| blob | 53039e48bc1c587c165691f5df121db54fe47814 |
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.4
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 %d date
1325 %m message-id.
1327 You may use normal field width specification between the % and the letter.
1328 This is for example useful to limit the length of the subject.
1342 It should match if the message is from the user him/herself."
1347 "Non-nil means storing a link to an Org file will use entry IDs.
1349 Note that before this variable is even considered, org-id must be loaded,
1350 so please customize `org-modules' and turn it on.
1352 The variable can have the following values:
1354 t Create an ID if needed to make a link to the current entry.
1356 create-if-interactive
1357 If `org-store-link' is called directly (interactively, as a user
1358 command), do create an ID to support the link. But when doing the
1359 job for remember, only use the ID if it already exists. The
1360 purpose of this setting is to avoid proliferation of unwanted
1361 IDs, just because you happen to be in an Org file when you
1362 call `org-remember' that automatically and preemptively
1363 creates a link. If you do want to get an ID link in a remember
1364 template to an entry not having an ID, create it first by
1365 explicitly creating a link to it, using `C-c C-l' first.
1367 create-if-interactive-and-no-custom-id
1368 Like create-if-interactive, but do not create an ID if there is
1369 a CUSTOM_ID property defined in the entry. This is the default.
1371 use-existing
1372 Use existing ID, do not create one.
1374 nil Never use an ID to make a link, instead link using a text search for
1375 the headline text."
1380 create-if-interactive)
1382 create-if-interactive-and-no-custom-id)
1387 "Non-nil means file links from `org-store-link' contain context.
1388 A search string will be added to the file name with :: as separator and
1389 used to find the context when the link is activated by the command
1390 `org-open-at-point'. When this option is t, the entire active region
1391 will be placed in the search string of the file link. If set to a
1392 positive integer, only the first n lines of context will be stored.
1395 negates this setting for the duration of the command."
1400 "Non-nil means keep link in list for entire session.
1402 The command `org-store-link' adds a link pointing to the current
1403 location to an internal list. These links accumulate during a session.
1404 The command `org-insert-link' can be used to insert links into any
1405 Org-mode file (offering completion for all stored links). When this
1407 will be removed from the list, to make completing the unused links
1408 more efficient."
1413 "Options concerning following links in Org-mode."
1418 "Function to translate links with different syntax to Org syntax.
1419 This can be used to translate links created for example by the Planner
1420 or emacs-wiki packages to Org syntax.
1421 The function must accept two parameters, a TYPE containing the link
1423 which is everything after the link protocol. It should return a cons
1424 with possibly modified values of type and path.
1425 Org contains a function for this, so if you set this variable to
1426 `org-translate-link-from-planner', you should be able follow many
1427 links created by planner."
1432 "Hook that is run after a link has been followed."
1437 "Non-nil means on links TAB will follow the link.
1438 Needs to be set before org.el is loaded.
1439 This really should not be used, it does not make sense, and the
1440 implementation is bad."
1445 "Non-nil means on links RET will follow the link."
1451 "Non-nil means mouse-1 on a link will follow the link.
1452 A longer mouse click will still set point. Does not work on XEmacs.
1453 Needs to be set before org.el is loaded."
1458 "Number of different positions to be recorded in the ring.
1459 Changing this requires a restart of Emacs to work correctly."
1464 "Non-nil means internal links in Org files must exactly match a headline.
1465 When nil, the link search tries to match a phrase will all words
1466 in the search text."
1472 query-to-create)))
1479 "Setup the frame configuration for following links.
1480 When following a link with Emacs, it may often be useful to display
1481 this link in another window or frame. This variable can be used to
1482 set this up for the different types of links.
1483 For VM, use any of
1484 `vm-visit-folder'
1485 `vm-visit-folder-other-frame'
1486 For Gnus, use any of
1487 `gnus'
1488 `gnus-other-frame'
1489 `org-gnus-no-new-news'
1490 For FILE, use any of
1491 `find-file'
1492 `find-file-other-window'
1493 `find-file-other-frame'
1494 For Wanderlust use any of
1495 `wl'
1496 `wl-other-frame'
1497 For the calendar, use the variable `calendar-setup'.
1498 For BBDB, it is currently only possible to display the matches in
1499 another window."
1523 "Non-nil means use indirect buffer to display infile links.
1524 Activating internal links (from one location in a file to another location
1525 in the same file) normally just jumps to the location. When the link is
1527 is displayed in
1528 another window. When this option is set, the other window actually displays
1529 an indirect buffer clone of the current buffer, to avoid any visibility
1530 changes to the current buffer."
1535 "Non-nil means `org-open-file' will open non-existing files.
1536 When nil, an error will be generated.
1537 This variable applies only to external applications because they
1538 might choke on non-existing files. If the link is to a file that
1539 will be opened in Emacs, the variable is ignored."
1544 "Non-nil means a link to a directory really means to index.org.
1545 When nil, following a directory link will run dired or open a finder/explorer
1546 window on that directory."
1551 "Function and arguments to call for following mailto links.
1552 This is a list with the first element being a Lisp function, and the
1553 remaining elements being arguments to the function. In string arguments,
1554 %a will be replaced by the address, and %s will be replaced by the subject
1555 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1564 "Non-nil means ask for confirmation before executing shell links.
1565 Shell links can be dangerous: just think about a link
1567 [[shell:rm -rf ~/*][Google Search]]
1570 but really it would remove your entire home directory.
1571 Therefore we advise against setting this variable to nil.
1572 Just change it to `y-or-n-p' if you want to confirm with a
1580 'safe-local-variable
1584 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1585 Elisp links can be dangerous: just think about a link
1590 but really it would remove your entire home directory.
1591 Therefore we advise against setting this variable to nil.
1592 Just change it to `y-or-n-p' if you want to confirm with a
1600 'safe-local-variable
1607 "Default file applications on a UNIX or GNU/Linux system.
1618 "Default file applications on a MacOS X system.
1620 for some files for which the OS does not have a good default.
1628 'mswindows-shell-execute
1633 'mswindows-shell-execute
1636 "Default file applications on a Windows NT system.
1641 '(
1646 )
1647 "External applications for opening `file:path' items in a document.
1648 Org-mode uses system defaults for different file types, but
1649 you can use this variable to set the application for a given file
1650 extension. The entries in this list are cons cells where the car identifies
1651 files and the cdr the corresponding command. Possible values for the
1652 file identifier are
1654 ways, depending on its contents:
1656 - Alphanumeric characters only:
1657 Match links with this file extension.
1659 to open PDFs with evince.
1661 - Regular expression: Match links where the
1662 filename matches the regexp. If you want to
1663 use groups here, use shy groups.
1667 to open *.html and *.xhtml with firefox.
1669 - Regular expression which contains (non-shy) groups:
1671 anything after that, matches the regexp.
1672 In a custom command string, %1, %2, etc. are replaced with
1673 the parts of the link that were matched by the groups.
1674 For backwards compatibility, if a command string is given
1675 that does not use any of the group matches, this case is
1676 handled identically to the second one (i.e. match against
1677 file name only).
1678 In a custom lisp form, you can access the group matches with
1679 (match-string n link).
1682 to open [[file:document.pdf::5]] with evince at page 5.
1684 `directory' Matches a directory
1685 `remote' Matches a remote file, accessible through tramp or efs.
1686 Remote files most likely should be visited through Emacs
1687 because external applications cannot handle such paths.
1688 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1689 so all files Emacs knows how to handle. Using this with
1690 command `emacs' will open most files in Emacs. Beware that this
1691 will also open html files inside Emacs, unless you add
1693 t Default for files not matched by any of the other options.
1694 `system' The system command to open files, like `open' on Windows
1695 and Mac OS X, and mailcap under GNU/Linux. This is the command
1696 that will be selected if you call `C-c C-o' with a double
1699 Possible values for the command are:
1700 `emacs' The file will be visited by the current Emacs process.
1701 `default' Use the default application for this file type, which is the
1702 association for t in the list, most likely in the system-specific
1703 part.
1704 This can be used to overrule an unwanted setting in the
1705 system-specific variable.
1707 This command is specified by the entry whose car is `system'.
1708 Most likely, the system-specific version of this variable
1709 does define this command, but you can overrule/replace it
1710 here.
1711 string A command to be executed by a shell; %s will be replaced
1712 by the path to the file.
1713 sexp A Lisp form which will be evaluated. The file path will
1714 be available in the Lisp variable `file'.
1715 For more examples, see the system specific constants
1716 `org-file-apps-defaults-macosx'
1717 `org-file-apps-defaults-windowsnt'
1718 `org-file-apps-defaults-gnu'."
1728 auto-mode))
1739 "Options concerning refiling entries in Org-mode."
1744 "Directory with org files.
1745 This is just a default location to look for Org files. There is no need
1746 at all to put your files into this directory. It is only used in the
1747 following situations:
1749 1. When a remember template specifies a target file that is not an
1750 absolute path. The path will then be interpreted relative to
1751 `org-directory'
1752 2. When a remember note is filed away in an interactive way (when exiting the
1753 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1754 with `org-directory' as the default path."
1760 "Default target for storing notes.
1761 Used as a fall back file for org-remember.el and org-capture.el, for
1762 templates that do not specify a target file."
1767 file))
1770 "The default interface to be used for `org-goto'.
1771 Allowed values are:
1772 outline The interface shows an outline of the relevant file
1773 and the correct heading is found by moving through
1774 the outline or by searching with incremental search.
1775 outline-path-completion Headlines in the current buffer are offered via
1776 completion. This is the interface also used by
1777 the refile command."
1784 "Maximum target level when running `org-goto' with refile interface."
1789 "Non-nil means store new notes at the beginning of a file or entry.
1790 When nil, new notes will be filed to the end of a file or entry.
1791 This can also be a list with cons cells of regular expressions that
1792 are matched against file names, and values."
1802 "Information to record when a task is refiled.
1804 Possible values are:
1806 nil Don't add anything
1807 time Add a time stamp to the task
1808 note Prompt for a note and add it with template `org-log-note-headings'
1810 This option can also be set with on a per-file-basis with
1812 #+STARTUP: nologrefile
1813 #+STARTUP: logrefile
1814 #+STARTUP: lognoterefile
1816 You can have local logging settings for a subtree by setting the LOGGING
1817 property to one or more of these keywords.
1819 When bulk-refiling from the agenda, the value `note' is forbidden and
1820 will temporarily be changed to `time'."
1830 This is list of cons cells. Each cell contains:
1831 - a specification of the files to be considered, either a list of files,
1832 or a symbol whose function or variable value will be used to retrieve
1833 a file name or a list of file names. If you use `org-agenda-files' for
1834 that, all agenda files will be scanned for targets. Nil means consider
1835 headings in the current buffer.
1836 - A specification of how to find candidate refile targets. This may be
1837 any of:
1839 This tag has to be present in all target headlines, inheritance will
1840 not be considered.
1842 todo keyword.
1844 headlines that are refiling targets.
1845 - a cons cell (:level . N). Any headline of level N is considered a target.
1846 Note that, when `org-odd-levels-only' is set, level corresponds to
1847 order in hierarchy, not to the number of stars.
1848 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1849 Note that, when `org-odd-levels-only' is set, level corresponds to
1850 order in hierarchy, not to the number of stars.
1852 You can set the variable `org-refile-target-verify-function' to a function
1853 to verify each headline found by the simple criteria above.
1855 When this variable is nil, all top-level headlines in the current buffer
1856 are used, equivalent to the value `((nil . (:level . 1))'."
1872 "Function to verify if the headline at point should be a refile target.
1873 The function will be called without arguments, with point at the
1874 beginning of the headline. It should return t and leave point
1875 where it is if the headline is a valid target for refiling.
1877 If the target should not be selected, the function must return nil.
1878 In addition to this, it may move point to a place from where the search
1879 should be continued. For example, the function may decide that the entire
1880 subtree of the current entry should be excluded and move point to the end
1881 of the subtree."
1886 "Non-nil means cache refile targets to speed up the process.
1887 The cache for a particular file will be updated automatically when
1888 the buffer has been killed, or when any of the marker used for flagging
1889 refile targets no longer points at a live buffer.
1890 If you have added new entries to a buffer that might themselves be targets,
1891 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1892 find that easier, `C-u C-u C-u C-c C-w'."
1897 "Non-nil means provide refile targets as paths.
1898 So a level 3 headline will be available as level1/level2/level3.
1900 When the value is `file', also include the file name (without directory)
1901 into the path. In this case, you can also stop the completion after
1902 the file name, to get entries inserted as top level in the file.
1904 When `full-file-path', include the full file path."
1913 "Non-nil means complete the outline path in hierarchical steps.
1914 When Org-mode uses the refile interface to select an outline path
1915 \(see variable `org-refile-use-outline-path'), the completion of
1916 the path can be done is a single go, or if can be done in steps down
1917 the headline hierarchy. Going in steps is probably the best if you
1918 do not use a special completion package like `ido' or `icicles'.
1919 However, when using these packages, going in one step can be very
1920 fast, while still showing the whole path to the entry."
1925 "Non-nil means allow to create new nodes as refile targets.
1927 of an existing node. When the value of this variable is `confirm',
1928 new node creation must be confirmed by the user (recommended)
1929 When nil, the completion must match an existing entry.
1931 Note that, if the new heading is not seen by the criteria
1932 listed in `org-refile-targets', multiple instances of the same
1933 heading would be created by trying again to file under the new
1934 heading."
1942 "Options concerning TODO items in Org-mode."
1947 "Options concerning Progress logging in Org-mode."
1952 '(
1955 "The available interpretation symbols for customizing `org-todo-keywords'.
1959 "List of TODO entry keyword sequences and their interpretation.
1962 Each sequence starts with a symbol, either `sequence' or `type',
1963 indicating if the keywords should be interpreted as a sequence of
1964 action steps, or as different types of TODO items. The first
1965 keywords are states requiring action - these states will select a headline
1966 for inclusion into the global TODO list Org-mode produces. If one of
1969 the last keyword is treated as the only DONE state of the sequence.
1972 additional state where no keyword is present. For details about this
1973 cycling, see the manual.
1975 TODO keywords and interpretation can also be set on a per-file basis with
1976 the special #+SEQ_TODO and #+TYP_TODO lines.
1978 Each keyword can optionally specify a character for fast state selection
1979 \(in combination with the variable `org-use-fast-todo-selection')
1980 and specifiers for state change logging, using the same syntax
1983 indicates to record a time stamp each time this state is selected.
1985 Each keyword may also specify if a timestamp or a note should be
1986 recorded when entering or leaving the state, by adding additional
1987 characters in the parenthesis after the keyword. This looks like this:
1989 record only the time of the state change. With X and Y being either
1991 Y when leaving the state if and only if the *target* state does not
1992 define X. You may omit any of the fast-selection key or X or /Y,
1993 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1995 For backward compatibility, this variable may also be just a list
1996 of keywords - in this case the interpretation (sequence or type) will be
1997 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2007 ;;Quick and dirty way to see
2008 ;;`org-todo-interpretations'. This takes the
2009 ;;place of item arguments
2010 :convert-widget
2017 org-todo-interpretation-widgets))
2018 widget))
2049 "Controls how TODO keywords are interpreted.
2050 This variable is in principle obsolete and is only used for
2051 backward compatibility, if the interpretation of todo keywords is
2052 not given already in `org-todo-keywords'. See that variable for
2053 more information."
2060 "Non-nil means use the fast todo selection scheme with C-c C-t.
2061 This variable describes if and under what circumstances the cycling
2062 mechanism for TODO keywords will be replaced by a single-key, direct
2063 selection scheme.
2065 When nil, fast selection is never used.
2067 When the symbol `prefix', it will be used when `org-todo' is called with
2068 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2069 in an agenda buffer.
2071 When t, fast selection is used by default. In this case, the prefix
2072 argument forces cycling instead.
2074 In all cases, the special interface is only used if access keys have actually
2075 been assigned by the user, i.e. if keywords in the configuration are followed
2076 by a letter in parenthesis, like TODO(t)."
2084 "Non-nil means update todo statistics after insert and toggle.
2085 ALL-HEADLINES means update todo statistics by including headlines
2086 with no TODO keyword as well, counting them as not done.
2087 A list of TODO keywords means the same, but skip keywords that are
2088 not in this list.
2090 When this is set, todo statistics is updated in the parent of the
2091 current entry each time a todo state is changed."
2101 "Non-nil means TODO statistics covers just direct children.
2102 When nil, all entries in the subtree are considered.
2103 This has only an effect if `org-provide-todo-statistics' is set.
2104 To set this to nil for only a single subtree, use a COOKIE_DATA
2110 "Hook which is run after the state of a TODO item was changed.
2111 The new state (a string with a TODO keyword, or nil) is available in the
2112 Lisp variable `state'."
2117 "Hook for functions that are allowed to block a state change.
2119 Each function gets as its single argument a property list, see
2120 `org-trigger-hook' for more information about this list.
2122 If any of the functions in this hook returns nil, the state change
2126 "Hook for functions that are triggered by a state change.
2128 Each function gets as its single argument a property list with at least
2129 the following elements:
2131 (:type type-of-change :position pos-at-entry-start
2132 :from old-state :to new-state)
2134 Depending on the type, more properties may be present.
2136 This mechanism is currently implemented for:
2138 TODO state changes
2139 ------------------
2140 :type todo-state-change
2141 :from previous state (keyword as a string), or nil, or a symbol
2142 'todo' or 'done', to indicate the general type of state.
2146 "Non-nil means undone TODO entries will block switching the parent to DONE.
2147 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2148 be blocked if any prior sibling is not yet done.
2149 Finally, if the parent is blocked because of ordered siblings of its own,
2150 the child will also be blocked.
2151 This variable needs to be set before org.el is loaded, and you need to
2152 restart Emacs after a change to make the change effective. The only way
2153 to change is while Emacs is running is through the customize interface."
2165 "Non-nil means unchecked boxes will block switching the parent to DONE.
2166 When this is nil, checkboxes have no influence on switching TODO states.
2167 When non-nil, you first need to check off all check boxes before the TODO
2168 entry can be switched to DONE.
2169 This variable needs to be set before org.el is loaded, and you need to
2170 restart Emacs after a change to make the change effective. The only way
2171 to change is while Emacs is running is through the customize interface."
2183 "Non-nil means inserting a TODO heading is treated as state change.
2185 logging will apply if appropriate. When nil, the new TODO item will
2186 be inserted directly, and no logging will take place."
2191 "Non-nil means switching TODO states with S-cursor counts as state change.
2192 This is the default behavior. However, setting this to nil allows a
2193 convenient way to select a TODO state and bypass any logging associated
2194 with that."
2199 "Tag changes that should be triggered by TODO state changes.
2200 This is a list. Each entry is
2202 (state-change (tag . flag) .......)
2204 State-change can be a string with a state, and empty string to indicate the
2205 state that has no TODO keyword, or it can be one of the symbols `todo'
2206 or `done', meaning any not-done or done state, respectively."
2220 "Information to record when a task moves to the DONE state.
2222 Possible values are:
2224 nil Don't add anything, just change the keyword
2225 time Add a time stamp to the task
2226 note Prompt for a note and add it with template `org-log-note-headings'
2228 This option can also be set with on a per-file-basis with
2230 #+STARTUP: nologdone
2231 #+STARTUP: logdone
2232 #+STARTUP: lognotedone
2234 You can have local logging settings for a subtree by setting the LOGGING
2235 property to one or more of these keywords."
2243 ;; Normalize old uses of org-log-done.
2250 "Information to record when the scheduling date of a tasks is modified.
2252 Possible values are:
2254 nil Don't add anything, just change the date
2255 time Add a time stamp to the task
2256 note Prompt for a note and add it with template `org-log-note-headings'
2258 This option can also be set with on a per-file-basis with
2260 #+STARTUP: nologreschedule
2261 #+STARTUP: logreschedule
2262 #+STARTUP: lognotereschedule"
2271 "Information to record when the deadline date of a tasks is modified.
2273 Possible values are:
2275 nil Don't add anything, just change the date
2276 time Add a time stamp to the task
2277 note Prompt for a note and add it with template `org-log-note-headings'
2279 This option can also be set with on a per-file-basis with
2281 #+STARTUP: nologredeadline
2282 #+STARTUP: logredeadline
2283 #+STARTUP: lognoteredeadline
2285 You can have local logging settings for a subtree by setting the LOGGING
2286 property to one or more of these keywords."
2295 "Non-nil means record a note when clocking out of an item.
2296 This can also be configured on a per-file basis by adding one of
2297 the following lines anywhere in the buffer:
2299 #+STARTUP: lognoteclock-out
2300 #+STARTUP: nolognoteclock-out"
2306 "Non-nil means the CLOSED time stamp will contain date and time.
2307 When nil, only the date will be recorded."
2321 "Headings for notes added to entries.
2322 The value is an alist, with the car being a symbol indicating the note
2323 context, and the cdr is the heading to be used. The heading may also be the
2324 empty string.
2325 %t in the heading will be replaced by a time stamp.
2326 %T will be an active time stamp instead the default inactive one
2327 %s will be replaced by the new TODO state, in double quotes.
2328 %S will be replaced by the old TODO state, in double quotes.
2329 %u will be replaced by the user name.
2330 %U will be replaced by the full user name.
2332 In fact, it is not a good idea to change the `state' entry, because
2333 agenda log mode depends on the format of these entries."
2339 "Heading when changing todo state (todo sequence only)"
2353 "Non-nil means insert state change notes and time stamps into a drawer.
2354 When nil, state changes notes will be inserted after the headline and
2355 any scheduling and clock lines, but not inside a drawer.
2357 The value of this variable should be the name of the drawer to use.
2358 LOGBOOK is proposed at the default drawer for this purpose, you can
2359 also set this to a string to define the drawer of your choice.
2363 If this variable is set, `org-log-state-notes-insert-after-drawers'
2364 will be ignored.
2366 You can set the property LOG_INTO_DRAWER to overrule this setting for
2367 a subtree."
2379 "Return the value of `org-log-into-drawer', but let properties overrule.
2380 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2381 used instead of the default value."
2389 "Non-nil means insert state change notes after any drawers in entry.
2390 Only the drawers that *immediately* follow the headline and the
2391 deadline/scheduled line are skipped.
2392 When nil, insert notes right after the heading and perhaps the line
2393 with deadline/scheduling if present.
2395 This variable will have no effect if `org-log-into-drawer' is
2396 set."
2402 "Non-nil means the latest state note will be directly after heading.
2403 When nil, the state change notes will be ordered according to time."
2409 "The TODO state to which a repeater should return the repeating task.
2410 By default this is the first task in a TODO sequence, or the previous state
2411 in a TODO_TYP set. But you can specify another task here.
2412 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2418 "Non-nil means record moving through the DONE state when triggering repeat.
2419 An auto-repeating task is immediately switched back to TODO when
2422 record a closing note, there will be no record of the task moving
2423 through DONE. This variable forces taking a note anyway.
2425 nil Don't force a record
2426 time Record a time stamp
2427 note Record a note
2429 This option can also be set with on a per-file-basis with
2431 #+STARTUP: logrepeat
2432 #+STARTUP: lognoterepeat
2433 #+STARTUP: nologrepeat
2435 You can have local logging settings for a subtree by setting the LOGGING
2436 property to one or more of these keywords."
2446 "Priorities in Org-mode."
2451 "Non-nil means priority commands are active.
2452 When nil, these commands will be disabled, so that you never accidentally
2453 set a priority."
2458 "The highest priority of TODO items. A character like ?A, ?B etc.
2459 Must have a smaller ASCII number than `org-lowest-priority'."
2464 "The lowest priority of TODO items. A character like ?A, ?B etc.
2465 Must have a larger ASCII number than `org-highest-priority'."
2470 "The default priority of TODO items.
2471 This is the priority an item get if no explicit priority is given."
2476 "Non-nil means start with default priority when starting to cycle.
2477 When this is nil, the first step in the cycle will be (depending on the
2478 command used) one higher or lower that the default priority."
2483 "Function to extract the priority from a string.
2484 The string is normally the headline. If this is nil Org computes the
2485 priority from the priority cookie like [#A] in the headline. It returns
2486 an integer, increasing by 1000 for each priority level.
2487 The user can set a different function here, which should take a string
2488 as an argument and return the numeric priority."
2493 "Options concerning time stamps and deadlines in Org-mode."
2498 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2499 When nil, these labeled time stamps are forces into the second line of an
2500 entry, just after the headline. When scheduling from the global TODO list,
2501 the time stamp will always be forced into the second line."
2506 "Formats for `format-time-string' which are used for time stamps.
2510 "Number of minutes to round time stamps to.
2511 These are two values, the first applies when first creating a time stamp.
2512 The second applies when changing it with the commands `S-up' and `S-down'.
2513 When changing the time stamp, this means that it will change in steps
2514 of N minutes, as given by the second value.
2516 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2517 numbers should be factors of 60, so for example 5, 10, 15.
2519 When this is larger than 1, you can still force an exact time stamp by using
2520 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2521 and by using a prefix arg to `S-up/down' to specify the exact number
2522 of minutes to shift."
2532 ;; Normalize old customizations of this variable.
2536 org-time-stamp-rounding-minutes)))
2539 "Non-nil means overlay custom formats over all time stamps.
2540 The formats are defined through the variable `org-time-stamp-custom-formats'.
2541 To turn this on on a per-file basis, insert anywhere in the file:
2542 #+STARTUP: customtime"
2550 "Custom formats for time stamps. See `format-time-string' for the syntax.
2551 These are overlayed over the default ISO format if the variable
2552 `org-display-custom-times' is set. Time like %H:%M should be at the
2553 end of the second format. The custom formats are also honored by export
2554 commands, if custom time display is turned on at the time of export."
2559 "Get the right format for a time string."
2564 f)))
2567 "The format string used when creating CLOCKSUM lines.
2568 This is also used when org-mode generates a time duration."
2574 org-mode generates a time duration."
2579 "The format string used when creating CLOCKSUM lines, or when
2580 org-mode generates a time duration."
2585 "No. of days before expiration during which a deadline becomes active.
2586 This variable governs the display in sparse trees and in the agenda.
2587 When 0 or negative, it means use this number (the absolute value of it)
2588 even if a deadline has a different individual lead time specified.
2590 Custom commands can set this variable in the options section."
2596 "Non-nil means assume future for incomplete date input from user.
2597 This affects the following situations:
2598 1. The user gives a month but not a year.
2601 2. The user gives a day, but no month.
2604 it will be considered as *this* month.
2606 If you set this variable to the symbol `time', then also the following
2607 will work:
2609 3. If the user gives a time, but no day. If the time is before now,
2610 to will be interpreted as tomorrow.
2612 Currently none of this works for ISO week specifications.
2614 When this option is nil, the current day, month and year will always be
2615 used as defaults.
2617 See also `org-agenda-jump-prefer-future'."
2625 "Should the agenda jump command prefer the future for incomplete dates?
2626 The default is to do the same as configured in `org-read-date-prefer-future'.
2627 But you can alse set a deviating value here.
2628 This may t or nil, or the symbol `org-read-date-prefer-future'."
2633 org-read-date-prefer-future)
2638 "Non-nil means display current interpretation of date prompt live.
2639 This display will be in an overlay, in the minibuffer."
2644 "Non-nil means pop up a calendar when prompting for a date.
2645 In the calendar, the date can be selected with mouse-1. However, the
2646 minibuffer will also be active, and you can simply enter the date as well.
2647 When nil, only the minibuffer will be available."
2655 "Hook to be used to set up keys for the date/time interface.
2656 Add key definitions to `minibuffer-local-map', which will be a temporary
2657 copy."
2662 "The hour when your day really ends. Must be an integer.
2663 This has influence for the following applications:
2665 the time given here, the day recognized as TODAY is actually yesterday.
2666 - When a date is read from the user and it is still before the time given
2667 here, the current date and time will be assumed to be yesterday, 23:59.
2668 Also, timestamps inserted in remember templates follow this rule.
2670 IMPORTANT: This is a feature whose implementation is and likely will
2671 remain incomplete. Really, it is only here because past midnight seems to
2672 be the favorite working time of John Wiegley :-)"
2677 "Non-nil means S-down will increase the time in a time stamp.
2678 When nil, S-up will increase."
2683 "Non-nil means make the calendar window follow timestamp changes.
2684 When a timestamp is modified and the calendar window is visible, it will be
2685 moved to the new date."
2690 "Options concerning tags in Org-mode."
2695 "List of tags allowed in Org-mode files.
2696 When this list is nil, Org-mode will base TAG input on what is already in the
2697 buffer.
2698 The value of this variable is an alist, the car of each entry must be a
2699 keyword as a string, the cdr may be a character that is used to select
2700 that tag through the fast-tag-selection interface.
2701 See the manual for details."
2716 "List of tags that will always appear in all Org-mode files.
2717 This is in addition to any in buffer settings or customizations
2718 of `org-tag-alist'.
2719 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2720 The value of this variable is an alist, the car of each entry must be a
2721 keyword as a string, the cdr may be a character that is used to select
2722 that tag through the fast-tag-selection interface.
2723 See the manual for details.
2724 To disable these tags on a per-file basis, insert anywhere in the file:
2725 #+STARTUP: noptag"
2736 "If non-nil, always offer completion for all tags of all agenda files.
2737 Instead of customizing this variable directly, you might want to
2738 set it locally for capture buffers, because there no list of
2739 tags in that file can be created dynamically (there are none).
2741 (add-hook 'org-capture-mode-hook
2742 (lambda ()
2743 (set (make-local-variable
2744 'org-complete-tags-always-offer-all-agenda-tags)
2745 t)))"
2750 "List of tags that can be inherited by all entries in the file.
2751 The tags will be inherited if the variable `org-use-tag-inheritance'
2752 says they should be.
2756 "Non-nil means use fast tag selection scheme.
2757 This is a special interface to select and deselect tags with single keys.
2758 When nil, fast selection is never used.
2759 When the symbol `auto', fast selection is used if and only if selection
2760 characters for tags have been configured, either through the variable
2761 `org-tag-alist' or through a #+TAGS line in the buffer.
2762 When t, fast selection is always used and selection keys are assigned
2763 automatically if necessary."
2771 "Non-nil means fast tag selection exits after first change.
2772 When nil, you have to press RET to exit it.
2773 During fast tag selection, you can toggle this flag with `C-c'.
2774 This variable can also have the value `expert'. In this case, the window
2775 displaying the tags menu is not even shown, until you press C-c again."
2783 "Non-nil means fast tags selection interface will also offer TODO states.
2787 "The column to which tags should be indented in a headline.
2788 If this number is positive, it specifies the column. If it is negative,
2789 it means that the tags should be flushright to that column. For example,
2790 -80 works well for a normal 80 character screen."
2795 "Non-nil means realign tags after pro/demotion of TODO state change.
2796 These operations change the length of a headline and therefore shift
2797 the tags around. With this options turned on, after each such operation
2798 the tags are again aligned to `org-tags-column'."
2803 "Non-nil means tags in levels apply also for sublevels.
2804 When nil, only the tags directly given in a specific line apply there.
2805 This may also be a list of tags that should be inherited, or a regexp that
2806 matches tags that should be inherited. Additional control is possible
2807 with the variable `org-tags-exclude-from-inheritance' which gives an
2808 explicit list of tags to be excluded from inheritance., even if the value of
2809 `org-use-tag-inheritance' would select it for inheritance.
2811 If this option is t, a match early-on in a tree can lead to a large
2812 number of matches in the subtree when constructing the agenda or creating
2813 a sparse tree. If you only want to see the first match in a tree during
2814 a search, check out the variable `org-tags-match-list-sublevels'."
2823 "List of tags that should never be inherited.
2824 This is a way to exclude a few tags from inheritance. For way to do
2825 the opposite, to actively allow inheritance for selected tags,
2826 see the variable `org-use-tag-inheritance'."
2831 "Check if TAG is one that should be inherited."
2843 "Non-nil means list also sublevels of headlines matching a search.
2844 This variable applies to tags/property searches, and also to stuck
2845 projects because this search is based on a tags match as well.
2847 When set to the symbol `indented', sublevels are indented with
2848 leading dots.
2850 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2851 the sublevels of a headline matching a tag search often also match
2852 the same search. Listing all of them can create very long lists.
2853 Setting this variable to nil causes subtrees of a match to be skipped.
2855 This variable is semi-obsolete and probably should always be true. It
2856 is better to limit inheritance to certain tags using the variables
2857 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2865 "When set, tags are sorted using this function as a comparator."
2881 "Options concerning properties in Org-mode."
2886 "How property key/value pairs should be formatted by `indent-line'.
2887 When `indent-line' hits a property definition, it will format the line
2888 according to this format, mainly to make sure that the values are
2889 lined-up with respect to each other."
2894 "Non-nil means properties apply also for sublevels.
2896 This setting is chiefly used during property searches. Turning it on can
2897 cause significant overhead when doing a search, which is why it is not
2898 on by default.
2900 When nil, only the properties directly given in the current entry count.
2901 When t, every property is inherited. The value may also be a list of
2902 properties that should have inheritance, or a regular expression matching
2903 properties that should be inherited.
2905 However, note that some special properties use inheritance under special
2906 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2908 for valid values of a property.
2910 Note for programmers:
2911 When querying an entry with `org-entry-get', you can control if inheritance
2912 should be used. By default, `org-entry-get' looks only at the local
2913 properties. You can request inheritance by setting the inherit argument
2914 to t (to force inheritance) or to `selective' (to respect the setting
2915 in this variable)."
2924 "Check if PROPERTY is one that should be inherited."
2935 "The default column format, if no other format has been defined.
2936 This variable can be set on the per-file basis by inserting a line
2938 #+COLUMNS: %25ITEM ....."
2943 "The ellipses to be used when a field in column view is truncated.
2944 When this is the empty string, as many characters as possible are shown,
2945 but then there will be no visual indication that the field has been truncated.
2946 When this is a string of length N, the last N characters of a truncated
2947 field are replaced by this string. If the column is narrower than the
2948 ellipses string, only part of the ellipses string will be shown."
2953 "Function that modifies values for display in column view.
2954 For example, it can be used to cut out a certain part from a time stamp.
2955 The function must take 2 arguments:
2957 column-title The title of the column (*not* the property name)
2958 value The value that should be modified.
2960 The function should return the value that should be displayed,
2961 or nil if the normal value should be used."
2966 "The property that is being used to keep track of effort estimates.
2967 Effort estimates given in this property need to have the format H:MM."
2975 "List of property/value pairs that can be inherited by any entry.
2977 These are fixed values, for the preset properties. The user variable
2978 that can be used to add to this list is `org-global-properties'.
2980 The entries in this list are cons cells where the car is a property
2981 name and cdr is a string with the value. If the value represents
2986 "List of property/value pairs that can be inherited by any entry.
2988 This list will be combined with the constant `org-global-properties-fixed'.
2990 The entries in this list are cons cells where the car is a property
2991 name and cdr is a string with the value.
2993 You can set buffer-local values for the same purpose in the variable
2994 `org-file-properties' this by adding lines like
2996 #+PROPERTY: NAME VALUE"
3003 "List of property/value pairs that can be inherited by any entry.
3004 Valid for the current buffer.
3009 "Options concerning agenda views in Org-mode."
3014 "Variable used by org files to set a category for agenda display.
3015 Such files should use a file variable to set it, for example
3019 or contain a special line
3021 #+CATEGORY: ELisp
3023 If the file does not specify a category, then file's base name
3029 "The files to be used for agenda display.
3033 If an entry is a directory, all files in that directory that are matched by
3034 `org-agenda-file-regexp' will be part of the file list.
3036 If the value of the variable is not a list but a single file name, then
3037 the list of agenda files is actually stored and maintained in that file, one
3038 agenda file per line. In this file paths can be given relative to
3039 `org-directory'. Tilde expansion and environment variable substitution
3040 are also made."
3047 "Regular expression to match files for `org-agenda-files'.
3048 If any element in the list in that variable contains a directory instead
3049 of a normal file, all files in that directory that are matched by this
3050 regular expression will be included."
3055 "List of extra files to be searched by text search commands.
3056 These files will be search in addition to the agenda files by the
3057 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3058 Note that these files will only be searched for text search commands,
3059 not for the other agenda views like todo lists, tag searches or the weekly
3060 agenda. This variable is intended to list notes and possibly archive files
3061 that should also be searched by these two commands.
3062 In fact, if the first element in the list is the symbol `agenda-archives',
3063 than all archive files of all agenda files will be added to the search
3064 scope."
3075 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3076 A nil value means to remove them, after a query, from the list."
3081 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3082 The command `org-calendar-goto-agenda' will be bound to this key. The
3083 default is the character `c' because then `c' can be used to switch back and
3084 forth between agenda and calendar."
3089 "The key to be installed in `calendar-mode-map' for agenda-action.
3090 The command `org-agenda-action' will be bound to this key. The
3091 default is the character `k' because we use the same key in the agenda."
3096 "The key to be installed in `calendar-mode-map' for adding diary entries.
3097 This option is irrelevant until `org-agenda-diary-file' has been configured
3098 to point to an Org-mode file. When that is the case, the command
3099 `org-agenda-diary-entry' will be bound to the key given here, by default
3100 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3101 if you want to continue doing this, you need to change this to a different
3102 key."
3107 "File to which to add new entries with the `i' key in agenda and calendar.
3108 When this is the symbol `diary-file', the functionality in the Emacs
3109 calendar will be used to add entries to the `diary-file'. But when this
3110 points to a file, `org-agenda-diary-entry' will be used instead."
3126 org-calendar-insert-diary-entry-key
3130 "Options for embedding LaTeX code into Org-mode."
3138 "Options for creating images from LaTeX fragments.
3139 This is a property list with the following properties:
3141 `default' means use the foreground of the default face.
3143 `default' means use the background of the default face.
3144 :scale a scaling factor for the size of the images, to get more pixels
3145 :html-foreground, :html-background, :html-scale
3146 the same numbers for HTML export.
3147 :matchers a list indicating which matchers should be used to
3148 find LaTeX fragments. Valid members of this list are:
3159 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3160 When nil, just push out a message."
3169 \[PACKAGES]
3170 \[DEFAULT-PACKAGES]
3171 % The settings below are copied from fullpage.sty
3184 "The document header used for processing LaTeX fragments.
3185 It is imperative that this header make sure that no page number
3186 appears on the page. The package defined in the variables
3187 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3189 will be appended."
3196 "Set the packages alist and make sure it has 3 elements per entry."
3200 x))
3201 val)))
3205 "Get the packages alist and make sure it has 3 elements per entry."
3209 x))
3212 ;; The following variables are defined here because is it also used
3213 ;; when formatting latex fragments. Originally it was part of the
3214 ;; LaTeX exporter, which is why the name includes "export".
3231 )
3232 "Alist of default packages to be inserted in the header.
3233 Change this only if one of the packages here causes an incompatibility
3234 with another package you are using.
3235 The packages in this list are needed by one part or another of Org-mode
3236 to function properly.
3238 - inputenc, fontenc: for basic font and character selection
3239 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3240 for interpreting the entities in `org-entities'. You can skip some of these
3241 packages if you don't use any of the symbols in it.
3242 - graphicx: for including images
3243 - float, wrapfig: for figure placement
3244 - longtable: for long tables
3245 - hyperref: for cross references
3247 Therefore you should not modify this variable unless you know what you
3248 are doing. The one reason to change it anyway is that you might be loading
3249 some other package that conflicts with one of the default packages.
3251 If SNIPPET-FLAG is t, the package also needs to be included when
3252 compiling LaTeX snippets into images for inclusion into HTML."
3265 "Alist of packages to be inserted in every LaTeX header.
3266 These will be inserted after `org-export-latex-default-packages-alist'.
3268 SNIPPET-FLAG, when t, indicates that this package is also needed when
3269 turning LaTeX snippets into images for inclusion into HTML.
3270 Make sure that you only list packages here which:
3271 - you want in every file
3272 - do not conflict with the default packages in
3273 `org-export-latex-default-packages-alist'
3274 - do not conflict with the setup in `org-format-latex-header'."
3288 "Settings for Org-mode appearance."
3293 "Non-nil means fontify only the stars in each headline.
3294 When nil, the entire headline is fontified.
3295 Changing it requires restart of `font-lock-mode' to become effective
3296 also in regions already fontified."
3301 "Non-nil means hide the first N-1 stars in a headline.
3302 This works by using the face `org-hide' for these stars. This
3303 face is white for a light background, and black for a dark
3304 background. You may have to customize the face `org-hide' to
3305 make this work.
3306 Changing it requires restart of `font-lock-mode' to become effective
3307 also in regions already fontified.
3308 You may also set this on a per-file basis by adding one of the following
3309 lines to the buffer:
3311 #+STARTUP: hidestars
3312 #+STARTUP: showstars"
3317 "List of keywords that should be hidden when typed in the org buffer.
3318 For example, add #+TITLE to this list in order to make the
3319 document title appear in the buffer without the initial #+TITLE:
3320 keyword."
3328 "Non-nil means change the face of a headline if it is marked DONE.
3329 Normally, only the TODO/DONE keyword indicates the state of a headline.
3330 When this is non-nil, the headline after the keyword is set to the
3331 `org-headline-done' as an additional indication."
3336 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3337 Changing this variable requires a restart of Emacs to take effect."
3342 "Non-nil means fontify the whole line for headings.
3343 This is useful when setting a background color for the
3344 org-level-* faces."
3349 "Non-nil means fontify what is treated specially by the exporters."
3354 "Non-nil mean font-lock should hide the emphasis marker characters."
3359 "Non-nil means show entities as UTF8 characters.
3365 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3370 "Regular expression for matching emphasis.
3371 After a match, the match groups contain these elements:
3372 0 The match of the full regular expression, including the characters
3373 before and after the proper match
3374 1 The character before the proper match, or empty at beginning of line
3375 2 The proper match, including the leading and trailing markers
3376 3 The leading marker like * or /, indicating the type of highlighting
3377 4 The text between the emphasis markers, not including the markers
3384 "Set variable and compute the emphasis regular expression."
3388 org-emphasis-alist org-emphasis-regexp-components)
3400 ;; make sure special characters appear at the right position in the class
3412 ;; Make the regexp
3420 body1
3432 body1
3440 "Components used to build the regular expression for emphasis.
3441 This is a list with five entries. Terminology: In an emphasis string
3445 specify what is allowed/forbidden in each part:
3447 pre Chars allowed as prematch. Beginning of line will be allowed too.
3448 post Chars allowed as postmatch. End of line will be allowed too.
3449 border The chars *forbidden* as border characters.
3451 non-shy groups here, and don't allow newline here.
3452 newline The maximum number of newlines allowed in an emphasis exp.
3454 Use customize to modify this, or restart Emacs after changing it."
3473 )
3474 "Special syntax for emphasized text.
3475 Text starting and ending with a special character will be emphasized, for
3476 example *bold*, _underlined_ and /italic/. This variable sets the marker
3477 characters, the face to be used by font-lock for highlighting in Org-mode
3478 Emacs buffers, and the HTML tags to be used for this.
3479 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3480 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3481 Use customize to modify this, or restart Emacs after changing it."
3496 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3499 ;;; Miscellaneous options
3502 "Completion in Org-mode."
3507 "Non-nil means use ido completion wherever possible.
3508 Note that `ido-mode' must be active for this variable to be relevant.
3509 If you decide to turn this variable on, you might well want to turn off
3510 `org-outline-path-complete-in-steps'.
3511 See also `org-completion-use-iswitchb'."
3516 "Non-nil means use iswitchb completion wherever possible.
3517 Note that `iswitchb-mode' must be active for this variable to be relevant.
3518 If you decide to turn this variable on, you might well want to turn off
3519 `org-outline-path-complete-in-steps'.
3520 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3526 Normal means, no org-mode-specific context."
3530 ;;; Functions and variables from their packages
3531 ;; Declared here to avoid compiler warnings
3533 ;; XEmacs only
3539 ;; Emacs only
3542 ;; Various packages
3560 org-format-agenda-item "org-agenda"
3591 ;;; Autoload and prepare some org modules
3593 ;; Some table stuff that needs to be defined here, because it is used
3594 ;; by the functions setting up org-mode or checking for table context.
3607 "Detect the first line outside a table when searching from within it.
3610 ;; Autoload the functions in org-table.el that are needed by functions here.
3615 org-table-convert org-table-convert-region org-table-copy-down
3616 org-table-copy-region org-table-create
3617 org-table-create-or-convert-from-region
3618 org-table-create-with-table.el org-table-current-dline
3619 org-table-cut-region org-table-delete-column org-table-edit-field
3620 org-table-edit-formulas org-table-end org-table-eval-formula
3621 org-table-export org-table-field-info
3622 org-table-get-stored-formulas org-table-goto-column
3623 org-table-hline-and-move org-table-import org-table-insert-column
3624 org-table-insert-hline org-table-insert-row org-table-iterate
3625 org-table-justify-field-maybe org-table-kill-row
3626 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3627 org-table-move-column org-table-move-column-left
3628 org-table-move-column-right org-table-move-row
3629 org-table-move-row-down org-table-move-row-up
3630 org-table-next-field org-table-next-row org-table-paste-rectangle
3631 org-table-previous-field org-table-recalculate
3632 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3633 org-table-toggle-coordinate-overlays
3634 org-table-toggle-formula-debugger org-table-wrap-region
3635 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3636 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3637 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3640 "Return t if the cursor is inside an org-type table.
3641 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3646 org-table-line-regexp)))
3647 nil))
3651 "Return t if and only if we are at a table.el table."
3657 "If there is a table.el table nearby, recognize it and move into it."
3663 nil
3673 t
3678 t)
3679 nil)
3680 nil))
3683 "Return t if the cursor is inside a hline in a table."
3688 nil))
3693 "Apply FUNCTION to the start of all tables in the buffer."
3709 ;; Declare and autoload functions from org-exp.el & Co
3717 org-insert-export-options-template
3718 org-table-clean-before-export))
3721 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3722 org-export-region-as-ascii))
3725 org-replace-region-by-latex org-export-region-as-latex
3726 org-export-as-latex org-export-as-pdf
3727 org-export-as-pdf-and-open))
3730 org-export-as-html-batch org-export-as-html-to-buffer
3731 org-replace-region-by-html org-export-region-as-html
3732 org-export-as-html))
3735 org-replace-region-by-docbook org-export-region-as-docbook
3736 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3737 org-export-as-docbook))
3740 org-export-icalendar-all-agenda-files
3741 org-export-icalendar-combine-agenda-files))
3745 ;; Declare and autoload functions from org-agenda.el
3750 org-todo-list org-tags-view org-agenda-list-stuck-projects
3751 org-diary org-agenda-to-appt
3752 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3754 ;; Autoload org-remember
3759 org-remember-apply-template org-remember org-remember-handler)))
3764 org-capture-import-remember-templates)))
3766 ;; Autoload org-clock.el
3781 "Return non-nil if clock is currently running.
3782 The return value is actually the clock marker."
3787 "org-clock"
3789 org-clock-goto org-clock-sum org-clock-display
3790 org-clock-remove-overlays org-clock-report
3791 org-clocktable-shift org-dblock-write:clocktable
3792 org-get-clocktable org-resolve-clocks)))
3795 "If this is a CLOCK line, update it and return t.
3796 Otherwise, return nil."
3805 ts te h m s neg)
3808 nil)
3813 ;; The clock is running here
3834 t))))))
3837 "Check if the current buffer contains the running clock.
3838 If yes, offer to stop it and to save the buffer with the changes."
3847 "Check if this line starts a clock table, if yes, shift the time block."
3851 ;; Autoload org-timer.el
3855 "org-timer"
3857 org-timer-change-times-in-region
3858 org-timer-set-timer
3859 org-timer-reset-timers
3860 org-timer-show-remaining-time)))
3862 ;; Autoload org-feed.el
3866 "org-feed"
3870 ;; Autoload org-indent.el
3872 ;; Define the variable already here, to make sure we have it.
3874 "Non-nil if Org-Indent mode is enabled.
3879 "org-indent"
3882 ;; Autoload org-mobile.el
3886 "org-mobile"
3889 ;; Autoload archiving code
3890 ;; The stuff that is needed for cycling and tags has to be defined here.
3893 "Options concerning archiving in Org-mode."
3898 "The location where subtrees should be archived.
3900 The value of this variable is a string, consisting of two parts,
3901 separated by a double-colon. The first part is a filename and
3902 the second part is a headline.
3904 When the filename is omitted, archiving happens in the same file.
3905 %s in the filename will be replaced by the current file
3906 name (without the directory part). Archiving to a different file
3907 is useful to keep archived entries from contributing to the
3908 Org-mode Agenda.
3910 The archived entries will be filed as subtrees of the specified
3911 headline. When the headline is omitted, the subtrees are simply
3912 filed away at the end of the file, as top-level entries. Also in
3913 the heading you can use %s to represent the file name, this can be
3914 useful when using the same archive for a number of different files.
3916 Here are a few examples:
3918 If the current file is Projects.org, archive in file
3919 Projects.org_archive, as top-level trees. This is the default.
3922 Archive in the current file, under the top-level headline
3926 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3929 Archive in file ~/org/archive.org (absolute path), under headlines
3933 Archive in file ./basement (relative path), as level 3 trees
3936 You may set this option on a per-file basis by adding to the buffer a
3937 line like
3939 #+ARCHIVE: basement::** Finished Tasks
3941 You may also define it locally for a subtree by setting an ARCHIVE property
3942 in the entry. If such a property is found in an entry, or anywhere up
3943 the hierarchy, it will be used."
3948 "The tag that marks a subtree as archived.
3949 An archived subtree does not open during visibility cycling, and does
3950 not contribute to the agenda listings.
3951 After changing this, font-lock must be restarted in the relevant buffers to
3952 get the proper fontification."
3958 "Non-nil means the agenda will skip any items located in archived trees.
3959 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3960 variable is no longer recommended, you should leave it at the value t.
3961 Instead, use the key `v' to cycle the archives-mode in the agenda."
3967 "Non-nil means ignore archived trees when creating column view."
3973 "Non-nil means `org-cycle' will open archived trees.
3974 An archived tree is a tree marked with the tag ARCHIVE.
3975 When nil, archived trees will stay folded. You can still open them with
3976 normal outline commands like `show-all', but not with the cycling commands."
3982 "Non-nil means sparse tree construction shows matches in archived trees.
3983 When nil, matches in these trees are highlighted, but the trees are kept in
3984 collapsed state."
3990 "Re-hide all archived subtrees after a visibility state change."
4001 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4004 "Cycle subtree even if it is archived."
4011 "Re-hide all archived subtrees after a visibility state change."
4026 flag)))
4033 org-archive-to-archive-sibling org-toggle-archive-tag
4034 org-archive-subtree-default
4035 org-archive-subtree-default-with-confirmation)))
4037 ;; Autoload Column View Code
4045 org-columns-compute org-agenda-columns org-columns-remove-overlays
4048 ;; Autoload ID code
4056 org-id-get-with-outline-path-completion
4057 org-id-get-with-outline-drilling org-id-store-link
4058 org-id-goto org-id-find org-id-store-link))
4060 ;; Autoload Plotting Code
4065 ;;; Variables for pre-computed regular expressions, all buffer local
4083 "Matches a headline and puts everything into groups:
4084 group 1: the stars
4085 group 2: The todo keyword, maybe
4086 group 3: Priority cookie
4087 group 4: True headline
4091 "Printf format to make regexp to match an exact headline.
4092 This regexp will match the headline of any node which hase the exact
4093 headline text that is put into the format, but may have any TODO state,
4097 "Matches a headline and puts TODO state into group 2 if present.
4152 "Regular expression to match a plain time or time range.
4153 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4154 groups carry important information:
4155 0 the full match
4156 1 the first time, range or not
4164 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4165 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4166 groups carry important information:
4167 0 the full match
4168 7 hours of duration
4177 "Regular expression to match a timestamp time or time range.
4178 After a match, the following groups carry important information:
4179 0 the full match
4180 1 date plus weekday, for back referencing to make sure both times are on the same day
4181 2 the first time, range or not
4236 "Variable associated with STARTUP options for org-mode.
4237 Each element is a list of three items: The startup options as written
4238 in the #+STARTUP line, the corresponding variable, and the value to
4239 set this variable to if the option is found. An optional forth element PUSH
4243 "Precompute regular expressions for current buffer."
4263 kwds kws0 kwsa key log value cat arch tags const links hw dws
4264 tail sep kws1 prio props ftags drawers beamer-p
4286 ;; general TODO-like setup
4298 links)))
4304 props)))
4309 ftags
4319 l var val)
4349 ))))
4366 ;; Process the TODO keywords
4368 ;; Use the global values as if they had been given locally.
4380 kws)))
4383 kwsa nil
4386 ;; 1 2
4394 kw)
4396 kws0)
4413 ;; Process the constants
4421 ;; Process the tags.
4432 tgs))
4440 ;; Compute the regular expressions and other local variables
4448 org-drawer-regexp
4452 org-not-done-keywords
4454 org-todo-regexp
4457 org-not-done-regexp
4461 org-not-done-heading-regexp
4465 org-todo-line-regexp
4469 org-complex-heading-regexp
4474 org-complex-heading-regexp-format
4483 org-nl-done-regexp
4487 org-todo-line-tags-regexp
4492 org-looking-at-done-regexp
4497 org-deadline-time-regexp
4499 org-deadline-line-regexp
4501 org-scheduled-regexp
4503 org-scheduled-time-regexp
4505 org-closed-time-regexp
4507 org-keyword-time-regexp
4513 org-keyword-time-not-clock-regexp
4519 org-maybe-keyword-time-regexp
4525 org-planning-or-clock-line-re
4530 org-all-time-keywords
4533 org-clock-string org-closed-string))
4534 )
4539 "Return the contents of FILE, as a string."
4553 "Extract the log state setting from a TODO keyword string.
4567 "Remove a pair of parenthesis at the end of each string in LIST."
4571 x))
4572 list))
4575 "Assign fast keys to a keyword-key alist.
4576 Respect keys that are already there."
4594 ;;; Some variables used in various places
4601 "Function to be called when `C-c C-c' is used.
4605 ;; FIXME: Occasionally check by commenting these, to make sure
4606 ;; no other functions uses these, forgetting to let-bind them.
4611 ;; Defined somewhere in this file, but used before definition.
4617 ;;;; Define the Org-mode
4620 (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"))
4623 ;; We use a before-change function to check if a table might need
4624 ;; an update.
4626 "Indicates that a table might need an update.
4627 This variable is set by `org-before-change-function'.
4630 "Every change indicates that a table might need an update."
4641 ;;;###autoload
4643 "Outline-based notes management and organizer, alias
4646 Org-mode develops organizational tasks around a NOTES file which
4647 contains information about projects as plain text. Org-mode is
4648 implemented on top of outline-mode, which is ideal to keep the content
4649 of large files well structured. It supports ToDo items, deadlines and
4650 time stamps, which magically appear in the diary listing of the Emacs
4651 calendar. Tables are easily created with a built-in table editor.
4652 Plain text URL-like links connect to websites, emails (VM), Usenet
4653 messages (Gnus), BBDB entries, and any files related to the project.
4654 For printing and sharing of notes, an Org-mode file (or a part of it)
4655 can be exported as a structured ASCII or HTML file.
4657 The following commands are available:
4661 ;; Get rid of Outline menus, they are not needed
4662 ;; Need to do this here because define-derived-mode sets up
4663 ;; the keymap so late. Still, it is a waste to call this each time
4664 ;; we switch another buffer into org-mode.
4667 ;; Assume this is Greg's port, it uses easymenu
4692 org-display-table 4
4695 org-ellipsis)))
4700 ;; tag faces set outside customize.... force initialization.
4702 ;; Calc embedded
4708 ;; Activate before-change-function
4712 ;; Check for running clock before killing a buffer
4714 ;; Paragraphs and auto-filling
4718 ;; Beginning/end of defun
4721 ;; Make sure dependence stuff works reliably, even for users who set it
4722 ;; too late :-(
4734 ;; Comment characters
4738 ;; Align options lines
4740 'align-mode-rules-list
4745 ;; Imenu
4749 ;; Make isearch reveal context
4752 ;; Emacs 21 and XEmacs make use of the hook
4754 ;; Emacs 22 deals with this through a special variable
4758 ;; Turn on org-beamer-mode?
4761 ;; Setup the pcomplete hooks
4772 ;; If empty file that did not turn on org-mode automatically, make it to.
4797 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4807 "Return today date, considering `org-extend-today-until'."
4812 ;;;; Font-Lock stuff, including the activators
4843 "Regular expression used to analyze links.
4844 Here is what the match groups contain after a match:
4845 1: http:
4846 2: http
4847 3: path
4848 4: [desc]
4856 "Number of stacked braces for sub/superscript matching.
4857 This has to be set before loading org.el to be effective."
4862 "Create a regular expression which will match a balanced sexp.
4863 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4864 as single character strings.
4865 The regexp returned will match the entire expression including the
4866 delimiters. It will also define a single group which contains the
4867 match except for the outermost delimiters. The maximum depth of
4868 stacked delimiters is N. Escaping delimiters is not possible."
4897 "Update the link regular expressions.
4898 This should be called after the variable `org-link-types' has changed."
4902 org-link-re-with-space
4908 org-link-re-with-space2
4914 org-link-re-with-space3
4919 org-angle-link-re
4925 org-plain-link-re
4929 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
4930 org-bracket-link-regexp
4932 org-bracket-link-analytic-regexp
4940 org-bracket-link-analytic-regexp++
4948 org-any-link-re
4959 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4960 "Regular expression matching time strings for analysis.
4961 This one does not require the space after the date, so it can be used
4963 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4979 "Regular expression matching a time stamp or time stamp range.
4985 "Run through the buffer and add overlays to links."
4994 'face
5007 rtn))
5010 "Insert or change an emphasis, i.e. a font like bold or italic.
5011 If there is an active region, change that region to a new emphasis.
5012 If there is no region, just insert the marker characters and position
5013 the cursor between them.
5014 CHAR should be either the marker character, or the first character of the
5015 HTML tag associated with that emphasis. If CHAR is a space, the means
5016 to remove the emphasis of the selected region.
5017 If char is not given (for example in an interactive call) it
5018 will be prompted for."
5069 "Run through the buffer and add overlays to links."
5078 nil
5084 t)))))
5092 t)))
5095 "When non-nil, fontify code in code blocks."
5101 "Fontify #+ lines and blocks, in the correct ways."
5104 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5105 limit t)
5113 end end1 quoting block-type)
5116 ;; a single line of backend-specific content
5124 ; for backend-specific code
5125 t)
5127 ;; Truly a block
5139 beg end
5143 ; for end_src
5149 org-block)))
5150 ; end of source block
5156 t))
5169 ;; just any other in-buffer setting, but not indented
5173 t)
5181 t)
5189 "Run through the buffer and add overlays to links."
5197 t)))
5200 "Run through the buffer and add overlays to links."
5202 limit t)
5207 'keymap org-mouse-map
5208 'help-echo
5210 "Footnote definition"
5212 ))
5214 t)))
5217 "Run through the buffer and add overlays to bracketed links."
5221 ;; FIXME: above we should remove the escapes.
5222 ;; but that requires another match, protecting match data,
5223 ;; a lot of overhead for font-lock.
5230 ;; We need to remove the invisible property here. Table narrowing
5231 ;; may have made some of this invisible.
5249 t)))
5252 "Run through the buffer and add overlays to dates."
5264 t)))
5273 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5277 "Run through the buffer and add overlays to target matches."
5285 'keymap org-mouse-map
5289 t)))))
5292 "Find all radio targets in this file and update the regular expression."
5307 t)))
5314 ;; This should be with the exporter code, but we also use if for font-locking
5324 "Compute regular expression for stuff treated specially by exporters."
5331 org-latex-regexps)))
5359 org-entities)))
5363 org-latex-entities)
5364 nil))
5366 ))
5367 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5370 org-export-html-special-string-regexps)))
5375 ))))
5377 'org-latex-and-specials-regexp
5382 "Run through the buffer and add overlays to links."
5386 limit t))
5400 rtn)))
5403 "Restart `font-lock-mode', to force refontification."
5409 "Return a list of all targets in this file.
5410 With optional argument RADIO, only find radio targets."
5412 rtn)
5417 rtn)))
5420 "Make regular expression matching all strings in TARGETS.
5421 The regular expression finds the targets also if there is a line break
5422 between words."
5431 x)
5432 targets
5444 t)))
5447 "Compute the outline level of the heading at point.
5448 This function assumes that the cursor is at the beginning of a line matched
5449 by `outline-regexp'. Otherwise it returns garbage.
5450 If this is called at a normal headline, the level is the number of stars.
5451 Use `org-reduced-level' to remove the effect of `org-odd-levels'.
5452 For plain list items, if they are matched by `outline-regexp', this returns
5453 1000 plus the line indentation."
5462 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5469 "Functions that can manipulate `org-font-lock-extra-keywords'.
5470 This is calles after `org-font-lock-extra-keywords' is defined, but before
5471 it is installed to be used by font lock. This can be useful if something
5482 ;; Call the hook
5484 ;; Headlines
5491 ;; Table lines
5494 ;; Table internals
5499 ;; Drawers
5502 ;; Properties
5506 ;; Links
5517 ;; TODO lines
5520 ;; DONE
5526 nil)
5527 ;; Priorities
5529 ;; Tags
5531 ;; Special keywords
5536 ;; Emphasis
5541 ;; Checkboxes
5542 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5547 ;; Description list items
5550 ;; ARCHIVEd headings
5553 ;; Specials
5557 ;; Code
5559 ;; COMMENT
5564 ;; Blocks and meta lines
5566 )))
5569 ;; Now set the full font-lock-keywords
5576 "Toggle the composition display of entities as UTF8 characters."
5588 "Find an entity to fontify."
5594 limit t)
5606 nil))))
5609 "Fontify string S like in Org-mode."
5621 "Get the right face for match N in font-lock matching of headlines."
5634 "Get the right face for a TODO keyword KWD.
5635 If KWD is a number, get the corresponding match group."
5643 "Create a face list that inherits INHERIT, but sets the foreground color.
5644 When FACE-OR-COLOR is not a string, just return it."
5648 face-or-color)
5649 face-or-color))
5652 "Add the special tag faces."
5661 "Add the special priority faces."
5668 org-priority-faces)))
5673 "Get the right face for a TODO keyword KWD.
5674 If KWD is a number, get the corresponding match group."
5681 "Remove fontification and activation overlays from links."
5686 deactivate-mark buffer-file-name buffer-file-truename)
5689 beg end
5691 ;; also remove line-prefix and wrap-prefix properties
5693 invisible t intangible t
5694 line-prefix t wrap-prefix t
5695 org-no-flyspell t org-emphasis t)
5697 invisible t intangible t
5698 org-no-flyspell t org-emphasis t)))
5708 "Remove specific display properties that have been added by font lock.
5709 The will remove the raise properties that are used to show superscripts
5710 and subscripts."
5720 "Add raise properties to sub/superscripts."
5724 org-match-substring-regexp
5725 org-match-substring-with-braces-regexp)
5726 limit t)
5736 ;; FIXME: Should we go back one character here, for a_b^c
5737 ;; (goto-char (1- pos)) ;????????????????????
5739 t
5741 'display
5757 t)))))
5759 ;;;; Visibility cycling, including org-goto and indirect buffer
5761 ;;; Cycling
5768 ;;;###autoload
5773 "TAB-action and visibility cycling for Org-mode.
5775 This is the command invoked in Org-mode by the TAB key. Its main purpose
5776 is outline visibility cycling, but it also invokes other actions
5777 in special contexts.
5779 - When this function is called with a prefix argument, rotate the entire
5780 buffer through 3 states (global cycling)
5781 1. OVERVIEW: Show only top-level headlines.
5782 2. CONTENTS: Show all headlines of all levels, but no body text.
5783 3. SHOW ALL: Show everything.
5784 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5785 determined by the variable `org-startup-folded', and by any VISIBILITY
5786 properties in the buffer.
5787 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5788 including any drawers.
5790 - When inside a table, re-align the table and move to the next field.
5792 - When point is at the beginning of a headline, rotate the subtree started
5793 by this line through 3 different states (local cycling)
5794 1. FOLDED: Only the main headline is shown.
5795 2. CHILDREN: The main headline and the direct children are shown.
5796 From this state, you can move to one of the children
5797 and zoom in further.
5798 3. SUBTREE: Show the entire subtree, including body text.
5799 If there is no subtree, switch directly from CHILDREN to FOLDED.
5801 - When point is at the beginning of an empty headline and the variable
5802 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5803 of the headline by demoting and promoting it to likely levels. This
5804 speeds up creation document structure by pressing TAB once or several
5805 times right after creating a new headline.
5807 - When there is a numeric prefix, go up to a heading with level ARG, do
5808 a `show-subtree' and return to the previous cursor position. If ARG
5809 is negative, go up that many levels.
5811 - When point is not at the beginning of a headline, execute the global
5812 binding for TAB, which is re-indenting the line. See the option
5813 `org-cycle-emulate-tab' for details.
5815 - Special case: if point is at the beginning of the buffer and there is
5816 no headline in line 1, this function will act as if called with prefix arg
5817 (C-u TAB, same as S-TAB) also when called without prefix arg.
5818 But only if also the variable `org-cycle-global-at-bob' is t."
5828 org-inlinetask-min-level
5833 limit-level)))
5849 org-cycle-hook))
5853 ;; special case: use global cycling
5868 ;; Enter the table or move to the next field in the table
5885 ;; Toggle block visibility
5890 ;; Show-subtree, ARG levels up from here.
5902 ;; TAB emulation and template completion
5926 t
5935 "Do the global cycling action."
5939 ;; We just created the overview - now do table of contents
5940 ;; This can be slow in very large buffers, so indicate action
5950 ;; We just showed the table of contents - now show everything
5958 ;; Default action: go to overview
5966 "Do the local cycling action."
5968 ;; First, some boundaries
5975 ; XEmacs does not have `next-single-char-property-change'
5976 ; I'm not sure about Emacs 21.
5990 ;; if we're in a list, org-end-of-subtree is in fact org-end-of-item.
5999 ;; Find out what to do next and set `this-command'
6002 ;; Nothing is hidden behind this heading
6014 org-cycle-skip-children-state-if-no-children))))
6015 ;; Entire subtree is hidden in one line: children view
6029 ;; We just showed the children, or no children are there,
6030 ;; now show everything.
6037 ;; Default action: hide the subtree.
6044 ;;;###autoload
6046 "Cycle the global visibility. For details see `org-cycle'.
6048 With a numeric prefix, show all headlines up to that level."
6064 "Set the visibility required by startup options and properties."
6079 "Switch subtree visibilities according to :VISIBILITY: property."
6086 nil t)
6111 "Switch to overview mode, showing only top-level headlines.
6112 Really, this shows all headlines with level equal or greater than the level
6113 of the first headline in the buffer. This is important, because if the
6114 first headline is not level one, then (hide-sublevels 1) gives confusing
6115 results."
6126 "Show all headlines in the buffer, like a table of contents.
6127 With numerical argument N, show content up to level N."
6130 ;; Visit all headings and show their offspring
6137 t)
6146 "Adjust the window after a change in outline visibility.
6147 This function is the default value of the hook `org-cycle-hook'."
6157 "Remove outline overlays that do not contain non-white stuff."
6167 "Fix visibility issues after moving a subtree."
6168 ;; First, find a reasonable region to look at:
6169 ;; Start two siblings above, end three below
6187 ;; Properly fold already folded siblings
6198 "Show empty lines above all visible headlines.
6199 The region to be covered depends on STATE when called through
6200 `org-cycle-hook'. Lisp program can use t for STATE to get the
6201 entire buffer covered. Note that an empty line is only shown if there
6202 are at least `org-cycle-separator-lines' empty lines before the headline."
6212 beg end b e)
6236 ;; Never hide empty lines at the end of the file.
6246 "Move to the parent and re-show empty lines before visible headlines."
6252 "Return `org-agenda-files' list, plus all open org-mode files.
6253 This is useful for operations that need to scan all of a user's
6254 open and agenda-wise Org files."
6262 files))
6265 "Return the beginning position of the current entry."
6269 "Return the end position of the current entry."
6273 "Re-hide all drawers after a visibility state change."
6300 "Is the end of the current subtree visible?"
6305 "Move cursor to the first headline and recenter the headline.
6306 Optional argument N means put the headline into the Nth line of the window."
6312 ;;; Saving and restoring visibility
6315 "Return a list of the locations of all outline overlays.
6316 These are overlays with the `invisible' property value `outline'.
6317 The return value is a list of cons cells, with start and stop
6318 positions for each overlay.
6319 If USE-MARKERS is set, return the positions as markers."
6337 "Create visibility overlays for all positions in DATA.
6338 DATA should have been made by `org-outline-overlay-data'."
6347 data)))))
6349 ;;; Folding of blocks
6361 "Call FUNCTION at the head of all source blocks in the current buffer.
6362 Optional arguments START and END can be used to limit the range."
6374 "Toggle the visibility of all blocks in the current buffer."
6378 "Fold all blocks in the current buffer."
6384 "Unfold all blocks in the current buffer."
6390 "Toggle visibility of block at point."
6401 "Toggle the visibility of the current block."
6408 ov)
6424 ;; make the block accessible to isearch
6426 ov 'isearch-open-invisible
6437 ;; org-tab-after-check-for-cycling-hook
6439 ;; Remove overlays when changing major mode
6444 ;;; Org-goto
6450 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6466 nil)
6467 (org-defkey map "q" 'org-goto-quit)
6468 (org-defkey map "n" 'outline-next-visible-heading)
6469 (org-defkey map "p" 'outline-previous-visible-heading)
6470 (org-defkey map "f" 'outline-forward-same-level)
6471 (org-defkey map "b" 'outline-backward-same-level)
6472 (org-defkey map "u" 'outline-up-heading))
6473 (org-defkey map "/" 'org-occur)
6474 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6475 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6476 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6477 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6478 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6479 map))
6481 (defconst org-goto-help
6482 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6483 RET=jump to location [Q]uit and return to previous location
6484 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6486 (defvar org-goto-start-pos) ; dynamically scoped parameter
6488 ;; FIXME: Docstring does not mention both interfaces
6489 (defun org-goto (&optional alternative-interface)
6490 "Look up a different location in the current file, keeping current visibility.
6492 When you want look-up or go to a different location in a document, the
6493 fastest way is often to fold the entire buffer and then dive into the tree.
6494 This method has the disadvantage, that the previous location will be folded,
6495 which may not be what you want.
6497 This command works around this by showing a copy of the current buffer
6498 in an indirect buffer, in overview mode. You can dive into the tree in
6499 that copy, use org-occur and incremental search to find a location.
6500 When pressing RET or `Q', the command returns to the original buffer in
6501 which the visibility is still unchanged. After RET is will also jump to
6502 the location selected in the indirect buffer and expose the
6503 the headline hierarchy above."
6504 (interactive "P")
6505 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6506 (org-refile-use-outline-path t)
6507 (org-refile-target-verify-function nil)
6508 (interface
6509 (if (not alternative-interface)
6510 org-goto-interface
6511 (if (eq org-goto-interface 'outline)
6512 'outline-path-completion
6513 'outline)))
6514 (org-goto-start-pos (point))
6515 (selected-point
6516 (if (eq interface 'outline)
6517 (car (org-get-location (current-buffer) org-goto-help))
6518 (let ((pa (org-refile-get-location "Goto: ")))
6519 (org-refile-check-position pa)
6520 (nth 3 pa)))))
6521 (if selected-point
6522 (progn
6523 (org-mark-ring-push org-goto-start-pos)
6524 (goto-char selected-point)
6525 (if (or (org-invisible-p) (org-invisible-p2))
6526 (org-show-context 'org-goto)))
6527 (message "Quit"))))
6529 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6530 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6531 (defvar org-goto-local-auto-isearch-map) ; defined below
6533 (defun org-get-location (buf help)
6534 "Let the user select a location in the Org-mode buffer BUF.
6535 This function uses a recursive edit. It returns the selected position
6536 or nil."
6537 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6538 (isearch-hide-immediately nil)
6539 (isearch-search-fun-function
6540 (lambda () 'org-goto-local-search-headings))
6541 (org-goto-selected-point org-goto-exit-command)
6542 (pop-up-frames nil)
6543 (special-display-buffer-names nil)
6544 (special-display-regexps nil)
6545 (special-display-function nil))
6546 (save-excursion
6547 (save-window-excursion
6548 (delete-other-windows)
6549 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6550 (switch-to-buffer
6551 (condition-case nil
6552 (make-indirect-buffer (current-buffer) "*org-goto*")
6553 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6554 (with-output-to-temp-buffer "*Help*"
6555 (princ help))
6556 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6557 (setq buffer-read-only nil)
6558 (let ((org-startup-truncated t)
6559 (org-startup-folded nil)
6560 (org-startup-align-all-tables nil))
6561 (org-mode)
6562 (org-overview))
6563 (setq buffer-read-only t)
6564 (if (and (boundp 'org-goto-start-pos)
6565 (integer-or-marker-p org-goto-start-pos))
6566 (let ((org-show-hierarchy-above t)
6567 (org-show-siblings t)
6568 (org-show-following-heading t))
6569 (goto-char org-goto-start-pos)
6570 (and (org-invisible-p) (org-show-context)))
6571 (goto-char (point-min)))
6572 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6573 (message "Select location and press RET")
6574 (use-local-map org-goto-map)
6575 (recursive-edit)
6576 ))
6577 (kill-buffer "*org-goto*")
6578 (cons org-goto-selected-point org-goto-exit-command)))
6580 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6581 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6582 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6583 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6585 (defun org-goto-local-search-headings (string bound noerror)
6586 "Search and make sure that any matches are in headlines."
6587 (catch 'return
6588 (while (if isearch-forward
6589 (search-forward string bound noerror)
6590 (search-backward string bound noerror))
6591 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6592 (and (member :headline context)
6593 (not (member :tags context))))
6594 (throw 'return (point))))))
6596 (defun org-goto-local-auto-isearch ()
6597 "Start isearch."
6598 (interactive)
6599 (goto-char (point-min))
6600 (let ((keys (this-command-keys)))
6601 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6602 (isearch-mode t)
6603 (isearch-process-search-char (string-to-char keys)))))
6605 (defun org-goto-ret (&optional arg)
6606 "Finish `org-goto' by going to the new location."
6607 (interactive "P")
6608 (setq org-goto-selected-point (point)
6609 org-goto-exit-command 'return)
6610 (throw 'exit nil))
6612 (defun org-goto-left ()
6613 "Finish `org-goto' by going to the new location."
6614 (interactive)
6615 (if (org-on-heading-p)
6616 (progn
6617 (beginning-of-line 1)
6618 (setq org-goto-selected-point (point)
6619 org-goto-exit-command 'left)
6620 (throw 'exit nil))
6621 (error "Not on a heading")))
6623 (defun org-goto-right ()
6624 "Finish `org-goto' by going to the new location."
6625 (interactive)
6626 (if (org-on-heading-p)
6627 (progn
6628 (setq org-goto-selected-point (point)
6629 org-goto-exit-command 'right)
6630 (throw 'exit nil))
6631 (error "Not on a heading")))
6633 (defun org-goto-quit ()
6634 "Finish `org-goto' without cursor motion."
6635 (interactive)
6636 (setq org-goto-selected-point nil)
6637 (setq org-goto-exit-command 'quit)
6638 (throw 'exit nil))
6640 ;;; Indirect buffer display of subtrees
6642 (defvar org-indirect-dedicated-frame nil
6643 "This is the frame being used for indirect tree display.")
6644 (defvar org-last-indirect-buffer nil)
6646 (defun org-tree-to-indirect-buffer (&optional arg)
6647 "Create indirect buffer and narrow it to current subtree.
6648 With numerical prefix ARG, go up to this level and then take that tree.
6649 If ARG is negative, go up that many levels.
6650 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6651 indirect buffer previously made with this command, to avoid proliferation of
6652 indirect buffers. However, when you call the command with a \
6654 when `org-indirect-buffer-display' is `new-frame', the last buffer
6655 is kept so that you can work with several indirect buffers at the same time.
6656 If `org-indirect-buffer-display' is `dedicated-frame', the \
6658 requests that a new frame be made for the new buffer, so that the dedicated
6659 frame is not changed."
6660 (interactive "P")
6661 (let ((cbuf (current-buffer))
6662 (cwin (selected-window))
6663 (pos (point))
6664 beg end level heading ibuf)
6665 (save-excursion
6666 (org-back-to-heading t)
6667 (when (numberp arg)
6668 (setq level (org-outline-level))
6669 (if (< arg 0) (setq arg (+ level arg)))
6670 (while (> (setq level (org-outline-level)) arg)
6671 (outline-up-heading 1 t)))
6672 (setq beg (point)
6673 heading (org-get-heading))
6674 (org-end-of-subtree t t)
6675 (if (org-on-heading-p) (backward-char 1))
6676 (setq end (point)))
6677 (if (and (buffer-live-p org-last-indirect-buffer)
6678 (not (eq org-indirect-buffer-display 'new-frame))
6679 (not arg))
6680 (kill-buffer org-last-indirect-buffer))
6681 (setq ibuf (org-get-indirect-buffer cbuf)
6682 org-last-indirect-buffer ibuf)
6683 (cond
6684 ((or (eq org-indirect-buffer-display 'new-frame)
6685 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6686 (select-frame (make-frame))
6687 (delete-other-windows)
6688 (switch-to-buffer ibuf)
6689 (org-set-frame-title heading))
6690 ((eq org-indirect-buffer-display 'dedicated-frame)
6691 (raise-frame
6692 (select-frame (or (and org-indirect-dedicated-frame
6693 (frame-live-p org-indirect-dedicated-frame)
6694 org-indirect-dedicated-frame)
6695 (setq org-indirect-dedicated-frame (make-frame)))))
6696 (delete-other-windows)
6697 (switch-to-buffer ibuf)
6698 (org-set-frame-title (concat "Indirect: " heading)))
6699 ((eq org-indirect-buffer-display 'current-window)
6700 (switch-to-buffer ibuf))
6701 ((eq org-indirect-buffer-display 'other-window)
6702 (pop-to-buffer ibuf))
6703 (t (error "Invalid value")))
6704 (if (featurep 'xemacs)
6705 (save-excursion (org-mode) (turn-on-font-lock)))
6706 (narrow-to-region beg end)
6707 (show-all)
6708 (goto-char pos)
6709 (and (window-live-p cwin) (select-window cwin))))
6711 (defun org-get-indirect-buffer (&optional buffer)
6712 (setq buffer (or buffer (current-buffer)))
6713 (let ((n 1) (base (buffer-name buffer)) bname)
6714 (while (buffer-live-p
6715 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6716 (setq n (1+ n)))
6717 (condition-case nil
6718 (make-indirect-buffer buffer bname 'clone)
6719 (error (make-indirect-buffer buffer bname)))))
6721 (defun org-set-frame-title (title)
6722 "Set the title of the current frame to the string TITLE."
6723 ;; FIXME: how to name a single frame in XEmacs???
6724 (unless (featurep 'xemacs)
6725 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6727 ;;;; Structure editing
6729 ;;; Inserting headlines
6731 (defun org-previous-line-empty-p ()
6732 (save-excursion
6733 (and (not (bobp))
6734 (or (beginning-of-line 0) t)
6735 (save-match-data
6738 (defun org-insert-heading (&optional force-heading invisible-ok)
6739 "Insert a new heading or item with same depth at point.
6740 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6741 If point is at the beginning of a headline, insert a sibling before the
6742 current headline. If point is not at the beginning, split the line,
6743 create the new headline with the text in the current line after point
6744 \(but see also the variable `org-M-RET-may-split-line').
6746 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6747 This is important for non-interactive uses of the command."
6748 (interactive "P")
6749 (if (or (= (buffer-size) 0)
6750 (and (not (save-excursion
6751 (and (ignore-errors (org-back-to-heading invisible-ok))
6752 (org-on-heading-p))))
6753 (not (org-in-item-p))))
6754 (progn
6756 (run-hooks 'org-insert-heading-hook))
6757 (when (or force-heading (not (org-insert-item)))
6758 (let* ((empty-line-p nil)
6759 (level nil)
6760 (on-heading (org-on-heading-p))
6761 (head (save-excursion
6762 (condition-case nil
6763 (progn
6764 (org-back-to-heading invisible-ok)
6765 (when (and (not on-heading)
6766 (featurep 'org-inlinetask)
6767 (integerp org-inlinetask-min-level)
6768 (>= (length (match-string 0))
6769 org-inlinetask-min-level))
6770 ;; Find a heading level before the inline task
6771 (while (and (setq level (org-up-heading-safe))
6772 (>= level org-inlinetask-min-level)))
6773 (if (org-on-heading-p)
6774 (org-back-to-heading invisible-ok)
6775 (error "This should not happen")))
6776 (setq empty-line-p (org-previous-line-empty-p))
6777 (match-string 0))
6778 (error "*"))))
6779 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6780 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6781 pos hide-previous previous-pos)
6782 (cond
6783 ((and (org-on-heading-p) (bolp)
6784 (or (bobp)
6785 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6786 ;; insert before the current line
6787 (open-line (if blank 2 1)))
6788 ((and (bolp)
6789 (not org-insert-heading-respect-content)
6790 (or (bobp)
6791 (save-excursion
6792 (backward-char 1) (not (org-invisible-p)))))
6793 ;; insert right here
6794 nil)
6795 (t
6796 ;; somewhere in the line
6797 (save-excursion
6798 (setq previous-pos (point-at-bol))
6799 (end-of-line)
6800 (setq hide-previous (org-invisible-p)))
6801 (and org-insert-heading-respect-content (org-show-subtree))
6802 (let ((split
6803 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6804 (save-excursion
6805 (let ((p (point)))
6806 (goto-char (point-at-bol))
6807 (and (looking-at org-complex-heading-regexp)
6808 (> p (match-beginning 4)))))))
6809 tags pos)
6810 (cond
6811 (org-insert-heading-respect-content
6812 (org-end-of-subtree nil t)
6813 (when (featurep 'org-inlinetask)
6814 (while (and (not (eobp))
6816 (>= (length (match-string 1))
6817 org-inlinetask-min-level))
6818 (org-end-of-subtree nil t)))
6819 (or (bolp) (newline))
6820 (or (org-previous-line-empty-p)
6821 (and blank (newline)))
6822 (open-line 1))
6823 ((org-on-heading-p)
6824 (when hide-previous
6825 (show-children)
6826 (org-show-entry))
6828 (setq tags (and (match-end 2) (match-string 2)))
6829 (and (match-end 1)
6830 (delete-region (match-beginning 1) (match-end 1)))
6831 (setq pos (point-at-bol))
6832 (or split (end-of-line 1))
6833 (delete-horizontal-space)
6835 (buffer-substring (point-at-bol) (point)))
6836 (insert " "))
6837 (newline (if blank 2 1))
6838 (when tags
6839 (save-excursion
6840 (goto-char pos)
6841 (end-of-line 1)
6842 (insert " " tags)
6843 (org-set-tags nil 'align))))
6844 (t
6845 (or split (end-of-line 1))
6846 (newline (if blank 2 1)))))))
6847 (insert head) (just-one-space)
6848 (setq pos (point))
6849 (end-of-line 1)
6850 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6851 (when (and org-insert-heading-respect-content hide-previous)
6852 (save-excursion
6853 (goto-char previous-pos)
6854 (hide-subtree)))
6855 (run-hooks 'org-insert-heading-hook)))))
6857 (defun org-get-heading (&optional no-tags)
6858 "Return the heading of the current entry, without the stars."
6859 (save-excursion
6860 (org-back-to-heading t)
6861 (if (looking-at
6862 (if no-tags
6865 (match-string 1) "")))
6867 (defun org-heading-components ()
6868 "Return the components of the current heading.
6869 This is a list with the following elements:
6870 - the level as an integer
6871 - the reduced level, different if `org-odd-levels-only' is set.
6872 - the TODO keyword, or nil
6873 - the priority character, like ?A, or nil if no priority is given
6874 - the headline text itself, or the tags string if no headline text
6875 - the tags string, or nil."
6876 (save-excursion
6877 (org-back-to-heading t)
6878 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6879 (list (length (match-string 1))
6880 (org-reduced-level (length (match-string 1)))
6881 (org-match-string-no-properties 2)
6882 (and (match-end 3) (aref (match-string 3) 2))
6883 (org-match-string-no-properties 4)
6884 (org-match-string-no-properties 5)))))
6886 (defun org-get-entry ()
6887 "Get the entry text, after heading, entire subtree."
6888 (save-excursion
6889 (org-back-to-heading t)
6890 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6892 (defun org-insert-heading-after-current ()
6893 "Insert a new heading with same level as current, after current subtree."
6894 (interactive)
6895 (org-back-to-heading)
6896 (org-insert-heading)
6897 (org-move-subtree-down)
6898 (end-of-line 1))
6900 (defun org-insert-heading-respect-content ()
6901 (interactive)
6902 (let ((org-insert-heading-respect-content t))
6903 (org-insert-heading t)))
6905 (defun org-insert-todo-heading-respect-content (&optional force-state)
6906 (interactive "P")
6907 (let ((org-insert-heading-respect-content t))
6908 (org-insert-todo-heading force-state t)))
6910 (defun org-insert-todo-heading (arg &optional force-heading)
6911 "Insert a new heading with the same level and TODO state as current heading.
6912 If the heading has no TODO state, or if the state is DONE, use the first
6913 state (TODO by default). Also with prefix arg, force first state."
6914 (interactive "P")
6915 (when (or force-heading (not (org-insert-item 'checkbox)))
6916 (org-insert-heading force-heading)
6917 (save-excursion
6918 (org-back-to-heading)
6919 (outline-previous-heading)
6920 (looking-at org-todo-line-regexp))
6921 (let*
6922 ((new-mark-x
6923 (if (or arg
6924 (not (match-beginning 2))
6925 (member (match-string 2) org-done-keywords))
6926 (car org-todo-keywords-1)
6927 (match-string 2)))
6928 (new-mark
6929 (or
6930 (run-hook-with-args-until-success
6931 'org-todo-get-default-hook new-mark-x nil)
6932 new-mark-x)))
6933 (beginning-of-line 1)
6935 (if org-treat-insert-todo-heading-as-state-change
6936 (org-todo new-mark)
6937 (insert new-mark " "))))
6938 (when org-provide-todo-statistics
6939 (org-update-parent-todo-statistics))))
6941 (defun org-insert-subheading (arg)
6942 "Insert a new subheading and demote it.
6943 Works for outline headings and for plain lists alike."
6944 (interactive "P")
6945 (org-insert-heading arg)
6946 (cond
6947 ((org-on-heading-p) (org-do-demote))
6948 ((org-at-item-p) (org-indent-item))))
6950 (defun org-insert-todo-subheading (arg)
6951 "Insert a new subheading with TODO keyword or checkbox and demote it.
6952 Works for outline headings and for plain lists alike."
6953 (interactive "P")
6954 (org-insert-todo-heading arg)
6955 (cond
6956 ((org-on-heading-p) (org-do-demote))
6957 ((org-at-item-p) (org-indent-item))))
6959 ;;; Promotion and Demotion
6961 (defvar org-after-demote-entry-hook nil
6962 "Hook run after an entry has been demoted.
6963 The cursor will be at the beginning of the entry.
6964 When a subtree is being demoted, the hook will be called for each node.")
6966 (defvar org-after-promote-entry-hook nil
6967 "Hook run after an entry has been promoted.
6968 The cursor will be at the beginning of the entry.
6969 When a subtree is being promoted, the hook will be called for each node.")
6971 (defun org-promote-subtree ()
6972 "Promote the entire subtree.
6973 See also `org-promote'."
6974 (interactive)
6975 (save-excursion
6976 (org-map-tree 'org-promote))
6977 (org-fix-position-after-promote))
6979 (defun org-demote-subtree ()
6980 "Demote the entire subtree. See `org-demote'.
6981 See also `org-promote'."
6982 (interactive)
6983 (save-excursion
6984 (org-map-tree 'org-demote))
6985 (org-fix-position-after-promote))
6988 (defun org-do-promote ()
6989 "Promote the current heading higher up the tree.
6990 If the region is active in `transient-mark-mode', promote all headings
6991 in the region."
6992 (interactive)
6993 (save-excursion
6994 (if (org-region-active-p)
6995 (org-map-region 'org-promote (region-beginning) (region-end))
6996 (org-promote)))
6997 (org-fix-position-after-promote))
6999 (defun org-do-demote ()
7000 "Demote the current heading lower down the tree.
7001 If the region is active in `transient-mark-mode', demote all headings
7002 in the region."
7003 (interactive)
7004 (save-excursion
7005 (if (org-region-active-p)
7006 (org-map-region 'org-demote (region-beginning) (region-end))
7007 (org-demote)))
7008 (org-fix-position-after-promote))
7010 (defun org-fix-position-after-promote ()
7011 "Make sure that after pro/demotion cursor position is right."
7012 (let ((pos (point)))
7013 (when (save-excursion
7014 (beginning-of-line 1)
7015 (looking-at org-todo-line-regexp)
7016 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7017 (cond ((eobp) (insert " "))
7018 ((eolp) (insert " "))
7019 ((equal (char-after) ?\ ) (forward-char 1))))))
7021 (defun org-current-level ()
7022 "Return the level of the current entry, or nil if before the first headline.
7023 The level is the number of stars at the beginning of the headline."
7024 (save-excursion
7025 (let ((outline-regexp (org-get-limited-outline-regexp)))
7026 (condition-case nil
7027 (progn
7028 (org-back-to-heading t)
7029 (funcall outline-level))
7030 (error nil)))))
7032 (defun org-get-previous-line-level ()
7033 "Return the outline depth of the last headline before the current line.
7034 Returns 0 for the first headline in the buffer, and nil if before the
7035 first headline."
7036 (let ((current-level (org-current-level))
7037 (prev-level (when (> (line-number-at-pos) 1)
7038 (save-excursion
7039 (beginning-of-line 0)
7040 (org-current-level)))))
7041 (cond ((null current-level) nil) ; Before first headline
7042 ((null prev-level) 0) ; At first headline
7043 (prev-level))))
7045 (defun org-reduced-level (l)
7046 "Compute the effective level of a heading.
7047 This takes into account the setting of `org-odd-levels-only'."
7048 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
7050 (defun org-level-increment ()
7051 "Return the number of stars that will be added or removed at a
7052 time to headlines when structure editing, based on the value of
7053 `org-odd-levels-only'."
7054 (if org-odd-levels-only 2 1))
7056 (defun org-get-valid-level (level &optional change)
7057 "Rectify a level change under the influence of `org-odd-levels-only'
7058 LEVEL is a current level, CHANGE is by how much the level should be
7059 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7060 even level numbers will become the next higher odd number."
7061 (if org-odd-levels-only
7062 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7063 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7064 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7065 (max 1 (+ level (or change 0)))))
7067 (if (boundp 'define-obsolete-function-alias)
7068 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7069 (define-obsolete-function-alias 'org-get-legal-level
7070 'org-get-valid-level)
7071 (define-obsolete-function-alias 'org-get-legal-level
7072 'org-get-valid-level "23.1")))
7074 (defun org-promote ()
7075 "Promote the current heading higher up the tree.
7076 If the region is active in `transient-mark-mode', promote all headings
7077 in the region."
7078 (org-back-to-heading t)
7079 (let* ((level (save-match-data (funcall outline-level)))
7080 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7081 (diff (abs (- level (length up-head) -1))))
7082 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7083 (replace-match up-head nil t)
7084 ;; Fixup tag positioning
7085 (and org-auto-align-tags (org-set-tags nil t))
7086 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7087 (run-hooks 'org-after-promote-entry-hook)))
7089 (defun org-demote ()
7090 "Demote the current heading lower down the tree.
7091 If the region is active in `transient-mark-mode', demote all headings
7092 in the region."
7093 (org-back-to-heading t)
7094 (let* ((level (save-match-data (funcall outline-level)))
7095 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7096 (diff (abs (- level (length down-head) -1))))
7097 (replace-match down-head nil t)
7098 ;; Fixup tag positioning
7099 (and org-auto-align-tags (org-set-tags nil t))
7100 (if org-adapt-indentation (org-fixup-indentation diff))
7101 (run-hooks 'org-after-demote-entry-hook)))
7103 (defun org-cycle-level ()
7104 "Cycle the level of an empty headline through possible states.
7105 This goes first to child, then to parent, level, then up the hierarchy.
7106 After top level, it switches back to sibling level."
7107 (interactive)
7108 (let ((org-adapt-indentation nil))
7109 (when (org-point-at-end-of-empty-headline)
7110 (setq this-command 'org-cycle-level) ; Only needed for caching
7111 (let ((cur-level (org-current-level))
7112 (prev-level (org-get-previous-line-level)))
7113 (cond
7114 ;; If first headline in file, promote to top-level.
7115 ((= prev-level 0)
7116 (loop repeat (/ (- cur-level 1) (org-level-increment))
7117 do (org-do-promote)))
7118 ;; If same level as prev, demote one.
7119 ((= prev-level cur-level)
7120 (org-do-demote))
7121 ;; If parent is top-level, promote to top level if not already.
7122 ((= prev-level 1)
7123 (loop repeat (/ (- cur-level 1) (org-level-increment))
7124 do (org-do-promote)))
7125 ;; If top-level, return to prev-level.
7126 ((= cur-level 1)
7127 (loop repeat (/ (- prev-level 1) (org-level-increment))
7128 do (org-do-demote)))
7129 ;; If less than prev-level, promote one.
7130 ((< cur-level prev-level)
7131 (org-do-promote))
7132 ;; If deeper than prev-level, promote until higher than
7133 ;; prev-level.
7134 ((> cur-level prev-level)
7135 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7136 do (org-do-promote))))
7137 t))))
7139 (defun org-map-tree (fun)
7140 "Call FUN for every heading underneath the current one."
7141 (org-back-to-heading)
7142 (let ((level (funcall outline-level)))
7143 (save-excursion
7144 (funcall fun)
7145 (while (and (progn
7146 (outline-next-heading)
7147 (> (funcall outline-level) level))
7148 (not (eobp)))
7149 (funcall fun)))))
7151 (defun org-map-region (fun beg end)
7152 "Call FUN for every heading between BEG and END."
7153 (let ((org-ignore-region t))
7154 (save-excursion
7155 (setq end (copy-marker end))
7156 (goto-char beg)
7157 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
7158 (< (point) end))
7159 (funcall fun))
7160 (while (and (progn
7161 (outline-next-heading)
7162 (< (point) end))
7163 (not (eobp)))
7164 (funcall fun)))))
7166 (defun org-fixup-indentation (diff)
7167 "Change the indentation in the current entry by DIFF.
7168 However, if any line in the current entry has no indentation, or if it
7169 would end up with no indentation after the change, nothing at all is done."
7170 (save-excursion
7171 (let ((end (save-excursion (outline-next-heading)
7172 (point-marker)))
7173 (prohibit (if (> diff 0)
7176 col)
7177 (unless (save-excursion (end-of-line 1)
7178 (re-search-forward prohibit end t))
7179 (while (and (< (point) end)
7181 (goto-char (match-end 0))
7182 (setq col (current-column))
7183 (if (< diff 0) (replace-match ""))
7184 (org-indent-to-column (+ diff col))))
7185 (move-marker end nil))))
7187 (defun org-convert-to-odd-levels ()
7188 "Convert an org-mode file with all levels allowed to one with odd levels.
7189 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7190 level 5 etc."
7191 (interactive)
7192 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7193 (let ((outline-regexp org-outline-regexp)
7194 (outline-level 'org-outline-level)
7195 (org-odd-levels-only nil) n)
7196 (save-excursion
7197 (goto-char (point-min))
7199 (setq n (- (length (match-string 0)) 2))
7200 (while (>= (setq n (1- n)) 0)
7201 (org-demote))
7202 (end-of-line 1))))))
7204 (defun org-convert-to-oddeven-levels ()
7205 "Convert an org-mode file with only odd levels to one with odd/even levels.
7206 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7207 file contains a section with an even level, conversion would
7208 destroy the structure of the file. An error is signaled in this
7209 case."
7210 (interactive)
7211 (goto-char (point-min))
7212 ;; First check if there are no even levels
7214 (org-show-context t)
7215 (error "Not all levels are odd in this file. Conversion not possible"))
7216 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7217 (let ((outline-regexp org-outline-regexp)
7218 (outline-level 'org-outline-level)
7219 (org-odd-levels-only nil) n)
7220 (save-excursion
7221 (goto-char (point-min))
7223 (setq n (/ (1- (length (match-string 0))) 2))
7224 (while (>= (setq n (1- n)) 0)
7225 (org-promote))
7226 (end-of-line 1))))))
7228 (defun org-tr-level (n)
7229 "Make N odd if required."
7230 (if org-odd-levels-only (1+ (/ n 2)) n))
7232 ;;; Vertical tree motion, cutting and pasting of subtrees
7234 (defun org-move-subtree-up (&optional arg)
7235 "Move the current subtree up past ARG headlines of the same level."
7236 (interactive "p")
7237 (org-move-subtree-down (- (prefix-numeric-value arg))))
7239 (defun org-move-subtree-down (&optional arg)
7240 "Move the current subtree down past ARG headlines of the same level."
7241 (interactive "p")
7242 (setq arg (prefix-numeric-value arg))
7243 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7244 'org-get-last-sibling))
7245 (ins-point (make-marker))
7246 (cnt (abs arg))
7247 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7248 ;; Select the tree
7249 (org-back-to-heading)
7250 (setq beg0 (point))
7251 (save-excursion
7252 (setq ne-beg (org-back-over-empty-lines))
7253 (setq beg (point)))
7254 (save-match-data
7255 (save-excursion (outline-end-of-heading)
7256 (setq folded (org-invisible-p)))
7257 (outline-end-of-subtree))
7258 (outline-next-heading)
7259 (setq ne-end (org-back-over-empty-lines))
7260 (setq end (point))
7261 (goto-char beg0)
7262 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7263 ;; include less whitespace
7264 (save-excursion
7265 (goto-char beg)
7266 (forward-line (- ne-beg ne-end))
7267 (setq beg (point))))
7268 ;; Find insertion point, with error handling
7269 (while (> cnt 0)
7270 (or (and (funcall movfunc) (looking-at outline-regexp))
7271 (progn (goto-char beg0)
7272 (error "Cannot move past superior level or buffer limit")))
7273 (setq cnt (1- cnt)))
7274 (if (> arg 0)
7275 ;; Moving forward - still need to move over subtree
7276 (progn (org-end-of-subtree t t)
7277 (save-excursion
7278 (org-back-over-empty-lines)
7279 (or (bolp) (newline)))))
7280 (setq ne-ins (org-back-over-empty-lines))
7281 (move-marker ins-point (point))
7282 (setq txt (buffer-substring beg end))
7283 (org-save-markers-in-region beg end)
7284 (delete-region beg end)
7285 (org-remove-empty-overlays-at beg)
7286 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7287 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7289 (let ((bbb (point)))
7290 (insert-before-markers txt)
7291 (org-reinstall-markers-in-region bbb)
7292 (move-marker ins-point bbb))
7294 (setq ins-end (point))
7295 (goto-char ins-point)
7296 (org-skip-whitespace)
7297 (when (and (< arg 0)
7298 (org-first-sibling-p)
7299 (> ne-ins ne-beg))
7300 ;; Move whitespace back to beginning
7301 (save-excursion
7302 (goto-char ins-end)
7303 (let ((kill-whole-line t))
7304 (kill-line (- ne-ins ne-beg)) (point)))
7306 (move-marker ins-point nil)
7307 (if folded
7308 (hide-subtree)
7309 (org-show-entry)
7310 (show-children)
7311 (org-cycle-hide-drawers 'children))
7312 (org-clean-visibility-after-subtree-move)))
7314 (defvar org-subtree-clip ""
7315 "Clipboard for cut and paste of subtrees.
7316 This is actually only a copy of the kill, because we use the normal kill
7317 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7319 (defvar org-subtree-clip-folded nil
7320 "Was the last copied subtree folded?
7321 This is used to fold the tree back after pasting.")
7323 (defun org-cut-subtree (&optional n)
7324 "Cut the current subtree into the clipboard.
7325 With prefix arg N, cut this many sequential subtrees.
7326 This is a short-hand for marking the subtree and then cutting it."
7327 (interactive "p")
7328 (org-copy-subtree n 'cut))
7330 (defun org-copy-subtree (&optional n cut force-store-markers)
7331 "Cut the current subtree into the clipboard.
7332 With prefix arg N, cut this many sequential subtrees.
7333 This is a short-hand for marking the subtree and then copying it.
7334 If CUT is non-nil, actually cut the subtree.
7335 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7336 of some markers in the region, even if CUT is non-nil. This is
7337 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7338 (interactive "p")
7339 (let (beg end folded (beg0 (point)))
7340 (if (interactive-p)
7341 (org-back-to-heading nil) ; take what looks like a subtree
7342 (org-back-to-heading t)) ; take what is really there
7343 (org-back-over-empty-lines)
7344 (setq beg (point))
7346 (save-match-data
7347 (save-excursion (outline-end-of-heading)
7348 (setq folded (org-invisible-p)))
7349 (condition-case nil
7350 (org-forward-same-level (1- n) t)
7351 (error nil))
7352 (org-end-of-subtree t t))
7353 (org-back-over-empty-lines)
7354 (setq end (point))
7355 (goto-char beg0)
7356 (when (> end beg)
7357 (setq org-subtree-clip-folded folded)
7358 (when (or cut force-store-markers)
7359 (org-save-markers-in-region beg end))
7360 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7361 (setq org-subtree-clip (current-kill 0))
7362 (message "%s: Subtree(s) with %d characters"
7363 (if cut "Cut" "Copied")
7364 (length org-subtree-clip)))))
7366 (defun org-paste-subtree (&optional level tree for-yank)
7367 "Paste the clipboard as a subtree, with modification of headline level.
7368 The entire subtree is promoted or demoted in order to match a new headline
7369 level.
7371 If the cursor is at the beginning of a headline, the same level as
7372 that headline is used to paste the tree
7374 If not, the new level is derived from the *visible* headings
7375 before and after the insertion point, and taken to be the inferior headline
7376 level of the two. So if the previous visible heading is level 3 and the
7377 next is level 4 (or vice versa), level 4 will be used for insertion.
7378 This makes sure that the subtree remains an independent subtree and does
7379 not swallow low level entries.
7381 You can also force a different level, either by using a numeric prefix
7382 argument, or by inserting the heading marker by hand. For example, if the
7385 If optional TREE is given, use this text instead of the kill ring.
7387 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7388 move back over whitespace before inserting, and move point to the end of
7389 the inserted text when done."
7390 (interactive "P")
7391 (setq tree (or tree (and kill-ring (current-kill 0))))
7392 (unless (org-kill-is-subtree-p tree)
7393 (error "%s"
7394 (substitute-command-keys
7396 (let* ((visp (not (org-invisible-p)))
7397 (txt tree)
7402 (old-level (if (string-match ^re txt)
7403 (- (match-end 0) (match-beginning 0) 1)
7404 -1))
7405 (force-level (cond (level (prefix-numeric-value level))
7407 (string-match
7408 ^re_ (buffer-substring
7409 (point-at-bol) (point))))
7410 (- (match-end 1) (match-beginning 1)))
7411 ((and (bolp)
7412 (looking-at org-outline-regexp))
7413 (- (match-end 0) (point) 1))
7414 (t nil)))
7415 (previous-level (save-excursion
7416 (condition-case nil
7417 (progn
7418 (outline-previous-visible-heading 1)
7419 (if (looking-at re)
7420 (- (match-end 0) (match-beginning 0) 1)
7421 1))
7422 (error 1))))
7423 (next-level (save-excursion
7424 (condition-case nil
7425 (progn
7426 (or (looking-at outline-regexp)
7427 (outline-next-visible-heading 1))
7428 (if (looking-at re)
7429 (- (match-end 0) (match-beginning 0) 1)
7430 1))
7431 (error 1))))
7432 (new-level (or force-level (max previous-level next-level)))
7433 (shift (if (or (= old-level -1)
7434 (= new-level -1)
7435 (= old-level new-level))
7436 0
7437 (- new-level old-level)))
7438 (delta (if (> shift 0) -1 1))
7439 (func (if (> shift 0) 'org-demote 'org-promote))
7440 (org-odd-levels-only nil)
7441 beg end newend)
7442 ;; Remove the forced level indicator
7443 (if force-level
7444 (delete-region (point-at-bol) (point)))
7445 ;; Paste
7446 (beginning-of-line 1)
7447 (unless for-yank (org-back-over-empty-lines))
7448 (setq beg (point))
7449 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7450 (insert-before-markers txt)
7452 (setq newend (point))
7453 (org-reinstall-markers-in-region beg)
7454 (setq end (point))
7455 (goto-char beg)
7457 (setq beg (point))
7458 (if (and (org-invisible-p) visp)
7459 (save-excursion (outline-show-heading)))
7460 ;; Shift if necessary
7461 (unless (= shift 0)
7462 (save-restriction
7463 (narrow-to-region beg end)
7464 (while (not (= shift 0))
7465 (org-map-region func (point-min) (point-max))
7466 (setq shift (+ delta shift)))
7467 (goto-char (point-min))
7468 (setq newend (point-max))))
7469 (when (or (interactive-p) for-yank)
7470 (message "Clipboard pasted as level %d subtree" new-level))
7471 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7472 kill-ring
7473 (eq org-subtree-clip (current-kill 0))
7474 org-subtree-clip-folded)
7475 ;; The tree was folded before it was killed/copied
7476 (hide-subtree))
7477 (and for-yank (goto-char newend))))
7479 (defun org-kill-is-subtree-p (&optional txt)
7480 "Check if the current kill is an outline subtree, or a set of trees.
7481 Returns nil if kill does not start with a headline, or if the first
7482 headline level is not the largest headline level in the tree.
7483 So this will actually accept several entries of equal levels as well,
7484 which is OK for `org-paste-subtree'.
7485 If optional TXT is given, check this string instead of the current kill."
7486 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7487 (start-level (and kill
7490 kill)
7491 (- (match-end 2) (match-beginning 2) 1)))
7492 (re (concat "^" org-outline-regexp))
7493 (start (1+ (or (match-beginning 2) -1))))
7494 (if (not start-level)
7495 (progn
7496 nil) ;; does not even start with a heading
7497 (catch 'exit
7498 (while (setq start (string-match re kill (1+ start)))
7499 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7500 (throw 'exit nil)))
7501 t))))
7503 (defvar org-markers-to-move nil
7504 "Markers that should be moved with a cut-and-paste operation.
7505 Those markers are stored together with their positions relative to
7506 the start of the region.")
7508 (defun org-save-markers-in-region (beg end)
7509 "Check markers in region.
7510 If these markers are between BEG and END, record their position relative
7511 to BEG, so that after moving the block of text, we can put the markers back
7512 into place.
7513 This function gets called just before an entry or tree gets cut from the
7514 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7515 called immediately, to move the markers with the entries."
7516 (setq org-markers-to-move nil)
7517 (when (featurep 'org-clock)
7518 (org-clock-save-markers-for-cut-and-paste beg end))
7519 (when (featurep 'org-agenda)
7520 (org-agenda-save-markers-for-cut-and-paste beg end)))
7522 (defun org-check-and-save-marker (marker beg end)
7523 "Check if MARKER is between BEG and END.
7524 If yes, remember the marker and the distance to BEG."
7525 (when (and (marker-buffer marker)
7526 (equal (marker-buffer marker) (current-buffer)))
7527 (if (and (>= marker beg) (< marker end))
7528 (push (cons marker (- marker beg)) org-markers-to-move))))
7530 (defun org-reinstall-markers-in-region (beg)
7531 "Move all remembered markers to their position relative to BEG."
7532 (mapc (lambda (x)
7533 (move-marker (car x) (+ beg (cdr x))))
7534 org-markers-to-move)
7535 (setq org-markers-to-move nil))
7537 (defun org-narrow-to-subtree ()
7538 "Narrow buffer to the current subtree."
7539 (interactive)
7540 (save-excursion
7541 (save-match-data
7542 (narrow-to-region
7543 (progn (org-back-to-heading t) (point))
7544 (progn (org-end-of-subtree t t)
7545 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7546 (point))))))
7548 (eval-when-compile
7549 (defvar org-property-drawer-re))
7551 (defvar org-property-start-re) ;; defined below
7552 (defun org-clone-subtree-with-time-shift (n &optional shift)
7553 "Clone the task (subtree) at point N times.
7554 The clones will be inserted as siblings.
7556 In interactive use, the user will be prompted for the number of
7557 clones to be produced, and for a time SHIFT, which may be a
7558 repeater as used in time stamps, for example `+3d'.
7560 When a valid repeater is given and the entry contains any time
7561 stamps, the clones will become a sequence in time, with time
7562 stamps in the subtree shifted for each clone produced. If SHIFT
7563 is nil or the empty string, time stamps will be left alone. The
7564 ID property of the original subtree is removed.
7566 If the original subtree did contain time stamps with a repeater,
7567 the following will happen:
7568 - the repeater will be removed in each clone
7569 - an additional clone will be produced, with the current, unshifted
7570 date(s) in the entry.
7571 - the original entry will be placed *after* all the clones, with
7572 repeater intact.
7573 - the start days in the repeater in the original entry will be shifted
7574 to past the last clone.
7575 I this way you can spell out a number of instances of a repeating task,
7576 and still retain the repeater to cover future instances of the task."
7577 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7578 (let (beg end template task idprop
7579 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7580 (if (not (and (integerp n) (> n 0)))
7581 (error "Invalid number of replications %s" n))
7584 shift)))
7585 (error "Invalid shift specification %s" shift))
7586 (when doshift
7587 (setq shift-n (string-to-number (match-string 1 shift))
7588 shift-what (cdr (assoc (match-string 2 shift)
7589 '(("d" . day) ("w" . week)
7590 ("m" . month) ("y" . year))))))
7591 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7592 (setq nmin 1 nmax n)
7593 (org-back-to-heading t)
7594 (setq beg (point))
7595 (setq idprop (org-entry-get nil "ID"))
7596 (org-end-of-subtree t t)
7598 (setq end (point))
7599 (setq template (buffer-substring beg end))
7600 (when (and doshift
7602 (delete-region beg end)
7603 (setq end beg)
7604 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7605 (goto-char end)
7606 (loop for n from nmin to nmax do
7607 ;; prepare clone
7608 (with-temp-buffer
7609 (insert template)
7610 (org-mode)
7611 (goto-char (point-min))
7612 (and idprop (if org-clone-delete-id
7613 (org-entry-delete nil "ID")
7614 (org-id-get-create t)))
7615 (while (re-search-forward org-property-start-re nil t)
7616 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7617 (goto-char (point-min))
7618 (when doshift
7619 (while (re-search-forward org-ts-regexp-both nil t)
7620 (org-timestamp-change (* n shift-n) shift-what))
7621 (unless (= n n-no-remove)
7622 (goto-char (point-min))
7623 (while (re-search-forward org-ts-regexp nil t)
7624 (save-excursion
7625 (goto-char (match-beginning 0))
7627 (delete-region (match-beginning 1) (match-end 1)))))))
7628 (setq task (buffer-string)))
7629 (insert task))
7630 (goto-char beg)))
7632 ;;; Outline Sorting
7634 (defun org-sort (with-case)
7635 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7636 Optional argument WITH-CASE means sort case-sensitively.
7637 With a double prefix argument, also remove duplicate entries."
7638 (interactive "P")
7639 (cond
7640 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7641 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7642 (t
7643 (org-call-with-arg 'org-sort-entries with-case))))
7645 (defun org-sort-remove-invisible (s)
7646 (remove-text-properties 0 (length s) org-rm-props s)
7647 (while (string-match org-bracket-link-regexp s)
7648 (setq s (replace-match (if (match-end 2)
7649 (match-string 3 s)
7650 (match-string 1 s)) t t s)))
7651 s)
7653 (defvar org-priority-regexp) ; defined later in the file
7655 (defvar org-after-sorting-entries-or-items-hook nil
7656 "Hook that is run after a bunch of entries or items have been sorted.
7657 When children are sorted, the cursor is in the parent line when this
7658 hook gets called. When a region or a plain list is sorted, the cursor
7659 will be in the first entry of the sorted region/list.")
7661 (defun org-sort-entries
7662 (&optional with-case sorting-type getkey-func compare-func property)
7663 "Sort entries on a certain level of an outline tree.
7664 If there is an active region, the entries in the region are sorted.
7665 Else, if the cursor is before the first entry, sort the top-level items.
7666 Else, the children of the entry at point are sorted.
7668 Sorting can be alphabetically, numerically, by date/time as given by
7669 a time stamp, by a property or by priority.
7671 The command prompts for the sorting type unless it has been given to the
7672 function through the SORTING-TYPE argument, which needs to be a character,
7673 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7674 precise meaning of each character:
7676 n Numerically, by converting the beginning of the entry/item to a number.
7677 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7678 t By date/time, either the first active time stamp in the entry, or, if
7679 none exist, by the first inactive one.
7680 s By the scheduled date/time.
7681 d By deadline date/time.
7682 c By creation time, which is assumed to be the first inactive time stamp
7683 at the beginning of a line.
7684 p By priority according to the cookie.
7685 r By the value of a property.
7687 Capital letters will reverse the sort order.
7689 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7690 called with point at the beginning of the record. It must return either
7691 a string or a number that should serve as the sorting key for that record.
7693 Comparing entries ignores case by default. However, with an optional argument
7694 WITH-CASE, the sorting considers case as well."
7695 (interactive "P")
7696 (let ((case-func (if with-case 'identity 'downcase))
7697 start beg end stars re re2
7698 txt what tmp)
7699 ;; Find beginning and end of region to sort
7700 (cond
7701 ((org-region-active-p)
7702 ;; we will sort the region
7703 (setq end (region-end)
7704 what "region")
7705 (goto-char (region-beginning))
7706 (if (not (org-on-heading-p)) (outline-next-heading))
7707 (setq start (point)))
7708 ((or (org-on-heading-p)
7709 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7710 ;; we will sort the children of the current headline
7711 (org-back-to-heading)
7712 (setq start (point)
7713 end (progn (org-end-of-subtree t t)
7715 (org-back-over-empty-lines)
7716 (point))
7717 what "children")
7718 (goto-char start)
7719 (show-subtree)
7720 (outline-next-heading))
7721 (t
7722 ;; we will sort the top-level entries in this file
7723 (goto-char (point-min))
7724 (or (org-on-heading-p) (outline-next-heading))
7725 (setq start (point))
7726 (goto-char (point-max))
7727 (beginning-of-line 1)
7729 ;; File ends in a non-white line
7730 (end-of-line 1)
7732 (setq end (point-max))
7733 (setq what "top-level")
7734 (goto-char start)
7735 (show-all)))
7737 (setq beg (point))
7738 (if (>= beg end) (error "Nothing to sort"))
7741 (setq stars (match-string 1)
7742 re (concat "^" (regexp-quote stars) " +")
7743 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
7744 txt (buffer-substring beg end))
7746 (if (and (not (equal stars "*")) (string-match re2 txt))
7747 (error "Region to sort contains a level above the first entry"))
7749 (unless sorting-type
7750 (message
7751 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7753 A/N/T/S/D/C/P/O/F means reversed:"
7754 what)
7755 (setq sorting-type (read-char-exclusive))
7757 (and (= (downcase sorting-type) ?f)
7758 (setq getkey-func
7759 (org-icompleting-read "Sort using function: "
7760 obarray 'fboundp t nil nil))
7761 (setq getkey-func (intern getkey-func)))
7763 (and (= (downcase sorting-type) ?r)
7764 (setq property
7765 (org-icompleting-read "Property: "
7766 (mapcar 'list (org-buffer-property-keys t))
7767 nil t))))
7769 (message "Sorting entries...")
7771 (save-restriction
7772 (narrow-to-region start end)
7773 (let ((dcst (downcase sorting-type))
7774 (case-fold-search nil)
7775 (now (current-time)))
7776 (sort-subr
7777 (/= dcst sorting-type)
7778 ;; This function moves to the beginning character of the "record" to
7779 ;; be sorted.
7780 (lambda nil
7781 (if (re-search-forward re nil t)
7782 (goto-char (match-beginning 0))
7783 (goto-char (point-max))))
7784 ;; This function moves to the last character of the "record" being
7785 ;; sorted.
7786 (lambda nil
7787 (save-match-data
7788 (condition-case nil
7789 (outline-forward-same-level 1)
7790 (error
7791 (goto-char (point-max))))))
7792 ;; This function returns the value that gets sorted against.
7793 (lambda nil
7794 (cond
7795 ((= dcst ?n)
7796 (if (looking-at org-complex-heading-regexp)
7797 (string-to-number (match-string 4))
7798 nil))
7799 ((= dcst ?a)
7800 (if (looking-at org-complex-heading-regexp)
7801 (funcall case-func (match-string 4))
7802 nil))
7803 ((= dcst ?t)
7804 (let ((end (save-excursion (outline-next-heading) (point))))
7805 (if (or (re-search-forward org-ts-regexp end t)
7806 (re-search-forward org-ts-regexp-both end t))
7807 (org-time-string-to-seconds (match-string 0))
7808 (org-float-time now))))
7809 ((= dcst ?c)
7810 (let ((end (save-excursion (outline-next-heading) (point))))
7811 (if (re-search-forward
7813 end t)
7814 (org-time-string-to-seconds (match-string 0))
7815 (org-float-time now))))
7816 ((= dcst ?s)
7817 (let ((end (save-excursion (outline-next-heading) (point))))
7818 (if (re-search-forward org-scheduled-time-regexp end t)
7819 (org-time-string-to-seconds (match-string 1))
7820 (org-float-time now))))
7821 ((= dcst ?d)
7822 (let ((end (save-excursion (outline-next-heading) (point))))
7823 (if (re-search-forward org-deadline-time-regexp end t)
7824 (org-time-string-to-seconds (match-string 1))
7825 (org-float-time now))))
7826 ((= dcst ?p)
7827 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7828 (string-to-char (match-string 2))
7829 org-default-priority))
7830 ((= dcst ?r)
7831 (or (org-entry-get nil property) ""))
7832 ((= dcst ?o)
7833 (if (looking-at org-complex-heading-regexp)
7834 (- 9999 (length (member (match-string 2)
7835 org-todo-keywords-1)))))
7836 ((= dcst ?f)
7837 (if getkey-func
7838 (progn
7839 (setq tmp (funcall getkey-func))
7840 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7841 tmp)
7842 (error "Invalid key function `%s'" getkey-func)))
7843 (t (error "Invalid sorting type `%c'" sorting-type))))
7844 nil
7845 (cond
7846 ((= dcst ?a) 'string<)
7847 ((= dcst ?f) compare-func)
7848 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7849 (t nil)))))
7850 (run-hooks 'org-after-sorting-entries-or-items-hook)
7851 (message "Sorting entries...done")))
7853 (defun org-do-sort (table what &optional with-case sorting-type)
7854 "Sort TABLE of WHAT according to SORTING-TYPE.
7855 The user will be prompted for the SORTING-TYPE if the call to this
7856 function does not specify it. WHAT is only for the prompt, to indicate
7857 what is being sorted. The sorting key will be extracted from
7858 the car of the elements of the table.
7859 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7860 (unless sorting-type
7861 (message
7862 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7863 what)
7864 (setq sorting-type (read-char-exclusive)))
7865 (let ((dcst (downcase sorting-type))
7866 extractfun comparefun)
7867 ;; Define the appropriate functions
7868 (cond
7869 ((= dcst ?n)
7870 (setq extractfun 'string-to-number
7871 comparefun (if (= dcst sorting-type) '< '>)))
7872 ((= dcst ?a)
7873 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7874 (lambda(x) (downcase (org-sort-remove-invisible x))))
7875 comparefun (if (= dcst sorting-type)
7876 'string<
7877 (lambda (a b) (and (not (string< a b))
7878 (not (string= a b)))))))
7879 ((= dcst ?t)
7880 (setq extractfun
7881 (lambda (x)
7882 (if (or (string-match org-ts-regexp x)
7883 (string-match org-ts-regexp-both x))
7884 (org-float-time
7885 (org-time-string-to-time (match-string 0 x)))
7886 0))
7887 comparefun (if (= dcst sorting-type) '< '>)))
7888 (t (error "Invalid sorting type `%c'" sorting-type)))
7890 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7891 table)
7892 (lambda (a b) (funcall comparefun (car a) (car b))))))
7895 ;;; The orgstruct minor mode
7897 ;; Define a minor mode which can be used in other modes in order to
7898 ;; integrate the org-mode structure editing commands.
7900 ;; This is really a hack, because the org-mode structure commands use
7901 ;; keys which normally belong to the major mode. Here is how it
7902 ;; works: The minor mode defines all the keys necessary to operate the
7903 ;; structure commands, but wraps the commands into a function which
7904 ;; tests if the cursor is currently at a headline or a plain list
7905 ;; item. If that is the case, the structure command is used,
7906 ;; temporarily setting many Org-mode variables like regular
7907 ;; expressions for filling etc. However, when any of those keys is
7908 ;; used at a different location, function uses `key-binding' to look
7909 ;; up if the key has an associated command in another currently active
7910 ;; keymap (minor modes, major mode, global), and executes that
7911 ;; command. There might be problems if any of the keys is otherwise
7912 ;; used as a prefix key.
7914 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7915 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7916 ;; addresses this by checking explicitly for both bindings.
7918 (defvar orgstruct-mode-map (make-sparse-keymap)
7919 "Keymap for the minor `orgstruct-mode'.")
7921 (defvar org-local-vars nil
7922 "List of local variables, for use by `orgstruct-mode'.")
7924 ;;;###autoload
7925 (define-minor-mode orgstruct-mode
7926 "Toggle the minor mode `orgstruct-mode'.
7927 This mode is for using Org-mode structure commands in other
7928 modes. The following keys behave as if Org-mode were active, if
7929 the cursor is on a headline, or on a plain list item (both as
7930 defined by Org-mode).
7932 M-up Move entry/item up
7933 M-down Move entry/item down
7934 M-left Promote
7935 M-right Demote
7936 M-S-up Move entry/item up
7937 M-S-down Move entry/item down
7938 M-S-left Promote subtree
7939 M-S-right Demote subtree
7940 M-q Fill paragraph and items like in Org-mode
7941 C-c ^ Sort entries
7942 C-c - Cycle list bullet
7943 TAB Cycle item visibility
7944 M-RET Insert new heading/item
7945 S-M-RET Insert new TODO heading / Checkbox item
7946 C-c C-c Set tags / toggle checkbox"
7947 nil " OrgStruct" nil
7948 (org-load-modules-maybe)
7949 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7951 ;;;###autoload
7952 (defun turn-on-orgstruct ()
7953 "Unconditionally turn on `orgstruct-mode'."
7954 (orgstruct-mode 1))
7956 (defun orgstruct++-mode (&optional arg)
7957 "Toggle `orgstruct-mode', the enhanced version of it.
7958 In addition to setting orgstruct-mode, this also exports all indentation
7959 and autofilling variables from org-mode into the buffer. It will also
7960 recognize item context in multiline items.
7961 Note that turning off orgstruct-mode will *not* remove the
7962 indentation/paragraph settings. This can only be done by refreshing the
7964 (interactive "P")
7965 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
7966 (if (< arg 1)
7967 (orgstruct-mode -1)
7968 (orgstruct-mode 1)
7969 (let (var val)
7970 (mapc
7971 (lambda (x)
7972 (when (string-match
7974 (symbol-name (car x)))
7975 (setq var (car x) val (nth 1 x))
7976 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7977 org-local-vars)
7978 (org-set-local 'orgstruct-is-++ t))))
7980 (defvar orgstruct-is-++ nil
7981 "Is `orgstruct-mode' in ++ version in the current-buffer?")
7982 (make-variable-buffer-local 'orgstruct-is-++)
7984 ;;;###autoload
7985 (defun turn-on-orgstruct++ ()
7986 "Unconditionally turn on `orgstruct++-mode'."
7987 (orgstruct++-mode 1))
7989 (defun orgstruct-error ()
7990 "Error when there is no default binding for a structure key."
7991 (interactive)
7992 (error "This key has no function outside structure elements"))
7994 (defun orgstruct-setup ()
7995 "Setup orgstruct keymaps."
7996 (let ((nfunc 0)
7997 (bindings
7998 (list
7999 '([(meta up)] org-metaup)
8000 '([(meta down)] org-metadown)
8001 '([(meta left)] org-metaleft)
8002 '([(meta right)] org-metaright)
8003 '([(meta shift up)] org-shiftmetaup)
8004 '([(meta shift down)] org-shiftmetadown)
8005 '([(meta shift left)] org-shiftmetaleft)
8006 '([(meta shift right)] org-shiftmetaright)
8007 '([?\e (up)] org-metaup)
8008 '([?\e (down)] org-metadown)
8009 '([?\e (left)] org-metaleft)
8010 '([?\e (right)] org-metaright)
8011 '([?\e (shift up)] org-shiftmetaup)
8012 '([?\e (shift down)] org-shiftmetadown)
8013 '([?\e (shift left)] org-shiftmetaleft)
8014 '([?\e (shift right)] org-shiftmetaright)
8015 '([(shift up)] org-shiftup)
8016 '([(shift down)] org-shiftdown)
8017 '([(shift left)] org-shiftleft)
8018 '([(shift right)] org-shiftright)
8019 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8020 '("\M-q" fill-paragraph)
8021 '("\C-c^" org-sort)
8022 '("\C-c-" org-cycle-list-bullet)))
8023 elt key fun cmd)
8024 (while (setq elt (pop bindings))
8025 (setq nfunc (1+ nfunc))
8026 (setq key (org-key (car elt))
8027 fun (nth 1 elt)
8028 cmd (orgstruct-make-binding fun nfunc key))
8029 (org-defkey orgstruct-mode-map key cmd))
8031 ;; Special treatment needed for TAB and RET
8032 (org-defkey orgstruct-mode-map [(tab)]
8033 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8034 (org-defkey orgstruct-mode-map "\C-i"
8035 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8037 (org-defkey orgstruct-mode-map "\M-\C-m"
8038 (orgstruct-make-binding 'org-insert-heading 105
8039 "\M-\C-m" [(meta return)]))
8040 (org-defkey orgstruct-mode-map [(meta return)]
8041 (orgstruct-make-binding 'org-insert-heading 106
8042 [(meta return)] "\M-\C-m"))
8044 (org-defkey orgstruct-mode-map [(shift meta return)]
8045 (orgstruct-make-binding 'org-insert-todo-heading 107
8046 [(meta return)] "\M-\C-m"))
8048 (org-defkey orgstruct-mode-map "\e\C-m"
8049 (orgstruct-make-binding 'org-insert-heading 108
8050 "\e\C-m" [?\e (return)]))
8051 (org-defkey orgstruct-mode-map [?\e (return)]
8052 (orgstruct-make-binding 'org-insert-heading 109
8053 [?\e (return)] "\e\C-m"))
8054 (org-defkey orgstruct-mode-map [?\e (shift return)]
8055 (orgstruct-make-binding 'org-insert-todo-heading 110
8056 [?\e (return)] "\e\C-m"))
8058 (unless org-local-vars
8059 (setq org-local-vars (org-get-local-variables)))
8061 t))
8063 (defun orgstruct-make-binding (fun n &rest keys)
8064 "Create a function for binding in the structure minor mode.
8065 FUN is the command to call inside a table. N is used to create a unique
8066 command name. KEYS are keys that should be checked in for a command
8067 to execute outside of tables."
8068 (eval
8069 (list 'defun
8070 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8071 '(arg)
8073 "Outside of structure, run the binding of `"
8074 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8075 "'.")
8076 '(interactive "p")
8077 (list 'if
8078 `(org-context-p 'headline 'item
8079 (and orgstruct-is-++
8080 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8081 'item-body))
8082 (list 'org-run-like-in-org-mode (list 'quote fun))
8083 (list 'let '(orgstruct-mode)
8084 (list 'call-interactively
8085 (append '(or)
8086 (mapcar (lambda (k)
8087 (list 'key-binding k))
8088 keys)
8089 '('orgstruct-error))))))))
8091 (defun org-context-p (&rest contexts)
8092 "Check if local context is any of CONTEXTS.
8093 Possible values in the list of contexts are `table', `headline', and `item'."
8094 (let ((pos (point)))
8095 (goto-char (point-at-bol))
8096 (prog1 (or (and (memq 'table contexts)
8098 (and (memq 'headline contexts)
8100 (looking-at outline-regexp))
8101 (and (memq 'item contexts)
8103 (and (memq 'item-body contexts)
8104 (org-in-item-p)))
8105 (goto-char pos))))
8107 (defun org-get-local-variables ()
8108 "Return a list of all local variables in an org-mode buffer."
8109 (let (varlist)
8110 (with-current-buffer (get-buffer-create "*Org tmp*")
8111 (erase-buffer)
8112 (org-mode)
8113 (setq varlist (buffer-local-variables)))
8114 (kill-buffer "*Org tmp*")
8115 (delq nil
8116 (mapcar
8117 (lambda (x)
8118 (setq x
8119 (if (symbolp x)
8120 (list x)
8121 (list (car x) (list 'quote (cdr x)))))
8122 (if (string-match
8123 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8124 (symbol-name (car x)))
8125 x nil))
8126 varlist))))
8128 ;;;###autoload
8129 (defun org-run-like-in-org-mode (cmd)
8130 "Run a command, pretending that the current buffer is in Org-mode.
8131 This will temporarily bind local variables that are typically bound in
8132 Org-mode to the values they have in Org-mode, and then interactively
8133 call CMD."
8134 (org-load-modules-maybe)
8135 (unless org-local-vars
8136 (setq org-local-vars (org-get-local-variables)))
8137 (eval (list 'let org-local-vars
8138 (list 'call-interactively (list 'quote cmd)))))
8140 ;;;; Archiving
8142 (defun org-get-category (&optional pos)
8143 "Get the category applying to position POS."
8144 (get-text-property (or pos (point)) 'org-category))
8146 (defun org-refresh-category-properties ()
8147 "Refresh category text properties in the buffer."
8148 (let ((def-cat (cond
8149 ((null org-category)
8150 (if buffer-file-name
8151 (file-name-sans-extension
8152 (file-name-nondirectory buffer-file-name))
8153 "???"))
8154 ((symbolp org-category) (symbol-name org-category))
8155 (t org-category)))
8156 beg end cat pos optionp)
8157 (org-unmodified
8158 (save-excursion
8159 (save-restriction
8160 (widen)
8161 (goto-char (point-min))
8162 (put-text-property (point) (point-max) 'org-category def-cat)
8163 (while (re-search-forward
8165 (setq pos (match-end 0)
8166 optionp (equal (char-after (match-beginning 0)) ?#)
8167 cat (org-trim (match-string 2)))
8168 (if optionp
8169 (setq beg (point-at-bol) end (point-max))
8170 (org-back-to-heading t)
8171 (setq beg (point) end (org-end-of-subtree t t)))
8172 (put-text-property beg end 'org-category cat)
8173 (goto-char pos)))))))
8176 ;;;; Link Stuff
8178 ;;; Link abbreviations
8180 (defun org-link-expand-abbrev (link)
8181 "Apply replacements as defined in `org-link-abbrev-alist."
8183 (let* ((key (match-string 1 link))
8184 (as (or (assoc key org-link-abbrev-alist-local)
8185 (assoc key org-link-abbrev-alist)))
8186 (tag (and (match-end 2) (match-string 3 link)))
8187 rpl)
8188 (if (not as)
8189 link
8190 (setq rpl (cdr as))
8191 (cond
8192 ((symbolp rpl) (funcall rpl tag))
8193 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8194 ((string-match "%h" rpl)
8195 (replace-match (url-hexify-string (or tag "")) t t rpl))
8196 (t (concat rpl tag)))))
8197 link))
8199 ;;; Storing and inserting links
8201 (defvar org-insert-link-history nil
8202 "Minibuffer history for links inserted with `org-insert-link'.")
8204 (defvar org-stored-links nil
8205 "Contains the links stored with `org-store-link'.")
8207 (defvar org-store-link-plist nil
8208 "Plist with info about the most recently link created with `org-store-link'.")
8210 (defvar org-link-protocols nil
8211 "Link protocols added to Org-mode using `org-add-link-type'.")
8213 (defvar org-store-link-functions nil
8214 "List of functions that are called to create and store a link.
8215 Each function will be called in turn until one returns a non-nil
8216 value. Each function should check if it is responsible for creating
8217 this link (for example by looking at the major mode).
8218 If not, it must exit and return nil.
8219 If yes, it should return a non-nil value after a calling
8220 `org-store-link-props' with a list of properties and values.
8221 Special properties are:
8225 This is obligatory as well.
8226 :description Optional default description for the second pair
8227 of brackets in an Org-mode link. The user can still change
8228 this when inserting this link into an Org-mode buffer.
8230 In addition to these, any additional properties can be specified
8231 and then used in remember templates.")
8233 (defun org-add-link-type (type &optional follow export)
8234 "Add TYPE to the list of `org-link-types'.
8235 Re-compute all regular expressions depending on `org-link-types'
8237 FOLLOW and EXPORT are two functions.
8239 FOLLOW should take the link path as the single argument and do whatever
8240 is necessary to follow the link, for example find a file or display
8241 a mail message.
8243 EXPORT should format the link path for export to one of the export formats.
8244 It should be a function accepting three arguments:
8247 desc the description of the link, if any, nil if there was no description
8248 format the export format, a symbol like `html' or `latex' or `ascii'..
8250 The function may use the FORMAT information to return different values
8251 depending on the format. The return value will be put literally into
8252 the exported file. If the return value is nil, this means Org should
8253 do what it normally does with links which do not have EXPORT defined.
8255 Org-mode has a built-in default for exporting links. If you are happy with
8256 this default, there is no need to define an export function for the link
8257 type. For a simple example of an export function, see `org-bbdb.el'."
8258 (add-to-list 'org-link-types type t)
8259 (org-make-link-regexps)
8260 (if (assoc type org-link-protocols)
8261 (setcdr (assoc type org-link-protocols) (list follow export))
8262 (push (list type follow export) org-link-protocols)))
8264 (defvar org-agenda-buffer-name)
8266 ;;;###autoload
8267 (defun org-store-link (arg)
8269 This link is added to `org-stored-links' and can later be inserted
8272 For some link types, a prefix arg is interpreted:
8273 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8274 For file links, arg negates `org-context-in-file-links'."
8275 (interactive "P")
8276 (org-load-modules-maybe)
8277 (setq org-store-link-plist nil) ; reset
8278 (let ((outline-regexp (org-get-limited-outline-regexp))
8279 link cpltxt desc description search txt custom-id agenda-link)
8280 (cond
8282 ((run-hook-with-args-until-success 'org-store-link-functions)
8283 (setq link (plist-get org-store-link-plist :link)
8284 desc (or (plist-get org-store-link-plist :description) link)))
8286 ((equal (buffer-name) "*Org Edit Src Example*")
8287 (let (label gc)
8288 (while (or (not label)
8289 (save-excursion
8290 (save-restriction
8291 (widen)
8292 (goto-char (point-min))
8293 (re-search-forward
8294 (regexp-quote (format org-coderef-label-format label))
8295 nil t))))
8296 (when label (message "Label exists already") (sit-for 2))
8297 (setq label (read-string "Code line label: " label)))
8298 (end-of-line 1)
8299 (setq link (format org-coderef-label-format label))
8300 (setq gc (- 79 (length link)))
8301 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8302 (insert link)
8303 (setq link (concat "(" label ")") desc nil)))
8305 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8306 ;; We are in the agenda, link to referenced location
8307 (let ((m (or (get-text-property (point) 'org-hd-marker)
8308 (get-text-property (point) 'org-marker))))
8309 (when m
8310 (org-with-point-at m
8311 (setq agenda-link
8312 (if (interactive-p)
8313 (call-interactively 'org-store-link)
8314 (org-store-link nil)))))))
8316 ((eq major-mode 'calendar-mode)
8317 (let ((cd (calendar-cursor-to-date)))
8318 (setq link
8319 (format-time-string
8320 (car org-time-stamp-formats)
8321 (apply 'encode-time
8322 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8323 nil nil nil))))
8324 (org-store-link-props :type "calendar" :date cd)))
8326 ((eq major-mode 'w3-mode)
8327 (setq cpltxt (if (and (buffer-name)
8328 (not (string-match "Untitled" (buffer-name))))
8329 (buffer-name)
8330 (url-view-url t))
8331 link (org-make-link (url-view-url t)))
8332 (org-store-link-props :type "w3" :url (url-view-url t)))
8334 ((eq major-mode 'w3m-mode)
8335 (setq cpltxt (or w3m-current-title w3m-current-url)
8336 link (org-make-link w3m-current-url))
8337 (org-store-link-props :type "w3m" :url (url-view-url t)))
8339 ((setq search (run-hook-with-args-until-success
8340 'org-create-file-search-functions))
8341 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8342 "::" search))
8343 (setq cpltxt (or description link)))
8345 ((eq major-mode 'image-mode)
8346 (setq cpltxt (concat "file:"
8347 (abbreviate-file-name buffer-file-name))
8348 link (org-make-link cpltxt))
8349 (org-store-link-props :type "image" :file buffer-file-name))
8351 ((eq major-mode 'dired-mode)
8352 ;; link to the file in the current line
8353 (let ((file (dired-get-filename nil t)))
8354 (setq file (if file
8355 (abbreviate-file-name
8356 (expand-file-name (dired-get-filename nil t)))
8357 ;; otherwise, no file so use current directory.
8358 default-directory))
8359 (setq cpltxt (concat "file:" file)
8360 link (org-make-link cpltxt))))
8362 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8363 (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
8364 (cond
8366 (setq cpltxt
8367 (concat "file:"
8368 (abbreviate-file-name
8369 (buffer-file-name (buffer-base-buffer)))
8370 "::" (match-string 1))
8371 link (org-make-link cpltxt)))
8372 ((and (featurep 'org-id)
8373 (or (eq org-link-to-org-use-id t)
8374 (and (eq org-link-to-org-use-id 'create-if-interactive)
8375 (interactive-p))
8376 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
8377 (interactive-p)
8378 (not custom-id))
8379 (and org-link-to-org-use-id
8380 (condition-case nil
8381 (org-entry-get nil "ID")
8382 (error nil)))))
8383 ;; We can make a link using the ID.
8384 (setq link (condition-case nil
8385 (prog1 (org-id-store-link)
8386 (setq desc (plist-get org-store-link-plist
8387 :description)))
8388 (error
8389 ;; probably before first headline, link to file only
8390 (concat "file:"
8391 (abbreviate-file-name
8392 (buffer-file-name (buffer-base-buffer))))))))
8393 (t
8394 ;; Just link to current headline
8395 (setq cpltxt (concat "file:"
8396 (abbreviate-file-name
8397 (buffer-file-name (buffer-base-buffer)))))
8398 ;; Add a context search string
8399 (when (org-xor org-context-in-file-links arg)
8400 (setq txt (cond
8401 ((org-on-heading-p) nil)
8402 ((org-region-active-p)
8403 (buffer-substring (region-beginning) (region-end)))
8404 (t nil)))
8406 (setq cpltxt
8407 (concat cpltxt "::"
8408 (condition-case nil
8409 (org-make-org-heading-search-string txt)
8410 (error "")))
8411 desc (or (nth 4 (ignore-errors
8412 (org-heading-components))) "NONE"))))
8414 (setq cpltxt (substring cpltxt 0 -2)))
8415 (setq link (org-make-link cpltxt)))))
8417 ((buffer-file-name (buffer-base-buffer))
8418 ;; Just link to this file here.
8419 (setq cpltxt (concat "file:"
8420 (abbreviate-file-name
8421 (buffer-file-name (buffer-base-buffer)))))
8422 ;; Add a context string
8423 (when (org-xor org-context-in-file-links arg)
8424 (setq txt (if (org-region-active-p)
8425 (buffer-substring (region-beginning) (region-end))
8426 (buffer-substring (point-at-bol) (point-at-eol))))
8427 ;; Only use search option if there is some text.
8429 (setq cpltxt
8430 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8431 desc "NONE")))
8432 (setq link (org-make-link cpltxt)))
8434 ((interactive-p)
8435 (error "Cannot link to a buffer which is not visiting a file"))
8437 (t (setq link nil)))
8439 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8440 (setq link (or link cpltxt)
8441 desc (or desc cpltxt))
8442 (if (equal desc "NONE") (setq desc nil))
8444 (if (and (or (interactive-p) executing-kbd-macro) link)
8445 (progn
8446 (setq org-stored-links
8447 (cons (list link desc) org-stored-links))
8448 (message "Stored: %s" (or desc link))
8449 (when custom-id
8450 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8451 "::#" custom-id))
8452 (setq org-stored-links
8453 (cons (list link desc) org-stored-links))))
8454 (or agenda-link (and link (org-make-link-string link desc))))))
8456 (defun org-store-link-props (&rest plist)
8457 "Store link properties, extract names and addresses."
8458 (let (x adr)
8459 (when (setq x (plist-get plist :from))
8460 (setq adr (mail-extract-address-components x))
8461 (setq plist (plist-put plist :fromname (car adr)))
8462 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8463 (when (setq x (plist-get plist :to))
8464 (setq adr (mail-extract-address-components x))
8465 (setq plist (plist-put plist :toname (car adr)))
8466 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8467 (let ((from (plist-get plist :from))
8468 (to (plist-get plist :to)))
8469 (when (and from to org-from-is-user-regexp)
8470 (setq plist
8471 (plist-put plist :fromto
8472 (if (string-match org-from-is-user-regexp from)
8473 (concat "to %t")
8474 (concat "from %f"))))))
8475 (setq org-store-link-plist plist))
8477 (defun org-add-link-props (&rest plist)
8478 "Add these properties to the link property list."
8479 (let (key value)
8480 (while plist
8481 (setq key (pop plist) value (pop plist))
8482 (setq org-store-link-plist
8483 (plist-put org-store-link-plist key value)))))
8485 (defun org-email-link-description (&optional fmt)
8486 "Return the description part of an email link.
8487 This takes information from `org-store-link-plist' and formats it
8488 according to FMT (default from `org-email-link-description-format')."
8489 (setq fmt (or fmt org-email-link-description-format))
8490 (let* ((p org-store-link-plist)
8491 (to (plist-get p :toaddress))
8492 (from (plist-get p :fromaddress))
8493 (table
8494 (list
8495 (cons "%c" (plist-get p :fromto))
8496 (cons "%F" (plist-get p :from))
8497 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8498 (cons "%T" (plist-get p :to))
8499 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8500 (cons "%s" (plist-get p :subject))
8501 (cons "%d" (plist-get p :date))
8502 (cons "%m" (plist-get p :message-id)))))
8503 (when (string-match "%c" fmt)
8504 ;; Check if the user wrote this message
8505 (if (and org-from-is-user-regexp from to
8506 (save-match-data (string-match org-from-is-user-regexp from)))
8507 (setq fmt (replace-match "to %t" t t fmt))
8508 (setq fmt (replace-match "from %f" t t fmt))))
8509 (org-replace-escapes fmt table)))
8511 (defun org-make-org-heading-search-string (&optional string heading)
8512 "Make search string for STRING or current headline."
8513 (interactive)
8514 (let ((s (or string (org-get-heading)))
8515 (lines org-context-in-file-links))
8516 (unless (and string (not heading))
8517 ;; We are using a headline, clean up garbage in there.
8518 (if (string-match org-todo-regexp s)
8519 (setq s (replace-match "" t t s)))
8521 (setq s (replace-match "" t t s)))
8522 (setq s (org-trim s))
8525 (setq s (replace-match "" t t s)))
8526 (while (string-match org-ts-regexp s)
8527 (setq s (replace-match "" t t s))))
8528 (or string (setq s (concat "*" s))) ; Add * for headlines
8529 (when (and string (integerp lines) (> lines 0))
8531 (when (< lines (length slines))
8532 (setq s (mapconcat
8533 'identity
8534 (reverse (nthcdr (- (length slines) lines)
8538 (defun org-make-link (&rest strings)
8539 "Concatenate STRINGS."
8540 (apply 'concat strings))
8542 (defun org-make-link-string (link &optional description)
8543 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8545 (error "Empty link"))
8546 (when (and description
8547 (stringp description)
8549 (setq description nil))
8550 (when (stringp description)
8551 ;; Remove brackets from the description, they are fatal.
8553 (setq description (replace-match "{" t t description)))
8555 (setq description (replace-match "}" t t description))))
8556 (when (equal (org-link-escape link) description)
8557 ;; No description needed, it is identical
8558 (setq description nil))
8559 (when (and (not description)
8560 (not (equal link (org-link-escape link))))
8561 (setq description (org-extract-attributes link)))
8562 (setq link (if (string-match org-link-types-re link)
8563 (concat (match-string 1 link)
8564 (org-link-escape (substring link (match-end 1))))
8565 (org-link-escape link)))
8566 (concat "[[" link "]"
8567 (if description (concat "[" description "]") "")
8568 "]"))
8570 (defconst org-link-escape-chars
8571 '((?\ . "%20")
8572 (?\[ . "%5B")
8573 (?\] . "%5D")
8584 (?\; . "%3B")
8585 ;; (?? . "%3F")
8586 (?= . "%3D")
8587 (?+ . "%2B")
8588 )
8589 "Association list of escapes for some characters problematic in links.
8590 This is the list that is used for internal purposes.")
8592 (defvar org-url-encoding-use-url-hexify nil)
8594 (defconst org-link-escape-chars-browser
8595 '((?\ . "%20")) ; 32 for the SPC char
8596 "Association list of escapes for some characters problematic in links.
8597 This is the list that is used before handing over to the browser.")
8599 (defun org-link-escape (text &optional table)
8600 "Escape characters in TEXT that are problematic for links."
8601 (if (and org-url-encoding-use-url-hexify (not table))
8602 (url-hexify-string text)
8603 (setq table (or table org-link-escape-chars))
8604 (when text
8605 (let ((re (mapconcat (lambda (x) (regexp-quote
8606 (char-to-string (car x))))
8608 (while (string-match re text)
8609 (setq text
8610 (replace-match
8611 (cdr (assoc (string-to-char (match-string 0 text))
8612 table))
8613 t t text)))
8614 text))))
8616 (defun org-link-unescape (text &optional table)
8617 "Reverse the action of `org-link-escape'."
8618 (if (and org-url-encoding-use-url-hexify (not table))
8619 (url-unhex-string text)
8620 (setq table (or table org-link-escape-chars))
8621 (when text
8622 (let ((case-fold-search t)
8623 (re (mapconcat (lambda (x) (regexp-quote (downcase (cdr x))))
8625 (while (string-match re text)
8626 (setq text
8627 (replace-match
8628 (char-to-string (car (rassoc (upcase (match-string 0 text))
8629 table)))
8630 t t text)))
8631 text))))
8633 (defun org-xor (a b)
8634 "Exclusive or."
8635 (if a (not b) b))
8637 (defun org-fixup-message-id-for-http (s)
8638 "Replace special characters in a message id, so it can be used in an http query."
8639 (when (string-match "%" s)
8640 (setq s (mapconcat (lambda (c)
8641 (if (eq c ?%)
8642 "%25"
8643 (char-to-string c)))
8644 s "")))
8645 (while (string-match "<" s)
8646 (setq s (replace-match "%3C" t t s)))
8647 (while (string-match ">" s)
8648 (setq s (replace-match "%3E" t t s)))
8649 (while (string-match "@" s)
8650 (setq s (replace-match "%40" t t s)))
8651 s)
8653 ;;;###autoload
8654 (defun org-insert-link-global ()
8655 "Insert a link like Org-mode does.
8656 This command can be called in any mode to insert a link in Org-mode syntax."
8657 (interactive)
8658 (org-load-modules-maybe)
8659 (org-run-like-in-org-mode 'org-insert-link))
8661 (defun org-insert-link (&optional complete-file link-location)
8662 "Insert a link. At the prompt, enter the link.
8664 Completion can be used to insert any of the link protocol prefixes like
8665 http or ftp in use.
8667 The history can be used to select a link previously stored with
8668 `org-store-link'. When the empty string is entered (i.e. if you just
8669 press RET at the prompt), the link defaults to the most recently
8670 stored link. As SPC triggers completion in the minibuffer, you need to
8671 use M-SPC or C-q SPC to force the insertion of a space character.
8673 You will also be prompted for a description, and if one is given, it will
8674 be displayed in the buffer instead of the link.
8676 If there is already a link at point, this command will allow you to edit link
8677 and description parts.
8680 be selected using completion. The path to the file will be relative to the
8681 current directory if the file is in the current directory or a subdirectory.
8682 Otherwise, the link will be the absolute path as completed in the minibuffer
8683 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8684 option `org-link-file-path-type'.
8687 the current directory or below.
8690 `org-keep-stored-link-after-insertion'.
8692 If `org-make-link-description-function' is non-nil, this function will be
8693 called with the link target, and the result will be the default
8694 link description.
8696 If the LINK-LOCATION parameter is non-nil, this value will be
8697 used as the link location instead of reading one interactively."
8698 (interactive "P")
8699 (let* ((wcf (current-window-configuration))
8700 (region (if (org-region-active-p)
8701 (buffer-substring (region-beginning) (region-end))))
8702 (remove (and region (list (region-beginning) (region-end))))
8703 (desc region)
8704 tmphist ; byte-compile incorrectly complains about this
8705 (link link-location)
8706 entry file all-prefixes)
8707 (cond
8708 (link-location) ; specified by arg, just use it.
8709 ((org-in-regexp org-bracket-link-regexp 1)
8710 ;; We do have a link at point, and we are going to edit it.
8711 (setq remove (list (match-beginning 0) (match-end 0)))
8712 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8713 (setq link (read-string "Link: "
8714 (org-link-unescape
8715 (org-match-string-no-properties 1)))))
8716 ((or (org-in-regexp org-angle-link-re)
8717 (org-in-regexp org-plain-link-re))
8718 ;; Convert to bracket link
8719 (setq remove (list (match-beginning 0) (match-end 0))
8720 link (read-string "Link: "
8721 (org-remove-angle-brackets (match-string 0)))))
8722 ((member complete-file '((4) (16)))
8723 ;; Completing read for file names.
8724 (setq link (org-file-complete-link complete-file)))
8725 (t
8726 ;; Read link, with completion for stored links.
8727 (with-output-to-temp-buffer "*Org Links*"
8728 (princ "Insert a link.
8730 (when org-stored-links
8732 (princ (mapconcat
8733 (lambda (x)
8734 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8736 (let ((cw (selected-window)))
8737 (select-window (get-buffer-window "*Org Links*" 'visible))
8738 (setq truncate-lines t)
8739 (unless (pos-visible-in-window-p (point-max))
8740 (org-fit-window-to-buffer))
8741 (and (window-live-p cw) (select-window cw)))
8742 ;; Fake a link history, containing the stored links.
8743 (setq tmphist (append (mapcar 'car org-stored-links)
8744 org-insert-link-history))
8745 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8746 (mapcar 'car org-link-abbrev-alist)
8747 org-link-types))
8748 (unwind-protect
8749 (progn
8750 (setq link
8751 (let ((org-completion-use-ido nil)
8752 (org-completion-use-iswitchb nil))
8753 (org-completing-read
8754 "Link: "
8755 (append
8756 (mapcar (lambda (x) (list (concat x ":")))
8757 all-prefixes)
8758 (mapcar 'car org-stored-links))
8759 nil nil nil
8760 'tmphist
8761 (car (car org-stored-links)))))
8763 (error "No link selected"))
8764 (if (or (member link all-prefixes)
8765 (and (equal ":" (substring link -1))
8766 (member (substring link 0 -1) all-prefixes)
8767 (setq link (substring link 0 -1))))
8768 (setq link (org-link-try-special-completion link))))
8769 (set-window-configuration wcf)
8770 (kill-buffer "*Org Links*"))
8771 (setq entry (assoc link org-stored-links))
8772 (or entry (push link org-insert-link-history))
8773 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8774 (not org-keep-stored-link-after-insertion))
8775 (setq org-stored-links (delq (assoc link org-stored-links)
8776 org-stored-links)))
8777 (setq desc (or desc (nth 1 entry)))))
8779 (if (string-match org-plain-link-re link)
8780 ;; URL-like link, normalize the use of angular brackets.
8781 (setq link (org-make-link (org-remove-angle-brackets link))))
8783 ;; Check if we are linking to the current file with a search option
8784 ;; If yes, simplify the link by using only the search option.
8785 (when (and buffer-file-name
8787 (let* ((path (match-string 1 link))
8788 (case-fold-search nil)
8789 (search (match-string 2 link)))
8790 (save-match-data
8791 (if (equal (file-truename buffer-file-name) (file-truename path))
8792 ;; We are linking to this same file, with a search option
8793 (setq link search)))))
8795 ;; Check if we can/should use a relative path. If yes, simplify the link
8797 (let* ((type (match-string 1 link))
8798 (path (match-string 2 link))
8799 (origpath path)
8800 (case-fold-search nil))
8801 (cond
8802 ((or (eq org-link-file-path-type 'absolute)
8803 (equal complete-file '(16)))
8804 (setq path (abbreviate-file-name (expand-file-name path))))
8805 ((eq org-link-file-path-type 'noabbrev)
8806 (setq path (expand-file-name path)))
8807 ((eq org-link-file-path-type 'relative)
8808 (setq path (file-relative-name path)))
8809 (t
8810 (save-match-data
8811 (if (string-match (concat "^" (regexp-quote
8812 (expand-file-name
8813 (file-name-as-directory
8814 default-directory))))
8815 (expand-file-name path))
8816 ;; We are linking a file with relative path name.
8817 (setq path (substring (expand-file-name path)
8818 (match-end 0)))
8819 (setq path (abbreviate-file-name (expand-file-name path)))))))
8820 (setq link (concat type path))
8821 (if (equal desc origpath)
8822 (setq desc path))))
8824 (if org-make-link-description-function
8825 (setq desc (funcall org-make-link-description-function link desc)))
8827 (setq desc (read-string "Description: " desc))
8829 (if remove (apply 'delete-region remove))
8830 (insert (org-make-link-string link desc))))
8832 (defun org-link-try-special-completion (type)
8833 "If there is completion support for link type TYPE, offer it."
8834 (let ((fun (intern (concat "org-" type "-complete-link"))))
8835 (if (functionp fun)
8836 (funcall fun)
8837 (read-string "Link (no completion support): " (concat type ":")))))
8839 (defun org-file-complete-link (&optional arg)
8840 "Create a file link using completion."
8841 (let (file link)
8842 (setq file (read-file-name "File: "))
8843 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8844 (pwd1 (file-name-as-directory (abbreviate-file-name
8845 (expand-file-name ".")))))
8846 (cond
8847 ((equal arg '(16))
8848 (setq link (org-make-link
8849 "file:"
8850 (abbreviate-file-name (expand-file-name file)))))
8852 (setq link (org-make-link "file:" (match-string 1 file))))
8854 (expand-file-name file))
8855 (setq link (org-make-link
8856 "file:" (match-string 1 (expand-file-name file)))))
8857 (t (setq link (org-make-link "file:" file)))))
8858 link))
8860 (defun org-completing-read (&rest args)
8861 "Completing-read with SPACE being a normal character."
8862 (let ((minibuffer-local-completion-map
8863 (copy-keymap minibuffer-local-completion-map)))
8864 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
8865 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
8866 (apply 'org-icompleting-read args)))
8868 (defun org-completing-read-no-i (&rest args)
8869 (let (org-completion-use-ido org-completion-use-iswitchb)
8870 (apply 'org-completing-read args)))
8872 (defun org-iswitchb-completing-read (prompt choices &rest args)
8873 "Use iswitch as a completing-read replacement to choose from choices.
8874 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
8875 from."
8876 (let* ((iswitchb-use-virtual-buffers nil)
8877 (iswitchb-make-buflist-hook
8878 (lambda ()
8879 (setq iswitchb-temp-buflist choices))))
8880 (iswitchb-read-buffer prompt)))
8882 (defun org-icompleting-read (&rest args)
8883 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
8884 (org-without-partial-completion
8885 (if (and org-completion-use-ido
8886 (fboundp 'ido-completing-read)
8887 (boundp 'ido-mode) ido-mode
8888 (listp (second args)))
8889 (let ((ido-enter-matching-directory nil))
8890 (apply 'ido-completing-read (concat (car args))
8891 (if (consp (car (nth 1 args)))
8892 (mapcar (lambda (x) (car x)) (nth 1 args))
8893 (nth 1 args))
8894 (cddr args)))
8895 (if (and org-completion-use-iswitchb
8896 (boundp 'iswitchb-mode) iswitchb-mode
8897 (listp (second args)))
8898 (apply 'org-iswitchb-completing-read (concat (car args))
8899 (if (consp (car (nth 1 args)))
8900 (mapcar (lambda (x) (car x)) (nth 1 args))
8901 (nth 1 args))
8902 (cddr args))
8903 (apply 'completing-read args)))))
8905 (defun org-extract-attributes (s)
8906 "Extract the attributes cookie from a string and set as text property."
8907 (let (a attr (start 0) key value)
8908 (save-match-data
8910 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
8912 (setq key (match-string 1 a) value (match-string 2 a)
8913 start (match-end 0)
8914 attr (plist-put attr (intern key) value))))
8915 (org-add-props s nil 'org-attr attr))
8916 s))
8918 (defun org-extract-attributes-from-string (tag)
8919 (let (key value attr)
8921 (setq key (match-string 1 tag) value (match-string 2 tag)
8922 tag (replace-match "" t t tag)
8923 attr (plist-put attr (intern key) value)))
8924 (cons tag attr)))
8926 (defun org-attributes-to-string (plist)
8927 "Format a property list into an HTML attribute list."
8928 (let ((s "") key value)
8929 (while plist
8930 (setq key (pop plist) value (pop plist))
8931 (and value
8933 s))
8935 ;;; Opening/following a link
8937 (defvar org-link-search-failed nil)
8939 (defvar org-open-link-functions nil
8940 "Hook for functions finding a plain text link.
8941 These functions must take a single argument, the link content.
8942 They will be called for links that look like [[link text][description]]
8946 These functions will be called *before* Org attempts to resolve the
8947 link by doing text searches in the current buffer - so if you want a
8949 handle this as a special case.
8951 When the function does handle the link, it must return a non-nil value.
8952 If it decides that it is not responsible for this link, it must return
8953 nil to indicate that that Org-mode can continue with other options
8954 like exact and fuzzy text search.")
8956 (defun org-next-link ()
8957 "Move forward to the next link.
8958 If the link is in hidden text, expose it."
8959 (interactive)
8960 (when (and org-link-search-failed (eq this-command last-command))
8961 (goto-char (point-min))
8962 (message "Link search wrapped back to beginning of buffer"))
8963 (setq org-link-search-failed nil)
8964 (let* ((pos (point))
8965 (ct (org-context))
8966 (a (assoc :link ct)))
8967 (if a (goto-char (nth 2 a)))
8968 (if (re-search-forward org-any-link-re nil t)
8969 (progn
8970 (goto-char (match-beginning 0))
8971 (if (org-invisible-p) (org-show-context)))
8972 (goto-char pos)
8973 (setq org-link-search-failed t)
8974 (error "No further link found"))))
8976 (defun org-previous-link ()
8977 "Move backward to the previous link.
8978 If the link is in hidden text, expose it."
8979 (interactive)
8980 (when (and org-link-search-failed (eq this-command last-command))
8981 (goto-char (point-max))
8982 (message "Link search wrapped back to end of buffer"))
8983 (setq org-link-search-failed nil)
8984 (let* ((pos (point))
8985 (ct (org-context))
8986 (a (assoc :link ct)))
8987 (if a (goto-char (nth 1 a)))
8988 (if (re-search-backward org-any-link-re nil t)
8989 (progn
8990 (goto-char (match-beginning 0))
8991 (if (org-invisible-p) (org-show-context)))
8992 (goto-char pos)
8993 (setq org-link-search-failed t)
8994 (error "No further link found"))))
8996 (defun org-translate-link (s)
8997 "Translate a link string if a translation function has been defined."
8998 (if (and org-link-translation-function
8999 (fboundp org-link-translation-function)
9001 (progn
9002 (setq s (funcall org-link-translation-function
9003 (match-string 1) (match-string 2)))
9004 (concat (car s) ":" (cdr s)))
9005 s))
9007 (defun org-translate-link-from-planner (type path)
9008 "Translate a link from Emacs Planner syntax so that Org can follow it.
9009 This is still an experimental function, your mileage may vary."
9010 (cond
9011 ((member type '("http" "https" "news" "ftp"))
9012 ;; standard Internet links are the same.
9013 nil)
9014 ((and (equal type "irc") (string-match "^//" path))
9015 ;; Planner has two / at the beginning of an irc link, we have 1.
9016 ;; We should have zero, actually....
9017 (setq path (substring path 1)))
9018 ((and (equal type "lisp") (string-match "^/" path))
9019 ;; Planner has a slash, we do not.
9020 (setq type "elisp" path (substring path 1)))
9022 ;; A typical message link. Planner has the id after the final slash,
9023 ;; we separate it with a hash mark
9024 (setq path (concat (match-string 1 path) "#"
9025 (org-remove-angle-brackets (match-string 2 path)))))
9026 )
9027 (cons type path))
9029 (defun org-find-file-at-mouse (ev)
9030 "Open file link or URL at mouse."
9031 (interactive "e")
9032 (mouse-set-point ev)
9033 (org-open-at-point 'in-emacs))
9035 (defun org-open-at-mouse (ev)
9036 "Open file link or URL at mouse."
9037 (interactive "e")
9038 (mouse-set-point ev)
9039 (if (eq major-mode 'org-agenda-mode)
9040 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9041 (org-open-at-point))
9043 (defvar org-window-config-before-follow-link nil
9044 "The window configuration before following a link.
9045 This is saved in case the need arises to restore it.")
9047 (defvar org-open-link-marker (make-marker)
9048 "Marker pointing to the location where `org-open-at-point; was called.")
9050 ;;;###autoload
9051 (defun org-open-at-point-global ()
9052 "Follow a link like Org-mode does.
9053 This command can be called in any mode to follow a link that has
9054 Org-mode syntax."
9055 (interactive)
9056 (org-run-like-in-org-mode 'org-open-at-point))
9058 ;;;###autoload
9059 (defun org-open-link-from-string (s &optional arg reference-buffer)
9060 "Open a link in the string S, as if it was in Org-mode."
9062 (let ((reference-buffer (or reference-buffer (current-buffer))))
9063 (with-temp-buffer
9064 (let ((org-inhibit-startup t))
9065 (org-mode)
9066 (insert s)
9067 (goto-char (point-min))
9068 (when reference-buffer
9069 (setq org-link-abbrev-alist-local
9070 (with-current-buffer reference-buffer
9071 org-link-abbrev-alist-local)))
9072 (org-open-at-point arg reference-buffer)))))
9074 (defvar org-open-at-point-functions nil
9075 "Hook that is run when following a link at point.
9077 Functions in this hook must return t if they identify and follow
9078 a link at point. If they don't find anything interesting at point,
9079 they must return nil.")
9081 (defun org-open-at-point (&optional in-emacs reference-buffer)
9082 "Open link at or after point.
9083 If there is no link at point, this function will search forward up to
9084 the end of the current line.
9085 Normally, files will be opened by an appropriate application. If the
9086 optional argument IN-EMACS is non-nil, Emacs will visit the file.
9087 With a double prefix argument, try to open outside of Emacs, in the
9088 application the system uses for this file type."
9089 (interactive "P")
9090 ;; if in a code block, then open the block's results
9091 (unless (call-interactively #'org-babel-open-src-block-result)
9092 (org-load-modules-maybe)
9093 (move-marker org-open-link-marker (point))
9094 (setq org-window-config-before-follow-link (current-window-configuration))
9095 (org-remove-occur-highlights nil nil t)
9096 (cond
9097 ((and (org-on-heading-p)
9098 (not (org-in-regexp
9103 (not (get-text-property (point) 'org-linked-text)))
9104 (or (org-offer-links-in-entry in-emacs)
9105 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9106 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9107 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9108 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9109 (not (org-in-regexp org-bracket-link-regexp)))
9110 (org-footnote-action))
9111 (t
9112 (let (type path link line search (pos (point)))
9113 (catch 'match
9114 (save-excursion
9116 (when (org-in-regexp org-bracket-link-regexp 1)
9117 (setq link (org-extract-attributes
9118 (org-link-unescape (org-match-string-no-properties 1))))
9120 (setq link (replace-match " " t t link)))
9121 (setq link (org-link-expand-abbrev link))
9122 (cond
9123 ((or (file-name-absolute-p link)
9125 (setq type "file" path link))
9126 ((string-match org-link-re-with-space3 link)
9127 (setq type (match-string 1 link) path (match-string 2 link)))
9128 (t (setq type "thisfile" path link)))
9129 (throw 'match t)))
9131 (when (get-text-property (point) 'org-linked-text)
9132 (setq type "thisfile"
9133 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9134 (1+ (point)) (point))
9135 path (buffer-substring
9136 (previous-single-property-change pos 'org-linked-text)
9137 (next-single-property-change pos 'org-linked-text)))
9138 (throw 'match t))
9140 (save-excursion
9141 (when (or (org-in-regexp org-angle-link-re)
9142 (org-in-regexp org-plain-link-re))
9143 (setq type (match-string 1) path (match-string 2))
9144 (throw 'match t)))
9145 (save-excursion
9147 (setq type "tags"
9148 path (match-string 1))
9149 (while (string-match ":" path)
9150 (setq path (replace-match "+" t t path)))
9151 (throw 'match t)))
9153 (setq type "tree-match"
9154 path (match-string 1))
9155 (throw 'match t)))
9156 (unless path
9157 (error "No link found"))
9159 ;; switch back to reference buffer
9160 ;; needed when if called in a temporary buffer through
9161 ;; org-open-link-from-string
9162 (with-current-buffer (or reference-buffer (current-buffer))
9164 ;; Remove any trailing spaces in path
9166 (setq path (replace-match "" t t path)))
9167 (if (and org-link-translation-function
9168 (fboundp org-link-translation-function))
9169 ;; Check if we need to translate the link
9170 (let ((tmp (funcall org-link-translation-function type path)))
9171 (setq type (car tmp) path (cdr tmp))))
9173 (cond
9175 ((assoc type org-link-protocols)
9176 (funcall (nth 1 (assoc type org-link-protocols)) path))
9178 ((equal type "mailto")
9179 (let ((cmd (car org-link-mailto-program))
9180 (args (cdr org-link-mailto-program)) args1
9181 (address path) (subject "") a)
9183 (setq address (match-string 1 path)
9184 subject (org-link-escape (match-string 2 path))))
9185 (while args
9186 (cond
9187 ((not (stringp (car args))) (push (pop args) args1))
9188 (t (setq a (pop args))
9189 (if (string-match "%a" a)
9190 (setq a (replace-match address t t a)))
9191 (if (string-match "%s" a)
9192 (setq a (replace-match subject t t a)))
9193 (push a args1))))
9194 (apply cmd (nreverse args1))))
9196 ((member type '("http" "https" "ftp" "news"))
9197 (browse-url (concat type ":" (org-link-escape
9198 path org-link-escape-chars-browser))))
9200 ((string= type "doi")
9201 (browse-url (concat "http://dx.doi.org/"
9202 (org-link-escape
9203 path org-link-escape-chars-browser))))
9205 ((member type '("message"))
9206 (browse-url (concat type ":" path)))
9208 ((string= type "tags")
9209 (org-tags-view in-emacs path))
9211 ((string= type "tree-match")
9214 ((string= type "file")
9216 (setq line (string-to-number (match-string 1 path))
9217 path (substring path 0 (match-beginning 0)))
9219 (setq search (match-string 1 path)
9220 path (substring path 0 (match-beginning 0)))))
9221 (if (string-match "[*?{]" (file-name-nondirectory path))
9222 (dired path)
9223 (org-open-file path in-emacs line search)))
9225 ((string= type "shell")
9226 (let ((cmd path))
9227 (if (or (not org-confirm-shell-link-function)
9228 (funcall org-confirm-shell-link-function
9230 (org-add-props cmd nil
9231 'face 'org-warning))))
9232 (progn
9233 (message "Executing %s" cmd)
9234 (shell-command cmd))
9235 (error "Abort"))))
9237 ((string= type "elisp")
9238 (let ((cmd path))
9239 (if (or (not org-confirm-elisp-link-function)
9240 (funcall org-confirm-elisp-link-function
9242 (org-add-props cmd nil
9243 'face 'org-warning))))
9244 (message "%s => %s" cmd
9245 (if (equal (string-to-char cmd) ?\()
9246 (eval (read cmd))
9247 (call-interactively (read cmd))))
9248 (error "Abort"))))
9250 ((and (string= type "thisfile")
9251 (run-hook-with-args-until-success
9252 'org-open-link-functions path)))
9254 ((string= type "thisfile")
9255 (if in-emacs
9256 (switch-to-buffer-other-window
9257 (org-get-buffer-for-internal-link (current-buffer)))
9258 (org-mark-ring-push))
9259 (let ((cmd `(org-link-search
9260 ,path
9261 ,(cond ((equal in-emacs '(4)) 'occur)
9262 ((equal in-emacs '(16)) 'org-occur)
9263 (t nil))
9264 ,pos)))
9265 (condition-case nil (eval cmd)
9266 (error (progn (widen) (eval cmd))))))
9268 (t
9269 (browse-url-at-point)))))))
9270 (move-marker org-open-link-marker nil)
9271 (run-hook-with-args 'org-follow-link-hook)))
9273 (defun org-offer-links-in-entry (&optional nth zero)
9274 "Offer links in the current entry and follow the selected link.
9275 If there is only one link, follow it immediately as well.
9276 If NTH is an integer, immediately pick the NTH link found.
9277 If ZERO is a string, check also this string for a link, and if
9278 there is one, offer it as link number zero."
9282 (cnt ?0)
9283 (in-emacs (if (integerp nth) nil nth))
9284 have-zero end links link c)
9285 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9286 (push (match-string 0 zero) links)
9287 (setq cnt (1- cnt) have-zero t))
9288 (save-excursion
9289 (org-back-to-heading t)
9290 (setq end (save-excursion (outline-next-heading) (point)))
9291 (while (re-search-forward re end t)
9292 (push (match-string 0) links))
9293 (setq links (org-uniquify (reverse links))))
9295 (cond
9296 ((null links)
9297 (message "No links"))
9298 ((equal (length links) 1)
9299 (setq link (list (car links))))
9300 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9301 (setq link (nth (if have-zero nth (1- nth)) links)))
9302 (t ; we have to select a link
9303 (save-excursion
9304 (save-window-excursion
9305 (delete-other-windows)
9306 (with-output-to-temp-buffer "*Select Link*"
9307 (mapc (lambda (l)
9308 (if (not (string-match org-bracket-link-regexp l))
9310 (org-remove-angle-brackets l)))
9311 (if (match-end 3)
9313 (match-string 3 l) (match-string 1 l)))
9315 (match-string 1 l))))))
9316 links))
9317 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9318 (message "Select link to open, RET to open all:")
9319 (setq c (read-char-exclusive))
9320 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9321 (when (equal c ?q) (error "Abort"))
9322 (if (equal c ?\C-m)
9323 (setq link links)
9324 (setq nth (- c ?0))
9325 (if have-zero (setq nth (1+ nth)))
9326 (unless (and (integerp nth) (>= (length links) nth))
9327 (error "Invalid link selection"))
9328 (setq link (list (nth (1- nth) links))))))
9329 (if link
9330 (let ((buf (current-buffer)))
9331 (dolist (l link)
9332 (org-open-link-from-string l in-emacs buf))
9333 t)
9334 nil)))
9336 ;; Add special file links that specify the way of opening
9338 (org-add-link-type "file+sys" 'org-open-file-with-system)
9339 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9340 (defun org-open-file-with-system (path)
9341 "Open file at PATH using the system way of opening it."
9342 (org-open-file path 'system))
9343 (defun org-open-file-with-emacs (path)
9344 "Open file at PATH in Emacs."
9345 (org-open-file path 'emacs))
9346 (defun org-remove-file-link-modifiers ()
9347 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9348 (goto-char (point-min))
9350 (org-if-unprotected
9351 (replace-match "file:" t t))))
9352 (eval-after-load "org-exp"
9353 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9354 'org-remove-file-link-modifiers))
9356 ;;;; Time estimates
9358 (defun org-get-effort (&optional pom)
9359 "Get the effort estimate for the current entry."
9360 (org-entry-get pom org-effort-property))
9362 ;;; File search
9364 (defvar org-create-file-search-functions nil
9365 "List of functions to construct the right search string for a file link.
9366 These functions are called in turn with point at the location to
9367 which the link should point.
9369 A function in the hook should first test if it would like to
9370 handle this file type, for example by checking the `major-mode'
9371 or the file extension. If it decides not to handle this file, it
9372 should just return nil to give other functions a chance. If it
9373 does handle the file, it must return the search string to be used
9374 when following the link. The search string will be part of the
9375 file link, given after a double colon, and `org-open-at-point'
9376 will automatically search for it. If special measures must be
9377 taken to make the search successful, another function should be
9378 added to the companion hook `org-execute-file-search-functions',
9379 which see.
9381 A function in this hook may also use `setq' to set the variable
9382 `description' to provide a suggestion for the descriptive text to
9383 be used for this link when it gets inserted into an Org-mode
9386 (defvar org-execute-file-search-functions nil
9387 "List of functions to execute a file search triggered by a link.
9389 Functions added to this hook must accept a single argument, the
9390 search string that was part of the file link, the part after the
9391 double colon. The function must first check if it would like to
9392 handle this search, for example by checking the `major-mode' or
9393 the file extension. If it decides not to handle this search, it
9394 should just return nil to give other functions a chance. If it
9395 does handle the search, it must return a non-nil value to keep
9396 other functions from trying.
9398 Each function can access the current prefix argument through the
9399 variable `current-prefix-argument'. Note that a single prefix is
9400 used to force opening a link in Emacs, so it may be good to only
9401 use a numeric or double prefix to guide the search function.
9403 In case this is needed, a function in this hook can also restore
9404 the window configuration before `org-open-at-point' was called using:
9406 (set-window-configuration org-window-config-before-follow-link)")
9408 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9409 (defun org-link-search (s &optional type avoid-pos)
9410 "Search for a link search option.
9411 If S is surrounded by forward slashes, it is interpreted as a
9412 regular expression. In org-mode files, this will create an `org-occur'
9413 sparse tree. In ordinary files, `occur' will be used to list matches.
9414 If the current buffer is in `dired-mode', grep will be used to search
9415 in all files. If AVOID-POS is given, ignore matches near that position."
9416 (let ((case-fold-search t)
9420 org-emphasis-alist)
9422 (pos (point))
9423 (pre nil) (post nil)
9424 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9425 (cond
9426 ;; First check if there are any special search functions
9427 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9428 ;; Now try the builtin stuff
9429 ((and (equal (string-to-char s0) ?#)
9430 (> (length s0) 1)
9431 (save-excursion
9432 (goto-char (point-min))
9433 (and
9434 (re-search-forward
9436 (setq type 'dedicated
9437 pos (match-beginning 0))))
9438 ;; There is an exact target for this
9439 (goto-char pos)
9440 (org-back-to-heading t)))
9441 ((save-excursion
9442 (goto-char (point-min))
9443 (and
9444 (re-search-forward
9445 (concat "<<" (regexp-quote s0) ">>") nil t)
9446 (setq type 'dedicated
9447 pos (match-beginning 0))))
9448 ;; There is an exact target for this
9449 (goto-char pos))
9451 (save-excursion
9452 (goto-char (point-min))
9453 (and
9454 (re-search-forward
9455 (concat "[^[]" (regexp-quote
9456 (format org-coderef-label-format
9457 (match-string 1 s0))))
9458 nil t)
9459 (setq type 'dedicated
9460 pos (1+ (match-beginning 0))))))
9461 ;; There is a coderef target for this
9462 (goto-char pos))
9464 ;; A regular expression
9465 (cond
9466 ((org-mode-p)
9467 (org-occur (match-string 1 s)))
9468 ;;((eq major-mode 'dired-mode)
9469 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9470 (t (org-do-occur (match-string 1 s)))))
9471 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9472 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9473 (goto-char (point-min))
9474 (cond
9475 ((let (case-fold-search)
9476 (re-search-forward (format org-complex-heading-regexp-format
9477 (regexp-quote s))
9478 nil t))
9479 ;; OK, found a match
9480 (setq type 'dedicated)
9481 (goto-char (match-beginning 0)))
9482 ((and (not org-link-search-inhibit-query)
9483 (eq org-link-search-must-match-exact-headline 'query-to-create)
9484 (y-or-n-p "No match - create this as a new heading? "))
9485 (goto-char (point-max))
9486 (or (bolp) (newline))
9488 (beginning-of-line 0))
9489 (t
9490 (goto-char pos)
9491 (error "No match"))))
9492 (t
9493 ;; A normal search string
9494 (when (equal (string-to-char s) ?*)
9495 ;; Anchor on headlines, post may include tags.
9498 s (substring s 1)))
9499 (remove-text-properties
9500 0 (length s)
9501 '(face nil mouse-face nil keymap nil fontified nil) s)
9502 ;; Make a series of regular expressions to find a match
9511 re4 (concat "[^a-zA-Z_]" re4_)
9513 re1 (concat pre re2 post)
9514 re3 (concat pre (if pre re4_ re4) post)
9515 re5 (concat pre ".*" re4)
9516 re2 (concat pre re2)
9517 re2a (concat pre (if pre re2a_ re2a))
9518 re4 (concat pre (if pre re4_ re4))
9522 ))
9523 (cond
9524 ((eq type 'org-occur) (org-occur reall))
9525 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9526 (t (goto-char (point-min))
9527 (setq type 'fuzzy)
9528 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9529 (org-search-not-self 1 re1 nil t)
9530 (org-search-not-self 1 re2 nil t)
9531 (org-search-not-self 1 re2a nil t)
9532 (org-search-not-self 1 re3 nil t)
9533 (org-search-not-self 1 re4 nil t)
9534 (org-search-not-self 1 re5 nil t)
9535 )
9536 (goto-char (match-beginning 1))
9537 (goto-char pos)
9538 (error "No match"))))))
9539 (and (org-mode-p) (org-show-context 'link-search))
9540 type))
9542 (defun org-search-not-self (group &rest args)
9543 "Execute `re-search-forward', but only accept matches that do not
9544 enclose the position of `org-open-link-marker'."
9545 (let ((m org-open-link-marker))
9546 (catch 'exit
9547 (while (apply 're-search-forward args)
9548 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9549 (goto-char (match-end group))
9550 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9551 (> (match-beginning 0) (marker-position m))
9552 (< (match-end 0) (marker-position m)))
9553 (save-match-data
9554 (or (not (org-in-regexp
9555 org-bracket-link-analytic-regexp 1))
9556 (not (match-end 4)) ; no description
9557 (and (<= (match-beginning 4) (point))
9558 (>= (match-end 4) (point))))))
9559 (throw 'exit (point))))))))
9561 (defun org-get-buffer-for-internal-link (buffer)
9562 "Return a buffer to be used for displaying the link target of internal links."
9563 (cond
9564 ((not org-display-internal-link-with-indirect-buffer)
9565 buffer)
9566 ((string-match "(Clone)$" (buffer-name buffer))
9567 (message "Buffer is already a clone, not making another one")
9568 ;; we also do not modify visibility in this case
9569 buffer)
9570 (t ; make a new indirect buffer for displaying the link
9571 (let* ((bn (buffer-name buffer))
9572 (ibn (concat bn "(Clone)"))
9573 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9574 (with-current-buffer ib (org-overview))
9575 ib))))
9577 (defun org-do-occur (regexp &optional cleanup)
9578 "Call the Emacs command `occur'.
9579 If CLEANUP is non-nil, remove the printout of the regular expression
9580 in the *Occur* buffer. This is useful if the regex is long and not useful
9581 to read."
9582 (occur regexp)
9583 (when cleanup
9584 (let ((cwin (selected-window)) win beg end)
9585 (when (setq win (get-buffer-window "*Occur*"))
9586 (select-window win))
9587 (goto-char (point-min))
9588 (when (re-search-forward "match[a-z]+" nil t)
9589 (setq beg (match-end 0))
9591 (setq end (1- (match-beginning 0)))))
9592 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9593 (goto-char (point-min))
9594 (select-window cwin))))
9596 ;;; The mark ring for links jumps
9598 (defvar org-mark-ring nil
9599 "Mark ring for positions before jumps in Org-mode.")
9600 (defvar org-mark-ring-last-goto nil
9601 "Last position in the mark ring used to go back.")
9602 ;; Fill and close the ring
9603 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9604 (loop for i from 1 to org-mark-ring-length do
9605 (push (make-marker) org-mark-ring))
9606 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9607 org-mark-ring)
9609 (defun org-mark-ring-push (&optional pos buffer)
9610 "Put the current position or POS into the mark ring and rotate it."
9611 (interactive)
9612 (setq pos (or pos (point)))
9613 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9614 (move-marker (car org-mark-ring)
9615 (or pos (point))
9616 (or buffer (current-buffer)))
9617 (message "%s"
9618 (substitute-command-keys
9621 (defun org-mark-ring-goto (&optional n)
9622 "Jump to the previous position in the mark ring.
9623 With prefix arg N, jump back that many stored positions. When
9624 called several times in succession, walk through the entire ring.
9625 Org-mode commands jumping to a different position in the current file,
9626 or to another Org-mode file, automatically push the old position
9627 onto the ring."
9628 (interactive "p")
9629 (let (p m)
9630 (if (eq last-command this-command)
9631 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9632 (setq p org-mark-ring))
9633 (setq org-mark-ring-last-goto p)
9634 (setq m (car p))
9635 (switch-to-buffer (marker-buffer m))
9636 (goto-char m)
9637 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9639 (defun org-remove-angle-brackets (s)
9640 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9641 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9642 s)
9643 (defun org-add-angle-brackets (s)
9644 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9645 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9646 s)
9647 (defun org-remove-double-quotes (s)
9650 s)
9652 ;;; Following specific links
9654 (defun org-follow-timestamp-link ()
9655 (cond
9656 ((org-at-date-range-p t)
9657 (let ((org-agenda-start-on-weekday)
9658 (t1 (match-string 1))
9659 (t2 (match-string 2)))
9660 (setq t1 (time-to-days (org-time-string-to-time t1))
9661 t2 (time-to-days (org-time-string-to-time t2)))
9662 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9663 ((org-at-timestamp-p t)
9664 (org-agenda-list nil (time-to-days (org-time-string-to-time
9665 (substring (match-string 1) 0 10)))
9666 1))
9667 (t (error "This should not happen"))))
9670 ;;; Following file links
9671 (defvar org-wait nil)
9672 (defun org-open-file (path &optional in-emacs line search)
9673 "Open the file at PATH.
9674 First, this expands any special file name abbreviations. Then the
9675 configuration variable `org-file-apps' is checked if it contains an
9676 entry for this file type, and if yes, the corresponding command is launched.
9678 If no application is found, Emacs simply visits the file.
9680 With optional prefix argument IN-EMACS, Emacs will visit the file.
9682 prefix arg, Org tries to avoid opening in Emacs
9683 and to use an external application to visit the file.
9685 Optional LINE specifies a line to go to, optional SEARCH a string
9686 to search for. If LINE or SEARCH is given, the file will be
9687 opened in Emacs, unless an entry from org-file-apps that makes
9688 use of groups in a regexp matches.
9689 If the file does not exist, an error is thrown."
9690 (let* ((file (if (equal path "")
9691 buffer-file-name
9692 (substitute-in-file-name (expand-file-name path))))
9693 (file-apps (append org-file-apps (org-default-apps)))
9694 (apps (org-remove-if
9695 'org-file-apps-entry-match-against-dlink-p file-apps))
9696 (apps-dlink (org-remove-if-not
9697 'org-file-apps-entry-match-against-dlink-p file-apps))
9698 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9699 (dirp (if remp nil (file-directory-p file)))
9700 (file (if (and dirp org-open-directory-means-index-dot-org)
9701 (concat (file-name-as-directory file) "index.org")
9702 file))
9703 (a-m-a-p (assq 'auto-mode apps))
9704 (dfile (downcase file))
9705 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9706 (link (cond ((and (eq line nil)
9707 (eq search nil))
9708 file)
9709 (line
9710 (concat file "::" (number-to-string line)))
9711 (search
9712 (concat file "::" search))))
9713 (dlink (downcase link))
9714 (old-buffer (current-buffer))
9715 (old-pos (point))
9716 (old-mode major-mode)
9717 ext cmd link-match-data)
9719 (setq ext (match-string 1 dfile))
9721 (setq ext (match-string 1 dfile))))
9722 (cond
9723 ((member in-emacs '((16) system))
9724 (setq cmd (cdr (assoc 'system apps))))
9725 (in-emacs (setq cmd 'emacs))
9726 (t
9727 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9728 (and dirp (cdr (assoc 'directory apps)))
9729 ; first, try matching against apps-dlink
9730 ; if we get a match here, store the match data for later
9731 (let ((match (assoc-default dlink apps-dlink
9732 'string-match)))
9733 (if match
9734 (progn (setq link-match-data (match-data))
9735 match)
9736 (progn (setq in-emacs (or in-emacs line search))
9737 nil))) ; if we have no match in apps-dlink,
9738 ; always open the file in emacs if line or search
9739 ; is given (for backwards compatibility)
9740 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9741 'string-match)
9742 (cdr (assoc ext apps))
9743 (cdr (assoc t apps))))))
9744 (when (eq cmd 'system)
9745 (setq cmd (cdr (assoc 'system apps))))
9746 (when (eq cmd 'default)
9747 (setq cmd (cdr (assoc t apps))))
9748 (when (eq cmd 'mailcap)
9749 (require 'mailcap)
9750 (mailcap-parse-mailcaps)
9751 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9752 (command (mailcap-mime-info mime-type)))
9753 (if (stringp command)
9754 (setq cmd command)
9755 (setq cmd 'emacs))))
9756 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9757 (not (file-exists-p file))
9758 (not org-open-non-existing-files))
9759 (error "No such file: %s" file))
9760 (cond
9762 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9764 (setq cmd (replace-match "%s" t t cmd)))
9765 (while (string-match "%s" cmd)
9766 (setq cmd (replace-match
9767 (save-match-data
9768 (shell-quote-argument
9769 (convert-standard-filename file)))
9770 t t cmd)))
9772 ;; Replace "%1", "%2" etc. in command with group matches from regex
9773 (save-match-data
9774 (let ((match-index 1)
9775 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9776 (set-match-data link-match-data)
9777 (while (<= match-index number-of-groups)
9778 (let ((regex (concat "%" (number-to-string match-index)))
9779 (replace-with (match-string match-index dlink)))
9780 (while (string-match regex cmd)
9781 (setq cmd (replace-match replace-with t t cmd))))
9782 (setq match-index (+ match-index 1)))))
9784 (save-window-excursion
9785 (start-process-shell-command cmd nil cmd)
9786 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9787 ))
9788 ((or (stringp cmd)
9789 (eq cmd 'emacs))
9790 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9791 (widen)
9792 (if line (org-goto-line line)
9793 (if search (org-link-search search))))
9794 ((consp cmd)
9795 (let ((file (convert-standard-filename file)))
9796 (save-match-data
9797 (set-match-data link-match-data)
9798 (eval cmd))))
9799 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9800 (and (org-mode-p) (eq old-mode 'org-mode)
9801 (or (not (equal old-buffer (current-buffer)))
9802 (not (equal old-pos (point))))
9803 (org-mark-ring-push old-pos old-buffer))))
9805 (defun org-file-apps-entry-match-against-dlink-p (entry)
9806 "This function returns non-nil if `entry' uses a regular
9807 expression which should be matched against the whole link by
9808 org-open-file.
9810 It assumes that is the case when the entry uses a regular
9811 expression which has at least one grouping construct and the
9812 action is either a lisp form or a command string containing
9813 '%1', i.e. using at least one subexpression match as a
9814 parameter."
9815 (let ((selector (car entry))
9816 (action (cdr entry)))
9817 (if (stringp selector)
9818 (and (> (regexp-opt-depth selector) 0)
9819 (or (and (stringp action)
9820 (string-match "%[0-9]" action))
9821 (consp action)))
9822 nil)))
9824 (defun org-default-apps ()
9825 "Return the default applications for this operating system."
9826 (cond
9827 ((eq system-type 'darwin)
9828 org-file-apps-defaults-macosx)
9829 ((eq system-type 'windows-nt)
9830 org-file-apps-defaults-windowsnt)
9831 (t org-file-apps-defaults-gnu)))
9833 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9834 "Convert extensions to regular expressions in the cars of LIST.
9835 Also, weed out any non-string entries, because the return value is used
9836 only for regexp matching.
9837 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9838 point to the symbol `emacs', indicating that the file should
9839 be opened in Emacs."
9840 (append
9841 (delq nil
9842 (mapcar (lambda (x)
9843 (if (not (stringp (car x)))
9844 nil
9846 x
9848 list))
9849 (if add-auto-mode
9850 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9852 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9853 (defun org-file-remote-p (file)
9854 "Test whether FILE specifies a location on a remote system.
9855 Return non-nil if the location is indeed remote.
9859 (cond ((fboundp 'file-remote-p)
9860 (file-remote-p file))
9861 ((fboundp 'tramp-handle-file-remote-p)
9862 (tramp-handle-file-remote-p file))
9863 ((and (boundp 'ange-ftp-name-format)
9864 (string-match (car ange-ftp-name-format) file))
9865 t)
9866 (t nil)))
9869 ;;;; Refiling
9871 (defun org-get-org-file ()
9872 "Read a filename, with default directory `org-directory'."
9873 (let ((default (or org-default-notes-file remember-data-file)))
9874 (read-file-name (format "File name [%s]: " default)
9875 (file-name-as-directory org-directory)
9876 default)))
9878 (defun org-notes-order-reversed-p ()
9879 "Check if the current file should receive notes in reversed order."
9880 (cond
9881 ((not org-reverse-note-order) nil)
9882 ((eq t org-reverse-note-order) t)
9883 ((not (listp org-reverse-note-order)) nil)
9884 (t (catch 'exit
9885 (let ((all org-reverse-note-order)
9886 entry)
9887 (while (setq entry (pop all))
9888 (if (string-match (car entry) buffer-file-name)
9889 (throw 'exit (cdr entry))))
9890 nil)))))
9892 (defvar org-refile-target-table nil
9893 "The list of refile targets, created by `org-refile'.")
9895 (defvar org-agenda-new-buffers nil
9896 "Buffers created to visit agenda files.")
9898 (defvar org-refile-cache nil
9899 "Cache for refile targets.")
9902 (defvar org-refile-markers nil
9903 "All the markers used for caching refile locations.")
9905 (defun org-refile-marker (pos)
9906 "Get a new refile marker, but only if caching is in use."
9907 (if (not org-refile-use-cache)
9908 pos
9909 (let ((m (make-marker)))
9910 (move-marker m pos)
9911 (push m org-refile-markers)
9912 m)))
9914 (defun org-refile-cache-clear ()
9915 "Clear the refile cache and disable all the markers."
9916 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
9917 (setq org-refile-markers nil)
9918 (setq org-refile-cache nil)
9919 (message "Refile cache has been cleared"))
9921 (defun org-refile-cache-check-set (set)
9922 "Check if all the markers in the cache still have live buffers."
9923 (let (marker)
9924 (catch 'exit
9925 (while (and set (setq marker (nth 3 (pop set))))
9926 ;; if org-refile-use-outline-path is 'file, marker may be nil
9927 (when (and marker (null (marker-buffer marker)))
9928 (message "not found") (sit-for 3)
9929 (throw 'exit nil)))
9930 t)))
9932 (defun org-refile-cache-put (set &rest identifiers)
9933 "Push the refile targets SET into the cache, under IDENTIFIERS."
9934 (let* ((key (sha1 (prin1-to-string identifiers)))
9935 (entry (assoc key org-refile-cache)))
9936 (if entry
9937 (setcdr entry set)
9938 (push (cons key set) org-refile-cache))))
9940 (defun org-refile-cache-get (&rest identifiers)
9941 "Retrieve the cached value for refile targets given by IDENTIFIERS."
9942 (cond
9943 ((not org-refile-cache) nil)
9944 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
9945 (t
9946 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
9947 org-refile-cache))))
9948 (and set (org-refile-cache-check-set set) set)))))
9950 (defun org-get-refile-targets (&optional default-buffer)
9951 "Produce a table with refile targets."
9952 (let ((case-fold-search nil)
9953 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
9954 (entries (or org-refile-targets '((nil . (:level . 1)))))
9955 targets tgs txt re files f desc descre fast-path-p level pos0)
9956 (message "Getting targets...")
9957 (with-current-buffer (or default-buffer (current-buffer))
9958 (while (setq entry (pop entries))
9959 (setq files (car entry) desc (cdr entry))
9960 (setq fast-path-p nil)
9961 (cond
9962 ((null files) (setq files (list (current-buffer))))
9963 ((eq files 'org-agenda-files)
9964 (setq files (org-agenda-files 'unrestricted)))
9965 ((and (symbolp files) (fboundp files))
9966 (setq files (funcall files)))
9967 ((and (symbolp files) (boundp files))
9968 (setq files (symbol-value files))))
9969 (if (stringp files) (setq files (list files)))
9970 (cond
9971 ((eq (car desc) :tag)
9973 ((eq (car desc) :todo)
9975 ((eq (car desc) :regexp)
9976 (setq descre (cdr desc)))
9977 ((eq (car desc) :level)
9979 (if org-odd-levels-only
9980 (1- (* 2 (cdr desc)))
9981 (cdr desc)))
9983 ((eq (car desc) :maxlevel)
9984 (setq fast-path-p t)
9986 (if org-odd-levels-only
9987 (1- (* 2 (cdr desc)))
9988 (cdr desc)))
9990 (t (error "Bad refiling target description %s" desc)))
9991 (while (setq f (pop files))
9992 (with-current-buffer
9993 (if (bufferp f) f (org-get-agenda-file-buffer f))
9994 (or
9995 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
9996 (progn
9997 (if (bufferp f) (setq f (buffer-file-name
9998 (buffer-base-buffer f))))
9999 (setq f (and f (expand-file-name f)))
10000 (if (eq org-refile-use-outline-path 'file)
10001 (push (list (file-name-nondirectory f) f nil nil) tgs))
10002 (save-excursion
10003 (save-restriction
10004 (widen)
10005 (goto-char (point-min))
10006 (while (re-search-forward descre nil t)
10007 (goto-char (setq pos0 (point-at-bol)))
10008 (catch 'next
10009 (when org-refile-target-verify-function
10010 (save-match-data
10011 (or (funcall org-refile-target-verify-function)
10012 (throw 'next t))))
10013 (when (looking-at org-complex-heading-regexp)
10014 (setq level (org-reduced-level
10015 (- (match-end 1) (match-beginning 1)))
10016 txt (org-link-display-format (match-string 4))
10018 re (format org-complex-heading-regexp-format
10019 (regexp-quote (match-string 4))))
10020 (when org-refile-use-outline-path
10021 (setq txt (mapconcat
10022 'org-protect-slash
10023 (append
10024 (if (eq org-refile-use-outline-path
10025 'file)
10026 (list (file-name-nondirectory
10027 (buffer-file-name
10028 (buffer-base-buffer))))
10029 (if (eq org-refile-use-outline-path
10030 'full-file-path)
10031 (list (buffer-file-name
10032 (buffer-base-buffer)))))
10033 (org-get-outline-path fast-path-p
10034 level txt)
10035 (list txt))
10036 "/")))
10037 (push (list txt f re (org-refile-marker (point)))
10038 tgs)))
10039 (when (= (point) pos0)
10040 ;; verification function has not moved point
10041 (goto-char (point-at-eol))))))))
10042 (when org-refile-use-cache
10043 (org-refile-cache-put tgs (buffer-file-name) descre))
10044 (setq targets (append tgs targets))
10045 ))))
10046 (message "Getting targets...done")
10047 (nreverse targets)))
10049 (defun org-protect-slash (s)
10050 (while (string-match "/" s)
10052 s)
10054 (defvar org-olpa (make-vector 20 nil))
10056 (defun org-get-outline-path (&optional fastp level heading)
10057 "Return the outline path to the current entry, as a list.
10059 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10060 routine which makes outline path derivations for an entire file,
10061 avoiding backtracing. Refile target collection makes use of that."
10062 (if fastp
10063 (progn
10064 (if (> level 19)
10065 (error "Outline path failure, more than 19 levels"))
10066 (loop for i from level upto 19 do
10067 (aset org-olpa i nil))
10068 (prog1
10069 (delq nil (append org-olpa nil))
10070 (aset org-olpa level heading)))
10071 (let (rtn case-fold-search)
10072 (save-excursion
10073 (save-restriction
10074 (widen)
10075 (while (org-up-heading-safe)
10076 (when (looking-at org-complex-heading-regexp)
10077 (push (org-match-string-no-properties 4) rtn)))
10078 rtn)))))
10080 (defun org-format-outline-path (path &optional width prefix)
10081 "Format the outline path PATH for display.
10082 Width is the maximum number of characters that is available.
10083 Prefix is a prefix to be included in the returned string,
10084 such as the file name."
10085 (setq width (or width 79))
10086 (if prefix (setq width (- width (length prefix))))
10087 (if (not path)
10088 (or prefix "")
10089 (let* ((nsteps (length path))
10090 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10091 (maxwidth (if (<= total-width width)
10092 10000 ;; everything fits
10093 ;; we need to shorten the level headings
10094 (/ (- width nsteps) nsteps)))
10095 (org-odd-levels-only nil)
10096 (n 0)
10097 (total (1+ (length prefix))))
10098 (setq maxwidth (max maxwidth 10))
10099 (concat prefix
10100 (mapconcat
10101 (lambda (h)
10102 (setq n (1+ n))
10103 (if (and (= n nsteps) (< maxwidth 10000))
10104 (setq maxwidth (- total-width total)))
10105 (if (< (length h) maxwidth)
10106 (progn (setq total (+ total (length h) 1)) h)
10107 (setq h (substring h 0 (- maxwidth 2))
10108 total (+ total maxwidth 1))
10110 (setq h (substring h 0 (match-beginning 0))))
10111 (setq h (concat h "..")))
10112 (org-add-props h nil 'face
10113 (nth (% (1- n) org-n-level-faces)
10114 org-level-faces))
10115 h)
10116 path "/")))))
10118 (defun org-display-outline-path (&optional file current)
10119 "Display the current outline path in the echo area."
10120 (interactive "P")
10121 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10122 (case-fold-search nil)
10123 (path (and (org-mode-p) (org-get-outline-path))))
10124 (if current (setq path (append path
10125 (save-excursion
10126 (org-back-to-heading t)
10127 (if (looking-at org-complex-heading-regexp)
10128 (list (match-string 4)))))))
10129 (message "%s"
10130 (org-format-outline-path
10131 path
10132 (1- (frame-width))
10133 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10135 (defvar org-refile-history nil
10136 "History for refiling operations.")
10138 (defvar org-after-refile-insert-hook nil
10139 "Hook run after `org-refile' has inserted its stuff at the new location.
10140 Note that this is still *before* the stuff will be removed from
10141 the *old* location.")
10143 (defvar org-capture-last-stored-marker)
10144 (defun org-refile (&optional goto default-buffer rfloc)
10145 "Move the entry at point to another heading.
10146 The list of target headings is compiled using the information in
10147 `org-refile-targets', which see. This list is created before each use
10148 and will therefore always be up-to-date.
10150 At the target location, the entry is filed as a subitem of the target heading.
10151 Depending on `org-reverse-note-order', the new subitem will either be the
10152 first or the last subitem.
10154 If there is an active region, all entries in that region will be moved.
10155 However, the region must fulfill the requirement that the first heading
10156 is the first one sets the top-level of the moved text - at most siblings
10157 below it are allowed.
10159 With prefix arg GOTO, the command will only visit the target location,
10160 not actually move anything.
10162 go to the location where the last refiling
10163 operation has put the subtree.
10164 With a prefix argument of `2', refile to the running clock.
10166 RFLOC can be a refile location obtained in a different way.
10168 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10170 If you are using target caching (see `org-refile-use-cache'),
10171 You have to clear the target cache in order to find new targets.
10172 This can be done with a 0 prefix: `C-0 C-c C-w'"
10173 (interactive "P")
10174 (if (member goto '(0 (64)))
10175 (org-refile-cache-clear)
10176 (let* ((cbuf (current-buffer))
10177 (regionp (org-region-active-p))
10178 (region-start (and regionp (region-beginning)))
10179 (region-end (and regionp (region-end)))
10180 (region-length (and regionp (- region-end region-start)))
10181 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10182 pos it nbuf file re level reversed)
10183 (setq last-command nil)
10184 (when regionp
10185 (goto-char region-start)
10186 (or (bolp) (goto-char (point-at-bol)))
10187 (setq region-start (point))
10188 (unless (org-kill-is-subtree-p
10189 (buffer-substring region-start region-end))
10190 (error "The region is not a (sequence of) subtree(s)")))
10191 (if (equal goto '(16))
10192 (org-refile-goto-last-stored)
10193 (when (or
10194 (and (equal goto 2)
10195 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10196 (prog1
10197 (setq it (list (or org-clock-heading "running clock")
10198 (buffer-file-name
10199 (marker-buffer org-clock-hd-marker))
10200 ""
10201 (marker-position org-clock-hd-marker)))
10202 (setq goto nil)))
10203 (setq it (or rfloc
10204 (save-excursion
10205 (org-refile-get-location
10206 (if goto "Goto: " "Refile to: ") default-buffer
10207 org-refile-allow-creating-parent-nodes)))))
10208 (setq file (nth 1 it)
10209 re (nth 2 it)
10210 pos (nth 3 it))
10211 (if (and (not goto)
10212 pos
10213 (equal (buffer-file-name) file)
10214 (if regionp
10215 (and (>= pos region-start)
10216 (<= pos region-end))
10217 (and (>= pos (point))
10218 (< pos (save-excursion
10219 (org-end-of-subtree t t))))))
10220 (error "Cannot refile to position inside the tree or region"))
10222 (setq nbuf (or (find-buffer-visiting file)
10223 (find-file-noselect file)))
10224 (if goto
10225 (progn
10226 (switch-to-buffer nbuf)
10227 (goto-char pos)
10228 (org-show-context 'org-goto))
10229 (if regionp
10230 (progn
10231 (org-kill-new (buffer-substring region-start region-end))
10232 (org-save-markers-in-region region-start region-end))
10233 (org-copy-subtree 1 nil t))
10234 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10235 (find-file-noselect file)))
10236 (setq reversed (org-notes-order-reversed-p))
10237 (save-excursion
10238 (save-restriction
10239 (widen)
10240 (if pos
10241 (progn
10242 (goto-char pos)
10243 (looking-at outline-regexp)
10244 (setq level (org-get-valid-level (funcall outline-level) 1))
10245 (goto-char
10246 (if reversed
10247 (or (outline-next-heading) (point-max))
10248 (or (save-excursion (org-get-next-sibling))
10249 (org-end-of-subtree t t)
10250 (point-max)))))
10251 (setq level 1)
10252 (if (not reversed)
10253 (goto-char (point-max))
10254 (goto-char (point-min))
10255 (or (outline-next-heading) (goto-char (point-max)))))
10256 (if (not (bolp)) (newline))
10257 (org-paste-subtree level)
10258 (when org-log-refile
10259 (org-add-log-setup 'refile nil nil 'findpos
10260 org-log-refile)
10261 (unless (eq org-log-refile 'note)
10262 (save-excursion (org-add-log-note))))
10263 (and org-auto-align-tags (org-set-tags nil t))
10264 (bookmark-set "org-refile-last-stored")
10265 ;; If we are refiling for capture, make sure that the
10266 ;; last-capture pointers point here
10267 (when (org-bound-and-true-p org-refile-for-capture)
10268 (bookmark-set "org-capture-last-stored-marker")
10269 (move-marker org-capture-last-stored-marker (point)))
10270 (if (fboundp 'deactivate-mark) (deactivate-mark))
10271 (run-hooks 'org-after-refile-insert-hook))))
10272 (if regionp
10273 (delete-region (point) (+ (point) region-length))
10274 (org-cut-subtree))
10275 (when (featurep 'org-inlinetask)
10276 (org-inlinetask-remove-END-maybe))
10277 (setq org-markers-to-move nil)
10280 (defun org-refile-goto-last-stored ()
10281 "Go to the location where the last refile was stored."
10282 (interactive)
10283 (bookmark-jump "org-refile-last-stored")
10284 (message "This is the location of the last refile"))
10286 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10287 "Prompt the user for a refile location, using PROMPT."
10288 (let ((org-refile-targets org-refile-targets)
10289 (org-refile-use-outline-path org-refile-use-outline-path))
10290 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
10291 (unless org-refile-target-table
10292 (error "No refile targets"))
10293 (let* ((cbuf (current-buffer))
10294 (partial-completion-mode nil)
10295 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10296 (cfunc (if (and org-refile-use-outline-path
10297 org-outline-path-complete-in-steps)
10298 'org-olpath-completing-read
10299 'org-icompleting-read))
10300 (extra (if org-refile-use-outline-path "/" ""))
10301 (filename (and cfn (expand-file-name cfn)))
10302 (tbl (mapcar
10303 (lambda (x)
10304 (if (and (not (member org-refile-use-outline-path
10305 '(file full-file-path)))
10306 (not (equal filename (nth 1 x))))
10307 (cons (concat (car x) extra " ("
10308 (file-name-nondirectory (nth 1 x)) ")")
10309 (cdr x))
10310 (cons (concat (car x) extra) (cdr x))))
10311 org-refile-target-table))
10312 (completion-ignore-case t)
10313 pa answ parent-target child parent old-hist)
10314 (setq old-hist org-refile-history)
10315 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10316 nil 'org-refile-history))
10317 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10318 (org-refile-check-position pa)
10319 (if pa
10320 (progn
10321 (when (or (not org-refile-history)
10322 (not (eq old-hist org-refile-history))
10323 (not (equal (car pa) (car org-refile-history))))
10324 (setq org-refile-history
10325 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10326 org-refile-history
10327 (cdr org-refile-history))))
10328 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10329 (pop org-refile-history)))
10330 pa)
10332 (progn
10333 (setq parent (match-string 1 answ)
10334 child (match-string 2 answ))
10335 (setq parent-target (or (assoc parent tbl)
10336 (assoc (concat parent "/") tbl)))
10337 (when (and parent-target
10338 (or (eq new-nodes t)
10339 (and (eq new-nodes 'confirm)
10341 child)))))
10342 (org-refile-new-child parent-target child)))
10343 (error "Invalid target location")))))
10345 (defun org-refile-check-position (refile-pointer)
10346 "Check if the refile pointer matches the readline to which it points."
10347 (let* ((file (nth 1 refile-pointer))
10348 (re (nth 2 refile-pointer))
10349 (pos (nth 3 refile-pointer))
10350 buffer)
10351 (when (org-string-nw-p re)
10352 (setq buffer (if (markerp pos)
10353 (marker-buffer pos)
10354 (or (find-buffer-visiting file)
10355 (find-file-noselect file))))
10356 (with-current-buffer buffer
10357 (save-excursion
10358 (save-restriction
10359 (widen)
10360 (goto-char pos)
10361 (beginning-of-line 1)
10362 (unless (org-looking-at-p re)
10363 (error "Invalid refile position, please rebuild the cache"))))))))
10365 (defun org-refile-new-child (parent-target child)
10366 "Use refile target PARENT-TARGET to add new CHILD below it."
10367 (unless parent-target
10368 (error "Cannot find parent for new node"))
10369 (let ((file (nth 1 parent-target))
10370 (pos (nth 3 parent-target))
10371 level)
10372 (with-current-buffer (or (find-buffer-visiting file)
10373 (find-file-noselect file))
10374 (save-excursion
10375 (save-restriction
10376 (widen)
10377 (if pos
10378 (goto-char pos)
10379 (goto-char (point-max))
10380 (if (not (bolp)) (newline)))
10381 (when (looking-at outline-regexp)
10382 (setq level (funcall outline-level))
10383 (org-end-of-subtree t t))
10384 (org-back-over-empty-lines)
10386 (if pos (org-get-valid-level level 1) 1) ?*)
10388 (beginning-of-line 0)
10389 (list (concat (car parent-target) "/" child) file "" (point)))))))
10391 (defun org-olpath-completing-read (prompt collection &rest args)
10392 "Read an outline path like a file name."
10393 (let ((thetable collection)
10394 (org-completion-use-ido nil) ; does not work with ido.
10395 (org-completion-use-iswitchb nil)) ; or iswitchb
10396 (apply
10397 'org-icompleting-read prompt
10398 (lambda (string predicate &optional flag)
10399 (let (rtn r f (l (length string)))
10400 (cond
10401 ((eq flag nil)
10402 ;; try completion
10403 (try-completion string thetable))
10404 ((eq flag t)
10405 ;; all-completions
10406 (setq rtn (all-completions string thetable predicate))
10407 (mapcar
10408 (lambda (x)
10409 (setq r (substring x l))
10410 (if (string-match " ([^)]*)$" x)
10411 (setq f (match-string 0 x))
10412 (setq f ""))
10413 (if (string-match "/" r)
10414 (concat string (substring r 0 (match-end 0)) f)
10415 x))
10416 rtn))
10417 ((eq flag 'lambda)
10418 ;; exact match?
10419 (assoc string thetable)))
10420 ))
10421 args)))
10423 ;;;; Dynamic blocks
10425 (defun org-find-dblock (name)
10426 "Find the first dynamic block with name NAME in the buffer.
10427 If not found, stay at current position and return nil."
10428 (let (pos)
10429 (save-excursion
10430 (goto-char (point-min))
10432 nil t)
10433 (match-beginning 0))))
10434 (if pos (goto-char pos))
10435 pos))
10437 (defconst org-dblock-start-re
10439 "Matches the start line of a dynamic block, with parameters.")
10442 "Matches the end of a dynamic block.")
10444 (defun org-create-dblock (plist)
10445 "Create a dynamic block section, with parameters taken from PLIST.
10446 PLIST must contain a :name entry which is used as name of the block."
10448 (end-of-line 1)
10449 (newline))
10450 (let ((col (current-column))
10451 (name (plist-get plist :name)))
10452 (insert "#+BEGIN: " name)
10453 (while plist
10454 (if (eq (car plist) :name)
10455 (setq plist (cddr plist))
10456 (insert " " (prin1-to-string (pop plist)))))
10458 (beginning-of-line -2)))
10460 (defun org-prepare-dblock ()
10461 "Prepare dynamic block for refresh.
10462 This empties the block, puts the cursor at the insert position and returns
10463 the property list including an extra property :name with the block name."
10464 (unless (looking-at org-dblock-start-re)
10465 (error "Not at a dynamic block"))
10466 (let* ((begdel (1+ (match-end 0)))
10467 (name (org-no-properties (match-string 1)))
10468 (params (append (list :name name)
10469 (read (concat "(" (match-string 3) ")")))))
10470 (save-excursion
10471 (beginning-of-line 1)
10473 (setq params (plist-put params :indentation-column (current-column))))
10474 (unless (re-search-forward org-dblock-end-re nil t)
10475 (error "Dynamic block not terminated"))
10476 (setq params
10477 (append params
10478 (list :content (buffer-substring
10479 begdel (match-beginning 0)))))
10480 (delete-region begdel (match-beginning 0))
10481 (goto-char begdel)
10482 (open-line 1)
10483 params))
10485 (defun org-map-dblocks (&optional command)
10486 "Apply COMMAND to all dynamic blocks in the current buffer.
10487 If COMMAND is not given, use `org-update-dblock'."
10488 (let ((cmd (or command 'org-update-dblock)))
10489 (save-excursion
10490 (goto-char (point-min))
10491 (while (re-search-forward org-dblock-start-re nil t)
10492 (goto-char (match-beginning 0))
10493 (save-excursion
10494 (condition-case nil
10495 (funcall cmd)
10496 (error (message "Error during update of dynamic block"))))
10497 (unless (re-search-forward org-dblock-end-re nil t)
10498 (error "Dynamic block not terminated"))))))
10500 (defun org-dblock-update (&optional arg)
10501 "User command for updating dynamic blocks.
10502 Update the dynamic block at point. With prefix ARG, update all dynamic
10503 blocks in the buffer."
10504 (interactive "P")
10505 (if arg
10506 (org-update-all-dblocks)
10507 (or (looking-at org-dblock-start-re)
10508 (org-beginning-of-dblock))
10509 (org-update-dblock)))
10511 (defun org-update-dblock ()
10512 "Update the dynamic block at point.
10513 This means to empty the block, parse for parameters and then call
10514 the correct writing function."
10515 (interactive)
10516 (save-window-excursion
10517 (let* ((pos (point))
10518 (line (org-current-line))
10519 (params (org-prepare-dblock))
10520 (name (plist-get params :name))
10521 (indent (plist-get params :indentation-column))
10522 (cmd (intern (concat "org-dblock-write:" name))))
10523 (message "Updating dynamic block `%s' at line %d..." name line)
10524 (funcall cmd params)
10525 (message "Updating dynamic block `%s' at line %d...done" name line)
10526 (goto-char pos)
10527 (when (and indent (> indent 0))
10528 (setq indent (make-string indent ?\ ))
10529 (save-excursion
10530 (org-beginning-of-dblock)
10531 (forward-line 1)
10532 (while (not (looking-at org-dblock-end-re))
10533 (insert indent)
10534 (beginning-of-line 2))
10535 (when (looking-at org-dblock-end-re)
10537 (replace-match ""))
10538 (insert indent)))))))
10540 (defun org-beginning-of-dblock ()
10541 "Find the beginning of the dynamic block at point.
10542 Error if there is no such block at point."
10543 (let ((pos (point))
10544 beg)
10545 (end-of-line 1)
10546 (if (and (re-search-backward org-dblock-start-re nil t)
10547 (setq beg (match-beginning 0))
10548 (re-search-forward org-dblock-end-re nil t)
10549 (> (match-end 0) pos))
10550 (goto-char beg)
10551 (goto-char pos)
10552 (error "Not in a dynamic block"))))
10554 (defun org-update-all-dblocks ()
10555 "Update all dynamic blocks in the buffer.
10556 This function can be used in a hook."
10557 (interactive)
10558 (when (org-mode-p)
10559 (org-map-dblocks 'org-update-dblock)))
10562 ;;;; Completion
10564 (defconst org-additional-option-like-keywords
10565 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10566 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10567 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10568 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10569 "BEGIN:" "END:"
10570 "ORGTBL" "TBLFM:" "TBLNAME:"
10571 "BEGIN_EXAMPLE" "END_EXAMPLE"
10572 "BEGIN_QUOTE" "END_QUOTE"
10573 "BEGIN_VERSE" "END_VERSE"
10574 "BEGIN_CENTER" "END_CENTER"
10575 "BEGIN_SRC" "END_SRC"
10576 "BEGIN_RESULT" "END_RESULT"
10577 "SOURCE:" "SRCNAME:" "FUNCTION:"
10578 "RESULTS:"
10579 "HEADER:" "HEADERS:"
10580 "BABEL:"
10581 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10582 "CAPTION:" "LABEL:"
10583 "SETUPFILE:"
10584 "INCLUDE:"
10585 "BIND:"
10586 "MACRO:"))
10588 (defcustom org-structure-template-alist
10589 '(
10602 ("L" "#+latex: "
10606 ("H" "#+html: "
10609 ("A" "#+ascii: ")
10610 ("i" "#+include %file ?"
10612 )
10613 "Structure completion elements.
10614 This is a list of abbreviation keys and values. The value gets inserted
10615 if you type `<' followed by the key and then press the completion key,
10616 usually `M-TAB'. %file will be replaced by a file name after prompting
10617 for the file using completion.
10618 There are two templates for each key, the first uses the original Org syntax,
10619 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10620 the default when the /org-mtags.el/ module has been loaded. See also the
10621 variable `org-mtags-prefer-muse-templates'.
10622 This is an experimental feature, it is undecided if it is going to stay in."
10623 :group 'org-completion
10624 :type '(repeat
10625 (string :tag "Key")
10626 (string :tag "Template")
10627 (string :tag "Muse Template")))
10629 (defun org-try-structure-completion ()
10630 "Try to complete a structure template before point.
10632 expands them."
10633 (let ((l (buffer-substring (point-at-bol) (point)))
10634 a)
10637 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10638 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10639 (match-beginning 1)) a)
10640 t)))
10642 (defun org-complete-expand-structure-template (start cell)
10643 "Expand a structure template."
10644 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10645 (rpl (nth (if musep 2 1) cell))
10646 (ind ""))
10647 (delete-region start (point))
10649 (cond
10650 ((bolp))
10652 (setq ind (buffer-substring (point-at-bol) (point))))
10653 (t (newline))))
10654 (setq start (point))
10655 (if (string-match "%file" rpl)
10656 (setq rpl (replace-match
10657 (concat
10659 (save-match-data
10660 (abbreviate-file-name (read-file-name "Include file: ")))
10662 t t rpl)))
10665 (insert rpl)
10668 ;;;; TODO, DEADLINE, Comments
10670 (defun org-toggle-comment ()
10671 "Change the COMMENT state of an entry."
10672 (interactive)
10673 (save-excursion
10674 (org-back-to-heading)
10675 (let (case-fold-search)
10676 (if (looking-at (concat outline-regexp
10678 (replace-match "" t t nil 1)
10679 (if (looking-at outline-regexp)
10680 (progn
10681 (goto-char (match-end 0))
10682 (insert org-comment-string " ")))))))
10684 (defvar org-last-todo-state-is-todo nil
10685 "This is non-nil when the last TODO state change led to a TODO state.
10686 If the last change removed the TODO tag or switched to DONE, then
10687 this is nil.")
10689 (defvar org-setting-tags nil) ; dynamically skipped
10691 (defvar org-todo-setup-filter-hook nil
10692 "Hook for functions that pre-filter todo specs.
10693 Each function takes a todo spec and returns either nil or the spec
10694 transformed into canonical form." )
10696 (defvar org-todo-get-default-hook nil
10697 "Hook for functions that get a default item for todo.
10698 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10699 nil or a string to be used for the todo mark." )
10701 (defvar org-agenda-headline-snapshot-before-repeat)
10703 (defun org-todo (&optional arg)
10704 "Change the TODO state of an item.
10705 The state of an item is given by a keyword at the start of the heading,
10706 like
10707 *** TODO Write paper
10708 *** DONE Call mom
10710 The different keywords are specified in the variable `org-todo-keywords'.
10712 So for this example: when the item starts with TODO, it is changed to DONE.
10713 When it starts with DONE, the DONE is removed. And when neither TODO nor
10714 DONE are present, add TODO at the beginning of the heading.
10717 state.
10718 With numeric prefix arg, switch to that state.
10720 keywords (nextset).
10723 For calling through lisp, arg is also interpreted in the following way:
10724 'none -> empty state
10726 'done -> switch to DONE
10727 'nextset -> switch to the next set of keywords
10728 'previousset -> switch to the previous set of keywords
10730 really is a member of `org-todo-keywords'."
10731 (interactive "P")
10732 (if (equal arg '(16)) (setq arg 'nextset))
10733 (let ((org-blocker-hook org-blocker-hook)
10734 (case-fold-search nil))
10735 (when (equal arg '(64))
10736 (setq arg nil org-blocker-hook nil))
10737 (when (and org-blocker-hook
10738 (or org-inhibit-blocking
10739 (org-entry-get nil "NOBLOCKING")))
10740 (setq org-blocker-hook nil))
10741 (save-excursion
10742 (catch 'exit
10743 (org-back-to-heading t)
10744 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10746 (looking-at " *"))
10747 (let* ((match-data (match-data))
10748 (startpos (point-at-bol))
10749 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10750 (org-log-done org-log-done)
10751 (org-log-repeat org-log-repeat)
10752 (org-todo-log-states org-todo-log-states)
10753 (this (match-string 1))
10754 (hl-pos (match-beginning 0))
10755 (head (org-get-todo-sequence-head this))
10756 (ass (assoc head org-todo-kwd-alist))
10757 (interpret (nth 1 ass))
10758 (done-word (nth 3 ass))
10759 (final-done-word (nth 4 ass))
10760 (last-state (or this ""))
10761 (completion-ignore-case t)
10762 (member (member this org-todo-keywords-1))
10763 (tail (cdr member))
10764 (state (cond
10765 ((and org-todo-key-trigger
10766 (or (and (equal arg '(4))
10767 (eq org-use-fast-todo-selection 'prefix))
10768 (and (not arg) org-use-fast-todo-selection
10769 (not (eq org-use-fast-todo-selection
10770 'prefix)))))
10771 ;; Use fast selection
10772 (org-fast-todo-selection))
10773 ((and (equal arg '(4))
10774 (or (not org-use-fast-todo-selection)
10775 (not org-todo-key-trigger)))
10776 ;; Read a state with completion
10777 (org-icompleting-read
10778 "State: " (mapcar (lambda(x) (list x))
10779 org-todo-keywords-1)
10780 nil t))
10781 ((eq arg 'right)
10782 (if this
10783 (if tail (car tail) nil)
10784 (car org-todo-keywords-1)))
10785 ((eq arg 'left)
10786 (if (equal member org-todo-keywords-1)
10787 nil
10788 (if this
10789 (nth (- (length org-todo-keywords-1)
10790 (length tail) 2)
10791 org-todo-keywords-1)
10792 (org-last org-todo-keywords-1))))
10793 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10794 (setq arg nil))) ; hack to fall back to cycling
10795 (arg
10796 ;; user or caller requests a specific state
10797 (cond
10798 ((equal arg "") nil)
10799 ((eq arg 'none) nil)
10800 ((eq arg 'done) (or done-word (car org-done-keywords)))
10801 ((eq arg 'nextset)
10802 (or (car (cdr (member head org-todo-heads)))
10803 (car org-todo-heads)))
10804 ((eq arg 'previousset)
10805 (let ((org-todo-heads (reverse org-todo-heads)))
10806 (or (car (cdr (member head org-todo-heads)))
10807 (car org-todo-heads))))
10808 ((car (member arg org-todo-keywords-1)))
10809 ((stringp arg)
10810 (error "State `%s' not valid in this file" arg))
10811 ((nth (1- (prefix-numeric-value arg))
10812 org-todo-keywords-1))))
10813 ((null member) (or head (car org-todo-keywords-1)))
10814 ((equal this final-done-word) nil) ;; -> make empty
10815 ((null tail) nil) ;; -> first entry
10816 ((memq interpret '(type priority))
10817 (if (eq this-command last-command)
10818 (car tail)
10819 (if (> (length tail) 0)
10820 (or done-word (car org-done-keywords))
10821 nil)))
10822 (t
10823 (car tail))))
10824 (state (or
10825 (run-hook-with-args-until-success
10826 'org-todo-get-default-hook state last-state)
10827 state))
10828 (next (if state (concat " " state " ") " "))
10829 (change-plist (list :type 'todo-state-change :from this :to state
10830 :position startpos))
10831 dolog now-done-p)
10832 (when org-blocker-hook
10833 (setq org-last-todo-state-is-todo
10834 (not (member this org-done-keywords)))
10835 (unless (save-excursion
10836 (save-match-data
10837 (run-hook-with-args-until-failure
10838 'org-blocker-hook change-plist)))
10839 (if (interactive-p)
10840 (error "TODO state change from %s to %s blocked" this state)
10841 ;; fail silently
10842 (message "TODO state change from %s to %s blocked" this state)
10843 (throw 'exit nil))))
10844 (store-match-data match-data)
10845 (replace-match next t t)
10846 (unless (pos-visible-in-window-p hl-pos)
10847 (message "TODO state changed to %s" (org-trim next)))
10848 (unless head
10849 (setq head (org-get-todo-sequence-head state)
10850 ass (assoc head org-todo-kwd-alist)
10851 interpret (nth 1 ass)
10852 done-word (nth 3 ass)
10853 final-done-word (nth 4 ass)))
10854 (when (memq arg '(nextset previousset))
10855 (message "Keyword-Set %d/%d: %s"
10856 (- (length org-todo-sets) -1
10857 (length (memq (assoc state org-todo-sets) org-todo-sets)))
10858 (length org-todo-sets)
10859 (mapconcat 'identity (assoc state org-todo-sets) " ")))
10860 (setq org-last-todo-state-is-todo
10861 (not (member state org-done-keywords)))
10862 (setq now-done-p (and (member state org-done-keywords)
10863 (not (member this org-done-keywords))))
10864 (and logging (org-local-logging logging))
10865 (when (and (or org-todo-log-states org-log-done)
10866 (not (eq org-inhibit-logging t))
10867 (not (memq arg '(nextset previousset))))
10868 ;; we need to look at recording a time and note
10869 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
10870 (nth 2 (assoc this org-todo-log-states))))
10871 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
10872 (setq dolog 'time))
10873 (when (and state
10874 (member state org-not-done-keywords)
10875 (not (member this org-not-done-keywords)))
10876 ;; This is now a todo state and was not one before
10877 ;; If there was a CLOSED time stamp, get rid of it.
10878 (org-add-planning-info nil nil 'closed))
10879 (when (and now-done-p org-log-done)
10880 ;; It is now done, and it was not done before
10881 (org-add-planning-info 'closed (org-current-time))
10882 (if (and (not dolog) (eq 'note org-log-done))
10883 (org-add-log-setup 'done state this 'findpos 'note)))
10884 (when (and state dolog)
10885 ;; This is a non-nil state, and we need to log it
10886 (org-add-log-setup 'state state this 'findpos dolog)))
10887 ;; Fixup tag positioning
10888 (org-todo-trigger-tag-changes state)
10889 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
10890 (when org-provide-todo-statistics
10891 (org-update-parent-todo-statistics))
10892 (run-hooks 'org-after-todo-state-change-hook)
10893 (if (and arg (not (member state org-done-keywords)))
10894 (setq head (org-get-todo-sequence-head state)))
10895 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
10896 ;; Do we need to trigger a repeat?
10897 (when now-done-p
10898 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
10899 ;; This is for the agenda, take a snapshot of the headline.
10900 (save-match-data
10901 (setq org-agenda-headline-snapshot-before-repeat
10902 (org-get-heading))))
10903 (org-auto-repeat-maybe state))
10904 ;; Fixup cursor location if close to the keyword
10905 (if (and (outline-on-heading-p)
10906 (not (bolp))
10907 (save-excursion (beginning-of-line 1)
10908 (looking-at org-todo-line-regexp))
10909 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
10910 (progn
10911 (goto-char (or (match-end 2) (match-end 1)))
10912 (and (looking-at " ") (just-one-space))))
10913 (when org-trigger-hook
10914 (save-excursion
10915 (run-hook-with-args 'org-trigger-hook change-plist))))))))
10917 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
10918 "Block turning an entry into a TODO, using the hierarchy.
10919 This checks whether the current task should be blocked from state
10920 changes. Such blocking occurs when:
10922 1. The task has children which are not all in a completed state.
10924 2. A task has a parent with the property :ORDERED:, and there
10925 are siblings prior to the current task with incomplete
10926 status.
10928 3. The parent of the task is blocked because it has siblings that should
10929 be done first, or is child of a block grandparent TODO entry."
10931 (if (not org-enforce-todo-dependencies)
10932 t ; if locally turned off don't block
10933 (catch 'dont-block
10934 ;; If this is not a todo state change, or if this entry is already DONE,
10935 ;; do not block
10936 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
10937 (member (plist-get change-plist :from)
10938 (cons 'done org-done-keywords))
10939 (member (plist-get change-plist :to)
10940 (cons 'todo org-not-done-keywords))
10941 (not (plist-get change-plist :to)))
10942 (throw 'dont-block t))
10943 ;; If this task has children, and any are undone, it's blocked
10944 (save-excursion
10945 (org-back-to-heading t)
10946 (let ((this-level (funcall outline-level)))
10947 (outline-next-heading)
10948 (let ((child-level (funcall outline-level)))
10949 (while (and (not (eobp))
10950 (> child-level this-level))
10951 ;; this todo has children, check whether they are all
10952 ;; completed
10953 (if (and (not (org-entry-is-done-p))
10954 (org-entry-is-todo-p))
10955 (throw 'dont-block nil))
10956 (outline-next-heading)
10957 (setq child-level (funcall outline-level))))))
10958 ;; Otherwise, if the task's parent has the :ORDERED: property, and
10959 ;; any previous siblings are undone, it's blocked
10960 (save-excursion
10961 (org-back-to-heading t)
10962 (let* ((pos (point))
10963 (parent-pos (and (org-up-heading-safe) (point))))
10964 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10965 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
10966 (forward-line 1)
10967 (re-search-forward org-not-done-heading-regexp pos t))
10968 (throw 'dont-block nil)) ; block, there is an older sibling not done.
10969 ;; Search further up the hierarchy, to see if an anchestor is blocked
10970 (while t
10971 (goto-char parent-pos)
10972 (if (not (looking-at org-not-done-heading-regexp))
10973 (throw 'dont-block t)) ; do not block, parent is not a TODO
10974 (setq pos (point))
10975 (setq parent-pos (and (org-up-heading-safe) (point)))
10976 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10977 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
10978 (forward-line 1)
10979 (re-search-forward org-not-done-heading-regexp pos t))
10980 (throw 'dont-block nil)))))))) ; block, older sibling not done.
10982 (defcustom org-track-ordered-property-with-tag nil
10983 "Should the ORDERED property also be shown as a tag?
10984 The ORDERED property decides if an entry should require subtasks to be
10985 completed in sequence. Since a property is not very visible, setting
10986 this option means that toggling the ORDERED property with the command
10987 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
10988 not relevant for the behavior, but it makes things more visible.
10990 Note that toggling the tag with tags commands will not change the property
10991 and therefore not influence behavior!
10993 This can be t, meaning the tag ORDERED should be used, It can also be a
10994 string to select a different tag for this task."
10995 :group 'org-todo
10996 :type '(choice
10997 (const :tag "No tracking" nil)
10998 (const :tag "Track with ORDERED tag" t)
10999 (string :tag "Use other tag")))
11001 (defun org-toggle-ordered-property ()
11002 "Toggle the ORDERED property of the current entry.
11003 For better visibility, you can track the value of this property with a tag.
11004 See variable `org-track-ordered-property-with-tag'."
11005 (interactive)
11006 (let* ((t1 org-track-ordered-property-with-tag)
11007 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11008 (save-excursion
11009 (org-back-to-heading)
11010 (if (org-entry-get nil "ORDERED")
11011 (progn
11012 (org-delete-property "ORDERED")
11013 (and tag (org-toggle-tag tag 'off))
11014 (message "Subtasks can be completed in arbitrary order"))
11015 (org-entry-put nil "ORDERED" "t")
11016 (and tag (org-toggle-tag tag 'on))
11017 (message "Subtasks must be completed in sequence")))))
11019 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11020 (defun org-block-todo-from-checkboxes (change-plist)
11021 "Block turning an entry into a TODO, using checkboxes.
11022 This checks whether the current task should be blocked from state
11023 changes because there are unchecked boxes in this entry."
11024 (if (not org-enforce-todo-checkbox-dependencies)
11025 t ; if locally turned off don't block
11026 (catch 'dont-block
11027 ;; If this is not a todo state change, or if this entry is already DONE,
11028 ;; do not block
11029 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11030 (member (plist-get change-plist :from)
11031 (cons 'done org-done-keywords))
11032 (member (plist-get change-plist :to)
11033 (cons 'todo org-not-done-keywords))
11034 (not (plist-get change-plist :to)))
11035 (throw 'dont-block t))
11036 ;; If this task has checkboxes that are not checked, it's blocked
11037 (save-excursion
11038 (org-back-to-heading t)
11039 (let ((beg (point)) end)
11040 (outline-next-heading)
11041 (setq end (point))
11042 (goto-char beg)
11044 end t)
11045 (progn
11046 (if (boundp 'org-blocked-by-checkboxes)
11047 (setq org-blocked-by-checkboxes t))
11048 (throw 'dont-block nil)))))
11049 t))) ; do not block
11051 (defun org-entry-blocked-p ()
11052 "Is the current entry blocked?"
11053 (if (org-entry-get nil "NOBLOCKING")
11054 nil ;; Never block this entry
11055 (not
11056 (run-hook-with-args-until-failure
11057 'org-blocker-hook
11058 (list :type 'todo-state-change
11059 :position (point)
11060 :from 'todo
11061 :to 'done)))))
11063 (defun org-update-statistics-cookies (all)
11064 "Update the statistics cookie, either from TODO or from checkboxes.
11065 This should be called with the cursor in a line with a statistics cookie."
11066 (interactive "P")
11067 (if all
11068 (progn
11069 (org-update-checkbox-count 'all)
11070 (org-map-entries 'org-update-parent-todo-statistics))
11071 (if (not (org-on-heading-p))
11072 (org-update-checkbox-count)
11073 (let ((pos (move-marker (make-marker) (point)))
11074 end l1 l2)
11075 (ignore-errors (org-back-to-heading t))
11076 (if (not (org-on-heading-p))
11077 (org-update-checkbox-count)
11078 (setq l1 (org-outline-level))
11079 (setq end (save-excursion
11080 (outline-next-heading)
11081 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11082 (point)))
11083 (if (and (save-excursion
11084 (re-search-forward
11086 (not (save-excursion (re-search-forward
11088 (org-update-checkbox-count)
11089 (if (and l2 (> l2 l1))
11090 (progn
11091 (goto-char end)
11092 (org-update-parent-todo-statistics))
11093 (goto-char pos)
11094 (beginning-of-line 1)
11095 (while (re-search-forward
11097 (point-at-eol) t)
11098 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11099 (goto-char pos)
11100 (move-marker pos nil)))))
11102 (defvar org-entry-property-inherited-from) ;; defined below
11103 (defun org-update-parent-todo-statistics ()
11104 "Update any statistics cookie in the parent of the current headline.
11105 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11106 the entire subtree and this will travel up the hierarchy and update
11107 statistics everywhere."
11108 (interactive)
11109 (let* ((lim 0) prop
11110 (recursive (or (not org-hierarchical-todo-statistics)
11111 (string-match
11113 (or (setq prop (org-entry-get
11114 nil "COOKIE_DATA" 'inherit)) ""))))
11115 (lim (or (and prop (marker-position
11116 org-entry-property-inherited-from))
11117 lim))
11118 (first t)
11120 level ltoggle l1 new ndel
11121 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
11122 (catch 'exit
11123 (save-excursion
11124 (beginning-of-line 1)
11125 (if (org-at-heading-p)
11126 (setq ltoggle (funcall outline-level))
11127 (error "This should not happen"))
11128 (while (and (setq level (org-up-heading-safe))
11129 (or recursive first)
11130 (>= (point) lim))
11131 (setq first nil cookie-present nil)
11132 (unless (and level
11133 (not (string-match
11135 (downcase
11136 (or (org-entry-get
11137 nil "COOKIE_DATA")
11138 "")))))
11139 (throw 'exit nil))
11140 (while (re-search-forward box-re (point-at-eol) t)
11141 (setq cnt-all 0 cnt-done 0 cookie-present t)
11142 (setq is-percent (match-end 2))
11143 (save-match-data
11144 (unless (outline-next-heading) (throw 'exit nil))
11145 (while (and (looking-at org-complex-heading-regexp)
11146 (> (setq l1 (length (match-string 1))) level))
11147 (setq kwd (and (or recursive (= l1 ltoggle))
11148 (match-string 2)))
11149 (if (or (eq org-provide-todo-statistics 'all-headlines)
11150 (and (listp org-provide-todo-statistics)
11151 (or (member kwd org-provide-todo-statistics)
11152 (member kwd org-done-keywords))))
11153 (setq cnt-all (1+ cnt-all))
11154 (if (eq org-provide-todo-statistics t)
11155 (and kwd (setq cnt-all (1+ cnt-all)))))
11156 (and (member kwd org-done-keywords)
11157 (setq cnt-done (1+ cnt-done)))
11158 (outline-next-heading)))
11159 (setq new
11160 (if is-percent
11161 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11162 (format "[%d/%d]" cnt-done cnt-all))
11163 ndel (- (match-end 0) (match-beginning 0)))
11164 (goto-char (match-beginning 0))
11165 (insert new)
11166 (delete-region (point) (+ (point) ndel)))
11167 (when cookie-present
11168 (run-hook-with-args 'org-after-todo-statistics-hook
11169 cnt-done (- cnt-all cnt-done))))))
11170 (run-hooks 'org-todo-statistics-hook)))
11172 (defvar org-after-todo-statistics-hook nil
11173 "Hook that is called after a TODO statistics cookie has been updated.
11174 Each function is called with two arguments: the number of not-done entries
11175 and the number of done entries.
11177 For example, the following function, when added to this hook, will switch
11178 an entry to DONE when all children are done, and back to TODO when new
11179 entries are set to a TODO status. Note that this hook is only called
11180 when there is a statistics cookie in the headline!
11182 (defun org-summary-todo (n-done n-not-done)
11184 (let (org-log-done org-log-states) ; turn off logging
11186 ")
11188 (defvar org-todo-statistics-hook nil
11189 "Hook that is run whenever Org thinks TODO statistics should be updated.
11190 This hook runs even if there is no statistics cookie present, in which case
11191 `org-after-todo-statistics-hook' would not run.")
11193 (defun org-todo-trigger-tag-changes (state)
11194 "Apply the changes defined in `org-todo-state-tags-triggers'."
11195 (let ((l org-todo-state-tags-triggers)
11196 changes)
11197 (when (or (not state) (equal state ""))
11198 (setq changes (append changes (cdr (assoc "" l)))))
11199 (when (and (stringp state) (> (length state) 0))
11200 (setq changes (append changes (cdr (assoc state l)))))
11201 (when (member state org-not-done-keywords)
11202 (setq changes (append changes (cdr (assoc 'todo l)))))
11203 (when (member state org-done-keywords)
11204 (setq changes (append changes (cdr (assoc 'done l)))))
11205 (dolist (c changes)
11206 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11208 (defun org-local-logging (value)
11209 "Get logging settings from a property VALUE."
11210 (let* (words w a)
11211 ;; directly set the variables, they are already local.
11212 (setq org-log-done nil
11213 org-log-repeat nil
11214 org-todo-log-states nil)
11215 (setq words (org-split-string value))
11216 (while (setq w (pop words))
11217 (cond
11218 ((setq a (assoc w org-startup-options))
11219 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11220 (set (nth 1 a) (nth 2 a))))
11221 ((setq a (org-extract-log-state-settings w))
11222 (and (member (car a) org-todo-keywords-1)
11223 (push a org-todo-log-states)))))))
11225 (defun org-get-todo-sequence-head (kwd)
11226 "Return the head of the TODO sequence to which KWD belongs.
11227 If KWD is not set, check if there is a text property remembering the
11228 right sequence."
11229 (let (p)
11230 (cond
11231 ((not kwd)
11232 (or (get-text-property (point-at-bol) 'org-todo-head)
11233 (progn
11234 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11235 nil (point-at-eol)))
11236 (get-text-property p 'org-todo-head))))
11237 ((not (member kwd org-todo-keywords-1))
11238 (car org-todo-keywords-1))
11239 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11241 (defun org-fast-todo-selection ()
11242 "Fast TODO keyword selection with single keys.
11243 Returns the new TODO keyword, or nil if no state change should occur."
11244 (let* ((fulltable org-todo-key-alist)
11245 (done-keywords org-done-keywords) ;; needed for the faces.
11246 (maxlen (apply 'max (mapcar
11247 (lambda (x)
11248 (if (stringp (car x)) (string-width (car x)) 0))
11249 fulltable)))
11250 (expert nil)
11251 (fwidth (+ maxlen 3 1 3))
11252 (ncol (/ (- (window-width) 4) fwidth))
11253 tg cnt e c tbl
11254 groups ingroup)
11255 (save-excursion
11256 (save-window-excursion
11257 (if expert
11258 (set-buffer (get-buffer-create " *Org todo*"))
11259 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11260 (erase-buffer)
11261 (org-set-local 'org-done-keywords done-keywords)
11262 (setq tbl fulltable cnt 0)
11263 (while (setq e (pop tbl))
11264 (cond
11265 ((equal e '(:startgroup))
11266 (push '() groups) (setq ingroup t)
11267 (when (not (= cnt 0))
11268 (setq cnt 0)
11270 (insert "{ "))
11271 ((equal e '(:endgroup))
11272 (setq ingroup nil cnt 0)
11274 ((equal e '(:newline))
11275 (when (not (= cnt 0))
11276 (setq cnt 0)
11278 (setq e (car tbl))
11279 (while (equal (car tbl) '(:newline))
11281 (setq tbl (cdr tbl)))))
11282 (t
11283 (setq tg (car e) c (cdr e))
11284 (if ingroup (push tg (car groups)))
11285 (setq tg (org-add-props tg nil 'face
11286 (org-get-todo-face tg)))
11287 (if (and (= cnt 0) (not ingroup)) (insert " "))
11288 (insert "[" c "] " tg (make-string
11289 (- fwidth 4 (length tg)) ?\ ))
11290 (when (= (setq cnt (1+ cnt)) ncol)
11292 (if ingroup (insert " "))
11293 (setq cnt 0)))))
11295 (goto-char (point-min))
11296 (if (not expert) (org-fit-window-to-buffer))
11297 (message "[a-z..]:Set [SPC]:clear")
11298 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11299 (cond
11300 ((or (= c ?\C-g)
11301 (and (= c ?q) (not (rassoc c fulltable))))
11302 (setq quit-flag t))
11303 ((= c ?\ ) nil)
11304 ((setq e (rassoc c fulltable) tg (car e))
11305 tg)
11306 (t (setq quit-flag t)))))))
11308 (defun org-entry-is-todo-p ()
11309 (member (org-get-todo-state) org-not-done-keywords))
11311 (defun org-entry-is-done-p ()
11312 (member (org-get-todo-state) org-done-keywords))
11314 (defun org-get-todo-state ()
11315 (save-excursion
11316 (org-back-to-heading t)
11317 (and (looking-at org-todo-line-regexp)
11318 (match-end 2)
11319 (match-string 2))))
11321 (defun org-at-date-range-p (&optional inactive-ok)
11322 "Is the cursor inside a date range?"
11323 (interactive)
11324 (save-excursion
11325 (catch 'exit
11326 (let ((pos (point)))
11328 (skip-chars-backward "<[")
11329 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11330 (>= (match-end 0) pos)
11331 (throw 'exit t))
11333 (skip-chars-backward "<[")
11334 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11335 (>= (match-end 0) pos)
11336 (throw 'exit t)))
11337 nil)))
11339 (defun org-get-repeat (&optional tagline)
11340 "Check if there is a deadline/schedule with repeater in this entry."
11341 (save-match-data
11342 (save-excursion
11343 (org-back-to-heading t)
11344 (and (re-search-forward (if tagline
11346 org-repeat-re)
11347 (org-entry-end-position) t)
11348 (match-string-no-properties 1)))))
11350 (defvar org-last-changed-timestamp)
11351 (defvar org-last-inserted-timestamp)
11352 (defvar org-log-post-message)
11353 (defvar org-log-note-purpose)
11354 (defvar org-log-note-how)
11355 (defvar org-log-note-extra)
11356 (defun org-auto-repeat-maybe (done-word)
11357 "Check if the current headline contains a repeated deadline/schedule.
11358 If yes, set TODO state back to what it was and change the base date
11359 of repeating deadline/scheduled time stamps to new date.
11360 This function is run automatically after each state change to a DONE state."
11361 ;; last-state is dynamically scoped into this function
11362 (let* ((repeat (org-get-repeat))
11363 (aa (assoc last-state org-todo-kwd-alist))
11364 (interpret (nth 1 aa))
11365 (head (nth 2 aa))
11366 (whata '(("d" . day) ("m" . month) ("y" . year)))
11367 (msg "Entry repeats: ")
11368 (org-log-done nil)
11369 (org-todo-log-states nil)
11370 re type n what ts time to-state)
11371 (when repeat
11372 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11373 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11374 org-todo-repeat-to-state))
11375 (unless (and to-state (member to-state org-todo-keywords-1))
11376 (setq to-state (if (eq interpret 'type) last-state head)))
11377 (org-todo to-state)
11378 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11379 (org-entry-put nil "LAST_REPEAT" (format-time-string
11380 (org-time-stamp-format t t))))
11381 (when org-log-repeat
11382 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11383 (memq 'org-add-log-note post-command-hook))
11384 ;; OK, we are already setup for some record
11385 (if (eq org-log-repeat 'note)
11386 ;; make sure we take a note, not only a time stamp
11387 (setq org-log-note-how 'note))
11388 ;; Set up for taking a record
11389 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11390 last-state
11391 'findpos org-log-repeat)))
11392 (org-back-to-heading t)
11393 (org-add-planning-info nil nil 'closed)
11397 (while (re-search-forward
11398 re (save-excursion (outline-next-heading) (point)) t)
11399 (setq type (if (match-end 1) org-scheduled-string
11400 (if (match-end 3) org-deadline-string "Plain:"))
11401 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11403 (setq n (string-to-number (match-string 2 ts))
11404 what (match-string 3 ts))
11405 (if (equal what "w") (setq n (* n 7) what "d"))
11406 ;; Preparation, see if we need to modify the start date for the change
11407 (when (match-end 1)
11408 (setq time (save-match-data (org-time-string-to-time ts)))
11409 (cond
11410 ((equal (match-string 1 ts) ".")
11411 ;; Shift starting date to today
11412 (org-timestamp-change
11413 (- (time-to-days (current-time)) (time-to-days time))
11414 'day))
11415 ((equal (match-string 1 ts) "+")
11416 (let ((nshiftmax 10) (nshift 0))
11417 (while (or (= nshift 0)
11418 (<= (time-to-days time)
11419 (time-to-days (current-time))))
11420 (when (= (incf nshift) nshiftmax)
11421 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11422 (error "Abort")))
11423 (org-timestamp-change n (cdr (assoc what whata)))
11424 (org-at-timestamp-p t)
11425 (setq ts (match-string 1))
11426 (setq time (save-match-data (org-time-string-to-time ts)))))
11427 (org-timestamp-change (- n) (cdr (assoc what whata)))
11428 ;; rematch, so that we have everything in place for the real shift
11429 (org-at-timestamp-p t)
11430 (setq ts (match-string 1))
11432 (org-timestamp-change n (cdr (assoc what whata)))
11433 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11434 (setq org-log-post-message msg)
11435 (message "%s" msg))))
11437 (defun org-show-todo-tree (arg)
11438 "Make a compact tree which shows all headlines marked with TODO.
11439 The tree will show the lines where the regexp matches, and all higher
11440 headlines above the match.
11442 With a numeric prefix N, construct a sparse tree for the Nth element
11443 of `org-todo-keywords-1'."
11444 (interactive "P")
11445 (let ((case-fold-search nil)
11446 (kwd-re
11447 (cond ((null arg) org-not-done-regexp)
11448 ((equal arg '(4))
11449 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11450 (mapcar 'list org-todo-keywords-1))))
11454 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11455 (regexp-quote (nth (1- (prefix-numeric-value arg))
11456 org-todo-keywords-1)))
11457 (t (error "Invalid prefix argument: %s" arg)))))
11458 (message "%d TODO entries found"
11459 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
11461 (defun org-deadline (&optional remove time)
11463 With argument REMOVE, remove any deadline from the item.
11464 When TIME is set, it should be an internal time specification, and the
11465 scheduling will use the corresponding date."
11466 (interactive "P")
11467 (let* ((old-date (org-entry-get nil "DEADLINE"))
11468 (repeater (and old-date
11470 (match-string 1 old-date))))
11471 (if remove
11472 (progn
11473 (when (and old-date org-log-redeadline)
11474 (org-add-log-setup 'deldeadline nil old-date 'findpos
11475 org-log-redeadline))
11476 (org-remove-timestamp-with-keyword org-deadline-string)
11477 (message "Item no longer has a deadline."))
11478 (org-add-planning-info 'deadline time 'closed)
11479 (when (and old-date org-log-redeadline
11480 (not (equal old-date
11481 (substring org-last-inserted-timestamp 1 -1))))
11482 (org-add-log-setup 'redeadline nil old-date 'findpos
11483 org-log-redeadline))
11484 (when repeater
11485 (save-excursion
11486 (org-back-to-heading t)
11487 (when (re-search-forward (concat org-deadline-string " "
11488 org-last-inserted-timestamp)
11489 (save-excursion
11490 (outline-next-heading) (point)) t)
11491 (goto-char (1- (match-end 0)))
11492 (insert " " repeater)
11493 (setq org-last-inserted-timestamp
11494 (concat (substring org-last-inserted-timestamp 0 -1)
11495 " " repeater
11496 (substring org-last-inserted-timestamp -1))))))
11497 (message "Deadline on %s" org-last-inserted-timestamp))))
11499 (defun org-schedule (&optional remove time)
11500 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11501 With argument REMOVE, remove any scheduling date from the item.
11502 When TIME is set, it should be an internal time specification, and the
11503 scheduling will use the corresponding date."
11504 (interactive "P")
11505 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11506 (repeater (and old-date
11508 (match-string 1 old-date))))
11509 (if remove
11510 (progn
11511 (when (and old-date org-log-reschedule)
11512 (org-add-log-setup 'delschedule nil old-date 'findpos
11513 org-log-reschedule))
11514 (org-remove-timestamp-with-keyword org-scheduled-string)
11515 (message "Item is no longer scheduled."))
11516 (org-add-planning-info 'scheduled time 'closed)
11517 (when (and old-date org-log-reschedule
11518 (not (equal old-date
11519 (substring org-last-inserted-timestamp 1 -1))))
11520 (org-add-log-setup 'reschedule nil old-date 'findpos
11521 org-log-reschedule))
11522 (when repeater
11523 (save-excursion
11524 (org-back-to-heading t)
11525 (when (re-search-forward (concat org-scheduled-string " "
11526 org-last-inserted-timestamp)
11527 (save-excursion
11528 (outline-next-heading) (point)) t)
11529 (goto-char (1- (match-end 0)))
11530 (insert " " repeater)
11531 (setq org-last-inserted-timestamp
11532 (concat (substring org-last-inserted-timestamp 0 -1)
11533 " " repeater
11534 (substring org-last-inserted-timestamp -1))))))
11535 (message "Scheduled to %s" org-last-inserted-timestamp))))
11537 (defun org-get-scheduled-time (pom &optional inherit)
11538 "Get the scheduled time as a time tuple, of a format suitable
11539 for calling org-schedule with, or if there is no scheduling,
11540 returns nil."
11541 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11542 (when time
11543 (apply 'encode-time (org-parse-time-string time)))))
11545 (defun org-get-deadline-time (pom &optional inherit)
11546 "Get the deadline as a time tuple, of a format suitable for
11547 calling org-deadline with, or if there is no scheduling, returns
11548 nil."
11549 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11550 (when time
11551 (apply 'encode-time (org-parse-time-string time)))))
11553 (defun org-remove-timestamp-with-keyword (keyword)
11554 "Remove all time stamps with KEYWORD in the current entry."
11556 beg)
11557 (save-excursion
11558 (org-back-to-heading t)
11559 (setq beg (point))
11560 (outline-next-heading)
11561 (while (re-search-backward re beg t)
11562 (replace-match "")
11564 (equal (char-before) ?\ ))
11565 (backward-delete-char 1)
11567 (point-at-bol) (point-at-eol)))
11568 (delete-region (point-at-bol)
11569 (min (point-max) (1+ (point-at-eol))))))))))
11571 (defun org-add-planning-info (what &optional time &rest remove)
11572 "Insert new timestamp with keyword in the line directly after the headline.
11573 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11574 If non is given, the user is prompted for a date.
11575 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11576 be removed."
11577 (interactive)
11578 (let (org-time-was-given org-end-time-was-given ts
11579 end default-time default-input)
11581 (catch 'exit
11582 (when (and (not time) (memq what '(scheduled deadline)))
11583 ;; Try to get a default date/time from existing timestamp
11584 (save-excursion
11585 (org-back-to-heading t)
11586 (setq end (save-excursion (outline-next-heading) (point)))
11587 (when (re-search-forward (if (eq what 'scheduled)
11588 org-scheduled-time-regexp
11589 org-deadline-time-regexp)
11590 end t)
11591 (setq ts (match-string 1)
11592 default-time
11593 (apply 'encode-time (org-parse-time-string ts))
11594 default-input (and ts (org-get-compact-tod ts))))))
11595 (when what
11596 ;; If necessary, get the time from the user
11597 (setq time (or time (org-read-date nil 'to-time nil nil
11598 default-time default-input))))
11600 (when (and org-insert-labeled-timestamps-at-point
11601 (member what '(scheduled deadline)))
11602 (insert
11603 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11604 (org-insert-time-stamp time org-time-was-given
11605 nil nil nil (list org-end-time-was-given))
11606 (setq what nil))
11607 (save-excursion
11608 (save-restriction
11609 (let (col list elt ts buffer-invisibility-spec)
11610 (org-back-to-heading t)
11612 (goto-char (match-end 1))
11613 (setq col (current-column))
11614 (goto-char (match-end 0))
11616 (when (and (not what)
11617 (not (looking-at
11619 org-keyword-time-not-clock-regexp))))
11620 ;; Nothing to add, nothing to remove...... :-)
11621 (throw 'exit nil))
11622 (if (and (not (looking-at outline-regexp))
11625 (not (equal (match-string 1) org-clock-string)))
11626 (narrow-to-region (match-beginning 0) (match-end 0))
11628 (backward-char 1)
11629 (narrow-to-region (point) (point))
11630 (and org-adapt-indentation (org-indent-to-column col)))
11631 ;; Check if we have to remove something.
11632 (setq list (cons what remove))
11633 (while list
11634 (setq elt (pop list))
11635 (goto-char (point-min))
11636 (when (or (and (eq elt 'scheduled)
11637 (re-search-forward org-scheduled-time-regexp nil t))
11638 (and (eq elt 'deadline)
11639 (re-search-forward org-deadline-time-regexp nil t))
11640 (and (eq elt 'closed)
11641 (re-search-forward org-closed-time-regexp nil t)))
11642 (replace-match "")
11643 (if (looking-at "--+<[^>]+>") (replace-match ""))
11644 (skip-chars-backward " ")
11645 (if (looking-at " +") (replace-match ""))))
11646 (goto-char (point-max))
11647 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11648 (when what
11649 (insert
11650 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11651 (cond ((eq what 'scheduled) org-scheduled-string)
11652 ((eq what 'deadline) org-deadline-string)
11653 ((eq what 'closed) org-closed-string))
11654 " ")
11655 (setq ts (org-insert-time-stamp
11656 time
11657 (or org-time-was-given
11658 (and (eq what 'closed) org-log-done-with-time))
11659 (eq what 'closed)
11660 nil nil (list org-end-time-was-given)))
11661 (end-of-line 1))
11662 (goto-char (point-min))
11663 (widen)
11666 (delete-region (1- (point)) (point-at-eol)))
11667 ts))))))
11669 (defvar org-log-note-marker (make-marker))
11670 (defvar org-log-note-purpose nil)
11671 (defvar org-log-note-state nil)
11672 (defvar org-log-note-previous-state nil)
11673 (defvar org-log-note-how nil)
11674 (defvar org-log-note-extra nil)
11675 (defvar org-log-note-window-configuration nil)
11676 (defvar org-log-note-return-to (make-marker))
11677 (defvar org-log-post-message nil
11678 "Message to be displayed after a log note has been stored.
11679 The auto-repeater uses this.")
11681 (defun org-add-note ()
11682 "Add a note to the current entry.
11683 This is done in the same way as adding a state change note."
11684 (interactive)
11685 (org-add-log-setup 'note nil nil 'findpos nil))
11687 (defvar org-property-end-re)
11688 (defun org-add-log-setup (&optional purpose state prev-state
11689 findpos how extra)
11690 "Set up the post command hook to take a note.
11691 If this is about to TODO state change, the new state is expected in STATE.
11692 When FINDPOS is non-nil, find the correct position for the note in
11693 the current entry. If not, assume that it can be inserted at point.
11694 HOW is an indicator what kind of note should be created.
11695 EXTRA is additional text that will be inserted into the notes buffer."
11696 (let* ((org-log-into-drawer (org-log-into-drawer))
11697 (drawer (cond ((stringp org-log-into-drawer)
11698 org-log-into-drawer)
11699 (org-log-into-drawer "LOGBOOK")
11700 (t nil))))
11701 (save-restriction
11702 (save-excursion
11703 (when findpos
11704 (org-back-to-heading t)
11705 (narrow-to-region (point) (save-excursion
11706 (outline-next-heading) (point)))
11710 (goto-char (match-end 0))
11711 (cond
11712 (drawer
11714 nil t)
11715 (progn
11716 (goto-char (match-end 0))
11717 (or org-log-states-order-reversed
11718 (and (re-search-forward org-property-end-re nil t)
11719 (goto-char (1- (match-beginning 0))))))
11721 (beginning-of-line 0)
11722 (org-indent-line-function)
11723 (beginning-of-line 2)
11724 (org-indent-line-function)
11725 (end-of-line 0)))
11726 ((and org-log-state-notes-insert-after-drawers
11727 (save-excursion
11728 (forward-line) (looking-at org-drawer-regexp)))
11729 (forward-line)
11730 (while (looking-at org-drawer-regexp)
11731 (goto-char (match-end 0))
11732 (re-search-forward org-property-end-re (point-max) t)
11733 (forward-line))
11734 (forward-line -1)))
11735 (unless org-log-states-order-reversed
11737 (org-skip-over-state-notes)
11739 (move-marker org-log-note-marker (point))
11740 (setq org-log-note-purpose purpose
11741 org-log-note-state state
11742 org-log-note-previous-state prev-state
11743 org-log-note-how how
11744 org-log-note-extra extra)
11745 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11747 (defun org-skip-over-state-notes ()
11748 "Skip past the list of State notes in an entry."
11750 (when (org-in-item-p)
11751 (let ((limit (org-list-bottom-point)))
11753 (goto-char (or (org-get-next-item (point) limit)
11754 (org-get-end-of-item limit)))))))
11756 (defun org-add-log-note (&optional purpose)
11757 "Pop up a window for taking a note, and add this note later at point."
11758 (remove-hook 'post-command-hook 'org-add-log-note)
11759 (setq org-log-note-window-configuration (current-window-configuration))
11760 (delete-other-windows)
11761 (move-marker org-log-note-return-to (point))
11762 (switch-to-buffer (marker-buffer org-log-note-marker))
11763 (goto-char org-log-note-marker)
11764 (org-switch-to-buffer-other-window "*Org Note*")
11765 (erase-buffer)
11766 (if (memq org-log-note-how '(time state))
11767 (let (current-prefix-arg) (org-store-log-note))
11768 (let ((org-inhibit-startup t)) (org-mode))
11769 (insert (format "# Insert note for %s.
11771 (cond
11772 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11773 ((eq org-log-note-purpose 'done) "closed todo item")
11774 ((eq org-log-note-purpose 'state)
11776 (or org-log-note-previous-state "")
11777 (or org-log-note-state "")))
11778 ((eq org-log-note-purpose 'reschedule)
11779 "rescheduling")
11780 ((eq org-log-note-purpose 'delschedule)
11781 "no longer scheduled")
11782 ((eq org-log-note-purpose 'redeadline)
11783 "changing deadline")
11784 ((eq org-log-note-purpose 'deldeadline)
11785 "removing deadline")
11786 ((eq org-log-note-purpose 'refile)
11787 "refiling")
11788 ((eq org-log-note-purpose 'note)
11789 "this entry")
11790 (t (error "This should not happen")))))
11791 (if org-log-note-extra (insert org-log-note-extra))
11792 (org-set-local 'org-finish-function 'org-store-log-note)))
11794 (defvar org-note-abort nil) ; dynamically scoped
11795 (defun org-store-log-note ()
11796 "Finish taking a log note, and insert it to where it belongs."
11797 (let ((txt (buffer-string))
11798 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11799 lines ind bul)
11800 (kill-buffer (current-buffer))
11802 (setq txt (replace-match "" t t txt)))
11804 (setq txt (replace-match "" t t txt)))
11807 (setq note
11808 (org-replace-escapes
11809 note
11810 (list (cons "%u" (user-login-name))
11811 (cons "%U" user-full-name)
11812 (cons "%t" (format-time-string
11813 (org-time-stamp-format 'long 'inactive)
11814 (current-time)))
11815 (cons "%T" (format-time-string
11816 (org-time-stamp-format 'long nil)
11817 (current-time)))
11818 (cons "%s" (if org-log-note-state
11820 ""))
11821 (cons "%S" (if org-log-note-previous-state
11825 (push note lines))
11826 (when (or current-prefix-arg org-note-abort)
11827 (when org-log-into-drawer
11828 (org-remove-empty-drawer-at
11829 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11830 org-log-note-marker))
11831 (setq lines nil))
11832 (when lines
11833 (with-current-buffer (marker-buffer org-log-note-marker)
11834 (save-excursion
11835 (goto-char org-log-note-marker)
11836 (move-marker org-log-note-marker nil)
11837 (end-of-line 1)
11839 (setq ind (save-excursion
11840 (if (org-in-item-p)
11841 (progn
11842 (goto-char (org-list-top-point))
11843 (org-get-indentation))
11845 (cond
11846 ((and (org-at-heading-p)
11847 org-adapt-indentation)
11848 (1+ (org-current-level)))
11849 ((org-at-heading-p) 0)
11850 (t (org-get-indentation))))))
11851 (setq bul (org-list-bullet-string "-"))
11852 (org-indent-line-to ind)
11853 (insert bul (pop lines))
11854 (let ((ind-body (+ (length bul) ind)))
11855 (while lines
11857 (org-indent-line-to ind-body)
11858 (insert (pop lines))))
11859 (message "Note stored")
11860 (org-back-to-heading t)
11861 (org-cycle-hide-drawers 'children)))))
11862 (set-window-configuration org-log-note-window-configuration)
11863 (with-current-buffer (marker-buffer org-log-note-return-to)
11864 (goto-char org-log-note-return-to))
11865 (move-marker org-log-note-return-to nil)
11866 (and org-log-post-message (message "%s" org-log-post-message)))
11868 (defun org-remove-empty-drawer-at (drawer pos)
11869 "Remove an empty drawer DRAWER at position POS.
11870 POS may also be a marker."
11871 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
11872 (save-excursion
11873 (save-restriction
11874 (widen)
11875 (goto-char pos)
11876 (if (org-in-regexp
11878 (replace-match ""))))))
11880 (defun org-sparse-tree (&optional arg)
11881 "Create a sparse tree, prompt for the details.
11882 This command can create sparse trees. You first need to select the type
11883 of match used to create the tree:
11885 t Show all TODO entries.
11886 T Show entries with a specific TODO keyword.
11887 m Show entries selected by a tags/property match.
11888 p Enter a property name and its value (both with completion on existing
11889 names/values) and show entries with that property.
11890 r Show entries matching a regular expression (`/' can be used as well)
11891 d Show deadlines due within `org-deadline-warning-days'.
11892 b Show deadlines and scheduled items before a date.
11893 a Show deadlines and scheduled items after a date."
11894 (interactive "P")
11895 (let (ans kwd value)
11896 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
11897 (setq ans (read-char-exclusive))
11898 (cond
11899 ((equal ans ?d)
11900 (call-interactively 'org-check-deadlines))
11901 ((equal ans ?b)
11902 (call-interactively 'org-check-before-date))
11903 ((equal ans ?a)
11904 (call-interactively 'org-check-after-date))
11905 ((equal ans ?t)
11906 (org-show-todo-tree nil))
11907 ((equal ans ?T)
11908 (org-show-todo-tree '(4)))
11909 ((member ans '(?T ?m))
11910 (call-interactively 'org-match-sparse-tree))
11911 ((member ans '(?p ?P))
11912 (setq kwd (org-icompleting-read "Property: "
11913 (mapcar 'list (org-buffer-property-keys))))
11914 (setq value (org-icompleting-read "Value: "
11915 (mapcar 'list (org-property-values kwd))))
11918 (org-match-sparse-tree arg (concat kwd "=" value)))
11919 ((member ans '(?r ?R ?/))
11920 (call-interactively 'org-occur))
11923 (defvar org-occur-highlights nil
11924 "List of overlays used for occur matches.")
11925 (make-variable-buffer-local 'org-occur-highlights)
11926 (defvar org-occur-parameters nil
11927 "Parameters of the active org-occur calls.
11928 This is a list, each call to org-occur pushes as cons cell,
11929 containing the regular expression and the callback, onto the list.
11930 The list can contain several entries if `org-occur' has been called
11931 several time with the KEEP-PREVIOUS argument. Otherwise, this list
11932 will only contain one set of parameters. When the highlights are
11933 removed (for example with `C-c C-c', or with the next edit (depending
11934 on `org-remove-highlights-with-change'), this variable is emptied
11935 as well.")
11936 (make-variable-buffer-local 'org-occur-parameters)
11938 (defun org-occur (regexp &optional keep-previous callback)
11939 "Make a compact tree which shows all matches of REGEXP.
11940 The tree will show the lines where the regexp matches, and all higher
11941 headlines above the match. It will also show the heading after the match,
11942 to make sure editing the matching entry is easy.
11943 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
11944 call to `org-occur' will be kept, to allow stacking of calls to this
11945 command.
11946 If CALLBACK is non-nil, it is a function which is called to confirm
11947 that the match should indeed be shown."
11949 (when (equal regexp "")
11950 (error "Regexp cannot be empty"))
11951 (unless keep-previous
11952 (org-remove-occur-highlights nil nil t))
11953 (push (cons regexp callback) org-occur-parameters)
11954 (let ((cnt 0))
11955 (save-excursion
11956 (goto-char (point-min))
11957 (if (or (not keep-previous) ; do not want to keep
11958 (not org-occur-highlights)) ; no previous matches
11959 ;; hide everything
11960 (org-overview))
11961 (while (re-search-forward regexp nil t)
11962 (when (or (not callback)
11963 (save-match-data (funcall callback)))
11964 (setq cnt (1+ cnt))
11965 (when org-highlight-sparse-tree-matches
11966 (org-highlight-new-match (match-beginning 0) (match-end 0)))
11967 (org-show-context 'occur-tree))))
11968 (when org-remove-highlights-with-change
11969 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
11970 nil 'local))
11971 (unless org-sparse-tree-open-archived-trees
11972 (org-hide-archived-subtrees (point-min) (point-max)))
11973 (run-hooks 'org-occur-hook)
11974 (if (interactive-p)
11975 (message "%d match(es) for regexp %s" cnt regexp))
11976 cnt))
11978 (defun org-show-context (&optional key)
11979 "Make sure point and context are visible.
11980 How much context is shown depends upon the variables
11981 `org-show-hierarchy-above', `org-show-following-heading'. and
11982 `org-show-siblings'."
11983 (let ((heading-p (org-on-heading-p t))
11984 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
11985 (following-p (org-get-alist-option org-show-following-heading key))
11986 (entry-p (org-get-alist-option org-show-entry-below key))
11987 (siblings-p (org-get-alist-option org-show-siblings key)))
11988 (catch 'exit
11989 ;; Show heading or entry text
11990 (if (and heading-p (not entry-p))
11991 (org-flag-heading nil) ; only show the heading
11992 (and (or entry-p (org-invisible-p) (org-invisible-p2))
11993 (org-show-hidden-entry))) ; show entire entry
11994 (when following-p
11995 ;; Show next sibling, or heading below text
11996 (save-excursion
11997 (and (if heading-p (org-goto-sibling) (outline-next-heading))
11998 (org-flag-heading nil))))
11999 (when siblings-p (org-show-siblings))
12000 (when hierarchy-p
12001 ;; show all higher headings, possibly with siblings
12002 (save-excursion
12003 (while (and (condition-case nil
12004 (progn (org-up-heading-all 1) t)
12005 (error nil))
12006 (not (bobp)))
12007 (org-flag-heading nil)
12008 (when siblings-p (org-show-siblings))))))))
12010 (defvar org-reveal-start-hook nil
12011 "Hook run before revealing a location.")
12013 (defun org-reveal (&optional siblings)
12014 "Show current entry, hierarchy above it, and the following headline.
12015 This can be used to show a consistent set of context around locations
12016 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12017 not t for the search context.
12019 With optional argument SIBLINGS, on each level of the hierarchy all
12020 siblings are shown. This repairs the tree structure to what it would
12021 look like when opened with hierarchical calls to `org-cycle'.
12023 go to the parent and show the
12024 entire tree."
12025 (interactive "P")
12026 (run-hooks 'org-reveal-start-hook)
12027 (let ((org-show-hierarchy-above t)
12028 (org-show-following-heading t)
12029 (org-show-siblings (if siblings t org-show-siblings)))
12030 (org-show-context nil))
12031 (when (equal siblings '(16))
12032 (save-excursion
12033 (when (org-up-heading-safe)
12034 (org-show-subtree)
12035 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12037 (defun org-highlight-new-match (beg end)
12038 "Highlight from BEG to END and mark the highlight is an occur headline."
12039 (let ((ov (make-overlay beg end)))
12040 (overlay-put ov 'face 'secondary-selection)
12041 (push ov org-occur-highlights)))
12043 (defun org-remove-occur-highlights (&optional beg end noremove)
12044 "Remove the occur highlights from the buffer.
12045 BEG and END are ignored. If NOREMOVE is nil, remove this function
12046 from the `before-change-functions' in the current buffer."
12047 (interactive)
12048 (unless org-inhibit-highlight-removal
12049 (mapc 'delete-overlay org-occur-highlights)
12050 (setq org-occur-highlights nil)
12051 (setq org-occur-parameters nil)
12052 (unless noremove
12053 (remove-hook 'before-change-functions
12054 'org-remove-occur-highlights 'local))))
12056 ;;;; Priorities
12059 "Regular expression matching the priority indicator.")
12061 (defvar org-remove-priority-next-time nil)
12063 (defun org-priority-up ()
12064 "Increase the priority of the current item."
12065 (interactive)
12066 (org-priority 'up))
12068 (defun org-priority-down ()
12069 "Decrease the priority of the current item."
12070 (interactive)
12071 (org-priority 'down))
12073 (defun org-priority (&optional action)
12074 "Change the priority of an item by ARG.
12075 ACTION can be `set', `up', `down', or a character."
12076 (interactive)
12077 (unless org-enable-priority-commands
12078 (error "Priority commands are disabled"))
12079 (setq action (or action 'set))
12080 (let (current new news have remove)
12081 (save-excursion
12082 (org-back-to-heading t)
12083 (if (looking-at org-priority-regexp)
12084 (setq current (string-to-char (match-string 2))
12085 have t)
12086 (setq current org-default-priority))
12087 (cond
12088 ((eq action 'remove)
12089 (setq remove t new ?\ ))
12090 ((or (eq action 'set)
12091 (if (featurep 'xemacs) (characterp action) (integerp action)))
12092 (if (not (eq action 'set))
12093 (setq new action)
12094 (message "Priority %c-%c, SPC to remove: "
12095 org-highest-priority org-lowest-priority)
12096 (save-match-data
12097 (setq new (read-char-exclusive))))
12098 (if (and (= (upcase org-highest-priority) org-highest-priority)
12099 (= (upcase org-lowest-priority) org-lowest-priority))
12100 (setq new (upcase new)))
12101 (cond ((equal new ?\ ) (setq remove t))
12102 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12103 (error "Priority must be between `%c' and `%c'"
12104 org-highest-priority org-lowest-priority))))
12105 ((eq action 'up)
12106 (if (and (not have) (eq last-command this-command))
12107 (setq new org-lowest-priority)
12108 (setq new (if (and org-priority-start-cycle-with-default (not have))
12109 org-default-priority (1- current)))))
12110 ((eq action 'down)
12111 (if (and (not have) (eq last-command this-command))
12112 (setq new org-highest-priority)
12113 (setq new (if (and org-priority-start-cycle-with-default (not have))
12114 org-default-priority (1+ current)))))
12115 (t (error "Invalid action")))
12116 (if (or (< (upcase new) org-highest-priority)
12117 (> (upcase new) org-lowest-priority))
12118 (setq remove t))
12119 (setq news (format "%c" new))
12120 (if have
12121 (if remove
12122 (replace-match "" t t nil 1)
12123 (replace-match news t t nil 2))
12124 (if remove
12125 (error "No priority cookie found in line")
12126 (let ((case-fold-search nil))
12127 (looking-at org-todo-line-regexp))
12128 (if (match-end 2)
12129 (progn
12130 (goto-char (match-end 2))
12131 (insert " [#" news "]"))
12132 (goto-char (match-beginning 3))
12133 (insert "[#" news "] "))))
12134 (org-preserve-lc (org-set-tags nil 'align)))
12135 (if remove
12136 (message "Priority removed")
12137 (message "Priority of current item set to %s" news))))
12139 (defun org-get-priority (s)
12140 "Find priority cookie and return priority."
12141 (if (functionp org-get-priority-function)
12142 (funcall org-get-priority-function)
12143 (save-match-data
12144 (if (not (string-match org-priority-regexp s))
12145 (* 1000 (- org-lowest-priority org-default-priority))
12146 (* 1000 (- org-lowest-priority
12147 (string-to-char (match-string 2 s))))))))
12149 ;;;; Tags
12151 (defvar org-agenda-archives-mode)
12152 (defvar org-map-continue-from nil
12153 "Position from where mapping should continue.
12154 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12156 (defvar org-scanner-tags nil
12157 "The current tag list while the tags scanner is running.")
12158 (defvar org-trust-scanner-tags nil
12159 "Should `org-get-tags-at' use the tags fro the scanner.
12160 This is for internal dynamical scoping only.
12161 When this is non-nil, the function `org-get-tags-at' will return the value
12162 of `org-scanner-tags' instead of building the list by itself. This
12163 can lead to large speed-ups when the tags scanner is used in a file with
12164 many entries, and when the list of tags is retrieved, for example to
12165 obtain a list of properties. Building the tags list for each entry in such
12166 a file becomes an N^2 operation - but with this variable set, it scales
12167 as N.")
12169 (defun org-scan-tags (action matcher &optional todo-only)
12170 "Scan headline tags with inheritance and produce output ACTION.
12172 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12173 or `agenda' to produce an entry list for an agenda view. It can also be
12174 a Lisp form or a function that should be called at each matched headline, in
12175 this case the return value is a list of all return values from these calls.
12177 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12178 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12179 only lines with a TODO keyword are included in the output."
12180 (require 'org-agenda)
12183 (org-re
12185 (props (list 'face 'default
12186 'done-face 'org-agenda-done
12187 'undone-face 'default
12188 'mouse-face 'highlight
12189 'org-not-done-regexp org-not-done-regexp
12190 'org-todo-regexp org-todo-regexp
12191 'help-echo
12192 (format "mouse-2 or RET jump to org file %s"
12193 (abbreviate-file-name
12194 (or (buffer-file-name (buffer-base-buffer))
12195 (buffer-name (buffer-base-buffer)))))))
12196 (case-fold-search nil)
12197 (org-map-continue-from nil)
12198 lspos tags tags-list
12199 (tags-alist (list (cons 0 org-file-tags)))
12200 (llast 0) rtn rtn1 level category i txt
12201 todo marker entry priority)
12202 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12203 (setq action (list 'lambda nil action)))
12204 (save-excursion
12205 (goto-char (point-min))
12206 (when (eq action 'sparse-tree)
12207 (org-overview)
12208 (org-remove-occur-highlights))
12209 (while (re-search-forward re nil t)
12210 (catch :skip
12211 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12212 tags (if (match-end 4) (org-match-string-no-properties 4)))
12213 (goto-char (setq lspos (match-beginning 0)))
12214 (setq level (org-reduced-level (funcall outline-level))
12215 category (org-get-category))
12216 (setq i llast llast level)
12217 ;; remove tag lists from same and sublevels
12218 (while (>= i level)
12219 (when (setq entry (assoc i tags-alist))
12220 (setq tags-alist (delete entry tags-alist)))
12221 (setq i (1- i)))
12222 ;; add the next tags
12223 (when tags
12224 (setq tags (org-split-string tags ":")
12225 tags-alist
12226 (cons (cons level tags) tags-alist)))
12227 ;; compile tags for current headline
12228 (setq tags-list
12229 (if org-use-tag-inheritance
12230 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12231 tags)
12232 org-scanner-tags tags-list)
12233 (when org-use-tag-inheritance
12234 (setcdr (car tags-alist)
12235 (mapcar (lambda (x)
12236 (setq x (copy-sequence x))
12237 (org-add-prop-inherited x))
12238 (cdar tags-alist))))
12239 (when (and tags org-use-tag-inheritance
12240 (or (not (eq t org-use-tag-inheritance))
12241 org-tags-exclude-from-inheritance))
12242 ;; selective inheritance, remove uninherited ones
12243 (setcdr (car tags-alist)
12244 (org-remove-uniherited-tags (cdar tags-alist))))
12245 (when (and (or (not todo-only)
12246 (and (member todo org-not-done-keywords)
12247 (or (not org-agenda-tags-todo-honor-ignore-options)
12248 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12249 (let ((case-fold-search t)) (eval matcher))
12250 (or
12251 (not (member org-archive-tag tags-list))
12252 ;; we have an archive tag, should we use this anyway?
12253 (or (not org-agenda-skip-archived-trees)
12254 (and (eq action 'agenda) org-agenda-archives-mode))))
12255 (unless (eq action 'sparse-tree) (org-agenda-skip))
12257 ;; select this headline
12259 (cond
12260 ((eq action 'sparse-tree)
12261 (and org-highlight-sparse-tree-matches
12262 (org-get-heading) (match-end 0)
12263 (org-highlight-new-match
12264 (match-beginning 0) (match-beginning 1)))
12265 (org-show-context 'tags-tree))
12266 ((eq action 'agenda)
12267 (setq txt (org-format-agenda-item
12268 ""
12269 (concat
12270 (if (eq org-tags-match-list-sublevels 'indented)
12271 (make-string (1- level) ?.) "")
12272 (org-get-heading))
12273 category
12274 tags-list
12275 )
12276 priority (org-get-priority txt))
12277 (goto-char lspos)
12278 (setq marker (org-agenda-new-marker))
12279 (org-add-props txt props
12280 'org-marker marker 'org-hd-marker marker 'org-category category
12281 'todo-state todo
12282 'priority priority 'type "tagsmatch")
12283 (push txt rtn))
12284 ((functionp action)
12285 (setq org-map-continue-from nil)
12286 (save-excursion
12287 (setq rtn1 (funcall action))
12288 (push rtn1 rtn)))
12289 (t (error "Invalid action")))
12291 ;; if we are to skip sublevels, jump to end of subtree
12292 (unless org-tags-match-list-sublevels
12293 (org-end-of-subtree t)
12294 (backward-char 1))))
12295 ;; Get the correct position from where to continue
12296 (if org-map-continue-from
12297 (goto-char org-map-continue-from)
12298 (and (= (point) lspos) (end-of-line 1)))))
12299 (when (and (eq action 'sparse-tree)
12300 (not org-sparse-tree-open-archived-trees))
12301 (org-hide-archived-subtrees (point-min) (point-max)))
12302 (nreverse rtn)))
12304 (defun org-remove-uniherited-tags (tags)
12305 "Remove all tags that are not inherited from the list TAGS."
12306 (cond
12307 ((eq org-use-tag-inheritance t)
12308 (if org-tags-exclude-from-inheritance
12309 (org-delete-all org-tags-exclude-from-inheritance tags)
12310 tags))
12311 ((not org-use-tag-inheritance) nil)
12312 ((stringp org-use-tag-inheritance)
12313 (delq nil (mapcar
12314 (lambda (x)
12315 (if (and (string-match org-use-tag-inheritance x)
12316 (not (member x org-tags-exclude-from-inheritance)))
12317 x nil))
12318 tags)))
12319 ((listp org-use-tag-inheritance)
12320 (delq nil (mapcar
12321 (lambda (x)
12322 (if (member x org-use-tag-inheritance) x nil))
12323 tags)))))
12325 (defvar todo-only) ;; dynamically scoped
12327 (defun org-match-sparse-tree (&optional todo-only match)
12328 "Create a sparse tree according to tags string MATCH.
12329 MATCH can contain positive and negative selection of tags, like
12331 If optional argument TODO-ONLY is non-nil, only select lines that are
12332 also TODO lines."
12333 (interactive "P")
12334 (org-prepare-agenda-buffers (list (current-buffer)))
12335 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12337 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12339 (defvar org-cached-props nil)
12340 (defun org-cached-entry-get (pom property)
12341 (if (or (eq t org-use-property-inheritance)
12342 (and (stringp org-use-property-inheritance)
12343 (string-match org-use-property-inheritance property))
12344 (and (listp org-use-property-inheritance)
12345 (member property org-use-property-inheritance)))
12346 ;; Caching is not possible, check it directly
12347 (org-entry-get pom property 'inherit)
12348 ;; Get all properties, so that we can do complicated checks easily
12349 (cdr (assoc property (or org-cached-props
12350 (setq org-cached-props
12351 (org-entry-properties pom)))))))
12353 (defun org-global-tags-completion-table (&optional files)
12354 "Return the list of all tags in all agenda buffer/files."
12355 (save-excursion
12356 (org-uniquify
12357 (delq nil
12358 (apply 'append
12359 (mapcar
12360 (lambda (file)
12361 (set-buffer (find-file-noselect file))
12362 (append (org-get-buffer-tags)
12363 (mapcar (lambda (x) (if (stringp (car-safe x))
12364 (list (car-safe x)) nil))
12365 org-tag-alist)))
12366 (if (and files (car files))
12367 files
12368 (org-agenda-files))))))))
12370 (defun org-make-tags-matcher (match)
12371 "Create the TAGS//TODO matcher form for the selection string MATCH."
12372 ;; todo-only is scoped dynamically into this function, and the function
12373 ;; may change it if the matcher asks for it.
12374 (unless match
12375 ;; Get a new match request, with completion
12376 (let ((org-last-tags-completion-table
12377 (org-global-tags-completion-table)))
12378 (setq match (org-completing-read-no-i
12379 "Match: " 'org-tags-completion-function nil nil nil
12380 'org-tags-history))))
12382 ;; Parse the string and create a lisp form
12383 (let ((match0 match)
12384 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12385 minus tag mm
12386 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12387 orterms term orlist re-p str-p level-p level-op time-p
12388 prop-p pn pv po gv rest)
12389 (if (string-match "/+" match)
12390 ;; match contains also a todo-matching request
12391 (progn
12392 (setq tagsmatch (substring match 0 (match-beginning 0))
12393 todomatch (substring match (match-end 0)))
12394 (if (string-match "^!" todomatch)
12395 (setq todo-only t todomatch (substring todomatch 1)))
12397 (setq todomatch nil)))
12398 ;; only matching tags
12399 (setq tagsmatch match todomatch nil))
12401 ;; Make the tags matcher
12403 (setq tagsmatcher t)
12404 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12405 (while (setq term (pop orterms))
12407 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12408 (while (string-match re term)
12409 (setq rest (substring term (match-end 0))
12410 minus (and (match-end 1)
12411 (equal (match-string 1 term) "-"))
12412 tag (save-match-data (replace-regexp-in-string
12414 (match-string 2 term)))
12415 re-p (equal (string-to-char tag) ?{)
12416 level-p (match-end 4)
12417 prop-p (match-end 5)
12418 mm (cond
12419 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12420 (level-p
12421 (setq level-op (org-op-to-function (match-string 3 term)))
12422 `(,level-op level ,(string-to-number
12423 (match-string 4 term))))
12424 (prop-p
12425 (setq pn (match-string 5 term)
12426 po (match-string 6 term)
12427 pv (match-string 7 term)
12428 re-p (equal (string-to-char pv) ?{)
12430 time-p (save-match-data
12432 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12433 (if time-p (setq pv (org-matcher-time pv)))
12434 (setq po (org-op-to-function po (if time-p 'time str-p)))
12435 (cond
12436 ((equal pn "CATEGORY")
12437 (setq gv '(get-text-property (point) 'org-category)))
12438 ((equal pn "TODO")
12439 (setq gv 'todo))
12440 (t
12441 (setq gv `(org-cached-entry-get nil ,pn))))
12442 (if re-p
12443 (if (eq po 'org<>)
12444 `(not (string-match ,pv (or ,gv "")))
12445 `(string-match ,pv (or ,gv "")))
12446 (if str-p
12447 `(,po (or ,gv "") ,pv)
12448 `(,po (string-to-number (or ,gv ""))
12449 ,(string-to-number pv) ))))
12450 (t `(member ,tag tags-list)))
12451 mm (if minus (list 'not mm) mm)
12452 term rest)
12453 (push mm tagsmatcher))
12454 (push (if (> (length tagsmatcher) 1)
12455 (cons 'and tagsmatcher)
12456 (car tagsmatcher))
12457 orlist)
12458 (setq tagsmatcher nil))
12459 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12460 (setq tagsmatcher
12461 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12462 ;; Make the todo matcher
12464 (setq todomatcher t)
12465 (setq orterms (org-split-string todomatch "|") orlist nil)
12466 (while (setq term (pop orterms))
12467 (while (string-match re term)
12468 (setq minus (and (match-end 1)
12469 (equal (match-string 1 term) "-"))
12470 kwd (match-string 2 term)
12471 re-p (equal (string-to-char kwd) ?{)
12472 term (substring term (match-end 0))
12473 mm (if re-p
12474 `(string-match ,(substring kwd 1 -1) todo)
12475 (list 'equal 'todo kwd))
12476 mm (if minus (list 'not mm) mm))
12477 (push mm todomatcher))
12478 (push (if (> (length todomatcher) 1)
12479 (cons 'and todomatcher)
12480 (car todomatcher))
12481 orlist)
12482 (setq todomatcher nil))
12483 (setq todomatcher (if (> (length orlist) 1)
12484 (cons 'or orlist) (car orlist))))
12486 ;; Return the string and lisp forms of the matcher
12487 (setq matcher (if todomatcher
12488 (list 'and tagsmatcher todomatcher)
12489 tagsmatcher))
12490 (cons match0 matcher)))
12492 (defun org-op-to-function (op &optional stringp)
12493 "Turn an operator into the appropriate function."
12494 (setq op
12495 (cond
12496 ((equal op "<" ) '(< string< org-time<))
12497 ((equal op ">" ) '(> org-string> org-time>))
12498 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12499 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12500 ((member op '("=" "==")) '(= string= org-time=))
12501 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12502 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12504 (defun org<> (a b) (not (= a b)))
12505 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12506 (defun org-string>= (a b) (not (string< a b)))
12507 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12508 (defun org-string<> (a b) (not (string= a b)))
12509 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12510 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12511 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12512 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12513 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12514 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12515 (defun org-2ft (s)
12516 "Convert S to a floating point time.
12517 If S is already a number, just return it. If it is a string, parse
12518 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12519 (cond
12520 ((numberp s) s)
12521 ((stringp s)
12522 (condition-case nil
12523 (float-time (apply 'encode-time (org-parse-time-string s)))
12524 (error 0.)))
12525 (t 0.)))
12527 (defun org-time-today ()
12528 "Time in seconds today at 0:00.
12529 Returns the float number of seconds since the beginning of the
12530 epoch to the beginning of today (00:00)."
12531 (float-time (apply 'encode-time
12532 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12534 (defun org-matcher-time (s)
12535 "Interpret a time comparison value."
12536 (save-match-data
12537 (cond
12538 ((string= s "<now>") (float-time))
12539 ((string= s "<today>") (org-time-today))
12540 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12541 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12543 (+ (org-time-today)
12544 (* (string-to-number (match-string 1 s))
12545 (cdr (assoc (match-string 2 s)
12546 '(("d" . 86400.0) ("w" . 604800.0)
12547 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12548 (t (org-2ft s)))))
12550 (defun org-match-any-p (re list)
12551 "Does re match any element of list?"
12552 (setq list (mapcar (lambda (x) (string-match re x)) list))
12553 (delq nil list))
12555 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12556 (defvar org-tags-overlay (make-overlay 1 1))
12557 (org-detach-overlay org-tags-overlay)
12559 (defun org-get-local-tags-at (&optional pos)
12560 "Get a list of tags defined in the current headline."
12561 (org-get-tags-at pos 'local))
12563 (defun org-get-local-tags ()
12564 "Get a list of tags defined in the current headline."
12565 (org-get-tags-at nil 'local))
12567 (defun org-get-tags-at (&optional pos local)
12568 "Get a list of all headline tags applicable at POS.
12569 POS defaults to point. If tags are inherited, the list contains
12570 the targets in the same sequence as the headlines appear, i.e.
12571 the tags of the current headline come last.
12572 When LOCAL is non-nil, only return tags from the current headline,
12573 ignore inherited ones."
12574 (interactive)
12575 (if (and org-trust-scanner-tags
12576 (or (not pos) (equal pos (point)))
12577 (not local))
12578 org-scanner-tags
12579 (let (tags ltags lastpos parent)
12580 (save-excursion
12581 (save-restriction
12582 (widen)
12583 (goto-char (or pos (point)))
12584 (save-match-data
12585 (catch 'done
12586 (condition-case nil
12587 (progn
12588 (org-back-to-heading t)
12589 (while (not (equal lastpos (point)))
12590 (setq lastpos (point))
12591 (when (looking-at
12593 (setq ltags (org-split-string
12594 (org-match-string-no-properties 1) ":"))
12595 (when parent
12596 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12597 (setq tags (append
12598 (if parent
12599 (org-remove-uniherited-tags ltags)
12600 ltags)
12601 tags)))
12602 (or org-use-tag-inheritance (throw 'done t))
12603 (if local (throw 'done t))
12604 (or (org-up-heading-safe) (error nil))
12605 (setq parent t)))
12606 (error nil)))))
12607 (append (org-remove-uniherited-tags org-file-tags) tags)))))
12609 (defun org-add-prop-inherited (s)
12610 (add-text-properties 0 (length s) '(inherited t) s)
12611 s)
12613 (defun org-toggle-tag (tag &optional onoff)
12614 "Toggle the tag TAG for the current line.
12615 If ONOFF is `on' or `off', don't toggle but set to this state."
12616 (let (res current)
12617 (save-excursion
12618 (org-back-to-heading t)
12620 (point-at-eol) t)
12621 (progn
12622 (setq current (match-string 1))
12623 (replace-match ""))
12624 (setq current ""))
12625 (setq current (nreverse (org-split-string current ":")))
12626 (cond
12627 ((eq onoff 'on)
12628 (setq res t)
12629 (or (member tag current) (push tag current)))
12630 ((eq onoff 'off)
12631 (or (not (member tag current)) (setq current (delete tag current))))
12632 (t (if (member tag current)
12633 (setq current (delete tag current))
12634 (setq res t)
12635 (push tag current))))
12636 (end-of-line 1)
12637 (if current
12638 (progn
12639 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12640 (org-set-tags nil t))
12641 (delete-horizontal-space))
12642 (run-hooks 'org-after-tags-change-hook))
12643 res))
12645 (defun org-align-tags-here (to-col)
12646 ;; Assumes that this is a headline
12647 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12648 (beginning-of-line 1)
12650 (< pos (match-beginning 2)))
12651 (progn
12652 (setq tags-l (- (match-end 2) (match-beginning 2)))
12653 (goto-char (match-beginning 1))
12654 (insert " ")
12655 (delete-region (point) (1+ (match-beginning 2)))
12656 (setq ncol (max (1+ (current-column))
12657 (1+ col)
12658 (if (> to-col 0)
12659 to-col
12660 (- (abs to-col) tags-l))))
12661 (setq p (point))
12662 (insert (make-string (- ncol (current-column)) ?\ ))
12663 (setq ncol (current-column))
12664 (when indent-tabs-mode (tabify p (point-at-eol)))
12665 (org-move-to-column (min ncol col) t))
12666 (goto-char pos))))
12668 (defun org-set-tags-command (&optional arg just-align)
12669 "Call the set-tags command for the current entry."
12670 (interactive "P")
12671 (if (org-on-heading-p)
12672 (org-set-tags arg just-align)
12673 (save-excursion
12674 (org-back-to-heading t)
12675 (org-set-tags arg just-align))))
12677 (defun org-set-tags-to (data)
12678 "Set the tags of the current entry to DATA, replacing the current tags.
12679 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12680 If DATA is nil or the empty string, any tags will be removed."
12681 (interactive "sTags: ")
12682 (setq data
12683 (cond
12684 ((eq data nil) "")
12685 ((equal data "") "")
12686 ((stringp data)
12687 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12688 ":"))
12689 ((listp data)
12690 (concat ":" (mapconcat 'identity data ":") ":"))
12691 (t nil)))
12692 (when data
12693 (save-excursion
12694 (org-back-to-heading t)
12695 (when (looking-at org-complex-heading-regexp)
12696 (if (match-end 5)
12697 (progn
12698 (goto-char (match-beginning 5))
12699 (insert data)
12700 (delete-region (point) (point-at-eol))
12701 (org-set-tags nil 'align))
12702 (goto-char (point-at-eol))
12703 (insert " " data)
12704 (org-set-tags nil 'align)))
12705 (beginning-of-line 1)
12707 (delete-region (match-beginning 1) (match-end 1))))))
12709 (defun org-align-all-tags ()
12710 "Align the tags i all headings."
12711 (interactive)
12712 (save-excursion
12713 (or (ignore-errors (org-back-to-heading t))
12714 (outline-next-heading))
12715 (if (org-on-heading-p)
12716 (org-set-tags t)
12717 (message "No headings"))))
12719 (defvar org-indent-indentation-per-level)
12720 (defun org-set-tags (&optional arg just-align)
12721 "Set the tags for the current headline.
12722 With prefix ARG, realign all tags in headings in the current buffer."
12723 (interactive "P")
12724 (let* ((re (concat "^" outline-regexp))
12725 (current (org-get-tags-string))
12726 (col (current-column))
12727 (org-setting-tags t)
12728 table current-tags inherited-tags ; computed below when needed
12729 tags p0 c0 c1 rpl di tc level)
12730 (if arg
12731 (save-excursion
12732 (goto-char (point-min))
12733 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12734 (while (re-search-forward re nil t)
12735 (org-set-tags nil t)
12736 (end-of-line 1)))
12737 (message "All tags realigned to column %d" org-tags-column))
12738 (if just-align
12739 (setq tags current)
12740 ;; Get a new set of tags from the user
12741 (save-excursion
12742 (setq table (append org-tag-persistent-alist
12743 (or org-tag-alist (org-get-buffer-tags))
12744 (and
12745 org-complete-tags-always-offer-all-agenda-tags
12746 (org-global-tags-completion-table
12747 (org-agenda-files))))
12748 org-last-tags-completion-table table
12749 current-tags (org-split-string current ":")
12750 inherited-tags (nreverse
12751 (nthcdr (length current-tags)
12752 (nreverse (org-get-tags-at))))
12753 tags
12754 (if (or (eq t org-use-fast-tag-selection)
12755 (and org-use-fast-tag-selection
12756 (delq nil (mapcar 'cdr table))))
12757 (org-fast-tag-selection
12758 current-tags inherited-tags table
12759 (if org-fast-tag-selection-include-todo
12760 org-todo-key-alist))
12761 (let ((org-add-colon-after-tag-completion t))
12762 (org-trim
12763 (org-without-partial-completion
12764 (org-icompleting-read "Tags: "
12765 'org-tags-completion-function
12766 nil nil current 'org-tags-history)))))))
12767 (while (string-match "[-+&]+" tags)
12768 ;; No boolean logic, just a list
12769 (setq tags (replace-match ":" t t tags))))
12771 (setq tags (replace-regexp-in-string "[ ,]" ":" tags))
12773 (if org-tags-sort-function
12774 (setq tags (mapconcat 'identity
12775 (sort (org-split-string
12776 tags (org-re "[^[:alnum:]_@#%]+"))
12777 org-tags-sort-function) ":")))
12780 (setq tags "")
12781 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12782 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12784 ;; Insert new tags at the correct column
12785 (beginning-of-line 1)
12786 (setq level (or (and (looking-at org-outline-regexp)
12787 (- (match-end 0) (point) 1))
12788 1))
12789 (cond
12790 ((and (equal current "") (equal tags "")))
12791 ((re-search-forward
12793 (point-at-eol) t)
12794 (if (equal tags "")
12795 (setq rpl "")
12796 (goto-char (match-beginning 0))
12797 (setq c0 (current-column)
12798 ;; compute offset for the case of org-indent-mode active
12799 di (if org-indent-mode
12800 (* (1- org-indent-indentation-per-level) (1- level))
12801 0)
12802 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
12803 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
12804 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
12805 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12806 (replace-match rpl t t)
12807 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
12808 tags)
12809 (t (error "Tags alignment failed")))
12810 (org-move-to-column col)
12811 (unless just-align
12812 (run-hooks 'org-after-tags-change-hook)))))
12814 (defun org-change-tag-in-region (beg end tag off)
12815 "Add or remove TAG for each entry in the region.
12816 This works in the agenda, and also in an org-mode buffer."
12817 (interactive
12818 (list (region-beginning) (region-end)
12819 (let ((org-last-tags-completion-table
12820 (if (org-mode-p)
12821 (org-get-buffer-tags)
12822 (org-global-tags-completion-table))))
12823 (org-icompleting-read
12824 "Tag: " 'org-tags-completion-function nil nil nil
12825 'org-tags-history))
12826 (progn
12828 (equal (read-char-exclusive) ?r))))
12829 (if (fboundp 'deactivate-mark) (deactivate-mark))
12830 (let ((agendap (equal major-mode 'org-agenda-mode))
12831 l1 l2 m buf pos newhead (cnt 0))
12832 (goto-char end)
12833 (setq l2 (1- (org-current-line)))
12834 (goto-char beg)
12835 (setq l1 (org-current-line))
12836 (loop for l from l1 to l2 do
12837 (org-goto-line l)
12838 (setq m (get-text-property (point) 'org-hd-marker))
12839 (when (or (and (org-mode-p) (org-on-heading-p))
12840 (and agendap m))
12841 (setq buf (if agendap (marker-buffer m) (current-buffer))
12842 pos (if agendap m (point)))
12843 (with-current-buffer buf
12844 (save-excursion
12845 (save-restriction
12846 (goto-char pos)
12847 (setq cnt (1+ cnt))
12848 (org-toggle-tag tag (if off 'off 'on))
12849 (setq newhead (org-get-heading)))))
12850 (and agendap (org-agenda-change-all-lines newhead m))))
12851 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
12853 (defun org-tags-completion-function (string predicate &optional flag)
12854 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12855 (confirm (lambda (x) (stringp (car x)))))
12857 (setq s1 (match-string 1 string)
12858 s2 (match-string 2 string))
12859 (setq s1 "" s2 string))
12860 (cond
12861 ((eq flag nil)
12862 ;; try completion
12863 (setq rtn (try-completion s2 ctable confirm))
12864 (if (stringp rtn)
12865 (setq rtn
12866 (concat s1 s2 (substring rtn (length s2))
12867 (if (and org-add-colon-after-tag-completion
12868 (assoc rtn ctable))
12869 ":" ""))))
12870 rtn)
12871 ((eq flag t)
12872 ;; all-completions
12873 (all-completions s2 ctable confirm)
12874 )
12875 ((eq flag 'lambda)
12876 ;; exact match?
12877 (assoc s2 ctable)))
12878 ))
12880 (defun org-fast-tag-insert (kwd tags face &optional end)
12881 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
12882 (insert (format "%-12s" (concat kwd ":"))
12883 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
12884 (or end "")))
12886 (defun org-fast-tag-show-exit (flag)
12887 (save-excursion
12888 (org-goto-line 3)
12890 (replace-match ""))
12891 (when flag
12892 (end-of-line 1)
12893 (org-move-to-column (- (window-width) 19) t)
12894 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
12896 (defun org-set-current-tags-overlay (current prefix)
12897 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
12898 (if (featurep 'xemacs)
12899 (org-overlay-display org-tags-overlay (concat prefix s)
12900 'secondary-selection)
12901 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
12902 (org-overlay-display org-tags-overlay (concat prefix s)))))
12904 (defvar org-last-tag-selection-key nil)
12905 (defun org-fast-tag-selection (current inherited table &optional todo-table)
12906 "Fast tag selection with single keys.
12907 CURRENT is the current list of tags in the headline, INHERITED is the
12908 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
12909 possibly with grouping information. TODO-TABLE is a similar table with
12910 TODO keywords, should these have keys assigned to them.
12911 If the keys are nil, a-z are automatically assigned.
12912 Returns the new tags string, or nil to not change the current settings."
12913 (let* ((fulltable (append table todo-table))
12914 (maxlen (apply 'max (mapcar
12915 (lambda (x)
12916 (if (stringp (car x)) (string-width (car x)) 0))
12917 fulltable)))
12918 (buf (current-buffer))
12919 (expert (eq org-fast-tag-selection-single-key 'expert))
12920 (buffer-tags nil)
12921 (fwidth (+ maxlen 3 1 3))
12922 (ncol (/ (- (window-width) 4) fwidth))
12923 (i-face 'org-done)
12924 (c-face 'org-todo)
12925 tg cnt e c char c1 c2 ntable tbl rtn
12926 ov-start ov-end ov-prefix
12927 (exit-after-next org-fast-tag-selection-single-key)
12928 (done-keywords org-done-keywords)
12929 groups ingroup)
12930 (save-excursion
12931 (beginning-of-line 1)
12932 (if (looking-at
12934 (setq ov-start (match-beginning 1)
12935 ov-end (match-end 1)
12936 ov-prefix "")
12937 (setq ov-start (1- (point-at-eol))
12938 ov-end (1+ ov-start))
12940 (setq ov-prefix
12941 (concat
12942 (buffer-substring (1- (point)) (point))
12943 (if (> (current-column) org-tags-column)
12944 " "
12945 (make-string (- org-tags-column (current-column)) ?\ ))))))
12946 (move-overlay org-tags-overlay ov-start ov-end)
12947 (save-window-excursion
12948 (if expert
12949 (set-buffer (get-buffer-create " *Org tags*"))
12950 (delete-other-windows)
12951 (split-window-vertically)
12952 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
12953 (erase-buffer)
12954 (org-set-local 'org-done-keywords done-keywords)
12957 (org-fast-tag-show-exit exit-after-next)
12958 (org-set-current-tags-overlay current ov-prefix)
12959 (setq tbl fulltable char ?a cnt 0)
12960 (while (setq e (pop tbl))
12961 (cond
12962 ((equal (car e) :startgroup)
12963 (push '() groups) (setq ingroup t)
12964 (when (not (= cnt 0))
12965 (setq cnt 0)
12967 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
12968 ((equal (car e) :endgroup)
12969 (setq ingroup nil cnt 0)
12971 ((equal e '(:newline))
12972 (when (not (= cnt 0))
12973 (setq cnt 0)
12975 (setq e (car tbl))
12976 (while (equal (car tbl) '(:newline))
12978 (setq tbl (cdr tbl)))))
12979 (t
12980 (setq tg (copy-sequence (car e)) c2 nil)
12981 (if (cdr e)
12982 (setq c (cdr e))
12983 ;; automatically assign a character.
12984 (setq c1 (string-to-char
12985 (downcase (substring
12986 tg (if (= (string-to-char tg) ?@) 1 0)))))
12987 (if (or (rassoc c1 ntable) (rassoc c1 table))
12988 (while (or (rassoc char ntable) (rassoc char table))
12989 (setq char (1+ char)))
12990 (setq c2 c1))
12991 (setq c (or c2 char)))
12992 (if ingroup (push tg (car groups)))
12993 (setq tg (org-add-props tg nil 'face
12994 (cond
12995 ((not (assoc tg table))
12996 (org-get-todo-face tg))
12997 ((member tg current) c-face)
12998 ((member tg inherited) i-face)
12999 (t nil))))
13000 (if (and (= cnt 0) (not ingroup)) (insert " "))
13001 (insert "[" c "] " tg (make-string
13002 (- fwidth 4 (length tg)) ?\ ))
13003 (push (cons tg c) ntable)
13004 (when (= (setq cnt (1+ cnt)) ncol)
13006 (if ingroup (insert " "))
13007 (setq cnt 0)))))
13008 (setq ntable (nreverse ntable))
13010 (goto-char (point-min))
13011 (if (not expert) (org-fit-window-to-buffer))
13012 (setq rtn
13013 (catch 'exit
13014 (while t
13015 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13016 (if (not groups) "no " "")
13017 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13018 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13019 (setq org-last-tag-selection-key c)
13020 (cond
13022 ((= c ?!)
13023 (setq groups (not groups))
13024 (goto-char (point-min))
13025 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13026 ((= c ?\C-c)
13027 (if (not expert)
13028 (org-fast-tag-show-exit
13029 (setq exit-after-next (not exit-after-next)))
13030 (setq expert nil)
13031 (delete-other-windows)
13032 (set-window-buffer (split-window-vertically) " *Org tags*")
13033 (org-switch-to-buffer-other-window " *Org tags*")
13034 (org-fit-window-to-buffer)))
13035 ((or (= c ?\C-g)
13036 (and (= c ?q) (not (rassoc c ntable))))
13037 (org-detach-overlay org-tags-overlay)
13038 (setq quit-flag t))
13039 ((= c ?\ )
13040 (setq current nil)
13041 (if exit-after-next (setq exit-after-next 'now)))
13043 (condition-case nil
13044 (setq tg (org-icompleting-read
13045 "Tag: "
13046 (or buffer-tags
13047 (with-current-buffer buf
13048 (org-get-buffer-tags)))))
13049 (quit (setq tg "")))
13051 (add-to-list 'buffer-tags (list tg))
13052 (if (member tg current)
13053 (setq current (delete tg current))
13054 (push tg current)))
13055 (if exit-after-next (setq exit-after-next 'now)))
13056 ((setq e (rassoc c todo-table) tg (car e))
13057 (with-current-buffer buf
13058 (save-excursion (org-todo tg)))
13059 (if exit-after-next (setq exit-after-next 'now)))
13060 ((setq e (rassoc c ntable) tg (car e))
13061 (if (member tg current)
13062 (setq current (delete tg current))
13063 (loop for g in groups do
13064 (if (member tg g)
13065 (mapc (lambda (x)
13066 (setq current (delete x current)))
13067 g)))
13068 (push tg current))
13069 (if exit-after-next (setq exit-after-next 'now))))
13071 ;; Create a sorted list
13072 (setq current
13073 (sort current
13074 (lambda (a b)
13075 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13076 (if (eq exit-after-next 'now) (throw 'exit t))
13077 (goto-char (point-min))
13078 (beginning-of-line 2)
13079 (delete-region (point) (point-at-eol))
13080 (org-fast-tag-insert "Current" current c-face)
13081 (org-set-current-tags-overlay current ov-prefix)
13082 (while (re-search-forward
13084 (setq tg (match-string 1))
13085 (add-text-properties
13086 (match-beginning 1) (match-end 1)
13087 (list 'face
13088 (cond
13089 ((member tg current) c-face)
13090 ((member tg inherited) i-face)
13091 (t (get-text-property (match-beginning 1) 'face))))))
13092 (goto-char (point-min)))))
13093 (org-detach-overlay org-tags-overlay)
13094 (if rtn
13095 (mapconcat 'identity current ":")
13096 nil))))
13098 (defun org-get-tags-string ()
13099 "Get the TAGS string in the current headline."
13100 (unless (org-on-heading-p t)
13101 (error "Not on a heading"))
13102 (save-excursion
13103 (beginning-of-line 1)
13105 (org-match-string-no-properties 1)
13106 "")))
13108 (defun org-get-tags ()
13109 "Get the list of tags specified in the current headline."
13110 (org-split-string (org-get-tags-string) ":"))
13112 (defun org-get-buffer-tags ()
13113 "Get a table of all tags used in the buffer, for completion."
13114 (let (tags)
13115 (save-excursion
13116 (goto-char (point-min))
13117 (while (re-search-forward
13119 (when (equal (char-after (point-at-bol 0)) ?*)
13120 (mapc (lambda (x) (add-to-list 'tags x))
13121 (org-split-string (org-match-string-no-properties 1) ":")))))
13122 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13123 (mapcar 'list tags)))
13125 ;;;; The mapping API
13127 ;;;###autoload
13128 (defun org-map-entries (func &optional match scope &rest skip)
13129 "Call FUNC at each headline selected by MATCH in SCOPE.
13131 FUNC is a function or a lisp form. The function will be called without
13132 arguments, with the cursor positioned at the beginning of the headline.
13133 The return values of all calls to the function will be collected and
13134 returned as a list.
13136 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13137 does not need to preserve point. After evaluation, the cursor will be
13138 moved to the end of the line (presumably of the headline of the
13139 processed entry) and search continues from there. Under some
13140 circumstances, this may not produce the wanted results. For example,
13141 if you have removed (e.g. archived) the current (sub)tree it could
13142 mean that the next entry will be skipped entirely. In such cases, you
13143 can specify the position from where search should continue by making
13144 FUNC set the variable `org-map-continue-from' to the desired buffer
13145 position.
13147 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13148 Only headlines that are matched by this query will be considered during
13149 the iteration. When MATCH is nil or t, all headlines will be
13150 visited by the iteration.
13152 SCOPE determines the scope of this command. It can be any of:
13154 nil The current buffer, respecting the restriction if any
13155 tree The subtree started with the entry at point
13156 file The current buffer, without restriction
13157 file-with-archives
13158 The current buffer, and any archives associated with it
13159 agenda All agenda files
13160 agenda-with-archives
13161 All agenda files with any archive files associated with them
13162 \(file1 file2 ...)
13163 If this is a list, all files in the list will be scanned
13165 The remaining args are treated as settings for the skipping facilities of
13166 the scanner. The following items can be given here:
13168 archive skip trees with the archive tag.
13169 comment skip trees with the COMMENT keyword
13170 function or Emacs Lisp form:
13171 will be used as value for `org-agenda-skip-function', so whenever
13172 the function returns t, FUNC will not be called for that
13173 entry and search will continue from the point where the
13174 function leaves it.
13176 If your function needs to retrieve the tags including inherited tags
13177 at the *current* entry, you can use the value of the variable
13178 `org-scanner-tags' which will be much faster than getting the value
13179 with `org-get-tags-at'. If your function gets properties with
13180 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13181 to t around the call to `org-entry-properties' to get the same speedup.
13182 Note that if your function moves around to retrieve tags and properties at
13183 a *different* entry, you cannot use these techniques."
13184 (let* ((org-agenda-archives-mode nil) ; just to make sure
13185 (org-agenda-skip-archived-trees (memq 'archive skip))
13186 (org-agenda-skip-comment-trees (memq 'comment skip))
13187 (org-agenda-skip-function
13188 (car (org-delete-all '(comment archive) skip)))
13189 (org-tags-match-list-sublevels t)
13190 matcher file res
13191 org-todo-keywords-for-agenda
13192 org-done-keywords-for-agenda
13193 org-todo-keyword-alist-for-agenda
13194 org-drawers-for-agenda
13195 org-tag-alist-for-agenda)
13197 (cond
13198 ((eq match t) (setq matcher t))
13199 ((eq match nil) (setq matcher t))
13200 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13202 (save-excursion
13203 (save-restriction
13204 (when (eq scope 'tree)
13205 (org-back-to-heading t)
13206 (org-narrow-to-subtree)
13207 (setq scope nil))
13209 (if (not scope)
13210 (progn
13211 (org-prepare-agenda-buffers
13212 (list (buffer-file-name (current-buffer))))
13213 (setq res (org-scan-tags func matcher)))
13214 ;; Get the right scope
13215 (cond
13216 ((and scope (listp scope) (symbolp (car scope)))
13217 (setq scope (eval scope)))
13218 ((eq scope 'agenda)
13219 (setq scope (org-agenda-files t)))
13220 ((eq scope 'agenda-with-archives)
13221 (setq scope (org-agenda-files t))
13222 (setq scope (org-add-archive-files scope)))
13223 ((eq scope 'file)
13224 (setq scope (list (buffer-file-name))))
13225 ((eq scope 'file-with-archives)
13226 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13227 (org-prepare-agenda-buffers scope)
13228 (while (setq file (pop scope))
13229 (with-current-buffer (org-find-base-buffer-visiting file)
13230 (save-excursion
13231 (save-restriction
13232 (widen)
13233 (goto-char (point-min))
13234 (setq res (append res (org-scan-tags func matcher))))))))))
13235 res))
13237 ;;;; Properties
13239 ;;; Setting and retrieving properties
13241 (defconst org-special-properties
13242 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13243 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE")
13244 "The special properties valid in Org-mode.
13246 These are properties that are not defined in the property drawer,
13247 but in some other way.")
13249 (defconst org-default-properties
13250 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13251 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13252 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13253 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13254 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13255 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13256 "Some properties that are used by Org-mode for various purposes.
13257 Being in this list makes sure that they are offered for completion.")
13260 "Regular expression matching the first line of a property drawer.")
13263 "Regular expression matching the last line of a property drawer.")
13266 "Regular expression matching the first line of a property drawer.")
13269 "Regular expression matching the first line of a property drawer.")
13271 (defconst org-property-drawer-re
13274 "Matches an entire property drawer.")
13276 (defconst org-clock-drawer-re
13279 "Matches an entire clock drawer.")
13281 (defun org-property-action ()
13282 "Do an action on properties."
13283 (interactive)
13284 (let (c)
13285 (org-at-property-p)
13286 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13287 (setq c (read-char-exclusive))
13288 (cond
13289 ((equal c ?s)
13290 (call-interactively 'org-set-property))
13291 ((equal c ?d)
13292 (call-interactively 'org-delete-property))
13293 ((equal c ?D)
13294 (call-interactively 'org-delete-property-globally))
13295 ((equal c ?c)
13296 (call-interactively 'org-compute-property-at-point))
13297 (t (error "No such property action %c" c)))))
13299 (defun org-set-effort (&optional value)
13300 "Set the effort property of the current entry.
13301 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13302 allowed value."
13303 (interactive "P")
13304 (if (equal value 0) (setq value 10))
13305 (let* ((completion-ignore-case t)
13306 (prop org-effort-property)
13307 (cur (org-entry-get nil prop))
13308 (allowed (org-property-get-allowed-values nil prop 'table))
13309 (existing (mapcar 'list (org-property-values prop)))
13310 rpl
13311 (val (cond
13312 ((stringp value) value)
13313 ((and allowed (integerp value))
13314 (or (car (nth (1- value) allowed))
13315 (car (org-last allowed))))
13316 (allowed
13317 (message "Select 1-9,0, [RET%s]: %s"
13318 (if cur (concat "=" cur) "")
13319 (mapconcat 'car allowed " "))
13320 (setq rpl (read-char-exclusive))
13322 cur
13323 (setq rpl (- rpl ?0))
13324 (if (equal rpl 0) (setq rpl 10))
13325 (if (and (> rpl 0) (<= rpl (length allowed)))
13326 (car (nth (1- rpl) allowed))
13327 (org-completing-read "Effort: " allowed nil))))
13328 (t
13329 (let (org-completion-use-ido org-completion-use-iswitchb)
13330 (org-completing-read
13332 (concat "[" cur "]") "")
13333 ": ")
13334 existing nil nil "" nil cur))))))
13335 (unless (equal (org-entry-get nil prop) val)
13336 (org-entry-put nil prop val))
13337 (message "%s is now %s" prop val)))
13339 (defun org-at-property-p ()
13340 "Is cursor inside a property drawer?"
13341 (save-excursion
13342 (beginning-of-line 1)
13344 (save-match-data ;; Used by calling procedures
13345 (let ((p (point))
13346 (range (unless (org-before-first-heading-p)
13347 (org-get-property-block))))
13348 (and range (<= (car range) p) (< p (cdr range))))))))
13350 (defun org-get-property-block (&optional beg end force)
13351 "Return the (beg . end) range of the body of the property drawer.
13352 BEG and END can be beginning and end of subtree, if not given
13353 they will be found.
13354 If the drawer does not exist and FORCE is non-nil, create the drawer."
13355 (catch 'exit
13356 (save-excursion
13357 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13358 (end (or end (progn (outline-next-heading) (point)))))
13359 (goto-char beg)
13360 (if (re-search-forward org-property-start-re end t)
13361 (setq beg (1+ (match-end 0)))
13362 (if force
13363 (save-excursion
13364 (org-insert-property-drawer)
13365 (setq end (progn (outline-next-heading) (point))))
13366 (throw 'exit nil))
13367 (goto-char beg)
13368 (if (re-search-forward org-property-start-re end t)
13369 (setq beg (1+ (match-end 0)))))
13370 (if (re-search-forward org-property-end-re end t)
13371 (setq end (match-beginning 0))
13372 (or force (throw 'exit nil))
13373 (goto-char beg)
13374 (setq end beg)
13375 (org-indent-line-function)
13377 (cons beg end)))))
13379 (defun org-entry-properties (&optional pom which specific)
13380 "Get all properties of the entry at point-or-marker POM.
13381 This includes the TODO keyword, the tags, time strings for deadline,
13382 scheduled, and clocking, and any additional properties defined in the
13383 entry. The return value is an alist, keys may occur multiple times
13384 if the property key was used several times.
13385 POM may also be nil, in which case the current entry is used.
13386 If WHICH is nil or `all', get all properties. If WHICH is
13387 `special' or `standard', only get that subclass. If WHICH
13388 is a string only get exactly this property. SPECIFIC can be a string, the
13389 specific property we are interested in. Specifying it can speed
13390 things up because then unnecessary parsing is avoided."
13391 (setq which (or which 'all))
13392 (org-with-point-at pom
13393 (let ((clockstr (substring org-clock-string 0 -1))
13394 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13395 (case-fold-search nil)
13396 beg end range props sum-props key key1 value string clocksum)
13397 (save-excursion
13398 (when (condition-case nil
13399 (and (org-mode-p) (org-back-to-heading t))
13400 (error nil))
13401 (setq beg (point))
13402 (setq sum-props (get-text-property (point) 'org-summaries))
13403 (setq clocksum (get-text-property (point) :org-clock-minutes))
13404 (outline-next-heading)
13405 (setq end (point))
13406 (when (memq which '(all special))
13407 ;; Get the special properties, like TODO and tags
13408 (goto-char beg)
13409 (when (and (or (not specific) (string= specific "TODO"))
13410 (looking-at org-todo-line-regexp) (match-end 2))
13411 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13412 (when (and (or (not specific) (string= specific "PRIORITY"))
13413 (looking-at org-priority-regexp))
13414 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13415 (when (or (not specific) (string= specific "FILE"))
13416 (push (cons "FILE" buffer-file-name) props))
13417 (when (and (or (not specific) (string= specific "TAGS"))
13418 (setq value (org-get-tags-string))
13420 (push (cons "TAGS" value) props))
13421 (when (and (or (not specific) (string= specific "ALLTAGS"))
13422 (setq value (org-get-tags-at)))
13423 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13424 ":"))
13425 props))
13426 (when (or (not specific) (string= specific "BLOCKED"))
13427 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13428 (when (or (not specific)
13429 (member specific
13430 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13431 "TIMESTAMP" "TIMESTAMP_IA")))
13432 (catch 'match
13433 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13434 (setq key (if (match-end 1)
13435 (substring (org-match-string-no-properties 1)
13436 0 -1))
13437 string (if (equal key clockstr)
13438 (org-no-properties
13439 (org-trim
13440 (buffer-substring
13441 (match-beginning 3) (goto-char
13442 (point-at-eol)))))
13443 (substring (org-match-string-no-properties 3)
13444 1 -1)))
13445 ;; Get the correct property name from the key. This is
13446 ;; necessary if the user has configured time keywords.
13447 (setq key1 (concat key ":"))
13448 (cond
13449 ((not key)
13450 (setq key
13451 (if (= (char-after (match-beginning 3)) ?\[)
13452 "TIMESTAMP_IA" "TIMESTAMP")))
13453 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13454 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13455 ((equal key1 org-closed-string) (setq key "CLOSED"))
13456 ((equal key1 org-clock-string) (setq key "CLOCK")))
13457 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13458 (progn
13459 (push (cons key string) props)
13460 ;; no need to search further if match is found
13461 (throw 'match t))
13462 (when (or (equal key "CLOCK") (not (assoc key props)))
13463 (push (cons key string) props))))))
13464 )
13466 (when (memq which '(all standard))
13467 ;; Get the standard properties, like :PROP: ...
13468 (setq range (org-get-property-block beg end))
13469 (when range
13470 (goto-char (car range))
13471 (while (re-search-forward
13473 (cdr range) t)
13474 (setq key (org-match-string-no-properties 1)
13475 value (org-trim (or (org-match-string-no-properties 2) "")))
13476 (unless (member key excluded)
13477 (push (cons key (or value "")) props)))))
13478 (if clocksum
13479 (push (cons "CLOCKSUM"
13480 (org-columns-number-to-string (/ (float clocksum) 60.)
13481 'add_times))
13482 props))
13483 (unless (assoc "CATEGORY" props)
13484 (setq value (or (org-get-category)
13485 (progn (org-refresh-category-properties)
13486 (org-get-category))))
13487 (push (cons "CATEGORY" value) props))
13488 (append sum-props (nreverse props)))))))
13490 (defun org-entry-get (pom property &optional inherit literal-nil)
13491 "Get value of PROPERTY for entry at point-or-marker POM.
13492 If INHERIT is non-nil and the entry does not have the property,
13493 then also check higher levels of the hierarchy.
13494 If INHERIT is the symbol `selective', use inheritance only if the setting
13495 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13496 If the property is present but empty, the return value is the empty string.
13497 If the property is not present at all, nil is returned.
13500 do not interpret it as the list atom nil. This is used for inheritance
13502 (org-with-point-at pom
13503 (if (and inherit (if (eq inherit 'selective)
13504 (org-property-inherit-p property)
13505 t))
13506 (org-entry-get-with-inheritance property literal-nil)
13507 (if (member property org-special-properties)
13508 ;; We need a special property. Use `org-entry-properties' to
13509 ;; retrieve it, but specify the wanted property
13510 (cdr (assoc property (org-entry-properties nil 'special property)))
13511 (let ((range (org-get-property-block)))
13512 (if (and range
13513 (goto-char (car range))
13514 (re-search-forward
13516 (cdr range) t))
13517 ;; Found the property, return it.
13518 (if (match-end 1)
13519 (if literal-nil
13520 (org-match-string-no-properties 1)
13521 (org-not-nil (org-match-string-no-properties 1)))
13522 "")))))))
13524 (defun org-property-or-variable-value (var &optional inherit)
13525 "Check if there is a property fixing the value of VAR.
13526 If yes, return this value. If not, return the current value of the variable."
13527 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13529 (read prop)
13530 (symbol-value var))))
13532 (defun org-entry-delete (pom property)
13533 "Delete the property PROPERTY from entry at point-or-marker POM."
13534 (org-with-point-at pom
13535 (if (member property org-special-properties)
13536 nil ; cannot delete these properties.
13537 (let ((range (org-get-property-block)))
13538 (if (and range
13539 (goto-char (car range))
13540 (re-search-forward
13542 (cdr range) t))
13543 (progn
13544 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13545 t)
13546 nil)))))
13548 ;; Multi-values properties are properties that contain multiple values
13549 ;; These values are assumed to be single words, separated by whitespace.
13550 (defun org-entry-add-to-multivalued-property (pom property value)
13551 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13552 (let* ((old (org-entry-get pom property))
13554 (setq value (org-entry-protect-space value))
13555 (unless (member value values)
13556 (setq values (cons value values))
13557 (org-entry-put pom property
13558 (mapconcat 'identity values " ")))))
13560 (defun org-entry-remove-from-multivalued-property (pom property value)
13561 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13562 (let* ((old (org-entry-get pom property))
13564 (setq value (org-entry-protect-space value))
13565 (when (member value values)
13566 (setq values (delete value values))
13567 (org-entry-put pom property
13568 (mapconcat 'identity values " ")))))
13570 (defun org-entry-member-in-multivalued-property (pom property value)
13571 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13572 (let* ((old (org-entry-get pom property))
13574 (setq value (org-entry-protect-space value))
13575 (member value values)))
13577 (defun org-entry-get-multivalued-property (pom property)
13578 "Return a list of values in a multivalued property."
13579 (let* ((value (org-entry-get pom property))
13581 (mapcar 'org-entry-restore-space values)))
13583 (defun org-entry-put-multivalued-property (pom property &rest values)
13584 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13585 VALUES should be a list of strings. Spaces will be protected."
13586 (org-entry-put pom property
13587 (mapconcat 'org-entry-protect-space values " "))
13588 (let* ((value (org-entry-get pom property))
13590 (mapcar 'org-entry-restore-space values)))
13592 (defun org-entry-protect-space (s)
13593 "Protect spaces and newline in string S."
13594 (while (string-match " " s)
13595 (setq s (replace-match "%20" t t s)))
13597 (setq s (replace-match "%0A" t t s)))
13598 s)
13600 (defun org-entry-restore-space (s)
13601 "Restore spaces and newline in string S."
13602 (while (string-match "%20" s)
13603 (setq s (replace-match " " t t s)))
13604 (while (string-match "%0A" s)
13606 s)
13608 (defvar org-entry-property-inherited-from (make-marker)
13609 "Marker pointing to the entry from where a property was inherited.
13610 Each call to `org-entry-get-with-inheritance' will set this marker to the
13611 location of the entry where the inheritance search matched. If there was
13612 no match, the marker will point nowhere.
13613 Note that also `org-entry-get' calls this function, if the INHERIT flag
13614 is set.")
13616 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13617 "Get entry property, and search higher levels if not present.
13618 The search will stop at the first ancestor which has the property defined.
13620 should be considered as undefined (this is the meaning of nil here).
13622 (move-marker org-entry-property-inherited-from nil)
13623 (let (tmp)
13624 (save-excursion
13625 (save-restriction
13626 (widen)
13627 (catch 'ex
13628 (while t
13629 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13630 (org-back-to-heading t)
13631 (move-marker org-entry-property-inherited-from (point))
13632 (throw 'ex tmp))
13633 (or (org-up-heading-safe) (throw 'ex nil)))))
13634 (setq tmp (or tmp
13635 (cdr (assoc property org-file-properties))
13636 (cdr (assoc property org-global-properties))
13637 (cdr (assoc property org-global-properties-fixed))))
13638 (if literal-nil tmp (org-not-nil tmp)))))
13640 (defvar org-property-changed-functions nil
13641 "Hook called when the value of a property has changed.
13642 Each hook function should accept two arguments, the name of the property
13643 and the new value.")
13645 (defun org-entry-put (pom property value)
13646 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13647 (org-with-point-at pom
13648 (org-back-to-heading t)
13649 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13650 range)
13651 (cond
13652 ((equal property "TODO")
13654 (not (member value org-todo-keywords-1)))
13656 (if (or (not value)
13658 (setq value 'none))
13659 (org-todo value)
13660 (org-set-tags nil 'align))
13661 ((equal property "PRIORITY")
13663 (string-to-char value) ?\ ))
13664 (org-set-tags nil 'align))
13665 ((equal property "SCHEDULED")
13666 (if (re-search-forward org-scheduled-time-regexp end t)
13667 (cond
13668 ((eq value 'earlier) (org-timestamp-change -1 'day))
13669 ((eq value 'later) (org-timestamp-change 1 'day))
13670 (t (call-interactively 'org-schedule)))
13671 (call-interactively 'org-schedule)))
13672 ((equal property "DEADLINE")
13673 (if (re-search-forward org-deadline-time-regexp end t)
13674 (cond
13675 ((eq value 'earlier) (org-timestamp-change -1 'day))
13676 ((eq value 'later) (org-timestamp-change 1 'day))
13677 (t (call-interactively 'org-deadline)))
13678 (call-interactively 'org-deadline)))
13679 ((member property org-special-properties)
13680 (error "The %s property can not yet be set with `org-entry-put'"
13681 property))
13682 (t ; a non-special property
13683 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13684 (setq range (org-get-property-block beg end 'force))
13685 (goto-char (car range))
13686 (if (re-search-forward
13688 (progn
13689 (delete-region (match-beginning 1) (match-end 1))
13690 (goto-char (match-beginning 1)))
13691 (goto-char (cdr range))
13693 (backward-char 1)
13694 (org-indent-line-function)
13695 (insert ":" property ":"))
13696 (and value (insert " " value))
13697 (org-indent-line-function)))))
13698 (run-hook-with-args 'org-property-changed-functions property value)))
13700 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13701 "Get all property keys in the current buffer.
13702 With INCLUDE-SPECIALS, also list the special properties that reflect things
13703 like tags and TODO state.
13704 With INCLUDE-DEFAULTS, also include properties that has special meaning
13705 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
13706 With INCLUDE-COLUMNS, also include property names given in COLUMN
13707 formats in the current buffer."
13708 (let (rtn range cfmt s p)
13709 (save-excursion
13710 (save-restriction
13711 (widen)
13712 (goto-char (point-min))
13713 (while (re-search-forward org-property-start-re nil t)
13714 (setq range (org-get-property-block))
13715 (goto-char (car range))
13716 (while (re-search-forward
13718 (cdr range) t)
13719 (add-to-list 'rtn (org-match-string-no-properties 1)))
13720 (outline-next-heading))))
13722 (when include-specials
13723 (setq rtn (append org-special-properties rtn)))
13725 (when include-defaults
13726 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13727 (add-to-list 'rtn org-effort-property))
13729 (when include-columns
13730 (save-excursion
13731 (save-restriction
13732 (widen)
13733 (goto-char (point-min))
13734 (while (re-search-forward
13736 nil t)
13737 (setq cfmt (match-string 2) s 0)
13739 cfmt s)
13740 (setq s (match-end 0)
13741 p (match-string 1 cfmt))
13742 (unless (or (equal p "ITEM")
13743 (member p org-special-properties))
13744 (add-to-list 'rtn (match-string 1 cfmt))))))))
13746 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13748 (defun org-property-values (key)
13749 "Return a list of all values of property KEY."
13750 (save-excursion
13751 (save-restriction
13752 (widen)
13753 (goto-char (point-min))
13755 values)
13756 (while (re-search-forward re nil t)
13757 (add-to-list 'values (org-trim (match-string 1))))
13758 (delete "" values)))))
13760 (defun org-insert-property-drawer ()
13761 "Insert a property drawer into the current entry."
13762 (interactive)
13763 (org-back-to-heading t)
13764 (looking-at outline-regexp)
13765 (let ((indent (if org-adapt-indentation
13766 (- (match-end 0)(match-beginning 0))
13767 0))
13768 (beg (point))
13770 end hiddenp)
13771 (outline-next-heading)
13772 (setq end (point))
13773 (goto-char beg)
13774 (while (re-search-forward re end t))
13775 (setq hiddenp (org-invisible-p))
13776 (end-of-line 1)
13779 (if (member (match-string 1) '("CLOCK:" ":END:"))
13780 ;; just skip this line
13781 (beginning-of-line 2)
13782 ;; Drawer start, find the end
13784 (beginning-of-line 1)))
13785 (org-skip-over-state-notes)
13787 (if (eq (char-before) ?*) (forward-char 1))
13789 (beginning-of-line 0)
13790 (org-indent-to-column indent)
13791 (beginning-of-line 2)
13792 (org-indent-to-column indent)
13793 (beginning-of-line 0)
13794 (if hiddenp
13795 (save-excursion
13796 (org-back-to-heading t)
13797 (hide-entry))
13798 (org-flag-drawer t))))
13800 (defun org-set-property (property value)
13801 "In the current entry, set PROPERTY to VALUE.
13802 When called interactively, this will prompt for a property name, offering
13803 completion on existing and default properties. And then it will prompt
13804 for a value, offering completion either on allowed values (via an inherited
13805 xxx_ALL property) or on existing values in other instances of this property
13806 in the current file."
13807 (interactive
13808 (let* ((completion-ignore-case t)
13809 (keys (org-buffer-property-keys nil t t))
13810 (prop0 (org-icompleting-read "Property: " (mapcar 'list keys)))
13811 (prop (if (member prop0 keys)
13812 prop0
13813 (or (cdr (assoc (downcase prop0)
13814 (mapcar (lambda (x) (cons (downcase x) x))
13815 keys)))
13816 prop0)))
13817 (cur (org-entry-get nil prop))
13818 (prompt (concat prop " value"
13820 (concat " [" cur "]") "") ": "))
13821 (allowed (org-property-get-allowed-values nil prop 'table))
13822 (existing (mapcar 'list (org-property-values prop)))
13823 (val (if allowed
13824 (org-completing-read prompt allowed nil
13825 (not (get-text-property 0 'org-unrestricted
13826 (caar allowed))))
13827 (let (org-completion-use-ido org-completion-use-iswitchb)
13828 (org-completing-read prompt existing nil nil "" nil cur)))))
13829 (list prop (if (equal val "") cur val))))
13830 (unless (equal (org-entry-get nil property) value)
13831 (org-entry-put nil property value)))
13833 (defun org-delete-property (property)
13834 "In the current entry, delete PROPERTY."
13835 (interactive
13836 (let* ((completion-ignore-case t)
13837 (prop (org-icompleting-read "Property: "
13838 (org-entry-properties nil 'standard))))
13839 (list prop)))
13840 (message "Property %s %s" property
13841 (if (org-entry-delete nil property)
13842 "deleted"
13843 "was not present in the entry")))
13845 (defun org-delete-property-globally (property)
13846 "Remove PROPERTY globally, from all entries."
13847 (interactive
13848 (let* ((completion-ignore-case t)
13849 (prop (org-icompleting-read
13850 "Globally remove property: "
13851 (mapcar 'list (org-buffer-property-keys)))))
13852 (list prop)))
13853 (save-excursion
13854 (save-restriction
13855 (widen)
13856 (goto-char (point-min))
13857 (let ((cnt 0))
13858 (while (re-search-forward
13860 nil t)
13861 (setq cnt (1+ cnt))
13862 (replace-match ""))
13865 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
13867 (defun org-compute-property-at-point ()
13868 "Compute the property at point.
13869 This looks for an enclosing column format, extracts the operator and
13870 then applies it to the property in the column format's scope."
13871 (interactive)
13872 (unless (org-at-property-p)
13873 (error "Not at a property"))
13874 (let ((prop (org-match-string-no-properties 2)))
13875 (org-columns-get-format-and-top-level)
13876 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
13877 (error "No operator defined for property %s" prop))
13878 (org-columns-compute prop)))
13880 (defvar org-property-allowed-value-functions nil
13881 "Hook for functions supplying allowed values for a specific property.
13882 The functions must take a single argument, the name of the property, and
13884 the values, this means that these values are intended as defaults for
13885 completion, but that other values should be allowed too.
13886 The functions must return nil if they are not responsible for this
13887 property.")
13889 (defun org-property-get-allowed-values (pom property &optional table)
13890 "Get allowed values for the property PROPERTY.
13891 When TABLE is non-nil, return an alist that can directly be used for
13892 completion."
13893 (let (vals)
13894 (cond
13895 ((equal property "TODO")
13896 (setq vals (org-with-point-at pom
13897 (append org-todo-keywords-1 '("")))))
13898 ((equal property "PRIORITY")
13899 (let ((n org-lowest-priority))
13900 (while (>= n org-highest-priority)
13901 (push (char-to-string n) vals)
13902 (setq n (1- n)))))
13903 ((member property org-special-properties))
13904 ((setq vals (run-hook-with-args-until-success
13905 'org-property-allowed-value-functions property)))
13906 (t
13907 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
13909 (setq vals (car (read-from-string (concat "(" vals ")"))))
13910 (setq vals (mapcar (lambda (x)
13911 (cond ((stringp x) x)
13912 ((numberp x) (number-to-string x))
13913 ((symbolp x) (symbol-name x))
13914 (t "???")))
13915 vals)))))
13916 (when (member ":ETC" vals)
13917 (setq vals (remove ":ETC" vals))
13918 (org-add-props (car vals) '(org-unrestricted t)))
13919 (if table (mapcar 'list vals) vals)))
13921 (defun org-property-previous-allowed-value (&optional previous)
13922 "Switch to the next allowed value for this property."
13923 (interactive)
13924 (org-property-next-allowed-value t))
13926 (defun org-property-next-allowed-value (&optional previous)
13927 "Switch to the next allowed value for this property."
13928 (interactive)
13929 (unless (org-at-property-p)
13930 (error "Not at a property"))
13931 (let* ((key (match-string 2))
13932 (value (match-string 3))
13933 (allowed (or (org-property-get-allowed-values (point) key)
13934 (and (member value '("[ ]" "[-]" "[X]"))
13935 '("[ ]" "[X]"))))
13936 nval)
13937 (unless allowed
13938 (error "Allowed values for this property have not been defined"))
13939 (if previous (setq allowed (reverse allowed)))
13940 (if (member value allowed)
13941 (setq nval (car (cdr (member value allowed)))))
13942 (setq nval (or nval (car allowed)))
13943 (if (equal nval value)
13944 (error "Only one allowed value for this property"))
13945 (org-at-property-p)
13946 (replace-match (concat " :" key ": " nval) t t)
13947 (org-indent-line-function)
13948 (beginning-of-line 1)
13950 (run-hook-with-args 'org-property-changed-functions key nval)))
13952 (defun org-find-olp (path &optional this-buffer)
13953 "Return a marker pointing to the entry at outline path OLP.
13954 If anything goes wrong, throw an error.
13955 You can wrap this call to catch the error like this:
13957 (condition-case msg
13958 (org-mobile-locate-entry (match-string 4))
13959 (error (nth 1 msg)))
13961 The return value will then be either a string with the error message,
13962 or a marker if everything is OK.
13964 If THIS-BUFFER is set, the outline path does not contain a file,
13965 only headings."
13966 (let* ((file (if this-buffer buffer-file-name (pop path)))
13967 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
13968 (level 1)
13969 (lmin 1)
13970 (lmax 1)
13971 limit re end found pos heading cnt)
13972 (unless buffer (error "File not found :%s" file))
13973 (with-current-buffer buffer
13974 (save-excursion
13975 (save-restriction
13976 (widen)
13977 (setq limit (point-max))
13978 (goto-char (point-min))
13979 (while (setq heading (pop path))
13980 (setq re (format org-complex-heading-regexp-format
13981 (regexp-quote heading)))
13982 (setq cnt 0 pos (point))
13983 (while (re-search-forward re end t)
13984 (setq level (- (match-end 1) (match-beginning 1)))
13985 (if (and (>= level lmin) (<= level lmax))
13986 (setq found (match-beginning 0) cnt (1+ cnt))))
13987 (when (= cnt 0) (error "Heading not found on level %d: %s"
13988 lmax heading))
13989 (when (> cnt 1) (error "Heading not unique on level %d: %s"
13990 lmax heading))
13991 (goto-char found)
13992 (setq lmin (1+ level) lmax (+ lmin (if org-odd-levels-only 1 0)))
13993 (setq end (save-excursion (org-end-of-subtree t t))))
13994 (when (org-on-heading-p)
13995 (move-marker (make-marker) (point))))))))
13997 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
13998 "Find node HEADING in BUFFER.
13999 Return a marker to the heading if it was found, or nil if not.
14000 If POS-ONLY is set, return just the position instead of a marker.
14002 The heading text must match exact, but it may have a TODO keyword,
14003 a priority cookie and tags in the standard locations."
14004 (with-current-buffer (or buffer (current-buffer))
14005 (save-excursion
14006 (save-restriction
14007 (widen)
14008 (goto-char (point-min))
14009 (let (case-fold-search)
14010 (if (re-search-forward
14011 (format org-complex-heading-regexp-format
14012 (regexp-quote heading)) nil t)
14013 (if pos-only
14014 (match-beginning 0)
14015 (move-marker (make-marker) (match-beginning 0)))))))))
14017 (defun org-find-exact-heading-in-directory (heading &optional dir)
14018 "Find Org node headline HEADING in all .org files in directory DIR.
14019 When the target headline is found, return a marker to this location."
14020 (let ((files (directory-files (or dir default-directory)
14022 file visiting m buffer)
14023 (catch 'found
14024 (while (setq file (pop files))
14025 (message "trying %s" file)
14026 (setq visiting (org-find-base-buffer-visiting file))
14027 (setq buffer (or visiting (find-file-noselect file)))
14028 (setq m (org-find-exact-headline-in-buffer
14029 heading buffer))
14030 (when (and (not m) (not visiting)) (kill-buffer buffer))
14031 (and m (throw 'found m))))))
14033 (defun org-find-entry-with-id (ident)
14034 "Locate the entry that contains the ID property with exact value IDENT.
14035 IDENT can be a string, a symbol or a number, this function will search for
14036 the string representation of it.
14037 Return the position where this entry starts, or nil if there is no such entry."
14038 (interactive "sID: ")
14039 (let ((id (cond
14040 ((stringp ident) ident)
14041 ((symbol-name ident) (symbol-name ident))
14042 ((numberp ident) (number-to-string ident))
14043 (t (error "IDENT %s must be a string, symbol or number" ident))))
14044 (case-fold-search nil))
14045 (save-excursion
14046 (save-restriction
14047 (widen)
14048 (goto-char (point-min))
14049 (when (re-search-forward
14051 nil t)
14052 (org-back-to-heading t)
14053 (point))))))
14055 ;;;; Timestamps
14057 (defvar org-last-changed-timestamp nil)
14058 (defvar org-last-inserted-timestamp nil
14059 "The last time stamp inserted with `org-insert-time-stamp'.")
14060 (defvar org-time-was-given) ; dynamically scoped parameter
14061 (defvar org-end-time-was-given) ; dynamically scoped parameter
14062 (defvar org-ts-what) ; dynamically scoped parameter
14064 (defun org-time-stamp (arg &optional inactive)
14065 "Prompt for a date/time and insert a time stamp.
14066 If the user specifies a time like HH:MM, or if this command is called
14067 with a prefix argument, the time stamp will contain date and time.
14068 Otherwise, only the date will be included. All parts of a date not
14069 specified by the user will be filled in from the current date/time.
14070 So if you press just return without typing anything, the time stamp
14071 will represent the current date/time. If there is already a timestamp
14072 at the cursor, it will be modified."
14073 (interactive "P")
14074 (let* ((ts nil)
14075 (default-time
14076 ;; Default time is either today, or, when entering a range,
14077 ;; the range start.
14078 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14079 (save-excursion
14080 (re-search-backward
14082 (- (point) 20) t)))
14083 (apply 'encode-time (org-parse-time-string (match-string 1)))
14084 (current-time)))
14085 (default-input (and ts (org-get-compact-tod ts)))
14086 org-time-was-given org-end-time-was-given time)
14087 (cond
14088 ((and (org-at-timestamp-p t)
14089 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14090 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14091 (insert "--")
14092 (setq time (let ((this-command this-command))
14093 (org-read-date arg 'totime nil nil
14094 default-time default-input)))
14095 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14096 ((org-at-timestamp-p t)
14097 (setq time (let ((this-command this-command))
14098 (org-read-date arg 'totime nil nil default-time default-input)))
14099 (when (org-at-timestamp-p t) ; just to get the match data
14100 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14101 (replace-match "")
14102 (setq org-last-changed-timestamp
14103 (org-insert-time-stamp
14104 time (or org-time-was-given arg)
14105 inactive nil nil (list org-end-time-was-given))))
14106 (message "Timestamp updated"))
14107 (t
14108 (setq time (let ((this-command this-command))
14109 (org-read-date arg 'totime nil nil default-time default-input)))
14110 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14111 nil nil (list org-end-time-was-given))))))
14113 ;; FIXME: can we use this for something else, like computing time differences?
14114 (defun org-get-compact-tod (s)
14115 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14116 (let* ((t1 (match-string 1 s))
14117 (h1 (string-to-number (match-string 2 s)))
14118 (m1 (string-to-number (match-string 3 s)))
14119 (t2 (and (match-end 4) (match-string 5 s)))
14120 (h2 (and t2 (string-to-number (match-string 6 s))))
14121 (m2 (and t2 (string-to-number (match-string 7 s))))
14122 dh dm)
14123 (if (not t2)
14124 t1
14125 (setq dh (- h2 h1) dm (- m2 m1))
14126 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14127 (concat t1 "+" (number-to-string dh)
14128 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14130 (defun org-time-stamp-inactive (&optional arg)
14131 "Insert an inactive time stamp.
14132 An inactive time stamp is enclosed in square brackets instead of angle
14133 brackets. It is inactive in the sense that it does not trigger agenda entries,
14134 does not link to the calendar and cannot be changed with the S-cursor keys.
14135 So these are more for recording a certain time/date."
14136 (interactive "P")
14137 (org-time-stamp arg 'inactive))
14139 (defvar org-date-ovl (make-overlay 1 1))
14140 (overlay-put org-date-ovl 'face 'org-warning)
14141 (org-detach-overlay org-date-ovl)
14143 (defvar org-ans1) ; dynamically scoped parameter
14144 (defvar org-ans2) ; dynamically scoped parameter
14146 (defvar org-plain-time-of-day-regexp) ; defined below
14148 (defvar org-overriding-default-time nil) ; dynamically scoped
14149 (defvar org-read-date-overlay nil)
14150 (defvar org-dcst nil) ; dynamically scoped
14151 (defvar org-read-date-history nil)
14152 (defvar org-read-date-final-answer nil)
14154 (defun org-read-date (&optional with-time to-time from-string prompt
14155 default-time default-input)
14156 "Read a date, possibly a time, and make things smooth for the user.
14157 The prompt will suggest to enter an ISO date, but you can also enter anything
14158 which will at least partially be understood by `parse-time-string'.
14159 Unrecognized parts of the date will default to the current day, month, year,
14160 hour and minute. If this command is called to replace a timestamp at point,
14161 of to enter the second timestamp of a range, the default time is taken
14162 from the existing stamp. Furthermore, the command prefers the future,
14163 so if you are giving a date where the year is not given, and the day-month
14164 combination is already past in the current year, it will assume you
14165 mean next year. For details, see the manual. A few examples:
14167 3-2-5 --> 2003-02-05
14168 feb 15 --> currentyear-02-15
14169 2/15 --> currentyear-02-15
14170 sep 12 9 --> 2009-09-12
14171 12:45 --> today 12:45
14172 22 sept 0:34 --> currentyear-09-22 0:34
14173 12 --> currentyear-currentmonth-12
14174 Fri --> nearest Friday (today or later)
14175 etc.
14177 Furthermore you can specify a relative date by giving, as the *first* thing
14178 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14179 change in days weeks, months, years.
14180 With a single plus or minus, the date is relative to today. With a double
14181 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14182 +4d --> four days from today
14183 +4 --> same as above
14184 +2w --> two weeks from today
14185 ++5 --> five days from default date
14187 The function understands only English month and weekday abbreviations,
14188 but this can be configured with the variables `parse-time-months' and
14189 `parse-time-weekdays'.
14191 While prompting, a calendar is popped up - you can also select the
14192 date with the mouse (button 1). The calendar shows a period of three
14193 months. To scroll it to other months, use the keys `>' and `<'.
14194 If you don't like the calendar, turn it off with
14195 \(setq org-read-date-popup-calendar nil)
14197 With optional argument TO-TIME, the date will immediately be converted
14198 to an internal time.
14199 With an optional argument WITH-TIME, the prompt will suggest to also
14200 insert a time. Note that when WITH-TIME is not set, you can still
14201 enter a time, and this function will inform the calling routine about
14202 this change. The calling routine may then choose to change the format
14203 used to insert the time stamp into the buffer to include the time.
14204 With optional argument FROM-STRING, read from this string instead from
14205 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14206 the time/date that is used for everything that is not specified by the
14207 user."
14208 (require 'parse-time)
14209 (let* ((org-time-stamp-rounding-minutes
14210 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14211 (org-dcst org-display-custom-times)
14212 (ct (org-current-time))
14213 (def (or org-overriding-default-time default-time ct))
14214 (defdecode (decode-time def))
14215 (dummy (progn
14216 (when (< (nth 2 defdecode) org-extend-today-until)
14217 (setcar (nthcdr 2 defdecode) -1)
14218 (setcar (nthcdr 1 defdecode) 59)
14219 (setq def (apply 'encode-time defdecode)
14220 defdecode (decode-time def)))))
14221 (calendar-frame-setup nil)
14222 (calendar-setup nil)
14223 (calendar-move-hook nil)
14224 (calendar-view-diary-initially-flag nil)
14225 (calendar-view-holidays-initially-flag nil)
14226 (timestr (format-time-string
14227 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14228 (prompt (concat (if prompt (concat prompt " ") "")
14229 (format "Date+time [%s]: " timestr)))
14230 ans (org-ans0 "") org-ans1 org-ans2 final)
14232 (cond
14233 (from-string (setq ans from-string))
14234 (org-read-date-popup-calendar
14235 (save-excursion
14236 (save-window-excursion
14237 (calendar)
14238 (calendar-forward-day (- (time-to-days def)
14239 (calendar-absolute-from-gregorian
14240 (calendar-current-date))))
14241 (org-eval-in-calendar nil t)
14242 (let* ((old-map (current-local-map))
14243 (map (copy-keymap calendar-mode-map))
14244 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14245 (org-defkey map (kbd "RET") 'org-calendar-select)
14246 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14247 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14248 (org-defkey minibuffer-local-map [(meta shift left)]
14249 (lambda () (interactive)
14250 (org-eval-in-calendar '(calendar-backward-month 1))))
14251 (org-defkey minibuffer-local-map [(meta shift right)]
14252 (lambda () (interactive)
14253 (org-eval-in-calendar '(calendar-forward-month 1))))
14254 (org-defkey minibuffer-local-map [(meta shift up)]
14255 (lambda () (interactive)
14256 (org-eval-in-calendar '(calendar-backward-year 1))))
14257 (org-defkey minibuffer-local-map [(meta shift down)]
14258 (lambda () (interactive)
14259 (org-eval-in-calendar '(calendar-forward-year 1))))
14260 (org-defkey minibuffer-local-map [?\e (shift left)]
14261 (lambda () (interactive)
14262 (org-eval-in-calendar '(calendar-backward-month 1))))
14263 (org-defkey minibuffer-local-map [?\e (shift right)]
14264 (lambda () (interactive)
14265 (org-eval-in-calendar '(calendar-forward-month 1))))
14266 (org-defkey minibuffer-local-map [?\e (shift up)]
14267 (lambda () (interactive)
14268 (org-eval-in-calendar '(calendar-backward-year 1))))
14269 (org-defkey minibuffer-local-map [?\e (shift down)]
14270 (lambda () (interactive)
14271 (org-eval-in-calendar '(calendar-forward-year 1))))
14272 (org-defkey minibuffer-local-map [(shift up)]
14273 (lambda () (interactive)
14274 (org-eval-in-calendar '(calendar-backward-week 1))))
14275 (org-defkey minibuffer-local-map [(shift down)]
14276 (lambda () (interactive)
14277 (org-eval-in-calendar '(calendar-forward-week 1))))
14278 (org-defkey minibuffer-local-map [(shift left)]
14279 (lambda () (interactive)
14280 (org-eval-in-calendar '(calendar-backward-day 1))))
14281 (org-defkey minibuffer-local-map [(shift right)]
14282 (lambda () (interactive)
14283 (org-eval-in-calendar '(calendar-forward-day 1))))
14284 (org-defkey minibuffer-local-map ">"
14285 (lambda () (interactive)
14286 (org-eval-in-calendar '(scroll-calendar-left 1))))
14287 (org-defkey minibuffer-local-map "<"
14288 (lambda () (interactive)
14289 (org-eval-in-calendar '(scroll-calendar-right 1))))
14290 (org-defkey minibuffer-local-map "\C-v"
14291 (lambda () (interactive)
14292 (org-eval-in-calendar
14293 '(calendar-scroll-left-three-months 1))))
14294 (org-defkey minibuffer-local-map "\M-v"
14295 (lambda () (interactive)
14296 (org-eval-in-calendar
14297 '(calendar-scroll-right-three-months 1))))
14298 (run-hooks 'org-read-date-minibuffer-setup-hook)
14299 (unwind-protect
14300 (progn
14301 (use-local-map map)
14302 (add-hook 'post-command-hook 'org-read-date-display)
14303 (setq org-ans0 (read-string prompt default-input
14304 'org-read-date-history nil))
14305 ;; org-ans0: from prompt
14306 ;; org-ans1: from mouse click
14307 ;; org-ans2: from calendar motion
14308 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14309 (remove-hook 'post-command-hook 'org-read-date-display)
14310 (use-local-map old-map)
14311 (when org-read-date-overlay
14312 (delete-overlay org-read-date-overlay)
14313 (setq org-read-date-overlay nil)))))))
14315 (t ; Naked prompt only
14316 (unwind-protect
14317 (setq ans (read-string prompt default-input
14318 'org-read-date-history timestr))
14319 (when org-read-date-overlay
14320 (delete-overlay org-read-date-overlay)
14321 (setq org-read-date-overlay nil)))))
14323 (setq final (org-read-date-analyze ans def defdecode))
14325 ;; One round trip to get rid of 34th of August and stuff like that....
14326 (setq final (decode-time (apply 'encode-time final)))
14328 (setq org-read-date-final-answer ans)
14330 (if to-time
14331 (apply 'encode-time final)
14332 (if (and (boundp 'org-time-was-given) org-time-was-given)
14333 (format "%04d-%02d-%02d %02d:%02d"
14334 (nth 5 final) (nth 4 final) (nth 3 final)
14335 (nth 2 final) (nth 1 final))
14336 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14338 (defvar def)
14339 (defvar defdecode)
14340 (defvar with-time)
14341 (defvar org-read-date-analyze-futurep nil)
14342 (defun org-read-date-display ()
14343 "Display the current date prompt interpretation in the minibuffer."
14344 (when org-read-date-display-live
14345 (when org-read-date-overlay
14346 (delete-overlay org-read-date-overlay))
14347 (let ((p (point)))
14348 (end-of-line 1)
14349 (while (not (equal (buffer-substring
14350 (max (point-min) (- (point) 4)) (point))
14351 " "))
14352 (insert " "))
14353 (goto-char p))
14354 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14355 " " (or org-ans1 org-ans2)))
14356 (org-end-time-was-given nil)
14357 (f (org-read-date-analyze ans def defdecode))
14358 (fmts (if org-dcst
14359 org-time-stamp-custom-formats
14360 org-time-stamp-formats))
14361 (fmt (if (or with-time
14362 (and (boundp 'org-time-was-given) org-time-was-given))
14363 (cdr fmts)
14364 (car fmts)))
14365 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14366 (when (and org-end-time-was-given
14367 (string-match org-plain-time-of-day-regexp txt))
14368 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14369 org-end-time-was-given
14370 (substring txt (match-end 0)))))
14371 (when org-read-date-analyze-futurep
14372 (setq txt (concat txt " (=>F)")))
14373 (setq org-read-date-overlay
14374 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14375 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14377 (defun org-read-date-analyze (ans def defdecode)
14378 "Analyze the combined answer of the date prompt."
14379 ;; FIXME: cleanup and comment
14380 (let ((nowdecode (decode-time (current-time)))
14381 delta deltan deltaw deltadef year month day
14382 hour minute second wday pm h2 m2 tl wday1
14383 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14384 (setq org-read-date-analyze-futurep nil)
14386 (setq ans "+0"))
14388 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14389 (setq ans (replace-match "" t t ans)
14390 deltan (car delta)
14391 deltaw (nth 1 delta)
14392 deltadef (nth 2 delta)))
14394 ;; Check if there is an iso week date in there
14395 ;; If yes, store the info and postpone interpreting it until the rest
14396 ;; of the parsing is done
14397 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14398 (setq iso-year (if (match-end 1)
14399 (org-small-year-to-year
14400 (string-to-number (match-string 1 ans))))
14401 iso-weekday (if (match-end 3)
14402 (string-to-number (match-string 3 ans)))
14403 iso-week (string-to-number (match-string 2 ans)))
14404 (setq ans (replace-match "" t t ans)))
14406 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14407 (when (string-match
14409 (setq year (if (match-end 2)
14410 (string-to-number (match-string 2 ans))
14411 (progn (setq kill-year t)
14412 (string-to-number (format-time-string "%Y"))))
14413 month (string-to-number (match-string 3 ans))
14414 day (string-to-number (match-string 4 ans)))
14415 (if (< year 100) (setq year (+ 2000 year)))
14417 t nil ans)))
14418 ;; Help matching american dates, like 5/30 or 5/30/7
14419 (when (string-match
14420 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14421 (setq year (if (match-end 4)
14422 (string-to-number (match-string 4 ans))
14423 (progn (setq kill-year t)
14424 (string-to-number (format-time-string "%Y"))))
14425 month (string-to-number (match-string 1 ans))
14426 day (string-to-number (match-string 2 ans)))
14427 (if (< year 100) (setq year (+ 2000 year)))
14429 t nil ans)))
14430 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14431 ;; If there is a time with am/pm, and *no* time without it, we convert
14432 ;; so that matching will be successful.
14433 (loop for i from 1 to 2 do ; twice, for end time as well
14436 (setq hour (string-to-number (match-string 1 ans))
14437 minute (if (match-end 3)
14438 (string-to-number (match-string 3 ans))
14439 0)
14440 pm (equal ?p
14441 (string-to-char (downcase (match-string 4 ans)))))
14442 (if (and (= hour 12) (not pm))
14443 (setq hour 0)
14444 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14445 (setq ans (replace-match (format "%02d:%02d" hour minute)
14446 t t ans))))
14448 ;; Check if a time range is given as a duration
14449 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14450 (setq hour (string-to-number (match-string 1 ans))
14451 h2 (+ hour (string-to-number (match-string 3 ans)))
14452 minute (string-to-number (match-string 2 ans))
14453 m2 (+ minute (if (match-end 5) (string-to-number
14454 (match-string 5 ans))0)))
14455 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14456 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14457 t t ans)))
14459 ;; Check if there is a time range
14460 (when (boundp 'org-end-time-was-given)
14461 (setq org-time-was-given nil)
14462 (when (and (string-match org-plain-time-of-day-regexp ans)
14463 (match-end 8))
14464 (setq org-end-time-was-given (match-string 8 ans))
14465 (setq ans (concat (substring ans 0 (match-beginning 7))
14466 (substring ans (match-end 7))))))
14468 (setq tl (parse-time-string ans)
14469 day (or (nth 3 tl) (nth 3 defdecode))
14470 month (or (nth 4 tl)
14471 (if (and org-read-date-prefer-future
14472 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14473 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14474 (nth 4 defdecode)))
14475 year (or (and (not kill-year) (nth 5 tl))
14476 (if (and org-read-date-prefer-future
14477 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14478 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14479 (nth 5 defdecode)))
14480 hour (or (nth 2 tl) (nth 2 defdecode))
14481 minute (or (nth 1 tl) (nth 1 defdecode))
14482 second (or (nth 0 tl) 0)
14483 wday (nth 6 tl))
14485 (when (and (eq org-read-date-prefer-future 'time)
14486 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14487 (equal day (nth 3 nowdecode))
14488 (equal month (nth 4 nowdecode))
14489 (equal year (nth 5 nowdecode))
14490 (nth 2 tl)
14491 (or (< (nth 2 tl) (nth 2 nowdecode))
14492 (and (= (nth 2 tl) (nth 2 nowdecode))
14493 (nth 1 tl)
14494 (< (nth 1 tl) (nth 1 nowdecode)))))
14495 (setq day (1+ day)
14496 futurep t))
14498 ;; Special date definitions below
14499 (cond
14500 (iso-week
14501 ;; There was an iso week
14502 (require 'cal-iso)
14503 (setq futurep nil)
14504 (setq year (or iso-year year)
14505 day (or iso-weekday wday 1)
14506 wday nil ; to make sure that the trigger below does not match
14507 iso-date (calendar-gregorian-from-absolute
14508 (calendar-absolute-from-iso
14509 (list iso-week day year))))
14510 ; FIXME: Should we also push ISO weeks into the future?
14511 ; (when (and org-read-date-prefer-future
14512 ; (not iso-year)
14513 ; (< (calendar-absolute-from-gregorian iso-date)
14514 ; (time-to-days (current-time))))
14515 ; (setq year (1+ year)
14516 ; iso-date (calendar-gregorian-from-absolute
14517 ; (calendar-absolute-from-iso
14518 ; (list iso-week day year)))))
14519 (setq month (car iso-date)
14520 year (nth 2 iso-date)
14521 day (nth 1 iso-date)))
14522 (deltan
14523 (setq futurep nil)
14524 (unless deltadef
14525 (let ((now (decode-time (current-time))))
14526 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14527 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14528 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14529 ((equal deltaw "m") (setq month (+ month deltan)))
14530 ((equal deltaw "y") (setq year (+ year deltan)))))
14531 ((and wday (not (nth 3 tl)))
14532 (setq futurep nil)
14533 ;; Weekday was given, but no day, so pick that day in the week
14534 ;; on or after the derived date.
14535 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14536 (unless (equal wday wday1)
14537 (setq day (+ day (% (- wday wday1 -7) 7))))))
14538 (if (and (boundp 'org-time-was-given)
14539 (nth 2 tl))
14540 (setq org-time-was-given t))
14541 (if (< year 100) (setq year (+ 2000 year)))
14542 (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
14543 (setq org-read-date-analyze-futurep futurep)
14544 (list second minute hour day month year)))
14546 (defvar parse-time-weekdays)
14548 (defun org-read-date-get-relative (s today default)
14549 "Check string S for special relative date string.
14550 TODAY and DEFAULT are internal times, for today and for a default.
14551 Return shift list (N what def-flag)
14553 N is the number of WHATs to shift.
14554 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14555 the DEFAULT date rather than TODAY."
14556 (when (and
14557 (string-match
14558 (concat
14563 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14564 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14565 (string-to-char (substring (match-string 1 s) -1))
14566 ?+))
14567 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14568 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14569 (what (if (match-end 3) (match-string 3 s) "d"))
14570 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14571 (date (if rel default today))
14572 (wday (nth 6 (decode-time date)))
14573 delta)
14574 (if wday1
14575 (progn
14576 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14577 (if (= dir ?-) (setq delta (- delta 7)))
14578 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14579 (list delta "d" rel))
14580 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14582 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14583 "Turn a user-specified date into the internal representation.
14584 The internal representation needed by the calendar is (month day year).
14585 This is a wrapper to handle the brain-dead convention in calendar that
14586 user function argument order change dependent on argument order."
14587 (if (boundp 'calendar-date-style)
14588 (cond
14589 ((eq calendar-date-style 'american)
14590 (list arg1 arg2 arg3))
14591 ((eq calendar-date-style 'european)
14592 (list arg2 arg1 arg3))
14593 ((eq calendar-date-style 'iso)
14594 (list arg2 arg3 arg1)))
14595 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
14596 (if (org-bound-and-true-p european-calendar-style)
14597 (list arg2 arg1 arg3)
14598 (list arg1 arg2 arg3)))))
14600 (defun org-eval-in-calendar (form &optional keepdate)
14601 "Eval FORM in the calendar window and return to current window.
14602 Also, store the cursor date in variable org-ans2."
14603 (let ((sf (selected-frame))
14604 (sw (selected-window)))
14605 (select-window (get-buffer-window "*Calendar*" t))
14606 (eval form)
14607 (when (and (not keepdate) (calendar-cursor-to-date))
14608 (let* ((date (calendar-cursor-to-date))
14609 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14610 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
14611 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
14612 (select-window sw)
14613 (org-select-frame-set-input-focus sf)))
14615 (defun org-calendar-select ()
14616 "Return to `org-read-date' with the date currently selected.
14617 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14618 (interactive)
14619 (when (calendar-cursor-to-date)
14620 (let* ((date (calendar-cursor-to-date))
14621 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14622 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14623 (if (active-minibuffer-window) (exit-minibuffer))))
14625 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
14626 "Insert a date stamp for the date given by the internal TIME.
14627 WITH-HM means use the stamp format that includes the time of the day.
14628 INACTIVE means use square brackets instead of angular ones, so that the
14629 stamp will not contribute to the agenda.
14630 PRE and POST are optional strings to be inserted before and after the
14631 stamp.
14632 The command returns the inserted time stamp."
14633 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
14634 stamp)
14635 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
14636 (insert-before-markers (or pre ""))
14637 (when (listp extra)
14638 (setq extra (car extra))
14639 (if (and (stringp extra)
14641 (setq extra (format "-%02d:%02d"
14642 (string-to-number (match-string 1 extra))
14643 (string-to-number (match-string 2 extra))))
14644 (setq extra nil)))
14645 (when extra
14646 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
14647 (insert-before-markers (setq stamp (format-time-string fmt time)))
14648 (insert-before-markers (or post ""))
14649 (setq org-last-inserted-timestamp stamp)))
14651 (defun org-toggle-time-stamp-overlays ()
14652 "Toggle the use of custom time stamp formats."
14653 (interactive)
14654 (setq org-display-custom-times (not org-display-custom-times))
14655 (unless org-display-custom-times
14656 (let ((p (point-min)) (bmp (buffer-modified-p)))
14657 (while (setq p (next-single-property-change p 'display))
14658 (if (and (get-text-property p 'display)
14659 (eq (get-text-property p 'face) 'org-date))
14660 (remove-text-properties
14661 p (setq p (next-single-property-change p 'display))
14662 '(display t))))
14663 (set-buffer-modified-p bmp)))
14664 (if (featurep 'xemacs)
14665 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
14666 (org-restart-font-lock)
14667 (setq org-table-may-need-update t)
14668 (if org-display-custom-times
14669 (message "Time stamps are overlayed with custom format")
14670 (message "Time stamp overlays removed")))
14672 (defun org-display-custom-time (beg end)
14673 "Overlay modified time stamp format over timestamp between BEG and END."
14674 (let* ((ts (buffer-substring beg end))
14675 t1 w1 with-hm tf time str w2 (off 0))
14676 (save-match-data
14677 (setq t1 (org-parse-time-string ts t))
14678 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
14679 (setq off (- (match-end 0) (match-beginning 0)))))
14680 (setq end (- end off))
14681 (setq w1 (- end beg)
14682 with-hm (and (nth 1 t1) (nth 2 t1))
14683 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
14684 time (org-fix-decoded-time t1)
14685 str (org-add-props
14686 (format-time-string
14687 (substring tf 1 -1) (apply 'encode-time time))
14688 nil 'mouse-face 'highlight)
14689 w2 (length str))
14690 (if (not (= w2 w1))
14691 (add-text-properties (1+ beg) (+ 2 beg)
14692 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
14693 (if (featurep 'xemacs)
14694 (progn
14695 (put-text-property beg end 'invisible t)
14696 (put-text-property beg end 'end-glyph (make-glyph str)))
14697 (put-text-property beg end 'display str))))
14699 (defun org-translate-time (string)
14700 "Translate all timestamps in STRING to custom format.
14701 But do this only if the variable `org-display-custom-times' is set."
14702 (when org-display-custom-times
14703 (save-match-data
14704 (let* ((start 0)
14705 (re org-ts-regexp-both)
14706 t1 with-hm inactive tf time str beg end)
14707 (while (setq start (string-match re string start))
14708 (setq beg (match-beginning 0)
14709 end (match-end 0)
14710 t1 (save-match-data
14711 (org-parse-time-string (substring string beg end) t))
14712 with-hm (and (nth 1 t1) (nth 2 t1))
14713 inactive (equal (substring string beg (1+ beg)) "[")
14714 tf (funcall (if with-hm 'cdr 'car)
14715 org-time-stamp-custom-formats)
14716 time (org-fix-decoded-time t1)
14717 str (format-time-string
14718 (concat
14719 (if inactive "[" "<") (substring tf 1 -1)
14720 (if inactive "]" ">"))
14721 (apply 'encode-time time))
14722 string (replace-match str t t string)
14723 start (+ start (length str)))))))
14724 string)
14726 (defun org-fix-decoded-time (time)
14727 "Set 0 instead of nil for the first 6 elements of time.
14728 Don't touch the rest."
14729 (let ((n 0))
14730 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
14732 (defun org-days-to-time (timestamp-string)
14733 "Difference between TIMESTAMP-STRING and now in days."
14734 (- (time-to-days (org-time-string-to-time timestamp-string))
14735 (time-to-days (current-time))))
14737 (defun org-deadline-close (timestamp-string &optional ndays)
14738 "Is the time in TIMESTAMP-STRING close to the current date?"
14739 (setq ndays (or ndays (org-get-wdays timestamp-string)))
14740 (and (< (org-days-to-time timestamp-string) ndays)
14741 (not (org-entry-is-done-p))))
14743 (defun org-get-wdays (ts)
14744 "Get the deadline lead time appropriate for timestring TS."
14745 (cond
14746 ((<= org-deadline-warning-days 0)
14747 ;; 0 or negative, enforce this value no matter what
14748 (- org-deadline-warning-days))
14750 ;; lead time is specified.
14751 (floor (* (string-to-number (match-string 1 ts))
14752 (cdr (assoc (match-string 2 ts)
14753 '(("d" . 1) ("w" . 7)
14754 ("m" . 30.4) ("y" . 365.25)))))))
14755 ;; go for the default.
14756 (t org-deadline-warning-days)))
14758 (defun org-calendar-select-mouse (ev)
14759 "Return to `org-read-date' with the date currently selected.
14760 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14761 (interactive "e")
14762 (mouse-set-point ev)
14763 (when (calendar-cursor-to-date)
14764 (let* ((date (calendar-cursor-to-date))
14765 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14766 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14767 (if (active-minibuffer-window) (exit-minibuffer))))
14769 (defun org-check-deadlines (ndays)
14770 "Check if there are any deadlines due or past due.
14771 A deadline is considered due if it happens within `org-deadline-warning-days'
14772 days from today's date. If the deadline appears in an entry marked DONE,
14773 it is not shown. The prefix arg NDAYS can be used to test that many
14775 (interactive "P")
14776 (let* ((org-warn-days
14777 (cond
14778 ((equal ndays '(4)) 100000)
14779 (ndays (prefix-numeric-value ndays))
14780 (t (abs org-deadline-warning-days))))
14781 (case-fold-search nil)
14783 (callback
14784 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
14786 (message "%d deadlines past-due or due within %d days"
14787 (org-occur regexp nil callback)
14788 org-warn-days)))
14790 (defun org-check-before-date (date)
14791 "Check if there are deadlines or scheduled entries before DATE."
14792 (interactive (list (org-read-date)))
14793 (let ((case-fold-search nil)
14797 (callback
14798 (lambda () (time-less-p
14799 (org-time-string-to-time (match-string 2))
14800 (org-time-string-to-time date)))))
14801 (message "%d entries before %s"
14802 (org-occur regexp nil callback) date)))
14804 (defun org-check-after-date (date)
14805 "Check if there are deadlines or scheduled entries after DATE."
14806 (interactive (list (org-read-date)))
14807 (let ((case-fold-search nil)
14811 (callback
14812 (lambda () (not
14813 (time-less-p
14814 (org-time-string-to-time (match-string 2))
14815 (org-time-string-to-time date))))))
14816 (message "%d entries after %s"
14817 (org-occur regexp nil callback) date)))
14819 (defun org-evaluate-time-range (&optional to-buffer)
14820 "Evaluate a time range by computing the difference between start and end.
14821 Normally the result is just printed in the echo area, but with prefix arg
14822 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
14823 If the time range is actually in a table, the result is inserted into the
14824 next column.
14825 For time difference computation, a year is assumed to be exactly 365
14826 days in order to avoid rounding problems."
14827 (interactive "P")
14828 (or
14829 (org-clock-update-time-maybe)
14830 (save-excursion
14831 (unless (org-at-date-range-p t)
14832 (goto-char (point-at-bol))
14833 (re-search-forward org-tr-regexp-both (point-at-eol) t))
14834 (if (not (org-at-date-range-p t))
14835 (error "Not at a time-stamp range, and none found in current line")))
14836 (let* ((ts1 (match-string 1))
14837 (ts2 (match-string 2))
14838 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
14839 (match-end (match-end 0))
14840 (time1 (org-time-string-to-time ts1))
14841 (time2 (org-time-string-to-time ts2))
14842 (t1 (org-float-time time1))
14843 (t2 (org-float-time time2))
14844 (diff (abs (- t2 t1)))
14845 (negative (< (- t2 t1) 0))
14846 ;; (ys (floor (* 365 24 60 60)))
14847 (ds (* 24 60 60))
14848 (hs (* 60 60))
14849 (fy "%dy %dd %02d:%02d")
14850 (fy1 "%dy %dd")
14851 (fd "%dd %02d:%02d")
14852 (fd1 "%dd")
14853 (fh "%02d:%02d")
14854 y d h m align)
14855 (if havetime
14856 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14857 y 0
14858 d (floor (/ diff ds)) diff (mod diff ds)
14859 h (floor (/ diff hs)) diff (mod diff hs)
14860 m (floor (/ diff 60)))
14861 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14862 y 0
14863 d (floor (+ (/ diff ds) 0.5))
14864 h 0 m 0))
14865 (if (not to-buffer)
14866 (message "%s" (org-make-tdiff-string y d h m))
14867 (if (org-at-table-p)
14868 (progn
14869 (goto-char match-end)
14870 (setq align t)
14871 (and (looking-at " *|") (goto-char (match-end 0))))
14872 (goto-char match-end))
14873 (if (looking-at
14875 (replace-match ""))
14876 (if negative (insert " -"))
14877 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
14878 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
14879 (insert " " (format fh h m))))
14880 (if align (org-table-align))
14881 (message "Time difference inserted")))))
14883 (defun org-make-tdiff-string (y d h m)
14884 (let ((fmt "")
14885 (l nil))
14886 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
14887 l (push y l)))
14888 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
14889 l (push d l)))
14890 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
14891 l (push h l)))
14892 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
14893 l (push m l)))
14894 (apply 'format fmt (nreverse l))))
14896 (defun org-time-string-to-time (s)
14897 (apply 'encode-time (org-parse-time-string s)))
14898 (defun org-time-string-to-seconds (s)
14899 (org-float-time (org-time-string-to-time s)))
14901 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
14902 "Convert a time stamp to an absolute day number.
14903 If there is a specifier for a cyclic time stamp, get the closest date to
14904 DAYNR.
14905 PREFER and SHOW-ALL are passed through to `org-closest-date'.
14906 the variable date is bound by the calendar when this is called."
14907 (cond
14909 (if (org-diary-sexp-entry (match-string 1 s) "" date)
14910 daynr
14911 (+ daynr 1000)))
14913 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
14914 (time-to-days (current-time))) (match-string 0 s)
14915 prefer show-all))
14916 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
14918 (defun org-days-to-iso-week (days)
14919 "Return the iso week number."
14920 (require 'cal-iso)
14921 (car (calendar-iso-from-absolute days)))
14923 (defun org-small-year-to-year (year)
14924 "Convert 2-digit years into 4-digit years.
14925 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
14926 The year 2000 cannot be abbreviated. Any year larger than 99
14927 is returned unchanged."
14928 (if (< year 38)
14929 (setq year (+ 2000 year))
14930 (if (< year 100)
14931 (setq year (+ 1900 year))))
14932 year)
14934 (defun org-time-from-absolute (d)
14935 "Return the time corresponding to date D.
14936 D may be an absolute day number, or a calendar-type list (month day year)."
14937 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
14938 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
14940 (defun org-calendar-holiday ()
14941 "List of holidays, for Diary display in Org-mode."
14942 (require 'holidays)
14943 (let ((hl (funcall
14944 (if (fboundp 'calendar-check-holidays)
14945 'calendar-check-holidays 'check-calendar-holidays) date)))
14946 (if hl (mapconcat 'identity hl "; "))))
14948 (defun org-diary-sexp-entry (sexp entry date)
14949 "Process a SEXP diary ENTRY for DATE."
14950 (require 'diary-lib)
14951 (let ((result (if calendar-debug-sexp
14952 (let ((stack-trace-on-error t))
14953 (eval (car (read-from-string sexp))))
14954 (condition-case nil
14955 (eval (car (read-from-string sexp)))
14956 (error
14957 (beep)
14958 (message "Bad sexp at line %d in %s: %s"
14959 (org-current-line)
14960 (buffer-file-name) sexp)
14961 (sleep-for 2))))))
14962 (cond ((stringp result) (split-string result "; "))
14963 ((and (consp result)
14964 (not (consp (cdr result)))
14965 (stringp (cdr result))) (cdr result))
14966 ((and (consp result)
14967 (stringp (car result))) result)
14968 (result entry)
14969 (t nil))))
14971 (defun org-diary-to-ical-string (frombuf)
14972 "Get iCalendar entries from diary entries in buffer FROMBUF.
14973 This uses the icalendar.el library."
14974 (let* ((tmpdir (if (featurep 'xemacs)
14975 (temp-directory)
14976 temporary-file-directory))
14977 (tmpfile (make-temp-name
14978 (expand-file-name "orgics" tmpdir)))
14979 buf rtn b e)
14980 (with-current-buffer frombuf
14981 (icalendar-export-region (point-min) (point-max) tmpfile)
14982 (setq buf (find-buffer-visiting tmpfile))
14983 (set-buffer buf)
14984 (goto-char (point-min))
14985 (if (re-search-forward "^BEGIN:VEVENT" nil t)
14986 (setq b (match-beginning 0)))
14987 (goto-char (point-max))
14988 (if (re-search-backward "^END:VEVENT" nil t)
14989 (setq e (match-end 0)))
14991 (kill-buffer buf)
14992 (delete-file tmpfile)
14993 rtn))
14995 (defun org-closest-date (start current change prefer show-all)
14996 "Find the date closest to CURRENT that is consistent with START and CHANGE.
14997 When PREFER is `past' return a date that is either CURRENT or past.
14998 When PREFER is `future', return a date that is either CURRENT or future.
14999 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15000 ;; Make the proper lists from the dates
15001 (catch 'exit
15002 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15003 dn dw sday cday n1 n2 n0
15004 d m y y1 y2 date1 date2 nmonths nm ny m2)
15006 (setq start (org-date-to-gregorian start)
15007 current (org-date-to-gregorian
15008 (if show-all
15009 current
15010 (time-to-days (current-time))))
15011 sday (calendar-absolute-from-gregorian start)
15012 cday (calendar-absolute-from-gregorian current))
15014 (if (<= cday sday) (throw 'exit sday))
15017 (setq dn (string-to-number (match-string 1 change))
15018 dw (cdr (assoc (match-string 2 change) a1)))
15019 (error "Invalid change specifier: %s" change))
15020 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15021 (cond
15022 ((eq dw 'day)
15023 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15024 n2 (+ n1 dn)))
15025 ((eq dw 'year)
15026 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15027 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15028 (setq date1 (list m d y1)
15029 n1 (calendar-absolute-from-gregorian date1)
15030 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15031 n2 (calendar-absolute-from-gregorian date2)))
15032 ((eq dw 'month)
15033 ;; approx number of month between the two dates
15034 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15035 ;; How often does dn fit in there?
15036 (setq d (nth 1 start) m (car start) y (nth 2 start)
15037 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15038 m (+ m nm)
15039 ny (floor (/ m 12))
15040 y (+ y ny)
15041 m (- m (* ny 12)))
15042 (while (> m 12) (setq m (- m 12) y (1+ y)))
15043 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15044 (setq m2 (+ m dn) y2 y)
15045 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15046 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15047 (while (<= n2 cday)
15048 (setq n1 n2 m m2 y y2)
15049 (setq m2 (+ m dn) y2 y)
15050 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15051 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15052 ;; Make sure n1 is the earlier date
15053 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15054 (if show-all
15055 (cond
15056 ((eq prefer 'past) (if (= cday n2) n2 n1))
15057 ((eq prefer 'future) (if (= cday n1) n1 n2))
15058 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15059 (cond
15060 ((eq prefer 'past) (if (= cday n2) n2 n1))
15061 ((eq prefer 'future) (if (= cday n1) n1 n2))
15062 (t (if (= cday n1) n1 n2)))))))
15064 (defun org-date-to-gregorian (date)
15065 "Turn any specification of DATE into a Gregorian date for the calendar."
15066 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15067 ((and (listp date) (= (length date) 3)) date)
15068 ((stringp date)
15069 (setq date (org-parse-time-string date))
15070 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15071 ((listp date)
15072 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15074 (defun org-parse-time-string (s &optional nodefault)
15075 "Parse the standard Org-mode time string.
15076 This should be a lot faster than the normal `parse-time-string'.
15077 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15078 hour and minute fields will be nil if not given."
15079 (if (string-match org-ts-regexp0 s)
15080 (list 0
15081 (if (or (match-beginning 8) (not nodefault))
15082 (string-to-number (or (match-string 8 s) "0")))
15083 (if (or (match-beginning 7) (not nodefault))
15084 (string-to-number (or (match-string 7 s) "0")))
15085 (string-to-number (match-string 4 s))
15086 (string-to-number (match-string 3 s))
15087 (string-to-number (match-string 2 s))
15088 nil nil nil)
15089 (error "Not a standard Org-mode time string: %s" s)))
15091 (defun org-timestamp-up (&optional arg)
15092 "Increase the date item at the cursor by one.
15093 If the cursor is on the year, change the year. If it is on the month or
15094 the day, change that.
15095 With prefix ARG, change by that many units."
15096 (interactive "p")
15097 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15099 (defun org-timestamp-down (&optional arg)
15100 "Decrease the date item at the cursor by one.
15101 If the cursor is on the year, change the year. If it is on the month or
15102 the day, change that.
15103 With prefix ARG, change by that many units."
15104 (interactive "p")
15105 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15107 (defun org-timestamp-up-day (&optional arg)
15108 "Increase the date in the time stamp by one day.
15109 With prefix ARG, change that many days."
15110 (interactive "p")
15111 (if (and (not (org-at-timestamp-p t))
15112 (org-on-heading-p))
15113 (org-todo 'up)
15114 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15116 (defun org-timestamp-down-day (&optional arg)
15117 "Decrease the date in the time stamp by one day.
15118 With prefix ARG, change that many days."
15119 (interactive "p")
15120 (if (and (not (org-at-timestamp-p t))
15121 (org-on-heading-p))
15122 (org-todo 'down)
15123 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15125 (defun org-at-timestamp-p (&optional inactive-ok)
15126 "Determine if the cursor is in or at a timestamp."
15127 (interactive)
15128 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15129 (pos (point))
15130 (ans (or (looking-at tsr)
15131 (save-excursion
15133 (if (> (point) (point-min)) (backward-char 1))
15134 (and (looking-at tsr)
15135 (> (- (match-end 0) pos) -1))))))
15136 (and ans
15137 (boundp 'org-ts-what)
15138 (setq org-ts-what
15139 (cond
15140 ((= pos (match-beginning 0)) 'bracket)
15141 ((= pos (1- (match-end 0))) 'bracket)
15142 ((org-pos-in-match-range pos 2) 'year)
15143 ((org-pos-in-match-range pos 3) 'month)
15144 ((org-pos-in-match-range pos 7) 'hour)
15145 ((org-pos-in-match-range pos 8) 'minute)
15146 ((or (org-pos-in-match-range pos 4)
15147 (org-pos-in-match-range pos 5)) 'day)
15148 ((and (> pos (or (match-end 8) (match-end 5)))
15149 (< pos (match-end 0)))
15150 (- pos (or (match-end 8) (match-end 5))))
15151 (t 'day))))
15152 ans))
15154 (defun org-toggle-timestamp-type ()
15155 "Toggle the type (<active> or [inactive]) of a time stamp."
15156 (interactive)
15157 (when (org-at-timestamp-p t)
15158 (let ((beg (match-beginning 0)) (end (match-end 0))
15159 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15160 (save-excursion
15161 (goto-char beg)
15162 (while (re-search-forward "[][<>]" end t)
15163 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15164 t t)))
15165 (message "Timestamp is now %sactive"
15166 (if (equal (char-after beg) ?<) "" "in")))))
15168 (defun org-timestamp-change (n &optional what updown)
15169 "Change the date in the time stamp at point.
15170 The date will be changed by N times WHAT. WHAT can be `day', `month',
15171 `year', `minute', `second'. If WHAT is not given, the cursor position
15172 in the timestamp determines what will be changed."
15173 (let ((pos (point))
15174 with-hm inactive
15175 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15176 org-ts-what
15177 extra rem
15178 ts time time0)
15179 (if (not (org-at-timestamp-p t))
15180 (error "Not at a timestamp"))
15181 (if (and (not what) (eq org-ts-what 'bracket))
15182 (org-toggle-timestamp-type)
15183 (if (and (not what) (not (eq org-ts-what 'day))
15184 org-display-custom-times
15185 (get-text-property (point) 'display)
15186 (not (get-text-property (1- (point)) 'display)))
15187 (setq org-ts-what 'day))
15188 (setq org-ts-what (or what org-ts-what)
15189 inactive (= (char-after (match-beginning 0)) ?\[)
15190 ts (match-string 0))
15191 (replace-match "")
15192 (if (string-match
15194 ts)
15195 (setq extra (match-string 1 ts)))
15197 (setq with-hm t))
15198 (setq time0 (org-parse-time-string ts))
15199 (when (and updown
15200 (eq org-ts-what 'minute)
15201 (not current-prefix-arg))
15202 ;; This looks like s-up and s-down. Change by one rounding step.
15203 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15204 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15205 (setcar (cdr time0) (+ (nth 1 time0)
15206 (if (> n 0) (- rem) (- dm rem))))))
15207 (setq time
15208 (encode-time (or (car time0) 0)
15209 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15210 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15211 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15212 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15213 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15214 (nthcdr 6 time0)))
15215 (when (and (member org-ts-what '(hour minute))
15216 extra
15218 (setq extra (org-modify-ts-extra
15219 extra
15220 (if (eq org-ts-what 'hour) 2 5)
15221 n dm)))
15222 (when (integerp org-ts-what)
15223 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15224 (if (eq what 'calendar)
15225 (let ((cal-date (org-get-date-from-calendar)))
15226 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15227 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15228 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15229 (setcar time0 (or (car time0) 0))
15230 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15231 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15232 (setq time (apply 'encode-time time0))))
15233 (setq org-last-changed-timestamp
15234 (org-insert-time-stamp time with-hm inactive nil nil extra))
15235 (org-clock-update-time-maybe)
15236 (goto-char pos)
15237 ;; Try to recenter the calendar window, if any
15238 (if (and org-calendar-follow-timestamp-change
15239 (get-buffer-window "*Calendar*" t)
15240 (memq org-ts-what '(day month year)))
15241 (org-recenter-calendar (time-to-days time))))))
15243 (defun org-modify-ts-extra (s pos n dm)
15244 "Change the different parts of the lead-time and repeat fields in timestamp."
15245 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15246 ng h m new rem)
15247 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15248 (cond
15249 ((or (org-pos-in-match-range pos 2)
15250 (org-pos-in-match-range pos 3))
15251 (setq m (string-to-number (match-string 3 s))
15252 h (string-to-number (match-string 2 s)))
15253 (if (org-pos-in-match-range pos 2)
15254 (setq h (+ h n))
15255 (setq n (* dm (org-no-warnings (signum n))))
15256 (when (not (= 0 (setq rem (% m dm))))
15257 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15258 (setq m (+ m n)))
15259 (if (< m 0) (setq m (+ m 60) h (1- h)))
15260 (if (> m 59) (setq m (- m 60) h (1+ h)))
15261 (setq h (min 24 (max 0 h)))
15262 (setq ng 1 new (format "-%02d:%02d" h m)))
15263 ((org-pos-in-match-range pos 6)
15264 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15265 ((org-pos-in-match-range pos 5)
15266 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15268 ((org-pos-in-match-range pos 9)
15269 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15270 ((org-pos-in-match-range pos 8)
15271 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15273 (when ng
15274 (setq s (concat
15275 (substring s 0 (match-beginning ng))
15276 new
15277 (substring s (match-end ng))))))
15278 s))
15280 (defun org-recenter-calendar (date)
15281 "If the calendar is visible, recenter it to DATE."
15282 (let* ((win (selected-window))
15283 (cwin (get-buffer-window "*Calendar*" t))
15284 (calendar-move-hook nil))
15285 (when cwin
15286 (select-window cwin)
15287 (calendar-goto-date (if (listp date) date
15288 (calendar-gregorian-from-absolute date)))
15289 (select-window win))))
15291 (defun org-goto-calendar (&optional arg)
15292 "Go to the Emacs calendar at the current date.
15293 If there is a time stamp in the current line, go to that date.
15294 A prefix ARG can be used to force the current date."
15295 (interactive "P")
15296 (let ((tsr org-ts-regexp) diff
15297 (calendar-move-hook nil)
15298 (calendar-view-holidays-initially-flag nil)
15299 (calendar-view-diary-initially-flag nil))
15300 (if (or (org-at-timestamp-p)
15301 (save-excursion
15302 (beginning-of-line 1)
15303 (looking-at (concat ".*" tsr))))
15304 (let ((d1 (time-to-days (current-time)))
15305 (d2 (time-to-days
15306 (org-time-string-to-time (match-string 1)))))
15307 (setq diff (- d2 d1))))
15308 (calendar)
15309 (calendar-goto-today)
15310 (if (and diff (not arg)) (calendar-forward-day diff))))
15312 (defun org-get-date-from-calendar ()
15313 "Return a list (month day year) of date at point in calendar."
15314 (with-current-buffer "*Calendar*"
15315 (save-match-data
15316 (calendar-cursor-to-date))))
15318 (defun org-date-from-calendar ()
15319 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15320 If there is already a time stamp at the cursor position, update it."
15321 (interactive)
15322 (if (org-at-timestamp-p t)
15323 (org-timestamp-change 0 'calendar)
15324 (let ((cal-date (org-get-date-from-calendar)))
15325 (org-insert-time-stamp
15326 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15328 (defun org-minutes-to-hh:mm-string (m)
15329 "Compute H:MM from a number of minutes."
15330 (let ((h (/ m 60)))
15331 (setq m (- m (* 60 h)))
15332 (format org-time-clocksum-format h m)))
15334 (defun org-hh:mm-string-to-minutes (s)
15335 "Convert a string H:MM to a number of minutes.
15336 If the string is just a number, interpret it as minutes.
15337 In fact, the first hh:mm or number in the string will be taken,
15338 there can be extra stuff in the string.
15339 If no number is found, the return value is 0."
15340 (cond
15342 (+ (* (string-to-number (match-string 1 s)) 60)
15343 (string-to-number (match-string 2 s))))
15345 (string-to-number (match-string 1 s)))
15346 (t 0)))
15348 ;;;; Files
15350 (defun org-save-all-org-buffers ()
15351 "Save all Org-mode buffers without user confirmation."
15352 (interactive)
15353 (message "Saving all Org-mode buffers...")
15354 (save-some-buffers t 'org-mode-p)
15355 (when (featurep 'org-id) (org-id-locations-save))
15356 (message "Saving all Org-mode buffers... done"))
15358 (defun org-revert-all-org-buffers ()
15359 "Revert all Org-mode buffers.
15360 Prompt for confirmation when there are unsaved changes.
15361 Be sure you know what you are doing before letting this function
15362 overwrite your changes.
15364 This function is useful in a setup where one tracks org files
15365 with a version control system, to revert on one machine after pulling
15366 changes from another. I believe the procedure must be like this:
15368 1. M-x org-save-all-org-buffers
15369 2. Pull changes from the other machine, resolve conflicts
15370 3. M-x org-revert-all-org-buffers"
15371 (interactive)
15372 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15373 (error "Abort"))
15374 (save-excursion
15375 (save-window-excursion
15376 (mapc
15377 (lambda (b)
15378 (when (and (with-current-buffer b (org-mode-p))
15379 (with-current-buffer b buffer-file-name))
15380 (switch-to-buffer b)
15381 (revert-buffer t 'no-confirm)))
15382 (buffer-list))
15383 (when (and (featurep 'org-id) org-id-track-globally)
15384 (org-id-locations-load)))))
15386 ;;;; Agenda files
15388 ;;;###autoload
15389 (defun org-switchb (&optional arg)
15390 "Switch between Org buffers.
15391 With a prefix argument, restrict available to files.
15392 With two prefix arguments, restrict available buffers to agenda files.
15394 Defaults to `iswitchb' for buffer name completion.
15395 Set `org-completion-use-ido' to make it use ido instead."
15396 (interactive "P")
15397 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15398 ((equal arg '(16)) (org-buffer-list 'agenda))
15399 (t (org-buffer-list))))
15400 (org-completion-use-iswitchb org-completion-use-iswitchb)
15401 (org-completion-use-ido org-completion-use-ido))
15402 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15403 (setq org-completion-use-iswitchb t))
15404 (switch-to-buffer
15405 (org-icompleting-read "Org buffer: "
15406 (mapcar 'list (mapcar 'buffer-name blist))
15407 nil t))))
15409 ;;; Define some older names previously used for this functionality
15410 ;;;###autoload
15411 (defalias 'org-ido-switchb 'org-switchb)
15412 ;;;###autoload
15413 (defalias 'org-iswitchb 'org-switchb)
15415 (defun org-buffer-list (&optional predicate exclude-tmp)
15416 "Return a list of Org buffers.
15417 PREDICATE can be `export', `files' or `agenda'.
15419 export restrict the list to Export buffers.
15420 files restrict the list to buffers visiting Org files.
15421 agenda restrict the list to buffers visiting agenda files.
15423 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15424 (let* ((bfn nil)
15425 (agenda-files (and (eq predicate 'agenda)
15426 (mapcar 'file-truename (org-agenda-files t))))
15427 (filter
15428 (cond
15429 ((eq predicate 'files)
15430 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
15431 ((eq predicate 'export)
15432 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15433 ((eq predicate 'agenda)
15434 (lambda (b)
15435 (with-current-buffer b
15436 (and (eq major-mode 'org-mode)
15437 (setq bfn (buffer-file-name b))
15438 (member (file-truename bfn) agenda-files)))))
15439 (t (lambda (b) (with-current-buffer b
15440 (or (eq major-mode 'org-mode)
15441 (string-match "\*Org .*Export"
15442 (buffer-name b)))))))))
15443 (delq nil
15444 (mapcar
15445 (lambda(b)
15446 (if (and (funcall filter b)
15447 (or (not exclude-tmp)
15448 (not (string-match "tmp" (buffer-name b)))))
15449 b
15450 nil))
15451 (buffer-list)))))
15453 (defun org-agenda-files (&optional unrestricted archives)
15454 "Get the list of agenda files.
15455 Optional UNRESTRICTED means return the full list even if a restriction
15456 is currently in place.
15457 When ARCHIVES is t, include all archive files that are really being
15458 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15459 `org-agenda-archives-mode' is t."
15460 (let ((files
15461 (cond
15462 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15463 ((stringp org-agenda-files) (org-read-agenda-file-list))
15464 ((listp org-agenda-files) org-agenda-files)
15465 (t (error "Invalid value of `org-agenda-files'")))))
15466 (setq files (apply 'append
15467 (mapcar (lambda (f)
15468 (if (file-directory-p f)
15469 (directory-files
15470 f t org-agenda-file-regexp)
15471 (list f)))
15472 files)))
15473 (when org-agenda-skip-unavailable-files
15474 (setq files (delq nil
15475 (mapcar (function
15476 (lambda (file)
15477 (and (file-readable-p file) file)))
15478 files))))
15479 (when (or (eq archives t)
15480 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15481 (setq files (org-add-archive-files files)))
15482 files))
15484 (defun org-agenda-file-p (&optional file)
15485 "Return non-nil, if FILE is an agenda file.
15486 If FILE is omitted, use the file associated with the current
15487 buffer."
15488 (member (or file (buffer-file-name))
15489 (org-agenda-files t)))
15491 (defun org-edit-agenda-file-list ()
15492 "Edit the list of agenda files.
15493 Depending on setup, this either uses customize to edit the variable
15494 `org-agenda-files', or it visits the file that is holding the list. In the
15495 latter case, the buffer is set up in a way that saving it automatically kills
15496 the buffer and restores the previous window configuration."
15497 (interactive)
15498 (if (stringp org-agenda-files)
15499 (let ((cw (current-window-configuration)))
15500 (find-file org-agenda-files)
15501 (org-set-local 'org-window-configuration cw)
15502 (org-add-hook 'after-save-hook
15503 (lambda ()
15504 (set-window-configuration
15505 (prog1 org-window-configuration
15506 (kill-buffer (current-buffer))))
15507 (org-install-agenda-files-menu)
15508 (message "New agenda file list installed"))
15509 nil 'local)
15510 (message "%s" (substitute-command-keys
15512 (customize-variable 'org-agenda-files)))
15514 (defun org-store-new-agenda-file-list (list)
15515 "Set new value for the agenda file list and save it correctly."
15516 (if (stringp org-agenda-files)
15517 (let ((fe (org-read-agenda-file-list t)) b u)
15518 (while (setq b (find-buffer-visiting org-agenda-files))
15519 (kill-buffer b))
15520 (with-temp-file org-agenda-files
15521 (insert
15522 (mapconcat
15523 (lambda (f) ;; Keep un-expanded entries.
15524 (if (setq u (assoc f fe))
15525 (cdr u)
15526 f))
15529 (let ((org-mode-hook nil) (org-inhibit-startup t)
15530 (org-insert-mode-line-in-empty-file nil))
15531 (setq org-agenda-files list)
15532 (customize-save-variable 'org-agenda-files org-agenda-files))))
15534 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15535 "Read the list of agenda files from a file.
15536 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15537 filenames, used by `org-store-new-agenda-file-list' to write back
15538 un-expanded file names."
15539 (when (file-directory-p org-agenda-files)
15540 (error "`org-agenda-files' cannot be a single directory"))
15541 (when (stringp org-agenda-files)
15542 (with-temp-buffer
15543 (insert-file-contents org-agenda-files)
15544 (mapcar
15545 (lambda (f)
15546 (let ((e (expand-file-name (substitute-in-file-name f)
15547 org-directory)))
15548 (if pair-with-expansion
15549 (cons e f)
15550 e)))
15553 ;;;###autoload
15554 (defun org-cycle-agenda-files ()
15555 "Cycle through the files in `org-agenda-files'.
15556 If the current buffer visits an agenda file, find the next one in the list.
15557 If the current buffer does not, find the first agenda file."
15558 (interactive)
15559 (let* ((fs (org-agenda-files t))
15560 (files (append fs (list (car fs))))
15561 (tcf (if buffer-file-name (file-truename buffer-file-name)))
15562 file)
15563 (unless files (error "No agenda files"))
15564 (catch 'exit
15565 (while (setq file (pop files))
15566 (if (equal (file-truename file) tcf)
15567 (when (car files)
15568 (find-file (car files))
15569 (throw 'exit t))))
15570 (find-file (car fs)))
15571 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
15573 (defun org-agenda-file-to-front (&optional to-end)
15574 "Move/add the current file to the top of the agenda file list.
15575 If the file is not present in the list, it is added to the front. If it is
15576 present, it is moved there. With optional argument TO-END, add/move to the
15577 end of the list."
15578 (interactive "P")
15579 (let ((org-agenda-skip-unavailable-files nil)
15580 (file-alist (mapcar (lambda (x)
15581 (cons (file-truename x) x))
15582 (org-agenda-files t)))
15583 (ctf (file-truename buffer-file-name))
15584 x had)
15585 (setq x (assoc ctf file-alist) had x)
15587 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
15588 (if to-end
15589 (setq file-alist (append (delq x file-alist) (list x)))
15590 (setq file-alist (cons x (delq x file-alist))))
15591 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
15592 (org-install-agenda-files-menu)
15593 (message "File %s to %s of agenda file list"
15594 (if had "moved" "added") (if to-end "end" "front"))))
15596 (defun org-remove-file (&optional file)
15597 "Remove current file from the list of files in variable `org-agenda-files'.
15598 These are the files which are being checked for agenda entries.
15599 Optional argument FILE means use this file instead of the current."
15600 (interactive)
15601 (let* ((org-agenda-skip-unavailable-files nil)
15602 (file (or file buffer-file-name))
15603 (true-file (file-truename file))
15604 (afile (abbreviate-file-name file))
15605 (files (delq nil (mapcar
15606 (lambda (x)
15607 (if (equal true-file
15608 (file-truename x))
15609 nil x))
15610 (org-agenda-files t)))))
15611 (if (not (= (length files) (length (org-agenda-files t))))
15612 (progn
15613 (org-store-new-agenda-file-list files)
15614 (org-install-agenda-files-menu)
15615 (message "Removed file: %s" afile))
15616 (message "File was not in list: %s (not removed)" afile))))
15618 (defun org-file-menu-entry (file)
15619 (vector file (list 'find-file file) t))
15621 (defun org-check-agenda-file (file)
15622 "Make sure FILE exists. If not, ask user what to do."
15623 (when (not (file-exists-p file))
15624 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
15625 (abbreviate-file-name file))
15626 (let ((r (downcase (read-char-exclusive))))
15627 (cond
15628 ((equal r ?r)
15629 (org-remove-file file)
15630 (throw 'nextfile t))
15631 (t (error "Abort"))))))
15633 (defun org-get-agenda-file-buffer (file)
15634 "Get a buffer visiting FILE. If the buffer needs to be created, add
15635 it to the list of buffers which might be released later."
15636 (let ((buf (org-find-base-buffer-visiting file)))
15637 (if buf
15638 buf ; just return it
15639 ;; Make a new buffer and remember it
15640 (setq buf (find-file-noselect file))
15641 (if buf (push buf org-agenda-new-buffers))
15642 buf)))
15644 (defun org-release-buffers (blist)
15645 "Release all buffers in list, asking the user for confirmation when needed.
15646 When a buffer is unmodified, it is just killed. When modified, it is saved
15647 \(if the user agrees) and then killed."
15648 (let (buf file)
15649 (while (setq buf (pop blist))
15650 (setq file (buffer-file-name buf))
15651 (when (and (buffer-modified-p buf)
15652 file
15653 (y-or-n-p (format "Save file %s? " file)))
15654 (with-current-buffer buf (save-buffer)))
15655 (kill-buffer buf))))
15657 (defun org-prepare-agenda-buffers (files)
15658 "Create buffers for all agenda files, protect archived trees and comments."
15659 (interactive)
15660 (let ((pa '(:org-archived t))
15661 (pc '(:org-comment t))
15662 (pall '(:org-archived t :org-comment t))
15663 (inhibit-read-only t)
15664 (rea (concat ":" org-archive-tag ":"))
15665 bmp file re)
15666 (save-excursion
15667 (save-restriction
15668 (while (setq file (pop files))
15669 (catch 'nextfile
15670 (if (bufferp file)
15671 (set-buffer file)
15672 (org-check-agenda-file file)
15673 (set-buffer (org-get-agenda-file-buffer file)))
15674 (widen)
15675 (setq bmp (buffer-modified-p))
15676 (org-refresh-category-properties)
15677 (setq org-todo-keywords-for-agenda
15678 (append org-todo-keywords-for-agenda org-todo-keywords-1))
15679 (setq org-done-keywords-for-agenda
15680 (append org-done-keywords-for-agenda org-done-keywords))
15681 (setq org-todo-keyword-alist-for-agenda
15682 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
15683 (setq org-drawers-for-agenda
15684 (append org-drawers-for-agenda org-drawers))
15685 (setq org-tag-alist-for-agenda
15686 (append org-tag-alist-for-agenda org-tag-alist))
15688 (save-excursion
15689 (remove-text-properties (point-min) (point-max) pall)
15690 (when org-agenda-skip-archived-trees
15691 (goto-char (point-min))
15692 (while (re-search-forward rea nil t)
15693 (if (org-on-heading-p t)
15694 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
15695 (goto-char (point-min))
15697 (while (re-search-forward re nil t)
15698 (add-text-properties
15699 (match-beginning 0) (org-end-of-subtree t) pc)))
15700 (set-buffer-modified-p bmp)))))
15701 (setq org-todo-keywords-for-agenda
15702 (org-uniquify org-todo-keywords-for-agenda))
15703 (setq org-todo-keyword-alist-for-agenda
15704 (org-uniquify org-todo-keyword-alist-for-agenda)
15705 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
15707 ;;;; Embedded LaTeX
15709 (defvar org-cdlatex-mode-map (make-sparse-keymap)
15710 "Keymap for the minor `org-cdlatex-mode'.")
15712 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
15713 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
15714 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
15715 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
15716 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
15718 (defvar org-cdlatex-texmathp-advice-is-done nil
15719 "Flag remembering if we have applied the advice to texmathp already.")
15721 (define-minor-mode org-cdlatex-mode
15722 "Toggle the minor `org-cdlatex-mode'.
15723 This mode supports entering LaTeX environment and math in LaTeX fragments
15724 in Org-mode.
15726 nil " OCDL" nil
15727 (when org-cdlatex-mode (require 'cdlatex))
15728 (unless org-cdlatex-texmathp-advice-is-done
15729 (setq org-cdlatex-texmathp-advice-is-done t)
15730 (defadvice texmathp (around org-math-always-on activate)
15731 "Always return t in org-mode buffers.
15732 This is because we want to insert math symbols without dollars even outside
15733 the LaTeX math segments. If Orgmode thinks that point is actually inside
15734 an embedded LaTeX fragment, let texmathp do its job.
15736 (interactive)
15737 (let (p)
15738 (cond
15739 ((not (org-mode-p)) ad-do-it)
15740 ((eq this-command 'cdlatex-math-symbol)
15741 (setq ad-return-value t
15742 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
15743 (t
15744 (let ((p (org-inside-LaTeX-fragment-p)))
15745 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
15746 (setq ad-return-value t
15747 texmathp-why '("Org-mode embedded math" . 0))
15748 (if p ad-do-it)))))))))
15750 (defun turn-on-org-cdlatex ()
15751 "Unconditionally turn on `org-cdlatex-mode'."
15752 (org-cdlatex-mode 1))
15754 (defun org-inside-LaTeX-fragment-p ()
15755 "Test if point is inside a LaTeX fragment.
15757 sequence appearing also before point.
15758 Even though the matchers for math are configurable, this function assumes
15760 delimiters are skipped when they have been removed by customization.
15761 The return value is nil, or a cons cell with the delimiter and
15762 and the position of this delimiter.
15764 This function does a reasonably good job, but can locally be fooled by
15765 for example currency specifications. For example it will assume being in
15767 fragments that are properly closed, but during editing, we have to live
15768 with the uncertainty caused by missing closing delimiters. This function
15769 looks only before point, not after."
15770 (catch 'exit
15771 (let ((pos (point))
15772 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
15773 (lim (progn
15775 (point)))
15776 dd-on str (start 0) m re)
15777 (goto-char pos)
15778 (when dodollar
15780 re (nth 1 (assoc "$" org-latex-regexps)))
15781 (while (string-match re str start)
15782 (cond
15783 ((= (match-end 0) (length str))
15784 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
15785 ((= (match-end 0) (- (length str) 5))
15786 (throw 'exit nil))
15787 (t (setq start (match-end 0))))))
15788 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
15789 (goto-char pos)
15790 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
15791 (and (match-beginning 2) (throw 'exit nil))
15792 ;; count $$
15794 (setq dd-on (not dd-on)))
15795 (goto-char pos)
15796 (if dd-on (cons "$$" m))))))
15798 (defun org-inside-latex-macro-p ()
15799 "Is point inside a LaTeX macro or its arguments?"
15800 (save-match-data
15801 (org-in-regexp
15804 (defun org-try-cdlatex-tab ()
15805 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15806 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15807 - inside a LaTeX fragment, or
15808 - after the first word in a line, where an abbreviation expansion could
15809 insert a LaTeX environment."
15810 (when org-cdlatex-mode
15811 (cond
15812 ((save-excursion
15813 (skip-chars-backward "a-zA-Z0-9*")
15815 (bolp))
15816 (cdlatex-tab) t)
15817 ((org-inside-LaTeX-fragment-p)
15818 (cdlatex-tab) t)
15819 (t nil))))
15821 (defun org-cdlatex-underscore-caret (&optional arg)
15822 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15823 Revert to the normal definition outside of these fragments."
15824 (interactive "P")
15825 (if (org-inside-LaTeX-fragment-p)
15826 (call-interactively 'cdlatex-sub-superscript)
15827 (let (org-cdlatex-mode)
15828 (call-interactively (key-binding (vector last-input-event))))))
15830 (defun org-cdlatex-math-modify (&optional arg)
15831 "Execute `cdlatex-math-modify' in LaTeX fragments.
15832 Revert to the normal definition outside of these fragments."
15833 (interactive "P")
15834 (if (org-inside-LaTeX-fragment-p)
15835 (call-interactively 'cdlatex-math-modify)
15836 (let (org-cdlatex-mode)
15837 (call-interactively (key-binding (vector last-input-event))))))
15839 (defvar org-latex-fragment-image-overlays nil
15840 "List of overlays carrying the images of latex fragments.")
15841 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
15843 (defun org-remove-latex-fragment-image-overlays ()
15844 "Remove all overlays with LaTeX fragment images in current buffer."
15845 (mapc 'delete-overlay org-latex-fragment-image-overlays)
15846 (setq org-latex-fragment-image-overlays nil))
15848 (defun org-preview-latex-fragment (&optional subtree)
15849 "Preview the LaTeX fragment at point, or all locally or globally.
15850 If the cursor is in a LaTeX fragment, create the image and overlay
15851 it over the source code. If there is no fragment at point, display
15852 all fragments in the current text, from one headline to the next. With
15853 prefix SUBTREE, display all fragments in the current subtree. With a
15855 the cursor is before the first headline,
15856 display all fragments in the buffer.
15858 (interactive "P")
15859 (org-remove-latex-fragment-image-overlays)
15860 (save-excursion
15861 (save-restriction
15862 (let (beg end at msg)
15863 (cond
15864 ((or (equal subtree '(16))
15865 (not (save-excursion
15866 (re-search-backward (concat "^" outline-regexp) nil t))))
15867 (setq beg (point-min) end (point-max)
15868 msg "Creating images for buffer...%s"))
15869 ((equal subtree '(4))
15870 (org-back-to-heading)
15871 (setq beg (point) end (org-end-of-subtree t)
15872 msg "Creating images for subtree...%s"))
15873 (t
15874 (if (setq at (org-inside-LaTeX-fragment-p))
15875 (goto-char (max (point-min) (- (cdr at) 2)))
15876 (org-back-to-heading))
15877 (setq beg (point) end (progn (outline-next-heading) (point))
15878 msg (if at "Creating image...%s"
15879 "Creating images for entry...%s"))))
15880 (message msg "")
15881 (narrow-to-region beg end)
15882 (goto-char beg)
15883 (org-format-latex
15884 (concat "ltxpng/" (file-name-sans-extension
15885 (file-name-nondirectory
15886 buffer-file-name)))
15887 default-directory 'overlays msg at 'forbuffer 'dvipng)
15888 (message msg "done. Use `C-c C-c' to remove images.")))))
15890 (defvar org-latex-regexps
15892 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
15895 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
15899 "Regular expressions for matching embedded LaTeX.")
15901 (defvar org-export-have-math nil) ;; dynamic scoping
15902 (defun org-format-latex (prefix &optional dir overlays msg at
15903 forbuffer processing-type)
15904 "Replace LaTeX fragments with links to an image, and produce images.
15905 Some of the options can be changed using the variable
15906 `org-format-latex-options'."
15907 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
15908 (let* ((prefixnodir (file-name-nondirectory prefix))
15909 (absprefix (expand-file-name prefix dir))
15910 (todir (file-name-directory absprefix))
15911 (opt org-format-latex-options)
15912 (matchers (plist-get opt :matchers))
15913 (re-list org-latex-regexps)
15914 (org-format-latex-header-extra
15915 (plist-get (org-infile-export-plist) :latex-header-extra))
15916 (cnt 0) txt hash link beg end re e checkdir
15917 executables-checked string
15918 m n block linkfile movefile ov)
15919 ;; Check the different regular expressions
15920 (while (setq e (pop re-list))
15921 (setq m (car e) re (nth 1 e) n (nth 2 e)
15923 (when (member m matchers)
15924 (goto-char (point-min))
15925 (while (re-search-forward re nil t)
15926 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
15927 (not (get-text-property (match-beginning n)
15928 'org-protected))
15929 (or (not overlays)
15930 (not (eq (get-char-property (match-beginning n)
15931 'org-overlay-type)
15932 'org-latex-overlay))))
15933 (setq org-export-have-math t)
15934 (cond
15935 ((eq processing-type 'verbatim)
15936 ;; Leave the text verbatim, just protect it
15937 (add-text-properties (match-beginning n) (match-end n)
15938 '(org-protected t)))
15939 ((eq processing-type 'mathjax)
15940 ;; Prepare for MathJax processing
15941 (setq string (match-string n))
15942 (if (member m '("$" "$1"))
15943 (save-excursion
15944 (delete-region (match-beginning n) (match-end n))
15945 (goto-char (match-beginning n))
15948 '(org-protected t))))
15949 (add-text-properties (match-beginning n) (match-end n)
15950 '(org-protected t))))
15951 ((or (eq processing-type 'dvipng) t)
15952 ;; Process to an image
15953 (setq txt (match-string n)
15954 beg (match-beginning n) end (match-end n)
15955 cnt (1+ cnt))
15956 (let (print-length print-level) ; make sure full list is printed
15957 (setq hash (sha1 (prin1-to-string
15958 (list org-format-latex-header
15959 org-format-latex-header-extra
15960 org-export-latex-default-packages-alist
15961 org-export-latex-packages-alist
15962 org-format-latex-options
15963 forbuffer txt)))
15964 linkfile (format "%s_%s.png" prefix hash)
15965 movefile (format "%s_%s.png" absprefix hash)))
15966 (setq link (concat block "[[file:" linkfile "]]" block))
15967 (if msg (message msg cnt))
15968 (goto-char beg)
15969 (unless checkdir ; make sure the directory exists
15970 (setq checkdir t)
15971 (or (file-directory-p todir) (make-directory todir t)))
15973 (unless executables-checked
15974 (org-check-external-command
15975 "latex" "needed to convert LaTeX fragments to images")
15976 (org-check-external-command
15977 "dvipng" "needed to convert LaTeX fragments to images")
15978 (setq executables-checked t))
15980 (unless (file-exists-p movefile)
15981 (org-create-formula-image
15982 txt movefile opt forbuffer))
15983 (if overlays
15984 (progn
15985 (mapc (lambda (o)
15986 (if (eq (overlay-get o 'org-overlay-type)
15987 'org-latex-overlay)
15988 (delete-overlay o)))
15989 (overlays-in beg end))
15990 (setq ov (make-overlay beg end))
15991 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
15992 (if (featurep 'xemacs)
15993 (progn
15994 (overlay-put ov 'invisible t)
15995 (overlay-put
15996 ov 'end-glyph
15997 (make-glyph (vector 'png :file movefile))))
15998 (overlay-put
15999 ov 'display
16000 (list 'image :type 'png :file movefile :ascent 'center)))
16001 (push ov org-latex-fragment-image-overlays)
16002 (goto-char end))
16003 (delete-region beg end)
16004 (insert (org-add-props link
16005 (list 'org-latex-src
16006 (replace-regexp-in-string
16009 ;; This function borrows from Ganesh Swami's latex2png.el
16010 (defun org-create-formula-image (string tofile options buffer)
16011 "This calls dvipng."
16012 (require 'org-latex)
16013 (let* ((tmpdir (if (featurep 'xemacs)
16014 (temp-directory)
16015 temporary-file-directory))
16016 (texfilebase (make-temp-name
16017 (expand-file-name "orgtex" tmpdir)))
16018 (texfile (concat texfilebase ".tex"))
16019 (dvifile (concat texfilebase ".dvi"))
16020 (pngfile (concat texfilebase ".png"))
16021 (fnh (if (featurep 'xemacs)
16022 (font-height (get-face-font 'default))
16023 (face-attribute 'default :height nil)))
16024 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16025 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16026 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16027 "Black"))
16028 (bg (or (plist-get options (if buffer :background :html-background))
16029 "Transparent")))
16030 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16031 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16032 (with-temp-file texfile
16033 (insert (org-splice-latex-header
16034 org-format-latex-header
16035 org-export-latex-default-packages-alist
16036 org-export-latex-packages-alist t
16037 org-format-latex-header-extra))
16039 (require 'org-latex)
16040 (org-export-latex-fix-inputenc))
16041 (let ((dir default-directory))
16042 (condition-case nil
16043 (progn
16044 (cd tmpdir)
16045 (call-process "latex" nil nil nil texfile))
16046 (error nil))
16047 (cd dir))
16048 (if (not (file-exists-p dvifile))
16049 (progn (message "Failed to create dvi file from %s" texfile) nil)
16050 (condition-case nil
16051 (call-process "dvipng" nil nil nil
16052 "-fg" fg "-bg" bg
16053 "-D" dpi
16054 ;;"-x" scale "-y" scale
16055 "-T" "tight"
16056 "-o" pngfile
16057 dvifile)
16058 (error nil))
16059 (if (not (file-exists-p pngfile))
16060 (if org-format-latex-signal-error
16061 (error "Failed to create png file from %s" texfile)
16062 (message "Failed to create png file from %s" texfile)
16063 nil)
16064 ;; Use the requested file name and clean up
16065 (copy-file pngfile tofile 'replace)
16066 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16067 (delete-file (concat texfilebase e)))
16068 pngfile))))
16070 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16071 "Fill a LaTeX header template TPL.
16072 In the template, the following place holders will be recognized:
16075 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16077 [NO-PACKAGES] do not include PKG
16078 [EXTRA] the string EXTRA
16079 [NO-EXTRA] do not include EXTRA
16081 For backward compatibility, if both the positive and the negative place
16083 assumed to be present at the end of the template.
16084 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16085 EXTRA is a string.
16086 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16087 (let (rpl (end ""))
16089 (setq rpl (if (or (match-end 1) (not def-pkg))
16090 "" (org-latex-packages-to-string def-pkg snippets-p t))
16091 tpl (replace-match rpl t t tpl))
16092 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16095 (setq rpl (if (or (match-end 1) (not pkg))
16096 "" (org-latex-packages-to-string pkg snippets-p t))
16097 tpl (replace-match rpl t t tpl))
16098 (if pkg (setq end
16100 (org-latex-packages-to-string pkg snippets-p)))))
16103 (setq rpl (if (or (match-end 1) (not extra))
16105 tpl (replace-match rpl t t tpl))
16111 tpl)))
16113 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16115 (setq pkg (mapconcat (lambda(p)
16116 (cond
16117 ((stringp p) p)
16118 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16119 (format "%% Package %s omitted" (cadr p)))
16120 ((equal "" (car p))
16122 (t
16124 (car p) (cadr p)))))
16125 pkg
16129 (defun org-dvipng-color (attr)
16130 "Return an rgb color specification for dvipng."
16131 (apply 'format "rgb %s %s %s"
16132 (mapcar 'org-normalize-color
16133 (color-values (face-attribute 'default attr nil)))))
16135 (defun org-normalize-color (value)
16136 "Return string to be used as color value for an RGB component."
16137 (format "%g" (/ value 65535.0)))
16139 ;; Image display
16142 (defvar org-inline-image-overlays nil)
16143 (make-variable-buffer-local 'org-inline-image-overlays)
16145 (defun org-toggle-inline-images (&optional include-linked)
16146 "Toggle the display of inline images.
16147 INCLUDE-LINKED is passed to `org-display-inline-images'."
16148 (interactive "P")
16149 (if org-inline-image-overlays
16150 (progn
16151 (org-remove-inline-images)
16152 (message "Inline image display turned off"))
16153 (org-display-inline-images include-linked)
16154 (if org-inline-image-overlays
16155 (message "%d images displayed inline"
16156 (length org-inline-image-overlays))
16157 (message "No images to display inline"))))
16159 (defun org-display-inline-images (&optional include-linked refresh beg end)
16160 "Display inline images.
16161 Normally only links without a description part are inlined, because this
16162 is how it will work for export. When INCLUDE-LINKED is set, also links
16163 with a description part will be inlined. This can be nice for a quick
16164 look at those images, but it does not reflect what exported files will look
16165 like.
16166 When REFRESH is set, refresh existing images between BEG and END.
16167 This will create new image displays only if necessary.
16168 BEG and END default to the buffer boundaries."
16169 (interactive "P")
16170 (unless refresh
16171 (org-remove-inline-images)
16172 (clear-image-cache))
16173 (save-excursion
16174 (save-restriction
16175 (widen)
16176 (setq beg (or beg (point-min)) end (or end (point-max)))
16177 (goto-char (point-min))
16179 (substring (org-image-file-name-regexp) 0 -2)
16181 old file ov img)
16182 (while (re-search-forward re end t)
16183 (setq old (get-char-property-and-overlay (match-beginning 1)
16184 'org-image-overlay))
16185 (setq file (expand-file-name
16186 (concat (or (match-string 3) "") (match-string 4))))
16187 (when (file-exists-p file)
16188 (if (and (car-safe old) refresh)
16189 (image-refresh (overlay-get (cdr old) 'display))
16190 (setq img (save-match-data (create-image file)))
16191 (when img
16192 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16193 (overlay-put ov 'display img)
16194 (overlay-put ov 'face 'default)
16195 (overlay-put ov 'org-image-overlay t)
16196 (overlay-put ov 'modification-hooks
16197 (list 'org-display-inline-modification-hook))
16198 (push ov org-inline-image-overlays)))))))))
16200 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16201 "Remove inline-display overlay if a corresponding region is modified."
16202 (let ((inhibit-modification-hooks t))
16203 (when (and ov after)
16204 (delete ov org-inline-image-overlays)
16205 (delete-overlay ov))))
16207 (defun org-remove-inline-images ()
16208 "Remove inline display of images."
16209 (interactive)
16210 (mapc 'delete-overlay org-inline-image-overlays)
16211 (setq org-inline-image-overlays nil))
16213 ;;;; Key bindings
16215 ;; Make `C-c C-x' a prefix key
16216 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16218 ;; TAB key with modifiers
16219 (org-defkey org-mode-map "\C-i" 'org-cycle)
16220 (org-defkey org-mode-map [(tab)] 'org-cycle)
16221 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16222 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16224 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16225 ;; The following line is necessary under Suse GNU/Linux
16226 (unless (featurep 'xemacs)
16227 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16228 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16229 (define-key org-mode-map [backtab] 'org-shifttab)
16231 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16232 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16233 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16235 ;; Cursor keys with modifiers
16236 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16237 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16238 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16239 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16241 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16242 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16243 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16244 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16246 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16247 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16248 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16249 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16251 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16252 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16254 ;; Babel keys
16255 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16256 (mapc (lambda (pair)
16257 (define-key org-babel-map (car pair) (cdr pair)))
16258 org-babel-key-bindings)
16260 ;;; Extra keys for tty access.
16261 ;; We only set them when really needed because otherwise the
16262 ;; menus don't show the simple keys
16264 (when (or org-use-extra-keys
16265 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16266 (not window-system))
16267 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16268 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16269 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16270 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16271 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16272 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16273 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16274 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16275 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16276 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16277 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16278 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16279 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16280 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16281 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16282 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16283 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16284 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16285 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16286 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16287 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16288 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16289 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16290 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16291 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16292 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16293 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16294 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16296 ;; All the other keys
16298 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16299 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16300 (if (boundp 'narrow-map)
16301 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16302 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16303 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16304 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16305 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16306 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16307 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16308 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16309 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16310 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16311 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16312 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16313 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16314 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16315 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16316 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16317 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16318 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16320 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16321 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16322 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16323 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16324 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16325 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16326 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16327 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16328 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16329 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16330 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16331 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16332 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16333 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16334 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16335 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16336 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16337 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16338 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16340 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16341 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16342 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16343 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16344 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16345 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16346 (org-defkey org-mode-map "\C-c^" 'org-sort)
16347 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16348 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16349 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16350 (org-defkey org-mode-map "\C-m" 'org-return)
16351 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16352 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16353 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16354 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16355 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16356 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16357 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16358 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16359 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16360 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16361 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16362 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16363 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16364 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16365 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16366 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16367 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16368 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16369 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16370 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16371 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16372 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16374 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16375 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16376 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16377 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16379 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16380 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16381 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16382 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16383 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16384 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16385 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16386 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16387 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16388 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16390 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16391 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16392 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16393 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16394 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16395 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16396 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16398 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16399 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16400 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16401 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16402 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16404 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16406 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16408 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16409 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16411 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16414 (when (featurep 'xemacs)
16415 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16418 (defconst org-speed-commands-default
16419 '(
16420 ("Outline Navigation")
16421 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16422 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16423 ("f" . (org-speed-move-safe 'org-forward-same-level))
16424 ("b" . (org-speed-move-safe 'org-backward-same-level))
16425 ("u" . (org-speed-move-safe 'outline-up-heading))
16426 ("j" . org-goto)
16427 ("g" . (org-refile t))
16428 ("Outline Visibility")
16429 ("c" . org-cycle)
16430 ("C" . org-shifttab)
16431 (" " . org-display-outline-path)
16432 ("Outline Structure Editing")
16433 ("U" . org-shiftmetaup)
16434 ("D" . org-shiftmetadown)
16435 ("r" . org-metaright)
16436 ("l" . org-metaleft)
16437 ("R" . org-shiftmetaright)
16438 ("L" . org-shiftmetaleft)
16439 ("i" . (progn (forward-char 1) (call-interactively
16440 'org-insert-heading-respect-content)))
16441 ("^" . org-sort)
16442 ("w" . org-refile)
16443 ("a" . org-archive-subtree-default-with-confirmation)
16444 ("." . org-mark-subtree)
16445 ("Clock Commands")
16446 ("I" . org-clock-in)
16447 ("O" . org-clock-out)
16448 ("Meta Data Editing")
16449 ("t" . org-todo)
16450 ("0" . (org-priority ?\ ))
16451 ("1" . (org-priority ?A))
16452 ("2" . (org-priority ?B))
16453 ("3" . (org-priority ?C))
16454 (";" . org-set-tags-command)
16455 ("e" . org-set-effort)
16456 ("Agenda Views etc")
16457 ("v" . org-agenda)
16458 ("/" . org-sparse-tree)
16459 ("Misc")
16460 ("o" . org-open-at-point)
16461 ("?" . org-speed-command-help)
16462 ("<" . (org-agenda-set-restriction-lock 'subtree))
16463 (">" . (org-agenda-remove-restriction-lock))
16464 )
16465 "The default speed commands.")
16467 (defun org-print-speed-command (e)
16468 (if (> (length (car e)) 1)
16469 (progn
16471 (princ (car e))
16473 (princ (make-string (length (car e)) ?-))
16475 (princ (car e))
16476 (princ " ")
16477 (if (symbolp (cdr e))
16478 (princ (symbol-name (cdr e)))
16479 (prin1 (cdr e)))
16482 (defun org-speed-command-help ()
16483 "Show the available speed commands."
16484 (interactive)
16485 (if (not org-use-speed-commands)
16486 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16487 (with-output-to-temp-buffer "*Help*"
16489 (mapc 'org-print-speed-command org-speed-commands-user)
16492 (mapc 'org-print-speed-command org-speed-commands-default))
16493 (with-current-buffer "*Help*"
16494 (setq truncate-lines t))))
16496 (defun org-speed-move-safe (cmd)
16497 "Execute CMD, but make sure that the cursor always ends up in a headline.
16498 If not, return to the original position and throw an error."
16499 (interactive)
16500 (let ((pos (point)))
16501 (call-interactively cmd)
16502 (unless (and (bolp) (org-on-heading-p))
16503 (goto-char pos)
16504 (error "Boundary reached while executing %s" cmd))))
16506 (defvar org-self-insert-command-undo-counter 0)
16508 (defvar org-table-auto-blank-field) ; defined in org-table.el
16509 (defvar org-speed-command nil)
16511 (defun org-speed-command-default-hook (keys)
16512 "Hook for activating single-letter speed commands.
16513 `org-speed-commands-default' specifies a minimal command set. Use
16514 `org-speed-commands-user' for further customization."
16515 (when (or (and (bolp) (looking-at outline-regexp))
16516 (and (functionp org-use-speed-commands)
16517 (funcall org-use-speed-commands)))
16518 (cdr (assoc keys (append org-speed-commands-user
16519 org-speed-commands-default)))))
16521 (defun org-babel-speed-command-hook (keys)
16522 "Hook for activating single-letter code block commands."
16523 (when (and (bolp) (looking-at org-babel-src-block-regexp))
16524 (cdr (assoc keys org-babel-key-bindings))))
16526 (defcustom org-speed-command-hook
16527 '(org-speed-command-default-hook org-babel-speed-command-hook)
16528 "Hook for activating speed commands at strategic locations.
16529 Hook functions are called in sequence until a valid handler is
16530 found.
16532 Each hook takes a single argument, a user-pressed command key
16533 which is also a `self-insert-command' from the global map.
16535 Within the hook, examine the cursor position and the command key
16536 and return nil or a valid handler as appropriate. Handler could
16537 be one of an interactive command, a function, or a form.
16539 Set `org-use-speed-commands' to non-nil value to enable this
16540 hook. The default setting is `org-speed-command-default-hook'."
16541 :group 'org-structure
16542 :type 'hook)
16544 (defun org-self-insert-command (N)
16545 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
16546 If the cursor is in a table looking at whitespace, the whitespace is
16547 overwritten, and the table is not marked as requiring realignment."
16548 (interactive "p")
16549 (cond
16550 ((and org-use-speed-commands
16551 (setq org-speed-command
16552 (run-hook-with-args-until-success
16553 'org-speed-command-hook (this-command-keys))))
16554 (cond
16555 ((commandp org-speed-command)
16556 (setq this-command org-speed-command)
16557 (call-interactively org-speed-command))
16558 ((functionp org-speed-command)
16559 (funcall org-speed-command))
16560 ((and org-speed-command (listp org-speed-command))
16561 (eval org-speed-command))
16562 (t (let (org-use-speed-commands)
16563 (call-interactively 'org-self-insert-command)))))
16564 ((and
16565 (org-table-p)
16566 (progn
16567 ;; check if we blank the field, and if that triggers align
16568 (and (featurep 'org-table) org-table-auto-blank-field
16569 (member last-command
16570 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
16572 ;; got extra space, this field does not determine column width
16573 (let (org-table-may-need-update) (org-table-blank-field))
16574 ;; no extra space, this field may determine column width
16575 (org-table-blank-field)))
16576 t)
16577 (eq N 1)
16579 (let (org-table-may-need-update)
16580 (goto-char (1- (match-end 0)))
16581 (delete-backward-char 1)
16582 (goto-char (match-beginning 0))
16583 (self-insert-command N)))
16584 (t
16585 (setq org-table-may-need-update t)
16586 (self-insert-command N)
16587 (org-fix-tags-on-the-fly)
16588 (if org-self-insert-cluster-for-undo
16589 (if (not (eq last-command 'org-self-insert-command))
16590 (setq org-self-insert-command-undo-counter 1)
16591 (if (>= org-self-insert-command-undo-counter 20)
16592 (setq org-self-insert-command-undo-counter 1)
16593 (and (> org-self-insert-command-undo-counter 0)
16594 buffer-undo-list
16595 (not (cadr buffer-undo-list)) ; remove nil entry
16596 (setcdr buffer-undo-list (cddr buffer-undo-list)))
16597 (setq org-self-insert-command-undo-counter
16598 (1+ org-self-insert-command-undo-counter))))))))
16600 (defun org-fix-tags-on-the-fly ()
16601 (when (and (equal (char-after (point-at-bol)) ?*)
16602 (org-on-heading-p))
16603 (org-align-tags-here org-tags-column)))
16605 (defun org-delete-backward-char (N)
16606 "Like `delete-backward-char', insert whitespace at field end in tables.
16607 When deleting backwards, in tables this function will insert whitespace in
16609 still be marked for re-alignment if the field did fill the entire column,
16610 because, in this case the deletion might narrow the column."
16611 (interactive "p")
16612 (if (and (org-table-p)
16613 (eq N 1)
16614 (string-match "|" (buffer-substring (point-at-bol) (point)))
16615 (looking-at ".*?|"))
16616 (let ((pos (point))
16618 (c org-table-may-need-update))
16619 (backward-delete-char N)
16620 (if (not overwrite-mode)
16621 (progn
16622 (skip-chars-forward "^|")
16623 (insert " ")
16624 (goto-char (1- pos))))
16625 ;; noalign: if there were two spaces at the end, this field
16626 ;; does not determine the width of the column.
16627 (if noalign (setq org-table-may-need-update c)))
16628 (backward-delete-char N)
16629 (org-fix-tags-on-the-fly)))
16631 (defun org-delete-char (N)
16632 "Like `delete-char', but insert whitespace at field end in tables.
16633 When deleting characters, in tables this function will insert whitespace in
16635 still be marked for re-alignment if the field did fill the entire column,
16636 because, in this case the deletion might narrow the column."
16637 (interactive "p")
16638 (if (and (org-table-p)
16639 (not (bolp))
16640 (not (= (char-after) ?|))
16641 (eq N 1))
16642 (if (looking-at ".*?|")
16643 (let ((pos (point))
16645 (c org-table-may-need-update))
16646 (replace-match (concat
16647 (substring (match-string 0) 1 -1)
16648 " |"))
16649 (goto-char pos)
16650 ;; noalign: if there were two spaces at the end, this field
16651 ;; does not determine the width of the column.
16652 (if noalign (setq org-table-may-need-update c)))
16653 (delete-char N))
16654 (delete-char N)
16655 (org-fix-tags-on-the-fly)))
16657 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
16658 (put 'org-self-insert-command 'delete-selection t)
16659 (put 'orgtbl-self-insert-command 'delete-selection t)
16660 (put 'org-delete-char 'delete-selection 'supersede)
16661 (put 'org-delete-backward-char 'delete-selection 'supersede)
16662 (put 'org-yank 'delete-selection 'yank)
16664 ;; Make `flyspell-mode' delay after some commands
16665 (put 'org-self-insert-command 'flyspell-delayed t)
16666 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
16667 (put 'org-delete-char 'flyspell-delayed t)
16668 (put 'org-delete-backward-char 'flyspell-delayed t)
16670 ;; Make pabbrev-mode expand after org-mode commands
16671 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
16672 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
16674 ;; How to do this: Measure non-white length of current string
16675 ;; If equal to column width, we should realign.
16677 (defun org-remap (map &rest commands)
16678 "In MAP, remap the functions given in COMMANDS.
16679 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
16680 (let (new old)
16681 (while commands
16682 (setq old (pop commands) new (pop commands))
16683 (if (fboundp 'command-remapping)
16684 (org-defkey map (vector 'remap old) new)
16685 (substitute-key-definition old new map global-map)))))
16687 (when (eq org-enable-table-editor 'optimized)
16688 ;; If the user wants maximum table support, we need to hijack
16689 ;; some standard editing functions
16690 (org-remap org-mode-map
16691 'self-insert-command 'org-self-insert-command
16692 'delete-char 'org-delete-char
16693 'delete-backward-char 'org-delete-backward-char)
16694 (org-defkey org-mode-map "|" 'org-force-self-insert))
16696 (defvar org-ctrl-c-ctrl-c-hook nil
16697 "Hook for functions attaching themselves to `C-c C-c'.
16698 This can be used to add additional functionality to the C-c C-c key which
16699 executes context-dependent commands.
16700 Each function will be called with no arguments. The function must check
16701 if the context is appropriate for it to act. If yes, it should do its
16702 thing and then return a non-nil value. If the context is wrong,
16703 just do nothing and return nil.")
16705 (defvar org-tab-first-hook nil
16706 "Hook for functions to attach themselves to TAB.
16707 See `org-ctrl-c-ctrl-c-hook' for more information.
16708 This hook runs as the first action when TAB is pressed, even before
16709 `org-cycle' messes around with the `outline-regexp' to cater for
16710 inline tasks and plain list item folding.
16711 If any function in this hook returns t, any other actions that
16712 would have been caused by TAB (such as table field motion or visibility
16713 cycling) will not occur.")
16715 (defvar org-tab-after-check-for-table-hook nil
16716 "Hook for functions to attach themselves to TAB.
16717 See `org-ctrl-c-ctrl-c-hook' for more information.
16718 This hook runs after it has been established that the cursor is not in a
16719 table, but before checking if the cursor is in a headline or if global cycling
16720 should be done.
16721 If any function in this hook returns t, not other actions like visibility
16722 cycling will be done.")
16724 (defvar org-tab-after-check-for-cycling-hook nil
16725 "Hook for functions to attach themselves to TAB.
16726 See `org-ctrl-c-ctrl-c-hook' for more information.
16727 This hook runs after it has been established that not table field motion and
16728 not visibility should be done because of current context. This is probably
16729 the place where a package like yasnippets can hook in.")
16731 (defvar org-tab-before-tab-emulation-hook nil
16732 "Hook for functions to attach themselves to TAB.
16733 See `org-ctrl-c-ctrl-c-hook' for more information.
16734 This hook runs after every other options for TAB have been exhausted, but
16737 (defvar org-metaleft-hook nil
16738 "Hook for functions attaching themselves to `M-left'.
16739 See `org-ctrl-c-ctrl-c-hook' for more information.")
16740 (defvar org-metaright-hook nil
16741 "Hook for functions attaching themselves to `M-right'.
16742 See `org-ctrl-c-ctrl-c-hook' for more information.")
16743 (defvar org-metaup-hook nil
16744 "Hook for functions attaching themselves to `M-up'.
16745 See `org-ctrl-c-ctrl-c-hook' for more information.")
16746 (defvar org-metadown-hook nil
16747 "Hook for functions attaching themselves to `M-down'.
16748 See `org-ctrl-c-ctrl-c-hook' for more information.")
16749 (defvar org-shiftmetaleft-hook nil
16750 "Hook for functions attaching themselves to `M-S-left'.
16751 See `org-ctrl-c-ctrl-c-hook' for more information.")
16752 (defvar org-shiftmetaright-hook nil
16753 "Hook for functions attaching themselves to `M-S-right'.
16754 See `org-ctrl-c-ctrl-c-hook' for more information.")
16755 (defvar org-shiftmetaup-hook nil
16756 "Hook for functions attaching themselves to `M-S-up'.
16757 See `org-ctrl-c-ctrl-c-hook' for more information.")
16758 (defvar org-shiftmetadown-hook nil
16759 "Hook for functions attaching themselves to `M-S-down'.
16760 See `org-ctrl-c-ctrl-c-hook' for more information.")
16761 (defvar org-metareturn-hook nil
16762 "Hook for functions attaching themselves to `M-RET'.
16763 See `org-ctrl-c-ctrl-c-hook' for more information.")
16764 (defvar org-shiftup-hook nil
16765 "Hook for functions attaching themselves to `S-up'.
16766 See `org-ctrl-c-ctrl-c-hook' for more information.")
16767 (defvar org-shiftup-final-hook nil
16768 "Hook for functions attaching themselves to `S-up'.
16769 This one runs after all other options except shift-select have been excluded.
16770 See `org-ctrl-c-ctrl-c-hook' for more information.")
16771 (defvar org-shiftdown-hook nil
16772 "Hook for functions attaching themselves to `S-down'.
16773 See `org-ctrl-c-ctrl-c-hook' for more information.")
16774 (defvar org-shiftdown-final-hook nil
16775 "Hook for functions attaching themselves to `S-down'.
16776 This one runs after all other options except shift-select have been excluded.
16777 See `org-ctrl-c-ctrl-c-hook' for more information.")
16778 (defvar org-shiftleft-hook nil
16779 "Hook for functions attaching themselves to `S-left'.
16780 See `org-ctrl-c-ctrl-c-hook' for more information.")
16781 (defvar org-shiftleft-final-hook nil
16782 "Hook for functions attaching themselves to `S-left'.
16783 This one runs after all other options except shift-select have been excluded.
16784 See `org-ctrl-c-ctrl-c-hook' for more information.")
16785 (defvar org-shiftright-hook nil
16786 "Hook for functions attaching themselves to `S-right'.
16787 See `org-ctrl-c-ctrl-c-hook' for more information.")
16788 (defvar org-shiftright-final-hook nil
16789 "Hook for functions attaching themselves to `S-right'.
16790 This one runs after all other options except shift-select have been excluded.
16791 See `org-ctrl-c-ctrl-c-hook' for more information.")
16793 (defun org-modifier-cursor-error ()
16794 "Throw an error, a modified cursor command was applied in wrong context."
16795 (error "This command is active in special context like tables, headlines or items"))
16797 (defun org-shiftselect-error ()
16798 "Throw an error because Shift-Cursor command was applied in wrong context."
16799 (if (and (boundp 'shift-select-mode) shift-select-mode)
16800 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
16801 (error "This command works only in special context like headlines or timestamps")))
16803 (defun org-call-for-shift-select (cmd)
16804 (let ((this-command-keys-shift-translated t))
16805 (call-interactively cmd)))
16807 (defun org-shifttab (&optional arg)
16808 "Global visibility cycling or move to previous table field.
16809 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
16810 on context.
16811 See the individual commands for more information."
16812 (interactive "P")
16813 (cond
16814 ((org-at-table-p) (call-interactively 'org-table-previous-field))
16815 ((integerp arg)
16816 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
16817 (message "Content view to level: %d" arg)
16818 (org-content (prefix-numeric-value arg2))
16819 (setq org-cycle-global-status 'overview)))
16820 (t (call-interactively 'org-global-cycle))))
16822 (defun org-shiftmetaleft ()
16823 "Promote subtree or delete table column.
16824 Calls `org-promote-subtree', `org-outdent-item',
16825 or `org-table-delete-column', depending on context.
16826 See the individual commands for more information."
16827 (interactive)
16828 (cond
16829 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
16830 ((org-at-table-p) (call-interactively 'org-table-delete-column))
16831 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
16832 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
16833 (t (org-modifier-cursor-error))))
16835 (defun org-shiftmetaright ()
16836 "Demote subtree or insert table column.
16837 Calls `org-demote-subtree', `org-indent-item',
16838 or `org-table-insert-column', depending on context.
16839 See the individual commands for more information."
16840 (interactive)
16841 (cond
16842 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
16843 ((org-at-table-p) (call-interactively 'org-table-insert-column))
16844 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
16845 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
16846 (t (org-modifier-cursor-error))))
16848 (defun org-shiftmetaup (&optional arg)
16849 "Move subtree up or kill table row.
16850 Calls `org-move-subtree-up' or `org-table-kill-row' or
16851 `org-move-item-up' depending on context. See the individual commands
16852 for more information."
16853 (interactive "P")
16854 (cond
16855 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
16856 ((org-at-table-p) (call-interactively 'org-table-kill-row))
16857 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16858 ((org-at-item-p) (call-interactively 'org-move-item-up))
16859 (t (org-modifier-cursor-error))))
16861 (defun org-shiftmetadown (&optional arg)
16862 "Move subtree down or insert table row.
16863 Calls `org-move-subtree-down' or `org-table-insert-row' or
16864 `org-move-item-down', depending on context. See the individual
16865 commands for more information."
16866 (interactive "P")
16867 (cond
16868 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
16869 ((org-at-table-p) (call-interactively 'org-table-insert-row))
16870 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16871 ((org-at-item-p) (call-interactively 'org-move-item-down))
16872 (t (org-modifier-cursor-error))))
16874 (defsubst org-hidden-tree-error ()
16875 (error
16876 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
16878 (defun org-metaleft (&optional arg)
16879 "Promote heading or move table column to left.
16880 Calls `org-do-promote' or `org-table-move-column', depending on context.
16881 With no specific context, calls the Emacs default `backward-word'.
16882 See the individual commands for more information."
16883 (interactive "P")
16884 (cond
16885 ((run-hook-with-args-until-success 'org-metaleft-hook))
16886 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
16887 ((or (org-on-heading-p)
16888 (and (org-region-active-p)
16889 (save-excursion
16890 (goto-char (region-beginning))
16891 (org-on-heading-p))))
16892 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16893 (call-interactively 'org-do-promote))
16894 ((or (org-at-item-p)
16895 (and (org-region-active-p)
16896 (save-excursion
16897 (goto-char (region-beginning))
16898 (org-at-item-p))))
16899 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16900 (call-interactively 'org-outdent-item))
16901 (t (call-interactively 'backward-word))))
16903 (defun org-metaright (&optional arg)
16904 "Demote subtree or move table column to right.
16905 Calls `org-do-demote' or `org-table-move-column', depending on context.
16906 With no specific context, calls the Emacs default `forward-word'.
16907 See the individual commands for more information."
16908 (interactive "P")
16909 (cond
16910 ((run-hook-with-args-until-success 'org-metaright-hook))
16911 ((org-at-table-p) (call-interactively 'org-table-move-column))
16912 ((or (org-on-heading-p)
16913 (and (org-region-active-p)
16914 (save-excursion
16915 (goto-char (region-beginning))
16916 (org-on-heading-p))))
16917 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16918 (call-interactively 'org-do-demote))
16919 ((or (org-at-item-p)
16920 (and (org-region-active-p)
16921 (save-excursion
16922 (goto-char (region-beginning))
16923 (org-at-item-p))))
16924 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16925 (call-interactively 'org-indent-item))
16926 (t (call-interactively 'forward-word))))
16928 (defun org-check-for-hidden (what)
16929 "Check if there are hidden headlines/items in the current visual line.
16930 WHAT can be either `headlines' or `items'. If the current line is
16931 an outline or item heading and it has a folded subtree below it,
16932 this function returns t, nil otherwise."
16933 (let ((re (cond
16934 ((eq what 'headlines) (concat "^" org-outline-regexp))
16935 ((eq what 'items) (concat "^" (org-item-re t)))
16936 (t (error "This should not happen"))))
16937 beg end)
16938 (save-excursion
16939 (catch 'exit
16940 (unless (org-region-active-p)
16941 (setq beg (point-at-bol))
16942 (beginning-of-line 2)
16943 (while (and (not (eobp)) ;; this is like `next-line'
16944 (get-char-property (1- (point)) 'invisible))
16945 (beginning-of-line 2))
16946 (setq end (point))
16947 (goto-char beg)
16948 (goto-char (point-at-eol))
16949 (setq end (max end (point)))
16950 (while (re-search-forward re end t)
16951 (if (get-char-property (match-beginning 0) 'invisible)
16952 (throw 'exit t))))
16953 nil))))
16955 (defun org-metaup (&optional arg)
16956 "Move subtree up or move table row up.
16957 Calls `org-move-subtree-up' or `org-table-move-row' or
16958 `org-move-item-up', depending on context. See the individual commands
16959 for more information."
16960 (interactive "P")
16961 (cond
16962 ((run-hook-with-args-until-success 'org-metaup-hook))
16963 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
16964 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16965 ((org-at-item-p) (call-interactively 'org-move-item-up))
16966 (t (transpose-lines 1) (beginning-of-line -1))))
16968 (defun org-metadown (&optional arg)
16969 "Move subtree down or move table row down.
16970 Calls `org-move-subtree-down' or `org-table-move-row' or
16971 `org-move-item-down', depending on context. See the individual
16972 commands for more information."
16973 (interactive "P")
16974 (cond
16975 ((run-hook-with-args-until-success 'org-metadown-hook))
16976 ((org-at-table-p) (call-interactively 'org-table-move-row))
16977 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16978 ((org-at-item-p) (call-interactively 'org-move-item-down))
16979 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
16981 (defun org-shiftup (&optional arg)
16982 "Increase item in timestamp or increase priority of current headline.
16983 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
16984 depending on context. See the individual commands for more information."
16985 (interactive "P")
16986 (cond
16987 ((run-hook-with-args-until-success 'org-shiftup-hook))
16988 ((and org-support-shift-select (org-region-active-p))
16989 (org-call-for-shift-select 'previous-line))
16990 ((org-at-timestamp-p t)
16991 (call-interactively (if org-edit-timestamp-down-means-later
16992 'org-timestamp-down 'org-timestamp-up)))
16993 ((and (not (eq org-support-shift-select 'always))
16994 org-enable-priority-commands
16995 (org-on-heading-p))
16996 (call-interactively 'org-priority-up))
16997 ((and (not org-support-shift-select) (org-at-item-p))
16998 (call-interactively 'org-previous-item))
16999 ((org-clocktable-try-shift 'up arg))
17000 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17001 (org-support-shift-select
17002 (org-call-for-shift-select 'previous-line))
17003 (t (org-shiftselect-error))))
17005 (defun org-shiftdown (&optional arg)
17006 "Decrease item in timestamp or decrease priority of current headline.
17007 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17008 depending on context. See the individual commands for more information."
17009 (interactive "P")
17010 (cond
17011 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17012 ((and org-support-shift-select (org-region-active-p))
17013 (org-call-for-shift-select 'next-line))
17014 ((org-at-timestamp-p t)
17015 (call-interactively (if org-edit-timestamp-down-means-later
17016 'org-timestamp-up 'org-timestamp-down)))
17017 ((and (not (eq org-support-shift-select 'always))
17018 org-enable-priority-commands
17019 (org-on-heading-p))
17020 (call-interactively 'org-priority-down))
17021 ((and (not org-support-shift-select) (org-at-item-p))
17022 (call-interactively 'org-next-item))
17023 ((org-clocktable-try-shift 'down arg))
17024 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17025 (org-support-shift-select
17026 (org-call-for-shift-select 'next-line))
17027 (t (org-shiftselect-error))))
17029 (defun org-shiftright (&optional arg)
17030 "Cycle the thing at point or in the current line, depending on context.
17031 Depending on context, this does one of the following:
17033 - switch a timestamp at point one day into the future
17034 - on a headline, switch to the next TODO keyword.
17035 - on an item, switch entire list to the next bullet type
17036 - on a property line, switch to the next allowed value
17037 - on a clocktable definition line, move time block into the future"
17038 (interactive "P")
17039 (cond
17040 ((run-hook-with-args-until-success 'org-shiftright-hook))
17041 ((and org-support-shift-select (org-region-active-p))
17042 (org-call-for-shift-select 'forward-char))
17043 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17044 ((and (not (eq org-support-shift-select 'always))
17045 (org-on-heading-p))
17046 (let ((org-inhibit-logging
17047 (not org-treat-S-cursor-todo-selection-as-state-change))
17048 (org-inhibit-blocking
17049 (not org-treat-S-cursor-todo-selection-as-state-change)))
17050 (org-call-with-arg 'org-todo 'right)))
17051 ((or (and org-support-shift-select
17052 (not (eq org-support-shift-select 'always))
17053 (org-at-item-bullet-p))
17054 (and (not org-support-shift-select) (org-at-item-p)))
17055 (org-call-with-arg 'org-cycle-list-bullet nil))
17056 ((and (not (eq org-support-shift-select 'always))
17057 (org-at-property-p))
17058 (call-interactively 'org-property-next-allowed-value))
17059 ((org-clocktable-try-shift 'right arg))
17060 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17061 (org-support-shift-select
17062 (org-call-for-shift-select 'forward-char))
17063 (t (org-shiftselect-error))))
17065 (defun org-shiftleft (&optional arg)
17066 "Cycle the thing at point or in the current line, depending on context.
17067 Depending on context, this does one of the following:
17069 - switch a timestamp at point one day into the past
17070 - on a headline, switch to the previous TODO keyword.
17071 - on an item, switch entire list to the previous bullet type
17072 - on a property line, switch to the previous allowed value
17073 - on a clocktable definition line, move time block into the past"
17074 (interactive "P")
17075 (cond
17076 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17077 ((and org-support-shift-select (org-region-active-p))
17078 (org-call-for-shift-select 'backward-char))
17079 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17080 ((and (not (eq org-support-shift-select 'always))
17081 (org-on-heading-p))
17082 (let ((org-inhibit-logging
17083 (not org-treat-S-cursor-todo-selection-as-state-change))
17084 (org-inhibit-blocking
17085 (not org-treat-S-cursor-todo-selection-as-state-change)))
17086 (org-call-with-arg 'org-todo 'left)))
17087 ((or (and org-support-shift-select
17088 (not (eq org-support-shift-select 'always))
17089 (org-at-item-bullet-p))
17090 (and (not org-support-shift-select) (org-at-item-p)))
17091 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17092 ((and (not (eq org-support-shift-select 'always))
17093 (org-at-property-p))
17094 (call-interactively 'org-property-previous-allowed-value))
17095 ((org-clocktable-try-shift 'left arg))
17096 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17097 (org-support-shift-select
17098 (org-call-for-shift-select 'backward-char))
17099 (t (org-shiftselect-error))))
17101 (defun org-shiftcontrolright ()
17102 "Switch to next TODO set."
17103 (interactive)
17104 (cond
17105 ((and org-support-shift-select (org-region-active-p))
17106 (org-call-for-shift-select 'forward-word))
17107 ((and (not (eq org-support-shift-select 'always))
17108 (org-on-heading-p))
17109 (org-call-with-arg 'org-todo 'nextset))
17110 (org-support-shift-select
17111 (org-call-for-shift-select 'forward-word))
17112 (t (org-shiftselect-error))))
17114 (defun org-shiftcontrolleft ()
17115 "Switch to previous TODO set."
17116 (interactive)
17117 (cond
17118 ((and org-support-shift-select (org-region-active-p))
17119 (org-call-for-shift-select 'backward-word))
17120 ((and (not (eq org-support-shift-select 'always))
17121 (org-on-heading-p))
17122 (org-call-with-arg 'org-todo 'previousset))
17123 (org-support-shift-select
17124 (org-call-for-shift-select 'backward-word))
17125 (t (org-shiftselect-error))))
17127 (defun org-ctrl-c-ret ()
17128 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17129 (interactive)
17130 (cond
17131 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17132 (t (call-interactively 'org-insert-heading))))
17134 (defun org-copy-special ()
17135 "Copy region in table or copy current subtree.
17136 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17137 See the individual commands for more information."
17138 (interactive)
17139 (call-interactively
17140 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17142 (defun org-cut-special ()
17143 "Cut region in table or cut current subtree.
17144 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17145 See the individual commands for more information."
17146 (interactive)
17147 (call-interactively
17148 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17150 (defun org-paste-special (arg)
17151 "Paste rectangular region into table, or past subtree relative to level.
17152 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17153 See the individual commands for more information."
17154 (interactive "P")
17155 (if (org-at-table-p)
17156 (org-table-paste-rectangle)
17157 (org-paste-subtree arg)))
17159 (defun org-edit-special (&optional arg)
17160 "Call a special editor for the stuff at point.
17161 When at a table, call the formula editor with `org-table-edit-formulas'.
17162 When at the first line of an src example, call `org-edit-src-code'.
17163 When in an #+include line, visit the include file. Otherwise call
17164 `ffap' to visit the file at point."
17165 (interactive)
17166 ;; possibly prep session before editing source
17167 (when arg
17168 (let* ((info (org-babel-get-src-block-info))
17169 (lang (nth 0 info))
17170 (params (nth 2 info))
17171 (session (cdr (assoc :session params))))
17172 (when (and info session) ;; we are in a source-code block with a session
17173 (funcall
17174 (intern (concat "org-babel-prep-session:" lang)) session params))))
17175 (cond ;; proceed with `org-edit-special'
17176 ((save-excursion
17177 (beginning-of-line 1)
17178 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17179 (find-file (org-trim (match-string 1))))
17180 ((org-edit-src-code))
17181 ((org-edit-fixed-width-region))
17182 ((org-at-table.el-p)
17183 (org-edit-src-code))
17184 ((or (org-at-table-p)
17185 (save-excursion
17186 (beginning-of-line 1)
17188 (call-interactively 'org-table-edit-formulas))
17189 (t (call-interactively 'ffap))))
17191 (defun org-ctrl-c-ctrl-c (&optional arg)
17192 "Set tags in headline, or update according to changed information at point.
17194 This command does many different things, depending on context:
17196 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17197 this is what we do.
17199 - If the cursor is on a statistics cookie, update it.
17201 - If the cursor is in a headline, prompt for tags and insert them
17202 into the current line, aligned to `org-tags-column'. When called
17203 with prefix arg, realign all tags in the current buffer.
17205 - If the cursor is in one of the special #+KEYWORD lines, this
17206 triggers scanning the buffer for these lines and updating the
17207 information.
17209 - If the cursor is inside a table, realign the table. This command
17210 works even if the automatic table editor has been turned off.
17212 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17213 the entire table.
17215 - If the cursor is at a footnote reference or definition, jump to
17216 the corresponding definition or references, respectively.
17218 - If the cursor is a the beginning of a dynamic block, update it.
17220 - If the current buffer is a capture buffer, close note and file it.
17222 - If the cursor is on a <<<target>>>, update radio targets and
17223 corresponding links in this buffer.
17225 - If the cursor is on a numbered item in a plain list, renumber the
17226 ordered list.
17228 - If the cursor is on a checkbox, toggle it.
17230 - If the cursor is on a code block, evaluate it. The variable
17231 `org-confirm-babel-evaluate' can be used to control prompting
17232 before code block evaluation, by default every code block
17233 evaluation requires confirmation. Code block evaluation can be
17234 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17235 (interactive "P")
17236 (let ((org-enable-table-editor t))
17237 (cond
17238 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17239 org-occur-highlights
17240 org-latex-fragment-image-overlays)
17241 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17242 (org-remove-occur-highlights)
17243 (org-remove-latex-fragment-image-overlays)
17244 (message "Temporary highlights/overlays removed from current buffer"))
17245 ((and (local-variable-p 'org-finish-function (current-buffer))
17246 (fboundp org-finish-function))
17247 (funcall org-finish-function))
17248 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17249 ((or (looking-at org-property-start-re)
17250 (org-at-property-p))
17251 (call-interactively 'org-property-action))
17252 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17254 (or (org-on-heading-p) (org-at-item-p)))
17255 (call-interactively 'org-update-statistics-cookies))
17256 ((org-on-heading-p) (call-interactively 'org-set-tags))
17257 ((org-at-table.el-p)
17258 (message "Use C-c ' to edit table.el tables"))
17259 ((org-at-table-p)
17260 (org-table-maybe-eval-formula)
17261 (if arg
17262 (call-interactively 'org-table-recalculate)
17263 (org-table-maybe-recalculate-line))
17264 (call-interactively 'org-table-align)
17265 (orgtbl-send-table 'maybe))
17266 ((or (org-footnote-at-reference-p)
17267 (org-footnote-at-definition-p))
17268 (call-interactively 'org-footnote-action))
17269 ((org-at-item-checkbox-p)
17270 (call-interactively 'org-list-repair)
17271 (call-interactively 'org-toggle-checkbox)
17272 (org-list-send-list 'maybe))
17273 ((org-at-item-p)
17274 (call-interactively 'org-list-repair)
17275 (when arg (call-interactively 'org-toggle-checkbox))
17276 (org-list-send-list 'maybe))
17277 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17278 ;; Dynamic block
17279 (beginning-of-line 1)
17280 (save-excursion (org-update-dblock)))
17281 ((save-excursion
17282 (beginning-of-line 1)
17284 (cond
17285 ((equal (match-string 1) "TBLFM")
17286 ;; Recalculate the table before this line
17287 (save-excursion
17288 (beginning-of-line 1)
17290 (if (org-at-table-p)
17291 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17292 (t
17293 (let ((org-inhibit-startup-visibility-stuff t)
17294 (org-startup-align-all-tables nil))
17295 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17296 (message "Local setup has been refreshed"))))
17297 ((org-clock-update-time-maybe))
17298 (t (error "C-c C-c can do nothing useful at this location")))))
17300 (defun org-mode-restart ()
17301 "Restart Org-mode, to scan again for special lines.
17302 Also updates the keyword regular expressions."
17303 (interactive)
17304 (org-mode)
17305 (message "Org-mode restarted"))
17307 (defun org-kill-note-or-show-branches ()
17308 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17309 (interactive)
17310 (if (not org-finish-function)
17311 (progn
17312 (hide-subtree)
17313 (call-interactively 'show-branches))
17314 (let ((org-note-abort t))
17315 (funcall org-finish-function))))
17317 (defun org-return (&optional indent)
17318 "Goto next table row or insert a newline.
17319 Calls `org-table-next-row' or `newline', depending on context.
17320 See the individual commands for more information."
17321 (interactive)
17322 (cond
17323 ((bobp) (if indent (newline-and-indent) (newline)))
17324 ((org-at-table-p)
17325 (org-table-justify-field-maybe)
17326 (call-interactively 'org-table-next-row))
17327 ((and org-return-follows-link
17328 (eq (get-text-property (point) 'face) 'org-link))
17329 (call-interactively 'org-open-at-point))
17330 ((and (org-at-heading-p)
17331 (looking-at
17333 (org-show-entry)
17334 (end-of-line 1)
17335 (newline))
17336 (t (if indent (newline-and-indent) (newline)))))
17338 (defun org-return-indent ()
17339 "Goto next table row or insert a newline and indent.
17340 Calls `org-table-next-row' or `newline-and-indent', depending on
17341 context. See the individual commands for more information."
17342 (interactive)
17343 (org-return t))
17345 (defun org-ctrl-c-star ()
17346 "Compute table, or change heading status of lines.
17347 Calls `org-table-recalculate' or `org-toggle-heading',
17348 depending on context."
17349 (interactive)
17350 (cond
17351 ((org-at-table-p)
17352 (call-interactively 'org-table-recalculate))
17353 (t
17354 ;; Convert all lines in region to list items
17355 (call-interactively 'org-toggle-heading))))
17357 (defun org-ctrl-c-minus ()
17358 "Insert separator line in table or modify bullet status of line.
17359 Also turns a plain line or a region of lines into list items.
17360 Calls `org-table-insert-hline', `org-toggle-item', or
17361 `org-cycle-list-bullet', depending on context."
17362 (interactive)
17363 (cond
17364 ((org-at-table-p)
17365 (call-interactively 'org-table-insert-hline))
17366 ((org-region-active-p)
17367 (call-interactively 'org-toggle-item))
17368 ((org-in-item-p)
17369 (call-interactively 'org-cycle-list-bullet))
17370 (t
17371 (call-interactively 'org-toggle-item))))
17373 (defun org-toggle-item ()
17374 "Convert headings or normal lines to items, items to normal lines.
17375 If there is no active region, only the current line is considered.
17377 If the first line in the region is a headline, convert all headlines to items.
17379 If the first line in the region is an item, convert all items to normal lines.
17381 If the first line is normal text, add an item bullet to each line."
17382 (interactive)
17383 (let (l2 l beg end)
17384 (if (org-region-active-p)
17385 (setq beg (region-beginning) end (region-end))
17386 (setq beg (point-at-bol)
17387 end (min (1+ (point-at-eol)) (point-max))))
17388 (save-excursion
17389 (goto-char end)
17390 (setq l2 (org-current-line))
17391 (goto-char beg)
17392 (beginning-of-line 1)
17393 (setq l (1- (org-current-line)))
17394 (if (org-at-item-p)
17395 ;; We already have items, de-itemize
17396 (while (< (setq l (1+ l)) l2)
17397 (when (org-at-item-p)
17399 (delete-region (point) (match-end 0)))
17400 (beginning-of-line 2))
17401 (if (org-on-heading-p)
17402 ;; Headings, convert to items
17403 (while (< (setq l (1+ l)) l2)
17404 (if (looking-at org-outline-regexp)
17405 (replace-match (org-list-bullet-string "-") t t))
17406 (beginning-of-line 2))
17407 ;; normal lines, turn them into items
17408 (while (< (setq l (1+ l)) l2)
17409 (unless (org-at-item-p)
17411 (replace-match
17413 (beginning-of-line 2)))))))
17415 (defun org-toggle-heading (&optional nstars)
17416 "Convert headings to normal text, or items or text to headings.
17417 If there is no active region, only the current line is considered.
17419 If the first line is a heading, remove the stars from all headlines
17420 in the region.
17422 If the first line is a plain list item, turn all plain list items
17423 into headings.
17425 If the first line is a normal line, turn each and every line in the
17426 region into a heading.
17428 When converting a line into a heading, the number of stars is chosen
17429 such that the lines become children of the current entry. However,
17430 when a prefix argument is given, its value determines the number of
17431 stars to add."
17432 (interactive "P")
17433 (let (l2 l itemp beg end)
17434 (if (org-region-active-p)
17435 (setq beg (region-beginning) end (region-end))
17436 (setq beg (point-at-bol)
17437 end (min (1+ (point-at-eol)) (point-max))))
17438 (save-excursion
17439 (goto-char end)
17440 (setq l2 (org-current-line))
17441 (goto-char beg)
17442 (beginning-of-line 1)
17443 (setq l (1- (org-current-line)))
17444 (if (org-on-heading-p)
17445 ;; We already have headlines, de-star them
17446 (while (< (setq l (1+ l)) l2)
17447 (when (org-on-heading-p t)
17448 (and (looking-at outline-regexp) (replace-match "")))
17449 (beginning-of-line 2))
17450 (setq itemp (org-at-item-p))
17451 (let* ((stars
17452 (if nstars
17453 (make-string (prefix-numeric-value current-prefix-arg)
17454 ?*)
17455 (save-excursion
17456 (if (re-search-backward org-complex-heading-regexp nil t)
17457 (match-string 1) ""))))
17458 (add-stars (cond (nstars "")
17459 ((equal stars "") "*")
17460 (org-odd-levels-only "**")
17461 (t "*")))
17462 (rpl (concat stars add-stars " ")))
17463 (while (< (setq l (1+ l)) l2)
17464 (if itemp
17465 (and (org-at-item-p) (replace-match rpl t t))
17466 (unless (org-on-heading-p)
17468 (replace-match (concat rpl (match-string 2))))))
17469 (beginning-of-line 2)))))))
17471 (defun org-meta-return (&optional arg)
17472 "Insert a new heading or wrap a region in a table.
17473 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17474 See the individual commands for more information."
17475 (interactive "P")
17476 (cond
17477 ((run-hook-with-args-until-success 'org-metareturn-hook))
17478 ((org-at-table-p)
17479 (call-interactively 'org-table-wrap-region))
17480 (t (call-interactively 'org-insert-heading))))
17482 ;;; Menu entries
17484 ;; Define the Org-mode menus
17485 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
17486 '("Tbl"
17487 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
17488 ["Next Field" org-cycle (org-at-table-p)]
17489 ["Previous Field" org-shifttab (org-at-table-p)]
17490 ["Next Row" org-return (org-at-table-p)]
17491 "--"
17492 ["Blank Field" org-table-blank-field (org-at-table-p)]
17493 ["Edit Field" org-table-edit-field (org-at-table-p)]
17494 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
17495 "--"
17496 ("Column"
17497 ["Move Column Left" org-metaleft (org-at-table-p)]
17498 ["Move Column Right" org-metaright (org-at-table-p)]
17499 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
17500 ["Insert Column" org-shiftmetaright (org-at-table-p)])
17501 ("Row"
17502 ["Move Row Up" org-metaup (org-at-table-p)]
17503 ["Move Row Down" org-metadown (org-at-table-p)]
17504 ["Delete Row" org-shiftmetaup (org-at-table-p)]
17505 ["Insert Row" org-shiftmetadown (org-at-table-p)]
17506 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
17507 "--"
17508 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
17509 ("Rectangle"
17510 ["Copy Rectangle" org-copy-special (org-at-table-p)]
17511 ["Cut Rectangle" org-cut-special (org-at-table-p)]
17512 ["Paste Rectangle" org-paste-special (org-at-table-p)]
17513 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
17514 "--"
17515 ("Calculate"
17516 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
17517 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17518 ["Edit Formulas" org-edit-special (org-at-table-p)]
17519 "--"
17520 ["Recalculate line" org-table-recalculate (org-at-table-p)]
17521 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17522 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
17523 "--"
17524 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
17525 "--"
17526 ["Sum Column/Rectangle" org-table-sum
17527 (or (org-at-table-p) (org-region-active-p))]
17528 ["Which Column?" org-table-current-column (org-at-table-p)])
17529 ["Debug Formulas"
17530 org-table-toggle-formula-debugger
17531 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
17532 ["Show Col/Row Numbers"
17533 org-table-toggle-coordinate-overlays
17534 :style toggle
17535 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
17536 "--"
17537 ["Create" org-table-create (and (not (org-at-table-p))
17538 org-enable-table-editor)]
17539 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
17540 ["Import from File" org-table-import (not (org-at-table-p))]
17541 ["Export to File" org-table-export (org-at-table-p)]
17542 "--"
17543 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
17545 (easy-menu-define org-org-menu org-mode-map "Org menu"
17546 '("Org"
17547 ("Show/Hide"
17548 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
17549 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
17550 ["Sparse Tree..." org-sparse-tree t]
17551 ["Reveal Context" org-reveal t]
17552 ["Show All" show-all t]
17553 "--"
17554 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
17555 "--"
17556 ["New Heading" org-insert-heading t]
17557 ("Navigate Headings"
17558 ["Up" outline-up-heading t]
17559 ["Next" outline-next-visible-heading t]
17560 ["Previous" outline-previous-visible-heading t]
17561 ["Next Same Level" outline-forward-same-level t]
17562 ["Previous Same Level" outline-backward-same-level t]
17563 "--"
17564 ["Jump" org-goto t])
17565 ("Edit Structure"
17566 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
17567 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
17568 "--"
17569 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
17570 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
17571 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
17572 "--"
17573 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
17574 "--"
17575 ["Promote Heading" org-metaleft (not (org-at-table-p))]
17576 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
17577 ["Demote Heading" org-metaright (not (org-at-table-p))]
17578 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
17579 "--"
17580 ["Sort Region/Children" org-sort (not (org-at-table-p))]
17581 "--"
17582 ["Convert to odd levels" org-convert-to-odd-levels t]
17583 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
17584 ("Editing"
17585 ["Emphasis..." org-emphasize t]
17586 ["Edit Source Example" org-edit-special t]
17587 "--"
17588 ["Footnote new/jump" org-footnote-action t]
17589 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
17590 ("Archive"
17591 ["Archive (default method)" org-archive-subtree-default t]
17592 "--"
17593 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
17594 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
17595 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
17596 )
17597 "--"
17598 ("Hyperlinks"
17599 ["Store Link (Global)" org-store-link t]
17600 ["Find existing link to here" org-occur-link-in-agenda-files t]
17601 ["Insert Link" org-insert-link t]
17602 ["Follow Link" org-open-at-point t]
17603 "--"
17604 ["Next link" org-next-link t]
17605 ["Previous link" org-previous-link t]
17606 "--"
17607 ["Descriptive Links"
17608 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
17609 :style radio
17610 :selected (member '(org-link) buffer-invisibility-spec)]
17611 ["Literal Links"
17612 (progn
17613 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
17614 :style radio
17615 :selected (not (member '(org-link) buffer-invisibility-spec))])
17616 "--"
17617 ("TODO Lists"
17618 ["TODO/DONE/-" org-todo t]
17619 ("Select keyword"
17620 ["Next keyword" org-shiftright (org-on-heading-p)]
17621 ["Previous keyword" org-shiftleft (org-on-heading-p)]
17622 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
17623 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
17624 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
17625 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
17626 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
17627 "--"
17628 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
17629 :selected org-enforce-todo-dependencies :style toggle :active t]
17630 "Settings for tree at point"
17631 ["Do Children sequentially" org-toggle-ordered-property :style radio
17632 :selected (ignore-errors (org-entry-get nil "ORDERED"))
17633 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17634 ["Do Children parallel" org-toggle-ordered-property :style radio
17635 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
17636 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17637 "--"
17638 ["Set Priority" org-priority t]
17639 ["Priority Up" org-shiftup t]
17640 ["Priority Down" org-shiftdown t]
17641 "--"
17642 ["Get news from all feeds" org-feed-update-all t]
17643 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
17644 ["Customize feeds" (customize-variable 'org-feed-alist) t])
17645 ("TAGS and Properties"
17646 ["Set Tags" org-set-tags-command t]
17647 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
17648 "--"
17649 ["Set property" org-set-property t]
17650 ["Column view of properties" org-columns t]
17651 ["Insert Column View DBlock" org-insert-columns-dblock t])
17652 ("Dates and Scheduling"
17653 ["Timestamp" org-time-stamp t]
17654 ["Timestamp (inactive)" org-time-stamp-inactive t]
17655 ("Change Date"
17656 ["1 Day Later" org-shiftright t]
17657 ["1 Day Earlier" org-shiftleft t]
17658 ["1 ... Later" org-shiftup t]
17659 ["1 ... Earlier" org-shiftdown t])
17660 ["Compute Time Range" org-evaluate-time-range t]
17661 ["Schedule Item" org-schedule t]
17662 ["Deadline" org-deadline t]
17663 "--"
17664 ["Custom time format" org-toggle-time-stamp-overlays
17665 :style radio :selected org-display-custom-times]
17666 "--"
17667 ["Goto Calendar" org-goto-calendar t]
17668 ["Date from Calendar" org-date-from-calendar t]
17669 "--"
17670 ["Start/Restart Timer" org-timer-start t]
17671 ["Pause/Continue Timer" org-timer-pause-or-continue t]
17672 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
17673 ["Insert Timer String" org-timer t]
17674 ["Insert Timer Item" org-timer-item t])
17675 ("Logging work"
17676 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
17677 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
17678 ["Clock out" org-clock-out t]
17679 ["Clock cancel" org-clock-cancel t]
17680 "--"
17681 ["Mark as default task" org-clock-mark-default-task t]
17682 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
17683 ["Goto running clock" org-clock-goto t]
17684 "--"
17685 ["Display times" org-clock-display t]
17686 ["Create clock table" org-clock-report t]
17687 "--"
17688 ["Record DONE time"
17689 (progn (setq org-log-done (not org-log-done))
17690 (message "Switching to %s will %s record a timestamp"
17691 (car org-done-keywords)
17692 (if org-log-done "automatically" "not")))
17693 :style toggle :selected org-log-done])
17694 "--"
17695 ["Agenda Command..." org-agenda t]
17696 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
17697 ("File List for Agenda")
17698 ("Special views current file"
17699 ["TODO Tree" org-show-todo-tree t]
17700 ["Check Deadlines" org-check-deadlines t]
17701 ["Timeline" org-timeline t]
17702 ["Tags/Property tree" org-match-sparse-tree t])
17703 "--"
17704 ["Export/Publish..." org-export t]
17705 ("LaTeX"
17706 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
17707 :selected org-cdlatex-mode]
17708 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
17709 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
17710 ["Modify math symbol" org-cdlatex-math-modify
17711 (org-inside-LaTeX-fragment-p)]
17712 ["Insert citation" org-reftex-citation t]
17713 "--"
17714 ["Template for BEAMER" org-insert-beamer-options-template t])
17715 "--"
17716 ("MobileOrg"
17717 ["Push Files and Views" org-mobile-push t]
17718 ["Get Captured and Flagged" org-mobile-pull t]
17719 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
17720 "--"
17721 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
17722 "--"
17723 ("Documentation"
17724 ["Show Version" org-version t]
17725 ["Info Documentation" org-info t])
17726 ("Customize"
17727 ["Browse Org Group" org-customize t]
17728 "--"
17729 ["Expand This Menu" org-create-customize-menu
17730 (fboundp 'customize-menu-create)])
17731 ["Send bug report" org-submit-bug-report t]
17732 "--"
17733 ("Refresh/Reload"
17734 ["Refresh setup current buffer" org-mode-restart t]
17735 ["Reload Org (after update)" org-reload t]
17736 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
17737 ))
17739 (defun org-info (&optional node)
17740 "Read documentation for Org-mode in the info system.
17741 With optional NODE, go directly to that node."
17742 (interactive)
17743 (info (format "(org)%s" (or node ""))))
17745 ;;;###autoload
17746 (defun org-submit-bug-report ()
17747 "Submit a bug report on Org-mode via mail.
17749 Don't hesitate to report any problems or inaccurate documentation.
17751 If you don't have setup sending mail from (X)Emacs, please copy the
17752 output buffer into your mail program, as it gives us important
17753 information about your Org-mode version and configuration."
17754 (interactive)
17755 (require 'reporter)
17756 (org-load-modules-maybe)
17757 (org-require-autoloaded-modules)
17758 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
17759 (reporter-submit-bug-report
17760 "emacs-orgmode@gnu.org"
17761 (org-version)
17762 (let (list)
17763 (save-window-excursion
17764 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
17765 (delete-other-windows)
17766 (erase-buffer)
17767 (insert "You are about to submit a bug report to the Org-mode mailing list.
17769 We would like to add your full Org-mode and Outline configuration to the
17770 bug report. This greatly simplifies the work of the maintainer and
17771 other experts on the mailing list.
17773 HOWEVER, some variables you have customized may contain private
17774 information. The names of customers, colleagues, or friends, might
17775 appear in the form of file names, tags, todo states, or search strings.
17776 If you answer yes to the prompt, you might want to check and remove
17777 such private information before sending the email.")
17778 (add-text-properties (point-min) (point-max) '(face org-warning))
17779 (when (yes-or-no-p "Include your Org-mode configuration ")
17780 (mapatoms
17781 (lambda (v)
17782 (and (boundp v)
17784 (or (and (symbol-value v)
17786 (and
17787 (get v 'custom-type) (get v 'standard-value)
17788 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
17789 (push v list)))))
17790 (kill-buffer (get-buffer "*Warn about privacy*"))
17791 list))
17792 nil nil
17793 "Remember to cover the basics, that is, what you expected to happen and
17794 what in fact did happen. You don't know how to make a good report? See
17796 http://orgmode.org/manual/Feedback.html#Feedback
17798 Your bug report will be posted to the Org-mode mailing list.
17799 ------------------------------------------------------------------------")
17800 (save-excursion
17805 (defun org-install-agenda-files-menu ()
17806 (let ((bl (buffer-list)))
17807 (save-excursion
17808 (while bl
17809 (set-buffer (pop bl))
17810 (if (org-mode-p) (setq bl nil)))
17811 (when (org-mode-p)
17812 (easy-menu-change
17813 '("Org") "File List for Agenda"
17814 (append
17815 (list
17816 ["Edit File List" (org-edit-agenda-file-list) t]
17817 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
17818 ["Remove Current File from List" org-remove-file t]
17819 ["Cycle through agenda files" org-cycle-agenda-files t]
17820 ["Occur in all agenda files" org-occur-in-agenda-files t]
17821 "--")
17822 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
17824 ;;;; Documentation
17826 ;;;###autoload
17827 (defun org-require-autoloaded-modules ()
17828 (interactive)
17829 (mapc 'require
17830 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
17831 org-docbook org-exp org-html org-icalendar
17832 org-id org-latex
17833 org-publish org-remember org-table
17834 org-timer org-xoxo)))
17836 ;;;###autoload
17837 (defun org-reload (&optional uncompiled)
17838 "Reload all org lisp files.
17839 With prefix arg UNCOMPILED, load the uncompiled versions."
17840 (interactive "P")
17841 (require 'find-func)
17843 (dir-org (file-name-directory (org-find-library-name "org")))
17844 (dir-org-contrib (ignore-errors
17845 (file-name-directory
17846 (org-find-library-name "org-contribdir"))))
17847 (babel-files
17848 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
17849 (append (list nil "comint" "eval" "exp" "keys"
17850 "lob" "ref" "table" "tangle")
17851 (delq nil
17852 (mapcar
17853 (lambda (lang)
17854 (when (cdr lang) (symbol-name (car lang))))
17855 org-babel-load-languages)))))
17856 (files
17857 (append (directory-files dir-org t file-re)
17858 babel-files
17859 (and dir-org-contrib
17860 (directory-files dir-org-contrib t file-re))))
17861 (remove-re (concat (if (featurep 'xemacs)
17862 "org-colview" "org-colview-xemacs")
17864 (setq files (mapcar 'file-name-sans-extension files))
17865 (setq files (mapcar
17866 (lambda (x) (if (string-match remove-re x) nil x))
17867 files))
17868 (setq files (delq nil files))
17869 (mapc
17870 (lambda (f)
17871 (when (featurep (intern (file-name-nondirectory f)))
17872 (if (and (not uncompiled)
17873 (file-exists-p (concat f ".elc")))
17874 (load (concat f ".elc") nil nil t)
17875 (load (concat f ".el") nil nil t))))
17876 files))
17877 (org-version))
17879 ;;;###autoload
17880 (defun org-customize ()
17881 "Call the customize function with org as argument."
17882 (interactive)
17883 (org-load-modules-maybe)
17884 (org-require-autoloaded-modules)
17885 (customize-browse 'org))
17887 (defun org-create-customize-menu ()
17888 "Create a full customization menu for Org-mode, insert it into the menu."
17889 (interactive)
17890 (org-load-modules-maybe)
17891 (org-require-autoloaded-modules)
17892 (if (fboundp 'customize-menu-create)
17893 (progn
17894 (easy-menu-change
17895 '("Org") "Customize"
17896 `(["Browse Org group" org-customize t]
17897 "--"
17898 ,(customize-menu-create 'org)
17899 ["Set" Custom-set t]
17900 ["Save" Custom-save t]
17901 ["Reset to Current" Custom-reset-current t]
17902 ["Reset to Saved" Custom-reset-saved t]
17903 ["Reset to Standard Settings" Custom-reset-standard t]))
17905 (error "Cannot expand menu (outdated version of cus-edit.el)")))
17907 ;;;; Miscellaneous stuff
17909 ;;; Generally useful functions
17911 (defun org-get-at-bol (property)
17912 "Get text property PROPERTY at beginning of line."
17913 (get-text-property (point-at-bol) property))
17915 (defun org-find-text-property-in-string (prop s)
17916 "Return the first non-nil value of property PROP in string S."
17917 (or (get-text-property 0 prop s)
17918 (get-text-property (or (next-single-property-change 0 prop s) 0)
17919 prop s)))
17921 (defun org-display-warning (message) ;; Copied from Emacs-Muse
17922 "Display the given MESSAGE as a warning."
17923 (if (fboundp 'display-warning)
17924 (display-warning 'org message
17925 (if (featurep 'xemacs) 'warning :warning))
17926 (let ((buf (get-buffer-create "*Org warnings*")))
17927 (with-current-buffer buf
17928 (goto-char (point-max))
17929 (insert "Warning (Org): " message)
17930 (unless (bolp)
17931 (newline)))
17932 (display-buffer buf)
17933 (sit-for 0))))
17935 (defun org-in-commented-line ()
17936 "Is point in a line starting with `#'?"
17937 (equal (char-after (point-at-bol)) ?#))
17939 (defun org-in-indented-comment-line ()
17940 "Is point in a line starting with `#' after some white space?"
17941 (save-excursion
17942 (save-match-data
17943 (goto-char (point-at-bol))
17946 (defun org-in-verbatim-emphasis ()
17947 (save-match-data
17948 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
17950 (defun org-goto-marker-or-bmk (marker &optional bookmark)
17951 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
17952 (if (and marker (marker-buffer marker)
17953 (buffer-live-p (marker-buffer marker)))
17954 (progn
17955 (switch-to-buffer (marker-buffer marker))
17956 (if (or (> marker (point-max)) (< marker (point-min)))
17957 (widen))
17958 (goto-char marker)
17959 (org-show-context 'org-goto))
17960 (if bookmark
17961 (bookmark-jump bookmark)
17962 (error "Cannot find location"))))
17964 (defun org-quote-csv-field (s)
17965 "Quote field for inclusion in CSV material."
17968 s))
17970 (defun org-plist-delete (plist property)
17971 "Delete PROPERTY from PLIST.
17972 This is in contrast to merely setting it to 0."
17973 (let (p)
17974 (while plist
17975 (if (not (eq property (car plist)))
17976 (setq p (plist-put p (car plist) (nth 1 plist))))
17977 (setq plist (cddr plist)))
17978 p))
17980 (defun org-force-self-insert (N)
17981 "Needed to enforce self-insert under remapping."
17982 (interactive "p")
17983 (self-insert-command N))
17985 (defun org-string-width (s)
17986 "Compute width of string, ignoring invisible characters.
17987 This ignores character with invisibility property `org-link', and also
17988 characters with property `org-cwidth', because these will become invisible
17989 upon the next fontification round."
17990 (let (b l)
17991 (when (or (eq t buffer-invisibility-spec)
17992 (assq 'org-link buffer-invisibility-spec))
17993 (while (setq b (text-property-any 0 (length s)
17994 'invisible 'org-link s))
17995 (setq s (concat (substring s 0 b)
17996 (substring s (or (next-single-property-change
17997 b 'invisible s) (length s)))))))
17998 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
17999 (setq s (concat (substring s 0 b)
18000 (substring s (or (next-single-property-change
18001 b 'org-cwidth s) (length s))))))
18002 (setq l (string-width s) b -1)
18003 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18004 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18005 l))
18007 (defun org-shorten-string (s maxlength)
18008 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18009 If the string is shorter or has length MAXLENGTH, just return the
18010 original string. If it is longer, the functions finds a space in the
18011 string, breaks this string off at that locations and adds three dots
18012 as ellipsis. Including the ellipsis, the string will not be longer
18013 than MAXLENGTH. If finding a good breaking point in the string does
18014 not work, the string is just chopped off in the middle of a word
18015 if necessary."
18016 (if (<= (length s) maxlength)
18017 s
18018 (let* ((n (max (- maxlength 4) 1))
18020 (if (string-match re s)
18021 (concat (match-string 1 s) "...")
18022 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18024 (defun org-get-indentation (&optional line)
18025 "Get the indentation of the current line, interpreting tabs.
18026 When LINE is given, assume it represents a line and compute its indentation."
18027 (if line
18028 (if (string-match "^ *" (org-remove-tabs line))
18029 (match-end 0))
18030 (save-excursion
18031 (beginning-of-line 1)
18033 (current-column))))
18035 (defun org-remove-tabs (s &optional width)
18036 "Replace tabulators in S with spaces.
18037 Assumes that s is a single line, starting in column 0."
18038 (setq width (or width tab-width))
18040 (setq s (replace-match
18041 (make-string
18042 (- (* width (/ (+ (match-beginning 0) width) width))
18043 (match-beginning 0)) ?\ )
18044 t t s)))
18045 s)
18047 (defun org-fix-indentation (line ind)
18048 "Fix indentation in LINE.
18049 IND is a cons cell with target and minimum indentation.
18050 If the current indentation in LINE is smaller than the minimum,
18051 leave it alone. If it is larger than ind, set it to the target."
18052 (let* ((l (org-remove-tabs line))
18053 (i (org-get-indentation l))
18054 (i1 (car ind)) (i2 (cdr ind)))
18055 (if (>= i i2) (setq l (substring line i2)))
18056 (if (> i1 0)
18057 (concat (make-string i1 ?\ ) l)
18058 l)))
18060 (defun org-remove-indentation (code &optional n)
18061 "Remove the maximum common indentation from the lines in CODE.
18062 N may optionally be the number of spaces to remove."
18063 (with-temp-buffer
18064 (insert code)
18065 (org-do-remove-indentation n)
18066 (buffer-string)))
18068 (defun org-do-remove-indentation (&optional n)
18069 "Remove the maximum common indentation from the buffer."
18070 (untabify (point-min) (point-max))
18071 (let ((min 10000) re)
18072 (if n
18073 (setq min n)
18074 (goto-char (point-min))
18076 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18077 (unless (or (= min 0) (= min 10000))
18079 (goto-char (point-min))
18080 (while (re-search-forward re nil t)
18081 (replace-match "")
18082 (end-of-line 1))
18083 min)))
18085 (defun org-fill-template (template alist)
18086 "Find each %key of ALIST in TEMPLATE and replace it."
18087 (let ((case-fold-search nil)
18088 entry key value)
18089 (setq alist (sort (copy-sequence alist)
18090 (lambda (a b) (< (length (car a)) (length (car b))))))
18091 (while (setq entry (pop alist))
18092 (setq template
18093 (replace-regexp-in-string
18094 (concat "%" (regexp-quote (car entry)))
18095 (cdr entry) template t t)))
18096 template))
18098 (defun org-base-buffer (buffer)
18099 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18100 (if (not buffer)
18101 buffer
18102 (or (buffer-base-buffer buffer)
18103 buffer)))
18105 (defun org-trim (s)
18106 "Remove whitespace at beginning and end of string."
18109 s)
18111 (defun org-wrap (string &optional width lines)
18112 "Wrap string to either a number of lines, or a width in characters.
18113 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18114 that costs. If there is a word longer than WIDTH, the text is actually
18115 wrapped to the length of that word.
18116 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18117 many lines, whatever width that takes.
18118 The return value is a list of lines, without newlines at the end."
18120 (maxword (apply 'max (mapcar 'org-string-width words)))
18121 w ll)
18122 (cond (width
18123 (org-do-wrap words (max maxword width)))
18124 (lines
18125 (setq w maxword)
18126 (setq ll (org-do-wrap words maxword))
18127 (if (<= (length ll) lines)
18128 ll
18129 (setq ll words)
18130 (while (> (length ll) lines)
18131 (setq w (1+ w))
18132 (setq ll (org-do-wrap words w)))
18133 ll))
18134 (t (error "Cannot wrap this")))))
18136 (defun org-do-wrap (words width)
18137 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18138 (let (lines line)
18139 (while words
18140 (setq line (pop words))
18141 (while (and words (< (+ (length line) (length (car words))) width))
18142 (setq line (concat line " " (pop words))))
18143 (setq lines (push line lines)))
18144 (nreverse lines)))
18146 (defun org-split-string (string &optional separators)
18147 "Splits STRING into substrings at SEPARATORS.
18148 No empty strings are returned if there are matches at the beginning
18149 and end of string."
18151 (start 0)
18152 notfirst
18153 (list nil))
18154 (while (and (string-match rexp string
18155 (if (and notfirst
18156 (= start (match-beginning 0))
18157 (< start (length string)))
18158 (1+ start) start))
18159 (< (match-beginning 0) (length string)))
18160 (setq notfirst t)
18161 (or (eq (match-beginning 0) 0)
18162 (and (eq (match-beginning 0) (match-end 0))
18163 (eq (match-beginning 0) start))
18164 (setq list
18165 (cons (substring string start (match-beginning 0))
18166 list)))
18167 (setq start (match-end 0)))
18168 (or (eq start (length string))
18169 (setq list
18170 (cons (substring string start)
18171 list)))
18172 (nreverse list)))
18174 (defun org-quote-vert (s)
18176 (while (string-match "|" s)
18178 s)
18180 (defun org-uuidgen-p (s)
18181 "Is S an ID created by UUIDGEN?"
18182 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18184 (defun org-context ()
18185 "Return a list of contexts of the current cursor position.
18186 If several contexts apply, all are returned.
18187 Each context entry is a list with a symbol naming the context, and
18188 two positions indicating start and end of the context. Possible
18189 contexts are:
18191 :headline anywhere in a headline
18192 :headline-stars on the leading stars in a headline
18193 :todo-keyword on a TODO keyword (including DONE) in a headline
18194 :tags on the TAGS in a headline
18195 :priority on the priority cookie in a headline
18196 :item on the first line of a plain list item
18197 :item-bullet on the bullet/number of a plain list item
18198 :checkbox on the checkbox in a plain list item
18199 :table in an org-mode table
18200 :table-special on a special filed in a table
18201 :table-table in a table.el table
18202 :link on a hyperlink
18203 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18204 :target on a <<target>>
18205 :radio-target on a <<<radio-target>>>
18206 :latex-fragment on a LaTeX fragment
18207 :latex-preview on a LaTeX fragment with overlayed preview image
18209 This function expects the position to be visible because it uses font-lock
18210 faces as a help to recognize the following contexts: :table-special, :link,
18211 and :keyword."
18212 (let* ((f (get-text-property (point) 'face))
18213 (faces (if (listp f) f (list f)))
18214 (p (point)) clist o)
18215 ;; First the large context
18216 (cond
18217 ((org-on-heading-p t)
18218 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18219 (when (progn
18220 (beginning-of-line 1)
18221 (looking-at org-todo-line-tags-regexp))
18222 (push (org-point-in-group p 1 :headline-stars) clist)
18223 (push (org-point-in-group p 2 :todo-keyword) clist)
18224 (push (org-point-in-group p 4 :tags) clist))
18225 (goto-char p)
18228 (push (org-point-in-group p 0 :priority) clist)))
18230 ((org-at-item-p)
18231 (push (org-point-in-group p 2 :item-bullet) clist)
18232 (push (list :item (point-at-bol)
18233 (save-excursion (org-end-of-item) (point)))
18234 clist)
18235 (and (org-at-item-checkbox-p)
18236 (push (org-point-in-group p 0 :checkbox) clist)))
18238 ((org-at-table-p)
18239 (push (list :table (org-table-begin) (org-table-end)) clist)
18240 (if (memq 'org-formula faces)
18241 (push (list :table-special
18242 (previous-single-property-change p 'face)
18243 (next-single-property-change p 'face)) clist)))
18244 ((org-at-table-p 'any)
18245 (push (list :table-table) clist)))
18246 (goto-char p)
18248 ;; Now the small context
18249 (cond
18250 ((org-at-timestamp-p)
18251 (push (org-point-in-group p 0 :timestamp) clist))
18252 ((memq 'org-link faces)
18253 (push (list :link
18254 (previous-single-property-change p 'face)
18255 (next-single-property-change p 'face)) clist))
18256 ((memq 'org-special-keyword faces)
18257 (push (list :keyword
18258 (previous-single-property-change p 'face)
18259 (next-single-property-change p 'face)) clist))
18260 ((org-on-target-p)
18261 (push (org-point-in-group p 0 :target) clist)
18262 (goto-char (1- (match-beginning 0)))
18263 (if (looking-at org-radio-target-regexp)
18264 (push (org-point-in-group p 0 :radio-target) clist))
18265 (goto-char p))
18266 ((setq o (car (delq nil
18267 (mapcar
18268 (lambda (x)
18269 (if (memq x org-latex-fragment-image-overlays) x))
18270 (overlays-at (point))))))
18271 (push (list :latex-fragment
18272 (overlay-start o) (overlay-end o)) clist)
18273 (push (list :latex-preview
18274 (overlay-start o) (overlay-end o)) clist))
18275 ((org-inside-LaTeX-fragment-p)
18276 ;; FIXME: positions wrong.
18277 (push (list :latex-fragment (point) (point)) clist)))
18279 (setq clist (nreverse (delq nil clist)))
18280 clist))
18282 ;; FIXME: Compare with at-regexp-p Do we need both?
18283 (defun org-in-regexp (re &optional nlines visually)
18284 "Check if point is inside a match of regexp.
18285 Normally only the current line is checked, but you can include NLINES extra
18286 lines both before and after point into the search.
18287 If VISUALLY is set, require that the cursor is not after the match but
18288 really on, so that the block visually is on the match."
18289 (catch 'exit
18290 (let ((pos (point))
18291 (eol (point-at-eol (+ 1 (or nlines 0))))
18292 (inc (if visually 1 0)))
18293 (save-excursion
18294 (beginning-of-line (- 1 (or nlines 0)))
18295 (while (re-search-forward re eol t)
18296 (if (and (<= (match-beginning 0) pos)
18297 (>= (+ inc (match-end 0)) pos))
18298 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18300 (defun org-at-regexp-p (regexp)
18301 "Is point inside a match of REGEXP in the current line?"
18302 (catch 'exit
18303 (save-excursion
18304 (let ((pos (point)) (end (point-at-eol)))
18305 (beginning-of-line 1)
18306 (while (re-search-forward regexp end t)
18307 (if (and (<= (match-beginning 0) pos)
18308 (>= (match-end 0) pos))
18309 (throw 'exit t)))
18310 nil))))
18312 (defun org-in-regexps-block-p (start-re end-re &optional bound)
18313 "Return t if the current point is between matches of START-RE and END-RE.
18314 This will also return t if point is on one of the two matches or
18315 in an unfinished block. END-RE can be a string or a form
18316 returning a string.
18318 An optional third argument bounds the search for START-RE. It
18319 defaults to previous heading or `point-min'."
18320 (let ((pos (point))
18321 (limit (or bound (save-excursion (outline-previous-heading)))))
18322 (save-excursion
18323 ;; we're on a block when point is on start-re...
18324 (or (org-at-regexp-p start-re)
18325 ;; ... or start-re can be found above...
18326 (and (re-search-backward start-re limit t)
18327 ;; ... but no end-re between start-re and point.
18328 (not (re-search-forward (eval end-re) pos t)))))))
18330 (defun org-occur-in-agenda-files (regexp &optional nlines)
18331 "Call `multi-occur' with buffers for all agenda files."
18333 (let* ((files (org-agenda-files))
18334 (tnames (mapcar 'file-truename files))
18335 (extra org-agenda-text-search-extra-files)
18336 f)
18337 (when (eq (car extra) 'agenda-archives)
18338 (setq extra (cdr extra))
18339 (setq files (org-add-archive-files files)))
18340 (while (setq f (pop extra))
18341 (unless (member (file-truename f) tnames)
18342 (add-to-list 'files f 'append)
18343 (add-to-list 'tnames (file-truename f) 'append)))
18344 (multi-occur
18345 (mapcar (lambda (x)
18346 (with-current-buffer
18347 (or (get-file-buffer x) (find-file-noselect x))
18348 (widen)
18349 (current-buffer)))
18350 files)
18351 regexp)))
18353 (if (boundp 'occur-mode-find-occurrence-hook)
18354 ;; Emacs 23
18355 (add-hook 'occur-mode-find-occurrence-hook
18356 (lambda ()
18357 (when (org-mode-p)
18358 (org-reveal))))
18359 ;; Emacs 22
18360 (defadvice occur-mode-goto-occurrence
18361 (after org-occur-reveal activate)
18362 (and (org-mode-p) (org-reveal)))
18363 (defadvice occur-mode-goto-occurrence-other-window
18364 (after org-occur-reveal activate)
18365 (and (org-mode-p) (org-reveal)))
18366 (defadvice occur-mode-display-occurrence
18367 (after org-occur-reveal activate)
18368 (when (org-mode-p)
18369 (let ((pos (occur-mode-find-occurrence)))
18370 (with-current-buffer (marker-buffer pos)
18371 (save-excursion
18372 (goto-char pos)
18373 (org-reveal)))))))
18375 (defun org-occur-link-in-agenda-files ()
18376 "Create a link and search for it in the agendas.
18377 The link is not stored in `org-stored-links', it is just created
18378 for the search purpose."
18379 (interactive)
18380 (let ((link (condition-case nil
18381 (org-store-link nil)
18382 (error "Unable to create a link to here"))))
18383 (org-occur-in-agenda-files (regexp-quote link))))
18385 (defun org-uniquify (list)
18386 "Remove duplicate elements from LIST."
18387 (let (res)
18388 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
18389 res))
18391 (defun org-delete-all (elts list)
18392 "Remove all elements in ELTS from LIST."
18393 (while elts
18394 (setq list (delete (pop elts) list)))
18395 list)
18397 (defun org-count (cl-item cl-seq)
18398 "Count the number of occurrences of ITEM in SEQ.
18399 Taken from `count' in cl-seq.el with all keyword arguments removed."
18400 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
18401 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
18402 (while (< cl-start cl-end)
18403 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
18404 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
18405 (setq cl-start (1+ cl-start)))
18406 cl-count))
18408 (defun org-remove-if (predicate seq)
18409 "Remove everything from SEQ that fulfills PREDICATE."
18410 (let (res e)
18411 (while seq
18412 (setq e (pop seq))
18413 (if (not (funcall predicate e)) (push e res)))
18414 (nreverse res)))
18416 (defun org-remove-if-not (predicate seq)
18417 "Remove everything from SEQ that does not fulfill PREDICATE."
18418 (let (res e)
18419 (while seq
18420 (setq e (pop seq))
18421 (if (funcall predicate e) (push e res)))
18422 (nreverse res)))
18424 (defun org-back-over-empty-lines ()
18425 "Move backwards over whitespace, to the beginning of the first empty line.
18426 Returns the number of empty lines passed."
18427 (let ((pos (point)))
18429 (beginning-of-line 2)
18430 (goto-char (min (point) pos))
18431 (count-lines (point) pos)))
18433 (defun org-skip-whitespace ()
18436 (defun org-point-in-group (point group &optional context)
18437 "Check if POINT is in match-group GROUP.
18438 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18439 match. If the match group does not exist or point is not inside it,
18440 return nil."
18441 (and (match-beginning group)
18442 (>= point (match-beginning group))
18443 (<= point (match-end group))
18444 (if context
18445 (list context (match-beginning group) (match-end group))
18446 t)))
18448 (defun org-switch-to-buffer-other-window (&rest args)
18449 "Switch to buffer in a second window on the current frame.
18450 In particular, do not allow pop-up frames.
18451 Returns the newly created buffer."
18452 (let (pop-up-frames special-display-buffer-names special-display-regexps
18453 special-display-function)
18454 (apply 'switch-to-buffer-other-window args)))
18456 (defun org-combine-plists (&rest plists)
18457 "Create a single property list from all plists in PLISTS.
18458 The process starts by copying the first list, and then setting properties
18459 from the other lists. Settings in the last list are the most significant
18460 ones and overrule settings in the other lists."
18461 (let ((rtn (copy-sequence (pop plists)))
18462 p v ls)
18463 (while plists
18464 (setq ls (pop plists))
18465 (while ls
18466 (setq p (pop ls) v (pop ls))
18467 (setq rtn (plist-put rtn p v))))
18468 rtn))
18470 (defun org-move-line-down (arg)
18471 "Move the current line down. With prefix argument, move it past ARG lines."
18472 (interactive "p")
18473 (let ((col (current-column))
18474 beg end pos)
18475 (beginning-of-line 1) (setq beg (point))
18476 (beginning-of-line 2) (setq end (point))
18477 (beginning-of-line (+ 1 arg))
18478 (setq pos (move-marker (make-marker) (point)))
18479 (insert (delete-and-extract-region beg end))
18480 (goto-char pos)
18481 (org-move-to-column col)))
18483 (defun org-move-line-up (arg)
18484 "Move the current line up. With prefix argument, move it past ARG lines."
18485 (interactive "p")
18486 (let ((col (current-column))
18487 beg end pos)
18488 (beginning-of-line 1) (setq beg (point))
18489 (beginning-of-line 2) (setq end (point))
18490 (beginning-of-line (- arg))
18491 (setq pos (move-marker (make-marker) (point)))
18492 (insert (delete-and-extract-region beg end))
18493 (goto-char pos)
18494 (org-move-to-column col)))
18496 (defun org-replace-escapes (string table)
18497 "Replace %-escapes in STRING with values in TABLE.
18499 The sequences in STRING may contain normal field width and padding information,
18501 so values can contain further %-escapes if they are define later in TABLE."
18502 (let ((tbl (copy-alist table))
18503 (case-fold-search nil)
18504 (pchg 0)
18505 e re rpl)
18506 (while (setq e (pop tbl))
18507 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
18508 (when (and (cdr e) (string-match re (cdr e)))
18509 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
18510 (safe "SREF"))
18511 (add-text-properties 0 3 (list 'sref sref) safe)
18512 (setcdr e (replace-match safe t t (cdr e)))))
18513 (while (string-match re string)
18514 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
18515 (cdr e)))
18516 (setq string (replace-match rpl t t string))))
18517 (while (setq pchg (next-property-change pchg string))
18518 (let ((sref (get-text-property pchg 'sref string)))
18519 (when (and sref (string-match "SREF" string pchg))
18520 (setq string (replace-match sref t t string)))))
18521 string))
18523 (defun org-sublist (list start end)
18524 "Return a section of LIST, from START to END.
18525 Counting starts at 1."
18526 (let (rtn (c start))
18527 (setq list (nthcdr (1- start) list))
18528 (while (and list (<= c end))
18529 (push (pop list) rtn)
18530 (setq c (1+ c)))
18531 (nreverse rtn)))
18533 (defun org-find-base-buffer-visiting (file)
18534 "Like `find-buffer-visiting' but always return the base buffer and
18535 not an indirect buffer."
18536 (let ((buf (or (get-file-buffer file)
18537 (find-buffer-visiting file))))
18538 (if buf
18539 (or (buffer-base-buffer buf) buf)
18540 nil)))
18542 (defun org-image-file-name-regexp (&optional extensions)
18543 "Return regexp matching the file names of images.
18544 If EXTENSIONS is given, only match these."
18545 (if (and (not extensions) (fboundp 'image-file-name-regexp))
18546 (image-file-name-regexp)
18547 (let ((image-file-name-extensions
18548 (or extensions
18549 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
18550 "xbm" "xpm" "pbm" "pgm" "ppm"))))
18552 (regexp-opt (nconc (mapcar 'upcase
18553 image-file-name-extensions)
18554 image-file-name-extensions)
18555 t)
18558 (defun org-file-image-p (file &optional extensions)
18559 "Return non-nil if FILE is an image."
18560 (save-match-data
18561 (string-match (org-image-file-name-regexp extensions) file)))
18563 (defun org-get-cursor-date ()
18564 "Return the date at cursor in as a time.
18565 This works in the calendar and in the agenda, anywhere else it just
18566 returns the current time."
18567 (let (date day defd)
18568 (cond
18569 ((eq major-mode 'calendar-mode)
18570 (setq date (calendar-cursor-to-date)
18571 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
18572 ((eq major-mode 'org-agenda-mode)
18573 (setq day (get-text-property (point) 'day))
18574 (if day
18575 (setq date (calendar-gregorian-from-absolute day)
18576 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
18577 (nth 2 date))))))
18578 (or defd (current-time))))
18580 (defvar org-agenda-action-marker (make-marker)
18581 "Marker pointing to the entry for the next agenda action.")
18583 (defun org-mark-entry-for-agenda-action ()
18584 "Mark the current entry as target of an agenda action.
18585 Agenda actions are actions executed from the agenda with the key `k',
18586 which make use of the date at the cursor."
18587 (interactive)
18588 (move-marker org-agenda-action-marker
18589 (save-excursion (org-back-to-heading t) (point))
18590 (current-buffer))
18591 (message
18592 "Entry marked for action; press `k' at desired date in agenda or calendar"))
18594 (defun org-mark-subtree ()
18595 "Mark the current subtree.
18596 This puts point at the start of the current subtree, and mark at the end.
18598 If point is in an inline task, mark that task instead."
18599 (interactive)
18600 (let ((inline-task-p
18601 (and (featurep 'org-inlinetask)
18602 (org-inlinetask-in-task-p)))
18603 (beg))
18604 ;; Get beginning of subtree
18605 (cond
18606 (inline-task-p (org-inlinetask-goto-beginning))
18607 ((org-at-heading-p) (beginning-of-line))
18608 (t (let ((outline-regexp (org-get-limited-outline-regexp)))
18609 (outline-previous-visible-heading 1))))
18610 (setq beg (point))
18611 ;; Get end of it
18612 (if inline-task-p
18613 (org-inlinetask-goto-end)
18614 (org-end-of-subtree))
18615 ;; Mark zone
18616 (push-mark (point) nil t)
18617 (goto-char beg)))
18619 ;;; Paragraph filling stuff.
18620 ;; We want this to be just right, so use the full arsenal.
18622 (defun org-indent-line-function ()
18623 "Indent line depending on context."
18624 (interactive)
18625 (let* ((pos (point))
18626 (itemp (org-at-item-p))
18627 (case-fold-search t)
18629 (inline-task-p (and (featurep 'org-inlinetask)
18630 (org-inlinetask-in-task-p)))
18631 column bpos bcol tpos tcol)
18632 (beginning-of-line 1)
18633 (cond
18634 ;; Comments
18635 ((looking-at "# ") (setq column 0))
18636 ;; Headings
18638 ;; Literal examples
18640 (setq column (org-get-indentation))) ; do nothing
18641 ;; Drawers
18643 (save-excursion (re-search-backward org-drawer-regexp nil t)))
18644 (save-excursion
18645 (goto-char (1- (match-beginning 1)))
18646 (setq column (current-column))))
18647 ;; Special blocks
18649 (save-excursion
18650 (re-search-backward
18652 (setq column (org-get-indentation (match-string 0))))
18655 (save-excursion
18657 (setq column
18658 (if (equal (downcase (match-string 1)) "src")
18659 ;; src blocks: let `org-edit-src-exit' handle them
18660 (org-get-indentation)
18661 (org-get-indentation (match-string 0)))))
18662 ;; Lists
18663 ((org-in-item-p)
18664 (org-beginning-of-item)
18665 (looking-at "[ \t]*\\(\\S-+\\)[ \t]*\\(\\(:?\\[@\\(:?start:\\)?[0-9]+\\][ \t]*\\)?\\[[- X]\\][ \t]*\\|.*? :: \\)?")
18666 (setq bpos (match-beginning 1) tpos (match-end 0)
18667 bcol (progn (goto-char bpos) (current-column))
18668 tcol (progn (goto-char tpos) (current-column)))
18669 (if (> tcol (+ bcol org-description-max-indent))
18670 (setq tcol (+ bcol 5)))
18671 (goto-char pos)
18672 (setq column (if itemp (org-get-indentation) tcol)))
18673 ;; This line has nothing special, look at the previous relevant
18674 ;; line to compute indentation
18675 (t
18676 (beginning-of-line 0)
18677 (while (and (not (bobp))
18678 (not (looking-at org-drawer-regexp))
18679 ;; skip comments, verbatim, empty lines, tables,
18680 ;; inline tasks, lists, drawers and blocks
18682 (re-search-backward org-drawer-regexp nil t))
18686 (and (org-in-item-p) (goto-char (org-list-top-point)))
18687 (and (not inline-task-p)
18688 (featurep 'org-inlinetask)
18689 (org-inlinetask-in-task-p)
18690 (or (org-inlinetask-goto-beginning) t))))
18691 (beginning-of-line 0))
18692 (cond
18693 ;; There was an heading above.
18695 (if (not org-adapt-indentation)
18696 (setq column 0)
18697 (goto-char (match-end 0))
18698 (setq column (current-column))))
18699 ;; A drawer had started and is unfinished
18700 ((looking-at org-drawer-regexp)
18701 (goto-char (1- (match-beginning 1)))
18702 (setq column (current-column)))
18703 ;; Else, nothing noticeable found: get indentation and go on.
18704 (t (setq column (org-get-indentation))))))
18705 ;; Now apply indentation and move cursor accordingly
18706 (goto-char pos)
18707 (if (<= (current-column) (current-indentation))
18708 (org-indent-line-to column)
18709 (save-excursion (org-indent-line-to column)))
18710 ;; Special polishing for properties, see `org-property-format'
18711 (setq column (current-column))
18712 (beginning-of-line 1)
18713 (if (looking-at
18715 (replace-match (concat (match-string 1)
18716 (format org-property-format
18717 (match-string 2) (match-string 3)))
18718 t t))
18719 (org-move-to-column column)))
18721 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
18722 "Variable to store copy of `adaptive-fill-regexp'.
18723 Since `adaptive-fill-regexp' is set to never match, we need to
18724 store a backup of its value before entering `org-mode' so that
18725 the functionality can be provided as a fall-back.")
18727 (defun org-set-autofill-regexps ()
18728 (interactive)
18729 ;; In the paragraph separator we include headlines, because filling
18730 ;; text in a line directly attached to a headline would otherwise
18731 ;; fill the headline as well.
18734 ;; The paragraph starter includes hand-formatted lists.
18735 (org-set-local
18736 'paragraph-start
18737 (concat
18746 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
18747 ;; But only if the user has not turned off tables or fixed-width regions
18748 (org-set-local
18749 'auto-fill-inhibit-regexp
18752 (if (or org-enable-table-editor org-enable-fixed-width-editor)
18753 (concat
18755 (if org-enable-table-editor "|" "")
18756 (if org-enable-fixed-width-editor ":" "")
18757 "]"))))
18758 ;; We use our own fill-paragraph function, to make sure that tables
18759 ;; and fixed-width regions are not wrapped. That function will pass
18760 ;; through to `fill-paragraph' when appropriate.
18761 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
18762 ;; Adaptive filling: To get full control, first make sure that
18763 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
18764 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
18765 (org-set-local 'org-adaptive-fill-regexp-backup
18766 adaptive-fill-regexp))
18768 (org-set-local 'adaptive-fill-function
18769 'org-adaptive-fill-function)
18770 (org-set-local
18771 'align-mode-rules-list
18772 '((org-in-buffer-settings
18774 (modes . '(org-mode))))))
18776 (defun org-fill-paragraph (&optional justify)
18777 "Re-align a table, pass through to fill-paragraph if no table."
18778 (let ((table-p (org-at-table-p))
18779 (table.el-p (org-at-table.el-p)))
18780 (cond ((and (equal (char-after (point-at-bol)) ?*)
18781 (save-excursion (goto-char (point-at-bol))
18782 (looking-at outline-regexp)))
18783 t) ; skip headlines
18784 (table.el-p t) ; skip table.el tables
18785 (table-p (org-table-align) t) ; align org-mode tables
18786 (t nil)))) ; call paragraph-fill
18788 ;; For reference, this is the default value of adaptive-fill-regexp
18791 (defun org-adaptive-fill-function ()
18792 "Return a fill prefix for org-mode files.
18793 In particular, this makes sure hanging paragraphs for hand-formatted lists
18794 work correctly."
18795 (cond
18796 ;; Comment line
18798 (match-string-no-properties 0))
18799 ;; Description list
18801 (save-excursion
18802 (if (> (match-end 1) (+ (match-beginning 1)
18803 org-description-max-indent))
18804 (goto-char (+ (match-beginning 1) 5))
18805 (goto-char (match-end 0)))
18806 (make-string (current-column) ?\ )))
18807 ;; Ordered or unordered list
18809 (save-excursion
18810 (goto-char (match-end 0))
18811 (make-string (current-column) ?\ )))
18812 ;; Other text
18813 ((looking-at org-adaptive-fill-regexp-backup)
18814 (match-string-no-properties 0))))
18816 ;;; Other stuff.
18818 (defun org-toggle-fixed-width-section (arg)
18819 "Toggle the fixed-width export.
18820 If there is no active region, the QUOTE keyword at the current headline is
18821 inserted or removed. When present, it causes the text between this headline
18822 and the next to be exported as fixed-width text, and unmodified.
18823 If there is an active region, this command adds or removes a colon as the
18824 first character of this line. If the first character of a line is a colon,
18825 this line is also exported in fixed-width font."
18826 (interactive "P")
18827 (let* ((cc 0)
18828 (regionp (org-region-active-p))
18829 (beg (if regionp (region-beginning) (point)))
18830 (end (if regionp (region-end)))
18831 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
18832 (case-fold-search nil)
18834 off)
18835 (if regionp
18836 (save-excursion
18837 (goto-char beg)
18838 (setq cc (current-column))
18839 (beginning-of-line 1)
18840 (setq off (looking-at re))
18841 (while (> nlines 0)
18842 (setq nlines (1- nlines))
18843 (beginning-of-line 1)
18844 (cond
18845 (arg
18846 (org-move-to-column cc t)
18848 (forward-line -1))
18849 ((and off (looking-at re))
18850 (replace-match "" t t nil 1))
18851 ((not off) (org-move-to-column cc t) (insert ": ")))
18852 (forward-line 1)))
18853 (save-excursion
18854 (org-back-to-heading)
18855 (if (looking-at (concat outline-regexp
18857 (replace-match "" t t nil 1)
18858 (if (looking-at outline-regexp)
18859 (progn
18860 (goto-char (match-end 0))
18861 (insert org-quote-string " "))))))))
18863 (defun org-reftex-citation ()
18864 "Use reftex-citation to insert a citation into the buffer.
18865 This looks for a line like
18867 #+BIBLIOGRAPHY: foo plain option:-d
18869 and derives from it that foo.bib is the bibliography file relevant
18870 for this document. It then installs the necessary environment for RefTeX
18871 to work in this buffer and calls `reftex-citation' to insert a citation
18872 into the buffer.
18874 Export of such citations to both LaTeX and HTML is handled by the contributed
18875 package org-exp-bibtex by Taru Karttunen."
18876 (interactive)
18877 (let ((reftex-docstruct-symbol 'rds)
18879 rds bib)
18880 (save-excursion
18881 (save-restriction
18882 (widen)
18883 (let ((case-fold-search t)
18885 (if (not (save-excursion
18886 (or (re-search-forward re nil t)
18887 (re-search-backward re nil t))))
18888 (error "No bibliography defined in file")
18889 (setq bib (concat (match-string 1) ".bib")
18890 rds (list (list 'bib bib)))))))
18891 (call-interactively 'reftex-citation)))
18893 ;;;; Functions extending outline functionality
18895 (defun org-beginning-of-line (&optional arg)
18896 "Go to the beginning of the current line. If that is invisible, continue
18897 to a visible line beginning. This makes the function of C-a more intuitive.
18898 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18899 first attempt, and only move to after the tags when the cursor is already
18900 beyond the end of the headline."
18901 (interactive "P")
18902 (let ((pos (point))
18903 (special (if (consp org-special-ctrl-a/e)
18904 (car org-special-ctrl-a/e)
18905 org-special-ctrl-a/e))
18906 refpos)
18907 (if (org-bound-and-true-p line-move-visual)
18908 (beginning-of-visual-line 1)
18909 (beginning-of-line 1))
18910 (if (and arg (fboundp 'move-beginning-of-line))
18911 (call-interactively 'move-beginning-of-line)
18912 (if (bobp)
18913 nil
18914 (backward-char 1)
18915 (if (org-truely-invisible-p)
18916 (while (and (not (bobp)) (org-truely-invisible-p))
18917 (backward-char 1)
18918 (beginning-of-line 1))
18919 (forward-char 1))))
18920 (when special
18921 (cond
18922 ((and (looking-at org-complex-heading-regexp)
18923 (= (char-after (match-end 1)) ?\ ))
18924 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
18925 (point-at-eol)))
18926 (goto-char
18927 (if (eq special t)
18928 (cond ((> pos refpos) refpos)
18929 ((= pos (point)) refpos)
18930 (t (point)))
18931 (cond ((> pos (point)) (point))
18932 ((not (eq last-command this-command)) (point))
18933 (t refpos)))))
18934 ((org-at-item-p)
18935 (goto-char
18936 (if (eq special t)
18937 (cond ((> pos (match-end 4)) (match-end 4))
18938 ((= pos (point)) (match-end 4))
18939 (t (point)))
18940 (cond ((> pos (point)) (point))
18941 ((not (eq last-command this-command)) (point))
18942 (t (match-end 4))))))))
18943 (org-no-warnings
18944 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18946 (defun org-end-of-line (&optional arg)
18947 "Go to the end of the line.
18948 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18949 first attempt, and only move to after the tags when the cursor is already
18950 beyond the end of the headline."
18951 (interactive "P")
18952 (let ((special (if (consp org-special-ctrl-a/e)
18953 (cdr org-special-ctrl-a/e)
18954 org-special-ctrl-a/e)))
18955 (if (or (not special)
18956 (not (org-on-heading-p))
18957 arg)
18958 (call-interactively
18959 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
18960 ((fboundp 'move-end-of-line) 'move-end-of-line)
18961 (t 'end-of-line)))
18962 (let ((pos (point)))
18963 (beginning-of-line 1)
18965 (if (eq special t)
18966 (if (or (< pos (match-beginning 1))
18967 (= pos (match-end 0)))
18968 (goto-char (match-beginning 1))
18969 (goto-char (match-end 0)))
18970 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
18971 (goto-char (match-end 0))
18972 (goto-char (match-beginning 1))))
18973 (call-interactively (if (fboundp 'move-end-of-line)
18974 'move-end-of-line
18975 'end-of-line)))))
18976 (org-no-warnings
18977 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18979 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
18980 (define-key org-mode-map "\C-e" 'org-end-of-line)
18982 (defun org-backward-sentence (&optional arg)
18983 "Go to beginning of sentence, or beginning of table field.
18984 This will call `backward-sentence' or `org-table-beginning-of-field',
18985 depending on context."
18986 (interactive "P")
18987 (cond
18988 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
18989 (t (call-interactively 'backward-sentence))))
18991 (defun org-forward-sentence (&optional arg)
18992 "Go to end of sentence, or end of table field.
18993 This will call `forward-sentence' or `org-table-end-of-field',
18994 depending on context."
18995 (interactive "P")
18996 (cond
18997 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
18998 (t (call-interactively 'forward-sentence))))
19000 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19001 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19003 (defun org-kill-line (&optional arg)
19004 "Kill line, to tags or end of line."
19005 (interactive "P")
19006 (cond
19007 ((or (not org-special-ctrl-k)
19008 (bolp)
19009 (not (org-on-heading-p)))
19010 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19011 org-ctrl-k-protect-subtree)
19012 (if (or (eq org-ctrl-k-protect-subtree 'error)
19013 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19014 (error "C-k aborted - would kill hidden subtree")))
19015 (call-interactively 'kill-line))
19017 (kill-region (point) (match-beginning 1))
19018 (org-set-tags nil t))
19019 (t (kill-region (point) (point-at-eol)))))
19021 (define-key org-mode-map "\C-k" 'org-kill-line)
19023 (defun org-yank (&optional arg)
19024 "Yank. If the kill is a subtree, treat it specially.
19025 This command will look at the current kill and check if is a single
19026 subtree, or a series of subtrees[1]. If it passes the test, and if the
19027 cursor is at the beginning of a line or after the stars of a currently
19028 empty headline, then the yank is handled specially. How exactly depends
19029 on the value of the following variables, both set by default.
19031 org-yank-folded-subtrees
19032 When set, the subtree(s) will be folded after insertion, but only
19033 if doing so would now swallow text after the yanked text.
19035 org-yank-adjusted-subtrees
19036 When set, the subtree will be promoted or demoted in order to
19037 fit into the local outline tree structure, which means that the level
19038 will be adjusted so that it becomes the smaller one of the two
19039 *visible* surrounding headings.
19041 Any prefix to this command will cause `yank' to be called directly with
19043 will just
19044 plainly yank the text as it is.
19046 \[1] The test checks if the first non-white line is a heading
19047 and if there are no other headings with fewer stars."
19048 (interactive "P")
19049 (org-yank-generic 'yank arg))
19051 (defun org-yank-generic (command arg)
19052 "Perform some yank-like command.
19054 This function implements the behavior described in the `org-yank'
19055 documentation. However, it has been generalized to work for any
19056 interactive command with similar behavior."
19058 ;; pretend to be command COMMAND
19059 (setq this-command command)
19061 (if arg
19062 (call-interactively command)
19064 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19065 (and (org-kill-is-subtree-p)
19066 (or (bolp)
19068 (string-match
19070 (buffer-substring (point-at-bol) (point)))))))
19071 swallowp)
19072 (cond
19073 ((and subtreep org-yank-folded-subtrees)
19074 (let ((beg (point))
19075 end)
19076 (if (and subtreep org-yank-adjusted-subtrees)
19077 (org-paste-subtree nil nil 'for-yank)
19078 (call-interactively command))
19080 (setq end (point))
19081 (goto-char beg)
19082 (when (and (bolp) subtreep
19083 (not (setq swallowp
19084 (org-yank-folding-would-swallow-text beg end))))
19085 (or (looking-at outline-regexp)
19086 (re-search-forward (concat "^" outline-regexp) end t))
19087 (while (and (< (point) end) (looking-at outline-regexp))
19088 (hide-subtree)
19089 (org-cycle-show-empty-lines 'folded)
19090 (condition-case nil
19091 (outline-forward-same-level 1)
19092 (error (goto-char end)))))
19093 (when swallowp
19094 (message
19095 "Inserted text not folded because that would swallow text"))
19097 (goto-char end)
19099 (beginning-of-line 1)
19100 (push-mark beg 'nomsg)))
19101 ((and subtreep org-yank-adjusted-subtrees)
19102 (let ((beg (point-at-bol)))
19103 (org-paste-subtree nil nil 'for-yank)
19104 (push-mark beg 'nomsg)))
19105 (t
19106 (call-interactively command))))))
19108 (defun org-yank-folding-would-swallow-text (beg end)
19109 "Would hide-subtree at BEG swallow any text after END?"
19110 (let (level)
19111 (save-excursion
19112 (goto-char beg)
19113 (when (or (looking-at outline-regexp)
19114 (re-search-forward (concat "^" outline-regexp) end t))
19115 (setq level (org-outline-level)))
19116 (goto-char end)
19118 (if (or (eobp)
19119 (and (bolp) (looking-at org-outline-regexp)
19120 (<= (org-outline-level) level)))
19121 nil ; Nothing would be swallowed
19122 t)))) ; something would swallow
19124 (define-key org-mode-map "\C-y" 'org-yank)
19126 (defun org-invisible-p ()
19127 "Check if point is at a character currently not visible."
19128 ;; Early versions of noutline don't have `outline-invisible-p'.
19129 (if (fboundp 'outline-invisible-p)
19130 (outline-invisible-p)
19131 (get-char-property (point) 'invisible)))
19133 (defun org-truely-invisible-p ()
19134 "Check if point is at a character currently not visible.
19135 This version does not only check the character property, but also
19136 `visible-mode'."
19137 ;; Early versions of noutline don't have `outline-invisible-p'.
19138 (if (org-bound-and-true-p visible-mode)
19139 nil
19140 (if (fboundp 'outline-invisible-p)
19141 (outline-invisible-p)
19142 (get-char-property (point) 'invisible))))
19144 (defun org-invisible-p2 ()
19145 "Check if point is at a character currently not visible."
19146 (save-excursion
19147 (if (and (eolp) (not (bobp))) (backward-char 1))
19148 ;; Early versions of noutline don't have `outline-invisible-p'.
19149 (if (fboundp 'outline-invisible-p)
19150 (outline-invisible-p)
19151 (get-char-property (point) 'invisible))))
19153 (defun org-back-to-heading (&optional invisible-ok)
19154 "Call `outline-back-to-heading', but provide a better error message."
19155 (condition-case nil
19156 (outline-back-to-heading invisible-ok)
19157 (error (error "Before first headline at position %d in buffer %s"
19158 (point) (current-buffer)))))
19160 (defun org-beginning-of-defun ()
19161 "Go to the beginning of the subtree, i.e. back to the heading."
19162 (org-back-to-heading))
19163 (defun org-end-of-defun ()
19164 "Go to the end of the subtree."
19165 (org-end-of-subtree nil t))
19167 (defun org-before-first-heading-p ()
19168 "Before first heading?"
19169 (save-excursion
19172 (defun org-on-heading-p (&optional ignored)
19173 (outline-on-heading-p t))
19174 (defun org-at-heading-p (&optional ignored)
19175 (outline-on-heading-p t))
19177 (defun org-point-at-end-of-empty-headline ()
19178 "If point is at the end of an empty headline, return t, else nil.
19179 If the heading only contains a TODO keyword, it is still still considered
19180 empty."
19182 (save-excursion
19183 (beginning-of-line 1)
19186 (defun org-at-heading-or-item-p ()
19187 (or (org-on-heading-p) (org-at-item-p)))
19189 (defun org-on-target-p ()
19190 (or (org-in-regexp org-radio-target-regexp)
19191 (org-in-regexp org-target-regexp)))
19193 (defun org-up-heading-all (arg)
19194 "Move to the heading line of which the present line is a subheading.
19195 This function considers both visible and invisible heading lines.
19196 With argument, move up ARG levels."
19197 (if (fboundp 'outline-up-heading-all)
19198 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19199 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19201 (defun org-up-heading-safe ()
19202 "Move to the heading line of which the present line is a subheading.
19203 This version will not throw an error. It will return the level of the
19204 headline found, or nil if no higher level is found.
19206 Also, this function will be a lot faster than `outline-up-heading',
19207 because it relies on stars being the outline starters. This can really
19208 make a significant difference in outlines with very many siblings."
19209 (let (start-level re)
19210 (org-back-to-heading t)
19211 (setq start-level (funcall outline-level))
19212 (if (equal start-level 1)
19213 nil
19215 (if (re-search-backward re nil t)
19216 (funcall outline-level)))))
19218 (defun org-first-sibling-p ()
19219 "Is this heading the first child of its parents?"
19220 (interactive)
19221 (let ((re (concat "^" outline-regexp))
19222 level l)
19223 (unless (org-at-heading-p t)
19224 (error "Not at a heading"))
19225 (setq level (funcall outline-level))
19226 (save-excursion
19227 (if (not (re-search-backward re nil t))
19228 t
19229 (setq l (funcall outline-level))
19230 (< l level)))))
19232 (defun org-goto-sibling (&optional previous)
19233 "Goto the next sibling, even if it is invisible.
19234 When PREVIOUS is set, go to the previous sibling instead. Returns t
19235 when a sibling was found. When none is found, return nil and don't
19236 move point."
19237 (let ((fun (if previous 're-search-backward 're-search-forward))
19238 (pos (point))
19239 (re (concat "^" outline-regexp))
19240 level l)
19241 (when (condition-case nil (org-back-to-heading t) (error nil))
19242 (setq level (funcall outline-level))
19243 (catch 'exit
19244 (or previous (forward-char 1))
19245 (while (funcall fun re nil t)
19246 (setq l (funcall outline-level))
19247 (when (< l level) (goto-char pos) (throw 'exit nil))
19248 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
19249 (goto-char pos)
19250 nil))))
19252 (defun org-show-siblings ()
19253 "Show all siblings of the current headline."
19254 (save-excursion
19255 (while (org-goto-sibling) (org-flag-heading nil)))
19256 (save-excursion
19257 (while (org-goto-sibling 'previous)
19258 (org-flag-heading nil))))
19260 (defun org-goto-first-child ()
19261 "Goto the first child, even if it is invisible.
19262 Return t when a child was found. Otherwise don't move point and
19263 return nil."
19264 (let (level (pos (point)) (re (concat "^" outline-regexp)))
19265 (when (condition-case nil (org-back-to-heading t) (error nil))
19266 (setq level (outline-level))
19267 (forward-char 1)
19268 (if (and (re-search-forward re nil t) (> (outline-level) level))
19269 (progn (goto-char (match-beginning 0)) t)
19270 (goto-char pos) nil))))
19272 (defun org-show-hidden-entry ()
19273 "Show an entry where even the heading is hidden."
19274 (save-excursion
19275 (org-show-entry)))
19277 (defun org-flag-heading (flag &optional entry)
19278 "Flag the current heading. FLAG non-nil means make invisible.
19279 When ENTRY is non-nil, show the entire entry."
19280 (save-excursion
19281 (org-back-to-heading t)
19282 ;; Check if we should show the entire entry
19283 (if entry
19284 (progn
19285 (org-show-entry)
19286 (save-excursion
19287 (and (outline-next-heading)
19288 (org-flag-heading nil))))
19289 (outline-flag-region (max (point-min) (1- (point)))
19290 (save-excursion (outline-end-of-heading) (point))
19291 flag))))
19293 (defun org-get-next-sibling ()
19294 "Move to next heading of the same level, and return point.
19295 If there is no such heading, return nil.
19296 This is like outline-next-sibling, but invisible headings are ok."
19297 (let ((level (funcall outline-level)))
19298 (outline-next-heading)
19299 (while (and (not (eobp)) (> (funcall outline-level) level))
19300 (outline-next-heading))
19301 (if (or (eobp) (< (funcall outline-level) level))
19302 nil
19303 (point))))
19305 (defun org-get-last-sibling ()
19306 "Move to previous heading of the same level, and return point.
19307 If there is no such heading, return nil."
19308 (let ((opoint (point))
19309 (level (funcall outline-level)))
19310 (outline-previous-heading)
19311 (when (and (/= (point) opoint) (outline-on-heading-p t))
19312 (while (and (> (funcall outline-level) level)
19313 (not (bobp)))
19314 (outline-previous-heading))
19315 (if (< (funcall outline-level) level)
19316 nil
19317 (point)))))
19319 (defun org-end-of-subtree (&optional invisible-OK to-heading)
19320 ;; This contains an exact copy of the original function, but it uses
19321 ;; `org-back-to-heading', to make it work also in invisible
19322 ;; trees. And is uses an invisible-OK argument.
19323 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
19324 ;; Furthermore, when used inside Org, finding the end of a large subtree
19325 ;; with many children and grandchildren etc, this can be much faster
19326 ;; than the outline version.
19327 (org-back-to-heading invisible-OK)
19328 (let ((first t)
19329 (level (funcall outline-level)))
19330 (if (and (org-mode-p) (< level 1000))
19331 ;; A true heading (not a plain list item), in Org-mode
19332 ;; This means we can easily find the end by looking
19333 ;; only for the right number of stars. Using a regexp to do
19334 ;; this is so much faster than using a Lisp loop.
19336 (forward-char 1)
19337 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
19338 ;; something else, do it the slow way
19339 (while (and (not (eobp))
19340 (or first (> (funcall outline-level) level)))
19341 (setq first nil)
19342 (outline-next-heading)))
19343 (unless to-heading
19345 (progn
19346 ;; Go to end of line before heading
19347 (forward-char -1)
19349 ;; leave blank line before heading
19350 (forward-char -1))))))
19351 (point))
19353 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
19354 "Use Org version in org-mode, for dramatic speed-up."
19355 (if (eq major-mode 'org-mode)
19356 (progn
19357 (org-end-of-subtree nil t)
19358 (unless (eobp) (backward-char 1)))
19359 ad-do-it))
19361 (defun org-forward-same-level (arg &optional invisible-ok)
19362 "Move forward to the arg'th subheading at same level as this one.
19363 Stop at the first and last subheadings of a superior heading.
19364 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
19365 it wil also look at invisible ones."
19366 (interactive "p")
19367 (org-back-to-heading invisible-ok)
19368 (org-on-heading-p)
19369 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19371 l)
19372 (forward-char 1)
19373 (while (> arg 0)
19374 (while (and (re-search-forward re nil 'move)
19375 (setq l (- (match-end 0) (match-beginning 0) 1))
19376 (= l level)
19377 (not invisible-ok)
19378 (progn (backward-char 1) (org-invisible-p)))
19379 (if (< l level) (setq arg 1)))
19380 (setq arg (1- arg)))
19381 (beginning-of-line 1)))
19383 (defun org-backward-same-level (arg &optional invisible-ok)
19384 "Move backward to the arg'th subheading at same level as this one.
19385 Stop at the first and last subheadings of a superior heading."
19386 (interactive "p")
19387 (org-back-to-heading)
19388 (org-on-heading-p)
19389 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19391 l)
19392 (while (> arg 0)
19393 (while (and (re-search-backward re nil 'move)
19394 (setq l (- (match-end 0) (match-beginning 0) 1))
19395 (= l level)
19396 (not invisible-ok)
19397 (org-invisible-p))
19398 (if (< l level) (setq arg 1)))
19399 (setq arg (1- arg)))))
19401 (defun org-show-subtree ()
19402 "Show everything after this heading at deeper levels."
19403 (outline-flag-region
19404 (point)
19405 (save-excursion
19406 (org-end-of-subtree t t))
19407 nil))
19409 (defun org-show-entry ()
19410 "Show the body directly following this heading.
19411 Show the heading too, if it is currently invisible."
19412 (interactive)
19413 (save-excursion
19414 (condition-case nil
19415 (progn
19416 (org-back-to-heading t)
19417 (outline-flag-region
19418 (max (point-min) (1- (point)))
19419 (save-excursion
19420 (if (re-search-forward
19422 (match-beginning 1)
19423 (point-max)))
19424 nil)
19425 (org-cycle-hide-drawers 'children))
19426 (error nil))))
19428 (defun org-make-options-regexp (kwds &optional extra)
19429 "Make a regular expression for keyword lines."
19430 (concat
19431 "^"
19438 ;; Make isearch reveal the necessary context
19439 (defun org-isearch-end ()
19440 "Reveal context after isearch exits."
19441 (when isearch-success ; only if search was successful
19442 (if (featurep 'xemacs)
19443 ;; Under XEmacs, the hook is run in the correct place,
19444 ;; we directly show the context.
19445 (org-show-context 'isearch)
19446 ;; In Emacs the hook runs *before* restoring the overlays.
19447 ;; So we have to use a one-time post-command-hook to do this.
19448 ;; (Emacs 22 has a special variable, see function `org-mode')
19449 (unless (and (boundp 'isearch-mode-end-hook-quit)
19450 isearch-mode-end-hook-quit)
19451 ;; Only when the isearch was not quitted.
19452 (org-add-hook 'post-command-hook 'org-isearch-post-command
19453 'append 'local)))))
19455 (defun org-isearch-post-command ()
19456 "Remove self from hook, and show context."
19457 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
19458 (org-show-context 'isearch))
19461 ;;;; Integration with and fixes for other packages
19463 ;;; Imenu support
19465 (defvar org-imenu-markers nil
19466 "All markers currently used by Imenu.")
19467 (make-variable-buffer-local 'org-imenu-markers)
19469 (defun org-imenu-new-marker (&optional pos)
19470 "Return a new marker for use by Imenu, and remember the marker."
19471 (let ((m (make-marker)))
19472 (move-marker m (or pos (point)))
19473 (push m org-imenu-markers)
19474 m))
19476 (defun org-imenu-get-tree ()
19477 "Produce the index for Imenu."
19478 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
19479 (setq org-imenu-markers nil)
19480 (let* ((n org-imenu-depth)
19481 (re (concat "^" outline-regexp))
19482 (subs (make-vector (1+ n) nil))
19483 (last-level 0)
19484 m level head)
19485 (save-excursion
19486 (save-restriction
19487 (widen)
19488 (goto-char (point-max))
19489 (while (re-search-backward re nil t)
19490 (setq level (org-reduced-level (funcall outline-level)))
19491 (when (<= level n)
19492 (looking-at org-complex-heading-regexp)
19493 (setq head (org-link-display-format
19494 (org-match-string-no-properties 4))
19495 m (org-imenu-new-marker))
19496 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
19497 (if (>= level last-level)
19498 (push (cons head m) (aref subs level))
19499 (push (cons head (aref subs (1+ level))) (aref subs level))
19500 (loop for i from (1+ level) to n do (aset subs i nil)))
19501 (setq last-level level)))))
19502 (aref subs 1)))
19504 (eval-after-load "imenu"
19505 '(progn
19506 (add-hook 'imenu-after-jump-hook
19507 (lambda ()
19508 (if (eq major-mode 'org-mode)
19509 (org-show-context 'org-goto))))))
19511 (defun org-link-display-format (link)
19512 "Replace a link with either the description, or the link target
19513 if no description is present"
19514 (save-match-data
19515 (if (string-match org-bracket-link-analytic-regexp link)
19516 (replace-match (if (match-end 5)
19517 (match-string 5 link)
19518 (concat (match-string 1 link)
19519 (match-string 3 link)))
19520 nil t link)
19521 link)))
19523 ;; Speedbar support
19525 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
19526 "Overlay marking the agenda restriction line in speedbar.")
19527 (overlay-put org-speedbar-restriction-lock-overlay
19528 'face 'org-agenda-restriction-lock)
19529 (overlay-put org-speedbar-restriction-lock-overlay
19530 'help-echo "Agendas are currently limited to this item.")
19531 (org-detach-overlay org-speedbar-restriction-lock-overlay)
19533 (defun org-speedbar-set-agenda-restriction ()
19534 "Restrict future agenda commands to the location at point in speedbar.
19536 (interactive)
19537 (require 'org-agenda)
19538 (let (p m tp np dir txt)
19539 (cond
19540 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19541 'org-imenu t))
19542 (setq m (get-text-property p 'org-imenu-marker))
19543 (with-current-buffer (marker-buffer m)
19544 (goto-char m)
19545 (org-agenda-set-restriction-lock 'subtree)))
19546 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19547 'speedbar-function 'speedbar-find-file))
19548 (setq tp (previous-single-property-change
19549 (1+ p) 'speedbar-function)
19550 np (next-single-property-change
19551 tp 'speedbar-function)
19552 dir (speedbar-line-directory)
19553 txt (buffer-substring-no-properties (or tp (point-min))
19554 (or np (point-max))))
19555 (with-current-buffer (find-file-noselect
19556 (let ((default-directory dir))
19557 (expand-file-name txt)))
19558 (unless (org-mode-p)
19559 (error "Cannot restrict to non-Org-mode file"))
19560 (org-agenda-set-restriction-lock 'file)))
19561 (t (error "Don't know how to restrict Org-mode's agenda")))
19562 (move-overlay org-speedbar-restriction-lock-overlay
19563 (point-at-bol) (point-at-eol))
19564 (setq current-prefix-arg nil)
19565 (org-agenda-maybe-redo)))
19567 (eval-after-load "speedbar"
19568 '(progn
19569 (speedbar-add-supported-extension ".org")
19570 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
19571 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
19572 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
19573 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19574 (add-hook 'speedbar-visiting-tag-hook
19575 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
19577 ;;; Fixes and Hacks for problems with other packages
19579 ;; Make flyspell not check words in links, to not mess up our keymap
19580 (defun org-mode-flyspell-verify ()
19581 "Don't let flyspell put overlays at active buttons."
19582 (and (not (get-text-property (max (1- (point)) (point-min)) 'keymap))
19583 (not (get-text-property (max (1- (point)) (point-min)) 'org-no-flyspell))))
19585 (defun org-remove-flyspell-overlays-in (beg end)
19586 "Remove flyspell overlays in region."
19587 (and (org-bound-and-true-p flyspell-mode)
19588 (fboundp 'flyspell-delete-region-overlays)
19589 (flyspell-delete-region-overlays beg end))
19590 (add-text-properties beg end '(org-no-flyspell t)))
19592 ;; Make `bookmark-jump' shows the jump location if it was hidden.
19593 (eval-after-load "bookmark"
19594 '(if (boundp 'bookmark-after-jump-hook)
19595 ;; We can use the hook
19596 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
19597 ;; Hook not available, use advice
19598 (defadvice bookmark-jump (after org-make-visible activate)
19599 "Make the position visible."
19600 (org-bookmark-jump-unhide))))
19602 ;; Make sure saveplace shows the location if it was hidden
19603 (eval-after-load "saveplace"
19604 '(defadvice save-place-find-file-hook (after org-make-visible activate)
19605 "Make the position visible."
19606 (org-bookmark-jump-unhide)))
19608 ;; Make sure ecb shows the location if it was hidden
19609 (eval-after-load "ecb"
19610 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
19611 "Make hierarchy visible when jumping into location from ECB tree buffer."
19612 (if (eq major-mode 'org-mode)
19613 (org-show-context))))
19615 (defun org-bookmark-jump-unhide ()
19616 "Unhide the current position, to show the bookmark location."
19617 (and (org-mode-p)
19618 (or (org-invisible-p)
19619 (save-excursion (goto-char (max (point-min) (1- (point))))
19620 (org-invisible-p)))
19621 (org-show-context 'bookmark-jump)))
19623 ;; Make session.el ignore our circular variable
19624 (eval-after-load "session"
19625 '(add-to-list 'session-globals-exclude 'org-mark-ring))
19627 ;;;; Experimental code
19629 (defun org-closed-in-range ()
19630 "Sparse tree of items closed in a certain time range.
19631 Still experimental, may disappear in the future."
19632 (interactive)
19633 ;; Get the time interval from the user.
19634 (let* ((time1 (org-float-time
19635 (org-read-date nil 'to-time nil "Starting date: ")))
19636 (time2 (org-float-time
19637 (org-read-date nil 'to-time nil "End date:")))
19638 ;; callback function
19639 (callback (lambda ()
19640 (let ((time
19641 (org-float-time
19642 (apply 'encode-time
19643 (org-parse-time-string
19644 (match-string 1))))))
19645 ;; check if time in interval
19646 (and (>= time time1) (<= time time2))))))
19647 ;; make tree, check each match with the callback
19650 ;;;; Finish up
19652 (provide 'org)
19654 (run-hooks 'org-load-hook)
19656 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
19658 ;;; org.el ends here