| blob | 2fe62c23e5aae53f092abc8139e8862f118aa7ce |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009
4 ;; Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 6.33trans
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
28 ;;
29 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
30 ;; project planning with a fast and effective plain-text system.
31 ;;
32 ;; Org-mode develops organizational tasks around NOTES files that contain
33 ;; information about projects as plain text. Org-mode is implemented on
34 ;; top of outline-mode, which makes it possible to keep the content of
35 ;; large files well structured. Visibility cycling and structure editing
36 ;; help to work with the tree. Tables are easily created with a built-in
37 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
38 ;; and scheduling. It dynamically compiles entries into an agenda that
39 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
40 ;; Plain text URL-like links connect to websites, emails, Usenet
41 ;; messages, BBDB entries, and any files related to the projects. For
42 ;; printing and sharing of notes, an Org-mode file can be exported as a
43 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
44 ;; iCalendar file. It can also serve as a publishing tool for a set of
45 ;; linked webpages.
46 ;;
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
50 ;;
51 ;; http://orgmode.org/org.html#Installation
52 ;;
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org-mode can be found in the TeXInfo file. The
56 ;; distribution also contains a PDF version of it. At the homepage of
57 ;; Org-mode, you can read the same text online as HTML. There is also an
58 ;; excellent reference card made by Philip Rooke. This card can be found
59 ;; in the etc/ directory of Emacs 22.
60 ;;
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
63 ;;
64 ;;; Code:
71 ;;;; Require other packages
77 ;; For XEmacs, noutline is not yet provided by outline.el, so arrange for
78 ;; the file noutline.el being loaded.
80 ;; We require noutline, which might be provided in outline.el
82 ;; Other stuff we need.
94 ;;;; Customization variables
96 ;;; Version
102 "Show the org-mode version in the echo area.
103 With prefix arg HERE, insert it at point."
129 ;;; Compatibility constants
131 ;;; The custom variables
134 "Outline-based notes management and organizer."
141 "Mode hook for Org-mode, run after the mode was turned on."
146 "Hook that is run after org.el has been loaded."
155 "Load all extensions listed in `org-modules'."
160 org-modules)
164 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
173 (defcustom org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
174 "Modules that should always be loaded together with org.el.
175 If a description starts with <C>, the file is not part of Emacs
176 and loading it will require that you have downloaded and properly installed
177 the org-mode distribution.
179 You can also use this system to load external packages (i.e. neither Org
180 core modules, nor modules from the CONTRIB directory). Just add symbols
181 to the end of the list. If the package is called org-xyz.el, then you need
182 to add the symbol `xyz', and the package must have a call to
184 (provide 'org-xyz)"
187 :type
215 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
222 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
244 "Non-nil means, make shift-cursor commands select text when possible.
246 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
247 selecting a region, or enlarge thusly regions started in this way.
248 In Org-mode, in special contexts, these same keys are used for other
249 purposes, important enough to compete with shift selection. Org tries
250 to balance these needs by supporting `shift-select-mode' outside these
251 special contexts, under control of this variable.
253 The default of this variable is nil, to avoid confusing behavior. Shifted
254 cursor keys will then execute Org commands in the following contexts:
255 - on a headline, changing TODO state (left/right) and priority (up/down)
256 - on a time stamp, changing the time
257 - in a plain list item, changing the bullet type
258 - in a property definition line, switching between allowed values
259 - in the BEGIN line of a clock table (changing the time block).
260 Outside these contexts, the commands will throw an error.
262 When this variable is t and the cursor is not in a special context,
263 Org-mode will support shift-selection for making and enlarging regions.
264 To make this more effective, the bullet cycling will no longer happen
265 anywhere in an item line, but only if the cursor is exactly on the bullet.
267 If you set this variable to the symbol `always', then the keys
268 will not be special in headlines, property lines, and item lines, to make
269 shift selection work there as well. If this is what you want, you can
270 use the following alternative commands: `C-c C-t' and `C-c ,' to
271 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
272 TODO sets, `C-c -' to cycle item bullet types, and properties can be
273 edited by hand or in column view.
275 However, when the cursor is on a timestamp, shift-cursor commands
276 will still edit the time stamp - this is just too good to give up.
278 XEmacs user should have this variable set to nil, because shift-select-mode
279 is Emacs 23 only."
287 "Options concerning startup of Org-mode."
292 "Non-nil means, entering Org-mode will switch to OVERVIEW.
293 This can also be configured on a per-file basis by adding one of
294 the following lines anywhere in the buffer:
296 #+STARTUP: fold (or `overview', this is equivalent)
297 #+STARTUP: nofold (or `showall', this is equivalent)
298 #+STARTUP: content
299 #+STARTUP: showeverything"
308 "Non-nil means, entering Org-mode will set `truncate-lines'.
309 This is useful since some lines containing links can be very long and
310 uninteresting. Also tables look terrible when wrapped."
315 "Non-nil means, turn on `org-indent-mode' on startup.
316 This can also be configured on a per-file basis by adding one of
317 the following lines anywhere in the buffer:
319 #+STARTUP: indent
320 #+STARTUP: noindent"
327 "Non-nil means, turn on `org-beamer-mode' on startup.
328 This can also be configured on a per-file basis by adding one of
329 the following lines anywhere in the buffer:
331 #+STARTUP: beamer"
336 "Non-nil means, align all tables when visiting a file.
337 This is useful when the column width in tables is forced with <N> cookies
338 in table fields. Such tables will look correct only after the first re-align.
339 This can also be configured on a per-file basis by adding one of
340 the following lines anywhere in the buffer:
341 #+STARTUP: align
342 #+STARTUP: noalign"
347 "Non-nil means insert the first line setting Org-mode in empty files.
348 When the function `org-mode' is called interactively in an empty file, this
349 normally means that the file name does not automatically trigger Org-mode.
350 To ensure that the file will always be in Org-mode in the future, a
351 line enforcing Org-mode will be inserted into the buffer, if this option
352 has been set."
357 "Non-nil means use alternative key bindings for some keys.
358 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
359 These keys are also used by other packages like shift-selection-mode'
360 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
361 If you want to use Org-mode together with one of these other modes,
362 or more generally if you would like to move some Org-mode commands to
363 other keys, set this variable and configure the keys with the variable
364 `org-disputed-keys'.
366 This option is only relevant at load-time of Org-mode, and must be set
367 *before* org.el is loaded. Changing it requires a restart of Emacs to
368 become effective."
373 "Non-nil means use extra key sequence definitions for certain
374 commands. This happens automatically if you run XEmacs or if
375 window-system is nil. This variable lets you do the same
376 manually. You must set it before loading org.
378 Example: on Carbon Emacs 22 running graphically, with an external
379 keyboard on a Powerbook, the default way of setting M-left might
380 not work for either Alt or ESC. Setting this variable will make
381 it work for ESC."
395 "Keys for which Org-mode and other modes compete.
396 This is an alist, cars are the default keys, second element specifies
397 the alternative to use when `org-replace-disputed-keys' is t.
399 Keys can be specified in any syntax supported by `define-key'.
400 The value of this option takes effect only at Org-mode's startup,
401 therefore you'll have to restart Emacs to apply it after changing."
406 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
407 Or return the original if not disputed."
412 org-disputed-keys)))
414 key))
424 "Define a key, possibly translated, as returned by `org-key'."
428 "The ellipsis to use in the Org-mode outline.
429 When nil, just use the standard three dots. When a string, use that instead,
430 When a face, use the standard 3 dots, but with the specified face.
431 The change affects only Org-mode (which will then use its own display table).
432 Changing this requires executing `M-x org-mode' in a buffer to become
433 effective."
443 "Keywords in Org-mode."
448 "String to mark deadline entries.
449 A deadline is this string, followed by a time stamp. Should be a word,
450 terminated by a colon. You can insert a schedule keyword and
452 Changes become only effective after restarting Emacs."
457 "String to mark scheduled TODO entries.
458 A schedule is this string, followed by a time stamp. Should be a word,
459 terminated by a colon. You can insert a schedule keyword and
461 Changes become only effective after restarting Emacs."
466 "String used as the prefix for timestamps logging closing a TODO entry."
471 "String used as prefix for timestamps clocking work hours on an item."
476 "Entries starting with this keyword will never be exported.
477 An entry can be toggled between COMMENT and normal with
479 Changes become only effective after restarting Emacs."
484 "Entries starting with this keyword will be exported in fixed-width font.
485 Quoting applies only to the text in the entry following the headline, and does
486 not extend beyond the next headline, even if that is lower level.
487 An entry can be toggled between QUOTE and normal with
494 "Regular expression for specifying repeated events.
498 "Options concerning the general structure of Org-mode files."
503 "Options about how to make context of a location visible."
527 "Non-nil means, show full hierarchy when revealing a location.
528 Org-mode often shows locations in an org-mode file which might have
529 been invisible before. When this is set, the hierarchy of headings
530 above the exposed location is shown.
531 Turning this off for example for sparse trees makes them very compact.
532 Instead of t, this can also be an alist specifying this option for different
533 contexts. Valid contexts are
534 agenda when exposing an entry from the agenda
535 org-goto when using the command `org-goto' on key C-c C-j
536 occur-tree when using the command `org-occur' on key C-c /
537 tags-tree when constructing a sparse tree based on tags matches
538 link-search when exposing search matches associated with a link
539 mark-goto when exposing the jump goal of a mark
540 bookmark-jump when exposing a bookmark location
541 isearch when exiting from an incremental search
542 default default for all contexts not set explicitly"
547 "Non-nil means, show following heading when revealing a location.
548 Org-mode often shows locations in an org-mode file which might have
549 been invisible before. When this is set, the heading following the
550 match is shown.
551 Turning this off for example for sparse trees makes them very compact,
552 but makes it harder to edit the location of the match. In such a case,
554 Instead of t, this can also be an alist specifying this option for different
555 contexts. See `org-show-hierarchy-above' for valid contexts."
560 "Non-nil means, show all sibling heading when revealing a location.
561 Org-mode often shows locations in an org-mode file which might have
562 been invisible before. When this is set, the sibling of the current entry
563 heading are all made visible. If `org-show-hierarchy-above' is t,
564 the same happens on each level of the hierarchy above the current entry.
566 By default this is on for the isearch context, off for all other contexts.
567 Turning this off for example for sparse trees makes them very compact,
568 but makes it harder to edit the location of the match. In such a case,
570 Instead of t, this can also be an alist specifying this option for different
571 contexts. See `org-show-hierarchy-above' for valid contexts."
576 "Non-nil means, show the entry below a headline when revealing a location.
577 Org-mode often shows locations in an org-mode file which might have
578 been invisible before. When this is set, the text below the headline that is
579 exposed is also shown.
581 By default this is off for all contexts.
582 Instead of t, this can also be an alist specifying this option for different
583 contexts. See `org-show-hierarchy-above' for valid contexts."
588 "How should indirect tree buffers be displayed?
589 This applies to indirect buffers created with the commands
591 Valid values are:
592 current-window Display in the current window
593 other-window Just display in another window.
594 dedicated-frame Create one new frame, and re-use it each time.
595 new-frame Make a new frame each time. Note that in this case
596 previously-made indirect buffers are kept, and you need to
597 kill these buffers yourself."
607 "Non-nil means, activate single letter commands at beginning of a headline.
608 This may also be a function to test for appropriate locations where speed
609 commands should be active."
617 "Alist of additional speed commands.
618 This list will be checked before `org-speed-commands-default'
619 when the variable `org-use-speed-commands' is non-nil
620 and when the cursor is at the beginning of a headline.
621 The car if each entry is a string with a single letter, which must
622 be assigned to `self-insert-command' in the global map.
623 The cdr is either a command to be called interactively, a function
624 to be called, or a form to be evaluated.
625 An entry that is just a list with a single string will be interpreted
626 as a descriptive headline that will be added when listing the speed
627 copmmands in the Help buffer using the `?' speed command."
639 "Options concerning visibility cycling in Org-mode."
644 "Non-nil means, skip CHILDREN state in entries that don't have any."
649 "Maximum level which should still be subject to visibility cycling.
650 Levels higher than this will, for cycling, be treated as text, not a headline.
651 When `org-odd-levels-only' is set, a value of N in this variable actually
652 means 2N-1 stars as the limiting headline.
653 When nil, cycle all levels.
654 Note that the limiting level of cycling is also influenced by
655 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
656 `org-inlinetask-min-level' is, cycling will be limited to levels one less
657 than its value."
664 "Names of drawers. Drawers are not opened by cycling on the headline above.
665 Drawers only open with a TAB on the drawer line itself. A drawer looks like
666 this:
667 :DRAWERNAME:
668 .....
669 :END:
671 the property API.
673 Drawers can be defined on the per-file basis with a line like:
675 #+DRAWERS: HIDDEN STATE PROPERTIES"
681 "Non-nil means, , entering Org-mode will fold all blocks.
682 This can also be set in on a per-file basis with
684 #+STARTUP: hideblocks
685 #+STARTUP: showblocks"
691 "Cycle globally if cursor is at beginning of buffer and not at a headline.
692 This makes it possible to do global cycling without having to use S-TAB or
693 C-u TAB. For this special case to work, the first line of the buffer
694 must not be a headline - it may be empty or some other text. When used in
695 this way, `org-cycle-hook' is disables temporarily, to make sure the
696 cursor stays at the beginning of the buffer.
697 When this option is nil, don't do anything special at the beginning
698 of the buffer."
703 "Non-nil means, cycle entry level or item indentation in new empty entries.
705 When the cursor is at the end of an empty headline, i.e with only stars
706 and maybe a TODO keyword, TAB will then switch the entry to become a child,
707 and then all possible anchestor states, before returning to the original state.
708 This makes data entry extremely fast: M-RET to create a new headline,
709 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
711 When the cursor is at the end of an empty plain list item, one TAB will
712 make it a subitem, two or more tabs will back up to make this an item
713 higher up in the item hierarchy."
718 "Where should `org-cycle' emulate TAB.
719 nil Never
720 white Only in completely white lines
721 whitestart Only at the beginning of lines, before the first non-white char
722 t Everywhere except in headlines
723 exc-hl-bol Everywhere except at the start of a headline
724 If TAB is used in a place where it does not emulate TAB, the current subtree
725 visibility is cycled."
732 ))
735 "Number of empty lines needed to keep an empty line between collapsed trees.
736 If you leave an empty line between the end of a subtree and the following
737 headline, this empty line is hidden when the subtree is folded.
738 Org-mode will leave (exactly) one empty line visible if the number of
739 empty lines is equal or larger to the number given in this variable.
740 So the default 2 means, at least 2 empty lines after the end of a subtree
741 are needed to produce free space between a collapsed subtree and the
742 following headline.
744 If the number is negative, and the number of empty lines is at least -N,
745 all empty lines are shown.
747 Special case: when 0, never leave empty lines in collapsed view."
753 "Hook that is run before visibility cycling is happening.
754 The function(s) in this hook must accept a single argument which indicates
755 the new state that will be set right after running this hook. The
756 argument is a symbol. Before a global state change, it can have the values
757 `overview', `content', or `all'. Before a local state change, it can have
758 the values `folded', `children', or `subtree'."
763 org-cycle-hide-drawers
764 org-cycle-show-empty-lines
765 org-optimize-window-after-visibility-change)
766 "Hook that is run after `org-cycle' has changed the buffer visibility.
767 The function(s) in this hook must accept a single argument which indicates
768 the new state that was set by the most recent `org-cycle' command. The
769 argument is a symbol. After a global state change, it can have the values
770 `overview', `content', or `all'. After a local state change, it can have
771 the values `folded', `children', or `subtree'."
776 "Options concerning structure editing in Org-mode."
781 "Non-nil means, skip even levels and only use odd levels for the outline.
782 This has the effect that two stars are being added/taken away in
783 promotion/demotion commands. It also influences how levels are
784 handled by the exporters.
785 Changing it requires restart of `font-lock-mode' to become effective
786 for fontification also in regions already fontified.
787 You may also set this on a per-file basis by adding one of the following
788 lines to the buffer:
790 #+STARTUP: odd
791 #+STARTUP: oddeven"
797 "Non-nil means, adapt indentation to outline node level.
799 When this variable is set, Org assumes that you write outlines by
800 indenting text in each node to align with the headline (after the stars).
801 The following issues are influenced by this variable:
803 - When this is set and the *entire* text in an entry is indented, the
804 indentation is increased by one space in a demotion command, and
805 decreased by one in a promotion command. If any line in the entry
806 body starts with text at column 0, indentation is not changed at all.
808 - Property drawers and planning information is inserted indented when
809 this variable s set. When nil, they will not be indented.
811 - TAB indents a line relative to context. The lines below a headline
812 will be indented when this variable is set.
814 Note that this is all about true indentation, by adding and removing
815 space characters. See also `org-indent.el' which does level-dependent
816 indentation in a virtual way, i.e. at display time in Emacs."
821 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
823 When t, `C-a' will bring back the cursor to the beginning of the
824 headline text, i.e. after the stars and after a possible TODO keyword.
825 In an item, this will be the position after the bullet.
826 When the cursor is already at that position, another `C-a' will bring
827 it to the beginning of the line.
829 `C-e' will jump to the end of the headline, ignoring the presence of tags
830 in the headline. A second `C-e' will then jump to the true end of the
831 line, after any tags. This also means that, when this variable is
832 non-nil, `C-e' also will never jump beyond the end of the heading of a
833 folded section, i.e. not after the ellipses.
835 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
836 going to the true line boundary first. Only a directly following, identical
837 keypress will bring the cursor to the special positions.
839 This may also be a cons cell where the behavior for `C-a' and `C-e' is
840 set separately."
859 "Non-nil means `C-k' will behave specially in headlines.
860 When nil, `C-k' will call the default `kill-line' command.
861 When t, the following will happen while the cursor is in the headline:
863 - When the cursor is at the beginning of a headline, kill the entire
864 line and possible the folded subtree below the line.
865 - When in the middle of the headline text, kill the headline up to the tags.
866 - When after the headline text, kill the tags."
871 "Non-nil means, when yanking subtrees, fold them.
872 If the kill is a single subtree, or a sequence of subtrees, i.e. if
873 it starts with a heading and all other headings in it are either children
874 or siblings, then fold all the subtrees. However, do this only if no
875 text after the yank would be swallowed into a folded tree by this action."
880 "Non-nil means, when yanking subtrees, adjust the level.
881 With this setting, `org-paste-subtree' is used to insert the subtree, see
882 this function for details."
887 "Non-nil means, M-RET will split the line at the cursor position.
888 When nil, it will go to the end of the line before making a
889 new line.
890 You may also set this option in a different way for different
891 contexts. Valid contexts are:
893 headline when creating a new headline
894 item when creating a new item
895 table in a table field
896 default the value to be used for all contexts not explicitly
897 customized"
914 "Non-nil means, insert new headings after the current subtree.
915 When nil, the new heading is created directly after the current line.
918 for the duration of the command."
924 "Should `org-insert-heading' leave a blank line before new heading/item?
925 The value is an alist, with `heading' and `plain-list-item' as car,
926 and a boolean flag as cdr. For plain lists, if the variable
927 `org-empty-line-terminates-plain-lists' is set, the setting here
928 is ignored and no empty line is inserted, to keep the list in tact."
941 "Hook being run after inserting a new heading."
947 This currently only means, they are never auto-wrapped.
948 When nil, such lines will be treated like ordinary lines.
949 See also the QUOTE keyword."
955 "Non-nil means, typing characters in org-goto starts incremental search."
960 "Options concerning sparse trees in Org-mode."
965 "Non-nil means, highlight all matches that define a sparse tree.
966 The highlights will automatically disappear the next time the buffer is
967 changed by an edit command."
972 "Non-nil means, any change to the buffer will remove temporary highlights.
973 Such highlights are created by `org-occur' and `org-clock-display'.
974 When nil, `C-c C-c needs to be used to get rid of the highlights.
975 The highlights created by `org-preview-latex-fragment' always need
976 `C-c C-c' to be removed."
983 "Hook that is run after `org-occur' has constructed a sparse tree.
984 This can be used to recenter the window to show as much of the structure
985 as possible."
990 "Options concerning imenu and speedbar in Org-mode."
995 "The maximum level for Imenu access to Org-mode headlines.
996 This also applied for speedbar access."
1001 "Options concerning tables in Org-mode."
1007 When nil, such lines will be treated like ordinary lines.
1009 When equal to the symbol `optimized', the table editor will be optimized to
1010 do the following:
1011 - Automatic overwrite mode in front of whitespace in table fields.
1012 This makes the structure of the table stay in tact as long as the edited
1013 field does not exceed the column width.
1014 - Minimize the number of realigns. Normally, the table is aligned each time
1015 TAB or RET are pressed to move to another field. With optimization this
1016 happens only if changes to a field might have changed the column width.
1017 Optimization requires replacing the functions `self-insert-command',
1018 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1019 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1020 very good at guessing when a re-align will be necessary, but you can always
1023 If you would like to use the optimized version in Org-mode, but the
1024 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1026 This variable can be used to turn on and off the table editor during a session,
1027 but in order to toggle optimization, a restart is required.
1029 See also the variable `org-table-auto-blank-field'."
1037 "Non-nil means cluster self-insert commands for undo when possible.
1038 If this is set, then, like in the Emacs command loop, 20 consecutive
1039 characters will be undone together.
1040 This is configurable, because there is some impact on typing performance."
1045 "Non-nil means, TAB will automatically notice a table.el table.
1046 When it sees such a table, it moves point into it and - if necessary -
1047 calls `table-recognize-table'."
1052 "Options concerning links in Org-mode."
1057 "Buffer-local version of `org-link-abbrev-alist', which see.
1062 "Alist of link abbreviations.
1063 The car of each element is a string, to be replaced at the start of a link.
1065 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1067 [[linkkey:tag][description]]
1069 The 'linkkey' must be a word word, starting with a letter, followed
1070 by letters, numbers, '-' or '_'.
1072 If REPLACE is a string, the tag will simply be appended to create the link.
1075 be inserted at that point (see the function `url-hexify-string').
1077 REPLACE may also be a function that will be called with the tag as the
1078 only argument to create the link, which should be returned as a string.
1080 See the manual for examples."
1090 "Non-nil means, hide link part and only show description of bracket links.
1091 Bracket links are like [[link][description]]. This variable sets the initial
1092 state in new org-mode buffers. The setting can then be toggled on a
1093 per-buffer basis from the Org->Hyperlinks menu."
1098 "How the path name in file links should be stored.
1099 Valid values are:
1101 relative Relative to the current directory, i.e. the directory of the file
1102 into which the link is being inserted.
1103 absolute Absolute path, if possible with ~ for home directory.
1104 noabbrev Absolute path, no abbreviation of home directory.
1105 adaptive Use relative path for files in the current directory and sub-
1106 directories of it. For other files, use an absolute path."
1115 "Types of links that should be activated in Org-mode files.
1116 This is a list of symbols, each leading to the activation of a certain link
1117 type. In principle, it does not hurt to turn on most link types - there may
1118 be a small gain when turning off unused link types. The types are:
1120 bracket The recommended [[link][description]] or [[link]] links with hiding.
1121 angular Links in angular brackets that may contain whitespace like
1122 <bbdb:Carsten Dominik>.
1123 plain Plain links in normal text, no whitespace, like http://google.com.
1124 radio Text that is matched by a radio target, see manual for details.
1125 tag Tag settings in a headline (link to tag search).
1126 date Time stamps (link to calendar).
1127 footnote Footnote labels.
1129 Changing this variable requires a restart of Emacs to become effective."
1141 "Function to use to generate link descriptions from links. If
1142 nil the link location will be used. This function must take two
1143 parameters; the first is the link and the second the description
1144 org-insert-link has generated, and should return the description
1145 to use."
1150 "Options concerning storing links in Org-mode."
1155 "Format of the description part of a link to an email or usenet message.
1156 The following %-escapes will be replaced by corresponding information:
1164 %s subject
1165 %m message-id.
1167 You may use normal field width specification between the % and the letter.
1168 This is for example useful to limit the length of the subject.
1182 It should match if the message is from the user him/herself."
1187 "Non-nil means, storing a link to an Org file will use entry IDs.
1189 Note that before this variable is even considered, org-id must be loaded,
1190 so please customize `org-modules' and turn it on.
1192 The variable can have the following values:
1194 t Create an ID if needed to make a link to the current entry.
1196 create-if-interactive
1197 If `org-store-link' is called directly (interactively, as a user
1198 command), do create an ID to support the link. But when doing the
1199 job for remember, only use the ID if it already exists. The
1200 purpose of this setting is to avoid proliferation of unwanted
1201 IDs, just because you happen to be in an Org file when you
1202 call `org-remember' that automatically and preemptively
1203 creates a link. If you do want to get an ID link in a remember
1204 template to an entry not having an ID, create it first by
1205 explicitly creating a link to it, using `C-c C-l' first.
1207 create-if-interactive-and-no-custom-id
1208 Like create-if-interactive, but do not create an ID if there is
1209 a CUSTOM_ID property defined in the entry. This is the default.
1211 use-existing
1212 Use existing ID, do not create one.
1214 nil Never use an ID to make a link, instead link using a text search for
1215 the headline text."
1220 create-if-interactive)
1222 create-if-interactive-and-no-custom-id)
1227 "Non-nil means, file links from `org-store-link' contain context.
1228 A search string will be added to the file name with :: as separator and
1229 used to find the context when the link is activated by the command
1230 `org-open-at-point'.
1232 negates this setting for the duration of the command."
1237 "Non-nil means, keep link in list for entire session.
1239 The command `org-store-link' adds a link pointing to the current
1240 location to an internal list. These links accumulate during a session.
1241 The command `org-insert-link' can be used to insert links into any
1242 Org-mode file (offering completion for all stored links). When this
1244 will be removed from the list, to make completing the unused links
1245 more efficient."
1250 "Options concerning following links in Org-mode."
1255 "Function to translate links with different syntax to Org syntax.
1256 This can be used to translate links created for example by the Planner
1257 or emacs-wiki packages to Org syntax.
1258 The function must accept two parameters, a TYPE containing the link
1260 which is everything after the link protocol. It should return a cons
1261 with possibly modified values of type and path.
1262 Org contains a function for this, so if you set this variable to
1263 `org-translate-link-from-planner', you should be able follow many
1264 links created by planner."
1269 "Hook that is run after a link has been followed."
1274 "Non-nil means, on links TAB will follow the link.
1275 Needs to be set before org.el is loaded.
1276 This really should not be used, it does not make sense, and the
1277 implementation is bad."
1282 "Non-nil means, on links RET will follow the link.
1283 Needs to be set before org.el is loaded."
1289 "Non-nil means, mouse-1 on a link will follow the link.
1290 A longer mouse click will still set point. Does not work on XEmacs.
1291 Needs to be set before org.el is loaded."
1296 "Number of different positions to be recorded in the ring
1297 Changing this requires a restart of Emacs to work correctly."
1305 "Setup the frame configuration for following links.
1306 When following a link with Emacs, it may often be useful to display
1307 this link in another window or frame. This variable can be used to
1308 set this up for the different types of links.
1309 For VM, use any of
1310 `vm-visit-folder'
1311 `vm-visit-folder-other-frame'
1312 For Gnus, use any of
1313 `gnus'
1314 `gnus-other-frame'
1315 `org-gnus-no-new-news'
1316 For FILE, use any of
1317 `find-file'
1318 `find-file-other-window'
1319 `find-file-other-frame'
1320 For the calendar, use the variable `calendar-setup'.
1321 For BBDB, it is currently only possible to display the matches in
1322 another window."
1342 "Non-nil means, use indirect buffer to display infile links.
1343 Activating internal links (from one location in a file to another location
1344 in the same file) normally just jumps to the location. When the link is
1345 activated with a C-u prefix (or with mouse-3), the link is displayed in
1346 another window. When this option is set, the other window actually displays
1347 an indirect buffer clone of the current buffer, to avoid any visibility
1348 changes to the current buffer."
1353 "Non-nil means, `org-open-file' will open non-existing files.
1354 When nil, an error will be generated.
1355 This variable applies only to external applications because they
1356 might choke on non-existing files. If the link is to a file that
1357 will be opened in Emacs, the variable is ignored."
1362 "Non-nil means, a link to a directory really means to index.org.
1363 When nil, following a directory link will run dired or open a finder/explorer
1364 window on that directory."
1369 "Function and arguments to call for following mailto links.
1370 This is a list with the first element being a lisp function, and the
1371 remaining elements being arguments to the function. In string arguments,
1372 %a will be replaced by the address, and %s will be replaced by the subject
1373 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1382 "Non-nil means, ask for confirmation before executing shell links.
1383 Shell links can be dangerous: just think about a link
1385 [[shell:rm -rf ~/*][Google Search]]
1388 but really it would remove your entire home directory.
1389 Therefore we advise against setting this variable to nil.
1390 Just change it to `y-or-n-p' if you want to confirm with a
1399 "Non-nil means, ask for confirmation before executing Emacs Lisp links.
1400 Elisp links can be dangerous: just think about a link
1405 but really it would remove your entire home directory.
1406 Therefore we advise against setting this variable to nil.
1407 Just change it to `y-or-n-p' if you want to confirm with a
1419 "Default file applications on a UNIX or GNU/Linux system.
1430 "Default file applications on a MacOS X system.
1432 for some files for which the OS does not have a good default.
1440 'mswindows-shell-execute
1445 'mswindows-shell-execute
1448 "Default file applications on a Windows NT system.
1453 '(
1458 )
1459 "External applications for opening `file:path' items in a document.
1460 Org-mode uses system defaults for different file types, but
1461 you can use this variable to set the application for a given file
1462 extension. The entries in this list are cons cells where the car identifies
1463 files and the cdr the corresponding command. Possible values for the
1464 file identifier are
1466 compatibility, this can also be a string with only alphanumeric
1467 characters, which is then interpreted as an extension.
1468 `directory' Matches a directory
1469 `remote' Matches a remote file, accessible through tramp or efs.
1470 Remote files most likely should be visited through Emacs
1471 because external applications cannot handle such paths.
1472 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1473 so all files Emacs knows how to handle. Using this with
1474 command `emacs' will open most files in Emacs. Beware that this
1475 will also open html files inside Emacs, unless you add
1477 t Default for files not matched by any of the other options.
1478 `system' The system command to open files, like `open' on Windows
1479 and Mac OS X, and mailcap under GNU/Linux. This is the command
1480 that will be selected if you call `C-c C-o' with a double
1481 `C-u C-u' prefix.
1483 Possible values for the command are:
1484 `emacs' The file will be visited by the current Emacs process.
1485 `default' Use the default application for this file type, which is the
1486 association for t in the list, most likely in the system-specific
1487 part.
1488 This can be used to overrule an unwanted setting in the
1489 system-specific variable.
1491 This command is specified by the entry whose car is `system'.
1492 Most likely, the system-specific version of this variable
1493 does define this command, but you can overrule/replace it
1494 here.
1495 string A command to be executed by a shell; %s will be replaced
1496 by the path to the file.
1497 sexp A Lisp form which will be evaluated. The file path will
1498 be available in the Lisp variable `file'.
1499 For more examples, see the system specific constants
1500 `org-file-apps-defaults-macosx'
1501 `org-file-apps-defaults-windowsnt'
1502 `org-file-apps-defaults-gnu'."
1512 auto-mode))
1521 "Options concerning refiling entries in Org-mode."
1526 "Directory with org files.
1527 This is just a default location to look for Org files. There is no need
1528 at all to put your files into this directory. It is only used in the
1529 following situations:
1531 1. When a remember template specifies a target file that is not an
1532 absolute path. The path will then be interpreted relative to
1533 `org-directory'
1534 2. When a remember note is filed away in an interactive way (when exiting the
1535 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1536 with `org-directory' as the default path."
1542 "Default target for storing notes.
1543 Used by the hooks for remember.el. This can be a string, or nil to mean
1544 the value of `remember-data-file'.
1545 You can set this on a per-template basis with the variable
1546 `org-remember-templates'."
1551 file))
1554 "The default interface to be used for `org-goto'.
1555 Allowed values are:
1556 outline The interface shows an outline of the relevant file
1557 and the correct heading is found by moving through
1558 the outline or by searching with incremental search.
1559 outline-path-completion Headlines in the current buffer are offered via
1560 completion. This is the interface also used by
1561 the refile command."
1568 "Maximum level to be considered when running org-goto with refile interface."
1573 "Non-nil means, store new notes at the beginning of a file or entry.
1574 When nil, new notes will be filed to the end of a file or entry.
1575 This can also be a list with cons cells of regular expressions that
1576 are matched against file names, and values."
1587 This is list of cons cells. Each cell contains:
1588 - a specification of the files to be considered, either a list of files,
1589 or a symbol whose function or variable value will be used to retrieve
1590 a file name or a list of file names. If you use `org-agenda-files' for
1591 that, all agenda files will be scanned for targets. Nil means, consider
1592 headings in the current buffer.
1593 - A specification of how to find candidate refile targets. This may be
1594 any of:
1596 This tag has to be present in all target headlines, inheritance will
1597 not be considered.
1599 todo keyword.
1601 headlines that are refiling targets.
1602 - a cons cell (:level . N). Any headline of level N is considered a target.
1603 Note that, when `org-odd-levels-only' is set, level corresponds to
1604 order in hierarchy, not to the number of stars.
1605 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1606 Note that, when `org-odd-levels-only' is set, level corresponds to
1607 order in hierarchy, not to the number of stars.
1609 You can set the variable `org-refile-target-verify-function' to a function
1610 to verify each headline found by the simple critery above.
1612 When this variable is nil, all top-level headlines in the current buffer
1613 are used, equivalent to the value `((nil . (:level . 1))'."
1629 "Function to verify if the headline at point should be a refile target.
1630 The function will be called without arguments, with point at the
1631 beginning of the headline. It should return t and leave point
1632 where it is if the headline is a valid target for refiling.
1634 If the target should not be selected, the function must return nil.
1635 In addition to this, it may move point to a place from where the search
1636 should be continued. For example, the function may decide that the entire
1637 subtree of the current entry should be excluded and move point to the end
1638 of the subtree."
1643 "Non-nil means, provide refile targets as paths.
1644 So a level 3 headline will be available as level1/level2/level3.
1646 When the value is `file', also include the file name (without directory)
1647 into the path. In this case, you can also stop the completion after
1648 the file name, to get entries inserted as top level in the file.
1650 When `full-file-path', include the full file path."
1659 "Non-nil means, complete the outline path in hierarchical steps.
1660 When Org-mode uses the refile interface to select an outline path
1661 \(see variable `org-refile-use-outline-path'), the completion of
1662 the path can be done is a single go, or if can be done in steps down
1663 the headline hierarchy. Going in steps is probably the best if you
1664 do not use a special completion package like `ido' or `icicles'.
1665 However, when using these packages, going in one step can be very
1666 fast, while still showing the whole path to the entry."
1671 "Non-nil means, allow to create new nodes as refile targets.
1673 of an existing node. When the value of this variable is `confirm',
1674 new node creation must be confirmed by the user (recommended)
1675 When nil, the completion must match an existing entry.
1677 Note that, if the new heading is not seen by the criteria
1678 listed in `org-refile-targets', multiple instances of the same
1679 heading would be created by trying again to file under the new
1680 heading."
1688 "Options concerning TODO items in Org-mode."
1693 "Options concerning Progress logging in Org-mode."
1698 '(
1701 "The available interpretation symbols for customizing
1702 `org-todo-keywords'.
1706 "List of TODO entry keyword sequences and their interpretation.
1709 Each sequence starts with a symbol, either `sequence' or `type',
1710 indicating if the keywords should be interpreted as a sequence of
1711 action steps, or as different types of TODO items. The first
1712 keywords are states requiring action - these states will select a headline
1713 for inclusion into the global TODO list Org-mode produces. If one of
1716 the last keyword is treated as the only DONE state of the sequence.
1719 additional state where no keyword is present. For details about this
1720 cycling, see the manual.
1722 TODO keywords and interpretation can also be set on a per-file basis with
1723 the special #+SEQ_TODO and #+TYP_TODO lines.
1725 Each keyword can optionally specify a character for fast state selection
1726 \(in combination with the variable `org-use-fast-todo-selection')
1727 and specifiers for state change logging, using the same syntax
1730 indicates to record a time stamp each time this state is selected.
1732 Each keyword may also specify if a timestamp or a note should be
1733 recorded when entering or leaving the state, by adding additional
1734 characters in the parenthesis after the keyword. This looks like this:
1736 record only the time of the state change. With X and Y being either
1738 Y when leaving the state if and only if the *target* state does not
1739 define X. You may omit any of the fast-selection key or X or /Y,
1740 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1742 For backward compatibility, this variable may also be just a list
1743 of keywords - in this case the interpretation (sequence or type) will be
1744 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
1754 ;;Quick and dirty way to see
1755 ;;`org-todo-interpretations'. This takes the
1756 ;;place of item arguments
1757 :convert-widget
1764 org-todo-interpretation-widgets))
1765 widget))
1796 "Controls how TODO keywords are interpreted.
1797 This variable is in principle obsolete and is only used for
1798 backward compatibility, if the interpretation of todo keywords is
1799 not given already in `org-todo-keywords'. See that variable for
1800 more information."
1807 "Non-nil means, use the fast todo selection scheme with C-c C-t.
1808 This variable describes if and under what circumstances the cycling
1809 mechanism for TODO keywords will be replaced by a single-key, direct
1810 selection scheme.
1812 When nil, fast selection is never used.
1814 When the symbol `prefix', it will be used when `org-todo' is called with
1815 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
1816 in an agenda buffer.
1818 When t, fast selection is used by default. In this case, the prefix
1819 argument forces cycling instead.
1821 In all cases, the special interface is only used if access keys have actually
1822 been assigned by the user, i.e. if keywords in the configuration are followed
1823 by a letter in parenthesis, like TODO(t)."
1831 "Non-nil means, update todo statistics after insert and toggle.
1832 ALL-HEADLINES means update todo statistics by including headlines
1833 with no TODO keyword as well, counting them as not done.
1834 A list of TODO keywords means the same, but skip keywords that are
1835 not in this list.
1837 When this is set, todo statistics is updated in the parent of the
1838 current entry each time a todo state is changed."
1848 "Non-nil means, TODO statistics covers just direct children.
1849 When nil, all entries in the subtree are considered.
1850 This has only an effect if `org-provide-todo-statistics' is set.
1851 To set this to nil for only a single subtree, use a COOKIE_DATA
1857 "Hook which is run after the state of a TODO item was changed.
1858 The new state (a string with a TODO keyword, or nil) is available in the
1859 Lisp variable `state'."
1864 "Hook for functions that are allowed to block a state change.
1866 Each function gets as its single argument a property list, see
1867 `org-trigger-hook' for more information about this list.
1869 If any of the functions in this hook returns nil, the state change
1873 "Hook for functions that are triggered by a state change.
1875 Each function gets as its single argument a property list with at least
1876 the following elements:
1878 (:type type-of-change :position pos-at-entry-start
1879 :from old-state :to new-state)
1881 Depending on the type, more properties may be present.
1883 This mechanism is currently implemented for:
1885 TODO state changes
1886 ------------------
1887 :type todo-state-change
1888 :from previous state (keyword as a string), or nil, or a symbol
1889 'todo' or 'done', to indicate the general type of state.
1893 "Non-nil means, undone TODO entries will block switching the parent to DONE.
1894 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
1895 be blocked if any prior sibling is not yet done.
1896 Finally, if the parent is blocked because of ordered siblings of its own,
1897 the child will also be blocked.
1898 This variable needs to be set before org.el is loaded, and you need to
1899 restart Emacs after a change to make the change effective. The only way
1900 to change is while Emacs is running is through the customize interface."
1912 "Non-nil means, unchecked boxes will block switching the parent to DONE.
1913 When this is nil, checkboxes have no influence on switching TODO states.
1914 When non-nil, you first need to check off all check boxes before the TODO
1915 entry can be switched to DONE.
1916 This variable needs to be set before org.el is loaded, and you need to
1917 restart Emacs after a change to make the change effective. The only way
1918 to change is while Emacs is running is through the customize interface."
1930 "Non-nil means, inserting a TODO heading is treated as state change.
1932 logging will apply if appropriate. When nil, the new TODO item will
1933 be inserted directly, and no logging will take place."
1938 "Non-nil means, switching TODO states with S-cursor counts as state change.
1939 This is the default behavior. However, setting this to nil allows a
1940 convenient way to select a TODO state and bypass any logging associated
1941 with that."
1946 "Tag changes that should be triggered by TODO state changes.
1947 This is a list. Each entry is
1949 (state-change (tag . flag) .......)
1951 State-change can be a string with a state, and empty string to indicate the
1952 state that has no TODO keyword, or it can be one of the symbols `todo'
1953 or `done', meaning any not-done or done state, respectively."
1967 "Information to record when a task moves to the DONE state.
1969 Possible values are:
1971 nil Don't add anything, just change the keyword
1972 time Add a time stamp to the task
1973 note Prompt for a note and add it with template `org-log-note-headings'
1975 This option can also be set with on a per-file-basis with
1977 #+STARTUP: nologdone
1978 #+STARTUP: logdone
1979 #+STARTUP: lognotedone
1981 You can have local logging settings for a subtree by setting the LOGGING
1982 property to one or more of these keywords."
1990 ;; Normalize old uses of org-log-done.
1997 "Information to record when the scheduling date of a tasks is modified.
1999 Possible values are:
2001 nil Don't add anything, just change the date
2002 time Add a time stamp to the task
2003 note Prompt for a note and add it with template `org-log-note-headings'
2005 This option can also be set with on a per-file-basis with
2007 #+STARTUP: nologreschedule
2008 #+STARTUP: logreschedule
2009 #+STARTUP: lognotereschedule"
2018 "Information to record when the deadline date of a tasks is modified.
2020 Possible values are:
2022 nil Don't add anything, just change the date
2023 time Add a time stamp to the task
2024 note Prompt for a note and add it with template `org-log-note-headings'
2026 This option can also be set with on a per-file-basis with
2028 #+STARTUP: nologredeadline
2029 #+STARTUP: logredeadline
2030 #+STARTUP: lognoteredeadline
2032 You can have local logging settings for a subtree by setting the LOGGING
2033 property to one or more of these keywords."
2042 "Non-nil means, record a note when clocking out of an item.
2043 This can also be configured on a per-file basis by adding one of
2044 the following lines anywhere in the buffer:
2046 #+STARTUP: lognoteclock-out
2047 #+STARTUP: nolognoteclock-out"
2053 "Non-nil means, the CLOSED time stamp will contain date and time.
2054 When nil, only the date will be recorded."
2067 "Headings for notes added to entries.
2068 The value is an alist, with the car being a symbol indicating the note
2069 context, and the cdr is the heading to be used. The heading may also be the
2070 empty string.
2071 %t in the heading will be replaced by a time stamp.
2072 %s will be replaced by the new TODO state, in double quotes.
2073 %S will be replaced by the old TODO state, in double quotes.
2074 %u will be replaced by the user name.
2075 %U will be replaced by the full user name.
2077 In fact, it is not a good idea to change the `state' entry, because
2078 agenda log mode depends on the format of these entries."
2084 "Heading when changing todo state (todo sequence only)"
2097 "Non-nil means, insert state change notes and time stamps into a drawer.
2098 When nil, state changes notes will be inserted after the headline and
2099 any scheduling and clock lines, but not inside a drawer.
2101 The value of this variable should be the name of the drawer to use.
2102 LOGBOOK is proposed at the default drawer for this purpose, you can
2103 also set this to a string to define the drawer of your choice.
2107 If this variable is set, `org-log-state-notes-insert-after-drawers'
2108 will be ignored.
2110 You can set the property LOG_INTO_DRAWER to overrule this setting for
2111 a subtree."
2123 "Return the value of `org-log-into-drawer', but let properties overrule.
2124 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2125 used instead of the default value."
2133 "Non-nil means, insert state change notes after any drawers in entry.
2134 Only the drawers that *immediately* follow the headline and the
2135 deadline/scheduled line are skipped.
2136 When nil, insert notes right after the heading and perhaps the line
2137 with deadline/scheduling if present.
2139 This variable will have no effect if `org-log-into-drawer' is
2140 set."
2146 "Non-nil means, the latest state change note will be directly after heading.
2147 When nil, the notes will be orderer according to time."
2153 "Non-nil means, record moving through the DONE state when triggering repeat.
2154 An auto-repeating task is immediately switched back to TODO when
2157 record a closing note, there will be no record of the task moving
2158 through DONE. This variable forces taking a note anyway.
2160 nil Don't force a record
2161 time Record a time stamp
2162 note Record a note
2164 This option can also be set with on a per-file-basis with
2166 #+STARTUP: logrepeat
2167 #+STARTUP: lognoterepeat
2168 #+STARTUP: nologrepeat
2170 You can have local logging settings for a subtree by setting the LOGGING
2171 property to one or more of these keywords."
2181 "Priorities in Org-mode."
2186 "Non-nil means, priority commands are active.
2187 When nil, these commands will be disabled, so that you never accidentally
2188 set a priority."
2193 "The highest priority of TODO items. A character like ?A, ?B etc.
2194 Must have a smaller ASCII number than `org-lowest-priority'."
2199 "The lowest priority of TODO items. A character like ?A, ?B etc.
2200 Must have a larger ASCII number than `org-highest-priority'."
2205 "The default priority of TODO items.
2206 This is the priority an item get if no explicit priority is given."
2211 "Non-nil means, start with default priority when starting to cycle.
2212 When this is nil, the first step in the cycle will be (depending on the
2213 command used) one higher or lower that the default priority."
2218 "Options concerning time stamps and deadlines in Org-mode."
2223 "Non-nil means, SCHEDULED and DEADLINE timestamps are inserted at point.
2224 When nil, these labeled time stamps are forces into the second line of an
2225 entry, just after the headline. When scheduling from the global TODO list,
2226 the time stamp will always be forced into the second line."
2231 "Formats for `format-time-string' which are used for time stamps.
2235 "Number of minutes to round time stamps to.
2236 These are two values, the first applies when first creating a time stamp.
2237 The second applies when changing it with the commands `S-up' and `S-down'.
2238 When changing the time stamp, this means that it will change in steps
2239 of N minutes, as given by the second value.
2241 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2242 numbers should be factors of 60, so for example 5, 10, 15.
2244 When this is larger than 1, you can still force an exact time-stamp by using
2245 a double prefix argument to a time-stamp command like `C-c .' or `C-c !',
2246 and by using a prefix arg to `S-up/down' to specify the exact number
2247 of minutes to shift."
2257 ;; Normalize old customizations of this variable.
2261 org-time-stamp-rounding-minutes)))
2264 "Non-nil means, overlay custom formats over all time stamps.
2265 The formats are defined through the variable `org-time-stamp-custom-formats'.
2266 To turn this on on a per-file basis, insert anywhere in the file:
2267 #+STARTUP: customtime"
2275 "Custom formats for time stamps. See `format-time-string' for the syntax.
2276 These are overlayed over the default ISO format if the variable
2277 `org-display-custom-times' is set. Time like %H:%M should be at the
2278 end of the second format. The custom formats are also honored by export
2279 commands, if custom time display is turned on at the time of export."
2284 "Get the right format for a time string."
2289 f)))
2292 "The format string used when creating CLOCKSUM lines, or when
2293 org-mode generates a time duration."
2299 org-mode generates a time duration."
2304 "The format string used when creating CLOCKSUM lines, or when
2305 org-mode generates a time duration."
2310 "No. of days before expiration during which a deadline becomes active.
2311 This variable governs the display in sparse trees and in the agenda.
2312 When 0 or negative, it means use this number (the absolute value of it)
2313 even if a deadline has a different individual lead time specified.
2315 Custom commands can set this variable in the options section."
2321 "Non-nil means, assume future for incomplete date input from user.
2322 This affects the following situations:
2323 1. The user gives a month but not a year.
2326 2. The user gives a day, but no month.
2329 it will be considered as *this* month.
2331 If you set this variable to the symbol `time', then also the following
2332 will work:
2334 3. If the user gives a time, but no day. If the time is before now,
2335 to will be interpreted as tomorrow.
2337 Currently none of this works for ISO week specifications.
2339 When this option is nil, the current day, month and year will always be
2340 used as defaults."
2348 "Non-nil means, display current interpretation of date prompt live.
2349 This display will be in an overlay, in the minibuffer."
2354 "Non-nil means, pop up a calendar when prompting for a date.
2355 In the calendar, the date can be selected with mouse-1. However, the
2356 minibuffer will also be active, and you can simply enter the date as well.
2357 When nil, only the minibuffer will be available."
2365 "Hook to be used to set up keys for the date/time interface.
2366 Add key definitions to `minibuffer-local-map', which will be a temporary
2367 copy."
2372 "The hour when your day really ends. Must be an integer.
2373 This has influence for the following applications:
2375 the time given here, the day recognized as TODAY is actually yesterday.
2376 - When a date is read from the user and it is still before the time given
2377 here, the current date and time will be assumed to be yesterday, 23:59.
2378 Also, timestamps inserted in remember templates follow this rule.
2380 IMPORTANT: This is a feature whose implementation is and likely will
2381 remain incomplete. Really, it is only here because past midnight seems to
2382 be the favorite working time of John Wiegley :-)"
2387 "Non-nil means, S-down will increase the time in a time stamp.
2388 When nil, S-up will increase."
2393 "Non-nil means, make the calendar window follow timestamp changes.
2394 When a timestamp is modified and the calendar window is visible, it will be
2395 moved to the new date."
2400 "Options concerning tags in Org-mode."
2405 "List of tags allowed in Org-mode files.
2406 When this list is nil, Org-mode will base TAG input on what is already in the
2407 buffer.
2408 The value of this variable is an alist, the car of each entry must be a
2409 keyword as a string, the cdr may be a character that is used to select
2410 that tag through the fast-tag-selection interface.
2411 See the manual for details."
2426 "List of tags that will always appear in all Org-mode files.
2427 This is in addition to any in buffer settings or customizations
2428 of `org-tag-alist'.
2429 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2430 The value of this variable is an alist, the car of each entry must be a
2431 keyword as a string, the cdr may be a character that is used to select
2432 that tag through the fast-tag-selection interface.
2433 See the manual for details.
2434 To disable these tags on a per-file basis, insert anywhere in the file:
2435 #+STARTUP: noptag"
2446 "If non-nil, always offer completion for all tags of all agenda files.
2447 Instead of customizing this variable directly, you might want to
2448 set it locally for remember buffers, because there no list of
2449 tags in that file can be created dynamically (there are none).
2451 (add-hook 'org-remember-mode-hook
2452 (lambda ()
2453 (set (make-local-variable
2454 'org-complete-tags-always-offer-all-agenda-tags)
2455 t)))"
2460 "List of tags that can be inherited by all entries in the file.
2461 The tags will be inherited if the variable `org-use-tag-inheritance'
2462 says they should be.
2466 "Non-nil means, use fast tag selection scheme.
2467 This is a special interface to select and deselect tags with single keys.
2468 When nil, fast selection is never used.
2469 When the symbol `auto', fast selection is used if and only if selection
2470 characters for tags have been configured, either through the variable
2471 `org-tag-alist' or through a #+TAGS line in the buffer.
2472 When t, fast selection is always used and selection keys are assigned
2473 automatically if necessary."
2481 "Non-nil means, fast tag selection exits after first change.
2482 When nil, you have to press RET to exit it.
2483 During fast tag selection, you can toggle this flag with `C-c'.
2484 This variable can also have the value `expert'. In this case, the window
2485 displaying the tags menu is not even shown, until you press C-c again."
2493 "Non-nil means, fast tags selection interface will also offer TODO states.
2497 "The column to which tags should be indented in a headline.
2498 If this number is positive, it specifies the column. If it is negative,
2499 it means that the tags should be flushright to that column. For example,
2500 -80 works well for a normal 80 character screen."
2505 "Non-nil means, realign tags after pro/demotion of TODO state change.
2506 These operations change the length of a headline and therefore shift
2507 the tags around. With this options turned on, after each such operation
2508 the tags are again aligned to `org-tags-column'."
2513 "Non-nil means, tags in levels apply also for sublevels.
2514 When nil, only the tags directly given in a specific line apply there.
2515 This may also be a list of tags that should be inherited, or a regexp that
2516 matches tags that should be inherited. Additional control is possible
2517 with the variable `org-tags-exclude-from-inheritance' which gives an
2518 explicit list of tags to be excluded from inheritance., even if the value of
2519 `org-use-tag-inheritance' would select it for inheritance.
2521 If this option is t, a match early-on in a tree can lead to a large
2522 number of matches in the subtree when constructing the agenda or creating
2523 a sparse tree. If you only want to see the first match in a tree during
2524 a search, check out the variable `org-tags-match-list-sublevels'."
2533 "List of tags that should never be inherited.
2534 This is a way to exclude a few tags from inheritance. For way to do
2535 the opposite, to actively allow inheritance for selected tags,
2536 see the variable `org-use-tag-inheritance'."
2541 "Check if TAG is one that should be inherited."
2553 "Non-nil means list also sublevels of headlines matching a search.
2554 This variable applies to tags/property searches, and also to stuck
2555 projects because this search is based on a tags match as well.
2557 When set to the symbol `indented', sublevels are indented with
2558 leading dots.
2560 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2561 the sublevels of a headline matching a tag search often also match
2562 the same search. Listing all of them can create very long lists.
2563 Setting this variable to nil causes subtrees of a match to be skipped.
2565 This variable is semi-obsolete and probably should always be true. It
2566 is better to limit inheritance to certain tags using the variables
2567 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2575 "When set, tags are sorted using this function as a comparator"
2591 "Options concerning properties in Org-mode."
2596 "How property key/value pairs should be formatted by `indent-line'.
2597 When `indent-line' hits a property definition, it will format the line
2598 according to this format, mainly to make sure that the values are
2599 lined-up with respect to each other."
2604 "Non-nil means, properties apply also for sublevels.
2606 This setting is chiefly used during property searches. Turning it on can
2607 cause significant overhead when doing a search, which is why it is not
2608 on by default.
2610 When nil, only the properties directly given in the current entry count.
2611 When t, every property is inherited. The value may also be a list of
2612 properties that should have inheritance, or a regular expression matching
2613 properties that should be inherited.
2615 However, note that some special properties use inheritance under special
2616 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2618 for valid values of a property.
2620 Note for programmers:
2621 When querying an entry with `org-entry-get', you can control if inheritance
2622 should be used. By default, `org-entry-get' looks only at the local
2623 properties. You can request inheritance by setting the inherit argument
2624 to t (to force inheritance) or to `selective' (to respect the setting
2625 in this variable)."
2634 "Check if PROPERTY is one that should be inherited."
2645 "The default column format, if no other format has been defined.
2646 This variable can be set on the per-file basis by inserting a line
2648 #+COLUMNS: %25ITEM ....."
2653 "The ellipses to be used when a field in column view is truncated.
2654 When this is the empty string, as many characters as possible are shown,
2655 but then there will be no visual indication that the field has been truncated.
2656 When this is a string of length N, the last N characters of a truncated
2657 field are replaced by this string. If the column is narrower than the
2658 ellipses string, only part of the ellipses string will be shown."
2663 "Function that modifies values for display in column view.
2664 For example, it can be used to cut out a certain part from a time stamp.
2665 The function must take 2 arguments:
2667 column-title The title of the column (*not* the property name)
2668 value The value that should be modified.
2670 The function should return the value that should be displayed,
2671 or nil if the normal value should be used."
2676 "The property that is being used to keep track of effort estimates.
2677 Effort estimates given in this property need to have the format H:MM."
2685 "List of property/value pairs that can be inherited by any entry.
2687 These are fixed values, for the preset properties. The user variable
2688 that can be used to add to this list is `org-global-properties'.
2690 The entries in this list are cons cells where the car is a property
2691 name and cdr is a string with the value. If the value represents
2696 "List of property/value pairs that can be inherited by any entry.
2698 This list will be combined with the constant `org-global-properties-fixed'.
2700 The entries in this list are cons cells where the car is a property
2701 name and cdr is a string with the value.
2703 You can set buffer-local values for the same purpose in the variable
2704 `org-file-properties' this by adding lines like
2706 #+PROPERTY: NAME VALUE"
2713 "List of property/value pairs that can be inherited by any entry.
2714 Valid for the current buffer.
2719 "Options concerning agenda views in Org-mode."
2724 "Variable used by org files to set a category for agenda display.
2725 Such files should use a file variable to set it, for example
2729 or contain a special line
2731 #+CATEGORY: ELisp
2733 If the file does not specify a category, then file's base name
2739 "The files to be used for agenda display.
2743 If an entry is a directory, all files in that directory that are matched by
2744 `org-agenda-file-regexp' will be part of the file list.
2746 If the value of the variable is not a list but a single file name, then
2747 the list of agenda files is actually stored and maintained in that file, one
2748 agenda file per line."
2755 "Regular expression to match files for `org-agenda-files'.
2756 If any element in the list in that variable contains a directory instead
2757 of a normal file, all files in that directory that are matched by this
2758 regular expression will be included."
2763 "List of extra files to be searched by text search commands.
2764 These files will be search in addition to the agenda files by the
2765 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
2766 Note that these files will only be searched for text search commands,
2767 not for the other agenda views like todo lists, tag searches or the weekly
2768 agenda. This variable is intended to list notes and possibly archive files
2769 that should also be searched by these two commands.
2770 In fact, if the first element in the list is the symbol `agenda-archives',
2771 than all archive files of all agenda files will be added to the search
2772 scope."
2783 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
2784 A nil value means to remove them, after a query, from the list."
2789 "The key to be installed in `calendar-mode-map' for switching to the agenda.
2790 The command `org-calendar-goto-agenda' will be bound to this key. The
2791 default is the character `c' because then `c' can be used to switch back and
2792 forth between agenda and calendar."
2797 "The key to be installed in `calendar-mode-map' for agenda-action.
2798 The command `org-agenda-action' will be bound to this key. The
2799 default is the character `k' because we use the same key in the agenda."
2804 "The key to be installed in `calendar-mode-map' for adding diary entries.
2805 This option is irrelevant until `org-agenda-diary-file' has been configured
2806 to point to an Org-mode file. When that is the case, the command
2807 `org-agenda-diary-entry' will be bound to the key given here, by default
2808 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
2809 if you want to continue doing this, you need to change this to a different
2810 key."
2815 "File to which to add new entries with the `i' key in agenda and calendar.
2816 When this is the symbol `diary-file', the functionality in the Emacs
2817 calendar will be used to add entries to the `diary-file'. But when this
2818 points to a file, `org-agenda-diary-entry' will be used instead."
2834 org-calendar-insert-diary-entry-key
2838 "Options for embedding LaTeX code into Org-mode."
2846 "Options for creating images from LaTeX fragments.
2847 This is a property list with the following properties:
2849 `default' means use the foreground of the default face.
2851 `default' means use the background of the default face.
2852 :scale a scaling factor for the size of the images.
2853 :html-foreground, :html-background, :html-scale
2854 the same numbers for HTML export.
2855 :matchers a list indicating which matchers should be used to
2856 find LaTeX fragments. Valid members of this list are:
2873 % The settings below are copied from fullpage.sty
2886 "The document header used for processing LaTeX fragments.
2887 It is imperative that this header make sure that no page number
2888 appears on the page."
2894 ;; The following variable is defined here because is it also used
2895 ;; when formatting latex fragments. Originally it was part of the
2896 ;; LaTeX exporter, which is why the name includes "export".
2898 "Alist of packages to be inserted in the header.
2907 "Font-lock settings for highlighting in Org-mode."
2912 "Non-nil means fontify only the stars in each headline.
2913 When nil, the entire headline is fontified.
2914 Changing it requires restart of `font-lock-mode' to become effective
2915 also in regions already fontified."
2920 "Non-nil means, hide the first N-1 stars in a headline.
2921 This works by using the face `org-hide' for these stars. This
2922 face is white for a light background, and black for a dark
2923 background. You may have to customize the face `org-hide' to
2924 make this work.
2925 Changing it requires restart of `font-lock-mode' to become effective
2926 also in regions already fontified.
2927 You may also set this on a per-file basis by adding one of the following
2928 lines to the buffer:
2930 #+STARTUP: hidestars
2931 #+STARTUP: showstars"
2936 "Non-nil means, change the face of a headline if it is marked DONE.
2937 Normally, only the TODO/DONE keyword indicates the state of a headline.
2938 When this is non-nil, the headline after the keyword is set to the
2939 `org-headline-done' as an additional indication."
2944 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
2945 Changing this variable requires a restart of Emacs to take effect."
2950 "Non-nil means fontify the whole line for headings.
2951 This is useful when setting a background color for the
2952 org-level-* faces."
2957 "Non-nil means, fontify what is treated specially by the exporters."
2962 "Non-nil mean font-lock should hide the emphasis marker characters."
2973 "Set variable and compute the emphasis regular expression."
2977 org-emphasis-alist org-emphasis-regexp-components)
2989 ;; make sure special characters appear at the right position in the class
3001 ;; Make the regexp
3009 body1
3021 body1
3029 "Components used to build the regular expression for emphasis.
3030 This is a list with 6 entries. Terminology: In an emphasis string
3034 specify what is allowed/forbidden in each part:
3036 pre Chars allowed as prematch. Beginning of line will be allowed too.
3037 post Chars allowed as postmatch. End of line will be allowed too.
3038 border The chars *forbidden* as border characters.
3040 non-shy groups here, and don't allow newline here.
3041 newline The maximum number of newlines allowed in an emphasis exp.
3043 Use customize to modify this, or restart Emacs after changing it."
3062 )
3063 "Special syntax for emphasized text.
3064 Text starting and ending with a special character will be emphasized, for
3065 example *bold*, _underlined_ and /italic/. This variable sets the marker
3066 characters, the face to be used by font-lock for highlighting in Org-mode
3067 Emacs buffers, and the HTML tags to be used for this.
3068 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3069 Use customize to modify this, or restart Emacs after changing it."
3084 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3087 ;;; Miscellaneous options
3090 "Completion in Org-mode."
3095 "Non-nil means, use ido completion wherever possible.
3096 Note that `ido-mode' must be active for this variable to be relevant.
3097 If you decide to turn this variable on, you might well want to turn off
3098 `org-outline-path-complete-in-steps'.
3099 See also `org-completion-use-iswitchb'."
3104 "Non-nil means, use iswitchb completion wherever possible.
3105 Note that `iswitchb-mode' must be active for this variable to be relevant.
3106 If you decide to turn this variable on, you might well want to turn off
3107 `org-outline-path-complete-in-steps'.
3108 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3114 Normal means, no org-mode-specific context."
3118 ;;; Functions and variables from their packages
3119 ;; Declared here to avoid compiler warnings
3121 ;; XEmacs only
3127 ;; Emacs only
3130 ;; Various packages
3148 org-format-agenda-item "org-agenda"
3174 ;;; Autoload and prepare some org modules
3176 ;; Some table stuff that needs to be defined here, because it is used
3177 ;; by the functions setting up org-mode or checking for table context.
3190 "Searching from within a table (any type) this finds the first line
3193 ;; Autoload the functions in org-table.el that are needed by functions here.
3198 org-table-convert org-table-convert-region org-table-copy-down
3199 org-table-copy-region org-table-create
3200 org-table-create-or-convert-from-region
3201 org-table-create-with-table.el org-table-current-dline
3202 org-table-cut-region org-table-delete-column org-table-edit-field
3203 org-table-edit-formulas org-table-end org-table-eval-formula
3204 org-table-export org-table-field-info
3205 org-table-get-stored-formulas org-table-goto-column
3206 org-table-hline-and-move org-table-import org-table-insert-column
3207 org-table-insert-hline org-table-insert-row org-table-iterate
3208 org-table-justify-field-maybe org-table-kill-row
3209 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3210 org-table-move-column org-table-move-column-left
3211 org-table-move-column-right org-table-move-row
3212 org-table-move-row-down org-table-move-row-up
3213 org-table-next-field org-table-next-row org-table-paste-rectangle
3214 org-table-previous-field org-table-recalculate
3215 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3216 org-table-toggle-coordinate-overlays
3217 org-table-toggle-formula-debugger org-table-wrap-region
3218 orgtbl-mode turn-on-orgtbl org-table-to-lisp)))
3221 "Return t if the cursor is inside an org-type table.
3222 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3227 org-table-line-regexp)))
3228 nil))
3232 "Return t if and only if we are at a table.el table."
3238 "If there is a table.el table nearby, recognize it and move into it."
3244 nil
3254 t
3259 t)
3260 nil)
3261 nil))
3264 "Return t if the cursor is inside a hline in a table."
3269 nil))
3274 "Apply FUNCTION to the start of all tables in the buffer."
3289 ;; Declare and autoload functions from org-exp.el & Co
3297 org-insert-export-options-template
3298 org-table-clean-before-export))
3301 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3302 org-export-region-as-ascii))
3305 org-replace-region-by-latex org-export-region-as-latex
3306 org-export-as-latex org-export-as-pdf
3307 org-export-as-pdf-and-open))
3310 org-export-as-html-batch org-export-as-html-to-buffer
3311 org-replace-region-by-html org-export-region-as-html
3312 org-export-as-html))
3315 org-replace-region-by-docbook org-export-region-as-docbook
3316 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3317 org-export-as-docbook))
3320 org-export-icalendar-all-agenda-files
3321 org-export-icalendar-combine-agenda-files))
3325 ;; Declare and autoload functions from org-agenda.el
3330 org-todo-list org-tags-view org-agenda-list-stuck-projects
3331 org-diary org-agenda-to-appt
3332 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3334 ;; Autoload org-remember
3339 org-remember-apply-template org-remember org-remember-handler)))
3341 ;; Autoload org-clock.el
3357 "Return non-nil if clock is currently running.
3358 The return value is actually the clock marker."
3363 "org-clock"
3365 org-clock-goto org-clock-sum org-clock-display
3366 org-clock-remove-overlays org-clock-report
3367 org-clocktable-shift org-dblock-write:clocktable
3368 org-get-clocktable org-resolve-clocks)))
3371 "If this is a CLOCK line, update it and return t.
3372 Otherwise, return nil."
3381 ts te h m s neg)
3384 nil)
3389 ;; The clock is running here
3410 t))))))
3413 "Check if the current buffer contains the running clock.
3414 If yes, offer to stop it and to save the buffer with the changes."
3423 "Check if this line starts a clock table, if yes, shift the time block."
3427 ;; Autoload org-timer.el
3431 "org-timer"
3433 org-timer-change-times-in-region
3434 org-timer-set-timer
3435 org-timer-reset-timers
3436 org-timer-show-remaining-time)))
3438 ;; Autoload org-feed.el
3442 "org-feed"
3446 ;; Autoload org-indent.el
3448 ;; Define the variable already here, to make sure we have it.
3450 "Non-nil if Org-Indent mode is enabled.
3455 "org-indent"
3458 ;; Autoload org-mobile.el
3462 "org-mobile"
3465 ;; Autoload archiving code
3466 ;; The stuff that is needed for cycling and tags has to be defined here.
3469 "Options concerning archiving in Org-mode."
3474 "The location where subtrees should be archived.
3476 The value of this variable is a string, consisting of two parts,
3477 separated by a double-colon. The first part is a filename and
3478 the second part is a headline.
3480 When the filename is omitted, archiving happens in the same file.
3481 %s in the filename will be replaced by the current file
3482 name (without the directory part). Archiving to a different file
3483 is useful to keep archived entries from contributing to the
3484 Org-mode Agenda.
3486 The archived entries will be filed as subtrees of the specified
3487 headline. When the headline is omitted, the subtrees are simply
3488 filed away at the end of the file, as top-level entries. Also in
3489 the heading you can use %s to represent the file name, this can be
3490 useful when using the same archive for a number of different files.
3492 Here are a few examples:
3494 If the current file is Projects.org, archive in file
3495 Projects.org_archive, as top-level trees. This is the default.
3498 Archive in the current file, under the top-level headline
3502 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3505 Archive in file ~/org/archive.org (absolute path), under headlines
3509 Archive in file ./basement (relative path), as level 3 trees
3512 You may set this option on a per-file basis by adding to the buffer a
3513 line like
3515 #+ARCHIVE: basement::** Finished Tasks
3517 You may also define it locally for a subtree by setting an ARCHIVE property
3518 in the entry. If such a property is found in an entry, or anywhere up
3519 the hierarchy, it will be used."
3524 "The tag that marks a subtree as archived.
3525 An archived subtree does not open during visibility cycling, and does
3526 not contribute to the agenda listings.
3527 After changing this, font-lock must be restarted in the relevant buffers to
3528 get the proper fontification."
3534 "Non-nil means, the agenda will skip any items located in archived trees.
3535 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3536 variable is no longer recommended, you should leave it at the value t.
3537 Instead, use the key `v' to cycle the archives-mode in the agenda."
3543 "Non-nil means, ignore archived trees when creating column view."
3549 "Non-nil means, `org-cycle' will open archived trees.
3550 An archived tree is a tree marked with the tag ARCHIVE.
3551 When nil, archived trees will stay folded. You can still open them with
3552 normal outline commands like `show-all', but not with the cycling commands."
3558 "Non-nil means sparse tree construction shows matches in archived trees.
3559 When nil, matches in these trees are highlighted, but the trees are kept in
3560 collapsed state."
3566 "Re-hide all archived subtrees after a visibility state change."
3577 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
3580 "Cycle subtree even if it is archived."
3587 "Re-hide all archived subtrees after a visibility state change."
3601 flag)))
3608 org-archive-to-archive-sibling org-toggle-archive-tag
3609 org-archive-subtree-default
3610 org-archive-subtree-default-with-confirmation)))
3612 ;; Autoload Column View Code
3620 org-columns-compute org-agenda-columns org-columns-remove-overlays
3623 ;; Autoload ID code
3631 org-id-get-with-outline-path-completion
3632 org-id-get-with-outline-drilling
3633 org-id-goto org-id-find org-id-store-link))
3635 ;; Autoload Plotting Code
3640 ;;; Variables for pre-computed regular expressions, all buffer local
3658 "Matches a headline and puts everything into groups:
3659 group 1: the stars
3660 group 2: The todo keyword, maybe
3661 group 3: Priority cookie
3662 group 4: True headline
3668 "Matches a headline and puts TODO state into group 2 if present.
3723 "Regular expression to match a plain time or time range.
3724 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
3725 groups carry important information:
3726 0 the full match
3727 1 the first time, range or not
3735 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
3736 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
3737 groups carry important information:
3738 0 the full match
3739 7 hours of duration
3748 "Regular expression to match a timestamp time or time range.
3749 After a match, the following groups carry important information:
3750 0 the full match
3751 1 date plus weekday, for back referencing to make sure both times are on the same day
3752 2 the first time, range or not
3800 "Variable associated with STARTUP options for org-mode.
3801 Each element is a list of three items: The startup options as written
3802 in the #+STARTUP line, the corresponding variable, and the value to
3803 set this variable to if the option is found. An optional forth element PUSH
3807 "Precompute regular expressions for current buffer."
3825 kwds kws0 kwsa key log value cat arch tags const links hw dws
3826 tail sep kws1 prio props ftags drawers beamer-p
3849 ;; general TODO-like setup
3861 links)))
3867 props)))
3872 ftags
3882 l var val)
3910 ))))
3926 ;; Process the TODO keywords
3928 ;; Use the global values as if they had been given locally.
3940 kws)))
3943 kwsa nil
3946 ;; 1 2
3954 kw)
3956 kws0)
3973 ;; Process the constants
3981 ;; Process the tags.
3992 tgs))
4000 ;; Compute the regular expressions and other local variables
4008 org-drawer-regexp
4012 org-not-done-keywords
4014 org-todo-regexp
4017 org-not-done-regexp
4021 org-not-done-heading-regexp
4025 org-todo-line-regexp
4029 org-complex-heading-regexp
4034 org-complex-heading-regexp-format
4039 org-nl-done-regexp
4043 org-todo-line-tags-regexp
4048 org-looking-at-done-regexp
4053 org-deadline-time-regexp
4055 org-deadline-line-regexp
4057 org-scheduled-regexp
4059 org-scheduled-time-regexp
4061 org-closed-time-regexp
4063 org-keyword-time-regexp
4069 org-keyword-time-not-clock-regexp
4075 org-maybe-keyword-time-regexp
4081 org-planning-or-clock-line-re
4086 org-all-time-keywords
4089 org-clock-string org-closed-string))
4090 )
4095 "Return the contents of FILE, as a string."
4109 "Extract the log state setting from a TODO keyword string.
4123 "Remove a pair of parenthesis at the end of each string in LIST."
4127 x))
4128 list))
4130 ;; FIXME: this could be done much better, using second characters etc.
4132 "Assign fast keys to a keyword-key alist.
4133 Respect keys that are already there."
4144 ;; automatically assign a character.
4156 ;;; Some variables used in various places
4163 "Function to be called when `C-c C-c' is used.
4167 ;; FIXME: Occasionally check by commenting these, to make sure
4168 ;; no other functions uses these, forgetting to let-bind them.
4173 ;; Defined somewhere in this file, but used before definition.
4179 ;;;; Define the Org-mode
4182 (error "Conflict with outdated version of allout.el. Load org.el before allout.el, or upgrade to newer allout, for example by switching to Emacs 22."))
4185 ;; We use a before-change function to check if a table might need
4186 ;; an update.
4188 "Indicates that a table might need an update.
4189 This variable is set by `org-before-change-function'.
4192 "Every change indicates that a table might need an update."
4203 ;;;###autoload
4205 "Outline-based notes management and organizer, alias
4208 Org-mode develops organizational tasks around a NOTES file which
4209 contains information about projects as plain text. Org-mode is
4210 implemented on top of outline-mode, which is ideal to keep the content
4211 of large files well structured. It supports ToDo items, deadlines and
4212 time stamps, which magically appear in the diary listing of the Emacs
4213 calendar. Tables are easily created with a built-in table editor.
4214 Plain text URL-like links connect to websites, emails (VM), Usenet
4215 messages (Gnus), BBDB entries, and any files related to the project.
4216 For printing and sharing of notes, an Org-mode file (or a part of it)
4217 can be exported as a structured ASCII or HTML file.
4219 The following commands are available:
4223 ;; Get rid of Outline menus, they are not needed
4224 ;; Need to do this here because define-derived-mode sets up
4225 ;; the keymap so late. Still, it is a waste to call this each time
4226 ;; we switch another buffer into org-mode.
4229 ;; Assume this is Greg's port, it used easymenu
4254 org-display-table 4
4257 org-ellipsis)))
4262 ;; tag faces set outside customize.... force initialization.
4264 ;; Calc embedded
4271 ;; Activate before-change-function
4275 ;; Check for running clock before killing a buffer
4277 ;; Paragraphs and auto-filling
4281 ;; Make sure dependence stuff works reliably, even for users who set it
4282 ;; too late :-(
4294 ;; Comment characters
4295 ; (org-set-local 'comment-start "#") ;; FIXME: this breaks wrapping
4298 ;; Align options lines
4300 'align-mode-rules-list
4305 ;; Imenu
4309 ;; Make isearch reveal context
4312 ;; Emacs 21 and XEmacs make use of the hook
4314 ;; Emacs 22 deals with this through a special variable
4318 ;; Turn on org-beamer-mode?
4321 ;; If empty file that did not turn on org-mode automatically, make it to.
4344 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4353 ;;;; Font-Lock stuff, including the activators
4358 (org-defkey org-mouse-map
4359 (if (featurep 'xemacs) [button3] [mouse-3]) 'org-find-file-at-mouse)
4360 (when org-mouse-1-follows-link
4361 (org-defkey org-mouse-map [follow-link] 'mouse-face))
4362 (when org-tab-follows-link
4363 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
4364 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
4366 (require 'font-lock)
4369 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
4370 "shell" "elisp"))
4371 (defvar org-link-types-re nil
4373 (defvar org-link-re-with-space nil
4374 "Matches a link with spaces, optional angular brackets around it.")
4375 (defvar org-link-re-with-space2 nil
4376 "Matches a link with spaces, optional angular brackets around it.")
4377 (defvar org-link-re-with-space3 nil
4378 "Matches a link with spaces, only for internal part in bracket links.")
4379 (defvar org-angle-link-re nil
4380 "Matches link with angular brackets, spaces are allowed.")
4381 (defvar org-plain-link-re nil
4382 "Matches plain link, without spaces.")
4383 (defvar org-bracket-link-regexp nil
4384 "Matches a link in double brackets.")
4385 (defvar org-bracket-link-analytic-regexp nil
4386 "Regular expression used to analyze links.
4387 Here is what the match groups contain after a match:
4388 1: http:
4389 2: http
4390 3: path
4391 4: [desc]
4392 5: desc")
4393 (defvar org-bracket-link-analytic-regexp++ nil
4394 "Like org-bracket-link-analytic-regexp, but include coderef internal type.")
4395 (defvar org-any-link-re nil
4396 "Regular expression matching any link.")
4398 (defun org-make-link-regexps ()
4399 "Update the link regular expressions.
4400 This should be called after the variable `org-link-types' has changed."
4401 (setq org-link-types-re
4402 (concat
4404 org-link-re-with-space
4405 (concat
4408 "[^" org-non-link-chars "]*"
4410 org-link-re-with-space2
4411 (concat
4416 org-link-re-with-space3
4417 (concat
4421 org-angle-link-re
4422 (concat
4425 "[^" org-non-link-chars "]*"
4427 org-plain-link-re
4428 (concat
4432 org-bracket-link-regexp
4434 org-bracket-link-analytic-regexp
4435 (concat
4442 org-bracket-link-analytic-regexp++
4443 (concat
4450 org-any-link-re
4455 (org-make-link-regexps)
4458 "Regular expression for fast time stamp matching.")
4460 "Regular expression for fast time stamp matching.")
4461 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4462 "Regular expression matching time strings for analysis.
4463 This one does not require the space after the date, so it can be used
4464 on a string that terminates immediately after the date.")
4465 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4466 "Regular expression matching time strings for analysis.")
4468 "Regular expression matching time stamps, with groups.")
4470 "Regular expression matching time stamps (also [..]), with groups.")
4471 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
4472 "Regular expression matching a time stamp range.")
4473 (defconst org-tr-regexp-both
4474 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
4475 "Regular expression matching a time stamp range.")
4478 "Regular expression matching a time stamp or time stamp range.")
4481 "Regular expression matching a time stamp or time stamp range.
4482 The time stamps may be either active or inactive.")
4484 (defvar org-emph-face nil)
4486 (defun org-do-emphasis-faces (limit)
4487 "Run through the buffer and add overlays to links."
4488 (let (rtn a)
4489 (while (and (not rtn) (re-search-forward org-emph-re limit t))
4490 (if (not (= (char-after (match-beginning 3))
4491 (char-after (match-beginning 4))))
4492 (progn
4493 (setq rtn t)
4494 (setq a (assoc (match-string 3) org-emphasis-alist))
4495 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
4496 'face
4497 (nth 1 a))
4498 (and (nth 4 a)
4499 (org-remove-flyspell-overlays-in
4500 (match-beginning 0) (match-end 0)))
4501 (add-text-properties (match-beginning 2) (match-end 2)
4502 '(font-lock-multiline t))
4503 (when org-hide-emphasis-markers
4504 (add-text-properties (match-end 4) (match-beginning 5)
4505 '(invisible org-link))
4506 (add-text-properties (match-beginning 3) (match-end 3)
4507 '(invisible org-link)))))
4508 (backward-char 1))
4509 rtn))
4511 (defun org-emphasize (&optional char)
4512 "Insert or change an emphasis, i.e. a font like bold or italic.
4513 If there is an active region, change that region to a new emphasis.
4514 If there is no region, just insert the marker characters and position
4515 the cursor between them.
4516 CHAR should be either the marker character, or the first character of the
4517 HTML tag associated with that emphasis. If CHAR is a space, the means
4518 to remove the emphasis of the selected region.
4519 If char is not given (for example in an interactive call) it
4520 will be prompted for."
4521 (interactive)
4522 (let ((eal org-emphasis-alist) e det
4523 (erc org-emphasis-regexp-components)
4524 (prompt "")
4525 (string "") beg end move tag c s)
4526 (if (org-region-active-p)
4527 (setq beg (region-beginning) end (region-end)
4528 string (buffer-substring beg end))
4529 (setq move t))
4531 (while (setq e (pop eal))
4532 (setq tag (car (org-split-string (nth 2 e) "[ <>/]+"))
4533 c (aref tag 0))
4534 (push (cons c (string-to-char (car e))) det)
4535 (setq prompt (concat prompt (format " [%s%c]%s" (car e) c
4536 (substring tag 1)))))
4537 (setq det (nreverse det))
4538 (unless char
4539 (message "%s" (concat "Emphasis marker or tag:" prompt))
4540 (setq char (read-char-exclusive)))
4541 (setq char (or (cdr (assoc char det)) char))
4542 (if (equal char ?\ )
4543 (setq s "" move nil)
4544 (unless (assoc (char-to-string char) org-emphasis-alist)
4546 (setq s (char-to-string char)))
4547 (while (and (> (length string) 1)
4548 (equal (substring string 0 1) (substring string -1))
4549 (assoc (substring string 0 1) org-emphasis-alist))
4550 (setq string (substring string 1 -1)))
4551 (setq string (concat s string s))
4552 (if beg (delete-region beg end))
4553 (unless (or (bolp)
4555 (char-to-string (char-before (point)))))
4556 (insert " "))
4558 (char-to-string (char-after (point))))
4559 (insert " ") (backward-char 1))
4560 (insert string)
4561 (and move (backward-char 1))))
4563 (defconst org-nonsticky-props
4564 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text))
4566 (defsubst org-rear-nonsticky-at (pos)
4567 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
4569 (defun org-activate-plain-links (limit)
4570 "Run through the buffer and add overlays to links."
4571 (catch 'exit
4572 (let (f)
4573 (if (re-search-forward org-plain-link-re limit t)
4574 (progn
4575 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4576 (setq f (get-text-property (match-beginning 0) 'face))
4577 (if (or (eq f 'org-tag)
4578 (and (listp f) (memq 'org-tag f)))
4579 nil
4580 (add-text-properties (match-beginning 0) (match-end 0)
4581 (list 'mouse-face 'highlight
4582 'face 'org-link
4583 'keymap org-mouse-map))
4584 (org-rear-nonsticky-at (match-end 0)))
4585 t)))))
4587 (defun org-activate-code (limit)
4589 (progn
4590 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4591 (remove-text-properties (match-beginning 0) (match-end 0)
4592 '(display t invisible t intangible t))
4593 t)))
4595 (defun org-fontify-meta-lines-and-blocks (limit)
4596 "Fontify #+ lines and blocks, in the correct ways."
4597 (let ((case-fold-search t))
4598 (if (re-search-forward
4600 limit t)
4601 (let ((beg (match-beginning 0))
4602 (beg1 (line-beginning-position 2))
4603 (dc1 (downcase (match-string 2)))
4604 (dc3 (downcase (match-string 3)))
4605 end end1 quoting block-type)
4606 (cond
4607 ((member dc1 '("html:" "ascii:" "latex:" "docbook:"))
4608 ;; a single line of backend-specific content
4609 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4610 (remove-text-properties (match-beginning 0) (match-end 0)
4611 '(display t invisible t intangible t))
4612 (add-text-properties (match-beginning 1) (match-end 3)
4613 '(font-lock-fontified t face org-meta-line))
4614 (add-text-properties (match-beginning 6) (match-end 6)
4615 '(font-lock-fontified t face org-block))
4616 t)
4617 ((and (match-end 4) (equal dc3 "begin"))
4618 ;; Truely a block
4619 (setq block-type (downcase (match-string 5))
4620 quoting (member block-type org-protecting-blocks))
4621 (when (re-search-forward
4623 nil t) ;; on purpose, we look further than LIMIT
4624 (setq end (match-end 0) end1 (1- (match-beginning 0)))
4625 (when quoting
4626 (remove-text-properties beg end
4627 '(display t invisible t intangible t)))
4628 (add-text-properties
4629 beg end
4630 '(font-lock-fontified t font-lock-multiline t))
4631 (add-text-properties beg beg1 '(face org-meta-line))
4632 (add-text-properties end1 end '(face org-meta-line))
4633 (cond
4634 (quoting
4635 (add-text-properties beg1 end1 '(face org-block)))
4636 ((string= block-type "quote")
4637 (add-text-properties beg1 end1 '(face org-quote)))
4638 ((string= block-type "verse")
4639 (add-text-properties beg1 end1 '(face org-verse))))
4640 t))
4642 ;; just any other in-buffer setting, but not indented
4643 (add-text-properties
4644 beg (match-end 0)
4645 '(font-lock-fontified t face org-meta-line))
4646 t)
4647 ((or (member dc1 '("begin:" "end:" "caption:" "label:"
4648 "orgtbl:" "tblfm:" "tblname:"))
4649 (and (match-end 4) (equal dc3 "attr")))
4650 (add-text-properties
4651 beg (match-end 0)
4652 '(font-lock-fontified t face org-meta-line))
4653 t)
4654 ((member dc3 '(" " ""))
4655 (add-text-properties
4656 beg (match-end 0)
4657 '(font-lock-fontified t face font-lock-comment-face)))
4658 (t nil))))))
4660 (defun org-activate-angle-links (limit)
4661 "Run through the buffer and add overlays to links."
4662 (if (re-search-forward org-angle-link-re limit t)
4663 (progn
4664 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4665 (add-text-properties (match-beginning 0) (match-end 0)
4666 (list 'mouse-face 'highlight
4667 'keymap org-mouse-map))
4668 (org-rear-nonsticky-at (match-end 0))
4669 t)))
4671 (defun org-activate-footnote-links (limit)
4672 "Run through the buffer and add overlays to links."
4674 limit t)
4675 (progn
4676 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4677 (add-text-properties (match-beginning 2) (match-end 2)
4678 (list 'mouse-face 'highlight
4679 'keymap org-mouse-map
4680 'help-echo
4681 (if (= (point-at-bol) (match-beginning 2))
4682 "Footnote definition"
4683 "Footnote reference")
4684 ))
4685 (org-rear-nonsticky-at (match-end 2))
4686 t)))
4688 (defun org-activate-bracket-links (limit)
4689 "Run through the buffer and add overlays to bracketed links."
4690 (if (re-search-forward org-bracket-link-regexp limit t)
4691 (let* ((help (concat "LINK: "
4692 (org-match-string-no-properties 1)))
4693 ;; FIXME: above we should remove the escapes.
4694 ;; but that requires another match, protecting match data,
4695 ;; a lot of overhead for font-lock.
4696 (ip (org-maybe-intangible
4697 (list 'invisible 'org-link
4698 'keymap org-mouse-map 'mouse-face 'highlight
4699 'font-lock-multiline t 'help-echo help)))
4700 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
4701 'font-lock-multiline t 'help-echo help)))
4702 ;; We need to remove the invisible property here. Table narrowing
4703 ;; may have made some of this invisible.
4704 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4705 (remove-text-properties (match-beginning 0) (match-end 0)
4706 '(invisible nil))
4707 (if (match-end 3)
4708 (progn
4709 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
4710 (org-rear-nonsticky-at (match-beginning 3))
4711 (add-text-properties (match-beginning 3) (match-end 3) vp)
4712 (org-rear-nonsticky-at (match-end 3))
4713 (add-text-properties (match-end 3) (match-end 0) ip)
4714 (org-rear-nonsticky-at (match-end 0)))
4715 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
4716 (org-rear-nonsticky-at (match-beginning 1))
4717 (add-text-properties (match-beginning 1) (match-end 1) vp)
4718 (org-rear-nonsticky-at (match-end 1))
4719 (add-text-properties (match-end 1) (match-end 0) ip)
4720 (org-rear-nonsticky-at (match-end 0)))
4721 t)))
4723 (defun org-activate-dates (limit)
4724 "Run through the buffer and add overlays to dates."
4725 (if (re-search-forward org-tsr-regexp-both limit t)
4726 (progn
4727 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4728 (add-text-properties (match-beginning 0) (match-end 0)
4729 (list 'mouse-face 'highlight
4730 'keymap org-mouse-map))
4731 (org-rear-nonsticky-at (match-end 0))
4732 (when org-display-custom-times
4733 (if (match-end 3)
4734 (org-display-custom-time (match-beginning 3) (match-end 3)))
4735 (org-display-custom-time (match-beginning 1) (match-end 1)))
4736 t)))
4738 (defvar org-target-link-regexp nil
4739 "Regular expression matching radio targets in plain text.")
4740 (make-variable-buffer-local 'org-target-link-regexp)
4742 "Regular expression matching a link target.")
4744 "Regular expression matching a radio target.")
4745 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
4746 "Regular expression matching any target.")
4748 (defun org-activate-target-links (limit)
4749 "Run through the buffer and add overlays to target matches."
4750 (when org-target-link-regexp
4751 (let ((case-fold-search t))
4752 (if (re-search-forward org-target-link-regexp limit t)
4753 (progn
4754 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
4755 (add-text-properties (match-beginning 0) (match-end 0)
4756 (list 'mouse-face 'highlight
4757 'keymap org-mouse-map
4758 'help-echo "Radio target link"
4759 'org-linked-text t))
4760 (org-rear-nonsticky-at (match-end 0))
4761 t)))))
4763 (defun org-update-radio-target-regexp ()
4764 "Find all radio targets in this file and update the regular expression."
4765 (interactive)
4766 (when (memq 'radio org-activate-links)
4767 (setq org-target-link-regexp
4768 (org-make-target-link-regexp (org-all-targets 'radio)))
4769 (org-restart-font-lock)))
4771 (defun org-hide-wide-columns (limit)
4772 (let (s e)
4773 (setq s (text-property-any (point) (or limit (point-max))
4774 'org-cwidth t))
4775 (when s
4776 (setq e (next-single-property-change s 'org-cwidth))
4777 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
4778 (goto-char e)
4779 t)))
4781 (defvar org-latex-and-specials-regexp nil
4782 "Regular expression for highlighting export special stuff.")
4783 (defvar org-match-substring-regexp)
4784 (defvar org-match-substring-with-braces-regexp)
4786 ;; This should be with the exporter code, but we also use if for font-locking
4787 (defconst org-export-html-special-string-regexps
4792 "Regular expressions for special string conversion.")
4795 (defun org-compute-latex-and-specials-regexp ()
4796 "Compute regular expression for stuff treated specially by exporters."
4797 (if (not org-highlight-latex-fragments-and-specials)
4798 (org-set-local 'org-latex-and-specials-regexp nil)
4799 (require 'org-exp)
4800 (let*
4801 ((matchers (plist-get org-format-latex-options :matchers))
4802 (latexs (delq nil (mapcar (lambda (x) (if (member (car x) matchers) x))
4803 org-latex-regexps)))
4804 (options (org-combine-plists (org-default-export-plist)
4805 (org-infile-export-plist)))
4806 (org-export-with-sub-superscripts (plist-get options :sub-superscript))
4807 (org-export-with-LaTeX-fragments (plist-get options :LaTeX-fragments))
4808 (org-export-with-TeX-macros (plist-get options :TeX-macros))
4809 (org-export-html-expand (plist-get options :expand-quoted-html))
4810 (org-export-with-special-strings (plist-get options :special-strings))
4811 (re-sub
4812 (cond
4813 ((equal org-export-with-sub-superscripts '{})
4814 (list org-match-substring-with-braces-regexp))
4815 (org-export-with-sub-superscripts
4816 (list org-match-substring-regexp))
4817 (t nil)))
4818 (re-latex
4819 (if org-export-with-LaTeX-fragments
4820 (mapcar (lambda (x) (nth 1 x)) latexs)))
4821 (re-macros
4822 (if org-export-with-TeX-macros
4824 (regexp-opt
4825 (append (mapcar 'car org-html-entities)
4826 (if (boundp 'org-latex-entities)
4827 (mapcar (lambda (x)
4828 (or (car-safe x) x))
4829 org-latex-entities)
4830 nil))
4831 'words))) ; FIXME
4832 ))
4834 (re-special (if org-export-with-special-strings
4835 (mapcar (lambda (x) (car x))
4836 org-export-html-special-string-regexps)))
4837 (re-rest
4838 (delq nil
4839 (list
4841 ))))
4842 (org-set-local
4843 'org-latex-and-specials-regexp
4844 (mapconcat 'identity (append re-latex re-sub re-macros re-special
4847 (defun org-do-latex-and-special-faces (limit)
4848 "Run through the buffer and add overlays to links."
4849 (when org-latex-and-specials-regexp
4850 (let (rtn d)
4851 (while (and (not rtn) (re-search-forward org-latex-and-specials-regexp
4852 limit t))
4853 (if (not (memq (car-safe (get-text-property (1+ (match-beginning 0))
4854 'face))
4855 '(org-code org-verbatim underline)))
4856 (progn
4857 (setq rtn t
4858 d (cond ((member (char-after (1+ (match-beginning 0)))
4859 '(?_ ?^)) 1)
4860 (t 0)))
4861 (font-lock-prepend-text-property
4862 (+ d (match-beginning 0)) (match-end 0)
4863 'face 'org-latex-and-export-specials)
4864 (add-text-properties (+ d (match-beginning 0)) (match-end 0)
4865 '(font-lock-multiline t)))))
4866 rtn)))
4868 (defun org-restart-font-lock ()
4869 "Restart font-lock-mode, to force refontification."
4870 (when (and (boundp 'font-lock-mode) font-lock-mode)
4871 (font-lock-mode -1)
4872 (font-lock-mode 1)))
4874 (defun org-all-targets (&optional radio)
4875 "Return a list of all targets in this file.
4876 With optional argument RADIO, only find radio targets."
4877 (let ((re (if radio org-radio-target-regexp org-target-regexp))
4878 rtn)
4879 (save-excursion
4880 (goto-char (point-min))
4881 (while (re-search-forward re nil t)
4882 (add-to-list 'rtn (downcase (org-match-string-no-properties 1))))
4883 rtn)))
4885 (defun org-make-target-link-regexp (targets)
4886 "Make regular expression matching all strings in TARGETS.
4887 The regular expression finds the targets also if there is a line break
4888 between words."
4889 (and targets
4890 (concat
4892 (mapconcat
4893 (lambda (x)
4894 (while (string-match " +" x)
4896 x)
4897 targets
4901 (defun org-activate-tags (limit)
4903 (progn
4904 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
4905 (add-text-properties (match-beginning 1) (match-end 1)
4906 (list 'mouse-face 'highlight
4907 'keymap org-mouse-map))
4908 (org-rear-nonsticky-at (match-end 1))
4909 t)))
4911 (defun org-outline-level ()
4912 "Compute the outline level of the heading at point.
4913 This function assumes that the cursor is at the beginning of a line matched
4914 by outline-regexp. Otherwise it returns garbage.
4915 If this is called at a normal headline, the level is the number of stars.
4916 Use `org-reduced-level' to remove the effect of `org-odd-levels'.
4917 For plain list items, if they are matched by `outline-regexp', this returns
4918 1000 plus the line indentation."
4919 (save-excursion
4920 (looking-at outline-regexp)
4921 (if (match-beginning 1)
4922 (+ (org-get-string-indentation (match-string 1)) 1000)
4923 (1- (- (match-end 0) (match-beginning 0))))))
4925 (defvar org-font-lock-keywords nil)
4927 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
4928 "Regular expression matching a property line.")
4930 (defvar org-font-lock-hook nil
4931 "Functions to be called for special font lock stuff.")
4933 (defun org-font-lock-hook (limit)
4934 (run-hook-with-args 'org-font-lock-hook limit))
4936 (defun org-set-font-lock-defaults ()
4937 (let* ((em org-fontify-emphasized-text)
4938 (lk org-activate-links)
4939 (org-font-lock-extra-keywords
4940 (list
4941 ;; Call the hook
4942 '(org-font-lock-hook)
4943 ;; Headlines
4944 `(,(if org-fontify-whole-heading-line
4947 (1 (org-get-level-face 1))
4948 (2 (org-get-level-face 2))
4949 (3 (org-get-level-face 3)))
4950 ;; Table lines
4952 (1 'org-table t))
4953 ;; Table internals
4958 ;; Drawers
4959 (list org-drawer-regexp '(0 'org-special-keyword t))
4961 ;; Properties
4962 (list org-property-re
4963 '(1 'org-special-keyword t)
4964 '(3 'org-property-value t))
4965 ;; Links
4966 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
4967 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
4968 (if (memq 'plain lk) '(org-activate-plain-links))
4969 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
4970 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
4971 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
4972 (if (memq 'footnote lk) '(org-activate-footnote-links
4973 (2 'org-footnote t)))
4975 '(org-hide-wide-columns (0 nil append))
4976 ;; TODO lines
4978 '(1 (org-get-todo-face 1) t))
4979 ;; DONE
4980 (if org-fontify-done-headline
4984 '(2 'org-headline-done t))
4985 nil)
4986 ;; Priorities
4987 '(org-font-lock-add-priority-faces)
4988 ;; Tags
4989 '(org-font-lock-add-tag-faces)
4990 ;; Special keywords
4995 ;; Emphasis
4996 (if em
4997 (if (featurep 'xemacs)
4998 '(org-do-emphasis-faces (0 nil append))
4999 '(org-do-emphasis-faces)))
5000 ;; Checkboxes
5002 2 'org-checkbox prepend)
5003 (if org-provide-checkbox-statistics
5005 (0 (org-get-checkbox-statistics-face) t)))
5006 ;; Description list items
5008 2 'bold prepend)
5009 ;; ARCHIVEd headings
5011 '(1 'org-archived prepend))
5012 ;; Specials
5013 '(org-do-latex-and-special-faces)
5014 ;; Code
5015 '(org-activate-code (1 'org-code t))
5016 ;; COMMENT
5019 '(1 'org-special-keyword t))
5020 '("^#.*" (0 'font-lock-comment-face t))
5021 ;; Blocks and meta lines
5022 '(org-fontify-meta-lines-and-blocks)
5023 )))
5024 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
5025 ;; Now set the full font-lock-keywords
5026 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
5027 (org-set-local 'font-lock-defaults
5028 '(org-font-lock-keywords t nil nil backward-paragraph))
5029 (kill-local-variable 'font-lock-keywords) nil))
5031 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
5032 "Fontify string S like in Org-mode"
5033 (with-temp-buffer
5034 (insert s)
5035 (let ((org-odd-levels-only odd-levels))
5036 (org-mode)
5037 (font-lock-fontify-buffer)
5038 (buffer-string))))
5040 (defvar org-m nil)
5041 (defvar org-l nil)
5042 (defvar org-f nil)
5043 (defun org-get-level-face (n)
5044 "Get the right face for match N in font-lock matching of headlines."
5045 (setq org-l (- (match-end 2) (match-beginning 1) 1))
5046 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
5047 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
5048 (cond
5049 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
5050 ((eq n 2) org-f)
5051 (t (if org-level-color-stars-only nil org-f))))
5053 (defun org-get-todo-face (kwd)
5054 "Get the right face for a TODO keyword KWD.
5055 If KWD is a number, get the corresponding match group."
5056 (if (numberp kwd) (setq kwd (match-string kwd)))
5057 (or (cdr (assoc kwd org-todo-keyword-faces))
5058 (and (member kwd org-done-keywords) 'org-done)
5059 'org-todo))
5061 (defun org-font-lock-add-tag-faces (limit)
5062 "Add the special tag faces."
5063 (when (and org-tag-faces org-tags-special-faces-re)
5064 (while (re-search-forward org-tags-special-faces-re limit t)
5065 (add-text-properties (match-beginning 1) (match-end 1)
5066 (list 'face (org-get-tag-face 1)
5067 'font-lock-fontified t))
5068 (backward-char 1))))
5070 (defun org-font-lock-add-priority-faces (limit)
5071 "Add the special priority faces."
5073 (add-text-properties
5074 (match-beginning 0) (match-end 0)
5075 (list 'face (or (cdr (assoc (char-after (match-beginning 1))
5076 org-priority-faces))
5077 'org-special-keyword)
5078 'font-lock-fontified t))))
5080 (defun org-get-tag-face (kwd)
5081 "Get the right face for a TODO keyword KWD.
5082 If KWD is a number, get the corresponding match group."
5083 (if (numberp kwd) (setq kwd (match-string kwd)))
5084 (or (cdr (assoc kwd org-tag-faces))
5085 'org-tag))
5087 (defun org-unfontify-region (beg end &optional maybe_loudly)
5088 "Remove fontification and activation overlays from links."
5089 (font-lock-default-unfontify-region beg end)
5090 (let* ((buffer-undo-list t)
5091 (inhibit-read-only t) (inhibit-point-motion-hooks t)
5092 (inhibit-modification-hooks t)
5093 deactivate-mark buffer-file-name buffer-file-truename)
5094 (remove-text-properties
5095 beg end
5096 (if org-indent-mode
5097 ;; also remove line-prefix and wrap-prefix properties
5098 '(mouse-face t keymap t org-linked-text t
5099 invisible t intangible t
5100 line-prefix t wrap-prefix t
5101 org-no-flyspell t)
5102 '(mouse-face t keymap t org-linked-text t
5103 invisible t intangible t
5104 org-no-flyspell t)))))
5106 ;;;; Visibility cycling, including org-goto and indirect buffer
5108 ;;; Cycling
5110 (defvar org-cycle-global-status nil)
5111 (make-variable-buffer-local 'org-cycle-global-status)
5112 (defvar org-cycle-subtree-status nil)
5113 (make-variable-buffer-local 'org-cycle-subtree-status)
5115 ;;;###autoload
5117 (defvar org-inlinetask-min-level)
5119 (defun org-cycle (&optional arg)
5120 "TAB-action and visibility cycling for Org-mode.
5122 This is the command invoked in Org-mode by the TAB key. Its main purpose
5123 is outline visibility cycling, but it also invokes other actions
5124 in special contexts.
5126 - When this function is called with a prefix argument, rotate the entire
5127 buffer through 3 states (global cycling)
5128 1. OVERVIEW: Show only top-level headlines.
5129 2. CONTENTS: Show all headlines of all levels, but no body text.
5130 3. SHOW ALL: Show everything.
5131 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5132 determined by the variable `org-startup-folded', and by any VISIBILITY
5133 properties in the buffer.
5134 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5135 including any drawers.
5137 - When inside a table, re-align the table and move to the next field.
5139 - When point is at the beginning of a headline, rotate the subtree started
5140 by this line through 3 different states (local cycling)
5141 1. FOLDED: Only the main headline is shown.
5142 2. CHILDREN: The main headline and the direct children are shown.
5143 From this state, you can move to one of the children
5144 and zoom in further.
5145 3. SUBTREE: Show the entire subtree, including body text.
5146 If there is no subtree, switch directly from CHILDREN to FOLDED.
5148 - When there is a numeric prefix, go up to a heading with level ARG, do
5149 a `show-subtree' and return to the previous cursor position. If ARG
5150 is negative, go up that many levels.
5152 - When point is not at the beginning of a headline, execute the global
5153 binding for TAB, which is re-indenting the line. See the option
5154 `org-cycle-emulate-tab' for details.
5156 - Special case: if point is at the beginning of the buffer and there is
5157 no headline in line 1, this function will act as if called with prefix arg.
5158 But only if also the variable `org-cycle-global-at-bob' is t."
5159 (interactive "P")
5160 (org-load-modules-maybe)
5161 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
5162 (and org-cycle-level-after-item/entry-creation
5163 (or (org-cycle-level)
5164 (org-cycle-item-indentation))))
5165 (let* ((limit-level
5166 (or org-cycle-max-level
5167 (and (boundp 'org-inlinetask-min-level)
5168 org-inlinetask-min-level
5169 (1- org-inlinetask-min-level))))
5170 (nstars (and limit-level
5171 (if org-odd-levels-only
5172 (and limit-level (1- (* limit-level 2)))
5173 limit-level)))
5174 (outline-regexp
5175 (cond
5176 ((not (org-mode-p)) outline-regexp)
5177 ((or (eq org-cycle-include-plain-lists 'integrate)
5178 (and org-cycle-include-plain-lists (org-at-item-p)))
5183 (bob-special (and org-cycle-global-at-bob (bobp)
5184 (not (looking-at outline-regexp))))
5185 (org-cycle-hook
5186 (if bob-special
5187 (delq 'org-optimize-window-after-visibility-change
5188 (copy-sequence org-cycle-hook))
5189 org-cycle-hook))
5190 (pos (point)))
5192 (if (or bob-special (equal arg '(4)))
5193 ;; special case: use global cycling
5194 (setq arg t))
5196 (cond
5198 ((equal arg '(16))
5199 (org-set-startup-visibility)
5200 (message "Startup visibility, plus VISIBILITY properties"))
5202 ((equal arg '(64))
5203 (show-all)
5204 (message "Entire buffer visible, including drawers"))
5206 ((org-at-table-p 'any)
5207 ;; Enter the table or move to the next field in the table
5208 (or (org-table-recognize-table.el)
5209 (progn
5210 (if arg (org-table-edit-field t)
5211 (org-table-justify-field-maybe)
5212 (call-interactively 'org-table-next-field)))))
5214 ((run-hook-with-args-until-success
5215 'org-tab-after-check-for-table-hook))
5217 ((eq arg t) ;; Global cycling
5218 (org-cycle-internal-global))
5220 ((and org-drawers org-drawer-regexp
5221 (save-excursion
5222 (beginning-of-line 1)
5223 (looking-at org-drawer-regexp)))
5224 ;; Toggle block visibility
5225 (org-flag-drawer
5226 (not (get-char-property (match-end 0) 'invisible))))
5228 ((integerp arg)
5229 ;; Show-subtree, ARG levels up from here.
5230 (save-excursion
5231 (org-back-to-heading)
5232 (outline-up-heading (if (< arg 0) (- arg)
5233 (- (funcall outline-level) arg)))
5234 (org-show-subtree)))
5236 ((and (save-excursion (beginning-of-line 1) (looking-at outline-regexp))
5237 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
5239 (org-cycle-internal-local))
5241 ;; TAB emulation and template completion
5242 (buffer-read-only (org-back-to-heading))
5244 ((run-hook-with-args-until-success
5245 'org-tab-after-check-for-cycling-hook))
5247 ((org-try-structure-completion))
5249 ((org-try-cdlatex-tab))
5251 ((run-hook-with-args-until-success
5252 'org-tab-before-tab-emulation-hook))
5254 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
5255 (or (not (bolp))
5256 (not (looking-at outline-regexp))))
5259 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
5261 (or (and (eq org-cycle-emulate-tab 'white)
5262 (= (match-end 0) (point-at-eol)))
5263 (and (eq org-cycle-emulate-tab 'whitestart)
5264 (>= (match-end 0) pos))))
5265 t
5266 (eq org-cycle-emulate-tab t))
5269 (t (save-excursion
5270 (org-back-to-heading)
5271 (org-cycle)))))))
5273 (defun org-cycle-internal-global ()
5274 "Do the global cycling action."
5275 (cond
5276 ((and (eq last-command this-command)
5277 (eq org-cycle-global-status 'overview))
5278 ;; We just created the overview - now do table of contents
5279 ;; This can be slow in very large buffers, so indicate action
5280 (run-hook-with-args 'org-pre-cycle-hook 'contents)
5281 (message "CONTENTS...")
5282 (org-content)
5283 (message "CONTENTS...done")
5284 (setq org-cycle-global-status 'contents)
5285 (run-hook-with-args 'org-cycle-hook 'contents))
5287 ((and (eq last-command this-command)
5288 (eq org-cycle-global-status 'contents))
5289 ;; We just showed the table of contents - now show everything
5290 (run-hook-with-args 'org-pre-cycle-hook 'all)
5291 (show-all)
5292 (message "SHOW ALL")
5293 (setq org-cycle-global-status 'all)
5294 (run-hook-with-args 'org-cycle-hook 'all))
5296 (t
5297 ;; Default action: go to overview
5298 (run-hook-with-args 'org-pre-cycle-hook 'overview)
5299 (org-overview)
5300 (message "OVERVIEW")
5301 (setq org-cycle-global-status 'overview)
5302 (run-hook-with-args 'org-cycle-hook 'overview))))
5304 (defun org-cycle-internal-local ()
5305 "Do the local cycling action."
5306 (org-back-to-heading)
5307 (let ((goal-column 0) eoh eol eos level has-children children-skipped)
5308 ;; First, some boundaries
5309 (save-excursion
5310 (org-back-to-heading)
5311 (setq level (funcall outline-level))
5312 (save-excursion
5313 (beginning-of-line 2)
5314 (if (or (featurep 'xemacs) (<= emacs-major-version 21))
5315 ; XEmacs does not have `next-single-char-property-change'
5316 ; I'm not sure about Emacs 21.
5317 (while (and (not (eobp)) ;; this is like `next-line'
5318 (get-char-property (1- (point)) 'invisible))
5319 (beginning-of-line 2))
5320 (while (and (not (eobp)) ;; this is like `next-line'
5321 (get-char-property (1- (point)) 'invisible))
5322 (goto-char (next-single-char-property-change (point) 'invisible))
5323 ;;;??? (or (bolp) (beginning-of-line 2))))
5324 (and (eolp) (beginning-of-line 2))))
5325 (setq eol (point)))
5326 (outline-end-of-heading) (setq eoh (point))
5327 (save-excursion
5328 (outline-next-heading)
5329 (setq has-children (and (org-at-heading-p t)
5330 (> (funcall outline-level) level))))
5331 (org-end-of-subtree t)
5332 (unless (eobp)
5334 (beginning-of-line 1) ; in case this is an item
5335 )
5336 (setq eos (if (eobp) (point) (1- (point)))))
5337 ;; Find out what to do next and set `this-command'
5338 (cond
5339 ((= eos eoh)
5340 ;; Nothing is hidden behind this heading
5341 (run-hook-with-args 'org-pre-cycle-hook 'empty)
5342 (message "EMPTY ENTRY")
5343 (setq org-cycle-subtree-status nil)
5344 (save-excursion
5345 (goto-char eos)
5346 (outline-next-heading)
5347 (if (org-invisible-p) (org-flag-heading nil))))
5348 ((and (or (>= eol eos)
5350 (or has-children
5351 (not (setq children-skipped
5352 org-cycle-skip-children-state-if-no-children))))
5353 ;; Entire subtree is hidden in one line: children view
5354 (run-hook-with-args 'org-pre-cycle-hook 'children)
5355 (org-show-entry)
5356 (show-children)
5357 (message "CHILDREN")
5358 (save-excursion
5359 (goto-char eos)
5360 (outline-next-heading)
5361 (if (org-invisible-p) (org-flag-heading nil)))
5362 (setq org-cycle-subtree-status 'children)
5363 (run-hook-with-args 'org-cycle-hook 'children))
5364 ((or children-skipped
5365 (and (eq last-command this-command)
5366 (eq org-cycle-subtree-status 'children)))
5367 ;; We just showed the children, or no children are there,
5368 ;; now show everything.
5369 (run-hook-with-args 'org-pre-cycle-hook 'subtree)
5370 (org-show-subtree)
5371 (message (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
5372 (setq org-cycle-subtree-status 'subtree)
5373 (run-hook-with-args 'org-cycle-hook 'subtree))
5374 (t
5375 ;; Default action: hide the subtree.
5376 (run-hook-with-args 'org-pre-cycle-hook 'folded)
5377 (hide-subtree)
5378 (message "FOLDED")
5379 (setq org-cycle-subtree-status 'folded)
5380 (run-hook-with-args 'org-cycle-hook 'folded)))))
5382 ;;;###autoload
5383 (defun org-global-cycle (&optional arg)
5384 "Cycle the global visibility. For details see `org-cycle'.
5385 With C-u prefix arg, switch to startup visibility.
5386 With a numeric prefix, show all headlines up to that level."
5387 (interactive "P")
5388 (let ((org-cycle-include-plain-lists
5389 (if (org-mode-p) org-cycle-include-plain-lists nil)))
5390 (cond
5391 ((integerp arg)
5392 (show-all)
5393 (hide-sublevels arg)
5394 (setq org-cycle-global-status 'contents))
5395 ((equal arg '(4))
5396 (org-set-startup-visibility)
5397 (message "Startup visibility, plus VISIBILITY properties."))
5398 (t
5399 (org-cycle '(4))))))
5401 (defun org-set-startup-visibility ()
5402 "Set the visibility required by startup options and properties."
5403 (cond
5404 ((eq org-startup-folded t)
5405 (org-cycle '(4)))
5406 ((eq org-startup-folded 'content)
5407 (let ((this-command 'org-cycle) (last-command 'org-cycle))
5408 (org-cycle '(4)) (org-cycle '(4)))))
5409 (unless (eq org-startup-folded 'showeverything)
5410 (if org-hide-block-startup (org-hide-block-all))
5411 (org-set-visibility-according-to-property 'no-cleanup)
5412 (org-cycle-hide-archived-subtrees 'all)
5413 (org-cycle-hide-drawers 'all)
5414 (org-cycle-show-empty-lines 'all)))
5416 (defun org-set-visibility-according-to-property (&optional no-cleanup)
5417 "Switch subtree visibilities according to :VISIBILITY: property."
5418 (interactive)
5419 (let (org-show-entry-below state)
5420 (save-excursion
5421 (goto-char (point-min))
5422 (while (re-search-forward
5424 nil t)
5425 (setq state (match-string 1))
5426 (save-excursion
5427 (org-back-to-heading t)
5428 (hide-subtree)
5429 (org-reveal)
5430 (cond
5431 ((equal state '("fold" "folded"))
5432 (hide-subtree))
5433 ((equal state "children")
5434 (org-show-hidden-entry)
5435 (show-children))
5436 ((equal state "content")
5437 (save-excursion
5438 (save-restriction
5439 (org-narrow-to-subtree)
5440 (org-content))))
5441 ((member state '("all" "showall"))
5442 (show-subtree)))))
5443 (unless no-cleanup
5444 (org-cycle-hide-archived-subtrees 'all)
5445 (org-cycle-hide-drawers 'all)
5446 (org-cycle-show-empty-lines 'all)))))
5448 (defun org-overview ()
5449 "Switch to overview mode, showing only top-level headlines.
5450 Really, this shows all headlines with level equal or greater than the level
5451 of the first headline in the buffer. This is important, because if the
5452 first headline is not level one, then (hide-sublevels 1) gives confusing
5453 results."
5454 (interactive)
5455 (let ((level (save-excursion
5456 (goto-char (point-min))
5457 (if (re-search-forward (concat "^" outline-regexp) nil t)
5458 (progn
5459 (goto-char (match-beginning 0))
5460 (funcall outline-level))))))
5461 (and level (hide-sublevels level))))
5463 (defun org-content (&optional arg)
5464 "Show all headlines in the buffer, like a table of contents.
5465 With numerical argument N, show content up to level N."
5466 (interactive "P")
5467 (save-excursion
5468 ;; Visit all headings and show their offspring
5469 (and (integerp arg) (org-overview))
5470 (goto-char (point-max))
5471 (catch 'exit
5472 (while (and (progn (condition-case nil
5473 (outline-previous-visible-heading 1)
5474 (error (goto-char (point-min))))
5475 t)
5476 (looking-at outline-regexp))
5477 (if (integerp arg)
5478 (show-children (1- arg))
5479 (show-branches))
5480 (if (bobp) (throw 'exit nil))))))
5483 (defun org-optimize-window-after-visibility-change (state)
5484 "Adjust the window after a change in outline visibility.
5485 This function is the default value of the hook `org-cycle-hook'."
5486 (when (get-buffer-window (current-buffer))
5487 (cond
5488 ((eq state 'content) nil)
5489 ((eq state 'all) nil)
5490 ((eq state 'folded) nil)
5491 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
5492 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
5494 (defun org-remove-empty-overlays-at (pos)
5495 "Remove outline overlays that do not contain non-white stuff."
5496 (mapc
5497 (lambda (o)
5498 (and (eq 'outline (org-overlay-get o 'invisible))
5500 (org-overlay-end o))))
5501 (org-delete-overlay o)))
5502 (org-overlays-at pos)))
5504 (defun org-clean-visibility-after-subtree-move ()
5505 "Fix visibility issues after moving a subtree."
5506 ;; First, find a reasonable region to look at:
5507 ;; Start two siblings above, end three below
5508 (let* ((beg (save-excursion
5509 (and (org-get-last-sibling)
5510 (org-get-last-sibling))
5511 (point)))
5512 (end (save-excursion
5513 (and (org-get-next-sibling)
5514 (org-get-next-sibling)
5515 (org-get-next-sibling))
5516 (if (org-at-heading-p)
5517 (point-at-eol)
5518 (point))))
5520 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
5521 (save-excursion
5522 (save-restriction
5523 (narrow-to-region beg end)
5524 (when re
5525 ;; Properly fold already folded siblings
5526 (goto-char (point-min))
5527 (while (re-search-forward re nil t)
5528 (if (and (not (org-invisible-p))
5529 (save-excursion
5530 (goto-char (point-at-eol)) (org-invisible-p)))
5531 (hide-entry))))
5532 (org-cycle-show-empty-lines 'overview)
5533 (org-cycle-hide-drawers 'overview)))))
5535 (defun org-cycle-show-empty-lines (state)
5536 "Show empty lines above all visible headlines.
5537 The region to be covered depends on STATE when called through
5538 `org-cycle-hook'. Lisp program can use t for STATE to get the
5539 entire buffer covered. Note that an empty line is only shown if there
5540 are at least `org-cycle-separator-lines' empty lines before the headline."
5541 (when (not (= org-cycle-separator-lines 0))
5542 (save-excursion
5543 (let* ((n (abs org-cycle-separator-lines))
5544 (re (cond
5547 (t (let ((ns (number-to-string (- n 2))))
5550 beg end b e)
5551 (cond
5552 ((memq state '(overview contents t))
5553 (setq beg (point-min) end (point-max)))
5554 ((memq state '(children folded))
5555 (setq beg (point) end (progn (org-end-of-subtree t t)
5556 (beginning-of-line 2)
5557 (point)))))
5558 (when beg
5559 (goto-char beg)
5560 (while (re-search-forward re end t)
5561 (unless (get-char-property (match-end 1) 'invisible)
5562 (setq e (match-end 1))
5563 (if (< org-cycle-separator-lines 0)
5564 (setq b (save-excursion
5565 (goto-char (match-beginning 0))
5566 (org-back-over-empty-lines)
5567 (if (save-excursion
5568 (goto-char (max (point-min) (1- (point))))
5569 (org-on-heading-p))
5570 (1- (point))
5571 (point))))
5572 (setq b (match-beginning 1)))
5573 (outline-flag-region b e nil)))))))
5574 ;; Never hide empty lines at the end of the file.
5575 (save-excursion
5576 (goto-char (point-max))
5577 (outline-previous-heading)
5578 (outline-end-of-heading)
5580 (= (match-end 0) (point-max)))
5581 (outline-flag-region (point) (match-end 0) nil))))
5583 (defun org-show-empty-lines-in-parent ()
5584 "Move to the parent and re-show empty lines before visible headlines."
5585 (save-excursion
5586 (let ((context (if (org-up-heading-safe) 'children 'overview)))
5587 (org-cycle-show-empty-lines context))))
5589 (defun org-files-list ()
5590 "Return `org-agenda-files' list, plus all open org-mode files.
5591 This is useful for operations that need to scan all of a user's
5592 open and agenda-wise Org files."
5593 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
5594 (dolist (buf (buffer-list))
5595 (with-current-buffer buf
5596 (if (and (eq major-mode 'org-mode) (buffer-file-name))
5597 (let ((file (expand-file-name (buffer-file-name))))
5598 (unless (member file files)
5599 (push file files))))))
5600 files))
5602 (defsubst org-entry-beginning-position ()
5603 "Return the beginning position of the current entry."
5604 (save-excursion (outline-back-to-heading t) (point)))
5606 (defsubst org-entry-end-position ()
5607 "Return the end position of the current entry."
5608 (save-excursion (outline-next-heading) (point)))
5610 (defun org-cycle-hide-drawers (state)
5611 "Re-hide all drawers after a visibility state change."
5612 (when (and (org-mode-p)
5613 (not (memq state '(overview folded contents))))
5614 (save-excursion
5615 (let* ((globalp (memq state '(contents all)))
5616 (beg (if globalp (point-min) (point)))
5617 (end (if globalp (point-max)
5618 (if (eq state 'children)
5619 (save-excursion (outline-next-heading) (point))
5620 (org-end-of-subtree t)))))
5621 (goto-char beg)
5622 (while (re-search-forward org-drawer-regexp end t)
5623 (org-flag-drawer t))))))
5625 (defun org-flag-drawer (flag)
5626 (save-excursion
5627 (beginning-of-line 1)
5629 (let ((b (match-end 0))
5630 (outline-regexp org-outline-regexp))
5631 (if (re-search-forward
5633 (save-excursion (outline-next-heading) (point)) t)
5634 (outline-flag-region b (point-at-eol) flag)
5635 (error ":END: line missing at position %s" b))))))
5637 (defun org-subtree-end-visible-p ()
5638 "Is the end of the current subtree visible?"
5639 (pos-visible-in-window-p
5640 (save-excursion (org-end-of-subtree t) (point))))
5642 (defun org-first-headline-recenter (&optional N)
5643 "Move cursor to the first headline and recenter the headline.
5644 Optional argument N means, put the headline into the Nth line of the window."
5645 (goto-char (point-min))
5647 (beginning-of-line)
5648 (recenter (prefix-numeric-value N))))
5650 ;;; Saving and restoring visibility
5652 (defun org-outline-overlay-data (&optional use-markers)
5653 "Return a list of the locations of all outline overlays.
5654 The are overlays with the `invisible' property value `outline'.
5655 The return valus is a list of cons cells, with start and stop
5656 positions for each overlay.
5657 If USE-MARKERS is set, return the positions as markers."
5658 (let (beg end)
5659 (save-excursion
5660 (save-restriction
5661 (widen)
5662 (delq nil
5663 (mapcar (lambda (o)
5664 (when (eq (org-overlay-get o 'invisible) 'outline)
5665 (setq beg (org-overlay-start o)
5666 end (org-overlay-end o))
5667 (and beg end (> end beg)
5668 (if use-markers
5669 (cons (move-marker (make-marker) beg)
5670 (move-marker (make-marker) end))
5671 (cons beg end)))))
5672 (org-overlays-in (point-min) (point-max))))))))
5674 (defun org-set-outline-overlay-data (data)
5675 "Create visibility overlays for all positions in DATA.
5676 DATA should have been made by `org-outline-overlay-data'."
5677 (let (o)
5678 (save-excursion
5679 (save-restriction
5680 (widen)
5681 (show-all)
5682 (mapc (lambda (c)
5683 (setq o (org-make-overlay (car c) (cdr c)))
5684 (org-overlay-put o 'invisible 'outline))
5685 data)))))
5687 (defmacro org-save-outline-visibility (use-markers &rest body)
5688 "Save and restore outline visibility around BODY.
5689 If USE-MARKERS is non-nil, use markers for the positions.
5690 This means that the buffer may change while running BODY,
5691 but it also means that the buffer should stay alive
5692 during the operation, because otherwise all these markers will
5693 point nowhere."
5694 `(let ((data (org-outline-overlay-data ,use-markers)))
5695 (unwind-protect
5696 (progn
5697 ,@body
5698 (org-set-outline-overlay-data data))
5699 (when ,use-markers
5700 (mapc (lambda (c)
5701 (and (markerp (car c)) (move-marker (car c) nil))
5702 (and (markerp (cdr c)) (move-marker (cdr c) nil)))
5703 data)))))
5706 ;;; Folding of blocks
5708 (defconst org-block-regexp
5711 "Regular expression for hiding blocks.")
5713 (defvar org-hide-block-overlays nil
5714 "Overlays hiding blocks.")
5715 (make-variable-buffer-local 'org-hide-block-overlays)
5717 (defun org-block-map (function &optional start end)
5718 "Call func at the head of all source blocks in the current
5719 buffer. Optional arguments START and END can be used to limit
5720 the range."
5721 (let ((start (or start (point-min)))
5722 (end (or end (point-max))))
5723 (save-excursion
5724 (goto-char start)
5725 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
5726 (save-excursion
5727 (save-match-data
5728 (goto-char (match-beginning 0))
5729 (funcall function)))))))
5731 (defun org-hide-block-toggle-all ()
5732 "Toggle the visibility of all blocks in the current buffer."
5733 (org-block-map #'org-hide-block-toggle))
5735 (defun org-hide-block-all ()
5736 "Fold all blocks in the current buffer."
5737 (interactive)
5738 (org-show-block-all)
5739 (org-block-map #'org-hide-block-toggle-maybe))
5741 (defun org-show-block-all ()
5742 "Unfold all blocks in the current buffer."
5743 (mapc 'org-delete-overlay org-hide-block-overlays)
5744 (setq org-hide-block-overlays nil))
5746 (defun org-hide-block-toggle-maybe ()
5747 "Toggle visibility of block at point."
5748 (interactive)
5749 (let ((case-fold-search t))
5750 (if (save-excursion
5751 (beginning-of-line 1)
5752 (looking-at org-block-regexp))
5753 (progn (org-hide-block-toggle)
5754 t) ;; to signal that we took action
5755 nil))) ;; to signal that we did not
5757 (defun org-hide-block-toggle (&optional force)
5758 "Toggle the visibility of the current block."
5759 (interactive)
5760 (save-excursion
5761 (beginning-of-line)
5762 (if (re-search-forward org-block-regexp nil t)
5763 (let ((start (- (match-beginning 4) 1)) ;; beginning of body
5764 (end (match-end 0)) ;; end of entire body
5765 ov)
5766 (if (memq t (mapcar (lambda (overlay)
5767 (eq (org-overlay-get overlay 'invisible)
5768 'org-hide-block))
5769 (org-overlays-at start)))
5770 (if (or (not force) (eq force 'off))
5771 (mapc (lambda (ov)
5772 (when (member ov org-hide-block-overlays)
5773 (setq org-hide-block-overlays
5774 (delq ov org-hide-block-overlays)))
5775 (when (eq (org-overlay-get ov 'invisible)
5776 'org-hide-block)
5777 (org-delete-overlay ov)))
5778 (org-overlays-at start)))
5779 (setq ov (org-make-overlay start end))
5780 (org-overlay-put ov 'invisible 'org-hide-block)
5781 ;; make the block accessible to isearch
5782 (org-overlay-put
5783 ov 'isearch-open-invisible
5784 (lambda (ov)
5785 (when (member ov org-hide-block-overlays)
5786 (setq org-hide-block-overlays
5787 (delq ov org-hide-block-overlays)))
5788 (when (eq (org-overlay-get ov 'invisible)
5789 'org-hide-block)
5790 (org-delete-overlay ov))))
5791 (push ov org-hide-block-overlays)))
5792 (error "Not looking at a source block"))))
5794 ;; org-tab-after-check-for-cycling-hook
5795 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
5796 ;; Remove overlays when changing major mode
5797 (add-hook 'org-mode-hook
5798 (lambda () (org-add-hook 'change-major-mode-hook
5799 'org-show-block-all 'append 'local)))
5801 ;;; Org-goto
5803 (defvar org-goto-window-configuration nil)
5804 (defvar org-goto-marker nil)
5805 (defvar org-goto-map
5806 (let ((map (make-sparse-keymap)))
5807 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
5808 (while (setq cmd (pop cmds))
5809 (substitute-key-definition cmd cmd map global-map)))
5810 (suppress-keymap map)
5811 (org-defkey map "\C-m" 'org-goto-ret)
5812 (org-defkey map [(return)] 'org-goto-ret)
5813 (org-defkey map [(left)] 'org-goto-left)
5814 (org-defkey map [(right)] 'org-goto-right)
5815 (org-defkey map [(control ?g)] 'org-goto-quit)
5816 (org-defkey map "\C-i" 'org-cycle)
5817 (org-defkey map [(tab)] 'org-cycle)
5818 (org-defkey map [(down)] 'outline-next-visible-heading)
5819 (org-defkey map [(up)] 'outline-previous-visible-heading)
5820 (if org-goto-auto-isearch
5821 (if (fboundp 'define-key-after)
5822 (define-key-after map [t] 'org-goto-local-auto-isearch)
5823 nil)
5824 (org-defkey map "q" 'org-goto-quit)
5825 (org-defkey map "n" 'outline-next-visible-heading)
5826 (org-defkey map "p" 'outline-previous-visible-heading)
5827 (org-defkey map "f" 'outline-forward-same-level)
5828 (org-defkey map "b" 'outline-backward-same-level)
5829 (org-defkey map "u" 'outline-up-heading))
5830 (org-defkey map "/" 'org-occur)
5831 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
5832 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
5833 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
5834 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
5835 (org-defkey map "\C-c\C-u" 'outline-up-heading)
5836 map))
5838 (defconst org-goto-help
5839 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
5840 RET=jump to location [Q]uit and return to previous location
5841 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
5843 (defvar org-goto-start-pos) ; dynamically scoped parameter
5845 ;; FIXME: Docstring does not mention both interfaces
5846 (defun org-goto (&optional alternative-interface)
5847 "Look up a different location in the current file, keeping current visibility.
5849 When you want look-up or go to a different location in a document, the
5850 fastest way is often to fold the entire buffer and then dive into the tree.
5851 This method has the disadvantage, that the previous location will be folded,
5852 which may not be what you want.
5854 This command works around this by showing a copy of the current buffer
5855 in an indirect buffer, in overview mode. You can dive into the tree in
5856 that copy, use org-occur and incremental search to find a location.
5857 When pressing RET or `Q', the command returns to the original buffer in
5858 which the visibility is still unchanged. After RET is will also jump to
5859 the location selected in the indirect buffer and expose the
5860 the headline hierarchy above."
5861 (interactive "P")
5862 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
5863 (org-refile-use-outline-path t)
5864 (org-refile-target-verify-function nil)
5865 (interface
5866 (if (not alternative-interface)
5867 org-goto-interface
5868 (if (eq org-goto-interface 'outline)
5869 'outline-path-completion
5870 'outline)))
5871 (org-goto-start-pos (point))
5872 (selected-point
5873 (if (eq interface 'outline)
5874 (car (org-get-location (current-buffer) org-goto-help))
5875 (nth 3 (org-refile-get-location "Goto: ")))))
5876 (if selected-point
5877 (progn
5878 (org-mark-ring-push org-goto-start-pos)
5879 (goto-char selected-point)
5880 (if (or (org-invisible-p) (org-invisible-p2))
5881 (org-show-context 'org-goto)))
5882 (message "Quit"))))
5884 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
5885 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
5886 (defvar org-goto-local-auto-isearch-map) ; defined below
5888 (defun org-get-location (buf help)
5889 "Let the user select a location in the Org-mode buffer BUF.
5890 This function uses a recursive edit. It returns the selected position
5891 or nil."
5892 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
5893 (isearch-hide-immediately nil)
5894 (isearch-search-fun-function
5895 (lambda () 'org-goto-local-search-headings))
5896 (org-goto-selected-point org-goto-exit-command))
5897 (save-excursion
5898 (save-window-excursion
5899 (delete-other-windows)
5900 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
5901 (switch-to-buffer
5902 (condition-case nil
5903 (make-indirect-buffer (current-buffer) "*org-goto*")
5904 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
5905 (with-output-to-temp-buffer "*Help*"
5906 (princ help))
5907 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
5908 (setq buffer-read-only nil)
5909 (let ((org-startup-truncated t)
5910 (org-startup-folded nil)
5911 (org-startup-align-all-tables nil))
5912 (org-mode)
5913 (org-overview))
5914 (setq buffer-read-only t)
5915 (if (and (boundp 'org-goto-start-pos)
5916 (integer-or-marker-p org-goto-start-pos))
5917 (let ((org-show-hierarchy-above t)
5918 (org-show-siblings t)
5919 (org-show-following-heading t))
5920 (goto-char org-goto-start-pos)
5921 (and (org-invisible-p) (org-show-context)))
5922 (goto-char (point-min)))
5923 (let (org-special-ctrl-a/e) (org-beginning-of-line))
5924 (message "Select location and press RET")
5925 (use-local-map org-goto-map)
5926 (recursive-edit)
5927 ))
5928 (kill-buffer "*org-goto*")
5929 (cons org-goto-selected-point org-goto-exit-command)))
5931 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
5932 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
5933 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
5934 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
5936 (defun org-goto-local-search-headings (string bound noerror)
5937 "Search and make sure that any matches are in headlines."
5938 (catch 'return
5939 (while (if isearch-forward
5940 (search-forward string bound noerror)
5941 (search-backward string bound noerror))
5942 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
5943 (and (member :headline context)
5944 (not (member :tags context))))
5945 (throw 'return (point))))))
5947 (defun org-goto-local-auto-isearch ()
5948 "Start isearch."
5949 (interactive)
5950 (goto-char (point-min))
5951 (let ((keys (this-command-keys)))
5952 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
5953 (isearch-mode t)
5954 (isearch-process-search-char (string-to-char keys)))))
5956 (defun org-goto-ret (&optional arg)
5957 "Finish `org-goto' by going to the new location."
5958 (interactive "P")
5959 (setq org-goto-selected-point (point)
5960 org-goto-exit-command 'return)
5961 (throw 'exit nil))
5963 (defun org-goto-left ()
5964 "Finish `org-goto' by going to the new location."
5965 (interactive)
5966 (if (org-on-heading-p)
5967 (progn
5968 (beginning-of-line 1)
5969 (setq org-goto-selected-point (point)
5970 org-goto-exit-command 'left)
5971 (throw 'exit nil))
5972 (error "Not on a heading")))
5974 (defun org-goto-right ()
5975 "Finish `org-goto' by going to the new location."
5976 (interactive)
5977 (if (org-on-heading-p)
5978 (progn
5979 (setq org-goto-selected-point (point)
5980 org-goto-exit-command 'right)
5981 (throw 'exit nil))
5982 (error "Not on a heading")))
5984 (defun org-goto-quit ()
5985 "Finish `org-goto' without cursor motion."
5986 (interactive)
5987 (setq org-goto-selected-point nil)
5988 (setq org-goto-exit-command 'quit)
5989 (throw 'exit nil))
5991 ;;; Indirect buffer display of subtrees
5993 (defvar org-indirect-dedicated-frame nil
5994 "This is the frame being used for indirect tree display.")
5995 (defvar org-last-indirect-buffer nil)
5997 (defun org-tree-to-indirect-buffer (&optional arg)
5998 "Create indirect buffer and narrow it to current subtree.
5999 With numerical prefix ARG, go up to this level and then take that tree.
6000 If ARG is negative, go up that many levels.
6001 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6002 indirect buffer previously made with this command, to avoid proliferation of
6003 indirect buffers. However, when you call the command with a `C-u' prefix, or
6004 when `org-indirect-buffer-display' is `new-frame', the last buffer
6005 is kept so that you can work with several indirect buffers at the same time.
6006 If `org-indirect-buffer-display' is `dedicated-frame', the C-u prefix also
6007 requests that a new frame be made for the new buffer, so that the dedicated
6008 frame is not changed."
6009 (interactive "P")
6010 (let ((cbuf (current-buffer))
6011 (cwin (selected-window))
6012 (pos (point))
6013 beg end level heading ibuf)
6014 (save-excursion
6015 (org-back-to-heading t)
6016 (when (numberp arg)
6017 (setq level (org-outline-level))
6018 (if (< arg 0) (setq arg (+ level arg)))
6019 (while (> (setq level (org-outline-level)) arg)
6020 (outline-up-heading 1 t)))
6021 (setq beg (point)
6022 heading (org-get-heading))
6023 (org-end-of-subtree t t) (setq end (point)))
6024 (if (and (buffer-live-p org-last-indirect-buffer)
6025 (not (eq org-indirect-buffer-display 'new-frame))
6026 (not arg))
6027 (kill-buffer org-last-indirect-buffer))
6028 (setq ibuf (org-get-indirect-buffer cbuf)
6029 org-last-indirect-buffer ibuf)
6030 (cond
6031 ((or (eq org-indirect-buffer-display 'new-frame)
6032 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6033 (select-frame (make-frame))
6034 (delete-other-windows)
6035 (switch-to-buffer ibuf)
6036 (org-set-frame-title heading))
6037 ((eq org-indirect-buffer-display 'dedicated-frame)
6038 (raise-frame
6039 (select-frame (or (and org-indirect-dedicated-frame
6040 (frame-live-p org-indirect-dedicated-frame)
6041 org-indirect-dedicated-frame)
6042 (setq org-indirect-dedicated-frame (make-frame)))))
6043 (delete-other-windows)
6044 (switch-to-buffer ibuf)
6045 (org-set-frame-title (concat "Indirect: " heading)))
6046 ((eq org-indirect-buffer-display 'current-window)
6047 (switch-to-buffer ibuf))
6048 ((eq org-indirect-buffer-display 'other-window)
6049 (pop-to-buffer ibuf))
6050 (t (error "Invalid value")))
6051 (if (featurep 'xemacs)
6052 (save-excursion (org-mode) (turn-on-font-lock)))
6053 (narrow-to-region beg end)
6054 (show-all)
6055 (goto-char pos)
6056 (and (window-live-p cwin) (select-window cwin))))
6058 (defun org-get-indirect-buffer (&optional buffer)
6059 (setq buffer (or buffer (current-buffer)))
6060 (let ((n 1) (base (buffer-name buffer)) bname)
6061 (while (buffer-live-p
6062 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6063 (setq n (1+ n)))
6064 (condition-case nil
6065 (make-indirect-buffer buffer bname 'clone)
6066 (error (make-indirect-buffer buffer bname)))))
6068 (defun org-set-frame-title (title)
6069 "Set the title of the current frame to the string TITLE."
6070 ;; FIXME: how to name a single frame in XEmacs???
6071 (unless (featurep 'xemacs)
6072 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6074 ;;;; Structure editing
6076 ;;; Inserting headlines
6078 (defun org-previous-line-empty-p ()
6079 (save-excursion
6080 (and (not (bobp))
6081 (or (beginning-of-line 0) t)
6082 (save-match-data
6085 (defun org-insert-heading (&optional force-heading)
6086 "Insert a new heading or item with same depth at point.
6087 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6088 If point is at the beginning of a headline, insert a sibling before the
6089 current headline. If point is not at the beginning, do not split the line,
6090 but create the new headline after the current line."
6091 (interactive "P")
6092 (if (or (= (buffer-size) 0)
6093 (and (not (save-excursion (and (ignore-errors (org-back-to-heading))
6094 (org-on-heading-p))))
6095 (not (org-in-item-p))))
6097 (when (or force-heading (not (org-insert-item)))
6098 (let* ((empty-line-p nil)
6099 (head (save-excursion
6100 (condition-case nil
6101 (progn
6102 (org-back-to-heading)
6103 (setq empty-line-p (org-previous-line-empty-p))
6104 (match-string 0))
6105 (error "*"))))
6106 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6107 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6108 pos hide-previous previous-pos)
6109 (cond
6110 ((and (org-on-heading-p) (bolp)
6111 (or (bobp)
6112 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6113 ;; insert before the current line
6114 (open-line (if blank 2 1)))
6115 ((and (bolp)
6116 (not org-insert-heading-respect-content)
6117 (or (bobp)
6118 (save-excursion
6119 (backward-char 1) (not (org-invisible-p)))))
6120 ;; insert right here
6121 nil)
6122 (t
6123 ;; somewhere in the line
6124 (save-excursion
6125 (setq previous-pos (point-at-bol))
6126 (end-of-line)
6127 (setq hide-previous (org-invisible-p)))
6128 (and org-insert-heading-respect-content (org-show-subtree))
6129 (let ((split
6130 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6131 (save-excursion
6132 (let ((p (point)))
6133 (goto-char (point-at-bol))
6134 (and (looking-at org-complex-heading-regexp)
6135 (> p (match-beginning 4)))))))
6136 tags pos)
6137 (cond
6138 (org-insert-heading-respect-content
6139 (org-end-of-subtree nil t)
6140 (or (bolp) (newline))
6141 (or (org-previous-line-empty-p)
6142 (and blank (newline)))
6143 (open-line 1))
6144 ((org-on-heading-p)
6145 (when hide-previous
6146 (show-children)
6147 (org-show-entry))
6149 (setq tags (and (match-end 2) (match-string 2)))
6150 (and (match-end 1)
6151 (delete-region (match-beginning 1) (match-end 1)))
6152 (setq pos (point-at-bol))
6153 (or split (end-of-line 1))
6154 (delete-horizontal-space)
6155 (newline (if blank 2 1))
6156 (when tags
6157 (save-excursion
6158 (goto-char pos)
6159 (end-of-line 1)
6160 (insert " " tags)
6161 (org-set-tags nil 'align))))
6162 (t
6163 (or split (end-of-line 1))
6164 (newline (if blank 2 1)))))))
6165 (insert head) (just-one-space)
6166 (setq pos (point))
6167 (end-of-line 1)
6168 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6169 (when (and org-insert-heading-respect-content hide-previous)
6170 (save-excursion
6171 (goto-char previous-pos)
6172 (hide-subtree)))
6173 (run-hooks 'org-insert-heading-hook)))))
6175 (defun org-get-heading (&optional no-tags)
6176 "Return the heading of the current entry, without the stars."
6177 (save-excursion
6178 (org-back-to-heading t)
6179 (if (looking-at
6180 (if no-tags
6183 (match-string 1) "")))
6185 (defun org-heading-components ()
6186 "Return the components of the current heading.
6187 This is a list with the following elements:
6188 - the level as an integer
6189 - the reduced level, different if `org-odd-levels-only' is set.
6190 - the TODO keyword, or nil
6191 - the priority character, like ?A, or nil if no priority is given
6192 - the headline text itself, or the tags string if no headline text
6193 - the tags string, or nil."
6194 (save-excursion
6195 (org-back-to-heading t)
6196 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6197 (list (length (match-string 1))
6198 (org-reduced-level (length (match-string 1)))
6199 (org-match-string-no-properties 2)
6200 (and (match-end 3) (aref (match-string 3) 2))
6201 (org-match-string-no-properties 4)
6202 (org-match-string-no-properties 5)))))
6204 (defun org-get-entry ()
6205 "Get the entry text, after heading, entire subtree."
6206 (save-excursion
6207 (org-back-to-heading t)
6208 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6210 (defun org-insert-heading-after-current ()
6211 "Insert a new heading with same level as current, after current subtree."
6212 (interactive)
6213 (org-back-to-heading)
6214 (org-insert-heading)
6215 (org-move-subtree-down)
6216 (end-of-line 1))
6218 (defun org-insert-heading-respect-content ()
6219 (interactive)
6220 (let ((org-insert-heading-respect-content t))
6221 (org-insert-heading t)))
6223 (defun org-insert-todo-heading-respect-content (&optional force-state)
6224 (interactive "P")
6225 (let ((org-insert-heading-respect-content t))
6226 (org-insert-todo-heading force-state t)))
6228 (defun org-insert-todo-heading (arg &optional force-heading)
6229 "Insert a new heading with the same level and TODO state as current heading.
6230 If the heading has no TODO state, or if the state is DONE, use the first
6231 state (TODO by default). Also with prefix arg, force first state."
6232 (interactive "P")
6233 (when (or force-heading (not (org-insert-item 'checkbox)))
6234 (org-insert-heading force-heading)
6235 (save-excursion
6236 (org-back-to-heading)
6237 (outline-previous-heading)
6238 (looking-at org-todo-line-regexp))
6239 (let*
6240 ((new-mark-x
6241 (if (or arg
6242 (not (match-beginning 2))
6243 (member (match-string 2) org-done-keywords))
6244 (car org-todo-keywords-1)
6245 (match-string 2)))
6246 (new-mark
6247 (or
6248 (run-hook-with-args-until-success
6249 'org-todo-get-default-hook new-mark-x nil)
6250 new-mark-x)))
6251 (beginning-of-line 1)
6253 (if org-treat-insert-todo-heading-as-state-change
6254 (org-todo new-mark)
6255 (insert new-mark " "))))
6256 (when org-provide-todo-statistics
6257 (org-update-parent-todo-statistics))))
6259 (defun org-insert-subheading (arg)
6260 "Insert a new subheading and demote it.
6261 Works for outline headings and for plain lists alike."
6262 (interactive "P")
6263 (org-insert-heading arg)
6264 (cond
6265 ((org-on-heading-p) (org-do-demote))
6266 ((org-at-item-p) (org-indent-item 1))))
6268 (defun org-insert-todo-subheading (arg)
6269 "Insert a new subheading with TODO keyword or checkbox and demote it.
6270 Works for outline headings and for plain lists alike."
6271 (interactive "P")
6272 (org-insert-todo-heading arg)
6273 (cond
6274 ((org-on-heading-p) (org-do-demote))
6275 ((org-at-item-p) (org-indent-item 1))))
6277 ;;; Promotion and Demotion
6279 (defvar org-after-demote-entry-hook nil
6280 "Hook run after an entry has been demoted.
6281 The cursor will be at the beginning of the entry.
6282 When a subtree is being demoted, the hook will be called for each node.")
6284 (defvar org-after-promote-entry-hook nil
6285 "Hook run after an entry has been promoted.
6286 The cursor will be at the beginning of the entry.
6287 When a subtree is being promoted, the hook will be called for each node.")
6289 (defun org-promote-subtree ()
6290 "Promote the entire subtree.
6291 See also `org-promote'."
6292 (interactive)
6293 (save-excursion
6294 (org-map-tree 'org-promote))
6295 (org-fix-position-after-promote))
6297 (defun org-demote-subtree ()
6298 "Demote the entire subtree. See `org-demote'.
6299 See also `org-promote'."
6300 (interactive)
6301 (save-excursion
6302 (org-map-tree 'org-demote))
6303 (org-fix-position-after-promote))
6306 (defun org-do-promote ()
6307 "Promote the current heading higher up the tree.
6308 If the region is active in `transient-mark-mode', promote all headings
6309 in the region."
6310 (interactive)
6311 (save-excursion
6312 (if (org-region-active-p)
6313 (org-map-region 'org-promote (region-beginning) (region-end))
6314 (org-promote)))
6315 (org-fix-position-after-promote))
6317 (defun org-do-demote ()
6318 "Demote the current heading lower down the tree.
6319 If the region is active in `transient-mark-mode', demote all headings
6320 in the region."
6321 (interactive)
6322 (save-excursion
6323 (if (org-region-active-p)
6324 (org-map-region 'org-demote (region-beginning) (region-end))
6325 (org-demote)))
6326 (org-fix-position-after-promote))
6328 (defun org-fix-position-after-promote ()
6329 "Make sure that after pro/demotion cursor position is right."
6330 (let ((pos (point)))
6331 (when (save-excursion
6332 (beginning-of-line 1)
6333 (looking-at org-todo-line-regexp)
6334 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6335 (cond ((eobp) (insert " "))
6336 ((eolp) (insert " "))
6337 ((equal (char-after) ?\ ) (forward-char 1))))))
6339 (defun org-current-level ()
6340 "Return the level of the current entry, or nil if before the first headline.
6341 The level is the number of stars at the beginning of the headline."
6342 (save-excursion
6343 (condition-case nil
6344 (progn
6345 (org-back-to-heading t)
6346 (funcall outline-level))
6347 (error nil))))
6349 (defun org-reduced-level (l)
6350 "Compute the effective level of a heading.
6351 This takes into account the setting of `org-odd-levels-only'."
6352 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
6354 (defun org-get-valid-level (level &optional change)
6355 "Rectify a level change under the influence of `org-odd-levels-only'
6356 LEVEL is a current level, CHANGE is by how much the level should be
6357 modified. Even if CHANGE is nil, LEVEL may be returned modified because
6358 even level numbers will become the next higher odd number."
6359 (if org-odd-levels-only
6360 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
6361 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
6362 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
6363 (max 1 (+ level (or change 0)))))
6365 (if (boundp 'define-obsolete-function-alias)
6366 (if (or (featurep 'xemacs) (< emacs-major-version 23))
6367 (define-obsolete-function-alias 'org-get-legal-level
6368 'org-get-valid-level)
6369 (define-obsolete-function-alias 'org-get-legal-level
6370 'org-get-valid-level "23.1")))
6372 (defun org-promote ()
6373 "Promote the current heading higher up the tree.
6374 If the region is active in `transient-mark-mode', promote all headings
6375 in the region."
6376 (org-back-to-heading t)
6377 (let* ((level (save-match-data (funcall outline-level)))
6378 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
6379 (diff (abs (- level (length up-head) -1))))
6380 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
6381 (replace-match up-head nil t)
6382 ;; Fixup tag positioning
6383 (and org-auto-align-tags (org-set-tags nil t))
6384 (if org-adapt-indentation (org-fixup-indentation (- diff)))
6385 (run-hooks 'org-after-promote-entry-hook)))
6387 (defun org-demote ()
6388 "Demote the current heading lower down the tree.
6389 If the region is active in `transient-mark-mode', demote all headings
6390 in the region."
6391 (org-back-to-heading t)
6392 (let* ((level (save-match-data (funcall outline-level)))
6393 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
6394 (diff (abs (- level (length down-head) -1))))
6395 (replace-match down-head nil t)
6396 ;; Fixup tag positioning
6397 (and org-auto-align-tags (org-set-tags nil t))
6398 (if org-adapt-indentation (org-fixup-indentation diff))
6399 (run-hooks 'org-after-demote-entry-hook)))
6401 (defvar org-tab-ind-state nil)
6403 (defun org-cycle-level ()
6404 (let ((org-adapt-indentation nil))
6406 (org-looking-back
6408 (setq this-command 'org-cycle-level)
6409 (if (eq last-command 'org-cycle-level)
6410 (condition-case nil
6411 (progn (org-do-promote)
6412 (if (equal org-tab-ind-state (org-current-level))
6413 (org-do-promote)))
6414 (error
6415 (progn
6416 (save-excursion
6417 (beginning-of-line 1)
6419 (replace-match
6420 (make-string org-tab-ind-state ?*))))
6421 (setq this-command 'org-cycle))))
6422 (setq org-tab-ind-state (- (match-end 1) (match-beginning 1)))
6423 (org-do-demote))
6424 t)))
6426 (defun org-map-tree (fun)
6427 "Call FUN for every heading underneath the current one."
6428 (org-back-to-heading)
6429 (let ((level (funcall outline-level)))
6430 (save-excursion
6431 (funcall fun)
6432 (while (and (progn
6433 (outline-next-heading)
6434 (> (funcall outline-level) level))
6435 (not (eobp)))
6436 (funcall fun)))))
6438 (defun org-map-region (fun beg end)
6439 "Call FUN for every heading between BEG and END."
6440 (let ((org-ignore-region t))
6441 (save-excursion
6442 (setq end (copy-marker end))
6443 (goto-char beg)
6444 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
6445 (< (point) end))
6446 (funcall fun))
6447 (while (and (progn
6448 (outline-next-heading)
6449 (< (point) end))
6450 (not (eobp)))
6451 (funcall fun)))))
6453 (defun org-fixup-indentation (diff)
6454 "Change the indentation in the current entry by DIFF
6455 However, if any line in the current entry has no indentation, or if it
6456 would end up with no indentation after the change, nothing at all is done."
6457 (save-excursion
6458 (let ((end (save-excursion (outline-next-heading)
6459 (point-marker)))
6460 (prohibit (if (> diff 0)
6463 col)
6464 (unless (save-excursion (end-of-line 1)
6465 (re-search-forward prohibit end t))
6466 (while (and (< (point) end)
6468 (goto-char (match-end 0))
6469 (setq col (current-column))
6470 (if (< diff 0) (replace-match ""))
6471 (org-indent-to-column (+ diff col))))
6472 (move-marker end nil))))
6474 (defun org-convert-to-odd-levels ()
6475 "Convert an org-mode file with all levels allowed to one with odd levels.
6476 This will leave level 1 alone, convert level 2 to level 3, level 3 to
6477 level 5 etc."
6478 (interactive)
6479 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
6480 (let ((outline-regexp org-outline-regexp)
6481 (outline-level 'org-outline-level)
6482 (org-odd-levels-only nil) n)
6483 (save-excursion
6484 (goto-char (point-min))
6486 (setq n (- (length (match-string 0)) 2))
6487 (while (>= (setq n (1- n)) 0)
6488 (org-demote))
6489 (end-of-line 1))))))
6491 (defun org-convert-to-oddeven-levels ()
6492 "Convert an org-mode file with only odd levels to one with odd and even levels.
6493 This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a
6494 section with an even level, conversion would destroy the structure of the file. An error
6495 is signaled in this case."
6496 (interactive)
6497 (goto-char (point-min))
6498 ;; First check if there are no even levels
6500 (org-show-context t)
6501 (error "Not all levels are odd in this file. Conversion not possible"))
6502 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
6503 (let ((outline-regexp org-outline-regexp)
6504 (outline-level 'org-outline-level)
6505 (org-odd-levels-only nil) n)
6506 (save-excursion
6507 (goto-char (point-min))
6509 (setq n (/ (1- (length (match-string 0))) 2))
6510 (while (>= (setq n (1- n)) 0)
6511 (org-promote))
6512 (end-of-line 1))))))
6514 (defun org-tr-level (n)
6515 "Make N odd if required."
6516 (if org-odd-levels-only (1+ (/ n 2)) n))
6518 ;;; Vertical tree motion, cutting and pasting of subtrees
6520 (defun org-move-subtree-up (&optional arg)
6521 "Move the current subtree up past ARG headlines of the same level."
6522 (interactive "p")
6523 (org-move-subtree-down (- (prefix-numeric-value arg))))
6525 (defun org-move-subtree-down (&optional arg)
6526 "Move the current subtree down past ARG headlines of the same level."
6527 (interactive "p")
6528 (setq arg (prefix-numeric-value arg))
6529 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
6530 'org-get-last-sibling))
6531 (ins-point (make-marker))
6532 (cnt (abs arg))
6533 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
6534 ;; Select the tree
6535 (org-back-to-heading)
6536 (setq beg0 (point))
6537 (save-excursion
6538 (setq ne-beg (org-back-over-empty-lines))
6539 (setq beg (point)))
6540 (save-match-data
6541 (save-excursion (outline-end-of-heading)
6542 (setq folded (org-invisible-p)))
6543 (outline-end-of-subtree))
6544 (outline-next-heading)
6545 (setq ne-end (org-back-over-empty-lines))
6546 (setq end (point))
6547 (goto-char beg0)
6548 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
6549 ;; include less whitespace
6550 (save-excursion
6551 (goto-char beg)
6552 (forward-line (- ne-beg ne-end))
6553 (setq beg (point))))
6554 ;; Find insertion point, with error handling
6555 (while (> cnt 0)
6556 (or (and (funcall movfunc) (looking-at outline-regexp))
6557 (progn (goto-char beg0)
6558 (error "Cannot move past superior level or buffer limit")))
6559 (setq cnt (1- cnt)))
6560 (if (> arg 0)
6561 ;; Moving forward - still need to move over subtree
6562 (progn (org-end-of-subtree t t)
6563 (save-excursion
6564 (org-back-over-empty-lines)
6565 (or (bolp) (newline)))))
6566 (setq ne-ins (org-back-over-empty-lines))
6567 (move-marker ins-point (point))
6568 (setq txt (buffer-substring beg end))
6569 (org-save-markers-in-region beg end)
6570 (delete-region beg end)
6571 (org-remove-empty-overlays-at beg)
6572 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
6573 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
6575 (let ((bbb (point)))
6576 (insert-before-markers txt)
6577 (org-reinstall-markers-in-region bbb)
6578 (move-marker ins-point bbb))
6580 (setq ins-end (point))
6581 (goto-char ins-point)
6582 (org-skip-whitespace)
6583 (when (and (< arg 0)
6584 (org-first-sibling-p)
6585 (> ne-ins ne-beg))
6586 ;; Move whitespace back to beginning
6587 (save-excursion
6588 (goto-char ins-end)
6589 (let ((kill-whole-line t))
6590 (kill-line (- ne-ins ne-beg)) (point)))
6592 (move-marker ins-point nil)
6593 (if folded
6594 (hide-subtree)
6595 (org-show-entry)
6596 (show-children)
6597 (org-cycle-hide-drawers 'children))
6598 (org-clean-visibility-after-subtree-move)))
6600 (defvar org-subtree-clip ""
6601 "Clipboard for cut and paste of subtrees.
6602 This is actually only a copy of the kill, because we use the normal kill
6603 ring. We need it to check if the kill was created by `org-copy-subtree'.")
6605 (defvar org-subtree-clip-folded nil
6606 "Was the last copied subtree folded?
6607 This is used to fold the tree back after pasting.")
6609 (defun org-cut-subtree (&optional n)
6610 "Cut the current subtree into the clipboard.
6611 With prefix arg N, cut this many sequential subtrees.
6612 This is a short-hand for marking the subtree and then cutting it."
6613 (interactive "p")
6614 (org-copy-subtree n 'cut))
6616 (defun org-copy-subtree (&optional n cut force-store-markers)
6617 "Cut the current subtree into the clipboard.
6618 With prefix arg N, cut this many sequential subtrees.
6619 This is a short-hand for marking the subtree and then copying it.
6620 If CUT is non-nil, actually cut the subtree.
6621 If FORCE-STORE-MARKERS is non-nil, store the relative locations
6622 of some markers in the region, even if CUT is non-nil. This is
6623 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
6624 (interactive "p")
6625 (let (beg end folded (beg0 (point)))
6626 (if (interactive-p)
6627 (org-back-to-heading nil) ; take what looks like a subtree
6628 (org-back-to-heading t)) ; take what is really there
6629 (org-back-over-empty-lines)
6630 (setq beg (point))
6632 (save-match-data
6633 (save-excursion (outline-end-of-heading)
6634 (setq folded (org-invisible-p)))
6635 (condition-case nil
6636 (org-forward-same-level (1- n) t)
6637 (error nil))
6638 (org-end-of-subtree t t))
6639 (org-back-over-empty-lines)
6640 (setq end (point))
6641 (goto-char beg0)
6642 (when (> end beg)
6643 (setq org-subtree-clip-folded folded)
6644 (when (or cut force-store-markers)
6645 (org-save-markers-in-region beg end))
6646 (if cut (kill-region beg end) (copy-region-as-kill beg end))
6647 (setq org-subtree-clip (current-kill 0))
6648 (message "%s: Subtree(s) with %d characters"
6649 (if cut "Cut" "Copied")
6650 (length org-subtree-clip)))))
6652 (defun org-paste-subtree (&optional level tree for-yank)
6653 "Paste the clipboard as a subtree, with modification of headline level.
6654 The entire subtree is promoted or demoted in order to match a new headline
6655 level.
6657 If the cursor is at the beginning of a headline, the same level as
6658 that headline is used to paste the tree
6660 If not, the new level is derived from the *visible* headings
6661 before and after the insertion point, and taken to be the inferior headline
6662 level of the two. So if the previous visible heading is level 3 and the
6663 next is level 4 (or vice versa), level 4 will be used for insertion.
6664 This makes sure that the subtree remains an independent subtree and does
6665 not swallow low level entries.
6667 You can also force a different level, either by using a numeric prefix
6668 argument, or by inserting the heading marker by hand. For example, if the
6671 If optional TREE is given, use this text instead of the kill ring.
6673 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
6674 move back over whitespace before inserting, and move point to the end of
6675 the inserted text when done."
6676 (interactive "P")
6677 (setq tree (or tree (and kill-ring (current-kill 0))))
6678 (unless (org-kill-is-subtree-p tree)
6679 (error "%s"
6680 (substitute-command-keys
6682 (let* ((visp (not (org-invisible-p)))
6683 (txt tree)
6688 (old-level (if (string-match ^re txt)
6689 (- (match-end 0) (match-beginning 0) 1)
6690 -1))
6691 (force-level (cond (level (prefix-numeric-value level))
6693 (string-match
6694 ^re_ (buffer-substring
6695 (point-at-bol) (point))))
6696 (- (match-end 1) (match-beginning 1)))
6697 ((and (bolp)
6698 (looking-at org-outline-regexp))
6699 (- (match-end 0) (point) 1))
6700 (t nil)))
6701 (previous-level (save-excursion
6702 (condition-case nil
6703 (progn
6704 (outline-previous-visible-heading 1)
6705 (if (looking-at re)
6706 (- (match-end 0) (match-beginning 0) 1)
6707 1))
6708 (error 1))))
6709 (next-level (save-excursion
6710 (condition-case nil
6711 (progn
6712 (or (looking-at outline-regexp)
6713 (outline-next-visible-heading 1))
6714 (if (looking-at re)
6715 (- (match-end 0) (match-beginning 0) 1)
6716 1))
6717 (error 1))))
6718 (new-level (or force-level (max previous-level next-level)))
6719 (shift (if (or (= old-level -1)
6720 (= new-level -1)
6721 (= old-level new-level))
6722 0
6723 (- new-level old-level)))
6724 (delta (if (> shift 0) -1 1))
6725 (func (if (> shift 0) 'org-demote 'org-promote))
6726 (org-odd-levels-only nil)
6727 beg end newend)
6728 ;; Remove the forced level indicator
6729 (if force-level
6730 (delete-region (point-at-bol) (point)))
6731 ;; Paste
6732 (beginning-of-line 1)
6733 (unless for-yank (org-back-over-empty-lines))
6734 (setq beg (point))
6735 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
6736 (insert-before-markers txt)
6738 (setq newend (point))
6739 (org-reinstall-markers-in-region beg)
6740 (setq end (point))
6741 (goto-char beg)
6743 (setq beg (point))
6744 (if (and (org-invisible-p) visp)
6745 (save-excursion (outline-show-heading)))
6746 ;; Shift if necessary
6747 (unless (= shift 0)
6748 (save-restriction
6749 (narrow-to-region beg end)
6750 (while (not (= shift 0))
6751 (org-map-region func (point-min) (point-max))
6752 (setq shift (+ delta shift)))
6753 (goto-char (point-min))
6754 (setq newend (point-max))))
6755 (when (or (interactive-p) for-yank)
6756 (message "Clipboard pasted as level %d subtree" new-level))
6757 (if (and (not for-yank) ; in this case, org-yank will decide about folding
6758 kill-ring
6759 (eq org-subtree-clip (current-kill 0))
6760 org-subtree-clip-folded)
6761 ;; The tree was folded before it was killed/copied
6762 (hide-subtree))
6763 (and for-yank (goto-char newend))))
6765 (defun org-kill-is-subtree-p (&optional txt)
6766 "Check if the current kill is an outline subtree, or a set of trees.
6767 Returns nil if kill does not start with a headline, or if the first
6768 headline level is not the largest headline level in the tree.
6769 So this will actually accept several entries of equal levels as well,
6770 which is OK for `org-paste-subtree'.
6771 If optional TXT is given, check this string instead of the current kill."
6772 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
6773 (start-level (and kill
6776 kill)
6777 (- (match-end 2) (match-beginning 2) 1)))
6778 (re (concat "^" org-outline-regexp))
6779 (start (1+ (or (match-beginning 2) -1))))
6780 (if (not start-level)
6781 (progn
6782 nil) ;; does not even start with a heading
6783 (catch 'exit
6784 (while (setq start (string-match re kill (1+ start)))
6785 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
6786 (throw 'exit nil)))
6787 t))))
6789 (defvar org-markers-to-move nil
6790 "Markers that should be moved with a cut-and-paste operation.
6791 Those markers are stored together with their positions relative to
6792 the start of the region.")
6794 (defun org-save-markers-in-region (beg end)
6795 "Check markers in region.
6796 If these markers are between BEG and END, record their position relative
6797 to BEG, so that after moving the block of text, we can put the markers back
6798 into place.
6799 This function gets called just before an entry or tree gets cut from the
6800 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
6801 called immediately, to move the markers with the entries."
6802 (setq org-markers-to-move nil)
6803 (when (featurep 'org-clock)
6804 (org-clock-save-markers-for-cut-and-paste beg end))
6805 (when (featurep 'org-agenda)
6806 (org-agenda-save-markers-for-cut-and-paste beg end)))
6808 (defun org-check-and-save-marker (marker beg end)
6809 "Check if MARKER is between BEG and END.
6810 If yes, remember the marker and the distance to BEG."
6811 (when (and (marker-buffer marker)
6812 (equal (marker-buffer marker) (current-buffer)))
6813 (if (and (>= marker beg) (< marker end))
6814 (push (cons marker (- marker beg)) org-markers-to-move))))
6816 (defun org-reinstall-markers-in-region (beg)
6817 "Move all remembered markers to their position relative to BEG."
6818 (mapc (lambda (x)
6819 (move-marker (car x) (+ beg (cdr x))))
6820 org-markers-to-move)
6821 (setq org-markers-to-move nil))
6823 (defun org-narrow-to-subtree ()
6824 "Narrow buffer to the current subtree."
6825 (interactive)
6826 (save-excursion
6827 (save-match-data
6828 (narrow-to-region
6829 (progn (org-back-to-heading t) (point))
6830 (progn (org-end-of-subtree t t) (point))))))
6832 (defun org-clone-subtree-with-time-shift (n &optional shift)
6833 "Clone the task (subtree) at point N times.
6834 The clones will be inserted as siblings.
6836 In interactive use, the user will be prompted for the number of clones
6837 to be produced, and for a time SHIFT, which may be a repeater as used
6838 in time stamps, for example `+3d'.
6840 When a valid repeater is given and the entry contains any time stamps,
6841 the clones will become a sequence in time, with time stamps in the
6842 subtree shifted for each clone produced. If SHIFT is nil or the
6843 empty string, time stamps will be left alone.
6845 If the original subtree did contain time stamps with a repeater,
6846 the following will happen:
6847 - the repeater will be removed in each clone
6848 - an additional clone will be produced, with the current, unshifted
6849 date(s) in the entry.
6850 - the original entry will be placed *after* all the clones, with
6851 repeater intact.
6852 - the start days in the repeater in the original entry will be shifted
6853 to past the last clone.
6854 I this way you can spell out a number of instances of a repeating task,
6855 and still retain the repeater to cover future instances of the task."
6856 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
6857 (let (beg end template task
6858 shift-n shift-what doshift nmin nmax (n-no-remove -1))
6859 (if (not (and (integerp n) (> n 0)))
6860 (error "Invalid number of replications %s" n))
6863 shift)))
6864 (error "Invalid shift specification %s" shift))
6865 (when doshift
6866 (setq shift-n (string-to-number (match-string 1 shift))
6867 shift-what (cdr (assoc (match-string 2 shift)
6868 '(("d" . day) ("w" . week)
6869 ("m" . month) ("y" . year))))))
6870 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
6871 (setq nmin 1 nmax n)
6872 (org-back-to-heading t)
6873 (setq beg (point))
6874 (org-end-of-subtree t t)
6876 (setq end (point))
6877 (setq template (buffer-substring beg end))
6878 (when (and doshift
6880 (delete-region beg end)
6881 (setq end beg)
6882 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
6883 (goto-char end)
6884 (loop for n from nmin to nmax do
6885 (if (not doshift)
6886 (setq task template)
6887 (with-temp-buffer
6888 (insert template)
6889 (org-mode)
6890 (goto-char (point-min))
6891 (while (re-search-forward org-ts-regexp-both nil t)
6892 (org-timestamp-change (* n shift-n) shift-what))
6893 (unless (= n n-no-remove)
6894 (goto-char (point-min))
6895 (while (re-search-forward org-ts-regexp nil t)
6896 (save-excursion
6897 (goto-char (match-beginning 0))
6899 (delete-region (match-beginning 1) (match-end 1))))))
6900 (setq task (buffer-string))))
6901 (insert task))
6902 (goto-char beg)))
6904 ;;; Outline Sorting
6906 (defun org-sort (with-case)
6907 "Call `org-sort-entries-or-items' or `org-table-sort-lines'.
6908 Optional argument WITH-CASE means sort case-sensitively.
6909 With a double prefix argument, also remove duplicate entries."
6910 (interactive "P")
6911 (if (org-at-table-p)
6912 (org-call-with-arg 'org-table-sort-lines with-case)
6913 (org-call-with-arg 'org-sort-entries-or-items with-case)))
6915 (defun org-sort-remove-invisible (s)
6916 (remove-text-properties 0 (length s) org-rm-props s)
6917 (while (string-match org-bracket-link-regexp s)
6918 (setq s (replace-match (if (match-end 2)
6919 (match-string 3 s)
6920 (match-string 1 s)) t t s)))
6921 s)
6923 (defvar org-priority-regexp) ; defined later in the file
6925 (defvar org-after-sorting-entries-or-items-hook nil
6926 "Hook that is run after a bunch of entries or items have been sorted.
6927 When children are sorted, the cursor is in the parent line when this
6928 hook gets called. When a region or a plain list is sorted, the cursor
6929 will be in the first entry of the sorted region/list.")
6931 (defun org-sort-entries-or-items
6932 (&optional with-case sorting-type getkey-func compare-func property)
6933 "Sort entries on a certain level of an outline tree, or plain list items.
6934 If there is an active region, the entries in the region are sorted.
6935 Else, if the cursor is before the first entry, sort the top-level items.
6936 Else, the children of the entry at point are sorted.
6937 If the cursor is at the first item in a plain list, the list items will be
6938 sorted.
6940 Sorting can be alphabetically, numerically, by date/time as given by
6941 a time stamp, by a property or by priority.
6943 The command prompts for the sorting type unless it has been given to the
6944 function through the SORTING-TYPE argument, which needs to a character,
6945 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
6946 precise meaning of each character:
6948 n Numerically, by converting the beginning of the entry/item to a number.
6949 a Alphabetically, ignoring the TODO keyword and the priority, if any.
6950 t By date/time, either the first active time stamp in the entry, or, if
6951 none exist, by the first inactive one.
6952 In items, only the first line will be checked.
6953 s By the scheduled date/time.
6954 d By deadline date/time.
6955 c By creation time, which is assumed to be the first inactive time stamp
6956 at the beginning of a line.
6957 p By priority according to the cookie.
6958 r By the value of a property.
6960 Capital letters will reverse the sort order.
6962 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
6963 called with point at the beginning of the record. It must return either
6964 a string or a number that should serve as the sorting key for that record.
6966 Comparing entries ignores case by default. However, with an optional argument
6967 WITH-CASE, the sorting considers case as well."
6968 (interactive "P")
6969 (let ((case-func (if with-case 'identity 'downcase))
6970 start beg end stars re re2
6971 txt what tmp plain-list-p)
6972 ;; Find beginning and end of region to sort
6973 (cond
6974 ((org-region-active-p)
6975 ;; we will sort the region
6976 (setq end (region-end)
6977 what "region")
6978 (goto-char (region-beginning))
6979 (if (not (org-on-heading-p)) (outline-next-heading))
6980 (setq start (point)))
6981 ((org-at-item-p)
6982 ;; we will sort this plain list
6983 (org-beginning-of-item-list) (setq start (point))
6984 (org-end-of-item-list)
6986 (setq end (point))
6987 (goto-char start)
6988 (setq plain-list-p t
6989 what "plain list"))
6990 ((or (org-on-heading-p)
6991 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
6992 ;; we will sort the children of the current headline
6993 (org-back-to-heading)
6994 (setq start (point)
6995 end (progn (org-end-of-subtree t t)
6997 (org-back-over-empty-lines)
6998 (point))
6999 what "children")
7000 (goto-char start)
7001 (show-subtree)
7002 (outline-next-heading))
7003 (t
7004 ;; we will sort the top-level entries in this file
7005 (goto-char (point-min))
7006 (or (org-on-heading-p) (outline-next-heading))
7007 (setq start (point))
7008 (goto-char (point-max))
7009 (beginning-of-line 1)
7011 ;; File ends in a non-white line
7012 (end-of-line 1)
7014 (setq end (point-max))
7015 (setq what "top-level")
7016 (goto-char start)
7017 (show-all)))
7019 (setq beg (point))
7020 (if (>= beg end) (error "Nothing to sort"))
7022 (unless plain-list-p
7024 (setq stars (match-string 1)
7025 re (concat "^" (regexp-quote stars) " +")
7026 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
7027 txt (buffer-substring beg end))
7029 (if (and (not (equal stars "*")) (string-match re2 txt))
7030 (error "Region to sort contains a level above the first entry")))
7032 (unless sorting-type
7033 (message
7034 (if plain-list-p
7035 "Sort %s: [a]lpha [n]umeric [t]ime [f]unc A/N/T/F means reversed:"
7036 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7037 [t]ime [s]cheduled [d]eadline [c]reated
7038 A/N/T/S/D/C/P/O/F means reversed:")
7039 what)
7040 (setq sorting-type (read-char-exclusive))
7042 (and (= (downcase sorting-type) ?f)
7043 (setq getkey-func
7044 (org-icompleting-read "Sort using function: "
7045 obarray 'fboundp t nil nil))
7046 (setq getkey-func (intern getkey-func)))
7048 (and (= (downcase sorting-type) ?r)
7049 (setq property
7050 (org-icompleting-read "Property: "
7051 (mapcar 'list (org-buffer-property-keys t))
7052 nil t))))
7054 (message "Sorting entries...")
7056 (save-restriction
7057 (narrow-to-region start end)
7059 (let ((dcst (downcase sorting-type))
7060 (case-fold-search nil)
7061 (now (current-time)))
7062 (sort-subr
7063 (/= dcst sorting-type)
7064 ;; This function moves to the beginning character of the "record" to
7065 ;; be sorted.
7066 (if plain-list-p
7067 (lambda nil
7068 (if (org-at-item-p) t (goto-char (point-max))))
7069 (lambda nil
7070 (if (re-search-forward re nil t)
7071 (goto-char (match-beginning 0))
7072 (goto-char (point-max)))))
7073 ;; This function moves to the last character of the "record" being
7074 ;; sorted.
7075 (if plain-list-p
7076 'org-end-of-item
7077 (lambda nil
7078 (save-match-data
7079 (condition-case nil
7080 (outline-forward-same-level 1)
7081 (error
7082 (goto-char (point-max)))))))
7084 ;; This function returns the value that gets sorted against.
7085 (if plain-list-p
7086 (lambda nil
7088 (cond
7089 ((= dcst ?n)
7090 (string-to-number (buffer-substring (match-end 0)
7091 (point-at-eol))))
7092 ((= dcst ?a)
7093 (buffer-substring (match-end 0) (point-at-eol)))
7094 ((= dcst ?t)
7095 (if (or (re-search-forward org-ts-regexp (point-at-eol) t)
7096 (re-search-forward org-ts-regexp-both
7097 (point-at-eol) t))
7098 (org-time-string-to-seconds (match-string 0))
7099 (org-float-time now)))
7100 ((= dcst ?f)
7101 (if getkey-func
7102 (progn
7103 (setq tmp (funcall getkey-func))
7104 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7105 tmp)
7106 (error "Invalid key function `%s'" getkey-func)))
7107 (t (error "Invalid sorting type `%c'" sorting-type)))))
7108 (lambda nil
7109 (cond
7110 ((= dcst ?n)
7111 (if (looking-at org-complex-heading-regexp)
7112 (string-to-number (match-string 4))
7113 nil))
7114 ((= dcst ?a)
7115 (if (looking-at org-complex-heading-regexp)
7116 (funcall case-func (match-string 4))
7117 nil))
7118 ((= dcst ?t)
7119 (let ((end (save-excursion (outline-next-heading) (point))))
7120 (if (or (re-search-forward org-ts-regexp end t)
7121 (re-search-forward org-ts-regexp-both end t))
7122 (org-time-string-to-seconds (match-string 0))
7123 (org-float-time now))))
7124 ((= dcst ?c)
7125 (let ((end (save-excursion (outline-next-heading) (point))))
7126 (if (re-search-forward
7128 end t)
7129 (org-time-string-to-seconds (match-string 0))
7130 (org-float-time now))))
7131 ((= dcst ?s)
7132 (let ((end (save-excursion (outline-next-heading) (point))))
7133 (if (re-search-forward org-scheduled-time-regexp end t)
7134 (org-time-string-to-seconds (match-string 1))
7135 (org-float-time now))))
7136 ((= dcst ?d)
7137 (let ((end (save-excursion (outline-next-heading) (point))))
7138 (if (re-search-forward org-deadline-time-regexp end t)
7139 (org-time-string-to-seconds (match-string 1))
7140 (org-float-time now))))
7141 ((= dcst ?p)
7142 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7143 (string-to-char (match-string 2))
7144 org-default-priority))
7145 ((= dcst ?r)
7146 (or (org-entry-get nil property) ""))
7147 ((= dcst ?o)
7148 (if (looking-at org-complex-heading-regexp)
7149 (- 9999 (length (member (match-string 2)
7150 org-todo-keywords-1)))))
7151 ((= dcst ?f)
7152 (if getkey-func
7153 (progn
7154 (setq tmp (funcall getkey-func))
7155 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7156 tmp)
7157 (error "Invalid key function `%s'" getkey-func)))
7158 (t (error "Invalid sorting type `%c'" sorting-type)))))
7159 nil
7160 (cond
7161 ((= dcst ?a) 'string<)
7162 ((= dcst ?f) compare-func)
7163 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7164 (t nil)))))
7165 (run-hooks 'org-after-sorting-entries-or-items-hook)
7166 (message "Sorting entries...done")))
7168 (defun org-do-sort (table what &optional with-case sorting-type)
7169 "Sort TABLE of WHAT according to SORTING-TYPE.
7170 The user will be prompted for the SORTING-TYPE if the call to this
7171 function does not specify it. WHAT is only for the prompt, to indicate
7172 what is being sorted. The sorting key will be extracted from
7173 the car of the elements of the table.
7174 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7175 (unless sorting-type
7176 (message
7177 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7178 what)
7179 (setq sorting-type (read-char-exclusive)))
7180 (let ((dcst (downcase sorting-type))
7181 extractfun comparefun)
7182 ;; Define the appropriate functions
7183 (cond
7184 ((= dcst ?n)
7185 (setq extractfun 'string-to-number
7186 comparefun (if (= dcst sorting-type) '< '>)))
7187 ((= dcst ?a)
7188 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7189 (lambda(x) (downcase (org-sort-remove-invisible x))))
7190 comparefun (if (= dcst sorting-type)
7191 'string<
7192 (lambda (a b) (and (not (string< a b))
7193 (not (string= a b)))))))
7194 ((= dcst ?t)
7195 (setq extractfun
7196 (lambda (x)
7197 (if (or (string-match org-ts-regexp x)
7198 (string-match org-ts-regexp-both x))
7199 (org-float-time
7200 (org-time-string-to-time (match-string 0 x)))
7201 0))
7202 comparefun (if (= dcst sorting-type) '< '>)))
7203 (t (error "Invalid sorting type `%c'" sorting-type)))
7205 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7206 table)
7207 (lambda (a b) (funcall comparefun (car a) (car b))))))
7210 ;;; The orgstruct minor mode
7212 ;; Define a minor mode which can be used in other modes in order to
7213 ;; integrate the org-mode structure editing commands.
7215 ;; This is really a hack, because the org-mode structure commands use
7216 ;; keys which normally belong to the major mode. Here is how it
7217 ;; works: The minor mode defines all the keys necessary to operate the
7218 ;; structure commands, but wraps the commands into a function which
7219 ;; tests if the cursor is currently at a headline or a plain list
7220 ;; item. If that is the case, the structure command is used,
7221 ;; temporarily setting many Org-mode variables like regular
7222 ;; expressions for filling etc. However, when any of those keys is
7223 ;; used at a different location, function uses `key-binding' to look
7224 ;; up if the key has an associated command in another currently active
7225 ;; keymap (minor modes, major mode, global), and executes that
7226 ;; command. There might be problems if any of the keys is otherwise
7227 ;; used as a prefix key.
7229 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7230 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7231 ;; addresses this by checking explicitly for both bindings.
7233 (defvar orgstruct-mode-map (make-sparse-keymap)
7234 "Keymap for the minor `orgstruct-mode'.")
7236 (defvar org-local-vars nil
7237 "List of local variables, for use by `orgstruct-mode'")
7239 ;;;###autoload
7240 (define-minor-mode orgstruct-mode
7241 "Toggle the minor more `orgstruct-mode'.
7242 This mode is for using Org-mode structure commands in other modes.
7243 The following key behave as if Org-mode was active, if the cursor
7244 is on a headline, or on a plain list item (both in the definition
7245 of Org-mode).
7247 M-up Move entry/item up
7248 M-down Move entry/item down
7249 M-left Promote
7250 M-right Demote
7251 M-S-up Move entry/item up
7252 M-S-down Move entry/item down
7253 M-S-left Promote subtree
7254 M-S-right Demote subtree
7255 M-q Fill paragraph and items like in Org-mode
7256 C-c ^ Sort entries
7257 C-c - Cycle list bullet
7258 TAB Cycle item visibility
7259 M-RET Insert new heading/item
7260 S-M-RET Insert new TODO heading / Checkbox item
7261 C-c C-c Set tags / toggle checkbox"
7262 nil " OrgStruct" nil
7263 (org-load-modules-maybe)
7264 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7266 ;;;###autoload
7267 (defun turn-on-orgstruct ()
7268 "Unconditionally turn on `orgstruct-mode'."
7269 (orgstruct-mode 1))
7271 (defun orgstruct++-mode (&optional arg)
7272 "Toggle `orgstruct-mode', the enhanced version of it.
7273 In addition to setting orgstruct-mode, this also exports all indentation
7274 and autofilling variables from org-mode into the buffer. It will also
7275 recognize item context in multiline items.
7276 Note that turning off orgstruct-mode will *not* remove the
7277 indentation/paragraph settings. This can only be done by refreshing the
7279 (interactive "P")
7280 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
7281 (if (< arg 1)
7282 (orgstruct-mode -1)
7283 (orgstruct-mode 1)
7284 (let (var val)
7285 (mapc
7286 (lambda (x)
7287 (when (string-match
7289 (symbol-name (car x)))
7290 (setq var (car x) val (nth 1 x))
7291 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7292 org-local-vars)
7293 (org-set-local 'orgstruct-is-++ t))))
7295 (defvar orgstruct-is-++ nil
7296 "Is orgstruct-mode in ++ version in the current-buffer?")
7297 (make-variable-buffer-local 'orgstruct-is-++)
7299 ;;;###autoload
7300 (defun turn-on-orgstruct++ ()
7301 "Unconditionally turn on `orgstruct++-mode'."
7302 (orgstruct++-mode 1))
7304 (defun orgstruct-error ()
7305 "Error when there is no default binding for a structure key."
7306 (interactive)
7307 (error "This key has no function outside structure elements"))
7309 (defun orgstruct-setup ()
7310 "Setup orgstruct keymaps."
7311 (let ((nfunc 0)
7312 (bindings
7313 (list
7314 '([(meta up)] org-metaup)
7315 '([(meta down)] org-metadown)
7316 '([(meta left)] org-metaleft)
7317 '([(meta right)] org-metaright)
7318 '([(meta shift up)] org-shiftmetaup)
7319 '([(meta shift down)] org-shiftmetadown)
7320 '([(meta shift left)] org-shiftmetaleft)
7321 '([(meta shift right)] org-shiftmetaright)
7322 '([?\e (up)] org-metaup)
7323 '([?\e (down)] org-metadown)
7324 '([?\e (left)] org-metaleft)
7325 '([?\e (right)] org-metaright)
7326 '([?\e (shift up)] org-shiftmetaup)
7327 '([?\e (shift down)] org-shiftmetadown)
7328 '([?\e (shift left)] org-shiftmetaleft)
7329 '([?\e (shift right)] org-shiftmetaright)
7330 '([(shift up)] org-shiftup)
7331 '([(shift down)] org-shiftdown)
7332 '([(shift left)] org-shiftleft)
7333 '([(shift right)] org-shiftright)
7334 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7335 '("\M-q" fill-paragraph)
7336 '("\C-c^" org-sort)
7337 '("\C-c-" org-cycle-list-bullet)))
7338 elt key fun cmd)
7339 (while (setq elt (pop bindings))
7340 (setq nfunc (1+ nfunc))
7341 (setq key (org-key (car elt))
7342 fun (nth 1 elt)
7343 cmd (orgstruct-make-binding fun nfunc key))
7344 (org-defkey orgstruct-mode-map key cmd))
7346 ;; Special treatment needed for TAB and RET
7347 (org-defkey orgstruct-mode-map [(tab)]
7348 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7349 (org-defkey orgstruct-mode-map "\C-i"
7350 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7352 (org-defkey orgstruct-mode-map "\M-\C-m"
7353 (orgstruct-make-binding 'org-insert-heading 105
7354 "\M-\C-m" [(meta return)]))
7355 (org-defkey orgstruct-mode-map [(meta return)]
7356 (orgstruct-make-binding 'org-insert-heading 106
7357 [(meta return)] "\M-\C-m"))
7359 (org-defkey orgstruct-mode-map [(shift meta return)]
7360 (orgstruct-make-binding 'org-insert-todo-heading 107
7361 [(meta return)] "\M-\C-m"))
7363 (org-defkey orgstruct-mode-map "\e\C-m"
7364 (orgstruct-make-binding 'org-insert-heading 108
7365 "\e\C-m" [?\e (return)]))
7366 (org-defkey orgstruct-mode-map [?\e (return)]
7367 (orgstruct-make-binding 'org-insert-heading 109
7368 [?\e (return)] "\e\C-m"))
7369 (org-defkey orgstruct-mode-map [?\e (shift return)]
7370 (orgstruct-make-binding 'org-insert-todo-heading 110
7371 [?\e (return)] "\e\C-m"))
7373 (unless org-local-vars
7374 (setq org-local-vars (org-get-local-variables)))
7376 t))
7378 (defun orgstruct-make-binding (fun n &rest keys)
7379 "Create a function for binding in the structure minor mode.
7380 FUN is the command to call inside a table. N is used to create a unique
7381 command name. KEYS are keys that should be checked in for a command
7382 to execute outside of tables."
7383 (eval
7384 (list 'defun
7385 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
7386 '(arg)
7388 "Outside of structure, run the binding of `"
7389 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
7390 "'.")
7391 '(interactive "p")
7392 (list 'if
7393 `(org-context-p 'headline 'item
7394 (and orgstruct-is-++
7395 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
7396 'item-body))
7397 (list 'org-run-like-in-org-mode (list 'quote fun))
7398 (list 'let '(orgstruct-mode)
7399 (list 'call-interactively
7400 (append '(or)
7401 (mapcar (lambda (k)
7402 (list 'key-binding k))
7403 keys)
7404 '('orgstruct-error))))))))
7406 (defun org-context-p (&rest contexts)
7407 "Check if local context is any of CONTEXTS.
7408 Possible values in the list of contexts are `table', `headline', and `item'."
7409 (let ((pos (point)))
7410 (goto-char (point-at-bol))
7411 (prog1 (or (and (memq 'table contexts)
7413 (and (memq 'headline contexts)
7415 (looking-at outline-regexp))
7416 (and (memq 'item contexts)
7418 (and (memq 'item-body contexts)
7419 (org-in-item-p)))
7420 (goto-char pos))))
7422 (defun org-get-local-variables ()
7423 "Return a list of all local variables in an org-mode buffer."
7424 (let (varlist)
7425 (with-current-buffer (get-buffer-create "*Org tmp*")
7426 (erase-buffer)
7427 (org-mode)
7428 (setq varlist (buffer-local-variables)))
7429 (kill-buffer "*Org tmp*")
7430 (delq nil
7431 (mapcar
7432 (lambda (x)
7433 (setq x
7434 (if (symbolp x)
7435 (list x)
7436 (list (car x) (list 'quote (cdr x)))))
7437 (if (string-match
7438 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
7439 (symbol-name (car x)))
7440 x nil))
7441 varlist))))
7443 ;;;###autoload
7444 (defun org-run-like-in-org-mode (cmd)
7445 "Run a command, pretending that the current buffer is in Org-mode.
7446 This will temporarily bind local variables that are typically bound in
7447 Org-mode to the values they have in Org-mode, and then interactively
7448 call CMD."
7449 (org-load-modules-maybe)
7450 (unless org-local-vars
7451 (setq org-local-vars (org-get-local-variables)))
7452 (eval (list 'let org-local-vars
7453 (list 'call-interactively (list 'quote cmd)))))
7455 ;;;; Archiving
7457 (defun org-get-category (&optional pos)
7458 "Get the category applying to position POS."
7459 (get-text-property (or pos (point)) 'org-category))
7461 (defun org-refresh-category-properties ()
7462 "Refresh category text properties in the buffer."
7463 (let ((def-cat (cond
7464 ((null org-category)
7465 (if buffer-file-name
7466 (file-name-sans-extension
7467 (file-name-nondirectory buffer-file-name))
7468 "???"))
7469 ((symbolp org-category) (symbol-name org-category))
7470 (t org-category)))
7471 beg end cat pos optionp)
7472 (org-unmodified
7473 (save-excursion
7474 (save-restriction
7475 (widen)
7476 (goto-char (point-min))
7477 (put-text-property (point) (point-max) 'org-category def-cat)
7478 (while (re-search-forward
7480 (setq pos (match-end 0)
7481 optionp (equal (char-after (match-beginning 0)) ?#)
7482 cat (org-trim (match-string 2)))
7483 (if optionp
7484 (setq beg (point-at-bol) end (point-max))
7485 (org-back-to-heading t)
7486 (setq beg (point) end (org-end-of-subtree t t)))
7487 (put-text-property beg end 'org-category cat)
7488 (goto-char pos)))))))
7491 ;;;; Link Stuff
7493 ;;; Link abbreviations
7495 (defun org-link-expand-abbrev (link)
7496 "Apply replacements as defined in `org-link-abbrev-alist."
7498 (let* ((key (match-string 1 link))
7499 (as (or (assoc key org-link-abbrev-alist-local)
7500 (assoc key org-link-abbrev-alist)))
7501 (tag (and (match-end 2) (match-string 3 link)))
7502 rpl)
7503 (if (not as)
7504 link
7505 (setq rpl (cdr as))
7506 (cond
7507 ((symbolp rpl) (funcall rpl tag))
7508 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
7509 ((string-match "%h" rpl)
7510 (replace-match (url-hexify-string (or tag "")) t t rpl))
7511 (t (concat rpl tag)))))
7512 link))
7514 ;;; Storing and inserting links
7516 (defvar org-insert-link-history nil
7517 "Minibuffer history for links inserted with `org-insert-link'.")
7519 (defvar org-stored-links nil
7520 "Contains the links stored with `org-store-link'.")
7522 (defvar org-store-link-plist nil
7523 "Plist with info about the most recently link created with `org-store-link'.")
7525 (defvar org-link-protocols nil
7526 "Link protocols added to Org-mode using `org-add-link-type'.")
7528 (defvar org-store-link-functions nil
7529 "List of functions that are called to create and store a link.
7530 Each function will be called in turn until one returns a non-nil
7531 value. Each function should check if it is responsible for creating
7532 this link (for example by looking at the major mode).
7533 If not, it must exit and return nil.
7534 If yes, it should return a non-nil value after a calling
7535 `org-store-link-props' with a list of properties and values.
7536 Special properties are:
7540 This is obligatory as well.
7541 :description Optional default description for the second pair
7542 of brackets in an Org-mode link. The user can still change
7543 this when inserting this link into an Org-mode buffer.
7545 In addition to these, any additional properties can be specified
7546 and then used in remember templates.")
7548 (defun org-add-link-type (type &optional follow export)
7549 "Add TYPE to the list of `org-link-types'.
7550 Re-compute all regular expressions depending on `org-link-types'
7552 FOLLOW and EXPORT are two functions.
7554 FOLLOW should take the link path as the single argument and do whatever
7555 is necessary to follow the link, for example find a file or display
7556 a mail message.
7558 EXPORT should format the link path for export to one of the export formats.
7559 It should be a function accepting three arguments:
7562 desc the description of the link, if any, nil if there was no description
7563 format the export format, a symbol like `html' or `latex'.
7565 The function may use the FORMAT information to return different values
7566 depending on the format. The return value will be put literally into
7567 the exported file.
7568 Org-mode has a built-in default for exporting links. If you are happy with
7569 this default, there is no need to define an export function for the link
7570 type. For a simple example of an export function, see `org-bbdb.el'."
7571 (add-to-list 'org-link-types type t)
7572 (org-make-link-regexps)
7573 (if (assoc type org-link-protocols)
7574 (setcdr (assoc type org-link-protocols) (list follow export))
7575 (push (list type follow export) org-link-protocols)))
7577 (defvar org-agenda-buffer-name)
7579 ;;;###autoload
7580 (defun org-store-link (arg)
7582 This link is added to `org-stored-links' and can later be inserted
7585 For some link types, a prefix arg is interpreted:
7586 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
7587 For file links, arg negates `org-context-in-file-links'."
7588 (interactive "P")
7589 (org-load-modules-maybe)
7590 (setq org-store-link-plist nil) ; reset
7591 (let ((outline-regexp (org-get-limited-outline-regexp))
7592 link cpltxt desc description search txt custom-id)
7593 (cond
7595 ((run-hook-with-args-until-success 'org-store-link-functions)
7596 (setq link (plist-get org-store-link-plist :link)
7597 desc (or (plist-get org-store-link-plist :description) link)))
7599 ((equal (buffer-name) "*Org Edit Src Example*")
7600 (let (label gc)
7601 (while (or (not label)
7602 (save-excursion
7603 (save-restriction
7604 (widen)
7605 (goto-char (point-min))
7606 (re-search-forward
7607 (regexp-quote (format org-coderef-label-format label))
7608 nil t))))
7609 (when label (message "Label exists already") (sit-for 2))
7610 (setq label (read-string "Code line label: " label)))
7611 (end-of-line 1)
7612 (setq link (format org-coderef-label-format label))
7613 (setq gc (- 79 (length link)))
7614 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
7615 (insert link)
7616 (setq link (concat "(" label ")") desc nil)))
7618 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
7619 ;; We are in the agenda, link to referenced location
7620 (let ((m (or (get-text-property (point) 'org-hd-marker)
7621 (get-text-property (point) 'org-marker))))
7622 (when m
7623 (org-with-point-at m
7624 (call-interactively 'org-store-link)))))
7626 ((eq major-mode 'calendar-mode)
7627 (let ((cd (calendar-cursor-to-date)))
7628 (setq link
7629 (format-time-string
7630 (car org-time-stamp-formats)
7631 (apply 'encode-time
7632 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
7633 nil nil nil))))
7634 (org-store-link-props :type "calendar" :date cd)))
7636 ((eq major-mode 'w3-mode)
7637 (setq cpltxt (if (and (buffer-name)
7638 (not (string-match "Untitled" (buffer-name))))
7639 (buffer-name)
7640 (url-view-url t))
7641 link (org-make-link (url-view-url t)))
7642 (org-store-link-props :type "w3" :url (url-view-url t)))
7644 ((eq major-mode 'w3m-mode)
7645 (setq cpltxt (or w3m-current-title w3m-current-url)
7646 link (org-make-link w3m-current-url))
7647 (org-store-link-props :type "w3m" :url (url-view-url t)))
7649 ((setq search (run-hook-with-args-until-success
7650 'org-create-file-search-functions))
7651 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
7652 "::" search))
7653 (setq cpltxt (or description link)))
7655 ((eq major-mode 'image-mode)
7656 (setq cpltxt (concat "file:"
7657 (abbreviate-file-name buffer-file-name))
7658 link (org-make-link cpltxt))
7659 (org-store-link-props :type "image" :file buffer-file-name))
7661 ((eq major-mode 'dired-mode)
7662 ;; link to the file in the current line
7663 (setq cpltxt (concat "file:"
7664 (abbreviate-file-name
7665 (expand-file-name
7666 (dired-get-filename nil t))))
7667 link (org-make-link cpltxt)))
7669 ((and buffer-file-name (org-mode-p))
7670 (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
7671 (cond
7673 (setq cpltxt
7674 (concat "file:"
7675 (abbreviate-file-name buffer-file-name)
7676 "::" (match-string 1))
7677 link (org-make-link cpltxt)))
7678 ((and (featurep 'org-id)
7679 (or (eq org-link-to-org-use-id t)
7680 (and (eq org-link-to-org-use-id 'create-if-interactive)
7681 (interactive-p))
7682 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
7683 (interactive-p)
7684 (not custom-id))
7685 (and org-link-to-org-use-id
7686 (condition-case nil
7687 (org-entry-get nil "ID")
7688 (error nil)))))
7689 ;; We can make a link using the ID.
7690 (setq link (condition-case nil
7691 (prog1 (org-id-store-link)
7692 (setq desc (plist-get org-store-link-plist
7693 :description)))
7694 (error
7695 ;; probably before first headline, link to file only
7696 (concat "file:"
7697 (abbreviate-file-name buffer-file-name))))))
7698 (t
7699 ;; Just link to current headline
7700 (setq cpltxt (concat "file:"
7701 (abbreviate-file-name buffer-file-name)))
7702 ;; Add a context search string
7703 (when (org-xor org-context-in-file-links arg)
7704 (setq txt (cond
7705 ((org-on-heading-p) nil)
7706 ((org-region-active-p)
7707 (buffer-substring (region-beginning) (region-end)))
7708 (t nil)))
7710 (setq cpltxt
7711 (concat cpltxt "::"
7712 (condition-case nil
7713 (org-make-org-heading-search-string txt)
7714 (error "")))
7715 desc (or (nth 4 (ignore-errors
7716 (org-heading-components))) "NONE"))))
7718 (setq cpltxt (substring cpltxt 0 -2)))
7719 (setq link (org-make-link cpltxt)))))
7721 ((buffer-file-name (buffer-base-buffer))
7722 ;; Just link to this file here.
7723 (setq cpltxt (concat "file:"
7724 (abbreviate-file-name
7725 (buffer-file-name (buffer-base-buffer)))))
7726 ;; Add a context string
7727 (when (org-xor org-context-in-file-links arg)
7728 (setq txt (if (org-region-active-p)
7729 (buffer-substring (region-beginning) (region-end))
7730 (buffer-substring (point-at-bol) (point-at-eol))))
7731 ;; Only use search option if there is some text.
7733 (setq cpltxt
7734 (concat cpltxt "::" (org-make-org-heading-search-string txt))
7735 desc "NONE")))
7736 (setq link (org-make-link cpltxt)))
7738 ((interactive-p)
7739 (error "Cannot link to a buffer which is not visiting a file"))
7741 (t (setq link nil)))
7743 (if (consp link) (setq cpltxt (car link) link (cdr link)))
7744 (setq link (or link cpltxt)
7745 desc (or desc cpltxt))
7746 (if (equal desc "NONE") (setq desc nil))
7748 (if (and (or (interactive-p) executing-kbd-macro) link)
7749 (progn
7750 (setq org-stored-links
7751 (cons (list link desc) org-stored-links))
7752 (message "Stored: %s" (or desc link))
7753 (when custom-id
7754 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
7755 "::#" custom-id))
7756 (setq org-stored-links
7757 (cons (list link desc) org-stored-links))))
7758 (and link (org-make-link-string link desc)))))
7760 (defun org-store-link-props (&rest plist)
7761 "Store link properties, extract names and addresses."
7762 (let (x adr)
7763 (when (setq x (plist-get plist :from))
7764 (setq adr (mail-extract-address-components x))
7765 (setq plist (plist-put plist :fromname (car adr)))
7766 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
7767 (when (setq x (plist-get plist :to))
7768 (setq adr (mail-extract-address-components x))
7769 (setq plist (plist-put plist :toname (car adr)))
7770 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
7771 (let ((from (plist-get plist :from))
7772 (to (plist-get plist :to)))
7773 (when (and from to org-from-is-user-regexp)
7774 (setq plist
7775 (plist-put plist :fromto
7776 (if (string-match org-from-is-user-regexp from)
7777 (concat "to %t")
7778 (concat "from %f"))))))
7779 (setq org-store-link-plist plist))
7781 (defun org-add-link-props (&rest plist)
7782 "Add these properties to the link property list."
7783 (let (key value)
7784 (while plist
7785 (setq key (pop plist) value (pop plist))
7786 (setq org-store-link-plist
7787 (plist-put org-store-link-plist key value)))))
7789 (defun org-email-link-description (&optional fmt)
7790 "Return the description part of an email link.
7791 This takes information from `org-store-link-plist' and formats it
7792 according to FMT (default from `org-email-link-description-format')."
7793 (setq fmt (or fmt org-email-link-description-format))
7794 (let* ((p org-store-link-plist)
7795 (to (plist-get p :toaddress))
7796 (from (plist-get p :fromaddress))
7797 (table
7798 (list
7799 (cons "%c" (plist-get p :fromto))
7800 (cons "%F" (plist-get p :from))
7801 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
7802 (cons "%T" (plist-get p :to))
7803 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
7804 (cons "%s" (plist-get p :subject))
7805 (cons "%m" (plist-get p :message-id)))))
7806 (when (string-match "%c" fmt)
7807 ;; Check if the user wrote this message
7808 (if (and org-from-is-user-regexp from to
7809 (save-match-data (string-match org-from-is-user-regexp from)))
7810 (setq fmt (replace-match "to %t" t t fmt))
7811 (setq fmt (replace-match "from %f" t t fmt))))
7812 (org-replace-escapes fmt table)))
7814 (defun org-make-org-heading-search-string (&optional string heading)
7815 "Make search string for STRING or current headline."
7816 (interactive)
7817 (let ((s (or string (org-get-heading))))
7818 (unless (and string (not heading))
7819 ;; We are using a headline, clean up garbage in there.
7820 (if (string-match org-todo-regexp s)
7821 (setq s (replace-match "" t t s)))
7823 (setq s (replace-match "" t t s)))
7824 (setq s (org-trim s))
7827 (setq s (replace-match "" t t s)))
7828 (while (string-match org-ts-regexp s)
7829 (setq s (replace-match "" t t s))))
7831 (setq s (replace-match " " t t s)))
7832 (or string (setq s (concat "*" s))) ; Add * for headlines
7835 (defun org-make-link (&rest strings)
7836 "Concatenate STRINGS."
7837 (apply 'concat strings))
7839 (defun org-make-link-string (link &optional description)
7840 "Make a link with brackets, consisting of LINK and DESCRIPTION."
7842 (error "Empty link"))
7843 (when (and description
7844 (stringp description)
7846 (setq description nil))
7847 (when (stringp description)
7848 ;; Remove brackets from the description, they are fatal.
7850 (setq description (replace-match "{" t t description)))
7852 (setq description (replace-match "}" t t description))))
7853 (when (equal (org-link-escape link) description)
7854 ;; No description needed, it is identical
7855 (setq description nil))
7856 (when (and (not description)
7857 (not (equal link (org-link-escape link))))
7858 (setq description (org-extract-attributes link)))
7859 (concat "[[" (org-link-escape link) "]"
7860 (if description (concat "[" description "]") "")
7861 "]"))
7863 (defconst org-link-escape-chars
7864 '((?\ . "%20")
7865 (?\[ . "%5B")
7866 (?\] . "%5D")
7877 (?\; . "%3B")
7878 (?? . "%3F")
7879 (?= . "%3D")
7880 (?+ . "%2B")
7881 )
7882 "Association list of escapes for some characters problematic in links.
7883 This is the list that is used for internal purposes.")
7885 (defvar org-url-encoding-use-url-hexify nil)
7887 (defconst org-link-escape-chars-browser
7888 '((?\ . "%20")) ; 32 for the SPC char
7889 "Association list of escapes for some characters problematic in links.
7890 This is the list that is used before handing over to the browser.")
7892 (defun org-link-escape (text &optional table)
7893 "Escape characters in TEXT that are problematic for links."
7894 (if org-url-encoding-use-url-hexify
7895 (url-hexify-string text)
7896 (setq table (or table org-link-escape-chars))
7897 (when text
7898 (let ((re (mapconcat (lambda (x) (regexp-quote
7899 (char-to-string (car x))))
7901 (while (string-match re text)
7902 (setq text
7903 (replace-match
7904 (cdr (assoc (string-to-char (match-string 0 text))
7905 table))
7906 t t text)))
7907 text))))
7909 (defun org-link-unescape (text &optional table)
7910 "Reverse the action of `org-link-escape'."
7911 (if org-url-encoding-use-url-hexify
7912 (url-unhex-string text)
7913 (setq table (or table org-link-escape-chars))
7914 (when text
7915 (let ((re (mapconcat (lambda (x) (regexp-quote (cdr x)))
7917 (while (string-match re text)
7918 (setq text
7919 (replace-match
7920 (char-to-string (car (rassoc (match-string 0 text) table)))
7921 t t text)))
7922 text))))
7924 (defun org-xor (a b)
7925 "Exclusive or."
7926 (if a (not b) b))
7928 (defun org-fixup-message-id-for-http (s)
7929 "Replace special characters in a message id, so it can be used in an http query."
7930 (while (string-match "<" s)
7931 (setq s (replace-match "%3C" t t s)))
7932 (while (string-match ">" s)
7933 (setq s (replace-match "%3E" t t s)))
7934 (while (string-match "@" s)
7935 (setq s (replace-match "%40" t t s)))
7936 s)
7938 ;;;###autoload
7939 (defun org-insert-link-global ()
7940 "Insert a link like Org-mode does.
7941 This command can be called in any mode to insert a link in Org-mode syntax."
7942 (interactive)
7943 (org-load-modules-maybe)
7944 (org-run-like-in-org-mode 'org-insert-link))
7946 (defun org-insert-link (&optional complete-file link-location)
7947 "Insert a link. At the prompt, enter the link.
7949 Completion can be used to insert any of the link protocol prefixes like
7950 http or ftp in use.
7952 The history can be used to select a link previously stored with
7953 `org-store-link'. When the empty string is entered (i.e. if you just
7954 press RET at the prompt), the link defaults to the most recently
7955 stored link. As SPC triggers completion in the minibuffer, you need to
7956 use M-SPC or C-q SPC to force the insertion of a space character.
7958 You will also be prompted for a description, and if one is given, it will
7959 be displayed in the buffer instead of the link.
7961 If there is already a link at point, this command will allow you to edit link
7962 and description parts.
7965 be selected using completion. The path to the file will be relative to the
7966 current directory if the file is in the current directory or a subdirectory.
7967 Otherwise, the link will be the absolute path as completed in the minibuffer
7968 \(i.e. normally ~/path/to/file). You can configure this behavior using the
7969 option `org-link-file-path-type'.
7972 the current directory or below.
7975 `org-keep-stored-link-after-insertion'.
7977 If `org-make-link-description-function' is non-nil, this function will be
7978 called with the link target, and the result will be the default
7979 link description.
7981 If the LINK-LOCATION parameter is non-nil, this value will be
7982 used as the link location instead of reading one interactively."
7983 (interactive "P")
7984 (let* ((wcf (current-window-configuration))
7985 (region (if (org-region-active-p)
7986 (buffer-substring (region-beginning) (region-end))))
7987 (remove (and region (list (region-beginning) (region-end))))
7988 (desc region)
7989 tmphist ; byte-compile incorrectly complains about this
7990 (link link-location)
7991 entry file all-prefixes)
7992 (cond
7993 (link-location) ; specified by arg, just use it.
7994 ((org-in-regexp org-bracket-link-regexp 1)
7995 ;; We do have a link at point, and we are going to edit it.
7996 (setq remove (list (match-beginning 0) (match-end 0)))
7997 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
7998 (setq link (read-string "Link: "
7999 (org-link-unescape
8000 (org-match-string-no-properties 1)))))
8001 ((or (org-in-regexp org-angle-link-re)
8002 (org-in-regexp org-plain-link-re))
8003 ;; Convert to bracket link
8004 (setq remove (list (match-beginning 0) (match-end 0))
8005 link (read-string "Link: "
8006 (org-remove-angle-brackets (match-string 0)))))
8007 ((member complete-file '((4) (16)))
8008 ;; Completing read for file names.
8009 (setq link (org-file-complete-link complete-file)))
8010 (t
8011 ;; Read link, with completion for stored links.
8012 (with-output-to-temp-buffer "*Org Links*"
8013 (princ "Insert a link.
8015 (when org-stored-links
8017 (princ (mapconcat
8018 (lambda (x)
8019 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8021 (let ((cw (selected-window)))
8022 (select-window (get-buffer-window "*Org Links*"))
8023 (setq truncate-lines t)
8024 (unless (pos-visible-in-window-p (point-max))
8025 (org-fit-window-to-buffer))
8026 (and (window-live-p cw) (select-window cw)))
8027 ;; Fake a link history, containing the stored links.
8028 (setq tmphist (append (mapcar 'car org-stored-links)
8029 org-insert-link-history))
8030 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8031 (mapcar 'car org-link-abbrev-alist)
8032 org-link-types))
8033 (unwind-protect
8034 (progn
8035 (setq link
8036 (let ((org-completion-use-ido nil)
8037 (org-completion-use-iswitchb nil))
8038 (org-completing-read
8039 "Link: "
8040 (append
8041 (mapcar (lambda (x) (list (concat x ":")))
8042 all-prefixes)
8043 (mapcar 'car org-stored-links))
8044 nil nil nil
8045 'tmphist
8046 (car (car org-stored-links)))))
8048 (error "No link selected"))
8049 (if (or (member link all-prefixes)
8050 (and (equal ":" (substring link -1))
8051 (member (substring link 0 -1) all-prefixes)
8052 (setq link (substring link 0 -1))))
8053 (setq link (org-link-try-special-completion link))))
8054 (set-window-configuration wcf)
8055 (kill-buffer "*Org Links*"))
8056 (setq entry (assoc link org-stored-links))
8057 (or entry (push link org-insert-link-history))
8058 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8059 (not org-keep-stored-link-after-insertion))
8060 (setq org-stored-links (delq (assoc link org-stored-links)
8061 org-stored-links)))
8062 (setq desc (or desc (nth 1 entry)))))
8064 (if (string-match org-plain-link-re link)
8065 ;; URL-like link, normalize the use of angular brackets.
8066 (setq link (org-make-link (org-remove-angle-brackets link))))
8068 ;; Check if we are linking to the current file with a search option
8069 ;; If yes, simplify the link by using only the search option.
8070 (when (and buffer-file-name
8072 (let* ((path (match-string 1 link))
8073 (case-fold-search nil)
8074 (search (match-string 2 link)))
8075 (save-match-data
8076 (if (equal (file-truename buffer-file-name) (file-truename path))
8077 ;; We are linking to this same file, with a search option
8078 (setq link search)))))
8080 ;; Check if we can/should use a relative path. If yes, simplify the link
8082 (let* ((type (match-string 1 link))
8083 (path (match-string 2 link))
8084 (origpath path)
8085 (case-fold-search nil))
8086 (cond
8087 ((or (eq org-link-file-path-type 'absolute)
8088 (equal complete-file '(16)))
8089 (setq path (abbreviate-file-name (expand-file-name path))))
8090 ((eq org-link-file-path-type 'noabbrev)
8091 (setq path (expand-file-name path)))
8092 ((eq org-link-file-path-type 'relative)
8093 (setq path (file-relative-name path)))
8094 (t
8095 (save-match-data
8096 (if (string-match (concat "^" (regexp-quote
8097 (file-name-as-directory
8098 (expand-file-name "."))))
8099 (expand-file-name path))
8100 ;; We are linking a file with relative path name.
8101 (setq path (substring (expand-file-name path)
8102 (match-end 0)))
8103 (setq path (abbreviate-file-name (expand-file-name path)))))))
8104 (setq link (concat type path))
8105 (if (equal desc origpath)
8106 (setq desc path))))
8108 (if org-make-link-description-function
8109 (setq desc (funcall org-make-link-description-function link desc)))
8111 (setq desc (read-string "Description: " desc))
8113 (if remove (apply 'delete-region remove))
8114 (insert (org-make-link-string link desc))))
8116 (defun org-link-try-special-completion (type)
8117 "If there is completion support for link type TYPE, offer it."
8118 (let ((fun (intern (concat "org-" type "-complete-link"))))
8119 (if (functionp fun)
8120 (funcall fun)
8121 (read-string "Link (no completion support): " (concat type ":")))))
8123 (defun org-file-complete-link (&optional arg)
8124 "Create a file link using completion."
8125 (let (file link)
8126 (setq file (read-file-name "File: "))
8127 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8128 (pwd1 (file-name-as-directory (abbreviate-file-name
8129 (expand-file-name ".")))))
8130 (cond
8131 ((equal arg '(16))
8132 (setq link (org-make-link
8133 "file:"
8134 (abbreviate-file-name (expand-file-name file)))))
8136 (setq link (org-make-link "file:" (match-string 1 file))))
8138 (expand-file-name file))
8139 (setq link (org-make-link
8140 "file:" (match-string 1 (expand-file-name file)))))
8141 (t (setq link (org-make-link "file:" file)))))
8142 link))
8144 (defun org-completing-read (&rest args)
8145 "Completing-read with SPACE being a normal character."
8146 (let ((minibuffer-local-completion-map
8147 (copy-keymap minibuffer-local-completion-map)))
8148 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
8149 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
8150 (apply 'org-icompleting-read args)))
8152 (defun org-completing-read-no-i (&rest args)
8153 (let (org-completion-use-ido org-completion-use-iswitchb)
8154 (apply 'org-completing-read args)))
8156 (defun org-iswitchb-completing-read (prompt choices &rest args)
8157 "Use iswitch as a completing-read replacement to choose from choices.
8158 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
8159 from."
8160 (let* ((iswitchb-use-virtual-buffers nil)
8161 (iswitchb-make-buflist-hook
8162 (lambda ()
8163 (setq iswitchb-temp-buflist choices))))
8164 (iswitchb-read-buffer prompt)))
8166 (defun org-icompleting-read (&rest args)
8167 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
8168 (org-without-partial-completion
8169 (if (and org-completion-use-ido
8170 (fboundp 'ido-completing-read)
8171 (boundp 'ido-mode) ido-mode
8172 (listp (second args)))
8173 (let ((ido-enter-matching-directory nil))
8174 (apply 'ido-completing-read (concat (car args))
8175 (if (consp (car (nth 1 args)))
8176 (mapcar (lambda (x) (car x)) (nth 1 args))
8177 (nth 1 args))
8178 (cddr args)))
8179 (if (and org-completion-use-iswitchb
8180 (boundp 'iswitchb-mode) iswitchb-mode
8181 (listp (second args)))
8182 (apply 'org-iswitchb-completing-read (concat (car args))
8183 (if (consp (car (nth 1 args)))
8184 (mapcar (lambda (x) (car x)) (nth 1 args))
8185 (nth 1 args))
8186 (cddr args))
8187 (apply 'completing-read args)))))
8189 (defun org-extract-attributes (s)
8190 "Extract the attributes cookie from a string and set as text property."
8191 (let (a attr (start 0) key value)
8192 (save-match-data
8194 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
8196 (setq key (match-string 1 a) value (match-string 2 a)
8197 start (match-end 0)
8198 attr (plist-put attr (intern key) value))))
8199 (org-add-props s nil 'org-attr attr))
8200 s))
8202 (defun org-extract-attributes-from-string (tag)
8203 (let (key value attr)
8205 (setq key (match-string 1 tag) value (match-string 2 tag)
8206 tag (replace-match "" t t tag)
8207 attr (plist-put attr (intern key) value)))
8208 (cons tag attr)))
8210 (defun org-attributes-to-string (plist)
8211 "Format a property list into an HTML attribute list."
8212 (let ((s "") key value)
8213 (while plist
8214 (setq key (pop plist) value (pop plist))
8215 (and value
8217 s))
8219 ;;; Opening/following a link
8221 (defvar org-link-search-failed nil)
8223 (defvar org-open-link-functions nil
8224 "Hook for functions finding a plain text link.
8225 These functions must take a single argument, the link content.
8226 They will be called for links that look like [[link text][description]]
8230 These functions will be called *before* Org attempts to resolve the
8231 link by doing text searches in the current buffer - so if you want a
8233 handle this as a special case.
8235 When the function does handle the link, it must return a non-nil value.
8236 If it decides that it is not responsible for this link, it must return
8237 nil to indicate that that Org-mode can continue with other options
8238 like exact and fuzzy text search.")
8240 (defun org-next-link ()
8241 "Move forward to the next link.
8242 If the link is in hidden text, expose it."
8243 (interactive)
8244 (when (and org-link-search-failed (eq this-command last-command))
8245 (goto-char (point-min))
8246 (message "Link search wrapped back to beginning of buffer"))
8247 (setq org-link-search-failed nil)
8248 (let* ((pos (point))
8249 (ct (org-context))
8250 (a (assoc :link ct)))
8251 (if a (goto-char (nth 2 a)))
8252 (if (re-search-forward org-any-link-re nil t)
8253 (progn
8254 (goto-char (match-beginning 0))
8255 (if (org-invisible-p) (org-show-context)))
8256 (goto-char pos)
8257 (setq org-link-search-failed t)
8258 (error "No further link found"))))
8260 (defun org-previous-link ()
8261 "Move backward to the previous link.
8262 If the link is in hidden text, expose it."
8263 (interactive)
8264 (when (and org-link-search-failed (eq this-command last-command))
8265 (goto-char (point-max))
8266 (message "Link search wrapped back to end of buffer"))
8267 (setq org-link-search-failed nil)
8268 (let* ((pos (point))
8269 (ct (org-context))
8270 (a (assoc :link ct)))
8271 (if a (goto-char (nth 1 a)))
8272 (if (re-search-backward org-any-link-re nil t)
8273 (progn
8274 (goto-char (match-beginning 0))
8275 (if (org-invisible-p) (org-show-context)))
8276 (goto-char pos)
8277 (setq org-link-search-failed t)
8278 (error "No further link found"))))
8280 (defun org-translate-link (s)
8281 "Translate a link string if a translation function has been defined."
8282 (if (and org-link-translation-function
8283 (fboundp org-link-translation-function)
8285 (progn
8286 (setq s (funcall org-link-translation-function
8287 (match-string 1) (match-string 2)))
8288 (concat (car s) ":" (cdr s)))
8289 s))
8291 (defun org-translate-link-from-planner (type path)
8292 "Translate a link from Emacs Planner syntax so that Org can follow it.
8293 This is still an experimental function, your mileage may vary."
8294 (cond
8295 ((member type '("http" "https" "news" "ftp"))
8296 ;; standard Internet links are the same.
8297 nil)
8298 ((and (equal type "irc") (string-match "^//" path))
8299 ;; Planner has two / at the beginning of an irc link, we have 1.
8300 ;; We should have zero, actually....
8301 (setq path (substring path 1)))
8302 ((and (equal type "lisp") (string-match "^/" path))
8303 ;; Planner has a slash, we do not.
8304 (setq type "elisp" path (substring path 1)))
8306 ;; A typical message link. Planner has the id after the final slash,
8307 ;; we separate it with a hash mark
8308 (setq path (concat (match-string 1 path) "#"
8309 (org-remove-angle-brackets (match-string 2 path)))))
8310 )
8311 (cons type path))
8313 (defun org-find-file-at-mouse (ev)
8314 "Open file link or URL at mouse."
8315 (interactive "e")
8316 (mouse-set-point ev)
8317 (org-open-at-point 'in-emacs))
8319 (defun org-open-at-mouse (ev)
8320 "Open file link or URL at mouse."
8321 (interactive "e")
8322 (mouse-set-point ev)
8323 (if (eq major-mode 'org-agenda-mode)
8324 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
8325 (org-open-at-point))
8327 (defvar org-window-config-before-follow-link nil
8328 "The window configuration before following a link.
8329 This is saved in case the need arises to restore it.")
8331 (defvar org-open-link-marker (make-marker)
8332 "Marker pointing to the location where `org-open-at-point; was called.")
8334 ;;;###autoload
8335 (defun org-open-at-point-global ()
8336 "Follow a link like Org-mode does.
8337 This command can be called in any mode to follow a link that has
8338 Org-mode syntax."
8339 (interactive)
8340 (org-run-like-in-org-mode 'org-open-at-point))
8342 ;;;###autoload
8343 (defun org-open-link-from-string (s &optional arg reference-buffer)
8344 "Open a link in the string S, as if it was in Org-mode."
8346 (let ((reference-buffer (or reference-buffer (current-buffer))))
8347 (with-temp-buffer
8348 (let ((org-inhibit-startup t))
8349 (org-mode)
8350 (insert s)
8351 (goto-char (point-min))
8352 (org-open-at-point arg reference-buffer)))))
8354 (defun org-open-at-point (&optional in-emacs reference-buffer)
8355 "Open link at or after point.
8356 If there is no link at point, this function will search forward up to
8357 the end of the current line.
8358 Normally, files will be opened by an appropriate application. If the
8359 optional argument IN-EMACS is non-nil, Emacs will visit the file.
8360 With a double prefix argument, try to open outside of Emacs, in the
8361 application the system uses for this file type."
8362 (interactive "P")
8363 (org-load-modules-maybe)
8364 (move-marker org-open-link-marker (point))
8365 (setq org-window-config-before-follow-link (current-window-configuration))
8366 (org-remove-occur-highlights nil nil t)
8367 (cond
8368 ((and (org-on-heading-p)
8369 (not (org-in-regexp
8374 (or (org-offer-links-in-entry in-emacs)
8375 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
8376 ((org-at-timestamp-p t) (org-follow-timestamp-link))
8377 ((or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
8378 (org-footnote-action))
8379 (t
8380 (let (type path link line search (pos (point)))
8381 (catch 'match
8382 (save-excursion
8384 (when (org-in-regexp org-bracket-link-regexp 1)
8385 (setq link (org-extract-attributes
8386 (org-link-unescape (org-match-string-no-properties 1))))
8388 (setq link (replace-match " " t t link)))
8389 (setq link (org-link-expand-abbrev link))
8390 (cond
8391 ((or (file-name-absolute-p link)
8393 (setq type "file" path link))
8394 ((string-match org-link-re-with-space3 link)
8395 (setq type (match-string 1 link) path (match-string 2 link)))
8396 (t (setq type "thisfile" path link)))
8397 (throw 'match t)))
8399 (when (get-text-property (point) 'org-linked-text)
8400 (setq type "thisfile"
8401 pos (if (get-text-property (1+ (point)) 'org-linked-text)
8402 (1+ (point)) (point))
8403 path (buffer-substring
8404 (previous-single-property-change pos 'org-linked-text)
8405 (next-single-property-change pos 'org-linked-text)))
8406 (throw 'match t))
8408 (save-excursion
8409 (when (or (org-in-regexp org-angle-link-re)
8410 (org-in-regexp org-plain-link-re))
8411 (setq type (match-string 1) path (match-string 2))
8412 (throw 'match t)))
8413 (save-excursion
8415 (setq type "tags"
8416 path (match-string 1))
8417 (while (string-match ":" path)
8418 (setq path (replace-match "+" t t path)))
8419 (throw 'match t)))
8421 (setq type "tree-match"
8422 path (match-string 1))
8423 (throw 'match t)))
8424 (unless path
8425 (error "No link found"))
8427 ;; switch back to reference buffer
8428 ;; needed when if called in a temporary buffer through
8429 ;; org-open-link-from-string
8430 (with-current-buffer (or reference-buffer (current-buffer))
8432 ;; Remove any trailing spaces in path
8434 (setq path (replace-match "" t t path)))
8435 (if (and org-link-translation-function
8436 (fboundp org-link-translation-function))
8437 ;; Check if we need to translate the link
8438 (let ((tmp (funcall org-link-translation-function type path)))
8439 (setq type (car tmp) path (cdr tmp))))
8441 (cond
8443 ((assoc type org-link-protocols)
8444 (funcall (nth 1 (assoc type org-link-protocols)) path))
8446 ((equal type "mailto")
8447 (let ((cmd (car org-link-mailto-program))
8448 (args (cdr org-link-mailto-program)) args1
8449 (address path) (subject "") a)
8451 (setq address (match-string 1 path)
8452 subject (org-link-escape (match-string 2 path))))
8453 (while args
8454 (cond
8455 ((not (stringp (car args))) (push (pop args) args1))
8456 (t (setq a (pop args))
8457 (if (string-match "%a" a)
8458 (setq a (replace-match address t t a)))
8459 (if (string-match "%s" a)
8460 (setq a (replace-match subject t t a)))
8461 (push a args1))))
8462 (apply cmd (nreverse args1))))
8464 ((member type '("http" "https" "ftp" "news"))
8465 (browse-url (concat type ":" (org-link-escape
8466 path org-link-escape-chars-browser))))
8468 ((member type '("message"))
8469 (browse-url (concat type ":" path)))
8471 ((string= type "tags")
8472 (org-tags-view in-emacs path))
8474 ((string= type "tree-match")
8477 ((string= type "file")
8479 (setq line (string-to-number (match-string 1 path))
8480 path (substring path 0 (match-beginning 0)))
8482 (setq search (match-string 1 path)
8483 path (substring path 0 (match-beginning 0)))))
8484 (if (string-match "[*?{]" (file-name-nondirectory path))
8485 (dired path)
8486 (org-open-file path in-emacs line search)))
8488 ((string= type "news")
8489 (require 'org-gnus)
8490 (org-gnus-follow-link path))
8492 ((string= type "shell")
8493 (let ((cmd path))
8494 (if (or (not org-confirm-shell-link-function)
8495 (funcall org-confirm-shell-link-function
8497 (org-add-props cmd nil
8498 'face 'org-warning))))
8499 (progn
8500 (message "Executing %s" cmd)
8501 (shell-command cmd))
8502 (error "Abort"))))
8504 ((string= type "elisp")
8505 (let ((cmd path))
8506 (if (or (not org-confirm-elisp-link-function)
8507 (funcall org-confirm-elisp-link-function
8509 (org-add-props cmd nil
8510 'face 'org-warning))))
8511 (message "%s => %s" cmd
8512 (if (equal (string-to-char cmd) ?\()
8513 (eval (read cmd))
8514 (call-interactively (read cmd))))
8515 (error "Abort"))))
8517 ((and (string= type "thisfile")
8518 (run-hook-with-args-until-success
8519 'org-open-link-functions path)))
8521 ((string= type "thisfile")
8522 (if in-emacs
8523 (switch-to-buffer-other-window
8524 (org-get-buffer-for-internal-link (current-buffer)))
8525 (org-mark-ring-push))
8526 (let ((cmd `(org-link-search
8527 ,path
8528 ,(cond ((equal in-emacs '(4)) 'occur)
8529 ((equal in-emacs '(16)) 'org-occur)
8530 (t nil))
8531 ,pos)))
8532 (condition-case nil (eval cmd)
8533 (error (progn (widen) (eval cmd))))))
8535 (t
8536 (browse-url-at-point)))))))
8537 (move-marker org-open-link-marker nil)
8538 (run-hook-with-args 'org-follow-link-hook))
8540 (defun org-offer-links-in-entry (&optional nth zero)
8541 "Offer links in the current entry and follow the selected link.
8542 If there is only one link, follow it immediately as well.
8543 If NTH is an integer, immediately pick the NTH link found.
8544 If ZERO is a string, check also this string for a link, and if
8545 there is one, offer it as link number zero."
8549 (cnt ?0)
8550 (in-emacs (if (integerp nth) nil nth))
8551 have-zero end links link c)
8552 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
8553 (push (match-string 0 zero) links)
8554 (setq cnt (1- cnt) have-zero t))
8555 (save-excursion
8556 (org-back-to-heading t)
8557 (setq end (save-excursion (outline-next-heading) (point)))
8558 (while (re-search-forward re end t)
8559 (push (match-string 0) links))
8560 (setq links (org-uniquify (reverse links))))
8562 (cond
8563 ((null links)
8564 (message "No links"))
8565 ((equal (length links) 1)
8566 (setq link (car links)))
8567 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
8568 (setq link (nth (if have-zero nth (1- nth)) links)))
8569 (t ; we have to select a link
8570 (save-excursion
8571 (save-window-excursion
8572 (delete-other-windows)
8573 (with-output-to-temp-buffer "*Select Link*"
8574 (mapc (lambda (l)
8575 (if (not (string-match org-bracket-link-regexp l))
8577 (org-remove-angle-brackets l)))
8578 (if (match-end 3)
8580 (match-string 3 l) (match-string 1 l)))
8582 (match-string 1 l))))))
8583 links))
8584 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
8585 (message "Select link to open:")
8586 (setq c (read-char-exclusive))
8587 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
8588 (when (equal c ?q) (error "Abort"))
8589 (setq nth (- c ?0))
8590 (if have-zero (setq nth (1+ nth)))
8591 (unless (and (integerp nth) (>= (length links) nth))
8592 (error "Invalid link selection"))
8593 (setq link (nth (1- nth) links))))
8594 (if link
8595 (progn (org-open-link-from-string link in-emacs (current-buffer)) t)
8596 nil)))
8598 ;;;; Time estimates
8600 (defun org-get-effort (&optional pom)
8601 "Get the effort estimate for the current entry."
8602 (org-entry-get pom org-effort-property))
8604 ;;; File search
8606 (defvar org-create-file-search-functions nil
8607 "List of functions to construct the right search string for a file link.
8608 These functions are called in turn with point at the location to
8609 which the link should point.
8611 A function in the hook should first test if it would like to
8612 handle this file type, for example by checking the major-mode or
8613 the file extension. If it decides not to handle this file, it
8614 should just return nil to give other functions a chance. If it
8615 does handle the file, it must return the search string to be used
8616 when following the link. The search string will be part of the
8617 file link, given after a double colon, and `org-open-at-point'
8618 will automatically search for it. If special measures must be
8619 taken to make the search successful, another function should be
8620 added to the companion hook `org-execute-file-search-functions',
8621 which see.
8623 A function in this hook may also use `setq' to set the variable
8624 `description' to provide a suggestion for the descriptive text to
8625 be used for this link when it gets inserted into an Org-mode
8628 (defvar org-execute-file-search-functions nil
8629 "List of functions to execute a file search triggered by a link.
8631 Functions added to this hook must accept a single argument, the
8632 search string that was part of the file link, the part after the
8633 double colon. The function must first check if it would like to
8634 handle this search, for example by checking the major-mode or the
8635 file extension. If it decides not to handle this search, it
8636 should just return nil to give other functions a chance. If it
8637 does handle the search, it must return a non-nil value to keep
8638 other functions from trying.
8640 Each function can access the current prefix argument through the
8641 variable `current-prefix-argument'. Note that a single prefix is
8642 used to force opening a link in Emacs, so it may be good to only
8643 use a numeric or double prefix to guide the search function.
8645 In case this is needed, a function in this hook can also restore
8646 the window configuration before `org-open-at-point' was called using:
8648 (set-window-configuration org-window-config-before-follow-link)")
8650 (defun org-link-search (s &optional type avoid-pos)
8651 "Search for a link search option.
8652 If S is surrounded by forward slashes, it is interpreted as a
8653 regular expression. In org-mode files, this will create an `org-occur'
8654 sparse tree. In ordinary files, `occur' will be used to list matches.
8655 If the current buffer is in `dired-mode', grep will be used to search
8656 in all files. If AVOID-POS is given, ignore matches near that position."
8657 (let ((case-fold-search t)
8661 org-emphasis-alist)
8663 (pos (point))
8664 (pre nil) (post nil)
8665 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
8666 (cond
8667 ;; First check if there are any special
8668 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
8669 ;; Now try the builtin stuff
8670 ((and (equal (string-to-char s0) ?#)
8671 (> (length s0) 1)
8672 (save-excursion
8673 (goto-char (point-min))
8674 (and
8675 (re-search-forward
8677 (setq type 'dedicated
8678 pos (match-beginning 0))))
8679 ;; There is an exact target for this
8680 (goto-char pos)
8681 (org-back-to-heading t)))
8682 ((save-excursion
8683 (goto-char (point-min))
8684 (and
8685 (re-search-forward
8686 (concat "<<" (regexp-quote s0) ">>") nil t)
8687 (setq type 'dedicated
8688 pos (match-beginning 0))))
8689 ;; There is an exact target for this
8690 (goto-char pos))
8692 (save-excursion
8693 (goto-char (point-min))
8694 (and
8695 (re-search-forward
8696 (concat "[^[]" (regexp-quote
8697 (format org-coderef-label-format
8698 (match-string 1 s0))))
8699 nil t)
8700 (setq type 'dedicated
8701 pos (1+ (match-beginning 0))))))
8702 ;; There is a coderef target for this
8703 (goto-char pos))
8705 ;; A regular expression
8706 (cond
8707 ((org-mode-p)
8708 (org-occur (match-string 1 s)))
8709 ;;((eq major-mode 'dired-mode)
8710 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
8711 (t (org-do-occur (match-string 1 s)))))
8712 (t
8713 ;; A normal search strings
8714 (when (equal (string-to-char s) ?*)
8715 ;; Anchor on headlines, post may include tags.
8718 s (substring s 1)))
8719 (remove-text-properties
8720 0 (length s)
8721 '(face nil mouse-face nil keymap nil fontified nil) s)
8722 ;; Make a series of regular expressions to find a match
8731 re4 (concat "[^a-zA-Z_]" re4_)
8733 re1 (concat pre re2 post)
8734 re3 (concat pre (if pre re4_ re4) post)
8735 re5 (concat pre ".*" re4)
8736 re2 (concat pre re2)
8737 re2a (concat pre (if pre re2a_ re2a))
8738 re4 (concat pre (if pre re4_ re4))
8742 ))
8743 (cond
8744 ((eq type 'org-occur) (org-occur reall))
8745 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
8746 (t (goto-char (point-min))
8747 (setq type 'fuzzy)
8748 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
8749 (org-search-not-self 1 re1 nil t)
8750 (org-search-not-self 1 re2 nil t)
8751 (org-search-not-self 1 re2a nil t)
8752 (org-search-not-self 1 re3 nil t)
8753 (org-search-not-self 1 re4 nil t)
8754 (org-search-not-self 1 re5 nil t)
8755 )
8756 (goto-char (match-beginning 1))
8757 (goto-char pos)
8758 (error "No match")))))
8759 (t
8760 ;; Normal string-search
8761 (goto-char (point-min))
8762 (if (search-forward s nil t)
8763 (goto-char (match-beginning 0))
8764 (error "No match"))))
8765 (and (org-mode-p) (org-show-context 'link-search))
8766 type))
8768 (defun org-search-not-self (group &rest args)
8769 "Execute `re-search-forward', but only accept matches that do not
8770 enclose the position of `org-open-link-marker'."
8771 (let ((m org-open-link-marker))
8772 (catch 'exit
8773 (while (apply 're-search-forward args)
8774 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
8775 (goto-char (match-end group))
8776 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
8777 (> (match-beginning 0) (marker-position m))
8778 (< (match-end 0) (marker-position m)))
8779 (save-match-data
8780 (or (not (org-in-regexp
8781 org-bracket-link-analytic-regexp 1))
8782 (not (match-end 4)) ; no description
8783 (and (<= (match-beginning 4) (point))
8784 (>= (match-end 4) (point))))))
8785 (throw 'exit (point))))))))
8787 (defun org-get-buffer-for-internal-link (buffer)
8788 "Return a buffer to be used for displaying the link target of internal links."
8789 (cond
8790 ((not org-display-internal-link-with-indirect-buffer)
8791 buffer)
8792 ((string-match "(Clone)$" (buffer-name buffer))
8793 (message "Buffer is already a clone, not making another one")
8794 ;; we also do not modify visibility in this case
8795 buffer)
8796 (t ; make a new indirect buffer for displaying the link
8797 (let* ((bn (buffer-name buffer))
8798 (ibn (concat bn "(Clone)"))
8799 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
8800 (with-current-buffer ib (org-overview))
8801 ib))))
8803 (defun org-do-occur (regexp &optional cleanup)
8804 "Call the Emacs command `occur'.
8805 If CLEANUP is non-nil, remove the printout of the regular expression
8806 in the *Occur* buffer. This is useful if the regex is long and not useful
8807 to read."
8808 (occur regexp)
8809 (when cleanup
8810 (let ((cwin (selected-window)) win beg end)
8811 (when (setq win (get-buffer-window "*Occur*"))
8812 (select-window win))
8813 (goto-char (point-min))
8814 (when (re-search-forward "match[a-z]+" nil t)
8815 (setq beg (match-end 0))
8817 (setq end (1- (match-beginning 0)))))
8818 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
8819 (goto-char (point-min))
8820 (select-window cwin))))
8822 ;;; The mark ring for links jumps
8824 (defvar org-mark-ring nil
8825 "Mark ring for positions before jumps in Org-mode.")
8826 (defvar org-mark-ring-last-goto nil
8827 "Last position in the mark ring used to go back.")
8828 ;; Fill and close the ring
8829 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
8830 (loop for i from 1 to org-mark-ring-length do
8831 (push (make-marker) org-mark-ring))
8832 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
8833 org-mark-ring)
8835 (defun org-mark-ring-push (&optional pos buffer)
8836 "Put the current position or POS into the mark ring and rotate it."
8837 (interactive)
8838 (setq pos (or pos (point)))
8839 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
8840 (move-marker (car org-mark-ring)
8841 (or pos (point))
8842 (or buffer (current-buffer)))
8843 (message "%s"
8844 (substitute-command-keys
8847 (defun org-mark-ring-goto (&optional n)
8848 "Jump to the previous position in the mark ring.
8849 With prefix arg N, jump back that many stored positions. When
8850 called several times in succession, walk through the entire ring.
8851 Org-mode commands jumping to a different position in the current file,
8852 or to another Org-mode file, automatically push the old position
8853 onto the ring."
8854 (interactive "p")
8855 (let (p m)
8856 (if (eq last-command this-command)
8857 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
8858 (setq p org-mark-ring))
8859 (setq org-mark-ring-last-goto p)
8860 (setq m (car p))
8861 (switch-to-buffer (marker-buffer m))
8862 (goto-char m)
8863 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
8865 (defun org-remove-angle-brackets (s)
8866 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
8867 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
8868 s)
8869 (defun org-add-angle-brackets (s)
8870 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
8871 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
8872 s)
8873 (defun org-remove-double-quotes (s)
8876 s)
8878 ;;; Following specific links
8880 (defun org-follow-timestamp-link ()
8881 (cond
8882 ((org-at-date-range-p t)
8883 (let ((org-agenda-start-on-weekday)
8884 (t1 (match-string 1))
8885 (t2 (match-string 2)))
8886 (setq t1 (time-to-days (org-time-string-to-time t1))
8887 t2 (time-to-days (org-time-string-to-time t2)))
8888 (org-agenda-list nil t1 (1+ (- t2 t1)))))
8889 ((org-at-timestamp-p t)
8890 (org-agenda-list nil (time-to-days (org-time-string-to-time
8891 (substring (match-string 1) 0 10)))
8892 1))
8893 (t (error "This should not happen"))))
8896 ;;; Following file links
8897 (defvar org-wait nil)
8898 (defun org-open-file (path &optional in-emacs line search)
8899 "Open the file at PATH.
8900 First, this expands any special file name abbreviations. Then the
8901 configuration variable `org-file-apps' is checked if it contains an
8902 entry for this file type, and if yes, the corresponding command is launched.
8904 If no application is found, Emacs simply visits the file.
8906 With optional prefix argument IN-EMACS, Emacs will visit the file.
8907 With a double C-c C-u prefix arg, Org tries to avoid opening in Emacs
8908 and o use an external application to visit the file.
8910 Optional LINE specifies a line to go to, optional SEARCH a string to
8911 search for. If LINE or SEARCH is given, the file will always be
8912 opened in Emacs.
8913 If the file does not exist, an error is thrown."
8914 (setq in-emacs (or in-emacs line search))
8915 (let* ((file (if (equal path "")
8916 buffer-file-name
8917 (substitute-in-file-name (expand-file-name path))))
8918 (apps (append org-file-apps (org-default-apps)))
8919 (remp (and (assq 'remote apps) (org-file-remote-p file)))
8920 (dirp (if remp nil (file-directory-p file)))
8921 (file (if (and dirp org-open-directory-means-index-dot-org)
8922 (concat (file-name-as-directory file) "index.org")
8923 file))
8924 (a-m-a-p (assq 'auto-mode apps))
8925 (dfile (downcase file))
8926 (old-buffer (current-buffer))
8927 (old-pos (point))
8928 (old-mode major-mode)
8929 ext cmd)
8931 (setq ext (match-string 1 dfile))
8933 (setq ext (match-string 1 dfile))))
8934 (cond
8935 ((equal in-emacs '(16))
8936 (setq cmd (cdr (assoc 'system apps))))
8937 (in-emacs (setq cmd 'emacs))
8938 (t
8939 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
8940 (and dirp (cdr (assoc 'directory apps)))
8941 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
8942 'string-match)
8943 (cdr (assoc ext apps))
8944 (cdr (assoc t apps))))))
8945 (when (eq cmd 'system)
8946 (setq cmd (cdr (assoc 'system apps))))
8947 (when (eq cmd 'default)
8948 (setq cmd (cdr (assoc t apps))))
8949 (when (eq cmd 'mailcap)
8950 (require 'mailcap)
8951 (mailcap-parse-mailcaps)
8952 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
8953 (command (mailcap-mime-info mime-type)))
8954 (if (stringp command)
8955 (setq cmd command)
8956 (setq cmd 'emacs))))
8957 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
8958 (not (file-exists-p file))
8959 (not org-open-non-existing-files))
8960 (error "No such file: %s" file))
8961 (cond
8963 ;; Remove quotes around the file name - we'll use shell-quote-argument.
8965 (setq cmd (replace-match "%s" t t cmd)))
8966 (while (string-match "%s" cmd)
8967 (setq cmd (replace-match
8968 (save-match-data
8969 (shell-quote-argument
8970 (convert-standard-filename file)))
8971 t t cmd)))
8972 (save-window-excursion
8973 (start-process-shell-command cmd nil cmd)
8974 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
8975 ))
8976 ((or (stringp cmd)
8977 (eq cmd 'emacs))
8978 (funcall (cdr (assq 'file org-link-frame-setup)) file)
8979 (widen)
8980 (if line (org-goto-line line)
8981 (if search (org-link-search search))))
8982 ((consp cmd)
8983 (let ((file (convert-standard-filename file)))
8984 (eval cmd)))
8985 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
8986 (and (org-mode-p) (eq old-mode 'org-mode)
8987 (or (not (equal old-buffer (current-buffer)))
8988 (not (equal old-pos (point))))
8989 (org-mark-ring-push old-pos old-buffer))))
8991 (defun org-default-apps ()
8992 "Return the default applications for this operating system."
8993 (cond
8994 ((eq system-type 'darwin)
8995 org-file-apps-defaults-macosx)
8996 ((eq system-type 'windows-nt)
8997 org-file-apps-defaults-windowsnt)
8998 (t org-file-apps-defaults-gnu)))
9000 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9001 "Convert extensions to regular expressions in the cars of LIST.
9002 Also, weed out any non-string entries, because the return value is used
9003 only for regexp matching.
9004 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9005 point to the symbol `emacs', indicating that the file should
9006 be opened in Emacs."
9007 (append
9008 (delq nil
9009 (mapcar (lambda (x)
9010 (if (not (stringp (car x)))
9011 nil
9013 x
9015 list))
9016 (if add-auto-mode
9017 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9019 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9020 (defun org-file-remote-p (file)
9021 "Test whether FILE specifies a location on a remote system.
9022 Return non-nil if the location is indeed remote.
9026 (cond ((fboundp 'file-remote-p)
9027 (file-remote-p file))
9028 ((fboundp 'tramp-handle-file-remote-p)
9029 (tramp-handle-file-remote-p file))
9030 ((and (boundp 'ange-ftp-name-format)
9031 (string-match (car ange-ftp-name-format) file))
9032 t)
9033 (t nil)))
9036 ;;;; Refiling
9038 (defun org-get-org-file ()
9039 "Read a filename, with default directory `org-directory'."
9040 (let ((default (or org-default-notes-file remember-data-file)))
9041 (read-file-name (format "File name [%s]: " default)
9042 (file-name-as-directory org-directory)
9043 default)))
9045 (defun org-notes-order-reversed-p ()
9046 "Check if the current file should receive notes in reversed order."
9047 (cond
9048 ((not org-reverse-note-order) nil)
9049 ((eq t org-reverse-note-order) t)
9050 ((not (listp org-reverse-note-order)) nil)
9051 (t (catch 'exit
9052 (let ((all org-reverse-note-order)
9053 entry)
9054 (while (setq entry (pop all))
9055 (if (string-match (car entry) buffer-file-name)
9056 (throw 'exit (cdr entry))))
9057 nil)))))
9059 (defvar org-refile-target-table nil
9060 "The list of refile targets, created by `org-refile'.")
9062 (defvar org-agenda-new-buffers nil
9063 "Buffers created to visit agenda files.")
9065 (defun org-get-refile-targets (&optional default-buffer)
9066 "Produce a table with refile targets."
9067 (let ((case-fold-search nil)
9068 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
9069 (entries (or org-refile-targets '((nil . (:level . 1)))))
9070 targets txt re files f desc descre fast-path-p level pos0)
9071 (message "Getting targets...")
9072 (with-current-buffer (or default-buffer (current-buffer))
9073 (while (setq entry (pop entries))
9074 (setq files (car entry) desc (cdr entry))
9075 (setq fast-path-p nil)
9076 (cond
9077 ((null files) (setq files (list (current-buffer))))
9078 ((eq files 'org-agenda-files)
9079 (setq files (org-agenda-files 'unrestricted)))
9080 ((and (symbolp files) (fboundp files))
9081 (setq files (funcall files)))
9082 ((and (symbolp files) (boundp files))
9083 (setq files (symbol-value files))))
9084 (if (stringp files) (setq files (list files)))
9085 (cond
9086 ((eq (car desc) :tag)
9088 ((eq (car desc) :todo)
9090 ((eq (car desc) :regexp)
9091 (setq descre (cdr desc)))
9092 ((eq (car desc) :level)
9094 (if org-odd-levels-only
9095 (1- (* 2 (cdr desc)))
9096 (cdr desc)))
9098 ((eq (car desc) :maxlevel)
9099 (setq fast-path-p t)
9101 (if org-odd-levels-only
9102 (1- (* 2 (cdr desc)))
9103 (cdr desc)))
9105 (t (error "Bad refiling target description %s" desc)))
9106 (while (setq f (pop files))
9107 (with-current-buffer
9108 (if (bufferp f) f (org-get-agenda-file-buffer f))
9109 (if (bufferp f) (setq f (buffer-file-name (buffer-base-buffer f))))
9110 (setq f (and f (expand-file-name f)))
9111 (if (eq org-refile-use-outline-path 'file)
9112 (push (list (file-name-nondirectory f) f nil nil) targets))
9113 (save-excursion
9114 (save-restriction
9115 (widen)
9116 (goto-char (point-min))
9117 (while (re-search-forward descre nil t)
9118 (goto-char (setq pos0 (point-at-bol)))
9119 (catch 'next
9120 (when org-refile-target-verify-function
9121 (save-match-data
9122 (or (funcall org-refile-target-verify-function)
9123 (throw 'next t))))
9124 (when (looking-at org-complex-heading-regexp)
9125 (setq level (org-reduced-level (- (match-end 1) (match-beginning 1)))
9126 txt (org-link-display-format (match-string 4))
9127 re (concat "^" (regexp-quote
9128 (buffer-substring (match-beginning 1)
9129 (match-end 4)))))
9131 (regexp-quote
9132 (match-string 5)))))
9134 (when org-refile-use-outline-path
9135 (setq txt (mapconcat 'org-protect-slash
9136 (append
9137 (if (eq org-refile-use-outline-path 'file)
9138 (list (file-name-nondirectory
9139 (buffer-file-name (buffer-base-buffer))))
9140 (if (eq org-refile-use-outline-path 'full-file-path)
9141 (list (buffer-file-name (buffer-base-buffer)))))
9142 (org-get-outline-path fast-path-p level txt)
9143 (list txt))
9144 "/")))
9145 (push (list txt f re (point)) targets)))
9146 (when (= (point) pos0)
9147 ;; verification function has not moved point
9148 (goto-char (point-at-eol))))))))))
9149 (message "Getting targets...done")
9150 (nreverse targets)))
9152 (defun org-protect-slash (s)
9153 (while (string-match "/" s)
9155 s)
9157 (defvar org-olpa (make-vector 20 nil))
9159 (defun org-get-outline-path (&optional fastp level heading)
9160 "Return the outline path to the current entry, as a list.
9161 The parameters FASTP, LEVEL, and HEADING are for use be a scanner
9162 routine which makes outline path derivations for an entire file,
9163 avoiding backtracing."
9164 (if fastp
9165 (progn
9166 (if (> level 19)
9167 (error "Outline path failure, more than 19 levels."))
9168 (loop for i from level upto 19 do
9169 (aset org-olpa i nil))
9170 (prog1
9171 (delq nil (append org-olpa nil))
9172 (aset org-olpa level heading)))
9173 (let (rtn case-fold-search)
9174 (save-excursion
9175 (save-restriction
9176 (widen)
9177 (while (org-up-heading-safe)
9178 (when (looking-at org-complex-heading-regexp)
9179 (push (org-match-string-no-properties 4) rtn)))
9180 rtn)))))
9182 (defun org-format-outline-path (path &optional width prefix)
9183 "Format the outlie path PATH for display.
9184 Width is the maximum number of characters that is available.
9185 Prefix is a prefix to be included in the returned string,
9186 such as the file name."
9187 (setq width (or width 79))
9188 (if prefix (setq width (- width (length prefix))))
9189 (if (not path)
9190 (or prefix "")
9191 (let* ((nsteps (length path))
9192 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
9193 (maxwidth (if (<= total-width width)
9194 10000 ;; everything fits
9195 ;; we need to shorten the level headings
9196 (/ (- width nsteps) nsteps)))
9197 (org-odd-levels-only nil)
9198 (n 0)
9199 (total (1+ (length prefix))))
9200 (setq maxwidth (max maxwidth 10))
9201 (concat prefix
9202 (mapconcat
9203 (lambda (h)
9204 (setq n (1+ n))
9205 (if (and (= n nsteps) (< maxwidth 10000))
9206 (setq maxwidth (- total-width total)))
9207 (if (< (length h) maxwidth)
9208 (progn (setq total (+ total (length h) 1)) h)
9209 (setq h (substring h 0 (- maxwidth 2))
9210 total (+ total maxwidth 1))
9212 (setq h (substring h 0 (match-beginning 0))))
9213 (setq h (concat h "..")))
9214 (org-add-props h nil 'face
9215 (nth (% (1- n) org-n-level-faces)
9216 org-level-faces))
9217 h)
9218 path "/")))))
9220 (defun org-display-outline-path (&optional file current)
9221 "Display the current outline path in the echo area."
9222 (interactive "P")
9223 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
9224 (case-fold-search nil)
9225 (path (and (org-mode-p) (org-get-outline-path))))
9226 (if current (setq path (append path
9227 (save-excursion
9228 (org-back-to-heading t)
9229 (if (looking-at org-complex-heading-regexp)
9230 (list (match-string 4)))))))
9231 (message "%s"
9232 (org-format-outline-path
9233 path
9234 (1- (frame-width))
9235 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
9237 (defvar org-refile-history nil
9238 "History for refiling operations.")
9240 (defvar org-after-refile-insert-hook nil
9241 "Hook run after `org-refile' has inserted its stuff at the new location.
9242 Note that this is still *before* the stuff will be removed from
9243 the *old* location.")
9245 (defun org-refile (&optional goto default-buffer rfloc)
9246 "Move the entry at point to another heading.
9247 The list of target headings is compiled using the information in
9248 `org-refile-targets', which see. This list is created before each use
9249 and will therefore always be up-to-date.
9251 At the target location, the entry is filed as a subitem of the target heading.
9252 Depending on `org-reverse-note-order', the new subitem will either be the
9253 first or the last subitem.
9255 If there is an active region, all entries in that region will be moved.
9256 However, the region must fulfil the requirement that the first heading
9257 is the first one sets the top-level of the moved text - at most siblings
9258 below it are allowed.
9260 With prefix arg GOTO, the command will only visit the target location,
9261 not actually move anything.
9262 With a double prefix `C-u C-u', go to the location where the last refiling
9263 operation has put the subtree.
9264 With a prefix argument of `2', refile to the running clock.
9266 RFLOC can be a refile location obtained in a different way.
9268 See also `org-refile-use-outline-path' and `org-completion-use-ido'"
9269 (interactive "P")
9270 (let* ((cbuf (current-buffer))
9271 (regionp (org-region-active-p))
9272 (region-start (and regionp (region-beginning)))
9273 (region-end (and regionp (region-end)))
9274 (region-length (and regionp (- region-end region-start)))
9275 (filename (buffer-file-name (buffer-base-buffer cbuf)))
9276 pos it nbuf file re level reversed)
9277 (setq last-command nil)
9278 (when regionp
9279 (goto-char region-start)
9280 (or (bolp) (goto-char (point-at-bol)))
9281 (setq region-start (point))
9282 (unless (org-kill-is-subtree-p
9283 (buffer-substring region-start region-end))
9284 (error "The region is not a (sequence of) subtree(s)")))
9285 (if (equal goto '(16))
9286 (org-refile-goto-last-stored)
9287 (when (or
9288 (and (equal goto 2)
9289 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
9290 (prog1
9291 (setq it (list (or org-clock-heading "running clock")
9292 (buffer-file-name
9293 (marker-buffer org-clock-hd-marker))
9294 ""
9295 (marker-position org-clock-hd-marker)))
9296 (setq goto nil)))
9297 (setq it (or rfloc
9298 (save-excursion
9299 (org-refile-get-location
9300 (if goto "Goto: " "Refile to: ") default-buffer
9301 org-refile-allow-creating-parent-nodes)))))
9302 (setq file (nth 1 it)
9303 re (nth 2 it)
9304 pos (nth 3 it))
9305 (if (and (not goto)
9306 pos
9307 (equal (buffer-file-name) file)
9308 (if regionp
9309 (and (>= pos region-start)
9310 (<= pos region-end))
9311 (and (>= pos (point))
9312 (< pos (save-excursion
9313 (org-end-of-subtree t t))))))
9314 (error "Cannot refile to position inside the tree or region"))
9316 (setq nbuf (or (find-buffer-visiting file)
9317 (find-file-noselect file)))
9318 (if goto
9319 (progn
9320 (switch-to-buffer nbuf)
9321 (goto-char pos)
9322 (org-show-context 'org-goto))
9323 (if regionp
9324 (progn
9325 (org-kill-new (buffer-substring region-start region-end))
9326 (org-save-markers-in-region region-start region-end))
9327 (org-copy-subtree 1 nil t))
9328 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
9329 (find-file-noselect file)))
9330 (setq reversed (org-notes-order-reversed-p))
9331 (save-excursion
9332 (save-restriction
9333 (widen)
9334 (if pos
9335 (progn
9336 (goto-char pos)
9337 (looking-at outline-regexp)
9338 (setq level (org-get-valid-level (funcall outline-level) 1))
9339 (goto-char
9340 (if reversed
9341 (or (outline-next-heading) (point-max))
9342 (or (save-excursion (org-get-next-sibling))
9343 (org-end-of-subtree t t)
9344 (point-max)))))
9345 (setq level 1)
9346 (if (not reversed)
9347 (goto-char (point-max))
9348 (goto-char (point-min))
9349 (or (outline-next-heading) (goto-char (point-max)))))
9350 (if (not (bolp)) (newline))
9351 (bookmark-set "org-refile-last-stored")
9352 (org-paste-subtree level)
9353 (if (fboundp 'deactivate-mark) (deactivate-mark))
9354 (run-hooks 'org-after-refile-insert-hook))))
9355 (if regionp
9356 (delete-region (point) (+ (point) region-length))
9357 (org-cut-subtree))
9358 (when (featurep 'org-inlinetask)
9359 (org-inlinetask-remove-END-maybe))
9360 (setq org-markers-to-move nil)
9362 (org-reveal))
9364 (defun org-refile-goto-last-stored ()
9365 "Go to the location where the last refile was stored."
9366 (interactive)
9367 (bookmark-jump "org-refile-last-stored")
9368 (message "This is the location of the last refile"))
9370 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
9371 "Prompt the user for a refile location, using PROMPT."
9372 (let ((org-refile-targets org-refile-targets)
9373 (org-refile-use-outline-path org-refile-use-outline-path))
9374 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
9375 (unless org-refile-target-table
9376 (error "No refile targets"))
9377 (let* ((cbuf (current-buffer))
9378 (partial-completion-mode nil)
9379 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
9380 (cfunc (if (and org-refile-use-outline-path
9381 org-outline-path-complete-in-steps)
9382 'org-olpath-completing-read
9383 'org-icompleting-read))
9384 (extra (if org-refile-use-outline-path "/" ""))
9385 (filename (and cfn (expand-file-name cfn)))
9386 (tbl (mapcar
9387 (lambda (x)
9388 (if (and (not (member org-refile-use-outline-path
9389 '(file full-file-path)))
9390 (not (equal filename (nth 1 x))))
9391 (cons (concat (car x) extra " ("
9392 (file-name-nondirectory (nth 1 x)) ")")
9393 (cdr x))
9394 (cons (concat (car x) extra) (cdr x))))
9395 org-refile-target-table))
9396 (completion-ignore-case t)
9397 pa answ parent-target child parent old-hist)
9398 (setq old-hist org-refile-history)
9399 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
9400 nil 'org-refile-history))
9401 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
9402 (if pa
9403 (progn
9404 (when (or (not org-refile-history)
9405 (not (eq old-hist org-refile-history))
9406 (not (equal (car pa) (car org-refile-history))))
9407 (setq org-refile-history
9408 (cons (car pa) (if (assoc (car org-refile-history) tbl)
9409 org-refile-history
9410 (cdr org-refile-history))))
9411 (if (equal (car org-refile-history) (nth 1 org-refile-history))
9412 (pop org-refile-history)))
9413 pa)
9415 (setq parent (match-string 1 answ)
9416 child (match-string 2 answ))
9417 (setq parent-target (or (assoc parent tbl) (assoc (concat parent "/") tbl)))
9418 (when (and parent-target
9419 (or (eq new-nodes t)
9420 (and (eq new-nodes 'confirm)
9422 (org-refile-new-child parent-target child))))))
9424 (defun org-refile-new-child (parent-target child)
9425 "Use refile target PARENT-TARGET to add new CHILD below it."
9426 (unless parent-target
9427 (error "Cannot find parent for new node"))
9428 (let ((file (nth 1 parent-target))
9429 (pos (nth 3 parent-target))
9430 level)
9431 (with-current-buffer (or (find-buffer-visiting file)
9432 (find-file-noselect file))
9433 (save-excursion
9434 (save-restriction
9435 (widen)
9436 (if pos
9437 (goto-char pos)
9438 (goto-char (point-max))
9439 (if (not (bolp)) (newline)))
9440 (when (looking-at outline-regexp)
9441 (setq level (funcall outline-level))
9442 (org-end-of-subtree t t))
9443 (org-back-over-empty-lines)
9445 (if pos (org-get-valid-level level 1) 1) ?*)
9447 (beginning-of-line 0)
9448 (list (concat (car parent-target) "/" child) file "" (point)))))))
9450 (defun org-olpath-completing-read (prompt collection &rest args)
9451 "Read an outline path like a file name."
9452 (let ((thetable collection)
9453 (org-completion-use-ido nil) ; does not work with ido.
9454 (org-completion-use-iswitchb nil)) ; or iswitchb
9455 (apply
9456 'org-icompleting-read prompt
9457 (lambda (string predicate &optional flag)
9458 (let (rtn r f (l (length string)))
9459 (cond
9460 ((eq flag nil)
9461 ;; try completion
9462 (try-completion string thetable))
9463 ((eq flag t)
9464 ;; all-completions
9465 (setq rtn (all-completions string thetable predicate))
9466 (mapcar
9467 (lambda (x)
9468 (setq r (substring x l))
9469 (if (string-match " ([^)]*)$" x)
9470 (setq f (match-string 0 x))
9471 (setq f ""))
9472 (if (string-match "/" r)
9473 (concat string (substring r 0 (match-end 0)) f)
9474 x))
9475 rtn))
9476 ((eq flag 'lambda)
9477 ;; exact match?
9478 (assoc string thetable)))
9479 ))
9480 args)))
9482 ;;;; Dynamic blocks
9484 (defun org-find-dblock (name)
9485 "Find the first dynamic block with name NAME in the buffer.
9486 If not found, stay at current position and return nil."
9487 (let (pos)
9488 (save-excursion
9489 (goto-char (point-min))
9491 nil t)
9492 (match-beginning 0))))
9493 (if pos (goto-char pos))
9494 pos))
9496 (defconst org-dblock-start-re
9498 "Matches the start line of a dynamic block, with parameters.")
9501 "Matches the end of a dynamic block.")
9503 (defun org-create-dblock (plist)
9504 "Create a dynamic block section, with parameters taken from PLIST.
9505 PLIST must contain a :name entry which is used as name of the block."
9507 (end-of-line 1)
9508 (newline))
9509 (let ((col (current-column))
9510 (name (plist-get plist :name)))
9511 (insert "#+BEGIN: " name)
9512 (while plist
9513 (if (eq (car plist) :name)
9514 (setq plist (cddr plist))
9515 (insert " " (prin1-to-string (pop plist)))))
9517 (beginning-of-line -2)))
9519 (defun org-prepare-dblock ()
9520 "Prepare dynamic block for refresh.
9521 This empties the block, puts the cursor at the insert position and returns
9522 the property list including an extra property :name with the block name."
9523 (unless (looking-at org-dblock-start-re)
9524 (error "Not at a dynamic block"))
9525 (let* ((begdel (1+ (match-end 0)))
9526 (name (org-no-properties (match-string 1)))
9527 (params (append (list :name name)
9528 (read (concat "(" (match-string 3) ")")))))
9529 (save-excursion
9530 (beginning-of-line 1)
9532 (setq params (plist-put params :indentation-column (current-column))))
9533 (unless (re-search-forward org-dblock-end-re nil t)
9534 (error "Dynamic block not terminated"))
9535 (setq params
9536 (append params
9537 (list :content (buffer-substring
9538 begdel (match-beginning 0)))))
9539 (delete-region begdel (match-beginning 0))
9540 (goto-char begdel)
9541 (open-line 1)
9542 params))
9544 (defun org-map-dblocks (&optional command)
9545 "Apply COMMAND to all dynamic blocks in the current buffer.
9546 If COMMAND is not given, use `org-update-dblock'."
9547 (let ((cmd (or command 'org-update-dblock))
9548 pos)
9549 (save-excursion
9550 (goto-char (point-min))
9551 (while (re-search-forward org-dblock-start-re nil t)
9552 (goto-char (setq pos (match-beginning 0)))
9553 (condition-case nil
9554 (funcall cmd)
9555 (error (message "Error during update of dynamic block")))
9556 (goto-char pos)
9557 (unless (re-search-forward org-dblock-end-re nil t)
9558 (error "Dynamic block not terminated"))))))
9560 (defun org-dblock-update (&optional arg)
9561 "User command for updating dynamic blocks.
9562 Update the dynamic block at point. With prefix ARG, update all dynamic
9563 blocks in the buffer."
9564 (interactive "P")
9565 (if arg
9566 (org-update-all-dblocks)
9567 (or (looking-at org-dblock-start-re)
9568 (org-beginning-of-dblock))
9569 (org-update-dblock)))
9571 (defun org-update-dblock ()
9572 "Update the dynamic block at point
9573 This means to empty the block, parse for parameters and then call
9574 the correct writing function."
9575 (save-window-excursion
9576 (let* ((pos (point))
9577 (line (org-current-line))
9578 (params (org-prepare-dblock))
9579 (name (plist-get params :name))
9580 (indent (plist-get params :indentation-column))
9581 (cmd (intern (concat "org-dblock-write:" name))))
9582 (message "Updating dynamic block `%s' at line %d..." name line)
9583 (funcall cmd params)
9584 (message "Updating dynamic block `%s' at line %d...done" name line)
9585 (goto-char pos)
9586 (when (and indent (> indent 0))
9587 (setq indent (make-string indent ?\ ))
9588 (save-excursion
9589 (org-beginning-of-dblock)
9590 (forward-line 1)
9591 (while (not (looking-at org-dblock-end-re))
9592 (insert indent)
9593 (beginning-of-line 2))
9594 (when (looking-at org-dblock-end-re)
9596 (replace-match ""))
9597 (insert indent)))))))
9599 (defun org-beginning-of-dblock ()
9600 "Find the beginning of the dynamic block at point.
9601 Error if there is no such block at point."
9602 (let ((pos (point))
9603 beg)
9604 (end-of-line 1)
9605 (if (and (re-search-backward org-dblock-start-re nil t)
9606 (setq beg (match-beginning 0))
9607 (re-search-forward org-dblock-end-re nil t)
9608 (> (match-end 0) pos))
9609 (goto-char beg)
9610 (goto-char pos)
9611 (error "Not in a dynamic block"))))
9613 (defun org-update-all-dblocks ()
9614 "Update all dynamic blocks in the buffer.
9615 This function can be used in a hook."
9616 (when (org-mode-p)
9617 (org-map-dblocks 'org-update-dblock)))
9620 ;;;; Completion
9622 (defconst org-additional-option-like-keywords
9623 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML"
9624 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook"
9625 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
9626 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX"
9627 "BEGIN:" "END:"
9628 "ORGTBL" "TBLFM:" "TBLNAME:"
9629 "BEGIN_EXAMPLE" "END_EXAMPLE"
9630 "BEGIN_QUOTE" "END_QUOTE"
9631 "BEGIN_VERSE" "END_VERSE"
9632 "BEGIN_CENTER" "END_CENTER"
9633 "BEGIN_SRC" "END_SRC"
9634 "CATEGORY" "COLUMNS"
9635 "CAPTION" "LABEL"
9636 "SETUPFILE"
9637 "BIND"
9638 "MACRO"))
9640 (defcustom org-structure-template-alist
9641 '(
9654 ("L" "#+latex: "
9658 ("H" "#+html: "
9661 ("A" "#+ascii: ")
9662 ("i" "#+include %file ?"
9664 )
9665 "Structure completion elements.
9666 This is a list of abbreviation keys and values. The value gets inserted
9667 it you type @samp{.} followed by the key and then the completion key,
9668 usually `M-TAB'. %file will be replaced by a file name after prompting
9669 for the file using completion.
9670 There are two templates for each key, the first uses the original Org syntax,
9671 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
9672 the default when the /org-mtags.el/ module has been loaded. See also the
9673 variable `org-mtags-prefer-muse-templates'.
9674 This is an experimental feature, it is undecided if it is going to stay in."
9675 :group 'org-completion
9676 :type '(repeat
9677 (string :tag "Key")
9678 (string :tag "Template")
9679 (string :tag "Muse Template")))
9681 (defun org-try-structure-completion ()
9682 "Try to complete a structure template before point.
9684 expands them."
9685 (let ((l (buffer-substring (point-at-bol) (point)))
9686 a)
9689 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
9690 (org-complete-expand-structure-template (+ -1 (point-at-bol)
9691 (match-beginning 1)) a)
9692 t)))
9694 (defun org-complete-expand-structure-template (start cell)
9695 "Expand a structure template."
9696 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
9697 (rpl (nth (if musep 2 1) cell))
9698 (ind ""))
9699 (delete-region start (point))
9701 (cond
9702 ((bolp))
9704 (setq ind (buffer-substring (point-at-bol) (point))))
9705 (t (newline))))
9706 (setq start (point))
9707 (if (string-match "%file" rpl)
9708 (setq rpl (replace-match
9709 (concat
9711 (save-match-data
9712 (abbreviate-file-name (read-file-name "Include file: ")))
9714 t t rpl)))
9717 (insert rpl)
9721 (defun org-complete (&optional arg)
9722 "Perform completion on word at point.
9723 At the beginning of a headline, this completes TODO keywords as given in
9724 `org-todo-keywords'.
9725 If the current word is preceded by a backslash, completes the TeX symbols
9726 that are supported for HTML support.
9728 setting file options.
9730 At all other locations, this simply calls the value of
9731 `org-completion-fallback-command'."
9732 (interactive "P")
9733 (org-without-partial-completion
9734 (catch 'exit
9735 (let* ((a nil)
9736 (end (point))
9737 (beg1 (save-excursion
9738 (skip-chars-backward (org-re "[:alnum:]_@"))
9739 (point)))
9740 (beg (save-excursion
9741 (skip-chars-backward "a-zA-Z0-9_:$")
9742 (point)))
9743 (confirm (lambda (x) (stringp (car x))))
9744 (searchhead (equal (char-before beg) ?*))
9745 (struct
9746 (when (and (member (char-before beg1) '(?. ?<))
9747 (setq a (assoc (buffer-substring beg1 (point))
9748 org-structure-template-alist)))
9749 (org-complete-expand-structure-template (1- beg1) a)
9750 (throw 'exit t)))
9751 (tag (and (equal (char-before beg1) ?:)
9752 (equal (char-after (point-at-bol)) ?*)))
9753 (prop (and (equal (char-before beg1) ?:)
9754 (not (equal (char-after (point-at-bol)) ?*))))
9756 (link (equal (char-before beg) ?\[))
9757 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
9758 beg)
9759 "#+"))
9761 (buffer-substring (point-at-bol) (point))))
9762 (completion-ignore-case opt)
9763 (type nil)
9764 (tbl nil)
9765 (table (cond
9766 (opt
9767 (setq type :opt)
9768 (require 'org-exp)
9769 (append
9770 (delq nil
9771 (mapcar
9772 (lambda (x)
9773 (if (string-match
9775 (cons (match-string 2 x)
9776 (match-string 1 x))))
9778 (mapcar 'list org-additional-option-like-keywords)))
9779 (startup
9780 (setq type :startup)
9781 org-startup-options)
9782 (link (append org-link-abbrev-alist-local
9783 org-link-abbrev-alist))
9784 (texp
9785 (setq type :tex)
9786 org-html-entities)
9788 (buffer-substring (point-at-bol) beg))
9789 (setq type :todo)
9790 (mapcar 'list org-todo-keywords-1))
9791 (searchhead
9792 (setq type :searchhead)
9793 (save-excursion
9794 (goto-char (point-min))
9795 (while (re-search-forward org-todo-line-regexp nil t)
9796 (push (list
9797 (org-make-org-heading-search-string
9798 (match-string 3) t))
9799 tbl)))
9800 tbl)
9801 (tag (setq type :tag beg beg1)
9802 (or org-tag-alist (org-get-buffer-tags)))
9803 (prop (setq type :prop beg beg1)
9804 (mapcar 'list (org-buffer-property-keys nil t t)))
9805 (t (progn
9806 (call-interactively org-completion-fallback-command)
9807 (throw 'exit nil)))))
9808 (pattern (buffer-substring-no-properties beg end))
9809 (completion (try-completion pattern table confirm)))
9810 (cond ((eq completion t)
9811 (if (not (assoc (upcase pattern) table))
9812 (message "Already complete")
9813 (if (and (equal type :opt)
9814 (not (member (car (assoc (upcase pattern) table))
9815 org-additional-option-like-keywords)))
9816 (insert (substring (cdr (assoc (upcase pattern) table))
9817 (length pattern)))
9818 (if (memq type '(:tag :prop)) (insert ":")))))
9819 ((null completion)
9821 (ding))
9822 ((not (string= pattern completion))
9823 (delete-region beg end)
9824 (if (string-match " +$" completion)
9825 (setq completion (replace-match "" t t completion)))
9826 (insert completion)
9827 (if (get-buffer-window "*Completions*")
9828 (delete-window (get-buffer-window "*Completions*")))
9829 (if (assoc completion table)
9830 (if (eq type :todo) (insert " ")
9831 (if (memq type '(:tag :prop)) (insert ":"))))
9832 (if (and (equal type :opt) (assoc completion table))
9833 (message "%s" (substitute-command-keys
9835 (t
9836 (message "Making completion list...")
9837 (let ((list (sort (all-completions pattern table confirm)
9838 'string<)))
9839 (with-output-to-temp-buffer "*Completions*"
9840 (condition-case nil
9841 ;; Protection needed for XEmacs and emacs 21
9842 (display-completion-list list pattern)
9843 (error (display-completion-list list)))))
9844 (message "Making completion list...%s" "done")))))))
9846 ;;;; TODO, DEADLINE, Comments
9848 (defun org-toggle-comment ()
9849 "Change the COMMENT state of an entry."
9850 (interactive)
9851 (save-excursion
9852 (org-back-to-heading)
9853 (let (case-fold-search)
9854 (if (looking-at (concat outline-regexp
9856 (replace-match "" t t nil 1)
9857 (if (looking-at outline-regexp)
9858 (progn
9859 (goto-char (match-end 0))
9860 (insert org-comment-string " ")))))))
9862 (defvar org-last-todo-state-is-todo nil
9863 "This is non-nil when the last TODO state change led to a TODO state.
9864 If the last change removed the TODO tag or switched to DONE, then
9865 this is nil.")
9867 (defvar org-setting-tags nil) ; dynamically skipped
9869 (defun org-parse-local-options (string var)
9870 "Parse STRING for startup setting relevant for variable VAR."
9871 (let ((rtn (symbol-value var))
9872 e opts)
9873 (save-match-data
9875 rtn
9876 (setq opts (delq nil (mapcar (lambda (x)
9877 (setq e (assoc x org-startup-options))
9878 (if (eq (nth 1 e) var) e nil))
9880 (if (not opts)
9881 rtn
9882 (setq rtn nil)
9883 (while (setq e (pop opts))
9884 (if (not (nth 3 e))
9885 (setq rtn (nth 2 e))
9886 (if (not (listp rtn)) (setq rtn nil))
9887 (push (nth 2 e) rtn)))
9888 rtn)))))
9890 (defvar org-todo-setup-filter-hook nil
9891 "Hook for functions that pre-filter todo specs.
9893 Each function takes a todo spec and returns either `nil' or the spec
9894 transformed into canonical form." )
9896 (defvar org-todo-get-default-hook nil
9897 "Hook for functions that get a default item for todo.
9899 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
9900 `nil' or a string to be used for the todo mark." )
9902 (defvar org-agenda-headline-snapshot-before-repeat)
9904 (defun org-todo (&optional arg)
9905 "Change the TODO state of an item.
9906 The state of an item is given by a keyword at the start of the heading,
9907 like
9908 *** TODO Write paper
9909 *** DONE Call mom
9911 The different keywords are specified in the variable `org-todo-keywords'.
9913 So for this example: when the item starts with TODO, it is changed to DONE.
9914 When it starts with DONE, the DONE is removed. And when neither TODO nor
9915 DONE are present, add TODO at the beginning of the heading.
9917 With C-u prefix arg, use completion to determine the new state.
9918 With numeric prefix arg, switch to that state.
9919 With a double C-u prefix, switch to the next set of TODO keywords (nextset).
9920 With a triple C-u prefix, circumvent any state blocking.
9922 For calling through lisp, arg is also interpreted in the following way:
9923 'none -> empty state
9925 'done -> switch to DONE
9926 'nextset -> switch to the next set of keywords
9927 'previousset -> switch to the previous set of keywords
9929 really is a member of `org-todo-keywords'."
9930 (interactive "P")
9931 (if (equal arg '(16)) (setq arg 'nextset))
9932 (let ((org-blocker-hook org-blocker-hook)
9933 (case-fold-search nil))
9934 (when (equal arg '(64))
9935 (setq arg nil org-blocker-hook nil))
9936 (when (and org-blocker-hook
9937 (or org-inhibit-blocking
9938 (org-entry-get nil "NOBLOCKING")))
9939 (setq org-blocker-hook nil))
9940 (save-excursion
9941 (catch 'exit
9942 (org-back-to-heading t)
9943 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
9945 (looking-at " *"))
9946 (let* ((match-data (match-data))
9947 (startpos (point-at-bol))
9948 (logging (save-match-data (org-entry-get nil "LOGGING" t)))
9949 (org-log-done org-log-done)
9950 (org-log-repeat org-log-repeat)
9951 (org-todo-log-states org-todo-log-states)
9952 (this (match-string 1))
9953 (hl-pos (match-beginning 0))
9954 (head (org-get-todo-sequence-head this))
9955 (ass (assoc head org-todo-kwd-alist))
9956 (interpret (nth 1 ass))
9957 (done-word (nth 3 ass))
9958 (final-done-word (nth 4 ass))
9959 (last-state (or this ""))
9960 (completion-ignore-case t)
9961 (member (member this org-todo-keywords-1))
9962 (tail (cdr member))
9963 (state (cond
9964 ((and org-todo-key-trigger
9965 (or (and (equal arg '(4))
9966 (eq org-use-fast-todo-selection 'prefix))
9967 (and (not arg) org-use-fast-todo-selection
9968 (not (eq org-use-fast-todo-selection
9969 'prefix)))))
9970 ;; Use fast selection
9971 (org-fast-todo-selection))
9972 ((and (equal arg '(4))
9973 (or (not org-use-fast-todo-selection)
9974 (not org-todo-key-trigger)))
9975 ;; Read a state with completion
9976 (org-icompleting-read
9977 "State: " (mapcar (lambda(x) (list x))
9978 org-todo-keywords-1)
9979 nil t))
9980 ((eq arg 'right)
9981 (if this
9982 (if tail (car tail) nil)
9983 (car org-todo-keywords-1)))
9984 ((eq arg 'left)
9985 (if (equal member org-todo-keywords-1)
9986 nil
9987 (if this
9988 (nth (- (length org-todo-keywords-1)
9989 (length tail) 2)
9990 org-todo-keywords-1)
9991 (org-last org-todo-keywords-1))))
9992 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
9993 (setq arg nil))) ; hack to fall back to cycling
9994 (arg
9995 ;; user or caller requests a specific state
9996 (cond
9997 ((equal arg "") nil)
9998 ((eq arg 'none) nil)
9999 ((eq arg 'done) (or done-word (car org-done-keywords)))
10000 ((eq arg 'nextset)
10001 (or (car (cdr (member head org-todo-heads)))
10002 (car org-todo-heads)))
10003 ((eq arg 'previousset)
10004 (let ((org-todo-heads (reverse org-todo-heads)))
10005 (or (car (cdr (member head org-todo-heads)))
10006 (car org-todo-heads))))
10007 ((car (member arg org-todo-keywords-1)))
10008 ((stringp arg)
10009 (error "State `%s' not valid in this file" arg))
10010 ((nth (1- (prefix-numeric-value arg))
10011 org-todo-keywords-1))))
10012 ((null member) (or head (car org-todo-keywords-1)))
10013 ((equal this final-done-word) nil) ;; -> make empty
10014 ((null tail) nil) ;; -> first entry
10015 ((memq interpret '(type priority))
10016 (if (eq this-command last-command)
10017 (car tail)
10018 (if (> (length tail) 0)
10019 (or done-word (car org-done-keywords))
10020 nil)))
10021 (t
10022 (car tail))))
10023 (state (or
10024 (run-hook-with-args-until-success
10025 'org-todo-get-default-hook state last-state)
10026 state))
10027 (next (if state (concat " " state " ") " "))
10028 (change-plist (list :type 'todo-state-change :from this :to state
10029 :position startpos))
10030 dolog now-done-p)
10031 (when org-blocker-hook
10032 (setq org-last-todo-state-is-todo
10033 (not (member this org-done-keywords)))
10034 (unless (save-excursion
10035 (save-match-data
10036 (run-hook-with-args-until-failure
10037 'org-blocker-hook change-plist)))
10038 (if (interactive-p)
10039 (error "TODO state change from %s to %s blocked" this state)
10040 ;; fail silently
10041 (message "TODO state change from %s to %s blocked" this state)
10042 (throw 'exit nil))))
10043 (store-match-data match-data)
10044 (replace-match next t t)
10045 (unless (pos-visible-in-window-p hl-pos)
10046 (message "TODO state changed to %s" (org-trim next)))
10047 (unless head
10048 (setq head (org-get-todo-sequence-head state)
10049 ass (assoc head org-todo-kwd-alist)
10050 interpret (nth 1 ass)
10051 done-word (nth 3 ass)
10052 final-done-word (nth 4 ass)))
10053 (when (memq arg '(nextset previousset))
10054 (message "Keyword-Set %d/%d: %s"
10055 (- (length org-todo-sets) -1
10056 (length (memq (assoc state org-todo-sets) org-todo-sets)))
10057 (length org-todo-sets)
10058 (mapconcat 'identity (assoc state org-todo-sets) " ")))
10059 (setq org-last-todo-state-is-todo
10060 (not (member state org-done-keywords)))
10061 (setq now-done-p (and (member state org-done-keywords)
10062 (not (member this org-done-keywords))))
10063 (and logging (org-local-logging logging))
10064 (when (and (or org-todo-log-states org-log-done)
10065 (not (eq org-inhibit-logging t))
10066 (not (memq arg '(nextset previousset))))
10067 ;; we need to look at recording a time and note
10068 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
10069 (nth 2 (assoc this org-todo-log-states))))
10070 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
10071 (setq dolog 'time))
10072 (when (and state
10073 (member state org-not-done-keywords)
10074 (not (member this org-not-done-keywords)))
10075 ;; This is now a todo state and was not one before
10076 ;; If there was a CLOSED time stamp, get rid of it.
10077 (org-add-planning-info nil nil 'closed))
10078 (when (and now-done-p org-log-done)
10079 ;; It is now done, and it was not done before
10080 (org-add-planning-info 'closed (org-current-time))
10081 (if (and (not dolog) (eq 'note org-log-done))
10082 (org-add-log-setup 'done state this 'findpos 'note)))
10083 (when (and state dolog)
10084 ;; This is a non-nil state, and we need to log it
10085 (org-add-log-setup 'state state this 'findpos dolog)))
10086 ;; Fixup tag positioning
10087 (org-todo-trigger-tag-changes state)
10088 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
10089 (when org-provide-todo-statistics
10090 (org-update-parent-todo-statistics))
10091 (run-hooks 'org-after-todo-state-change-hook)
10092 (if (and arg (not (member state org-done-keywords)))
10093 (setq head (org-get-todo-sequence-head state)))
10094 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
10095 ;; Do we need to trigger a repeat?
10096 (when now-done-p
10097 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
10098 ;; This is for the agenda, take a snapshot of the headline.
10099 (save-match-data
10100 (setq org-agenda-headline-snapshot-before-repeat
10101 (org-get-heading))))
10102 (org-auto-repeat-maybe state))
10103 ;; Fixup cursor location if close to the keyword
10104 (if (and (outline-on-heading-p)
10105 (not (bolp))
10106 (save-excursion (beginning-of-line 1)
10107 (looking-at org-todo-line-regexp))
10108 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
10109 (progn
10110 (goto-char (or (match-end 2) (match-end 1)))
10111 (and (looking-at " ") (just-one-space))))
10112 (when org-trigger-hook
10113 (save-excursion
10114 (run-hook-with-args 'org-trigger-hook change-plist))))))))
10116 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
10117 "Block turning an entry into a TODO, using the hierarchy.
10118 This checks whether the current task should be blocked from state
10119 changes. Such blocking occurs when:
10121 1. The task has children which are not all in a completed state.
10123 2. A task has a parent with the property :ORDERED:, and there
10124 are siblings prior to the current task with incomplete
10125 status.
10127 3. The parent of the task is blocked because it has siblings that should
10128 be done first, or is child of a block grandparent TODO entry."
10130 (catch 'dont-block
10131 ;; If this is not a todo state change, or if this entry is already DONE,
10132 ;; do not block
10133 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
10134 (member (plist-get change-plist :from)
10135 (cons 'done org-done-keywords))
10136 (member (plist-get change-plist :to)
10137 (cons 'todo org-not-done-keywords))
10138 (not (plist-get change-plist :to)))
10139 (throw 'dont-block t))
10140 ;; If this task has children, and any are undone, it's blocked
10141 (save-excursion
10142 (org-back-to-heading t)
10143 (let ((this-level (funcall outline-level)))
10144 (outline-next-heading)
10145 (let ((child-level (funcall outline-level)))
10146 (while (and (not (eobp))
10147 (> child-level this-level))
10148 ;; this todo has children, check whether they are all
10149 ;; completed
10150 (if (and (not (org-entry-is-done-p))
10151 (org-entry-is-todo-p))
10152 (throw 'dont-block nil))
10153 (outline-next-heading)
10154 (setq child-level (funcall outline-level))))))
10155 ;; Otherwise, if the task's parent has the :ORDERED: property, and
10156 ;; any previous siblings are undone, it's blocked
10157 (save-excursion
10158 (org-back-to-heading t)
10159 (let* ((pos (point))
10160 (parent-pos (and (org-up-heading-safe) (point))))
10161 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10162 (when (and (org-entry-get (point) "ORDERED")
10163 (forward-line 1)
10164 (re-search-forward org-not-done-heading-regexp pos t))
10165 (throw 'dont-block nil)) ; block, there is an older sibling not done.
10166 ;; Search further up the hierarchy, to see if an anchestor is blocked
10167 (while t
10168 (goto-char parent-pos)
10169 (if (not (looking-at org-not-done-heading-regexp))
10170 (throw 'dont-block t)) ; do not block, parent is not a TODO
10171 (setq pos (point))
10172 (setq parent-pos (and (org-up-heading-safe) (point)))
10173 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10174 (when (and (org-entry-get (point) "ORDERED")
10175 (forward-line 1)
10176 (re-search-forward org-not-done-heading-regexp pos t))
10177 (throw 'dont-block nil))))))) ; block, older sibling not done.
10179 (defcustom org-track-ordered-property-with-tag nil
10180 "Should the ORDERED property also be shown as a tag?
10181 The ORDERED property decides if an entry should require subtasks to be
10182 completed in sequence. Since a property is not very visible, setting
10183 this option means that toggling the ORDERED property with the command
10184 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
10185 not relevant for the behavior, but it makes things more visible.
10187 Note that toggling the tag with tags commands will not change the property
10188 and therefore not influence behavior!
10190 This can be t, meaning the tag ORDERED should be used, It can also be a
10191 string to select a different tag for this task."
10192 :group 'org-todo
10193 :type '(choice
10194 (const :tag "No tracking" nil)
10195 (const :tag "Track with ORDERED tag" t)
10196 (string :tag "Use other tag")))
10198 (defun org-toggle-ordered-property ()
10199 "Toggle the ORDERED property of the current entry.
10200 For better visibility, you can track the value of this property with a tag.
10201 See variable `org-track-ordered-property-with-tag'."
10202 (interactive)
10203 (let* ((t1 org-track-ordered-property-with-tag)
10204 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
10205 (save-excursion
10206 (org-back-to-heading)
10207 (if (org-entry-get nil "ORDERED")
10208 (progn
10209 (org-delete-property "ORDERED")
10210 (and tag (org-toggle-tag tag 'off))
10211 (message "Subtasks can be completed in arbitrary order"))
10212 (org-entry-put nil "ORDERED" "t")
10213 (and tag (org-toggle-tag tag 'on))
10214 (message "Subtasks must be completed in sequence")))))
10216 (defvar org-blocked-by-checkboxes) ; dynamically scoped
10217 (defun org-block-todo-from-checkboxes (change-plist)
10218 "Block turning an entry into a TODO, using checkboxes.
10219 This checks whether the current task should be blocked from state
10220 changes because there are unchecked boxes in this entry."
10221 (catch 'dont-block
10222 ;; If this is not a todo state change, or if this entry is already DONE,
10223 ;; do not block
10224 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
10225 (member (plist-get change-plist :from)
10226 (cons 'done org-done-keywords))
10227 (member (plist-get change-plist :to)
10228 (cons 'todo org-not-done-keywords))
10229 (not (plist-get change-plist :to)))
10230 (throw 'dont-block t))
10231 ;; If this task has checkboxes that are not checked, it's blocked
10232 (save-excursion
10233 (org-back-to-heading t)
10234 (let ((beg (point)) end)
10235 (outline-next-heading)
10236 (setq end (point))
10237 (goto-char beg)
10239 end t)
10240 (progn
10241 (if (boundp 'org-blocked-by-checkboxes)
10242 (setq org-blocked-by-checkboxes t))
10243 (throw 'dont-block nil)))))
10244 t)) ; do not block
10246 (defun org-entry-blocked-p ()
10247 "Is the current entry blocked?"
10248 (if (org-entry-get nil "NOBLOCKING")
10249 nil ;; Never block this entry
10250 (not
10251 (run-hook-with-args-until-failure
10252 'org-blocker-hook
10253 (list :type 'todo-state-change
10254 :position (point)
10255 :from 'todo
10256 :to 'done)))))
10258 (defun org-update-statistics-cookies (all)
10259 "Update the statistics cookie, either from TODO or from checkboxes.
10260 This should be called with the cursor in a line with a statistics cookie."
10261 (interactive "P")
10262 (if all
10263 (progn
10264 (org-update-checkbox-count 'all)
10265 (org-map-entries 'org-update-parent-todo-statistics))
10266 (if (not (org-on-heading-p))
10267 (org-update-checkbox-count)
10268 (let ((pos (move-marker (make-marker) (point)))
10269 end l1 l2)
10270 (ignore-errors (org-back-to-heading t))
10271 (if (not (org-on-heading-p))
10272 (org-update-checkbox-count)
10273 (setq l1 (org-outline-level))
10274 (setq end (save-excursion
10275 (outline-next-heading)
10276 (if (org-on-heading-p) (setq l2 (org-outline-level)))
10277 (point)))
10278 (if (and (save-excursion (re-search-forward
10280 (not (save-excursion (re-search-forward
10282 (org-update-checkbox-count)
10283 (if (and l2 (> l2 l1))
10284 (progn
10285 (goto-char end)
10286 (org-update-parent-todo-statistics))
10287 (error "No data for statistics cookie"))))
10288 (goto-char pos)
10289 (move-marker pos nil)))))
10291 (defvar org-entry-property-inherited-from) ;; defined below
10292 (defun org-update-parent-todo-statistics ()
10293 "Update any statistics cookie in the parent of the current headline.
10294 When `org-hierarchical-todo-statistics' is nil, statistics will cover
10295 the entire subtree and this will travel up the hierarchy and update
10296 statistics everywhere."
10297 (interactive)
10298 (let* ((lim 0) prop
10299 (recursive (or (not org-hierarchical-todo-statistics)
10300 (string-match
10302 (or (setq prop (org-entry-get
10303 nil "COOKIE_DATA" 'inherit)) ""))))
10304 (lim (or (and prop (marker-position
10305 org-entry-property-inherited-from))
10306 lim))
10307 (first t)
10309 level ltoggle l1 new ndel
10310 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
10311 (catch 'exit
10312 (save-excursion
10313 (beginning-of-line 1)
10314 (if (org-at-heading-p)
10315 (setq ltoggle (funcall outline-level))
10316 (error "This should not happen"))
10317 (while (and (setq level (org-up-heading-safe))
10318 (or recursive first)
10319 (>= (point) lim))
10320 (setq first nil cookie-present nil)
10321 (unless (and level
10322 (not (string-match
10324 (downcase
10325 (or (org-entry-get
10326 nil "COOKIE_DATA")
10327 "")))))
10328 (throw 'exit nil))
10329 (while (re-search-forward box-re (point-at-eol) t)
10330 (setq cnt-all 0 cnt-done 0 cookie-present t)
10331 (setq is-percent (match-end 2))
10332 (save-match-data
10333 (unless (outline-next-heading) (throw 'exit nil))
10334 (while (and (looking-at org-complex-heading-regexp)
10335 (> (setq l1 (length (match-string 1))) level))
10336 (setq kwd (and (or recursive (= l1 ltoggle))
10337 (match-string 2)))
10338 (if (or (eq org-provide-todo-statistics 'all-headlines)
10339 (and (listp org-provide-todo-statistics)
10340 (or (member kwd org-provide-todo-statistics)
10341 (member kwd org-done-keywords))))
10342 (setq cnt-all (1+ cnt-all))
10343 (if (eq org-provide-todo-statistics t)
10344 (and kwd (setq cnt-all (1+ cnt-all)))))
10345 (and (member kwd org-done-keywords)
10346 (setq cnt-done (1+ cnt-done)))
10347 (outline-next-heading)))
10348 (setq new
10349 (if is-percent
10350 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
10351 (format "[%d/%d]" cnt-done cnt-all))
10352 ndel (- (match-end 0) (match-beginning 0)))
10353 (goto-char (match-beginning 0))
10354 (insert new)
10355 (delete-region (point) (+ (point) ndel)))
10356 (when cookie-present
10357 (run-hook-with-args 'org-after-todo-statistics-hook
10358 cnt-done (- cnt-all cnt-done))))))
10359 (run-hooks 'org-todo-statistics-hook)))
10361 (defvar org-after-todo-statistics-hook nil
10362 "Hook that is called after a TODO statistics cookie has been updated.
10363 Each function is called with two arguments: the number of not-done entries
10364 and the number of done entries.
10366 For example, the following function, when added to this hook, will switch
10367 an entry to DONE when all children are done, and back to TODO when new
10368 entries are set to a TODO status. Note that this hook is only called
10369 when there is a statistics cookie in the headline!
10371 (defun org-summary-todo (n-done n-not-done)
10373 (let (org-log-done org-log-states) ; turn off logging
10375 ")
10377 (defvar org-todo-statistics-hook nil
10378 "Hook that is run whenever Org thinks TODO statistics should be updated.
10379 This hook runs even if there is no statistics cookie present, in which case
10380 `org-after-todo-statistics-hook' would not run.")
10382 (defun org-todo-trigger-tag-changes (state)
10383 "Apply the changes defined in `org-todo-state-tags-triggers'."
10384 (let ((l org-todo-state-tags-triggers)
10385 changes)
10386 (when (or (not state) (equal state ""))
10387 (setq changes (append changes (cdr (assoc "" l)))))
10388 (when (and (stringp state) (> (length state) 0))
10389 (setq changes (append changes (cdr (assoc state l)))))
10390 (when (member state org-not-done-keywords)
10391 (setq changes (append changes (cdr (assoc 'todo l)))))
10392 (when (member state org-done-keywords)
10393 (setq changes (append changes (cdr (assoc 'done l)))))
10394 (dolist (c changes)
10395 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
10397 (defun org-local-logging (value)
10398 "Get logging settings from a property VALUE."
10399 (let* (words w a)
10400 ;; directly set the variables, they are already local.
10401 (setq org-log-done nil
10402 org-log-repeat nil
10403 org-todo-log-states nil)
10404 (setq words (org-split-string value))
10405 (while (setq w (pop words))
10406 (cond
10407 ((setq a (assoc w org-startup-options))
10408 (and (member (nth 1 a) '(org-log-done org-log-repeat))
10409 (set (nth 1 a) (nth 2 a))))
10410 ((setq a (org-extract-log-state-settings w))
10411 (and (member (car a) org-todo-keywords-1)
10412 (push a org-todo-log-states)))))))
10414 (defun org-get-todo-sequence-head (kwd)
10415 "Return the head of the TODO sequence to which KWD belongs.
10416 If KWD is not set, check if there is a text property remembering the
10417 right sequence."
10418 (let (p)
10419 (cond
10420 ((not kwd)
10421 (or (get-text-property (point-at-bol) 'org-todo-head)
10422 (progn
10423 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
10424 nil (point-at-eol)))
10425 (get-text-property p 'org-todo-head))))
10426 ((not (member kwd org-todo-keywords-1))
10427 (car org-todo-keywords-1))
10428 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
10430 (defun org-fast-todo-selection ()
10431 "Fast TODO keyword selection with single keys.
10432 Returns the new TODO keyword, or nil if no state change should occur."
10433 (let* ((fulltable org-todo-key-alist)
10434 (done-keywords org-done-keywords) ;; needed for the faces.
10435 (maxlen (apply 'max (mapcar
10436 (lambda (x)
10437 (if (stringp (car x)) (string-width (car x)) 0))
10438 fulltable)))
10439 (expert nil)
10440 (fwidth (+ maxlen 3 1 3))
10441 (ncol (/ (- (window-width) 4) fwidth))
10442 tg cnt e c tbl
10443 groups ingroup)
10444 (save-excursion
10445 (save-window-excursion
10446 (if expert
10447 (set-buffer (get-buffer-create " *Org todo*"))
10448 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
10449 (erase-buffer)
10450 (org-set-local 'org-done-keywords done-keywords)
10451 (setq tbl fulltable cnt 0)
10452 (while (setq e (pop tbl))
10453 (cond
10454 ((equal e '(:startgroup))
10455 (push '() groups) (setq ingroup t)
10456 (when (not (= cnt 0))
10457 (setq cnt 0)
10459 (insert "{ "))
10460 ((equal e '(:endgroup))
10461 (setq ingroup nil cnt 0)
10463 ((equal e '(:newline))
10464 (when (not (= cnt 0))
10465 (setq cnt 0)
10467 (setq e (car tbl))
10468 (while (equal (car tbl) '(:newline))
10470 (setq tbl (cdr tbl)))))
10471 (t
10472 (setq tg (car e) c (cdr e))
10473 (if ingroup (push tg (car groups)))
10474 (setq tg (org-add-props tg nil 'face
10475 (org-get-todo-face tg)))
10476 (if (and (= cnt 0) (not ingroup)) (insert " "))
10477 (insert "[" c "] " tg (make-string
10478 (- fwidth 4 (length tg)) ?\ ))
10479 (when (= (setq cnt (1+ cnt)) ncol)
10481 (if ingroup (insert " "))
10482 (setq cnt 0)))))
10484 (goto-char (point-min))
10485 (if (not expert) (org-fit-window-to-buffer))
10486 (message "[a-z..]:Set [SPC]:clear")
10487 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
10488 (cond
10489 ((or (= c ?\C-g)
10490 (and (= c ?q) (not (rassoc c fulltable))))
10491 (setq quit-flag t))
10492 ((= c ?\ ) nil)
10493 ((setq e (rassoc c fulltable) tg (car e))
10494 tg)
10495 (t (setq quit-flag t)))))))
10497 (defun org-entry-is-todo-p ()
10498 (member (org-get-todo-state) org-not-done-keywords))
10500 (defun org-entry-is-done-p ()
10501 (member (org-get-todo-state) org-done-keywords))
10503 (defun org-get-todo-state ()
10504 (save-excursion
10505 (org-back-to-heading t)
10506 (and (looking-at org-todo-line-regexp)
10507 (match-end 2)
10508 (match-string 2))))
10510 (defun org-at-date-range-p (&optional inactive-ok)
10511 "Is the cursor inside a date range?"
10512 (interactive)
10513 (save-excursion
10514 (catch 'exit
10515 (let ((pos (point)))
10517 (skip-chars-backward "<[")
10518 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
10519 (>= (match-end 0) pos)
10520 (throw 'exit t))
10522 (skip-chars-backward "<[")
10523 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
10524 (>= (match-end 0) pos)
10525 (throw 'exit t)))
10526 nil)))
10528 (defun org-get-repeat (&optional tagline)
10529 "Check if there is a deadline/schedule with repeater in this entry."
10530 (save-match-data
10531 (save-excursion
10532 (org-back-to-heading t)
10533 (and (re-search-forward (if tagline
10535 org-repeat-re)
10536 (org-entry-end-position) t)
10537 (match-string-no-properties 1)))))
10539 (defvar org-last-changed-timestamp)
10540 (defvar org-last-inserted-timestamp)
10541 (defvar org-log-post-message)
10542 (defvar org-log-note-purpose)
10543 (defvar org-log-note-how)
10544 (defvar org-log-note-extra)
10545 (defun org-auto-repeat-maybe (done-word)
10546 "Check if the current headline contains a repeated deadline/schedule.
10547 If yes, set TODO state back to what it was and change the base date
10548 of repeating deadline/scheduled time stamps to new date.
10549 This function is run automatically after each state change to a DONE state."
10550 ;; last-state is dynamically scoped into this function
10551 (let* ((repeat (org-get-repeat))
10552 (aa (assoc last-state org-todo-kwd-alist))
10553 (interpret (nth 1 aa))
10554 (head (nth 2 aa))
10555 (whata '(("d" . day) ("m" . month) ("y" . year)))
10556 (msg "Entry repeats: ")
10557 (org-log-done nil)
10558 (org-todo-log-states nil)
10559 (nshiftmax 10) (nshift 0)
10560 re type n what ts time)
10561 (when repeat
10562 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
10563 (org-todo (if (eq interpret 'type) last-state head))
10564 (org-entry-put nil "LAST_REPEAT" (format-time-string
10565 (org-time-stamp-format t t)))
10566 (when org-log-repeat
10567 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
10568 (memq 'org-add-log-note post-command-hook))
10569 ;; OK, we are already setup for some record
10570 (if (eq org-log-repeat 'note)
10571 ;; make sure we take a note, not only a time stamp
10572 (setq org-log-note-how 'note))
10573 ;; Set up for taking a record
10574 (org-add-log-setup 'state (or done-word (car org-done-keywords))
10575 last-state
10576 'findpos org-log-repeat)))
10577 (org-back-to-heading t)
10578 (org-add-planning-info nil nil 'closed)
10582 (while (re-search-forward
10583 re (save-excursion (outline-next-heading) (point)) t)
10584 (setq type (if (match-end 1) org-scheduled-string
10585 (if (match-end 3) org-deadline-string "Plain:"))
10586 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
10588 (setq n (string-to-number (match-string 2 ts))
10589 what (match-string 3 ts))
10590 (if (equal what "w") (setq n (* n 7) what "d"))
10591 ;; Preparation, see if we need to modify the start date for the change
10592 (when (match-end 1)
10593 (setq time (save-match-data (org-time-string-to-time ts)))
10594 (cond
10595 ((equal (match-string 1 ts) ".")
10596 ;; Shift starting date to today
10597 (org-timestamp-change
10598 (- (time-to-days (current-time)) (time-to-days time))
10599 'day))
10600 ((equal (match-string 1 ts) "+")
10601 (while (or (= nshift 0)
10602 (<= (time-to-days time) (time-to-days (current-time))))
10603 (when (= (incf nshift) nshiftmax)
10604 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
10605 (error "Abort")))
10606 (org-timestamp-change n (cdr (assoc what whata)))
10607 (org-at-timestamp-p t)
10608 (setq ts (match-string 1))
10609 (setq time (save-match-data (org-time-string-to-time ts))))
10610 (org-timestamp-change (- n) (cdr (assoc what whata)))
10611 ;; rematch, so that we have everything in place for the real shift
10612 (org-at-timestamp-p t)
10613 (setq ts (match-string 1))
10615 (org-timestamp-change n (cdr (assoc what whata)))
10616 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
10617 (setq org-log-post-message msg)
10618 (message "%s" msg))))
10620 (defun org-show-todo-tree (arg)
10621 "Make a compact tree which shows all headlines marked with TODO.
10622 The tree will show the lines where the regexp matches, and all higher
10623 headlines above the match.
10625 With a numeric prefix N, construct a sparse tree for the Nth element
10626 of `org-todo-keywords-1'."
10627 (interactive "P")
10628 (let ((case-fold-search nil)
10629 (kwd-re
10630 (cond ((null arg) org-not-done-regexp)
10631 ((equal arg '(4))
10632 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
10633 (mapcar 'list org-todo-keywords-1))))
10637 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
10638 (regexp-quote (nth (1- (prefix-numeric-value arg))
10639 org-todo-keywords-1)))
10640 (t (error "Invalid prefix argument: %s" arg)))))
10641 (message "%d TODO entries found"
10642 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
10644 (defun org-deadline (&optional remove time)
10646 With argument REMOVE, remove any deadline from the item.
10647 When TIME is set, it should be an internal time specification, and the
10648 scheduling will use the corresponding date."
10649 (interactive "P")
10650 (let ((old-date (org-entry-get nil "DEADLINE")))
10651 (if remove
10652 (progn
10653 (when (and old-date org-log-redeadline)
10654 (org-add-log-setup 'deldeadline nil old-date 'findpos
10655 org-log-redeadline))
10656 (org-remove-timestamp-with-keyword org-deadline-string)
10657 (message "Item no longer has a deadline."))
10658 (if (org-get-repeat)
10659 (error "Cannot change deadline on task with repeater, please do that by hand")
10660 (org-add-planning-info 'deadline time 'closed)
10661 (when (and old-date org-log-redeadline
10662 (not (equal old-date
10663 (substring org-last-inserted-timestamp 1 -1))))
10664 (org-add-log-setup 'redeadline nil old-date 'findpos
10665 org-log-redeadline))
10666 (message "Deadline on %s" org-last-inserted-timestamp)))))
10668 (defun org-schedule (&optional remove time)
10669 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
10670 With argument REMOVE, remove any scheduling date from the item.
10671 When TIME is set, it should be an internal time specification, and the
10672 scheduling will use the corresponding date."
10673 (interactive "P")
10674 (let ((old-date (org-entry-get nil "SCHEDULED")))
10675 (if remove
10676 (progn
10677 (when (and old-date org-log-reschedule)
10678 (org-add-log-setup 'delschedule nil old-date 'findpos
10679 org-log-reschedule))
10680 (org-remove-timestamp-with-keyword org-scheduled-string)
10681 (message "Item is no longer scheduled."))
10682 (if (org-get-repeat)
10683 (error "Cannot reschedule task with repeater, please do that by hand")
10684 (org-add-planning-info 'scheduled time 'closed)
10685 (when (and old-date org-log-reschedule
10686 (not (equal old-date
10687 (substring org-last-inserted-timestamp 1 -1))))
10688 (org-add-log-setup 'reschedule nil old-date 'findpos
10689 org-log-reschedule))
10690 (message "Scheduled to %s" org-last-inserted-timestamp)))))
10692 (defun org-get-scheduled-time (pom &optional inherit)
10693 "Get the scheduled time as a time tuple, of a format suitable
10694 for calling org-schedule with, or if there is no scheduling,
10695 returns nil."
10696 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
10697 (when time
10698 (apply 'encode-time (org-parse-time-string time)))))
10700 (defun org-get-deadline-time (pom &optional inherit)
10701 "Get the deadine as a time tuple, of a format suitable for
10702 calling org-deadline with, or if there is no scheduling, returns
10703 nil."
10704 (let ((time (org-entry-get pom "DEADLINE" inherit)))
10705 (when time
10706 (apply 'encode-time (org-parse-time-string time)))))
10708 (defun org-remove-timestamp-with-keyword (keyword)
10709 "Remove all time stamps with KEYWORD in the current entry."
10711 beg)
10712 (save-excursion
10713 (org-back-to-heading t)
10714 (setq beg (point))
10715 (outline-next-heading)
10716 (while (re-search-backward re beg t)
10717 (replace-match "")
10719 (equal (char-before) ?\ ))
10720 (backward-delete-char 1)
10722 (point-at-bol) (point-at-eol)))
10723 (delete-region (point-at-bol)
10724 (min (point-max) (1+ (point-at-eol))))))))))
10726 (defun org-add-planning-info (what &optional time &rest remove)
10727 "Insert new timestamp with keyword in the line directly after the headline.
10728 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
10729 If non is given, the user is prompted for a date.
10730 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
10731 be removed."
10732 (interactive)
10733 (let (org-time-was-given org-end-time-was-given ts
10734 end default-time default-input)
10736 (catch 'exit
10737 (when (and (not time) (memq what '(scheduled deadline)))
10738 ;; Try to get a default date/time from existing timestamp
10739 (save-excursion
10740 (org-back-to-heading t)
10741 (setq end (save-excursion (outline-next-heading) (point)))
10742 (when (re-search-forward (if (eq what 'scheduled)
10743 org-scheduled-time-regexp
10744 org-deadline-time-regexp)
10745 end t)
10746 (setq ts (match-string 1)
10747 default-time
10748 (apply 'encode-time (org-parse-time-string ts))
10749 default-input (and ts (org-get-compact-tod ts))))))
10750 (when what
10751 ;; If necessary, get the time from the user
10752 (setq time (or time (org-read-date nil 'to-time nil nil
10753 default-time default-input))))
10755 (when (and org-insert-labeled-timestamps-at-point
10756 (member what '(scheduled deadline)))
10757 (insert
10758 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
10759 (org-insert-time-stamp time org-time-was-given
10760 nil nil nil (list org-end-time-was-given))
10761 (setq what nil))
10762 (save-excursion
10763 (save-restriction
10764 (let (col list elt ts buffer-invisibility-spec)
10765 (org-back-to-heading t)
10767 (goto-char (match-end 1))
10768 (setq col (current-column))
10769 (goto-char (match-end 0))
10771 (when (and (not what)
10772 (not (looking-at
10774 org-keyword-time-not-clock-regexp))))
10775 ;; Nothing to add, nothing to remove...... :-)
10776 (throw 'exit nil))
10777 (if (and (not (looking-at outline-regexp))
10780 (not (equal (match-string 1) org-clock-string)))
10781 (narrow-to-region (match-beginning 0) (match-end 0))
10783 (backward-char 1)
10784 (narrow-to-region (point) (point))
10785 (and org-adapt-indentation (org-indent-to-column col)))
10786 ;; Check if we have to remove something.
10787 (setq list (cons what remove))
10788 (while list
10789 (setq elt (pop list))
10790 (goto-char (point-min))
10791 (when (or (and (eq elt 'scheduled)
10792 (re-search-forward org-scheduled-time-regexp nil t))
10793 (and (eq elt 'deadline)
10794 (re-search-forward org-deadline-time-regexp nil t))
10795 (and (eq elt 'closed)
10796 (re-search-forward org-closed-time-regexp nil t)))
10797 (replace-match "")
10798 (if (looking-at "--+<[^>]+>") (replace-match ""))
10799 (skip-chars-backward " ")
10800 (if (looking-at " +") (replace-match ""))))
10801 (goto-char (point-max))
10802 (and org-adapt-indentation (bolp) (org-indent-to-column col))
10803 (when what
10804 (insert
10805 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
10806 (cond ((eq what 'scheduled) org-scheduled-string)
10807 ((eq what 'deadline) org-deadline-string)
10808 ((eq what 'closed) org-closed-string))
10809 " ")
10810 (setq ts (org-insert-time-stamp
10811 time
10812 (or org-time-was-given
10813 (and (eq what 'closed) org-log-done-with-time))
10814 (eq what 'closed)
10815 nil nil (list org-end-time-was-given)))
10816 (end-of-line 1))
10817 (goto-char (point-min))
10818 (widen)
10821 (delete-region (1- (point)) (point-at-eol)))
10822 ts))))))
10824 (defvar org-log-note-marker (make-marker))
10825 (defvar org-log-note-purpose nil)
10826 (defvar org-log-note-state nil)
10827 (defvar org-log-note-previous-state nil)
10828 (defvar org-log-note-how nil)
10829 (defvar org-log-note-extra nil)
10830 (defvar org-log-note-window-configuration nil)
10831 (defvar org-log-note-return-to (make-marker))
10832 (defvar org-log-post-message nil
10833 "Message to be displayed after a log note has been stored.
10834 The auto-repeater uses this.")
10836 (defun org-add-note ()
10837 "Add a note to the current entry.
10838 This is done in the same way as adding a state change note."
10839 (interactive)
10840 (org-add-log-setup 'note nil nil 'findpos nil))
10842 (defvar org-property-end-re)
10843 (defun org-add-log-setup (&optional purpose state prev-state
10844 findpos how &optional extra)
10845 "Set up the post command hook to take a note.
10846 If this is about to TODO state change, the new state is expected in STATE.
10847 When FINDPOS is non-nil, find the correct position for the note in
10848 the current entry. If not, assume that it can be inserted at point.
10849 HOW is an indicator what kind of note should be created.
10850 EXTRA is additional text that will be inserted into the notes buffer."
10851 (let* ((org-log-into-drawer (org-log-into-drawer))
10852 (drawer (cond ((stringp org-log-into-drawer)
10853 org-log-into-drawer)
10854 (org-log-into-drawer "LOGBOOK")
10855 (t nil))))
10856 (save-restriction
10857 (save-excursion
10858 (when findpos
10859 (org-back-to-heading t)
10860 (narrow-to-region (point) (save-excursion
10861 (outline-next-heading) (point)))
10865 (goto-char (match-end 0))
10866 (cond
10867 (drawer
10869 nil t)
10870 (progn
10871 (goto-char (match-end 0))
10872 (or org-log-states-order-reversed
10873 (and (re-search-forward org-property-end-re nil t)
10874 (goto-char (1- (match-beginning 0))))))
10876 (beginning-of-line 0)
10877 (org-indent-line-function)
10878 (beginning-of-line 2)
10879 (org-indent-line-function)
10880 (end-of-line 0)))
10881 ((and org-log-state-notes-insert-after-drawers
10882 (save-excursion
10883 (forward-line) (looking-at org-drawer-regexp)))
10884 (forward-line)
10885 (while (looking-at org-drawer-regexp)
10886 (goto-char (match-end 0))
10887 (re-search-forward org-property-end-re (point-max) t)
10888 (forward-line))
10889 (forward-line -1)))
10890 (unless org-log-states-order-reversed
10892 (org-skip-over-state-notes)
10894 (move-marker org-log-note-marker (point))
10895 (setq org-log-note-purpose purpose
10896 org-log-note-state state
10897 org-log-note-previous-state prev-state
10898 org-log-note-how how
10899 org-log-note-extra extra)
10900 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
10902 (defun org-skip-over-state-notes ()
10903 "Skip past the list of State notes in an entry."
10906 (condition-case nil
10907 (org-next-item)
10908 (error (org-end-of-item)))))
10910 (defun org-add-log-note (&optional purpose)
10911 "Pop up a window for taking a note, and add this note later at point."
10912 (remove-hook 'post-command-hook 'org-add-log-note)
10913 (setq org-log-note-window-configuration (current-window-configuration))
10914 (delete-other-windows)
10915 (move-marker org-log-note-return-to (point))
10916 (switch-to-buffer (marker-buffer org-log-note-marker))
10917 (goto-char org-log-note-marker)
10918 (org-switch-to-buffer-other-window "*Org Note*")
10919 (erase-buffer)
10920 (if (memq org-log-note-how '(time state))
10921 (let (current-prefix-arg) (org-store-log-note))
10922 (let ((org-inhibit-startup t)) (org-mode))
10923 (insert (format "# Insert note for %s.
10925 (cond
10926 ((eq org-log-note-purpose 'clock-out) "stopped clock")
10927 ((eq org-log-note-purpose 'done) "closed todo item")
10928 ((eq org-log-note-purpose 'state)
10930 (or org-log-note-previous-state "")
10931 (or org-log-note-state "")))
10932 ((eq org-log-note-purpose 'reschedule)
10933 "rescheduling")
10934 ((eq org-log-note-purpose 'delschedule)
10935 "no longer scheduled")
10936 ((eq org-log-note-purpose 'redeadline)
10937 "changing deadline")
10938 ((eq org-log-note-purpose 'deldeadline)
10939 "removing deadline")
10940 ((eq org-log-note-purpose 'note)
10941 "this entry")
10942 (t (error "This should not happen")))))
10943 (if org-log-note-extra (insert org-log-note-extra))
10944 (org-set-local 'org-finish-function 'org-store-log-note)))
10946 (defvar org-note-abort nil) ; dynamically scoped
10947 (defun org-store-log-note ()
10948 "Finish taking a log note, and insert it to where it belongs."
10949 (let ((txt (buffer-string))
10950 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
10951 lines ind)
10952 (kill-buffer (current-buffer))
10954 (setq txt (replace-match "" t t txt)))
10956 (setq txt (replace-match "" t t txt)))
10959 (setq note
10960 (org-replace-escapes
10961 note
10962 (list (cons "%u" (user-login-name))
10963 (cons "%U" user-full-name)
10964 (cons "%t" (format-time-string
10965 (org-time-stamp-format 'long 'inactive)
10966 (current-time)))
10967 (cons "%s" (if org-log-note-state
10969 ""))
10970 (cons "%S" (if org-log-note-previous-state
10974 (push note lines))
10975 (when (or current-prefix-arg org-note-abort)
10976 (when org-log-into-drawer
10977 (org-remove-empty-drawer-at
10978 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
10979 org-log-note-marker))
10980 (setq lines nil))
10981 (when lines
10982 (with-current-buffer (marker-buffer org-log-note-marker)
10983 (save-excursion
10984 (goto-char org-log-note-marker)
10985 (move-marker org-log-note-marker nil)
10986 (end-of-line 1)
10988 (insert "- " (pop lines))
10989 (org-indent-line-function)
10990 (beginning-of-line 1)
10992 (setq ind (concat (match-string 0) " "))
10993 (end-of-line 1)
10995 (message "Note stored")
10996 (org-back-to-heading t)
10997 (org-cycle-hide-drawers 'children)))))
10998 (set-window-configuration org-log-note-window-configuration)
10999 (with-current-buffer (marker-buffer org-log-note-return-to)
11000 (goto-char org-log-note-return-to))
11001 (move-marker org-log-note-return-to nil)
11002 (and org-log-post-message (message "%s" org-log-post-message)))
11004 (defun org-remove-empty-drawer-at (drawer pos)
11005 "Remove an empty drawer DRAWER at position POS.
11006 POS may also be a marker."
11007 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
11008 (save-excursion
11009 (save-restriction
11010 (widen)
11011 (goto-char pos)
11012 (if (org-in-regexp
11014 (replace-match ""))))))
11016 (defun org-sparse-tree (&optional arg)
11017 "Create a sparse tree, prompt for the details.
11018 This command can create sparse trees. You first need to select the type
11019 of match used to create the tree:
11021 t Show entries with a specific TODO keyword.
11022 m Show entries selected by a tags/property match.
11023 p Enter a property name and its value (both with completion on existing
11024 names/values) and show entries with that property.
11025 / Show entries matching a regular expression (`r' can be used as well)
11026 d Show deadlines due within `org-deadline-warning-days'.
11027 b Show deadlines and scheduled items before a date.
11028 a Show deadlines and scheduled items after a date."
11029 (interactive "P")
11030 (let (ans kwd value)
11031 (message "Sparse tree: [/]regexp [t]odo-kwd [m]atch [p]roperty [d]eadlines [b]efore-date [a]fter-date")
11032 (setq ans (read-char-exclusive))
11033 (cond
11034 ((equal ans ?d)
11035 (call-interactively 'org-check-deadlines))
11036 ((equal ans ?b)
11037 (call-interactively 'org-check-before-date))
11038 ((equal ans ?a)
11039 (call-interactively 'org-check-after-date))
11040 ((equal ans ?t)
11041 (org-show-todo-tree '(4)))
11042 ((member ans '(?T ?m))
11043 (call-interactively 'org-match-sparse-tree))
11044 ((member ans '(?p ?P))
11045 (setq kwd (org-icompleting-read "Property: "
11046 (mapcar 'list (org-buffer-property-keys))))
11047 (setq value (org-icompleting-read "Value: "
11048 (mapcar 'list (org-property-values kwd))))
11051 (org-match-sparse-tree arg (concat kwd "=" value)))
11052 ((member ans '(?r ?R ?/))
11053 (call-interactively 'org-occur))
11056 (defvar org-occur-highlights nil
11057 "List of overlays used for occur matches.")
11058 (make-variable-buffer-local 'org-occur-highlights)
11059 (defvar org-occur-parameters nil
11060 "Parameters of the active org-occur calls.
11061 This is a list, each call to org-occur pushes as cons cell,
11062 containing the regular expression and the callback, onto the list.
11063 The list can contain several entries if `org-occur' has been called
11064 several time with the KEEP-PREVIOUS argument. Otherwise, this list
11065 will only contain one set of parameters. When the highlights are
11066 removed (for example with `C-c C-c', or with the next edit (depending
11067 on `org-remove-highlights-with-change'), this variable is emptied
11068 as well.")
11069 (make-variable-buffer-local 'org-occur-parameters)
11071 (defun org-occur (regexp &optional keep-previous callback)
11072 "Make a compact tree which shows all matches of REGEXP.
11073 The tree will show the lines where the regexp matches, and all higher
11074 headlines above the match. It will also show the heading after the match,
11075 to make sure editing the matching entry is easy.
11076 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
11077 call to `org-occur' will be kept, to allow stacking of calls to this
11078 command.
11079 If CALLBACK is non-nil, it is a function which is called to confirm
11080 that the match should indeed be shown."
11082 (when (equal regexp "")
11083 (error "Regexp cannot be empty"))
11084 (unless keep-previous
11085 (org-remove-occur-highlights nil nil t))
11086 (push (cons regexp callback) org-occur-parameters)
11087 (let ((cnt 0))
11088 (save-excursion
11089 (goto-char (point-min))
11090 (if (or (not keep-previous) ; do not want to keep
11091 (not org-occur-highlights)) ; no previous matches
11092 ;; hide everything
11093 (org-overview))
11094 (while (re-search-forward regexp nil t)
11095 (when (or (not callback)
11096 (save-match-data (funcall callback)))
11097 (setq cnt (1+ cnt))
11098 (when org-highlight-sparse-tree-matches
11099 (org-highlight-new-match (match-beginning 0) (match-end 0)))
11100 (org-show-context 'occur-tree))))
11101 (when org-remove-highlights-with-change
11102 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
11103 nil 'local))
11104 (unless org-sparse-tree-open-archived-trees
11105 (org-hide-archived-subtrees (point-min) (point-max)))
11106 (run-hooks 'org-occur-hook)
11107 (if (interactive-p)
11108 (message "%d match(es) for regexp %s" cnt regexp))
11109 cnt))
11111 (defun org-show-context (&optional key)
11112 "Make sure point and context and visible.
11113 How much context is shown depends upon the variables
11114 `org-show-hierarchy-above', `org-show-following-heading'. and
11115 `org-show-siblings'."
11116 (let ((heading-p (org-on-heading-p t))
11117 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
11118 (following-p (org-get-alist-option org-show-following-heading key))
11119 (entry-p (org-get-alist-option org-show-entry-below key))
11120 (siblings-p (org-get-alist-option org-show-siblings key)))
11121 (catch 'exit
11122 ;; Show heading or entry text
11123 (if (and heading-p (not entry-p))
11124 (org-flag-heading nil) ; only show the heading
11125 (and (or entry-p (org-invisible-p) (org-invisible-p2))
11126 (org-show-hidden-entry))) ; show entire entry
11127 (when following-p
11128 ;; Show next sibling, or heading below text
11129 (save-excursion
11130 (and (if heading-p (org-goto-sibling) (outline-next-heading))
11131 (org-flag-heading nil))))
11132 (when siblings-p (org-show-siblings))
11133 (when hierarchy-p
11134 ;; show all higher headings, possibly with siblings
11135 (save-excursion
11136 (while (and (condition-case nil
11137 (progn (org-up-heading-all 1) t)
11138 (error nil))
11139 (not (bobp)))
11140 (org-flag-heading nil)
11141 (when siblings-p (org-show-siblings))))))))
11143 (defun org-reveal (&optional siblings)
11144 "Show current entry, hierarchy above it, and the following headline.
11145 This can be used to show a consistent set of context around locations
11146 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
11147 not t for the search context.
11149 With optional argument SIBLINGS, on each level of the hierarchy all
11150 siblings are shown. This repairs the tree structure to what it would
11151 look like when opened with hierarchical calls to `org-cycle'."
11152 (interactive "P")
11153 (let ((org-show-hierarchy-above t)
11154 (org-show-following-heading t)
11155 (org-show-siblings (if siblings t org-show-siblings)))
11156 (org-show-context nil)))
11158 (defun org-highlight-new-match (beg end)
11159 "Highlight from BEG to END and mark the highlight is an occur headline."
11160 (let ((ov (org-make-overlay beg end)))
11161 (org-overlay-put ov 'face 'secondary-selection)
11162 (push ov org-occur-highlights)))
11164 (defun org-remove-occur-highlights (&optional beg end noremove)
11165 "Remove the occur highlights from the buffer.
11166 BEG and END are ignored. If NOREMOVE is nil, remove this function
11167 from the `before-change-functions' in the current buffer."
11168 (interactive)
11169 (unless org-inhibit-highlight-removal
11170 (mapc 'org-delete-overlay org-occur-highlights)
11171 (setq org-occur-highlights nil)
11172 (setq org-occur-parameters nil)
11173 (unless noremove
11174 (remove-hook 'before-change-functions
11175 'org-remove-occur-highlights 'local))))
11177 ;;;; Priorities
11180 "Regular expression matching the priority indicator.")
11182 (defvar org-remove-priority-next-time nil)
11184 (defun org-priority-up ()
11185 "Increase the priority of the current item."
11186 (interactive)
11187 (org-priority 'up))
11189 (defun org-priority-down ()
11190 "Decrease the priority of the current item."
11191 (interactive)
11192 (org-priority 'down))
11194 (defun org-priority (&optional action)
11195 "Change the priority of an item by ARG.
11196 ACTION can be `set', `up', `down', or a character."
11197 (interactive)
11198 (unless org-enable-priority-commands
11199 (error "Priority commands are disabled"))
11200 (setq action (or action 'set))
11201 (let (current new news have remove)
11202 (save-excursion
11203 (org-back-to-heading t)
11204 (if (looking-at org-priority-regexp)
11205 (setq current (string-to-char (match-string 2))
11206 have t)
11207 (setq current org-default-priority))
11208 (cond
11209 ((eq action 'remove)
11210 (setq remove t new ?\ ))
11211 ((or (eq action 'set)
11212 (if (featurep 'xemacs) (characterp action) (integerp action)))
11213 (if (not (eq action 'set))
11214 (setq new action)
11215 (message "Priority %c-%c, SPC to remove: "
11216 org-highest-priority org-lowest-priority)
11217 (setq new (read-char-exclusive)))
11218 (if (and (= (upcase org-highest-priority) org-highest-priority)
11219 (= (upcase org-lowest-priority) org-lowest-priority))
11220 (setq new (upcase new)))
11221 (cond ((equal new ?\ ) (setq remove t))
11222 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
11223 (error "Priority must be between `%c' and `%c'"
11224 org-highest-priority org-lowest-priority))))
11225 ((eq action 'up)
11226 (if (and (not have) (eq last-command this-command))
11227 (setq new org-lowest-priority)
11228 (setq new (if (and org-priority-start-cycle-with-default (not have))
11229 org-default-priority (1- current)))))
11230 ((eq action 'down)
11231 (if (and (not have) (eq last-command this-command))
11232 (setq new org-highest-priority)
11233 (setq new (if (and org-priority-start-cycle-with-default (not have))
11234 org-default-priority (1+ current)))))
11235 (t (error "Invalid action")))
11236 (if (or (< (upcase new) org-highest-priority)
11237 (> (upcase new) org-lowest-priority))
11238 (setq remove t))
11239 (setq news (format "%c" new))
11240 (if have
11241 (if remove
11242 (replace-match "" t t nil 1)
11243 (replace-match news t t nil 2))
11244 (if remove
11245 (error "No priority cookie found in line")
11246 (let ((case-fold-search nil))
11247 (looking-at org-todo-line-regexp))
11248 (if (match-end 2)
11249 (progn
11250 (goto-char (match-end 2))
11251 (insert " [#" news "]"))
11252 (goto-char (match-beginning 3))
11253 (insert "[#" news "] "))))
11254 (org-preserve-lc (org-set-tags nil 'align)))
11255 (if remove
11256 (message "Priority removed")
11257 (message "Priority of current item set to %s" news))))
11259 (defun org-get-priority (s)
11260 "Find priority cookie and return priority."
11261 (save-match-data
11262 (if (not (string-match org-priority-regexp s))
11263 (* 1000 (- org-lowest-priority org-default-priority))
11264 (* 1000 (- org-lowest-priority
11265 (string-to-char (match-string 2 s)))))))
11267 ;;;; Tags
11269 (defvar org-agenda-archives-mode)
11270 (defvar org-map-continue-from nil
11271 "Position from where mapping should continue.
11272 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
11274 (defvar org-scanner-tags nil
11275 "The current tag list while the tags scanner is running.")
11276 (defvar org-trust-scanner-tags nil
11277 "Should `org-get-tags-at' use the tags fro the scanner.
11278 This is for internal dynamical scoping only.
11279 When this is non-nil, the function `org-get-tags-at' will return the value
11280 of `org-scanner-tags' instead of building the list by itself. This
11281 can lead to large speed-ups when the tags scanner is used in a file with
11282 many entries, and when the list of tags is retrieved, for example to
11283 obtain a list of properties. Building the tags list for each entry in such
11284 a file becomes an N^2 operation - but with this variable set, it scales
11285 as N.")
11287 (defun org-scan-tags (action matcher &optional todo-only)
11288 "Scan headline tags with inheritance and produce output ACTION.
11290 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
11291 or `agenda' to produce an entry list for an agenda view. It can also be
11292 a Lisp form or a function that should be called at each matched headline, in
11293 this case the return value is a list of all return values from these calls.
11295 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
11296 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
11297 only lines with a TODO keyword are included in the output."
11298 (require 'org-agenda)
11301 (org-re
11303 (props (list 'face 'default
11304 'done-face 'org-agenda-done
11305 'undone-face 'default
11306 'mouse-face 'highlight
11307 'org-not-done-regexp org-not-done-regexp
11308 'org-todo-regexp org-todo-regexp
11309 'help-echo
11310 (format "mouse-2 or RET jump to org file %s"
11311 (abbreviate-file-name
11312 (or (buffer-file-name (buffer-base-buffer))
11313 (buffer-name (buffer-base-buffer)))))))
11314 (case-fold-search nil)
11315 (org-map-continue-from nil)
11316 lspos tags tags-list
11317 (tags-alist (list (cons 0 org-file-tags)))
11318 (llast 0) rtn rtn1 level category i txt
11319 todo marker entry priority)
11320 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
11321 (setq action (list 'lambda nil action)))
11322 (save-excursion
11323 (goto-char (point-min))
11324 (when (eq action 'sparse-tree)
11325 (org-overview)
11326 (org-remove-occur-highlights))
11327 (while (re-search-forward re nil t)
11328 (catch :skip
11329 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
11330 tags (if (match-end 4) (org-match-string-no-properties 4)))
11331 (goto-char (setq lspos (match-beginning 0)))
11332 (setq level (org-reduced-level (funcall outline-level))
11333 category (org-get-category))
11334 (setq i llast llast level)
11335 ;; remove tag lists from same and sublevels
11336 (while (>= i level)
11337 (when (setq entry (assoc i tags-alist))
11338 (setq tags-alist (delete entry tags-alist)))
11339 (setq i (1- i)))
11340 ;; add the next tags
11341 (when tags
11342 (setq tags (org-split-string tags ":")
11343 tags-alist
11344 (cons (cons level tags) tags-alist)))
11345 ;; compile tags for current headline
11346 (setq tags-list
11347 (if org-use-tag-inheritance
11348 (apply 'append (mapcar 'cdr (reverse tags-alist)))
11349 tags)
11350 org-scanner-tags tags-list)
11351 (when org-use-tag-inheritance
11352 (setcdr (car tags-alist)
11353 (mapcar (lambda (x)
11354 (setq x (copy-sequence x))
11355 (org-add-prop-inherited x))
11356 (cdar tags-alist))))
11357 (when (and tags org-use-tag-inheritance
11358 (or (not (eq t org-use-tag-inheritance))
11359 org-tags-exclude-from-inheritance))
11360 ;; selective inheritance, remove uninherited ones
11361 (setcdr (car tags-alist)
11362 (org-remove-uniherited-tags (cdar tags-alist))))
11363 (when (and (or (not todo-only)
11364 (and (member todo org-not-done-keywords)
11365 (or (not org-agenda-tags-todo-honor-ignore-options)
11366 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
11367 (let ((case-fold-search t)) (eval matcher))
11368 (or
11369 (not (member org-archive-tag tags-list))
11370 ;; we have an archive tag, should we use this anyway?
11371 (or (not org-agenda-skip-archived-trees)
11372 (and (eq action 'agenda) org-agenda-archives-mode))))
11373 (unless (eq action 'sparse-tree) (org-agenda-skip))
11375 ;; select this headline
11377 (cond
11378 ((eq action 'sparse-tree)
11379 (and org-highlight-sparse-tree-matches
11380 (org-get-heading) (match-end 0)
11381 (org-highlight-new-match
11382 (match-beginning 0) (match-beginning 1)))
11383 (org-show-context 'tags-tree))
11384 ((eq action 'agenda)
11385 (setq txt (org-format-agenda-item
11386 ""
11387 (concat
11388 (if (eq org-tags-match-list-sublevels 'indented)
11389 (make-string (1- level) ?.) "")
11390 (org-get-heading))
11391 category
11392 tags-list
11393 )
11394 priority (org-get-priority txt))
11395 (goto-char lspos)
11396 (setq marker (org-agenda-new-marker))
11397 (org-add-props txt props
11398 'org-marker marker 'org-hd-marker marker 'org-category category
11399 'todo-state todo
11400 'priority priority 'type "tagsmatch")
11401 (push txt rtn))
11402 ((functionp action)
11403 (setq org-map-continue-from nil)
11404 (save-excursion
11405 (setq rtn1 (funcall action))
11406 (push rtn1 rtn)))
11407 (t (error "Invalid action")))
11409 ;; if we are to skip sublevels, jump to end of subtree
11410 (unless org-tags-match-list-sublevels
11411 (org-end-of-subtree t)
11412 (backward-char 1))))
11413 ;; Get the correct position from where to continue
11414 (if org-map-continue-from
11415 (goto-char org-map-continue-from)
11416 (and (= (point) lspos) (end-of-line 1)))))
11417 (when (and (eq action 'sparse-tree)
11418 (not org-sparse-tree-open-archived-trees))
11419 (org-hide-archived-subtrees (point-min) (point-max)))
11420 (nreverse rtn)))
11422 (defun org-remove-uniherited-tags (tags)
11423 "Remove all tags that are not inherited from the list TAGS."
11424 (cond
11425 ((eq org-use-tag-inheritance t)
11426 (if org-tags-exclude-from-inheritance
11427 (org-delete-all org-tags-exclude-from-inheritance tags)
11428 tags))
11429 ((not org-use-tag-inheritance) nil)
11430 ((stringp org-use-tag-inheritance)
11431 (delq nil (mapcar
11432 (lambda (x)
11433 (if (and (string-match org-use-tag-inheritance x)
11434 (not (member x org-tags-exclude-from-inheritance)))
11435 x nil))
11436 tags)))
11437 ((listp org-use-tag-inheritance)
11438 (delq nil (mapcar
11439 (lambda (x)
11440 (if (member x org-use-tag-inheritance) x nil))
11441 tags)))))
11443 (defvar todo-only) ;; dynamically scoped
11445 (defun org-match-sparse-tree (&optional todo-only match)
11446 "Create a sparse tree according to tags string MATCH.
11447 MATCH can contain positive and negative selection of tags, like
11449 If optional argument TODO-ONLY is non-nil, only select lines that are
11450 also TODO lines."
11451 (interactive "P")
11452 (org-prepare-agenda-buffers (list (current-buffer)))
11453 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
11455 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
11457 (defvar org-cached-props nil)
11458 (defun org-cached-entry-get (pom property)
11459 (if (or (eq t org-use-property-inheritance)
11460 (and (stringp org-use-property-inheritance)
11461 (string-match org-use-property-inheritance property))
11462 (and (listp org-use-property-inheritance)
11463 (member property org-use-property-inheritance)))
11464 ;; Caching is not possible, check it directly
11465 (org-entry-get pom property 'inherit)
11466 ;; Get all properties, so that we can do complicated checks easily
11467 (cdr (assoc property (or org-cached-props
11468 (setq org-cached-props
11469 (org-entry-properties pom)))))))
11471 (defun org-global-tags-completion-table (&optional files)
11472 "Return the list of all tags in all agenda buffer/files."
11473 (save-excursion
11474 (org-uniquify
11475 (delq nil
11476 (apply 'append
11477 (mapcar
11478 (lambda (file)
11479 (set-buffer (find-file-noselect file))
11480 (append (org-get-buffer-tags)
11481 (mapcar (lambda (x) (if (stringp (car-safe x))
11482 (list (car-safe x)) nil))
11483 org-tag-alist)))
11484 (if (and files (car files))
11485 files
11486 (org-agenda-files))))))))
11488 (defun org-make-tags-matcher (match)
11489 "Create the TAGS//TODO matcher form for the selection string MATCH."
11490 ;; todo-only is scoped dynamically into this function, and the function
11491 ;; may change it if the matcher asks for it.
11492 (unless match
11493 ;; Get a new match request, with completion
11494 (let ((org-last-tags-completion-table
11495 (org-global-tags-completion-table)))
11496 (setq match (org-completing-read-no-i
11497 "Match: " 'org-tags-completion-function nil nil nil
11498 'org-tags-history))))
11500 ;; Parse the string and create a lisp form
11501 (let ((match0 match)
11502 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\([[:alnum:]_]+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@]+\\)"))
11503 minus tag mm
11504 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
11505 orterms term orlist re-p str-p level-p level-op time-p
11506 prop-p pn pv po cat-p gv rest)
11507 (if (string-match "/+" match)
11508 ;; match contains also a todo-matching request
11509 (progn
11510 (setq tagsmatch (substring match 0 (match-beginning 0))
11511 todomatch (substring match (match-end 0)))
11512 (if (string-match "^!" todomatch)
11513 (setq todo-only t todomatch (substring todomatch 1)))
11515 (setq todomatch nil)))
11516 ;; only matching tags
11517 (setq tagsmatch match todomatch nil))
11519 ;; Make the tags matcher
11521 (setq tagsmatcher t)
11522 (setq orterms (org-split-string tagsmatch "|") orlist nil)
11523 (while (setq term (pop orterms))
11525 (setq term (concat term "|" (pop orterms)))) ; repair bad split
11526 (while (string-match re term)
11527 (setq rest (substring term (match-end 0))
11528 minus (and (match-end 1)
11529 (equal (match-string 1 term) "-"))
11530 tag (match-string 2 term)
11531 re-p (equal (string-to-char tag) ?{)
11532 level-p (match-end 4)
11533 prop-p (match-end 5)
11534 mm (cond
11535 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
11536 (level-p
11537 (setq level-op (org-op-to-function (match-string 3 term)))
11538 `(,level-op level ,(string-to-number
11539 (match-string 4 term))))
11540 (prop-p
11541 (setq pn (match-string 5 term)
11542 po (match-string 6 term)
11543 pv (match-string 7 term)
11544 cat-p (equal pn "CATEGORY")
11545 re-p (equal (string-to-char pv) ?{)
11547 time-p (save-match-data
11549 pv (if (or re-p str-p) (substring pv 1 -1) pv))
11550 (if time-p (setq pv (org-matcher-time pv)))
11551 (setq po (org-op-to-function po (if time-p 'time str-p)))
11552 (cond
11553 ((equal pn "CATEGORY")
11554 (setq gv '(get-text-property (point) 'org-category)))
11555 ((equal pn "TODO")
11556 (setq gv 'todo))
11557 (t
11558 (setq gv `(org-cached-entry-get nil ,pn))))
11559 (if re-p
11560 (if (eq po 'org<>)
11561 `(not (string-match ,pv (or ,gv "")))
11562 `(string-match ,pv (or ,gv "")))
11563 (if str-p
11564 `(,po (or ,gv "") ,pv)
11565 `(,po (string-to-number (or ,gv ""))
11566 ,(string-to-number pv) ))))
11567 (t `(member ,tag tags-list)))
11568 mm (if minus (list 'not mm) mm)
11569 term rest)
11570 (push mm tagsmatcher))
11571 (push (if (> (length tagsmatcher) 1)
11572 (cons 'and tagsmatcher)
11573 (car tagsmatcher))
11574 orlist)
11575 (setq tagsmatcher nil))
11576 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
11577 (setq tagsmatcher
11578 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
11579 ;; Make the todo matcher
11581 (setq todomatcher t)
11582 (setq orterms (org-split-string todomatch "|") orlist nil)
11583 (while (setq term (pop orterms))
11584 (while (string-match re term)
11585 (setq minus (and (match-end 1)
11586 (equal (match-string 1 term) "-"))
11587 kwd (match-string 2 term)
11588 re-p (equal (string-to-char kwd) ?{)
11589 term (substring term (match-end 0))
11590 mm (if re-p
11591 `(string-match ,(substring kwd 1 -1) todo)
11592 (list 'equal 'todo kwd))
11593 mm (if minus (list 'not mm) mm))
11594 (push mm todomatcher))
11595 (push (if (> (length todomatcher) 1)
11596 (cons 'and todomatcher)
11597 (car todomatcher))
11598 orlist)
11599 (setq todomatcher nil))
11600 (setq todomatcher (if (> (length orlist) 1)
11601 (cons 'or orlist) (car orlist))))
11603 ;; Return the string and lisp forms of the matcher
11604 (setq matcher (if todomatcher
11605 (list 'and tagsmatcher todomatcher)
11606 tagsmatcher))
11607 (cons match0 matcher)))
11609 (defun org-op-to-function (op &optional stringp)
11610 "Turn an operator into the appropriate function."
11611 (setq op
11612 (cond
11613 ((equal op "<" ) '(< string< org-time<))
11614 ((equal op ">" ) '(> org-string> org-time>))
11615 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
11616 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
11617 ((member op '("=" "==")) '(= string= org-time=))
11618 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
11619 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
11621 (defun org<> (a b) (not (= a b)))
11622 (defun org-string<= (a b) (or (string= a b) (string< a b)))
11623 (defun org-string>= (a b) (not (string< a b)))
11624 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
11625 (defun org-string<> (a b) (not (string= a b)))
11626 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
11627 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
11628 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
11629 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
11630 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
11631 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
11632 (defun org-2ft (s)
11633 "Convert S to a floating point time.
11634 If S is already a number, just return it. If it is a string, parse
11635 it as a time string and apply `float-time' to it. If S is nil, just return 0."
11636 (cond
11637 ((numberp s) s)
11638 ((stringp s)
11639 (condition-case nil
11640 (float-time (apply 'encode-time (org-parse-time-string s)))
11641 (error 0.)))
11642 (t 0.)))
11644 (defun org-time-today ()
11645 "Time in seconds today at 0:00.
11646 Returns the float number of seconds since the beginning of the
11647 epoch to the beginning of today (00:00)."
11648 (float-time (apply 'encode-time
11649 (append '(0 0 0) (nthcdr 3 (decode-time))))))
11651 (defun org-matcher-time (s)
11652 "Interpret a time comparison value."
11653 (save-match-data
11654 (cond
11655 ((string= s "<now>") (float-time))
11656 ((string= s "<today>") (org-time-today))
11657 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
11658 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
11660 (+ (org-time-today)
11661 (* (string-to-number (match-string 1 s))
11662 (cdr (assoc (match-string 2 s)
11663 '(("d" . 86400.0) ("w" . 604800.0)
11664 ("m" . 2678400.0) ("y" . 31557600.0)))))))
11665 (t (org-2ft s)))))
11667 (defun org-match-any-p (re list)
11668 "Does re match any element of list?"
11669 (setq list (mapcar (lambda (x) (string-match re x)) list))
11670 (delq nil list))
11672 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
11673 (defvar org-tags-overlay (org-make-overlay 1 1))
11674 (org-detach-overlay org-tags-overlay)
11676 (defun org-get-local-tags-at (&optional pos)
11677 "Get a list of tags defined in the current headline."
11678 (org-get-tags-at pos 'local))
11680 (defun org-get-local-tags ()
11681 "Get a list of tags defined in the current headline."
11682 (org-get-tags-at nil 'local))
11684 (defun org-get-tags-at (&optional pos local)
11685 "Get a list of all headline tags applicable at POS.
11686 POS defaults to point. If tags are inherited, the list contains
11687 the targets in the same sequence as the headlines appear, i.e.
11688 the tags of the current headline come last.
11689 When LOCAL is non-nil, only return tags from the current headline,
11690 ignore inherited ones."
11691 (interactive)
11692 (if (and org-trust-scanner-tags
11693 (or (not pos) (equal pos (point)))
11694 (not local))
11695 org-scanner-tags
11696 (let (tags ltags lastpos parent)
11697 (save-excursion
11698 (save-restriction
11699 (widen)
11700 (goto-char (or pos (point)))
11701 (save-match-data
11702 (catch 'done
11703 (condition-case nil
11704 (progn
11705 (org-back-to-heading t)
11706 (while (not (equal lastpos (point)))
11707 (setq lastpos (point))
11708 (when (looking-at
11710 (setq ltags (org-split-string
11711 (org-match-string-no-properties 1) ":"))
11712 (when parent
11713 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
11714 (setq tags (append
11715 (if parent
11716 (org-remove-uniherited-tags ltags)
11717 ltags)
11718 tags)))
11719 (or org-use-tag-inheritance (throw 'done t))
11720 (if local (throw 'done t))
11721 (or (org-up-heading-safe) (error nil))
11722 (setq parent t)))
11723 (error nil)))))
11724 (append (org-remove-uniherited-tags org-file-tags) tags)))))
11726 (defun org-add-prop-inherited (s)
11727 (add-text-properties 0 (length s) '(inherited t) s)
11728 s)
11730 (defun org-toggle-tag (tag &optional onoff)
11731 "Toggle the tag TAG for the current line.
11732 If ONOFF is `on' or `off', don't toggle but set to this state."
11733 (let (res current)
11734 (save-excursion
11735 (org-back-to-heading t)
11737 (point-at-eol) t)
11738 (progn
11739 (setq current (match-string 1))
11740 (replace-match ""))
11741 (setq current ""))
11742 (setq current (nreverse (org-split-string current ":")))
11743 (cond
11744 ((eq onoff 'on)
11745 (setq res t)
11746 (or (member tag current) (push tag current)))
11747 ((eq onoff 'off)
11748 (or (not (member tag current)) (setq current (delete tag current))))
11749 (t (if (member tag current)
11750 (setq current (delete tag current))
11751 (setq res t)
11752 (push tag current))))
11753 (end-of-line 1)
11754 (if current
11755 (progn
11756 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
11757 (org-set-tags nil t))
11758 (delete-horizontal-space))
11759 (run-hooks 'org-after-tags-change-hook))
11760 res))
11762 (defun org-align-tags-here (to-col)
11763 ;; Assumes that this is a headline
11764 (let ((pos (point)) (col (current-column)) ncol tags-l p)
11765 (beginning-of-line 1)
11767 (< pos (match-beginning 2)))
11768 (progn
11769 (setq tags-l (- (match-end 2) (match-beginning 2)))
11770 (goto-char (match-beginning 1))
11771 (insert " ")
11772 (delete-region (point) (1+ (match-beginning 2)))
11773 (setq ncol (max (1+ (current-column))
11774 (1+ col)
11775 (if (> to-col 0)
11776 to-col
11777 (- (abs to-col) tags-l))))
11778 (setq p (point))
11779 (insert (make-string (- ncol (current-column)) ?\ ))
11780 (setq ncol (current-column))
11781 (when indent-tabs-mode (tabify p (point-at-eol)))
11782 (org-move-to-column (min ncol col) t))
11783 (goto-char pos))))
11785 (defun org-set-tags-command (&optional arg just-align)
11786 "Call the set-tags command for the current entry."
11787 (interactive "P")
11788 (if (org-on-heading-p)
11789 (org-set-tags arg just-align)
11790 (save-excursion
11791 (org-back-to-heading t)
11792 (org-set-tags arg just-align))))
11794 (defun org-set-tags-to (data)
11795 "Set the tags of the current entry to DATA, replacing the current tags.
11796 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
11797 If DATA is nil or the empty string, any tags will be removed."
11798 (interactive "sTags: ")
11799 (setq data
11800 (cond
11801 ((eq data nil) "")
11802 ((equal data "") "")
11803 ((stringp data)
11804 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
11805 ":"))
11806 ((listp data)
11807 (concat ":" (mapconcat 'identity data ":") ":"))
11808 (t nil)))
11809 (when data
11810 (save-excursion
11811 (org-back-to-heading t)
11812 (when (looking-at org-complex-heading-regexp)
11813 (if (match-end 5)
11814 (progn
11815 (goto-char (match-beginning 5))
11816 (insert data)
11817 (delete-region (point) (point-at-eol))
11818 (org-set-tags nil 'align))
11819 (goto-char (point-at-eol))
11820 (insert " " data)
11821 (org-set-tags nil 'align)))
11822 (beginning-of-line 1)
11824 (delete-region (match-beginning 1) (match-end 1))))))
11826 (defun org-set-tags (&optional arg just-align)
11827 "Set the tags for the current headline.
11828 With prefix ARG, realign all tags in headings in the current buffer."
11829 (interactive "P")
11830 (let* ((re (concat "^" outline-regexp))
11831 (current (org-get-tags-string))
11832 (col (current-column))
11833 (org-setting-tags t)
11834 table current-tags inherited-tags ; computed below when needed
11835 tags p0 c0 c1 rpl)
11836 (if arg
11837 (save-excursion
11838 (goto-char (point-min))
11839 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
11840 (while (re-search-forward re nil t)
11841 (org-set-tags nil t)
11842 (end-of-line 1)))
11843 (message "All tags realigned to column %d" org-tags-column))
11844 (if just-align
11845 (setq tags current)
11846 ;; Get a new set of tags from the user
11847 (save-excursion
11848 (setq table (append org-tag-persistent-alist
11849 (or org-tag-alist (org-get-buffer-tags))
11850 (and org-complete-tags-always-offer-all-agenda-tags
11851 (org-global-tags-completion-table (org-agenda-files))))
11852 org-last-tags-completion-table table
11853 current-tags (org-split-string current ":")
11854 inherited-tags (nreverse
11855 (nthcdr (length current-tags)
11856 (nreverse (org-get-tags-at))))
11857 tags
11858 (if (or (eq t org-use-fast-tag-selection)
11859 (and org-use-fast-tag-selection
11860 (delq nil (mapcar 'cdr table))))
11861 (org-fast-tag-selection
11862 current-tags inherited-tags table
11863 (if org-fast-tag-selection-include-todo org-todo-key-alist))
11864 (let ((org-add-colon-after-tag-completion t))
11865 (org-trim
11866 (org-without-partial-completion
11867 (org-icompleting-read "Tags: " 'org-tags-completion-function
11868 nil nil current 'org-tags-history)))))))
11869 (while (string-match "[-+&]+" tags)
11870 ;; No boolean logic, just a list
11871 (setq tags (replace-match ":" t t tags))))
11873 (if org-tags-sort-function
11874 (setq tags (mapconcat 'identity
11875 (sort (org-split-string tags (org-re "[^[:alnum:]_@]+"))
11876 org-tags-sort-function) ":")))
11879 (setq tags "")
11880 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
11881 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
11883 ;; Insert new tags at the correct column
11884 (beginning-of-line 1)
11885 (cond
11886 ((and (equal current "") (equal tags "")))
11887 ((re-search-forward
11889 (point-at-eol) t)
11890 (if (equal tags "")
11891 (setq rpl "")
11892 (goto-char (match-beginning 0))
11893 (setq c0 (current-column) p0 (if (equal (char-before) ?*)
11894 (1+ (point)) (point))
11895 c1 (max (1+ c0) (if (> org-tags-column 0)
11896 org-tags-column
11897 (- (- org-tags-column) (length tags))))
11898 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
11899 (replace-match rpl t t)
11900 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
11901 tags)
11902 (t (error "Tags alignment failed")))
11903 (org-move-to-column col)
11904 (unless just-align
11905 (run-hooks 'org-after-tags-change-hook)))))
11907 (defun org-change-tag-in-region (beg end tag off)
11908 "Add or remove TAG for each entry in the region.
11909 This works in the agenda, and also in an org-mode buffer."
11910 (interactive
11911 (list (region-beginning) (region-end)
11912 (let ((org-last-tags-completion-table
11913 (if (org-mode-p)
11914 (org-get-buffer-tags)
11915 (org-global-tags-completion-table))))
11916 (org-icompleting-read
11917 "Tag: " 'org-tags-completion-function nil nil nil
11918 'org-tags-history))
11919 (progn
11920 (message "[s]et or [r]emove? ")
11921 (equal (read-char-exclusive) ?r))))
11922 (if (fboundp 'deactivate-mark) (deactivate-mark))
11923 (let ((agendap (equal major-mode 'org-agenda-mode))
11924 l1 l2 m buf pos newhead (cnt 0))
11925 (goto-char end)
11926 (setq l2 (1- (org-current-line)))
11927 (goto-char beg)
11928 (setq l1 (org-current-line))
11929 (loop for l from l1 to l2 do
11930 (org-goto-line l)
11931 (setq m (get-text-property (point) 'org-hd-marker))
11932 (when (or (and (org-mode-p) (org-on-heading-p))
11933 (and agendap m))
11934 (setq buf (if agendap (marker-buffer m) (current-buffer))
11935 pos (if agendap m (point)))
11936 (with-current-buffer buf
11937 (save-excursion
11938 (save-restriction
11939 (goto-char pos)
11940 (setq cnt (1+ cnt))
11941 (org-toggle-tag tag (if off 'off 'on))
11942 (setq newhead (org-get-heading)))))
11943 (and agendap (org-agenda-change-all-lines newhead m))))
11944 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
11946 (defun org-tags-completion-function (string predicate &optional flag)
11947 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
11948 (confirm (lambda (x) (stringp (car x)))))
11950 (setq s1 (match-string 1 string)
11951 s2 (match-string 2 string))
11952 (setq s1 "" s2 string))
11953 (cond
11954 ((eq flag nil)
11955 ;; try completion
11956 (setq rtn (try-completion s2 ctable confirm))
11957 (if (stringp rtn)
11958 (setq rtn
11959 (concat s1 s2 (substring rtn (length s2))
11960 (if (and org-add-colon-after-tag-completion
11961 (assoc rtn ctable))
11962 ":" ""))))
11963 rtn)
11964 ((eq flag t)
11965 ;; all-completions
11966 (all-completions s2 ctable confirm)
11967 )
11968 ((eq flag 'lambda)
11969 ;; exact match?
11970 (assoc s2 ctable)))
11971 ))
11973 (defun org-fast-tag-insert (kwd tags face &optional end)
11974 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
11975 (insert (format "%-12s" (concat kwd ":"))
11976 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
11977 (or end "")))
11979 (defun org-fast-tag-show-exit (flag)
11980 (save-excursion
11981 (org-goto-line 3)
11983 (replace-match ""))
11984 (when flag
11985 (end-of-line 1)
11986 (org-move-to-column (- (window-width) 19) t)
11987 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
11989 (defun org-set-current-tags-overlay (current prefix)
11990 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
11991 (if (featurep 'xemacs)
11992 (org-overlay-display org-tags-overlay (concat prefix s)
11993 'secondary-selection)
11994 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
11995 (org-overlay-display org-tags-overlay (concat prefix s)))))
11997 (defvar org-last-tag-selection-key nil)
11998 (defun org-fast-tag-selection (current inherited table &optional todo-table)
11999 "Fast tag selection with single keys.
12000 CURRENT is the current list of tags in the headline, INHERITED is the
12001 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
12002 possibly with grouping information. TODO-TABLE is a similar table with
12003 TODO keywords, should these have keys assigned to them.
12004 If the keys are nil, a-z are automatically assigned.
12005 Returns the new tags string, or nil to not change the current settings."
12006 (let* ((fulltable (append table todo-table))
12007 (maxlen (apply 'max (mapcar
12008 (lambda (x)
12009 (if (stringp (car x)) (string-width (car x)) 0))
12010 fulltable)))
12011 (buf (current-buffer))
12012 (expert (eq org-fast-tag-selection-single-key 'expert))
12013 (buffer-tags nil)
12014 (fwidth (+ maxlen 3 1 3))
12015 (ncol (/ (- (window-width) 4) fwidth))
12016 (i-face 'org-done)
12017 (c-face 'org-todo)
12018 tg cnt e c char c1 c2 ntable tbl rtn
12019 ov-start ov-end ov-prefix
12020 (exit-after-next org-fast-tag-selection-single-key)
12021 (done-keywords org-done-keywords)
12022 groups ingroup)
12023 (save-excursion
12024 (beginning-of-line 1)
12025 (if (looking-at
12027 (setq ov-start (match-beginning 1)
12028 ov-end (match-end 1)
12029 ov-prefix "")
12030 (setq ov-start (1- (point-at-eol))
12031 ov-end (1+ ov-start))
12033 (setq ov-prefix
12034 (concat
12035 (buffer-substring (1- (point)) (point))
12036 (if (> (current-column) org-tags-column)
12037 " "
12038 (make-string (- org-tags-column (current-column)) ?\ ))))))
12039 (org-move-overlay org-tags-overlay ov-start ov-end)
12040 (save-window-excursion
12041 (if expert
12042 (set-buffer (get-buffer-create " *Org tags*"))
12043 (delete-other-windows)
12044 (split-window-vertically)
12045 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
12046 (erase-buffer)
12047 (org-set-local 'org-done-keywords done-keywords)
12050 (org-fast-tag-show-exit exit-after-next)
12051 (org-set-current-tags-overlay current ov-prefix)
12052 (setq tbl fulltable char ?a cnt 0)
12053 (while (setq e (pop tbl))
12054 (cond
12055 ((equal (car e) :startgroup)
12056 (push '() groups) (setq ingroup t)
12057 (when (not (= cnt 0))
12058 (setq cnt 0)
12060 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
12061 ((equal (car e) :endgroup)
12062 (setq ingroup nil cnt 0)
12064 ((equal e '(:newline))
12065 (when (not (= cnt 0))
12066 (setq cnt 0)
12068 (setq e (car tbl))
12069 (while (equal (car tbl) '(:newline))
12071 (setq tbl (cdr tbl)))))
12072 (t
12073 (setq tg (copy-sequence (car e)) c2 nil)
12074 (if (cdr e)
12075 (setq c (cdr e))
12076 ;; automatically assign a character.
12077 (setq c1 (string-to-char
12078 (downcase (substring
12079 tg (if (= (string-to-char tg) ?@) 1 0)))))
12080 (if (or (rassoc c1 ntable) (rassoc c1 table))
12081 (while (or (rassoc char ntable) (rassoc char table))
12082 (setq char (1+ char)))
12083 (setq c2 c1))
12084 (setq c (or c2 char)))
12085 (if ingroup (push tg (car groups)))
12086 (setq tg (org-add-props tg nil 'face
12087 (cond
12088 ((not (assoc tg table))
12089 (org-get-todo-face tg))
12090 ((member tg current) c-face)
12091 ((member tg inherited) i-face)
12092 (t nil))))
12093 (if (and (= cnt 0) (not ingroup)) (insert " "))
12094 (insert "[" c "] " tg (make-string
12095 (- fwidth 4 (length tg)) ?\ ))
12096 (push (cons tg c) ntable)
12097 (when (= (setq cnt (1+ cnt)) ncol)
12099 (if ingroup (insert " "))
12100 (setq cnt 0)))))
12101 (setq ntable (nreverse ntable))
12103 (goto-char (point-min))
12104 (if (not expert) (org-fit-window-to-buffer))
12105 (setq rtn
12106 (catch 'exit
12107 (while t
12108 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
12109 (if (not groups) "no " "")
12110 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
12111 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12112 (setq org-last-tag-selection-key c)
12113 (cond
12115 ((= c ?!)
12116 (setq groups (not groups))
12117 (goto-char (point-min))
12118 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
12119 ((= c ?\C-c)
12120 (if (not expert)
12121 (org-fast-tag-show-exit
12122 (setq exit-after-next (not exit-after-next)))
12123 (setq expert nil)
12124 (delete-other-windows)
12125 (split-window-vertically)
12126 (org-switch-to-buffer-other-window " *Org tags*")
12127 (org-fit-window-to-buffer)))
12128 ((or (= c ?\C-g)
12129 (and (= c ?q) (not (rassoc c ntable))))
12130 (org-detach-overlay org-tags-overlay)
12131 (setq quit-flag t))
12132 ((= c ?\ )
12133 (setq current nil)
12134 (if exit-after-next (setq exit-after-next 'now)))
12136 (condition-case nil
12137 (setq tg (org-icompleting-read
12138 "Tag: "
12139 (or buffer-tags
12140 (with-current-buffer buf
12141 (org-get-buffer-tags)))))
12142 (quit (setq tg "")))
12144 (add-to-list 'buffer-tags (list tg))
12145 (if (member tg current)
12146 (setq current (delete tg current))
12147 (push tg current)))
12148 (if exit-after-next (setq exit-after-next 'now)))
12149 ((setq e (rassoc c todo-table) tg (car e))
12150 (with-current-buffer buf
12151 (save-excursion (org-todo tg)))
12152 (if exit-after-next (setq exit-after-next 'now)))
12153 ((setq e (rassoc c ntable) tg (car e))
12154 (if (member tg current)
12155 (setq current (delete tg current))
12156 (loop for g in groups do
12157 (if (member tg g)
12158 (mapc (lambda (x)
12159 (setq current (delete x current)))
12160 g)))
12161 (push tg current))
12162 (if exit-after-next (setq exit-after-next 'now))))
12164 ;; Create a sorted list
12165 (setq current
12166 (sort current
12167 (lambda (a b)
12168 (assoc b (cdr (memq (assoc a ntable) ntable))))))
12169 (if (eq exit-after-next 'now) (throw 'exit t))
12170 (goto-char (point-min))
12171 (beginning-of-line 2)
12172 (delete-region (point) (point-at-eol))
12173 (org-fast-tag-insert "Current" current c-face)
12174 (org-set-current-tags-overlay current ov-prefix)
12175 (while (re-search-forward
12177 (setq tg (match-string 1))
12178 (add-text-properties
12179 (match-beginning 1) (match-end 1)
12180 (list 'face
12181 (cond
12182 ((member tg current) c-face)
12183 ((member tg inherited) i-face)
12184 (t (get-text-property (match-beginning 1) 'face))))))
12185 (goto-char (point-min)))))
12186 (org-detach-overlay org-tags-overlay)
12187 (if rtn
12188 (mapconcat 'identity current ":")
12189 nil))))
12191 (defun org-get-tags-string ()
12192 "Get the TAGS string in the current headline."
12193 (unless (org-on-heading-p t)
12194 (error "Not on a heading"))
12195 (save-excursion
12196 (beginning-of-line 1)
12198 (org-match-string-no-properties 1)
12199 "")))
12201 (defun org-get-tags ()
12202 "Get the list of tags specified in the current headline."
12203 (org-split-string (org-get-tags-string) ":"))
12205 (defun org-get-buffer-tags ()
12206 "Get a table of all tags used in the buffer, for completion."
12207 (let (tags)
12208 (save-excursion
12209 (goto-char (point-min))
12210 (while (re-search-forward
12212 (when (equal (char-after (point-at-bol 0)) ?*)
12213 (mapc (lambda (x) (add-to-list 'tags x))
12214 (org-split-string (org-match-string-no-properties 1) ":")))))
12215 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
12216 (mapcar 'list tags)))
12218 ;;;; The mapping API
12220 ;;;###autoload
12221 (defun org-map-entries (func &optional match scope &rest skip)
12222 "Call FUNC at each headline selected by MATCH in SCOPE.
12224 FUNC is a function or a lisp form. The function will be called without
12225 arguments, with the cursor positioned at the beginning of the headline.
12226 The return values of all calls to the function will be collected and
12227 returned as a list.
12229 The call to FUNC will be wrapped into a save-excursion form, so FUNC
12230 does not need to preserve point. After evaluation, the cursor will be
12231 moved to the end of the line (presumably of the headline of the
12232 processed entry) and search continues from there. Under some
12233 circumstances, this may not produce the wanted results. For example,
12234 if you have removed (e.g. archived) the current (sub)tree it could
12235 mean that the next entry will be skipped entirely. In such cases, you
12236 can specify the position from where search should continue by making
12237 FUNC set the variable `org-map-continue-from' to the desired buffer
12238 position.
12240 MATCH is a tags/property/todo match as it is used in the agenda tags view.
12241 Only headlines that are matched by this query will be considered during
12242 the iteration. When MATCH is nil or t, all headlines will be
12243 visited by the iteration.
12245 SCOPE determines the scope of this command. It can be any of:
12247 nil The current buffer, respecting the restriction if any
12248 tree The subtree started with the entry at point
12249 file The current buffer, without restriction
12250 file-with-archives
12251 The current buffer, and any archives associated with it
12252 agenda All agenda files
12253 agenda-with-archives
12254 All agenda files with any archive files associated with them
12255 \(file1 file2 ...)
12256 If this is a list, all files in the list will be scanned
12258 The remaining args are treated as settings for the skipping facilities of
12259 the scanner. The following items can be given here:
12261 archive skip trees with the archive tag.
12262 comment skip trees with the COMMENT keyword
12263 function or Emacs Lisp form:
12264 will be used as value for `org-agenda-skip-function', so whenever
12265 the function returns t, FUNC will not be called for that
12266 entry and search will continue from the point where the
12267 function leaves it.
12269 If your function needs to retrieve the tags including inherited tags
12270 at the *current* entry, you can use the value of the variable
12271 `org-scanner-tags' which will be much faster than getting the value
12272 with `org-get-tags-at'. If your function gets properties with
12273 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
12274 to t around the call to `org-entry-properties' to get the same speedup.
12275 Note that if your function moves around to retrieve tags and properties at
12276 a *different* entry, you cannot use these techniques."
12277 (let* ((org-agenda-archives-mode nil) ; just to make sure
12278 (org-agenda-skip-archived-trees (memq 'archive skip))
12279 (org-agenda-skip-comment-trees (memq 'comment skip))
12280 (org-agenda-skip-function
12281 (car (org-delete-all '(comment archive) skip)))
12282 (org-tags-match-list-sublevels t)
12283 matcher file res
12284 org-todo-keywords-for-agenda
12285 org-done-keywords-for-agenda
12286 org-todo-keyword-alist-for-agenda
12287 org-drawers-for-agenda
12288 org-tag-alist-for-agenda)
12290 (cond
12291 ((eq match t) (setq matcher t))
12292 ((eq match nil) (setq matcher t))
12293 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
12295 (save-excursion
12296 (save-restriction
12297 (when (eq scope 'tree)
12298 (org-back-to-heading t)
12299 (org-narrow-to-subtree)
12300 (setq scope nil))
12302 (if (not scope)
12303 (progn
12304 (org-prepare-agenda-buffers
12305 (list (buffer-file-name (current-buffer))))
12306 (setq res (org-scan-tags func matcher)))
12307 ;; Get the right scope
12308 (cond
12309 ((and scope (listp scope) (symbolp (car scope)))
12310 (setq scope (eval scope)))
12311 ((eq scope 'agenda)
12312 (setq scope (org-agenda-files t)))
12313 ((eq scope 'agenda-with-archives)
12314 (setq scope (org-agenda-files t))
12315 (setq scope (org-add-archive-files scope)))
12316 ((eq scope 'file)
12317 (setq scope (list (buffer-file-name))))
12318 ((eq scope 'file-with-archives)
12319 (setq scope (org-add-archive-files (list (buffer-file-name))))))
12320 (org-prepare-agenda-buffers scope)
12321 (while (setq file (pop scope))
12322 (with-current-buffer (org-find-base-buffer-visiting file)
12323 (save-excursion
12324 (save-restriction
12325 (widen)
12326 (goto-char (point-min))
12327 (setq res (append res (org-scan-tags func matcher))))))))))
12328 res))
12330 ;;;; Properties
12332 ;;; Setting and retrieving properties
12334 (defconst org-special-properties
12335 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
12336 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED")
12337 "The special properties valid in Org-mode.
12339 These are properties that are not defined in the property drawer,
12340 but in some other way.")
12342 (defconst org-default-properties
12343 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
12344 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
12345 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
12346 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
12347 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER"
12348 "CLOCK_MODELINE_TOTAL" "STYLE")
12349 "Some properties that are used by Org-mode for various purposes.
12350 Being in this list makes sure that they are offered for completion.")
12353 "Regular expression matching the first line of a property drawer.")
12356 "Regular expression matching the first line of a property drawer.")
12359 "Regular expression matching the first line of a property drawer.")
12362 "Regular expression matching the first line of a property drawer.")
12364 (defconst org-property-drawer-re
12367 "Matches an entire property drawer.")
12369 (defconst org-clock-drawer-re
12372 "Matches an entire clock drawer.")
12374 (defun org-property-action ()
12375 "Do an action on properties."
12376 (interactive)
12377 (let (c)
12378 (org-at-property-p)
12379 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
12380 (setq c (read-char-exclusive))
12381 (cond
12382 ((equal c ?s)
12383 (call-interactively 'org-set-property))
12384 ((equal c ?d)
12385 (call-interactively 'org-delete-property))
12386 ((equal c ?D)
12387 (call-interactively 'org-delete-property-globally))
12388 ((equal c ?c)
12389 (call-interactively 'org-compute-property-at-point))
12390 (t (error "No such property action %c" c)))))
12392 (defun org-set-effort (&optional value)
12393 "Set the effort property of the current entry.
12394 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
12395 allowed value."
12396 (interactive "P")
12397 (if (equal value 0) (setq value 10))
12398 (let* ((completion-ignore-case t)
12399 (prop org-effort-property)
12400 (cur (org-entry-get nil prop))
12401 (allowed (org-property-get-allowed-values nil prop 'table))
12402 (existing (mapcar 'list (org-property-values prop)))
12403 rpl
12404 (val (cond
12405 ((stringp value) value)
12406 ((and allowed (integerp value))
12407 (or (car (nth (1- value) allowed))
12408 (car (org-last allowed))))
12409 (allowed
12410 (message "Select 1-9,0, [RET%s]: %s"
12411 (if cur (concat "=" cur) "")
12412 (mapconcat 'car allowed " "))
12413 (setq rpl (read-char-exclusive))
12415 cur
12416 (setq rpl (- rpl ?0))
12417 (if (equal rpl 0) (setq rpl 10))
12418 (if (and (> rpl 0) (<= rpl (length allowed)))
12419 (car (nth (1- rpl) allowed))
12420 (org-completing-read "Effort: " allowed nil))))
12421 (t
12422 (let (org-completion-use-ido org-completion-use-iswitchb)
12423 (org-completing-read
12425 (concat "[" cur "]") "")
12426 ": ")
12427 existing nil nil "" nil cur))))))
12428 (unless (equal (org-entry-get nil prop) val)
12429 (org-entry-put nil prop val))
12430 (message "%s is now %s" prop val)))
12432 (defun org-at-property-p ()
12433 "Is the cursor in a property line?"
12434 ;; FIXME: Does not check if we are actually in the drawer.
12435 ;; FIXME: also returns true on any drawers.....
12436 ;; This is used by C-c C-c for property action.
12437 (save-excursion
12438 (beginning-of-line 1)
12441 (defun org-get-property-block (&optional beg end force)
12442 "Return the (beg . end) range of the body of the property drawer.
12443 BEG and END can be beginning and end of subtree, if not given
12444 they will be found.
12445 If the drawer does not exist and FORCE is non-nil, create the drawer."
12446 (catch 'exit
12447 (save-excursion
12448 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
12449 (end (or end (progn (outline-next-heading) (point)))))
12450 (goto-char beg)
12451 (if (re-search-forward org-property-start-re end t)
12452 (setq beg (1+ (match-end 0)))
12453 (if force
12454 (save-excursion
12455 (org-insert-property-drawer)
12456 (setq end (progn (outline-next-heading) (point))))
12457 (throw 'exit nil))
12458 (goto-char beg)
12459 (if (re-search-forward org-property-start-re end t)
12460 (setq beg (1+ (match-end 0)))))
12461 (if (re-search-forward org-property-end-re end t)
12462 (setq end (match-beginning 0))
12463 (or force (throw 'exit nil))
12464 (goto-char beg)
12465 (setq end beg)
12466 (org-indent-line-function)
12468 (cons beg end)))))
12470 (defun org-entry-properties (&optional pom which specific)
12471 "Get all properties of the entry at point-or-marker POM.
12472 This includes the TODO keyword, the tags, time strings for deadline,
12473 scheduled, and clocking, and any additional properties defined in the
12474 entry. The return value is an alist, keys may occur multiple times
12475 if the property key was used several times.
12476 POM may also be nil, in which case the current entry is used.
12477 If WHICH is nil or `all', get all properties. If WHICH is
12478 `special' or `standard', only get that subclass. If WHICH
12479 is a string only get exactly this property. Specific can be a sting, the
12480 specific property we are interested in. Specifying it can speed
12481 things up because then unnecessary parsing is avoided."
12482 (setq which (or which 'all))
12483 (org-with-point-at pom
12484 (let ((clockstr (substring org-clock-string 0 -1))
12485 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY"))
12486 beg end range props sum-props key value string clocksum)
12487 (save-excursion
12488 (when (condition-case nil
12489 (and (org-mode-p) (org-back-to-heading t))
12490 (error nil))
12491 (setq beg (point))
12492 (setq sum-props (get-text-property (point) 'org-summaries))
12493 (setq clocksum (get-text-property (point) :org-clock-minutes))
12494 (outline-next-heading)
12495 (setq end (point))
12496 (when (memq which '(all special))
12497 ;; Get the special properties, like TODO and tags
12498 (goto-char beg)
12499 (when (and (or (not specific) (string= specific "TODO"))
12500 (looking-at org-todo-line-regexp) (match-end 2))
12501 (push (cons "TODO" (org-match-string-no-properties 2)) props))
12502 (when (and (or (not specific) (string= specific "PRIORITY"))
12503 (looking-at org-priority-regexp))
12504 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
12505 (when (and (or (not specific) (string= specific "TAGS"))
12506 (setq value (org-get-tags-string))
12508 (push (cons "TAGS" value) props))
12509 (when (and (or (not specific) (string= specific "TAGS"))
12510 (setq value (org-get-tags-at)))
12511 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
12512 ":"))
12513 props))
12514 (when (or (not specific) (string= specific "TAGS"))
12515 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
12516 (when (or (not specific)
12517 (member specific org-all-time-keywords)
12518 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
12519 (while (re-search-forward org-maybe-keyword-time-regexp end t)
12520 (setq key (if (match-end 1) (substring (org-match-string-no-properties 1) 0 -1))
12521 string (if (equal key clockstr)
12522 (org-no-properties
12523 (org-trim
12524 (buffer-substring
12525 (match-beginning 3) (goto-char (point-at-eol)))))
12526 (substring (org-match-string-no-properties 3) 1 -1)))
12527 (unless key
12528 (if (= (char-after (match-beginning 3)) ?\[)
12529 (setq key "TIMESTAMP_IA")
12530 (setq key "TIMESTAMP")))
12531 (when (or (equal key clockstr) (not (assoc key props)))
12532 (push (cons key string) props))))
12534 )
12536 (when (memq which '(all standard))
12537 ;; Get the standard properties, like :PROP: ...
12538 (setq range (org-get-property-block beg end))
12539 (when range
12540 (goto-char (car range))
12541 (while (re-search-forward
12543 (cdr range) t)
12544 (setq key (org-match-string-no-properties 1)
12545 value (org-trim (or (org-match-string-no-properties 2) "")))
12546 (unless (member key excluded)
12547 (push (cons key (or value "")) props)))))
12548 (if clocksum
12549 (push (cons "CLOCKSUM"
12550 (org-columns-number-to-string (/ (float clocksum) 60.)
12551 'add_times))
12552 props))
12553 (unless (assoc "CATEGORY" props)
12554 (setq value (or (org-get-category)
12555 (progn (org-refresh-category-properties)
12556 (org-get-category))))
12557 (push (cons "CATEGORY" value) props))
12558 (append sum-props (nreverse props)))))))
12560 (defun org-entry-get (pom property &optional inherit)
12561 "Get value of PROPERTY for entry at point-or-marker POM.
12562 If INHERIT is non-nil and the entry does not have the property,
12563 then also check higher levels of the hierarchy.
12564 If INHERIT is the symbol `selective', use inheritance only if the setting
12565 in `org-use-property-inheritance' selects PROPERTY for inheritance.
12566 If the property is present but empty, the return value is the empty string.
12567 If the property is not present at all, nil is returned."
12568 (org-with-point-at pom
12569 (if (and inherit (if (eq inherit 'selective)
12570 (org-property-inherit-p property)
12571 t))
12572 (org-entry-get-with-inheritance property)
12573 (if (member property org-special-properties)
12574 ;; We need a special property. Use `org-entry-properties' to
12575 ;; retrieve it, but specify the wanted property
12576 (cdr (assoc property (org-entry-properties nil 'special property)))
12577 (let ((range (org-get-property-block)))
12578 (if (and range
12579 (goto-char (car range))
12580 (re-search-forward
12582 (cdr range) t))
12583 ;; Found the property, return it.
12584 (if (match-end 1)
12585 (org-match-string-no-properties 1)
12586 "")))))))
12588 (defun org-property-or-variable-value (var &optional inherit)
12589 "Check if there is a property fixing the value of VAR.
12590 If yes, return this value. If not, return the current value of the variable."
12591 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
12593 (read prop)
12594 (symbol-value var))))
12596 (defun org-entry-delete (pom property)
12597 "Delete the property PROPERTY from entry at point-or-marker POM."
12598 (org-with-point-at pom
12599 (if (member property org-special-properties)
12600 nil ; cannot delete these properties.
12601 (let ((range (org-get-property-block)))
12602 (if (and range
12603 (goto-char (car range))
12604 (re-search-forward
12606 (cdr range) t))
12607 (progn
12608 (delete-region (match-beginning 0) (1+ (point-at-eol)))
12609 t)
12610 nil)))))
12612 ;; Multi-values properties are properties that contain multiple values
12613 ;; These values are assumed to be single words, separated by whitespace.
12614 (defun org-entry-add-to-multivalued-property (pom property value)
12615 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
12616 (let* ((old (org-entry-get pom property))
12618 (setq value (org-entry-protect-space value))
12619 (unless (member value values)
12620 (setq values (cons value values))
12621 (org-entry-put pom property
12622 (mapconcat 'identity values " ")))))
12624 (defun org-entry-remove-from-multivalued-property (pom property value)
12625 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
12626 (let* ((old (org-entry-get pom property))
12628 (setq value (org-entry-protect-space value))
12629 (when (member value values)
12630 (setq values (delete value values))
12631 (org-entry-put pom property
12632 (mapconcat 'identity values " ")))))
12634 (defun org-entry-member-in-multivalued-property (pom property value)
12635 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
12636 (let* ((old (org-entry-get pom property))
12638 (setq value (org-entry-protect-space value))
12639 (member value values)))
12641 (defun org-entry-get-multivalued-property (pom property)
12642 "Return a list of values in a multivalued property."
12643 (let* ((value (org-entry-get pom property))
12645 (mapcar 'org-entry-restore-space values)))
12647 (defun org-entry-put-multivalued-property (pom property &rest values)
12648 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
12649 VALUES should be a list of strings. Spaces will be protected."
12650 (org-entry-put pom property
12651 (mapconcat 'org-entry-protect-space values " "))
12652 (let* ((value (org-entry-get pom property))
12654 (mapcar 'org-entry-restore-space values)))
12656 (defun org-entry-protect-space (s)
12657 "Protect spaces and newline in string S."
12658 (while (string-match " " s)
12659 (setq s (replace-match "%20" t t s)))
12661 (setq s (replace-match "%0A" t t s)))
12662 s)
12664 (defun org-entry-restore-space (s)
12665 "Restore spaces and newline in string S."
12666 (while (string-match "%20" s)
12667 (setq s (replace-match " " t t s)))
12668 (while (string-match "%0A" s)
12670 s)
12672 (defvar org-entry-property-inherited-from (make-marker)
12673 "Marker pointing to the entry from where a property was inherited.
12674 Each call to `org-entry-get-with-inheritance' will set this marker to the
12675 location of the entry where the inheritance search matched. If there was
12676 no match, the marker will point nowhere.
12677 Note that also `org-entry-get' calls this function, if the INHERIT flag
12678 is set.")
12680 (defun org-entry-get-with-inheritance (property)
12681 "Get entry property, and search higher levels if not present."
12682 (move-marker org-entry-property-inherited-from nil)
12683 (let (tmp)
12684 (save-excursion
12685 (save-restriction
12686 (widen)
12687 (catch 'ex
12688 (while t
12689 (when (setq tmp (org-entry-get nil property))
12690 (org-back-to-heading t)
12691 (move-marker org-entry-property-inherited-from (point))
12692 (throw 'ex tmp))
12693 (or (org-up-heading-safe) (throw 'ex nil)))))
12694 (or tmp
12695 (cdr (assoc property org-file-properties))
12696 (cdr (assoc property org-global-properties))
12697 (cdr (assoc property org-global-properties-fixed))))))
12699 (defvar org-property-changed-functions nil
12700 "Hook called when the value of a property has changed.
12701 Each hook function should accept two arguments, the name of the property
12702 and the new value.")
12704 (defun org-entry-put (pom property value)
12705 "Set PROPERTY to VALUE for entry at point-or-marker POM."
12706 (org-with-point-at pom
12707 (org-back-to-heading t)
12708 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
12709 range)
12710 (cond
12711 ((equal property "TODO")
12713 (not (member value org-todo-keywords-1)))
12715 (if (or (not value)
12717 (setq value 'none))
12718 (org-todo value)
12719 (org-set-tags nil 'align))
12720 ((equal property "PRIORITY")
12722 (string-to-char value) ?\ ))
12723 (org-set-tags nil 'align))
12724 ((equal property "SCHEDULED")
12725 (if (re-search-forward org-scheduled-time-regexp end t)
12726 (cond
12727 ((eq value 'earlier) (org-timestamp-change -1 'day))
12728 ((eq value 'later) (org-timestamp-change 1 'day))
12729 (t (call-interactively 'org-schedule)))
12730 (call-interactively 'org-schedule)))
12731 ((equal property "DEADLINE")
12732 (if (re-search-forward org-deadline-time-regexp end t)
12733 (cond
12734 ((eq value 'earlier) (org-timestamp-change -1 'day))
12735 ((eq value 'later) (org-timestamp-change 1 'day))
12736 (t (call-interactively 'org-deadline)))
12737 (call-interactively 'org-deadline)))
12738 ((member property org-special-properties)
12739 (error "The %s property can not yet be set with `org-entry-put'"
12740 property))
12741 (t ; a non-special property
12742 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
12743 (setq range (org-get-property-block beg end 'force))
12744 (goto-char (car range))
12745 (if (re-search-forward
12747 (progn
12748 (delete-region (match-beginning 1) (match-end 1))
12749 (goto-char (match-beginning 1)))
12750 (goto-char (cdr range))
12752 (backward-char 1)
12753 (org-indent-line-function)
12754 (insert ":" property ":"))
12755 (and value (insert " " value))
12756 (org-indent-line-function)))))
12757 (run-hook-with-args 'org-property-changed-functions property value)))
12759 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
12760 "Get all property keys in the current buffer.
12761 With INCLUDE-SPECIALS, also list the special properties that reflect things
12762 like tags and TODO state.
12763 With INCLUDE-DEFAULTS, also include properties that has special meaning
12764 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
12765 With INCLUDE-COLUMNS, also include property names given in COLUMN
12766 formats in the current buffer."
12767 (let (rtn range cfmt s p)
12768 (save-excursion
12769 (save-restriction
12770 (widen)
12771 (goto-char (point-min))
12772 (while (re-search-forward org-property-start-re nil t)
12773 (setq range (org-get-property-block))
12774 (goto-char (car range))
12775 (while (re-search-forward
12777 (cdr range) t)
12778 (add-to-list 'rtn (org-match-string-no-properties 1)))
12779 (outline-next-heading))))
12781 (when include-specials
12782 (setq rtn (append org-special-properties rtn)))
12784 (when include-defaults
12785 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
12786 (add-to-list 'rtn org-effort-property))
12788 (when include-columns
12789 (save-excursion
12790 (save-restriction
12791 (widen)
12792 (goto-char (point-min))
12793 (while (re-search-forward
12795 nil t)
12796 (setq cfmt (match-string 2) s 0)
12798 cfmt s)
12799 (setq s (match-end 0)
12800 p (match-string 1 cfmt))
12801 (unless (or (equal p "ITEM")
12802 (member p org-special-properties))
12803 (add-to-list 'rtn (match-string 1 cfmt))))))))
12805 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
12807 (defun org-property-values (key)
12808 "Return a list of all values of property KEY."
12809 (save-excursion
12810 (save-restriction
12811 (widen)
12812 (goto-char (point-min))
12814 values)
12815 (while (re-search-forward re nil t)
12816 (add-to-list 'values (org-trim (match-string 1))))
12817 (delete "" values)))))
12819 (defun org-insert-property-drawer ()
12820 "Insert a property drawer into the current entry."
12821 (interactive)
12822 (org-back-to-heading t)
12823 (looking-at outline-regexp)
12824 (let ((indent (if org-adapt-indentation
12825 (- (match-end 0)(match-beginning 0))
12826 0))
12827 (beg (point))
12829 end hiddenp)
12830 (outline-next-heading)
12831 (setq end (point))
12832 (goto-char beg)
12833 (while (re-search-forward re end t))
12834 (setq hiddenp (org-invisible-p))
12835 (end-of-line 1)
12838 (if (member (match-string 1) '("CLOCK:" ":END:"))
12839 ;; just skip this line
12840 (beginning-of-line 2)
12841 ;; Drawer start, find the end
12843 (beginning-of-line 1)))
12844 (org-skip-over-state-notes)
12846 (if (eq (char-before) ?*) (forward-char 1))
12848 (beginning-of-line 0)
12849 (org-indent-to-column indent)
12850 (beginning-of-line 2)
12851 (org-indent-to-column indent)
12852 (beginning-of-line 0)
12853 (if hiddenp
12854 (save-excursion
12855 (org-back-to-heading t)
12856 (hide-entry))
12857 (org-flag-drawer t))))
12859 (defun org-set-property (property value)
12860 "In the current entry, set PROPERTY to VALUE.
12861 When called interactively, this will prompt for a property name, offering
12862 completion on existing and default properties. And then it will prompt
12863 for a value, offering completion either on allowed values (via an inherited
12864 xxx_ALL property) or on existing values in other instances of this property
12865 in the current file."
12866 (interactive
12867 (let* ((completion-ignore-case t)
12868 (keys (org-buffer-property-keys nil t t))
12869 (prop0 (org-icompleting-read "Property: " (mapcar 'list keys)))
12870 (prop (if (member prop0 keys)
12871 prop0
12872 (or (cdr (assoc (downcase prop0)
12873 (mapcar (lambda (x) (cons (downcase x) x))
12874 keys)))
12875 prop0)))
12876 (cur (org-entry-get nil prop))
12877 (allowed (org-property-get-allowed-values nil prop 'table))
12878 (existing (mapcar 'list (org-property-values prop)))
12879 (val (if allowed
12880 (org-completing-read "Value: " allowed nil
12881 (not (get-text-property 0 'org-unrestricted
12882 (caar allowed))))
12883 (let (org-completion-use-ido org-completion-use-iswitchb)
12884 (org-completing-read
12886 (concat "[" cur "]") "")
12887 ": ")
12888 existing nil nil "" nil cur)))))
12889 (list prop (if (equal val "") cur val))))
12890 (unless (equal (org-entry-get nil property) value)
12891 (org-entry-put nil property value)))
12893 (defun org-delete-property (property)
12894 "In the current entry, delete PROPERTY."
12895 (interactive
12896 (let* ((completion-ignore-case t)
12897 (prop (org-icompleting-read
12898 "Property: " (org-entry-properties nil 'standard))))
12899 (list prop)))
12900 (message "Property %s %s" property
12901 (if (org-entry-delete nil property)
12902 "deleted"
12903 "was not present in the entry")))
12905 (defun org-delete-property-globally (property)
12906 "Remove PROPERTY globally, from all entries."
12907 (interactive
12908 (let* ((completion-ignore-case t)
12909 (prop (org-icompleting-read
12910 "Globally remove property: "
12911 (mapcar 'list (org-buffer-property-keys)))))
12912 (list prop)))
12913 (save-excursion
12914 (save-restriction
12915 (widen)
12916 (goto-char (point-min))
12917 (let ((cnt 0))
12918 (while (re-search-forward
12920 nil t)
12921 (setq cnt (1+ cnt))
12922 (replace-match ""))
12925 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
12927 (defun org-compute-property-at-point ()
12928 "Compute the property at point.
12929 This looks for an enclosing column format, extracts the operator and
12930 then applies it to the property in the column format's scope."
12931 (interactive)
12932 (unless (org-at-property-p)
12933 (error "Not at a property"))
12934 (let ((prop (org-match-string-no-properties 2)))
12935 (org-columns-get-format-and-top-level)
12936 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
12937 (error "No operator defined for property %s" prop))
12938 (org-columns-compute prop)))
12940 (defvar org-property-allowed-value-functions nil
12941 "Hook for functions supplying allowed values for specific.
12942 The functions must take a single argument, the name of the property, and
12944 the values, this means that these values are intended as defaults for
12945 completion, but that other values should be allowed too.
12946 The functions must return nil if they are now responsible for this
12947 prioerty.")
12949 (defun org-property-get-allowed-values (pom property &optional table)
12950 "Get allowed values for the property PROPERTY.
12951 When TABLE is non-nil, return an alist that can directly be used for
12952 completion."
12953 (let (vals)
12954 (cond
12955 ((equal property "TODO")
12956 (setq vals (org-with-point-at pom
12957 (append org-todo-keywords-1 '("")))))
12958 ((equal property "PRIORITY")
12959 (let ((n org-lowest-priority))
12960 (while (>= n org-highest-priority)
12961 (push (char-to-string n) vals)
12962 (setq n (1- n)))))
12963 ((member property org-special-properties))
12964 ((setq vals (run-hook-with-args-until-success
12965 'org-property-allowed-value-functions property)))
12966 (t
12967 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
12969 (setq vals (car (read-from-string (concat "(" vals ")"))))
12970 (setq vals (mapcar (lambda (x)
12971 (cond ((stringp x) x)
12972 ((numberp x) (number-to-string x))
12973 ((symbolp x) (symbol-name x))
12974 (t "???")))
12975 vals)))))
12976 (when (member ":ETC" vals)
12977 (setq vals (remove ":ETC" vals))
12978 (org-add-props (car vals) '(org-unrestricted t)))
12979 (if table (mapcar 'list vals) vals)))
12981 (defun org-property-previous-allowed-value (&optional previous)
12982 "Switch to the next allowed value for this property."
12983 (interactive)
12984 (org-property-next-allowed-value t))
12986 (defun org-property-next-allowed-value (&optional previous)
12987 "Switch to the next allowed value for this property."
12988 (interactive)
12989 (unless (org-at-property-p)
12990 (error "Not at a property"))
12991 (let* ((key (match-string 2))
12992 (value (match-string 3))
12993 (allowed (or (org-property-get-allowed-values (point) key)
12994 (and (member value '("[ ]" "[-]" "[X]"))
12995 '("[ ]" "[X]"))))
12996 nval)
12997 (unless allowed
12998 (error "Allowed values for this property have not been defined"))
12999 (if previous (setq allowed (reverse allowed)))
13000 (if (member value allowed)
13001 (setq nval (car (cdr (member value allowed)))))
13002 (setq nval (or nval (car allowed)))
13003 (if (equal nval value)
13004 (error "Only one allowed value for this property"))
13005 (org-at-property-p)
13006 (replace-match (concat " :" key ": " nval) t t)
13007 (org-indent-line-function)
13008 (beginning-of-line 1)
13010 (run-hook-with-args 'org-property-changed-functions key nval)))
13012 (defun org-find-entry-with-id (ident)
13013 "Locate the entry that contains the ID property with exact value IDENT.
13014 IDENT can be a string, a symbol or a number, this function will search for
13015 the string representation of it.
13016 Return the position where this entry starts, or nil if there is no such entry."
13017 (interactive "sID: ")
13018 (let ((id (cond
13019 ((stringp ident) ident)
13020 ((symbol-name ident) (symbol-name ident))
13021 ((numberp ident) (number-to-string ident))
13022 (t (error "IDENT %s must be a string, symbol or number" ident))))
13023 (case-fold-search nil))
13024 (save-excursion
13025 (save-restriction
13026 (widen)
13027 (goto-char (point-min))
13028 (when (re-search-forward
13030 nil t)
13031 (org-back-to-heading t)
13032 (point))))))
13034 ;;;; Timestamps
13036 (defvar org-last-changed-timestamp nil)
13037 (defvar org-last-inserted-timestamp nil
13038 "The last time stamp inserted with `org-insert-time-stamp'.")
13039 (defvar org-time-was-given) ; dynamically scoped parameter
13040 (defvar org-end-time-was-given) ; dynamically scoped parameter
13041 (defvar org-ts-what) ; dynamically scoped parameter
13043 (defun org-time-stamp (arg &optional inactive)
13044 "Prompt for a date/time and insert a time stamp.
13045 If the user specifies a time like HH:MM, or if this command is called
13046 with a prefix argument, the time stamp will contain date and time.
13047 Otherwise, only the date will be included. All parts of a date not
13048 specified by the user will be filled in from the current date/time.
13049 So if you press just return without typing anything, the time stamp
13050 will represent the current date/time. If there is already a timestamp
13051 at the cursor, it will be modified."
13052 (interactive "P")
13053 (let* ((ts nil)
13054 (default-time
13055 ;; Default time is either today, or, when entering a range,
13056 ;; the range start.
13057 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
13058 (save-excursion
13059 (re-search-backward
13061 (- (point) 20) t)))
13062 (apply 'encode-time (org-parse-time-string (match-string 1)))
13063 (current-time)))
13064 (default-input (and ts (org-get-compact-tod ts)))
13065 org-time-was-given org-end-time-was-given time)
13066 (cond
13067 ((and (org-at-timestamp-p t)
13068 (memq last-command '(org-time-stamp org-time-stamp-inactive))
13069 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
13070 (insert "--")
13071 (setq time (let ((this-command this-command))
13072 (org-read-date arg 'totime nil nil
13073 default-time default-input)))
13074 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
13075 ((org-at-timestamp-p t)
13076 (setq time (let ((this-command this-command))
13077 (org-read-date arg 'totime nil nil default-time default-input)))
13078 (when (org-at-timestamp-p t) ; just to get the match data
13079 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
13080 (replace-match "")
13081 (setq org-last-changed-timestamp
13082 (org-insert-time-stamp
13083 time (or org-time-was-given arg)
13084 inactive nil nil (list org-end-time-was-given))))
13085 (message "Timestamp updated"))
13086 (t
13087 (setq time (let ((this-command this-command))
13088 (org-read-date arg 'totime nil nil default-time default-input)))
13089 (org-insert-time-stamp time (or org-time-was-given arg) inactive
13090 nil nil (list org-end-time-was-given))))))
13092 ;; FIXME: can we use this for something else, like computing time differences?
13093 (defun org-get-compact-tod (s)
13094 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
13095 (let* ((t1 (match-string 1 s))
13096 (h1 (string-to-number (match-string 2 s)))
13097 (m1 (string-to-number (match-string 3 s)))
13098 (t2 (and (match-end 4) (match-string 5 s)))
13099 (h2 (and t2 (string-to-number (match-string 6 s))))
13100 (m2 (and t2 (string-to-number (match-string 7 s))))
13101 dh dm)
13102 (if (not t2)
13103 t1
13104 (setq dh (- h2 h1) dm (- m2 m1))
13105 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
13106 (concat t1 "+" (number-to-string dh)
13107 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
13109 (defun org-time-stamp-inactive (&optional arg)
13110 "Insert an inactive time stamp.
13111 An inactive time stamp is enclosed in square brackets instead of angle
13112 brackets. It is inactive in the sense that it does not trigger agenda entries,
13113 does not link to the calendar and cannot be changed with the S-cursor keys.
13114 So these are more for recording a certain time/date."
13115 (interactive "P")
13116 (org-time-stamp arg 'inactive))
13118 (defvar org-date-ovl (org-make-overlay 1 1))
13119 (org-overlay-put org-date-ovl 'face 'org-warning)
13120 (org-detach-overlay org-date-ovl)
13122 (defvar org-ans1) ; dynamically scoped parameter
13123 (defvar org-ans2) ; dynamically scoped parameter
13125 (defvar org-plain-time-of-day-regexp) ; defined below
13127 (defvar org-overriding-default-time nil) ; dynamically scoped
13128 (defvar org-read-date-overlay nil)
13129 (defvar org-dcst nil) ; dynamically scoped
13130 (defvar org-read-date-history nil)
13131 (defvar org-read-date-final-answer nil)
13133 (defun org-read-date (&optional with-time to-time from-string prompt
13134 default-time default-input)
13135 "Read a date, possibly a time, and make things smooth for the user.
13136 The prompt will suggest to enter an ISO date, but you can also enter anything
13137 which will at least partially be understood by `parse-time-string'.
13138 Unrecognized parts of the date will default to the current day, month, year,
13139 hour and minute. If this command is called to replace a timestamp at point,
13140 of to enter the second timestamp of a range, the default time is taken from the
13141 existing stamp. For example,
13142 3-2-5 --> 2003-02-05
13143 feb 15 --> currentyear-02-15
13144 sep 12 9 --> 2009-09-12
13145 12:45 --> today 12:45
13146 22 sept 0:34 --> currentyear-09-22 0:34
13147 12 --> currentyear-currentmonth-12
13148 Fri --> nearest Friday (today or later)
13149 etc.
13151 Furthermore you can specify a relative date by giving, as the *first* thing
13152 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
13153 change in days weeks, months, years.
13154 With a single plus or minus, the date is relative to today. With a double
13155 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
13156 +4d --> four days from today
13157 +4 --> same as above
13158 +2w --> two weeks from today
13159 ++5 --> five days from default date
13161 The function understands only English month and weekday abbreviations,
13162 but this can be configured with the variables `parse-time-months' and
13163 `parse-time-weekdays'.
13165 While prompting, a calendar is popped up - you can also select the
13166 date with the mouse (button 1). The calendar shows a period of three
13167 months. To scroll it to other months, use the keys `>' and `<'.
13168 If you don't like the calendar, turn it off with
13169 \(setq org-read-date-popup-calendar nil)
13171 With optional argument TO-TIME, the date will immediately be converted
13172 to an internal time.
13173 With an optional argument WITH-TIME, the prompt will suggest to also
13174 insert a time. Note that when WITH-TIME is not set, you can still
13175 enter a time, and this function will inform the calling routine about
13176 this change. The calling routine may then choose to change the format
13177 used to insert the time stamp into the buffer to include the time.
13178 With optional argument FROM-STRING, read from this string instead from
13179 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
13180 the time/date that is used for everything that is not specified by the
13181 user."
13182 (require 'parse-time)
13183 (let* ((org-time-stamp-rounding-minutes
13184 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
13185 (org-dcst org-display-custom-times)
13186 (ct (org-current-time))
13187 (def (or org-overriding-default-time default-time ct))
13188 (defdecode (decode-time def))
13189 (dummy (progn
13190 (when (< (nth 2 defdecode) org-extend-today-until)
13191 (setcar (nthcdr 2 defdecode) -1)
13192 (setcar (nthcdr 1 defdecode) 59)
13193 (setq def (apply 'encode-time defdecode)
13194 defdecode (decode-time def)))))
13195 (calendar-frame-setup nil)
13196 (calendar-move-hook nil)
13197 (calendar-view-diary-initially-flag nil)
13198 (view-diary-entries-initially nil)
13199 (calendar-view-holidays-initially-flag nil)
13200 (view-calendar-holidays-initially nil)
13201 (timestr (format-time-string
13202 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
13203 (prompt (concat (if prompt (concat prompt " ") "")
13204 (format "Date+time [%s]: " timestr)))
13205 ans (org-ans0 "") org-ans1 org-ans2 final)
13207 (cond
13208 (from-string (setq ans from-string))
13209 (org-read-date-popup-calendar
13210 (save-excursion
13211 (save-window-excursion
13212 (calendar)
13213 (calendar-forward-day (- (time-to-days def)
13214 (calendar-absolute-from-gregorian
13215 (calendar-current-date))))
13216 (org-eval-in-calendar nil t)
13217 (let* ((old-map (current-local-map))
13218 (map (copy-keymap calendar-mode-map))
13219 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
13220 (org-defkey map (kbd "RET") 'org-calendar-select)
13221 (org-defkey map (if (featurep 'xemacs) [button1] [mouse-1])
13222 'org-calendar-select-mouse)
13274 ;; org-ans0: from prompt
13275 ;; org-ans1: from mouse click
13276 ;; org-ans2: from calendar motion
13308 "Display the current date prompt interpretation in the minibuffer."
13324 org-time-stamp-custom-formats
13325 org-time-stamp-formats))
13334 org-end-time-was-given
13343 "Analyse the combined answer of the date prompt."
13344 ;; FIXME: cleanup and comment
13346 delta deltan deltaw deltadef year month day
13347 hour minute second wday pm h2 m2 tl wday1
13348 iso-year iso-weekday iso-week iso-year iso-date futurep)
13359 ;; Check if there is an iso week date in there
13360 ;; If yes, store the info and postpone interpreting it until the rest
13361 ;; of the parsing is done
13362 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
13363 (setq iso-year (if (match-end 1) (org-small-year-to-year (string-to-number (match-string 1 ans))))
13368 ;; Help matching ISO dates with single digit month ot day, like 2006-8-11.
13378 t nil ans)))
13379 ;; Help matching am/pm times, because `parse-time-string' does not do that.
13380 ;; If there is a time with am/pm, and *no* time without it, we convert
13381 ;; so that matching will be successful.
13395 t t ans))))
13397 ;; Check if a time range is given as a duration
13398 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
13406 t t ans)))
13408 ;; Check if there is a time range
13445 futurep t))
13447 ;; Special date definitions below
13450 ;; There was an iso week
13454 wday nil ; to make sure that the trigger below does not match
13458 ; FIXME: Should we also push ISO weeks into the future?
13459 ; (when (and org-read-date-prefer-future
13460 ; (not iso-year)
13461 ; (< (calendar-absolute-from-gregorian iso-date)
13462 ; (time-to-days (current-time))))
13463 ; (setq year (1+ year)
13464 ; iso-date (calendar-gregorian-from-absolute
13465 ; (calendar-absolute-from-iso
13466 ; (list iso-week day year)))))
13481 ;; Weekday was given, but no day, so pick that day in the week
13482 ;; on or after the derived date.
13497 "Check string S for special relative date string.
13498 TODAY and DEFAULT are internal times, for today and for a default.
13499 Return shift list (N what def-flag)
13501 N is the number of WHATs to shift.
13502 DEF-FLAG is t when a double ++ or -- indicates shift relative to
13503 the DEFAULT date rather than TODAY."
13514 ?+))
13521 delta)
13531 "Eval FORM in the calendar window and return to current window.
13532 Also, store the cursor date in variable org-ans2."
13546 "Return to `org-read-date' with the date currently selected.
13547 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
13556 "Insert a date stamp for the date given by the internal TIME.
13557 WITH-HM means, use the stamp format that includes the time of the day.
13558 INACTIVE means use square brackets instead of angular ones, so that the
13559 stamp will not contribute to the agenda.
13560 PRE and POST are optional strings to be inserted before and after the
13561 stamp.
13562 The command returns the inserted time stamp."
13564 stamp)
13584 "Toggle the use of custom time stamp formats."
13605 "Overlay modified time stamp format over timestamp between BEG and END."
13610 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
13632 "Translate all timestamps in STRING to custom format.
13633 But do this only if the variable `org-display-custom-times' is set."
13638 t1 with-hm inactive tf time str beg end)
13647 org-time-stamp-custom-formats)
13656 string)
13659 "Set 0 instead of nil for the first 6 elements of time.
13660 Don't touch the rest."
13665 "Difference between TIMESTAMP-STRING and now in days."
13670 "Is the time in TIMESTAMP-STRING close to the current date?"
13676 "Get the deadline lead time appropriate for timestring TS."
13679 ;; 0 or negative, enforce this value no matter what
13682 ;; lead time is specified.
13687 ;; go for the default.
13691 "Return to `org-read-date' with the date currently selected.
13692 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
13702 "Check if there are any deadlines due or past due.
13703 A deadline is considered due if it happens within `org-deadline-warning-days'
13704 days from today's date. If the deadline appears in an entry marked DONE,
13705 it is not shown. The prefix arg NDAYS can be used to test that many
13720 org-warn-days)))
13723 "Check if there are deadlines or scheduled entries before DATE."
13737 "Check if there are deadlines or scheduled entries after DATE."
13752 "Evaluate a time range by computing the difference between start and end.
13753 Normally the result is just printed in the echo area, but with prefix arg
13754 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
13755 If the time range is actually in a table, the result is inserted into the
13756 next column.
13757 For time difference computation, a year is assumed to be exactly 365
13758 days in order to avoid rounding problems."
13778 ;; (ys (floor (* 365 24 60 60)))
13786 y d h m align)
13789 y 0
13794 y 0
13834 "Convert a time stamp to an absolute day number.
13835 If there is a specifyer for a cyclic time stamp, get the closest date to
13836 DAYNR.
13837 PREFER and SHOW-ALL are passed through to `org-closest-date'.
13838 the variable date is bound by the calendar when this is called."
13842 daynr
13847 prefer show-all))
13851 "Return the iso week number."
13856 "Convert 2-digit years into 4-digit years.
13857 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
13858 The year 2000 cannot be abbreviated. Any year larger than 99
13859 is returned unchanged."
13864 year)
13867 "Return the time corresponding to date D.
13868 D may be an absolute day number, or a calendar-type list (month day year)."
13873 "List of holidays, for Diary display in Org-mode."
13881 "Process a SEXP diary ENTRY for DATE."
13901 "Get iCalendar entries from diary entries in buffer FROMBUF.
13902 This uses the icalendar.el library."
13905 temporary-file-directory))
13908 buf rtn b e)
13922 rtn))
13925 "Find the date closest to CURRENT that is consistent with START and CHANGE.
13926 When PREFER is `past' return a date that is either CURRENT or past.
13927 When PREFER is `future', return a date that is either CURRENT or future.
13928 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
13929 ;; Make the proper lists from the dates
13932 dn dw sday cday n1 n2 n0
13933 d m y y1 y2 date1 date2 nmonths nm ny m2)
13938 current
13962 ;; approx number of month between the two dates
13964 ;; How often does dn fit in there?
13981 ;; Make sure n1 is the earlier date
13994 "Turn any specification of DATE into a gregorian date for the calendar."
14004 "Parse the standard Org-mode time string.
14005 This should be a lot faster than the normal `parse-time-string'.
14006 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
14007 hour and minute fields will be nil if not given."
14017 nil nil nil)
14021 "Increase the date item at the cursor by one.
14022 If the cursor is on the year, change the year. If it is on the month or
14023 the day, change that.
14024 With prefix ARG, change by that many units."
14029 "Decrease the date item at the cursor by one.
14030 If the cursor is on the year, change the year. If it is on the month or
14031 the day, change that.
14032 With prefix ARG, change by that many units."
14037 "Increase the date in the time stamp by one day.
14038 With prefix ARG, change that many days."
14046 "Decrease the date in the time stamp by one day.
14047 With prefix ARG, change that many days."
14055 "Determine if the cursor is in or at a timestamp."
14081 ans))
14084 "Toggle the type (<active> or [inactive]) of a time stamp."
14093 t t)))
14098 "Change the date in the time stamp at point.
14099 The date will be changed by N times WHAT. WHAT can be `day', `month',
14100 `year', `minute', `second'. If WHAT is not given, the cursor position
14101 in the timestamp determines what will be changed."
14103 with-hm inactive
14105 org-ts-what
14106 extra rem
14107 ts time time0)
14113 org-display-custom-times
14123 ts)
14143 extra
14146 extra
14148 n dm)))
14164 ;; Try to recenter the calendar window, if any
14171 "Change the different parts of the lead-time and repeat fields in timestamp."
14173 ng h m new rem)
14174 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
14203 new
14205 s))
14208 "If the calendar is visible, recenter it to DATE."
14219 "Go to the Emacs calendar at the current date.
14220 If there is a time stamp in the current line, go to that date.
14221 A prefix ARG can be used to force the current date."
14242 "Return a list (month day year) of date at point in calendar."
14248 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
14249 If there is already a time stamp at the cursor position, update it."
14258 "Compute H:MM from a number of minutes."
14264 "Convert a string H:MM to a number of minutes.
14265 If the string is just a number, interpret it as minutes.
14266 In fact, the first hh:mm or number in the string will be taken,
14267 there can be extra stuff in the string.
14268 If no number is found, the return value is 0."
14277 ;;;; Files
14280 "Save all Org-mode buffers without user confirmation."
14288 "Revert all Org-mode buffers.
14289 Prompt for confirmation when there are unsaved changes.
14290 Be sure you know what you are doing before letting this function
14291 overwrite your changes.
14293 This function is useful in a setup where one tracks org files
14294 with a version control system, to revert on one machine after pulling
14295 changes from another. I believe the procedure must be like this:
14297 1. M-x org-save-all-org-buffers
14298 2. Pull changes from the other machine, resolve conflicts
14299 3. M-x org-revert-all-org-buffers"
14315 ;;;; Agenda files
14317 ;;;###autoload
14319 "Use `org-icompleting-read' to prompt for an Org buffer to switch to.
14320 With a prefix argument, restrict available to files.
14321 With two prefix arguments, restrict available buffers to agenda files."
14329 nil t))))
14331 ;;;###autoload
14335 "Return a list of Org buffers.
14336 PREDICATE can be `export', `files' or `agenda'.
14338 export restrict the list to Export buffers.
14339 files restrict the list to buffers visiting Org files.
14340 agenda restrict the list to buffers visiting agenda files.
14342 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
14368 b
14369 nil))
14373 "Get the list of agenda files.
14374 Optional UNRESTRICTED means return the full list even if a restriction
14375 is currently in place.
14376 When ARCHIVES is t, include all archive files hat are really being
14377 used by the agenda files. If ARCHIVE is `ifmode', do this only if
14378 `org-agenda-archives-mode' is t."
14389 f t org-agenda-file-regexp)
14391 files)))
14397 files))))
14401 files))
14404 "Edit the list of agenda files.
14405 Depending on setup, this either uses customize to edit the variable
14406 `org-agenda-files', or it visits the file that is holding the list. In the
14407 latter case, the buffer is set up in a way that saving it automatically kills
14408 the buffer and restores the previous window configuration."
14427 "Set new value for the agenda file list and save it correctly."
14439 "Read the list of agenda files from a file."
14448 ;;;###autoload
14450 "Cycle through the files in `org-agenda-files'.
14451 If the current buffer visits an agenda file, find the next one in the list.
14452 If the current buffer does not, find the first agenda file."
14457 file)
14469 "Move/add the current file to the top of the agenda file list.
14470 If the file is not present in the list, it is added to the front. If it is
14471 present, it is moved there. With optional argument TO-END, add/move to the
14472 end of the list."
14479 x had)
14492 "Remove current file from the list of files in variable `org-agenda-files'.
14493 These are the files which are being checked for agenda entries.
14494 Optional argument FILE means, use this file instead of the current."
14504 nil x))
14517 "Make sure FILE exists. If not, ask user what to do."
14529 "Get a buffer visiting FILE. If the buffer needs to be created, add
14530 it to the list of buffers which might be released later."
14533 buf ; just return it
14534 ;; Make a new buffer and remember it
14537 buf)))
14540 "Release all buffers in list, asking the user for confirmation when needed.
14541 When a buffer is unmodified, it is just killed. When modified, it is saved
14542 \(if the user agrees) and then killed."
14547 file
14553 "Create buffers for all agenda files, protect archived trees and comments."
14560 bmp file re)
14600 ;;;; Embedded LaTeX
14615 "Toggle the minor `org-cdlatex-mode'.
14616 This mode supports entering LaTeX environment and math in LaTeX fragments
14617 in Org-mode.
14619 nil " OCDL" nil
14624 "Always return t in org-mode buffers.
14625 This is because we want to insert math symbols without dollars even outside
14626 the LaTeX math segments. If Orgmode thinks that point is actually inside
14627 an embedded LaTeX fragment, let texmathp do its job.
14644 "Unconditionally turn on `org-cdlatex-mode'."
14648 "Test if point is inside a LaTeX fragment.
14650 sequence appearing also before point.
14651 Even though the matchers for math are configurable, this function assumes
14653 delimiters are skipped when they have been removed by customization.
14654 The return value is nil, or a cons cell with the delimiter and
14655 and the position of this delimiter.
14657 This function does a reasonably good job, but can locally be fooled by
14658 for example currency specifications. For example it will assume being in
14660 fragments that are properly closed, but during editing, we have to live
14661 with the uncertainty caused by missing closing delimiters. This function
14662 looks only before point, not after."
14681 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
14685 ;; count $$
14692 "Is point inside a LaTeX macro or its arguments?"
14698 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
14699 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
14700 - inside a LaTeX fragment, or
14701 - after the first word in a line, where an abbreviation expansion could
14702 insert a LaTeX environment."
14715 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
14716 Revert to the normal definition outside of these fragments."
14724 "Execute `cdlatex-math-modify' in LaTeX fragments.
14725 Revert to the normal definition outside of these fragments."
14737 "Remove all overlays with LaTeX fragment images in current buffer."
14742 "Preview the LaTeX fragment at point, or all locally or globally.
14743 If the cursor is in a LaTeX fragment, create the image and overlay
14744 it over the source code. If there is no fragment at point, display
14745 all fragments in the current text, from one headline to the next. With
14746 prefix SUBTREE, display all fragments in the current subtree. With a
14747 double prefix `C-u C-u', or when the cursor is before the first headline,
14748 display all fragments in the buffer.
14778 buffer-file-name)))
14784 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
14785 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
14787 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
14794 "Replace LaTeX fragments with links to an image, and produce images.
14795 Some of the options can be changed using the variable
14796 `org-format-latex-options'."
14807 executables-checked
14808 m n block linkfile movefile ov)
14809 ;; Check the different regular expressions
14829 org-format-latex-header-extra
14830 org-export-latex-packages-alist
14831 org-format-latex-options
14832 forbuffer txt)))
14851 txt movefile opt forbuffer))
14865 ov 'end-glyph
14868 ov 'display
14875 ;; This function borrows from Ganesh Swami's latex2png.el
14877 "This calls dvipng."
14881 temporary-file-directory))
14925 "-D" dpi
14926 ;;"-x" scale "-y" scale
14928 "-o" pngfile
14929 dvifile)
14933 ;; Use the requested file name and clean up
14937 pngfile))))
14940 "Return an rgb color specification for dvipng."
14946 "Return string to be used as color value for an RGB component."
14949 ;;;; Key bindings
14951 ;; Make `C-c C-x' a prefix key
14954 ;; TAB key with modifiers
14961 ;; The following line is necessary under Suse GNU/Linux
14967 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
14968 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
14969 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
14971 ;; Cursor keys with modifiers
14972 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
14973 (org-defkey org-mode-map [(meta right)] 'org-metaright)
14974 (org-defkey org-mode-map [(meta up)] 'org-metaup)
14975 (org-defkey org-mode-map [(meta down)] 'org-metadown)
14977 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
14978 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
14979 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
14980 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
14982 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
14983 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
14984 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
14985 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
14987 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
14988 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
14990 ;;; Extra keys for tty access.
14991 ;; We only set them when really needed because otherwise the
14992 ;; menus don't show the simple keys
14994 (when (or org-use-extra-keys
14995 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
14996 (not window-system))
14997 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
14998 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
14999 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
15000 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
15001 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
15002 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
15003 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
15004 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
15005 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
15006 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
15007 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
15008 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
15009 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
15010 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
15011 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
15012 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
15013 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
15014 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
15015 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
15016 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
15017 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
15018 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
15019 (org-defkey org-mode-map [?\e (tab)] 'org-complete)
15020 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
15021 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
15022 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
15023 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
15024 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
15026 ;; All the other keys
15028 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
15029 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
15030 (if (boundp 'narrow-map)
15031 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
15032 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
15033 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
15034 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
15035 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
15036 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
15037 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
15038 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
15039 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
15040 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
15041 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
15042 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
15043 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
15044 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
15045 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
15046 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
15047 (org-defkey org-mode-map "\C-c\C-v" 'org-show-todo-tree)
15048 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
15049 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
15051 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
15052 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
15053 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
15054 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
15055 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
15056 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
15057 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
15058 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
15059 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
15060 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
15061 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
15062 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
15063 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
15064 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
15065 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
15066 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
15067 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
15068 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
15069 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
15071 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
15072 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
15073 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
15074 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
15075 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
15076 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
15077 (org-defkey org-mode-map "\C-c^" 'org-sort)
15078 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
15079 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
15080 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
15081 (org-defkey org-mode-map "\C-m" 'org-return)
15082 (org-defkey org-mode-map "\C-j" 'org-return-indent)
15083 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
15084 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
15085 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
15086 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
15087 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
15088 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
15089 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
15090 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
15091 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
15092 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
15093 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
15094 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
15095 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
15096 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
15097 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
15098 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
15099 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
15100 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
15101 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
15102 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
15104 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
15105 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
15106 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
15107 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
15109 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
15110 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
15111 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
15112 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
15113 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
15114 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
15115 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
15116 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
15117 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
15118 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
15119 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
15120 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
15121 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
15122 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
15123 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
15125 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
15126 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
15127 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
15128 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
15130 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
15132 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
15134 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
15135 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
15137 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
15140 (when (featurep 'xemacs)
15141 (org-defkey org-mode-map 'button3 'popup-mode-menu))
15144 (defconst org-speed-commands-default
15145 '(
15146 ("Outline Navigation")
15147 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
15148 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
15149 ("f" . (org-speed-move-safe 'org-forward-same-level))
15150 ("b" . (org-speed-move-safe 'org-backward-same-level))
15151 ("u" . (org-speed-move-safe 'outline-up-heading))
15152 ("j" . org-goto)
15153 ("g" . (org-refile t))
15154 ("Outline Visibility")
15155 ("c" . org-cycle)
15156 ("C" . org-shifttab)
15157 (" " . org-display-outline-path)
15158 ("Outline Structure Editing")
15159 ("U" . org-shiftmetaup)
15160 ("D" . org-shiftmetadown)
15161 ("r" . org-metaright)
15162 ("l" . org-metaleft)
15163 ("R" . org-shiftmetaright)
15164 ("L" . org-shiftmetaleft)
15165 ("i" . (progn (forward-char 1) (call-interactively
15166 'org-insert-heading-respect-content)))
15167 ("^" . org-sort)
15168 ("w" . org-refile)
15169 ("a" . org-archive-subtree-default-with-confirmation)
15170 ("." . outline-mark-subtree)
15171 ("Clock Commands")
15172 ("I" . org-clock-in)
15173 ("O" . org-clock-out)
15174 ("Meta Data Editing")
15175 ("t" . org-todo)
15176 ("0" . (org-priority ?\ ))
15177 ("1" . (org-priority ?A))
15178 ("2" . (org-priority ?B))
15179 ("3" . (org-priority ?C))
15180 (";" . org-set-tags-command)
15181 ("e" . org-set-effort)
15182 ("Agenda Views etc")
15183 ("v" . org-agenda)
15184 ("/" . org-sparse-tree)
15185 ("Misc")
15186 ("o" . org-open-at-point)
15187 ("?" . org-speed-command-help)
15188 )
15189 "The default speed commands.")
15191 (defun org-print-speed-command (e)
15192 (if (> (length (car e)) 1)
15193 (progn
15195 (princ (car e))
15197 (princ (make-string (length (car e)) ?-))
15199 (princ (car e))
15200 (princ " ")
15201 (if (symbolp (cdr e))
15202 (princ (symbol-name (cdr e)))
15203 (prin1 (cdr e)))
15206 (defun org-speed-command-help ()
15207 "Show the available speed commands."
15208 (interactive)
15209 (if (not org-use-speed-commands)
15210 (error "Speed commands are not activated, customize `org-use-speed-commands'.")
15211 (with-output-to-temp-buffer "*Help*"
15213 (mapc 'org-print-speed-command org-speed-commands-user)
15216 (mapc 'org-print-speed-command org-speed-commands-default))
15217 (with-current-buffer "*Help*"
15218 (setq truncate-lines t))))
15220 (defun org-speed-move-safe (cmd)
15221 "Execute CMD, but make sure that the cursor always ends up in a headline.
15222 If not, return to the original position and throw an error."
15223 (interactive)
15224 (let ((pos (point)))
15225 (call-interactively cmd)
15226 (unless (and (bolp) (org-on-heading-p))
15227 (goto-char pos)
15228 (error "Boundary reached while executing %s" cmd))))
15230 (defvar org-self-insert-command-undo-counter 0)
15232 (defvar org-table-auto-blank-field) ; defined in org-table.el
15233 (defvar org-speed-command nil)
15234 (defun org-self-insert-command (N)
15235 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
15236 If the cursor is in a table looking at whitespace, the whitespace is
15237 overwritten, and the table is not marked as requiring realignment."
15238 (interactive "p")
15239 (cond
15240 ((and org-use-speed-commands
15241 (or (and (bolp) (looking-at outline-regexp))
15242 (and (functionp org-use-speed-commands)
15243 (funcall org-use-speed-commands)))
15244 (setq
15245 org-speed-command
15246 (or (cdr (assoc (this-command-keys) org-speed-commands-user))
15247 (cdr (assoc (this-command-keys) org-speed-commands-default)))))
15248 (cond
15249 ((commandp org-speed-command)
15250 (setq this-command org-speed-command)
15251 (call-interactively org-speed-command))
15252 ((functionp org-speed-command)
15253 (funcall org-speed-command))
15254 ((and org-speed-command (listp org-speed-command))
15255 (eval org-speed-command))
15256 (t (let (org-use-speed-commands)
15257 (call-interactively 'org-self-insert-command)))))
15258 ((and
15259 (org-table-p)
15260 (progn
15261 ;; check if we blank the field, and if that triggers align
15262 (and (featurep 'org-table) org-table-auto-blank-field
15263 (member last-command
15264 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
15266 ;; got extra space, this field does not determine column width
15267 (let (org-table-may-need-update) (org-table-blank-field))
15268 ;; no extra space, this field may determine column width
15269 (org-table-blank-field)))
15270 t)
15271 (eq N 1)
15273 (let (org-table-may-need-update)
15274 (goto-char (1- (match-end 0)))
15275 (delete-backward-char 1)
15276 (goto-char (match-beginning 0))
15277 (self-insert-command N)))
15278 (t
15279 (setq org-table-may-need-update t)
15280 (self-insert-command N)
15281 (org-fix-tags-on-the-fly)
15282 (if org-self-insert-cluster-for-undo
15283 (if (not (eq last-command 'org-self-insert-command))
15284 (setq org-self-insert-command-undo-counter 1)
15285 (if (>= org-self-insert-command-undo-counter 20)
15286 (setq org-self-insert-command-undo-counter 1)
15287 (and (> org-self-insert-command-undo-counter 0)
15288 buffer-undo-list
15289 (not (cadr buffer-undo-list)) ; remove nil entry
15290 (setcdr buffer-undo-list (cddr buffer-undo-list)))
15291 (setq org-self-insert-command-undo-counter
15292 (1+ org-self-insert-command-undo-counter))))))))
15294 (defun org-fix-tags-on-the-fly ()
15295 (when (and (equal (char-after (point-at-bol)) ?*)
15296 (org-on-heading-p))
15297 (org-align-tags-here org-tags-column)))
15299 (defun org-delete-backward-char (N)
15300 "Like `delete-backward-char', insert whitespace at field end in tables.
15301 When deleting backwards, in tables this function will insert whitespace in
15303 still be marked for re-alignment if the field did fill the entire column,
15304 because, in this case the deletion might narrow the column."
15305 (interactive "p")
15306 (if (and (org-table-p)
15307 (eq N 1)
15308 (string-match "|" (buffer-substring (point-at-bol) (point)))
15309 (looking-at ".*?|"))
15310 (let ((pos (point))
15312 (c org-table-may-need-update))
15313 (backward-delete-char N)
15314 (skip-chars-forward "^|")
15315 (insert " ")
15316 (goto-char (1- pos))
15317 ;; noalign: if there were two spaces at the end, this field
15318 ;; does not determine the width of the column.
15319 (if noalign (setq org-table-may-need-update c)))
15320 (backward-delete-char N)
15321 (org-fix-tags-on-the-fly)))
15323 (defun org-delete-char (N)
15324 "Like `delete-char', but insert whitespace at field end in tables.
15325 When deleting characters, in tables this function will insert whitespace in
15327 still be marked for re-alignment if the field did fill the entire column,
15328 because, in this case the deletion might narrow the column."
15329 (interactive "p")
15330 (if (and (org-table-p)
15331 (not (bolp))
15332 (not (= (char-after) ?|))
15333 (eq N 1))
15334 (if (looking-at ".*?|")
15335 (let ((pos (point))
15337 (c org-table-may-need-update))
15338 (replace-match (concat
15339 (substring (match-string 0) 1 -1)
15340 " |"))
15341 (goto-char pos)
15342 ;; noalign: if there were two spaces at the end, this field
15343 ;; does not determine the width of the column.
15344 (if noalign (setq org-table-may-need-update c)))
15345 (delete-char N))
15346 (delete-char N)
15347 (org-fix-tags-on-the-fly)))
15349 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
15350 (put 'org-self-insert-command 'delete-selection t)
15351 (put 'orgtbl-self-insert-command 'delete-selection t)
15352 (put 'org-delete-char 'delete-selection 'supersede)
15353 (put 'org-delete-backward-char 'delete-selection 'supersede)
15354 (put 'org-yank 'delete-selection 'yank)
15356 ;; Make `flyspell-mode' delay after some commands
15357 (put 'org-self-insert-command 'flyspell-delayed t)
15358 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
15359 (put 'org-delete-char 'flyspell-delayed t)
15360 (put 'org-delete-backward-char 'flyspell-delayed t)
15362 ;; Make pabbrev-mode expand after org-mode commands
15363 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
15364 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
15366 ;; How to do this: Measure non-white length of current string
15367 ;; If equal to column width, we should realign.
15369 (defun org-remap (map &rest commands)
15370 "In MAP, remap the functions given in COMMANDS.
15371 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
15372 (let (new old)
15373 (while commands
15374 (setq old (pop commands) new (pop commands))
15375 (if (fboundp 'command-remapping)
15376 (org-defkey map (vector 'remap old) new)
15377 (substitute-key-definition old new map global-map)))))
15379 (when (eq org-enable-table-editor 'optimized)
15380 ;; If the user wants maximum table support, we need to hijack
15381 ;; some standard editing functions
15382 (org-remap org-mode-map
15383 'self-insert-command 'org-self-insert-command
15384 'delete-char 'org-delete-char
15385 'delete-backward-char 'org-delete-backward-char)
15386 (org-defkey org-mode-map "|" 'org-force-self-insert))
15388 (defvar org-ctrl-c-ctrl-c-hook nil
15389 "Hook for functions attaching themselves to `C-c C-c'.
15390 This can be used to add additional functionality to the C-c C-c key which
15391 executes context-dependent commands.
15392 Each function will be called with no arguments. The function must check
15393 if the context is appropriate for it to act. If yes, it should do its
15394 thing and then return a non-nil value. If the context is wrong,
15395 just do nothing and return nil.")
15397 (defvar org-tab-first-hook nil
15398 "Hook for functions to attach themselves to TAB.
15399 See `org-ctrl-c-ctrl-c-hook' for more information.
15400 This hook runs as the first action when TAB is pressed, even before
15401 `org-cycle' messes around with the `outline-regexp' to cater for
15402 inline tasks and plain list item folding.
15403 If any function in this hook returns t, not other actions like table
15404 field motion visibility cycling will be done.")
15406 (defvar org-tab-after-check-for-table-hook nil
15407 "Hook for functions to attach themselves to TAB.
15408 See `org-ctrl-c-ctrl-c-hook' for more information.
15409 This hook runs after it has been established that the cursor is not in a
15410 table, but before checking if the cursor is in a headline or if global cycling
15411 should be done.
15412 If any function in this hook returns t, not other actions like visibility
15413 cycling will be done.")
15415 (defvar org-tab-after-check-for-cycling-hook nil
15416 "Hook for functions to attach themselves to TAB.
15417 See `org-ctrl-c-ctrl-c-hook' for more information.
15418 This hook runs after it has been established that not table field motion and
15419 not visibility should be done because of current context. This is probably
15420 the place where a package like yasnippets can hook in.")
15422 (defvar org-tab-before-tab-emulation-hook nil
15423 "Hook for functions to attach themselves to TAB.
15424 See `org-ctrl-c-ctrl-c-hook' for more information.
15425 This hook runs after every other options for TAB have been exhausted, but
15428 (defvar org-metaleft-hook nil
15429 "Hook for functions attaching themselves to `M-left'.
15430 See `org-ctrl-c-ctrl-c-hook' for more information.")
15431 (defvar org-metaright-hook nil
15432 "Hook for functions attaching themselves to `M-right'.
15433 See `org-ctrl-c-ctrl-c-hook' for more information.")
15434 (defvar org-metaup-hook nil
15435 "Hook for functions attaching themselves to `M-up'.
15436 See `org-ctrl-c-ctrl-c-hook' for more information.")
15437 (defvar org-metadown-hook nil
15438 "Hook for functions attaching themselves to `M-down'.
15439 See `org-ctrl-c-ctrl-c-hook' for more information.")
15440 (defvar org-shiftmetaleft-hook nil
15441 "Hook for functions attaching themselves to `M-S-left'.
15442 See `org-ctrl-c-ctrl-c-hook' for more information.")
15443 (defvar org-shiftmetaright-hook nil
15444 "Hook for functions attaching themselves to `M-S-right'.
15445 See `org-ctrl-c-ctrl-c-hook' for more information.")
15446 (defvar org-shiftmetaup-hook nil
15447 "Hook for functions attaching themselves to `M-S-up'.
15448 See `org-ctrl-c-ctrl-c-hook' for more information.")
15449 (defvar org-shiftmetadown-hook nil
15450 "Hook for functions attaching themselves to `M-S-down'.
15451 See `org-ctrl-c-ctrl-c-hook' for more information.")
15452 (defvar org-metareturn-hook nil
15453 "Hook for functions attaching themselves to `M-RET'.
15454 See `org-ctrl-c-ctrl-c-hook' for more information.")
15456 (defun org-modifier-cursor-error ()
15457 "Throw an error, a modified cursor command was applied in wrong context."
15458 (error "This command is active in special context like tables, headlines or items"))
15460 (defun org-shiftselect-error ()
15461 "Throw an error because Shift-Cursor command was applied in wrong context."
15462 (if (and (boundp 'shift-select-mode) shift-select-mode)
15463 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
15464 (error "This command works only in special context like headlines or timestamps")))
15466 (defun org-call-for-shift-select (cmd)
15467 (let ((this-command-keys-shift-translated t))
15468 (call-interactively cmd)))
15470 (defun org-shifttab (&optional arg)
15471 "Global visibility cycling or move to previous table field.
15472 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
15473 on context.
15474 See the individual commands for more information."
15475 (interactive "P")
15476 (cond
15477 ((org-at-table-p) (call-interactively 'org-table-previous-field))
15478 ((integerp arg)
15479 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
15480 (message "Content view to level: %d" arg)
15481 (org-content (prefix-numeric-value arg2))
15482 (setq org-cycle-global-status 'overview)))
15483 (t (call-interactively 'org-global-cycle))))
15485 (defun org-shiftmetaleft ()
15486 "Promote subtree or delete table column.
15487 Calls `org-promote-subtree', `org-outdent-item',
15488 or `org-table-delete-column', depending on context.
15489 See the individual commands for more information."
15490 (interactive)
15491 (cond
15492 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
15493 ((org-at-table-p) (call-interactively 'org-table-delete-column))
15494 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
15495 ((org-at-item-p) (call-interactively 'org-outdent-item))
15496 (t (org-modifier-cursor-error))))
15498 (defun org-shiftmetaright ()
15499 "Demote subtree or insert table column.
15500 Calls `org-demote-subtree', `org-indent-item',
15501 or `org-table-insert-column', depending on context.
15502 See the individual commands for more information."
15503 (interactive)
15504 (cond
15505 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
15506 ((org-at-table-p) (call-interactively 'org-table-insert-column))
15507 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
15508 ((org-at-item-p) (call-interactively 'org-indent-item))
15509 (t (org-modifier-cursor-error))))
15511 (defun org-shiftmetaup (&optional arg)
15512 "Move subtree up or kill table row.
15513 Calls `org-move-subtree-up' or `org-table-kill-row' or
15514 `org-move-item-up' depending on context. See the individual commands
15515 for more information."
15516 (interactive "P")
15517 (cond
15518 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
15519 ((org-at-table-p) (call-interactively 'org-table-kill-row))
15520 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
15521 ((org-at-item-p) (call-interactively 'org-move-item-up))
15522 (t (org-modifier-cursor-error))))
15524 (defun org-shiftmetadown (&optional arg)
15525 "Move subtree down or insert table row.
15526 Calls `org-move-subtree-down' or `org-table-insert-row' or
15527 `org-move-item-down', depending on context. See the individual
15528 commands for more information."
15529 (interactive "P")
15530 (cond
15531 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
15532 ((org-at-table-p) (call-interactively 'org-table-insert-row))
15533 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
15534 ((org-at-item-p) (call-interactively 'org-move-item-down))
15535 (t (org-modifier-cursor-error))))
15537 (defun org-metaleft (&optional arg)
15538 "Promote heading or move table column to left.
15539 Calls `org-do-promote' or `org-table-move-column', depending on context.
15540 With no specific context, calls the Emacs default `backward-word'.
15541 See the individual commands for more information."
15542 (interactive "P")
15543 (cond
15544 ((run-hook-with-args-until-success 'org-metaleft-hook))
15545 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
15546 ((or (org-on-heading-p)
15547 (and (org-region-active-p)
15548 (save-excursion
15549 (goto-char (region-beginning))
15550 (org-on-heading-p))))
15551 (call-interactively 'org-do-promote))
15552 ((or (org-at-item-p)
15553 (and (org-region-active-p)
15554 (save-excursion
15555 (goto-char (region-beginning))
15556 (org-at-item-p))))
15557 (call-interactively 'org-outdent-item))
15558 (t (call-interactively 'backward-word))))
15560 (defun org-metaright (&optional arg)
15561 "Demote subtree or move table column to right.
15562 Calls `org-do-demote' or `org-table-move-column', depending on context.
15563 With no specific context, calls the Emacs default `forward-word'.
15564 See the individual commands for more information."
15565 (interactive "P")
15566 (cond
15567 ((run-hook-with-args-until-success 'org-metaright-hook))
15568 ((org-at-table-p) (call-interactively 'org-table-move-column))
15569 ((or (org-on-heading-p)
15570 (and (org-region-active-p)
15571 (save-excursion
15572 (goto-char (region-beginning))
15573 (org-on-heading-p))))
15574 (call-interactively 'org-do-demote))
15575 ((or (org-at-item-p)
15576 (and (org-region-active-p)
15577 (save-excursion
15578 (goto-char (region-beginning))
15579 (org-at-item-p))))
15580 (call-interactively 'org-indent-item))
15581 (t (call-interactively 'forward-word))))
15583 (defun org-metaup (&optional arg)
15584 "Move subtree up or move table row up.
15585 Calls `org-move-subtree-up' or `org-table-move-row' or
15586 `org-move-item-up', depending on context. See the individual commands
15587 for more information."
15588 (interactive "P")
15589 (cond
15590 ((run-hook-with-args-until-success 'org-metaup-hook))
15591 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
15592 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
15593 ((org-at-item-p) (call-interactively 'org-move-item-up))
15594 (t (transpose-lines 1) (beginning-of-line -1))))
15596 (defun org-metadown (&optional arg)
15597 "Move subtree down or move table row down.
15598 Calls `org-move-subtree-down' or `org-table-move-row' or
15599 `org-move-item-down', depending on context. See the individual
15600 commands for more information."
15601 (interactive "P")
15602 (cond
15603 ((run-hook-with-args-until-success 'org-metadown-hook))
15604 ((org-at-table-p) (call-interactively 'org-table-move-row))
15605 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
15606 ((org-at-item-p) (call-interactively 'org-move-item-down))
15607 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
15609 (defun org-shiftup (&optional arg)
15610 "Increase item in timestamp or increase priority of current headline.
15611 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
15612 depending on context. See the individual commands for more information."
15613 (interactive "P")
15614 (cond
15615 ((and org-support-shift-select (org-region-active-p))
15616 (org-call-for-shift-select 'previous-line))
15617 ((org-at-timestamp-p t)
15618 (call-interactively (if org-edit-timestamp-down-means-later
15619 'org-timestamp-down 'org-timestamp-up)))
15620 ((and (not (eq org-support-shift-select 'always))
15621 org-enable-priority-commands
15622 (org-on-heading-p))
15623 (call-interactively 'org-priority-up))
15624 ((and (not org-support-shift-select) (org-at-item-p))
15625 (call-interactively 'org-previous-item))
15626 ((org-clocktable-try-shift 'up arg))
15627 (org-support-shift-select
15628 (org-call-for-shift-select 'previous-line))
15629 (t (org-shiftselect-error))))
15631 (defun org-shiftdown (&optional arg)
15632 "Decrease item in timestamp or decrease priority of current headline.
15633 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
15634 depending on context. See the individual commands for more information."
15635 (interactive "P")
15636 (cond
15637 ((and org-support-shift-select (org-region-active-p))
15638 (org-call-for-shift-select 'next-line))
15639 ((org-at-timestamp-p t)
15640 (call-interactively (if org-edit-timestamp-down-means-later
15641 'org-timestamp-up 'org-timestamp-down)))
15642 ((and (not (eq org-support-shift-select 'always))
15643 org-enable-priority-commands
15644 (org-on-heading-p))
15645 (call-interactively 'org-priority-down))
15646 ((and (not org-support-shift-select) (org-at-item-p))
15647 (call-interactively 'org-next-item))
15648 ((org-clocktable-try-shift 'down arg))
15649 (org-support-shift-select
15650 (org-call-for-shift-select 'next-line))
15651 (t (org-shiftselect-error))))
15653 (defun org-shiftright (&optional arg)
15654 "Cycle the thing at point or in the current line, depending on context.
15655 Depending on context, this does one of the following:
15657 - switch a timestamp at point one day into the future
15658 - on a headline, switch to the next TODO keyword.
15659 - on an item, switch entire list to the next bullet type
15660 - on a property line, switch to the next allowed value
15661 - on a clocktable definition line, move time block into the future"
15662 (interactive "P")
15663 (cond
15664 ((and org-support-shift-select (org-region-active-p))
15665 (org-call-for-shift-select 'forward-char))
15666 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
15667 ((and (not (eq org-support-shift-select 'always))
15668 (org-on-heading-p))
15669 (let ((org-inhibit-logging
15670 (not org-treat-S-cursor-todo-selection-as-state-change))
15671 (org-inhibit-blocking
15672 (not org-treat-S-cursor-todo-selection-as-state-change)))
15673 (org-call-with-arg 'org-todo 'right)))
15674 ((or (and org-support-shift-select
15675 (not (eq org-support-shift-select 'always))
15676 (org-at-item-bullet-p))
15677 (and (not org-support-shift-select) (org-at-item-p)))
15678 (org-call-with-arg 'org-cycle-list-bullet nil))
15679 ((and (not (eq org-support-shift-select 'always))
15680 (org-at-property-p))
15681 (call-interactively 'org-property-next-allowed-value))
15682 ((org-clocktable-try-shift 'right arg))
15683 (org-support-shift-select
15684 (org-call-for-shift-select 'forward-char))
15685 (t (org-shiftselect-error))))
15687 (defun org-shiftleft (&optional arg)
15688 "Cycle the thing at point or in the current line, depending on context.
15689 Depending on context, this does one of the following:
15691 - switch a timestamp at point one day into the past
15692 - on a headline, switch to the previous TODO keyword.
15693 - on an item, switch entire list to the previous bullet type
15694 - on a property line, switch to the previous allowed value
15695 - on a clocktable definition line, move time block into the past"
15696 (interactive "P")
15697 (cond
15698 ((and org-support-shift-select (org-region-active-p))
15699 (org-call-for-shift-select 'backward-char))
15700 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
15701 ((and (not (eq org-support-shift-select 'always))
15702 (org-on-heading-p))
15703 (let ((org-inhibit-logging
15704 (not org-treat-S-cursor-todo-selection-as-state-change))
15705 (org-inhibit-blocking
15706 (not org-treat-S-cursor-todo-selection-as-state-change)))
15707 (org-call-with-arg 'org-todo 'left)))
15708 ((or (and org-support-shift-select
15709 (not (eq org-support-shift-select 'always))
15710 (org-at-item-bullet-p))
15711 (and (not org-support-shift-select) (org-at-item-p)))
15712 (org-call-with-arg 'org-cycle-list-bullet 'previous))
15713 ((and (not (eq org-support-shift-select 'always))
15714 (org-at-property-p))
15715 (call-interactively 'org-property-previous-allowed-value))
15716 ((org-clocktable-try-shift 'left arg))
15717 (org-support-shift-select
15718 (org-call-for-shift-select 'backward-char))
15719 (t (org-shiftselect-error))))
15721 (defun org-shiftcontrolright ()
15722 "Switch to next TODO set."
15723 (interactive)
15724 (cond
15725 ((and org-support-shift-select (org-region-active-p))
15726 (org-call-for-shift-select 'forward-word))
15727 ((and (not (eq org-support-shift-select 'always))
15728 (org-on-heading-p))
15729 (org-call-with-arg 'org-todo 'nextset))
15730 (org-support-shift-select
15731 (org-call-for-shift-select 'forward-word))
15732 (t (org-shiftselect-error))))
15734 (defun org-shiftcontrolleft ()
15735 "Switch to previous TODO set."
15736 (interactive)
15737 (cond
15738 ((and org-support-shift-select (org-region-active-p))
15739 (org-call-for-shift-select 'backward-word))
15740 ((and (not (eq org-support-shift-select 'always))
15741 (org-on-heading-p))
15742 (org-call-with-arg 'org-todo 'previousset))
15743 (org-support-shift-select
15744 (org-call-for-shift-select 'backward-word))
15745 (t (org-shiftselect-error))))
15747 (defun org-ctrl-c-ret ()
15748 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
15749 (interactive)
15750 (cond
15751 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
15752 (t (call-interactively 'org-insert-heading))))
15754 (defun org-copy-special ()
15755 "Copy region in table or copy current subtree.
15756 Calls `org-table-copy' or `org-copy-subtree', depending on context.
15757 See the individual commands for more information."
15758 (interactive)
15759 (call-interactively
15760 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
15762 (defun org-cut-special ()
15763 "Cut region in table or cut current subtree.
15764 Calls `org-table-copy' or `org-cut-subtree', depending on context.
15765 See the individual commands for more information."
15766 (interactive)
15767 (call-interactively
15768 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
15770 (defun org-paste-special (arg)
15771 "Paste rectangular region into table, or past subtree relative to level.
15772 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
15773 See the individual commands for more information."
15774 (interactive "P")
15775 (if (org-at-table-p)
15776 (org-table-paste-rectangle)
15777 (org-paste-subtree arg)))
15779 (defun org-edit-special ()
15780 "Call a special editor for the stuff at point.
15781 When at a table, call the formula editor with `org-table-edit-formulas'.
15782 When at the first line of an src example, call `org-edit-src-code'.
15783 When in an #+include line, visit the include file. Otherwise call
15784 `ffap' to visit the file at point."
15785 (interactive)
15786 (cond
15787 ((org-at-table-p)
15788 (call-interactively 'org-table-edit-formulas))
15789 ((save-excursion
15790 (beginning-of-line 1)
15791 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
15792 (find-file (org-trim (match-string 1))))
15793 ((org-edit-src-code))
15794 ((org-edit-fixed-width-region))
15795 (t (call-interactively 'ffap))))
15798 (defun org-ctrl-c-ctrl-c (&optional arg)
15799 "Set tags in headline, or update according to changed information at point.
15801 This command does many different things, depending on context:
15803 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
15804 this is what we do.
15806 - If the cursor is on a statistics cookie, update it.
15808 - If the cursor is in a headline, prompt for tags and insert them
15809 into the current line, aligned to `org-tags-column'. When called
15810 with prefix arg, realign all tags in the current buffer.
15812 - If the cursor is in one of the special #+KEYWORD lines, this
15813 triggers scanning the buffer for these lines and updating the
15814 information.
15816 - If the cursor is inside a table, realign the table. This command
15817 works even if the automatic table editor has been turned off.
15819 - If the cursor is on a #+TBLFM line, re-apply the formulas to
15820 the entire table.
15822 - If the cursor is at a footnote reference or definition, jump to
15823 the corresponding definition or references, respectively.
15825 - If the cursor is a the beginning of a dynamic block, update it.
15827 - If the cursor is inside a table created by the table.el package,
15828 activate that table.
15830 - If the current buffer is a remember buffer, close note and file
15831 it. A prefix argument of 1 files to the default location
15832 without further interaction. A prefix argument of 2 files to
15833 the currently clocking task.
15835 - If the cursor is on a <<<target>>>, update radio targets and corresponding
15836 links in this buffer.
15838 - If the cursor is on a numbered item in a plain list, renumber the
15839 ordered list.
15841 - If the cursor is on a checkbox, toggle it."
15842 (interactive "P")
15843 (let ((org-enable-table-editor t))
15844 (cond
15845 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
15846 org-occur-highlights
15847 org-latex-fragment-image-overlays)
15848 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
15849 (org-remove-occur-highlights)
15850 (org-remove-latex-fragment-image-overlays)
15851 (message "Temporary highlights/overlays removed from current buffer"))
15852 ((and (local-variable-p 'org-finish-function (current-buffer))
15853 (fboundp org-finish-function))
15854 (funcall org-finish-function))
15855 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
15856 ((org-at-property-p)
15857 (call-interactively 'org-property-action))
15858 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
15860 (or (org-on-heading-p) (org-at-item-p)))
15861 (call-interactively 'org-update-statistics-cookies))
15862 ((org-on-heading-p) (call-interactively 'org-set-tags))
15863 ((org-at-table.el-p)
15864 (require 'table)
15865 (beginning-of-line 1)
15866 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
15867 (call-interactively 'table-recognize-table))
15868 ((org-at-table-p)
15869 (org-table-maybe-eval-formula)
15870 (if arg
15871 (call-interactively 'org-table-recalculate)
15872 (org-table-maybe-recalculate-line))
15873 (call-interactively 'org-table-align))
15874 ((or (org-footnote-at-reference-p)
15875 (org-footnote-at-definition-p))
15876 (call-interactively 'org-footnote-action))
15877 ((org-at-item-checkbox-p)
15878 (call-interactively 'org-toggle-checkbox))
15879 ((org-at-item-p)
15880 (if arg
15881 (call-interactively 'org-toggle-checkbox)
15882 (call-interactively 'org-maybe-renumber-ordered-list)))
15883 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
15884 ;; Dynamic block
15885 (beginning-of-line 1)
15886 (save-excursion (org-update-dblock)))
15887 ((save-excursion
15888 (beginning-of-line 1)
15890 (cond
15891 ((equal (match-string 1) "TBLFM")
15892 ;; Recalculate the table before this line
15893 (save-excursion
15894 (beginning-of-line 1)
15896 (if (org-at-table-p)
15897 (org-call-with-arg 'org-table-recalculate (or arg t)))))
15898 (t
15899 (let ((org-inhibit-startup-visibility-stuff t)
15900 (org-startup-align-all-tables nil))
15901 (org-save-outline-visibility 'use-markers (org-mode-restart)))
15902 (message "Local setup has been refreshed"))))
15903 ((org-clock-update-time-maybe))
15904 (t (error "C-c C-c can do nothing useful at this location")))))
15906 (defun org-mode-restart ()
15907 "Restart Org-mode, to scan again for special lines.
15908 Also updates the keyword regular expressions."
15909 (interactive)
15910 (org-mode)
15911 (message "Org-mode restarted"))
15913 (defun org-kill-note-or-show-branches ()
15914 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
15915 (interactive)
15916 (if (not org-finish-function)
15917 (call-interactively 'show-branches)
15918 (let ((org-note-abort t))
15919 (funcall org-finish-function))))
15921 (defun org-return (&optional indent)
15922 "Goto next table row or insert a newline.
15923 Calls `org-table-next-row' or `newline', depending on context.
15924 See the individual commands for more information."
15925 (interactive)
15926 (cond
15927 ((bobp) (if indent (newline-and-indent) (newline)))
15928 ((org-at-table-p)
15929 (org-table-justify-field-maybe)
15930 (call-interactively 'org-table-next-row))
15931 ((and org-return-follows-link
15932 (eq (get-text-property (point) 'face) 'org-link))
15933 (call-interactively 'org-open-at-point))
15934 ((and (org-at-heading-p)
15935 (looking-at
15937 (org-show-entry)
15938 (end-of-line 1)
15939 (newline))
15940 (t (if indent (newline-and-indent) (newline)))))
15942 (defun org-return-indent ()
15943 "Goto next table row or insert a newline and indent.
15944 Calls `org-table-next-row' or `newline-and-indent', depending on
15945 context. See the individual commands for more information."
15946 (interactive)
15947 (org-return t))
15949 (defun org-ctrl-c-star ()
15950 "Compute table, or change heading status of lines.
15951 Calls `org-table-recalculate' or `org-toggle-heading',
15952 depending on context."
15953 (interactive)
15954 (cond
15955 ((org-at-table-p)
15956 (call-interactively 'org-table-recalculate))
15957 (t
15958 ;; Convert all lines in region to list items
15959 (call-interactively 'org-toggle-heading))))
15961 (defun org-ctrl-c-minus ()
15962 "Insert separator line in table or modify bullet status of line.
15963 Also turns a plain line or a region of lines into list items.
15964 Calls `org-table-insert-hline', `org-toggle-item', or
15965 `org-cycle-list-bullet', depending on context."
15966 (interactive)
15967 (cond
15968 ((org-at-table-p)
15969 (call-interactively 'org-table-insert-hline))
15970 ((org-region-active-p)
15971 (call-interactively 'org-toggle-item))
15972 ((org-in-item-p)
15973 (call-interactively 'org-cycle-list-bullet))
15974 (t
15975 (call-interactively 'org-toggle-item))))
15977 (defun org-toggle-item ()
15978 "Convert headings or normal lines to items, items to normal lines.
15979 If there is no active region, only the current line is considered.
15981 If the first line in the region is a headline, convert all headlines to items.
15983 If the first line in the region is an item, convert all items to normal lines.
15985 If the first line is normal text, add an item bullet to each line."
15986 (interactive)
15987 (let (l2 l beg end)
15988 (if (org-region-active-p)
15989 (setq beg (region-beginning) end (region-end))
15990 (setq beg (point-at-bol)
15991 end (min (1+ (point-at-eol)) (point-max))))
15992 (save-excursion
15993 (goto-char end)
15994 (setq l2 (org-current-line))
15995 (goto-char beg)
15996 (beginning-of-line 1)
15997 (setq l (1- (org-current-line)))
15998 (if (org-at-item-p)
15999 ;; We already have items, de-itemize
16000 (while (< (setq l (1+ l)) l2)
16001 (when (org-at-item-p)
16002 (goto-char (match-beginning 2))
16003 (delete-region (match-beginning 2) (match-end 2))
16005 (beginning-of-line 2))
16006 (if (org-on-heading-p)
16007 ;; Headings, convert to items
16008 (while (< (setq l (1+ l)) l2)
16009 (if (looking-at org-outline-regexp)
16010 (replace-match "- " t t))
16011 (beginning-of-line 2))
16012 ;; normal lines, turn them into items
16013 (while (< (setq l (1+ l)) l2)
16014 (unless (org-at-item-p)
16017 (beginning-of-line 2)))))))
16019 (defun org-toggle-heading (&optional nstars)
16020 "Convert headings to normal text, or items or text to headings.
16021 If there is no active region, only the current line is considered.
16023 If the first line is a heading, remove the stars from all headlines
16024 in the region.
16026 If the first line is a plain list item, turn all plain list items
16027 into headings.
16029 If the first line is a normal line, turn each and every line in the
16030 region into a heading.
16032 When converting a line into a heading, the number of stars is chosen
16033 such that the lines become children of the current entry. However,
16034 when a prefix argument is given, its value determines the number of
16035 stars to add."
16036 (interactive "P")
16037 (let (l2 l itemp beg end)
16038 (if (org-region-active-p)
16039 (setq beg (region-beginning) end (region-end))
16040 (setq beg (point-at-bol)
16041 end (min (1+ (point-at-eol)) (point-max))))
16042 (save-excursion
16043 (goto-char end)
16044 (setq l2 (org-current-line))
16045 (goto-char beg)
16046 (beginning-of-line 1)
16047 (setq l (1- (org-current-line)))
16048 (if (org-on-heading-p)
16049 ;; We already have headlines, de-star them
16050 (while (< (setq l (1+ l)) l2)
16051 (when (org-on-heading-p t)
16052 (and (looking-at outline-regexp) (replace-match "")))
16053 (beginning-of-line 2))
16054 (setq itemp (org-at-item-p))
16055 (let* ((stars
16056 (if nstars
16057 (make-string (prefix-numeric-value current-prefix-arg)
16058 ?*)
16059 (save-excursion
16060 (if (re-search-backward org-complex-heading-regexp nil t)
16061 (match-string 1) ""))))
16062 (add-stars (cond (nstars "")
16063 ((equal stars "") "*")
16064 (org-odd-levels-only "**")
16065 (t "*")))
16066 (rpl (concat stars add-stars " ")))
16067 (while (< (setq l (1+ l)) l2)
16068 (if itemp
16069 (and (org-at-item-p) (replace-match rpl t t))
16070 (unless (org-on-heading-p)
16072 (replace-match (concat rpl (match-string 2))))))
16073 (beginning-of-line 2)))))))
16075 (defun org-meta-return (&optional arg)
16076 "Insert a new heading or wrap a region in a table.
16077 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
16078 See the individual commands for more information."
16079 (interactive "P")
16080 (cond
16081 ((run-hook-with-args-until-success 'org-metareturn-hook))
16082 ((org-at-table-p)
16083 (call-interactively 'org-table-wrap-region))
16084 (t (call-interactively 'org-insert-heading))))
16086 ;;; Menu entries
16088 ;; Define the Org-mode menus
16089 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
16090 '("Tbl"
16091 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
16092 ["Next Field" org-cycle (org-at-table-p)]
16093 ["Previous Field" org-shifttab (org-at-table-p)]
16094 ["Next Row" org-return (org-at-table-p)]
16095 "--"
16096 ["Blank Field" org-table-blank-field (org-at-table-p)]
16097 ["Edit Field" org-table-edit-field (org-at-table-p)]
16098 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
16099 "--"
16100 ("Column"
16101 ["Move Column Left" org-metaleft (org-at-table-p)]
16102 ["Move Column Right" org-metaright (org-at-table-p)]
16103 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
16104 ["Insert Column" org-shiftmetaright (org-at-table-p)])
16105 ("Row"
16106 ["Move Row Up" org-metaup (org-at-table-p)]
16107 ["Move Row Down" org-metadown (org-at-table-p)]
16108 ["Delete Row" org-shiftmetaup (org-at-table-p)]
16109 ["Insert Row" org-shiftmetadown (org-at-table-p)]
16110 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
16111 "--"
16112 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
16113 ("Rectangle"
16114 ["Copy Rectangle" org-copy-special (org-at-table-p)]
16115 ["Cut Rectangle" org-cut-special (org-at-table-p)]
16116 ["Paste Rectangle" org-paste-special (org-at-table-p)]
16117 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
16118 "--"
16119 ("Calculate"
16120 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
16121 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
16122 ["Edit Formulas" org-edit-special (org-at-table-p)]
16123 "--"
16124 ["Recalculate line" org-table-recalculate (org-at-table-p)]
16125 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
16126 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
16127 "--"
16128 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
16129 "--"
16130 ["Sum Column/Rectangle" org-table-sum
16131 (or (org-at-table-p) (org-region-active-p))]
16132 ["Which Column?" org-table-current-column (org-at-table-p)])
16133 ["Debug Formulas"
16134 org-table-toggle-formula-debugger
16135 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
16136 ["Show Col/Row Numbers"
16137 org-table-toggle-coordinate-overlays
16138 :style toggle
16139 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
16140 "--"
16141 ["Create" org-table-create (and (not (org-at-table-p))
16142 org-enable-table-editor)]
16143 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
16144 ["Import from File" org-table-import (not (org-at-table-p))]
16145 ["Export to File" org-table-export (org-at-table-p)]
16146 "--"
16147 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
16149 (easy-menu-define org-org-menu org-mode-map "Org menu"
16150 '("Org"
16151 ("Show/Hide"
16152 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
16153 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
16154 ["Sparse Tree..." org-sparse-tree t]
16155 ["Reveal Context" org-reveal t]
16156 ["Show All" show-all t]
16157 "--"
16158 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
16159 "--"
16160 ["New Heading" org-insert-heading t]
16161 ("Navigate Headings"
16162 ["Up" outline-up-heading t]
16163 ["Next" outline-next-visible-heading t]
16164 ["Previous" outline-previous-visible-heading t]
16165 ["Next Same Level" outline-forward-same-level t]
16166 ["Previous Same Level" outline-backward-same-level t]
16167 "--"
16168 ["Jump" org-goto t])
16169 ("Edit Structure"
16170 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
16171 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
16172 "--"
16173 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
16174 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
16175 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
16176 "--"
16177 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
16178 "--"
16179 ["Promote Heading" org-metaleft (not (org-at-table-p))]
16180 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
16181 ["Demote Heading" org-metaright (not (org-at-table-p))]
16182 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
16183 "--"
16184 ["Sort Region/Children" org-sort (not (org-at-table-p))]
16185 "--"
16186 ["Convert to odd levels" org-convert-to-odd-levels t]
16187 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
16188 ("Editing"
16189 ["Emphasis..." org-emphasize t]
16190 ["Edit Source Example" org-edit-special t]
16191 "--"
16192 ["Footnote new/jump" org-footnote-action t]
16193 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
16194 ("Archive"
16195 ["Archive (default method)" org-archive-subtree-default t]
16196 "--"
16197 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
16198 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
16199 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
16200 )
16201 "--"
16202 ("Hyperlinks"
16203 ["Store Link (Global)" org-store-link t]
16204 ["Find existing link to here" org-occur-link-in-agenda-files t]
16205 ["Insert Link" org-insert-link t]
16206 ["Follow Link" org-open-at-point t]
16207 "--"
16208 ["Next link" org-next-link t]
16209 ["Previous link" org-previous-link t]
16210 "--"
16211 ["Descriptive Links"
16212 (progn (org-add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
16213 :style radio
16214 :selected (member '(org-link) buffer-invisibility-spec)]
16215 ["Literal Links"
16216 (progn
16217 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
16218 :style radio
16219 :selected (not (member '(org-link) buffer-invisibility-spec))])
16220 "--"
16221 ("TODO Lists"
16222 ["TODO/DONE/-" org-todo t]
16223 ("Select keyword"
16224 ["Next keyword" org-shiftright (org-on-heading-p)]
16225 ["Previous keyword" org-shiftleft (org-on-heading-p)]
16226 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
16227 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
16228 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
16229 ["Show TODO Tree" org-show-todo-tree t]
16230 ["Global TODO list" org-todo-list t]
16231 "--"
16232 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
16233 :selected org-enforce-todo-dependencies :style toggle :active t]
16234 "Settings for tree at point"
16235 ["Do Children sequentially" org-toggle-ordered-property :style radio
16236 :selected (ignore-errors (org-entry-get nil "ORDERED"))
16237 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
16238 ["Do Children parallel" org-toggle-ordered-property :style radio
16239 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
16240 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
16241 "--"
16242 ["Set Priority" org-priority t]
16243 ["Priority Up" org-shiftup t]
16244 ["Priority Down" org-shiftdown t]
16245 "--"
16246 ["Get news from all feeds" org-feed-update-all t]
16247 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
16248 ["Customize feeds" (customize-variable 'org-feed-alist) t])
16249 ("TAGS and Properties"
16250 ["Set Tags" org-set-tags-command t]
16251 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
16252 "--"
16253 ["Set property" org-set-property t]
16254 ["Column view of properties" org-columns t]
16255 ["Insert Column View DBlock" org-insert-columns-dblock t])
16256 ("Dates and Scheduling"
16257 ["Timestamp" org-time-stamp t]
16258 ["Timestamp (inactive)" org-time-stamp-inactive t]
16259 ("Change Date"
16260 ["1 Day Later" org-shiftright t]
16261 ["1 Day Earlier" org-shiftleft t]
16262 ["1 ... Later" org-shiftup t]
16263 ["1 ... Earlier" org-shiftdown t])
16264 ["Compute Time Range" org-evaluate-time-range t]
16265 ["Schedule Item" org-schedule t]
16266 ["Deadline" org-deadline t]
16267 "--"
16268 ["Custom time format" org-toggle-time-stamp-overlays
16269 :style radio :selected org-display-custom-times]
16270 "--"
16271 ["Goto Calendar" org-goto-calendar t]
16272 ["Date from Calendar" org-date-from-calendar t]
16273 "--"
16274 ["Start/Restart Timer" org-timer-start t]
16275 ["Pause/Continue Timer" org-timer-pause-or-continue t]
16276 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
16277 ["Insert Timer String" org-timer t]
16278 ["Insert Timer Item" org-timer-item t])
16279 ("Logging work"
16280 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
16281 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
16282 ["Clock out" org-clock-out t]
16283 ["Clock cancel" org-clock-cancel t]
16284 "--"
16285 ["Mark as default task" org-clock-mark-default-task t]
16286 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
16287 ["Goto running clock" org-clock-goto t]
16288 "--"
16289 ["Display times" org-clock-display t]
16290 ["Create clock table" org-clock-report t]
16291 "--"
16292 ["Record DONE time"
16293 (progn (setq org-log-done (not org-log-done))
16294 (message "Switching to %s will %s record a timestamp"
16295 (car org-done-keywords)
16296 (if org-log-done "automatically" "not")))
16297 :style toggle :selected org-log-done])
16298 "--"
16299 ["Agenda Command..." org-agenda t]
16300 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
16301 ("File List for Agenda")
16302 ("Special views current file"
16303 ["TODO Tree" org-show-todo-tree t]
16304 ["Check Deadlines" org-check-deadlines t]
16305 ["Timeline" org-timeline t]
16306 ["Tags/Property tree" org-match-sparse-tree t])
16307 "--"
16308 ["Export/Publish..." org-export t]
16309 ("LaTeX"
16310 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
16311 :selected org-cdlatex-mode]
16312 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
16313 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
16314 ["Modify math symbol" org-cdlatex-math-modify
16315 (org-inside-LaTeX-fragment-p)]
16316 ["Insert citation" org-reftex-citation t]
16317 "--"
16318 ["Export LaTeX fragments as images"
16319 (if (featurep 'org-exp)
16320 (setq org-export-with-LaTeX-fragments
16321 (not org-export-with-LaTeX-fragments))
16322 (require 'org-exp))
16323 :style toggle :selected (and (boundp 'org-export-with-LaTeX-fragments)
16324 org-export-with-LaTeX-fragments)]
16325 "--"
16326 ["Template for BEAMER" org-beamer-settings-template t])
16327 "--"
16328 ("MobileOrg"
16329 ["Push Files and Views" org-mobile-push t]
16330 ["Get Captured and Flagged" org-mobile-pull t]
16331 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
16332 "--"
16333 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
16334 "--"
16335 ("Documentation"
16336 ["Show Version" org-version t]
16337 ["Info Documentation" org-info t])
16338 ("Customize"
16339 ["Browse Org Group" org-customize t]
16340 "--"
16341 ["Expand This Menu" org-create-customize-menu
16342 (fboundp 'customize-menu-create)])
16343 ["Send bug report" org-submit-bug-report t]
16344 "--"
16345 ("Refresh/Reload"
16346 ["Refresh setup current buffer" org-mode-restart t]
16347 ["Reload Org (after update)" org-reload t]
16348 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
16349 ))
16351 (defun org-info (&optional node)
16352 "Read documentation for Org-mode in the info system.
16353 With optional NODE, go directly to that node."
16354 (interactive)
16355 (info (format "(org)%s" (or node ""))))
16357 ;;;###autoload
16358 (defun org-submit-bug-report ()
16359 "Submit a bug report on Org-mode via mail.
16361 Don't hesitate to report any problems or inaccurate documentation.
16363 If you don't have setup sending mail from (X)Emacs, please copy the
16364 output buffer into your mail program, as it gives us important
16365 information about your Org-mode version and configuration."
16366 (interactive)
16367 (require 'reporter)
16368 (org-load-modules-maybe)
16369 (org-require-autoloaded-modules)
16370 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
16371 (reporter-submit-bug-report
16372 "emacs-orgmode@gnu.org"
16373 (org-version)
16374 (let (list)
16375 (save-window-excursion
16376 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
16377 (delete-other-windows)
16378 (erase-buffer)
16379 (insert "You are about to submit a bug report to the Org-mode mailing list.
16381 We would like to add your full Org-mode and Outline configuration to the
16382 bug report. This greatly simplifies the work of the maintainer and
16383 other experts on the mailing list.
16385 HOWEVER, some variables you have customized may contain private
16386 information. The names of customers, colleagues, or friends, might
16387 appear in the form of file names, tags, todo states, or search strings.
16388 If you answer yes to the prompt, you might want to check and remove
16389 such private information before sending the email.")
16390 (add-text-properties (point-min) (point-max) '(face org-warning))
16391 (when (yes-or-no-p "Include your Org-mode configuration ")
16392 (mapatoms
16393 (lambda (v)
16394 (and (boundp v)
16396 (or (and (symbol-value v)
16398 (and
16399 (get v 'custom-type) (get v 'standard-value)
16400 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
16401 (push v list)))))
16402 (kill-buffer (get-buffer "*Warn about privacy*"))
16403 list))
16404 nil nil
16405 "Remember to cover the basics, that is, what you expected to happen and
16406 what in fact did happen. You don't know how to make a good report? See
16408 http://orgmode.org/manual/Feedback.html#Feedback
16410 Your bug report will be posted to the Org-mode mailing list.
16411 ------------------------------------------------------------------------")
16412 (save-excursion
16417 (defun org-install-agenda-files-menu ()
16418 (let ((bl (buffer-list)))
16419 (save-excursion
16420 (while bl
16421 (set-buffer (pop bl))
16422 (if (org-mode-p) (setq bl nil)))
16423 (when (org-mode-p)
16424 (easy-menu-change
16425 '("Org") "File List for Agenda"
16426 (append
16427 (list
16428 ["Edit File List" (org-edit-agenda-file-list) t]
16429 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
16430 ["Remove Current File from List" org-remove-file t]
16431 ["Cycle through agenda files" org-cycle-agenda-files t]
16432 ["Occur in all agenda files" org-occur-in-agenda-files t]
16433 "--")
16434 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
16436 ;;;; Documentation
16438 ;;;###autoload
16439 (defun org-require-autoloaded-modules ()
16440 (interactive)
16441 (mapc 'require
16442 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
16443 org-docbook org-exp org-html org-icalendar
16444 org-id org-latex
16445 org-publish org-remember org-table
16446 org-timer org-xoxo)))
16448 ;;;###autoload
16449 (defun org-reload (&optional uncompiled)
16450 "Reload all org lisp files.
16451 With prefix arg UNCOMPILED, load the uncompiled versions."
16452 (interactive "P")
16453 (require 'find-func)
16455 (dir-org (file-name-directory (org-find-library-name "org")))
16456 (dir-org-contrib (ignore-errors
16457 (file-name-directory
16458 (org-find-library-name "org-contribdir"))))
16459 (files
16460 (append (directory-files dir-org t file-re)
16461 (and dir-org-contrib
16462 (directory-files dir-org-contrib t file-re))))
16463 (remove-re (concat (if (featurep 'xemacs)
16464 "org-colview" "org-colview-xemacs")
16466 (setq files (mapcar 'file-name-sans-extension files))
16467 (setq files (mapcar
16468 (lambda (x) (if (string-match remove-re x) nil x))
16469 files))
16470 (setq files (delq nil files))
16471 (mapc
16472 (lambda (f)
16473 (when (featurep (intern (file-name-nondirectory f)))
16474 (if (and (not uncompiled)
16475 (file-exists-p (concat f ".elc")))
16476 (load (concat f ".elc") nil nil t)
16477 (load (concat f ".el") nil nil t))))
16478 files))
16479 (org-version))
16481 ;;;###autoload
16482 (defun org-customize ()
16483 "Call the customize function with org as argument."
16484 (interactive)
16485 (org-load-modules-maybe)
16486 (org-require-autoloaded-modules)
16487 (customize-browse 'org))
16489 (defun org-create-customize-menu ()
16490 "Create a full customization menu for Org-mode, insert it into the menu."
16491 (interactive)
16492 (org-load-modules-maybe)
16493 (org-require-autoloaded-modules)
16494 (if (fboundp 'customize-menu-create)
16495 (progn
16496 (easy-menu-change
16497 '("Org") "Customize"
16498 `(["Browse Org group" org-customize t]
16499 "--"
16500 ,(customize-menu-create 'org)
16501 ["Set" Custom-set t]
16502 ["Save" Custom-save t]
16503 ["Reset to Current" Custom-reset-current t]
16504 ["Reset to Saved" Custom-reset-saved t]
16505 ["Reset to Standard Settings" Custom-reset-standard t]))
16507 (error "Cannot expand menu (outdated version of cus-edit.el)")))
16509 ;;;; Miscellaneous stuff
16511 ;;; Generally useful functions
16513 (defun org-get-at-bol (property)
16514 "Get text property PROPERTY at beginning of line."
16515 (get-text-property (point-at-bol) property))
16517 (defun org-find-text-property-in-string (prop s)
16518 "Return the first non-nil value of property PROP in string S."
16519 (or (get-text-property 0 prop s)
16520 (get-text-property (or (next-single-property-change 0 prop s) 0)
16521 prop s)))
16523 (defun org-display-warning (message) ;; Copied from Emacs-Muse
16524 "Display the given MESSAGE as a warning."
16525 (if (fboundp 'display-warning)
16526 (display-warning 'org message
16527 (if (featurep 'xemacs)
16528 'warning
16529 :warning))
16530 (let ((buf (get-buffer-create "*Org warnings*")))
16531 (with-current-buffer buf
16532 (goto-char (point-max))
16533 (insert "Warning (Org): " message)
16534 (unless (bolp)
16535 (newline)))
16536 (display-buffer buf)
16537 (sit-for 0))))
16539 (defun org-in-commented-line ()
16540 "Is point in a line starting with `#'?"
16541 (equal (char-after (point-at-bol)) ?#))
16543 (defun org-in-verbatim-emphasis ()
16544 (save-match-data
16545 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
16547 (defun org-goto-marker-or-bmk (marker &optional bookmark)
16548 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
16549 (if (and marker (marker-buffer marker)
16550 (buffer-live-p (marker-buffer marker)))
16551 (progn
16552 (switch-to-buffer (marker-buffer marker))
16553 (if (or (> marker (point-max)) (< marker (point-min)))
16554 (widen))
16555 (goto-char marker)
16556 (org-show-context 'org-goto))
16557 (if bookmark
16558 (bookmark-jump bookmark)
16559 (error "Cannot find location"))))
16561 (defun org-quote-csv-field (s)
16562 "Quote field for inclusion in CSV material."
16565 s))
16567 (defun org-plist-delete (plist property)
16568 "Delete PROPERTY from PLIST.
16569 This is in contrast to merely setting it to 0."
16570 (let (p)
16571 (while plist
16572 (if (not (eq property (car plist)))
16573 (setq p (plist-put p (car plist) (nth 1 plist))))
16574 (setq plist (cddr plist)))
16575 p))
16577 (defun org-force-self-insert (N)
16578 "Needed to enforce self-insert under remapping."
16579 (interactive "p")
16580 (self-insert-command N))
16582 (defun org-string-width (s)
16583 "Compute width of string, ignoring invisible characters.
16584 This ignores character with invisibility property `org-link', and also
16585 characters with property `org-cwidth', because these will become invisible
16586 upon the next fontification round."
16587 (let (b l)
16588 (when (or (eq t buffer-invisibility-spec)
16589 (assq 'org-link buffer-invisibility-spec))
16590 (while (setq b (text-property-any 0 (length s)
16591 'invisible 'org-link s))
16592 (setq s (concat (substring s 0 b)
16593 (substring s (or (next-single-property-change
16594 b 'invisible s) (length s)))))))
16595 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
16596 (setq s (concat (substring s 0 b)
16597 (substring s (or (next-single-property-change
16598 b 'org-cwidth s) (length s))))))
16599 (setq l (string-width s) b -1)
16600 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
16601 (setq l (- l (get-text-property b 'org-dwidth-n s))))
16602 l))
16604 (defun org-get-indentation (&optional line)
16605 "Get the indentation of the current line, interpreting tabs.
16606 When LINE is given, assume it represents a line and compute its indentation."
16607 (if line
16608 (if (string-match "^ *" (org-remove-tabs line))
16609 (match-end 0))
16610 (save-excursion
16611 (beginning-of-line 1)
16613 (current-column))))
16615 (defun org-remove-tabs (s &optional width)
16616 "Replace tabulators in S with spaces.
16617 Assumes that s is a single line, starting in column 0."
16618 (setq width (or width tab-width))
16620 (setq s (replace-match
16621 (make-string
16622 (- (* width (/ (+ (match-beginning 0) width) width))
16623 (match-beginning 0)) ?\ )
16624 t t s)))
16625 s)
16627 (defun org-fix-indentation (line ind)
16628 "Fix indentation in LINE.
16629 IND is a cons cell with target and minimum indentation.
16630 If the current indentation in LINE is smaller than the minimum,
16631 leave it alone. If it is larger than ind, set it to the target."
16632 (let* ((l (org-remove-tabs line))
16633 (i (org-get-indentation l))
16634 (i1 (car ind)) (i2 (cdr ind)))
16635 (if (>= i i2) (setq l (substring line i2)))
16636 (if (> i1 0)
16637 (concat (make-string i1 ?\ ) l)
16638 l)))
16640 (defun org-remove-indentation (code &optional n)
16641 "Remove the maximum common indentation from the lines in CODE.
16642 N may optionally be the number of spaces to remove."
16643 (with-temp-buffer
16644 (insert code)
16645 (org-do-remove-indentation n)
16646 (buffer-string)))
16648 (defun org-do-remove-indentation (&optional n)
16649 "Remove the maximum common indentation from the buffer."
16650 (untabify (point-min) (point-max))
16651 (let ((min 10000) re)
16652 (if n
16653 (setq min n)
16654 (goto-char (point-min))
16656 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
16657 (unless (or (= min 0) (= min 10000))
16659 (goto-char (point-min))
16660 (while (re-search-forward re nil t)
16661 (replace-match "")
16662 (end-of-line 1))
16663 min)))
16665 (defun org-fill-template (template alist)
16666 "Find each %key of ALIST in TEMPLATE and replace it."
16667 (let ((case-fold-search nil)
16668 entry key value)
16669 (setq alist (sort (copy-sequence alist)
16670 (lambda (a b) (< (length (car a)) (length (car b))))))
16671 (while (setq entry (pop alist))
16672 (setq template
16673 (replace-regexp-in-string
16674 (concat "%" (regexp-quote (car entry)))
16675 (cdr entry) template t t)))
16676 template))
16678 (defun org-base-buffer (buffer)
16679 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
16680 (if (not buffer)
16681 buffer
16682 (or (buffer-base-buffer buffer)
16683 buffer)))
16685 (defun org-trim (s)
16686 "Remove whitespace at beginning and end of string."
16689 s)
16691 (defun org-wrap (string &optional width lines)
16692 "Wrap string to either a number of lines, or a width in characters.
16693 If WIDTH is non-nil, the string is wrapped to that width, however many lines
16694 that costs. If there is a word longer than WIDTH, the text is actually
16695 wrapped to the length of that word.
16696 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
16697 many lines, whatever width that takes.
16698 The return value is a list of lines, without newlines at the end."
16700 (maxword (apply 'max (mapcar 'org-string-width words)))
16701 w ll)
16702 (cond (width
16703 (org-do-wrap words (max maxword width)))
16704 (lines
16705 (setq w maxword)
16706 (setq ll (org-do-wrap words maxword))
16707 (if (<= (length ll) lines)
16708 ll
16709 (setq ll words)
16710 (while (> (length ll) lines)
16711 (setq w (1+ w))
16712 (setq ll (org-do-wrap words w)))
16713 ll))
16714 (t (error "Cannot wrap this")))))
16716 (defun org-do-wrap (words width)
16717 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
16718 (let (lines line)
16719 (while words
16720 (setq line (pop words))
16721 (while (and words (< (+ (length line) (length (car words))) width))
16722 (setq line (concat line " " (pop words))))
16723 (setq lines (push line lines)))
16724 (nreverse lines)))
16726 (defun org-split-string (string &optional separators)
16727 "Splits STRING into substrings at SEPARATORS.
16728 No empty strings are returned if there are matches at the beginning
16729 and end of string."
16731 (start 0)
16732 notfirst
16733 (list nil))
16734 (while (and (string-match rexp string
16735 (if (and notfirst
16736 (= start (match-beginning 0))
16737 (< start (length string)))
16738 (1+ start) start))
16739 (< (match-beginning 0) (length string)))
16740 (setq notfirst t)
16741 (or (eq (match-beginning 0) 0)
16742 (and (eq (match-beginning 0) (match-end 0))
16743 (eq (match-beginning 0) start))
16744 (setq list
16745 (cons (substring string start (match-beginning 0))
16746 list)))
16747 (setq start (match-end 0)))
16748 (or (eq start (length string))
16749 (setq list
16750 (cons (substring string start)
16751 list)))
16752 (nreverse list)))
16754 (defun org-quote-vert (s)
16756 (while (string-match "|" s)
16758 s)
16760 (defun org-uuidgen-p (s)
16761 "Is S an ID created by UUIDGEN?"
16762 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
16764 (defun org-context ()
16765 "Return a list of contexts of the current cursor position.
16766 If several contexts apply, all are returned.
16767 Each context entry is a list with a symbol naming the context, and
16768 two positions indicating start and end of the context. Possible
16769 contexts are:
16771 :headline anywhere in a headline
16772 :headline-stars on the leading stars in a headline
16773 :todo-keyword on a TODO keyword (including DONE) in a headline
16774 :tags on the TAGS in a headline
16775 :priority on the priority cookie in a headline
16776 :item on the first line of a plain list item
16777 :item-bullet on the bullet/number of a plain list item
16778 :checkbox on the checkbox in a plain list item
16779 :table in an org-mode table
16780 :table-special on a special filed in a table
16781 :table-table in a table.el table
16782 :link on a hyperlink
16783 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
16784 :target on a <<target>>
16785 :radio-target on a <<<radio-target>>>
16786 :latex-fragment on a LaTeX fragment
16787 :latex-preview on a LaTeX fragment with overlayed preview image
16789 This function expects the position to be visible because it uses font-lock
16790 faces as a help to recognize the following contexts: :table-special, :link,
16791 and :keyword."
16792 (let* ((f (get-text-property (point) 'face))
16793 (faces (if (listp f) f (list f)))
16794 (p (point)) clist o)
16795 ;; First the large context
16796 (cond
16797 ((org-on-heading-p t)
16798 (push (list :headline (point-at-bol) (point-at-eol)) clist)
16799 (when (progn
16800 (beginning-of-line 1)
16801 (looking-at org-todo-line-tags-regexp))
16802 (push (org-point-in-group p 1 :headline-stars) clist)
16803 (push (org-point-in-group p 2 :todo-keyword) clist)
16804 (push (org-point-in-group p 4 :tags) clist))
16805 (goto-char p)
16808 (push (org-point-in-group p 0 :priority) clist)))
16810 ((org-at-item-p)
16811 (push (org-point-in-group p 2 :item-bullet) clist)
16812 (push (list :item (point-at-bol)
16813 (save-excursion (org-end-of-item) (point)))
16814 clist)
16815 (and (org-at-item-checkbox-p)
16816 (push (org-point-in-group p 0 :checkbox) clist)))
16818 ((org-at-table-p)
16819 (push (list :table (org-table-begin) (org-table-end)) clist)
16820 (if (memq 'org-formula faces)
16821 (push (list :table-special
16822 (previous-single-property-change p 'face)
16823 (next-single-property-change p 'face)) clist)))
16824 ((org-at-table-p 'any)
16825 (push (list :table-table) clist)))
16826 (goto-char p)
16828 ;; Now the small context
16829 (cond
16830 ((org-at-timestamp-p)
16831 (push (org-point-in-group p 0 :timestamp) clist))
16832 ((memq 'org-link faces)
16833 (push (list :link
16834 (previous-single-property-change p 'face)
16835 (next-single-property-change p 'face)) clist))
16836 ((memq 'org-special-keyword faces)
16837 (push (list :keyword
16838 (previous-single-property-change p 'face)
16839 (next-single-property-change p 'face)) clist))
16840 ((org-on-target-p)
16841 (push (org-point-in-group p 0 :target) clist)
16842 (goto-char (1- (match-beginning 0)))
16843 (if (looking-at org-radio-target-regexp)
16844 (push (org-point-in-group p 0 :radio-target) clist))
16845 (goto-char p))
16846 ((setq o (car (delq nil
16847 (mapcar
16848 (lambda (x)
16849 (if (memq x org-latex-fragment-image-overlays) x))
16850 (org-overlays-at (point))))))
16851 (push (list :latex-fragment
16852 (org-overlay-start o) (org-overlay-end o)) clist)
16853 (push (list :latex-preview
16854 (org-overlay-start o) (org-overlay-end o)) clist))
16855 ((org-inside-LaTeX-fragment-p)
16856 ;; FIXME: positions wrong.
16857 (push (list :latex-fragment (point) (point)) clist)))
16859 (setq clist (nreverse (delq nil clist)))
16860 clist))
16862 ;; FIXME: Compare with at-regexp-p Do we need both?
16863 (defun org-in-regexp (re &optional nlines visually)
16864 "Check if point is inside a match of regexp.
16865 Normally only the current line is checked, but you can include NLINES extra
16866 lines both before and after point into the search.
16867 If VISUALLY is set, require that the cursor is not after the match but
16868 really on, so that the block visually is on the match."
16869 (catch 'exit
16870 (let ((pos (point))
16871 (eol (point-at-eol (+ 1 (or nlines 0))))
16872 (inc (if visually 1 0)))
16873 (save-excursion
16874 (beginning-of-line (- 1 (or nlines 0)))
16875 (while (re-search-forward re eol t)
16876 (if (and (<= (match-beginning 0) pos)
16877 (>= (+ inc (match-end 0)) pos))
16878 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
16880 (defun org-at-regexp-p (regexp)
16881 "Is point inside a match of REGEXP in the current line?"
16882 (catch 'exit
16883 (save-excursion
16884 (let ((pos (point)) (end (point-at-eol)))
16885 (beginning-of-line 1)
16886 (while (re-search-forward regexp end t)
16887 (if (and (<= (match-beginning 0) pos)
16888 (>= (match-end 0) pos))
16889 (throw 'exit t)))
16890 nil))))
16892 (defun org-occur-in-agenda-files (regexp &optional nlines)
16893 "Call `multi-occur' with buffers for all agenda files."
16895 (let* ((files (org-agenda-files))
16896 (tnames (mapcar 'file-truename files))
16897 (extra org-agenda-text-search-extra-files)
16898 f)
16899 (when (eq (car extra) 'agenda-archives)
16900 (setq extra (cdr extra))
16901 (setq files (org-add-archive-files files)))
16902 (while (setq f (pop extra))
16903 (unless (member (file-truename f) tnames)
16904 (add-to-list 'files f 'append)
16905 (add-to-list 'tnames (file-truename f) 'append)))
16906 (multi-occur
16907 (mapcar (lambda (x)
16908 (with-current-buffer
16909 (or (get-file-buffer x) (find-file-noselect x))
16910 (widen)
16911 (current-buffer)))
16912 files)
16913 regexp)))
16915 (if (boundp 'occur-mode-find-occurrence-hook)
16916 ;; Emacs 23
16917 (add-hook 'occur-mode-find-occurrence-hook
16918 (lambda ()
16919 (when (org-mode-p)
16920 (org-reveal))))
16921 ;; Emacs 22
16922 (defadvice occur-mode-goto-occurrence
16923 (after org-occur-reveal activate)
16924 (and (org-mode-p) (org-reveal)))
16925 (defadvice occur-mode-goto-occurrence-other-window
16926 (after org-occur-reveal activate)
16927 (and (org-mode-p) (org-reveal)))
16928 (defadvice occur-mode-display-occurrence
16929 (after org-occur-reveal activate)
16930 (when (org-mode-p)
16931 (let ((pos (occur-mode-find-occurrence)))
16932 (with-current-buffer (marker-buffer pos)
16933 (save-excursion
16934 (goto-char pos)
16935 (org-reveal)))))))
16937 (defun org-occur-link-in-agenda-files ()
16938 "Create a link and search for it in the agendas.
16939 The link is not stored in `org-stored-links', it is just created
16940 for the search purpose."
16941 (interactive)
16942 (let ((link (condition-case nil
16943 (org-store-link nil)
16944 (error "Unable to create a link to here"))))
16945 (org-occur-in-agenda-files (regexp-quote link))))
16947 (defun org-uniquify (list)
16948 "Remove duplicate elements from LIST."
16949 (let (res)
16950 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
16951 res))
16953 (defun org-delete-all (elts list)
16954 "Remove all elements in ELTS from LIST."
16955 (while elts
16956 (setq list (delete (pop elts) list)))
16957 list)
16959 (defun org-back-over-empty-lines ()
16960 "Move backwards over whitespace, to the beginning of the first empty line.
16961 Returns the number of empty lines passed."
16962 (let ((pos (point)))
16964 (beginning-of-line 2)
16965 (goto-char (min (point) pos))
16966 (count-lines (point) pos)))
16968 (defun org-skip-whitespace ()
16971 (defun org-point-in-group (point group &optional context)
16972 "Check if POINT is in match-group GROUP.
16973 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
16974 match. If the match group does ot exist or point is not inside it,
16975 return nil."
16976 (and (match-beginning group)
16977 (>= point (match-beginning group))
16978 (<= point (match-end group))
16979 (if context
16980 (list context (match-beginning group) (match-end group))
16981 t)))
16983 (defun org-switch-to-buffer-other-window (&rest args)
16984 "Switch to buffer in a second window on the current frame.
16985 In particular, do not allow pop-up frames."
16986 (let (pop-up-frames special-display-buffer-names special-display-regexps
16987 special-display-function)
16988 (apply 'switch-to-buffer-other-window args)))
16990 (defun org-combine-plists (&rest plists)
16991 "Create a single property list from all plists in PLISTS.
16992 The process starts by copying the first list, and then setting properties
16993 from the other lists. Settings in the last list are the most significant
16994 ones and overrule settings in the other lists."
16995 (let ((rtn (copy-sequence (pop plists)))
16996 p v ls)
16997 (while plists
16998 (setq ls (pop plists))
16999 (while ls
17000 (setq p (pop ls) v (pop ls))
17001 (setq rtn (plist-put rtn p v))))
17002 rtn))
17004 (defun org-move-line-down (arg)
17005 "Move the current line down. With prefix argument, move it past ARG lines."
17006 (interactive "p")
17007 (let ((col (current-column))
17008 beg end pos)
17009 (beginning-of-line 1) (setq beg (point))
17010 (beginning-of-line 2) (setq end (point))
17011 (beginning-of-line (+ 1 arg))
17012 (setq pos (move-marker (make-marker) (point)))
17013 (insert (delete-and-extract-region beg end))
17014 (goto-char pos)
17015 (org-move-to-column col)))
17017 (defun org-move-line-up (arg)
17018 "Move the current line up. With prefix argument, move it past ARG lines."
17019 (interactive "p")
17020 (let ((col (current-column))
17021 beg end pos)
17022 (beginning-of-line 1) (setq beg (point))
17023 (beginning-of-line 2) (setq end (point))
17024 (beginning-of-line (- arg))
17025 (setq pos (move-marker (make-marker) (point)))
17026 (insert (delete-and-extract-region beg end))
17027 (goto-char pos)
17028 (org-move-to-column col)))
17030 (defun org-replace-escapes (string table)
17031 "Replace %-escapes in STRING with values in TABLE.
17033 The sequences in STRING may contain normal field width and padding information,
17035 so values can contain further %-escapes if they are define later in TABLE."
17036 (let ((case-fold-search nil)
17037 e re rpl)
17038 (while (setq e (pop table))
17039 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
17040 (while (string-match re string)
17041 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
17042 (cdr e)))
17043 (setq string (replace-match rpl t t string))))
17044 string))
17047 (defun org-sublist (list start end)
17048 "Return a section of LIST, from START to END.
17049 Counting starts at 1."
17050 (let (rtn (c start))
17051 (setq list (nthcdr (1- start) list))
17052 (while (and list (<= c end))
17053 (push (pop list) rtn)
17054 (setq c (1+ c)))
17055 (nreverse rtn)))
17057 (defun org-find-base-buffer-visiting (file)
17058 "Like `find-buffer-visiting' but always return the base buffer and
17059 not an indirect buffer."
17060 (let ((buf (or (get-file-buffer file)
17061 (find-buffer-visiting file))))
17062 (if buf
17063 (or (buffer-base-buffer buf) buf)
17064 nil)))
17066 (defun org-image-file-name-regexp (&optional extensions)
17067 "Return regexp matching the file names of images.
17068 If EXTENSIONS is given, only match these."
17069 (if (and (not extensions) (fboundp 'image-file-name-regexp))
17070 (image-file-name-regexp)
17071 (let ((image-file-name-extensions
17072 (or extensions
17073 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
17074 "xbm" "xpm" "pbm" "pgm" "ppm"))))
17076 (regexp-opt (nconc (mapcar 'upcase
17077 image-file-name-extensions)
17078 image-file-name-extensions)
17079 t)
17082 (defun org-file-image-p (file &optional extensions)
17083 "Return non-nil if FILE is an image."
17084 (save-match-data
17085 (string-match (org-image-file-name-regexp extensions) file)))
17087 (defun org-get-cursor-date ()
17088 "Return the date at cursor in as a time.
17089 This works in the calendar and in the agenda, anywhere else it just
17090 returns the current time."
17091 (let (date day defd)
17092 (cond
17093 ((eq major-mode 'calendar-mode)
17094 (setq date (calendar-cursor-to-date)
17095 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17096 ((eq major-mode 'org-agenda-mode)
17097 (setq day (get-text-property (point) 'day))
17098 (if day
17099 (setq date (calendar-gregorian-from-absolute day)
17100 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
17101 (nth 2 date))))))
17102 (or defd (current-time))))
17104 (defvar org-agenda-action-marker (make-marker)
17105 "Marker pointing to the entry for the next agenda action.")
17107 (defun org-mark-entry-for-agenda-action ()
17108 "Mark the current entry as target of an agenda action.
17109 Agenda actions are actions executed from the agenda with the key `k',
17110 which make use of the date at the cursor."
17111 (interactive)
17112 (move-marker org-agenda-action-marker
17113 (save-excursion (org-back-to-heading t) (point))
17114 (current-buffer))
17115 (message
17116 "Entry marked for action; press `k' at desired date in agenda or calendar"))
17118 ;;; Paragraph filling stuff.
17119 ;; We want this to be just right, so use the full arsenal.
17121 (defun org-indent-line-function ()
17122 "Indent line like previous, but further if previous was headline or item."
17123 (interactive)
17124 (let* ((pos (point))
17125 (itemp (org-at-item-p))
17126 (case-fold-search t)
17128 column bpos bcol tpos tcol bullet btype bullet-type)
17129 ;; Find the previous relevant line
17130 (beginning-of-line 1)
17131 (cond
17132 ((looking-at "#") (setq column 0))
17135 (save-excursion (re-search-backward org-drawer-regexp nil t)))
17136 (save-excursion
17137 (goto-char (1- (match-beginning 1)))
17138 (setq column (current-column))))
17140 (save-excursion
17141 (re-search-backward
17143 (setq column (org-get-indentation (match-string 0))))
17144 (t
17145 (beginning-of-line 0)
17148 (not (looking-at org-drawer-regexp)))
17149 (beginning-of-line 0))
17150 (cond
17152 (if (not org-adapt-indentation)
17153 (setq column 0)
17154 (goto-char (match-end 0))
17155 (setq column (current-column))))
17156 ((looking-at org-drawer-regexp)
17157 (goto-char (1- (match-beginning 1)))
17158 (setq column (current-column)))
17160 (goto-char (match-end 1))
17161 (setq column (current-column)))
17162 ((org-in-item-p)
17163 (org-beginning-of-item)
17165 (setq bpos (match-beginning 1) tpos (match-end 0)
17166 bcol (progn (goto-char bpos) (current-column))
17167 tcol (progn (goto-char tpos) (current-column))
17168 bullet (match-string 1)
17169 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
17170 (if (> tcol (+ bcol org-description-max-indent))
17171 (setq tcol (+ bcol 5)))
17172 (if (not itemp)
17173 (setq column tcol)
17174 (goto-char pos)
17175 (beginning-of-line 1)
17177 (progn
17179 (setq bullet (match-string 1)
17180 btype (if (string-match "[0-9]" bullet) "n" bullet))
17181 (setq column (if (equal btype bullet-type) bcol tcol)))
17182 (setq column (org-get-indentation)))))
17183 (t (setq column (org-get-indentation))))))
17184 (goto-char pos)
17185 (if (<= (current-column) (current-indentation))
17186 (org-indent-line-to column)
17187 (save-excursion (org-indent-line-to column)))
17188 (setq column (current-column))
17189 (beginning-of-line 1)
17190 (if (looking-at
17192 (replace-match (concat (match-string 1)
17193 (format org-property-format
17194 (match-string 2) (match-string 3)))
17195 t t))
17196 (org-move-to-column column)))
17198 (defun org-set-autofill-regexps ()
17199 (interactive)
17200 ;; In the paragraph separator we include headlines, because filling
17201 ;; text in a line directly attached to a headline would otherwise
17202 ;; fill the headline as well.
17205 ;; The paragraph starter includes hand-formatted lists.
17206 (org-set-local
17207 'paragraph-start
17208 (concat
17217 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
17218 ;; But only if the user has not turned off tables or fixed-width regions
17219 (org-set-local
17220 'auto-fill-inhibit-regexp
17223 (if (or org-enable-table-editor org-enable-fixed-width-editor)
17224 (concat
17226 (if org-enable-table-editor "|" "")
17227 (if org-enable-fixed-width-editor ":" "")
17228 "]"))))
17229 ;; We use our own fill-paragraph function, to make sure that tables
17230 ;; and fixed-width regions are not wrapped. That function will pass
17231 ;; through to `fill-paragraph' when appropriate.
17232 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
17233 ; Adaptive filling: To get full control, first make sure that
17234 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
17236 (org-set-local 'adaptive-fill-function
17237 'org-adaptive-fill-function)
17238 (org-set-local
17239 'align-mode-rules-list
17240 '((org-in-buffer-settings
17242 (modes . '(org-mode))))))
17244 (defun org-fill-paragraph (&optional justify)
17245 "Re-align a table, pass through to fill-paragraph if no table."
17246 (let ((table-p (org-at-table-p))
17247 (table.el-p (org-at-table.el-p)))
17248 (cond ((and (equal (char-after (point-at-bol)) ?*)
17249 (save-excursion (goto-char (point-at-bol))
17250 (looking-at outline-regexp)))
17251 t) ; skip headlines
17252 (table.el-p t) ; skip table.el tables
17253 (table-p (org-table-align) t) ; align org-mode tables
17254 (t nil)))) ; call paragraph-fill
17256 ;; For reference, this is the default value of adaptive-fill-regexp
17259 (defun org-adaptive-fill-function ()
17260 "Return a fill prefix for org-mode files.
17261 In particular, this makes sure hanging paragraphs for hand-formatted lists
17262 work correctly."
17264 (match-string 0))
17266 (save-excursion
17267 (if (> (match-end 1) (+ (match-beginning 1)
17268 org-description-max-indent))
17269 (goto-char (+ (match-beginning 1) 5))
17270 (goto-char (match-end 0)))
17271 (make-string (current-column) ?\ )))
17273 (save-excursion
17274 (goto-char (match-end 0))
17275 (make-string (current-column) ?\ )))
17276 (t nil)))
17278 ;;; Other stuff.
17280 (defun org-toggle-fixed-width-section (arg)
17281 "Toggle the fixed-width export.
17282 If there is no active region, the QUOTE keyword at the current headline is
17283 inserted or removed. When present, it causes the text between this headline
17284 and the next to be exported as fixed-width text, and unmodified.
17285 If there is an active region, this command adds or removes a colon as the
17286 first character of this line. If the first character of a line is a colon,
17287 this line is also exported in fixed-width font."
17288 (interactive "P")
17289 (let* ((cc 0)
17290 (regionp (org-region-active-p))
17291 (beg (if regionp (region-beginning) (point)))
17292 (end (if regionp (region-end)))
17293 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
17294 (case-fold-search nil)
17296 off)
17297 (if regionp
17298 (save-excursion
17299 (goto-char beg)
17300 (setq cc (current-column))
17301 (beginning-of-line 1)
17302 (setq off (looking-at re))
17303 (while (> nlines 0)
17304 (setq nlines (1- nlines))
17305 (beginning-of-line 1)
17306 (cond
17307 (arg
17308 (org-move-to-column cc t)
17310 (forward-line -1))
17311 ((and off (looking-at re))
17312 (replace-match "" t t nil 1))
17313 ((not off) (org-move-to-column cc t) (insert ": ")))
17314 (forward-line 1)))
17315 (save-excursion
17316 (org-back-to-heading)
17317 (if (looking-at (concat outline-regexp
17319 (replace-match "" t t nil 1)
17320 (if (looking-at outline-regexp)
17321 (progn
17322 (goto-char (match-end 0))
17323 (insert org-quote-string " "))))))))
17325 (defun org-reftex-citation ()
17326 "Use reftex-citation to insert a citation into the buffer.
17327 This looks for a line like
17329 #+BIBLIOGRAPHY: foo plain option:-d
17331 and derives from it that foo.bib is the bibliography file relevant
17332 for this document. It then installs the necessary environment for RefTeX
17333 to work in this buffer and calls `reftex-citation' to insert a citation
17334 into the buffer.
17336 Export of such citations to both LaTeX and HTML is handled by the contributed
17337 package org-exp-bibtex by Taru Karttunen."
17338 (interactive)
17339 (let ((reftex-docstruct-symbol 'rds)
17341 rds bib)
17342 (save-excursion
17343 (save-restriction
17344 (widen)
17345 (let ((case-fold-search t)
17347 (if (not (save-excursion
17348 (or (re-search-forward re nil t)
17349 (re-search-backward re nil t))))
17350 (error "No bibliography defined in file")
17351 (setq bib (concat (match-string 1) ".bib")
17352 rds (list (list 'bib bib)))))))
17353 (call-interactively 'reftex-citation)))
17355 ;;;; Functions extending outline functionality
17357 (defun org-beginning-of-line (&optional arg)
17358 "Go to the beginning of the current line. If that is invisible, continue
17359 to a visible line beginning. This makes the function of C-a more intuitive.
17360 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
17361 first attempt, and only move to after the tags when the cursor is already
17362 beyond the end of the headline."
17363 (interactive "P")
17364 (let ((pos (point))
17365 (special (if (consp org-special-ctrl-a/e)
17366 (car org-special-ctrl-a/e)
17367 org-special-ctrl-a/e))
17368 refpos)
17369 (if (org-bound-and-true-p line-move-visual)
17370 (beginning-of-visual-line 1)
17371 (beginning-of-line 1))
17372 (if (and arg (fboundp 'move-beginning-of-line))
17373 (call-interactively 'move-beginning-of-line)
17374 (if (bobp)
17375 nil
17376 (backward-char 1)
17377 (if (org-invisible-p)
17378 (while (and (not (bobp)) (org-invisible-p))
17379 (backward-char 1)
17380 (beginning-of-line 1))
17381 (forward-char 1))))
17382 (when special
17383 (cond
17384 ((and (looking-at org-complex-heading-regexp)
17385 (= (char-after (match-end 1)) ?\ ))
17386 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
17387 (point-at-eol)))
17388 (goto-char
17389 (if (eq special t)
17390 (cond ((> pos refpos) refpos)
17391 ((= pos (point)) refpos)
17392 (t (point)))
17393 (cond ((> pos (point)) (point))
17394 ((not (eq last-command this-command)) (point))
17395 (t refpos)))))
17396 ((org-at-item-p)
17397 (goto-char
17398 (if (eq special t)
17399 (cond ((> pos (match-end 4)) (match-end 4))
17400 ((= pos (point)) (match-end 4))
17401 (t (point)))
17402 (cond ((> pos (point)) (point))
17403 ((not (eq last-command this-command)) (point))
17404 (t (match-end 4))))))))
17405 (org-no-warnings
17406 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
17408 (defun org-end-of-line (&optional arg)
17409 "Go to the end of the line.
17410 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
17411 first attempt, and only move to after the tags when the cursor is already
17412 beyond the end of the headline."
17413 (interactive "P")
17414 (let ((special (if (consp org-special-ctrl-a/e)
17415 (cdr org-special-ctrl-a/e)
17416 org-special-ctrl-a/e)))
17417 (if (or (not special)
17418 (not (org-on-heading-p))
17419 arg)
17420 (call-interactively
17421 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
17422 ((fboundp 'move-end-of-line) 'move-end-of-line)
17423 (t 'end-of-line)))
17424 (let ((pos (point)))
17425 (beginning-of-line 1)
17427 (if (eq special t)
17428 (if (or (< pos (match-beginning 1))
17429 (= pos (match-end 0)))
17430 (goto-char (match-beginning 1))
17431 (goto-char (match-end 0)))
17432 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
17433 (goto-char (match-end 0))
17434 (goto-char (match-beginning 1))))
17435 (call-interactively (if (fboundp 'move-end-of-line)
17436 'move-end-of-line
17437 'end-of-line)))))
17438 (org-no-warnings
17439 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
17441 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
17442 (define-key org-mode-map "\C-e" 'org-end-of-line)
17443 (define-key org-mode-map [home] 'org-beginning-of-line)
17444 (define-key org-mode-map [end] 'org-end-of-line)
17446 (defun org-backward-sentence (&optional arg)
17447 "Go to beginning of sentence, or beginning of table field.
17448 This will call `backward-sentence' or `org-table-beginning-of-field',
17449 depending on context."
17450 (interactive "P")
17451 (cond
17452 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
17453 (t (call-interactively 'backward-sentence))))
17455 (defun org-forward-sentence (&optional arg)
17456 "Go to end of sentence, or end of table field.
17457 This will call `forward-sentence' or `org-table-end-of-field',
17458 depending on context."
17459 (interactive "P")
17460 (cond
17461 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
17462 (t (call-interactively 'forward-sentence))))
17464 (define-key org-mode-map "\M-a" 'org-backward-sentence)
17465 (define-key org-mode-map "\M-e" 'org-forward-sentence)
17467 (defun org-kill-line (&optional arg)
17468 "Kill line, to tags or end of line."
17469 (interactive "P")
17470 (cond
17471 ((or (not org-special-ctrl-k)
17472 (bolp)
17473 (not (org-on-heading-p)))
17474 (call-interactively 'kill-line))
17476 (kill-region (point) (match-beginning 1))
17477 (org-set-tags nil t))
17478 (t (kill-region (point) (point-at-eol)))))
17480 (define-key org-mode-map "\C-k" 'org-kill-line)
17482 (defun org-yank (&optional arg)
17483 "Yank. If the kill is a subtree, treat it specially.
17484 This command will look at the current kill and check if is a single
17485 subtree, or a series of subtrees[1]. If it passes the test, and if the
17486 cursor is at the beginning of a line or after the stars of a currently
17487 empty headline, then the yank is handled specially. How exactly depends
17488 on the value of the following variables, both set by default.
17490 org-yank-folded-subtrees
17491 When set, the subtree(s) will be folded after insertion, but only
17492 if doing so would now swallow text after the yanked text.
17494 org-yank-adjusted-subtrees
17495 When set, the subtree will be promoted or demoted in order to
17496 fit into the local outline tree structure, which means that the level
17497 will be adjusted so that it becomes the smaller one of the two
17498 *visible* surrounding headings.
17500 Any prefix to this command will cause `yank' to be called directly with
17501 no special treatment. In particular, a simple `C-u' prefix will just
17502 plainly yank the text as it is.
17504 \[1] The test checks if the first non-white line is a heading
17505 and if there are no other headings with fewer stars."
17506 (interactive "P")
17507 (org-yank-generic 'yank arg))
17509 (defun org-yank-generic (command arg)
17510 "Perform some yank-like command.
17512 This function implements the behavior described in the `org-yank'
17513 documentation. However, it has been generalized to work for any
17514 interactive command with similar behavior."
17516 ;; pretend to be command COMMAND
17517 (setq this-command command)
17519 (if arg
17520 (call-interactively command)
17522 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
17523 (and (org-kill-is-subtree-p)
17524 (or (bolp)
17526 (string-match
17528 (buffer-substring (point-at-bol) (point)))))))
17529 swallowp)
17530 (cond
17531 ((and subtreep org-yank-folded-subtrees)
17532 (let ((beg (point))
17533 end)
17534 (if (and subtreep org-yank-adjusted-subtrees)
17535 (org-paste-subtree nil nil 'for-yank)
17536 (call-interactively command))
17538 (setq end (point))
17539 (goto-char beg)
17540 (when (and (bolp) subtreep
17541 (not (setq swallowp
17542 (org-yank-folding-would-swallow-text beg end))))
17543 (or (looking-at outline-regexp)
17544 (re-search-forward (concat "^" outline-regexp) end t))
17545 (while (and (< (point) end) (looking-at outline-regexp))
17546 (hide-subtree)
17547 (org-cycle-show-empty-lines 'folded)
17548 (condition-case nil
17549 (outline-forward-same-level 1)
17550 (error (goto-char end)))))
17551 (when swallowp
17552 (message
17553 "Inserted text not folded because that would swallow text"))
17555 (goto-char end)
17557 (beginning-of-line 1)
17558 (push-mark beg 'nomsg)))
17559 ((and subtreep org-yank-adjusted-subtrees)
17560 (let ((beg (point-at-bol)))
17561 (org-paste-subtree nil nil 'for-yank)
17562 (push-mark beg 'nomsg)))
17563 (t
17564 (call-interactively command))))))
17566 (defun org-yank-folding-would-swallow-text (beg end)
17567 "Would hide-subtree at BEG swallow any text after END?"
17568 (let (level)
17569 (save-excursion
17570 (goto-char beg)
17571 (when (or (looking-at outline-regexp)
17572 (re-search-forward (concat "^" outline-regexp) end t))
17573 (setq level (org-outline-level)))
17574 (goto-char end)
17576 (if (or (eobp)
17577 (and (bolp) (looking-at org-outline-regexp)
17578 (<= (org-outline-level) level)))
17579 nil ; Nothing would be swallowed
17580 t)))) ; something would swallow
17582 (define-key org-mode-map "\C-y" 'org-yank)
17584 (defun org-invisible-p ()
17585 "Check if point is at a character currently not visible."
17586 ;; Early versions of noutline don't have `outline-invisible-p'.
17587 (if (fboundp 'outline-invisible-p)
17588 (outline-invisible-p)
17589 (get-char-property (point) 'invisible)))
17591 (defun org-invisible-p2 ()
17592 "Check if point is at a character currently not visible."
17593 (save-excursion
17594 (if (and (eolp) (not (bobp))) (backward-char 1))
17595 ;; Early versions of noutline don't have `outline-invisible-p'.
17596 (if (fboundp 'outline-invisible-p)
17597 (outline-invisible-p)
17598 (get-char-property (point) 'invisible))))
17600 (defun org-back-to-heading (&optional invisible-ok)
17601 "Call `outline-back-to-heading', but provide a better error message."
17602 (condition-case nil
17603 (outline-back-to-heading invisible-ok)
17604 (error (error "Before first headline at position %d in buffer %s"
17605 (point) (current-buffer)))))
17607 (defun org-before-first-heading-p ()
17608 "Before first heading?"
17609 (save-excursion
17612 (defun org-on-heading-p (&optional ignored)
17613 (outline-on-heading-p t))
17614 (defun org-at-heading-p (&optional ignored)
17615 (outline-on-heading-p t))
17617 (defun org-at-heading-or-item-p ()
17618 (or (org-on-heading-p) (org-at-item-p)))
17620 (defun org-on-target-p ()
17621 (or (org-in-regexp org-radio-target-regexp)
17622 (org-in-regexp org-target-regexp)))
17624 (defun org-up-heading-all (arg)
17625 "Move to the heading line of which the present line is a subheading.
17626 This function considers both visible and invisible heading lines.
17627 With argument, move up ARG levels."
17628 (if (fboundp 'outline-up-heading-all)
17629 (outline-up-heading-all arg) ; emacs 21 version of outline.el
17630 (outline-up-heading arg t))) ; emacs 22 version of outline.el
17632 (defun org-up-heading-safe ()
17633 "Move to the heading line of which the present line is a subheading.
17634 This version will not throw an error. It will return the level of the
17635 headline found, or nil if no higher level is found.
17637 Also, this function will be a lot faster than `outline-up-heading',
17638 because it relies on stars being the outline starters. This can really
17639 make a significant difference in outlines with very many siblings."
17640 (let (start-level re)
17641 (org-back-to-heading t)
17642 (setq start-level (funcall outline-level))
17643 (if (equal start-level 1)
17644 nil
17646 (if (re-search-backward re nil t)
17647 (funcall outline-level)))))
17649 (defun org-first-sibling-p ()
17650 "Is this heading the first child of its parents?"
17651 (interactive)
17652 (let ((re (concat "^" outline-regexp))
17653 level l)
17654 (unless (org-at-heading-p t)
17655 (error "Not at a heading"))
17656 (setq level (funcall outline-level))
17657 (save-excursion
17658 (if (not (re-search-backward re nil t))
17659 t
17660 (setq l (funcall outline-level))
17661 (< l level)))))
17663 (defun org-goto-sibling (&optional previous)
17664 "Goto the next sibling, even if it is invisible.
17665 When PREVIOUS is set, go to the previous sibling instead. Returns t
17666 when a sibling was found. When none is found, return nil and don't
17667 move point."
17668 (let ((fun (if previous 're-search-backward 're-search-forward))
17669 (pos (point))
17670 (re (concat "^" outline-regexp))
17671 level l)
17672 (when (condition-case nil (org-back-to-heading t) (error nil))
17673 (setq level (funcall outline-level))
17674 (catch 'exit
17675 (or previous (forward-char 1))
17676 (while (funcall fun re nil t)
17677 (setq l (funcall outline-level))
17678 (when (< l level) (goto-char pos) (throw 'exit nil))
17679 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
17680 (goto-char pos)
17681 nil))))
17683 (defun org-show-siblings ()
17684 "Show all siblings of the current headline."
17685 (save-excursion
17686 (while (org-goto-sibling) (org-flag-heading nil)))
17687 (save-excursion
17688 (while (org-goto-sibling 'previous)
17689 (org-flag-heading nil))))
17691 (defun org-show-hidden-entry ()
17692 "Show an entry where even the heading is hidden."
17693 (save-excursion
17694 (org-show-entry)))
17696 (defun org-flag-heading (flag &optional entry)
17697 "Flag the current heading. FLAG non-nil means make invisible.
17698 When ENTRY is non-nil, show the entire entry."
17699 (save-excursion
17700 (org-back-to-heading t)
17701 ;; Check if we should show the entire entry
17702 (if entry
17703 (progn
17704 (org-show-entry)
17705 (save-excursion
17706 (and (outline-next-heading)
17707 (org-flag-heading nil))))
17708 (outline-flag-region (max (point-min) (1- (point)))
17709 (save-excursion (outline-end-of-heading) (point))
17710 flag))))
17712 (defun org-get-next-sibling ()
17713 "Move to next heading of the same level, and return point.
17714 If there is no such heading, return nil.
17715 This is like outline-next-sibling, but invisible headings are ok."
17716 (let ((level (funcall outline-level)))
17717 (outline-next-heading)
17718 (while (and (not (eobp)) (> (funcall outline-level) level))
17719 (outline-next-heading))
17720 (if (or (eobp) (< (funcall outline-level) level))
17721 nil
17722 (point))))
17724 (defun org-get-last-sibling ()
17725 "Move to previous heading of the same level, and return point.
17726 If there is no such heading, return nil."
17727 (let ((opoint (point))
17728 (level (funcall outline-level)))
17729 (outline-previous-heading)
17730 (when (and (/= (point) opoint) (outline-on-heading-p t))
17731 (while (and (> (funcall outline-level) level)
17732 (not (bobp)))
17733 (outline-previous-heading))
17734 (if (< (funcall outline-level) level)
17735 nil
17736 (point)))))
17738 (defun org-end-of-subtree (&optional invisible-OK to-heading)
17739 ;; This contains an exact copy of the original function, but it uses
17740 ;; `org-back-to-heading', to make it work also in invisible
17741 ;; trees. And is uses an invisible-OK argument.
17742 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
17743 ;; Furthermore, when used inside Org, finding the end of a large subtree
17744 ;; with many children and grandchildren etc, this can be much faster
17745 ;; than the outline version.
17746 (org-back-to-heading invisible-OK)
17747 (let ((first t)
17748 (level (funcall outline-level)))
17749 (if (and (org-mode-p) (< level 1000))
17750 ;; A true heading (not a plain list item), in Org-mode
17751 ;; This means we can easily find the end by looking
17752 ;; only for the right number of stars. Using a regexp to do
17753 ;; this is so much faster than using a Lisp loop.
17755 (forward-char 1)
17756 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
17757 ;; something else, do it the slow way
17758 (while (and (not (eobp))
17759 (or first (> (funcall outline-level) level)))
17760 (setq first nil)
17761 (outline-next-heading)))
17762 (unless to-heading
17764 (progn
17765 ;; Go to end of line before heading
17766 (forward-char -1)
17768 ;; leave blank line before heading
17769 (forward-char -1))))))
17770 (point))
17772 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
17773 "Use Org version in org-mode, for dramatic speed-up."
17774 (if (eq major-mode 'org-mode)
17775 (progn
17776 (org-end-of-subtree nil t)
17777 (unless (eobp) (backward-char 1)))
17778 ad-do-it))
17780 (defun org-forward-same-level (arg &optional invisible-ok)
17781 "Move forward to the arg'th subheading at same level as this one.
17782 Stop at the first and last subheadings of a superior heading."
17783 (interactive "p")
17784 (org-back-to-heading invisible-ok)
17785 (org-on-heading-p)
17786 (let* ((level (- (match-end 0) (match-beginning 0) 1))
17788 l)
17789 (forward-char 1)
17790 (while (> arg 0)
17791 (while (and (re-search-forward re nil 'move)
17792 (setq l (- (match-end 0) (match-beginning 0) 1))
17793 (= l level)
17794 (not invisible-ok)
17795 (progn (backward-char 1) (org-invisible-p)))
17796 (if (< l level) (setq arg 1)))
17797 (setq arg (1- arg)))
17798 (beginning-of-line 1)))
17800 (defun org-backward-same-level (arg &optional invisible-ok)
17801 "Move backward to the arg'th subheading at same level as this one.
17802 Stop at the first and last subheadings of a superior heading."
17803 (interactive "p")
17804 (org-back-to-heading)
17805 (org-on-heading-p)
17806 (let* ((level (- (match-end 0) (match-beginning 0) 1))
17808 l)
17809 (while (> arg 0)
17810 (while (and (re-search-backward re nil 'move)
17811 (setq l (- (match-end 0) (match-beginning 0) 1))
17812 (= l level)
17813 (not invisible-ok)
17814 (org-invisible-p))
17815 (if (< l level) (setq arg 1)))
17816 (setq arg (1- arg)))))
17818 (defun org-show-subtree ()
17819 "Show everything after this heading at deeper levels."
17820 (outline-flag-region
17821 (point)
17822 (save-excursion
17823 (org-end-of-subtree t t))
17824 nil))
17826 (defun org-show-entry ()
17827 "Show the body directly following this heading.
17828 Show the heading too, if it is currently invisible."
17829 (interactive)
17830 (save-excursion
17831 (condition-case nil
17832 (progn
17833 (org-back-to-heading t)
17834 (outline-flag-region
17835 (max (point-min) (1- (point)))
17836 (save-excursion
17837 (if (re-search-forward
17839 (match-beginning 1)
17840 (point-max)))
17841 nil)
17842 (org-cycle-hide-drawers 'children))
17843 (error nil))))
17845 (defun org-make-options-regexp (kwds &optional extra)
17846 "Make a regular expression for keyword lines."
17847 (concat
17848 "^"
17855 ;; Make isearch reveal the necessary context
17856 (defun org-isearch-end ()
17857 "Reveal context after isearch exits."
17858 (when isearch-success ; only if search was successful
17859 (if (featurep 'xemacs)
17860 ;; Under XEmacs, the hook is run in the correct place,
17861 ;; we directly show the context.
17862 (org-show-context 'isearch)
17863 ;; In Emacs the hook runs *before* restoring the overlays.
17864 ;; So we have to use a one-time post-command-hook to do this.
17865 ;; (Emacs 22 has a special variable, see function `org-mode')
17866 (unless (and (boundp 'isearch-mode-end-hook-quit)
17867 isearch-mode-end-hook-quit)
17868 ;; Only when the isearch was not quitted.
17869 (org-add-hook 'post-command-hook 'org-isearch-post-command
17870 'append 'local)))))
17872 (defun org-isearch-post-command ()
17873 "Remove self from hook, and show context."
17874 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
17875 (org-show-context 'isearch))
17878 ;;;; Integration with and fixes for other packages
17880 ;;; Imenu support
17882 (defvar org-imenu-markers nil
17883 "All markers currently used by Imenu.")
17884 (make-variable-buffer-local 'org-imenu-markers)
17886 (defun org-imenu-new-marker (&optional pos)
17887 "Return a new marker for use by Imenu, and remember the marker."
17888 (let ((m (make-marker)))
17889 (move-marker m (or pos (point)))
17890 (push m org-imenu-markers)
17891 m))
17893 (defun org-imenu-get-tree ()
17894 "Produce the index for Imenu."
17895 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
17896 (setq org-imenu-markers nil)
17897 (let* ((n org-imenu-depth)
17898 (re (concat "^" outline-regexp))
17899 (subs (make-vector (1+ n) nil))
17900 (last-level 0)
17901 m level head)
17902 (save-excursion
17903 (save-restriction
17904 (widen)
17905 (goto-char (point-max))
17906 (while (re-search-backward re nil t)
17907 (setq level (org-reduced-level (funcall outline-level)))
17908 (when (<= level n)
17909 (looking-at org-complex-heading-regexp)
17910 (setq head (org-link-display-format
17911 (org-match-string-no-properties 4))
17912 m (org-imenu-new-marker))
17913 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
17914 (if (>= level last-level)
17915 (push (cons head m) (aref subs level))
17916 (push (cons head (aref subs (1+ level))) (aref subs level))
17917 (loop for i from (1+ level) to n do (aset subs i nil)))
17918 (setq last-level level)))))
17919 (aref subs 1)))
17921 (eval-after-load "imenu"
17922 '(progn
17923 (add-hook 'imenu-after-jump-hook
17924 (lambda ()
17925 (if (eq major-mode 'org-mode)
17926 (org-show-context 'org-goto))))))
17928 (defun org-link-display-format (link)
17929 "Replace a link with either the description, or the link target
17930 if no description is present"
17931 (save-match-data
17932 (if (string-match org-bracket-link-analytic-regexp link)
17933 (replace-match (if (match-end 5)
17934 (match-string 5 link)
17935 (concat (match-string 1 link)
17936 (match-string 3 link)))
17937 nil t link)
17938 link)))
17940 ;; Speedbar support
17942 (defvar org-speedbar-restriction-lock-overlay (org-make-overlay 1 1)
17943 "Overlay marking the agenda restriction line in speedbar.")
17944 (org-overlay-put org-speedbar-restriction-lock-overlay
17945 'face 'org-agenda-restriction-lock)
17946 (org-overlay-put org-speedbar-restriction-lock-overlay
17947 'help-echo "Agendas are currently limited to this item.")
17948 (org-detach-overlay org-speedbar-restriction-lock-overlay)
17950 (defun org-speedbar-set-agenda-restriction ()
17951 "Restrict future agenda commands to the location at point in speedbar.
17953 (interactive)
17954 (require 'org-agenda)
17955 (let (p m tp np dir txt)
17956 (cond
17957 ((setq p (text-property-any (point-at-bol) (point-at-eol)
17958 'org-imenu t))
17959 (setq m (get-text-property p 'org-imenu-marker))
17960 (with-current-buffer (marker-buffer m)
17961 (goto-char m)
17962 (org-agenda-set-restriction-lock 'subtree)))
17963 ((setq p (text-property-any (point-at-bol) (point-at-eol)
17964 'speedbar-function 'speedbar-find-file))
17965 (setq tp (previous-single-property-change
17966 (1+ p) 'speedbar-function)
17967 np (next-single-property-change
17968 tp 'speedbar-function)
17969 dir (speedbar-line-directory)
17970 txt (buffer-substring-no-properties (or tp (point-min))
17971 (or np (point-max))))
17972 (with-current-buffer (find-file-noselect
17973 (let ((default-directory dir))
17974 (expand-file-name txt)))
17975 (unless (org-mode-p)
17976 (error "Cannot restrict to non-Org-mode file"))
17977 (org-agenda-set-restriction-lock 'file)))
17978 (t (error "Don't know how to restrict Org-mode's agenda")))
17979 (org-move-overlay org-speedbar-restriction-lock-overlay
17980 (point-at-bol) (point-at-eol))
17981 (setq current-prefix-arg nil)
17982 (org-agenda-maybe-redo)))
17984 (eval-after-load "speedbar"
17985 '(progn
17986 (speedbar-add-supported-extension ".org")
17987 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
17988 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
17989 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
17990 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17991 (add-hook 'speedbar-visiting-tag-hook
17992 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
17995 ;;; Fixes and Hacks for problems with other packages
17997 ;; Make flyspell not check words in links, to not mess up our keymap
17998 (defun org-mode-flyspell-verify ()
17999 "Don't let flyspell put overlays at active buttons."
18000 (and (not (get-text-property (point) 'keymap))
18001 (not (get-text-property (point) 'org-no-flyspell))))
18003 (defun org-remove-flyspell-overlays-in (beg end)
18004 "Remove flyspell overlays in region."
18005 (and (org-bound-and-true-p flyspell-mode)
18006 (fboundp 'flyspell-delete-region-overlays)
18007 (flyspell-delete-region-overlays beg end))
18008 (add-text-properties beg end '(org-no-flyspell t)))
18010 ;; Make `bookmark-jump' shows the jump location if it was hidden.
18011 (eval-after-load "bookmark"
18012 '(if (boundp 'bookmark-after-jump-hook)
18013 ;; We can use the hook
18014 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
18015 ;; Hook not available, use advice
18016 (defadvice bookmark-jump (after org-make-visible activate)
18017 "Make the position visible."
18018 (org-bookmark-jump-unhide))))
18020 ;; Make sure saveplace shows the location if it was hidden
18021 (eval-after-load "saveplace"
18022 '(defadvice save-place-find-file-hook (after org-make-visible activate)
18023 "Make the position visible."
18024 (org-bookmark-jump-unhide)))
18026 ;; Make sure ecb shows the location if it was hidden
18027 (eval-after-load "ecb"
18028 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
18029 "Make hierarchy visible when jumping into location from ECB tree buffer."
18030 (if (eq major-mode 'org-mode)
18031 (org-show-context))))
18033 (defun org-bookmark-jump-unhide ()
18034 "Unhide the current position, to show the bookmark location."
18035 (and (org-mode-p)
18036 (or (org-invisible-p)
18037 (save-excursion (goto-char (max (point-min) (1- (point))))
18038 (org-invisible-p)))
18039 (org-show-context 'bookmark-jump)))
18041 ;; Make session.el ignore our circular variable
18042 (eval-after-load "session"
18043 '(add-to-list 'session-globals-exclude 'org-mark-ring))
18045 ;;;; Experimental code
18047 (defun org-closed-in-range ()
18048 "Sparse tree of items closed in a certain time range.
18049 Still experimental, may disappear in the future."
18050 (interactive)
18051 ;; Get the time interval from the user.
18052 (let* ((time1 (org-float-time
18053 (org-read-date nil 'to-time nil "Starting date: ")))
18054 (time2 (org-float-time
18055 (org-read-date nil 'to-time nil "End date:")))
18056 ;; callback function
18057 (callback (lambda ()
18058 (let ((time
18059 (org-float-time
18060 (apply 'encode-time
18061 (org-parse-time-string
18062 (match-string 1))))))
18063 ;; check if time in interval
18064 (and (>= time time1) (<= time time2))))))
18065 ;; make tree, check each match with the callback
18068 ;;;; Finish up
18070 (provide 'org)
18072 (run-hooks 'org-load-hook)
18074 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
18076 ;;; org.el ends here