| blob | 66514a251be652e0c6009e64221554f5dc94e6f6 |
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, 2010
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: 7.3
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
79 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
91 ;; Other stuff we need.
106 ;; babel
115 ;; load languages based on value of `org-babel-load-languages'
117 ;;;###autoload
119 "Load the languages defined in `org-babel-load-languages'."
131 org-babel-load-languages))
134 "Languages which can be evaluated in Org-mode buffers.
135 This list can be used to load support for any of the languages
136 below, note that each language will depend on a different set of
137 system executables and/or Emacs modes. When a language is
139 with `org-babel-execute-src-block' bound by default to C-c
140 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
141 be set to remove code block evaluation from the C-c C-c
142 keybinding. By default only Emacs Lisp (which has no
143 requirements) is loaded."
147 :key-type
180 ;;;; Customization variables
182 "Remove ID property of clones of a subtree.
183 When non-nil, clones of a subtree don't inherit the ID property.
184 Otherwise they inherit the ID property with a new unique
185 identifier."
189 ;;; Version
195 "Show the org-mode version in the echo area.
196 With prefix arg HERE, insert it at point."
222 ;;; Compatibility constants
224 ;;; The custom variables
227 "Outline-based notes management and organizer."
233 "Mode hook for Org-mode, run after the mode was turned on."
238 "Hook that is run after org.el has been loaded."
247 "Load all extensions listed in `org-modules'."
252 org-modules)
256 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
265 (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)
266 "Modules that should always be loaded together with org.el.
267 If a description starts with <C>, the file is not part of Emacs
268 and loading it will require that you have downloaded and properly installed
269 the org-mode distribution.
271 You can also use this system to load external packages (i.e. neither Org
272 core modules, nor modules from the CONTRIB directory). Just add symbols
273 to the end of the list. If the package is called org-xyz.el, then you need
274 to add the symbol `xyz', and the package must have a call to
276 (provide 'org-xyz)"
279 :type
309 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
316 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
324 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
341 "Non-nil means make shift-cursor commands select text when possible.
343 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
344 selecting a region, or enlarge regions started in this way.
345 In Org-mode, in special contexts, these same keys are used for other
346 purposes, important enough to compete with shift selection. Org tries
347 to balance these needs by supporting `shift-select-mode' outside these
348 special contexts, under control of this variable.
350 The default of this variable is nil, to avoid confusing behavior. Shifted
351 cursor keys will then execute Org commands in the following contexts:
352 - on a headline, changing TODO state (left/right) and priority (up/down)
353 - on a time stamp, changing the time
354 - in a plain list item, changing the bullet type
355 - in a property definition line, switching between allowed values
356 - in the BEGIN line of a clock table (changing the time block).
357 Outside these contexts, the commands will throw an error.
359 When this variable is t and the cursor is not in a special context,
360 Org-mode will support shift-selection for making and enlarging regions.
361 To make this more effective, the bullet cycling will no longer happen
362 anywhere in an item line, but only if the cursor is exactly on the bullet.
364 If you set this variable to the symbol `always', then the keys
365 will not be special in headlines, property lines, and item lines, to make
366 shift selection work there as well. If this is what you want, you can
367 use the following alternative commands: `C-c C-t' and `C-c ,' to
368 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
369 TODO sets, `C-c -' to cycle item bullet types, and properties can be
370 edited by hand or in column view.
372 However, when the cursor is on a timestamp, shift-cursor commands
373 will still edit the time stamp - this is just too good to give up.
375 XEmacs user should have this variable set to nil, because shift-select-mode
376 is Emacs 23 only."
384 "Options concerning startup of Org-mode."
389 "Non-nil means entering Org-mode will switch to OVERVIEW.
390 This can also be configured on a per-file basis by adding one of
391 the following lines anywhere in the buffer:
393 #+STARTUP: fold (or `overview', this is equivalent)
394 #+STARTUP: nofold (or `showall', this is equivalent)
395 #+STARTUP: content
396 #+STARTUP: showeverything"
405 "Non-nil means entering Org-mode will set `truncate-lines'.
406 This is useful since some lines containing links can be very long and
407 uninteresting. Also tables look terrible when wrapped."
412 "Non-nil means turn on `org-indent-mode' on startup.
413 This can also be configured on a per-file basis by adding one of
414 the following lines anywhere in the buffer:
416 #+STARTUP: indent
417 #+STARTUP: noindent"
425 When this option is turned on, you can use TeX-like syntax for sub- and
427 considered as a single item - so grouping with {} is normally not
428 needed. For example, the following things will be parsed as single
429 sub- or superscripts.
431 10^24 or 10^tau several digits will be considered 1 item.
432 10^-12 or 10^-tau a leading sign with digits or a word
433 x^2-y^3 will be read as x^2 - y^3, because items are
434 terminated by almost any nonword/nondigit char.
435 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
437 Still, ambiguity is possible - so when in doubt use {} to enclose the
438 sub/superscript. If you set this variable to the symbol `{}',
439 the braces are *required* in order to trigger interpretations as
441 frequently in plain text.
443 Not all export backends support this, but HTML does.
458 "Non-nil means turn on `org-beamer-mode' on startup.
459 This can also be configured on a per-file basis by adding one of
460 the following lines anywhere in the buffer:
462 #+STARTUP: beamer"
467 "Non-nil means align all tables when visiting a file.
468 This is useful when the column width in tables is forced with <N> cookies
469 in table fields. Such tables will look correct only after the first re-align.
470 This can also be configured on a per-file basis by adding one of
471 the following lines anywhere in the buffer:
472 #+STARTUP: align
473 #+STARTUP: noalign"
478 "Non-nil means show inline images when loading a new Org file.
479 This can also be configured on a per-file basis by adding one of
480 the following lines anywhere in the buffer:
481 #+STARTUP: inlineimages
482 #+STARTUP: noinlineimages"
487 "Non-nil means insert the first line setting Org-mode in empty files.
488 When the function `org-mode' is called interactively in an empty file, this
489 normally means that the file name does not automatically trigger Org-mode.
490 To ensure that the file will always be in Org-mode in the future, a
491 line enforcing Org-mode will be inserted into the buffer, if this option
492 has been set."
497 "Non-nil means use alternative key bindings for some keys.
498 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
499 These keys are also used by other packages like shift-selection-mode'
500 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
501 If you want to use Org-mode together with one of these other modes,
502 or more generally if you would like to move some Org-mode commands to
503 other keys, set this variable and configure the keys with the variable
504 `org-disputed-keys'.
506 This option is only relevant at load-time of Org-mode, and must be set
507 *before* org.el is loaded. Changing it requires a restart of Emacs to
508 become effective."
513 "Non-nil means use extra key sequence definitions for certain commands.
514 This happens automatically if you run XEmacs or if `window-system'
515 is nil. This variable lets you do the same manually. You must
516 set it before loading org.
518 Example: on Carbon Emacs 22 running graphically, with an external
519 keyboard on a Powerbook, the default way of setting M-left might
520 not work for either Alt or ESC. Setting this variable will make
521 it work for ESC."
535 "Keys for which Org-mode and other modes compete.
536 This is an alist, cars are the default keys, second element specifies
537 the alternative to use when `org-replace-disputed-keys' is t.
539 Keys can be specified in any syntax supported by `define-key'.
540 The value of this option takes effect only at Org-mode's startup,
541 therefore you'll have to restart Emacs to apply it after changing."
546 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
547 Or return the original if not disputed.
548 Also apply the translations defined in `org-xemacs-key-equivalents'."
553 org-disputed-keys)))
557 key)
567 "Define a key, possibly translated, as returned by `org-key'."
571 "The ellipsis to use in the Org-mode outline.
572 When nil, just use the standard three dots. When a string, use that instead,
573 When a face, use the standard 3 dots, but with the specified face.
574 The change affects only Org-mode (which will then use its own display table).
575 Changing this requires executing `M-x org-mode' in a buffer to become
576 effective."
586 "Keywords in Org-mode."
591 "String to mark deadline entries.
592 A deadline is this string, followed by a time stamp. Should be a word,
593 terminated by a colon. You can insert a schedule keyword and
595 Changes become only effective after restarting Emacs."
600 "String to mark scheduled TODO entries.
601 A schedule is this string, followed by a time stamp. Should be a word,
602 terminated by a colon. You can insert a schedule keyword and
604 Changes become only effective after restarting Emacs."
609 "String used as the prefix for timestamps logging closing a TODO entry."
614 "String used as prefix for timestamps clocking work hours on an item."
619 "Entries starting with this keyword will never be exported.
620 An entry can be toggled between COMMENT and normal with
622 Changes become only effective after restarting Emacs."
627 "Entries starting with this keyword will be exported in fixed-width font.
628 Quoting applies only to the text in the entry following the headline, and does
629 not extend beyond the next headline, even if that is lower level.
630 An entry can be toggled between QUOTE and normal with
637 "Regular expression for specifying repeated events.
641 "Options concerning the general structure of Org-mode files."
646 "Options about how to make context of a location visible."
670 "Non-nil means show full hierarchy when revealing a location.
671 Org-mode often shows locations in an org-mode file which might have
672 been invisible before. When this is set, the hierarchy of headings
673 above the exposed location is shown.
674 Turning this off for example for sparse trees makes them very compact.
675 Instead of t, this can also be an alist specifying this option for different
676 contexts. Valid contexts are
677 agenda when exposing an entry from the agenda
678 org-goto when using the command `org-goto' on key C-c C-j
679 occur-tree when using the command `org-occur' on key C-c /
680 tags-tree when constructing a sparse tree based on tags matches
681 link-search when exposing search matches associated with a link
682 mark-goto when exposing the jump goal of a mark
683 bookmark-jump when exposing a bookmark location
684 isearch when exiting from an incremental search
685 default default for all contexts not set explicitly"
690 "Non-nil means show following heading when revealing a location.
691 Org-mode often shows locations in an org-mode file which might have
692 been invisible before. When this is set, the heading following the
693 match is shown.
694 Turning this off for example for sparse trees makes them very compact,
695 but makes it harder to edit the location of the match. In such a case,
697 Instead of t, this can also be an alist specifying this option for different
698 contexts. See `org-show-hierarchy-above' for valid contexts."
703 "Non-nil means show all sibling heading when revealing a location.
704 Org-mode often shows locations in an org-mode file which might have
705 been invisible before. When this is set, the sibling of the current entry
706 heading are all made visible. If `org-show-hierarchy-above' is t,
707 the same happens on each level of the hierarchy above the current entry.
709 By default this is on for the isearch context, off for all other contexts.
710 Turning this off for example for sparse trees makes them very compact,
711 but makes it harder to edit the location of the match. In such a case,
713 Instead of t, this can also be an alist specifying this option for different
714 contexts. See `org-show-hierarchy-above' for valid contexts."
719 "Non-nil means show the entry below a headline when revealing a location.
720 Org-mode often shows locations in an org-mode file which might have
721 been invisible before. When this is set, the text below the headline that is
722 exposed is also shown.
724 By default this is off for all contexts.
725 Instead of t, this can also be an alist specifying this option for different
726 contexts. See `org-show-hierarchy-above' for valid contexts."
731 "How should indirect tree buffers be displayed?
732 This applies to indirect buffers created with the commands
734 Valid values are:
735 current-window Display in the current window
736 other-window Just display in another window.
737 dedicated-frame Create one new frame, and re-use it each time.
738 new-frame Make a new frame each time. Note that in this case
739 previously-made indirect buffers are kept, and you need to
740 kill these buffers yourself."
750 "Non-nil means activate single letter commands at beginning of a headline.
751 This may also be a function to test for appropriate locations where speed
752 commands should be active."
760 "Alist of additional speed commands.
761 This list will be checked before `org-speed-commands-default'
762 when the variable `org-use-speed-commands' is non-nil
763 and when the cursor is at the beginning of a headline.
764 The car if each entry is a string with a single letter, which must
765 be assigned to `self-insert-command' in the global map.
766 The cdr is either a command to be called interactively, a function
767 to be called, or a form to be evaluated.
768 An entry that is just a list with a single string will be interpreted
769 as a descriptive headline that will be added when listing the speed
770 commands in the Help buffer using the `?' speed command."
782 "Options concerning visibility cycling in Org-mode."
787 "Non-nil means skip CHILDREN state in entries that don't have any."
792 "Maximum level which should still be subject to visibility cycling.
793 Levels higher than this will, for cycling, be treated as text, not a headline.
794 When `org-odd-levels-only' is set, a value of N in this variable actually
795 means 2N-1 stars as the limiting headline.
796 When nil, cycle all levels.
797 Note that the limiting level of cycling is also influenced by
798 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
799 `org-inlinetask-min-level' is, cycling will be limited to levels one less
800 than its value."
807 "Names of drawers. Drawers are not opened by cycling on the headline above.
808 Drawers only open with a TAB on the drawer line itself. A drawer looks like
809 this:
810 :DRAWERNAME:
811 .....
812 :END:
814 the property API.
816 Drawers can be defined on the per-file basis with a line like:
818 #+DRAWERS: HIDDEN STATE PROPERTIES"
824 "Non-nil means entering Org-mode will fold all blocks.
825 This can also be set in on a per-file basis with
827 #+STARTUP: hideblocks
828 #+STARTUP: showblocks"
834 "Cycle globally if cursor is at beginning of buffer and not at a headline.
835 This makes it possible to do global cycling without having to use S-TAB or
837 of the buffer
838 must not be a headline - it may be empty or some other text. When used in
839 this way, `org-cycle-hook' is disables temporarily, to make sure the
840 cursor stays at the beginning of the buffer.
841 When this option is nil, don't do anything special at the beginning
842 of the buffer."
847 "Non-nil means cycle entry level or item indentation in new empty entries.
849 When the cursor is at the end of an empty headline, i.e with only stars
850 and maybe a TODO keyword, TAB will then switch the entry to become a child,
851 and then all possible ancestor states, before returning to the original state.
852 This makes data entry extremely fast: M-RET to create a new headline,
853 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
855 When the cursor is at the end of an empty plain list item, one TAB will
856 make it a subitem, two or more tabs will back up to make this an item
857 higher up in the item hierarchy."
862 "Where should `org-cycle' emulate TAB.
863 nil Never
864 white Only in completely white lines
865 whitestart Only at the beginning of lines, before the first non-white char
866 t Everywhere except in headlines
867 exc-hl-bol Everywhere except at the start of a headline
868 If TAB is used in a place where it does not emulate TAB, the current subtree
869 visibility is cycled."
876 ))
879 "Number of empty lines needed to keep an empty line between collapsed trees.
880 If you leave an empty line between the end of a subtree and the following
881 headline, this empty line is hidden when the subtree is folded.
882 Org-mode will leave (exactly) one empty line visible if the number of
883 empty lines is equal or larger to the number given in this variable.
884 So the default 2 means at least 2 empty lines after the end of a subtree
885 are needed to produce free space between a collapsed subtree and the
886 following headline.
888 If the number is negative, and the number of empty lines is at least -N,
889 all empty lines are shown.
891 Special case: when 0, never leave empty lines in collapsed view."
897 "Hook that is run before visibility cycling is happening.
898 The function(s) in this hook must accept a single argument which indicates
899 the new state that will be set right after running this hook. The
900 argument is a symbol. Before a global state change, it can have the values
901 `overview', `content', or `all'. Before a local state change, it can have
902 the values `folded', `children', or `subtree'."
907 org-cycle-hide-drawers
908 org-cycle-show-empty-lines
909 org-optimize-window-after-visibility-change)
910 "Hook that is run after `org-cycle' has changed the buffer visibility.
911 The function(s) in this hook must accept a single argument which indicates
912 the new state that was set by the most recent `org-cycle' command. The
913 argument is a symbol. After a global state change, it can have the values
914 `overview', `content', or `all'. After a local state change, it can have
915 the values `folded', `children', or `subtree'."
920 "Options concerning structure editing in Org-mode."
925 "Non-nil means skip even levels and only use odd levels for the outline.
926 This has the effect that two stars are being added/taken away in
927 promotion/demotion commands. It also influences how levels are
928 handled by the exporters.
929 Changing it requires restart of `font-lock-mode' to become effective
930 for fontification also in regions already fontified.
931 You may also set this on a per-file basis by adding one of the following
932 lines to the buffer:
934 #+STARTUP: odd
935 #+STARTUP: oddeven"
941 "Non-nil means adapt indentation to outline node level.
943 When this variable is set, Org assumes that you write outlines by
944 indenting text in each node to align with the headline (after the stars).
945 The following issues are influenced by this variable:
947 - When this is set and the *entire* text in an entry is indented, the
948 indentation is increased by one space in a demotion command, and
949 decreased by one in a promotion command. If any line in the entry
950 body starts with text at column 0, indentation is not changed at all.
952 - Property drawers and planning information is inserted indented when
953 this variable s set. When nil, they will not be indented.
955 - TAB indents a line relative to context. The lines below a headline
956 will be indented when this variable is set.
958 Note that this is all about true indentation, by adding and removing
959 space characters. See also `org-indent.el' which does level-dependent
960 indentation in a virtual way, i.e. at display time in Emacs."
965 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
967 When t, `C-a' will bring back the cursor to the beginning of the
968 headline text, i.e. after the stars and after a possible TODO keyword.
969 In an item, this will be the position after the bullet.
970 When the cursor is already at that position, another `C-a' will bring
971 it to the beginning of the line.
973 `C-e' will jump to the end of the headline, ignoring the presence of tags
974 in the headline. A second `C-e' will then jump to the true end of the
975 line, after any tags. This also means that, when this variable is
976 non-nil, `C-e' also will never jump beyond the end of the heading of a
977 folded section, i.e. not after the ellipses.
979 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
980 going to the true line boundary first. Only a directly following, identical
981 keypress will bring the cursor to the special positions.
983 This may also be a cons cell where the behavior for `C-a' and `C-e' is
984 set separately."
1003 "Non-nil means `C-k' will behave specially in headlines.
1004 When nil, `C-k' will call the default `kill-line' command.
1005 When t, the following will happen while the cursor is in the headline:
1007 - When the cursor is at the beginning of a headline, kill the entire
1008 line and possible the folded subtree below the line.
1009 - When in the middle of the headline text, kill the headline up to the tags.
1010 - When after the headline text, kill the tags."
1015 "Non-nil means, do not delete a hidden subtree with C-k.
1016 When set to the symbol `error', simply throw an error when C-k is
1017 used to kill (part-of) a headline that has hidden text behind it.
1018 Any other non-nil value will result in a query to the user, if it is
1019 OK to kill that hidden subtree. When nil, kill without remorse."
1027 "Non-nil means when yanking subtrees, fold them.
1028 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1029 it starts with a heading and all other headings in it are either children
1030 or siblings, then fold all the subtrees. However, do this only if no
1031 text after the yank would be swallowed into a folded tree by this action."
1036 "Non-nil means when yanking subtrees, adjust the level.
1037 With this setting, `org-paste-subtree' is used to insert the subtree, see
1038 this function for details."
1043 "Non-nil means M-RET will split the line at the cursor position.
1044 When nil, it will go to the end of the line before making a
1045 new line.
1046 You may also set this option in a different way for different
1047 contexts. Valid contexts are:
1049 headline when creating a new headline
1050 item when creating a new item
1051 table in a table field
1052 default the value to be used for all contexts not explicitly
1053 customized"
1070 "Non-nil means insert new headings after the current subtree.
1071 When nil, the new heading is created directly after the current line.
1074 for the duration of the command."
1080 "Should `org-insert-heading' leave a blank line before new heading/item?
1081 The value is an alist, with `heading' and `plain-list-item' as car,
1082 and a boolean flag as cdr. The cdr may lso be the symbol `auto', and then
1083 Org will look at the surrounding headings/items and try to make an
1084 intelligent decision wether to insert a blank line or not.
1086 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1087 set, the setting here is ignored and no empty line is inserted, to avoid
1088 breaking the list structure."
1101 "Hook being run after inserting a new heading."
1107 This currently only means they are never auto-wrapped.
1108 When nil, such lines will be treated like ordinary lines.
1109 See also the QUOTE keyword."
1114 "Non-nil means typing characters in `org-goto' starts incremental search."
1119 "Options concerning sparse trees in Org-mode."
1124 "Non-nil means highlight all matches that define a sparse tree.
1125 The highlights will automatically disappear the next time the buffer is
1126 changed by an edit command."
1131 "Non-nil means any change to the buffer will remove temporary highlights.
1132 Such highlights are created by `org-occur' and `org-clock-display'.
1133 When nil, `C-c C-c needs to be used to get rid of the highlights.
1134 The highlights created by `org-preview-latex-fragment' always need
1135 `C-c C-c' to be removed."
1142 "Hook that is run after `org-occur' has constructed a sparse tree.
1143 This can be used to recenter the window to show as much of the structure
1144 as possible."
1149 "Options concerning imenu and speedbar in Org-mode."
1154 "The maximum level for Imenu access to Org-mode headlines.
1155 This also applied for speedbar access."
1160 "Options concerning tables in Org-mode."
1166 When nil, such lines will be treated like ordinary lines.
1168 When equal to the symbol `optimized', the table editor will be optimized to
1169 do the following:
1170 - Automatic overwrite mode in front of whitespace in table fields.
1171 This makes the structure of the table stay in tact as long as the edited
1172 field does not exceed the column width.
1173 - Minimize the number of realigns. Normally, the table is aligned each time
1174 TAB or RET are pressed to move to another field. With optimization this
1175 happens only if changes to a field might have changed the column width.
1176 Optimization requires replacing the functions `self-insert-command',
1177 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1178 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1179 very good at guessing when a re-align will be necessary, but you can always
1182 If you would like to use the optimized version in Org-mode, but the
1183 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1185 This variable can be used to turn on and off the table editor during a session,
1186 but in order to toggle optimization, a restart is required.
1188 See also the variable `org-table-auto-blank-field'."
1196 "Non-nil means cluster self-insert commands for undo when possible.
1197 If this is set, then, like in the Emacs command loop, 20 consecutive
1198 characters will be undone together.
1199 This is configurable, because there is some impact on typing performance."
1204 "Non-nil means TAB will automatically notice a table.el table.
1205 When it sees such a table, it moves point into it and - if necessary -
1206 calls `table-recognize-table'."
1211 "Options concerning links in Org-mode."
1216 "Buffer-local version of `org-link-abbrev-alist', which see.
1221 "Alist of link abbreviations.
1222 The car of each element is a string, to be replaced at the start of a link.
1224 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1226 [[linkkey:tag][description]]
1228 The 'linkkey' must be a word word, starting with a letter, followed
1229 by letters, numbers, '-' or '_'.
1231 If REPLACE is a string, the tag will simply be appended to create the link.
1234 be inserted at that point (see the function `url-hexify-string').
1236 REPLACE may also be a function that will be called with the tag as the
1237 only argument to create the link, which should be returned as a string.
1239 See the manual for examples."
1249 "Non-nil means hide link part and only show description of bracket links.
1250 Bracket links are like [[link][description]]. This variable sets the initial
1251 state in new org-mode buffers. The setting can then be toggled on a
1252 per-buffer basis from the Org->Hyperlinks menu."
1257 "How the path name in file links should be stored.
1258 Valid values are:
1260 relative Relative to the current directory, i.e. the directory of the file
1261 into which the link is being inserted.
1262 absolute Absolute path, if possible with ~ for home directory.
1263 noabbrev Absolute path, no abbreviation of home directory.
1264 adaptive Use relative path for files in the current directory and sub-
1265 directories of it. For other files, use an absolute path."
1274 "Types of links that should be activated in Org-mode files.
1275 This is a list of symbols, each leading to the activation of a certain link
1276 type. In principle, it does not hurt to turn on most link types - there may
1277 be a small gain when turning off unused link types. The types are:
1279 bracket The recommended [[link][description]] or [[link]] links with hiding.
1280 angle Links in angular brackets that may contain whitespace like
1281 <bbdb:Carsten Dominik>.
1282 plain Plain links in normal text, no whitespace, like http://google.com.
1283 radio Text that is matched by a radio target, see manual for details.
1284 tag Tag settings in a headline (link to tag search).
1285 date Time stamps (link to calendar).
1286 footnote Footnote labels.
1288 Changing this variable requires a restart of Emacs to become effective."
1300 "Function to use to generate link descriptions from links.
1301 If nil the link location will be used. This function must take
1302 two parameters; the first is the link and the second the
1303 description `org-insert-link' has generated, and should return the
1304 description to use."
1309 "Options concerning storing links in Org-mode."
1314 "Format of the description part of a link to an email or usenet message.
1315 The following %-escapes will be replaced by corresponding information:
1323 %s subject
1324 %m message-id.
1326 You may use normal field width specification between the % and the letter.
1327 This is for example useful to limit the length of the subject.
1341 It should match if the message is from the user him/herself."
1346 "Non-nil means storing a link to an Org file will use entry IDs.
1348 Note that before this variable is even considered, org-id must be loaded,
1349 so please customize `org-modules' and turn it on.
1351 The variable can have the following values:
1353 t Create an ID if needed to make a link to the current entry.
1355 create-if-interactive
1356 If `org-store-link' is called directly (interactively, as a user
1357 command), do create an ID to support the link. But when doing the
1358 job for remember, only use the ID if it already exists. The
1359 purpose of this setting is to avoid proliferation of unwanted
1360 IDs, just because you happen to be in an Org file when you
1361 call `org-remember' that automatically and preemptively
1362 creates a link. If you do want to get an ID link in a remember
1363 template to an entry not having an ID, create it first by
1364 explicitly creating a link to it, using `C-c C-l' first.
1366 create-if-interactive-and-no-custom-id
1367 Like create-if-interactive, but do not create an ID if there is
1368 a CUSTOM_ID property defined in the entry. This is the default.
1370 use-existing
1371 Use existing ID, do not create one.
1373 nil Never use an ID to make a link, instead link using a text search for
1374 the headline text."
1379 create-if-interactive)
1381 create-if-interactive-and-no-custom-id)
1386 "Non-nil means file links from `org-store-link' contain context.
1387 A search string will be added to the file name with :: as separator and
1388 used to find the context when the link is activated by the command
1389 `org-open-at-point'.
1391 negates this setting for the duration of the command."
1396 "Non-nil means keep link in list for entire session.
1398 The command `org-store-link' adds a link pointing to the current
1399 location to an internal list. These links accumulate during a session.
1400 The command `org-insert-link' can be used to insert links into any
1401 Org-mode file (offering completion for all stored links). When this
1403 will be removed from the list, to make completing the unused links
1404 more efficient."
1409 "Options concerning following links in Org-mode."
1414 "Function to translate links with different syntax to Org syntax.
1415 This can be used to translate links created for example by the Planner
1416 or emacs-wiki packages to Org syntax.
1417 The function must accept two parameters, a TYPE containing the link
1419 which is everything after the link protocol. It should return a cons
1420 with possibly modified values of type and path.
1421 Org contains a function for this, so if you set this variable to
1422 `org-translate-link-from-planner', you should be able follow many
1423 links created by planner."
1428 "Hook that is run after a link has been followed."
1433 "Non-nil means on links TAB will follow the link.
1434 Needs to be set before org.el is loaded.
1435 This really should not be used, it does not make sense, and the
1436 implementation is bad."
1441 "Non-nil means on links RET will follow the link."
1447 "Non-nil means mouse-1 on a link will follow the link.
1448 A longer mouse click will still set point. Does not work on XEmacs.
1449 Needs to be set before org.el is loaded."
1454 "Number of different positions to be recorded in the ring.
1455 Changing this requires a restart of Emacs to work correctly."
1460 "Non-nil means internal links in Org files must exactly match a headline.
1461 When nil, the link search tries to match a phrase will all words
1462 in the search text."
1468 query-to-create)))
1475 "Setup the frame configuration for following links.
1476 When following a link with Emacs, it may often be useful to display
1477 this link in another window or frame. This variable can be used to
1478 set this up for the different types of links.
1479 For VM, use any of
1480 `vm-visit-folder'
1481 `vm-visit-folder-other-frame'
1482 For Gnus, use any of
1483 `gnus'
1484 `gnus-other-frame'
1485 `org-gnus-no-new-news'
1486 For FILE, use any of
1487 `find-file'
1488 `find-file-other-window'
1489 `find-file-other-frame'
1490 For Wanderlust use any of
1491 `wl'
1492 `wl-other-frame'
1493 For the calendar, use the variable `calendar-setup'.
1494 For BBDB, it is currently only possible to display the matches in
1495 another window."
1519 "Non-nil means use indirect buffer to display infile links.
1520 Activating internal links (from one location in a file to another location
1521 in the same file) normally just jumps to the location. When the link is
1523 is displayed in
1524 another window. When this option is set, the other window actually displays
1525 an indirect buffer clone of the current buffer, to avoid any visibility
1526 changes to the current buffer."
1531 "Non-nil means `org-open-file' will open non-existing files.
1532 When nil, an error will be generated.
1533 This variable applies only to external applications because they
1534 might choke on non-existing files. If the link is to a file that
1535 will be opened in Emacs, the variable is ignored."
1540 "Non-nil means a link to a directory really means to index.org.
1541 When nil, following a directory link will run dired or open a finder/explorer
1542 window on that directory."
1547 "Function and arguments to call for following mailto links.
1548 This is a list with the first element being a Lisp function, and the
1549 remaining elements being arguments to the function. In string arguments,
1550 %a will be replaced by the address, and %s will be replaced by the subject
1551 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1560 "Non-nil means ask for confirmation before executing shell links.
1561 Shell links can be dangerous: just think about a link
1563 [[shell:rm -rf ~/*][Google Search]]
1566 but really it would remove your entire home directory.
1567 Therefore we advise against setting this variable to nil.
1568 Just change it to `y-or-n-p' if you want to confirm with a
1576 'safe-local-variable
1580 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1581 Elisp links can be dangerous: just think about a link
1586 but really it would remove your entire home directory.
1587 Therefore we advise against setting this variable to nil.
1588 Just change it to `y-or-n-p' if you want to confirm with a
1596 'safe-local-variable
1603 "Default file applications on a UNIX or GNU/Linux system.
1614 "Default file applications on a MacOS X system.
1616 for some files for which the OS does not have a good default.
1624 'mswindows-shell-execute
1629 'mswindows-shell-execute
1632 "Default file applications on a Windows NT system.
1637 '(
1642 )
1643 "External applications for opening `file:path' items in a document.
1644 Org-mode uses system defaults for different file types, but
1645 you can use this variable to set the application for a given file
1646 extension. The entries in this list are cons cells where the car identifies
1647 files and the cdr the corresponding command. Possible values for the
1648 file identifier are
1650 ways, depending on its contents:
1652 - Alphanumeric characters only:
1653 Match links with this file extension.
1655 to open PDFs with evince.
1657 - Regular expression: Match links where the
1658 filename matches the regexp. If you want to
1659 use groups here, use shy groups.
1663 to open *.html and *.xhtml with firefox.
1665 - Regular expression which contains (non-shy) groups:
1667 anything after that, matches the regexp.
1668 In a custom command string, %1, %2, etc. are replaced with
1669 the parts of the link that were matched by the groups.
1670 For backwards compatibility, if a command string is given
1671 that does not use any of the group matches, this case is
1672 handled identically to the second one (i.e. match against
1673 file name only).
1674 In a custom lisp form, you can access the group matches with
1675 (match-string n link).
1678 to open [[file:document.pdf::5]] with evince at page 5.
1680 `directory' Matches a directory
1681 `remote' Matches a remote file, accessible through tramp or efs.
1682 Remote files most likely should be visited through Emacs
1683 because external applications cannot handle such paths.
1684 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1685 so all files Emacs knows how to handle. Using this with
1686 command `emacs' will open most files in Emacs. Beware that this
1687 will also open html files inside Emacs, unless you add
1689 t Default for files not matched by any of the other options.
1690 `system' The system command to open files, like `open' on Windows
1691 and Mac OS X, and mailcap under GNU/Linux. This is the command
1692 that will be selected if you call `C-c C-o' with a double
1695 Possible values for the command are:
1696 `emacs' The file will be visited by the current Emacs process.
1697 `default' Use the default application for this file type, which is the
1698 association for t in the list, most likely in the system-specific
1699 part.
1700 This can be used to overrule an unwanted setting in the
1701 system-specific variable.
1703 This command is specified by the entry whose car is `system'.
1704 Most likely, the system-specific version of this variable
1705 does define this command, but you can overrule/replace it
1706 here.
1707 string A command to be executed by a shell; %s will be replaced
1708 by the path to the file.
1709 sexp A Lisp form which will be evaluated. The file path will
1710 be available in the Lisp variable `file'.
1711 For more examples, see the system specific constants
1712 `org-file-apps-defaults-macosx'
1713 `org-file-apps-defaults-windowsnt'
1714 `org-file-apps-defaults-gnu'."
1724 auto-mode))
1735 "Options concerning refiling entries in Org-mode."
1740 "Directory with org files.
1741 This is just a default location to look for Org files. There is no need
1742 at all to put your files into this directory. It is only used in the
1743 following situations:
1745 1. When a remember template specifies a target file that is not an
1746 absolute path. The path will then be interpreted relative to
1747 `org-directory'
1748 2. When a remember note is filed away in an interactive way (when exiting the
1749 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1750 with `org-directory' as the default path."
1756 "Default target for storing notes.
1757 Used as a fall back file for org-remember.el and org-capture.el, for
1758 templates that do not specify a target file."
1763 file))
1766 "The default interface to be used for `org-goto'.
1767 Allowed values are:
1768 outline The interface shows an outline of the relevant file
1769 and the correct heading is found by moving through
1770 the outline or by searching with incremental search.
1771 outline-path-completion Headlines in the current buffer are offered via
1772 completion. This is the interface also used by
1773 the refile command."
1780 "Maximum target level when running `org-goto' with refile interface."
1785 "Non-nil means store new notes at the beginning of a file or entry.
1786 When nil, new notes will be filed to the end of a file or entry.
1787 This can also be a list with cons cells of regular expressions that
1788 are matched against file names, and values."
1798 "Information to record when a task is refiled.
1800 Possible values are:
1802 nil Don't add anything
1803 time Add a time stamp to the task
1804 note Prompt for a note and add it with template `org-log-note-headings'
1806 This option can also be set with on a per-file-basis with
1808 #+STARTUP: nologrefile
1809 #+STARTUP: logrefile
1810 #+STARTUP: lognoterefile
1812 You can have local logging settings for a subtree by setting the LOGGING
1813 property to one or more of these keywords.
1815 When bulk-refiling from the agenda, the value `note' is forbidden and
1816 will temporarily be changed to `time'."
1826 This is list of cons cells. Each cell contains:
1827 - a specification of the files to be considered, either a list of files,
1828 or a symbol whose function or variable value will be used to retrieve
1829 a file name or a list of file names. If you use `org-agenda-files' for
1830 that, all agenda files will be scanned for targets. Nil means consider
1831 headings in the current buffer.
1832 - A specification of how to find candidate refile targets. This may be
1833 any of:
1835 This tag has to be present in all target headlines, inheritance will
1836 not be considered.
1838 todo keyword.
1840 headlines that are refiling targets.
1841 - a cons cell (:level . N). Any headline of level N is considered a target.
1842 Note that, when `org-odd-levels-only' is set, level corresponds to
1843 order in hierarchy, not to the number of stars.
1844 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1845 Note that, when `org-odd-levels-only' is set, level corresponds to
1846 order in hierarchy, not to the number of stars.
1848 You can set the variable `org-refile-target-verify-function' to a function
1849 to verify each headline found by the simple criteria above.
1851 When this variable is nil, all top-level headlines in the current buffer
1852 are used, equivalent to the value `((nil . (:level . 1))'."
1868 "Function to verify if the headline at point should be a refile target.
1869 The function will be called without arguments, with point at the
1870 beginning of the headline. It should return t and leave point
1871 where it is if the headline is a valid target for refiling.
1873 If the target should not be selected, the function must return nil.
1874 In addition to this, it may move point to a place from where the search
1875 should be continued. For example, the function may decide that the entire
1876 subtree of the current entry should be excluded and move point to the end
1877 of the subtree."
1882 "Non-nil means cache refile targets to speed up the process.
1883 The cache for a particular file will be updated automatically when
1884 the buffer has been killed, or when any of the marker used for flagging
1885 refile targets no longer points at a live buffer.
1886 If you have added new entries to a buffer that might themselves be targets,
1887 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1888 find that easier, `C-u C-u C-u C-c C-w'."
1893 "Non-nil means provide refile targets as paths.
1894 So a level 3 headline will be available as level1/level2/level3.
1896 When the value is `file', also include the file name (without directory)
1897 into the path. In this case, you can also stop the completion after
1898 the file name, to get entries inserted as top level in the file.
1900 When `full-file-path', include the full file path."
1909 "Non-nil means complete the outline path in hierarchical steps.
1910 When Org-mode uses the refile interface to select an outline path
1911 \(see variable `org-refile-use-outline-path'), the completion of
1912 the path can be done is a single go, or if can be done in steps down
1913 the headline hierarchy. Going in steps is probably the best if you
1914 do not use a special completion package like `ido' or `icicles'.
1915 However, when using these packages, going in one step can be very
1916 fast, while still showing the whole path to the entry."
1921 "Non-nil means allow to create new nodes as refile targets.
1923 of an existing node. When the value of this variable is `confirm',
1924 new node creation must be confirmed by the user (recommended)
1925 When nil, the completion must match an existing entry.
1927 Note that, if the new heading is not seen by the criteria
1928 listed in `org-refile-targets', multiple instances of the same
1929 heading would be created by trying again to file under the new
1930 heading."
1938 "Options concerning TODO items in Org-mode."
1943 "Options concerning Progress logging in Org-mode."
1948 '(
1951 "The available interpretation symbols for customizing `org-todo-keywords'.
1955 "List of TODO entry keyword sequences and their interpretation.
1958 Each sequence starts with a symbol, either `sequence' or `type',
1959 indicating if the keywords should be interpreted as a sequence of
1960 action steps, or as different types of TODO items. The first
1961 keywords are states requiring action - these states will select a headline
1962 for inclusion into the global TODO list Org-mode produces. If one of
1965 the last keyword is treated as the only DONE state of the sequence.
1968 additional state where no keyword is present. For details about this
1969 cycling, see the manual.
1971 TODO keywords and interpretation can also be set on a per-file basis with
1972 the special #+SEQ_TODO and #+TYP_TODO lines.
1974 Each keyword can optionally specify a character for fast state selection
1975 \(in combination with the variable `org-use-fast-todo-selection')
1976 and specifiers for state change logging, using the same syntax
1979 indicates to record a time stamp each time this state is selected.
1981 Each keyword may also specify if a timestamp or a note should be
1982 recorded when entering or leaving the state, by adding additional
1983 characters in the parenthesis after the keyword. This looks like this:
1985 record only the time of the state change. With X and Y being either
1987 Y when leaving the state if and only if the *target* state does not
1988 define X. You may omit any of the fast-selection key or X or /Y,
1989 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1991 For backward compatibility, this variable may also be just a list
1992 of keywords - in this case the interpretation (sequence or type) will be
1993 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2003 ;;Quick and dirty way to see
2004 ;;`org-todo-interpretations'. This takes the
2005 ;;place of item arguments
2006 :convert-widget
2013 org-todo-interpretation-widgets))
2014 widget))
2045 "Controls how TODO keywords are interpreted.
2046 This variable is in principle obsolete and is only used for
2047 backward compatibility, if the interpretation of todo keywords is
2048 not given already in `org-todo-keywords'. See that variable for
2049 more information."
2056 "Non-nil means use the fast todo selection scheme with C-c C-t.
2057 This variable describes if and under what circumstances the cycling
2058 mechanism for TODO keywords will be replaced by a single-key, direct
2059 selection scheme.
2061 When nil, fast selection is never used.
2063 When the symbol `prefix', it will be used when `org-todo' is called with
2064 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2065 in an agenda buffer.
2067 When t, fast selection is used by default. In this case, the prefix
2068 argument forces cycling instead.
2070 In all cases, the special interface is only used if access keys have actually
2071 been assigned by the user, i.e. if keywords in the configuration are followed
2072 by a letter in parenthesis, like TODO(t)."
2080 "Non-nil means update todo statistics after insert and toggle.
2081 ALL-HEADLINES means update todo statistics by including headlines
2082 with no TODO keyword as well, counting them as not done.
2083 A list of TODO keywords means the same, but skip keywords that are
2084 not in this list.
2086 When this is set, todo statistics is updated in the parent of the
2087 current entry each time a todo state is changed."
2097 "Non-nil means TODO statistics covers just direct children.
2098 When nil, all entries in the subtree are considered.
2099 This has only an effect if `org-provide-todo-statistics' is set.
2100 To set this to nil for only a single subtree, use a COOKIE_DATA
2106 "Hook which is run after the state of a TODO item was changed.
2107 The new state (a string with a TODO keyword, or nil) is available in the
2108 Lisp variable `state'."
2113 "Hook for functions that are allowed to block a state change.
2115 Each function gets as its single argument a property list, see
2116 `org-trigger-hook' for more information about this list.
2118 If any of the functions in this hook returns nil, the state change
2122 "Hook for functions that are triggered by a state change.
2124 Each function gets as its single argument a property list with at least
2125 the following elements:
2127 (:type type-of-change :position pos-at-entry-start
2128 :from old-state :to new-state)
2130 Depending on the type, more properties may be present.
2132 This mechanism is currently implemented for:
2134 TODO state changes
2135 ------------------
2136 :type todo-state-change
2137 :from previous state (keyword as a string), or nil, or a symbol
2138 'todo' or 'done', to indicate the general type of state.
2142 "Non-nil means undone TODO entries will block switching the parent to DONE.
2143 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2144 be blocked if any prior sibling is not yet done.
2145 Finally, if the parent is blocked because of ordered siblings of its own,
2146 the child will also be blocked.
2147 This variable needs to be set before org.el is loaded, and you need to
2148 restart Emacs after a change to make the change effective. The only way
2149 to change is while Emacs is running is through the customize interface."
2161 "Non-nil means unchecked boxes will block switching the parent to DONE.
2162 When this is nil, checkboxes have no influence on switching TODO states.
2163 When non-nil, you first need to check off all check boxes before the TODO
2164 entry can be switched to DONE.
2165 This variable needs to be set before org.el is loaded, and you need to
2166 restart Emacs after a change to make the change effective. The only way
2167 to change is while Emacs is running is through the customize interface."
2179 "Non-nil means inserting a TODO heading is treated as state change.
2181 logging will apply if appropriate. When nil, the new TODO item will
2182 be inserted directly, and no logging will take place."
2187 "Non-nil means switching TODO states with S-cursor counts as state change.
2188 This is the default behavior. However, setting this to nil allows a
2189 convenient way to select a TODO state and bypass any logging associated
2190 with that."
2195 "Tag changes that should be triggered by TODO state changes.
2196 This is a list. Each entry is
2198 (state-change (tag . flag) .......)
2200 State-change can be a string with a state, and empty string to indicate the
2201 state that has no TODO keyword, or it can be one of the symbols `todo'
2202 or `done', meaning any not-done or done state, respectively."
2216 "Information to record when a task moves to the DONE state.
2218 Possible values are:
2220 nil Don't add anything, just change the keyword
2221 time Add a time stamp to the task
2222 note Prompt for a note and add it with template `org-log-note-headings'
2224 This option can also be set with on a per-file-basis with
2226 #+STARTUP: nologdone
2227 #+STARTUP: logdone
2228 #+STARTUP: lognotedone
2230 You can have local logging settings for a subtree by setting the LOGGING
2231 property to one or more of these keywords."
2239 ;; Normalize old uses of org-log-done.
2246 "Information to record when the scheduling date of a tasks is modified.
2248 Possible values are:
2250 nil Don't add anything, just change the date
2251 time Add a time stamp to the task
2252 note Prompt for a note and add it with template `org-log-note-headings'
2254 This option can also be set with on a per-file-basis with
2256 #+STARTUP: nologreschedule
2257 #+STARTUP: logreschedule
2258 #+STARTUP: lognotereschedule"
2267 "Information to record when the deadline date of a tasks is modified.
2269 Possible values are:
2271 nil Don't add anything, just change the date
2272 time Add a time stamp to the task
2273 note Prompt for a note and add it with template `org-log-note-headings'
2275 This option can also be set with on a per-file-basis with
2277 #+STARTUP: nologredeadline
2278 #+STARTUP: logredeadline
2279 #+STARTUP: lognoteredeadline
2281 You can have local logging settings for a subtree by setting the LOGGING
2282 property to one or more of these keywords."
2291 "Non-nil means record a note when clocking out of an item.
2292 This can also be configured on a per-file basis by adding one of
2293 the following lines anywhere in the buffer:
2295 #+STARTUP: lognoteclock-out
2296 #+STARTUP: nolognoteclock-out"
2302 "Non-nil means the CLOSED time stamp will contain date and time.
2303 When nil, only the date will be recorded."
2317 "Headings for notes added to entries.
2318 The value is an alist, with the car being a symbol indicating the note
2319 context, and the cdr is the heading to be used. The heading may also be the
2320 empty string.
2321 %t in the heading will be replaced by a time stamp.
2322 %T will be an active time stamp instead the default inactive one
2323 %s will be replaced by the new TODO state, in double quotes.
2324 %S will be replaced by the old TODO state, in double quotes.
2325 %u will be replaced by the user name.
2326 %U will be replaced by the full user name.
2328 In fact, it is not a good idea to change the `state' entry, because
2329 agenda log mode depends on the format of these entries."
2335 "Heading when changing todo state (todo sequence only)"
2349 "Non-nil means insert state change notes and time stamps into a drawer.
2350 When nil, state changes notes will be inserted after the headline and
2351 any scheduling and clock lines, but not inside a drawer.
2353 The value of this variable should be the name of the drawer to use.
2354 LOGBOOK is proposed at the default drawer for this purpose, you can
2355 also set this to a string to define the drawer of your choice.
2359 If this variable is set, `org-log-state-notes-insert-after-drawers'
2360 will be ignored.
2362 You can set the property LOG_INTO_DRAWER to overrule this setting for
2363 a subtree."
2375 "Return the value of `org-log-into-drawer', but let properties overrule.
2376 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2377 used instead of the default value."
2385 "Non-nil means insert state change notes after any drawers in entry.
2386 Only the drawers that *immediately* follow the headline and the
2387 deadline/scheduled line are skipped.
2388 When nil, insert notes right after the heading and perhaps the line
2389 with deadline/scheduling if present.
2391 This variable will have no effect if `org-log-into-drawer' is
2392 set."
2398 "Non-nil means the latest state note will be directly after heading.
2399 When nil, the state change notes will be ordered according to time."
2405 "The TODO state to which a repeater should return the repeating task.
2406 By default this is the first task in a TODO sequence, or the previous state
2407 in a TODO_TYP set. But you can specify another task here.
2408 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2414 "Non-nil means record moving through the DONE state when triggering repeat.
2415 An auto-repeating task is immediately switched back to TODO when
2418 record a closing note, there will be no record of the task moving
2419 through DONE. This variable forces taking a note anyway.
2421 nil Don't force a record
2422 time Record a time stamp
2423 note Record a note
2425 This option can also be set with on a per-file-basis with
2427 #+STARTUP: logrepeat
2428 #+STARTUP: lognoterepeat
2429 #+STARTUP: nologrepeat
2431 You can have local logging settings for a subtree by setting the LOGGING
2432 property to one or more of these keywords."
2442 "Priorities in Org-mode."
2447 "Non-nil means priority commands are active.
2448 When nil, these commands will be disabled, so that you never accidentally
2449 set a priority."
2454 "The highest priority of TODO items. A character like ?A, ?B etc.
2455 Must have a smaller ASCII number than `org-lowest-priority'."
2460 "The lowest priority of TODO items. A character like ?A, ?B etc.
2461 Must have a larger ASCII number than `org-highest-priority'."
2466 "The default priority of TODO items.
2467 This is the priority an item get if no explicit priority is given."
2472 "Non-nil means start with default priority when starting to cycle.
2473 When this is nil, the first step in the cycle will be (depending on the
2474 command used) one higher or lower that the default priority."
2479 "Function to extract the priority from a string.
2480 The string is normally the headline. If this is nil Org computes the
2481 priority from the priority cookie like [#A] in the headline. It returns
2482 an integer, increasing by 1000 for each priority level.
2483 The user can set a different function here, which should take a string
2484 as an argument and return the numeric priority."
2489 "Options concerning time stamps and deadlines in Org-mode."
2494 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2495 When nil, these labeled time stamps are forces into the second line of an
2496 entry, just after the headline. When scheduling from the global TODO list,
2497 the time stamp will always be forced into the second line."
2502 "Formats for `format-time-string' which are used for time stamps.
2506 "Number of minutes to round time stamps to.
2507 These are two values, the first applies when first creating a time stamp.
2508 The second applies when changing it with the commands `S-up' and `S-down'.
2509 When changing the time stamp, this means that it will change in steps
2510 of N minutes, as given by the second value.
2512 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2513 numbers should be factors of 60, so for example 5, 10, 15.
2515 When this is larger than 1, you can still force an exact time stamp by using
2516 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2517 and by using a prefix arg to `S-up/down' to specify the exact number
2518 of minutes to shift."
2528 ;; Normalize old customizations of this variable.
2532 org-time-stamp-rounding-minutes)))
2535 "Non-nil means overlay custom formats over all time stamps.
2536 The formats are defined through the variable `org-time-stamp-custom-formats'.
2537 To turn this on on a per-file basis, insert anywhere in the file:
2538 #+STARTUP: customtime"
2546 "Custom formats for time stamps. See `format-time-string' for the syntax.
2547 These are overlayed over the default ISO format if the variable
2548 `org-display-custom-times' is set. Time like %H:%M should be at the
2549 end of the second format. The custom formats are also honored by export
2550 commands, if custom time display is turned on at the time of export."
2555 "Get the right format for a time string."
2560 f)))
2563 "The format string used when creating CLOCKSUM lines.
2564 This is also used when org-mode generates a time duration."
2570 org-mode generates a time duration."
2575 "The format string used when creating CLOCKSUM lines, or when
2576 org-mode generates a time duration."
2581 "No. of days before expiration during which a deadline becomes active.
2582 This variable governs the display in sparse trees and in the agenda.
2583 When 0 or negative, it means use this number (the absolute value of it)
2584 even if a deadline has a different individual lead time specified.
2586 Custom commands can set this variable in the options section."
2592 "Non-nil means assume future for incomplete date input from user.
2593 This affects the following situations:
2594 1. The user gives a month but not a year.
2597 2. The user gives a day, but no month.
2600 it will be considered as *this* month.
2602 If you set this variable to the symbol `time', then also the following
2603 will work:
2605 3. If the user gives a time, but no day. If the time is before now,
2606 to will be interpreted as tomorrow.
2608 Currently none of this works for ISO week specifications.
2610 When this option is nil, the current day, month and year will always be
2611 used as defaults.
2613 See also `org-agenda-jump-prefer-future'."
2621 "Should the agenda jump command prefer the future for incomplete dates?
2622 The default is to do the same as configured in `org-read-date-prefer-future'.
2623 But you can alse set a deviating value here.
2624 This may t or nil, or the symbol `org-read-date-prefer-future'."
2629 org-read-date-prefer-future)
2634 "Non-nil means display current interpretation of date prompt live.
2635 This display will be in an overlay, in the minibuffer."
2640 "Non-nil means pop up a calendar when prompting for a date.
2641 In the calendar, the date can be selected with mouse-1. However, the
2642 minibuffer will also be active, and you can simply enter the date as well.
2643 When nil, only the minibuffer will be available."
2651 "Hook to be used to set up keys for the date/time interface.
2652 Add key definitions to `minibuffer-local-map', which will be a temporary
2653 copy."
2658 "The hour when your day really ends. Must be an integer.
2659 This has influence for the following applications:
2661 the time given here, the day recognized as TODAY is actually yesterday.
2662 - When a date is read from the user and it is still before the time given
2663 here, the current date and time will be assumed to be yesterday, 23:59.
2664 Also, timestamps inserted in remember templates follow this rule.
2666 IMPORTANT: This is a feature whose implementation is and likely will
2667 remain incomplete. Really, it is only here because past midnight seems to
2668 be the favorite working time of John Wiegley :-)"
2673 "Non-nil means S-down will increase the time in a time stamp.
2674 When nil, S-up will increase."
2679 "Non-nil means make the calendar window follow timestamp changes.
2680 When a timestamp is modified and the calendar window is visible, it will be
2681 moved to the new date."
2686 "Options concerning tags in Org-mode."
2691 "List of tags allowed in Org-mode files.
2692 When this list is nil, Org-mode will base TAG input on what is already in the
2693 buffer.
2694 The value of this variable is an alist, the car of each entry must be a
2695 keyword as a string, the cdr may be a character that is used to select
2696 that tag through the fast-tag-selection interface.
2697 See the manual for details."
2712 "List of tags that will always appear in all Org-mode files.
2713 This is in addition to any in buffer settings or customizations
2714 of `org-tag-alist'.
2715 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2716 The value of this variable is an alist, the car of each entry must be a
2717 keyword as a string, the cdr may be a character that is used to select
2718 that tag through the fast-tag-selection interface.
2719 See the manual for details.
2720 To disable these tags on a per-file basis, insert anywhere in the file:
2721 #+STARTUP: noptag"
2732 "If non-nil, always offer completion for all tags of all agenda files.
2733 Instead of customizing this variable directly, you might want to
2734 set it locally for capture buffers, because there no list of
2735 tags in that file can be created dynamically (there are none).
2737 (add-hook 'org-capture-mode-hook
2738 (lambda ()
2739 (set (make-local-variable
2740 'org-complete-tags-always-offer-all-agenda-tags)
2741 t)))"
2746 "List of tags that can be inherited by all entries in the file.
2747 The tags will be inherited if the variable `org-use-tag-inheritance'
2748 says they should be.
2752 "Non-nil means use fast tag selection scheme.
2753 This is a special interface to select and deselect tags with single keys.
2754 When nil, fast selection is never used.
2755 When the symbol `auto', fast selection is used if and only if selection
2756 characters for tags have been configured, either through the variable
2757 `org-tag-alist' or through a #+TAGS line in the buffer.
2758 When t, fast selection is always used and selection keys are assigned
2759 automatically if necessary."
2767 "Non-nil means fast tag selection exits after first change.
2768 When nil, you have to press RET to exit it.
2769 During fast tag selection, you can toggle this flag with `C-c'.
2770 This variable can also have the value `expert'. In this case, the window
2771 displaying the tags menu is not even shown, until you press C-c again."
2779 "Non-nil means fast tags selection interface will also offer TODO states.
2783 "The column to which tags should be indented in a headline.
2784 If this number is positive, it specifies the column. If it is negative,
2785 it means that the tags should be flushright to that column. For example,
2786 -80 works well for a normal 80 character screen."
2791 "Non-nil means realign tags after pro/demotion of TODO state change.
2792 These operations change the length of a headline and therefore shift
2793 the tags around. With this options turned on, after each such operation
2794 the tags are again aligned to `org-tags-column'."
2799 "Non-nil means tags in levels apply also for sublevels.
2800 When nil, only the tags directly given in a specific line apply there.
2801 This may also be a list of tags that should be inherited, or a regexp that
2802 matches tags that should be inherited. Additional control is possible
2803 with the variable `org-tags-exclude-from-inheritance' which gives an
2804 explicit list of tags to be excluded from inheritance., even if the value of
2805 `org-use-tag-inheritance' would select it for inheritance.
2807 If this option is t, a match early-on in a tree can lead to a large
2808 number of matches in the subtree when constructing the agenda or creating
2809 a sparse tree. If you only want to see the first match in a tree during
2810 a search, check out the variable `org-tags-match-list-sublevels'."
2819 "List of tags that should never be inherited.
2820 This is a way to exclude a few tags from inheritance. For way to do
2821 the opposite, to actively allow inheritance for selected tags,
2822 see the variable `org-use-tag-inheritance'."
2827 "Check if TAG is one that should be inherited."
2839 "Non-nil means list also sublevels of headlines matching a search.
2840 This variable applies to tags/property searches, and also to stuck
2841 projects because this search is based on a tags match as well.
2843 When set to the symbol `indented', sublevels are indented with
2844 leading dots.
2846 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2847 the sublevels of a headline matching a tag search often also match
2848 the same search. Listing all of them can create very long lists.
2849 Setting this variable to nil causes subtrees of a match to be skipped.
2851 This variable is semi-obsolete and probably should always be true. It
2852 is better to limit inheritance to certain tags using the variables
2853 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2861 "When set, tags are sorted using this function as a comparator."
2877 "Options concerning properties in Org-mode."
2882 "How property key/value pairs should be formatted by `indent-line'.
2883 When `indent-line' hits a property definition, it will format the line
2884 according to this format, mainly to make sure that the values are
2885 lined-up with respect to each other."
2890 "Non-nil means properties apply also for sublevels.
2892 This setting is chiefly used during property searches. Turning it on can
2893 cause significant overhead when doing a search, which is why it is not
2894 on by default.
2896 When nil, only the properties directly given in the current entry count.
2897 When t, every property is inherited. The value may also be a list of
2898 properties that should have inheritance, or a regular expression matching
2899 properties that should be inherited.
2901 However, note that some special properties use inheritance under special
2902 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2904 for valid values of a property.
2906 Note for programmers:
2907 When querying an entry with `org-entry-get', you can control if inheritance
2908 should be used. By default, `org-entry-get' looks only at the local
2909 properties. You can request inheritance by setting the inherit argument
2910 to t (to force inheritance) or to `selective' (to respect the setting
2911 in this variable)."
2920 "Check if PROPERTY is one that should be inherited."
2931 "The default column format, if no other format has been defined.
2932 This variable can be set on the per-file basis by inserting a line
2934 #+COLUMNS: %25ITEM ....."
2939 "The ellipses to be used when a field in column view is truncated.
2940 When this is the empty string, as many characters as possible are shown,
2941 but then there will be no visual indication that the field has been truncated.
2942 When this is a string of length N, the last N characters of a truncated
2943 field are replaced by this string. If the column is narrower than the
2944 ellipses string, only part of the ellipses string will be shown."
2949 "Function that modifies values for display in column view.
2950 For example, it can be used to cut out a certain part from a time stamp.
2951 The function must take 2 arguments:
2953 column-title The title of the column (*not* the property name)
2954 value The value that should be modified.
2956 The function should return the value that should be displayed,
2957 or nil if the normal value should be used."
2962 "The property that is being used to keep track of effort estimates.
2963 Effort estimates given in this property need to have the format H:MM."
2971 "List of property/value pairs that can be inherited by any entry.
2973 These are fixed values, for the preset properties. The user variable
2974 that can be used to add to this list is `org-global-properties'.
2976 The entries in this list are cons cells where the car is a property
2977 name and cdr is a string with the value. If the value represents
2982 "List of property/value pairs that can be inherited by any entry.
2984 This list will be combined with the constant `org-global-properties-fixed'.
2986 The entries in this list are cons cells where the car is a property
2987 name and cdr is a string with the value.
2989 You can set buffer-local values for the same purpose in the variable
2990 `org-file-properties' this by adding lines like
2992 #+PROPERTY: NAME VALUE"
2999 "List of property/value pairs that can be inherited by any entry.
3000 Valid for the current buffer.
3005 "Options concerning agenda views in Org-mode."
3010 "Variable used by org files to set a category for agenda display.
3011 Such files should use a file variable to set it, for example
3015 or contain a special line
3017 #+CATEGORY: ELisp
3019 If the file does not specify a category, then file's base name
3025 "The files to be used for agenda display.
3029 If an entry is a directory, all files in that directory that are matched by
3030 `org-agenda-file-regexp' will be part of the file list.
3032 If the value of the variable is not a list but a single file name, then
3033 the list of agenda files is actually stored and maintained in that file, one
3034 agenda file per line. In this file paths can be given relative to
3035 `org-directory'. Tilde expansion and environment variable substitution
3036 are also made."
3043 "Regular expression to match files for `org-agenda-files'.
3044 If any element in the list in that variable contains a directory instead
3045 of a normal file, all files in that directory that are matched by this
3046 regular expression will be included."
3051 "List of extra files to be searched by text search commands.
3052 These files will be search in addition to the agenda files by the
3053 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3054 Note that these files will only be searched for text search commands,
3055 not for the other agenda views like todo lists, tag searches or the weekly
3056 agenda. This variable is intended to list notes and possibly archive files
3057 that should also be searched by these two commands.
3058 In fact, if the first element in the list is the symbol `agenda-archives',
3059 than all archive files of all agenda files will be added to the search
3060 scope."
3071 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3072 A nil value means to remove them, after a query, from the list."
3077 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3078 The command `org-calendar-goto-agenda' will be bound to this key. The
3079 default is the character `c' because then `c' can be used to switch back and
3080 forth between agenda and calendar."
3085 "The key to be installed in `calendar-mode-map' for agenda-action.
3086 The command `org-agenda-action' will be bound to this key. The
3087 default is the character `k' because we use the same key in the agenda."
3092 "The key to be installed in `calendar-mode-map' for adding diary entries.
3093 This option is irrelevant until `org-agenda-diary-file' has been configured
3094 to point to an Org-mode file. When that is the case, the command
3095 `org-agenda-diary-entry' will be bound to the key given here, by default
3096 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3097 if you want to continue doing this, you need to change this to a different
3098 key."
3103 "File to which to add new entries with the `i' key in agenda and calendar.
3104 When this is the symbol `diary-file', the functionality in the Emacs
3105 calendar will be used to add entries to the `diary-file'. But when this
3106 points to a file, `org-agenda-diary-entry' will be used instead."
3122 org-calendar-insert-diary-entry-key
3126 "Options for embedding LaTeX code into Org-mode."
3134 "Options for creating images from LaTeX fragments.
3135 This is a property list with the following properties:
3137 `default' means use the foreground of the default face.
3139 `default' means use the background of the default face.
3140 :scale a scaling factor for the size of the images, to get more pixels
3141 :html-foreground, :html-background, :html-scale
3142 the same numbers for HTML export.
3143 :matchers a list indicating which matchers should be used to
3144 find LaTeX fragments. Valid members of this list are:
3155 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3156 When nil, just push out a message."
3165 \[PACKAGES]
3166 \[DEFAULT-PACKAGES]
3167 % The settings below are copied from fullpage.sty
3180 "The document header used for processing LaTeX fragments.
3181 It is imperative that this header make sure that no page number
3182 appears on the page. The package defined in the variables
3183 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3185 will be appended."
3192 "Set the packages alist and make sure it has 3 elements per entry."
3196 x))
3197 val)))
3201 "Get the packages alist and make sure it has 3 elements per entry."
3205 x))
3208 ;; The following variables are defined here because is it also used
3209 ;; when formatting latex fragments. Originally it was part of the
3210 ;; LaTeX exporter, which is why the name includes "export".
3227 )
3228 "Alist of default packages to be inserted in the header.
3229 Change this only if one of the packages here causes an incompatibility
3230 with another package you are using.
3231 The packages in this list are needed by one part or another of Org-mode
3232 to function properly.
3234 - inputenc, fontenc: for basic font and character selection
3235 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3236 for interpreting the entities in `org-entities'. You can skip some of these
3237 packages if you don't use any of the symbols in it.
3238 - graphicx: for including images
3239 - float, wrapfig: for figure placement
3240 - longtable: for long tables
3241 - hyperref: for cross references
3243 Therefore you should not modify this variable unless you know what you
3244 are doing. The one reason to change it anyway is that you might be loading
3245 some other package that conflicts with one of the default packages.
3247 If SNIPPET-FLAG is t, the package also needs to be included when
3248 compiling LaTeX snippets into images for inclusion into HTML."
3261 "Alist of packages to be inserted in every LaTeX header.
3262 These will be inserted after `org-export-latex-default-packages-alist'.
3264 SNIPPET-FLAG, when t, indicates that this package is also needed when
3265 turning LaTeX snippets into images for inclusion into HTML.
3266 Make sure that you only list packages here which:
3267 - you want in every file
3268 - do not conflict with the default packages in
3269 `org-export-latex-default-packages-alist'
3270 - do not conflict with the setup in `org-format-latex-header'."
3284 "Settings for Org-mode appearance."
3289 "Non-nil means fontify only the stars in each headline.
3290 When nil, the entire headline is fontified.
3291 Changing it requires restart of `font-lock-mode' to become effective
3292 also in regions already fontified."
3297 "Non-nil means hide the first N-1 stars in a headline.
3298 This works by using the face `org-hide' for these stars. This
3299 face is white for a light background, and black for a dark
3300 background. You may have to customize the face `org-hide' to
3301 make this work.
3302 Changing it requires restart of `font-lock-mode' to become effective
3303 also in regions already fontified.
3304 You may also set this on a per-file basis by adding one of the following
3305 lines to the buffer:
3307 #+STARTUP: hidestars
3308 #+STARTUP: showstars"
3313 "List of keywords that should be hidden when typed in the org buffer.
3314 For example, add #+TITLE to this list in order to make the
3315 document title appear in the buffer without the initial #+TITLE:
3316 keyword."
3324 "Non-nil means change the face of a headline if it is marked DONE.
3325 Normally, only the TODO/DONE keyword indicates the state of a headline.
3326 When this is non-nil, the headline after the keyword is set to the
3327 `org-headline-done' as an additional indication."
3332 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3333 Changing this variable requires a restart of Emacs to take effect."
3338 "Non-nil means fontify the whole line for headings.
3339 This is useful when setting a background color for the
3340 org-level-* faces."
3345 "Non-nil means fontify what is treated specially by the exporters."
3350 "Non-nil mean font-lock should hide the emphasis marker characters."
3355 "Non-nil means show entities as UTF8 characters.
3361 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3366 "Regular expression for matching emphasis.
3367 After a match, the match groups contain these elements:
3368 0 The match of the full regular expression, including the characters
3369 before and after the proper match
3370 1 The character before the proper match, or empty at beginning of line
3371 2 The proper match, including the leading and trailing markers
3372 3 The leading marker like * or /, indicating the type of highlighting
3373 4 The text between the emphasis markers, not including the markers
3380 "Set variable and compute the emphasis regular expression."
3384 org-emphasis-alist org-emphasis-regexp-components)
3396 ;; make sure special characters appear at the right position in the class
3408 ;; Make the regexp
3416 body1
3428 body1
3436 "Components used to build the regular expression for emphasis.
3437 This is a list with five entries. Terminology: In an emphasis string
3441 specify what is allowed/forbidden in each part:
3443 pre Chars allowed as prematch. Beginning of line will be allowed too.
3444 post Chars allowed as postmatch. End of line will be allowed too.
3445 border The chars *forbidden* as border characters.
3447 non-shy groups here, and don't allow newline here.
3448 newline The maximum number of newlines allowed in an emphasis exp.
3450 Use customize to modify this, or restart Emacs after changing it."
3469 )
3470 "Special syntax for emphasized text.
3471 Text starting and ending with a special character will be emphasized, for
3472 example *bold*, _underlined_ and /italic/. This variable sets the marker
3473 characters, the face to be used by font-lock for highlighting in Org-mode
3474 Emacs buffers, and the HTML tags to be used for this.
3475 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3476 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3477 Use customize to modify this, or restart Emacs after changing it."
3492 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3495 ;;; Miscellaneous options
3498 "Completion in Org-mode."
3503 "Non-nil means use ido completion wherever possible.
3504 Note that `ido-mode' must be active for this variable to be relevant.
3505 If you decide to turn this variable on, you might well want to turn off
3506 `org-outline-path-complete-in-steps'.
3507 See also `org-completion-use-iswitchb'."
3512 "Non-nil means use iswitchb completion wherever possible.
3513 Note that `iswitchb-mode' must be active for this variable to be relevant.
3514 If you decide to turn this variable on, you might well want to turn off
3515 `org-outline-path-complete-in-steps'.
3516 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3522 Normal means, no org-mode-specific context."
3526 ;;; Functions and variables from their packages
3527 ;; Declared here to avoid compiler warnings
3529 ;; XEmacs only
3535 ;; Emacs only
3538 ;; Various packages
3556 org-format-agenda-item "org-agenda"
3585 ;;; Autoload and prepare some org modules
3587 ;; Some table stuff that needs to be defined here, because it is used
3588 ;; by the functions setting up org-mode or checking for table context.
3601 "Detect the first line outside a table when searching from within it.
3604 ;; Autoload the functions in org-table.el that are needed by functions here.
3609 org-table-convert org-table-convert-region org-table-copy-down
3610 org-table-copy-region org-table-create
3611 org-table-create-or-convert-from-region
3612 org-table-create-with-table.el org-table-current-dline
3613 org-table-cut-region org-table-delete-column org-table-edit-field
3614 org-table-edit-formulas org-table-end org-table-eval-formula
3615 org-table-export org-table-field-info
3616 org-table-get-stored-formulas org-table-goto-column
3617 org-table-hline-and-move org-table-import org-table-insert-column
3618 org-table-insert-hline org-table-insert-row org-table-iterate
3619 org-table-justify-field-maybe org-table-kill-row
3620 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3621 org-table-move-column org-table-move-column-left
3622 org-table-move-column-right org-table-move-row
3623 org-table-move-row-down org-table-move-row-up
3624 org-table-next-field org-table-next-row org-table-paste-rectangle
3625 org-table-previous-field org-table-recalculate
3626 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3627 org-table-toggle-coordinate-overlays
3628 org-table-toggle-formula-debugger org-table-wrap-region
3629 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3630 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3631 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3634 "Return t if the cursor is inside an org-type table.
3635 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3640 org-table-line-regexp)))
3641 nil))
3645 "Return t if and only if we are at a table.el table."
3651 "If there is a table.el table nearby, recognize it and move into it."
3657 nil
3667 t
3672 t)
3673 nil)
3674 nil))
3677 "Return t if the cursor is inside a hline in a table."
3682 nil))
3687 "Apply FUNCTION to the start of all tables in the buffer."
3703 ;; Declare and autoload functions from org-exp.el & Co
3711 org-insert-export-options-template
3712 org-table-clean-before-export))
3715 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3716 org-export-region-as-ascii))
3719 org-replace-region-by-latex org-export-region-as-latex
3720 org-export-as-latex org-export-as-pdf
3721 org-export-as-pdf-and-open))
3724 org-export-as-html-batch org-export-as-html-to-buffer
3725 org-replace-region-by-html org-export-region-as-html
3726 org-export-as-html))
3729 org-replace-region-by-docbook org-export-region-as-docbook
3730 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3731 org-export-as-docbook))
3734 org-export-icalendar-all-agenda-files
3735 org-export-icalendar-combine-agenda-files))
3739 ;; Declare and autoload functions from org-agenda.el
3744 org-todo-list org-tags-view org-agenda-list-stuck-projects
3745 org-diary org-agenda-to-appt
3746 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3748 ;; Autoload org-remember
3753 org-remember-apply-template org-remember org-remember-handler)))
3758 org-capture-import-remember-templates)))
3760 ;; Autoload org-clock.el
3775 "Return non-nil if clock is currently running.
3776 The return value is actually the clock marker."
3781 "org-clock"
3783 org-clock-goto org-clock-sum org-clock-display
3784 org-clock-remove-overlays org-clock-report
3785 org-clocktable-shift org-dblock-write:clocktable
3786 org-get-clocktable org-resolve-clocks)))
3789 "If this is a CLOCK line, update it and return t.
3790 Otherwise, return nil."
3799 ts te h m s neg)
3802 nil)
3807 ;; The clock is running here
3828 t))))))
3831 "Check if the current buffer contains the running clock.
3832 If yes, offer to stop it and to save the buffer with the changes."
3841 "Check if this line starts a clock table, if yes, shift the time block."
3845 ;; Autoload org-timer.el
3849 "org-timer"
3851 org-timer-change-times-in-region
3852 org-timer-set-timer
3853 org-timer-reset-timers
3854 org-timer-show-remaining-time)))
3856 ;; Autoload org-feed.el
3860 "org-feed"
3864 ;; Autoload org-indent.el
3866 ;; Define the variable already here, to make sure we have it.
3868 "Non-nil if Org-Indent mode is enabled.
3873 "org-indent"
3876 ;; Autoload org-mobile.el
3880 "org-mobile"
3883 ;; Autoload archiving code
3884 ;; The stuff that is needed for cycling and tags has to be defined here.
3887 "Options concerning archiving in Org-mode."
3892 "The location where subtrees should be archived.
3894 The value of this variable is a string, consisting of two parts,
3895 separated by a double-colon. The first part is a filename and
3896 the second part is a headline.
3898 When the filename is omitted, archiving happens in the same file.
3899 %s in the filename will be replaced by the current file
3900 name (without the directory part). Archiving to a different file
3901 is useful to keep archived entries from contributing to the
3902 Org-mode Agenda.
3904 The archived entries will be filed as subtrees of the specified
3905 headline. When the headline is omitted, the subtrees are simply
3906 filed away at the end of the file, as top-level entries. Also in
3907 the heading you can use %s to represent the file name, this can be
3908 useful when using the same archive for a number of different files.
3910 Here are a few examples:
3912 If the current file is Projects.org, archive in file
3913 Projects.org_archive, as top-level trees. This is the default.
3916 Archive in the current file, under the top-level headline
3920 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3923 Archive in file ~/org/archive.org (absolute path), under headlines
3927 Archive in file ./basement (relative path), as level 3 trees
3930 You may set this option on a per-file basis by adding to the buffer a
3931 line like
3933 #+ARCHIVE: basement::** Finished Tasks
3935 You may also define it locally for a subtree by setting an ARCHIVE property
3936 in the entry. If such a property is found in an entry, or anywhere up
3937 the hierarchy, it will be used."
3942 "The tag that marks a subtree as archived.
3943 An archived subtree does not open during visibility cycling, and does
3944 not contribute to the agenda listings.
3945 After changing this, font-lock must be restarted in the relevant buffers to
3946 get the proper fontification."
3952 "Non-nil means the agenda will skip any items located in archived trees.
3953 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3954 variable is no longer recommended, you should leave it at the value t.
3955 Instead, use the key `v' to cycle the archives-mode in the agenda."
3961 "Non-nil means ignore archived trees when creating column view."
3967 "Non-nil means `org-cycle' will open archived trees.
3968 An archived tree is a tree marked with the tag ARCHIVE.
3969 When nil, archived trees will stay folded. You can still open them with
3970 normal outline commands like `show-all', but not with the cycling commands."
3976 "Non-nil means sparse tree construction shows matches in archived trees.
3977 When nil, matches in these trees are highlighted, but the trees are kept in
3978 collapsed state."
3984 "Re-hide all archived subtrees after a visibility state change."
3995 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
3998 "Cycle subtree even if it is archived."
4005 "Re-hide all archived subtrees after a visibility state change."
4020 flag)))
4027 org-archive-to-archive-sibling org-toggle-archive-tag
4028 org-archive-subtree-default
4029 org-archive-subtree-default-with-confirmation)))
4031 ;; Autoload Column View Code
4039 org-columns-compute org-agenda-columns org-columns-remove-overlays
4042 ;; Autoload ID code
4050 org-id-get-with-outline-path-completion
4051 org-id-get-with-outline-drilling org-id-store-link
4052 org-id-goto org-id-find org-id-store-link))
4054 ;; Autoload Plotting Code
4059 ;;; Variables for pre-computed regular expressions, all buffer local
4077 "Matches a headline and puts everything into groups:
4078 group 1: the stars
4079 group 2: The todo keyword, maybe
4080 group 3: Priority cookie
4081 group 4: True headline
4085 "Printf format to make regexp to match an exact headline.
4086 This regexp will match the headline of any node which hase the exact
4087 headline text that is put into the format, but may have any TODO state,
4091 "Matches a headline and puts TODO state into group 2 if present.
4146 "Regular expression to match a plain time or time range.
4147 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4148 groups carry important information:
4149 0 the full match
4150 1 the first time, range or not
4158 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4159 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4160 groups carry important information:
4161 0 the full match
4162 7 hours of duration
4171 "Regular expression to match a timestamp time or time range.
4172 After a match, the following groups carry important information:
4173 0 the full match
4174 1 date plus weekday, for back referencing to make sure both times are on the same day
4175 2 the first time, range or not
4230 "Variable associated with STARTUP options for org-mode.
4231 Each element is a list of three items: The startup options as written
4232 in the #+STARTUP line, the corresponding variable, and the value to
4233 set this variable to if the option is found. An optional forth element PUSH
4237 "Precompute regular expressions for current buffer."
4257 kwds kws0 kwsa key log value cat arch tags const links hw dws
4258 tail sep kws1 prio props ftags drawers beamer-p
4280 ;; general TODO-like setup
4292 links)))
4298 props)))
4303 ftags
4313 l var val)
4343 ))))
4360 ;; Process the TODO keywords
4362 ;; Use the global values as if they had been given locally.
4374 kws)))
4377 kwsa nil
4380 ;; 1 2
4388 kw)
4390 kws0)
4407 ;; Process the constants
4415 ;; Process the tags.
4426 tgs))
4434 ;; Compute the regular expressions and other local variables
4442 org-drawer-regexp
4446 org-not-done-keywords
4448 org-todo-regexp
4451 org-not-done-regexp
4455 org-not-done-heading-regexp
4459 org-todo-line-regexp
4463 org-complex-heading-regexp
4468 org-complex-heading-regexp-format
4477 org-nl-done-regexp
4481 org-todo-line-tags-regexp
4486 org-looking-at-done-regexp
4491 org-deadline-time-regexp
4493 org-deadline-line-regexp
4495 org-scheduled-regexp
4497 org-scheduled-time-regexp
4499 org-closed-time-regexp
4501 org-keyword-time-regexp
4507 org-keyword-time-not-clock-regexp
4513 org-maybe-keyword-time-regexp
4519 org-planning-or-clock-line-re
4524 org-all-time-keywords
4527 org-clock-string org-closed-string))
4528 )
4533 "Return the contents of FILE, as a string."
4547 "Extract the log state setting from a TODO keyword string.
4561 "Remove a pair of parenthesis at the end of each string in LIST."
4565 x))
4566 list))
4569 "Assign fast keys to a keyword-key alist.
4570 Respect keys that are already there."
4588 ;;; Some variables used in various places
4595 "Function to be called when `C-c C-c' is used.
4599 ;; FIXME: Occasionally check by commenting these, to make sure
4600 ;; no other functions uses these, forgetting to let-bind them.
4605 ;; Defined somewhere in this file, but used before definition.
4611 ;;;; Define the Org-mode
4614 (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"))
4617 ;; We use a before-change function to check if a table might need
4618 ;; an update.
4620 "Indicates that a table might need an update.
4621 This variable is set by `org-before-change-function'.
4624 "Every change indicates that a table might need an update."
4635 ;;;###autoload
4637 "Outline-based notes management and organizer, alias
4640 Org-mode develops organizational tasks around a NOTES file which
4641 contains information about projects as plain text. Org-mode is
4642 implemented on top of outline-mode, which is ideal to keep the content
4643 of large files well structured. It supports ToDo items, deadlines and
4644 time stamps, which magically appear in the diary listing of the Emacs
4645 calendar. Tables are easily created with a built-in table editor.
4646 Plain text URL-like links connect to websites, emails (VM), Usenet
4647 messages (Gnus), BBDB entries, and any files related to the project.
4648 For printing and sharing of notes, an Org-mode file (or a part of it)
4649 can be exported as a structured ASCII or HTML file.
4651 The following commands are available:
4655 ;; Get rid of Outline menus, they are not needed
4656 ;; Need to do this here because define-derived-mode sets up
4657 ;; the keymap so late. Still, it is a waste to call this each time
4658 ;; we switch another buffer into org-mode.
4661 ;; Assume this is Greg's port, it uses easymenu
4686 org-display-table 4
4689 org-ellipsis)))
4694 ;; tag faces set outside customize.... force initialization.
4696 ;; Calc embedded
4702 ;; Activate before-change-function
4706 ;; Check for running clock before killing a buffer
4708 ;; Paragraphs and auto-filling
4712 ;; Beginning/end of defun
4715 ;; Make sure dependence stuff works reliably, even for users who set it
4716 ;; too late :-(
4728 ;; Comment characters
4732 ;; Align options lines
4734 'align-mode-rules-list
4739 ;; Imenu
4743 ;; Make isearch reveal context
4746 ;; Emacs 21 and XEmacs make use of the hook
4748 ;; Emacs 22 deals with this through a special variable
4752 ;; Turn on org-beamer-mode?
4755 ;; Setup the pcomplete hooks
4766 ;; If empty file that did not turn on org-mode automatically, make it to.
4791 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4801 "Return today date, considering `org-extend-today-until'."
4806 ;;;; Font-Lock stuff, including the activators
4837 "Regular expression used to analyze links.
4838 Here is what the match groups contain after a match:
4839 1: http:
4840 2: http
4841 3: path
4842 4: [desc]
4850 "Number of stacked braces for sub/superscript matching.
4851 This has to be set before loading org.el to be effective."
4856 "Create a regular expression which will match a balanced sexp.
4857 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4858 as single character strings.
4859 The regexp returned will match the entire expression including the
4860 delimiters. It will also define a single group which contains the
4861 match except for the outermost delimiters. The maximum depth of
4862 stacked delimiters is N. Escaping delimiters is not possible."
4891 "Update the link regular expressions.
4892 This should be called after the variable `org-link-types' has changed."
4896 org-link-re-with-space
4902 org-link-re-with-space2
4908 org-link-re-with-space3
4913 org-angle-link-re
4919 org-plain-link-re
4923 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
4924 org-bracket-link-regexp
4926 org-bracket-link-analytic-regexp
4934 org-bracket-link-analytic-regexp++
4942 org-any-link-re
4953 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4954 "Regular expression matching time strings for analysis.
4955 This one does not require the space after the date, so it can be used
4957 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4973 "Regular expression matching a time stamp or time stamp range.
4979 "Run through the buffer and add overlays to links."
4988 'face
5001 rtn))
5004 "Insert or change an emphasis, i.e. a font like bold or italic.
5005 If there is an active region, change that region to a new emphasis.
5006 If there is no region, just insert the marker characters and position
5007 the cursor between them.
5008 CHAR should be either the marker character, or the first character of the
5009 HTML tag associated with that emphasis. If CHAR is a space, the means
5010 to remove the emphasis of the selected region.
5011 If char is not given (for example in an interactive call) it
5012 will be prompted for."
5063 "Run through the buffer and add overlays to links."
5072 nil
5078 t)))))
5086 t)))
5089 "When non-nil, fontify code in code blocks."
5095 "Fontify #+ lines and blocks, in the correct ways."
5098 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5099 limit t)
5107 end end1 quoting block-type)
5110 ;; a single line of backend-specific content
5118 ; for backend-specific code
5119 t)
5121 ;; Truly a block
5133 beg end
5137 ; for end_src
5143 org-block)))
5144 ; end of source block
5150 t))
5163 ;; just any other in-buffer setting, but not indented
5167 t)
5175 t)
5183 "Run through the buffer and add overlays to links."
5191 t)))
5194 "Run through the buffer and add overlays to links."
5196 limit t)
5201 'keymap org-mouse-map
5202 'help-echo
5204 "Footnote definition"
5206 ))
5208 t)))
5211 "Run through the buffer and add overlays to bracketed links."
5215 ;; FIXME: above we should remove the escapes.
5216 ;; but that requires another match, protecting match data,
5217 ;; a lot of overhead for font-lock.
5224 ;; We need to remove the invisible property here. Table narrowing
5225 ;; may have made some of this invisible.
5243 t)))
5246 "Run through the buffer and add overlays to dates."
5258 t)))
5267 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5271 "Run through the buffer and add overlays to target matches."
5279 'keymap org-mouse-map
5283 t)))))
5286 "Find all radio targets in this file and update the regular expression."
5301 t)))
5308 ;; This should be with the exporter code, but we also use if for font-locking
5318 "Compute regular expression for stuff treated specially by exporters."
5325 org-latex-regexps)))
5353 org-entities)))
5357 org-latex-entities)
5358 nil))
5360 ))
5361 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5364 org-export-html-special-string-regexps)))
5369 ))))
5371 'org-latex-and-specials-regexp
5376 "Run through the buffer and add overlays to links."
5380 limit t))
5394 rtn)))
5397 "Restart `font-lock-mode', to force refontification."
5403 "Return a list of all targets in this file.
5404 With optional argument RADIO, only find radio targets."
5406 rtn)
5411 rtn)))
5414 "Make regular expression matching all strings in TARGETS.
5415 The regular expression finds the targets also if there is a line break
5416 between words."
5424 x)
5425 targets
5437 t)))
5440 "Compute the outline level of the heading at point.
5441 This function assumes that the cursor is at the beginning of a line matched
5442 by `outline-regexp'. Otherwise it returns garbage.
5443 If this is called at a normal headline, the level is the number of stars.
5444 Use `org-reduced-level' to remove the effect of `org-odd-levels'.
5445 For plain list items, if they are matched by `outline-regexp', this returns
5446 1000 plus the line indentation."
5455 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5462 "Functions that can manipulate `org-font-lock-extra-keywords'.
5463 This is calles after `org-font-lock-extra-keywords' is defined, but before
5464 it is installed to be used by font lock. This can be useful if something
5475 ;; Call the hook
5477 ;; Headlines
5484 ;; Table lines
5487 ;; Table internals
5492 ;; Drawers
5495 ;; Properties
5499 ;; Links
5510 ;; TODO lines
5513 ;; DONE
5519 nil)
5520 ;; Priorities
5522 ;; Tags
5524 ;; Special keywords
5529 ;; Emphasis
5534 ;; Checkboxes
5535 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5540 ;; Description list items
5543 ;; ARCHIVEd headings
5546 ;; Specials
5550 ;; Code
5552 ;; COMMENT
5557 ;; Blocks and meta lines
5559 )))
5562 ;; Now set the full font-lock-keywords
5569 "Toggle the composition display of entities as UTF8 characters."
5581 "Find an entity to fontify."
5587 limit t)
5599 nil))))
5602 "Fontify string S like in Org-mode."
5614 "Get the right face for match N in font-lock matching of headlines."
5627 "Get the right face for a TODO keyword KWD.
5628 If KWD is a number, get the corresponding match group."
5636 "Create a face list that inherits INHERIT, but sets the foreground color.
5637 When FACE-OR-COLOR is not a string, just return it."
5641 face-or-color)
5642 face-or-color))
5645 "Add the special tag faces."
5654 "Add the special priority faces."
5661 org-priority-faces)))
5666 "Get the right face for a TODO keyword KWD.
5667 If KWD is a number, get the corresponding match group."
5674 "Remove fontification and activation overlays from links."
5679 deactivate-mark buffer-file-name buffer-file-truename)
5682 beg end
5684 ;; also remove line-prefix and wrap-prefix properties
5686 invisible t intangible t
5687 line-prefix t wrap-prefix t
5688 org-no-flyspell t org-emphasis t)
5690 invisible t intangible t
5691 org-no-flyspell t org-emphasis t)))
5701 "Remove specific display properties that have been added by font lock.
5702 The will remove the raise properties that are used to show superscripts
5703 and subscripts."
5713 "Add raise properties to sub/superscripts."
5717 org-match-substring-regexp
5718 org-match-substring-with-braces-regexp)
5719 limit t)
5729 ;; FIXME: Should we go back one character here, for a_b^c
5730 ;; (goto-char (1- pos)) ;????????????????????
5732 t
5734 'display
5750 t)))))
5752 ;;;; Visibility cycling, including org-goto and indirect buffer
5754 ;;; Cycling
5761 ;;;###autoload
5766 "TAB-action and visibility cycling for Org-mode.
5768 This is the command invoked in Org-mode by the TAB key. Its main purpose
5769 is outline visibility cycling, but it also invokes other actions
5770 in special contexts.
5772 - When this function is called with a prefix argument, rotate the entire
5773 buffer through 3 states (global cycling)
5774 1. OVERVIEW: Show only top-level headlines.
5775 2. CONTENTS: Show all headlines of all levels, but no body text.
5776 3. SHOW ALL: Show everything.
5777 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5778 determined by the variable `org-startup-folded', and by any VISIBILITY
5779 properties in the buffer.
5780 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5781 including any drawers.
5783 - When inside a table, re-align the table and move to the next field.
5785 - When point is at the beginning of a headline, rotate the subtree started
5786 by this line through 3 different states (local cycling)
5787 1. FOLDED: Only the main headline is shown.
5788 2. CHILDREN: The main headline and the direct children are shown.
5789 From this state, you can move to one of the children
5790 and zoom in further.
5791 3. SUBTREE: Show the entire subtree, including body text.
5792 If there is no subtree, switch directly from CHILDREN to FOLDED.
5794 - When point is at the beginning of an empty headline and the variable
5795 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5796 of the headline by demoting and promoting it to likely levels. This
5797 speeds up creation document structure by pressing TAB once or several
5798 times right after creating a new headline.
5800 - When there is a numeric prefix, go up to a heading with level ARG, do
5801 a `show-subtree' and return to the previous cursor position. If ARG
5802 is negative, go up that many levels.
5804 - When point is not at the beginning of a headline, execute the global
5805 binding for TAB, which is re-indenting the line. See the option
5806 `org-cycle-emulate-tab' for details.
5808 - Special case: if point is at the beginning of the buffer and there is
5809 no headline in line 1, this function will act as if called with prefix arg
5810 (C-u TAB, same as S-TAB) also when called without prefix arg.
5811 But only if also the variable `org-cycle-global-at-bob' is t."
5821 org-inlinetask-min-level
5826 limit-level)))
5842 org-cycle-hook))
5846 ;; special case: use global cycling
5861 ;; Enter the table or move to the next field in the table
5878 ;; Toggle block visibility
5883 ;; Show-subtree, ARG levels up from here.
5895 ;; TAB emulation and template completion
5919 t
5928 "Do the global cycling action."
5932 ;; We just created the overview - now do table of contents
5933 ;; This can be slow in very large buffers, so indicate action
5943 ;; We just showed the table of contents - now show everything
5951 ;; Default action: go to overview
5959 "Do the local cycling action."
5961 ;; First, some boundaries
5968 ; XEmacs does not have `next-single-char-property-change'
5969 ; I'm not sure about Emacs 21.
5983 ;; if we're in a list, org-end-of-subtree is in fact org-end-of-item.
5992 ;; Find out what to do next and set `this-command'
5995 ;; Nothing is hidden behind this heading
6007 org-cycle-skip-children-state-if-no-children))))
6008 ;; Entire subtree is hidden in one line: children view
6022 ;; We just showed the children, or no children are there,
6023 ;; now show everything.
6030 ;; Default action: hide the subtree.
6037 ;;;###autoload
6039 "Cycle the global visibility. For details see `org-cycle'.
6041 With a numeric prefix, show all headlines up to that level."
6057 "Set the visibility required by startup options and properties."
6072 "Switch subtree visibilities according to :VISIBILITY: property."
6079 nil t)
6104 "Switch to overview mode, showing only top-level headlines.
6105 Really, this shows all headlines with level equal or greater than the level
6106 of the first headline in the buffer. This is important, because if the
6107 first headline is not level one, then (hide-sublevels 1) gives confusing
6108 results."
6119 "Show all headlines in the buffer, like a table of contents.
6120 With numerical argument N, show content up to level N."
6123 ;; Visit all headings and show their offspring
6130 t)
6139 "Adjust the window after a change in outline visibility.
6140 This function is the default value of the hook `org-cycle-hook'."
6150 "Remove outline overlays that do not contain non-white stuff."
6160 "Fix visibility issues after moving a subtree."
6161 ;; First, find a reasonable region to look at:
6162 ;; Start two siblings above, end three below
6180 ;; Properly fold already folded siblings
6191 "Show empty lines above all visible headlines.
6192 The region to be covered depends on STATE when called through
6193 `org-cycle-hook'. Lisp program can use t for STATE to get the
6194 entire buffer covered. Note that an empty line is only shown if there
6195 are at least `org-cycle-separator-lines' empty lines before the headline."
6205 beg end b e)
6229 ;; Never hide empty lines at the end of the file.
6239 "Move to the parent and re-show empty lines before visible headlines."
6245 "Return `org-agenda-files' list, plus all open org-mode files.
6246 This is useful for operations that need to scan all of a user's
6247 open and agenda-wise Org files."
6255 files))
6258 "Return the beginning position of the current entry."
6262 "Return the end position of the current entry."
6266 "Re-hide all drawers after a visibility state change."
6293 "Is the end of the current subtree visible?"
6298 "Move cursor to the first headline and recenter the headline.
6299 Optional argument N means put the headline into the Nth line of the window."
6305 ;;; Saving and restoring visibility
6308 "Return a list of the locations of all outline overlays.
6309 These are overlays with the `invisible' property value `outline'.
6310 The return value is a list of cons cells, with start and stop
6311 positions for each overlay.
6312 If USE-MARKERS is set, return the positions as markers."
6330 "Create visibility overlays for all positions in DATA.
6331 DATA should have been made by `org-outline-overlay-data'."
6340 data)))))
6342 ;;; Folding of blocks
6354 "Call FUNCTION at the head of all source blocks in the current buffer.
6355 Optional arguments START and END can be used to limit the range."
6367 "Toggle the visibility of all blocks in the current buffer."
6371 "Fold all blocks in the current buffer."
6377 "Unfold all blocks in the current buffer."
6383 "Toggle visibility of block at point."
6394 "Toggle the visibility of the current block."
6401 ov)
6417 ;; make the block accessible to isearch
6419 ov 'isearch-open-invisible
6430 ;; org-tab-after-check-for-cycling-hook
6432 ;; Remove overlays when changing major mode
6437 ;;; Org-goto
6443 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6459 nil)
6460 (org-defkey map "q" 'org-goto-quit)
6461 (org-defkey map "n" 'outline-next-visible-heading)
6462 (org-defkey map "p" 'outline-previous-visible-heading)
6463 (org-defkey map "f" 'outline-forward-same-level)
6464 (org-defkey map "b" 'outline-backward-same-level)
6465 (org-defkey map "u" 'outline-up-heading))
6466 (org-defkey map "/" 'org-occur)
6467 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6468 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6469 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6470 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6471 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6472 map))
6474 (defconst org-goto-help
6475 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6476 RET=jump to location [Q]uit and return to previous location
6477 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6479 (defvar org-goto-start-pos) ; dynamically scoped parameter
6481 ;; FIXME: Docstring does not mention both interfaces
6482 (defun org-goto (&optional alternative-interface)
6483 "Look up a different location in the current file, keeping current visibility.
6485 When you want look-up or go to a different location in a document, the
6486 fastest way is often to fold the entire buffer and then dive into the tree.
6487 This method has the disadvantage, that the previous location will be folded,
6488 which may not be what you want.
6490 This command works around this by showing a copy of the current buffer
6491 in an indirect buffer, in overview mode. You can dive into the tree in
6492 that copy, use org-occur and incremental search to find a location.
6493 When pressing RET or `Q', the command returns to the original buffer in
6494 which the visibility is still unchanged. After RET is will also jump to
6495 the location selected in the indirect buffer and expose the
6496 the headline hierarchy above."
6497 (interactive "P")
6498 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6499 (org-refile-use-outline-path t)
6500 (org-refile-target-verify-function nil)
6501 (interface
6502 (if (not alternative-interface)
6503 org-goto-interface
6504 (if (eq org-goto-interface 'outline)
6505 'outline-path-completion
6506 'outline)))
6507 (org-goto-start-pos (point))
6508 (selected-point
6509 (if (eq interface 'outline)
6510 (car (org-get-location (current-buffer) org-goto-help))
6511 (let ((pa (org-refile-get-location "Goto: ")))
6512 (org-refile-check-position pa)
6513 (nth 3 pa)))))
6514 (if selected-point
6515 (progn
6516 (org-mark-ring-push org-goto-start-pos)
6517 (goto-char selected-point)
6518 (if (or (org-invisible-p) (org-invisible-p2))
6519 (org-show-context 'org-goto)))
6520 (message "Quit"))))
6522 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6523 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6524 (defvar org-goto-local-auto-isearch-map) ; defined below
6526 (defun org-get-location (buf help)
6527 "Let the user select a location in the Org-mode buffer BUF.
6528 This function uses a recursive edit. It returns the selected position
6529 or nil."
6530 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6531 (isearch-hide-immediately nil)
6532 (isearch-search-fun-function
6533 (lambda () 'org-goto-local-search-headings))
6534 (org-goto-selected-point org-goto-exit-command)
6535 (pop-up-frames nil)
6536 (special-display-buffer-names nil)
6537 (special-display-regexps nil)
6538 (special-display-function nil))
6539 (save-excursion
6540 (save-window-excursion
6541 (delete-other-windows)
6542 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6543 (switch-to-buffer
6544 (condition-case nil
6545 (make-indirect-buffer (current-buffer) "*org-goto*")
6546 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6547 (with-output-to-temp-buffer "*Help*"
6548 (princ help))
6549 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6550 (setq buffer-read-only nil)
6551 (let ((org-startup-truncated t)
6552 (org-startup-folded nil)
6553 (org-startup-align-all-tables nil))
6554 (org-mode)
6555 (org-overview))
6556 (setq buffer-read-only t)
6557 (if (and (boundp 'org-goto-start-pos)
6558 (integer-or-marker-p org-goto-start-pos))
6559 (let ((org-show-hierarchy-above t)
6560 (org-show-siblings t)
6561 (org-show-following-heading t))
6562 (goto-char org-goto-start-pos)
6563 (and (org-invisible-p) (org-show-context)))
6564 (goto-char (point-min)))
6565 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6566 (message "Select location and press RET")
6567 (use-local-map org-goto-map)
6568 (recursive-edit)
6569 ))
6570 (kill-buffer "*org-goto*")
6571 (cons org-goto-selected-point org-goto-exit-command)))
6573 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6574 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6575 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6576 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6578 (defun org-goto-local-search-headings (string bound noerror)
6579 "Search and make sure that any matches are in headlines."
6580 (catch 'return
6581 (while (if isearch-forward
6582 (search-forward string bound noerror)
6583 (search-backward string bound noerror))
6584 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6585 (and (member :headline context)
6586 (not (member :tags context))))
6587 (throw 'return (point))))))
6589 (defun org-goto-local-auto-isearch ()
6590 "Start isearch."
6591 (interactive)
6592 (goto-char (point-min))
6593 (let ((keys (this-command-keys)))
6594 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6595 (isearch-mode t)
6596 (isearch-process-search-char (string-to-char keys)))))
6598 (defun org-goto-ret (&optional arg)
6599 "Finish `org-goto' by going to the new location."
6600 (interactive "P")
6601 (setq org-goto-selected-point (point)
6602 org-goto-exit-command 'return)
6603 (throw 'exit nil))
6605 (defun org-goto-left ()
6606 "Finish `org-goto' by going to the new location."
6607 (interactive)
6608 (if (org-on-heading-p)
6609 (progn
6610 (beginning-of-line 1)
6611 (setq org-goto-selected-point (point)
6612 org-goto-exit-command 'left)
6613 (throw 'exit nil))
6614 (error "Not on a heading")))
6616 (defun org-goto-right ()
6617 "Finish `org-goto' by going to the new location."
6618 (interactive)
6619 (if (org-on-heading-p)
6620 (progn
6621 (setq org-goto-selected-point (point)
6622 org-goto-exit-command 'right)
6623 (throw 'exit nil))
6624 (error "Not on a heading")))
6626 (defun org-goto-quit ()
6627 "Finish `org-goto' without cursor motion."
6628 (interactive)
6629 (setq org-goto-selected-point nil)
6630 (setq org-goto-exit-command 'quit)
6631 (throw 'exit nil))
6633 ;;; Indirect buffer display of subtrees
6635 (defvar org-indirect-dedicated-frame nil
6636 "This is the frame being used for indirect tree display.")
6637 (defvar org-last-indirect-buffer nil)
6639 (defun org-tree-to-indirect-buffer (&optional arg)
6640 "Create indirect buffer and narrow it to current subtree.
6641 With numerical prefix ARG, go up to this level and then take that tree.
6642 If ARG is negative, go up that many levels.
6643 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6644 indirect buffer previously made with this command, to avoid proliferation of
6645 indirect buffers. However, when you call the command with a \
6647 when `org-indirect-buffer-display' is `new-frame', the last buffer
6648 is kept so that you can work with several indirect buffers at the same time.
6649 If `org-indirect-buffer-display' is `dedicated-frame', the \
6651 requests that a new frame be made for the new buffer, so that the dedicated
6652 frame is not changed."
6653 (interactive "P")
6654 (let ((cbuf (current-buffer))
6655 (cwin (selected-window))
6656 (pos (point))
6657 beg end level heading ibuf)
6658 (save-excursion
6659 (org-back-to-heading t)
6660 (when (numberp arg)
6661 (setq level (org-outline-level))
6662 (if (< arg 0) (setq arg (+ level arg)))
6663 (while (> (setq level (org-outline-level)) arg)
6664 (outline-up-heading 1 t)))
6665 (setq beg (point)
6666 heading (org-get-heading))
6667 (org-end-of-subtree t t)
6668 (if (org-on-heading-p) (backward-char 1))
6669 (setq end (point)))
6670 (if (and (buffer-live-p org-last-indirect-buffer)
6671 (not (eq org-indirect-buffer-display 'new-frame))
6672 (not arg))
6673 (kill-buffer org-last-indirect-buffer))
6674 (setq ibuf (org-get-indirect-buffer cbuf)
6675 org-last-indirect-buffer ibuf)
6676 (cond
6677 ((or (eq org-indirect-buffer-display 'new-frame)
6678 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6679 (select-frame (make-frame))
6680 (delete-other-windows)
6681 (switch-to-buffer ibuf)
6682 (org-set-frame-title heading))
6683 ((eq org-indirect-buffer-display 'dedicated-frame)
6684 (raise-frame
6685 (select-frame (or (and org-indirect-dedicated-frame
6686 (frame-live-p org-indirect-dedicated-frame)
6687 org-indirect-dedicated-frame)
6688 (setq org-indirect-dedicated-frame (make-frame)))))
6689 (delete-other-windows)
6690 (switch-to-buffer ibuf)
6691 (org-set-frame-title (concat "Indirect: " heading)))
6692 ((eq org-indirect-buffer-display 'current-window)
6693 (switch-to-buffer ibuf))
6694 ((eq org-indirect-buffer-display 'other-window)
6695 (pop-to-buffer ibuf))
6696 (t (error "Invalid value")))
6697 (if (featurep 'xemacs)
6698 (save-excursion (org-mode) (turn-on-font-lock)))
6699 (narrow-to-region beg end)
6700 (show-all)
6701 (goto-char pos)
6702 (and (window-live-p cwin) (select-window cwin))))
6704 (defun org-get-indirect-buffer (&optional buffer)
6705 (setq buffer (or buffer (current-buffer)))
6706 (let ((n 1) (base (buffer-name buffer)) bname)
6707 (while (buffer-live-p
6708 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6709 (setq n (1+ n)))
6710 (condition-case nil
6711 (make-indirect-buffer buffer bname 'clone)
6712 (error (make-indirect-buffer buffer bname)))))
6714 (defun org-set-frame-title (title)
6715 "Set the title of the current frame to the string TITLE."
6716 ;; FIXME: how to name a single frame in XEmacs???
6717 (unless (featurep 'xemacs)
6718 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6720 ;;;; Structure editing
6722 ;;; Inserting headlines
6724 (defun org-previous-line-empty-p ()
6725 (save-excursion
6726 (and (not (bobp))
6727 (or (beginning-of-line 0) t)
6728 (save-match-data
6731 (defun org-insert-heading (&optional force-heading invisible-ok)
6732 "Insert a new heading or item with same depth at point.
6733 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6734 If point is at the beginning of a headline, insert a sibling before the
6735 current headline. If point is not at the beginning, split the line,
6736 create the new headline with the text in the current line after point
6737 \(but see also the variable `org-M-RET-may-split-line').
6739 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6740 This is important for non-interactive uses of the command."
6741 (interactive "P")
6742 (if (or (= (buffer-size) 0)
6743 (and (not (save-excursion
6744 (and (ignore-errors (org-back-to-heading invisible-ok))
6745 (org-on-heading-p))))
6746 (not (org-in-item-p))))
6747 (progn
6749 (run-hooks 'org-insert-heading-hook))
6750 (when (or force-heading (not (org-insert-item)))
6751 (let* ((empty-line-p nil)
6752 (level nil)
6753 (on-heading (org-on-heading-p))
6754 (head (save-excursion
6755 (condition-case nil
6756 (progn
6757 (org-back-to-heading invisible-ok)
6758 (when (and (not on-heading)
6759 (featurep 'org-inlinetask)
6760 (integerp org-inlinetask-min-level)
6761 (>= (length (match-string 0))
6762 org-inlinetask-min-level))
6763 ;; Find a heading level before the inline task
6764 (while (and (setq level (org-up-heading-safe))
6765 (>= level org-inlinetask-min-level)))
6766 (if (org-on-heading-p)
6767 (org-back-to-heading invisible-ok)
6768 (error "This should not happen")))
6769 (setq empty-line-p (org-previous-line-empty-p))
6770 (match-string 0))
6771 (error "*"))))
6772 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6773 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6774 pos hide-previous previous-pos)
6775 (cond
6776 ((and (org-on-heading-p) (bolp)
6777 (or (bobp)
6778 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6779 ;; insert before the current line
6780 (open-line (if blank 2 1)))
6781 ((and (bolp)
6782 (not org-insert-heading-respect-content)
6783 (or (bobp)
6784 (save-excursion
6785 (backward-char 1) (not (org-invisible-p)))))
6786 ;; insert right here
6787 nil)
6788 (t
6789 ;; somewhere in the line
6790 (save-excursion
6791 (setq previous-pos (point-at-bol))
6792 (end-of-line)
6793 (setq hide-previous (org-invisible-p)))
6794 (and org-insert-heading-respect-content (org-show-subtree))
6795 (let ((split
6796 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6797 (save-excursion
6798 (let ((p (point)))
6799 (goto-char (point-at-bol))
6800 (and (looking-at org-complex-heading-regexp)
6801 (> p (match-beginning 4)))))))
6802 tags pos)
6803 (cond
6804 (org-insert-heading-respect-content
6805 (org-end-of-subtree nil t)
6806 (when (featurep 'org-inlinetask)
6807 (while (and (not (eobp))
6809 (>= (length (match-string 1))
6810 org-inlinetask-min-level))
6811 (org-end-of-subtree nil t)))
6812 (or (bolp) (newline))
6813 (or (org-previous-line-empty-p)
6814 (and blank (newline)))
6815 (open-line 1))
6816 ((org-on-heading-p)
6817 (when hide-previous
6818 (show-children)
6819 (org-show-entry))
6821 (setq tags (and (match-end 2) (match-string 2)))
6822 (and (match-end 1)
6823 (delete-region (match-beginning 1) (match-end 1)))
6824 (setq pos (point-at-bol))
6825 (or split (end-of-line 1))
6826 (delete-horizontal-space)
6828 (buffer-substring (point-at-bol) (point)))
6829 (insert " "))
6830 (newline (if blank 2 1))
6831 (when tags
6832 (save-excursion
6833 (goto-char pos)
6834 (end-of-line 1)
6835 (insert " " tags)
6836 (org-set-tags nil 'align))))
6837 (t
6838 (or split (end-of-line 1))
6839 (newline (if blank 2 1)))))))
6840 (insert head) (just-one-space)
6841 (setq pos (point))
6842 (end-of-line 1)
6843 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6844 (when (and org-insert-heading-respect-content hide-previous)
6845 (save-excursion
6846 (goto-char previous-pos)
6847 (hide-subtree)))
6848 (run-hooks 'org-insert-heading-hook)))))
6850 (defun org-get-heading (&optional no-tags)
6851 "Return the heading of the current entry, without the stars."
6852 (save-excursion
6853 (org-back-to-heading t)
6854 (if (looking-at
6855 (if no-tags
6858 (match-string 1) "")))
6860 (defun org-heading-components ()
6861 "Return the components of the current heading.
6862 This is a list with the following elements:
6863 - the level as an integer
6864 - the reduced level, different if `org-odd-levels-only' is set.
6865 - the TODO keyword, or nil
6866 - the priority character, like ?A, or nil if no priority is given
6867 - the headline text itself, or the tags string if no headline text
6868 - the tags string, or nil."
6869 (save-excursion
6870 (org-back-to-heading t)
6871 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6872 (list (length (match-string 1))
6873 (org-reduced-level (length (match-string 1)))
6874 (org-match-string-no-properties 2)
6875 (and (match-end 3) (aref (match-string 3) 2))
6876 (org-match-string-no-properties 4)
6877 (org-match-string-no-properties 5)))))
6879 (defun org-get-entry ()
6880 "Get the entry text, after heading, entire subtree."
6881 (save-excursion
6882 (org-back-to-heading t)
6883 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6885 (defun org-insert-heading-after-current ()
6886 "Insert a new heading with same level as current, after current subtree."
6887 (interactive)
6888 (org-back-to-heading)
6889 (org-insert-heading)
6890 (org-move-subtree-down)
6891 (end-of-line 1))
6893 (defun org-insert-heading-respect-content ()
6894 (interactive)
6895 (let ((org-insert-heading-respect-content t))
6896 (org-insert-heading t)))
6898 (defun org-insert-todo-heading-respect-content (&optional force-state)
6899 (interactive "P")
6900 (let ((org-insert-heading-respect-content t))
6901 (org-insert-todo-heading force-state t)))
6903 (defun org-insert-todo-heading (arg &optional force-heading)
6904 "Insert a new heading with the same level and TODO state as current heading.
6905 If the heading has no TODO state, or if the state is DONE, use the first
6906 state (TODO by default). Also with prefix arg, force first state."
6907 (interactive "P")
6908 (when (or force-heading (not (org-insert-item 'checkbox)))
6909 (org-insert-heading force-heading)
6910 (save-excursion
6911 (org-back-to-heading)
6912 (outline-previous-heading)
6913 (looking-at org-todo-line-regexp))
6914 (let*
6915 ((new-mark-x
6916 (if (or arg
6917 (not (match-beginning 2))
6918 (member (match-string 2) org-done-keywords))
6919 (car org-todo-keywords-1)
6920 (match-string 2)))
6921 (new-mark
6922 (or
6923 (run-hook-with-args-until-success
6924 'org-todo-get-default-hook new-mark-x nil)
6925 new-mark-x)))
6926 (beginning-of-line 1)
6928 (if org-treat-insert-todo-heading-as-state-change
6929 (org-todo new-mark)
6930 (insert new-mark " "))))
6931 (when org-provide-todo-statistics
6932 (org-update-parent-todo-statistics))))
6934 (defun org-insert-subheading (arg)
6935 "Insert a new subheading and demote it.
6936 Works for outline headings and for plain lists alike."
6937 (interactive "P")
6938 (org-insert-heading arg)
6939 (cond
6940 ((org-on-heading-p) (org-do-demote))
6941 ((org-at-item-p) (org-indent-item))))
6943 (defun org-insert-todo-subheading (arg)
6944 "Insert a new subheading with TODO keyword or checkbox and demote it.
6945 Works for outline headings and for plain lists alike."
6946 (interactive "P")
6947 (org-insert-todo-heading arg)
6948 (cond
6949 ((org-on-heading-p) (org-do-demote))
6950 ((org-at-item-p) (org-indent-item))))
6952 ;;; Promotion and Demotion
6954 (defvar org-after-demote-entry-hook nil
6955 "Hook run after an entry has been demoted.
6956 The cursor will be at the beginning of the entry.
6957 When a subtree is being demoted, the hook will be called for each node.")
6959 (defvar org-after-promote-entry-hook nil
6960 "Hook run after an entry has been promoted.
6961 The cursor will be at the beginning of the entry.
6962 When a subtree is being promoted, the hook will be called for each node.")
6964 (defun org-promote-subtree ()
6965 "Promote the entire subtree.
6966 See also `org-promote'."
6967 (interactive)
6968 (save-excursion
6969 (org-map-tree 'org-promote))
6970 (org-fix-position-after-promote))
6972 (defun org-demote-subtree ()
6973 "Demote the entire subtree. See `org-demote'.
6974 See also `org-promote'."
6975 (interactive)
6976 (save-excursion
6977 (org-map-tree 'org-demote))
6978 (org-fix-position-after-promote))
6981 (defun org-do-promote ()
6982 "Promote the current heading higher up the tree.
6983 If the region is active in `transient-mark-mode', promote all headings
6984 in the region."
6985 (interactive)
6986 (save-excursion
6987 (if (org-region-active-p)
6988 (org-map-region 'org-promote (region-beginning) (region-end))
6989 (org-promote)))
6990 (org-fix-position-after-promote))
6992 (defun org-do-demote ()
6993 "Demote the current heading lower down the tree.
6994 If the region is active in `transient-mark-mode', demote all headings
6995 in the region."
6996 (interactive)
6997 (save-excursion
6998 (if (org-region-active-p)
6999 (org-map-region 'org-demote (region-beginning) (region-end))
7000 (org-demote)))
7001 (org-fix-position-after-promote))
7003 (defun org-fix-position-after-promote ()
7004 "Make sure that after pro/demotion cursor position is right."
7005 (let ((pos (point)))
7006 (when (save-excursion
7007 (beginning-of-line 1)
7008 (looking-at org-todo-line-regexp)
7009 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7010 (cond ((eobp) (insert " "))
7011 ((eolp) (insert " "))
7012 ((equal (char-after) ?\ ) (forward-char 1))))))
7014 (defun org-current-level ()
7015 "Return the level of the current entry, or nil if before the first headline.
7016 The level is the number of stars at the beginning of the headline."
7017 (save-excursion
7018 (condition-case nil
7019 (progn
7020 (org-back-to-heading t)
7021 (funcall outline-level))
7022 (error nil))))
7024 (defun org-get-previous-line-level ()
7025 "Return the outline depth of the last headline before the current line.
7026 Returns 0 for the first headline in the buffer, and nil if before the
7027 first headline."
7028 (let ((current-level (org-current-level))
7029 (prev-level (when (> (line-number-at-pos) 1)
7030 (save-excursion
7031 (beginning-of-line 0)
7032 (org-current-level)))))
7033 (cond ((null current-level) nil) ; Before first headline
7034 ((null prev-level) 0) ; At first headline
7035 (prev-level))))
7037 (defun org-reduced-level (l)
7038 "Compute the effective level of a heading.
7039 This takes into account the setting of `org-odd-levels-only'."
7040 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
7042 (defun org-level-increment ()
7043 "Return the number of stars that will be added or removed at a
7044 time to headlines when structure editing, based on the value of
7045 `org-odd-levels-only'."
7046 (if org-odd-levels-only 2 1))
7048 (defun org-get-valid-level (level &optional change)
7049 "Rectify a level change under the influence of `org-odd-levels-only'
7050 LEVEL is a current level, CHANGE is by how much the level should be
7051 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7052 even level numbers will become the next higher odd number."
7053 (if org-odd-levels-only
7054 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7055 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7056 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7057 (max 1 (+ level (or change 0)))))
7059 (if (boundp 'define-obsolete-function-alias)
7060 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7061 (define-obsolete-function-alias 'org-get-legal-level
7062 'org-get-valid-level)
7063 (define-obsolete-function-alias 'org-get-legal-level
7064 'org-get-valid-level "23.1")))
7066 (defun org-promote ()
7067 "Promote the current heading higher up the tree.
7068 If the region is active in `transient-mark-mode', promote all headings
7069 in the region."
7070 (org-back-to-heading t)
7071 (let* ((level (save-match-data (funcall outline-level)))
7072 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7073 (diff (abs (- level (length up-head) -1))))
7074 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7075 (replace-match up-head nil t)
7076 ;; Fixup tag positioning
7077 (and org-auto-align-tags (org-set-tags nil t))
7078 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7079 (run-hooks 'org-after-promote-entry-hook)))
7081 (defun org-demote ()
7082 "Demote the current heading lower down the tree.
7083 If the region is active in `transient-mark-mode', demote all headings
7084 in the region."
7085 (org-back-to-heading t)
7086 (let* ((level (save-match-data (funcall outline-level)))
7087 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7088 (diff (abs (- level (length down-head) -1))))
7089 (replace-match down-head nil t)
7090 ;; Fixup tag positioning
7091 (and org-auto-align-tags (org-set-tags nil t))
7092 (if org-adapt-indentation (org-fixup-indentation diff))
7093 (run-hooks 'org-after-demote-entry-hook)))
7095 (defun org-cycle-level ()
7096 "Cycle the level of an empty headline through possible states.
7097 This goes first to child, then to parent, level, then up the hierarchy.
7098 After top level, it switches back to sibling level."
7099 (interactive)
7100 (let ((org-adapt-indentation nil))
7101 (when (org-point-at-end-of-empty-headline)
7102 (setq this-command 'org-cycle-level) ; Only needed for caching
7103 (let ((cur-level (org-current-level))
7104 (prev-level (org-get-previous-line-level)))
7105 (cond
7106 ;; If first headline in file, promote to top-level.
7107 ((= prev-level 0)
7108 (loop repeat (/ (- cur-level 1) (org-level-increment))
7109 do (org-do-promote)))
7110 ;; If same level as prev, demote one.
7111 ((= prev-level cur-level)
7112 (org-do-demote))
7113 ;; If parent is top-level, promote to top level if not already.
7114 ((= prev-level 1)
7115 (loop repeat (/ (- cur-level 1) (org-level-increment))
7116 do (org-do-promote)))
7117 ;; If top-level, return to prev-level.
7118 ((= cur-level 1)
7119 (loop repeat (/ (- prev-level 1) (org-level-increment))
7120 do (org-do-demote)))
7121 ;; If less than prev-level, promote one.
7122 ((< cur-level prev-level)
7123 (org-do-promote))
7124 ;; If deeper than prev-level, promote until higher than
7125 ;; prev-level.
7126 ((> cur-level prev-level)
7127 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7128 do (org-do-promote))))
7129 t))))
7131 (defun org-map-tree (fun)
7132 "Call FUN for every heading underneath the current one."
7133 (org-back-to-heading)
7134 (let ((level (funcall outline-level)))
7135 (save-excursion
7136 (funcall fun)
7137 (while (and (progn
7138 (outline-next-heading)
7139 (> (funcall outline-level) level))
7140 (not (eobp)))
7141 (funcall fun)))))
7143 (defun org-map-region (fun beg end)
7144 "Call FUN for every heading between BEG and END."
7145 (let ((org-ignore-region t))
7146 (save-excursion
7147 (setq end (copy-marker end))
7148 (goto-char beg)
7149 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
7150 (< (point) end))
7151 (funcall fun))
7152 (while (and (progn
7153 (outline-next-heading)
7154 (< (point) end))
7155 (not (eobp)))
7156 (funcall fun)))))
7158 (defun org-fixup-indentation (diff)
7159 "Change the indentation in the current entry by DIFF.
7160 However, if any line in the current entry has no indentation, or if it
7161 would end up with no indentation after the change, nothing at all is done."
7162 (save-excursion
7163 (let ((end (save-excursion (outline-next-heading)
7164 (point-marker)))
7165 (prohibit (if (> diff 0)
7168 col)
7169 (unless (save-excursion (end-of-line 1)
7170 (re-search-forward prohibit end t))
7171 (while (and (< (point) end)
7173 (goto-char (match-end 0))
7174 (setq col (current-column))
7175 (if (< diff 0) (replace-match ""))
7176 (org-indent-to-column (+ diff col))))
7177 (move-marker end nil))))
7179 (defun org-convert-to-odd-levels ()
7180 "Convert an org-mode file with all levels allowed to one with odd levels.
7181 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7182 level 5 etc."
7183 (interactive)
7184 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7185 (let ((outline-regexp org-outline-regexp)
7186 (outline-level 'org-outline-level)
7187 (org-odd-levels-only nil) n)
7188 (save-excursion
7189 (goto-char (point-min))
7191 (setq n (- (length (match-string 0)) 2))
7192 (while (>= (setq n (1- n)) 0)
7193 (org-demote))
7194 (end-of-line 1))))))
7196 (defun org-convert-to-oddeven-levels ()
7197 "Convert an org-mode file with only odd levels to one with odd/even levels.
7198 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7199 file contains a section with an even level, conversion would
7200 destroy the structure of the file. An error is signaled in this
7201 case."
7202 (interactive)
7203 (goto-char (point-min))
7204 ;; First check if there are no even levels
7206 (org-show-context t)
7207 (error "Not all levels are odd in this file. Conversion not possible"))
7208 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7209 (let ((outline-regexp org-outline-regexp)
7210 (outline-level 'org-outline-level)
7211 (org-odd-levels-only nil) n)
7212 (save-excursion
7213 (goto-char (point-min))
7215 (setq n (/ (1- (length (match-string 0))) 2))
7216 (while (>= (setq n (1- n)) 0)
7217 (org-promote))
7218 (end-of-line 1))))))
7220 (defun org-tr-level (n)
7221 "Make N odd if required."
7222 (if org-odd-levels-only (1+ (/ n 2)) n))
7224 ;;; Vertical tree motion, cutting and pasting of subtrees
7226 (defun org-move-subtree-up (&optional arg)
7227 "Move the current subtree up past ARG headlines of the same level."
7228 (interactive "p")
7229 (org-move-subtree-down (- (prefix-numeric-value arg))))
7231 (defun org-move-subtree-down (&optional arg)
7232 "Move the current subtree down past ARG headlines of the same level."
7233 (interactive "p")
7234 (setq arg (prefix-numeric-value arg))
7235 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7236 'org-get-last-sibling))
7237 (ins-point (make-marker))
7238 (cnt (abs arg))
7239 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7240 ;; Select the tree
7241 (org-back-to-heading)
7242 (setq beg0 (point))
7243 (save-excursion
7244 (setq ne-beg (org-back-over-empty-lines))
7245 (setq beg (point)))
7246 (save-match-data
7247 (save-excursion (outline-end-of-heading)
7248 (setq folded (org-invisible-p)))
7249 (outline-end-of-subtree))
7250 (outline-next-heading)
7251 (setq ne-end (org-back-over-empty-lines))
7252 (setq end (point))
7253 (goto-char beg0)
7254 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7255 ;; include less whitespace
7256 (save-excursion
7257 (goto-char beg)
7258 (forward-line (- ne-beg ne-end))
7259 (setq beg (point))))
7260 ;; Find insertion point, with error handling
7261 (while (> cnt 0)
7262 (or (and (funcall movfunc) (looking-at outline-regexp))
7263 (progn (goto-char beg0)
7264 (error "Cannot move past superior level or buffer limit")))
7265 (setq cnt (1- cnt)))
7266 (if (> arg 0)
7267 ;; Moving forward - still need to move over subtree
7268 (progn (org-end-of-subtree t t)
7269 (save-excursion
7270 (org-back-over-empty-lines)
7271 (or (bolp) (newline)))))
7272 (setq ne-ins (org-back-over-empty-lines))
7273 (move-marker ins-point (point))
7274 (setq txt (buffer-substring beg end))
7275 (org-save-markers-in-region beg end)
7276 (delete-region beg end)
7277 (org-remove-empty-overlays-at beg)
7278 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7279 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7281 (let ((bbb (point)))
7282 (insert-before-markers txt)
7283 (org-reinstall-markers-in-region bbb)
7284 (move-marker ins-point bbb))
7286 (setq ins-end (point))
7287 (goto-char ins-point)
7288 (org-skip-whitespace)
7289 (when (and (< arg 0)
7290 (org-first-sibling-p)
7291 (> ne-ins ne-beg))
7292 ;; Move whitespace back to beginning
7293 (save-excursion
7294 (goto-char ins-end)
7295 (let ((kill-whole-line t))
7296 (kill-line (- ne-ins ne-beg)) (point)))
7298 (move-marker ins-point nil)
7299 (if folded
7300 (hide-subtree)
7301 (org-show-entry)
7302 (show-children)
7303 (org-cycle-hide-drawers 'children))
7304 (org-clean-visibility-after-subtree-move)))
7306 (defvar org-subtree-clip ""
7307 "Clipboard for cut and paste of subtrees.
7308 This is actually only a copy of the kill, because we use the normal kill
7309 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7311 (defvar org-subtree-clip-folded nil
7312 "Was the last copied subtree folded?
7313 This is used to fold the tree back after pasting.")
7315 (defun org-cut-subtree (&optional n)
7316 "Cut the current subtree into the clipboard.
7317 With prefix arg N, cut this many sequential subtrees.
7318 This is a short-hand for marking the subtree and then cutting it."
7319 (interactive "p")
7320 (org-copy-subtree n 'cut))
7322 (defun org-copy-subtree (&optional n cut force-store-markers)
7323 "Cut the current subtree into the clipboard.
7324 With prefix arg N, cut this many sequential subtrees.
7325 This is a short-hand for marking the subtree and then copying it.
7326 If CUT is non-nil, actually cut the subtree.
7327 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7328 of some markers in the region, even if CUT is non-nil. This is
7329 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7330 (interactive "p")
7331 (let (beg end folded (beg0 (point)))
7332 (if (interactive-p)
7333 (org-back-to-heading nil) ; take what looks like a subtree
7334 (org-back-to-heading t)) ; take what is really there
7335 (org-back-over-empty-lines)
7336 (setq beg (point))
7338 (save-match-data
7339 (save-excursion (outline-end-of-heading)
7340 (setq folded (org-invisible-p)))
7341 (condition-case nil
7342 (org-forward-same-level (1- n) t)
7343 (error nil))
7344 (org-end-of-subtree t t))
7345 (org-back-over-empty-lines)
7346 (setq end (point))
7347 (goto-char beg0)
7348 (when (> end beg)
7349 (setq org-subtree-clip-folded folded)
7350 (when (or cut force-store-markers)
7351 (org-save-markers-in-region beg end))
7352 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7353 (setq org-subtree-clip (current-kill 0))
7354 (message "%s: Subtree(s) with %d characters"
7355 (if cut "Cut" "Copied")
7356 (length org-subtree-clip)))))
7358 (defun org-paste-subtree (&optional level tree for-yank)
7359 "Paste the clipboard as a subtree, with modification of headline level.
7360 The entire subtree is promoted or demoted in order to match a new headline
7361 level.
7363 If the cursor is at the beginning of a headline, the same level as
7364 that headline is used to paste the tree
7366 If not, the new level is derived from the *visible* headings
7367 before and after the insertion point, and taken to be the inferior headline
7368 level of the two. So if the previous visible heading is level 3 and the
7369 next is level 4 (or vice versa), level 4 will be used for insertion.
7370 This makes sure that the subtree remains an independent subtree and does
7371 not swallow low level entries.
7373 You can also force a different level, either by using a numeric prefix
7374 argument, or by inserting the heading marker by hand. For example, if the
7377 If optional TREE is given, use this text instead of the kill ring.
7379 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7380 move back over whitespace before inserting, and move point to the end of
7381 the inserted text when done."
7382 (interactive "P")
7383 (setq tree (or tree (and kill-ring (current-kill 0))))
7384 (unless (org-kill-is-subtree-p tree)
7385 (error "%s"
7386 (substitute-command-keys
7388 (let* ((visp (not (org-invisible-p)))
7389 (txt tree)
7394 (old-level (if (string-match ^re txt)
7395 (- (match-end 0) (match-beginning 0) 1)
7396 -1))
7397 (force-level (cond (level (prefix-numeric-value level))
7399 (string-match
7400 ^re_ (buffer-substring
7401 (point-at-bol) (point))))
7402 (- (match-end 1) (match-beginning 1)))
7403 ((and (bolp)
7404 (looking-at org-outline-regexp))
7405 (- (match-end 0) (point) 1))
7406 (t nil)))
7407 (previous-level (save-excursion
7408 (condition-case nil
7409 (progn
7410 (outline-previous-visible-heading 1)
7411 (if (looking-at re)
7412 (- (match-end 0) (match-beginning 0) 1)
7413 1))
7414 (error 1))))
7415 (next-level (save-excursion
7416 (condition-case nil
7417 (progn
7418 (or (looking-at outline-regexp)
7419 (outline-next-visible-heading 1))
7420 (if (looking-at re)
7421 (- (match-end 0) (match-beginning 0) 1)
7422 1))
7423 (error 1))))
7424 (new-level (or force-level (max previous-level next-level)))
7425 (shift (if (or (= old-level -1)
7426 (= new-level -1)
7427 (= old-level new-level))
7428 0
7429 (- new-level old-level)))
7430 (delta (if (> shift 0) -1 1))
7431 (func (if (> shift 0) 'org-demote 'org-promote))
7432 (org-odd-levels-only nil)
7433 beg end newend)
7434 ;; Remove the forced level indicator
7435 (if force-level
7436 (delete-region (point-at-bol) (point)))
7437 ;; Paste
7438 (beginning-of-line 1)
7439 (unless for-yank (org-back-over-empty-lines))
7440 (setq beg (point))
7441 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7442 (insert-before-markers txt)
7444 (setq newend (point))
7445 (org-reinstall-markers-in-region beg)
7446 (setq end (point))
7447 (goto-char beg)
7449 (setq beg (point))
7450 (if (and (org-invisible-p) visp)
7451 (save-excursion (outline-show-heading)))
7452 ;; Shift if necessary
7453 (unless (= shift 0)
7454 (save-restriction
7455 (narrow-to-region beg end)
7456 (while (not (= shift 0))
7457 (org-map-region func (point-min) (point-max))
7458 (setq shift (+ delta shift)))
7459 (goto-char (point-min))
7460 (setq newend (point-max))))
7461 (when (or (interactive-p) for-yank)
7462 (message "Clipboard pasted as level %d subtree" new-level))
7463 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7464 kill-ring
7465 (eq org-subtree-clip (current-kill 0))
7466 org-subtree-clip-folded)
7467 ;; The tree was folded before it was killed/copied
7468 (hide-subtree))
7469 (and for-yank (goto-char newend))))
7471 (defun org-kill-is-subtree-p (&optional txt)
7472 "Check if the current kill is an outline subtree, or a set of trees.
7473 Returns nil if kill does not start with a headline, or if the first
7474 headline level is not the largest headline level in the tree.
7475 So this will actually accept several entries of equal levels as well,
7476 which is OK for `org-paste-subtree'.
7477 If optional TXT is given, check this string instead of the current kill."
7478 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7479 (start-level (and kill
7482 kill)
7483 (- (match-end 2) (match-beginning 2) 1)))
7484 (re (concat "^" org-outline-regexp))
7485 (start (1+ (or (match-beginning 2) -1))))
7486 (if (not start-level)
7487 (progn
7488 nil) ;; does not even start with a heading
7489 (catch 'exit
7490 (while (setq start (string-match re kill (1+ start)))
7491 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7492 (throw 'exit nil)))
7493 t))))
7495 (defvar org-markers-to-move nil
7496 "Markers that should be moved with a cut-and-paste operation.
7497 Those markers are stored together with their positions relative to
7498 the start of the region.")
7500 (defun org-save-markers-in-region (beg end)
7501 "Check markers in region.
7502 If these markers are between BEG and END, record their position relative
7503 to BEG, so that after moving the block of text, we can put the markers back
7504 into place.
7505 This function gets called just before an entry or tree gets cut from the
7506 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7507 called immediately, to move the markers with the entries."
7508 (setq org-markers-to-move nil)
7509 (when (featurep 'org-clock)
7510 (org-clock-save-markers-for-cut-and-paste beg end))
7511 (when (featurep 'org-agenda)
7512 (org-agenda-save-markers-for-cut-and-paste beg end)))
7514 (defun org-check-and-save-marker (marker beg end)
7515 "Check if MARKER is between BEG and END.
7516 If yes, remember the marker and the distance to BEG."
7517 (when (and (marker-buffer marker)
7518 (equal (marker-buffer marker) (current-buffer)))
7519 (if (and (>= marker beg) (< marker end))
7520 (push (cons marker (- marker beg)) org-markers-to-move))))
7522 (defun org-reinstall-markers-in-region (beg)
7523 "Move all remembered markers to their position relative to BEG."
7524 (mapc (lambda (x)
7525 (move-marker (car x) (+ beg (cdr x))))
7526 org-markers-to-move)
7527 (setq org-markers-to-move nil))
7529 (defun org-narrow-to-subtree ()
7530 "Narrow buffer to the current subtree."
7531 (interactive)
7532 (save-excursion
7533 (save-match-data
7534 (narrow-to-region
7535 (progn (org-back-to-heading t) (point))
7536 (progn (org-end-of-subtree t t)
7537 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7538 (point))))))
7540 (eval-when-compile
7541 (defvar org-property-drawer-re))
7543 (defun org-clone-subtree-with-time-shift (n &optional shift)
7544 "Clone the task (subtree) at point N times.
7545 The clones will be inserted as siblings.
7547 In interactive use, the user will be prompted for the number of
7548 clones to be produced, and for a time SHIFT, which may be a
7549 repeater as used in time stamps, for example `+3d'.
7551 When a valid repeater is given and the entry contains any time
7552 stamps, the clones will become a sequence in time, with time
7553 stamps in the subtree shifted for each clone produced. If SHIFT
7554 is nil or the empty string, time stamps will be left alone. The
7555 ID property of the original subtree is removed.
7557 If the original subtree did contain time stamps with a repeater,
7558 the following will happen:
7559 - the repeater will be removed in each clone
7560 - an additional clone will be produced, with the current, unshifted
7561 date(s) in the entry.
7562 - the original entry will be placed *after* all the clones, with
7563 repeater intact.
7564 - the start days in the repeater in the original entry will be shifted
7565 to past the last clone.
7566 I this way you can spell out a number of instances of a repeating task,
7567 and still retain the repeater to cover future instances of the task."
7568 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7569 (let (beg end template task idprop
7570 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7571 (if (not (and (integerp n) (> n 0)))
7572 (error "Invalid number of replications %s" n))
7575 shift)))
7576 (error "Invalid shift specification %s" shift))
7577 (when doshift
7578 (setq shift-n (string-to-number (match-string 1 shift))
7579 shift-what (cdr (assoc (match-string 2 shift)
7580 '(("d" . day) ("w" . week)
7581 ("m" . month) ("y" . year))))))
7582 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7583 (setq nmin 1 nmax n)
7584 (org-back-to-heading t)
7585 (setq beg (point))
7586 (setq idprop (org-entry-get nil "ID"))
7587 (org-end-of-subtree t t)
7589 (setq end (point))
7590 (setq template (buffer-substring beg end))
7591 (when (and doshift
7593 (delete-region beg end)
7594 (setq end beg)
7595 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7596 (goto-char end)
7597 (loop for n from nmin to nmax do
7598 ;; prepare clone
7599 (with-temp-buffer
7600 (insert template)
7601 (org-mode)
7602 (goto-char (point-min))
7603 (and idprop (if org-clone-delete-id
7604 (org-entry-delete nil "ID")
7605 (org-id-get-create t)))
7606 (while (re-search-forward org-property-drawer-re nil t)
7607 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7608 (goto-char (point-min))
7609 (when doshift
7610 (while (re-search-forward org-ts-regexp-both nil t)
7611 (org-timestamp-change (* n shift-n) shift-what))
7612 (unless (= n n-no-remove)
7613 (goto-char (point-min))
7614 (while (re-search-forward org-ts-regexp nil t)
7615 (save-excursion
7616 (goto-char (match-beginning 0))
7618 (delete-region (match-beginning 1) (match-end 1)))))))
7619 (setq task (buffer-string)))
7620 (insert task))
7621 (goto-char beg)))
7623 ;;; Outline Sorting
7625 (defun org-sort (with-case)
7626 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7627 Optional argument WITH-CASE means sort case-sensitively.
7628 With a double prefix argument, also remove duplicate entries."
7629 (interactive "P")
7630 (cond
7631 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7632 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7633 (t
7634 (org-call-with-arg 'org-sort-entries with-case))))
7636 (defun org-sort-remove-invisible (s)
7637 (remove-text-properties 0 (length s) org-rm-props s)
7638 (while (string-match org-bracket-link-regexp s)
7639 (setq s (replace-match (if (match-end 2)
7640 (match-string 3 s)
7641 (match-string 1 s)) t t s)))
7642 s)
7644 (defvar org-priority-regexp) ; defined later in the file
7646 (defvar org-after-sorting-entries-or-items-hook nil
7647 "Hook that is run after a bunch of entries or items have been sorted.
7648 When children are sorted, the cursor is in the parent line when this
7649 hook gets called. When a region or a plain list is sorted, the cursor
7650 will be in the first entry of the sorted region/list.")
7652 (defun org-sort-entries
7653 (&optional with-case sorting-type getkey-func compare-func property)
7654 "Sort entries on a certain level of an outline tree.
7655 If there is an active region, the entries in the region are sorted.
7656 Else, if the cursor is before the first entry, sort the top-level items.
7657 Else, the children of the entry at point are sorted.
7659 Sorting can be alphabetically, numerically, by date/time as given by
7660 a time stamp, by a property or by priority.
7662 The command prompts for the sorting type unless it has been given to the
7663 function through the SORTING-TYPE argument, which needs to be a character,
7664 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7665 precise meaning of each character:
7667 n Numerically, by converting the beginning of the entry/item to a number.
7668 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7669 t By date/time, either the first active time stamp in the entry, or, if
7670 none exist, by the first inactive one.
7671 s By the scheduled date/time.
7672 d By deadline date/time.
7673 c By creation time, which is assumed to be the first inactive time stamp
7674 at the beginning of a line.
7675 p By priority according to the cookie.
7676 r By the value of a property.
7678 Capital letters will reverse the sort order.
7680 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7681 called with point at the beginning of the record. It must return either
7682 a string or a number that should serve as the sorting key for that record.
7684 Comparing entries ignores case by default. However, with an optional argument
7685 WITH-CASE, the sorting considers case as well."
7686 (interactive "P")
7687 (let ((case-func (if with-case 'identity 'downcase))
7688 start beg end stars re re2
7689 txt what tmp)
7690 ;; Find beginning and end of region to sort
7691 (cond
7692 ((org-region-active-p)
7693 ;; we will sort the region
7694 (setq end (region-end)
7695 what "region")
7696 (goto-char (region-beginning))
7697 (if (not (org-on-heading-p)) (outline-next-heading))
7698 (setq start (point)))
7699 ((or (org-on-heading-p)
7700 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7701 ;; we will sort the children of the current headline
7702 (org-back-to-heading)
7703 (setq start (point)
7704 end (progn (org-end-of-subtree t t)
7706 (org-back-over-empty-lines)
7707 (point))
7708 what "children")
7709 (goto-char start)
7710 (show-subtree)
7711 (outline-next-heading))
7712 (t
7713 ;; we will sort the top-level entries in this file
7714 (goto-char (point-min))
7715 (or (org-on-heading-p) (outline-next-heading))
7716 (setq start (point))
7717 (goto-char (point-max))
7718 (beginning-of-line 1)
7720 ;; File ends in a non-white line
7721 (end-of-line 1)
7723 (setq end (point-max))
7724 (setq what "top-level")
7725 (goto-char start)
7726 (show-all)))
7728 (setq beg (point))
7729 (if (>= beg end) (error "Nothing to sort"))
7732 (setq stars (match-string 1)
7733 re (concat "^" (regexp-quote stars) " +")
7734 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
7735 txt (buffer-substring beg end))
7737 (if (and (not (equal stars "*")) (string-match re2 txt))
7738 (error "Region to sort contains a level above the first entry"))
7740 (unless sorting-type
7741 (message
7742 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7744 A/N/T/S/D/C/P/O/F means reversed:"
7745 what)
7746 (setq sorting-type (read-char-exclusive))
7748 (and (= (downcase sorting-type) ?f)
7749 (setq getkey-func
7750 (org-icompleting-read "Sort using function: "
7751 obarray 'fboundp t nil nil))
7752 (setq getkey-func (intern getkey-func)))
7754 (and (= (downcase sorting-type) ?r)
7755 (setq property
7756 (org-icompleting-read "Property: "
7757 (mapcar 'list (org-buffer-property-keys t))
7758 nil t))))
7760 (message "Sorting entries...")
7762 (save-restriction
7763 (narrow-to-region start end)
7764 (let ((dcst (downcase sorting-type))
7765 (case-fold-search nil)
7766 (now (current-time)))
7767 (sort-subr
7768 (/= dcst sorting-type)
7769 ;; This function moves to the beginning character of the "record" to
7770 ;; be sorted.
7771 (lambda nil
7772 (if (re-search-forward re nil t)
7773 (goto-char (match-beginning 0))
7774 (goto-char (point-max))))
7775 ;; This function moves to the last character of the "record" being
7776 ;; sorted.
7777 (lambda nil
7778 (save-match-data
7779 (condition-case nil
7780 (outline-forward-same-level 1)
7781 (error
7782 (goto-char (point-max))))))
7783 ;; This function returns the value that gets sorted against.
7784 (lambda nil
7785 (cond
7786 ((= dcst ?n)
7787 (if (looking-at org-complex-heading-regexp)
7788 (string-to-number (match-string 4))
7789 nil))
7790 ((= dcst ?a)
7791 (if (looking-at org-complex-heading-regexp)
7792 (funcall case-func (match-string 4))
7793 nil))
7794 ((= dcst ?t)
7795 (let ((end (save-excursion (outline-next-heading) (point))))
7796 (if (or (re-search-forward org-ts-regexp end t)
7797 (re-search-forward org-ts-regexp-both end t))
7798 (org-time-string-to-seconds (match-string 0))
7799 (org-float-time now))))
7800 ((= dcst ?c)
7801 (let ((end (save-excursion (outline-next-heading) (point))))
7802 (if (re-search-forward
7804 end t)
7805 (org-time-string-to-seconds (match-string 0))
7806 (org-float-time now))))
7807 ((= dcst ?s)
7808 (let ((end (save-excursion (outline-next-heading) (point))))
7809 (if (re-search-forward org-scheduled-time-regexp end t)
7810 (org-time-string-to-seconds (match-string 1))
7811 (org-float-time now))))
7812 ((= dcst ?d)
7813 (let ((end (save-excursion (outline-next-heading) (point))))
7814 (if (re-search-forward org-deadline-time-regexp end t)
7815 (org-time-string-to-seconds (match-string 1))
7816 (org-float-time now))))
7817 ((= dcst ?p)
7818 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7819 (string-to-char (match-string 2))
7820 org-default-priority))
7821 ((= dcst ?r)
7822 (or (org-entry-get nil property) ""))
7823 ((= dcst ?o)
7824 (if (looking-at org-complex-heading-regexp)
7825 (- 9999 (length (member (match-string 2)
7826 org-todo-keywords-1)))))
7827 ((= dcst ?f)
7828 (if getkey-func
7829 (progn
7830 (setq tmp (funcall getkey-func))
7831 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7832 tmp)
7833 (error "Invalid key function `%s'" getkey-func)))
7834 (t (error "Invalid sorting type `%c'" sorting-type))))
7835 nil
7836 (cond
7837 ((= dcst ?a) 'string<)
7838 ((= dcst ?f) compare-func)
7839 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7840 (t nil)))))
7841 (run-hooks 'org-after-sorting-entries-or-items-hook)
7842 (message "Sorting entries...done")))
7844 (defun org-do-sort (table what &optional with-case sorting-type)
7845 "Sort TABLE of WHAT according to SORTING-TYPE.
7846 The user will be prompted for the SORTING-TYPE if the call to this
7847 function does not specify it. WHAT is only for the prompt, to indicate
7848 what is being sorted. The sorting key will be extracted from
7849 the car of the elements of the table.
7850 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7851 (unless sorting-type
7852 (message
7853 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7854 what)
7855 (setq sorting-type (read-char-exclusive)))
7856 (let ((dcst (downcase sorting-type))
7857 extractfun comparefun)
7858 ;; Define the appropriate functions
7859 (cond
7860 ((= dcst ?n)
7861 (setq extractfun 'string-to-number
7862 comparefun (if (= dcst sorting-type) '< '>)))
7863 ((= dcst ?a)
7864 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7865 (lambda(x) (downcase (org-sort-remove-invisible x))))
7866 comparefun (if (= dcst sorting-type)
7867 'string<
7868 (lambda (a b) (and (not (string< a b))
7869 (not (string= a b)))))))
7870 ((= dcst ?t)
7871 (setq extractfun
7872 (lambda (x)
7873 (if (or (string-match org-ts-regexp x)
7874 (string-match org-ts-regexp-both x))
7875 (org-float-time
7876 (org-time-string-to-time (match-string 0 x)))
7877 0))
7878 comparefun (if (= dcst sorting-type) '< '>)))
7879 (t (error "Invalid sorting type `%c'" sorting-type)))
7881 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7882 table)
7883 (lambda (a b) (funcall comparefun (car a) (car b))))))
7886 ;;; The orgstruct minor mode
7888 ;; Define a minor mode which can be used in other modes in order to
7889 ;; integrate the org-mode structure editing commands.
7891 ;; This is really a hack, because the org-mode structure commands use
7892 ;; keys which normally belong to the major mode. Here is how it
7893 ;; works: The minor mode defines all the keys necessary to operate the
7894 ;; structure commands, but wraps the commands into a function which
7895 ;; tests if the cursor is currently at a headline or a plain list
7896 ;; item. If that is the case, the structure command is used,
7897 ;; temporarily setting many Org-mode variables like regular
7898 ;; expressions for filling etc. However, when any of those keys is
7899 ;; used at a different location, function uses `key-binding' to look
7900 ;; up if the key has an associated command in another currently active
7901 ;; keymap (minor modes, major mode, global), and executes that
7902 ;; command. There might be problems if any of the keys is otherwise
7903 ;; used as a prefix key.
7905 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7906 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7907 ;; addresses this by checking explicitly for both bindings.
7909 (defvar orgstruct-mode-map (make-sparse-keymap)
7910 "Keymap for the minor `orgstruct-mode'.")
7912 (defvar org-local-vars nil
7913 "List of local variables, for use by `orgstruct-mode'.")
7915 ;;;###autoload
7916 (define-minor-mode orgstruct-mode
7917 "Toggle the minor mode `orgstruct-mode'.
7918 This mode is for using Org-mode structure commands in other
7919 modes. The following keys behave as if Org-mode were active, if
7920 the cursor is on a headline, or on a plain list item (both as
7921 defined by Org-mode).
7923 M-up Move entry/item up
7924 M-down Move entry/item down
7925 M-left Promote
7926 M-right Demote
7927 M-S-up Move entry/item up
7928 M-S-down Move entry/item down
7929 M-S-left Promote subtree
7930 M-S-right Demote subtree
7931 M-q Fill paragraph and items like in Org-mode
7932 C-c ^ Sort entries
7933 C-c - Cycle list bullet
7934 TAB Cycle item visibility
7935 M-RET Insert new heading/item
7936 S-M-RET Insert new TODO heading / Checkbox item
7937 C-c C-c Set tags / toggle checkbox"
7938 nil " OrgStruct" nil
7939 (org-load-modules-maybe)
7940 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7942 ;;;###autoload
7943 (defun turn-on-orgstruct ()
7944 "Unconditionally turn on `orgstruct-mode'."
7945 (orgstruct-mode 1))
7947 (defun orgstruct++-mode (&optional arg)
7948 "Toggle `orgstruct-mode', the enhanced version of it.
7949 In addition to setting orgstruct-mode, this also exports all indentation
7950 and autofilling variables from org-mode into the buffer. It will also
7951 recognize item context in multiline items.
7952 Note that turning off orgstruct-mode will *not* remove the
7953 indentation/paragraph settings. This can only be done by refreshing the
7955 (interactive "P")
7956 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
7957 (if (< arg 1)
7958 (orgstruct-mode -1)
7959 (orgstruct-mode 1)
7960 (let (var val)
7961 (mapc
7962 (lambda (x)
7963 (when (string-match
7965 (symbol-name (car x)))
7966 (setq var (car x) val (nth 1 x))
7967 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7968 org-local-vars)
7969 (org-set-local 'orgstruct-is-++ t))))
7971 (defvar orgstruct-is-++ nil
7972 "Is `orgstruct-mode' in ++ version in the current-buffer?")
7973 (make-variable-buffer-local 'orgstruct-is-++)
7975 ;;;###autoload
7976 (defun turn-on-orgstruct++ ()
7977 "Unconditionally turn on `orgstruct++-mode'."
7978 (orgstruct++-mode 1))
7980 (defun orgstruct-error ()
7981 "Error when there is no default binding for a structure key."
7982 (interactive)
7983 (error "This key has no function outside structure elements"))
7985 (defun orgstruct-setup ()
7986 "Setup orgstruct keymaps."
7987 (let ((nfunc 0)
7988 (bindings
7989 (list
7990 '([(meta up)] org-metaup)
7991 '([(meta down)] org-metadown)
7992 '([(meta left)] org-metaleft)
7993 '([(meta right)] org-metaright)
7994 '([(meta shift up)] org-shiftmetaup)
7995 '([(meta shift down)] org-shiftmetadown)
7996 '([(meta shift left)] org-shiftmetaleft)
7997 '([(meta shift right)] org-shiftmetaright)
7998 '([?\e (up)] org-metaup)
7999 '([?\e (down)] org-metadown)
8000 '([?\e (left)] org-metaleft)
8001 '([?\e (right)] org-metaright)
8002 '([?\e (shift up)] org-shiftmetaup)
8003 '([?\e (shift down)] org-shiftmetadown)
8004 '([?\e (shift left)] org-shiftmetaleft)
8005 '([?\e (shift right)] org-shiftmetaright)
8006 '([(shift up)] org-shiftup)
8007 '([(shift down)] org-shiftdown)
8008 '([(shift left)] org-shiftleft)
8009 '([(shift right)] org-shiftright)
8010 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8011 '("\M-q" fill-paragraph)
8012 '("\C-c^" org-sort)
8013 '("\C-c-" org-cycle-list-bullet)))
8014 elt key fun cmd)
8015 (while (setq elt (pop bindings))
8016 (setq nfunc (1+ nfunc))
8017 (setq key (org-key (car elt))
8018 fun (nth 1 elt)
8019 cmd (orgstruct-make-binding fun nfunc key))
8020 (org-defkey orgstruct-mode-map key cmd))
8022 ;; Special treatment needed for TAB and RET
8023 (org-defkey orgstruct-mode-map [(tab)]
8024 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8025 (org-defkey orgstruct-mode-map "\C-i"
8026 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8028 (org-defkey orgstruct-mode-map "\M-\C-m"
8029 (orgstruct-make-binding 'org-insert-heading 105
8030 "\M-\C-m" [(meta return)]))
8031 (org-defkey orgstruct-mode-map [(meta return)]
8032 (orgstruct-make-binding 'org-insert-heading 106
8033 [(meta return)] "\M-\C-m"))
8035 (org-defkey orgstruct-mode-map [(shift meta return)]
8036 (orgstruct-make-binding 'org-insert-todo-heading 107
8037 [(meta return)] "\M-\C-m"))
8039 (org-defkey orgstruct-mode-map "\e\C-m"
8040 (orgstruct-make-binding 'org-insert-heading 108
8041 "\e\C-m" [?\e (return)]))
8042 (org-defkey orgstruct-mode-map [?\e (return)]
8043 (orgstruct-make-binding 'org-insert-heading 109
8044 [?\e (return)] "\e\C-m"))
8045 (org-defkey orgstruct-mode-map [?\e (shift return)]
8046 (orgstruct-make-binding 'org-insert-todo-heading 110
8047 [?\e (return)] "\e\C-m"))
8049 (unless org-local-vars
8050 (setq org-local-vars (org-get-local-variables)))
8052 t))
8054 (defun orgstruct-make-binding (fun n &rest keys)
8055 "Create a function for binding in the structure minor mode.
8056 FUN is the command to call inside a table. N is used to create a unique
8057 command name. KEYS are keys that should be checked in for a command
8058 to execute outside of tables."
8059 (eval
8060 (list 'defun
8061 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8062 '(arg)
8064 "Outside of structure, run the binding of `"
8065 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8066 "'.")
8067 '(interactive "p")
8068 (list 'if
8069 `(org-context-p 'headline 'item
8070 (and orgstruct-is-++
8071 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8072 'item-body))
8073 (list 'org-run-like-in-org-mode (list 'quote fun))
8074 (list 'let '(orgstruct-mode)
8075 (list 'call-interactively
8076 (append '(or)
8077 (mapcar (lambda (k)
8078 (list 'key-binding k))
8079 keys)
8080 '('orgstruct-error))))))))
8082 (defun org-context-p (&rest contexts)
8083 "Check if local context is any of CONTEXTS.
8084 Possible values in the list of contexts are `table', `headline', and `item'."
8085 (let ((pos (point)))
8086 (goto-char (point-at-bol))
8087 (prog1 (or (and (memq 'table contexts)
8089 (and (memq 'headline contexts)
8091 (looking-at outline-regexp))
8092 (and (memq 'item contexts)
8094 (and (memq 'item-body contexts)
8095 (org-in-item-p)))
8096 (goto-char pos))))
8098 (defun org-get-local-variables ()
8099 "Return a list of all local variables in an org-mode buffer."
8100 (let (varlist)
8101 (with-current-buffer (get-buffer-create "*Org tmp*")
8102 (erase-buffer)
8103 (org-mode)
8104 (setq varlist (buffer-local-variables)))
8105 (kill-buffer "*Org tmp*")
8106 (delq nil
8107 (mapcar
8108 (lambda (x)
8109 (setq x
8110 (if (symbolp x)
8111 (list x)
8112 (list (car x) (list 'quote (cdr x)))))
8113 (if (string-match
8114 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8115 (symbol-name (car x)))
8116 x nil))
8117 varlist))))
8119 ;;;###autoload
8120 (defun org-run-like-in-org-mode (cmd)
8121 "Run a command, pretending that the current buffer is in Org-mode.
8122 This will temporarily bind local variables that are typically bound in
8123 Org-mode to the values they have in Org-mode, and then interactively
8124 call CMD."
8125 (org-load-modules-maybe)
8126 (unless org-local-vars
8127 (setq org-local-vars (org-get-local-variables)))
8128 (eval (list 'let org-local-vars
8129 (list 'call-interactively (list 'quote cmd)))))
8131 ;;;; Archiving
8133 (defun org-get-category (&optional pos)
8134 "Get the category applying to position POS."
8135 (get-text-property (or pos (point)) 'org-category))
8137 (defun org-refresh-category-properties ()
8138 "Refresh category text properties in the buffer."
8139 (let ((def-cat (cond
8140 ((null org-category)
8141 (if buffer-file-name
8142 (file-name-sans-extension
8143 (file-name-nondirectory buffer-file-name))
8144 "???"))
8145 ((symbolp org-category) (symbol-name org-category))
8146 (t org-category)))
8147 beg end cat pos optionp)
8148 (org-unmodified
8149 (save-excursion
8150 (save-restriction
8151 (widen)
8152 (goto-char (point-min))
8153 (put-text-property (point) (point-max) 'org-category def-cat)
8154 (while (re-search-forward
8156 (setq pos (match-end 0)
8157 optionp (equal (char-after (match-beginning 0)) ?#)
8158 cat (org-trim (match-string 2)))
8159 (if optionp
8160 (setq beg (point-at-bol) end (point-max))
8161 (org-back-to-heading t)
8162 (setq beg (point) end (org-end-of-subtree t t)))
8163 (put-text-property beg end 'org-category cat)
8164 (goto-char pos)))))))
8167 ;;;; Link Stuff
8169 ;;; Link abbreviations
8171 (defun org-link-expand-abbrev (link)
8172 "Apply replacements as defined in `org-link-abbrev-alist."
8174 (let* ((key (match-string 1 link))
8175 (as (or (assoc key org-link-abbrev-alist-local)
8176 (assoc key org-link-abbrev-alist)))
8177 (tag (and (match-end 2) (match-string 3 link)))
8178 rpl)
8179 (if (not as)
8180 link
8181 (setq rpl (cdr as))
8182 (cond
8183 ((symbolp rpl) (funcall rpl tag))
8184 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8185 ((string-match "%h" rpl)
8186 (replace-match (url-hexify-string (or tag "")) t t rpl))
8187 (t (concat rpl tag)))))
8188 link))
8190 ;;; Storing and inserting links
8192 (defvar org-insert-link-history nil
8193 "Minibuffer history for links inserted with `org-insert-link'.")
8195 (defvar org-stored-links nil
8196 "Contains the links stored with `org-store-link'.")
8198 (defvar org-store-link-plist nil
8199 "Plist with info about the most recently link created with `org-store-link'.")
8201 (defvar org-link-protocols nil
8202 "Link protocols added to Org-mode using `org-add-link-type'.")
8204 (defvar org-store-link-functions nil
8205 "List of functions that are called to create and store a link.
8206 Each function will be called in turn until one returns a non-nil
8207 value. Each function should check if it is responsible for creating
8208 this link (for example by looking at the major mode).
8209 If not, it must exit and return nil.
8210 If yes, it should return a non-nil value after a calling
8211 `org-store-link-props' with a list of properties and values.
8212 Special properties are:
8216 This is obligatory as well.
8217 :description Optional default description for the second pair
8218 of brackets in an Org-mode link. The user can still change
8219 this when inserting this link into an Org-mode buffer.
8221 In addition to these, any additional properties can be specified
8222 and then used in remember templates.")
8224 (defun org-add-link-type (type &optional follow export)
8225 "Add TYPE to the list of `org-link-types'.
8226 Re-compute all regular expressions depending on `org-link-types'
8228 FOLLOW and EXPORT are two functions.
8230 FOLLOW should take the link path as the single argument and do whatever
8231 is necessary to follow the link, for example find a file or display
8232 a mail message.
8234 EXPORT should format the link path for export to one of the export formats.
8235 It should be a function accepting three arguments:
8238 desc the description of the link, if any, nil if there was no description
8239 format the export format, a symbol like `html' or `latex' or `ascii'..
8241 The function may use the FORMAT information to return different values
8242 depending on the format. The return value will be put literally into
8243 the exported file. If the return value is nil, this means Org should
8244 do what it normally does with links which do not have EXPORT defined.
8246 Org-mode has a built-in default for exporting links. If you are happy with
8247 this default, there is no need to define an export function for the link
8248 type. For a simple example of an export function, see `org-bbdb.el'."
8249 (add-to-list 'org-link-types type t)
8250 (org-make-link-regexps)
8251 (if (assoc type org-link-protocols)
8252 (setcdr (assoc type org-link-protocols) (list follow export))
8253 (push (list type follow export) org-link-protocols)))
8255 (defvar org-agenda-buffer-name)
8257 ;;;###autoload
8258 (defun org-store-link (arg)
8260 This link is added to `org-stored-links' and can later be inserted
8263 For some link types, a prefix arg is interpreted:
8264 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8265 For file links, arg negates `org-context-in-file-links'."
8266 (interactive "P")
8267 (org-load-modules-maybe)
8268 (setq org-store-link-plist nil) ; reset
8269 (let ((outline-regexp (org-get-limited-outline-regexp))
8270 link cpltxt desc description search txt custom-id agenda-link)
8271 (cond
8273 ((run-hook-with-args-until-success 'org-store-link-functions)
8274 (setq link (plist-get org-store-link-plist :link)
8275 desc (or (plist-get org-store-link-plist :description) link)))
8277 ((equal (buffer-name) "*Org Edit Src Example*")
8278 (let (label gc)
8279 (while (or (not label)
8280 (save-excursion
8281 (save-restriction
8282 (widen)
8283 (goto-char (point-min))
8284 (re-search-forward
8285 (regexp-quote (format org-coderef-label-format label))
8286 nil t))))
8287 (when label (message "Label exists already") (sit-for 2))
8288 (setq label (read-string "Code line label: " label)))
8289 (end-of-line 1)
8290 (setq link (format org-coderef-label-format label))
8291 (setq gc (- 79 (length link)))
8292 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8293 (insert link)
8294 (setq link (concat "(" label ")") desc nil)))
8296 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8297 ;; We are in the agenda, link to referenced location
8298 (let ((m (or (get-text-property (point) 'org-hd-marker)
8299 (get-text-property (point) 'org-marker))))
8300 (when m
8301 (org-with-point-at m
8302 (setq agenda-link
8303 (if (interactive-p)
8304 (call-interactively 'org-store-link)
8305 (org-store-link nil)))))))
8307 ((eq major-mode 'calendar-mode)
8308 (let ((cd (calendar-cursor-to-date)))
8309 (setq link
8310 (format-time-string
8311 (car org-time-stamp-formats)
8312 (apply 'encode-time
8313 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8314 nil nil nil))))
8315 (org-store-link-props :type "calendar" :date cd)))
8317 ((eq major-mode 'w3-mode)
8318 (setq cpltxt (if (and (buffer-name)
8319 (not (string-match "Untitled" (buffer-name))))
8320 (buffer-name)
8321 (url-view-url t))
8322 link (org-make-link (url-view-url t)))
8323 (org-store-link-props :type "w3" :url (url-view-url t)))
8325 ((eq major-mode 'w3m-mode)
8326 (setq cpltxt (or w3m-current-title w3m-current-url)
8327 link (org-make-link w3m-current-url))
8328 (org-store-link-props :type "w3m" :url (url-view-url t)))
8330 ((setq search (run-hook-with-args-until-success
8331 'org-create-file-search-functions))
8332 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8333 "::" search))
8334 (setq cpltxt (or description link)))
8336 ((eq major-mode 'image-mode)
8337 (setq cpltxt (concat "file:"
8338 (abbreviate-file-name buffer-file-name))
8339 link (org-make-link cpltxt))
8340 (org-store-link-props :type "image" :file buffer-file-name))
8342 ((eq major-mode 'dired-mode)
8343 ;; link to the file in the current line
8344 (let ((file (dired-get-filename nil t)))
8345 (setq file (if file
8346 (abbreviate-file-name
8347 (expand-file-name (dired-get-filename nil t)))
8348 ;; otherwise, no file so use current directory.
8349 default-directory))
8350 (setq cpltxt (concat "file:" file)
8351 link (org-make-link cpltxt))))
8353 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8354 (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
8355 (cond
8357 (setq cpltxt
8358 (concat "file:"
8359 (abbreviate-file-name
8360 (buffer-file-name (buffer-base-buffer)))
8361 "::" (match-string 1))
8362 link (org-make-link cpltxt)))
8363 ((and (featurep 'org-id)
8364 (or (eq org-link-to-org-use-id t)
8365 (and (eq org-link-to-org-use-id 'create-if-interactive)
8366 (interactive-p))
8367 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
8368 (interactive-p)
8369 (not custom-id))
8370 (and org-link-to-org-use-id
8371 (condition-case nil
8372 (org-entry-get nil "ID")
8373 (error nil)))))
8374 ;; We can make a link using the ID.
8375 (setq link (condition-case nil
8376 (prog1 (org-id-store-link)
8377 (setq desc (plist-get org-store-link-plist
8378 :description)))
8379 (error
8380 ;; probably before first headline, link to file only
8381 (concat "file:"
8382 (abbreviate-file-name
8383 (buffer-file-name (buffer-base-buffer))))))))
8384 (t
8385 ;; Just link to current headline
8386 (setq cpltxt (concat "file:"
8387 (abbreviate-file-name
8388 (buffer-file-name (buffer-base-buffer)))))
8389 ;; Add a context search string
8390 (when (org-xor org-context-in-file-links arg)
8391 (setq txt (cond
8392 ((org-on-heading-p) nil)
8393 ((org-region-active-p)
8394 (buffer-substring (region-beginning) (region-end)))
8395 (t nil)))
8397 (setq cpltxt
8398 (concat cpltxt "::"
8399 (condition-case nil
8400 (org-make-org-heading-search-string txt)
8401 (error "")))
8402 desc (or (nth 4 (ignore-errors
8403 (org-heading-components))) "NONE"))))
8405 (setq cpltxt (substring cpltxt 0 -2)))
8406 (setq link (org-make-link cpltxt)))))
8408 ((buffer-file-name (buffer-base-buffer))
8409 ;; Just link to this file here.
8410 (setq cpltxt (concat "file:"
8411 (abbreviate-file-name
8412 (buffer-file-name (buffer-base-buffer)))))
8413 ;; Add a context string
8414 (when (org-xor org-context-in-file-links arg)
8415 (setq txt (if (org-region-active-p)
8416 (buffer-substring (region-beginning) (region-end))
8417 (buffer-substring (point-at-bol) (point-at-eol))))
8418 ;; Only use search option if there is some text.
8420 (setq cpltxt
8421 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8422 desc "NONE")))
8423 (setq link (org-make-link cpltxt)))
8425 ((interactive-p)
8426 (error "Cannot link to a buffer which is not visiting a file"))
8428 (t (setq link nil)))
8430 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8431 (setq link (or link cpltxt)
8432 desc (or desc cpltxt))
8433 (if (equal desc "NONE") (setq desc nil))
8435 (if (and (or (interactive-p) executing-kbd-macro) link)
8436 (progn
8437 (setq org-stored-links
8438 (cons (list link desc) org-stored-links))
8439 (message "Stored: %s" (or desc link))
8440 (when custom-id
8441 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8442 "::#" custom-id))
8443 (setq org-stored-links
8444 (cons (list link desc) org-stored-links))))
8445 (or agenda-link (and link (org-make-link-string link desc))))))
8447 (defun org-store-link-props (&rest plist)
8448 "Store link properties, extract names and addresses."
8449 (let (x adr)
8450 (when (setq x (plist-get plist :from))
8451 (setq adr (mail-extract-address-components x))
8452 (setq plist (plist-put plist :fromname (car adr)))
8453 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8454 (when (setq x (plist-get plist :to))
8455 (setq adr (mail-extract-address-components x))
8456 (setq plist (plist-put plist :toname (car adr)))
8457 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8458 (let ((from (plist-get plist :from))
8459 (to (plist-get plist :to)))
8460 (when (and from to org-from-is-user-regexp)
8461 (setq plist
8462 (plist-put plist :fromto
8463 (if (string-match org-from-is-user-regexp from)
8464 (concat "to %t")
8465 (concat "from %f"))))))
8466 (setq org-store-link-plist plist))
8468 (defun org-add-link-props (&rest plist)
8469 "Add these properties to the link property list."
8470 (let (key value)
8471 (while plist
8472 (setq key (pop plist) value (pop plist))
8473 (setq org-store-link-plist
8474 (plist-put org-store-link-plist key value)))))
8476 (defun org-email-link-description (&optional fmt)
8477 "Return the description part of an email link.
8478 This takes information from `org-store-link-plist' and formats it
8479 according to FMT (default from `org-email-link-description-format')."
8480 (setq fmt (or fmt org-email-link-description-format))
8481 (let* ((p org-store-link-plist)
8482 (to (plist-get p :toaddress))
8483 (from (plist-get p :fromaddress))
8484 (table
8485 (list
8486 (cons "%c" (plist-get p :fromto))
8487 (cons "%F" (plist-get p :from))
8488 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8489 (cons "%T" (plist-get p :to))
8490 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8491 (cons "%s" (plist-get p :subject))
8492 (cons "%m" (plist-get p :message-id)))))
8493 (when (string-match "%c" fmt)
8494 ;; Check if the user wrote this message
8495 (if (and org-from-is-user-regexp from to
8496 (save-match-data (string-match org-from-is-user-regexp from)))
8497 (setq fmt (replace-match "to %t" t t fmt))
8498 (setq fmt (replace-match "from %f" t t fmt))))
8499 (org-replace-escapes fmt table)))
8501 (defun org-make-org-heading-search-string (&optional string heading)
8502 "Make search string for STRING or current headline."
8503 (interactive)
8504 (let ((s (or string (org-get-heading))))
8505 (unless (and string (not heading))
8506 ;; We are using a headline, clean up garbage in there.
8507 (if (string-match org-todo-regexp s)
8508 (setq s (replace-match "" t t s)))
8510 (setq s (replace-match "" t t s)))
8511 (setq s (org-trim s))
8514 (setq s (replace-match "" t t s)))
8515 (while (string-match org-ts-regexp s)
8516 (setq s (replace-match "" t t s))))
8517 (or string (setq s (concat "*" s))) ; Add * for headlines
8520 (defun org-make-link (&rest strings)
8521 "Concatenate STRINGS."
8522 (apply 'concat strings))
8524 (defun org-make-link-string (link &optional description)
8525 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8527 (error "Empty link"))
8528 (when (and description
8529 (stringp description)
8531 (setq description nil))
8532 (when (stringp description)
8533 ;; Remove brackets from the description, they are fatal.
8535 (setq description (replace-match "{" t t description)))
8537 (setq description (replace-match "}" t t description))))
8538 (when (equal (org-link-escape link) description)
8539 ;; No description needed, it is identical
8540 (setq description nil))
8541 (when (and (not description)
8542 (not (equal link (org-link-escape link))))
8543 (setq description (org-extract-attributes link)))
8544 (setq link (if (string-match org-link-types-re link)
8545 (concat (match-string 1 link)
8546 (org-link-escape (substring link (match-end 1))))
8547 (org-link-escape link)))
8548 (concat "[[" link "]"
8549 (if description (concat "[" description "]") "")
8550 "]"))
8552 (defconst org-link-escape-chars
8553 '((?\ . "%20")
8554 (?\[ . "%5B")
8555 (?\] . "%5D")
8566 (?\; . "%3B")
8567 ;; (?? . "%3F")
8568 (?= . "%3D")
8569 (?+ . "%2B")
8570 )
8571 "Association list of escapes for some characters problematic in links.
8572 This is the list that is used for internal purposes.")
8574 (defvar org-url-encoding-use-url-hexify nil)
8576 (defconst org-link-escape-chars-browser
8577 '((?\ . "%20")) ; 32 for the SPC char
8578 "Association list of escapes for some characters problematic in links.
8579 This is the list that is used before handing over to the browser.")
8581 (defun org-link-escape (text &optional table)
8582 "Escape characters in TEXT that are problematic for links."
8583 (if (and org-url-encoding-use-url-hexify (not table))
8584 (url-hexify-string text)
8585 (setq table (or table org-link-escape-chars))
8586 (when text
8587 (let ((re (mapconcat (lambda (x) (regexp-quote
8588 (char-to-string (car x))))
8590 (while (string-match re text)
8591 (setq text
8592 (replace-match
8593 (cdr (assoc (string-to-char (match-string 0 text))
8594 table))
8595 t t text)))
8596 text))))
8598 (defun org-link-unescape (text &optional table)
8599 "Reverse the action of `org-link-escape'."
8600 (if (and org-url-encoding-use-url-hexify (not table))
8601 (url-unhex-string text)
8602 (setq table (or table org-link-escape-chars))
8603 (when text
8604 (let ((case-fold-search t)
8605 (re (mapconcat (lambda (x) (regexp-quote (downcase (cdr x))))
8607 (while (string-match re text)
8608 (setq text
8609 (replace-match
8610 (char-to-string (car (rassoc (upcase (match-string 0 text))
8611 table)))
8612 t t text)))
8613 text))))
8615 (defun org-xor (a b)
8616 "Exclusive or."
8617 (if a (not b) b))
8619 (defun org-fixup-message-id-for-http (s)
8620 "Replace special characters in a message id, so it can be used in an http query."
8621 (when (string-match "%" s)
8622 (setq s (mapconcat (lambda (c)
8623 (if (eq c ?%)
8624 "%25"
8625 (char-to-string c)))
8626 s "")))
8627 (while (string-match "<" s)
8628 (setq s (replace-match "%3C" t t s)))
8629 (while (string-match ">" s)
8630 (setq s (replace-match "%3E" t t s)))
8631 (while (string-match "@" s)
8632 (setq s (replace-match "%40" t t s)))
8633 s)
8635 ;;;###autoload
8636 (defun org-insert-link-global ()
8637 "Insert a link like Org-mode does.
8638 This command can be called in any mode to insert a link in Org-mode syntax."
8639 (interactive)
8640 (org-load-modules-maybe)
8641 (org-run-like-in-org-mode 'org-insert-link))
8643 (defun org-insert-link (&optional complete-file link-location)
8644 "Insert a link. At the prompt, enter the link.
8646 Completion can be used to insert any of the link protocol prefixes like
8647 http or ftp in use.
8649 The history can be used to select a link previously stored with
8650 `org-store-link'. When the empty string is entered (i.e. if you just
8651 press RET at the prompt), the link defaults to the most recently
8652 stored link. As SPC triggers completion in the minibuffer, you need to
8653 use M-SPC or C-q SPC to force the insertion of a space character.
8655 You will also be prompted for a description, and if one is given, it will
8656 be displayed in the buffer instead of the link.
8658 If there is already a link at point, this command will allow you to edit link
8659 and description parts.
8662 be selected using completion. The path to the file will be relative to the
8663 current directory if the file is in the current directory or a subdirectory.
8664 Otherwise, the link will be the absolute path as completed in the minibuffer
8665 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8666 option `org-link-file-path-type'.
8669 the current directory or below.
8672 `org-keep-stored-link-after-insertion'.
8674 If `org-make-link-description-function' is non-nil, this function will be
8675 called with the link target, and the result will be the default
8676 link description.
8678 If the LINK-LOCATION parameter is non-nil, this value will be
8679 used as the link location instead of reading one interactively."
8680 (interactive "P")
8681 (let* ((wcf (current-window-configuration))
8682 (region (if (org-region-active-p)
8683 (buffer-substring (region-beginning) (region-end))))
8684 (remove (and region (list (region-beginning) (region-end))))
8685 (desc region)
8686 tmphist ; byte-compile incorrectly complains about this
8687 (link link-location)
8688 entry file all-prefixes)
8689 (cond
8690 (link-location) ; specified by arg, just use it.
8691 ((org-in-regexp org-bracket-link-regexp 1)
8692 ;; We do have a link at point, and we are going to edit it.
8693 (setq remove (list (match-beginning 0) (match-end 0)))
8694 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8695 (setq link (read-string "Link: "
8696 (org-link-unescape
8697 (org-match-string-no-properties 1)))))
8698 ((or (org-in-regexp org-angle-link-re)
8699 (org-in-regexp org-plain-link-re))
8700 ;; Convert to bracket link
8701 (setq remove (list (match-beginning 0) (match-end 0))
8702 link (read-string "Link: "
8703 (org-remove-angle-brackets (match-string 0)))))
8704 ((member complete-file '((4) (16)))
8705 ;; Completing read for file names.
8706 (setq link (org-file-complete-link complete-file)))
8707 (t
8708 ;; Read link, with completion for stored links.
8709 (with-output-to-temp-buffer "*Org Links*"
8710 (princ "Insert a link.
8712 (when org-stored-links
8714 (princ (mapconcat
8715 (lambda (x)
8716 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8718 (let ((cw (selected-window)))
8719 (select-window (get-buffer-window "*Org Links*" 'visible))
8720 (setq truncate-lines t)
8721 (unless (pos-visible-in-window-p (point-max))
8722 (org-fit-window-to-buffer))
8723 (and (window-live-p cw) (select-window cw)))
8724 ;; Fake a link history, containing the stored links.
8725 (setq tmphist (append (mapcar 'car org-stored-links)
8726 org-insert-link-history))
8727 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8728 (mapcar 'car org-link-abbrev-alist)
8729 org-link-types))
8730 (unwind-protect
8731 (progn
8732 (setq link
8733 (let ((org-completion-use-ido nil)
8734 (org-completion-use-iswitchb nil))
8735 (org-completing-read
8736 "Link: "
8737 (append
8738 (mapcar (lambda (x) (list (concat x ":")))
8739 all-prefixes)
8740 (mapcar 'car org-stored-links))
8741 nil nil nil
8742 'tmphist
8743 (car (car org-stored-links)))))
8745 (error "No link selected"))
8746 (if (or (member link all-prefixes)
8747 (and (equal ":" (substring link -1))
8748 (member (substring link 0 -1) all-prefixes)
8749 (setq link (substring link 0 -1))))
8750 (setq link (org-link-try-special-completion link))))
8751 (set-window-configuration wcf)
8752 (kill-buffer "*Org Links*"))
8753 (setq entry (assoc link org-stored-links))
8754 (or entry (push link org-insert-link-history))
8755 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8756 (not org-keep-stored-link-after-insertion))
8757 (setq org-stored-links (delq (assoc link org-stored-links)
8758 org-stored-links)))
8759 (setq desc (or desc (nth 1 entry)))))
8761 (if (string-match org-plain-link-re link)
8762 ;; URL-like link, normalize the use of angular brackets.
8763 (setq link (org-make-link (org-remove-angle-brackets link))))
8765 ;; Check if we are linking to the current file with a search option
8766 ;; If yes, simplify the link by using only the search option.
8767 (when (and buffer-file-name
8769 (let* ((path (match-string 1 link))
8770 (case-fold-search nil)
8771 (search (match-string 2 link)))
8772 (save-match-data
8773 (if (equal (file-truename buffer-file-name) (file-truename path))
8774 ;; We are linking to this same file, with a search option
8775 (setq link search)))))
8777 ;; Check if we can/should use a relative path. If yes, simplify the link
8779 (let* ((type (match-string 1 link))
8780 (path (match-string 2 link))
8781 (origpath path)
8782 (case-fold-search nil))
8783 (cond
8784 ((or (eq org-link-file-path-type 'absolute)
8785 (equal complete-file '(16)))
8786 (setq path (abbreviate-file-name (expand-file-name path))))
8787 ((eq org-link-file-path-type 'noabbrev)
8788 (setq path (expand-file-name path)))
8789 ((eq org-link-file-path-type 'relative)
8790 (setq path (file-relative-name path)))
8791 (t
8792 (save-match-data
8793 (if (string-match (concat "^" (regexp-quote
8794 (expand-file-name
8795 (file-name-as-directory
8796 default-directory))))
8797 (expand-file-name path))
8798 ;; We are linking a file with relative path name.
8799 (setq path (substring (expand-file-name path)
8800 (match-end 0)))
8801 (setq path (abbreviate-file-name (expand-file-name path)))))))
8802 (setq link (concat type path))
8803 (if (equal desc origpath)
8804 (setq desc path))))
8806 (if org-make-link-description-function
8807 (setq desc (funcall org-make-link-description-function link desc)))
8809 (setq desc (read-string "Description: " desc))
8811 (if remove (apply 'delete-region remove))
8812 (insert (org-make-link-string link desc))))
8814 (defun org-link-try-special-completion (type)
8815 "If there is completion support for link type TYPE, offer it."
8816 (let ((fun (intern (concat "org-" type "-complete-link"))))
8817 (if (functionp fun)
8818 (funcall fun)
8819 (read-string "Link (no completion support): " (concat type ":")))))
8821 (defun org-file-complete-link (&optional arg)
8822 "Create a file link using completion."
8823 (let (file link)
8824 (setq file (read-file-name "File: "))
8825 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8826 (pwd1 (file-name-as-directory (abbreviate-file-name
8827 (expand-file-name ".")))))
8828 (cond
8829 ((equal arg '(16))
8830 (setq link (org-make-link
8831 "file:"
8832 (abbreviate-file-name (expand-file-name file)))))
8834 (setq link (org-make-link "file:" (match-string 1 file))))
8836 (expand-file-name file))
8837 (setq link (org-make-link
8838 "file:" (match-string 1 (expand-file-name file)))))
8839 (t (setq link (org-make-link "file:" file)))))
8840 link))
8842 (defun org-completing-read (&rest args)
8843 "Completing-read with SPACE being a normal character."
8844 (let ((minibuffer-local-completion-map
8845 (copy-keymap minibuffer-local-completion-map)))
8846 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
8847 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
8848 (apply 'org-icompleting-read args)))
8850 (defun org-completing-read-no-i (&rest args)
8851 (let (org-completion-use-ido org-completion-use-iswitchb)
8852 (apply 'org-completing-read args)))
8854 (defun org-iswitchb-completing-read (prompt choices &rest args)
8855 "Use iswitch as a completing-read replacement to choose from choices.
8856 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
8857 from."
8858 (let* ((iswitchb-use-virtual-buffers nil)
8859 (iswitchb-make-buflist-hook
8860 (lambda ()
8861 (setq iswitchb-temp-buflist choices))))
8862 (iswitchb-read-buffer prompt)))
8864 (defun org-icompleting-read (&rest args)
8865 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
8866 (org-without-partial-completion
8867 (if (and org-completion-use-ido
8868 (fboundp 'ido-completing-read)
8869 (boundp 'ido-mode) ido-mode
8870 (listp (second args)))
8871 (let ((ido-enter-matching-directory nil))
8872 (apply 'ido-completing-read (concat (car args))
8873 (if (consp (car (nth 1 args)))
8874 (mapcar (lambda (x) (car x)) (nth 1 args))
8875 (nth 1 args))
8876 (cddr args)))
8877 (if (and org-completion-use-iswitchb
8878 (boundp 'iswitchb-mode) iswitchb-mode
8879 (listp (second args)))
8880 (apply 'org-iswitchb-completing-read (concat (car args))
8881 (if (consp (car (nth 1 args)))
8882 (mapcar (lambda (x) (car x)) (nth 1 args))
8883 (nth 1 args))
8884 (cddr args))
8885 (apply 'completing-read args)))))
8887 (defun org-extract-attributes (s)
8888 "Extract the attributes cookie from a string and set as text property."
8889 (let (a attr (start 0) key value)
8890 (save-match-data
8892 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
8894 (setq key (match-string 1 a) value (match-string 2 a)
8895 start (match-end 0)
8896 attr (plist-put attr (intern key) value))))
8897 (org-add-props s nil 'org-attr attr))
8898 s))
8900 (defun org-extract-attributes-from-string (tag)
8901 (let (key value attr)
8903 (setq key (match-string 1 tag) value (match-string 2 tag)
8904 tag (replace-match "" t t tag)
8905 attr (plist-put attr (intern key) value)))
8906 (cons tag attr)))
8908 (defun org-attributes-to-string (plist)
8909 "Format a property list into an HTML attribute list."
8910 (let ((s "") key value)
8911 (while plist
8912 (setq key (pop plist) value (pop plist))
8913 (and value
8915 s))
8917 ;;; Opening/following a link
8919 (defvar org-link-search-failed nil)
8921 (defvar org-open-link-functions nil
8922 "Hook for functions finding a plain text link.
8923 These functions must take a single argument, the link content.
8924 They will be called for links that look like [[link text][description]]
8928 These functions will be called *before* Org attempts to resolve the
8929 link by doing text searches in the current buffer - so if you want a
8931 handle this as a special case.
8933 When the function does handle the link, it must return a non-nil value.
8934 If it decides that it is not responsible for this link, it must return
8935 nil to indicate that that Org-mode can continue with other options
8936 like exact and fuzzy text search.")
8938 (defun org-next-link ()
8939 "Move forward to the next link.
8940 If the link is in hidden text, expose it."
8941 (interactive)
8942 (when (and org-link-search-failed (eq this-command last-command))
8943 (goto-char (point-min))
8944 (message "Link search wrapped back to beginning of buffer"))
8945 (setq org-link-search-failed nil)
8946 (let* ((pos (point))
8947 (ct (org-context))
8948 (a (assoc :link ct)))
8949 (if a (goto-char (nth 2 a)))
8950 (if (re-search-forward org-any-link-re nil t)
8951 (progn
8952 (goto-char (match-beginning 0))
8953 (if (org-invisible-p) (org-show-context)))
8954 (goto-char pos)
8955 (setq org-link-search-failed t)
8956 (error "No further link found"))))
8958 (defun org-previous-link ()
8959 "Move backward to the previous link.
8960 If the link is in hidden text, expose it."
8961 (interactive)
8962 (when (and org-link-search-failed (eq this-command last-command))
8963 (goto-char (point-max))
8964 (message "Link search wrapped back to end of buffer"))
8965 (setq org-link-search-failed nil)
8966 (let* ((pos (point))
8967 (ct (org-context))
8968 (a (assoc :link ct)))
8969 (if a (goto-char (nth 1 a)))
8970 (if (re-search-backward org-any-link-re nil t)
8971 (progn
8972 (goto-char (match-beginning 0))
8973 (if (org-invisible-p) (org-show-context)))
8974 (goto-char pos)
8975 (setq org-link-search-failed t)
8976 (error "No further link found"))))
8978 (defun org-translate-link (s)
8979 "Translate a link string if a translation function has been defined."
8980 (if (and org-link-translation-function
8981 (fboundp org-link-translation-function)
8983 (progn
8984 (setq s (funcall org-link-translation-function
8985 (match-string 1) (match-string 2)))
8986 (concat (car s) ":" (cdr s)))
8987 s))
8989 (defun org-translate-link-from-planner (type path)
8990 "Translate a link from Emacs Planner syntax so that Org can follow it.
8991 This is still an experimental function, your mileage may vary."
8992 (cond
8993 ((member type '("http" "https" "news" "ftp"))
8994 ;; standard Internet links are the same.
8995 nil)
8996 ((and (equal type "irc") (string-match "^//" path))
8997 ;; Planner has two / at the beginning of an irc link, we have 1.
8998 ;; We should have zero, actually....
8999 (setq path (substring path 1)))
9000 ((and (equal type "lisp") (string-match "^/" path))
9001 ;; Planner has a slash, we do not.
9002 (setq type "elisp" path (substring path 1)))
9004 ;; A typical message link. Planner has the id after the final slash,
9005 ;; we separate it with a hash mark
9006 (setq path (concat (match-string 1 path) "#"
9007 (org-remove-angle-brackets (match-string 2 path)))))
9008 )
9009 (cons type path))
9011 (defun org-find-file-at-mouse (ev)
9012 "Open file link or URL at mouse."
9013 (interactive "e")
9014 (mouse-set-point ev)
9015 (org-open-at-point 'in-emacs))
9017 (defun org-open-at-mouse (ev)
9018 "Open file link or URL at mouse."
9019 (interactive "e")
9020 (mouse-set-point ev)
9021 (if (eq major-mode 'org-agenda-mode)
9022 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9023 (org-open-at-point))
9025 (defvar org-window-config-before-follow-link nil
9026 "The window configuration before following a link.
9027 This is saved in case the need arises to restore it.")
9029 (defvar org-open-link-marker (make-marker)
9030 "Marker pointing to the location where `org-open-at-point; was called.")
9032 ;;;###autoload
9033 (defun org-open-at-point-global ()
9034 "Follow a link like Org-mode does.
9035 This command can be called in any mode to follow a link that has
9036 Org-mode syntax."
9037 (interactive)
9038 (org-run-like-in-org-mode 'org-open-at-point))
9040 ;;;###autoload
9041 (defun org-open-link-from-string (s &optional arg reference-buffer)
9042 "Open a link in the string S, as if it was in Org-mode."
9044 (let ((reference-buffer (or reference-buffer (current-buffer))))
9045 (with-temp-buffer
9046 (let ((org-inhibit-startup t))
9047 (org-mode)
9048 (insert s)
9049 (goto-char (point-min))
9050 (when reference-buffer
9051 (setq org-link-abbrev-alist-local
9052 (with-current-buffer reference-buffer
9053 org-link-abbrev-alist-local)))
9054 (org-open-at-point arg reference-buffer)))))
9056 (defvar org-open-at-point-functions nil
9057 "Hook that is run when following a link at point.
9059 Functions in this hook must return t if they identify and follow
9060 a link at point. If they don't find anything interesting at point,
9061 they must return nil.")
9063 (defun org-open-at-point (&optional in-emacs reference-buffer)
9064 "Open link at or after point.
9065 If there is no link at point, this function will search forward up to
9066 the end of the current line.
9067 Normally, files will be opened by an appropriate application. If the
9068 optional argument IN-EMACS is non-nil, Emacs will visit the file.
9069 With a double prefix argument, try to open outside of Emacs, in the
9070 application the system uses for this file type."
9071 (interactive "P")
9072 ;; if in a code block, then open the block's results
9073 (unless (call-interactively #'org-babel-open-src-block-result)
9074 (org-load-modules-maybe)
9075 (move-marker org-open-link-marker (point))
9076 (setq org-window-config-before-follow-link (current-window-configuration))
9077 (org-remove-occur-highlights nil nil t)
9078 (cond
9079 ((and (org-on-heading-p)
9080 (not (org-in-regexp
9085 (not (get-text-property (point) 'org-linked-text)))
9086 (or (org-offer-links-in-entry in-emacs)
9087 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9088 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9089 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9090 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9091 (not (org-in-regexp org-bracket-link-regexp)))
9092 (org-footnote-action))
9093 (t
9094 (let (type path link line search (pos (point)))
9095 (catch 'match
9096 (save-excursion
9098 (when (org-in-regexp org-bracket-link-regexp 1)
9099 (setq link (org-extract-attributes
9100 (org-link-unescape (org-match-string-no-properties 1))))
9102 (setq link (replace-match " " t t link)))
9103 (setq link (org-link-expand-abbrev link))
9104 (cond
9105 ((or (file-name-absolute-p link)
9107 (setq type "file" path link))
9108 ((string-match org-link-re-with-space3 link)
9109 (setq type (match-string 1 link) path (match-string 2 link)))
9110 (t (setq type "thisfile" path link)))
9111 (throw 'match t)))
9113 (when (get-text-property (point) 'org-linked-text)
9114 (setq type "thisfile"
9115 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9116 (1+ (point)) (point))
9117 path (buffer-substring
9118 (previous-single-property-change pos 'org-linked-text)
9119 (next-single-property-change pos 'org-linked-text)))
9120 (throw 'match t))
9122 (save-excursion
9123 (when (or (org-in-regexp org-angle-link-re)
9124 (org-in-regexp org-plain-link-re))
9125 (setq type (match-string 1) path (match-string 2))
9126 (throw 'match t)))
9127 (save-excursion
9129 (setq type "tags"
9130 path (match-string 1))
9131 (while (string-match ":" path)
9132 (setq path (replace-match "+" t t path)))
9133 (throw 'match t)))
9135 (setq type "tree-match"
9136 path (match-string 1))
9137 (throw 'match t)))
9138 (unless path
9139 (error "No link found"))
9141 ;; switch back to reference buffer
9142 ;; needed when if called in a temporary buffer through
9143 ;; org-open-link-from-string
9144 (with-current-buffer (or reference-buffer (current-buffer))
9146 ;; Remove any trailing spaces in path
9148 (setq path (replace-match "" t t path)))
9149 (if (and org-link-translation-function
9150 (fboundp org-link-translation-function))
9151 ;; Check if we need to translate the link
9152 (let ((tmp (funcall org-link-translation-function type path)))
9153 (setq type (car tmp) path (cdr tmp))))
9155 (cond
9157 ((assoc type org-link-protocols)
9158 (funcall (nth 1 (assoc type org-link-protocols)) path))
9160 ((equal type "mailto")
9161 (let ((cmd (car org-link-mailto-program))
9162 (args (cdr org-link-mailto-program)) args1
9163 (address path) (subject "") a)
9165 (setq address (match-string 1 path)
9166 subject (org-link-escape (match-string 2 path))))
9167 (while args
9168 (cond
9169 ((not (stringp (car args))) (push (pop args) args1))
9170 (t (setq a (pop args))
9171 (if (string-match "%a" a)
9172 (setq a (replace-match address t t a)))
9173 (if (string-match "%s" a)
9174 (setq a (replace-match subject t t a)))
9175 (push a args1))))
9176 (apply cmd (nreverse args1))))
9178 ((member type '("http" "https" "ftp" "news"))
9179 (browse-url (concat type ":" (org-link-escape
9180 path org-link-escape-chars-browser))))
9182 ((string= type "doi")
9183 (browse-url (concat "http://dx.doi.org/"
9184 (org-link-escape
9185 path org-link-escape-chars-browser))))
9187 ((member type '("message"))
9188 (browse-url (concat type ":" path)))
9190 ((string= type "tags")
9191 (org-tags-view in-emacs path))
9193 ((string= type "tree-match")
9196 ((string= type "file")
9198 (setq line (string-to-number (match-string 1 path))
9199 path (substring path 0 (match-beginning 0)))
9201 (setq search (match-string 1 path)
9202 path (substring path 0 (match-beginning 0)))))
9203 (if (string-match "[*?{]" (file-name-nondirectory path))
9204 (dired path)
9205 (org-open-file path in-emacs line search)))
9207 ((string= type "shell")
9208 (let ((cmd path))
9209 (if (or (not org-confirm-shell-link-function)
9210 (funcall org-confirm-shell-link-function
9212 (org-add-props cmd nil
9213 'face 'org-warning))))
9214 (progn
9215 (message "Executing %s" cmd)
9216 (shell-command cmd))
9217 (error "Abort"))))
9219 ((string= type "elisp")
9220 (let ((cmd path))
9221 (if (or (not org-confirm-elisp-link-function)
9222 (funcall org-confirm-elisp-link-function
9224 (org-add-props cmd nil
9225 'face 'org-warning))))
9226 (message "%s => %s" cmd
9227 (if (equal (string-to-char cmd) ?\()
9228 (eval (read cmd))
9229 (call-interactively (read cmd))))
9230 (error "Abort"))))
9232 ((and (string= type "thisfile")
9233 (run-hook-with-args-until-success
9234 'org-open-link-functions path)))
9236 ((string= type "thisfile")
9237 (if in-emacs
9238 (switch-to-buffer-other-window
9239 (org-get-buffer-for-internal-link (current-buffer)))
9240 (org-mark-ring-push))
9241 (let ((cmd `(org-link-search
9242 ,path
9243 ,(cond ((equal in-emacs '(4)) 'occur)
9244 ((equal in-emacs '(16)) 'org-occur)
9245 (t nil))
9246 ,pos)))
9247 (condition-case nil (eval cmd)
9248 (error (progn (widen) (eval cmd))))))
9250 (t
9251 (browse-url-at-point)))))))
9252 (move-marker org-open-link-marker nil)
9253 (run-hook-with-args 'org-follow-link-hook)))
9255 (defun org-offer-links-in-entry (&optional nth zero)
9256 "Offer links in the current entry and follow the selected link.
9257 If there is only one link, follow it immediately as well.
9258 If NTH is an integer, immediately pick the NTH link found.
9259 If ZERO is a string, check also this string for a link, and if
9260 there is one, offer it as link number zero."
9264 (cnt ?0)
9265 (in-emacs (if (integerp nth) nil nth))
9266 have-zero end links link c)
9267 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9268 (push (match-string 0 zero) links)
9269 (setq cnt (1- cnt) have-zero t))
9270 (save-excursion
9271 (org-back-to-heading t)
9272 (setq end (save-excursion (outline-next-heading) (point)))
9273 (while (re-search-forward re end t)
9274 (push (match-string 0) links))
9275 (setq links (org-uniquify (reverse links))))
9277 (cond
9278 ((null links)
9279 (message "No links"))
9280 ((equal (length links) 1)
9281 (setq link (list (car links))))
9282 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9283 (setq link (nth (if have-zero nth (1- nth)) links)))
9284 (t ; we have to select a link
9285 (save-excursion
9286 (save-window-excursion
9287 (delete-other-windows)
9288 (with-output-to-temp-buffer "*Select Link*"
9289 (mapc (lambda (l)
9290 (if (not (string-match org-bracket-link-regexp l))
9292 (org-remove-angle-brackets l)))
9293 (if (match-end 3)
9295 (match-string 3 l) (match-string 1 l)))
9297 (match-string 1 l))))))
9298 links))
9299 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9300 (message "Select link to open, RET to open all:")
9301 (setq c (read-char-exclusive))
9302 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9303 (when (equal c ?q) (error "Abort"))
9304 (if (equal c ?\C-m)
9305 (setq link links)
9306 (setq nth (- c ?0))
9307 (if have-zero (setq nth (1+ nth)))
9308 (unless (and (integerp nth) (>= (length links) nth))
9309 (error "Invalid link selection"))
9310 (setq link (list (nth (1- nth) links))))))
9311 (if link
9312 (let ((buf (current-buffer)))
9313 (dolist (l link)
9314 (org-open-link-from-string l in-emacs buf))
9315 t)
9316 nil)))
9318 ;; Add special file links that specify the way of opening
9320 (org-add-link-type "file+sys" 'org-open-file-with-system)
9321 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9322 (defun org-open-file-with-system (path)
9323 "Open file at PATH using the system way of opening it."
9324 (org-open-file path 'system))
9325 (defun org-open-file-with-emacs (path)
9326 "Open file at PATH in Emacs."
9327 (org-open-file path 'emacs))
9328 (defun org-remove-file-link-modifiers ()
9329 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9330 (goto-char (point-min))
9332 (org-if-unprotected
9333 (replace-match "file:" t t))))
9334 (eval-after-load "org-exp"
9335 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9336 'org-remove-file-link-modifiers))
9338 ;;;; Time estimates
9340 (defun org-get-effort (&optional pom)
9341 "Get the effort estimate for the current entry."
9342 (org-entry-get pom org-effort-property))
9344 ;;; File search
9346 (defvar org-create-file-search-functions nil
9347 "List of functions to construct the right search string for a file link.
9348 These functions are called in turn with point at the location to
9349 which the link should point.
9351 A function in the hook should first test if it would like to
9352 handle this file type, for example by checking the `major-mode'
9353 or the file extension. If it decides not to handle this file, it
9354 should just return nil to give other functions a chance. If it
9355 does handle the file, it must return the search string to be used
9356 when following the link. The search string will be part of the
9357 file link, given after a double colon, and `org-open-at-point'
9358 will automatically search for it. If special measures must be
9359 taken to make the search successful, another function should be
9360 added to the companion hook `org-execute-file-search-functions',
9361 which see.
9363 A function in this hook may also use `setq' to set the variable
9364 `description' to provide a suggestion for the descriptive text to
9365 be used for this link when it gets inserted into an Org-mode
9368 (defvar org-execute-file-search-functions nil
9369 "List of functions to execute a file search triggered by a link.
9371 Functions added to this hook must accept a single argument, the
9372 search string that was part of the file link, the part after the
9373 double colon. The function must first check if it would like to
9374 handle this search, for example by checking the `major-mode' or
9375 the file extension. If it decides not to handle this search, it
9376 should just return nil to give other functions a chance. If it
9377 does handle the search, it must return a non-nil value to keep
9378 other functions from trying.
9380 Each function can access the current prefix argument through the
9381 variable `current-prefix-argument'. Note that a single prefix is
9382 used to force opening a link in Emacs, so it may be good to only
9383 use a numeric or double prefix to guide the search function.
9385 In case this is needed, a function in this hook can also restore
9386 the window configuration before `org-open-at-point' was called using:
9388 (set-window-configuration org-window-config-before-follow-link)")
9390 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9391 (defun org-link-search (s &optional type avoid-pos)
9392 "Search for a link search option.
9393 If S is surrounded by forward slashes, it is interpreted as a
9394 regular expression. In org-mode files, this will create an `org-occur'
9395 sparse tree. In ordinary files, `occur' will be used to list matches.
9396 If the current buffer is in `dired-mode', grep will be used to search
9397 in all files. If AVOID-POS is given, ignore matches near that position."
9398 (let ((case-fold-search t)
9402 org-emphasis-alist)
9404 (pos (point))
9405 (pre nil) (post nil)
9406 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9407 (cond
9408 ;; First check if there are any special search functions
9409 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9410 ;; Now try the builtin stuff
9411 ((and (equal (string-to-char s0) ?#)
9412 (> (length s0) 1)
9413 (save-excursion
9414 (goto-char (point-min))
9415 (and
9416 (re-search-forward
9418 (setq type 'dedicated
9419 pos (match-beginning 0))))
9420 ;; There is an exact target for this
9421 (goto-char pos)
9422 (org-back-to-heading t)))
9423 ((save-excursion
9424 (goto-char (point-min))
9425 (and
9426 (re-search-forward
9427 (concat "<<" (regexp-quote s0) ">>") nil t)
9428 (setq type 'dedicated
9429 pos (match-beginning 0))))
9430 ;; There is an exact target for this
9431 (goto-char pos))
9433 (save-excursion
9434 (goto-char (point-min))
9435 (and
9436 (re-search-forward
9437 (concat "[^[]" (regexp-quote
9438 (format org-coderef-label-format
9439 (match-string 1 s0))))
9440 nil t)
9441 (setq type 'dedicated
9442 pos (1+ (match-beginning 0))))))
9443 ;; There is a coderef target for this
9444 (goto-char pos))
9446 ;; A regular expression
9447 (cond
9448 ((org-mode-p)
9449 (org-occur (match-string 1 s)))
9450 ;;((eq major-mode 'dired-mode)
9451 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9452 (t (org-do-occur (match-string 1 s)))))
9453 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9454 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9455 (goto-char (point-min))
9456 (cond
9457 ((let (case-fold-search)
9458 (re-search-forward (format org-complex-heading-regexp-format
9459 (regexp-quote s))
9460 nil t))
9461 ;; OK, found a match
9462 (setq type 'dedicated)
9463 (goto-char (match-beginning 0)))
9464 ((and (not org-link-search-inhibit-query)
9465 (eq org-link-search-must-match-exact-headline 'query-to-create)
9466 (y-or-n-p "No match - create this as a new heading? "))
9467 (goto-char (point-max))
9468 (or (bolp) (newline))
9470 (beginning-of-line 0))
9471 (t
9472 (goto-char pos)
9473 (error "No match"))))
9474 (t
9475 ;; A normal search string
9476 (when (equal (string-to-char s) ?*)
9477 ;; Anchor on headlines, post may include tags.
9480 s (substring s 1)))
9481 (remove-text-properties
9482 0 (length s)
9483 '(face nil mouse-face nil keymap nil fontified nil) s)
9484 ;; Make a series of regular expressions to find a match
9493 re4 (concat "[^a-zA-Z_]" re4_)
9495 re1 (concat pre re2 post)
9496 re3 (concat pre (if pre re4_ re4) post)
9497 re5 (concat pre ".*" re4)
9498 re2 (concat pre re2)
9499 re2a (concat pre (if pre re2a_ re2a))
9500 re4 (concat pre (if pre re4_ re4))
9504 ))
9505 (cond
9506 ((eq type 'org-occur) (org-occur reall))
9507 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9508 (t (goto-char (point-min))
9509 (setq type 'fuzzy)
9510 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9511 (org-search-not-self 1 re1 nil t)
9512 (org-search-not-self 1 re2 nil t)
9513 (org-search-not-self 1 re2a nil t)
9514 (org-search-not-self 1 re3 nil t)
9515 (org-search-not-self 1 re4 nil t)
9516 (org-search-not-self 1 re5 nil t)
9517 )
9518 (goto-char (match-beginning 1))
9519 (goto-char pos)
9520 (error "No match"))))))
9521 (and (org-mode-p) (org-show-context 'link-search))
9522 type))
9524 (defun org-search-not-self (group &rest args)
9525 "Execute `re-search-forward', but only accept matches that do not
9526 enclose the position of `org-open-link-marker'."
9527 (let ((m org-open-link-marker))
9528 (catch 'exit
9529 (while (apply 're-search-forward args)
9530 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9531 (goto-char (match-end group))
9532 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9533 (> (match-beginning 0) (marker-position m))
9534 (< (match-end 0) (marker-position m)))
9535 (save-match-data
9536 (or (not (org-in-regexp
9537 org-bracket-link-analytic-regexp 1))
9538 (not (match-end 4)) ; no description
9539 (and (<= (match-beginning 4) (point))
9540 (>= (match-end 4) (point))))))
9541 (throw 'exit (point))))))))
9543 (defun org-get-buffer-for-internal-link (buffer)
9544 "Return a buffer to be used for displaying the link target of internal links."
9545 (cond
9546 ((not org-display-internal-link-with-indirect-buffer)
9547 buffer)
9548 ((string-match "(Clone)$" (buffer-name buffer))
9549 (message "Buffer is already a clone, not making another one")
9550 ;; we also do not modify visibility in this case
9551 buffer)
9552 (t ; make a new indirect buffer for displaying the link
9553 (let* ((bn (buffer-name buffer))
9554 (ibn (concat bn "(Clone)"))
9555 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9556 (with-current-buffer ib (org-overview))
9557 ib))))
9559 (defun org-do-occur (regexp &optional cleanup)
9560 "Call the Emacs command `occur'.
9561 If CLEANUP is non-nil, remove the printout of the regular expression
9562 in the *Occur* buffer. This is useful if the regex is long and not useful
9563 to read."
9564 (occur regexp)
9565 (when cleanup
9566 (let ((cwin (selected-window)) win beg end)
9567 (when (setq win (get-buffer-window "*Occur*"))
9568 (select-window win))
9569 (goto-char (point-min))
9570 (when (re-search-forward "match[a-z]+" nil t)
9571 (setq beg (match-end 0))
9573 (setq end (1- (match-beginning 0)))))
9574 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9575 (goto-char (point-min))
9576 (select-window cwin))))
9578 ;;; The mark ring for links jumps
9580 (defvar org-mark-ring nil
9581 "Mark ring for positions before jumps in Org-mode.")
9582 (defvar org-mark-ring-last-goto nil
9583 "Last position in the mark ring used to go back.")
9584 ;; Fill and close the ring
9585 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9586 (loop for i from 1 to org-mark-ring-length do
9587 (push (make-marker) org-mark-ring))
9588 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9589 org-mark-ring)
9591 (defun org-mark-ring-push (&optional pos buffer)
9592 "Put the current position or POS into the mark ring and rotate it."
9593 (interactive)
9594 (setq pos (or pos (point)))
9595 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9596 (move-marker (car org-mark-ring)
9597 (or pos (point))
9598 (or buffer (current-buffer)))
9599 (message "%s"
9600 (substitute-command-keys
9603 (defun org-mark-ring-goto (&optional n)
9604 "Jump to the previous position in the mark ring.
9605 With prefix arg N, jump back that many stored positions. When
9606 called several times in succession, walk through the entire ring.
9607 Org-mode commands jumping to a different position in the current file,
9608 or to another Org-mode file, automatically push the old position
9609 onto the ring."
9610 (interactive "p")
9611 (let (p m)
9612 (if (eq last-command this-command)
9613 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9614 (setq p org-mark-ring))
9615 (setq org-mark-ring-last-goto p)
9616 (setq m (car p))
9617 (switch-to-buffer (marker-buffer m))
9618 (goto-char m)
9619 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9621 (defun org-remove-angle-brackets (s)
9622 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9623 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9624 s)
9625 (defun org-add-angle-brackets (s)
9626 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9627 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9628 s)
9629 (defun org-remove-double-quotes (s)
9632 s)
9634 ;;; Following specific links
9636 (defun org-follow-timestamp-link ()
9637 (cond
9638 ((org-at-date-range-p t)
9639 (let ((org-agenda-start-on-weekday)
9640 (t1 (match-string 1))
9641 (t2 (match-string 2)))
9642 (setq t1 (time-to-days (org-time-string-to-time t1))
9643 t2 (time-to-days (org-time-string-to-time t2)))
9644 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9645 ((org-at-timestamp-p t)
9646 (org-agenda-list nil (time-to-days (org-time-string-to-time
9647 (substring (match-string 1) 0 10)))
9648 1))
9649 (t (error "This should not happen"))))
9652 ;;; Following file links
9653 (defvar org-wait nil)
9654 (defun org-open-file (path &optional in-emacs line search)
9655 "Open the file at PATH.
9656 First, this expands any special file name abbreviations. Then the
9657 configuration variable `org-file-apps' is checked if it contains an
9658 entry for this file type, and if yes, the corresponding command is launched.
9660 If no application is found, Emacs simply visits the file.
9662 With optional prefix argument IN-EMACS, Emacs will visit the file.
9664 prefix arg, Org tries to avoid opening in Emacs
9665 and to use an external application to visit the file.
9667 Optional LINE specifies a line to go to, optional SEARCH a string
9668 to search for. If LINE or SEARCH is given, the file will be
9669 opened in Emacs, unless an entry from org-file-apps that makes
9670 use of groups in a regexp matches.
9671 If the file does not exist, an error is thrown."
9672 (let* ((file (if (equal path "")
9673 buffer-file-name
9674 (substitute-in-file-name (expand-file-name path))))
9675 (file-apps (append org-file-apps (org-default-apps)))
9676 (apps (org-remove-if
9677 'org-file-apps-entry-match-against-dlink-p file-apps))
9678 (apps-dlink (org-remove-if-not
9679 'org-file-apps-entry-match-against-dlink-p file-apps))
9680 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9681 (dirp (if remp nil (file-directory-p file)))
9682 (file (if (and dirp org-open-directory-means-index-dot-org)
9683 (concat (file-name-as-directory file) "index.org")
9684 file))
9685 (a-m-a-p (assq 'auto-mode apps))
9686 (dfile (downcase file))
9687 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9688 (link (cond ((and (eq line nil)
9689 (eq search nil))
9690 file)
9691 (line
9692 (concat file "::" (number-to-string line)))
9693 (search
9694 (concat file "::" search))))
9695 (dlink (downcase link))
9696 (old-buffer (current-buffer))
9697 (old-pos (point))
9698 (old-mode major-mode)
9699 ext cmd link-match-data)
9701 (setq ext (match-string 1 dfile))
9703 (setq ext (match-string 1 dfile))))
9704 (cond
9705 ((member in-emacs '((16) system))
9706 (setq cmd (cdr (assoc 'system apps))))
9707 (in-emacs (setq cmd 'emacs))
9708 (t
9709 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9710 (and dirp (cdr (assoc 'directory apps)))
9711 ; first, try matching against apps-dlink
9712 ; if we get a match here, store the match data for later
9713 (let ((match (assoc-default dlink apps-dlink
9714 'string-match)))
9715 (if match
9716 (progn (setq link-match-data (match-data))
9717 match)
9718 (progn (setq in-emacs (or in-emacs line search))
9719 nil))) ; if we have no match in apps-dlink,
9720 ; always open the file in emacs if line or search
9721 ; is given (for backwards compatibility)
9722 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9723 'string-match)
9724 (cdr (assoc ext apps))
9725 (cdr (assoc t apps))))))
9726 (when (eq cmd 'system)
9727 (setq cmd (cdr (assoc 'system apps))))
9728 (when (eq cmd 'default)
9729 (setq cmd (cdr (assoc t apps))))
9730 (when (eq cmd 'mailcap)
9731 (require 'mailcap)
9732 (mailcap-parse-mailcaps)
9733 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9734 (command (mailcap-mime-info mime-type)))
9735 (if (stringp command)
9736 (setq cmd command)
9737 (setq cmd 'emacs))))
9738 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9739 (not (file-exists-p file))
9740 (not org-open-non-existing-files))
9741 (error "No such file: %s" file))
9742 (cond
9744 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9746 (setq cmd (replace-match "%s" t t cmd)))
9747 (while (string-match "%s" cmd)
9748 (setq cmd (replace-match
9749 (save-match-data
9750 (shell-quote-argument
9751 (convert-standard-filename file)))
9752 t t cmd)))
9754 ;; Replace "%1", "%2" etc. in command with group matches from regex
9755 (save-match-data
9756 (let ((match-index 1)
9757 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9758 (set-match-data link-match-data)
9759 (while (<= match-index number-of-groups)
9760 (let ((regex (concat "%" (number-to-string match-index)))
9761 (replace-with (match-string match-index dlink)))
9762 (while (string-match regex cmd)
9763 (setq cmd (replace-match replace-with t t cmd))))
9764 (setq match-index (+ match-index 1)))))
9766 (save-window-excursion
9767 (start-process-shell-command cmd nil cmd)
9768 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9769 ))
9770 ((or (stringp cmd)
9771 (eq cmd 'emacs))
9772 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9773 (widen)
9774 (if line (org-goto-line line)
9775 (if search (org-link-search search))))
9776 ((consp cmd)
9777 (let ((file (convert-standard-filename file)))
9778 (save-match-data
9779 (set-match-data link-match-data)
9780 (eval cmd))))
9781 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9782 (and (org-mode-p) (eq old-mode 'org-mode)
9783 (or (not (equal old-buffer (current-buffer)))
9784 (not (equal old-pos (point))))
9785 (org-mark-ring-push old-pos old-buffer))))
9787 (defun org-file-apps-entry-match-against-dlink-p (entry)
9788 "This function returns non-nil if `entry' uses a regular
9789 expression which should be matched against the whole link by
9790 org-open-file.
9792 It assumes that is the case when the entry uses a regular
9793 expression which has at least one grouping construct and the
9794 action is either a lisp form or a command string containing
9795 '%1', i.e. using at least one subexpression match as a
9796 parameter."
9797 (let ((selector (car entry))
9798 (action (cdr entry)))
9799 (if (stringp selector)
9800 (and (> (regexp-opt-depth selector) 0)
9801 (or (and (stringp action)
9802 (string-match "%[0-9]" action))
9803 (consp action)))
9804 nil)))
9806 (defun org-default-apps ()
9807 "Return the default applications for this operating system."
9808 (cond
9809 ((eq system-type 'darwin)
9810 org-file-apps-defaults-macosx)
9811 ((eq system-type 'windows-nt)
9812 org-file-apps-defaults-windowsnt)
9813 (t org-file-apps-defaults-gnu)))
9815 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9816 "Convert extensions to regular expressions in the cars of LIST.
9817 Also, weed out any non-string entries, because the return value is used
9818 only for regexp matching.
9819 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9820 point to the symbol `emacs', indicating that the file should
9821 be opened in Emacs."
9822 (append
9823 (delq nil
9824 (mapcar (lambda (x)
9825 (if (not (stringp (car x)))
9826 nil
9828 x
9830 list))
9831 (if add-auto-mode
9832 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9834 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9835 (defun org-file-remote-p (file)
9836 "Test whether FILE specifies a location on a remote system.
9837 Return non-nil if the location is indeed remote.
9841 (cond ((fboundp 'file-remote-p)
9842 (file-remote-p file))
9843 ((fboundp 'tramp-handle-file-remote-p)
9844 (tramp-handle-file-remote-p file))
9845 ((and (boundp 'ange-ftp-name-format)
9846 (string-match (car ange-ftp-name-format) file))
9847 t)
9848 (t nil)))
9851 ;;;; Refiling
9853 (defun org-get-org-file ()
9854 "Read a filename, with default directory `org-directory'."
9855 (let ((default (or org-default-notes-file remember-data-file)))
9856 (read-file-name (format "File name [%s]: " default)
9857 (file-name-as-directory org-directory)
9858 default)))
9860 (defun org-notes-order-reversed-p ()
9861 "Check if the current file should receive notes in reversed order."
9862 (cond
9863 ((not org-reverse-note-order) nil)
9864 ((eq t org-reverse-note-order) t)
9865 ((not (listp org-reverse-note-order)) nil)
9866 (t (catch 'exit
9867 (let ((all org-reverse-note-order)
9868 entry)
9869 (while (setq entry (pop all))
9870 (if (string-match (car entry) buffer-file-name)
9871 (throw 'exit (cdr entry))))
9872 nil)))))
9874 (defvar org-refile-target-table nil
9875 "The list of refile targets, created by `org-refile'.")
9877 (defvar org-agenda-new-buffers nil
9878 "Buffers created to visit agenda files.")
9880 (defvar org-refile-cache nil
9881 "Cache for refile targets.")
9884 (defvar org-refile-markers nil
9885 "All the markers used for caching refile locations.")
9887 (defun org-refile-marker (pos)
9888 "Get a new refile marker, but only if caching is in use."
9889 (if (not org-refile-use-cache)
9890 pos
9891 (let ((m (make-marker)))
9892 (move-marker m pos)
9893 (push m org-refile-markers)
9894 m)))
9896 (defun org-refile-cache-clear ()
9897 "Clear the refile cache and disable all the markers."
9898 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
9899 (setq org-refile-markers nil)
9900 (setq org-refile-cache nil)
9901 (message "Refile cache has been cleared"))
9903 (defun org-refile-cache-check-set (set)
9904 "Check if all the markers in the cache still have live buffers."
9905 (let (marker)
9906 (catch 'exit
9907 (while (and set (setq marker (nth 3 (pop set))))
9908 ;; if org-refile-use-outline-path is 'file, marker may be nil
9909 (when (and marker (null (marker-buffer marker)))
9910 (message "not found") (sit-for 3)
9911 (throw 'exit nil)))
9912 t)))
9914 (defun org-refile-cache-put (set &rest identifiers)
9915 "Push the refile targets SET into the cache, under IDENTIFIERS."
9916 (let* ((key (sha1 (prin1-to-string identifiers)))
9917 (entry (assoc key org-refile-cache)))
9918 (if entry
9919 (setcdr entry set)
9920 (push (cons key set) org-refile-cache))))
9922 (defun org-refile-cache-get (&rest identifiers)
9923 "Retrieve the cached value for refile targets given by IDENTIFIERS."
9924 (cond
9925 ((not org-refile-cache) nil)
9926 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
9927 (t
9928 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
9929 org-refile-cache))))
9930 (and set (org-refile-cache-check-set set) set)))))
9932 (defun org-get-refile-targets (&optional default-buffer)
9933 "Produce a table with refile targets."
9934 (let ((case-fold-search nil)
9935 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
9936 (entries (or org-refile-targets '((nil . (:level . 1)))))
9937 targets tgs txt re files f desc descre fast-path-p level pos0)
9938 (message "Getting targets...")
9939 (with-current-buffer (or default-buffer (current-buffer))
9940 (while (setq entry (pop entries))
9941 (setq files (car entry) desc (cdr entry))
9942 (setq fast-path-p nil)
9943 (cond
9944 ((null files) (setq files (list (current-buffer))))
9945 ((eq files 'org-agenda-files)
9946 (setq files (org-agenda-files 'unrestricted)))
9947 ((and (symbolp files) (fboundp files))
9948 (setq files (funcall files)))
9949 ((and (symbolp files) (boundp files))
9950 (setq files (symbol-value files))))
9951 (if (stringp files) (setq files (list files)))
9952 (cond
9953 ((eq (car desc) :tag)
9955 ((eq (car desc) :todo)
9957 ((eq (car desc) :regexp)
9958 (setq descre (cdr desc)))
9959 ((eq (car desc) :level)
9961 (if org-odd-levels-only
9962 (1- (* 2 (cdr desc)))
9963 (cdr desc)))
9965 ((eq (car desc) :maxlevel)
9966 (setq fast-path-p t)
9968 (if org-odd-levels-only
9969 (1- (* 2 (cdr desc)))
9970 (cdr desc)))
9972 (t (error "Bad refiling target description %s" desc)))
9973 (while (setq f (pop files))
9974 (with-current-buffer
9975 (if (bufferp f) f (org-get-agenda-file-buffer f))
9976 (or
9977 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
9978 (progn
9979 (if (bufferp f) (setq f (buffer-file-name
9980 (buffer-base-buffer f))))
9981 (setq f (and f (expand-file-name f)))
9982 (if (eq org-refile-use-outline-path 'file)
9983 (push (list (file-name-nondirectory f) f nil nil) tgs))
9984 (save-excursion
9985 (save-restriction
9986 (widen)
9987 (goto-char (point-min))
9988 (while (re-search-forward descre nil t)
9989 (goto-char (setq pos0 (point-at-bol)))
9990 (catch 'next
9991 (when org-refile-target-verify-function
9992 (save-match-data
9993 (or (funcall org-refile-target-verify-function)
9994 (throw 'next t))))
9995 (when (looking-at org-complex-heading-regexp)
9996 (setq level (org-reduced-level
9997 (- (match-end 1) (match-beginning 1)))
9998 txt (org-link-display-format (match-string 4))
10000 re (format org-complex-heading-regexp-format
10001 (regexp-quote (match-string 4))))
10002 (when org-refile-use-outline-path
10003 (setq txt (mapconcat
10004 'org-protect-slash
10005 (append
10006 (if (eq org-refile-use-outline-path
10007 'file)
10008 (list (file-name-nondirectory
10009 (buffer-file-name
10010 (buffer-base-buffer))))
10011 (if (eq org-refile-use-outline-path
10012 'full-file-path)
10013 (list (buffer-file-name
10014 (buffer-base-buffer)))))
10015 (org-get-outline-path fast-path-p
10016 level txt)
10017 (list txt))
10018 "/")))
10019 (push (list txt f re (org-refile-marker (point)))
10020 tgs)))
10021 (when (= (point) pos0)
10022 ;; verification function has not moved point
10023 (goto-char (point-at-eol))))))))
10024 (when org-refile-use-cache
10025 (org-refile-cache-put tgs (buffer-file-name) descre))
10026 (setq targets (append tgs targets))
10027 ))))
10028 (message "Getting targets...done")
10029 (nreverse targets)))
10031 (defun org-protect-slash (s)
10032 (while (string-match "/" s)
10034 s)
10036 (defvar org-olpa (make-vector 20 nil))
10038 (defun org-get-outline-path (&optional fastp level heading)
10039 "Return the outline path to the current entry, as a list.
10041 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10042 routine which makes outline path derivations for an entire file,
10043 avoiding backtracing. Refile target collection makes use of that."
10044 (if fastp
10045 (progn
10046 (if (> level 19)
10047 (error "Outline path failure, more than 19 levels"))
10048 (loop for i from level upto 19 do
10049 (aset org-olpa i nil))
10050 (prog1
10051 (delq nil (append org-olpa nil))
10052 (aset org-olpa level heading)))
10053 (let (rtn case-fold-search)
10054 (save-excursion
10055 (save-restriction
10056 (widen)
10057 (while (org-up-heading-safe)
10058 (when (looking-at org-complex-heading-regexp)
10059 (push (org-match-string-no-properties 4) rtn)))
10060 rtn)))))
10062 (defun org-format-outline-path (path &optional width prefix)
10063 "Format the outline path PATH for display.
10064 Width is the maximum number of characters that is available.
10065 Prefix is a prefix to be included in the returned string,
10066 such as the file name."
10067 (setq width (or width 79))
10068 (if prefix (setq width (- width (length prefix))))
10069 (if (not path)
10070 (or prefix "")
10071 (let* ((nsteps (length path))
10072 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10073 (maxwidth (if (<= total-width width)
10074 10000 ;; everything fits
10075 ;; we need to shorten the level headings
10076 (/ (- width nsteps) nsteps)))
10077 (org-odd-levels-only nil)
10078 (n 0)
10079 (total (1+ (length prefix))))
10080 (setq maxwidth (max maxwidth 10))
10081 (concat prefix
10082 (mapconcat
10083 (lambda (h)
10084 (setq n (1+ n))
10085 (if (and (= n nsteps) (< maxwidth 10000))
10086 (setq maxwidth (- total-width total)))
10087 (if (< (length h) maxwidth)
10088 (progn (setq total (+ total (length h) 1)) h)
10089 (setq h (substring h 0 (- maxwidth 2))
10090 total (+ total maxwidth 1))
10092 (setq h (substring h 0 (match-beginning 0))))
10093 (setq h (concat h "..")))
10094 (org-add-props h nil 'face
10095 (nth (% (1- n) org-n-level-faces)
10096 org-level-faces))
10097 h)
10098 path "/")))))
10100 (defun org-display-outline-path (&optional file current)
10101 "Display the current outline path in the echo area."
10102 (interactive "P")
10103 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10104 (case-fold-search nil)
10105 (path (and (org-mode-p) (org-get-outline-path))))
10106 (if current (setq path (append path
10107 (save-excursion
10108 (org-back-to-heading t)
10109 (if (looking-at org-complex-heading-regexp)
10110 (list (match-string 4)))))))
10111 (message "%s"
10112 (org-format-outline-path
10113 path
10114 (1- (frame-width))
10115 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10117 (defvar org-refile-history nil
10118 "History for refiling operations.")
10120 (defvar org-after-refile-insert-hook nil
10121 "Hook run after `org-refile' has inserted its stuff at the new location.
10122 Note that this is still *before* the stuff will be removed from
10123 the *old* location.")
10125 (defvar org-capture-last-stored-marker)
10126 (defun org-refile (&optional goto default-buffer rfloc)
10127 "Move the entry at point to another heading.
10128 The list of target headings is compiled using the information in
10129 `org-refile-targets', which see. This list is created before each use
10130 and will therefore always be up-to-date.
10132 At the target location, the entry is filed as a subitem of the target heading.
10133 Depending on `org-reverse-note-order', the new subitem will either be the
10134 first or the last subitem.
10136 If there is an active region, all entries in that region will be moved.
10137 However, the region must fulfill the requirement that the first heading
10138 is the first one sets the top-level of the moved text - at most siblings
10139 below it are allowed.
10141 With prefix arg GOTO, the command will only visit the target location,
10142 not actually move anything.
10144 go to the location where the last refiling
10145 operation has put the subtree.
10146 With a prefix argument of `2', refile to the running clock.
10148 RFLOC can be a refile location obtained in a different way.
10150 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10152 If you are using target caching (see `org-refile-use-cache'),
10153 You have to clear the target cache in order to find new targets.
10154 This can be done with a 0 prefix: `C-0 C-c C-w'"
10155 (interactive "P")
10156 (if (member goto '(0 (64)))
10157 (org-refile-cache-clear)
10158 (let* ((cbuf (current-buffer))
10159 (regionp (org-region-active-p))
10160 (region-start (and regionp (region-beginning)))
10161 (region-end (and regionp (region-end)))
10162 (region-length (and regionp (- region-end region-start)))
10163 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10164 pos it nbuf file re level reversed)
10165 (setq last-command nil)
10166 (when regionp
10167 (goto-char region-start)
10168 (or (bolp) (goto-char (point-at-bol)))
10169 (setq region-start (point))
10170 (unless (org-kill-is-subtree-p
10171 (buffer-substring region-start region-end))
10172 (error "The region is not a (sequence of) subtree(s)")))
10173 (if (equal goto '(16))
10174 (org-refile-goto-last-stored)
10175 (when (or
10176 (and (equal goto 2)
10177 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10178 (prog1
10179 (setq it (list (or org-clock-heading "running clock")
10180 (buffer-file-name
10181 (marker-buffer org-clock-hd-marker))
10182 ""
10183 (marker-position org-clock-hd-marker)))
10184 (setq goto nil)))
10185 (setq it (or rfloc
10186 (save-excursion
10187 (org-refile-get-location
10188 (if goto "Goto: " "Refile to: ") default-buffer
10189 org-refile-allow-creating-parent-nodes)))))
10190 (setq file (nth 1 it)
10191 re (nth 2 it)
10192 pos (nth 3 it))
10193 (if (and (not goto)
10194 pos
10195 (equal (buffer-file-name) file)
10196 (if regionp
10197 (and (>= pos region-start)
10198 (<= pos region-end))
10199 (and (>= pos (point))
10200 (< pos (save-excursion
10201 (org-end-of-subtree t t))))))
10202 (error "Cannot refile to position inside the tree or region"))
10204 (setq nbuf (or (find-buffer-visiting file)
10205 (find-file-noselect file)))
10206 (if goto
10207 (progn
10208 (switch-to-buffer nbuf)
10209 (goto-char pos)
10210 (org-show-context 'org-goto))
10211 (if regionp
10212 (progn
10213 (org-kill-new (buffer-substring region-start region-end))
10214 (org-save-markers-in-region region-start region-end))
10215 (org-copy-subtree 1 nil t))
10216 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10217 (find-file-noselect file)))
10218 (setq reversed (org-notes-order-reversed-p))
10219 (save-excursion
10220 (save-restriction
10221 (widen)
10222 (if pos
10223 (progn
10224 (goto-char pos)
10225 (looking-at outline-regexp)
10226 (setq level (org-get-valid-level (funcall outline-level) 1))
10227 (goto-char
10228 (if reversed
10229 (or (outline-next-heading) (point-max))
10230 (or (save-excursion (org-get-next-sibling))
10231 (org-end-of-subtree t t)
10232 (point-max)))))
10233 (setq level 1)
10234 (if (not reversed)
10235 (goto-char (point-max))
10236 (goto-char (point-min))
10237 (or (outline-next-heading) (goto-char (point-max)))))
10238 (if (not (bolp)) (newline))
10239 (org-paste-subtree level)
10240 (when org-log-refile
10241 (org-add-log-setup 'refile nil nil 'findpos
10242 org-log-refile)
10243 (unless (eq org-log-refile 'note)
10244 (save-excursion (org-add-log-note))))
10245 (and org-auto-align-tags (org-set-tags nil t))
10246 (bookmark-set "org-refile-last-stored")
10247 ;; If we are refiling for capture, make sure that the
10248 ;; last-capture pointers point here
10249 (when (org-bound-and-true-p org-refile-for-capture)
10250 (bookmark-set "org-capture-last-stored-marker")
10251 (move-marker org-capture-last-stored-marker (point)))
10252 (if (fboundp 'deactivate-mark) (deactivate-mark))
10253 (run-hooks 'org-after-refile-insert-hook))))
10254 (if regionp
10255 (delete-region (point) (+ (point) region-length))
10256 (org-cut-subtree))
10257 (when (featurep 'org-inlinetask)
10258 (org-inlinetask-remove-END-maybe))
10259 (setq org-markers-to-move nil)
10262 (defun org-refile-goto-last-stored ()
10263 "Go to the location where the last refile was stored."
10264 (interactive)
10265 (bookmark-jump "org-refile-last-stored")
10266 (message "This is the location of the last refile"))
10268 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10269 "Prompt the user for a refile location, using PROMPT."
10270 (let ((org-refile-targets org-refile-targets)
10271 (org-refile-use-outline-path org-refile-use-outline-path))
10272 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
10273 (unless org-refile-target-table
10274 (error "No refile targets"))
10275 (let* ((cbuf (current-buffer))
10276 (partial-completion-mode nil)
10277 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10278 (cfunc (if (and org-refile-use-outline-path
10279 org-outline-path-complete-in-steps)
10280 'org-olpath-completing-read
10281 'org-icompleting-read))
10282 (extra (if org-refile-use-outline-path "/" ""))
10283 (filename (and cfn (expand-file-name cfn)))
10284 (tbl (mapcar
10285 (lambda (x)
10286 (if (and (not (member org-refile-use-outline-path
10287 '(file full-file-path)))
10288 (not (equal filename (nth 1 x))))
10289 (cons (concat (car x) extra " ("
10290 (file-name-nondirectory (nth 1 x)) ")")
10291 (cdr x))
10292 (cons (concat (car x) extra) (cdr x))))
10293 org-refile-target-table))
10294 (completion-ignore-case t)
10295 pa answ parent-target child parent old-hist)
10296 (setq old-hist org-refile-history)
10297 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10298 nil 'org-refile-history))
10299 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10300 (org-refile-check-position pa)
10301 (if pa
10302 (progn
10303 (when (or (not org-refile-history)
10304 (not (eq old-hist org-refile-history))
10305 (not (equal (car pa) (car org-refile-history))))
10306 (setq org-refile-history
10307 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10308 org-refile-history
10309 (cdr org-refile-history))))
10310 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10311 (pop org-refile-history)))
10312 pa)
10314 (progn
10315 (setq parent (match-string 1 answ)
10316 child (match-string 2 answ))
10317 (setq parent-target (or (assoc parent tbl)
10318 (assoc (concat parent "/") tbl)))
10319 (when (and parent-target
10320 (or (eq new-nodes t)
10321 (and (eq new-nodes 'confirm)
10323 child)))))
10324 (org-refile-new-child parent-target child)))
10325 (error "Invalid target location")))))
10327 (defun org-refile-check-position (refile-pointer)
10328 "Check if the refile pointer matches the readline to which it points."
10329 (let* ((file (nth 1 refile-pointer))
10330 (re (nth 2 refile-pointer))
10331 (pos (nth 3 refile-pointer))
10332 buffer)
10333 (when (org-string-nw-p re)
10334 (setq buffer (if (markerp pos)
10335 (marker-buffer pos)
10336 (or (find-buffer-visiting file)
10337 (find-file-noselect file))))
10338 (with-current-buffer buffer
10339 (save-excursion
10340 (save-restriction
10341 (widen)
10342 (goto-char pos)
10343 (beginning-of-line 1)
10344 (unless (org-looking-at-p re)
10345 (error "Invalid refile position, please rebuild the cache"))))))))
10347 (defun org-refile-new-child (parent-target child)
10348 "Use refile target PARENT-TARGET to add new CHILD below it."
10349 (unless parent-target
10350 (error "Cannot find parent for new node"))
10351 (let ((file (nth 1 parent-target))
10352 (pos (nth 3 parent-target))
10353 level)
10354 (with-current-buffer (or (find-buffer-visiting file)
10355 (find-file-noselect file))
10356 (save-excursion
10357 (save-restriction
10358 (widen)
10359 (if pos
10360 (goto-char pos)
10361 (goto-char (point-max))
10362 (if (not (bolp)) (newline)))
10363 (when (looking-at outline-regexp)
10364 (setq level (funcall outline-level))
10365 (org-end-of-subtree t t))
10366 (org-back-over-empty-lines)
10368 (if pos (org-get-valid-level level 1) 1) ?*)
10370 (beginning-of-line 0)
10371 (list (concat (car parent-target) "/" child) file "" (point)))))))
10373 (defun org-olpath-completing-read (prompt collection &rest args)
10374 "Read an outline path like a file name."
10375 (let ((thetable collection)
10376 (org-completion-use-ido nil) ; does not work with ido.
10377 (org-completion-use-iswitchb nil)) ; or iswitchb
10378 (apply
10379 'org-icompleting-read prompt
10380 (lambda (string predicate &optional flag)
10381 (let (rtn r f (l (length string)))
10382 (cond
10383 ((eq flag nil)
10384 ;; try completion
10385 (try-completion string thetable))
10386 ((eq flag t)
10387 ;; all-completions
10388 (setq rtn (all-completions string thetable predicate))
10389 (mapcar
10390 (lambda (x)
10391 (setq r (substring x l))
10392 (if (string-match " ([^)]*)$" x)
10393 (setq f (match-string 0 x))
10394 (setq f ""))
10395 (if (string-match "/" r)
10396 (concat string (substring r 0 (match-end 0)) f)
10397 x))
10398 rtn))
10399 ((eq flag 'lambda)
10400 ;; exact match?
10401 (assoc string thetable)))
10402 ))
10403 args)))
10405 ;;;; Dynamic blocks
10407 (defun org-find-dblock (name)
10408 "Find the first dynamic block with name NAME in the buffer.
10409 If not found, stay at current position and return nil."
10410 (let (pos)
10411 (save-excursion
10412 (goto-char (point-min))
10414 nil t)
10415 (match-beginning 0))))
10416 (if pos (goto-char pos))
10417 pos))
10419 (defconst org-dblock-start-re
10421 "Matches the start line of a dynamic block, with parameters.")
10424 "Matches the end of a dynamic block.")
10426 (defun org-create-dblock (plist)
10427 "Create a dynamic block section, with parameters taken from PLIST.
10428 PLIST must contain a :name entry which is used as name of the block."
10430 (end-of-line 1)
10431 (newline))
10432 (let ((col (current-column))
10433 (name (plist-get plist :name)))
10434 (insert "#+BEGIN: " name)
10435 (while plist
10436 (if (eq (car plist) :name)
10437 (setq plist (cddr plist))
10438 (insert " " (prin1-to-string (pop plist)))))
10440 (beginning-of-line -2)))
10442 (defun org-prepare-dblock ()
10443 "Prepare dynamic block for refresh.
10444 This empties the block, puts the cursor at the insert position and returns
10445 the property list including an extra property :name with the block name."
10446 (unless (looking-at org-dblock-start-re)
10447 (error "Not at a dynamic block"))
10448 (let* ((begdel (1+ (match-end 0)))
10449 (name (org-no-properties (match-string 1)))
10450 (params (append (list :name name)
10451 (read (concat "(" (match-string 3) ")")))))
10452 (save-excursion
10453 (beginning-of-line 1)
10455 (setq params (plist-put params :indentation-column (current-column))))
10456 (unless (re-search-forward org-dblock-end-re nil t)
10457 (error "Dynamic block not terminated"))
10458 (setq params
10459 (append params
10460 (list :content (buffer-substring
10461 begdel (match-beginning 0)))))
10462 (delete-region begdel (match-beginning 0))
10463 (goto-char begdel)
10464 (open-line 1)
10465 params))
10467 (defun org-map-dblocks (&optional command)
10468 "Apply COMMAND to all dynamic blocks in the current buffer.
10469 If COMMAND is not given, use `org-update-dblock'."
10470 (let ((cmd (or command 'org-update-dblock)))
10471 (save-excursion
10472 (goto-char (point-min))
10473 (while (re-search-forward org-dblock-start-re nil t)
10474 (goto-char (match-beginning 0))
10475 (save-excursion
10476 (condition-case nil
10477 (funcall cmd)
10478 (error (message "Error during update of dynamic block"))))
10479 (unless (re-search-forward org-dblock-end-re nil t)
10480 (error "Dynamic block not terminated"))))))
10482 (defun org-dblock-update (&optional arg)
10483 "User command for updating dynamic blocks.
10484 Update the dynamic block at point. With prefix ARG, update all dynamic
10485 blocks in the buffer."
10486 (interactive "P")
10487 (if arg
10488 (org-update-all-dblocks)
10489 (or (looking-at org-dblock-start-re)
10490 (org-beginning-of-dblock))
10491 (org-update-dblock)))
10493 (defun org-update-dblock ()
10494 "Update the dynamic block at point.
10495 This means to empty the block, parse for parameters and then call
10496 the correct writing function."
10497 (interactive)
10498 (save-window-excursion
10499 (let* ((pos (point))
10500 (line (org-current-line))
10501 (params (org-prepare-dblock))
10502 (name (plist-get params :name))
10503 (indent (plist-get params :indentation-column))
10504 (cmd (intern (concat "org-dblock-write:" name))))
10505 (message "Updating dynamic block `%s' at line %d..." name line)
10506 (funcall cmd params)
10507 (message "Updating dynamic block `%s' at line %d...done" name line)
10508 (goto-char pos)
10509 (when (and indent (> indent 0))
10510 (setq indent (make-string indent ?\ ))
10511 (save-excursion
10512 (org-beginning-of-dblock)
10513 (forward-line 1)
10514 (while (not (looking-at org-dblock-end-re))
10515 (insert indent)
10516 (beginning-of-line 2))
10517 (when (looking-at org-dblock-end-re)
10519 (replace-match ""))
10520 (insert indent)))))))
10522 (defun org-beginning-of-dblock ()
10523 "Find the beginning of the dynamic block at point.
10524 Error if there is no such block at point."
10525 (let ((pos (point))
10526 beg)
10527 (end-of-line 1)
10528 (if (and (re-search-backward org-dblock-start-re nil t)
10529 (setq beg (match-beginning 0))
10530 (re-search-forward org-dblock-end-re nil t)
10531 (> (match-end 0) pos))
10532 (goto-char beg)
10533 (goto-char pos)
10534 (error "Not in a dynamic block"))))
10536 (defun org-update-all-dblocks ()
10537 "Update all dynamic blocks in the buffer.
10538 This function can be used in a hook."
10539 (interactive)
10540 (when (org-mode-p)
10541 (org-map-dblocks 'org-update-dblock)))
10544 ;;;; Completion
10546 (defconst org-additional-option-like-keywords
10547 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10548 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10549 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10550 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10551 "BEGIN:" "END:"
10552 "ORGTBL" "TBLFM:" "TBLNAME:"
10553 "BEGIN_EXAMPLE" "END_EXAMPLE"
10554 "BEGIN_QUOTE" "END_QUOTE"
10555 "BEGIN_VERSE" "END_VERSE"
10556 "BEGIN_CENTER" "END_CENTER"
10557 "BEGIN_SRC" "END_SRC"
10558 "BEGIN_RESULT" "END_RESULT"
10559 "SOURCE:" "SRCNAME:" "FUNCTION:"
10560 "RESULTS:"
10561 "HEADER:" "HEADERS:"
10562 "BABEL:"
10563 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10564 "CAPTION:" "LABEL:"
10565 "SETUPFILE:"
10566 "INCLUDE:"
10567 "BIND:"
10568 "MACRO:"))
10570 (defcustom org-structure-template-alist
10571 '(
10584 ("L" "#+latex: "
10588 ("H" "#+html: "
10591 ("A" "#+ascii: ")
10592 ("i" "#+include %file ?"
10594 )
10595 "Structure completion elements.
10596 This is a list of abbreviation keys and values. The value gets inserted
10597 if you type `<' followed by the key and then press the completion key,
10598 usually `M-TAB'. %file will be replaced by a file name after prompting
10599 for the file using completion.
10600 There are two templates for each key, the first uses the original Org syntax,
10601 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10602 the default when the /org-mtags.el/ module has been loaded. See also the
10603 variable `org-mtags-prefer-muse-templates'.
10604 This is an experimental feature, it is undecided if it is going to stay in."
10605 :group 'org-completion
10606 :type '(repeat
10607 (string :tag "Key")
10608 (string :tag "Template")
10609 (string :tag "Muse Template")))
10611 (defun org-try-structure-completion ()
10612 "Try to complete a structure template before point.
10614 expands them."
10615 (let ((l (buffer-substring (point-at-bol) (point)))
10616 a)
10619 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10620 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10621 (match-beginning 1)) a)
10622 t)))
10624 (defun org-complete-expand-structure-template (start cell)
10625 "Expand a structure template."
10626 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10627 (rpl (nth (if musep 2 1) cell))
10628 (ind ""))
10629 (delete-region start (point))
10631 (cond
10632 ((bolp))
10634 (setq ind (buffer-substring (point-at-bol) (point))))
10635 (t (newline))))
10636 (setq start (point))
10637 (if (string-match "%file" rpl)
10638 (setq rpl (replace-match
10639 (concat
10641 (save-match-data
10642 (abbreviate-file-name (read-file-name "Include file: ")))
10644 t t rpl)))
10647 (insert rpl)
10650 ;;;; TODO, DEADLINE, Comments
10652 (defun org-toggle-comment ()
10653 "Change the COMMENT state of an entry."
10654 (interactive)
10655 (save-excursion
10656 (org-back-to-heading)
10657 (let (case-fold-search)
10658 (if (looking-at (concat outline-regexp
10660 (replace-match "" t t nil 1)
10661 (if (looking-at outline-regexp)
10662 (progn
10663 (goto-char (match-end 0))
10664 (insert org-comment-string " ")))))))
10666 (defvar org-last-todo-state-is-todo nil
10667 "This is non-nil when the last TODO state change led to a TODO state.
10668 If the last change removed the TODO tag or switched to DONE, then
10669 this is nil.")
10671 (defvar org-setting-tags nil) ; dynamically skipped
10673 (defvar org-todo-setup-filter-hook nil
10674 "Hook for functions that pre-filter todo specs.
10675 Each function takes a todo spec and returns either nil or the spec
10676 transformed into canonical form." )
10678 (defvar org-todo-get-default-hook nil
10679 "Hook for functions that get a default item for todo.
10680 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10681 nil or a string to be used for the todo mark." )
10683 (defvar org-agenda-headline-snapshot-before-repeat)
10685 (defun org-todo (&optional arg)
10686 "Change the TODO state of an item.
10687 The state of an item is given by a keyword at the start of the heading,
10688 like
10689 *** TODO Write paper
10690 *** DONE Call mom
10692 The different keywords are specified in the variable `org-todo-keywords'.
10694 So for this example: when the item starts with TODO, it is changed to DONE.
10695 When it starts with DONE, the DONE is removed. And when neither TODO nor
10696 DONE are present, add TODO at the beginning of the heading.
10699 state.
10700 With numeric prefix arg, switch to that state.
10702 keywords (nextset).
10705 For calling through lisp, arg is also interpreted in the following way:
10706 'none -> empty state
10708 'done -> switch to DONE
10709 'nextset -> switch to the next set of keywords
10710 'previousset -> switch to the previous set of keywords
10712 really is a member of `org-todo-keywords'."
10713 (interactive "P")
10714 (if (equal arg '(16)) (setq arg 'nextset))
10715 (let ((org-blocker-hook org-blocker-hook)
10716 (case-fold-search nil))
10717 (when (equal arg '(64))
10718 (setq arg nil org-blocker-hook nil))
10719 (when (and org-blocker-hook
10720 (or org-inhibit-blocking
10721 (org-entry-get nil "NOBLOCKING")))
10722 (setq org-blocker-hook nil))
10723 (save-excursion
10724 (catch 'exit
10725 (org-back-to-heading t)
10726 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10728 (looking-at " *"))
10729 (let* ((match-data (match-data))
10730 (startpos (point-at-bol))
10731 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10732 (org-log-done org-log-done)
10733 (org-log-repeat org-log-repeat)
10734 (org-todo-log-states org-todo-log-states)
10735 (this (match-string 1))
10736 (hl-pos (match-beginning 0))
10737 (head (org-get-todo-sequence-head this))
10738 (ass (assoc head org-todo-kwd-alist))
10739 (interpret (nth 1 ass))
10740 (done-word (nth 3 ass))
10741 (final-done-word (nth 4 ass))
10742 (last-state (or this ""))
10743 (completion-ignore-case t)
10744 (member (member this org-todo-keywords-1))
10745 (tail (cdr member))
10746 (state (cond
10747 ((and org-todo-key-trigger
10748 (or (and (equal arg '(4))
10749 (eq org-use-fast-todo-selection 'prefix))
10750 (and (not arg) org-use-fast-todo-selection
10751 (not (eq org-use-fast-todo-selection
10752 'prefix)))))
10753 ;; Use fast selection
10754 (org-fast-todo-selection))
10755 ((and (equal arg '(4))
10756 (or (not org-use-fast-todo-selection)
10757 (not org-todo-key-trigger)))
10758 ;; Read a state with completion
10759 (org-icompleting-read
10760 "State: " (mapcar (lambda(x) (list x))
10761 org-todo-keywords-1)
10762 nil t))
10763 ((eq arg 'right)
10764 (if this
10765 (if tail (car tail) nil)
10766 (car org-todo-keywords-1)))
10767 ((eq arg 'left)
10768 (if (equal member org-todo-keywords-1)
10769 nil
10770 (if this
10771 (nth (- (length org-todo-keywords-1)
10772 (length tail) 2)
10773 org-todo-keywords-1)
10774 (org-last org-todo-keywords-1))))
10775 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10776 (setq arg nil))) ; hack to fall back to cycling
10777 (arg
10778 ;; user or caller requests a specific state
10779 (cond
10780 ((equal arg "") nil)
10781 ((eq arg 'none) nil)
10782 ((eq arg 'done) (or done-word (car org-done-keywords)))
10783 ((eq arg 'nextset)
10784 (or (car (cdr (member head org-todo-heads)))
10785 (car org-todo-heads)))
10786 ((eq arg 'previousset)
10787 (let ((org-todo-heads (reverse org-todo-heads)))
10788 (or (car (cdr (member head org-todo-heads)))
10789 (car org-todo-heads))))
10790 ((car (member arg org-todo-keywords-1)))
10791 ((stringp arg)
10792 (error "State `%s' not valid in this file" arg))
10793 ((nth (1- (prefix-numeric-value arg))
10794 org-todo-keywords-1))))
10795 ((null member) (or head (car org-todo-keywords-1)))
10796 ((equal this final-done-word) nil) ;; -> make empty
10797 ((null tail) nil) ;; -> first entry
10798 ((memq interpret '(type priority))
10799 (if (eq this-command last-command)
10800 (car tail)
10801 (if (> (length tail) 0)
10802 (or done-word (car org-done-keywords))
10803 nil)))
10804 (t
10805 (car tail))))
10806 (state (or
10807 (run-hook-with-args-until-success
10808 'org-todo-get-default-hook state last-state)
10809 state))
10810 (next (if state (concat " " state " ") " "))
10811 (change-plist (list :type 'todo-state-change :from this :to state
10812 :position startpos))
10813 dolog now-done-p)
10814 (when org-blocker-hook
10815 (setq org-last-todo-state-is-todo
10816 (not (member this org-done-keywords)))
10817 (unless (save-excursion
10818 (save-match-data
10819 (run-hook-with-args-until-failure
10820 'org-blocker-hook change-plist)))
10821 (if (interactive-p)
10822 (error "TODO state change from %s to %s blocked" this state)
10823 ;; fail silently
10824 (message "TODO state change from %s to %s blocked" this state)
10825 (throw 'exit nil))))
10826 (store-match-data match-data)
10827 (replace-match next t t)
10828 (unless (pos-visible-in-window-p hl-pos)
10829 (message "TODO state changed to %s" (org-trim next)))
10830 (unless head
10831 (setq head (org-get-todo-sequence-head state)
10832 ass (assoc head org-todo-kwd-alist)
10833 interpret (nth 1 ass)
10834 done-word (nth 3 ass)
10835 final-done-word (nth 4 ass)))
10836 (when (memq arg '(nextset previousset))
10837 (message "Keyword-Set %d/%d: %s"
10838 (- (length org-todo-sets) -1
10839 (length (memq (assoc state org-todo-sets) org-todo-sets)))
10840 (length org-todo-sets)
10841 (mapconcat 'identity (assoc state org-todo-sets) " ")))
10842 (setq org-last-todo-state-is-todo
10843 (not (member state org-done-keywords)))
10844 (setq now-done-p (and (member state org-done-keywords)
10845 (not (member this org-done-keywords))))
10846 (and logging (org-local-logging logging))
10847 (when (and (or org-todo-log-states org-log-done)
10848 (not (eq org-inhibit-logging t))
10849 (not (memq arg '(nextset previousset))))
10850 ;; we need to look at recording a time and note
10851 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
10852 (nth 2 (assoc this org-todo-log-states))))
10853 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
10854 (setq dolog 'time))
10855 (when (and state
10856 (member state org-not-done-keywords)
10857 (not (member this org-not-done-keywords)))
10858 ;; This is now a todo state and was not one before
10859 ;; If there was a CLOSED time stamp, get rid of it.
10860 (org-add-planning-info nil nil 'closed))
10861 (when (and now-done-p org-log-done)
10862 ;; It is now done, and it was not done before
10863 (org-add-planning-info 'closed (org-current-time))
10864 (if (and (not dolog) (eq 'note org-log-done))
10865 (org-add-log-setup 'done state this 'findpos 'note)))
10866 (when (and state dolog)
10867 ;; This is a non-nil state, and we need to log it
10868 (org-add-log-setup 'state state this 'findpos dolog)))
10869 ;; Fixup tag positioning
10870 (org-todo-trigger-tag-changes state)
10871 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
10872 (when org-provide-todo-statistics
10873 (org-update-parent-todo-statistics))
10874 (run-hooks 'org-after-todo-state-change-hook)
10875 (if (and arg (not (member state org-done-keywords)))
10876 (setq head (org-get-todo-sequence-head state)))
10877 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
10878 ;; Do we need to trigger a repeat?
10879 (when now-done-p
10880 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
10881 ;; This is for the agenda, take a snapshot of the headline.
10882 (save-match-data
10883 (setq org-agenda-headline-snapshot-before-repeat
10884 (org-get-heading))))
10885 (org-auto-repeat-maybe state))
10886 ;; Fixup cursor location if close to the keyword
10887 (if (and (outline-on-heading-p)
10888 (not (bolp))
10889 (save-excursion (beginning-of-line 1)
10890 (looking-at org-todo-line-regexp))
10891 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
10892 (progn
10893 (goto-char (or (match-end 2) (match-end 1)))
10894 (and (looking-at " ") (just-one-space))))
10895 (when org-trigger-hook
10896 (save-excursion
10897 (run-hook-with-args 'org-trigger-hook change-plist))))))))
10899 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
10900 "Block turning an entry into a TODO, using the hierarchy.
10901 This checks whether the current task should be blocked from state
10902 changes. Such blocking occurs when:
10904 1. The task has children which are not all in a completed state.
10906 2. A task has a parent with the property :ORDERED:, and there
10907 are siblings prior to the current task with incomplete
10908 status.
10910 3. The parent of the task is blocked because it has siblings that should
10911 be done first, or is child of a block grandparent TODO entry."
10913 (if (not org-enforce-todo-dependencies)
10914 t ; if locally turned off don't block
10915 (catch 'dont-block
10916 ;; If this is not a todo state change, or if this entry is already DONE,
10917 ;; do not block
10918 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
10919 (member (plist-get change-plist :from)
10920 (cons 'done org-done-keywords))
10921 (member (plist-get change-plist :to)
10922 (cons 'todo org-not-done-keywords))
10923 (not (plist-get change-plist :to)))
10924 (throw 'dont-block t))
10925 ;; If this task has children, and any are undone, it's blocked
10926 (save-excursion
10927 (org-back-to-heading t)
10928 (let ((this-level (funcall outline-level)))
10929 (outline-next-heading)
10930 (let ((child-level (funcall outline-level)))
10931 (while (and (not (eobp))
10932 (> child-level this-level))
10933 ;; this todo has children, check whether they are all
10934 ;; completed
10935 (if (and (not (org-entry-is-done-p))
10936 (org-entry-is-todo-p))
10937 (throw 'dont-block nil))
10938 (outline-next-heading)
10939 (setq child-level (funcall outline-level))))))
10940 ;; Otherwise, if the task's parent has the :ORDERED: property, and
10941 ;; any previous siblings are undone, it's blocked
10942 (save-excursion
10943 (org-back-to-heading t)
10944 (let* ((pos (point))
10945 (parent-pos (and (org-up-heading-safe) (point))))
10946 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10947 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
10948 (forward-line 1)
10949 (re-search-forward org-not-done-heading-regexp pos t))
10950 (throw 'dont-block nil)) ; block, there is an older sibling not done.
10951 ;; Search further up the hierarchy, to see if an anchestor is blocked
10952 (while t
10953 (goto-char parent-pos)
10954 (if (not (looking-at org-not-done-heading-regexp))
10955 (throw 'dont-block t)) ; do not block, parent is not a TODO
10956 (setq pos (point))
10957 (setq parent-pos (and (org-up-heading-safe) (point)))
10958 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10959 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
10960 (forward-line 1)
10961 (re-search-forward org-not-done-heading-regexp pos t))
10962 (throw 'dont-block nil)))))))) ; block, older sibling not done.
10964 (defcustom org-track-ordered-property-with-tag nil
10965 "Should the ORDERED property also be shown as a tag?
10966 The ORDERED property decides if an entry should require subtasks to be
10967 completed in sequence. Since a property is not very visible, setting
10968 this option means that toggling the ORDERED property with the command
10969 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
10970 not relevant for the behavior, but it makes things more visible.
10972 Note that toggling the tag with tags commands will not change the property
10973 and therefore not influence behavior!
10975 This can be t, meaning the tag ORDERED should be used, It can also be a
10976 string to select a different tag for this task."
10977 :group 'org-todo
10978 :type '(choice
10979 (const :tag "No tracking" nil)
10980 (const :tag "Track with ORDERED tag" t)
10981 (string :tag "Use other tag")))
10983 (defun org-toggle-ordered-property ()
10984 "Toggle the ORDERED property of the current entry.
10985 For better visibility, you can track the value of this property with a tag.
10986 See variable `org-track-ordered-property-with-tag'."
10987 (interactive)
10988 (let* ((t1 org-track-ordered-property-with-tag)
10989 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
10990 (save-excursion
10991 (org-back-to-heading)
10992 (if (org-entry-get nil "ORDERED")
10993 (progn
10994 (org-delete-property "ORDERED")
10995 (and tag (org-toggle-tag tag 'off))
10996 (message "Subtasks can be completed in arbitrary order"))
10997 (org-entry-put nil "ORDERED" "t")
10998 (and tag (org-toggle-tag tag 'on))
10999 (message "Subtasks must be completed in sequence")))))
11001 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11002 (defun org-block-todo-from-checkboxes (change-plist)
11003 "Block turning an entry into a TODO, using checkboxes.
11004 This checks whether the current task should be blocked from state
11005 changes because there are unchecked boxes in this entry."
11006 (if (not org-enforce-todo-checkbox-dependencies)
11007 t ; if locally turned off don't block
11008 (catch 'dont-block
11009 ;; If this is not a todo state change, or if this entry is already DONE,
11010 ;; do not block
11011 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11012 (member (plist-get change-plist :from)
11013 (cons 'done org-done-keywords))
11014 (member (plist-get change-plist :to)
11015 (cons 'todo org-not-done-keywords))
11016 (not (plist-get change-plist :to)))
11017 (throw 'dont-block t))
11018 ;; If this task has checkboxes that are not checked, it's blocked
11019 (save-excursion
11020 (org-back-to-heading t)
11021 (let ((beg (point)) end)
11022 (outline-next-heading)
11023 (setq end (point))
11024 (goto-char beg)
11026 end t)
11027 (progn
11028 (if (boundp 'org-blocked-by-checkboxes)
11029 (setq org-blocked-by-checkboxes t))
11030 (throw 'dont-block nil)))))
11031 t))) ; do not block
11033 (defun org-entry-blocked-p ()
11034 "Is the current entry blocked?"
11035 (if (org-entry-get nil "NOBLOCKING")
11036 nil ;; Never block this entry
11037 (not
11038 (run-hook-with-args-until-failure
11039 'org-blocker-hook
11040 (list :type 'todo-state-change
11041 :position (point)
11042 :from 'todo
11043 :to 'done)))))
11045 (defun org-update-statistics-cookies (all)
11046 "Update the statistics cookie, either from TODO or from checkboxes.
11047 This should be called with the cursor in a line with a statistics cookie."
11048 (interactive "P")
11049 (if all
11050 (progn
11051 (org-update-checkbox-count 'all)
11052 (org-map-entries 'org-update-parent-todo-statistics))
11053 (if (not (org-on-heading-p))
11054 (org-update-checkbox-count)
11055 (let ((pos (move-marker (make-marker) (point)))
11056 end l1 l2)
11057 (ignore-errors (org-back-to-heading t))
11058 (if (not (org-on-heading-p))
11059 (org-update-checkbox-count)
11060 (setq l1 (org-outline-level))
11061 (setq end (save-excursion
11062 (outline-next-heading)
11063 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11064 (point)))
11065 (if (and (save-excursion
11066 (re-search-forward
11068 (not (save-excursion (re-search-forward
11070 (org-update-checkbox-count)
11071 (if (and l2 (> l2 l1))
11072 (progn
11073 (goto-char end)
11074 (org-update-parent-todo-statistics))
11075 (goto-char pos)
11076 (beginning-of-line 1)
11077 (while (re-search-forward
11079 (point-at-eol) t)
11080 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11081 (goto-char pos)
11082 (move-marker pos nil)))))
11084 (defvar org-entry-property-inherited-from) ;; defined below
11085 (defun org-update-parent-todo-statistics ()
11086 "Update any statistics cookie in the parent of the current headline.
11087 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11088 the entire subtree and this will travel up the hierarchy and update
11089 statistics everywhere."
11090 (interactive)
11091 (let* ((lim 0) prop
11092 (recursive (or (not org-hierarchical-todo-statistics)
11093 (string-match
11095 (or (setq prop (org-entry-get
11096 nil "COOKIE_DATA" 'inherit)) ""))))
11097 (lim (or (and prop (marker-position
11098 org-entry-property-inherited-from))
11099 lim))
11100 (first t)
11102 level ltoggle l1 new ndel
11103 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
11104 (catch 'exit
11105 (save-excursion
11106 (beginning-of-line 1)
11107 (if (org-at-heading-p)
11108 (setq ltoggle (funcall outline-level))
11109 (error "This should not happen"))
11110 (while (and (setq level (org-up-heading-safe))
11111 (or recursive first)
11112 (>= (point) lim))
11113 (setq first nil cookie-present nil)
11114 (unless (and level
11115 (not (string-match
11117 (downcase
11118 (or (org-entry-get
11119 nil "COOKIE_DATA")
11120 "")))))
11121 (throw 'exit nil))
11122 (while (re-search-forward box-re (point-at-eol) t)
11123 (setq cnt-all 0 cnt-done 0 cookie-present t)
11124 (setq is-percent (match-end 2))
11125 (save-match-data
11126 (unless (outline-next-heading) (throw 'exit nil))
11127 (while (and (looking-at org-complex-heading-regexp)
11128 (> (setq l1 (length (match-string 1))) level))
11129 (setq kwd (and (or recursive (= l1 ltoggle))
11130 (match-string 2)))
11131 (if (or (eq org-provide-todo-statistics 'all-headlines)
11132 (and (listp org-provide-todo-statistics)
11133 (or (member kwd org-provide-todo-statistics)
11134 (member kwd org-done-keywords))))
11135 (setq cnt-all (1+ cnt-all))
11136 (if (eq org-provide-todo-statistics t)
11137 (and kwd (setq cnt-all (1+ cnt-all)))))
11138 (and (member kwd org-done-keywords)
11139 (setq cnt-done (1+ cnt-done)))
11140 (outline-next-heading)))
11141 (setq new
11142 (if is-percent
11143 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11144 (format "[%d/%d]" cnt-done cnt-all))
11145 ndel (- (match-end 0) (match-beginning 0)))
11146 (goto-char (match-beginning 0))
11147 (insert new)
11148 (delete-region (point) (+ (point) ndel)))
11149 (when cookie-present
11150 (run-hook-with-args 'org-after-todo-statistics-hook
11151 cnt-done (- cnt-all cnt-done))))))
11152 (run-hooks 'org-todo-statistics-hook)))
11154 (defvar org-after-todo-statistics-hook nil
11155 "Hook that is called after a TODO statistics cookie has been updated.
11156 Each function is called with two arguments: the number of not-done entries
11157 and the number of done entries.
11159 For example, the following function, when added to this hook, will switch
11160 an entry to DONE when all children are done, and back to TODO when new
11161 entries are set to a TODO status. Note that this hook is only called
11162 when there is a statistics cookie in the headline!
11164 (defun org-summary-todo (n-done n-not-done)
11166 (let (org-log-done org-log-states) ; turn off logging
11168 ")
11170 (defvar org-todo-statistics-hook nil
11171 "Hook that is run whenever Org thinks TODO statistics should be updated.
11172 This hook runs even if there is no statistics cookie present, in which case
11173 `org-after-todo-statistics-hook' would not run.")
11175 (defun org-todo-trigger-tag-changes (state)
11176 "Apply the changes defined in `org-todo-state-tags-triggers'."
11177 (let ((l org-todo-state-tags-triggers)
11178 changes)
11179 (when (or (not state) (equal state ""))
11180 (setq changes (append changes (cdr (assoc "" l)))))
11181 (when (and (stringp state) (> (length state) 0))
11182 (setq changes (append changes (cdr (assoc state l)))))
11183 (when (member state org-not-done-keywords)
11184 (setq changes (append changes (cdr (assoc 'todo l)))))
11185 (when (member state org-done-keywords)
11186 (setq changes (append changes (cdr (assoc 'done l)))))
11187 (dolist (c changes)
11188 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11190 (defun org-local-logging (value)
11191 "Get logging settings from a property VALUE."
11192 (let* (words w a)
11193 ;; directly set the variables, they are already local.
11194 (setq org-log-done nil
11195 org-log-repeat nil
11196 org-todo-log-states nil)
11197 (setq words (org-split-string value))
11198 (while (setq w (pop words))
11199 (cond
11200 ((setq a (assoc w org-startup-options))
11201 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11202 (set (nth 1 a) (nth 2 a))))
11203 ((setq a (org-extract-log-state-settings w))
11204 (and (member (car a) org-todo-keywords-1)
11205 (push a org-todo-log-states)))))))
11207 (defun org-get-todo-sequence-head (kwd)
11208 "Return the head of the TODO sequence to which KWD belongs.
11209 If KWD is not set, check if there is a text property remembering the
11210 right sequence."
11211 (let (p)
11212 (cond
11213 ((not kwd)
11214 (or (get-text-property (point-at-bol) 'org-todo-head)
11215 (progn
11216 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11217 nil (point-at-eol)))
11218 (get-text-property p 'org-todo-head))))
11219 ((not (member kwd org-todo-keywords-1))
11220 (car org-todo-keywords-1))
11221 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11223 (defun org-fast-todo-selection ()
11224 "Fast TODO keyword selection with single keys.
11225 Returns the new TODO keyword, or nil if no state change should occur."
11226 (let* ((fulltable org-todo-key-alist)
11227 (done-keywords org-done-keywords) ;; needed for the faces.
11228 (maxlen (apply 'max (mapcar
11229 (lambda (x)
11230 (if (stringp (car x)) (string-width (car x)) 0))
11231 fulltable)))
11232 (expert nil)
11233 (fwidth (+ maxlen 3 1 3))
11234 (ncol (/ (- (window-width) 4) fwidth))
11235 tg cnt e c tbl
11236 groups ingroup)
11237 (save-excursion
11238 (save-window-excursion
11239 (if expert
11240 (set-buffer (get-buffer-create " *Org todo*"))
11241 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11242 (erase-buffer)
11243 (org-set-local 'org-done-keywords done-keywords)
11244 (setq tbl fulltable cnt 0)
11245 (while (setq e (pop tbl))
11246 (cond
11247 ((equal e '(:startgroup))
11248 (push '() groups) (setq ingroup t)
11249 (when (not (= cnt 0))
11250 (setq cnt 0)
11252 (insert "{ "))
11253 ((equal e '(:endgroup))
11254 (setq ingroup nil cnt 0)
11256 ((equal e '(:newline))
11257 (when (not (= cnt 0))
11258 (setq cnt 0)
11260 (setq e (car tbl))
11261 (while (equal (car tbl) '(:newline))
11263 (setq tbl (cdr tbl)))))
11264 (t
11265 (setq tg (car e) c (cdr e))
11266 (if ingroup (push tg (car groups)))
11267 (setq tg (org-add-props tg nil 'face
11268 (org-get-todo-face tg)))
11269 (if (and (= cnt 0) (not ingroup)) (insert " "))
11270 (insert "[" c "] " tg (make-string
11271 (- fwidth 4 (length tg)) ?\ ))
11272 (when (= (setq cnt (1+ cnt)) ncol)
11274 (if ingroup (insert " "))
11275 (setq cnt 0)))))
11277 (goto-char (point-min))
11278 (if (not expert) (org-fit-window-to-buffer))
11279 (message "[a-z..]:Set [SPC]:clear")
11280 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11281 (cond
11282 ((or (= c ?\C-g)
11283 (and (= c ?q) (not (rassoc c fulltable))))
11284 (setq quit-flag t))
11285 ((= c ?\ ) nil)
11286 ((setq e (rassoc c fulltable) tg (car e))
11287 tg)
11288 (t (setq quit-flag t)))))))
11290 (defun org-entry-is-todo-p ()
11291 (member (org-get-todo-state) org-not-done-keywords))
11293 (defun org-entry-is-done-p ()
11294 (member (org-get-todo-state) org-done-keywords))
11296 (defun org-get-todo-state ()
11297 (save-excursion
11298 (org-back-to-heading t)
11299 (and (looking-at org-todo-line-regexp)
11300 (match-end 2)
11301 (match-string 2))))
11303 (defun org-at-date-range-p (&optional inactive-ok)
11304 "Is the cursor inside a date range?"
11305 (interactive)
11306 (save-excursion
11307 (catch 'exit
11308 (let ((pos (point)))
11310 (skip-chars-backward "<[")
11311 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11312 (>= (match-end 0) pos)
11313 (throw 'exit t))
11315 (skip-chars-backward "<[")
11316 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11317 (>= (match-end 0) pos)
11318 (throw 'exit t)))
11319 nil)))
11321 (defun org-get-repeat (&optional tagline)
11322 "Check if there is a deadline/schedule with repeater in this entry."
11323 (save-match-data
11324 (save-excursion
11325 (org-back-to-heading t)
11326 (and (re-search-forward (if tagline
11328 org-repeat-re)
11329 (org-entry-end-position) t)
11330 (match-string-no-properties 1)))))
11332 (defvar org-last-changed-timestamp)
11333 (defvar org-last-inserted-timestamp)
11334 (defvar org-log-post-message)
11335 (defvar org-log-note-purpose)
11336 (defvar org-log-note-how)
11337 (defvar org-log-note-extra)
11338 (defun org-auto-repeat-maybe (done-word)
11339 "Check if the current headline contains a repeated deadline/schedule.
11340 If yes, set TODO state back to what it was and change the base date
11341 of repeating deadline/scheduled time stamps to new date.
11342 This function is run automatically after each state change to a DONE state."
11343 ;; last-state is dynamically scoped into this function
11344 (let* ((repeat (org-get-repeat))
11345 (aa (assoc last-state org-todo-kwd-alist))
11346 (interpret (nth 1 aa))
11347 (head (nth 2 aa))
11348 (whata '(("d" . day) ("m" . month) ("y" . year)))
11349 (msg "Entry repeats: ")
11350 (org-log-done nil)
11351 (org-todo-log-states nil)
11352 re type n what ts time to-state)
11353 (when repeat
11354 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11355 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11356 org-todo-repeat-to-state))
11357 (unless (and to-state (member to-state org-todo-keywords-1))
11358 (setq to-state (if (eq interpret 'type) last-state head)))
11359 (org-todo to-state)
11360 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11361 (org-entry-put nil "LAST_REPEAT" (format-time-string
11362 (org-time-stamp-format t t))))
11363 (when org-log-repeat
11364 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11365 (memq 'org-add-log-note post-command-hook))
11366 ;; OK, we are already setup for some record
11367 (if (eq org-log-repeat 'note)
11368 ;; make sure we take a note, not only a time stamp
11369 (setq org-log-note-how 'note))
11370 ;; Set up for taking a record
11371 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11372 last-state
11373 'findpos org-log-repeat)))
11374 (org-back-to-heading t)
11375 (org-add-planning-info nil nil 'closed)
11379 (while (re-search-forward
11380 re (save-excursion (outline-next-heading) (point)) t)
11381 (setq type (if (match-end 1) org-scheduled-string
11382 (if (match-end 3) org-deadline-string "Plain:"))
11383 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11385 (setq n (string-to-number (match-string 2 ts))
11386 what (match-string 3 ts))
11387 (if (equal what "w") (setq n (* n 7) what "d"))
11388 ;; Preparation, see if we need to modify the start date for the change
11389 (when (match-end 1)
11390 (setq time (save-match-data (org-time-string-to-time ts)))
11391 (cond
11392 ((equal (match-string 1 ts) ".")
11393 ;; Shift starting date to today
11394 (org-timestamp-change
11395 (- (time-to-days (current-time)) (time-to-days time))
11396 'day))
11397 ((equal (match-string 1 ts) "+")
11398 (let ((nshiftmax 10) (nshift 0))
11399 (while (or (= nshift 0)
11400 (<= (time-to-days time)
11401 (time-to-days (current-time))))
11402 (when (= (incf nshift) nshiftmax)
11403 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11404 (error "Abort")))
11405 (org-timestamp-change n (cdr (assoc what whata)))
11406 (org-at-timestamp-p t)
11407 (setq ts (match-string 1))
11408 (setq time (save-match-data (org-time-string-to-time ts)))))
11409 (org-timestamp-change (- n) (cdr (assoc what whata)))
11410 ;; rematch, so that we have everything in place for the real shift
11411 (org-at-timestamp-p t)
11412 (setq ts (match-string 1))
11414 (org-timestamp-change n (cdr (assoc what whata)))
11415 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11416 (setq org-log-post-message msg)
11417 (message "%s" msg))))
11419 (defun org-show-todo-tree (arg)
11420 "Make a compact tree which shows all headlines marked with TODO.
11421 The tree will show the lines where the regexp matches, and all higher
11422 headlines above the match.
11424 With a numeric prefix N, construct a sparse tree for the Nth element
11425 of `org-todo-keywords-1'."
11426 (interactive "P")
11427 (let ((case-fold-search nil)
11428 (kwd-re
11429 (cond ((null arg) org-not-done-regexp)
11430 ((equal arg '(4))
11431 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11432 (mapcar 'list org-todo-keywords-1))))
11436 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11437 (regexp-quote (nth (1- (prefix-numeric-value arg))
11438 org-todo-keywords-1)))
11439 (t (error "Invalid prefix argument: %s" arg)))))
11440 (message "%d TODO entries found"
11441 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
11443 (defun org-deadline (&optional remove time)
11445 With argument REMOVE, remove any deadline from the item.
11446 When TIME is set, it should be an internal time specification, and the
11447 scheduling will use the corresponding date."
11448 (interactive "P")
11449 (let* ((old-date (org-entry-get nil "DEADLINE"))
11450 (repeater (and old-date
11452 (match-string 1 old-date))))
11453 (if remove
11454 (progn
11455 (when (and old-date org-log-redeadline)
11456 (org-add-log-setup 'deldeadline nil old-date 'findpos
11457 org-log-redeadline))
11458 (org-remove-timestamp-with-keyword org-deadline-string)
11459 (message "Item no longer has a deadline."))
11460 (org-add-planning-info 'deadline time 'closed)
11461 (when (and old-date org-log-redeadline
11462 (not (equal old-date
11463 (substring org-last-inserted-timestamp 1 -1))))
11464 (org-add-log-setup 'redeadline nil old-date 'findpos
11465 org-log-redeadline))
11466 (when repeater
11467 (save-excursion
11468 (org-back-to-heading t)
11469 (when (re-search-forward (concat org-deadline-string " "
11470 org-last-inserted-timestamp)
11471 (save-excursion
11472 (outline-next-heading) (point)) t)
11473 (goto-char (1- (match-end 0)))
11474 (insert " " repeater)
11475 (setq org-last-inserted-timestamp
11476 (concat (substring org-last-inserted-timestamp 0 -1)
11477 " " repeater
11478 (substring org-last-inserted-timestamp -1))))))
11479 (message "Deadline on %s" org-last-inserted-timestamp))))
11481 (defun org-schedule (&optional remove time)
11482 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11483 With argument REMOVE, remove any scheduling date from the item.
11484 When TIME is set, it should be an internal time specification, and the
11485 scheduling will use the corresponding date."
11486 (interactive "P")
11487 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11488 (repeater (and old-date
11490 (match-string 1 old-date))))
11491 (if remove
11492 (progn
11493 (when (and old-date org-log-reschedule)
11494 (org-add-log-setup 'delschedule nil old-date 'findpos
11495 org-log-reschedule))
11496 (org-remove-timestamp-with-keyword org-scheduled-string)
11497 (message "Item is no longer scheduled."))
11498 (org-add-planning-info 'scheduled time 'closed)
11499 (when (and old-date org-log-reschedule
11500 (not (equal old-date
11501 (substring org-last-inserted-timestamp 1 -1))))
11502 (org-add-log-setup 'reschedule nil old-date 'findpos
11503 org-log-reschedule))
11504 (when repeater
11505 (save-excursion
11506 (org-back-to-heading t)
11507 (when (re-search-forward (concat org-scheduled-string " "
11508 org-last-inserted-timestamp)
11509 (save-excursion
11510 (outline-next-heading) (point)) t)
11511 (goto-char (1- (match-end 0)))
11512 (insert " " repeater)
11513 (setq org-last-inserted-timestamp
11514 (concat (substring org-last-inserted-timestamp 0 -1)
11515 " " repeater
11516 (substring org-last-inserted-timestamp -1))))))
11517 (message "Scheduled to %s" org-last-inserted-timestamp))))
11519 (defun org-get-scheduled-time (pom &optional inherit)
11520 "Get the scheduled time as a time tuple, of a format suitable
11521 for calling org-schedule with, or if there is no scheduling,
11522 returns nil."
11523 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11524 (when time
11525 (apply 'encode-time (org-parse-time-string time)))))
11527 (defun org-get-deadline-time (pom &optional inherit)
11528 "Get the deadline as a time tuple, of a format suitable for
11529 calling org-deadline with, or if there is no scheduling, returns
11530 nil."
11531 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11532 (when time
11533 (apply 'encode-time (org-parse-time-string time)))))
11535 (defun org-remove-timestamp-with-keyword (keyword)
11536 "Remove all time stamps with KEYWORD in the current entry."
11538 beg)
11539 (save-excursion
11540 (org-back-to-heading t)
11541 (setq beg (point))
11542 (outline-next-heading)
11543 (while (re-search-backward re beg t)
11544 (replace-match "")
11546 (equal (char-before) ?\ ))
11547 (backward-delete-char 1)
11549 (point-at-bol) (point-at-eol)))
11550 (delete-region (point-at-bol)
11551 (min (point-max) (1+ (point-at-eol))))))))))
11553 (defun org-add-planning-info (what &optional time &rest remove)
11554 "Insert new timestamp with keyword in the line directly after the headline.
11555 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11556 If non is given, the user is prompted for a date.
11557 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11558 be removed."
11559 (interactive)
11560 (let (org-time-was-given org-end-time-was-given ts
11561 end default-time default-input)
11563 (catch 'exit
11564 (when (and (not time) (memq what '(scheduled deadline)))
11565 ;; Try to get a default date/time from existing timestamp
11566 (save-excursion
11567 (org-back-to-heading t)
11568 (setq end (save-excursion (outline-next-heading) (point)))
11569 (when (re-search-forward (if (eq what 'scheduled)
11570 org-scheduled-time-regexp
11571 org-deadline-time-regexp)
11572 end t)
11573 (setq ts (match-string 1)
11574 default-time
11575 (apply 'encode-time (org-parse-time-string ts))
11576 default-input (and ts (org-get-compact-tod ts))))))
11577 (when what
11578 ;; If necessary, get the time from the user
11579 (setq time (or time (org-read-date nil 'to-time nil nil
11580 default-time default-input))))
11582 (when (and org-insert-labeled-timestamps-at-point
11583 (member what '(scheduled deadline)))
11584 (insert
11585 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11586 (org-insert-time-stamp time org-time-was-given
11587 nil nil nil (list org-end-time-was-given))
11588 (setq what nil))
11589 (save-excursion
11590 (save-restriction
11591 (let (col list elt ts buffer-invisibility-spec)
11592 (org-back-to-heading t)
11594 (goto-char (match-end 1))
11595 (setq col (current-column))
11596 (goto-char (match-end 0))
11598 (when (and (not what)
11599 (not (looking-at
11601 org-keyword-time-not-clock-regexp))))
11602 ;; Nothing to add, nothing to remove...... :-)
11603 (throw 'exit nil))
11604 (if (and (not (looking-at outline-regexp))
11607 (not (equal (match-string 1) org-clock-string)))
11608 (narrow-to-region (match-beginning 0) (match-end 0))
11610 (backward-char 1)
11611 (narrow-to-region (point) (point))
11612 (and org-adapt-indentation (org-indent-to-column col)))
11613 ;; Check if we have to remove something.
11614 (setq list (cons what remove))
11615 (while list
11616 (setq elt (pop list))
11617 (goto-char (point-min))
11618 (when (or (and (eq elt 'scheduled)
11619 (re-search-forward org-scheduled-time-regexp nil t))
11620 (and (eq elt 'deadline)
11621 (re-search-forward org-deadline-time-regexp nil t))
11622 (and (eq elt 'closed)
11623 (re-search-forward org-closed-time-regexp nil t)))
11624 (replace-match "")
11625 (if (looking-at "--+<[^>]+>") (replace-match ""))
11626 (skip-chars-backward " ")
11627 (if (looking-at " +") (replace-match ""))))
11628 (goto-char (point-max))
11629 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11630 (when what
11631 (insert
11632 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11633 (cond ((eq what 'scheduled) org-scheduled-string)
11634 ((eq what 'deadline) org-deadline-string)
11635 ((eq what 'closed) org-closed-string))
11636 " ")
11637 (setq ts (org-insert-time-stamp
11638 time
11639 (or org-time-was-given
11640 (and (eq what 'closed) org-log-done-with-time))
11641 (eq what 'closed)
11642 nil nil (list org-end-time-was-given)))
11643 (end-of-line 1))
11644 (goto-char (point-min))
11645 (widen)
11648 (delete-region (1- (point)) (point-at-eol)))
11649 ts))))))
11651 (defvar org-log-note-marker (make-marker))
11652 (defvar org-log-note-purpose nil)
11653 (defvar org-log-note-state nil)
11654 (defvar org-log-note-previous-state nil)
11655 (defvar org-log-note-how nil)
11656 (defvar org-log-note-extra nil)
11657 (defvar org-log-note-window-configuration nil)
11658 (defvar org-log-note-return-to (make-marker))
11659 (defvar org-log-post-message nil
11660 "Message to be displayed after a log note has been stored.
11661 The auto-repeater uses this.")
11663 (defun org-add-note ()
11664 "Add a note to the current entry.
11665 This is done in the same way as adding a state change note."
11666 (interactive)
11667 (org-add-log-setup 'note nil nil 'findpos nil))
11669 (defvar org-property-end-re)
11670 (defun org-add-log-setup (&optional purpose state prev-state
11671 findpos how extra)
11672 "Set up the post command hook to take a note.
11673 If this is about to TODO state change, the new state is expected in STATE.
11674 When FINDPOS is non-nil, find the correct position for the note in
11675 the current entry. If not, assume that it can be inserted at point.
11676 HOW is an indicator what kind of note should be created.
11677 EXTRA is additional text that will be inserted into the notes buffer."
11678 (let* ((org-log-into-drawer (org-log-into-drawer))
11679 (drawer (cond ((stringp org-log-into-drawer)
11680 org-log-into-drawer)
11681 (org-log-into-drawer "LOGBOOK")
11682 (t nil))))
11683 (save-restriction
11684 (save-excursion
11685 (when findpos
11686 (org-back-to-heading t)
11687 (narrow-to-region (point) (save-excursion
11688 (outline-next-heading) (point)))
11692 (goto-char (match-end 0))
11693 (cond
11694 (drawer
11696 nil t)
11697 (progn
11698 (goto-char (match-end 0))
11699 (or org-log-states-order-reversed
11700 (and (re-search-forward org-property-end-re nil t)
11701 (goto-char (1- (match-beginning 0))))))
11703 (beginning-of-line 0)
11704 (org-indent-line-function)
11705 (beginning-of-line 2)
11706 (org-indent-line-function)
11707 (end-of-line 0)))
11708 ((and org-log-state-notes-insert-after-drawers
11709 (save-excursion
11710 (forward-line) (looking-at org-drawer-regexp)))
11711 (forward-line)
11712 (while (looking-at org-drawer-regexp)
11713 (goto-char (match-end 0))
11714 (re-search-forward org-property-end-re (point-max) t)
11715 (forward-line))
11716 (forward-line -1)))
11717 (unless org-log-states-order-reversed
11719 (org-skip-over-state-notes)
11721 (move-marker org-log-note-marker (point))
11722 (setq org-log-note-purpose purpose
11723 org-log-note-state state
11724 org-log-note-previous-state prev-state
11725 org-log-note-how how
11726 org-log-note-extra extra)
11727 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11729 (defun org-skip-over-state-notes ()
11730 "Skip past the list of State notes in an entry."
11732 (when (org-in-item-p)
11733 (let ((limit (org-list-bottom-point)))
11735 (goto-char (or (org-get-next-item (point) limit)
11736 (org-get-end-of-item limit)))))))
11738 (defun org-add-log-note (&optional purpose)
11739 "Pop up a window for taking a note, and add this note later at point."
11740 (remove-hook 'post-command-hook 'org-add-log-note)
11741 (setq org-log-note-window-configuration (current-window-configuration))
11742 (delete-other-windows)
11743 (move-marker org-log-note-return-to (point))
11744 (switch-to-buffer (marker-buffer org-log-note-marker))
11745 (goto-char org-log-note-marker)
11746 (org-switch-to-buffer-other-window "*Org Note*")
11747 (erase-buffer)
11748 (if (memq org-log-note-how '(time state))
11749 (let (current-prefix-arg) (org-store-log-note))
11750 (let ((org-inhibit-startup t)) (org-mode))
11751 (insert (format "# Insert note for %s.
11753 (cond
11754 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11755 ((eq org-log-note-purpose 'done) "closed todo item")
11756 ((eq org-log-note-purpose 'state)
11758 (or org-log-note-previous-state "")
11759 (or org-log-note-state "")))
11760 ((eq org-log-note-purpose 'reschedule)
11761 "rescheduling")
11762 ((eq org-log-note-purpose 'delschedule)
11763 "no longer scheduled")
11764 ((eq org-log-note-purpose 'redeadline)
11765 "changing deadline")
11766 ((eq org-log-note-purpose 'deldeadline)
11767 "removing deadline")
11768 ((eq org-log-note-purpose 'refile)
11769 "refiling")
11770 ((eq org-log-note-purpose 'note)
11771 "this entry")
11772 (t (error "This should not happen")))))
11773 (if org-log-note-extra (insert org-log-note-extra))
11774 (org-set-local 'org-finish-function 'org-store-log-note)))
11776 (defvar org-note-abort nil) ; dynamically scoped
11777 (defun org-store-log-note ()
11778 "Finish taking a log note, and insert it to where it belongs."
11779 (let ((txt (buffer-string))
11780 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11781 lines ind bul)
11782 (kill-buffer (current-buffer))
11784 (setq txt (replace-match "" t t txt)))
11786 (setq txt (replace-match "" t t txt)))
11789 (setq note
11790 (org-replace-escapes
11791 note
11792 (list (cons "%u" (user-login-name))
11793 (cons "%U" user-full-name)
11794 (cons "%t" (format-time-string
11795 (org-time-stamp-format 'long 'inactive)
11796 (current-time)))
11797 (cons "%T" (format-time-string
11798 (org-time-stamp-format 'long nil)
11799 (current-time)))
11800 (cons "%s" (if org-log-note-state
11802 ""))
11803 (cons "%S" (if org-log-note-previous-state
11807 (push note lines))
11808 (when (or current-prefix-arg org-note-abort)
11809 (when org-log-into-drawer
11810 (org-remove-empty-drawer-at
11811 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11812 org-log-note-marker))
11813 (setq lines nil))
11814 (when lines
11815 (with-current-buffer (marker-buffer org-log-note-marker)
11816 (save-excursion
11817 (goto-char org-log-note-marker)
11818 (move-marker org-log-note-marker nil)
11819 (end-of-line 1)
11821 (setq ind (save-excursion
11822 (if (org-in-item-p)
11823 (progn
11824 (goto-char (org-list-top-point))
11825 (org-get-indentation))
11827 (cond
11828 ((and (org-at-heading-p)
11829 org-adapt-indentation)
11830 (1+ (org-current-level)))
11831 ((org-at-heading-p) 0)
11832 (t (org-get-indentation))))))
11833 (setq bul (org-list-bullet-string "-"))
11834 (org-indent-line-to ind)
11835 (insert bul (pop lines))
11836 (let ((ind-body (+ (length bul) ind)))
11837 (while lines
11839 (org-indent-line-to ind-body)
11840 (insert (pop lines))))
11841 (message "Note stored")
11842 (org-back-to-heading t)
11843 (org-cycle-hide-drawers 'children)))))
11844 (set-window-configuration org-log-note-window-configuration)
11845 (with-current-buffer (marker-buffer org-log-note-return-to)
11846 (goto-char org-log-note-return-to))
11847 (move-marker org-log-note-return-to nil)
11848 (and org-log-post-message (message "%s" org-log-post-message)))
11850 (defun org-remove-empty-drawer-at (drawer pos)
11851 "Remove an empty drawer DRAWER at position POS.
11852 POS may also be a marker."
11853 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
11854 (save-excursion
11855 (save-restriction
11856 (widen)
11857 (goto-char pos)
11858 (if (org-in-regexp
11860 (replace-match ""))))))
11862 (defun org-sparse-tree (&optional arg)
11863 "Create a sparse tree, prompt for the details.
11864 This command can create sparse trees. You first need to select the type
11865 of match used to create the tree:
11867 t Show all TODO entries.
11868 T Show entries with a specific TODO keyword.
11869 m Show entries selected by a tags/property match.
11870 p Enter a property name and its value (both with completion on existing
11871 names/values) and show entries with that property.
11872 r Show entries matching a regular expression (`/' can be used as well)
11873 d Show deadlines due within `org-deadline-warning-days'.
11874 b Show deadlines and scheduled items before a date.
11875 a Show deadlines and scheduled items after a date."
11876 (interactive "P")
11877 (let (ans kwd value)
11878 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
11879 (setq ans (read-char-exclusive))
11880 (cond
11881 ((equal ans ?d)
11882 (call-interactively 'org-check-deadlines))
11883 ((equal ans ?b)
11884 (call-interactively 'org-check-before-date))
11885 ((equal ans ?a)
11886 (call-interactively 'org-check-after-date))
11887 ((equal ans ?t)
11888 (org-show-todo-tree nil))
11889 ((equal ans ?T)
11890 (org-show-todo-tree '(4)))
11891 ((member ans '(?T ?m))
11892 (call-interactively 'org-match-sparse-tree))
11893 ((member ans '(?p ?P))
11894 (setq kwd (org-icompleting-read "Property: "
11895 (mapcar 'list (org-buffer-property-keys))))
11896 (setq value (org-icompleting-read "Value: "
11897 (mapcar 'list (org-property-values kwd))))
11900 (org-match-sparse-tree arg (concat kwd "=" value)))
11901 ((member ans '(?r ?R ?/))
11902 (call-interactively 'org-occur))
11905 (defvar org-occur-highlights nil
11906 "List of overlays used for occur matches.")
11907 (make-variable-buffer-local 'org-occur-highlights)
11908 (defvar org-occur-parameters nil
11909 "Parameters of the active org-occur calls.
11910 This is a list, each call to org-occur pushes as cons cell,
11911 containing the regular expression and the callback, onto the list.
11912 The list can contain several entries if `org-occur' has been called
11913 several time with the KEEP-PREVIOUS argument. Otherwise, this list
11914 will only contain one set of parameters. When the highlights are
11915 removed (for example with `C-c C-c', or with the next edit (depending
11916 on `org-remove-highlights-with-change'), this variable is emptied
11917 as well.")
11918 (make-variable-buffer-local 'org-occur-parameters)
11920 (defun org-occur (regexp &optional keep-previous callback)
11921 "Make a compact tree which shows all matches of REGEXP.
11922 The tree will show the lines where the regexp matches, and all higher
11923 headlines above the match. It will also show the heading after the match,
11924 to make sure editing the matching entry is easy.
11925 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
11926 call to `org-occur' will be kept, to allow stacking of calls to this
11927 command.
11928 If CALLBACK is non-nil, it is a function which is called to confirm
11929 that the match should indeed be shown."
11931 (when (equal regexp "")
11932 (error "Regexp cannot be empty"))
11933 (unless keep-previous
11934 (org-remove-occur-highlights nil nil t))
11935 (push (cons regexp callback) org-occur-parameters)
11936 (let ((cnt 0))
11937 (save-excursion
11938 (goto-char (point-min))
11939 (if (or (not keep-previous) ; do not want to keep
11940 (not org-occur-highlights)) ; no previous matches
11941 ;; hide everything
11942 (org-overview))
11943 (while (re-search-forward regexp nil t)
11944 (when (or (not callback)
11945 (save-match-data (funcall callback)))
11946 (setq cnt (1+ cnt))
11947 (when org-highlight-sparse-tree-matches
11948 (org-highlight-new-match (match-beginning 0) (match-end 0)))
11949 (org-show-context 'occur-tree))))
11950 (when org-remove-highlights-with-change
11951 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
11952 nil 'local))
11953 (unless org-sparse-tree-open-archived-trees
11954 (org-hide-archived-subtrees (point-min) (point-max)))
11955 (run-hooks 'org-occur-hook)
11956 (if (interactive-p)
11957 (message "%d match(es) for regexp %s" cnt regexp))
11958 cnt))
11960 (defun org-show-context (&optional key)
11961 "Make sure point and context are visible.
11962 How much context is shown depends upon the variables
11963 `org-show-hierarchy-above', `org-show-following-heading'. and
11964 `org-show-siblings'."
11965 (let ((heading-p (org-on-heading-p t))
11966 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
11967 (following-p (org-get-alist-option org-show-following-heading key))
11968 (entry-p (org-get-alist-option org-show-entry-below key))
11969 (siblings-p (org-get-alist-option org-show-siblings key)))
11970 (catch 'exit
11971 ;; Show heading or entry text
11972 (if (and heading-p (not entry-p))
11973 (org-flag-heading nil) ; only show the heading
11974 (and (or entry-p (org-invisible-p) (org-invisible-p2))
11975 (org-show-hidden-entry))) ; show entire entry
11976 (when following-p
11977 ;; Show next sibling, or heading below text
11978 (save-excursion
11979 (and (if heading-p (org-goto-sibling) (outline-next-heading))
11980 (org-flag-heading nil))))
11981 (when siblings-p (org-show-siblings))
11982 (when hierarchy-p
11983 ;; show all higher headings, possibly with siblings
11984 (save-excursion
11985 (while (and (condition-case nil
11986 (progn (org-up-heading-all 1) t)
11987 (error nil))
11988 (not (bobp)))
11989 (org-flag-heading nil)
11990 (when siblings-p (org-show-siblings))))))))
11992 (defvar org-reveal-start-hook nil
11993 "Hook run before revealing a location.")
11995 (defun org-reveal (&optional siblings)
11996 "Show current entry, hierarchy above it, and the following headline.
11997 This can be used to show a consistent set of context around locations
11998 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
11999 not t for the search context.
12001 With optional argument SIBLINGS, on each level of the hierarchy all
12002 siblings are shown. This repairs the tree structure to what it would
12003 look like when opened with hierarchical calls to `org-cycle'.
12005 go to the parent and show the
12006 entire tree."
12007 (interactive "P")
12008 (run-hooks 'org-reveal-start-hook)
12009 (let ((org-show-hierarchy-above t)
12010 (org-show-following-heading t)
12011 (org-show-siblings (if siblings t org-show-siblings)))
12012 (org-show-context nil))
12013 (when (equal siblings '(16))
12014 (save-excursion
12015 (when (org-up-heading-safe)
12016 (org-show-subtree)
12017 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12019 (defun org-highlight-new-match (beg end)
12020 "Highlight from BEG to END and mark the highlight is an occur headline."
12021 (let ((ov (make-overlay beg end)))
12022 (overlay-put ov 'face 'secondary-selection)
12023 (push ov org-occur-highlights)))
12025 (defun org-remove-occur-highlights (&optional beg end noremove)
12026 "Remove the occur highlights from the buffer.
12027 BEG and END are ignored. If NOREMOVE is nil, remove this function
12028 from the `before-change-functions' in the current buffer."
12029 (interactive)
12030 (unless org-inhibit-highlight-removal
12031 (mapc 'delete-overlay org-occur-highlights)
12032 (setq org-occur-highlights nil)
12033 (setq org-occur-parameters nil)
12034 (unless noremove
12035 (remove-hook 'before-change-functions
12036 'org-remove-occur-highlights 'local))))
12038 ;;;; Priorities
12041 "Regular expression matching the priority indicator.")
12043 (defvar org-remove-priority-next-time nil)
12045 (defun org-priority-up ()
12046 "Increase the priority of the current item."
12047 (interactive)
12048 (org-priority 'up))
12050 (defun org-priority-down ()
12051 "Decrease the priority of the current item."
12052 (interactive)
12053 (org-priority 'down))
12055 (defun org-priority (&optional action)
12056 "Change the priority of an item by ARG.
12057 ACTION can be `set', `up', `down', or a character."
12058 (interactive)
12059 (unless org-enable-priority-commands
12060 (error "Priority commands are disabled"))
12061 (setq action (or action 'set))
12062 (let (current new news have remove)
12063 (save-excursion
12064 (org-back-to-heading t)
12065 (if (looking-at org-priority-regexp)
12066 (setq current (string-to-char (match-string 2))
12067 have t)
12068 (setq current org-default-priority))
12069 (cond
12070 ((eq action 'remove)
12071 (setq remove t new ?\ ))
12072 ((or (eq action 'set)
12073 (if (featurep 'xemacs) (characterp action) (integerp action)))
12074 (if (not (eq action 'set))
12075 (setq new action)
12076 (message "Priority %c-%c, SPC to remove: "
12077 org-highest-priority org-lowest-priority)
12078 (save-match-data
12079 (setq new (read-char-exclusive))))
12080 (if (and (= (upcase org-highest-priority) org-highest-priority)
12081 (= (upcase org-lowest-priority) org-lowest-priority))
12082 (setq new (upcase new)))
12083 (cond ((equal new ?\ ) (setq remove t))
12084 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12085 (error "Priority must be between `%c' and `%c'"
12086 org-highest-priority org-lowest-priority))))
12087 ((eq action 'up)
12088 (if (and (not have) (eq last-command this-command))
12089 (setq new org-lowest-priority)
12090 (setq new (if (and org-priority-start-cycle-with-default (not have))
12091 org-default-priority (1- current)))))
12092 ((eq action 'down)
12093 (if (and (not have) (eq last-command this-command))
12094 (setq new org-highest-priority)
12095 (setq new (if (and org-priority-start-cycle-with-default (not have))
12096 org-default-priority (1+ current)))))
12097 (t (error "Invalid action")))
12098 (if (or (< (upcase new) org-highest-priority)
12099 (> (upcase new) org-lowest-priority))
12100 (setq remove t))
12101 (setq news (format "%c" new))
12102 (if have
12103 (if remove
12104 (replace-match "" t t nil 1)
12105 (replace-match news t t nil 2))
12106 (if remove
12107 (error "No priority cookie found in line")
12108 (let ((case-fold-search nil))
12109 (looking-at org-todo-line-regexp))
12110 (if (match-end 2)
12111 (progn
12112 (goto-char (match-end 2))
12113 (insert " [#" news "]"))
12114 (goto-char (match-beginning 3))
12115 (insert "[#" news "] "))))
12116 (org-preserve-lc (org-set-tags nil 'align)))
12117 (if remove
12118 (message "Priority removed")
12119 (message "Priority of current item set to %s" news))))
12121 (defun org-get-priority (s)
12122 "Find priority cookie and return priority."
12123 (if (functionp org-get-priority-function)
12124 (funcall org-get-priority-function)
12125 (save-match-data
12126 (if (not (string-match org-priority-regexp s))
12127 (* 1000 (- org-lowest-priority org-default-priority))
12128 (* 1000 (- org-lowest-priority
12129 (string-to-char (match-string 2 s))))))))
12131 ;;;; Tags
12133 (defvar org-agenda-archives-mode)
12134 (defvar org-map-continue-from nil
12135 "Position from where mapping should continue.
12136 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12138 (defvar org-scanner-tags nil
12139 "The current tag list while the tags scanner is running.")
12140 (defvar org-trust-scanner-tags nil
12141 "Should `org-get-tags-at' use the tags fro the scanner.
12142 This is for internal dynamical scoping only.
12143 When this is non-nil, the function `org-get-tags-at' will return the value
12144 of `org-scanner-tags' instead of building the list by itself. This
12145 can lead to large speed-ups when the tags scanner is used in a file with
12146 many entries, and when the list of tags is retrieved, for example to
12147 obtain a list of properties. Building the tags list for each entry in such
12148 a file becomes an N^2 operation - but with this variable set, it scales
12149 as N.")
12151 (defun org-scan-tags (action matcher &optional todo-only)
12152 "Scan headline tags with inheritance and produce output ACTION.
12154 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12155 or `agenda' to produce an entry list for an agenda view. It can also be
12156 a Lisp form or a function that should be called at each matched headline, in
12157 this case the return value is a list of all return values from these calls.
12159 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12160 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12161 only lines with a TODO keyword are included in the output."
12162 (require 'org-agenda)
12165 (org-re
12167 (props (list 'face 'default
12168 'done-face 'org-agenda-done
12169 'undone-face 'default
12170 'mouse-face 'highlight
12171 'org-not-done-regexp org-not-done-regexp
12172 'org-todo-regexp org-todo-regexp
12173 'help-echo
12174 (format "mouse-2 or RET jump to org file %s"
12175 (abbreviate-file-name
12176 (or (buffer-file-name (buffer-base-buffer))
12177 (buffer-name (buffer-base-buffer)))))))
12178 (case-fold-search nil)
12179 (org-map-continue-from nil)
12180 lspos tags tags-list
12181 (tags-alist (list (cons 0 org-file-tags)))
12182 (llast 0) rtn rtn1 level category i txt
12183 todo marker entry priority)
12184 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12185 (setq action (list 'lambda nil action)))
12186 (save-excursion
12187 (goto-char (point-min))
12188 (when (eq action 'sparse-tree)
12189 (org-overview)
12190 (org-remove-occur-highlights))
12191 (while (re-search-forward re nil t)
12192 (catch :skip
12193 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12194 tags (if (match-end 4) (org-match-string-no-properties 4)))
12195 (goto-char (setq lspos (match-beginning 0)))
12196 (setq level (org-reduced-level (funcall outline-level))
12197 category (org-get-category))
12198 (setq i llast llast level)
12199 ;; remove tag lists from same and sublevels
12200 (while (>= i level)
12201 (when (setq entry (assoc i tags-alist))
12202 (setq tags-alist (delete entry tags-alist)))
12203 (setq i (1- i)))
12204 ;; add the next tags
12205 (when tags
12206 (setq tags (org-split-string tags ":")
12207 tags-alist
12208 (cons (cons level tags) tags-alist)))
12209 ;; compile tags for current headline
12210 (setq tags-list
12211 (if org-use-tag-inheritance
12212 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12213 tags)
12214 org-scanner-tags tags-list)
12215 (when org-use-tag-inheritance
12216 (setcdr (car tags-alist)
12217 (mapcar (lambda (x)
12218 (setq x (copy-sequence x))
12219 (org-add-prop-inherited x))
12220 (cdar tags-alist))))
12221 (when (and tags org-use-tag-inheritance
12222 (or (not (eq t org-use-tag-inheritance))
12223 org-tags-exclude-from-inheritance))
12224 ;; selective inheritance, remove uninherited ones
12225 (setcdr (car tags-alist)
12226 (org-remove-uniherited-tags (cdar tags-alist))))
12227 (when (and (or (not todo-only)
12228 (and (member todo org-not-done-keywords)
12229 (or (not org-agenda-tags-todo-honor-ignore-options)
12230 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12231 (let ((case-fold-search t)) (eval matcher))
12232 (or
12233 (not (member org-archive-tag tags-list))
12234 ;; we have an archive tag, should we use this anyway?
12235 (or (not org-agenda-skip-archived-trees)
12236 (and (eq action 'agenda) org-agenda-archives-mode))))
12237 (unless (eq action 'sparse-tree) (org-agenda-skip))
12239 ;; select this headline
12241 (cond
12242 ((eq action 'sparse-tree)
12243 (and org-highlight-sparse-tree-matches
12244 (org-get-heading) (match-end 0)
12245 (org-highlight-new-match
12246 (match-beginning 0) (match-beginning 1)))
12247 (org-show-context 'tags-tree))
12248 ((eq action 'agenda)
12249 (setq txt (org-format-agenda-item
12250 ""
12251 (concat
12252 (if (eq org-tags-match-list-sublevels 'indented)
12253 (make-string (1- level) ?.) "")
12254 (org-get-heading))
12255 category
12256 tags-list
12257 )
12258 priority (org-get-priority txt))
12259 (goto-char lspos)
12260 (setq marker (org-agenda-new-marker))
12261 (org-add-props txt props
12262 'org-marker marker 'org-hd-marker marker 'org-category category
12263 'todo-state todo
12264 'priority priority 'type "tagsmatch")
12265 (push txt rtn))
12266 ((functionp action)
12267 (setq org-map-continue-from nil)
12268 (save-excursion
12269 (setq rtn1 (funcall action))
12270 (push rtn1 rtn)))
12271 (t (error "Invalid action")))
12273 ;; if we are to skip sublevels, jump to end of subtree
12274 (unless org-tags-match-list-sublevels
12275 (org-end-of-subtree t)
12276 (backward-char 1))))
12277 ;; Get the correct position from where to continue
12278 (if org-map-continue-from
12279 (goto-char org-map-continue-from)
12280 (and (= (point) lspos) (end-of-line 1)))))
12281 (when (and (eq action 'sparse-tree)
12282 (not org-sparse-tree-open-archived-trees))
12283 (org-hide-archived-subtrees (point-min) (point-max)))
12284 (nreverse rtn)))
12286 (defun org-remove-uniherited-tags (tags)
12287 "Remove all tags that are not inherited from the list TAGS."
12288 (cond
12289 ((eq org-use-tag-inheritance t)
12290 (if org-tags-exclude-from-inheritance
12291 (org-delete-all org-tags-exclude-from-inheritance tags)
12292 tags))
12293 ((not org-use-tag-inheritance) nil)
12294 ((stringp org-use-tag-inheritance)
12295 (delq nil (mapcar
12296 (lambda (x)
12297 (if (and (string-match org-use-tag-inheritance x)
12298 (not (member x org-tags-exclude-from-inheritance)))
12299 x nil))
12300 tags)))
12301 ((listp org-use-tag-inheritance)
12302 (delq nil (mapcar
12303 (lambda (x)
12304 (if (member x org-use-tag-inheritance) x nil))
12305 tags)))))
12307 (defvar todo-only) ;; dynamically scoped
12309 (defun org-match-sparse-tree (&optional todo-only match)
12310 "Create a sparse tree according to tags string MATCH.
12311 MATCH can contain positive and negative selection of tags, like
12313 If optional argument TODO-ONLY is non-nil, only select lines that are
12314 also TODO lines."
12315 (interactive "P")
12316 (org-prepare-agenda-buffers (list (current-buffer)))
12317 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12319 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12321 (defvar org-cached-props nil)
12322 (defun org-cached-entry-get (pom property)
12323 (if (or (eq t org-use-property-inheritance)
12324 (and (stringp org-use-property-inheritance)
12325 (string-match org-use-property-inheritance property))
12326 (and (listp org-use-property-inheritance)
12327 (member property org-use-property-inheritance)))
12328 ;; Caching is not possible, check it directly
12329 (org-entry-get pom property 'inherit)
12330 ;; Get all properties, so that we can do complicated checks easily
12331 (cdr (assoc property (or org-cached-props
12332 (setq org-cached-props
12333 (org-entry-properties pom)))))))
12335 (defun org-global-tags-completion-table (&optional files)
12336 "Return the list of all tags in all agenda buffer/files."
12337 (save-excursion
12338 (org-uniquify
12339 (delq nil
12340 (apply 'append
12341 (mapcar
12342 (lambda (file)
12343 (set-buffer (find-file-noselect file))
12344 (append (org-get-buffer-tags)
12345 (mapcar (lambda (x) (if (stringp (car-safe x))
12346 (list (car-safe x)) nil))
12347 org-tag-alist)))
12348 (if (and files (car files))
12349 files
12350 (org-agenda-files))))))))
12352 (defun org-make-tags-matcher (match)
12353 "Create the TAGS//TODO matcher form for the selection string MATCH."
12354 ;; todo-only is scoped dynamically into this function, and the function
12355 ;; may change it if the matcher asks for it.
12356 (unless match
12357 ;; Get a new match request, with completion
12358 (let ((org-last-tags-completion-table
12359 (org-global-tags-completion-table)))
12360 (setq match (org-completing-read-no-i
12361 "Match: " 'org-tags-completion-function nil nil nil
12362 'org-tags-history))))
12364 ;; Parse the string and create a lisp form
12365 (let ((match0 match)
12366 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12367 minus tag mm
12368 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12369 orterms term orlist re-p str-p level-p level-op time-p
12370 prop-p pn pv po cat-p gv rest)
12371 (if (string-match "/+" match)
12372 ;; match contains also a todo-matching request
12373 (progn
12374 (setq tagsmatch (substring match 0 (match-beginning 0))
12375 todomatch (substring match (match-end 0)))
12376 (if (string-match "^!" todomatch)
12377 (setq todo-only t todomatch (substring todomatch 1)))
12379 (setq todomatch nil)))
12380 ;; only matching tags
12381 (setq tagsmatch match todomatch nil))
12383 ;; Make the tags matcher
12385 (setq tagsmatcher t)
12386 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12387 (while (setq term (pop orterms))
12389 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12390 (while (string-match re term)
12391 (setq rest (substring term (match-end 0))
12392 minus (and (match-end 1)
12393 (equal (match-string 1 term) "-"))
12394 tag (save-match-data (replace-regexp-in-string
12396 (match-string 2 term)))
12397 re-p (equal (string-to-char tag) ?{)
12398 level-p (match-end 4)
12399 prop-p (match-end 5)
12400 mm (cond
12401 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12402 (level-p
12403 (setq level-op (org-op-to-function (match-string 3 term)))
12404 `(,level-op level ,(string-to-number
12405 (match-string 4 term))))
12406 (prop-p
12407 (setq pn (match-string 5 term)
12408 po (match-string 6 term)
12409 pv (match-string 7 term)
12410 cat-p (equal pn "CATEGORY")
12411 re-p (equal (string-to-char pv) ?{)
12413 time-p (save-match-data
12415 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12416 (if time-p (setq pv (org-matcher-time pv)))
12417 (setq po (org-op-to-function po (if time-p 'time str-p)))
12418 (cond
12419 ((equal pn "CATEGORY")
12420 (setq gv '(get-text-property (point) 'org-category)))
12421 ((equal pn "TODO")
12422 (setq gv 'todo))
12423 (t
12424 (setq gv `(org-cached-entry-get nil ,pn))))
12425 (if re-p
12426 (if (eq po 'org<>)
12427 `(not (string-match ,pv (or ,gv "")))
12428 `(string-match ,pv (or ,gv "")))
12429 (if str-p
12430 `(,po (or ,gv "") ,pv)
12431 `(,po (string-to-number (or ,gv ""))
12432 ,(string-to-number pv) ))))
12433 (t `(member ,tag tags-list)))
12434 mm (if minus (list 'not mm) mm)
12435 term rest)
12436 (push mm tagsmatcher))
12437 (push (if (> (length tagsmatcher) 1)
12438 (cons 'and tagsmatcher)
12439 (car tagsmatcher))
12440 orlist)
12441 (setq tagsmatcher nil))
12442 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12443 (setq tagsmatcher
12444 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12445 ;; Make the todo matcher
12447 (setq todomatcher t)
12448 (setq orterms (org-split-string todomatch "|") orlist nil)
12449 (while (setq term (pop orterms))
12450 (while (string-match re term)
12451 (setq minus (and (match-end 1)
12452 (equal (match-string 1 term) "-"))
12453 kwd (match-string 2 term)
12454 re-p (equal (string-to-char kwd) ?{)
12455 term (substring term (match-end 0))
12456 mm (if re-p
12457 `(string-match ,(substring kwd 1 -1) todo)
12458 (list 'equal 'todo kwd))
12459 mm (if minus (list 'not mm) mm))
12460 (push mm todomatcher))
12461 (push (if (> (length todomatcher) 1)
12462 (cons 'and todomatcher)
12463 (car todomatcher))
12464 orlist)
12465 (setq todomatcher nil))
12466 (setq todomatcher (if (> (length orlist) 1)
12467 (cons 'or orlist) (car orlist))))
12469 ;; Return the string and lisp forms of the matcher
12470 (setq matcher (if todomatcher
12471 (list 'and tagsmatcher todomatcher)
12472 tagsmatcher))
12473 (cons match0 matcher)))
12475 (defun org-op-to-function (op &optional stringp)
12476 "Turn an operator into the appropriate function."
12477 (setq op
12478 (cond
12479 ((equal op "<" ) '(< string< org-time<))
12480 ((equal op ">" ) '(> org-string> org-time>))
12481 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12482 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12483 ((member op '("=" "==")) '(= string= org-time=))
12484 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12485 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12487 (defun org<> (a b) (not (= a b)))
12488 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12489 (defun org-string>= (a b) (not (string< a b)))
12490 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12491 (defun org-string<> (a b) (not (string= a b)))
12492 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12493 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12494 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12495 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12496 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12497 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12498 (defun org-2ft (s)
12499 "Convert S to a floating point time.
12500 If S is already a number, just return it. If it is a string, parse
12501 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12502 (cond
12503 ((numberp s) s)
12504 ((stringp s)
12505 (condition-case nil
12506 (float-time (apply 'encode-time (org-parse-time-string s)))
12507 (error 0.)))
12508 (t 0.)))
12510 (defun org-time-today ()
12511 "Time in seconds today at 0:00.
12512 Returns the float number of seconds since the beginning of the
12513 epoch to the beginning of today (00:00)."
12514 (float-time (apply 'encode-time
12515 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12517 (defun org-matcher-time (s)
12518 "Interpret a time comparison value."
12519 (save-match-data
12520 (cond
12521 ((string= s "<now>") (float-time))
12522 ((string= s "<today>") (org-time-today))
12523 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12524 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12526 (+ (org-time-today)
12527 (* (string-to-number (match-string 1 s))
12528 (cdr (assoc (match-string 2 s)
12529 '(("d" . 86400.0) ("w" . 604800.0)
12530 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12531 (t (org-2ft s)))))
12533 (defun org-match-any-p (re list)
12534 "Does re match any element of list?"
12535 (setq list (mapcar (lambda (x) (string-match re x)) list))
12536 (delq nil list))
12538 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12539 (defvar org-tags-overlay (make-overlay 1 1))
12540 (org-detach-overlay org-tags-overlay)
12542 (defun org-get-local-tags-at (&optional pos)
12543 "Get a list of tags defined in the current headline."
12544 (org-get-tags-at pos 'local))
12546 (defun org-get-local-tags ()
12547 "Get a list of tags defined in the current headline."
12548 (org-get-tags-at nil 'local))
12550 (defun org-get-tags-at (&optional pos local)
12551 "Get a list of all headline tags applicable at POS.
12552 POS defaults to point. If tags are inherited, the list contains
12553 the targets in the same sequence as the headlines appear, i.e.
12554 the tags of the current headline come last.
12555 When LOCAL is non-nil, only return tags from the current headline,
12556 ignore inherited ones."
12557 (interactive)
12558 (if (and org-trust-scanner-tags
12559 (or (not pos) (equal pos (point)))
12560 (not local))
12561 org-scanner-tags
12562 (let (tags ltags lastpos parent)
12563 (save-excursion
12564 (save-restriction
12565 (widen)
12566 (goto-char (or pos (point)))
12567 (save-match-data
12568 (catch 'done
12569 (condition-case nil
12570 (progn
12571 (org-back-to-heading t)
12572 (while (not (equal lastpos (point)))
12573 (setq lastpos (point))
12574 (when (looking-at
12576 (setq ltags (org-split-string
12577 (org-match-string-no-properties 1) ":"))
12578 (when parent
12579 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12580 (setq tags (append
12581 (if parent
12582 (org-remove-uniherited-tags ltags)
12583 ltags)
12584 tags)))
12585 (or org-use-tag-inheritance (throw 'done t))
12586 (if local (throw 'done t))
12587 (or (org-up-heading-safe) (error nil))
12588 (setq parent t)))
12589 (error nil)))))
12590 (append (org-remove-uniherited-tags org-file-tags) tags)))))
12592 (defun org-add-prop-inherited (s)
12593 (add-text-properties 0 (length s) '(inherited t) s)
12594 s)
12596 (defun org-toggle-tag (tag &optional onoff)
12597 "Toggle the tag TAG for the current line.
12598 If ONOFF is `on' or `off', don't toggle but set to this state."
12599 (let (res current)
12600 (save-excursion
12601 (org-back-to-heading t)
12603 (point-at-eol) t)
12604 (progn
12605 (setq current (match-string 1))
12606 (replace-match ""))
12607 (setq current ""))
12608 (setq current (nreverse (org-split-string current ":")))
12609 (cond
12610 ((eq onoff 'on)
12611 (setq res t)
12612 (or (member tag current) (push tag current)))
12613 ((eq onoff 'off)
12614 (or (not (member tag current)) (setq current (delete tag current))))
12615 (t (if (member tag current)
12616 (setq current (delete tag current))
12617 (setq res t)
12618 (push tag current))))
12619 (end-of-line 1)
12620 (if current
12621 (progn
12622 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12623 (org-set-tags nil t))
12624 (delete-horizontal-space))
12625 (run-hooks 'org-after-tags-change-hook))
12626 res))
12628 (defun org-align-tags-here (to-col)
12629 ;; Assumes that this is a headline
12630 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12631 (beginning-of-line 1)
12633 (< pos (match-beginning 2)))
12634 (progn
12635 (setq tags-l (- (match-end 2) (match-beginning 2)))
12636 (goto-char (match-beginning 1))
12637 (insert " ")
12638 (delete-region (point) (1+ (match-beginning 2)))
12639 (setq ncol (max (1+ (current-column))
12640 (1+ col)
12641 (if (> to-col 0)
12642 to-col
12643 (- (abs to-col) tags-l))))
12644 (setq p (point))
12645 (insert (make-string (- ncol (current-column)) ?\ ))
12646 (setq ncol (current-column))
12647 (when indent-tabs-mode (tabify p (point-at-eol)))
12648 (org-move-to-column (min ncol col) t))
12649 (goto-char pos))))
12651 (defun org-set-tags-command (&optional arg just-align)
12652 "Call the set-tags command for the current entry."
12653 (interactive "P")
12654 (if (org-on-heading-p)
12655 (org-set-tags arg just-align)
12656 (save-excursion
12657 (org-back-to-heading t)
12658 (org-set-tags arg just-align))))
12660 (defun org-set-tags-to (data)
12661 "Set the tags of the current entry to DATA, replacing the current tags.
12662 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12663 If DATA is nil or the empty string, any tags will be removed."
12664 (interactive "sTags: ")
12665 (setq data
12666 (cond
12667 ((eq data nil) "")
12668 ((equal data "") "")
12669 ((stringp data)
12670 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12671 ":"))
12672 ((listp data)
12673 (concat ":" (mapconcat 'identity data ":") ":"))
12674 (t nil)))
12675 (when data
12676 (save-excursion
12677 (org-back-to-heading t)
12678 (when (looking-at org-complex-heading-regexp)
12679 (if (match-end 5)
12680 (progn
12681 (goto-char (match-beginning 5))
12682 (insert data)
12683 (delete-region (point) (point-at-eol))
12684 (org-set-tags nil 'align))
12685 (goto-char (point-at-eol))
12686 (insert " " data)
12687 (org-set-tags nil 'align)))
12688 (beginning-of-line 1)
12690 (delete-region (match-beginning 1) (match-end 1))))))
12692 (defun org-align-all-tags ()
12693 "Align the tags i all headings."
12694 (interactive)
12695 (save-excursion
12696 (or (ignore-errors (org-back-to-heading t))
12697 (outline-next-heading))
12698 (if (org-on-heading-p)
12699 (org-set-tags t)
12700 (message "No headings"))))
12702 (defvar org-indent-indentation-per-level)
12703 (defun org-set-tags (&optional arg just-align)
12704 "Set the tags for the current headline.
12705 With prefix ARG, realign all tags in headings in the current buffer."
12706 (interactive "P")
12707 (let* ((re (concat "^" outline-regexp))
12708 (current (org-get-tags-string))
12709 (col (current-column))
12710 (org-setting-tags t)
12711 table current-tags inherited-tags ; computed below when needed
12712 tags p0 c0 c1 rpl di tc level)
12713 (if arg
12714 (save-excursion
12715 (goto-char (point-min))
12716 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12717 (while (re-search-forward re nil t)
12718 (org-set-tags nil t)
12719 (end-of-line 1)))
12720 (message "All tags realigned to column %d" org-tags-column))
12721 (if just-align
12722 (setq tags current)
12723 ;; Get a new set of tags from the user
12724 (save-excursion
12725 (setq table (append org-tag-persistent-alist
12726 (or org-tag-alist (org-get-buffer-tags))
12727 (and
12728 org-complete-tags-always-offer-all-agenda-tags
12729 (org-global-tags-completion-table
12730 (org-agenda-files))))
12731 org-last-tags-completion-table table
12732 current-tags (org-split-string current ":")
12733 inherited-tags (nreverse
12734 (nthcdr (length current-tags)
12735 (nreverse (org-get-tags-at))))
12736 tags
12737 (if (or (eq t org-use-fast-tag-selection)
12738 (and org-use-fast-tag-selection
12739 (delq nil (mapcar 'cdr table))))
12740 (org-fast-tag-selection
12741 current-tags inherited-tags table
12742 (if org-fast-tag-selection-include-todo
12743 org-todo-key-alist))
12744 (let ((org-add-colon-after-tag-completion t))
12745 (org-trim
12746 (org-without-partial-completion
12747 (org-icompleting-read "Tags: "
12748 'org-tags-completion-function
12749 nil nil current 'org-tags-history)))))))
12750 (while (string-match "[-+&]+" tags)
12751 ;; No boolean logic, just a list
12752 (setq tags (replace-match ":" t t tags))))
12754 (setq tags (replace-regexp-in-string "[ ,]" ":" tags))
12756 (if org-tags-sort-function
12757 (setq tags (mapconcat 'identity
12758 (sort (org-split-string
12759 tags (org-re "[^[:alnum:]_@#%]+"))
12760 org-tags-sort-function) ":")))
12763 (setq tags "")
12764 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12765 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12767 ;; Insert new tags at the correct column
12768 (beginning-of-line 1)
12769 (setq level (or (and (looking-at org-outline-regexp)
12770 (- (match-end 0) (point) 1))
12771 1))
12772 (cond
12773 ((and (equal current "") (equal tags "")))
12774 ((re-search-forward
12776 (point-at-eol) t)
12777 (if (equal tags "")
12778 (setq rpl "")
12779 (goto-char (match-beginning 0))
12780 (setq c0 (current-column)
12781 ;; compute offset for the case of org-indent-mode active
12782 di (if org-indent-mode
12783 (* (1- org-indent-indentation-per-level) (1- level))
12784 0)
12785 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
12786 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
12787 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
12788 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12789 (replace-match rpl t t)
12790 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
12791 tags)
12792 (t (error "Tags alignment failed")))
12793 (org-move-to-column col)
12794 (unless just-align
12795 (run-hooks 'org-after-tags-change-hook)))))
12797 (defun org-change-tag-in-region (beg end tag off)
12798 "Add or remove TAG for each entry in the region.
12799 This works in the agenda, and also in an org-mode buffer."
12800 (interactive
12801 (list (region-beginning) (region-end)
12802 (let ((org-last-tags-completion-table
12803 (if (org-mode-p)
12804 (org-get-buffer-tags)
12805 (org-global-tags-completion-table))))
12806 (org-icompleting-read
12807 "Tag: " 'org-tags-completion-function nil nil nil
12808 'org-tags-history))
12809 (progn
12811 (equal (read-char-exclusive) ?r))))
12812 (if (fboundp 'deactivate-mark) (deactivate-mark))
12813 (let ((agendap (equal major-mode 'org-agenda-mode))
12814 l1 l2 m buf pos newhead (cnt 0))
12815 (goto-char end)
12816 (setq l2 (1- (org-current-line)))
12817 (goto-char beg)
12818 (setq l1 (org-current-line))
12819 (loop for l from l1 to l2 do
12820 (org-goto-line l)
12821 (setq m (get-text-property (point) 'org-hd-marker))
12822 (when (or (and (org-mode-p) (org-on-heading-p))
12823 (and agendap m))
12824 (setq buf (if agendap (marker-buffer m) (current-buffer))
12825 pos (if agendap m (point)))
12826 (with-current-buffer buf
12827 (save-excursion
12828 (save-restriction
12829 (goto-char pos)
12830 (setq cnt (1+ cnt))
12831 (org-toggle-tag tag (if off 'off 'on))
12832 (setq newhead (org-get-heading)))))
12833 (and agendap (org-agenda-change-all-lines newhead m))))
12834 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
12836 (defun org-tags-completion-function (string predicate &optional flag)
12837 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12838 (confirm (lambda (x) (stringp (car x)))))
12840 (setq s1 (match-string 1 string)
12841 s2 (match-string 2 string))
12842 (setq s1 "" s2 string))
12843 (cond
12844 ((eq flag nil)
12845 ;; try completion
12846 (setq rtn (try-completion s2 ctable confirm))
12847 (if (stringp rtn)
12848 (setq rtn
12849 (concat s1 s2 (substring rtn (length s2))
12850 (if (and org-add-colon-after-tag-completion
12851 (assoc rtn ctable))
12852 ":" ""))))
12853 rtn)
12854 ((eq flag t)
12855 ;; all-completions
12856 (all-completions s2 ctable confirm)
12857 )
12858 ((eq flag 'lambda)
12859 ;; exact match?
12860 (assoc s2 ctable)))
12861 ))
12863 (defun org-fast-tag-insert (kwd tags face &optional end)
12864 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
12865 (insert (format "%-12s" (concat kwd ":"))
12866 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
12867 (or end "")))
12869 (defun org-fast-tag-show-exit (flag)
12870 (save-excursion
12871 (org-goto-line 3)
12873 (replace-match ""))
12874 (when flag
12875 (end-of-line 1)
12876 (org-move-to-column (- (window-width) 19) t)
12877 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
12879 (defun org-set-current-tags-overlay (current prefix)
12880 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
12881 (if (featurep 'xemacs)
12882 (org-overlay-display org-tags-overlay (concat prefix s)
12883 'secondary-selection)
12884 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
12885 (org-overlay-display org-tags-overlay (concat prefix s)))))
12887 (defvar org-last-tag-selection-key nil)
12888 (defun org-fast-tag-selection (current inherited table &optional todo-table)
12889 "Fast tag selection with single keys.
12890 CURRENT is the current list of tags in the headline, INHERITED is the
12891 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
12892 possibly with grouping information. TODO-TABLE is a similar table with
12893 TODO keywords, should these have keys assigned to them.
12894 If the keys are nil, a-z are automatically assigned.
12895 Returns the new tags string, or nil to not change the current settings."
12896 (let* ((fulltable (append table todo-table))
12897 (maxlen (apply 'max (mapcar
12898 (lambda (x)
12899 (if (stringp (car x)) (string-width (car x)) 0))
12900 fulltable)))
12901 (buf (current-buffer))
12902 (expert (eq org-fast-tag-selection-single-key 'expert))
12903 (buffer-tags nil)
12904 (fwidth (+ maxlen 3 1 3))
12905 (ncol (/ (- (window-width) 4) fwidth))
12906 (i-face 'org-done)
12907 (c-face 'org-todo)
12908 tg cnt e c char c1 c2 ntable tbl rtn
12909 ov-start ov-end ov-prefix
12910 (exit-after-next org-fast-tag-selection-single-key)
12911 (done-keywords org-done-keywords)
12912 groups ingroup)
12913 (save-excursion
12914 (beginning-of-line 1)
12915 (if (looking-at
12917 (setq ov-start (match-beginning 1)
12918 ov-end (match-end 1)
12919 ov-prefix "")
12920 (setq ov-start (1- (point-at-eol))
12921 ov-end (1+ ov-start))
12923 (setq ov-prefix
12924 (concat
12925 (buffer-substring (1- (point)) (point))
12926 (if (> (current-column) org-tags-column)
12927 " "
12928 (make-string (- org-tags-column (current-column)) ?\ ))))))
12929 (move-overlay org-tags-overlay ov-start ov-end)
12930 (save-window-excursion
12931 (if expert
12932 (set-buffer (get-buffer-create " *Org tags*"))
12933 (delete-other-windows)
12934 (split-window-vertically)
12935 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
12936 (erase-buffer)
12937 (org-set-local 'org-done-keywords done-keywords)
12940 (org-fast-tag-show-exit exit-after-next)
12941 (org-set-current-tags-overlay current ov-prefix)
12942 (setq tbl fulltable char ?a cnt 0)
12943 (while (setq e (pop tbl))
12944 (cond
12945 ((equal (car e) :startgroup)
12946 (push '() groups) (setq ingroup t)
12947 (when (not (= cnt 0))
12948 (setq cnt 0)
12950 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
12951 ((equal (car e) :endgroup)
12952 (setq ingroup nil cnt 0)
12954 ((equal e '(:newline))
12955 (when (not (= cnt 0))
12956 (setq cnt 0)
12958 (setq e (car tbl))
12959 (while (equal (car tbl) '(:newline))
12961 (setq tbl (cdr tbl)))))
12962 (t
12963 (setq tg (copy-sequence (car e)) c2 nil)
12964 (if (cdr e)
12965 (setq c (cdr e))
12966 ;; automatically assign a character.
12967 (setq c1 (string-to-char
12968 (downcase (substring
12969 tg (if (= (string-to-char tg) ?@) 1 0)))))
12970 (if (or (rassoc c1 ntable) (rassoc c1 table))
12971 (while (or (rassoc char ntable) (rassoc char table))
12972 (setq char (1+ char)))
12973 (setq c2 c1))
12974 (setq c (or c2 char)))
12975 (if ingroup (push tg (car groups)))
12976 (setq tg (org-add-props tg nil 'face
12977 (cond
12978 ((not (assoc tg table))
12979 (org-get-todo-face tg))
12980 ((member tg current) c-face)
12981 ((member tg inherited) i-face)
12982 (t nil))))
12983 (if (and (= cnt 0) (not ingroup)) (insert " "))
12984 (insert "[" c "] " tg (make-string
12985 (- fwidth 4 (length tg)) ?\ ))
12986 (push (cons tg c) ntable)
12987 (when (= (setq cnt (1+ cnt)) ncol)
12989 (if ingroup (insert " "))
12990 (setq cnt 0)))))
12991 (setq ntable (nreverse ntable))
12993 (goto-char (point-min))
12994 (if (not expert) (org-fit-window-to-buffer))
12995 (setq rtn
12996 (catch 'exit
12997 (while t
12998 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
12999 (if (not groups) "no " "")
13000 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13001 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13002 (setq org-last-tag-selection-key c)
13003 (cond
13005 ((= c ?!)
13006 (setq groups (not groups))
13007 (goto-char (point-min))
13008 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13009 ((= c ?\C-c)
13010 (if (not expert)
13011 (org-fast-tag-show-exit
13012 (setq exit-after-next (not exit-after-next)))
13013 (setq expert nil)
13014 (delete-other-windows)
13015 (split-window-vertically)
13016 (org-switch-to-buffer-other-window " *Org tags*")
13017 (org-fit-window-to-buffer)))
13018 ((or (= c ?\C-g)
13019 (and (= c ?q) (not (rassoc c ntable))))
13020 (org-detach-overlay org-tags-overlay)
13021 (setq quit-flag t))
13022 ((= c ?\ )
13023 (setq current nil)
13024 (if exit-after-next (setq exit-after-next 'now)))
13026 (condition-case nil
13027 (setq tg (org-icompleting-read
13028 "Tag: "
13029 (or buffer-tags
13030 (with-current-buffer buf
13031 (org-get-buffer-tags)))))
13032 (quit (setq tg "")))
13034 (add-to-list 'buffer-tags (list tg))
13035 (if (member tg current)
13036 (setq current (delete tg current))
13037 (push tg current)))
13038 (if exit-after-next (setq exit-after-next 'now)))
13039 ((setq e (rassoc c todo-table) tg (car e))
13040 (with-current-buffer buf
13041 (save-excursion (org-todo tg)))
13042 (if exit-after-next (setq exit-after-next 'now)))
13043 ((setq e (rassoc c ntable) tg (car e))
13044 (if (member tg current)
13045 (setq current (delete tg current))
13046 (loop for g in groups do
13047 (if (member tg g)
13048 (mapc (lambda (x)
13049 (setq current (delete x current)))
13050 g)))
13051 (push tg current))
13052 (if exit-after-next (setq exit-after-next 'now))))
13054 ;; Create a sorted list
13055 (setq current
13056 (sort current
13057 (lambda (a b)
13058 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13059 (if (eq exit-after-next 'now) (throw 'exit t))
13060 (goto-char (point-min))
13061 (beginning-of-line 2)
13062 (delete-region (point) (point-at-eol))
13063 (org-fast-tag-insert "Current" current c-face)
13064 (org-set-current-tags-overlay current ov-prefix)
13065 (while (re-search-forward
13067 (setq tg (match-string 1))
13068 (add-text-properties
13069 (match-beginning 1) (match-end 1)
13070 (list 'face
13071 (cond
13072 ((member tg current) c-face)
13073 ((member tg inherited) i-face)
13074 (t (get-text-property (match-beginning 1) 'face))))))
13075 (goto-char (point-min)))))
13076 (org-detach-overlay org-tags-overlay)
13077 (if rtn
13078 (mapconcat 'identity current ":")
13079 nil))))
13081 (defun org-get-tags-string ()
13082 "Get the TAGS string in the current headline."
13083 (unless (org-on-heading-p t)
13084 (error "Not on a heading"))
13085 (save-excursion
13086 (beginning-of-line 1)
13088 (org-match-string-no-properties 1)
13089 "")))
13091 (defun org-get-tags ()
13092 "Get the list of tags specified in the current headline."
13093 (org-split-string (org-get-tags-string) ":"))
13095 (defun org-get-buffer-tags ()
13096 "Get a table of all tags used in the buffer, for completion."
13097 (let (tags)
13098 (save-excursion
13099 (goto-char (point-min))
13100 (while (re-search-forward
13102 (when (equal (char-after (point-at-bol 0)) ?*)
13103 (mapc (lambda (x) (add-to-list 'tags x))
13104 (org-split-string (org-match-string-no-properties 1) ":")))))
13105 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13106 (mapcar 'list tags)))
13108 ;;;; The mapping API
13110 ;;;###autoload
13111 (defun org-map-entries (func &optional match scope &rest skip)
13112 "Call FUNC at each headline selected by MATCH in SCOPE.
13114 FUNC is a function or a lisp form. The function will be called without
13115 arguments, with the cursor positioned at the beginning of the headline.
13116 The return values of all calls to the function will be collected and
13117 returned as a list.
13119 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13120 does not need to preserve point. After evaluation, the cursor will be
13121 moved to the end of the line (presumably of the headline of the
13122 processed entry) and search continues from there. Under some
13123 circumstances, this may not produce the wanted results. For example,
13124 if you have removed (e.g. archived) the current (sub)tree it could
13125 mean that the next entry will be skipped entirely. In such cases, you
13126 can specify the position from where search should continue by making
13127 FUNC set the variable `org-map-continue-from' to the desired buffer
13128 position.
13130 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13131 Only headlines that are matched by this query will be considered during
13132 the iteration. When MATCH is nil or t, all headlines will be
13133 visited by the iteration.
13135 SCOPE determines the scope of this command. It can be any of:
13137 nil The current buffer, respecting the restriction if any
13138 tree The subtree started with the entry at point
13139 file The current buffer, without restriction
13140 file-with-archives
13141 The current buffer, and any archives associated with it
13142 agenda All agenda files
13143 agenda-with-archives
13144 All agenda files with any archive files associated with them
13145 \(file1 file2 ...)
13146 If this is a list, all files in the list will be scanned
13148 The remaining args are treated as settings for the skipping facilities of
13149 the scanner. The following items can be given here:
13151 archive skip trees with the archive tag.
13152 comment skip trees with the COMMENT keyword
13153 function or Emacs Lisp form:
13154 will be used as value for `org-agenda-skip-function', so whenever
13155 the function returns t, FUNC will not be called for that
13156 entry and search will continue from the point where the
13157 function leaves it.
13159 If your function needs to retrieve the tags including inherited tags
13160 at the *current* entry, you can use the value of the variable
13161 `org-scanner-tags' which will be much faster than getting the value
13162 with `org-get-tags-at'. If your function gets properties with
13163 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13164 to t around the call to `org-entry-properties' to get the same speedup.
13165 Note that if your function moves around to retrieve tags and properties at
13166 a *different* entry, you cannot use these techniques."
13167 (let* ((org-agenda-archives-mode nil) ; just to make sure
13168 (org-agenda-skip-archived-trees (memq 'archive skip))
13169 (org-agenda-skip-comment-trees (memq 'comment skip))
13170 (org-agenda-skip-function
13171 (car (org-delete-all '(comment archive) skip)))
13172 (org-tags-match-list-sublevels t)
13173 matcher file res
13174 org-todo-keywords-for-agenda
13175 org-done-keywords-for-agenda
13176 org-todo-keyword-alist-for-agenda
13177 org-drawers-for-agenda
13178 org-tag-alist-for-agenda)
13180 (cond
13181 ((eq match t) (setq matcher t))
13182 ((eq match nil) (setq matcher t))
13183 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13185 (save-excursion
13186 (save-restriction
13187 (when (eq scope 'tree)
13188 (org-back-to-heading t)
13189 (org-narrow-to-subtree)
13190 (setq scope nil))
13192 (if (not scope)
13193 (progn
13194 (org-prepare-agenda-buffers
13195 (list (buffer-file-name (current-buffer))))
13196 (setq res (org-scan-tags func matcher)))
13197 ;; Get the right scope
13198 (cond
13199 ((and scope (listp scope) (symbolp (car scope)))
13200 (setq scope (eval scope)))
13201 ((eq scope 'agenda)
13202 (setq scope (org-agenda-files t)))
13203 ((eq scope 'agenda-with-archives)
13204 (setq scope (org-agenda-files t))
13205 (setq scope (org-add-archive-files scope)))
13206 ((eq scope 'file)
13207 (setq scope (list (buffer-file-name))))
13208 ((eq scope 'file-with-archives)
13209 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13210 (org-prepare-agenda-buffers scope)
13211 (while (setq file (pop scope))
13212 (with-current-buffer (org-find-base-buffer-visiting file)
13213 (save-excursion
13214 (save-restriction
13215 (widen)
13216 (goto-char (point-min))
13217 (setq res (append res (org-scan-tags func matcher))))))))))
13218 res))
13220 ;;;; Properties
13222 ;;; Setting and retrieving properties
13224 (defconst org-special-properties
13225 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13226 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED")
13227 "The special properties valid in Org-mode.
13229 These are properties that are not defined in the property drawer,
13230 but in some other way.")
13232 (defconst org-default-properties
13233 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13234 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13235 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13236 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13237 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13238 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13239 "Some properties that are used by Org-mode for various purposes.
13240 Being in this list makes sure that they are offered for completion.")
13243 "Regular expression matching the first line of a property drawer.")
13246 "Regular expression matching the last line of a property drawer.")
13249 "Regular expression matching the first line of a property drawer.")
13252 "Regular expression matching the first line of a property drawer.")
13254 (defconst org-property-drawer-re
13257 "Matches an entire property drawer.")
13259 (defconst org-clock-drawer-re
13262 "Matches an entire clock drawer.")
13264 (defun org-property-action ()
13265 "Do an action on properties."
13266 (interactive)
13267 (let (c)
13268 (org-at-property-p)
13269 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13270 (setq c (read-char-exclusive))
13271 (cond
13272 ((equal c ?s)
13273 (call-interactively 'org-set-property))
13274 ((equal c ?d)
13275 (call-interactively 'org-delete-property))
13276 ((equal c ?D)
13277 (call-interactively 'org-delete-property-globally))
13278 ((equal c ?c)
13279 (call-interactively 'org-compute-property-at-point))
13280 (t (error "No such property action %c" c)))))
13282 (defun org-set-effort (&optional value)
13283 "Set the effort property of the current entry.
13284 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13285 allowed value."
13286 (interactive "P")
13287 (if (equal value 0) (setq value 10))
13288 (let* ((completion-ignore-case t)
13289 (prop org-effort-property)
13290 (cur (org-entry-get nil prop))
13291 (allowed (org-property-get-allowed-values nil prop 'table))
13292 (existing (mapcar 'list (org-property-values prop)))
13293 rpl
13294 (val (cond
13295 ((stringp value) value)
13296 ((and allowed (integerp value))
13297 (or (car (nth (1- value) allowed))
13298 (car (org-last allowed))))
13299 (allowed
13300 (message "Select 1-9,0, [RET%s]: %s"
13301 (if cur (concat "=" cur) "")
13302 (mapconcat 'car allowed " "))
13303 (setq rpl (read-char-exclusive))
13305 cur
13306 (setq rpl (- rpl ?0))
13307 (if (equal rpl 0) (setq rpl 10))
13308 (if (and (> rpl 0) (<= rpl (length allowed)))
13309 (car (nth (1- rpl) allowed))
13310 (org-completing-read "Effort: " allowed nil))))
13311 (t
13312 (let (org-completion-use-ido org-completion-use-iswitchb)
13313 (org-completing-read
13315 (concat "[" cur "]") "")
13316 ": ")
13317 existing nil nil "" nil cur))))))
13318 (unless (equal (org-entry-get nil prop) val)
13319 (org-entry-put nil prop val))
13320 (message "%s is now %s" prop val)))
13322 (defun org-at-property-p ()
13323 "Is cursor inside a property drawer?"
13324 (save-excursion
13325 (beginning-of-line 1)
13327 (save-match-data ;; Used by calling procedures
13328 (let ((p (point))
13329 (range (unless (org-before-first-heading-p)
13330 (org-get-property-block))))
13331 (and range (<= (car range) p) (< p (cdr range))))))))
13333 (defun org-get-property-block (&optional beg end force)
13334 "Return the (beg . end) range of the body of the property drawer.
13335 BEG and END can be beginning and end of subtree, if not given
13336 they will be found.
13337 If the drawer does not exist and FORCE is non-nil, create the drawer."
13338 (catch 'exit
13339 (save-excursion
13340 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13341 (end (or end (progn (outline-next-heading) (point)))))
13342 (goto-char beg)
13343 (if (re-search-forward org-property-start-re end t)
13344 (setq beg (1+ (match-end 0)))
13345 (if force
13346 (save-excursion
13347 (org-insert-property-drawer)
13348 (setq end (progn (outline-next-heading) (point))))
13349 (throw 'exit nil))
13350 (goto-char beg)
13351 (if (re-search-forward org-property-start-re end t)
13352 (setq beg (1+ (match-end 0)))))
13353 (if (re-search-forward org-property-end-re end t)
13354 (setq end (match-beginning 0))
13355 (or force (throw 'exit nil))
13356 (goto-char beg)
13357 (setq end beg)
13358 (org-indent-line-function)
13360 (cons beg end)))))
13362 (defun org-entry-properties (&optional pom which specific)
13363 "Get all properties of the entry at point-or-marker POM.
13364 This includes the TODO keyword, the tags, time strings for deadline,
13365 scheduled, and clocking, and any additional properties defined in the
13366 entry. The return value is an alist, keys may occur multiple times
13367 if the property key was used several times.
13368 POM may also be nil, in which case the current entry is used.
13369 If WHICH is nil or `all', get all properties. If WHICH is
13370 `special' or `standard', only get that subclass. If WHICH
13371 is a string only get exactly this property. Specific can be a string, the
13372 specific property we are interested in. Specifying it can speed
13373 things up because then unnecessary parsing is avoided."
13374 (setq which (or which 'all))
13375 (org-with-point-at pom
13376 (let ((clockstr (substring org-clock-string 0 -1))
13377 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13378 (case-fold-search nil)
13379 beg end range props sum-props key key1 value string clocksum)
13380 (save-excursion
13381 (when (condition-case nil
13382 (and (org-mode-p) (org-back-to-heading t))
13383 (error nil))
13384 (setq beg (point))
13385 (setq sum-props (get-text-property (point) 'org-summaries))
13386 (setq clocksum (get-text-property (point) :org-clock-minutes))
13387 (outline-next-heading)
13388 (setq end (point))
13389 (when (memq which '(all special))
13390 ;; Get the special properties, like TODO and tags
13391 (goto-char beg)
13392 (when (and (or (not specific) (string= specific "TODO"))
13393 (looking-at org-todo-line-regexp) (match-end 2))
13394 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13395 (when (and (or (not specific) (string= specific "PRIORITY"))
13396 (looking-at org-priority-regexp))
13397 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13398 (when (and (or (not specific) (string= specific "TAGS"))
13399 (setq value (org-get-tags-string))
13401 (push (cons "TAGS" value) props))
13402 (when (and (or (not specific) (string= specific "ALLTAGS"))
13403 (setq value (org-get-tags-at)))
13404 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13405 ":"))
13406 props))
13407 (when (or (not specific) (string= specific "BLOCKED"))
13408 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13409 (when (or (not specific)
13410 (member specific
13411 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13412 "TIMESTAMP" "TIMESTAMP_IA")))
13413 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13414 (setq key (if (match-end 1)
13415 (substring (org-match-string-no-properties 1)
13416 0 -1))
13417 string (if (equal key clockstr)
13418 (org-no-properties
13419 (org-trim
13420 (buffer-substring
13421 (match-beginning 3) (goto-char
13422 (point-at-eol)))))
13423 (substring (org-match-string-no-properties 3)
13424 1 -1)))
13425 ;; Get the correct property name from the key. This is
13426 ;; necessary if the user has configured time keywords.
13427 (setq key1 (concat key ":"))
13428 (cond
13429 ((not key)
13430 (setq key
13431 (if (= (char-after (match-beginning 3)) ?\[)
13432 "TIMESTAMP_IA" "TIMESTAMP")))
13433 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13434 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13435 ((equal key1 org-closed-string) (setq key "CLOSED"))
13436 ((equal key1 org-clock-string) (setq key "CLOCK")))
13437 (when (or (equal key "CLOCK") (not (assoc key props)))
13438 (push (cons key string) props))))
13439 )
13441 (when (memq which '(all standard))
13442 ;; Get the standard properties, like :PROP: ...
13443 (setq range (org-get-property-block beg end))
13444 (when range
13445 (goto-char (car range))
13446 (while (re-search-forward
13448 (cdr range) t)
13449 (setq key (org-match-string-no-properties 1)
13450 value (org-trim (or (org-match-string-no-properties 2) "")))
13451 (unless (member key excluded)
13452 (push (cons key (or value "")) props)))))
13453 (if clocksum
13454 (push (cons "CLOCKSUM"
13455 (org-columns-number-to-string (/ (float clocksum) 60.)
13456 'add_times))
13457 props))
13458 (unless (assoc "CATEGORY" props)
13459 (setq value (or (org-get-category)
13460 (progn (org-refresh-category-properties)
13461 (org-get-category))))
13462 (push (cons "CATEGORY" value) props))
13463 (append sum-props (nreverse props)))))))
13465 (defun org-entry-get (pom property &optional inherit literal-nil)
13466 "Get value of PROPERTY for entry at point-or-marker POM.
13467 If INHERIT is non-nil and the entry does not have the property,
13468 then also check higher levels of the hierarchy.
13469 If INHERIT is the symbol `selective', use inheritance only if the setting
13470 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13471 If the property is present but empty, the return value is the empty string.
13472 If the property is not present at all, nil is returned.
13475 do not interpret it as the list atom nil. This is used for inheritance
13477 (org-with-point-at pom
13478 (if (and inherit (if (eq inherit 'selective)
13479 (org-property-inherit-p property)
13480 t))
13481 (org-entry-get-with-inheritance property literal-nil)
13482 (if (member property org-special-properties)
13483 ;; We need a special property. Use `org-entry-properties' to
13484 ;; retrieve it, but specify the wanted property
13485 (cdr (assoc property (org-entry-properties nil 'special property)))
13486 (let ((range (org-get-property-block)))
13487 (if (and range
13488 (goto-char (car range))
13489 (re-search-forward
13491 (cdr range) t))
13492 ;; Found the property, return it.
13493 (if (match-end 1)
13494 (if literal-nil
13495 (org-match-string-no-properties 1)
13496 (org-not-nil (org-match-string-no-properties 1)))
13497 "")))))))
13499 (defun org-property-or-variable-value (var &optional inherit)
13500 "Check if there is a property fixing the value of VAR.
13501 If yes, return this value. If not, return the current value of the variable."
13502 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13504 (read prop)
13505 (symbol-value var))))
13507 (defun org-entry-delete (pom property)
13508 "Delete the property PROPERTY from entry at point-or-marker POM."
13509 (org-with-point-at pom
13510 (if (member property org-special-properties)
13511 nil ; cannot delete these properties.
13512 (let ((range (org-get-property-block)))
13513 (if (and range
13514 (goto-char (car range))
13515 (re-search-forward
13517 (cdr range) t))
13518 (progn
13519 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13520 t)
13521 nil)))))
13523 ;; Multi-values properties are properties that contain multiple values
13524 ;; These values are assumed to be single words, separated by whitespace.
13525 (defun org-entry-add-to-multivalued-property (pom property value)
13526 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13527 (let* ((old (org-entry-get pom property))
13529 (setq value (org-entry-protect-space value))
13530 (unless (member value values)
13531 (setq values (cons value values))
13532 (org-entry-put pom property
13533 (mapconcat 'identity values " ")))))
13535 (defun org-entry-remove-from-multivalued-property (pom property value)
13536 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13537 (let* ((old (org-entry-get pom property))
13539 (setq value (org-entry-protect-space value))
13540 (when (member value values)
13541 (setq values (delete value values))
13542 (org-entry-put pom property
13543 (mapconcat 'identity values " ")))))
13545 (defun org-entry-member-in-multivalued-property (pom property value)
13546 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13547 (let* ((old (org-entry-get pom property))
13549 (setq value (org-entry-protect-space value))
13550 (member value values)))
13552 (defun org-entry-get-multivalued-property (pom property)
13553 "Return a list of values in a multivalued property."
13554 (let* ((value (org-entry-get pom property))
13556 (mapcar 'org-entry-restore-space values)))
13558 (defun org-entry-put-multivalued-property (pom property &rest values)
13559 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13560 VALUES should be a list of strings. Spaces will be protected."
13561 (org-entry-put pom property
13562 (mapconcat 'org-entry-protect-space values " "))
13563 (let* ((value (org-entry-get pom property))
13565 (mapcar 'org-entry-restore-space values)))
13567 (defun org-entry-protect-space (s)
13568 "Protect spaces and newline in string S."
13569 (while (string-match " " s)
13570 (setq s (replace-match "%20" t t s)))
13572 (setq s (replace-match "%0A" t t s)))
13573 s)
13575 (defun org-entry-restore-space (s)
13576 "Restore spaces and newline in string S."
13577 (while (string-match "%20" s)
13578 (setq s (replace-match " " t t s)))
13579 (while (string-match "%0A" s)
13581 s)
13583 (defvar org-entry-property-inherited-from (make-marker)
13584 "Marker pointing to the entry from where a property was inherited.
13585 Each call to `org-entry-get-with-inheritance' will set this marker to the
13586 location of the entry where the inheritance search matched. If there was
13587 no match, the marker will point nowhere.
13588 Note that also `org-entry-get' calls this function, if the INHERIT flag
13589 is set.")
13591 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13592 "Get entry property, and search higher levels if not present.
13593 The search will stop at the first ancestor which has the property defined.
13595 should be considered as undefined (this is the meaning of nil here).
13597 (move-marker org-entry-property-inherited-from nil)
13598 (let (tmp)
13599 (save-excursion
13600 (save-restriction
13601 (widen)
13602 (catch 'ex
13603 (while t
13604 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13605 (org-back-to-heading t)
13606 (move-marker org-entry-property-inherited-from (point))
13607 (throw 'ex tmp))
13608 (or (org-up-heading-safe) (throw 'ex nil)))))
13609 (setq tmp (or tmp
13610 (cdr (assoc property org-file-properties))
13611 (cdr (assoc property org-global-properties))
13612 (cdr (assoc property org-global-properties-fixed))))
13613 (if literal-nil tmp (org-not-nil tmp)))))
13615 (defvar org-property-changed-functions nil
13616 "Hook called when the value of a property has changed.
13617 Each hook function should accept two arguments, the name of the property
13618 and the new value.")
13620 (defun org-entry-put (pom property value)
13621 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13622 (org-with-point-at pom
13623 (org-back-to-heading t)
13624 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13625 range)
13626 (cond
13627 ((equal property "TODO")
13629 (not (member value org-todo-keywords-1)))
13631 (if (or (not value)
13633 (setq value 'none))
13634 (org-todo value)
13635 (org-set-tags nil 'align))
13636 ((equal property "PRIORITY")
13638 (string-to-char value) ?\ ))
13639 (org-set-tags nil 'align))
13640 ((equal property "SCHEDULED")
13641 (if (re-search-forward org-scheduled-time-regexp end t)
13642 (cond
13643 ((eq value 'earlier) (org-timestamp-change -1 'day))
13644 ((eq value 'later) (org-timestamp-change 1 'day))
13645 (t (call-interactively 'org-schedule)))
13646 (call-interactively 'org-schedule)))
13647 ((equal property "DEADLINE")
13648 (if (re-search-forward org-deadline-time-regexp end t)
13649 (cond
13650 ((eq value 'earlier) (org-timestamp-change -1 'day))
13651 ((eq value 'later) (org-timestamp-change 1 'day))
13652 (t (call-interactively 'org-deadline)))
13653 (call-interactively 'org-deadline)))
13654 ((member property org-special-properties)
13655 (error "The %s property can not yet be set with `org-entry-put'"
13656 property))
13657 (t ; a non-special property
13658 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13659 (setq range (org-get-property-block beg end 'force))
13660 (goto-char (car range))
13661 (if (re-search-forward
13663 (progn
13664 (delete-region (match-beginning 1) (match-end 1))
13665 (goto-char (match-beginning 1)))
13666 (goto-char (cdr range))
13668 (backward-char 1)
13669 (org-indent-line-function)
13670 (insert ":" property ":"))
13671 (and value (insert " " value))
13672 (org-indent-line-function)))))
13673 (run-hook-with-args 'org-property-changed-functions property value)))
13675 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13676 "Get all property keys in the current buffer.
13677 With INCLUDE-SPECIALS, also list the special properties that reflect things
13678 like tags and TODO state.
13679 With INCLUDE-DEFAULTS, also include properties that has special meaning
13680 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
13681 With INCLUDE-COLUMNS, also include property names given in COLUMN
13682 formats in the current buffer."
13683 (let (rtn range cfmt s p)
13684 (save-excursion
13685 (save-restriction
13686 (widen)
13687 (goto-char (point-min))
13688 (while (re-search-forward org-property-start-re nil t)
13689 (setq range (org-get-property-block))
13690 (goto-char (car range))
13691 (while (re-search-forward
13693 (cdr range) t)
13694 (add-to-list 'rtn (org-match-string-no-properties 1)))
13695 (outline-next-heading))))
13697 (when include-specials
13698 (setq rtn (append org-special-properties rtn)))
13700 (when include-defaults
13701 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13702 (add-to-list 'rtn org-effort-property))
13704 (when include-columns
13705 (save-excursion
13706 (save-restriction
13707 (widen)
13708 (goto-char (point-min))
13709 (while (re-search-forward
13711 nil t)
13712 (setq cfmt (match-string 2) s 0)
13714 cfmt s)
13715 (setq s (match-end 0)
13716 p (match-string 1 cfmt))
13717 (unless (or (equal p "ITEM")
13718 (member p org-special-properties))
13719 (add-to-list 'rtn (match-string 1 cfmt))))))))
13721 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13723 (defun org-property-values (key)
13724 "Return a list of all values of property KEY."
13725 (save-excursion
13726 (save-restriction
13727 (widen)
13728 (goto-char (point-min))
13730 values)
13731 (while (re-search-forward re nil t)
13732 (add-to-list 'values (org-trim (match-string 1))))
13733 (delete "" values)))))
13735 (defun org-insert-property-drawer ()
13736 "Insert a property drawer into the current entry."
13737 (interactive)
13738 (org-back-to-heading t)
13739 (looking-at outline-regexp)
13740 (let ((indent (if org-adapt-indentation
13741 (- (match-end 0)(match-beginning 0))
13742 0))
13743 (beg (point))
13745 end hiddenp)
13746 (outline-next-heading)
13747 (setq end (point))
13748 (goto-char beg)
13749 (while (re-search-forward re end t))
13750 (setq hiddenp (org-invisible-p))
13751 (end-of-line 1)
13754 (if (member (match-string 1) '("CLOCK:" ":END:"))
13755 ;; just skip this line
13756 (beginning-of-line 2)
13757 ;; Drawer start, find the end
13759 (beginning-of-line 1)))
13760 (org-skip-over-state-notes)
13762 (if (eq (char-before) ?*) (forward-char 1))
13764 (beginning-of-line 0)
13765 (org-indent-to-column indent)
13766 (beginning-of-line 2)
13767 (org-indent-to-column indent)
13768 (beginning-of-line 0)
13769 (if hiddenp
13770 (save-excursion
13771 (org-back-to-heading t)
13772 (hide-entry))
13773 (org-flag-drawer t))))
13775 (defun org-set-property (property value)
13776 "In the current entry, set PROPERTY to VALUE.
13777 When called interactively, this will prompt for a property name, offering
13778 completion on existing and default properties. And then it will prompt
13779 for a value, offering completion either on allowed values (via an inherited
13780 xxx_ALL property) or on existing values in other instances of this property
13781 in the current file."
13782 (interactive
13783 (let* ((completion-ignore-case t)
13784 (keys (org-buffer-property-keys nil t t))
13785 (prop0 (org-icompleting-read "Property: " (mapcar 'list keys)))
13786 (prop (if (member prop0 keys)
13787 prop0
13788 (or (cdr (assoc (downcase prop0)
13789 (mapcar (lambda (x) (cons (downcase x) x))
13790 keys)))
13791 prop0)))
13792 (cur (org-entry-get nil prop))
13793 (prompt (concat prop " value"
13795 (concat " [" cur "]") "") ": "))
13796 (allowed (org-property-get-allowed-values nil prop 'table))
13797 (existing (mapcar 'list (org-property-values prop)))
13798 (val (if allowed
13799 (org-completing-read prompt allowed nil
13800 (not (get-text-property 0 'org-unrestricted
13801 (caar allowed))))
13802 (let (org-completion-use-ido org-completion-use-iswitchb)
13803 (org-completing-read prompt existing nil nil "" nil cur)))))
13804 (list prop (if (equal val "") cur val))))
13805 (unless (equal (org-entry-get nil property) value)
13806 (org-entry-put nil property value)))
13808 (defun org-delete-property (property)
13809 "In the current entry, delete PROPERTY."
13810 (interactive
13811 (let* ((completion-ignore-case t)
13812 (prop (org-icompleting-read "Property: "
13813 (org-entry-properties nil 'standard))))
13814 (list prop)))
13815 (message "Property %s %s" property
13816 (if (org-entry-delete nil property)
13817 "deleted"
13818 "was not present in the entry")))
13820 (defun org-delete-property-globally (property)
13821 "Remove PROPERTY globally, from all entries."
13822 (interactive
13823 (let* ((completion-ignore-case t)
13824 (prop (org-icompleting-read
13825 "Globally remove property: "
13826 (mapcar 'list (org-buffer-property-keys)))))
13827 (list prop)))
13828 (save-excursion
13829 (save-restriction
13830 (widen)
13831 (goto-char (point-min))
13832 (let ((cnt 0))
13833 (while (re-search-forward
13835 nil t)
13836 (setq cnt (1+ cnt))
13837 (replace-match ""))
13840 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
13842 (defun org-compute-property-at-point ()
13843 "Compute the property at point.
13844 This looks for an enclosing column format, extracts the operator and
13845 then applies it to the property in the column format's scope."
13846 (interactive)
13847 (unless (org-at-property-p)
13848 (error "Not at a property"))
13849 (let ((prop (org-match-string-no-properties 2)))
13850 (org-columns-get-format-and-top-level)
13851 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
13852 (error "No operator defined for property %s" prop))
13853 (org-columns-compute prop)))
13855 (defvar org-property-allowed-value-functions nil
13856 "Hook for functions supplying allowed values for a specific property.
13857 The functions must take a single argument, the name of the property, and
13859 the values, this means that these values are intended as defaults for
13860 completion, but that other values should be allowed too.
13861 The functions must return nil if they are not responsible for this
13862 property.")
13864 (defun org-property-get-allowed-values (pom property &optional table)
13865 "Get allowed values for the property PROPERTY.
13866 When TABLE is non-nil, return an alist that can directly be used for
13867 completion."
13868 (let (vals)
13869 (cond
13870 ((equal property "TODO")
13871 (setq vals (org-with-point-at pom
13872 (append org-todo-keywords-1 '("")))))
13873 ((equal property "PRIORITY")
13874 (let ((n org-lowest-priority))
13875 (while (>= n org-highest-priority)
13876 (push (char-to-string n) vals)
13877 (setq n (1- n)))))
13878 ((member property org-special-properties))
13879 ((setq vals (run-hook-with-args-until-success
13880 'org-property-allowed-value-functions property)))
13881 (t
13882 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
13884 (setq vals (car (read-from-string (concat "(" vals ")"))))
13885 (setq vals (mapcar (lambda (x)
13886 (cond ((stringp x) x)
13887 ((numberp x) (number-to-string x))
13888 ((symbolp x) (symbol-name x))
13889 (t "???")))
13890 vals)))))
13891 (when (member ":ETC" vals)
13892 (setq vals (remove ":ETC" vals))
13893 (org-add-props (car vals) '(org-unrestricted t)))
13894 (if table (mapcar 'list vals) vals)))
13896 (defun org-property-previous-allowed-value (&optional previous)
13897 "Switch to the next allowed value for this property."
13898 (interactive)
13899 (org-property-next-allowed-value t))
13901 (defun org-property-next-allowed-value (&optional previous)
13902 "Switch to the next allowed value for this property."
13903 (interactive)
13904 (unless (org-at-property-p)
13905 (error "Not at a property"))
13906 (let* ((key (match-string 2))
13907 (value (match-string 3))
13908 (allowed (or (org-property-get-allowed-values (point) key)
13909 (and (member value '("[ ]" "[-]" "[X]"))
13910 '("[ ]" "[X]"))))
13911 nval)
13912 (unless allowed
13913 (error "Allowed values for this property have not been defined"))
13914 (if previous (setq allowed (reverse allowed)))
13915 (if (member value allowed)
13916 (setq nval (car (cdr (member value allowed)))))
13917 (setq nval (or nval (car allowed)))
13918 (if (equal nval value)
13919 (error "Only one allowed value for this property"))
13920 (org-at-property-p)
13921 (replace-match (concat " :" key ": " nval) t t)
13922 (org-indent-line-function)
13923 (beginning-of-line 1)
13925 (run-hook-with-args 'org-property-changed-functions key nval)))
13927 (defun org-find-olp (path &optional this-buffer)
13928 "Return a marker pointing to the entry at outline path OLP.
13929 If anything goes wrong, throw an error.
13930 You can wrap this call to catch the error like this:
13932 (condition-case msg
13933 (org-mobile-locate-entry (match-string 4))
13934 (error (nth 1 msg)))
13936 The return value will then be either a string with the error message,
13937 or a marker if everything is OK.
13939 If THIS-BUFFER is set, the outline path does not contain a file,
13940 only headings."
13941 (let* ((file (if this-buffer buffer-file-name (pop path)))
13942 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
13943 (level 1)
13944 (lmin 1)
13945 (lmax 1)
13946 limit re end found pos heading cnt)
13947 (unless buffer (error "File not found :%s" file))
13948 (with-current-buffer buffer
13949 (save-excursion
13950 (save-restriction
13951 (widen)
13952 (setq limit (point-max))
13953 (goto-char (point-min))
13954 (while (setq heading (pop path))
13955 (setq re (format org-complex-heading-regexp-format
13956 (regexp-quote heading)))
13957 (setq cnt 0 pos (point))
13958 (while (re-search-forward re end t)
13959 (setq level (- (match-end 1) (match-beginning 1)))
13960 (if (and (>= level lmin) (<= level lmax))
13961 (setq found (match-beginning 0) cnt (1+ cnt))))
13962 (when (= cnt 0) (error "Heading not found on level %d: %s"
13963 lmax heading))
13964 (when (> cnt 1) (error "Heading not unique on level %d: %s"
13965 lmax heading))
13966 (goto-char found)
13967 (setq lmin (1+ level) lmax (+ lmin (if org-odd-levels-only 1 0)))
13968 (setq end (save-excursion (org-end-of-subtree t t))))
13969 (when (org-on-heading-p)
13970 (move-marker (make-marker) (point))))))))
13972 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
13973 "Find node HEADING in BUFFER.
13974 Return a marker to the heading if it was found, or nil if not.
13975 If POS-ONLY is set, return just the position instead of a marker.
13977 The heading text must match exact, but it may have a TODO keyword,
13978 a priority cookie and tags in the standard locations."
13979 (with-current-buffer (or buffer (current-buffer))
13980 (save-excursion
13981 (save-restriction
13982 (widen)
13983 (goto-char (point-min))
13984 (let (case-fold-search)
13985 (if (re-search-forward
13986 (format org-complex-heading-regexp-format
13987 (regexp-quote heading)) nil t)
13988 (if pos-only
13989 (match-beginning 0)
13990 (move-marker (make-marker) (match-beginning 0)))))))))
13992 (defun org-find-exact-heading-in-directory (heading &optional dir)
13993 "Find Org node headline HEADING in all .org files in directory DIR.
13994 When the target headline is found, return a marker to this location."
13995 (let ((files (directory-files (or dir default-directory)
13997 file visiting m buffer)
13998 (catch 'found
13999 (while (setq file (pop files))
14000 (message "trying %s" file)
14001 (setq visiting (org-find-base-buffer-visiting file))
14002 (setq buffer (or visiting (find-file-noselect file)))
14003 (setq m (org-find-exact-headline-in-buffer
14004 heading buffer))
14005 (when (and (not m) (not visiting)) (kill-buffer buffer))
14006 (and m (throw 'found m))))))
14008 (defun org-find-entry-with-id (ident)
14009 "Locate the entry that contains the ID property with exact value IDENT.
14010 IDENT can be a string, a symbol or a number, this function will search for
14011 the string representation of it.
14012 Return the position where this entry starts, or nil if there is no such entry."
14013 (interactive "sID: ")
14014 (let ((id (cond
14015 ((stringp ident) ident)
14016 ((symbol-name ident) (symbol-name ident))
14017 ((numberp ident) (number-to-string ident))
14018 (t (error "IDENT %s must be a string, symbol or number" ident))))
14019 (case-fold-search nil))
14020 (save-excursion
14021 (save-restriction
14022 (widen)
14023 (goto-char (point-min))
14024 (when (re-search-forward
14026 nil t)
14027 (org-back-to-heading t)
14028 (point))))))
14030 ;;;; Timestamps
14032 (defvar org-last-changed-timestamp nil)
14033 (defvar org-last-inserted-timestamp nil
14034 "The last time stamp inserted with `org-insert-time-stamp'.")
14035 (defvar org-time-was-given) ; dynamically scoped parameter
14036 (defvar org-end-time-was-given) ; dynamically scoped parameter
14037 (defvar org-ts-what) ; dynamically scoped parameter
14039 (defun org-time-stamp (arg &optional inactive)
14040 "Prompt for a date/time and insert a time stamp.
14041 If the user specifies a time like HH:MM, or if this command is called
14042 with a prefix argument, the time stamp will contain date and time.
14043 Otherwise, only the date will be included. All parts of a date not
14044 specified by the user will be filled in from the current date/time.
14045 So if you press just return without typing anything, the time stamp
14046 will represent the current date/time. If there is already a timestamp
14047 at the cursor, it will be modified."
14048 (interactive "P")
14049 (let* ((ts nil)
14050 (default-time
14051 ;; Default time is either today, or, when entering a range,
14052 ;; the range start.
14053 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14054 (save-excursion
14055 (re-search-backward
14057 (- (point) 20) t)))
14058 (apply 'encode-time (org-parse-time-string (match-string 1)))
14059 (current-time)))
14060 (default-input (and ts (org-get-compact-tod ts)))
14061 org-time-was-given org-end-time-was-given time)
14062 (cond
14063 ((and (org-at-timestamp-p t)
14064 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14065 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14066 (insert "--")
14067 (setq time (let ((this-command this-command))
14068 (org-read-date arg 'totime nil nil
14069 default-time default-input)))
14070 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14071 ((org-at-timestamp-p t)
14072 (setq time (let ((this-command this-command))
14073 (org-read-date arg 'totime nil nil default-time default-input)))
14074 (when (org-at-timestamp-p t) ; just to get the match data
14075 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14076 (replace-match "")
14077 (setq org-last-changed-timestamp
14078 (org-insert-time-stamp
14079 time (or org-time-was-given arg)
14080 inactive nil nil (list org-end-time-was-given))))
14081 (message "Timestamp updated"))
14082 (t
14083 (setq time (let ((this-command this-command))
14084 (org-read-date arg 'totime nil nil default-time default-input)))
14085 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14086 nil nil (list org-end-time-was-given))))))
14088 ;; FIXME: can we use this for something else, like computing time differences?
14089 (defun org-get-compact-tod (s)
14090 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14091 (let* ((t1 (match-string 1 s))
14092 (h1 (string-to-number (match-string 2 s)))
14093 (m1 (string-to-number (match-string 3 s)))
14094 (t2 (and (match-end 4) (match-string 5 s)))
14095 (h2 (and t2 (string-to-number (match-string 6 s))))
14096 (m2 (and t2 (string-to-number (match-string 7 s))))
14097 dh dm)
14098 (if (not t2)
14099 t1
14100 (setq dh (- h2 h1) dm (- m2 m1))
14101 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14102 (concat t1 "+" (number-to-string dh)
14103 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14105 (defun org-time-stamp-inactive (&optional arg)
14106 "Insert an inactive time stamp.
14107 An inactive time stamp is enclosed in square brackets instead of angle
14108 brackets. It is inactive in the sense that it does not trigger agenda entries,
14109 does not link to the calendar and cannot be changed with the S-cursor keys.
14110 So these are more for recording a certain time/date."
14111 (interactive "P")
14112 (org-time-stamp arg 'inactive))
14114 (defvar org-date-ovl (make-overlay 1 1))
14115 (overlay-put org-date-ovl 'face 'org-warning)
14116 (org-detach-overlay org-date-ovl)
14118 (defvar org-ans1) ; dynamically scoped parameter
14119 (defvar org-ans2) ; dynamically scoped parameter
14121 (defvar org-plain-time-of-day-regexp) ; defined below
14123 (defvar org-overriding-default-time nil) ; dynamically scoped
14124 (defvar org-read-date-overlay nil)
14125 (defvar org-dcst nil) ; dynamically scoped
14126 (defvar org-read-date-history nil)
14127 (defvar org-read-date-final-answer nil)
14129 (defun org-read-date (&optional with-time to-time from-string prompt
14130 default-time default-input)
14131 "Read a date, possibly a time, and make things smooth for the user.
14132 The prompt will suggest to enter an ISO date, but you can also enter anything
14133 which will at least partially be understood by `parse-time-string'.
14134 Unrecognized parts of the date will default to the current day, month, year,
14135 hour and minute. If this command is called to replace a timestamp at point,
14136 of to enter the second timestamp of a range, the default time is taken
14137 from the existing stamp. Furthermore, the command prefers the future,
14138 so if you are giving a date where the year is not given, and the day-month
14139 combination is already past in the current year, it will assume you
14140 mean next year. For details, see the manual. A few examples:
14142 3-2-5 --> 2003-02-05
14143 feb 15 --> currentyear-02-15
14144 2/15 --> currentyear-02-15
14145 sep 12 9 --> 2009-09-12
14146 12:45 --> today 12:45
14147 22 sept 0:34 --> currentyear-09-22 0:34
14148 12 --> currentyear-currentmonth-12
14149 Fri --> nearest Friday (today or later)
14150 etc.
14152 Furthermore you can specify a relative date by giving, as the *first* thing
14153 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14154 change in days weeks, months, years.
14155 With a single plus or minus, the date is relative to today. With a double
14156 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14157 +4d --> four days from today
14158 +4 --> same as above
14159 +2w --> two weeks from today
14160 ++5 --> five days from default date
14162 The function understands only English month and weekday abbreviations,
14163 but this can be configured with the variables `parse-time-months' and
14164 `parse-time-weekdays'.
14166 While prompting, a calendar is popped up - you can also select the
14167 date with the mouse (button 1). The calendar shows a period of three
14168 months. To scroll it to other months, use the keys `>' and `<'.
14169 If you don't like the calendar, turn it off with
14170 \(setq org-read-date-popup-calendar nil)
14172 With optional argument TO-TIME, the date will immediately be converted
14173 to an internal time.
14174 With an optional argument WITH-TIME, the prompt will suggest to also
14175 insert a time. Note that when WITH-TIME is not set, you can still
14176 enter a time, and this function will inform the calling routine about
14177 this change. The calling routine may then choose to change the format
14178 used to insert the time stamp into the buffer to include the time.
14179 With optional argument FROM-STRING, read from this string instead from
14180 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14181 the time/date that is used for everything that is not specified by the
14182 user."
14183 (require 'parse-time)
14184 (let* ((org-time-stamp-rounding-minutes
14185 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14186 (org-dcst org-display-custom-times)
14187 (ct (org-current-time))
14188 (def (or org-overriding-default-time default-time ct))
14189 (defdecode (decode-time def))
14190 (dummy (progn
14191 (when (< (nth 2 defdecode) org-extend-today-until)
14192 (setcar (nthcdr 2 defdecode) -1)
14193 (setcar (nthcdr 1 defdecode) 59)
14194 (setq def (apply 'encode-time defdecode)
14195 defdecode (decode-time def)))))
14196 (calendar-frame-setup nil)
14197 (calendar-setup nil)
14198 (calendar-move-hook nil)
14199 (calendar-view-diary-initially-flag nil)
14200 (calendar-view-holidays-initially-flag nil)
14201 (timestr (format-time-string
14202 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14203 (prompt (concat (if prompt (concat prompt " ") "")
14204 (format "Date+time [%s]: " timestr)))
14205 ans (org-ans0 "") org-ans1 org-ans2 final)
14207 (cond
14208 (from-string (setq ans from-string))
14209 (org-read-date-popup-calendar
14210 (save-excursion
14211 (save-window-excursion
14212 (calendar)
14213 (calendar-forward-day (- (time-to-days def)
14214 (calendar-absolute-from-gregorian
14215 (calendar-current-date))))
14216 (org-eval-in-calendar nil t)
14217 (let* ((old-map (current-local-map))
14218 (map (copy-keymap calendar-mode-map))
14219 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14220 (org-defkey map (kbd "RET") 'org-calendar-select)
14221 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14222 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14223 (org-defkey minibuffer-local-map [(meta shift left)]
14224 (lambda () (interactive)
14225 (org-eval-in-calendar '(calendar-backward-month 1))))
14226 (org-defkey minibuffer-local-map [(meta shift right)]
14227 (lambda () (interactive)
14228 (org-eval-in-calendar '(calendar-forward-month 1))))
14229 (org-defkey minibuffer-local-map [(meta shift up)]
14230 (lambda () (interactive)
14231 (org-eval-in-calendar '(calendar-backward-year 1))))
14232 (org-defkey minibuffer-local-map [(meta shift down)]
14233 (lambda () (interactive)
14234 (org-eval-in-calendar '(calendar-forward-year 1))))
14235 (org-defkey minibuffer-local-map [?\e (shift left)]
14236 (lambda () (interactive)
14237 (org-eval-in-calendar '(calendar-backward-month 1))))
14238 (org-defkey minibuffer-local-map [?\e (shift right)]
14239 (lambda () (interactive)
14240 (org-eval-in-calendar '(calendar-forward-month 1))))
14241 (org-defkey minibuffer-local-map [?\e (shift up)]
14242 (lambda () (interactive)
14243 (org-eval-in-calendar '(calendar-backward-year 1))))
14244 (org-defkey minibuffer-local-map [?\e (shift down)]
14245 (lambda () (interactive)
14246 (org-eval-in-calendar '(calendar-forward-year 1))))
14247 (org-defkey minibuffer-local-map [(shift up)]
14248 (lambda () (interactive)
14249 (org-eval-in-calendar '(calendar-backward-week 1))))
14250 (org-defkey minibuffer-local-map [(shift down)]
14251 (lambda () (interactive)
14252 (org-eval-in-calendar '(calendar-forward-week 1))))
14253 (org-defkey minibuffer-local-map [(shift left)]
14254 (lambda () (interactive)
14255 (org-eval-in-calendar '(calendar-backward-day 1))))
14256 (org-defkey minibuffer-local-map [(shift right)]
14257 (lambda () (interactive)
14258 (org-eval-in-calendar '(calendar-forward-day 1))))
14259 (org-defkey minibuffer-local-map ">"
14260 (lambda () (interactive)
14261 (org-eval-in-calendar '(scroll-calendar-left 1))))
14262 (org-defkey minibuffer-local-map "<"
14263 (lambda () (interactive)
14264 (org-eval-in-calendar '(scroll-calendar-right 1))))
14265 (org-defkey minibuffer-local-map "\C-v"
14266 (lambda () (interactive)
14267 (org-eval-in-calendar
14268 '(calendar-scroll-left-three-months 1))))
14269 (org-defkey minibuffer-local-map "\M-v"
14270 (lambda () (interactive)
14271 (org-eval-in-calendar
14272 '(calendar-scroll-right-three-months 1))))
14273 (run-hooks 'org-read-date-minibuffer-setup-hook)
14274 (unwind-protect
14275 (progn
14276 (use-local-map map)
14277 (add-hook 'post-command-hook 'org-read-date-display)
14278 (setq org-ans0 (read-string prompt default-input
14279 'org-read-date-history nil))
14280 ;; org-ans0: from prompt
14281 ;; org-ans1: from mouse click
14282 ;; org-ans2: from calendar motion
14283 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14284 (remove-hook 'post-command-hook 'org-read-date-display)
14285 (use-local-map old-map)
14286 (when org-read-date-overlay
14287 (delete-overlay org-read-date-overlay)
14288 (setq org-read-date-overlay nil)))))))
14290 (t ; Naked prompt only
14291 (unwind-protect
14292 (setq ans (read-string prompt default-input
14293 'org-read-date-history timestr))
14294 (when org-read-date-overlay
14295 (delete-overlay org-read-date-overlay)
14296 (setq org-read-date-overlay nil)))))
14298 (setq final (org-read-date-analyze ans def defdecode))
14300 ;; One round trip to get rid of 34th of August and stuff like that....
14301 (setq final (decode-time (apply 'encode-time final)))
14303 (setq org-read-date-final-answer ans)
14305 (if to-time
14306 (apply 'encode-time final)
14307 (if (and (boundp 'org-time-was-given) org-time-was-given)
14308 (format "%04d-%02d-%02d %02d:%02d"
14309 (nth 5 final) (nth 4 final) (nth 3 final)
14310 (nth 2 final) (nth 1 final))
14311 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14313 (defvar def)
14314 (defvar defdecode)
14315 (defvar with-time)
14316 (defvar org-read-date-analyze-futurep nil)
14317 (defun org-read-date-display ()
14318 "Display the current date prompt interpretation in the minibuffer."
14319 (when org-read-date-display-live
14320 (when org-read-date-overlay
14321 (delete-overlay org-read-date-overlay))
14322 (let ((p (point)))
14323 (end-of-line 1)
14324 (while (not (equal (buffer-substring
14325 (max (point-min) (- (point) 4)) (point))
14326 " "))
14327 (insert " "))
14328 (goto-char p))
14329 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14330 " " (or org-ans1 org-ans2)))
14331 (org-end-time-was-given nil)
14332 (f (org-read-date-analyze ans def defdecode))
14333 (fmts (if org-dcst
14334 org-time-stamp-custom-formats
14335 org-time-stamp-formats))
14336 (fmt (if (or with-time
14337 (and (boundp 'org-time-was-given) org-time-was-given))
14338 (cdr fmts)
14339 (car fmts)))
14340 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14341 (when (and org-end-time-was-given
14342 (string-match org-plain-time-of-day-regexp txt))
14343 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14344 org-end-time-was-given
14345 (substring txt (match-end 0)))))
14346 (when org-read-date-analyze-futurep
14347 (setq txt (concat txt " (=>F)")))
14348 (setq org-read-date-overlay
14349 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14350 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14352 (defun org-read-date-analyze (ans def defdecode)
14353 "Analyze the combined answer of the date prompt."
14354 ;; FIXME: cleanup and comment
14355 (let ((nowdecode (decode-time (current-time)))
14356 delta deltan deltaw deltadef year month day
14357 hour minute second wday pm h2 m2 tl wday1
14358 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14359 (setq org-read-date-analyze-futurep nil)
14361 (setq ans "+0"))
14363 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14364 (setq ans (replace-match "" t t ans)
14365 deltan (car delta)
14366 deltaw (nth 1 delta)
14367 deltadef (nth 2 delta)))
14369 ;; Check if there is an iso week date in there
14370 ;; If yes, store the info and postpone interpreting it until the rest
14371 ;; of the parsing is done
14372 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14373 (setq iso-year (if (match-end 1)
14374 (org-small-year-to-year
14375 (string-to-number (match-string 1 ans))))
14376 iso-weekday (if (match-end 3)
14377 (string-to-number (match-string 3 ans)))
14378 iso-week (string-to-number (match-string 2 ans)))
14379 (setq ans (replace-match "" t t ans)))
14381 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14382 (when (string-match
14384 (setq year (if (match-end 2)
14385 (string-to-number (match-string 2 ans))
14386 (progn (setq kill-year t)
14387 (string-to-number (format-time-string "%Y"))))
14388 month (string-to-number (match-string 3 ans))
14389 day (string-to-number (match-string 4 ans)))
14390 (if (< year 100) (setq year (+ 2000 year)))
14392 t nil ans)))
14393 ;; Help matching american dates, like 5/30 or 5/30/7
14394 (when (string-match
14395 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14396 (setq year (if (match-end 4)
14397 (string-to-number (match-string 4 ans))
14398 (progn (setq kill-year t)
14399 (string-to-number (format-time-string "%Y"))))
14400 month (string-to-number (match-string 1 ans))
14401 day (string-to-number (match-string 2 ans)))
14402 (if (< year 100) (setq year (+ 2000 year)))
14404 t nil ans)))
14405 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14406 ;; If there is a time with am/pm, and *no* time without it, we convert
14407 ;; so that matching will be successful.
14408 (loop for i from 1 to 2 do ; twice, for end time as well
14411 (setq hour (string-to-number (match-string 1 ans))
14412 minute (if (match-end 3)
14413 (string-to-number (match-string 3 ans))
14414 0)
14415 pm (equal ?p
14416 (string-to-char (downcase (match-string 4 ans)))))
14417 (if (and (= hour 12) (not pm))
14418 (setq hour 0)
14419 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14420 (setq ans (replace-match (format "%02d:%02d" hour minute)
14421 t t ans))))
14423 ;; Check if a time range is given as a duration
14424 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14425 (setq hour (string-to-number (match-string 1 ans))
14426 h2 (+ hour (string-to-number (match-string 3 ans)))
14427 minute (string-to-number (match-string 2 ans))
14428 m2 (+ minute (if (match-end 5) (string-to-number
14429 (match-string 5 ans))0)))
14430 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14431 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14432 t t ans)))
14434 ;; Check if there is a time range
14435 (when (boundp 'org-end-time-was-given)
14436 (setq org-time-was-given nil)
14437 (when (and (string-match org-plain-time-of-day-regexp ans)
14438 (match-end 8))
14439 (setq org-end-time-was-given (match-string 8 ans))
14440 (setq ans (concat (substring ans 0 (match-beginning 7))
14441 (substring ans (match-end 7))))))
14443 (setq tl (parse-time-string ans)
14444 day (or (nth 3 tl) (nth 3 defdecode))
14445 month (or (nth 4 tl)
14446 (if (and org-read-date-prefer-future
14447 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14448 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14449 (nth 4 defdecode)))
14450 year (or (and (not kill-year) (nth 5 tl))
14451 (if (and org-read-date-prefer-future
14452 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14453 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14454 (nth 5 defdecode)))
14455 hour (or (nth 2 tl) (nth 2 defdecode))
14456 minute (or (nth 1 tl) (nth 1 defdecode))
14457 second (or (nth 0 tl) 0)
14458 wday (nth 6 tl))
14460 (when (and (eq org-read-date-prefer-future 'time)
14461 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14462 (equal day (nth 3 nowdecode))
14463 (equal month (nth 4 nowdecode))
14464 (equal year (nth 5 nowdecode))
14465 (nth 2 tl)
14466 (or (< (nth 2 tl) (nth 2 nowdecode))
14467 (and (= (nth 2 tl) (nth 2 nowdecode))
14468 (nth 1 tl)
14469 (< (nth 1 tl) (nth 1 nowdecode)))))
14470 (setq day (1+ day)
14471 futurep t))
14473 ;; Special date definitions below
14474 (cond
14475 (iso-week
14476 ;; There was an iso week
14477 (require 'cal-iso)
14478 (setq futurep nil)
14479 (setq year (or iso-year year)
14480 day (or iso-weekday wday 1)
14481 wday nil ; to make sure that the trigger below does not match
14482 iso-date (calendar-gregorian-from-absolute
14483 (calendar-absolute-from-iso
14484 (list iso-week day year))))
14485 ; FIXME: Should we also push ISO weeks into the future?
14486 ; (when (and org-read-date-prefer-future
14487 ; (not iso-year)
14488 ; (< (calendar-absolute-from-gregorian iso-date)
14489 ; (time-to-days (current-time))))
14490 ; (setq year (1+ year)
14491 ; iso-date (calendar-gregorian-from-absolute
14492 ; (calendar-absolute-from-iso
14493 ; (list iso-week day year)))))
14494 (setq month (car iso-date)
14495 year (nth 2 iso-date)
14496 day (nth 1 iso-date)))
14497 (deltan
14498 (setq futurep nil)
14499 (unless deltadef
14500 (let ((now (decode-time (current-time))))
14501 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14502 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14503 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14504 ((equal deltaw "m") (setq month (+ month deltan)))
14505 ((equal deltaw "y") (setq year (+ year deltan)))))
14506 ((and wday (not (nth 3 tl)))
14507 (setq futurep nil)
14508 ;; Weekday was given, but no day, so pick that day in the week
14509 ;; on or after the derived date.
14510 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14511 (unless (equal wday wday1)
14512 (setq day (+ day (% (- wday wday1 -7) 7))))))
14513 (if (and (boundp 'org-time-was-given)
14514 (nth 2 tl))
14515 (setq org-time-was-given t))
14516 (if (< year 100) (setq year (+ 2000 year)))
14517 (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
14518 (setq org-read-date-analyze-futurep futurep)
14519 (list second minute hour day month year)))
14521 (defvar parse-time-weekdays)
14523 (defun org-read-date-get-relative (s today default)
14524 "Check string S for special relative date string.
14525 TODAY and DEFAULT are internal times, for today and for a default.
14526 Return shift list (N what def-flag)
14528 N is the number of WHATs to shift.
14529 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14530 the DEFAULT date rather than TODAY."
14531 (when (and
14532 (string-match
14533 (concat
14538 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14539 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14540 (string-to-char (substring (match-string 1 s) -1))
14541 ?+))
14542 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14543 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14544 (what (if (match-end 3) (match-string 3 s) "d"))
14545 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14546 (date (if rel default today))
14547 (wday (nth 6 (decode-time date)))
14548 delta)
14549 (if wday1
14550 (progn
14551 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14552 (if (= dir ?-) (setq delta (- delta 7)))
14553 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14554 (list delta "d" rel))
14555 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14557 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14558 "Turn a user-specified date into the internal representation.
14559 The internal representation needed by the calendar is (month day year).
14560 This is a wrapper to handle the brain-dead convention in calendar that
14561 user function argument order change dependent on argument order."
14562 (if (boundp 'calendar-date-style)
14563 (cond
14564 ((eq calendar-date-style 'american)
14565 (list arg1 arg2 arg3))
14566 ((eq calendar-date-style 'european)
14567 (list arg2 arg1 arg3))
14568 ((eq calendar-date-style 'iso)
14569 (list arg2 arg3 arg1)))
14570 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
14571 (if (org-bound-and-true-p european-calendar-style)
14572 (list arg2 arg1 arg3)
14573 (list arg1 arg2 arg3)))))
14575 (defun org-eval-in-calendar (form &optional keepdate)
14576 "Eval FORM in the calendar window and return to current window.
14577 Also, store the cursor date in variable org-ans2."
14578 (let ((sf (selected-frame))
14579 (sw (selected-window)))
14580 (select-window (get-buffer-window "*Calendar*" t))
14581 (eval form)
14582 (when (and (not keepdate) (calendar-cursor-to-date))
14583 (let* ((date (calendar-cursor-to-date))
14584 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14585 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
14586 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
14587 (select-window sw)
14588 (org-select-frame-set-input-focus sf)))
14590 (defun org-calendar-select ()
14591 "Return to `org-read-date' with the date currently selected.
14592 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14593 (interactive)
14594 (when (calendar-cursor-to-date)
14595 (let* ((date (calendar-cursor-to-date))
14596 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14597 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14598 (if (active-minibuffer-window) (exit-minibuffer))))
14600 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
14601 "Insert a date stamp for the date given by the internal TIME.
14602 WITH-HM means use the stamp format that includes the time of the day.
14603 INACTIVE means use square brackets instead of angular ones, so that the
14604 stamp will not contribute to the agenda.
14605 PRE and POST are optional strings to be inserted before and after the
14606 stamp.
14607 The command returns the inserted time stamp."
14608 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
14609 stamp)
14610 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
14611 (insert-before-markers (or pre ""))
14612 (when (listp extra)
14613 (setq extra (car extra))
14614 (if (and (stringp extra)
14616 (setq extra (format "-%02d:%02d"
14617 (string-to-number (match-string 1 extra))
14618 (string-to-number (match-string 2 extra))))
14619 (setq extra nil)))
14620 (when extra
14621 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
14622 (insert-before-markers (setq stamp (format-time-string fmt time)))
14623 (insert-before-markers (or post ""))
14624 (setq org-last-inserted-timestamp stamp)))
14626 (defun org-toggle-time-stamp-overlays ()
14627 "Toggle the use of custom time stamp formats."
14628 (interactive)
14629 (setq org-display-custom-times (not org-display-custom-times))
14630 (unless org-display-custom-times
14631 (let ((p (point-min)) (bmp (buffer-modified-p)))
14632 (while (setq p (next-single-property-change p 'display))
14633 (if (and (get-text-property p 'display)
14634 (eq (get-text-property p 'face) 'org-date))
14635 (remove-text-properties
14636 p (setq p (next-single-property-change p 'display))
14637 '(display t))))
14638 (set-buffer-modified-p bmp)))
14639 (if (featurep 'xemacs)
14640 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
14641 (org-restart-font-lock)
14642 (setq org-table-may-need-update t)
14643 (if org-display-custom-times
14644 (message "Time stamps are overlayed with custom format")
14645 (message "Time stamp overlays removed")))
14647 (defun org-display-custom-time (beg end)
14648 "Overlay modified time stamp format over timestamp between BEG and END."
14649 (let* ((ts (buffer-substring beg end))
14650 t1 w1 with-hm tf time str w2 (off 0))
14651 (save-match-data
14652 (setq t1 (org-parse-time-string ts t))
14653 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
14654 (setq off (- (match-end 0) (match-beginning 0)))))
14655 (setq end (- end off))
14656 (setq w1 (- end beg)
14657 with-hm (and (nth 1 t1) (nth 2 t1))
14658 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
14659 time (org-fix-decoded-time t1)
14660 str (org-add-props
14661 (format-time-string
14662 (substring tf 1 -1) (apply 'encode-time time))
14663 nil 'mouse-face 'highlight)
14664 w2 (length str))
14665 (if (not (= w2 w1))
14666 (add-text-properties (1+ beg) (+ 2 beg)
14667 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
14668 (if (featurep 'xemacs)
14669 (progn
14670 (put-text-property beg end 'invisible t)
14671 (put-text-property beg end 'end-glyph (make-glyph str)))
14672 (put-text-property beg end 'display str))))
14674 (defun org-translate-time (string)
14675 "Translate all timestamps in STRING to custom format.
14676 But do this only if the variable `org-display-custom-times' is set."
14677 (when org-display-custom-times
14678 (save-match-data
14679 (let* ((start 0)
14680 (re org-ts-regexp-both)
14681 t1 with-hm inactive tf time str beg end)
14682 (while (setq start (string-match re string start))
14683 (setq beg (match-beginning 0)
14684 end (match-end 0)
14685 t1 (save-match-data
14686 (org-parse-time-string (substring string beg end) t))
14687 with-hm (and (nth 1 t1) (nth 2 t1))
14688 inactive (equal (substring string beg (1+ beg)) "[")
14689 tf (funcall (if with-hm 'cdr 'car)
14690 org-time-stamp-custom-formats)
14691 time (org-fix-decoded-time t1)
14692 str (format-time-string
14693 (concat
14694 (if inactive "[" "<") (substring tf 1 -1)
14695 (if inactive "]" ">"))
14696 (apply 'encode-time time))
14697 string (replace-match str t t string)
14698 start (+ start (length str)))))))
14699 string)
14701 (defun org-fix-decoded-time (time)
14702 "Set 0 instead of nil for the first 6 elements of time.
14703 Don't touch the rest."
14704 (let ((n 0))
14705 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
14707 (defun org-days-to-time (timestamp-string)
14708 "Difference between TIMESTAMP-STRING and now in days."
14709 (- (time-to-days (org-time-string-to-time timestamp-string))
14710 (time-to-days (current-time))))
14712 (defun org-deadline-close (timestamp-string &optional ndays)
14713 "Is the time in TIMESTAMP-STRING close to the current date?"
14714 (setq ndays (or ndays (org-get-wdays timestamp-string)))
14715 (and (< (org-days-to-time timestamp-string) ndays)
14716 (not (org-entry-is-done-p))))
14718 (defun org-get-wdays (ts)
14719 "Get the deadline lead time appropriate for timestring TS."
14720 (cond
14721 ((<= org-deadline-warning-days 0)
14722 ;; 0 or negative, enforce this value no matter what
14723 (- org-deadline-warning-days))
14725 ;; lead time is specified.
14726 (floor (* (string-to-number (match-string 1 ts))
14727 (cdr (assoc (match-string 2 ts)
14728 '(("d" . 1) ("w" . 7)
14729 ("m" . 30.4) ("y" . 365.25)))))))
14730 ;; go for the default.
14731 (t org-deadline-warning-days)))
14733 (defun org-calendar-select-mouse (ev)
14734 "Return to `org-read-date' with the date currently selected.
14735 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14736 (interactive "e")
14737 (mouse-set-point ev)
14738 (when (calendar-cursor-to-date)
14739 (let* ((date (calendar-cursor-to-date))
14740 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14741 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14742 (if (active-minibuffer-window) (exit-minibuffer))))
14744 (defun org-check-deadlines (ndays)
14745 "Check if there are any deadlines due or past due.
14746 A deadline is considered due if it happens within `org-deadline-warning-days'
14747 days from today's date. If the deadline appears in an entry marked DONE,
14748 it is not shown. The prefix arg NDAYS can be used to test that many
14750 (interactive "P")
14751 (let* ((org-warn-days
14752 (cond
14753 ((equal ndays '(4)) 100000)
14754 (ndays (prefix-numeric-value ndays))
14755 (t (abs org-deadline-warning-days))))
14756 (case-fold-search nil)
14758 (callback
14759 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
14761 (message "%d deadlines past-due or due within %d days"
14762 (org-occur regexp nil callback)
14763 org-warn-days)))
14765 (defun org-check-before-date (date)
14766 "Check if there are deadlines or scheduled entries before DATE."
14767 (interactive (list (org-read-date)))
14768 (let ((case-fold-search nil)
14772 (callback
14773 (lambda () (time-less-p
14774 (org-time-string-to-time (match-string 2))
14775 (org-time-string-to-time date)))))
14776 (message "%d entries before %s"
14777 (org-occur regexp nil callback) date)))
14779 (defun org-check-after-date (date)
14780 "Check if there are deadlines or scheduled entries after DATE."
14781 (interactive (list (org-read-date)))
14782 (let ((case-fold-search nil)
14786 (callback
14787 (lambda () (not
14788 (time-less-p
14789 (org-time-string-to-time (match-string 2))
14790 (org-time-string-to-time date))))))
14791 (message "%d entries after %s"
14792 (org-occur regexp nil callback) date)))
14794 (defun org-evaluate-time-range (&optional to-buffer)
14795 "Evaluate a time range by computing the difference between start and end.
14796 Normally the result is just printed in the echo area, but with prefix arg
14797 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
14798 If the time range is actually in a table, the result is inserted into the
14799 next column.
14800 For time difference computation, a year is assumed to be exactly 365
14801 days in order to avoid rounding problems."
14802 (interactive "P")
14803 (or
14804 (org-clock-update-time-maybe)
14805 (save-excursion
14806 (unless (org-at-date-range-p t)
14807 (goto-char (point-at-bol))
14808 (re-search-forward org-tr-regexp-both (point-at-eol) t))
14809 (if (not (org-at-date-range-p t))
14810 (error "Not at a time-stamp range, and none found in current line")))
14811 (let* ((ts1 (match-string 1))
14812 (ts2 (match-string 2))
14813 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
14814 (match-end (match-end 0))
14815 (time1 (org-time-string-to-time ts1))
14816 (time2 (org-time-string-to-time ts2))
14817 (t1 (org-float-time time1))
14818 (t2 (org-float-time time2))
14819 (diff (abs (- t2 t1)))
14820 (negative (< (- t2 t1) 0))
14821 ;; (ys (floor (* 365 24 60 60)))
14822 (ds (* 24 60 60))
14823 (hs (* 60 60))
14824 (fy "%dy %dd %02d:%02d")
14825 (fy1 "%dy %dd")
14826 (fd "%dd %02d:%02d")
14827 (fd1 "%dd")
14828 (fh "%02d:%02d")
14829 y d h m align)
14830 (if havetime
14831 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14832 y 0
14833 d (floor (/ diff ds)) diff (mod diff ds)
14834 h (floor (/ diff hs)) diff (mod diff hs)
14835 m (floor (/ diff 60)))
14836 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14837 y 0
14838 d (floor (+ (/ diff ds) 0.5))
14839 h 0 m 0))
14840 (if (not to-buffer)
14841 (message "%s" (org-make-tdiff-string y d h m))
14842 (if (org-at-table-p)
14843 (progn
14844 (goto-char match-end)
14845 (setq align t)
14846 (and (looking-at " *|") (goto-char (match-end 0))))
14847 (goto-char match-end))
14848 (if (looking-at
14850 (replace-match ""))
14851 (if negative (insert " -"))
14852 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
14853 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
14854 (insert " " (format fh h m))))
14855 (if align (org-table-align))
14856 (message "Time difference inserted")))))
14858 (defun org-make-tdiff-string (y d h m)
14859 (let ((fmt "")
14860 (l nil))
14861 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
14862 l (push y l)))
14863 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
14864 l (push d l)))
14865 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
14866 l (push h l)))
14867 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
14868 l (push m l)))
14869 (apply 'format fmt (nreverse l))))
14871 (defun org-time-string-to-time (s)
14872 (apply 'encode-time (org-parse-time-string s)))
14873 (defun org-time-string-to-seconds (s)
14874 (org-float-time (org-time-string-to-time s)))
14876 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
14877 "Convert a time stamp to an absolute day number.
14878 If there is a specifier for a cyclic time stamp, get the closest date to
14879 DAYNR.
14880 PREFER and SHOW-ALL are passed through to `org-closest-date'.
14881 the variable date is bound by the calendar when this is called."
14882 (cond
14884 (if (org-diary-sexp-entry (match-string 1 s) "" date)
14885 daynr
14886 (+ daynr 1000)))
14888 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
14889 (time-to-days (current-time))) (match-string 0 s)
14890 prefer show-all))
14891 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
14893 (defun org-days-to-iso-week (days)
14894 "Return the iso week number."
14895 (require 'cal-iso)
14896 (car (calendar-iso-from-absolute days)))
14898 (defun org-small-year-to-year (year)
14899 "Convert 2-digit years into 4-digit years.
14900 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
14901 The year 2000 cannot be abbreviated. Any year larger than 99
14902 is returned unchanged."
14903 (if (< year 38)
14904 (setq year (+ 2000 year))
14905 (if (< year 100)
14906 (setq year (+ 1900 year))))
14907 year)
14909 (defun org-time-from-absolute (d)
14910 "Return the time corresponding to date D.
14911 D may be an absolute day number, or a calendar-type list (month day year)."
14912 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
14913 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
14915 (defun org-calendar-holiday ()
14916 "List of holidays, for Diary display in Org-mode."
14917 (require 'holidays)
14918 (let ((hl (funcall
14919 (if (fboundp 'calendar-check-holidays)
14920 'calendar-check-holidays 'check-calendar-holidays) date)))
14921 (if hl (mapconcat 'identity hl "; "))))
14923 (defun org-diary-sexp-entry (sexp entry date)
14924 "Process a SEXP diary ENTRY for DATE."
14925 (require 'diary-lib)
14926 (let ((result (if calendar-debug-sexp
14927 (let ((stack-trace-on-error t))
14928 (eval (car (read-from-string sexp))))
14929 (condition-case nil
14930 (eval (car (read-from-string sexp)))
14931 (error
14932 (beep)
14933 (message "Bad sexp at line %d in %s: %s"
14934 (org-current-line)
14935 (buffer-file-name) sexp)
14936 (sleep-for 2))))))
14937 (cond ((stringp result) (split-string result "; "))
14938 ((and (consp result)
14939 (not (consp (cdr result)))
14940 (stringp (cdr result))) (cdr result))
14941 ((and (consp result)
14942 (stringp (car result))) result)
14943 (result entry)
14944 (t nil))))
14946 (defun org-diary-to-ical-string (frombuf)
14947 "Get iCalendar entries from diary entries in buffer FROMBUF.
14948 This uses the icalendar.el library."
14949 (let* ((tmpdir (if (featurep 'xemacs)
14950 (temp-directory)
14951 temporary-file-directory))
14952 (tmpfile (make-temp-name
14953 (expand-file-name "orgics" tmpdir)))
14954 buf rtn b e)
14955 (with-current-buffer frombuf
14956 (icalendar-export-region (point-min) (point-max) tmpfile)
14957 (setq buf (find-buffer-visiting tmpfile))
14958 (set-buffer buf)
14959 (goto-char (point-min))
14960 (if (re-search-forward "^BEGIN:VEVENT" nil t)
14961 (setq b (match-beginning 0)))
14962 (goto-char (point-max))
14963 (if (re-search-backward "^END:VEVENT" nil t)
14964 (setq e (match-end 0)))
14966 (kill-buffer buf)
14967 (delete-file tmpfile)
14968 rtn))
14970 (defun org-closest-date (start current change prefer show-all)
14971 "Find the date closest to CURRENT that is consistent with START and CHANGE.
14972 When PREFER is `past' return a date that is either CURRENT or past.
14973 When PREFER is `future', return a date that is either CURRENT or future.
14974 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
14975 ;; Make the proper lists from the dates
14976 (catch 'exit
14977 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
14978 dn dw sday cday n1 n2 n0
14979 d m y y1 y2 date1 date2 nmonths nm ny m2)
14981 (setq start (org-date-to-gregorian start)
14982 current (org-date-to-gregorian
14983 (if show-all
14984 current
14985 (time-to-days (current-time))))
14986 sday (calendar-absolute-from-gregorian start)
14987 cday (calendar-absolute-from-gregorian current))
14989 (if (<= cday sday) (throw 'exit sday))
14992 (setq dn (string-to-number (match-string 1 change))
14993 dw (cdr (assoc (match-string 2 change) a1)))
14994 (error "Invalid change specifier: %s" change))
14995 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
14996 (cond
14997 ((eq dw 'day)
14998 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
14999 n2 (+ n1 dn)))
15000 ((eq dw 'year)
15001 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15002 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15003 (setq date1 (list m d y1)
15004 n1 (calendar-absolute-from-gregorian date1)
15005 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15006 n2 (calendar-absolute-from-gregorian date2)))
15007 ((eq dw 'month)
15008 ;; approx number of month between the two dates
15009 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15010 ;; How often does dn fit in there?
15011 (setq d (nth 1 start) m (car start) y (nth 2 start)
15012 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15013 m (+ m nm)
15014 ny (floor (/ m 12))
15015 y (+ y ny)
15016 m (- m (* ny 12)))
15017 (while (> m 12) (setq m (- m 12) y (1+ y)))
15018 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15019 (setq m2 (+ m dn) y2 y)
15020 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15021 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15022 (while (<= n2 cday)
15023 (setq n1 n2 m m2 y y2)
15024 (setq m2 (+ m dn) y2 y)
15025 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15026 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15027 ;; Make sure n1 is the earlier date
15028 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15029 (if show-all
15030 (cond
15031 ((eq prefer 'past) (if (= cday n2) n2 n1))
15032 ((eq prefer 'future) (if (= cday n1) n1 n2))
15033 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15034 (cond
15035 ((eq prefer 'past) (if (= cday n2) n2 n1))
15036 ((eq prefer 'future) (if (= cday n1) n1 n2))
15037 (t (if (= cday n1) n1 n2)))))))
15039 (defun org-date-to-gregorian (date)
15040 "Turn any specification of DATE into a Gregorian date for the calendar."
15041 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15042 ((and (listp date) (= (length date) 3)) date)
15043 ((stringp date)
15044 (setq date (org-parse-time-string date))
15045 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15046 ((listp date)
15047 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15049 (defun org-parse-time-string (s &optional nodefault)
15050 "Parse the standard Org-mode time string.
15051 This should be a lot faster than the normal `parse-time-string'.
15052 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15053 hour and minute fields will be nil if not given."
15054 (if (string-match org-ts-regexp0 s)
15055 (list 0
15056 (if (or (match-beginning 8) (not nodefault))
15057 (string-to-number (or (match-string 8 s) "0")))
15058 (if (or (match-beginning 7) (not nodefault))
15059 (string-to-number (or (match-string 7 s) "0")))
15060 (string-to-number (match-string 4 s))
15061 (string-to-number (match-string 3 s))
15062 (string-to-number (match-string 2 s))
15063 nil nil nil)
15064 (error "Not a standard Org-mode time string: %s" s)))
15066 (defun org-timestamp-up (&optional arg)
15067 "Increase the date item at the cursor by one.
15068 If the cursor is on the year, change the year. If it is on the month or
15069 the day, change that.
15070 With prefix ARG, change by that many units."
15071 (interactive "p")
15072 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15074 (defun org-timestamp-down (&optional arg)
15075 "Decrease the date item at the cursor by one.
15076 If the cursor is on the year, change the year. If it is on the month or
15077 the day, change that.
15078 With prefix ARG, change by that many units."
15079 (interactive "p")
15080 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15082 (defun org-timestamp-up-day (&optional arg)
15083 "Increase the date in the time stamp by one day.
15084 With prefix ARG, change that many days."
15085 (interactive "p")
15086 (if (and (not (org-at-timestamp-p t))
15087 (org-on-heading-p))
15088 (org-todo 'up)
15089 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15091 (defun org-timestamp-down-day (&optional arg)
15092 "Decrease the date in the time stamp by one day.
15093 With prefix ARG, change that many days."
15094 (interactive "p")
15095 (if (and (not (org-at-timestamp-p t))
15096 (org-on-heading-p))
15097 (org-todo 'down)
15098 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15100 (defun org-at-timestamp-p (&optional inactive-ok)
15101 "Determine if the cursor is in or at a timestamp."
15102 (interactive)
15103 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15104 (pos (point))
15105 (ans (or (looking-at tsr)
15106 (save-excursion
15108 (if (> (point) (point-min)) (backward-char 1))
15109 (and (looking-at tsr)
15110 (> (- (match-end 0) pos) -1))))))
15111 (and ans
15112 (boundp 'org-ts-what)
15113 (setq org-ts-what
15114 (cond
15115 ((= pos (match-beginning 0)) 'bracket)
15116 ((= pos (1- (match-end 0))) 'bracket)
15117 ((org-pos-in-match-range pos 2) 'year)
15118 ((org-pos-in-match-range pos 3) 'month)
15119 ((org-pos-in-match-range pos 7) 'hour)
15120 ((org-pos-in-match-range pos 8) 'minute)
15121 ((or (org-pos-in-match-range pos 4)
15122 (org-pos-in-match-range pos 5)) 'day)
15123 ((and (> pos (or (match-end 8) (match-end 5)))
15124 (< pos (match-end 0)))
15125 (- pos (or (match-end 8) (match-end 5))))
15126 (t 'day))))
15127 ans))
15129 (defun org-toggle-timestamp-type ()
15130 "Toggle the type (<active> or [inactive]) of a time stamp."
15131 (interactive)
15132 (when (org-at-timestamp-p t)
15133 (let ((beg (match-beginning 0)) (end (match-end 0))
15134 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15135 (save-excursion
15136 (goto-char beg)
15137 (while (re-search-forward "[][<>]" end t)
15138 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15139 t t)))
15140 (message "Timestamp is now %sactive"
15141 (if (equal (char-after beg) ?<) "" "in")))))
15143 (defun org-timestamp-change (n &optional what updown)
15144 "Change the date in the time stamp at point.
15145 The date will be changed by N times WHAT. WHAT can be `day', `month',
15146 `year', `minute', `second'. If WHAT is not given, the cursor position
15147 in the timestamp determines what will be changed."
15148 (let ((pos (point))
15149 with-hm inactive
15150 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15151 org-ts-what
15152 extra rem
15153 ts time time0)
15154 (if (not (org-at-timestamp-p t))
15155 (error "Not at a timestamp"))
15156 (if (and (not what) (eq org-ts-what 'bracket))
15157 (org-toggle-timestamp-type)
15158 (if (and (not what) (not (eq org-ts-what 'day))
15159 org-display-custom-times
15160 (get-text-property (point) 'display)
15161 (not (get-text-property (1- (point)) 'display)))
15162 (setq org-ts-what 'day))
15163 (setq org-ts-what (or what org-ts-what)
15164 inactive (= (char-after (match-beginning 0)) ?\[)
15165 ts (match-string 0))
15166 (replace-match "")
15167 (if (string-match
15169 ts)
15170 (setq extra (match-string 1 ts)))
15172 (setq with-hm t))
15173 (setq time0 (org-parse-time-string ts))
15174 (when (and updown
15175 (eq org-ts-what 'minute)
15176 (not current-prefix-arg))
15177 ;; This looks like s-up and s-down. Change by one rounding step.
15178 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15179 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15180 (setcar (cdr time0) (+ (nth 1 time0)
15181 (if (> n 0) (- rem) (- dm rem))))))
15182 (setq time
15183 (encode-time (or (car time0) 0)
15184 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15185 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15186 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15187 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15188 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15189 (nthcdr 6 time0)))
15190 (when (and (member org-ts-what '(hour minute))
15191 extra
15193 (setq extra (org-modify-ts-extra
15194 extra
15195 (if (eq org-ts-what 'hour) 2 5)
15196 n dm)))
15197 (when (integerp org-ts-what)
15198 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15199 (if (eq what 'calendar)
15200 (let ((cal-date (org-get-date-from-calendar)))
15201 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15202 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15203 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15204 (setcar time0 (or (car time0) 0))
15205 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15206 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15207 (setq time (apply 'encode-time time0))))
15208 (setq org-last-changed-timestamp
15209 (org-insert-time-stamp time with-hm inactive nil nil extra))
15210 (org-clock-update-time-maybe)
15211 (goto-char pos)
15212 ;; Try to recenter the calendar window, if any
15213 (if (and org-calendar-follow-timestamp-change
15214 (get-buffer-window "*Calendar*" t)
15215 (memq org-ts-what '(day month year)))
15216 (org-recenter-calendar (time-to-days time))))))
15218 (defun org-modify-ts-extra (s pos n dm)
15219 "Change the different parts of the lead-time and repeat fields in timestamp."
15220 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15221 ng h m new rem)
15222 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15223 (cond
15224 ((or (org-pos-in-match-range pos 2)
15225 (org-pos-in-match-range pos 3))
15226 (setq m (string-to-number (match-string 3 s))
15227 h (string-to-number (match-string 2 s)))
15228 (if (org-pos-in-match-range pos 2)
15229 (setq h (+ h n))
15230 (setq n (* dm (org-no-warnings (signum n))))
15231 (when (not (= 0 (setq rem (% m dm))))
15232 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15233 (setq m (+ m n)))
15234 (if (< m 0) (setq m (+ m 60) h (1- h)))
15235 (if (> m 59) (setq m (- m 60) h (1+ h)))
15236 (setq h (min 24 (max 0 h)))
15237 (setq ng 1 new (format "-%02d:%02d" h m)))
15238 ((org-pos-in-match-range pos 6)
15239 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15240 ((org-pos-in-match-range pos 5)
15241 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15243 ((org-pos-in-match-range pos 9)
15244 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15245 ((org-pos-in-match-range pos 8)
15246 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15248 (when ng
15249 (setq s (concat
15250 (substring s 0 (match-beginning ng))
15251 new
15252 (substring s (match-end ng))))))
15253 s))
15255 (defun org-recenter-calendar (date)
15256 "If the calendar is visible, recenter it to DATE."
15257 (let* ((win (selected-window))
15258 (cwin (get-buffer-window "*Calendar*" t))
15259 (calendar-move-hook nil))
15260 (when cwin
15261 (select-window cwin)
15262 (calendar-goto-date (if (listp date) date
15263 (calendar-gregorian-from-absolute date)))
15264 (select-window win))))
15266 (defun org-goto-calendar (&optional arg)
15267 "Go to the Emacs calendar at the current date.
15268 If there is a time stamp in the current line, go to that date.
15269 A prefix ARG can be used to force the current date."
15270 (interactive "P")
15271 (let ((tsr org-ts-regexp) diff
15272 (calendar-move-hook nil)
15273 (calendar-view-holidays-initially-flag nil)
15274 (calendar-view-diary-initially-flag nil))
15275 (if (or (org-at-timestamp-p)
15276 (save-excursion
15277 (beginning-of-line 1)
15278 (looking-at (concat ".*" tsr))))
15279 (let ((d1 (time-to-days (current-time)))
15280 (d2 (time-to-days
15281 (org-time-string-to-time (match-string 1)))))
15282 (setq diff (- d2 d1))))
15283 (calendar)
15284 (calendar-goto-today)
15285 (if (and diff (not arg)) (calendar-forward-day diff))))
15287 (defun org-get-date-from-calendar ()
15288 "Return a list (month day year) of date at point in calendar."
15289 (with-current-buffer "*Calendar*"
15290 (save-match-data
15291 (calendar-cursor-to-date))))
15293 (defun org-date-from-calendar ()
15294 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15295 If there is already a time stamp at the cursor position, update it."
15296 (interactive)
15297 (if (org-at-timestamp-p t)
15298 (org-timestamp-change 0 'calendar)
15299 (let ((cal-date (org-get-date-from-calendar)))
15300 (org-insert-time-stamp
15301 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15303 (defun org-minutes-to-hh:mm-string (m)
15304 "Compute H:MM from a number of minutes."
15305 (let ((h (/ m 60)))
15306 (setq m (- m (* 60 h)))
15307 (format org-time-clocksum-format h m)))
15309 (defun org-hh:mm-string-to-minutes (s)
15310 "Convert a string H:MM to a number of minutes.
15311 If the string is just a number, interpret it as minutes.
15312 In fact, the first hh:mm or number in the string will be taken,
15313 there can be extra stuff in the string.
15314 If no number is found, the return value is 0."
15315 (cond
15317 (+ (* (string-to-number (match-string 1 s)) 60)
15318 (string-to-number (match-string 2 s))))
15320 (string-to-number (match-string 1 s)))
15321 (t 0)))
15323 ;;;; Files
15325 (defun org-save-all-org-buffers ()
15326 "Save all Org-mode buffers without user confirmation."
15327 (interactive)
15328 (message "Saving all Org-mode buffers...")
15329 (save-some-buffers t 'org-mode-p)
15330 (when (featurep 'org-id) (org-id-locations-save))
15331 (message "Saving all Org-mode buffers... done"))
15333 (defun org-revert-all-org-buffers ()
15334 "Revert all Org-mode buffers.
15335 Prompt for confirmation when there are unsaved changes.
15336 Be sure you know what you are doing before letting this function
15337 overwrite your changes.
15339 This function is useful in a setup where one tracks org files
15340 with a version control system, to revert on one machine after pulling
15341 changes from another. I believe the procedure must be like this:
15343 1. M-x org-save-all-org-buffers
15344 2. Pull changes from the other machine, resolve conflicts
15345 3. M-x org-revert-all-org-buffers"
15346 (interactive)
15347 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15348 (error "Abort"))
15349 (save-excursion
15350 (save-window-excursion
15351 (mapc
15352 (lambda (b)
15353 (when (and (with-current-buffer b (org-mode-p))
15354 (with-current-buffer b buffer-file-name))
15355 (switch-to-buffer b)
15356 (revert-buffer t 'no-confirm)))
15357 (buffer-list))
15358 (when (and (featurep 'org-id) org-id-track-globally)
15359 (org-id-locations-load)))))
15361 ;;;; Agenda files
15363 ;;;###autoload
15364 (defun org-switchb (&optional arg)
15365 "Switch between Org buffers.
15366 With a prefix argument, restrict available to files.
15367 With two prefix arguments, restrict available buffers to agenda files.
15369 Defaults to `iswitchb' for buffer name completion.
15370 Set `org-completion-use-ido' to make it use ido instead."
15371 (interactive "P")
15372 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15373 ((equal arg '(16)) (org-buffer-list 'agenda))
15374 (t (org-buffer-list))))
15375 (org-completion-use-iswitchb org-completion-use-iswitchb)
15376 (org-completion-use-ido org-completion-use-ido))
15377 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15378 (setq org-completion-use-iswitchb t))
15379 (switch-to-buffer
15380 (org-icompleting-read "Org buffer: "
15381 (mapcar 'list (mapcar 'buffer-name blist))
15382 nil t))))
15384 ;;; Define some older names previously used for this functionality
15385 ;;;###autoload
15386 (defalias 'org-ido-switchb 'org-switchb)
15387 ;;;###autoload
15388 (defalias 'org-iswitchb 'org-switchb)
15390 (defun org-buffer-list (&optional predicate exclude-tmp)
15391 "Return a list of Org buffers.
15392 PREDICATE can be `export', `files' or `agenda'.
15394 export restrict the list to Export buffers.
15395 files restrict the list to buffers visiting Org files.
15396 agenda restrict the list to buffers visiting agenda files.
15398 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15399 (let* ((bfn nil)
15400 (agenda-files (and (eq predicate 'agenda)
15401 (mapcar 'file-truename (org-agenda-files t))))
15402 (filter
15403 (cond
15404 ((eq predicate 'files)
15405 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
15406 ((eq predicate 'export)
15407 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15408 ((eq predicate 'agenda)
15409 (lambda (b)
15410 (with-current-buffer b
15411 (and (eq major-mode 'org-mode)
15412 (setq bfn (buffer-file-name b))
15413 (member (file-truename bfn) agenda-files)))))
15414 (t (lambda (b) (with-current-buffer b
15415 (or (eq major-mode 'org-mode)
15416 (string-match "\*Org .*Export"
15417 (buffer-name b)))))))))
15418 (delq nil
15419 (mapcar
15420 (lambda(b)
15421 (if (and (funcall filter b)
15422 (or (not exclude-tmp)
15423 (not (string-match "tmp" (buffer-name b)))))
15424 b
15425 nil))
15426 (buffer-list)))))
15428 (defun org-agenda-files (&optional unrestricted archives)
15429 "Get the list of agenda files.
15430 Optional UNRESTRICTED means return the full list even if a restriction
15431 is currently in place.
15432 When ARCHIVES is t, include all archive files that are really being
15433 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15434 `org-agenda-archives-mode' is t."
15435 (let ((files
15436 (cond
15437 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15438 ((stringp org-agenda-files) (org-read-agenda-file-list))
15439 ((listp org-agenda-files) org-agenda-files)
15440 (t (error "Invalid value of `org-agenda-files'")))))
15441 (setq files (apply 'append
15442 (mapcar (lambda (f)
15443 (if (file-directory-p f)
15444 (directory-files
15445 f t org-agenda-file-regexp)
15446 (list f)))
15447 files)))
15448 (when org-agenda-skip-unavailable-files
15449 (setq files (delq nil
15450 (mapcar (function
15451 (lambda (file)
15452 (and (file-readable-p file) file)))
15453 files))))
15454 (when (or (eq archives t)
15455 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15456 (setq files (org-add-archive-files files)))
15457 files))
15459 (defun org-agenda-file-p (&optional file)
15460 "Return non-nil, if FILE is an agenda file.
15461 If FILE is omitted, use the file associated with the current
15462 buffer."
15463 (member (or file (buffer-file-name))
15464 (org-agenda-files t)))
15466 (defun org-edit-agenda-file-list ()
15467 "Edit the list of agenda files.
15468 Depending on setup, this either uses customize to edit the variable
15469 `org-agenda-files', or it visits the file that is holding the list. In the
15470 latter case, the buffer is set up in a way that saving it automatically kills
15471 the buffer and restores the previous window configuration."
15472 (interactive)
15473 (if (stringp org-agenda-files)
15474 (let ((cw (current-window-configuration)))
15475 (find-file org-agenda-files)
15476 (org-set-local 'org-window-configuration cw)
15477 (org-add-hook 'after-save-hook
15478 (lambda ()
15479 (set-window-configuration
15480 (prog1 org-window-configuration
15481 (kill-buffer (current-buffer))))
15482 (org-install-agenda-files-menu)
15483 (message "New agenda file list installed"))
15484 nil 'local)
15485 (message "%s" (substitute-command-keys
15487 (customize-variable 'org-agenda-files)))
15489 (defun org-store-new-agenda-file-list (list)
15490 "Set new value for the agenda file list and save it correctly."
15491 (if (stringp org-agenda-files)
15492 (let ((fe (org-read-agenda-file-list t)) b u)
15493 (while (setq b (find-buffer-visiting org-agenda-files))
15494 (kill-buffer b))
15495 (with-temp-file org-agenda-files
15496 (insert
15497 (mapconcat
15498 (lambda (f) ;; Keep un-expanded entries.
15499 (if (setq u (assoc f fe))
15500 (cdr u)
15501 f))
15504 (let ((org-mode-hook nil) (org-inhibit-startup t)
15505 (org-insert-mode-line-in-empty-file nil))
15506 (setq org-agenda-files list)
15507 (customize-save-variable 'org-agenda-files org-agenda-files))))
15509 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15510 "Read the list of agenda files from a file.
15511 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15512 filenames, used by `org-store-new-agenda-file-list' to write back
15513 un-expanded file names."
15514 (when (file-directory-p org-agenda-files)
15515 (error "`org-agenda-files' cannot be a single directory"))
15516 (when (stringp org-agenda-files)
15517 (with-temp-buffer
15518 (insert-file-contents org-agenda-files)
15519 (mapcar
15520 (lambda (f)
15521 (let ((e (expand-file-name (substitute-in-file-name f)
15522 org-directory)))
15523 (if pair-with-expansion
15524 (cons e f)
15525 e)))
15528 ;;;###autoload
15529 (defun org-cycle-agenda-files ()
15530 "Cycle through the files in `org-agenda-files'.
15531 If the current buffer visits an agenda file, find the next one in the list.
15532 If the current buffer does not, find the first agenda file."
15533 (interactive)
15534 (let* ((fs (org-agenda-files t))
15535 (files (append fs (list (car fs))))
15536 (tcf (if buffer-file-name (file-truename buffer-file-name)))
15537 file)
15538 (unless files (error "No agenda files"))
15539 (catch 'exit
15540 (while (setq file (pop files))
15541 (if (equal (file-truename file) tcf)
15542 (when (car files)
15543 (find-file (car files))
15544 (throw 'exit t))))
15545 (find-file (car fs)))
15546 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
15548 (defun org-agenda-file-to-front (&optional to-end)
15549 "Move/add the current file to the top of the agenda file list.
15550 If the file is not present in the list, it is added to the front. If it is
15551 present, it is moved there. With optional argument TO-END, add/move to the
15552 end of the list."
15553 (interactive "P")
15554 (let ((org-agenda-skip-unavailable-files nil)
15555 (file-alist (mapcar (lambda (x)
15556 (cons (file-truename x) x))
15557 (org-agenda-files t)))
15558 (ctf (file-truename buffer-file-name))
15559 x had)
15560 (setq x (assoc ctf file-alist) had x)
15562 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
15563 (if to-end
15564 (setq file-alist (append (delq x file-alist) (list x)))
15565 (setq file-alist (cons x (delq x file-alist))))
15566 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
15567 (org-install-agenda-files-menu)
15568 (message "File %s to %s of agenda file list"
15569 (if had "moved" "added") (if to-end "end" "front"))))
15571 (defun org-remove-file (&optional file)
15572 "Remove current file from the list of files in variable `org-agenda-files'.
15573 These are the files which are being checked for agenda entries.
15574 Optional argument FILE means use this file instead of the current."
15575 (interactive)
15576 (let* ((org-agenda-skip-unavailable-files nil)
15577 (file (or file buffer-file-name))
15578 (true-file (file-truename file))
15579 (afile (abbreviate-file-name file))
15580 (files (delq nil (mapcar
15581 (lambda (x)
15582 (if (equal true-file
15583 (file-truename x))
15584 nil x))
15585 (org-agenda-files t)))))
15586 (if (not (= (length files) (length (org-agenda-files t))))
15587 (progn
15588 (org-store-new-agenda-file-list files)
15589 (org-install-agenda-files-menu)
15590 (message "Removed file: %s" afile))
15591 (message "File was not in list: %s (not removed)" afile))))
15593 (defun org-file-menu-entry (file)
15594 (vector file (list 'find-file file) t))
15596 (defun org-check-agenda-file (file)
15597 "Make sure FILE exists. If not, ask user what to do."
15598 (when (not (file-exists-p file))
15599 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
15600 (abbreviate-file-name file))
15601 (let ((r (downcase (read-char-exclusive))))
15602 (cond
15603 ((equal r ?r)
15604 (org-remove-file file)
15605 (throw 'nextfile t))
15606 (t (error "Abort"))))))
15608 (defun org-get-agenda-file-buffer (file)
15609 "Get a buffer visiting FILE. If the buffer needs to be created, add
15610 it to the list of buffers which might be released later."
15611 (let ((buf (org-find-base-buffer-visiting file)))
15612 (if buf
15613 buf ; just return it
15614 ;; Make a new buffer and remember it
15615 (setq buf (find-file-noselect file))
15616 (if buf (push buf org-agenda-new-buffers))
15617 buf)))
15619 (defun org-release-buffers (blist)
15620 "Release all buffers in list, asking the user for confirmation when needed.
15621 When a buffer is unmodified, it is just killed. When modified, it is saved
15622 \(if the user agrees) and then killed."
15623 (let (buf file)
15624 (while (setq buf (pop blist))
15625 (setq file (buffer-file-name buf))
15626 (when (and (buffer-modified-p buf)
15627 file
15628 (y-or-n-p (format "Save file %s? " file)))
15629 (with-current-buffer buf (save-buffer)))
15630 (kill-buffer buf))))
15632 (defun org-prepare-agenda-buffers (files)
15633 "Create buffers for all agenda files, protect archived trees and comments."
15634 (interactive)
15635 (let ((pa '(:org-archived t))
15636 (pc '(:org-comment t))
15637 (pall '(:org-archived t :org-comment t))
15638 (inhibit-read-only t)
15639 (rea (concat ":" org-archive-tag ":"))
15640 bmp file re)
15641 (save-excursion
15642 (save-restriction
15643 (while (setq file (pop files))
15644 (catch 'nextfile
15645 (if (bufferp file)
15646 (set-buffer file)
15647 (org-check-agenda-file file)
15648 (set-buffer (org-get-agenda-file-buffer file)))
15649 (widen)
15650 (setq bmp (buffer-modified-p))
15651 (org-refresh-category-properties)
15652 (setq org-todo-keywords-for-agenda
15653 (append org-todo-keywords-for-agenda org-todo-keywords-1))
15654 (setq org-done-keywords-for-agenda
15655 (append org-done-keywords-for-agenda org-done-keywords))
15656 (setq org-todo-keyword-alist-for-agenda
15657 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
15658 (setq org-drawers-for-agenda
15659 (append org-drawers-for-agenda org-drawers))
15660 (setq org-tag-alist-for-agenda
15661 (append org-tag-alist-for-agenda org-tag-alist))
15663 (save-excursion
15664 (remove-text-properties (point-min) (point-max) pall)
15665 (when org-agenda-skip-archived-trees
15666 (goto-char (point-min))
15667 (while (re-search-forward rea nil t)
15668 (if (org-on-heading-p t)
15669 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
15670 (goto-char (point-min))
15672 (while (re-search-forward re nil t)
15673 (add-text-properties
15674 (match-beginning 0) (org-end-of-subtree t) pc)))
15675 (set-buffer-modified-p bmp)))))
15676 (setq org-todo-keywords-for-agenda
15677 (org-uniquify org-todo-keywords-for-agenda))
15678 (setq org-todo-keyword-alist-for-agenda
15679 (org-uniquify org-todo-keyword-alist-for-agenda)
15680 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
15682 ;;;; Embedded LaTeX
15684 (defvar org-cdlatex-mode-map (make-sparse-keymap)
15685 "Keymap for the minor `org-cdlatex-mode'.")
15687 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
15688 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
15689 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
15690 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
15691 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
15693 (defvar org-cdlatex-texmathp-advice-is-done nil
15694 "Flag remembering if we have applied the advice to texmathp already.")
15696 (define-minor-mode org-cdlatex-mode
15697 "Toggle the minor `org-cdlatex-mode'.
15698 This mode supports entering LaTeX environment and math in LaTeX fragments
15699 in Org-mode.
15701 nil " OCDL" nil
15702 (when org-cdlatex-mode (require 'cdlatex))
15703 (unless org-cdlatex-texmathp-advice-is-done
15704 (setq org-cdlatex-texmathp-advice-is-done t)
15705 (defadvice texmathp (around org-math-always-on activate)
15706 "Always return t in org-mode buffers.
15707 This is because we want to insert math symbols without dollars even outside
15708 the LaTeX math segments. If Orgmode thinks that point is actually inside
15709 an embedded LaTeX fragment, let texmathp do its job.
15711 (interactive)
15712 (let (p)
15713 (cond
15714 ((not (org-mode-p)) ad-do-it)
15715 ((eq this-command 'cdlatex-math-symbol)
15716 (setq ad-return-value t
15717 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
15718 (t
15719 (let ((p (org-inside-LaTeX-fragment-p)))
15720 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
15721 (setq ad-return-value t
15722 texmathp-why '("Org-mode embedded math" . 0))
15723 (if p ad-do-it)))))))))
15725 (defun turn-on-org-cdlatex ()
15726 "Unconditionally turn on `org-cdlatex-mode'."
15727 (org-cdlatex-mode 1))
15729 (defun org-inside-LaTeX-fragment-p ()
15730 "Test if point is inside a LaTeX fragment.
15732 sequence appearing also before point.
15733 Even though the matchers for math are configurable, this function assumes
15735 delimiters are skipped when they have been removed by customization.
15736 The return value is nil, or a cons cell with the delimiter and
15737 and the position of this delimiter.
15739 This function does a reasonably good job, but can locally be fooled by
15740 for example currency specifications. For example it will assume being in
15742 fragments that are properly closed, but during editing, we have to live
15743 with the uncertainty caused by missing closing delimiters. This function
15744 looks only before point, not after."
15745 (catch 'exit
15746 (let ((pos (point))
15747 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
15748 (lim (progn
15750 (point)))
15751 dd-on str (start 0) m re)
15752 (goto-char pos)
15753 (when dodollar
15755 re (nth 1 (assoc "$" org-latex-regexps)))
15756 (while (string-match re str start)
15757 (cond
15758 ((= (match-end 0) (length str))
15759 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
15760 ((= (match-end 0) (- (length str) 5))
15761 (throw 'exit nil))
15762 (t (setq start (match-end 0))))))
15763 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
15764 (goto-char pos)
15765 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
15766 (and (match-beginning 2) (throw 'exit nil))
15767 ;; count $$
15769 (setq dd-on (not dd-on)))
15770 (goto-char pos)
15771 (if dd-on (cons "$$" m))))))
15773 (defun org-inside-latex-macro-p ()
15774 "Is point inside a LaTeX macro or its arguments?"
15775 (save-match-data
15776 (org-in-regexp
15779 (defun org-try-cdlatex-tab ()
15780 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15781 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15782 - inside a LaTeX fragment, or
15783 - after the first word in a line, where an abbreviation expansion could
15784 insert a LaTeX environment."
15785 (when org-cdlatex-mode
15786 (cond
15787 ((save-excursion
15788 (skip-chars-backward "a-zA-Z0-9*")
15790 (bolp))
15791 (cdlatex-tab) t)
15792 ((org-inside-LaTeX-fragment-p)
15793 (cdlatex-tab) t)
15794 (t nil))))
15796 (defun org-cdlatex-underscore-caret (&optional arg)
15797 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15798 Revert to the normal definition outside of these fragments."
15799 (interactive "P")
15800 (if (org-inside-LaTeX-fragment-p)
15801 (call-interactively 'cdlatex-sub-superscript)
15802 (let (org-cdlatex-mode)
15803 (call-interactively (key-binding (vector last-input-event))))))
15805 (defun org-cdlatex-math-modify (&optional arg)
15806 "Execute `cdlatex-math-modify' in LaTeX fragments.
15807 Revert to the normal definition outside of these fragments."
15808 (interactive "P")
15809 (if (org-inside-LaTeX-fragment-p)
15810 (call-interactively 'cdlatex-math-modify)
15811 (let (org-cdlatex-mode)
15812 (call-interactively (key-binding (vector last-input-event))))))
15814 (defvar org-latex-fragment-image-overlays nil
15815 "List of overlays carrying the images of latex fragments.")
15816 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
15818 (defun org-remove-latex-fragment-image-overlays ()
15819 "Remove all overlays with LaTeX fragment images in current buffer."
15820 (mapc 'delete-overlay org-latex-fragment-image-overlays)
15821 (setq org-latex-fragment-image-overlays nil))
15823 (defun org-preview-latex-fragment (&optional subtree)
15824 "Preview the LaTeX fragment at point, or all locally or globally.
15825 If the cursor is in a LaTeX fragment, create the image and overlay
15826 it over the source code. If there is no fragment at point, display
15827 all fragments in the current text, from one headline to the next. With
15828 prefix SUBTREE, display all fragments in the current subtree. With a
15830 the cursor is before the first headline,
15831 display all fragments in the buffer.
15833 (interactive "P")
15834 (org-remove-latex-fragment-image-overlays)
15835 (save-excursion
15836 (save-restriction
15837 (let (beg end at msg)
15838 (cond
15839 ((or (equal subtree '(16))
15840 (not (save-excursion
15841 (re-search-backward (concat "^" outline-regexp) nil t))))
15842 (setq beg (point-min) end (point-max)
15843 msg "Creating images for buffer...%s"))
15844 ((equal subtree '(4))
15845 (org-back-to-heading)
15846 (setq beg (point) end (org-end-of-subtree t)
15847 msg "Creating images for subtree...%s"))
15848 (t
15849 (if (setq at (org-inside-LaTeX-fragment-p))
15850 (goto-char (max (point-min) (- (cdr at) 2)))
15851 (org-back-to-heading))
15852 (setq beg (point) end (progn (outline-next-heading) (point))
15853 msg (if at "Creating image...%s"
15854 "Creating images for entry...%s"))))
15855 (message msg "")
15856 (narrow-to-region beg end)
15857 (goto-char beg)
15858 (org-format-latex
15859 (concat "ltxpng/" (file-name-sans-extension
15860 (file-name-nondirectory
15861 buffer-file-name)))
15862 default-directory 'overlays msg at 'forbuffer 'dvipng)
15863 (message msg "done. Use `C-c C-c' to remove images.")))))
15865 (defvar org-latex-regexps
15867 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
15870 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
15874 "Regular expressions for matching embedded LaTeX.")
15876 (defvar org-export-have-math nil) ;; dynamic scoping
15877 (defun org-format-latex (prefix &optional dir overlays msg at
15878 forbuffer processing-type)
15879 "Replace LaTeX fragments with links to an image, and produce images.
15880 Some of the options can be changed using the variable
15881 `org-format-latex-options'."
15882 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
15883 (let* ((prefixnodir (file-name-nondirectory prefix))
15884 (absprefix (expand-file-name prefix dir))
15885 (todir (file-name-directory absprefix))
15886 (opt org-format-latex-options)
15887 (matchers (plist-get opt :matchers))
15888 (re-list org-latex-regexps)
15889 (org-format-latex-header-extra
15890 (plist-get (org-infile-export-plist) :latex-header-extra))
15891 (cnt 0) txt hash link beg end re e checkdir
15892 executables-checked string
15893 m n block linkfile movefile ov)
15894 ;; Check the different regular expressions
15895 (while (setq e (pop re-list))
15896 (setq m (car e) re (nth 1 e) n (nth 2 e)
15898 (when (member m matchers)
15899 (goto-char (point-min))
15900 (while (re-search-forward re nil t)
15901 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
15902 (not (get-text-property (match-beginning n)
15903 'org-protected))
15904 (or (not overlays)
15905 (not (eq (get-char-property (match-beginning n)
15906 'org-overlay-type)
15907 'org-latex-overlay))))
15908 (setq org-export-have-math t)
15909 (cond
15910 ((eq processing-type 'verbatim)
15911 ;; Leave the text verbatim, just protect it
15912 (add-text-properties (match-beginning n) (match-end n)
15913 '(org-protected t)))
15914 ((eq processing-type 'mathjax)
15915 ;; Prepare for MathJax processing
15916 (setq string (match-string n))
15917 (if (member m '("$" "$1"))
15918 (save-excursion
15919 (delete-region (match-beginning n) (match-end n))
15920 (goto-char (match-beginning n))
15923 '(org-protected t))))
15924 (add-text-properties (match-beginning n) (match-end n)
15925 '(org-protected t))))
15926 ((or (eq processing-type 'dvipng) t)
15927 ;; Process to an image
15928 (setq txt (match-string n)
15929 beg (match-beginning n) end (match-end n)
15930 cnt (1+ cnt))
15931 (let (print-length print-level) ; make sure full list is printed
15932 (setq hash (sha1 (prin1-to-string
15933 (list org-format-latex-header
15934 org-format-latex-header-extra
15935 org-export-latex-default-packages-alist
15936 org-export-latex-packages-alist
15937 org-format-latex-options
15938 forbuffer txt)))
15939 linkfile (format "%s_%s.png" prefix hash)
15940 movefile (format "%s_%s.png" absprefix hash)))
15941 (setq link (concat block "[[file:" linkfile "]]" block))
15942 (if msg (message msg cnt))
15943 (goto-char beg)
15944 (unless checkdir ; make sure the directory exists
15945 (setq checkdir t)
15946 (or (file-directory-p todir) (make-directory todir t)))
15948 (unless executables-checked
15949 (org-check-external-command
15950 "latex" "needed to convert LaTeX fragments to images")
15951 (org-check-external-command
15952 "dvipng" "needed to convert LaTeX fragments to images")
15953 (setq executables-checked t))
15955 (unless (file-exists-p movefile)
15956 (org-create-formula-image
15957 txt movefile opt forbuffer))
15958 (if overlays
15959 (progn
15960 (mapc (lambda (o)
15961 (if (eq (overlay-get o 'org-overlay-type)
15962 'org-latex-overlay)
15963 (delete-overlay o)))
15964 (overlays-in beg end))
15965 (setq ov (make-overlay beg end))
15966 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
15967 (if (featurep 'xemacs)
15968 (progn
15969 (overlay-put ov 'invisible t)
15970 (overlay-put
15971 ov 'end-glyph
15972 (make-glyph (vector 'png :file movefile))))
15973 (overlay-put
15974 ov 'display
15975 (list 'image :type 'png :file movefile :ascent 'center)))
15976 (push ov org-latex-fragment-image-overlays)
15977 (goto-char end))
15978 (delete-region beg end)
15979 (insert (org-add-props link
15980 (list 'org-latex-src
15981 (replace-regexp-in-string
15984 ;; This function borrows from Ganesh Swami's latex2png.el
15985 (defun org-create-formula-image (string tofile options buffer)
15986 "This calls dvipng."
15987 (require 'org-latex)
15988 (let* ((tmpdir (if (featurep 'xemacs)
15989 (temp-directory)
15990 temporary-file-directory))
15991 (texfilebase (make-temp-name
15992 (expand-file-name "orgtex" tmpdir)))
15993 (texfile (concat texfilebase ".tex"))
15994 (dvifile (concat texfilebase ".dvi"))
15995 (pngfile (concat texfilebase ".png"))
15996 (fnh (if (featurep 'xemacs)
15997 (font-height (get-face-font 'default))
15998 (face-attribute 'default :height nil)))
15999 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16000 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16001 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16002 "Black"))
16003 (bg (or (plist-get options (if buffer :background :html-background))
16004 "Transparent")))
16005 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16006 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16007 (with-temp-file texfile
16008 (insert (org-splice-latex-header
16009 org-format-latex-header
16010 org-export-latex-default-packages-alist
16011 org-export-latex-packages-alist t
16012 org-format-latex-header-extra))
16014 (require 'org-latex)
16015 (org-export-latex-fix-inputenc))
16016 (let ((dir default-directory))
16017 (condition-case nil
16018 (progn
16019 (cd tmpdir)
16020 (call-process "latex" nil nil nil texfile))
16021 (error nil))
16022 (cd dir))
16023 (if (not (file-exists-p dvifile))
16024 (progn (message "Failed to create dvi file from %s" texfile) nil)
16025 (condition-case nil
16026 (call-process "dvipng" nil nil nil
16027 "-fg" fg "-bg" bg
16028 "-D" dpi
16029 ;;"-x" scale "-y" scale
16030 "-T" "tight"
16031 "-o" pngfile
16032 dvifile)
16033 (error nil))
16034 (if (not (file-exists-p pngfile))
16035 (if org-format-latex-signal-error
16036 (error "Failed to create png file from %s" texfile)
16037 (message "Failed to create png file from %s" texfile)
16038 nil)
16039 ;; Use the requested file name and clean up
16040 (copy-file pngfile tofile 'replace)
16041 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16042 (delete-file (concat texfilebase e)))
16043 pngfile))))
16045 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16046 "Fill a LaTeX header template TPL.
16047 In the template, the following place holders will be recognized:
16050 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16052 [NO-PACKAGES] do not include PKG
16053 [EXTRA] the string EXTRA
16054 [NO-EXTRA] do not include EXTRA
16056 For backward compatibility, if both the positive and the negative place
16058 assumed to be present at the end of the template.
16059 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16060 EXTRA is a string.
16061 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16062 (let (rpl (end ""))
16064 (setq rpl (if (or (match-end 1) (not def-pkg))
16065 "" (org-latex-packages-to-string def-pkg snippets-p t))
16066 tpl (replace-match rpl t t tpl))
16067 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16070 (setq rpl (if (or (match-end 1) (not pkg))
16071 "" (org-latex-packages-to-string pkg snippets-p t))
16072 tpl (replace-match rpl t t tpl))
16073 (if pkg (setq end
16075 (org-latex-packages-to-string pkg snippets-p)))))
16078 (setq rpl (if (or (match-end 1) (not extra))
16080 tpl (replace-match rpl t t tpl))
16086 tpl)))
16088 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16090 (setq pkg (mapconcat (lambda(p)
16091 (cond
16092 ((stringp p) p)
16093 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16094 (format "%% Package %s omitted" (cadr p)))
16095 ((equal "" (car p))
16097 (t
16099 (car p) (cadr p)))))
16100 pkg
16104 (defun org-dvipng-color (attr)
16105 "Return an rgb color specification for dvipng."
16106 (apply 'format "rgb %s %s %s"
16107 (mapcar 'org-normalize-color
16108 (color-values (face-attribute 'default attr nil)))))
16110 (defun org-normalize-color (value)
16111 "Return string to be used as color value for an RGB component."
16112 (format "%g" (/ value 65535.0)))
16114 ;; Image display
16117 (defvar org-inline-image-overlays nil)
16118 (make-variable-buffer-local 'org-inline-image-overlays)
16120 (defun org-toggle-inline-images (&optional include-linked)
16121 "Toggle the display of inline images.
16122 INCLUDE-LINKED is passed to `org-display-inline-images'."
16123 (interactive "P")
16124 (if org-inline-image-overlays
16125 (progn
16126 (org-remove-inline-images)
16127 (message "Inline image display turned off"))
16128 (org-display-inline-images include-linked)
16129 (if org-inline-image-overlays
16130 (message "%d images displayed inline"
16131 (length org-inline-image-overlays))
16132 (message "No images to display inline"))))
16134 (defun org-display-inline-images (&optional include-linked refresh beg end)
16135 "Display inline images.
16136 Normally only links without a description part are inlined, because this
16137 is how it will work for export. When INCLUDE-LINKED is set, also links
16138 with a description part will be inlined. This can be nice for a quick
16139 look at those images, but it does not reflect what exported files will look
16140 like.
16141 When REFRESH is set, refresh existing images between BEG and END.
16142 This will create new image displays only if necessary.
16143 BEG and END default to the buffer boundaries."
16144 (interactive "P")
16145 (unless refresh
16146 (org-remove-inline-images)
16147 (clear-image-cache))
16148 (save-excursion
16149 (save-restriction
16150 (widen)
16151 (setq beg (or beg (point-min)) end (or end (point-max)))
16152 (goto-char (point-min))
16154 (substring (org-image-file-name-regexp) 0 -2)
16156 old file ov img)
16157 (while (re-search-forward re end t)
16158 (setq old (get-char-property-and-overlay (match-beginning 1)
16159 'org-image-overlay))
16160 (setq file (expand-file-name
16161 (concat (or (match-string 3) "") (match-string 4))))
16162 (when (file-exists-p file)
16163 (if (and (car-safe old) refresh)
16164 (image-refresh (overlay-get (cdr old) 'display))
16165 (setq img (save-match-data (create-image file)))
16166 (when img
16167 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16168 (overlay-put ov 'display img)
16169 (overlay-put ov 'face 'default)
16170 (overlay-put ov 'org-image-overlay t)
16171 (overlay-put ov 'modification-hooks
16172 (list 'org-display-inline-modification-hook))
16173 (push ov org-inline-image-overlays)))))))))
16175 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16176 "Remove inline-display overlay if a corresponding region is modified."
16177 (let ((inhibit-modification-hooks t))
16178 (when (and ov after)
16179 (delete ov org-inline-image-overlays)
16180 (delete-overlay ov))))
16182 (defun org-remove-inline-images ()
16183 "Remove inline display of images."
16184 (interactive)
16185 (mapc 'delete-overlay org-inline-image-overlays)
16186 (setq org-inline-image-overlays nil))
16188 ;;;; Key bindings
16190 ;; Make `C-c C-x' a prefix key
16191 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16193 ;; TAB key with modifiers
16194 (org-defkey org-mode-map "\C-i" 'org-cycle)
16195 (org-defkey org-mode-map [(tab)] 'org-cycle)
16196 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16197 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16199 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16200 ;; The following line is necessary under Suse GNU/Linux
16201 (unless (featurep 'xemacs)
16202 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16203 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16204 (define-key org-mode-map [backtab] 'org-shifttab)
16206 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16207 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16208 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16210 ;; Cursor keys with modifiers
16211 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16212 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16213 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16214 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16216 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16217 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16218 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16219 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16221 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16222 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16223 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16224 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16226 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16227 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16229 ;; Babel keys
16230 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16231 (mapc (lambda (pair)
16232 (define-key org-babel-map (car pair) (cdr pair)))
16233 org-babel-key-bindings)
16235 ;;; Extra keys for tty access.
16236 ;; We only set them when really needed because otherwise the
16237 ;; menus don't show the simple keys
16239 (when (or org-use-extra-keys
16240 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16241 (not window-system))
16242 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16243 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16244 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16245 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16246 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16247 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16248 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16249 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16250 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16251 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16252 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16253 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16254 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16255 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16256 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16257 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16258 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16259 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16260 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16261 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16262 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16263 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16264 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16265 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16266 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16267 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16268 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16269 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16271 ;; All the other keys
16273 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16274 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16275 (if (boundp 'narrow-map)
16276 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16277 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16278 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16279 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16280 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16281 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16282 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16283 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16284 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16285 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16286 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16287 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16288 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16289 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16290 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16291 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16292 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16293 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16295 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16296 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16297 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16298 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16299 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16300 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16301 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16302 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16303 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16304 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16305 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16306 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16307 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16308 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16309 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16310 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16311 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16312 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16313 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16315 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16316 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16317 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16318 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16319 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16320 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16321 (org-defkey org-mode-map "\C-c^" 'org-sort)
16322 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16323 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16324 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16325 (org-defkey org-mode-map "\C-m" 'org-return)
16326 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16327 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16328 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16329 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16330 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16331 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16332 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16333 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16334 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16335 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16336 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16337 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16338 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16339 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16340 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16341 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16342 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16343 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16344 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16345 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16346 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16348 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16349 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16350 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16351 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16353 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16354 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16355 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16356 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16357 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16358 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16359 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16360 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16361 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16362 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16364 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16365 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16366 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16367 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16368 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16369 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16370 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16372 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16373 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16374 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16375 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16376 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16378 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16380 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16382 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16383 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16385 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16388 (when (featurep 'xemacs)
16389 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16392 (defconst org-speed-commands-default
16393 '(
16394 ("Outline Navigation")
16395 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16396 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16397 ("f" . (org-speed-move-safe 'org-forward-same-level))
16398 ("b" . (org-speed-move-safe 'org-backward-same-level))
16399 ("u" . (org-speed-move-safe 'outline-up-heading))
16400 ("j" . org-goto)
16401 ("g" . (org-refile t))
16402 ("Outline Visibility")
16403 ("c" . org-cycle)
16404 ("C" . org-shifttab)
16405 (" " . org-display-outline-path)
16406 ("Outline Structure Editing")
16407 ("U" . org-shiftmetaup)
16408 ("D" . org-shiftmetadown)
16409 ("r" . org-metaright)
16410 ("l" . org-metaleft)
16411 ("R" . org-shiftmetaright)
16412 ("L" . org-shiftmetaleft)
16413 ("i" . (progn (forward-char 1) (call-interactively
16414 'org-insert-heading-respect-content)))
16415 ("^" . org-sort)
16416 ("w" . org-refile)
16417 ("a" . org-archive-subtree-default-with-confirmation)
16418 ("." . outline-mark-subtree)
16419 ("Clock Commands")
16420 ("I" . org-clock-in)
16421 ("O" . org-clock-out)
16422 ("Meta Data Editing")
16423 ("t" . org-todo)
16424 ("0" . (org-priority ?\ ))
16425 ("1" . (org-priority ?A))
16426 ("2" . (org-priority ?B))
16427 ("3" . (org-priority ?C))
16428 (";" . org-set-tags-command)
16429 ("e" . org-set-effort)
16430 ("Agenda Views etc")
16431 ("v" . org-agenda)
16432 ("/" . org-sparse-tree)
16433 ("Misc")
16434 ("o" . org-open-at-point)
16435 ("?" . org-speed-command-help)
16436 ("<" . (org-agenda-set-restriction-lock 'subtree))
16437 (">" . (org-agenda-remove-restriction-lock))
16438 )
16439 "The default speed commands.")
16441 (defun org-print-speed-command (e)
16442 (if (> (length (car e)) 1)
16443 (progn
16445 (princ (car e))
16447 (princ (make-string (length (car e)) ?-))
16449 (princ (car e))
16450 (princ " ")
16451 (if (symbolp (cdr e))
16452 (princ (symbol-name (cdr e)))
16453 (prin1 (cdr e)))
16456 (defun org-speed-command-help ()
16457 "Show the available speed commands."
16458 (interactive)
16459 (if (not org-use-speed-commands)
16460 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16461 (with-output-to-temp-buffer "*Help*"
16463 (mapc 'org-print-speed-command org-speed-commands-user)
16466 (mapc 'org-print-speed-command org-speed-commands-default))
16467 (with-current-buffer "*Help*"
16468 (setq truncate-lines t))))
16470 (defun org-speed-move-safe (cmd)
16471 "Execute CMD, but make sure that the cursor always ends up in a headline.
16472 If not, return to the original position and throw an error."
16473 (interactive)
16474 (let ((pos (point)))
16475 (call-interactively cmd)
16476 (unless (and (bolp) (org-on-heading-p))
16477 (goto-char pos)
16478 (error "Boundary reached while executing %s" cmd))))
16480 (defvar org-self-insert-command-undo-counter 0)
16482 (defvar org-table-auto-blank-field) ; defined in org-table.el
16483 (defvar org-speed-command nil)
16485 (defun org-speed-command-default-hook (keys)
16486 "Hook for activating single-letter speed commands.
16487 `org-speed-commands-default' specifies a minimal command set. Use
16488 `org-speed-commands-user' for further customization."
16489 (when (or (and (bolp) (looking-at outline-regexp))
16490 (and (functionp org-use-speed-commands)
16491 (funcall org-use-speed-commands)))
16492 (cdr (assoc keys (append org-speed-commands-user
16493 org-speed-commands-default)))))
16495 (defun org-babel-speed-command-hook (keys)
16496 "Hook for activating single-letter code block commands."
16497 (when (and (bolp) (looking-at org-babel-src-block-regexp))
16498 (cdr (assoc keys org-babel-key-bindings))))
16500 (defcustom org-speed-command-hook
16501 '(org-speed-command-default-hook org-babel-speed-command-hook)
16502 "Hook for activating speed commands at strategic locations.
16503 Hook functions are called in sequence until a valid handler is
16504 found.
16506 Each hook takes a single argument, a user-pressed command key
16507 which is also a `self-insert-command' from the global map.
16509 Within the hook, examine the cursor position and the command key
16510 and return nil or a valid handler as appropriate. Handler could
16511 be one of an interactive command, a function, or a form.
16513 Set `org-use-speed-commands' to non-nil value to enable this
16514 hook. The default setting is `org-speed-command-default-hook'."
16515 :group 'org-structure
16516 :type 'hook)
16518 (defun org-self-insert-command (N)
16519 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
16520 If the cursor is in a table looking at whitespace, the whitespace is
16521 overwritten, and the table is not marked as requiring realignment."
16522 (interactive "p")
16523 (cond
16524 ((and org-use-speed-commands
16525 (setq org-speed-command
16526 (run-hook-with-args-until-success
16527 'org-speed-command-hook (this-command-keys))))
16528 (cond
16529 ((commandp org-speed-command)
16530 (setq this-command org-speed-command)
16531 (call-interactively org-speed-command))
16532 ((functionp org-speed-command)
16533 (funcall org-speed-command))
16534 ((and org-speed-command (listp org-speed-command))
16535 (eval org-speed-command))
16536 (t (let (org-use-speed-commands)
16537 (call-interactively 'org-self-insert-command)))))
16538 ((and
16539 (org-table-p)
16540 (progn
16541 ;; check if we blank the field, and if that triggers align
16542 (and (featurep 'org-table) org-table-auto-blank-field
16543 (member last-command
16544 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
16546 ;; got extra space, this field does not determine column width
16547 (let (org-table-may-need-update) (org-table-blank-field))
16548 ;; no extra space, this field may determine column width
16549 (org-table-blank-field)))
16550 t)
16551 (eq N 1)
16553 (let (org-table-may-need-update)
16554 (goto-char (1- (match-end 0)))
16555 (delete-backward-char 1)
16556 (goto-char (match-beginning 0))
16557 (self-insert-command N)))
16558 (t
16559 (setq org-table-may-need-update t)
16560 (self-insert-command N)
16561 (org-fix-tags-on-the-fly)
16562 (if org-self-insert-cluster-for-undo
16563 (if (not (eq last-command 'org-self-insert-command))
16564 (setq org-self-insert-command-undo-counter 1)
16565 (if (>= org-self-insert-command-undo-counter 20)
16566 (setq org-self-insert-command-undo-counter 1)
16567 (and (> org-self-insert-command-undo-counter 0)
16568 buffer-undo-list
16569 (not (cadr buffer-undo-list)) ; remove nil entry
16570 (setcdr buffer-undo-list (cddr buffer-undo-list)))
16571 (setq org-self-insert-command-undo-counter
16572 (1+ org-self-insert-command-undo-counter))))))))
16574 (defun org-fix-tags-on-the-fly ()
16575 (when (and (equal (char-after (point-at-bol)) ?*)
16576 (org-on-heading-p))
16577 (org-align-tags-here org-tags-column)))
16579 (defun org-delete-backward-char (N)
16580 "Like `delete-backward-char', insert whitespace at field end in tables.
16581 When deleting backwards, in tables this function will insert whitespace in
16583 still be marked for re-alignment if the field did fill the entire column,
16584 because, in this case the deletion might narrow the column."
16585 (interactive "p")
16586 (if (and (org-table-p)
16587 (eq N 1)
16588 (string-match "|" (buffer-substring (point-at-bol) (point)))
16589 (looking-at ".*?|"))
16590 (let ((pos (point))
16592 (c org-table-may-need-update))
16593 (backward-delete-char N)
16594 (if (not overwrite-mode)
16595 (progn
16596 (skip-chars-forward "^|")
16597 (insert " ")
16598 (goto-char (1- pos))))
16599 ;; noalign: if there were two spaces at the end, this field
16600 ;; does not determine the width of the column.
16601 (if noalign (setq org-table-may-need-update c)))
16602 (backward-delete-char N)
16603 (org-fix-tags-on-the-fly)))
16605 (defun org-delete-char (N)
16606 "Like `delete-char', but insert whitespace at field end in tables.
16607 When deleting characters, in tables this function will insert whitespace in
16609 still be marked for re-alignment if the field did fill the entire column,
16610 because, in this case the deletion might narrow the column."
16611 (interactive "p")
16612 (if (and (org-table-p)
16613 (not (bolp))
16614 (not (= (char-after) ?|))
16615 (eq N 1))
16616 (if (looking-at ".*?|")
16617 (let ((pos (point))
16619 (c org-table-may-need-update))
16620 (replace-match (concat
16621 (substring (match-string 0) 1 -1)
16622 " |"))
16623 (goto-char pos)
16624 ;; noalign: if there were two spaces at the end, this field
16625 ;; does not determine the width of the column.
16626 (if noalign (setq org-table-may-need-update c)))
16627 (delete-char N))
16628 (delete-char N)
16629 (org-fix-tags-on-the-fly)))
16631 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
16632 (put 'org-self-insert-command 'delete-selection t)
16633 (put 'orgtbl-self-insert-command 'delete-selection t)
16634 (put 'org-delete-char 'delete-selection 'supersede)
16635 (put 'org-delete-backward-char 'delete-selection 'supersede)
16636 (put 'org-yank 'delete-selection 'yank)
16638 ;; Make `flyspell-mode' delay after some commands
16639 (put 'org-self-insert-command 'flyspell-delayed t)
16640 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
16641 (put 'org-delete-char 'flyspell-delayed t)
16642 (put 'org-delete-backward-char 'flyspell-delayed t)
16644 ;; Make pabbrev-mode expand after org-mode commands
16645 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
16646 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
16648 ;; How to do this: Measure non-white length of current string
16649 ;; If equal to column width, we should realign.
16651 (defun org-remap (map &rest commands)
16652 "In MAP, remap the functions given in COMMANDS.
16653 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
16654 (let (new old)
16655 (while commands
16656 (setq old (pop commands) new (pop commands))
16657 (if (fboundp 'command-remapping)
16658 (org-defkey map (vector 'remap old) new)
16659 (substitute-key-definition old new map global-map)))))
16661 (when (eq org-enable-table-editor 'optimized)
16662 ;; If the user wants maximum table support, we need to hijack
16663 ;; some standard editing functions
16664 (org-remap org-mode-map
16665 'self-insert-command 'org-self-insert-command
16666 'delete-char 'org-delete-char
16667 'delete-backward-char 'org-delete-backward-char)
16668 (org-defkey org-mode-map "|" 'org-force-self-insert))
16670 (defvar org-ctrl-c-ctrl-c-hook nil
16671 "Hook for functions attaching themselves to `C-c C-c'.
16672 This can be used to add additional functionality to the C-c C-c key which
16673 executes context-dependent commands.
16674 Each function will be called with no arguments. The function must check
16675 if the context is appropriate for it to act. If yes, it should do its
16676 thing and then return a non-nil value. If the context is wrong,
16677 just do nothing and return nil.")
16679 (defvar org-tab-first-hook nil
16680 "Hook for functions to attach themselves to TAB.
16681 See `org-ctrl-c-ctrl-c-hook' for more information.
16682 This hook runs as the first action when TAB is pressed, even before
16683 `org-cycle' messes around with the `outline-regexp' to cater for
16684 inline tasks and plain list item folding.
16685 If any function in this hook returns t, any other actions that
16686 would have been caused by TAB (such as table field motion or visibility
16687 cycling) will not occur.")
16689 (defvar org-tab-after-check-for-table-hook nil
16690 "Hook for functions to attach themselves to TAB.
16691 See `org-ctrl-c-ctrl-c-hook' for more information.
16692 This hook runs after it has been established that the cursor is not in a
16693 table, but before checking if the cursor is in a headline or if global cycling
16694 should be done.
16695 If any function in this hook returns t, not other actions like visibility
16696 cycling will be done.")
16698 (defvar org-tab-after-check-for-cycling-hook nil
16699 "Hook for functions to attach themselves to TAB.
16700 See `org-ctrl-c-ctrl-c-hook' for more information.
16701 This hook runs after it has been established that not table field motion and
16702 not visibility should be done because of current context. This is probably
16703 the place where a package like yasnippets can hook in.")
16705 (defvar org-tab-before-tab-emulation-hook nil
16706 "Hook for functions to attach themselves to TAB.
16707 See `org-ctrl-c-ctrl-c-hook' for more information.
16708 This hook runs after every other options for TAB have been exhausted, but
16711 (defvar org-metaleft-hook nil
16712 "Hook for functions attaching themselves to `M-left'.
16713 See `org-ctrl-c-ctrl-c-hook' for more information.")
16714 (defvar org-metaright-hook nil
16715 "Hook for functions attaching themselves to `M-right'.
16716 See `org-ctrl-c-ctrl-c-hook' for more information.")
16717 (defvar org-metaup-hook nil
16718 "Hook for functions attaching themselves to `M-up'.
16719 See `org-ctrl-c-ctrl-c-hook' for more information.")
16720 (defvar org-metadown-hook nil
16721 "Hook for functions attaching themselves to `M-down'.
16722 See `org-ctrl-c-ctrl-c-hook' for more information.")
16723 (defvar org-shiftmetaleft-hook nil
16724 "Hook for functions attaching themselves to `M-S-left'.
16725 See `org-ctrl-c-ctrl-c-hook' for more information.")
16726 (defvar org-shiftmetaright-hook nil
16727 "Hook for functions attaching themselves to `M-S-right'.
16728 See `org-ctrl-c-ctrl-c-hook' for more information.")
16729 (defvar org-shiftmetaup-hook nil
16730 "Hook for functions attaching themselves to `M-S-up'.
16731 See `org-ctrl-c-ctrl-c-hook' for more information.")
16732 (defvar org-shiftmetadown-hook nil
16733 "Hook for functions attaching themselves to `M-S-down'.
16734 See `org-ctrl-c-ctrl-c-hook' for more information.")
16735 (defvar org-metareturn-hook nil
16736 "Hook for functions attaching themselves to `M-RET'.
16737 See `org-ctrl-c-ctrl-c-hook' for more information.")
16738 (defvar org-shiftup-hook nil
16739 "Hook for functions attaching themselves to `S-up'.
16740 See `org-ctrl-c-ctrl-c-hook' for more information.")
16741 (defvar org-shiftup-final-hook nil
16742 "Hook for functions attaching themselves to `S-up'.
16743 This one runs after all other options except shift-select have been excluded.
16744 See `org-ctrl-c-ctrl-c-hook' for more information.")
16745 (defvar org-shiftdown-hook nil
16746 "Hook for functions attaching themselves to `S-down'.
16747 See `org-ctrl-c-ctrl-c-hook' for more information.")
16748 (defvar org-shiftdown-final-hook nil
16749 "Hook for functions attaching themselves to `S-down'.
16750 This one runs after all other options except shift-select have been excluded.
16751 See `org-ctrl-c-ctrl-c-hook' for more information.")
16752 (defvar org-shiftleft-hook nil
16753 "Hook for functions attaching themselves to `S-left'.
16754 See `org-ctrl-c-ctrl-c-hook' for more information.")
16755 (defvar org-shiftleft-final-hook nil
16756 "Hook for functions attaching themselves to `S-left'.
16757 This one runs after all other options except shift-select have been excluded.
16758 See `org-ctrl-c-ctrl-c-hook' for more information.")
16759 (defvar org-shiftright-hook nil
16760 "Hook for functions attaching themselves to `S-right'.
16761 See `org-ctrl-c-ctrl-c-hook' for more information.")
16762 (defvar org-shiftright-final-hook nil
16763 "Hook for functions attaching themselves to `S-right'.
16764 This one runs after all other options except shift-select have been excluded.
16765 See `org-ctrl-c-ctrl-c-hook' for more information.")
16767 (defun org-modifier-cursor-error ()
16768 "Throw an error, a modified cursor command was applied in wrong context."
16769 (error "This command is active in special context like tables, headlines or items"))
16771 (defun org-shiftselect-error ()
16772 "Throw an error because Shift-Cursor command was applied in wrong context."
16773 (if (and (boundp 'shift-select-mode) shift-select-mode)
16774 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
16775 (error "This command works only in special context like headlines or timestamps")))
16777 (defun org-call-for-shift-select (cmd)
16778 (let ((this-command-keys-shift-translated t))
16779 (call-interactively cmd)))
16781 (defun org-shifttab (&optional arg)
16782 "Global visibility cycling or move to previous table field.
16783 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
16784 on context.
16785 See the individual commands for more information."
16786 (interactive "P")
16787 (cond
16788 ((org-at-table-p) (call-interactively 'org-table-previous-field))
16789 ((integerp arg)
16790 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
16791 (message "Content view to level: %d" arg)
16792 (org-content (prefix-numeric-value arg2))
16793 (setq org-cycle-global-status 'overview)))
16794 (t (call-interactively 'org-global-cycle))))
16796 (defun org-shiftmetaleft ()
16797 "Promote subtree or delete table column.
16798 Calls `org-promote-subtree', `org-outdent-item',
16799 or `org-table-delete-column', depending on context.
16800 See the individual commands for more information."
16801 (interactive)
16802 (cond
16803 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
16804 ((org-at-table-p) (call-interactively 'org-table-delete-column))
16805 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
16806 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
16807 (t (org-modifier-cursor-error))))
16809 (defun org-shiftmetaright ()
16810 "Demote subtree or insert table column.
16811 Calls `org-demote-subtree', `org-indent-item',
16812 or `org-table-insert-column', depending on context.
16813 See the individual commands for more information."
16814 (interactive)
16815 (cond
16816 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
16817 ((org-at-table-p) (call-interactively 'org-table-insert-column))
16818 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
16819 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
16820 (t (org-modifier-cursor-error))))
16822 (defun org-shiftmetaup (&optional arg)
16823 "Move subtree up or kill table row.
16824 Calls `org-move-subtree-up' or `org-table-kill-row' or
16825 `org-move-item-up' depending on context. See the individual commands
16826 for more information."
16827 (interactive "P")
16828 (cond
16829 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
16830 ((org-at-table-p) (call-interactively 'org-table-kill-row))
16831 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16832 ((org-at-item-p) (call-interactively 'org-move-item-up))
16833 (t (org-modifier-cursor-error))))
16835 (defun org-shiftmetadown (&optional arg)
16836 "Move subtree down or insert table row.
16837 Calls `org-move-subtree-down' or `org-table-insert-row' or
16838 `org-move-item-down', depending on context. See the individual
16839 commands for more information."
16840 (interactive "P")
16841 (cond
16842 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
16843 ((org-at-table-p) (call-interactively 'org-table-insert-row))
16844 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16845 ((org-at-item-p) (call-interactively 'org-move-item-down))
16846 (t (org-modifier-cursor-error))))
16848 (defsubst org-hidden-tree-error ()
16849 (error
16850 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
16852 (defun org-metaleft (&optional arg)
16853 "Promote heading or move table column to left.
16854 Calls `org-do-promote' or `org-table-move-column', depending on context.
16855 With no specific context, calls the Emacs default `backward-word'.
16856 See the individual commands for more information."
16857 (interactive "P")
16858 (cond
16859 ((run-hook-with-args-until-success 'org-metaleft-hook))
16860 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
16861 ((or (org-on-heading-p)
16862 (and (org-region-active-p)
16863 (save-excursion
16864 (goto-char (region-beginning))
16865 (org-on-heading-p))))
16866 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16867 (call-interactively 'org-do-promote))
16868 ((or (org-at-item-p)
16869 (and (org-region-active-p)
16870 (save-excursion
16871 (goto-char (region-beginning))
16872 (org-at-item-p))))
16873 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16874 (call-interactively 'org-outdent-item))
16875 (t (call-interactively 'backward-word))))
16877 (defun org-metaright (&optional arg)
16878 "Demote subtree or move table column to right.
16879 Calls `org-do-demote' or `org-table-move-column', depending on context.
16880 With no specific context, calls the Emacs default `forward-word'.
16881 See the individual commands for more information."
16882 (interactive "P")
16883 (cond
16884 ((run-hook-with-args-until-success 'org-metaright-hook))
16885 ((org-at-table-p) (call-interactively 'org-table-move-column))
16886 ((or (org-on-heading-p)
16887 (and (org-region-active-p)
16888 (save-excursion
16889 (goto-char (region-beginning))
16890 (org-on-heading-p))))
16891 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16892 (call-interactively 'org-do-demote))
16893 ((or (org-at-item-p)
16894 (and (org-region-active-p)
16895 (save-excursion
16896 (goto-char (region-beginning))
16897 (org-at-item-p))))
16898 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16899 (call-interactively 'org-indent-item))
16900 (t (call-interactively 'forward-word))))
16902 (defun org-check-for-hidden (what)
16903 "Check if there are hidden headlines/items in the current visual line.
16904 WHAT can be either `headlines' or `items'. If the current line is
16905 an outline or item heading and it has a folded subtree below it,
16906 this function returns t, nil otherwise."
16907 (let ((re (cond
16908 ((eq what 'headlines) (concat "^" org-outline-regexp))
16909 ((eq what 'items) (concat "^" (org-item-re t)))
16910 (t (error "This should not happen"))))
16911 beg end)
16912 (save-excursion
16913 (catch 'exit
16914 (unless (org-region-active-p)
16915 (setq beg (point-at-bol))
16916 (beginning-of-line 2)
16917 (while (and (not (eobp)) ;; this is like `next-line'
16918 (get-char-property (1- (point)) 'invisible))
16919 (beginning-of-line 2))
16920 (setq end (point))
16921 (goto-char beg)
16922 (goto-char (point-at-eol))
16923 (setq end (max end (point)))
16924 (while (re-search-forward re end t)
16925 (if (get-char-property (match-beginning 0) 'invisible)
16926 (throw 'exit t))))
16927 nil))))
16929 (defun org-metaup (&optional arg)
16930 "Move subtree up or move table row up.
16931 Calls `org-move-subtree-up' or `org-table-move-row' or
16932 `org-move-item-up', depending on context. See the individual commands
16933 for more information."
16934 (interactive "P")
16935 (cond
16936 ((run-hook-with-args-until-success 'org-metaup-hook))
16937 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
16938 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16939 ((org-at-item-p) (call-interactively 'org-move-item-up))
16940 (t (transpose-lines 1) (beginning-of-line -1))))
16942 (defun org-metadown (&optional arg)
16943 "Move subtree down or move table row down.
16944 Calls `org-move-subtree-down' or `org-table-move-row' or
16945 `org-move-item-down', depending on context. See the individual
16946 commands for more information."
16947 (interactive "P")
16948 (cond
16949 ((run-hook-with-args-until-success 'org-metadown-hook))
16950 ((org-at-table-p) (call-interactively 'org-table-move-row))
16951 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16952 ((org-at-item-p) (call-interactively 'org-move-item-down))
16953 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
16955 (defun org-shiftup (&optional arg)
16956 "Increase item in timestamp or increase priority of current headline.
16957 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
16958 depending on context. See the individual commands for more information."
16959 (interactive "P")
16960 (cond
16961 ((run-hook-with-args-until-success 'org-shiftup-hook))
16962 ((and org-support-shift-select (org-region-active-p))
16963 (org-call-for-shift-select 'previous-line))
16964 ((org-at-timestamp-p t)
16965 (call-interactively (if org-edit-timestamp-down-means-later
16966 'org-timestamp-down 'org-timestamp-up)))
16967 ((and (not (eq org-support-shift-select 'always))
16968 org-enable-priority-commands
16969 (org-on-heading-p))
16970 (call-interactively 'org-priority-up))
16971 ((and (not org-support-shift-select) (org-at-item-p))
16972 (call-interactively 'org-previous-item))
16973 ((org-clocktable-try-shift 'up arg))
16974 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
16975 (org-support-shift-select
16976 (org-call-for-shift-select 'previous-line))
16977 (t (org-shiftselect-error))))
16979 (defun org-shiftdown (&optional arg)
16980 "Decrease item in timestamp or decrease priority of current headline.
16981 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
16982 depending on context. See the individual commands for more information."
16983 (interactive "P")
16984 (cond
16985 ((run-hook-with-args-until-success 'org-shiftdown-hook))
16986 ((and org-support-shift-select (org-region-active-p))
16987 (org-call-for-shift-select 'next-line))
16988 ((org-at-timestamp-p t)
16989 (call-interactively (if org-edit-timestamp-down-means-later
16990 'org-timestamp-up 'org-timestamp-down)))
16991 ((and (not (eq org-support-shift-select 'always))
16992 org-enable-priority-commands
16993 (org-on-heading-p))
16994 (call-interactively 'org-priority-down))
16995 ((and (not org-support-shift-select) (org-at-item-p))
16996 (call-interactively 'org-next-item))
16997 ((org-clocktable-try-shift 'down arg))
16998 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
16999 (org-support-shift-select
17000 (org-call-for-shift-select 'next-line))
17001 (t (org-shiftselect-error))))
17003 (defun org-shiftright (&optional arg)
17004 "Cycle the thing at point or in the current line, depending on context.
17005 Depending on context, this does one of the following:
17007 - switch a timestamp at point one day into the future
17008 - on a headline, switch to the next TODO keyword.
17009 - on an item, switch entire list to the next bullet type
17010 - on a property line, switch to the next allowed value
17011 - on a clocktable definition line, move time block into the future"
17012 (interactive "P")
17013 (cond
17014 ((run-hook-with-args-until-success 'org-shiftright-hook))
17015 ((and org-support-shift-select (org-region-active-p))
17016 (org-call-for-shift-select 'forward-char))
17017 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17018 ((and (not (eq org-support-shift-select 'always))
17019 (org-on-heading-p))
17020 (let ((org-inhibit-logging
17021 (not org-treat-S-cursor-todo-selection-as-state-change))
17022 (org-inhibit-blocking
17023 (not org-treat-S-cursor-todo-selection-as-state-change)))
17024 (org-call-with-arg 'org-todo 'right)))
17025 ((or (and org-support-shift-select
17026 (not (eq org-support-shift-select 'always))
17027 (org-at-item-bullet-p))
17028 (and (not org-support-shift-select) (org-at-item-p)))
17029 (org-call-with-arg 'org-cycle-list-bullet nil))
17030 ((and (not (eq org-support-shift-select 'always))
17031 (org-at-property-p))
17032 (call-interactively 'org-property-next-allowed-value))
17033 ((org-clocktable-try-shift 'right arg))
17034 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17035 (org-support-shift-select
17036 (org-call-for-shift-select 'forward-char))
17037 (t (org-shiftselect-error))))
17039 (defun org-shiftleft (&optional arg)
17040 "Cycle the thing at point or in the current line, depending on context.
17041 Depending on context, this does one of the following:
17043 - switch a timestamp at point one day into the past
17044 - on a headline, switch to the previous TODO keyword.
17045 - on an item, switch entire list to the previous bullet type
17046 - on a property line, switch to the previous allowed value
17047 - on a clocktable definition line, move time block into the past"
17048 (interactive "P")
17049 (cond
17050 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17051 ((and org-support-shift-select (org-region-active-p))
17052 (org-call-for-shift-select 'backward-char))
17053 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17054 ((and (not (eq org-support-shift-select 'always))
17055 (org-on-heading-p))
17056 (let ((org-inhibit-logging
17057 (not org-treat-S-cursor-todo-selection-as-state-change))
17058 (org-inhibit-blocking
17059 (not org-treat-S-cursor-todo-selection-as-state-change)))
17060 (org-call-with-arg 'org-todo 'left)))
17061 ((or (and org-support-shift-select
17062 (not (eq org-support-shift-select 'always))
17063 (org-at-item-bullet-p))
17064 (and (not org-support-shift-select) (org-at-item-p)))
17065 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17066 ((and (not (eq org-support-shift-select 'always))
17067 (org-at-property-p))
17068 (call-interactively 'org-property-previous-allowed-value))
17069 ((org-clocktable-try-shift 'left arg))
17070 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17071 (org-support-shift-select
17072 (org-call-for-shift-select 'backward-char))
17073 (t (org-shiftselect-error))))
17075 (defun org-shiftcontrolright ()
17076 "Switch to next TODO set."
17077 (interactive)
17078 (cond
17079 ((and org-support-shift-select (org-region-active-p))
17080 (org-call-for-shift-select 'forward-word))
17081 ((and (not (eq org-support-shift-select 'always))
17082 (org-on-heading-p))
17083 (org-call-with-arg 'org-todo 'nextset))
17084 (org-support-shift-select
17085 (org-call-for-shift-select 'forward-word))
17086 (t (org-shiftselect-error))))
17088 (defun org-shiftcontrolleft ()
17089 "Switch to previous TODO set."
17090 (interactive)
17091 (cond
17092 ((and org-support-shift-select (org-region-active-p))
17093 (org-call-for-shift-select 'backward-word))
17094 ((and (not (eq org-support-shift-select 'always))
17095 (org-on-heading-p))
17096 (org-call-with-arg 'org-todo 'previousset))
17097 (org-support-shift-select
17098 (org-call-for-shift-select 'backward-word))
17099 (t (org-shiftselect-error))))
17101 (defun org-ctrl-c-ret ()
17102 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17103 (interactive)
17104 (cond
17105 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17106 (t (call-interactively 'org-insert-heading))))
17108 (defun org-copy-special ()
17109 "Copy region in table or copy current subtree.
17110 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17111 See the individual commands for more information."
17112 (interactive)
17113 (call-interactively
17114 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17116 (defun org-cut-special ()
17117 "Cut region in table or cut current subtree.
17118 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17119 See the individual commands for more information."
17120 (interactive)
17121 (call-interactively
17122 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17124 (defun org-paste-special (arg)
17125 "Paste rectangular region into table, or past subtree relative to level.
17126 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17127 See the individual commands for more information."
17128 (interactive "P")
17129 (if (org-at-table-p)
17130 (org-table-paste-rectangle)
17131 (org-paste-subtree arg)))
17133 (defun org-edit-special (&optional arg)
17134 "Call a special editor for the stuff at point.
17135 When at a table, call the formula editor with `org-table-edit-formulas'.
17136 When at the first line of an src example, call `org-edit-src-code'.
17137 When in an #+include line, visit the include file. Otherwise call
17138 `ffap' to visit the file at point."
17139 (interactive)
17140 ;; possibly prep session before editing source
17141 (when arg
17142 (let* ((info (org-babel-get-src-block-info))
17143 (lang (nth 0 info))
17144 (params (nth 2 info))
17145 (session (cdr (assoc :session params))))
17146 (when (and info session) ;; we are in a source-code block with a session
17147 (funcall
17148 (intern (concat "org-babel-prep-session:" lang)) session params))))
17149 (cond ;; proceed with `org-edit-special'
17150 ((save-excursion
17151 (beginning-of-line 1)
17152 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17153 (find-file (org-trim (match-string 1))))
17154 ((org-edit-src-code))
17155 ((org-edit-fixed-width-region))
17156 ((org-at-table.el-p)
17157 (org-edit-src-code))
17158 ((or (org-at-table-p)
17159 (save-excursion
17160 (beginning-of-line 1)
17162 (call-interactively 'org-table-edit-formulas))
17163 (t (call-interactively 'ffap))))
17165 (defun org-ctrl-c-ctrl-c (&optional arg)
17166 "Set tags in headline, or update according to changed information at point.
17168 This command does many different things, depending on context:
17170 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17171 this is what we do.
17173 - If the cursor is on a statistics cookie, update it.
17175 - If the cursor is in a headline, prompt for tags and insert them
17176 into the current line, aligned to `org-tags-column'. When called
17177 with prefix arg, realign all tags in the current buffer.
17179 - If the cursor is in one of the special #+KEYWORD lines, this
17180 triggers scanning the buffer for these lines and updating the
17181 information.
17183 - If the cursor is inside a table, realign the table. This command
17184 works even if the automatic table editor has been turned off.
17186 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17187 the entire table.
17189 - If the cursor is at a footnote reference or definition, jump to
17190 the corresponding definition or references, respectively.
17192 - If the cursor is a the beginning of a dynamic block, update it.
17194 - If the current buffer is a capture buffer, close note and file it.
17196 - If the cursor is on a <<<target>>>, update radio targets and
17197 corresponding links in this buffer.
17199 - If the cursor is on a numbered item in a plain list, renumber the
17200 ordered list.
17202 - If the cursor is on a checkbox, toggle it.
17204 - If the cursor is on a code block, evaluate it. The variable
17205 `org-confirm-babel-evaluate' can be used to control prompting
17206 before code block evaluation, by default every code block
17207 evaluation requires confirmation. Code block evaluation can be
17208 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17209 (interactive "P")
17210 (let ((org-enable-table-editor t))
17211 (cond
17212 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17213 org-occur-highlights
17214 org-latex-fragment-image-overlays)
17215 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17216 (org-remove-occur-highlights)
17217 (org-remove-latex-fragment-image-overlays)
17218 (message "Temporary highlights/overlays removed from current buffer"))
17219 ((and (local-variable-p 'org-finish-function (current-buffer))
17220 (fboundp org-finish-function))
17221 (funcall org-finish-function))
17222 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17223 ((or (looking-at org-property-start-re)
17224 (org-at-property-p))
17225 (call-interactively 'org-property-action))
17226 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17228 (or (org-on-heading-p) (org-at-item-p)))
17229 (call-interactively 'org-update-statistics-cookies))
17230 ((org-on-heading-p) (call-interactively 'org-set-tags))
17231 ((org-at-table.el-p)
17232 (message "Use C-c ' to edit table.el tables"))
17233 ((org-at-table-p)
17234 (org-table-maybe-eval-formula)
17235 (if arg
17236 (call-interactively 'org-table-recalculate)
17237 (org-table-maybe-recalculate-line))
17238 (call-interactively 'org-table-align)
17239 (orgtbl-send-table 'maybe))
17240 ((or (org-footnote-at-reference-p)
17241 (org-footnote-at-definition-p))
17242 (call-interactively 'org-footnote-action))
17243 ((org-at-item-checkbox-p)
17244 (call-interactively 'org-list-repair)
17245 (call-interactively 'org-toggle-checkbox)
17246 (org-list-send-list 'maybe))
17247 ((org-at-item-p)
17248 (call-interactively 'org-list-repair)
17249 (when arg (call-interactively 'org-toggle-checkbox))
17250 (org-list-send-list 'maybe))
17251 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17252 ;; Dynamic block
17253 (beginning-of-line 1)
17254 (save-excursion (org-update-dblock)))
17255 ((save-excursion
17256 (beginning-of-line 1)
17258 (cond
17259 ((equal (match-string 1) "TBLFM")
17260 ;; Recalculate the table before this line
17261 (save-excursion
17262 (beginning-of-line 1)
17264 (if (org-at-table-p)
17265 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17266 (t
17267 (let ((org-inhibit-startup-visibility-stuff t)
17268 (org-startup-align-all-tables nil))
17269 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17270 (message "Local setup has been refreshed"))))
17271 ((org-clock-update-time-maybe))
17272 (t (error "C-c C-c can do nothing useful at this location")))))
17274 (defun org-mode-restart ()
17275 "Restart Org-mode, to scan again for special lines.
17276 Also updates the keyword regular expressions."
17277 (interactive)
17278 (org-mode)
17279 (message "Org-mode restarted"))
17281 (defun org-kill-note-or-show-branches ()
17282 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17283 (interactive)
17284 (if (not org-finish-function)
17285 (progn
17286 (hide-subtree)
17287 (call-interactively 'show-branches))
17288 (let ((org-note-abort t))
17289 (funcall org-finish-function))))
17291 (defun org-return (&optional indent)
17292 "Goto next table row or insert a newline.
17293 Calls `org-table-next-row' or `newline', depending on context.
17294 See the individual commands for more information."
17295 (interactive)
17296 (cond
17297 ((bobp) (if indent (newline-and-indent) (newline)))
17298 ((org-at-table-p)
17299 (org-table-justify-field-maybe)
17300 (call-interactively 'org-table-next-row))
17301 ((and org-return-follows-link
17302 (eq (get-text-property (point) 'face) 'org-link))
17303 (call-interactively 'org-open-at-point))
17304 ((and (org-at-heading-p)
17305 (looking-at
17307 (org-show-entry)
17308 (end-of-line 1)
17309 (newline))
17310 (t (if indent (newline-and-indent) (newline)))))
17312 (defun org-return-indent ()
17313 "Goto next table row or insert a newline and indent.
17314 Calls `org-table-next-row' or `newline-and-indent', depending on
17315 context. See the individual commands for more information."
17316 (interactive)
17317 (org-return t))
17319 (defun org-ctrl-c-star ()
17320 "Compute table, or change heading status of lines.
17321 Calls `org-table-recalculate' or `org-toggle-heading',
17322 depending on context."
17323 (interactive)
17324 (cond
17325 ((org-at-table-p)
17326 (call-interactively 'org-table-recalculate))
17327 (t
17328 ;; Convert all lines in region to list items
17329 (call-interactively 'org-toggle-heading))))
17331 (defun org-ctrl-c-minus ()
17332 "Insert separator line in table or modify bullet status of line.
17333 Also turns a plain line or a region of lines into list items.
17334 Calls `org-table-insert-hline', `org-toggle-item', or
17335 `org-cycle-list-bullet', depending on context."
17336 (interactive)
17337 (cond
17338 ((org-at-table-p)
17339 (call-interactively 'org-table-insert-hline))
17340 ((org-region-active-p)
17341 (call-interactively 'org-toggle-item))
17342 ((org-in-item-p)
17343 (call-interactively 'org-cycle-list-bullet))
17344 (t
17345 (call-interactively 'org-toggle-item))))
17347 (defun org-toggle-item ()
17348 "Convert headings or normal lines to items, items to normal lines.
17349 If there is no active region, only the current line is considered.
17351 If the first line in the region is a headline, convert all headlines to items.
17353 If the first line in the region is an item, convert all items to normal lines.
17355 If the first line is normal text, add an item bullet to each line."
17356 (interactive)
17357 (let (l2 l beg end)
17358 (if (org-region-active-p)
17359 (setq beg (region-beginning) end (region-end))
17360 (setq beg (point-at-bol)
17361 end (min (1+ (point-at-eol)) (point-max))))
17362 (save-excursion
17363 (goto-char end)
17364 (setq l2 (org-current-line))
17365 (goto-char beg)
17366 (beginning-of-line 1)
17367 (setq l (1- (org-current-line)))
17368 (if (org-at-item-p)
17369 ;; We already have items, de-itemize
17370 (while (< (setq l (1+ l)) l2)
17371 (when (org-at-item-p)
17373 (delete-region (point) (match-end 0)))
17374 (beginning-of-line 2))
17375 (if (org-on-heading-p)
17376 ;; Headings, convert to items
17377 (while (< (setq l (1+ l)) l2)
17378 (if (looking-at org-outline-regexp)
17379 (replace-match (org-list-bullet-string "-") t t))
17380 (beginning-of-line 2))
17381 ;; normal lines, turn them into items
17382 (while (< (setq l (1+ l)) l2)
17383 (unless (org-at-item-p)
17385 (replace-match
17387 (beginning-of-line 2)))))))
17389 (defun org-toggle-heading (&optional nstars)
17390 "Convert headings to normal text, or items or text to headings.
17391 If there is no active region, only the current line is considered.
17393 If the first line is a heading, remove the stars from all headlines
17394 in the region.
17396 If the first line is a plain list item, turn all plain list items
17397 into headings.
17399 If the first line is a normal line, turn each and every line in the
17400 region into a heading.
17402 When converting a line into a heading, the number of stars is chosen
17403 such that the lines become children of the current entry. However,
17404 when a prefix argument is given, its value determines the number of
17405 stars to add."
17406 (interactive "P")
17407 (let (l2 l itemp beg end)
17408 (if (org-region-active-p)
17409 (setq beg (region-beginning) end (region-end))
17410 (setq beg (point-at-bol)
17411 end (min (1+ (point-at-eol)) (point-max))))
17412 (save-excursion
17413 (goto-char end)
17414 (setq l2 (org-current-line))
17415 (goto-char beg)
17416 (beginning-of-line 1)
17417 (setq l (1- (org-current-line)))
17418 (if (org-on-heading-p)
17419 ;; We already have headlines, de-star them
17420 (while (< (setq l (1+ l)) l2)
17421 (when (org-on-heading-p t)
17422 (and (looking-at outline-regexp) (replace-match "")))
17423 (beginning-of-line 2))
17424 (setq itemp (org-at-item-p))
17425 (let* ((stars
17426 (if nstars
17427 (make-string (prefix-numeric-value current-prefix-arg)
17428 ?*)
17429 (save-excursion
17430 (if (re-search-backward org-complex-heading-regexp nil t)
17431 (match-string 1) ""))))
17432 (add-stars (cond (nstars "")
17433 ((equal stars "") "*")
17434 (org-odd-levels-only "**")
17435 (t "*")))
17436 (rpl (concat stars add-stars " ")))
17437 (while (< (setq l (1+ l)) l2)
17438 (if itemp
17439 (and (org-at-item-p) (replace-match rpl t t))
17440 (unless (org-on-heading-p)
17442 (replace-match (concat rpl (match-string 2))))))
17443 (beginning-of-line 2)))))))
17445 (defun org-meta-return (&optional arg)
17446 "Insert a new heading or wrap a region in a table.
17447 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17448 See the individual commands for more information."
17449 (interactive "P")
17450 (cond
17451 ((run-hook-with-args-until-success 'org-metareturn-hook))
17452 ((org-at-table-p)
17453 (call-interactively 'org-table-wrap-region))
17454 (t (call-interactively 'org-insert-heading))))
17456 ;;; Menu entries
17458 ;; Define the Org-mode menus
17459 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
17460 '("Tbl"
17461 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
17462 ["Next Field" org-cycle (org-at-table-p)]
17463 ["Previous Field" org-shifttab (org-at-table-p)]
17464 ["Next Row" org-return (org-at-table-p)]
17465 "--"
17466 ["Blank Field" org-table-blank-field (org-at-table-p)]
17467 ["Edit Field" org-table-edit-field (org-at-table-p)]
17468 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
17469 "--"
17470 ("Column"
17471 ["Move Column Left" org-metaleft (org-at-table-p)]
17472 ["Move Column Right" org-metaright (org-at-table-p)]
17473 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
17474 ["Insert Column" org-shiftmetaright (org-at-table-p)])
17475 ("Row"
17476 ["Move Row Up" org-metaup (org-at-table-p)]
17477 ["Move Row Down" org-metadown (org-at-table-p)]
17478 ["Delete Row" org-shiftmetaup (org-at-table-p)]
17479 ["Insert Row" org-shiftmetadown (org-at-table-p)]
17480 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
17481 "--"
17482 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
17483 ("Rectangle"
17484 ["Copy Rectangle" org-copy-special (org-at-table-p)]
17485 ["Cut Rectangle" org-cut-special (org-at-table-p)]
17486 ["Paste Rectangle" org-paste-special (org-at-table-p)]
17487 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
17488 "--"
17489 ("Calculate"
17490 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
17491 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17492 ["Edit Formulas" org-edit-special (org-at-table-p)]
17493 "--"
17494 ["Recalculate line" org-table-recalculate (org-at-table-p)]
17495 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17496 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
17497 "--"
17498 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
17499 "--"
17500 ["Sum Column/Rectangle" org-table-sum
17501 (or (org-at-table-p) (org-region-active-p))]
17502 ["Which Column?" org-table-current-column (org-at-table-p)])
17503 ["Debug Formulas"
17504 org-table-toggle-formula-debugger
17505 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
17506 ["Show Col/Row Numbers"
17507 org-table-toggle-coordinate-overlays
17508 :style toggle
17509 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
17510 "--"
17511 ["Create" org-table-create (and (not (org-at-table-p))
17512 org-enable-table-editor)]
17513 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
17514 ["Import from File" org-table-import (not (org-at-table-p))]
17515 ["Export to File" org-table-export (org-at-table-p)]
17516 "--"
17517 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
17519 (easy-menu-define org-org-menu org-mode-map "Org menu"
17520 '("Org"
17521 ("Show/Hide"
17522 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
17523 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
17524 ["Sparse Tree..." org-sparse-tree t]
17525 ["Reveal Context" org-reveal t]
17526 ["Show All" show-all t]
17527 "--"
17528 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
17529 "--"
17530 ["New Heading" org-insert-heading t]
17531 ("Navigate Headings"
17532 ["Up" outline-up-heading t]
17533 ["Next" outline-next-visible-heading t]
17534 ["Previous" outline-previous-visible-heading t]
17535 ["Next Same Level" outline-forward-same-level t]
17536 ["Previous Same Level" outline-backward-same-level t]
17537 "--"
17538 ["Jump" org-goto t])
17539 ("Edit Structure"
17540 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
17541 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
17542 "--"
17543 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
17544 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
17545 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
17546 "--"
17547 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
17548 "--"
17549 ["Promote Heading" org-metaleft (not (org-at-table-p))]
17550 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
17551 ["Demote Heading" org-metaright (not (org-at-table-p))]
17552 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
17553 "--"
17554 ["Sort Region/Children" org-sort (not (org-at-table-p))]
17555 "--"
17556 ["Convert to odd levels" org-convert-to-odd-levels t]
17557 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
17558 ("Editing"
17559 ["Emphasis..." org-emphasize t]
17560 ["Edit Source Example" org-edit-special t]
17561 "--"
17562 ["Footnote new/jump" org-footnote-action t]
17563 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
17564 ("Archive"
17565 ["Archive (default method)" org-archive-subtree-default t]
17566 "--"
17567 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
17568 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
17569 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
17570 )
17571 "--"
17572 ("Hyperlinks"
17573 ["Store Link (Global)" org-store-link t]
17574 ["Find existing link to here" org-occur-link-in-agenda-files t]
17575 ["Insert Link" org-insert-link t]
17576 ["Follow Link" org-open-at-point t]
17577 "--"
17578 ["Next link" org-next-link t]
17579 ["Previous link" org-previous-link t]
17580 "--"
17581 ["Descriptive Links"
17582 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
17583 :style radio
17584 :selected (member '(org-link) buffer-invisibility-spec)]
17585 ["Literal Links"
17586 (progn
17587 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
17588 :style radio
17589 :selected (not (member '(org-link) buffer-invisibility-spec))])
17590 "--"
17591 ("TODO Lists"
17592 ["TODO/DONE/-" org-todo t]
17593 ("Select keyword"
17594 ["Next keyword" org-shiftright (org-on-heading-p)]
17595 ["Previous keyword" org-shiftleft (org-on-heading-p)]
17596 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
17597 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
17598 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
17599 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
17600 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
17601 "--"
17602 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
17603 :selected org-enforce-todo-dependencies :style toggle :active t]
17604 "Settings for tree at point"
17605 ["Do Children sequentially" org-toggle-ordered-property :style radio
17606 :selected (ignore-errors (org-entry-get nil "ORDERED"))
17607 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17608 ["Do Children parallel" org-toggle-ordered-property :style radio
17609 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
17610 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17611 "--"
17612 ["Set Priority" org-priority t]
17613 ["Priority Up" org-shiftup t]
17614 ["Priority Down" org-shiftdown t]
17615 "--"
17616 ["Get news from all feeds" org-feed-update-all t]
17617 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
17618 ["Customize feeds" (customize-variable 'org-feed-alist) t])
17619 ("TAGS and Properties"
17620 ["Set Tags" org-set-tags-command t]
17621 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
17622 "--"
17623 ["Set property" org-set-property t]
17624 ["Column view of properties" org-columns t]
17625 ["Insert Column View DBlock" org-insert-columns-dblock t])
17626 ("Dates and Scheduling"
17627 ["Timestamp" org-time-stamp t]
17628 ["Timestamp (inactive)" org-time-stamp-inactive t]
17629 ("Change Date"
17630 ["1 Day Later" org-shiftright t]
17631 ["1 Day Earlier" org-shiftleft t]
17632 ["1 ... Later" org-shiftup t]
17633 ["1 ... Earlier" org-shiftdown t])
17634 ["Compute Time Range" org-evaluate-time-range t]
17635 ["Schedule Item" org-schedule t]
17636 ["Deadline" org-deadline t]
17637 "--"
17638 ["Custom time format" org-toggle-time-stamp-overlays
17639 :style radio :selected org-display-custom-times]
17640 "--"
17641 ["Goto Calendar" org-goto-calendar t]
17642 ["Date from Calendar" org-date-from-calendar t]
17643 "--"
17644 ["Start/Restart Timer" org-timer-start t]
17645 ["Pause/Continue Timer" org-timer-pause-or-continue t]
17646 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
17647 ["Insert Timer String" org-timer t]
17648 ["Insert Timer Item" org-timer-item t])
17649 ("Logging work"
17650 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
17651 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
17652 ["Clock out" org-clock-out t]
17653 ["Clock cancel" org-clock-cancel t]
17654 "--"
17655 ["Mark as default task" org-clock-mark-default-task t]
17656 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
17657 ["Goto running clock" org-clock-goto t]
17658 "--"
17659 ["Display times" org-clock-display t]
17660 ["Create clock table" org-clock-report t]
17661 "--"
17662 ["Record DONE time"
17663 (progn (setq org-log-done (not org-log-done))
17664 (message "Switching to %s will %s record a timestamp"
17665 (car org-done-keywords)
17666 (if org-log-done "automatically" "not")))
17667 :style toggle :selected org-log-done])
17668 "--"
17669 ["Agenda Command..." org-agenda t]
17670 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
17671 ("File List for Agenda")
17672 ("Special views current file"
17673 ["TODO Tree" org-show-todo-tree t]
17674 ["Check Deadlines" org-check-deadlines t]
17675 ["Timeline" org-timeline t]
17676 ["Tags/Property tree" org-match-sparse-tree t])
17677 "--"
17678 ["Export/Publish..." org-export t]
17679 ("LaTeX"
17680 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
17681 :selected org-cdlatex-mode]
17682 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
17683 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
17684 ["Modify math symbol" org-cdlatex-math-modify
17685 (org-inside-LaTeX-fragment-p)]
17686 ["Insert citation" org-reftex-citation t]
17687 "--"
17688 ["Template for BEAMER" org-insert-beamer-options-template t])
17689 "--"
17690 ("MobileOrg"
17691 ["Push Files and Views" org-mobile-push t]
17692 ["Get Captured and Flagged" org-mobile-pull t]
17693 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
17694 "--"
17695 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
17696 "--"
17697 ("Documentation"
17698 ["Show Version" org-version t]
17699 ["Info Documentation" org-info t])
17700 ("Customize"
17701 ["Browse Org Group" org-customize t]
17702 "--"
17703 ["Expand This Menu" org-create-customize-menu
17704 (fboundp 'customize-menu-create)])
17705 ["Send bug report" org-submit-bug-report t]
17706 "--"
17707 ("Refresh/Reload"
17708 ["Refresh setup current buffer" org-mode-restart t]
17709 ["Reload Org (after update)" org-reload t]
17710 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
17711 ))
17713 (defun org-info (&optional node)
17714 "Read documentation for Org-mode in the info system.
17715 With optional NODE, go directly to that node."
17716 (interactive)
17717 (info (format "(org)%s" (or node ""))))
17719 ;;;###autoload
17720 (defun org-submit-bug-report ()
17721 "Submit a bug report on Org-mode via mail.
17723 Don't hesitate to report any problems or inaccurate documentation.
17725 If you don't have setup sending mail from (X)Emacs, please copy the
17726 output buffer into your mail program, as it gives us important
17727 information about your Org-mode version and configuration."
17728 (interactive)
17729 (require 'reporter)
17730 (org-load-modules-maybe)
17731 (org-require-autoloaded-modules)
17732 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
17733 (reporter-submit-bug-report
17734 "emacs-orgmode@gnu.org"
17735 (org-version)
17736 (let (list)
17737 (save-window-excursion
17738 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
17739 (delete-other-windows)
17740 (erase-buffer)
17741 (insert "You are about to submit a bug report to the Org-mode mailing list.
17743 We would like to add your full Org-mode and Outline configuration to the
17744 bug report. This greatly simplifies the work of the maintainer and
17745 other experts on the mailing list.
17747 HOWEVER, some variables you have customized may contain private
17748 information. The names of customers, colleagues, or friends, might
17749 appear in the form of file names, tags, todo states, or search strings.
17750 If you answer yes to the prompt, you might want to check and remove
17751 such private information before sending the email.")
17752 (add-text-properties (point-min) (point-max) '(face org-warning))
17753 (when (yes-or-no-p "Include your Org-mode configuration ")
17754 (mapatoms
17755 (lambda (v)
17756 (and (boundp v)
17758 (or (and (symbol-value v)
17760 (and
17761 (get v 'custom-type) (get v 'standard-value)
17762 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
17763 (push v list)))))
17764 (kill-buffer (get-buffer "*Warn about privacy*"))
17765 list))
17766 nil nil
17767 "Remember to cover the basics, that is, what you expected to happen and
17768 what in fact did happen. You don't know how to make a good report? See
17770 http://orgmode.org/manual/Feedback.html#Feedback
17772 Your bug report will be posted to the Org-mode mailing list.
17773 ------------------------------------------------------------------------")
17774 (save-excursion
17779 (defun org-install-agenda-files-menu ()
17780 (let ((bl (buffer-list)))
17781 (save-excursion
17782 (while bl
17783 (set-buffer (pop bl))
17784 (if (org-mode-p) (setq bl nil)))
17785 (when (org-mode-p)
17786 (easy-menu-change
17787 '("Org") "File List for Agenda"
17788 (append
17789 (list
17790 ["Edit File List" (org-edit-agenda-file-list) t]
17791 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
17792 ["Remove Current File from List" org-remove-file t]
17793 ["Cycle through agenda files" org-cycle-agenda-files t]
17794 ["Occur in all agenda files" org-occur-in-agenda-files t]
17795 "--")
17796 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
17798 ;;;; Documentation
17800 ;;;###autoload
17801 (defun org-require-autoloaded-modules ()
17802 (interactive)
17803 (mapc 'require
17804 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
17805 org-docbook org-exp org-html org-icalendar
17806 org-id org-latex
17807 org-publish org-remember org-table
17808 org-timer org-xoxo)))
17810 ;;;###autoload
17811 (defun org-reload (&optional uncompiled)
17812 "Reload all org lisp files.
17813 With prefix arg UNCOMPILED, load the uncompiled versions."
17814 (interactive "P")
17815 (require 'find-func)
17817 (dir-org (file-name-directory (org-find-library-name "org")))
17818 (dir-org-contrib (ignore-errors
17819 (file-name-directory
17820 (org-find-library-name "org-contribdir"))))
17821 (babel-files
17822 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
17823 (append (list nil "comint" "eval" "exp" "keys"
17824 "lob" "ref" "table" "tangle")
17825 (delq nil
17826 (mapcar
17827 (lambda (lang)
17828 (when (cdr lang) (symbol-name (car lang))))
17829 org-babel-load-languages)))))
17830 (files
17831 (append (directory-files dir-org t file-re)
17832 babel-files
17833 (and dir-org-contrib
17834 (directory-files dir-org-contrib t file-re))))
17835 (remove-re (concat (if (featurep 'xemacs)
17836 "org-colview" "org-colview-xemacs")
17838 (setq files (mapcar 'file-name-sans-extension files))
17839 (setq files (mapcar
17840 (lambda (x) (if (string-match remove-re x) nil x))
17841 files))
17842 (setq files (delq nil files))
17843 (mapc
17844 (lambda (f)
17845 (when (featurep (intern (file-name-nondirectory f)))
17846 (if (and (not uncompiled)
17847 (file-exists-p (concat f ".elc")))
17848 (load (concat f ".elc") nil nil t)
17849 (load (concat f ".el") nil nil t))))
17850 files))
17851 (org-version))
17853 ;;;###autoload
17854 (defun org-customize ()
17855 "Call the customize function with org as argument."
17856 (interactive)
17857 (org-load-modules-maybe)
17858 (org-require-autoloaded-modules)
17859 (customize-browse 'org))
17861 (defun org-create-customize-menu ()
17862 "Create a full customization menu for Org-mode, insert it into the menu."
17863 (interactive)
17864 (org-load-modules-maybe)
17865 (org-require-autoloaded-modules)
17866 (if (fboundp 'customize-menu-create)
17867 (progn
17868 (easy-menu-change
17869 '("Org") "Customize"
17870 `(["Browse Org group" org-customize t]
17871 "--"
17872 ,(customize-menu-create 'org)
17873 ["Set" Custom-set t]
17874 ["Save" Custom-save t]
17875 ["Reset to Current" Custom-reset-current t]
17876 ["Reset to Saved" Custom-reset-saved t]
17877 ["Reset to Standard Settings" Custom-reset-standard t]))
17879 (error "Cannot expand menu (outdated version of cus-edit.el)")))
17881 ;;;; Miscellaneous stuff
17883 ;;; Generally useful functions
17885 (defun org-get-at-bol (property)
17886 "Get text property PROPERTY at beginning of line."
17887 (get-text-property (point-at-bol) property))
17889 (defun org-find-text-property-in-string (prop s)
17890 "Return the first non-nil value of property PROP in string S."
17891 (or (get-text-property 0 prop s)
17892 (get-text-property (or (next-single-property-change 0 prop s) 0)
17893 prop s)))
17895 (defun org-display-warning (message) ;; Copied from Emacs-Muse
17896 "Display the given MESSAGE as a warning."
17897 (if (fboundp 'display-warning)
17898 (display-warning 'org message
17899 (if (featurep 'xemacs) 'warning :warning))
17900 (let ((buf (get-buffer-create "*Org warnings*")))
17901 (with-current-buffer buf
17902 (goto-char (point-max))
17903 (insert "Warning (Org): " message)
17904 (unless (bolp)
17905 (newline)))
17906 (display-buffer buf)
17907 (sit-for 0))))
17909 (defun org-in-commented-line ()
17910 "Is point in a line starting with `#'?"
17911 (equal (char-after (point-at-bol)) ?#))
17913 (defun org-in-indented-comment-line ()
17914 "Is point in a line starting with `#' after some white space?"
17915 (save-excursion
17916 (save-match-data
17917 (goto-char (point-at-bol))
17920 (defun org-in-verbatim-emphasis ()
17921 (save-match-data
17922 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
17924 (defun org-goto-marker-or-bmk (marker &optional bookmark)
17925 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
17926 (if (and marker (marker-buffer marker)
17927 (buffer-live-p (marker-buffer marker)))
17928 (progn
17929 (switch-to-buffer (marker-buffer marker))
17930 (if (or (> marker (point-max)) (< marker (point-min)))
17931 (widen))
17932 (goto-char marker)
17933 (org-show-context 'org-goto))
17934 (if bookmark
17935 (bookmark-jump bookmark)
17936 (error "Cannot find location"))))
17938 (defun org-quote-csv-field (s)
17939 "Quote field for inclusion in CSV material."
17942 s))
17944 (defun org-plist-delete (plist property)
17945 "Delete PROPERTY from PLIST.
17946 This is in contrast to merely setting it to 0."
17947 (let (p)
17948 (while plist
17949 (if (not (eq property (car plist)))
17950 (setq p (plist-put p (car plist) (nth 1 plist))))
17951 (setq plist (cddr plist)))
17952 p))
17954 (defun org-force-self-insert (N)
17955 "Needed to enforce self-insert under remapping."
17956 (interactive "p")
17957 (self-insert-command N))
17959 (defun org-string-width (s)
17960 "Compute width of string, ignoring invisible characters.
17961 This ignores character with invisibility property `org-link', and also
17962 characters with property `org-cwidth', because these will become invisible
17963 upon the next fontification round."
17964 (let (b l)
17965 (when (or (eq t buffer-invisibility-spec)
17966 (assq 'org-link buffer-invisibility-spec))
17967 (while (setq b (text-property-any 0 (length s)
17968 'invisible 'org-link s))
17969 (setq s (concat (substring s 0 b)
17970 (substring s (or (next-single-property-change
17971 b 'invisible s) (length s)))))))
17972 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
17973 (setq s (concat (substring s 0 b)
17974 (substring s (or (next-single-property-change
17975 b 'org-cwidth s) (length s))))))
17976 (setq l (string-width s) b -1)
17977 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
17978 (setq l (- l (get-text-property b 'org-dwidth-n s))))
17979 l))
17981 (defun org-shorten-string (s maxlength)
17982 "Shorten string S so tht it is no longer than MAXLENGTH characters.
17983 If the string is shorter or has length MAXLENGTH, just return the
17984 original string. If it is longer, the functions finds a space in the
17985 string, breaks this string off at that locations and adds three dots
17986 as ellipsis. Including the ellipsis, the string will not be longer
17987 than MAXLENGTH. If finding a good breaking point in the string does
17988 not work, the string is just chopped off in the middle of a word
17989 if necessary."
17990 (if (<= (length s) maxlength)
17991 s
17992 (let* ((n (max (- maxlength 4) 1))
17994 (if (string-match re s)
17995 (concat (match-string 1 s) "...")
17996 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
17998 (defun org-get-indentation (&optional line)
17999 "Get the indentation of the current line, interpreting tabs.
18000 When LINE is given, assume it represents a line and compute its indentation."
18001 (if line
18002 (if (string-match "^ *" (org-remove-tabs line))
18003 (match-end 0))
18004 (save-excursion
18005 (beginning-of-line 1)
18007 (current-column))))
18009 (defun org-remove-tabs (s &optional width)
18010 "Replace tabulators in S with spaces.
18011 Assumes that s is a single line, starting in column 0."
18012 (setq width (or width tab-width))
18014 (setq s (replace-match
18015 (make-string
18016 (- (* width (/ (+ (match-beginning 0) width) width))
18017 (match-beginning 0)) ?\ )
18018 t t s)))
18019 s)
18021 (defun org-fix-indentation (line ind)
18022 "Fix indentation in LINE.
18023 IND is a cons cell with target and minimum indentation.
18024 If the current indentation in LINE is smaller than the minimum,
18025 leave it alone. If it is larger than ind, set it to the target."
18026 (let* ((l (org-remove-tabs line))
18027 (i (org-get-indentation l))
18028 (i1 (car ind)) (i2 (cdr ind)))
18029 (if (>= i i2) (setq l (substring line i2)))
18030 (if (> i1 0)
18031 (concat (make-string i1 ?\ ) l)
18032 l)))
18034 (defun org-remove-indentation (code &optional n)
18035 "Remove the maximum common indentation from the lines in CODE.
18036 N may optionally be the number of spaces to remove."
18037 (with-temp-buffer
18038 (insert code)
18039 (org-do-remove-indentation n)
18040 (buffer-string)))
18042 (defun org-do-remove-indentation (&optional n)
18043 "Remove the maximum common indentation from the buffer."
18044 (untabify (point-min) (point-max))
18045 (let ((min 10000) re)
18046 (if n
18047 (setq min n)
18048 (goto-char (point-min))
18050 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18051 (unless (or (= min 0) (= min 10000))
18053 (goto-char (point-min))
18054 (while (re-search-forward re nil t)
18055 (replace-match "")
18056 (end-of-line 1))
18057 min)))
18059 (defun org-fill-template (template alist)
18060 "Find each %key of ALIST in TEMPLATE and replace it."
18061 (let ((case-fold-search nil)
18062 entry key value)
18063 (setq alist (sort (copy-sequence alist)
18064 (lambda (a b) (< (length (car a)) (length (car b))))))
18065 (while (setq entry (pop alist))
18066 (setq template
18067 (replace-regexp-in-string
18068 (concat "%" (regexp-quote (car entry)))
18069 (cdr entry) template t t)))
18070 template))
18072 (defun org-base-buffer (buffer)
18073 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18074 (if (not buffer)
18075 buffer
18076 (or (buffer-base-buffer buffer)
18077 buffer)))
18079 (defun org-trim (s)
18080 "Remove whitespace at beginning and end of string."
18083 s)
18085 (defun org-wrap (string &optional width lines)
18086 "Wrap string to either a number of lines, or a width in characters.
18087 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18088 that costs. If there is a word longer than WIDTH, the text is actually
18089 wrapped to the length of that word.
18090 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18091 many lines, whatever width that takes.
18092 The return value is a list of lines, without newlines at the end."
18094 (maxword (apply 'max (mapcar 'org-string-width words)))
18095 w ll)
18096 (cond (width
18097 (org-do-wrap words (max maxword width)))
18098 (lines
18099 (setq w maxword)
18100 (setq ll (org-do-wrap words maxword))
18101 (if (<= (length ll) lines)
18102 ll
18103 (setq ll words)
18104 (while (> (length ll) lines)
18105 (setq w (1+ w))
18106 (setq ll (org-do-wrap words w)))
18107 ll))
18108 (t (error "Cannot wrap this")))))
18110 (defun org-do-wrap (words width)
18111 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18112 (let (lines line)
18113 (while words
18114 (setq line (pop words))
18115 (while (and words (< (+ (length line) (length (car words))) width))
18116 (setq line (concat line " " (pop words))))
18117 (setq lines (push line lines)))
18118 (nreverse lines)))
18120 (defun org-split-string (string &optional separators)
18121 "Splits STRING into substrings at SEPARATORS.
18122 No empty strings are returned if there are matches at the beginning
18123 and end of string."
18125 (start 0)
18126 notfirst
18127 (list nil))
18128 (while (and (string-match rexp string
18129 (if (and notfirst
18130 (= start (match-beginning 0))
18131 (< start (length string)))
18132 (1+ start) start))
18133 (< (match-beginning 0) (length string)))
18134 (setq notfirst t)
18135 (or (eq (match-beginning 0) 0)
18136 (and (eq (match-beginning 0) (match-end 0))
18137 (eq (match-beginning 0) start))
18138 (setq list
18139 (cons (substring string start (match-beginning 0))
18140 list)))
18141 (setq start (match-end 0)))
18142 (or (eq start (length string))
18143 (setq list
18144 (cons (substring string start)
18145 list)))
18146 (nreverse list)))
18148 (defun org-quote-vert (s)
18150 (while (string-match "|" s)
18152 s)
18154 (defun org-uuidgen-p (s)
18155 "Is S an ID created by UUIDGEN?"
18156 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18158 (defun org-context ()
18159 "Return a list of contexts of the current cursor position.
18160 If several contexts apply, all are returned.
18161 Each context entry is a list with a symbol naming the context, and
18162 two positions indicating start and end of the context. Possible
18163 contexts are:
18165 :headline anywhere in a headline
18166 :headline-stars on the leading stars in a headline
18167 :todo-keyword on a TODO keyword (including DONE) in a headline
18168 :tags on the TAGS in a headline
18169 :priority on the priority cookie in a headline
18170 :item on the first line of a plain list item
18171 :item-bullet on the bullet/number of a plain list item
18172 :checkbox on the checkbox in a plain list item
18173 :table in an org-mode table
18174 :table-special on a special filed in a table
18175 :table-table in a table.el table
18176 :link on a hyperlink
18177 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18178 :target on a <<target>>
18179 :radio-target on a <<<radio-target>>>
18180 :latex-fragment on a LaTeX fragment
18181 :latex-preview on a LaTeX fragment with overlayed preview image
18183 This function expects the position to be visible because it uses font-lock
18184 faces as a help to recognize the following contexts: :table-special, :link,
18185 and :keyword."
18186 (let* ((f (get-text-property (point) 'face))
18187 (faces (if (listp f) f (list f)))
18188 (p (point)) clist o)
18189 ;; First the large context
18190 (cond
18191 ((org-on-heading-p t)
18192 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18193 (when (progn
18194 (beginning-of-line 1)
18195 (looking-at org-todo-line-tags-regexp))
18196 (push (org-point-in-group p 1 :headline-stars) clist)
18197 (push (org-point-in-group p 2 :todo-keyword) clist)
18198 (push (org-point-in-group p 4 :tags) clist))
18199 (goto-char p)
18202 (push (org-point-in-group p 0 :priority) clist)))
18204 ((org-at-item-p)
18205 (push (org-point-in-group p 2 :item-bullet) clist)
18206 (push (list :item (point-at-bol)
18207 (save-excursion (org-end-of-item) (point)))
18208 clist)
18209 (and (org-at-item-checkbox-p)
18210 (push (org-point-in-group p 0 :checkbox) clist)))
18212 ((org-at-table-p)
18213 (push (list :table (org-table-begin) (org-table-end)) clist)
18214 (if (memq 'org-formula faces)
18215 (push (list :table-special
18216 (previous-single-property-change p 'face)
18217 (next-single-property-change p 'face)) clist)))
18218 ((org-at-table-p 'any)
18219 (push (list :table-table) clist)))
18220 (goto-char p)
18222 ;; Now the small context
18223 (cond
18224 ((org-at-timestamp-p)
18225 (push (org-point-in-group p 0 :timestamp) clist))
18226 ((memq 'org-link faces)
18227 (push (list :link
18228 (previous-single-property-change p 'face)
18229 (next-single-property-change p 'face)) clist))
18230 ((memq 'org-special-keyword faces)
18231 (push (list :keyword
18232 (previous-single-property-change p 'face)
18233 (next-single-property-change p 'face)) clist))
18234 ((org-on-target-p)
18235 (push (org-point-in-group p 0 :target) clist)
18236 (goto-char (1- (match-beginning 0)))
18237 (if (looking-at org-radio-target-regexp)
18238 (push (org-point-in-group p 0 :radio-target) clist))
18239 (goto-char p))
18240 ((setq o (car (delq nil
18241 (mapcar
18242 (lambda (x)
18243 (if (memq x org-latex-fragment-image-overlays) x))
18244 (overlays-at (point))))))
18245 (push (list :latex-fragment
18246 (overlay-start o) (overlay-end o)) clist)
18247 (push (list :latex-preview
18248 (overlay-start o) (overlay-end o)) clist))
18249 ((org-inside-LaTeX-fragment-p)
18250 ;; FIXME: positions wrong.
18251 (push (list :latex-fragment (point) (point)) clist)))
18253 (setq clist (nreverse (delq nil clist)))
18254 clist))
18256 ;; FIXME: Compare with at-regexp-p Do we need both?
18257 (defun org-in-regexp (re &optional nlines visually)
18258 "Check if point is inside a match of regexp.
18259 Normally only the current line is checked, but you can include NLINES extra
18260 lines both before and after point into the search.
18261 If VISUALLY is set, require that the cursor is not after the match but
18262 really on, so that the block visually is on the match."
18263 (catch 'exit
18264 (let ((pos (point))
18265 (eol (point-at-eol (+ 1 (or nlines 0))))
18266 (inc (if visually 1 0)))
18267 (save-excursion
18268 (beginning-of-line (- 1 (or nlines 0)))
18269 (while (re-search-forward re eol t)
18270 (if (and (<= (match-beginning 0) pos)
18271 (>= (+ inc (match-end 0)) pos))
18272 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18274 (defun org-at-regexp-p (regexp)
18275 "Is point inside a match of REGEXP in the current line?"
18276 (catch 'exit
18277 (save-excursion
18278 (let ((pos (point)) (end (point-at-eol)))
18279 (beginning-of-line 1)
18280 (while (re-search-forward regexp end t)
18281 (if (and (<= (match-beginning 0) pos)
18282 (>= (match-end 0) pos))
18283 (throw 'exit t)))
18284 nil))))
18286 (defun org-in-regexps-block-p (start-re end-re &optional bound)
18287 "Return t if the current point is between matches of START-RE and END-RE.
18288 This will also return t if point is on one of the two matches or
18289 in an unfinished block. END-RE can be a string or a form
18290 returning a string.
18292 An optional third argument bounds the search for START-RE. It
18293 defaults to previous heading or `point-min'."
18294 (let ((pos (point))
18295 (limit (or bound (save-excursion (outline-previous-heading)))))
18296 (save-excursion
18297 ;; we're on a block when point is on start-re...
18298 (or (org-at-regexp-p start-re)
18299 ;; ... or start-re can be found above...
18300 (and (re-search-backward start-re limit t)
18301 ;; ... but no end-re between start-re and point.
18302 (not (re-search-forward (eval end-re) pos t)))))))
18304 (defun org-occur-in-agenda-files (regexp &optional nlines)
18305 "Call `multi-occur' with buffers for all agenda files."
18307 (let* ((files (org-agenda-files))
18308 (tnames (mapcar 'file-truename files))
18309 (extra org-agenda-text-search-extra-files)
18310 f)
18311 (when (eq (car extra) 'agenda-archives)
18312 (setq extra (cdr extra))
18313 (setq files (org-add-archive-files files)))
18314 (while (setq f (pop extra))
18315 (unless (member (file-truename f) tnames)
18316 (add-to-list 'files f 'append)
18317 (add-to-list 'tnames (file-truename f) 'append)))
18318 (multi-occur
18319 (mapcar (lambda (x)
18320 (with-current-buffer
18321 (or (get-file-buffer x) (find-file-noselect x))
18322 (widen)
18323 (current-buffer)))
18324 files)
18325 regexp)))
18327 (if (boundp 'occur-mode-find-occurrence-hook)
18328 ;; Emacs 23
18329 (add-hook 'occur-mode-find-occurrence-hook
18330 (lambda ()
18331 (when (org-mode-p)
18332 (org-reveal))))
18333 ;; Emacs 22
18334 (defadvice occur-mode-goto-occurrence
18335 (after org-occur-reveal activate)
18336 (and (org-mode-p) (org-reveal)))
18337 (defadvice occur-mode-goto-occurrence-other-window
18338 (after org-occur-reveal activate)
18339 (and (org-mode-p) (org-reveal)))
18340 (defadvice occur-mode-display-occurrence
18341 (after org-occur-reveal activate)
18342 (when (org-mode-p)
18343 (let ((pos (occur-mode-find-occurrence)))
18344 (with-current-buffer (marker-buffer pos)
18345 (save-excursion
18346 (goto-char pos)
18347 (org-reveal)))))))
18349 (defun org-occur-link-in-agenda-files ()
18350 "Create a link and search for it in the agendas.
18351 The link is not stored in `org-stored-links', it is just created
18352 for the search purpose."
18353 (interactive)
18354 (let ((link (condition-case nil
18355 (org-store-link nil)
18356 (error "Unable to create a link to here"))))
18357 (org-occur-in-agenda-files (regexp-quote link))))
18359 (defun org-uniquify (list)
18360 "Remove duplicate elements from LIST."
18361 (let (res)
18362 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
18363 res))
18365 (defun org-delete-all (elts list)
18366 "Remove all elements in ELTS from LIST."
18367 (while elts
18368 (setq list (delete (pop elts) list)))
18369 list)
18371 (defun org-count (cl-item cl-seq)
18372 "Count the number of occurrences of ITEM in SEQ.
18373 Taken from `count' in cl-seq.el with all keyword arguments removed."
18374 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
18375 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
18376 (while (< cl-start cl-end)
18377 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
18378 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
18379 (setq cl-start (1+ cl-start)))
18380 cl-count))
18382 (defun org-remove-if (predicate seq)
18383 "Remove everything from SEQ that fulfills PREDICATE."
18384 (let (res e)
18385 (while seq
18386 (setq e (pop seq))
18387 (if (not (funcall predicate e)) (push e res)))
18388 (nreverse res)))
18390 (defun org-remove-if-not (predicate seq)
18391 "Remove everything from SEQ that does not fulfill PREDICATE."
18392 (let (res e)
18393 (while seq
18394 (setq e (pop seq))
18395 (if (funcall predicate e) (push e res)))
18396 (nreverse res)))
18398 (defun org-back-over-empty-lines ()
18399 "Move backwards over whitespace, to the beginning of the first empty line.
18400 Returns the number of empty lines passed."
18401 (let ((pos (point)))
18403 (beginning-of-line 2)
18404 (goto-char (min (point) pos))
18405 (count-lines (point) pos)))
18407 (defun org-skip-whitespace ()
18410 (defun org-point-in-group (point group &optional context)
18411 "Check if POINT is in match-group GROUP.
18412 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18413 match. If the match group does not exist or point is not inside it,
18414 return nil."
18415 (and (match-beginning group)
18416 (>= point (match-beginning group))
18417 (<= point (match-end group))
18418 (if context
18419 (list context (match-beginning group) (match-end group))
18420 t)))
18422 (defun org-switch-to-buffer-other-window (&rest args)
18423 "Switch to buffer in a second window on the current frame.
18424 In particular, do not allow pop-up frames.
18425 Returns the newly created buffer."
18426 (let (pop-up-frames special-display-buffer-names special-display-regexps
18427 special-display-function)
18428 (apply 'switch-to-buffer-other-window args)))
18430 (defun org-combine-plists (&rest plists)
18431 "Create a single property list from all plists in PLISTS.
18432 The process starts by copying the first list, and then setting properties
18433 from the other lists. Settings in the last list are the most significant
18434 ones and overrule settings in the other lists."
18435 (let ((rtn (copy-sequence (pop plists)))
18436 p v ls)
18437 (while plists
18438 (setq ls (pop plists))
18439 (while ls
18440 (setq p (pop ls) v (pop ls))
18441 (setq rtn (plist-put rtn p v))))
18442 rtn))
18444 (defun org-move-line-down (arg)
18445 "Move the current line down. With prefix argument, move it past ARG lines."
18446 (interactive "p")
18447 (let ((col (current-column))
18448 beg end pos)
18449 (beginning-of-line 1) (setq beg (point))
18450 (beginning-of-line 2) (setq end (point))
18451 (beginning-of-line (+ 1 arg))
18452 (setq pos (move-marker (make-marker) (point)))
18453 (insert (delete-and-extract-region beg end))
18454 (goto-char pos)
18455 (org-move-to-column col)))
18457 (defun org-move-line-up (arg)
18458 "Move the current line up. With prefix argument, move it past ARG lines."
18459 (interactive "p")
18460 (let ((col (current-column))
18461 beg end pos)
18462 (beginning-of-line 1) (setq beg (point))
18463 (beginning-of-line 2) (setq end (point))
18464 (beginning-of-line (- arg))
18465 (setq pos (move-marker (make-marker) (point)))
18466 (insert (delete-and-extract-region beg end))
18467 (goto-char pos)
18468 (org-move-to-column col)))
18470 (defun org-replace-escapes (string table)
18471 "Replace %-escapes in STRING with values in TABLE.
18473 The sequences in STRING may contain normal field width and padding information,
18475 so values can contain further %-escapes if they are define later in TABLE."
18476 (let ((tbl (copy-alist table))
18477 (case-fold-search nil)
18478 (pchg 0)
18479 e re rpl)
18480 (while (setq e (pop tbl))
18481 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
18482 (when (and (cdr e) (string-match re (cdr e)))
18483 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
18484 (safe "SREF"))
18485 (add-text-properties 0 3 (list 'sref sref) safe)
18486 (setcdr e (replace-match safe t t (cdr e)))))
18487 (while (string-match re string)
18488 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
18489 (cdr e)))
18490 (setq string (replace-match rpl t t string))))
18491 (while (setq pchg (next-property-change pchg string))
18492 (let ((sref (get-text-property pchg 'sref string)))
18493 (when (and sref (string-match "SREF" string pchg))
18494 (setq string (replace-match sref t t string)))))
18495 string))
18497 (defun org-sublist (list start end)
18498 "Return a section of LIST, from START to END.
18499 Counting starts at 1."
18500 (let (rtn (c start))
18501 (setq list (nthcdr (1- start) list))
18502 (while (and list (<= c end))
18503 (push (pop list) rtn)
18504 (setq c (1+ c)))
18505 (nreverse rtn)))
18507 (defun org-find-base-buffer-visiting (file)
18508 "Like `find-buffer-visiting' but always return the base buffer and
18509 not an indirect buffer."
18510 (let ((buf (or (get-file-buffer file)
18511 (find-buffer-visiting file))))
18512 (if buf
18513 (or (buffer-base-buffer buf) buf)
18514 nil)))
18516 (defun org-image-file-name-regexp (&optional extensions)
18517 "Return regexp matching the file names of images.
18518 If EXTENSIONS is given, only match these."
18519 (if (and (not extensions) (fboundp 'image-file-name-regexp))
18520 (image-file-name-regexp)
18521 (let ((image-file-name-extensions
18522 (or extensions
18523 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
18524 "xbm" "xpm" "pbm" "pgm" "ppm"))))
18526 (regexp-opt (nconc (mapcar 'upcase
18527 image-file-name-extensions)
18528 image-file-name-extensions)
18529 t)
18532 (defun org-file-image-p (file &optional extensions)
18533 "Return non-nil if FILE is an image."
18534 (save-match-data
18535 (string-match (org-image-file-name-regexp extensions) file)))
18537 (defun org-get-cursor-date ()
18538 "Return the date at cursor in as a time.
18539 This works in the calendar and in the agenda, anywhere else it just
18540 returns the current time."
18541 (let (date day defd)
18542 (cond
18543 ((eq major-mode 'calendar-mode)
18544 (setq date (calendar-cursor-to-date)
18545 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
18546 ((eq major-mode 'org-agenda-mode)
18547 (setq day (get-text-property (point) 'day))
18548 (if day
18549 (setq date (calendar-gregorian-from-absolute day)
18550 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
18551 (nth 2 date))))))
18552 (or defd (current-time))))
18554 (defvar org-agenda-action-marker (make-marker)
18555 "Marker pointing to the entry for the next agenda action.")
18557 (defun org-mark-entry-for-agenda-action ()
18558 "Mark the current entry as target of an agenda action.
18559 Agenda actions are actions executed from the agenda with the key `k',
18560 which make use of the date at the cursor."
18561 (interactive)
18562 (move-marker org-agenda-action-marker
18563 (save-excursion (org-back-to-heading t) (point))
18564 (current-buffer))
18565 (message
18566 "Entry marked for action; press `k' at desired date in agenda or calendar"))
18568 ;;; Paragraph filling stuff.
18569 ;; We want this to be just right, so use the full arsenal.
18571 (defun org-indent-line-function ()
18572 "Indent line depending on context."
18573 (interactive)
18574 (let* ((pos (point))
18575 (itemp (org-at-item-p))
18576 (case-fold-search t)
18578 (inline-task-p (and (featurep 'org-inlinetask)
18579 (org-inlinetask-in-task-p)))
18580 column bpos bcol tpos tcol)
18581 (beginning-of-line 1)
18582 (cond
18583 ;; Comments
18584 ((looking-at "# ") (setq column 0))
18585 ;; Headings
18587 ;; Literal examples
18589 (setq column (org-get-indentation))) ; do nothing
18590 ;; Drawers
18592 (save-excursion (re-search-backward org-drawer-regexp nil t)))
18593 (save-excursion
18594 (goto-char (1- (match-beginning 1)))
18595 (setq column (current-column))))
18596 ;; Special blocks
18598 (save-excursion
18599 (re-search-backward
18601 (setq column (org-get-indentation (match-string 0))))
18604 (save-excursion
18606 (setq column
18607 (if (equal (downcase (match-string 1)) "src")
18608 ;; src blocks: let `org-edit-src-exit' handle them
18609 (org-get-indentation)
18610 (org-get-indentation (match-string 0)))))
18611 ;; Lists
18612 ((org-in-item-p)
18613 (org-beginning-of-item)
18614 (looking-at "[ \t]*\\(\\S-+\\)[ \t]*\\(\\(:?\\[@\\(:?start:\\)?[0-9]+\\][ \t]*\\)?\\[[- X]\\][ \t]*\\|.*? :: \\)?")
18615 (setq bpos (match-beginning 1) tpos (match-end 0)
18616 bcol (progn (goto-char bpos) (current-column))
18617 tcol (progn (goto-char tpos) (current-column)))
18618 (if (> tcol (+ bcol org-description-max-indent))
18619 (setq tcol (+ bcol 5)))
18620 (goto-char pos)
18621 (setq column (if itemp (org-get-indentation) tcol)))
18622 ;; This line has nothing special, look at the previous relevant
18623 ;; line to compute indentation
18624 (t
18625 (beginning-of-line 0)
18626 (while (and (not (bobp))
18627 (not (looking-at org-drawer-regexp))
18628 ;; skip comments, verbatim, empty lines, tables,
18629 ;; inline tasks, lists, drawers and blocks
18631 (re-search-backward org-drawer-regexp nil t))
18635 (and (org-in-item-p) (goto-char (org-list-top-point)))
18636 (and (not inline-task-p)
18637 (featurep 'org-inlinetask)
18638 (org-inlinetask-in-task-p))))
18639 (beginning-of-line 0))
18640 (cond
18641 ;; There was an heading above.
18643 (if (not org-adapt-indentation)
18644 (setq column 0)
18645 (goto-char (match-end 0))
18646 (setq column (current-column))))
18647 ;; A drawer had started and is unfinished
18648 ((looking-at org-drawer-regexp)
18649 (goto-char (1- (match-beginning 1)))
18650 (setq column (current-column)))
18651 ;; Else, nothing noticeable found: get indentation and go on.
18652 (t (setq column (org-get-indentation))))))
18653 ;; Now apply indentation and move cursor accordingly
18654 (goto-char pos)
18655 (if (<= (current-column) (current-indentation))
18656 (org-indent-line-to column)
18657 (save-excursion (org-indent-line-to column)))
18658 ;; Special polishing for properties, see `org-property-format'
18659 (setq column (current-column))
18660 (beginning-of-line 1)
18661 (if (looking-at
18663 (replace-match (concat (match-string 1)
18664 (format org-property-format
18665 (match-string 2) (match-string 3)))
18666 t t))
18667 (org-move-to-column column)))
18669 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
18670 "Variable to store copy of `adaptive-fill-regexp'.
18671 Since `adaptive-fill-regexp' is set to never match, we need to
18672 store a backup of its value before entering `org-mode' so that
18673 the functionality can be provided as a fall-back.")
18675 (defun org-set-autofill-regexps ()
18676 (interactive)
18677 ;; In the paragraph separator we include headlines, because filling
18678 ;; text in a line directly attached to a headline would otherwise
18679 ;; fill the headline as well.
18682 ;; The paragraph starter includes hand-formatted lists.
18683 (org-set-local
18684 'paragraph-start
18685 (concat
18694 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
18695 ;; But only if the user has not turned off tables or fixed-width regions
18696 (org-set-local
18697 'auto-fill-inhibit-regexp
18700 (if (or org-enable-table-editor org-enable-fixed-width-editor)
18701 (concat
18703 (if org-enable-table-editor "|" "")
18704 (if org-enable-fixed-width-editor ":" "")
18705 "]"))))
18706 ;; We use our own fill-paragraph function, to make sure that tables
18707 ;; and fixed-width regions are not wrapped. That function will pass
18708 ;; through to `fill-paragraph' when appropriate.
18709 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
18710 ;; Adaptive filling: To get full control, first make sure that
18711 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
18712 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
18713 (org-set-local 'org-adaptive-fill-regexp-backup
18714 adaptive-fill-regexp))
18716 (org-set-local 'adaptive-fill-function
18717 'org-adaptive-fill-function)
18718 (org-set-local
18719 'align-mode-rules-list
18720 '((org-in-buffer-settings
18722 (modes . '(org-mode))))))
18724 (defun org-fill-paragraph (&optional justify)
18725 "Re-align a table, pass through to fill-paragraph if no table."
18726 (let ((table-p (org-at-table-p))
18727 (table.el-p (org-at-table.el-p)))
18728 (cond ((and (equal (char-after (point-at-bol)) ?*)
18729 (save-excursion (goto-char (point-at-bol))
18730 (looking-at outline-regexp)))
18731 t) ; skip headlines
18732 (table.el-p t) ; skip table.el tables
18733 (table-p (org-table-align) t) ; align org-mode tables
18734 (t nil)))) ; call paragraph-fill
18736 ;; For reference, this is the default value of adaptive-fill-regexp
18739 (defun org-adaptive-fill-function ()
18740 "Return a fill prefix for org-mode files.
18741 In particular, this makes sure hanging paragraphs for hand-formatted lists
18742 work correctly."
18743 (cond
18744 ;; Comment line
18746 (match-string-no-properties 0))
18747 ;; Description list
18749 (save-excursion
18750 (if (> (match-end 1) (+ (match-beginning 1)
18751 org-description-max-indent))
18752 (goto-char (+ (match-beginning 1) 5))
18753 (goto-char (match-end 0)))
18754 (make-string (current-column) ?\ )))
18755 ;; Ordered or unordered list
18757 (save-excursion
18758 (goto-char (match-end 0))
18759 (make-string (current-column) ?\ )))
18760 ;; Other text
18761 ((looking-at org-adaptive-fill-regexp-backup)
18762 (match-string-no-properties 0))))
18764 ;;; Other stuff.
18766 (defun org-toggle-fixed-width-section (arg)
18767 "Toggle the fixed-width export.
18768 If there is no active region, the QUOTE keyword at the current headline is
18769 inserted or removed. When present, it causes the text between this headline
18770 and the next to be exported as fixed-width text, and unmodified.
18771 If there is an active region, this command adds or removes a colon as the
18772 first character of this line. If the first character of a line is a colon,
18773 this line is also exported in fixed-width font."
18774 (interactive "P")
18775 (let* ((cc 0)
18776 (regionp (org-region-active-p))
18777 (beg (if regionp (region-beginning) (point)))
18778 (end (if regionp (region-end)))
18779 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
18780 (case-fold-search nil)
18782 off)
18783 (if regionp
18784 (save-excursion
18785 (goto-char beg)
18786 (setq cc (current-column))
18787 (beginning-of-line 1)
18788 (setq off (looking-at re))
18789 (while (> nlines 0)
18790 (setq nlines (1- nlines))
18791 (beginning-of-line 1)
18792 (cond
18793 (arg
18794 (org-move-to-column cc t)
18796 (forward-line -1))
18797 ((and off (looking-at re))
18798 (replace-match "" t t nil 1))
18799 ((not off) (org-move-to-column cc t) (insert ": ")))
18800 (forward-line 1)))
18801 (save-excursion
18802 (org-back-to-heading)
18803 (if (looking-at (concat outline-regexp
18805 (replace-match "" t t nil 1)
18806 (if (looking-at outline-regexp)
18807 (progn
18808 (goto-char (match-end 0))
18809 (insert org-quote-string " "))))))))
18811 (defun org-reftex-citation ()
18812 "Use reftex-citation to insert a citation into the buffer.
18813 This looks for a line like
18815 #+BIBLIOGRAPHY: foo plain option:-d
18817 and derives from it that foo.bib is the bibliography file relevant
18818 for this document. It then installs the necessary environment for RefTeX
18819 to work in this buffer and calls `reftex-citation' to insert a citation
18820 into the buffer.
18822 Export of such citations to both LaTeX and HTML is handled by the contributed
18823 package org-exp-bibtex by Taru Karttunen."
18824 (interactive)
18825 (let ((reftex-docstruct-symbol 'rds)
18827 rds bib)
18828 (save-excursion
18829 (save-restriction
18830 (widen)
18831 (let ((case-fold-search t)
18833 (if (not (save-excursion
18834 (or (re-search-forward re nil t)
18835 (re-search-backward re nil t))))
18836 (error "No bibliography defined in file")
18837 (setq bib (concat (match-string 1) ".bib")
18838 rds (list (list 'bib bib)))))))
18839 (call-interactively 'reftex-citation)))
18841 ;;;; Functions extending outline functionality
18843 (defun org-beginning-of-line (&optional arg)
18844 "Go to the beginning of the current line. If that is invisible, continue
18845 to a visible line beginning. This makes the function of C-a more intuitive.
18846 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18847 first attempt, and only move to after the tags when the cursor is already
18848 beyond the end of the headline."
18849 (interactive "P")
18850 (let ((pos (point))
18851 (special (if (consp org-special-ctrl-a/e)
18852 (car org-special-ctrl-a/e)
18853 org-special-ctrl-a/e))
18854 refpos)
18855 (if (org-bound-and-true-p line-move-visual)
18856 (beginning-of-visual-line 1)
18857 (beginning-of-line 1))
18858 (if (and arg (fboundp 'move-beginning-of-line))
18859 (call-interactively 'move-beginning-of-line)
18860 (if (bobp)
18861 nil
18862 (backward-char 1)
18863 (if (org-truely-invisible-p)
18864 (while (and (not (bobp)) (org-truely-invisible-p))
18865 (backward-char 1)
18866 (beginning-of-line 1))
18867 (forward-char 1))))
18868 (when special
18869 (cond
18870 ((and (looking-at org-complex-heading-regexp)
18871 (= (char-after (match-end 1)) ?\ ))
18872 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
18873 (point-at-eol)))
18874 (goto-char
18875 (if (eq special t)
18876 (cond ((> pos refpos) refpos)
18877 ((= pos (point)) refpos)
18878 (t (point)))
18879 (cond ((> pos (point)) (point))
18880 ((not (eq last-command this-command)) (point))
18881 (t refpos)))))
18882 ((org-at-item-p)
18883 (goto-char
18884 (if (eq special t)
18885 (cond ((> pos (match-end 4)) (match-end 4))
18886 ((= pos (point)) (match-end 4))
18887 (t (point)))
18888 (cond ((> pos (point)) (point))
18889 ((not (eq last-command this-command)) (point))
18890 (t (match-end 4))))))))
18891 (org-no-warnings
18892 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18894 (defun org-end-of-line (&optional arg)
18895 "Go to the end of the line.
18896 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18897 first attempt, and only move to after the tags when the cursor is already
18898 beyond the end of the headline."
18899 (interactive "P")
18900 (let ((special (if (consp org-special-ctrl-a/e)
18901 (cdr org-special-ctrl-a/e)
18902 org-special-ctrl-a/e)))
18903 (if (or (not special)
18904 (not (org-on-heading-p))
18905 arg)
18906 (call-interactively
18907 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
18908 ((fboundp 'move-end-of-line) 'move-end-of-line)
18909 (t 'end-of-line)))
18910 (let ((pos (point)))
18911 (beginning-of-line 1)
18913 (if (eq special t)
18914 (if (or (< pos (match-beginning 1))
18915 (= pos (match-end 0)))
18916 (goto-char (match-beginning 1))
18917 (goto-char (match-end 0)))
18918 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
18919 (goto-char (match-end 0))
18920 (goto-char (match-beginning 1))))
18921 (call-interactively (if (fboundp 'move-end-of-line)
18922 'move-end-of-line
18923 'end-of-line)))))
18924 (org-no-warnings
18925 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18927 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
18928 (define-key org-mode-map "\C-e" 'org-end-of-line)
18930 (defun org-backward-sentence (&optional arg)
18931 "Go to beginning of sentence, or beginning of table field.
18932 This will call `backward-sentence' or `org-table-beginning-of-field',
18933 depending on context."
18934 (interactive "P")
18935 (cond
18936 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
18937 (t (call-interactively 'backward-sentence))))
18939 (defun org-forward-sentence (&optional arg)
18940 "Go to end of sentence, or end of table field.
18941 This will call `forward-sentence' or `org-table-end-of-field',
18942 depending on context."
18943 (interactive "P")
18944 (cond
18945 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
18946 (t (call-interactively 'forward-sentence))))
18948 (define-key org-mode-map "\M-a" 'org-backward-sentence)
18949 (define-key org-mode-map "\M-e" 'org-forward-sentence)
18951 (defun org-kill-line (&optional arg)
18952 "Kill line, to tags or end of line."
18953 (interactive "P")
18954 (cond
18955 ((or (not org-special-ctrl-k)
18956 (bolp)
18957 (not (org-on-heading-p)))
18958 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
18959 org-ctrl-k-protect-subtree)
18960 (if (or (eq org-ctrl-k-protect-subtree 'error)
18961 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
18962 (error "C-k aborted - would kill hidden subtree")))
18963 (call-interactively 'kill-line))
18965 (kill-region (point) (match-beginning 1))
18966 (org-set-tags nil t))
18967 (t (kill-region (point) (point-at-eol)))))
18969 (define-key org-mode-map "\C-k" 'org-kill-line)
18971 (defun org-yank (&optional arg)
18972 "Yank. If the kill is a subtree, treat it specially.
18973 This command will look at the current kill and check if is a single
18974 subtree, or a series of subtrees[1]. If it passes the test, and if the
18975 cursor is at the beginning of a line or after the stars of a currently
18976 empty headline, then the yank is handled specially. How exactly depends
18977 on the value of the following variables, both set by default.
18979 org-yank-folded-subtrees
18980 When set, the subtree(s) will be folded after insertion, but only
18981 if doing so would now swallow text after the yanked text.
18983 org-yank-adjusted-subtrees
18984 When set, the subtree will be promoted or demoted in order to
18985 fit into the local outline tree structure, which means that the level
18986 will be adjusted so that it becomes the smaller one of the two
18987 *visible* surrounding headings.
18989 Any prefix to this command will cause `yank' to be called directly with
18991 will just
18992 plainly yank the text as it is.
18994 \[1] The test checks if the first non-white line is a heading
18995 and if there are no other headings with fewer stars."
18996 (interactive "P")
18997 (org-yank-generic 'yank arg))
18999 (defun org-yank-generic (command arg)
19000 "Perform some yank-like command.
19002 This function implements the behavior described in the `org-yank'
19003 documentation. However, it has been generalized to work for any
19004 interactive command with similar behavior."
19006 ;; pretend to be command COMMAND
19007 (setq this-command command)
19009 (if arg
19010 (call-interactively command)
19012 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19013 (and (org-kill-is-subtree-p)
19014 (or (bolp)
19016 (string-match
19018 (buffer-substring (point-at-bol) (point)))))))
19019 swallowp)
19020 (cond
19021 ((and subtreep org-yank-folded-subtrees)
19022 (let ((beg (point))
19023 end)
19024 (if (and subtreep org-yank-adjusted-subtrees)
19025 (org-paste-subtree nil nil 'for-yank)
19026 (call-interactively command))
19028 (setq end (point))
19029 (goto-char beg)
19030 (when (and (bolp) subtreep
19031 (not (setq swallowp
19032 (org-yank-folding-would-swallow-text beg end))))
19033 (or (looking-at outline-regexp)
19034 (re-search-forward (concat "^" outline-regexp) end t))
19035 (while (and (< (point) end) (looking-at outline-regexp))
19036 (hide-subtree)
19037 (org-cycle-show-empty-lines 'folded)
19038 (condition-case nil
19039 (outline-forward-same-level 1)
19040 (error (goto-char end)))))
19041 (when swallowp
19042 (message
19043 "Inserted text not folded because that would swallow text"))
19045 (goto-char end)
19047 (beginning-of-line 1)
19048 (push-mark beg 'nomsg)))
19049 ((and subtreep org-yank-adjusted-subtrees)
19050 (let ((beg (point-at-bol)))
19051 (org-paste-subtree nil nil 'for-yank)
19052 (push-mark beg 'nomsg)))
19053 (t
19054 (call-interactively command))))))
19056 (defun org-yank-folding-would-swallow-text (beg end)
19057 "Would hide-subtree at BEG swallow any text after END?"
19058 (let (level)
19059 (save-excursion
19060 (goto-char beg)
19061 (when (or (looking-at outline-regexp)
19062 (re-search-forward (concat "^" outline-regexp) end t))
19063 (setq level (org-outline-level)))
19064 (goto-char end)
19066 (if (or (eobp)
19067 (and (bolp) (looking-at org-outline-regexp)
19068 (<= (org-outline-level) level)))
19069 nil ; Nothing would be swallowed
19070 t)))) ; something would swallow
19072 (define-key org-mode-map "\C-y" 'org-yank)
19074 (defun org-invisible-p ()
19075 "Check if point is at a character currently not visible."
19076 ;; Early versions of noutline don't have `outline-invisible-p'.
19077 (if (fboundp 'outline-invisible-p)
19078 (outline-invisible-p)
19079 (get-char-property (point) 'invisible)))
19081 (defun org-truely-invisible-p ()
19082 "Check if point is at a character currently not visible.
19083 This version does not only check the character property, but also
19084 `visible-mode'."
19085 ;; Early versions of noutline don't have `outline-invisible-p'.
19086 (if (org-bound-and-true-p visible-mode)
19087 nil
19088 (if (fboundp 'outline-invisible-p)
19089 (outline-invisible-p)
19090 (get-char-property (point) 'invisible))))
19092 (defun org-invisible-p2 ()
19093 "Check if point is at a character currently not visible."
19094 (save-excursion
19095 (if (and (eolp) (not (bobp))) (backward-char 1))
19096 ;; Early versions of noutline don't have `outline-invisible-p'.
19097 (if (fboundp 'outline-invisible-p)
19098 (outline-invisible-p)
19099 (get-char-property (point) 'invisible))))
19101 (defun org-back-to-heading (&optional invisible-ok)
19102 "Call `outline-back-to-heading', but provide a better error message."
19103 (condition-case nil
19104 (outline-back-to-heading invisible-ok)
19105 (error (error "Before first headline at position %d in buffer %s"
19106 (point) (current-buffer)))))
19108 (defun org-beginning-of-defun ()
19109 "Go to the beginning of the subtree, i.e. back to the heading."
19110 (org-back-to-heading))
19111 (defun org-end-of-defun ()
19112 "Go to the end of the subtree."
19113 (org-end-of-subtree nil t))
19115 (defun org-before-first-heading-p ()
19116 "Before first heading?"
19117 (save-excursion
19120 (defun org-on-heading-p (&optional ignored)
19121 (outline-on-heading-p t))
19122 (defun org-at-heading-p (&optional ignored)
19123 (outline-on-heading-p t))
19125 (defun org-point-at-end-of-empty-headline ()
19126 "If point is at the end of an empty headline, return t, else nil.
19127 If the heading only contains a TODO keyword, it is still still considered
19128 empty."
19130 (save-excursion
19131 (beginning-of-line 1)
19134 (defun org-at-heading-or-item-p ()
19135 (or (org-on-heading-p) (org-at-item-p)))
19137 (defun org-on-target-p ()
19138 (or (org-in-regexp org-radio-target-regexp)
19139 (org-in-regexp org-target-regexp)))
19141 (defun org-up-heading-all (arg)
19142 "Move to the heading line of which the present line is a subheading.
19143 This function considers both visible and invisible heading lines.
19144 With argument, move up ARG levels."
19145 (if (fboundp 'outline-up-heading-all)
19146 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19147 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19149 (defun org-up-heading-safe ()
19150 "Move to the heading line of which the present line is a subheading.
19151 This version will not throw an error. It will return the level of the
19152 headline found, or nil if no higher level is found.
19154 Also, this function will be a lot faster than `outline-up-heading',
19155 because it relies on stars being the outline starters. This can really
19156 make a significant difference in outlines with very many siblings."
19157 (let (start-level re)
19158 (org-back-to-heading t)
19159 (setq start-level (funcall outline-level))
19160 (if (equal start-level 1)
19161 nil
19163 (if (re-search-backward re nil t)
19164 (funcall outline-level)))))
19166 (defun org-first-sibling-p ()
19167 "Is this heading the first child of its parents?"
19168 (interactive)
19169 (let ((re (concat "^" outline-regexp))
19170 level l)
19171 (unless (org-at-heading-p t)
19172 (error "Not at a heading"))
19173 (setq level (funcall outline-level))
19174 (save-excursion
19175 (if (not (re-search-backward re nil t))
19176 t
19177 (setq l (funcall outline-level))
19178 (< l level)))))
19180 (defun org-goto-sibling (&optional previous)
19181 "Goto the next sibling, even if it is invisible.
19182 When PREVIOUS is set, go to the previous sibling instead. Returns t
19183 when a sibling was found. When none is found, return nil and don't
19184 move point."
19185 (let ((fun (if previous 're-search-backward 're-search-forward))
19186 (pos (point))
19187 (re (concat "^" outline-regexp))
19188 level l)
19189 (when (condition-case nil (org-back-to-heading t) (error nil))
19190 (setq level (funcall outline-level))
19191 (catch 'exit
19192 (or previous (forward-char 1))
19193 (while (funcall fun re nil t)
19194 (setq l (funcall outline-level))
19195 (when (< l level) (goto-char pos) (throw 'exit nil))
19196 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
19197 (goto-char pos)
19198 nil))))
19200 (defun org-show-siblings ()
19201 "Show all siblings of the current headline."
19202 (save-excursion
19203 (while (org-goto-sibling) (org-flag-heading nil)))
19204 (save-excursion
19205 (while (org-goto-sibling 'previous)
19206 (org-flag-heading nil))))
19208 (defun org-goto-first-child ()
19209 "Goto the first child, even if it is invisible.
19210 Return t when a child was found. Otherwise don't move point and
19211 return nil."
19212 (let (level (pos (point)) (re (concat "^" outline-regexp)))
19213 (when (condition-case nil (org-back-to-heading t) (error nil))
19214 (setq level (outline-level))
19215 (forward-char 1)
19216 (if (and (re-search-forward re nil t) (> (outline-level) level))
19217 (progn (goto-char (match-beginning 0)) t)
19218 (goto-char pos) nil))))
19220 (defun org-show-hidden-entry ()
19221 "Show an entry where even the heading is hidden."
19222 (save-excursion
19223 (org-show-entry)))
19225 (defun org-flag-heading (flag &optional entry)
19226 "Flag the current heading. FLAG non-nil means make invisible.
19227 When ENTRY is non-nil, show the entire entry."
19228 (save-excursion
19229 (org-back-to-heading t)
19230 ;; Check if we should show the entire entry
19231 (if entry
19232 (progn
19233 (org-show-entry)
19234 (save-excursion
19235 (and (outline-next-heading)
19236 (org-flag-heading nil))))
19237 (outline-flag-region (max (point-min) (1- (point)))
19238 (save-excursion (outline-end-of-heading) (point))
19239 flag))))
19241 (defun org-get-next-sibling ()
19242 "Move to next heading of the same level, and return point.
19243 If there is no such heading, return nil.
19244 This is like outline-next-sibling, but invisible headings are ok."
19245 (let ((level (funcall outline-level)))
19246 (outline-next-heading)
19247 (while (and (not (eobp)) (> (funcall outline-level) level))
19248 (outline-next-heading))
19249 (if (or (eobp) (< (funcall outline-level) level))
19250 nil
19251 (point))))
19253 (defun org-get-last-sibling ()
19254 "Move to previous heading of the same level, and return point.
19255 If there is no such heading, return nil."
19256 (let ((opoint (point))
19257 (level (funcall outline-level)))
19258 (outline-previous-heading)
19259 (when (and (/= (point) opoint) (outline-on-heading-p t))
19260 (while (and (> (funcall outline-level) level)
19261 (not (bobp)))
19262 (outline-previous-heading))
19263 (if (< (funcall outline-level) level)
19264 nil
19265 (point)))))
19267 (defun org-end-of-subtree (&optional invisible-OK to-heading)
19268 ;; This contains an exact copy of the original function, but it uses
19269 ;; `org-back-to-heading', to make it work also in invisible
19270 ;; trees. And is uses an invisible-OK argument.
19271 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
19272 ;; Furthermore, when used inside Org, finding the end of a large subtree
19273 ;; with many children and grandchildren etc, this can be much faster
19274 ;; than the outline version.
19275 (org-back-to-heading invisible-OK)
19276 (let ((first t)
19277 (level (funcall outline-level)))
19278 (if (and (org-mode-p) (< level 1000))
19279 ;; A true heading (not a plain list item), in Org-mode
19280 ;; This means we can easily find the end by looking
19281 ;; only for the right number of stars. Using a regexp to do
19282 ;; this is so much faster than using a Lisp loop.
19284 (forward-char 1)
19285 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
19286 ;; something else, do it the slow way
19287 (while (and (not (eobp))
19288 (or first (> (funcall outline-level) level)))
19289 (setq first nil)
19290 (outline-next-heading)))
19291 (unless to-heading
19293 (progn
19294 ;; Go to end of line before heading
19295 (forward-char -1)
19297 ;; leave blank line before heading
19298 (forward-char -1))))))
19299 (point))
19301 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
19302 "Use Org version in org-mode, for dramatic speed-up."
19303 (if (eq major-mode 'org-mode)
19304 (progn
19305 (org-end-of-subtree nil t)
19306 (unless (eobp) (backward-char 1)))
19307 ad-do-it))
19309 (defun org-forward-same-level (arg &optional invisible-ok)
19310 "Move forward to the arg'th subheading at same level as this one.
19311 Stop at the first and last subheadings of a superior heading.
19312 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
19313 it wil also look at invisible ones."
19314 (interactive "p")
19315 (org-back-to-heading invisible-ok)
19316 (org-on-heading-p)
19317 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19319 l)
19320 (forward-char 1)
19321 (while (> arg 0)
19322 (while (and (re-search-forward re nil 'move)
19323 (setq l (- (match-end 0) (match-beginning 0) 1))
19324 (= l level)
19325 (not invisible-ok)
19326 (progn (backward-char 1) (org-invisible-p)))
19327 (if (< l level) (setq arg 1)))
19328 (setq arg (1- arg)))
19329 (beginning-of-line 1)))
19331 (defun org-backward-same-level (arg &optional invisible-ok)
19332 "Move backward to the arg'th subheading at same level as this one.
19333 Stop at the first and last subheadings of a superior heading."
19334 (interactive "p")
19335 (org-back-to-heading)
19336 (org-on-heading-p)
19337 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19339 l)
19340 (while (> arg 0)
19341 (while (and (re-search-backward re nil 'move)
19342 (setq l (- (match-end 0) (match-beginning 0) 1))
19343 (= l level)
19344 (not invisible-ok)
19345 (org-invisible-p))
19346 (if (< l level) (setq arg 1)))
19347 (setq arg (1- arg)))))
19349 (defun org-show-subtree ()
19350 "Show everything after this heading at deeper levels."
19351 (outline-flag-region
19352 (point)
19353 (save-excursion
19354 (org-end-of-subtree t t))
19355 nil))
19357 (defun org-show-entry ()
19358 "Show the body directly following this heading.
19359 Show the heading too, if it is currently invisible."
19360 (interactive)
19361 (save-excursion
19362 (condition-case nil
19363 (progn
19364 (org-back-to-heading t)
19365 (outline-flag-region
19366 (max (point-min) (1- (point)))
19367 (save-excursion
19368 (if (re-search-forward
19370 (match-beginning 1)
19371 (point-max)))
19372 nil)
19373 (org-cycle-hide-drawers 'children))
19374 (error nil))))
19376 (defun org-make-options-regexp (kwds &optional extra)
19377 "Make a regular expression for keyword lines."
19378 (concat
19379 "^"
19386 ;; Make isearch reveal the necessary context
19387 (defun org-isearch-end ()
19388 "Reveal context after isearch exits."
19389 (when isearch-success ; only if search was successful
19390 (if (featurep 'xemacs)
19391 ;; Under XEmacs, the hook is run in the correct place,
19392 ;; we directly show the context.
19393 (org-show-context 'isearch)
19394 ;; In Emacs the hook runs *before* restoring the overlays.
19395 ;; So we have to use a one-time post-command-hook to do this.
19396 ;; (Emacs 22 has a special variable, see function `org-mode')
19397 (unless (and (boundp 'isearch-mode-end-hook-quit)
19398 isearch-mode-end-hook-quit)
19399 ;; Only when the isearch was not quitted.
19400 (org-add-hook 'post-command-hook 'org-isearch-post-command
19401 'append 'local)))))
19403 (defun org-isearch-post-command ()
19404 "Remove self from hook, and show context."
19405 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
19406 (org-show-context 'isearch))
19409 ;;;; Integration with and fixes for other packages
19411 ;;; Imenu support
19413 (defvar org-imenu-markers nil
19414 "All markers currently used by Imenu.")
19415 (make-variable-buffer-local 'org-imenu-markers)
19417 (defun org-imenu-new-marker (&optional pos)
19418 "Return a new marker for use by Imenu, and remember the marker."
19419 (let ((m (make-marker)))
19420 (move-marker m (or pos (point)))
19421 (push m org-imenu-markers)
19422 m))
19424 (defun org-imenu-get-tree ()
19425 "Produce the index for Imenu."
19426 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
19427 (setq org-imenu-markers nil)
19428 (let* ((n org-imenu-depth)
19429 (re (concat "^" outline-regexp))
19430 (subs (make-vector (1+ n) nil))
19431 (last-level 0)
19432 m level head)
19433 (save-excursion
19434 (save-restriction
19435 (widen)
19436 (goto-char (point-max))
19437 (while (re-search-backward re nil t)
19438 (setq level (org-reduced-level (funcall outline-level)))
19439 (when (<= level n)
19440 (looking-at org-complex-heading-regexp)
19441 (setq head (org-link-display-format
19442 (org-match-string-no-properties 4))
19443 m (org-imenu-new-marker))
19444 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
19445 (if (>= level last-level)
19446 (push (cons head m) (aref subs level))
19447 (push (cons head (aref subs (1+ level))) (aref subs level))
19448 (loop for i from (1+ level) to n do (aset subs i nil)))
19449 (setq last-level level)))))
19450 (aref subs 1)))
19452 (eval-after-load "imenu"
19453 '(progn
19454 (add-hook 'imenu-after-jump-hook
19455 (lambda ()
19456 (if (eq major-mode 'org-mode)
19457 (org-show-context 'org-goto))))))
19459 (defun org-link-display-format (link)
19460 "Replace a link with either the description, or the link target
19461 if no description is present"
19462 (save-match-data
19463 (if (string-match org-bracket-link-analytic-regexp link)
19464 (replace-match (if (match-end 5)
19465 (match-string 5 link)
19466 (concat (match-string 1 link)
19467 (match-string 3 link)))
19468 nil t link)
19469 link)))
19471 ;; Speedbar support
19473 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
19474 "Overlay marking the agenda restriction line in speedbar.")
19475 (overlay-put org-speedbar-restriction-lock-overlay
19476 'face 'org-agenda-restriction-lock)
19477 (overlay-put org-speedbar-restriction-lock-overlay
19478 'help-echo "Agendas are currently limited to this item.")
19479 (org-detach-overlay org-speedbar-restriction-lock-overlay)
19481 (defun org-speedbar-set-agenda-restriction ()
19482 "Restrict future agenda commands to the location at point in speedbar.
19484 (interactive)
19485 (require 'org-agenda)
19486 (let (p m tp np dir txt)
19487 (cond
19488 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19489 'org-imenu t))
19490 (setq m (get-text-property p 'org-imenu-marker))
19491 (with-current-buffer (marker-buffer m)
19492 (goto-char m)
19493 (org-agenda-set-restriction-lock 'subtree)))
19494 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19495 'speedbar-function 'speedbar-find-file))
19496 (setq tp (previous-single-property-change
19497 (1+ p) 'speedbar-function)
19498 np (next-single-property-change
19499 tp 'speedbar-function)
19500 dir (speedbar-line-directory)
19501 txt (buffer-substring-no-properties (or tp (point-min))
19502 (or np (point-max))))
19503 (with-current-buffer (find-file-noselect
19504 (let ((default-directory dir))
19505 (expand-file-name txt)))
19506 (unless (org-mode-p)
19507 (error "Cannot restrict to non-Org-mode file"))
19508 (org-agenda-set-restriction-lock 'file)))
19509 (t (error "Don't know how to restrict Org-mode's agenda")))
19510 (move-overlay org-speedbar-restriction-lock-overlay
19511 (point-at-bol) (point-at-eol))
19512 (setq current-prefix-arg nil)
19513 (org-agenda-maybe-redo)))
19515 (eval-after-load "speedbar"
19516 '(progn
19517 (speedbar-add-supported-extension ".org")
19518 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
19519 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
19520 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
19521 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19522 (add-hook 'speedbar-visiting-tag-hook
19523 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
19525 ;;; Fixes and Hacks for problems with other packages
19527 ;; Make flyspell not check words in links, to not mess up our keymap
19528 (defun org-mode-flyspell-verify ()
19529 "Don't let flyspell put overlays at active buttons."
19530 (and (not (get-text-property (max (1- (point)) (point-min)) 'keymap))
19531 (not (get-text-property (max (1- (point)) (point-min)) 'org-no-flyspell))))
19533 (defun org-remove-flyspell-overlays-in (beg end)
19534 "Remove flyspell overlays in region."
19535 (and (org-bound-and-true-p flyspell-mode)
19536 (fboundp 'flyspell-delete-region-overlays)
19537 (flyspell-delete-region-overlays beg end))
19538 (add-text-properties beg end '(org-no-flyspell t)))
19540 ;; Make `bookmark-jump' shows the jump location if it was hidden.
19541 (eval-after-load "bookmark"
19542 '(if (boundp 'bookmark-after-jump-hook)
19543 ;; We can use the hook
19544 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
19545 ;; Hook not available, use advice
19546 (defadvice bookmark-jump (after org-make-visible activate)
19547 "Make the position visible."
19548 (org-bookmark-jump-unhide))))
19550 ;; Make sure saveplace shows the location if it was hidden
19551 (eval-after-load "saveplace"
19552 '(defadvice save-place-find-file-hook (after org-make-visible activate)
19553 "Make the position visible."
19554 (org-bookmark-jump-unhide)))
19556 ;; Make sure ecb shows the location if it was hidden
19557 (eval-after-load "ecb"
19558 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
19559 "Make hierarchy visible when jumping into location from ECB tree buffer."
19560 (if (eq major-mode 'org-mode)
19561 (org-show-context))))
19563 (defun org-bookmark-jump-unhide ()
19564 "Unhide the current position, to show the bookmark location."
19565 (and (org-mode-p)
19566 (or (org-invisible-p)
19567 (save-excursion (goto-char (max (point-min) (1- (point))))
19568 (org-invisible-p)))
19569 (org-show-context 'bookmark-jump)))
19571 ;; Make session.el ignore our circular variable
19572 (eval-after-load "session"
19573 '(add-to-list 'session-globals-exclude 'org-mark-ring))
19575 ;;;; Experimental code
19577 (defun org-closed-in-range ()
19578 "Sparse tree of items closed in a certain time range.
19579 Still experimental, may disappear in the future."
19580 (interactive)
19581 ;; Get the time interval from the user.
19582 (let* ((time1 (org-float-time
19583 (org-read-date nil 'to-time nil "Starting date: ")))
19584 (time2 (org-float-time
19585 (org-read-date nil 'to-time nil "End date:")))
19586 ;; callback function
19587 (callback (lambda ()
19588 (let ((time
19589 (org-float-time
19590 (apply 'encode-time
19591 (org-parse-time-string
19592 (match-string 1))))))
19593 ;; check if time in interval
19594 (and (>= time time1) (<= time time2))))))
19595 ;; make tree, check each match with the callback
19598 ;;;; Finish up
19600 (provide 'org)
19602 (run-hooks 'org-load-hook)
19604 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
19606 ;;; org.el ends here