| blob | a49d3e27873338cd3c948ae2b1df36ab627dd286 |
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
310 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
318 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
326 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
342 "Non-nil means make shift-cursor commands select text when possible.
344 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
345 selecting a region, or enlarge regions started in this way.
346 In Org-mode, in special contexts, these same keys are used for other
347 purposes, important enough to compete with shift selection. Org tries
348 to balance these needs by supporting `shift-select-mode' outside these
349 special contexts, under control of this variable.
351 The default of this variable is nil, to avoid confusing behavior. Shifted
352 cursor keys will then execute Org commands in the following contexts:
353 - on a headline, changing TODO state (left/right) and priority (up/down)
354 - on a time stamp, changing the time
355 - in a plain list item, changing the bullet type
356 - in a property definition line, switching between allowed values
357 - in the BEGIN line of a clock table (changing the time block).
358 Outside these contexts, the commands will throw an error.
360 When this variable is t and the cursor is not in a special context,
361 Org-mode will support shift-selection for making and enlarging regions.
362 To make this more effective, the bullet cycling will no longer happen
363 anywhere in an item line, but only if the cursor is exactly on the bullet.
365 If you set this variable to the symbol `always', then the keys
366 will not be special in headlines, property lines, and item lines, to make
367 shift selection work there as well. If this is what you want, you can
368 use the following alternative commands: `C-c C-t' and `C-c ,' to
369 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
370 TODO sets, `C-c -' to cycle item bullet types, and properties can be
371 edited by hand or in column view.
373 However, when the cursor is on a timestamp, shift-cursor commands
374 will still edit the time stamp - this is just too good to give up.
376 XEmacs user should have this variable set to nil, because shift-select-mode
377 is Emacs 23 only."
385 "Options concerning startup of Org-mode."
390 "Non-nil means entering Org-mode will switch to OVERVIEW.
391 This can also be configured on a per-file basis by adding one of
392 the following lines anywhere in the buffer:
394 #+STARTUP: fold (or `overview', this is equivalent)
395 #+STARTUP: nofold (or `showall', this is equivalent)
396 #+STARTUP: content
397 #+STARTUP: showeverything"
406 "Non-nil means entering Org-mode will set `truncate-lines'.
407 This is useful since some lines containing links can be very long and
408 uninteresting. Also tables look terrible when wrapped."
413 "Non-nil means turn on `org-indent-mode' on startup.
414 This can also be configured on a per-file basis by adding one of
415 the following lines anywhere in the buffer:
417 #+STARTUP: indent
418 #+STARTUP: noindent"
426 When this option is turned on, you can use TeX-like syntax for sub- and
428 considered as a single item - so grouping with {} is normally not
429 needed. For example, the following things will be parsed as single
430 sub- or superscripts.
432 10^24 or 10^tau several digits will be considered 1 item.
433 10^-12 or 10^-tau a leading sign with digits or a word
434 x^2-y^3 will be read as x^2 - y^3, because items are
435 terminated by almost any nonword/nondigit char.
436 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
438 Still, ambiguity is possible - so when in doubt use {} to enclose the
439 sub/superscript. If you set this variable to the symbol `{}',
440 the braces are *required* in order to trigger interpretations as
442 frequently in plain text.
444 Not all export backends support this, but HTML does.
459 "Non-nil means turn on `org-beamer-mode' on startup.
460 This can also be configured on a per-file basis by adding one of
461 the following lines anywhere in the buffer:
463 #+STARTUP: beamer"
468 "Non-nil means align all tables when visiting a file.
469 This is useful when the column width in tables is forced with <N> cookies
470 in table fields. Such tables will look correct only after the first re-align.
471 This can also be configured on a per-file basis by adding one of
472 the following lines anywhere in the buffer:
473 #+STARTUP: align
474 #+STARTUP: noalign"
479 "Non-nil means show inline images when loading a new Org file.
480 This can also be configured on a per-file basis by adding one of
481 the following lines anywhere in the buffer:
482 #+STARTUP: inlineimages
483 #+STARTUP: noinlineimages"
488 "Non-nil means insert the first line setting Org-mode in empty files.
489 When the function `org-mode' is called interactively in an empty file, this
490 normally means that the file name does not automatically trigger Org-mode.
491 To ensure that the file will always be in Org-mode in the future, a
492 line enforcing Org-mode will be inserted into the buffer, if this option
493 has been set."
498 "Non-nil means use alternative key bindings for some keys.
499 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
500 These keys are also used by other packages like shift-selection-mode'
501 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
502 If you want to use Org-mode together with one of these other modes,
503 or more generally if you would like to move some Org-mode commands to
504 other keys, set this variable and configure the keys with the variable
505 `org-disputed-keys'.
507 This option is only relevant at load-time of Org-mode, and must be set
508 *before* org.el is loaded. Changing it requires a restart of Emacs to
509 become effective."
514 "Non-nil means use extra key sequence definitions for certain commands.
515 This happens automatically if you run XEmacs or if `window-system'
516 is nil. This variable lets you do the same manually. You must
517 set it before loading org.
519 Example: on Carbon Emacs 22 running graphically, with an external
520 keyboard on a Powerbook, the default way of setting M-left might
521 not work for either Alt or ESC. Setting this variable will make
522 it work for ESC."
536 "Keys for which Org-mode and other modes compete.
537 This is an alist, cars are the default keys, second element specifies
538 the alternative to use when `org-replace-disputed-keys' is t.
540 Keys can be specified in any syntax supported by `define-key'.
541 The value of this option takes effect only at Org-mode's startup,
542 therefore you'll have to restart Emacs to apply it after changing."
547 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
548 Or return the original if not disputed.
549 Also apply the translations defined in `org-xemacs-key-equivalents'."
554 org-disputed-keys)))
558 key)
568 "Define a key, possibly translated, as returned by `org-key'."
572 "The ellipsis to use in the Org-mode outline.
573 When nil, just use the standard three dots. When a string, use that instead,
574 When a face, use the standard 3 dots, but with the specified face.
575 The change affects only Org-mode (which will then use its own display table).
576 Changing this requires executing `M-x org-mode' in a buffer to become
577 effective."
587 "Keywords in Org-mode."
592 "String to mark deadline entries.
593 A deadline is this string, followed by a time stamp. Should be a word,
594 terminated by a colon. You can insert a schedule keyword and
596 Changes become only effective after restarting Emacs."
601 "String to mark scheduled TODO entries.
602 A schedule is this string, followed by a time stamp. Should be a word,
603 terminated by a colon. You can insert a schedule keyword and
605 Changes become only effective after restarting Emacs."
610 "String used as the prefix for timestamps logging closing a TODO entry."
615 "String used as prefix for timestamps clocking work hours on an item."
620 "Entries starting with this keyword will never be exported.
621 An entry can be toggled between COMMENT and normal with
623 Changes become only effective after restarting Emacs."
628 "Entries starting with this keyword will be exported in fixed-width font.
629 Quoting applies only to the text in the entry following the headline, and does
630 not extend beyond the next headline, even if that is lower level.
631 An entry can be toggled between QUOTE and normal with
638 "Regular expression for specifying repeated events.
642 "Options concerning the general structure of Org-mode files."
647 "Options about how to make context of a location visible."
671 "Non-nil means show full hierarchy when revealing a location.
672 Org-mode often shows locations in an org-mode file which might have
673 been invisible before. When this is set, the hierarchy of headings
674 above the exposed location is shown.
675 Turning this off for example for sparse trees makes them very compact.
676 Instead of t, this can also be an alist specifying this option for different
677 contexts. Valid contexts are
678 agenda when exposing an entry from the agenda
679 org-goto when using the command `org-goto' on key C-c C-j
680 occur-tree when using the command `org-occur' on key C-c /
681 tags-tree when constructing a sparse tree based on tags matches
682 link-search when exposing search matches associated with a link
683 mark-goto when exposing the jump goal of a mark
684 bookmark-jump when exposing a bookmark location
685 isearch when exiting from an incremental search
686 default default for all contexts not set explicitly"
691 "Non-nil means show following heading when revealing a location.
692 Org-mode often shows locations in an org-mode file which might have
693 been invisible before. When this is set, the heading following the
694 match is shown.
695 Turning this off for example for sparse trees makes them very compact,
696 but makes it harder to edit the location of the match. In such a case,
698 Instead of t, this can also be an alist specifying this option for different
699 contexts. See `org-show-hierarchy-above' for valid contexts."
704 "Non-nil means show all sibling heading when revealing a location.
705 Org-mode often shows locations in an org-mode file which might have
706 been invisible before. When this is set, the sibling of the current entry
707 heading are all made visible. If `org-show-hierarchy-above' is t,
708 the same happens on each level of the hierarchy above the current entry.
710 By default this is on for the isearch context, off for all other contexts.
711 Turning this off for example for sparse trees makes them very compact,
712 but makes it harder to edit the location of the match. In such a case,
714 Instead of t, this can also be an alist specifying this option for different
715 contexts. See `org-show-hierarchy-above' for valid contexts."
720 "Non-nil means show the entry below a headline when revealing a location.
721 Org-mode often shows locations in an org-mode file which might have
722 been invisible before. When this is set, the text below the headline that is
723 exposed is also shown.
725 By default this is off for all contexts.
726 Instead of t, this can also be an alist specifying this option for different
727 contexts. See `org-show-hierarchy-above' for valid contexts."
732 "How should indirect tree buffers be displayed?
733 This applies to indirect buffers created with the commands
735 Valid values are:
736 current-window Display in the current window
737 other-window Just display in another window.
738 dedicated-frame Create one new frame, and re-use it each time.
739 new-frame Make a new frame each time. Note that in this case
740 previously-made indirect buffers are kept, and you need to
741 kill these buffers yourself."
751 "Non-nil means activate single letter commands at beginning of a headline.
752 This may also be a function to test for appropriate locations where speed
753 commands should be active."
761 "Alist of additional speed commands.
762 This list will be checked before `org-speed-commands-default'
763 when the variable `org-use-speed-commands' is non-nil
764 and when the cursor is at the beginning of a headline.
765 The car if each entry is a string with a single letter, which must
766 be assigned to `self-insert-command' in the global map.
767 The cdr is either a command to be called interactively, a function
768 to be called, or a form to be evaluated.
769 An entry that is just a list with a single string will be interpreted
770 as a descriptive headline that will be added when listing the speed
771 commands in the Help buffer using the `?' speed command."
783 "Options concerning visibility cycling in Org-mode."
788 "Non-nil means skip CHILDREN state in entries that don't have any."
793 "Maximum level which should still be subject to visibility cycling.
794 Levels higher than this will, for cycling, be treated as text, not a headline.
795 When `org-odd-levels-only' is set, a value of N in this variable actually
796 means 2N-1 stars as the limiting headline.
797 When nil, cycle all levels.
798 Note that the limiting level of cycling is also influenced by
799 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
800 `org-inlinetask-min-level' is, cycling will be limited to levels one less
801 than its value."
808 "Names of drawers. Drawers are not opened by cycling on the headline above.
809 Drawers only open with a TAB on the drawer line itself. A drawer looks like
810 this:
811 :DRAWERNAME:
812 .....
813 :END:
815 the property API.
817 Drawers can be defined on the per-file basis with a line like:
819 #+DRAWERS: HIDDEN STATE PROPERTIES"
825 "Non-nil means entering Org-mode will fold all blocks.
826 This can also be set in on a per-file basis with
828 #+STARTUP: hideblocks
829 #+STARTUP: showblocks"
835 "Cycle globally if cursor is at beginning of buffer and not at a headline.
836 This makes it possible to do global cycling without having to use S-TAB or
838 of the buffer
839 must not be a headline - it may be empty or some other text. When used in
840 this way, `org-cycle-hook' is disables temporarily, to make sure the
841 cursor stays at the beginning of the buffer.
842 When this option is nil, don't do anything special at the beginning
843 of the buffer."
848 "Non-nil means cycle entry level or item indentation in new empty entries.
850 When the cursor is at the end of an empty headline, i.e with only stars
851 and maybe a TODO keyword, TAB will then switch the entry to become a child,
852 and then all possible ancestor states, before returning to the original state.
853 This makes data entry extremely fast: M-RET to create a new headline,
854 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
856 When the cursor is at the end of an empty plain list item, one TAB will
857 make it a subitem, two or more tabs will back up to make this an item
858 higher up in the item hierarchy."
863 "Where should `org-cycle' emulate TAB.
864 nil Never
865 white Only in completely white lines
866 whitestart Only at the beginning of lines, before the first non-white char
867 t Everywhere except in headlines
868 exc-hl-bol Everywhere except at the start of a headline
869 If TAB is used in a place where it does not emulate TAB, the current subtree
870 visibility is cycled."
877 ))
880 "Number of empty lines needed to keep an empty line between collapsed trees.
881 If you leave an empty line between the end of a subtree and the following
882 headline, this empty line is hidden when the subtree is folded.
883 Org-mode will leave (exactly) one empty line visible if the number of
884 empty lines is equal or larger to the number given in this variable.
885 So the default 2 means at least 2 empty lines after the end of a subtree
886 are needed to produce free space between a collapsed subtree and the
887 following headline.
889 If the number is negative, and the number of empty lines is at least -N,
890 all empty lines are shown.
892 Special case: when 0, never leave empty lines in collapsed view."
898 "Hook that is run before visibility cycling is happening.
899 The function(s) in this hook must accept a single argument which indicates
900 the new state that will be set right after running this hook. The
901 argument is a symbol. Before a global state change, it can have the values
902 `overview', `content', or `all'. Before a local state change, it can have
903 the values `folded', `children', or `subtree'."
908 org-cycle-hide-drawers
909 org-cycle-show-empty-lines
910 org-optimize-window-after-visibility-change)
911 "Hook that is run after `org-cycle' has changed the buffer visibility.
912 The function(s) in this hook must accept a single argument which indicates
913 the new state that was set by the most recent `org-cycle' command. The
914 argument is a symbol. After a global state change, it can have the values
915 `overview', `content', or `all'. After a local state change, it can have
916 the values `folded', `children', or `subtree'."
921 "Options concerning structure editing in Org-mode."
926 "Non-nil means skip even levels and only use odd levels for the outline.
927 This has the effect that two stars are being added/taken away in
928 promotion/demotion commands. It also influences how levels are
929 handled by the exporters.
930 Changing it requires restart of `font-lock-mode' to become effective
931 for fontification also in regions already fontified.
932 You may also set this on a per-file basis by adding one of the following
933 lines to the buffer:
935 #+STARTUP: odd
936 #+STARTUP: oddeven"
942 "Non-nil means adapt indentation to outline node level.
944 When this variable is set, Org assumes that you write outlines by
945 indenting text in each node to align with the headline (after the stars).
946 The following issues are influenced by this variable:
948 - When this is set and the *entire* text in an entry is indented, the
949 indentation is increased by one space in a demotion command, and
950 decreased by one in a promotion command. If any line in the entry
951 body starts with text at column 0, indentation is not changed at all.
953 - Property drawers and planning information is inserted indented when
954 this variable s set. When nil, they will not be indented.
956 - TAB indents a line relative to context. The lines below a headline
957 will be indented when this variable is set.
959 Note that this is all about true indentation, by adding and removing
960 space characters. See also `org-indent.el' which does level-dependent
961 indentation in a virtual way, i.e. at display time in Emacs."
966 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
968 When t, `C-a' will bring back the cursor to the beginning of the
969 headline text, i.e. after the stars and after a possible TODO keyword.
970 In an item, this will be the position after the bullet.
971 When the cursor is already at that position, another `C-a' will bring
972 it to the beginning of the line.
974 `C-e' will jump to the end of the headline, ignoring the presence of tags
975 in the headline. A second `C-e' will then jump to the true end of the
976 line, after any tags. This also means that, when this variable is
977 non-nil, `C-e' also will never jump beyond the end of the heading of a
978 folded section, i.e. not after the ellipses.
980 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
981 going to the true line boundary first. Only a directly following, identical
982 keypress will bring the cursor to the special positions.
984 This may also be a cons cell where the behavior for `C-a' and `C-e' is
985 set separately."
1004 "Non-nil means `C-k' will behave specially in headlines.
1005 When nil, `C-k' will call the default `kill-line' command.
1006 When t, the following will happen while the cursor is in the headline:
1008 - When the cursor is at the beginning of a headline, kill the entire
1009 line and possible the folded subtree below the line.
1010 - When in the middle of the headline text, kill the headline up to the tags.
1011 - When after the headline text, kill the tags."
1016 "Non-nil means, do not delete a hidden subtree with C-k.
1017 When set to the symbol `error', simply throw an error when C-k is
1018 used to kill (part-of) a headline that has hidden text behind it.
1019 Any other non-nil value will result in a query to the user, if it is
1020 OK to kill that hidden subtree. When nil, kill without remorse."
1028 "Non-nil means when yanking subtrees, fold them.
1029 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1030 it starts with a heading and all other headings in it are either children
1031 or siblings, then fold all the subtrees. However, do this only if no
1032 text after the yank would be swallowed into a folded tree by this action."
1037 "Non-nil means when yanking subtrees, adjust the level.
1038 With this setting, `org-paste-subtree' is used to insert the subtree, see
1039 this function for details."
1044 "Non-nil means M-RET will split the line at the cursor position.
1045 When nil, it will go to the end of the line before making a
1046 new line.
1047 You may also set this option in a different way for different
1048 contexts. Valid contexts are:
1050 headline when creating a new headline
1051 item when creating a new item
1052 table in a table field
1053 default the value to be used for all contexts not explicitly
1054 customized"
1071 "Non-nil means insert new headings after the current subtree.
1072 When nil, the new heading is created directly after the current line.
1075 for the duration of the command."
1081 "Should `org-insert-heading' leave a blank line before new heading/item?
1082 The value is an alist, with `heading' and `plain-list-item' as car,
1083 and a boolean flag as cdr. The cdr may also be the symbol `auto', and then
1084 Org will look at the surrounding headings/items and try to make an
1085 intelligent decision wether to insert a blank line or not.
1087 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1088 set, the setting here is ignored and no empty line is inserted, to avoid
1089 breaking the list structure."
1102 "Hook being run after inserting a new heading."
1108 This currently only means they are never auto-wrapped.
1109 When nil, such lines will be treated like ordinary lines.
1110 See also the QUOTE keyword."
1115 "Non-nil means typing characters in `org-goto' starts incremental search."
1120 "Options concerning sparse trees in Org-mode."
1125 "Non-nil means highlight all matches that define a sparse tree.
1126 The highlights will automatically disappear the next time the buffer is
1127 changed by an edit command."
1132 "Non-nil means any change to the buffer will remove temporary highlights.
1133 Such highlights are created by `org-occur' and `org-clock-display'.
1134 When nil, `C-c C-c needs to be used to get rid of the highlights.
1135 The highlights created by `org-preview-latex-fragment' always need
1136 `C-c C-c' to be removed."
1143 "Hook that is run after `org-occur' has constructed a sparse tree.
1144 This can be used to recenter the window to show as much of the structure
1145 as possible."
1150 "Options concerning imenu and speedbar in Org-mode."
1155 "The maximum level for Imenu access to Org-mode headlines.
1156 This also applied for speedbar access."
1161 "Options concerning tables in Org-mode."
1167 When nil, such lines will be treated like ordinary lines.
1169 When equal to the symbol `optimized', the table editor will be optimized to
1170 do the following:
1171 - Automatic overwrite mode in front of whitespace in table fields.
1172 This makes the structure of the table stay in tact as long as the edited
1173 field does not exceed the column width.
1174 - Minimize the number of realigns. Normally, the table is aligned each time
1175 TAB or RET are pressed to move to another field. With optimization this
1176 happens only if changes to a field might have changed the column width.
1177 Optimization requires replacing the functions `self-insert-command',
1178 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1179 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1180 very good at guessing when a re-align will be necessary, but you can always
1183 If you would like to use the optimized version in Org-mode, but the
1184 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1186 This variable can be used to turn on and off the table editor during a session,
1187 but in order to toggle optimization, a restart is required.
1189 See also the variable `org-table-auto-blank-field'."
1197 "Non-nil means cluster self-insert commands for undo when possible.
1198 If this is set, then, like in the Emacs command loop, 20 consecutive
1199 characters will be undone together.
1200 This is configurable, because there is some impact on typing performance."
1205 "Non-nil means TAB will automatically notice a table.el table.
1206 When it sees such a table, it moves point into it and - if necessary -
1207 calls `table-recognize-table'."
1212 "Options concerning links in Org-mode."
1217 "Buffer-local version of `org-link-abbrev-alist', which see.
1222 "Alist of link abbreviations.
1223 The car of each element is a string, to be replaced at the start of a link.
1225 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1227 [[linkkey:tag][description]]
1229 The 'linkkey' must be a word word, starting with a letter, followed
1230 by letters, numbers, '-' or '_'.
1232 If REPLACE is a string, the tag will simply be appended to create the link.
1235 be inserted at that point (see the function `url-hexify-string').
1237 REPLACE may also be a function that will be called with the tag as the
1238 only argument to create the link, which should be returned as a string.
1240 See the manual for examples."
1250 "Non-nil means hide link part and only show description of bracket links.
1251 Bracket links are like [[link][description]]. This variable sets the initial
1252 state in new org-mode buffers. The setting can then be toggled on a
1253 per-buffer basis from the Org->Hyperlinks menu."
1258 "How the path name in file links should be stored.
1259 Valid values are:
1261 relative Relative to the current directory, i.e. the directory of the file
1262 into which the link is being inserted.
1263 absolute Absolute path, if possible with ~ for home directory.
1264 noabbrev Absolute path, no abbreviation of home directory.
1265 adaptive Use relative path for files in the current directory and sub-
1266 directories of it. For other files, use an absolute path."
1275 "Types of links that should be activated in Org-mode files.
1276 This is a list of symbols, each leading to the activation of a certain link
1277 type. In principle, it does not hurt to turn on most link types - there may
1278 be a small gain when turning off unused link types. The types are:
1280 bracket The recommended [[link][description]] or [[link]] links with hiding.
1281 angle Links in angular brackets that may contain whitespace like
1282 <bbdb:Carsten Dominik>.
1283 plain Plain links in normal text, no whitespace, like http://google.com.
1284 radio Text that is matched by a radio target, see manual for details.
1285 tag Tag settings in a headline (link to tag search).
1286 date Time stamps (link to calendar).
1287 footnote Footnote labels.
1289 Changing this variable requires a restart of Emacs to become effective."
1301 "Function to use to generate link descriptions from links.
1302 If nil the link location will be used. This function must take
1303 two parameters; the first is the link and the second the
1304 description `org-insert-link' has generated, and should return the
1305 description to use."
1310 "Options concerning storing links in Org-mode."
1315 "Format of the description part of a link to an email or usenet message.
1316 The following %-escapes will be replaced by corresponding information:
1324 %s subject
1325 %d date
1326 %m message-id.
1328 You may use normal field width specification between the % and the letter.
1329 This is for example useful to limit the length of the subject.
1343 It should match if the message is from the user him/herself."
1348 "Non-nil means storing a link to an Org file will use entry IDs.
1350 Note that before this variable is even considered, org-id must be loaded,
1351 so please customize `org-modules' and turn it on.
1353 The variable can have the following values:
1355 t Create an ID if needed to make a link to the current entry.
1357 create-if-interactive
1358 If `org-store-link' is called directly (interactively, as a user
1359 command), do create an ID to support the link. But when doing the
1360 job for remember, only use the ID if it already exists. The
1361 purpose of this setting is to avoid proliferation of unwanted
1362 IDs, just because you happen to be in an Org file when you
1363 call `org-remember' that automatically and preemptively
1364 creates a link. If you do want to get an ID link in a remember
1365 template to an entry not having an ID, create it first by
1366 explicitly creating a link to it, using `C-c C-l' first.
1368 create-if-interactive-and-no-custom-id
1369 Like create-if-interactive, but do not create an ID if there is
1370 a CUSTOM_ID property defined in the entry. This is the default.
1372 use-existing
1373 Use existing ID, do not create one.
1375 nil Never use an ID to make a link, instead link using a text search for
1376 the headline text."
1381 create-if-interactive)
1383 create-if-interactive-and-no-custom-id)
1388 "Non-nil means file links from `org-store-link' contain context.
1389 A search string will be added to the file name with :: as separator and
1390 used to find the context when the link is activated by the command
1391 `org-open-at-point'. When this option is t, the entire active region
1392 will be placed in the search string of the file link. If set to a
1393 positive integer, only the first n lines of context will be stored.
1396 negates this setting for the duration of the command."
1401 "Non-nil means keep link in list for entire session.
1403 The command `org-store-link' adds a link pointing to the current
1404 location to an internal list. These links accumulate during a session.
1405 The command `org-insert-link' can be used to insert links into any
1406 Org-mode file (offering completion for all stored links). When this
1408 will be removed from the list, to make completing the unused links
1409 more efficient."
1414 "Options concerning following links in Org-mode."
1419 "Function to translate links with different syntax to Org syntax.
1420 This can be used to translate links created for example by the Planner
1421 or emacs-wiki packages to Org syntax.
1422 The function must accept two parameters, a TYPE containing the link
1424 which is everything after the link protocol. It should return a cons
1425 with possibly modified values of type and path.
1426 Org contains a function for this, so if you set this variable to
1427 `org-translate-link-from-planner', you should be able follow many
1428 links created by planner."
1433 "Hook that is run after a link has been followed."
1438 "Non-nil means on links TAB will follow the link.
1439 Needs to be set before org.el is loaded.
1440 This really should not be used, it does not make sense, and the
1441 implementation is bad."
1446 "Non-nil means on links RET will follow the link."
1452 "Non-nil means mouse-1 on a link will follow the link.
1453 A longer mouse click will still set point. Does not work on XEmacs.
1454 Needs to be set before org.el is loaded."
1459 "Number of different positions to be recorded in the ring.
1460 Changing this requires a restart of Emacs to work correctly."
1465 "Non-nil means internal links in Org files must exactly match a headline.
1466 When nil, the link search tries to match a phrase will all words
1467 in the search text."
1473 query-to-create)))
1480 "Setup the frame configuration for following links.
1481 When following a link with Emacs, it may often be useful to display
1482 this link in another window or frame. This variable can be used to
1483 set this up for the different types of links.
1484 For VM, use any of
1485 `vm-visit-folder'
1486 `vm-visit-folder-other-window'
1487 `vm-visit-folder-other-frame'
1488 For Gnus, use any of
1489 `gnus'
1490 `gnus-other-frame'
1491 `org-gnus-no-new-news'
1492 For FILE, use any of
1493 `find-file'
1494 `find-file-other-window'
1495 `find-file-other-frame'
1496 For Wanderlust use any of
1497 `wl'
1498 `wl-other-frame'
1499 For the calendar, use the variable `calendar-setup'.
1500 For BBDB, it is currently only possible to display the matches in
1501 another window."
1525 "Non-nil means use indirect buffer to display infile links.
1526 Activating internal links (from one location in a file to another location
1527 in the same file) normally just jumps to the location. When the link is
1529 is displayed in
1530 another window. When this option is set, the other window actually displays
1531 an indirect buffer clone of the current buffer, to avoid any visibility
1532 changes to the current buffer."
1537 "Non-nil means `org-open-file' will open non-existing files.
1538 When nil, an error will be generated.
1539 This variable applies only to external applications because they
1540 might choke on non-existing files. If the link is to a file that
1541 will be opened in Emacs, the variable is ignored."
1546 "Non-nil means a link to a directory really means to index.org.
1547 When nil, following a directory link will run dired or open a finder/explorer
1548 window on that directory."
1553 "Function and arguments to call for following mailto links.
1554 This is a list with the first element being a Lisp function, and the
1555 remaining elements being arguments to the function. In string arguments,
1556 %a will be replaced by the address, and %s will be replaced by the subject
1557 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1566 "Non-nil means ask for confirmation before executing shell links.
1567 Shell links can be dangerous: just think about a link
1569 [[shell:rm -rf ~/*][Google Search]]
1572 but really it would remove your entire home directory.
1573 Therefore we advise against setting this variable to nil.
1574 Just change it to `y-or-n-p' if you want to confirm with a
1582 'safe-local-variable
1586 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1587 Elisp links can be dangerous: just think about a link
1592 but really it would remove your entire home directory.
1593 Therefore we advise against setting this variable to nil.
1594 Just change it to `y-or-n-p' if you want to confirm with a
1602 'safe-local-variable
1609 "Default file applications on a UNIX or GNU/Linux system.
1620 "Default file applications on a MacOS X system.
1622 for some files for which the OS does not have a good default.
1630 'mswindows-shell-execute
1635 'mswindows-shell-execute
1638 "Default file applications on a Windows NT system.
1643 '(
1648 )
1649 "External applications for opening `file:path' items in a document.
1650 Org-mode uses system defaults for different file types, but
1651 you can use this variable to set the application for a given file
1652 extension. The entries in this list are cons cells where the car identifies
1653 files and the cdr the corresponding command. Possible values for the
1654 file identifier are
1656 ways, depending on its contents:
1658 - Alphanumeric characters only:
1659 Match links with this file extension.
1661 to open PDFs with evince.
1663 - Regular expression: Match links where the
1664 filename matches the regexp. If you want to
1665 use groups here, use shy groups.
1669 to open *.html and *.xhtml with firefox.
1671 - Regular expression which contains (non-shy) groups:
1673 anything after that, matches the regexp.
1674 In a custom command string, %1, %2, etc. are replaced with
1675 the parts of the link that were matched by the groups.
1676 For backwards compatibility, if a command string is given
1677 that does not use any of the group matches, this case is
1678 handled identically to the second one (i.e. match against
1679 file name only).
1680 In a custom lisp form, you can access the group matches with
1681 (match-string n link).
1684 to open [[file:document.pdf::5]] with evince at page 5.
1686 `directory' Matches a directory
1687 `remote' Matches a remote file, accessible through tramp or efs.
1688 Remote files most likely should be visited through Emacs
1689 because external applications cannot handle such paths.
1690 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1691 so all files Emacs knows how to handle. Using this with
1692 command `emacs' will open most files in Emacs. Beware that this
1693 will also open html files inside Emacs, unless you add
1695 t Default for files not matched by any of the other options.
1696 `system' The system command to open files, like `open' on Windows
1697 and Mac OS X, and mailcap under GNU/Linux. This is the command
1698 that will be selected if you call `C-c C-o' with a double
1701 Possible values for the command are:
1702 `emacs' The file will be visited by the current Emacs process.
1703 `default' Use the default application for this file type, which is the
1704 association for t in the list, most likely in the system-specific
1705 part.
1706 This can be used to overrule an unwanted setting in the
1707 system-specific variable.
1709 This command is specified by the entry whose car is `system'.
1710 Most likely, the system-specific version of this variable
1711 does define this command, but you can overrule/replace it
1712 here.
1713 string A command to be executed by a shell; %s will be replaced
1714 by the path to the file.
1715 sexp A Lisp form which will be evaluated. The file path will
1716 be available in the Lisp variable `file'.
1717 For more examples, see the system specific constants
1718 `org-file-apps-defaults-macosx'
1719 `org-file-apps-defaults-windowsnt'
1720 `org-file-apps-defaults-gnu'."
1730 auto-mode))
1741 "Options concerning refiling entries in Org-mode."
1746 "Directory with org files.
1747 This is just a default location to look for Org files. There is no need
1748 at all to put your files into this directory. It is only used in the
1749 following situations:
1751 1. When a remember template specifies a target file that is not an
1752 absolute path. The path will then be interpreted relative to
1753 `org-directory'
1754 2. When a remember note is filed away in an interactive way (when exiting the
1755 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1756 with `org-directory' as the default path."
1762 "Default target for storing notes.
1763 Used as a fall back file for org-remember.el and org-capture.el, for
1764 templates that do not specify a target file."
1769 file))
1772 "The default interface to be used for `org-goto'.
1773 Allowed values are:
1774 outline The interface shows an outline of the relevant file
1775 and the correct heading is found by moving through
1776 the outline or by searching with incremental search.
1777 outline-path-completion Headlines in the current buffer are offered via
1778 completion. This is the interface also used by
1779 the refile command."
1786 "Maximum target level when running `org-goto' with refile interface."
1791 "Non-nil means store new notes at the beginning of a file or entry.
1792 When nil, new notes will be filed to the end of a file or entry.
1793 This can also be a list with cons cells of regular expressions that
1794 are matched against file names, and values."
1804 "Information to record when a task is refiled.
1806 Possible values are:
1808 nil Don't add anything
1809 time Add a time stamp to the task
1810 note Prompt for a note and add it with template `org-log-note-headings'
1812 This option can also be set with on a per-file-basis with
1814 #+STARTUP: nologrefile
1815 #+STARTUP: logrefile
1816 #+STARTUP: lognoterefile
1818 You can have local logging settings for a subtree by setting the LOGGING
1819 property to one or more of these keywords.
1821 When bulk-refiling from the agenda, the value `note' is forbidden and
1822 will temporarily be changed to `time'."
1832 This is list of cons cells. Each cell contains:
1833 - a specification of the files to be considered, either a list of files,
1834 or a symbol whose function or variable value will be used to retrieve
1835 a file name or a list of file names. If you use `org-agenda-files' for
1836 that, all agenda files will be scanned for targets. Nil means consider
1837 headings in the current buffer.
1838 - A specification of how to find candidate refile targets. This may be
1839 any of:
1841 This tag has to be present in all target headlines, inheritance will
1842 not be considered.
1844 todo keyword.
1846 headlines that are refiling targets.
1847 - a cons cell (:level . N). Any headline of level N is considered a target.
1848 Note that, when `org-odd-levels-only' is set, level corresponds to
1849 order in hierarchy, not to the number of stars.
1850 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1851 Note that, when `org-odd-levels-only' is set, level corresponds to
1852 order in hierarchy, not to the number of stars.
1854 You can set the variable `org-refile-target-verify-function' to a function
1855 to verify each headline found by the simple criteria above.
1857 When this variable is nil, all top-level headlines in the current buffer
1858 are used, equivalent to the value `((nil . (:level . 1))'."
1874 "Function to verify if the headline at point should be a refile target.
1875 The function will be called without arguments, with point at the
1876 beginning of the headline. It should return t and leave point
1877 where it is if the headline is a valid target for refiling.
1879 If the target should not be selected, the function must return nil.
1880 In addition to this, it may move point to a place from where the search
1881 should be continued. For example, the function may decide that the entire
1882 subtree of the current entry should be excluded and move point to the end
1883 of the subtree."
1888 "Non-nil means cache refile targets to speed up the process.
1889 The cache for a particular file will be updated automatically when
1890 the buffer has been killed, or when any of the marker used for flagging
1891 refile targets no longer points at a live buffer.
1892 If you have added new entries to a buffer that might themselves be targets,
1893 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1894 find that easier, `C-u C-u C-u C-c C-w'."
1899 "Non-nil means provide refile targets as paths.
1900 So a level 3 headline will be available as level1/level2/level3.
1902 When the value is `file', also include the file name (without directory)
1903 into the path. In this case, you can also stop the completion after
1904 the file name, to get entries inserted as top level in the file.
1906 When `full-file-path', include the full file path."
1915 "Non-nil means complete the outline path in hierarchical steps.
1916 When Org-mode uses the refile interface to select an outline path
1917 \(see variable `org-refile-use-outline-path'), the completion of
1918 the path can be done is a single go, or if can be done in steps down
1919 the headline hierarchy. Going in steps is probably the best if you
1920 do not use a special completion package like `ido' or `icicles'.
1921 However, when using these packages, going in one step can be very
1922 fast, while still showing the whole path to the entry."
1927 "Non-nil means allow to create new nodes as refile targets.
1929 of an existing node. When the value of this variable is `confirm',
1930 new node creation must be confirmed by the user (recommended)
1931 When nil, the completion must match an existing entry.
1933 Note that, if the new heading is not seen by the criteria
1934 listed in `org-refile-targets', multiple instances of the same
1935 heading would be created by trying again to file under the new
1936 heading."
1944 "Options concerning TODO items in Org-mode."
1949 "Options concerning Progress logging in Org-mode."
1954 '(
1957 "The available interpretation symbols for customizing `org-todo-keywords'.
1961 "List of TODO entry keyword sequences and their interpretation.
1964 Each sequence starts with a symbol, either `sequence' or `type',
1965 indicating if the keywords should be interpreted as a sequence of
1966 action steps, or as different types of TODO items. The first
1967 keywords are states requiring action - these states will select a headline
1968 for inclusion into the global TODO list Org-mode produces. If one of
1971 the last keyword is treated as the only DONE state of the sequence.
1974 additional state where no keyword is present. For details about this
1975 cycling, see the manual.
1977 TODO keywords and interpretation can also be set on a per-file basis with
1978 the special #+SEQ_TODO and #+TYP_TODO lines.
1980 Each keyword can optionally specify a character for fast state selection
1981 \(in combination with the variable `org-use-fast-todo-selection')
1982 and specifiers for state change logging, using the same syntax
1985 indicates to record a time stamp each time this state is selected.
1987 Each keyword may also specify if a timestamp or a note should be
1988 recorded when entering or leaving the state, by adding additional
1989 characters in the parenthesis after the keyword. This looks like this:
1991 record only the time of the state change. With X and Y being either
1993 Y when leaving the state if and only if the *target* state does not
1994 define X. You may omit any of the fast-selection key or X or /Y,
1995 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1997 For backward compatibility, this variable may also be just a list
1998 of keywords - in this case the interpretation (sequence or type) will be
1999 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2009 ;;Quick and dirty way to see
2010 ;;`org-todo-interpretations'. This takes the
2011 ;;place of item arguments
2012 :convert-widget
2019 org-todo-interpretation-widgets))
2020 widget))
2051 "Controls how TODO keywords are interpreted.
2052 This variable is in principle obsolete and is only used for
2053 backward compatibility, if the interpretation of todo keywords is
2054 not given already in `org-todo-keywords'. See that variable for
2055 more information."
2062 "Non-nil means use the fast todo selection scheme with C-c C-t.
2063 This variable describes if and under what circumstances the cycling
2064 mechanism for TODO keywords will be replaced by a single-key, direct
2065 selection scheme.
2067 When nil, fast selection is never used.
2069 When the symbol `prefix', it will be used when `org-todo' is called with
2070 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2071 in an agenda buffer.
2073 When t, fast selection is used by default. In this case, the prefix
2074 argument forces cycling instead.
2076 In all cases, the special interface is only used if access keys have actually
2077 been assigned by the user, i.e. if keywords in the configuration are followed
2078 by a letter in parenthesis, like TODO(t)."
2086 "Non-nil means update todo statistics after insert and toggle.
2087 ALL-HEADLINES means update todo statistics by including headlines
2088 with no TODO keyword as well, counting them as not done.
2089 A list of TODO keywords means the same, but skip keywords that are
2090 not in this list.
2092 When this is set, todo statistics is updated in the parent of the
2093 current entry each time a todo state is changed."
2103 "Non-nil means TODO statistics covers just direct children.
2104 When nil, all entries in the subtree are considered.
2105 This has only an effect if `org-provide-todo-statistics' is set.
2106 To set this to nil for only a single subtree, use a COOKIE_DATA
2112 "Hook which is run after the state of a TODO item was changed.
2113 The new state (a string with a TODO keyword, or nil) is available in the
2114 Lisp variable `state'."
2119 "Hook for functions that are allowed to block a state change.
2121 Each function gets as its single argument a property list, see
2122 `org-trigger-hook' for more information about this list.
2124 If any of the functions in this hook returns nil, the state change
2128 "Hook for functions that are triggered by a state change.
2130 Each function gets as its single argument a property list with at least
2131 the following elements:
2133 (:type type-of-change :position pos-at-entry-start
2134 :from old-state :to new-state)
2136 Depending on the type, more properties may be present.
2138 This mechanism is currently implemented for:
2140 TODO state changes
2141 ------------------
2142 :type todo-state-change
2143 :from previous state (keyword as a string), or nil, or a symbol
2144 'todo' or 'done', to indicate the general type of state.
2148 "Non-nil means undone TODO entries will block switching the parent to DONE.
2149 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2150 be blocked if any prior sibling is not yet done.
2151 Finally, if the parent is blocked because of ordered siblings of its own,
2152 the child will also be blocked.
2153 This variable needs to be set before org.el is loaded, and you need to
2154 restart Emacs after a change to make the change effective. The only way
2155 to change is while Emacs is running is through the customize interface."
2167 "Non-nil means unchecked boxes will block switching the parent to DONE.
2168 When this is nil, checkboxes have no influence on switching TODO states.
2169 When non-nil, you first need to check off all check boxes before the TODO
2170 entry can be switched to DONE.
2171 This variable needs to be set before org.el is loaded, and you need to
2172 restart Emacs after a change to make the change effective. The only way
2173 to change is while Emacs is running is through the customize interface."
2185 "Non-nil means inserting a TODO heading is treated as state change.
2187 logging will apply if appropriate. When nil, the new TODO item will
2188 be inserted directly, and no logging will take place."
2193 "Non-nil means switching TODO states with S-cursor counts as state change.
2194 This is the default behavior. However, setting this to nil allows a
2195 convenient way to select a TODO state and bypass any logging associated
2196 with that."
2201 "Tag changes that should be triggered by TODO state changes.
2202 This is a list. Each entry is
2204 (state-change (tag . flag) .......)
2206 State-change can be a string with a state, and empty string to indicate the
2207 state that has no TODO keyword, or it can be one of the symbols `todo'
2208 or `done', meaning any not-done or done state, respectively."
2222 "Information to record when a task moves to the DONE state.
2224 Possible values are:
2226 nil Don't add anything, just change the keyword
2227 time Add a time stamp to the task
2228 note Prompt for a note and add it with template `org-log-note-headings'
2230 This option can also be set with on a per-file-basis with
2232 #+STARTUP: nologdone
2233 #+STARTUP: logdone
2234 #+STARTUP: lognotedone
2236 You can have local logging settings for a subtree by setting the LOGGING
2237 property to one or more of these keywords."
2245 ;; Normalize old uses of org-log-done.
2252 "Information to record when the scheduling date of a tasks is modified.
2254 Possible values are:
2256 nil Don't add anything, just change the date
2257 time Add a time stamp to the task
2258 note Prompt for a note and add it with template `org-log-note-headings'
2260 This option can also be set with on a per-file-basis with
2262 #+STARTUP: nologreschedule
2263 #+STARTUP: logreschedule
2264 #+STARTUP: lognotereschedule"
2273 "Information to record when the deadline date of a tasks is modified.
2275 Possible values are:
2277 nil Don't add anything, just change the date
2278 time Add a time stamp to the task
2279 note Prompt for a note and add it with template `org-log-note-headings'
2281 This option can also be set with on a per-file-basis with
2283 #+STARTUP: nologredeadline
2284 #+STARTUP: logredeadline
2285 #+STARTUP: lognoteredeadline
2287 You can have local logging settings for a subtree by setting the LOGGING
2288 property to one or more of these keywords."
2297 "Non-nil means record a note when clocking out of an item.
2298 This can also be configured on a per-file basis by adding one of
2299 the following lines anywhere in the buffer:
2301 #+STARTUP: lognoteclock-out
2302 #+STARTUP: nolognoteclock-out"
2308 "Non-nil means the CLOSED time stamp will contain date and time.
2309 When nil, only the date will be recorded."
2323 "Headings for notes added to entries.
2324 The value is an alist, with the car being a symbol indicating the note
2325 context, and the cdr is the heading to be used. The heading may also be the
2326 empty string.
2327 %t in the heading will be replaced by a time stamp.
2328 %T will be an active time stamp instead the default inactive one
2329 %s will be replaced by the new TODO state, in double quotes.
2330 %S will be replaced by the old TODO state, in double quotes.
2331 %u will be replaced by the user name.
2332 %U will be replaced by the full user name.
2334 In fact, it is not a good idea to change the `state' entry, because
2335 agenda log mode depends on the format of these entries."
2341 "Heading when changing todo state (todo sequence only)"
2355 "Non-nil means insert state change notes and time stamps into a drawer.
2356 When nil, state changes notes will be inserted after the headline and
2357 any scheduling and clock lines, but not inside a drawer.
2359 The value of this variable should be the name of the drawer to use.
2360 LOGBOOK is proposed at the default drawer for this purpose, you can
2361 also set this to a string to define the drawer of your choice.
2365 If this variable is set, `org-log-state-notes-insert-after-drawers'
2366 will be ignored.
2368 You can set the property LOG_INTO_DRAWER to overrule this setting for
2369 a subtree."
2381 "Return the value of `org-log-into-drawer', but let properties overrule.
2382 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2383 used instead of the default value."
2391 "Non-nil means insert state change notes after any drawers in entry.
2392 Only the drawers that *immediately* follow the headline and the
2393 deadline/scheduled line are skipped.
2394 When nil, insert notes right after the heading and perhaps the line
2395 with deadline/scheduling if present.
2397 This variable will have no effect if `org-log-into-drawer' is
2398 set."
2404 "Non-nil means the latest state note will be directly after heading.
2405 When nil, the state change notes will be ordered according to time."
2411 "The TODO state to which a repeater should return the repeating task.
2412 By default this is the first task in a TODO sequence, or the previous state
2413 in a TODO_TYP set. But you can specify another task here.
2414 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2420 "Non-nil means record moving through the DONE state when triggering repeat.
2421 An auto-repeating task is immediately switched back to TODO when
2424 record a closing note, there will be no record of the task moving
2425 through DONE. This variable forces taking a note anyway.
2427 nil Don't force a record
2428 time Record a time stamp
2429 note Record a note
2431 This option can also be set with on a per-file-basis with
2433 #+STARTUP: logrepeat
2434 #+STARTUP: lognoterepeat
2435 #+STARTUP: nologrepeat
2437 You can have local logging settings for a subtree by setting the LOGGING
2438 property to one or more of these keywords."
2448 "Priorities in Org-mode."
2453 "Non-nil means priority commands are active.
2454 When nil, these commands will be disabled, so that you never accidentally
2455 set a priority."
2460 "The highest priority of TODO items. A character like ?A, ?B etc.
2461 Must have a smaller ASCII number than `org-lowest-priority'."
2466 "The lowest priority of TODO items. A character like ?A, ?B etc.
2467 Must have a larger ASCII number than `org-highest-priority'."
2472 "The default priority of TODO items.
2473 This is the priority an item get if no explicit priority is given."
2478 "Non-nil means start with default priority when starting to cycle.
2479 When this is nil, the first step in the cycle will be (depending on the
2480 command used) one higher or lower that the default priority."
2485 "Function to extract the priority from a string.
2486 The string is normally the headline. If this is nil Org computes the
2487 priority from the priority cookie like [#A] in the headline. It returns
2488 an integer, increasing by 1000 for each priority level.
2489 The user can set a different function here, which should take a string
2490 as an argument and return the numeric priority."
2495 "Options concerning time stamps and deadlines in Org-mode."
2500 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2501 When nil, these labeled time stamps are forces into the second line of an
2502 entry, just after the headline. When scheduling from the global TODO list,
2503 the time stamp will always be forced into the second line."
2508 "Formats for `format-time-string' which are used for time stamps.
2512 "Number of minutes to round time stamps to.
2513 These are two values, the first applies when first creating a time stamp.
2514 The second applies when changing it with the commands `S-up' and `S-down'.
2515 When changing the time stamp, this means that it will change in steps
2516 of N minutes, as given by the second value.
2518 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2519 numbers should be factors of 60, so for example 5, 10, 15.
2521 When this is larger than 1, you can still force an exact time stamp by using
2522 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2523 and by using a prefix arg to `S-up/down' to specify the exact number
2524 of minutes to shift."
2534 ;; Normalize old customizations of this variable.
2538 org-time-stamp-rounding-minutes)))
2541 "Non-nil means overlay custom formats over all time stamps.
2542 The formats are defined through the variable `org-time-stamp-custom-formats'.
2543 To turn this on on a per-file basis, insert anywhere in the file:
2544 #+STARTUP: customtime"
2552 "Custom formats for time stamps. See `format-time-string' for the syntax.
2553 These are overlayed over the default ISO format if the variable
2554 `org-display-custom-times' is set. Time like %H:%M should be at the
2555 end of the second format. The custom formats are also honored by export
2556 commands, if custom time display is turned on at the time of export."
2561 "Get the right format for a time string."
2566 f)))
2569 "The format string used when creating CLOCKSUM lines.
2570 This is also used when org-mode generates a time duration."
2576 org-mode generates a time duration."
2581 "The format string used when creating CLOCKSUM lines, or when
2582 org-mode generates a time duration."
2587 "No. of days before expiration during which a deadline becomes active.
2588 This variable governs the display in sparse trees and in the agenda.
2589 When 0 or negative, it means use this number (the absolute value of it)
2590 even if a deadline has a different individual lead time specified.
2592 Custom commands can set this variable in the options section."
2598 "Non-nil means assume future for incomplete date input from user.
2599 This affects the following situations:
2600 1. The user gives a month but not a year.
2603 2. The user gives a day, but no month.
2606 it will be considered as *this* month.
2608 If you set this variable to the symbol `time', then also the following
2609 will work:
2611 3. If the user gives a time, but no day. If the time is before now,
2612 to will be interpreted as tomorrow.
2614 Currently none of this works for ISO week specifications.
2616 When this option is nil, the current day, month and year will always be
2617 used as defaults.
2619 See also `org-agenda-jump-prefer-future'."
2627 "Should the agenda jump command prefer the future for incomplete dates?
2628 The default is to do the same as configured in `org-read-date-prefer-future'.
2629 But you can alse set a deviating value here.
2630 This may t or nil, or the symbol `org-read-date-prefer-future'."
2635 org-read-date-prefer-future)
2640 "Non-nil means display current interpretation of date prompt live.
2641 This display will be in an overlay, in the minibuffer."
2646 "Non-nil means pop up a calendar when prompting for a date.
2647 In the calendar, the date can be selected with mouse-1. However, the
2648 minibuffer will also be active, and you can simply enter the date as well.
2649 When nil, only the minibuffer will be available."
2657 "Hook to be used to set up keys for the date/time interface.
2658 Add key definitions to `minibuffer-local-map', which will be a temporary
2659 copy."
2664 "The hour when your day really ends. Must be an integer.
2665 This has influence for the following applications:
2667 the time given here, the day recognized as TODAY is actually yesterday.
2668 - When a date is read from the user and it is still before the time given
2669 here, the current date and time will be assumed to be yesterday, 23:59.
2670 Also, timestamps inserted in remember templates follow this rule.
2672 IMPORTANT: This is a feature whose implementation is and likely will
2673 remain incomplete. Really, it is only here because past midnight seems to
2674 be the favorite working time of John Wiegley :-)"
2679 "Non-nil means S-down will increase the time in a time stamp.
2680 When nil, S-up will increase."
2685 "Non-nil means make the calendar window follow timestamp changes.
2686 When a timestamp is modified and the calendar window is visible, it will be
2687 moved to the new date."
2692 "Options concerning tags in Org-mode."
2697 "List of tags allowed in Org-mode files.
2698 When this list is nil, Org-mode will base TAG input on what is already in the
2699 buffer.
2700 The value of this variable is an alist, the car of each entry must be a
2701 keyword as a string, the cdr may be a character that is used to select
2702 that tag through the fast-tag-selection interface.
2703 See the manual for details."
2718 "List of tags that will always appear in all Org-mode files.
2719 This is in addition to any in buffer settings or customizations
2720 of `org-tag-alist'.
2721 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2722 The value of this variable is an alist, the car of each entry must be a
2723 keyword as a string, the cdr may be a character that is used to select
2724 that tag through the fast-tag-selection interface.
2725 See the manual for details.
2726 To disable these tags on a per-file basis, insert anywhere in the file:
2727 #+STARTUP: noptag"
2738 "If non-nil, always offer completion for all tags of all agenda files.
2739 Instead of customizing this variable directly, you might want to
2740 set it locally for capture buffers, because there no list of
2741 tags in that file can be created dynamically (there are none).
2743 (add-hook 'org-capture-mode-hook
2744 (lambda ()
2745 (set (make-local-variable
2746 'org-complete-tags-always-offer-all-agenda-tags)
2747 t)))"
2752 "List of tags that can be inherited by all entries in the file.
2753 The tags will be inherited if the variable `org-use-tag-inheritance'
2754 says they should be.
2758 "Non-nil means use fast tag selection scheme.
2759 This is a special interface to select and deselect tags with single keys.
2760 When nil, fast selection is never used.
2761 When the symbol `auto', fast selection is used if and only if selection
2762 characters for tags have been configured, either through the variable
2763 `org-tag-alist' or through a #+TAGS line in the buffer.
2764 When t, fast selection is always used and selection keys are assigned
2765 automatically if necessary."
2773 "Non-nil means fast tag selection exits after first change.
2774 When nil, you have to press RET to exit it.
2775 During fast tag selection, you can toggle this flag with `C-c'.
2776 This variable can also have the value `expert'. In this case, the window
2777 displaying the tags menu is not even shown, until you press C-c again."
2785 "Non-nil means fast tags selection interface will also offer TODO states.
2789 "The column to which tags should be indented in a headline.
2790 If this number is positive, it specifies the column. If it is negative,
2791 it means that the tags should be flushright to that column. For example,
2792 -80 works well for a normal 80 character screen."
2797 "Non-nil means realign tags after pro/demotion of TODO state change.
2798 These operations change the length of a headline and therefore shift
2799 the tags around. With this options turned on, after each such operation
2800 the tags are again aligned to `org-tags-column'."
2805 "Non-nil means tags in levels apply also for sublevels.
2806 When nil, only the tags directly given in a specific line apply there.
2807 This may also be a list of tags that should be inherited, or a regexp that
2808 matches tags that should be inherited. Additional control is possible
2809 with the variable `org-tags-exclude-from-inheritance' which gives an
2810 explicit list of tags to be excluded from inheritance., even if the value of
2811 `org-use-tag-inheritance' would select it for inheritance.
2813 If this option is t, a match early-on in a tree can lead to a large
2814 number of matches in the subtree when constructing the agenda or creating
2815 a sparse tree. If you only want to see the first match in a tree during
2816 a search, check out the variable `org-tags-match-list-sublevels'."
2825 "List of tags that should never be inherited.
2826 This is a way to exclude a few tags from inheritance. For way to do
2827 the opposite, to actively allow inheritance for selected tags,
2828 see the variable `org-use-tag-inheritance'."
2833 "Check if TAG is one that should be inherited."
2845 "Non-nil means list also sublevels of headlines matching a search.
2846 This variable applies to tags/property searches, and also to stuck
2847 projects because this search is based on a tags match as well.
2849 When set to the symbol `indented', sublevels are indented with
2850 leading dots.
2852 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2853 the sublevels of a headline matching a tag search often also match
2854 the same search. Listing all of them can create very long lists.
2855 Setting this variable to nil causes subtrees of a match to be skipped.
2857 This variable is semi-obsolete and probably should always be true. It
2858 is better to limit inheritance to certain tags using the variables
2859 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2867 "When set, tags are sorted using this function as a comparator."
2883 "Options concerning properties in Org-mode."
2888 "How property key/value pairs should be formatted by `indent-line'.
2889 When `indent-line' hits a property definition, it will format the line
2890 according to this format, mainly to make sure that the values are
2891 lined-up with respect to each other."
2896 "Non-nil means properties apply also for sublevels.
2898 This setting is chiefly used during property searches. Turning it on can
2899 cause significant overhead when doing a search, which is why it is not
2900 on by default.
2902 When nil, only the properties directly given in the current entry count.
2903 When t, every property is inherited. The value may also be a list of
2904 properties that should have inheritance, or a regular expression matching
2905 properties that should be inherited.
2907 However, note that some special properties use inheritance under special
2908 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2910 for valid values of a property.
2912 Note for programmers:
2913 When querying an entry with `org-entry-get', you can control if inheritance
2914 should be used. By default, `org-entry-get' looks only at the local
2915 properties. You can request inheritance by setting the inherit argument
2916 to t (to force inheritance) or to `selective' (to respect the setting
2917 in this variable)."
2926 "Check if PROPERTY is one that should be inherited."
2937 "The default column format, if no other format has been defined.
2938 This variable can be set on the per-file basis by inserting a line
2940 #+COLUMNS: %25ITEM ....."
2945 "The ellipses to be used when a field in column view is truncated.
2946 When this is the empty string, as many characters as possible are shown,
2947 but then there will be no visual indication that the field has been truncated.
2948 When this is a string of length N, the last N characters of a truncated
2949 field are replaced by this string. If the column is narrower than the
2950 ellipses string, only part of the ellipses string will be shown."
2955 "Function that modifies values for display in column view.
2956 For example, it can be used to cut out a certain part from a time stamp.
2957 The function must take 2 arguments:
2959 column-title The title of the column (*not* the property name)
2960 value The value that should be modified.
2962 The function should return the value that should be displayed,
2963 or nil if the normal value should be used."
2968 "The property that is being used to keep track of effort estimates.
2969 Effort estimates given in this property need to have the format H:MM."
2977 "List of property/value pairs that can be inherited by any entry.
2979 These are fixed values, for the preset properties. The user variable
2980 that can be used to add to this list is `org-global-properties'.
2982 The entries in this list are cons cells where the car is a property
2983 name and cdr is a string with the value. If the value represents
2988 "List of property/value pairs that can be inherited by any entry.
2990 This list will be combined with the constant `org-global-properties-fixed'.
2992 The entries in this list are cons cells where the car is a property
2993 name and cdr is a string with the value.
2995 You can set buffer-local values for the same purpose in the variable
2996 `org-file-properties' this by adding lines like
2998 #+PROPERTY: NAME VALUE"
3005 "List of property/value pairs that can be inherited by any entry.
3006 Valid for the current buffer.
3011 "Options concerning agenda views in Org-mode."
3016 "Variable used by org files to set a category for agenda display.
3017 Such files should use a file variable to set it, for example
3021 or contain a special line
3023 #+CATEGORY: ELisp
3025 If the file does not specify a category, then file's base name
3031 "The files to be used for agenda display.
3035 If an entry is a directory, all files in that directory that are matched by
3036 `org-agenda-file-regexp' will be part of the file list.
3038 If the value of the variable is not a list but a single file name, then
3039 the list of agenda files is actually stored and maintained in that file, one
3040 agenda file per line. In this file paths can be given relative to
3041 `org-directory'. Tilde expansion and environment variable substitution
3042 are also made."
3049 "Regular expression to match files for `org-agenda-files'.
3050 If any element in the list in that variable contains a directory instead
3051 of a normal file, all files in that directory that are matched by this
3052 regular expression will be included."
3057 "List of extra files to be searched by text search commands.
3058 These files will be search in addition to the agenda files by the
3059 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3060 Note that these files will only be searched for text search commands,
3061 not for the other agenda views like todo lists, tag searches or the weekly
3062 agenda. This variable is intended to list notes and possibly archive files
3063 that should also be searched by these two commands.
3064 In fact, if the first element in the list is the symbol `agenda-archives',
3065 than all archive files of all agenda files will be added to the search
3066 scope."
3077 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3078 A nil value means to remove them, after a query, from the list."
3083 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3084 The command `org-calendar-goto-agenda' will be bound to this key. The
3085 default is the character `c' because then `c' can be used to switch back and
3086 forth between agenda and calendar."
3091 "The key to be installed in `calendar-mode-map' for agenda-action.
3092 The command `org-agenda-action' will be bound to this key. The
3093 default is the character `k' because we use the same key in the agenda."
3098 "The key to be installed in `calendar-mode-map' for adding diary entries.
3099 This option is irrelevant until `org-agenda-diary-file' has been configured
3100 to point to an Org-mode file. When that is the case, the command
3101 `org-agenda-diary-entry' will be bound to the key given here, by default
3102 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3103 if you want to continue doing this, you need to change this to a different
3104 key."
3109 "File to which to add new entries with the `i' key in agenda and calendar.
3110 When this is the symbol `diary-file', the functionality in the Emacs
3111 calendar will be used to add entries to the `diary-file'. But when this
3112 points to a file, `org-agenda-diary-entry' will be used instead."
3128 org-calendar-insert-diary-entry-key
3132 "Options for embedding LaTeX code into Org-mode."
3140 "Options for creating images from LaTeX fragments.
3141 This is a property list with the following properties:
3143 `default' means use the foreground of the default face.
3145 `default' means use the background of the default face.
3146 :scale a scaling factor for the size of the images, to get more pixels
3147 :html-foreground, :html-background, :html-scale
3148 the same numbers for HTML export.
3149 :matchers a list indicating which matchers should be used to
3150 find LaTeX fragments. Valid members of this list are:
3161 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3162 When nil, just push out a message."
3171 \[PACKAGES]
3172 \[DEFAULT-PACKAGES]
3173 % The settings below are copied from fullpage.sty
3186 "The document header used for processing LaTeX fragments.
3187 It is imperative that this header make sure that no page number
3188 appears on the page. The package defined in the variables
3189 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3191 will be appended."
3198 "Set the packages alist and make sure it has 3 elements per entry."
3202 x))
3203 val)))
3207 "Get the packages alist and make sure it has 3 elements per entry."
3211 x))
3214 ;; The following variables are defined here because is it also used
3215 ;; when formatting latex fragments. Originally it was part of the
3216 ;; LaTeX exporter, which is why the name includes "export".
3233 )
3234 "Alist of default packages to be inserted in the header.
3235 Change this only if one of the packages here causes an incompatibility
3236 with another package you are using.
3237 The packages in this list are needed by one part or another of Org-mode
3238 to function properly.
3240 - inputenc, fontenc: for basic font and character selection
3241 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3242 for interpreting the entities in `org-entities'. You can skip some of these
3243 packages if you don't use any of the symbols in it.
3244 - graphicx: for including images
3245 - float, wrapfig: for figure placement
3246 - longtable: for long tables
3247 - hyperref: for cross references
3249 Therefore you should not modify this variable unless you know what you
3250 are doing. The one reason to change it anyway is that you might be loading
3251 some other package that conflicts with one of the default packages.
3253 If SNIPPET-FLAG is t, the package also needs to be included when
3254 compiling LaTeX snippets into images for inclusion into HTML."
3267 "Alist of packages to be inserted in every LaTeX header.
3268 These will be inserted after `org-export-latex-default-packages-alist'.
3270 SNIPPET-FLAG, when t, indicates that this package is also needed when
3271 turning LaTeX snippets into images for inclusion into HTML.
3272 Make sure that you only list packages here which:
3273 - you want in every file
3274 - do not conflict with the default packages in
3275 `org-export-latex-default-packages-alist'
3276 - do not conflict with the setup in `org-format-latex-header'."
3290 "Settings for Org-mode appearance."
3295 "Non-nil means fontify only the stars in each headline.
3296 When nil, the entire headline is fontified.
3297 Changing it requires restart of `font-lock-mode' to become effective
3298 also in regions already fontified."
3303 "Non-nil means hide the first N-1 stars in a headline.
3304 This works by using the face `org-hide' for these stars. This
3305 face is white for a light background, and black for a dark
3306 background. You may have to customize the face `org-hide' to
3307 make this work.
3308 Changing it requires restart of `font-lock-mode' to become effective
3309 also in regions already fontified.
3310 You may also set this on a per-file basis by adding one of the following
3311 lines to the buffer:
3313 #+STARTUP: hidestars
3314 #+STARTUP: showstars"
3319 "List of keywords that should be hidden when typed in the org buffer.
3320 For example, add #+TITLE to this list in order to make the
3321 document title appear in the buffer without the initial #+TITLE:
3322 keyword."
3330 "Non-nil means change the face of a headline if it is marked DONE.
3331 Normally, only the TODO/DONE keyword indicates the state of a headline.
3332 When this is non-nil, the headline after the keyword is set to the
3333 `org-headline-done' as an additional indication."
3338 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3339 Changing this variable requires a restart of Emacs to take effect."
3344 "Non-nil means fontify the whole line for headings.
3345 This is useful when setting a background color for the
3346 org-level-* faces."
3351 "Non-nil means fontify what is treated specially by the exporters."
3356 "Non-nil mean font-lock should hide the emphasis marker characters."
3361 "Non-nil means show entities as UTF8 characters.
3367 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3372 "Regular expression for matching emphasis.
3373 After a match, the match groups contain these elements:
3374 0 The match of the full regular expression, including the characters
3375 before and after the proper match
3376 1 The character before the proper match, or empty at beginning of line
3377 2 The proper match, including the leading and trailing markers
3378 3 The leading marker like * or /, indicating the type of highlighting
3379 4 The text between the emphasis markers, not including the markers
3386 "Set variable and compute the emphasis regular expression."
3390 org-emphasis-alist org-emphasis-regexp-components)
3402 ;; make sure special characters appear at the right position in the class
3414 ;; Make the regexp
3422 body1
3434 body1
3442 "Components used to build the regular expression for emphasis.
3443 This is a list with five entries. Terminology: In an emphasis string
3447 specify what is allowed/forbidden in each part:
3449 pre Chars allowed as prematch. Beginning of line will be allowed too.
3450 post Chars allowed as postmatch. End of line will be allowed too.
3451 border The chars *forbidden* as border characters.
3453 non-shy groups here, and don't allow newline here.
3454 newline The maximum number of newlines allowed in an emphasis exp.
3456 Use customize to modify this, or restart Emacs after changing it."
3475 )
3476 "Special syntax for emphasized text.
3477 Text starting and ending with a special character will be emphasized, for
3478 example *bold*, _underlined_ and /italic/. This variable sets the marker
3479 characters, the face to be used by font-lock for highlighting in Org-mode
3480 Emacs buffers, and the HTML tags to be used for this.
3481 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3482 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3483 Use customize to modify this, or restart Emacs after changing it."
3498 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3501 ;;; Miscellaneous options
3504 "Completion in Org-mode."
3509 "Non-nil means use ido completion wherever possible.
3510 Note that `ido-mode' must be active for this variable to be relevant.
3511 If you decide to turn this variable on, you might well want to turn off
3512 `org-outline-path-complete-in-steps'.
3513 See also `org-completion-use-iswitchb'."
3518 "Non-nil means use iswitchb completion wherever possible.
3519 Note that `iswitchb-mode' must be active for this variable to be relevant.
3520 If you decide to turn this variable on, you might well want to turn off
3521 `org-outline-path-complete-in-steps'.
3522 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3528 Normal means, no org-mode-specific context."
3532 ;;; Functions and variables from their packages
3533 ;; Declared here to avoid compiler warnings
3535 ;; XEmacs only
3541 ;; Emacs only
3544 ;; Various packages
3562 org-format-agenda-item "org-agenda"
3593 ;;; Autoload and prepare some org modules
3595 ;; Some table stuff that needs to be defined here, because it is used
3596 ;; by the functions setting up org-mode or checking for table context.
3609 "Detect the first line outside a table when searching from within it.
3612 ;; Autoload the functions in org-table.el that are needed by functions here.
3617 org-table-convert org-table-convert-region org-table-copy-down
3618 org-table-copy-region org-table-create
3619 org-table-create-or-convert-from-region
3620 org-table-create-with-table.el org-table-current-dline
3621 org-table-cut-region org-table-delete-column org-table-edit-field
3622 org-table-edit-formulas org-table-end org-table-eval-formula
3623 org-table-export org-table-field-info
3624 org-table-get-stored-formulas org-table-goto-column
3625 org-table-hline-and-move org-table-import org-table-insert-column
3626 org-table-insert-hline org-table-insert-row org-table-iterate
3627 org-table-justify-field-maybe org-table-kill-row
3628 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3629 org-table-move-column org-table-move-column-left
3630 org-table-move-column-right org-table-move-row
3631 org-table-move-row-down org-table-move-row-up
3632 org-table-next-field org-table-next-row org-table-paste-rectangle
3633 org-table-previous-field org-table-recalculate
3634 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3635 org-table-toggle-coordinate-overlays
3636 org-table-toggle-formula-debugger org-table-wrap-region
3637 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3638 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3639 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3642 "Return t if the cursor is inside an org-type table.
3643 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3648 org-table-line-regexp)))
3649 nil))
3653 "Return t if and only if we are at a table.el table."
3659 "If there is a table.el table nearby, recognize it and move into it."
3665 nil
3675 t
3680 t)
3681 nil)
3682 nil))
3685 "Return t if the cursor is inside a hline in a table."
3690 nil))
3695 "Apply FUNCTION to the start of all tables in the buffer."
3711 ;; Declare and autoload functions from org-exp.el & Co
3719 org-insert-export-options-template
3720 org-table-clean-before-export))
3723 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3724 org-export-region-as-ascii))
3727 org-replace-region-by-latex org-export-region-as-latex
3728 org-export-as-latex org-export-as-pdf
3729 org-export-as-pdf-and-open))
3732 org-export-as-html-batch org-export-as-html-to-buffer
3733 org-replace-region-by-html org-export-region-as-html
3734 org-export-as-html))
3737 org-replace-region-by-docbook org-export-region-as-docbook
3738 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3739 org-export-as-docbook))
3742 org-export-icalendar-all-agenda-files
3743 org-export-icalendar-combine-agenda-files))
3747 ;; Declare and autoload functions from org-agenda.el
3752 org-todo-list org-tags-view org-agenda-list-stuck-projects
3753 org-diary org-agenda-to-appt
3754 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3756 ;; Autoload org-remember
3761 org-remember-apply-template org-remember org-remember-handler)))
3766 org-capture-import-remember-templates)))
3768 ;; Autoload org-clock.el
3783 "Return non-nil if clock is currently running.
3784 The return value is actually the clock marker."
3789 "org-clock"
3791 org-clock-goto org-clock-sum org-clock-display
3792 org-clock-remove-overlays org-clock-report
3793 org-clocktable-shift org-dblock-write:clocktable
3794 org-get-clocktable org-resolve-clocks)))
3797 "If this is a CLOCK line, update it and return t.
3798 Otherwise, return nil."
3807 ts te h m s neg)
3810 nil)
3815 ;; The clock is running here
3836 t))))))
3839 "Check if the current buffer contains the running clock.
3840 If yes, offer to stop it and to save the buffer with the changes."
3849 "Check if this line starts a clock table, if yes, shift the time block."
3853 ;; Autoload org-timer.el
3857 "org-timer"
3859 org-timer-change-times-in-region
3860 org-timer-set-timer
3861 org-timer-reset-timers
3862 org-timer-show-remaining-time)))
3864 ;; Autoload org-feed.el
3868 "org-feed"
3872 ;; Autoload org-indent.el
3874 ;; Define the variable already here, to make sure we have it.
3876 "Non-nil if Org-Indent mode is enabled.
3881 "org-indent"
3884 ;; Autoload org-mobile.el
3888 "org-mobile"
3891 ;; Autoload archiving code
3892 ;; The stuff that is needed for cycling and tags has to be defined here.
3895 "Options concerning archiving in Org-mode."
3900 "The location where subtrees should be archived.
3902 The value of this variable is a string, consisting of two parts,
3903 separated by a double-colon. The first part is a filename and
3904 the second part is a headline.
3906 When the filename is omitted, archiving happens in the same file.
3907 %s in the filename will be replaced by the current file
3908 name (without the directory part). Archiving to a different file
3909 is useful to keep archived entries from contributing to the
3910 Org-mode Agenda.
3912 The archived entries will be filed as subtrees of the specified
3913 headline. When the headline is omitted, the subtrees are simply
3914 filed away at the end of the file, as top-level entries. Also in
3915 the heading you can use %s to represent the file name, this can be
3916 useful when using the same archive for a number of different files.
3918 Here are a few examples:
3920 If the current file is Projects.org, archive in file
3921 Projects.org_archive, as top-level trees. This is the default.
3924 Archive in the current file, under the top-level headline
3928 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3931 Archive in file ~/org/archive.org (absolute path), under headlines
3935 Archive in file ./basement (relative path), as level 3 trees
3938 You may set this option on a per-file basis by adding to the buffer a
3939 line like
3941 #+ARCHIVE: basement::** Finished Tasks
3943 You may also define it locally for a subtree by setting an ARCHIVE property
3944 in the entry. If such a property is found in an entry, or anywhere up
3945 the hierarchy, it will be used."
3950 "The tag that marks a subtree as archived.
3951 An archived subtree does not open during visibility cycling, and does
3952 not contribute to the agenda listings.
3953 After changing this, font-lock must be restarted in the relevant buffers to
3954 get the proper fontification."
3960 "Non-nil means the agenda will skip any items located in archived trees.
3961 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3962 variable is no longer recommended, you should leave it at the value t.
3963 Instead, use the key `v' to cycle the archives-mode in the agenda."
3969 "Non-nil means ignore archived trees when creating column view."
3975 "Non-nil means `org-cycle' will open archived trees.
3976 An archived tree is a tree marked with the tag ARCHIVE.
3977 When nil, archived trees will stay folded. You can still open them with
3978 normal outline commands like `show-all', but not with the cycling commands."
3984 "Non-nil means sparse tree construction shows matches in archived trees.
3985 When nil, matches in these trees are highlighted, but the trees are kept in
3986 collapsed state."
3992 "Re-hide all archived subtrees after a visibility state change."
4003 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4006 "Cycle subtree even if it is archived."
4013 "Re-hide all archived subtrees after a visibility state change."
4028 flag)))
4035 org-archive-to-archive-sibling org-toggle-archive-tag
4036 org-archive-subtree-default
4037 org-archive-subtree-default-with-confirmation)))
4039 ;; Autoload Column View Code
4047 org-columns-compute org-agenda-columns org-columns-remove-overlays
4050 ;; Autoload ID code
4058 org-id-get-with-outline-path-completion
4059 org-id-get-with-outline-drilling org-id-store-link
4060 org-id-goto org-id-find org-id-store-link))
4062 ;; Autoload Plotting Code
4067 ;;; Variables for pre-computed regular expressions, all buffer local
4085 "Matches a headline and puts everything into groups:
4086 group 1: the stars
4087 group 2: The todo keyword, maybe
4088 group 3: Priority cookie
4089 group 4: True headline
4093 "Printf format to make regexp to match an exact headline.
4094 This regexp will match the headline of any node which hase the exact
4095 headline text that is put into the format, but may have any TODO state,
4099 "Matches a headline and puts TODO state into group 2 if present.
4154 "Regular expression to match a plain time or time range.
4155 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4156 groups carry important information:
4157 0 the full match
4158 1 the first time, range or not
4166 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4167 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4168 groups carry important information:
4169 0 the full match
4170 7 hours of duration
4179 "Regular expression to match a timestamp time or time range.
4180 After a match, the following groups carry important information:
4181 0 the full match
4182 1 date plus weekday, for back referencing to make sure both times are on the same day
4183 2 the first time, range or not
4238 "Variable associated with STARTUP options for org-mode.
4239 Each element is a list of three items: The startup options as written
4240 in the #+STARTUP line, the corresponding variable, and the value to
4241 set this variable to if the option is found. An optional forth element PUSH
4245 "Precompute regular expressions for current buffer."
4265 kwds kws0 kwsa key log value cat arch tags const links hw dws
4266 tail sep kws1 prio props ftags drawers beamer-p
4288 ;; general TODO-like setup
4300 links)))
4306 props)))
4311 ftags
4321 l var val)
4351 ))))
4368 ;; Process the TODO keywords
4370 ;; Use the global values as if they had been given locally.
4382 kws)))
4385 kwsa nil
4388 ;; 1 2
4396 kw)
4398 kws0)
4415 ;; Process the constants
4423 ;; Process the tags.
4434 tgs))
4442 ;; Compute the regular expressions and other local variables
4450 org-drawer-regexp
4454 org-not-done-keywords
4456 org-todo-regexp
4459 org-not-done-regexp
4463 org-not-done-heading-regexp
4467 org-todo-line-regexp
4471 org-complex-heading-regexp
4476 org-complex-heading-regexp-format
4485 org-nl-done-regexp
4489 org-todo-line-tags-regexp
4494 org-looking-at-done-regexp
4499 org-deadline-time-regexp
4501 org-deadline-line-regexp
4503 org-scheduled-regexp
4505 org-scheduled-time-regexp
4507 org-closed-time-regexp
4509 org-keyword-time-regexp
4515 org-keyword-time-not-clock-regexp
4521 org-maybe-keyword-time-regexp
4527 org-planning-or-clock-line-re
4532 org-all-time-keywords
4535 org-clock-string org-closed-string))
4536 )
4541 "Return the contents of FILE, as a string."
4555 "Extract the log state setting from a TODO keyword string.
4569 "Remove a pair of parenthesis at the end of each string in LIST."
4573 x))
4574 list))
4577 "Assign fast keys to a keyword-key alist.
4578 Respect keys that are already there."
4596 ;;; Some variables used in various places
4603 "Function to be called when `C-c C-c' is used.
4607 ;; FIXME: Occasionally check by commenting these, to make sure
4608 ;; no other functions uses these, forgetting to let-bind them.
4613 ;; Defined somewhere in this file, but used before definition.
4619 ;;;; Define the Org-mode
4622 (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"))
4625 ;; We use a before-change function to check if a table might need
4626 ;; an update.
4628 "Indicates that a table might need an update.
4629 This variable is set by `org-before-change-function'.
4632 "Every change indicates that a table might need an update."
4643 ;;;###autoload
4645 "Outline-based notes management and organizer, alias
4648 Org-mode develops organizational tasks around a NOTES file which
4649 contains information about projects as plain text. Org-mode is
4650 implemented on top of outline-mode, which is ideal to keep the content
4651 of large files well structured. It supports ToDo items, deadlines and
4652 time stamps, which magically appear in the diary listing of the Emacs
4653 calendar. Tables are easily created with a built-in table editor.
4654 Plain text URL-like links connect to websites, emails (VM), Usenet
4655 messages (Gnus), BBDB entries, and any files related to the project.
4656 For printing and sharing of notes, an Org-mode file (or a part of it)
4657 can be exported as a structured ASCII or HTML file.
4659 The following commands are available:
4663 ;; Get rid of Outline menus, they are not needed
4664 ;; Need to do this here because define-derived-mode sets up
4665 ;; the keymap so late. Still, it is a waste to call this each time
4666 ;; we switch another buffer into org-mode.
4669 ;; Assume this is Greg's port, it uses easymenu
4694 org-display-table 4
4697 org-ellipsis)))
4702 ;; tag faces set outside customize.... force initialization.
4704 ;; Calc embedded
4710 ;; Activate before-change-function
4714 ;; Check for running clock before killing a buffer
4716 ;; Paragraphs and auto-filling
4720 ;; Beginning/end of defun
4723 ;; Next error for sparse trees
4725 ;; Make sure dependence stuff works reliably, even for users who set it
4726 ;; too late :-(
4738 ;; Comment characters
4742 ;; Align options lines
4744 'align-mode-rules-list
4749 ;; Imenu
4753 ;; Make isearch reveal context
4756 ;; Emacs 21 and XEmacs make use of the hook
4758 ;; Emacs 22 deals with this through a special variable
4762 ;; Turn on org-beamer-mode?
4765 ;; Setup the pcomplete hooks
4776 ;; If empty file that did not turn on org-mode automatically, make it to.
4801 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4811 "Return today date, considering `org-extend-today-until'."
4816 ;;;; Font-Lock stuff, including the activators
4847 "Regular expression used to analyze links.
4848 Here is what the match groups contain after a match:
4849 1: http:
4850 2: http
4851 3: path
4852 4: [desc]
4860 "Number of stacked braces for sub/superscript matching.
4861 This has to be set before loading org.el to be effective."
4866 "Create a regular expression which will match a balanced sexp.
4867 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4868 as single character strings.
4869 The regexp returned will match the entire expression including the
4870 delimiters. It will also define a single group which contains the
4871 match except for the outermost delimiters. The maximum depth of
4872 stacked delimiters is N. Escaping delimiters is not possible."
4901 "Update the link regular expressions.
4902 This should be called after the variable `org-link-types' has changed."
4906 org-link-re-with-space
4912 org-link-re-with-space2
4918 org-link-re-with-space3
4923 org-angle-link-re
4929 org-plain-link-re
4933 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
4934 org-bracket-link-regexp
4936 org-bracket-link-analytic-regexp
4944 org-bracket-link-analytic-regexp++
4952 org-any-link-re
4963 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4964 "Regular expression matching time strings for analysis.
4965 This one does not require the space after the date, so it can be used
4967 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4983 "Regular expression matching a time stamp or time stamp range.
4989 "Run through the buffer and add overlays to links."
4998 'face
5011 rtn))
5014 "Insert or change an emphasis, i.e. a font like bold or italic.
5015 If there is an active region, change that region to a new emphasis.
5016 If there is no region, just insert the marker characters and position
5017 the cursor between them.
5018 CHAR should be either the marker character, or the first character of the
5019 HTML tag associated with that emphasis. If CHAR is a space, the means
5020 to remove the emphasis of the selected region.
5021 If char is not given (for example in an interactive call) it
5022 will be prompted for."
5073 "Run through the buffer and add overlays to links."
5082 nil
5088 t)))))
5096 t)))
5099 "When non-nil, fontify code in code blocks."
5105 "Fontify #+ lines and blocks, in the correct ways."
5108 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5109 limit t)
5117 end end1 quoting block-type)
5120 ;; a single line of backend-specific content
5128 ; for backend-specific code
5129 t)
5131 ;; Truly a block
5143 beg end
5147 ; for end_src
5153 org-block)))
5154 ; end of source block
5160 t))
5173 ;; just any other in-buffer setting, but not indented
5177 t)
5185 t)
5193 "Run through the buffer and add overlays to links."
5201 t)))
5204 "Run through the buffer and add overlays to links."
5206 limit t)
5211 'keymap org-mouse-map
5212 'help-echo
5214 "Footnote definition"
5216 ))
5218 t)))
5221 "Run through the buffer and add overlays to bracketed links."
5225 ;; FIXME: above we should remove the escapes.
5226 ;; but that requires another match, protecting match data,
5227 ;; a lot of overhead for font-lock.
5234 ;; We need to remove the invisible property here. Table narrowing
5235 ;; may have made some of this invisible.
5253 t)))
5256 "Run through the buffer and add overlays to dates."
5268 t)))
5277 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5281 "Run through the buffer and add overlays to target matches."
5289 'keymap org-mouse-map
5293 t)))))
5296 "Find all radio targets in this file and update the regular expression."
5311 t)))
5318 ;; This should be with the exporter code, but we also use if for font-locking
5328 "Compute regular expression for stuff treated specially by exporters."
5335 org-latex-regexps)))
5363 org-entities)))
5367 org-latex-entities)
5368 nil))
5370 ))
5371 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5374 org-export-html-special-string-regexps)))
5379 ))))
5381 'org-latex-and-specials-regexp
5386 "Run through the buffer and add overlays to links."
5390 limit t))
5404 rtn)))
5407 "Restart `font-lock-mode', to force refontification."
5413 "Return a list of all targets in this file.
5414 With optional argument RADIO, only find radio targets."
5416 rtn)
5421 rtn)))
5424 "Make regular expression matching all strings in TARGETS.
5425 The regular expression finds the targets also if there is a line break
5426 between words."
5435 x)
5436 targets
5448 t)))
5451 "Compute the outline level of the heading at point.
5452 This function assumes that the cursor is at the beginning of a line matched
5453 by `outline-regexp'. Otherwise it returns garbage.
5454 If this is called at a normal headline, the level is the number of stars.
5455 Use `org-reduced-level' to remove the effect of `org-odd-levels'.
5456 For plain list items, if they are matched by `outline-regexp', this returns
5457 1000 plus the line indentation."
5466 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5473 "Functions that can manipulate `org-font-lock-extra-keywords'.
5474 This is calles after `org-font-lock-extra-keywords' is defined, but before
5475 it is installed to be used by font lock. This can be useful if something
5486 ;; Call the hook
5488 ;; Headlines
5495 ;; Table lines
5498 ;; Table internals
5503 ;; Drawers
5506 ;; Properties
5510 ;; Links
5521 ;; TODO lines
5524 ;; DONE
5530 nil)
5531 ;; Priorities
5533 ;; Tags
5535 ;; Special keywords
5540 ;; Emphasis
5545 ;; Checkboxes
5546 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5551 ;; Description list items
5554 ;; ARCHIVEd headings
5557 ;; Specials
5561 ;; Code
5563 ;; COMMENT
5568 ;; Blocks and meta lines
5570 )))
5573 ;; Now set the full font-lock-keywords
5580 "Toggle the composition display of entities as UTF8 characters."
5592 "Find an entity to fontify."
5598 limit t)
5610 nil))))
5613 "Fontify string S like in Org-mode."
5625 "Get the right face for match N in font-lock matching of headlines."
5638 "Get the right face for a TODO keyword KWD.
5639 If KWD is a number, get the corresponding match group."
5647 "Create a face list that inherits INHERIT, but sets the foreground color.
5648 When FACE-OR-COLOR is not a string, just return it."
5652 face-or-color)
5653 face-or-color))
5656 "Add the special tag faces."
5665 "Add the special priority faces."
5672 org-priority-faces)))
5677 "Get the right face for a TODO keyword KWD.
5678 If KWD is a number, get the corresponding match group."
5685 "Remove fontification and activation overlays from links."
5690 deactivate-mark buffer-file-name buffer-file-truename)
5693 beg end
5695 ;; also remove line-prefix and wrap-prefix properties
5697 invisible t intangible t
5698 line-prefix t wrap-prefix t
5699 org-no-flyspell t org-emphasis t)
5701 invisible t intangible t
5702 org-no-flyspell t org-emphasis t)))
5712 "Remove specific display properties that have been added by font lock.
5713 The will remove the raise properties that are used to show superscripts
5714 and subscripts."
5724 "Add raise properties to sub/superscripts."
5728 org-match-substring-regexp
5729 org-match-substring-with-braces-regexp)
5730 limit t)
5740 ;; FIXME: Should we go back one character here, for a_b^c
5741 ;; (goto-char (1- pos)) ;????????????????????
5743 t
5745 'display
5761 t)))))
5763 ;;;; Visibility cycling, including org-goto and indirect buffer
5765 ;;; Cycling
5772 ;;;###autoload
5777 "TAB-action and visibility cycling for Org-mode.
5779 This is the command invoked in Org-mode by the TAB key. Its main purpose
5780 is outline visibility cycling, but it also invokes other actions
5781 in special contexts.
5783 - When this function is called with a prefix argument, rotate the entire
5784 buffer through 3 states (global cycling)
5785 1. OVERVIEW: Show only top-level headlines.
5786 2. CONTENTS: Show all headlines of all levels, but no body text.
5787 3. SHOW ALL: Show everything.
5788 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5789 determined by the variable `org-startup-folded', and by any VISIBILITY
5790 properties in the buffer.
5791 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5792 including any drawers.
5794 - When inside a table, re-align the table and move to the next field.
5796 - When point is at the beginning of a headline, rotate the subtree started
5797 by this line through 3 different states (local cycling)
5798 1. FOLDED: Only the main headline is shown.
5799 2. CHILDREN: The main headline and the direct children are shown.
5800 From this state, you can move to one of the children
5801 and zoom in further.
5802 3. SUBTREE: Show the entire subtree, including body text.
5803 If there is no subtree, switch directly from CHILDREN to FOLDED.
5805 - When point is at the beginning of an empty headline and the variable
5806 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5807 of the headline by demoting and promoting it to likely levels. This
5808 speeds up creation document structure by pressing TAB once or several
5809 times right after creating a new headline.
5811 - When there is a numeric prefix, go up to a heading with level ARG, do
5812 a `show-subtree' and return to the previous cursor position. If ARG
5813 is negative, go up that many levels.
5815 - When point is not at the beginning of a headline, execute the global
5816 binding for TAB, which is re-indenting the line. See the option
5817 `org-cycle-emulate-tab' for details.
5819 - Special case: if point is at the beginning of the buffer and there is
5820 no headline in line 1, this function will act as if called with prefix arg
5821 (C-u TAB, same as S-TAB) also when called without prefix arg.
5822 But only if also the variable `org-cycle-global-at-bob' is t."
5832 org-inlinetask-min-level
5837 limit-level)))
5853 org-cycle-hook))
5857 ;; special case: use global cycling
5872 ;; Enter the table or move to the next field in the table
5889 ;; Toggle block visibility
5894 ;; Show-subtree, ARG levels up from here.
5906 ;; TAB emulation and template completion
5930 t
5939 "Do the global cycling action."
5943 ;; We just created the overview - now do table of contents
5944 ;; This can be slow in very large buffers, so indicate action
5954 ;; We just showed the table of contents - now show everything
5962 ;; Default action: go to overview
5970 "Do the local cycling action."
5972 ;; First, some boundaries
5979 ; XEmacs does not have `next-single-char-property-change'
5980 ; I'm not sure about Emacs 21.
5994 ;; if we're in a list, org-end-of-subtree is in fact org-end-of-item.
6003 ;; Find out what to do next and set `this-command'
6006 ;; Nothing is hidden behind this heading
6018 org-cycle-skip-children-state-if-no-children))))
6019 ;; Entire subtree is hidden in one line: children view
6033 ;; We just showed the children, or no children are there,
6034 ;; now show everything.
6041 ;; Default action: hide the subtree.
6048 ;;;###autoload
6050 "Cycle the global visibility. For details see `org-cycle'.
6052 With a numeric prefix, show all headlines up to that level."
6068 "Set the visibility required by startup options and properties."
6083 "Switch subtree visibilities according to :VISIBILITY: property."
6090 nil t)
6115 "Switch to overview mode, showing only top-level headlines.
6116 Really, this shows all headlines with level equal or greater than the level
6117 of the first headline in the buffer. This is important, because if the
6118 first headline is not level one, then (hide-sublevels 1) gives confusing
6119 results."
6130 "Show all headlines in the buffer, like a table of contents.
6131 With numerical argument N, show content up to level N."
6134 ;; Visit all headings and show their offspring
6141 t)
6150 "Adjust the window after a change in outline visibility.
6151 This function is the default value of the hook `org-cycle-hook'."
6161 "Remove outline overlays that do not contain non-white stuff."
6171 "Fix visibility issues after moving a subtree."
6172 ;; First, find a reasonable region to look at:
6173 ;; Start two siblings above, end three below
6191 ;; Properly fold already folded siblings
6202 "Show empty lines above all visible headlines.
6203 The region to be covered depends on STATE when called through
6204 `org-cycle-hook'. Lisp program can use t for STATE to get the
6205 entire buffer covered. Note that an empty line is only shown if there
6206 are at least `org-cycle-separator-lines' empty lines before the headline."
6216 beg end b e)
6240 ;; Never hide empty lines at the end of the file.
6250 "Move to the parent and re-show empty lines before visible headlines."
6256 "Return `org-agenda-files' list, plus all open org-mode files.
6257 This is useful for operations that need to scan all of a user's
6258 open and agenda-wise Org files."
6266 files))
6269 "Return the beginning position of the current entry."
6273 "Return the end position of the current entry."
6277 "Re-hide all drawers after a visibility state change."
6304 "Is the end of the current subtree visible?"
6309 "Move cursor to the first headline and recenter the headline.
6310 Optional argument N means put the headline into the Nth line of the window."
6316 ;;; Saving and restoring visibility
6319 "Return a list of the locations of all outline overlays.
6320 These are overlays with the `invisible' property value `outline'.
6321 The return value is a list of cons cells, with start and stop
6322 positions for each overlay.
6323 If USE-MARKERS is set, return the positions as markers."
6341 "Create visibility overlays for all positions in DATA.
6342 DATA should have been made by `org-outline-overlay-data'."
6351 data)))))
6353 ;;; Folding of blocks
6365 "Call FUNCTION at the head of all source blocks in the current buffer.
6366 Optional arguments START and END can be used to limit the range."
6378 "Toggle the visibility of all blocks in the current buffer."
6382 "Fold all blocks in the current buffer."
6388 "Unfold all blocks in the current buffer."
6394 "Toggle visibility of block at point."
6405 "Toggle the visibility of the current block."
6412 ov)
6428 ;; make the block accessible to isearch
6430 ov 'isearch-open-invisible
6441 ;; org-tab-after-check-for-cycling-hook
6443 ;; Remove overlays when changing major mode
6448 ;;; Org-goto
6454 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6470 nil)
6471 (org-defkey map "q" 'org-goto-quit)
6472 (org-defkey map "n" 'outline-next-visible-heading)
6473 (org-defkey map "p" 'outline-previous-visible-heading)
6474 (org-defkey map "f" 'outline-forward-same-level)
6475 (org-defkey map "b" 'outline-backward-same-level)
6476 (org-defkey map "u" 'outline-up-heading))
6477 (org-defkey map "/" 'org-occur)
6478 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6479 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6480 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6481 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6482 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6483 map))
6485 (defconst org-goto-help
6486 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6487 RET=jump to location [Q]uit and return to previous location
6488 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6490 (defvar org-goto-start-pos) ; dynamically scoped parameter
6492 ;; FIXME: Docstring does not mention both interfaces
6493 (defun org-goto (&optional alternative-interface)
6494 "Look up a different location in the current file, keeping current visibility.
6496 When you want look-up or go to a different location in a document, the
6497 fastest way is often to fold the entire buffer and then dive into the tree.
6498 This method has the disadvantage, that the previous location will be folded,
6499 which may not be what you want.
6501 This command works around this by showing a copy of the current buffer
6502 in an indirect buffer, in overview mode. You can dive into the tree in
6503 that copy, use org-occur and incremental search to find a location.
6504 When pressing RET or `Q', the command returns to the original buffer in
6505 which the visibility is still unchanged. After RET is will also jump to
6506 the location selected in the indirect buffer and expose the
6507 the headline hierarchy above."
6508 (interactive "P")
6509 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6510 (org-refile-use-outline-path t)
6511 (org-refile-target-verify-function nil)
6512 (interface
6513 (if (not alternative-interface)
6514 org-goto-interface
6515 (if (eq org-goto-interface 'outline)
6516 'outline-path-completion
6517 'outline)))
6518 (org-goto-start-pos (point))
6519 (selected-point
6520 (if (eq interface 'outline)
6521 (car (org-get-location (current-buffer) org-goto-help))
6522 (let ((pa (org-refile-get-location "Goto: ")))
6523 (org-refile-check-position pa)
6524 (nth 3 pa)))))
6525 (if selected-point
6526 (progn
6527 (org-mark-ring-push org-goto-start-pos)
6528 (goto-char selected-point)
6529 (if (or (outline-invisible-p) (org-invisible-p2))
6530 (org-show-context 'org-goto)))
6531 (message "Quit"))))
6533 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6534 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6535 (defvar org-goto-local-auto-isearch-map) ; defined below
6537 (defun org-get-location (buf help)
6538 "Let the user select a location in the Org-mode buffer BUF.
6539 This function uses a recursive edit. It returns the selected position
6540 or nil."
6541 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6542 (isearch-hide-immediately nil)
6543 (isearch-search-fun-function
6544 (lambda () 'org-goto-local-search-headings))
6545 (org-goto-selected-point org-goto-exit-command)
6546 (pop-up-frames nil)
6547 (special-display-buffer-names nil)
6548 (special-display-regexps nil)
6549 (special-display-function nil))
6550 (save-excursion
6551 (save-window-excursion
6552 (delete-other-windows)
6553 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6554 (switch-to-buffer
6555 (condition-case nil
6556 (make-indirect-buffer (current-buffer) "*org-goto*")
6557 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6558 (with-output-to-temp-buffer "*Help*"
6559 (princ help))
6560 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6561 (setq buffer-read-only nil)
6562 (let ((org-startup-truncated t)
6563 (org-startup-folded nil)
6564 (org-startup-align-all-tables nil))
6565 (org-mode)
6566 (org-overview))
6567 (setq buffer-read-only t)
6568 (if (and (boundp 'org-goto-start-pos)
6569 (integer-or-marker-p org-goto-start-pos))
6570 (let ((org-show-hierarchy-above t)
6571 (org-show-siblings t)
6572 (org-show-following-heading t))
6573 (goto-char org-goto-start-pos)
6574 (and (outline-invisible-p) (org-show-context)))
6575 (goto-char (point-min)))
6576 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6577 (message "Select location and press RET")
6578 (use-local-map org-goto-map)
6579 (recursive-edit)
6580 ))
6581 (kill-buffer "*org-goto*")
6582 (cons org-goto-selected-point org-goto-exit-command)))
6584 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6585 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6586 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6587 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6589 (defun org-goto-local-search-headings (string bound noerror)
6590 "Search and make sure that any matches are in headlines."
6591 (catch 'return
6592 (while (if isearch-forward
6593 (search-forward string bound noerror)
6594 (search-backward string bound noerror))
6595 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6596 (and (member :headline context)
6597 (not (member :tags context))))
6598 (throw 'return (point))))))
6600 (defun org-goto-local-auto-isearch ()
6601 "Start isearch."
6602 (interactive)
6603 (goto-char (point-min))
6604 (let ((keys (this-command-keys)))
6605 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6606 (isearch-mode t)
6607 (isearch-process-search-char (string-to-char keys)))))
6609 (defun org-goto-ret (&optional arg)
6610 "Finish `org-goto' by going to the new location."
6611 (interactive "P")
6612 (setq org-goto-selected-point (point)
6613 org-goto-exit-command 'return)
6614 (throw 'exit nil))
6616 (defun org-goto-left ()
6617 "Finish `org-goto' by going to the new location."
6618 (interactive)
6619 (if (org-on-heading-p)
6620 (progn
6621 (beginning-of-line 1)
6622 (setq org-goto-selected-point (point)
6623 org-goto-exit-command 'left)
6624 (throw 'exit nil))
6625 (error "Not on a heading")))
6627 (defun org-goto-right ()
6628 "Finish `org-goto' by going to the new location."
6629 (interactive)
6630 (if (org-on-heading-p)
6631 (progn
6632 (setq org-goto-selected-point (point)
6633 org-goto-exit-command 'right)
6634 (throw 'exit nil))
6635 (error "Not on a heading")))
6637 (defun org-goto-quit ()
6638 "Finish `org-goto' without cursor motion."
6639 (interactive)
6640 (setq org-goto-selected-point nil)
6641 (setq org-goto-exit-command 'quit)
6642 (throw 'exit nil))
6644 ;;; Indirect buffer display of subtrees
6646 (defvar org-indirect-dedicated-frame nil
6647 "This is the frame being used for indirect tree display.")
6648 (defvar org-last-indirect-buffer nil)
6650 (defun org-tree-to-indirect-buffer (&optional arg)
6651 "Create indirect buffer and narrow it to current subtree.
6652 With numerical prefix ARG, go up to this level and then take that tree.
6653 If ARG is negative, go up that many levels.
6654 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6655 indirect buffer previously made with this command, to avoid proliferation of
6656 indirect buffers. However, when you call the command with a \
6658 when `org-indirect-buffer-display' is `new-frame', the last buffer
6659 is kept so that you can work with several indirect buffers at the same time.
6660 If `org-indirect-buffer-display' is `dedicated-frame', the \
6662 requests that a new frame be made for the new buffer, so that the dedicated
6663 frame is not changed."
6664 (interactive "P")
6665 (let ((cbuf (current-buffer))
6666 (cwin (selected-window))
6667 (pos (point))
6668 beg end level heading ibuf)
6669 (save-excursion
6670 (org-back-to-heading t)
6671 (when (numberp arg)
6672 (setq level (org-outline-level))
6673 (if (< arg 0) (setq arg (+ level arg)))
6674 (while (> (setq level (org-outline-level)) arg)
6675 (outline-up-heading 1 t)))
6676 (setq beg (point)
6677 heading (org-get-heading))
6678 (org-end-of-subtree t t)
6679 (if (org-on-heading-p) (backward-char 1))
6680 (setq end (point)))
6681 (if (and (buffer-live-p org-last-indirect-buffer)
6682 (not (eq org-indirect-buffer-display 'new-frame))
6683 (not arg))
6684 (kill-buffer org-last-indirect-buffer))
6685 (setq ibuf (org-get-indirect-buffer cbuf)
6686 org-last-indirect-buffer ibuf)
6687 (cond
6688 ((or (eq org-indirect-buffer-display 'new-frame)
6689 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6690 (select-frame (make-frame))
6691 (delete-other-windows)
6692 (switch-to-buffer ibuf)
6693 (org-set-frame-title heading))
6694 ((eq org-indirect-buffer-display 'dedicated-frame)
6695 (raise-frame
6696 (select-frame (or (and org-indirect-dedicated-frame
6697 (frame-live-p org-indirect-dedicated-frame)
6698 org-indirect-dedicated-frame)
6699 (setq org-indirect-dedicated-frame (make-frame)))))
6700 (delete-other-windows)
6701 (switch-to-buffer ibuf)
6702 (org-set-frame-title (concat "Indirect: " heading)))
6703 ((eq org-indirect-buffer-display 'current-window)
6704 (switch-to-buffer ibuf))
6705 ((eq org-indirect-buffer-display 'other-window)
6706 (pop-to-buffer ibuf))
6707 (t (error "Invalid value")))
6708 (if (featurep 'xemacs)
6709 (save-excursion (org-mode) (turn-on-font-lock)))
6710 (narrow-to-region beg end)
6711 (show-all)
6712 (goto-char pos)
6713 (and (window-live-p cwin) (select-window cwin))))
6715 (defun org-get-indirect-buffer (&optional buffer)
6716 (setq buffer (or buffer (current-buffer)))
6717 (let ((n 1) (base (buffer-name buffer)) bname)
6718 (while (buffer-live-p
6719 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6720 (setq n (1+ n)))
6721 (condition-case nil
6722 (make-indirect-buffer buffer bname 'clone)
6723 (error (make-indirect-buffer buffer bname)))))
6725 (defun org-set-frame-title (title)
6726 "Set the title of the current frame to the string TITLE."
6727 ;; FIXME: how to name a single frame in XEmacs???
6728 (unless (featurep 'xemacs)
6729 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6731 ;;;; Structure editing
6733 ;;; Inserting headlines
6735 (defun org-previous-line-empty-p ()
6736 (save-excursion
6737 (and (not (bobp))
6738 (or (beginning-of-line 0) t)
6739 (save-match-data
6742 (defun org-insert-heading (&optional force-heading invisible-ok)
6743 "Insert a new heading or item with same depth at point.
6744 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6745 If point is at the beginning of a headline, insert a sibling before the
6746 current headline. If point is not at the beginning, split the line,
6747 create the new headline with the text in the current line after point
6748 \(but see also the variable `org-M-RET-may-split-line').
6750 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6751 This is important for non-interactive uses of the command."
6752 (interactive "P")
6753 (if (or (= (buffer-size) 0)
6754 (and (not (save-excursion
6755 (and (ignore-errors (org-back-to-heading invisible-ok))
6756 (org-on-heading-p))))
6757 (not (org-in-item-p))))
6758 (progn
6760 (run-hooks 'org-insert-heading-hook))
6761 (when (or force-heading (not (org-insert-item)))
6762 (let* ((empty-line-p nil)
6763 (level nil)
6764 (on-heading (org-on-heading-p))
6765 (head (save-excursion
6766 (condition-case nil
6767 (progn
6768 (org-back-to-heading invisible-ok)
6769 (when (and (not on-heading)
6770 (featurep 'org-inlinetask)
6771 (integerp org-inlinetask-min-level)
6772 (>= (length (match-string 0))
6773 org-inlinetask-min-level))
6774 ;; Find a heading level before the inline task
6775 (while (and (setq level (org-up-heading-safe))
6776 (>= level org-inlinetask-min-level)))
6777 (if (org-on-heading-p)
6778 (org-back-to-heading invisible-ok)
6779 (error "This should not happen")))
6780 (setq empty-line-p (org-previous-line-empty-p))
6781 (match-string 0))
6782 (error "*"))))
6783 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6784 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6785 pos hide-previous previous-pos)
6786 (cond
6787 ((and (org-on-heading-p) (bolp)
6788 (or (bobp)
6789 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
6790 ;; insert before the current line
6791 (open-line (if blank 2 1)))
6792 ((and (bolp)
6793 (not org-insert-heading-respect-content)
6794 (or (bobp)
6795 (save-excursion
6796 (backward-char 1) (not (outline-invisible-p)))))
6797 ;; insert right here
6798 nil)
6799 (t
6800 ;; somewhere in the line
6801 (save-excursion
6802 (setq previous-pos (point-at-bol))
6803 (end-of-line)
6804 (setq hide-previous (outline-invisible-p)))
6805 (and org-insert-heading-respect-content (org-show-subtree))
6806 (let ((split
6807 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6808 (save-excursion
6809 (let ((p (point)))
6810 (goto-char (point-at-bol))
6811 (and (looking-at org-complex-heading-regexp)
6812 (> p (match-beginning 4)))))))
6813 tags pos)
6814 (cond
6815 (org-insert-heading-respect-content
6816 (org-end-of-subtree nil t)
6817 (when (featurep 'org-inlinetask)
6818 (while (and (not (eobp))
6820 (>= (length (match-string 1))
6821 org-inlinetask-min-level))
6822 (org-end-of-subtree nil t)))
6823 (or (bolp) (newline))
6824 (or (org-previous-line-empty-p)
6825 (and blank (newline)))
6826 (open-line 1))
6827 ((org-on-heading-p)
6828 (when hide-previous
6829 (show-children)
6830 (org-show-entry))
6832 (setq tags (and (match-end 2) (match-string 2)))
6833 (and (match-end 1)
6834 (delete-region (match-beginning 1) (match-end 1)))
6835 (setq pos (point-at-bol))
6836 (or split (end-of-line 1))
6837 (delete-horizontal-space)
6839 (buffer-substring (point-at-bol) (point)))
6840 (insert " "))
6841 (newline (if blank 2 1))
6842 (when tags
6843 (save-excursion
6844 (goto-char pos)
6845 (end-of-line 1)
6846 (insert " " tags)
6847 (org-set-tags nil 'align))))
6848 (t
6849 (or split (end-of-line 1))
6850 (newline (if blank 2 1)))))))
6851 (insert head) (just-one-space)
6852 (setq pos (point))
6853 (end-of-line 1)
6854 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6855 (when (and org-insert-heading-respect-content hide-previous)
6856 (save-excursion
6857 (goto-char previous-pos)
6858 (hide-subtree)))
6859 (run-hooks 'org-insert-heading-hook)))))
6861 (defun org-get-heading (&optional no-tags)
6862 "Return the heading of the current entry, without the stars."
6863 (save-excursion
6864 (org-back-to-heading t)
6865 (if (looking-at
6866 (if no-tags
6869 (match-string 1) "")))
6871 (defun org-heading-components ()
6872 "Return the components of the current heading.
6873 This is a list with the following elements:
6874 - the level as an integer
6875 - the reduced level, different if `org-odd-levels-only' is set.
6876 - the TODO keyword, or nil
6877 - the priority character, like ?A, or nil if no priority is given
6878 - the headline text itself, or the tags string if no headline text
6879 - the tags string, or nil."
6880 (save-excursion
6881 (org-back-to-heading t)
6882 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6883 (list (length (match-string 1))
6884 (org-reduced-level (length (match-string 1)))
6885 (org-match-string-no-properties 2)
6886 (and (match-end 3) (aref (match-string 3) 2))
6887 (org-match-string-no-properties 4)
6888 (org-match-string-no-properties 5)))))
6890 (defun org-get-entry ()
6891 "Get the entry text, after heading, entire subtree."
6892 (save-excursion
6893 (org-back-to-heading t)
6894 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6896 (defun org-insert-heading-after-current ()
6897 "Insert a new heading with same level as current, after current subtree."
6898 (interactive)
6899 (org-back-to-heading)
6900 (org-insert-heading)
6901 (org-move-subtree-down)
6902 (end-of-line 1))
6904 (defun org-insert-heading-respect-content ()
6905 (interactive)
6906 (let ((org-insert-heading-respect-content t))
6907 (org-insert-heading t)))
6909 (defun org-insert-todo-heading-respect-content (&optional force-state)
6910 (interactive "P")
6911 (let ((org-insert-heading-respect-content t))
6912 (org-insert-todo-heading force-state t)))
6914 (defun org-insert-todo-heading (arg &optional force-heading)
6915 "Insert a new heading with the same level and TODO state as current heading.
6916 If the heading has no TODO state, or if the state is DONE, use the first
6917 state (TODO by default). Also with prefix arg, force first state."
6918 (interactive "P")
6919 (when (or force-heading (not (org-insert-item 'checkbox)))
6920 (org-insert-heading force-heading)
6921 (save-excursion
6922 (org-back-to-heading)
6923 (outline-previous-heading)
6924 (looking-at org-todo-line-regexp))
6925 (let*
6926 ((new-mark-x
6927 (if (or arg
6928 (not (match-beginning 2))
6929 (member (match-string 2) org-done-keywords))
6930 (car org-todo-keywords-1)
6931 (match-string 2)))
6932 (new-mark
6933 (or
6934 (run-hook-with-args-until-success
6935 'org-todo-get-default-hook new-mark-x nil)
6936 new-mark-x)))
6937 (beginning-of-line 1)
6939 (if org-treat-insert-todo-heading-as-state-change
6940 (org-todo new-mark)
6941 (insert new-mark " "))))
6942 (when org-provide-todo-statistics
6943 (org-update-parent-todo-statistics))))
6945 (defun org-insert-subheading (arg)
6946 "Insert a new subheading and demote it.
6947 Works for outline headings and for plain lists alike."
6948 (interactive "P")
6949 (org-insert-heading arg)
6950 (cond
6951 ((org-on-heading-p) (org-do-demote))
6952 ((org-at-item-p) (org-indent-item))))
6954 (defun org-insert-todo-subheading (arg)
6955 "Insert a new subheading with TODO keyword or checkbox and demote it.
6956 Works for outline headings and for plain lists alike."
6957 (interactive "P")
6958 (org-insert-todo-heading arg)
6959 (cond
6960 ((org-on-heading-p) (org-do-demote))
6961 ((org-at-item-p) (org-indent-item))))
6963 ;;; Promotion and Demotion
6965 (defvar org-after-demote-entry-hook nil
6966 "Hook run after an entry has been demoted.
6967 The cursor will be at the beginning of the entry.
6968 When a subtree is being demoted, the hook will be called for each node.")
6970 (defvar org-after-promote-entry-hook nil
6971 "Hook run after an entry has been promoted.
6972 The cursor will be at the beginning of the entry.
6973 When a subtree is being promoted, the hook will be called for each node.")
6975 (defun org-promote-subtree ()
6976 "Promote the entire subtree.
6977 See also `org-promote'."
6978 (interactive)
6979 (save-excursion
6980 (org-map-tree 'org-promote))
6981 (org-fix-position-after-promote))
6983 (defun org-demote-subtree ()
6984 "Demote the entire subtree. See `org-demote'.
6985 See also `org-promote'."
6986 (interactive)
6987 (save-excursion
6988 (org-map-tree 'org-demote))
6989 (org-fix-position-after-promote))
6992 (defun org-do-promote ()
6993 "Promote the current heading higher up the tree.
6994 If the region is active in `transient-mark-mode', promote all headings
6995 in the region."
6996 (interactive)
6997 (save-excursion
6998 (if (org-region-active-p)
6999 (org-map-region 'org-promote (region-beginning) (region-end))
7000 (org-promote)))
7001 (org-fix-position-after-promote))
7003 (defun org-do-demote ()
7004 "Demote the current heading lower down the tree.
7005 If the region is active in `transient-mark-mode', demote all headings
7006 in the region."
7007 (interactive)
7008 (save-excursion
7009 (if (org-region-active-p)
7010 (org-map-region 'org-demote (region-beginning) (region-end))
7011 (org-demote)))
7012 (org-fix-position-after-promote))
7014 (defun org-fix-position-after-promote ()
7015 "Make sure that after pro/demotion cursor position is right."
7016 (let ((pos (point)))
7017 (when (save-excursion
7018 (beginning-of-line 1)
7019 (looking-at org-todo-line-regexp)
7020 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7021 (cond ((eobp) (insert " "))
7022 ((eolp) (insert " "))
7023 ((equal (char-after) ?\ ) (forward-char 1))))))
7025 (defun org-current-level ()
7026 "Return the level of the current entry, or nil if before the first headline.
7027 The level is the number of stars at the beginning of the headline."
7028 (save-excursion
7029 (org-with-limited-levels
7030 (ignore-errors
7031 (org-back-to-heading t)
7032 (funcall outline-level)))))
7034 (defun org-get-previous-line-level ()
7035 "Return the outline depth of the last headline before the current line.
7036 Returns 0 for the first headline in the buffer, and nil if before the
7037 first headline."
7038 (let ((current-level (org-current-level))
7039 (prev-level (when (> (line-number-at-pos) 1)
7040 (save-excursion
7041 (beginning-of-line 0)
7042 (org-current-level)))))
7043 (cond ((null current-level) nil) ; Before first headline
7044 ((null prev-level) 0) ; At first headline
7045 (prev-level))))
7047 (defun org-reduced-level (l)
7048 "Compute the effective level of a heading.
7049 This takes into account the setting of `org-odd-levels-only'."
7050 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
7052 (defun org-level-increment ()
7053 "Return the number of stars that will be added or removed at a
7054 time to headlines when structure editing, based on the value of
7055 `org-odd-levels-only'."
7056 (if org-odd-levels-only 2 1))
7058 (defun org-get-valid-level (level &optional change)
7059 "Rectify a level change under the influence of `org-odd-levels-only'
7060 LEVEL is a current level, CHANGE is by how much the level should be
7061 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7062 even level numbers will become the next higher odd number."
7063 (if org-odd-levels-only
7064 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7065 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7066 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7067 (max 1 (+ level (or change 0)))))
7069 (if (boundp 'define-obsolete-function-alias)
7070 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7071 (define-obsolete-function-alias 'org-get-legal-level
7072 'org-get-valid-level)
7073 (define-obsolete-function-alias 'org-get-legal-level
7074 'org-get-valid-level "23.1")))
7076 (defun org-promote ()
7077 "Promote the current heading higher up the tree.
7078 If the region is active in `transient-mark-mode', promote all headings
7079 in the region."
7080 (org-back-to-heading t)
7081 (let* ((level (save-match-data (funcall outline-level)))
7082 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7083 (diff (abs (- level (length up-head) -1))))
7084 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7085 (replace-match up-head nil t)
7086 ;; Fixup tag positioning
7087 (and org-auto-align-tags (org-set-tags nil t))
7088 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7089 (run-hooks 'org-after-promote-entry-hook)))
7091 (defun org-demote ()
7092 "Demote the current heading lower down the tree.
7093 If the region is active in `transient-mark-mode', demote all headings
7094 in the region."
7095 (org-back-to-heading t)
7096 (let* ((level (save-match-data (funcall outline-level)))
7097 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7098 (diff (abs (- level (length down-head) -1))))
7099 (replace-match down-head nil t)
7100 ;; Fixup tag positioning
7101 (and org-auto-align-tags (org-set-tags nil t))
7102 (if org-adapt-indentation (org-fixup-indentation diff))
7103 (run-hooks 'org-after-demote-entry-hook)))
7105 (defun org-cycle-level ()
7106 "Cycle the level of an empty headline through possible states.
7107 This goes first to child, then to parent, level, then up the hierarchy.
7108 After top level, it switches back to sibling level."
7109 (interactive)
7110 (let ((org-adapt-indentation nil))
7111 (when (org-point-at-end-of-empty-headline)
7112 (setq this-command 'org-cycle-level) ; Only needed for caching
7113 (let ((cur-level (org-current-level))
7114 (prev-level (org-get-previous-line-level)))
7115 (cond
7116 ;; If first headline in file, promote to top-level.
7117 ((= prev-level 0)
7118 (loop repeat (/ (- cur-level 1) (org-level-increment))
7119 do (org-do-promote)))
7120 ;; If same level as prev, demote one.
7121 ((= prev-level cur-level)
7122 (org-do-demote))
7123 ;; If parent is top-level, promote to top level if not already.
7124 ((= prev-level 1)
7125 (loop repeat (/ (- cur-level 1) (org-level-increment))
7126 do (org-do-promote)))
7127 ;; If top-level, return to prev-level.
7128 ((= cur-level 1)
7129 (loop repeat (/ (- prev-level 1) (org-level-increment))
7130 do (org-do-demote)))
7131 ;; If less than prev-level, promote one.
7132 ((< cur-level prev-level)
7133 (org-do-promote))
7134 ;; If deeper than prev-level, promote until higher than
7135 ;; prev-level.
7136 ((> cur-level prev-level)
7137 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7138 do (org-do-promote))))
7139 t))))
7141 (defun org-map-tree (fun)
7142 "Call FUN for every heading underneath the current one."
7143 (org-back-to-heading)
7144 (let ((level (funcall outline-level)))
7145 (save-excursion
7146 (funcall fun)
7147 (while (and (progn
7148 (outline-next-heading)
7149 (> (funcall outline-level) level))
7150 (not (eobp)))
7151 (funcall fun)))))
7153 (defun org-map-region (fun beg end)
7154 "Call FUN for every heading between BEG and END."
7155 (let ((org-ignore-region t))
7156 (save-excursion
7157 (setq end (copy-marker end))
7158 (goto-char beg)
7159 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
7160 (< (point) end))
7161 (funcall fun))
7162 (while (and (progn
7163 (outline-next-heading)
7164 (< (point) end))
7165 (not (eobp)))
7166 (funcall fun)))))
7168 (defun org-fixup-indentation (diff)
7169 "Change the indentation in the current entry by DIFF.
7170 However, if any line in the current entry has no indentation, or if it
7171 would end up with no indentation after the change, nothing at all is done."
7172 (save-excursion
7173 (let ((end (save-excursion (outline-next-heading)
7174 (point-marker)))
7175 (prohibit (if (> diff 0)
7178 col)
7179 (unless (save-excursion (end-of-line 1)
7180 (re-search-forward prohibit end t))
7181 (while (and (< (point) end)
7183 (goto-char (match-end 0))
7184 (setq col (current-column))
7185 (if (< diff 0) (replace-match ""))
7186 (org-indent-to-column (+ diff col))))
7187 (move-marker end nil))))
7189 (defun org-convert-to-odd-levels ()
7190 "Convert an org-mode file with all levels allowed to one with odd levels.
7191 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7192 level 5 etc."
7193 (interactive)
7194 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7195 (let ((outline-regexp org-outline-regexp)
7196 (outline-level 'org-outline-level)
7197 (org-odd-levels-only nil) n)
7198 (save-excursion
7199 (goto-char (point-min))
7201 (setq n (- (length (match-string 0)) 2))
7202 (while (>= (setq n (1- n)) 0)
7203 (org-demote))
7204 (end-of-line 1))))))
7206 (defun org-convert-to-oddeven-levels ()
7207 "Convert an org-mode file with only odd levels to one with odd/even levels.
7208 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7209 file contains a section with an even level, conversion would
7210 destroy the structure of the file. An error is signaled in this
7211 case."
7212 (interactive)
7213 (goto-char (point-min))
7214 ;; First check if there are no even levels
7216 (org-show-context t)
7217 (error "Not all levels are odd in this file. Conversion not possible"))
7218 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7219 (let ((outline-regexp org-outline-regexp)
7220 (outline-level 'org-outline-level)
7221 (org-odd-levels-only nil) n)
7222 (save-excursion
7223 (goto-char (point-min))
7225 (setq n (/ (1- (length (match-string 0))) 2))
7226 (while (>= (setq n (1- n)) 0)
7227 (org-promote))
7228 (end-of-line 1))))))
7230 (defun org-tr-level (n)
7231 "Make N odd if required."
7232 (if org-odd-levels-only (1+ (/ n 2)) n))
7234 ;;; Vertical tree motion, cutting and pasting of subtrees
7236 (defun org-move-subtree-up (&optional arg)
7237 "Move the current subtree up past ARG headlines of the same level."
7238 (interactive "p")
7239 (org-move-subtree-down (- (prefix-numeric-value arg))))
7241 (defun org-move-subtree-down (&optional arg)
7242 "Move the current subtree down past ARG headlines of the same level."
7243 (interactive "p")
7244 (setq arg (prefix-numeric-value arg))
7245 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7246 'org-get-last-sibling))
7247 (ins-point (make-marker))
7248 (cnt (abs arg))
7249 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7250 ;; Select the tree
7251 (org-back-to-heading)
7252 (setq beg0 (point))
7253 (save-excursion
7254 (setq ne-beg (org-back-over-empty-lines))
7255 (setq beg (point)))
7256 (save-match-data
7257 (save-excursion (outline-end-of-heading)
7258 (setq folded (outline-invisible-p)))
7259 (outline-end-of-subtree))
7260 (outline-next-heading)
7261 (setq ne-end (org-back-over-empty-lines))
7262 (setq end (point))
7263 (goto-char beg0)
7264 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7265 ;; include less whitespace
7266 (save-excursion
7267 (goto-char beg)
7268 (forward-line (- ne-beg ne-end))
7269 (setq beg (point))))
7270 ;; Find insertion point, with error handling
7271 (while (> cnt 0)
7272 (or (and (funcall movfunc) (looking-at outline-regexp))
7273 (progn (goto-char beg0)
7274 (error "Cannot move past superior level or buffer limit")))
7275 (setq cnt (1- cnt)))
7276 (if (> arg 0)
7277 ;; Moving forward - still need to move over subtree
7278 (progn (org-end-of-subtree t t)
7279 (save-excursion
7280 (org-back-over-empty-lines)
7281 (or (bolp) (newline)))))
7282 (setq ne-ins (org-back-over-empty-lines))
7283 (move-marker ins-point (point))
7284 (setq txt (buffer-substring beg end))
7285 (org-save-markers-in-region beg end)
7286 (delete-region beg end)
7287 (org-remove-empty-overlays-at beg)
7288 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7289 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7291 (let ((bbb (point)))
7292 (insert-before-markers txt)
7293 (org-reinstall-markers-in-region bbb)
7294 (move-marker ins-point bbb))
7296 (setq ins-end (point))
7297 (goto-char ins-point)
7298 (org-skip-whitespace)
7299 (when (and (< arg 0)
7300 (org-first-sibling-p)
7301 (> ne-ins ne-beg))
7302 ;; Move whitespace back to beginning
7303 (save-excursion
7304 (goto-char ins-end)
7305 (let ((kill-whole-line t))
7306 (kill-line (- ne-ins ne-beg)) (point)))
7308 (move-marker ins-point nil)
7309 (if folded
7310 (hide-subtree)
7311 (org-show-entry)
7312 (show-children)
7313 (org-cycle-hide-drawers 'children))
7314 (org-clean-visibility-after-subtree-move)))
7316 (defvar org-subtree-clip ""
7317 "Clipboard for cut and paste of subtrees.
7318 This is actually only a copy of the kill, because we use the normal kill
7319 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7321 (defvar org-subtree-clip-folded nil
7322 "Was the last copied subtree folded?
7323 This is used to fold the tree back after pasting.")
7325 (defun org-cut-subtree (&optional n)
7326 "Cut the current subtree into the clipboard.
7327 With prefix arg N, cut this many sequential subtrees.
7328 This is a short-hand for marking the subtree and then cutting it."
7329 (interactive "p")
7330 (org-copy-subtree n 'cut))
7332 (defun org-copy-subtree (&optional n cut force-store-markers)
7333 "Cut the current subtree into the clipboard.
7334 With prefix arg N, cut this many sequential subtrees.
7335 This is a short-hand for marking the subtree and then copying it.
7336 If CUT is non-nil, actually cut the subtree.
7337 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7338 of some markers in the region, even if CUT is non-nil. This is
7339 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7340 (interactive "p")
7341 (let (beg end folded (beg0 (point)))
7342 (if (interactive-p)
7343 (org-back-to-heading nil) ; take what looks like a subtree
7344 (org-back-to-heading t)) ; take what is really there
7345 (org-back-over-empty-lines)
7346 (setq beg (point))
7348 (save-match-data
7349 (save-excursion (outline-end-of-heading)
7350 (setq folded (outline-invisible-p)))
7351 (condition-case nil
7352 (org-forward-same-level (1- n) t)
7353 (error nil))
7354 (org-end-of-subtree t t))
7355 (org-back-over-empty-lines)
7356 (setq end (point))
7357 (goto-char beg0)
7358 (when (> end beg)
7359 (setq org-subtree-clip-folded folded)
7360 (when (or cut force-store-markers)
7361 (org-save-markers-in-region beg end))
7362 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7363 (setq org-subtree-clip (current-kill 0))
7364 (message "%s: Subtree(s) with %d characters"
7365 (if cut "Cut" "Copied")
7366 (length org-subtree-clip)))))
7368 (defun org-paste-subtree (&optional level tree for-yank)
7369 "Paste the clipboard as a subtree, with modification of headline level.
7370 The entire subtree is promoted or demoted in order to match a new headline
7371 level.
7373 If the cursor is at the beginning of a headline, the same level as
7374 that headline is used to paste the tree
7376 If not, the new level is derived from the *visible* headings
7377 before and after the insertion point, and taken to be the inferior headline
7378 level of the two. So if the previous visible heading is level 3 and the
7379 next is level 4 (or vice versa), level 4 will be used for insertion.
7380 This makes sure that the subtree remains an independent subtree and does
7381 not swallow low level entries.
7383 You can also force a different level, either by using a numeric prefix
7384 argument, or by inserting the heading marker by hand. For example, if the
7387 If optional TREE is given, use this text instead of the kill ring.
7389 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7390 move back over whitespace before inserting, and move point to the end of
7391 the inserted text when done."
7392 (interactive "P")
7393 (setq tree (or tree (and kill-ring (current-kill 0))))
7394 (unless (org-kill-is-subtree-p tree)
7395 (error "%s"
7396 (substitute-command-keys
7398 (let* ((visp (not (outline-invisible-p)))
7399 (txt tree)
7404 (old-level (if (string-match ^re txt)
7405 (- (match-end 0) (match-beginning 0) 1)
7406 -1))
7407 (force-level (cond (level (prefix-numeric-value level))
7409 (string-match
7410 ^re_ (buffer-substring
7411 (point-at-bol) (point))))
7412 (- (match-end 1) (match-beginning 1)))
7413 ((and (bolp)
7414 (looking-at org-outline-regexp))
7415 (- (match-end 0) (point) 1))
7416 (t nil)))
7417 (previous-level (save-excursion
7418 (condition-case nil
7419 (progn
7420 (outline-previous-visible-heading 1)
7421 (if (looking-at re)
7422 (- (match-end 0) (match-beginning 0) 1)
7423 1))
7424 (error 1))))
7425 (next-level (save-excursion
7426 (condition-case nil
7427 (progn
7428 (or (looking-at outline-regexp)
7429 (outline-next-visible-heading 1))
7430 (if (looking-at re)
7431 (- (match-end 0) (match-beginning 0) 1)
7432 1))
7433 (error 1))))
7434 (new-level (or force-level (max previous-level next-level)))
7435 (shift (if (or (= old-level -1)
7436 (= new-level -1)
7437 (= old-level new-level))
7438 0
7439 (- new-level old-level)))
7440 (delta (if (> shift 0) -1 1))
7441 (func (if (> shift 0) 'org-demote 'org-promote))
7442 (org-odd-levels-only nil)
7443 beg end newend)
7444 ;; Remove the forced level indicator
7445 (if force-level
7446 (delete-region (point-at-bol) (point)))
7447 ;; Paste
7448 (beginning-of-line 1)
7449 (unless for-yank (org-back-over-empty-lines))
7450 (setq beg (point))
7451 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7452 (insert-before-markers txt)
7454 (setq newend (point))
7455 (org-reinstall-markers-in-region beg)
7456 (setq end (point))
7457 (goto-char beg)
7459 (setq beg (point))
7460 (if (and (outline-invisible-p) visp)
7461 (save-excursion (outline-show-heading)))
7462 ;; Shift if necessary
7463 (unless (= shift 0)
7464 (save-restriction
7465 (narrow-to-region beg end)
7466 (while (not (= shift 0))
7467 (org-map-region func (point-min) (point-max))
7468 (setq shift (+ delta shift)))
7469 (goto-char (point-min))
7470 (setq newend (point-max))))
7471 (when (or (interactive-p) for-yank)
7472 (message "Clipboard pasted as level %d subtree" new-level))
7473 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7474 kill-ring
7475 (eq org-subtree-clip (current-kill 0))
7476 org-subtree-clip-folded)
7477 ;; The tree was folded before it was killed/copied
7478 (hide-subtree))
7479 (and for-yank (goto-char newend))))
7481 (defun org-kill-is-subtree-p (&optional txt)
7482 "Check if the current kill is an outline subtree, or a set of trees.
7483 Returns nil if kill does not start with a headline, or if the first
7484 headline level is not the largest headline level in the tree.
7485 So this will actually accept several entries of equal levels as well,
7486 which is OK for `org-paste-subtree'.
7487 If optional TXT is given, check this string instead of the current kill."
7488 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7489 (start-level (and kill
7492 kill)
7493 (- (match-end 2) (match-beginning 2) 1)))
7494 (re (concat "^" org-outline-regexp))
7495 (start (1+ (or (match-beginning 2) -1))))
7496 (if (not start-level)
7497 (progn
7498 nil) ;; does not even start with a heading
7499 (catch 'exit
7500 (while (setq start (string-match re kill (1+ start)))
7501 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7502 (throw 'exit nil)))
7503 t))))
7505 (defvar org-markers-to-move nil
7506 "Markers that should be moved with a cut-and-paste operation.
7507 Those markers are stored together with their positions relative to
7508 the start of the region.")
7510 (defun org-save-markers-in-region (beg end)
7511 "Check markers in region.
7512 If these markers are between BEG and END, record their position relative
7513 to BEG, so that after moving the block of text, we can put the markers back
7514 into place.
7515 This function gets called just before an entry or tree gets cut from the
7516 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7517 called immediately, to move the markers with the entries."
7518 (setq org-markers-to-move nil)
7519 (when (featurep 'org-clock)
7520 (org-clock-save-markers-for-cut-and-paste beg end))
7521 (when (featurep 'org-agenda)
7522 (org-agenda-save-markers-for-cut-and-paste beg end)))
7524 (defun org-check-and-save-marker (marker beg end)
7525 "Check if MARKER is between BEG and END.
7526 If yes, remember the marker and the distance to BEG."
7527 (when (and (marker-buffer marker)
7528 (equal (marker-buffer marker) (current-buffer)))
7529 (if (and (>= marker beg) (< marker end))
7530 (push (cons marker (- marker beg)) org-markers-to-move))))
7532 (defun org-reinstall-markers-in-region (beg)
7533 "Move all remembered markers to their position relative to BEG."
7534 (mapc (lambda (x)
7535 (move-marker (car x) (+ beg (cdr x))))
7536 org-markers-to-move)
7537 (setq org-markers-to-move nil))
7539 (defun org-narrow-to-subtree ()
7540 "Narrow buffer to the current subtree."
7541 (interactive)
7542 (save-excursion
7543 (save-match-data
7544 (narrow-to-region
7545 (progn (org-back-to-heading t) (point))
7546 (progn (org-end-of-subtree t t)
7547 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7548 (point))))))
7550 (eval-when-compile
7551 (defvar org-property-drawer-re))
7553 (defvar org-property-start-re) ;; defined below
7554 (defun org-clone-subtree-with-time-shift (n &optional shift)
7555 "Clone the task (subtree) at point N times.
7556 The clones will be inserted as siblings.
7558 In interactive use, the user will be prompted for the number of
7559 clones to be produced, and for a time SHIFT, which may be a
7560 repeater as used in time stamps, for example `+3d'.
7562 When a valid repeater is given and the entry contains any time
7563 stamps, the clones will become a sequence in time, with time
7564 stamps in the subtree shifted for each clone produced. If SHIFT
7565 is nil or the empty string, time stamps will be left alone. The
7566 ID property of the original subtree is removed.
7568 If the original subtree did contain time stamps with a repeater,
7569 the following will happen:
7570 - the repeater will be removed in each clone
7571 - an additional clone will be produced, with the current, unshifted
7572 date(s) in the entry.
7573 - the original entry will be placed *after* all the clones, with
7574 repeater intact.
7575 - the start days in the repeater in the original entry will be shifted
7576 to past the last clone.
7577 I this way you can spell out a number of instances of a repeating task,
7578 and still retain the repeater to cover future instances of the task."
7579 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7580 (let (beg end template task idprop
7581 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7582 (if (not (and (integerp n) (> n 0)))
7583 (error "Invalid number of replications %s" n))
7586 shift)))
7587 (error "Invalid shift specification %s" shift))
7588 (when doshift
7589 (setq shift-n (string-to-number (match-string 1 shift))
7590 shift-what (cdr (assoc (match-string 2 shift)
7591 '(("d" . day) ("w" . week)
7592 ("m" . month) ("y" . year))))))
7593 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7594 (setq nmin 1 nmax n)
7595 (org-back-to-heading t)
7596 (setq beg (point))
7597 (setq idprop (org-entry-get nil "ID"))
7598 (org-end-of-subtree t t)
7600 (setq end (point))
7601 (setq template (buffer-substring beg end))
7602 (when (and doshift
7604 (delete-region beg end)
7605 (setq end beg)
7606 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7607 (goto-char end)
7608 (loop for n from nmin to nmax do
7609 ;; prepare clone
7610 (with-temp-buffer
7611 (insert template)
7612 (org-mode)
7613 (goto-char (point-min))
7614 (and idprop (if org-clone-delete-id
7615 (org-entry-delete nil "ID")
7616 (org-id-get-create t)))
7617 (while (re-search-forward org-property-start-re nil t)
7618 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7619 (goto-char (point-min))
7620 (when doshift
7621 (while (re-search-forward org-ts-regexp-both nil t)
7622 (org-timestamp-change (* n shift-n) shift-what))
7623 (unless (= n n-no-remove)
7624 (goto-char (point-min))
7625 (while (re-search-forward org-ts-regexp nil t)
7626 (save-excursion
7627 (goto-char (match-beginning 0))
7629 (delete-region (match-beginning 1) (match-end 1)))))))
7630 (setq task (buffer-string)))
7631 (insert task))
7632 (goto-char beg)))
7634 ;;; Outline Sorting
7636 (defun org-sort (with-case)
7637 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7638 Optional argument WITH-CASE means sort case-sensitively.
7639 With a double prefix argument, also remove duplicate entries."
7640 (interactive "P")
7641 (cond
7642 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7643 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7644 (t
7645 (org-call-with-arg 'org-sort-entries with-case))))
7647 (defun org-sort-remove-invisible (s)
7648 (remove-text-properties 0 (length s) org-rm-props s)
7649 (while (string-match org-bracket-link-regexp s)
7650 (setq s (replace-match (if (match-end 2)
7651 (match-string 3 s)
7652 (match-string 1 s)) t t s)))
7653 s)
7655 (defvar org-priority-regexp) ; defined later in the file
7657 (defvar org-after-sorting-entries-or-items-hook nil
7658 "Hook that is run after a bunch of entries or items have been sorted.
7659 When children are sorted, the cursor is in the parent line when this
7660 hook gets called. When a region or a plain list is sorted, the cursor
7661 will be in the first entry of the sorted region/list.")
7663 (defun org-sort-entries
7664 (&optional with-case sorting-type getkey-func compare-func property)
7665 "Sort entries on a certain level of an outline tree.
7666 If there is an active region, the entries in the region are sorted.
7667 Else, if the cursor is before the first entry, sort the top-level items.
7668 Else, the children of the entry at point are sorted.
7670 Sorting can be alphabetically, numerically, by date/time as given by
7671 a time stamp, by a property or by priority.
7673 The command prompts for the sorting type unless it has been given to the
7674 function through the SORTING-TYPE argument, which needs to be a character,
7675 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7676 precise meaning of each character:
7678 n Numerically, by converting the beginning of the entry/item to a number.
7679 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7680 t By date/time, either the first active time stamp in the entry, or, if
7681 none exist, by the first inactive one.
7682 s By the scheduled date/time.
7683 d By deadline date/time.
7684 c By creation time, which is assumed to be the first inactive time stamp
7685 at the beginning of a line.
7686 p By priority according to the cookie.
7687 r By the value of a property.
7689 Capital letters will reverse the sort order.
7691 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7692 called with point at the beginning of the record. It must return either
7693 a string or a number that should serve as the sorting key for that record.
7695 Comparing entries ignores case by default. However, with an optional argument
7696 WITH-CASE, the sorting considers case as well."
7697 (interactive "P")
7698 (let ((case-func (if with-case 'identity 'downcase))
7699 start beg end stars re re2
7700 txt what tmp)
7701 ;; Find beginning and end of region to sort
7702 (cond
7703 ((org-region-active-p)
7704 ;; we will sort the region
7705 (setq end (region-end)
7706 what "region")
7707 (goto-char (region-beginning))
7708 (if (not (org-on-heading-p)) (outline-next-heading))
7709 (setq start (point)))
7710 ((or (org-on-heading-p)
7711 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7712 ;; we will sort the children of the current headline
7713 (org-back-to-heading)
7714 (setq start (point)
7715 end (progn (org-end-of-subtree t t)
7717 (org-back-over-empty-lines)
7718 (point))
7719 what "children")
7720 (goto-char start)
7721 (show-subtree)
7722 (outline-next-heading))
7723 (t
7724 ;; we will sort the top-level entries in this file
7725 (goto-char (point-min))
7726 (or (org-on-heading-p) (outline-next-heading))
7727 (setq start (point))
7728 (goto-char (point-max))
7729 (beginning-of-line 1)
7731 ;; File ends in a non-white line
7732 (end-of-line 1)
7734 (setq end (point-max))
7735 (setq what "top-level")
7736 (goto-char start)
7737 (show-all)))
7739 (setq beg (point))
7740 (if (>= beg end) (error "Nothing to sort"))
7743 (setq stars (match-string 1)
7744 re (concat "^" (regexp-quote stars) " +")
7746 txt (buffer-substring beg end))
7748 (if (and (not (equal stars "*")) (string-match re2 txt))
7749 (error "Region to sort contains a level above the first entry"))
7751 (unless sorting-type
7752 (message
7753 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7755 A/N/T/S/D/C/P/O/F means reversed:"
7756 what)
7757 (setq sorting-type (read-char-exclusive))
7759 (and (= (downcase sorting-type) ?f)
7760 (setq getkey-func
7761 (org-icompleting-read "Sort using function: "
7762 obarray 'fboundp t nil nil))
7763 (setq getkey-func (intern getkey-func)))
7765 (and (= (downcase sorting-type) ?r)
7766 (setq property
7767 (org-icompleting-read "Property: "
7768 (mapcar 'list (org-buffer-property-keys t))
7769 nil t))))
7771 (message "Sorting entries...")
7773 (save-restriction
7774 (narrow-to-region start end)
7775 (let ((dcst (downcase sorting-type))
7776 (case-fold-search nil)
7777 (now (current-time)))
7778 (sort-subr
7779 (/= dcst sorting-type)
7780 ;; This function moves to the beginning character of the "record" to
7781 ;; be sorted.
7782 (lambda nil
7783 (if (re-search-forward re nil t)
7784 (goto-char (match-beginning 0))
7785 (goto-char (point-max))))
7786 ;; This function moves to the last character of the "record" being
7787 ;; sorted.
7788 (lambda nil
7789 (save-match-data
7790 (condition-case nil
7791 (outline-forward-same-level 1)
7792 (error
7793 (goto-char (point-max))))))
7794 ;; This function returns the value that gets sorted against.
7795 (lambda nil
7796 (cond
7797 ((= dcst ?n)
7798 (if (looking-at org-complex-heading-regexp)
7799 (string-to-number (match-string 4))
7800 nil))
7801 ((= dcst ?a)
7802 (if (looking-at org-complex-heading-regexp)
7803 (funcall case-func (match-string 4))
7804 nil))
7805 ((= dcst ?t)
7806 (let ((end (save-excursion (outline-next-heading) (point))))
7807 (if (or (re-search-forward org-ts-regexp end t)
7808 (re-search-forward org-ts-regexp-both end t))
7809 (org-time-string-to-seconds (match-string 0))
7810 (org-float-time now))))
7811 ((= dcst ?c)
7812 (let ((end (save-excursion (outline-next-heading) (point))))
7813 (if (re-search-forward
7815 end t)
7816 (org-time-string-to-seconds (match-string 0))
7817 (org-float-time now))))
7818 ((= dcst ?s)
7819 (let ((end (save-excursion (outline-next-heading) (point))))
7820 (if (re-search-forward org-scheduled-time-regexp end t)
7821 (org-time-string-to-seconds (match-string 1))
7822 (org-float-time now))))
7823 ((= dcst ?d)
7824 (let ((end (save-excursion (outline-next-heading) (point))))
7825 (if (re-search-forward org-deadline-time-regexp end t)
7826 (org-time-string-to-seconds (match-string 1))
7827 (org-float-time now))))
7828 ((= dcst ?p)
7829 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7830 (string-to-char (match-string 2))
7831 org-default-priority))
7832 ((= dcst ?r)
7833 (or (org-entry-get nil property) ""))
7834 ((= dcst ?o)
7835 (if (looking-at org-complex-heading-regexp)
7836 (- 9999 (length (member (match-string 2)
7837 org-todo-keywords-1)))))
7838 ((= dcst ?f)
7839 (if getkey-func
7840 (progn
7841 (setq tmp (funcall getkey-func))
7842 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7843 tmp)
7844 (error "Invalid key function `%s'" getkey-func)))
7845 (t (error "Invalid sorting type `%c'" sorting-type))))
7846 nil
7847 (cond
7848 ((= dcst ?a) 'string<)
7849 ((= dcst ?f) compare-func)
7850 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7851 (t nil)))))
7852 (run-hooks 'org-after-sorting-entries-or-items-hook)
7853 (message "Sorting entries...done")))
7855 (defun org-do-sort (table what &optional with-case sorting-type)
7856 "Sort TABLE of WHAT according to SORTING-TYPE.
7857 The user will be prompted for the SORTING-TYPE if the call to this
7858 function does not specify it. WHAT is only for the prompt, to indicate
7859 what is being sorted. The sorting key will be extracted from
7860 the car of the elements of the table.
7861 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7862 (unless sorting-type
7863 (message
7864 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7865 what)
7866 (setq sorting-type (read-char-exclusive)))
7867 (let ((dcst (downcase sorting-type))
7868 extractfun comparefun)
7869 ;; Define the appropriate functions
7870 (cond
7871 ((= dcst ?n)
7872 (setq extractfun 'string-to-number
7873 comparefun (if (= dcst sorting-type) '< '>)))
7874 ((= dcst ?a)
7875 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7876 (lambda(x) (downcase (org-sort-remove-invisible x))))
7877 comparefun (if (= dcst sorting-type)
7878 'string<
7879 (lambda (a b) (and (not (string< a b))
7880 (not (string= a b)))))))
7881 ((= dcst ?t)
7882 (setq extractfun
7883 (lambda (x)
7884 (if (or (string-match org-ts-regexp x)
7885 (string-match org-ts-regexp-both x))
7886 (org-float-time
7887 (org-time-string-to-time (match-string 0 x)))
7888 0))
7889 comparefun (if (= dcst sorting-type) '< '>)))
7890 (t (error "Invalid sorting type `%c'" sorting-type)))
7892 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7893 table)
7894 (lambda (a b) (funcall comparefun (car a) (car b))))))
7897 ;;; The orgstruct minor mode
7899 ;; Define a minor mode which can be used in other modes in order to
7900 ;; integrate the org-mode structure editing commands.
7902 ;; This is really a hack, because the org-mode structure commands use
7903 ;; keys which normally belong to the major mode. Here is how it
7904 ;; works: The minor mode defines all the keys necessary to operate the
7905 ;; structure commands, but wraps the commands into a function which
7906 ;; tests if the cursor is currently at a headline or a plain list
7907 ;; item. If that is the case, the structure command is used,
7908 ;; temporarily setting many Org-mode variables like regular
7909 ;; expressions for filling etc. However, when any of those keys is
7910 ;; used at a different location, function uses `key-binding' to look
7911 ;; up if the key has an associated command in another currently active
7912 ;; keymap (minor modes, major mode, global), and executes that
7913 ;; command. There might be problems if any of the keys is otherwise
7914 ;; used as a prefix key.
7916 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7917 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7918 ;; addresses this by checking explicitly for both bindings.
7920 (defvar orgstruct-mode-map (make-sparse-keymap)
7921 "Keymap for the minor `orgstruct-mode'.")
7923 (defvar org-local-vars nil
7924 "List of local variables, for use by `orgstruct-mode'.")
7926 ;;;###autoload
7927 (define-minor-mode orgstruct-mode
7928 "Toggle the minor mode `orgstruct-mode'.
7929 This mode is for using Org-mode structure commands in other
7930 modes. The following keys behave as if Org-mode were active, if
7931 the cursor is on a headline, or on a plain list item (both as
7932 defined by Org-mode).
7934 M-up Move entry/item up
7935 M-down Move entry/item down
7936 M-left Promote
7937 M-right Demote
7938 M-S-up Move entry/item up
7939 M-S-down Move entry/item down
7940 M-S-left Promote subtree
7941 M-S-right Demote subtree
7942 M-q Fill paragraph and items like in Org-mode
7943 C-c ^ Sort entries
7944 C-c - Cycle list bullet
7945 TAB Cycle item visibility
7946 M-RET Insert new heading/item
7947 S-M-RET Insert new TODO heading / Checkbox item
7948 C-c C-c Set tags / toggle checkbox"
7949 nil " OrgStruct" nil
7950 (org-load-modules-maybe)
7951 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7953 ;;;###autoload
7954 (defun turn-on-orgstruct ()
7955 "Unconditionally turn on `orgstruct-mode'."
7956 (orgstruct-mode 1))
7958 (defun orgstruct++-mode (&optional arg)
7959 "Toggle `orgstruct-mode', the enhanced version of it.
7960 In addition to setting orgstruct-mode, this also exports all indentation
7961 and autofilling variables from org-mode into the buffer. It will also
7962 recognize item context in multiline items.
7963 Note that turning off orgstruct-mode will *not* remove the
7964 indentation/paragraph settings. This can only be done by refreshing the
7966 (interactive "P")
7967 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
7968 (if (< arg 1)
7969 (orgstruct-mode -1)
7970 (orgstruct-mode 1)
7971 (let (var val)
7972 (mapc
7973 (lambda (x)
7974 (when (string-match
7976 (symbol-name (car x)))
7977 (setq var (car x) val (nth 1 x))
7978 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7979 org-local-vars)
7980 (org-set-local 'orgstruct-is-++ t))))
7982 (defvar orgstruct-is-++ nil
7983 "Is `orgstruct-mode' in ++ version in the current-buffer?")
7984 (make-variable-buffer-local 'orgstruct-is-++)
7986 ;;;###autoload
7987 (defun turn-on-orgstruct++ ()
7988 "Unconditionally turn on `orgstruct++-mode'."
7989 (orgstruct++-mode 1))
7991 (defun orgstruct-error ()
7992 "Error when there is no default binding for a structure key."
7993 (interactive)
7994 (error "This key has no function outside structure elements"))
7996 (defun orgstruct-setup ()
7997 "Setup orgstruct keymaps."
7998 (let ((nfunc 0)
7999 (bindings
8000 (list
8001 '([(meta up)] org-metaup)
8002 '([(meta down)] org-metadown)
8003 '([(meta left)] org-metaleft)
8004 '([(meta right)] org-metaright)
8005 '([(meta shift up)] org-shiftmetaup)
8006 '([(meta shift down)] org-shiftmetadown)
8007 '([(meta shift left)] org-shiftmetaleft)
8008 '([(meta shift right)] org-shiftmetaright)
8009 '([?\e (up)] org-metaup)
8010 '([?\e (down)] org-metadown)
8011 '([?\e (left)] org-metaleft)
8012 '([?\e (right)] org-metaright)
8013 '([?\e (shift up)] org-shiftmetaup)
8014 '([?\e (shift down)] org-shiftmetadown)
8015 '([?\e (shift left)] org-shiftmetaleft)
8016 '([?\e (shift right)] org-shiftmetaright)
8017 '([(shift up)] org-shiftup)
8018 '([(shift down)] org-shiftdown)
8019 '([(shift left)] org-shiftleft)
8020 '([(shift right)] org-shiftright)
8021 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8022 '("\M-q" fill-paragraph)
8023 '("\C-c^" org-sort)
8024 '("\C-c-" org-cycle-list-bullet)))
8025 elt key fun cmd)
8026 (while (setq elt (pop bindings))
8027 (setq nfunc (1+ nfunc))
8028 (setq key (org-key (car elt))
8029 fun (nth 1 elt)
8030 cmd (orgstruct-make-binding fun nfunc key))
8031 (org-defkey orgstruct-mode-map key cmd))
8033 ;; Special treatment needed for TAB and RET
8034 (org-defkey orgstruct-mode-map [(tab)]
8035 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8036 (org-defkey orgstruct-mode-map "\C-i"
8037 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8039 (org-defkey orgstruct-mode-map "\M-\C-m"
8040 (orgstruct-make-binding 'org-insert-heading 105
8041 "\M-\C-m" [(meta return)]))
8042 (org-defkey orgstruct-mode-map [(meta return)]
8043 (orgstruct-make-binding 'org-insert-heading 106
8044 [(meta return)] "\M-\C-m"))
8046 (org-defkey orgstruct-mode-map [(shift meta return)]
8047 (orgstruct-make-binding 'org-insert-todo-heading 107
8048 [(meta return)] "\M-\C-m"))
8050 (org-defkey orgstruct-mode-map "\e\C-m"
8051 (orgstruct-make-binding 'org-insert-heading 108
8052 "\e\C-m" [?\e (return)]))
8053 (org-defkey orgstruct-mode-map [?\e (return)]
8054 (orgstruct-make-binding 'org-insert-heading 109
8055 [?\e (return)] "\e\C-m"))
8056 (org-defkey orgstruct-mode-map [?\e (shift return)]
8057 (orgstruct-make-binding 'org-insert-todo-heading 110
8058 [?\e (return)] "\e\C-m"))
8060 (unless org-local-vars
8061 (setq org-local-vars (org-get-local-variables)))
8063 t))
8065 (defun orgstruct-make-binding (fun n &rest keys)
8066 "Create a function for binding in the structure minor mode.
8067 FUN is the command to call inside a table. N is used to create a unique
8068 command name. KEYS are keys that should be checked in for a command
8069 to execute outside of tables."
8070 (eval
8071 (list 'defun
8072 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8073 '(arg)
8075 "Outside of structure, run the binding of `"
8076 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8077 "'.")
8078 '(interactive "p")
8079 (list 'if
8080 `(org-context-p 'headline 'item
8081 (and orgstruct-is-++
8082 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8083 'item-body))
8084 (list 'org-run-like-in-org-mode (list 'quote fun))
8085 (list 'let '(orgstruct-mode)
8086 (list 'call-interactively
8087 (append '(or)
8088 (mapcar (lambda (k)
8089 (list 'key-binding k))
8090 keys)
8091 '('orgstruct-error))))))))
8093 (defun org-context-p (&rest contexts)
8094 "Check if local context is any of CONTEXTS.
8095 Possible values in the list of contexts are `table', `headline', and `item'."
8096 (let ((pos (point)))
8097 (goto-char (point-at-bol))
8098 (prog1 (or (and (memq 'table contexts)
8100 (and (memq 'headline contexts)
8102 (looking-at outline-regexp))
8103 (and (memq 'item contexts)
8105 (and (memq 'item-body contexts)
8106 (org-in-item-p)))
8107 (goto-char pos))))
8109 (defun org-get-local-variables ()
8110 "Return a list of all local variables in an org-mode buffer."
8111 (let (varlist)
8112 (with-current-buffer (get-buffer-create "*Org tmp*")
8113 (erase-buffer)
8114 (org-mode)
8115 (setq varlist (buffer-local-variables)))
8116 (kill-buffer "*Org tmp*")
8117 (delq nil
8118 (mapcar
8119 (lambda (x)
8120 (setq x
8121 (if (symbolp x)
8122 (list x)
8123 (list (car x) (list 'quote (cdr x)))))
8124 (if (string-match
8125 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8126 (symbol-name (car x)))
8127 x nil))
8128 varlist))))
8130 ;;;###autoload
8131 (defun org-run-like-in-org-mode (cmd)
8132 "Run a command, pretending that the current buffer is in Org-mode.
8133 This will temporarily bind local variables that are typically bound in
8134 Org-mode to the values they have in Org-mode, and then interactively
8135 call CMD."
8136 (org-load-modules-maybe)
8137 (unless org-local-vars
8138 (setq org-local-vars (org-get-local-variables)))
8139 (eval (list 'let org-local-vars
8140 (list 'call-interactively (list 'quote cmd)))))
8142 ;;;; Archiving
8144 (defun org-get-category (&optional pos force-refresh)
8145 "Get the category applying to position POS."
8146 (if force-refresh (org-refresh-category-properties))
8147 (let ((pos (or pos (point))))
8148 (or (get-text-property pos 'org-category)
8149 (progn (org-refresh-category-properties)
8150 (get-text-property pos 'org-category)))))
8152 (defun org-refresh-category-properties ()
8153 "Refresh category text properties in the buffer."
8154 (let ((def-cat (cond
8155 ((null org-category)
8156 (if buffer-file-name
8157 (file-name-sans-extension
8158 (file-name-nondirectory buffer-file-name))
8159 "???"))
8160 ((symbolp org-category) (symbol-name org-category))
8161 (t org-category)))
8162 beg end cat pos optionp)
8163 (org-unmodified
8164 (save-excursion
8165 (save-restriction
8166 (widen)
8167 (goto-char (point-min))
8168 (put-text-property (point) (point-max) 'org-category def-cat)
8169 (while (re-search-forward
8171 (setq pos (match-end 0)
8172 optionp (equal (char-after (match-beginning 0)) ?#)
8173 cat (org-trim (match-string 2)))
8174 (if optionp
8175 (setq beg (point-at-bol) end (point-max))
8176 (org-back-to-heading t)
8177 (setq beg (point) end (org-end-of-subtree t t)))
8178 (put-text-property beg end 'org-category cat)
8179 (goto-char pos)))))))
8182 ;;;; Link Stuff
8184 ;;; Link abbreviations
8186 (defun org-link-expand-abbrev (link)
8187 "Apply replacements as defined in `org-link-abbrev-alist."
8189 (let* ((key (match-string 1 link))
8190 (as (or (assoc key org-link-abbrev-alist-local)
8191 (assoc key org-link-abbrev-alist)))
8192 (tag (and (match-end 2) (match-string 3 link)))
8193 rpl)
8194 (if (not as)
8195 link
8196 (setq rpl (cdr as))
8197 (cond
8198 ((symbolp rpl) (funcall rpl tag))
8199 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8200 ((string-match "%h" rpl)
8201 (replace-match (url-hexify-string (or tag "")) t t rpl))
8202 (t (concat rpl tag)))))
8203 link))
8205 ;;; Storing and inserting links
8207 (defvar org-insert-link-history nil
8208 "Minibuffer history for links inserted with `org-insert-link'.")
8210 (defvar org-stored-links nil
8211 "Contains the links stored with `org-store-link'.")
8213 (defvar org-store-link-plist nil
8214 "Plist with info about the most recently link created with `org-store-link'.")
8216 (defvar org-link-protocols nil
8217 "Link protocols added to Org-mode using `org-add-link-type'.")
8219 (defvar org-store-link-functions nil
8220 "List of functions that are called to create and store a link.
8221 Each function will be called in turn until one returns a non-nil
8222 value. Each function should check if it is responsible for creating
8223 this link (for example by looking at the major mode).
8224 If not, it must exit and return nil.
8225 If yes, it should return a non-nil value after a calling
8226 `org-store-link-props' with a list of properties and values.
8227 Special properties are:
8231 This is obligatory as well.
8232 :description Optional default description for the second pair
8233 of brackets in an Org-mode link. The user can still change
8234 this when inserting this link into an Org-mode buffer.
8236 In addition to these, any additional properties can be specified
8237 and then used in remember templates.")
8239 (defun org-add-link-type (type &optional follow export)
8240 "Add TYPE to the list of `org-link-types'.
8241 Re-compute all regular expressions depending on `org-link-types'
8243 FOLLOW and EXPORT are two functions.
8245 FOLLOW should take the link path as the single argument and do whatever
8246 is necessary to follow the link, for example find a file or display
8247 a mail message.
8249 EXPORT should format the link path for export to one of the export formats.
8250 It should be a function accepting three arguments:
8253 desc the description of the link, if any, nil if there was no description
8254 format the export format, a symbol like `html' or `latex' or `ascii'..
8256 The function may use the FORMAT information to return different values
8257 depending on the format. The return value will be put literally into
8258 the exported file. If the return value is nil, this means Org should
8259 do what it normally does with links which do not have EXPORT defined.
8261 Org-mode has a built-in default for exporting links. If you are happy with
8262 this default, there is no need to define an export function for the link
8263 type. For a simple example of an export function, see `org-bbdb.el'."
8264 (add-to-list 'org-link-types type t)
8265 (org-make-link-regexps)
8266 (if (assoc type org-link-protocols)
8267 (setcdr (assoc type org-link-protocols) (list follow export))
8268 (push (list type follow export) org-link-protocols)))
8270 (defvar org-agenda-buffer-name)
8272 ;;;###autoload
8273 (defun org-store-link (arg)
8275 This link is added to `org-stored-links' and can later be inserted
8278 For some link types, a prefix arg is interpreted:
8279 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8280 For file links, arg negates `org-context-in-file-links'."
8281 (interactive "P")
8282 (org-load-modules-maybe)
8283 (setq org-store-link-plist nil) ; reset
8284 (org-with-limited-levels
8285 (let (link cpltxt desc description search txt custom-id agenda-link)
8286 (cond
8288 ((run-hook-with-args-until-success 'org-store-link-functions)
8289 (setq link (plist-get org-store-link-plist :link)
8290 desc (or (plist-get org-store-link-plist :description) link)))
8292 ((equal (buffer-name) "*Org Edit Src Example*")
8293 (let (label gc)
8294 (while (or (not label)
8295 (save-excursion
8296 (save-restriction
8297 (widen)
8298 (goto-char (point-min))
8299 (re-search-forward
8300 (regexp-quote (format org-coderef-label-format label))
8301 nil t))))
8302 (when label (message "Label exists already") (sit-for 2))
8303 (setq label (read-string "Code line label: " label)))
8304 (end-of-line 1)
8305 (setq link (format org-coderef-label-format label))
8306 (setq gc (- 79 (length link)))
8307 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8308 (insert link)
8309 (setq link (concat "(" label ")") desc nil)))
8311 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8312 ;; We are in the agenda, link to referenced location
8313 (let ((m (or (get-text-property (point) 'org-hd-marker)
8314 (get-text-property (point) 'org-marker))))
8315 (when m
8316 (org-with-point-at m
8317 (setq agenda-link
8318 (if (interactive-p)
8319 (call-interactively 'org-store-link)
8320 (org-store-link nil)))))))
8322 ((eq major-mode 'calendar-mode)
8323 (let ((cd (calendar-cursor-to-date)))
8324 (setq link
8325 (format-time-string
8326 (car org-time-stamp-formats)
8327 (apply 'encode-time
8328 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8329 nil nil nil))))
8330 (org-store-link-props :type "calendar" :date cd)))
8332 ((eq major-mode 'w3-mode)
8333 (setq cpltxt (if (and (buffer-name)
8334 (not (string-match "Untitled" (buffer-name))))
8335 (buffer-name)
8336 (url-view-url t))
8337 link (org-make-link (url-view-url t)))
8338 (org-store-link-props :type "w3" :url (url-view-url t)))
8340 ((eq major-mode 'w3m-mode)
8341 (setq cpltxt (or w3m-current-title w3m-current-url)
8342 link (org-make-link w3m-current-url))
8343 (org-store-link-props :type "w3m" :url (url-view-url t)))
8345 ((setq search (run-hook-with-args-until-success
8346 'org-create-file-search-functions))
8347 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8348 "::" search))
8349 (setq cpltxt (or description link)))
8351 ((eq major-mode 'image-mode)
8352 (setq cpltxt (concat "file:"
8353 (abbreviate-file-name buffer-file-name))
8354 link (org-make-link cpltxt))
8355 (org-store-link-props :type "image" :file buffer-file-name))
8357 ((eq major-mode 'dired-mode)
8358 ;; link to the file in the current line
8359 (let ((file (dired-get-filename nil t)))
8360 (setq file (if file
8361 (abbreviate-file-name
8362 (expand-file-name (dired-get-filename nil t)))
8363 ;; otherwise, no file so use current directory.
8364 default-directory))
8365 (setq cpltxt (concat "file:" file)
8366 link (org-make-link cpltxt))))
8368 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8369 (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
8370 (cond
8372 (setq cpltxt
8373 (concat "file:"
8374 (abbreviate-file-name
8375 (buffer-file-name (buffer-base-buffer)))
8376 "::" (match-string 1))
8377 link (org-make-link cpltxt)))
8378 ((and (featurep 'org-id)
8379 (or (eq org-link-to-org-use-id t)
8380 (and (eq org-link-to-org-use-id 'create-if-interactive)
8381 (interactive-p))
8382 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
8383 (interactive-p)
8384 (not custom-id))
8385 (and org-link-to-org-use-id
8386 (condition-case nil
8387 (org-entry-get nil "ID")
8388 (error nil)))))
8389 ;; We can make a link using the ID.
8390 (setq link (condition-case nil
8391 (prog1 (org-id-store-link)
8392 (setq desc (plist-get org-store-link-plist
8393 :description)))
8394 (error
8395 ;; probably before first headline, link to file only
8396 (concat "file:"
8397 (abbreviate-file-name
8398 (buffer-file-name (buffer-base-buffer))))))))
8399 (t
8400 ;; Just link to current headline
8401 (setq cpltxt (concat "file:"
8402 (abbreviate-file-name
8403 (buffer-file-name (buffer-base-buffer)))))
8404 ;; Add a context search string
8405 (when (org-xor org-context-in-file-links arg)
8406 (setq txt (cond
8407 ((org-on-heading-p) nil)
8408 ((org-region-active-p)
8409 (buffer-substring (region-beginning) (region-end)))
8410 (t nil)))
8412 (setq cpltxt
8413 (concat cpltxt "::"
8414 (condition-case nil
8415 (org-make-org-heading-search-string txt)
8416 (error "")))
8417 desc (or (nth 4 (ignore-errors
8418 (org-heading-components))) "NONE"))))
8420 (setq cpltxt (substring cpltxt 0 -2)))
8421 (setq link (org-make-link cpltxt)))))
8423 ((buffer-file-name (buffer-base-buffer))
8424 ;; Just link to this file here.
8425 (setq cpltxt (concat "file:"
8426 (abbreviate-file-name
8427 (buffer-file-name (buffer-base-buffer)))))
8428 ;; Add a context string
8429 (when (org-xor org-context-in-file-links arg)
8430 (setq txt (if (org-region-active-p)
8431 (buffer-substring (region-beginning) (region-end))
8432 (buffer-substring (point-at-bol) (point-at-eol))))
8433 ;; Only use search option if there is some text.
8435 (setq cpltxt
8436 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8437 desc "NONE")))
8438 (setq link (org-make-link cpltxt)))
8440 ((interactive-p)
8441 (error "Cannot link to a buffer which is not visiting a file"))
8443 (t (setq link nil)))
8445 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8446 (setq link (or link cpltxt)
8447 desc (or desc cpltxt))
8448 (if (equal desc "NONE") (setq desc nil))
8450 (if (and (or (interactive-p) executing-kbd-macro) link)
8451 (progn
8452 (setq org-stored-links
8453 (cons (list link desc) org-stored-links))
8454 (message "Stored: %s" (or desc link))
8455 (when custom-id
8456 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8457 "::#" custom-id))
8458 (setq org-stored-links
8459 (cons (list link desc) org-stored-links))))
8460 (or agenda-link (and link (org-make-link-string link desc)))))))
8462 (defun org-store-link-props (&rest plist)
8463 "Store link properties, extract names and addresses."
8464 (let (x adr)
8465 (when (setq x (plist-get plist :from))
8466 (setq adr (mail-extract-address-components x))
8467 (setq plist (plist-put plist :fromname (car adr)))
8468 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8469 (when (setq x (plist-get plist :to))
8470 (setq adr (mail-extract-address-components x))
8471 (setq plist (plist-put plist :toname (car adr)))
8472 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8473 (let ((from (plist-get plist :from))
8474 (to (plist-get plist :to)))
8475 (when (and from to org-from-is-user-regexp)
8476 (setq plist
8477 (plist-put plist :fromto
8478 (if (string-match org-from-is-user-regexp from)
8479 (concat "to %t")
8480 (concat "from %f"))))))
8481 (setq org-store-link-plist plist))
8483 (defun org-add-link-props (&rest plist)
8484 "Add these properties to the link property list."
8485 (let (key value)
8486 (while plist
8487 (setq key (pop plist) value (pop plist))
8488 (setq org-store-link-plist
8489 (plist-put org-store-link-plist key value)))))
8491 (defun org-email-link-description (&optional fmt)
8492 "Return the description part of an email link.
8493 This takes information from `org-store-link-plist' and formats it
8494 according to FMT (default from `org-email-link-description-format')."
8495 (setq fmt (or fmt org-email-link-description-format))
8496 (let* ((p org-store-link-plist)
8497 (to (plist-get p :toaddress))
8498 (from (plist-get p :fromaddress))
8499 (table
8500 (list
8501 (cons "%c" (plist-get p :fromto))
8502 (cons "%F" (plist-get p :from))
8503 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8504 (cons "%T" (plist-get p :to))
8505 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8506 (cons "%s" (plist-get p :subject))
8507 (cons "%d" (plist-get p :date))
8508 (cons "%m" (plist-get p :message-id)))))
8509 (when (string-match "%c" fmt)
8510 ;; Check if the user wrote this message
8511 (if (and org-from-is-user-regexp from to
8512 (save-match-data (string-match org-from-is-user-regexp from)))
8513 (setq fmt (replace-match "to %t" t t fmt))
8514 (setq fmt (replace-match "from %f" t t fmt))))
8515 (org-replace-escapes fmt table)))
8517 (defun org-make-org-heading-search-string (&optional string heading)
8518 "Make search string for STRING or current headline."
8519 (interactive)
8520 (let ((s (or string (org-get-heading)))
8521 (lines org-context-in-file-links))
8522 (unless (and string (not heading))
8523 ;; We are using a headline, clean up garbage in there.
8524 (if (string-match org-todo-regexp s)
8525 (setq s (replace-match "" t t s)))
8527 (setq s (replace-match "" t t s)))
8528 (setq s (org-trim s))
8531 (setq s (replace-match "" t t s)))
8532 (while (string-match org-ts-regexp s)
8533 (setq s (replace-match "" t t s))))
8534 (or string (setq s (concat "*" s))) ; Add * for headlines
8535 (when (and string (integerp lines) (> lines 0))
8537 (when (< lines (length slines))
8538 (setq s (mapconcat
8539 'identity
8540 (reverse (nthcdr (- (length slines) lines)
8544 (defun org-make-link (&rest strings)
8545 "Concatenate STRINGS."
8546 (apply 'concat strings))
8548 (defun org-make-link-string (link &optional description)
8549 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8551 (error "Empty link"))
8552 (when (and description
8553 (stringp description)
8555 (setq description nil))
8556 (when (stringp description)
8557 ;; Remove brackets from the description, they are fatal.
8559 (setq description (replace-match "{" t t description)))
8561 (setq description (replace-match "}" t t description))))
8562 (when (equal (org-link-escape link) description)
8563 ;; No description needed, it is identical
8564 (setq description nil))
8565 (when (and (not description)
8566 (not (equal link (org-link-escape link))))
8567 (setq description (org-extract-attributes link)))
8568 (setq link (if (string-match org-link-types-re link)
8569 (concat (match-string 1 link)
8570 (org-link-escape (substring link (match-end 1))))
8571 (org-link-escape link)))
8572 (concat "[[" link "]"
8573 (if description (concat "[" description "]") "")
8574 "]"))
8576 (defconst org-link-escape-chars
8577 '((?\ . "%20")
8578 (?\[ . "%5B")
8579 (?\] . "%5D")
8590 (?\; . "%3B")
8591 ;; (?? . "%3F")
8592 (?= . "%3D")
8593 (?+ . "%2B")
8594 )
8595 "Association list of escapes for some characters problematic in links.
8596 This is the list that is used for internal purposes.")
8598 (defvar org-url-encoding-use-url-hexify nil)
8600 (defconst org-link-escape-chars-browser
8601 '((?\ . "%20")) ; 32 for the SPC char
8602 "Association list of escapes for some characters problematic in links.
8603 This is the list that is used before handing over to the browser.")
8605 (defun org-link-escape (text &optional table)
8606 "Escape characters in TEXT that are problematic for links."
8607 (if (and org-url-encoding-use-url-hexify (not table))
8608 (url-hexify-string text)
8609 (setq table (or table org-link-escape-chars))
8610 (when text
8611 (let ((re (mapconcat (lambda (x) (regexp-quote
8612 (char-to-string (car x))))
8614 (while (string-match re text)
8615 (setq text
8616 (replace-match
8617 (cdr (assoc (string-to-char (match-string 0 text))
8618 table))
8619 t t text)))
8620 text))))
8622 (defun org-link-unescape (text &optional table)
8623 "Reverse the action of `org-link-escape'."
8624 (if (and org-url-encoding-use-url-hexify (not table))
8625 (url-unhex-string text)
8626 (setq table (or table org-link-escape-chars))
8627 (when text
8628 (let ((case-fold-search t)
8629 (re (mapconcat (lambda (x) (regexp-quote (downcase (cdr x))))
8631 (while (string-match re text)
8632 (setq text
8633 (replace-match
8634 (char-to-string (car (rassoc (upcase (match-string 0 text))
8635 table)))
8636 t t text)))
8637 text))))
8639 (defun org-xor (a b)
8640 "Exclusive or."
8641 (if a (not b) b))
8643 (defun org-fixup-message-id-for-http (s)
8644 "Replace special characters in a message id, so it can be used in an http query."
8645 (when (string-match "%" s)
8646 (setq s (mapconcat (lambda (c)
8647 (if (eq c ?%)
8648 "%25"
8649 (char-to-string c)))
8650 s "")))
8651 (while (string-match "<" s)
8652 (setq s (replace-match "%3C" t t s)))
8653 (while (string-match ">" s)
8654 (setq s (replace-match "%3E" t t s)))
8655 (while (string-match "@" s)
8656 (setq s (replace-match "%40" t t s)))
8657 s)
8659 ;;;###autoload
8660 (defun org-insert-link-global ()
8661 "Insert a link like Org-mode does.
8662 This command can be called in any mode to insert a link in Org-mode syntax."
8663 (interactive)
8664 (org-load-modules-maybe)
8665 (org-run-like-in-org-mode 'org-insert-link))
8667 (defun org-insert-link (&optional complete-file link-location)
8668 "Insert a link. At the prompt, enter the link.
8670 Completion can be used to insert any of the link protocol prefixes like
8671 http or ftp in use.
8673 The history can be used to select a link previously stored with
8674 `org-store-link'. When the empty string is entered (i.e. if you just
8675 press RET at the prompt), the link defaults to the most recently
8676 stored link. As SPC triggers completion in the minibuffer, you need to
8677 use M-SPC or C-q SPC to force the insertion of a space character.
8679 You will also be prompted for a description, and if one is given, it will
8680 be displayed in the buffer instead of the link.
8682 If there is already a link at point, this command will allow you to edit link
8683 and description parts.
8686 be selected using completion. The path to the file will be relative to the
8687 current directory if the file is in the current directory or a subdirectory.
8688 Otherwise, the link will be the absolute path as completed in the minibuffer
8689 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8690 option `org-link-file-path-type'.
8693 the current directory or below.
8696 `org-keep-stored-link-after-insertion'.
8698 If `org-make-link-description-function' is non-nil, this function will be
8699 called with the link target, and the result will be the default
8700 link description.
8702 If the LINK-LOCATION parameter is non-nil, this value will be
8703 used as the link location instead of reading one interactively."
8704 (interactive "P")
8705 (let* ((wcf (current-window-configuration))
8706 (region (if (org-region-active-p)
8707 (buffer-substring (region-beginning) (region-end))))
8708 (remove (and region (list (region-beginning) (region-end))))
8709 (desc region)
8710 tmphist ; byte-compile incorrectly complains about this
8711 (link link-location)
8712 entry file all-prefixes)
8713 (cond
8714 (link-location) ; specified by arg, just use it.
8715 ((org-in-regexp org-bracket-link-regexp 1)
8716 ;; We do have a link at point, and we are going to edit it.
8717 (setq remove (list (match-beginning 0) (match-end 0)))
8718 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8719 (setq link (read-string "Link: "
8720 (org-link-unescape
8721 (org-match-string-no-properties 1)))))
8722 ((or (org-in-regexp org-angle-link-re)
8723 (org-in-regexp org-plain-link-re))
8724 ;; Convert to bracket link
8725 (setq remove (list (match-beginning 0) (match-end 0))
8726 link (read-string "Link: "
8727 (org-remove-angle-brackets (match-string 0)))))
8728 ((member complete-file '((4) (16)))
8729 ;; Completing read for file names.
8730 (setq link (org-file-complete-link complete-file)))
8731 (t
8732 ;; Read link, with completion for stored links.
8733 (with-output-to-temp-buffer "*Org Links*"
8734 (princ "Insert a link.
8736 (when org-stored-links
8738 (princ (mapconcat
8739 (lambda (x)
8740 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8742 (let ((cw (selected-window)))
8743 (select-window (get-buffer-window "*Org Links*" 'visible))
8744 (setq truncate-lines t)
8745 (unless (pos-visible-in-window-p (point-max))
8746 (org-fit-window-to-buffer))
8747 (and (window-live-p cw) (select-window cw)))
8748 ;; Fake a link history, containing the stored links.
8749 (setq tmphist (append (mapcar 'car org-stored-links)
8750 org-insert-link-history))
8751 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8752 (mapcar 'car org-link-abbrev-alist)
8753 org-link-types))
8754 (unwind-protect
8755 (progn
8756 (setq link
8757 (let ((org-completion-use-ido nil)
8758 (org-completion-use-iswitchb nil))
8759 (org-completing-read
8760 "Link: "
8761 (append
8762 (mapcar (lambda (x) (list (concat x ":")))
8763 all-prefixes)
8764 (mapcar 'car org-stored-links))
8765 nil nil nil
8766 'tmphist
8767 (car (car org-stored-links)))))
8769 (error "No link selected"))
8770 (if (or (member link all-prefixes)
8771 (and (equal ":" (substring link -1))
8772 (member (substring link 0 -1) all-prefixes)
8773 (setq link (substring link 0 -1))))
8774 (setq link (org-link-try-special-completion link))))
8775 (set-window-configuration wcf)
8776 (kill-buffer "*Org Links*"))
8777 (setq entry (assoc link org-stored-links))
8778 (or entry (push link org-insert-link-history))
8779 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8780 (not org-keep-stored-link-after-insertion))
8781 (setq org-stored-links (delq (assoc link org-stored-links)
8782 org-stored-links)))
8783 (setq desc (or desc (nth 1 entry)))))
8785 (if (string-match org-plain-link-re link)
8786 ;; URL-like link, normalize the use of angular brackets.
8787 (setq link (org-make-link (org-remove-angle-brackets link))))
8789 ;; Check if we are linking to the current file with a search option
8790 ;; If yes, simplify the link by using only the search option.
8791 (when (and buffer-file-name
8793 (let* ((path (match-string 1 link))
8794 (case-fold-search nil)
8795 (search (match-string 2 link)))
8796 (save-match-data
8797 (if (equal (file-truename buffer-file-name) (file-truename path))
8798 ;; We are linking to this same file, with a search option
8799 (setq link search)))))
8801 ;; Check if we can/should use a relative path. If yes, simplify the link
8803 (let* ((type (match-string 1 link))
8804 (path (match-string 2 link))
8805 (origpath path)
8806 (case-fold-search nil))
8807 (cond
8808 ((or (eq org-link-file-path-type 'absolute)
8809 (equal complete-file '(16)))
8810 (setq path (abbreviate-file-name (expand-file-name path))))
8811 ((eq org-link-file-path-type 'noabbrev)
8812 (setq path (expand-file-name path)))
8813 ((eq org-link-file-path-type 'relative)
8814 (setq path (file-relative-name path)))
8815 (t
8816 (save-match-data
8817 (if (string-match (concat "^" (regexp-quote
8818 (expand-file-name
8819 (file-name-as-directory
8820 default-directory))))
8821 (expand-file-name path))
8822 ;; We are linking a file with relative path name.
8823 (setq path (substring (expand-file-name path)
8824 (match-end 0)))
8825 (setq path (abbreviate-file-name (expand-file-name path)))))))
8826 (setq link (concat type path))
8827 (if (equal desc origpath)
8828 (setq desc path))))
8830 (if org-make-link-description-function
8831 (setq desc (funcall org-make-link-description-function link desc)))
8833 (setq desc (read-string "Description: " desc))
8835 (if remove (apply 'delete-region remove))
8836 (insert (org-make-link-string link desc))))
8838 (defun org-link-try-special-completion (type)
8839 "If there is completion support for link type TYPE, offer it."
8840 (let ((fun (intern (concat "org-" type "-complete-link"))))
8841 (if (functionp fun)
8842 (funcall fun)
8843 (read-string "Link (no completion support): " (concat type ":")))))
8845 (defun org-file-complete-link (&optional arg)
8846 "Create a file link using completion."
8847 (let (file link)
8848 (setq file (read-file-name "File: "))
8849 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8850 (pwd1 (file-name-as-directory (abbreviate-file-name
8851 (expand-file-name ".")))))
8852 (cond
8853 ((equal arg '(16))
8854 (setq link (org-make-link
8855 "file:"
8856 (abbreviate-file-name (expand-file-name file)))))
8858 (setq link (org-make-link "file:" (match-string 1 file))))
8860 (expand-file-name file))
8861 (setq link (org-make-link
8862 "file:" (match-string 1 (expand-file-name file)))))
8863 (t (setq link (org-make-link "file:" file)))))
8864 link))
8866 (defun org-completing-read (&rest args)
8867 "Completing-read with SPACE being a normal character."
8868 (let ((minibuffer-local-completion-map
8869 (copy-keymap minibuffer-local-completion-map)))
8870 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
8871 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
8872 (apply 'org-icompleting-read args)))
8874 (defun org-completing-read-no-i (&rest args)
8875 (let (org-completion-use-ido org-completion-use-iswitchb)
8876 (apply 'org-completing-read args)))
8878 (defun org-iswitchb-completing-read (prompt choices &rest args)
8879 "Use iswitch as a completing-read replacement to choose from choices.
8880 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
8881 from."
8882 (let* ((iswitchb-use-virtual-buffers nil)
8883 (iswitchb-make-buflist-hook
8884 (lambda ()
8885 (setq iswitchb-temp-buflist choices))))
8886 (iswitchb-read-buffer prompt)))
8888 (defun org-icompleting-read (&rest args)
8889 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
8890 (org-without-partial-completion
8891 (if (and org-completion-use-ido
8892 (fboundp 'ido-completing-read)
8893 (boundp 'ido-mode) ido-mode
8894 (listp (second args)))
8895 (let ((ido-enter-matching-directory nil))
8896 (apply 'ido-completing-read (concat (car args))
8897 (if (consp (car (nth 1 args)))
8898 (mapcar (lambda (x) (car x)) (nth 1 args))
8899 (nth 1 args))
8900 (cddr args)))
8901 (if (and org-completion-use-iswitchb
8902 (boundp 'iswitchb-mode) iswitchb-mode
8903 (listp (second args)))
8904 (apply 'org-iswitchb-completing-read (concat (car args))
8905 (if (consp (car (nth 1 args)))
8906 (mapcar (lambda (x) (car x)) (nth 1 args))
8907 (nth 1 args))
8908 (cddr args))
8909 (apply 'completing-read args)))))
8911 (defun org-extract-attributes (s)
8912 "Extract the attributes cookie from a string and set as text property."
8913 (let (a attr (start 0) key value)
8914 (save-match-data
8916 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
8918 (setq key (match-string 1 a) value (match-string 2 a)
8919 start (match-end 0)
8920 attr (plist-put attr (intern key) value))))
8921 (org-add-props s nil 'org-attr attr))
8922 s))
8924 (defun org-extract-attributes-from-string (tag)
8925 (let (key value attr)
8927 (setq key (match-string 1 tag) value (match-string 2 tag)
8928 tag (replace-match "" t t tag)
8929 attr (plist-put attr (intern key) value)))
8930 (cons tag attr)))
8932 (defun org-attributes-to-string (plist)
8933 "Format a property list into an HTML attribute list."
8934 (let ((s "") key value)
8935 (while plist
8936 (setq key (pop plist) value (pop plist))
8937 (and value
8939 s))
8941 ;;; Opening/following a link
8943 (defvar org-link-search-failed nil)
8945 (defvar org-open-link-functions nil
8946 "Hook for functions finding a plain text link.
8947 These functions must take a single argument, the link content.
8948 They will be called for links that look like [[link text][description]]
8952 These functions will be called *before* Org attempts to resolve the
8953 link by doing text searches in the current buffer - so if you want a
8955 handle this as a special case.
8957 When the function does handle the link, it must return a non-nil value.
8958 If it decides that it is not responsible for this link, it must return
8959 nil to indicate that that Org-mode can continue with other options
8960 like exact and fuzzy text search.")
8962 (defun org-next-link ()
8963 "Move forward to the next link.
8964 If the link is in hidden text, expose it."
8965 (interactive)
8966 (when (and org-link-search-failed (eq this-command last-command))
8967 (goto-char (point-min))
8968 (message "Link search wrapped back to beginning of buffer"))
8969 (setq org-link-search-failed nil)
8970 (let* ((pos (point))
8971 (ct (org-context))
8972 (a (assoc :link ct)))
8973 (if a (goto-char (nth 2 a)))
8974 (if (re-search-forward org-any-link-re nil t)
8975 (progn
8976 (goto-char (match-beginning 0))
8977 (if (outline-invisible-p) (org-show-context)))
8978 (goto-char pos)
8979 (setq org-link-search-failed t)
8980 (error "No further link found"))))
8982 (defun org-previous-link ()
8983 "Move backward to the previous link.
8984 If the link is in hidden text, expose it."
8985 (interactive)
8986 (when (and org-link-search-failed (eq this-command last-command))
8987 (goto-char (point-max))
8988 (message "Link search wrapped back to end of buffer"))
8989 (setq org-link-search-failed nil)
8990 (let* ((pos (point))
8991 (ct (org-context))
8992 (a (assoc :link ct)))
8993 (if a (goto-char (nth 1 a)))
8994 (if (re-search-backward org-any-link-re nil t)
8995 (progn
8996 (goto-char (match-beginning 0))
8997 (if (outline-invisible-p) (org-show-context)))
8998 (goto-char pos)
8999 (setq org-link-search-failed t)
9000 (error "No further link found"))))
9002 (defun org-translate-link (s)
9003 "Translate a link string if a translation function has been defined."
9004 (if (and org-link-translation-function
9005 (fboundp org-link-translation-function)
9007 (progn
9008 (setq s (funcall org-link-translation-function
9009 (match-string 1) (match-string 2)))
9010 (concat (car s) ":" (cdr s)))
9011 s))
9013 (defun org-translate-link-from-planner (type path)
9014 "Translate a link from Emacs Planner syntax so that Org can follow it.
9015 This is still an experimental function, your mileage may vary."
9016 (cond
9017 ((member type '("http" "https" "news" "ftp"))
9018 ;; standard Internet links are the same.
9019 nil)
9020 ((and (equal type "irc") (string-match "^//" path))
9021 ;; Planner has two / at the beginning of an irc link, we have 1.
9022 ;; We should have zero, actually....
9023 (setq path (substring path 1)))
9024 ((and (equal type "lisp") (string-match "^/" path))
9025 ;; Planner has a slash, we do not.
9026 (setq type "elisp" path (substring path 1)))
9028 ;; A typical message link. Planner has the id after the final slash,
9029 ;; we separate it with a hash mark
9030 (setq path (concat (match-string 1 path) "#"
9031 (org-remove-angle-brackets (match-string 2 path)))))
9032 )
9033 (cons type path))
9035 (defun org-find-file-at-mouse (ev)
9036 "Open file link or URL at mouse."
9037 (interactive "e")
9038 (mouse-set-point ev)
9039 (org-open-at-point 'in-emacs))
9041 (defun org-open-at-mouse (ev)
9042 "Open file link or URL at mouse."
9043 (interactive "e")
9044 (mouse-set-point ev)
9045 (if (eq major-mode 'org-agenda-mode)
9046 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9047 (org-open-at-point))
9049 (defvar org-window-config-before-follow-link nil
9050 "The window configuration before following a link.
9051 This is saved in case the need arises to restore it.")
9053 (defvar org-open-link-marker (make-marker)
9054 "Marker pointing to the location where `org-open-at-point; was called.")
9056 ;;;###autoload
9057 (defun org-open-at-point-global ()
9058 "Follow a link like Org-mode does.
9059 This command can be called in any mode to follow a link that has
9060 Org-mode syntax."
9061 (interactive)
9062 (org-run-like-in-org-mode 'org-open-at-point))
9064 ;;;###autoload
9065 (defun org-open-link-from-string (s &optional arg reference-buffer)
9066 "Open a link in the string S, as if it was in Org-mode."
9068 (let ((reference-buffer (or reference-buffer (current-buffer))))
9069 (with-temp-buffer
9070 (let ((org-inhibit-startup t))
9071 (org-mode)
9072 (insert s)
9073 (goto-char (point-min))
9074 (when reference-buffer
9075 (setq org-link-abbrev-alist-local
9076 (with-current-buffer reference-buffer
9077 org-link-abbrev-alist-local)))
9078 (org-open-at-point arg reference-buffer)))))
9080 (defvar org-open-at-point-functions nil
9081 "Hook that is run when following a link at point.
9083 Functions in this hook must return t if they identify and follow
9084 a link at point. If they don't find anything interesting at point,
9085 they must return nil.")
9087 (defun org-open-at-point (&optional in-emacs reference-buffer)
9088 "Open link at or after point.
9089 If there is no link at point, this function will search forward up to
9090 the end of the current line.
9091 Normally, files will be opened by an appropriate application. If the
9092 optional argument IN-EMACS is non-nil, Emacs will visit the file.
9093 With a double prefix argument, try to open outside of Emacs, in the
9094 application the system uses for this file type."
9095 (interactive "P")
9096 ;; if in a code block, then open the block's results
9097 (unless (call-interactively #'org-babel-open-src-block-result)
9098 (org-load-modules-maybe)
9099 (move-marker org-open-link-marker (point))
9100 (setq org-window-config-before-follow-link (current-window-configuration))
9101 (org-remove-occur-highlights nil nil t)
9102 (cond
9103 ((and (org-on-heading-p)
9104 (not (org-in-regexp
9109 (not (get-text-property (point) 'org-linked-text)))
9110 (or (org-offer-links-in-entry in-emacs)
9111 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9112 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9113 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9114 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9115 (not (org-in-regexp org-bracket-link-regexp)))
9116 (org-footnote-action))
9117 (t
9118 (let (type path link line search (pos (point)))
9119 (catch 'match
9120 (save-excursion
9122 (when (org-in-regexp org-bracket-link-regexp 1)
9123 (setq link (org-extract-attributes
9124 (org-link-unescape (org-match-string-no-properties 1))))
9126 (setq link (replace-match " " t t link)))
9127 (setq link (org-link-expand-abbrev link))
9128 (cond
9129 ((or (file-name-absolute-p link)
9131 (setq type "file" path link))
9132 ((string-match org-link-re-with-space3 link)
9133 (setq type (match-string 1 link) path (match-string 2 link)))
9134 (t (setq type "thisfile" path link)))
9135 (throw 'match t)))
9137 (when (get-text-property (point) 'org-linked-text)
9138 (setq type "thisfile"
9139 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9140 (1+ (point)) (point))
9141 path (buffer-substring
9142 (previous-single-property-change pos 'org-linked-text)
9143 (next-single-property-change pos 'org-linked-text)))
9144 (throw 'match t))
9146 (save-excursion
9147 (when (or (org-in-regexp org-angle-link-re)
9148 (org-in-regexp org-plain-link-re))
9149 (setq type (match-string 1) path (match-string 2))
9150 (throw 'match t)))
9151 (save-excursion
9153 (setq type "tags"
9154 path (match-string 1))
9155 (while (string-match ":" path)
9156 (setq path (replace-match "+" t t path)))
9157 (throw 'match t)))
9159 (setq type "tree-match"
9160 path (match-string 1))
9161 (throw 'match t)))
9162 (unless path
9163 (error "No link found"))
9165 ;; switch back to reference buffer
9166 ;; needed when if called in a temporary buffer through
9167 ;; org-open-link-from-string
9168 (with-current-buffer (or reference-buffer (current-buffer))
9170 ;; Remove any trailing spaces in path
9172 (setq path (replace-match "" t t path)))
9173 (if (and org-link-translation-function
9174 (fboundp org-link-translation-function))
9175 ;; Check if we need to translate the link
9176 (let ((tmp (funcall org-link-translation-function type path)))
9177 (setq type (car tmp) path (cdr tmp))))
9179 (cond
9181 ((assoc type org-link-protocols)
9182 (funcall (nth 1 (assoc type org-link-protocols)) path))
9184 ((equal type "mailto")
9185 (let ((cmd (car org-link-mailto-program))
9186 (args (cdr org-link-mailto-program)) args1
9187 (address path) (subject "") a)
9189 (setq address (match-string 1 path)
9190 subject (org-link-escape (match-string 2 path))))
9191 (while args
9192 (cond
9193 ((not (stringp (car args))) (push (pop args) args1))
9194 (t (setq a (pop args))
9195 (if (string-match "%a" a)
9196 (setq a (replace-match address t t a)))
9197 (if (string-match "%s" a)
9198 (setq a (replace-match subject t t a)))
9199 (push a args1))))
9200 (apply cmd (nreverse args1))))
9202 ((member type '("http" "https" "ftp" "news"))
9203 (browse-url (concat type ":" (org-link-escape
9204 path org-link-escape-chars-browser))))
9206 ((string= type "doi")
9207 (browse-url (concat "http://dx.doi.org/"
9208 (org-link-escape
9209 path org-link-escape-chars-browser))))
9211 ((member type '("message"))
9212 (browse-url (concat type ":" path)))
9214 ((string= type "tags")
9215 (org-tags-view in-emacs path))
9217 ((string= type "tree-match")
9220 ((string= type "file")
9222 (setq line (string-to-number (match-string 1 path))
9223 path (substring path 0 (match-beginning 0)))
9225 (setq search (match-string 1 path)
9226 path (substring path 0 (match-beginning 0)))))
9227 (if (string-match "[*?{]" (file-name-nondirectory path))
9228 (dired path)
9229 (org-open-file path in-emacs line search)))
9231 ((string= type "shell")
9232 (let ((cmd path))
9233 (if (or (not org-confirm-shell-link-function)
9234 (funcall org-confirm-shell-link-function
9236 (org-add-props cmd nil
9237 'face 'org-warning))))
9238 (progn
9239 (message "Executing %s" cmd)
9240 (shell-command cmd))
9241 (error "Abort"))))
9243 ((string= type "elisp")
9244 (let ((cmd path))
9245 (if (or (not org-confirm-elisp-link-function)
9246 (funcall org-confirm-elisp-link-function
9248 (org-add-props cmd nil
9249 'face 'org-warning))))
9250 (message "%s => %s" cmd
9251 (if (equal (string-to-char cmd) ?\()
9252 (eval (read cmd))
9253 (call-interactively (read cmd))))
9254 (error "Abort"))))
9256 ((and (string= type "thisfile")
9257 (run-hook-with-args-until-success
9258 'org-open-link-functions path)))
9260 ((string= type "thisfile")
9261 (if in-emacs
9262 (switch-to-buffer-other-window
9263 (org-get-buffer-for-internal-link (current-buffer)))
9264 (org-mark-ring-push))
9265 (let ((cmd `(org-link-search
9266 ,path
9267 ,(cond ((equal in-emacs '(4)) 'occur)
9268 ((equal in-emacs '(16)) 'org-occur)
9269 (t nil))
9270 ,pos)))
9271 (condition-case nil (eval cmd)
9272 (error (progn (widen) (eval cmd))))))
9274 (t
9275 (browse-url-at-point)))))))
9276 (move-marker org-open-link-marker nil)
9277 (run-hook-with-args 'org-follow-link-hook)))
9279 (defun org-offer-links-in-entry (&optional nth zero)
9280 "Offer links in the current entry and follow the selected link.
9281 If there is only one link, follow it immediately as well.
9282 If NTH is an integer, immediately pick the NTH link found.
9283 If ZERO is a string, check also this string for a link, and if
9284 there is one, offer it as link number zero."
9288 (cnt ?0)
9289 (in-emacs (if (integerp nth) nil nth))
9290 have-zero end links link c)
9291 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9292 (push (match-string 0 zero) links)
9293 (setq cnt (1- cnt) have-zero t))
9294 (save-excursion
9295 (org-back-to-heading t)
9296 (setq end (save-excursion (outline-next-heading) (point)))
9297 (while (re-search-forward re end t)
9298 (push (match-string 0) links))
9299 (setq links (org-uniquify (reverse links))))
9301 (cond
9302 ((null links)
9303 (message "No links"))
9304 ((equal (length links) 1)
9305 (setq link (list (car links))))
9306 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9307 (setq link (nth (if have-zero nth (1- nth)) links)))
9308 (t ; we have to select a link
9309 (save-excursion
9310 (save-window-excursion
9311 (delete-other-windows)
9312 (with-output-to-temp-buffer "*Select Link*"
9313 (mapc (lambda (l)
9314 (if (not (string-match org-bracket-link-regexp l))
9316 (org-remove-angle-brackets l)))
9317 (if (match-end 3)
9319 (match-string 3 l) (match-string 1 l)))
9321 (match-string 1 l))))))
9322 links))
9323 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9324 (message "Select link to open, RET to open all:")
9325 (setq c (read-char-exclusive))
9326 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9327 (when (equal c ?q) (error "Abort"))
9328 (if (equal c ?\C-m)
9329 (setq link links)
9330 (setq nth (- c ?0))
9331 (if have-zero (setq nth (1+ nth)))
9332 (unless (and (integerp nth) (>= (length links) nth))
9333 (error "Invalid link selection"))
9334 (setq link (list (nth (1- nth) links))))))
9335 (if link
9336 (let ((buf (current-buffer)))
9337 (dolist (l link)
9338 (org-open-link-from-string l in-emacs buf))
9339 t)
9340 nil)))
9342 ;; Add special file links that specify the way of opening
9344 (org-add-link-type "file+sys" 'org-open-file-with-system)
9345 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9346 (defun org-open-file-with-system (path)
9347 "Open file at PATH using the system way of opening it."
9348 (org-open-file path 'system))
9349 (defun org-open-file-with-emacs (path)
9350 "Open file at PATH in Emacs."
9351 (org-open-file path 'emacs))
9352 (defun org-remove-file-link-modifiers ()
9353 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9354 (goto-char (point-min))
9356 (org-if-unprotected
9357 (replace-match "file:" t t))))
9358 (eval-after-load "org-exp"
9359 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9360 'org-remove-file-link-modifiers))
9362 ;;;; Time estimates
9364 (defun org-get-effort (&optional pom)
9365 "Get the effort estimate for the current entry."
9366 (org-entry-get pom org-effort-property))
9368 ;;; File search
9370 (defvar org-create-file-search-functions nil
9371 "List of functions to construct the right search string for a file link.
9372 These functions are called in turn with point at the location to
9373 which the link should point.
9375 A function in the hook should first test if it would like to
9376 handle this file type, for example by checking the `major-mode'
9377 or the file extension. If it decides not to handle this file, it
9378 should just return nil to give other functions a chance. If it
9379 does handle the file, it must return the search string to be used
9380 when following the link. The search string will be part of the
9381 file link, given after a double colon, and `org-open-at-point'
9382 will automatically search for it. If special measures must be
9383 taken to make the search successful, another function should be
9384 added to the companion hook `org-execute-file-search-functions',
9385 which see.
9387 A function in this hook may also use `setq' to set the variable
9388 `description' to provide a suggestion for the descriptive text to
9389 be used for this link when it gets inserted into an Org-mode
9392 (defvar org-execute-file-search-functions nil
9393 "List of functions to execute a file search triggered by a link.
9395 Functions added to this hook must accept a single argument, the
9396 search string that was part of the file link, the part after the
9397 double colon. The function must first check if it would like to
9398 handle this search, for example by checking the `major-mode' or
9399 the file extension. If it decides not to handle this search, it
9400 should just return nil to give other functions a chance. If it
9401 does handle the search, it must return a non-nil value to keep
9402 other functions from trying.
9404 Each function can access the current prefix argument through the
9405 variable `current-prefix-argument'. Note that a single prefix is
9406 used to force opening a link in Emacs, so it may be good to only
9407 use a numeric or double prefix to guide the search function.
9409 In case this is needed, a function in this hook can also restore
9410 the window configuration before `org-open-at-point' was called using:
9412 (set-window-configuration org-window-config-before-follow-link)")
9414 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9415 (defun org-link-search (s &optional type avoid-pos)
9416 "Search for a link search option.
9417 If S is surrounded by forward slashes, it is interpreted as a
9418 regular expression. In org-mode files, this will create an `org-occur'
9419 sparse tree. In ordinary files, `occur' will be used to list matches.
9420 If the current buffer is in `dired-mode', grep will be used to search
9421 in all files. If AVOID-POS is given, ignore matches near that position."
9422 (let ((case-fold-search t)
9426 org-emphasis-alist)
9428 (pos (point))
9429 (pre nil) (post nil)
9430 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9431 (cond
9432 ;; First check if there are any special search functions
9433 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9434 ;; Now try the builtin stuff
9435 ((and (equal (string-to-char s0) ?#)
9436 (> (length s0) 1)
9437 (save-excursion
9438 (goto-char (point-min))
9439 (and
9440 (re-search-forward
9442 (setq type 'dedicated
9443 pos (match-beginning 0))))
9444 ;; There is an exact target for this
9445 (goto-char pos)
9446 (org-back-to-heading t)))
9447 ((save-excursion
9448 (goto-char (point-min))
9449 (and
9450 (re-search-forward
9451 (concat "<<" (regexp-quote s0) ">>") nil t)
9452 (setq type 'dedicated
9453 pos (match-beginning 0))))
9454 ;; There is an exact target for this
9455 (goto-char pos))
9457 (save-excursion
9458 (goto-char (point-min))
9459 (and
9460 (re-search-forward
9461 (concat "[^[]" (regexp-quote
9462 (format org-coderef-label-format
9463 (match-string 1 s0))))
9464 nil t)
9465 (setq type 'dedicated
9466 pos (1+ (match-beginning 0))))))
9467 ;; There is a coderef target for this
9468 (goto-char pos))
9470 ;; A regular expression
9471 (cond
9472 ((org-mode-p)
9473 (org-occur (match-string 1 s)))
9474 ;;((eq major-mode 'dired-mode)
9475 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9476 (t (org-do-occur (match-string 1 s)))))
9477 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9478 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9479 (goto-char (point-min))
9480 (cond
9481 ((let (case-fold-search)
9482 (re-search-forward (format org-complex-heading-regexp-format
9483 (regexp-quote s))
9484 nil t))
9485 ;; OK, found a match
9486 (setq type 'dedicated)
9487 (goto-char (match-beginning 0)))
9488 ((and (not org-link-search-inhibit-query)
9489 (eq org-link-search-must-match-exact-headline 'query-to-create)
9490 (y-or-n-p "No match - create this as a new heading? "))
9491 (goto-char (point-max))
9492 (or (bolp) (newline))
9494 (beginning-of-line 0))
9495 (t
9496 (goto-char pos)
9497 (error "No match"))))
9498 (t
9499 ;; A normal search string
9500 (when (equal (string-to-char s) ?*)
9501 ;; Anchor on headlines, post may include tags.
9504 s (substring s 1)))
9505 (remove-text-properties
9506 0 (length s)
9507 '(face nil mouse-face nil keymap nil fontified nil) s)
9508 ;; Make a series of regular expressions to find a match
9517 re4 (concat "[^a-zA-Z_]" re4_)
9519 re1 (concat pre re2 post)
9520 re3 (concat pre (if pre re4_ re4) post)
9521 re5 (concat pre ".*" re4)
9522 re2 (concat pre re2)
9523 re2a (concat pre (if pre re2a_ re2a))
9524 re4 (concat pre (if pre re4_ re4))
9528 ))
9529 (cond
9530 ((eq type 'org-occur) (org-occur reall))
9531 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9532 (t (goto-char (point-min))
9533 (setq type 'fuzzy)
9534 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9535 (org-search-not-self 1 re1 nil t)
9536 (org-search-not-self 1 re2 nil t)
9537 (org-search-not-self 1 re2a nil t)
9538 (org-search-not-self 1 re3 nil t)
9539 (org-search-not-self 1 re4 nil t)
9540 (org-search-not-self 1 re5 nil t)
9541 )
9542 (goto-char (match-beginning 1))
9543 (goto-char pos)
9544 (error "No match"))))))
9545 (and (org-mode-p) (org-show-context 'link-search))
9546 type))
9548 (defun org-search-not-self (group &rest args)
9549 "Execute `re-search-forward', but only accept matches that do not
9550 enclose the position of `org-open-link-marker'."
9551 (let ((m org-open-link-marker))
9552 (catch 'exit
9553 (while (apply 're-search-forward args)
9554 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9555 (goto-char (match-end group))
9556 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9557 (> (match-beginning 0) (marker-position m))
9558 (< (match-end 0) (marker-position m)))
9559 (save-match-data
9560 (or (not (org-in-regexp
9561 org-bracket-link-analytic-regexp 1))
9562 (not (match-end 4)) ; no description
9563 (and (<= (match-beginning 4) (point))
9564 (>= (match-end 4) (point))))))
9565 (throw 'exit (point))))))))
9567 (defun org-get-buffer-for-internal-link (buffer)
9568 "Return a buffer to be used for displaying the link target of internal links."
9569 (cond
9570 ((not org-display-internal-link-with-indirect-buffer)
9571 buffer)
9572 ((string-match "(Clone)$" (buffer-name buffer))
9573 (message "Buffer is already a clone, not making another one")
9574 ;; we also do not modify visibility in this case
9575 buffer)
9576 (t ; make a new indirect buffer for displaying the link
9577 (let* ((bn (buffer-name buffer))
9578 (ibn (concat bn "(Clone)"))
9579 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9580 (with-current-buffer ib (org-overview))
9581 ib))))
9583 (defun org-do-occur (regexp &optional cleanup)
9584 "Call the Emacs command `occur'.
9585 If CLEANUP is non-nil, remove the printout of the regular expression
9586 in the *Occur* buffer. This is useful if the regex is long and not useful
9587 to read."
9588 (occur regexp)
9589 (when cleanup
9590 (let ((cwin (selected-window)) win beg end)
9591 (when (setq win (get-buffer-window "*Occur*"))
9592 (select-window win))
9593 (goto-char (point-min))
9594 (when (re-search-forward "match[a-z]+" nil t)
9595 (setq beg (match-end 0))
9597 (setq end (1- (match-beginning 0)))))
9598 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9599 (goto-char (point-min))
9600 (select-window cwin))))
9602 ;;; The mark ring for links jumps
9604 (defvar org-mark-ring nil
9605 "Mark ring for positions before jumps in Org-mode.")
9606 (defvar org-mark-ring-last-goto nil
9607 "Last position in the mark ring used to go back.")
9608 ;; Fill and close the ring
9609 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9610 (loop for i from 1 to org-mark-ring-length do
9611 (push (make-marker) org-mark-ring))
9612 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9613 org-mark-ring)
9615 (defun org-mark-ring-push (&optional pos buffer)
9616 "Put the current position or POS into the mark ring and rotate it."
9617 (interactive)
9618 (setq pos (or pos (point)))
9619 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9620 (move-marker (car org-mark-ring)
9621 (or pos (point))
9622 (or buffer (current-buffer)))
9623 (message "%s"
9624 (substitute-command-keys
9627 (defun org-mark-ring-goto (&optional n)
9628 "Jump to the previous position in the mark ring.
9629 With prefix arg N, jump back that many stored positions. When
9630 called several times in succession, walk through the entire ring.
9631 Org-mode commands jumping to a different position in the current file,
9632 or to another Org-mode file, automatically push the old position
9633 onto the ring."
9634 (interactive "p")
9635 (let (p m)
9636 (if (eq last-command this-command)
9637 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9638 (setq p org-mark-ring))
9639 (setq org-mark-ring-last-goto p)
9640 (setq m (car p))
9641 (switch-to-buffer (marker-buffer m))
9642 (goto-char m)
9643 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9645 (defun org-remove-angle-brackets (s)
9646 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9647 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9648 s)
9649 (defun org-add-angle-brackets (s)
9650 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9651 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9652 s)
9653 (defun org-remove-double-quotes (s)
9656 s)
9658 ;;; Following specific links
9660 (defun org-follow-timestamp-link ()
9661 (cond
9662 ((org-at-date-range-p t)
9663 (let ((org-agenda-start-on-weekday)
9664 (t1 (match-string 1))
9665 (t2 (match-string 2)))
9666 (setq t1 (time-to-days (org-time-string-to-time t1))
9667 t2 (time-to-days (org-time-string-to-time t2)))
9668 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9669 ((org-at-timestamp-p t)
9670 (org-agenda-list nil (time-to-days (org-time-string-to-time
9671 (substring (match-string 1) 0 10)))
9672 1))
9673 (t (error "This should not happen"))))
9676 ;;; Following file links
9677 (defvar org-wait nil)
9678 (defun org-open-file (path &optional in-emacs line search)
9679 "Open the file at PATH.
9680 First, this expands any special file name abbreviations. Then the
9681 configuration variable `org-file-apps' is checked if it contains an
9682 entry for this file type, and if yes, the corresponding command is launched.
9684 If no application is found, Emacs simply visits the file.
9686 With optional prefix argument IN-EMACS, Emacs will visit the file.
9688 prefix arg, Org tries to avoid opening in Emacs
9689 and to use an external application to visit the file.
9691 Optional LINE specifies a line to go to, optional SEARCH a string
9692 to search for. If LINE or SEARCH is given, the file will be
9693 opened in Emacs, unless an entry from org-file-apps that makes
9694 use of groups in a regexp matches.
9695 If the file does not exist, an error is thrown."
9696 (let* ((file (if (equal path "")
9697 buffer-file-name
9698 (substitute-in-file-name (expand-file-name path))))
9699 (file-apps (append org-file-apps (org-default-apps)))
9700 (apps (org-remove-if
9701 'org-file-apps-entry-match-against-dlink-p file-apps))
9702 (apps-dlink (org-remove-if-not
9703 'org-file-apps-entry-match-against-dlink-p file-apps))
9704 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9705 (dirp (if remp nil (file-directory-p file)))
9706 (file (if (and dirp org-open-directory-means-index-dot-org)
9707 (concat (file-name-as-directory file) "index.org")
9708 file))
9709 (a-m-a-p (assq 'auto-mode apps))
9710 (dfile (downcase file))
9711 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9712 (link (cond ((and (eq line nil)
9713 (eq search nil))
9714 file)
9715 (line
9716 (concat file "::" (number-to-string line)))
9717 (search
9718 (concat file "::" search))))
9719 (dlink (downcase link))
9720 (old-buffer (current-buffer))
9721 (old-pos (point))
9722 (old-mode major-mode)
9723 ext cmd link-match-data)
9725 (setq ext (match-string 1 dfile))
9727 (setq ext (match-string 1 dfile))))
9728 (cond
9729 ((member in-emacs '((16) system))
9730 (setq cmd (cdr (assoc 'system apps))))
9731 (in-emacs (setq cmd 'emacs))
9732 (t
9733 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9734 (and dirp (cdr (assoc 'directory apps)))
9735 ; first, try matching against apps-dlink
9736 ; if we get a match here, store the match data for later
9737 (let ((match (assoc-default dlink apps-dlink
9738 'string-match)))
9739 (if match
9740 (progn (setq link-match-data (match-data))
9741 match)
9742 (progn (setq in-emacs (or in-emacs line search))
9743 nil))) ; if we have no match in apps-dlink,
9744 ; always open the file in emacs if line or search
9745 ; is given (for backwards compatibility)
9746 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9747 'string-match)
9748 (cdr (assoc ext apps))
9749 (cdr (assoc t apps))))))
9750 (when (eq cmd 'system)
9751 (setq cmd (cdr (assoc 'system apps))))
9752 (when (eq cmd 'default)
9753 (setq cmd (cdr (assoc t apps))))
9754 (when (eq cmd 'mailcap)
9755 (require 'mailcap)
9756 (mailcap-parse-mailcaps)
9757 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9758 (command (mailcap-mime-info mime-type)))
9759 (if (stringp command)
9760 (setq cmd command)
9761 (setq cmd 'emacs))))
9762 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9763 (not (file-exists-p file))
9764 (not org-open-non-existing-files))
9765 (error "No such file: %s" file))
9766 (cond
9768 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9770 (setq cmd (replace-match "%s" t t cmd)))
9771 (while (string-match "%s" cmd)
9772 (setq cmd (replace-match
9773 (save-match-data
9774 (shell-quote-argument
9775 (convert-standard-filename file)))
9776 t t cmd)))
9778 ;; Replace "%1", "%2" etc. in command with group matches from regex
9779 (save-match-data
9780 (let ((match-index 1)
9781 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9782 (set-match-data link-match-data)
9783 (while (<= match-index number-of-groups)
9784 (let ((regex (concat "%" (number-to-string match-index)))
9785 (replace-with (match-string match-index dlink)))
9786 (while (string-match regex cmd)
9787 (setq cmd (replace-match replace-with t t cmd))))
9788 (setq match-index (+ match-index 1)))))
9790 (save-window-excursion
9791 (start-process-shell-command cmd nil cmd)
9792 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9793 ))
9794 ((or (stringp cmd)
9795 (eq cmd 'emacs))
9796 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9797 (widen)
9798 (if line (org-goto-line line)
9799 (if search (org-link-search search))))
9800 ((consp cmd)
9801 (let ((file (convert-standard-filename file)))
9802 (save-match-data
9803 (set-match-data link-match-data)
9804 (eval cmd))))
9805 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9806 (and (org-mode-p) (eq old-mode 'org-mode)
9807 (or (not (equal old-buffer (current-buffer)))
9808 (not (equal old-pos (point))))
9809 (org-mark-ring-push old-pos old-buffer))))
9811 (defun org-file-apps-entry-match-against-dlink-p (entry)
9812 "This function returns non-nil if `entry' uses a regular
9813 expression which should be matched against the whole link by
9814 org-open-file.
9816 It assumes that is the case when the entry uses a regular
9817 expression which has at least one grouping construct and the
9818 action is either a lisp form or a command string containing
9819 '%1', i.e. using at least one subexpression match as a
9820 parameter."
9821 (let ((selector (car entry))
9822 (action (cdr entry)))
9823 (if (stringp selector)
9824 (and (> (regexp-opt-depth selector) 0)
9825 (or (and (stringp action)
9826 (string-match "%[0-9]" action))
9827 (consp action)))
9828 nil)))
9830 (defun org-default-apps ()
9831 "Return the default applications for this operating system."
9832 (cond
9833 ((eq system-type 'darwin)
9834 org-file-apps-defaults-macosx)
9835 ((eq system-type 'windows-nt)
9836 org-file-apps-defaults-windowsnt)
9837 (t org-file-apps-defaults-gnu)))
9839 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9840 "Convert extensions to regular expressions in the cars of LIST.
9841 Also, weed out any non-string entries, because the return value is used
9842 only for regexp matching.
9843 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9844 point to the symbol `emacs', indicating that the file should
9845 be opened in Emacs."
9846 (append
9847 (delq nil
9848 (mapcar (lambda (x)
9849 (if (not (stringp (car x)))
9850 nil
9852 x
9854 list))
9855 (if add-auto-mode
9856 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9858 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9859 (defun org-file-remote-p (file)
9860 "Test whether FILE specifies a location on a remote system.
9861 Return non-nil if the location is indeed remote.
9865 (cond ((fboundp 'file-remote-p)
9866 (file-remote-p file))
9867 ((fboundp 'tramp-handle-file-remote-p)
9868 (tramp-handle-file-remote-p file))
9869 ((and (boundp 'ange-ftp-name-format)
9870 (string-match (car ange-ftp-name-format) file))
9871 t)
9872 (t nil)))
9875 ;;;; Refiling
9877 (defun org-get-org-file ()
9878 "Read a filename, with default directory `org-directory'."
9879 (let ((default (or org-default-notes-file remember-data-file)))
9880 (read-file-name (format "File name [%s]: " default)
9881 (file-name-as-directory org-directory)
9882 default)))
9884 (defun org-notes-order-reversed-p ()
9885 "Check if the current file should receive notes in reversed order."
9886 (cond
9887 ((not org-reverse-note-order) nil)
9888 ((eq t org-reverse-note-order) t)
9889 ((not (listp org-reverse-note-order)) nil)
9890 (t (catch 'exit
9891 (let ((all org-reverse-note-order)
9892 entry)
9893 (while (setq entry (pop all))
9894 (if (string-match (car entry) buffer-file-name)
9895 (throw 'exit (cdr entry))))
9896 nil)))))
9898 (defvar org-refile-target-table nil
9899 "The list of refile targets, created by `org-refile'.")
9901 (defvar org-agenda-new-buffers nil
9902 "Buffers created to visit agenda files.")
9904 (defvar org-refile-cache nil
9905 "Cache for refile targets.")
9908 (defvar org-refile-markers nil
9909 "All the markers used for caching refile locations.")
9911 (defun org-refile-marker (pos)
9912 "Get a new refile marker, but only if caching is in use."
9913 (if (not org-refile-use-cache)
9914 pos
9915 (let ((m (make-marker)))
9916 (move-marker m pos)
9917 (push m org-refile-markers)
9918 m)))
9920 (defun org-refile-cache-clear ()
9921 "Clear the refile cache and disable all the markers."
9922 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
9923 (setq org-refile-markers nil)
9924 (setq org-refile-cache nil)
9925 (message "Refile cache has been cleared"))
9927 (defun org-refile-cache-check-set (set)
9928 "Check if all the markers in the cache still have live buffers."
9929 (let (marker)
9930 (catch 'exit
9931 (while (and set (setq marker (nth 3 (pop set))))
9932 ;; if org-refile-use-outline-path is 'file, marker may be nil
9933 (when (and marker (null (marker-buffer marker)))
9934 (message "not found") (sit-for 3)
9935 (throw 'exit nil)))
9936 t)))
9938 (defun org-refile-cache-put (set &rest identifiers)
9939 "Push the refile targets SET into the cache, under IDENTIFIERS."
9940 (let* ((key (sha1 (prin1-to-string identifiers)))
9941 (entry (assoc key org-refile-cache)))
9942 (if entry
9943 (setcdr entry set)
9944 (push (cons key set) org-refile-cache))))
9946 (defun org-refile-cache-get (&rest identifiers)
9947 "Retrieve the cached value for refile targets given by IDENTIFIERS."
9948 (cond
9949 ((not org-refile-cache) nil)
9950 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
9951 (t
9952 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
9953 org-refile-cache))))
9954 (and set (org-refile-cache-check-set set) set)))))
9956 (defun org-get-refile-targets (&optional default-buffer)
9957 "Produce a table with refile targets."
9958 (let ((case-fold-search nil)
9959 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
9960 (entries (or org-refile-targets '((nil . (:level . 1)))))
9961 targets tgs txt re files f desc descre fast-path-p level pos0)
9962 (message "Getting targets...")
9963 (with-current-buffer (or default-buffer (current-buffer))
9964 (while (setq entry (pop entries))
9965 (setq files (car entry) desc (cdr entry))
9966 (setq fast-path-p nil)
9967 (cond
9968 ((null files) (setq files (list (current-buffer))))
9969 ((eq files 'org-agenda-files)
9970 (setq files (org-agenda-files 'unrestricted)))
9971 ((and (symbolp files) (fboundp files))
9972 (setq files (funcall files)))
9973 ((and (symbolp files) (boundp files))
9974 (setq files (symbol-value files))))
9975 (if (stringp files) (setq files (list files)))
9976 (cond
9977 ((eq (car desc) :tag)
9979 ((eq (car desc) :todo)
9981 ((eq (car desc) :regexp)
9982 (setq descre (cdr desc)))
9983 ((eq (car desc) :level)
9985 (if org-odd-levels-only
9986 (1- (* 2 (cdr desc)))
9987 (cdr desc)))
9989 ((eq (car desc) :maxlevel)
9990 (setq fast-path-p t)
9992 (if org-odd-levels-only
9993 (1- (* 2 (cdr desc)))
9994 (cdr desc)))
9996 (t (error "Bad refiling target description %s" desc)))
9997 (while (setq f (pop files))
9998 (with-current-buffer
9999 (if (bufferp f) f (org-get-agenda-file-buffer f))
10000 (or
10001 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10002 (progn
10003 (if (bufferp f) (setq f (buffer-file-name
10004 (buffer-base-buffer f))))
10005 (setq f (and f (expand-file-name f)))
10006 (if (eq org-refile-use-outline-path 'file)
10007 (push (list (file-name-nondirectory f) f nil nil) tgs))
10008 (save-excursion
10009 (save-restriction
10010 (widen)
10011 (goto-char (point-min))
10012 (while (re-search-forward descre nil t)
10013 (goto-char (setq pos0 (point-at-bol)))
10014 (catch 'next
10015 (when org-refile-target-verify-function
10016 (save-match-data
10017 (or (funcall org-refile-target-verify-function)
10018 (throw 'next t))))
10019 (when (looking-at org-complex-heading-regexp)
10020 (setq level (org-reduced-level
10021 (- (match-end 1) (match-beginning 1)))
10022 txt (org-link-display-format (match-string 4))
10024 re (format org-complex-heading-regexp-format
10025 (regexp-quote (match-string 4))))
10026 (when org-refile-use-outline-path
10027 (setq txt (mapconcat
10028 'org-protect-slash
10029 (append
10030 (if (eq org-refile-use-outline-path
10031 'file)
10032 (list (file-name-nondirectory
10033 (buffer-file-name
10034 (buffer-base-buffer))))
10035 (if (eq org-refile-use-outline-path
10036 'full-file-path)
10037 (list (buffer-file-name
10038 (buffer-base-buffer)))))
10039 (org-get-outline-path fast-path-p
10040 level txt)
10041 (list txt))
10042 "/")))
10043 (push (list txt f re (org-refile-marker (point)))
10044 tgs)))
10045 (when (= (point) pos0)
10046 ;; verification function has not moved point
10047 (goto-char (point-at-eol))))))))
10048 (when org-refile-use-cache
10049 (org-refile-cache-put tgs (buffer-file-name) descre))
10050 (setq targets (append tgs targets))
10051 ))))
10052 (message "Getting targets...done")
10053 (nreverse targets)))
10055 (defun org-protect-slash (s)
10056 (while (string-match "/" s)
10058 s)
10060 (defvar org-olpa (make-vector 20 nil))
10062 (defun org-get-outline-path (&optional fastp level heading)
10063 "Return the outline path to the current entry, as a list.
10065 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10066 routine which makes outline path derivations for an entire file,
10067 avoiding backtracing. Refile target collection makes use of that."
10068 (if fastp
10069 (progn
10070 (if (> level 19)
10071 (error "Outline path failure, more than 19 levels"))
10072 (loop for i from level upto 19 do
10073 (aset org-olpa i nil))
10074 (prog1
10075 (delq nil (append org-olpa nil))
10076 (aset org-olpa level heading)))
10077 (let (rtn case-fold-search)
10078 (save-excursion
10079 (save-restriction
10080 (widen)
10081 (while (org-up-heading-safe)
10082 (when (looking-at org-complex-heading-regexp)
10083 (push (org-match-string-no-properties 4) rtn)))
10084 rtn)))))
10086 (defun org-format-outline-path (path &optional width prefix)
10087 "Format the outline path PATH for display.
10088 Width is the maximum number of characters that is available.
10089 Prefix is a prefix to be included in the returned string,
10090 such as the file name."
10091 (setq width (or width 79))
10092 (if prefix (setq width (- width (length prefix))))
10093 (if (not path)
10094 (or prefix "")
10095 (let* ((nsteps (length path))
10096 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10097 (maxwidth (if (<= total-width width)
10098 10000 ;; everything fits
10099 ;; we need to shorten the level headings
10100 (/ (- width nsteps) nsteps)))
10101 (org-odd-levels-only nil)
10102 (n 0)
10103 (total (1+ (length prefix))))
10104 (setq maxwidth (max maxwidth 10))
10105 (concat prefix
10106 (mapconcat
10107 (lambda (h)
10108 (setq n (1+ n))
10109 (if (and (= n nsteps) (< maxwidth 10000))
10110 (setq maxwidth (- total-width total)))
10111 (if (< (length h) maxwidth)
10112 (progn (setq total (+ total (length h) 1)) h)
10113 (setq h (substring h 0 (- maxwidth 2))
10114 total (+ total maxwidth 1))
10116 (setq h (substring h 0 (match-beginning 0))))
10117 (setq h (concat h "..")))
10118 (org-add-props h nil 'face
10119 (nth (% (1- n) org-n-level-faces)
10120 org-level-faces))
10121 h)
10122 path "/")))))
10124 (defun org-display-outline-path (&optional file current)
10125 "Display the current outline path in the echo area."
10126 (interactive "P")
10127 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10128 (case-fold-search nil)
10129 (path (and (org-mode-p) (org-get-outline-path))))
10130 (if current (setq path (append path
10131 (save-excursion
10132 (org-back-to-heading t)
10133 (if (looking-at org-complex-heading-regexp)
10134 (list (match-string 4)))))))
10135 (message "%s"
10136 (org-format-outline-path
10137 path
10138 (1- (frame-width))
10139 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10141 (defvar org-refile-history nil
10142 "History for refiling operations.")
10144 (defvar org-after-refile-insert-hook nil
10145 "Hook run after `org-refile' has inserted its stuff at the new location.
10146 Note that this is still *before* the stuff will be removed from
10147 the *old* location.")
10149 (defvar org-capture-last-stored-marker)
10150 (defun org-refile (&optional goto default-buffer rfloc)
10151 "Move the entry at point to another heading.
10152 The list of target headings is compiled using the information in
10153 `org-refile-targets', which see. This list is created before each use
10154 and will therefore always be up-to-date.
10156 At the target location, the entry is filed as a subitem of the target heading.
10157 Depending on `org-reverse-note-order', the new subitem will either be the
10158 first or the last subitem.
10160 If there is an active region, all entries in that region will be moved.
10161 However, the region must fulfill the requirement that the first heading
10162 is the first one sets the top-level of the moved text - at most siblings
10163 below it are allowed.
10165 With prefix arg GOTO, the command will only visit the target location,
10166 not actually move anything.
10168 go to the location where the last refiling
10169 operation has put the subtree.
10170 With a prefix argument of `2', refile to the running clock.
10172 RFLOC can be a refile location obtained in a different way.
10174 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10176 If you are using target caching (see `org-refile-use-cache'),
10177 You have to clear the target cache in order to find new targets.
10178 This can be done with a 0 prefix: `C-0 C-c C-w'"
10179 (interactive "P")
10180 (if (member goto '(0 (64)))
10181 (org-refile-cache-clear)
10182 (let* ((cbuf (current-buffer))
10183 (regionp (org-region-active-p))
10184 (region-start (and regionp (region-beginning)))
10185 (region-end (and regionp (region-end)))
10186 (region-length (and regionp (- region-end region-start)))
10187 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10188 pos it nbuf file re level reversed)
10189 (setq last-command nil)
10190 (when regionp
10191 (goto-char region-start)
10192 (or (bolp) (goto-char (point-at-bol)))
10193 (setq region-start (point))
10194 (unless (org-kill-is-subtree-p
10195 (buffer-substring region-start region-end))
10196 (error "The region is not a (sequence of) subtree(s)")))
10197 (if (equal goto '(16))
10198 (org-refile-goto-last-stored)
10199 (when (or
10200 (and (equal goto 2)
10201 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10202 (prog1
10203 (setq it (list (or org-clock-heading "running clock")
10204 (buffer-file-name
10205 (marker-buffer org-clock-hd-marker))
10206 ""
10207 (marker-position org-clock-hd-marker)))
10208 (setq goto nil)))
10209 (setq it (or rfloc
10210 (save-excursion
10211 (org-refile-get-location
10212 (if goto "Goto: " "Refile to: ") default-buffer
10213 org-refile-allow-creating-parent-nodes)))))
10214 (setq file (nth 1 it)
10215 re (nth 2 it)
10216 pos (nth 3 it))
10217 (if (and (not goto)
10218 pos
10219 (equal (buffer-file-name) file)
10220 (if regionp
10221 (and (>= pos region-start)
10222 (<= pos region-end))
10223 (and (>= pos (point))
10224 (< pos (save-excursion
10225 (org-end-of-subtree t t))))))
10226 (error "Cannot refile to position inside the tree or region"))
10228 (setq nbuf (or (find-buffer-visiting file)
10229 (find-file-noselect file)))
10230 (if goto
10231 (progn
10232 (switch-to-buffer nbuf)
10233 (goto-char pos)
10234 (org-show-context 'org-goto))
10235 (if regionp
10236 (progn
10237 (org-kill-new (buffer-substring region-start region-end))
10238 (org-save-markers-in-region region-start region-end))
10239 (org-copy-subtree 1 nil t))
10240 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10241 (find-file-noselect file)))
10242 (setq reversed (org-notes-order-reversed-p))
10243 (save-excursion
10244 (save-restriction
10245 (widen)
10246 (if pos
10247 (progn
10248 (goto-char pos)
10249 (looking-at outline-regexp)
10250 (setq level (org-get-valid-level (funcall outline-level) 1))
10251 (goto-char
10252 (if reversed
10253 (or (outline-next-heading) (point-max))
10254 (or (save-excursion (org-get-next-sibling))
10255 (org-end-of-subtree t t)
10256 (point-max)))))
10257 (setq level 1)
10258 (if (not reversed)
10259 (goto-char (point-max))
10260 (goto-char (point-min))
10261 (or (outline-next-heading) (goto-char (point-max)))))
10262 (if (not (bolp)) (newline))
10263 (org-paste-subtree level)
10264 (when org-log-refile
10265 (org-add-log-setup 'refile nil nil 'findpos
10266 org-log-refile)
10267 (unless (eq org-log-refile 'note)
10268 (save-excursion (org-add-log-note))))
10269 (and org-auto-align-tags (org-set-tags nil t))
10270 (bookmark-set "org-refile-last-stored")
10271 ;; If we are refiling for capture, make sure that the
10272 ;; last-capture pointers point here
10273 (when (org-bound-and-true-p org-refile-for-capture)
10274 (bookmark-set "org-capture-last-stored-marker")
10275 (move-marker org-capture-last-stored-marker (point)))
10276 (if (fboundp 'deactivate-mark) (deactivate-mark))
10277 (run-hooks 'org-after-refile-insert-hook))))
10278 (if regionp
10279 (delete-region (point) (+ (point) region-length))
10280 (org-cut-subtree))
10281 (when (featurep 'org-inlinetask)
10282 (org-inlinetask-remove-END-maybe))
10283 (setq org-markers-to-move nil)
10286 (defun org-refile-goto-last-stored ()
10287 "Go to the location where the last refile was stored."
10288 (interactive)
10289 (bookmark-jump "org-refile-last-stored")
10290 (message "This is the location of the last refile"))
10292 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10293 "Prompt the user for a refile location, using PROMPT."
10294 (let ((org-refile-targets org-refile-targets)
10295 (org-refile-use-outline-path org-refile-use-outline-path))
10296 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
10297 (unless org-refile-target-table
10298 (error "No refile targets"))
10299 (let* ((cbuf (current-buffer))
10300 (partial-completion-mode nil)
10301 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10302 (cfunc (if (and org-refile-use-outline-path
10303 org-outline-path-complete-in-steps)
10304 'org-olpath-completing-read
10305 'org-icompleting-read))
10306 (extra (if org-refile-use-outline-path "/" ""))
10307 (filename (and cfn (expand-file-name cfn)))
10308 (tbl (mapcar
10309 (lambda (x)
10310 (if (and (not (member org-refile-use-outline-path
10311 '(file full-file-path)))
10312 (not (equal filename (nth 1 x))))
10313 (cons (concat (car x) extra " ("
10314 (file-name-nondirectory (nth 1 x)) ")")
10315 (cdr x))
10316 (cons (concat (car x) extra) (cdr x))))
10317 org-refile-target-table))
10318 (completion-ignore-case t)
10319 pa answ parent-target child parent old-hist)
10320 (setq old-hist org-refile-history)
10321 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10322 nil 'org-refile-history))
10323 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10324 (org-refile-check-position pa)
10325 (if pa
10326 (progn
10327 (when (or (not org-refile-history)
10328 (not (eq old-hist org-refile-history))
10329 (not (equal (car pa) (car org-refile-history))))
10330 (setq org-refile-history
10331 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10332 org-refile-history
10333 (cdr org-refile-history))))
10334 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10335 (pop org-refile-history)))
10336 pa)
10338 (progn
10339 (setq parent (match-string 1 answ)
10340 child (match-string 2 answ))
10341 (setq parent-target (or (assoc parent tbl)
10342 (assoc (concat parent "/") tbl)))
10343 (when (and parent-target
10344 (or (eq new-nodes t)
10345 (and (eq new-nodes 'confirm)
10347 child)))))
10348 (org-refile-new-child parent-target child)))
10349 (error "Invalid target location")))))
10351 (defun org-refile-check-position (refile-pointer)
10352 "Check if the refile pointer matches the readline to which it points."
10353 (let* ((file (nth 1 refile-pointer))
10354 (re (nth 2 refile-pointer))
10355 (pos (nth 3 refile-pointer))
10356 buffer)
10357 (when (org-string-nw-p re)
10358 (setq buffer (if (markerp pos)
10359 (marker-buffer pos)
10360 (or (find-buffer-visiting file)
10361 (find-file-noselect file))))
10362 (with-current-buffer buffer
10363 (save-excursion
10364 (save-restriction
10365 (widen)
10366 (goto-char pos)
10367 (beginning-of-line 1)
10368 (unless (org-looking-at-p re)
10369 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10371 (defun org-refile-new-child (parent-target child)
10372 "Use refile target PARENT-TARGET to add new CHILD below it."
10373 (unless parent-target
10374 (error "Cannot find parent for new node"))
10375 (let ((file (nth 1 parent-target))
10376 (pos (nth 3 parent-target))
10377 level)
10378 (with-current-buffer (or (find-buffer-visiting file)
10379 (find-file-noselect file))
10380 (save-excursion
10381 (save-restriction
10382 (widen)
10383 (if pos
10384 (goto-char pos)
10385 (goto-char (point-max))
10386 (if (not (bolp)) (newline)))
10387 (when (looking-at outline-regexp)
10388 (setq level (funcall outline-level))
10389 (org-end-of-subtree t t))
10390 (org-back-over-empty-lines)
10392 (if pos (org-get-valid-level level 1) 1) ?*)
10394 (beginning-of-line 0)
10395 (list (concat (car parent-target) "/" child) file "" (point)))))))
10397 (defun org-olpath-completing-read (prompt collection &rest args)
10398 "Read an outline path like a file name."
10399 (let ((thetable collection)
10400 (org-completion-use-ido nil) ; does not work with ido.
10401 (org-completion-use-iswitchb nil)) ; or iswitchb
10402 (apply
10403 'org-icompleting-read prompt
10404 (lambda (string predicate &optional flag)
10405 (let (rtn r f (l (length string)))
10406 (cond
10407 ((eq flag nil)
10408 ;; try completion
10409 (try-completion string thetable))
10410 ((eq flag t)
10411 ;; all-completions
10412 (setq rtn (all-completions string thetable predicate))
10413 (mapcar
10414 (lambda (x)
10415 (setq r (substring x l))
10416 (if (string-match " ([^)]*)$" x)
10417 (setq f (match-string 0 x))
10418 (setq f ""))
10419 (if (string-match "/" r)
10420 (concat string (substring r 0 (match-end 0)) f)
10421 x))
10422 rtn))
10423 ((eq flag 'lambda)
10424 ;; exact match?
10425 (assoc string thetable)))
10426 ))
10427 args)))
10429 ;;;; Dynamic blocks
10431 (defun org-find-dblock (name)
10432 "Find the first dynamic block with name NAME in the buffer.
10433 If not found, stay at current position and return nil."
10434 (let (pos)
10435 (save-excursion
10436 (goto-char (point-min))
10438 nil t)
10439 (match-beginning 0))))
10440 (if pos (goto-char pos))
10441 pos))
10443 (defconst org-dblock-start-re
10445 "Matches the start line of a dynamic block, with parameters.")
10448 "Matches the end of a dynamic block.")
10450 (defun org-create-dblock (plist)
10451 "Create a dynamic block section, with parameters taken from PLIST.
10452 PLIST must contain a :name entry which is used as name of the block."
10454 (end-of-line 1)
10455 (newline))
10456 (let ((col (current-column))
10457 (name (plist-get plist :name)))
10458 (insert "#+BEGIN: " name)
10459 (while plist
10460 (if (eq (car plist) :name)
10461 (setq plist (cddr plist))
10462 (insert " " (prin1-to-string (pop plist)))))
10464 (beginning-of-line -2)))
10466 (defun org-prepare-dblock ()
10467 "Prepare dynamic block for refresh.
10468 This empties the block, puts the cursor at the insert position and returns
10469 the property list including an extra property :name with the block name."
10470 (unless (looking-at org-dblock-start-re)
10471 (error "Not at a dynamic block"))
10472 (let* ((begdel (1+ (match-end 0)))
10473 (name (org-no-properties (match-string 1)))
10474 (params (append (list :name name)
10475 (read (concat "(" (match-string 3) ")")))))
10476 (save-excursion
10477 (beginning-of-line 1)
10479 (setq params (plist-put params :indentation-column (current-column))))
10480 (unless (re-search-forward org-dblock-end-re nil t)
10481 (error "Dynamic block not terminated"))
10482 (setq params
10483 (append params
10484 (list :content (buffer-substring
10485 begdel (match-beginning 0)))))
10486 (delete-region begdel (match-beginning 0))
10487 (goto-char begdel)
10488 (open-line 1)
10489 params))
10491 (defun org-map-dblocks (&optional command)
10492 "Apply COMMAND to all dynamic blocks in the current buffer.
10493 If COMMAND is not given, use `org-update-dblock'."
10494 (let ((cmd (or command 'org-update-dblock)))
10495 (save-excursion
10496 (goto-char (point-min))
10497 (while (re-search-forward org-dblock-start-re nil t)
10498 (goto-char (match-beginning 0))
10499 (save-excursion
10500 (condition-case nil
10501 (funcall cmd)
10502 (error (message "Error during update of dynamic block"))))
10503 (unless (re-search-forward org-dblock-end-re nil t)
10504 (error "Dynamic block not terminated"))))))
10506 (defun org-dblock-update (&optional arg)
10507 "User command for updating dynamic blocks.
10508 Update the dynamic block at point. With prefix ARG, update all dynamic
10509 blocks in the buffer."
10510 (interactive "P")
10511 (if arg
10512 (org-update-all-dblocks)
10513 (or (looking-at org-dblock-start-re)
10514 (org-beginning-of-dblock))
10515 (org-update-dblock)))
10517 (defun org-update-dblock ()
10518 "Update the dynamic block at point.
10519 This means to empty the block, parse for parameters and then call
10520 the correct writing function."
10521 (interactive)
10522 (save-window-excursion
10523 (let* ((pos (point))
10524 (line (org-current-line))
10525 (params (org-prepare-dblock))
10526 (name (plist-get params :name))
10527 (indent (plist-get params :indentation-column))
10528 (cmd (intern (concat "org-dblock-write:" name))))
10529 (message "Updating dynamic block `%s' at line %d..." name line)
10530 (funcall cmd params)
10531 (message "Updating dynamic block `%s' at line %d...done" name line)
10532 (goto-char pos)
10533 (when (and indent (> indent 0))
10534 (setq indent (make-string indent ?\ ))
10535 (save-excursion
10536 (org-beginning-of-dblock)
10537 (forward-line 1)
10538 (while (not (looking-at org-dblock-end-re))
10539 (insert indent)
10540 (beginning-of-line 2))
10541 (when (looking-at org-dblock-end-re)
10543 (replace-match ""))
10544 (insert indent)))))))
10546 (defun org-beginning-of-dblock ()
10547 "Find the beginning of the dynamic block at point.
10548 Error if there is no such block at point."
10549 (let ((pos (point))
10550 beg)
10551 (end-of-line 1)
10552 (if (and (re-search-backward org-dblock-start-re nil t)
10553 (setq beg (match-beginning 0))
10554 (re-search-forward org-dblock-end-re nil t)
10555 (> (match-end 0) pos))
10556 (goto-char beg)
10557 (goto-char pos)
10558 (error "Not in a dynamic block"))))
10560 (defun org-update-all-dblocks ()
10561 "Update all dynamic blocks in the buffer.
10562 This function can be used in a hook."
10563 (interactive)
10564 (when (org-mode-p)
10565 (org-map-dblocks 'org-update-dblock)))
10568 ;;;; Completion
10570 (defconst org-additional-option-like-keywords
10571 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10572 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10573 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10574 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10575 "BEGIN:" "END:"
10576 "ORGTBL" "TBLFM:" "TBLNAME:"
10577 "BEGIN_EXAMPLE" "END_EXAMPLE"
10578 "BEGIN_QUOTE" "END_QUOTE"
10579 "BEGIN_VERSE" "END_VERSE"
10580 "BEGIN_CENTER" "END_CENTER"
10581 "BEGIN_SRC" "END_SRC"
10582 "BEGIN_RESULT" "END_RESULT"
10583 "SOURCE:" "SRCNAME:" "FUNCTION:"
10584 "RESULTS:"
10585 "HEADER:" "HEADERS:"
10586 "BABEL:"
10587 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10588 "CAPTION:" "LABEL:"
10589 "SETUPFILE:"
10590 "INCLUDE:"
10591 "BIND:"
10592 "MACRO:"))
10594 (defcustom org-structure-template-alist
10595 '(
10608 ("L" "#+latex: "
10612 ("H" "#+html: "
10615 ("A" "#+ascii: ")
10616 ("i" "#+include %file ?"
10618 )
10619 "Structure completion elements.
10620 This is a list of abbreviation keys and values. The value gets inserted
10621 if you type `<' followed by the key and then press the completion key,
10622 usually `M-TAB'. %file will be replaced by a file name after prompting
10623 for the file using completion.
10624 There are two templates for each key, the first uses the original Org syntax,
10625 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10626 the default when the /org-mtags.el/ module has been loaded. See also the
10627 variable `org-mtags-prefer-muse-templates'.
10628 This is an experimental feature, it is undecided if it is going to stay in."
10629 :group 'org-completion
10630 :type '(repeat
10631 (string :tag "Key")
10632 (string :tag "Template")
10633 (string :tag "Muse Template")))
10635 (defun org-try-structure-completion ()
10636 "Try to complete a structure template before point.
10638 expands them."
10639 (let ((l (buffer-substring (point-at-bol) (point)))
10640 a)
10643 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10644 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10645 (match-beginning 1)) a)
10646 t)))
10648 (defun org-complete-expand-structure-template (start cell)
10649 "Expand a structure template."
10650 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10651 (rpl (nth (if musep 2 1) cell))
10652 (ind ""))
10653 (delete-region start (point))
10655 (cond
10656 ((bolp))
10658 (setq ind (buffer-substring (point-at-bol) (point))))
10659 (t (newline))))
10660 (setq start (point))
10661 (if (string-match "%file" rpl)
10662 (setq rpl (replace-match
10663 (concat
10665 (save-match-data
10666 (abbreviate-file-name (read-file-name "Include file: ")))
10668 t t rpl)))
10671 (insert rpl)
10674 ;;;; TODO, DEADLINE, Comments
10676 (defun org-toggle-comment ()
10677 "Change the COMMENT state of an entry."
10678 (interactive)
10679 (save-excursion
10680 (org-back-to-heading)
10681 (let (case-fold-search)
10682 (if (looking-at (concat outline-regexp
10684 (replace-match "" t t nil 1)
10685 (if (looking-at outline-regexp)
10686 (progn
10687 (goto-char (match-end 0))
10688 (insert org-comment-string " ")))))))
10690 (defvar org-last-todo-state-is-todo nil
10691 "This is non-nil when the last TODO state change led to a TODO state.
10692 If the last change removed the TODO tag or switched to DONE, then
10693 this is nil.")
10695 (defvar org-setting-tags nil) ; dynamically skipped
10697 (defvar org-todo-setup-filter-hook nil
10698 "Hook for functions that pre-filter todo specs.
10699 Each function takes a todo spec and returns either nil or the spec
10700 transformed into canonical form." )
10702 (defvar org-todo-get-default-hook nil
10703 "Hook for functions that get a default item for todo.
10704 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10705 nil or a string to be used for the todo mark." )
10707 (defvar org-agenda-headline-snapshot-before-repeat)
10709 (defun org-todo (&optional arg)
10710 "Change the TODO state of an item.
10711 The state of an item is given by a keyword at the start of the heading,
10712 like
10713 *** TODO Write paper
10714 *** DONE Call mom
10716 The different keywords are specified in the variable `org-todo-keywords'.
10718 So for this example: when the item starts with TODO, it is changed to DONE.
10719 When it starts with DONE, the DONE is removed. And when neither TODO nor
10720 DONE are present, add TODO at the beginning of the heading.
10723 state.
10724 With numeric prefix arg, switch to that state.
10726 keywords (nextset).
10729 For calling through lisp, arg is also interpreted in the following way:
10730 'none -> empty state
10732 'done -> switch to DONE
10733 'nextset -> switch to the next set of keywords
10734 'previousset -> switch to the previous set of keywords
10736 really is a member of `org-todo-keywords'."
10737 (interactive "P")
10738 (if (equal arg '(16)) (setq arg 'nextset))
10739 (let ((org-blocker-hook org-blocker-hook)
10740 (case-fold-search nil))
10741 (when (equal arg '(64))
10742 (setq arg nil org-blocker-hook nil))
10743 (when (and org-blocker-hook
10744 (or org-inhibit-blocking
10745 (org-entry-get nil "NOBLOCKING")))
10746 (setq org-blocker-hook nil))
10747 (save-excursion
10748 (catch 'exit
10749 (org-back-to-heading t)
10750 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10752 (looking-at " *"))
10753 (let* ((match-data (match-data))
10754 (startpos (point-at-bol))
10755 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10756 (org-log-done org-log-done)
10757 (org-log-repeat org-log-repeat)
10758 (org-todo-log-states org-todo-log-states)
10759 (this (match-string 1))
10760 (hl-pos (match-beginning 0))
10761 (head (org-get-todo-sequence-head this))
10762 (ass (assoc head org-todo-kwd-alist))
10763 (interpret (nth 1 ass))
10764 (done-word (nth 3 ass))
10765 (final-done-word (nth 4 ass))
10766 (last-state (or this ""))
10767 (completion-ignore-case t)
10768 (member (member this org-todo-keywords-1))
10769 (tail (cdr member))
10770 (state (cond
10771 ((and org-todo-key-trigger
10772 (or (and (equal arg '(4))
10773 (eq org-use-fast-todo-selection 'prefix))
10774 (and (not arg) org-use-fast-todo-selection
10775 (not (eq org-use-fast-todo-selection
10776 'prefix)))))
10777 ;; Use fast selection
10778 (org-fast-todo-selection))
10779 ((and (equal arg '(4))
10780 (or (not org-use-fast-todo-selection)
10781 (not org-todo-key-trigger)))
10782 ;; Read a state with completion
10783 (org-icompleting-read
10784 "State: " (mapcar (lambda(x) (list x))
10785 org-todo-keywords-1)
10786 nil t))
10787 ((eq arg 'right)
10788 (if this
10789 (if tail (car tail) nil)
10790 (car org-todo-keywords-1)))
10791 ((eq arg 'left)
10792 (if (equal member org-todo-keywords-1)
10793 nil
10794 (if this
10795 (nth (- (length org-todo-keywords-1)
10796 (length tail) 2)
10797 org-todo-keywords-1)
10798 (org-last org-todo-keywords-1))))
10799 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10800 (setq arg nil))) ; hack to fall back to cycling
10801 (arg
10802 ;; user or caller requests a specific state
10803 (cond
10804 ((equal arg "") nil)
10805 ((eq arg 'none) nil)
10806 ((eq arg 'done) (or done-word (car org-done-keywords)))
10807 ((eq arg 'nextset)
10808 (or (car (cdr (member head org-todo-heads)))
10809 (car org-todo-heads)))
10810 ((eq arg 'previousset)
10811 (let ((org-todo-heads (reverse org-todo-heads)))
10812 (or (car (cdr (member head org-todo-heads)))
10813 (car org-todo-heads))))
10814 ((car (member arg org-todo-keywords-1)))
10815 ((stringp arg)
10816 (error "State `%s' not valid in this file" arg))
10817 ((nth (1- (prefix-numeric-value arg))
10818 org-todo-keywords-1))))
10819 ((null member) (or head (car org-todo-keywords-1)))
10820 ((equal this final-done-word) nil) ;; -> make empty
10821 ((null tail) nil) ;; -> first entry
10822 ((memq interpret '(type priority))
10823 (if (eq this-command last-command)
10824 (car tail)
10825 (if (> (length tail) 0)
10826 (or done-word (car org-done-keywords))
10827 nil)))
10828 (t
10829 (car tail))))
10830 (state (or
10831 (run-hook-with-args-until-success
10832 'org-todo-get-default-hook state last-state)
10833 state))
10834 (next (if state (concat " " state " ") " "))
10835 (change-plist (list :type 'todo-state-change :from this :to state
10836 :position startpos))
10837 dolog now-done-p)
10838 (when org-blocker-hook
10839 (setq org-last-todo-state-is-todo
10840 (not (member this org-done-keywords)))
10841 (unless (save-excursion
10842 (save-match-data
10843 (run-hook-with-args-until-failure
10844 'org-blocker-hook change-plist)))
10845 (if (interactive-p)
10846 (error "TODO state change from %s to %s blocked" this state)
10847 ;; fail silently
10848 (message "TODO state change from %s to %s blocked" this state)
10849 (throw 'exit nil))))
10850 (store-match-data match-data)
10851 (replace-match next t t)
10852 (unless (pos-visible-in-window-p hl-pos)
10853 (message "TODO state changed to %s" (org-trim next)))
10854 (unless head
10855 (setq head (org-get-todo-sequence-head state)
10856 ass (assoc head org-todo-kwd-alist)
10857 interpret (nth 1 ass)
10858 done-word (nth 3 ass)
10859 final-done-word (nth 4 ass)))
10860 (when (memq arg '(nextset previousset))
10861 (message "Keyword-Set %d/%d: %s"
10862 (- (length org-todo-sets) -1
10863 (length (memq (assoc state org-todo-sets) org-todo-sets)))
10864 (length org-todo-sets)
10865 (mapconcat 'identity (assoc state org-todo-sets) " ")))
10866 (setq org-last-todo-state-is-todo
10867 (not (member state org-done-keywords)))
10868 (setq now-done-p (and (member state org-done-keywords)
10869 (not (member this org-done-keywords))))
10870 (and logging (org-local-logging logging))
10871 (when (and (or org-todo-log-states org-log-done)
10872 (not (eq org-inhibit-logging t))
10873 (not (memq arg '(nextset previousset))))
10874 ;; we need to look at recording a time and note
10875 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
10876 (nth 2 (assoc this org-todo-log-states))))
10877 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
10878 (setq dolog 'time))
10879 (when (and state
10880 (member state org-not-done-keywords)
10881 (not (member this org-not-done-keywords)))
10882 ;; This is now a todo state and was not one before
10883 ;; If there was a CLOSED time stamp, get rid of it.
10884 (org-add-planning-info nil nil 'closed))
10885 (when (and now-done-p org-log-done)
10886 ;; It is now done, and it was not done before
10887 (org-add-planning-info 'closed (org-current-time))
10888 (if (and (not dolog) (eq 'note org-log-done))
10889 (org-add-log-setup 'done state this 'findpos 'note)))
10890 (when (and state dolog)
10891 ;; This is a non-nil state, and we need to log it
10892 (org-add-log-setup 'state state this 'findpos dolog)))
10893 ;; Fixup tag positioning
10894 (org-todo-trigger-tag-changes state)
10895 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
10896 (when org-provide-todo-statistics
10897 (org-update-parent-todo-statistics))
10898 (run-hooks 'org-after-todo-state-change-hook)
10899 (if (and arg (not (member state org-done-keywords)))
10900 (setq head (org-get-todo-sequence-head state)))
10901 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
10902 ;; Do we need to trigger a repeat?
10903 (when now-done-p
10904 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
10905 ;; This is for the agenda, take a snapshot of the headline.
10906 (save-match-data
10907 (setq org-agenda-headline-snapshot-before-repeat
10908 (org-get-heading))))
10909 (org-auto-repeat-maybe state))
10910 ;; Fixup cursor location if close to the keyword
10911 (if (and (outline-on-heading-p)
10912 (not (bolp))
10913 (save-excursion (beginning-of-line 1)
10914 (looking-at org-todo-line-regexp))
10915 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
10916 (progn
10917 (goto-char (or (match-end 2) (match-end 1)))
10918 (and (looking-at " ") (just-one-space))))
10919 (when org-trigger-hook
10920 (save-excursion
10921 (run-hook-with-args 'org-trigger-hook change-plist))))))))
10923 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
10924 "Block turning an entry into a TODO, using the hierarchy.
10925 This checks whether the current task should be blocked from state
10926 changes. Such blocking occurs when:
10928 1. The task has children which are not all in a completed state.
10930 2. A task has a parent with the property :ORDERED:, and there
10931 are siblings prior to the current task with incomplete
10932 status.
10934 3. The parent of the task is blocked because it has siblings that should
10935 be done first, or is child of a block grandparent TODO entry."
10937 (if (not org-enforce-todo-dependencies)
10938 t ; if locally turned off don't block
10939 (catch 'dont-block
10940 ;; If this is not a todo state change, or if this entry is already DONE,
10941 ;; do not block
10942 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
10943 (member (plist-get change-plist :from)
10944 (cons 'done org-done-keywords))
10945 (member (plist-get change-plist :to)
10946 (cons 'todo org-not-done-keywords))
10947 (not (plist-get change-plist :to)))
10948 (throw 'dont-block t))
10949 ;; If this task has children, and any are undone, it's blocked
10950 (save-excursion
10951 (org-back-to-heading t)
10952 (let ((this-level (funcall outline-level)))
10953 (outline-next-heading)
10954 (let ((child-level (funcall outline-level)))
10955 (while (and (not (eobp))
10956 (> child-level this-level))
10957 ;; this todo has children, check whether they are all
10958 ;; completed
10959 (if (and (not (org-entry-is-done-p))
10960 (org-entry-is-todo-p))
10961 (throw 'dont-block nil))
10962 (outline-next-heading)
10963 (setq child-level (funcall outline-level))))))
10964 ;; Otherwise, if the task's parent has the :ORDERED: property, and
10965 ;; any previous siblings are undone, it's blocked
10966 (save-excursion
10967 (org-back-to-heading t)
10968 (let* ((pos (point))
10969 (parent-pos (and (org-up-heading-safe) (point))))
10970 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10971 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
10972 (forward-line 1)
10973 (re-search-forward org-not-done-heading-regexp pos t))
10974 (throw 'dont-block nil)) ; block, there is an older sibling not done.
10975 ;; Search further up the hierarchy, to see if an anchestor is blocked
10976 (while t
10977 (goto-char parent-pos)
10978 (if (not (looking-at org-not-done-heading-regexp))
10979 (throw 'dont-block t)) ; do not block, parent is not a TODO
10980 (setq pos (point))
10981 (setq parent-pos (and (org-up-heading-safe) (point)))
10982 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10983 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
10984 (forward-line 1)
10985 (re-search-forward org-not-done-heading-regexp pos t))
10986 (throw 'dont-block nil)))))))) ; block, older sibling not done.
10988 (defcustom org-track-ordered-property-with-tag nil
10989 "Should the ORDERED property also be shown as a tag?
10990 The ORDERED property decides if an entry should require subtasks to be
10991 completed in sequence. Since a property is not very visible, setting
10992 this option means that toggling the ORDERED property with the command
10993 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
10994 not relevant for the behavior, but it makes things more visible.
10996 Note that toggling the tag with tags commands will not change the property
10997 and therefore not influence behavior!
10999 This can be t, meaning the tag ORDERED should be used, It can also be a
11000 string to select a different tag for this task."
11001 :group 'org-todo
11002 :type '(choice
11003 (const :tag "No tracking" nil)
11004 (const :tag "Track with ORDERED tag" t)
11005 (string :tag "Use other tag")))
11007 (defun org-toggle-ordered-property ()
11008 "Toggle the ORDERED property of the current entry.
11009 For better visibility, you can track the value of this property with a tag.
11010 See variable `org-track-ordered-property-with-tag'."
11011 (interactive)
11012 (let* ((t1 org-track-ordered-property-with-tag)
11013 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11014 (save-excursion
11015 (org-back-to-heading)
11016 (if (org-entry-get nil "ORDERED")
11017 (progn
11018 (org-delete-property "ORDERED")
11019 (and tag (org-toggle-tag tag 'off))
11020 (message "Subtasks can be completed in arbitrary order"))
11021 (org-entry-put nil "ORDERED" "t")
11022 (and tag (org-toggle-tag tag 'on))
11023 (message "Subtasks must be completed in sequence")))))
11025 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11026 (defun org-block-todo-from-checkboxes (change-plist)
11027 "Block turning an entry into a TODO, using checkboxes.
11028 This checks whether the current task should be blocked from state
11029 changes because there are unchecked boxes in this entry."
11030 (if (not org-enforce-todo-checkbox-dependencies)
11031 t ; if locally turned off don't block
11032 (catch 'dont-block
11033 ;; If this is not a todo state change, or if this entry is already DONE,
11034 ;; do not block
11035 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11036 (member (plist-get change-plist :from)
11037 (cons 'done org-done-keywords))
11038 (member (plist-get change-plist :to)
11039 (cons 'todo org-not-done-keywords))
11040 (not (plist-get change-plist :to)))
11041 (throw 'dont-block t))
11042 ;; If this task has checkboxes that are not checked, it's blocked
11043 (save-excursion
11044 (org-back-to-heading t)
11045 (let ((beg (point)) end)
11046 (outline-next-heading)
11047 (setq end (point))
11048 (goto-char beg)
11050 end t)
11051 (progn
11052 (if (boundp 'org-blocked-by-checkboxes)
11053 (setq org-blocked-by-checkboxes t))
11054 (throw 'dont-block nil)))))
11055 t))) ; do not block
11057 (defun org-entry-blocked-p ()
11058 "Is the current entry blocked?"
11059 (if (org-entry-get nil "NOBLOCKING")
11060 nil ;; Never block this entry
11061 (not
11062 (run-hook-with-args-until-failure
11063 'org-blocker-hook
11064 (list :type 'todo-state-change
11065 :position (point)
11066 :from 'todo
11067 :to 'done)))))
11069 (defun org-update-statistics-cookies (all)
11070 "Update the statistics cookie, either from TODO or from checkboxes.
11071 This should be called with the cursor in a line with a statistics cookie."
11072 (interactive "P")
11073 (if all
11074 (progn
11075 (org-update-checkbox-count 'all)
11076 (org-map-entries 'org-update-parent-todo-statistics))
11077 (if (not (org-on-heading-p))
11078 (org-update-checkbox-count)
11079 (let ((pos (move-marker (make-marker) (point)))
11080 end l1 l2)
11081 (ignore-errors (org-back-to-heading t))
11082 (if (not (org-on-heading-p))
11083 (org-update-checkbox-count)
11084 (setq l1 (org-outline-level))
11085 (setq end (save-excursion
11086 (outline-next-heading)
11087 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11088 (point)))
11089 (if (and (save-excursion
11090 (re-search-forward
11092 (not (save-excursion (re-search-forward
11094 (org-update-checkbox-count)
11095 (if (and l2 (> l2 l1))
11096 (progn
11097 (goto-char end)
11098 (org-update-parent-todo-statistics))
11099 (goto-char pos)
11100 (beginning-of-line 1)
11101 (while (re-search-forward
11103 (point-at-eol) t)
11104 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11105 (goto-char pos)
11106 (move-marker pos nil)))))
11108 (defvar org-entry-property-inherited-from) ;; defined below
11109 (defun org-update-parent-todo-statistics ()
11110 "Update any statistics cookie in the parent of the current headline.
11111 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11112 the entire subtree and this will travel up the hierarchy and update
11113 statistics everywhere."
11114 (interactive)
11115 (let* ((lim 0) prop
11116 (recursive (or (not org-hierarchical-todo-statistics)
11117 (string-match
11119 (or (setq prop (org-entry-get
11120 nil "COOKIE_DATA" 'inherit)) ""))))
11121 (lim (or (and prop (marker-position
11122 org-entry-property-inherited-from))
11123 lim))
11124 (first t)
11126 level ltoggle l1 new ndel
11127 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
11128 (catch 'exit
11129 (save-excursion
11130 (beginning-of-line 1)
11131 (if (org-at-heading-p)
11132 (setq ltoggle (funcall outline-level))
11133 (error "This should not happen"))
11134 (while (and (setq level (org-up-heading-safe))
11135 (or recursive first)
11136 (>= (point) lim))
11137 (setq first nil cookie-present nil)
11138 (unless (and level
11139 (not (string-match
11141 (downcase
11142 (or (org-entry-get
11143 nil "COOKIE_DATA")
11144 "")))))
11145 (throw 'exit nil))
11146 (while (re-search-forward box-re (point-at-eol) t)
11147 (setq cnt-all 0 cnt-done 0 cookie-present t)
11148 (setq is-percent (match-end 2))
11149 (save-match-data
11150 (unless (outline-next-heading) (throw 'exit nil))
11151 (while (and (looking-at org-complex-heading-regexp)
11152 (> (setq l1 (length (match-string 1))) level))
11153 (setq kwd (and (or recursive (= l1 ltoggle))
11154 (match-string 2)))
11155 (if (or (eq org-provide-todo-statistics 'all-headlines)
11156 (and (listp org-provide-todo-statistics)
11157 (or (member kwd org-provide-todo-statistics)
11158 (member kwd org-done-keywords))))
11159 (setq cnt-all (1+ cnt-all))
11160 (if (eq org-provide-todo-statistics t)
11161 (and kwd (setq cnt-all (1+ cnt-all)))))
11162 (and (member kwd org-done-keywords)
11163 (setq cnt-done (1+ cnt-done)))
11164 (outline-next-heading)))
11165 (setq new
11166 (if is-percent
11167 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11168 (format "[%d/%d]" cnt-done cnt-all))
11169 ndel (- (match-end 0) (match-beginning 0)))
11170 (goto-char (match-beginning 0))
11171 (insert new)
11172 (delete-region (point) (+ (point) ndel)))
11173 (when cookie-present
11174 (run-hook-with-args 'org-after-todo-statistics-hook
11175 cnt-done (- cnt-all cnt-done))))))
11176 (run-hooks 'org-todo-statistics-hook)))
11178 (defvar org-after-todo-statistics-hook nil
11179 "Hook that is called after a TODO statistics cookie has been updated.
11180 Each function is called with two arguments: the number of not-done entries
11181 and the number of done entries.
11183 For example, the following function, when added to this hook, will switch
11184 an entry to DONE when all children are done, and back to TODO when new
11185 entries are set to a TODO status. Note that this hook is only called
11186 when there is a statistics cookie in the headline!
11188 (defun org-summary-todo (n-done n-not-done)
11190 (let (org-log-done org-log-states) ; turn off logging
11192 ")
11194 (defvar org-todo-statistics-hook nil
11195 "Hook that is run whenever Org thinks TODO statistics should be updated.
11196 This hook runs even if there is no statistics cookie present, in which case
11197 `org-after-todo-statistics-hook' would not run.")
11199 (defun org-todo-trigger-tag-changes (state)
11200 "Apply the changes defined in `org-todo-state-tags-triggers'."
11201 (let ((l org-todo-state-tags-triggers)
11202 changes)
11203 (when (or (not state) (equal state ""))
11204 (setq changes (append changes (cdr (assoc "" l)))))
11205 (when (and (stringp state) (> (length state) 0))
11206 (setq changes (append changes (cdr (assoc state l)))))
11207 (when (member state org-not-done-keywords)
11208 (setq changes (append changes (cdr (assoc 'todo l)))))
11209 (when (member state org-done-keywords)
11210 (setq changes (append changes (cdr (assoc 'done l)))))
11211 (dolist (c changes)
11212 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11214 (defun org-local-logging (value)
11215 "Get logging settings from a property VALUE."
11216 (let* (words w a)
11217 ;; directly set the variables, they are already local.
11218 (setq org-log-done nil
11219 org-log-repeat nil
11220 org-todo-log-states nil)
11221 (setq words (org-split-string value))
11222 (while (setq w (pop words))
11223 (cond
11224 ((setq a (assoc w org-startup-options))
11225 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11226 (set (nth 1 a) (nth 2 a))))
11227 ((setq a (org-extract-log-state-settings w))
11228 (and (member (car a) org-todo-keywords-1)
11229 (push a org-todo-log-states)))))))
11231 (defun org-get-todo-sequence-head (kwd)
11232 "Return the head of the TODO sequence to which KWD belongs.
11233 If KWD is not set, check if there is a text property remembering the
11234 right sequence."
11235 (let (p)
11236 (cond
11237 ((not kwd)
11238 (or (get-text-property (point-at-bol) 'org-todo-head)
11239 (progn
11240 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11241 nil (point-at-eol)))
11242 (get-text-property p 'org-todo-head))))
11243 ((not (member kwd org-todo-keywords-1))
11244 (car org-todo-keywords-1))
11245 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11247 (defun org-fast-todo-selection ()
11248 "Fast TODO keyword selection with single keys.
11249 Returns the new TODO keyword, or nil if no state change should occur."
11250 (let* ((fulltable org-todo-key-alist)
11251 (done-keywords org-done-keywords) ;; needed for the faces.
11252 (maxlen (apply 'max (mapcar
11253 (lambda (x)
11254 (if (stringp (car x)) (string-width (car x)) 0))
11255 fulltable)))
11256 (expert nil)
11257 (fwidth (+ maxlen 3 1 3))
11258 (ncol (/ (- (window-width) 4) fwidth))
11259 tg cnt e c tbl
11260 groups ingroup)
11261 (save-excursion
11262 (save-window-excursion
11263 (if expert
11264 (set-buffer (get-buffer-create " *Org todo*"))
11265 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11266 (erase-buffer)
11267 (org-set-local 'org-done-keywords done-keywords)
11268 (setq tbl fulltable cnt 0)
11269 (while (setq e (pop tbl))
11270 (cond
11271 ((equal e '(:startgroup))
11272 (push '() groups) (setq ingroup t)
11273 (when (not (= cnt 0))
11274 (setq cnt 0)
11276 (insert "{ "))
11277 ((equal e '(:endgroup))
11278 (setq ingroup nil cnt 0)
11280 ((equal e '(:newline))
11281 (when (not (= cnt 0))
11282 (setq cnt 0)
11284 (setq e (car tbl))
11285 (while (equal (car tbl) '(:newline))
11287 (setq tbl (cdr tbl)))))
11288 (t
11289 (setq tg (car e) c (cdr e))
11290 (if ingroup (push tg (car groups)))
11291 (setq tg (org-add-props tg nil 'face
11292 (org-get-todo-face tg)))
11293 (if (and (= cnt 0) (not ingroup)) (insert " "))
11294 (insert "[" c "] " tg (make-string
11295 (- fwidth 4 (length tg)) ?\ ))
11296 (when (= (setq cnt (1+ cnt)) ncol)
11298 (if ingroup (insert " "))
11299 (setq cnt 0)))))
11301 (goto-char (point-min))
11302 (if (not expert) (org-fit-window-to-buffer))
11303 (message "[a-z..]:Set [SPC]:clear")
11304 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11305 (cond
11306 ((or (= c ?\C-g)
11307 (and (= c ?q) (not (rassoc c fulltable))))
11308 (setq quit-flag t))
11309 ((= c ?\ ) nil)
11310 ((setq e (rassoc c fulltable) tg (car e))
11311 tg)
11312 (t (setq quit-flag t)))))))
11314 (defun org-entry-is-todo-p ()
11315 (member (org-get-todo-state) org-not-done-keywords))
11317 (defun org-entry-is-done-p ()
11318 (member (org-get-todo-state) org-done-keywords))
11320 (defun org-get-todo-state ()
11321 (save-excursion
11322 (org-back-to-heading t)
11323 (and (looking-at org-todo-line-regexp)
11324 (match-end 2)
11325 (match-string 2))))
11327 (defun org-at-date-range-p (&optional inactive-ok)
11328 "Is the cursor inside a date range?"
11329 (interactive)
11330 (save-excursion
11331 (catch 'exit
11332 (let ((pos (point)))
11334 (skip-chars-backward "<[")
11335 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11336 (>= (match-end 0) pos)
11337 (throw 'exit t))
11339 (skip-chars-backward "<[")
11340 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11341 (>= (match-end 0) pos)
11342 (throw 'exit t)))
11343 nil)))
11345 (defun org-get-repeat (&optional tagline)
11346 "Check if there is a deadline/schedule with repeater in this entry."
11347 (save-match-data
11348 (save-excursion
11349 (org-back-to-heading t)
11350 (and (re-search-forward (if tagline
11352 org-repeat-re)
11353 (org-entry-end-position) t)
11354 (match-string-no-properties 1)))))
11356 (defvar org-last-changed-timestamp)
11357 (defvar org-last-inserted-timestamp)
11358 (defvar org-log-post-message)
11359 (defvar org-log-note-purpose)
11360 (defvar org-log-note-how)
11361 (defvar org-log-note-extra)
11362 (defun org-auto-repeat-maybe (done-word)
11363 "Check if the current headline contains a repeated deadline/schedule.
11364 If yes, set TODO state back to what it was and change the base date
11365 of repeating deadline/scheduled time stamps to new date.
11366 This function is run automatically after each state change to a DONE state."
11367 ;; last-state is dynamically scoped into this function
11368 (let* ((repeat (org-get-repeat))
11369 (aa (assoc last-state org-todo-kwd-alist))
11370 (interpret (nth 1 aa))
11371 (head (nth 2 aa))
11372 (whata '(("d" . day) ("m" . month) ("y" . year)))
11373 (msg "Entry repeats: ")
11374 (org-log-done nil)
11375 (org-todo-log-states nil)
11376 re type n what ts time to-state)
11377 (when repeat
11378 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11379 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11380 org-todo-repeat-to-state))
11381 (unless (and to-state (member to-state org-todo-keywords-1))
11382 (setq to-state (if (eq interpret 'type) last-state head)))
11383 (org-todo to-state)
11384 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11385 (org-entry-put nil "LAST_REPEAT" (format-time-string
11386 (org-time-stamp-format t t))))
11387 (when org-log-repeat
11388 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11389 (memq 'org-add-log-note post-command-hook))
11390 ;; OK, we are already setup for some record
11391 (if (eq org-log-repeat 'note)
11392 ;; make sure we take a note, not only a time stamp
11393 (setq org-log-note-how 'note))
11394 ;; Set up for taking a record
11395 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11396 last-state
11397 'findpos org-log-repeat)))
11398 (org-back-to-heading t)
11399 (org-add-planning-info nil nil 'closed)
11403 (while (re-search-forward
11404 re (save-excursion (outline-next-heading) (point)) t)
11405 (setq type (if (match-end 1) org-scheduled-string
11406 (if (match-end 3) org-deadline-string "Plain:"))
11407 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11409 (setq n (string-to-number (match-string 2 ts))
11410 what (match-string 3 ts))
11411 (if (equal what "w") (setq n (* n 7) what "d"))
11412 ;; Preparation, see if we need to modify the start date for the change
11413 (when (match-end 1)
11414 (setq time (save-match-data (org-time-string-to-time ts)))
11415 (cond
11416 ((equal (match-string 1 ts) ".")
11417 ;; Shift starting date to today
11418 (org-timestamp-change
11419 (- (time-to-days (current-time)) (time-to-days time))
11420 'day))
11421 ((equal (match-string 1 ts) "+")
11422 (let ((nshiftmax 10) (nshift 0))
11423 (while (or (= nshift 0)
11424 (<= (time-to-days time)
11425 (time-to-days (current-time))))
11426 (when (= (incf nshift) nshiftmax)
11427 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11428 (error "Abort")))
11429 (org-timestamp-change n (cdr (assoc what whata)))
11430 (org-at-timestamp-p t)
11431 (setq ts (match-string 1))
11432 (setq time (save-match-data (org-time-string-to-time ts)))))
11433 (org-timestamp-change (- n) (cdr (assoc what whata)))
11434 ;; rematch, so that we have everything in place for the real shift
11435 (org-at-timestamp-p t)
11436 (setq ts (match-string 1))
11438 (org-timestamp-change n (cdr (assoc what whata)))
11439 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11440 (setq org-log-post-message msg)
11441 (message "%s" msg))))
11443 (defun org-show-todo-tree (arg)
11444 "Make a compact tree which shows all headlines marked with TODO.
11445 The tree will show the lines where the regexp matches, and all higher
11446 headlines above the match.
11448 With a numeric prefix N, construct a sparse tree for the Nth element
11449 of `org-todo-keywords-1'."
11450 (interactive "P")
11451 (let ((case-fold-search nil)
11452 (kwd-re
11453 (cond ((null arg) org-not-done-regexp)
11454 ((equal arg '(4))
11455 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11456 (mapcar 'list org-todo-keywords-1))))
11460 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11461 (regexp-quote (nth (1- (prefix-numeric-value arg))
11462 org-todo-keywords-1)))
11463 (t (error "Invalid prefix argument: %s" arg)))))
11464 (message "%d TODO entries found"
11465 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
11467 (defun org-deadline (&optional remove time)
11469 With argument REMOVE, remove any deadline from the item.
11470 When TIME is set, it should be an internal time specification, and the
11471 scheduling will use the corresponding date."
11472 (interactive "P")
11473 (let* ((old-date (org-entry-get nil "DEADLINE"))
11474 (repeater (and old-date
11476 (match-string 1 old-date))))
11477 (if remove
11478 (progn
11479 (when (and old-date org-log-redeadline)
11480 (org-add-log-setup 'deldeadline nil old-date 'findpos
11481 org-log-redeadline))
11482 (org-remove-timestamp-with-keyword org-deadline-string)
11483 (message "Item no longer has a deadline."))
11484 (org-add-planning-info 'deadline time 'closed)
11485 (when (and old-date org-log-redeadline
11486 (not (equal old-date
11487 (substring org-last-inserted-timestamp 1 -1))))
11488 (org-add-log-setup 'redeadline nil old-date 'findpos
11489 org-log-redeadline))
11490 (when repeater
11491 (save-excursion
11492 (org-back-to-heading t)
11493 (when (re-search-forward (concat org-deadline-string " "
11494 org-last-inserted-timestamp)
11495 (save-excursion
11496 (outline-next-heading) (point)) t)
11497 (goto-char (1- (match-end 0)))
11498 (insert " " repeater)
11499 (setq org-last-inserted-timestamp
11500 (concat (substring org-last-inserted-timestamp 0 -1)
11501 " " repeater
11502 (substring org-last-inserted-timestamp -1))))))
11503 (message "Deadline on %s" org-last-inserted-timestamp))))
11505 (defun org-schedule (&optional remove time)
11506 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11507 With argument REMOVE, remove any scheduling date from the item.
11508 When TIME is set, it should be an internal time specification, and the
11509 scheduling will use the corresponding date."
11510 (interactive "P")
11511 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11512 (repeater (and old-date
11514 (match-string 1 old-date))))
11515 (if remove
11516 (progn
11517 (when (and old-date org-log-reschedule)
11518 (org-add-log-setup 'delschedule nil old-date 'findpos
11519 org-log-reschedule))
11520 (org-remove-timestamp-with-keyword org-scheduled-string)
11521 (message "Item is no longer scheduled."))
11522 (org-add-planning-info 'scheduled time 'closed)
11523 (when (and old-date org-log-reschedule
11524 (not (equal old-date
11525 (substring org-last-inserted-timestamp 1 -1))))
11526 (org-add-log-setup 'reschedule nil old-date 'findpos
11527 org-log-reschedule))
11528 (when repeater
11529 (save-excursion
11530 (org-back-to-heading t)
11531 (when (re-search-forward (concat org-scheduled-string " "
11532 org-last-inserted-timestamp)
11533 (save-excursion
11534 (outline-next-heading) (point)) t)
11535 (goto-char (1- (match-end 0)))
11536 (insert " " repeater)
11537 (setq org-last-inserted-timestamp
11538 (concat (substring org-last-inserted-timestamp 0 -1)
11539 " " repeater
11540 (substring org-last-inserted-timestamp -1))))))
11541 (message "Scheduled to %s" org-last-inserted-timestamp))))
11543 (defun org-get-scheduled-time (pom &optional inherit)
11544 "Get the scheduled time as a time tuple, of a format suitable
11545 for calling org-schedule with, or if there is no scheduling,
11546 returns nil."
11547 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11548 (when time
11549 (apply 'encode-time (org-parse-time-string time)))))
11551 (defun org-get-deadline-time (pom &optional inherit)
11552 "Get the deadline as a time tuple, of a format suitable for
11553 calling org-deadline with, or if there is no scheduling, returns
11554 nil."
11555 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11556 (when time
11557 (apply 'encode-time (org-parse-time-string time)))))
11559 (defun org-remove-timestamp-with-keyword (keyword)
11560 "Remove all time stamps with KEYWORD in the current entry."
11562 beg)
11563 (save-excursion
11564 (org-back-to-heading t)
11565 (setq beg (point))
11566 (outline-next-heading)
11567 (while (re-search-backward re beg t)
11568 (replace-match "")
11570 (equal (char-before) ?\ ))
11571 (backward-delete-char 1)
11573 (point-at-bol) (point-at-eol)))
11574 (delete-region (point-at-bol)
11575 (min (point-max) (1+ (point-at-eol))))))))))
11577 (defun org-add-planning-info (what &optional time &rest remove)
11578 "Insert new timestamp with keyword in the line directly after the headline.
11579 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11580 If non is given, the user is prompted for a date.
11581 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11582 be removed."
11583 (interactive)
11584 (let (org-time-was-given org-end-time-was-given ts
11585 end default-time default-input)
11587 (catch 'exit
11588 (when (and (not time) (memq what '(scheduled deadline)))
11589 ;; Try to get a default date/time from existing timestamp
11590 (save-excursion
11591 (org-back-to-heading t)
11592 (setq end (save-excursion (outline-next-heading) (point)))
11593 (when (re-search-forward (if (eq what 'scheduled)
11594 org-scheduled-time-regexp
11595 org-deadline-time-regexp)
11596 end t)
11597 (setq ts (match-string 1)
11598 default-time
11599 (apply 'encode-time (org-parse-time-string ts))
11600 default-input (and ts (org-get-compact-tod ts))))))
11601 (when what
11602 ;; If necessary, get the time from the user
11603 (setq time (or time (org-read-date nil 'to-time nil nil
11604 default-time default-input))))
11606 (when (and org-insert-labeled-timestamps-at-point
11607 (member what '(scheduled deadline)))
11608 (insert
11609 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11610 (org-insert-time-stamp time org-time-was-given
11611 nil nil nil (list org-end-time-was-given))
11612 (setq what nil))
11613 (save-excursion
11614 (save-restriction
11615 (let (col list elt ts buffer-invisibility-spec)
11616 (org-back-to-heading t)
11618 (goto-char (match-end 1))
11619 (setq col (current-column))
11620 (goto-char (match-end 0))
11622 (when (and (not what)
11623 (not (looking-at
11625 org-keyword-time-not-clock-regexp))))
11626 ;; Nothing to add, nothing to remove...... :-)
11627 (throw 'exit nil))
11628 (if (and (not (looking-at outline-regexp))
11631 (not (equal (match-string 1) org-clock-string)))
11632 (narrow-to-region (match-beginning 0) (match-end 0))
11634 (backward-char 1)
11635 (narrow-to-region (point) (point))
11636 (and org-adapt-indentation (org-indent-to-column col)))
11637 ;; Check if we have to remove something.
11638 (setq list (cons what remove))
11639 (while list
11640 (setq elt (pop list))
11641 (goto-char (point-min))
11642 (when (or (and (eq elt 'scheduled)
11643 (re-search-forward org-scheduled-time-regexp nil t))
11644 (and (eq elt 'deadline)
11645 (re-search-forward org-deadline-time-regexp nil t))
11646 (and (eq elt 'closed)
11647 (re-search-forward org-closed-time-regexp nil t)))
11648 (replace-match "")
11649 (if (looking-at "--+<[^>]+>") (replace-match ""))
11650 (skip-chars-backward " ")
11651 (if (looking-at " +") (replace-match ""))))
11652 (goto-char (point-max))
11653 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11654 (when what
11655 (insert
11656 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11657 (cond ((eq what 'scheduled) org-scheduled-string)
11658 ((eq what 'deadline) org-deadline-string)
11659 ((eq what 'closed) org-closed-string))
11660 " ")
11661 (setq ts (org-insert-time-stamp
11662 time
11663 (or org-time-was-given
11664 (and (eq what 'closed) org-log-done-with-time))
11665 (eq what 'closed)
11666 nil nil (list org-end-time-was-given)))
11667 (end-of-line 1))
11668 (goto-char (point-min))
11669 (widen)
11672 (delete-region (1- (point)) (point-at-eol)))
11673 ts))))))
11675 (defvar org-log-note-marker (make-marker))
11676 (defvar org-log-note-purpose nil)
11677 (defvar org-log-note-state nil)
11678 (defvar org-log-note-previous-state nil)
11679 (defvar org-log-note-how nil)
11680 (defvar org-log-note-extra nil)
11681 (defvar org-log-note-window-configuration nil)
11682 (defvar org-log-note-return-to (make-marker))
11683 (defvar org-log-post-message nil
11684 "Message to be displayed after a log note has been stored.
11685 The auto-repeater uses this.")
11687 (defun org-add-note ()
11688 "Add a note to the current entry.
11689 This is done in the same way as adding a state change note."
11690 (interactive)
11691 (org-add-log-setup 'note nil nil 'findpos nil))
11693 (defvar org-property-end-re)
11694 (defun org-add-log-setup (&optional purpose state prev-state
11695 findpos how extra)
11696 "Set up the post command hook to take a note.
11697 If this is about to TODO state change, the new state is expected in STATE.
11698 When FINDPOS is non-nil, find the correct position for the note in
11699 the current entry. If not, assume that it can be inserted at point.
11700 HOW is an indicator what kind of note should be created.
11701 EXTRA is additional text that will be inserted into the notes buffer."
11702 (let* ((org-log-into-drawer (org-log-into-drawer))
11703 (drawer (cond ((stringp org-log-into-drawer)
11704 org-log-into-drawer)
11705 (org-log-into-drawer "LOGBOOK")
11706 (t nil))))
11707 (save-restriction
11708 (save-excursion
11709 (when findpos
11710 (org-back-to-heading t)
11711 (narrow-to-region (point) (save-excursion
11712 (outline-next-heading) (point)))
11716 (goto-char (match-end 0))
11717 (cond
11718 (drawer
11720 nil t)
11721 (progn
11722 (goto-char (match-end 0))
11723 (or org-log-states-order-reversed
11724 (and (re-search-forward org-property-end-re nil t)
11725 (goto-char (1- (match-beginning 0))))))
11727 (beginning-of-line 0)
11728 (org-indent-line-function)
11729 (beginning-of-line 2)
11730 (org-indent-line-function)
11731 (end-of-line 0)))
11732 ((and org-log-state-notes-insert-after-drawers
11733 (save-excursion
11734 (forward-line) (looking-at org-drawer-regexp)))
11735 (forward-line)
11736 (while (looking-at org-drawer-regexp)
11737 (goto-char (match-end 0))
11738 (re-search-forward org-property-end-re (point-max) t)
11739 (forward-line))
11740 (forward-line -1)))
11741 (unless org-log-states-order-reversed
11743 (org-skip-over-state-notes)
11745 (move-marker org-log-note-marker (point))
11746 (setq org-log-note-purpose purpose
11747 org-log-note-state state
11748 org-log-note-previous-state prev-state
11749 org-log-note-how how
11750 org-log-note-extra extra)
11751 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11753 (defun org-skip-over-state-notes ()
11754 "Skip past the list of State notes in an entry."
11756 (when (org-in-item-p)
11757 (let ((limit (org-list-bottom-point)))
11759 (goto-char (or (org-get-next-item (point) limit)
11760 (org-get-end-of-item limit)))))))
11762 (defun org-add-log-note (&optional purpose)
11763 "Pop up a window for taking a note, and add this note later at point."
11764 (remove-hook 'post-command-hook 'org-add-log-note)
11765 (setq org-log-note-window-configuration (current-window-configuration))
11766 (delete-other-windows)
11767 (move-marker org-log-note-return-to (point))
11768 (switch-to-buffer (marker-buffer org-log-note-marker))
11769 (goto-char org-log-note-marker)
11770 (org-switch-to-buffer-other-window "*Org Note*")
11771 (erase-buffer)
11772 (if (memq org-log-note-how '(time state))
11773 (let (current-prefix-arg) (org-store-log-note))
11774 (let ((org-inhibit-startup t)) (org-mode))
11775 (insert (format "# Insert note for %s.
11777 (cond
11778 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11779 ((eq org-log-note-purpose 'done) "closed todo item")
11780 ((eq org-log-note-purpose 'state)
11782 (or org-log-note-previous-state "")
11783 (or org-log-note-state "")))
11784 ((eq org-log-note-purpose 'reschedule)
11785 "rescheduling")
11786 ((eq org-log-note-purpose 'delschedule)
11787 "no longer scheduled")
11788 ((eq org-log-note-purpose 'redeadline)
11789 "changing deadline")
11790 ((eq org-log-note-purpose 'deldeadline)
11791 "removing deadline")
11792 ((eq org-log-note-purpose 'refile)
11793 "refiling")
11794 ((eq org-log-note-purpose 'note)
11795 "this entry")
11796 (t (error "This should not happen")))))
11797 (if org-log-note-extra (insert org-log-note-extra))
11798 (org-set-local 'org-finish-function 'org-store-log-note)))
11800 (defvar org-note-abort nil) ; dynamically scoped
11801 (defun org-store-log-note ()
11802 "Finish taking a log note, and insert it to where it belongs."
11803 (let ((txt (buffer-string))
11804 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11805 lines ind bul)
11806 (kill-buffer (current-buffer))
11808 (setq txt (replace-match "" t t txt)))
11810 (setq txt (replace-match "" t t txt)))
11813 (setq note
11814 (org-replace-escapes
11815 note
11816 (list (cons "%u" (user-login-name))
11817 (cons "%U" user-full-name)
11818 (cons "%t" (format-time-string
11819 (org-time-stamp-format 'long 'inactive)
11820 (current-time)))
11821 (cons "%T" (format-time-string
11822 (org-time-stamp-format 'long nil)
11823 (current-time)))
11824 (cons "%s" (if org-log-note-state
11826 ""))
11827 (cons "%S" (if org-log-note-previous-state
11831 (push note lines))
11832 (when (or current-prefix-arg org-note-abort)
11833 (when org-log-into-drawer
11834 (org-remove-empty-drawer-at
11835 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11836 org-log-note-marker))
11837 (setq lines nil))
11838 (when lines
11839 (with-current-buffer (marker-buffer org-log-note-marker)
11840 (save-excursion
11841 (goto-char org-log-note-marker)
11842 (move-marker org-log-note-marker nil)
11843 (end-of-line 1)
11845 (setq ind (save-excursion
11846 (if (org-in-item-p)
11847 (progn
11848 (goto-char (org-list-top-point))
11849 (org-get-indentation))
11851 (cond
11852 ((and (org-at-heading-p)
11853 org-adapt-indentation)
11854 (1+ (org-current-level)))
11855 ((org-at-heading-p) 0)
11856 (t (org-get-indentation))))))
11857 (setq bul (org-list-bullet-string "-"))
11858 (org-indent-line-to ind)
11859 (insert bul (pop lines))
11860 (let ((ind-body (+ (length bul) ind)))
11861 (while lines
11863 (org-indent-line-to ind-body)
11864 (insert (pop lines))))
11865 (message "Note stored")
11866 (org-back-to-heading t)
11867 (org-cycle-hide-drawers 'children)))))
11868 (set-window-configuration org-log-note-window-configuration)
11869 (with-current-buffer (marker-buffer org-log-note-return-to)
11870 (goto-char org-log-note-return-to))
11871 (move-marker org-log-note-return-to nil)
11872 (and org-log-post-message (message "%s" org-log-post-message)))
11874 (defun org-remove-empty-drawer-at (drawer pos)
11875 "Remove an empty drawer DRAWER at position POS.
11876 POS may also be a marker."
11877 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
11878 (save-excursion
11879 (save-restriction
11880 (widen)
11881 (goto-char pos)
11882 (if (org-in-regexp
11884 (replace-match ""))))))
11886 (defun org-sparse-tree (&optional arg)
11887 "Create a sparse tree, prompt for the details.
11888 This command can create sparse trees. You first need to select the type
11889 of match used to create the tree:
11891 t Show all TODO entries.
11892 T Show entries with a specific TODO keyword.
11893 m Show entries selected by a tags/property match.
11894 p Enter a property name and its value (both with completion on existing
11895 names/values) and show entries with that property.
11896 r Show entries matching a regular expression (`/' can be used as well)
11897 d Show deadlines due within `org-deadline-warning-days'.
11898 b Show deadlines and scheduled items before a date.
11899 a Show deadlines and scheduled items after a date."
11900 (interactive "P")
11901 (let (ans kwd value)
11902 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
11903 (setq ans (read-char-exclusive))
11904 (cond
11905 ((equal ans ?d)
11906 (call-interactively 'org-check-deadlines))
11907 ((equal ans ?b)
11908 (call-interactively 'org-check-before-date))
11909 ((equal ans ?a)
11910 (call-interactively 'org-check-after-date))
11911 ((equal ans ?t)
11912 (org-show-todo-tree nil))
11913 ((equal ans ?T)
11914 (org-show-todo-tree '(4)))
11915 ((member ans '(?T ?m))
11916 (call-interactively 'org-match-sparse-tree))
11917 ((member ans '(?p ?P))
11918 (setq kwd (org-icompleting-read "Property: "
11919 (mapcar 'list (org-buffer-property-keys))))
11920 (setq value (org-icompleting-read "Value: "
11921 (mapcar 'list (org-property-values kwd))))
11924 (org-match-sparse-tree arg (concat kwd "=" value)))
11925 ((member ans '(?r ?R ?/))
11926 (call-interactively 'org-occur))
11929 (defvar org-occur-highlights nil
11930 "List of overlays used for occur matches.")
11931 (make-variable-buffer-local 'org-occur-highlights)
11932 (defvar org-occur-parameters nil
11933 "Parameters of the active org-occur calls.
11934 This is a list, each call to org-occur pushes as cons cell,
11935 containing the regular expression and the callback, onto the list.
11936 The list can contain several entries if `org-occur' has been called
11937 several time with the KEEP-PREVIOUS argument. Otherwise, this list
11938 will only contain one set of parameters. When the highlights are
11939 removed (for example with `C-c C-c', or with the next edit (depending
11940 on `org-remove-highlights-with-change'), this variable is emptied
11941 as well.")
11942 (make-variable-buffer-local 'org-occur-parameters)
11944 (defun org-occur (regexp &optional keep-previous callback)
11945 "Make a compact tree which shows all matches of REGEXP.
11946 The tree will show the lines where the regexp matches, and all higher
11947 headlines above the match. It will also show the heading after the match,
11948 to make sure editing the matching entry is easy.
11949 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
11950 call to `org-occur' will be kept, to allow stacking of calls to this
11951 command.
11952 If CALLBACK is non-nil, it is a function which is called to confirm
11953 that the match should indeed be shown."
11955 (when (equal regexp "")
11956 (error "Regexp cannot be empty"))
11957 (unless keep-previous
11958 (org-remove-occur-highlights nil nil t))
11959 (push (cons regexp callback) org-occur-parameters)
11960 (let ((cnt 0))
11961 (save-excursion
11962 (goto-char (point-min))
11963 (if (or (not keep-previous) ; do not want to keep
11964 (not org-occur-highlights)) ; no previous matches
11965 ;; hide everything
11966 (org-overview))
11967 (while (re-search-forward regexp nil t)
11968 (when (or (not callback)
11969 (save-match-data (funcall callback)))
11970 (setq cnt (1+ cnt))
11971 (when org-highlight-sparse-tree-matches
11972 (org-highlight-new-match (match-beginning 0) (match-end 0)))
11973 (org-show-context 'occur-tree))))
11974 (when org-remove-highlights-with-change
11975 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
11976 nil 'local))
11977 (unless org-sparse-tree-open-archived-trees
11978 (org-hide-archived-subtrees (point-min) (point-max)))
11979 (run-hooks 'org-occur-hook)
11980 (if (interactive-p)
11981 (message "%d match(es) for regexp %s" cnt regexp))
11982 cnt))
11984 (defun org-occur-next-match (&optional n reset)
11985 "Function for `next-error-function' to find sparse tree matches.
11986 N is the number of matches to move, when negative move backwards.
11987 RESET is entirely ignored - this function always goes back to the
11988 starting point when no match is found."
11989 (let* ((limit (if (< n 0) (point-min) (point-max)))
11990 (search-func (if (< n 0)
11991 'previous-single-char-property-change
11992 'next-single-char-property-change))
11993 (n (abs n))
11994 (pos (point))
11995 p1)
11996 (catch 'exit
11997 (while (setq p1 (funcall search-func (point) 'org-type))
11998 (when (equal p1 limit)
11999 (goto-char pos)
12000 (error "No more matches"))
12001 (when (equal (get-char-property p1 'org-type) 'org-occur)
12002 (setq n (1- n))
12003 (when (= n 0)
12004 (goto-char p1)
12005 (throw 'exit (point))))
12006 (goto-char p1))
12007 (goto-char p1)
12008 (error "No more matches"))))
12010 (defun org-show-context (&optional key)
12011 "Make sure point and context are visible.
12012 How much context is shown depends upon the variables
12013 `org-show-hierarchy-above', `org-show-following-heading'. and
12014 `org-show-siblings'."
12015 (let ((heading-p (org-on-heading-p t))
12016 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12017 (following-p (org-get-alist-option org-show-following-heading key))
12018 (entry-p (org-get-alist-option org-show-entry-below key))
12019 (siblings-p (org-get-alist-option org-show-siblings key)))
12020 (catch 'exit
12021 ;; Show heading or entry text
12022 (if (and heading-p (not entry-p))
12023 (org-flag-heading nil) ; only show the heading
12024 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12025 (org-show-hidden-entry))) ; show entire entry
12026 (when following-p
12027 ;; Show next sibling, or heading below text
12028 (save-excursion
12029 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12030 (org-flag-heading nil))))
12031 (when siblings-p (org-show-siblings))
12032 (when hierarchy-p
12033 ;; show all higher headings, possibly with siblings
12034 (save-excursion
12035 (while (and (condition-case nil
12036 (progn (org-up-heading-all 1) t)
12037 (error nil))
12038 (not (bobp)))
12039 (org-flag-heading nil)
12040 (when siblings-p (org-show-siblings))))))))
12042 (defvar org-reveal-start-hook nil
12043 "Hook run before revealing a location.")
12045 (defun org-reveal (&optional siblings)
12046 "Show current entry, hierarchy above it, and the following headline.
12047 This can be used to show a consistent set of context around locations
12048 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12049 not t for the search context.
12051 With optional argument SIBLINGS, on each level of the hierarchy all
12052 siblings are shown. This repairs the tree structure to what it would
12053 look like when opened with hierarchical calls to `org-cycle'.
12055 go to the parent and show the
12056 entire tree."
12057 (interactive "P")
12058 (run-hooks 'org-reveal-start-hook)
12059 (let ((org-show-hierarchy-above t)
12060 (org-show-following-heading t)
12061 (org-show-siblings (if siblings t org-show-siblings)))
12062 (org-show-context nil))
12063 (when (equal siblings '(16))
12064 (save-excursion
12065 (when (org-up-heading-safe)
12066 (org-show-subtree)
12067 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12069 (defun org-highlight-new-match (beg end)
12070 "Highlight from BEG to END and mark the highlight is an occur headline."
12071 (let ((ov (make-overlay beg end)))
12072 (overlay-put ov 'face 'secondary-selection)
12073 (overlay-put ov 'org-type 'org-occur)
12074 (push ov org-occur-highlights)))
12076 (defun org-remove-occur-highlights (&optional beg end noremove)
12077 "Remove the occur highlights from the buffer.
12078 BEG and END are ignored. If NOREMOVE is nil, remove this function
12079 from the `before-change-functions' in the current buffer."
12080 (interactive)
12081 (unless org-inhibit-highlight-removal
12082 (mapc 'delete-overlay org-occur-highlights)
12083 (setq org-occur-highlights nil)
12084 (setq org-occur-parameters nil)
12085 (unless noremove
12086 (remove-hook 'before-change-functions
12087 'org-remove-occur-highlights 'local))))
12089 ;;;; Priorities
12092 "Regular expression matching the priority indicator.")
12094 (defvar org-remove-priority-next-time nil)
12096 (defun org-priority-up ()
12097 "Increase the priority of the current item."
12098 (interactive)
12099 (org-priority 'up))
12101 (defun org-priority-down ()
12102 "Decrease the priority of the current item."
12103 (interactive)
12104 (org-priority 'down))
12106 (defun org-priority (&optional action)
12107 "Change the priority of an item by ARG.
12108 ACTION can be `set', `up', `down', or a character."
12109 (interactive)
12110 (unless org-enable-priority-commands
12111 (error "Priority commands are disabled"))
12112 (setq action (or action 'set))
12113 (let (current new news have remove)
12114 (save-excursion
12115 (org-back-to-heading t)
12116 (if (looking-at org-priority-regexp)
12117 (setq current (string-to-char (match-string 2))
12118 have t)
12119 (setq current org-default-priority))
12120 (cond
12121 ((eq action 'remove)
12122 (setq remove t new ?\ ))
12123 ((or (eq action 'set)
12124 (if (featurep 'xemacs) (characterp action) (integerp action)))
12125 (if (not (eq action 'set))
12126 (setq new action)
12127 (message "Priority %c-%c, SPC to remove: "
12128 org-highest-priority org-lowest-priority)
12129 (save-match-data
12130 (setq new (read-char-exclusive))))
12131 (if (and (= (upcase org-highest-priority) org-highest-priority)
12132 (= (upcase org-lowest-priority) org-lowest-priority))
12133 (setq new (upcase new)))
12134 (cond ((equal new ?\ ) (setq remove t))
12135 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12136 (error "Priority must be between `%c' and `%c'"
12137 org-highest-priority org-lowest-priority))))
12138 ((eq action 'up)
12139 (if (and (not have) (eq last-command this-command))
12140 (setq new org-lowest-priority)
12141 (setq new (if (and org-priority-start-cycle-with-default (not have))
12142 org-default-priority (1- current)))))
12143 ((eq action 'down)
12144 (if (and (not have) (eq last-command this-command))
12145 (setq new org-highest-priority)
12146 (setq new (if (and org-priority-start-cycle-with-default (not have))
12147 org-default-priority (1+ current)))))
12148 (t (error "Invalid action")))
12149 (if (or (< (upcase new) org-highest-priority)
12150 (> (upcase new) org-lowest-priority))
12151 (setq remove t))
12152 (setq news (format "%c" new))
12153 (if have
12154 (if remove
12155 (replace-match "" t t nil 1)
12156 (replace-match news t t nil 2))
12157 (if remove
12158 (error "No priority cookie found in line")
12159 (let ((case-fold-search nil))
12160 (looking-at org-todo-line-regexp))
12161 (if (match-end 2)
12162 (progn
12163 (goto-char (match-end 2))
12164 (insert " [#" news "]"))
12165 (goto-char (match-beginning 3))
12166 (insert "[#" news "] "))))
12167 (org-preserve-lc (org-set-tags nil 'align)))
12168 (if remove
12169 (message "Priority removed")
12170 (message "Priority of current item set to %s" news))))
12172 (defun org-get-priority (s)
12173 "Find priority cookie and return priority."
12174 (if (functionp org-get-priority-function)
12175 (funcall org-get-priority-function)
12176 (save-match-data
12177 (if (not (string-match org-priority-regexp s))
12178 (* 1000 (- org-lowest-priority org-default-priority))
12179 (* 1000 (- org-lowest-priority
12180 (string-to-char (match-string 2 s))))))))
12182 ;;;; Tags
12184 (defvar org-agenda-archives-mode)
12185 (defvar org-map-continue-from nil
12186 "Position from where mapping should continue.
12187 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12189 (defvar org-scanner-tags nil
12190 "The current tag list while the tags scanner is running.")
12191 (defvar org-trust-scanner-tags nil
12192 "Should `org-get-tags-at' use the tags fro the scanner.
12193 This is for internal dynamical scoping only.
12194 When this is non-nil, the function `org-get-tags-at' will return the value
12195 of `org-scanner-tags' instead of building the list by itself. This
12196 can lead to large speed-ups when the tags scanner is used in a file with
12197 many entries, and when the list of tags is retrieved, for example to
12198 obtain a list of properties. Building the tags list for each entry in such
12199 a file becomes an N^2 operation - but with this variable set, it scales
12200 as N.")
12202 (defun org-scan-tags (action matcher &optional todo-only)
12203 "Scan headline tags with inheritance and produce output ACTION.
12205 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12206 or `agenda' to produce an entry list for an agenda view. It can also be
12207 a Lisp form or a function that should be called at each matched headline, in
12208 this case the return value is a list of all return values from these calls.
12210 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12211 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12212 only lines with a TODO keyword are included in the output."
12213 (require 'org-agenda)
12216 (org-re
12218 (props (list 'face 'default
12219 'done-face 'org-agenda-done
12220 'undone-face 'default
12221 'mouse-face 'highlight
12222 'org-not-done-regexp org-not-done-regexp
12223 'org-todo-regexp org-todo-regexp
12224 'help-echo
12225 (format "mouse-2 or RET jump to org file %s"
12226 (abbreviate-file-name
12227 (or (buffer-file-name (buffer-base-buffer))
12228 (buffer-name (buffer-base-buffer)))))))
12229 (case-fold-search nil)
12230 (org-map-continue-from nil)
12231 lspos tags tags-list
12232 (tags-alist (list (cons 0 org-file-tags)))
12233 (llast 0) rtn rtn1 level category i txt
12234 todo marker entry priority)
12235 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12236 (setq action (list 'lambda nil action)))
12237 (save-excursion
12238 (goto-char (point-min))
12239 (when (eq action 'sparse-tree)
12240 (org-overview)
12241 (org-remove-occur-highlights))
12242 (while (re-search-forward re nil t)
12243 (catch :skip
12244 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12245 tags (if (match-end 4) (org-match-string-no-properties 4)))
12246 (goto-char (setq lspos (match-beginning 0)))
12247 (setq level (org-reduced-level (funcall outline-level))
12248 category (org-get-category))
12249 (setq i llast llast level)
12250 ;; remove tag lists from same and sublevels
12251 (while (>= i level)
12252 (when (setq entry (assoc i tags-alist))
12253 (setq tags-alist (delete entry tags-alist)))
12254 (setq i (1- i)))
12255 ;; add the next tags
12256 (when tags
12257 (setq tags (org-split-string tags ":")
12258 tags-alist
12259 (cons (cons level tags) tags-alist)))
12260 ;; compile tags for current headline
12261 (setq tags-list
12262 (if org-use-tag-inheritance
12263 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12264 tags)
12265 org-scanner-tags tags-list)
12266 (when org-use-tag-inheritance
12267 (setcdr (car tags-alist)
12268 (mapcar (lambda (x)
12269 (setq x (copy-sequence x))
12270 (org-add-prop-inherited x))
12271 (cdar tags-alist))))
12272 (when (and tags org-use-tag-inheritance
12273 (or (not (eq t org-use-tag-inheritance))
12274 org-tags-exclude-from-inheritance))
12275 ;; selective inheritance, remove uninherited ones
12276 (setcdr (car tags-alist)
12277 (org-remove-uniherited-tags (cdar tags-alist))))
12278 (when (and (or (not todo-only)
12279 (and (member todo org-not-done-keywords)
12280 (or (not org-agenda-tags-todo-honor-ignore-options)
12281 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12282 (let ((case-fold-search t)) (eval matcher))
12283 (or
12284 (not (member org-archive-tag tags-list))
12285 ;; we have an archive tag, should we use this anyway?
12286 (or (not org-agenda-skip-archived-trees)
12287 (and (eq action 'agenda) org-agenda-archives-mode))))
12288 (unless (eq action 'sparse-tree) (org-agenda-skip))
12290 ;; select this headline
12292 (cond
12293 ((eq action 'sparse-tree)
12294 (and org-highlight-sparse-tree-matches
12295 (org-get-heading) (match-end 0)
12296 (org-highlight-new-match
12297 (match-beginning 0) (match-beginning 1)))
12298 (org-show-context 'tags-tree))
12299 ((eq action 'agenda)
12300 (setq txt (org-format-agenda-item
12301 ""
12302 (concat
12303 (if (eq org-tags-match-list-sublevels 'indented)
12304 (make-string (1- level) ?.) "")
12305 (org-get-heading))
12306 category
12307 tags-list
12308 )
12309 priority (org-get-priority txt))
12310 (goto-char lspos)
12311 (setq marker (org-agenda-new-marker))
12312 (org-add-props txt props
12313 'org-marker marker 'org-hd-marker marker 'org-category category
12314 'todo-state todo
12315 'priority priority 'type "tagsmatch")
12316 (push txt rtn))
12317 ((functionp action)
12318 (setq org-map-continue-from nil)
12319 (save-excursion
12320 (setq rtn1 (funcall action))
12321 (push rtn1 rtn)))
12322 (t (error "Invalid action")))
12324 ;; if we are to skip sublevels, jump to end of subtree
12325 (unless org-tags-match-list-sublevels
12326 (org-end-of-subtree t)
12327 (backward-char 1))))
12328 ;; Get the correct position from where to continue
12329 (if org-map-continue-from
12330 (goto-char org-map-continue-from)
12331 (and (= (point) lspos) (end-of-line 1)))))
12332 (when (and (eq action 'sparse-tree)
12333 (not org-sparse-tree-open-archived-trees))
12334 (org-hide-archived-subtrees (point-min) (point-max)))
12335 (nreverse rtn)))
12337 (defun org-remove-uniherited-tags (tags)
12338 "Remove all tags that are not inherited from the list TAGS."
12339 (cond
12340 ((eq org-use-tag-inheritance t)
12341 (if org-tags-exclude-from-inheritance
12342 (org-delete-all org-tags-exclude-from-inheritance tags)
12343 tags))
12344 ((not org-use-tag-inheritance) nil)
12345 ((stringp org-use-tag-inheritance)
12346 (delq nil (mapcar
12347 (lambda (x)
12348 (if (and (string-match org-use-tag-inheritance x)
12349 (not (member x org-tags-exclude-from-inheritance)))
12350 x nil))
12351 tags)))
12352 ((listp org-use-tag-inheritance)
12353 (delq nil (mapcar
12354 (lambda (x)
12355 (if (member x org-use-tag-inheritance) x nil))
12356 tags)))))
12358 (defvar todo-only) ;; dynamically scoped
12360 (defun org-match-sparse-tree (&optional todo-only match)
12361 "Create a sparse tree according to tags string MATCH.
12362 MATCH can contain positive and negative selection of tags, like
12364 If optional argument TODO-ONLY is non-nil, only select lines that are
12365 also TODO lines."
12366 (interactive "P")
12367 (org-prepare-agenda-buffers (list (current-buffer)))
12368 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12370 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12372 (defvar org-cached-props nil)
12373 (defun org-cached-entry-get (pom property)
12374 (if (or (eq t org-use-property-inheritance)
12375 (and (stringp org-use-property-inheritance)
12376 (string-match org-use-property-inheritance property))
12377 (and (listp org-use-property-inheritance)
12378 (member property org-use-property-inheritance)))
12379 ;; Caching is not possible, check it directly
12380 (org-entry-get pom property 'inherit)
12381 ;; Get all properties, so that we can do complicated checks easily
12382 (cdr (assoc property (or org-cached-props
12383 (setq org-cached-props
12384 (org-entry-properties pom)))))))
12386 (defun org-global-tags-completion-table (&optional files)
12387 "Return the list of all tags in all agenda buffer/files.
12388 Optional FILES argument is a list of files to which can be used
12389 instead of the agenda files."
12390 (save-excursion
12391 (org-uniquify
12392 (delq nil
12393 (apply 'append
12394 (mapcar
12395 (lambda (file)
12396 (set-buffer (find-file-noselect file))
12397 (append (org-get-buffer-tags)
12398 (mapcar (lambda (x) (if (stringp (car-safe x))
12399 (list (car-safe x)) nil))
12400 org-tag-alist)))
12401 (if (and files (car files))
12402 files
12403 (org-agenda-files))))))))
12405 (defun org-make-tags-matcher (match)
12406 "Create the TAGS//TODO matcher form for the selection string MATCH."
12407 ;; todo-only is scoped dynamically into this function, and the function
12408 ;; may change it if the matcher asks for it.
12409 (unless match
12410 ;; Get a new match request, with completion
12411 (let ((org-last-tags-completion-table
12412 (org-global-tags-completion-table)))
12413 (setq match (org-completing-read-no-i
12414 "Match: " 'org-tags-completion-function nil nil nil
12415 'org-tags-history))))
12417 ;; Parse the string and create a lisp form
12418 (let ((match0 match)
12419 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12420 minus tag mm
12421 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12422 orterms term orlist re-p str-p level-p level-op time-p
12423 prop-p pn pv po gv rest)
12424 (if (string-match "/+" match)
12425 ;; match contains also a todo-matching request
12426 (progn
12427 (setq tagsmatch (substring match 0 (match-beginning 0))
12428 todomatch (substring match (match-end 0)))
12429 (if (string-match "^!" todomatch)
12430 (setq todo-only t todomatch (substring todomatch 1)))
12432 (setq todomatch nil)))
12433 ;; only matching tags
12434 (setq tagsmatch match todomatch nil))
12436 ;; Make the tags matcher
12438 (setq tagsmatcher t)
12439 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12440 (while (setq term (pop orterms))
12442 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12443 (while (string-match re term)
12444 (setq rest (substring term (match-end 0))
12445 minus (and (match-end 1)
12446 (equal (match-string 1 term) "-"))
12447 tag (save-match-data (replace-regexp-in-string
12449 (match-string 2 term)))
12450 re-p (equal (string-to-char tag) ?{)
12451 level-p (match-end 4)
12452 prop-p (match-end 5)
12453 mm (cond
12454 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12455 (level-p
12456 (setq level-op (org-op-to-function (match-string 3 term)))
12457 `(,level-op level ,(string-to-number
12458 (match-string 4 term))))
12459 (prop-p
12460 (setq pn (match-string 5 term)
12461 po (match-string 6 term)
12462 pv (match-string 7 term)
12463 re-p (equal (string-to-char pv) ?{)
12465 time-p (save-match-data
12467 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12468 (if time-p (setq pv (org-matcher-time pv)))
12469 (setq po (org-op-to-function po (if time-p 'time str-p)))
12470 (cond
12471 ((equal pn "CATEGORY")
12472 (setq gv '(get-text-property (point) 'org-category)))
12473 ((equal pn "TODO")
12474 (setq gv 'todo))
12475 (t
12476 (setq gv `(org-cached-entry-get nil ,pn))))
12477 (if re-p
12478 (if (eq po 'org<>)
12479 `(not (string-match ,pv (or ,gv "")))
12480 `(string-match ,pv (or ,gv "")))
12481 (if str-p
12482 `(,po (or ,gv "") ,pv)
12483 `(,po (string-to-number (or ,gv ""))
12484 ,(string-to-number pv) ))))
12485 (t `(member ,tag tags-list)))
12486 mm (if minus (list 'not mm) mm)
12487 term rest)
12488 (push mm tagsmatcher))
12489 (push (if (> (length tagsmatcher) 1)
12490 (cons 'and tagsmatcher)
12491 (car tagsmatcher))
12492 orlist)
12493 (setq tagsmatcher nil))
12494 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12495 (setq tagsmatcher
12496 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12497 ;; Make the todo matcher
12499 (setq todomatcher t)
12500 (setq orterms (org-split-string todomatch "|") orlist nil)
12501 (while (setq term (pop orterms))
12502 (while (string-match re term)
12503 (setq minus (and (match-end 1)
12504 (equal (match-string 1 term) "-"))
12505 kwd (match-string 2 term)
12506 re-p (equal (string-to-char kwd) ?{)
12507 term (substring term (match-end 0))
12508 mm (if re-p
12509 `(string-match ,(substring kwd 1 -1) todo)
12510 (list 'equal 'todo kwd))
12511 mm (if minus (list 'not mm) mm))
12512 (push mm todomatcher))
12513 (push (if (> (length todomatcher) 1)
12514 (cons 'and todomatcher)
12515 (car todomatcher))
12516 orlist)
12517 (setq todomatcher nil))
12518 (setq todomatcher (if (> (length orlist) 1)
12519 (cons 'or orlist) (car orlist))))
12521 ;; Return the string and lisp forms of the matcher
12522 (setq matcher (if todomatcher
12523 (list 'and tagsmatcher todomatcher)
12524 tagsmatcher))
12525 (cons match0 matcher)))
12527 (defun org-op-to-function (op &optional stringp)
12528 "Turn an operator into the appropriate function."
12529 (setq op
12530 (cond
12531 ((equal op "<" ) '(< string< org-time<))
12532 ((equal op ">" ) '(> org-string> org-time>))
12533 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12534 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12535 ((member op '("=" "==")) '(= string= org-time=))
12536 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12537 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12539 (defun org<> (a b) (not (= a b)))
12540 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12541 (defun org-string>= (a b) (not (string< a b)))
12542 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12543 (defun org-string<> (a b) (not (string= a b)))
12544 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12545 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12546 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12547 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12548 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12549 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12550 (defun org-2ft (s)
12551 "Convert S to a floating point time.
12552 If S is already a number, just return it. If it is a string, parse
12553 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12554 (cond
12555 ((numberp s) s)
12556 ((stringp s)
12557 (condition-case nil
12558 (float-time (apply 'encode-time (org-parse-time-string s)))
12559 (error 0.)))
12560 (t 0.)))
12562 (defun org-time-today ()
12563 "Time in seconds today at 0:00.
12564 Returns the float number of seconds since the beginning of the
12565 epoch to the beginning of today (00:00)."
12566 (float-time (apply 'encode-time
12567 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12569 (defun org-matcher-time (s)
12570 "Interpret a time comparison value."
12571 (save-match-data
12572 (cond
12573 ((string= s "<now>") (float-time))
12574 ((string= s "<today>") (org-time-today))
12575 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12576 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12578 (+ (org-time-today)
12579 (* (string-to-number (match-string 1 s))
12580 (cdr (assoc (match-string 2 s)
12581 '(("d" . 86400.0) ("w" . 604800.0)
12582 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12583 (t (org-2ft s)))))
12585 (defun org-match-any-p (re list)
12586 "Does re match any element of list?"
12587 (setq list (mapcar (lambda (x) (string-match re x)) list))
12588 (delq nil list))
12590 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12591 (defvar org-tags-overlay (make-overlay 1 1))
12592 (org-detach-overlay org-tags-overlay)
12594 (defun org-get-local-tags-at (&optional pos)
12595 "Get a list of tags defined in the current headline."
12596 (org-get-tags-at pos 'local))
12598 (defun org-get-local-tags ()
12599 "Get a list of tags defined in the current headline."
12600 (org-get-tags-at nil 'local))
12602 (defun org-get-tags-at (&optional pos local)
12603 "Get a list of all headline tags applicable at POS.
12604 POS defaults to point. If tags are inherited, the list contains
12605 the targets in the same sequence as the headlines appear, i.e.
12606 the tags of the current headline come last.
12607 When LOCAL is non-nil, only return tags from the current headline,
12608 ignore inherited ones."
12609 (interactive)
12610 (if (and org-trust-scanner-tags
12611 (or (not pos) (equal pos (point)))
12612 (not local))
12613 org-scanner-tags
12614 (let (tags ltags lastpos parent)
12615 (save-excursion
12616 (save-restriction
12617 (widen)
12618 (goto-char (or pos (point)))
12619 (save-match-data
12620 (catch 'done
12621 (condition-case nil
12622 (progn
12623 (org-back-to-heading t)
12624 (while (not (equal lastpos (point)))
12625 (setq lastpos (point))
12626 (when (looking-at
12628 (setq ltags (org-split-string
12629 (org-match-string-no-properties 1) ":"))
12630 (when parent
12631 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12632 (setq tags (append
12633 (if parent
12634 (org-remove-uniherited-tags ltags)
12635 ltags)
12636 tags)))
12637 (or org-use-tag-inheritance (throw 'done t))
12638 (if local (throw 'done t))
12639 (or (org-up-heading-safe) (error nil))
12640 (setq parent t)))
12641 (error nil)))))
12642 (append (org-remove-uniherited-tags org-file-tags) tags)))))
12644 (defun org-add-prop-inherited (s)
12645 (add-text-properties 0 (length s) '(inherited t) s)
12646 s)
12648 (defun org-toggle-tag (tag &optional onoff)
12649 "Toggle the tag TAG for the current line.
12650 If ONOFF is `on' or `off', don't toggle but set to this state."
12651 (let (res current)
12652 (save-excursion
12653 (org-back-to-heading t)
12655 (point-at-eol) t)
12656 (progn
12657 (setq current (match-string 1))
12658 (replace-match ""))
12659 (setq current ""))
12660 (setq current (nreverse (org-split-string current ":")))
12661 (cond
12662 ((eq onoff 'on)
12663 (setq res t)
12664 (or (member tag current) (push tag current)))
12665 ((eq onoff 'off)
12666 (or (not (member tag current)) (setq current (delete tag current))))
12667 (t (if (member tag current)
12668 (setq current (delete tag current))
12669 (setq res t)
12670 (push tag current))))
12671 (end-of-line 1)
12672 (if current
12673 (progn
12674 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12675 (org-set-tags nil t))
12676 (delete-horizontal-space))
12677 (run-hooks 'org-after-tags-change-hook))
12678 res))
12680 (defun org-align-tags-here (to-col)
12681 ;; Assumes that this is a headline
12682 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12683 (beginning-of-line 1)
12685 (< pos (match-beginning 2)))
12686 (progn
12687 (setq tags-l (- (match-end 2) (match-beginning 2)))
12688 (goto-char (match-beginning 1))
12689 (insert " ")
12690 (delete-region (point) (1+ (match-beginning 2)))
12691 (setq ncol (max (1+ (current-column))
12692 (1+ col)
12693 (if (> to-col 0)
12694 to-col
12695 (- (abs to-col) tags-l))))
12696 (setq p (point))
12697 (insert (make-string (- ncol (current-column)) ?\ ))
12698 (setq ncol (current-column))
12699 (when indent-tabs-mode (tabify p (point-at-eol)))
12700 (org-move-to-column (min ncol col) t))
12701 (goto-char pos))))
12703 (defun org-set-tags-command (&optional arg just-align)
12704 "Call the set-tags command for the current entry."
12705 (interactive "P")
12706 (if (org-on-heading-p)
12707 (org-set-tags arg just-align)
12708 (save-excursion
12709 (org-back-to-heading t)
12710 (org-set-tags arg just-align))))
12712 (defun org-set-tags-to (data)
12713 "Set the tags of the current entry to DATA, replacing the current tags.
12714 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12715 If DATA is nil or the empty string, any tags will be removed."
12716 (interactive "sTags: ")
12717 (setq data
12718 (cond
12719 ((eq data nil) "")
12720 ((equal data "") "")
12721 ((stringp data)
12722 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12723 ":"))
12724 ((listp data)
12725 (concat ":" (mapconcat 'identity data ":") ":"))
12726 (t nil)))
12727 (when data
12728 (save-excursion
12729 (org-back-to-heading t)
12730 (when (looking-at org-complex-heading-regexp)
12731 (if (match-end 5)
12732 (progn
12733 (goto-char (match-beginning 5))
12734 (insert data)
12735 (delete-region (point) (point-at-eol))
12736 (org-set-tags nil 'align))
12737 (goto-char (point-at-eol))
12738 (insert " " data)
12739 (org-set-tags nil 'align)))
12740 (beginning-of-line 1)
12742 (delete-region (match-beginning 1) (match-end 1))))))
12744 (defun org-align-all-tags ()
12745 "Align the tags i all headings."
12746 (interactive)
12747 (save-excursion
12748 (or (ignore-errors (org-back-to-heading t))
12749 (outline-next-heading))
12750 (if (org-on-heading-p)
12751 (org-set-tags t)
12752 (message "No headings"))))
12754 (defvar org-indent-indentation-per-level)
12755 (defun org-set-tags (&optional arg just-align)
12756 "Set the tags for the current headline.
12757 With prefix ARG, realign all tags in headings in the current buffer."
12758 (interactive "P")
12759 (let* ((re (concat "^" outline-regexp))
12760 (current (org-get-tags-string))
12761 (col (current-column))
12762 (org-setting-tags t)
12763 table current-tags inherited-tags ; computed below when needed
12764 tags p0 c0 c1 rpl di tc level)
12765 (if arg
12766 (save-excursion
12767 (goto-char (point-min))
12768 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12769 (while (re-search-forward re nil t)
12770 (org-set-tags nil t)
12771 (end-of-line 1)))
12772 (message "All tags realigned to column %d" org-tags-column))
12773 (if just-align
12774 (setq tags current)
12775 ;; Get a new set of tags from the user
12776 (save-excursion
12777 (setq table (append org-tag-persistent-alist
12778 (or org-tag-alist (org-get-buffer-tags))
12779 (and
12780 org-complete-tags-always-offer-all-agenda-tags
12781 (org-global-tags-completion-table
12782 (org-agenda-files))))
12783 org-last-tags-completion-table table
12784 current-tags (org-split-string current ":")
12785 inherited-tags (nreverse
12786 (nthcdr (length current-tags)
12787 (nreverse (org-get-tags-at))))
12788 tags
12789 (if (or (eq t org-use-fast-tag-selection)
12790 (and org-use-fast-tag-selection
12791 (delq nil (mapcar 'cdr table))))
12792 (org-fast-tag-selection
12793 current-tags inherited-tags table
12794 (if org-fast-tag-selection-include-todo
12795 org-todo-key-alist))
12796 (let ((org-add-colon-after-tag-completion t))
12797 (org-trim
12798 (org-without-partial-completion
12799 (org-icompleting-read "Tags: "
12800 'org-tags-completion-function
12801 nil nil current 'org-tags-history)))))))
12802 (while (string-match "[-+&]+" tags)
12803 ;; No boolean logic, just a list
12804 (setq tags (replace-match ":" t t tags))))
12806 (setq tags (replace-regexp-in-string "[,]" ":" tags))
12808 (if org-tags-sort-function
12809 (setq tags (mapconcat 'identity
12810 (sort (org-split-string
12811 tags (org-re "[^[:alnum:]_@#%]+"))
12812 org-tags-sort-function) ":")))
12815 (setq tags "")
12816 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12817 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12819 ;; Insert new tags at the correct column
12820 (beginning-of-line 1)
12821 (setq level (or (and (looking-at org-outline-regexp)
12822 (- (match-end 0) (point) 1))
12823 1))
12824 (cond
12825 ((and (equal current "") (equal tags "")))
12826 ((re-search-forward
12828 (point-at-eol) t)
12829 (if (equal tags "")
12830 (setq rpl "")
12831 (goto-char (match-beginning 0))
12832 (setq c0 (current-column)
12833 ;; compute offset for the case of org-indent-mode active
12834 di (if org-indent-mode
12835 (* (1- org-indent-indentation-per-level) (1- level))
12836 0)
12837 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
12838 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
12839 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
12840 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12841 (replace-match rpl t t)
12842 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
12843 tags)
12844 (t (error "Tags alignment failed")))
12845 (org-move-to-column col)
12846 (unless just-align
12847 (run-hooks 'org-after-tags-change-hook)))))
12849 (defun org-change-tag-in-region (beg end tag off)
12850 "Add or remove TAG for each entry in the region.
12851 This works in the agenda, and also in an org-mode buffer."
12852 (interactive
12853 (list (region-beginning) (region-end)
12854 (let ((org-last-tags-completion-table
12855 (if (org-mode-p)
12856 (org-get-buffer-tags)
12857 (org-global-tags-completion-table))))
12858 (org-icompleting-read
12859 "Tag: " 'org-tags-completion-function nil nil nil
12860 'org-tags-history))
12861 (progn
12863 (equal (read-char-exclusive) ?r))))
12864 (if (fboundp 'deactivate-mark) (deactivate-mark))
12865 (let ((agendap (equal major-mode 'org-agenda-mode))
12866 l1 l2 m buf pos newhead (cnt 0))
12867 (goto-char end)
12868 (setq l2 (1- (org-current-line)))
12869 (goto-char beg)
12870 (setq l1 (org-current-line))
12871 (loop for l from l1 to l2 do
12872 (org-goto-line l)
12873 (setq m (get-text-property (point) 'org-hd-marker))
12874 (when (or (and (org-mode-p) (org-on-heading-p))
12875 (and agendap m))
12876 (setq buf (if agendap (marker-buffer m) (current-buffer))
12877 pos (if agendap m (point)))
12878 (with-current-buffer buf
12879 (save-excursion
12880 (save-restriction
12881 (goto-char pos)
12882 (setq cnt (1+ cnt))
12883 (org-toggle-tag tag (if off 'off 'on))
12884 (setq newhead (org-get-heading)))))
12885 (and agendap (org-agenda-change-all-lines newhead m))))
12886 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
12888 (defun org-tags-completion-function (string predicate &optional flag)
12889 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12890 (confirm (lambda (x) (stringp (car x)))))
12892 (setq s1 (match-string 1 string)
12893 s2 (match-string 2 string))
12894 (setq s1 "" s2 string))
12895 (cond
12896 ((eq flag nil)
12897 ;; try completion
12898 (setq rtn (try-completion s2 ctable confirm))
12899 (if (stringp rtn)
12900 (setq rtn
12901 (concat s1 s2 (substring rtn (length s2))
12902 (if (and org-add-colon-after-tag-completion
12903 (assoc rtn ctable))
12904 ":" ""))))
12905 rtn)
12906 ((eq flag t)
12907 ;; all-completions
12908 (all-completions s2 ctable confirm)
12909 )
12910 ((eq flag 'lambda)
12911 ;; exact match?
12912 (assoc s2 ctable)))
12913 ))
12915 (defun org-fast-tag-insert (kwd tags face &optional end)
12916 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
12917 (insert (format "%-12s" (concat kwd ":"))
12918 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
12919 (or end "")))
12921 (defun org-fast-tag-show-exit (flag)
12922 (save-excursion
12923 (org-goto-line 3)
12925 (replace-match ""))
12926 (when flag
12927 (end-of-line 1)
12928 (org-move-to-column (- (window-width) 19) t)
12929 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
12931 (defun org-set-current-tags-overlay (current prefix)
12932 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
12933 (if (featurep 'xemacs)
12934 (org-overlay-display org-tags-overlay (concat prefix s)
12935 'secondary-selection)
12936 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
12937 (org-overlay-display org-tags-overlay (concat prefix s)))))
12939 (defvar org-last-tag-selection-key nil)
12940 (defun org-fast-tag-selection (current inherited table &optional todo-table)
12941 "Fast tag selection with single keys.
12942 CURRENT is the current list of tags in the headline, INHERITED is the
12943 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
12944 possibly with grouping information. TODO-TABLE is a similar table with
12945 TODO keywords, should these have keys assigned to them.
12946 If the keys are nil, a-z are automatically assigned.
12947 Returns the new tags string, or nil to not change the current settings."
12948 (let* ((fulltable (append table todo-table))
12949 (maxlen (apply 'max (mapcar
12950 (lambda (x)
12951 (if (stringp (car x)) (string-width (car x)) 0))
12952 fulltable)))
12953 (buf (current-buffer))
12954 (expert (eq org-fast-tag-selection-single-key 'expert))
12955 (buffer-tags nil)
12956 (fwidth (+ maxlen 3 1 3))
12957 (ncol (/ (- (window-width) 4) fwidth))
12958 (i-face 'org-done)
12959 (c-face 'org-todo)
12960 tg cnt e c char c1 c2 ntable tbl rtn
12961 ov-start ov-end ov-prefix
12962 (exit-after-next org-fast-tag-selection-single-key)
12963 (done-keywords org-done-keywords)
12964 groups ingroup)
12965 (save-excursion
12966 (beginning-of-line 1)
12967 (if (looking-at
12969 (setq ov-start (match-beginning 1)
12970 ov-end (match-end 1)
12971 ov-prefix "")
12972 (setq ov-start (1- (point-at-eol))
12973 ov-end (1+ ov-start))
12975 (setq ov-prefix
12976 (concat
12977 (buffer-substring (1- (point)) (point))
12978 (if (> (current-column) org-tags-column)
12979 " "
12980 (make-string (- org-tags-column (current-column)) ?\ ))))))
12981 (move-overlay org-tags-overlay ov-start ov-end)
12982 (save-window-excursion
12983 (if expert
12984 (set-buffer (get-buffer-create " *Org tags*"))
12985 (delete-other-windows)
12986 (split-window-vertically)
12987 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
12988 (erase-buffer)
12989 (org-set-local 'org-done-keywords done-keywords)
12992 (org-fast-tag-show-exit exit-after-next)
12993 (org-set-current-tags-overlay current ov-prefix)
12994 (setq tbl fulltable char ?a cnt 0)
12995 (while (setq e (pop tbl))
12996 (cond
12997 ((equal (car e) :startgroup)
12998 (push '() groups) (setq ingroup t)
12999 (when (not (= cnt 0))
13000 (setq cnt 0)
13002 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13003 ((equal (car e) :endgroup)
13004 (setq ingroup nil cnt 0)
13006 ((equal e '(:newline))
13007 (when (not (= cnt 0))
13008 (setq cnt 0)
13010 (setq e (car tbl))
13011 (while (equal (car tbl) '(:newline))
13013 (setq tbl (cdr tbl)))))
13014 (t
13015 (setq tg (copy-sequence (car e)) c2 nil)
13016 (if (cdr e)
13017 (setq c (cdr e))
13018 ;; automatically assign a character.
13019 (setq c1 (string-to-char
13020 (downcase (substring
13021 tg (if (= (string-to-char tg) ?@) 1 0)))))
13022 (if (or (rassoc c1 ntable) (rassoc c1 table))
13023 (while (or (rassoc char ntable) (rassoc char table))
13024 (setq char (1+ char)))
13025 (setq c2 c1))
13026 (setq c (or c2 char)))
13027 (if ingroup (push tg (car groups)))
13028 (setq tg (org-add-props tg nil 'face
13029 (cond
13030 ((not (assoc tg table))
13031 (org-get-todo-face tg))
13032 ((member tg current) c-face)
13033 ((member tg inherited) i-face)
13034 (t nil))))
13035 (if (and (= cnt 0) (not ingroup)) (insert " "))
13036 (insert "[" c "] " tg (make-string
13037 (- fwidth 4 (length tg)) ?\ ))
13038 (push (cons tg c) ntable)
13039 (when (= (setq cnt (1+ cnt)) ncol)
13041 (if ingroup (insert " "))
13042 (setq cnt 0)))))
13043 (setq ntable (nreverse ntable))
13045 (goto-char (point-min))
13046 (if (not expert) (org-fit-window-to-buffer))
13047 (setq rtn
13048 (catch 'exit
13049 (while t
13050 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13051 (if (not groups) "no " "")
13052 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13053 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13054 (setq org-last-tag-selection-key c)
13055 (cond
13057 ((= c ?!)
13058 (setq groups (not groups))
13059 (goto-char (point-min))
13060 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13061 ((= c ?\C-c)
13062 (if (not expert)
13063 (org-fast-tag-show-exit
13064 (setq exit-after-next (not exit-after-next)))
13065 (setq expert nil)
13066 (delete-other-windows)
13067 (set-window-buffer (split-window-vertically) " *Org tags*")
13068 (org-switch-to-buffer-other-window " *Org tags*")
13069 (org-fit-window-to-buffer)))
13070 ((or (= c ?\C-g)
13071 (and (= c ?q) (not (rassoc c ntable))))
13072 (org-detach-overlay org-tags-overlay)
13073 (setq quit-flag t))
13074 ((= c ?\ )
13075 (setq current nil)
13076 (if exit-after-next (setq exit-after-next 'now)))
13078 (condition-case nil
13079 (setq tg (org-icompleting-read
13080 "Tag: "
13081 (or buffer-tags
13082 (with-current-buffer buf
13083 (org-get-buffer-tags)))))
13084 (quit (setq tg "")))
13086 (add-to-list 'buffer-tags (list tg))
13087 (if (member tg current)
13088 (setq current (delete tg current))
13089 (push tg current)))
13090 (if exit-after-next (setq exit-after-next 'now)))
13091 ((setq e (rassoc c todo-table) tg (car e))
13092 (with-current-buffer buf
13093 (save-excursion (org-todo tg)))
13094 (if exit-after-next (setq exit-after-next 'now)))
13095 ((setq e (rassoc c ntable) tg (car e))
13096 (if (member tg current)
13097 (setq current (delete tg current))
13098 (loop for g in groups do
13099 (if (member tg g)
13100 (mapc (lambda (x)
13101 (setq current (delete x current)))
13102 g)))
13103 (push tg current))
13104 (if exit-after-next (setq exit-after-next 'now))))
13106 ;; Create a sorted list
13107 (setq current
13108 (sort current
13109 (lambda (a b)
13110 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13111 (if (eq exit-after-next 'now) (throw 'exit t))
13112 (goto-char (point-min))
13113 (beginning-of-line 2)
13114 (delete-region (point) (point-at-eol))
13115 (org-fast-tag-insert "Current" current c-face)
13116 (org-set-current-tags-overlay current ov-prefix)
13117 (while (re-search-forward
13119 (setq tg (match-string 1))
13120 (add-text-properties
13121 (match-beginning 1) (match-end 1)
13122 (list 'face
13123 (cond
13124 ((member tg current) c-face)
13125 ((member tg inherited) i-face)
13126 (t (get-text-property (match-beginning 1) 'face))))))
13127 (goto-char (point-min)))))
13128 (org-detach-overlay org-tags-overlay)
13129 (if rtn
13130 (mapconcat 'identity current ":")
13131 nil))))
13133 (defun org-get-tags-string ()
13134 "Get the TAGS string in the current headline."
13135 (unless (org-on-heading-p t)
13136 (error "Not on a heading"))
13137 (save-excursion
13138 (beginning-of-line 1)
13140 (org-match-string-no-properties 1)
13141 "")))
13143 (defun org-get-tags ()
13144 "Get the list of tags specified in the current headline."
13145 (org-split-string (org-get-tags-string) ":"))
13147 (defun org-get-buffer-tags ()
13148 "Get a table of all tags used in the buffer, for completion."
13149 (let (tags)
13150 (save-excursion
13151 (goto-char (point-min))
13152 (while (re-search-forward
13154 (when (equal (char-after (point-at-bol 0)) ?*)
13155 (mapc (lambda (x) (add-to-list 'tags x))
13156 (org-split-string (org-match-string-no-properties 1) ":")))))
13157 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13158 (mapcar 'list tags)))
13160 ;;;; The mapping API
13162 ;;;###autoload
13163 (defun org-map-entries (func &optional match scope &rest skip)
13164 "Call FUNC at each headline selected by MATCH in SCOPE.
13166 FUNC is a function or a lisp form. The function will be called without
13167 arguments, with the cursor positioned at the beginning of the headline.
13168 The return values of all calls to the function will be collected and
13169 returned as a list.
13171 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13172 does not need to preserve point. After evaluation, the cursor will be
13173 moved to the end of the line (presumably of the headline of the
13174 processed entry) and search continues from there. Under some
13175 circumstances, this may not produce the wanted results. For example,
13176 if you have removed (e.g. archived) the current (sub)tree it could
13177 mean that the next entry will be skipped entirely. In such cases, you
13178 can specify the position from where search should continue by making
13179 FUNC set the variable `org-map-continue-from' to the desired buffer
13180 position.
13182 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13183 Only headlines that are matched by this query will be considered during
13184 the iteration. When MATCH is nil or t, all headlines will be
13185 visited by the iteration.
13187 SCOPE determines the scope of this command. It can be any of:
13189 nil The current buffer, respecting the restriction if any
13190 tree The subtree started with the entry at point
13191 file The current buffer, without restriction
13192 file-with-archives
13193 The current buffer, and any archives associated with it
13194 agenda All agenda files
13195 agenda-with-archives
13196 All agenda files with any archive files associated with them
13197 \(file1 file2 ...)
13198 If this is a list, all files in the list will be scanned
13200 The remaining args are treated as settings for the skipping facilities of
13201 the scanner. The following items can be given here:
13203 archive skip trees with the archive tag.
13204 comment skip trees with the COMMENT keyword
13205 function or Emacs Lisp form:
13206 will be used as value for `org-agenda-skip-function', so whenever
13207 the function returns t, FUNC will not be called for that
13208 entry and search will continue from the point where the
13209 function leaves it.
13211 If your function needs to retrieve the tags including inherited tags
13212 at the *current* entry, you can use the value of the variable
13213 `org-scanner-tags' which will be much faster than getting the value
13214 with `org-get-tags-at'. If your function gets properties with
13215 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13216 to t around the call to `org-entry-properties' to get the same speedup.
13217 Note that if your function moves around to retrieve tags and properties at
13218 a *different* entry, you cannot use these techniques."
13219 (let* ((org-agenda-archives-mode nil) ; just to make sure
13220 (org-agenda-skip-archived-trees (memq 'archive skip))
13221 (org-agenda-skip-comment-trees (memq 'comment skip))
13222 (org-agenda-skip-function
13223 (car (org-delete-all '(comment archive) skip)))
13224 (org-tags-match-list-sublevels t)
13225 matcher file res
13226 org-todo-keywords-for-agenda
13227 org-done-keywords-for-agenda
13228 org-todo-keyword-alist-for-agenda
13229 org-drawers-for-agenda
13230 org-tag-alist-for-agenda)
13232 (cond
13233 ((eq match t) (setq matcher t))
13234 ((eq match nil) (setq matcher t))
13235 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13237 (save-excursion
13238 (save-restriction
13239 (when (eq scope 'tree)
13240 (org-back-to-heading t)
13241 (org-narrow-to-subtree)
13242 (setq scope nil))
13244 (if (not scope)
13245 (progn
13246 (org-prepare-agenda-buffers
13247 (list (buffer-file-name (current-buffer))))
13248 (setq res (org-scan-tags func matcher)))
13249 ;; Get the right scope
13250 (cond
13251 ((and scope (listp scope) (symbolp (car scope)))
13252 (setq scope (eval scope)))
13253 ((eq scope 'agenda)
13254 (setq scope (org-agenda-files t)))
13255 ((eq scope 'agenda-with-archives)
13256 (setq scope (org-agenda-files t))
13257 (setq scope (org-add-archive-files scope)))
13258 ((eq scope 'file)
13259 (setq scope (list (buffer-file-name))))
13260 ((eq scope 'file-with-archives)
13261 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13262 (org-prepare-agenda-buffers scope)
13263 (while (setq file (pop scope))
13264 (with-current-buffer (org-find-base-buffer-visiting file)
13265 (save-excursion
13266 (save-restriction
13267 (widen)
13268 (goto-char (point-min))
13269 (setq res (append res (org-scan-tags func matcher))))))))))
13270 res))
13272 ;;;; Properties
13274 ;;; Setting and retrieving properties
13276 (defconst org-special-properties
13277 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13278 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE")
13279 "The special properties valid in Org-mode.
13281 These are properties that are not defined in the property drawer,
13282 but in some other way.")
13284 (defconst org-default-properties
13285 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13286 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13287 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13288 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13289 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13290 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13291 "Some properties that are used by Org-mode for various purposes.
13292 Being in this list makes sure that they are offered for completion.")
13295 "Regular expression matching the first line of a property drawer.")
13298 "Regular expression matching the last line of a property drawer.")
13301 "Regular expression matching the first line of a property drawer.")
13304 "Regular expression matching the first line of a property drawer.")
13306 (defconst org-property-drawer-re
13309 "Matches an entire property drawer.")
13311 (defconst org-clock-drawer-re
13314 "Matches an entire clock drawer.")
13316 (defun org-property-action ()
13317 "Do an action on properties."
13318 (interactive)
13319 (let (c)
13320 (org-at-property-p)
13321 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13322 (setq c (read-char-exclusive))
13323 (cond
13324 ((equal c ?s)
13325 (call-interactively 'org-set-property))
13326 ((equal c ?d)
13327 (call-interactively 'org-delete-property))
13328 ((equal c ?D)
13329 (call-interactively 'org-delete-property-globally))
13330 ((equal c ?c)
13331 (call-interactively 'org-compute-property-at-point))
13332 (t (error "No such property action %c" c)))))
13334 (defun org-set-effort (&optional value)
13335 "Set the effort property of the current entry.
13336 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13337 allowed value."
13338 (interactive "P")
13339 (if (equal value 0) (setq value 10))
13340 (let* ((completion-ignore-case t)
13341 (prop org-effort-property)
13342 (cur (org-entry-get nil prop))
13343 (allowed (org-property-get-allowed-values nil prop 'table))
13344 (existing (mapcar 'list (org-property-values prop)))
13345 rpl
13346 (val (cond
13347 ((stringp value) value)
13348 ((and allowed (integerp value))
13349 (or (car (nth (1- value) allowed))
13350 (car (org-last allowed))))
13351 (allowed
13352 (message "Select 1-9,0, [RET%s]: %s"
13353 (if cur (concat "=" cur) "")
13354 (mapconcat 'car allowed " "))
13355 (setq rpl (read-char-exclusive))
13357 cur
13358 (setq rpl (- rpl ?0))
13359 (if (equal rpl 0) (setq rpl 10))
13360 (if (and (> rpl 0) (<= rpl (length allowed)))
13361 (car (nth (1- rpl) allowed))
13362 (org-completing-read "Effort: " allowed nil))))
13363 (t
13364 (let (org-completion-use-ido org-completion-use-iswitchb)
13365 (org-completing-read
13367 (concat "[" cur "]") "")
13368 ": ")
13369 existing nil nil "" nil cur))))))
13370 (unless (equal (org-entry-get nil prop) val)
13371 (org-entry-put nil prop val))
13372 (message "%s is now %s" prop val)))
13374 (defun org-at-property-p ()
13375 "Is cursor inside a property drawer?"
13376 (save-excursion
13377 (beginning-of-line 1)
13379 (save-match-data ;; Used by calling procedures
13380 (let ((p (point))
13381 (range (unless (org-before-first-heading-p)
13382 (org-get-property-block))))
13383 (and range (<= (car range) p) (< p (cdr range))))))))
13385 (defun org-get-property-block (&optional beg end force)
13386 "Return the (beg . end) range of the body of the property drawer.
13387 BEG and END can be beginning and end of subtree, if not given
13388 they will be found.
13389 If the drawer does not exist and FORCE is non-nil, create the drawer."
13390 (catch 'exit
13391 (save-excursion
13392 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13393 (end (or end (progn (outline-next-heading) (point)))))
13394 (goto-char beg)
13395 (if (re-search-forward org-property-start-re end t)
13396 (setq beg (1+ (match-end 0)))
13397 (if force
13398 (save-excursion
13399 (org-insert-property-drawer)
13400 (setq end (progn (outline-next-heading) (point))))
13401 (throw 'exit nil))
13402 (goto-char beg)
13403 (if (re-search-forward org-property-start-re end t)
13404 (setq beg (1+ (match-end 0)))))
13405 (if (re-search-forward org-property-end-re end t)
13406 (setq end (match-beginning 0))
13407 (or force (throw 'exit nil))
13408 (goto-char beg)
13409 (setq end beg)
13410 (org-indent-line-function)
13412 (cons beg end)))))
13414 (defun org-entry-properties (&optional pom which specific)
13415 "Get all properties of the entry at point-or-marker POM.
13416 This includes the TODO keyword, the tags, time strings for deadline,
13417 scheduled, and clocking, and any additional properties defined in the
13418 entry. The return value is an alist, keys may occur multiple times
13419 if the property key was used several times.
13420 POM may also be nil, in which case the current entry is used.
13421 If WHICH is nil or `all', get all properties. If WHICH is
13422 `special' or `standard', only get that subclass. If WHICH
13423 is a string only get exactly this property. SPECIFIC can be a string, the
13424 specific property we are interested in. Specifying it can speed
13425 things up because then unnecessary parsing is avoided."
13426 (setq which (or which 'all))
13427 (org-with-point-at pom
13428 (let ((clockstr (substring org-clock-string 0 -1))
13429 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13430 (case-fold-search nil)
13431 beg end range props sum-props key key1 value string clocksum)
13432 (save-excursion
13433 (when (condition-case nil
13434 (and (org-mode-p) (org-back-to-heading t))
13435 (error nil))
13436 (setq beg (point))
13437 (setq sum-props (get-text-property (point) 'org-summaries))
13438 (setq clocksum (get-text-property (point) :org-clock-minutes))
13439 (outline-next-heading)
13440 (setq end (point))
13441 (when (memq which '(all special))
13442 ;; Get the special properties, like TODO and tags
13443 (goto-char beg)
13444 (when (and (or (not specific) (string= specific "TODO"))
13445 (looking-at org-todo-line-regexp) (match-end 2))
13446 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13447 (when (and (or (not specific) (string= specific "PRIORITY"))
13448 (looking-at org-priority-regexp))
13449 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13450 (when (or (not specific) (string= specific "FILE"))
13451 (push (cons "FILE" buffer-file-name) props))
13452 (when (and (or (not specific) (string= specific "TAGS"))
13453 (setq value (org-get-tags-string))
13455 (push (cons "TAGS" value) props))
13456 (when (and (or (not specific) (string= specific "ALLTAGS"))
13457 (setq value (org-get-tags-at)))
13458 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13459 ":"))
13460 props))
13461 (when (or (not specific) (string= specific "BLOCKED"))
13462 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13463 (when (or (not specific)
13464 (member specific
13465 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13466 "TIMESTAMP" "TIMESTAMP_IA")))
13467 (catch 'match
13468 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13469 (setq key (if (match-end 1)
13470 (substring (org-match-string-no-properties 1)
13471 0 -1))
13472 string (if (equal key clockstr)
13473 (org-no-properties
13474 (org-trim
13475 (buffer-substring
13476 (match-beginning 3) (goto-char
13477 (point-at-eol)))))
13478 (substring (org-match-string-no-properties 3)
13479 1 -1)))
13480 ;; Get the correct property name from the key. This is
13481 ;; necessary if the user has configured time keywords.
13482 (setq key1 (concat key ":"))
13483 (cond
13484 ((not key)
13485 (setq key
13486 (if (= (char-after (match-beginning 3)) ?\[)
13487 "TIMESTAMP_IA" "TIMESTAMP")))
13488 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13489 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13490 ((equal key1 org-closed-string) (setq key "CLOSED"))
13491 ((equal key1 org-clock-string) (setq key "CLOCK")))
13492 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13493 (progn
13494 (push (cons key string) props)
13495 ;; no need to search further if match is found
13496 (throw 'match t))
13497 (when (or (equal key "CLOCK") (not (assoc key props)))
13498 (push (cons key string) props))))))
13499 )
13501 (when (memq which '(all standard))
13502 ;; Get the standard properties, like :PROP: ...
13503 (setq range (org-get-property-block beg end))
13504 (when range
13505 (goto-char (car range))
13506 (while (re-search-forward
13508 (cdr range) t)
13509 (setq key (org-match-string-no-properties 1)
13510 value (org-trim (or (org-match-string-no-properties 2) "")))
13511 (unless (member key excluded)
13512 (push (cons key (or value "")) props)))))
13513 (if clocksum
13514 (push (cons "CLOCKSUM"
13515 (org-columns-number-to-string (/ (float clocksum) 60.)
13516 'add_times))
13517 props))
13518 (unless (assoc "CATEGORY" props)
13519 (push (cons "CATEGORY" (org-get-category)) props))
13520 (append sum-props (nreverse props)))))))
13522 (defun org-entry-get (pom property &optional inherit literal-nil)
13523 "Get value of PROPERTY for entry at point-or-marker POM.
13524 If INHERIT is non-nil and the entry does not have the property,
13525 then also check higher levels of the hierarchy.
13526 If INHERIT is the symbol `selective', use inheritance only if the setting
13527 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13528 If the property is present but empty, the return value is the empty string.
13529 If the property is not present at all, nil is returned.
13532 do not interpret it as the list atom nil. This is used for inheritance
13534 (org-with-point-at pom
13535 (if (and inherit (if (eq inherit 'selective)
13536 (org-property-inherit-p property)
13537 t))
13538 (org-entry-get-with-inheritance property literal-nil)
13539 (if (member property org-special-properties)
13540 ;; We need a special property. Use `org-entry-properties' to
13541 ;; retrieve it, but specify the wanted property
13542 (cdr (assoc property (org-entry-properties nil 'special property)))
13543 (let ((range (org-get-property-block)))
13544 (if (and range
13545 (goto-char (car range))
13546 (re-search-forward
13548 (cdr range) t))
13549 ;; Found the property, return it.
13550 (if (match-end 1)
13551 (if literal-nil
13552 (org-match-string-no-properties 1)
13553 (org-not-nil (org-match-string-no-properties 1)))
13554 "")))))))
13556 (defun org-property-or-variable-value (var &optional inherit)
13557 "Check if there is a property fixing the value of VAR.
13558 If yes, return this value. If not, return the current value of the variable."
13559 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13561 (read prop)
13562 (symbol-value var))))
13564 (defun org-entry-delete (pom property)
13565 "Delete the property PROPERTY from entry at point-or-marker POM."
13566 (org-with-point-at pom
13567 (if (member property org-special-properties)
13568 nil ; cannot delete these properties.
13569 (let ((range (org-get-property-block)))
13570 (if (and range
13571 (goto-char (car range))
13572 (re-search-forward
13574 (cdr range) t))
13575 (progn
13576 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13577 t)
13578 nil)))))
13580 ;; Multi-values properties are properties that contain multiple values
13581 ;; These values are assumed to be single words, separated by whitespace.
13582 (defun org-entry-add-to-multivalued-property (pom property value)
13583 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13584 (let* ((old (org-entry-get pom property))
13586 (setq value (org-entry-protect-space value))
13587 (unless (member value values)
13588 (setq values (cons value values))
13589 (org-entry-put pom property
13590 (mapconcat 'identity values " ")))))
13592 (defun org-entry-remove-from-multivalued-property (pom property value)
13593 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13594 (let* ((old (org-entry-get pom property))
13596 (setq value (org-entry-protect-space value))
13597 (when (member value values)
13598 (setq values (delete value values))
13599 (org-entry-put pom property
13600 (mapconcat 'identity values " ")))))
13602 (defun org-entry-member-in-multivalued-property (pom property value)
13603 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13604 (let* ((old (org-entry-get pom property))
13606 (setq value (org-entry-protect-space value))
13607 (member value values)))
13609 (defun org-entry-get-multivalued-property (pom property)
13610 "Return a list of values in a multivalued property."
13611 (let* ((value (org-entry-get pom property))
13613 (mapcar 'org-entry-restore-space values)))
13615 (defun org-entry-put-multivalued-property (pom property &rest values)
13616 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13617 VALUES should be a list of strings. Spaces will be protected."
13618 (org-entry-put pom property
13619 (mapconcat 'org-entry-protect-space values " "))
13620 (let* ((value (org-entry-get pom property))
13622 (mapcar 'org-entry-restore-space values)))
13624 (defun org-entry-protect-space (s)
13625 "Protect spaces and newline in string S."
13626 (while (string-match " " s)
13627 (setq s (replace-match "%20" t t s)))
13629 (setq s (replace-match "%0A" t t s)))
13630 s)
13632 (defun org-entry-restore-space (s)
13633 "Restore spaces and newline in string S."
13634 (while (string-match "%20" s)
13635 (setq s (replace-match " " t t s)))
13636 (while (string-match "%0A" s)
13638 s)
13640 (defvar org-entry-property-inherited-from (make-marker)
13641 "Marker pointing to the entry from where a property was inherited.
13642 Each call to `org-entry-get-with-inheritance' will set this marker to the
13643 location of the entry where the inheritance search matched. If there was
13644 no match, the marker will point nowhere.
13645 Note that also `org-entry-get' calls this function, if the INHERIT flag
13646 is set.")
13648 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13649 "Get entry property, and search higher levels if not present.
13650 The search will stop at the first ancestor which has the property defined.
13652 should be considered as undefined (this is the meaning of nil here).
13654 (move-marker org-entry-property-inherited-from nil)
13655 (let (tmp)
13656 (save-excursion
13657 (save-restriction
13658 (widen)
13659 (catch 'ex
13660 (while t
13661 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13662 (org-back-to-heading t)
13663 (move-marker org-entry-property-inherited-from (point))
13664 (throw 'ex tmp))
13665 (or (org-up-heading-safe) (throw 'ex nil)))))
13666 (setq tmp (or tmp
13667 (cdr (assoc property org-file-properties))
13668 (cdr (assoc property org-global-properties))
13669 (cdr (assoc property org-global-properties-fixed))))
13670 (if literal-nil tmp (org-not-nil tmp)))))
13672 (defvar org-property-changed-functions nil
13673 "Hook called when the value of a property has changed.
13674 Each hook function should accept two arguments, the name of the property
13675 and the new value.")
13677 (defun org-entry-put (pom property value)
13678 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13679 (org-with-point-at pom
13680 (org-back-to-heading t)
13681 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13682 range)
13683 (cond
13684 ((equal property "TODO")
13686 (not (member value org-todo-keywords-1)))
13688 (if (or (not value)
13690 (setq value 'none))
13691 (org-todo value)
13692 (org-set-tags nil 'align))
13693 ((equal property "PRIORITY")
13695 (string-to-char value) ?\ ))
13696 (org-set-tags nil 'align))
13697 ((equal property "SCHEDULED")
13698 (if (re-search-forward org-scheduled-time-regexp end t)
13699 (cond
13700 ((eq value 'earlier) (org-timestamp-change -1 'day))
13701 ((eq value 'later) (org-timestamp-change 1 'day))
13702 (t (call-interactively 'org-schedule)))
13703 (call-interactively 'org-schedule)))
13704 ((equal property "DEADLINE")
13705 (if (re-search-forward org-deadline-time-regexp end t)
13706 (cond
13707 ((eq value 'earlier) (org-timestamp-change -1 'day))
13708 ((eq value 'later) (org-timestamp-change 1 'day))
13709 (t (call-interactively 'org-deadline)))
13710 (call-interactively 'org-deadline)))
13711 ((member property org-special-properties)
13712 (error "The %s property can not yet be set with `org-entry-put'"
13713 property))
13714 (t ; a non-special property
13715 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13716 (setq range (org-get-property-block beg end 'force))
13717 (goto-char (car range))
13718 (if (re-search-forward
13720 (progn
13721 (delete-region (match-beginning 1) (match-end 1))
13722 (goto-char (match-beginning 1)))
13723 (goto-char (cdr range))
13725 (backward-char 1)
13726 (org-indent-line-function)
13727 (insert ":" property ":"))
13728 (and value (insert " " value))
13729 (org-indent-line-function)))))
13730 (run-hook-with-args 'org-property-changed-functions property value)))
13732 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13733 "Get all property keys in the current buffer.
13734 With INCLUDE-SPECIALS, also list the special properties that reflect things
13735 like tags and TODO state.
13736 With INCLUDE-DEFAULTS, also include properties that has special meaning
13737 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
13738 With INCLUDE-COLUMNS, also include property names given in COLUMN
13739 formats in the current buffer."
13740 (let (rtn range cfmt s p)
13741 (save-excursion
13742 (save-restriction
13743 (widen)
13744 (goto-char (point-min))
13745 (while (re-search-forward org-property-start-re nil t)
13746 (setq range (org-get-property-block))
13747 (goto-char (car range))
13748 (while (re-search-forward
13750 (cdr range) t)
13751 (add-to-list 'rtn (org-match-string-no-properties 1)))
13752 (outline-next-heading))))
13754 (when include-specials
13755 (setq rtn (append org-special-properties rtn)))
13757 (when include-defaults
13758 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13759 (add-to-list 'rtn org-effort-property))
13761 (when include-columns
13762 (save-excursion
13763 (save-restriction
13764 (widen)
13765 (goto-char (point-min))
13766 (while (re-search-forward
13768 nil t)
13769 (setq cfmt (match-string 2) s 0)
13771 cfmt s)
13772 (setq s (match-end 0)
13773 p (match-string 1 cfmt))
13774 (unless (or (equal p "ITEM")
13775 (member p org-special-properties))
13776 (add-to-list 'rtn (match-string 1 cfmt))))))))
13778 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13780 (defun org-property-values (key)
13781 "Return a list of all values of property KEY."
13782 (save-excursion
13783 (save-restriction
13784 (widen)
13785 (goto-char (point-min))
13787 values)
13788 (while (re-search-forward re nil t)
13789 (add-to-list 'values (org-trim (match-string 1))))
13790 (delete "" values)))))
13792 (defun org-insert-property-drawer ()
13793 "Insert a property drawer into the current entry."
13794 (interactive)
13795 (org-back-to-heading t)
13796 (looking-at outline-regexp)
13797 (let ((indent (if org-adapt-indentation
13798 (- (match-end 0)(match-beginning 0))
13799 0))
13800 (beg (point))
13802 end hiddenp)
13803 (outline-next-heading)
13804 (setq end (point))
13805 (goto-char beg)
13806 (while (re-search-forward re end t))
13807 (setq hiddenp (outline-invisible-p))
13808 (end-of-line 1)
13811 (if (member (match-string 1) '("CLOCK:" ":END:"))
13812 ;; just skip this line
13813 (beginning-of-line 2)
13814 ;; Drawer start, find the end
13816 (beginning-of-line 1)))
13817 (org-skip-over-state-notes)
13819 (if (eq (char-before) ?*) (forward-char 1))
13821 (beginning-of-line 0)
13822 (org-indent-to-column indent)
13823 (beginning-of-line 2)
13824 (org-indent-to-column indent)
13825 (beginning-of-line 0)
13826 (if hiddenp
13827 (save-excursion
13828 (org-back-to-heading t)
13829 (hide-entry))
13830 (org-flag-drawer t))))
13832 (defvar org-property-set-functions-alist nil
13833 "Property set function alist.
13834 Each entry should have the following format:
13836 (PROPERTY . READ-FUNCTION)
13838 The read function will be called with the same argument as
13839 `org-completing-read.")
13841 (defun org-set-property-function (property)
13842 "Get the function that should be used to set PROPERTY.
13843 This is computed according to `org-property-set-functions-alist'."
13844 (or (cdr (assoc property org-property-set-functions-alist))
13845 'org-completing-read))
13847 (defun org-read-property-value (property)
13848 "Read PROPERTY value from user."
13849 (let* ((completion-ignore-case t)
13850 (allowed (org-property-get-allowed-values nil property 'table))
13851 (cur (org-entry-get nil property))
13852 (prompt (concat property " value"
13854 (concat " [" cur "]") "") ": "))
13855 (set-function (org-set-property-function property))
13856 (val (if allowed
13857 (funcall set-function prompt allowed nil
13858 (not (get-text-property 0 'org-unrestricted
13859 (caar allowed))))
13860 (let (org-completion-use-ido org-completion-use-iswitchb)
13861 (funcall set-function prompt
13862 (mapcar 'list (org-property-values property))
13863 nil nil "" nil cur)))))
13864 (if (equal val "")
13865 cur
13866 val)))
13868 (defun org-read-property-name ()
13869 "Read a property name."
13870 (let* ((completion-ignore-case t)
13871 (keys (org-buffer-property-keys nil t t))
13872 (property (org-icompleting-read "Property: " (mapcar 'list keys))))
13873 (if (member property keys)
13874 property
13875 (or (cdr (assoc (downcase property)
13876 (mapcar (lambda (x) (cons (downcase x) x))
13877 keys)))
13878 property))))
13880 (defun org-set-property (property value)
13881 "In the current entry, set PROPERTY to VALUE.
13882 When called interactively, this will prompt for a property name, offering
13883 completion on existing and default properties. And then it will prompt
13884 for a value, offering completion either on allowed values (via an inherited
13885 xxx_ALL property) or on existing values in other instances of this property
13886 in the current file."
13887 (interactive (list nil nil))
13888 (let* ((property (or property (org-read-property-name)))
13889 (value (or value (org-read-property-value property))))
13890 (unless (equal (org-entry-get nil property) value)
13891 (org-entry-put nil property value))))
13893 (defun org-delete-property (property)
13894 "In the current entry, delete PROPERTY."
13895 (interactive
13896 (let* ((completion-ignore-case t)
13897 (prop (org-icompleting-read "Property: "
13898 (org-entry-properties nil 'standard))))
13899 (list prop)))
13900 (message "Property %s %s" property
13901 (if (org-entry-delete nil property)
13902 "deleted"
13903 "was not present in the entry")))
13905 (defun org-delete-property-globally (property)
13906 "Remove PROPERTY globally, from all entries."
13907 (interactive
13908 (let* ((completion-ignore-case t)
13909 (prop (org-icompleting-read
13910 "Globally remove property: "
13911 (mapcar 'list (org-buffer-property-keys)))))
13912 (list prop)))
13913 (save-excursion
13914 (save-restriction
13915 (widen)
13916 (goto-char (point-min))
13917 (let ((cnt 0))
13918 (while (re-search-forward
13920 nil t)
13921 (setq cnt (1+ cnt))
13922 (replace-match ""))
13925 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
13927 (defun org-compute-property-at-point ()
13928 "Compute the property at point.
13929 This looks for an enclosing column format, extracts the operator and
13930 then applies it to the property in the column format's scope."
13931 (interactive)
13932 (unless (org-at-property-p)
13933 (error "Not at a property"))
13934 (let ((prop (org-match-string-no-properties 2)))
13935 (org-columns-get-format-and-top-level)
13936 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
13937 (error "No operator defined for property %s" prop))
13938 (org-columns-compute prop)))
13940 (defvar org-property-allowed-value-functions nil
13941 "Hook for functions supplying allowed values for a specific property.
13942 The functions must take a single argument, the name of the property, and
13944 the values, this means that these values are intended as defaults for
13945 completion, but that other values should be allowed too.
13946 The functions must return nil if they are not responsible for this
13947 property.")
13949 (defun org-property-get-allowed-values (pom property &optional table)
13950 "Get allowed values for the property PROPERTY.
13951 When TABLE is non-nil, return an alist that can directly be used for
13952 completion."
13953 (let (vals)
13954 (cond
13955 ((equal property "TODO")
13956 (setq vals (org-with-point-at pom
13957 (append org-todo-keywords-1 '("")))))
13958 ((equal property "PRIORITY")
13959 (let ((n org-lowest-priority))
13960 (while (>= n org-highest-priority)
13961 (push (char-to-string n) vals)
13962 (setq n (1- n)))))
13963 ((member property org-special-properties))
13964 ((setq vals (run-hook-with-args-until-success
13965 'org-property-allowed-value-functions property)))
13966 (t
13967 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
13969 (setq vals (car (read-from-string (concat "(" vals ")"))))
13970 (setq vals (mapcar (lambda (x)
13971 (cond ((stringp x) x)
13972 ((numberp x) (number-to-string x))
13973 ((symbolp x) (symbol-name x))
13974 (t "???")))
13975 vals)))))
13976 (when (member ":ETC" vals)
13977 (setq vals (remove ":ETC" vals))
13978 (org-add-props (car vals) '(org-unrestricted t)))
13979 (if table (mapcar 'list vals) vals)))
13981 (defun org-property-previous-allowed-value (&optional previous)
13982 "Switch to the next allowed value for this property."
13983 (interactive)
13984 (org-property-next-allowed-value t))
13986 (defun org-property-next-allowed-value (&optional previous)
13987 "Switch to the next allowed value for this property."
13988 (interactive)
13989 (unless (org-at-property-p)
13990 (error "Not at a property"))
13991 (let* ((key (match-string 2))
13992 (value (match-string 3))
13993 (allowed (or (org-property-get-allowed-values (point) key)
13994 (and (member value '("[ ]" "[-]" "[X]"))
13995 '("[ ]" "[X]"))))
13996 nval)
13997 (unless allowed
13998 (error "Allowed values for this property have not been defined"))
13999 (if previous (setq allowed (reverse allowed)))
14000 (if (member value allowed)
14001 (setq nval (car (cdr (member value allowed)))))
14002 (setq nval (or nval (car allowed)))
14003 (if (equal nval value)
14004 (error "Only one allowed value for this property"))
14005 (org-at-property-p)
14006 (replace-match (concat " :" key ": " nval) t t)
14007 (org-indent-line-function)
14008 (beginning-of-line 1)
14010 (run-hook-with-args 'org-property-changed-functions key nval)))
14012 (defun org-find-olp (path &optional this-buffer)
14013 "Return a marker pointing to the entry at outline path OLP.
14014 If anything goes wrong, throw an error.
14015 You can wrap this call to catch the error like this:
14017 (condition-case msg
14018 (org-mobile-locate-entry (match-string 4))
14019 (error (nth 1 msg)))
14021 The return value will then be either a string with the error message,
14022 or a marker if everything is OK.
14024 If THIS-BUFFER is set, the outline path does not contain a file,
14025 only headings."
14026 (let* ((file (if this-buffer buffer-file-name (pop path)))
14027 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14028 (level 1)
14029 (lmin 1)
14030 (lmax 1)
14031 limit re end found pos heading cnt)
14032 (unless buffer (error "File not found :%s" file))
14033 (with-current-buffer buffer
14034 (save-excursion
14035 (save-restriction
14036 (widen)
14037 (setq limit (point-max))
14038 (goto-char (point-min))
14039 (while (setq heading (pop path))
14040 (setq re (format org-complex-heading-regexp-format
14041 (regexp-quote heading)))
14042 (setq cnt 0 pos (point))
14043 (while (re-search-forward re end t)
14044 (setq level (- (match-end 1) (match-beginning 1)))
14045 (if (and (>= level lmin) (<= level lmax))
14046 (setq found (match-beginning 0) cnt (1+ cnt))))
14047 (when (= cnt 0) (error "Heading not found on level %d: %s"
14048 lmax heading))
14049 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14050 lmax heading))
14051 (goto-char found)
14052 (setq lmin (1+ level) lmax (+ lmin (if org-odd-levels-only 1 0)))
14053 (setq end (save-excursion (org-end-of-subtree t t))))
14054 (when (org-on-heading-p)
14055 (move-marker (make-marker) (point))))))))
14057 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14058 "Find node HEADING in BUFFER.
14059 Return a marker to the heading if it was found, or nil if not.
14060 If POS-ONLY is set, return just the position instead of a marker.
14062 The heading text must match exact, but it may have a TODO keyword,
14063 a priority cookie and tags in the standard locations."
14064 (with-current-buffer (or buffer (current-buffer))
14065 (save-excursion
14066 (save-restriction
14067 (widen)
14068 (goto-char (point-min))
14069 (let (case-fold-search)
14070 (if (re-search-forward
14071 (format org-complex-heading-regexp-format
14072 (regexp-quote heading)) nil t)
14073 (if pos-only
14074 (match-beginning 0)
14075 (move-marker (make-marker) (match-beginning 0)))))))))
14077 (defun org-find-exact-heading-in-directory (heading &optional dir)
14078 "Find Org node headline HEADING in all .org files in directory DIR.
14079 When the target headline is found, return a marker to this location."
14080 (let ((files (directory-files (or dir default-directory)
14082 file visiting m buffer)
14083 (catch 'found
14084 (while (setq file (pop files))
14085 (message "trying %s" file)
14086 (setq visiting (org-find-base-buffer-visiting file))
14087 (setq buffer (or visiting (find-file-noselect file)))
14088 (setq m (org-find-exact-headline-in-buffer
14089 heading buffer))
14090 (when (and (not m) (not visiting)) (kill-buffer buffer))
14091 (and m (throw 'found m))))))
14093 (defun org-find-entry-with-id (ident)
14094 "Locate the entry that contains the ID property with exact value IDENT.
14095 IDENT can be a string, a symbol or a number, this function will search for
14096 the string representation of it.
14097 Return the position where this entry starts, or nil if there is no such entry."
14098 (interactive "sID: ")
14099 (let ((id (cond
14100 ((stringp ident) ident)
14101 ((symbol-name ident) (symbol-name ident))
14102 ((numberp ident) (number-to-string ident))
14103 (t (error "IDENT %s must be a string, symbol or number" ident))))
14104 (case-fold-search nil))
14105 (save-excursion
14106 (save-restriction
14107 (widen)
14108 (goto-char (point-min))
14109 (when (re-search-forward
14111 nil t)
14112 (org-back-to-heading t)
14113 (point))))))
14115 ;;;; Timestamps
14117 (defvar org-last-changed-timestamp nil)
14118 (defvar org-last-inserted-timestamp nil
14119 "The last time stamp inserted with `org-insert-time-stamp'.")
14120 (defvar org-time-was-given) ; dynamically scoped parameter
14121 (defvar org-end-time-was-given) ; dynamically scoped parameter
14122 (defvar org-ts-what) ; dynamically scoped parameter
14124 (defun org-time-stamp (arg &optional inactive)
14125 "Prompt for a date/time and insert a time stamp.
14126 If the user specifies a time like HH:MM, or if this command is called
14127 with a prefix argument, the time stamp will contain date and time.
14128 Otherwise, only the date will be included. All parts of a date not
14129 specified by the user will be filled in from the current date/time.
14130 So if you press just return without typing anything, the time stamp
14131 will represent the current date/time. If there is already a timestamp
14132 at the cursor, it will be modified."
14133 (interactive "P")
14134 (let* ((ts nil)
14135 (default-time
14136 ;; Default time is either today, or, when entering a range,
14137 ;; the range start.
14138 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14139 (save-excursion
14140 (re-search-backward
14142 (- (point) 20) t)))
14143 (apply 'encode-time (org-parse-time-string (match-string 1)))
14144 (current-time)))
14145 (default-input (and ts (org-get-compact-tod ts)))
14146 org-time-was-given org-end-time-was-given time)
14147 (cond
14148 ((and (org-at-timestamp-p t)
14149 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14150 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14151 (insert "--")
14152 (setq time (let ((this-command this-command))
14153 (org-read-date arg 'totime nil nil
14154 default-time default-input)))
14155 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14156 ((org-at-timestamp-p t)
14157 (setq time (let ((this-command this-command))
14158 (org-read-date arg 'totime nil nil default-time default-input)))
14159 (when (org-at-timestamp-p t) ; just to get the match data
14160 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14161 (replace-match "")
14162 (setq org-last-changed-timestamp
14163 (org-insert-time-stamp
14164 time (or org-time-was-given arg)
14165 inactive nil nil (list org-end-time-was-given))))
14166 (message "Timestamp updated"))
14167 (t
14168 (setq time (let ((this-command this-command))
14169 (org-read-date arg 'totime nil nil default-time default-input)))
14170 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14171 nil nil (list org-end-time-was-given))))))
14173 ;; FIXME: can we use this for something else, like computing time differences?
14174 (defun org-get-compact-tod (s)
14175 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14176 (let* ((t1 (match-string 1 s))
14177 (h1 (string-to-number (match-string 2 s)))
14178 (m1 (string-to-number (match-string 3 s)))
14179 (t2 (and (match-end 4) (match-string 5 s)))
14180 (h2 (and t2 (string-to-number (match-string 6 s))))
14181 (m2 (and t2 (string-to-number (match-string 7 s))))
14182 dh dm)
14183 (if (not t2)
14184 t1
14185 (setq dh (- h2 h1) dm (- m2 m1))
14186 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14187 (concat t1 "+" (number-to-string dh)
14188 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14190 (defun org-time-stamp-inactive (&optional arg)
14191 "Insert an inactive time stamp.
14192 An inactive time stamp is enclosed in square brackets instead of angle
14193 brackets. It is inactive in the sense that it does not trigger agenda entries,
14194 does not link to the calendar and cannot be changed with the S-cursor keys.
14195 So these are more for recording a certain time/date."
14196 (interactive "P")
14197 (org-time-stamp arg 'inactive))
14199 (defvar org-date-ovl (make-overlay 1 1))
14200 (overlay-put org-date-ovl 'face 'org-warning)
14201 (org-detach-overlay org-date-ovl)
14203 (defvar org-ans1) ; dynamically scoped parameter
14204 (defvar org-ans2) ; dynamically scoped parameter
14206 (defvar org-plain-time-of-day-regexp) ; defined below
14208 (defvar org-overriding-default-time nil) ; dynamically scoped
14209 (defvar org-read-date-overlay nil)
14210 (defvar org-dcst nil) ; dynamically scoped
14211 (defvar org-read-date-history nil)
14212 (defvar org-read-date-final-answer nil)
14214 (defun org-read-date (&optional with-time to-time from-string prompt
14215 default-time default-input)
14216 "Read a date, possibly a time, and make things smooth for the user.
14217 The prompt will suggest to enter an ISO date, but you can also enter anything
14218 which will at least partially be understood by `parse-time-string'.
14219 Unrecognized parts of the date will default to the current day, month, year,
14220 hour and minute. If this command is called to replace a timestamp at point,
14221 of to enter the second timestamp of a range, the default time is taken
14222 from the existing stamp. Furthermore, the command prefers the future,
14223 so if you are giving a date where the year is not given, and the day-month
14224 combination is already past in the current year, it will assume you
14225 mean next year. For details, see the manual. A few examples:
14227 3-2-5 --> 2003-02-05
14228 feb 15 --> currentyear-02-15
14229 2/15 --> currentyear-02-15
14230 sep 12 9 --> 2009-09-12
14231 12:45 --> today 12:45
14232 22 sept 0:34 --> currentyear-09-22 0:34
14233 12 --> currentyear-currentmonth-12
14234 Fri --> nearest Friday (today or later)
14235 etc.
14237 Furthermore you can specify a relative date by giving, as the *first* thing
14238 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14239 change in days weeks, months, years.
14240 With a single plus or minus, the date is relative to today. With a double
14241 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14242 +4d --> four days from today
14243 +4 --> same as above
14244 +2w --> two weeks from today
14245 ++5 --> five days from default date
14247 The function understands only English month and weekday abbreviations,
14248 but this can be configured with the variables `parse-time-months' and
14249 `parse-time-weekdays'.
14251 While prompting, a calendar is popped up - you can also select the
14252 date with the mouse (button 1). The calendar shows a period of three
14253 months. To scroll it to other months, use the keys `>' and `<'.
14254 If you don't like the calendar, turn it off with
14255 \(setq org-read-date-popup-calendar nil)
14257 With optional argument TO-TIME, the date will immediately be converted
14258 to an internal time.
14259 With an optional argument WITH-TIME, the prompt will suggest to also
14260 insert a time. Note that when WITH-TIME is not set, you can still
14261 enter a time, and this function will inform the calling routine about
14262 this change. The calling routine may then choose to change the format
14263 used to insert the time stamp into the buffer to include the time.
14264 With optional argument FROM-STRING, read from this string instead from
14265 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14266 the time/date that is used for everything that is not specified by the
14267 user."
14268 (require 'parse-time)
14269 (let* ((org-time-stamp-rounding-minutes
14270 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14271 (org-dcst org-display-custom-times)
14272 (ct (org-current-time))
14273 (def (or org-overriding-default-time default-time ct))
14274 (defdecode (decode-time def))
14275 (dummy (progn
14276 (when (< (nth 2 defdecode) org-extend-today-until)
14277 (setcar (nthcdr 2 defdecode) -1)
14278 (setcar (nthcdr 1 defdecode) 59)
14279 (setq def (apply 'encode-time defdecode)
14280 defdecode (decode-time def)))))
14281 (calendar-frame-setup nil)
14282 (calendar-setup nil)
14283 (calendar-move-hook nil)
14284 (calendar-view-diary-initially-flag nil)
14285 (calendar-view-holidays-initially-flag nil)
14286 (timestr (format-time-string
14287 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14288 (prompt (concat (if prompt (concat prompt " ") "")
14289 (format "Date+time [%s]: " timestr)))
14290 ans (org-ans0 "") org-ans1 org-ans2 final)
14292 (cond
14293 (from-string (setq ans from-string))
14294 (org-read-date-popup-calendar
14295 (save-excursion
14296 (save-window-excursion
14297 (calendar)
14298 (calendar-forward-day (- (time-to-days def)
14299 (calendar-absolute-from-gregorian
14300 (calendar-current-date))))
14301 (org-eval-in-calendar nil t)
14302 (let* ((old-map (current-local-map))
14303 (map (copy-keymap calendar-mode-map))
14304 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14305 (org-defkey map (kbd "RET") 'org-calendar-select)
14306 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14307 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14308 (org-defkey minibuffer-local-map [(meta shift left)]
14309 (lambda () (interactive)
14310 (org-eval-in-calendar '(calendar-backward-month 1))))
14311 (org-defkey minibuffer-local-map [(meta shift right)]
14312 (lambda () (interactive)
14313 (org-eval-in-calendar '(calendar-forward-month 1))))
14314 (org-defkey minibuffer-local-map [(meta shift up)]
14315 (lambda () (interactive)
14316 (org-eval-in-calendar '(calendar-backward-year 1))))
14317 (org-defkey minibuffer-local-map [(meta shift down)]
14318 (lambda () (interactive)
14319 (org-eval-in-calendar '(calendar-forward-year 1))))
14320 (org-defkey minibuffer-local-map [?\e (shift left)]
14321 (lambda () (interactive)
14322 (org-eval-in-calendar '(calendar-backward-month 1))))
14323 (org-defkey minibuffer-local-map [?\e (shift right)]
14324 (lambda () (interactive)
14325 (org-eval-in-calendar '(calendar-forward-month 1))))
14326 (org-defkey minibuffer-local-map [?\e (shift up)]
14327 (lambda () (interactive)
14328 (org-eval-in-calendar '(calendar-backward-year 1))))
14329 (org-defkey minibuffer-local-map [?\e (shift down)]
14330 (lambda () (interactive)
14331 (org-eval-in-calendar '(calendar-forward-year 1))))
14332 (org-defkey minibuffer-local-map [(shift up)]
14333 (lambda () (interactive)
14334 (org-eval-in-calendar '(calendar-backward-week 1))))
14335 (org-defkey minibuffer-local-map [(shift down)]
14336 (lambda () (interactive)
14337 (org-eval-in-calendar '(calendar-forward-week 1))))
14338 (org-defkey minibuffer-local-map [(shift left)]
14339 (lambda () (interactive)
14340 (org-eval-in-calendar '(calendar-backward-day 1))))
14341 (org-defkey minibuffer-local-map [(shift right)]
14342 (lambda () (interactive)
14343 (org-eval-in-calendar '(calendar-forward-day 1))))
14344 (org-defkey minibuffer-local-map ">"
14345 (lambda () (interactive)
14346 (org-eval-in-calendar '(scroll-calendar-left 1))))
14347 (org-defkey minibuffer-local-map "<"
14348 (lambda () (interactive)
14349 (org-eval-in-calendar '(scroll-calendar-right 1))))
14350 (org-defkey minibuffer-local-map "\C-v"
14351 (lambda () (interactive)
14352 (org-eval-in-calendar
14353 '(calendar-scroll-left-three-months 1))))
14354 (org-defkey minibuffer-local-map "\M-v"
14355 (lambda () (interactive)
14356 (org-eval-in-calendar
14357 '(calendar-scroll-right-three-months 1))))
14358 (run-hooks 'org-read-date-minibuffer-setup-hook)
14359 (unwind-protect
14360 (progn
14361 (use-local-map map)
14362 (add-hook 'post-command-hook 'org-read-date-display)
14363 (setq org-ans0 (read-string prompt default-input
14364 'org-read-date-history nil))
14365 ;; org-ans0: from prompt
14366 ;; org-ans1: from mouse click
14367 ;; org-ans2: from calendar motion
14368 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14369 (remove-hook 'post-command-hook 'org-read-date-display)
14370 (use-local-map old-map)
14371 (when org-read-date-overlay
14372 (delete-overlay org-read-date-overlay)
14373 (setq org-read-date-overlay nil)))))))
14375 (t ; Naked prompt only
14376 (unwind-protect
14377 (setq ans (read-string prompt default-input
14378 'org-read-date-history timestr))
14379 (when org-read-date-overlay
14380 (delete-overlay org-read-date-overlay)
14381 (setq org-read-date-overlay nil)))))
14383 (setq final (org-read-date-analyze ans def defdecode))
14385 ;; One round trip to get rid of 34th of August and stuff like that....
14386 (setq final (decode-time (apply 'encode-time final)))
14388 (setq org-read-date-final-answer ans)
14390 (if to-time
14391 (apply 'encode-time final)
14392 (if (and (boundp 'org-time-was-given) org-time-was-given)
14393 (format "%04d-%02d-%02d %02d:%02d"
14394 (nth 5 final) (nth 4 final) (nth 3 final)
14395 (nth 2 final) (nth 1 final))
14396 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14398 (defvar def)
14399 (defvar defdecode)
14400 (defvar with-time)
14401 (defvar org-read-date-analyze-futurep nil)
14402 (defun org-read-date-display ()
14403 "Display the current date prompt interpretation in the minibuffer."
14404 (when org-read-date-display-live
14405 (when org-read-date-overlay
14406 (delete-overlay org-read-date-overlay))
14407 (let ((p (point)))
14408 (end-of-line 1)
14409 (while (not (equal (buffer-substring
14410 (max (point-min) (- (point) 4)) (point))
14411 " "))
14412 (insert " "))
14413 (goto-char p))
14414 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14415 " " (or org-ans1 org-ans2)))
14416 (org-end-time-was-given nil)
14417 (f (org-read-date-analyze ans def defdecode))
14418 (fmts (if org-dcst
14419 org-time-stamp-custom-formats
14420 org-time-stamp-formats))
14421 (fmt (if (or with-time
14422 (and (boundp 'org-time-was-given) org-time-was-given))
14423 (cdr fmts)
14424 (car fmts)))
14425 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14426 (when (and org-end-time-was-given
14427 (string-match org-plain-time-of-day-regexp txt))
14428 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14429 org-end-time-was-given
14430 (substring txt (match-end 0)))))
14431 (when org-read-date-analyze-futurep
14432 (setq txt (concat txt " (=>F)")))
14433 (setq org-read-date-overlay
14434 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14435 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14437 (defun org-read-date-analyze (ans def defdecode)
14438 "Analyze the combined answer of the date prompt."
14439 ;; FIXME: cleanup and comment
14440 (let ((nowdecode (decode-time (current-time)))
14441 delta deltan deltaw deltadef year month day
14442 hour minute second wday pm h2 m2 tl wday1
14443 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14444 (setq org-read-date-analyze-futurep nil)
14446 (setq ans "+0"))
14448 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14449 (setq ans (replace-match "" t t ans)
14450 deltan (car delta)
14451 deltaw (nth 1 delta)
14452 deltadef (nth 2 delta)))
14454 ;; Check if there is an iso week date in there
14455 ;; If yes, store the info and postpone interpreting it until the rest
14456 ;; of the parsing is done
14457 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14458 (setq iso-year (if (match-end 1)
14459 (org-small-year-to-year
14460 (string-to-number (match-string 1 ans))))
14461 iso-weekday (if (match-end 3)
14462 (string-to-number (match-string 3 ans)))
14463 iso-week (string-to-number (match-string 2 ans)))
14464 (setq ans (replace-match "" t t ans)))
14466 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14467 (when (string-match
14469 (setq year (if (match-end 2)
14470 (string-to-number (match-string 2 ans))
14471 (progn (setq kill-year t)
14472 (string-to-number (format-time-string "%Y"))))
14473 month (string-to-number (match-string 3 ans))
14474 day (string-to-number (match-string 4 ans)))
14475 (if (< year 100) (setq year (+ 2000 year)))
14477 t nil ans)))
14478 ;; Help matching american dates, like 5/30 or 5/30/7
14479 (when (string-match
14480 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14481 (setq year (if (match-end 4)
14482 (string-to-number (match-string 4 ans))
14483 (progn (setq kill-year t)
14484 (string-to-number (format-time-string "%Y"))))
14485 month (string-to-number (match-string 1 ans))
14486 day (string-to-number (match-string 2 ans)))
14487 (if (< year 100) (setq year (+ 2000 year)))
14489 t nil ans)))
14490 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14491 ;; If there is a time with am/pm, and *no* time without it, we convert
14492 ;; so that matching will be successful.
14493 (loop for i from 1 to 2 do ; twice, for end time as well
14496 (setq hour (string-to-number (match-string 1 ans))
14497 minute (if (match-end 3)
14498 (string-to-number (match-string 3 ans))
14499 0)
14500 pm (equal ?p
14501 (string-to-char (downcase (match-string 4 ans)))))
14502 (if (and (= hour 12) (not pm))
14503 (setq hour 0)
14504 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14505 (setq ans (replace-match (format "%02d:%02d" hour minute)
14506 t t ans))))
14508 ;; Check if a time range is given as a duration
14509 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14510 (setq hour (string-to-number (match-string 1 ans))
14511 h2 (+ hour (string-to-number (match-string 3 ans)))
14512 minute (string-to-number (match-string 2 ans))
14513 m2 (+ minute (if (match-end 5) (string-to-number
14514 (match-string 5 ans))0)))
14515 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14516 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14517 t t ans)))
14519 ;; Check if there is a time range
14520 (when (boundp 'org-end-time-was-given)
14521 (setq org-time-was-given nil)
14522 (when (and (string-match org-plain-time-of-day-regexp ans)
14523 (match-end 8))
14524 (setq org-end-time-was-given (match-string 8 ans))
14525 (setq ans (concat (substring ans 0 (match-beginning 7))
14526 (substring ans (match-end 7))))))
14528 (setq tl (parse-time-string ans)
14529 day (or (nth 3 tl) (nth 3 defdecode))
14530 month (or (nth 4 tl)
14531 (if (and org-read-date-prefer-future
14532 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14533 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14534 (nth 4 defdecode)))
14535 year (or (and (not kill-year) (nth 5 tl))
14536 (if (and org-read-date-prefer-future
14537 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14538 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14539 (nth 5 defdecode)))
14540 hour (or (nth 2 tl) (nth 2 defdecode))
14541 minute (or (nth 1 tl) (nth 1 defdecode))
14542 second (or (nth 0 tl) 0)
14543 wday (nth 6 tl))
14545 (when (and (eq org-read-date-prefer-future 'time)
14546 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14547 (equal day (nth 3 nowdecode))
14548 (equal month (nth 4 nowdecode))
14549 (equal year (nth 5 nowdecode))
14550 (nth 2 tl)
14551 (or (< (nth 2 tl) (nth 2 nowdecode))
14552 (and (= (nth 2 tl) (nth 2 nowdecode))
14553 (nth 1 tl)
14554 (< (nth 1 tl) (nth 1 nowdecode)))))
14555 (setq day (1+ day)
14556 futurep t))
14558 ;; Special date definitions below
14559 (cond
14560 (iso-week
14561 ;; There was an iso week
14562 (require 'cal-iso)
14563 (setq futurep nil)
14564 (setq year (or iso-year year)
14565 day (or iso-weekday wday 1)
14566 wday nil ; to make sure that the trigger below does not match
14567 iso-date (calendar-gregorian-from-absolute
14568 (calendar-absolute-from-iso
14569 (list iso-week day year))))
14570 ; FIXME: Should we also push ISO weeks into the future?
14571 ; (when (and org-read-date-prefer-future
14572 ; (not iso-year)
14573 ; (< (calendar-absolute-from-gregorian iso-date)
14574 ; (time-to-days (current-time))))
14575 ; (setq year (1+ year)
14576 ; iso-date (calendar-gregorian-from-absolute
14577 ; (calendar-absolute-from-iso
14578 ; (list iso-week day year)))))
14579 (setq month (car iso-date)
14580 year (nth 2 iso-date)
14581 day (nth 1 iso-date)))
14582 (deltan
14583 (setq futurep nil)
14584 (unless deltadef
14585 (let ((now (decode-time (current-time))))
14586 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14587 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14588 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14589 ((equal deltaw "m") (setq month (+ month deltan)))
14590 ((equal deltaw "y") (setq year (+ year deltan)))))
14591 ((and wday (not (nth 3 tl)))
14592 (setq futurep nil)
14593 ;; Weekday was given, but no day, so pick that day in the week
14594 ;; on or after the derived date.
14595 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14596 (unless (equal wday wday1)
14597 (setq day (+ day (% (- wday wday1 -7) 7))))))
14598 (if (and (boundp 'org-time-was-given)
14599 (nth 2 tl))
14600 (setq org-time-was-given t))
14601 (if (< year 100) (setq year (+ 2000 year)))
14602 (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
14603 (setq org-read-date-analyze-futurep futurep)
14604 (list second minute hour day month year)))
14606 (defvar parse-time-weekdays)
14608 (defun org-read-date-get-relative (s today default)
14609 "Check string S for special relative date string.
14610 TODAY and DEFAULT are internal times, for today and for a default.
14611 Return shift list (N what def-flag)
14613 N is the number of WHATs to shift.
14614 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14615 the DEFAULT date rather than TODAY."
14616 (when (and
14617 (string-match
14618 (concat
14623 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14624 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14625 (string-to-char (substring (match-string 1 s) -1))
14626 ?+))
14627 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14628 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14629 (what (if (match-end 3) (match-string 3 s) "d"))
14630 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14631 (date (if rel default today))
14632 (wday (nth 6 (decode-time date)))
14633 delta)
14634 (if wday1
14635 (progn
14636 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14637 (if (= dir ?-) (setq delta (- delta 7)))
14638 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14639 (list delta "d" rel))
14640 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14642 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14643 "Turn a user-specified date into the internal representation.
14644 The internal representation needed by the calendar is (month day year).
14645 This is a wrapper to handle the brain-dead convention in calendar that
14646 user function argument order change dependent on argument order."
14647 (if (boundp 'calendar-date-style)
14648 (cond
14649 ((eq calendar-date-style 'american)
14650 (list arg1 arg2 arg3))
14651 ((eq calendar-date-style 'european)
14652 (list arg2 arg1 arg3))
14653 ((eq calendar-date-style 'iso)
14654 (list arg2 arg3 arg1)))
14655 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
14656 (if (org-bound-and-true-p european-calendar-style)
14657 (list arg2 arg1 arg3)
14658 (list arg1 arg2 arg3)))))
14660 (defun org-eval-in-calendar (form &optional keepdate)
14661 "Eval FORM in the calendar window and return to current window.
14662 Also, store the cursor date in variable org-ans2."
14663 (let ((sf (selected-frame))
14664 (sw (selected-window)))
14665 (select-window (get-buffer-window "*Calendar*" t))
14666 (eval form)
14667 (when (and (not keepdate) (calendar-cursor-to-date))
14668 (let* ((date (calendar-cursor-to-date))
14669 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14670 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
14671 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
14672 (select-window sw)
14673 (org-select-frame-set-input-focus sf)))
14675 (defun org-calendar-select ()
14676 "Return to `org-read-date' with the date currently selected.
14677 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14678 (interactive)
14679 (when (calendar-cursor-to-date)
14680 (let* ((date (calendar-cursor-to-date))
14681 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14682 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14683 (if (active-minibuffer-window) (exit-minibuffer))))
14685 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
14686 "Insert a date stamp for the date given by the internal TIME.
14687 WITH-HM means use the stamp format that includes the time of the day.
14688 INACTIVE means use square brackets instead of angular ones, so that the
14689 stamp will not contribute to the agenda.
14690 PRE and POST are optional strings to be inserted before and after the
14691 stamp.
14692 The command returns the inserted time stamp."
14693 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
14694 stamp)
14695 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
14696 (insert-before-markers (or pre ""))
14697 (when (listp extra)
14698 (setq extra (car extra))
14699 (if (and (stringp extra)
14701 (setq extra (format "-%02d:%02d"
14702 (string-to-number (match-string 1 extra))
14703 (string-to-number (match-string 2 extra))))
14704 (setq extra nil)))
14705 (when extra
14706 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
14707 (insert-before-markers (setq stamp (format-time-string fmt time)))
14708 (insert-before-markers (or post ""))
14709 (setq org-last-inserted-timestamp stamp)))
14711 (defun org-toggle-time-stamp-overlays ()
14712 "Toggle the use of custom time stamp formats."
14713 (interactive)
14714 (setq org-display-custom-times (not org-display-custom-times))
14715 (unless org-display-custom-times
14716 (let ((p (point-min)) (bmp (buffer-modified-p)))
14717 (while (setq p (next-single-property-change p 'display))
14718 (if (and (get-text-property p 'display)
14719 (eq (get-text-property p 'face) 'org-date))
14720 (remove-text-properties
14721 p (setq p (next-single-property-change p 'display))
14722 '(display t))))
14723 (set-buffer-modified-p bmp)))
14724 (if (featurep 'xemacs)
14725 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
14726 (org-restart-font-lock)
14727 (setq org-table-may-need-update t)
14728 (if org-display-custom-times
14729 (message "Time stamps are overlayed with custom format")
14730 (message "Time stamp overlays removed")))
14732 (defun org-display-custom-time (beg end)
14733 "Overlay modified time stamp format over timestamp between BEG and END."
14734 (let* ((ts (buffer-substring beg end))
14735 t1 w1 with-hm tf time str w2 (off 0))
14736 (save-match-data
14737 (setq t1 (org-parse-time-string ts t))
14738 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
14739 (setq off (- (match-end 0) (match-beginning 0)))))
14740 (setq end (- end off))
14741 (setq w1 (- end beg)
14742 with-hm (and (nth 1 t1) (nth 2 t1))
14743 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
14744 time (org-fix-decoded-time t1)
14745 str (org-add-props
14746 (format-time-string
14747 (substring tf 1 -1) (apply 'encode-time time))
14748 nil 'mouse-face 'highlight)
14749 w2 (length str))
14750 (if (not (= w2 w1))
14751 (add-text-properties (1+ beg) (+ 2 beg)
14752 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
14753 (if (featurep 'xemacs)
14754 (progn
14755 (put-text-property beg end 'invisible t)
14756 (put-text-property beg end 'end-glyph (make-glyph str)))
14757 (put-text-property beg end 'display str))))
14759 (defun org-translate-time (string)
14760 "Translate all timestamps in STRING to custom format.
14761 But do this only if the variable `org-display-custom-times' is set."
14762 (when org-display-custom-times
14763 (save-match-data
14764 (let* ((start 0)
14765 (re org-ts-regexp-both)
14766 t1 with-hm inactive tf time str beg end)
14767 (while (setq start (string-match re string start))
14768 (setq beg (match-beginning 0)
14769 end (match-end 0)
14770 t1 (save-match-data
14771 (org-parse-time-string (substring string beg end) t))
14772 with-hm (and (nth 1 t1) (nth 2 t1))
14773 inactive (equal (substring string beg (1+ beg)) "[")
14774 tf (funcall (if with-hm 'cdr 'car)
14775 org-time-stamp-custom-formats)
14776 time (org-fix-decoded-time t1)
14777 str (format-time-string
14778 (concat
14779 (if inactive "[" "<") (substring tf 1 -1)
14780 (if inactive "]" ">"))
14781 (apply 'encode-time time))
14782 string (replace-match str t t string)
14783 start (+ start (length str)))))))
14784 string)
14786 (defun org-fix-decoded-time (time)
14787 "Set 0 instead of nil for the first 6 elements of time.
14788 Don't touch the rest."
14789 (let ((n 0))
14790 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
14792 (defun org-days-to-time (timestamp-string)
14793 "Difference between TIMESTAMP-STRING and now in days."
14794 (- (time-to-days (org-time-string-to-time timestamp-string))
14795 (time-to-days (current-time))))
14797 (defun org-deadline-close (timestamp-string &optional ndays)
14798 "Is the time in TIMESTAMP-STRING close to the current date?"
14799 (setq ndays (or ndays (org-get-wdays timestamp-string)))
14800 (and (< (org-days-to-time timestamp-string) ndays)
14801 (not (org-entry-is-done-p))))
14803 (defun org-get-wdays (ts)
14804 "Get the deadline lead time appropriate for timestring TS."
14805 (cond
14806 ((<= org-deadline-warning-days 0)
14807 ;; 0 or negative, enforce this value no matter what
14808 (- org-deadline-warning-days))
14810 ;; lead time is specified.
14811 (floor (* (string-to-number (match-string 1 ts))
14812 (cdr (assoc (match-string 2 ts)
14813 '(("d" . 1) ("w" . 7)
14814 ("m" . 30.4) ("y" . 365.25)))))))
14815 ;; go for the default.
14816 (t org-deadline-warning-days)))
14818 (defun org-calendar-select-mouse (ev)
14819 "Return to `org-read-date' with the date currently selected.
14820 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14821 (interactive "e")
14822 (mouse-set-point ev)
14823 (when (calendar-cursor-to-date)
14824 (let* ((date (calendar-cursor-to-date))
14825 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14826 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14827 (if (active-minibuffer-window) (exit-minibuffer))))
14829 (defun org-check-deadlines (ndays)
14830 "Check if there are any deadlines due or past due.
14831 A deadline is considered due if it happens within `org-deadline-warning-days'
14832 days from today's date. If the deadline appears in an entry marked DONE,
14833 it is not shown. The prefix arg NDAYS can be used to test that many
14835 (interactive "P")
14836 (let* ((org-warn-days
14837 (cond
14838 ((equal ndays '(4)) 100000)
14839 (ndays (prefix-numeric-value ndays))
14840 (t (abs org-deadline-warning-days))))
14841 (case-fold-search nil)
14843 (callback
14844 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
14846 (message "%d deadlines past-due or due within %d days"
14847 (org-occur regexp nil callback)
14848 org-warn-days)))
14850 (defun org-check-before-date (date)
14851 "Check if there are deadlines or scheduled entries before DATE."
14852 (interactive (list (org-read-date)))
14853 (let ((case-fold-search nil)
14857 (callback
14858 (lambda () (time-less-p
14859 (org-time-string-to-time (match-string 2))
14860 (org-time-string-to-time date)))))
14861 (message "%d entries before %s"
14862 (org-occur regexp nil callback) date)))
14864 (defun org-check-after-date (date)
14865 "Check if there are deadlines or scheduled entries after DATE."
14866 (interactive (list (org-read-date)))
14867 (let ((case-fold-search nil)
14871 (callback
14872 (lambda () (not
14873 (time-less-p
14874 (org-time-string-to-time (match-string 2))
14875 (org-time-string-to-time date))))))
14876 (message "%d entries after %s"
14877 (org-occur regexp nil callback) date)))
14879 (defun org-evaluate-time-range (&optional to-buffer)
14880 "Evaluate a time range by computing the difference between start and end.
14881 Normally the result is just printed in the echo area, but with prefix arg
14882 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
14883 If the time range is actually in a table, the result is inserted into the
14884 next column.
14885 For time difference computation, a year is assumed to be exactly 365
14886 days in order to avoid rounding problems."
14887 (interactive "P")
14888 (or
14889 (org-clock-update-time-maybe)
14890 (save-excursion
14891 (unless (org-at-date-range-p t)
14892 (goto-char (point-at-bol))
14893 (re-search-forward org-tr-regexp-both (point-at-eol) t))
14894 (if (not (org-at-date-range-p t))
14895 (error "Not at a time-stamp range, and none found in current line")))
14896 (let* ((ts1 (match-string 1))
14897 (ts2 (match-string 2))
14898 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
14899 (match-end (match-end 0))
14900 (time1 (org-time-string-to-time ts1))
14901 (time2 (org-time-string-to-time ts2))
14902 (t1 (org-float-time time1))
14903 (t2 (org-float-time time2))
14904 (diff (abs (- t2 t1)))
14905 (negative (< (- t2 t1) 0))
14906 ;; (ys (floor (* 365 24 60 60)))
14907 (ds (* 24 60 60))
14908 (hs (* 60 60))
14909 (fy "%dy %dd %02d:%02d")
14910 (fy1 "%dy %dd")
14911 (fd "%dd %02d:%02d")
14912 (fd1 "%dd")
14913 (fh "%02d:%02d")
14914 y d h m align)
14915 (if havetime
14916 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14917 y 0
14918 d (floor (/ diff ds)) diff (mod diff ds)
14919 h (floor (/ diff hs)) diff (mod diff hs)
14920 m (floor (/ diff 60)))
14921 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14922 y 0
14923 d (floor (+ (/ diff ds) 0.5))
14924 h 0 m 0))
14925 (if (not to-buffer)
14926 (message "%s" (org-make-tdiff-string y d h m))
14927 (if (org-at-table-p)
14928 (progn
14929 (goto-char match-end)
14930 (setq align t)
14931 (and (looking-at " *|") (goto-char (match-end 0))))
14932 (goto-char match-end))
14933 (if (looking-at
14935 (replace-match ""))
14936 (if negative (insert " -"))
14937 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
14938 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
14939 (insert " " (format fh h m))))
14940 (if align (org-table-align))
14941 (message "Time difference inserted")))))
14943 (defun org-make-tdiff-string (y d h m)
14944 (let ((fmt "")
14945 (l nil))
14946 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
14947 l (push y l)))
14948 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
14949 l (push d l)))
14950 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
14951 l (push h l)))
14952 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
14953 l (push m l)))
14954 (apply 'format fmt (nreverse l))))
14956 (defun org-time-string-to-time (s)
14957 (apply 'encode-time (org-parse-time-string s)))
14958 (defun org-time-string-to-seconds (s)
14959 (org-float-time (org-time-string-to-time s)))
14961 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
14962 "Convert a time stamp to an absolute day number.
14963 If there is a specifier for a cyclic time stamp, get the closest date to
14964 DAYNR.
14965 PREFER and SHOW-ALL are passed through to `org-closest-date'.
14966 the variable date is bound by the calendar when this is called."
14967 (cond
14969 (if (org-diary-sexp-entry (match-string 1 s) "" date)
14970 daynr
14971 (+ daynr 1000)))
14973 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
14974 (time-to-days (current-time))) (match-string 0 s)
14975 prefer show-all))
14976 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
14978 (defun org-days-to-iso-week (days)
14979 "Return the iso week number."
14980 (require 'cal-iso)
14981 (car (calendar-iso-from-absolute days)))
14983 (defun org-small-year-to-year (year)
14984 "Convert 2-digit years into 4-digit years.
14985 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
14986 The year 2000 cannot be abbreviated. Any year larger than 99
14987 is returned unchanged."
14988 (if (< year 38)
14989 (setq year (+ 2000 year))
14990 (if (< year 100)
14991 (setq year (+ 1900 year))))
14992 year)
14994 (defun org-time-from-absolute (d)
14995 "Return the time corresponding to date D.
14996 D may be an absolute day number, or a calendar-type list (month day year)."
14997 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
14998 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15000 (defun org-calendar-holiday ()
15001 "List of holidays, for Diary display in Org-mode."
15002 (require 'holidays)
15003 (let ((hl (funcall
15004 (if (fboundp 'calendar-check-holidays)
15005 'calendar-check-holidays 'check-calendar-holidays) date)))
15006 (if hl (mapconcat 'identity hl "; "))))
15008 (defun org-diary-sexp-entry (sexp entry date)
15009 "Process a SEXP diary ENTRY for DATE."
15010 (require 'diary-lib)
15011 (let ((result (if calendar-debug-sexp
15012 (let ((stack-trace-on-error t))
15013 (eval (car (read-from-string sexp))))
15014 (condition-case nil
15015 (eval (car (read-from-string sexp)))
15016 (error
15017 (beep)
15018 (message "Bad sexp at line %d in %s: %s"
15019 (org-current-line)
15020 (buffer-file-name) sexp)
15021 (sleep-for 2))))))
15022 (cond ((stringp result) (split-string result "; "))
15023 ((and (consp result)
15024 (not (consp (cdr result)))
15025 (stringp (cdr result))) (cdr result))
15026 ((and (consp result)
15027 (stringp (car result))) result)
15028 (result entry)
15029 (t nil))))
15031 (defun org-diary-to-ical-string (frombuf)
15032 "Get iCalendar entries from diary entries in buffer FROMBUF.
15033 This uses the icalendar.el library."
15034 (let* ((tmpdir (if (featurep 'xemacs)
15035 (temp-directory)
15036 temporary-file-directory))
15037 (tmpfile (make-temp-name
15038 (expand-file-name "orgics" tmpdir)))
15039 buf rtn b e)
15040 (with-current-buffer frombuf
15041 (icalendar-export-region (point-min) (point-max) tmpfile)
15042 (setq buf (find-buffer-visiting tmpfile))
15043 (set-buffer buf)
15044 (goto-char (point-min))
15045 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15046 (setq b (match-beginning 0)))
15047 (goto-char (point-max))
15048 (if (re-search-backward "^END:VEVENT" nil t)
15049 (setq e (match-end 0)))
15051 (kill-buffer buf)
15052 (delete-file tmpfile)
15053 rtn))
15055 (defun org-closest-date (start current change prefer show-all)
15056 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15057 When PREFER is `past' return a date that is either CURRENT or past.
15058 When PREFER is `future', return a date that is either CURRENT or future.
15059 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15060 ;; Make the proper lists from the dates
15061 (catch 'exit
15062 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15063 dn dw sday cday n1 n2 n0
15064 d m y y1 y2 date1 date2 nmonths nm ny m2)
15066 (setq start (org-date-to-gregorian start)
15067 current (org-date-to-gregorian
15068 (if show-all
15069 current
15070 (time-to-days (current-time))))
15071 sday (calendar-absolute-from-gregorian start)
15072 cday (calendar-absolute-from-gregorian current))
15074 (if (<= cday sday) (throw 'exit sday))
15077 (setq dn (string-to-number (match-string 1 change))
15078 dw (cdr (assoc (match-string 2 change) a1)))
15079 (error "Invalid change specifier: %s" change))
15080 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15081 (cond
15082 ((eq dw 'day)
15083 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15084 n2 (+ n1 dn)))
15085 ((eq dw 'year)
15086 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15087 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15088 (setq date1 (list m d y1)
15089 n1 (calendar-absolute-from-gregorian date1)
15090 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15091 n2 (calendar-absolute-from-gregorian date2)))
15092 ((eq dw 'month)
15093 ;; approx number of month between the two dates
15094 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15095 ;; How often does dn fit in there?
15096 (setq d (nth 1 start) m (car start) y (nth 2 start)
15097 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15098 m (+ m nm)
15099 ny (floor (/ m 12))
15100 y (+ y ny)
15101 m (- m (* ny 12)))
15102 (while (> m 12) (setq m (- m 12) y (1+ y)))
15103 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15104 (setq m2 (+ m dn) y2 y)
15105 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15106 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15107 (while (<= n2 cday)
15108 (setq n1 n2 m m2 y y2)
15109 (setq m2 (+ m dn) y2 y)
15110 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15111 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15112 ;; Make sure n1 is the earlier date
15113 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15114 (if show-all
15115 (cond
15116 ((eq prefer 'past) (if (= cday n2) n2 n1))
15117 ((eq prefer 'future) (if (= cday n1) n1 n2))
15118 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15119 (cond
15120 ((eq prefer 'past) (if (= cday n2) n2 n1))
15121 ((eq prefer 'future) (if (= cday n1) n1 n2))
15122 (t (if (= cday n1) n1 n2)))))))
15124 (defun org-date-to-gregorian (date)
15125 "Turn any specification of DATE into a Gregorian date for the calendar."
15126 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15127 ((and (listp date) (= (length date) 3)) date)
15128 ((stringp date)
15129 (setq date (org-parse-time-string date))
15130 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15131 ((listp date)
15132 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15134 (defun org-parse-time-string (s &optional nodefault)
15135 "Parse the standard Org-mode time string.
15136 This should be a lot faster than the normal `parse-time-string'.
15137 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15138 hour and minute fields will be nil if not given."
15139 (if (string-match org-ts-regexp0 s)
15140 (list 0
15141 (if (or (match-beginning 8) (not nodefault))
15142 (string-to-number (or (match-string 8 s) "0")))
15143 (if (or (match-beginning 7) (not nodefault))
15144 (string-to-number (or (match-string 7 s) "0")))
15145 (string-to-number (match-string 4 s))
15146 (string-to-number (match-string 3 s))
15147 (string-to-number (match-string 2 s))
15148 nil nil nil)
15149 (error "Not a standard Org-mode time string: %s" s)))
15151 (defun org-timestamp-up (&optional arg)
15152 "Increase the date item at the cursor by one.
15153 If the cursor is on the year, change the year. If it is on the month or
15154 the day, change that.
15155 With prefix ARG, change by that many units."
15156 (interactive "p")
15157 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15159 (defun org-timestamp-down (&optional arg)
15160 "Decrease the date item at the cursor by one.
15161 If the cursor is on the year, change the year. If it is on the month or
15162 the day, change that.
15163 With prefix ARG, change by that many units."
15164 (interactive "p")
15165 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15167 (defun org-timestamp-up-day (&optional arg)
15168 "Increase the date in the time stamp by one day.
15169 With prefix ARG, change that many days."
15170 (interactive "p")
15171 (if (and (not (org-at-timestamp-p t))
15172 (org-on-heading-p))
15173 (org-todo 'up)
15174 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15176 (defun org-timestamp-down-day (&optional arg)
15177 "Decrease the date in the time stamp by one day.
15178 With prefix ARG, change that many days."
15179 (interactive "p")
15180 (if (and (not (org-at-timestamp-p t))
15181 (org-on-heading-p))
15182 (org-todo 'down)
15183 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15185 (defun org-at-timestamp-p (&optional inactive-ok)
15186 "Determine if the cursor is in or at a timestamp."
15187 (interactive)
15188 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15189 (pos (point))
15190 (ans (or (looking-at tsr)
15191 (save-excursion
15193 (if (> (point) (point-min)) (backward-char 1))
15194 (and (looking-at tsr)
15195 (> (- (match-end 0) pos) -1))))))
15196 (and ans
15197 (boundp 'org-ts-what)
15198 (setq org-ts-what
15199 (cond
15200 ((= pos (match-beginning 0)) 'bracket)
15201 ((= pos (1- (match-end 0))) 'bracket)
15202 ((org-pos-in-match-range pos 2) 'year)
15203 ((org-pos-in-match-range pos 3) 'month)
15204 ((org-pos-in-match-range pos 7) 'hour)
15205 ((org-pos-in-match-range pos 8) 'minute)
15206 ((or (org-pos-in-match-range pos 4)
15207 (org-pos-in-match-range pos 5)) 'day)
15208 ((and (> pos (or (match-end 8) (match-end 5)))
15209 (< pos (match-end 0)))
15210 (- pos (or (match-end 8) (match-end 5))))
15211 (t 'day))))
15212 ans))
15214 (defun org-toggle-timestamp-type ()
15215 "Toggle the type (<active> or [inactive]) of a time stamp."
15216 (interactive)
15217 (when (org-at-timestamp-p t)
15218 (let ((beg (match-beginning 0)) (end (match-end 0))
15219 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15220 (save-excursion
15221 (goto-char beg)
15222 (while (re-search-forward "[][<>]" end t)
15223 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15224 t t)))
15225 (message "Timestamp is now %sactive"
15226 (if (equal (char-after beg) ?<) "" "in")))))
15228 (defun org-timestamp-change (n &optional what updown)
15229 "Change the date in the time stamp at point.
15230 The date will be changed by N times WHAT. WHAT can be `day', `month',
15231 `year', `minute', `second'. If WHAT is not given, the cursor position
15232 in the timestamp determines what will be changed."
15233 (let ((pos (point))
15234 with-hm inactive
15235 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15236 org-ts-what
15237 extra rem
15238 ts time time0)
15239 (if (not (org-at-timestamp-p t))
15240 (error "Not at a timestamp"))
15241 (if (and (not what) (eq org-ts-what 'bracket))
15242 (org-toggle-timestamp-type)
15243 (if (and (not what) (not (eq org-ts-what 'day))
15244 org-display-custom-times
15245 (get-text-property (point) 'display)
15246 (not (get-text-property (1- (point)) 'display)))
15247 (setq org-ts-what 'day))
15248 (setq org-ts-what (or what org-ts-what)
15249 inactive (= (char-after (match-beginning 0)) ?\[)
15250 ts (match-string 0))
15251 (replace-match "")
15252 (if (string-match
15254 ts)
15255 (setq extra (match-string 1 ts)))
15257 (setq with-hm t))
15258 (setq time0 (org-parse-time-string ts))
15259 (when (and updown
15260 (eq org-ts-what 'minute)
15261 (not current-prefix-arg))
15262 ;; This looks like s-up and s-down. Change by one rounding step.
15263 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15264 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15265 (setcar (cdr time0) (+ (nth 1 time0)
15266 (if (> n 0) (- rem) (- dm rem))))))
15267 (setq time
15268 (encode-time (or (car time0) 0)
15269 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15270 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15271 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15272 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15273 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15274 (nthcdr 6 time0)))
15275 (when (and (member org-ts-what '(hour minute))
15276 extra
15278 (setq extra (org-modify-ts-extra
15279 extra
15280 (if (eq org-ts-what 'hour) 2 5)
15281 n dm)))
15282 (when (integerp org-ts-what)
15283 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15284 (if (eq what 'calendar)
15285 (let ((cal-date (org-get-date-from-calendar)))
15286 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15287 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15288 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15289 (setcar time0 (or (car time0) 0))
15290 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15291 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15292 (setq time (apply 'encode-time time0))))
15293 (setq org-last-changed-timestamp
15294 (org-insert-time-stamp time with-hm inactive nil nil extra))
15295 (org-clock-update-time-maybe)
15296 (goto-char pos)
15297 ;; Try to recenter the calendar window, if any
15298 (if (and org-calendar-follow-timestamp-change
15299 (get-buffer-window "*Calendar*" t)
15300 (memq org-ts-what '(day month year)))
15301 (org-recenter-calendar (time-to-days time))))))
15303 (defun org-modify-ts-extra (s pos n dm)
15304 "Change the different parts of the lead-time and repeat fields in timestamp."
15305 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15306 ng h m new rem)
15307 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15308 (cond
15309 ((or (org-pos-in-match-range pos 2)
15310 (org-pos-in-match-range pos 3))
15311 (setq m (string-to-number (match-string 3 s))
15312 h (string-to-number (match-string 2 s)))
15313 (if (org-pos-in-match-range pos 2)
15314 (setq h (+ h n))
15315 (setq n (* dm (org-no-warnings (signum n))))
15316 (when (not (= 0 (setq rem (% m dm))))
15317 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15318 (setq m (+ m n)))
15319 (if (< m 0) (setq m (+ m 60) h (1- h)))
15320 (if (> m 59) (setq m (- m 60) h (1+ h)))
15321 (setq h (min 24 (max 0 h)))
15322 (setq ng 1 new (format "-%02d:%02d" h m)))
15323 ((org-pos-in-match-range pos 6)
15324 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15325 ((org-pos-in-match-range pos 5)
15326 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15328 ((org-pos-in-match-range pos 9)
15329 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15330 ((org-pos-in-match-range pos 8)
15331 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15333 (when ng
15334 (setq s (concat
15335 (substring s 0 (match-beginning ng))
15336 new
15337 (substring s (match-end ng))))))
15338 s))
15340 (defun org-recenter-calendar (date)
15341 "If the calendar is visible, recenter it to DATE."
15342 (let* ((win (selected-window))
15343 (cwin (get-buffer-window "*Calendar*" t))
15344 (calendar-move-hook nil))
15345 (when cwin
15346 (select-window cwin)
15347 (calendar-goto-date (if (listp date) date
15348 (calendar-gregorian-from-absolute date)))
15349 (select-window win))))
15351 (defun org-goto-calendar (&optional arg)
15352 "Go to the Emacs calendar at the current date.
15353 If there is a time stamp in the current line, go to that date.
15354 A prefix ARG can be used to force the current date."
15355 (interactive "P")
15356 (let ((tsr org-ts-regexp) diff
15357 (calendar-move-hook nil)
15358 (calendar-view-holidays-initially-flag nil)
15359 (calendar-view-diary-initially-flag nil))
15360 (if (or (org-at-timestamp-p)
15361 (save-excursion
15362 (beginning-of-line 1)
15363 (looking-at (concat ".*" tsr))))
15364 (let ((d1 (time-to-days (current-time)))
15365 (d2 (time-to-days
15366 (org-time-string-to-time (match-string 1)))))
15367 (setq diff (- d2 d1))))
15368 (calendar)
15369 (calendar-goto-today)
15370 (if (and diff (not arg)) (calendar-forward-day diff))))
15372 (defun org-get-date-from-calendar ()
15373 "Return a list (month day year) of date at point in calendar."
15374 (with-current-buffer "*Calendar*"
15375 (save-match-data
15376 (calendar-cursor-to-date))))
15378 (defun org-date-from-calendar ()
15379 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15380 If there is already a time stamp at the cursor position, update it."
15381 (interactive)
15382 (if (org-at-timestamp-p t)
15383 (org-timestamp-change 0 'calendar)
15384 (let ((cal-date (org-get-date-from-calendar)))
15385 (org-insert-time-stamp
15386 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15388 (defun org-minutes-to-hh:mm-string (m)
15389 "Compute H:MM from a number of minutes."
15390 (let ((h (/ m 60)))
15391 (setq m (- m (* 60 h)))
15392 (format org-time-clocksum-format h m)))
15394 (defun org-hh:mm-string-to-minutes (s)
15395 "Convert a string H:MM to a number of minutes.
15396 If the string is just a number, interpret it as minutes.
15397 In fact, the first hh:mm or number in the string will be taken,
15398 there can be extra stuff in the string.
15399 If no number is found, the return value is 0."
15400 (cond
15402 (+ (* (string-to-number (match-string 1 s)) 60)
15403 (string-to-number (match-string 2 s))))
15405 (string-to-number (match-string 1 s)))
15406 (t 0)))
15408 ;;;; Files
15410 (defun org-save-all-org-buffers ()
15411 "Save all Org-mode buffers without user confirmation."
15412 (interactive)
15413 (message "Saving all Org-mode buffers...")
15414 (save-some-buffers t 'org-mode-p)
15415 (when (featurep 'org-id) (org-id-locations-save))
15416 (message "Saving all Org-mode buffers... done"))
15418 (defun org-revert-all-org-buffers ()
15419 "Revert all Org-mode buffers.
15420 Prompt for confirmation when there are unsaved changes.
15421 Be sure you know what you are doing before letting this function
15422 overwrite your changes.
15424 This function is useful in a setup where one tracks org files
15425 with a version control system, to revert on one machine after pulling
15426 changes from another. I believe the procedure must be like this:
15428 1. M-x org-save-all-org-buffers
15429 2. Pull changes from the other machine, resolve conflicts
15430 3. M-x org-revert-all-org-buffers"
15431 (interactive)
15432 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15433 (error "Abort"))
15434 (save-excursion
15435 (save-window-excursion
15436 (mapc
15437 (lambda (b)
15438 (when (and (with-current-buffer b (org-mode-p))
15439 (with-current-buffer b buffer-file-name))
15440 (switch-to-buffer b)
15441 (revert-buffer t 'no-confirm)))
15442 (buffer-list))
15443 (when (and (featurep 'org-id) org-id-track-globally)
15444 (org-id-locations-load)))))
15446 ;;;; Agenda files
15448 ;;;###autoload
15449 (defun org-switchb (&optional arg)
15450 "Switch between Org buffers.
15451 With a prefix argument, restrict available to files.
15452 With two prefix arguments, restrict available buffers to agenda files.
15454 Defaults to `iswitchb' for buffer name completion.
15455 Set `org-completion-use-ido' to make it use ido instead."
15456 (interactive "P")
15457 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15458 ((equal arg '(16)) (org-buffer-list 'agenda))
15459 (t (org-buffer-list))))
15460 (org-completion-use-iswitchb org-completion-use-iswitchb)
15461 (org-completion-use-ido org-completion-use-ido))
15462 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15463 (setq org-completion-use-iswitchb t))
15464 (switch-to-buffer
15465 (org-icompleting-read "Org buffer: "
15466 (mapcar 'list (mapcar 'buffer-name blist))
15467 nil t))))
15469 ;;; Define some older names previously used for this functionality
15470 ;;;###autoload
15471 (defalias 'org-ido-switchb 'org-switchb)
15472 ;;;###autoload
15473 (defalias 'org-iswitchb 'org-switchb)
15475 (defun org-buffer-list (&optional predicate exclude-tmp)
15476 "Return a list of Org buffers.
15477 PREDICATE can be `export', `files' or `agenda'.
15479 export restrict the list to Export buffers.
15480 files restrict the list to buffers visiting Org files.
15481 agenda restrict the list to buffers visiting agenda files.
15483 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15484 (let* ((bfn nil)
15485 (agenda-files (and (eq predicate 'agenda)
15486 (mapcar 'file-truename (org-agenda-files t))))
15487 (filter
15488 (cond
15489 ((eq predicate 'files)
15490 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
15491 ((eq predicate 'export)
15492 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15493 ((eq predicate 'agenda)
15494 (lambda (b)
15495 (with-current-buffer b
15496 (and (eq major-mode 'org-mode)
15497 (setq bfn (buffer-file-name b))
15498 (member (file-truename bfn) agenda-files)))))
15499 (t (lambda (b) (with-current-buffer b
15500 (or (eq major-mode 'org-mode)
15501 (string-match "\*Org .*Export"
15502 (buffer-name b)))))))))
15503 (delq nil
15504 (mapcar
15505 (lambda(b)
15506 (if (and (funcall filter b)
15507 (or (not exclude-tmp)
15508 (not (string-match "tmp" (buffer-name b)))))
15509 b
15510 nil))
15511 (buffer-list)))))
15513 (defun org-agenda-files (&optional unrestricted archives)
15514 "Get the list of agenda files.
15515 Optional UNRESTRICTED means return the full list even if a restriction
15516 is currently in place.
15517 When ARCHIVES is t, include all archive files that are really being
15518 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15519 `org-agenda-archives-mode' is t."
15520 (let ((files
15521 (cond
15522 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15523 ((stringp org-agenda-files) (org-read-agenda-file-list))
15524 ((listp org-agenda-files) org-agenda-files)
15525 (t (error "Invalid value of `org-agenda-files'")))))
15526 (setq files (apply 'append
15527 (mapcar (lambda (f)
15528 (if (file-directory-p f)
15529 (directory-files
15530 f t org-agenda-file-regexp)
15531 (list f)))
15532 files)))
15533 (when org-agenda-skip-unavailable-files
15534 (setq files (delq nil
15535 (mapcar (function
15536 (lambda (file)
15537 (and (file-readable-p file) file)))
15538 files))))
15539 (when (or (eq archives t)
15540 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15541 (setq files (org-add-archive-files files)))
15542 files))
15544 (defun org-agenda-file-p (&optional file)
15545 "Return non-nil, if FILE is an agenda file.
15546 If FILE is omitted, use the file associated with the current
15547 buffer."
15548 (member (or file (buffer-file-name))
15549 (org-agenda-files t)))
15551 (defun org-edit-agenda-file-list ()
15552 "Edit the list of agenda files.
15553 Depending on setup, this either uses customize to edit the variable
15554 `org-agenda-files', or it visits the file that is holding the list. In the
15555 latter case, the buffer is set up in a way that saving it automatically kills
15556 the buffer and restores the previous window configuration."
15557 (interactive)
15558 (if (stringp org-agenda-files)
15559 (let ((cw (current-window-configuration)))
15560 (find-file org-agenda-files)
15561 (org-set-local 'org-window-configuration cw)
15562 (org-add-hook 'after-save-hook
15563 (lambda ()
15564 (set-window-configuration
15565 (prog1 org-window-configuration
15566 (kill-buffer (current-buffer))))
15567 (org-install-agenda-files-menu)
15568 (message "New agenda file list installed"))
15569 nil 'local)
15570 (message "%s" (substitute-command-keys
15572 (customize-variable 'org-agenda-files)))
15574 (defun org-store-new-agenda-file-list (list)
15575 "Set new value for the agenda file list and save it correctly."
15576 (if (stringp org-agenda-files)
15577 (let ((fe (org-read-agenda-file-list t)) b u)
15578 (while (setq b (find-buffer-visiting org-agenda-files))
15579 (kill-buffer b))
15580 (with-temp-file org-agenda-files
15581 (insert
15582 (mapconcat
15583 (lambda (f) ;; Keep un-expanded entries.
15584 (if (setq u (assoc f fe))
15585 (cdr u)
15586 f))
15589 (let ((org-mode-hook nil) (org-inhibit-startup t)
15590 (org-insert-mode-line-in-empty-file nil))
15591 (setq org-agenda-files list)
15592 (customize-save-variable 'org-agenda-files org-agenda-files))))
15594 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15595 "Read the list of agenda files from a file.
15596 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15597 filenames, used by `org-store-new-agenda-file-list' to write back
15598 un-expanded file names."
15599 (when (file-directory-p org-agenda-files)
15600 (error "`org-agenda-files' cannot be a single directory"))
15601 (when (stringp org-agenda-files)
15602 (with-temp-buffer
15603 (insert-file-contents org-agenda-files)
15604 (mapcar
15605 (lambda (f)
15606 (let ((e (expand-file-name (substitute-in-file-name f)
15607 org-directory)))
15608 (if pair-with-expansion
15609 (cons e f)
15610 e)))
15613 ;;;###autoload
15614 (defun org-cycle-agenda-files ()
15615 "Cycle through the files in `org-agenda-files'.
15616 If the current buffer visits an agenda file, find the next one in the list.
15617 If the current buffer does not, find the first agenda file."
15618 (interactive)
15619 (let* ((fs (org-agenda-files t))
15620 (files (append fs (list (car fs))))
15621 (tcf (if buffer-file-name (file-truename buffer-file-name)))
15622 file)
15623 (unless files (error "No agenda files"))
15624 (catch 'exit
15625 (while (setq file (pop files))
15626 (if (equal (file-truename file) tcf)
15627 (when (car files)
15628 (find-file (car files))
15629 (throw 'exit t))))
15630 (find-file (car fs)))
15631 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
15633 (defun org-agenda-file-to-front (&optional to-end)
15634 "Move/add the current file to the top of the agenda file list.
15635 If the file is not present in the list, it is added to the front. If it is
15636 present, it is moved there. With optional argument TO-END, add/move to the
15637 end of the list."
15638 (interactive "P")
15639 (let ((org-agenda-skip-unavailable-files nil)
15640 (file-alist (mapcar (lambda (x)
15641 (cons (file-truename x) x))
15642 (org-agenda-files t)))
15643 (ctf (file-truename buffer-file-name))
15644 x had)
15645 (setq x (assoc ctf file-alist) had x)
15647 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
15648 (if to-end
15649 (setq file-alist (append (delq x file-alist) (list x)))
15650 (setq file-alist (cons x (delq x file-alist))))
15651 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
15652 (org-install-agenda-files-menu)
15653 (message "File %s to %s of agenda file list"
15654 (if had "moved" "added") (if to-end "end" "front"))))
15656 (defun org-remove-file (&optional file)
15657 "Remove current file from the list of files in variable `org-agenda-files'.
15658 These are the files which are being checked for agenda entries.
15659 Optional argument FILE means use this file instead of the current."
15660 (interactive)
15661 (let* ((org-agenda-skip-unavailable-files nil)
15662 (file (or file buffer-file-name))
15663 (true-file (file-truename file))
15664 (afile (abbreviate-file-name file))
15665 (files (delq nil (mapcar
15666 (lambda (x)
15667 (if (equal true-file
15668 (file-truename x))
15669 nil x))
15670 (org-agenda-files t)))))
15671 (if (not (= (length files) (length (org-agenda-files t))))
15672 (progn
15673 (org-store-new-agenda-file-list files)
15674 (org-install-agenda-files-menu)
15675 (message "Removed file: %s" afile))
15676 (message "File was not in list: %s (not removed)" afile))))
15678 (defun org-file-menu-entry (file)
15679 (vector file (list 'find-file file) t))
15681 (defun org-check-agenda-file (file)
15682 "Make sure FILE exists. If not, ask user what to do."
15683 (when (not (file-exists-p file))
15684 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
15685 (abbreviate-file-name file))
15686 (let ((r (downcase (read-char-exclusive))))
15687 (cond
15688 ((equal r ?r)
15689 (org-remove-file file)
15690 (throw 'nextfile t))
15691 (t (error "Abort"))))))
15693 (defun org-get-agenda-file-buffer (file)
15694 "Get a buffer visiting FILE. If the buffer needs to be created, add
15695 it to the list of buffers which might be released later."
15696 (let ((buf (org-find-base-buffer-visiting file)))
15697 (if buf
15698 buf ; just return it
15699 ;; Make a new buffer and remember it
15700 (setq buf (find-file-noselect file))
15701 (if buf (push buf org-agenda-new-buffers))
15702 buf)))
15704 (defun org-release-buffers (blist)
15705 "Release all buffers in list, asking the user for confirmation when needed.
15706 When a buffer is unmodified, it is just killed. When modified, it is saved
15707 \(if the user agrees) and then killed."
15708 (let (buf file)
15709 (while (setq buf (pop blist))
15710 (setq file (buffer-file-name buf))
15711 (when (and (buffer-modified-p buf)
15712 file
15713 (y-or-n-p (format "Save file %s? " file)))
15714 (with-current-buffer buf (save-buffer)))
15715 (kill-buffer buf))))
15717 (defun org-prepare-agenda-buffers (files)
15718 "Create buffers for all agenda files, protect archived trees and comments."
15719 (interactive)
15720 (let ((pa '(:org-archived t))
15721 (pc '(:org-comment t))
15722 (pall '(:org-archived t :org-comment t))
15723 (inhibit-read-only t)
15724 (rea (concat ":" org-archive-tag ":"))
15725 bmp file re)
15726 (save-excursion
15727 (save-restriction
15728 (while (setq file (pop files))
15729 (catch 'nextfile
15730 (if (bufferp file)
15731 (set-buffer file)
15732 (org-check-agenda-file file)
15733 (set-buffer (org-get-agenda-file-buffer file)))
15734 (widen)
15735 (setq bmp (buffer-modified-p))
15736 (org-refresh-category-properties)
15737 (setq org-todo-keywords-for-agenda
15738 (append org-todo-keywords-for-agenda org-todo-keywords-1))
15739 (setq org-done-keywords-for-agenda
15740 (append org-done-keywords-for-agenda org-done-keywords))
15741 (setq org-todo-keyword-alist-for-agenda
15742 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
15743 (setq org-drawers-for-agenda
15744 (append org-drawers-for-agenda org-drawers))
15745 (setq org-tag-alist-for-agenda
15746 (append org-tag-alist-for-agenda org-tag-alist))
15748 (save-excursion
15749 (remove-text-properties (point-min) (point-max) pall)
15750 (when org-agenda-skip-archived-trees
15751 (goto-char (point-min))
15752 (while (re-search-forward rea nil t)
15753 (if (org-on-heading-p t)
15754 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
15755 (goto-char (point-min))
15757 (while (re-search-forward re nil t)
15758 (add-text-properties
15759 (match-beginning 0) (org-end-of-subtree t) pc)))
15760 (set-buffer-modified-p bmp)))))
15761 (setq org-todo-keywords-for-agenda
15762 (org-uniquify org-todo-keywords-for-agenda))
15763 (setq org-todo-keyword-alist-for-agenda
15764 (org-uniquify org-todo-keyword-alist-for-agenda)
15765 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
15767 ;;;; Embedded LaTeX
15769 (defvar org-cdlatex-mode-map (make-sparse-keymap)
15770 "Keymap for the minor `org-cdlatex-mode'.")
15772 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
15773 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
15774 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
15775 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
15776 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
15778 (defvar org-cdlatex-texmathp-advice-is-done nil
15779 "Flag remembering if we have applied the advice to texmathp already.")
15781 (define-minor-mode org-cdlatex-mode
15782 "Toggle the minor `org-cdlatex-mode'.
15783 This mode supports entering LaTeX environment and math in LaTeX fragments
15784 in Org-mode.
15786 nil " OCDL" nil
15787 (when org-cdlatex-mode (require 'cdlatex))
15788 (unless org-cdlatex-texmathp-advice-is-done
15789 (setq org-cdlatex-texmathp-advice-is-done t)
15790 (defadvice texmathp (around org-math-always-on activate)
15791 "Always return t in org-mode buffers.
15792 This is because we want to insert math symbols without dollars even outside
15793 the LaTeX math segments. If Orgmode thinks that point is actually inside
15794 an embedded LaTeX fragment, let texmathp do its job.
15796 (interactive)
15797 (let (p)
15798 (cond
15799 ((not (org-mode-p)) ad-do-it)
15800 ((eq this-command 'cdlatex-math-symbol)
15801 (setq ad-return-value t
15802 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
15803 (t
15804 (let ((p (org-inside-LaTeX-fragment-p)))
15805 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
15806 (setq ad-return-value t
15807 texmathp-why '("Org-mode embedded math" . 0))
15808 (if p ad-do-it)))))))))
15810 (defun turn-on-org-cdlatex ()
15811 "Unconditionally turn on `org-cdlatex-mode'."
15812 (org-cdlatex-mode 1))
15814 (defun org-inside-LaTeX-fragment-p ()
15815 "Test if point is inside a LaTeX fragment.
15817 sequence appearing also before point.
15818 Even though the matchers for math are configurable, this function assumes
15820 delimiters are skipped when they have been removed by customization.
15821 The return value is nil, or a cons cell with the delimiter and
15822 and the position of this delimiter.
15824 This function does a reasonably good job, but can locally be fooled by
15825 for example currency specifications. For example it will assume being in
15827 fragments that are properly closed, but during editing, we have to live
15828 with the uncertainty caused by missing closing delimiters. This function
15829 looks only before point, not after."
15830 (catch 'exit
15831 (let ((pos (point))
15832 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
15833 (lim (progn
15835 (point)))
15836 dd-on str (start 0) m re)
15837 (goto-char pos)
15838 (when dodollar
15840 re (nth 1 (assoc "$" org-latex-regexps)))
15841 (while (string-match re str start)
15842 (cond
15843 ((= (match-end 0) (length str))
15844 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
15845 ((= (match-end 0) (- (length str) 5))
15846 (throw 'exit nil))
15847 (t (setq start (match-end 0))))))
15848 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
15849 (goto-char pos)
15850 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
15851 (and (match-beginning 2) (throw 'exit nil))
15852 ;; count $$
15854 (setq dd-on (not dd-on)))
15855 (goto-char pos)
15856 (if dd-on (cons "$$" m))))))
15858 (defun org-inside-latex-macro-p ()
15859 "Is point inside a LaTeX macro or its arguments?"
15860 (save-match-data
15861 (org-in-regexp
15864 (defun org-try-cdlatex-tab ()
15865 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15866 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15867 - inside a LaTeX fragment, or
15868 - after the first word in a line, where an abbreviation expansion could
15869 insert a LaTeX environment."
15870 (when org-cdlatex-mode
15871 (cond
15872 ((save-excursion
15873 (skip-chars-backward "a-zA-Z0-9*")
15875 (bolp))
15876 (cdlatex-tab) t)
15877 ((org-inside-LaTeX-fragment-p)
15878 (cdlatex-tab) t)
15879 (t nil))))
15881 (defun org-cdlatex-underscore-caret (&optional arg)
15882 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15883 Revert to the normal definition outside of these fragments."
15884 (interactive "P")
15885 (if (org-inside-LaTeX-fragment-p)
15886 (call-interactively 'cdlatex-sub-superscript)
15887 (let (org-cdlatex-mode)
15888 (call-interactively (key-binding (vector last-input-event))))))
15890 (defun org-cdlatex-math-modify (&optional arg)
15891 "Execute `cdlatex-math-modify' in LaTeX fragments.
15892 Revert to the normal definition outside of these fragments."
15893 (interactive "P")
15894 (if (org-inside-LaTeX-fragment-p)
15895 (call-interactively 'cdlatex-math-modify)
15896 (let (org-cdlatex-mode)
15897 (call-interactively (key-binding (vector last-input-event))))))
15899 (defvar org-latex-fragment-image-overlays nil
15900 "List of overlays carrying the images of latex fragments.")
15901 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
15903 (defun org-remove-latex-fragment-image-overlays ()
15904 "Remove all overlays with LaTeX fragment images in current buffer."
15905 (mapc 'delete-overlay org-latex-fragment-image-overlays)
15906 (setq org-latex-fragment-image-overlays nil))
15908 (defun org-preview-latex-fragment (&optional subtree)
15909 "Preview the LaTeX fragment at point, or all locally or globally.
15910 If the cursor is in a LaTeX fragment, create the image and overlay
15911 it over the source code. If there is no fragment at point, display
15912 all fragments in the current text, from one headline to the next. With
15913 prefix SUBTREE, display all fragments in the current subtree. With a
15915 the cursor is before the first headline,
15916 display all fragments in the buffer.
15918 (interactive "P")
15919 (org-remove-latex-fragment-image-overlays)
15920 (save-excursion
15921 (save-restriction
15922 (let (beg end at msg)
15923 (cond
15924 ((or (equal subtree '(16))
15925 (not (save-excursion
15926 (re-search-backward (concat "^" outline-regexp) nil t))))
15927 (setq beg (point-min) end (point-max)
15928 msg "Creating images for buffer...%s"))
15929 ((equal subtree '(4))
15930 (org-back-to-heading)
15931 (setq beg (point) end (org-end-of-subtree t)
15932 msg "Creating images for subtree...%s"))
15933 (t
15934 (if (setq at (org-inside-LaTeX-fragment-p))
15935 (goto-char (max (point-min) (- (cdr at) 2)))
15936 (org-back-to-heading))
15937 (setq beg (point) end (progn (outline-next-heading) (point))
15938 msg (if at "Creating image...%s"
15939 "Creating images for entry...%s"))))
15940 (message msg "")
15941 (narrow-to-region beg end)
15942 (goto-char beg)
15943 (org-format-latex
15944 (concat "ltxpng/" (file-name-sans-extension
15945 (file-name-nondirectory
15946 buffer-file-name)))
15947 default-directory 'overlays msg at 'forbuffer 'dvipng)
15948 (message msg "done. Use `C-c C-c' to remove images.")))))
15950 (defvar org-latex-regexps
15952 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
15955 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
15959 "Regular expressions for matching embedded LaTeX.")
15961 (defvar org-export-have-math nil) ;; dynamic scoping
15962 (defun org-format-latex (prefix &optional dir overlays msg at
15963 forbuffer processing-type)
15964 "Replace LaTeX fragments with links to an image, and produce images.
15965 Some of the options can be changed using the variable
15966 `org-format-latex-options'."
15967 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
15968 (let* ((prefixnodir (file-name-nondirectory prefix))
15969 (absprefix (expand-file-name prefix dir))
15970 (todir (file-name-directory absprefix))
15971 (opt org-format-latex-options)
15972 (matchers (plist-get opt :matchers))
15973 (re-list org-latex-regexps)
15974 (org-format-latex-header-extra
15975 (plist-get (org-infile-export-plist) :latex-header-extra))
15976 (cnt 0) txt hash link beg end re e checkdir
15977 executables-checked string
15978 m n block linkfile movefile ov)
15979 ;; Check the different regular expressions
15980 (while (setq e (pop re-list))
15981 (setq m (car e) re (nth 1 e) n (nth 2 e)
15983 (when (member m matchers)
15984 (goto-char (point-min))
15985 (while (re-search-forward re nil t)
15986 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
15987 (not (get-text-property (match-beginning n)
15988 'org-protected))
15989 (or (not overlays)
15990 (not (eq (get-char-property (match-beginning n)
15991 'org-overlay-type)
15992 'org-latex-overlay))))
15993 (setq org-export-have-math t)
15994 (cond
15995 ((eq processing-type 'verbatim)
15996 ;; Leave the text verbatim, just protect it
15997 (add-text-properties (match-beginning n) (match-end n)
15998 '(org-protected t)))
15999 ((eq processing-type 'mathjax)
16000 ;; Prepare for MathJax processing
16001 (setq string (match-string n))
16002 (if (member m '("$" "$1"))
16003 (save-excursion
16004 (delete-region (match-beginning n) (match-end n))
16005 (goto-char (match-beginning n))
16008 '(org-protected t))))
16009 (add-text-properties (match-beginning n) (match-end n)
16010 '(org-protected t))))
16011 ((or (eq processing-type 'dvipng) t)
16012 ;; Process to an image
16013 (setq txt (match-string n)
16014 beg (match-beginning n) end (match-end n)
16015 cnt (1+ cnt))
16016 (let (print-length print-level) ; make sure full list is printed
16017 (setq hash (sha1 (prin1-to-string
16018 (list org-format-latex-header
16019 org-format-latex-header-extra
16020 org-export-latex-default-packages-alist
16021 org-export-latex-packages-alist
16022 org-format-latex-options
16023 forbuffer txt)))
16024 linkfile (format "%s_%s.png" prefix hash)
16025 movefile (format "%s_%s.png" absprefix hash)))
16026 (setq link (concat block "[[file:" linkfile "]]" block))
16027 (if msg (message msg cnt))
16028 (goto-char beg)
16029 (unless checkdir ; make sure the directory exists
16030 (setq checkdir t)
16031 (or (file-directory-p todir) (make-directory todir t)))
16033 (unless executables-checked
16034 (org-check-external-command
16035 "latex" "needed to convert LaTeX fragments to images")
16036 (org-check-external-command
16037 "dvipng" "needed to convert LaTeX fragments to images")
16038 (setq executables-checked t))
16040 (unless (file-exists-p movefile)
16041 (org-create-formula-image
16042 txt movefile opt forbuffer))
16043 (if overlays
16044 (progn
16045 (mapc (lambda (o)
16046 (if (eq (overlay-get o 'org-overlay-type)
16047 'org-latex-overlay)
16048 (delete-overlay o)))
16049 (overlays-in beg end))
16050 (setq ov (make-overlay beg end))
16051 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16052 (if (featurep 'xemacs)
16053 (progn
16054 (overlay-put ov 'invisible t)
16055 (overlay-put
16056 ov 'end-glyph
16057 (make-glyph (vector 'png :file movefile))))
16058 (overlay-put
16059 ov 'display
16060 (list 'image :type 'png :file movefile :ascent 'center)))
16061 (push ov org-latex-fragment-image-overlays)
16062 (goto-char end))
16063 (delete-region beg end)
16064 (insert (org-add-props link
16065 (list 'org-latex-src
16066 (replace-regexp-in-string
16069 ;; This function borrows from Ganesh Swami's latex2png.el
16070 (defun org-create-formula-image (string tofile options buffer)
16071 "This calls dvipng."
16072 (require 'org-latex)
16073 (let* ((tmpdir (if (featurep 'xemacs)
16074 (temp-directory)
16075 temporary-file-directory))
16076 (texfilebase (make-temp-name
16077 (expand-file-name "orgtex" tmpdir)))
16078 (texfile (concat texfilebase ".tex"))
16079 (dvifile (concat texfilebase ".dvi"))
16080 (pngfile (concat texfilebase ".png"))
16081 (fnh (if (featurep 'xemacs)
16082 (font-height (get-face-font 'default))
16083 (face-attribute 'default :height nil)))
16084 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16085 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16086 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16087 "Black"))
16088 (bg (or (plist-get options (if buffer :background :html-background))
16089 "Transparent")))
16090 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16091 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16092 (with-temp-file texfile
16093 (insert (org-splice-latex-header
16094 org-format-latex-header
16095 org-export-latex-default-packages-alist
16096 org-export-latex-packages-alist t
16097 org-format-latex-header-extra))
16099 (require 'org-latex)
16100 (org-export-latex-fix-inputenc))
16101 (let ((dir default-directory))
16102 (condition-case nil
16103 (progn
16104 (cd tmpdir)
16105 (call-process "latex" nil nil nil texfile))
16106 (error nil))
16107 (cd dir))
16108 (if (not (file-exists-p dvifile))
16109 (progn (message "Failed to create dvi file from %s" texfile) nil)
16110 (condition-case nil
16111 (call-process "dvipng" nil nil nil
16112 "-fg" fg "-bg" bg
16113 "-D" dpi
16114 ;;"-x" scale "-y" scale
16115 "-T" "tight"
16116 "-o" pngfile
16117 dvifile)
16118 (error nil))
16119 (if (not (file-exists-p pngfile))
16120 (if org-format-latex-signal-error
16121 (error "Failed to create png file from %s" texfile)
16122 (message "Failed to create png file from %s" texfile)
16123 nil)
16124 ;; Use the requested file name and clean up
16125 (copy-file pngfile tofile 'replace)
16126 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16127 (delete-file (concat texfilebase e)))
16128 pngfile))))
16130 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16131 "Fill a LaTeX header template TPL.
16132 In the template, the following place holders will be recognized:
16135 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16137 [NO-PACKAGES] do not include PKG
16138 [EXTRA] the string EXTRA
16139 [NO-EXTRA] do not include EXTRA
16141 For backward compatibility, if both the positive and the negative place
16143 assumed to be present at the end of the template.
16144 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16145 EXTRA is a string.
16146 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16147 (let (rpl (end ""))
16149 (setq rpl (if (or (match-end 1) (not def-pkg))
16150 "" (org-latex-packages-to-string def-pkg snippets-p t))
16151 tpl (replace-match rpl t t tpl))
16152 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16155 (setq rpl (if (or (match-end 1) (not pkg))
16156 "" (org-latex-packages-to-string pkg snippets-p t))
16157 tpl (replace-match rpl t t tpl))
16158 (if pkg (setq end
16160 (org-latex-packages-to-string pkg snippets-p)))))
16163 (setq rpl (if (or (match-end 1) (not extra))
16165 tpl (replace-match rpl t t tpl))
16171 tpl)))
16173 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16175 (setq pkg (mapconcat (lambda(p)
16176 (cond
16177 ((stringp p) p)
16178 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16179 (format "%% Package %s omitted" (cadr p)))
16180 ((equal "" (car p))
16182 (t
16184 (car p) (cadr p)))))
16185 pkg
16189 (defun org-dvipng-color (attr)
16190 "Return an rgb color specification for dvipng."
16191 (apply 'format "rgb %s %s %s"
16192 (mapcar 'org-normalize-color
16193 (color-values (face-attribute 'default attr nil)))))
16195 (defun org-normalize-color (value)
16196 "Return string to be used as color value for an RGB component."
16197 (format "%g" (/ value 65535.0)))
16199 ;; Image display
16202 (defvar org-inline-image-overlays nil)
16203 (make-variable-buffer-local 'org-inline-image-overlays)
16205 (defun org-toggle-inline-images (&optional include-linked)
16206 "Toggle the display of inline images.
16207 INCLUDE-LINKED is passed to `org-display-inline-images'."
16208 (interactive "P")
16209 (if org-inline-image-overlays
16210 (progn
16211 (org-remove-inline-images)
16212 (message "Inline image display turned off"))
16213 (org-display-inline-images include-linked)
16214 (if org-inline-image-overlays
16215 (message "%d images displayed inline"
16216 (length org-inline-image-overlays))
16217 (message "No images to display inline"))))
16219 (defun org-display-inline-images (&optional include-linked refresh beg end)
16220 "Display inline images.
16221 Normally only links without a description part are inlined, because this
16222 is how it will work for export. When INCLUDE-LINKED is set, also links
16223 with a description part will be inlined. This can be nice for a quick
16224 look at those images, but it does not reflect what exported files will look
16225 like.
16226 When REFRESH is set, refresh existing images between BEG and END.
16227 This will create new image displays only if necessary.
16228 BEG and END default to the buffer boundaries."
16229 (interactive "P")
16230 (unless refresh
16231 (org-remove-inline-images)
16232 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16233 (save-excursion
16234 (save-restriction
16235 (widen)
16236 (setq beg (or beg (point-min)) end (or end (point-max)))
16237 (goto-char (point-min))
16239 (substring (org-image-file-name-regexp) 0 -2)
16241 old file ov img)
16242 (while (re-search-forward re end t)
16243 (setq old (get-char-property-and-overlay (match-beginning 1)
16244 'org-image-overlay))
16245 (setq file (expand-file-name
16246 (concat (or (match-string 3) "") (match-string 4))))
16247 (when (file-exists-p file)
16248 (if (and (car-safe old) refresh)
16249 (image-refresh (overlay-get (cdr old) 'display))
16250 (setq img (save-match-data (create-image file)))
16251 (when img
16252 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16253 (overlay-put ov 'display img)
16254 (overlay-put ov 'face 'default)
16255 (overlay-put ov 'org-image-overlay t)
16256 (overlay-put ov 'modification-hooks
16257 (list 'org-display-inline-modification-hook))
16258 (push ov org-inline-image-overlays)))))))))
16260 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16261 "Remove inline-display overlay if a corresponding region is modified."
16262 (let ((inhibit-modification-hooks t))
16263 (when (and ov after)
16264 (delete ov org-inline-image-overlays)
16265 (delete-overlay ov))))
16267 (defun org-remove-inline-images ()
16268 "Remove inline display of images."
16269 (interactive)
16270 (mapc 'delete-overlay org-inline-image-overlays)
16271 (setq org-inline-image-overlays nil))
16273 ;;;; Key bindings
16275 ;; Make `C-c C-x' a prefix key
16276 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16278 ;; TAB key with modifiers
16279 (org-defkey org-mode-map "\C-i" 'org-cycle)
16280 (org-defkey org-mode-map [(tab)] 'org-cycle)
16281 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16282 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16284 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16285 ;; The following line is necessary under Suse GNU/Linux
16286 (unless (featurep 'xemacs)
16287 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16288 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16289 (define-key org-mode-map [backtab] 'org-shifttab)
16291 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16292 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16293 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16295 ;; Cursor keys with modifiers
16296 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16297 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16298 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16299 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16301 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16302 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16303 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16304 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16306 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16307 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16308 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16309 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16311 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16312 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16314 ;; Babel keys
16315 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16316 (mapc (lambda (pair)
16317 (define-key org-babel-map (car pair) (cdr pair)))
16318 org-babel-key-bindings)
16320 ;;; Extra keys for tty access.
16321 ;; We only set them when really needed because otherwise the
16322 ;; menus don't show the simple keys
16324 (when (or org-use-extra-keys
16325 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16326 (not window-system))
16327 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16328 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16329 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16330 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16331 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16332 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16333 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16334 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16335 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16336 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16337 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16338 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16339 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16340 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16341 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16342 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16343 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16344 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16345 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16346 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16347 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16348 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16349 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16350 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16351 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16352 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16353 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16354 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16356 ;; All the other keys
16358 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16359 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16360 (if (boundp 'narrow-map)
16361 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16362 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16363 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16364 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16365 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16366 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16367 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16368 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16369 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16370 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16371 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16372 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16373 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16374 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16375 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16376 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16377 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16378 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16380 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16381 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16382 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16383 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16384 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16385 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16386 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16387 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16388 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16389 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16390 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16391 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16392 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16393 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16394 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16395 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16396 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16397 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16398 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16400 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16401 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16402 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16403 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16404 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16405 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16406 (org-defkey org-mode-map "\C-c^" 'org-sort)
16407 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16408 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16409 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16410 (org-defkey org-mode-map "\C-m" 'org-return)
16411 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16412 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16413 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16414 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16415 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16416 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16417 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16418 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16419 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16420 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16421 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16422 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16423 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16424 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16425 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16426 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16427 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16428 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16429 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16430 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16431 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16432 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16434 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16435 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16436 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16437 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16439 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16440 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16441 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16442 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16443 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16444 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16445 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16446 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16447 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16448 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16450 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16451 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16452 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16453 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16454 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16455 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16456 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16458 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16459 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16460 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16461 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16462 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16464 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16466 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16468 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16469 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16471 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16474 (when (featurep 'xemacs)
16475 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16478 (defconst org-speed-commands-default
16479 '(
16480 ("Outline Navigation")
16481 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16482 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16483 ("f" . (org-speed-move-safe 'org-forward-same-level))
16484 ("b" . (org-speed-move-safe 'org-backward-same-level))
16485 ("u" . (org-speed-move-safe 'outline-up-heading))
16486 ("j" . org-goto)
16487 ("g" . (org-refile t))
16488 ("Outline Visibility")
16489 ("c" . org-cycle)
16490 ("C" . org-shifttab)
16491 (" " . org-display-outline-path)
16492 ("Outline Structure Editing")
16493 ("U" . org-shiftmetaup)
16494 ("D" . org-shiftmetadown)
16495 ("r" . org-metaright)
16496 ("l" . org-metaleft)
16497 ("R" . org-shiftmetaright)
16498 ("L" . org-shiftmetaleft)
16499 ("i" . (progn (forward-char 1) (call-interactively
16500 'org-insert-heading-respect-content)))
16501 ("^" . org-sort)
16502 ("w" . org-refile)
16503 ("a" . org-archive-subtree-default-with-confirmation)
16504 ("." . org-mark-subtree)
16505 ("Clock Commands")
16506 ("I" . org-clock-in)
16507 ("O" . org-clock-out)
16508 ("Meta Data Editing")
16509 ("t" . org-todo)
16510 ("0" . (org-priority ?\ ))
16511 ("1" . (org-priority ?A))
16512 ("2" . (org-priority ?B))
16513 ("3" . (org-priority ?C))
16514 (";" . org-set-tags-command)
16515 ("e" . org-set-effort)
16516 ("Agenda Views etc")
16517 ("v" . org-agenda)
16518 ("/" . org-sparse-tree)
16519 ("Misc")
16520 ("o" . org-open-at-point)
16521 ("?" . org-speed-command-help)
16522 ("<" . (org-agenda-set-restriction-lock 'subtree))
16523 (">" . (org-agenda-remove-restriction-lock))
16524 )
16525 "The default speed commands.")
16527 (defun org-print-speed-command (e)
16528 (if (> (length (car e)) 1)
16529 (progn
16531 (princ (car e))
16533 (princ (make-string (length (car e)) ?-))
16535 (princ (car e))
16536 (princ " ")
16537 (if (symbolp (cdr e))
16538 (princ (symbol-name (cdr e)))
16539 (prin1 (cdr e)))
16542 (defun org-speed-command-help ()
16543 "Show the available speed commands."
16544 (interactive)
16545 (if (not org-use-speed-commands)
16546 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16547 (with-output-to-temp-buffer "*Help*"
16549 (mapc 'org-print-speed-command org-speed-commands-user)
16552 (mapc 'org-print-speed-command org-speed-commands-default))
16553 (with-current-buffer "*Help*"
16554 (setq truncate-lines t))))
16556 (defun org-speed-move-safe (cmd)
16557 "Execute CMD, but make sure that the cursor always ends up in a headline.
16558 If not, return to the original position and throw an error."
16559 (interactive)
16560 (let ((pos (point)))
16561 (call-interactively cmd)
16562 (unless (and (bolp) (org-on-heading-p))
16563 (goto-char pos)
16564 (error "Boundary reached while executing %s" cmd))))
16566 (defvar org-self-insert-command-undo-counter 0)
16568 (defvar org-table-auto-blank-field) ; defined in org-table.el
16569 (defvar org-speed-command nil)
16571 (defun org-speed-command-default-hook (keys)
16572 "Hook for activating single-letter speed commands.
16573 `org-speed-commands-default' specifies a minimal command set. Use
16574 `org-speed-commands-user' for further customization."
16575 (when (or (and (bolp) (looking-at outline-regexp))
16576 (and (functionp org-use-speed-commands)
16577 (funcall org-use-speed-commands)))
16578 (cdr (assoc keys (append org-speed-commands-user
16579 org-speed-commands-default)))))
16581 (defun org-babel-speed-command-hook (keys)
16582 "Hook for activating single-letter code block commands."
16583 (when (and (bolp) (looking-at org-babel-src-block-regexp))
16584 (cdr (assoc keys org-babel-key-bindings))))
16586 (defcustom org-speed-command-hook
16587 '(org-speed-command-default-hook org-babel-speed-command-hook)
16588 "Hook for activating speed commands at strategic locations.
16589 Hook functions are called in sequence until a valid handler is
16590 found.
16592 Each hook takes a single argument, a user-pressed command key
16593 which is also a `self-insert-command' from the global map.
16595 Within the hook, examine the cursor position and the command key
16596 and return nil or a valid handler as appropriate. Handler could
16597 be one of an interactive command, a function, or a form.
16599 Set `org-use-speed-commands' to non-nil value to enable this
16600 hook. The default setting is `org-speed-command-default-hook'."
16601 :group 'org-structure
16602 :type 'hook)
16604 (defun org-self-insert-command (N)
16605 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
16606 If the cursor is in a table looking at whitespace, the whitespace is
16607 overwritten, and the table is not marked as requiring realignment."
16608 (interactive "p")
16609 (cond
16610 ((and org-use-speed-commands
16611 (setq org-speed-command
16612 (run-hook-with-args-until-success
16613 'org-speed-command-hook (this-command-keys))))
16614 (cond
16615 ((commandp org-speed-command)
16616 (setq this-command org-speed-command)
16617 (call-interactively org-speed-command))
16618 ((functionp org-speed-command)
16619 (funcall org-speed-command))
16620 ((and org-speed-command (listp org-speed-command))
16621 (eval org-speed-command))
16622 (t (let (org-use-speed-commands)
16623 (call-interactively 'org-self-insert-command)))))
16624 ((and
16625 (org-table-p)
16626 (progn
16627 ;; check if we blank the field, and if that triggers align
16628 (and (featurep 'org-table) org-table-auto-blank-field
16629 (member last-command
16630 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
16632 ;; got extra space, this field does not determine column width
16633 (let (org-table-may-need-update) (org-table-blank-field))
16634 ;; no extra space, this field may determine column width
16635 (org-table-blank-field)))
16636 t)
16637 (eq N 1)
16639 (let (org-table-may-need-update)
16640 (goto-char (1- (match-end 0)))
16641 (delete-backward-char 1)
16642 (goto-char (match-beginning 0))
16643 (self-insert-command N)))
16644 (t
16645 (setq org-table-may-need-update t)
16646 (self-insert-command N)
16647 (org-fix-tags-on-the-fly)
16648 (if org-self-insert-cluster-for-undo
16649 (if (not (eq last-command 'org-self-insert-command))
16650 (setq org-self-insert-command-undo-counter 1)
16651 (if (>= org-self-insert-command-undo-counter 20)
16652 (setq org-self-insert-command-undo-counter 1)
16653 (and (> org-self-insert-command-undo-counter 0)
16654 buffer-undo-list
16655 (not (cadr buffer-undo-list)) ; remove nil entry
16656 (setcdr buffer-undo-list (cddr buffer-undo-list)))
16657 (setq org-self-insert-command-undo-counter
16658 (1+ org-self-insert-command-undo-counter))))))))
16660 (defun org-fix-tags-on-the-fly ()
16661 (when (and (equal (char-after (point-at-bol)) ?*)
16662 (org-on-heading-p))
16663 (org-align-tags-here org-tags-column)))
16665 (defun org-delete-backward-char (N)
16666 "Like `delete-backward-char', insert whitespace at field end in tables.
16667 When deleting backwards, in tables this function will insert whitespace in
16669 still be marked for re-alignment if the field did fill the entire column,
16670 because, in this case the deletion might narrow the column."
16671 (interactive "p")
16672 (if (and (org-table-p)
16673 (eq N 1)
16674 (string-match "|" (buffer-substring (point-at-bol) (point)))
16675 (looking-at ".*?|"))
16676 (let ((pos (point))
16678 (c org-table-may-need-update))
16679 (backward-delete-char N)
16680 (if (not overwrite-mode)
16681 (progn
16682 (skip-chars-forward "^|")
16683 (insert " ")
16684 (goto-char (1- pos))))
16685 ;; noalign: if there were two spaces at the end, this field
16686 ;; does not determine the width of the column.
16687 (if noalign (setq org-table-may-need-update c)))
16688 (backward-delete-char N)
16689 (org-fix-tags-on-the-fly)))
16691 (defun org-delete-char (N)
16692 "Like `delete-char', but insert whitespace at field end in tables.
16693 When deleting characters, in tables this function will insert whitespace in
16695 still be marked for re-alignment if the field did fill the entire column,
16696 because, in this case the deletion might narrow the column."
16697 (interactive "p")
16698 (if (and (org-table-p)
16699 (not (bolp))
16700 (not (= (char-after) ?|))
16701 (eq N 1))
16702 (if (looking-at ".*?|")
16703 (let ((pos (point))
16705 (c org-table-may-need-update))
16706 (replace-match (concat
16707 (substring (match-string 0) 1 -1)
16708 " |"))
16709 (goto-char pos)
16710 ;; noalign: if there were two spaces at the end, this field
16711 ;; does not determine the width of the column.
16712 (if noalign (setq org-table-may-need-update c)))
16713 (delete-char N))
16714 (delete-char N)
16715 (org-fix-tags-on-the-fly)))
16717 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
16718 (put 'org-self-insert-command 'delete-selection t)
16719 (put 'orgtbl-self-insert-command 'delete-selection t)
16720 (put 'org-delete-char 'delete-selection 'supersede)
16721 (put 'org-delete-backward-char 'delete-selection 'supersede)
16722 (put 'org-yank 'delete-selection 'yank)
16724 ;; Make `flyspell-mode' delay after some commands
16725 (put 'org-self-insert-command 'flyspell-delayed t)
16726 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
16727 (put 'org-delete-char 'flyspell-delayed t)
16728 (put 'org-delete-backward-char 'flyspell-delayed t)
16730 ;; Make pabbrev-mode expand after org-mode commands
16731 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
16732 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
16734 ;; How to do this: Measure non-white length of current string
16735 ;; If equal to column width, we should realign.
16737 (defun org-remap (map &rest commands)
16738 "In MAP, remap the functions given in COMMANDS.
16739 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
16740 (let (new old)
16741 (while commands
16742 (setq old (pop commands) new (pop commands))
16743 (if (fboundp 'command-remapping)
16744 (org-defkey map (vector 'remap old) new)
16745 (substitute-key-definition old new map global-map)))))
16747 (when (eq org-enable-table-editor 'optimized)
16748 ;; If the user wants maximum table support, we need to hijack
16749 ;; some standard editing functions
16750 (org-remap org-mode-map
16751 'self-insert-command 'org-self-insert-command
16752 'delete-char 'org-delete-char
16753 'delete-backward-char 'org-delete-backward-char)
16754 (org-defkey org-mode-map "|" 'org-force-self-insert))
16756 (defvar org-ctrl-c-ctrl-c-hook nil
16757 "Hook for functions attaching themselves to `C-c C-c'.
16758 This can be used to add additional functionality to the C-c C-c key which
16759 executes context-dependent commands.
16760 Each function will be called with no arguments. The function must check
16761 if the context is appropriate for it to act. If yes, it should do its
16762 thing and then return a non-nil value. If the context is wrong,
16763 just do nothing and return nil.")
16765 (defvar org-tab-first-hook nil
16766 "Hook for functions to attach themselves to TAB.
16767 See `org-ctrl-c-ctrl-c-hook' for more information.
16768 This hook runs as the first action when TAB is pressed, even before
16769 `org-cycle' messes around with the `outline-regexp' to cater for
16770 inline tasks and plain list item folding.
16771 If any function in this hook returns t, any other actions that
16772 would have been caused by TAB (such as table field motion or visibility
16773 cycling) will not occur.")
16775 (defvar org-tab-after-check-for-table-hook nil
16776 "Hook for functions to attach themselves to TAB.
16777 See `org-ctrl-c-ctrl-c-hook' for more information.
16778 This hook runs after it has been established that the cursor is not in a
16779 table, but before checking if the cursor is in a headline or if global cycling
16780 should be done.
16781 If any function in this hook returns t, not other actions like visibility
16782 cycling will be done.")
16784 (defvar org-tab-after-check-for-cycling-hook nil
16785 "Hook for functions to attach themselves to TAB.
16786 See `org-ctrl-c-ctrl-c-hook' for more information.
16787 This hook runs after it has been established that not table field motion and
16788 not visibility should be done because of current context. This is probably
16789 the place where a package like yasnippets can hook in.")
16791 (defvar org-tab-before-tab-emulation-hook nil
16792 "Hook for functions to attach themselves to TAB.
16793 See `org-ctrl-c-ctrl-c-hook' for more information.
16794 This hook runs after every other options for TAB have been exhausted, but
16797 (defvar org-metaleft-hook nil
16798 "Hook for functions attaching themselves to `M-left'.
16799 See `org-ctrl-c-ctrl-c-hook' for more information.")
16800 (defvar org-metaright-hook nil
16801 "Hook for functions attaching themselves to `M-right'.
16802 See `org-ctrl-c-ctrl-c-hook' for more information.")
16803 (defvar org-metaup-hook nil
16804 "Hook for functions attaching themselves to `M-up'.
16805 See `org-ctrl-c-ctrl-c-hook' for more information.")
16806 (defvar org-metadown-hook nil
16807 "Hook for functions attaching themselves to `M-down'.
16808 See `org-ctrl-c-ctrl-c-hook' for more information.")
16809 (defvar org-shiftmetaleft-hook nil
16810 "Hook for functions attaching themselves to `M-S-left'.
16811 See `org-ctrl-c-ctrl-c-hook' for more information.")
16812 (defvar org-shiftmetaright-hook nil
16813 "Hook for functions attaching themselves to `M-S-right'.
16814 See `org-ctrl-c-ctrl-c-hook' for more information.")
16815 (defvar org-shiftmetaup-hook nil
16816 "Hook for functions attaching themselves to `M-S-up'.
16817 See `org-ctrl-c-ctrl-c-hook' for more information.")
16818 (defvar org-shiftmetadown-hook nil
16819 "Hook for functions attaching themselves to `M-S-down'.
16820 See `org-ctrl-c-ctrl-c-hook' for more information.")
16821 (defvar org-metareturn-hook nil
16822 "Hook for functions attaching themselves to `M-RET'.
16823 See `org-ctrl-c-ctrl-c-hook' for more information.")
16824 (defvar org-shiftup-hook nil
16825 "Hook for functions attaching themselves to `S-up'.
16826 See `org-ctrl-c-ctrl-c-hook' for more information.")
16827 (defvar org-shiftup-final-hook nil
16828 "Hook for functions attaching themselves to `S-up'.
16829 This one runs after all other options except shift-select have been excluded.
16830 See `org-ctrl-c-ctrl-c-hook' for more information.")
16831 (defvar org-shiftdown-hook nil
16832 "Hook for functions attaching themselves to `S-down'.
16833 See `org-ctrl-c-ctrl-c-hook' for more information.")
16834 (defvar org-shiftdown-final-hook nil
16835 "Hook for functions attaching themselves to `S-down'.
16836 This one runs after all other options except shift-select have been excluded.
16837 See `org-ctrl-c-ctrl-c-hook' for more information.")
16838 (defvar org-shiftleft-hook nil
16839 "Hook for functions attaching themselves to `S-left'.
16840 See `org-ctrl-c-ctrl-c-hook' for more information.")
16841 (defvar org-shiftleft-final-hook nil
16842 "Hook for functions attaching themselves to `S-left'.
16843 This one runs after all other options except shift-select have been excluded.
16844 See `org-ctrl-c-ctrl-c-hook' for more information.")
16845 (defvar org-shiftright-hook nil
16846 "Hook for functions attaching themselves to `S-right'.
16847 See `org-ctrl-c-ctrl-c-hook' for more information.")
16848 (defvar org-shiftright-final-hook nil
16849 "Hook for functions attaching themselves to `S-right'.
16850 This one runs after all other options except shift-select have been excluded.
16851 See `org-ctrl-c-ctrl-c-hook' for more information.")
16853 (defun org-modifier-cursor-error ()
16854 "Throw an error, a modified cursor command was applied in wrong context."
16855 (error "This command is active in special context like tables, headlines or items"))
16857 (defun org-shiftselect-error ()
16858 "Throw an error because Shift-Cursor command was applied in wrong context."
16859 (if (and (boundp 'shift-select-mode) shift-select-mode)
16860 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
16861 (error "This command works only in special context like headlines or timestamps")))
16863 (defun org-call-for-shift-select (cmd)
16864 (let ((this-command-keys-shift-translated t))
16865 (call-interactively cmd)))
16867 (defun org-shifttab (&optional arg)
16868 "Global visibility cycling or move to previous table field.
16869 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
16870 on context.
16871 See the individual commands for more information."
16872 (interactive "P")
16873 (cond
16874 ((org-at-table-p) (call-interactively 'org-table-previous-field))
16875 ((integerp arg)
16876 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
16877 (message "Content view to level: %d" arg)
16878 (org-content (prefix-numeric-value arg2))
16879 (setq org-cycle-global-status 'overview)))
16880 (t (call-interactively 'org-global-cycle))))
16882 (defun org-shiftmetaleft ()
16883 "Promote subtree or delete table column.
16884 Calls `org-promote-subtree', `org-outdent-item',
16885 or `org-table-delete-column', depending on context.
16886 See the individual commands for more information."
16887 (interactive)
16888 (cond
16889 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
16890 ((org-at-table-p) (call-interactively 'org-table-delete-column))
16891 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
16892 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
16893 (t (org-modifier-cursor-error))))
16895 (defun org-shiftmetaright ()
16896 "Demote subtree or insert table column.
16897 Calls `org-demote-subtree', `org-indent-item',
16898 or `org-table-insert-column', depending on context.
16899 See the individual commands for more information."
16900 (interactive)
16901 (cond
16902 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
16903 ((org-at-table-p) (call-interactively 'org-table-insert-column))
16904 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
16905 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
16906 (t (org-modifier-cursor-error))))
16908 (defun org-shiftmetaup (&optional arg)
16909 "Move subtree up or kill table row.
16910 Calls `org-move-subtree-up' or `org-table-kill-row' or
16911 `org-move-item-up' depending on context. See the individual commands
16912 for more information."
16913 (interactive "P")
16914 (cond
16915 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
16916 ((org-at-table-p) (call-interactively 'org-table-kill-row))
16917 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16918 ((org-at-item-p) (call-interactively 'org-move-item-up))
16919 (t (org-modifier-cursor-error))))
16921 (defun org-shiftmetadown (&optional arg)
16922 "Move subtree down or insert table row.
16923 Calls `org-move-subtree-down' or `org-table-insert-row' or
16924 `org-move-item-down', depending on context. See the individual
16925 commands for more information."
16926 (interactive "P")
16927 (cond
16928 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
16929 ((org-at-table-p) (call-interactively 'org-table-insert-row))
16930 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16931 ((org-at-item-p) (call-interactively 'org-move-item-down))
16932 (t (org-modifier-cursor-error))))
16934 (defsubst org-hidden-tree-error ()
16935 (error
16936 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
16938 (defun org-metaleft (&optional arg)
16939 "Promote heading or move table column to left.
16940 Calls `org-do-promote' or `org-table-move-column', depending on context.
16941 With no specific context, calls the Emacs default `backward-word'.
16942 See the individual commands for more information."
16943 (interactive "P")
16944 (cond
16945 ((run-hook-with-args-until-success 'org-metaleft-hook))
16946 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
16947 ((or (org-on-heading-p)
16948 (and (org-region-active-p)
16949 (save-excursion
16950 (goto-char (region-beginning))
16951 (org-on-heading-p))))
16952 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16953 (call-interactively 'org-do-promote))
16954 ((or (org-at-item-p)
16955 (and (org-region-active-p)
16956 (save-excursion
16957 (goto-char (region-beginning))
16958 (org-at-item-p))))
16959 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16960 (call-interactively 'org-outdent-item))
16961 (t (call-interactively 'backward-word))))
16963 (defun org-metaright (&optional arg)
16964 "Demote subtree or move table column to right.
16965 Calls `org-do-demote' or `org-table-move-column', depending on context.
16966 With no specific context, calls the Emacs default `forward-word'.
16967 See the individual commands for more information."
16968 (interactive "P")
16969 (cond
16970 ((run-hook-with-args-until-success 'org-metaright-hook))
16971 ((org-at-table-p) (call-interactively 'org-table-move-column))
16972 ((or (org-on-heading-p)
16973 (and (org-region-active-p)
16974 (save-excursion
16975 (goto-char (region-beginning))
16976 (org-on-heading-p))))
16977 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16978 (call-interactively 'org-do-demote))
16979 ((or (org-at-item-p)
16980 (and (org-region-active-p)
16981 (save-excursion
16982 (goto-char (region-beginning))
16983 (org-at-item-p))))
16984 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16985 (call-interactively 'org-indent-item))
16986 (t (call-interactively 'forward-word))))
16988 (defun org-check-for-hidden (what)
16989 "Check if there are hidden headlines/items in the current visual line.
16990 WHAT can be either `headlines' or `items'. If the current line is
16991 an outline or item heading and it has a folded subtree below it,
16992 this function returns t, nil otherwise."
16993 (let ((re (cond
16994 ((eq what 'headlines) (concat "^" org-outline-regexp))
16995 ((eq what 'items) (concat "^" (org-item-re t)))
16996 (t (error "This should not happen"))))
16997 beg end)
16998 (save-excursion
16999 (catch 'exit
17000 (unless (org-region-active-p)
17001 (setq beg (point-at-bol))
17002 (beginning-of-line 2)
17003 (while (and (not (eobp)) ;; this is like `next-line'
17004 (get-char-property (1- (point)) 'invisible))
17005 (beginning-of-line 2))
17006 (setq end (point))
17007 (goto-char beg)
17008 (goto-char (point-at-eol))
17009 (setq end (max end (point)))
17010 (while (re-search-forward re end t)
17011 (if (get-char-property (match-beginning 0) 'invisible)
17012 (throw 'exit t))))
17013 nil))))
17015 (defun org-metaup (&optional arg)
17016 "Move subtree up or move table row up.
17017 Calls `org-move-subtree-up' or `org-table-move-row' or
17018 `org-move-item-up', depending on context. See the individual commands
17019 for more information."
17020 (interactive "P")
17021 (cond
17022 ((run-hook-with-args-until-success 'org-metaup-hook))
17023 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17024 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17025 ((org-at-item-p) (call-interactively 'org-move-item-up))
17026 (t (transpose-lines 1) (beginning-of-line -1))))
17028 (defun org-metadown (&optional arg)
17029 "Move subtree down or move table row down.
17030 Calls `org-move-subtree-down' or `org-table-move-row' or
17031 `org-move-item-down', depending on context. See the individual
17032 commands for more information."
17033 (interactive "P")
17034 (cond
17035 ((run-hook-with-args-until-success 'org-metadown-hook))
17036 ((org-at-table-p) (call-interactively 'org-table-move-row))
17037 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17038 ((org-at-item-p) (call-interactively 'org-move-item-down))
17039 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17041 (defun org-shiftup (&optional arg)
17042 "Increase item in timestamp or increase priority of current headline.
17043 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17044 depending on context. See the individual commands for more information."
17045 (interactive "P")
17046 (cond
17047 ((run-hook-with-args-until-success 'org-shiftup-hook))
17048 ((and org-support-shift-select (org-region-active-p))
17049 (org-call-for-shift-select 'previous-line))
17050 ((org-at-timestamp-p t)
17051 (call-interactively (if org-edit-timestamp-down-means-later
17052 'org-timestamp-down 'org-timestamp-up)))
17053 ((and (not (eq org-support-shift-select 'always))
17054 org-enable-priority-commands
17055 (org-on-heading-p))
17056 (call-interactively 'org-priority-up))
17057 ((and (not org-support-shift-select) (org-at-item-p))
17058 (call-interactively 'org-previous-item))
17059 ((org-clocktable-try-shift 'up arg))
17060 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17061 (org-support-shift-select
17062 (org-call-for-shift-select 'previous-line))
17063 (t (org-shiftselect-error))))
17065 (defun org-shiftdown (&optional arg)
17066 "Decrease item in timestamp or decrease priority of current headline.
17067 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17068 depending on context. See the individual commands for more information."
17069 (interactive "P")
17070 (cond
17071 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17072 ((and org-support-shift-select (org-region-active-p))
17073 (org-call-for-shift-select 'next-line))
17074 ((org-at-timestamp-p t)
17075 (call-interactively (if org-edit-timestamp-down-means-later
17076 'org-timestamp-up 'org-timestamp-down)))
17077 ((and (not (eq org-support-shift-select 'always))
17078 org-enable-priority-commands
17079 (org-on-heading-p))
17080 (call-interactively 'org-priority-down))
17081 ((and (not org-support-shift-select) (org-at-item-p))
17082 (call-interactively 'org-next-item))
17083 ((org-clocktable-try-shift 'down arg))
17084 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17085 (org-support-shift-select
17086 (org-call-for-shift-select 'next-line))
17087 (t (org-shiftselect-error))))
17089 (defun org-shiftright (&optional arg)
17090 "Cycle the thing at point or in the current line, depending on context.
17091 Depending on context, this does one of the following:
17093 - switch a timestamp at point one day into the future
17094 - on a headline, switch to the next TODO keyword.
17095 - on an item, switch entire list to the next bullet type
17096 - on a property line, switch to the next allowed value
17097 - on a clocktable definition line, move time block into the future"
17098 (interactive "P")
17099 (cond
17100 ((run-hook-with-args-until-success 'org-shiftright-hook))
17101 ((and org-support-shift-select (org-region-active-p))
17102 (org-call-for-shift-select 'forward-char))
17103 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17104 ((and (not (eq org-support-shift-select 'always))
17105 (org-on-heading-p))
17106 (let ((org-inhibit-logging
17107 (not org-treat-S-cursor-todo-selection-as-state-change))
17108 (org-inhibit-blocking
17109 (not org-treat-S-cursor-todo-selection-as-state-change)))
17110 (org-call-with-arg 'org-todo 'right)))
17111 ((or (and org-support-shift-select
17112 (not (eq org-support-shift-select 'always))
17113 (org-at-item-bullet-p))
17114 (and (not org-support-shift-select) (org-at-item-p)))
17115 (org-call-with-arg 'org-cycle-list-bullet nil))
17116 ((and (not (eq org-support-shift-select 'always))
17117 (org-at-property-p))
17118 (call-interactively 'org-property-next-allowed-value))
17119 ((org-clocktable-try-shift 'right arg))
17120 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17121 (org-support-shift-select
17122 (org-call-for-shift-select 'forward-char))
17123 (t (org-shiftselect-error))))
17125 (defun org-shiftleft (&optional arg)
17126 "Cycle the thing at point or in the current line, depending on context.
17127 Depending on context, this does one of the following:
17129 - switch a timestamp at point one day into the past
17130 - on a headline, switch to the previous TODO keyword.
17131 - on an item, switch entire list to the previous bullet type
17132 - on a property line, switch to the previous allowed value
17133 - on a clocktable definition line, move time block into the past"
17134 (interactive "P")
17135 (cond
17136 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17137 ((and org-support-shift-select (org-region-active-p))
17138 (org-call-for-shift-select 'backward-char))
17139 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17140 ((and (not (eq org-support-shift-select 'always))
17141 (org-on-heading-p))
17142 (let ((org-inhibit-logging
17143 (not org-treat-S-cursor-todo-selection-as-state-change))
17144 (org-inhibit-blocking
17145 (not org-treat-S-cursor-todo-selection-as-state-change)))
17146 (org-call-with-arg 'org-todo 'left)))
17147 ((or (and org-support-shift-select
17148 (not (eq org-support-shift-select 'always))
17149 (org-at-item-bullet-p))
17150 (and (not org-support-shift-select) (org-at-item-p)))
17151 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17152 ((and (not (eq org-support-shift-select 'always))
17153 (org-at-property-p))
17154 (call-interactively 'org-property-previous-allowed-value))
17155 ((org-clocktable-try-shift 'left arg))
17156 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17157 (org-support-shift-select
17158 (org-call-for-shift-select 'backward-char))
17159 (t (org-shiftselect-error))))
17161 (defun org-shiftcontrolright ()
17162 "Switch to next TODO set."
17163 (interactive)
17164 (cond
17165 ((and org-support-shift-select (org-region-active-p))
17166 (org-call-for-shift-select 'forward-word))
17167 ((and (not (eq org-support-shift-select 'always))
17168 (org-on-heading-p))
17169 (org-call-with-arg 'org-todo 'nextset))
17170 (org-support-shift-select
17171 (org-call-for-shift-select 'forward-word))
17172 (t (org-shiftselect-error))))
17174 (defun org-shiftcontrolleft ()
17175 "Switch to previous TODO set."
17176 (interactive)
17177 (cond
17178 ((and org-support-shift-select (org-region-active-p))
17179 (org-call-for-shift-select 'backward-word))
17180 ((and (not (eq org-support-shift-select 'always))
17181 (org-on-heading-p))
17182 (org-call-with-arg 'org-todo 'previousset))
17183 (org-support-shift-select
17184 (org-call-for-shift-select 'backward-word))
17185 (t (org-shiftselect-error))))
17187 (defun org-ctrl-c-ret ()
17188 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17189 (interactive)
17190 (cond
17191 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17192 (t (call-interactively 'org-insert-heading))))
17194 (defun org-copy-special ()
17195 "Copy region in table or copy current subtree.
17196 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17197 See the individual commands for more information."
17198 (interactive)
17199 (call-interactively
17200 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17202 (defun org-cut-special ()
17203 "Cut region in table or cut current subtree.
17204 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17205 See the individual commands for more information."
17206 (interactive)
17207 (call-interactively
17208 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17210 (defun org-paste-special (arg)
17211 "Paste rectangular region into table, or past subtree relative to level.
17212 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17213 See the individual commands for more information."
17214 (interactive "P")
17215 (if (org-at-table-p)
17216 (org-table-paste-rectangle)
17217 (org-paste-subtree arg)))
17219 (defun org-edit-special (&optional arg)
17220 "Call a special editor for the stuff at point.
17221 When at a table, call the formula editor with `org-table-edit-formulas'.
17222 When at the first line of an src example, call `org-edit-src-code'.
17223 When in an #+include line, visit the include file. Otherwise call
17224 `ffap' to visit the file at point."
17225 (interactive)
17226 ;; possibly prep session before editing source
17227 (when arg
17228 (let* ((info (org-babel-get-src-block-info))
17229 (lang (nth 0 info))
17230 (params (nth 2 info))
17231 (session (cdr (assoc :session params))))
17232 (when (and info session) ;; we are in a source-code block with a session
17233 (funcall
17234 (intern (concat "org-babel-prep-session:" lang)) session params))))
17235 (cond ;; proceed with `org-edit-special'
17236 ((save-excursion
17237 (beginning-of-line 1)
17238 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17239 (find-file (org-trim (match-string 1))))
17240 ((org-edit-src-code))
17241 ((org-edit-fixed-width-region))
17242 ((org-at-table.el-p)
17243 (org-edit-src-code))
17244 ((or (org-at-table-p)
17245 (save-excursion
17246 (beginning-of-line 1)
17248 (call-interactively 'org-table-edit-formulas))
17249 (t (call-interactively 'ffap))))
17251 (defun org-ctrl-c-ctrl-c (&optional arg)
17252 "Set tags in headline, or update according to changed information at point.
17254 This command does many different things, depending on context:
17256 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17257 this is what we do.
17259 - If the cursor is on a statistics cookie, update it.
17261 - If the cursor is in a headline, prompt for tags and insert them
17262 into the current line, aligned to `org-tags-column'. When called
17263 with prefix arg, realign all tags in the current buffer.
17265 - If the cursor is in one of the special #+KEYWORD lines, this
17266 triggers scanning the buffer for these lines and updating the
17267 information.
17269 - If the cursor is inside a table, realign the table. This command
17270 works even if the automatic table editor has been turned off.
17272 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17273 the entire table.
17275 - If the cursor is at a footnote reference or definition, jump to
17276 the corresponding definition or references, respectively.
17278 - If the cursor is a the beginning of a dynamic block, update it.
17280 - If the current buffer is a capture buffer, close note and file it.
17282 - If the cursor is on a <<<target>>>, update radio targets and
17283 corresponding links in this buffer.
17285 - If the cursor is on a numbered item in a plain list, renumber the
17286 ordered list.
17288 - If the cursor is on a checkbox, toggle it.
17290 - If the cursor is on a code block, evaluate it. The variable
17291 `org-confirm-babel-evaluate' can be used to control prompting
17292 before code block evaluation, by default every code block
17293 evaluation requires confirmation. Code block evaluation can be
17294 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17295 (interactive "P")
17296 (let ((org-enable-table-editor t))
17297 (cond
17298 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17299 org-occur-highlights
17300 org-latex-fragment-image-overlays)
17301 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17302 (org-remove-occur-highlights)
17303 (org-remove-latex-fragment-image-overlays)
17304 (message "Temporary highlights/overlays removed from current buffer"))
17305 ((and (local-variable-p 'org-finish-function (current-buffer))
17306 (fboundp org-finish-function))
17307 (funcall org-finish-function))
17308 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17309 ((or (looking-at org-property-start-re)
17310 (org-at-property-p))
17311 (call-interactively 'org-property-action))
17312 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17314 (or (org-on-heading-p) (org-at-item-p)))
17315 (call-interactively 'org-update-statistics-cookies))
17316 ((org-on-heading-p) (call-interactively 'org-set-tags))
17317 ((org-at-table.el-p)
17318 (message "Use C-c ' to edit table.el tables"))
17319 ((org-at-table-p)
17320 (org-table-maybe-eval-formula)
17321 (if arg
17322 (call-interactively 'org-table-recalculate)
17323 (org-table-maybe-recalculate-line))
17324 (call-interactively 'org-table-align)
17325 (orgtbl-send-table 'maybe))
17326 ((or (org-footnote-at-reference-p)
17327 (org-footnote-at-definition-p))
17328 (call-interactively 'org-footnote-action))
17329 ((org-at-item-checkbox-p)
17330 (call-interactively 'org-list-repair)
17331 (call-interactively 'org-toggle-checkbox)
17332 (org-list-send-list 'maybe))
17333 ((org-at-item-p)
17334 (call-interactively 'org-list-repair)
17335 (when arg (call-interactively 'org-toggle-checkbox))
17336 (org-list-send-list 'maybe))
17337 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17338 ;; Dynamic block
17339 (beginning-of-line 1)
17340 (save-excursion (org-update-dblock)))
17341 ((save-excursion
17342 (beginning-of-line 1)
17344 (cond
17345 ((equal (match-string 1) "TBLFM")
17346 ;; Recalculate the table before this line
17347 (save-excursion
17348 (beginning-of-line 1)
17350 (if (org-at-table-p)
17351 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17352 (t
17353 (let ((org-inhibit-startup-visibility-stuff t)
17354 (org-startup-align-all-tables nil))
17355 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17356 (message "Local setup has been refreshed"))))
17357 ((org-clock-update-time-maybe))
17358 (t (error "C-c C-c can do nothing useful at this location")))))
17360 (defun org-mode-restart ()
17361 "Restart Org-mode, to scan again for special lines.
17362 Also updates the keyword regular expressions."
17363 (interactive)
17364 (org-mode)
17365 (message "Org-mode restarted"))
17367 (defun org-kill-note-or-show-branches ()
17368 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17369 (interactive)
17370 (if (not org-finish-function)
17371 (progn
17372 (hide-subtree)
17373 (call-interactively 'show-branches))
17374 (let ((org-note-abort t))
17375 (funcall org-finish-function))))
17377 (defun org-return (&optional indent)
17378 "Goto next table row or insert a newline.
17379 Calls `org-table-next-row' or `newline', depending on context.
17380 See the individual commands for more information."
17381 (interactive)
17382 (cond
17383 ((bobp) (if indent (newline-and-indent) (newline)))
17384 ((org-at-table-p)
17385 (org-table-justify-field-maybe)
17386 (call-interactively 'org-table-next-row))
17387 ((and org-return-follows-link
17388 (eq (get-text-property (point) 'face) 'org-link))
17389 (call-interactively 'org-open-at-point))
17390 ((and (org-at-heading-p)
17391 (looking-at
17393 (org-show-entry)
17394 (end-of-line 1)
17395 (newline))
17396 (t (if indent (newline-and-indent) (newline)))))
17398 (defun org-return-indent ()
17399 "Goto next table row or insert a newline and indent.
17400 Calls `org-table-next-row' or `newline-and-indent', depending on
17401 context. See the individual commands for more information."
17402 (interactive)
17403 (org-return t))
17405 (defun org-ctrl-c-star ()
17406 "Compute table, or change heading status of lines.
17407 Calls `org-table-recalculate' or `org-toggle-heading',
17408 depending on context."
17409 (interactive)
17410 (cond
17411 ((org-at-table-p)
17412 (call-interactively 'org-table-recalculate))
17413 (t
17414 ;; Convert all lines in region to list items
17415 (call-interactively 'org-toggle-heading))))
17417 (defun org-ctrl-c-minus ()
17418 "Insert separator line in table or modify bullet status of line.
17419 Also turns a plain line or a region of lines into list items.
17420 Calls `org-table-insert-hline', `org-toggle-item', or
17421 `org-cycle-list-bullet', depending on context."
17422 (interactive)
17423 (cond
17424 ((org-at-table-p)
17425 (call-interactively 'org-table-insert-hline))
17426 ((org-region-active-p)
17427 (call-interactively 'org-toggle-item))
17428 ((org-in-item-p)
17429 (call-interactively 'org-cycle-list-bullet))
17430 (t
17431 (call-interactively 'org-toggle-item))))
17433 (defun org-toggle-item ()
17434 "Convert headings or normal lines to items, items to normal lines.
17435 If there is no active region, only the current line is considered.
17437 If the first line in the region is a headline, convert all headlines to items.
17439 If the first line in the region is an item, convert all items to normal lines.
17441 If the first line is normal text, add an item bullet to each line."
17442 (interactive)
17443 (let (l2 l beg end)
17444 (if (org-region-active-p)
17445 (setq beg (region-beginning) end (region-end))
17446 (setq beg (point-at-bol)
17447 end (min (1+ (point-at-eol)) (point-max))))
17448 (save-excursion
17449 (goto-char end)
17450 (setq l2 (org-current-line))
17451 (goto-char beg)
17452 (beginning-of-line 1)
17453 (setq l (1- (org-current-line)))
17454 (if (org-at-item-p)
17455 ;; We already have items, de-itemize
17456 (while (< (setq l (1+ l)) l2)
17457 (when (org-at-item-p)
17459 (delete-region (point) (match-end 0)))
17460 (beginning-of-line 2))
17461 (if (org-on-heading-p)
17462 ;; Headings, convert to items
17463 (while (< (setq l (1+ l)) l2)
17464 (if (looking-at org-outline-regexp)
17465 (replace-match (org-list-bullet-string "-") t t))
17466 (beginning-of-line 2))
17467 ;; normal lines, turn them into items
17468 (while (< (setq l (1+ l)) l2)
17469 (unless (org-at-item-p)
17471 (replace-match
17473 (beginning-of-line 2)))))))
17475 (defun org-toggle-heading (&optional nstars)
17476 "Convert headings to normal text, or items or text to headings.
17477 If there is no active region, only the current line is considered.
17479 If the first line is a heading, remove the stars from all headlines
17480 in the region.
17482 If the first line is a plain list item, turn all plain list items
17483 into headings.
17485 If the first line is a normal line, turn each and every line in the
17486 region into a heading.
17488 When converting a line into a heading, the number of stars is chosen
17489 such that the lines become children of the current entry. However,
17490 when a prefix argument is given, its value determines the number of
17491 stars to add."
17492 (interactive "P")
17493 (let (l2 l itemp beg end)
17494 (if (org-region-active-p)
17495 (setq beg (region-beginning) end (region-end))
17496 (setq beg (point-at-bol)
17497 end (min (1+ (point-at-eol)) (point-max))))
17498 (save-excursion
17499 (goto-char end)
17500 (setq l2 (org-current-line))
17501 (goto-char beg)
17502 (beginning-of-line 1)
17503 (setq l (1- (org-current-line)))
17504 (if (org-on-heading-p)
17505 ;; We already have headlines, de-star them
17506 (while (< (setq l (1+ l)) l2)
17507 (when (org-on-heading-p t)
17508 (and (looking-at outline-regexp) (replace-match "")))
17509 (beginning-of-line 2))
17510 (setq itemp (org-at-item-p))
17511 (let* ((stars
17512 (if nstars
17513 (make-string (prefix-numeric-value current-prefix-arg)
17514 ?*)
17515 (save-excursion
17516 (if (re-search-backward org-complex-heading-regexp nil t)
17517 (match-string 1) ""))))
17518 (add-stars (cond (nstars "")
17519 ((equal stars "") "*")
17520 (org-odd-levels-only "**")
17521 (t "*")))
17522 (rpl (concat stars add-stars " ")))
17523 (while (< (setq l (1+ l)) l2)
17524 (if itemp
17525 (and (org-at-item-p) (replace-match rpl t t))
17526 (unless (org-on-heading-p)
17528 (replace-match (concat rpl (match-string 2))))))
17529 (beginning-of-line 2)))))))
17531 (defun org-meta-return (&optional arg)
17532 "Insert a new heading or wrap a region in a table.
17533 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17534 See the individual commands for more information."
17535 (interactive "P")
17536 (cond
17537 ((run-hook-with-args-until-success 'org-metareturn-hook))
17538 ((org-at-table-p)
17539 (call-interactively 'org-table-wrap-region))
17540 (t (call-interactively 'org-insert-heading))))
17542 ;;; Menu entries
17544 ;; Define the Org-mode menus
17545 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
17546 '("Tbl"
17547 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
17548 ["Next Field" org-cycle (org-at-table-p)]
17549 ["Previous Field" org-shifttab (org-at-table-p)]
17550 ["Next Row" org-return (org-at-table-p)]
17551 "--"
17552 ["Blank Field" org-table-blank-field (org-at-table-p)]
17553 ["Edit Field" org-table-edit-field (org-at-table-p)]
17554 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
17555 "--"
17556 ("Column"
17557 ["Move Column Left" org-metaleft (org-at-table-p)]
17558 ["Move Column Right" org-metaright (org-at-table-p)]
17559 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
17560 ["Insert Column" org-shiftmetaright (org-at-table-p)])
17561 ("Row"
17562 ["Move Row Up" org-metaup (org-at-table-p)]
17563 ["Move Row Down" org-metadown (org-at-table-p)]
17564 ["Delete Row" org-shiftmetaup (org-at-table-p)]
17565 ["Insert Row" org-shiftmetadown (org-at-table-p)]
17566 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
17567 "--"
17568 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
17569 ("Rectangle"
17570 ["Copy Rectangle" org-copy-special (org-at-table-p)]
17571 ["Cut Rectangle" org-cut-special (org-at-table-p)]
17572 ["Paste Rectangle" org-paste-special (org-at-table-p)]
17573 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
17574 "--"
17575 ("Calculate"
17576 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
17577 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17578 ["Edit Formulas" org-edit-special (org-at-table-p)]
17579 "--"
17580 ["Recalculate line" org-table-recalculate (org-at-table-p)]
17581 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17582 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
17583 "--"
17584 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
17585 "--"
17586 ["Sum Column/Rectangle" org-table-sum
17587 (or (org-at-table-p) (org-region-active-p))]
17588 ["Which Column?" org-table-current-column (org-at-table-p)])
17589 ["Debug Formulas"
17590 org-table-toggle-formula-debugger
17591 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
17592 ["Show Col/Row Numbers"
17593 org-table-toggle-coordinate-overlays
17594 :style toggle
17595 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
17596 "--"
17597 ["Create" org-table-create (and (not (org-at-table-p))
17598 org-enable-table-editor)]
17599 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
17600 ["Import from File" org-table-import (not (org-at-table-p))]
17601 ["Export to File" org-table-export (org-at-table-p)]
17602 "--"
17603 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
17605 (easy-menu-define org-org-menu org-mode-map "Org menu"
17606 '("Org"
17607 ("Show/Hide"
17608 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
17609 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
17610 ["Sparse Tree..." org-sparse-tree t]
17611 ["Reveal Context" org-reveal t]
17612 ["Show All" show-all t]
17613 "--"
17614 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
17615 "--"
17616 ["New Heading" org-insert-heading t]
17617 ("Navigate Headings"
17618 ["Up" outline-up-heading t]
17619 ["Next" outline-next-visible-heading t]
17620 ["Previous" outline-previous-visible-heading t]
17621 ["Next Same Level" outline-forward-same-level t]
17622 ["Previous Same Level" outline-backward-same-level t]
17623 "--"
17624 ["Jump" org-goto t])
17625 ("Edit Structure"
17626 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
17627 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
17628 "--"
17629 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
17630 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
17631 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
17632 "--"
17633 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
17634 "--"
17635 ["Promote Heading" org-metaleft (not (org-at-table-p))]
17636 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
17637 ["Demote Heading" org-metaright (not (org-at-table-p))]
17638 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
17639 "--"
17640 ["Sort Region/Children" org-sort (not (org-at-table-p))]
17641 "--"
17642 ["Convert to odd levels" org-convert-to-odd-levels t]
17643 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
17644 ("Editing"
17645 ["Emphasis..." org-emphasize t]
17646 ["Edit Source Example" org-edit-special t]
17647 "--"
17648 ["Footnote new/jump" org-footnote-action t]
17649 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
17650 ("Archive"
17651 ["Archive (default method)" org-archive-subtree-default t]
17652 "--"
17653 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
17654 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
17655 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
17656 )
17657 "--"
17658 ("Hyperlinks"
17659 ["Store Link (Global)" org-store-link t]
17660 ["Find existing link to here" org-occur-link-in-agenda-files t]
17661 ["Insert Link" org-insert-link t]
17662 ["Follow Link" org-open-at-point t]
17663 "--"
17664 ["Next link" org-next-link t]
17665 ["Previous link" org-previous-link t]
17666 "--"
17667 ["Descriptive Links"
17668 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
17669 :style radio
17670 :selected (member '(org-link) buffer-invisibility-spec)]
17671 ["Literal Links"
17672 (progn
17673 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
17674 :style radio
17675 :selected (not (member '(org-link) buffer-invisibility-spec))])
17676 "--"
17677 ("TODO Lists"
17678 ["TODO/DONE/-" org-todo t]
17679 ("Select keyword"
17680 ["Next keyword" org-shiftright (org-on-heading-p)]
17681 ["Previous keyword" org-shiftleft (org-on-heading-p)]
17682 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
17683 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
17684 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
17685 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
17686 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
17687 "--"
17688 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
17689 :selected org-enforce-todo-dependencies :style toggle :active t]
17690 "Settings for tree at point"
17691 ["Do Children sequentially" org-toggle-ordered-property :style radio
17692 :selected (ignore-errors (org-entry-get nil "ORDERED"))
17693 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17694 ["Do Children parallel" org-toggle-ordered-property :style radio
17695 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
17696 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17697 "--"
17698 ["Set Priority" org-priority t]
17699 ["Priority Up" org-shiftup t]
17700 ["Priority Down" org-shiftdown t]
17701 "--"
17702 ["Get news from all feeds" org-feed-update-all t]
17703 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
17704 ["Customize feeds" (customize-variable 'org-feed-alist) t])
17705 ("TAGS and Properties"
17706 ["Set Tags" org-set-tags-command t]
17707 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
17708 "--"
17709 ["Set property" org-set-property t]
17710 ["Column view of properties" org-columns t]
17711 ["Insert Column View DBlock" org-insert-columns-dblock t])
17712 ("Dates and Scheduling"
17713 ["Timestamp" org-time-stamp t]
17714 ["Timestamp (inactive)" org-time-stamp-inactive t]
17715 ("Change Date"
17716 ["1 Day Later" org-shiftright t]
17717 ["1 Day Earlier" org-shiftleft t]
17718 ["1 ... Later" org-shiftup t]
17719 ["1 ... Earlier" org-shiftdown t])
17720 ["Compute Time Range" org-evaluate-time-range t]
17721 ["Schedule Item" org-schedule t]
17722 ["Deadline" org-deadline t]
17723 "--"
17724 ["Custom time format" org-toggle-time-stamp-overlays
17725 :style radio :selected org-display-custom-times]
17726 "--"
17727 ["Goto Calendar" org-goto-calendar t]
17728 ["Date from Calendar" org-date-from-calendar t]
17729 "--"
17730 ["Start/Restart Timer" org-timer-start t]
17731 ["Pause/Continue Timer" org-timer-pause-or-continue t]
17732 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
17733 ["Insert Timer String" org-timer t]
17734 ["Insert Timer Item" org-timer-item t])
17735 ("Logging work"
17736 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
17737 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
17738 ["Clock out" org-clock-out t]
17739 ["Clock cancel" org-clock-cancel t]
17740 "--"
17741 ["Mark as default task" org-clock-mark-default-task t]
17742 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
17743 ["Goto running clock" org-clock-goto t]
17744 "--"
17745 ["Display times" org-clock-display t]
17746 ["Create clock table" org-clock-report t]
17747 "--"
17748 ["Record DONE time"
17749 (progn (setq org-log-done (not org-log-done))
17750 (message "Switching to %s will %s record a timestamp"
17751 (car org-done-keywords)
17752 (if org-log-done "automatically" "not")))
17753 :style toggle :selected org-log-done])
17754 "--"
17755 ["Agenda Command..." org-agenda t]
17756 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
17757 ("File List for Agenda")
17758 ("Special views current file"
17759 ["TODO Tree" org-show-todo-tree t]
17760 ["Check Deadlines" org-check-deadlines t]
17761 ["Timeline" org-timeline t]
17762 ["Tags/Property tree" org-match-sparse-tree t])
17763 "--"
17764 ["Export/Publish..." org-export t]
17765 ("LaTeX"
17766 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
17767 :selected org-cdlatex-mode]
17768 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
17769 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
17770 ["Modify math symbol" org-cdlatex-math-modify
17771 (org-inside-LaTeX-fragment-p)]
17772 ["Insert citation" org-reftex-citation t]
17773 "--"
17774 ["Template for BEAMER" org-insert-beamer-options-template t])
17775 "--"
17776 ("MobileOrg"
17777 ["Push Files and Views" org-mobile-push t]
17778 ["Get Captured and Flagged" org-mobile-pull t]
17779 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
17780 "--"
17781 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
17782 "--"
17783 ("Documentation"
17784 ["Show Version" org-version t]
17785 ["Info Documentation" org-info t])
17786 ("Customize"
17787 ["Browse Org Group" org-customize t]
17788 "--"
17789 ["Expand This Menu" org-create-customize-menu
17790 (fboundp 'customize-menu-create)])
17791 ["Send bug report" org-submit-bug-report t]
17792 "--"
17793 ("Refresh/Reload"
17794 ["Refresh setup current buffer" org-mode-restart t]
17795 ["Reload Org (after update)" org-reload t]
17796 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
17797 ))
17799 (defun org-info (&optional node)
17800 "Read documentation for Org-mode in the info system.
17801 With optional NODE, go directly to that node."
17802 (interactive)
17803 (info (format "(org)%s" (or node ""))))
17805 ;;;###autoload
17806 (defun org-submit-bug-report ()
17807 "Submit a bug report on Org-mode via mail.
17809 Don't hesitate to report any problems or inaccurate documentation.
17811 If you don't have setup sending mail from (X)Emacs, please copy the
17812 output buffer into your mail program, as it gives us important
17813 information about your Org-mode version and configuration."
17814 (interactive)
17815 (require 'reporter)
17816 (org-load-modules-maybe)
17817 (org-require-autoloaded-modules)
17818 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
17819 (reporter-submit-bug-report
17820 "emacs-orgmode@gnu.org"
17821 (org-version)
17822 (let (list)
17823 (save-window-excursion
17824 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
17825 (delete-other-windows)
17826 (erase-buffer)
17827 (insert "You are about to submit a bug report to the Org-mode mailing list.
17829 We would like to add your full Org-mode and Outline configuration to the
17830 bug report. This greatly simplifies the work of the maintainer and
17831 other experts on the mailing list.
17833 HOWEVER, some variables you have customized may contain private
17834 information. The names of customers, colleagues, or friends, might
17835 appear in the form of file names, tags, todo states, or search strings.
17836 If you answer yes to the prompt, you might want to check and remove
17837 such private information before sending the email.")
17838 (add-text-properties (point-min) (point-max) '(face org-warning))
17839 (when (yes-or-no-p "Include your Org-mode configuration ")
17840 (mapatoms
17841 (lambda (v)
17842 (and (boundp v)
17844 (or (and (symbol-value v)
17846 (and
17847 (get v 'custom-type) (get v 'standard-value)
17848 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
17849 (push v list)))))
17850 (kill-buffer (get-buffer "*Warn about privacy*"))
17851 list))
17852 nil nil
17853 "Remember to cover the basics, that is, what you expected to happen and
17854 what in fact did happen. You don't know how to make a good report? See
17856 http://orgmode.org/manual/Feedback.html#Feedback
17858 Your bug report will be posted to the Org-mode mailing list.
17859 ------------------------------------------------------------------------")
17860 (save-excursion
17865 (defun org-install-agenda-files-menu ()
17866 (let ((bl (buffer-list)))
17867 (save-excursion
17868 (while bl
17869 (set-buffer (pop bl))
17870 (if (org-mode-p) (setq bl nil)))
17871 (when (org-mode-p)
17872 (easy-menu-change
17873 '("Org") "File List for Agenda"
17874 (append
17875 (list
17876 ["Edit File List" (org-edit-agenda-file-list) t]
17877 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
17878 ["Remove Current File from List" org-remove-file t]
17879 ["Cycle through agenda files" org-cycle-agenda-files t]
17880 ["Occur in all agenda files" org-occur-in-agenda-files t]
17881 "--")
17882 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
17884 ;;;; Documentation
17886 ;;;###autoload
17887 (defun org-require-autoloaded-modules ()
17888 (interactive)
17889 (mapc 'require
17890 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
17891 org-docbook org-exp org-html org-icalendar
17892 org-id org-latex
17893 org-publish org-remember org-table
17894 org-timer org-xoxo)))
17896 ;;;###autoload
17897 (defun org-reload (&optional uncompiled)
17898 "Reload all org lisp files.
17899 With prefix arg UNCOMPILED, load the uncompiled versions."
17900 (interactive "P")
17901 (require 'find-func)
17903 (dir-org (file-name-directory (org-find-library-name "org")))
17904 (dir-org-contrib (ignore-errors
17905 (file-name-directory
17906 (org-find-library-name "org-contribdir"))))
17907 (babel-files
17908 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
17909 (append (list nil "comint" "eval" "exp" "keys"
17910 "lob" "ref" "table" "tangle")
17911 (delq nil
17912 (mapcar
17913 (lambda (lang)
17914 (when (cdr lang) (symbol-name (car lang))))
17915 org-babel-load-languages)))))
17916 (files
17917 (append (directory-files dir-org t file-re)
17918 babel-files
17919 (and dir-org-contrib
17920 (directory-files dir-org-contrib t file-re))))
17921 (remove-re (concat (if (featurep 'xemacs)
17922 "org-colview" "org-colview-xemacs")
17924 (setq files (mapcar 'file-name-sans-extension files))
17925 (setq files (mapcar
17926 (lambda (x) (if (string-match remove-re x) nil x))
17927 files))
17928 (setq files (delq nil files))
17929 (mapc
17930 (lambda (f)
17931 (when (featurep (intern (file-name-nondirectory f)))
17932 (if (and (not uncompiled)
17933 (file-exists-p (concat f ".elc")))
17934 (load (concat f ".elc") nil nil t)
17935 (load (concat f ".el") nil nil t))))
17936 files))
17937 (org-version))
17939 ;;;###autoload
17940 (defun org-customize ()
17941 "Call the customize function with org as argument."
17942 (interactive)
17943 (org-load-modules-maybe)
17944 (org-require-autoloaded-modules)
17945 (customize-browse 'org))
17947 (defun org-create-customize-menu ()
17948 "Create a full customization menu for Org-mode, insert it into the menu."
17949 (interactive)
17950 (org-load-modules-maybe)
17951 (org-require-autoloaded-modules)
17952 (if (fboundp 'customize-menu-create)
17953 (progn
17954 (easy-menu-change
17955 '("Org") "Customize"
17956 `(["Browse Org group" org-customize t]
17957 "--"
17958 ,(customize-menu-create 'org)
17959 ["Set" Custom-set t]
17960 ["Save" Custom-save t]
17961 ["Reset to Current" Custom-reset-current t]
17962 ["Reset to Saved" Custom-reset-saved t]
17963 ["Reset to Standard Settings" Custom-reset-standard t]))
17965 (error "Cannot expand menu (outdated version of cus-edit.el)")))
17967 ;;;; Miscellaneous stuff
17969 ;;; Generally useful functions
17971 (defun org-get-at-bol (property)
17972 "Get text property PROPERTY at beginning of line."
17973 (get-text-property (point-at-bol) property))
17975 (defun org-find-text-property-in-string (prop s)
17976 "Return the first non-nil value of property PROP in string S."
17977 (or (get-text-property 0 prop s)
17978 (get-text-property (or (next-single-property-change 0 prop s) 0)
17979 prop s)))
17981 (defun org-display-warning (message) ;; Copied from Emacs-Muse
17982 "Display the given MESSAGE as a warning."
17983 (if (fboundp 'display-warning)
17984 (display-warning 'org message
17985 (if (featurep 'xemacs) 'warning :warning))
17986 (let ((buf (get-buffer-create "*Org warnings*")))
17987 (with-current-buffer buf
17988 (goto-char (point-max))
17989 (insert "Warning (Org): " message)
17990 (unless (bolp)
17991 (newline)))
17992 (display-buffer buf)
17993 (sit-for 0))))
17995 (defun org-in-commented-line ()
17996 "Is point in a line starting with `#'?"
17997 (equal (char-after (point-at-bol)) ?#))
17999 (defun org-in-indented-comment-line ()
18000 "Is point in a line starting with `#' after some white space?"
18001 (save-excursion
18002 (save-match-data
18003 (goto-char (point-at-bol))
18006 (defun org-in-verbatim-emphasis ()
18007 (save-match-data
18008 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18010 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18011 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18012 (if (and marker (marker-buffer marker)
18013 (buffer-live-p (marker-buffer marker)))
18014 (progn
18015 (switch-to-buffer (marker-buffer marker))
18016 (if (or (> marker (point-max)) (< marker (point-min)))
18017 (widen))
18018 (goto-char marker)
18019 (org-show-context 'org-goto))
18020 (if bookmark
18021 (bookmark-jump bookmark)
18022 (error "Cannot find location"))))
18024 (defun org-quote-csv-field (s)
18025 "Quote field for inclusion in CSV material."
18028 s))
18030 (defun org-force-self-insert (N)
18031 "Needed to enforce self-insert under remapping."
18032 (interactive "p")
18033 (self-insert-command N))
18035 (defun org-string-width (s)
18036 "Compute width of string, ignoring invisible characters.
18037 This ignores character with invisibility property `org-link', and also
18038 characters with property `org-cwidth', because these will become invisible
18039 upon the next fontification round."
18040 (let (b l)
18041 (when (or (eq t buffer-invisibility-spec)
18042 (assq 'org-link buffer-invisibility-spec))
18043 (while (setq b (text-property-any 0 (length s)
18044 'invisible 'org-link s))
18045 (setq s (concat (substring s 0 b)
18046 (substring s (or (next-single-property-change
18047 b 'invisible s) (length s)))))))
18048 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18049 (setq s (concat (substring s 0 b)
18050 (substring s (or (next-single-property-change
18051 b 'org-cwidth s) (length s))))))
18052 (setq l (string-width s) b -1)
18053 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18054 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18055 l))
18057 (defun org-shorten-string (s maxlength)
18058 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18059 If the string is shorter or has length MAXLENGTH, just return the
18060 original string. If it is longer, the functions finds a space in the
18061 string, breaks this string off at that locations and adds three dots
18062 as ellipsis. Including the ellipsis, the string will not be longer
18063 than MAXLENGTH. If finding a good breaking point in the string does
18064 not work, the string is just chopped off in the middle of a word
18065 if necessary."
18066 (if (<= (length s) maxlength)
18067 s
18068 (let* ((n (max (- maxlength 4) 1))
18070 (if (string-match re s)
18071 (concat (match-string 1 s) "...")
18072 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18074 (defun org-get-indentation (&optional line)
18075 "Get the indentation of the current line, interpreting tabs.
18076 When LINE is given, assume it represents a line and compute its indentation."
18077 (if line
18078 (if (string-match "^ *" (org-remove-tabs line))
18079 (match-end 0))
18080 (save-excursion
18081 (beginning-of-line 1)
18083 (current-column))))
18085 (defun org-remove-tabs (s &optional width)
18086 "Replace tabulators in S with spaces.
18087 Assumes that s is a single line, starting in column 0."
18088 (setq width (or width tab-width))
18090 (setq s (replace-match
18091 (make-string
18092 (- (* width (/ (+ (match-beginning 0) width) width))
18093 (match-beginning 0)) ?\ )
18094 t t s)))
18095 s)
18097 (defun org-fix-indentation (line ind)
18098 "Fix indentation in LINE.
18099 IND is a cons cell with target and minimum indentation.
18100 If the current indentation in LINE is smaller than the minimum,
18101 leave it alone. If it is larger than ind, set it to the target."
18102 (let* ((l (org-remove-tabs line))
18103 (i (org-get-indentation l))
18104 (i1 (car ind)) (i2 (cdr ind)))
18105 (if (>= i i2) (setq l (substring line i2)))
18106 (if (> i1 0)
18107 (concat (make-string i1 ?\ ) l)
18108 l)))
18110 (defun org-remove-indentation (code &optional n)
18111 "Remove the maximum common indentation from the lines in CODE.
18112 N may optionally be the number of spaces to remove."
18113 (with-temp-buffer
18114 (insert code)
18115 (org-do-remove-indentation n)
18116 (buffer-string)))
18118 (defun org-do-remove-indentation (&optional n)
18119 "Remove the maximum common indentation from the buffer."
18120 (untabify (point-min) (point-max))
18121 (let ((min 10000) re)
18122 (if n
18123 (setq min n)
18124 (goto-char (point-min))
18126 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18127 (unless (or (= min 0) (= min 10000))
18129 (goto-char (point-min))
18130 (while (re-search-forward re nil t)
18131 (replace-match "")
18132 (end-of-line 1))
18133 min)))
18135 (defun org-fill-template (template alist)
18136 "Find each %key of ALIST in TEMPLATE and replace it."
18137 (let ((case-fold-search nil)
18138 entry key value)
18139 (setq alist (sort (copy-sequence alist)
18140 (lambda (a b) (< (length (car a)) (length (car b))))))
18141 (while (setq entry (pop alist))
18142 (setq template
18143 (replace-regexp-in-string
18144 (concat "%" (regexp-quote (car entry)))
18145 (cdr entry) template t t)))
18146 template))
18148 (defun org-base-buffer (buffer)
18149 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18150 (if (not buffer)
18151 buffer
18152 (or (buffer-base-buffer buffer)
18153 buffer)))
18155 (defun org-trim (s)
18156 "Remove whitespace at beginning and end of string."
18159 s)
18161 (defun org-wrap (string &optional width lines)
18162 "Wrap string to either a number of lines, or a width in characters.
18163 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18164 that costs. If there is a word longer than WIDTH, the text is actually
18165 wrapped to the length of that word.
18166 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18167 many lines, whatever width that takes.
18168 The return value is a list of lines, without newlines at the end."
18170 (maxword (apply 'max (mapcar 'org-string-width words)))
18171 w ll)
18172 (cond (width
18173 (org-do-wrap words (max maxword width)))
18174 (lines
18175 (setq w maxword)
18176 (setq ll (org-do-wrap words maxword))
18177 (if (<= (length ll) lines)
18178 ll
18179 (setq ll words)
18180 (while (> (length ll) lines)
18181 (setq w (1+ w))
18182 (setq ll (org-do-wrap words w)))
18183 ll))
18184 (t (error "Cannot wrap this")))))
18186 (defun org-do-wrap (words width)
18187 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18188 (let (lines line)
18189 (while words
18190 (setq line (pop words))
18191 (while (and words (< (+ (length line) (length (car words))) width))
18192 (setq line (concat line " " (pop words))))
18193 (setq lines (push line lines)))
18194 (nreverse lines)))
18196 (defun org-split-string (string &optional separators)
18197 "Splits STRING into substrings at SEPARATORS.
18198 No empty strings are returned if there are matches at the beginning
18199 and end of string."
18201 (start 0)
18202 notfirst
18203 (list nil))
18204 (while (and (string-match rexp string
18205 (if (and notfirst
18206 (= start (match-beginning 0))
18207 (< start (length string)))
18208 (1+ start) start))
18209 (< (match-beginning 0) (length string)))
18210 (setq notfirst t)
18211 (or (eq (match-beginning 0) 0)
18212 (and (eq (match-beginning 0) (match-end 0))
18213 (eq (match-beginning 0) start))
18214 (setq list
18215 (cons (substring string start (match-beginning 0))
18216 list)))
18217 (setq start (match-end 0)))
18218 (or (eq start (length string))
18219 (setq list
18220 (cons (substring string start)
18221 list)))
18222 (nreverse list)))
18224 (defun org-quote-vert (s)
18226 (while (string-match "|" s)
18228 s)
18230 (defun org-uuidgen-p (s)
18231 "Is S an ID created by UUIDGEN?"
18232 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18234 (defun org-context ()
18235 "Return a list of contexts of the current cursor position.
18236 If several contexts apply, all are returned.
18237 Each context entry is a list with a symbol naming the context, and
18238 two positions indicating start and end of the context. Possible
18239 contexts are:
18241 :headline anywhere in a headline
18242 :headline-stars on the leading stars in a headline
18243 :todo-keyword on a TODO keyword (including DONE) in a headline
18244 :tags on the TAGS in a headline
18245 :priority on the priority cookie in a headline
18246 :item on the first line of a plain list item
18247 :item-bullet on the bullet/number of a plain list item
18248 :checkbox on the checkbox in a plain list item
18249 :table in an org-mode table
18250 :table-special on a special filed in a table
18251 :table-table in a table.el table
18252 :link on a hyperlink
18253 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18254 :target on a <<target>>
18255 :radio-target on a <<<radio-target>>>
18256 :latex-fragment on a LaTeX fragment
18257 :latex-preview on a LaTeX fragment with overlayed preview image
18259 This function expects the position to be visible because it uses font-lock
18260 faces as a help to recognize the following contexts: :table-special, :link,
18261 and :keyword."
18262 (let* ((f (get-text-property (point) 'face))
18263 (faces (if (listp f) f (list f)))
18264 (p (point)) clist o)
18265 ;; First the large context
18266 (cond
18267 ((org-on-heading-p t)
18268 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18269 (when (progn
18270 (beginning-of-line 1)
18271 (looking-at org-todo-line-tags-regexp))
18272 (push (org-point-in-group p 1 :headline-stars) clist)
18273 (push (org-point-in-group p 2 :todo-keyword) clist)
18274 (push (org-point-in-group p 4 :tags) clist))
18275 (goto-char p)
18278 (push (org-point-in-group p 0 :priority) clist)))
18280 ((org-at-item-p)
18281 (push (org-point-in-group p 2 :item-bullet) clist)
18282 (push (list :item (point-at-bol)
18283 (save-excursion (org-end-of-item) (point)))
18284 clist)
18285 (and (org-at-item-checkbox-p)
18286 (push (org-point-in-group p 0 :checkbox) clist)))
18288 ((org-at-table-p)
18289 (push (list :table (org-table-begin) (org-table-end)) clist)
18290 (if (memq 'org-formula faces)
18291 (push (list :table-special
18292 (previous-single-property-change p 'face)
18293 (next-single-property-change p 'face)) clist)))
18294 ((org-at-table-p 'any)
18295 (push (list :table-table) clist)))
18296 (goto-char p)
18298 ;; Now the small context
18299 (cond
18300 ((org-at-timestamp-p)
18301 (push (org-point-in-group p 0 :timestamp) clist))
18302 ((memq 'org-link faces)
18303 (push (list :link
18304 (previous-single-property-change p 'face)
18305 (next-single-property-change p 'face)) clist))
18306 ((memq 'org-special-keyword faces)
18307 (push (list :keyword
18308 (previous-single-property-change p 'face)
18309 (next-single-property-change p 'face)) clist))
18310 ((org-on-target-p)
18311 (push (org-point-in-group p 0 :target) clist)
18312 (goto-char (1- (match-beginning 0)))
18313 (if (looking-at org-radio-target-regexp)
18314 (push (org-point-in-group p 0 :radio-target) clist))
18315 (goto-char p))
18316 ((setq o (car (delq nil
18317 (mapcar
18318 (lambda (x)
18319 (if (memq x org-latex-fragment-image-overlays) x))
18320 (overlays-at (point))))))
18321 (push (list :latex-fragment
18322 (overlay-start o) (overlay-end o)) clist)
18323 (push (list :latex-preview
18324 (overlay-start o) (overlay-end o)) clist))
18325 ((org-inside-LaTeX-fragment-p)
18326 ;; FIXME: positions wrong.
18327 (push (list :latex-fragment (point) (point)) clist)))
18329 (setq clist (nreverse (delq nil clist)))
18330 clist))
18332 ;; FIXME: Compare with at-regexp-p Do we need both?
18333 (defun org-in-regexp (re &optional nlines visually)
18334 "Check if point is inside a match of regexp.
18335 Normally only the current line is checked, but you can include NLINES extra
18336 lines both before and after point into the search.
18337 If VISUALLY is set, require that the cursor is not after the match but
18338 really on, so that the block visually is on the match."
18339 (catch 'exit
18340 (let ((pos (point))
18341 (eol (point-at-eol (+ 1 (or nlines 0))))
18342 (inc (if visually 1 0)))
18343 (save-excursion
18344 (beginning-of-line (- 1 (or nlines 0)))
18345 (while (re-search-forward re eol t)
18346 (if (and (<= (match-beginning 0) pos)
18347 (>= (+ inc (match-end 0)) pos))
18348 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18350 (defun org-at-regexp-p (regexp)
18351 "Is point inside a match of REGEXP in the current line?"
18352 (catch 'exit
18353 (save-excursion
18354 (let ((pos (point)) (end (point-at-eol)))
18355 (beginning-of-line 1)
18356 (while (re-search-forward regexp end t)
18357 (if (and (<= (match-beginning 0) pos)
18358 (>= (match-end 0) pos))
18359 (throw 'exit t)))
18360 nil))))
18362 (defun org-in-regexps-block-p (start-re end-re &optional bound)
18363 "Return t if the current point is between matches of START-RE and END-RE.
18364 This will also return t if point is on one of the two matches or
18365 in an unfinished block. END-RE can be a string or a form
18366 returning a string.
18368 An optional third argument bounds the search for START-RE. It
18369 defaults to previous heading or `point-min'."
18370 (let ((pos (point))
18371 (limit (or bound (save-excursion (outline-previous-heading)))))
18372 (save-excursion
18373 ;; we're on a block when point is on start-re...
18374 (or (org-at-regexp-p start-re)
18375 ;; ... or start-re can be found above...
18376 (and (re-search-backward start-re limit t)
18377 ;; ... but no end-re between start-re and point.
18378 (not (re-search-forward (eval end-re) pos t)))))))
18380 (defun org-occur-in-agenda-files (regexp &optional nlines)
18381 "Call `multi-occur' with buffers for all agenda files."
18383 (let* ((files (org-agenda-files))
18384 (tnames (mapcar 'file-truename files))
18385 (extra org-agenda-text-search-extra-files)
18386 f)
18387 (when (eq (car extra) 'agenda-archives)
18388 (setq extra (cdr extra))
18389 (setq files (org-add-archive-files files)))
18390 (while (setq f (pop extra))
18391 (unless (member (file-truename f) tnames)
18392 (add-to-list 'files f 'append)
18393 (add-to-list 'tnames (file-truename f) 'append)))
18394 (multi-occur
18395 (mapcar (lambda (x)
18396 (with-current-buffer
18397 (or (get-file-buffer x) (find-file-noselect x))
18398 (widen)
18399 (current-buffer)))
18400 files)
18401 regexp)))
18403 (if (boundp 'occur-mode-find-occurrence-hook)
18404 ;; Emacs 23
18405 (add-hook 'occur-mode-find-occurrence-hook
18406 (lambda ()
18407 (when (org-mode-p)
18408 (org-reveal))))
18409 ;; Emacs 22
18410 (defadvice occur-mode-goto-occurrence
18411 (after org-occur-reveal activate)
18412 (and (org-mode-p) (org-reveal)))
18413 (defadvice occur-mode-goto-occurrence-other-window
18414 (after org-occur-reveal activate)
18415 (and (org-mode-p) (org-reveal)))
18416 (defadvice occur-mode-display-occurrence
18417 (after org-occur-reveal activate)
18418 (when (org-mode-p)
18419 (let ((pos (occur-mode-find-occurrence)))
18420 (with-current-buffer (marker-buffer pos)
18421 (save-excursion
18422 (goto-char pos)
18423 (org-reveal)))))))
18425 (defun org-occur-link-in-agenda-files ()
18426 "Create a link and search for it in the agendas.
18427 The link is not stored in `org-stored-links', it is just created
18428 for the search purpose."
18429 (interactive)
18430 (let ((link (condition-case nil
18431 (org-store-link nil)
18432 (error "Unable to create a link to here"))))
18433 (org-occur-in-agenda-files (regexp-quote link))))
18435 (defun org-uniquify (list)
18436 "Remove duplicate elements from LIST."
18437 (let (res)
18438 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
18439 res))
18441 (defun org-delete-all (elts list)
18442 "Remove all elements in ELTS from LIST."
18443 (while elts
18444 (setq list (delete (pop elts) list)))
18445 list)
18447 (defun org-count (cl-item cl-seq)
18448 "Count the number of occurrences of ITEM in SEQ.
18449 Taken from `count' in cl-seq.el with all keyword arguments removed."
18450 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
18451 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
18452 (while (< cl-start cl-end)
18453 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
18454 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
18455 (setq cl-start (1+ cl-start)))
18456 cl-count))
18458 (defun org-remove-if (predicate seq)
18459 "Remove everything from SEQ that fulfills PREDICATE."
18460 (let (res e)
18461 (while seq
18462 (setq e (pop seq))
18463 (if (not (funcall predicate e)) (push e res)))
18464 (nreverse res)))
18466 (defun org-remove-if-not (predicate seq)
18467 "Remove everything from SEQ that does not fulfill PREDICATE."
18468 (let (res e)
18469 (while seq
18470 (setq e (pop seq))
18471 (if (funcall predicate e) (push e res)))
18472 (nreverse res)))
18474 (defun org-back-over-empty-lines ()
18475 "Move backwards over whitespace, to the beginning of the first empty line.
18476 Returns the number of empty lines passed."
18477 (let ((pos (point)))
18479 (beginning-of-line 2)
18480 (goto-char (min (point) pos))
18481 (count-lines (point) pos)))
18483 (defun org-skip-whitespace ()
18486 (defun org-point-in-group (point group &optional context)
18487 "Check if POINT is in match-group GROUP.
18488 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18489 match. If the match group does not exist or point is not inside it,
18490 return nil."
18491 (and (match-beginning group)
18492 (>= point (match-beginning group))
18493 (<= point (match-end group))
18494 (if context
18495 (list context (match-beginning group) (match-end group))
18496 t)))
18498 (defun org-switch-to-buffer-other-window (&rest args)
18499 "Switch to buffer in a second window on the current frame.
18500 In particular, do not allow pop-up frames.
18501 Returns the newly created buffer."
18502 (let (pop-up-frames special-display-buffer-names special-display-regexps
18503 special-display-function)
18504 (apply 'switch-to-buffer-other-window args)))
18506 (defun org-combine-plists (&rest plists)
18507 "Create a single property list from all plists in PLISTS.
18508 The process starts by copying the first list, and then setting properties
18509 from the other lists. Settings in the last list are the most significant
18510 ones and overrule settings in the other lists."
18511 (let ((rtn (copy-sequence (pop plists)))
18512 p v ls)
18513 (while plists
18514 (setq ls (pop plists))
18515 (while ls
18516 (setq p (pop ls) v (pop ls))
18517 (setq rtn (plist-put rtn p v))))
18518 rtn))
18520 (defun org-move-line-down (arg)
18521 "Move the current line down. With prefix argument, move it past ARG lines."
18522 (interactive "p")
18523 (let ((col (current-column))
18524 beg end pos)
18525 (beginning-of-line 1) (setq beg (point))
18526 (beginning-of-line 2) (setq end (point))
18527 (beginning-of-line (+ 1 arg))
18528 (setq pos (move-marker (make-marker) (point)))
18529 (insert (delete-and-extract-region beg end))
18530 (goto-char pos)
18531 (org-move-to-column col)))
18533 (defun org-move-line-up (arg)
18534 "Move the current line up. With prefix argument, move it past ARG lines."
18535 (interactive "p")
18536 (let ((col (current-column))
18537 beg end pos)
18538 (beginning-of-line 1) (setq beg (point))
18539 (beginning-of-line 2) (setq end (point))
18540 (beginning-of-line (- arg))
18541 (setq pos (move-marker (make-marker) (point)))
18542 (insert (delete-and-extract-region beg end))
18543 (goto-char pos)
18544 (org-move-to-column col)))
18546 (defun org-replace-escapes (string table)
18547 "Replace %-escapes in STRING with values in TABLE.
18549 The sequences in STRING may contain normal field width and padding information,
18551 so values can contain further %-escapes if they are define later in TABLE."
18552 (let ((tbl (copy-alist table))
18553 (case-fold-search nil)
18554 (pchg 0)
18555 e re rpl)
18556 (while (setq e (pop tbl))
18557 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
18558 (when (and (cdr e) (string-match re (cdr e)))
18559 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
18560 (safe "SREF"))
18561 (add-text-properties 0 3 (list 'sref sref) safe)
18562 (setcdr e (replace-match safe t t (cdr e)))))
18563 (while (string-match re string)
18564 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
18565 (cdr e)))
18566 (setq string (replace-match rpl t t string))))
18567 (while (setq pchg (next-property-change pchg string))
18568 (let ((sref (get-text-property pchg 'sref string)))
18569 (when (and sref (string-match "SREF" string pchg))
18570 (setq string (replace-match sref t t string)))))
18571 string))
18573 (defun org-sublist (list start end)
18574 "Return a section of LIST, from START to END.
18575 Counting starts at 1."
18576 (let (rtn (c start))
18577 (setq list (nthcdr (1- start) list))
18578 (while (and list (<= c end))
18579 (push (pop list) rtn)
18580 (setq c (1+ c)))
18581 (nreverse rtn)))
18583 (defun org-find-base-buffer-visiting (file)
18584 "Like `find-buffer-visiting' but always return the base buffer and
18585 not an indirect buffer."
18586 (let ((buf (or (get-file-buffer file)
18587 (find-buffer-visiting file))))
18588 (if buf
18589 (or (buffer-base-buffer buf) buf)
18590 nil)))
18592 (defun org-image-file-name-regexp (&optional extensions)
18593 "Return regexp matching the file names of images.
18594 If EXTENSIONS is given, only match these."
18595 (if (and (not extensions) (fboundp 'image-file-name-regexp))
18596 (image-file-name-regexp)
18597 (let ((image-file-name-extensions
18598 (or extensions
18599 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
18600 "xbm" "xpm" "pbm" "pgm" "ppm"))))
18602 (regexp-opt (nconc (mapcar 'upcase
18603 image-file-name-extensions)
18604 image-file-name-extensions)
18605 t)
18608 (defun org-file-image-p (file &optional extensions)
18609 "Return non-nil if FILE is an image."
18610 (save-match-data
18611 (string-match (org-image-file-name-regexp extensions) file)))
18613 (defun org-get-cursor-date ()
18614 "Return the date at cursor in as a time.
18615 This works in the calendar and in the agenda, anywhere else it just
18616 returns the current time."
18617 (let (date day defd)
18618 (cond
18619 ((eq major-mode 'calendar-mode)
18620 (setq date (calendar-cursor-to-date)
18621 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
18622 ((eq major-mode 'org-agenda-mode)
18623 (setq day (get-text-property (point) 'day))
18624 (if day
18625 (setq date (calendar-gregorian-from-absolute day)
18626 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
18627 (nth 2 date))))))
18628 (or defd (current-time))))
18630 (defvar org-agenda-action-marker (make-marker)
18631 "Marker pointing to the entry for the next agenda action.")
18633 (defun org-mark-entry-for-agenda-action ()
18634 "Mark the current entry as target of an agenda action.
18635 Agenda actions are actions executed from the agenda with the key `k',
18636 which make use of the date at the cursor."
18637 (interactive)
18638 (move-marker org-agenda-action-marker
18639 (save-excursion (org-back-to-heading t) (point))
18640 (current-buffer))
18641 (message
18642 "Entry marked for action; press `k' at desired date in agenda or calendar"))
18644 (defun org-mark-subtree ()
18645 "Mark the current subtree.
18646 This puts point at the start of the current subtree, and mark at the end.
18648 If point is in an inline task, mark that task instead."
18649 (interactive)
18650 (let ((inline-task-p
18651 (and (featurep 'org-inlinetask)
18652 (org-inlinetask-in-task-p)))
18653 (beg))
18654 ;; Get beginning of subtree
18655 (cond
18656 (inline-task-p (org-inlinetask-goto-beginning))
18657 ((org-at-heading-p) (beginning-of-line))
18658 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
18659 (setq beg (point))
18660 ;; Get end of it
18661 (if inline-task-p
18662 (org-inlinetask-goto-end)
18663 (org-end-of-subtree))
18664 ;; Mark zone
18665 (push-mark (point) nil t)
18666 (goto-char beg)))
18668 ;;; Paragraph filling stuff.
18669 ;; We want this to be just right, so use the full arsenal.
18671 (defun org-indent-line-function ()
18672 "Indent line depending on context."
18673 (interactive)
18674 (let* ((pos (point))
18675 (itemp (org-at-item-p))
18676 (case-fold-search t)
18678 (inline-task-p (and (featurep 'org-inlinetask)
18679 (org-inlinetask-in-task-p)))
18680 column bpos bcol tpos tcol)
18681 (beginning-of-line 1)
18682 (cond
18683 ;; Comments
18684 ((looking-at "# ") (setq column 0))
18685 ;; Headings
18687 ;; Literal examples
18689 (setq column (org-get-indentation))) ; do nothing
18690 ;; Drawers
18692 (save-excursion (re-search-backward org-drawer-regexp nil t)))
18693 (save-excursion
18694 (goto-char (1- (match-beginning 1)))
18695 (setq column (current-column))))
18696 ;; Special blocks
18698 (save-excursion
18699 (re-search-backward
18701 (setq column (org-get-indentation (match-string 0))))
18704 (save-excursion
18706 (setq column
18707 (if (equal (downcase (match-string 1)) "src")
18708 ;; src blocks: let `org-edit-src-exit' handle them
18709 (org-get-indentation)
18710 (org-get-indentation (match-string 0)))))
18711 ;; Lists
18712 ((org-in-item-p)
18713 (org-beginning-of-item)
18714 (looking-at "[ \t]*\\(\\S-+\\)[ \t]*\\(\\(:?\\[@\\(:?start:\\)?[0-9]+\\][ \t]*\\)?\\[[- X]\\][ \t]*\\|.*? :: \\)?")
18715 (setq bpos (match-beginning 1) tpos (match-end 0)
18716 bcol (progn (goto-char bpos) (current-column))
18717 tcol (progn (goto-char tpos) (current-column)))
18718 (if (> tcol (+ bcol org-description-max-indent))
18719 (setq tcol (+ bcol 5)))
18720 (goto-char pos)
18721 (setq column (if itemp (org-get-indentation) tcol)))
18722 ;; This line has nothing special, look at the previous relevant
18723 ;; line to compute indentation
18724 (t
18725 (beginning-of-line 0)
18726 (while (and (not (bobp))
18727 (not (looking-at org-drawer-regexp))
18728 ;; skip comments, verbatim, empty lines, tables,
18729 ;; inline tasks, lists, drawers and blocks
18731 (re-search-backward org-drawer-regexp nil t))
18735 (and (org-in-item-p) (goto-char (org-list-top-point)))
18736 (and (not inline-task-p)
18737 (featurep 'org-inlinetask)
18738 (org-inlinetask-in-task-p)
18739 (or (org-inlinetask-goto-beginning) t))))
18740 (beginning-of-line 0))
18741 (cond
18742 ;; There was an heading above.
18744 (if (not org-adapt-indentation)
18745 (setq column 0)
18746 (goto-char (match-end 0))
18747 (setq column (current-column))))
18748 ;; A drawer had started and is unfinished
18749 ((looking-at org-drawer-regexp)
18750 (goto-char (1- (match-beginning 1)))
18751 (setq column (current-column)))
18752 ;; Else, nothing noticeable found: get indentation and go on.
18753 (t (setq column (org-get-indentation))))))
18754 ;; Now apply indentation and move cursor accordingly
18755 (goto-char pos)
18756 (if (<= (current-column) (current-indentation))
18757 (org-indent-line-to column)
18758 (save-excursion (org-indent-line-to column)))
18759 ;; Special polishing for properties, see `org-property-format'
18760 (setq column (current-column))
18761 (beginning-of-line 1)
18762 (if (looking-at
18764 (replace-match (concat (match-string 1)
18765 (format org-property-format
18766 (match-string 2) (match-string 3)))
18767 t t))
18768 (org-move-to-column column)))
18770 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
18771 "Variable to store copy of `adaptive-fill-regexp'.
18772 Since `adaptive-fill-regexp' is set to never match, we need to
18773 store a backup of its value before entering `org-mode' so that
18774 the functionality can be provided as a fall-back.")
18776 (defun org-set-autofill-regexps ()
18777 (interactive)
18778 ;; In the paragraph separator we include headlines, because filling
18779 ;; text in a line directly attached to a headline would otherwise
18780 ;; fill the headline as well.
18783 ;; The paragraph starter includes hand-formatted lists.
18784 (org-set-local
18785 'paragraph-start
18786 (concat
18795 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
18796 ;; But only if the user has not turned off tables or fixed-width regions
18797 (org-set-local
18798 'auto-fill-inhibit-regexp
18801 (if (or org-enable-table-editor org-enable-fixed-width-editor)
18802 (concat
18804 (if org-enable-table-editor "|" "")
18805 (if org-enable-fixed-width-editor ":" "")
18806 "]"))))
18807 ;; We use our own fill-paragraph function, to make sure that tables
18808 ;; and fixed-width regions are not wrapped. That function will pass
18809 ;; through to `fill-paragraph' when appropriate.
18810 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
18811 ;; Adaptive filling: To get full control, first make sure that
18812 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
18813 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
18814 (org-set-local 'org-adaptive-fill-regexp-backup
18815 adaptive-fill-regexp))
18817 (org-set-local 'adaptive-fill-function
18818 'org-adaptive-fill-function)
18819 (org-set-local
18820 'align-mode-rules-list
18821 '((org-in-buffer-settings
18823 (modes . '(org-mode))))))
18825 (defun org-fill-paragraph (&optional justify)
18826 "Re-align a table, pass through to fill-paragraph if no table."
18827 (let ((table-p (org-at-table-p))
18828 (table.el-p (org-at-table.el-p)))
18829 (cond ((and (equal (char-after (point-at-bol)) ?*)
18830 (save-excursion (goto-char (point-at-bol))
18831 (looking-at outline-regexp)))
18832 t) ; skip headlines
18833 (table.el-p t) ; skip table.el tables
18834 (table-p (org-table-align) t) ; align org-mode tables
18835 (t nil)))) ; call paragraph-fill
18837 ;; For reference, this is the default value of adaptive-fill-regexp
18840 (defun org-adaptive-fill-function ()
18841 "Return a fill prefix for org-mode files.
18842 In particular, this makes sure hanging paragraphs for hand-formatted lists
18843 work correctly."
18844 (cond
18845 ;; Comment line
18847 (match-string-no-properties 0))
18848 ;; Description list
18850 (save-excursion
18851 (if (> (match-end 1) (+ (match-beginning 1)
18852 org-description-max-indent))
18853 (goto-char (+ (match-beginning 1) 5))
18854 (goto-char (match-end 0)))
18855 (make-string (current-column) ?\ )))
18856 ;; Ordered or unordered list
18858 (save-excursion
18859 (goto-char (match-end 0))
18860 (make-string (current-column) ?\ )))
18861 ;; Other text
18862 ((looking-at org-adaptive-fill-regexp-backup)
18863 (match-string-no-properties 0))))
18865 ;;; Other stuff.
18867 (defun org-toggle-fixed-width-section (arg)
18868 "Toggle the fixed-width export.
18869 If there is no active region, the QUOTE keyword at the current headline is
18870 inserted or removed. When present, it causes the text between this headline
18871 and the next to be exported as fixed-width text, and unmodified.
18872 If there is an active region, this command adds or removes a colon as the
18873 first character of this line. If the first character of a line is a colon,
18874 this line is also exported in fixed-width font."
18875 (interactive "P")
18876 (let* ((cc 0)
18877 (regionp (org-region-active-p))
18878 (beg (if regionp (region-beginning) (point)))
18879 (end (if regionp (region-end)))
18880 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
18881 (case-fold-search nil)
18883 off)
18884 (if regionp
18885 (save-excursion
18886 (goto-char beg)
18887 (setq cc (current-column))
18888 (beginning-of-line 1)
18889 (setq off (looking-at re))
18890 (while (> nlines 0)
18891 (setq nlines (1- nlines))
18892 (beginning-of-line 1)
18893 (cond
18894 (arg
18895 (org-move-to-column cc t)
18897 (forward-line -1))
18898 ((and off (looking-at re))
18899 (replace-match "" t t nil 1))
18900 ((not off) (org-move-to-column cc t) (insert ": ")))
18901 (forward-line 1)))
18902 (save-excursion
18903 (org-back-to-heading)
18904 (if (looking-at (concat outline-regexp
18906 (replace-match "" t t nil 1)
18907 (if (looking-at outline-regexp)
18908 (progn
18909 (goto-char (match-end 0))
18910 (insert org-quote-string " "))))))))
18912 (defun org-reftex-citation ()
18913 "Use reftex-citation to insert a citation into the buffer.
18914 This looks for a line like
18916 #+BIBLIOGRAPHY: foo plain option:-d
18918 and derives from it that foo.bib is the bibliography file relevant
18919 for this document. It then installs the necessary environment for RefTeX
18920 to work in this buffer and calls `reftex-citation' to insert a citation
18921 into the buffer.
18923 Export of such citations to both LaTeX and HTML is handled by the contributed
18924 package org-exp-bibtex by Taru Karttunen."
18925 (interactive)
18926 (let ((reftex-docstruct-symbol 'rds)
18928 rds bib)
18929 (save-excursion
18930 (save-restriction
18931 (widen)
18932 (let ((case-fold-search t)
18934 (if (not (save-excursion
18935 (or (re-search-forward re nil t)
18936 (re-search-backward re nil t))))
18937 (error "No bibliography defined in file")
18938 (setq bib (concat (match-string 1) ".bib")
18939 rds (list (list 'bib bib)))))))
18940 (call-interactively 'reftex-citation)))
18942 ;;;; Functions extending outline functionality
18944 (defun org-beginning-of-line (&optional arg)
18945 "Go to the beginning of the current line. If that is invisible, continue
18946 to a visible line beginning. This makes the function of C-a more intuitive.
18947 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18948 first attempt, and only move to after the tags when the cursor is already
18949 beyond the end of the headline."
18950 (interactive "P")
18951 (let ((pos (point))
18952 (special (if (consp org-special-ctrl-a/e)
18953 (car org-special-ctrl-a/e)
18954 org-special-ctrl-a/e))
18955 refpos)
18956 (if (org-bound-and-true-p line-move-visual)
18957 (beginning-of-visual-line 1)
18958 (beginning-of-line 1))
18959 (if (and arg (fboundp 'move-beginning-of-line))
18960 (call-interactively 'move-beginning-of-line)
18961 (if (bobp)
18962 nil
18963 (backward-char 1)
18964 (if (org-truely-invisible-p)
18965 (while (and (not (bobp)) (org-truely-invisible-p))
18966 (backward-char 1)
18967 (beginning-of-line 1))
18968 (forward-char 1))))
18969 (when special
18970 (cond
18971 ((and (looking-at org-complex-heading-regexp)
18972 (= (char-after (match-end 1)) ?\ ))
18973 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
18974 (point-at-eol)))
18975 (goto-char
18976 (if (eq special t)
18977 (cond ((> pos refpos) refpos)
18978 ((= pos (point)) refpos)
18979 (t (point)))
18980 (cond ((> pos (point)) (point))
18981 ((not (eq last-command this-command)) (point))
18982 (t refpos)))))
18983 ((org-at-item-p)
18984 (goto-char
18985 (if (eq special t)
18986 (cond ((> pos (match-end 4)) (match-end 4))
18987 ((= pos (point)) (match-end 4))
18988 (t (point)))
18989 (cond ((> pos (point)) (point))
18990 ((not (eq last-command this-command)) (point))
18991 (t (match-end 4))))))))
18992 (org-no-warnings
18993 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18995 (defun org-end-of-line (&optional arg)
18996 "Go to the end of the line.
18997 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18998 first attempt, and only move to after the tags when the cursor is already
18999 beyond the end of the headline."
19000 (interactive "P")
19001 (let ((special (if (consp org-special-ctrl-a/e)
19002 (cdr org-special-ctrl-a/e)
19003 org-special-ctrl-a/e)))
19004 (if (or (not special)
19005 (not (org-on-heading-p))
19006 arg)
19007 (call-interactively
19008 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
19009 ((fboundp 'move-end-of-line) 'move-end-of-line)
19010 (t 'end-of-line)))
19011 (let ((pos (point)))
19012 (beginning-of-line 1)
19014 (if (eq special t)
19015 (if (or (< pos (match-beginning 1))
19016 (= pos (match-end 0)))
19017 (goto-char (match-beginning 1))
19018 (goto-char (match-end 0)))
19019 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19020 (goto-char (match-end 0))
19021 (goto-char (match-beginning 1))))
19022 (call-interactively (if (fboundp 'move-end-of-line)
19023 'move-end-of-line
19024 'end-of-line)))))
19025 (org-no-warnings
19026 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19028 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19029 (define-key org-mode-map "\C-e" 'org-end-of-line)
19031 (defun org-backward-sentence (&optional arg)
19032 "Go to beginning of sentence, or beginning of table field.
19033 This will call `backward-sentence' or `org-table-beginning-of-field',
19034 depending on context."
19035 (interactive "P")
19036 (cond
19037 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19038 (t (call-interactively 'backward-sentence))))
19040 (defun org-forward-sentence (&optional arg)
19041 "Go to end of sentence, or end of table field.
19042 This will call `forward-sentence' or `org-table-end-of-field',
19043 depending on context."
19044 (interactive "P")
19045 (cond
19046 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19047 (t (call-interactively 'forward-sentence))))
19049 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19050 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19052 (defun org-kill-line (&optional arg)
19053 "Kill line, to tags or end of line."
19054 (interactive "P")
19055 (cond
19056 ((or (not org-special-ctrl-k)
19057 (bolp)
19058 (not (org-on-heading-p)))
19059 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19060 org-ctrl-k-protect-subtree)
19061 (if (or (eq org-ctrl-k-protect-subtree 'error)
19062 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19063 (error "C-k aborted - would kill hidden subtree")))
19064 (call-interactively 'kill-line))
19066 (kill-region (point) (match-beginning 1))
19067 (org-set-tags nil t))
19068 (t (kill-region (point) (point-at-eol)))))
19070 (define-key org-mode-map "\C-k" 'org-kill-line)
19072 (defun org-yank (&optional arg)
19073 "Yank. If the kill is a subtree, treat it specially.
19074 This command will look at the current kill and check if is a single
19075 subtree, or a series of subtrees[1]. If it passes the test, and if the
19076 cursor is at the beginning of a line or after the stars of a currently
19077 empty headline, then the yank is handled specially. How exactly depends
19078 on the value of the following variables, both set by default.
19080 org-yank-folded-subtrees
19081 When set, the subtree(s) will be folded after insertion, but only
19082 if doing so would now swallow text after the yanked text.
19084 org-yank-adjusted-subtrees
19085 When set, the subtree will be promoted or demoted in order to
19086 fit into the local outline tree structure, which means that the level
19087 will be adjusted so that it becomes the smaller one of the two
19088 *visible* surrounding headings.
19090 Any prefix to this command will cause `yank' to be called directly with
19092 will just
19093 plainly yank the text as it is.
19095 \[1] The test checks if the first non-white line is a heading
19096 and if there are no other headings with fewer stars."
19097 (interactive "P")
19098 (org-yank-generic 'yank arg))
19100 (defun org-yank-generic (command arg)
19101 "Perform some yank-like command.
19103 This function implements the behavior described in the `org-yank'
19104 documentation. However, it has been generalized to work for any
19105 interactive command with similar behavior."
19107 ;; pretend to be command COMMAND
19108 (setq this-command command)
19110 (if arg
19111 (call-interactively command)
19113 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19114 (and (org-kill-is-subtree-p)
19115 (or (bolp)
19117 (string-match
19119 (buffer-substring (point-at-bol) (point)))))))
19120 swallowp)
19121 (cond
19122 ((and subtreep org-yank-folded-subtrees)
19123 (let ((beg (point))
19124 end)
19125 (if (and subtreep org-yank-adjusted-subtrees)
19126 (org-paste-subtree nil nil 'for-yank)
19127 (call-interactively command))
19129 (setq end (point))
19130 (goto-char beg)
19131 (when (and (bolp) subtreep
19132 (not (setq swallowp
19133 (org-yank-folding-would-swallow-text beg end))))
19134 (or (looking-at outline-regexp)
19135 (re-search-forward (concat "^" outline-regexp) end t))
19136 (while (and (< (point) end) (looking-at outline-regexp))
19137 (hide-subtree)
19138 (org-cycle-show-empty-lines 'folded)
19139 (condition-case nil
19140 (outline-forward-same-level 1)
19141 (error (goto-char end)))))
19142 (when swallowp
19143 (message
19144 "Inserted text not folded because that would swallow text"))
19146 (goto-char end)
19148 (beginning-of-line 1)
19149 (push-mark beg 'nomsg)))
19150 ((and subtreep org-yank-adjusted-subtrees)
19151 (let ((beg (point-at-bol)))
19152 (org-paste-subtree nil nil 'for-yank)
19153 (push-mark beg 'nomsg)))
19154 (t
19155 (call-interactively command))))))
19157 (defun org-yank-folding-would-swallow-text (beg end)
19158 "Would hide-subtree at BEG swallow any text after END?"
19159 (let (level)
19160 (save-excursion
19161 (goto-char beg)
19162 (when (or (looking-at outline-regexp)
19163 (re-search-forward (concat "^" outline-regexp) end t))
19164 (setq level (org-outline-level)))
19165 (goto-char end)
19167 (if (or (eobp)
19168 (and (bolp) (looking-at org-outline-regexp)
19169 (<= (org-outline-level) level)))
19170 nil ; Nothing would be swallowed
19171 t)))) ; something would swallow
19173 (define-key org-mode-map "\C-y" 'org-yank)
19175 (defun org-truely-invisible-p ()
19176 "Check if point is at a character currently not visible.
19177 This version does not only check the character property, but also
19178 `visible-mode'."
19179 ;; Early versions of noutline don't have `outline-invisible-p'.
19180 (if (org-bound-and-true-p visible-mode)
19181 nil
19182 (outline-invisible-p)))
19184 (defun org-invisible-p2 ()
19185 "Check if point is at a character currently not visible."
19186 (save-excursion
19187 (if (and (eolp) (not (bobp))) (backward-char 1))
19188 ;; Early versions of noutline don't have `outline-invisible-p'.
19189 (outline-invisible-p)))
19191 (defun org-back-to-heading (&optional invisible-ok)
19192 "Call `outline-back-to-heading', but provide a better error message."
19193 (condition-case nil
19194 (outline-back-to-heading invisible-ok)
19195 (error (error "Before first headline at position %d in buffer %s"
19196 (point) (current-buffer)))))
19198 (defun org-beginning-of-defun ()
19199 "Go to the beginning of the subtree, i.e. back to the heading."
19200 (org-back-to-heading))
19201 (defun org-end-of-defun ()
19202 "Go to the end of the subtree."
19203 (org-end-of-subtree nil t))
19205 (defun org-before-first-heading-p ()
19206 "Before first heading?"
19207 (save-excursion
19208 (end-of-line)
19211 (defun org-on-heading-p (&optional ignored)
19212 (outline-on-heading-p t))
19213 (defun org-at-heading-p (&optional ignored)
19214 (outline-on-heading-p t))
19216 (defun org-point-at-end-of-empty-headline ()
19217 "If point is at the end of an empty headline, return t, else nil.
19218 If the heading only contains a TODO keyword, it is still still considered
19219 empty."
19221 (save-excursion
19222 (beginning-of-line 1)
19225 (defun org-at-heading-or-item-p ()
19226 (or (org-on-heading-p) (org-at-item-p)))
19228 (defun org-on-target-p ()
19229 (or (org-in-regexp org-radio-target-regexp)
19230 (org-in-regexp org-target-regexp)))
19232 (defun org-up-heading-all (arg)
19233 "Move to the heading line of which the present line is a subheading.
19234 This function considers both visible and invisible heading lines.
19235 With argument, move up ARG levels."
19236 (if (fboundp 'outline-up-heading-all)
19237 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19238 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19240 (defun org-up-heading-safe ()
19241 "Move to the heading line of which the present line is a subheading.
19242 This version will not throw an error. It will return the level of the
19243 headline found, or nil if no higher level is found.
19245 Also, this function will be a lot faster than `outline-up-heading',
19246 because it relies on stars being the outline starters. This can really
19247 make a significant difference in outlines with very many siblings."
19248 (let (start-level re)
19249 (org-back-to-heading t)
19250 (setq start-level (funcall outline-level))
19251 (if (equal start-level 1)
19252 nil
19254 (if (re-search-backward re nil t)
19255 (funcall outline-level)))))
19257 (defun org-first-sibling-p ()
19258 "Is this heading the first child of its parents?"
19259 (interactive)
19260 (let ((re (concat "^" outline-regexp))
19261 level l)
19262 (unless (org-at-heading-p t)
19263 (error "Not at a heading"))
19264 (setq level (funcall outline-level))
19265 (save-excursion
19266 (if (not (re-search-backward re nil t))
19267 t
19268 (setq l (funcall outline-level))
19269 (< l level)))))
19271 (defun org-goto-sibling (&optional previous)
19272 "Goto the next sibling, even if it is invisible.
19273 When PREVIOUS is set, go to the previous sibling instead. Returns t
19274 when a sibling was found. When none is found, return nil and don't
19275 move point."
19276 (let ((fun (if previous 're-search-backward 're-search-forward))
19277 (pos (point))
19278 (re (concat "^" outline-regexp))
19279 level l)
19280 (when (condition-case nil (org-back-to-heading t) (error nil))
19281 (setq level (funcall outline-level))
19282 (catch 'exit
19283 (or previous (forward-char 1))
19284 (while (funcall fun re nil t)
19285 (setq l (funcall outline-level))
19286 (when (< l level) (goto-char pos) (throw 'exit nil))
19287 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
19288 (goto-char pos)
19289 nil))))
19291 (defun org-show-siblings ()
19292 "Show all siblings of the current headline."
19293 (save-excursion
19294 (while (org-goto-sibling) (org-flag-heading nil)))
19295 (save-excursion
19296 (while (org-goto-sibling 'previous)
19297 (org-flag-heading nil))))
19299 (defun org-goto-first-child ()
19300 "Goto the first child, even if it is invisible.
19301 Return t when a child was found. Otherwise don't move point and
19302 return nil."
19303 (let (level (pos (point)) (re (concat "^" outline-regexp)))
19304 (when (condition-case nil (org-back-to-heading t) (error nil))
19305 (setq level (outline-level))
19306 (forward-char 1)
19307 (if (and (re-search-forward re nil t) (> (outline-level) level))
19308 (progn (goto-char (match-beginning 0)) t)
19309 (goto-char pos) nil))))
19311 (defun org-show-hidden-entry ()
19312 "Show an entry where even the heading is hidden."
19313 (save-excursion
19314 (org-show-entry)))
19316 (defun org-flag-heading (flag &optional entry)
19317 "Flag the current heading. FLAG non-nil means make invisible.
19318 When ENTRY is non-nil, show the entire entry."
19319 (save-excursion
19320 (org-back-to-heading t)
19321 ;; Check if we should show the entire entry
19322 (if entry
19323 (progn
19324 (org-show-entry)
19325 (save-excursion
19326 (and (outline-next-heading)
19327 (org-flag-heading nil))))
19328 (outline-flag-region (max (point-min) (1- (point)))
19329 (save-excursion (outline-end-of-heading) (point))
19330 flag))))
19332 (defun org-get-next-sibling ()
19333 "Move to next heading of the same level, and return point.
19334 If there is no such heading, return nil.
19335 This is like outline-next-sibling, but invisible headings are ok."
19336 (let ((level (funcall outline-level)))
19337 (outline-next-heading)
19338 (while (and (not (eobp)) (> (funcall outline-level) level))
19339 (outline-next-heading))
19340 (if (or (eobp) (< (funcall outline-level) level))
19341 nil
19342 (point))))
19344 (defun org-get-last-sibling ()
19345 "Move to previous heading of the same level, and return point.
19346 If there is no such heading, return nil."
19347 (let ((opoint (point))
19348 (level (funcall outline-level)))
19349 (outline-previous-heading)
19350 (when (and (/= (point) opoint) (outline-on-heading-p t))
19351 (while (and (> (funcall outline-level) level)
19352 (not (bobp)))
19353 (outline-previous-heading))
19354 (if (< (funcall outline-level) level)
19355 nil
19356 (point)))))
19358 (defun org-end-of-subtree (&optional invisible-OK to-heading)
19359 ;; This contains an exact copy of the original function, but it uses
19360 ;; `org-back-to-heading', to make it work also in invisible
19361 ;; trees. And is uses an invisible-OK argument.
19362 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
19363 ;; Furthermore, when used inside Org, finding the end of a large subtree
19364 ;; with many children and grandchildren etc, this can be much faster
19365 ;; than the outline version.
19366 (org-back-to-heading invisible-OK)
19367 (let ((first t)
19368 (level (funcall outline-level)))
19369 (if (and (org-mode-p) (< level 1000))
19370 ;; A true heading (not a plain list item), in Org-mode
19371 ;; This means we can easily find the end by looking
19372 ;; only for the right number of stars. Using a regexp to do
19373 ;; this is so much faster than using a Lisp loop.
19375 (forward-char 1)
19376 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
19377 ;; something else, do it the slow way
19378 (while (and (not (eobp))
19379 (or first (> (funcall outline-level) level)))
19380 (setq first nil)
19381 (outline-next-heading)))
19382 (unless to-heading
19384 (progn
19385 ;; Go to end of line before heading
19386 (forward-char -1)
19388 ;; leave blank line before heading
19389 (forward-char -1))))))
19390 (point))
19392 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
19393 "Use Org version in org-mode, for dramatic speed-up."
19394 (if (eq major-mode 'org-mode)
19395 (progn
19396 (org-end-of-subtree nil t)
19397 (unless (eobp) (backward-char 1)))
19398 ad-do-it))
19400 (defun org-forward-same-level (arg &optional invisible-ok)
19401 "Move forward to the arg'th subheading at same level as this one.
19402 Stop at the first and last subheadings of a superior heading.
19403 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
19404 it wil also look at invisible ones."
19405 (interactive "p")
19406 (org-back-to-heading invisible-ok)
19407 (org-on-heading-p)
19408 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19410 l)
19411 (forward-char 1)
19412 (while (> arg 0)
19413 (while (and (re-search-forward re nil 'move)
19414 (setq l (- (match-end 0) (match-beginning 0) 1))
19415 (= l level)
19416 (not invisible-ok)
19417 (progn (backward-char 1) (outline-invisible-p)))
19418 (if (< l level) (setq arg 1)))
19419 (setq arg (1- arg)))
19420 (beginning-of-line 1)))
19422 (defun org-backward-same-level (arg &optional invisible-ok)
19423 "Move backward to the arg'th subheading at same level as this one.
19424 Stop at the first and last subheadings of a superior heading."
19425 (interactive "p")
19426 (org-back-to-heading)
19427 (org-on-heading-p)
19428 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19430 l)
19431 (while (> arg 0)
19432 (while (and (re-search-backward re nil 'move)
19433 (setq l (- (match-end 0) (match-beginning 0) 1))
19434 (= l level)
19435 (not invisible-ok)
19436 (outline-invisible-p))
19437 (if (< l level) (setq arg 1)))
19438 (setq arg (1- arg)))))
19440 (defun org-show-subtree ()
19441 "Show everything after this heading at deeper levels."
19442 (outline-flag-region
19443 (point)
19444 (save-excursion
19445 (org-end-of-subtree t t))
19446 nil))
19448 (defun org-show-entry ()
19449 "Show the body directly following this heading.
19450 Show the heading too, if it is currently invisible."
19451 (interactive)
19452 (save-excursion
19453 (condition-case nil
19454 (progn
19455 (org-back-to-heading t)
19456 (outline-flag-region
19457 (max (point-min) (1- (point)))
19458 (save-excursion
19459 (if (re-search-forward
19461 (match-beginning 1)
19462 (point-max)))
19463 nil)
19464 (org-cycle-hide-drawers 'children))
19465 (error nil))))
19467 (defun org-make-options-regexp (kwds &optional extra)
19468 "Make a regular expression for keyword lines."
19469 (concat
19470 "^"
19477 ;; Make isearch reveal the necessary context
19478 (defun org-isearch-end ()
19479 "Reveal context after isearch exits."
19480 (when isearch-success ; only if search was successful
19481 (if (featurep 'xemacs)
19482 ;; Under XEmacs, the hook is run in the correct place,
19483 ;; we directly show the context.
19484 (org-show-context 'isearch)
19485 ;; In Emacs the hook runs *before* restoring the overlays.
19486 ;; So we have to use a one-time post-command-hook to do this.
19487 ;; (Emacs 22 has a special variable, see function `org-mode')
19488 (unless (and (boundp 'isearch-mode-end-hook-quit)
19489 isearch-mode-end-hook-quit)
19490 ;; Only when the isearch was not quitted.
19491 (org-add-hook 'post-command-hook 'org-isearch-post-command
19492 'append 'local)))))
19494 (defun org-isearch-post-command ()
19495 "Remove self from hook, and show context."
19496 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
19497 (org-show-context 'isearch))
19500 ;;;; Integration with and fixes for other packages
19502 ;;; Imenu support
19504 (defvar org-imenu-markers nil
19505 "All markers currently used by Imenu.")
19506 (make-variable-buffer-local 'org-imenu-markers)
19508 (defun org-imenu-new-marker (&optional pos)
19509 "Return a new marker for use by Imenu, and remember the marker."
19510 (let ((m (make-marker)))
19511 (move-marker m (or pos (point)))
19512 (push m org-imenu-markers)
19513 m))
19515 (defun org-imenu-get-tree ()
19516 "Produce the index for Imenu."
19517 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
19518 (setq org-imenu-markers nil)
19519 (let* ((n org-imenu-depth)
19520 (re (concat "^" outline-regexp))
19521 (subs (make-vector (1+ n) nil))
19522 (last-level 0)
19523 m level head)
19524 (save-excursion
19525 (save-restriction
19526 (widen)
19527 (goto-char (point-max))
19528 (while (re-search-backward re nil t)
19529 (setq level (org-reduced-level (funcall outline-level)))
19530 (when (<= level n)
19531 (looking-at org-complex-heading-regexp)
19532 (setq head (org-link-display-format
19533 (org-match-string-no-properties 4))
19534 m (org-imenu-new-marker))
19535 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
19536 (if (>= level last-level)
19537 (push (cons head m) (aref subs level))
19538 (push (cons head (aref subs (1+ level))) (aref subs level))
19539 (loop for i from (1+ level) to n do (aset subs i nil)))
19540 (setq last-level level)))))
19541 (aref subs 1)))
19543 (eval-after-load "imenu"
19544 '(progn
19545 (add-hook 'imenu-after-jump-hook
19546 (lambda ()
19547 (if (eq major-mode 'org-mode)
19548 (org-show-context 'org-goto))))))
19550 (defun org-link-display-format (link)
19551 "Replace a link with either the description, or the link target
19552 if no description is present"
19553 (save-match-data
19554 (if (string-match org-bracket-link-analytic-regexp link)
19555 (replace-match (if (match-end 5)
19556 (match-string 5 link)
19557 (concat (match-string 1 link)
19558 (match-string 3 link)))
19559 nil t link)
19560 link)))
19562 ;; Speedbar support
19564 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
19565 "Overlay marking the agenda restriction line in speedbar.")
19566 (overlay-put org-speedbar-restriction-lock-overlay
19567 'face 'org-agenda-restriction-lock)
19568 (overlay-put org-speedbar-restriction-lock-overlay
19569 'help-echo "Agendas are currently limited to this item.")
19570 (org-detach-overlay org-speedbar-restriction-lock-overlay)
19572 (defun org-speedbar-set-agenda-restriction ()
19573 "Restrict future agenda commands to the location at point in speedbar.
19575 (interactive)
19576 (require 'org-agenda)
19577 (let (p m tp np dir txt)
19578 (cond
19579 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19580 'org-imenu t))
19581 (setq m (get-text-property p 'org-imenu-marker))
19582 (with-current-buffer (marker-buffer m)
19583 (goto-char m)
19584 (org-agenda-set-restriction-lock 'subtree)))
19585 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19586 'speedbar-function 'speedbar-find-file))
19587 (setq tp (previous-single-property-change
19588 (1+ p) 'speedbar-function)
19589 np (next-single-property-change
19590 tp 'speedbar-function)
19591 dir (speedbar-line-directory)
19592 txt (buffer-substring-no-properties (or tp (point-min))
19593 (or np (point-max))))
19594 (with-current-buffer (find-file-noselect
19595 (let ((default-directory dir))
19596 (expand-file-name txt)))
19597 (unless (org-mode-p)
19598 (error "Cannot restrict to non-Org-mode file"))
19599 (org-agenda-set-restriction-lock 'file)))
19600 (t (error "Don't know how to restrict Org-mode's agenda")))
19601 (move-overlay org-speedbar-restriction-lock-overlay
19602 (point-at-bol) (point-at-eol))
19603 (setq current-prefix-arg nil)
19604 (org-agenda-maybe-redo)))
19606 (eval-after-load "speedbar"
19607 '(progn
19608 (speedbar-add-supported-extension ".org")
19609 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
19610 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
19611 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
19612 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19613 (add-hook 'speedbar-visiting-tag-hook
19614 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
19616 ;;; Fixes and Hacks for problems with other packages
19618 ;; Make flyspell not check words in links, to not mess up our keymap
19619 (defun org-mode-flyspell-verify ()
19620 "Don't let flyspell put overlays at active buttons."
19621 (and (not (get-text-property (max (1- (point)) (point-min)) 'keymap))
19622 (not (get-text-property (max (1- (point)) (point-min)) 'org-no-flyspell))))
19624 (defun org-remove-flyspell-overlays-in (beg end)
19625 "Remove flyspell overlays in region."
19626 (and (org-bound-and-true-p flyspell-mode)
19627 (fboundp 'flyspell-delete-region-overlays)
19628 (flyspell-delete-region-overlays beg end))
19629 (add-text-properties beg end '(org-no-flyspell t)))
19631 ;; Make `bookmark-jump' shows the jump location if it was hidden.
19632 (eval-after-load "bookmark"
19633 '(if (boundp 'bookmark-after-jump-hook)
19634 ;; We can use the hook
19635 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
19636 ;; Hook not available, use advice
19637 (defadvice bookmark-jump (after org-make-visible activate)
19638 "Make the position visible."
19639 (org-bookmark-jump-unhide))))
19641 ;; Make sure saveplace shows the location if it was hidden
19642 (eval-after-load "saveplace"
19643 '(defadvice save-place-find-file-hook (after org-make-visible activate)
19644 "Make the position visible."
19645 (org-bookmark-jump-unhide)))
19647 ;; Make sure ecb shows the location if it was hidden
19648 (eval-after-load "ecb"
19649 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
19650 "Make hierarchy visible when jumping into location from ECB tree buffer."
19651 (if (eq major-mode 'org-mode)
19652 (org-show-context))))
19654 (defun org-bookmark-jump-unhide ()
19655 "Unhide the current position, to show the bookmark location."
19656 (and (org-mode-p)
19657 (or (outline-invisible-p)
19658 (save-excursion (goto-char (max (point-min) (1- (point))))
19659 (outline-invisible-p)))
19660 (org-show-context 'bookmark-jump)))
19662 ;; Make session.el ignore our circular variable
19663 (eval-after-load "session"
19664 '(add-to-list 'session-globals-exclude 'org-mark-ring))
19666 ;;;; Experimental code
19668 (defun org-closed-in-range ()
19669 "Sparse tree of items closed in a certain time range.
19670 Still experimental, may disappear in the future."
19671 (interactive)
19672 ;; Get the time interval from the user.
19673 (let* ((time1 (org-float-time
19674 (org-read-date nil 'to-time nil "Starting date: ")))
19675 (time2 (org-float-time
19676 (org-read-date nil 'to-time nil "End date:")))
19677 ;; callback function
19678 (callback (lambda ()
19679 (let ((time
19680 (org-float-time
19681 (apply 'encode-time
19682 (org-parse-time-string
19683 (match-string 1))))))
19684 ;; check if time in interval
19685 (and (>= time time1) (<= time time2))))))
19686 ;; make tree, check each match with the callback
19689 ;;;; Finish up
19691 (provide 'org)
19693 (run-hooks 'org-load-hook)
19695 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
19697 ;;; org.el ends here