| blob | b974e6c5f58abe16a18a5cf6c16c4ffc8f00c45b |
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'. When this option is t, the entire active region
1390 will be placed in the search string of the file link. If set to a
1391 positive integer, only the first n lines of context will be stored.
1394 negates this setting for the duration of the command."
1399 "Non-nil means keep link in list for entire session.
1401 The command `org-store-link' adds a link pointing to the current
1402 location to an internal list. These links accumulate during a session.
1403 The command `org-insert-link' can be used to insert links into any
1404 Org-mode file (offering completion for all stored links). When this
1406 will be removed from the list, to make completing the unused links
1407 more efficient."
1412 "Options concerning following links in Org-mode."
1417 "Function to translate links with different syntax to Org syntax.
1418 This can be used to translate links created for example by the Planner
1419 or emacs-wiki packages to Org syntax.
1420 The function must accept two parameters, a TYPE containing the link
1422 which is everything after the link protocol. It should return a cons
1423 with possibly modified values of type and path.
1424 Org contains a function for this, so if you set this variable to
1425 `org-translate-link-from-planner', you should be able follow many
1426 links created by planner."
1431 "Hook that is run after a link has been followed."
1436 "Non-nil means on links TAB will follow the link.
1437 Needs to be set before org.el is loaded.
1438 This really should not be used, it does not make sense, and the
1439 implementation is bad."
1444 "Non-nil means on links RET will follow the link."
1450 "Non-nil means mouse-1 on a link will follow the link.
1451 A longer mouse click will still set point. Does not work on XEmacs.
1452 Needs to be set before org.el is loaded."
1457 "Number of different positions to be recorded in the ring.
1458 Changing this requires a restart of Emacs to work correctly."
1463 "Non-nil means internal links in Org files must exactly match a headline.
1464 When nil, the link search tries to match a phrase will all words
1465 in the search text."
1471 query-to-create)))
1478 "Setup the frame configuration for following links.
1479 When following a link with Emacs, it may often be useful to display
1480 this link in another window or frame. This variable can be used to
1481 set this up for the different types of links.
1482 For VM, use any of
1483 `vm-visit-folder'
1484 `vm-visit-folder-other-frame'
1485 For Gnus, use any of
1486 `gnus'
1487 `gnus-other-frame'
1488 `org-gnus-no-new-news'
1489 For FILE, use any of
1490 `find-file'
1491 `find-file-other-window'
1492 `find-file-other-frame'
1493 For Wanderlust use any of
1494 `wl'
1495 `wl-other-frame'
1496 For the calendar, use the variable `calendar-setup'.
1497 For BBDB, it is currently only possible to display the matches in
1498 another window."
1522 "Non-nil means use indirect buffer to display infile links.
1523 Activating internal links (from one location in a file to another location
1524 in the same file) normally just jumps to the location. When the link is
1526 is displayed in
1527 another window. When this option is set, the other window actually displays
1528 an indirect buffer clone of the current buffer, to avoid any visibility
1529 changes to the current buffer."
1534 "Non-nil means `org-open-file' will open non-existing files.
1535 When nil, an error will be generated.
1536 This variable applies only to external applications because they
1537 might choke on non-existing files. If the link is to a file that
1538 will be opened in Emacs, the variable is ignored."
1543 "Non-nil means a link to a directory really means to index.org.
1544 When nil, following a directory link will run dired or open a finder/explorer
1545 window on that directory."
1550 "Function and arguments to call for following mailto links.
1551 This is a list with the first element being a Lisp function, and the
1552 remaining elements being arguments to the function. In string arguments,
1553 %a will be replaced by the address, and %s will be replaced by the subject
1554 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1563 "Non-nil means ask for confirmation before executing shell links.
1564 Shell links can be dangerous: just think about a link
1566 [[shell:rm -rf ~/*][Google Search]]
1569 but really it would remove your entire home directory.
1570 Therefore we advise against setting this variable to nil.
1571 Just change it to `y-or-n-p' if you want to confirm with a
1579 'safe-local-variable
1583 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1584 Elisp links can be dangerous: just think about a link
1589 but really it would remove your entire home directory.
1590 Therefore we advise against setting this variable to nil.
1591 Just change it to `y-or-n-p' if you want to confirm with a
1599 'safe-local-variable
1606 "Default file applications on a UNIX or GNU/Linux system.
1617 "Default file applications on a MacOS X system.
1619 for some files for which the OS does not have a good default.
1627 'mswindows-shell-execute
1632 'mswindows-shell-execute
1635 "Default file applications on a Windows NT system.
1640 '(
1645 )
1646 "External applications for opening `file:path' items in a document.
1647 Org-mode uses system defaults for different file types, but
1648 you can use this variable to set the application for a given file
1649 extension. The entries in this list are cons cells where the car identifies
1650 files and the cdr the corresponding command. Possible values for the
1651 file identifier are
1653 ways, depending on its contents:
1655 - Alphanumeric characters only:
1656 Match links with this file extension.
1658 to open PDFs with evince.
1660 - Regular expression: Match links where the
1661 filename matches the regexp. If you want to
1662 use groups here, use shy groups.
1666 to open *.html and *.xhtml with firefox.
1668 - Regular expression which contains (non-shy) groups:
1670 anything after that, matches the regexp.
1671 In a custom command string, %1, %2, etc. are replaced with
1672 the parts of the link that were matched by the groups.
1673 For backwards compatibility, if a command string is given
1674 that does not use any of the group matches, this case is
1675 handled identically to the second one (i.e. match against
1676 file name only).
1677 In a custom lisp form, you can access the group matches with
1678 (match-string n link).
1681 to open [[file:document.pdf::5]] with evince at page 5.
1683 `directory' Matches a directory
1684 `remote' Matches a remote file, accessible through tramp or efs.
1685 Remote files most likely should be visited through Emacs
1686 because external applications cannot handle such paths.
1687 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1688 so all files Emacs knows how to handle. Using this with
1689 command `emacs' will open most files in Emacs. Beware that this
1690 will also open html files inside Emacs, unless you add
1692 t Default for files not matched by any of the other options.
1693 `system' The system command to open files, like `open' on Windows
1694 and Mac OS X, and mailcap under GNU/Linux. This is the command
1695 that will be selected if you call `C-c C-o' with a double
1698 Possible values for the command are:
1699 `emacs' The file will be visited by the current Emacs process.
1700 `default' Use the default application for this file type, which is the
1701 association for t in the list, most likely in the system-specific
1702 part.
1703 This can be used to overrule an unwanted setting in the
1704 system-specific variable.
1706 This command is specified by the entry whose car is `system'.
1707 Most likely, the system-specific version of this variable
1708 does define this command, but you can overrule/replace it
1709 here.
1710 string A command to be executed by a shell; %s will be replaced
1711 by the path to the file.
1712 sexp A Lisp form which will be evaluated. The file path will
1713 be available in the Lisp variable `file'.
1714 For more examples, see the system specific constants
1715 `org-file-apps-defaults-macosx'
1716 `org-file-apps-defaults-windowsnt'
1717 `org-file-apps-defaults-gnu'."
1727 auto-mode))
1738 "Options concerning refiling entries in Org-mode."
1743 "Directory with org files.
1744 This is just a default location to look for Org files. There is no need
1745 at all to put your files into this directory. It is only used in the
1746 following situations:
1748 1. When a remember template specifies a target file that is not an
1749 absolute path. The path will then be interpreted relative to
1750 `org-directory'
1751 2. When a remember note is filed away in an interactive way (when exiting the
1752 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1753 with `org-directory' as the default path."
1759 "Default target for storing notes.
1760 Used as a fall back file for org-remember.el and org-capture.el, for
1761 templates that do not specify a target file."
1766 file))
1769 "The default interface to be used for `org-goto'.
1770 Allowed values are:
1771 outline The interface shows an outline of the relevant file
1772 and the correct heading is found by moving through
1773 the outline or by searching with incremental search.
1774 outline-path-completion Headlines in the current buffer are offered via
1775 completion. This is the interface also used by
1776 the refile command."
1783 "Maximum target level when running `org-goto' with refile interface."
1788 "Non-nil means store new notes at the beginning of a file or entry.
1789 When nil, new notes will be filed to the end of a file or entry.
1790 This can also be a list with cons cells of regular expressions that
1791 are matched against file names, and values."
1801 "Information to record when a task is refiled.
1803 Possible values are:
1805 nil Don't add anything
1806 time Add a time stamp to the task
1807 note Prompt for a note and add it with template `org-log-note-headings'
1809 This option can also be set with on a per-file-basis with
1811 #+STARTUP: nologrefile
1812 #+STARTUP: logrefile
1813 #+STARTUP: lognoterefile
1815 You can have local logging settings for a subtree by setting the LOGGING
1816 property to one or more of these keywords.
1818 When bulk-refiling from the agenda, the value `note' is forbidden and
1819 will temporarily be changed to `time'."
1829 This is list of cons cells. Each cell contains:
1830 - a specification of the files to be considered, either a list of files,
1831 or a symbol whose function or variable value will be used to retrieve
1832 a file name or a list of file names. If you use `org-agenda-files' for
1833 that, all agenda files will be scanned for targets. Nil means consider
1834 headings in the current buffer.
1835 - A specification of how to find candidate refile targets. This may be
1836 any of:
1838 This tag has to be present in all target headlines, inheritance will
1839 not be considered.
1841 todo keyword.
1843 headlines that are refiling targets.
1844 - a cons cell (:level . N). Any headline of level N is considered 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.
1847 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1848 Note that, when `org-odd-levels-only' is set, level corresponds to
1849 order in hierarchy, not to the number of stars.
1851 You can set the variable `org-refile-target-verify-function' to a function
1852 to verify each headline found by the simple criteria above.
1854 When this variable is nil, all top-level headlines in the current buffer
1855 are used, equivalent to the value `((nil . (:level . 1))'."
1871 "Function to verify if the headline at point should be a refile target.
1872 The function will be called without arguments, with point at the
1873 beginning of the headline. It should return t and leave point
1874 where it is if the headline is a valid target for refiling.
1876 If the target should not be selected, the function must return nil.
1877 In addition to this, it may move point to a place from where the search
1878 should be continued. For example, the function may decide that the entire
1879 subtree of the current entry should be excluded and move point to the end
1880 of the subtree."
1885 "Non-nil means cache refile targets to speed up the process.
1886 The cache for a particular file will be updated automatically when
1887 the buffer has been killed, or when any of the marker used for flagging
1888 refile targets no longer points at a live buffer.
1889 If you have added new entries to a buffer that might themselves be targets,
1890 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1891 find that easier, `C-u C-u C-u C-c C-w'."
1896 "Non-nil means provide refile targets as paths.
1897 So a level 3 headline will be available as level1/level2/level3.
1899 When the value is `file', also include the file name (without directory)
1900 into the path. In this case, you can also stop the completion after
1901 the file name, to get entries inserted as top level in the file.
1903 When `full-file-path', include the full file path."
1912 "Non-nil means complete the outline path in hierarchical steps.
1913 When Org-mode uses the refile interface to select an outline path
1914 \(see variable `org-refile-use-outline-path'), the completion of
1915 the path can be done is a single go, or if can be done in steps down
1916 the headline hierarchy. Going in steps is probably the best if you
1917 do not use a special completion package like `ido' or `icicles'.
1918 However, when using these packages, going in one step can be very
1919 fast, while still showing the whole path to the entry."
1924 "Non-nil means allow to create new nodes as refile targets.
1926 of an existing node. When the value of this variable is `confirm',
1927 new node creation must be confirmed by the user (recommended)
1928 When nil, the completion must match an existing entry.
1930 Note that, if the new heading is not seen by the criteria
1931 listed in `org-refile-targets', multiple instances of the same
1932 heading would be created by trying again to file under the new
1933 heading."
1941 "Options concerning TODO items in Org-mode."
1946 "Options concerning Progress logging in Org-mode."
1951 '(
1954 "The available interpretation symbols for customizing `org-todo-keywords'.
1958 "List of TODO entry keyword sequences and their interpretation.
1961 Each sequence starts with a symbol, either `sequence' or `type',
1962 indicating if the keywords should be interpreted as a sequence of
1963 action steps, or as different types of TODO items. The first
1964 keywords are states requiring action - these states will select a headline
1965 for inclusion into the global TODO list Org-mode produces. If one of
1968 the last keyword is treated as the only DONE state of the sequence.
1971 additional state where no keyword is present. For details about this
1972 cycling, see the manual.
1974 TODO keywords and interpretation can also be set on a per-file basis with
1975 the special #+SEQ_TODO and #+TYP_TODO lines.
1977 Each keyword can optionally specify a character for fast state selection
1978 \(in combination with the variable `org-use-fast-todo-selection')
1979 and specifiers for state change logging, using the same syntax
1982 indicates to record a time stamp each time this state is selected.
1984 Each keyword may also specify if a timestamp or a note should be
1985 recorded when entering or leaving the state, by adding additional
1986 characters in the parenthesis after the keyword. This looks like this:
1988 record only the time of the state change. With X and Y being either
1990 Y when leaving the state if and only if the *target* state does not
1991 define X. You may omit any of the fast-selection key or X or /Y,
1992 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1994 For backward compatibility, this variable may also be just a list
1995 of keywords - in this case the interpretation (sequence or type) will be
1996 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2006 ;;Quick and dirty way to see
2007 ;;`org-todo-interpretations'. This takes the
2008 ;;place of item arguments
2009 :convert-widget
2016 org-todo-interpretation-widgets))
2017 widget))
2048 "Controls how TODO keywords are interpreted.
2049 This variable is in principle obsolete and is only used for
2050 backward compatibility, if the interpretation of todo keywords is
2051 not given already in `org-todo-keywords'. See that variable for
2052 more information."
2059 "Non-nil means use the fast todo selection scheme with C-c C-t.
2060 This variable describes if and under what circumstances the cycling
2061 mechanism for TODO keywords will be replaced by a single-key, direct
2062 selection scheme.
2064 When nil, fast selection is never used.
2066 When the symbol `prefix', it will be used when `org-todo' is called with
2067 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2068 in an agenda buffer.
2070 When t, fast selection is used by default. In this case, the prefix
2071 argument forces cycling instead.
2073 In all cases, the special interface is only used if access keys have actually
2074 been assigned by the user, i.e. if keywords in the configuration are followed
2075 by a letter in parenthesis, like TODO(t)."
2083 "Non-nil means update todo statistics after insert and toggle.
2084 ALL-HEADLINES means update todo statistics by including headlines
2085 with no TODO keyword as well, counting them as not done.
2086 A list of TODO keywords means the same, but skip keywords that are
2087 not in this list.
2089 When this is set, todo statistics is updated in the parent of the
2090 current entry each time a todo state is changed."
2100 "Non-nil means TODO statistics covers just direct children.
2101 When nil, all entries in the subtree are considered.
2102 This has only an effect if `org-provide-todo-statistics' is set.
2103 To set this to nil for only a single subtree, use a COOKIE_DATA
2109 "Hook which is run after the state of a TODO item was changed.
2110 The new state (a string with a TODO keyword, or nil) is available in the
2111 Lisp variable `state'."
2116 "Hook for functions that are allowed to block a state change.
2118 Each function gets as its single argument a property list, see
2119 `org-trigger-hook' for more information about this list.
2121 If any of the functions in this hook returns nil, the state change
2125 "Hook for functions that are triggered by a state change.
2127 Each function gets as its single argument a property list with at least
2128 the following elements:
2130 (:type type-of-change :position pos-at-entry-start
2131 :from old-state :to new-state)
2133 Depending on the type, more properties may be present.
2135 This mechanism is currently implemented for:
2137 TODO state changes
2138 ------------------
2139 :type todo-state-change
2140 :from previous state (keyword as a string), or nil, or a symbol
2141 'todo' or 'done', to indicate the general type of state.
2145 "Non-nil means undone TODO entries will block switching the parent to DONE.
2146 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2147 be blocked if any prior sibling is not yet done.
2148 Finally, if the parent is blocked because of ordered siblings of its own,
2149 the child will also be blocked.
2150 This variable needs to be set before org.el is loaded, and you need to
2151 restart Emacs after a change to make the change effective. The only way
2152 to change is while Emacs is running is through the customize interface."
2164 "Non-nil means unchecked boxes will block switching the parent to DONE.
2165 When this is nil, checkboxes have no influence on switching TODO states.
2166 When non-nil, you first need to check off all check boxes before the TODO
2167 entry can be switched to DONE.
2168 This variable needs to be set before org.el is loaded, and you need to
2169 restart Emacs after a change to make the change effective. The only way
2170 to change is while Emacs is running is through the customize interface."
2182 "Non-nil means inserting a TODO heading is treated as state change.
2184 logging will apply if appropriate. When nil, the new TODO item will
2185 be inserted directly, and no logging will take place."
2190 "Non-nil means switching TODO states with S-cursor counts as state change.
2191 This is the default behavior. However, setting this to nil allows a
2192 convenient way to select a TODO state and bypass any logging associated
2193 with that."
2198 "Tag changes that should be triggered by TODO state changes.
2199 This is a list. Each entry is
2201 (state-change (tag . flag) .......)
2203 State-change can be a string with a state, and empty string to indicate the
2204 state that has no TODO keyword, or it can be one of the symbols `todo'
2205 or `done', meaning any not-done or done state, respectively."
2219 "Information to record when a task moves to the DONE state.
2221 Possible values are:
2223 nil Don't add anything, just change the keyword
2224 time Add a time stamp to the task
2225 note Prompt for a note and add it with template `org-log-note-headings'
2227 This option can also be set with on a per-file-basis with
2229 #+STARTUP: nologdone
2230 #+STARTUP: logdone
2231 #+STARTUP: lognotedone
2233 You can have local logging settings for a subtree by setting the LOGGING
2234 property to one or more of these keywords."
2242 ;; Normalize old uses of org-log-done.
2249 "Information to record when the scheduling date of a tasks is modified.
2251 Possible values are:
2253 nil Don't add anything, just change the date
2254 time Add a time stamp to the task
2255 note Prompt for a note and add it with template `org-log-note-headings'
2257 This option can also be set with on a per-file-basis with
2259 #+STARTUP: nologreschedule
2260 #+STARTUP: logreschedule
2261 #+STARTUP: lognotereschedule"
2270 "Information to record when the deadline date of a tasks is modified.
2272 Possible values are:
2274 nil Don't add anything, just change the date
2275 time Add a time stamp to the task
2276 note Prompt for a note and add it with template `org-log-note-headings'
2278 This option can also be set with on a per-file-basis with
2280 #+STARTUP: nologredeadline
2281 #+STARTUP: logredeadline
2282 #+STARTUP: lognoteredeadline
2284 You can have local logging settings for a subtree by setting the LOGGING
2285 property to one or more of these keywords."
2294 "Non-nil means record a note when clocking out of an item.
2295 This can also be configured on a per-file basis by adding one of
2296 the following lines anywhere in the buffer:
2298 #+STARTUP: lognoteclock-out
2299 #+STARTUP: nolognoteclock-out"
2305 "Non-nil means the CLOSED time stamp will contain date and time.
2306 When nil, only the date will be recorded."
2320 "Headings for notes added to entries.
2321 The value is an alist, with the car being a symbol indicating the note
2322 context, and the cdr is the heading to be used. The heading may also be the
2323 empty string.
2324 %t in the heading will be replaced by a time stamp.
2325 %T will be an active time stamp instead the default inactive one
2326 %s will be replaced by the new TODO state, in double quotes.
2327 %S will be replaced by the old TODO state, in double quotes.
2328 %u will be replaced by the user name.
2329 %U will be replaced by the full user name.
2331 In fact, it is not a good idea to change the `state' entry, because
2332 agenda log mode depends on the format of these entries."
2338 "Heading when changing todo state (todo sequence only)"
2352 "Non-nil means insert state change notes and time stamps into a drawer.
2353 When nil, state changes notes will be inserted after the headline and
2354 any scheduling and clock lines, but not inside a drawer.
2356 The value of this variable should be the name of the drawer to use.
2357 LOGBOOK is proposed at the default drawer for this purpose, you can
2358 also set this to a string to define the drawer of your choice.
2362 If this variable is set, `org-log-state-notes-insert-after-drawers'
2363 will be ignored.
2365 You can set the property LOG_INTO_DRAWER to overrule this setting for
2366 a subtree."
2378 "Return the value of `org-log-into-drawer', but let properties overrule.
2379 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2380 used instead of the default value."
2388 "Non-nil means insert state change notes after any drawers in entry.
2389 Only the drawers that *immediately* follow the headline and the
2390 deadline/scheduled line are skipped.
2391 When nil, insert notes right after the heading and perhaps the line
2392 with deadline/scheduling if present.
2394 This variable will have no effect if `org-log-into-drawer' is
2395 set."
2401 "Non-nil means the latest state note will be directly after heading.
2402 When nil, the state change notes will be ordered according to time."
2408 "The TODO state to which a repeater should return the repeating task.
2409 By default this is the first task in a TODO sequence, or the previous state
2410 in a TODO_TYP set. But you can specify another task here.
2411 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2417 "Non-nil means record moving through the DONE state when triggering repeat.
2418 An auto-repeating task is immediately switched back to TODO when
2421 record a closing note, there will be no record of the task moving
2422 through DONE. This variable forces taking a note anyway.
2424 nil Don't force a record
2425 time Record a time stamp
2426 note Record a note
2428 This option can also be set with on a per-file-basis with
2430 #+STARTUP: logrepeat
2431 #+STARTUP: lognoterepeat
2432 #+STARTUP: nologrepeat
2434 You can have local logging settings for a subtree by setting the LOGGING
2435 property to one or more of these keywords."
2445 "Priorities in Org-mode."
2450 "Non-nil means priority commands are active.
2451 When nil, these commands will be disabled, so that you never accidentally
2452 set a priority."
2457 "The highest priority of TODO items. A character like ?A, ?B etc.
2458 Must have a smaller ASCII number than `org-lowest-priority'."
2463 "The lowest priority of TODO items. A character like ?A, ?B etc.
2464 Must have a larger ASCII number than `org-highest-priority'."
2469 "The default priority of TODO items.
2470 This is the priority an item get if no explicit priority is given."
2475 "Non-nil means start with default priority when starting to cycle.
2476 When this is nil, the first step in the cycle will be (depending on the
2477 command used) one higher or lower that the default priority."
2482 "Function to extract the priority from a string.
2483 The string is normally the headline. If this is nil Org computes the
2484 priority from the priority cookie like [#A] in the headline. It returns
2485 an integer, increasing by 1000 for each priority level.
2486 The user can set a different function here, which should take a string
2487 as an argument and return the numeric priority."
2492 "Options concerning time stamps and deadlines in Org-mode."
2497 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2498 When nil, these labeled time stamps are forces into the second line of an
2499 entry, just after the headline. When scheduling from the global TODO list,
2500 the time stamp will always be forced into the second line."
2505 "Formats for `format-time-string' which are used for time stamps.
2509 "Number of minutes to round time stamps to.
2510 These are two values, the first applies when first creating a time stamp.
2511 The second applies when changing it with the commands `S-up' and `S-down'.
2512 When changing the time stamp, this means that it will change in steps
2513 of N minutes, as given by the second value.
2515 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2516 numbers should be factors of 60, so for example 5, 10, 15.
2518 When this is larger than 1, you can still force an exact time stamp by using
2519 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2520 and by using a prefix arg to `S-up/down' to specify the exact number
2521 of minutes to shift."
2531 ;; Normalize old customizations of this variable.
2535 org-time-stamp-rounding-minutes)))
2538 "Non-nil means overlay custom formats over all time stamps.
2539 The formats are defined through the variable `org-time-stamp-custom-formats'.
2540 To turn this on on a per-file basis, insert anywhere in the file:
2541 #+STARTUP: customtime"
2549 "Custom formats for time stamps. See `format-time-string' for the syntax.
2550 These are overlayed over the default ISO format if the variable
2551 `org-display-custom-times' is set. Time like %H:%M should be at the
2552 end of the second format. The custom formats are also honored by export
2553 commands, if custom time display is turned on at the time of export."
2558 "Get the right format for a time string."
2563 f)))
2566 "The format string used when creating CLOCKSUM lines.
2567 This is also used when org-mode generates a time duration."
2573 org-mode generates a time duration."
2578 "The format string used when creating CLOCKSUM lines, or when
2579 org-mode generates a time duration."
2584 "No. of days before expiration during which a deadline becomes active.
2585 This variable governs the display in sparse trees and in the agenda.
2586 When 0 or negative, it means use this number (the absolute value of it)
2587 even if a deadline has a different individual lead time specified.
2589 Custom commands can set this variable in the options section."
2595 "Non-nil means assume future for incomplete date input from user.
2596 This affects the following situations:
2597 1. The user gives a month but not a year.
2600 2. The user gives a day, but no month.
2603 it will be considered as *this* month.
2605 If you set this variable to the symbol `time', then also the following
2606 will work:
2608 3. If the user gives a time, but no day. If the time is before now,
2609 to will be interpreted as tomorrow.
2611 Currently none of this works for ISO week specifications.
2613 When this option is nil, the current day, month and year will always be
2614 used as defaults.
2616 See also `org-agenda-jump-prefer-future'."
2624 "Should the agenda jump command prefer the future for incomplete dates?
2625 The default is to do the same as configured in `org-read-date-prefer-future'.
2626 But you can alse set a deviating value here.
2627 This may t or nil, or the symbol `org-read-date-prefer-future'."
2632 org-read-date-prefer-future)
2637 "Non-nil means display current interpretation of date prompt live.
2638 This display will be in an overlay, in the minibuffer."
2643 "Non-nil means pop up a calendar when prompting for a date.
2644 In the calendar, the date can be selected with mouse-1. However, the
2645 minibuffer will also be active, and you can simply enter the date as well.
2646 When nil, only the minibuffer will be available."
2654 "Hook to be used to set up keys for the date/time interface.
2655 Add key definitions to `minibuffer-local-map', which will be a temporary
2656 copy."
2661 "The hour when your day really ends. Must be an integer.
2662 This has influence for the following applications:
2664 the time given here, the day recognized as TODAY is actually yesterday.
2665 - When a date is read from the user and it is still before the time given
2666 here, the current date and time will be assumed to be yesterday, 23:59.
2667 Also, timestamps inserted in remember templates follow this rule.
2669 IMPORTANT: This is a feature whose implementation is and likely will
2670 remain incomplete. Really, it is only here because past midnight seems to
2671 be the favorite working time of John Wiegley :-)"
2676 "Non-nil means S-down will increase the time in a time stamp.
2677 When nil, S-up will increase."
2682 "Non-nil means make the calendar window follow timestamp changes.
2683 When a timestamp is modified and the calendar window is visible, it will be
2684 moved to the new date."
2689 "Options concerning tags in Org-mode."
2694 "List of tags allowed in Org-mode files.
2695 When this list is nil, Org-mode will base TAG input on what is already in the
2696 buffer.
2697 The value of this variable is an alist, the car of each entry must be a
2698 keyword as a string, the cdr may be a character that is used to select
2699 that tag through the fast-tag-selection interface.
2700 See the manual for details."
2715 "List of tags that will always appear in all Org-mode files.
2716 This is in addition to any in buffer settings or customizations
2717 of `org-tag-alist'.
2718 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2719 The value of this variable is an alist, the car of each entry must be a
2720 keyword as a string, the cdr may be a character that is used to select
2721 that tag through the fast-tag-selection interface.
2722 See the manual for details.
2723 To disable these tags on a per-file basis, insert anywhere in the file:
2724 #+STARTUP: noptag"
2735 "If non-nil, always offer completion for all tags of all agenda files.
2736 Instead of customizing this variable directly, you might want to
2737 set it locally for capture buffers, because there no list of
2738 tags in that file can be created dynamically (there are none).
2740 (add-hook 'org-capture-mode-hook
2741 (lambda ()
2742 (set (make-local-variable
2743 'org-complete-tags-always-offer-all-agenda-tags)
2744 t)))"
2749 "List of tags that can be inherited by all entries in the file.
2750 The tags will be inherited if the variable `org-use-tag-inheritance'
2751 says they should be.
2755 "Non-nil means use fast tag selection scheme.
2756 This is a special interface to select and deselect tags with single keys.
2757 When nil, fast selection is never used.
2758 When the symbol `auto', fast selection is used if and only if selection
2759 characters for tags have been configured, either through the variable
2760 `org-tag-alist' or through a #+TAGS line in the buffer.
2761 When t, fast selection is always used and selection keys are assigned
2762 automatically if necessary."
2770 "Non-nil means fast tag selection exits after first change.
2771 When nil, you have to press RET to exit it.
2772 During fast tag selection, you can toggle this flag with `C-c'.
2773 This variable can also have the value `expert'. In this case, the window
2774 displaying the tags menu is not even shown, until you press C-c again."
2782 "Non-nil means fast tags selection interface will also offer TODO states.
2786 "The column to which tags should be indented in a headline.
2787 If this number is positive, it specifies the column. If it is negative,
2788 it means that the tags should be flushright to that column. For example,
2789 -80 works well for a normal 80 character screen."
2794 "Non-nil means realign tags after pro/demotion of TODO state change.
2795 These operations change the length of a headline and therefore shift
2796 the tags around. With this options turned on, after each such operation
2797 the tags are again aligned to `org-tags-column'."
2802 "Non-nil means tags in levels apply also for sublevels.
2803 When nil, only the tags directly given in a specific line apply there.
2804 This may also be a list of tags that should be inherited, or a regexp that
2805 matches tags that should be inherited. Additional control is possible
2806 with the variable `org-tags-exclude-from-inheritance' which gives an
2807 explicit list of tags to be excluded from inheritance., even if the value of
2808 `org-use-tag-inheritance' would select it for inheritance.
2810 If this option is t, a match early-on in a tree can lead to a large
2811 number of matches in the subtree when constructing the agenda or creating
2812 a sparse tree. If you only want to see the first match in a tree during
2813 a search, check out the variable `org-tags-match-list-sublevels'."
2822 "List of tags that should never be inherited.
2823 This is a way to exclude a few tags from inheritance. For way to do
2824 the opposite, to actively allow inheritance for selected tags,
2825 see the variable `org-use-tag-inheritance'."
2830 "Check if TAG is one that should be inherited."
2842 "Non-nil means list also sublevels of headlines matching a search.
2843 This variable applies to tags/property searches, and also to stuck
2844 projects because this search is based on a tags match as well.
2846 When set to the symbol `indented', sublevels are indented with
2847 leading dots.
2849 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2850 the sublevels of a headline matching a tag search often also match
2851 the same search. Listing all of them can create very long lists.
2852 Setting this variable to nil causes subtrees of a match to be skipped.
2854 This variable is semi-obsolete and probably should always be true. It
2855 is better to limit inheritance to certain tags using the variables
2856 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2864 "When set, tags are sorted using this function as a comparator."
2880 "Options concerning properties in Org-mode."
2885 "How property key/value pairs should be formatted by `indent-line'.
2886 When `indent-line' hits a property definition, it will format the line
2887 according to this format, mainly to make sure that the values are
2888 lined-up with respect to each other."
2893 "Non-nil means properties apply also for sublevels.
2895 This setting is chiefly used during property searches. Turning it on can
2896 cause significant overhead when doing a search, which is why it is not
2897 on by default.
2899 When nil, only the properties directly given in the current entry count.
2900 When t, every property is inherited. The value may also be a list of
2901 properties that should have inheritance, or a regular expression matching
2902 properties that should be inherited.
2904 However, note that some special properties use inheritance under special
2905 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2907 for valid values of a property.
2909 Note for programmers:
2910 When querying an entry with `org-entry-get', you can control if inheritance
2911 should be used. By default, `org-entry-get' looks only at the local
2912 properties. You can request inheritance by setting the inherit argument
2913 to t (to force inheritance) or to `selective' (to respect the setting
2914 in this variable)."
2923 "Check if PROPERTY is one that should be inherited."
2934 "The default column format, if no other format has been defined.
2935 This variable can be set on the per-file basis by inserting a line
2937 #+COLUMNS: %25ITEM ....."
2942 "The ellipses to be used when a field in column view is truncated.
2943 When this is the empty string, as many characters as possible are shown,
2944 but then there will be no visual indication that the field has been truncated.
2945 When this is a string of length N, the last N characters of a truncated
2946 field are replaced by this string. If the column is narrower than the
2947 ellipses string, only part of the ellipses string will be shown."
2952 "Function that modifies values for display in column view.
2953 For example, it can be used to cut out a certain part from a time stamp.
2954 The function must take 2 arguments:
2956 column-title The title of the column (*not* the property name)
2957 value The value that should be modified.
2959 The function should return the value that should be displayed,
2960 or nil if the normal value should be used."
2965 "The property that is being used to keep track of effort estimates.
2966 Effort estimates given in this property need to have the format H:MM."
2974 "List of property/value pairs that can be inherited by any entry.
2976 These are fixed values, for the preset properties. The user variable
2977 that can be used to add to this list is `org-global-properties'.
2979 The entries in this list are cons cells where the car is a property
2980 name and cdr is a string with the value. If the value represents
2985 "List of property/value pairs that can be inherited by any entry.
2987 This list will be combined with the constant `org-global-properties-fixed'.
2989 The entries in this list are cons cells where the car is a property
2990 name and cdr is a string with the value.
2992 You can set buffer-local values for the same purpose in the variable
2993 `org-file-properties' this by adding lines like
2995 #+PROPERTY: NAME VALUE"
3002 "List of property/value pairs that can be inherited by any entry.
3003 Valid for the current buffer.
3008 "Options concerning agenda views in Org-mode."
3013 "Variable used by org files to set a category for agenda display.
3014 Such files should use a file variable to set it, for example
3018 or contain a special line
3020 #+CATEGORY: ELisp
3022 If the file does not specify a category, then file's base name
3028 "The files to be used for agenda display.
3032 If an entry is a directory, all files in that directory that are matched by
3033 `org-agenda-file-regexp' will be part of the file list.
3035 If the value of the variable is not a list but a single file name, then
3036 the list of agenda files is actually stored and maintained in that file, one
3037 agenda file per line. In this file paths can be given relative to
3038 `org-directory'. Tilde expansion and environment variable substitution
3039 are also made."
3046 "Regular expression to match files for `org-agenda-files'.
3047 If any element in the list in that variable contains a directory instead
3048 of a normal file, all files in that directory that are matched by this
3049 regular expression will be included."
3054 "List of extra files to be searched by text search commands.
3055 These files will be search in addition to the agenda files by the
3056 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3057 Note that these files will only be searched for text search commands,
3058 not for the other agenda views like todo lists, tag searches or the weekly
3059 agenda. This variable is intended to list notes and possibly archive files
3060 that should also be searched by these two commands.
3061 In fact, if the first element in the list is the symbol `agenda-archives',
3062 than all archive files of all agenda files will be added to the search
3063 scope."
3074 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3075 A nil value means to remove them, after a query, from the list."
3080 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3081 The command `org-calendar-goto-agenda' will be bound to this key. The
3082 default is the character `c' because then `c' can be used to switch back and
3083 forth between agenda and calendar."
3088 "The key to be installed in `calendar-mode-map' for agenda-action.
3089 The command `org-agenda-action' will be bound to this key. The
3090 default is the character `k' because we use the same key in the agenda."
3095 "The key to be installed in `calendar-mode-map' for adding diary entries.
3096 This option is irrelevant until `org-agenda-diary-file' has been configured
3097 to point to an Org-mode file. When that is the case, the command
3098 `org-agenda-diary-entry' will be bound to the key given here, by default
3099 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3100 if you want to continue doing this, you need to change this to a different
3101 key."
3106 "File to which to add new entries with the `i' key in agenda and calendar.
3107 When this is the symbol `diary-file', the functionality in the Emacs
3108 calendar will be used to add entries to the `diary-file'. But when this
3109 points to a file, `org-agenda-diary-entry' will be used instead."
3125 org-calendar-insert-diary-entry-key
3129 "Options for embedding LaTeX code into Org-mode."
3137 "Options for creating images from LaTeX fragments.
3138 This is a property list with the following properties:
3140 `default' means use the foreground of the default face.
3142 `default' means use the background of the default face.
3143 :scale a scaling factor for the size of the images, to get more pixels
3144 :html-foreground, :html-background, :html-scale
3145 the same numbers for HTML export.
3146 :matchers a list indicating which matchers should be used to
3147 find LaTeX fragments. Valid members of this list are:
3158 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3159 When nil, just push out a message."
3168 \[PACKAGES]
3169 \[DEFAULT-PACKAGES]
3170 % The settings below are copied from fullpage.sty
3183 "The document header used for processing LaTeX fragments.
3184 It is imperative that this header make sure that no page number
3185 appears on the page. The package defined in the variables
3186 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3188 will be appended."
3195 "Set the packages alist and make sure it has 3 elements per entry."
3199 x))
3200 val)))
3204 "Get the packages alist and make sure it has 3 elements per entry."
3208 x))
3211 ;; The following variables are defined here because is it also used
3212 ;; when formatting latex fragments. Originally it was part of the
3213 ;; LaTeX exporter, which is why the name includes "export".
3230 )
3231 "Alist of default packages to be inserted in the header.
3232 Change this only if one of the packages here causes an incompatibility
3233 with another package you are using.
3234 The packages in this list are needed by one part or another of Org-mode
3235 to function properly.
3237 - inputenc, fontenc: for basic font and character selection
3238 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3239 for interpreting the entities in `org-entities'. You can skip some of these
3240 packages if you don't use any of the symbols in it.
3241 - graphicx: for including images
3242 - float, wrapfig: for figure placement
3243 - longtable: for long tables
3244 - hyperref: for cross references
3246 Therefore you should not modify this variable unless you know what you
3247 are doing. The one reason to change it anyway is that you might be loading
3248 some other package that conflicts with one of the default packages.
3250 If SNIPPET-FLAG is t, the package also needs to be included when
3251 compiling LaTeX snippets into images for inclusion into HTML."
3264 "Alist of packages to be inserted in every LaTeX header.
3265 These will be inserted after `org-export-latex-default-packages-alist'.
3267 SNIPPET-FLAG, when t, indicates that this package is also needed when
3268 turning LaTeX snippets into images for inclusion into HTML.
3269 Make sure that you only list packages here which:
3270 - you want in every file
3271 - do not conflict with the default packages in
3272 `org-export-latex-default-packages-alist'
3273 - do not conflict with the setup in `org-format-latex-header'."
3287 "Settings for Org-mode appearance."
3292 "Non-nil means fontify only the stars in each headline.
3293 When nil, the entire headline is fontified.
3294 Changing it requires restart of `font-lock-mode' to become effective
3295 also in regions already fontified."
3300 "Non-nil means hide the first N-1 stars in a headline.
3301 This works by using the face `org-hide' for these stars. This
3302 face is white for a light background, and black for a dark
3303 background. You may have to customize the face `org-hide' to
3304 make this work.
3305 Changing it requires restart of `font-lock-mode' to become effective
3306 also in regions already fontified.
3307 You may also set this on a per-file basis by adding one of the following
3308 lines to the buffer:
3310 #+STARTUP: hidestars
3311 #+STARTUP: showstars"
3316 "List of keywords that should be hidden when typed in the org buffer.
3317 For example, add #+TITLE to this list in order to make the
3318 document title appear in the buffer without the initial #+TITLE:
3319 keyword."
3327 "Non-nil means change the face of a headline if it is marked DONE.
3328 Normally, only the TODO/DONE keyword indicates the state of a headline.
3329 When this is non-nil, the headline after the keyword is set to the
3330 `org-headline-done' as an additional indication."
3335 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3336 Changing this variable requires a restart of Emacs to take effect."
3341 "Non-nil means fontify the whole line for headings.
3342 This is useful when setting a background color for the
3343 org-level-* faces."
3348 "Non-nil means fontify what is treated specially by the exporters."
3353 "Non-nil mean font-lock should hide the emphasis marker characters."
3358 "Non-nil means show entities as UTF8 characters.
3364 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3369 "Regular expression for matching emphasis.
3370 After a match, the match groups contain these elements:
3371 0 The match of the full regular expression, including the characters
3372 before and after the proper match
3373 1 The character before the proper match, or empty at beginning of line
3374 2 The proper match, including the leading and trailing markers
3375 3 The leading marker like * or /, indicating the type of highlighting
3376 4 The text between the emphasis markers, not including the markers
3383 "Set variable and compute the emphasis regular expression."
3387 org-emphasis-alist org-emphasis-regexp-components)
3399 ;; make sure special characters appear at the right position in the class
3411 ;; Make the regexp
3419 body1
3431 body1
3439 "Components used to build the regular expression for emphasis.
3440 This is a list with five entries. Terminology: In an emphasis string
3444 specify what is allowed/forbidden in each part:
3446 pre Chars allowed as prematch. Beginning of line will be allowed too.
3447 post Chars allowed as postmatch. End of line will be allowed too.
3448 border The chars *forbidden* as border characters.
3450 non-shy groups here, and don't allow newline here.
3451 newline The maximum number of newlines allowed in an emphasis exp.
3453 Use customize to modify this, or restart Emacs after changing it."
3472 )
3473 "Special syntax for emphasized text.
3474 Text starting and ending with a special character will be emphasized, for
3475 example *bold*, _underlined_ and /italic/. This variable sets the marker
3476 characters, the face to be used by font-lock for highlighting in Org-mode
3477 Emacs buffers, and the HTML tags to be used for this.
3478 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3479 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3480 Use customize to modify this, or restart Emacs after changing it."
3495 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3498 ;;; Miscellaneous options
3501 "Completion in Org-mode."
3506 "Non-nil means use ido completion wherever possible.
3507 Note that `ido-mode' must be active for this variable to be relevant.
3508 If you decide to turn this variable on, you might well want to turn off
3509 `org-outline-path-complete-in-steps'.
3510 See also `org-completion-use-iswitchb'."
3515 "Non-nil means use iswitchb completion wherever possible.
3516 Note that `iswitchb-mode' must be active for this variable to be relevant.
3517 If you decide to turn this variable on, you might well want to turn off
3518 `org-outline-path-complete-in-steps'.
3519 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3525 Normal means, no org-mode-specific context."
3529 ;;; Functions and variables from their packages
3530 ;; Declared here to avoid compiler warnings
3532 ;; XEmacs only
3538 ;; Emacs only
3541 ;; Various packages
3559 org-format-agenda-item "org-agenda"
3588 ;;; Autoload and prepare some org modules
3590 ;; Some table stuff that needs to be defined here, because it is used
3591 ;; by the functions setting up org-mode or checking for table context.
3604 "Detect the first line outside a table when searching from within it.
3607 ;; Autoload the functions in org-table.el that are needed by functions here.
3612 org-table-convert org-table-convert-region org-table-copy-down
3613 org-table-copy-region org-table-create
3614 org-table-create-or-convert-from-region
3615 org-table-create-with-table.el org-table-current-dline
3616 org-table-cut-region org-table-delete-column org-table-edit-field
3617 org-table-edit-formulas org-table-end org-table-eval-formula
3618 org-table-export org-table-field-info
3619 org-table-get-stored-formulas org-table-goto-column
3620 org-table-hline-and-move org-table-import org-table-insert-column
3621 org-table-insert-hline org-table-insert-row org-table-iterate
3622 org-table-justify-field-maybe org-table-kill-row
3623 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3624 org-table-move-column org-table-move-column-left
3625 org-table-move-column-right org-table-move-row
3626 org-table-move-row-down org-table-move-row-up
3627 org-table-next-field org-table-next-row org-table-paste-rectangle
3628 org-table-previous-field org-table-recalculate
3629 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3630 org-table-toggle-coordinate-overlays
3631 org-table-toggle-formula-debugger org-table-wrap-region
3632 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3633 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3634 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3637 "Return t if the cursor is inside an org-type table.
3638 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3643 org-table-line-regexp)))
3644 nil))
3648 "Return t if and only if we are at a table.el table."
3654 "If there is a table.el table nearby, recognize it and move into it."
3660 nil
3670 t
3675 t)
3676 nil)
3677 nil))
3680 "Return t if the cursor is inside a hline in a table."
3685 nil))
3690 "Apply FUNCTION to the start of all tables in the buffer."
3706 ;; Declare and autoload functions from org-exp.el & Co
3714 org-insert-export-options-template
3715 org-table-clean-before-export))
3718 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3719 org-export-region-as-ascii))
3722 org-replace-region-by-latex org-export-region-as-latex
3723 org-export-as-latex org-export-as-pdf
3724 org-export-as-pdf-and-open))
3727 org-export-as-html-batch org-export-as-html-to-buffer
3728 org-replace-region-by-html org-export-region-as-html
3729 org-export-as-html))
3732 org-replace-region-by-docbook org-export-region-as-docbook
3733 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3734 org-export-as-docbook))
3737 org-export-icalendar-all-agenda-files
3738 org-export-icalendar-combine-agenda-files))
3742 ;; Declare and autoload functions from org-agenda.el
3747 org-todo-list org-tags-view org-agenda-list-stuck-projects
3748 org-diary org-agenda-to-appt
3749 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3751 ;; Autoload org-remember
3756 org-remember-apply-template org-remember org-remember-handler)))
3761 org-capture-import-remember-templates)))
3763 ;; Autoload org-clock.el
3778 "Return non-nil if clock is currently running.
3779 The return value is actually the clock marker."
3784 "org-clock"
3786 org-clock-goto org-clock-sum org-clock-display
3787 org-clock-remove-overlays org-clock-report
3788 org-clocktable-shift org-dblock-write:clocktable
3789 org-get-clocktable org-resolve-clocks)))
3792 "If this is a CLOCK line, update it and return t.
3793 Otherwise, return nil."
3802 ts te h m s neg)
3805 nil)
3810 ;; The clock is running here
3831 t))))))
3834 "Check if the current buffer contains the running clock.
3835 If yes, offer to stop it and to save the buffer with the changes."
3844 "Check if this line starts a clock table, if yes, shift the time block."
3848 ;; Autoload org-timer.el
3852 "org-timer"
3854 org-timer-change-times-in-region
3855 org-timer-set-timer
3856 org-timer-reset-timers
3857 org-timer-show-remaining-time)))
3859 ;; Autoload org-feed.el
3863 "org-feed"
3867 ;; Autoload org-indent.el
3869 ;; Define the variable already here, to make sure we have it.
3871 "Non-nil if Org-Indent mode is enabled.
3876 "org-indent"
3879 ;; Autoload org-mobile.el
3883 "org-mobile"
3886 ;; Autoload archiving code
3887 ;; The stuff that is needed for cycling and tags has to be defined here.
3890 "Options concerning archiving in Org-mode."
3895 "The location where subtrees should be archived.
3897 The value of this variable is a string, consisting of two parts,
3898 separated by a double-colon. The first part is a filename and
3899 the second part is a headline.
3901 When the filename is omitted, archiving happens in the same file.
3902 %s in the filename will be replaced by the current file
3903 name (without the directory part). Archiving to a different file
3904 is useful to keep archived entries from contributing to the
3905 Org-mode Agenda.
3907 The archived entries will be filed as subtrees of the specified
3908 headline. When the headline is omitted, the subtrees are simply
3909 filed away at the end of the file, as top-level entries. Also in
3910 the heading you can use %s to represent the file name, this can be
3911 useful when using the same archive for a number of different files.
3913 Here are a few examples:
3915 If the current file is Projects.org, archive in file
3916 Projects.org_archive, as top-level trees. This is the default.
3919 Archive in the current file, under the top-level headline
3923 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3926 Archive in file ~/org/archive.org (absolute path), under headlines
3930 Archive in file ./basement (relative path), as level 3 trees
3933 You may set this option on a per-file basis by adding to the buffer a
3934 line like
3936 #+ARCHIVE: basement::** Finished Tasks
3938 You may also define it locally for a subtree by setting an ARCHIVE property
3939 in the entry. If such a property is found in an entry, or anywhere up
3940 the hierarchy, it will be used."
3945 "The tag that marks a subtree as archived.
3946 An archived subtree does not open during visibility cycling, and does
3947 not contribute to the agenda listings.
3948 After changing this, font-lock must be restarted in the relevant buffers to
3949 get the proper fontification."
3955 "Non-nil means the agenda will skip any items located in archived trees.
3956 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3957 variable is no longer recommended, you should leave it at the value t.
3958 Instead, use the key `v' to cycle the archives-mode in the agenda."
3964 "Non-nil means ignore archived trees when creating column view."
3970 "Non-nil means `org-cycle' will open archived trees.
3971 An archived tree is a tree marked with the tag ARCHIVE.
3972 When nil, archived trees will stay folded. You can still open them with
3973 normal outline commands like `show-all', but not with the cycling commands."
3979 "Non-nil means sparse tree construction shows matches in archived trees.
3980 When nil, matches in these trees are highlighted, but the trees are kept in
3981 collapsed state."
3987 "Re-hide all archived subtrees after a visibility state change."
3998 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4001 "Cycle subtree even if it is archived."
4008 "Re-hide all archived subtrees after a visibility state change."
4023 flag)))
4030 org-archive-to-archive-sibling org-toggle-archive-tag
4031 org-archive-subtree-default
4032 org-archive-subtree-default-with-confirmation)))
4034 ;; Autoload Column View Code
4042 org-columns-compute org-agenda-columns org-columns-remove-overlays
4045 ;; Autoload ID code
4053 org-id-get-with-outline-path-completion
4054 org-id-get-with-outline-drilling org-id-store-link
4055 org-id-goto org-id-find org-id-store-link))
4057 ;; Autoload Plotting Code
4062 ;;; Variables for pre-computed regular expressions, all buffer local
4080 "Matches a headline and puts everything into groups:
4081 group 1: the stars
4082 group 2: The todo keyword, maybe
4083 group 3: Priority cookie
4084 group 4: True headline
4088 "Printf format to make regexp to match an exact headline.
4089 This regexp will match the headline of any node which hase the exact
4090 headline text that is put into the format, but may have any TODO state,
4094 "Matches a headline and puts TODO state into group 2 if present.
4149 "Regular expression to match a plain time or time range.
4150 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4151 groups carry important information:
4152 0 the full match
4153 1 the first time, range or not
4161 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4162 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4163 groups carry important information:
4164 0 the full match
4165 7 hours of duration
4174 "Regular expression to match a timestamp time or time range.
4175 After a match, the following groups carry important information:
4176 0 the full match
4177 1 date plus weekday, for back referencing to make sure both times are on the same day
4178 2 the first time, range or not
4233 "Variable associated with STARTUP options for org-mode.
4234 Each element is a list of three items: The startup options as written
4235 in the #+STARTUP line, the corresponding variable, and the value to
4236 set this variable to if the option is found. An optional forth element PUSH
4240 "Precompute regular expressions for current buffer."
4260 kwds kws0 kwsa key log value cat arch tags const links hw dws
4261 tail sep kws1 prio props ftags drawers beamer-p
4283 ;; general TODO-like setup
4295 links)))
4301 props)))
4306 ftags
4316 l var val)
4346 ))))
4363 ;; Process the TODO keywords
4365 ;; Use the global values as if they had been given locally.
4377 kws)))
4380 kwsa nil
4383 ;; 1 2
4391 kw)
4393 kws0)
4410 ;; Process the constants
4418 ;; Process the tags.
4429 tgs))
4437 ;; Compute the regular expressions and other local variables
4445 org-drawer-regexp
4449 org-not-done-keywords
4451 org-todo-regexp
4454 org-not-done-regexp
4458 org-not-done-heading-regexp
4462 org-todo-line-regexp
4466 org-complex-heading-regexp
4471 org-complex-heading-regexp-format
4480 org-nl-done-regexp
4484 org-todo-line-tags-regexp
4489 org-looking-at-done-regexp
4494 org-deadline-time-regexp
4496 org-deadline-line-regexp
4498 org-scheduled-regexp
4500 org-scheduled-time-regexp
4502 org-closed-time-regexp
4504 org-keyword-time-regexp
4510 org-keyword-time-not-clock-regexp
4516 org-maybe-keyword-time-regexp
4522 org-planning-or-clock-line-re
4527 org-all-time-keywords
4530 org-clock-string org-closed-string))
4531 )
4536 "Return the contents of FILE, as a string."
4550 "Extract the log state setting from a TODO keyword string.
4564 "Remove a pair of parenthesis at the end of each string in LIST."
4568 x))
4569 list))
4572 "Assign fast keys to a keyword-key alist.
4573 Respect keys that are already there."
4591 ;;; Some variables used in various places
4598 "Function to be called when `C-c C-c' is used.
4602 ;; FIXME: Occasionally check by commenting these, to make sure
4603 ;; no other functions uses these, forgetting to let-bind them.
4608 ;; Defined somewhere in this file, but used before definition.
4614 ;;;; Define the Org-mode
4617 (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"))
4620 ;; We use a before-change function to check if a table might need
4621 ;; an update.
4623 "Indicates that a table might need an update.
4624 This variable is set by `org-before-change-function'.
4627 "Every change indicates that a table might need an update."
4638 ;;;###autoload
4640 "Outline-based notes management and organizer, alias
4643 Org-mode develops organizational tasks around a NOTES file which
4644 contains information about projects as plain text. Org-mode is
4645 implemented on top of outline-mode, which is ideal to keep the content
4646 of large files well structured. It supports ToDo items, deadlines and
4647 time stamps, which magically appear in the diary listing of the Emacs
4648 calendar. Tables are easily created with a built-in table editor.
4649 Plain text URL-like links connect to websites, emails (VM), Usenet
4650 messages (Gnus), BBDB entries, and any files related to the project.
4651 For printing and sharing of notes, an Org-mode file (or a part of it)
4652 can be exported as a structured ASCII or HTML file.
4654 The following commands are available:
4658 ;; Get rid of Outline menus, they are not needed
4659 ;; Need to do this here because define-derived-mode sets up
4660 ;; the keymap so late. Still, it is a waste to call this each time
4661 ;; we switch another buffer into org-mode.
4664 ;; Assume this is Greg's port, it uses easymenu
4689 org-display-table 4
4692 org-ellipsis)))
4697 ;; tag faces set outside customize.... force initialization.
4699 ;; Calc embedded
4705 ;; Activate before-change-function
4709 ;; Check for running clock before killing a buffer
4711 ;; Paragraphs and auto-filling
4715 ;; Beginning/end of defun
4718 ;; Make sure dependence stuff works reliably, even for users who set it
4719 ;; too late :-(
4731 ;; Comment characters
4735 ;; Align options lines
4737 'align-mode-rules-list
4742 ;; Imenu
4746 ;; Make isearch reveal context
4749 ;; Emacs 21 and XEmacs make use of the hook
4751 ;; Emacs 22 deals with this through a special variable
4755 ;; Turn on org-beamer-mode?
4758 ;; Setup the pcomplete hooks
4769 ;; If empty file that did not turn on org-mode automatically, make it to.
4794 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4804 "Return today date, considering `org-extend-today-until'."
4809 ;;;; Font-Lock stuff, including the activators
4840 "Regular expression used to analyze links.
4841 Here is what the match groups contain after a match:
4842 1: http:
4843 2: http
4844 3: path
4845 4: [desc]
4853 "Number of stacked braces for sub/superscript matching.
4854 This has to be set before loading org.el to be effective."
4859 "Create a regular expression which will match a balanced sexp.
4860 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4861 as single character strings.
4862 The regexp returned will match the entire expression including the
4863 delimiters. It will also define a single group which contains the
4864 match except for the outermost delimiters. The maximum depth of
4865 stacked delimiters is N. Escaping delimiters is not possible."
4894 "Update the link regular expressions.
4895 This should be called after the variable `org-link-types' has changed."
4899 org-link-re-with-space
4905 org-link-re-with-space2
4911 org-link-re-with-space3
4916 org-angle-link-re
4922 org-plain-link-re
4926 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
4927 org-bracket-link-regexp
4929 org-bracket-link-analytic-regexp
4937 org-bracket-link-analytic-regexp++
4945 org-any-link-re
4956 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4957 "Regular expression matching time strings for analysis.
4958 This one does not require the space after the date, so it can be used
4960 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4976 "Regular expression matching a time stamp or time stamp range.
4982 "Run through the buffer and add overlays to links."
4991 'face
5004 rtn))
5007 "Insert or change an emphasis, i.e. a font like bold or italic.
5008 If there is an active region, change that region to a new emphasis.
5009 If there is no region, just insert the marker characters and position
5010 the cursor between them.
5011 CHAR should be either the marker character, or the first character of the
5012 HTML tag associated with that emphasis. If CHAR is a space, the means
5013 to remove the emphasis of the selected region.
5014 If char is not given (for example in an interactive call) it
5015 will be prompted for."
5066 "Run through the buffer and add overlays to links."
5075 nil
5081 t)))))
5089 t)))
5092 "When non-nil, fontify code in code blocks."
5098 "Fontify #+ lines and blocks, in the correct ways."
5101 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5102 limit t)
5110 end end1 quoting block-type)
5113 ;; a single line of backend-specific content
5121 ; for backend-specific code
5122 t)
5124 ;; Truly a block
5136 beg end
5140 ; for end_src
5146 org-block)))
5147 ; end of source block
5153 t))
5166 ;; just any other in-buffer setting, but not indented
5170 t)
5178 t)
5186 "Run through the buffer and add overlays to links."
5194 t)))
5197 "Run through the buffer and add overlays to links."
5199 limit t)
5204 'keymap org-mouse-map
5205 'help-echo
5207 "Footnote definition"
5209 ))
5211 t)))
5214 "Run through the buffer and add overlays to bracketed links."
5218 ;; FIXME: above we should remove the escapes.
5219 ;; but that requires another match, protecting match data,
5220 ;; a lot of overhead for font-lock.
5227 ;; We need to remove the invisible property here. Table narrowing
5228 ;; may have made some of this invisible.
5246 t)))
5249 "Run through the buffer and add overlays to dates."
5261 t)))
5270 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5274 "Run through the buffer and add overlays to target matches."
5282 'keymap org-mouse-map
5286 t)))))
5289 "Find all radio targets in this file and update the regular expression."
5304 t)))
5311 ;; This should be with the exporter code, but we also use if for font-locking
5321 "Compute regular expression for stuff treated specially by exporters."
5328 org-latex-regexps)))
5356 org-entities)))
5360 org-latex-entities)
5361 nil))
5363 ))
5364 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5367 org-export-html-special-string-regexps)))
5372 ))))
5374 'org-latex-and-specials-regexp
5379 "Run through the buffer and add overlays to links."
5383 limit t))
5397 rtn)))
5400 "Restart `font-lock-mode', to force refontification."
5406 "Return a list of all targets in this file.
5407 With optional argument RADIO, only find radio targets."
5409 rtn)
5414 rtn)))
5417 "Make regular expression matching all strings in TARGETS.
5418 The regular expression finds the targets also if there is a line break
5419 between words."
5427 x)
5428 targets
5440 t)))
5443 "Compute the outline level of the heading at point.
5444 This function assumes that the cursor is at the beginning of a line matched
5445 by `outline-regexp'. Otherwise it returns garbage.
5446 If this is called at a normal headline, the level is the number of stars.
5447 Use `org-reduced-level' to remove the effect of `org-odd-levels'.
5448 For plain list items, if they are matched by `outline-regexp', this returns
5449 1000 plus the line indentation."
5458 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5465 "Functions that can manipulate `org-font-lock-extra-keywords'.
5466 This is calles after `org-font-lock-extra-keywords' is defined, but before
5467 it is installed to be used by font lock. This can be useful if something
5478 ;; Call the hook
5480 ;; Headlines
5487 ;; Table lines
5490 ;; Table internals
5495 ;; Drawers
5498 ;; Properties
5502 ;; Links
5513 ;; TODO lines
5516 ;; DONE
5522 nil)
5523 ;; Priorities
5525 ;; Tags
5527 ;; Special keywords
5532 ;; Emphasis
5537 ;; Checkboxes
5538 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5543 ;; Description list items
5546 ;; ARCHIVEd headings
5549 ;; Specials
5553 ;; Code
5555 ;; COMMENT
5560 ;; Blocks and meta lines
5562 )))
5565 ;; Now set the full font-lock-keywords
5572 "Toggle the composition display of entities as UTF8 characters."
5584 "Find an entity to fontify."
5590 limit t)
5602 nil))))
5605 "Fontify string S like in Org-mode."
5617 "Get the right face for match N in font-lock matching of headlines."
5630 "Get the right face for a TODO keyword KWD.
5631 If KWD is a number, get the corresponding match group."
5639 "Create a face list that inherits INHERIT, but sets the foreground color.
5640 When FACE-OR-COLOR is not a string, just return it."
5644 face-or-color)
5645 face-or-color))
5648 "Add the special tag faces."
5657 "Add the special priority faces."
5664 org-priority-faces)))
5669 "Get the right face for a TODO keyword KWD.
5670 If KWD is a number, get the corresponding match group."
5677 "Remove fontification and activation overlays from links."
5682 deactivate-mark buffer-file-name buffer-file-truename)
5685 beg end
5687 ;; also remove line-prefix and wrap-prefix properties
5689 invisible t intangible t
5690 line-prefix t wrap-prefix t
5691 org-no-flyspell t org-emphasis t)
5693 invisible t intangible t
5694 org-no-flyspell t org-emphasis t)))
5704 "Remove specific display properties that have been added by font lock.
5705 The will remove the raise properties that are used to show superscripts
5706 and subscripts."
5716 "Add raise properties to sub/superscripts."
5720 org-match-substring-regexp
5721 org-match-substring-with-braces-regexp)
5722 limit t)
5732 ;; FIXME: Should we go back one character here, for a_b^c
5733 ;; (goto-char (1- pos)) ;????????????????????
5735 t
5737 'display
5753 t)))))
5755 ;;;; Visibility cycling, including org-goto and indirect buffer
5757 ;;; Cycling
5764 ;;;###autoload
5769 "TAB-action and visibility cycling for Org-mode.
5771 This is the command invoked in Org-mode by the TAB key. Its main purpose
5772 is outline visibility cycling, but it also invokes other actions
5773 in special contexts.
5775 - When this function is called with a prefix argument, rotate the entire
5776 buffer through 3 states (global cycling)
5777 1. OVERVIEW: Show only top-level headlines.
5778 2. CONTENTS: Show all headlines of all levels, but no body text.
5779 3. SHOW ALL: Show everything.
5780 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5781 determined by the variable `org-startup-folded', and by any VISIBILITY
5782 properties in the buffer.
5783 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5784 including any drawers.
5786 - When inside a table, re-align the table and move to the next field.
5788 - When point is at the beginning of a headline, rotate the subtree started
5789 by this line through 3 different states (local cycling)
5790 1. FOLDED: Only the main headline is shown.
5791 2. CHILDREN: The main headline and the direct children are shown.
5792 From this state, you can move to one of the children
5793 and zoom in further.
5794 3. SUBTREE: Show the entire subtree, including body text.
5795 If there is no subtree, switch directly from CHILDREN to FOLDED.
5797 - When point is at the beginning of an empty headline and the variable
5798 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5799 of the headline by demoting and promoting it to likely levels. This
5800 speeds up creation document structure by pressing TAB once or several
5801 times right after creating a new headline.
5803 - When there is a numeric prefix, go up to a heading with level ARG, do
5804 a `show-subtree' and return to the previous cursor position. If ARG
5805 is negative, go up that many levels.
5807 - When point is not at the beginning of a headline, execute the global
5808 binding for TAB, which is re-indenting the line. See the option
5809 `org-cycle-emulate-tab' for details.
5811 - Special case: if point is at the beginning of the buffer and there is
5812 no headline in line 1, this function will act as if called with prefix arg
5813 (C-u TAB, same as S-TAB) also when called without prefix arg.
5814 But only if also the variable `org-cycle-global-at-bob' is t."
5824 org-inlinetask-min-level
5829 limit-level)))
5845 org-cycle-hook))
5849 ;; special case: use global cycling
5864 ;; Enter the table or move to the next field in the table
5881 ;; Toggle block visibility
5886 ;; Show-subtree, ARG levels up from here.
5898 ;; TAB emulation and template completion
5922 t
5931 "Do the global cycling action."
5935 ;; We just created the overview - now do table of contents
5936 ;; This can be slow in very large buffers, so indicate action
5946 ;; We just showed the table of contents - now show everything
5954 ;; Default action: go to overview
5962 "Do the local cycling action."
5964 ;; First, some boundaries
5971 ; XEmacs does not have `next-single-char-property-change'
5972 ; I'm not sure about Emacs 21.
5986 ;; if we're in a list, org-end-of-subtree is in fact org-end-of-item.
5995 ;; Find out what to do next and set `this-command'
5998 ;; Nothing is hidden behind this heading
6010 org-cycle-skip-children-state-if-no-children))))
6011 ;; Entire subtree is hidden in one line: children view
6025 ;; We just showed the children, or no children are there,
6026 ;; now show everything.
6033 ;; Default action: hide the subtree.
6040 ;;;###autoload
6042 "Cycle the global visibility. For details see `org-cycle'.
6044 With a numeric prefix, show all headlines up to that level."
6060 "Set the visibility required by startup options and properties."
6075 "Switch subtree visibilities according to :VISIBILITY: property."
6082 nil t)
6107 "Switch to overview mode, showing only top-level headlines.
6108 Really, this shows all headlines with level equal or greater than the level
6109 of the first headline in the buffer. This is important, because if the
6110 first headline is not level one, then (hide-sublevels 1) gives confusing
6111 results."
6122 "Show all headlines in the buffer, like a table of contents.
6123 With numerical argument N, show content up to level N."
6126 ;; Visit all headings and show their offspring
6133 t)
6142 "Adjust the window after a change in outline visibility.
6143 This function is the default value of the hook `org-cycle-hook'."
6153 "Remove outline overlays that do not contain non-white stuff."
6163 "Fix visibility issues after moving a subtree."
6164 ;; First, find a reasonable region to look at:
6165 ;; Start two siblings above, end three below
6183 ;; Properly fold already folded siblings
6194 "Show empty lines above all visible headlines.
6195 The region to be covered depends on STATE when called through
6196 `org-cycle-hook'. Lisp program can use t for STATE to get the
6197 entire buffer covered. Note that an empty line is only shown if there
6198 are at least `org-cycle-separator-lines' empty lines before the headline."
6208 beg end b e)
6232 ;; Never hide empty lines at the end of the file.
6242 "Move to the parent and re-show empty lines before visible headlines."
6248 "Return `org-agenda-files' list, plus all open org-mode files.
6249 This is useful for operations that need to scan all of a user's
6250 open and agenda-wise Org files."
6258 files))
6261 "Return the beginning position of the current entry."
6265 "Return the end position of the current entry."
6269 "Re-hide all drawers after a visibility state change."
6296 "Is the end of the current subtree visible?"
6301 "Move cursor to the first headline and recenter the headline.
6302 Optional argument N means put the headline into the Nth line of the window."
6308 ;;; Saving and restoring visibility
6311 "Return a list of the locations of all outline overlays.
6312 These are overlays with the `invisible' property value `outline'.
6313 The return value is a list of cons cells, with start and stop
6314 positions for each overlay.
6315 If USE-MARKERS is set, return the positions as markers."
6333 "Create visibility overlays for all positions in DATA.
6334 DATA should have been made by `org-outline-overlay-data'."
6343 data)))))
6345 ;;; Folding of blocks
6357 "Call FUNCTION at the head of all source blocks in the current buffer.
6358 Optional arguments START and END can be used to limit the range."
6370 "Toggle the visibility of all blocks in the current buffer."
6374 "Fold all blocks in the current buffer."
6380 "Unfold all blocks in the current buffer."
6386 "Toggle visibility of block at point."
6397 "Toggle the visibility of the current block."
6404 ov)
6420 ;; make the block accessible to isearch
6422 ov 'isearch-open-invisible
6433 ;; org-tab-after-check-for-cycling-hook
6435 ;; Remove overlays when changing major mode
6440 ;;; Org-goto
6446 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6462 nil)
6463 (org-defkey map "q" 'org-goto-quit)
6464 (org-defkey map "n" 'outline-next-visible-heading)
6465 (org-defkey map "p" 'outline-previous-visible-heading)
6466 (org-defkey map "f" 'outline-forward-same-level)
6467 (org-defkey map "b" 'outline-backward-same-level)
6468 (org-defkey map "u" 'outline-up-heading))
6469 (org-defkey map "/" 'org-occur)
6470 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6471 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6472 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6473 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6474 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6475 map))
6477 (defconst org-goto-help
6478 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6479 RET=jump to location [Q]uit and return to previous location
6480 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6482 (defvar org-goto-start-pos) ; dynamically scoped parameter
6484 ;; FIXME: Docstring does not mention both interfaces
6485 (defun org-goto (&optional alternative-interface)
6486 "Look up a different location in the current file, keeping current visibility.
6488 When you want look-up or go to a different location in a document, the
6489 fastest way is often to fold the entire buffer and then dive into the tree.
6490 This method has the disadvantage, that the previous location will be folded,
6491 which may not be what you want.
6493 This command works around this by showing a copy of the current buffer
6494 in an indirect buffer, in overview mode. You can dive into the tree in
6495 that copy, use org-occur and incremental search to find a location.
6496 When pressing RET or `Q', the command returns to the original buffer in
6497 which the visibility is still unchanged. After RET is will also jump to
6498 the location selected in the indirect buffer and expose the
6499 the headline hierarchy above."
6500 (interactive "P")
6501 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6502 (org-refile-use-outline-path t)
6503 (org-refile-target-verify-function nil)
6504 (interface
6505 (if (not alternative-interface)
6506 org-goto-interface
6507 (if (eq org-goto-interface 'outline)
6508 'outline-path-completion
6509 'outline)))
6510 (org-goto-start-pos (point))
6511 (selected-point
6512 (if (eq interface 'outline)
6513 (car (org-get-location (current-buffer) org-goto-help))
6514 (let ((pa (org-refile-get-location "Goto: ")))
6515 (org-refile-check-position pa)
6516 (nth 3 pa)))))
6517 (if selected-point
6518 (progn
6519 (org-mark-ring-push org-goto-start-pos)
6520 (goto-char selected-point)
6521 (if (or (org-invisible-p) (org-invisible-p2))
6522 (org-show-context 'org-goto)))
6523 (message "Quit"))))
6525 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6526 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6527 (defvar org-goto-local-auto-isearch-map) ; defined below
6529 (defun org-get-location (buf help)
6530 "Let the user select a location in the Org-mode buffer BUF.
6531 This function uses a recursive edit. It returns the selected position
6532 or nil."
6533 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6534 (isearch-hide-immediately nil)
6535 (isearch-search-fun-function
6536 (lambda () 'org-goto-local-search-headings))
6537 (org-goto-selected-point org-goto-exit-command)
6538 (pop-up-frames nil)
6539 (special-display-buffer-names nil)
6540 (special-display-regexps nil)
6541 (special-display-function nil))
6542 (save-excursion
6543 (save-window-excursion
6544 (delete-other-windows)
6545 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6546 (switch-to-buffer
6547 (condition-case nil
6548 (make-indirect-buffer (current-buffer) "*org-goto*")
6549 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6550 (with-output-to-temp-buffer "*Help*"
6551 (princ help))
6552 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6553 (setq buffer-read-only nil)
6554 (let ((org-startup-truncated t)
6555 (org-startup-folded nil)
6556 (org-startup-align-all-tables nil))
6557 (org-mode)
6558 (org-overview))
6559 (setq buffer-read-only t)
6560 (if (and (boundp 'org-goto-start-pos)
6561 (integer-or-marker-p org-goto-start-pos))
6562 (let ((org-show-hierarchy-above t)
6563 (org-show-siblings t)
6564 (org-show-following-heading t))
6565 (goto-char org-goto-start-pos)
6566 (and (org-invisible-p) (org-show-context)))
6567 (goto-char (point-min)))
6568 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6569 (message "Select location and press RET")
6570 (use-local-map org-goto-map)
6571 (recursive-edit)
6572 ))
6573 (kill-buffer "*org-goto*")
6574 (cons org-goto-selected-point org-goto-exit-command)))
6576 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6577 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6578 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6579 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6581 (defun org-goto-local-search-headings (string bound noerror)
6582 "Search and make sure that any matches are in headlines."
6583 (catch 'return
6584 (while (if isearch-forward
6585 (search-forward string bound noerror)
6586 (search-backward string bound noerror))
6587 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6588 (and (member :headline context)
6589 (not (member :tags context))))
6590 (throw 'return (point))))))
6592 (defun org-goto-local-auto-isearch ()
6593 "Start isearch."
6594 (interactive)
6595 (goto-char (point-min))
6596 (let ((keys (this-command-keys)))
6597 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6598 (isearch-mode t)
6599 (isearch-process-search-char (string-to-char keys)))))
6601 (defun org-goto-ret (&optional arg)
6602 "Finish `org-goto' by going to the new location."
6603 (interactive "P")
6604 (setq org-goto-selected-point (point)
6605 org-goto-exit-command 'return)
6606 (throw 'exit nil))
6608 (defun org-goto-left ()
6609 "Finish `org-goto' by going to the new location."
6610 (interactive)
6611 (if (org-on-heading-p)
6612 (progn
6613 (beginning-of-line 1)
6614 (setq org-goto-selected-point (point)
6615 org-goto-exit-command 'left)
6616 (throw 'exit nil))
6617 (error "Not on a heading")))
6619 (defun org-goto-right ()
6620 "Finish `org-goto' by going to the new location."
6621 (interactive)
6622 (if (org-on-heading-p)
6623 (progn
6624 (setq org-goto-selected-point (point)
6625 org-goto-exit-command 'right)
6626 (throw 'exit nil))
6627 (error "Not on a heading")))
6629 (defun org-goto-quit ()
6630 "Finish `org-goto' without cursor motion."
6631 (interactive)
6632 (setq org-goto-selected-point nil)
6633 (setq org-goto-exit-command 'quit)
6634 (throw 'exit nil))
6636 ;;; Indirect buffer display of subtrees
6638 (defvar org-indirect-dedicated-frame nil
6639 "This is the frame being used for indirect tree display.")
6640 (defvar org-last-indirect-buffer nil)
6642 (defun org-tree-to-indirect-buffer (&optional arg)
6643 "Create indirect buffer and narrow it to current subtree.
6644 With numerical prefix ARG, go up to this level and then take that tree.
6645 If ARG is negative, go up that many levels.
6646 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6647 indirect buffer previously made with this command, to avoid proliferation of
6648 indirect buffers. However, when you call the command with a \
6650 when `org-indirect-buffer-display' is `new-frame', the last buffer
6651 is kept so that you can work with several indirect buffers at the same time.
6652 If `org-indirect-buffer-display' is `dedicated-frame', the \
6654 requests that a new frame be made for the new buffer, so that the dedicated
6655 frame is not changed."
6656 (interactive "P")
6657 (let ((cbuf (current-buffer))
6658 (cwin (selected-window))
6659 (pos (point))
6660 beg end level heading ibuf)
6661 (save-excursion
6662 (org-back-to-heading t)
6663 (when (numberp arg)
6664 (setq level (org-outline-level))
6665 (if (< arg 0) (setq arg (+ level arg)))
6666 (while (> (setq level (org-outline-level)) arg)
6667 (outline-up-heading 1 t)))
6668 (setq beg (point)
6669 heading (org-get-heading))
6670 (org-end-of-subtree t t)
6671 (if (org-on-heading-p) (backward-char 1))
6672 (setq end (point)))
6673 (if (and (buffer-live-p org-last-indirect-buffer)
6674 (not (eq org-indirect-buffer-display 'new-frame))
6675 (not arg))
6676 (kill-buffer org-last-indirect-buffer))
6677 (setq ibuf (org-get-indirect-buffer cbuf)
6678 org-last-indirect-buffer ibuf)
6679 (cond
6680 ((or (eq org-indirect-buffer-display 'new-frame)
6681 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6682 (select-frame (make-frame))
6683 (delete-other-windows)
6684 (switch-to-buffer ibuf)
6685 (org-set-frame-title heading))
6686 ((eq org-indirect-buffer-display 'dedicated-frame)
6687 (raise-frame
6688 (select-frame (or (and org-indirect-dedicated-frame
6689 (frame-live-p org-indirect-dedicated-frame)
6690 org-indirect-dedicated-frame)
6691 (setq org-indirect-dedicated-frame (make-frame)))))
6692 (delete-other-windows)
6693 (switch-to-buffer ibuf)
6694 (org-set-frame-title (concat "Indirect: " heading)))
6695 ((eq org-indirect-buffer-display 'current-window)
6696 (switch-to-buffer ibuf))
6697 ((eq org-indirect-buffer-display 'other-window)
6698 (pop-to-buffer ibuf))
6699 (t (error "Invalid value")))
6700 (if (featurep 'xemacs)
6701 (save-excursion (org-mode) (turn-on-font-lock)))
6702 (narrow-to-region beg end)
6703 (show-all)
6704 (goto-char pos)
6705 (and (window-live-p cwin) (select-window cwin))))
6707 (defun org-get-indirect-buffer (&optional buffer)
6708 (setq buffer (or buffer (current-buffer)))
6709 (let ((n 1) (base (buffer-name buffer)) bname)
6710 (while (buffer-live-p
6711 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6712 (setq n (1+ n)))
6713 (condition-case nil
6714 (make-indirect-buffer buffer bname 'clone)
6715 (error (make-indirect-buffer buffer bname)))))
6717 (defun org-set-frame-title (title)
6718 "Set the title of the current frame to the string TITLE."
6719 ;; FIXME: how to name a single frame in XEmacs???
6720 (unless (featurep 'xemacs)
6721 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6723 ;;;; Structure editing
6725 ;;; Inserting headlines
6727 (defun org-previous-line-empty-p ()
6728 (save-excursion
6729 (and (not (bobp))
6730 (or (beginning-of-line 0) t)
6731 (save-match-data
6734 (defun org-insert-heading (&optional force-heading invisible-ok)
6735 "Insert a new heading or item with same depth at point.
6736 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6737 If point is at the beginning of a headline, insert a sibling before the
6738 current headline. If point is not at the beginning, split the line,
6739 create the new headline with the text in the current line after point
6740 \(but see also the variable `org-M-RET-may-split-line').
6742 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6743 This is important for non-interactive uses of the command."
6744 (interactive "P")
6745 (if (or (= (buffer-size) 0)
6746 (and (not (save-excursion
6747 (and (ignore-errors (org-back-to-heading invisible-ok))
6748 (org-on-heading-p))))
6749 (not (org-in-item-p))))
6750 (progn
6752 (run-hooks 'org-insert-heading-hook))
6753 (when (or force-heading (not (org-insert-item)))
6754 (let* ((empty-line-p nil)
6755 (level nil)
6756 (on-heading (org-on-heading-p))
6757 (head (save-excursion
6758 (condition-case nil
6759 (progn
6760 (org-back-to-heading invisible-ok)
6761 (when (and (not on-heading)
6762 (featurep 'org-inlinetask)
6763 (integerp org-inlinetask-min-level)
6764 (>= (length (match-string 0))
6765 org-inlinetask-min-level))
6766 ;; Find a heading level before the inline task
6767 (while (and (setq level (org-up-heading-safe))
6768 (>= level org-inlinetask-min-level)))
6769 (if (org-on-heading-p)
6770 (org-back-to-heading invisible-ok)
6771 (error "This should not happen")))
6772 (setq empty-line-p (org-previous-line-empty-p))
6773 (match-string 0))
6774 (error "*"))))
6775 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6776 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6777 pos hide-previous previous-pos)
6778 (cond
6779 ((and (org-on-heading-p) (bolp)
6780 (or (bobp)
6781 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6782 ;; insert before the current line
6783 (open-line (if blank 2 1)))
6784 ((and (bolp)
6785 (not org-insert-heading-respect-content)
6786 (or (bobp)
6787 (save-excursion
6788 (backward-char 1) (not (org-invisible-p)))))
6789 ;; insert right here
6790 nil)
6791 (t
6792 ;; somewhere in the line
6793 (save-excursion
6794 (setq previous-pos (point-at-bol))
6795 (end-of-line)
6796 (setq hide-previous (org-invisible-p)))
6797 (and org-insert-heading-respect-content (org-show-subtree))
6798 (let ((split
6799 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6800 (save-excursion
6801 (let ((p (point)))
6802 (goto-char (point-at-bol))
6803 (and (looking-at org-complex-heading-regexp)
6804 (> p (match-beginning 4)))))))
6805 tags pos)
6806 (cond
6807 (org-insert-heading-respect-content
6808 (org-end-of-subtree nil t)
6809 (when (featurep 'org-inlinetask)
6810 (while (and (not (eobp))
6812 (>= (length (match-string 1))
6813 org-inlinetask-min-level))
6814 (org-end-of-subtree nil t)))
6815 (or (bolp) (newline))
6816 (or (org-previous-line-empty-p)
6817 (and blank (newline)))
6818 (open-line 1))
6819 ((org-on-heading-p)
6820 (when hide-previous
6821 (show-children)
6822 (org-show-entry))
6824 (setq tags (and (match-end 2) (match-string 2)))
6825 (and (match-end 1)
6826 (delete-region (match-beginning 1) (match-end 1)))
6827 (setq pos (point-at-bol))
6828 (or split (end-of-line 1))
6829 (delete-horizontal-space)
6831 (buffer-substring (point-at-bol) (point)))
6832 (insert " "))
6833 (newline (if blank 2 1))
6834 (when tags
6835 (save-excursion
6836 (goto-char pos)
6837 (end-of-line 1)
6838 (insert " " tags)
6839 (org-set-tags nil 'align))))
6840 (t
6841 (or split (end-of-line 1))
6842 (newline (if blank 2 1)))))))
6843 (insert head) (just-one-space)
6844 (setq pos (point))
6845 (end-of-line 1)
6846 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6847 (when (and org-insert-heading-respect-content hide-previous)
6848 (save-excursion
6849 (goto-char previous-pos)
6850 (hide-subtree)))
6851 (run-hooks 'org-insert-heading-hook)))))
6853 (defun org-get-heading (&optional no-tags)
6854 "Return the heading of the current entry, without the stars."
6855 (save-excursion
6856 (org-back-to-heading t)
6857 (if (looking-at
6858 (if no-tags
6861 (match-string 1) "")))
6863 (defun org-heading-components ()
6864 "Return the components of the current heading.
6865 This is a list with the following elements:
6866 - the level as an integer
6867 - the reduced level, different if `org-odd-levels-only' is set.
6868 - the TODO keyword, or nil
6869 - the priority character, like ?A, or nil if no priority is given
6870 - the headline text itself, or the tags string if no headline text
6871 - the tags string, or nil."
6872 (save-excursion
6873 (org-back-to-heading t)
6874 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6875 (list (length (match-string 1))
6876 (org-reduced-level (length (match-string 1)))
6877 (org-match-string-no-properties 2)
6878 (and (match-end 3) (aref (match-string 3) 2))
6879 (org-match-string-no-properties 4)
6880 (org-match-string-no-properties 5)))))
6882 (defun org-get-entry ()
6883 "Get the entry text, after heading, entire subtree."
6884 (save-excursion
6885 (org-back-to-heading t)
6886 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6888 (defun org-insert-heading-after-current ()
6889 "Insert a new heading with same level as current, after current subtree."
6890 (interactive)
6891 (org-back-to-heading)
6892 (org-insert-heading)
6893 (org-move-subtree-down)
6894 (end-of-line 1))
6896 (defun org-insert-heading-respect-content ()
6897 (interactive)
6898 (let ((org-insert-heading-respect-content t))
6899 (org-insert-heading t)))
6901 (defun org-insert-todo-heading-respect-content (&optional force-state)
6902 (interactive "P")
6903 (let ((org-insert-heading-respect-content t))
6904 (org-insert-todo-heading force-state t)))
6906 (defun org-insert-todo-heading (arg &optional force-heading)
6907 "Insert a new heading with the same level and TODO state as current heading.
6908 If the heading has no TODO state, or if the state is DONE, use the first
6909 state (TODO by default). Also with prefix arg, force first state."
6910 (interactive "P")
6911 (when (or force-heading (not (org-insert-item 'checkbox)))
6912 (org-insert-heading force-heading)
6913 (save-excursion
6914 (org-back-to-heading)
6915 (outline-previous-heading)
6916 (looking-at org-todo-line-regexp))
6917 (let*
6918 ((new-mark-x
6919 (if (or arg
6920 (not (match-beginning 2))
6921 (member (match-string 2) org-done-keywords))
6922 (car org-todo-keywords-1)
6923 (match-string 2)))
6924 (new-mark
6925 (or
6926 (run-hook-with-args-until-success
6927 'org-todo-get-default-hook new-mark-x nil)
6928 new-mark-x)))
6929 (beginning-of-line 1)
6931 (if org-treat-insert-todo-heading-as-state-change
6932 (org-todo new-mark)
6933 (insert new-mark " "))))
6934 (when org-provide-todo-statistics
6935 (org-update-parent-todo-statistics))))
6937 (defun org-insert-subheading (arg)
6938 "Insert a new subheading and demote it.
6939 Works for outline headings and for plain lists alike."
6940 (interactive "P")
6941 (org-insert-heading arg)
6942 (cond
6943 ((org-on-heading-p) (org-do-demote))
6944 ((org-at-item-p) (org-indent-item))))
6946 (defun org-insert-todo-subheading (arg)
6947 "Insert a new subheading with TODO keyword or checkbox and demote it.
6948 Works for outline headings and for plain lists alike."
6949 (interactive "P")
6950 (org-insert-todo-heading arg)
6951 (cond
6952 ((org-on-heading-p) (org-do-demote))
6953 ((org-at-item-p) (org-indent-item))))
6955 ;;; Promotion and Demotion
6957 (defvar org-after-demote-entry-hook nil
6958 "Hook run after an entry has been demoted.
6959 The cursor will be at the beginning of the entry.
6960 When a subtree is being demoted, the hook will be called for each node.")
6962 (defvar org-after-promote-entry-hook nil
6963 "Hook run after an entry has been promoted.
6964 The cursor will be at the beginning of the entry.
6965 When a subtree is being promoted, the hook will be called for each node.")
6967 (defun org-promote-subtree ()
6968 "Promote the entire subtree.
6969 See also `org-promote'."
6970 (interactive)
6971 (save-excursion
6972 (org-map-tree 'org-promote))
6973 (org-fix-position-after-promote))
6975 (defun org-demote-subtree ()
6976 "Demote the entire subtree. See `org-demote'.
6977 See also `org-promote'."
6978 (interactive)
6979 (save-excursion
6980 (org-map-tree 'org-demote))
6981 (org-fix-position-after-promote))
6984 (defun org-do-promote ()
6985 "Promote the current heading higher up the tree.
6986 If the region is active in `transient-mark-mode', promote all headings
6987 in the region."
6988 (interactive)
6989 (save-excursion
6990 (if (org-region-active-p)
6991 (org-map-region 'org-promote (region-beginning) (region-end))
6992 (org-promote)))
6993 (org-fix-position-after-promote))
6995 (defun org-do-demote ()
6996 "Demote the current heading lower down the tree.
6997 If the region is active in `transient-mark-mode', demote all headings
6998 in the region."
6999 (interactive)
7000 (save-excursion
7001 (if (org-region-active-p)
7002 (org-map-region 'org-demote (region-beginning) (region-end))
7003 (org-demote)))
7004 (org-fix-position-after-promote))
7006 (defun org-fix-position-after-promote ()
7007 "Make sure that after pro/demotion cursor position is right."
7008 (let ((pos (point)))
7009 (when (save-excursion
7010 (beginning-of-line 1)
7011 (looking-at org-todo-line-regexp)
7012 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7013 (cond ((eobp) (insert " "))
7014 ((eolp) (insert " "))
7015 ((equal (char-after) ?\ ) (forward-char 1))))))
7017 (defun org-current-level ()
7018 "Return the level of the current entry, or nil if before the first headline.
7019 The level is the number of stars at the beginning of the headline."
7020 (save-excursion
7021 (condition-case nil
7022 (progn
7023 (org-back-to-heading t)
7024 (funcall outline-level))
7025 (error nil))))
7027 (defun org-get-previous-line-level ()
7028 "Return the outline depth of the last headline before the current line.
7029 Returns 0 for the first headline in the buffer, and nil if before the
7030 first headline."
7031 (let ((current-level (org-current-level))
7032 (prev-level (when (> (line-number-at-pos) 1)
7033 (save-excursion
7034 (beginning-of-line 0)
7035 (org-current-level)))))
7036 (cond ((null current-level) nil) ; Before first headline
7037 ((null prev-level) 0) ; At first headline
7038 (prev-level))))
7040 (defun org-reduced-level (l)
7041 "Compute the effective level of a heading.
7042 This takes into account the setting of `org-odd-levels-only'."
7043 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
7045 (defun org-level-increment ()
7046 "Return the number of stars that will be added or removed at a
7047 time to headlines when structure editing, based on the value of
7048 `org-odd-levels-only'."
7049 (if org-odd-levels-only 2 1))
7051 (defun org-get-valid-level (level &optional change)
7052 "Rectify a level change under the influence of `org-odd-levels-only'
7053 LEVEL is a current level, CHANGE is by how much the level should be
7054 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7055 even level numbers will become the next higher odd number."
7056 (if org-odd-levels-only
7057 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7058 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7059 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7060 (max 1 (+ level (or change 0)))))
7062 (if (boundp 'define-obsolete-function-alias)
7063 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7064 (define-obsolete-function-alias 'org-get-legal-level
7065 'org-get-valid-level)
7066 (define-obsolete-function-alias 'org-get-legal-level
7067 'org-get-valid-level "23.1")))
7069 (defun org-promote ()
7070 "Promote the current heading higher up the tree.
7071 If the region is active in `transient-mark-mode', promote all headings
7072 in the region."
7073 (org-back-to-heading t)
7074 (let* ((level (save-match-data (funcall outline-level)))
7075 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7076 (diff (abs (- level (length up-head) -1))))
7077 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7078 (replace-match up-head nil t)
7079 ;; Fixup tag positioning
7080 (and org-auto-align-tags (org-set-tags nil t))
7081 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7082 (run-hooks 'org-after-promote-entry-hook)))
7084 (defun org-demote ()
7085 "Demote the current heading lower down the tree.
7086 If the region is active in `transient-mark-mode', demote all headings
7087 in the region."
7088 (org-back-to-heading t)
7089 (let* ((level (save-match-data (funcall outline-level)))
7090 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7091 (diff (abs (- level (length down-head) -1))))
7092 (replace-match down-head nil t)
7093 ;; Fixup tag positioning
7094 (and org-auto-align-tags (org-set-tags nil t))
7095 (if org-adapt-indentation (org-fixup-indentation diff))
7096 (run-hooks 'org-after-demote-entry-hook)))
7098 (defun org-cycle-level ()
7099 "Cycle the level of an empty headline through possible states.
7100 This goes first to child, then to parent, level, then up the hierarchy.
7101 After top level, it switches back to sibling level."
7102 (interactive)
7103 (let ((org-adapt-indentation nil))
7104 (when (org-point-at-end-of-empty-headline)
7105 (setq this-command 'org-cycle-level) ; Only needed for caching
7106 (let ((cur-level (org-current-level))
7107 (prev-level (org-get-previous-line-level)))
7108 (cond
7109 ;; If first headline in file, promote to top-level.
7110 ((= prev-level 0)
7111 (loop repeat (/ (- cur-level 1) (org-level-increment))
7112 do (org-do-promote)))
7113 ;; If same level as prev, demote one.
7114 ((= prev-level cur-level)
7115 (org-do-demote))
7116 ;; If parent is top-level, promote to top level if not already.
7117 ((= prev-level 1)
7118 (loop repeat (/ (- cur-level 1) (org-level-increment))
7119 do (org-do-promote)))
7120 ;; If top-level, return to prev-level.
7121 ((= cur-level 1)
7122 (loop repeat (/ (- prev-level 1) (org-level-increment))
7123 do (org-do-demote)))
7124 ;; If less than prev-level, promote one.
7125 ((< cur-level prev-level)
7126 (org-do-promote))
7127 ;; If deeper than prev-level, promote until higher than
7128 ;; prev-level.
7129 ((> cur-level prev-level)
7130 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7131 do (org-do-promote))))
7132 t))))
7134 (defun org-map-tree (fun)
7135 "Call FUN for every heading underneath the current one."
7136 (org-back-to-heading)
7137 (let ((level (funcall outline-level)))
7138 (save-excursion
7139 (funcall fun)
7140 (while (and (progn
7141 (outline-next-heading)
7142 (> (funcall outline-level) level))
7143 (not (eobp)))
7144 (funcall fun)))))
7146 (defun org-map-region (fun beg end)
7147 "Call FUN for every heading between BEG and END."
7148 (let ((org-ignore-region t))
7149 (save-excursion
7150 (setq end (copy-marker end))
7151 (goto-char beg)
7152 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
7153 (< (point) end))
7154 (funcall fun))
7155 (while (and (progn
7156 (outline-next-heading)
7157 (< (point) end))
7158 (not (eobp)))
7159 (funcall fun)))))
7161 (defun org-fixup-indentation (diff)
7162 "Change the indentation in the current entry by DIFF.
7163 However, if any line in the current entry has no indentation, or if it
7164 would end up with no indentation after the change, nothing at all is done."
7165 (save-excursion
7166 (let ((end (save-excursion (outline-next-heading)
7167 (point-marker)))
7168 (prohibit (if (> diff 0)
7171 col)
7172 (unless (save-excursion (end-of-line 1)
7173 (re-search-forward prohibit end t))
7174 (while (and (< (point) end)
7176 (goto-char (match-end 0))
7177 (setq col (current-column))
7178 (if (< diff 0) (replace-match ""))
7179 (org-indent-to-column (+ diff col))))
7180 (move-marker end nil))))
7182 (defun org-convert-to-odd-levels ()
7183 "Convert an org-mode file with all levels allowed to one with odd levels.
7184 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7185 level 5 etc."
7186 (interactive)
7187 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7188 (let ((outline-regexp org-outline-regexp)
7189 (outline-level 'org-outline-level)
7190 (org-odd-levels-only nil) n)
7191 (save-excursion
7192 (goto-char (point-min))
7194 (setq n (- (length (match-string 0)) 2))
7195 (while (>= (setq n (1- n)) 0)
7196 (org-demote))
7197 (end-of-line 1))))))
7199 (defun org-convert-to-oddeven-levels ()
7200 "Convert an org-mode file with only odd levels to one with odd/even levels.
7201 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7202 file contains a section with an even level, conversion would
7203 destroy the structure of the file. An error is signaled in this
7204 case."
7205 (interactive)
7206 (goto-char (point-min))
7207 ;; First check if there are no even levels
7209 (org-show-context t)
7210 (error "Not all levels are odd in this file. Conversion not possible"))
7211 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7212 (let ((outline-regexp org-outline-regexp)
7213 (outline-level 'org-outline-level)
7214 (org-odd-levels-only nil) n)
7215 (save-excursion
7216 (goto-char (point-min))
7218 (setq n (/ (1- (length (match-string 0))) 2))
7219 (while (>= (setq n (1- n)) 0)
7220 (org-promote))
7221 (end-of-line 1))))))
7223 (defun org-tr-level (n)
7224 "Make N odd if required."
7225 (if org-odd-levels-only (1+ (/ n 2)) n))
7227 ;;; Vertical tree motion, cutting and pasting of subtrees
7229 (defun org-move-subtree-up (&optional arg)
7230 "Move the current subtree up past ARG headlines of the same level."
7231 (interactive "p")
7232 (org-move-subtree-down (- (prefix-numeric-value arg))))
7234 (defun org-move-subtree-down (&optional arg)
7235 "Move the current subtree down past ARG headlines of the same level."
7236 (interactive "p")
7237 (setq arg (prefix-numeric-value arg))
7238 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7239 'org-get-last-sibling))
7240 (ins-point (make-marker))
7241 (cnt (abs arg))
7242 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7243 ;; Select the tree
7244 (org-back-to-heading)
7245 (setq beg0 (point))
7246 (save-excursion
7247 (setq ne-beg (org-back-over-empty-lines))
7248 (setq beg (point)))
7249 (save-match-data
7250 (save-excursion (outline-end-of-heading)
7251 (setq folded (org-invisible-p)))
7252 (outline-end-of-subtree))
7253 (outline-next-heading)
7254 (setq ne-end (org-back-over-empty-lines))
7255 (setq end (point))
7256 (goto-char beg0)
7257 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7258 ;; include less whitespace
7259 (save-excursion
7260 (goto-char beg)
7261 (forward-line (- ne-beg ne-end))
7262 (setq beg (point))))
7263 ;; Find insertion point, with error handling
7264 (while (> cnt 0)
7265 (or (and (funcall movfunc) (looking-at outline-regexp))
7266 (progn (goto-char beg0)
7267 (error "Cannot move past superior level or buffer limit")))
7268 (setq cnt (1- cnt)))
7269 (if (> arg 0)
7270 ;; Moving forward - still need to move over subtree
7271 (progn (org-end-of-subtree t t)
7272 (save-excursion
7273 (org-back-over-empty-lines)
7274 (or (bolp) (newline)))))
7275 (setq ne-ins (org-back-over-empty-lines))
7276 (move-marker ins-point (point))
7277 (setq txt (buffer-substring beg end))
7278 (org-save-markers-in-region beg end)
7279 (delete-region beg end)
7280 (org-remove-empty-overlays-at beg)
7281 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7282 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7284 (let ((bbb (point)))
7285 (insert-before-markers txt)
7286 (org-reinstall-markers-in-region bbb)
7287 (move-marker ins-point bbb))
7289 (setq ins-end (point))
7290 (goto-char ins-point)
7291 (org-skip-whitespace)
7292 (when (and (< arg 0)
7293 (org-first-sibling-p)
7294 (> ne-ins ne-beg))
7295 ;; Move whitespace back to beginning
7296 (save-excursion
7297 (goto-char ins-end)
7298 (let ((kill-whole-line t))
7299 (kill-line (- ne-ins ne-beg)) (point)))
7301 (move-marker ins-point nil)
7302 (if folded
7303 (hide-subtree)
7304 (org-show-entry)
7305 (show-children)
7306 (org-cycle-hide-drawers 'children))
7307 (org-clean-visibility-after-subtree-move)))
7309 (defvar org-subtree-clip ""
7310 "Clipboard for cut and paste of subtrees.
7311 This is actually only a copy of the kill, because we use the normal kill
7312 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7314 (defvar org-subtree-clip-folded nil
7315 "Was the last copied subtree folded?
7316 This is used to fold the tree back after pasting.")
7318 (defun org-cut-subtree (&optional n)
7319 "Cut the current subtree into the clipboard.
7320 With prefix arg N, cut this many sequential subtrees.
7321 This is a short-hand for marking the subtree and then cutting it."
7322 (interactive "p")
7323 (org-copy-subtree n 'cut))
7325 (defun org-copy-subtree (&optional n cut force-store-markers)
7326 "Cut the current subtree into the clipboard.
7327 With prefix arg N, cut this many sequential subtrees.
7328 This is a short-hand for marking the subtree and then copying it.
7329 If CUT is non-nil, actually cut the subtree.
7330 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7331 of some markers in the region, even if CUT is non-nil. This is
7332 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7333 (interactive "p")
7334 (let (beg end folded (beg0 (point)))
7335 (if (interactive-p)
7336 (org-back-to-heading nil) ; take what looks like a subtree
7337 (org-back-to-heading t)) ; take what is really there
7338 (org-back-over-empty-lines)
7339 (setq beg (point))
7341 (save-match-data
7342 (save-excursion (outline-end-of-heading)
7343 (setq folded (org-invisible-p)))
7344 (condition-case nil
7345 (org-forward-same-level (1- n) t)
7346 (error nil))
7347 (org-end-of-subtree t t))
7348 (org-back-over-empty-lines)
7349 (setq end (point))
7350 (goto-char beg0)
7351 (when (> end beg)
7352 (setq org-subtree-clip-folded folded)
7353 (when (or cut force-store-markers)
7354 (org-save-markers-in-region beg end))
7355 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7356 (setq org-subtree-clip (current-kill 0))
7357 (message "%s: Subtree(s) with %d characters"
7358 (if cut "Cut" "Copied")
7359 (length org-subtree-clip)))))
7361 (defun org-paste-subtree (&optional level tree for-yank)
7362 "Paste the clipboard as a subtree, with modification of headline level.
7363 The entire subtree is promoted or demoted in order to match a new headline
7364 level.
7366 If the cursor is at the beginning of a headline, the same level as
7367 that headline is used to paste the tree
7369 If not, the new level is derived from the *visible* headings
7370 before and after the insertion point, and taken to be the inferior headline
7371 level of the two. So if the previous visible heading is level 3 and the
7372 next is level 4 (or vice versa), level 4 will be used for insertion.
7373 This makes sure that the subtree remains an independent subtree and does
7374 not swallow low level entries.
7376 You can also force a different level, either by using a numeric prefix
7377 argument, or by inserting the heading marker by hand. For example, if the
7380 If optional TREE is given, use this text instead of the kill ring.
7382 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7383 move back over whitespace before inserting, and move point to the end of
7384 the inserted text when done."
7385 (interactive "P")
7386 (setq tree (or tree (and kill-ring (current-kill 0))))
7387 (unless (org-kill-is-subtree-p tree)
7388 (error "%s"
7389 (substitute-command-keys
7391 (let* ((visp (not (org-invisible-p)))
7392 (txt tree)
7397 (old-level (if (string-match ^re txt)
7398 (- (match-end 0) (match-beginning 0) 1)
7399 -1))
7400 (force-level (cond (level (prefix-numeric-value level))
7402 (string-match
7403 ^re_ (buffer-substring
7404 (point-at-bol) (point))))
7405 (- (match-end 1) (match-beginning 1)))
7406 ((and (bolp)
7407 (looking-at org-outline-regexp))
7408 (- (match-end 0) (point) 1))
7409 (t nil)))
7410 (previous-level (save-excursion
7411 (condition-case nil
7412 (progn
7413 (outline-previous-visible-heading 1)
7414 (if (looking-at re)
7415 (- (match-end 0) (match-beginning 0) 1)
7416 1))
7417 (error 1))))
7418 (next-level (save-excursion
7419 (condition-case nil
7420 (progn
7421 (or (looking-at outline-regexp)
7422 (outline-next-visible-heading 1))
7423 (if (looking-at re)
7424 (- (match-end 0) (match-beginning 0) 1)
7425 1))
7426 (error 1))))
7427 (new-level (or force-level (max previous-level next-level)))
7428 (shift (if (or (= old-level -1)
7429 (= new-level -1)
7430 (= old-level new-level))
7431 0
7432 (- new-level old-level)))
7433 (delta (if (> shift 0) -1 1))
7434 (func (if (> shift 0) 'org-demote 'org-promote))
7435 (org-odd-levels-only nil)
7436 beg end newend)
7437 ;; Remove the forced level indicator
7438 (if force-level
7439 (delete-region (point-at-bol) (point)))
7440 ;; Paste
7441 (beginning-of-line 1)
7442 (unless for-yank (org-back-over-empty-lines))
7443 (setq beg (point))
7444 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7445 (insert-before-markers txt)
7447 (setq newend (point))
7448 (org-reinstall-markers-in-region beg)
7449 (setq end (point))
7450 (goto-char beg)
7452 (setq beg (point))
7453 (if (and (org-invisible-p) visp)
7454 (save-excursion (outline-show-heading)))
7455 ;; Shift if necessary
7456 (unless (= shift 0)
7457 (save-restriction
7458 (narrow-to-region beg end)
7459 (while (not (= shift 0))
7460 (org-map-region func (point-min) (point-max))
7461 (setq shift (+ delta shift)))
7462 (goto-char (point-min))
7463 (setq newend (point-max))))
7464 (when (or (interactive-p) for-yank)
7465 (message "Clipboard pasted as level %d subtree" new-level))
7466 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7467 kill-ring
7468 (eq org-subtree-clip (current-kill 0))
7469 org-subtree-clip-folded)
7470 ;; The tree was folded before it was killed/copied
7471 (hide-subtree))
7472 (and for-yank (goto-char newend))))
7474 (defun org-kill-is-subtree-p (&optional txt)
7475 "Check if the current kill is an outline subtree, or a set of trees.
7476 Returns nil if kill does not start with a headline, or if the first
7477 headline level is not the largest headline level in the tree.
7478 So this will actually accept several entries of equal levels as well,
7479 which is OK for `org-paste-subtree'.
7480 If optional TXT is given, check this string instead of the current kill."
7481 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7482 (start-level (and kill
7485 kill)
7486 (- (match-end 2) (match-beginning 2) 1)))
7487 (re (concat "^" org-outline-regexp))
7488 (start (1+ (or (match-beginning 2) -1))))
7489 (if (not start-level)
7490 (progn
7491 nil) ;; does not even start with a heading
7492 (catch 'exit
7493 (while (setq start (string-match re kill (1+ start)))
7494 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7495 (throw 'exit nil)))
7496 t))))
7498 (defvar org-markers-to-move nil
7499 "Markers that should be moved with a cut-and-paste operation.
7500 Those markers are stored together with their positions relative to
7501 the start of the region.")
7503 (defun org-save-markers-in-region (beg end)
7504 "Check markers in region.
7505 If these markers are between BEG and END, record their position relative
7506 to BEG, so that after moving the block of text, we can put the markers back
7507 into place.
7508 This function gets called just before an entry or tree gets cut from the
7509 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7510 called immediately, to move the markers with the entries."
7511 (setq org-markers-to-move nil)
7512 (when (featurep 'org-clock)
7513 (org-clock-save-markers-for-cut-and-paste beg end))
7514 (when (featurep 'org-agenda)
7515 (org-agenda-save-markers-for-cut-and-paste beg end)))
7517 (defun org-check-and-save-marker (marker beg end)
7518 "Check if MARKER is between BEG and END.
7519 If yes, remember the marker and the distance to BEG."
7520 (when (and (marker-buffer marker)
7521 (equal (marker-buffer marker) (current-buffer)))
7522 (if (and (>= marker beg) (< marker end))
7523 (push (cons marker (- marker beg)) org-markers-to-move))))
7525 (defun org-reinstall-markers-in-region (beg)
7526 "Move all remembered markers to their position relative to BEG."
7527 (mapc (lambda (x)
7528 (move-marker (car x) (+ beg (cdr x))))
7529 org-markers-to-move)
7530 (setq org-markers-to-move nil))
7532 (defun org-narrow-to-subtree ()
7533 "Narrow buffer to the current subtree."
7534 (interactive)
7535 (save-excursion
7536 (save-match-data
7537 (narrow-to-region
7538 (progn (org-back-to-heading t) (point))
7539 (progn (org-end-of-subtree t t)
7540 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7541 (point))))))
7543 (eval-when-compile
7544 (defvar org-property-drawer-re))
7546 (defun org-clone-subtree-with-time-shift (n &optional shift)
7547 "Clone the task (subtree) at point N times.
7548 The clones will be inserted as siblings.
7550 In interactive use, the user will be prompted for the number of
7551 clones to be produced, and for a time SHIFT, which may be a
7552 repeater as used in time stamps, for example `+3d'.
7554 When a valid repeater is given and the entry contains any time
7555 stamps, the clones will become a sequence in time, with time
7556 stamps in the subtree shifted for each clone produced. If SHIFT
7557 is nil or the empty string, time stamps will be left alone. The
7558 ID property of the original subtree is removed.
7560 If the original subtree did contain time stamps with a repeater,
7561 the following will happen:
7562 - the repeater will be removed in each clone
7563 - an additional clone will be produced, with the current, unshifted
7564 date(s) in the entry.
7565 - the original entry will be placed *after* all the clones, with
7566 repeater intact.
7567 - the start days in the repeater in the original entry will be shifted
7568 to past the last clone.
7569 I this way you can spell out a number of instances of a repeating task,
7570 and still retain the repeater to cover future instances of the task."
7571 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7572 (let (beg end template task idprop
7573 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7574 (if (not (and (integerp n) (> n 0)))
7575 (error "Invalid number of replications %s" n))
7578 shift)))
7579 (error "Invalid shift specification %s" shift))
7580 (when doshift
7581 (setq shift-n (string-to-number (match-string 1 shift))
7582 shift-what (cdr (assoc (match-string 2 shift)
7583 '(("d" . day) ("w" . week)
7584 ("m" . month) ("y" . year))))))
7585 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7586 (setq nmin 1 nmax n)
7587 (org-back-to-heading t)
7588 (setq beg (point))
7589 (setq idprop (org-entry-get nil "ID"))
7590 (org-end-of-subtree t t)
7592 (setq end (point))
7593 (setq template (buffer-substring beg end))
7594 (when (and doshift
7596 (delete-region beg end)
7597 (setq end beg)
7598 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7599 (goto-char end)
7600 (loop for n from nmin to nmax do
7601 ;; prepare clone
7602 (with-temp-buffer
7603 (insert template)
7604 (org-mode)
7605 (goto-char (point-min))
7606 (and idprop (if org-clone-delete-id
7607 (org-entry-delete nil "ID")
7608 (org-id-get-create t)))
7609 (while (re-search-forward org-property-start-re nil t)
7610 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7611 (goto-char (point-min))
7612 (when doshift
7613 (while (re-search-forward org-ts-regexp-both nil t)
7614 (org-timestamp-change (* n shift-n) shift-what))
7615 (unless (= n n-no-remove)
7616 (goto-char (point-min))
7617 (while (re-search-forward org-ts-regexp nil t)
7618 (save-excursion
7619 (goto-char (match-beginning 0))
7621 (delete-region (match-beginning 1) (match-end 1)))))))
7622 (setq task (buffer-string)))
7623 (insert task))
7624 (goto-char beg)))
7626 ;;; Outline Sorting
7628 (defun org-sort (with-case)
7629 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7630 Optional argument WITH-CASE means sort case-sensitively.
7631 With a double prefix argument, also remove duplicate entries."
7632 (interactive "P")
7633 (cond
7634 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7635 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7636 (t
7637 (org-call-with-arg 'org-sort-entries with-case))))
7639 (defun org-sort-remove-invisible (s)
7640 (remove-text-properties 0 (length s) org-rm-props s)
7641 (while (string-match org-bracket-link-regexp s)
7642 (setq s (replace-match (if (match-end 2)
7643 (match-string 3 s)
7644 (match-string 1 s)) t t s)))
7645 s)
7647 (defvar org-priority-regexp) ; defined later in the file
7649 (defvar org-after-sorting-entries-or-items-hook nil
7650 "Hook that is run after a bunch of entries or items have been sorted.
7651 When children are sorted, the cursor is in the parent line when this
7652 hook gets called. When a region or a plain list is sorted, the cursor
7653 will be in the first entry of the sorted region/list.")
7655 (defun org-sort-entries
7656 (&optional with-case sorting-type getkey-func compare-func property)
7657 "Sort entries on a certain level of an outline tree.
7658 If there is an active region, the entries in the region are sorted.
7659 Else, if the cursor is before the first entry, sort the top-level items.
7660 Else, the children of the entry at point are sorted.
7662 Sorting can be alphabetically, numerically, by date/time as given by
7663 a time stamp, by a property or by priority.
7665 The command prompts for the sorting type unless it has been given to the
7666 function through the SORTING-TYPE argument, which needs to be a character,
7667 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7668 precise meaning of each character:
7670 n Numerically, by converting the beginning of the entry/item to a number.
7671 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7672 t By date/time, either the first active time stamp in the entry, or, if
7673 none exist, by the first inactive one.
7674 s By the scheduled date/time.
7675 d By deadline date/time.
7676 c By creation time, which is assumed to be the first inactive time stamp
7677 at the beginning of a line.
7678 p By priority according to the cookie.
7679 r By the value of a property.
7681 Capital letters will reverse the sort order.
7683 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7684 called with point at the beginning of the record. It must return either
7685 a string or a number that should serve as the sorting key for that record.
7687 Comparing entries ignores case by default. However, with an optional argument
7688 WITH-CASE, the sorting considers case as well."
7689 (interactive "P")
7690 (let ((case-func (if with-case 'identity 'downcase))
7691 start beg end stars re re2
7692 txt what tmp)
7693 ;; Find beginning and end of region to sort
7694 (cond
7695 ((org-region-active-p)
7696 ;; we will sort the region
7697 (setq end (region-end)
7698 what "region")
7699 (goto-char (region-beginning))
7700 (if (not (org-on-heading-p)) (outline-next-heading))
7701 (setq start (point)))
7702 ((or (org-on-heading-p)
7703 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7704 ;; we will sort the children of the current headline
7705 (org-back-to-heading)
7706 (setq start (point)
7707 end (progn (org-end-of-subtree t t)
7709 (org-back-over-empty-lines)
7710 (point))
7711 what "children")
7712 (goto-char start)
7713 (show-subtree)
7714 (outline-next-heading))
7715 (t
7716 ;; we will sort the top-level entries in this file
7717 (goto-char (point-min))
7718 (or (org-on-heading-p) (outline-next-heading))
7719 (setq start (point))
7720 (goto-char (point-max))
7721 (beginning-of-line 1)
7723 ;; File ends in a non-white line
7724 (end-of-line 1)
7726 (setq end (point-max))
7727 (setq what "top-level")
7728 (goto-char start)
7729 (show-all)))
7731 (setq beg (point))
7732 (if (>= beg end) (error "Nothing to sort"))
7735 (setq stars (match-string 1)
7736 re (concat "^" (regexp-quote stars) " +")
7737 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
7738 txt (buffer-substring beg end))
7740 (if (and (not (equal stars "*")) (string-match re2 txt))
7741 (error "Region to sort contains a level above the first entry"))
7743 (unless sorting-type
7744 (message
7745 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7747 A/N/T/S/D/C/P/O/F means reversed:"
7748 what)
7749 (setq sorting-type (read-char-exclusive))
7751 (and (= (downcase sorting-type) ?f)
7752 (setq getkey-func
7753 (org-icompleting-read "Sort using function: "
7754 obarray 'fboundp t nil nil))
7755 (setq getkey-func (intern getkey-func)))
7757 (and (= (downcase sorting-type) ?r)
7758 (setq property
7759 (org-icompleting-read "Property: "
7760 (mapcar 'list (org-buffer-property-keys t))
7761 nil t))))
7763 (message "Sorting entries...")
7765 (save-restriction
7766 (narrow-to-region start end)
7767 (let ((dcst (downcase sorting-type))
7768 (case-fold-search nil)
7769 (now (current-time)))
7770 (sort-subr
7771 (/= dcst sorting-type)
7772 ;; This function moves to the beginning character of the "record" to
7773 ;; be sorted.
7774 (lambda nil
7775 (if (re-search-forward re nil t)
7776 (goto-char (match-beginning 0))
7777 (goto-char (point-max))))
7778 ;; This function moves to the last character of the "record" being
7779 ;; sorted.
7780 (lambda nil
7781 (save-match-data
7782 (condition-case nil
7783 (outline-forward-same-level 1)
7784 (error
7785 (goto-char (point-max))))))
7786 ;; This function returns the value that gets sorted against.
7787 (lambda nil
7788 (cond
7789 ((= dcst ?n)
7790 (if (looking-at org-complex-heading-regexp)
7791 (string-to-number (match-string 4))
7792 nil))
7793 ((= dcst ?a)
7794 (if (looking-at org-complex-heading-regexp)
7795 (funcall case-func (match-string 4))
7796 nil))
7797 ((= dcst ?t)
7798 (let ((end (save-excursion (outline-next-heading) (point))))
7799 (if (or (re-search-forward org-ts-regexp end t)
7800 (re-search-forward org-ts-regexp-both end t))
7801 (org-time-string-to-seconds (match-string 0))
7802 (org-float-time now))))
7803 ((= dcst ?c)
7804 (let ((end (save-excursion (outline-next-heading) (point))))
7805 (if (re-search-forward
7807 end t)
7808 (org-time-string-to-seconds (match-string 0))
7809 (org-float-time now))))
7810 ((= dcst ?s)
7811 (let ((end (save-excursion (outline-next-heading) (point))))
7812 (if (re-search-forward org-scheduled-time-regexp end t)
7813 (org-time-string-to-seconds (match-string 1))
7814 (org-float-time now))))
7815 ((= dcst ?d)
7816 (let ((end (save-excursion (outline-next-heading) (point))))
7817 (if (re-search-forward org-deadline-time-regexp end t)
7818 (org-time-string-to-seconds (match-string 1))
7819 (org-float-time now))))
7820 ((= dcst ?p)
7821 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7822 (string-to-char (match-string 2))
7823 org-default-priority))
7824 ((= dcst ?r)
7825 (or (org-entry-get nil property) ""))
7826 ((= dcst ?o)
7827 (if (looking-at org-complex-heading-regexp)
7828 (- 9999 (length (member (match-string 2)
7829 org-todo-keywords-1)))))
7830 ((= dcst ?f)
7831 (if getkey-func
7832 (progn
7833 (setq tmp (funcall getkey-func))
7834 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7835 tmp)
7836 (error "Invalid key function `%s'" getkey-func)))
7837 (t (error "Invalid sorting type `%c'" sorting-type))))
7838 nil
7839 (cond
7840 ((= dcst ?a) 'string<)
7841 ((= dcst ?f) compare-func)
7842 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7843 (t nil)))))
7844 (run-hooks 'org-after-sorting-entries-or-items-hook)
7845 (message "Sorting entries...done")))
7847 (defun org-do-sort (table what &optional with-case sorting-type)
7848 "Sort TABLE of WHAT according to SORTING-TYPE.
7849 The user will be prompted for the SORTING-TYPE if the call to this
7850 function does not specify it. WHAT is only for the prompt, to indicate
7851 what is being sorted. The sorting key will be extracted from
7852 the car of the elements of the table.
7853 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7854 (unless sorting-type
7855 (message
7856 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7857 what)
7858 (setq sorting-type (read-char-exclusive)))
7859 (let ((dcst (downcase sorting-type))
7860 extractfun comparefun)
7861 ;; Define the appropriate functions
7862 (cond
7863 ((= dcst ?n)
7864 (setq extractfun 'string-to-number
7865 comparefun (if (= dcst sorting-type) '< '>)))
7866 ((= dcst ?a)
7867 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7868 (lambda(x) (downcase (org-sort-remove-invisible x))))
7869 comparefun (if (= dcst sorting-type)
7870 'string<
7871 (lambda (a b) (and (not (string< a b))
7872 (not (string= a b)))))))
7873 ((= dcst ?t)
7874 (setq extractfun
7875 (lambda (x)
7876 (if (or (string-match org-ts-regexp x)
7877 (string-match org-ts-regexp-both x))
7878 (org-float-time
7879 (org-time-string-to-time (match-string 0 x)))
7880 0))
7881 comparefun (if (= dcst sorting-type) '< '>)))
7882 (t (error "Invalid sorting type `%c'" sorting-type)))
7884 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7885 table)
7886 (lambda (a b) (funcall comparefun (car a) (car b))))))
7889 ;;; The orgstruct minor mode
7891 ;; Define a minor mode which can be used in other modes in order to
7892 ;; integrate the org-mode structure editing commands.
7894 ;; This is really a hack, because the org-mode structure commands use
7895 ;; keys which normally belong to the major mode. Here is how it
7896 ;; works: The minor mode defines all the keys necessary to operate the
7897 ;; structure commands, but wraps the commands into a function which
7898 ;; tests if the cursor is currently at a headline or a plain list
7899 ;; item. If that is the case, the structure command is used,
7900 ;; temporarily setting many Org-mode variables like regular
7901 ;; expressions for filling etc. However, when any of those keys is
7902 ;; used at a different location, function uses `key-binding' to look
7903 ;; up if the key has an associated command in another currently active
7904 ;; keymap (minor modes, major mode, global), and executes that
7905 ;; command. There might be problems if any of the keys is otherwise
7906 ;; used as a prefix key.
7908 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7909 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7910 ;; addresses this by checking explicitly for both bindings.
7912 (defvar orgstruct-mode-map (make-sparse-keymap)
7913 "Keymap for the minor `orgstruct-mode'.")
7915 (defvar org-local-vars nil
7916 "List of local variables, for use by `orgstruct-mode'.")
7918 ;;;###autoload
7919 (define-minor-mode orgstruct-mode
7920 "Toggle the minor mode `orgstruct-mode'.
7921 This mode is for using Org-mode structure commands in other
7922 modes. The following keys behave as if Org-mode were active, if
7923 the cursor is on a headline, or on a plain list item (both as
7924 defined by Org-mode).
7926 M-up Move entry/item up
7927 M-down Move entry/item down
7928 M-left Promote
7929 M-right Demote
7930 M-S-up Move entry/item up
7931 M-S-down Move entry/item down
7932 M-S-left Promote subtree
7933 M-S-right Demote subtree
7934 M-q Fill paragraph and items like in Org-mode
7935 C-c ^ Sort entries
7936 C-c - Cycle list bullet
7937 TAB Cycle item visibility
7938 M-RET Insert new heading/item
7939 S-M-RET Insert new TODO heading / Checkbox item
7940 C-c C-c Set tags / toggle checkbox"
7941 nil " OrgStruct" nil
7942 (org-load-modules-maybe)
7943 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7945 ;;;###autoload
7946 (defun turn-on-orgstruct ()
7947 "Unconditionally turn on `orgstruct-mode'."
7948 (orgstruct-mode 1))
7950 (defun orgstruct++-mode (&optional arg)
7951 "Toggle `orgstruct-mode', the enhanced version of it.
7952 In addition to setting orgstruct-mode, this also exports all indentation
7953 and autofilling variables from org-mode into the buffer. It will also
7954 recognize item context in multiline items.
7955 Note that turning off orgstruct-mode will *not* remove the
7956 indentation/paragraph settings. This can only be done by refreshing the
7958 (interactive "P")
7959 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
7960 (if (< arg 1)
7961 (orgstruct-mode -1)
7962 (orgstruct-mode 1)
7963 (let (var val)
7964 (mapc
7965 (lambda (x)
7966 (when (string-match
7968 (symbol-name (car x)))
7969 (setq var (car x) val (nth 1 x))
7970 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7971 org-local-vars)
7972 (org-set-local 'orgstruct-is-++ t))))
7974 (defvar orgstruct-is-++ nil
7975 "Is `orgstruct-mode' in ++ version in the current-buffer?")
7976 (make-variable-buffer-local 'orgstruct-is-++)
7978 ;;;###autoload
7979 (defun turn-on-orgstruct++ ()
7980 "Unconditionally turn on `orgstruct++-mode'."
7981 (orgstruct++-mode 1))
7983 (defun orgstruct-error ()
7984 "Error when there is no default binding for a structure key."
7985 (interactive)
7986 (error "This key has no function outside structure elements"))
7988 (defun orgstruct-setup ()
7989 "Setup orgstruct keymaps."
7990 (let ((nfunc 0)
7991 (bindings
7992 (list
7993 '([(meta up)] org-metaup)
7994 '([(meta down)] org-metadown)
7995 '([(meta left)] org-metaleft)
7996 '([(meta right)] org-metaright)
7997 '([(meta shift up)] org-shiftmetaup)
7998 '([(meta shift down)] org-shiftmetadown)
7999 '([(meta shift left)] org-shiftmetaleft)
8000 '([(meta shift right)] org-shiftmetaright)
8001 '([?\e (up)] org-metaup)
8002 '([?\e (down)] org-metadown)
8003 '([?\e (left)] org-metaleft)
8004 '([?\e (right)] org-metaright)
8005 '([?\e (shift up)] org-shiftmetaup)
8006 '([?\e (shift down)] org-shiftmetadown)
8007 '([?\e (shift left)] org-shiftmetaleft)
8008 '([?\e (shift right)] org-shiftmetaright)
8009 '([(shift up)] org-shiftup)
8010 '([(shift down)] org-shiftdown)
8011 '([(shift left)] org-shiftleft)
8012 '([(shift right)] org-shiftright)
8013 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8014 '("\M-q" fill-paragraph)
8015 '("\C-c^" org-sort)
8016 '("\C-c-" org-cycle-list-bullet)))
8017 elt key fun cmd)
8018 (while (setq elt (pop bindings))
8019 (setq nfunc (1+ nfunc))
8020 (setq key (org-key (car elt))
8021 fun (nth 1 elt)
8022 cmd (orgstruct-make-binding fun nfunc key))
8023 (org-defkey orgstruct-mode-map key cmd))
8025 ;; Special treatment needed for TAB and RET
8026 (org-defkey orgstruct-mode-map [(tab)]
8027 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8028 (org-defkey orgstruct-mode-map "\C-i"
8029 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8031 (org-defkey orgstruct-mode-map "\M-\C-m"
8032 (orgstruct-make-binding 'org-insert-heading 105
8033 "\M-\C-m" [(meta return)]))
8034 (org-defkey orgstruct-mode-map [(meta return)]
8035 (orgstruct-make-binding 'org-insert-heading 106
8036 [(meta return)] "\M-\C-m"))
8038 (org-defkey orgstruct-mode-map [(shift meta return)]
8039 (orgstruct-make-binding 'org-insert-todo-heading 107
8040 [(meta return)] "\M-\C-m"))
8042 (org-defkey orgstruct-mode-map "\e\C-m"
8043 (orgstruct-make-binding 'org-insert-heading 108
8044 "\e\C-m" [?\e (return)]))
8045 (org-defkey orgstruct-mode-map [?\e (return)]
8046 (orgstruct-make-binding 'org-insert-heading 109
8047 [?\e (return)] "\e\C-m"))
8048 (org-defkey orgstruct-mode-map [?\e (shift return)]
8049 (orgstruct-make-binding 'org-insert-todo-heading 110
8050 [?\e (return)] "\e\C-m"))
8052 (unless org-local-vars
8053 (setq org-local-vars (org-get-local-variables)))
8055 t))
8057 (defun orgstruct-make-binding (fun n &rest keys)
8058 "Create a function for binding in the structure minor mode.
8059 FUN is the command to call inside a table. N is used to create a unique
8060 command name. KEYS are keys that should be checked in for a command
8061 to execute outside of tables."
8062 (eval
8063 (list 'defun
8064 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8065 '(arg)
8067 "Outside of structure, run the binding of `"
8068 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8069 "'.")
8070 '(interactive "p")
8071 (list 'if
8072 `(org-context-p 'headline 'item
8073 (and orgstruct-is-++
8074 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8075 'item-body))
8076 (list 'org-run-like-in-org-mode (list 'quote fun))
8077 (list 'let '(orgstruct-mode)
8078 (list 'call-interactively
8079 (append '(or)
8080 (mapcar (lambda (k)
8081 (list 'key-binding k))
8082 keys)
8083 '('orgstruct-error))))))))
8085 (defun org-context-p (&rest contexts)
8086 "Check if local context is any of CONTEXTS.
8087 Possible values in the list of contexts are `table', `headline', and `item'."
8088 (let ((pos (point)))
8089 (goto-char (point-at-bol))
8090 (prog1 (or (and (memq 'table contexts)
8092 (and (memq 'headline contexts)
8094 (looking-at outline-regexp))
8095 (and (memq 'item contexts)
8097 (and (memq 'item-body contexts)
8098 (org-in-item-p)))
8099 (goto-char pos))))
8101 (defun org-get-local-variables ()
8102 "Return a list of all local variables in an org-mode buffer."
8103 (let (varlist)
8104 (with-current-buffer (get-buffer-create "*Org tmp*")
8105 (erase-buffer)
8106 (org-mode)
8107 (setq varlist (buffer-local-variables)))
8108 (kill-buffer "*Org tmp*")
8109 (delq nil
8110 (mapcar
8111 (lambda (x)
8112 (setq x
8113 (if (symbolp x)
8114 (list x)
8115 (list (car x) (list 'quote (cdr x)))))
8116 (if (string-match
8117 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8118 (symbol-name (car x)))
8119 x nil))
8120 varlist))))
8122 ;;;###autoload
8123 (defun org-run-like-in-org-mode (cmd)
8124 "Run a command, pretending that the current buffer is in Org-mode.
8125 This will temporarily bind local variables that are typically bound in
8126 Org-mode to the values they have in Org-mode, and then interactively
8127 call CMD."
8128 (org-load-modules-maybe)
8129 (unless org-local-vars
8130 (setq org-local-vars (org-get-local-variables)))
8131 (eval (list 'let org-local-vars
8132 (list 'call-interactively (list 'quote cmd)))))
8134 ;;;; Archiving
8136 (defun org-get-category (&optional pos)
8137 "Get the category applying to position POS."
8138 (get-text-property (or pos (point)) 'org-category))
8140 (defun org-refresh-category-properties ()
8141 "Refresh category text properties in the buffer."
8142 (let ((def-cat (cond
8143 ((null org-category)
8144 (if buffer-file-name
8145 (file-name-sans-extension
8146 (file-name-nondirectory buffer-file-name))
8147 "???"))
8148 ((symbolp org-category) (symbol-name org-category))
8149 (t org-category)))
8150 beg end cat pos optionp)
8151 (org-unmodified
8152 (save-excursion
8153 (save-restriction
8154 (widen)
8155 (goto-char (point-min))
8156 (put-text-property (point) (point-max) 'org-category def-cat)
8157 (while (re-search-forward
8159 (setq pos (match-end 0)
8160 optionp (equal (char-after (match-beginning 0)) ?#)
8161 cat (org-trim (match-string 2)))
8162 (if optionp
8163 (setq beg (point-at-bol) end (point-max))
8164 (org-back-to-heading t)
8165 (setq beg (point) end (org-end-of-subtree t t)))
8166 (put-text-property beg end 'org-category cat)
8167 (goto-char pos)))))))
8170 ;;;; Link Stuff
8172 ;;; Link abbreviations
8174 (defun org-link-expand-abbrev (link)
8175 "Apply replacements as defined in `org-link-abbrev-alist."
8177 (let* ((key (match-string 1 link))
8178 (as (or (assoc key org-link-abbrev-alist-local)
8179 (assoc key org-link-abbrev-alist)))
8180 (tag (and (match-end 2) (match-string 3 link)))
8181 rpl)
8182 (if (not as)
8183 link
8184 (setq rpl (cdr as))
8185 (cond
8186 ((symbolp rpl) (funcall rpl tag))
8187 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8188 ((string-match "%h" rpl)
8189 (replace-match (url-hexify-string (or tag "")) t t rpl))
8190 (t (concat rpl tag)))))
8191 link))
8193 ;;; Storing and inserting links
8195 (defvar org-insert-link-history nil
8196 "Minibuffer history for links inserted with `org-insert-link'.")
8198 (defvar org-stored-links nil
8199 "Contains the links stored with `org-store-link'.")
8201 (defvar org-store-link-plist nil
8202 "Plist with info about the most recently link created with `org-store-link'.")
8204 (defvar org-link-protocols nil
8205 "Link protocols added to Org-mode using `org-add-link-type'.")
8207 (defvar org-store-link-functions nil
8208 "List of functions that are called to create and store a link.
8209 Each function will be called in turn until one returns a non-nil
8210 value. Each function should check if it is responsible for creating
8211 this link (for example by looking at the major mode).
8212 If not, it must exit and return nil.
8213 If yes, it should return a non-nil value after a calling
8214 `org-store-link-props' with a list of properties and values.
8215 Special properties are:
8219 This is obligatory as well.
8220 :description Optional default description for the second pair
8221 of brackets in an Org-mode link. The user can still change
8222 this when inserting this link into an Org-mode buffer.
8224 In addition to these, any additional properties can be specified
8225 and then used in remember templates.")
8227 (defun org-add-link-type (type &optional follow export)
8228 "Add TYPE to the list of `org-link-types'.
8229 Re-compute all regular expressions depending on `org-link-types'
8231 FOLLOW and EXPORT are two functions.
8233 FOLLOW should take the link path as the single argument and do whatever
8234 is necessary to follow the link, for example find a file or display
8235 a mail message.
8237 EXPORT should format the link path for export to one of the export formats.
8238 It should be a function accepting three arguments:
8241 desc the description of the link, if any, nil if there was no description
8242 format the export format, a symbol like `html' or `latex' or `ascii'..
8244 The function may use the FORMAT information to return different values
8245 depending on the format. The return value will be put literally into
8246 the exported file. If the return value is nil, this means Org should
8247 do what it normally does with links which do not have EXPORT defined.
8249 Org-mode has a built-in default for exporting links. If you are happy with
8250 this default, there is no need to define an export function for the link
8251 type. For a simple example of an export function, see `org-bbdb.el'."
8252 (add-to-list 'org-link-types type t)
8253 (org-make-link-regexps)
8254 (if (assoc type org-link-protocols)
8255 (setcdr (assoc type org-link-protocols) (list follow export))
8256 (push (list type follow export) org-link-protocols)))
8258 (defvar org-agenda-buffer-name)
8260 ;;;###autoload
8261 (defun org-store-link (arg)
8263 This link is added to `org-stored-links' and can later be inserted
8266 For some link types, a prefix arg is interpreted:
8267 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8268 For file links, arg negates `org-context-in-file-links'."
8269 (interactive "P")
8270 (org-load-modules-maybe)
8271 (setq org-store-link-plist nil) ; reset
8272 (let ((outline-regexp (org-get-limited-outline-regexp))
8273 link cpltxt desc description search txt custom-id agenda-link)
8274 (cond
8276 ((run-hook-with-args-until-success 'org-store-link-functions)
8277 (setq link (plist-get org-store-link-plist :link)
8278 desc (or (plist-get org-store-link-plist :description) link)))
8280 ((equal (buffer-name) "*Org Edit Src Example*")
8281 (let (label gc)
8282 (while (or (not label)
8283 (save-excursion
8284 (save-restriction
8285 (widen)
8286 (goto-char (point-min))
8287 (re-search-forward
8288 (regexp-quote (format org-coderef-label-format label))
8289 nil t))))
8290 (when label (message "Label exists already") (sit-for 2))
8291 (setq label (read-string "Code line label: " label)))
8292 (end-of-line 1)
8293 (setq link (format org-coderef-label-format label))
8294 (setq gc (- 79 (length link)))
8295 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8296 (insert link)
8297 (setq link (concat "(" label ")") desc nil)))
8299 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8300 ;; We are in the agenda, link to referenced location
8301 (let ((m (or (get-text-property (point) 'org-hd-marker)
8302 (get-text-property (point) 'org-marker))))
8303 (when m
8304 (org-with-point-at m
8305 (setq agenda-link
8306 (if (interactive-p)
8307 (call-interactively 'org-store-link)
8308 (org-store-link nil)))))))
8310 ((eq major-mode 'calendar-mode)
8311 (let ((cd (calendar-cursor-to-date)))
8312 (setq link
8313 (format-time-string
8314 (car org-time-stamp-formats)
8315 (apply 'encode-time
8316 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8317 nil nil nil))))
8318 (org-store-link-props :type "calendar" :date cd)))
8320 ((eq major-mode 'w3-mode)
8321 (setq cpltxt (if (and (buffer-name)
8322 (not (string-match "Untitled" (buffer-name))))
8323 (buffer-name)
8324 (url-view-url t))
8325 link (org-make-link (url-view-url t)))
8326 (org-store-link-props :type "w3" :url (url-view-url t)))
8328 ((eq major-mode 'w3m-mode)
8329 (setq cpltxt (or w3m-current-title w3m-current-url)
8330 link (org-make-link w3m-current-url))
8331 (org-store-link-props :type "w3m" :url (url-view-url t)))
8333 ((setq search (run-hook-with-args-until-success
8334 'org-create-file-search-functions))
8335 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8336 "::" search))
8337 (setq cpltxt (or description link)))
8339 ((eq major-mode 'image-mode)
8340 (setq cpltxt (concat "file:"
8341 (abbreviate-file-name buffer-file-name))
8342 link (org-make-link cpltxt))
8343 (org-store-link-props :type "image" :file buffer-file-name))
8345 ((eq major-mode 'dired-mode)
8346 ;; link to the file in the current line
8347 (let ((file (dired-get-filename nil t)))
8348 (setq file (if file
8349 (abbreviate-file-name
8350 (expand-file-name (dired-get-filename nil t)))
8351 ;; otherwise, no file so use current directory.
8352 default-directory))
8353 (setq cpltxt (concat "file:" file)
8354 link (org-make-link cpltxt))))
8356 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8357 (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
8358 (cond
8360 (setq cpltxt
8361 (concat "file:"
8362 (abbreviate-file-name
8363 (buffer-file-name (buffer-base-buffer)))
8364 "::" (match-string 1))
8365 link (org-make-link cpltxt)))
8366 ((and (featurep 'org-id)
8367 (or (eq org-link-to-org-use-id t)
8368 (and (eq org-link-to-org-use-id 'create-if-interactive)
8369 (interactive-p))
8370 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
8371 (interactive-p)
8372 (not custom-id))
8373 (and org-link-to-org-use-id
8374 (condition-case nil
8375 (org-entry-get nil "ID")
8376 (error nil)))))
8377 ;; We can make a link using the ID.
8378 (setq link (condition-case nil
8379 (prog1 (org-id-store-link)
8380 (setq desc (plist-get org-store-link-plist
8381 :description)))
8382 (error
8383 ;; probably before first headline, link to file only
8384 (concat "file:"
8385 (abbreviate-file-name
8386 (buffer-file-name (buffer-base-buffer))))))))
8387 (t
8388 ;; Just link to current headline
8389 (setq cpltxt (concat "file:"
8390 (abbreviate-file-name
8391 (buffer-file-name (buffer-base-buffer)))))
8392 ;; Add a context search string
8393 (when (org-xor org-context-in-file-links arg)
8394 (setq txt (cond
8395 ((org-on-heading-p) nil)
8396 ((org-region-active-p)
8397 (buffer-substring (region-beginning) (region-end)))
8398 (t nil)))
8400 (setq cpltxt
8401 (concat cpltxt "::"
8402 (condition-case nil
8403 (org-make-org-heading-search-string txt)
8404 (error "")))
8405 desc (or (nth 4 (ignore-errors
8406 (org-heading-components))) "NONE"))))
8408 (setq cpltxt (substring cpltxt 0 -2)))
8409 (setq link (org-make-link cpltxt)))))
8411 ((buffer-file-name (buffer-base-buffer))
8412 ;; Just link to this file here.
8413 (setq cpltxt (concat "file:"
8414 (abbreviate-file-name
8415 (buffer-file-name (buffer-base-buffer)))))
8416 ;; Add a context string
8417 (when (org-xor org-context-in-file-links arg)
8418 (setq txt (if (org-region-active-p)
8419 (buffer-substring (region-beginning) (region-end))
8420 (buffer-substring (point-at-bol) (point-at-eol))))
8421 ;; Only use search option if there is some text.
8423 (setq cpltxt
8424 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8425 desc "NONE")))
8426 (setq link (org-make-link cpltxt)))
8428 ((interactive-p)
8429 (error "Cannot link to a buffer which is not visiting a file"))
8431 (t (setq link nil)))
8433 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8434 (setq link (or link cpltxt)
8435 desc (or desc cpltxt))
8436 (if (equal desc "NONE") (setq desc nil))
8438 (if (and (or (interactive-p) executing-kbd-macro) link)
8439 (progn
8440 (setq org-stored-links
8441 (cons (list link desc) org-stored-links))
8442 (message "Stored: %s" (or desc link))
8443 (when custom-id
8444 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8445 "::#" custom-id))
8446 (setq org-stored-links
8447 (cons (list link desc) org-stored-links))))
8448 (or agenda-link (and link (org-make-link-string link desc))))))
8450 (defun org-store-link-props (&rest plist)
8451 "Store link properties, extract names and addresses."
8452 (let (x adr)
8453 (when (setq x (plist-get plist :from))
8454 (setq adr (mail-extract-address-components x))
8455 (setq plist (plist-put plist :fromname (car adr)))
8456 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8457 (when (setq x (plist-get plist :to))
8458 (setq adr (mail-extract-address-components x))
8459 (setq plist (plist-put plist :toname (car adr)))
8460 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8461 (let ((from (plist-get plist :from))
8462 (to (plist-get plist :to)))
8463 (when (and from to org-from-is-user-regexp)
8464 (setq plist
8465 (plist-put plist :fromto
8466 (if (string-match org-from-is-user-regexp from)
8467 (concat "to %t")
8468 (concat "from %f"))))))
8469 (setq org-store-link-plist plist))
8471 (defun org-add-link-props (&rest plist)
8472 "Add these properties to the link property list."
8473 (let (key value)
8474 (while plist
8475 (setq key (pop plist) value (pop plist))
8476 (setq org-store-link-plist
8477 (plist-put org-store-link-plist key value)))))
8479 (defun org-email-link-description (&optional fmt)
8480 "Return the description part of an email link.
8481 This takes information from `org-store-link-plist' and formats it
8482 according to FMT (default from `org-email-link-description-format')."
8483 (setq fmt (or fmt org-email-link-description-format))
8484 (let* ((p org-store-link-plist)
8485 (to (plist-get p :toaddress))
8486 (from (plist-get p :fromaddress))
8487 (table
8488 (list
8489 (cons "%c" (plist-get p :fromto))
8490 (cons "%F" (plist-get p :from))
8491 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8492 (cons "%T" (plist-get p :to))
8493 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8494 (cons "%s" (plist-get p :subject))
8495 (cons "%m" (plist-get p :message-id)))))
8496 (when (string-match "%c" fmt)
8497 ;; Check if the user wrote this message
8498 (if (and org-from-is-user-regexp from to
8499 (save-match-data (string-match org-from-is-user-regexp from)))
8500 (setq fmt (replace-match "to %t" t t fmt))
8501 (setq fmt (replace-match "from %f" t t fmt))))
8502 (org-replace-escapes fmt table)))
8504 (defun org-make-org-heading-search-string (&optional string heading)
8505 "Make search string for STRING or current headline."
8506 (interactive)
8507 (let ((s (or string (org-get-heading)))
8508 (lines org-context-in-file-links))
8509 (unless (and string (not heading))
8510 ;; We are using a headline, clean up garbage in there.
8511 (if (string-match org-todo-regexp s)
8512 (setq s (replace-match "" t t s)))
8514 (setq s (replace-match "" t t s)))
8515 (setq s (org-trim s))
8518 (setq s (replace-match "" t t s)))
8519 (while (string-match org-ts-regexp s)
8520 (setq s (replace-match "" t t s))))
8521 (or string (setq s (concat "*" s))) ; Add * for headlines
8522 (when (and string (integerp lines) (> lines 0))
8524 (when (< lines (length slines))
8525 (setq s (mapconcat
8526 'identity
8527 (reverse (nthcdr (- (length slines) lines)
8531 (defun org-make-link (&rest strings)
8532 "Concatenate STRINGS."
8533 (apply 'concat strings))
8535 (defun org-make-link-string (link &optional description)
8536 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8538 (error "Empty link"))
8539 (when (and description
8540 (stringp description)
8542 (setq description nil))
8543 (when (stringp description)
8544 ;; Remove brackets from the description, they are fatal.
8546 (setq description (replace-match "{" t t description)))
8548 (setq description (replace-match "}" t t description))))
8549 (when (equal (org-link-escape link) description)
8550 ;; No description needed, it is identical
8551 (setq description nil))
8552 (when (and (not description)
8553 (not (equal link (org-link-escape link))))
8554 (setq description (org-extract-attributes link)))
8555 (setq link (if (string-match org-link-types-re link)
8556 (concat (match-string 1 link)
8557 (org-link-escape (substring link (match-end 1))))
8558 (org-link-escape link)))
8559 (concat "[[" link "]"
8560 (if description (concat "[" description "]") "")
8561 "]"))
8563 (defconst org-link-escape-chars
8564 '((?\ . "%20")
8565 (?\[ . "%5B")
8566 (?\] . "%5D")
8577 (?\; . "%3B")
8578 ;; (?? . "%3F")
8579 (?= . "%3D")
8580 (?+ . "%2B")
8581 )
8582 "Association list of escapes for some characters problematic in links.
8583 This is the list that is used for internal purposes.")
8585 (defvar org-url-encoding-use-url-hexify nil)
8587 (defconst org-link-escape-chars-browser
8588 '((?\ . "%20")) ; 32 for the SPC char
8589 "Association list of escapes for some characters problematic in links.
8590 This is the list that is used before handing over to the browser.")
8592 (defun org-link-escape (text &optional table)
8593 "Escape characters in TEXT that are problematic for links."
8594 (if (and org-url-encoding-use-url-hexify (not table))
8595 (url-hexify-string text)
8596 (setq table (or table org-link-escape-chars))
8597 (when text
8598 (let ((re (mapconcat (lambda (x) (regexp-quote
8599 (char-to-string (car x))))
8601 (while (string-match re text)
8602 (setq text
8603 (replace-match
8604 (cdr (assoc (string-to-char (match-string 0 text))
8605 table))
8606 t t text)))
8607 text))))
8609 (defun org-link-unescape (text &optional table)
8610 "Reverse the action of `org-link-escape'."
8611 (if (and org-url-encoding-use-url-hexify (not table))
8612 (url-unhex-string text)
8613 (setq table (or table org-link-escape-chars))
8614 (when text
8615 (let ((case-fold-search t)
8616 (re (mapconcat (lambda (x) (regexp-quote (downcase (cdr x))))
8618 (while (string-match re text)
8619 (setq text
8620 (replace-match
8621 (char-to-string (car (rassoc (upcase (match-string 0 text))
8622 table)))
8623 t t text)))
8624 text))))
8626 (defun org-xor (a b)
8627 "Exclusive or."
8628 (if a (not b) b))
8630 (defun org-fixup-message-id-for-http (s)
8631 "Replace special characters in a message id, so it can be used in an http query."
8632 (when (string-match "%" s)
8633 (setq s (mapconcat (lambda (c)
8634 (if (eq c ?%)
8635 "%25"
8636 (char-to-string c)))
8637 s "")))
8638 (while (string-match "<" s)
8639 (setq s (replace-match "%3C" t t s)))
8640 (while (string-match ">" s)
8641 (setq s (replace-match "%3E" t t s)))
8642 (while (string-match "@" s)
8643 (setq s (replace-match "%40" t t s)))
8644 s)
8646 ;;;###autoload
8647 (defun org-insert-link-global ()
8648 "Insert a link like Org-mode does.
8649 This command can be called in any mode to insert a link in Org-mode syntax."
8650 (interactive)
8651 (org-load-modules-maybe)
8652 (org-run-like-in-org-mode 'org-insert-link))
8654 (defun org-insert-link (&optional complete-file link-location)
8655 "Insert a link. At the prompt, enter the link.
8657 Completion can be used to insert any of the link protocol prefixes like
8658 http or ftp in use.
8660 The history can be used to select a link previously stored with
8661 `org-store-link'. When the empty string is entered (i.e. if you just
8662 press RET at the prompt), the link defaults to the most recently
8663 stored link. As SPC triggers completion in the minibuffer, you need to
8664 use M-SPC or C-q SPC to force the insertion of a space character.
8666 You will also be prompted for a description, and if one is given, it will
8667 be displayed in the buffer instead of the link.
8669 If there is already a link at point, this command will allow you to edit link
8670 and description parts.
8673 be selected using completion. The path to the file will be relative to the
8674 current directory if the file is in the current directory or a subdirectory.
8675 Otherwise, the link will be the absolute path as completed in the minibuffer
8676 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8677 option `org-link-file-path-type'.
8680 the current directory or below.
8683 `org-keep-stored-link-after-insertion'.
8685 If `org-make-link-description-function' is non-nil, this function will be
8686 called with the link target, and the result will be the default
8687 link description.
8689 If the LINK-LOCATION parameter is non-nil, this value will be
8690 used as the link location instead of reading one interactively."
8691 (interactive "P")
8692 (let* ((wcf (current-window-configuration))
8693 (region (if (org-region-active-p)
8694 (buffer-substring (region-beginning) (region-end))))
8695 (remove (and region (list (region-beginning) (region-end))))
8696 (desc region)
8697 tmphist ; byte-compile incorrectly complains about this
8698 (link link-location)
8699 entry file all-prefixes)
8700 (cond
8701 (link-location) ; specified by arg, just use it.
8702 ((org-in-regexp org-bracket-link-regexp 1)
8703 ;; We do have a link at point, and we are going to edit it.
8704 (setq remove (list (match-beginning 0) (match-end 0)))
8705 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8706 (setq link (read-string "Link: "
8707 (org-link-unescape
8708 (org-match-string-no-properties 1)))))
8709 ((or (org-in-regexp org-angle-link-re)
8710 (org-in-regexp org-plain-link-re))
8711 ;; Convert to bracket link
8712 (setq remove (list (match-beginning 0) (match-end 0))
8713 link (read-string "Link: "
8714 (org-remove-angle-brackets (match-string 0)))))
8715 ((member complete-file '((4) (16)))
8716 ;; Completing read for file names.
8717 (setq link (org-file-complete-link complete-file)))
8718 (t
8719 ;; Read link, with completion for stored links.
8720 (with-output-to-temp-buffer "*Org Links*"
8721 (princ "Insert a link.
8723 (when org-stored-links
8725 (princ (mapconcat
8726 (lambda (x)
8727 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8729 (let ((cw (selected-window)))
8730 (select-window (get-buffer-window "*Org Links*" 'visible))
8731 (setq truncate-lines t)
8732 (unless (pos-visible-in-window-p (point-max))
8733 (org-fit-window-to-buffer))
8734 (and (window-live-p cw) (select-window cw)))
8735 ;; Fake a link history, containing the stored links.
8736 (setq tmphist (append (mapcar 'car org-stored-links)
8737 org-insert-link-history))
8738 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8739 (mapcar 'car org-link-abbrev-alist)
8740 org-link-types))
8741 (unwind-protect
8742 (progn
8743 (setq link
8744 (let ((org-completion-use-ido nil)
8745 (org-completion-use-iswitchb nil))
8746 (org-completing-read
8747 "Link: "
8748 (append
8749 (mapcar (lambda (x) (list (concat x ":")))
8750 all-prefixes)
8751 (mapcar 'car org-stored-links))
8752 nil nil nil
8753 'tmphist
8754 (car (car org-stored-links)))))
8756 (error "No link selected"))
8757 (if (or (member link all-prefixes)
8758 (and (equal ":" (substring link -1))
8759 (member (substring link 0 -1) all-prefixes)
8760 (setq link (substring link 0 -1))))
8761 (setq link (org-link-try-special-completion link))))
8762 (set-window-configuration wcf)
8763 (kill-buffer "*Org Links*"))
8764 (setq entry (assoc link org-stored-links))
8765 (or entry (push link org-insert-link-history))
8766 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8767 (not org-keep-stored-link-after-insertion))
8768 (setq org-stored-links (delq (assoc link org-stored-links)
8769 org-stored-links)))
8770 (setq desc (or desc (nth 1 entry)))))
8772 (if (string-match org-plain-link-re link)
8773 ;; URL-like link, normalize the use of angular brackets.
8774 (setq link (org-make-link (org-remove-angle-brackets link))))
8776 ;; Check if we are linking to the current file with a search option
8777 ;; If yes, simplify the link by using only the search option.
8778 (when (and buffer-file-name
8780 (let* ((path (match-string 1 link))
8781 (case-fold-search nil)
8782 (search (match-string 2 link)))
8783 (save-match-data
8784 (if (equal (file-truename buffer-file-name) (file-truename path))
8785 ;; We are linking to this same file, with a search option
8786 (setq link search)))))
8788 ;; Check if we can/should use a relative path. If yes, simplify the link
8790 (let* ((type (match-string 1 link))
8791 (path (match-string 2 link))
8792 (origpath path)
8793 (case-fold-search nil))
8794 (cond
8795 ((or (eq org-link-file-path-type 'absolute)
8796 (equal complete-file '(16)))
8797 (setq path (abbreviate-file-name (expand-file-name path))))
8798 ((eq org-link-file-path-type 'noabbrev)
8799 (setq path (expand-file-name path)))
8800 ((eq org-link-file-path-type 'relative)
8801 (setq path (file-relative-name path)))
8802 (t
8803 (save-match-data
8804 (if (string-match (concat "^" (regexp-quote
8805 (expand-file-name
8806 (file-name-as-directory
8807 default-directory))))
8808 (expand-file-name path))
8809 ;; We are linking a file with relative path name.
8810 (setq path (substring (expand-file-name path)
8811 (match-end 0)))
8812 (setq path (abbreviate-file-name (expand-file-name path)))))))
8813 (setq link (concat type path))
8814 (if (equal desc origpath)
8815 (setq desc path))))
8817 (if org-make-link-description-function
8818 (setq desc (funcall org-make-link-description-function link desc)))
8820 (setq desc (read-string "Description: " desc))
8822 (if remove (apply 'delete-region remove))
8823 (insert (org-make-link-string link desc))))
8825 (defun org-link-try-special-completion (type)
8826 "If there is completion support for link type TYPE, offer it."
8827 (let ((fun (intern (concat "org-" type "-complete-link"))))
8828 (if (functionp fun)
8829 (funcall fun)
8830 (read-string "Link (no completion support): " (concat type ":")))))
8832 (defun org-file-complete-link (&optional arg)
8833 "Create a file link using completion."
8834 (let (file link)
8835 (setq file (read-file-name "File: "))
8836 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8837 (pwd1 (file-name-as-directory (abbreviate-file-name
8838 (expand-file-name ".")))))
8839 (cond
8840 ((equal arg '(16))
8841 (setq link (org-make-link
8842 "file:"
8843 (abbreviate-file-name (expand-file-name file)))))
8845 (setq link (org-make-link "file:" (match-string 1 file))))
8847 (expand-file-name file))
8848 (setq link (org-make-link
8849 "file:" (match-string 1 (expand-file-name file)))))
8850 (t (setq link (org-make-link "file:" file)))))
8851 link))
8853 (defun org-completing-read (&rest args)
8854 "Completing-read with SPACE being a normal character."
8855 (let ((minibuffer-local-completion-map
8856 (copy-keymap minibuffer-local-completion-map)))
8857 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
8858 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
8859 (apply 'org-icompleting-read args)))
8861 (defun org-completing-read-no-i (&rest args)
8862 (let (org-completion-use-ido org-completion-use-iswitchb)
8863 (apply 'org-completing-read args)))
8865 (defun org-iswitchb-completing-read (prompt choices &rest args)
8866 "Use iswitch as a completing-read replacement to choose from choices.
8867 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
8868 from."
8869 (let* ((iswitchb-use-virtual-buffers nil)
8870 (iswitchb-make-buflist-hook
8871 (lambda ()
8872 (setq iswitchb-temp-buflist choices))))
8873 (iswitchb-read-buffer prompt)))
8875 (defun org-icompleting-read (&rest args)
8876 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
8877 (org-without-partial-completion
8878 (if (and org-completion-use-ido
8879 (fboundp 'ido-completing-read)
8880 (boundp 'ido-mode) ido-mode
8881 (listp (second args)))
8882 (let ((ido-enter-matching-directory nil))
8883 (apply 'ido-completing-read (concat (car args))
8884 (if (consp (car (nth 1 args)))
8885 (mapcar (lambda (x) (car x)) (nth 1 args))
8886 (nth 1 args))
8887 (cddr args)))
8888 (if (and org-completion-use-iswitchb
8889 (boundp 'iswitchb-mode) iswitchb-mode
8890 (listp (second args)))
8891 (apply 'org-iswitchb-completing-read (concat (car args))
8892 (if (consp (car (nth 1 args)))
8893 (mapcar (lambda (x) (car x)) (nth 1 args))
8894 (nth 1 args))
8895 (cddr args))
8896 (apply 'completing-read args)))))
8898 (defun org-extract-attributes (s)
8899 "Extract the attributes cookie from a string and set as text property."
8900 (let (a attr (start 0) key value)
8901 (save-match-data
8903 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
8905 (setq key (match-string 1 a) value (match-string 2 a)
8906 start (match-end 0)
8907 attr (plist-put attr (intern key) value))))
8908 (org-add-props s nil 'org-attr attr))
8909 s))
8911 (defun org-extract-attributes-from-string (tag)
8912 (let (key value attr)
8914 (setq key (match-string 1 tag) value (match-string 2 tag)
8915 tag (replace-match "" t t tag)
8916 attr (plist-put attr (intern key) value)))
8917 (cons tag attr)))
8919 (defun org-attributes-to-string (plist)
8920 "Format a property list into an HTML attribute list."
8921 (let ((s "") key value)
8922 (while plist
8923 (setq key (pop plist) value (pop plist))
8924 (and value
8926 s))
8928 ;;; Opening/following a link
8930 (defvar org-link-search-failed nil)
8932 (defvar org-open-link-functions nil
8933 "Hook for functions finding a plain text link.
8934 These functions must take a single argument, the link content.
8935 They will be called for links that look like [[link text][description]]
8939 These functions will be called *before* Org attempts to resolve the
8940 link by doing text searches in the current buffer - so if you want a
8942 handle this as a special case.
8944 When the function does handle the link, it must return a non-nil value.
8945 If it decides that it is not responsible for this link, it must return
8946 nil to indicate that that Org-mode can continue with other options
8947 like exact and fuzzy text search.")
8949 (defun org-next-link ()
8950 "Move forward to the next link.
8951 If the link is in hidden text, expose it."
8952 (interactive)
8953 (when (and org-link-search-failed (eq this-command last-command))
8954 (goto-char (point-min))
8955 (message "Link search wrapped back to beginning of buffer"))
8956 (setq org-link-search-failed nil)
8957 (let* ((pos (point))
8958 (ct (org-context))
8959 (a (assoc :link ct)))
8960 (if a (goto-char (nth 2 a)))
8961 (if (re-search-forward org-any-link-re nil t)
8962 (progn
8963 (goto-char (match-beginning 0))
8964 (if (org-invisible-p) (org-show-context)))
8965 (goto-char pos)
8966 (setq org-link-search-failed t)
8967 (error "No further link found"))))
8969 (defun org-previous-link ()
8970 "Move backward to the previous link.
8971 If the link is in hidden text, expose it."
8972 (interactive)
8973 (when (and org-link-search-failed (eq this-command last-command))
8974 (goto-char (point-max))
8975 (message "Link search wrapped back to end of buffer"))
8976 (setq org-link-search-failed nil)
8977 (let* ((pos (point))
8978 (ct (org-context))
8979 (a (assoc :link ct)))
8980 (if a (goto-char (nth 1 a)))
8981 (if (re-search-backward org-any-link-re nil t)
8982 (progn
8983 (goto-char (match-beginning 0))
8984 (if (org-invisible-p) (org-show-context)))
8985 (goto-char pos)
8986 (setq org-link-search-failed t)
8987 (error "No further link found"))))
8989 (defun org-translate-link (s)
8990 "Translate a link string if a translation function has been defined."
8991 (if (and org-link-translation-function
8992 (fboundp org-link-translation-function)
8994 (progn
8995 (setq s (funcall org-link-translation-function
8996 (match-string 1) (match-string 2)))
8997 (concat (car s) ":" (cdr s)))
8998 s))
9000 (defun org-translate-link-from-planner (type path)
9001 "Translate a link from Emacs Planner syntax so that Org can follow it.
9002 This is still an experimental function, your mileage may vary."
9003 (cond
9004 ((member type '("http" "https" "news" "ftp"))
9005 ;; standard Internet links are the same.
9006 nil)
9007 ((and (equal type "irc") (string-match "^//" path))
9008 ;; Planner has two / at the beginning of an irc link, we have 1.
9009 ;; We should have zero, actually....
9010 (setq path (substring path 1)))
9011 ((and (equal type "lisp") (string-match "^/" path))
9012 ;; Planner has a slash, we do not.
9013 (setq type "elisp" path (substring path 1)))
9015 ;; A typical message link. Planner has the id after the final slash,
9016 ;; we separate it with a hash mark
9017 (setq path (concat (match-string 1 path) "#"
9018 (org-remove-angle-brackets (match-string 2 path)))))
9019 )
9020 (cons type path))
9022 (defun org-find-file-at-mouse (ev)
9023 "Open file link or URL at mouse."
9024 (interactive "e")
9025 (mouse-set-point ev)
9026 (org-open-at-point 'in-emacs))
9028 (defun org-open-at-mouse (ev)
9029 "Open file link or URL at mouse."
9030 (interactive "e")
9031 (mouse-set-point ev)
9032 (if (eq major-mode 'org-agenda-mode)
9033 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9034 (org-open-at-point))
9036 (defvar org-window-config-before-follow-link nil
9037 "The window configuration before following a link.
9038 This is saved in case the need arises to restore it.")
9040 (defvar org-open-link-marker (make-marker)
9041 "Marker pointing to the location where `org-open-at-point; was called.")
9043 ;;;###autoload
9044 (defun org-open-at-point-global ()
9045 "Follow a link like Org-mode does.
9046 This command can be called in any mode to follow a link that has
9047 Org-mode syntax."
9048 (interactive)
9049 (org-run-like-in-org-mode 'org-open-at-point))
9051 ;;;###autoload
9052 (defun org-open-link-from-string (s &optional arg reference-buffer)
9053 "Open a link in the string S, as if it was in Org-mode."
9055 (let ((reference-buffer (or reference-buffer (current-buffer))))
9056 (with-temp-buffer
9057 (let ((org-inhibit-startup t))
9058 (org-mode)
9059 (insert s)
9060 (goto-char (point-min))
9061 (when reference-buffer
9062 (setq org-link-abbrev-alist-local
9063 (with-current-buffer reference-buffer
9064 org-link-abbrev-alist-local)))
9065 (org-open-at-point arg reference-buffer)))))
9067 (defvar org-open-at-point-functions nil
9068 "Hook that is run when following a link at point.
9070 Functions in this hook must return t if they identify and follow
9071 a link at point. If they don't find anything interesting at point,
9072 they must return nil.")
9074 (defun org-open-at-point (&optional in-emacs reference-buffer)
9075 "Open link at or after point.
9076 If there is no link at point, this function will search forward up to
9077 the end of the current line.
9078 Normally, files will be opened by an appropriate application. If the
9079 optional argument IN-EMACS is non-nil, Emacs will visit the file.
9080 With a double prefix argument, try to open outside of Emacs, in the
9081 application the system uses for this file type."
9082 (interactive "P")
9083 ;; if in a code block, then open the block's results
9084 (unless (call-interactively #'org-babel-open-src-block-result)
9085 (org-load-modules-maybe)
9086 (move-marker org-open-link-marker (point))
9087 (setq org-window-config-before-follow-link (current-window-configuration))
9088 (org-remove-occur-highlights nil nil t)
9089 (cond
9090 ((and (org-on-heading-p)
9091 (not (org-in-regexp
9096 (not (get-text-property (point) 'org-linked-text)))
9097 (or (org-offer-links-in-entry in-emacs)
9098 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9099 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9100 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9101 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9102 (not (org-in-regexp org-bracket-link-regexp)))
9103 (org-footnote-action))
9104 (t
9105 (let (type path link line search (pos (point)))
9106 (catch 'match
9107 (save-excursion
9109 (when (org-in-regexp org-bracket-link-regexp 1)
9110 (setq link (org-extract-attributes
9111 (org-link-unescape (org-match-string-no-properties 1))))
9113 (setq link (replace-match " " t t link)))
9114 (setq link (org-link-expand-abbrev link))
9115 (cond
9116 ((or (file-name-absolute-p link)
9118 (setq type "file" path link))
9119 ((string-match org-link-re-with-space3 link)
9120 (setq type (match-string 1 link) path (match-string 2 link)))
9121 (t (setq type "thisfile" path link)))
9122 (throw 'match t)))
9124 (when (get-text-property (point) 'org-linked-text)
9125 (setq type "thisfile"
9126 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9127 (1+ (point)) (point))
9128 path (buffer-substring
9129 (previous-single-property-change pos 'org-linked-text)
9130 (next-single-property-change pos 'org-linked-text)))
9131 (throw 'match t))
9133 (save-excursion
9134 (when (or (org-in-regexp org-angle-link-re)
9135 (org-in-regexp org-plain-link-re))
9136 (setq type (match-string 1) path (match-string 2))
9137 (throw 'match t)))
9138 (save-excursion
9140 (setq type "tags"
9141 path (match-string 1))
9142 (while (string-match ":" path)
9143 (setq path (replace-match "+" t t path)))
9144 (throw 'match t)))
9146 (setq type "tree-match"
9147 path (match-string 1))
9148 (throw 'match t)))
9149 (unless path
9150 (error "No link found"))
9152 ;; switch back to reference buffer
9153 ;; needed when if called in a temporary buffer through
9154 ;; org-open-link-from-string
9155 (with-current-buffer (or reference-buffer (current-buffer))
9157 ;; Remove any trailing spaces in path
9159 (setq path (replace-match "" t t path)))
9160 (if (and org-link-translation-function
9161 (fboundp org-link-translation-function))
9162 ;; Check if we need to translate the link
9163 (let ((tmp (funcall org-link-translation-function type path)))
9164 (setq type (car tmp) path (cdr tmp))))
9166 (cond
9168 ((assoc type org-link-protocols)
9169 (funcall (nth 1 (assoc type org-link-protocols)) path))
9171 ((equal type "mailto")
9172 (let ((cmd (car org-link-mailto-program))
9173 (args (cdr org-link-mailto-program)) args1
9174 (address path) (subject "") a)
9176 (setq address (match-string 1 path)
9177 subject (org-link-escape (match-string 2 path))))
9178 (while args
9179 (cond
9180 ((not (stringp (car args))) (push (pop args) args1))
9181 (t (setq a (pop args))
9182 (if (string-match "%a" a)
9183 (setq a (replace-match address t t a)))
9184 (if (string-match "%s" a)
9185 (setq a (replace-match subject t t a)))
9186 (push a args1))))
9187 (apply cmd (nreverse args1))))
9189 ((member type '("http" "https" "ftp" "news"))
9190 (browse-url (concat type ":" (org-link-escape
9191 path org-link-escape-chars-browser))))
9193 ((string= type "doi")
9194 (browse-url (concat "http://dx.doi.org/"
9195 (org-link-escape
9196 path org-link-escape-chars-browser))))
9198 ((member type '("message"))
9199 (browse-url (concat type ":" path)))
9201 ((string= type "tags")
9202 (org-tags-view in-emacs path))
9204 ((string= type "tree-match")
9207 ((string= type "file")
9209 (setq line (string-to-number (match-string 1 path))
9210 path (substring path 0 (match-beginning 0)))
9212 (setq search (match-string 1 path)
9213 path (substring path 0 (match-beginning 0)))))
9214 (if (string-match "[*?{]" (file-name-nondirectory path))
9215 (dired path)
9216 (org-open-file path in-emacs line search)))
9218 ((string= type "shell")
9219 (let ((cmd path))
9220 (if (or (not org-confirm-shell-link-function)
9221 (funcall org-confirm-shell-link-function
9223 (org-add-props cmd nil
9224 'face 'org-warning))))
9225 (progn
9226 (message "Executing %s" cmd)
9227 (shell-command cmd))
9228 (error "Abort"))))
9230 ((string= type "elisp")
9231 (let ((cmd path))
9232 (if (or (not org-confirm-elisp-link-function)
9233 (funcall org-confirm-elisp-link-function
9235 (org-add-props cmd nil
9236 'face 'org-warning))))
9237 (message "%s => %s" cmd
9238 (if (equal (string-to-char cmd) ?\()
9239 (eval (read cmd))
9240 (call-interactively (read cmd))))
9241 (error "Abort"))))
9243 ((and (string= type "thisfile")
9244 (run-hook-with-args-until-success
9245 'org-open-link-functions path)))
9247 ((string= type "thisfile")
9248 (if in-emacs
9249 (switch-to-buffer-other-window
9250 (org-get-buffer-for-internal-link (current-buffer)))
9251 (org-mark-ring-push))
9252 (let ((cmd `(org-link-search
9253 ,path
9254 ,(cond ((equal in-emacs '(4)) 'occur)
9255 ((equal in-emacs '(16)) 'org-occur)
9256 (t nil))
9257 ,pos)))
9258 (condition-case nil (eval cmd)
9259 (error (progn (widen) (eval cmd))))))
9261 (t
9262 (browse-url-at-point)))))))
9263 (move-marker org-open-link-marker nil)
9264 (run-hook-with-args 'org-follow-link-hook)))
9266 (defun org-offer-links-in-entry (&optional nth zero)
9267 "Offer links in the current entry and follow the selected link.
9268 If there is only one link, follow it immediately as well.
9269 If NTH is an integer, immediately pick the NTH link found.
9270 If ZERO is a string, check also this string for a link, and if
9271 there is one, offer it as link number zero."
9275 (cnt ?0)
9276 (in-emacs (if (integerp nth) nil nth))
9277 have-zero end links link c)
9278 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9279 (push (match-string 0 zero) links)
9280 (setq cnt (1- cnt) have-zero t))
9281 (save-excursion
9282 (org-back-to-heading t)
9283 (setq end (save-excursion (outline-next-heading) (point)))
9284 (while (re-search-forward re end t)
9285 (push (match-string 0) links))
9286 (setq links (org-uniquify (reverse links))))
9288 (cond
9289 ((null links)
9290 (message "No links"))
9291 ((equal (length links) 1)
9292 (setq link (list (car links))))
9293 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9294 (setq link (nth (if have-zero nth (1- nth)) links)))
9295 (t ; we have to select a link
9296 (save-excursion
9297 (save-window-excursion
9298 (delete-other-windows)
9299 (with-output-to-temp-buffer "*Select Link*"
9300 (mapc (lambda (l)
9301 (if (not (string-match org-bracket-link-regexp l))
9303 (org-remove-angle-brackets l)))
9304 (if (match-end 3)
9306 (match-string 3 l) (match-string 1 l)))
9308 (match-string 1 l))))))
9309 links))
9310 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9311 (message "Select link to open, RET to open all:")
9312 (setq c (read-char-exclusive))
9313 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9314 (when (equal c ?q) (error "Abort"))
9315 (if (equal c ?\C-m)
9316 (setq link links)
9317 (setq nth (- c ?0))
9318 (if have-zero (setq nth (1+ nth)))
9319 (unless (and (integerp nth) (>= (length links) nth))
9320 (error "Invalid link selection"))
9321 (setq link (list (nth (1- nth) links))))))
9322 (if link
9323 (let ((buf (current-buffer)))
9324 (dolist (l link)
9325 (org-open-link-from-string l in-emacs buf))
9326 t)
9327 nil)))
9329 ;; Add special file links that specify the way of opening
9331 (org-add-link-type "file+sys" 'org-open-file-with-system)
9332 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9333 (defun org-open-file-with-system (path)
9334 "Open file at PATH using the system way of opening it."
9335 (org-open-file path 'system))
9336 (defun org-open-file-with-emacs (path)
9337 "Open file at PATH in Emacs."
9338 (org-open-file path 'emacs))
9339 (defun org-remove-file-link-modifiers ()
9340 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9341 (goto-char (point-min))
9343 (org-if-unprotected
9344 (replace-match "file:" t t))))
9345 (eval-after-load "org-exp"
9346 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9347 'org-remove-file-link-modifiers))
9349 ;;;; Time estimates
9351 (defun org-get-effort (&optional pom)
9352 "Get the effort estimate for the current entry."
9353 (org-entry-get pom org-effort-property))
9355 ;;; File search
9357 (defvar org-create-file-search-functions nil
9358 "List of functions to construct the right search string for a file link.
9359 These functions are called in turn with point at the location to
9360 which the link should point.
9362 A function in the hook should first test if it would like to
9363 handle this file type, for example by checking the `major-mode'
9364 or the file extension. If it decides not to handle this file, it
9365 should just return nil to give other functions a chance. If it
9366 does handle the file, it must return the search string to be used
9367 when following the link. The search string will be part of the
9368 file link, given after a double colon, and `org-open-at-point'
9369 will automatically search for it. If special measures must be
9370 taken to make the search successful, another function should be
9371 added to the companion hook `org-execute-file-search-functions',
9372 which see.
9374 A function in this hook may also use `setq' to set the variable
9375 `description' to provide a suggestion for the descriptive text to
9376 be used for this link when it gets inserted into an Org-mode
9379 (defvar org-execute-file-search-functions nil
9380 "List of functions to execute a file search triggered by a link.
9382 Functions added to this hook must accept a single argument, the
9383 search string that was part of the file link, the part after the
9384 double colon. The function must first check if it would like to
9385 handle this search, for example by checking the `major-mode' or
9386 the file extension. If it decides not to handle this search, it
9387 should just return nil to give other functions a chance. If it
9388 does handle the search, it must return a non-nil value to keep
9389 other functions from trying.
9391 Each function can access the current prefix argument through the
9392 variable `current-prefix-argument'. Note that a single prefix is
9393 used to force opening a link in Emacs, so it may be good to only
9394 use a numeric or double prefix to guide the search function.
9396 In case this is needed, a function in this hook can also restore
9397 the window configuration before `org-open-at-point' was called using:
9399 (set-window-configuration org-window-config-before-follow-link)")
9401 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9402 (defun org-link-search (s &optional type avoid-pos)
9403 "Search for a link search option.
9404 If S is surrounded by forward slashes, it is interpreted as a
9405 regular expression. In org-mode files, this will create an `org-occur'
9406 sparse tree. In ordinary files, `occur' will be used to list matches.
9407 If the current buffer is in `dired-mode', grep will be used to search
9408 in all files. If AVOID-POS is given, ignore matches near that position."
9409 (let ((case-fold-search t)
9413 org-emphasis-alist)
9415 (pos (point))
9416 (pre nil) (post nil)
9417 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9418 (cond
9419 ;; First check if there are any special search functions
9420 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9421 ;; Now try the builtin stuff
9422 ((and (equal (string-to-char s0) ?#)
9423 (> (length s0) 1)
9424 (save-excursion
9425 (goto-char (point-min))
9426 (and
9427 (re-search-forward
9429 (setq type 'dedicated
9430 pos (match-beginning 0))))
9431 ;; There is an exact target for this
9432 (goto-char pos)
9433 (org-back-to-heading t)))
9434 ((save-excursion
9435 (goto-char (point-min))
9436 (and
9437 (re-search-forward
9438 (concat "<<" (regexp-quote s0) ">>") nil t)
9439 (setq type 'dedicated
9440 pos (match-beginning 0))))
9441 ;; There is an exact target for this
9442 (goto-char pos))
9444 (save-excursion
9445 (goto-char (point-min))
9446 (and
9447 (re-search-forward
9448 (concat "[^[]" (regexp-quote
9449 (format org-coderef-label-format
9450 (match-string 1 s0))))
9451 nil t)
9452 (setq type 'dedicated
9453 pos (1+ (match-beginning 0))))))
9454 ;; There is a coderef target for this
9455 (goto-char pos))
9457 ;; A regular expression
9458 (cond
9459 ((org-mode-p)
9460 (org-occur (match-string 1 s)))
9461 ;;((eq major-mode 'dired-mode)
9462 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9463 (t (org-do-occur (match-string 1 s)))))
9464 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9465 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9466 (goto-char (point-min))
9467 (cond
9468 ((let (case-fold-search)
9469 (re-search-forward (format org-complex-heading-regexp-format
9470 (regexp-quote s))
9471 nil t))
9472 ;; OK, found a match
9473 (setq type 'dedicated)
9474 (goto-char (match-beginning 0)))
9475 ((and (not org-link-search-inhibit-query)
9476 (eq org-link-search-must-match-exact-headline 'query-to-create)
9477 (y-or-n-p "No match - create this as a new heading? "))
9478 (goto-char (point-max))
9479 (or (bolp) (newline))
9481 (beginning-of-line 0))
9482 (t
9483 (goto-char pos)
9484 (error "No match"))))
9485 (t
9486 ;; A normal search string
9487 (when (equal (string-to-char s) ?*)
9488 ;; Anchor on headlines, post may include tags.
9491 s (substring s 1)))
9492 (remove-text-properties
9493 0 (length s)
9494 '(face nil mouse-face nil keymap nil fontified nil) s)
9495 ;; Make a series of regular expressions to find a match
9504 re4 (concat "[^a-zA-Z_]" re4_)
9506 re1 (concat pre re2 post)
9507 re3 (concat pre (if pre re4_ re4) post)
9508 re5 (concat pre ".*" re4)
9509 re2 (concat pre re2)
9510 re2a (concat pre (if pre re2a_ re2a))
9511 re4 (concat pre (if pre re4_ re4))
9515 ))
9516 (cond
9517 ((eq type 'org-occur) (org-occur reall))
9518 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9519 (t (goto-char (point-min))
9520 (setq type 'fuzzy)
9521 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9522 (org-search-not-self 1 re1 nil t)
9523 (org-search-not-self 1 re2 nil t)
9524 (org-search-not-self 1 re2a nil t)
9525 (org-search-not-self 1 re3 nil t)
9526 (org-search-not-self 1 re4 nil t)
9527 (org-search-not-self 1 re5 nil t)
9528 )
9529 (goto-char (match-beginning 1))
9530 (goto-char pos)
9531 (error "No match"))))))
9532 (and (org-mode-p) (org-show-context 'link-search))
9533 type))
9535 (defun org-search-not-self (group &rest args)
9536 "Execute `re-search-forward', but only accept matches that do not
9537 enclose the position of `org-open-link-marker'."
9538 (let ((m org-open-link-marker))
9539 (catch 'exit
9540 (while (apply 're-search-forward args)
9541 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9542 (goto-char (match-end group))
9543 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9544 (> (match-beginning 0) (marker-position m))
9545 (< (match-end 0) (marker-position m)))
9546 (save-match-data
9547 (or (not (org-in-regexp
9548 org-bracket-link-analytic-regexp 1))
9549 (not (match-end 4)) ; no description
9550 (and (<= (match-beginning 4) (point))
9551 (>= (match-end 4) (point))))))
9552 (throw 'exit (point))))))))
9554 (defun org-get-buffer-for-internal-link (buffer)
9555 "Return a buffer to be used for displaying the link target of internal links."
9556 (cond
9557 ((not org-display-internal-link-with-indirect-buffer)
9558 buffer)
9559 ((string-match "(Clone)$" (buffer-name buffer))
9560 (message "Buffer is already a clone, not making another one")
9561 ;; we also do not modify visibility in this case
9562 buffer)
9563 (t ; make a new indirect buffer for displaying the link
9564 (let* ((bn (buffer-name buffer))
9565 (ibn (concat bn "(Clone)"))
9566 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9567 (with-current-buffer ib (org-overview))
9568 ib))))
9570 (defun org-do-occur (regexp &optional cleanup)
9571 "Call the Emacs command `occur'.
9572 If CLEANUP is non-nil, remove the printout of the regular expression
9573 in the *Occur* buffer. This is useful if the regex is long and not useful
9574 to read."
9575 (occur regexp)
9576 (when cleanup
9577 (let ((cwin (selected-window)) win beg end)
9578 (when (setq win (get-buffer-window "*Occur*"))
9579 (select-window win))
9580 (goto-char (point-min))
9581 (when (re-search-forward "match[a-z]+" nil t)
9582 (setq beg (match-end 0))
9584 (setq end (1- (match-beginning 0)))))
9585 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9586 (goto-char (point-min))
9587 (select-window cwin))))
9589 ;;; The mark ring for links jumps
9591 (defvar org-mark-ring nil
9592 "Mark ring for positions before jumps in Org-mode.")
9593 (defvar org-mark-ring-last-goto nil
9594 "Last position in the mark ring used to go back.")
9595 ;; Fill and close the ring
9596 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9597 (loop for i from 1 to org-mark-ring-length do
9598 (push (make-marker) org-mark-ring))
9599 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9600 org-mark-ring)
9602 (defun org-mark-ring-push (&optional pos buffer)
9603 "Put the current position or POS into the mark ring and rotate it."
9604 (interactive)
9605 (setq pos (or pos (point)))
9606 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9607 (move-marker (car org-mark-ring)
9608 (or pos (point))
9609 (or buffer (current-buffer)))
9610 (message "%s"
9611 (substitute-command-keys
9614 (defun org-mark-ring-goto (&optional n)
9615 "Jump to the previous position in the mark ring.
9616 With prefix arg N, jump back that many stored positions. When
9617 called several times in succession, walk through the entire ring.
9618 Org-mode commands jumping to a different position in the current file,
9619 or to another Org-mode file, automatically push the old position
9620 onto the ring."
9621 (interactive "p")
9622 (let (p m)
9623 (if (eq last-command this-command)
9624 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9625 (setq p org-mark-ring))
9626 (setq org-mark-ring-last-goto p)
9627 (setq m (car p))
9628 (switch-to-buffer (marker-buffer m))
9629 (goto-char m)
9630 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9632 (defun org-remove-angle-brackets (s)
9633 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9634 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9635 s)
9636 (defun org-add-angle-brackets (s)
9637 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9638 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9639 s)
9640 (defun org-remove-double-quotes (s)
9643 s)
9645 ;;; Following specific links
9647 (defun org-follow-timestamp-link ()
9648 (cond
9649 ((org-at-date-range-p t)
9650 (let ((org-agenda-start-on-weekday)
9651 (t1 (match-string 1))
9652 (t2 (match-string 2)))
9653 (setq t1 (time-to-days (org-time-string-to-time t1))
9654 t2 (time-to-days (org-time-string-to-time t2)))
9655 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9656 ((org-at-timestamp-p t)
9657 (org-agenda-list nil (time-to-days (org-time-string-to-time
9658 (substring (match-string 1) 0 10)))
9659 1))
9660 (t (error "This should not happen"))))
9663 ;;; Following file links
9664 (defvar org-wait nil)
9665 (defun org-open-file (path &optional in-emacs line search)
9666 "Open the file at PATH.
9667 First, this expands any special file name abbreviations. Then the
9668 configuration variable `org-file-apps' is checked if it contains an
9669 entry for this file type, and if yes, the corresponding command is launched.
9671 If no application is found, Emacs simply visits the file.
9673 With optional prefix argument IN-EMACS, Emacs will visit the file.
9675 prefix arg, Org tries to avoid opening in Emacs
9676 and to use an external application to visit the file.
9678 Optional LINE specifies a line to go to, optional SEARCH a string
9679 to search for. If LINE or SEARCH is given, the file will be
9680 opened in Emacs, unless an entry from org-file-apps that makes
9681 use of groups in a regexp matches.
9682 If the file does not exist, an error is thrown."
9683 (let* ((file (if (equal path "")
9684 buffer-file-name
9685 (substitute-in-file-name (expand-file-name path))))
9686 (file-apps (append org-file-apps (org-default-apps)))
9687 (apps (org-remove-if
9688 'org-file-apps-entry-match-against-dlink-p file-apps))
9689 (apps-dlink (org-remove-if-not
9690 'org-file-apps-entry-match-against-dlink-p file-apps))
9691 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9692 (dirp (if remp nil (file-directory-p file)))
9693 (file (if (and dirp org-open-directory-means-index-dot-org)
9694 (concat (file-name-as-directory file) "index.org")
9695 file))
9696 (a-m-a-p (assq 'auto-mode apps))
9697 (dfile (downcase file))
9698 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9699 (link (cond ((and (eq line nil)
9700 (eq search nil))
9701 file)
9702 (line
9703 (concat file "::" (number-to-string line)))
9704 (search
9705 (concat file "::" search))))
9706 (dlink (downcase link))
9707 (old-buffer (current-buffer))
9708 (old-pos (point))
9709 (old-mode major-mode)
9710 ext cmd link-match-data)
9712 (setq ext (match-string 1 dfile))
9714 (setq ext (match-string 1 dfile))))
9715 (cond
9716 ((member in-emacs '((16) system))
9717 (setq cmd (cdr (assoc 'system apps))))
9718 (in-emacs (setq cmd 'emacs))
9719 (t
9720 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9721 (and dirp (cdr (assoc 'directory apps)))
9722 ; first, try matching against apps-dlink
9723 ; if we get a match here, store the match data for later
9724 (let ((match (assoc-default dlink apps-dlink
9725 'string-match)))
9726 (if match
9727 (progn (setq link-match-data (match-data))
9728 match)
9729 (progn (setq in-emacs (or in-emacs line search))
9730 nil))) ; if we have no match in apps-dlink,
9731 ; always open the file in emacs if line or search
9732 ; is given (for backwards compatibility)
9733 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9734 'string-match)
9735 (cdr (assoc ext apps))
9736 (cdr (assoc t apps))))))
9737 (when (eq cmd 'system)
9738 (setq cmd (cdr (assoc 'system apps))))
9739 (when (eq cmd 'default)
9740 (setq cmd (cdr (assoc t apps))))
9741 (when (eq cmd 'mailcap)
9742 (require 'mailcap)
9743 (mailcap-parse-mailcaps)
9744 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9745 (command (mailcap-mime-info mime-type)))
9746 (if (stringp command)
9747 (setq cmd command)
9748 (setq cmd 'emacs))))
9749 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9750 (not (file-exists-p file))
9751 (not org-open-non-existing-files))
9752 (error "No such file: %s" file))
9753 (cond
9755 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9757 (setq cmd (replace-match "%s" t t cmd)))
9758 (while (string-match "%s" cmd)
9759 (setq cmd (replace-match
9760 (save-match-data
9761 (shell-quote-argument
9762 (convert-standard-filename file)))
9763 t t cmd)))
9765 ;; Replace "%1", "%2" etc. in command with group matches from regex
9766 (save-match-data
9767 (let ((match-index 1)
9768 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9769 (set-match-data link-match-data)
9770 (while (<= match-index number-of-groups)
9771 (let ((regex (concat "%" (number-to-string match-index)))
9772 (replace-with (match-string match-index dlink)))
9773 (while (string-match regex cmd)
9774 (setq cmd (replace-match replace-with t t cmd))))
9775 (setq match-index (+ match-index 1)))))
9777 (save-window-excursion
9778 (start-process-shell-command cmd nil cmd)
9779 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9780 ))
9781 ((or (stringp cmd)
9782 (eq cmd 'emacs))
9783 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9784 (widen)
9785 (if line (org-goto-line line)
9786 (if search (org-link-search search))))
9787 ((consp cmd)
9788 (let ((file (convert-standard-filename file)))
9789 (save-match-data
9790 (set-match-data link-match-data)
9791 (eval cmd))))
9792 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9793 (and (org-mode-p) (eq old-mode 'org-mode)
9794 (or (not (equal old-buffer (current-buffer)))
9795 (not (equal old-pos (point))))
9796 (org-mark-ring-push old-pos old-buffer))))
9798 (defun org-file-apps-entry-match-against-dlink-p (entry)
9799 "This function returns non-nil if `entry' uses a regular
9800 expression which should be matched against the whole link by
9801 org-open-file.
9803 It assumes that is the case when the entry uses a regular
9804 expression which has at least one grouping construct and the
9805 action is either a lisp form or a command string containing
9806 '%1', i.e. using at least one subexpression match as a
9807 parameter."
9808 (let ((selector (car entry))
9809 (action (cdr entry)))
9810 (if (stringp selector)
9811 (and (> (regexp-opt-depth selector) 0)
9812 (or (and (stringp action)
9813 (string-match "%[0-9]" action))
9814 (consp action)))
9815 nil)))
9817 (defun org-default-apps ()
9818 "Return the default applications for this operating system."
9819 (cond
9820 ((eq system-type 'darwin)
9821 org-file-apps-defaults-macosx)
9822 ((eq system-type 'windows-nt)
9823 org-file-apps-defaults-windowsnt)
9824 (t org-file-apps-defaults-gnu)))
9826 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9827 "Convert extensions to regular expressions in the cars of LIST.
9828 Also, weed out any non-string entries, because the return value is used
9829 only for regexp matching.
9830 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9831 point to the symbol `emacs', indicating that the file should
9832 be opened in Emacs."
9833 (append
9834 (delq nil
9835 (mapcar (lambda (x)
9836 (if (not (stringp (car x)))
9837 nil
9839 x
9841 list))
9842 (if add-auto-mode
9843 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9845 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9846 (defun org-file-remote-p (file)
9847 "Test whether FILE specifies a location on a remote system.
9848 Return non-nil if the location is indeed remote.
9852 (cond ((fboundp 'file-remote-p)
9853 (file-remote-p file))
9854 ((fboundp 'tramp-handle-file-remote-p)
9855 (tramp-handle-file-remote-p file))
9856 ((and (boundp 'ange-ftp-name-format)
9857 (string-match (car ange-ftp-name-format) file))
9858 t)
9859 (t nil)))
9862 ;;;; Refiling
9864 (defun org-get-org-file ()
9865 "Read a filename, with default directory `org-directory'."
9866 (let ((default (or org-default-notes-file remember-data-file)))
9867 (read-file-name (format "File name [%s]: " default)
9868 (file-name-as-directory org-directory)
9869 default)))
9871 (defun org-notes-order-reversed-p ()
9872 "Check if the current file should receive notes in reversed order."
9873 (cond
9874 ((not org-reverse-note-order) nil)
9875 ((eq t org-reverse-note-order) t)
9876 ((not (listp org-reverse-note-order)) nil)
9877 (t (catch 'exit
9878 (let ((all org-reverse-note-order)
9879 entry)
9880 (while (setq entry (pop all))
9881 (if (string-match (car entry) buffer-file-name)
9882 (throw 'exit (cdr entry))))
9883 nil)))))
9885 (defvar org-refile-target-table nil
9886 "The list of refile targets, created by `org-refile'.")
9888 (defvar org-agenda-new-buffers nil
9889 "Buffers created to visit agenda files.")
9891 (defvar org-refile-cache nil
9892 "Cache for refile targets.")
9895 (defvar org-refile-markers nil
9896 "All the markers used for caching refile locations.")
9898 (defun org-refile-marker (pos)
9899 "Get a new refile marker, but only if caching is in use."
9900 (if (not org-refile-use-cache)
9901 pos
9902 (let ((m (make-marker)))
9903 (move-marker m pos)
9904 (push m org-refile-markers)
9905 m)))
9907 (defun org-refile-cache-clear ()
9908 "Clear the refile cache and disable all the markers."
9909 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
9910 (setq org-refile-markers nil)
9911 (setq org-refile-cache nil)
9912 (message "Refile cache has been cleared"))
9914 (defun org-refile-cache-check-set (set)
9915 "Check if all the markers in the cache still have live buffers."
9916 (let (marker)
9917 (catch 'exit
9918 (while (and set (setq marker (nth 3 (pop set))))
9919 ;; if org-refile-use-outline-path is 'file, marker may be nil
9920 (when (and marker (null (marker-buffer marker)))
9921 (message "not found") (sit-for 3)
9922 (throw 'exit nil)))
9923 t)))
9925 (defun org-refile-cache-put (set &rest identifiers)
9926 "Push the refile targets SET into the cache, under IDENTIFIERS."
9927 (let* ((key (sha1 (prin1-to-string identifiers)))
9928 (entry (assoc key org-refile-cache)))
9929 (if entry
9930 (setcdr entry set)
9931 (push (cons key set) org-refile-cache))))
9933 (defun org-refile-cache-get (&rest identifiers)
9934 "Retrieve the cached value for refile targets given by IDENTIFIERS."
9935 (cond
9936 ((not org-refile-cache) nil)
9937 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
9938 (t
9939 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
9940 org-refile-cache))))
9941 (and set (org-refile-cache-check-set set) set)))))
9943 (defun org-get-refile-targets (&optional default-buffer)
9944 "Produce a table with refile targets."
9945 (let ((case-fold-search nil)
9946 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
9947 (entries (or org-refile-targets '((nil . (:level . 1)))))
9948 targets tgs txt re files f desc descre fast-path-p level pos0)
9949 (message "Getting targets...")
9950 (with-current-buffer (or default-buffer (current-buffer))
9951 (while (setq entry (pop entries))
9952 (setq files (car entry) desc (cdr entry))
9953 (setq fast-path-p nil)
9954 (cond
9955 ((null files) (setq files (list (current-buffer))))
9956 ((eq files 'org-agenda-files)
9957 (setq files (org-agenda-files 'unrestricted)))
9958 ((and (symbolp files) (fboundp files))
9959 (setq files (funcall files)))
9960 ((and (symbolp files) (boundp files))
9961 (setq files (symbol-value files))))
9962 (if (stringp files) (setq files (list files)))
9963 (cond
9964 ((eq (car desc) :tag)
9966 ((eq (car desc) :todo)
9968 ((eq (car desc) :regexp)
9969 (setq descre (cdr desc)))
9970 ((eq (car desc) :level)
9972 (if org-odd-levels-only
9973 (1- (* 2 (cdr desc)))
9974 (cdr desc)))
9976 ((eq (car desc) :maxlevel)
9977 (setq fast-path-p t)
9979 (if org-odd-levels-only
9980 (1- (* 2 (cdr desc)))
9981 (cdr desc)))
9983 (t (error "Bad refiling target description %s" desc)))
9984 (while (setq f (pop files))
9985 (with-current-buffer
9986 (if (bufferp f) f (org-get-agenda-file-buffer f))
9987 (or
9988 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
9989 (progn
9990 (if (bufferp f) (setq f (buffer-file-name
9991 (buffer-base-buffer f))))
9992 (setq f (and f (expand-file-name f)))
9993 (if (eq org-refile-use-outline-path 'file)
9994 (push (list (file-name-nondirectory f) f nil nil) tgs))
9995 (save-excursion
9996 (save-restriction
9997 (widen)
9998 (goto-char (point-min))
9999 (while (re-search-forward descre nil t)
10000 (goto-char (setq pos0 (point-at-bol)))
10001 (catch 'next
10002 (when org-refile-target-verify-function
10003 (save-match-data
10004 (or (funcall org-refile-target-verify-function)
10005 (throw 'next t))))
10006 (when (looking-at org-complex-heading-regexp)
10007 (setq level (org-reduced-level
10008 (- (match-end 1) (match-beginning 1)))
10009 txt (org-link-display-format (match-string 4))
10011 re (format org-complex-heading-regexp-format
10012 (regexp-quote (match-string 4))))
10013 (when org-refile-use-outline-path
10014 (setq txt (mapconcat
10015 'org-protect-slash
10016 (append
10017 (if (eq org-refile-use-outline-path
10018 'file)
10019 (list (file-name-nondirectory
10020 (buffer-file-name
10021 (buffer-base-buffer))))
10022 (if (eq org-refile-use-outline-path
10023 'full-file-path)
10024 (list (buffer-file-name
10025 (buffer-base-buffer)))))
10026 (org-get-outline-path fast-path-p
10027 level txt)
10028 (list txt))
10029 "/")))
10030 (push (list txt f re (org-refile-marker (point)))
10031 tgs)))
10032 (when (= (point) pos0)
10033 ;; verification function has not moved point
10034 (goto-char (point-at-eol))))))))
10035 (when org-refile-use-cache
10036 (org-refile-cache-put tgs (buffer-file-name) descre))
10037 (setq targets (append tgs targets))
10038 ))))
10039 (message "Getting targets...done")
10040 (nreverse targets)))
10042 (defun org-protect-slash (s)
10043 (while (string-match "/" s)
10045 s)
10047 (defvar org-olpa (make-vector 20 nil))
10049 (defun org-get-outline-path (&optional fastp level heading)
10050 "Return the outline path to the current entry, as a list.
10052 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10053 routine which makes outline path derivations for an entire file,
10054 avoiding backtracing. Refile target collection makes use of that."
10055 (if fastp
10056 (progn
10057 (if (> level 19)
10058 (error "Outline path failure, more than 19 levels"))
10059 (loop for i from level upto 19 do
10060 (aset org-olpa i nil))
10061 (prog1
10062 (delq nil (append org-olpa nil))
10063 (aset org-olpa level heading)))
10064 (let (rtn case-fold-search)
10065 (save-excursion
10066 (save-restriction
10067 (widen)
10068 (while (org-up-heading-safe)
10069 (when (looking-at org-complex-heading-regexp)
10070 (push (org-match-string-no-properties 4) rtn)))
10071 rtn)))))
10073 (defun org-format-outline-path (path &optional width prefix)
10074 "Format the outline path PATH for display.
10075 Width is the maximum number of characters that is available.
10076 Prefix is a prefix to be included in the returned string,
10077 such as the file name."
10078 (setq width (or width 79))
10079 (if prefix (setq width (- width (length prefix))))
10080 (if (not path)
10081 (or prefix "")
10082 (let* ((nsteps (length path))
10083 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10084 (maxwidth (if (<= total-width width)
10085 10000 ;; everything fits
10086 ;; we need to shorten the level headings
10087 (/ (- width nsteps) nsteps)))
10088 (org-odd-levels-only nil)
10089 (n 0)
10090 (total (1+ (length prefix))))
10091 (setq maxwidth (max maxwidth 10))
10092 (concat prefix
10093 (mapconcat
10094 (lambda (h)
10095 (setq n (1+ n))
10096 (if (and (= n nsteps) (< maxwidth 10000))
10097 (setq maxwidth (- total-width total)))
10098 (if (< (length h) maxwidth)
10099 (progn (setq total (+ total (length h) 1)) h)
10100 (setq h (substring h 0 (- maxwidth 2))
10101 total (+ total maxwidth 1))
10103 (setq h (substring h 0 (match-beginning 0))))
10104 (setq h (concat h "..")))
10105 (org-add-props h nil 'face
10106 (nth (% (1- n) org-n-level-faces)
10107 org-level-faces))
10108 h)
10109 path "/")))))
10111 (defun org-display-outline-path (&optional file current)
10112 "Display the current outline path in the echo area."
10113 (interactive "P")
10114 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10115 (case-fold-search nil)
10116 (path (and (org-mode-p) (org-get-outline-path))))
10117 (if current (setq path (append path
10118 (save-excursion
10119 (org-back-to-heading t)
10120 (if (looking-at org-complex-heading-regexp)
10121 (list (match-string 4)))))))
10122 (message "%s"
10123 (org-format-outline-path
10124 path
10125 (1- (frame-width))
10126 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10128 (defvar org-refile-history nil
10129 "History for refiling operations.")
10131 (defvar org-after-refile-insert-hook nil
10132 "Hook run after `org-refile' has inserted its stuff at the new location.
10133 Note that this is still *before* the stuff will be removed from
10134 the *old* location.")
10136 (defvar org-capture-last-stored-marker)
10137 (defun org-refile (&optional goto default-buffer rfloc)
10138 "Move the entry at point to another heading.
10139 The list of target headings is compiled using the information in
10140 `org-refile-targets', which see. This list is created before each use
10141 and will therefore always be up-to-date.
10143 At the target location, the entry is filed as a subitem of the target heading.
10144 Depending on `org-reverse-note-order', the new subitem will either be the
10145 first or the last subitem.
10147 If there is an active region, all entries in that region will be moved.
10148 However, the region must fulfill the requirement that the first heading
10149 is the first one sets the top-level of the moved text - at most siblings
10150 below it are allowed.
10152 With prefix arg GOTO, the command will only visit the target location,
10153 not actually move anything.
10155 go to the location where the last refiling
10156 operation has put the subtree.
10157 With a prefix argument of `2', refile to the running clock.
10159 RFLOC can be a refile location obtained in a different way.
10161 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10163 If you are using target caching (see `org-refile-use-cache'),
10164 You have to clear the target cache in order to find new targets.
10165 This can be done with a 0 prefix: `C-0 C-c C-w'"
10166 (interactive "P")
10167 (if (member goto '(0 (64)))
10168 (org-refile-cache-clear)
10169 (let* ((cbuf (current-buffer))
10170 (regionp (org-region-active-p))
10171 (region-start (and regionp (region-beginning)))
10172 (region-end (and regionp (region-end)))
10173 (region-length (and regionp (- region-end region-start)))
10174 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10175 pos it nbuf file re level reversed)
10176 (setq last-command nil)
10177 (when regionp
10178 (goto-char region-start)
10179 (or (bolp) (goto-char (point-at-bol)))
10180 (setq region-start (point))
10181 (unless (org-kill-is-subtree-p
10182 (buffer-substring region-start region-end))
10183 (error "The region is not a (sequence of) subtree(s)")))
10184 (if (equal goto '(16))
10185 (org-refile-goto-last-stored)
10186 (when (or
10187 (and (equal goto 2)
10188 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10189 (prog1
10190 (setq it (list (or org-clock-heading "running clock")
10191 (buffer-file-name
10192 (marker-buffer org-clock-hd-marker))
10193 ""
10194 (marker-position org-clock-hd-marker)))
10195 (setq goto nil)))
10196 (setq it (or rfloc
10197 (save-excursion
10198 (org-refile-get-location
10199 (if goto "Goto: " "Refile to: ") default-buffer
10200 org-refile-allow-creating-parent-nodes)))))
10201 (setq file (nth 1 it)
10202 re (nth 2 it)
10203 pos (nth 3 it))
10204 (if (and (not goto)
10205 pos
10206 (equal (buffer-file-name) file)
10207 (if regionp
10208 (and (>= pos region-start)
10209 (<= pos region-end))
10210 (and (>= pos (point))
10211 (< pos (save-excursion
10212 (org-end-of-subtree t t))))))
10213 (error "Cannot refile to position inside the tree or region"))
10215 (setq nbuf (or (find-buffer-visiting file)
10216 (find-file-noselect file)))
10217 (if goto
10218 (progn
10219 (switch-to-buffer nbuf)
10220 (goto-char pos)
10221 (org-show-context 'org-goto))
10222 (if regionp
10223 (progn
10224 (org-kill-new (buffer-substring region-start region-end))
10225 (org-save-markers-in-region region-start region-end))
10226 (org-copy-subtree 1 nil t))
10227 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10228 (find-file-noselect file)))
10229 (setq reversed (org-notes-order-reversed-p))
10230 (save-excursion
10231 (save-restriction
10232 (widen)
10233 (if pos
10234 (progn
10235 (goto-char pos)
10236 (looking-at outline-regexp)
10237 (setq level (org-get-valid-level (funcall outline-level) 1))
10238 (goto-char
10239 (if reversed
10240 (or (outline-next-heading) (point-max))
10241 (or (save-excursion (org-get-next-sibling))
10242 (org-end-of-subtree t t)
10243 (point-max)))))
10244 (setq level 1)
10245 (if (not reversed)
10246 (goto-char (point-max))
10247 (goto-char (point-min))
10248 (or (outline-next-heading) (goto-char (point-max)))))
10249 (if (not (bolp)) (newline))
10250 (org-paste-subtree level)
10251 (when org-log-refile
10252 (org-add-log-setup 'refile nil nil 'findpos
10253 org-log-refile)
10254 (unless (eq org-log-refile 'note)
10255 (save-excursion (org-add-log-note))))
10256 (and org-auto-align-tags (org-set-tags nil t))
10257 (bookmark-set "org-refile-last-stored")
10258 ;; If we are refiling for capture, make sure that the
10259 ;; last-capture pointers point here
10260 (when (org-bound-and-true-p org-refile-for-capture)
10261 (bookmark-set "org-capture-last-stored-marker")
10262 (move-marker org-capture-last-stored-marker (point)))
10263 (if (fboundp 'deactivate-mark) (deactivate-mark))
10264 (run-hooks 'org-after-refile-insert-hook))))
10265 (if regionp
10266 (delete-region (point) (+ (point) region-length))
10267 (org-cut-subtree))
10268 (when (featurep 'org-inlinetask)
10269 (org-inlinetask-remove-END-maybe))
10270 (setq org-markers-to-move nil)
10273 (defun org-refile-goto-last-stored ()
10274 "Go to the location where the last refile was stored."
10275 (interactive)
10276 (bookmark-jump "org-refile-last-stored")
10277 (message "This is the location of the last refile"))
10279 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10280 "Prompt the user for a refile location, using PROMPT."
10281 (let ((org-refile-targets org-refile-targets)
10282 (org-refile-use-outline-path org-refile-use-outline-path))
10283 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
10284 (unless org-refile-target-table
10285 (error "No refile targets"))
10286 (let* ((cbuf (current-buffer))
10287 (partial-completion-mode nil)
10288 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10289 (cfunc (if (and org-refile-use-outline-path
10290 org-outline-path-complete-in-steps)
10291 'org-olpath-completing-read
10292 'org-icompleting-read))
10293 (extra (if org-refile-use-outline-path "/" ""))
10294 (filename (and cfn (expand-file-name cfn)))
10295 (tbl (mapcar
10296 (lambda (x)
10297 (if (and (not (member org-refile-use-outline-path
10298 '(file full-file-path)))
10299 (not (equal filename (nth 1 x))))
10300 (cons (concat (car x) extra " ("
10301 (file-name-nondirectory (nth 1 x)) ")")
10302 (cdr x))
10303 (cons (concat (car x) extra) (cdr x))))
10304 org-refile-target-table))
10305 (completion-ignore-case t)
10306 pa answ parent-target child parent old-hist)
10307 (setq old-hist org-refile-history)
10308 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10309 nil 'org-refile-history))
10310 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10311 (org-refile-check-position pa)
10312 (if pa
10313 (progn
10314 (when (or (not org-refile-history)
10315 (not (eq old-hist org-refile-history))
10316 (not (equal (car pa) (car org-refile-history))))
10317 (setq org-refile-history
10318 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10319 org-refile-history
10320 (cdr org-refile-history))))
10321 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10322 (pop org-refile-history)))
10323 pa)
10325 (progn
10326 (setq parent (match-string 1 answ)
10327 child (match-string 2 answ))
10328 (setq parent-target (or (assoc parent tbl)
10329 (assoc (concat parent "/") tbl)))
10330 (when (and parent-target
10331 (or (eq new-nodes t)
10332 (and (eq new-nodes 'confirm)
10334 child)))))
10335 (org-refile-new-child parent-target child)))
10336 (error "Invalid target location")))))
10338 (defun org-refile-check-position (refile-pointer)
10339 "Check if the refile pointer matches the readline to which it points."
10340 (let* ((file (nth 1 refile-pointer))
10341 (re (nth 2 refile-pointer))
10342 (pos (nth 3 refile-pointer))
10343 buffer)
10344 (when (org-string-nw-p re)
10345 (setq buffer (if (markerp pos)
10346 (marker-buffer pos)
10347 (or (find-buffer-visiting file)
10348 (find-file-noselect file))))
10349 (with-current-buffer buffer
10350 (save-excursion
10351 (save-restriction
10352 (widen)
10353 (goto-char pos)
10354 (beginning-of-line 1)
10355 (unless (org-looking-at-p re)
10356 (error "Invalid refile position, please rebuild the cache"))))))))
10358 (defun org-refile-new-child (parent-target child)
10359 "Use refile target PARENT-TARGET to add new CHILD below it."
10360 (unless parent-target
10361 (error "Cannot find parent for new node"))
10362 (let ((file (nth 1 parent-target))
10363 (pos (nth 3 parent-target))
10364 level)
10365 (with-current-buffer (or (find-buffer-visiting file)
10366 (find-file-noselect file))
10367 (save-excursion
10368 (save-restriction
10369 (widen)
10370 (if pos
10371 (goto-char pos)
10372 (goto-char (point-max))
10373 (if (not (bolp)) (newline)))
10374 (when (looking-at outline-regexp)
10375 (setq level (funcall outline-level))
10376 (org-end-of-subtree t t))
10377 (org-back-over-empty-lines)
10379 (if pos (org-get-valid-level level 1) 1) ?*)
10381 (beginning-of-line 0)
10382 (list (concat (car parent-target) "/" child) file "" (point)))))))
10384 (defun org-olpath-completing-read (prompt collection &rest args)
10385 "Read an outline path like a file name."
10386 (let ((thetable collection)
10387 (org-completion-use-ido nil) ; does not work with ido.
10388 (org-completion-use-iswitchb nil)) ; or iswitchb
10389 (apply
10390 'org-icompleting-read prompt
10391 (lambda (string predicate &optional flag)
10392 (let (rtn r f (l (length string)))
10393 (cond
10394 ((eq flag nil)
10395 ;; try completion
10396 (try-completion string thetable))
10397 ((eq flag t)
10398 ;; all-completions
10399 (setq rtn (all-completions string thetable predicate))
10400 (mapcar
10401 (lambda (x)
10402 (setq r (substring x l))
10403 (if (string-match " ([^)]*)$" x)
10404 (setq f (match-string 0 x))
10405 (setq f ""))
10406 (if (string-match "/" r)
10407 (concat string (substring r 0 (match-end 0)) f)
10408 x))
10409 rtn))
10410 ((eq flag 'lambda)
10411 ;; exact match?
10412 (assoc string thetable)))
10413 ))
10414 args)))
10416 ;;;; Dynamic blocks
10418 (defun org-find-dblock (name)
10419 "Find the first dynamic block with name NAME in the buffer.
10420 If not found, stay at current position and return nil."
10421 (let (pos)
10422 (save-excursion
10423 (goto-char (point-min))
10425 nil t)
10426 (match-beginning 0))))
10427 (if pos (goto-char pos))
10428 pos))
10430 (defconst org-dblock-start-re
10432 "Matches the start line of a dynamic block, with parameters.")
10435 "Matches the end of a dynamic block.")
10437 (defun org-create-dblock (plist)
10438 "Create a dynamic block section, with parameters taken from PLIST.
10439 PLIST must contain a :name entry which is used as name of the block."
10441 (end-of-line 1)
10442 (newline))
10443 (let ((col (current-column))
10444 (name (plist-get plist :name)))
10445 (insert "#+BEGIN: " name)
10446 (while plist
10447 (if (eq (car plist) :name)
10448 (setq plist (cddr plist))
10449 (insert " " (prin1-to-string (pop plist)))))
10451 (beginning-of-line -2)))
10453 (defun org-prepare-dblock ()
10454 "Prepare dynamic block for refresh.
10455 This empties the block, puts the cursor at the insert position and returns
10456 the property list including an extra property :name with the block name."
10457 (unless (looking-at org-dblock-start-re)
10458 (error "Not at a dynamic block"))
10459 (let* ((begdel (1+ (match-end 0)))
10460 (name (org-no-properties (match-string 1)))
10461 (params (append (list :name name)
10462 (read (concat "(" (match-string 3) ")")))))
10463 (save-excursion
10464 (beginning-of-line 1)
10466 (setq params (plist-put params :indentation-column (current-column))))
10467 (unless (re-search-forward org-dblock-end-re nil t)
10468 (error "Dynamic block not terminated"))
10469 (setq params
10470 (append params
10471 (list :content (buffer-substring
10472 begdel (match-beginning 0)))))
10473 (delete-region begdel (match-beginning 0))
10474 (goto-char begdel)
10475 (open-line 1)
10476 params))
10478 (defun org-map-dblocks (&optional command)
10479 "Apply COMMAND to all dynamic blocks in the current buffer.
10480 If COMMAND is not given, use `org-update-dblock'."
10481 (let ((cmd (or command 'org-update-dblock)))
10482 (save-excursion
10483 (goto-char (point-min))
10484 (while (re-search-forward org-dblock-start-re nil t)
10485 (goto-char (match-beginning 0))
10486 (save-excursion
10487 (condition-case nil
10488 (funcall cmd)
10489 (error (message "Error during update of dynamic block"))))
10490 (unless (re-search-forward org-dblock-end-re nil t)
10491 (error "Dynamic block not terminated"))))))
10493 (defun org-dblock-update (&optional arg)
10494 "User command for updating dynamic blocks.
10495 Update the dynamic block at point. With prefix ARG, update all dynamic
10496 blocks in the buffer."
10497 (interactive "P")
10498 (if arg
10499 (org-update-all-dblocks)
10500 (or (looking-at org-dblock-start-re)
10501 (org-beginning-of-dblock))
10502 (org-update-dblock)))
10504 (defun org-update-dblock ()
10505 "Update the dynamic block at point.
10506 This means to empty the block, parse for parameters and then call
10507 the correct writing function."
10508 (interactive)
10509 (save-window-excursion
10510 (let* ((pos (point))
10511 (line (org-current-line))
10512 (params (org-prepare-dblock))
10513 (name (plist-get params :name))
10514 (indent (plist-get params :indentation-column))
10515 (cmd (intern (concat "org-dblock-write:" name))))
10516 (message "Updating dynamic block `%s' at line %d..." name line)
10517 (funcall cmd params)
10518 (message "Updating dynamic block `%s' at line %d...done" name line)
10519 (goto-char pos)
10520 (when (and indent (> indent 0))
10521 (setq indent (make-string indent ?\ ))
10522 (save-excursion
10523 (org-beginning-of-dblock)
10524 (forward-line 1)
10525 (while (not (looking-at org-dblock-end-re))
10526 (insert indent)
10527 (beginning-of-line 2))
10528 (when (looking-at org-dblock-end-re)
10530 (replace-match ""))
10531 (insert indent)))))))
10533 (defun org-beginning-of-dblock ()
10534 "Find the beginning of the dynamic block at point.
10535 Error if there is no such block at point."
10536 (let ((pos (point))
10537 beg)
10538 (end-of-line 1)
10539 (if (and (re-search-backward org-dblock-start-re nil t)
10540 (setq beg (match-beginning 0))
10541 (re-search-forward org-dblock-end-re nil t)
10542 (> (match-end 0) pos))
10543 (goto-char beg)
10544 (goto-char pos)
10545 (error "Not in a dynamic block"))))
10547 (defun org-update-all-dblocks ()
10548 "Update all dynamic blocks in the buffer.
10549 This function can be used in a hook."
10550 (interactive)
10551 (when (org-mode-p)
10552 (org-map-dblocks 'org-update-dblock)))
10555 ;;;; Completion
10557 (defconst org-additional-option-like-keywords
10558 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10559 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10560 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10561 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10562 "BEGIN:" "END:"
10563 "ORGTBL" "TBLFM:" "TBLNAME:"
10564 "BEGIN_EXAMPLE" "END_EXAMPLE"
10565 "BEGIN_QUOTE" "END_QUOTE"
10566 "BEGIN_VERSE" "END_VERSE"
10567 "BEGIN_CENTER" "END_CENTER"
10568 "BEGIN_SRC" "END_SRC"
10569 "BEGIN_RESULT" "END_RESULT"
10570 "SOURCE:" "SRCNAME:" "FUNCTION:"
10571 "RESULTS:"
10572 "HEADER:" "HEADERS:"
10573 "BABEL:"
10574 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10575 "CAPTION:" "LABEL:"
10576 "SETUPFILE:"
10577 "INCLUDE:"
10578 "BIND:"
10579 "MACRO:"))
10581 (defcustom org-structure-template-alist
10582 '(
10595 ("L" "#+latex: "
10599 ("H" "#+html: "
10602 ("A" "#+ascii: ")
10603 ("i" "#+include %file ?"
10605 )
10606 "Structure completion elements.
10607 This is a list of abbreviation keys and values. The value gets inserted
10608 if you type `<' followed by the key and then press the completion key,
10609 usually `M-TAB'. %file will be replaced by a file name after prompting
10610 for the file using completion.
10611 There are two templates for each key, the first uses the original Org syntax,
10612 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10613 the default when the /org-mtags.el/ module has been loaded. See also the
10614 variable `org-mtags-prefer-muse-templates'.
10615 This is an experimental feature, it is undecided if it is going to stay in."
10616 :group 'org-completion
10617 :type '(repeat
10618 (string :tag "Key")
10619 (string :tag "Template")
10620 (string :tag "Muse Template")))
10622 (defun org-try-structure-completion ()
10623 "Try to complete a structure template before point.
10625 expands them."
10626 (let ((l (buffer-substring (point-at-bol) (point)))
10627 a)
10630 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10631 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10632 (match-beginning 1)) a)
10633 t)))
10635 (defun org-complete-expand-structure-template (start cell)
10636 "Expand a structure template."
10637 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10638 (rpl (nth (if musep 2 1) cell))
10639 (ind ""))
10640 (delete-region start (point))
10642 (cond
10643 ((bolp))
10645 (setq ind (buffer-substring (point-at-bol) (point))))
10646 (t (newline))))
10647 (setq start (point))
10648 (if (string-match "%file" rpl)
10649 (setq rpl (replace-match
10650 (concat
10652 (save-match-data
10653 (abbreviate-file-name (read-file-name "Include file: ")))
10655 t t rpl)))
10658 (insert rpl)
10661 ;;;; TODO, DEADLINE, Comments
10663 (defun org-toggle-comment ()
10664 "Change the COMMENT state of an entry."
10665 (interactive)
10666 (save-excursion
10667 (org-back-to-heading)
10668 (let (case-fold-search)
10669 (if (looking-at (concat outline-regexp
10671 (replace-match "" t t nil 1)
10672 (if (looking-at outline-regexp)
10673 (progn
10674 (goto-char (match-end 0))
10675 (insert org-comment-string " ")))))))
10677 (defvar org-last-todo-state-is-todo nil
10678 "This is non-nil when the last TODO state change led to a TODO state.
10679 If the last change removed the TODO tag or switched to DONE, then
10680 this is nil.")
10682 (defvar org-setting-tags nil) ; dynamically skipped
10684 (defvar org-todo-setup-filter-hook nil
10685 "Hook for functions that pre-filter todo specs.
10686 Each function takes a todo spec and returns either nil or the spec
10687 transformed into canonical form." )
10689 (defvar org-todo-get-default-hook nil
10690 "Hook for functions that get a default item for todo.
10691 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10692 nil or a string to be used for the todo mark." )
10694 (defvar org-agenda-headline-snapshot-before-repeat)
10696 (defun org-todo (&optional arg)
10697 "Change the TODO state of an item.
10698 The state of an item is given by a keyword at the start of the heading,
10699 like
10700 *** TODO Write paper
10701 *** DONE Call mom
10703 The different keywords are specified in the variable `org-todo-keywords'.
10705 So for this example: when the item starts with TODO, it is changed to DONE.
10706 When it starts with DONE, the DONE is removed. And when neither TODO nor
10707 DONE are present, add TODO at the beginning of the heading.
10710 state.
10711 With numeric prefix arg, switch to that state.
10713 keywords (nextset).
10716 For calling through lisp, arg is also interpreted in the following way:
10717 'none -> empty state
10719 'done -> switch to DONE
10720 'nextset -> switch to the next set of keywords
10721 'previousset -> switch to the previous set of keywords
10723 really is a member of `org-todo-keywords'."
10724 (interactive "P")
10725 (if (equal arg '(16)) (setq arg 'nextset))
10726 (let ((org-blocker-hook org-blocker-hook)
10727 (case-fold-search nil))
10728 (when (equal arg '(64))
10729 (setq arg nil org-blocker-hook nil))
10730 (when (and org-blocker-hook
10731 (or org-inhibit-blocking
10732 (org-entry-get nil "NOBLOCKING")))
10733 (setq org-blocker-hook nil))
10734 (save-excursion
10735 (catch 'exit
10736 (org-back-to-heading t)
10737 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10739 (looking-at " *"))
10740 (let* ((match-data (match-data))
10741 (startpos (point-at-bol))
10742 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10743 (org-log-done org-log-done)
10744 (org-log-repeat org-log-repeat)
10745 (org-todo-log-states org-todo-log-states)
10746 (this (match-string 1))
10747 (hl-pos (match-beginning 0))
10748 (head (org-get-todo-sequence-head this))
10749 (ass (assoc head org-todo-kwd-alist))
10750 (interpret (nth 1 ass))
10751 (done-word (nth 3 ass))
10752 (final-done-word (nth 4 ass))
10753 (last-state (or this ""))
10754 (completion-ignore-case t)
10755 (member (member this org-todo-keywords-1))
10756 (tail (cdr member))
10757 (state (cond
10758 ((and org-todo-key-trigger
10759 (or (and (equal arg '(4))
10760 (eq org-use-fast-todo-selection 'prefix))
10761 (and (not arg) org-use-fast-todo-selection
10762 (not (eq org-use-fast-todo-selection
10763 'prefix)))))
10764 ;; Use fast selection
10765 (org-fast-todo-selection))
10766 ((and (equal arg '(4))
10767 (or (not org-use-fast-todo-selection)
10768 (not org-todo-key-trigger)))
10769 ;; Read a state with completion
10770 (org-icompleting-read
10771 "State: " (mapcar (lambda(x) (list x))
10772 org-todo-keywords-1)
10773 nil t))
10774 ((eq arg 'right)
10775 (if this
10776 (if tail (car tail) nil)
10777 (car org-todo-keywords-1)))
10778 ((eq arg 'left)
10779 (if (equal member org-todo-keywords-1)
10780 nil
10781 (if this
10782 (nth (- (length org-todo-keywords-1)
10783 (length tail) 2)
10784 org-todo-keywords-1)
10785 (org-last org-todo-keywords-1))))
10786 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10787 (setq arg nil))) ; hack to fall back to cycling
10788 (arg
10789 ;; user or caller requests a specific state
10790 (cond
10791 ((equal arg "") nil)
10792 ((eq arg 'none) nil)
10793 ((eq arg 'done) (or done-word (car org-done-keywords)))
10794 ((eq arg 'nextset)
10795 (or (car (cdr (member head org-todo-heads)))
10796 (car org-todo-heads)))
10797 ((eq arg 'previousset)
10798 (let ((org-todo-heads (reverse org-todo-heads)))
10799 (or (car (cdr (member head org-todo-heads)))
10800 (car org-todo-heads))))
10801 ((car (member arg org-todo-keywords-1)))
10802 ((stringp arg)
10803 (error "State `%s' not valid in this file" arg))
10804 ((nth (1- (prefix-numeric-value arg))
10805 org-todo-keywords-1))))
10806 ((null member) (or head (car org-todo-keywords-1)))
10807 ((equal this final-done-word) nil) ;; -> make empty
10808 ((null tail) nil) ;; -> first entry
10809 ((memq interpret '(type priority))
10810 (if (eq this-command last-command)
10811 (car tail)
10812 (if (> (length tail) 0)
10813 (or done-word (car org-done-keywords))
10814 nil)))
10815 (t
10816 (car tail))))
10817 (state (or
10818 (run-hook-with-args-until-success
10819 'org-todo-get-default-hook state last-state)
10820 state))
10821 (next (if state (concat " " state " ") " "))
10822 (change-plist (list :type 'todo-state-change :from this :to state
10823 :position startpos))
10824 dolog now-done-p)
10825 (when org-blocker-hook
10826 (setq org-last-todo-state-is-todo
10827 (not (member this org-done-keywords)))
10828 (unless (save-excursion
10829 (save-match-data
10830 (run-hook-with-args-until-failure
10831 'org-blocker-hook change-plist)))
10832 (if (interactive-p)
10833 (error "TODO state change from %s to %s blocked" this state)
10834 ;; fail silently
10835 (message "TODO state change from %s to %s blocked" this state)
10836 (throw 'exit nil))))
10837 (store-match-data match-data)
10838 (replace-match next t t)
10839 (unless (pos-visible-in-window-p hl-pos)
10840 (message "TODO state changed to %s" (org-trim next)))
10841 (unless head
10842 (setq head (org-get-todo-sequence-head state)
10843 ass (assoc head org-todo-kwd-alist)
10844 interpret (nth 1 ass)
10845 done-word (nth 3 ass)
10846 final-done-word (nth 4 ass)))
10847 (when (memq arg '(nextset previousset))
10848 (message "Keyword-Set %d/%d: %s"
10849 (- (length org-todo-sets) -1
10850 (length (memq (assoc state org-todo-sets) org-todo-sets)))
10851 (length org-todo-sets)
10852 (mapconcat 'identity (assoc state org-todo-sets) " ")))
10853 (setq org-last-todo-state-is-todo
10854 (not (member state org-done-keywords)))
10855 (setq now-done-p (and (member state org-done-keywords)
10856 (not (member this org-done-keywords))))
10857 (and logging (org-local-logging logging))
10858 (when (and (or org-todo-log-states org-log-done)
10859 (not (eq org-inhibit-logging t))
10860 (not (memq arg '(nextset previousset))))
10861 ;; we need to look at recording a time and note
10862 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
10863 (nth 2 (assoc this org-todo-log-states))))
10864 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
10865 (setq dolog 'time))
10866 (when (and state
10867 (member state org-not-done-keywords)
10868 (not (member this org-not-done-keywords)))
10869 ;; This is now a todo state and was not one before
10870 ;; If there was a CLOSED time stamp, get rid of it.
10871 (org-add-planning-info nil nil 'closed))
10872 (when (and now-done-p org-log-done)
10873 ;; It is now done, and it was not done before
10874 (org-add-planning-info 'closed (org-current-time))
10875 (if (and (not dolog) (eq 'note org-log-done))
10876 (org-add-log-setup 'done state this 'findpos 'note)))
10877 (when (and state dolog)
10878 ;; This is a non-nil state, and we need to log it
10879 (org-add-log-setup 'state state this 'findpos dolog)))
10880 ;; Fixup tag positioning
10881 (org-todo-trigger-tag-changes state)
10882 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
10883 (when org-provide-todo-statistics
10884 (org-update-parent-todo-statistics))
10885 (run-hooks 'org-after-todo-state-change-hook)
10886 (if (and arg (not (member state org-done-keywords)))
10887 (setq head (org-get-todo-sequence-head state)))
10888 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
10889 ;; Do we need to trigger a repeat?
10890 (when now-done-p
10891 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
10892 ;; This is for the agenda, take a snapshot of the headline.
10893 (save-match-data
10894 (setq org-agenda-headline-snapshot-before-repeat
10895 (org-get-heading))))
10896 (org-auto-repeat-maybe state))
10897 ;; Fixup cursor location if close to the keyword
10898 (if (and (outline-on-heading-p)
10899 (not (bolp))
10900 (save-excursion (beginning-of-line 1)
10901 (looking-at org-todo-line-regexp))
10902 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
10903 (progn
10904 (goto-char (or (match-end 2) (match-end 1)))
10905 (and (looking-at " ") (just-one-space))))
10906 (when org-trigger-hook
10907 (save-excursion
10908 (run-hook-with-args 'org-trigger-hook change-plist))))))))
10910 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
10911 "Block turning an entry into a TODO, using the hierarchy.
10912 This checks whether the current task should be blocked from state
10913 changes. Such blocking occurs when:
10915 1. The task has children which are not all in a completed state.
10917 2. A task has a parent with the property :ORDERED:, and there
10918 are siblings prior to the current task with incomplete
10919 status.
10921 3. The parent of the task is blocked because it has siblings that should
10922 be done first, or is child of a block grandparent TODO entry."
10924 (if (not org-enforce-todo-dependencies)
10925 t ; if locally turned off don't block
10926 (catch 'dont-block
10927 ;; If this is not a todo state change, or if this entry is already DONE,
10928 ;; do not block
10929 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
10930 (member (plist-get change-plist :from)
10931 (cons 'done org-done-keywords))
10932 (member (plist-get change-plist :to)
10933 (cons 'todo org-not-done-keywords))
10934 (not (plist-get change-plist :to)))
10935 (throw 'dont-block t))
10936 ;; If this task has children, and any are undone, it's blocked
10937 (save-excursion
10938 (org-back-to-heading t)
10939 (let ((this-level (funcall outline-level)))
10940 (outline-next-heading)
10941 (let ((child-level (funcall outline-level)))
10942 (while (and (not (eobp))
10943 (> child-level this-level))
10944 ;; this todo has children, check whether they are all
10945 ;; completed
10946 (if (and (not (org-entry-is-done-p))
10947 (org-entry-is-todo-p))
10948 (throw 'dont-block nil))
10949 (outline-next-heading)
10950 (setq child-level (funcall outline-level))))))
10951 ;; Otherwise, if the task's parent has the :ORDERED: property, and
10952 ;; any previous siblings are undone, it's blocked
10953 (save-excursion
10954 (org-back-to-heading t)
10955 (let* ((pos (point))
10956 (parent-pos (and (org-up-heading-safe) (point))))
10957 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10958 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
10959 (forward-line 1)
10960 (re-search-forward org-not-done-heading-regexp pos t))
10961 (throw 'dont-block nil)) ; block, there is an older sibling not done.
10962 ;; Search further up the hierarchy, to see if an anchestor is blocked
10963 (while t
10964 (goto-char parent-pos)
10965 (if (not (looking-at org-not-done-heading-regexp))
10966 (throw 'dont-block t)) ; do not block, parent is not a TODO
10967 (setq pos (point))
10968 (setq parent-pos (and (org-up-heading-safe) (point)))
10969 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10970 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
10971 (forward-line 1)
10972 (re-search-forward org-not-done-heading-regexp pos t))
10973 (throw 'dont-block nil)))))))) ; block, older sibling not done.
10975 (defcustom org-track-ordered-property-with-tag nil
10976 "Should the ORDERED property also be shown as a tag?
10977 The ORDERED property decides if an entry should require subtasks to be
10978 completed in sequence. Since a property is not very visible, setting
10979 this option means that toggling the ORDERED property with the command
10980 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
10981 not relevant for the behavior, but it makes things more visible.
10983 Note that toggling the tag with tags commands will not change the property
10984 and therefore not influence behavior!
10986 This can be t, meaning the tag ORDERED should be used, It can also be a
10987 string to select a different tag for this task."
10988 :group 'org-todo
10989 :type '(choice
10990 (const :tag "No tracking" nil)
10991 (const :tag "Track with ORDERED tag" t)
10992 (string :tag "Use other tag")))
10994 (defun org-toggle-ordered-property ()
10995 "Toggle the ORDERED property of the current entry.
10996 For better visibility, you can track the value of this property with a tag.
10997 See variable `org-track-ordered-property-with-tag'."
10998 (interactive)
10999 (let* ((t1 org-track-ordered-property-with-tag)
11000 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11001 (save-excursion
11002 (org-back-to-heading)
11003 (if (org-entry-get nil "ORDERED")
11004 (progn
11005 (org-delete-property "ORDERED")
11006 (and tag (org-toggle-tag tag 'off))
11007 (message "Subtasks can be completed in arbitrary order"))
11008 (org-entry-put nil "ORDERED" "t")
11009 (and tag (org-toggle-tag tag 'on))
11010 (message "Subtasks must be completed in sequence")))))
11012 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11013 (defun org-block-todo-from-checkboxes (change-plist)
11014 "Block turning an entry into a TODO, using checkboxes.
11015 This checks whether the current task should be blocked from state
11016 changes because there are unchecked boxes in this entry."
11017 (if (not org-enforce-todo-checkbox-dependencies)
11018 t ; if locally turned off don't block
11019 (catch 'dont-block
11020 ;; If this is not a todo state change, or if this entry is already DONE,
11021 ;; do not block
11022 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11023 (member (plist-get change-plist :from)
11024 (cons 'done org-done-keywords))
11025 (member (plist-get change-plist :to)
11026 (cons 'todo org-not-done-keywords))
11027 (not (plist-get change-plist :to)))
11028 (throw 'dont-block t))
11029 ;; If this task has checkboxes that are not checked, it's blocked
11030 (save-excursion
11031 (org-back-to-heading t)
11032 (let ((beg (point)) end)
11033 (outline-next-heading)
11034 (setq end (point))
11035 (goto-char beg)
11037 end t)
11038 (progn
11039 (if (boundp 'org-blocked-by-checkboxes)
11040 (setq org-blocked-by-checkboxes t))
11041 (throw 'dont-block nil)))))
11042 t))) ; do not block
11044 (defun org-entry-blocked-p ()
11045 "Is the current entry blocked?"
11046 (if (org-entry-get nil "NOBLOCKING")
11047 nil ;; Never block this entry
11048 (not
11049 (run-hook-with-args-until-failure
11050 'org-blocker-hook
11051 (list :type 'todo-state-change
11052 :position (point)
11053 :from 'todo
11054 :to 'done)))))
11056 (defun org-update-statistics-cookies (all)
11057 "Update the statistics cookie, either from TODO or from checkboxes.
11058 This should be called with the cursor in a line with a statistics cookie."
11059 (interactive "P")
11060 (if all
11061 (progn
11062 (org-update-checkbox-count 'all)
11063 (org-map-entries 'org-update-parent-todo-statistics))
11064 (if (not (org-on-heading-p))
11065 (org-update-checkbox-count)
11066 (let ((pos (move-marker (make-marker) (point)))
11067 end l1 l2)
11068 (ignore-errors (org-back-to-heading t))
11069 (if (not (org-on-heading-p))
11070 (org-update-checkbox-count)
11071 (setq l1 (org-outline-level))
11072 (setq end (save-excursion
11073 (outline-next-heading)
11074 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11075 (point)))
11076 (if (and (save-excursion
11077 (re-search-forward
11079 (not (save-excursion (re-search-forward
11081 (org-update-checkbox-count)
11082 (if (and l2 (> l2 l1))
11083 (progn
11084 (goto-char end)
11085 (org-update-parent-todo-statistics))
11086 (goto-char pos)
11087 (beginning-of-line 1)
11088 (while (re-search-forward
11090 (point-at-eol) t)
11091 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11092 (goto-char pos)
11093 (move-marker pos nil)))))
11095 (defvar org-entry-property-inherited-from) ;; defined below
11096 (defun org-update-parent-todo-statistics ()
11097 "Update any statistics cookie in the parent of the current headline.
11098 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11099 the entire subtree and this will travel up the hierarchy and update
11100 statistics everywhere."
11101 (interactive)
11102 (let* ((lim 0) prop
11103 (recursive (or (not org-hierarchical-todo-statistics)
11104 (string-match
11106 (or (setq prop (org-entry-get
11107 nil "COOKIE_DATA" 'inherit)) ""))))
11108 (lim (or (and prop (marker-position
11109 org-entry-property-inherited-from))
11110 lim))
11111 (first t)
11113 level ltoggle l1 new ndel
11114 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
11115 (catch 'exit
11116 (save-excursion
11117 (beginning-of-line 1)
11118 (if (org-at-heading-p)
11119 (setq ltoggle (funcall outline-level))
11120 (error "This should not happen"))
11121 (while (and (setq level (org-up-heading-safe))
11122 (or recursive first)
11123 (>= (point) lim))
11124 (setq first nil cookie-present nil)
11125 (unless (and level
11126 (not (string-match
11128 (downcase
11129 (or (org-entry-get
11130 nil "COOKIE_DATA")
11131 "")))))
11132 (throw 'exit nil))
11133 (while (re-search-forward box-re (point-at-eol) t)
11134 (setq cnt-all 0 cnt-done 0 cookie-present t)
11135 (setq is-percent (match-end 2))
11136 (save-match-data
11137 (unless (outline-next-heading) (throw 'exit nil))
11138 (while (and (looking-at org-complex-heading-regexp)
11139 (> (setq l1 (length (match-string 1))) level))
11140 (setq kwd (and (or recursive (= l1 ltoggle))
11141 (match-string 2)))
11142 (if (or (eq org-provide-todo-statistics 'all-headlines)
11143 (and (listp org-provide-todo-statistics)
11144 (or (member kwd org-provide-todo-statistics)
11145 (member kwd org-done-keywords))))
11146 (setq cnt-all (1+ cnt-all))
11147 (if (eq org-provide-todo-statistics t)
11148 (and kwd (setq cnt-all (1+ cnt-all)))))
11149 (and (member kwd org-done-keywords)
11150 (setq cnt-done (1+ cnt-done)))
11151 (outline-next-heading)))
11152 (setq new
11153 (if is-percent
11154 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11155 (format "[%d/%d]" cnt-done cnt-all))
11156 ndel (- (match-end 0) (match-beginning 0)))
11157 (goto-char (match-beginning 0))
11158 (insert new)
11159 (delete-region (point) (+ (point) ndel)))
11160 (when cookie-present
11161 (run-hook-with-args 'org-after-todo-statistics-hook
11162 cnt-done (- cnt-all cnt-done))))))
11163 (run-hooks 'org-todo-statistics-hook)))
11165 (defvar org-after-todo-statistics-hook nil
11166 "Hook that is called after a TODO statistics cookie has been updated.
11167 Each function is called with two arguments: the number of not-done entries
11168 and the number of done entries.
11170 For example, the following function, when added to this hook, will switch
11171 an entry to DONE when all children are done, and back to TODO when new
11172 entries are set to a TODO status. Note that this hook is only called
11173 when there is a statistics cookie in the headline!
11175 (defun org-summary-todo (n-done n-not-done)
11177 (let (org-log-done org-log-states) ; turn off logging
11179 ")
11181 (defvar org-todo-statistics-hook nil
11182 "Hook that is run whenever Org thinks TODO statistics should be updated.
11183 This hook runs even if there is no statistics cookie present, in which case
11184 `org-after-todo-statistics-hook' would not run.")
11186 (defun org-todo-trigger-tag-changes (state)
11187 "Apply the changes defined in `org-todo-state-tags-triggers'."
11188 (let ((l org-todo-state-tags-triggers)
11189 changes)
11190 (when (or (not state) (equal state ""))
11191 (setq changes (append changes (cdr (assoc "" l)))))
11192 (when (and (stringp state) (> (length state) 0))
11193 (setq changes (append changes (cdr (assoc state l)))))
11194 (when (member state org-not-done-keywords)
11195 (setq changes (append changes (cdr (assoc 'todo l)))))
11196 (when (member state org-done-keywords)
11197 (setq changes (append changes (cdr (assoc 'done l)))))
11198 (dolist (c changes)
11199 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11201 (defun org-local-logging (value)
11202 "Get logging settings from a property VALUE."
11203 (let* (words w a)
11204 ;; directly set the variables, they are already local.
11205 (setq org-log-done nil
11206 org-log-repeat nil
11207 org-todo-log-states nil)
11208 (setq words (org-split-string value))
11209 (while (setq w (pop words))
11210 (cond
11211 ((setq a (assoc w org-startup-options))
11212 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11213 (set (nth 1 a) (nth 2 a))))
11214 ((setq a (org-extract-log-state-settings w))
11215 (and (member (car a) org-todo-keywords-1)
11216 (push a org-todo-log-states)))))))
11218 (defun org-get-todo-sequence-head (kwd)
11219 "Return the head of the TODO sequence to which KWD belongs.
11220 If KWD is not set, check if there is a text property remembering the
11221 right sequence."
11222 (let (p)
11223 (cond
11224 ((not kwd)
11225 (or (get-text-property (point-at-bol) 'org-todo-head)
11226 (progn
11227 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11228 nil (point-at-eol)))
11229 (get-text-property p 'org-todo-head))))
11230 ((not (member kwd org-todo-keywords-1))
11231 (car org-todo-keywords-1))
11232 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11234 (defun org-fast-todo-selection ()
11235 "Fast TODO keyword selection with single keys.
11236 Returns the new TODO keyword, or nil if no state change should occur."
11237 (let* ((fulltable org-todo-key-alist)
11238 (done-keywords org-done-keywords) ;; needed for the faces.
11239 (maxlen (apply 'max (mapcar
11240 (lambda (x)
11241 (if (stringp (car x)) (string-width (car x)) 0))
11242 fulltable)))
11243 (expert nil)
11244 (fwidth (+ maxlen 3 1 3))
11245 (ncol (/ (- (window-width) 4) fwidth))
11246 tg cnt e c tbl
11247 groups ingroup)
11248 (save-excursion
11249 (save-window-excursion
11250 (if expert
11251 (set-buffer (get-buffer-create " *Org todo*"))
11252 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11253 (erase-buffer)
11254 (org-set-local 'org-done-keywords done-keywords)
11255 (setq tbl fulltable cnt 0)
11256 (while (setq e (pop tbl))
11257 (cond
11258 ((equal e '(:startgroup))
11259 (push '() groups) (setq ingroup t)
11260 (when (not (= cnt 0))
11261 (setq cnt 0)
11263 (insert "{ "))
11264 ((equal e '(:endgroup))
11265 (setq ingroup nil cnt 0)
11267 ((equal e '(:newline))
11268 (when (not (= cnt 0))
11269 (setq cnt 0)
11271 (setq e (car tbl))
11272 (while (equal (car tbl) '(:newline))
11274 (setq tbl (cdr tbl)))))
11275 (t
11276 (setq tg (car e) c (cdr e))
11277 (if ingroup (push tg (car groups)))
11278 (setq tg (org-add-props tg nil 'face
11279 (org-get-todo-face tg)))
11280 (if (and (= cnt 0) (not ingroup)) (insert " "))
11281 (insert "[" c "] " tg (make-string
11282 (- fwidth 4 (length tg)) ?\ ))
11283 (when (= (setq cnt (1+ cnt)) ncol)
11285 (if ingroup (insert " "))
11286 (setq cnt 0)))))
11288 (goto-char (point-min))
11289 (if (not expert) (org-fit-window-to-buffer))
11290 (message "[a-z..]:Set [SPC]:clear")
11291 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11292 (cond
11293 ((or (= c ?\C-g)
11294 (and (= c ?q) (not (rassoc c fulltable))))
11295 (setq quit-flag t))
11296 ((= c ?\ ) nil)
11297 ((setq e (rassoc c fulltable) tg (car e))
11298 tg)
11299 (t (setq quit-flag t)))))))
11301 (defun org-entry-is-todo-p ()
11302 (member (org-get-todo-state) org-not-done-keywords))
11304 (defun org-entry-is-done-p ()
11305 (member (org-get-todo-state) org-done-keywords))
11307 (defun org-get-todo-state ()
11308 (save-excursion
11309 (org-back-to-heading t)
11310 (and (looking-at org-todo-line-regexp)
11311 (match-end 2)
11312 (match-string 2))))
11314 (defun org-at-date-range-p (&optional inactive-ok)
11315 "Is the cursor inside a date range?"
11316 (interactive)
11317 (save-excursion
11318 (catch 'exit
11319 (let ((pos (point)))
11321 (skip-chars-backward "<[")
11322 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11323 (>= (match-end 0) pos)
11324 (throw 'exit t))
11326 (skip-chars-backward "<[")
11327 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11328 (>= (match-end 0) pos)
11329 (throw 'exit t)))
11330 nil)))
11332 (defun org-get-repeat (&optional tagline)
11333 "Check if there is a deadline/schedule with repeater in this entry."
11334 (save-match-data
11335 (save-excursion
11336 (org-back-to-heading t)
11337 (and (re-search-forward (if tagline
11339 org-repeat-re)
11340 (org-entry-end-position) t)
11341 (match-string-no-properties 1)))))
11343 (defvar org-last-changed-timestamp)
11344 (defvar org-last-inserted-timestamp)
11345 (defvar org-log-post-message)
11346 (defvar org-log-note-purpose)
11347 (defvar org-log-note-how)
11348 (defvar org-log-note-extra)
11349 (defun org-auto-repeat-maybe (done-word)
11350 "Check if the current headline contains a repeated deadline/schedule.
11351 If yes, set TODO state back to what it was and change the base date
11352 of repeating deadline/scheduled time stamps to new date.
11353 This function is run automatically after each state change to a DONE state."
11354 ;; last-state is dynamically scoped into this function
11355 (let* ((repeat (org-get-repeat))
11356 (aa (assoc last-state org-todo-kwd-alist))
11357 (interpret (nth 1 aa))
11358 (head (nth 2 aa))
11359 (whata '(("d" . day) ("m" . month) ("y" . year)))
11360 (msg "Entry repeats: ")
11361 (org-log-done nil)
11362 (org-todo-log-states nil)
11363 re type n what ts time to-state)
11364 (when repeat
11365 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11366 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11367 org-todo-repeat-to-state))
11368 (unless (and to-state (member to-state org-todo-keywords-1))
11369 (setq to-state (if (eq interpret 'type) last-state head)))
11370 (org-todo to-state)
11371 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11372 (org-entry-put nil "LAST_REPEAT" (format-time-string
11373 (org-time-stamp-format t t))))
11374 (when org-log-repeat
11375 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11376 (memq 'org-add-log-note post-command-hook))
11377 ;; OK, we are already setup for some record
11378 (if (eq org-log-repeat 'note)
11379 ;; make sure we take a note, not only a time stamp
11380 (setq org-log-note-how 'note))
11381 ;; Set up for taking a record
11382 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11383 last-state
11384 'findpos org-log-repeat)))
11385 (org-back-to-heading t)
11386 (org-add-planning-info nil nil 'closed)
11390 (while (re-search-forward
11391 re (save-excursion (outline-next-heading) (point)) t)
11392 (setq type (if (match-end 1) org-scheduled-string
11393 (if (match-end 3) org-deadline-string "Plain:"))
11394 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11396 (setq n (string-to-number (match-string 2 ts))
11397 what (match-string 3 ts))
11398 (if (equal what "w") (setq n (* n 7) what "d"))
11399 ;; Preparation, see if we need to modify the start date for the change
11400 (when (match-end 1)
11401 (setq time (save-match-data (org-time-string-to-time ts)))
11402 (cond
11403 ((equal (match-string 1 ts) ".")
11404 ;; Shift starting date to today
11405 (org-timestamp-change
11406 (- (time-to-days (current-time)) (time-to-days time))
11407 'day))
11408 ((equal (match-string 1 ts) "+")
11409 (let ((nshiftmax 10) (nshift 0))
11410 (while (or (= nshift 0)
11411 (<= (time-to-days time)
11412 (time-to-days (current-time))))
11413 (when (= (incf nshift) nshiftmax)
11414 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11415 (error "Abort")))
11416 (org-timestamp-change n (cdr (assoc what whata)))
11417 (org-at-timestamp-p t)
11418 (setq ts (match-string 1))
11419 (setq time (save-match-data (org-time-string-to-time ts)))))
11420 (org-timestamp-change (- n) (cdr (assoc what whata)))
11421 ;; rematch, so that we have everything in place for the real shift
11422 (org-at-timestamp-p t)
11423 (setq ts (match-string 1))
11425 (org-timestamp-change n (cdr (assoc what whata)))
11426 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11427 (setq org-log-post-message msg)
11428 (message "%s" msg))))
11430 (defun org-show-todo-tree (arg)
11431 "Make a compact tree which shows all headlines marked with TODO.
11432 The tree will show the lines where the regexp matches, and all higher
11433 headlines above the match.
11435 With a numeric prefix N, construct a sparse tree for the Nth element
11436 of `org-todo-keywords-1'."
11437 (interactive "P")
11438 (let ((case-fold-search nil)
11439 (kwd-re
11440 (cond ((null arg) org-not-done-regexp)
11441 ((equal arg '(4))
11442 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11443 (mapcar 'list org-todo-keywords-1))))
11447 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11448 (regexp-quote (nth (1- (prefix-numeric-value arg))
11449 org-todo-keywords-1)))
11450 (t (error "Invalid prefix argument: %s" arg)))))
11451 (message "%d TODO entries found"
11452 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
11454 (defun org-deadline (&optional remove time)
11456 With argument REMOVE, remove any deadline from the item.
11457 When TIME is set, it should be an internal time specification, and the
11458 scheduling will use the corresponding date."
11459 (interactive "P")
11460 (let* ((old-date (org-entry-get nil "DEADLINE"))
11461 (repeater (and old-date
11463 (match-string 1 old-date))))
11464 (if remove
11465 (progn
11466 (when (and old-date org-log-redeadline)
11467 (org-add-log-setup 'deldeadline nil old-date 'findpos
11468 org-log-redeadline))
11469 (org-remove-timestamp-with-keyword org-deadline-string)
11470 (message "Item no longer has a deadline."))
11471 (org-add-planning-info 'deadline time 'closed)
11472 (when (and old-date org-log-redeadline
11473 (not (equal old-date
11474 (substring org-last-inserted-timestamp 1 -1))))
11475 (org-add-log-setup 'redeadline nil old-date 'findpos
11476 org-log-redeadline))
11477 (when repeater
11478 (save-excursion
11479 (org-back-to-heading t)
11480 (when (re-search-forward (concat org-deadline-string " "
11481 org-last-inserted-timestamp)
11482 (save-excursion
11483 (outline-next-heading) (point)) t)
11484 (goto-char (1- (match-end 0)))
11485 (insert " " repeater)
11486 (setq org-last-inserted-timestamp
11487 (concat (substring org-last-inserted-timestamp 0 -1)
11488 " " repeater
11489 (substring org-last-inserted-timestamp -1))))))
11490 (message "Deadline on %s" org-last-inserted-timestamp))))
11492 (defun org-schedule (&optional remove time)
11493 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11494 With argument REMOVE, remove any scheduling date from the item.
11495 When TIME is set, it should be an internal time specification, and the
11496 scheduling will use the corresponding date."
11497 (interactive "P")
11498 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11499 (repeater (and old-date
11501 (match-string 1 old-date))))
11502 (if remove
11503 (progn
11504 (when (and old-date org-log-reschedule)
11505 (org-add-log-setup 'delschedule nil old-date 'findpos
11506 org-log-reschedule))
11507 (org-remove-timestamp-with-keyword org-scheduled-string)
11508 (message "Item is no longer scheduled."))
11509 (org-add-planning-info 'scheduled time 'closed)
11510 (when (and old-date org-log-reschedule
11511 (not (equal old-date
11512 (substring org-last-inserted-timestamp 1 -1))))
11513 (org-add-log-setup 'reschedule nil old-date 'findpos
11514 org-log-reschedule))
11515 (when repeater
11516 (save-excursion
11517 (org-back-to-heading t)
11518 (when (re-search-forward (concat org-scheduled-string " "
11519 org-last-inserted-timestamp)
11520 (save-excursion
11521 (outline-next-heading) (point)) t)
11522 (goto-char (1- (match-end 0)))
11523 (insert " " repeater)
11524 (setq org-last-inserted-timestamp
11525 (concat (substring org-last-inserted-timestamp 0 -1)
11526 " " repeater
11527 (substring org-last-inserted-timestamp -1))))))
11528 (message "Scheduled to %s" org-last-inserted-timestamp))))
11530 (defun org-get-scheduled-time (pom &optional inherit)
11531 "Get the scheduled time as a time tuple, of a format suitable
11532 for calling org-schedule with, or if there is no scheduling,
11533 returns nil."
11534 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11535 (when time
11536 (apply 'encode-time (org-parse-time-string time)))))
11538 (defun org-get-deadline-time (pom &optional inherit)
11539 "Get the deadline as a time tuple, of a format suitable for
11540 calling org-deadline with, or if there is no scheduling, returns
11541 nil."
11542 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11543 (when time
11544 (apply 'encode-time (org-parse-time-string time)))))
11546 (defun org-remove-timestamp-with-keyword (keyword)
11547 "Remove all time stamps with KEYWORD in the current entry."
11549 beg)
11550 (save-excursion
11551 (org-back-to-heading t)
11552 (setq beg (point))
11553 (outline-next-heading)
11554 (while (re-search-backward re beg t)
11555 (replace-match "")
11557 (equal (char-before) ?\ ))
11558 (backward-delete-char 1)
11560 (point-at-bol) (point-at-eol)))
11561 (delete-region (point-at-bol)
11562 (min (point-max) (1+ (point-at-eol))))))))))
11564 (defun org-add-planning-info (what &optional time &rest remove)
11565 "Insert new timestamp with keyword in the line directly after the headline.
11566 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11567 If non is given, the user is prompted for a date.
11568 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11569 be removed."
11570 (interactive)
11571 (let (org-time-was-given org-end-time-was-given ts
11572 end default-time default-input)
11574 (catch 'exit
11575 (when (and (not time) (memq what '(scheduled deadline)))
11576 ;; Try to get a default date/time from existing timestamp
11577 (save-excursion
11578 (org-back-to-heading t)
11579 (setq end (save-excursion (outline-next-heading) (point)))
11580 (when (re-search-forward (if (eq what 'scheduled)
11581 org-scheduled-time-regexp
11582 org-deadline-time-regexp)
11583 end t)
11584 (setq ts (match-string 1)
11585 default-time
11586 (apply 'encode-time (org-parse-time-string ts))
11587 default-input (and ts (org-get-compact-tod ts))))))
11588 (when what
11589 ;; If necessary, get the time from the user
11590 (setq time (or time (org-read-date nil 'to-time nil nil
11591 default-time default-input))))
11593 (when (and org-insert-labeled-timestamps-at-point
11594 (member what '(scheduled deadline)))
11595 (insert
11596 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11597 (org-insert-time-stamp time org-time-was-given
11598 nil nil nil (list org-end-time-was-given))
11599 (setq what nil))
11600 (save-excursion
11601 (save-restriction
11602 (let (col list elt ts buffer-invisibility-spec)
11603 (org-back-to-heading t)
11605 (goto-char (match-end 1))
11606 (setq col (current-column))
11607 (goto-char (match-end 0))
11609 (when (and (not what)
11610 (not (looking-at
11612 org-keyword-time-not-clock-regexp))))
11613 ;; Nothing to add, nothing to remove...... :-)
11614 (throw 'exit nil))
11615 (if (and (not (looking-at outline-regexp))
11618 (not (equal (match-string 1) org-clock-string)))
11619 (narrow-to-region (match-beginning 0) (match-end 0))
11621 (backward-char 1)
11622 (narrow-to-region (point) (point))
11623 (and org-adapt-indentation (org-indent-to-column col)))
11624 ;; Check if we have to remove something.
11625 (setq list (cons what remove))
11626 (while list
11627 (setq elt (pop list))
11628 (goto-char (point-min))
11629 (when (or (and (eq elt 'scheduled)
11630 (re-search-forward org-scheduled-time-regexp nil t))
11631 (and (eq elt 'deadline)
11632 (re-search-forward org-deadline-time-regexp nil t))
11633 (and (eq elt 'closed)
11634 (re-search-forward org-closed-time-regexp nil t)))
11635 (replace-match "")
11636 (if (looking-at "--+<[^>]+>") (replace-match ""))
11637 (skip-chars-backward " ")
11638 (if (looking-at " +") (replace-match ""))))
11639 (goto-char (point-max))
11640 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11641 (when what
11642 (insert
11643 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11644 (cond ((eq what 'scheduled) org-scheduled-string)
11645 ((eq what 'deadline) org-deadline-string)
11646 ((eq what 'closed) org-closed-string))
11647 " ")
11648 (setq ts (org-insert-time-stamp
11649 time
11650 (or org-time-was-given
11651 (and (eq what 'closed) org-log-done-with-time))
11652 (eq what 'closed)
11653 nil nil (list org-end-time-was-given)))
11654 (end-of-line 1))
11655 (goto-char (point-min))
11656 (widen)
11659 (delete-region (1- (point)) (point-at-eol)))
11660 ts))))))
11662 (defvar org-log-note-marker (make-marker))
11663 (defvar org-log-note-purpose nil)
11664 (defvar org-log-note-state nil)
11665 (defvar org-log-note-previous-state nil)
11666 (defvar org-log-note-how nil)
11667 (defvar org-log-note-extra nil)
11668 (defvar org-log-note-window-configuration nil)
11669 (defvar org-log-note-return-to (make-marker))
11670 (defvar org-log-post-message nil
11671 "Message to be displayed after a log note has been stored.
11672 The auto-repeater uses this.")
11674 (defun org-add-note ()
11675 "Add a note to the current entry.
11676 This is done in the same way as adding a state change note."
11677 (interactive)
11678 (org-add-log-setup 'note nil nil 'findpos nil))
11680 (defvar org-property-end-re)
11681 (defun org-add-log-setup (&optional purpose state prev-state
11682 findpos how extra)
11683 "Set up the post command hook to take a note.
11684 If this is about to TODO state change, the new state is expected in STATE.
11685 When FINDPOS is non-nil, find the correct position for the note in
11686 the current entry. If not, assume that it can be inserted at point.
11687 HOW is an indicator what kind of note should be created.
11688 EXTRA is additional text that will be inserted into the notes buffer."
11689 (let* ((org-log-into-drawer (org-log-into-drawer))
11690 (drawer (cond ((stringp org-log-into-drawer)
11691 org-log-into-drawer)
11692 (org-log-into-drawer "LOGBOOK")
11693 (t nil))))
11694 (save-restriction
11695 (save-excursion
11696 (when findpos
11697 (org-back-to-heading t)
11698 (narrow-to-region (point) (save-excursion
11699 (outline-next-heading) (point)))
11703 (goto-char (match-end 0))
11704 (cond
11705 (drawer
11707 nil t)
11708 (progn
11709 (goto-char (match-end 0))
11710 (or org-log-states-order-reversed
11711 (and (re-search-forward org-property-end-re nil t)
11712 (goto-char (1- (match-beginning 0))))))
11714 (beginning-of-line 0)
11715 (org-indent-line-function)
11716 (beginning-of-line 2)
11717 (org-indent-line-function)
11718 (end-of-line 0)))
11719 ((and org-log-state-notes-insert-after-drawers
11720 (save-excursion
11721 (forward-line) (looking-at org-drawer-regexp)))
11722 (forward-line)
11723 (while (looking-at org-drawer-regexp)
11724 (goto-char (match-end 0))
11725 (re-search-forward org-property-end-re (point-max) t)
11726 (forward-line))
11727 (forward-line -1)))
11728 (unless org-log-states-order-reversed
11730 (org-skip-over-state-notes)
11732 (move-marker org-log-note-marker (point))
11733 (setq org-log-note-purpose purpose
11734 org-log-note-state state
11735 org-log-note-previous-state prev-state
11736 org-log-note-how how
11737 org-log-note-extra extra)
11738 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11740 (defun org-skip-over-state-notes ()
11741 "Skip past the list of State notes in an entry."
11743 (when (org-in-item-p)
11744 (let ((limit (org-list-bottom-point)))
11746 (goto-char (or (org-get-next-item (point) limit)
11747 (org-get-end-of-item limit)))))))
11749 (defun org-add-log-note (&optional purpose)
11750 "Pop up a window for taking a note, and add this note later at point."
11751 (remove-hook 'post-command-hook 'org-add-log-note)
11752 (setq org-log-note-window-configuration (current-window-configuration))
11753 (delete-other-windows)
11754 (move-marker org-log-note-return-to (point))
11755 (switch-to-buffer (marker-buffer org-log-note-marker))
11756 (goto-char org-log-note-marker)
11757 (org-switch-to-buffer-other-window "*Org Note*")
11758 (erase-buffer)
11759 (if (memq org-log-note-how '(time state))
11760 (let (current-prefix-arg) (org-store-log-note))
11761 (let ((org-inhibit-startup t)) (org-mode))
11762 (insert (format "# Insert note for %s.
11764 (cond
11765 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11766 ((eq org-log-note-purpose 'done) "closed todo item")
11767 ((eq org-log-note-purpose 'state)
11769 (or org-log-note-previous-state "")
11770 (or org-log-note-state "")))
11771 ((eq org-log-note-purpose 'reschedule)
11772 "rescheduling")
11773 ((eq org-log-note-purpose 'delschedule)
11774 "no longer scheduled")
11775 ((eq org-log-note-purpose 'redeadline)
11776 "changing deadline")
11777 ((eq org-log-note-purpose 'deldeadline)
11778 "removing deadline")
11779 ((eq org-log-note-purpose 'refile)
11780 "refiling")
11781 ((eq org-log-note-purpose 'note)
11782 "this entry")
11783 (t (error "This should not happen")))))
11784 (if org-log-note-extra (insert org-log-note-extra))
11785 (org-set-local 'org-finish-function 'org-store-log-note)))
11787 (defvar org-note-abort nil) ; dynamically scoped
11788 (defun org-store-log-note ()
11789 "Finish taking a log note, and insert it to where it belongs."
11790 (let ((txt (buffer-string))
11791 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11792 lines ind bul)
11793 (kill-buffer (current-buffer))
11795 (setq txt (replace-match "" t t txt)))
11797 (setq txt (replace-match "" t t txt)))
11800 (setq note
11801 (org-replace-escapes
11802 note
11803 (list (cons "%u" (user-login-name))
11804 (cons "%U" user-full-name)
11805 (cons "%t" (format-time-string
11806 (org-time-stamp-format 'long 'inactive)
11807 (current-time)))
11808 (cons "%T" (format-time-string
11809 (org-time-stamp-format 'long nil)
11810 (current-time)))
11811 (cons "%s" (if org-log-note-state
11813 ""))
11814 (cons "%S" (if org-log-note-previous-state
11818 (push note lines))
11819 (when (or current-prefix-arg org-note-abort)
11820 (when org-log-into-drawer
11821 (org-remove-empty-drawer-at
11822 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11823 org-log-note-marker))
11824 (setq lines nil))
11825 (when lines
11826 (with-current-buffer (marker-buffer org-log-note-marker)
11827 (save-excursion
11828 (goto-char org-log-note-marker)
11829 (move-marker org-log-note-marker nil)
11830 (end-of-line 1)
11832 (setq ind (save-excursion
11833 (if (org-in-item-p)
11834 (progn
11835 (goto-char (org-list-top-point))
11836 (org-get-indentation))
11838 (cond
11839 ((and (org-at-heading-p)
11840 org-adapt-indentation)
11841 (1+ (org-current-level)))
11842 ((org-at-heading-p) 0)
11843 (t (org-get-indentation))))))
11844 (setq bul (org-list-bullet-string "-"))
11845 (org-indent-line-to ind)
11846 (insert bul (pop lines))
11847 (let ((ind-body (+ (length bul) ind)))
11848 (while lines
11850 (org-indent-line-to ind-body)
11851 (insert (pop lines))))
11852 (message "Note stored")
11853 (org-back-to-heading t)
11854 (org-cycle-hide-drawers 'children)))))
11855 (set-window-configuration org-log-note-window-configuration)
11856 (with-current-buffer (marker-buffer org-log-note-return-to)
11857 (goto-char org-log-note-return-to))
11858 (move-marker org-log-note-return-to nil)
11859 (and org-log-post-message (message "%s" org-log-post-message)))
11861 (defun org-remove-empty-drawer-at (drawer pos)
11862 "Remove an empty drawer DRAWER at position POS.
11863 POS may also be a marker."
11864 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
11865 (save-excursion
11866 (save-restriction
11867 (widen)
11868 (goto-char pos)
11869 (if (org-in-regexp
11871 (replace-match ""))))))
11873 (defun org-sparse-tree (&optional arg)
11874 "Create a sparse tree, prompt for the details.
11875 This command can create sparse trees. You first need to select the type
11876 of match used to create the tree:
11878 t Show all TODO entries.
11879 T Show entries with a specific TODO keyword.
11880 m Show entries selected by a tags/property match.
11881 p Enter a property name and its value (both with completion on existing
11882 names/values) and show entries with that property.
11883 r Show entries matching a regular expression (`/' can be used as well)
11884 d Show deadlines due within `org-deadline-warning-days'.
11885 b Show deadlines and scheduled items before a date.
11886 a Show deadlines and scheduled items after a date."
11887 (interactive "P")
11888 (let (ans kwd value)
11889 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
11890 (setq ans (read-char-exclusive))
11891 (cond
11892 ((equal ans ?d)
11893 (call-interactively 'org-check-deadlines))
11894 ((equal ans ?b)
11895 (call-interactively 'org-check-before-date))
11896 ((equal ans ?a)
11897 (call-interactively 'org-check-after-date))
11898 ((equal ans ?t)
11899 (org-show-todo-tree nil))
11900 ((equal ans ?T)
11901 (org-show-todo-tree '(4)))
11902 ((member ans '(?T ?m))
11903 (call-interactively 'org-match-sparse-tree))
11904 ((member ans '(?p ?P))
11905 (setq kwd (org-icompleting-read "Property: "
11906 (mapcar 'list (org-buffer-property-keys))))
11907 (setq value (org-icompleting-read "Value: "
11908 (mapcar 'list (org-property-values kwd))))
11911 (org-match-sparse-tree arg (concat kwd "=" value)))
11912 ((member ans '(?r ?R ?/))
11913 (call-interactively 'org-occur))
11916 (defvar org-occur-highlights nil
11917 "List of overlays used for occur matches.")
11918 (make-variable-buffer-local 'org-occur-highlights)
11919 (defvar org-occur-parameters nil
11920 "Parameters of the active org-occur calls.
11921 This is a list, each call to org-occur pushes as cons cell,
11922 containing the regular expression and the callback, onto the list.
11923 The list can contain several entries if `org-occur' has been called
11924 several time with the KEEP-PREVIOUS argument. Otherwise, this list
11925 will only contain one set of parameters. When the highlights are
11926 removed (for example with `C-c C-c', or with the next edit (depending
11927 on `org-remove-highlights-with-change'), this variable is emptied
11928 as well.")
11929 (make-variable-buffer-local 'org-occur-parameters)
11931 (defun org-occur (regexp &optional keep-previous callback)
11932 "Make a compact tree which shows all matches of REGEXP.
11933 The tree will show the lines where the regexp matches, and all higher
11934 headlines above the match. It will also show the heading after the match,
11935 to make sure editing the matching entry is easy.
11936 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
11937 call to `org-occur' will be kept, to allow stacking of calls to this
11938 command.
11939 If CALLBACK is non-nil, it is a function which is called to confirm
11940 that the match should indeed be shown."
11942 (when (equal regexp "")
11943 (error "Regexp cannot be empty"))
11944 (unless keep-previous
11945 (org-remove-occur-highlights nil nil t))
11946 (push (cons regexp callback) org-occur-parameters)
11947 (let ((cnt 0))
11948 (save-excursion
11949 (goto-char (point-min))
11950 (if (or (not keep-previous) ; do not want to keep
11951 (not org-occur-highlights)) ; no previous matches
11952 ;; hide everything
11953 (org-overview))
11954 (while (re-search-forward regexp nil t)
11955 (when (or (not callback)
11956 (save-match-data (funcall callback)))
11957 (setq cnt (1+ cnt))
11958 (when org-highlight-sparse-tree-matches
11959 (org-highlight-new-match (match-beginning 0) (match-end 0)))
11960 (org-show-context 'occur-tree))))
11961 (when org-remove-highlights-with-change
11962 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
11963 nil 'local))
11964 (unless org-sparse-tree-open-archived-trees
11965 (org-hide-archived-subtrees (point-min) (point-max)))
11966 (run-hooks 'org-occur-hook)
11967 (if (interactive-p)
11968 (message "%d match(es) for regexp %s" cnt regexp))
11969 cnt))
11971 (defun org-show-context (&optional key)
11972 "Make sure point and context are visible.
11973 How much context is shown depends upon the variables
11974 `org-show-hierarchy-above', `org-show-following-heading'. and
11975 `org-show-siblings'."
11976 (let ((heading-p (org-on-heading-p t))
11977 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
11978 (following-p (org-get-alist-option org-show-following-heading key))
11979 (entry-p (org-get-alist-option org-show-entry-below key))
11980 (siblings-p (org-get-alist-option org-show-siblings key)))
11981 (catch 'exit
11982 ;; Show heading or entry text
11983 (if (and heading-p (not entry-p))
11984 (org-flag-heading nil) ; only show the heading
11985 (and (or entry-p (org-invisible-p) (org-invisible-p2))
11986 (org-show-hidden-entry))) ; show entire entry
11987 (when following-p
11988 ;; Show next sibling, or heading below text
11989 (save-excursion
11990 (and (if heading-p (org-goto-sibling) (outline-next-heading))
11991 (org-flag-heading nil))))
11992 (when siblings-p (org-show-siblings))
11993 (when hierarchy-p
11994 ;; show all higher headings, possibly with siblings
11995 (save-excursion
11996 (while (and (condition-case nil
11997 (progn (org-up-heading-all 1) t)
11998 (error nil))
11999 (not (bobp)))
12000 (org-flag-heading nil)
12001 (when siblings-p (org-show-siblings))))))))
12003 (defvar org-reveal-start-hook nil
12004 "Hook run before revealing a location.")
12006 (defun org-reveal (&optional siblings)
12007 "Show current entry, hierarchy above it, and the following headline.
12008 This can be used to show a consistent set of context around locations
12009 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12010 not t for the search context.
12012 With optional argument SIBLINGS, on each level of the hierarchy all
12013 siblings are shown. This repairs the tree structure to what it would
12014 look like when opened with hierarchical calls to `org-cycle'.
12016 go to the parent and show the
12017 entire tree."
12018 (interactive "P")
12019 (run-hooks 'org-reveal-start-hook)
12020 (let ((org-show-hierarchy-above t)
12021 (org-show-following-heading t)
12022 (org-show-siblings (if siblings t org-show-siblings)))
12023 (org-show-context nil))
12024 (when (equal siblings '(16))
12025 (save-excursion
12026 (when (org-up-heading-safe)
12027 (org-show-subtree)
12028 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12030 (defun org-highlight-new-match (beg end)
12031 "Highlight from BEG to END and mark the highlight is an occur headline."
12032 (let ((ov (make-overlay beg end)))
12033 (overlay-put ov 'face 'secondary-selection)
12034 (push ov org-occur-highlights)))
12036 (defun org-remove-occur-highlights (&optional beg end noremove)
12037 "Remove the occur highlights from the buffer.
12038 BEG and END are ignored. If NOREMOVE is nil, remove this function
12039 from the `before-change-functions' in the current buffer."
12040 (interactive)
12041 (unless org-inhibit-highlight-removal
12042 (mapc 'delete-overlay org-occur-highlights)
12043 (setq org-occur-highlights nil)
12044 (setq org-occur-parameters nil)
12045 (unless noremove
12046 (remove-hook 'before-change-functions
12047 'org-remove-occur-highlights 'local))))
12049 ;;;; Priorities
12052 "Regular expression matching the priority indicator.")
12054 (defvar org-remove-priority-next-time nil)
12056 (defun org-priority-up ()
12057 "Increase the priority of the current item."
12058 (interactive)
12059 (org-priority 'up))
12061 (defun org-priority-down ()
12062 "Decrease the priority of the current item."
12063 (interactive)
12064 (org-priority 'down))
12066 (defun org-priority (&optional action)
12067 "Change the priority of an item by ARG.
12068 ACTION can be `set', `up', `down', or a character."
12069 (interactive)
12070 (unless org-enable-priority-commands
12071 (error "Priority commands are disabled"))
12072 (setq action (or action 'set))
12073 (let (current new news have remove)
12074 (save-excursion
12075 (org-back-to-heading t)
12076 (if (looking-at org-priority-regexp)
12077 (setq current (string-to-char (match-string 2))
12078 have t)
12079 (setq current org-default-priority))
12080 (cond
12081 ((eq action 'remove)
12082 (setq remove t new ?\ ))
12083 ((or (eq action 'set)
12084 (if (featurep 'xemacs) (characterp action) (integerp action)))
12085 (if (not (eq action 'set))
12086 (setq new action)
12087 (message "Priority %c-%c, SPC to remove: "
12088 org-highest-priority org-lowest-priority)
12089 (save-match-data
12090 (setq new (read-char-exclusive))))
12091 (if (and (= (upcase org-highest-priority) org-highest-priority)
12092 (= (upcase org-lowest-priority) org-lowest-priority))
12093 (setq new (upcase new)))
12094 (cond ((equal new ?\ ) (setq remove t))
12095 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12096 (error "Priority must be between `%c' and `%c'"
12097 org-highest-priority org-lowest-priority))))
12098 ((eq action 'up)
12099 (if (and (not have) (eq last-command this-command))
12100 (setq new org-lowest-priority)
12101 (setq new (if (and org-priority-start-cycle-with-default (not have))
12102 org-default-priority (1- current)))))
12103 ((eq action 'down)
12104 (if (and (not have) (eq last-command this-command))
12105 (setq new org-highest-priority)
12106 (setq new (if (and org-priority-start-cycle-with-default (not have))
12107 org-default-priority (1+ current)))))
12108 (t (error "Invalid action")))
12109 (if (or (< (upcase new) org-highest-priority)
12110 (> (upcase new) org-lowest-priority))
12111 (setq remove t))
12112 (setq news (format "%c" new))
12113 (if have
12114 (if remove
12115 (replace-match "" t t nil 1)
12116 (replace-match news t t nil 2))
12117 (if remove
12118 (error "No priority cookie found in line")
12119 (let ((case-fold-search nil))
12120 (looking-at org-todo-line-regexp))
12121 (if (match-end 2)
12122 (progn
12123 (goto-char (match-end 2))
12124 (insert " [#" news "]"))
12125 (goto-char (match-beginning 3))
12126 (insert "[#" news "] "))))
12127 (org-preserve-lc (org-set-tags nil 'align)))
12128 (if remove
12129 (message "Priority removed")
12130 (message "Priority of current item set to %s" news))))
12132 (defun org-get-priority (s)
12133 "Find priority cookie and return priority."
12134 (if (functionp org-get-priority-function)
12135 (funcall org-get-priority-function)
12136 (save-match-data
12137 (if (not (string-match org-priority-regexp s))
12138 (* 1000 (- org-lowest-priority org-default-priority))
12139 (* 1000 (- org-lowest-priority
12140 (string-to-char (match-string 2 s))))))))
12142 ;;;; Tags
12144 (defvar org-agenda-archives-mode)
12145 (defvar org-map-continue-from nil
12146 "Position from where mapping should continue.
12147 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12149 (defvar org-scanner-tags nil
12150 "The current tag list while the tags scanner is running.")
12151 (defvar org-trust-scanner-tags nil
12152 "Should `org-get-tags-at' use the tags fro the scanner.
12153 This is for internal dynamical scoping only.
12154 When this is non-nil, the function `org-get-tags-at' will return the value
12155 of `org-scanner-tags' instead of building the list by itself. This
12156 can lead to large speed-ups when the tags scanner is used in a file with
12157 many entries, and when the list of tags is retrieved, for example to
12158 obtain a list of properties. Building the tags list for each entry in such
12159 a file becomes an N^2 operation - but with this variable set, it scales
12160 as N.")
12162 (defun org-scan-tags (action matcher &optional todo-only)
12163 "Scan headline tags with inheritance and produce output ACTION.
12165 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12166 or `agenda' to produce an entry list for an agenda view. It can also be
12167 a Lisp form or a function that should be called at each matched headline, in
12168 this case the return value is a list of all return values from these calls.
12170 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12171 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12172 only lines with a TODO keyword are included in the output."
12173 (require 'org-agenda)
12176 (org-re
12178 (props (list 'face 'default
12179 'done-face 'org-agenda-done
12180 'undone-face 'default
12181 'mouse-face 'highlight
12182 'org-not-done-regexp org-not-done-regexp
12183 'org-todo-regexp org-todo-regexp
12184 'help-echo
12185 (format "mouse-2 or RET jump to org file %s"
12186 (abbreviate-file-name
12187 (or (buffer-file-name (buffer-base-buffer))
12188 (buffer-name (buffer-base-buffer)))))))
12189 (case-fold-search nil)
12190 (org-map-continue-from nil)
12191 lspos tags tags-list
12192 (tags-alist (list (cons 0 org-file-tags)))
12193 (llast 0) rtn rtn1 level category i txt
12194 todo marker entry priority)
12195 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12196 (setq action (list 'lambda nil action)))
12197 (save-excursion
12198 (goto-char (point-min))
12199 (when (eq action 'sparse-tree)
12200 (org-overview)
12201 (org-remove-occur-highlights))
12202 (while (re-search-forward re nil t)
12203 (catch :skip
12204 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12205 tags (if (match-end 4) (org-match-string-no-properties 4)))
12206 (goto-char (setq lspos (match-beginning 0)))
12207 (setq level (org-reduced-level (funcall outline-level))
12208 category (org-get-category))
12209 (setq i llast llast level)
12210 ;; remove tag lists from same and sublevels
12211 (while (>= i level)
12212 (when (setq entry (assoc i tags-alist))
12213 (setq tags-alist (delete entry tags-alist)))
12214 (setq i (1- i)))
12215 ;; add the next tags
12216 (when tags
12217 (setq tags (org-split-string tags ":")
12218 tags-alist
12219 (cons (cons level tags) tags-alist)))
12220 ;; compile tags for current headline
12221 (setq tags-list
12222 (if org-use-tag-inheritance
12223 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12224 tags)
12225 org-scanner-tags tags-list)
12226 (when org-use-tag-inheritance
12227 (setcdr (car tags-alist)
12228 (mapcar (lambda (x)
12229 (setq x (copy-sequence x))
12230 (org-add-prop-inherited x))
12231 (cdar tags-alist))))
12232 (when (and tags org-use-tag-inheritance
12233 (or (not (eq t org-use-tag-inheritance))
12234 org-tags-exclude-from-inheritance))
12235 ;; selective inheritance, remove uninherited ones
12236 (setcdr (car tags-alist)
12237 (org-remove-uniherited-tags (cdar tags-alist))))
12238 (when (and (or (not todo-only)
12239 (and (member todo org-not-done-keywords)
12240 (or (not org-agenda-tags-todo-honor-ignore-options)
12241 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12242 (let ((case-fold-search t)) (eval matcher))
12243 (or
12244 (not (member org-archive-tag tags-list))
12245 ;; we have an archive tag, should we use this anyway?
12246 (or (not org-agenda-skip-archived-trees)
12247 (and (eq action 'agenda) org-agenda-archives-mode))))
12248 (unless (eq action 'sparse-tree) (org-agenda-skip))
12250 ;; select this headline
12252 (cond
12253 ((eq action 'sparse-tree)
12254 (and org-highlight-sparse-tree-matches
12255 (org-get-heading) (match-end 0)
12256 (org-highlight-new-match
12257 (match-beginning 0) (match-beginning 1)))
12258 (org-show-context 'tags-tree))
12259 ((eq action 'agenda)
12260 (setq txt (org-format-agenda-item
12261 ""
12262 (concat
12263 (if (eq org-tags-match-list-sublevels 'indented)
12264 (make-string (1- level) ?.) "")
12265 (org-get-heading))
12266 category
12267 tags-list
12268 )
12269 priority (org-get-priority txt))
12270 (goto-char lspos)
12271 (setq marker (org-agenda-new-marker))
12272 (org-add-props txt props
12273 'org-marker marker 'org-hd-marker marker 'org-category category
12274 'todo-state todo
12275 'priority priority 'type "tagsmatch")
12276 (push txt rtn))
12277 ((functionp action)
12278 (setq org-map-continue-from nil)
12279 (save-excursion
12280 (setq rtn1 (funcall action))
12281 (push rtn1 rtn)))
12282 (t (error "Invalid action")))
12284 ;; if we are to skip sublevels, jump to end of subtree
12285 (unless org-tags-match-list-sublevels
12286 (org-end-of-subtree t)
12287 (backward-char 1))))
12288 ;; Get the correct position from where to continue
12289 (if org-map-continue-from
12290 (goto-char org-map-continue-from)
12291 (and (= (point) lspos) (end-of-line 1)))))
12292 (when (and (eq action 'sparse-tree)
12293 (not org-sparse-tree-open-archived-trees))
12294 (org-hide-archived-subtrees (point-min) (point-max)))
12295 (nreverse rtn)))
12297 (defun org-remove-uniherited-tags (tags)
12298 "Remove all tags that are not inherited from the list TAGS."
12299 (cond
12300 ((eq org-use-tag-inheritance t)
12301 (if org-tags-exclude-from-inheritance
12302 (org-delete-all org-tags-exclude-from-inheritance tags)
12303 tags))
12304 ((not org-use-tag-inheritance) nil)
12305 ((stringp org-use-tag-inheritance)
12306 (delq nil (mapcar
12307 (lambda (x)
12308 (if (and (string-match org-use-tag-inheritance x)
12309 (not (member x org-tags-exclude-from-inheritance)))
12310 x nil))
12311 tags)))
12312 ((listp org-use-tag-inheritance)
12313 (delq nil (mapcar
12314 (lambda (x)
12315 (if (member x org-use-tag-inheritance) x nil))
12316 tags)))))
12318 (defvar todo-only) ;; dynamically scoped
12320 (defun org-match-sparse-tree (&optional todo-only match)
12321 "Create a sparse tree according to tags string MATCH.
12322 MATCH can contain positive and negative selection of tags, like
12324 If optional argument TODO-ONLY is non-nil, only select lines that are
12325 also TODO lines."
12326 (interactive "P")
12327 (org-prepare-agenda-buffers (list (current-buffer)))
12328 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12330 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12332 (defvar org-cached-props nil)
12333 (defun org-cached-entry-get (pom property)
12334 (if (or (eq t org-use-property-inheritance)
12335 (and (stringp org-use-property-inheritance)
12336 (string-match org-use-property-inheritance property))
12337 (and (listp org-use-property-inheritance)
12338 (member property org-use-property-inheritance)))
12339 ;; Caching is not possible, check it directly
12340 (org-entry-get pom property 'inherit)
12341 ;; Get all properties, so that we can do complicated checks easily
12342 (cdr (assoc property (or org-cached-props
12343 (setq org-cached-props
12344 (org-entry-properties pom)))))))
12346 (defun org-global-tags-completion-table (&optional files)
12347 "Return the list of all tags in all agenda buffer/files."
12348 (save-excursion
12349 (org-uniquify
12350 (delq nil
12351 (apply 'append
12352 (mapcar
12353 (lambda (file)
12354 (set-buffer (find-file-noselect file))
12355 (append (org-get-buffer-tags)
12356 (mapcar (lambda (x) (if (stringp (car-safe x))
12357 (list (car-safe x)) nil))
12358 org-tag-alist)))
12359 (if (and files (car files))
12360 files
12361 (org-agenda-files))))))))
12363 (defun org-make-tags-matcher (match)
12364 "Create the TAGS//TODO matcher form for the selection string MATCH."
12365 ;; todo-only is scoped dynamically into this function, and the function
12366 ;; may change it if the matcher asks for it.
12367 (unless match
12368 ;; Get a new match request, with completion
12369 (let ((org-last-tags-completion-table
12370 (org-global-tags-completion-table)))
12371 (setq match (org-completing-read-no-i
12372 "Match: " 'org-tags-completion-function nil nil nil
12373 'org-tags-history))))
12375 ;; Parse the string and create a lisp form
12376 (let ((match0 match)
12377 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12378 minus tag mm
12379 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12380 orterms term orlist re-p str-p level-p level-op time-p
12381 prop-p pn pv po cat-p gv rest)
12382 (if (string-match "/+" match)
12383 ;; match contains also a todo-matching request
12384 (progn
12385 (setq tagsmatch (substring match 0 (match-beginning 0))
12386 todomatch (substring match (match-end 0)))
12387 (if (string-match "^!" todomatch)
12388 (setq todo-only t todomatch (substring todomatch 1)))
12390 (setq todomatch nil)))
12391 ;; only matching tags
12392 (setq tagsmatch match todomatch nil))
12394 ;; Make the tags matcher
12396 (setq tagsmatcher t)
12397 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12398 (while (setq term (pop orterms))
12400 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12401 (while (string-match re term)
12402 (setq rest (substring term (match-end 0))
12403 minus (and (match-end 1)
12404 (equal (match-string 1 term) "-"))
12405 tag (save-match-data (replace-regexp-in-string
12407 (match-string 2 term)))
12408 re-p (equal (string-to-char tag) ?{)
12409 level-p (match-end 4)
12410 prop-p (match-end 5)
12411 mm (cond
12412 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12413 (level-p
12414 (setq level-op (org-op-to-function (match-string 3 term)))
12415 `(,level-op level ,(string-to-number
12416 (match-string 4 term))))
12417 (prop-p
12418 (setq pn (match-string 5 term)
12419 po (match-string 6 term)
12420 pv (match-string 7 term)
12421 cat-p (equal pn "CATEGORY")
12422 re-p (equal (string-to-char pv) ?{)
12424 time-p (save-match-data
12426 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12427 (if time-p (setq pv (org-matcher-time pv)))
12428 (setq po (org-op-to-function po (if time-p 'time str-p)))
12429 (cond
12430 ((equal pn "CATEGORY")
12431 (setq gv '(get-text-property (point) 'org-category)))
12432 ((equal pn "TODO")
12433 (setq gv 'todo))
12434 (t
12435 (setq gv `(org-cached-entry-get nil ,pn))))
12436 (if re-p
12437 (if (eq po 'org<>)
12438 `(not (string-match ,pv (or ,gv "")))
12439 `(string-match ,pv (or ,gv "")))
12440 (if str-p
12441 `(,po (or ,gv "") ,pv)
12442 `(,po (string-to-number (or ,gv ""))
12443 ,(string-to-number pv) ))))
12444 (t `(member ,tag tags-list)))
12445 mm (if minus (list 'not mm) mm)
12446 term rest)
12447 (push mm tagsmatcher))
12448 (push (if (> (length tagsmatcher) 1)
12449 (cons 'and tagsmatcher)
12450 (car tagsmatcher))
12451 orlist)
12452 (setq tagsmatcher nil))
12453 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12454 (setq tagsmatcher
12455 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12456 ;; Make the todo matcher
12458 (setq todomatcher t)
12459 (setq orterms (org-split-string todomatch "|") orlist nil)
12460 (while (setq term (pop orterms))
12461 (while (string-match re term)
12462 (setq minus (and (match-end 1)
12463 (equal (match-string 1 term) "-"))
12464 kwd (match-string 2 term)
12465 re-p (equal (string-to-char kwd) ?{)
12466 term (substring term (match-end 0))
12467 mm (if re-p
12468 `(string-match ,(substring kwd 1 -1) todo)
12469 (list 'equal 'todo kwd))
12470 mm (if minus (list 'not mm) mm))
12471 (push mm todomatcher))
12472 (push (if (> (length todomatcher) 1)
12473 (cons 'and todomatcher)
12474 (car todomatcher))
12475 orlist)
12476 (setq todomatcher nil))
12477 (setq todomatcher (if (> (length orlist) 1)
12478 (cons 'or orlist) (car orlist))))
12480 ;; Return the string and lisp forms of the matcher
12481 (setq matcher (if todomatcher
12482 (list 'and tagsmatcher todomatcher)
12483 tagsmatcher))
12484 (cons match0 matcher)))
12486 (defun org-op-to-function (op &optional stringp)
12487 "Turn an operator into the appropriate function."
12488 (setq op
12489 (cond
12490 ((equal op "<" ) '(< string< org-time<))
12491 ((equal op ">" ) '(> org-string> org-time>))
12492 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12493 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12494 ((member op '("=" "==")) '(= string= org-time=))
12495 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12496 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12498 (defun org<> (a b) (not (= a b)))
12499 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12500 (defun org-string>= (a b) (not (string< a b)))
12501 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12502 (defun org-string<> (a b) (not (string= a b)))
12503 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12504 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12505 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12506 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12507 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12508 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12509 (defun org-2ft (s)
12510 "Convert S to a floating point time.
12511 If S is already a number, just return it. If it is a string, parse
12512 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12513 (cond
12514 ((numberp s) s)
12515 ((stringp s)
12516 (condition-case nil
12517 (float-time (apply 'encode-time (org-parse-time-string s)))
12518 (error 0.)))
12519 (t 0.)))
12521 (defun org-time-today ()
12522 "Time in seconds today at 0:00.
12523 Returns the float number of seconds since the beginning of the
12524 epoch to the beginning of today (00:00)."
12525 (float-time (apply 'encode-time
12526 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12528 (defun org-matcher-time (s)
12529 "Interpret a time comparison value."
12530 (save-match-data
12531 (cond
12532 ((string= s "<now>") (float-time))
12533 ((string= s "<today>") (org-time-today))
12534 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12535 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12537 (+ (org-time-today)
12538 (* (string-to-number (match-string 1 s))
12539 (cdr (assoc (match-string 2 s)
12540 '(("d" . 86400.0) ("w" . 604800.0)
12541 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12542 (t (org-2ft s)))))
12544 (defun org-match-any-p (re list)
12545 "Does re match any element of list?"
12546 (setq list (mapcar (lambda (x) (string-match re x)) list))
12547 (delq nil list))
12549 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12550 (defvar org-tags-overlay (make-overlay 1 1))
12551 (org-detach-overlay org-tags-overlay)
12553 (defun org-get-local-tags-at (&optional pos)
12554 "Get a list of tags defined in the current headline."
12555 (org-get-tags-at pos 'local))
12557 (defun org-get-local-tags ()
12558 "Get a list of tags defined in the current headline."
12559 (org-get-tags-at nil 'local))
12561 (defun org-get-tags-at (&optional pos local)
12562 "Get a list of all headline tags applicable at POS.
12563 POS defaults to point. If tags are inherited, the list contains
12564 the targets in the same sequence as the headlines appear, i.e.
12565 the tags of the current headline come last.
12566 When LOCAL is non-nil, only return tags from the current headline,
12567 ignore inherited ones."
12568 (interactive)
12569 (if (and org-trust-scanner-tags
12570 (or (not pos) (equal pos (point)))
12571 (not local))
12572 org-scanner-tags
12573 (let (tags ltags lastpos parent)
12574 (save-excursion
12575 (save-restriction
12576 (widen)
12577 (goto-char (or pos (point)))
12578 (save-match-data
12579 (catch 'done
12580 (condition-case nil
12581 (progn
12582 (org-back-to-heading t)
12583 (while (not (equal lastpos (point)))
12584 (setq lastpos (point))
12585 (when (looking-at
12587 (setq ltags (org-split-string
12588 (org-match-string-no-properties 1) ":"))
12589 (when parent
12590 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12591 (setq tags (append
12592 (if parent
12593 (org-remove-uniherited-tags ltags)
12594 ltags)
12595 tags)))
12596 (or org-use-tag-inheritance (throw 'done t))
12597 (if local (throw 'done t))
12598 (or (org-up-heading-safe) (error nil))
12599 (setq parent t)))
12600 (error nil)))))
12601 (append (org-remove-uniherited-tags org-file-tags) tags)))))
12603 (defun org-add-prop-inherited (s)
12604 (add-text-properties 0 (length s) '(inherited t) s)
12605 s)
12607 (defun org-toggle-tag (tag &optional onoff)
12608 "Toggle the tag TAG for the current line.
12609 If ONOFF is `on' or `off', don't toggle but set to this state."
12610 (let (res current)
12611 (save-excursion
12612 (org-back-to-heading t)
12614 (point-at-eol) t)
12615 (progn
12616 (setq current (match-string 1))
12617 (replace-match ""))
12618 (setq current ""))
12619 (setq current (nreverse (org-split-string current ":")))
12620 (cond
12621 ((eq onoff 'on)
12622 (setq res t)
12623 (or (member tag current) (push tag current)))
12624 ((eq onoff 'off)
12625 (or (not (member tag current)) (setq current (delete tag current))))
12626 (t (if (member tag current)
12627 (setq current (delete tag current))
12628 (setq res t)
12629 (push tag current))))
12630 (end-of-line 1)
12631 (if current
12632 (progn
12633 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12634 (org-set-tags nil t))
12635 (delete-horizontal-space))
12636 (run-hooks 'org-after-tags-change-hook))
12637 res))
12639 (defun org-align-tags-here (to-col)
12640 ;; Assumes that this is a headline
12641 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12642 (beginning-of-line 1)
12644 (< pos (match-beginning 2)))
12645 (progn
12646 (setq tags-l (- (match-end 2) (match-beginning 2)))
12647 (goto-char (match-beginning 1))
12648 (insert " ")
12649 (delete-region (point) (1+ (match-beginning 2)))
12650 (setq ncol (max (1+ (current-column))
12651 (1+ col)
12652 (if (> to-col 0)
12653 to-col
12654 (- (abs to-col) tags-l))))
12655 (setq p (point))
12656 (insert (make-string (- ncol (current-column)) ?\ ))
12657 (setq ncol (current-column))
12658 (when indent-tabs-mode (tabify p (point-at-eol)))
12659 (org-move-to-column (min ncol col) t))
12660 (goto-char pos))))
12662 (defun org-set-tags-command (&optional arg just-align)
12663 "Call the set-tags command for the current entry."
12664 (interactive "P")
12665 (if (org-on-heading-p)
12666 (org-set-tags arg just-align)
12667 (save-excursion
12668 (org-back-to-heading t)
12669 (org-set-tags arg just-align))))
12671 (defun org-set-tags-to (data)
12672 "Set the tags of the current entry to DATA, replacing the current tags.
12673 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12674 If DATA is nil or the empty string, any tags will be removed."
12675 (interactive "sTags: ")
12676 (setq data
12677 (cond
12678 ((eq data nil) "")
12679 ((equal data "") "")
12680 ((stringp data)
12681 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12682 ":"))
12683 ((listp data)
12684 (concat ":" (mapconcat 'identity data ":") ":"))
12685 (t nil)))
12686 (when data
12687 (save-excursion
12688 (org-back-to-heading t)
12689 (when (looking-at org-complex-heading-regexp)
12690 (if (match-end 5)
12691 (progn
12692 (goto-char (match-beginning 5))
12693 (insert data)
12694 (delete-region (point) (point-at-eol))
12695 (org-set-tags nil 'align))
12696 (goto-char (point-at-eol))
12697 (insert " " data)
12698 (org-set-tags nil 'align)))
12699 (beginning-of-line 1)
12701 (delete-region (match-beginning 1) (match-end 1))))))
12703 (defun org-align-all-tags ()
12704 "Align the tags i all headings."
12705 (interactive)
12706 (save-excursion
12707 (or (ignore-errors (org-back-to-heading t))
12708 (outline-next-heading))
12709 (if (org-on-heading-p)
12710 (org-set-tags t)
12711 (message "No headings"))))
12713 (defvar org-indent-indentation-per-level)
12714 (defun org-set-tags (&optional arg just-align)
12715 "Set the tags for the current headline.
12716 With prefix ARG, realign all tags in headings in the current buffer."
12717 (interactive "P")
12718 (let* ((re (concat "^" outline-regexp))
12719 (current (org-get-tags-string))
12720 (col (current-column))
12721 (org-setting-tags t)
12722 table current-tags inherited-tags ; computed below when needed
12723 tags p0 c0 c1 rpl di tc level)
12724 (if arg
12725 (save-excursion
12726 (goto-char (point-min))
12727 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12728 (while (re-search-forward re nil t)
12729 (org-set-tags nil t)
12730 (end-of-line 1)))
12731 (message "All tags realigned to column %d" org-tags-column))
12732 (if just-align
12733 (setq tags current)
12734 ;; Get a new set of tags from the user
12735 (save-excursion
12736 (setq table (append org-tag-persistent-alist
12737 (or org-tag-alist (org-get-buffer-tags))
12738 (and
12739 org-complete-tags-always-offer-all-agenda-tags
12740 (org-global-tags-completion-table
12741 (org-agenda-files))))
12742 org-last-tags-completion-table table
12743 current-tags (org-split-string current ":")
12744 inherited-tags (nreverse
12745 (nthcdr (length current-tags)
12746 (nreverse (org-get-tags-at))))
12747 tags
12748 (if (or (eq t org-use-fast-tag-selection)
12749 (and org-use-fast-tag-selection
12750 (delq nil (mapcar 'cdr table))))
12751 (org-fast-tag-selection
12752 current-tags inherited-tags table
12753 (if org-fast-tag-selection-include-todo
12754 org-todo-key-alist))
12755 (let ((org-add-colon-after-tag-completion t))
12756 (org-trim
12757 (org-without-partial-completion
12758 (org-icompleting-read "Tags: "
12759 'org-tags-completion-function
12760 nil nil current 'org-tags-history)))))))
12761 (while (string-match "[-+&]+" tags)
12762 ;; No boolean logic, just a list
12763 (setq tags (replace-match ":" t t tags))))
12765 (setq tags (replace-regexp-in-string "[ ,]" ":" tags))
12767 (if org-tags-sort-function
12768 (setq tags (mapconcat 'identity
12769 (sort (org-split-string
12770 tags (org-re "[^[:alnum:]_@#%]+"))
12771 org-tags-sort-function) ":")))
12774 (setq tags "")
12775 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12776 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12778 ;; Insert new tags at the correct column
12779 (beginning-of-line 1)
12780 (setq level (or (and (looking-at org-outline-regexp)
12781 (- (match-end 0) (point) 1))
12782 1))
12783 (cond
12784 ((and (equal current "") (equal tags "")))
12785 ((re-search-forward
12787 (point-at-eol) t)
12788 (if (equal tags "")
12789 (setq rpl "")
12790 (goto-char (match-beginning 0))
12791 (setq c0 (current-column)
12792 ;; compute offset for the case of org-indent-mode active
12793 di (if org-indent-mode
12794 (* (1- org-indent-indentation-per-level) (1- level))
12795 0)
12796 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
12797 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
12798 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
12799 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12800 (replace-match rpl t t)
12801 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
12802 tags)
12803 (t (error "Tags alignment failed")))
12804 (org-move-to-column col)
12805 (unless just-align
12806 (run-hooks 'org-after-tags-change-hook)))))
12808 (defun org-change-tag-in-region (beg end tag off)
12809 "Add or remove TAG for each entry in the region.
12810 This works in the agenda, and also in an org-mode buffer."
12811 (interactive
12812 (list (region-beginning) (region-end)
12813 (let ((org-last-tags-completion-table
12814 (if (org-mode-p)
12815 (org-get-buffer-tags)
12816 (org-global-tags-completion-table))))
12817 (org-icompleting-read
12818 "Tag: " 'org-tags-completion-function nil nil nil
12819 'org-tags-history))
12820 (progn
12822 (equal (read-char-exclusive) ?r))))
12823 (if (fboundp 'deactivate-mark) (deactivate-mark))
12824 (let ((agendap (equal major-mode 'org-agenda-mode))
12825 l1 l2 m buf pos newhead (cnt 0))
12826 (goto-char end)
12827 (setq l2 (1- (org-current-line)))
12828 (goto-char beg)
12829 (setq l1 (org-current-line))
12830 (loop for l from l1 to l2 do
12831 (org-goto-line l)
12832 (setq m (get-text-property (point) 'org-hd-marker))
12833 (when (or (and (org-mode-p) (org-on-heading-p))
12834 (and agendap m))
12835 (setq buf (if agendap (marker-buffer m) (current-buffer))
12836 pos (if agendap m (point)))
12837 (with-current-buffer buf
12838 (save-excursion
12839 (save-restriction
12840 (goto-char pos)
12841 (setq cnt (1+ cnt))
12842 (org-toggle-tag tag (if off 'off 'on))
12843 (setq newhead (org-get-heading)))))
12844 (and agendap (org-agenda-change-all-lines newhead m))))
12845 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
12847 (defun org-tags-completion-function (string predicate &optional flag)
12848 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12849 (confirm (lambda (x) (stringp (car x)))))
12851 (setq s1 (match-string 1 string)
12852 s2 (match-string 2 string))
12853 (setq s1 "" s2 string))
12854 (cond
12855 ((eq flag nil)
12856 ;; try completion
12857 (setq rtn (try-completion s2 ctable confirm))
12858 (if (stringp rtn)
12859 (setq rtn
12860 (concat s1 s2 (substring rtn (length s2))
12861 (if (and org-add-colon-after-tag-completion
12862 (assoc rtn ctable))
12863 ":" ""))))
12864 rtn)
12865 ((eq flag t)
12866 ;; all-completions
12867 (all-completions s2 ctable confirm)
12868 )
12869 ((eq flag 'lambda)
12870 ;; exact match?
12871 (assoc s2 ctable)))
12872 ))
12874 (defun org-fast-tag-insert (kwd tags face &optional end)
12875 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
12876 (insert (format "%-12s" (concat kwd ":"))
12877 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
12878 (or end "")))
12880 (defun org-fast-tag-show-exit (flag)
12881 (save-excursion
12882 (org-goto-line 3)
12884 (replace-match ""))
12885 (when flag
12886 (end-of-line 1)
12887 (org-move-to-column (- (window-width) 19) t)
12888 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
12890 (defun org-set-current-tags-overlay (current prefix)
12891 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
12892 (if (featurep 'xemacs)
12893 (org-overlay-display org-tags-overlay (concat prefix s)
12894 'secondary-selection)
12895 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
12896 (org-overlay-display org-tags-overlay (concat prefix s)))))
12898 (defvar org-last-tag-selection-key nil)
12899 (defun org-fast-tag-selection (current inherited table &optional todo-table)
12900 "Fast tag selection with single keys.
12901 CURRENT is the current list of tags in the headline, INHERITED is the
12902 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
12903 possibly with grouping information. TODO-TABLE is a similar table with
12904 TODO keywords, should these have keys assigned to them.
12905 If the keys are nil, a-z are automatically assigned.
12906 Returns the new tags string, or nil to not change the current settings."
12907 (let* ((fulltable (append table todo-table))
12908 (maxlen (apply 'max (mapcar
12909 (lambda (x)
12910 (if (stringp (car x)) (string-width (car x)) 0))
12911 fulltable)))
12912 (buf (current-buffer))
12913 (expert (eq org-fast-tag-selection-single-key 'expert))
12914 (buffer-tags nil)
12915 (fwidth (+ maxlen 3 1 3))
12916 (ncol (/ (- (window-width) 4) fwidth))
12917 (i-face 'org-done)
12918 (c-face 'org-todo)
12919 tg cnt e c char c1 c2 ntable tbl rtn
12920 ov-start ov-end ov-prefix
12921 (exit-after-next org-fast-tag-selection-single-key)
12922 (done-keywords org-done-keywords)
12923 groups ingroup)
12924 (save-excursion
12925 (beginning-of-line 1)
12926 (if (looking-at
12928 (setq ov-start (match-beginning 1)
12929 ov-end (match-end 1)
12930 ov-prefix "")
12931 (setq ov-start (1- (point-at-eol))
12932 ov-end (1+ ov-start))
12934 (setq ov-prefix
12935 (concat
12936 (buffer-substring (1- (point)) (point))
12937 (if (> (current-column) org-tags-column)
12938 " "
12939 (make-string (- org-tags-column (current-column)) ?\ ))))))
12940 (move-overlay org-tags-overlay ov-start ov-end)
12941 (save-window-excursion
12942 (if expert
12943 (set-buffer (get-buffer-create " *Org tags*"))
12944 (delete-other-windows)
12945 (split-window-vertically)
12946 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
12947 (erase-buffer)
12948 (org-set-local 'org-done-keywords done-keywords)
12951 (org-fast-tag-show-exit exit-after-next)
12952 (org-set-current-tags-overlay current ov-prefix)
12953 (setq tbl fulltable char ?a cnt 0)
12954 (while (setq e (pop tbl))
12955 (cond
12956 ((equal (car e) :startgroup)
12957 (push '() groups) (setq ingroup t)
12958 (when (not (= cnt 0))
12959 (setq cnt 0)
12961 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
12962 ((equal (car e) :endgroup)
12963 (setq ingroup nil cnt 0)
12965 ((equal e '(:newline))
12966 (when (not (= cnt 0))
12967 (setq cnt 0)
12969 (setq e (car tbl))
12970 (while (equal (car tbl) '(:newline))
12972 (setq tbl (cdr tbl)))))
12973 (t
12974 (setq tg (copy-sequence (car e)) c2 nil)
12975 (if (cdr e)
12976 (setq c (cdr e))
12977 ;; automatically assign a character.
12978 (setq c1 (string-to-char
12979 (downcase (substring
12980 tg (if (= (string-to-char tg) ?@) 1 0)))))
12981 (if (or (rassoc c1 ntable) (rassoc c1 table))
12982 (while (or (rassoc char ntable) (rassoc char table))
12983 (setq char (1+ char)))
12984 (setq c2 c1))
12985 (setq c (or c2 char)))
12986 (if ingroup (push tg (car groups)))
12987 (setq tg (org-add-props tg nil 'face
12988 (cond
12989 ((not (assoc tg table))
12990 (org-get-todo-face tg))
12991 ((member tg current) c-face)
12992 ((member tg inherited) i-face)
12993 (t nil))))
12994 (if (and (= cnt 0) (not ingroup)) (insert " "))
12995 (insert "[" c "] " tg (make-string
12996 (- fwidth 4 (length tg)) ?\ ))
12997 (push (cons tg c) ntable)
12998 (when (= (setq cnt (1+ cnt)) ncol)
13000 (if ingroup (insert " "))
13001 (setq cnt 0)))))
13002 (setq ntable (nreverse ntable))
13004 (goto-char (point-min))
13005 (if (not expert) (org-fit-window-to-buffer))
13006 (setq rtn
13007 (catch 'exit
13008 (while t
13009 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13010 (if (not groups) "no " "")
13011 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13012 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13013 (setq org-last-tag-selection-key c)
13014 (cond
13016 ((= c ?!)
13017 (setq groups (not groups))
13018 (goto-char (point-min))
13019 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13020 ((= c ?\C-c)
13021 (if (not expert)
13022 (org-fast-tag-show-exit
13023 (setq exit-after-next (not exit-after-next)))
13024 (setq expert nil)
13025 (delete-other-windows)
13026 (split-window-vertically)
13027 (org-switch-to-buffer-other-window " *Org tags*")
13028 (org-fit-window-to-buffer)))
13029 ((or (= c ?\C-g)
13030 (and (= c ?q) (not (rassoc c ntable))))
13031 (org-detach-overlay org-tags-overlay)
13032 (setq quit-flag t))
13033 ((= c ?\ )
13034 (setq current nil)
13035 (if exit-after-next (setq exit-after-next 'now)))
13037 (condition-case nil
13038 (setq tg (org-icompleting-read
13039 "Tag: "
13040 (or buffer-tags
13041 (with-current-buffer buf
13042 (org-get-buffer-tags)))))
13043 (quit (setq tg "")))
13045 (add-to-list 'buffer-tags (list tg))
13046 (if (member tg current)
13047 (setq current (delete tg current))
13048 (push tg current)))
13049 (if exit-after-next (setq exit-after-next 'now)))
13050 ((setq e (rassoc c todo-table) tg (car e))
13051 (with-current-buffer buf
13052 (save-excursion (org-todo tg)))
13053 (if exit-after-next (setq exit-after-next 'now)))
13054 ((setq e (rassoc c ntable) tg (car e))
13055 (if (member tg current)
13056 (setq current (delete tg current))
13057 (loop for g in groups do
13058 (if (member tg g)
13059 (mapc (lambda (x)
13060 (setq current (delete x current)))
13061 g)))
13062 (push tg current))
13063 (if exit-after-next (setq exit-after-next 'now))))
13065 ;; Create a sorted list
13066 (setq current
13067 (sort current
13068 (lambda (a b)
13069 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13070 (if (eq exit-after-next 'now) (throw 'exit t))
13071 (goto-char (point-min))
13072 (beginning-of-line 2)
13073 (delete-region (point) (point-at-eol))
13074 (org-fast-tag-insert "Current" current c-face)
13075 (org-set-current-tags-overlay current ov-prefix)
13076 (while (re-search-forward
13078 (setq tg (match-string 1))
13079 (add-text-properties
13080 (match-beginning 1) (match-end 1)
13081 (list 'face
13082 (cond
13083 ((member tg current) c-face)
13084 ((member tg inherited) i-face)
13085 (t (get-text-property (match-beginning 1) 'face))))))
13086 (goto-char (point-min)))))
13087 (org-detach-overlay org-tags-overlay)
13088 (if rtn
13089 (mapconcat 'identity current ":")
13090 nil))))
13092 (defun org-get-tags-string ()
13093 "Get the TAGS string in the current headline."
13094 (unless (org-on-heading-p t)
13095 (error "Not on a heading"))
13096 (save-excursion
13097 (beginning-of-line 1)
13099 (org-match-string-no-properties 1)
13100 "")))
13102 (defun org-get-tags ()
13103 "Get the list of tags specified in the current headline."
13104 (org-split-string (org-get-tags-string) ":"))
13106 (defun org-get-buffer-tags ()
13107 "Get a table of all tags used in the buffer, for completion."
13108 (let (tags)
13109 (save-excursion
13110 (goto-char (point-min))
13111 (while (re-search-forward
13113 (when (equal (char-after (point-at-bol 0)) ?*)
13114 (mapc (lambda (x) (add-to-list 'tags x))
13115 (org-split-string (org-match-string-no-properties 1) ":")))))
13116 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13117 (mapcar 'list tags)))
13119 ;;;; The mapping API
13121 ;;;###autoload
13122 (defun org-map-entries (func &optional match scope &rest skip)
13123 "Call FUNC at each headline selected by MATCH in SCOPE.
13125 FUNC is a function or a lisp form. The function will be called without
13126 arguments, with the cursor positioned at the beginning of the headline.
13127 The return values of all calls to the function will be collected and
13128 returned as a list.
13130 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13131 does not need to preserve point. After evaluation, the cursor will be
13132 moved to the end of the line (presumably of the headline of the
13133 processed entry) and search continues from there. Under some
13134 circumstances, this may not produce the wanted results. For example,
13135 if you have removed (e.g. archived) the current (sub)tree it could
13136 mean that the next entry will be skipped entirely. In such cases, you
13137 can specify the position from where search should continue by making
13138 FUNC set the variable `org-map-continue-from' to the desired buffer
13139 position.
13141 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13142 Only headlines that are matched by this query will be considered during
13143 the iteration. When MATCH is nil or t, all headlines will be
13144 visited by the iteration.
13146 SCOPE determines the scope of this command. It can be any of:
13148 nil The current buffer, respecting the restriction if any
13149 tree The subtree started with the entry at point
13150 file The current buffer, without restriction
13151 file-with-archives
13152 The current buffer, and any archives associated with it
13153 agenda All agenda files
13154 agenda-with-archives
13155 All agenda files with any archive files associated with them
13156 \(file1 file2 ...)
13157 If this is a list, all files in the list will be scanned
13159 The remaining args are treated as settings for the skipping facilities of
13160 the scanner. The following items can be given here:
13162 archive skip trees with the archive tag.
13163 comment skip trees with the COMMENT keyword
13164 function or Emacs Lisp form:
13165 will be used as value for `org-agenda-skip-function', so whenever
13166 the function returns t, FUNC will not be called for that
13167 entry and search will continue from the point where the
13168 function leaves it.
13170 If your function needs to retrieve the tags including inherited tags
13171 at the *current* entry, you can use the value of the variable
13172 `org-scanner-tags' which will be much faster than getting the value
13173 with `org-get-tags-at'. If your function gets properties with
13174 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13175 to t around the call to `org-entry-properties' to get the same speedup.
13176 Note that if your function moves around to retrieve tags and properties at
13177 a *different* entry, you cannot use these techniques."
13178 (let* ((org-agenda-archives-mode nil) ; just to make sure
13179 (org-agenda-skip-archived-trees (memq 'archive skip))
13180 (org-agenda-skip-comment-trees (memq 'comment skip))
13181 (org-agenda-skip-function
13182 (car (org-delete-all '(comment archive) skip)))
13183 (org-tags-match-list-sublevels t)
13184 matcher file res
13185 org-todo-keywords-for-agenda
13186 org-done-keywords-for-agenda
13187 org-todo-keyword-alist-for-agenda
13188 org-drawers-for-agenda
13189 org-tag-alist-for-agenda)
13191 (cond
13192 ((eq match t) (setq matcher t))
13193 ((eq match nil) (setq matcher t))
13194 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13196 (save-excursion
13197 (save-restriction
13198 (when (eq scope 'tree)
13199 (org-back-to-heading t)
13200 (org-narrow-to-subtree)
13201 (setq scope nil))
13203 (if (not scope)
13204 (progn
13205 (org-prepare-agenda-buffers
13206 (list (buffer-file-name (current-buffer))))
13207 (setq res (org-scan-tags func matcher)))
13208 ;; Get the right scope
13209 (cond
13210 ((and scope (listp scope) (symbolp (car scope)))
13211 (setq scope (eval scope)))
13212 ((eq scope 'agenda)
13213 (setq scope (org-agenda-files t)))
13214 ((eq scope 'agenda-with-archives)
13215 (setq scope (org-agenda-files t))
13216 (setq scope (org-add-archive-files scope)))
13217 ((eq scope 'file)
13218 (setq scope (list (buffer-file-name))))
13219 ((eq scope 'file-with-archives)
13220 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13221 (org-prepare-agenda-buffers scope)
13222 (while (setq file (pop scope))
13223 (with-current-buffer (org-find-base-buffer-visiting file)
13224 (save-excursion
13225 (save-restriction
13226 (widen)
13227 (goto-char (point-min))
13228 (setq res (append res (org-scan-tags func matcher))))))))))
13229 res))
13231 ;;;; Properties
13233 ;;; Setting and retrieving properties
13235 (defconst org-special-properties
13236 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13237 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED")
13238 "The special properties valid in Org-mode.
13240 These are properties that are not defined in the property drawer,
13241 but in some other way.")
13243 (defconst org-default-properties
13244 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13245 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13246 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13247 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13248 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13249 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13250 "Some properties that are used by Org-mode for various purposes.
13251 Being in this list makes sure that they are offered for completion.")
13254 "Regular expression matching the first line of a property drawer.")
13257 "Regular expression matching the last line of a property drawer.")
13260 "Regular expression matching the first line of a property drawer.")
13263 "Regular expression matching the first line of a property drawer.")
13265 (defconst org-property-drawer-re
13268 "Matches an entire property drawer.")
13270 (defconst org-clock-drawer-re
13273 "Matches an entire clock drawer.")
13275 (defun org-property-action ()
13276 "Do an action on properties."
13277 (interactive)
13278 (let (c)
13279 (org-at-property-p)
13280 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13281 (setq c (read-char-exclusive))
13282 (cond
13283 ((equal c ?s)
13284 (call-interactively 'org-set-property))
13285 ((equal c ?d)
13286 (call-interactively 'org-delete-property))
13287 ((equal c ?D)
13288 (call-interactively 'org-delete-property-globally))
13289 ((equal c ?c)
13290 (call-interactively 'org-compute-property-at-point))
13291 (t (error "No such property action %c" c)))))
13293 (defun org-set-effort (&optional value)
13294 "Set the effort property of the current entry.
13295 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13296 allowed value."
13297 (interactive "P")
13298 (if (equal value 0) (setq value 10))
13299 (let* ((completion-ignore-case t)
13300 (prop org-effort-property)
13301 (cur (org-entry-get nil prop))
13302 (allowed (org-property-get-allowed-values nil prop 'table))
13303 (existing (mapcar 'list (org-property-values prop)))
13304 rpl
13305 (val (cond
13306 ((stringp value) value)
13307 ((and allowed (integerp value))
13308 (or (car (nth (1- value) allowed))
13309 (car (org-last allowed))))
13310 (allowed
13311 (message "Select 1-9,0, [RET%s]: %s"
13312 (if cur (concat "=" cur) "")
13313 (mapconcat 'car allowed " "))
13314 (setq rpl (read-char-exclusive))
13316 cur
13317 (setq rpl (- rpl ?0))
13318 (if (equal rpl 0) (setq rpl 10))
13319 (if (and (> rpl 0) (<= rpl (length allowed)))
13320 (car (nth (1- rpl) allowed))
13321 (org-completing-read "Effort: " allowed nil))))
13322 (t
13323 (let (org-completion-use-ido org-completion-use-iswitchb)
13324 (org-completing-read
13326 (concat "[" cur "]") "")
13327 ": ")
13328 existing nil nil "" nil cur))))))
13329 (unless (equal (org-entry-get nil prop) val)
13330 (org-entry-put nil prop val))
13331 (message "%s is now %s" prop val)))
13333 (defun org-at-property-p ()
13334 "Is cursor inside a property drawer?"
13335 (save-excursion
13336 (beginning-of-line 1)
13338 (save-match-data ;; Used by calling procedures
13339 (let ((p (point))
13340 (range (unless (org-before-first-heading-p)
13341 (org-get-property-block))))
13342 (and range (<= (car range) p) (< p (cdr range))))))))
13344 (defun org-get-property-block (&optional beg end force)
13345 "Return the (beg . end) range of the body of the property drawer.
13346 BEG and END can be beginning and end of subtree, if not given
13347 they will be found.
13348 If the drawer does not exist and FORCE is non-nil, create the drawer."
13349 (catch 'exit
13350 (save-excursion
13351 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13352 (end (or end (progn (outline-next-heading) (point)))))
13353 (goto-char beg)
13354 (if (re-search-forward org-property-start-re end t)
13355 (setq beg (1+ (match-end 0)))
13356 (if force
13357 (save-excursion
13358 (org-insert-property-drawer)
13359 (setq end (progn (outline-next-heading) (point))))
13360 (throw 'exit nil))
13361 (goto-char beg)
13362 (if (re-search-forward org-property-start-re end t)
13363 (setq beg (1+ (match-end 0)))))
13364 (if (re-search-forward org-property-end-re end t)
13365 (setq end (match-beginning 0))
13366 (or force (throw 'exit nil))
13367 (goto-char beg)
13368 (setq end beg)
13369 (org-indent-line-function)
13371 (cons beg end)))))
13373 (defun org-entry-properties (&optional pom which specific)
13374 "Get all properties of the entry at point-or-marker POM.
13375 This includes the TODO keyword, the tags, time strings for deadline,
13376 scheduled, and clocking, and any additional properties defined in the
13377 entry. The return value is an alist, keys may occur multiple times
13378 if the property key was used several times.
13379 POM may also be nil, in which case the current entry is used.
13380 If WHICH is nil or `all', get all properties. If WHICH is
13381 `special' or `standard', only get that subclass. If WHICH
13382 is a string only get exactly this property. Specific can be a string, the
13383 specific property we are interested in. Specifying it can speed
13384 things up because then unnecessary parsing is avoided."
13385 (setq which (or which 'all))
13386 (org-with-point-at pom
13387 (let ((clockstr (substring org-clock-string 0 -1))
13388 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13389 (case-fold-search nil)
13390 beg end range props sum-props key key1 value string clocksum)
13391 (save-excursion
13392 (when (condition-case nil
13393 (and (org-mode-p) (org-back-to-heading t))
13394 (error nil))
13395 (setq beg (point))
13396 (setq sum-props (get-text-property (point) 'org-summaries))
13397 (setq clocksum (get-text-property (point) :org-clock-minutes))
13398 (outline-next-heading)
13399 (setq end (point))
13400 (when (memq which '(all special))
13401 ;; Get the special properties, like TODO and tags
13402 (goto-char beg)
13403 (when (and (or (not specific) (string= specific "TODO"))
13404 (looking-at org-todo-line-regexp) (match-end 2))
13405 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13406 (when (and (or (not specific) (string= specific "PRIORITY"))
13407 (looking-at org-priority-regexp))
13408 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13409 (when (and (or (not specific) (string= specific "TAGS"))
13410 (setq value (org-get-tags-string))
13412 (push (cons "TAGS" value) props))
13413 (when (and (or (not specific) (string= specific "ALLTAGS"))
13414 (setq value (org-get-tags-at)))
13415 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13416 ":"))
13417 props))
13418 (when (or (not specific) (string= specific "BLOCKED"))
13419 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13420 (when (or (not specific)
13421 (member specific
13422 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13423 "TIMESTAMP" "TIMESTAMP_IA")))
13424 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13425 (setq key (if (match-end 1)
13426 (substring (org-match-string-no-properties 1)
13427 0 -1))
13428 string (if (equal key clockstr)
13429 (org-no-properties
13430 (org-trim
13431 (buffer-substring
13432 (match-beginning 3) (goto-char
13433 (point-at-eol)))))
13434 (substring (org-match-string-no-properties 3)
13435 1 -1)))
13436 ;; Get the correct property name from the key. This is
13437 ;; necessary if the user has configured time keywords.
13438 (setq key1 (concat key ":"))
13439 (cond
13440 ((not key)
13441 (setq key
13442 (if (= (char-after (match-beginning 3)) ?\[)
13443 "TIMESTAMP_IA" "TIMESTAMP")))
13444 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13445 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13446 ((equal key1 org-closed-string) (setq key "CLOSED"))
13447 ((equal key1 org-clock-string) (setq key "CLOCK")))
13448 (when (or (equal key "CLOCK") (not (assoc key props)))
13449 (push (cons key string) props))))
13450 )
13452 (when (memq which '(all standard))
13453 ;; Get the standard properties, like :PROP: ...
13454 (setq range (org-get-property-block beg end))
13455 (when range
13456 (goto-char (car range))
13457 (while (re-search-forward
13459 (cdr range) t)
13460 (setq key (org-match-string-no-properties 1)
13461 value (org-trim (or (org-match-string-no-properties 2) "")))
13462 (unless (member key excluded)
13463 (push (cons key (or value "")) props)))))
13464 (if clocksum
13465 (push (cons "CLOCKSUM"
13466 (org-columns-number-to-string (/ (float clocksum) 60.)
13467 'add_times))
13468 props))
13469 (unless (assoc "CATEGORY" props)
13470 (setq value (or (org-get-category)
13471 (progn (org-refresh-category-properties)
13472 (org-get-category))))
13473 (push (cons "CATEGORY" value) props))
13474 (append sum-props (nreverse props)))))))
13476 (defun org-entry-get (pom property &optional inherit literal-nil)
13477 "Get value of PROPERTY for entry at point-or-marker POM.
13478 If INHERIT is non-nil and the entry does not have the property,
13479 then also check higher levels of the hierarchy.
13480 If INHERIT is the symbol `selective', use inheritance only if the setting
13481 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13482 If the property is present but empty, the return value is the empty string.
13483 If the property is not present at all, nil is returned.
13486 do not interpret it as the list atom nil. This is used for inheritance
13488 (org-with-point-at pom
13489 (if (and inherit (if (eq inherit 'selective)
13490 (org-property-inherit-p property)
13491 t))
13492 (org-entry-get-with-inheritance property literal-nil)
13493 (if (member property org-special-properties)
13494 ;; We need a special property. Use `org-entry-properties' to
13495 ;; retrieve it, but specify the wanted property
13496 (cdr (assoc property (org-entry-properties nil 'special property)))
13497 (let ((range (org-get-property-block)))
13498 (if (and range
13499 (goto-char (car range))
13500 (re-search-forward
13502 (cdr range) t))
13503 ;; Found the property, return it.
13504 (if (match-end 1)
13505 (if literal-nil
13506 (org-match-string-no-properties 1)
13507 (org-not-nil (org-match-string-no-properties 1)))
13508 "")))))))
13510 (defun org-property-or-variable-value (var &optional inherit)
13511 "Check if there is a property fixing the value of VAR.
13512 If yes, return this value. If not, return the current value of the variable."
13513 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13515 (read prop)
13516 (symbol-value var))))
13518 (defun org-entry-delete (pom property)
13519 "Delete the property PROPERTY from entry at point-or-marker POM."
13520 (org-with-point-at pom
13521 (if (member property org-special-properties)
13522 nil ; cannot delete these properties.
13523 (let ((range (org-get-property-block)))
13524 (if (and range
13525 (goto-char (car range))
13526 (re-search-forward
13528 (cdr range) t))
13529 (progn
13530 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13531 t)
13532 nil)))))
13534 ;; Multi-values properties are properties that contain multiple values
13535 ;; These values are assumed to be single words, separated by whitespace.
13536 (defun org-entry-add-to-multivalued-property (pom property value)
13537 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13538 (let* ((old (org-entry-get pom property))
13540 (setq value (org-entry-protect-space value))
13541 (unless (member value values)
13542 (setq values (cons value values))
13543 (org-entry-put pom property
13544 (mapconcat 'identity values " ")))))
13546 (defun org-entry-remove-from-multivalued-property (pom property value)
13547 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13548 (let* ((old (org-entry-get pom property))
13550 (setq value (org-entry-protect-space value))
13551 (when (member value values)
13552 (setq values (delete value values))
13553 (org-entry-put pom property
13554 (mapconcat 'identity values " ")))))
13556 (defun org-entry-member-in-multivalued-property (pom property value)
13557 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13558 (let* ((old (org-entry-get pom property))
13560 (setq value (org-entry-protect-space value))
13561 (member value values)))
13563 (defun org-entry-get-multivalued-property (pom property)
13564 "Return a list of values in a multivalued property."
13565 (let* ((value (org-entry-get pom property))
13567 (mapcar 'org-entry-restore-space values)))
13569 (defun org-entry-put-multivalued-property (pom property &rest values)
13570 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13571 VALUES should be a list of strings. Spaces will be protected."
13572 (org-entry-put pom property
13573 (mapconcat 'org-entry-protect-space values " "))
13574 (let* ((value (org-entry-get pom property))
13576 (mapcar 'org-entry-restore-space values)))
13578 (defun org-entry-protect-space (s)
13579 "Protect spaces and newline in string S."
13580 (while (string-match " " s)
13581 (setq s (replace-match "%20" t t s)))
13583 (setq s (replace-match "%0A" t t s)))
13584 s)
13586 (defun org-entry-restore-space (s)
13587 "Restore spaces and newline in string S."
13588 (while (string-match "%20" s)
13589 (setq s (replace-match " " t t s)))
13590 (while (string-match "%0A" s)
13592 s)
13594 (defvar org-entry-property-inherited-from (make-marker)
13595 "Marker pointing to the entry from where a property was inherited.
13596 Each call to `org-entry-get-with-inheritance' will set this marker to the
13597 location of the entry where the inheritance search matched. If there was
13598 no match, the marker will point nowhere.
13599 Note that also `org-entry-get' calls this function, if the INHERIT flag
13600 is set.")
13602 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13603 "Get entry property, and search higher levels if not present.
13604 The search will stop at the first ancestor which has the property defined.
13606 should be considered as undefined (this is the meaning of nil here).
13608 (move-marker org-entry-property-inherited-from nil)
13609 (let (tmp)
13610 (save-excursion
13611 (save-restriction
13612 (widen)
13613 (catch 'ex
13614 (while t
13615 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13616 (org-back-to-heading t)
13617 (move-marker org-entry-property-inherited-from (point))
13618 (throw 'ex tmp))
13619 (or (org-up-heading-safe) (throw 'ex nil)))))
13620 (setq tmp (or tmp
13621 (cdr (assoc property org-file-properties))
13622 (cdr (assoc property org-global-properties))
13623 (cdr (assoc property org-global-properties-fixed))))
13624 (if literal-nil tmp (org-not-nil tmp)))))
13626 (defvar org-property-changed-functions nil
13627 "Hook called when the value of a property has changed.
13628 Each hook function should accept two arguments, the name of the property
13629 and the new value.")
13631 (defun org-entry-put (pom property value)
13632 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13633 (org-with-point-at pom
13634 (org-back-to-heading t)
13635 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13636 range)
13637 (cond
13638 ((equal property "TODO")
13640 (not (member value org-todo-keywords-1)))
13642 (if (or (not value)
13644 (setq value 'none))
13645 (org-todo value)
13646 (org-set-tags nil 'align))
13647 ((equal property "PRIORITY")
13649 (string-to-char value) ?\ ))
13650 (org-set-tags nil 'align))
13651 ((equal property "SCHEDULED")
13652 (if (re-search-forward org-scheduled-time-regexp end t)
13653 (cond
13654 ((eq value 'earlier) (org-timestamp-change -1 'day))
13655 ((eq value 'later) (org-timestamp-change 1 'day))
13656 (t (call-interactively 'org-schedule)))
13657 (call-interactively 'org-schedule)))
13658 ((equal property "DEADLINE")
13659 (if (re-search-forward org-deadline-time-regexp end t)
13660 (cond
13661 ((eq value 'earlier) (org-timestamp-change -1 'day))
13662 ((eq value 'later) (org-timestamp-change 1 'day))
13663 (t (call-interactively 'org-deadline)))
13664 (call-interactively 'org-deadline)))
13665 ((member property org-special-properties)
13666 (error "The %s property can not yet be set with `org-entry-put'"
13667 property))
13668 (t ; a non-special property
13669 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13670 (setq range (org-get-property-block beg end 'force))
13671 (goto-char (car range))
13672 (if (re-search-forward
13674 (progn
13675 (delete-region (match-beginning 1) (match-end 1))
13676 (goto-char (match-beginning 1)))
13677 (goto-char (cdr range))
13679 (backward-char 1)
13680 (org-indent-line-function)
13681 (insert ":" property ":"))
13682 (and value (insert " " value))
13683 (org-indent-line-function)))))
13684 (run-hook-with-args 'org-property-changed-functions property value)))
13686 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13687 "Get all property keys in the current buffer.
13688 With INCLUDE-SPECIALS, also list the special properties that reflect things
13689 like tags and TODO state.
13690 With INCLUDE-DEFAULTS, also include properties that has special meaning
13691 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
13692 With INCLUDE-COLUMNS, also include property names given in COLUMN
13693 formats in the current buffer."
13694 (let (rtn range cfmt s p)
13695 (save-excursion
13696 (save-restriction
13697 (widen)
13698 (goto-char (point-min))
13699 (while (re-search-forward org-property-start-re nil t)
13700 (setq range (org-get-property-block))
13701 (goto-char (car range))
13702 (while (re-search-forward
13704 (cdr range) t)
13705 (add-to-list 'rtn (org-match-string-no-properties 1)))
13706 (outline-next-heading))))
13708 (when include-specials
13709 (setq rtn (append org-special-properties rtn)))
13711 (when include-defaults
13712 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13713 (add-to-list 'rtn org-effort-property))
13715 (when include-columns
13716 (save-excursion
13717 (save-restriction
13718 (widen)
13719 (goto-char (point-min))
13720 (while (re-search-forward
13722 nil t)
13723 (setq cfmt (match-string 2) s 0)
13725 cfmt s)
13726 (setq s (match-end 0)
13727 p (match-string 1 cfmt))
13728 (unless (or (equal p "ITEM")
13729 (member p org-special-properties))
13730 (add-to-list 'rtn (match-string 1 cfmt))))))))
13732 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13734 (defun org-property-values (key)
13735 "Return a list of all values of property KEY."
13736 (save-excursion
13737 (save-restriction
13738 (widen)
13739 (goto-char (point-min))
13741 values)
13742 (while (re-search-forward re nil t)
13743 (add-to-list 'values (org-trim (match-string 1))))
13744 (delete "" values)))))
13746 (defun org-insert-property-drawer ()
13747 "Insert a property drawer into the current entry."
13748 (interactive)
13749 (org-back-to-heading t)
13750 (looking-at outline-regexp)
13751 (let ((indent (if org-adapt-indentation
13752 (- (match-end 0)(match-beginning 0))
13753 0))
13754 (beg (point))
13756 end hiddenp)
13757 (outline-next-heading)
13758 (setq end (point))
13759 (goto-char beg)
13760 (while (re-search-forward re end t))
13761 (setq hiddenp (org-invisible-p))
13762 (end-of-line 1)
13765 (if (member (match-string 1) '("CLOCK:" ":END:"))
13766 ;; just skip this line
13767 (beginning-of-line 2)
13768 ;; Drawer start, find the end
13770 (beginning-of-line 1)))
13771 (org-skip-over-state-notes)
13773 (if (eq (char-before) ?*) (forward-char 1))
13775 (beginning-of-line 0)
13776 (org-indent-to-column indent)
13777 (beginning-of-line 2)
13778 (org-indent-to-column indent)
13779 (beginning-of-line 0)
13780 (if hiddenp
13781 (save-excursion
13782 (org-back-to-heading t)
13783 (hide-entry))
13784 (org-flag-drawer t))))
13786 (defun org-set-property (property value)
13787 "In the current entry, set PROPERTY to VALUE.
13788 When called interactively, this will prompt for a property name, offering
13789 completion on existing and default properties. And then it will prompt
13790 for a value, offering completion either on allowed values (via an inherited
13791 xxx_ALL property) or on existing values in other instances of this property
13792 in the current file."
13793 (interactive
13794 (let* ((completion-ignore-case t)
13795 (keys (org-buffer-property-keys nil t t))
13796 (prop0 (org-icompleting-read "Property: " (mapcar 'list keys)))
13797 (prop (if (member prop0 keys)
13798 prop0
13799 (or (cdr (assoc (downcase prop0)
13800 (mapcar (lambda (x) (cons (downcase x) x))
13801 keys)))
13802 prop0)))
13803 (cur (org-entry-get nil prop))
13804 (prompt (concat prop " value"
13806 (concat " [" cur "]") "") ": "))
13807 (allowed (org-property-get-allowed-values nil prop 'table))
13808 (existing (mapcar 'list (org-property-values prop)))
13809 (val (if allowed
13810 (org-completing-read prompt allowed nil
13811 (not (get-text-property 0 'org-unrestricted
13812 (caar allowed))))
13813 (let (org-completion-use-ido org-completion-use-iswitchb)
13814 (org-completing-read prompt existing nil nil "" nil cur)))))
13815 (list prop (if (equal val "") cur val))))
13816 (unless (equal (org-entry-get nil property) value)
13817 (org-entry-put nil property value)))
13819 (defun org-delete-property (property)
13820 "In the current entry, delete PROPERTY."
13821 (interactive
13822 (let* ((completion-ignore-case t)
13823 (prop (org-icompleting-read "Property: "
13824 (org-entry-properties nil 'standard))))
13825 (list prop)))
13826 (message "Property %s %s" property
13827 (if (org-entry-delete nil property)
13828 "deleted"
13829 "was not present in the entry")))
13831 (defun org-delete-property-globally (property)
13832 "Remove PROPERTY globally, from all entries."
13833 (interactive
13834 (let* ((completion-ignore-case t)
13835 (prop (org-icompleting-read
13836 "Globally remove property: "
13837 (mapcar 'list (org-buffer-property-keys)))))
13838 (list prop)))
13839 (save-excursion
13840 (save-restriction
13841 (widen)
13842 (goto-char (point-min))
13843 (let ((cnt 0))
13844 (while (re-search-forward
13846 nil t)
13847 (setq cnt (1+ cnt))
13848 (replace-match ""))
13851 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
13853 (defun org-compute-property-at-point ()
13854 "Compute the property at point.
13855 This looks for an enclosing column format, extracts the operator and
13856 then applies it to the property in the column format's scope."
13857 (interactive)
13858 (unless (org-at-property-p)
13859 (error "Not at a property"))
13860 (let ((prop (org-match-string-no-properties 2)))
13861 (org-columns-get-format-and-top-level)
13862 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
13863 (error "No operator defined for property %s" prop))
13864 (org-columns-compute prop)))
13866 (defvar org-property-allowed-value-functions nil
13867 "Hook for functions supplying allowed values for a specific property.
13868 The functions must take a single argument, the name of the property, and
13870 the values, this means that these values are intended as defaults for
13871 completion, but that other values should be allowed too.
13872 The functions must return nil if they are not responsible for this
13873 property.")
13875 (defun org-property-get-allowed-values (pom property &optional table)
13876 "Get allowed values for the property PROPERTY.
13877 When TABLE is non-nil, return an alist that can directly be used for
13878 completion."
13879 (let (vals)
13880 (cond
13881 ((equal property "TODO")
13882 (setq vals (org-with-point-at pom
13883 (append org-todo-keywords-1 '("")))))
13884 ((equal property "PRIORITY")
13885 (let ((n org-lowest-priority))
13886 (while (>= n org-highest-priority)
13887 (push (char-to-string n) vals)
13888 (setq n (1- n)))))
13889 ((member property org-special-properties))
13890 ((setq vals (run-hook-with-args-until-success
13891 'org-property-allowed-value-functions property)))
13892 (t
13893 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
13895 (setq vals (car (read-from-string (concat "(" vals ")"))))
13896 (setq vals (mapcar (lambda (x)
13897 (cond ((stringp x) x)
13898 ((numberp x) (number-to-string x))
13899 ((symbolp x) (symbol-name x))
13900 (t "???")))
13901 vals)))))
13902 (when (member ":ETC" vals)
13903 (setq vals (remove ":ETC" vals))
13904 (org-add-props (car vals) '(org-unrestricted t)))
13905 (if table (mapcar 'list vals) vals)))
13907 (defun org-property-previous-allowed-value (&optional previous)
13908 "Switch to the next allowed value for this property."
13909 (interactive)
13910 (org-property-next-allowed-value t))
13912 (defun org-property-next-allowed-value (&optional previous)
13913 "Switch to the next allowed value for this property."
13914 (interactive)
13915 (unless (org-at-property-p)
13916 (error "Not at a property"))
13917 (let* ((key (match-string 2))
13918 (value (match-string 3))
13919 (allowed (or (org-property-get-allowed-values (point) key)
13920 (and (member value '("[ ]" "[-]" "[X]"))
13921 '("[ ]" "[X]"))))
13922 nval)
13923 (unless allowed
13924 (error "Allowed values for this property have not been defined"))
13925 (if previous (setq allowed (reverse allowed)))
13926 (if (member value allowed)
13927 (setq nval (car (cdr (member value allowed)))))
13928 (setq nval (or nval (car allowed)))
13929 (if (equal nval value)
13930 (error "Only one allowed value for this property"))
13931 (org-at-property-p)
13932 (replace-match (concat " :" key ": " nval) t t)
13933 (org-indent-line-function)
13934 (beginning-of-line 1)
13936 (run-hook-with-args 'org-property-changed-functions key nval)))
13938 (defun org-find-olp (path &optional this-buffer)
13939 "Return a marker pointing to the entry at outline path OLP.
13940 If anything goes wrong, throw an error.
13941 You can wrap this call to catch the error like this:
13943 (condition-case msg
13944 (org-mobile-locate-entry (match-string 4))
13945 (error (nth 1 msg)))
13947 The return value will then be either a string with the error message,
13948 or a marker if everything is OK.
13950 If THIS-BUFFER is set, the outline path does not contain a file,
13951 only headings."
13952 (let* ((file (if this-buffer buffer-file-name (pop path)))
13953 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
13954 (level 1)
13955 (lmin 1)
13956 (lmax 1)
13957 limit re end found pos heading cnt)
13958 (unless buffer (error "File not found :%s" file))
13959 (with-current-buffer buffer
13960 (save-excursion
13961 (save-restriction
13962 (widen)
13963 (setq limit (point-max))
13964 (goto-char (point-min))
13965 (while (setq heading (pop path))
13966 (setq re (format org-complex-heading-regexp-format
13967 (regexp-quote heading)))
13968 (setq cnt 0 pos (point))
13969 (while (re-search-forward re end t)
13970 (setq level (- (match-end 1) (match-beginning 1)))
13971 (if (and (>= level lmin) (<= level lmax))
13972 (setq found (match-beginning 0) cnt (1+ cnt))))
13973 (when (= cnt 0) (error "Heading not found on level %d: %s"
13974 lmax heading))
13975 (when (> cnt 1) (error "Heading not unique on level %d: %s"
13976 lmax heading))
13977 (goto-char found)
13978 (setq lmin (1+ level) lmax (+ lmin (if org-odd-levels-only 1 0)))
13979 (setq end (save-excursion (org-end-of-subtree t t))))
13980 (when (org-on-heading-p)
13981 (move-marker (make-marker) (point))))))))
13983 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
13984 "Find node HEADING in BUFFER.
13985 Return a marker to the heading if it was found, or nil if not.
13986 If POS-ONLY is set, return just the position instead of a marker.
13988 The heading text must match exact, but it may have a TODO keyword,
13989 a priority cookie and tags in the standard locations."
13990 (with-current-buffer (or buffer (current-buffer))
13991 (save-excursion
13992 (save-restriction
13993 (widen)
13994 (goto-char (point-min))
13995 (let (case-fold-search)
13996 (if (re-search-forward
13997 (format org-complex-heading-regexp-format
13998 (regexp-quote heading)) nil t)
13999 (if pos-only
14000 (match-beginning 0)
14001 (move-marker (make-marker) (match-beginning 0)))))))))
14003 (defun org-find-exact-heading-in-directory (heading &optional dir)
14004 "Find Org node headline HEADING in all .org files in directory DIR.
14005 When the target headline is found, return a marker to this location."
14006 (let ((files (directory-files (or dir default-directory)
14008 file visiting m buffer)
14009 (catch 'found
14010 (while (setq file (pop files))
14011 (message "trying %s" file)
14012 (setq visiting (org-find-base-buffer-visiting file))
14013 (setq buffer (or visiting (find-file-noselect file)))
14014 (setq m (org-find-exact-headline-in-buffer
14015 heading buffer))
14016 (when (and (not m) (not visiting)) (kill-buffer buffer))
14017 (and m (throw 'found m))))))
14019 (defun org-find-entry-with-id (ident)
14020 "Locate the entry that contains the ID property with exact value IDENT.
14021 IDENT can be a string, a symbol or a number, this function will search for
14022 the string representation of it.
14023 Return the position where this entry starts, or nil if there is no such entry."
14024 (interactive "sID: ")
14025 (let ((id (cond
14026 ((stringp ident) ident)
14027 ((symbol-name ident) (symbol-name ident))
14028 ((numberp ident) (number-to-string ident))
14029 (t (error "IDENT %s must be a string, symbol or number" ident))))
14030 (case-fold-search nil))
14031 (save-excursion
14032 (save-restriction
14033 (widen)
14034 (goto-char (point-min))
14035 (when (re-search-forward
14037 nil t)
14038 (org-back-to-heading t)
14039 (point))))))
14041 ;;;; Timestamps
14043 (defvar org-last-changed-timestamp nil)
14044 (defvar org-last-inserted-timestamp nil
14045 "The last time stamp inserted with `org-insert-time-stamp'.")
14046 (defvar org-time-was-given) ; dynamically scoped parameter
14047 (defvar org-end-time-was-given) ; dynamically scoped parameter
14048 (defvar org-ts-what) ; dynamically scoped parameter
14050 (defun org-time-stamp (arg &optional inactive)
14051 "Prompt for a date/time and insert a time stamp.
14052 If the user specifies a time like HH:MM, or if this command is called
14053 with a prefix argument, the time stamp will contain date and time.
14054 Otherwise, only the date will be included. All parts of a date not
14055 specified by the user will be filled in from the current date/time.
14056 So if you press just return without typing anything, the time stamp
14057 will represent the current date/time. If there is already a timestamp
14058 at the cursor, it will be modified."
14059 (interactive "P")
14060 (let* ((ts nil)
14061 (default-time
14062 ;; Default time is either today, or, when entering a range,
14063 ;; the range start.
14064 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14065 (save-excursion
14066 (re-search-backward
14068 (- (point) 20) t)))
14069 (apply 'encode-time (org-parse-time-string (match-string 1)))
14070 (current-time)))
14071 (default-input (and ts (org-get-compact-tod ts)))
14072 org-time-was-given org-end-time-was-given time)
14073 (cond
14074 ((and (org-at-timestamp-p t)
14075 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14076 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14077 (insert "--")
14078 (setq time (let ((this-command this-command))
14079 (org-read-date arg 'totime nil nil
14080 default-time default-input)))
14081 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14082 ((org-at-timestamp-p t)
14083 (setq time (let ((this-command this-command))
14084 (org-read-date arg 'totime nil nil default-time default-input)))
14085 (when (org-at-timestamp-p t) ; just to get the match data
14086 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14087 (replace-match "")
14088 (setq org-last-changed-timestamp
14089 (org-insert-time-stamp
14090 time (or org-time-was-given arg)
14091 inactive nil nil (list org-end-time-was-given))))
14092 (message "Timestamp updated"))
14093 (t
14094 (setq time (let ((this-command this-command))
14095 (org-read-date arg 'totime nil nil default-time default-input)))
14096 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14097 nil nil (list org-end-time-was-given))))))
14099 ;; FIXME: can we use this for something else, like computing time differences?
14100 (defun org-get-compact-tod (s)
14101 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14102 (let* ((t1 (match-string 1 s))
14103 (h1 (string-to-number (match-string 2 s)))
14104 (m1 (string-to-number (match-string 3 s)))
14105 (t2 (and (match-end 4) (match-string 5 s)))
14106 (h2 (and t2 (string-to-number (match-string 6 s))))
14107 (m2 (and t2 (string-to-number (match-string 7 s))))
14108 dh dm)
14109 (if (not t2)
14110 t1
14111 (setq dh (- h2 h1) dm (- m2 m1))
14112 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14113 (concat t1 "+" (number-to-string dh)
14114 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14116 (defun org-time-stamp-inactive (&optional arg)
14117 "Insert an inactive time stamp.
14118 An inactive time stamp is enclosed in square brackets instead of angle
14119 brackets. It is inactive in the sense that it does not trigger agenda entries,
14120 does not link to the calendar and cannot be changed with the S-cursor keys.
14121 So these are more for recording a certain time/date."
14122 (interactive "P")
14123 (org-time-stamp arg 'inactive))
14125 (defvar org-date-ovl (make-overlay 1 1))
14126 (overlay-put org-date-ovl 'face 'org-warning)
14127 (org-detach-overlay org-date-ovl)
14129 (defvar org-ans1) ; dynamically scoped parameter
14130 (defvar org-ans2) ; dynamically scoped parameter
14132 (defvar org-plain-time-of-day-regexp) ; defined below
14134 (defvar org-overriding-default-time nil) ; dynamically scoped
14135 (defvar org-read-date-overlay nil)
14136 (defvar org-dcst nil) ; dynamically scoped
14137 (defvar org-read-date-history nil)
14138 (defvar org-read-date-final-answer nil)
14140 (defun org-read-date (&optional with-time to-time from-string prompt
14141 default-time default-input)
14142 "Read a date, possibly a time, and make things smooth for the user.
14143 The prompt will suggest to enter an ISO date, but you can also enter anything
14144 which will at least partially be understood by `parse-time-string'.
14145 Unrecognized parts of the date will default to the current day, month, year,
14146 hour and minute. If this command is called to replace a timestamp at point,
14147 of to enter the second timestamp of a range, the default time is taken
14148 from the existing stamp. Furthermore, the command prefers the future,
14149 so if you are giving a date where the year is not given, and the day-month
14150 combination is already past in the current year, it will assume you
14151 mean next year. For details, see the manual. A few examples:
14153 3-2-5 --> 2003-02-05
14154 feb 15 --> currentyear-02-15
14155 2/15 --> currentyear-02-15
14156 sep 12 9 --> 2009-09-12
14157 12:45 --> today 12:45
14158 22 sept 0:34 --> currentyear-09-22 0:34
14159 12 --> currentyear-currentmonth-12
14160 Fri --> nearest Friday (today or later)
14161 etc.
14163 Furthermore you can specify a relative date by giving, as the *first* thing
14164 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14165 change in days weeks, months, years.
14166 With a single plus or minus, the date is relative to today. With a double
14167 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14168 +4d --> four days from today
14169 +4 --> same as above
14170 +2w --> two weeks from today
14171 ++5 --> five days from default date
14173 The function understands only English month and weekday abbreviations,
14174 but this can be configured with the variables `parse-time-months' and
14175 `parse-time-weekdays'.
14177 While prompting, a calendar is popped up - you can also select the
14178 date with the mouse (button 1). The calendar shows a period of three
14179 months. To scroll it to other months, use the keys `>' and `<'.
14180 If you don't like the calendar, turn it off with
14181 \(setq org-read-date-popup-calendar nil)
14183 With optional argument TO-TIME, the date will immediately be converted
14184 to an internal time.
14185 With an optional argument WITH-TIME, the prompt will suggest to also
14186 insert a time. Note that when WITH-TIME is not set, you can still
14187 enter a time, and this function will inform the calling routine about
14188 this change. The calling routine may then choose to change the format
14189 used to insert the time stamp into the buffer to include the time.
14190 With optional argument FROM-STRING, read from this string instead from
14191 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14192 the time/date that is used for everything that is not specified by the
14193 user."
14194 (require 'parse-time)
14195 (let* ((org-time-stamp-rounding-minutes
14196 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14197 (org-dcst org-display-custom-times)
14198 (ct (org-current-time))
14199 (def (or org-overriding-default-time default-time ct))
14200 (defdecode (decode-time def))
14201 (dummy (progn
14202 (when (< (nth 2 defdecode) org-extend-today-until)
14203 (setcar (nthcdr 2 defdecode) -1)
14204 (setcar (nthcdr 1 defdecode) 59)
14205 (setq def (apply 'encode-time defdecode)
14206 defdecode (decode-time def)))))
14207 (calendar-frame-setup nil)
14208 (calendar-setup nil)
14209 (calendar-move-hook nil)
14210 (calendar-view-diary-initially-flag nil)
14211 (calendar-view-holidays-initially-flag nil)
14212 (timestr (format-time-string
14213 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14214 (prompt (concat (if prompt (concat prompt " ") "")
14215 (format "Date+time [%s]: " timestr)))
14216 ans (org-ans0 "") org-ans1 org-ans2 final)
14218 (cond
14219 (from-string (setq ans from-string))
14220 (org-read-date-popup-calendar
14221 (save-excursion
14222 (save-window-excursion
14223 (calendar)
14224 (calendar-forward-day (- (time-to-days def)
14225 (calendar-absolute-from-gregorian
14226 (calendar-current-date))))
14227 (org-eval-in-calendar nil t)
14228 (let* ((old-map (current-local-map))
14229 (map (copy-keymap calendar-mode-map))
14230 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14231 (org-defkey map (kbd "RET") 'org-calendar-select)
14232 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14233 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14234 (org-defkey minibuffer-local-map [(meta shift left)]
14235 (lambda () (interactive)
14236 (org-eval-in-calendar '(calendar-backward-month 1))))
14237 (org-defkey minibuffer-local-map [(meta shift right)]
14238 (lambda () (interactive)
14239 (org-eval-in-calendar '(calendar-forward-month 1))))
14240 (org-defkey minibuffer-local-map [(meta shift up)]
14241 (lambda () (interactive)
14242 (org-eval-in-calendar '(calendar-backward-year 1))))
14243 (org-defkey minibuffer-local-map [(meta shift down)]
14244 (lambda () (interactive)
14245 (org-eval-in-calendar '(calendar-forward-year 1))))
14246 (org-defkey minibuffer-local-map [?\e (shift left)]
14247 (lambda () (interactive)
14248 (org-eval-in-calendar '(calendar-backward-month 1))))
14249 (org-defkey minibuffer-local-map [?\e (shift right)]
14250 (lambda () (interactive)
14251 (org-eval-in-calendar '(calendar-forward-month 1))))
14252 (org-defkey minibuffer-local-map [?\e (shift up)]
14253 (lambda () (interactive)
14254 (org-eval-in-calendar '(calendar-backward-year 1))))
14255 (org-defkey minibuffer-local-map [?\e (shift down)]
14256 (lambda () (interactive)
14257 (org-eval-in-calendar '(calendar-forward-year 1))))
14258 (org-defkey minibuffer-local-map [(shift up)]
14259 (lambda () (interactive)
14260 (org-eval-in-calendar '(calendar-backward-week 1))))
14261 (org-defkey minibuffer-local-map [(shift down)]
14262 (lambda () (interactive)
14263 (org-eval-in-calendar '(calendar-forward-week 1))))
14264 (org-defkey minibuffer-local-map [(shift left)]
14265 (lambda () (interactive)
14266 (org-eval-in-calendar '(calendar-backward-day 1))))
14267 (org-defkey minibuffer-local-map [(shift right)]
14268 (lambda () (interactive)
14269 (org-eval-in-calendar '(calendar-forward-day 1))))
14270 (org-defkey minibuffer-local-map ">"
14271 (lambda () (interactive)
14272 (org-eval-in-calendar '(scroll-calendar-left 1))))
14273 (org-defkey minibuffer-local-map "<"
14274 (lambda () (interactive)
14275 (org-eval-in-calendar '(scroll-calendar-right 1))))
14276 (org-defkey minibuffer-local-map "\C-v"
14277 (lambda () (interactive)
14278 (org-eval-in-calendar
14279 '(calendar-scroll-left-three-months 1))))
14280 (org-defkey minibuffer-local-map "\M-v"
14281 (lambda () (interactive)
14282 (org-eval-in-calendar
14283 '(calendar-scroll-right-three-months 1))))
14284 (run-hooks 'org-read-date-minibuffer-setup-hook)
14285 (unwind-protect
14286 (progn
14287 (use-local-map map)
14288 (add-hook 'post-command-hook 'org-read-date-display)
14289 (setq org-ans0 (read-string prompt default-input
14290 'org-read-date-history nil))
14291 ;; org-ans0: from prompt
14292 ;; org-ans1: from mouse click
14293 ;; org-ans2: from calendar motion
14294 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14295 (remove-hook 'post-command-hook 'org-read-date-display)
14296 (use-local-map old-map)
14297 (when org-read-date-overlay
14298 (delete-overlay org-read-date-overlay)
14299 (setq org-read-date-overlay nil)))))))
14301 (t ; Naked prompt only
14302 (unwind-protect
14303 (setq ans (read-string prompt default-input
14304 'org-read-date-history timestr))
14305 (when org-read-date-overlay
14306 (delete-overlay org-read-date-overlay)
14307 (setq org-read-date-overlay nil)))))
14309 (setq final (org-read-date-analyze ans def defdecode))
14311 ;; One round trip to get rid of 34th of August and stuff like that....
14312 (setq final (decode-time (apply 'encode-time final)))
14314 (setq org-read-date-final-answer ans)
14316 (if to-time
14317 (apply 'encode-time final)
14318 (if (and (boundp 'org-time-was-given) org-time-was-given)
14319 (format "%04d-%02d-%02d %02d:%02d"
14320 (nth 5 final) (nth 4 final) (nth 3 final)
14321 (nth 2 final) (nth 1 final))
14322 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14324 (defvar def)
14325 (defvar defdecode)
14326 (defvar with-time)
14327 (defvar org-read-date-analyze-futurep nil)
14328 (defun org-read-date-display ()
14329 "Display the current date prompt interpretation in the minibuffer."
14330 (when org-read-date-display-live
14331 (when org-read-date-overlay
14332 (delete-overlay org-read-date-overlay))
14333 (let ((p (point)))
14334 (end-of-line 1)
14335 (while (not (equal (buffer-substring
14336 (max (point-min) (- (point) 4)) (point))
14337 " "))
14338 (insert " "))
14339 (goto-char p))
14340 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14341 " " (or org-ans1 org-ans2)))
14342 (org-end-time-was-given nil)
14343 (f (org-read-date-analyze ans def defdecode))
14344 (fmts (if org-dcst
14345 org-time-stamp-custom-formats
14346 org-time-stamp-formats))
14347 (fmt (if (or with-time
14348 (and (boundp 'org-time-was-given) org-time-was-given))
14349 (cdr fmts)
14350 (car fmts)))
14351 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14352 (when (and org-end-time-was-given
14353 (string-match org-plain-time-of-day-regexp txt))
14354 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14355 org-end-time-was-given
14356 (substring txt (match-end 0)))))
14357 (when org-read-date-analyze-futurep
14358 (setq txt (concat txt " (=>F)")))
14359 (setq org-read-date-overlay
14360 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14361 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14363 (defun org-read-date-analyze (ans def defdecode)
14364 "Analyze the combined answer of the date prompt."
14365 ;; FIXME: cleanup and comment
14366 (let ((nowdecode (decode-time (current-time)))
14367 delta deltan deltaw deltadef year month day
14368 hour minute second wday pm h2 m2 tl wday1
14369 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14370 (setq org-read-date-analyze-futurep nil)
14372 (setq ans "+0"))
14374 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14375 (setq ans (replace-match "" t t ans)
14376 deltan (car delta)
14377 deltaw (nth 1 delta)
14378 deltadef (nth 2 delta)))
14380 ;; Check if there is an iso week date in there
14381 ;; If yes, store the info and postpone interpreting it until the rest
14382 ;; of the parsing is done
14383 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14384 (setq iso-year (if (match-end 1)
14385 (org-small-year-to-year
14386 (string-to-number (match-string 1 ans))))
14387 iso-weekday (if (match-end 3)
14388 (string-to-number (match-string 3 ans)))
14389 iso-week (string-to-number (match-string 2 ans)))
14390 (setq ans (replace-match "" t t ans)))
14392 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14393 (when (string-match
14395 (setq year (if (match-end 2)
14396 (string-to-number (match-string 2 ans))
14397 (progn (setq kill-year t)
14398 (string-to-number (format-time-string "%Y"))))
14399 month (string-to-number (match-string 3 ans))
14400 day (string-to-number (match-string 4 ans)))
14401 (if (< year 100) (setq year (+ 2000 year)))
14403 t nil ans)))
14404 ;; Help matching american dates, like 5/30 or 5/30/7
14405 (when (string-match
14406 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14407 (setq year (if (match-end 4)
14408 (string-to-number (match-string 4 ans))
14409 (progn (setq kill-year t)
14410 (string-to-number (format-time-string "%Y"))))
14411 month (string-to-number (match-string 1 ans))
14412 day (string-to-number (match-string 2 ans)))
14413 (if (< year 100) (setq year (+ 2000 year)))
14415 t nil ans)))
14416 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14417 ;; If there is a time with am/pm, and *no* time without it, we convert
14418 ;; so that matching will be successful.
14419 (loop for i from 1 to 2 do ; twice, for end time as well
14422 (setq hour (string-to-number (match-string 1 ans))
14423 minute (if (match-end 3)
14424 (string-to-number (match-string 3 ans))
14425 0)
14426 pm (equal ?p
14427 (string-to-char (downcase (match-string 4 ans)))))
14428 (if (and (= hour 12) (not pm))
14429 (setq hour 0)
14430 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14431 (setq ans (replace-match (format "%02d:%02d" hour minute)
14432 t t ans))))
14434 ;; Check if a time range is given as a duration
14435 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14436 (setq hour (string-to-number (match-string 1 ans))
14437 h2 (+ hour (string-to-number (match-string 3 ans)))
14438 minute (string-to-number (match-string 2 ans))
14439 m2 (+ minute (if (match-end 5) (string-to-number
14440 (match-string 5 ans))0)))
14441 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14442 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14443 t t ans)))
14445 ;; Check if there is a time range
14446 (when (boundp 'org-end-time-was-given)
14447 (setq org-time-was-given nil)
14448 (when (and (string-match org-plain-time-of-day-regexp ans)
14449 (match-end 8))
14450 (setq org-end-time-was-given (match-string 8 ans))
14451 (setq ans (concat (substring ans 0 (match-beginning 7))
14452 (substring ans (match-end 7))))))
14454 (setq tl (parse-time-string ans)
14455 day (or (nth 3 tl) (nth 3 defdecode))
14456 month (or (nth 4 tl)
14457 (if (and org-read-date-prefer-future
14458 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14459 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14460 (nth 4 defdecode)))
14461 year (or (and (not kill-year) (nth 5 tl))
14462 (if (and org-read-date-prefer-future
14463 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14464 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14465 (nth 5 defdecode)))
14466 hour (or (nth 2 tl) (nth 2 defdecode))
14467 minute (or (nth 1 tl) (nth 1 defdecode))
14468 second (or (nth 0 tl) 0)
14469 wday (nth 6 tl))
14471 (when (and (eq org-read-date-prefer-future 'time)
14472 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14473 (equal day (nth 3 nowdecode))
14474 (equal month (nth 4 nowdecode))
14475 (equal year (nth 5 nowdecode))
14476 (nth 2 tl)
14477 (or (< (nth 2 tl) (nth 2 nowdecode))
14478 (and (= (nth 2 tl) (nth 2 nowdecode))
14479 (nth 1 tl)
14480 (< (nth 1 tl) (nth 1 nowdecode)))))
14481 (setq day (1+ day)
14482 futurep t))
14484 ;; Special date definitions below
14485 (cond
14486 (iso-week
14487 ;; There was an iso week
14488 (require 'cal-iso)
14489 (setq futurep nil)
14490 (setq year (or iso-year year)
14491 day (or iso-weekday wday 1)
14492 wday nil ; to make sure that the trigger below does not match
14493 iso-date (calendar-gregorian-from-absolute
14494 (calendar-absolute-from-iso
14495 (list iso-week day year))))
14496 ; FIXME: Should we also push ISO weeks into the future?
14497 ; (when (and org-read-date-prefer-future
14498 ; (not iso-year)
14499 ; (< (calendar-absolute-from-gregorian iso-date)
14500 ; (time-to-days (current-time))))
14501 ; (setq year (1+ year)
14502 ; iso-date (calendar-gregorian-from-absolute
14503 ; (calendar-absolute-from-iso
14504 ; (list iso-week day year)))))
14505 (setq month (car iso-date)
14506 year (nth 2 iso-date)
14507 day (nth 1 iso-date)))
14508 (deltan
14509 (setq futurep nil)
14510 (unless deltadef
14511 (let ((now (decode-time (current-time))))
14512 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14513 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14514 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14515 ((equal deltaw "m") (setq month (+ month deltan)))
14516 ((equal deltaw "y") (setq year (+ year deltan)))))
14517 ((and wday (not (nth 3 tl)))
14518 (setq futurep nil)
14519 ;; Weekday was given, but no day, so pick that day in the week
14520 ;; on or after the derived date.
14521 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14522 (unless (equal wday wday1)
14523 (setq day (+ day (% (- wday wday1 -7) 7))))))
14524 (if (and (boundp 'org-time-was-given)
14525 (nth 2 tl))
14526 (setq org-time-was-given t))
14527 (if (< year 100) (setq year (+ 2000 year)))
14528 (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
14529 (setq org-read-date-analyze-futurep futurep)
14530 (list second minute hour day month year)))
14532 (defvar parse-time-weekdays)
14534 (defun org-read-date-get-relative (s today default)
14535 "Check string S for special relative date string.
14536 TODAY and DEFAULT are internal times, for today and for a default.
14537 Return shift list (N what def-flag)
14539 N is the number of WHATs to shift.
14540 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14541 the DEFAULT date rather than TODAY."
14542 (when (and
14543 (string-match
14544 (concat
14549 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14550 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14551 (string-to-char (substring (match-string 1 s) -1))
14552 ?+))
14553 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14554 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14555 (what (if (match-end 3) (match-string 3 s) "d"))
14556 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14557 (date (if rel default today))
14558 (wday (nth 6 (decode-time date)))
14559 delta)
14560 (if wday1
14561 (progn
14562 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14563 (if (= dir ?-) (setq delta (- delta 7)))
14564 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14565 (list delta "d" rel))
14566 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14568 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14569 "Turn a user-specified date into the internal representation.
14570 The internal representation needed by the calendar is (month day year).
14571 This is a wrapper to handle the brain-dead convention in calendar that
14572 user function argument order change dependent on argument order."
14573 (if (boundp 'calendar-date-style)
14574 (cond
14575 ((eq calendar-date-style 'american)
14576 (list arg1 arg2 arg3))
14577 ((eq calendar-date-style 'european)
14578 (list arg2 arg1 arg3))
14579 ((eq calendar-date-style 'iso)
14580 (list arg2 arg3 arg1)))
14581 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
14582 (if (org-bound-and-true-p european-calendar-style)
14583 (list arg2 arg1 arg3)
14584 (list arg1 arg2 arg3)))))
14586 (defun org-eval-in-calendar (form &optional keepdate)
14587 "Eval FORM in the calendar window and return to current window.
14588 Also, store the cursor date in variable org-ans2."
14589 (let ((sf (selected-frame))
14590 (sw (selected-window)))
14591 (select-window (get-buffer-window "*Calendar*" t))
14592 (eval form)
14593 (when (and (not keepdate) (calendar-cursor-to-date))
14594 (let* ((date (calendar-cursor-to-date))
14595 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14596 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
14597 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
14598 (select-window sw)
14599 (org-select-frame-set-input-focus sf)))
14601 (defun org-calendar-select ()
14602 "Return to `org-read-date' with the date currently selected.
14603 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14604 (interactive)
14605 (when (calendar-cursor-to-date)
14606 (let* ((date (calendar-cursor-to-date))
14607 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14608 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14609 (if (active-minibuffer-window) (exit-minibuffer))))
14611 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
14612 "Insert a date stamp for the date given by the internal TIME.
14613 WITH-HM means use the stamp format that includes the time of the day.
14614 INACTIVE means use square brackets instead of angular ones, so that the
14615 stamp will not contribute to the agenda.
14616 PRE and POST are optional strings to be inserted before and after the
14617 stamp.
14618 The command returns the inserted time stamp."
14619 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
14620 stamp)
14621 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
14622 (insert-before-markers (or pre ""))
14623 (when (listp extra)
14624 (setq extra (car extra))
14625 (if (and (stringp extra)
14627 (setq extra (format "-%02d:%02d"
14628 (string-to-number (match-string 1 extra))
14629 (string-to-number (match-string 2 extra))))
14630 (setq extra nil)))
14631 (when extra
14632 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
14633 (insert-before-markers (setq stamp (format-time-string fmt time)))
14634 (insert-before-markers (or post ""))
14635 (setq org-last-inserted-timestamp stamp)))
14637 (defun org-toggle-time-stamp-overlays ()
14638 "Toggle the use of custom time stamp formats."
14639 (interactive)
14640 (setq org-display-custom-times (not org-display-custom-times))
14641 (unless org-display-custom-times
14642 (let ((p (point-min)) (bmp (buffer-modified-p)))
14643 (while (setq p (next-single-property-change p 'display))
14644 (if (and (get-text-property p 'display)
14645 (eq (get-text-property p 'face) 'org-date))
14646 (remove-text-properties
14647 p (setq p (next-single-property-change p 'display))
14648 '(display t))))
14649 (set-buffer-modified-p bmp)))
14650 (if (featurep 'xemacs)
14651 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
14652 (org-restart-font-lock)
14653 (setq org-table-may-need-update t)
14654 (if org-display-custom-times
14655 (message "Time stamps are overlayed with custom format")
14656 (message "Time stamp overlays removed")))
14658 (defun org-display-custom-time (beg end)
14659 "Overlay modified time stamp format over timestamp between BEG and END."
14660 (let* ((ts (buffer-substring beg end))
14661 t1 w1 with-hm tf time str w2 (off 0))
14662 (save-match-data
14663 (setq t1 (org-parse-time-string ts t))
14664 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
14665 (setq off (- (match-end 0) (match-beginning 0)))))
14666 (setq end (- end off))
14667 (setq w1 (- end beg)
14668 with-hm (and (nth 1 t1) (nth 2 t1))
14669 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
14670 time (org-fix-decoded-time t1)
14671 str (org-add-props
14672 (format-time-string
14673 (substring tf 1 -1) (apply 'encode-time time))
14674 nil 'mouse-face 'highlight)
14675 w2 (length str))
14676 (if (not (= w2 w1))
14677 (add-text-properties (1+ beg) (+ 2 beg)
14678 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
14679 (if (featurep 'xemacs)
14680 (progn
14681 (put-text-property beg end 'invisible t)
14682 (put-text-property beg end 'end-glyph (make-glyph str)))
14683 (put-text-property beg end 'display str))))
14685 (defun org-translate-time (string)
14686 "Translate all timestamps in STRING to custom format.
14687 But do this only if the variable `org-display-custom-times' is set."
14688 (when org-display-custom-times
14689 (save-match-data
14690 (let* ((start 0)
14691 (re org-ts-regexp-both)
14692 t1 with-hm inactive tf time str beg end)
14693 (while (setq start (string-match re string start))
14694 (setq beg (match-beginning 0)
14695 end (match-end 0)
14696 t1 (save-match-data
14697 (org-parse-time-string (substring string beg end) t))
14698 with-hm (and (nth 1 t1) (nth 2 t1))
14699 inactive (equal (substring string beg (1+ beg)) "[")
14700 tf (funcall (if with-hm 'cdr 'car)
14701 org-time-stamp-custom-formats)
14702 time (org-fix-decoded-time t1)
14703 str (format-time-string
14704 (concat
14705 (if inactive "[" "<") (substring tf 1 -1)
14706 (if inactive "]" ">"))
14707 (apply 'encode-time time))
14708 string (replace-match str t t string)
14709 start (+ start (length str)))))))
14710 string)
14712 (defun org-fix-decoded-time (time)
14713 "Set 0 instead of nil for the first 6 elements of time.
14714 Don't touch the rest."
14715 (let ((n 0))
14716 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
14718 (defun org-days-to-time (timestamp-string)
14719 "Difference between TIMESTAMP-STRING and now in days."
14720 (- (time-to-days (org-time-string-to-time timestamp-string))
14721 (time-to-days (current-time))))
14723 (defun org-deadline-close (timestamp-string &optional ndays)
14724 "Is the time in TIMESTAMP-STRING close to the current date?"
14725 (setq ndays (or ndays (org-get-wdays timestamp-string)))
14726 (and (< (org-days-to-time timestamp-string) ndays)
14727 (not (org-entry-is-done-p))))
14729 (defun org-get-wdays (ts)
14730 "Get the deadline lead time appropriate for timestring TS."
14731 (cond
14732 ((<= org-deadline-warning-days 0)
14733 ;; 0 or negative, enforce this value no matter what
14734 (- org-deadline-warning-days))
14736 ;; lead time is specified.
14737 (floor (* (string-to-number (match-string 1 ts))
14738 (cdr (assoc (match-string 2 ts)
14739 '(("d" . 1) ("w" . 7)
14740 ("m" . 30.4) ("y" . 365.25)))))))
14741 ;; go for the default.
14742 (t org-deadline-warning-days)))
14744 (defun org-calendar-select-mouse (ev)
14745 "Return to `org-read-date' with the date currently selected.
14746 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14747 (interactive "e")
14748 (mouse-set-point ev)
14749 (when (calendar-cursor-to-date)
14750 (let* ((date (calendar-cursor-to-date))
14751 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14752 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14753 (if (active-minibuffer-window) (exit-minibuffer))))
14755 (defun org-check-deadlines (ndays)
14756 "Check if there are any deadlines due or past due.
14757 A deadline is considered due if it happens within `org-deadline-warning-days'
14758 days from today's date. If the deadline appears in an entry marked DONE,
14759 it is not shown. The prefix arg NDAYS can be used to test that many
14761 (interactive "P")
14762 (let* ((org-warn-days
14763 (cond
14764 ((equal ndays '(4)) 100000)
14765 (ndays (prefix-numeric-value ndays))
14766 (t (abs org-deadline-warning-days))))
14767 (case-fold-search nil)
14769 (callback
14770 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
14772 (message "%d deadlines past-due or due within %d days"
14773 (org-occur regexp nil callback)
14774 org-warn-days)))
14776 (defun org-check-before-date (date)
14777 "Check if there are deadlines or scheduled entries before DATE."
14778 (interactive (list (org-read-date)))
14779 (let ((case-fold-search nil)
14783 (callback
14784 (lambda () (time-less-p
14785 (org-time-string-to-time (match-string 2))
14786 (org-time-string-to-time date)))))
14787 (message "%d entries before %s"
14788 (org-occur regexp nil callback) date)))
14790 (defun org-check-after-date (date)
14791 "Check if there are deadlines or scheduled entries after DATE."
14792 (interactive (list (org-read-date)))
14793 (let ((case-fold-search nil)
14797 (callback
14798 (lambda () (not
14799 (time-less-p
14800 (org-time-string-to-time (match-string 2))
14801 (org-time-string-to-time date))))))
14802 (message "%d entries after %s"
14803 (org-occur regexp nil callback) date)))
14805 (defun org-evaluate-time-range (&optional to-buffer)
14806 "Evaluate a time range by computing the difference between start and end.
14807 Normally the result is just printed in the echo area, but with prefix arg
14808 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
14809 If the time range is actually in a table, the result is inserted into the
14810 next column.
14811 For time difference computation, a year is assumed to be exactly 365
14812 days in order to avoid rounding problems."
14813 (interactive "P")
14814 (or
14815 (org-clock-update-time-maybe)
14816 (save-excursion
14817 (unless (org-at-date-range-p t)
14818 (goto-char (point-at-bol))
14819 (re-search-forward org-tr-regexp-both (point-at-eol) t))
14820 (if (not (org-at-date-range-p t))
14821 (error "Not at a time-stamp range, and none found in current line")))
14822 (let* ((ts1 (match-string 1))
14823 (ts2 (match-string 2))
14824 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
14825 (match-end (match-end 0))
14826 (time1 (org-time-string-to-time ts1))
14827 (time2 (org-time-string-to-time ts2))
14828 (t1 (org-float-time time1))
14829 (t2 (org-float-time time2))
14830 (diff (abs (- t2 t1)))
14831 (negative (< (- t2 t1) 0))
14832 ;; (ys (floor (* 365 24 60 60)))
14833 (ds (* 24 60 60))
14834 (hs (* 60 60))
14835 (fy "%dy %dd %02d:%02d")
14836 (fy1 "%dy %dd")
14837 (fd "%dd %02d:%02d")
14838 (fd1 "%dd")
14839 (fh "%02d:%02d")
14840 y d h m align)
14841 (if havetime
14842 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14843 y 0
14844 d (floor (/ diff ds)) diff (mod diff ds)
14845 h (floor (/ diff hs)) diff (mod diff hs)
14846 m (floor (/ diff 60)))
14847 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14848 y 0
14849 d (floor (+ (/ diff ds) 0.5))
14850 h 0 m 0))
14851 (if (not to-buffer)
14852 (message "%s" (org-make-tdiff-string y d h m))
14853 (if (org-at-table-p)
14854 (progn
14855 (goto-char match-end)
14856 (setq align t)
14857 (and (looking-at " *|") (goto-char (match-end 0))))
14858 (goto-char match-end))
14859 (if (looking-at
14861 (replace-match ""))
14862 (if negative (insert " -"))
14863 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
14864 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
14865 (insert " " (format fh h m))))
14866 (if align (org-table-align))
14867 (message "Time difference inserted")))))
14869 (defun org-make-tdiff-string (y d h m)
14870 (let ((fmt "")
14871 (l nil))
14872 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
14873 l (push y l)))
14874 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
14875 l (push d l)))
14876 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
14877 l (push h l)))
14878 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
14879 l (push m l)))
14880 (apply 'format fmt (nreverse l))))
14882 (defun org-time-string-to-time (s)
14883 (apply 'encode-time (org-parse-time-string s)))
14884 (defun org-time-string-to-seconds (s)
14885 (org-float-time (org-time-string-to-time s)))
14887 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
14888 "Convert a time stamp to an absolute day number.
14889 If there is a specifier for a cyclic time stamp, get the closest date to
14890 DAYNR.
14891 PREFER and SHOW-ALL are passed through to `org-closest-date'.
14892 the variable date is bound by the calendar when this is called."
14893 (cond
14895 (if (org-diary-sexp-entry (match-string 1 s) "" date)
14896 daynr
14897 (+ daynr 1000)))
14899 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
14900 (time-to-days (current-time))) (match-string 0 s)
14901 prefer show-all))
14902 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
14904 (defun org-days-to-iso-week (days)
14905 "Return the iso week number."
14906 (require 'cal-iso)
14907 (car (calendar-iso-from-absolute days)))
14909 (defun org-small-year-to-year (year)
14910 "Convert 2-digit years into 4-digit years.
14911 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
14912 The year 2000 cannot be abbreviated. Any year larger than 99
14913 is returned unchanged."
14914 (if (< year 38)
14915 (setq year (+ 2000 year))
14916 (if (< year 100)
14917 (setq year (+ 1900 year))))
14918 year)
14920 (defun org-time-from-absolute (d)
14921 "Return the time corresponding to date D.
14922 D may be an absolute day number, or a calendar-type list (month day year)."
14923 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
14924 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
14926 (defun org-calendar-holiday ()
14927 "List of holidays, for Diary display in Org-mode."
14928 (require 'holidays)
14929 (let ((hl (funcall
14930 (if (fboundp 'calendar-check-holidays)
14931 'calendar-check-holidays 'check-calendar-holidays) date)))
14932 (if hl (mapconcat 'identity hl "; "))))
14934 (defun org-diary-sexp-entry (sexp entry date)
14935 "Process a SEXP diary ENTRY for DATE."
14936 (require 'diary-lib)
14937 (let ((result (if calendar-debug-sexp
14938 (let ((stack-trace-on-error t))
14939 (eval (car (read-from-string sexp))))
14940 (condition-case nil
14941 (eval (car (read-from-string sexp)))
14942 (error
14943 (beep)
14944 (message "Bad sexp at line %d in %s: %s"
14945 (org-current-line)
14946 (buffer-file-name) sexp)
14947 (sleep-for 2))))))
14948 (cond ((stringp result) (split-string result "; "))
14949 ((and (consp result)
14950 (not (consp (cdr result)))
14951 (stringp (cdr result))) (cdr result))
14952 ((and (consp result)
14953 (stringp (car result))) result)
14954 (result entry)
14955 (t nil))))
14957 (defun org-diary-to-ical-string (frombuf)
14958 "Get iCalendar entries from diary entries in buffer FROMBUF.
14959 This uses the icalendar.el library."
14960 (let* ((tmpdir (if (featurep 'xemacs)
14961 (temp-directory)
14962 temporary-file-directory))
14963 (tmpfile (make-temp-name
14964 (expand-file-name "orgics" tmpdir)))
14965 buf rtn b e)
14966 (with-current-buffer frombuf
14967 (icalendar-export-region (point-min) (point-max) tmpfile)
14968 (setq buf (find-buffer-visiting tmpfile))
14969 (set-buffer buf)
14970 (goto-char (point-min))
14971 (if (re-search-forward "^BEGIN:VEVENT" nil t)
14972 (setq b (match-beginning 0)))
14973 (goto-char (point-max))
14974 (if (re-search-backward "^END:VEVENT" nil t)
14975 (setq e (match-end 0)))
14977 (kill-buffer buf)
14978 (delete-file tmpfile)
14979 rtn))
14981 (defun org-closest-date (start current change prefer show-all)
14982 "Find the date closest to CURRENT that is consistent with START and CHANGE.
14983 When PREFER is `past' return a date that is either CURRENT or past.
14984 When PREFER is `future', return a date that is either CURRENT or future.
14985 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
14986 ;; Make the proper lists from the dates
14987 (catch 'exit
14988 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
14989 dn dw sday cday n1 n2 n0
14990 d m y y1 y2 date1 date2 nmonths nm ny m2)
14992 (setq start (org-date-to-gregorian start)
14993 current (org-date-to-gregorian
14994 (if show-all
14995 current
14996 (time-to-days (current-time))))
14997 sday (calendar-absolute-from-gregorian start)
14998 cday (calendar-absolute-from-gregorian current))
15000 (if (<= cday sday) (throw 'exit sday))
15003 (setq dn (string-to-number (match-string 1 change))
15004 dw (cdr (assoc (match-string 2 change) a1)))
15005 (error "Invalid change specifier: %s" change))
15006 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15007 (cond
15008 ((eq dw 'day)
15009 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15010 n2 (+ n1 dn)))
15011 ((eq dw 'year)
15012 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15013 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15014 (setq date1 (list m d y1)
15015 n1 (calendar-absolute-from-gregorian date1)
15016 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15017 n2 (calendar-absolute-from-gregorian date2)))
15018 ((eq dw 'month)
15019 ;; approx number of month between the two dates
15020 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15021 ;; How often does dn fit in there?
15022 (setq d (nth 1 start) m (car start) y (nth 2 start)
15023 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15024 m (+ m nm)
15025 ny (floor (/ m 12))
15026 y (+ y ny)
15027 m (- m (* ny 12)))
15028 (while (> m 12) (setq m (- m 12) y (1+ y)))
15029 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15030 (setq m2 (+ m dn) y2 y)
15031 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15032 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15033 (while (<= n2 cday)
15034 (setq n1 n2 m m2 y y2)
15035 (setq m2 (+ m dn) y2 y)
15036 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15037 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15038 ;; Make sure n1 is the earlier date
15039 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15040 (if show-all
15041 (cond
15042 ((eq prefer 'past) (if (= cday n2) n2 n1))
15043 ((eq prefer 'future) (if (= cday n1) n1 n2))
15044 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15045 (cond
15046 ((eq prefer 'past) (if (= cday n2) n2 n1))
15047 ((eq prefer 'future) (if (= cday n1) n1 n2))
15048 (t (if (= cday n1) n1 n2)))))))
15050 (defun org-date-to-gregorian (date)
15051 "Turn any specification of DATE into a Gregorian date for the calendar."
15052 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15053 ((and (listp date) (= (length date) 3)) date)
15054 ((stringp date)
15055 (setq date (org-parse-time-string date))
15056 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15057 ((listp date)
15058 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15060 (defun org-parse-time-string (s &optional nodefault)
15061 "Parse the standard Org-mode time string.
15062 This should be a lot faster than the normal `parse-time-string'.
15063 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15064 hour and minute fields will be nil if not given."
15065 (if (string-match org-ts-regexp0 s)
15066 (list 0
15067 (if (or (match-beginning 8) (not nodefault))
15068 (string-to-number (or (match-string 8 s) "0")))
15069 (if (or (match-beginning 7) (not nodefault))
15070 (string-to-number (or (match-string 7 s) "0")))
15071 (string-to-number (match-string 4 s))
15072 (string-to-number (match-string 3 s))
15073 (string-to-number (match-string 2 s))
15074 nil nil nil)
15075 (error "Not a standard Org-mode time string: %s" s)))
15077 (defun org-timestamp-up (&optional arg)
15078 "Increase the date item at the cursor by one.
15079 If the cursor is on the year, change the year. If it is on the month or
15080 the day, change that.
15081 With prefix ARG, change by that many units."
15082 (interactive "p")
15083 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15085 (defun org-timestamp-down (&optional arg)
15086 "Decrease the date item at the cursor by one.
15087 If the cursor is on the year, change the year. If it is on the month or
15088 the day, change that.
15089 With prefix ARG, change by that many units."
15090 (interactive "p")
15091 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15093 (defun org-timestamp-up-day (&optional arg)
15094 "Increase the date in the time stamp by one day.
15095 With prefix ARG, change that many days."
15096 (interactive "p")
15097 (if (and (not (org-at-timestamp-p t))
15098 (org-on-heading-p))
15099 (org-todo 'up)
15100 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15102 (defun org-timestamp-down-day (&optional arg)
15103 "Decrease the date in the time stamp by one day.
15104 With prefix ARG, change that many days."
15105 (interactive "p")
15106 (if (and (not (org-at-timestamp-p t))
15107 (org-on-heading-p))
15108 (org-todo 'down)
15109 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15111 (defun org-at-timestamp-p (&optional inactive-ok)
15112 "Determine if the cursor is in or at a timestamp."
15113 (interactive)
15114 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15115 (pos (point))
15116 (ans (or (looking-at tsr)
15117 (save-excursion
15119 (if (> (point) (point-min)) (backward-char 1))
15120 (and (looking-at tsr)
15121 (> (- (match-end 0) pos) -1))))))
15122 (and ans
15123 (boundp 'org-ts-what)
15124 (setq org-ts-what
15125 (cond
15126 ((= pos (match-beginning 0)) 'bracket)
15127 ((= pos (1- (match-end 0))) 'bracket)
15128 ((org-pos-in-match-range pos 2) 'year)
15129 ((org-pos-in-match-range pos 3) 'month)
15130 ((org-pos-in-match-range pos 7) 'hour)
15131 ((org-pos-in-match-range pos 8) 'minute)
15132 ((or (org-pos-in-match-range pos 4)
15133 (org-pos-in-match-range pos 5)) 'day)
15134 ((and (> pos (or (match-end 8) (match-end 5)))
15135 (< pos (match-end 0)))
15136 (- pos (or (match-end 8) (match-end 5))))
15137 (t 'day))))
15138 ans))
15140 (defun org-toggle-timestamp-type ()
15141 "Toggle the type (<active> or [inactive]) of a time stamp."
15142 (interactive)
15143 (when (org-at-timestamp-p t)
15144 (let ((beg (match-beginning 0)) (end (match-end 0))
15145 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15146 (save-excursion
15147 (goto-char beg)
15148 (while (re-search-forward "[][<>]" end t)
15149 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15150 t t)))
15151 (message "Timestamp is now %sactive"
15152 (if (equal (char-after beg) ?<) "" "in")))))
15154 (defun org-timestamp-change (n &optional what updown)
15155 "Change the date in the time stamp at point.
15156 The date will be changed by N times WHAT. WHAT can be `day', `month',
15157 `year', `minute', `second'. If WHAT is not given, the cursor position
15158 in the timestamp determines what will be changed."
15159 (let ((pos (point))
15160 with-hm inactive
15161 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15162 org-ts-what
15163 extra rem
15164 ts time time0)
15165 (if (not (org-at-timestamp-p t))
15166 (error "Not at a timestamp"))
15167 (if (and (not what) (eq org-ts-what 'bracket))
15168 (org-toggle-timestamp-type)
15169 (if (and (not what) (not (eq org-ts-what 'day))
15170 org-display-custom-times
15171 (get-text-property (point) 'display)
15172 (not (get-text-property (1- (point)) 'display)))
15173 (setq org-ts-what 'day))
15174 (setq org-ts-what (or what org-ts-what)
15175 inactive (= (char-after (match-beginning 0)) ?\[)
15176 ts (match-string 0))
15177 (replace-match "")
15178 (if (string-match
15180 ts)
15181 (setq extra (match-string 1 ts)))
15183 (setq with-hm t))
15184 (setq time0 (org-parse-time-string ts))
15185 (when (and updown
15186 (eq org-ts-what 'minute)
15187 (not current-prefix-arg))
15188 ;; This looks like s-up and s-down. Change by one rounding step.
15189 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15190 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15191 (setcar (cdr time0) (+ (nth 1 time0)
15192 (if (> n 0) (- rem) (- dm rem))))))
15193 (setq time
15194 (encode-time (or (car time0) 0)
15195 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15196 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15197 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15198 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15199 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15200 (nthcdr 6 time0)))
15201 (when (and (member org-ts-what '(hour minute))
15202 extra
15204 (setq extra (org-modify-ts-extra
15205 extra
15206 (if (eq org-ts-what 'hour) 2 5)
15207 n dm)))
15208 (when (integerp org-ts-what)
15209 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15210 (if (eq what 'calendar)
15211 (let ((cal-date (org-get-date-from-calendar)))
15212 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15213 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15214 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15215 (setcar time0 (or (car time0) 0))
15216 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15217 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15218 (setq time (apply 'encode-time time0))))
15219 (setq org-last-changed-timestamp
15220 (org-insert-time-stamp time with-hm inactive nil nil extra))
15221 (org-clock-update-time-maybe)
15222 (goto-char pos)
15223 ;; Try to recenter the calendar window, if any
15224 (if (and org-calendar-follow-timestamp-change
15225 (get-buffer-window "*Calendar*" t)
15226 (memq org-ts-what '(day month year)))
15227 (org-recenter-calendar (time-to-days time))))))
15229 (defun org-modify-ts-extra (s pos n dm)
15230 "Change the different parts of the lead-time and repeat fields in timestamp."
15231 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15232 ng h m new rem)
15233 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15234 (cond
15235 ((or (org-pos-in-match-range pos 2)
15236 (org-pos-in-match-range pos 3))
15237 (setq m (string-to-number (match-string 3 s))
15238 h (string-to-number (match-string 2 s)))
15239 (if (org-pos-in-match-range pos 2)
15240 (setq h (+ h n))
15241 (setq n (* dm (org-no-warnings (signum n))))
15242 (when (not (= 0 (setq rem (% m dm))))
15243 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15244 (setq m (+ m n)))
15245 (if (< m 0) (setq m (+ m 60) h (1- h)))
15246 (if (> m 59) (setq m (- m 60) h (1+ h)))
15247 (setq h (min 24 (max 0 h)))
15248 (setq ng 1 new (format "-%02d:%02d" h m)))
15249 ((org-pos-in-match-range pos 6)
15250 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15251 ((org-pos-in-match-range pos 5)
15252 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15254 ((org-pos-in-match-range pos 9)
15255 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15256 ((org-pos-in-match-range pos 8)
15257 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15259 (when ng
15260 (setq s (concat
15261 (substring s 0 (match-beginning ng))
15262 new
15263 (substring s (match-end ng))))))
15264 s))
15266 (defun org-recenter-calendar (date)
15267 "If the calendar is visible, recenter it to DATE."
15268 (let* ((win (selected-window))
15269 (cwin (get-buffer-window "*Calendar*" t))
15270 (calendar-move-hook nil))
15271 (when cwin
15272 (select-window cwin)
15273 (calendar-goto-date (if (listp date) date
15274 (calendar-gregorian-from-absolute date)))
15275 (select-window win))))
15277 (defun org-goto-calendar (&optional arg)
15278 "Go to the Emacs calendar at the current date.
15279 If there is a time stamp in the current line, go to that date.
15280 A prefix ARG can be used to force the current date."
15281 (interactive "P")
15282 (let ((tsr org-ts-regexp) diff
15283 (calendar-move-hook nil)
15284 (calendar-view-holidays-initially-flag nil)
15285 (calendar-view-diary-initially-flag nil))
15286 (if (or (org-at-timestamp-p)
15287 (save-excursion
15288 (beginning-of-line 1)
15289 (looking-at (concat ".*" tsr))))
15290 (let ((d1 (time-to-days (current-time)))
15291 (d2 (time-to-days
15292 (org-time-string-to-time (match-string 1)))))
15293 (setq diff (- d2 d1))))
15294 (calendar)
15295 (calendar-goto-today)
15296 (if (and diff (not arg)) (calendar-forward-day diff))))
15298 (defun org-get-date-from-calendar ()
15299 "Return a list (month day year) of date at point in calendar."
15300 (with-current-buffer "*Calendar*"
15301 (save-match-data
15302 (calendar-cursor-to-date))))
15304 (defun org-date-from-calendar ()
15305 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15306 If there is already a time stamp at the cursor position, update it."
15307 (interactive)
15308 (if (org-at-timestamp-p t)
15309 (org-timestamp-change 0 'calendar)
15310 (let ((cal-date (org-get-date-from-calendar)))
15311 (org-insert-time-stamp
15312 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15314 (defun org-minutes-to-hh:mm-string (m)
15315 "Compute H:MM from a number of minutes."
15316 (let ((h (/ m 60)))
15317 (setq m (- m (* 60 h)))
15318 (format org-time-clocksum-format h m)))
15320 (defun org-hh:mm-string-to-minutes (s)
15321 "Convert a string H:MM to a number of minutes.
15322 If the string is just a number, interpret it as minutes.
15323 In fact, the first hh:mm or number in the string will be taken,
15324 there can be extra stuff in the string.
15325 If no number is found, the return value is 0."
15326 (cond
15328 (+ (* (string-to-number (match-string 1 s)) 60)
15329 (string-to-number (match-string 2 s))))
15331 (string-to-number (match-string 1 s)))
15332 (t 0)))
15334 ;;;; Files
15336 (defun org-save-all-org-buffers ()
15337 "Save all Org-mode buffers without user confirmation."
15338 (interactive)
15339 (message "Saving all Org-mode buffers...")
15340 (save-some-buffers t 'org-mode-p)
15341 (when (featurep 'org-id) (org-id-locations-save))
15342 (message "Saving all Org-mode buffers... done"))
15344 (defun org-revert-all-org-buffers ()
15345 "Revert all Org-mode buffers.
15346 Prompt for confirmation when there are unsaved changes.
15347 Be sure you know what you are doing before letting this function
15348 overwrite your changes.
15350 This function is useful in a setup where one tracks org files
15351 with a version control system, to revert on one machine after pulling
15352 changes from another. I believe the procedure must be like this:
15354 1. M-x org-save-all-org-buffers
15355 2. Pull changes from the other machine, resolve conflicts
15356 3. M-x org-revert-all-org-buffers"
15357 (interactive)
15358 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15359 (error "Abort"))
15360 (save-excursion
15361 (save-window-excursion
15362 (mapc
15363 (lambda (b)
15364 (when (and (with-current-buffer b (org-mode-p))
15365 (with-current-buffer b buffer-file-name))
15366 (switch-to-buffer b)
15367 (revert-buffer t 'no-confirm)))
15368 (buffer-list))
15369 (when (and (featurep 'org-id) org-id-track-globally)
15370 (org-id-locations-load)))))
15372 ;;;; Agenda files
15374 ;;;###autoload
15375 (defun org-switchb (&optional arg)
15376 "Switch between Org buffers.
15377 With a prefix argument, restrict available to files.
15378 With two prefix arguments, restrict available buffers to agenda files.
15380 Defaults to `iswitchb' for buffer name completion.
15381 Set `org-completion-use-ido' to make it use ido instead."
15382 (interactive "P")
15383 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15384 ((equal arg '(16)) (org-buffer-list 'agenda))
15385 (t (org-buffer-list))))
15386 (org-completion-use-iswitchb org-completion-use-iswitchb)
15387 (org-completion-use-ido org-completion-use-ido))
15388 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15389 (setq org-completion-use-iswitchb t))
15390 (switch-to-buffer
15391 (org-icompleting-read "Org buffer: "
15392 (mapcar 'list (mapcar 'buffer-name blist))
15393 nil t))))
15395 ;;; Define some older names previously used for this functionality
15396 ;;;###autoload
15397 (defalias 'org-ido-switchb 'org-switchb)
15398 ;;;###autoload
15399 (defalias 'org-iswitchb 'org-switchb)
15401 (defun org-buffer-list (&optional predicate exclude-tmp)
15402 "Return a list of Org buffers.
15403 PREDICATE can be `export', `files' or `agenda'.
15405 export restrict the list to Export buffers.
15406 files restrict the list to buffers visiting Org files.
15407 agenda restrict the list to buffers visiting agenda files.
15409 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15410 (let* ((bfn nil)
15411 (agenda-files (and (eq predicate 'agenda)
15412 (mapcar 'file-truename (org-agenda-files t))))
15413 (filter
15414 (cond
15415 ((eq predicate 'files)
15416 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
15417 ((eq predicate 'export)
15418 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15419 ((eq predicate 'agenda)
15420 (lambda (b)
15421 (with-current-buffer b
15422 (and (eq major-mode 'org-mode)
15423 (setq bfn (buffer-file-name b))
15424 (member (file-truename bfn) agenda-files)))))
15425 (t (lambda (b) (with-current-buffer b
15426 (or (eq major-mode 'org-mode)
15427 (string-match "\*Org .*Export"
15428 (buffer-name b)))))))))
15429 (delq nil
15430 (mapcar
15431 (lambda(b)
15432 (if (and (funcall filter b)
15433 (or (not exclude-tmp)
15434 (not (string-match "tmp" (buffer-name b)))))
15435 b
15436 nil))
15437 (buffer-list)))))
15439 (defun org-agenda-files (&optional unrestricted archives)
15440 "Get the list of agenda files.
15441 Optional UNRESTRICTED means return the full list even if a restriction
15442 is currently in place.
15443 When ARCHIVES is t, include all archive files that are really being
15444 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15445 `org-agenda-archives-mode' is t."
15446 (let ((files
15447 (cond
15448 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15449 ((stringp org-agenda-files) (org-read-agenda-file-list))
15450 ((listp org-agenda-files) org-agenda-files)
15451 (t (error "Invalid value of `org-agenda-files'")))))
15452 (setq files (apply 'append
15453 (mapcar (lambda (f)
15454 (if (file-directory-p f)
15455 (directory-files
15456 f t org-agenda-file-regexp)
15457 (list f)))
15458 files)))
15459 (when org-agenda-skip-unavailable-files
15460 (setq files (delq nil
15461 (mapcar (function
15462 (lambda (file)
15463 (and (file-readable-p file) file)))
15464 files))))
15465 (when (or (eq archives t)
15466 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15467 (setq files (org-add-archive-files files)))
15468 files))
15470 (defun org-agenda-file-p (&optional file)
15471 "Return non-nil, if FILE is an agenda file.
15472 If FILE is omitted, use the file associated with the current
15473 buffer."
15474 (member (or file (buffer-file-name))
15475 (org-agenda-files t)))
15477 (defun org-edit-agenda-file-list ()
15478 "Edit the list of agenda files.
15479 Depending on setup, this either uses customize to edit the variable
15480 `org-agenda-files', or it visits the file that is holding the list. In the
15481 latter case, the buffer is set up in a way that saving it automatically kills
15482 the buffer and restores the previous window configuration."
15483 (interactive)
15484 (if (stringp org-agenda-files)
15485 (let ((cw (current-window-configuration)))
15486 (find-file org-agenda-files)
15487 (org-set-local 'org-window-configuration cw)
15488 (org-add-hook 'after-save-hook
15489 (lambda ()
15490 (set-window-configuration
15491 (prog1 org-window-configuration
15492 (kill-buffer (current-buffer))))
15493 (org-install-agenda-files-menu)
15494 (message "New agenda file list installed"))
15495 nil 'local)
15496 (message "%s" (substitute-command-keys
15498 (customize-variable 'org-agenda-files)))
15500 (defun org-store-new-agenda-file-list (list)
15501 "Set new value for the agenda file list and save it correctly."
15502 (if (stringp org-agenda-files)
15503 (let ((fe (org-read-agenda-file-list t)) b u)
15504 (while (setq b (find-buffer-visiting org-agenda-files))
15505 (kill-buffer b))
15506 (with-temp-file org-agenda-files
15507 (insert
15508 (mapconcat
15509 (lambda (f) ;; Keep un-expanded entries.
15510 (if (setq u (assoc f fe))
15511 (cdr u)
15512 f))
15515 (let ((org-mode-hook nil) (org-inhibit-startup t)
15516 (org-insert-mode-line-in-empty-file nil))
15517 (setq org-agenda-files list)
15518 (customize-save-variable 'org-agenda-files org-agenda-files))))
15520 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15521 "Read the list of agenda files from a file.
15522 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15523 filenames, used by `org-store-new-agenda-file-list' to write back
15524 un-expanded file names."
15525 (when (file-directory-p org-agenda-files)
15526 (error "`org-agenda-files' cannot be a single directory"))
15527 (when (stringp org-agenda-files)
15528 (with-temp-buffer
15529 (insert-file-contents org-agenda-files)
15530 (mapcar
15531 (lambda (f)
15532 (let ((e (expand-file-name (substitute-in-file-name f)
15533 org-directory)))
15534 (if pair-with-expansion
15535 (cons e f)
15536 e)))
15539 ;;;###autoload
15540 (defun org-cycle-agenda-files ()
15541 "Cycle through the files in `org-agenda-files'.
15542 If the current buffer visits an agenda file, find the next one in the list.
15543 If the current buffer does not, find the first agenda file."
15544 (interactive)
15545 (let* ((fs (org-agenda-files t))
15546 (files (append fs (list (car fs))))
15547 (tcf (if buffer-file-name (file-truename buffer-file-name)))
15548 file)
15549 (unless files (error "No agenda files"))
15550 (catch 'exit
15551 (while (setq file (pop files))
15552 (if (equal (file-truename file) tcf)
15553 (when (car files)
15554 (find-file (car files))
15555 (throw 'exit t))))
15556 (find-file (car fs)))
15557 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
15559 (defun org-agenda-file-to-front (&optional to-end)
15560 "Move/add the current file to the top of the agenda file list.
15561 If the file is not present in the list, it is added to the front. If it is
15562 present, it is moved there. With optional argument TO-END, add/move to the
15563 end of the list."
15564 (interactive "P")
15565 (let ((org-agenda-skip-unavailable-files nil)
15566 (file-alist (mapcar (lambda (x)
15567 (cons (file-truename x) x))
15568 (org-agenda-files t)))
15569 (ctf (file-truename buffer-file-name))
15570 x had)
15571 (setq x (assoc ctf file-alist) had x)
15573 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
15574 (if to-end
15575 (setq file-alist (append (delq x file-alist) (list x)))
15576 (setq file-alist (cons x (delq x file-alist))))
15577 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
15578 (org-install-agenda-files-menu)
15579 (message "File %s to %s of agenda file list"
15580 (if had "moved" "added") (if to-end "end" "front"))))
15582 (defun org-remove-file (&optional file)
15583 "Remove current file from the list of files in variable `org-agenda-files'.
15584 These are the files which are being checked for agenda entries.
15585 Optional argument FILE means use this file instead of the current."
15586 (interactive)
15587 (let* ((org-agenda-skip-unavailable-files nil)
15588 (file (or file buffer-file-name))
15589 (true-file (file-truename file))
15590 (afile (abbreviate-file-name file))
15591 (files (delq nil (mapcar
15592 (lambda (x)
15593 (if (equal true-file
15594 (file-truename x))
15595 nil x))
15596 (org-agenda-files t)))))
15597 (if (not (= (length files) (length (org-agenda-files t))))
15598 (progn
15599 (org-store-new-agenda-file-list files)
15600 (org-install-agenda-files-menu)
15601 (message "Removed file: %s" afile))
15602 (message "File was not in list: %s (not removed)" afile))))
15604 (defun org-file-menu-entry (file)
15605 (vector file (list 'find-file file) t))
15607 (defun org-check-agenda-file (file)
15608 "Make sure FILE exists. If not, ask user what to do."
15609 (when (not (file-exists-p file))
15610 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
15611 (abbreviate-file-name file))
15612 (let ((r (downcase (read-char-exclusive))))
15613 (cond
15614 ((equal r ?r)
15615 (org-remove-file file)
15616 (throw 'nextfile t))
15617 (t (error "Abort"))))))
15619 (defun org-get-agenda-file-buffer (file)
15620 "Get a buffer visiting FILE. If the buffer needs to be created, add
15621 it to the list of buffers which might be released later."
15622 (let ((buf (org-find-base-buffer-visiting file)))
15623 (if buf
15624 buf ; just return it
15625 ;; Make a new buffer and remember it
15626 (setq buf (find-file-noselect file))
15627 (if buf (push buf org-agenda-new-buffers))
15628 buf)))
15630 (defun org-release-buffers (blist)
15631 "Release all buffers in list, asking the user for confirmation when needed.
15632 When a buffer is unmodified, it is just killed. When modified, it is saved
15633 \(if the user agrees) and then killed."
15634 (let (buf file)
15635 (while (setq buf (pop blist))
15636 (setq file (buffer-file-name buf))
15637 (when (and (buffer-modified-p buf)
15638 file
15639 (y-or-n-p (format "Save file %s? " file)))
15640 (with-current-buffer buf (save-buffer)))
15641 (kill-buffer buf))))
15643 (defun org-prepare-agenda-buffers (files)
15644 "Create buffers for all agenda files, protect archived trees and comments."
15645 (interactive)
15646 (let ((pa '(:org-archived t))
15647 (pc '(:org-comment t))
15648 (pall '(:org-archived t :org-comment t))
15649 (inhibit-read-only t)
15650 (rea (concat ":" org-archive-tag ":"))
15651 bmp file re)
15652 (save-excursion
15653 (save-restriction
15654 (while (setq file (pop files))
15655 (catch 'nextfile
15656 (if (bufferp file)
15657 (set-buffer file)
15658 (org-check-agenda-file file)
15659 (set-buffer (org-get-agenda-file-buffer file)))
15660 (widen)
15661 (setq bmp (buffer-modified-p))
15662 (org-refresh-category-properties)
15663 (setq org-todo-keywords-for-agenda
15664 (append org-todo-keywords-for-agenda org-todo-keywords-1))
15665 (setq org-done-keywords-for-agenda
15666 (append org-done-keywords-for-agenda org-done-keywords))
15667 (setq org-todo-keyword-alist-for-agenda
15668 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
15669 (setq org-drawers-for-agenda
15670 (append org-drawers-for-agenda org-drawers))
15671 (setq org-tag-alist-for-agenda
15672 (append org-tag-alist-for-agenda org-tag-alist))
15674 (save-excursion
15675 (remove-text-properties (point-min) (point-max) pall)
15676 (when org-agenda-skip-archived-trees
15677 (goto-char (point-min))
15678 (while (re-search-forward rea nil t)
15679 (if (org-on-heading-p t)
15680 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
15681 (goto-char (point-min))
15683 (while (re-search-forward re nil t)
15684 (add-text-properties
15685 (match-beginning 0) (org-end-of-subtree t) pc)))
15686 (set-buffer-modified-p bmp)))))
15687 (setq org-todo-keywords-for-agenda
15688 (org-uniquify org-todo-keywords-for-agenda))
15689 (setq org-todo-keyword-alist-for-agenda
15690 (org-uniquify org-todo-keyword-alist-for-agenda)
15691 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
15693 ;;;; Embedded LaTeX
15695 (defvar org-cdlatex-mode-map (make-sparse-keymap)
15696 "Keymap for the minor `org-cdlatex-mode'.")
15698 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
15699 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
15700 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
15701 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
15702 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
15704 (defvar org-cdlatex-texmathp-advice-is-done nil
15705 "Flag remembering if we have applied the advice to texmathp already.")
15707 (define-minor-mode org-cdlatex-mode
15708 "Toggle the minor `org-cdlatex-mode'.
15709 This mode supports entering LaTeX environment and math in LaTeX fragments
15710 in Org-mode.
15712 nil " OCDL" nil
15713 (when org-cdlatex-mode (require 'cdlatex))
15714 (unless org-cdlatex-texmathp-advice-is-done
15715 (setq org-cdlatex-texmathp-advice-is-done t)
15716 (defadvice texmathp (around org-math-always-on activate)
15717 "Always return t in org-mode buffers.
15718 This is because we want to insert math symbols without dollars even outside
15719 the LaTeX math segments. If Orgmode thinks that point is actually inside
15720 an embedded LaTeX fragment, let texmathp do its job.
15722 (interactive)
15723 (let (p)
15724 (cond
15725 ((not (org-mode-p)) ad-do-it)
15726 ((eq this-command 'cdlatex-math-symbol)
15727 (setq ad-return-value t
15728 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
15729 (t
15730 (let ((p (org-inside-LaTeX-fragment-p)))
15731 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
15732 (setq ad-return-value t
15733 texmathp-why '("Org-mode embedded math" . 0))
15734 (if p ad-do-it)))))))))
15736 (defun turn-on-org-cdlatex ()
15737 "Unconditionally turn on `org-cdlatex-mode'."
15738 (org-cdlatex-mode 1))
15740 (defun org-inside-LaTeX-fragment-p ()
15741 "Test if point is inside a LaTeX fragment.
15743 sequence appearing also before point.
15744 Even though the matchers for math are configurable, this function assumes
15746 delimiters are skipped when they have been removed by customization.
15747 The return value is nil, or a cons cell with the delimiter and
15748 and the position of this delimiter.
15750 This function does a reasonably good job, but can locally be fooled by
15751 for example currency specifications. For example it will assume being in
15753 fragments that are properly closed, but during editing, we have to live
15754 with the uncertainty caused by missing closing delimiters. This function
15755 looks only before point, not after."
15756 (catch 'exit
15757 (let ((pos (point))
15758 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
15759 (lim (progn
15761 (point)))
15762 dd-on str (start 0) m re)
15763 (goto-char pos)
15764 (when dodollar
15766 re (nth 1 (assoc "$" org-latex-regexps)))
15767 (while (string-match re str start)
15768 (cond
15769 ((= (match-end 0) (length str))
15770 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
15771 ((= (match-end 0) (- (length str) 5))
15772 (throw 'exit nil))
15773 (t (setq start (match-end 0))))))
15774 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
15775 (goto-char pos)
15776 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
15777 (and (match-beginning 2) (throw 'exit nil))
15778 ;; count $$
15780 (setq dd-on (not dd-on)))
15781 (goto-char pos)
15782 (if dd-on (cons "$$" m))))))
15784 (defun org-inside-latex-macro-p ()
15785 "Is point inside a LaTeX macro or its arguments?"
15786 (save-match-data
15787 (org-in-regexp
15790 (defun org-try-cdlatex-tab ()
15791 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15792 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15793 - inside a LaTeX fragment, or
15794 - after the first word in a line, where an abbreviation expansion could
15795 insert a LaTeX environment."
15796 (when org-cdlatex-mode
15797 (cond
15798 ((save-excursion
15799 (skip-chars-backward "a-zA-Z0-9*")
15801 (bolp))
15802 (cdlatex-tab) t)
15803 ((org-inside-LaTeX-fragment-p)
15804 (cdlatex-tab) t)
15805 (t nil))))
15807 (defun org-cdlatex-underscore-caret (&optional arg)
15808 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15809 Revert to the normal definition outside of these fragments."
15810 (interactive "P")
15811 (if (org-inside-LaTeX-fragment-p)
15812 (call-interactively 'cdlatex-sub-superscript)
15813 (let (org-cdlatex-mode)
15814 (call-interactively (key-binding (vector last-input-event))))))
15816 (defun org-cdlatex-math-modify (&optional arg)
15817 "Execute `cdlatex-math-modify' in LaTeX fragments.
15818 Revert to the normal definition outside of these fragments."
15819 (interactive "P")
15820 (if (org-inside-LaTeX-fragment-p)
15821 (call-interactively 'cdlatex-math-modify)
15822 (let (org-cdlatex-mode)
15823 (call-interactively (key-binding (vector last-input-event))))))
15825 (defvar org-latex-fragment-image-overlays nil
15826 "List of overlays carrying the images of latex fragments.")
15827 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
15829 (defun org-remove-latex-fragment-image-overlays ()
15830 "Remove all overlays with LaTeX fragment images in current buffer."
15831 (mapc 'delete-overlay org-latex-fragment-image-overlays)
15832 (setq org-latex-fragment-image-overlays nil))
15834 (defun org-preview-latex-fragment (&optional subtree)
15835 "Preview the LaTeX fragment at point, or all locally or globally.
15836 If the cursor is in a LaTeX fragment, create the image and overlay
15837 it over the source code. If there is no fragment at point, display
15838 all fragments in the current text, from one headline to the next. With
15839 prefix SUBTREE, display all fragments in the current subtree. With a
15841 the cursor is before the first headline,
15842 display all fragments in the buffer.
15844 (interactive "P")
15845 (org-remove-latex-fragment-image-overlays)
15846 (save-excursion
15847 (save-restriction
15848 (let (beg end at msg)
15849 (cond
15850 ((or (equal subtree '(16))
15851 (not (save-excursion
15852 (re-search-backward (concat "^" outline-regexp) nil t))))
15853 (setq beg (point-min) end (point-max)
15854 msg "Creating images for buffer...%s"))
15855 ((equal subtree '(4))
15856 (org-back-to-heading)
15857 (setq beg (point) end (org-end-of-subtree t)
15858 msg "Creating images for subtree...%s"))
15859 (t
15860 (if (setq at (org-inside-LaTeX-fragment-p))
15861 (goto-char (max (point-min) (- (cdr at) 2)))
15862 (org-back-to-heading))
15863 (setq beg (point) end (progn (outline-next-heading) (point))
15864 msg (if at "Creating image...%s"
15865 "Creating images for entry...%s"))))
15866 (message msg "")
15867 (narrow-to-region beg end)
15868 (goto-char beg)
15869 (org-format-latex
15870 (concat "ltxpng/" (file-name-sans-extension
15871 (file-name-nondirectory
15872 buffer-file-name)))
15873 default-directory 'overlays msg at 'forbuffer 'dvipng)
15874 (message msg "done. Use `C-c C-c' to remove images.")))))
15876 (defvar org-latex-regexps
15878 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
15881 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
15885 "Regular expressions for matching embedded LaTeX.")
15887 (defvar org-export-have-math nil) ;; dynamic scoping
15888 (defun org-format-latex (prefix &optional dir overlays msg at
15889 forbuffer processing-type)
15890 "Replace LaTeX fragments with links to an image, and produce images.
15891 Some of the options can be changed using the variable
15892 `org-format-latex-options'."
15893 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
15894 (let* ((prefixnodir (file-name-nondirectory prefix))
15895 (absprefix (expand-file-name prefix dir))
15896 (todir (file-name-directory absprefix))
15897 (opt org-format-latex-options)
15898 (matchers (plist-get opt :matchers))
15899 (re-list org-latex-regexps)
15900 (org-format-latex-header-extra
15901 (plist-get (org-infile-export-plist) :latex-header-extra))
15902 (cnt 0) txt hash link beg end re e checkdir
15903 executables-checked string
15904 m n block linkfile movefile ov)
15905 ;; Check the different regular expressions
15906 (while (setq e (pop re-list))
15907 (setq m (car e) re (nth 1 e) n (nth 2 e)
15909 (when (member m matchers)
15910 (goto-char (point-min))
15911 (while (re-search-forward re nil t)
15912 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
15913 (not (get-text-property (match-beginning n)
15914 'org-protected))
15915 (or (not overlays)
15916 (not (eq (get-char-property (match-beginning n)
15917 'org-overlay-type)
15918 'org-latex-overlay))))
15919 (setq org-export-have-math t)
15920 (cond
15921 ((eq processing-type 'verbatim)
15922 ;; Leave the text verbatim, just protect it
15923 (add-text-properties (match-beginning n) (match-end n)
15924 '(org-protected t)))
15925 ((eq processing-type 'mathjax)
15926 ;; Prepare for MathJax processing
15927 (setq string (match-string n))
15928 (if (member m '("$" "$1"))
15929 (save-excursion
15930 (delete-region (match-beginning n) (match-end n))
15931 (goto-char (match-beginning n))
15934 '(org-protected t))))
15935 (add-text-properties (match-beginning n) (match-end n)
15936 '(org-protected t))))
15937 ((or (eq processing-type 'dvipng) t)
15938 ;; Process to an image
15939 (setq txt (match-string n)
15940 beg (match-beginning n) end (match-end n)
15941 cnt (1+ cnt))
15942 (let (print-length print-level) ; make sure full list is printed
15943 (setq hash (sha1 (prin1-to-string
15944 (list org-format-latex-header
15945 org-format-latex-header-extra
15946 org-export-latex-default-packages-alist
15947 org-export-latex-packages-alist
15948 org-format-latex-options
15949 forbuffer txt)))
15950 linkfile (format "%s_%s.png" prefix hash)
15951 movefile (format "%s_%s.png" absprefix hash)))
15952 (setq link (concat block "[[file:" linkfile "]]" block))
15953 (if msg (message msg cnt))
15954 (goto-char beg)
15955 (unless checkdir ; make sure the directory exists
15956 (setq checkdir t)
15957 (or (file-directory-p todir) (make-directory todir t)))
15959 (unless executables-checked
15960 (org-check-external-command
15961 "latex" "needed to convert LaTeX fragments to images")
15962 (org-check-external-command
15963 "dvipng" "needed to convert LaTeX fragments to images")
15964 (setq executables-checked t))
15966 (unless (file-exists-p movefile)
15967 (org-create-formula-image
15968 txt movefile opt forbuffer))
15969 (if overlays
15970 (progn
15971 (mapc (lambda (o)
15972 (if (eq (overlay-get o 'org-overlay-type)
15973 'org-latex-overlay)
15974 (delete-overlay o)))
15975 (overlays-in beg end))
15976 (setq ov (make-overlay beg end))
15977 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
15978 (if (featurep 'xemacs)
15979 (progn
15980 (overlay-put ov 'invisible t)
15981 (overlay-put
15982 ov 'end-glyph
15983 (make-glyph (vector 'png :file movefile))))
15984 (overlay-put
15985 ov 'display
15986 (list 'image :type 'png :file movefile :ascent 'center)))
15987 (push ov org-latex-fragment-image-overlays)
15988 (goto-char end))
15989 (delete-region beg end)
15990 (insert (org-add-props link
15991 (list 'org-latex-src
15992 (replace-regexp-in-string
15995 ;; This function borrows from Ganesh Swami's latex2png.el
15996 (defun org-create-formula-image (string tofile options buffer)
15997 "This calls dvipng."
15998 (require 'org-latex)
15999 (let* ((tmpdir (if (featurep 'xemacs)
16000 (temp-directory)
16001 temporary-file-directory))
16002 (texfilebase (make-temp-name
16003 (expand-file-name "orgtex" tmpdir)))
16004 (texfile (concat texfilebase ".tex"))
16005 (dvifile (concat texfilebase ".dvi"))
16006 (pngfile (concat texfilebase ".png"))
16007 (fnh (if (featurep 'xemacs)
16008 (font-height (get-face-font 'default))
16009 (face-attribute 'default :height nil)))
16010 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16011 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16012 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16013 "Black"))
16014 (bg (or (plist-get options (if buffer :background :html-background))
16015 "Transparent")))
16016 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16017 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16018 (with-temp-file texfile
16019 (insert (org-splice-latex-header
16020 org-format-latex-header
16021 org-export-latex-default-packages-alist
16022 org-export-latex-packages-alist t
16023 org-format-latex-header-extra))
16025 (require 'org-latex)
16026 (org-export-latex-fix-inputenc))
16027 (let ((dir default-directory))
16028 (condition-case nil
16029 (progn
16030 (cd tmpdir)
16031 (call-process "latex" nil nil nil texfile))
16032 (error nil))
16033 (cd dir))
16034 (if (not (file-exists-p dvifile))
16035 (progn (message "Failed to create dvi file from %s" texfile) nil)
16036 (condition-case nil
16037 (call-process "dvipng" nil nil nil
16038 "-fg" fg "-bg" bg
16039 "-D" dpi
16040 ;;"-x" scale "-y" scale
16041 "-T" "tight"
16042 "-o" pngfile
16043 dvifile)
16044 (error nil))
16045 (if (not (file-exists-p pngfile))
16046 (if org-format-latex-signal-error
16047 (error "Failed to create png file from %s" texfile)
16048 (message "Failed to create png file from %s" texfile)
16049 nil)
16050 ;; Use the requested file name and clean up
16051 (copy-file pngfile tofile 'replace)
16052 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16053 (delete-file (concat texfilebase e)))
16054 pngfile))))
16056 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16057 "Fill a LaTeX header template TPL.
16058 In the template, the following place holders will be recognized:
16061 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16063 [NO-PACKAGES] do not include PKG
16064 [EXTRA] the string EXTRA
16065 [NO-EXTRA] do not include EXTRA
16067 For backward compatibility, if both the positive and the negative place
16069 assumed to be present at the end of the template.
16070 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16071 EXTRA is a string.
16072 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16073 (let (rpl (end ""))
16075 (setq rpl (if (or (match-end 1) (not def-pkg))
16076 "" (org-latex-packages-to-string def-pkg snippets-p t))
16077 tpl (replace-match rpl t t tpl))
16078 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16081 (setq rpl (if (or (match-end 1) (not pkg))
16082 "" (org-latex-packages-to-string pkg snippets-p t))
16083 tpl (replace-match rpl t t tpl))
16084 (if pkg (setq end
16086 (org-latex-packages-to-string pkg snippets-p)))))
16089 (setq rpl (if (or (match-end 1) (not extra))
16091 tpl (replace-match rpl t t tpl))
16097 tpl)))
16099 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16101 (setq pkg (mapconcat (lambda(p)
16102 (cond
16103 ((stringp p) p)
16104 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16105 (format "%% Package %s omitted" (cadr p)))
16106 ((equal "" (car p))
16108 (t
16110 (car p) (cadr p)))))
16111 pkg
16115 (defun org-dvipng-color (attr)
16116 "Return an rgb color specification for dvipng."
16117 (apply 'format "rgb %s %s %s"
16118 (mapcar 'org-normalize-color
16119 (color-values (face-attribute 'default attr nil)))))
16121 (defun org-normalize-color (value)
16122 "Return string to be used as color value for an RGB component."
16123 (format "%g" (/ value 65535.0)))
16125 ;; Image display
16128 (defvar org-inline-image-overlays nil)
16129 (make-variable-buffer-local 'org-inline-image-overlays)
16131 (defun org-toggle-inline-images (&optional include-linked)
16132 "Toggle the display of inline images.
16133 INCLUDE-LINKED is passed to `org-display-inline-images'."
16134 (interactive "P")
16135 (if org-inline-image-overlays
16136 (progn
16137 (org-remove-inline-images)
16138 (message "Inline image display turned off"))
16139 (org-display-inline-images include-linked)
16140 (if org-inline-image-overlays
16141 (message "%d images displayed inline"
16142 (length org-inline-image-overlays))
16143 (message "No images to display inline"))))
16145 (defun org-display-inline-images (&optional include-linked refresh beg end)
16146 "Display inline images.
16147 Normally only links without a description part are inlined, because this
16148 is how it will work for export. When INCLUDE-LINKED is set, also links
16149 with a description part will be inlined. This can be nice for a quick
16150 look at those images, but it does not reflect what exported files will look
16151 like.
16152 When REFRESH is set, refresh existing images between BEG and END.
16153 This will create new image displays only if necessary.
16154 BEG and END default to the buffer boundaries."
16155 (interactive "P")
16156 (unless refresh
16157 (org-remove-inline-images)
16158 (clear-image-cache))
16159 (save-excursion
16160 (save-restriction
16161 (widen)
16162 (setq beg (or beg (point-min)) end (or end (point-max)))
16163 (goto-char (point-min))
16165 (substring (org-image-file-name-regexp) 0 -2)
16167 old file ov img)
16168 (while (re-search-forward re end t)
16169 (setq old (get-char-property-and-overlay (match-beginning 1)
16170 'org-image-overlay))
16171 (setq file (expand-file-name
16172 (concat (or (match-string 3) "") (match-string 4))))
16173 (when (file-exists-p file)
16174 (if (and (car-safe old) refresh)
16175 (image-refresh (overlay-get (cdr old) 'display))
16176 (setq img (save-match-data (create-image file)))
16177 (when img
16178 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16179 (overlay-put ov 'display img)
16180 (overlay-put ov 'face 'default)
16181 (overlay-put ov 'org-image-overlay t)
16182 (overlay-put ov 'modification-hooks
16183 (list 'org-display-inline-modification-hook))
16184 (push ov org-inline-image-overlays)))))))))
16186 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16187 "Remove inline-display overlay if a corresponding region is modified."
16188 (let ((inhibit-modification-hooks t))
16189 (when (and ov after)
16190 (delete ov org-inline-image-overlays)
16191 (delete-overlay ov))))
16193 (defun org-remove-inline-images ()
16194 "Remove inline display of images."
16195 (interactive)
16196 (mapc 'delete-overlay org-inline-image-overlays)
16197 (setq org-inline-image-overlays nil))
16199 ;;;; Key bindings
16201 ;; Make `C-c C-x' a prefix key
16202 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16204 ;; TAB key with modifiers
16205 (org-defkey org-mode-map "\C-i" 'org-cycle)
16206 (org-defkey org-mode-map [(tab)] 'org-cycle)
16207 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16208 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16210 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16211 ;; The following line is necessary under Suse GNU/Linux
16212 (unless (featurep 'xemacs)
16213 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16214 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16215 (define-key org-mode-map [backtab] 'org-shifttab)
16217 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16218 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16219 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16221 ;; Cursor keys with modifiers
16222 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16223 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16224 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16225 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16227 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16228 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16229 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16230 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16232 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16233 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16234 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16235 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16237 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16238 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16240 ;; Babel keys
16241 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16242 (mapc (lambda (pair)
16243 (define-key org-babel-map (car pair) (cdr pair)))
16244 org-babel-key-bindings)
16246 ;;; Extra keys for tty access.
16247 ;; We only set them when really needed because otherwise the
16248 ;; menus don't show the simple keys
16250 (when (or org-use-extra-keys
16251 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16252 (not window-system))
16253 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16254 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16255 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16256 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16257 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16258 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16259 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16260 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16261 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16262 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16263 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16264 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16265 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16266 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16267 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16268 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16269 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16270 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16271 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16272 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16273 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16274 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16275 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16276 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16277 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16278 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16279 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16280 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16282 ;; All the other keys
16284 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16285 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16286 (if (boundp 'narrow-map)
16287 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16288 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16289 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16290 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16291 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16292 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16293 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16294 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16295 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16296 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16297 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16298 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16299 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16300 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16301 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16302 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16303 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16304 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16306 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16307 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16308 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16309 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16310 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16311 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16312 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16313 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16314 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16315 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16316 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16317 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16318 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16319 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16320 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16321 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16322 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16323 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16324 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16326 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16327 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16328 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16329 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16330 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16331 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16332 (org-defkey org-mode-map "\C-c^" 'org-sort)
16333 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16334 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16335 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16336 (org-defkey org-mode-map "\C-m" 'org-return)
16337 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16338 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16339 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16340 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16341 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16342 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16343 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16344 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16345 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16346 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16347 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16348 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16349 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16350 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16351 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16352 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16353 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16354 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16355 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16356 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16357 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16359 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16360 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16361 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16362 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16364 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16365 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16366 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16367 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16368 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16369 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16370 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16371 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16372 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16373 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16375 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16376 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16377 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16378 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16379 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16380 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16381 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16383 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16384 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16385 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16386 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16387 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16389 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16391 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16393 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16394 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16396 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16399 (when (featurep 'xemacs)
16400 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16403 (defconst org-speed-commands-default
16404 '(
16405 ("Outline Navigation")
16406 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16407 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16408 ("f" . (org-speed-move-safe 'org-forward-same-level))
16409 ("b" . (org-speed-move-safe 'org-backward-same-level))
16410 ("u" . (org-speed-move-safe 'outline-up-heading))
16411 ("j" . org-goto)
16412 ("g" . (org-refile t))
16413 ("Outline Visibility")
16414 ("c" . org-cycle)
16415 ("C" . org-shifttab)
16416 (" " . org-display-outline-path)
16417 ("Outline Structure Editing")
16418 ("U" . org-shiftmetaup)
16419 ("D" . org-shiftmetadown)
16420 ("r" . org-metaright)
16421 ("l" . org-metaleft)
16422 ("R" . org-shiftmetaright)
16423 ("L" . org-shiftmetaleft)
16424 ("i" . (progn (forward-char 1) (call-interactively
16425 'org-insert-heading-respect-content)))
16426 ("^" . org-sort)
16427 ("w" . org-refile)
16428 ("a" . org-archive-subtree-default-with-confirmation)
16429 ("." . outline-mark-subtree)
16430 ("Clock Commands")
16431 ("I" . org-clock-in)
16432 ("O" . org-clock-out)
16433 ("Meta Data Editing")
16434 ("t" . org-todo)
16435 ("0" . (org-priority ?\ ))
16436 ("1" . (org-priority ?A))
16437 ("2" . (org-priority ?B))
16438 ("3" . (org-priority ?C))
16439 (";" . org-set-tags-command)
16440 ("e" . org-set-effort)
16441 ("Agenda Views etc")
16442 ("v" . org-agenda)
16443 ("/" . org-sparse-tree)
16444 ("Misc")
16445 ("o" . org-open-at-point)
16446 ("?" . org-speed-command-help)
16447 ("<" . (org-agenda-set-restriction-lock 'subtree))
16448 (">" . (org-agenda-remove-restriction-lock))
16449 )
16450 "The default speed commands.")
16452 (defun org-print-speed-command (e)
16453 (if (> (length (car e)) 1)
16454 (progn
16456 (princ (car e))
16458 (princ (make-string (length (car e)) ?-))
16460 (princ (car e))
16461 (princ " ")
16462 (if (symbolp (cdr e))
16463 (princ (symbol-name (cdr e)))
16464 (prin1 (cdr e)))
16467 (defun org-speed-command-help ()
16468 "Show the available speed commands."
16469 (interactive)
16470 (if (not org-use-speed-commands)
16471 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16472 (with-output-to-temp-buffer "*Help*"
16474 (mapc 'org-print-speed-command org-speed-commands-user)
16477 (mapc 'org-print-speed-command org-speed-commands-default))
16478 (with-current-buffer "*Help*"
16479 (setq truncate-lines t))))
16481 (defun org-speed-move-safe (cmd)
16482 "Execute CMD, but make sure that the cursor always ends up in a headline.
16483 If not, return to the original position and throw an error."
16484 (interactive)
16485 (let ((pos (point)))
16486 (call-interactively cmd)
16487 (unless (and (bolp) (org-on-heading-p))
16488 (goto-char pos)
16489 (error "Boundary reached while executing %s" cmd))))
16491 (defvar org-self-insert-command-undo-counter 0)
16493 (defvar org-table-auto-blank-field) ; defined in org-table.el
16494 (defvar org-speed-command nil)
16496 (defun org-speed-command-default-hook (keys)
16497 "Hook for activating single-letter speed commands.
16498 `org-speed-commands-default' specifies a minimal command set. Use
16499 `org-speed-commands-user' for further customization."
16500 (when (or (and (bolp) (looking-at outline-regexp))
16501 (and (functionp org-use-speed-commands)
16502 (funcall org-use-speed-commands)))
16503 (cdr (assoc keys (append org-speed-commands-user
16504 org-speed-commands-default)))))
16506 (defun org-babel-speed-command-hook (keys)
16507 "Hook for activating single-letter code block commands."
16508 (when (and (bolp) (looking-at org-babel-src-block-regexp))
16509 (cdr (assoc keys org-babel-key-bindings))))
16511 (defcustom org-speed-command-hook
16512 '(org-speed-command-default-hook org-babel-speed-command-hook)
16513 "Hook for activating speed commands at strategic locations.
16514 Hook functions are called in sequence until a valid handler is
16515 found.
16517 Each hook takes a single argument, a user-pressed command key
16518 which is also a `self-insert-command' from the global map.
16520 Within the hook, examine the cursor position and the command key
16521 and return nil or a valid handler as appropriate. Handler could
16522 be one of an interactive command, a function, or a form.
16524 Set `org-use-speed-commands' to non-nil value to enable this
16525 hook. The default setting is `org-speed-command-default-hook'."
16526 :group 'org-structure
16527 :type 'hook)
16529 (defun org-self-insert-command (N)
16530 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
16531 If the cursor is in a table looking at whitespace, the whitespace is
16532 overwritten, and the table is not marked as requiring realignment."
16533 (interactive "p")
16534 (cond
16535 ((and org-use-speed-commands
16536 (setq org-speed-command
16537 (run-hook-with-args-until-success
16538 'org-speed-command-hook (this-command-keys))))
16539 (cond
16540 ((commandp org-speed-command)
16541 (setq this-command org-speed-command)
16542 (call-interactively org-speed-command))
16543 ((functionp org-speed-command)
16544 (funcall org-speed-command))
16545 ((and org-speed-command (listp org-speed-command))
16546 (eval org-speed-command))
16547 (t (let (org-use-speed-commands)
16548 (call-interactively 'org-self-insert-command)))))
16549 ((and
16550 (org-table-p)
16551 (progn
16552 ;; check if we blank the field, and if that triggers align
16553 (and (featurep 'org-table) org-table-auto-blank-field
16554 (member last-command
16555 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
16557 ;; got extra space, this field does not determine column width
16558 (let (org-table-may-need-update) (org-table-blank-field))
16559 ;; no extra space, this field may determine column width
16560 (org-table-blank-field)))
16561 t)
16562 (eq N 1)
16564 (let (org-table-may-need-update)
16565 (goto-char (1- (match-end 0)))
16566 (delete-backward-char 1)
16567 (goto-char (match-beginning 0))
16568 (self-insert-command N)))
16569 (t
16570 (setq org-table-may-need-update t)
16571 (self-insert-command N)
16572 (org-fix-tags-on-the-fly)
16573 (if org-self-insert-cluster-for-undo
16574 (if (not (eq last-command 'org-self-insert-command))
16575 (setq org-self-insert-command-undo-counter 1)
16576 (if (>= org-self-insert-command-undo-counter 20)
16577 (setq org-self-insert-command-undo-counter 1)
16578 (and (> org-self-insert-command-undo-counter 0)
16579 buffer-undo-list
16580 (not (cadr buffer-undo-list)) ; remove nil entry
16581 (setcdr buffer-undo-list (cddr buffer-undo-list)))
16582 (setq org-self-insert-command-undo-counter
16583 (1+ org-self-insert-command-undo-counter))))))))
16585 (defun org-fix-tags-on-the-fly ()
16586 (when (and (equal (char-after (point-at-bol)) ?*)
16587 (org-on-heading-p))
16588 (org-align-tags-here org-tags-column)))
16590 (defun org-delete-backward-char (N)
16591 "Like `delete-backward-char', insert whitespace at field end in tables.
16592 When deleting backwards, in tables this function will insert whitespace in
16594 still be marked for re-alignment if the field did fill the entire column,
16595 because, in this case the deletion might narrow the column."
16596 (interactive "p")
16597 (if (and (org-table-p)
16598 (eq N 1)
16599 (string-match "|" (buffer-substring (point-at-bol) (point)))
16600 (looking-at ".*?|"))
16601 (let ((pos (point))
16603 (c org-table-may-need-update))
16604 (backward-delete-char N)
16605 (if (not overwrite-mode)
16606 (progn
16607 (skip-chars-forward "^|")
16608 (insert " ")
16609 (goto-char (1- pos))))
16610 ;; noalign: if there were two spaces at the end, this field
16611 ;; does not determine the width of the column.
16612 (if noalign (setq org-table-may-need-update c)))
16613 (backward-delete-char N)
16614 (org-fix-tags-on-the-fly)))
16616 (defun org-delete-char (N)
16617 "Like `delete-char', but insert whitespace at field end in tables.
16618 When deleting characters, in tables this function will insert whitespace in
16620 still be marked for re-alignment if the field did fill the entire column,
16621 because, in this case the deletion might narrow the column."
16622 (interactive "p")
16623 (if (and (org-table-p)
16624 (not (bolp))
16625 (not (= (char-after) ?|))
16626 (eq N 1))
16627 (if (looking-at ".*?|")
16628 (let ((pos (point))
16630 (c org-table-may-need-update))
16631 (replace-match (concat
16632 (substring (match-string 0) 1 -1)
16633 " |"))
16634 (goto-char pos)
16635 ;; noalign: if there were two spaces at the end, this field
16636 ;; does not determine the width of the column.
16637 (if noalign (setq org-table-may-need-update c)))
16638 (delete-char N))
16639 (delete-char N)
16640 (org-fix-tags-on-the-fly)))
16642 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
16643 (put 'org-self-insert-command 'delete-selection t)
16644 (put 'orgtbl-self-insert-command 'delete-selection t)
16645 (put 'org-delete-char 'delete-selection 'supersede)
16646 (put 'org-delete-backward-char 'delete-selection 'supersede)
16647 (put 'org-yank 'delete-selection 'yank)
16649 ;; Make `flyspell-mode' delay after some commands
16650 (put 'org-self-insert-command 'flyspell-delayed t)
16651 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
16652 (put 'org-delete-char 'flyspell-delayed t)
16653 (put 'org-delete-backward-char 'flyspell-delayed t)
16655 ;; Make pabbrev-mode expand after org-mode commands
16656 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
16657 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
16659 ;; How to do this: Measure non-white length of current string
16660 ;; If equal to column width, we should realign.
16662 (defun org-remap (map &rest commands)
16663 "In MAP, remap the functions given in COMMANDS.
16664 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
16665 (let (new old)
16666 (while commands
16667 (setq old (pop commands) new (pop commands))
16668 (if (fboundp 'command-remapping)
16669 (org-defkey map (vector 'remap old) new)
16670 (substitute-key-definition old new map global-map)))))
16672 (when (eq org-enable-table-editor 'optimized)
16673 ;; If the user wants maximum table support, we need to hijack
16674 ;; some standard editing functions
16675 (org-remap org-mode-map
16676 'self-insert-command 'org-self-insert-command
16677 'delete-char 'org-delete-char
16678 'delete-backward-char 'org-delete-backward-char)
16679 (org-defkey org-mode-map "|" 'org-force-self-insert))
16681 (defvar org-ctrl-c-ctrl-c-hook nil
16682 "Hook for functions attaching themselves to `C-c C-c'.
16683 This can be used to add additional functionality to the C-c C-c key which
16684 executes context-dependent commands.
16685 Each function will be called with no arguments. The function must check
16686 if the context is appropriate for it to act. If yes, it should do its
16687 thing and then return a non-nil value. If the context is wrong,
16688 just do nothing and return nil.")
16690 (defvar org-tab-first-hook nil
16691 "Hook for functions to attach themselves to TAB.
16692 See `org-ctrl-c-ctrl-c-hook' for more information.
16693 This hook runs as the first action when TAB is pressed, even before
16694 `org-cycle' messes around with the `outline-regexp' to cater for
16695 inline tasks and plain list item folding.
16696 If any function in this hook returns t, any other actions that
16697 would have been caused by TAB (such as table field motion or visibility
16698 cycling) will not occur.")
16700 (defvar org-tab-after-check-for-table-hook nil
16701 "Hook for functions to attach themselves to TAB.
16702 See `org-ctrl-c-ctrl-c-hook' for more information.
16703 This hook runs after it has been established that the cursor is not in a
16704 table, but before checking if the cursor is in a headline or if global cycling
16705 should be done.
16706 If any function in this hook returns t, not other actions like visibility
16707 cycling will be done.")
16709 (defvar org-tab-after-check-for-cycling-hook nil
16710 "Hook for functions to attach themselves to TAB.
16711 See `org-ctrl-c-ctrl-c-hook' for more information.
16712 This hook runs after it has been established that not table field motion and
16713 not visibility should be done because of current context. This is probably
16714 the place where a package like yasnippets can hook in.")
16716 (defvar org-tab-before-tab-emulation-hook nil
16717 "Hook for functions to attach themselves to TAB.
16718 See `org-ctrl-c-ctrl-c-hook' for more information.
16719 This hook runs after every other options for TAB have been exhausted, but
16722 (defvar org-metaleft-hook nil
16723 "Hook for functions attaching themselves to `M-left'.
16724 See `org-ctrl-c-ctrl-c-hook' for more information.")
16725 (defvar org-metaright-hook nil
16726 "Hook for functions attaching themselves to `M-right'.
16727 See `org-ctrl-c-ctrl-c-hook' for more information.")
16728 (defvar org-metaup-hook nil
16729 "Hook for functions attaching themselves to `M-up'.
16730 See `org-ctrl-c-ctrl-c-hook' for more information.")
16731 (defvar org-metadown-hook nil
16732 "Hook for functions attaching themselves to `M-down'.
16733 See `org-ctrl-c-ctrl-c-hook' for more information.")
16734 (defvar org-shiftmetaleft-hook nil
16735 "Hook for functions attaching themselves to `M-S-left'.
16736 See `org-ctrl-c-ctrl-c-hook' for more information.")
16737 (defvar org-shiftmetaright-hook nil
16738 "Hook for functions attaching themselves to `M-S-right'.
16739 See `org-ctrl-c-ctrl-c-hook' for more information.")
16740 (defvar org-shiftmetaup-hook nil
16741 "Hook for functions attaching themselves to `M-S-up'.
16742 See `org-ctrl-c-ctrl-c-hook' for more information.")
16743 (defvar org-shiftmetadown-hook nil
16744 "Hook for functions attaching themselves to `M-S-down'.
16745 See `org-ctrl-c-ctrl-c-hook' for more information.")
16746 (defvar org-metareturn-hook nil
16747 "Hook for functions attaching themselves to `M-RET'.
16748 See `org-ctrl-c-ctrl-c-hook' for more information.")
16749 (defvar org-shiftup-hook nil
16750 "Hook for functions attaching themselves to `S-up'.
16751 See `org-ctrl-c-ctrl-c-hook' for more information.")
16752 (defvar org-shiftup-final-hook nil
16753 "Hook for functions attaching themselves to `S-up'.
16754 This one runs after all other options except shift-select have been excluded.
16755 See `org-ctrl-c-ctrl-c-hook' for more information.")
16756 (defvar org-shiftdown-hook nil
16757 "Hook for functions attaching themselves to `S-down'.
16758 See `org-ctrl-c-ctrl-c-hook' for more information.")
16759 (defvar org-shiftdown-final-hook nil
16760 "Hook for functions attaching themselves to `S-down'.
16761 This one runs after all other options except shift-select have been excluded.
16762 See `org-ctrl-c-ctrl-c-hook' for more information.")
16763 (defvar org-shiftleft-hook nil
16764 "Hook for functions attaching themselves to `S-left'.
16765 See `org-ctrl-c-ctrl-c-hook' for more information.")
16766 (defvar org-shiftleft-final-hook nil
16767 "Hook for functions attaching themselves to `S-left'.
16768 This one runs after all other options except shift-select have been excluded.
16769 See `org-ctrl-c-ctrl-c-hook' for more information.")
16770 (defvar org-shiftright-hook nil
16771 "Hook for functions attaching themselves to `S-right'.
16772 See `org-ctrl-c-ctrl-c-hook' for more information.")
16773 (defvar org-shiftright-final-hook nil
16774 "Hook for functions attaching themselves to `S-right'.
16775 This one runs after all other options except shift-select have been excluded.
16776 See `org-ctrl-c-ctrl-c-hook' for more information.")
16778 (defun org-modifier-cursor-error ()
16779 "Throw an error, a modified cursor command was applied in wrong context."
16780 (error "This command is active in special context like tables, headlines or items"))
16782 (defun org-shiftselect-error ()
16783 "Throw an error because Shift-Cursor command was applied in wrong context."
16784 (if (and (boundp 'shift-select-mode) shift-select-mode)
16785 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
16786 (error "This command works only in special context like headlines or timestamps")))
16788 (defun org-call-for-shift-select (cmd)
16789 (let ((this-command-keys-shift-translated t))
16790 (call-interactively cmd)))
16792 (defun org-shifttab (&optional arg)
16793 "Global visibility cycling or move to previous table field.
16794 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
16795 on context.
16796 See the individual commands for more information."
16797 (interactive "P")
16798 (cond
16799 ((org-at-table-p) (call-interactively 'org-table-previous-field))
16800 ((integerp arg)
16801 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
16802 (message "Content view to level: %d" arg)
16803 (org-content (prefix-numeric-value arg2))
16804 (setq org-cycle-global-status 'overview)))
16805 (t (call-interactively 'org-global-cycle))))
16807 (defun org-shiftmetaleft ()
16808 "Promote subtree or delete table column.
16809 Calls `org-promote-subtree', `org-outdent-item',
16810 or `org-table-delete-column', depending on context.
16811 See the individual commands for more information."
16812 (interactive)
16813 (cond
16814 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
16815 ((org-at-table-p) (call-interactively 'org-table-delete-column))
16816 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
16817 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
16818 (t (org-modifier-cursor-error))))
16820 (defun org-shiftmetaright ()
16821 "Demote subtree or insert table column.
16822 Calls `org-demote-subtree', `org-indent-item',
16823 or `org-table-insert-column', depending on context.
16824 See the individual commands for more information."
16825 (interactive)
16826 (cond
16827 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
16828 ((org-at-table-p) (call-interactively 'org-table-insert-column))
16829 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
16830 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
16831 (t (org-modifier-cursor-error))))
16833 (defun org-shiftmetaup (&optional arg)
16834 "Move subtree up or kill table row.
16835 Calls `org-move-subtree-up' or `org-table-kill-row' or
16836 `org-move-item-up' depending on context. See the individual commands
16837 for more information."
16838 (interactive "P")
16839 (cond
16840 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
16841 ((org-at-table-p) (call-interactively 'org-table-kill-row))
16842 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16843 ((org-at-item-p) (call-interactively 'org-move-item-up))
16844 (t (org-modifier-cursor-error))))
16846 (defun org-shiftmetadown (&optional arg)
16847 "Move subtree down or insert table row.
16848 Calls `org-move-subtree-down' or `org-table-insert-row' or
16849 `org-move-item-down', depending on context. See the individual
16850 commands for more information."
16851 (interactive "P")
16852 (cond
16853 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
16854 ((org-at-table-p) (call-interactively 'org-table-insert-row))
16855 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16856 ((org-at-item-p) (call-interactively 'org-move-item-down))
16857 (t (org-modifier-cursor-error))))
16859 (defsubst org-hidden-tree-error ()
16860 (error
16861 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
16863 (defun org-metaleft (&optional arg)
16864 "Promote heading or move table column to left.
16865 Calls `org-do-promote' or `org-table-move-column', depending on context.
16866 With no specific context, calls the Emacs default `backward-word'.
16867 See the individual commands for more information."
16868 (interactive "P")
16869 (cond
16870 ((run-hook-with-args-until-success 'org-metaleft-hook))
16871 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
16872 ((or (org-on-heading-p)
16873 (and (org-region-active-p)
16874 (save-excursion
16875 (goto-char (region-beginning))
16876 (org-on-heading-p))))
16877 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16878 (call-interactively 'org-do-promote))
16879 ((or (org-at-item-p)
16880 (and (org-region-active-p)
16881 (save-excursion
16882 (goto-char (region-beginning))
16883 (org-at-item-p))))
16884 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16885 (call-interactively 'org-outdent-item))
16886 (t (call-interactively 'backward-word))))
16888 (defun org-metaright (&optional arg)
16889 "Demote subtree or move table column to right.
16890 Calls `org-do-demote' or `org-table-move-column', depending on context.
16891 With no specific context, calls the Emacs default `forward-word'.
16892 See the individual commands for more information."
16893 (interactive "P")
16894 (cond
16895 ((run-hook-with-args-until-success 'org-metaright-hook))
16896 ((org-at-table-p) (call-interactively 'org-table-move-column))
16897 ((or (org-on-heading-p)
16898 (and (org-region-active-p)
16899 (save-excursion
16900 (goto-char (region-beginning))
16901 (org-on-heading-p))))
16902 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16903 (call-interactively 'org-do-demote))
16904 ((or (org-at-item-p)
16905 (and (org-region-active-p)
16906 (save-excursion
16907 (goto-char (region-beginning))
16908 (org-at-item-p))))
16909 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16910 (call-interactively 'org-indent-item))
16911 (t (call-interactively 'forward-word))))
16913 (defun org-check-for-hidden (what)
16914 "Check if there are hidden headlines/items in the current visual line.
16915 WHAT can be either `headlines' or `items'. If the current line is
16916 an outline or item heading and it has a folded subtree below it,
16917 this function returns t, nil otherwise."
16918 (let ((re (cond
16919 ((eq what 'headlines) (concat "^" org-outline-regexp))
16920 ((eq what 'items) (concat "^" (org-item-re t)))
16921 (t (error "This should not happen"))))
16922 beg end)
16923 (save-excursion
16924 (catch 'exit
16925 (unless (org-region-active-p)
16926 (setq beg (point-at-bol))
16927 (beginning-of-line 2)
16928 (while (and (not (eobp)) ;; this is like `next-line'
16929 (get-char-property (1- (point)) 'invisible))
16930 (beginning-of-line 2))
16931 (setq end (point))
16932 (goto-char beg)
16933 (goto-char (point-at-eol))
16934 (setq end (max end (point)))
16935 (while (re-search-forward re end t)
16936 (if (get-char-property (match-beginning 0) 'invisible)
16937 (throw 'exit t))))
16938 nil))))
16940 (defun org-metaup (&optional arg)
16941 "Move subtree up or move table row up.
16942 Calls `org-move-subtree-up' or `org-table-move-row' or
16943 `org-move-item-up', depending on context. See the individual commands
16944 for more information."
16945 (interactive "P")
16946 (cond
16947 ((run-hook-with-args-until-success 'org-metaup-hook))
16948 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
16949 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16950 ((org-at-item-p) (call-interactively 'org-move-item-up))
16951 (t (transpose-lines 1) (beginning-of-line -1))))
16953 (defun org-metadown (&optional arg)
16954 "Move subtree down or move table row down.
16955 Calls `org-move-subtree-down' or `org-table-move-row' or
16956 `org-move-item-down', depending on context. See the individual
16957 commands for more information."
16958 (interactive "P")
16959 (cond
16960 ((run-hook-with-args-until-success 'org-metadown-hook))
16961 ((org-at-table-p) (call-interactively 'org-table-move-row))
16962 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16963 ((org-at-item-p) (call-interactively 'org-move-item-down))
16964 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
16966 (defun org-shiftup (&optional arg)
16967 "Increase item in timestamp or increase priority of current headline.
16968 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
16969 depending on context. See the individual commands for more information."
16970 (interactive "P")
16971 (cond
16972 ((run-hook-with-args-until-success 'org-shiftup-hook))
16973 ((and org-support-shift-select (org-region-active-p))
16974 (org-call-for-shift-select 'previous-line))
16975 ((org-at-timestamp-p t)
16976 (call-interactively (if org-edit-timestamp-down-means-later
16977 'org-timestamp-down 'org-timestamp-up)))
16978 ((and (not (eq org-support-shift-select 'always))
16979 org-enable-priority-commands
16980 (org-on-heading-p))
16981 (call-interactively 'org-priority-up))
16982 ((and (not org-support-shift-select) (org-at-item-p))
16983 (call-interactively 'org-previous-item))
16984 ((org-clocktable-try-shift 'up arg))
16985 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
16986 (org-support-shift-select
16987 (org-call-for-shift-select 'previous-line))
16988 (t (org-shiftselect-error))))
16990 (defun org-shiftdown (&optional arg)
16991 "Decrease item in timestamp or decrease priority of current headline.
16992 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
16993 depending on context. See the individual commands for more information."
16994 (interactive "P")
16995 (cond
16996 ((run-hook-with-args-until-success 'org-shiftdown-hook))
16997 ((and org-support-shift-select (org-region-active-p))
16998 (org-call-for-shift-select 'next-line))
16999 ((org-at-timestamp-p t)
17000 (call-interactively (if org-edit-timestamp-down-means-later
17001 'org-timestamp-up 'org-timestamp-down)))
17002 ((and (not (eq org-support-shift-select 'always))
17003 org-enable-priority-commands
17004 (org-on-heading-p))
17005 (call-interactively 'org-priority-down))
17006 ((and (not org-support-shift-select) (org-at-item-p))
17007 (call-interactively 'org-next-item))
17008 ((org-clocktable-try-shift 'down arg))
17009 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17010 (org-support-shift-select
17011 (org-call-for-shift-select 'next-line))
17012 (t (org-shiftselect-error))))
17014 (defun org-shiftright (&optional arg)
17015 "Cycle the thing at point or in the current line, depending on context.
17016 Depending on context, this does one of the following:
17018 - switch a timestamp at point one day into the future
17019 - on a headline, switch to the next TODO keyword.
17020 - on an item, switch entire list to the next bullet type
17021 - on a property line, switch to the next allowed value
17022 - on a clocktable definition line, move time block into the future"
17023 (interactive "P")
17024 (cond
17025 ((run-hook-with-args-until-success 'org-shiftright-hook))
17026 ((and org-support-shift-select (org-region-active-p))
17027 (org-call-for-shift-select 'forward-char))
17028 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17029 ((and (not (eq org-support-shift-select 'always))
17030 (org-on-heading-p))
17031 (let ((org-inhibit-logging
17032 (not org-treat-S-cursor-todo-selection-as-state-change))
17033 (org-inhibit-blocking
17034 (not org-treat-S-cursor-todo-selection-as-state-change)))
17035 (org-call-with-arg 'org-todo 'right)))
17036 ((or (and org-support-shift-select
17037 (not (eq org-support-shift-select 'always))
17038 (org-at-item-bullet-p))
17039 (and (not org-support-shift-select) (org-at-item-p)))
17040 (org-call-with-arg 'org-cycle-list-bullet nil))
17041 ((and (not (eq org-support-shift-select 'always))
17042 (org-at-property-p))
17043 (call-interactively 'org-property-next-allowed-value))
17044 ((org-clocktable-try-shift 'right arg))
17045 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17046 (org-support-shift-select
17047 (org-call-for-shift-select 'forward-char))
17048 (t (org-shiftselect-error))))
17050 (defun org-shiftleft (&optional arg)
17051 "Cycle the thing at point or in the current line, depending on context.
17052 Depending on context, this does one of the following:
17054 - switch a timestamp at point one day into the past
17055 - on a headline, switch to the previous TODO keyword.
17056 - on an item, switch entire list to the previous bullet type
17057 - on a property line, switch to the previous allowed value
17058 - on a clocktable definition line, move time block into the past"
17059 (interactive "P")
17060 (cond
17061 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17062 ((and org-support-shift-select (org-region-active-p))
17063 (org-call-for-shift-select 'backward-char))
17064 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17065 ((and (not (eq org-support-shift-select 'always))
17066 (org-on-heading-p))
17067 (let ((org-inhibit-logging
17068 (not org-treat-S-cursor-todo-selection-as-state-change))
17069 (org-inhibit-blocking
17070 (not org-treat-S-cursor-todo-selection-as-state-change)))
17071 (org-call-with-arg 'org-todo 'left)))
17072 ((or (and org-support-shift-select
17073 (not (eq org-support-shift-select 'always))
17074 (org-at-item-bullet-p))
17075 (and (not org-support-shift-select) (org-at-item-p)))
17076 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17077 ((and (not (eq org-support-shift-select 'always))
17078 (org-at-property-p))
17079 (call-interactively 'org-property-previous-allowed-value))
17080 ((org-clocktable-try-shift 'left arg))
17081 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17082 (org-support-shift-select
17083 (org-call-for-shift-select 'backward-char))
17084 (t (org-shiftselect-error))))
17086 (defun org-shiftcontrolright ()
17087 "Switch to next TODO set."
17088 (interactive)
17089 (cond
17090 ((and org-support-shift-select (org-region-active-p))
17091 (org-call-for-shift-select 'forward-word))
17092 ((and (not (eq org-support-shift-select 'always))
17093 (org-on-heading-p))
17094 (org-call-with-arg 'org-todo 'nextset))
17095 (org-support-shift-select
17096 (org-call-for-shift-select 'forward-word))
17097 (t (org-shiftselect-error))))
17099 (defun org-shiftcontrolleft ()
17100 "Switch to previous TODO set."
17101 (interactive)
17102 (cond
17103 ((and org-support-shift-select (org-region-active-p))
17104 (org-call-for-shift-select 'backward-word))
17105 ((and (not (eq org-support-shift-select 'always))
17106 (org-on-heading-p))
17107 (org-call-with-arg 'org-todo 'previousset))
17108 (org-support-shift-select
17109 (org-call-for-shift-select 'backward-word))
17110 (t (org-shiftselect-error))))
17112 (defun org-ctrl-c-ret ()
17113 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17114 (interactive)
17115 (cond
17116 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17117 (t (call-interactively 'org-insert-heading))))
17119 (defun org-copy-special ()
17120 "Copy region in table or copy current subtree.
17121 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17122 See the individual commands for more information."
17123 (interactive)
17124 (call-interactively
17125 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17127 (defun org-cut-special ()
17128 "Cut region in table or cut current subtree.
17129 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17130 See the individual commands for more information."
17131 (interactive)
17132 (call-interactively
17133 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17135 (defun org-paste-special (arg)
17136 "Paste rectangular region into table, or past subtree relative to level.
17137 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17138 See the individual commands for more information."
17139 (interactive "P")
17140 (if (org-at-table-p)
17141 (org-table-paste-rectangle)
17142 (org-paste-subtree arg)))
17144 (defun org-edit-special (&optional arg)
17145 "Call a special editor for the stuff at point.
17146 When at a table, call the formula editor with `org-table-edit-formulas'.
17147 When at the first line of an src example, call `org-edit-src-code'.
17148 When in an #+include line, visit the include file. Otherwise call
17149 `ffap' to visit the file at point."
17150 (interactive)
17151 ;; possibly prep session before editing source
17152 (when arg
17153 (let* ((info (org-babel-get-src-block-info))
17154 (lang (nth 0 info))
17155 (params (nth 2 info))
17156 (session (cdr (assoc :session params))))
17157 (when (and info session) ;; we are in a source-code block with a session
17158 (funcall
17159 (intern (concat "org-babel-prep-session:" lang)) session params))))
17160 (cond ;; proceed with `org-edit-special'
17161 ((save-excursion
17162 (beginning-of-line 1)
17163 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17164 (find-file (org-trim (match-string 1))))
17165 ((org-edit-src-code))
17166 ((org-edit-fixed-width-region))
17167 ((org-at-table.el-p)
17168 (org-edit-src-code))
17169 ((or (org-at-table-p)
17170 (save-excursion
17171 (beginning-of-line 1)
17173 (call-interactively 'org-table-edit-formulas))
17174 (t (call-interactively 'ffap))))
17176 (defun org-ctrl-c-ctrl-c (&optional arg)
17177 "Set tags in headline, or update according to changed information at point.
17179 This command does many different things, depending on context:
17181 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17182 this is what we do.
17184 - If the cursor is on a statistics cookie, update it.
17186 - If the cursor is in a headline, prompt for tags and insert them
17187 into the current line, aligned to `org-tags-column'. When called
17188 with prefix arg, realign all tags in the current buffer.
17190 - If the cursor is in one of the special #+KEYWORD lines, this
17191 triggers scanning the buffer for these lines and updating the
17192 information.
17194 - If the cursor is inside a table, realign the table. This command
17195 works even if the automatic table editor has been turned off.
17197 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17198 the entire table.
17200 - If the cursor is at a footnote reference or definition, jump to
17201 the corresponding definition or references, respectively.
17203 - If the cursor is a the beginning of a dynamic block, update it.
17205 - If the current buffer is a capture buffer, close note and file it.
17207 - If the cursor is on a <<<target>>>, update radio targets and
17208 corresponding links in this buffer.
17210 - If the cursor is on a numbered item in a plain list, renumber the
17211 ordered list.
17213 - If the cursor is on a checkbox, toggle it.
17215 - If the cursor is on a code block, evaluate it. The variable
17216 `org-confirm-babel-evaluate' can be used to control prompting
17217 before code block evaluation, by default every code block
17218 evaluation requires confirmation. Code block evaluation can be
17219 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17220 (interactive "P")
17221 (let ((org-enable-table-editor t))
17222 (cond
17223 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17224 org-occur-highlights
17225 org-latex-fragment-image-overlays)
17226 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17227 (org-remove-occur-highlights)
17228 (org-remove-latex-fragment-image-overlays)
17229 (message "Temporary highlights/overlays removed from current buffer"))
17230 ((and (local-variable-p 'org-finish-function (current-buffer))
17231 (fboundp org-finish-function))
17232 (funcall org-finish-function))
17233 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17234 ((or (looking-at org-property-start-re)
17235 (org-at-property-p))
17236 (call-interactively 'org-property-action))
17237 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17239 (or (org-on-heading-p) (org-at-item-p)))
17240 (call-interactively 'org-update-statistics-cookies))
17241 ((org-on-heading-p) (call-interactively 'org-set-tags))
17242 ((org-at-table.el-p)
17243 (message "Use C-c ' to edit table.el tables"))
17244 ((org-at-table-p)
17245 (org-table-maybe-eval-formula)
17246 (if arg
17247 (call-interactively 'org-table-recalculate)
17248 (org-table-maybe-recalculate-line))
17249 (call-interactively 'org-table-align)
17250 (orgtbl-send-table 'maybe))
17251 ((or (org-footnote-at-reference-p)
17252 (org-footnote-at-definition-p))
17253 (call-interactively 'org-footnote-action))
17254 ((org-at-item-checkbox-p)
17255 (call-interactively 'org-list-repair)
17256 (call-interactively 'org-toggle-checkbox)
17257 (org-list-send-list 'maybe))
17258 ((org-at-item-p)
17259 (call-interactively 'org-list-repair)
17260 (when arg (call-interactively 'org-toggle-checkbox))
17261 (org-list-send-list 'maybe))
17262 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17263 ;; Dynamic block
17264 (beginning-of-line 1)
17265 (save-excursion (org-update-dblock)))
17266 ((save-excursion
17267 (beginning-of-line 1)
17269 (cond
17270 ((equal (match-string 1) "TBLFM")
17271 ;; Recalculate the table before this line
17272 (save-excursion
17273 (beginning-of-line 1)
17275 (if (org-at-table-p)
17276 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17277 (t
17278 (let ((org-inhibit-startup-visibility-stuff t)
17279 (org-startup-align-all-tables nil))
17280 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17281 (message "Local setup has been refreshed"))))
17282 ((org-clock-update-time-maybe))
17283 (t (error "C-c C-c can do nothing useful at this location")))))
17285 (defun org-mode-restart ()
17286 "Restart Org-mode, to scan again for special lines.
17287 Also updates the keyword regular expressions."
17288 (interactive)
17289 (org-mode)
17290 (message "Org-mode restarted"))
17292 (defun org-kill-note-or-show-branches ()
17293 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17294 (interactive)
17295 (if (not org-finish-function)
17296 (progn
17297 (hide-subtree)
17298 (call-interactively 'show-branches))
17299 (let ((org-note-abort t))
17300 (funcall org-finish-function))))
17302 (defun org-return (&optional indent)
17303 "Goto next table row or insert a newline.
17304 Calls `org-table-next-row' or `newline', depending on context.
17305 See the individual commands for more information."
17306 (interactive)
17307 (cond
17308 ((bobp) (if indent (newline-and-indent) (newline)))
17309 ((org-at-table-p)
17310 (org-table-justify-field-maybe)
17311 (call-interactively 'org-table-next-row))
17312 ((and org-return-follows-link
17313 (eq (get-text-property (point) 'face) 'org-link))
17314 (call-interactively 'org-open-at-point))
17315 ((and (org-at-heading-p)
17316 (looking-at
17318 (org-show-entry)
17319 (end-of-line 1)
17320 (newline))
17321 (t (if indent (newline-and-indent) (newline)))))
17323 (defun org-return-indent ()
17324 "Goto next table row or insert a newline and indent.
17325 Calls `org-table-next-row' or `newline-and-indent', depending on
17326 context. See the individual commands for more information."
17327 (interactive)
17328 (org-return t))
17330 (defun org-ctrl-c-star ()
17331 "Compute table, or change heading status of lines.
17332 Calls `org-table-recalculate' or `org-toggle-heading',
17333 depending on context."
17334 (interactive)
17335 (cond
17336 ((org-at-table-p)
17337 (call-interactively 'org-table-recalculate))
17338 (t
17339 ;; Convert all lines in region to list items
17340 (call-interactively 'org-toggle-heading))))
17342 (defun org-ctrl-c-minus ()
17343 "Insert separator line in table or modify bullet status of line.
17344 Also turns a plain line or a region of lines into list items.
17345 Calls `org-table-insert-hline', `org-toggle-item', or
17346 `org-cycle-list-bullet', depending on context."
17347 (interactive)
17348 (cond
17349 ((org-at-table-p)
17350 (call-interactively 'org-table-insert-hline))
17351 ((org-region-active-p)
17352 (call-interactively 'org-toggle-item))
17353 ((org-in-item-p)
17354 (call-interactively 'org-cycle-list-bullet))
17355 (t
17356 (call-interactively 'org-toggle-item))))
17358 (defun org-toggle-item ()
17359 "Convert headings or normal lines to items, items to normal lines.
17360 If there is no active region, only the current line is considered.
17362 If the first line in the region is a headline, convert all headlines to items.
17364 If the first line in the region is an item, convert all items to normal lines.
17366 If the first line is normal text, add an item bullet to each line."
17367 (interactive)
17368 (let (l2 l beg end)
17369 (if (org-region-active-p)
17370 (setq beg (region-beginning) end (region-end))
17371 (setq beg (point-at-bol)
17372 end (min (1+ (point-at-eol)) (point-max))))
17373 (save-excursion
17374 (goto-char end)
17375 (setq l2 (org-current-line))
17376 (goto-char beg)
17377 (beginning-of-line 1)
17378 (setq l (1- (org-current-line)))
17379 (if (org-at-item-p)
17380 ;; We already have items, de-itemize
17381 (while (< (setq l (1+ l)) l2)
17382 (when (org-at-item-p)
17384 (delete-region (point) (match-end 0)))
17385 (beginning-of-line 2))
17386 (if (org-on-heading-p)
17387 ;; Headings, convert to items
17388 (while (< (setq l (1+ l)) l2)
17389 (if (looking-at org-outline-regexp)
17390 (replace-match (org-list-bullet-string "-") t t))
17391 (beginning-of-line 2))
17392 ;; normal lines, turn them into items
17393 (while (< (setq l (1+ l)) l2)
17394 (unless (org-at-item-p)
17396 (replace-match
17398 (beginning-of-line 2)))))))
17400 (defun org-toggle-heading (&optional nstars)
17401 "Convert headings to normal text, or items or text to headings.
17402 If there is no active region, only the current line is considered.
17404 If the first line is a heading, remove the stars from all headlines
17405 in the region.
17407 If the first line is a plain list item, turn all plain list items
17408 into headings.
17410 If the first line is a normal line, turn each and every line in the
17411 region into a heading.
17413 When converting a line into a heading, the number of stars is chosen
17414 such that the lines become children of the current entry. However,
17415 when a prefix argument is given, its value determines the number of
17416 stars to add."
17417 (interactive "P")
17418 (let (l2 l itemp beg end)
17419 (if (org-region-active-p)
17420 (setq beg (region-beginning) end (region-end))
17421 (setq beg (point-at-bol)
17422 end (min (1+ (point-at-eol)) (point-max))))
17423 (save-excursion
17424 (goto-char end)
17425 (setq l2 (org-current-line))
17426 (goto-char beg)
17427 (beginning-of-line 1)
17428 (setq l (1- (org-current-line)))
17429 (if (org-on-heading-p)
17430 ;; We already have headlines, de-star them
17431 (while (< (setq l (1+ l)) l2)
17432 (when (org-on-heading-p t)
17433 (and (looking-at outline-regexp) (replace-match "")))
17434 (beginning-of-line 2))
17435 (setq itemp (org-at-item-p))
17436 (let* ((stars
17437 (if nstars
17438 (make-string (prefix-numeric-value current-prefix-arg)
17439 ?*)
17440 (save-excursion
17441 (if (re-search-backward org-complex-heading-regexp nil t)
17442 (match-string 1) ""))))
17443 (add-stars (cond (nstars "")
17444 ((equal stars "") "*")
17445 (org-odd-levels-only "**")
17446 (t "*")))
17447 (rpl (concat stars add-stars " ")))
17448 (while (< (setq l (1+ l)) l2)
17449 (if itemp
17450 (and (org-at-item-p) (replace-match rpl t t))
17451 (unless (org-on-heading-p)
17453 (replace-match (concat rpl (match-string 2))))))
17454 (beginning-of-line 2)))))))
17456 (defun org-meta-return (&optional arg)
17457 "Insert a new heading or wrap a region in a table.
17458 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17459 See the individual commands for more information."
17460 (interactive "P")
17461 (cond
17462 ((run-hook-with-args-until-success 'org-metareturn-hook))
17463 ((org-at-table-p)
17464 (call-interactively 'org-table-wrap-region))
17465 (t (call-interactively 'org-insert-heading))))
17467 ;;; Menu entries
17469 ;; Define the Org-mode menus
17470 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
17471 '("Tbl"
17472 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
17473 ["Next Field" org-cycle (org-at-table-p)]
17474 ["Previous Field" org-shifttab (org-at-table-p)]
17475 ["Next Row" org-return (org-at-table-p)]
17476 "--"
17477 ["Blank Field" org-table-blank-field (org-at-table-p)]
17478 ["Edit Field" org-table-edit-field (org-at-table-p)]
17479 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
17480 "--"
17481 ("Column"
17482 ["Move Column Left" org-metaleft (org-at-table-p)]
17483 ["Move Column Right" org-metaright (org-at-table-p)]
17484 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
17485 ["Insert Column" org-shiftmetaright (org-at-table-p)])
17486 ("Row"
17487 ["Move Row Up" org-metaup (org-at-table-p)]
17488 ["Move Row Down" org-metadown (org-at-table-p)]
17489 ["Delete Row" org-shiftmetaup (org-at-table-p)]
17490 ["Insert Row" org-shiftmetadown (org-at-table-p)]
17491 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
17492 "--"
17493 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
17494 ("Rectangle"
17495 ["Copy Rectangle" org-copy-special (org-at-table-p)]
17496 ["Cut Rectangle" org-cut-special (org-at-table-p)]
17497 ["Paste Rectangle" org-paste-special (org-at-table-p)]
17498 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
17499 "--"
17500 ("Calculate"
17501 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
17502 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17503 ["Edit Formulas" org-edit-special (org-at-table-p)]
17504 "--"
17505 ["Recalculate line" org-table-recalculate (org-at-table-p)]
17506 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17507 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
17508 "--"
17509 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
17510 "--"
17511 ["Sum Column/Rectangle" org-table-sum
17512 (or (org-at-table-p) (org-region-active-p))]
17513 ["Which Column?" org-table-current-column (org-at-table-p)])
17514 ["Debug Formulas"
17515 org-table-toggle-formula-debugger
17516 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
17517 ["Show Col/Row Numbers"
17518 org-table-toggle-coordinate-overlays
17519 :style toggle
17520 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
17521 "--"
17522 ["Create" org-table-create (and (not (org-at-table-p))
17523 org-enable-table-editor)]
17524 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
17525 ["Import from File" org-table-import (not (org-at-table-p))]
17526 ["Export to File" org-table-export (org-at-table-p)]
17527 "--"
17528 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
17530 (easy-menu-define org-org-menu org-mode-map "Org menu"
17531 '("Org"
17532 ("Show/Hide"
17533 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
17534 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
17535 ["Sparse Tree..." org-sparse-tree t]
17536 ["Reveal Context" org-reveal t]
17537 ["Show All" show-all t]
17538 "--"
17539 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
17540 "--"
17541 ["New Heading" org-insert-heading t]
17542 ("Navigate Headings"
17543 ["Up" outline-up-heading t]
17544 ["Next" outline-next-visible-heading t]
17545 ["Previous" outline-previous-visible-heading t]
17546 ["Next Same Level" outline-forward-same-level t]
17547 ["Previous Same Level" outline-backward-same-level t]
17548 "--"
17549 ["Jump" org-goto t])
17550 ("Edit Structure"
17551 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
17552 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
17553 "--"
17554 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
17555 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
17556 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
17557 "--"
17558 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
17559 "--"
17560 ["Promote Heading" org-metaleft (not (org-at-table-p))]
17561 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
17562 ["Demote Heading" org-metaright (not (org-at-table-p))]
17563 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
17564 "--"
17565 ["Sort Region/Children" org-sort (not (org-at-table-p))]
17566 "--"
17567 ["Convert to odd levels" org-convert-to-odd-levels t]
17568 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
17569 ("Editing"
17570 ["Emphasis..." org-emphasize t]
17571 ["Edit Source Example" org-edit-special t]
17572 "--"
17573 ["Footnote new/jump" org-footnote-action t]
17574 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
17575 ("Archive"
17576 ["Archive (default method)" org-archive-subtree-default t]
17577 "--"
17578 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
17579 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
17580 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
17581 )
17582 "--"
17583 ("Hyperlinks"
17584 ["Store Link (Global)" org-store-link t]
17585 ["Find existing link to here" org-occur-link-in-agenda-files t]
17586 ["Insert Link" org-insert-link t]
17587 ["Follow Link" org-open-at-point t]
17588 "--"
17589 ["Next link" org-next-link t]
17590 ["Previous link" org-previous-link t]
17591 "--"
17592 ["Descriptive Links"
17593 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
17594 :style radio
17595 :selected (member '(org-link) buffer-invisibility-spec)]
17596 ["Literal Links"
17597 (progn
17598 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
17599 :style radio
17600 :selected (not (member '(org-link) buffer-invisibility-spec))])
17601 "--"
17602 ("TODO Lists"
17603 ["TODO/DONE/-" org-todo t]
17604 ("Select keyword"
17605 ["Next keyword" org-shiftright (org-on-heading-p)]
17606 ["Previous keyword" org-shiftleft (org-on-heading-p)]
17607 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
17608 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
17609 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
17610 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
17611 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
17612 "--"
17613 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
17614 :selected org-enforce-todo-dependencies :style toggle :active t]
17615 "Settings for tree at point"
17616 ["Do Children sequentially" org-toggle-ordered-property :style radio
17617 :selected (ignore-errors (org-entry-get nil "ORDERED"))
17618 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17619 ["Do Children parallel" org-toggle-ordered-property :style radio
17620 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
17621 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17622 "--"
17623 ["Set Priority" org-priority t]
17624 ["Priority Up" org-shiftup t]
17625 ["Priority Down" org-shiftdown t]
17626 "--"
17627 ["Get news from all feeds" org-feed-update-all t]
17628 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
17629 ["Customize feeds" (customize-variable 'org-feed-alist) t])
17630 ("TAGS and Properties"
17631 ["Set Tags" org-set-tags-command t]
17632 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
17633 "--"
17634 ["Set property" org-set-property t]
17635 ["Column view of properties" org-columns t]
17636 ["Insert Column View DBlock" org-insert-columns-dblock t])
17637 ("Dates and Scheduling"
17638 ["Timestamp" org-time-stamp t]
17639 ["Timestamp (inactive)" org-time-stamp-inactive t]
17640 ("Change Date"
17641 ["1 Day Later" org-shiftright t]
17642 ["1 Day Earlier" org-shiftleft t]
17643 ["1 ... Later" org-shiftup t]
17644 ["1 ... Earlier" org-shiftdown t])
17645 ["Compute Time Range" org-evaluate-time-range t]
17646 ["Schedule Item" org-schedule t]
17647 ["Deadline" org-deadline t]
17648 "--"
17649 ["Custom time format" org-toggle-time-stamp-overlays
17650 :style radio :selected org-display-custom-times]
17651 "--"
17652 ["Goto Calendar" org-goto-calendar t]
17653 ["Date from Calendar" org-date-from-calendar t]
17654 "--"
17655 ["Start/Restart Timer" org-timer-start t]
17656 ["Pause/Continue Timer" org-timer-pause-or-continue t]
17657 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
17658 ["Insert Timer String" org-timer t]
17659 ["Insert Timer Item" org-timer-item t])
17660 ("Logging work"
17661 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
17662 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
17663 ["Clock out" org-clock-out t]
17664 ["Clock cancel" org-clock-cancel t]
17665 "--"
17666 ["Mark as default task" org-clock-mark-default-task t]
17667 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
17668 ["Goto running clock" org-clock-goto t]
17669 "--"
17670 ["Display times" org-clock-display t]
17671 ["Create clock table" org-clock-report t]
17672 "--"
17673 ["Record DONE time"
17674 (progn (setq org-log-done (not org-log-done))
17675 (message "Switching to %s will %s record a timestamp"
17676 (car org-done-keywords)
17677 (if org-log-done "automatically" "not")))
17678 :style toggle :selected org-log-done])
17679 "--"
17680 ["Agenda Command..." org-agenda t]
17681 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
17682 ("File List for Agenda")
17683 ("Special views current file"
17684 ["TODO Tree" org-show-todo-tree t]
17685 ["Check Deadlines" org-check-deadlines t]
17686 ["Timeline" org-timeline t]
17687 ["Tags/Property tree" org-match-sparse-tree t])
17688 "--"
17689 ["Export/Publish..." org-export t]
17690 ("LaTeX"
17691 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
17692 :selected org-cdlatex-mode]
17693 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
17694 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
17695 ["Modify math symbol" org-cdlatex-math-modify
17696 (org-inside-LaTeX-fragment-p)]
17697 ["Insert citation" org-reftex-citation t]
17698 "--"
17699 ["Template for BEAMER" org-insert-beamer-options-template t])
17700 "--"
17701 ("MobileOrg"
17702 ["Push Files and Views" org-mobile-push t]
17703 ["Get Captured and Flagged" org-mobile-pull t]
17704 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
17705 "--"
17706 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
17707 "--"
17708 ("Documentation"
17709 ["Show Version" org-version t]
17710 ["Info Documentation" org-info t])
17711 ("Customize"
17712 ["Browse Org Group" org-customize t]
17713 "--"
17714 ["Expand This Menu" org-create-customize-menu
17715 (fboundp 'customize-menu-create)])
17716 ["Send bug report" org-submit-bug-report t]
17717 "--"
17718 ("Refresh/Reload"
17719 ["Refresh setup current buffer" org-mode-restart t]
17720 ["Reload Org (after update)" org-reload t]
17721 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
17722 ))
17724 (defun org-info (&optional node)
17725 "Read documentation for Org-mode in the info system.
17726 With optional NODE, go directly to that node."
17727 (interactive)
17728 (info (format "(org)%s" (or node ""))))
17730 ;;;###autoload
17731 (defun org-submit-bug-report ()
17732 "Submit a bug report on Org-mode via mail.
17734 Don't hesitate to report any problems or inaccurate documentation.
17736 If you don't have setup sending mail from (X)Emacs, please copy the
17737 output buffer into your mail program, as it gives us important
17738 information about your Org-mode version and configuration."
17739 (interactive)
17740 (require 'reporter)
17741 (org-load-modules-maybe)
17742 (org-require-autoloaded-modules)
17743 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
17744 (reporter-submit-bug-report
17745 "emacs-orgmode@gnu.org"
17746 (org-version)
17747 (let (list)
17748 (save-window-excursion
17749 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
17750 (delete-other-windows)
17751 (erase-buffer)
17752 (insert "You are about to submit a bug report to the Org-mode mailing list.
17754 We would like to add your full Org-mode and Outline configuration to the
17755 bug report. This greatly simplifies the work of the maintainer and
17756 other experts on the mailing list.
17758 HOWEVER, some variables you have customized may contain private
17759 information. The names of customers, colleagues, or friends, might
17760 appear in the form of file names, tags, todo states, or search strings.
17761 If you answer yes to the prompt, you might want to check and remove
17762 such private information before sending the email.")
17763 (add-text-properties (point-min) (point-max) '(face org-warning))
17764 (when (yes-or-no-p "Include your Org-mode configuration ")
17765 (mapatoms
17766 (lambda (v)
17767 (and (boundp v)
17769 (or (and (symbol-value v)
17771 (and
17772 (get v 'custom-type) (get v 'standard-value)
17773 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
17774 (push v list)))))
17775 (kill-buffer (get-buffer "*Warn about privacy*"))
17776 list))
17777 nil nil
17778 "Remember to cover the basics, that is, what you expected to happen and
17779 what in fact did happen. You don't know how to make a good report? See
17781 http://orgmode.org/manual/Feedback.html#Feedback
17783 Your bug report will be posted to the Org-mode mailing list.
17784 ------------------------------------------------------------------------")
17785 (save-excursion
17790 (defun org-install-agenda-files-menu ()
17791 (let ((bl (buffer-list)))
17792 (save-excursion
17793 (while bl
17794 (set-buffer (pop bl))
17795 (if (org-mode-p) (setq bl nil)))
17796 (when (org-mode-p)
17797 (easy-menu-change
17798 '("Org") "File List for Agenda"
17799 (append
17800 (list
17801 ["Edit File List" (org-edit-agenda-file-list) t]
17802 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
17803 ["Remove Current File from List" org-remove-file t]
17804 ["Cycle through agenda files" org-cycle-agenda-files t]
17805 ["Occur in all agenda files" org-occur-in-agenda-files t]
17806 "--")
17807 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
17809 ;;;; Documentation
17811 ;;;###autoload
17812 (defun org-require-autoloaded-modules ()
17813 (interactive)
17814 (mapc 'require
17815 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
17816 org-docbook org-exp org-html org-icalendar
17817 org-id org-latex
17818 org-publish org-remember org-table
17819 org-timer org-xoxo)))
17821 ;;;###autoload
17822 (defun org-reload (&optional uncompiled)
17823 "Reload all org lisp files.
17824 With prefix arg UNCOMPILED, load the uncompiled versions."
17825 (interactive "P")
17826 (require 'find-func)
17828 (dir-org (file-name-directory (org-find-library-name "org")))
17829 (dir-org-contrib (ignore-errors
17830 (file-name-directory
17831 (org-find-library-name "org-contribdir"))))
17832 (babel-files
17833 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
17834 (append (list nil "comint" "eval" "exp" "keys"
17835 "lob" "ref" "table" "tangle")
17836 (delq nil
17837 (mapcar
17838 (lambda (lang)
17839 (when (cdr lang) (symbol-name (car lang))))
17840 org-babel-load-languages)))))
17841 (files
17842 (append (directory-files dir-org t file-re)
17843 babel-files
17844 (and dir-org-contrib
17845 (directory-files dir-org-contrib t file-re))))
17846 (remove-re (concat (if (featurep 'xemacs)
17847 "org-colview" "org-colview-xemacs")
17849 (setq files (mapcar 'file-name-sans-extension files))
17850 (setq files (mapcar
17851 (lambda (x) (if (string-match remove-re x) nil x))
17852 files))
17853 (setq files (delq nil files))
17854 (mapc
17855 (lambda (f)
17856 (when (featurep (intern (file-name-nondirectory f)))
17857 (if (and (not uncompiled)
17858 (file-exists-p (concat f ".elc")))
17859 (load (concat f ".elc") nil nil t)
17860 (load (concat f ".el") nil nil t))))
17861 files))
17862 (org-version))
17864 ;;;###autoload
17865 (defun org-customize ()
17866 "Call the customize function with org as argument."
17867 (interactive)
17868 (org-load-modules-maybe)
17869 (org-require-autoloaded-modules)
17870 (customize-browse 'org))
17872 (defun org-create-customize-menu ()
17873 "Create a full customization menu for Org-mode, insert it into the menu."
17874 (interactive)
17875 (org-load-modules-maybe)
17876 (org-require-autoloaded-modules)
17877 (if (fboundp 'customize-menu-create)
17878 (progn
17879 (easy-menu-change
17880 '("Org") "Customize"
17881 `(["Browse Org group" org-customize t]
17882 "--"
17883 ,(customize-menu-create 'org)
17884 ["Set" Custom-set t]
17885 ["Save" Custom-save t]
17886 ["Reset to Current" Custom-reset-current t]
17887 ["Reset to Saved" Custom-reset-saved t]
17888 ["Reset to Standard Settings" Custom-reset-standard t]))
17890 (error "Cannot expand menu (outdated version of cus-edit.el)")))
17892 ;;;; Miscellaneous stuff
17894 ;;; Generally useful functions
17896 (defun org-get-at-bol (property)
17897 "Get text property PROPERTY at beginning of line."
17898 (get-text-property (point-at-bol) property))
17900 (defun org-find-text-property-in-string (prop s)
17901 "Return the first non-nil value of property PROP in string S."
17902 (or (get-text-property 0 prop s)
17903 (get-text-property (or (next-single-property-change 0 prop s) 0)
17904 prop s)))
17906 (defun org-display-warning (message) ;; Copied from Emacs-Muse
17907 "Display the given MESSAGE as a warning."
17908 (if (fboundp 'display-warning)
17909 (display-warning 'org message
17910 (if (featurep 'xemacs) 'warning :warning))
17911 (let ((buf (get-buffer-create "*Org warnings*")))
17912 (with-current-buffer buf
17913 (goto-char (point-max))
17914 (insert "Warning (Org): " message)
17915 (unless (bolp)
17916 (newline)))
17917 (display-buffer buf)
17918 (sit-for 0))))
17920 (defun org-in-commented-line ()
17921 "Is point in a line starting with `#'?"
17922 (equal (char-after (point-at-bol)) ?#))
17924 (defun org-in-indented-comment-line ()
17925 "Is point in a line starting with `#' after some white space?"
17926 (save-excursion
17927 (save-match-data
17928 (goto-char (point-at-bol))
17931 (defun org-in-verbatim-emphasis ()
17932 (save-match-data
17933 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
17935 (defun org-goto-marker-or-bmk (marker &optional bookmark)
17936 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
17937 (if (and marker (marker-buffer marker)
17938 (buffer-live-p (marker-buffer marker)))
17939 (progn
17940 (switch-to-buffer (marker-buffer marker))
17941 (if (or (> marker (point-max)) (< marker (point-min)))
17942 (widen))
17943 (goto-char marker)
17944 (org-show-context 'org-goto))
17945 (if bookmark
17946 (bookmark-jump bookmark)
17947 (error "Cannot find location"))))
17949 (defun org-quote-csv-field (s)
17950 "Quote field for inclusion in CSV material."
17953 s))
17955 (defun org-plist-delete (plist property)
17956 "Delete PROPERTY from PLIST.
17957 This is in contrast to merely setting it to 0."
17958 (let (p)
17959 (while plist
17960 (if (not (eq property (car plist)))
17961 (setq p (plist-put p (car plist) (nth 1 plist))))
17962 (setq plist (cddr plist)))
17963 p))
17965 (defun org-force-self-insert (N)
17966 "Needed to enforce self-insert under remapping."
17967 (interactive "p")
17968 (self-insert-command N))
17970 (defun org-string-width (s)
17971 "Compute width of string, ignoring invisible characters.
17972 This ignores character with invisibility property `org-link', and also
17973 characters with property `org-cwidth', because these will become invisible
17974 upon the next fontification round."
17975 (let (b l)
17976 (when (or (eq t buffer-invisibility-spec)
17977 (assq 'org-link buffer-invisibility-spec))
17978 (while (setq b (text-property-any 0 (length s)
17979 'invisible 'org-link s))
17980 (setq s (concat (substring s 0 b)
17981 (substring s (or (next-single-property-change
17982 b 'invisible s) (length s)))))))
17983 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
17984 (setq s (concat (substring s 0 b)
17985 (substring s (or (next-single-property-change
17986 b 'org-cwidth s) (length s))))))
17987 (setq l (string-width s) b -1)
17988 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
17989 (setq l (- l (get-text-property b 'org-dwidth-n s))))
17990 l))
17992 (defun org-shorten-string (s maxlength)
17993 "Shorten string S so tht it is no longer than MAXLENGTH characters.
17994 If the string is shorter or has length MAXLENGTH, just return the
17995 original string. If it is longer, the functions finds a space in the
17996 string, breaks this string off at that locations and adds three dots
17997 as ellipsis. Including the ellipsis, the string will not be longer
17998 than MAXLENGTH. If finding a good breaking point in the string does
17999 not work, the string is just chopped off in the middle of a word
18000 if necessary."
18001 (if (<= (length s) maxlength)
18002 s
18003 (let* ((n (max (- maxlength 4) 1))
18005 (if (string-match re s)
18006 (concat (match-string 1 s) "...")
18007 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18009 (defun org-get-indentation (&optional line)
18010 "Get the indentation of the current line, interpreting tabs.
18011 When LINE is given, assume it represents a line and compute its indentation."
18012 (if line
18013 (if (string-match "^ *" (org-remove-tabs line))
18014 (match-end 0))
18015 (save-excursion
18016 (beginning-of-line 1)
18018 (current-column))))
18020 (defun org-remove-tabs (s &optional width)
18021 "Replace tabulators in S with spaces.
18022 Assumes that s is a single line, starting in column 0."
18023 (setq width (or width tab-width))
18025 (setq s (replace-match
18026 (make-string
18027 (- (* width (/ (+ (match-beginning 0) width) width))
18028 (match-beginning 0)) ?\ )
18029 t t s)))
18030 s)
18032 (defun org-fix-indentation (line ind)
18033 "Fix indentation in LINE.
18034 IND is a cons cell with target and minimum indentation.
18035 If the current indentation in LINE is smaller than the minimum,
18036 leave it alone. If it is larger than ind, set it to the target."
18037 (let* ((l (org-remove-tabs line))
18038 (i (org-get-indentation l))
18039 (i1 (car ind)) (i2 (cdr ind)))
18040 (if (>= i i2) (setq l (substring line i2)))
18041 (if (> i1 0)
18042 (concat (make-string i1 ?\ ) l)
18043 l)))
18045 (defun org-remove-indentation (code &optional n)
18046 "Remove the maximum common indentation from the lines in CODE.
18047 N may optionally be the number of spaces to remove."
18048 (with-temp-buffer
18049 (insert code)
18050 (org-do-remove-indentation n)
18051 (buffer-string)))
18053 (defun org-do-remove-indentation (&optional n)
18054 "Remove the maximum common indentation from the buffer."
18055 (untabify (point-min) (point-max))
18056 (let ((min 10000) re)
18057 (if n
18058 (setq min n)
18059 (goto-char (point-min))
18061 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18062 (unless (or (= min 0) (= min 10000))
18064 (goto-char (point-min))
18065 (while (re-search-forward re nil t)
18066 (replace-match "")
18067 (end-of-line 1))
18068 min)))
18070 (defun org-fill-template (template alist)
18071 "Find each %key of ALIST in TEMPLATE and replace it."
18072 (let ((case-fold-search nil)
18073 entry key value)
18074 (setq alist (sort (copy-sequence alist)
18075 (lambda (a b) (< (length (car a)) (length (car b))))))
18076 (while (setq entry (pop alist))
18077 (setq template
18078 (replace-regexp-in-string
18079 (concat "%" (regexp-quote (car entry)))
18080 (cdr entry) template t t)))
18081 template))
18083 (defun org-base-buffer (buffer)
18084 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18085 (if (not buffer)
18086 buffer
18087 (or (buffer-base-buffer buffer)
18088 buffer)))
18090 (defun org-trim (s)
18091 "Remove whitespace at beginning and end of string."
18094 s)
18096 (defun org-wrap (string &optional width lines)
18097 "Wrap string to either a number of lines, or a width in characters.
18098 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18099 that costs. If there is a word longer than WIDTH, the text is actually
18100 wrapped to the length of that word.
18101 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18102 many lines, whatever width that takes.
18103 The return value is a list of lines, without newlines at the end."
18105 (maxword (apply 'max (mapcar 'org-string-width words)))
18106 w ll)
18107 (cond (width
18108 (org-do-wrap words (max maxword width)))
18109 (lines
18110 (setq w maxword)
18111 (setq ll (org-do-wrap words maxword))
18112 (if (<= (length ll) lines)
18113 ll
18114 (setq ll words)
18115 (while (> (length ll) lines)
18116 (setq w (1+ w))
18117 (setq ll (org-do-wrap words w)))
18118 ll))
18119 (t (error "Cannot wrap this")))))
18121 (defun org-do-wrap (words width)
18122 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18123 (let (lines line)
18124 (while words
18125 (setq line (pop words))
18126 (while (and words (< (+ (length line) (length (car words))) width))
18127 (setq line (concat line " " (pop words))))
18128 (setq lines (push line lines)))
18129 (nreverse lines)))
18131 (defun org-split-string (string &optional separators)
18132 "Splits STRING into substrings at SEPARATORS.
18133 No empty strings are returned if there are matches at the beginning
18134 and end of string."
18136 (start 0)
18137 notfirst
18138 (list nil))
18139 (while (and (string-match rexp string
18140 (if (and notfirst
18141 (= start (match-beginning 0))
18142 (< start (length string)))
18143 (1+ start) start))
18144 (< (match-beginning 0) (length string)))
18145 (setq notfirst t)
18146 (or (eq (match-beginning 0) 0)
18147 (and (eq (match-beginning 0) (match-end 0))
18148 (eq (match-beginning 0) start))
18149 (setq list
18150 (cons (substring string start (match-beginning 0))
18151 list)))
18152 (setq start (match-end 0)))
18153 (or (eq start (length string))
18154 (setq list
18155 (cons (substring string start)
18156 list)))
18157 (nreverse list)))
18159 (defun org-quote-vert (s)
18161 (while (string-match "|" s)
18163 s)
18165 (defun org-uuidgen-p (s)
18166 "Is S an ID created by UUIDGEN?"
18167 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18169 (defun org-context ()
18170 "Return a list of contexts of the current cursor position.
18171 If several contexts apply, all are returned.
18172 Each context entry is a list with a symbol naming the context, and
18173 two positions indicating start and end of the context. Possible
18174 contexts are:
18176 :headline anywhere in a headline
18177 :headline-stars on the leading stars in a headline
18178 :todo-keyword on a TODO keyword (including DONE) in a headline
18179 :tags on the TAGS in a headline
18180 :priority on the priority cookie in a headline
18181 :item on the first line of a plain list item
18182 :item-bullet on the bullet/number of a plain list item
18183 :checkbox on the checkbox in a plain list item
18184 :table in an org-mode table
18185 :table-special on a special filed in a table
18186 :table-table in a table.el table
18187 :link on a hyperlink
18188 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18189 :target on a <<target>>
18190 :radio-target on a <<<radio-target>>>
18191 :latex-fragment on a LaTeX fragment
18192 :latex-preview on a LaTeX fragment with overlayed preview image
18194 This function expects the position to be visible because it uses font-lock
18195 faces as a help to recognize the following contexts: :table-special, :link,
18196 and :keyword."
18197 (let* ((f (get-text-property (point) 'face))
18198 (faces (if (listp f) f (list f)))
18199 (p (point)) clist o)
18200 ;; First the large context
18201 (cond
18202 ((org-on-heading-p t)
18203 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18204 (when (progn
18205 (beginning-of-line 1)
18206 (looking-at org-todo-line-tags-regexp))
18207 (push (org-point-in-group p 1 :headline-stars) clist)
18208 (push (org-point-in-group p 2 :todo-keyword) clist)
18209 (push (org-point-in-group p 4 :tags) clist))
18210 (goto-char p)
18213 (push (org-point-in-group p 0 :priority) clist)))
18215 ((org-at-item-p)
18216 (push (org-point-in-group p 2 :item-bullet) clist)
18217 (push (list :item (point-at-bol)
18218 (save-excursion (org-end-of-item) (point)))
18219 clist)
18220 (and (org-at-item-checkbox-p)
18221 (push (org-point-in-group p 0 :checkbox) clist)))
18223 ((org-at-table-p)
18224 (push (list :table (org-table-begin) (org-table-end)) clist)
18225 (if (memq 'org-formula faces)
18226 (push (list :table-special
18227 (previous-single-property-change p 'face)
18228 (next-single-property-change p 'face)) clist)))
18229 ((org-at-table-p 'any)
18230 (push (list :table-table) clist)))
18231 (goto-char p)
18233 ;; Now the small context
18234 (cond
18235 ((org-at-timestamp-p)
18236 (push (org-point-in-group p 0 :timestamp) clist))
18237 ((memq 'org-link faces)
18238 (push (list :link
18239 (previous-single-property-change p 'face)
18240 (next-single-property-change p 'face)) clist))
18241 ((memq 'org-special-keyword faces)
18242 (push (list :keyword
18243 (previous-single-property-change p 'face)
18244 (next-single-property-change p 'face)) clist))
18245 ((org-on-target-p)
18246 (push (org-point-in-group p 0 :target) clist)
18247 (goto-char (1- (match-beginning 0)))
18248 (if (looking-at org-radio-target-regexp)
18249 (push (org-point-in-group p 0 :radio-target) clist))
18250 (goto-char p))
18251 ((setq o (car (delq nil
18252 (mapcar
18253 (lambda (x)
18254 (if (memq x org-latex-fragment-image-overlays) x))
18255 (overlays-at (point))))))
18256 (push (list :latex-fragment
18257 (overlay-start o) (overlay-end o)) clist)
18258 (push (list :latex-preview
18259 (overlay-start o) (overlay-end o)) clist))
18260 ((org-inside-LaTeX-fragment-p)
18261 ;; FIXME: positions wrong.
18262 (push (list :latex-fragment (point) (point)) clist)))
18264 (setq clist (nreverse (delq nil clist)))
18265 clist))
18267 ;; FIXME: Compare with at-regexp-p Do we need both?
18268 (defun org-in-regexp (re &optional nlines visually)
18269 "Check if point is inside a match of regexp.
18270 Normally only the current line is checked, but you can include NLINES extra
18271 lines both before and after point into the search.
18272 If VISUALLY is set, require that the cursor is not after the match but
18273 really on, so that the block visually is on the match."
18274 (catch 'exit
18275 (let ((pos (point))
18276 (eol (point-at-eol (+ 1 (or nlines 0))))
18277 (inc (if visually 1 0)))
18278 (save-excursion
18279 (beginning-of-line (- 1 (or nlines 0)))
18280 (while (re-search-forward re eol t)
18281 (if (and (<= (match-beginning 0) pos)
18282 (>= (+ inc (match-end 0)) pos))
18283 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18285 (defun org-at-regexp-p (regexp)
18286 "Is point inside a match of REGEXP in the current line?"
18287 (catch 'exit
18288 (save-excursion
18289 (let ((pos (point)) (end (point-at-eol)))
18290 (beginning-of-line 1)
18291 (while (re-search-forward regexp end t)
18292 (if (and (<= (match-beginning 0) pos)
18293 (>= (match-end 0) pos))
18294 (throw 'exit t)))
18295 nil))))
18297 (defun org-in-regexps-block-p (start-re end-re &optional bound)
18298 "Return t if the current point is between matches of START-RE and END-RE.
18299 This will also return t if point is on one of the two matches or
18300 in an unfinished block. END-RE can be a string or a form
18301 returning a string.
18303 An optional third argument bounds the search for START-RE. It
18304 defaults to previous heading or `point-min'."
18305 (let ((pos (point))
18306 (limit (or bound (save-excursion (outline-previous-heading)))))
18307 (save-excursion
18308 ;; we're on a block when point is on start-re...
18309 (or (org-at-regexp-p start-re)
18310 ;; ... or start-re can be found above...
18311 (and (re-search-backward start-re limit t)
18312 ;; ... but no end-re between start-re and point.
18313 (not (re-search-forward (eval end-re) pos t)))))))
18315 (defun org-occur-in-agenda-files (regexp &optional nlines)
18316 "Call `multi-occur' with buffers for all agenda files."
18318 (let* ((files (org-agenda-files))
18319 (tnames (mapcar 'file-truename files))
18320 (extra org-agenda-text-search-extra-files)
18321 f)
18322 (when (eq (car extra) 'agenda-archives)
18323 (setq extra (cdr extra))
18324 (setq files (org-add-archive-files files)))
18325 (while (setq f (pop extra))
18326 (unless (member (file-truename f) tnames)
18327 (add-to-list 'files f 'append)
18328 (add-to-list 'tnames (file-truename f) 'append)))
18329 (multi-occur
18330 (mapcar (lambda (x)
18331 (with-current-buffer
18332 (or (get-file-buffer x) (find-file-noselect x))
18333 (widen)
18334 (current-buffer)))
18335 files)
18336 regexp)))
18338 (if (boundp 'occur-mode-find-occurrence-hook)
18339 ;; Emacs 23
18340 (add-hook 'occur-mode-find-occurrence-hook
18341 (lambda ()
18342 (when (org-mode-p)
18343 (org-reveal))))
18344 ;; Emacs 22
18345 (defadvice occur-mode-goto-occurrence
18346 (after org-occur-reveal activate)
18347 (and (org-mode-p) (org-reveal)))
18348 (defadvice occur-mode-goto-occurrence-other-window
18349 (after org-occur-reveal activate)
18350 (and (org-mode-p) (org-reveal)))
18351 (defadvice occur-mode-display-occurrence
18352 (after org-occur-reveal activate)
18353 (when (org-mode-p)
18354 (let ((pos (occur-mode-find-occurrence)))
18355 (with-current-buffer (marker-buffer pos)
18356 (save-excursion
18357 (goto-char pos)
18358 (org-reveal)))))))
18360 (defun org-occur-link-in-agenda-files ()
18361 "Create a link and search for it in the agendas.
18362 The link is not stored in `org-stored-links', it is just created
18363 for the search purpose."
18364 (interactive)
18365 (let ((link (condition-case nil
18366 (org-store-link nil)
18367 (error "Unable to create a link to here"))))
18368 (org-occur-in-agenda-files (regexp-quote link))))
18370 (defun org-uniquify (list)
18371 "Remove duplicate elements from LIST."
18372 (let (res)
18373 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
18374 res))
18376 (defun org-delete-all (elts list)
18377 "Remove all elements in ELTS from LIST."
18378 (while elts
18379 (setq list (delete (pop elts) list)))
18380 list)
18382 (defun org-count (cl-item cl-seq)
18383 "Count the number of occurrences of ITEM in SEQ.
18384 Taken from `count' in cl-seq.el with all keyword arguments removed."
18385 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
18386 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
18387 (while (< cl-start cl-end)
18388 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
18389 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
18390 (setq cl-start (1+ cl-start)))
18391 cl-count))
18393 (defun org-remove-if (predicate seq)
18394 "Remove everything from SEQ that fulfills PREDICATE."
18395 (let (res e)
18396 (while seq
18397 (setq e (pop seq))
18398 (if (not (funcall predicate e)) (push e res)))
18399 (nreverse res)))
18401 (defun org-remove-if-not (predicate seq)
18402 "Remove everything from SEQ that does not fulfill PREDICATE."
18403 (let (res e)
18404 (while seq
18405 (setq e (pop seq))
18406 (if (funcall predicate e) (push e res)))
18407 (nreverse res)))
18409 (defun org-back-over-empty-lines ()
18410 "Move backwards over whitespace, to the beginning of the first empty line.
18411 Returns the number of empty lines passed."
18412 (let ((pos (point)))
18414 (beginning-of-line 2)
18415 (goto-char (min (point) pos))
18416 (count-lines (point) pos)))
18418 (defun org-skip-whitespace ()
18421 (defun org-point-in-group (point group &optional context)
18422 "Check if POINT is in match-group GROUP.
18423 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18424 match. If the match group does not exist or point is not inside it,
18425 return nil."
18426 (and (match-beginning group)
18427 (>= point (match-beginning group))
18428 (<= point (match-end group))
18429 (if context
18430 (list context (match-beginning group) (match-end group))
18431 t)))
18433 (defun org-switch-to-buffer-other-window (&rest args)
18434 "Switch to buffer in a second window on the current frame.
18435 In particular, do not allow pop-up frames.
18436 Returns the newly created buffer."
18437 (let (pop-up-frames special-display-buffer-names special-display-regexps
18438 special-display-function)
18439 (apply 'switch-to-buffer-other-window args)))
18441 (defun org-combine-plists (&rest plists)
18442 "Create a single property list from all plists in PLISTS.
18443 The process starts by copying the first list, and then setting properties
18444 from the other lists. Settings in the last list are the most significant
18445 ones and overrule settings in the other lists."
18446 (let ((rtn (copy-sequence (pop plists)))
18447 p v ls)
18448 (while plists
18449 (setq ls (pop plists))
18450 (while ls
18451 (setq p (pop ls) v (pop ls))
18452 (setq rtn (plist-put rtn p v))))
18453 rtn))
18455 (defun org-move-line-down (arg)
18456 "Move the current line down. With prefix argument, move it past ARG lines."
18457 (interactive "p")
18458 (let ((col (current-column))
18459 beg end pos)
18460 (beginning-of-line 1) (setq beg (point))
18461 (beginning-of-line 2) (setq end (point))
18462 (beginning-of-line (+ 1 arg))
18463 (setq pos (move-marker (make-marker) (point)))
18464 (insert (delete-and-extract-region beg end))
18465 (goto-char pos)
18466 (org-move-to-column col)))
18468 (defun org-move-line-up (arg)
18469 "Move the current line up. With prefix argument, move it past ARG lines."
18470 (interactive "p")
18471 (let ((col (current-column))
18472 beg end pos)
18473 (beginning-of-line 1) (setq beg (point))
18474 (beginning-of-line 2) (setq end (point))
18475 (beginning-of-line (- arg))
18476 (setq pos (move-marker (make-marker) (point)))
18477 (insert (delete-and-extract-region beg end))
18478 (goto-char pos)
18479 (org-move-to-column col)))
18481 (defun org-replace-escapes (string table)
18482 "Replace %-escapes in STRING with values in TABLE.
18484 The sequences in STRING may contain normal field width and padding information,
18486 so values can contain further %-escapes if they are define later in TABLE."
18487 (let ((tbl (copy-alist table))
18488 (case-fold-search nil)
18489 (pchg 0)
18490 e re rpl)
18491 (while (setq e (pop tbl))
18492 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
18493 (when (and (cdr e) (string-match re (cdr e)))
18494 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
18495 (safe "SREF"))
18496 (add-text-properties 0 3 (list 'sref sref) safe)
18497 (setcdr e (replace-match safe t t (cdr e)))))
18498 (while (string-match re string)
18499 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
18500 (cdr e)))
18501 (setq string (replace-match rpl t t string))))
18502 (while (setq pchg (next-property-change pchg string))
18503 (let ((sref (get-text-property pchg 'sref string)))
18504 (when (and sref (string-match "SREF" string pchg))
18505 (setq string (replace-match sref t t string)))))
18506 string))
18508 (defun org-sublist (list start end)
18509 "Return a section of LIST, from START to END.
18510 Counting starts at 1."
18511 (let (rtn (c start))
18512 (setq list (nthcdr (1- start) list))
18513 (while (and list (<= c end))
18514 (push (pop list) rtn)
18515 (setq c (1+ c)))
18516 (nreverse rtn)))
18518 (defun org-find-base-buffer-visiting (file)
18519 "Like `find-buffer-visiting' but always return the base buffer and
18520 not an indirect buffer."
18521 (let ((buf (or (get-file-buffer file)
18522 (find-buffer-visiting file))))
18523 (if buf
18524 (or (buffer-base-buffer buf) buf)
18525 nil)))
18527 (defun org-image-file-name-regexp (&optional extensions)
18528 "Return regexp matching the file names of images.
18529 If EXTENSIONS is given, only match these."
18530 (if (and (not extensions) (fboundp 'image-file-name-regexp))
18531 (image-file-name-regexp)
18532 (let ((image-file-name-extensions
18533 (or extensions
18534 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
18535 "xbm" "xpm" "pbm" "pgm" "ppm"))))
18537 (regexp-opt (nconc (mapcar 'upcase
18538 image-file-name-extensions)
18539 image-file-name-extensions)
18540 t)
18543 (defun org-file-image-p (file &optional extensions)
18544 "Return non-nil if FILE is an image."
18545 (save-match-data
18546 (string-match (org-image-file-name-regexp extensions) file)))
18548 (defun org-get-cursor-date ()
18549 "Return the date at cursor in as a time.
18550 This works in the calendar and in the agenda, anywhere else it just
18551 returns the current time."
18552 (let (date day defd)
18553 (cond
18554 ((eq major-mode 'calendar-mode)
18555 (setq date (calendar-cursor-to-date)
18556 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
18557 ((eq major-mode 'org-agenda-mode)
18558 (setq day (get-text-property (point) 'day))
18559 (if day
18560 (setq date (calendar-gregorian-from-absolute day)
18561 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
18562 (nth 2 date))))))
18563 (or defd (current-time))))
18565 (defvar org-agenda-action-marker (make-marker)
18566 "Marker pointing to the entry for the next agenda action.")
18568 (defun org-mark-entry-for-agenda-action ()
18569 "Mark the current entry as target of an agenda action.
18570 Agenda actions are actions executed from the agenda with the key `k',
18571 which make use of the date at the cursor."
18572 (interactive)
18573 (move-marker org-agenda-action-marker
18574 (save-excursion (org-back-to-heading t) (point))
18575 (current-buffer))
18576 (message
18577 "Entry marked for action; press `k' at desired date in agenda or calendar"))
18579 ;;; Paragraph filling stuff.
18580 ;; We want this to be just right, so use the full arsenal.
18582 (defun org-indent-line-function ()
18583 "Indent line depending on context."
18584 (interactive)
18585 (let* ((pos (point))
18586 (itemp (org-at-item-p))
18587 (case-fold-search t)
18589 (inline-task-p (and (featurep 'org-inlinetask)
18590 (org-inlinetask-in-task-p)))
18591 column bpos bcol tpos tcol)
18592 (beginning-of-line 1)
18593 (cond
18594 ;; Comments
18595 ((looking-at "# ") (setq column 0))
18596 ;; Headings
18598 ;; Literal examples
18600 (setq column (org-get-indentation))) ; do nothing
18601 ;; Drawers
18603 (save-excursion (re-search-backward org-drawer-regexp nil t)))
18604 (save-excursion
18605 (goto-char (1- (match-beginning 1)))
18606 (setq column (current-column))))
18607 ;; Special blocks
18609 (save-excursion
18610 (re-search-backward
18612 (setq column (org-get-indentation (match-string 0))))
18615 (save-excursion
18617 (setq column
18618 (if (equal (downcase (match-string 1)) "src")
18619 ;; src blocks: let `org-edit-src-exit' handle them
18620 (org-get-indentation)
18621 (org-get-indentation (match-string 0)))))
18622 ;; Lists
18623 ((org-in-item-p)
18624 (org-beginning-of-item)
18625 (looking-at "[ \t]*\\(\\S-+\\)[ \t]*\\(\\(:?\\[@\\(:?start:\\)?[0-9]+\\][ \t]*\\)?\\[[- X]\\][ \t]*\\|.*? :: \\)?")
18626 (setq bpos (match-beginning 1) tpos (match-end 0)
18627 bcol (progn (goto-char bpos) (current-column))
18628 tcol (progn (goto-char tpos) (current-column)))
18629 (if (> tcol (+ bcol org-description-max-indent))
18630 (setq tcol (+ bcol 5)))
18631 (goto-char pos)
18632 (setq column (if itemp (org-get-indentation) tcol)))
18633 ;; This line has nothing special, look at the previous relevant
18634 ;; line to compute indentation
18635 (t
18636 (beginning-of-line 0)
18637 (while (and (not (bobp))
18638 (not (looking-at org-drawer-regexp))
18639 ;; skip comments, verbatim, empty lines, tables,
18640 ;; inline tasks, lists, drawers and blocks
18642 (re-search-backward org-drawer-regexp nil t))
18646 (and (org-in-item-p) (goto-char (org-list-top-point)))
18647 (and (not inline-task-p)
18648 (featurep 'org-inlinetask)
18649 (org-inlinetask-in-task-p))))
18650 (beginning-of-line 0))
18651 (cond
18652 ;; There was an heading above.
18654 (if (not org-adapt-indentation)
18655 (setq column 0)
18656 (goto-char (match-end 0))
18657 (setq column (current-column))))
18658 ;; A drawer had started and is unfinished
18659 ((looking-at org-drawer-regexp)
18660 (goto-char (1- (match-beginning 1)))
18661 (setq column (current-column)))
18662 ;; Else, nothing noticeable found: get indentation and go on.
18663 (t (setq column (org-get-indentation))))))
18664 ;; Now apply indentation and move cursor accordingly
18665 (goto-char pos)
18666 (if (<= (current-column) (current-indentation))
18667 (org-indent-line-to column)
18668 (save-excursion (org-indent-line-to column)))
18669 ;; Special polishing for properties, see `org-property-format'
18670 (setq column (current-column))
18671 (beginning-of-line 1)
18672 (if (looking-at
18674 (replace-match (concat (match-string 1)
18675 (format org-property-format
18676 (match-string 2) (match-string 3)))
18677 t t))
18678 (org-move-to-column column)))
18680 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
18681 "Variable to store copy of `adaptive-fill-regexp'.
18682 Since `adaptive-fill-regexp' is set to never match, we need to
18683 store a backup of its value before entering `org-mode' so that
18684 the functionality can be provided as a fall-back.")
18686 (defun org-set-autofill-regexps ()
18687 (interactive)
18688 ;; In the paragraph separator we include headlines, because filling
18689 ;; text in a line directly attached to a headline would otherwise
18690 ;; fill the headline as well.
18693 ;; The paragraph starter includes hand-formatted lists.
18694 (org-set-local
18695 'paragraph-start
18696 (concat
18705 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
18706 ;; But only if the user has not turned off tables or fixed-width regions
18707 (org-set-local
18708 'auto-fill-inhibit-regexp
18711 (if (or org-enable-table-editor org-enable-fixed-width-editor)
18712 (concat
18714 (if org-enable-table-editor "|" "")
18715 (if org-enable-fixed-width-editor ":" "")
18716 "]"))))
18717 ;; We use our own fill-paragraph function, to make sure that tables
18718 ;; and fixed-width regions are not wrapped. That function will pass
18719 ;; through to `fill-paragraph' when appropriate.
18720 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
18721 ;; Adaptive filling: To get full control, first make sure that
18722 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
18723 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
18724 (org-set-local 'org-adaptive-fill-regexp-backup
18725 adaptive-fill-regexp))
18727 (org-set-local 'adaptive-fill-function
18728 'org-adaptive-fill-function)
18729 (org-set-local
18730 'align-mode-rules-list
18731 '((org-in-buffer-settings
18733 (modes . '(org-mode))))))
18735 (defun org-fill-paragraph (&optional justify)
18736 "Re-align a table, pass through to fill-paragraph if no table."
18737 (let ((table-p (org-at-table-p))
18738 (table.el-p (org-at-table.el-p)))
18739 (cond ((and (equal (char-after (point-at-bol)) ?*)
18740 (save-excursion (goto-char (point-at-bol))
18741 (looking-at outline-regexp)))
18742 t) ; skip headlines
18743 (table.el-p t) ; skip table.el tables
18744 (table-p (org-table-align) t) ; align org-mode tables
18745 (t nil)))) ; call paragraph-fill
18747 ;; For reference, this is the default value of adaptive-fill-regexp
18750 (defun org-adaptive-fill-function ()
18751 "Return a fill prefix for org-mode files.
18752 In particular, this makes sure hanging paragraphs for hand-formatted lists
18753 work correctly."
18754 (cond
18755 ;; Comment line
18757 (match-string-no-properties 0))
18758 ;; Description list
18760 (save-excursion
18761 (if (> (match-end 1) (+ (match-beginning 1)
18762 org-description-max-indent))
18763 (goto-char (+ (match-beginning 1) 5))
18764 (goto-char (match-end 0)))
18765 (make-string (current-column) ?\ )))
18766 ;; Ordered or unordered list
18768 (save-excursion
18769 (goto-char (match-end 0))
18770 (make-string (current-column) ?\ )))
18771 ;; Other text
18772 ((looking-at org-adaptive-fill-regexp-backup)
18773 (match-string-no-properties 0))))
18775 ;;; Other stuff.
18777 (defun org-toggle-fixed-width-section (arg)
18778 "Toggle the fixed-width export.
18779 If there is no active region, the QUOTE keyword at the current headline is
18780 inserted or removed. When present, it causes the text between this headline
18781 and the next to be exported as fixed-width text, and unmodified.
18782 If there is an active region, this command adds or removes a colon as the
18783 first character of this line. If the first character of a line is a colon,
18784 this line is also exported in fixed-width font."
18785 (interactive "P")
18786 (let* ((cc 0)
18787 (regionp (org-region-active-p))
18788 (beg (if regionp (region-beginning) (point)))
18789 (end (if regionp (region-end)))
18790 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
18791 (case-fold-search nil)
18793 off)
18794 (if regionp
18795 (save-excursion
18796 (goto-char beg)
18797 (setq cc (current-column))
18798 (beginning-of-line 1)
18799 (setq off (looking-at re))
18800 (while (> nlines 0)
18801 (setq nlines (1- nlines))
18802 (beginning-of-line 1)
18803 (cond
18804 (arg
18805 (org-move-to-column cc t)
18807 (forward-line -1))
18808 ((and off (looking-at re))
18809 (replace-match "" t t nil 1))
18810 ((not off) (org-move-to-column cc t) (insert ": ")))
18811 (forward-line 1)))
18812 (save-excursion
18813 (org-back-to-heading)
18814 (if (looking-at (concat outline-regexp
18816 (replace-match "" t t nil 1)
18817 (if (looking-at outline-regexp)
18818 (progn
18819 (goto-char (match-end 0))
18820 (insert org-quote-string " "))))))))
18822 (defun org-reftex-citation ()
18823 "Use reftex-citation to insert a citation into the buffer.
18824 This looks for a line like
18826 #+BIBLIOGRAPHY: foo plain option:-d
18828 and derives from it that foo.bib is the bibliography file relevant
18829 for this document. It then installs the necessary environment for RefTeX
18830 to work in this buffer and calls `reftex-citation' to insert a citation
18831 into the buffer.
18833 Export of such citations to both LaTeX and HTML is handled by the contributed
18834 package org-exp-bibtex by Taru Karttunen."
18835 (interactive)
18836 (let ((reftex-docstruct-symbol 'rds)
18838 rds bib)
18839 (save-excursion
18840 (save-restriction
18841 (widen)
18842 (let ((case-fold-search t)
18844 (if (not (save-excursion
18845 (or (re-search-forward re nil t)
18846 (re-search-backward re nil t))))
18847 (error "No bibliography defined in file")
18848 (setq bib (concat (match-string 1) ".bib")
18849 rds (list (list 'bib bib)))))))
18850 (call-interactively 'reftex-citation)))
18852 ;;;; Functions extending outline functionality
18854 (defun org-beginning-of-line (&optional arg)
18855 "Go to the beginning of the current line. If that is invisible, continue
18856 to a visible line beginning. This makes the function of C-a more intuitive.
18857 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18858 first attempt, and only move to after the tags when the cursor is already
18859 beyond the end of the headline."
18860 (interactive "P")
18861 (let ((pos (point))
18862 (special (if (consp org-special-ctrl-a/e)
18863 (car org-special-ctrl-a/e)
18864 org-special-ctrl-a/e))
18865 refpos)
18866 (if (org-bound-and-true-p line-move-visual)
18867 (beginning-of-visual-line 1)
18868 (beginning-of-line 1))
18869 (if (and arg (fboundp 'move-beginning-of-line))
18870 (call-interactively 'move-beginning-of-line)
18871 (if (bobp)
18872 nil
18873 (backward-char 1)
18874 (if (org-truely-invisible-p)
18875 (while (and (not (bobp)) (org-truely-invisible-p))
18876 (backward-char 1)
18877 (beginning-of-line 1))
18878 (forward-char 1))))
18879 (when special
18880 (cond
18881 ((and (looking-at org-complex-heading-regexp)
18882 (= (char-after (match-end 1)) ?\ ))
18883 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
18884 (point-at-eol)))
18885 (goto-char
18886 (if (eq special t)
18887 (cond ((> pos refpos) refpos)
18888 ((= pos (point)) refpos)
18889 (t (point)))
18890 (cond ((> pos (point)) (point))
18891 ((not (eq last-command this-command)) (point))
18892 (t refpos)))))
18893 ((org-at-item-p)
18894 (goto-char
18895 (if (eq special t)
18896 (cond ((> pos (match-end 4)) (match-end 4))
18897 ((= pos (point)) (match-end 4))
18898 (t (point)))
18899 (cond ((> pos (point)) (point))
18900 ((not (eq last-command this-command)) (point))
18901 (t (match-end 4))))))))
18902 (org-no-warnings
18903 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18905 (defun org-end-of-line (&optional arg)
18906 "Go to the end of the line.
18907 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18908 first attempt, and only move to after the tags when the cursor is already
18909 beyond the end of the headline."
18910 (interactive "P")
18911 (let ((special (if (consp org-special-ctrl-a/e)
18912 (cdr org-special-ctrl-a/e)
18913 org-special-ctrl-a/e)))
18914 (if (or (not special)
18915 (not (org-on-heading-p))
18916 arg)
18917 (call-interactively
18918 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
18919 ((fboundp 'move-end-of-line) 'move-end-of-line)
18920 (t 'end-of-line)))
18921 (let ((pos (point)))
18922 (beginning-of-line 1)
18924 (if (eq special t)
18925 (if (or (< pos (match-beginning 1))
18926 (= pos (match-end 0)))
18927 (goto-char (match-beginning 1))
18928 (goto-char (match-end 0)))
18929 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
18930 (goto-char (match-end 0))
18931 (goto-char (match-beginning 1))))
18932 (call-interactively (if (fboundp 'move-end-of-line)
18933 'move-end-of-line
18934 'end-of-line)))))
18935 (org-no-warnings
18936 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18938 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
18939 (define-key org-mode-map "\C-e" 'org-end-of-line)
18941 (defun org-backward-sentence (&optional arg)
18942 "Go to beginning of sentence, or beginning of table field.
18943 This will call `backward-sentence' or `org-table-beginning-of-field',
18944 depending on context."
18945 (interactive "P")
18946 (cond
18947 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
18948 (t (call-interactively 'backward-sentence))))
18950 (defun org-forward-sentence (&optional arg)
18951 "Go to end of sentence, or end of table field.
18952 This will call `forward-sentence' or `org-table-end-of-field',
18953 depending on context."
18954 (interactive "P")
18955 (cond
18956 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
18957 (t (call-interactively 'forward-sentence))))
18959 (define-key org-mode-map "\M-a" 'org-backward-sentence)
18960 (define-key org-mode-map "\M-e" 'org-forward-sentence)
18962 (defun org-kill-line (&optional arg)
18963 "Kill line, to tags or end of line."
18964 (interactive "P")
18965 (cond
18966 ((or (not org-special-ctrl-k)
18967 (bolp)
18968 (not (org-on-heading-p)))
18969 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
18970 org-ctrl-k-protect-subtree)
18971 (if (or (eq org-ctrl-k-protect-subtree 'error)
18972 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
18973 (error "C-k aborted - would kill hidden subtree")))
18974 (call-interactively 'kill-line))
18976 (kill-region (point) (match-beginning 1))
18977 (org-set-tags nil t))
18978 (t (kill-region (point) (point-at-eol)))))
18980 (define-key org-mode-map "\C-k" 'org-kill-line)
18982 (defun org-yank (&optional arg)
18983 "Yank. If the kill is a subtree, treat it specially.
18984 This command will look at the current kill and check if is a single
18985 subtree, or a series of subtrees[1]. If it passes the test, and if the
18986 cursor is at the beginning of a line or after the stars of a currently
18987 empty headline, then the yank is handled specially. How exactly depends
18988 on the value of the following variables, both set by default.
18990 org-yank-folded-subtrees
18991 When set, the subtree(s) will be folded after insertion, but only
18992 if doing so would now swallow text after the yanked text.
18994 org-yank-adjusted-subtrees
18995 When set, the subtree will be promoted or demoted in order to
18996 fit into the local outline tree structure, which means that the level
18997 will be adjusted so that it becomes the smaller one of the two
18998 *visible* surrounding headings.
19000 Any prefix to this command will cause `yank' to be called directly with
19002 will just
19003 plainly yank the text as it is.
19005 \[1] The test checks if the first non-white line is a heading
19006 and if there are no other headings with fewer stars."
19007 (interactive "P")
19008 (org-yank-generic 'yank arg))
19010 (defun org-yank-generic (command arg)
19011 "Perform some yank-like command.
19013 This function implements the behavior described in the `org-yank'
19014 documentation. However, it has been generalized to work for any
19015 interactive command with similar behavior."
19017 ;; pretend to be command COMMAND
19018 (setq this-command command)
19020 (if arg
19021 (call-interactively command)
19023 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19024 (and (org-kill-is-subtree-p)
19025 (or (bolp)
19027 (string-match
19029 (buffer-substring (point-at-bol) (point)))))))
19030 swallowp)
19031 (cond
19032 ((and subtreep org-yank-folded-subtrees)
19033 (let ((beg (point))
19034 end)
19035 (if (and subtreep org-yank-adjusted-subtrees)
19036 (org-paste-subtree nil nil 'for-yank)
19037 (call-interactively command))
19039 (setq end (point))
19040 (goto-char beg)
19041 (when (and (bolp) subtreep
19042 (not (setq swallowp
19043 (org-yank-folding-would-swallow-text beg end))))
19044 (or (looking-at outline-regexp)
19045 (re-search-forward (concat "^" outline-regexp) end t))
19046 (while (and (< (point) end) (looking-at outline-regexp))
19047 (hide-subtree)
19048 (org-cycle-show-empty-lines 'folded)
19049 (condition-case nil
19050 (outline-forward-same-level 1)
19051 (error (goto-char end)))))
19052 (when swallowp
19053 (message
19054 "Inserted text not folded because that would swallow text"))
19056 (goto-char end)
19058 (beginning-of-line 1)
19059 (push-mark beg 'nomsg)))
19060 ((and subtreep org-yank-adjusted-subtrees)
19061 (let ((beg (point-at-bol)))
19062 (org-paste-subtree nil nil 'for-yank)
19063 (push-mark beg 'nomsg)))
19064 (t
19065 (call-interactively command))))))
19067 (defun org-yank-folding-would-swallow-text (beg end)
19068 "Would hide-subtree at BEG swallow any text after END?"
19069 (let (level)
19070 (save-excursion
19071 (goto-char beg)
19072 (when (or (looking-at outline-regexp)
19073 (re-search-forward (concat "^" outline-regexp) end t))
19074 (setq level (org-outline-level)))
19075 (goto-char end)
19077 (if (or (eobp)
19078 (and (bolp) (looking-at org-outline-regexp)
19079 (<= (org-outline-level) level)))
19080 nil ; Nothing would be swallowed
19081 t)))) ; something would swallow
19083 (define-key org-mode-map "\C-y" 'org-yank)
19085 (defun org-invisible-p ()
19086 "Check if point is at a character currently not visible."
19087 ;; Early versions of noutline don't have `outline-invisible-p'.
19088 (if (fboundp 'outline-invisible-p)
19089 (outline-invisible-p)
19090 (get-char-property (point) 'invisible)))
19092 (defun org-truely-invisible-p ()
19093 "Check if point is at a character currently not visible.
19094 This version does not only check the character property, but also
19095 `visible-mode'."
19096 ;; Early versions of noutline don't have `outline-invisible-p'.
19097 (if (org-bound-and-true-p visible-mode)
19098 nil
19099 (if (fboundp 'outline-invisible-p)
19100 (outline-invisible-p)
19101 (get-char-property (point) 'invisible))))
19103 (defun org-invisible-p2 ()
19104 "Check if point is at a character currently not visible."
19105 (save-excursion
19106 (if (and (eolp) (not (bobp))) (backward-char 1))
19107 ;; Early versions of noutline don't have `outline-invisible-p'.
19108 (if (fboundp 'outline-invisible-p)
19109 (outline-invisible-p)
19110 (get-char-property (point) 'invisible))))
19112 (defun org-back-to-heading (&optional invisible-ok)
19113 "Call `outline-back-to-heading', but provide a better error message."
19114 (condition-case nil
19115 (outline-back-to-heading invisible-ok)
19116 (error (error "Before first headline at position %d in buffer %s"
19117 (point) (current-buffer)))))
19119 (defun org-beginning-of-defun ()
19120 "Go to the beginning of the subtree, i.e. back to the heading."
19121 (org-back-to-heading))
19122 (defun org-end-of-defun ()
19123 "Go to the end of the subtree."
19124 (org-end-of-subtree nil t))
19126 (defun org-before-first-heading-p ()
19127 "Before first heading?"
19128 (save-excursion
19131 (defun org-on-heading-p (&optional ignored)
19132 (outline-on-heading-p t))
19133 (defun org-at-heading-p (&optional ignored)
19134 (outline-on-heading-p t))
19136 (defun org-point-at-end-of-empty-headline ()
19137 "If point is at the end of an empty headline, return t, else nil.
19138 If the heading only contains a TODO keyword, it is still still considered
19139 empty."
19141 (save-excursion
19142 (beginning-of-line 1)
19145 (defun org-at-heading-or-item-p ()
19146 (or (org-on-heading-p) (org-at-item-p)))
19148 (defun org-on-target-p ()
19149 (or (org-in-regexp org-radio-target-regexp)
19150 (org-in-regexp org-target-regexp)))
19152 (defun org-up-heading-all (arg)
19153 "Move to the heading line of which the present line is a subheading.
19154 This function considers both visible and invisible heading lines.
19155 With argument, move up ARG levels."
19156 (if (fboundp 'outline-up-heading-all)
19157 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19158 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19160 (defun org-up-heading-safe ()
19161 "Move to the heading line of which the present line is a subheading.
19162 This version will not throw an error. It will return the level of the
19163 headline found, or nil if no higher level is found.
19165 Also, this function will be a lot faster than `outline-up-heading',
19166 because it relies on stars being the outline starters. This can really
19167 make a significant difference in outlines with very many siblings."
19168 (let (start-level re)
19169 (org-back-to-heading t)
19170 (setq start-level (funcall outline-level))
19171 (if (equal start-level 1)
19172 nil
19174 (if (re-search-backward re nil t)
19175 (funcall outline-level)))))
19177 (defun org-first-sibling-p ()
19178 "Is this heading the first child of its parents?"
19179 (interactive)
19180 (let ((re (concat "^" outline-regexp))
19181 level l)
19182 (unless (org-at-heading-p t)
19183 (error "Not at a heading"))
19184 (setq level (funcall outline-level))
19185 (save-excursion
19186 (if (not (re-search-backward re nil t))
19187 t
19188 (setq l (funcall outline-level))
19189 (< l level)))))
19191 (defun org-goto-sibling (&optional previous)
19192 "Goto the next sibling, even if it is invisible.
19193 When PREVIOUS is set, go to the previous sibling instead. Returns t
19194 when a sibling was found. When none is found, return nil and don't
19195 move point."
19196 (let ((fun (if previous 're-search-backward 're-search-forward))
19197 (pos (point))
19198 (re (concat "^" outline-regexp))
19199 level l)
19200 (when (condition-case nil (org-back-to-heading t) (error nil))
19201 (setq level (funcall outline-level))
19202 (catch 'exit
19203 (or previous (forward-char 1))
19204 (while (funcall fun re nil t)
19205 (setq l (funcall outline-level))
19206 (when (< l level) (goto-char pos) (throw 'exit nil))
19207 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
19208 (goto-char pos)
19209 nil))))
19211 (defun org-show-siblings ()
19212 "Show all siblings of the current headline."
19213 (save-excursion
19214 (while (org-goto-sibling) (org-flag-heading nil)))
19215 (save-excursion
19216 (while (org-goto-sibling 'previous)
19217 (org-flag-heading nil))))
19219 (defun org-goto-first-child ()
19220 "Goto the first child, even if it is invisible.
19221 Return t when a child was found. Otherwise don't move point and
19222 return nil."
19223 (let (level (pos (point)) (re (concat "^" outline-regexp)))
19224 (when (condition-case nil (org-back-to-heading t) (error nil))
19225 (setq level (outline-level))
19226 (forward-char 1)
19227 (if (and (re-search-forward re nil t) (> (outline-level) level))
19228 (progn (goto-char (match-beginning 0)) t)
19229 (goto-char pos) nil))))
19231 (defun org-show-hidden-entry ()
19232 "Show an entry where even the heading is hidden."
19233 (save-excursion
19234 (org-show-entry)))
19236 (defun org-flag-heading (flag &optional entry)
19237 "Flag the current heading. FLAG non-nil means make invisible.
19238 When ENTRY is non-nil, show the entire entry."
19239 (save-excursion
19240 (org-back-to-heading t)
19241 ;; Check if we should show the entire entry
19242 (if entry
19243 (progn
19244 (org-show-entry)
19245 (save-excursion
19246 (and (outline-next-heading)
19247 (org-flag-heading nil))))
19248 (outline-flag-region (max (point-min) (1- (point)))
19249 (save-excursion (outline-end-of-heading) (point))
19250 flag))))
19252 (defun org-get-next-sibling ()
19253 "Move to next heading of the same level, and return point.
19254 If there is no such heading, return nil.
19255 This is like outline-next-sibling, but invisible headings are ok."
19256 (let ((level (funcall outline-level)))
19257 (outline-next-heading)
19258 (while (and (not (eobp)) (> (funcall outline-level) level))
19259 (outline-next-heading))
19260 (if (or (eobp) (< (funcall outline-level) level))
19261 nil
19262 (point))))
19264 (defun org-get-last-sibling ()
19265 "Move to previous heading of the same level, and return point.
19266 If there is no such heading, return nil."
19267 (let ((opoint (point))
19268 (level (funcall outline-level)))
19269 (outline-previous-heading)
19270 (when (and (/= (point) opoint) (outline-on-heading-p t))
19271 (while (and (> (funcall outline-level) level)
19272 (not (bobp)))
19273 (outline-previous-heading))
19274 (if (< (funcall outline-level) level)
19275 nil
19276 (point)))))
19278 (defun org-end-of-subtree (&optional invisible-OK to-heading)
19279 ;; This contains an exact copy of the original function, but it uses
19280 ;; `org-back-to-heading', to make it work also in invisible
19281 ;; trees. And is uses an invisible-OK argument.
19282 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
19283 ;; Furthermore, when used inside Org, finding the end of a large subtree
19284 ;; with many children and grandchildren etc, this can be much faster
19285 ;; than the outline version.
19286 (org-back-to-heading invisible-OK)
19287 (let ((first t)
19288 (level (funcall outline-level)))
19289 (if (and (org-mode-p) (< level 1000))
19290 ;; A true heading (not a plain list item), in Org-mode
19291 ;; This means we can easily find the end by looking
19292 ;; only for the right number of stars. Using a regexp to do
19293 ;; this is so much faster than using a Lisp loop.
19295 (forward-char 1)
19296 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
19297 ;; something else, do it the slow way
19298 (while (and (not (eobp))
19299 (or first (> (funcall outline-level) level)))
19300 (setq first nil)
19301 (outline-next-heading)))
19302 (unless to-heading
19304 (progn
19305 ;; Go to end of line before heading
19306 (forward-char -1)
19308 ;; leave blank line before heading
19309 (forward-char -1))))))
19310 (point))
19312 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
19313 "Use Org version in org-mode, for dramatic speed-up."
19314 (if (eq major-mode 'org-mode)
19315 (progn
19316 (org-end-of-subtree nil t)
19317 (unless (eobp) (backward-char 1)))
19318 ad-do-it))
19320 (defun org-forward-same-level (arg &optional invisible-ok)
19321 "Move forward to the arg'th subheading at same level as this one.
19322 Stop at the first and last subheadings of a superior heading.
19323 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
19324 it wil also look at invisible ones."
19325 (interactive "p")
19326 (org-back-to-heading invisible-ok)
19327 (org-on-heading-p)
19328 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19330 l)
19331 (forward-char 1)
19332 (while (> arg 0)
19333 (while (and (re-search-forward re nil 'move)
19334 (setq l (- (match-end 0) (match-beginning 0) 1))
19335 (= l level)
19336 (not invisible-ok)
19337 (progn (backward-char 1) (org-invisible-p)))
19338 (if (< l level) (setq arg 1)))
19339 (setq arg (1- arg)))
19340 (beginning-of-line 1)))
19342 (defun org-backward-same-level (arg &optional invisible-ok)
19343 "Move backward to the arg'th subheading at same level as this one.
19344 Stop at the first and last subheadings of a superior heading."
19345 (interactive "p")
19346 (org-back-to-heading)
19347 (org-on-heading-p)
19348 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19350 l)
19351 (while (> arg 0)
19352 (while (and (re-search-backward re nil 'move)
19353 (setq l (- (match-end 0) (match-beginning 0) 1))
19354 (= l level)
19355 (not invisible-ok)
19356 (org-invisible-p))
19357 (if (< l level) (setq arg 1)))
19358 (setq arg (1- arg)))))
19360 (defun org-show-subtree ()
19361 "Show everything after this heading at deeper levels."
19362 (outline-flag-region
19363 (point)
19364 (save-excursion
19365 (org-end-of-subtree t t))
19366 nil))
19368 (defun org-show-entry ()
19369 "Show the body directly following this heading.
19370 Show the heading too, if it is currently invisible."
19371 (interactive)
19372 (save-excursion
19373 (condition-case nil
19374 (progn
19375 (org-back-to-heading t)
19376 (outline-flag-region
19377 (max (point-min) (1- (point)))
19378 (save-excursion
19379 (if (re-search-forward
19381 (match-beginning 1)
19382 (point-max)))
19383 nil)
19384 (org-cycle-hide-drawers 'children))
19385 (error nil))))
19387 (defun org-make-options-regexp (kwds &optional extra)
19388 "Make a regular expression for keyword lines."
19389 (concat
19390 "^"
19397 ;; Make isearch reveal the necessary context
19398 (defun org-isearch-end ()
19399 "Reveal context after isearch exits."
19400 (when isearch-success ; only if search was successful
19401 (if (featurep 'xemacs)
19402 ;; Under XEmacs, the hook is run in the correct place,
19403 ;; we directly show the context.
19404 (org-show-context 'isearch)
19405 ;; In Emacs the hook runs *before* restoring the overlays.
19406 ;; So we have to use a one-time post-command-hook to do this.
19407 ;; (Emacs 22 has a special variable, see function `org-mode')
19408 (unless (and (boundp 'isearch-mode-end-hook-quit)
19409 isearch-mode-end-hook-quit)
19410 ;; Only when the isearch was not quitted.
19411 (org-add-hook 'post-command-hook 'org-isearch-post-command
19412 'append 'local)))))
19414 (defun org-isearch-post-command ()
19415 "Remove self from hook, and show context."
19416 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
19417 (org-show-context 'isearch))
19420 ;;;; Integration with and fixes for other packages
19422 ;;; Imenu support
19424 (defvar org-imenu-markers nil
19425 "All markers currently used by Imenu.")
19426 (make-variable-buffer-local 'org-imenu-markers)
19428 (defun org-imenu-new-marker (&optional pos)
19429 "Return a new marker for use by Imenu, and remember the marker."
19430 (let ((m (make-marker)))
19431 (move-marker m (or pos (point)))
19432 (push m org-imenu-markers)
19433 m))
19435 (defun org-imenu-get-tree ()
19436 "Produce the index for Imenu."
19437 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
19438 (setq org-imenu-markers nil)
19439 (let* ((n org-imenu-depth)
19440 (re (concat "^" outline-regexp))
19441 (subs (make-vector (1+ n) nil))
19442 (last-level 0)
19443 m level head)
19444 (save-excursion
19445 (save-restriction
19446 (widen)
19447 (goto-char (point-max))
19448 (while (re-search-backward re nil t)
19449 (setq level (org-reduced-level (funcall outline-level)))
19450 (when (<= level n)
19451 (looking-at org-complex-heading-regexp)
19452 (setq head (org-link-display-format
19453 (org-match-string-no-properties 4))
19454 m (org-imenu-new-marker))
19455 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
19456 (if (>= level last-level)
19457 (push (cons head m) (aref subs level))
19458 (push (cons head (aref subs (1+ level))) (aref subs level))
19459 (loop for i from (1+ level) to n do (aset subs i nil)))
19460 (setq last-level level)))))
19461 (aref subs 1)))
19463 (eval-after-load "imenu"
19464 '(progn
19465 (add-hook 'imenu-after-jump-hook
19466 (lambda ()
19467 (if (eq major-mode 'org-mode)
19468 (org-show-context 'org-goto))))))
19470 (defun org-link-display-format (link)
19471 "Replace a link with either the description, or the link target
19472 if no description is present"
19473 (save-match-data
19474 (if (string-match org-bracket-link-analytic-regexp link)
19475 (replace-match (if (match-end 5)
19476 (match-string 5 link)
19477 (concat (match-string 1 link)
19478 (match-string 3 link)))
19479 nil t link)
19480 link)))
19482 ;; Speedbar support
19484 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
19485 "Overlay marking the agenda restriction line in speedbar.")
19486 (overlay-put org-speedbar-restriction-lock-overlay
19487 'face 'org-agenda-restriction-lock)
19488 (overlay-put org-speedbar-restriction-lock-overlay
19489 'help-echo "Agendas are currently limited to this item.")
19490 (org-detach-overlay org-speedbar-restriction-lock-overlay)
19492 (defun org-speedbar-set-agenda-restriction ()
19493 "Restrict future agenda commands to the location at point in speedbar.
19495 (interactive)
19496 (require 'org-agenda)
19497 (let (p m tp np dir txt)
19498 (cond
19499 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19500 'org-imenu t))
19501 (setq m (get-text-property p 'org-imenu-marker))
19502 (with-current-buffer (marker-buffer m)
19503 (goto-char m)
19504 (org-agenda-set-restriction-lock 'subtree)))
19505 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19506 'speedbar-function 'speedbar-find-file))
19507 (setq tp (previous-single-property-change
19508 (1+ p) 'speedbar-function)
19509 np (next-single-property-change
19510 tp 'speedbar-function)
19511 dir (speedbar-line-directory)
19512 txt (buffer-substring-no-properties (or tp (point-min))
19513 (or np (point-max))))
19514 (with-current-buffer (find-file-noselect
19515 (let ((default-directory dir))
19516 (expand-file-name txt)))
19517 (unless (org-mode-p)
19518 (error "Cannot restrict to non-Org-mode file"))
19519 (org-agenda-set-restriction-lock 'file)))
19520 (t (error "Don't know how to restrict Org-mode's agenda")))
19521 (move-overlay org-speedbar-restriction-lock-overlay
19522 (point-at-bol) (point-at-eol))
19523 (setq current-prefix-arg nil)
19524 (org-agenda-maybe-redo)))
19526 (eval-after-load "speedbar"
19527 '(progn
19528 (speedbar-add-supported-extension ".org")
19529 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
19530 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
19531 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
19532 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19533 (add-hook 'speedbar-visiting-tag-hook
19534 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
19536 ;;; Fixes and Hacks for problems with other packages
19538 ;; Make flyspell not check words in links, to not mess up our keymap
19539 (defun org-mode-flyspell-verify ()
19540 "Don't let flyspell put overlays at active buttons."
19541 (and (not (get-text-property (max (1- (point)) (point-min)) 'keymap))
19542 (not (get-text-property (max (1- (point)) (point-min)) 'org-no-flyspell))))
19544 (defun org-remove-flyspell-overlays-in (beg end)
19545 "Remove flyspell overlays in region."
19546 (and (org-bound-and-true-p flyspell-mode)
19547 (fboundp 'flyspell-delete-region-overlays)
19548 (flyspell-delete-region-overlays beg end))
19549 (add-text-properties beg end '(org-no-flyspell t)))
19551 ;; Make `bookmark-jump' shows the jump location if it was hidden.
19552 (eval-after-load "bookmark"
19553 '(if (boundp 'bookmark-after-jump-hook)
19554 ;; We can use the hook
19555 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
19556 ;; Hook not available, use advice
19557 (defadvice bookmark-jump (after org-make-visible activate)
19558 "Make the position visible."
19559 (org-bookmark-jump-unhide))))
19561 ;; Make sure saveplace shows the location if it was hidden
19562 (eval-after-load "saveplace"
19563 '(defadvice save-place-find-file-hook (after org-make-visible activate)
19564 "Make the position visible."
19565 (org-bookmark-jump-unhide)))
19567 ;; Make sure ecb shows the location if it was hidden
19568 (eval-after-load "ecb"
19569 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
19570 "Make hierarchy visible when jumping into location from ECB tree buffer."
19571 (if (eq major-mode 'org-mode)
19572 (org-show-context))))
19574 (defun org-bookmark-jump-unhide ()
19575 "Unhide the current position, to show the bookmark location."
19576 (and (org-mode-p)
19577 (or (org-invisible-p)
19578 (save-excursion (goto-char (max (point-min) (1- (point))))
19579 (org-invisible-p)))
19580 (org-show-context 'bookmark-jump)))
19582 ;; Make session.el ignore our circular variable
19583 (eval-after-load "session"
19584 '(add-to-list 'session-globals-exclude 'org-mark-ring))
19586 ;;;; Experimental code
19588 (defun org-closed-in-range ()
19589 "Sparse tree of items closed in a certain time range.
19590 Still experimental, may disappear in the future."
19591 (interactive)
19592 ;; Get the time interval from the user.
19593 (let* ((time1 (org-float-time
19594 (org-read-date nil 'to-time nil "Starting date: ")))
19595 (time2 (org-float-time
19596 (org-read-date nil 'to-time nil "End date:")))
19597 ;; callback function
19598 (callback (lambda ()
19599 (let ((time
19600 (org-float-time
19601 (apply 'encode-time
19602 (org-parse-time-string
19603 (match-string 1))))))
19604 ;; check if time in interval
19605 (and (>= time time1) (<= time time2))))))
19606 ;; make tree, check each match with the callback
19609 ;;;; Finish up
19611 (provide 'org)
19613 (run-hooks 'org-load-hook)
19615 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
19617 ;;; org.el ends here