| blob | e190b84d25fe47520fec8dfce7e64d275620c187 |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.4
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
28 ;;
29 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
30 ;; project planning with a fast and effective plain-text system.
31 ;;
32 ;; Org-mode develops organizational tasks around NOTES files that contain
33 ;; information about projects as plain text. Org-mode is implemented on
34 ;; top of outline-mode, which makes it possible to keep the content of
35 ;; large files well structured. Visibility cycling and structure editing
36 ;; help to work with the tree. Tables are easily created with a built-in
37 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
38 ;; and scheduling. It dynamically compiles entries into an agenda that
39 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
40 ;; Plain text URL-like links connect to websites, emails, Usenet
41 ;; messages, BBDB entries, and any files related to the projects. For
42 ;; printing and sharing of notes, an Org-mode file can be exported as a
43 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
44 ;; iCalendar file. It can also serve as a publishing tool for a set of
45 ;; linked webpages.
46 ;;
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
50 ;;
51 ;; http://orgmode.org/org.html#Installation
52 ;;
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org-mode can be found in the TeXInfo file. The
56 ;; distribution also contains a PDF version of it. At the homepage of
57 ;; Org-mode, you can read the same text online as HTML. There is also an
58 ;; excellent reference card made by Philip Rooke. This card can be found
59 ;; in the etc/ directory of Emacs 22.
60 ;;
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
63 ;;
64 ;;; Code:
71 ;;;; Require other packages
79 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
91 ;; Other stuff we need.
106 ;; babel
115 ;; load languages based on value of `org-babel-load-languages'
117 ;;;###autoload
119 "Load the languages defined in `org-babel-load-languages'."
131 org-babel-load-languages))
134 "Languages which can be evaluated in Org-mode buffers.
135 This list can be used to load support for any of the languages
136 below, note that each language will depend on a different set of
137 system executables and/or Emacs modes. When a language is
139 with `org-babel-execute-src-block' bound by default to C-c
140 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
141 be set to remove code block evaluation from the C-c C-c
142 keybinding. By default only Emacs Lisp (which has no
143 requirements) is loaded."
147 :key-type
180 ;;;; Customization variables
182 "Remove ID property of clones of a subtree.
183 When non-nil, clones of a subtree don't inherit the ID property.
184 Otherwise they inherit the ID property with a new unique
185 identifier."
189 ;;; Version
195 "Show the org-mode version in the echo area.
196 With prefix arg HERE, insert it at point."
222 ;;; Compatibility constants
224 ;;; The custom variables
227 "Outline-based notes management and organizer."
233 "Mode hook for Org-mode, run after the mode was turned on."
238 "Hook that is run after org.el has been loaded."
247 "Load all extensions listed in `org-modules'."
252 org-modules)
256 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
265 (defcustom org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
266 "Modules that should always be loaded together with org.el.
267 If a description starts with <C>, the file is not part of Emacs
268 and loading it will require that you have downloaded and properly installed
269 the org-mode distribution.
271 You can also use this system to load external packages (i.e. neither Org
272 core modules, nor modules from the CONTRIB directory). Just add symbols
273 to the end of the list. If the package is called org-xyz.el, then you need
274 to add the symbol `xyz', and the package must have a call to
276 (provide 'org-xyz)"
279 :type
309 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
316 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
324 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
341 "Non-nil means make shift-cursor commands select text when possible.
343 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
344 selecting a region, or enlarge regions started in this way.
345 In Org-mode, in special contexts, these same keys are used for other
346 purposes, important enough to compete with shift selection. Org tries
347 to balance these needs by supporting `shift-select-mode' outside these
348 special contexts, under control of this variable.
350 The default of this variable is nil, to avoid confusing behavior. Shifted
351 cursor keys will then execute Org commands in the following contexts:
352 - on a headline, changing TODO state (left/right) and priority (up/down)
353 - on a time stamp, changing the time
354 - in a plain list item, changing the bullet type
355 - in a property definition line, switching between allowed values
356 - in the BEGIN line of a clock table (changing the time block).
357 Outside these contexts, the commands will throw an error.
359 When this variable is t and the cursor is not in a special context,
360 Org-mode will support shift-selection for making and enlarging regions.
361 To make this more effective, the bullet cycling will no longer happen
362 anywhere in an item line, but only if the cursor is exactly on the bullet.
364 If you set this variable to the symbol `always', then the keys
365 will not be special in headlines, property lines, and item lines, to make
366 shift selection work there as well. If this is what you want, you can
367 use the following alternative commands: `C-c C-t' and `C-c ,' to
368 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
369 TODO sets, `C-c -' to cycle item bullet types, and properties can be
370 edited by hand or in column view.
372 However, when the cursor is on a timestamp, shift-cursor commands
373 will still edit the time stamp - this is just too good to give up.
375 XEmacs user should have this variable set to nil, because shift-select-mode
376 is Emacs 23 only."
384 "Options concerning startup of Org-mode."
389 "Non-nil means entering Org-mode will switch to OVERVIEW.
390 This can also be configured on a per-file basis by adding one of
391 the following lines anywhere in the buffer:
393 #+STARTUP: fold (or `overview', this is equivalent)
394 #+STARTUP: nofold (or `showall', this is equivalent)
395 #+STARTUP: content
396 #+STARTUP: showeverything"
405 "Non-nil means entering Org-mode will set `truncate-lines'.
406 This is useful since some lines containing links can be very long and
407 uninteresting. Also tables look terrible when wrapped."
412 "Non-nil means turn on `org-indent-mode' on startup.
413 This can also be configured on a per-file basis by adding one of
414 the following lines anywhere in the buffer:
416 #+STARTUP: indent
417 #+STARTUP: noindent"
425 When this option is turned on, you can use TeX-like syntax for sub- and
427 considered as a single item - so grouping with {} is normally not
428 needed. For example, the following things will be parsed as single
429 sub- or superscripts.
431 10^24 or 10^tau several digits will be considered 1 item.
432 10^-12 or 10^-tau a leading sign with digits or a word
433 x^2-y^3 will be read as x^2 - y^3, because items are
434 terminated by almost any nonword/nondigit char.
435 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
437 Still, ambiguity is possible - so when in doubt use {} to enclose the
438 sub/superscript. If you set this variable to the symbol `{}',
439 the braces are *required* in order to trigger interpretations as
441 frequently in plain text.
443 Not all export backends support this, but HTML does.
458 "Non-nil means turn on `org-beamer-mode' on startup.
459 This can also be configured on a per-file basis by adding one of
460 the following lines anywhere in the buffer:
462 #+STARTUP: beamer"
467 "Non-nil means align all tables when visiting a file.
468 This is useful when the column width in tables is forced with <N> cookies
469 in table fields. Such tables will look correct only after the first re-align.
470 This can also be configured on a per-file basis by adding one of
471 the following lines anywhere in the buffer:
472 #+STARTUP: align
473 #+STARTUP: noalign"
478 "Non-nil means show inline images when loading a new Org file.
479 This can also be configured on a per-file basis by adding one of
480 the following lines anywhere in the buffer:
481 #+STARTUP: inlineimages
482 #+STARTUP: noinlineimages"
487 "Non-nil means insert the first line setting Org-mode in empty files.
488 When the function `org-mode' is called interactively in an empty file, this
489 normally means that the file name does not automatically trigger Org-mode.
490 To ensure that the file will always be in Org-mode in the future, a
491 line enforcing Org-mode will be inserted into the buffer, if this option
492 has been set."
497 "Non-nil means use alternative key bindings for some keys.
498 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
499 These keys are also used by other packages like shift-selection-mode'
500 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
501 If you want to use Org-mode together with one of these other modes,
502 or more generally if you would like to move some Org-mode commands to
503 other keys, set this variable and configure the keys with the variable
504 `org-disputed-keys'.
506 This option is only relevant at load-time of Org-mode, and must be set
507 *before* org.el is loaded. Changing it requires a restart of Emacs to
508 become effective."
513 "Non-nil means use extra key sequence definitions for certain commands.
514 This happens automatically if you run XEmacs or if `window-system'
515 is nil. This variable lets you do the same manually. You must
516 set it before loading org.
518 Example: on Carbon Emacs 22 running graphically, with an external
519 keyboard on a Powerbook, the default way of setting M-left might
520 not work for either Alt or ESC. Setting this variable will make
521 it work for ESC."
535 "Keys for which Org-mode and other modes compete.
536 This is an alist, cars are the default keys, second element specifies
537 the alternative to use when `org-replace-disputed-keys' is t.
539 Keys can be specified in any syntax supported by `define-key'.
540 The value of this option takes effect only at Org-mode's startup,
541 therefore you'll have to restart Emacs to apply it after changing."
546 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
547 Or return the original if not disputed.
548 Also apply the translations defined in `org-xemacs-key-equivalents'."
553 org-disputed-keys)))
557 key)
567 "Define a key, possibly translated, as returned by `org-key'."
571 "The ellipsis to use in the Org-mode outline.
572 When nil, just use the standard three dots. When a string, use that instead,
573 When a face, use the standard 3 dots, but with the specified face.
574 The change affects only Org-mode (which will then use its own display table).
575 Changing this requires executing `M-x org-mode' in a buffer to become
576 effective."
586 "Keywords in Org-mode."
591 "String to mark deadline entries.
592 A deadline is this string, followed by a time stamp. Should be a word,
593 terminated by a colon. You can insert a schedule keyword and
595 Changes become only effective after restarting Emacs."
600 "String to mark scheduled TODO entries.
601 A schedule is this string, followed by a time stamp. Should be a word,
602 terminated by a colon. You can insert a schedule keyword and
604 Changes become only effective after restarting Emacs."
609 "String used as the prefix for timestamps logging closing a TODO entry."
614 "String used as prefix for timestamps clocking work hours on an item."
619 "Entries starting with this keyword will never be exported.
620 An entry can be toggled between COMMENT and normal with
622 Changes become only effective after restarting Emacs."
627 "Entries starting with this keyword will be exported in fixed-width font.
628 Quoting applies only to the text in the entry following the headline, and does
629 not extend beyond the next headline, even if that is lower level.
630 An entry can be toggled between QUOTE and normal with
637 "Regular expression for specifying repeated events.
641 "Options concerning the general structure of Org-mode files."
646 "Options about how to make context of a location visible."
670 "Non-nil means show full hierarchy when revealing a location.
671 Org-mode often shows locations in an org-mode file which might have
672 been invisible before. When this is set, the hierarchy of headings
673 above the exposed location is shown.
674 Turning this off for example for sparse trees makes them very compact.
675 Instead of t, this can also be an alist specifying this option for different
676 contexts. Valid contexts are
677 agenda when exposing an entry from the agenda
678 org-goto when using the command `org-goto' on key C-c C-j
679 occur-tree when using the command `org-occur' on key C-c /
680 tags-tree when constructing a sparse tree based on tags matches
681 link-search when exposing search matches associated with a link
682 mark-goto when exposing the jump goal of a mark
683 bookmark-jump when exposing a bookmark location
684 isearch when exiting from an incremental search
685 default default for all contexts not set explicitly"
690 "Non-nil means show following heading when revealing a location.
691 Org-mode often shows locations in an org-mode file which might have
692 been invisible before. When this is set, the heading following the
693 match is shown.
694 Turning this off for example for sparse trees makes them very compact,
695 but makes it harder to edit the location of the match. In such a case,
697 Instead of t, this can also be an alist specifying this option for different
698 contexts. See `org-show-hierarchy-above' for valid contexts."
703 "Non-nil means show all sibling heading when revealing a location.
704 Org-mode often shows locations in an org-mode file which might have
705 been invisible before. When this is set, the sibling of the current entry
706 heading are all made visible. If `org-show-hierarchy-above' is t,
707 the same happens on each level of the hierarchy above the current entry.
709 By default this is on for the isearch context, off for all other contexts.
710 Turning this off for example for sparse trees makes them very compact,
711 but makes it harder to edit the location of the match. In such a case,
713 Instead of t, this can also be an alist specifying this option for different
714 contexts. See `org-show-hierarchy-above' for valid contexts."
719 "Non-nil means show the entry below a headline when revealing a location.
720 Org-mode often shows locations in an org-mode file which might have
721 been invisible before. When this is set, the text below the headline that is
722 exposed is also shown.
724 By default this is off for all contexts.
725 Instead of t, this can also be an alist specifying this option for different
726 contexts. See `org-show-hierarchy-above' for valid contexts."
731 "How should indirect tree buffers be displayed?
732 This applies to indirect buffers created with the commands
734 Valid values are:
735 current-window Display in the current window
736 other-window Just display in another window.
737 dedicated-frame Create one new frame, and re-use it each time.
738 new-frame Make a new frame each time. Note that in this case
739 previously-made indirect buffers are kept, and you need to
740 kill these buffers yourself."
750 "Non-nil means activate single letter commands at beginning of a headline.
751 This may also be a function to test for appropriate locations where speed
752 commands should be active."
760 "Alist of additional speed commands.
761 This list will be checked before `org-speed-commands-default'
762 when the variable `org-use-speed-commands' is non-nil
763 and when the cursor is at the beginning of a headline.
764 The car if each entry is a string with a single letter, which must
765 be assigned to `self-insert-command' in the global map.
766 The cdr is either a command to be called interactively, a function
767 to be called, or a form to be evaluated.
768 An entry that is just a list with a single string will be interpreted
769 as a descriptive headline that will be added when listing the speed
770 commands in the Help buffer using the `?' speed command."
782 "Options concerning visibility cycling in Org-mode."
787 "Non-nil means skip CHILDREN state in entries that don't have any."
792 "Maximum level which should still be subject to visibility cycling.
793 Levels higher than this will, for cycling, be treated as text, not a headline.
794 When `org-odd-levels-only' is set, a value of N in this variable actually
795 means 2N-1 stars as the limiting headline.
796 When nil, cycle all levels.
797 Note that the limiting level of cycling is also influenced by
798 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
799 `org-inlinetask-min-level' is, cycling will be limited to levels one less
800 than its value."
807 "Names of drawers. Drawers are not opened by cycling on the headline above.
808 Drawers only open with a TAB on the drawer line itself. A drawer looks like
809 this:
810 :DRAWERNAME:
811 .....
812 :END:
814 the property API.
816 Drawers can be defined on the per-file basis with a line like:
818 #+DRAWERS: HIDDEN STATE PROPERTIES"
824 "Non-nil means entering Org-mode will fold all blocks.
825 This can also be set in on a per-file basis with
827 #+STARTUP: hideblocks
828 #+STARTUP: showblocks"
834 "Cycle globally if cursor is at beginning of buffer and not at a headline.
835 This makes it possible to do global cycling without having to use S-TAB or
837 of the buffer
838 must not be a headline - it may be empty or some other text. When used in
839 this way, `org-cycle-hook' is disables temporarily, to make sure the
840 cursor stays at the beginning of the buffer.
841 When this option is nil, don't do anything special at the beginning
842 of the buffer."
847 "Non-nil means cycle entry level or item indentation in new empty entries.
849 When the cursor is at the end of an empty headline, i.e with only stars
850 and maybe a TODO keyword, TAB will then switch the entry to become a child,
851 and then all possible ancestor states, before returning to the original state.
852 This makes data entry extremely fast: M-RET to create a new headline,
853 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
855 When the cursor is at the end of an empty plain list item, one TAB will
856 make it a subitem, two or more tabs will back up to make this an item
857 higher up in the item hierarchy."
862 "Where should `org-cycle' emulate TAB.
863 nil Never
864 white Only in completely white lines
865 whitestart Only at the beginning of lines, before the first non-white char
866 t Everywhere except in headlines
867 exc-hl-bol Everywhere except at the start of a headline
868 If TAB is used in a place where it does not emulate TAB, the current subtree
869 visibility is cycled."
876 ))
879 "Number of empty lines needed to keep an empty line between collapsed trees.
880 If you leave an empty line between the end of a subtree and the following
881 headline, this empty line is hidden when the subtree is folded.
882 Org-mode will leave (exactly) one empty line visible if the number of
883 empty lines is equal or larger to the number given in this variable.
884 So the default 2 means at least 2 empty lines after the end of a subtree
885 are needed to produce free space between a collapsed subtree and the
886 following headline.
888 If the number is negative, and the number of empty lines is at least -N,
889 all empty lines are shown.
891 Special case: when 0, never leave empty lines in collapsed view."
897 "Hook that is run before visibility cycling is happening.
898 The function(s) in this hook must accept a single argument which indicates
899 the new state that will be set right after running this hook. The
900 argument is a symbol. Before a global state change, it can have the values
901 `overview', `content', or `all'. Before a local state change, it can have
902 the values `folded', `children', or `subtree'."
907 org-cycle-hide-drawers
908 org-cycle-show-empty-lines
909 org-optimize-window-after-visibility-change)
910 "Hook that is run after `org-cycle' has changed the buffer visibility.
911 The function(s) in this hook must accept a single argument which indicates
912 the new state that was set by the most recent `org-cycle' command. The
913 argument is a symbol. After a global state change, it can have the values
914 `overview', `content', or `all'. After a local state change, it can have
915 the values `folded', `children', or `subtree'."
920 "Options concerning structure editing in Org-mode."
925 "Non-nil means skip even levels and only use odd levels for the outline.
926 This has the effect that two stars are being added/taken away in
927 promotion/demotion commands. It also influences how levels are
928 handled by the exporters.
929 Changing it requires restart of `font-lock-mode' to become effective
930 for fontification also in regions already fontified.
931 You may also set this on a per-file basis by adding one of the following
932 lines to the buffer:
934 #+STARTUP: odd
935 #+STARTUP: oddeven"
941 "Non-nil means adapt indentation to outline node level.
943 When this variable is set, Org assumes that you write outlines by
944 indenting text in each node to align with the headline (after the stars).
945 The following issues are influenced by this variable:
947 - When this is set and the *entire* text in an entry is indented, the
948 indentation is increased by one space in a demotion command, and
949 decreased by one in a promotion command. If any line in the entry
950 body starts with text at column 0, indentation is not changed at all.
952 - Property drawers and planning information is inserted indented when
953 this variable s set. When nil, they will not be indented.
955 - TAB indents a line relative to context. The lines below a headline
956 will be indented when this variable is set.
958 Note that this is all about true indentation, by adding and removing
959 space characters. See also `org-indent.el' which does level-dependent
960 indentation in a virtual way, i.e. at display time in Emacs."
965 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
967 When t, `C-a' will bring back the cursor to the beginning of the
968 headline text, i.e. after the stars and after a possible TODO keyword.
969 In an item, this will be the position after the bullet.
970 When the cursor is already at that position, another `C-a' will bring
971 it to the beginning of the line.
973 `C-e' will jump to the end of the headline, ignoring the presence of tags
974 in the headline. A second `C-e' will then jump to the true end of the
975 line, after any tags. This also means that, when this variable is
976 non-nil, `C-e' also will never jump beyond the end of the heading of a
977 folded section, i.e. not after the ellipses.
979 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
980 going to the true line boundary first. Only a directly following, identical
981 keypress will bring the cursor to the special positions.
983 This may also be a cons cell where the behavior for `C-a' and `C-e' is
984 set separately."
1003 "Non-nil means `C-k' will behave specially in headlines.
1004 When nil, `C-k' will call the default `kill-line' command.
1005 When t, the following will happen while the cursor is in the headline:
1007 - When the cursor is at the beginning of a headline, kill the entire
1008 line and possible the folded subtree below the line.
1009 - When in the middle of the headline text, kill the headline up to the tags.
1010 - When after the headline text, kill the tags."
1015 "Non-nil means, do not delete a hidden subtree with C-k.
1016 When set to the symbol `error', simply throw an error when C-k is
1017 used to kill (part-of) a headline that has hidden text behind it.
1018 Any other non-nil value will result in a query to the user, if it is
1019 OK to kill that hidden subtree. When nil, kill without remorse."
1027 "Non-nil means when yanking subtrees, fold them.
1028 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1029 it starts with a heading and all other headings in it are either children
1030 or siblings, then fold all the subtrees. However, do this only if no
1031 text after the yank would be swallowed into a folded tree by this action."
1036 "Non-nil means when yanking subtrees, adjust the level.
1037 With this setting, `org-paste-subtree' is used to insert the subtree, see
1038 this function for details."
1043 "Non-nil means M-RET will split the line at the cursor position.
1044 When nil, it will go to the end of the line before making a
1045 new line.
1046 You may also set this option in a different way for different
1047 contexts. Valid contexts are:
1049 headline when creating a new headline
1050 item when creating a new item
1051 table in a table field
1052 default the value to be used for all contexts not explicitly
1053 customized"
1070 "Non-nil means insert new headings after the current subtree.
1071 When nil, the new heading is created directly after the current line.
1074 for the duration of the command."
1080 "Should `org-insert-heading' leave a blank line before new heading/item?
1081 The value is an alist, with `heading' and `plain-list-item' as car,
1082 and a boolean flag as cdr. The cdr may lso be the symbol `auto', and then
1083 Org will look at the surrounding headings/items and try to make an
1084 intelligent decision wether to insert a blank line or not.
1086 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1087 set, the setting here is ignored and no empty line is inserted, to avoid
1088 breaking the list structure."
1101 "Hook being run after inserting a new heading."
1107 This currently only means they are never auto-wrapped.
1108 When nil, such lines will be treated like ordinary lines.
1109 See also the QUOTE keyword."
1114 "Non-nil means typing characters in `org-goto' starts incremental search."
1119 "Options concerning sparse trees in Org-mode."
1124 "Non-nil means highlight all matches that define a sparse tree.
1125 The highlights will automatically disappear the next time the buffer is
1126 changed by an edit command."
1131 "Non-nil means any change to the buffer will remove temporary highlights.
1132 Such highlights are created by `org-occur' and `org-clock-display'.
1133 When nil, `C-c C-c needs to be used to get rid of the highlights.
1134 The highlights created by `org-preview-latex-fragment' always need
1135 `C-c C-c' to be removed."
1142 "Hook that is run after `org-occur' has constructed a sparse tree.
1143 This can be used to recenter the window to show as much of the structure
1144 as possible."
1149 "Options concerning imenu and speedbar in Org-mode."
1154 "The maximum level for Imenu access to Org-mode headlines.
1155 This also applied for speedbar access."
1160 "Options concerning tables in Org-mode."
1166 When nil, such lines will be treated like ordinary lines.
1168 When equal to the symbol `optimized', the table editor will be optimized to
1169 do the following:
1170 - Automatic overwrite mode in front of whitespace in table fields.
1171 This makes the structure of the table stay in tact as long as the edited
1172 field does not exceed the column width.
1173 - Minimize the number of realigns. Normally, the table is aligned each time
1174 TAB or RET are pressed to move to another field. With optimization this
1175 happens only if changes to a field might have changed the column width.
1176 Optimization requires replacing the functions `self-insert-command',
1177 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1178 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1179 very good at guessing when a re-align will be necessary, but you can always
1182 If you would like to use the optimized version in Org-mode, but the
1183 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1185 This variable can be used to turn on and off the table editor during a session,
1186 but in order to toggle optimization, a restart is required.
1188 See also the variable `org-table-auto-blank-field'."
1196 "Non-nil means cluster self-insert commands for undo when possible.
1197 If this is set, then, like in the Emacs command loop, 20 consecutive
1198 characters will be undone together.
1199 This is configurable, because there is some impact on typing performance."
1204 "Non-nil means TAB will automatically notice a table.el table.
1205 When it sees such a table, it moves point into it and - if necessary -
1206 calls `table-recognize-table'."
1211 "Options concerning links in Org-mode."
1216 "Buffer-local version of `org-link-abbrev-alist', which see.
1221 "Alist of link abbreviations.
1222 The car of each element is a string, to be replaced at the start of a link.
1224 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1226 [[linkkey:tag][description]]
1228 The 'linkkey' must be a word word, starting with a letter, followed
1229 by letters, numbers, '-' or '_'.
1231 If REPLACE is a string, the tag will simply be appended to create the link.
1234 be inserted at that point (see the function `url-hexify-string').
1236 REPLACE may also be a function that will be called with the tag as the
1237 only argument to create the link, which should be returned as a string.
1239 See the manual for examples."
1249 "Non-nil means hide link part and only show description of bracket links.
1250 Bracket links are like [[link][description]]. This variable sets the initial
1251 state in new org-mode buffers. The setting can then be toggled on a
1252 per-buffer basis from the Org->Hyperlinks menu."
1257 "How the path name in file links should be stored.
1258 Valid values are:
1260 relative Relative to the current directory, i.e. the directory of the file
1261 into which the link is being inserted.
1262 absolute Absolute path, if possible with ~ for home directory.
1263 noabbrev Absolute path, no abbreviation of home directory.
1264 adaptive Use relative path for files in the current directory and sub-
1265 directories of it. For other files, use an absolute path."
1274 "Types of links that should be activated in Org-mode files.
1275 This is a list of symbols, each leading to the activation of a certain link
1276 type. In principle, it does not hurt to turn on most link types - there may
1277 be a small gain when turning off unused link types. The types are:
1279 bracket The recommended [[link][description]] or [[link]] links with hiding.
1280 angle Links in angular brackets that may contain whitespace like
1281 <bbdb:Carsten Dominik>.
1282 plain Plain links in normal text, no whitespace, like http://google.com.
1283 radio Text that is matched by a radio target, see manual for details.
1284 tag Tag settings in a headline (link to tag search).
1285 date Time stamps (link to calendar).
1286 footnote Footnote labels.
1288 Changing this variable requires a restart of Emacs to become effective."
1300 "Function to use to generate link descriptions from links.
1301 If nil the link location will be used. This function must take
1302 two parameters; the first is the link and the second the
1303 description `org-insert-link' has generated, and should return the
1304 description to use."
1309 "Options concerning storing links in Org-mode."
1314 "Format of the description part of a link to an email or usenet message.
1315 The following %-escapes will be replaced by corresponding information:
1323 %s subject
1324 %d date
1325 %m message-id.
1327 You may use normal field width specification between the % and the letter.
1328 This is for example useful to limit the length of the subject.
1342 It should match if the message is from the user him/herself."
1347 "Non-nil means storing a link to an Org file will use entry IDs.
1349 Note that before this variable is even considered, org-id must be loaded,
1350 so please customize `org-modules' and turn it on.
1352 The variable can have the following values:
1354 t Create an ID if needed to make a link to the current entry.
1356 create-if-interactive
1357 If `org-store-link' is called directly (interactively, as a user
1358 command), do create an ID to support the link. But when doing the
1359 job for remember, only use the ID if it already exists. The
1360 purpose of this setting is to avoid proliferation of unwanted
1361 IDs, just because you happen to be in an Org file when you
1362 call `org-remember' that automatically and preemptively
1363 creates a link. If you do want to get an ID link in a remember
1364 template to an entry not having an ID, create it first by
1365 explicitly creating a link to it, using `C-c C-l' first.
1367 create-if-interactive-and-no-custom-id
1368 Like create-if-interactive, but do not create an ID if there is
1369 a CUSTOM_ID property defined in the entry. This is the default.
1371 use-existing
1372 Use existing ID, do not create one.
1374 nil Never use an ID to make a link, instead link using a text search for
1375 the headline text."
1380 create-if-interactive)
1382 create-if-interactive-and-no-custom-id)
1387 "Non-nil means file links from `org-store-link' contain context.
1388 A search string will be added to the file name with :: as separator and
1389 used to find the context when the link is activated by the command
1390 `org-open-at-point'. When this option is t, the entire active region
1391 will be placed in the search string of the file link. If set to a
1392 positive integer, only the first n lines of context will be stored.
1395 negates this setting for the duration of the command."
1400 "Non-nil means keep link in list for entire session.
1402 The command `org-store-link' adds a link pointing to the current
1403 location to an internal list. These links accumulate during a session.
1404 The command `org-insert-link' can be used to insert links into any
1405 Org-mode file (offering completion for all stored links). When this
1407 will be removed from the list, to make completing the unused links
1408 more efficient."
1413 "Options concerning following links in Org-mode."
1418 "Function to translate links with different syntax to Org syntax.
1419 This can be used to translate links created for example by the Planner
1420 or emacs-wiki packages to Org syntax.
1421 The function must accept two parameters, a TYPE containing the link
1423 which is everything after the link protocol. It should return a cons
1424 with possibly modified values of type and path.
1425 Org contains a function for this, so if you set this variable to
1426 `org-translate-link-from-planner', you should be able follow many
1427 links created by planner."
1432 "Hook that is run after a link has been followed."
1437 "Non-nil means on links TAB will follow the link.
1438 Needs to be set before org.el is loaded.
1439 This really should not be used, it does not make sense, and the
1440 implementation is bad."
1445 "Non-nil means on links RET will follow the link."
1451 "Non-nil means mouse-1 on a link will follow the link.
1452 A longer mouse click will still set point. Does not work on XEmacs.
1453 Needs to be set before org.el is loaded."
1458 "Number of different positions to be recorded in the ring.
1459 Changing this requires a restart of Emacs to work correctly."
1464 "Non-nil means internal links in Org files must exactly match a headline.
1465 When nil, the link search tries to match a phrase will all words
1466 in the search text."
1472 query-to-create)))
1479 "Setup the frame configuration for following links.
1480 When following a link with Emacs, it may often be useful to display
1481 this link in another window or frame. This variable can be used to
1482 set this up for the different types of links.
1483 For VM, use any of
1484 `vm-visit-folder'
1485 `vm-visit-folder-other-window'
1486 `vm-visit-folder-other-frame'
1487 For Gnus, use any of
1488 `gnus'
1489 `gnus-other-frame'
1490 `org-gnus-no-new-news'
1491 For FILE, use any of
1492 `find-file'
1493 `find-file-other-window'
1494 `find-file-other-frame'
1495 For Wanderlust use any of
1496 `wl'
1497 `wl-other-frame'
1498 For the calendar, use the variable `calendar-setup'.
1499 For BBDB, it is currently only possible to display the matches in
1500 another window."
1524 "Non-nil means use indirect buffer to display infile links.
1525 Activating internal links (from one location in a file to another location
1526 in the same file) normally just jumps to the location. When the link is
1528 is displayed in
1529 another window. When this option is set, the other window actually displays
1530 an indirect buffer clone of the current buffer, to avoid any visibility
1531 changes to the current buffer."
1536 "Non-nil means `org-open-file' will open non-existing files.
1537 When nil, an error will be generated.
1538 This variable applies only to external applications because they
1539 might choke on non-existing files. If the link is to a file that
1540 will be opened in Emacs, the variable is ignored."
1545 "Non-nil means a link to a directory really means to index.org.
1546 When nil, following a directory link will run dired or open a finder/explorer
1547 window on that directory."
1552 "Function and arguments to call for following mailto links.
1553 This is a list with the first element being a Lisp function, and the
1554 remaining elements being arguments to the function. In string arguments,
1555 %a will be replaced by the address, and %s will be replaced by the subject
1556 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1565 "Non-nil means ask for confirmation before executing shell links.
1566 Shell links can be dangerous: just think about a link
1568 [[shell:rm -rf ~/*][Google Search]]
1571 but really it would remove your entire home directory.
1572 Therefore we advise against setting this variable to nil.
1573 Just change it to `y-or-n-p' if you want to confirm with a
1581 'safe-local-variable
1585 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1586 Elisp links can be dangerous: just think about a link
1591 but really it would remove your entire home directory.
1592 Therefore we advise against setting this variable to nil.
1593 Just change it to `y-or-n-p' if you want to confirm with a
1601 'safe-local-variable
1608 "Default file applications on a UNIX or GNU/Linux system.
1619 "Default file applications on a MacOS X system.
1621 for some files for which the OS does not have a good default.
1629 'mswindows-shell-execute
1634 'mswindows-shell-execute
1637 "Default file applications on a Windows NT system.
1642 '(
1647 )
1648 "External applications for opening `file:path' items in a document.
1649 Org-mode uses system defaults for different file types, but
1650 you can use this variable to set the application for a given file
1651 extension. The entries in this list are cons cells where the car identifies
1652 files and the cdr the corresponding command. Possible values for the
1653 file identifier are
1655 ways, depending on its contents:
1657 - Alphanumeric characters only:
1658 Match links with this file extension.
1660 to open PDFs with evince.
1662 - Regular expression: Match links where the
1663 filename matches the regexp. If you want to
1664 use groups here, use shy groups.
1668 to open *.html and *.xhtml with firefox.
1670 - Regular expression which contains (non-shy) groups:
1672 anything after that, matches the regexp.
1673 In a custom command string, %1, %2, etc. are replaced with
1674 the parts of the link that were matched by the groups.
1675 For backwards compatibility, if a command string is given
1676 that does not use any of the group matches, this case is
1677 handled identically to the second one (i.e. match against
1678 file name only).
1679 In a custom lisp form, you can access the group matches with
1680 (match-string n link).
1683 to open [[file:document.pdf::5]] with evince at page 5.
1685 `directory' Matches a directory
1686 `remote' Matches a remote file, accessible through tramp or efs.
1687 Remote files most likely should be visited through Emacs
1688 because external applications cannot handle such paths.
1689 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1690 so all files Emacs knows how to handle. Using this with
1691 command `emacs' will open most files in Emacs. Beware that this
1692 will also open html files inside Emacs, unless you add
1694 t Default for files not matched by any of the other options.
1695 `system' The system command to open files, like `open' on Windows
1696 and Mac OS X, and mailcap under GNU/Linux. This is the command
1697 that will be selected if you call `C-c C-o' with a double
1700 Possible values for the command are:
1701 `emacs' The file will be visited by the current Emacs process.
1702 `default' Use the default application for this file type, which is the
1703 association for t in the list, most likely in the system-specific
1704 part.
1705 This can be used to overrule an unwanted setting in the
1706 system-specific variable.
1708 This command is specified by the entry whose car is `system'.
1709 Most likely, the system-specific version of this variable
1710 does define this command, but you can overrule/replace it
1711 here.
1712 string A command to be executed by a shell; %s will be replaced
1713 by the path to the file.
1714 sexp A Lisp form which will be evaluated. The file path will
1715 be available in the Lisp variable `file'.
1716 For more examples, see the system specific constants
1717 `org-file-apps-defaults-macosx'
1718 `org-file-apps-defaults-windowsnt'
1719 `org-file-apps-defaults-gnu'."
1729 auto-mode))
1740 "Options concerning refiling entries in Org-mode."
1745 "Directory with org files.
1746 This is just a default location to look for Org files. There is no need
1747 at all to put your files into this directory. It is only used in the
1748 following situations:
1750 1. When a remember template specifies a target file that is not an
1751 absolute path. The path will then be interpreted relative to
1752 `org-directory'
1753 2. When a remember note is filed away in an interactive way (when exiting the
1754 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1755 with `org-directory' as the default path."
1761 "Default target for storing notes.
1762 Used as a fall back file for org-remember.el and org-capture.el, for
1763 templates that do not specify a target file."
1768 file))
1771 "The default interface to be used for `org-goto'.
1772 Allowed values are:
1773 outline The interface shows an outline of the relevant file
1774 and the correct heading is found by moving through
1775 the outline or by searching with incremental search.
1776 outline-path-completion Headlines in the current buffer are offered via
1777 completion. This is the interface also used by
1778 the refile command."
1785 "Maximum target level when running `org-goto' with refile interface."
1790 "Non-nil means store new notes at the beginning of a file or entry.
1791 When nil, new notes will be filed to the end of a file or entry.
1792 This can also be a list with cons cells of regular expressions that
1793 are matched against file names, and values."
1803 "Information to record when a task is refiled.
1805 Possible values are:
1807 nil Don't add anything
1808 time Add a time stamp to the task
1809 note Prompt for a note and add it with template `org-log-note-headings'
1811 This option can also be set with on a per-file-basis with
1813 #+STARTUP: nologrefile
1814 #+STARTUP: logrefile
1815 #+STARTUP: lognoterefile
1817 You can have local logging settings for a subtree by setting the LOGGING
1818 property to one or more of these keywords.
1820 When bulk-refiling from the agenda, the value `note' is forbidden and
1821 will temporarily be changed to `time'."
1831 This is list of cons cells. Each cell contains:
1832 - a specification of the files to be considered, either a list of files,
1833 or a symbol whose function or variable value will be used to retrieve
1834 a file name or a list of file names. If you use `org-agenda-files' for
1835 that, all agenda files will be scanned for targets. Nil means consider
1836 headings in the current buffer.
1837 - A specification of how to find candidate refile targets. This may be
1838 any of:
1840 This tag has to be present in all target headlines, inheritance will
1841 not be considered.
1843 todo keyword.
1845 headlines that are refiling targets.
1846 - a cons cell (:level . N). Any headline of level N is considered a target.
1847 Note that, when `org-odd-levels-only' is set, level corresponds to
1848 order in hierarchy, not to the number of stars.
1849 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1850 Note that, when `org-odd-levels-only' is set, level corresponds to
1851 order in hierarchy, not to the number of stars.
1853 You can set the variable `org-refile-target-verify-function' to a function
1854 to verify each headline found by the simple criteria above.
1856 When this variable is nil, all top-level headlines in the current buffer
1857 are used, equivalent to the value `((nil . (:level . 1))'."
1873 "Function to verify if the headline at point should be a refile target.
1874 The function will be called without arguments, with point at the
1875 beginning of the headline. It should return t and leave point
1876 where it is if the headline is a valid target for refiling.
1878 If the target should not be selected, the function must return nil.
1879 In addition to this, it may move point to a place from where the search
1880 should be continued. For example, the function may decide that the entire
1881 subtree of the current entry should be excluded and move point to the end
1882 of the subtree."
1887 "Non-nil means cache refile targets to speed up the process.
1888 The cache for a particular file will be updated automatically when
1889 the buffer has been killed, or when any of the marker used for flagging
1890 refile targets no longer points at a live buffer.
1891 If you have added new entries to a buffer that might themselves be targets,
1892 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1893 find that easier, `C-u C-u C-u C-c C-w'."
1898 "Non-nil means provide refile targets as paths.
1899 So a level 3 headline will be available as level1/level2/level3.
1901 When the value is `file', also include the file name (without directory)
1902 into the path. In this case, you can also stop the completion after
1903 the file name, to get entries inserted as top level in the file.
1905 When `full-file-path', include the full file path."
1914 "Non-nil means complete the outline path in hierarchical steps.
1915 When Org-mode uses the refile interface to select an outline path
1916 \(see variable `org-refile-use-outline-path'), the completion of
1917 the path can be done is a single go, or if can be done in steps down
1918 the headline hierarchy. Going in steps is probably the best if you
1919 do not use a special completion package like `ido' or `icicles'.
1920 However, when using these packages, going in one step can be very
1921 fast, while still showing the whole path to the entry."
1926 "Non-nil means allow to create new nodes as refile targets.
1928 of an existing node. When the value of this variable is `confirm',
1929 new node creation must be confirmed by the user (recommended)
1930 When nil, the completion must match an existing entry.
1932 Note that, if the new heading is not seen by the criteria
1933 listed in `org-refile-targets', multiple instances of the same
1934 heading would be created by trying again to file under the new
1935 heading."
1943 "Options concerning TODO items in Org-mode."
1948 "Options concerning Progress logging in Org-mode."
1953 '(
1956 "The available interpretation symbols for customizing `org-todo-keywords'.
1960 "List of TODO entry keyword sequences and their interpretation.
1963 Each sequence starts with a symbol, either `sequence' or `type',
1964 indicating if the keywords should be interpreted as a sequence of
1965 action steps, or as different types of TODO items. The first
1966 keywords are states requiring action - these states will select a headline
1967 for inclusion into the global TODO list Org-mode produces. If one of
1970 the last keyword is treated as the only DONE state of the sequence.
1973 additional state where no keyword is present. For details about this
1974 cycling, see the manual.
1976 TODO keywords and interpretation can also be set on a per-file basis with
1977 the special #+SEQ_TODO and #+TYP_TODO lines.
1979 Each keyword can optionally specify a character for fast state selection
1980 \(in combination with the variable `org-use-fast-todo-selection')
1981 and specifiers for state change logging, using the same syntax
1984 indicates to record a time stamp each time this state is selected.
1986 Each keyword may also specify if a timestamp or a note should be
1987 recorded when entering or leaving the state, by adding additional
1988 characters in the parenthesis after the keyword. This looks like this:
1990 record only the time of the state change. With X and Y being either
1992 Y when leaving the state if and only if the *target* state does not
1993 define X. You may omit any of the fast-selection key or X or /Y,
1994 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1996 For backward compatibility, this variable may also be just a list
1997 of keywords - in this case the interpretation (sequence or type) will be
1998 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2008 ;;Quick and dirty way to see
2009 ;;`org-todo-interpretations'. This takes the
2010 ;;place of item arguments
2011 :convert-widget
2018 org-todo-interpretation-widgets))
2019 widget))
2050 "Controls how TODO keywords are interpreted.
2051 This variable is in principle obsolete and is only used for
2052 backward compatibility, if the interpretation of todo keywords is
2053 not given already in `org-todo-keywords'. See that variable for
2054 more information."
2061 "Non-nil means use the fast todo selection scheme with C-c C-t.
2062 This variable describes if and under what circumstances the cycling
2063 mechanism for TODO keywords will be replaced by a single-key, direct
2064 selection scheme.
2066 When nil, fast selection is never used.
2068 When the symbol `prefix', it will be used when `org-todo' is called with
2069 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2070 in an agenda buffer.
2072 When t, fast selection is used by default. In this case, the prefix
2073 argument forces cycling instead.
2075 In all cases, the special interface is only used if access keys have actually
2076 been assigned by the user, i.e. if keywords in the configuration are followed
2077 by a letter in parenthesis, like TODO(t)."
2085 "Non-nil means update todo statistics after insert and toggle.
2086 ALL-HEADLINES means update todo statistics by including headlines
2087 with no TODO keyword as well, counting them as not done.
2088 A list of TODO keywords means the same, but skip keywords that are
2089 not in this list.
2091 When this is set, todo statistics is updated in the parent of the
2092 current entry each time a todo state is changed."
2102 "Non-nil means TODO statistics covers just direct children.
2103 When nil, all entries in the subtree are considered.
2104 This has only an effect if `org-provide-todo-statistics' is set.
2105 To set this to nil for only a single subtree, use a COOKIE_DATA
2111 "Hook which is run after the state of a TODO item was changed.
2112 The new state (a string with a TODO keyword, or nil) is available in the
2113 Lisp variable `state'."
2118 "Hook for functions that are allowed to block a state change.
2120 Each function gets as its single argument a property list, see
2121 `org-trigger-hook' for more information about this list.
2123 If any of the functions in this hook returns nil, the state change
2127 "Hook for functions that are triggered by a state change.
2129 Each function gets as its single argument a property list with at least
2130 the following elements:
2132 (:type type-of-change :position pos-at-entry-start
2133 :from old-state :to new-state)
2135 Depending on the type, more properties may be present.
2137 This mechanism is currently implemented for:
2139 TODO state changes
2140 ------------------
2141 :type todo-state-change
2142 :from previous state (keyword as a string), or nil, or a symbol
2143 'todo' or 'done', to indicate the general type of state.
2147 "Non-nil means undone TODO entries will block switching the parent to DONE.
2148 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2149 be blocked if any prior sibling is not yet done.
2150 Finally, if the parent is blocked because of ordered siblings of its own,
2151 the child will also be blocked.
2152 This variable needs to be set before org.el is loaded, and you need to
2153 restart Emacs after a change to make the change effective. The only way
2154 to change is while Emacs is running is through the customize interface."
2166 "Non-nil means unchecked boxes will block switching the parent to DONE.
2167 When this is nil, checkboxes have no influence on switching TODO states.
2168 When non-nil, you first need to check off all check boxes before the TODO
2169 entry can be switched to DONE.
2170 This variable needs to be set before org.el is loaded, and you need to
2171 restart Emacs after a change to make the change effective. The only way
2172 to change is while Emacs is running is through the customize interface."
2184 "Non-nil means inserting a TODO heading is treated as state change.
2186 logging will apply if appropriate. When nil, the new TODO item will
2187 be inserted directly, and no logging will take place."
2192 "Non-nil means switching TODO states with S-cursor counts as state change.
2193 This is the default behavior. However, setting this to nil allows a
2194 convenient way to select a TODO state and bypass any logging associated
2195 with that."
2200 "Tag changes that should be triggered by TODO state changes.
2201 This is a list. Each entry is
2203 (state-change (tag . flag) .......)
2205 State-change can be a string with a state, and empty string to indicate the
2206 state that has no TODO keyword, or it can be one of the symbols `todo'
2207 or `done', meaning any not-done or done state, respectively."
2221 "Information to record when a task moves to the DONE state.
2223 Possible values are:
2225 nil Don't add anything, just change the keyword
2226 time Add a time stamp to the task
2227 note Prompt for a note and add it with template `org-log-note-headings'
2229 This option can also be set with on a per-file-basis with
2231 #+STARTUP: nologdone
2232 #+STARTUP: logdone
2233 #+STARTUP: lognotedone
2235 You can have local logging settings for a subtree by setting the LOGGING
2236 property to one or more of these keywords."
2244 ;; Normalize old uses of org-log-done.
2251 "Information to record when the scheduling date of a tasks is modified.
2253 Possible values are:
2255 nil Don't add anything, just change the date
2256 time Add a time stamp to the task
2257 note Prompt for a note and add it with template `org-log-note-headings'
2259 This option can also be set with on a per-file-basis with
2261 #+STARTUP: nologreschedule
2262 #+STARTUP: logreschedule
2263 #+STARTUP: lognotereschedule"
2272 "Information to record when the deadline date of a tasks is modified.
2274 Possible values are:
2276 nil Don't add anything, just change the date
2277 time Add a time stamp to the task
2278 note Prompt for a note and add it with template `org-log-note-headings'
2280 This option can also be set with on a per-file-basis with
2282 #+STARTUP: nologredeadline
2283 #+STARTUP: logredeadline
2284 #+STARTUP: lognoteredeadline
2286 You can have local logging settings for a subtree by setting the LOGGING
2287 property to one or more of these keywords."
2296 "Non-nil means record a note when clocking out of an item.
2297 This can also be configured on a per-file basis by adding one of
2298 the following lines anywhere in the buffer:
2300 #+STARTUP: lognoteclock-out
2301 #+STARTUP: nolognoteclock-out"
2307 "Non-nil means the CLOSED time stamp will contain date and time.
2308 When nil, only the date will be recorded."
2322 "Headings for notes added to entries.
2323 The value is an alist, with the car being a symbol indicating the note
2324 context, and the cdr is the heading to be used. The heading may also be the
2325 empty string.
2326 %t in the heading will be replaced by a time stamp.
2327 %T will be an active time stamp instead the default inactive one
2328 %s will be replaced by the new TODO state, in double quotes.
2329 %S will be replaced by the old TODO state, in double quotes.
2330 %u will be replaced by the user name.
2331 %U will be replaced by the full user name.
2333 In fact, it is not a good idea to change the `state' entry, because
2334 agenda log mode depends on the format of these entries."
2340 "Heading when changing todo state (todo sequence only)"
2354 "Non-nil means insert state change notes and time stamps into a drawer.
2355 When nil, state changes notes will be inserted after the headline and
2356 any scheduling and clock lines, but not inside a drawer.
2358 The value of this variable should be the name of the drawer to use.
2359 LOGBOOK is proposed at the default drawer for this purpose, you can
2360 also set this to a string to define the drawer of your choice.
2364 If this variable is set, `org-log-state-notes-insert-after-drawers'
2365 will be ignored.
2367 You can set the property LOG_INTO_DRAWER to overrule this setting for
2368 a subtree."
2380 "Return the value of `org-log-into-drawer', but let properties overrule.
2381 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2382 used instead of the default value."
2390 "Non-nil means insert state change notes after any drawers in entry.
2391 Only the drawers that *immediately* follow the headline and the
2392 deadline/scheduled line are skipped.
2393 When nil, insert notes right after the heading and perhaps the line
2394 with deadline/scheduling if present.
2396 This variable will have no effect if `org-log-into-drawer' is
2397 set."
2403 "Non-nil means the latest state note will be directly after heading.
2404 When nil, the state change notes will be ordered according to time."
2410 "The TODO state to which a repeater should return the repeating task.
2411 By default this is the first task in a TODO sequence, or the previous state
2412 in a TODO_TYP set. But you can specify another task here.
2413 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2419 "Non-nil means record moving through the DONE state when triggering repeat.
2420 An auto-repeating task is immediately switched back to TODO when
2423 record a closing note, there will be no record of the task moving
2424 through DONE. This variable forces taking a note anyway.
2426 nil Don't force a record
2427 time Record a time stamp
2428 note Record a note
2430 This option can also be set with on a per-file-basis with
2432 #+STARTUP: logrepeat
2433 #+STARTUP: lognoterepeat
2434 #+STARTUP: nologrepeat
2436 You can have local logging settings for a subtree by setting the LOGGING
2437 property to one or more of these keywords."
2447 "Priorities in Org-mode."
2452 "Non-nil means priority commands are active.
2453 When nil, these commands will be disabled, so that you never accidentally
2454 set a priority."
2459 "The highest priority of TODO items. A character like ?A, ?B etc.
2460 Must have a smaller ASCII number than `org-lowest-priority'."
2465 "The lowest priority of TODO items. A character like ?A, ?B etc.
2466 Must have a larger ASCII number than `org-highest-priority'."
2471 "The default priority of TODO items.
2472 This is the priority an item get if no explicit priority is given."
2477 "Non-nil means start with default priority when starting to cycle.
2478 When this is nil, the first step in the cycle will be (depending on the
2479 command used) one higher or lower that the default priority."
2484 "Function to extract the priority from a string.
2485 The string is normally the headline. If this is nil Org computes the
2486 priority from the priority cookie like [#A] in the headline. It returns
2487 an integer, increasing by 1000 for each priority level.
2488 The user can set a different function here, which should take a string
2489 as an argument and return the numeric priority."
2494 "Options concerning time stamps and deadlines in Org-mode."
2499 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2500 When nil, these labeled time stamps are forces into the second line of an
2501 entry, just after the headline. When scheduling from the global TODO list,
2502 the time stamp will always be forced into the second line."
2507 "Formats for `format-time-string' which are used for time stamps.
2511 "Number of minutes to round time stamps to.
2512 These are two values, the first applies when first creating a time stamp.
2513 The second applies when changing it with the commands `S-up' and `S-down'.
2514 When changing the time stamp, this means that it will change in steps
2515 of N minutes, as given by the second value.
2517 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2518 numbers should be factors of 60, so for example 5, 10, 15.
2520 When this is larger than 1, you can still force an exact time stamp by using
2521 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2522 and by using a prefix arg to `S-up/down' to specify the exact number
2523 of minutes to shift."
2533 ;; Normalize old customizations of this variable.
2537 org-time-stamp-rounding-minutes)))
2540 "Non-nil means overlay custom formats over all time stamps.
2541 The formats are defined through the variable `org-time-stamp-custom-formats'.
2542 To turn this on on a per-file basis, insert anywhere in the file:
2543 #+STARTUP: customtime"
2551 "Custom formats for time stamps. See `format-time-string' for the syntax.
2552 These are overlayed over the default ISO format if the variable
2553 `org-display-custom-times' is set. Time like %H:%M should be at the
2554 end of the second format. The custom formats are also honored by export
2555 commands, if custom time display is turned on at the time of export."
2560 "Get the right format for a time string."
2565 f)))
2568 "The format string used when creating CLOCKSUM lines.
2569 This is also used when org-mode generates a time duration."
2575 org-mode generates a time duration."
2580 "The format string used when creating CLOCKSUM lines, or when
2581 org-mode generates a time duration."
2586 "No. of days before expiration during which a deadline becomes active.
2587 This variable governs the display in sparse trees and in the agenda.
2588 When 0 or negative, it means use this number (the absolute value of it)
2589 even if a deadline has a different individual lead time specified.
2591 Custom commands can set this variable in the options section."
2597 "Non-nil means assume future for incomplete date input from user.
2598 This affects the following situations:
2599 1. The user gives a month but not a year.
2602 2. The user gives a day, but no month.
2605 it will be considered as *this* month.
2607 If you set this variable to the symbol `time', then also the following
2608 will work:
2610 3. If the user gives a time, but no day. If the time is before now,
2611 to will be interpreted as tomorrow.
2613 Currently none of this works for ISO week specifications.
2615 When this option is nil, the current day, month and year will always be
2616 used as defaults.
2618 See also `org-agenda-jump-prefer-future'."
2626 "Should the agenda jump command prefer the future for incomplete dates?
2627 The default is to do the same as configured in `org-read-date-prefer-future'.
2628 But you can alse set a deviating value here.
2629 This may t or nil, or the symbol `org-read-date-prefer-future'."
2634 org-read-date-prefer-future)
2639 "Non-nil means display current interpretation of date prompt live.
2640 This display will be in an overlay, in the minibuffer."
2645 "Non-nil means pop up a calendar when prompting for a date.
2646 In the calendar, the date can be selected with mouse-1. However, the
2647 minibuffer will also be active, and you can simply enter the date as well.
2648 When nil, only the minibuffer will be available."
2656 "Hook to be used to set up keys for the date/time interface.
2657 Add key definitions to `minibuffer-local-map', which will be a temporary
2658 copy."
2663 "The hour when your day really ends. Must be an integer.
2664 This has influence for the following applications:
2666 the time given here, the day recognized as TODAY is actually yesterday.
2667 - When a date is read from the user and it is still before the time given
2668 here, the current date and time will be assumed to be yesterday, 23:59.
2669 Also, timestamps inserted in remember templates follow this rule.
2671 IMPORTANT: This is a feature whose implementation is and likely will
2672 remain incomplete. Really, it is only here because past midnight seems to
2673 be the favorite working time of John Wiegley :-)"
2678 "Non-nil means S-down will increase the time in a time stamp.
2679 When nil, S-up will increase."
2684 "Non-nil means make the calendar window follow timestamp changes.
2685 When a timestamp is modified and the calendar window is visible, it will be
2686 moved to the new date."
2691 "Options concerning tags in Org-mode."
2696 "List of tags allowed in Org-mode files.
2697 When this list is nil, Org-mode will base TAG input on what is already in the
2698 buffer.
2699 The value of this variable is an alist, the car of each entry must be a
2700 keyword as a string, the cdr may be a character that is used to select
2701 that tag through the fast-tag-selection interface.
2702 See the manual for details."
2717 "List of tags that will always appear in all Org-mode files.
2718 This is in addition to any in buffer settings or customizations
2719 of `org-tag-alist'.
2720 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2721 The value of this variable is an alist, the car of each entry must be a
2722 keyword as a string, the cdr may be a character that is used to select
2723 that tag through the fast-tag-selection interface.
2724 See the manual for details.
2725 To disable these tags on a per-file basis, insert anywhere in the file:
2726 #+STARTUP: noptag"
2737 "If non-nil, always offer completion for all tags of all agenda files.
2738 Instead of customizing this variable directly, you might want to
2739 set it locally for capture buffers, because there no list of
2740 tags in that file can be created dynamically (there are none).
2742 (add-hook 'org-capture-mode-hook
2743 (lambda ()
2744 (set (make-local-variable
2745 'org-complete-tags-always-offer-all-agenda-tags)
2746 t)))"
2751 "List of tags that can be inherited by all entries in the file.
2752 The tags will be inherited if the variable `org-use-tag-inheritance'
2753 says they should be.
2757 "Non-nil means use fast tag selection scheme.
2758 This is a special interface to select and deselect tags with single keys.
2759 When nil, fast selection is never used.
2760 When the symbol `auto', fast selection is used if and only if selection
2761 characters for tags have been configured, either through the variable
2762 `org-tag-alist' or through a #+TAGS line in the buffer.
2763 When t, fast selection is always used and selection keys are assigned
2764 automatically if necessary."
2772 "Non-nil means fast tag selection exits after first change.
2773 When nil, you have to press RET to exit it.
2774 During fast tag selection, you can toggle this flag with `C-c'.
2775 This variable can also have the value `expert'. In this case, the window
2776 displaying the tags menu is not even shown, until you press C-c again."
2784 "Non-nil means fast tags selection interface will also offer TODO states.
2788 "The column to which tags should be indented in a headline.
2789 If this number is positive, it specifies the column. If it is negative,
2790 it means that the tags should be flushright to that column. For example,
2791 -80 works well for a normal 80 character screen."
2796 "Non-nil means realign tags after pro/demotion of TODO state change.
2797 These operations change the length of a headline and therefore shift
2798 the tags around. With this options turned on, after each such operation
2799 the tags are again aligned to `org-tags-column'."
2804 "Non-nil means tags in levels apply also for sublevels.
2805 When nil, only the tags directly given in a specific line apply there.
2806 This may also be a list of tags that should be inherited, or a regexp that
2807 matches tags that should be inherited. Additional control is possible
2808 with the variable `org-tags-exclude-from-inheritance' which gives an
2809 explicit list of tags to be excluded from inheritance., even if the value of
2810 `org-use-tag-inheritance' would select it for inheritance.
2812 If this option is t, a match early-on in a tree can lead to a large
2813 number of matches in the subtree when constructing the agenda or creating
2814 a sparse tree. If you only want to see the first match in a tree during
2815 a search, check out the variable `org-tags-match-list-sublevels'."
2824 "List of tags that should never be inherited.
2825 This is a way to exclude a few tags from inheritance. For way to do
2826 the opposite, to actively allow inheritance for selected tags,
2827 see the variable `org-use-tag-inheritance'."
2832 "Check if TAG is one that should be inherited."
2844 "Non-nil means list also sublevels of headlines matching a search.
2845 This variable applies to tags/property searches, and also to stuck
2846 projects because this search is based on a tags match as well.
2848 When set to the symbol `indented', sublevels are indented with
2849 leading dots.
2851 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2852 the sublevels of a headline matching a tag search often also match
2853 the same search. Listing all of them can create very long lists.
2854 Setting this variable to nil causes subtrees of a match to be skipped.
2856 This variable is semi-obsolete and probably should always be true. It
2857 is better to limit inheritance to certain tags using the variables
2858 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2866 "When set, tags are sorted using this function as a comparator."
2882 "Options concerning properties in Org-mode."
2887 "How property key/value pairs should be formatted by `indent-line'.
2888 When `indent-line' hits a property definition, it will format the line
2889 according to this format, mainly to make sure that the values are
2890 lined-up with respect to each other."
2895 "Non-nil means properties apply also for sublevels.
2897 This setting is chiefly used during property searches. Turning it on can
2898 cause significant overhead when doing a search, which is why it is not
2899 on by default.
2901 When nil, only the properties directly given in the current entry count.
2902 When t, every property is inherited. The value may also be a list of
2903 properties that should have inheritance, or a regular expression matching
2904 properties that should be inherited.
2906 However, note that some special properties use inheritance under special
2907 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2909 for valid values of a property.
2911 Note for programmers:
2912 When querying an entry with `org-entry-get', you can control if inheritance
2913 should be used. By default, `org-entry-get' looks only at the local
2914 properties. You can request inheritance by setting the inherit argument
2915 to t (to force inheritance) or to `selective' (to respect the setting
2916 in this variable)."
2925 "Check if PROPERTY is one that should be inherited."
2936 "The default column format, if no other format has been defined.
2937 This variable can be set on the per-file basis by inserting a line
2939 #+COLUMNS: %25ITEM ....."
2944 "The ellipses to be used when a field in column view is truncated.
2945 When this is the empty string, as many characters as possible are shown,
2946 but then there will be no visual indication that the field has been truncated.
2947 When this is a string of length N, the last N characters of a truncated
2948 field are replaced by this string. If the column is narrower than the
2949 ellipses string, only part of the ellipses string will be shown."
2954 "Function that modifies values for display in column view.
2955 For example, it can be used to cut out a certain part from a time stamp.
2956 The function must take 2 arguments:
2958 column-title The title of the column (*not* the property name)
2959 value The value that should be modified.
2961 The function should return the value that should be displayed,
2962 or nil if the normal value should be used."
2967 "The property that is being used to keep track of effort estimates.
2968 Effort estimates given in this property need to have the format H:MM."
2976 "List of property/value pairs that can be inherited by any entry.
2978 These are fixed values, for the preset properties. The user variable
2979 that can be used to add to this list is `org-global-properties'.
2981 The entries in this list are cons cells where the car is a property
2982 name and cdr is a string with the value. If the value represents
2987 "List of property/value pairs that can be inherited by any entry.
2989 This list will be combined with the constant `org-global-properties-fixed'.
2991 The entries in this list are cons cells where the car is a property
2992 name and cdr is a string with the value.
2994 You can set buffer-local values for the same purpose in the variable
2995 `org-file-properties' this by adding lines like
2997 #+PROPERTY: NAME VALUE"
3004 "List of property/value pairs that can be inherited by any entry.
3005 Valid for the current buffer.
3010 "Options concerning agenda views in Org-mode."
3015 "Variable used by org files to set a category for agenda display.
3016 Such files should use a file variable to set it, for example
3020 or contain a special line
3022 #+CATEGORY: ELisp
3024 If the file does not specify a category, then file's base name
3030 "The files to be used for agenda display.
3034 If an entry is a directory, all files in that directory that are matched by
3035 `org-agenda-file-regexp' will be part of the file list.
3037 If the value of the variable is not a list but a single file name, then
3038 the list of agenda files is actually stored and maintained in that file, one
3039 agenda file per line. In this file paths can be given relative to
3040 `org-directory'. Tilde expansion and environment variable substitution
3041 are also made."
3048 "Regular expression to match files for `org-agenda-files'.
3049 If any element in the list in that variable contains a directory instead
3050 of a normal file, all files in that directory that are matched by this
3051 regular expression will be included."
3056 "List of extra files to be searched by text search commands.
3057 These files will be search in addition to the agenda files by the
3058 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3059 Note that these files will only be searched for text search commands,
3060 not for the other agenda views like todo lists, tag searches or the weekly
3061 agenda. This variable is intended to list notes and possibly archive files
3062 that should also be searched by these two commands.
3063 In fact, if the first element in the list is the symbol `agenda-archives',
3064 than all archive files of all agenda files will be added to the search
3065 scope."
3076 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3077 A nil value means to remove them, after a query, from the list."
3082 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3083 The command `org-calendar-goto-agenda' will be bound to this key. The
3084 default is the character `c' because then `c' can be used to switch back and
3085 forth between agenda and calendar."
3090 "The key to be installed in `calendar-mode-map' for agenda-action.
3091 The command `org-agenda-action' will be bound to this key. The
3092 default is the character `k' because we use the same key in the agenda."
3097 "The key to be installed in `calendar-mode-map' for adding diary entries.
3098 This option is irrelevant until `org-agenda-diary-file' has been configured
3099 to point to an Org-mode file. When that is the case, the command
3100 `org-agenda-diary-entry' will be bound to the key given here, by default
3101 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3102 if you want to continue doing this, you need to change this to a different
3103 key."
3108 "File to which to add new entries with the `i' key in agenda and calendar.
3109 When this is the symbol `diary-file', the functionality in the Emacs
3110 calendar will be used to add entries to the `diary-file'. But when this
3111 points to a file, `org-agenda-diary-entry' will be used instead."
3127 org-calendar-insert-diary-entry-key
3131 "Options for embedding LaTeX code into Org-mode."
3139 "Options for creating images from LaTeX fragments.
3140 This is a property list with the following properties:
3142 `default' means use the foreground of the default face.
3144 `default' means use the background of the default face.
3145 :scale a scaling factor for the size of the images, to get more pixels
3146 :html-foreground, :html-background, :html-scale
3147 the same numbers for HTML export.
3148 :matchers a list indicating which matchers should be used to
3149 find LaTeX fragments. Valid members of this list are:
3160 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3161 When nil, just push out a message."
3170 \[PACKAGES]
3171 \[DEFAULT-PACKAGES]
3172 % The settings below are copied from fullpage.sty
3185 "The document header used for processing LaTeX fragments.
3186 It is imperative that this header make sure that no page number
3187 appears on the page. The package defined in the variables
3188 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3190 will be appended."
3197 "Set the packages alist and make sure it has 3 elements per entry."
3201 x))
3202 val)))
3206 "Get the packages alist and make sure it has 3 elements per entry."
3210 x))
3213 ;; The following variables are defined here because is it also used
3214 ;; when formatting latex fragments. Originally it was part of the
3215 ;; LaTeX exporter, which is why the name includes "export".
3232 )
3233 "Alist of default packages to be inserted in the header.
3234 Change this only if one of the packages here causes an incompatibility
3235 with another package you are using.
3236 The packages in this list are needed by one part or another of Org-mode
3237 to function properly.
3239 - inputenc, fontenc: for basic font and character selection
3240 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3241 for interpreting the entities in `org-entities'. You can skip some of these
3242 packages if you don't use any of the symbols in it.
3243 - graphicx: for including images
3244 - float, wrapfig: for figure placement
3245 - longtable: for long tables
3246 - hyperref: for cross references
3248 Therefore you should not modify this variable unless you know what you
3249 are doing. The one reason to change it anyway is that you might be loading
3250 some other package that conflicts with one of the default packages.
3252 If SNIPPET-FLAG is t, the package also needs to be included when
3253 compiling LaTeX snippets into images for inclusion into HTML."
3266 "Alist of packages to be inserted in every LaTeX header.
3267 These will be inserted after `org-export-latex-default-packages-alist'.
3269 SNIPPET-FLAG, when t, indicates that this package is also needed when
3270 turning LaTeX snippets into images for inclusion into HTML.
3271 Make sure that you only list packages here which:
3272 - you want in every file
3273 - do not conflict with the default packages in
3274 `org-export-latex-default-packages-alist'
3275 - do not conflict with the setup in `org-format-latex-header'."
3289 "Settings for Org-mode appearance."
3294 "Non-nil means fontify only the stars in each headline.
3295 When nil, the entire headline is fontified.
3296 Changing it requires restart of `font-lock-mode' to become effective
3297 also in regions already fontified."
3302 "Non-nil means hide the first N-1 stars in a headline.
3303 This works by using the face `org-hide' for these stars. This
3304 face is white for a light background, and black for a dark
3305 background. You may have to customize the face `org-hide' to
3306 make this work.
3307 Changing it requires restart of `font-lock-mode' to become effective
3308 also in regions already fontified.
3309 You may also set this on a per-file basis by adding one of the following
3310 lines to the buffer:
3312 #+STARTUP: hidestars
3313 #+STARTUP: showstars"
3318 "List of keywords that should be hidden when typed in the org buffer.
3319 For example, add #+TITLE to this list in order to make the
3320 document title appear in the buffer without the initial #+TITLE:
3321 keyword."
3329 "Non-nil means change the face of a headline if it is marked DONE.
3330 Normally, only the TODO/DONE keyword indicates the state of a headline.
3331 When this is non-nil, the headline after the keyword is set to the
3332 `org-headline-done' as an additional indication."
3337 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3338 Changing this variable requires a restart of Emacs to take effect."
3343 "Non-nil means fontify the whole line for headings.
3344 This is useful when setting a background color for the
3345 org-level-* faces."
3350 "Non-nil means fontify what is treated specially by the exporters."
3355 "Non-nil mean font-lock should hide the emphasis marker characters."
3360 "Non-nil means show entities as UTF8 characters.
3366 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3371 "Regular expression for matching emphasis.
3372 After a match, the match groups contain these elements:
3373 0 The match of the full regular expression, including the characters
3374 before and after the proper match
3375 1 The character before the proper match, or empty at beginning of line
3376 2 The proper match, including the leading and trailing markers
3377 3 The leading marker like * or /, indicating the type of highlighting
3378 4 The text between the emphasis markers, not including the markers
3385 "Set variable and compute the emphasis regular expression."
3389 org-emphasis-alist org-emphasis-regexp-components)
3401 ;; make sure special characters appear at the right position in the class
3413 ;; Make the regexp
3421 body1
3433 body1
3441 "Components used to build the regular expression for emphasis.
3442 This is a list with five entries. Terminology: In an emphasis string
3446 specify what is allowed/forbidden in each part:
3448 pre Chars allowed as prematch. Beginning of line will be allowed too.
3449 post Chars allowed as postmatch. End of line will be allowed too.
3450 border The chars *forbidden* as border characters.
3452 non-shy groups here, and don't allow newline here.
3453 newline The maximum number of newlines allowed in an emphasis exp.
3455 Use customize to modify this, or restart Emacs after changing it."
3474 )
3475 "Special syntax for emphasized text.
3476 Text starting and ending with a special character will be emphasized, for
3477 example *bold*, _underlined_ and /italic/. This variable sets the marker
3478 characters, the face to be used by font-lock for highlighting in Org-mode
3479 Emacs buffers, and the HTML tags to be used for this.
3480 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3481 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3482 Use customize to modify this, or restart Emacs after changing it."
3497 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3500 ;;; Miscellaneous options
3503 "Completion in Org-mode."
3508 "Non-nil means use ido completion wherever possible.
3509 Note that `ido-mode' must be active for this variable to be relevant.
3510 If you decide to turn this variable on, you might well want to turn off
3511 `org-outline-path-complete-in-steps'.
3512 See also `org-completion-use-iswitchb'."
3517 "Non-nil means use iswitchb completion wherever possible.
3518 Note that `iswitchb-mode' must be active for this variable to be relevant.
3519 If you decide to turn this variable on, you might well want to turn off
3520 `org-outline-path-complete-in-steps'.
3521 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3527 Normal means, no org-mode-specific context."
3531 ;;; Functions and variables from their packages
3532 ;; Declared here to avoid compiler warnings
3534 ;; XEmacs only
3540 ;; Emacs only
3543 ;; Various packages
3561 org-format-agenda-item "org-agenda"
3592 ;;; Autoload and prepare some org modules
3594 ;; Some table stuff that needs to be defined here, because it is used
3595 ;; by the functions setting up org-mode or checking for table context.
3608 "Detect the first line outside a table when searching from within it.
3611 ;; Autoload the functions in org-table.el that are needed by functions here.
3616 org-table-convert org-table-convert-region org-table-copy-down
3617 org-table-copy-region org-table-create
3618 org-table-create-or-convert-from-region
3619 org-table-create-with-table.el org-table-current-dline
3620 org-table-cut-region org-table-delete-column org-table-edit-field
3621 org-table-edit-formulas org-table-end org-table-eval-formula
3622 org-table-export org-table-field-info
3623 org-table-get-stored-formulas org-table-goto-column
3624 org-table-hline-and-move org-table-import org-table-insert-column
3625 org-table-insert-hline org-table-insert-row org-table-iterate
3626 org-table-justify-field-maybe org-table-kill-row
3627 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3628 org-table-move-column org-table-move-column-left
3629 org-table-move-column-right org-table-move-row
3630 org-table-move-row-down org-table-move-row-up
3631 org-table-next-field org-table-next-row org-table-paste-rectangle
3632 org-table-previous-field org-table-recalculate
3633 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3634 org-table-toggle-coordinate-overlays
3635 org-table-toggle-formula-debugger org-table-wrap-region
3636 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3637 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3638 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3641 "Return t if the cursor is inside an org-type table.
3642 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3647 org-table-line-regexp)))
3648 nil))
3652 "Return t if and only if we are at a table.el table."
3658 "If there is a table.el table nearby, recognize it and move into it."
3664 nil
3674 t
3679 t)
3680 nil)
3681 nil))
3684 "Return t if the cursor is inside a hline in a table."
3689 nil))
3694 "Apply FUNCTION to the start of all tables in the buffer."
3710 ;; Declare and autoload functions from org-exp.el & Co
3718 org-insert-export-options-template
3719 org-table-clean-before-export))
3722 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3723 org-export-region-as-ascii))
3726 org-replace-region-by-latex org-export-region-as-latex
3727 org-export-as-latex org-export-as-pdf
3728 org-export-as-pdf-and-open))
3731 org-export-as-html-batch org-export-as-html-to-buffer
3732 org-replace-region-by-html org-export-region-as-html
3733 org-export-as-html))
3736 org-replace-region-by-docbook org-export-region-as-docbook
3737 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3738 org-export-as-docbook))
3741 org-export-icalendar-all-agenda-files
3742 org-export-icalendar-combine-agenda-files))
3746 ;; Declare and autoload functions from org-agenda.el
3751 org-todo-list org-tags-view org-agenda-list-stuck-projects
3752 org-diary org-agenda-to-appt
3753 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3755 ;; Autoload org-remember
3760 org-remember-apply-template org-remember org-remember-handler)))
3765 org-capture-import-remember-templates)))
3767 ;; Autoload org-clock.el
3782 "Return non-nil if clock is currently running.
3783 The return value is actually the clock marker."
3788 "org-clock"
3790 org-clock-goto org-clock-sum org-clock-display
3791 org-clock-remove-overlays org-clock-report
3792 org-clocktable-shift org-dblock-write:clocktable
3793 org-get-clocktable org-resolve-clocks)))
3796 "If this is a CLOCK line, update it and return t.
3797 Otherwise, return nil."
3806 ts te h m s neg)
3809 nil)
3814 ;; The clock is running here
3835 t))))))
3838 "Check if the current buffer contains the running clock.
3839 If yes, offer to stop it and to save the buffer with the changes."
3848 "Check if this line starts a clock table, if yes, shift the time block."
3852 ;; Autoload org-timer.el
3856 "org-timer"
3858 org-timer-change-times-in-region
3859 org-timer-set-timer
3860 org-timer-reset-timers
3861 org-timer-show-remaining-time)))
3863 ;; Autoload org-feed.el
3867 "org-feed"
3871 ;; Autoload org-indent.el
3873 ;; Define the variable already here, to make sure we have it.
3875 "Non-nil if Org-Indent mode is enabled.
3880 "org-indent"
3883 ;; Autoload org-mobile.el
3887 "org-mobile"
3890 ;; Autoload archiving code
3891 ;; The stuff that is needed for cycling and tags has to be defined here.
3894 "Options concerning archiving in Org-mode."
3899 "The location where subtrees should be archived.
3901 The value of this variable is a string, consisting of two parts,
3902 separated by a double-colon. The first part is a filename and
3903 the second part is a headline.
3905 When the filename is omitted, archiving happens in the same file.
3906 %s in the filename will be replaced by the current file
3907 name (without the directory part). Archiving to a different file
3908 is useful to keep archived entries from contributing to the
3909 Org-mode Agenda.
3911 The archived entries will be filed as subtrees of the specified
3912 headline. When the headline is omitted, the subtrees are simply
3913 filed away at the end of the file, as top-level entries. Also in
3914 the heading you can use %s to represent the file name, this can be
3915 useful when using the same archive for a number of different files.
3917 Here are a few examples:
3919 If the current file is Projects.org, archive in file
3920 Projects.org_archive, as top-level trees. This is the default.
3923 Archive in the current file, under the top-level headline
3927 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3930 Archive in file ~/org/archive.org (absolute path), under headlines
3934 Archive in file ./basement (relative path), as level 3 trees
3937 You may set this option on a per-file basis by adding to the buffer a
3938 line like
3940 #+ARCHIVE: basement::** Finished Tasks
3942 You may also define it locally for a subtree by setting an ARCHIVE property
3943 in the entry. If such a property is found in an entry, or anywhere up
3944 the hierarchy, it will be used."
3949 "The tag that marks a subtree as archived.
3950 An archived subtree does not open during visibility cycling, and does
3951 not contribute to the agenda listings.
3952 After changing this, font-lock must be restarted in the relevant buffers to
3953 get the proper fontification."
3959 "Non-nil means the agenda will skip any items located in archived trees.
3960 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3961 variable is no longer recommended, you should leave it at the value t.
3962 Instead, use the key `v' to cycle the archives-mode in the agenda."
3968 "Non-nil means ignore archived trees when creating column view."
3974 "Non-nil means `org-cycle' will open archived trees.
3975 An archived tree is a tree marked with the tag ARCHIVE.
3976 When nil, archived trees will stay folded. You can still open them with
3977 normal outline commands like `show-all', but not with the cycling commands."
3983 "Non-nil means sparse tree construction shows matches in archived trees.
3984 When nil, matches in these trees are highlighted, but the trees are kept in
3985 collapsed state."
3991 "Re-hide all archived subtrees after a visibility state change."
4002 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4005 "Cycle subtree even if it is archived."
4012 "Re-hide all archived subtrees after a visibility state change."
4027 flag)))
4034 org-archive-to-archive-sibling org-toggle-archive-tag
4035 org-archive-subtree-default
4036 org-archive-subtree-default-with-confirmation)))
4038 ;; Autoload Column View Code
4046 org-columns-compute org-agenda-columns org-columns-remove-overlays
4049 ;; Autoload ID code
4057 org-id-get-with-outline-path-completion
4058 org-id-get-with-outline-drilling org-id-store-link
4059 org-id-goto org-id-find org-id-store-link))
4061 ;; Autoload Plotting Code
4066 ;;; Variables for pre-computed regular expressions, all buffer local
4084 "Matches a headline and puts everything into groups:
4085 group 1: the stars
4086 group 2: The todo keyword, maybe
4087 group 3: Priority cookie
4088 group 4: True headline
4092 "Printf format to make regexp to match an exact headline.
4093 This regexp will match the headline of any node which hase the exact
4094 headline text that is put into the format, but may have any TODO state,
4098 "Matches a headline and puts TODO state into group 2 if present.
4153 "Regular expression to match a plain time or time range.
4154 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4155 groups carry important information:
4156 0 the full match
4157 1 the first time, range or not
4165 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4166 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4167 groups carry important information:
4168 0 the full match
4169 7 hours of duration
4178 "Regular expression to match a timestamp time or time range.
4179 After a match, the following groups carry important information:
4180 0 the full match
4181 1 date plus weekday, for back referencing to make sure both times are on the same day
4182 2 the first time, range or not
4237 "Variable associated with STARTUP options for org-mode.
4238 Each element is a list of three items: The startup options as written
4239 in the #+STARTUP line, the corresponding variable, and the value to
4240 set this variable to if the option is found. An optional forth element PUSH
4244 "Precompute regular expressions for current buffer."
4264 kwds kws0 kwsa key log value cat arch tags const links hw dws
4265 tail sep kws1 prio props ftags drawers beamer-p
4287 ;; general TODO-like setup
4299 links)))
4305 props)))
4310 ftags
4320 l var val)
4350 ))))
4367 ;; Process the TODO keywords
4369 ;; Use the global values as if they had been given locally.
4381 kws)))
4384 kwsa nil
4387 ;; 1 2
4395 kw)
4397 kws0)
4414 ;; Process the constants
4422 ;; Process the tags.
4433 tgs))
4441 ;; Compute the regular expressions and other local variables
4449 org-drawer-regexp
4453 org-not-done-keywords
4455 org-todo-regexp
4458 org-not-done-regexp
4462 org-not-done-heading-regexp
4466 org-todo-line-regexp
4470 org-complex-heading-regexp
4475 org-complex-heading-regexp-format
4484 org-nl-done-regexp
4488 org-todo-line-tags-regexp
4493 org-looking-at-done-regexp
4498 org-deadline-time-regexp
4500 org-deadline-line-regexp
4502 org-scheduled-regexp
4504 org-scheduled-time-regexp
4506 org-closed-time-regexp
4508 org-keyword-time-regexp
4514 org-keyword-time-not-clock-regexp
4520 org-maybe-keyword-time-regexp
4526 org-planning-or-clock-line-re
4531 org-all-time-keywords
4534 org-clock-string org-closed-string))
4535 )
4540 "Return the contents of FILE, as a string."
4554 "Extract the log state setting from a TODO keyword string.
4568 "Remove a pair of parenthesis at the end of each string in LIST."
4572 x))
4573 list))
4576 "Assign fast keys to a keyword-key alist.
4577 Respect keys that are already there."
4595 ;;; Some variables used in various places
4602 "Function to be called when `C-c C-c' is used.
4606 ;; FIXME: Occasionally check by commenting these, to make sure
4607 ;; no other functions uses these, forgetting to let-bind them.
4612 ;; Defined somewhere in this file, but used before definition.
4618 ;;;; Define the Org-mode
4621 (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"))
4624 ;; We use a before-change function to check if a table might need
4625 ;; an update.
4627 "Indicates that a table might need an update.
4628 This variable is set by `org-before-change-function'.
4631 "Every change indicates that a table might need an update."
4642 ;;;###autoload
4644 "Outline-based notes management and organizer, alias
4647 Org-mode develops organizational tasks around a NOTES file which
4648 contains information about projects as plain text. Org-mode is
4649 implemented on top of outline-mode, which is ideal to keep the content
4650 of large files well structured. It supports ToDo items, deadlines and
4651 time stamps, which magically appear in the diary listing of the Emacs
4652 calendar. Tables are easily created with a built-in table editor.
4653 Plain text URL-like links connect to websites, emails (VM), Usenet
4654 messages (Gnus), BBDB entries, and any files related to the project.
4655 For printing and sharing of notes, an Org-mode file (or a part of it)
4656 can be exported as a structured ASCII or HTML file.
4658 The following commands are available:
4662 ;; Get rid of Outline menus, they are not needed
4663 ;; Need to do this here because define-derived-mode sets up
4664 ;; the keymap so late. Still, it is a waste to call this each time
4665 ;; we switch another buffer into org-mode.
4668 ;; Assume this is Greg's port, it uses easymenu
4693 org-display-table 4
4696 org-ellipsis)))
4701 ;; tag faces set outside customize.... force initialization.
4703 ;; Calc embedded
4709 ;; Activate before-change-function
4713 ;; Check for running clock before killing a buffer
4715 ;; Paragraphs and auto-filling
4719 ;; Beginning/end of defun
4722 ;; Make sure dependence stuff works reliably, even for users who set it
4723 ;; too late :-(
4735 ;; Comment characters
4739 ;; Align options lines
4741 'align-mode-rules-list
4746 ;; Imenu
4750 ;; Make isearch reveal context
4753 ;; Emacs 21 and XEmacs make use of the hook
4755 ;; Emacs 22 deals with this through a special variable
4759 ;; Turn on org-beamer-mode?
4762 ;; Setup the pcomplete hooks
4773 ;; If empty file that did not turn on org-mode automatically, make it to.
4798 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4808 "Return today date, considering `org-extend-today-until'."
4813 ;;;; Font-Lock stuff, including the activators
4844 "Regular expression used to analyze links.
4845 Here is what the match groups contain after a match:
4846 1: http:
4847 2: http
4848 3: path
4849 4: [desc]
4857 "Number of stacked braces for sub/superscript matching.
4858 This has to be set before loading org.el to be effective."
4863 "Create a regular expression which will match a balanced sexp.
4864 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4865 as single character strings.
4866 The regexp returned will match the entire expression including the
4867 delimiters. It will also define a single group which contains the
4868 match except for the outermost delimiters. The maximum depth of
4869 stacked delimiters is N. Escaping delimiters is not possible."
4898 "Update the link regular expressions.
4899 This should be called after the variable `org-link-types' has changed."
4903 org-link-re-with-space
4909 org-link-re-with-space2
4915 org-link-re-with-space3
4920 org-angle-link-re
4926 org-plain-link-re
4930 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
4931 org-bracket-link-regexp
4933 org-bracket-link-analytic-regexp
4941 org-bracket-link-analytic-regexp++
4949 org-any-link-re
4960 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4961 "Regular expression matching time strings for analysis.
4962 This one does not require the space after the date, so it can be used
4964 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4980 "Regular expression matching a time stamp or time stamp range.
4986 "Run through the buffer and add overlays to links."
4995 'face
5008 rtn))
5011 "Insert or change an emphasis, i.e. a font like bold or italic.
5012 If there is an active region, change that region to a new emphasis.
5013 If there is no region, just insert the marker characters and position
5014 the cursor between them.
5015 CHAR should be either the marker character, or the first character of the
5016 HTML tag associated with that emphasis. If CHAR is a space, the means
5017 to remove the emphasis of the selected region.
5018 If char is not given (for example in an interactive call) it
5019 will be prompted for."
5070 "Run through the buffer and add overlays to links."
5079 nil
5085 t)))))
5093 t)))
5096 "When non-nil, fontify code in code blocks."
5102 "Fontify #+ lines and blocks, in the correct ways."
5105 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5106 limit t)
5114 end end1 quoting block-type)
5117 ;; a single line of backend-specific content
5125 ; for backend-specific code
5126 t)
5128 ;; Truly a block
5140 beg end
5144 ; for end_src
5150 org-block)))
5151 ; end of source block
5157 t))
5170 ;; just any other in-buffer setting, but not indented
5174 t)
5182 t)
5190 "Run through the buffer and add overlays to links."
5198 t)))
5201 "Run through the buffer and add overlays to links."
5203 limit t)
5208 'keymap org-mouse-map
5209 'help-echo
5211 "Footnote definition"
5213 ))
5215 t)))
5218 "Run through the buffer and add overlays to bracketed links."
5222 ;; FIXME: above we should remove the escapes.
5223 ;; but that requires another match, protecting match data,
5224 ;; a lot of overhead for font-lock.
5231 ;; We need to remove the invisible property here. Table narrowing
5232 ;; may have made some of this invisible.
5250 t)))
5253 "Run through the buffer and add overlays to dates."
5265 t)))
5274 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5278 "Run through the buffer and add overlays to target matches."
5286 'keymap org-mouse-map
5290 t)))))
5293 "Find all radio targets in this file and update the regular expression."
5308 t)))
5315 ;; This should be with the exporter code, but we also use if for font-locking
5325 "Compute regular expression for stuff treated specially by exporters."
5332 org-latex-regexps)))
5360 org-entities)))
5364 org-latex-entities)
5365 nil))
5367 ))
5368 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5371 org-export-html-special-string-regexps)))
5376 ))))
5378 'org-latex-and-specials-regexp
5383 "Run through the buffer and add overlays to links."
5387 limit t))
5401 rtn)))
5404 "Restart `font-lock-mode', to force refontification."
5410 "Return a list of all targets in this file.
5411 With optional argument RADIO, only find radio targets."
5413 rtn)
5418 rtn)))
5421 "Make regular expression matching all strings in TARGETS.
5422 The regular expression finds the targets also if there is a line break
5423 between words."
5432 x)
5433 targets
5445 t)))
5448 "Compute the outline level of the heading at point.
5449 This function assumes that the cursor is at the beginning of a line matched
5450 by `outline-regexp'. Otherwise it returns garbage.
5451 If this is called at a normal headline, the level is the number of stars.
5452 Use `org-reduced-level' to remove the effect of `org-odd-levels'.
5453 For plain list items, if they are matched by `outline-regexp', this returns
5454 1000 plus the line indentation."
5463 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5470 "Functions that can manipulate `org-font-lock-extra-keywords'.
5471 This is calles after `org-font-lock-extra-keywords' is defined, but before
5472 it is installed to be used by font lock. This can be useful if something
5483 ;; Call the hook
5485 ;; Headlines
5492 ;; Table lines
5495 ;; Table internals
5500 ;; Drawers
5503 ;; Properties
5507 ;; Links
5518 ;; TODO lines
5521 ;; DONE
5527 nil)
5528 ;; Priorities
5530 ;; Tags
5532 ;; Special keywords
5537 ;; Emphasis
5542 ;; Checkboxes
5543 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5548 ;; Description list items
5551 ;; ARCHIVEd headings
5554 ;; Specials
5558 ;; Code
5560 ;; COMMENT
5565 ;; Blocks and meta lines
5567 )))
5570 ;; Now set the full font-lock-keywords
5577 "Toggle the composition display of entities as UTF8 characters."
5589 "Find an entity to fontify."
5595 limit t)
5607 nil))))
5610 "Fontify string S like in Org-mode."
5622 "Get the right face for match N in font-lock matching of headlines."
5635 "Get the right face for a TODO keyword KWD.
5636 If KWD is a number, get the corresponding match group."
5644 "Create a face list that inherits INHERIT, but sets the foreground color.
5645 When FACE-OR-COLOR is not a string, just return it."
5649 face-or-color)
5650 face-or-color))
5653 "Add the special tag faces."
5662 "Add the special priority faces."
5669 org-priority-faces)))
5674 "Get the right face for a TODO keyword KWD.
5675 If KWD is a number, get the corresponding match group."
5682 "Remove fontification and activation overlays from links."
5687 deactivate-mark buffer-file-name buffer-file-truename)
5690 beg end
5692 ;; also remove line-prefix and wrap-prefix properties
5694 invisible t intangible t
5695 line-prefix t wrap-prefix t
5696 org-no-flyspell t org-emphasis t)
5698 invisible t intangible t
5699 org-no-flyspell t org-emphasis t)))
5709 "Remove specific display properties that have been added by font lock.
5710 The will remove the raise properties that are used to show superscripts
5711 and subscripts."
5721 "Add raise properties to sub/superscripts."
5725 org-match-substring-regexp
5726 org-match-substring-with-braces-regexp)
5727 limit t)
5737 ;; FIXME: Should we go back one character here, for a_b^c
5738 ;; (goto-char (1- pos)) ;????????????????????
5740 t
5742 'display
5758 t)))))
5760 ;;;; Visibility cycling, including org-goto and indirect buffer
5762 ;;; Cycling
5769 ;;;###autoload
5774 "TAB-action and visibility cycling for Org-mode.
5776 This is the command invoked in Org-mode by the TAB key. Its main purpose
5777 is outline visibility cycling, but it also invokes other actions
5778 in special contexts.
5780 - When this function is called with a prefix argument, rotate the entire
5781 buffer through 3 states (global cycling)
5782 1. OVERVIEW: Show only top-level headlines.
5783 2. CONTENTS: Show all headlines of all levels, but no body text.
5784 3. SHOW ALL: Show everything.
5785 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5786 determined by the variable `org-startup-folded', and by any VISIBILITY
5787 properties in the buffer.
5788 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5789 including any drawers.
5791 - When inside a table, re-align the table and move to the next field.
5793 - When point is at the beginning of a headline, rotate the subtree started
5794 by this line through 3 different states (local cycling)
5795 1. FOLDED: Only the main headline is shown.
5796 2. CHILDREN: The main headline and the direct children are shown.
5797 From this state, you can move to one of the children
5798 and zoom in further.
5799 3. SUBTREE: Show the entire subtree, including body text.
5800 If there is no subtree, switch directly from CHILDREN to FOLDED.
5802 - When point is at the beginning of an empty headline and the variable
5803 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5804 of the headline by demoting and promoting it to likely levels. This
5805 speeds up creation document structure by pressing TAB once or several
5806 times right after creating a new headline.
5808 - When there is a numeric prefix, go up to a heading with level ARG, do
5809 a `show-subtree' and return to the previous cursor position. If ARG
5810 is negative, go up that many levels.
5812 - When point is not at the beginning of a headline, execute the global
5813 binding for TAB, which is re-indenting the line. See the option
5814 `org-cycle-emulate-tab' for details.
5816 - Special case: if point is at the beginning of the buffer and there is
5817 no headline in line 1, this function will act as if called with prefix arg
5818 (C-u TAB, same as S-TAB) also when called without prefix arg.
5819 But only if also the variable `org-cycle-global-at-bob' is t."
5829 org-inlinetask-min-level
5834 limit-level)))
5850 org-cycle-hook))
5854 ;; special case: use global cycling
5869 ;; Enter the table or move to the next field in the table
5886 ;; Toggle block visibility
5891 ;; Show-subtree, ARG levels up from here.
5903 ;; TAB emulation and template completion
5927 t
5936 "Do the global cycling action."
5940 ;; We just created the overview - now do table of contents
5941 ;; This can be slow in very large buffers, so indicate action
5951 ;; We just showed the table of contents - now show everything
5959 ;; Default action: go to overview
5967 "Do the local cycling action."
5969 ;; First, some boundaries
5976 ; XEmacs does not have `next-single-char-property-change'
5977 ; I'm not sure about Emacs 21.
5991 ;; if we're in a list, org-end-of-subtree is in fact org-end-of-item.
6000 ;; Find out what to do next and set `this-command'
6003 ;; Nothing is hidden behind this heading
6015 org-cycle-skip-children-state-if-no-children))))
6016 ;; Entire subtree is hidden in one line: children view
6030 ;; We just showed the children, or no children are there,
6031 ;; now show everything.
6038 ;; Default action: hide the subtree.
6045 ;;;###autoload
6047 "Cycle the global visibility. For details see `org-cycle'.
6049 With a numeric prefix, show all headlines up to that level."
6065 "Set the visibility required by startup options and properties."
6080 "Switch subtree visibilities according to :VISIBILITY: property."
6087 nil t)
6112 "Switch to overview mode, showing only top-level headlines.
6113 Really, this shows all headlines with level equal or greater than the level
6114 of the first headline in the buffer. This is important, because if the
6115 first headline is not level one, then (hide-sublevels 1) gives confusing
6116 results."
6127 "Show all headlines in the buffer, like a table of contents.
6128 With numerical argument N, show content up to level N."
6131 ;; Visit all headings and show their offspring
6138 t)
6147 "Adjust the window after a change in outline visibility.
6148 This function is the default value of the hook `org-cycle-hook'."
6158 "Remove outline overlays that do not contain non-white stuff."
6168 "Fix visibility issues after moving a subtree."
6169 ;; First, find a reasonable region to look at:
6170 ;; Start two siblings above, end three below
6188 ;; Properly fold already folded siblings
6199 "Show empty lines above all visible headlines.
6200 The region to be covered depends on STATE when called through
6201 `org-cycle-hook'. Lisp program can use t for STATE to get the
6202 entire buffer covered. Note that an empty line is only shown if there
6203 are at least `org-cycle-separator-lines' empty lines before the headline."
6213 beg end b e)
6237 ;; Never hide empty lines at the end of the file.
6247 "Move to the parent and re-show empty lines before visible headlines."
6253 "Return `org-agenda-files' list, plus all open org-mode files.
6254 This is useful for operations that need to scan all of a user's
6255 open and agenda-wise Org files."
6263 files))
6266 "Return the beginning position of the current entry."
6270 "Return the end position of the current entry."
6274 "Re-hide all drawers after a visibility state change."
6301 "Is the end of the current subtree visible?"
6306 "Move cursor to the first headline and recenter the headline.
6307 Optional argument N means put the headline into the Nth line of the window."
6313 ;;; Saving and restoring visibility
6316 "Return a list of the locations of all outline overlays.
6317 These are overlays with the `invisible' property value `outline'.
6318 The return value is a list of cons cells, with start and stop
6319 positions for each overlay.
6320 If USE-MARKERS is set, return the positions as markers."
6338 "Create visibility overlays for all positions in DATA.
6339 DATA should have been made by `org-outline-overlay-data'."
6348 data)))))
6350 ;;; Folding of blocks
6362 "Call FUNCTION at the head of all source blocks in the current buffer.
6363 Optional arguments START and END can be used to limit the range."
6375 "Toggle the visibility of all blocks in the current buffer."
6379 "Fold all blocks in the current buffer."
6385 "Unfold all blocks in the current buffer."
6391 "Toggle visibility of block at point."
6402 "Toggle the visibility of the current block."
6409 ov)
6425 ;; make the block accessible to isearch
6427 ov 'isearch-open-invisible
6438 ;; org-tab-after-check-for-cycling-hook
6440 ;; Remove overlays when changing major mode
6445 ;;; Org-goto
6451 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6467 nil)
6468 (org-defkey map "q" 'org-goto-quit)
6469 (org-defkey map "n" 'outline-next-visible-heading)
6470 (org-defkey map "p" 'outline-previous-visible-heading)
6471 (org-defkey map "f" 'outline-forward-same-level)
6472 (org-defkey map "b" 'outline-backward-same-level)
6473 (org-defkey map "u" 'outline-up-heading))
6474 (org-defkey map "/" 'org-occur)
6475 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6476 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6477 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6478 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6479 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6480 map))
6482 (defconst org-goto-help
6483 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6484 RET=jump to location [Q]uit and return to previous location
6485 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6487 (defvar org-goto-start-pos) ; dynamically scoped parameter
6489 ;; FIXME: Docstring does not mention both interfaces
6490 (defun org-goto (&optional alternative-interface)
6491 "Look up a different location in the current file, keeping current visibility.
6493 When you want look-up or go to a different location in a document, the
6494 fastest way is often to fold the entire buffer and then dive into the tree.
6495 This method has the disadvantage, that the previous location will be folded,
6496 which may not be what you want.
6498 This command works around this by showing a copy of the current buffer
6499 in an indirect buffer, in overview mode. You can dive into the tree in
6500 that copy, use org-occur and incremental search to find a location.
6501 When pressing RET or `Q', the command returns to the original buffer in
6502 which the visibility is still unchanged. After RET is will also jump to
6503 the location selected in the indirect buffer and expose the
6504 the headline hierarchy above."
6505 (interactive "P")
6506 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6507 (org-refile-use-outline-path t)
6508 (org-refile-target-verify-function nil)
6509 (interface
6510 (if (not alternative-interface)
6511 org-goto-interface
6512 (if (eq org-goto-interface 'outline)
6513 'outline-path-completion
6514 'outline)))
6515 (org-goto-start-pos (point))
6516 (selected-point
6517 (if (eq interface 'outline)
6518 (car (org-get-location (current-buffer) org-goto-help))
6519 (let ((pa (org-refile-get-location "Goto: ")))
6520 (org-refile-check-position pa)
6521 (nth 3 pa)))))
6522 (if selected-point
6523 (progn
6524 (org-mark-ring-push org-goto-start-pos)
6525 (goto-char selected-point)
6526 (if (or (org-invisible-p) (org-invisible-p2))
6527 (org-show-context 'org-goto)))
6528 (message "Quit"))))
6530 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6531 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6532 (defvar org-goto-local-auto-isearch-map) ; defined below
6534 (defun org-get-location (buf help)
6535 "Let the user select a location in the Org-mode buffer BUF.
6536 This function uses a recursive edit. It returns the selected position
6537 or nil."
6538 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6539 (isearch-hide-immediately nil)
6540 (isearch-search-fun-function
6541 (lambda () 'org-goto-local-search-headings))
6542 (org-goto-selected-point org-goto-exit-command)
6543 (pop-up-frames nil)
6544 (special-display-buffer-names nil)
6545 (special-display-regexps nil)
6546 (special-display-function nil))
6547 (save-excursion
6548 (save-window-excursion
6549 (delete-other-windows)
6550 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6551 (switch-to-buffer
6552 (condition-case nil
6553 (make-indirect-buffer (current-buffer) "*org-goto*")
6554 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6555 (with-output-to-temp-buffer "*Help*"
6556 (princ help))
6557 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6558 (setq buffer-read-only nil)
6559 (let ((org-startup-truncated t)
6560 (org-startup-folded nil)
6561 (org-startup-align-all-tables nil))
6562 (org-mode)
6563 (org-overview))
6564 (setq buffer-read-only t)
6565 (if (and (boundp 'org-goto-start-pos)
6566 (integer-or-marker-p org-goto-start-pos))
6567 (let ((org-show-hierarchy-above t)
6568 (org-show-siblings t)
6569 (org-show-following-heading t))
6570 (goto-char org-goto-start-pos)
6571 (and (org-invisible-p) (org-show-context)))
6572 (goto-char (point-min)))
6573 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6574 (message "Select location and press RET")
6575 (use-local-map org-goto-map)
6576 (recursive-edit)
6577 ))
6578 (kill-buffer "*org-goto*")
6579 (cons org-goto-selected-point org-goto-exit-command)))
6581 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6582 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6583 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6584 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6586 (defun org-goto-local-search-headings (string bound noerror)
6587 "Search and make sure that any matches are in headlines."
6588 (catch 'return
6589 (while (if isearch-forward
6590 (search-forward string bound noerror)
6591 (search-backward string bound noerror))
6592 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6593 (and (member :headline context)
6594 (not (member :tags context))))
6595 (throw 'return (point))))))
6597 (defun org-goto-local-auto-isearch ()
6598 "Start isearch."
6599 (interactive)
6600 (goto-char (point-min))
6601 (let ((keys (this-command-keys)))
6602 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6603 (isearch-mode t)
6604 (isearch-process-search-char (string-to-char keys)))))
6606 (defun org-goto-ret (&optional arg)
6607 "Finish `org-goto' by going to the new location."
6608 (interactive "P")
6609 (setq org-goto-selected-point (point)
6610 org-goto-exit-command 'return)
6611 (throw 'exit nil))
6613 (defun org-goto-left ()
6614 "Finish `org-goto' by going to the new location."
6615 (interactive)
6616 (if (org-on-heading-p)
6617 (progn
6618 (beginning-of-line 1)
6619 (setq org-goto-selected-point (point)
6620 org-goto-exit-command 'left)
6621 (throw 'exit nil))
6622 (error "Not on a heading")))
6624 (defun org-goto-right ()
6625 "Finish `org-goto' by going to the new location."
6626 (interactive)
6627 (if (org-on-heading-p)
6628 (progn
6629 (setq org-goto-selected-point (point)
6630 org-goto-exit-command 'right)
6631 (throw 'exit nil))
6632 (error "Not on a heading")))
6634 (defun org-goto-quit ()
6635 "Finish `org-goto' without cursor motion."
6636 (interactive)
6637 (setq org-goto-selected-point nil)
6638 (setq org-goto-exit-command 'quit)
6639 (throw 'exit nil))
6641 ;;; Indirect buffer display of subtrees
6643 (defvar org-indirect-dedicated-frame nil
6644 "This is the frame being used for indirect tree display.")
6645 (defvar org-last-indirect-buffer nil)
6647 (defun org-tree-to-indirect-buffer (&optional arg)
6648 "Create indirect buffer and narrow it to current subtree.
6649 With numerical prefix ARG, go up to this level and then take that tree.
6650 If ARG is negative, go up that many levels.
6651 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6652 indirect buffer previously made with this command, to avoid proliferation of
6653 indirect buffers. However, when you call the command with a \
6655 when `org-indirect-buffer-display' is `new-frame', the last buffer
6656 is kept so that you can work with several indirect buffers at the same time.
6657 If `org-indirect-buffer-display' is `dedicated-frame', the \
6659 requests that a new frame be made for the new buffer, so that the dedicated
6660 frame is not changed."
6661 (interactive "P")
6662 (let ((cbuf (current-buffer))
6663 (cwin (selected-window))
6664 (pos (point))
6665 beg end level heading ibuf)
6666 (save-excursion
6667 (org-back-to-heading t)
6668 (when (numberp arg)
6669 (setq level (org-outline-level))
6670 (if (< arg 0) (setq arg (+ level arg)))
6671 (while (> (setq level (org-outline-level)) arg)
6672 (outline-up-heading 1 t)))
6673 (setq beg (point)
6674 heading (org-get-heading))
6675 (org-end-of-subtree t t)
6676 (if (org-on-heading-p) (backward-char 1))
6677 (setq end (point)))
6678 (if (and (buffer-live-p org-last-indirect-buffer)
6679 (not (eq org-indirect-buffer-display 'new-frame))
6680 (not arg))
6681 (kill-buffer org-last-indirect-buffer))
6682 (setq ibuf (org-get-indirect-buffer cbuf)
6683 org-last-indirect-buffer ibuf)
6684 (cond
6685 ((or (eq org-indirect-buffer-display 'new-frame)
6686 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6687 (select-frame (make-frame))
6688 (delete-other-windows)
6689 (switch-to-buffer ibuf)
6690 (org-set-frame-title heading))
6691 ((eq org-indirect-buffer-display 'dedicated-frame)
6692 (raise-frame
6693 (select-frame (or (and org-indirect-dedicated-frame
6694 (frame-live-p org-indirect-dedicated-frame)
6695 org-indirect-dedicated-frame)
6696 (setq org-indirect-dedicated-frame (make-frame)))))
6697 (delete-other-windows)
6698 (switch-to-buffer ibuf)
6699 (org-set-frame-title (concat "Indirect: " heading)))
6700 ((eq org-indirect-buffer-display 'current-window)
6701 (switch-to-buffer ibuf))
6702 ((eq org-indirect-buffer-display 'other-window)
6703 (pop-to-buffer ibuf))
6704 (t (error "Invalid value")))
6705 (if (featurep 'xemacs)
6706 (save-excursion (org-mode) (turn-on-font-lock)))
6707 (narrow-to-region beg end)
6708 (show-all)
6709 (goto-char pos)
6710 (and (window-live-p cwin) (select-window cwin))))
6712 (defun org-get-indirect-buffer (&optional buffer)
6713 (setq buffer (or buffer (current-buffer)))
6714 (let ((n 1) (base (buffer-name buffer)) bname)
6715 (while (buffer-live-p
6716 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6717 (setq n (1+ n)))
6718 (condition-case nil
6719 (make-indirect-buffer buffer bname 'clone)
6720 (error (make-indirect-buffer buffer bname)))))
6722 (defun org-set-frame-title (title)
6723 "Set the title of the current frame to the string TITLE."
6724 ;; FIXME: how to name a single frame in XEmacs???
6725 (unless (featurep 'xemacs)
6726 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6728 ;;;; Structure editing
6730 ;;; Inserting headlines
6732 (defun org-previous-line-empty-p ()
6733 (save-excursion
6734 (and (not (bobp))
6735 (or (beginning-of-line 0) t)
6736 (save-match-data
6739 (defun org-insert-heading (&optional force-heading invisible-ok)
6740 "Insert a new heading or item with same depth at point.
6741 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6742 If point is at the beginning of a headline, insert a sibling before the
6743 current headline. If point is not at the beginning, split the line,
6744 create the new headline with the text in the current line after point
6745 \(but see also the variable `org-M-RET-may-split-line').
6747 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6748 This is important for non-interactive uses of the command."
6749 (interactive "P")
6750 (if (or (= (buffer-size) 0)
6751 (and (not (save-excursion
6752 (and (ignore-errors (org-back-to-heading invisible-ok))
6753 (org-on-heading-p))))
6754 (not (org-in-item-p))))
6755 (progn
6757 (run-hooks 'org-insert-heading-hook))
6758 (when (or force-heading (not (org-insert-item)))
6759 (let* ((empty-line-p nil)
6760 (level nil)
6761 (on-heading (org-on-heading-p))
6762 (head (save-excursion
6763 (condition-case nil
6764 (progn
6765 (org-back-to-heading invisible-ok)
6766 (when (and (not on-heading)
6767 (featurep 'org-inlinetask)
6768 (integerp org-inlinetask-min-level)
6769 (>= (length (match-string 0))
6770 org-inlinetask-min-level))
6771 ;; Find a heading level before the inline task
6772 (while (and (setq level (org-up-heading-safe))
6773 (>= level org-inlinetask-min-level)))
6774 (if (org-on-heading-p)
6775 (org-back-to-heading invisible-ok)
6776 (error "This should not happen")))
6777 (setq empty-line-p (org-previous-line-empty-p))
6778 (match-string 0))
6779 (error "*"))))
6780 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6781 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6782 pos hide-previous previous-pos)
6783 (cond
6784 ((and (org-on-heading-p) (bolp)
6785 (or (bobp)
6786 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6787 ;; insert before the current line
6788 (open-line (if blank 2 1)))
6789 ((and (bolp)
6790 (not org-insert-heading-respect-content)
6791 (or (bobp)
6792 (save-excursion
6793 (backward-char 1) (not (org-invisible-p)))))
6794 ;; insert right here
6795 nil)
6796 (t
6797 ;; somewhere in the line
6798 (save-excursion
6799 (setq previous-pos (point-at-bol))
6800 (end-of-line)
6801 (setq hide-previous (org-invisible-p)))
6802 (and org-insert-heading-respect-content (org-show-subtree))
6803 (let ((split
6804 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6805 (save-excursion
6806 (let ((p (point)))
6807 (goto-char (point-at-bol))
6808 (and (looking-at org-complex-heading-regexp)
6809 (> p (match-beginning 4)))))))
6810 tags pos)
6811 (cond
6812 (org-insert-heading-respect-content
6813 (org-end-of-subtree nil t)
6814 (when (featurep 'org-inlinetask)
6815 (while (and (not (eobp))
6817 (>= (length (match-string 1))
6818 org-inlinetask-min-level))
6819 (org-end-of-subtree nil t)))
6820 (or (bolp) (newline))
6821 (or (org-previous-line-empty-p)
6822 (and blank (newline)))
6823 (open-line 1))
6824 ((org-on-heading-p)
6825 (when hide-previous
6826 (show-children)
6827 (org-show-entry))
6829 (setq tags (and (match-end 2) (match-string 2)))
6830 (and (match-end 1)
6831 (delete-region (match-beginning 1) (match-end 1)))
6832 (setq pos (point-at-bol))
6833 (or split (end-of-line 1))
6834 (delete-horizontal-space)
6836 (buffer-substring (point-at-bol) (point)))
6837 (insert " "))
6838 (newline (if blank 2 1))
6839 (when tags
6840 (save-excursion
6841 (goto-char pos)
6842 (end-of-line 1)
6843 (insert " " tags)
6844 (org-set-tags nil 'align))))
6845 (t
6846 (or split (end-of-line 1))
6847 (newline (if blank 2 1)))))))
6848 (insert head) (just-one-space)
6849 (setq pos (point))
6850 (end-of-line 1)
6851 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6852 (when (and org-insert-heading-respect-content hide-previous)
6853 (save-excursion
6854 (goto-char previous-pos)
6855 (hide-subtree)))
6856 (run-hooks 'org-insert-heading-hook)))))
6858 (defun org-get-heading (&optional no-tags)
6859 "Return the heading of the current entry, without the stars."
6860 (save-excursion
6861 (org-back-to-heading t)
6862 (if (looking-at
6863 (if no-tags
6866 (match-string 1) "")))
6868 (defun org-heading-components ()
6869 "Return the components of the current heading.
6870 This is a list with the following elements:
6871 - the level as an integer
6872 - the reduced level, different if `org-odd-levels-only' is set.
6873 - the TODO keyword, or nil
6874 - the priority character, like ?A, or nil if no priority is given
6875 - the headline text itself, or the tags string if no headline text
6876 - the tags string, or nil."
6877 (save-excursion
6878 (org-back-to-heading t)
6879 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6880 (list (length (match-string 1))
6881 (org-reduced-level (length (match-string 1)))
6882 (org-match-string-no-properties 2)
6883 (and (match-end 3) (aref (match-string 3) 2))
6884 (org-match-string-no-properties 4)
6885 (org-match-string-no-properties 5)))))
6887 (defun org-get-entry ()
6888 "Get the entry text, after heading, entire subtree."
6889 (save-excursion
6890 (org-back-to-heading t)
6891 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6893 (defun org-insert-heading-after-current ()
6894 "Insert a new heading with same level as current, after current subtree."
6895 (interactive)
6896 (org-back-to-heading)
6897 (org-insert-heading)
6898 (org-move-subtree-down)
6899 (end-of-line 1))
6901 (defun org-insert-heading-respect-content ()
6902 (interactive)
6903 (let ((org-insert-heading-respect-content t))
6904 (org-insert-heading t)))
6906 (defun org-insert-todo-heading-respect-content (&optional force-state)
6907 (interactive "P")
6908 (let ((org-insert-heading-respect-content t))
6909 (org-insert-todo-heading force-state t)))
6911 (defun org-insert-todo-heading (arg &optional force-heading)
6912 "Insert a new heading with the same level and TODO state as current heading.
6913 If the heading has no TODO state, or if the state is DONE, use the first
6914 state (TODO by default). Also with prefix arg, force first state."
6915 (interactive "P")
6916 (when (or force-heading (not (org-insert-item 'checkbox)))
6917 (org-insert-heading force-heading)
6918 (save-excursion
6919 (org-back-to-heading)
6920 (outline-previous-heading)
6921 (looking-at org-todo-line-regexp))
6922 (let*
6923 ((new-mark-x
6924 (if (or arg
6925 (not (match-beginning 2))
6926 (member (match-string 2) org-done-keywords))
6927 (car org-todo-keywords-1)
6928 (match-string 2)))
6929 (new-mark
6930 (or
6931 (run-hook-with-args-until-success
6932 'org-todo-get-default-hook new-mark-x nil)
6933 new-mark-x)))
6934 (beginning-of-line 1)
6936 (if org-treat-insert-todo-heading-as-state-change
6937 (org-todo new-mark)
6938 (insert new-mark " "))))
6939 (when org-provide-todo-statistics
6940 (org-update-parent-todo-statistics))))
6942 (defun org-insert-subheading (arg)
6943 "Insert a new subheading and demote it.
6944 Works for outline headings and for plain lists alike."
6945 (interactive "P")
6946 (org-insert-heading arg)
6947 (cond
6948 ((org-on-heading-p) (org-do-demote))
6949 ((org-at-item-p) (org-indent-item))))
6951 (defun org-insert-todo-subheading (arg)
6952 "Insert a new subheading with TODO keyword or checkbox and demote it.
6953 Works for outline headings and for plain lists alike."
6954 (interactive "P")
6955 (org-insert-todo-heading arg)
6956 (cond
6957 ((org-on-heading-p) (org-do-demote))
6958 ((org-at-item-p) (org-indent-item))))
6960 ;;; Promotion and Demotion
6962 (defvar org-after-demote-entry-hook nil
6963 "Hook run after an entry has been demoted.
6964 The cursor will be at the beginning of the entry.
6965 When a subtree is being demoted, the hook will be called for each node.")
6967 (defvar org-after-promote-entry-hook nil
6968 "Hook run after an entry has been promoted.
6969 The cursor will be at the beginning of the entry.
6970 When a subtree is being promoted, the hook will be called for each node.")
6972 (defun org-promote-subtree ()
6973 "Promote the entire subtree.
6974 See also `org-promote'."
6975 (interactive)
6976 (save-excursion
6977 (org-map-tree 'org-promote))
6978 (org-fix-position-after-promote))
6980 (defun org-demote-subtree ()
6981 "Demote the entire subtree. See `org-demote'.
6982 See also `org-promote'."
6983 (interactive)
6984 (save-excursion
6985 (org-map-tree 'org-demote))
6986 (org-fix-position-after-promote))
6989 (defun org-do-promote ()
6990 "Promote the current heading higher up the tree.
6991 If the region is active in `transient-mark-mode', promote all headings
6992 in the region."
6993 (interactive)
6994 (save-excursion
6995 (if (org-region-active-p)
6996 (org-map-region 'org-promote (region-beginning) (region-end))
6997 (org-promote)))
6998 (org-fix-position-after-promote))
7000 (defun org-do-demote ()
7001 "Demote the current heading lower down the tree.
7002 If the region is active in `transient-mark-mode', demote all headings
7003 in the region."
7004 (interactive)
7005 (save-excursion
7006 (if (org-region-active-p)
7007 (org-map-region 'org-demote (region-beginning) (region-end))
7008 (org-demote)))
7009 (org-fix-position-after-promote))
7011 (defun org-fix-position-after-promote ()
7012 "Make sure that after pro/demotion cursor position is right."
7013 (let ((pos (point)))
7014 (when (save-excursion
7015 (beginning-of-line 1)
7016 (looking-at org-todo-line-regexp)
7017 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7018 (cond ((eobp) (insert " "))
7019 ((eolp) (insert " "))
7020 ((equal (char-after) ?\ ) (forward-char 1))))))
7022 (defun org-current-level ()
7023 "Return the level of the current entry, or nil if before the first headline.
7024 The level is the number of stars at the beginning of the headline."
7025 (save-excursion
7026 (let ((outline-regexp (org-get-limited-outline-regexp)))
7027 (condition-case nil
7028 (progn
7029 (org-back-to-heading t)
7030 (funcall outline-level))
7031 (error nil)))))
7033 (defun org-get-previous-line-level ()
7034 "Return the outline depth of the last headline before the current line.
7035 Returns 0 for the first headline in the buffer, and nil if before the
7036 first headline."
7037 (let ((current-level (org-current-level))
7038 (prev-level (when (> (line-number-at-pos) 1)
7039 (save-excursion
7040 (beginning-of-line 0)
7041 (org-current-level)))))
7042 (cond ((null current-level) nil) ; Before first headline
7043 ((null prev-level) 0) ; At first headline
7044 (prev-level))))
7046 (defun org-reduced-level (l)
7047 "Compute the effective level of a heading.
7048 This takes into account the setting of `org-odd-levels-only'."
7049 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
7051 (defun org-level-increment ()
7052 "Return the number of stars that will be added or removed at a
7053 time to headlines when structure editing, based on the value of
7054 `org-odd-levels-only'."
7055 (if org-odd-levels-only 2 1))
7057 (defun org-get-valid-level (level &optional change)
7058 "Rectify a level change under the influence of `org-odd-levels-only'
7059 LEVEL is a current level, CHANGE is by how much the level should be
7060 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7061 even level numbers will become the next higher odd number."
7062 (if org-odd-levels-only
7063 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7064 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7065 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7066 (max 1 (+ level (or change 0)))))
7068 (if (boundp 'define-obsolete-function-alias)
7069 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7070 (define-obsolete-function-alias 'org-get-legal-level
7071 'org-get-valid-level)
7072 (define-obsolete-function-alias 'org-get-legal-level
7073 'org-get-valid-level "23.1")))
7075 (defun org-promote ()
7076 "Promote the current heading higher up the tree.
7077 If the region is active in `transient-mark-mode', promote all headings
7078 in the region."
7079 (org-back-to-heading t)
7080 (let* ((level (save-match-data (funcall outline-level)))
7081 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7082 (diff (abs (- level (length up-head) -1))))
7083 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7084 (replace-match up-head nil t)
7085 ;; Fixup tag positioning
7086 (and org-auto-align-tags (org-set-tags nil t))
7087 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7088 (run-hooks 'org-after-promote-entry-hook)))
7090 (defun org-demote ()
7091 "Demote the current heading lower down the tree.
7092 If the region is active in `transient-mark-mode', demote all headings
7093 in the region."
7094 (org-back-to-heading t)
7095 (let* ((level (save-match-data (funcall outline-level)))
7096 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7097 (diff (abs (- level (length down-head) -1))))
7098 (replace-match down-head nil t)
7099 ;; Fixup tag positioning
7100 (and org-auto-align-tags (org-set-tags nil t))
7101 (if org-adapt-indentation (org-fixup-indentation diff))
7102 (run-hooks 'org-after-demote-entry-hook)))
7104 (defun org-cycle-level ()
7105 "Cycle the level of an empty headline through possible states.
7106 This goes first to child, then to parent, level, then up the hierarchy.
7107 After top level, it switches back to sibling level."
7108 (interactive)
7109 (let ((org-adapt-indentation nil))
7110 (when (org-point-at-end-of-empty-headline)
7111 (setq this-command 'org-cycle-level) ; Only needed for caching
7112 (let ((cur-level (org-current-level))
7113 (prev-level (org-get-previous-line-level)))
7114 (cond
7115 ;; If first headline in file, promote to top-level.
7116 ((= prev-level 0)
7117 (loop repeat (/ (- cur-level 1) (org-level-increment))
7118 do (org-do-promote)))
7119 ;; If same level as prev, demote one.
7120 ((= prev-level cur-level)
7121 (org-do-demote))
7122 ;; If parent is top-level, promote to top level if not already.
7123 ((= prev-level 1)
7124 (loop repeat (/ (- cur-level 1) (org-level-increment))
7125 do (org-do-promote)))
7126 ;; If top-level, return to prev-level.
7127 ((= cur-level 1)
7128 (loop repeat (/ (- prev-level 1) (org-level-increment))
7129 do (org-do-demote)))
7130 ;; If less than prev-level, promote one.
7131 ((< cur-level prev-level)
7132 (org-do-promote))
7133 ;; If deeper than prev-level, promote until higher than
7134 ;; prev-level.
7135 ((> cur-level prev-level)
7136 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7137 do (org-do-promote))))
7138 t))))
7140 (defun org-map-tree (fun)
7141 "Call FUN for every heading underneath the current one."
7142 (org-back-to-heading)
7143 (let ((level (funcall outline-level)))
7144 (save-excursion
7145 (funcall fun)
7146 (while (and (progn
7147 (outline-next-heading)
7148 (> (funcall outline-level) level))
7149 (not (eobp)))
7150 (funcall fun)))))
7152 (defun org-map-region (fun beg end)
7153 "Call FUN for every heading between BEG and END."
7154 (let ((org-ignore-region t))
7155 (save-excursion
7156 (setq end (copy-marker end))
7157 (goto-char beg)
7158 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
7159 (< (point) end))
7160 (funcall fun))
7161 (while (and (progn
7162 (outline-next-heading)
7163 (< (point) end))
7164 (not (eobp)))
7165 (funcall fun)))))
7167 (defun org-fixup-indentation (diff)
7168 "Change the indentation in the current entry by DIFF.
7169 However, if any line in the current entry has no indentation, or if it
7170 would end up with no indentation after the change, nothing at all is done."
7171 (save-excursion
7172 (let ((end (save-excursion (outline-next-heading)
7173 (point-marker)))
7174 (prohibit (if (> diff 0)
7177 col)
7178 (unless (save-excursion (end-of-line 1)
7179 (re-search-forward prohibit end t))
7180 (while (and (< (point) end)
7182 (goto-char (match-end 0))
7183 (setq col (current-column))
7184 (if (< diff 0) (replace-match ""))
7185 (org-indent-to-column (+ diff col))))
7186 (move-marker end nil))))
7188 (defun org-convert-to-odd-levels ()
7189 "Convert an org-mode file with all levels allowed to one with odd levels.
7190 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7191 level 5 etc."
7192 (interactive)
7193 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7194 (let ((outline-regexp org-outline-regexp)
7195 (outline-level 'org-outline-level)
7196 (org-odd-levels-only nil) n)
7197 (save-excursion
7198 (goto-char (point-min))
7200 (setq n (- (length (match-string 0)) 2))
7201 (while (>= (setq n (1- n)) 0)
7202 (org-demote))
7203 (end-of-line 1))))))
7205 (defun org-convert-to-oddeven-levels ()
7206 "Convert an org-mode file with only odd levels to one with odd/even levels.
7207 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7208 file contains a section with an even level, conversion would
7209 destroy the structure of the file. An error is signaled in this
7210 case."
7211 (interactive)
7212 (goto-char (point-min))
7213 ;; First check if there are no even levels
7215 (org-show-context t)
7216 (error "Not all levels are odd in this file. Conversion not possible"))
7217 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7218 (let ((outline-regexp org-outline-regexp)
7219 (outline-level 'org-outline-level)
7220 (org-odd-levels-only nil) n)
7221 (save-excursion
7222 (goto-char (point-min))
7224 (setq n (/ (1- (length (match-string 0))) 2))
7225 (while (>= (setq n (1- n)) 0)
7226 (org-promote))
7227 (end-of-line 1))))))
7229 (defun org-tr-level (n)
7230 "Make N odd if required."
7231 (if org-odd-levels-only (1+ (/ n 2)) n))
7233 ;;; Vertical tree motion, cutting and pasting of subtrees
7235 (defun org-move-subtree-up (&optional arg)
7236 "Move the current subtree up past ARG headlines of the same level."
7237 (interactive "p")
7238 (org-move-subtree-down (- (prefix-numeric-value arg))))
7240 (defun org-move-subtree-down (&optional arg)
7241 "Move the current subtree down past ARG headlines of the same level."
7242 (interactive "p")
7243 (setq arg (prefix-numeric-value arg))
7244 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7245 'org-get-last-sibling))
7246 (ins-point (make-marker))
7247 (cnt (abs arg))
7248 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7249 ;; Select the tree
7250 (org-back-to-heading)
7251 (setq beg0 (point))
7252 (save-excursion
7253 (setq ne-beg (org-back-over-empty-lines))
7254 (setq beg (point)))
7255 (save-match-data
7256 (save-excursion (outline-end-of-heading)
7257 (setq folded (org-invisible-p)))
7258 (outline-end-of-subtree))
7259 (outline-next-heading)
7260 (setq ne-end (org-back-over-empty-lines))
7261 (setq end (point))
7262 (goto-char beg0)
7263 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7264 ;; include less whitespace
7265 (save-excursion
7266 (goto-char beg)
7267 (forward-line (- ne-beg ne-end))
7268 (setq beg (point))))
7269 ;; Find insertion point, with error handling
7270 (while (> cnt 0)
7271 (or (and (funcall movfunc) (looking-at outline-regexp))
7272 (progn (goto-char beg0)
7273 (error "Cannot move past superior level or buffer limit")))
7274 (setq cnt (1- cnt)))
7275 (if (> arg 0)
7276 ;; Moving forward - still need to move over subtree
7277 (progn (org-end-of-subtree t t)
7278 (save-excursion
7279 (org-back-over-empty-lines)
7280 (or (bolp) (newline)))))
7281 (setq ne-ins (org-back-over-empty-lines))
7282 (move-marker ins-point (point))
7283 (setq txt (buffer-substring beg end))
7284 (org-save-markers-in-region beg end)
7285 (delete-region beg end)
7286 (org-remove-empty-overlays-at beg)
7287 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7288 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7290 (let ((bbb (point)))
7291 (insert-before-markers txt)
7292 (org-reinstall-markers-in-region bbb)
7293 (move-marker ins-point bbb))
7295 (setq ins-end (point))
7296 (goto-char ins-point)
7297 (org-skip-whitespace)
7298 (when (and (< arg 0)
7299 (org-first-sibling-p)
7300 (> ne-ins ne-beg))
7301 ;; Move whitespace back to beginning
7302 (save-excursion
7303 (goto-char ins-end)
7304 (let ((kill-whole-line t))
7305 (kill-line (- ne-ins ne-beg)) (point)))
7307 (move-marker ins-point nil)
7308 (if folded
7309 (hide-subtree)
7310 (org-show-entry)
7311 (show-children)
7312 (org-cycle-hide-drawers 'children))
7313 (org-clean-visibility-after-subtree-move)))
7315 (defvar org-subtree-clip ""
7316 "Clipboard for cut and paste of subtrees.
7317 This is actually only a copy of the kill, because we use the normal kill
7318 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7320 (defvar org-subtree-clip-folded nil
7321 "Was the last copied subtree folded?
7322 This is used to fold the tree back after pasting.")
7324 (defun org-cut-subtree (&optional n)
7325 "Cut the current subtree into the clipboard.
7326 With prefix arg N, cut this many sequential subtrees.
7327 This is a short-hand for marking the subtree and then cutting it."
7328 (interactive "p")
7329 (org-copy-subtree n 'cut))
7331 (defun org-copy-subtree (&optional n cut force-store-markers)
7332 "Cut the current subtree into the clipboard.
7333 With prefix arg N, cut this many sequential subtrees.
7334 This is a short-hand for marking the subtree and then copying it.
7335 If CUT is non-nil, actually cut the subtree.
7336 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7337 of some markers in the region, even if CUT is non-nil. This is
7338 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7339 (interactive "p")
7340 (let (beg end folded (beg0 (point)))
7341 (if (interactive-p)
7342 (org-back-to-heading nil) ; take what looks like a subtree
7343 (org-back-to-heading t)) ; take what is really there
7344 (org-back-over-empty-lines)
7345 (setq beg (point))
7347 (save-match-data
7348 (save-excursion (outline-end-of-heading)
7349 (setq folded (org-invisible-p)))
7350 (condition-case nil
7351 (org-forward-same-level (1- n) t)
7352 (error nil))
7353 (org-end-of-subtree t t))
7354 (org-back-over-empty-lines)
7355 (setq end (point))
7356 (goto-char beg0)
7357 (when (> end beg)
7358 (setq org-subtree-clip-folded folded)
7359 (when (or cut force-store-markers)
7360 (org-save-markers-in-region beg end))
7361 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7362 (setq org-subtree-clip (current-kill 0))
7363 (message "%s: Subtree(s) with %d characters"
7364 (if cut "Cut" "Copied")
7365 (length org-subtree-clip)))))
7367 (defun org-paste-subtree (&optional level tree for-yank)
7368 "Paste the clipboard as a subtree, with modification of headline level.
7369 The entire subtree is promoted or demoted in order to match a new headline
7370 level.
7372 If the cursor is at the beginning of a headline, the same level as
7373 that headline is used to paste the tree
7375 If not, the new level is derived from the *visible* headings
7376 before and after the insertion point, and taken to be the inferior headline
7377 level of the two. So if the previous visible heading is level 3 and the
7378 next is level 4 (or vice versa), level 4 will be used for insertion.
7379 This makes sure that the subtree remains an independent subtree and does
7380 not swallow low level entries.
7382 You can also force a different level, either by using a numeric prefix
7383 argument, or by inserting the heading marker by hand. For example, if the
7386 If optional TREE is given, use this text instead of the kill ring.
7388 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7389 move back over whitespace before inserting, and move point to the end of
7390 the inserted text when done."
7391 (interactive "P")
7392 (setq tree (or tree (and kill-ring (current-kill 0))))
7393 (unless (org-kill-is-subtree-p tree)
7394 (error "%s"
7395 (substitute-command-keys
7397 (let* ((visp (not (org-invisible-p)))
7398 (txt tree)
7403 (old-level (if (string-match ^re txt)
7404 (- (match-end 0) (match-beginning 0) 1)
7405 -1))
7406 (force-level (cond (level (prefix-numeric-value level))
7408 (string-match
7409 ^re_ (buffer-substring
7410 (point-at-bol) (point))))
7411 (- (match-end 1) (match-beginning 1)))
7412 ((and (bolp)
7413 (looking-at org-outline-regexp))
7414 (- (match-end 0) (point) 1))
7415 (t nil)))
7416 (previous-level (save-excursion
7417 (condition-case nil
7418 (progn
7419 (outline-previous-visible-heading 1)
7420 (if (looking-at re)
7421 (- (match-end 0) (match-beginning 0) 1)
7422 1))
7423 (error 1))))
7424 (next-level (save-excursion
7425 (condition-case nil
7426 (progn
7427 (or (looking-at outline-regexp)
7428 (outline-next-visible-heading 1))
7429 (if (looking-at re)
7430 (- (match-end 0) (match-beginning 0) 1)
7431 1))
7432 (error 1))))
7433 (new-level (or force-level (max previous-level next-level)))
7434 (shift (if (or (= old-level -1)
7435 (= new-level -1)
7436 (= old-level new-level))
7437 0
7438 (- new-level old-level)))
7439 (delta (if (> shift 0) -1 1))
7440 (func (if (> shift 0) 'org-demote 'org-promote))
7441 (org-odd-levels-only nil)
7442 beg end newend)
7443 ;; Remove the forced level indicator
7444 (if force-level
7445 (delete-region (point-at-bol) (point)))
7446 ;; Paste
7447 (beginning-of-line 1)
7448 (unless for-yank (org-back-over-empty-lines))
7449 (setq beg (point))
7450 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7451 (insert-before-markers txt)
7453 (setq newend (point))
7454 (org-reinstall-markers-in-region beg)
7455 (setq end (point))
7456 (goto-char beg)
7458 (setq beg (point))
7459 (if (and (org-invisible-p) visp)
7460 (save-excursion (outline-show-heading)))
7461 ;; Shift if necessary
7462 (unless (= shift 0)
7463 (save-restriction
7464 (narrow-to-region beg end)
7465 (while (not (= shift 0))
7466 (org-map-region func (point-min) (point-max))
7467 (setq shift (+ delta shift)))
7468 (goto-char (point-min))
7469 (setq newend (point-max))))
7470 (when (or (interactive-p) for-yank)
7471 (message "Clipboard pasted as level %d subtree" new-level))
7472 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7473 kill-ring
7474 (eq org-subtree-clip (current-kill 0))
7475 org-subtree-clip-folded)
7476 ;; The tree was folded before it was killed/copied
7477 (hide-subtree))
7478 (and for-yank (goto-char newend))))
7480 (defun org-kill-is-subtree-p (&optional txt)
7481 "Check if the current kill is an outline subtree, or a set of trees.
7482 Returns nil if kill does not start with a headline, or if the first
7483 headline level is not the largest headline level in the tree.
7484 So this will actually accept several entries of equal levels as well,
7485 which is OK for `org-paste-subtree'.
7486 If optional TXT is given, check this string instead of the current kill."
7487 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7488 (start-level (and kill
7491 kill)
7492 (- (match-end 2) (match-beginning 2) 1)))
7493 (re (concat "^" org-outline-regexp))
7494 (start (1+ (or (match-beginning 2) -1))))
7495 (if (not start-level)
7496 (progn
7497 nil) ;; does not even start with a heading
7498 (catch 'exit
7499 (while (setq start (string-match re kill (1+ start)))
7500 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7501 (throw 'exit nil)))
7502 t))))
7504 (defvar org-markers-to-move nil
7505 "Markers that should be moved with a cut-and-paste operation.
7506 Those markers are stored together with their positions relative to
7507 the start of the region.")
7509 (defun org-save-markers-in-region (beg end)
7510 "Check markers in region.
7511 If these markers are between BEG and END, record their position relative
7512 to BEG, so that after moving the block of text, we can put the markers back
7513 into place.
7514 This function gets called just before an entry or tree gets cut from the
7515 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7516 called immediately, to move the markers with the entries."
7517 (setq org-markers-to-move nil)
7518 (when (featurep 'org-clock)
7519 (org-clock-save-markers-for-cut-and-paste beg end))
7520 (when (featurep 'org-agenda)
7521 (org-agenda-save-markers-for-cut-and-paste beg end)))
7523 (defun org-check-and-save-marker (marker beg end)
7524 "Check if MARKER is between BEG and END.
7525 If yes, remember the marker and the distance to BEG."
7526 (when (and (marker-buffer marker)
7527 (equal (marker-buffer marker) (current-buffer)))
7528 (if (and (>= marker beg) (< marker end))
7529 (push (cons marker (- marker beg)) org-markers-to-move))))
7531 (defun org-reinstall-markers-in-region (beg)
7532 "Move all remembered markers to their position relative to BEG."
7533 (mapc (lambda (x)
7534 (move-marker (car x) (+ beg (cdr x))))
7535 org-markers-to-move)
7536 (setq org-markers-to-move nil))
7538 (defun org-narrow-to-subtree ()
7539 "Narrow buffer to the current subtree."
7540 (interactive)
7541 (save-excursion
7542 (save-match-data
7543 (narrow-to-region
7544 (progn (org-back-to-heading t) (point))
7545 (progn (org-end-of-subtree t t)
7546 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7547 (point))))))
7549 (eval-when-compile
7550 (defvar org-property-drawer-re))
7552 (defvar org-property-start-re) ;; defined below
7553 (defun org-clone-subtree-with-time-shift (n &optional shift)
7554 "Clone the task (subtree) at point N times.
7555 The clones will be inserted as siblings.
7557 In interactive use, the user will be prompted for the number of
7558 clones to be produced, and for a time SHIFT, which may be a
7559 repeater as used in time stamps, for example `+3d'.
7561 When a valid repeater is given and the entry contains any time
7562 stamps, the clones will become a sequence in time, with time
7563 stamps in the subtree shifted for each clone produced. If SHIFT
7564 is nil or the empty string, time stamps will be left alone. The
7565 ID property of the original subtree is removed.
7567 If the original subtree did contain time stamps with a repeater,
7568 the following will happen:
7569 - the repeater will be removed in each clone
7570 - an additional clone will be produced, with the current, unshifted
7571 date(s) in the entry.
7572 - the original entry will be placed *after* all the clones, with
7573 repeater intact.
7574 - the start days in the repeater in the original entry will be shifted
7575 to past the last clone.
7576 I this way you can spell out a number of instances of a repeating task,
7577 and still retain the repeater to cover future instances of the task."
7578 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7579 (let (beg end template task idprop
7580 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7581 (if (not (and (integerp n) (> n 0)))
7582 (error "Invalid number of replications %s" n))
7585 shift)))
7586 (error "Invalid shift specification %s" shift))
7587 (when doshift
7588 (setq shift-n (string-to-number (match-string 1 shift))
7589 shift-what (cdr (assoc (match-string 2 shift)
7590 '(("d" . day) ("w" . week)
7591 ("m" . month) ("y" . year))))))
7592 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7593 (setq nmin 1 nmax n)
7594 (org-back-to-heading t)
7595 (setq beg (point))
7596 (setq idprop (org-entry-get nil "ID"))
7597 (org-end-of-subtree t t)
7599 (setq end (point))
7600 (setq template (buffer-substring beg end))
7601 (when (and doshift
7603 (delete-region beg end)
7604 (setq end beg)
7605 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7606 (goto-char end)
7607 (loop for n from nmin to nmax do
7608 ;; prepare clone
7609 (with-temp-buffer
7610 (insert template)
7611 (org-mode)
7612 (goto-char (point-min))
7613 (and idprop (if org-clone-delete-id
7614 (org-entry-delete nil "ID")
7615 (org-id-get-create t)))
7616 (while (re-search-forward org-property-start-re nil t)
7617 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7618 (goto-char (point-min))
7619 (when doshift
7620 (while (re-search-forward org-ts-regexp-both nil t)
7621 (org-timestamp-change (* n shift-n) shift-what))
7622 (unless (= n n-no-remove)
7623 (goto-char (point-min))
7624 (while (re-search-forward org-ts-regexp nil t)
7625 (save-excursion
7626 (goto-char (match-beginning 0))
7628 (delete-region (match-beginning 1) (match-end 1)))))))
7629 (setq task (buffer-string)))
7630 (insert task))
7631 (goto-char beg)))
7633 ;;; Outline Sorting
7635 (defun org-sort (with-case)
7636 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7637 Optional argument WITH-CASE means sort case-sensitively.
7638 With a double prefix argument, also remove duplicate entries."
7639 (interactive "P")
7640 (cond
7641 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7642 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7643 (t
7644 (org-call-with-arg 'org-sort-entries with-case))))
7646 (defun org-sort-remove-invisible (s)
7647 (remove-text-properties 0 (length s) org-rm-props s)
7648 (while (string-match org-bracket-link-regexp s)
7649 (setq s (replace-match (if (match-end 2)
7650 (match-string 3 s)
7651 (match-string 1 s)) t t s)))
7652 s)
7654 (defvar org-priority-regexp) ; defined later in the file
7656 (defvar org-after-sorting-entries-or-items-hook nil
7657 "Hook that is run after a bunch of entries or items have been sorted.
7658 When children are sorted, the cursor is in the parent line when this
7659 hook gets called. When a region or a plain list is sorted, the cursor
7660 will be in the first entry of the sorted region/list.")
7662 (defun org-sort-entries
7663 (&optional with-case sorting-type getkey-func compare-func property)
7664 "Sort entries on a certain level of an outline tree.
7665 If there is an active region, the entries in the region are sorted.
7666 Else, if the cursor is before the first entry, sort the top-level items.
7667 Else, the children of the entry at point are sorted.
7669 Sorting can be alphabetically, numerically, by date/time as given by
7670 a time stamp, by a property or by priority.
7672 The command prompts for the sorting type unless it has been given to the
7673 function through the SORTING-TYPE argument, which needs to be a character,
7674 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7675 precise meaning of each character:
7677 n Numerically, by converting the beginning of the entry/item to a number.
7678 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7679 t By date/time, either the first active time stamp in the entry, or, if
7680 none exist, by the first inactive one.
7681 s By the scheduled date/time.
7682 d By deadline date/time.
7683 c By creation time, which is assumed to be the first inactive time stamp
7684 at the beginning of a line.
7685 p By priority according to the cookie.
7686 r By the value of a property.
7688 Capital letters will reverse the sort order.
7690 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7691 called with point at the beginning of the record. It must return either
7692 a string or a number that should serve as the sorting key for that record.
7694 Comparing entries ignores case by default. However, with an optional argument
7695 WITH-CASE, the sorting considers case as well."
7696 (interactive "P")
7697 (let ((case-func (if with-case 'identity 'downcase))
7698 start beg end stars re re2
7699 txt what tmp)
7700 ;; Find beginning and end of region to sort
7701 (cond
7702 ((org-region-active-p)
7703 ;; we will sort the region
7704 (setq end (region-end)
7705 what "region")
7706 (goto-char (region-beginning))
7707 (if (not (org-on-heading-p)) (outline-next-heading))
7708 (setq start (point)))
7709 ((or (org-on-heading-p)
7710 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7711 ;; we will sort the children of the current headline
7712 (org-back-to-heading)
7713 (setq start (point)
7714 end (progn (org-end-of-subtree t t)
7716 (org-back-over-empty-lines)
7717 (point))
7718 what "children")
7719 (goto-char start)
7720 (show-subtree)
7721 (outline-next-heading))
7722 (t
7723 ;; we will sort the top-level entries in this file
7724 (goto-char (point-min))
7725 (or (org-on-heading-p) (outline-next-heading))
7726 (setq start (point))
7727 (goto-char (point-max))
7728 (beginning-of-line 1)
7730 ;; File ends in a non-white line
7731 (end-of-line 1)
7733 (setq end (point-max))
7734 (setq what "top-level")
7735 (goto-char start)
7736 (show-all)))
7738 (setq beg (point))
7739 (if (>= beg end) (error "Nothing to sort"))
7742 (setq stars (match-string 1)
7743 re (concat "^" (regexp-quote stars) " +")
7744 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
7745 txt (buffer-substring beg end))
7747 (if (and (not (equal stars "*")) (string-match re2 txt))
7748 (error "Region to sort contains a level above the first entry"))
7750 (unless sorting-type
7751 (message
7752 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7754 A/N/T/S/D/C/P/O/F means reversed:"
7755 what)
7756 (setq sorting-type (read-char-exclusive))
7758 (and (= (downcase sorting-type) ?f)
7759 (setq getkey-func
7760 (org-icompleting-read "Sort using function: "
7761 obarray 'fboundp t nil nil))
7762 (setq getkey-func (intern getkey-func)))
7764 (and (= (downcase sorting-type) ?r)
7765 (setq property
7766 (org-icompleting-read "Property: "
7767 (mapcar 'list (org-buffer-property-keys t))
7768 nil t))))
7770 (message "Sorting entries...")
7772 (save-restriction
7773 (narrow-to-region start end)
7774 (let ((dcst (downcase sorting-type))
7775 (case-fold-search nil)
7776 (now (current-time)))
7777 (sort-subr
7778 (/= dcst sorting-type)
7779 ;; This function moves to the beginning character of the "record" to
7780 ;; be sorted.
7781 (lambda nil
7782 (if (re-search-forward re nil t)
7783 (goto-char (match-beginning 0))
7784 (goto-char (point-max))))
7785 ;; This function moves to the last character of the "record" being
7786 ;; sorted.
7787 (lambda nil
7788 (save-match-data
7789 (condition-case nil
7790 (outline-forward-same-level 1)
7791 (error
7792 (goto-char (point-max))))))
7793 ;; This function returns the value that gets sorted against.
7794 (lambda nil
7795 (cond
7796 ((= dcst ?n)
7797 (if (looking-at org-complex-heading-regexp)
7798 (string-to-number (match-string 4))
7799 nil))
7800 ((= dcst ?a)
7801 (if (looking-at org-complex-heading-regexp)
7802 (funcall case-func (match-string 4))
7803 nil))
7804 ((= dcst ?t)
7805 (let ((end (save-excursion (outline-next-heading) (point))))
7806 (if (or (re-search-forward org-ts-regexp end t)
7807 (re-search-forward org-ts-regexp-both end t))
7808 (org-time-string-to-seconds (match-string 0))
7809 (org-float-time now))))
7810 ((= dcst ?c)
7811 (let ((end (save-excursion (outline-next-heading) (point))))
7812 (if (re-search-forward
7814 end t)
7815 (org-time-string-to-seconds (match-string 0))
7816 (org-float-time now))))
7817 ((= dcst ?s)
7818 (let ((end (save-excursion (outline-next-heading) (point))))
7819 (if (re-search-forward org-scheduled-time-regexp end t)
7820 (org-time-string-to-seconds (match-string 1))
7821 (org-float-time now))))
7822 ((= dcst ?d)
7823 (let ((end (save-excursion (outline-next-heading) (point))))
7824 (if (re-search-forward org-deadline-time-regexp end t)
7825 (org-time-string-to-seconds (match-string 1))
7826 (org-float-time now))))
7827 ((= dcst ?p)
7828 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7829 (string-to-char (match-string 2))
7830 org-default-priority))
7831 ((= dcst ?r)
7832 (or (org-entry-get nil property) ""))
7833 ((= dcst ?o)
7834 (if (looking-at org-complex-heading-regexp)
7835 (- 9999 (length (member (match-string 2)
7836 org-todo-keywords-1)))))
7837 ((= dcst ?f)
7838 (if getkey-func
7839 (progn
7840 (setq tmp (funcall getkey-func))
7841 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7842 tmp)
7843 (error "Invalid key function `%s'" getkey-func)))
7844 (t (error "Invalid sorting type `%c'" sorting-type))))
7845 nil
7846 (cond
7847 ((= dcst ?a) 'string<)
7848 ((= dcst ?f) compare-func)
7849 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7850 (t nil)))))
7851 (run-hooks 'org-after-sorting-entries-or-items-hook)
7852 (message "Sorting entries...done")))
7854 (defun org-do-sort (table what &optional with-case sorting-type)
7855 "Sort TABLE of WHAT according to SORTING-TYPE.
7856 The user will be prompted for the SORTING-TYPE if the call to this
7857 function does not specify it. WHAT is only for the prompt, to indicate
7858 what is being sorted. The sorting key will be extracted from
7859 the car of the elements of the table.
7860 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7861 (unless sorting-type
7862 (message
7863 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7864 what)
7865 (setq sorting-type (read-char-exclusive)))
7866 (let ((dcst (downcase sorting-type))
7867 extractfun comparefun)
7868 ;; Define the appropriate functions
7869 (cond
7870 ((= dcst ?n)
7871 (setq extractfun 'string-to-number
7872 comparefun (if (= dcst sorting-type) '< '>)))
7873 ((= dcst ?a)
7874 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7875 (lambda(x) (downcase (org-sort-remove-invisible x))))
7876 comparefun (if (= dcst sorting-type)
7877 'string<
7878 (lambda (a b) (and (not (string< a b))
7879 (not (string= a b)))))))
7880 ((= dcst ?t)
7881 (setq extractfun
7882 (lambda (x)
7883 (if (or (string-match org-ts-regexp x)
7884 (string-match org-ts-regexp-both x))
7885 (org-float-time
7886 (org-time-string-to-time (match-string 0 x)))
7887 0))
7888 comparefun (if (= dcst sorting-type) '< '>)))
7889 (t (error "Invalid sorting type `%c'" sorting-type)))
7891 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7892 table)
7893 (lambda (a b) (funcall comparefun (car a) (car b))))))
7896 ;;; The orgstruct minor mode
7898 ;; Define a minor mode which can be used in other modes in order to
7899 ;; integrate the org-mode structure editing commands.
7901 ;; This is really a hack, because the org-mode structure commands use
7902 ;; keys which normally belong to the major mode. Here is how it
7903 ;; works: The minor mode defines all the keys necessary to operate the
7904 ;; structure commands, but wraps the commands into a function which
7905 ;; tests if the cursor is currently at a headline or a plain list
7906 ;; item. If that is the case, the structure command is used,
7907 ;; temporarily setting many Org-mode variables like regular
7908 ;; expressions for filling etc. However, when any of those keys is
7909 ;; used at a different location, function uses `key-binding' to look
7910 ;; up if the key has an associated command in another currently active
7911 ;; keymap (minor modes, major mode, global), and executes that
7912 ;; command. There might be problems if any of the keys is otherwise
7913 ;; used as a prefix key.
7915 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7916 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7917 ;; addresses this by checking explicitly for both bindings.
7919 (defvar orgstruct-mode-map (make-sparse-keymap)
7920 "Keymap for the minor `orgstruct-mode'.")
7922 (defvar org-local-vars nil
7923 "List of local variables, for use by `orgstruct-mode'.")
7925 ;;;###autoload
7926 (define-minor-mode orgstruct-mode
7927 "Toggle the minor mode `orgstruct-mode'.
7928 This mode is for using Org-mode structure commands in other
7929 modes. The following keys behave as if Org-mode were active, if
7930 the cursor is on a headline, or on a plain list item (both as
7931 defined by Org-mode).
7933 M-up Move entry/item up
7934 M-down Move entry/item down
7935 M-left Promote
7936 M-right Demote
7937 M-S-up Move entry/item up
7938 M-S-down Move entry/item down
7939 M-S-left Promote subtree
7940 M-S-right Demote subtree
7941 M-q Fill paragraph and items like in Org-mode
7942 C-c ^ Sort entries
7943 C-c - Cycle list bullet
7944 TAB Cycle item visibility
7945 M-RET Insert new heading/item
7946 S-M-RET Insert new TODO heading / Checkbox item
7947 C-c C-c Set tags / toggle checkbox"
7948 nil " OrgStruct" nil
7949 (org-load-modules-maybe)
7950 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7952 ;;;###autoload
7953 (defun turn-on-orgstruct ()
7954 "Unconditionally turn on `orgstruct-mode'."
7955 (orgstruct-mode 1))
7957 (defun orgstruct++-mode (&optional arg)
7958 "Toggle `orgstruct-mode', the enhanced version of it.
7959 In addition to setting orgstruct-mode, this also exports all indentation
7960 and autofilling variables from org-mode into the buffer. It will also
7961 recognize item context in multiline items.
7962 Note that turning off orgstruct-mode will *not* remove the
7963 indentation/paragraph settings. This can only be done by refreshing the
7965 (interactive "P")
7966 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
7967 (if (< arg 1)
7968 (orgstruct-mode -1)
7969 (orgstruct-mode 1)
7970 (let (var val)
7971 (mapc
7972 (lambda (x)
7973 (when (string-match
7975 (symbol-name (car x)))
7976 (setq var (car x) val (nth 1 x))
7977 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7978 org-local-vars)
7979 (org-set-local 'orgstruct-is-++ t))))
7981 (defvar orgstruct-is-++ nil
7982 "Is `orgstruct-mode' in ++ version in the current-buffer?")
7983 (make-variable-buffer-local 'orgstruct-is-++)
7985 ;;;###autoload
7986 (defun turn-on-orgstruct++ ()
7987 "Unconditionally turn on `orgstruct++-mode'."
7988 (orgstruct++-mode 1))
7990 (defun orgstruct-error ()
7991 "Error when there is no default binding for a structure key."
7992 (interactive)
7993 (error "This key has no function outside structure elements"))
7995 (defun orgstruct-setup ()
7996 "Setup orgstruct keymaps."
7997 (let ((nfunc 0)
7998 (bindings
7999 (list
8000 '([(meta up)] org-metaup)
8001 '([(meta down)] org-metadown)
8002 '([(meta left)] org-metaleft)
8003 '([(meta right)] org-metaright)
8004 '([(meta shift up)] org-shiftmetaup)
8005 '([(meta shift down)] org-shiftmetadown)
8006 '([(meta shift left)] org-shiftmetaleft)
8007 '([(meta shift right)] org-shiftmetaright)
8008 '([?\e (up)] org-metaup)
8009 '([?\e (down)] org-metadown)
8010 '([?\e (left)] org-metaleft)
8011 '([?\e (right)] org-metaright)
8012 '([?\e (shift up)] org-shiftmetaup)
8013 '([?\e (shift down)] org-shiftmetadown)
8014 '([?\e (shift left)] org-shiftmetaleft)
8015 '([?\e (shift right)] org-shiftmetaright)
8016 '([(shift up)] org-shiftup)
8017 '([(shift down)] org-shiftdown)
8018 '([(shift left)] org-shiftleft)
8019 '([(shift right)] org-shiftright)
8020 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8021 '("\M-q" fill-paragraph)
8022 '("\C-c^" org-sort)
8023 '("\C-c-" org-cycle-list-bullet)))
8024 elt key fun cmd)
8025 (while (setq elt (pop bindings))
8026 (setq nfunc (1+ nfunc))
8027 (setq key (org-key (car elt))
8028 fun (nth 1 elt)
8029 cmd (orgstruct-make-binding fun nfunc key))
8030 (org-defkey orgstruct-mode-map key cmd))
8032 ;; Special treatment needed for TAB and RET
8033 (org-defkey orgstruct-mode-map [(tab)]
8034 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8035 (org-defkey orgstruct-mode-map "\C-i"
8036 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8038 (org-defkey orgstruct-mode-map "\M-\C-m"
8039 (orgstruct-make-binding 'org-insert-heading 105
8040 "\M-\C-m" [(meta return)]))
8041 (org-defkey orgstruct-mode-map [(meta return)]
8042 (orgstruct-make-binding 'org-insert-heading 106
8043 [(meta return)] "\M-\C-m"))
8045 (org-defkey orgstruct-mode-map [(shift meta return)]
8046 (orgstruct-make-binding 'org-insert-todo-heading 107
8047 [(meta return)] "\M-\C-m"))
8049 (org-defkey orgstruct-mode-map "\e\C-m"
8050 (orgstruct-make-binding 'org-insert-heading 108
8051 "\e\C-m" [?\e (return)]))
8052 (org-defkey orgstruct-mode-map [?\e (return)]
8053 (orgstruct-make-binding 'org-insert-heading 109
8054 [?\e (return)] "\e\C-m"))
8055 (org-defkey orgstruct-mode-map [?\e (shift return)]
8056 (orgstruct-make-binding 'org-insert-todo-heading 110
8057 [?\e (return)] "\e\C-m"))
8059 (unless org-local-vars
8060 (setq org-local-vars (org-get-local-variables)))
8062 t))
8064 (defun orgstruct-make-binding (fun n &rest keys)
8065 "Create a function for binding in the structure minor mode.
8066 FUN is the command to call inside a table. N is used to create a unique
8067 command name. KEYS are keys that should be checked in for a command
8068 to execute outside of tables."
8069 (eval
8070 (list 'defun
8071 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8072 '(arg)
8074 "Outside of structure, run the binding of `"
8075 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8076 "'.")
8077 '(interactive "p")
8078 (list 'if
8079 `(org-context-p 'headline 'item
8080 (and orgstruct-is-++
8081 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8082 'item-body))
8083 (list 'org-run-like-in-org-mode (list 'quote fun))
8084 (list 'let '(orgstruct-mode)
8085 (list 'call-interactively
8086 (append '(or)
8087 (mapcar (lambda (k)
8088 (list 'key-binding k))
8089 keys)
8090 '('orgstruct-error))))))))
8092 (defun org-context-p (&rest contexts)
8093 "Check if local context is any of CONTEXTS.
8094 Possible values in the list of contexts are `table', `headline', and `item'."
8095 (let ((pos (point)))
8096 (goto-char (point-at-bol))
8097 (prog1 (or (and (memq 'table contexts)
8099 (and (memq 'headline contexts)
8101 (looking-at outline-regexp))
8102 (and (memq 'item contexts)
8104 (and (memq 'item-body contexts)
8105 (org-in-item-p)))
8106 (goto-char pos))))
8108 (defun org-get-local-variables ()
8109 "Return a list of all local variables in an org-mode buffer."
8110 (let (varlist)
8111 (with-current-buffer (get-buffer-create "*Org tmp*")
8112 (erase-buffer)
8113 (org-mode)
8114 (setq varlist (buffer-local-variables)))
8115 (kill-buffer "*Org tmp*")
8116 (delq nil
8117 (mapcar
8118 (lambda (x)
8119 (setq x
8120 (if (symbolp x)
8121 (list x)
8122 (list (car x) (list 'quote (cdr x)))))
8123 (if (string-match
8124 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8125 (symbol-name (car x)))
8126 x nil))
8127 varlist))))
8129 ;;;###autoload
8130 (defun org-run-like-in-org-mode (cmd)
8131 "Run a command, pretending that the current buffer is in Org-mode.
8132 This will temporarily bind local variables that are typically bound in
8133 Org-mode to the values they have in Org-mode, and then interactively
8134 call CMD."
8135 (org-load-modules-maybe)
8136 (unless org-local-vars
8137 (setq org-local-vars (org-get-local-variables)))
8138 (eval (list 'let org-local-vars
8139 (list 'call-interactively (list 'quote cmd)))))
8141 ;;;; Archiving
8143 (defun org-get-category (&optional pos)
8144 "Get the category applying to position POS."
8145 (get-text-property (or pos (point)) 'org-category))
8147 (defun org-refresh-category-properties ()
8148 "Refresh category text properties in the buffer."
8149 (let ((def-cat (cond
8150 ((null org-category)
8151 (if buffer-file-name
8152 (file-name-sans-extension
8153 (file-name-nondirectory buffer-file-name))
8154 "???"))
8155 ((symbolp org-category) (symbol-name org-category))
8156 (t org-category)))
8157 beg end cat pos optionp)
8158 (org-unmodified
8159 (save-excursion
8160 (save-restriction
8161 (widen)
8162 (goto-char (point-min))
8163 (put-text-property (point) (point-max) 'org-category def-cat)
8164 (while (re-search-forward
8166 (setq pos (match-end 0)
8167 optionp (equal (char-after (match-beginning 0)) ?#)
8168 cat (org-trim (match-string 2)))
8169 (if optionp
8170 (setq beg (point-at-bol) end (point-max))
8171 (org-back-to-heading t)
8172 (setq beg (point) end (org-end-of-subtree t t)))
8173 (put-text-property beg end 'org-category cat)
8174 (goto-char pos)))))))
8177 ;;;; Link Stuff
8179 ;;; Link abbreviations
8181 (defun org-link-expand-abbrev (link)
8182 "Apply replacements as defined in `org-link-abbrev-alist."
8184 (let* ((key (match-string 1 link))
8185 (as (or (assoc key org-link-abbrev-alist-local)
8186 (assoc key org-link-abbrev-alist)))
8187 (tag (and (match-end 2) (match-string 3 link)))
8188 rpl)
8189 (if (not as)
8190 link
8191 (setq rpl (cdr as))
8192 (cond
8193 ((symbolp rpl) (funcall rpl tag))
8194 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8195 ((string-match "%h" rpl)
8196 (replace-match (url-hexify-string (or tag "")) t t rpl))
8197 (t (concat rpl tag)))))
8198 link))
8200 ;;; Storing and inserting links
8202 (defvar org-insert-link-history nil
8203 "Minibuffer history for links inserted with `org-insert-link'.")
8205 (defvar org-stored-links nil
8206 "Contains the links stored with `org-store-link'.")
8208 (defvar org-store-link-plist nil
8209 "Plist with info about the most recently link created with `org-store-link'.")
8211 (defvar org-link-protocols nil
8212 "Link protocols added to Org-mode using `org-add-link-type'.")
8214 (defvar org-store-link-functions nil
8215 "List of functions that are called to create and store a link.
8216 Each function will be called in turn until one returns a non-nil
8217 value. Each function should check if it is responsible for creating
8218 this link (for example by looking at the major mode).
8219 If not, it must exit and return nil.
8220 If yes, it should return a non-nil value after a calling
8221 `org-store-link-props' with a list of properties and values.
8222 Special properties are:
8226 This is obligatory as well.
8227 :description Optional default description for the second pair
8228 of brackets in an Org-mode link. The user can still change
8229 this when inserting this link into an Org-mode buffer.
8231 In addition to these, any additional properties can be specified
8232 and then used in remember templates.")
8234 (defun org-add-link-type (type &optional follow export)
8235 "Add TYPE to the list of `org-link-types'.
8236 Re-compute all regular expressions depending on `org-link-types'
8238 FOLLOW and EXPORT are two functions.
8240 FOLLOW should take the link path as the single argument and do whatever
8241 is necessary to follow the link, for example find a file or display
8242 a mail message.
8244 EXPORT should format the link path for export to one of the export formats.
8245 It should be a function accepting three arguments:
8248 desc the description of the link, if any, nil if there was no description
8249 format the export format, a symbol like `html' or `latex' or `ascii'..
8251 The function may use the FORMAT information to return different values
8252 depending on the format. The return value will be put literally into
8253 the exported file. If the return value is nil, this means Org should
8254 do what it normally does with links which do not have EXPORT defined.
8256 Org-mode has a built-in default for exporting links. If you are happy with
8257 this default, there is no need to define an export function for the link
8258 type. For a simple example of an export function, see `org-bbdb.el'."
8259 (add-to-list 'org-link-types type t)
8260 (org-make-link-regexps)
8261 (if (assoc type org-link-protocols)
8262 (setcdr (assoc type org-link-protocols) (list follow export))
8263 (push (list type follow export) org-link-protocols)))
8265 (defvar org-agenda-buffer-name)
8267 ;;;###autoload
8268 (defun org-store-link (arg)
8270 This link is added to `org-stored-links' and can later be inserted
8273 For some link types, a prefix arg is interpreted:
8274 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8275 For file links, arg negates `org-context-in-file-links'."
8276 (interactive "P")
8277 (org-load-modules-maybe)
8278 (setq org-store-link-plist nil) ; reset
8279 (let ((outline-regexp (org-get-limited-outline-regexp))
8280 link cpltxt desc description search txt custom-id agenda-link)
8281 (cond
8283 ((run-hook-with-args-until-success 'org-store-link-functions)
8284 (setq link (plist-get org-store-link-plist :link)
8285 desc (or (plist-get org-store-link-plist :description) link)))
8287 ((equal (buffer-name) "*Org Edit Src Example*")
8288 (let (label gc)
8289 (while (or (not label)
8290 (save-excursion
8291 (save-restriction
8292 (widen)
8293 (goto-char (point-min))
8294 (re-search-forward
8295 (regexp-quote (format org-coderef-label-format label))
8296 nil t))))
8297 (when label (message "Label exists already") (sit-for 2))
8298 (setq label (read-string "Code line label: " label)))
8299 (end-of-line 1)
8300 (setq link (format org-coderef-label-format label))
8301 (setq gc (- 79 (length link)))
8302 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8303 (insert link)
8304 (setq link (concat "(" label ")") desc nil)))
8306 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8307 ;; We are in the agenda, link to referenced location
8308 (let ((m (or (get-text-property (point) 'org-hd-marker)
8309 (get-text-property (point) 'org-marker))))
8310 (when m
8311 (org-with-point-at m
8312 (setq agenda-link
8313 (if (interactive-p)
8314 (call-interactively 'org-store-link)
8315 (org-store-link nil)))))))
8317 ((eq major-mode 'calendar-mode)
8318 (let ((cd (calendar-cursor-to-date)))
8319 (setq link
8320 (format-time-string
8321 (car org-time-stamp-formats)
8322 (apply 'encode-time
8323 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8324 nil nil nil))))
8325 (org-store-link-props :type "calendar" :date cd)))
8327 ((eq major-mode 'w3-mode)
8328 (setq cpltxt (if (and (buffer-name)
8329 (not (string-match "Untitled" (buffer-name))))
8330 (buffer-name)
8331 (url-view-url t))
8332 link (org-make-link (url-view-url t)))
8333 (org-store-link-props :type "w3" :url (url-view-url t)))
8335 ((eq major-mode 'w3m-mode)
8336 (setq cpltxt (or w3m-current-title w3m-current-url)
8337 link (org-make-link w3m-current-url))
8338 (org-store-link-props :type "w3m" :url (url-view-url t)))
8340 ((setq search (run-hook-with-args-until-success
8341 'org-create-file-search-functions))
8342 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8343 "::" search))
8344 (setq cpltxt (or description link)))
8346 ((eq major-mode 'image-mode)
8347 (setq cpltxt (concat "file:"
8348 (abbreviate-file-name buffer-file-name))
8349 link (org-make-link cpltxt))
8350 (org-store-link-props :type "image" :file buffer-file-name))
8352 ((eq major-mode 'dired-mode)
8353 ;; link to the file in the current line
8354 (let ((file (dired-get-filename nil t)))
8355 (setq file (if file
8356 (abbreviate-file-name
8357 (expand-file-name (dired-get-filename nil t)))
8358 ;; otherwise, no file so use current directory.
8359 default-directory))
8360 (setq cpltxt (concat "file:" file)
8361 link (org-make-link cpltxt))))
8363 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8364 (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
8365 (cond
8367 (setq cpltxt
8368 (concat "file:"
8369 (abbreviate-file-name
8370 (buffer-file-name (buffer-base-buffer)))
8371 "::" (match-string 1))
8372 link (org-make-link cpltxt)))
8373 ((and (featurep 'org-id)
8374 (or (eq org-link-to-org-use-id t)
8375 (and (eq org-link-to-org-use-id 'create-if-interactive)
8376 (interactive-p))
8377 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
8378 (interactive-p)
8379 (not custom-id))
8380 (and org-link-to-org-use-id
8381 (condition-case nil
8382 (org-entry-get nil "ID")
8383 (error nil)))))
8384 ;; We can make a link using the ID.
8385 (setq link (condition-case nil
8386 (prog1 (org-id-store-link)
8387 (setq desc (plist-get org-store-link-plist
8388 :description)))
8389 (error
8390 ;; probably before first headline, link to file only
8391 (concat "file:"
8392 (abbreviate-file-name
8393 (buffer-file-name (buffer-base-buffer))))))))
8394 (t
8395 ;; Just link to current headline
8396 (setq cpltxt (concat "file:"
8397 (abbreviate-file-name
8398 (buffer-file-name (buffer-base-buffer)))))
8399 ;; Add a context search string
8400 (when (org-xor org-context-in-file-links arg)
8401 (setq txt (cond
8402 ((org-on-heading-p) nil)
8403 ((org-region-active-p)
8404 (buffer-substring (region-beginning) (region-end)))
8405 (t nil)))
8407 (setq cpltxt
8408 (concat cpltxt "::"
8409 (condition-case nil
8410 (org-make-org-heading-search-string txt)
8411 (error "")))
8412 desc (or (nth 4 (ignore-errors
8413 (org-heading-components))) "NONE"))))
8415 (setq cpltxt (substring cpltxt 0 -2)))
8416 (setq link (org-make-link cpltxt)))))
8418 ((buffer-file-name (buffer-base-buffer))
8419 ;; Just link to this file here.
8420 (setq cpltxt (concat "file:"
8421 (abbreviate-file-name
8422 (buffer-file-name (buffer-base-buffer)))))
8423 ;; Add a context string
8424 (when (org-xor org-context-in-file-links arg)
8425 (setq txt (if (org-region-active-p)
8426 (buffer-substring (region-beginning) (region-end))
8427 (buffer-substring (point-at-bol) (point-at-eol))))
8428 ;; Only use search option if there is some text.
8430 (setq cpltxt
8431 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8432 desc "NONE")))
8433 (setq link (org-make-link cpltxt)))
8435 ((interactive-p)
8436 (error "Cannot link to a buffer which is not visiting a file"))
8438 (t (setq link nil)))
8440 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8441 (setq link (or link cpltxt)
8442 desc (or desc cpltxt))
8443 (if (equal desc "NONE") (setq desc nil))
8445 (if (and (or (interactive-p) executing-kbd-macro) link)
8446 (progn
8447 (setq org-stored-links
8448 (cons (list link desc) org-stored-links))
8449 (message "Stored: %s" (or desc link))
8450 (when custom-id
8451 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8452 "::#" custom-id))
8453 (setq org-stored-links
8454 (cons (list link desc) org-stored-links))))
8455 (or agenda-link (and link (org-make-link-string link desc))))))
8457 (defun org-store-link-props (&rest plist)
8458 "Store link properties, extract names and addresses."
8459 (let (x adr)
8460 (when (setq x (plist-get plist :from))
8461 (setq adr (mail-extract-address-components x))
8462 (setq plist (plist-put plist :fromname (car adr)))
8463 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8464 (when (setq x (plist-get plist :to))
8465 (setq adr (mail-extract-address-components x))
8466 (setq plist (plist-put plist :toname (car adr)))
8467 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8468 (let ((from (plist-get plist :from))
8469 (to (plist-get plist :to)))
8470 (when (and from to org-from-is-user-regexp)
8471 (setq plist
8472 (plist-put plist :fromto
8473 (if (string-match org-from-is-user-regexp from)
8474 (concat "to %t")
8475 (concat "from %f"))))))
8476 (setq org-store-link-plist plist))
8478 (defun org-add-link-props (&rest plist)
8479 "Add these properties to the link property list."
8480 (let (key value)
8481 (while plist
8482 (setq key (pop plist) value (pop plist))
8483 (setq org-store-link-plist
8484 (plist-put org-store-link-plist key value)))))
8486 (defun org-email-link-description (&optional fmt)
8487 "Return the description part of an email link.
8488 This takes information from `org-store-link-plist' and formats it
8489 according to FMT (default from `org-email-link-description-format')."
8490 (setq fmt (or fmt org-email-link-description-format))
8491 (let* ((p org-store-link-plist)
8492 (to (plist-get p :toaddress))
8493 (from (plist-get p :fromaddress))
8494 (table
8495 (list
8496 (cons "%c" (plist-get p :fromto))
8497 (cons "%F" (plist-get p :from))
8498 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8499 (cons "%T" (plist-get p :to))
8500 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8501 (cons "%s" (plist-get p :subject))
8502 (cons "%d" (plist-get p :date))
8503 (cons "%m" (plist-get p :message-id)))))
8504 (when (string-match "%c" fmt)
8505 ;; Check if the user wrote this message
8506 (if (and org-from-is-user-regexp from to
8507 (save-match-data (string-match org-from-is-user-regexp from)))
8508 (setq fmt (replace-match "to %t" t t fmt))
8509 (setq fmt (replace-match "from %f" t t fmt))))
8510 (org-replace-escapes fmt table)))
8512 (defun org-make-org-heading-search-string (&optional string heading)
8513 "Make search string for STRING or current headline."
8514 (interactive)
8515 (let ((s (or string (org-get-heading)))
8516 (lines org-context-in-file-links))
8517 (unless (and string (not heading))
8518 ;; We are using a headline, clean up garbage in there.
8519 (if (string-match org-todo-regexp s)
8520 (setq s (replace-match "" t t s)))
8522 (setq s (replace-match "" t t s)))
8523 (setq s (org-trim s))
8526 (setq s (replace-match "" t t s)))
8527 (while (string-match org-ts-regexp s)
8528 (setq s (replace-match "" t t s))))
8529 (or string (setq s (concat "*" s))) ; Add * for headlines
8530 (when (and string (integerp lines) (> lines 0))
8532 (when (< lines (length slines))
8533 (setq s (mapconcat
8534 'identity
8535 (reverse (nthcdr (- (length slines) lines)
8539 (defun org-make-link (&rest strings)
8540 "Concatenate STRINGS."
8541 (apply 'concat strings))
8543 (defun org-make-link-string (link &optional description)
8544 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8546 (error "Empty link"))
8547 (when (and description
8548 (stringp description)
8550 (setq description nil))
8551 (when (stringp description)
8552 ;; Remove brackets from the description, they are fatal.
8554 (setq description (replace-match "{" t t description)))
8556 (setq description (replace-match "}" t t description))))
8557 (when (equal (org-link-escape link) description)
8558 ;; No description needed, it is identical
8559 (setq description nil))
8560 (when (and (not description)
8561 (not (equal link (org-link-escape link))))
8562 (setq description (org-extract-attributes link)))
8563 (setq link (if (string-match org-link-types-re link)
8564 (concat (match-string 1 link)
8565 (org-link-escape (substring link (match-end 1))))
8566 (org-link-escape link)))
8567 (concat "[[" link "]"
8568 (if description (concat "[" description "]") "")
8569 "]"))
8571 (defconst org-link-escape-chars
8572 '((?\ . "%20")
8573 (?\[ . "%5B")
8574 (?\] . "%5D")
8585 (?\; . "%3B")
8586 ;; (?? . "%3F")
8587 (?= . "%3D")
8588 (?+ . "%2B")
8589 )
8590 "Association list of escapes for some characters problematic in links.
8591 This is the list that is used for internal purposes.")
8593 (defvar org-url-encoding-use-url-hexify nil)
8595 (defconst org-link-escape-chars-browser
8596 '((?\ . "%20")) ; 32 for the SPC char
8597 "Association list of escapes for some characters problematic in links.
8598 This is the list that is used before handing over to the browser.")
8600 (defun org-link-escape (text &optional table)
8601 "Escape characters in TEXT that are problematic for links."
8602 (if (and org-url-encoding-use-url-hexify (not table))
8603 (url-hexify-string text)
8604 (setq table (or table org-link-escape-chars))
8605 (when text
8606 (let ((re (mapconcat (lambda (x) (regexp-quote
8607 (char-to-string (car x))))
8609 (while (string-match re text)
8610 (setq text
8611 (replace-match
8612 (cdr (assoc (string-to-char (match-string 0 text))
8613 table))
8614 t t text)))
8615 text))))
8617 (defun org-link-unescape (text &optional table)
8618 "Reverse the action of `org-link-escape'."
8619 (if (and org-url-encoding-use-url-hexify (not table))
8620 (url-unhex-string text)
8621 (setq table (or table org-link-escape-chars))
8622 (when text
8623 (let ((case-fold-search t)
8624 (re (mapconcat (lambda (x) (regexp-quote (downcase (cdr x))))
8626 (while (string-match re text)
8627 (setq text
8628 (replace-match
8629 (char-to-string (car (rassoc (upcase (match-string 0 text))
8630 table)))
8631 t t text)))
8632 text))))
8634 (defun org-xor (a b)
8635 "Exclusive or."
8636 (if a (not b) b))
8638 (defun org-fixup-message-id-for-http (s)
8639 "Replace special characters in a message id, so it can be used in an http query."
8640 (when (string-match "%" s)
8641 (setq s (mapconcat (lambda (c)
8642 (if (eq c ?%)
8643 "%25"
8644 (char-to-string c)))
8645 s "")))
8646 (while (string-match "<" s)
8647 (setq s (replace-match "%3C" t t s)))
8648 (while (string-match ">" s)
8649 (setq s (replace-match "%3E" t t s)))
8650 (while (string-match "@" s)
8651 (setq s (replace-match "%40" t t s)))
8652 s)
8654 ;;;###autoload
8655 (defun org-insert-link-global ()
8656 "Insert a link like Org-mode does.
8657 This command can be called in any mode to insert a link in Org-mode syntax."
8658 (interactive)
8659 (org-load-modules-maybe)
8660 (org-run-like-in-org-mode 'org-insert-link))
8662 (defun org-insert-link (&optional complete-file link-location)
8663 "Insert a link. At the prompt, enter the link.
8665 Completion can be used to insert any of the link protocol prefixes like
8666 http or ftp in use.
8668 The history can be used to select a link previously stored with
8669 `org-store-link'. When the empty string is entered (i.e. if you just
8670 press RET at the prompt), the link defaults to the most recently
8671 stored link. As SPC triggers completion in the minibuffer, you need to
8672 use M-SPC or C-q SPC to force the insertion of a space character.
8674 You will also be prompted for a description, and if one is given, it will
8675 be displayed in the buffer instead of the link.
8677 If there is already a link at point, this command will allow you to edit link
8678 and description parts.
8681 be selected using completion. The path to the file will be relative to the
8682 current directory if the file is in the current directory or a subdirectory.
8683 Otherwise, the link will be the absolute path as completed in the minibuffer
8684 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8685 option `org-link-file-path-type'.
8688 the current directory or below.
8691 `org-keep-stored-link-after-insertion'.
8693 If `org-make-link-description-function' is non-nil, this function will be
8694 called with the link target, and the result will be the default
8695 link description.
8697 If the LINK-LOCATION parameter is non-nil, this value will be
8698 used as the link location instead of reading one interactively."
8699 (interactive "P")
8700 (let* ((wcf (current-window-configuration))
8701 (region (if (org-region-active-p)
8702 (buffer-substring (region-beginning) (region-end))))
8703 (remove (and region (list (region-beginning) (region-end))))
8704 (desc region)
8705 tmphist ; byte-compile incorrectly complains about this
8706 (link link-location)
8707 entry file all-prefixes)
8708 (cond
8709 (link-location) ; specified by arg, just use it.
8710 ((org-in-regexp org-bracket-link-regexp 1)
8711 ;; We do have a link at point, and we are going to edit it.
8712 (setq remove (list (match-beginning 0) (match-end 0)))
8713 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8714 (setq link (read-string "Link: "
8715 (org-link-unescape
8716 (org-match-string-no-properties 1)))))
8717 ((or (org-in-regexp org-angle-link-re)
8718 (org-in-regexp org-plain-link-re))
8719 ;; Convert to bracket link
8720 (setq remove (list (match-beginning 0) (match-end 0))
8721 link (read-string "Link: "
8722 (org-remove-angle-brackets (match-string 0)))))
8723 ((member complete-file '((4) (16)))
8724 ;; Completing read for file names.
8725 (setq link (org-file-complete-link complete-file)))
8726 (t
8727 ;; Read link, with completion for stored links.
8728 (with-output-to-temp-buffer "*Org Links*"
8729 (princ "Insert a link.
8731 (when org-stored-links
8733 (princ (mapconcat
8734 (lambda (x)
8735 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8737 (let ((cw (selected-window)))
8738 (select-window (get-buffer-window "*Org Links*" 'visible))
8739 (setq truncate-lines t)
8740 (unless (pos-visible-in-window-p (point-max))
8741 (org-fit-window-to-buffer))
8742 (and (window-live-p cw) (select-window cw)))
8743 ;; Fake a link history, containing the stored links.
8744 (setq tmphist (append (mapcar 'car org-stored-links)
8745 org-insert-link-history))
8746 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8747 (mapcar 'car org-link-abbrev-alist)
8748 org-link-types))
8749 (unwind-protect
8750 (progn
8751 (setq link
8752 (let ((org-completion-use-ido nil)
8753 (org-completion-use-iswitchb nil))
8754 (org-completing-read
8755 "Link: "
8756 (append
8757 (mapcar (lambda (x) (list (concat x ":")))
8758 all-prefixes)
8759 (mapcar 'car org-stored-links))
8760 nil nil nil
8761 'tmphist
8762 (car (car org-stored-links)))))
8764 (error "No link selected"))
8765 (if (or (member link all-prefixes)
8766 (and (equal ":" (substring link -1))
8767 (member (substring link 0 -1) all-prefixes)
8768 (setq link (substring link 0 -1))))
8769 (setq link (org-link-try-special-completion link))))
8770 (set-window-configuration wcf)
8771 (kill-buffer "*Org Links*"))
8772 (setq entry (assoc link org-stored-links))
8773 (or entry (push link org-insert-link-history))
8774 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8775 (not org-keep-stored-link-after-insertion))
8776 (setq org-stored-links (delq (assoc link org-stored-links)
8777 org-stored-links)))
8778 (setq desc (or desc (nth 1 entry)))))
8780 (if (string-match org-plain-link-re link)
8781 ;; URL-like link, normalize the use of angular brackets.
8782 (setq link (org-make-link (org-remove-angle-brackets link))))
8784 ;; Check if we are linking to the current file with a search option
8785 ;; If yes, simplify the link by using only the search option.
8786 (when (and buffer-file-name
8788 (let* ((path (match-string 1 link))
8789 (case-fold-search nil)
8790 (search (match-string 2 link)))
8791 (save-match-data
8792 (if (equal (file-truename buffer-file-name) (file-truename path))
8793 ;; We are linking to this same file, with a search option
8794 (setq link search)))))
8796 ;; Check if we can/should use a relative path. If yes, simplify the link
8798 (let* ((type (match-string 1 link))
8799 (path (match-string 2 link))
8800 (origpath path)
8801 (case-fold-search nil))
8802 (cond
8803 ((or (eq org-link-file-path-type 'absolute)
8804 (equal complete-file '(16)))
8805 (setq path (abbreviate-file-name (expand-file-name path))))
8806 ((eq org-link-file-path-type 'noabbrev)
8807 (setq path (expand-file-name path)))
8808 ((eq org-link-file-path-type 'relative)
8809 (setq path (file-relative-name path)))
8810 (t
8811 (save-match-data
8812 (if (string-match (concat "^" (regexp-quote
8813 (expand-file-name
8814 (file-name-as-directory
8815 default-directory))))
8816 (expand-file-name path))
8817 ;; We are linking a file with relative path name.
8818 (setq path (substring (expand-file-name path)
8819 (match-end 0)))
8820 (setq path (abbreviate-file-name (expand-file-name path)))))))
8821 (setq link (concat type path))
8822 (if (equal desc origpath)
8823 (setq desc path))))
8825 (if org-make-link-description-function
8826 (setq desc (funcall org-make-link-description-function link desc)))
8828 (setq desc (read-string "Description: " desc))
8830 (if remove (apply 'delete-region remove))
8831 (insert (org-make-link-string link desc))))
8833 (defun org-link-try-special-completion (type)
8834 "If there is completion support for link type TYPE, offer it."
8835 (let ((fun (intern (concat "org-" type "-complete-link"))))
8836 (if (functionp fun)
8837 (funcall fun)
8838 (read-string "Link (no completion support): " (concat type ":")))))
8840 (defun org-file-complete-link (&optional arg)
8841 "Create a file link using completion."
8842 (let (file link)
8843 (setq file (read-file-name "File: "))
8844 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8845 (pwd1 (file-name-as-directory (abbreviate-file-name
8846 (expand-file-name ".")))))
8847 (cond
8848 ((equal arg '(16))
8849 (setq link (org-make-link
8850 "file:"
8851 (abbreviate-file-name (expand-file-name file)))))
8853 (setq link (org-make-link "file:" (match-string 1 file))))
8855 (expand-file-name file))
8856 (setq link (org-make-link
8857 "file:" (match-string 1 (expand-file-name file)))))
8858 (t (setq link (org-make-link "file:" file)))))
8859 link))
8861 (defun org-completing-read (&rest args)
8862 "Completing-read with SPACE being a normal character."
8863 (let ((minibuffer-local-completion-map
8864 (copy-keymap minibuffer-local-completion-map)))
8865 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
8866 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
8867 (apply 'org-icompleting-read args)))
8869 (defun org-completing-read-no-i (&rest args)
8870 (let (org-completion-use-ido org-completion-use-iswitchb)
8871 (apply 'org-completing-read args)))
8873 (defun org-iswitchb-completing-read (prompt choices &rest args)
8874 "Use iswitch as a completing-read replacement to choose from choices.
8875 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
8876 from."
8877 (let* ((iswitchb-use-virtual-buffers nil)
8878 (iswitchb-make-buflist-hook
8879 (lambda ()
8880 (setq iswitchb-temp-buflist choices))))
8881 (iswitchb-read-buffer prompt)))
8883 (defun org-icompleting-read (&rest args)
8884 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
8885 (org-without-partial-completion
8886 (if (and org-completion-use-ido
8887 (fboundp 'ido-completing-read)
8888 (boundp 'ido-mode) ido-mode
8889 (listp (second args)))
8890 (let ((ido-enter-matching-directory nil))
8891 (apply 'ido-completing-read (concat (car args))
8892 (if (consp (car (nth 1 args)))
8893 (mapcar (lambda (x) (car x)) (nth 1 args))
8894 (nth 1 args))
8895 (cddr args)))
8896 (if (and org-completion-use-iswitchb
8897 (boundp 'iswitchb-mode) iswitchb-mode
8898 (listp (second args)))
8899 (apply 'org-iswitchb-completing-read (concat (car args))
8900 (if (consp (car (nth 1 args)))
8901 (mapcar (lambda (x) (car x)) (nth 1 args))
8902 (nth 1 args))
8903 (cddr args))
8904 (apply 'completing-read args)))))
8906 (defun org-extract-attributes (s)
8907 "Extract the attributes cookie from a string and set as text property."
8908 (let (a attr (start 0) key value)
8909 (save-match-data
8911 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
8913 (setq key (match-string 1 a) value (match-string 2 a)
8914 start (match-end 0)
8915 attr (plist-put attr (intern key) value))))
8916 (org-add-props s nil 'org-attr attr))
8917 s))
8919 (defun org-extract-attributes-from-string (tag)
8920 (let (key value attr)
8922 (setq key (match-string 1 tag) value (match-string 2 tag)
8923 tag (replace-match "" t t tag)
8924 attr (plist-put attr (intern key) value)))
8925 (cons tag attr)))
8927 (defun org-attributes-to-string (plist)
8928 "Format a property list into an HTML attribute list."
8929 (let ((s "") key value)
8930 (while plist
8931 (setq key (pop plist) value (pop plist))
8932 (and value
8934 s))
8936 ;;; Opening/following a link
8938 (defvar org-link-search-failed nil)
8940 (defvar org-open-link-functions nil
8941 "Hook for functions finding a plain text link.
8942 These functions must take a single argument, the link content.
8943 They will be called for links that look like [[link text][description]]
8947 These functions will be called *before* Org attempts to resolve the
8948 link by doing text searches in the current buffer - so if you want a
8950 handle this as a special case.
8952 When the function does handle the link, it must return a non-nil value.
8953 If it decides that it is not responsible for this link, it must return
8954 nil to indicate that that Org-mode can continue with other options
8955 like exact and fuzzy text search.")
8957 (defun org-next-link ()
8958 "Move forward to the next link.
8959 If the link is in hidden text, expose it."
8960 (interactive)
8961 (when (and org-link-search-failed (eq this-command last-command))
8962 (goto-char (point-min))
8963 (message "Link search wrapped back to beginning of buffer"))
8964 (setq org-link-search-failed nil)
8965 (let* ((pos (point))
8966 (ct (org-context))
8967 (a (assoc :link ct)))
8968 (if a (goto-char (nth 2 a)))
8969 (if (re-search-forward org-any-link-re nil t)
8970 (progn
8971 (goto-char (match-beginning 0))
8972 (if (org-invisible-p) (org-show-context)))
8973 (goto-char pos)
8974 (setq org-link-search-failed t)
8975 (error "No further link found"))))
8977 (defun org-previous-link ()
8978 "Move backward to the previous link.
8979 If the link is in hidden text, expose it."
8980 (interactive)
8981 (when (and org-link-search-failed (eq this-command last-command))
8982 (goto-char (point-max))
8983 (message "Link search wrapped back to end of buffer"))
8984 (setq org-link-search-failed nil)
8985 (let* ((pos (point))
8986 (ct (org-context))
8987 (a (assoc :link ct)))
8988 (if a (goto-char (nth 1 a)))
8989 (if (re-search-backward org-any-link-re nil t)
8990 (progn
8991 (goto-char (match-beginning 0))
8992 (if (org-invisible-p) (org-show-context)))
8993 (goto-char pos)
8994 (setq org-link-search-failed t)
8995 (error "No further link found"))))
8997 (defun org-translate-link (s)
8998 "Translate a link string if a translation function has been defined."
8999 (if (and org-link-translation-function
9000 (fboundp org-link-translation-function)
9002 (progn
9003 (setq s (funcall org-link-translation-function
9004 (match-string 1) (match-string 2)))
9005 (concat (car s) ":" (cdr s)))
9006 s))
9008 (defun org-translate-link-from-planner (type path)
9009 "Translate a link from Emacs Planner syntax so that Org can follow it.
9010 This is still an experimental function, your mileage may vary."
9011 (cond
9012 ((member type '("http" "https" "news" "ftp"))
9013 ;; standard Internet links are the same.
9014 nil)
9015 ((and (equal type "irc") (string-match "^//" path))
9016 ;; Planner has two / at the beginning of an irc link, we have 1.
9017 ;; We should have zero, actually....
9018 (setq path (substring path 1)))
9019 ((and (equal type "lisp") (string-match "^/" path))
9020 ;; Planner has a slash, we do not.
9021 (setq type "elisp" path (substring path 1)))
9023 ;; A typical message link. Planner has the id after the final slash,
9024 ;; we separate it with a hash mark
9025 (setq path (concat (match-string 1 path) "#"
9026 (org-remove-angle-brackets (match-string 2 path)))))
9027 )
9028 (cons type path))
9030 (defun org-find-file-at-mouse (ev)
9031 "Open file link or URL at mouse."
9032 (interactive "e")
9033 (mouse-set-point ev)
9034 (org-open-at-point 'in-emacs))
9036 (defun org-open-at-mouse (ev)
9037 "Open file link or URL at mouse."
9038 (interactive "e")
9039 (mouse-set-point ev)
9040 (if (eq major-mode 'org-agenda-mode)
9041 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9042 (org-open-at-point))
9044 (defvar org-window-config-before-follow-link nil
9045 "The window configuration before following a link.
9046 This is saved in case the need arises to restore it.")
9048 (defvar org-open-link-marker (make-marker)
9049 "Marker pointing to the location where `org-open-at-point; was called.")
9051 ;;;###autoload
9052 (defun org-open-at-point-global ()
9053 "Follow a link like Org-mode does.
9054 This command can be called in any mode to follow a link that has
9055 Org-mode syntax."
9056 (interactive)
9057 (org-run-like-in-org-mode 'org-open-at-point))
9059 ;;;###autoload
9060 (defun org-open-link-from-string (s &optional arg reference-buffer)
9061 "Open a link in the string S, as if it was in Org-mode."
9063 (let ((reference-buffer (or reference-buffer (current-buffer))))
9064 (with-temp-buffer
9065 (let ((org-inhibit-startup t))
9066 (org-mode)
9067 (insert s)
9068 (goto-char (point-min))
9069 (when reference-buffer
9070 (setq org-link-abbrev-alist-local
9071 (with-current-buffer reference-buffer
9072 org-link-abbrev-alist-local)))
9073 (org-open-at-point arg reference-buffer)))))
9075 (defvar org-open-at-point-functions nil
9076 "Hook that is run when following a link at point.
9078 Functions in this hook must return t if they identify and follow
9079 a link at point. If they don't find anything interesting at point,
9080 they must return nil.")
9082 (defun org-open-at-point (&optional in-emacs reference-buffer)
9083 "Open link at or after point.
9084 If there is no link at point, this function will search forward up to
9085 the end of the current line.
9086 Normally, files will be opened by an appropriate application. If the
9087 optional argument IN-EMACS is non-nil, Emacs will visit the file.
9088 With a double prefix argument, try to open outside of Emacs, in the
9089 application the system uses for this file type."
9090 (interactive "P")
9091 ;; if in a code block, then open the block's results
9092 (unless (call-interactively #'org-babel-open-src-block-result)
9093 (org-load-modules-maybe)
9094 (move-marker org-open-link-marker (point))
9095 (setq org-window-config-before-follow-link (current-window-configuration))
9096 (org-remove-occur-highlights nil nil t)
9097 (cond
9098 ((and (org-on-heading-p)
9099 (not (org-in-regexp
9104 (not (get-text-property (point) 'org-linked-text)))
9105 (or (org-offer-links-in-entry in-emacs)
9106 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9107 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9108 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9109 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9110 (not (org-in-regexp org-bracket-link-regexp)))
9111 (org-footnote-action))
9112 (t
9113 (let (type path link line search (pos (point)))
9114 (catch 'match
9115 (save-excursion
9117 (when (org-in-regexp org-bracket-link-regexp 1)
9118 (setq link (org-extract-attributes
9119 (org-link-unescape (org-match-string-no-properties 1))))
9121 (setq link (replace-match " " t t link)))
9122 (setq link (org-link-expand-abbrev link))
9123 (cond
9124 ((or (file-name-absolute-p link)
9126 (setq type "file" path link))
9127 ((string-match org-link-re-with-space3 link)
9128 (setq type (match-string 1 link) path (match-string 2 link)))
9129 (t (setq type "thisfile" path link)))
9130 (throw 'match t)))
9132 (when (get-text-property (point) 'org-linked-text)
9133 (setq type "thisfile"
9134 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9135 (1+ (point)) (point))
9136 path (buffer-substring
9137 (previous-single-property-change pos 'org-linked-text)
9138 (next-single-property-change pos 'org-linked-text)))
9139 (throw 'match t))
9141 (save-excursion
9142 (when (or (org-in-regexp org-angle-link-re)
9143 (org-in-regexp org-plain-link-re))
9144 (setq type (match-string 1) path (match-string 2))
9145 (throw 'match t)))
9146 (save-excursion
9148 (setq type "tags"
9149 path (match-string 1))
9150 (while (string-match ":" path)
9151 (setq path (replace-match "+" t t path)))
9152 (throw 'match t)))
9154 (setq type "tree-match"
9155 path (match-string 1))
9156 (throw 'match t)))
9157 (unless path
9158 (error "No link found"))
9160 ;; switch back to reference buffer
9161 ;; needed when if called in a temporary buffer through
9162 ;; org-open-link-from-string
9163 (with-current-buffer (or reference-buffer (current-buffer))
9165 ;; Remove any trailing spaces in path
9167 (setq path (replace-match "" t t path)))
9168 (if (and org-link-translation-function
9169 (fboundp org-link-translation-function))
9170 ;; Check if we need to translate the link
9171 (let ((tmp (funcall org-link-translation-function type path)))
9172 (setq type (car tmp) path (cdr tmp))))
9174 (cond
9176 ((assoc type org-link-protocols)
9177 (funcall (nth 1 (assoc type org-link-protocols)) path))
9179 ((equal type "mailto")
9180 (let ((cmd (car org-link-mailto-program))
9181 (args (cdr org-link-mailto-program)) args1
9182 (address path) (subject "") a)
9184 (setq address (match-string 1 path)
9185 subject (org-link-escape (match-string 2 path))))
9186 (while args
9187 (cond
9188 ((not (stringp (car args))) (push (pop args) args1))
9189 (t (setq a (pop args))
9190 (if (string-match "%a" a)
9191 (setq a (replace-match address t t a)))
9192 (if (string-match "%s" a)
9193 (setq a (replace-match subject t t a)))
9194 (push a args1))))
9195 (apply cmd (nreverse args1))))
9197 ((member type '("http" "https" "ftp" "news"))
9198 (browse-url (concat type ":" (org-link-escape
9199 path org-link-escape-chars-browser))))
9201 ((string= type "doi")
9202 (browse-url (concat "http://dx.doi.org/"
9203 (org-link-escape
9204 path org-link-escape-chars-browser))))
9206 ((member type '("message"))
9207 (browse-url (concat type ":" path)))
9209 ((string= type "tags")
9210 (org-tags-view in-emacs path))
9212 ((string= type "tree-match")
9215 ((string= type "file")
9217 (setq line (string-to-number (match-string 1 path))
9218 path (substring path 0 (match-beginning 0)))
9220 (setq search (match-string 1 path)
9221 path (substring path 0 (match-beginning 0)))))
9222 (if (string-match "[*?{]" (file-name-nondirectory path))
9223 (dired path)
9224 (org-open-file path in-emacs line search)))
9226 ((string= type "shell")
9227 (let ((cmd path))
9228 (if (or (not org-confirm-shell-link-function)
9229 (funcall org-confirm-shell-link-function
9231 (org-add-props cmd nil
9232 'face 'org-warning))))
9233 (progn
9234 (message "Executing %s" cmd)
9235 (shell-command cmd))
9236 (error "Abort"))))
9238 ((string= type "elisp")
9239 (let ((cmd path))
9240 (if (or (not org-confirm-elisp-link-function)
9241 (funcall org-confirm-elisp-link-function
9243 (org-add-props cmd nil
9244 'face 'org-warning))))
9245 (message "%s => %s" cmd
9246 (if (equal (string-to-char cmd) ?\()
9247 (eval (read cmd))
9248 (call-interactively (read cmd))))
9249 (error "Abort"))))
9251 ((and (string= type "thisfile")
9252 (run-hook-with-args-until-success
9253 'org-open-link-functions path)))
9255 ((string= type "thisfile")
9256 (if in-emacs
9257 (switch-to-buffer-other-window
9258 (org-get-buffer-for-internal-link (current-buffer)))
9259 (org-mark-ring-push))
9260 (let ((cmd `(org-link-search
9261 ,path
9262 ,(cond ((equal in-emacs '(4)) 'occur)
9263 ((equal in-emacs '(16)) 'org-occur)
9264 (t nil))
9265 ,pos)))
9266 (condition-case nil (eval cmd)
9267 (error (progn (widen) (eval cmd))))))
9269 (t
9270 (browse-url-at-point)))))))
9271 (move-marker org-open-link-marker nil)
9272 (run-hook-with-args 'org-follow-link-hook)))
9274 (defun org-offer-links-in-entry (&optional nth zero)
9275 "Offer links in the current entry and follow the selected link.
9276 If there is only one link, follow it immediately as well.
9277 If NTH is an integer, immediately pick the NTH link found.
9278 If ZERO is a string, check also this string for a link, and if
9279 there is one, offer it as link number zero."
9283 (cnt ?0)
9284 (in-emacs (if (integerp nth) nil nth))
9285 have-zero end links link c)
9286 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9287 (push (match-string 0 zero) links)
9288 (setq cnt (1- cnt) have-zero t))
9289 (save-excursion
9290 (org-back-to-heading t)
9291 (setq end (save-excursion (outline-next-heading) (point)))
9292 (while (re-search-forward re end t)
9293 (push (match-string 0) links))
9294 (setq links (org-uniquify (reverse links))))
9296 (cond
9297 ((null links)
9298 (message "No links"))
9299 ((equal (length links) 1)
9300 (setq link (list (car links))))
9301 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9302 (setq link (nth (if have-zero nth (1- nth)) links)))
9303 (t ; we have to select a link
9304 (save-excursion
9305 (save-window-excursion
9306 (delete-other-windows)
9307 (with-output-to-temp-buffer "*Select Link*"
9308 (mapc (lambda (l)
9309 (if (not (string-match org-bracket-link-regexp l))
9311 (org-remove-angle-brackets l)))
9312 (if (match-end 3)
9314 (match-string 3 l) (match-string 1 l)))
9316 (match-string 1 l))))))
9317 links))
9318 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9319 (message "Select link to open, RET to open all:")
9320 (setq c (read-char-exclusive))
9321 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9322 (when (equal c ?q) (error "Abort"))
9323 (if (equal c ?\C-m)
9324 (setq link links)
9325 (setq nth (- c ?0))
9326 (if have-zero (setq nth (1+ nth)))
9327 (unless (and (integerp nth) (>= (length links) nth))
9328 (error "Invalid link selection"))
9329 (setq link (list (nth (1- nth) links))))))
9330 (if link
9331 (let ((buf (current-buffer)))
9332 (dolist (l link)
9333 (org-open-link-from-string l in-emacs buf))
9334 t)
9335 nil)))
9337 ;; Add special file links that specify the way of opening
9339 (org-add-link-type "file+sys" 'org-open-file-with-system)
9340 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9341 (defun org-open-file-with-system (path)
9342 "Open file at PATH using the system way of opening it."
9343 (org-open-file path 'system))
9344 (defun org-open-file-with-emacs (path)
9345 "Open file at PATH in Emacs."
9346 (org-open-file path 'emacs))
9347 (defun org-remove-file-link-modifiers ()
9348 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9349 (goto-char (point-min))
9351 (org-if-unprotected
9352 (replace-match "file:" t t))))
9353 (eval-after-load "org-exp"
9354 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9355 'org-remove-file-link-modifiers))
9357 ;;;; Time estimates
9359 (defun org-get-effort (&optional pom)
9360 "Get the effort estimate for the current entry."
9361 (org-entry-get pom org-effort-property))
9363 ;;; File search
9365 (defvar org-create-file-search-functions nil
9366 "List of functions to construct the right search string for a file link.
9367 These functions are called in turn with point at the location to
9368 which the link should point.
9370 A function in the hook should first test if it would like to
9371 handle this file type, for example by checking the `major-mode'
9372 or the file extension. If it decides not to handle this file, it
9373 should just return nil to give other functions a chance. If it
9374 does handle the file, it must return the search string to be used
9375 when following the link. The search string will be part of the
9376 file link, given after a double colon, and `org-open-at-point'
9377 will automatically search for it. If special measures must be
9378 taken to make the search successful, another function should be
9379 added to the companion hook `org-execute-file-search-functions',
9380 which see.
9382 A function in this hook may also use `setq' to set the variable
9383 `description' to provide a suggestion for the descriptive text to
9384 be used for this link when it gets inserted into an Org-mode
9387 (defvar org-execute-file-search-functions nil
9388 "List of functions to execute a file search triggered by a link.
9390 Functions added to this hook must accept a single argument, the
9391 search string that was part of the file link, the part after the
9392 double colon. The function must first check if it would like to
9393 handle this search, for example by checking the `major-mode' or
9394 the file extension. If it decides not to handle this search, it
9395 should just return nil to give other functions a chance. If it
9396 does handle the search, it must return a non-nil value to keep
9397 other functions from trying.
9399 Each function can access the current prefix argument through the
9400 variable `current-prefix-argument'. Note that a single prefix is
9401 used to force opening a link in Emacs, so it may be good to only
9402 use a numeric or double prefix to guide the search function.
9404 In case this is needed, a function in this hook can also restore
9405 the window configuration before `org-open-at-point' was called using:
9407 (set-window-configuration org-window-config-before-follow-link)")
9409 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9410 (defun org-link-search (s &optional type avoid-pos)
9411 "Search for a link search option.
9412 If S is surrounded by forward slashes, it is interpreted as a
9413 regular expression. In org-mode files, this will create an `org-occur'
9414 sparse tree. In ordinary files, `occur' will be used to list matches.
9415 If the current buffer is in `dired-mode', grep will be used to search
9416 in all files. If AVOID-POS is given, ignore matches near that position."
9417 (let ((case-fold-search t)
9421 org-emphasis-alist)
9423 (pos (point))
9424 (pre nil) (post nil)
9425 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9426 (cond
9427 ;; First check if there are any special search functions
9428 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9429 ;; Now try the builtin stuff
9430 ((and (equal (string-to-char s0) ?#)
9431 (> (length s0) 1)
9432 (save-excursion
9433 (goto-char (point-min))
9434 (and
9435 (re-search-forward
9437 (setq type 'dedicated
9438 pos (match-beginning 0))))
9439 ;; There is an exact target for this
9440 (goto-char pos)
9441 (org-back-to-heading t)))
9442 ((save-excursion
9443 (goto-char (point-min))
9444 (and
9445 (re-search-forward
9446 (concat "<<" (regexp-quote s0) ">>") nil t)
9447 (setq type 'dedicated
9448 pos (match-beginning 0))))
9449 ;; There is an exact target for this
9450 (goto-char pos))
9452 (save-excursion
9453 (goto-char (point-min))
9454 (and
9455 (re-search-forward
9456 (concat "[^[]" (regexp-quote
9457 (format org-coderef-label-format
9458 (match-string 1 s0))))
9459 nil t)
9460 (setq type 'dedicated
9461 pos (1+ (match-beginning 0))))))
9462 ;; There is a coderef target for this
9463 (goto-char pos))
9465 ;; A regular expression
9466 (cond
9467 ((org-mode-p)
9468 (org-occur (match-string 1 s)))
9469 ;;((eq major-mode 'dired-mode)
9470 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9471 (t (org-do-occur (match-string 1 s)))))
9472 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9473 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9474 (goto-char (point-min))
9475 (cond
9476 ((let (case-fold-search)
9477 (re-search-forward (format org-complex-heading-regexp-format
9478 (regexp-quote s))
9479 nil t))
9480 ;; OK, found a match
9481 (setq type 'dedicated)
9482 (goto-char (match-beginning 0)))
9483 ((and (not org-link-search-inhibit-query)
9484 (eq org-link-search-must-match-exact-headline 'query-to-create)
9485 (y-or-n-p "No match - create this as a new heading? "))
9486 (goto-char (point-max))
9487 (or (bolp) (newline))
9489 (beginning-of-line 0))
9490 (t
9491 (goto-char pos)
9492 (error "No match"))))
9493 (t
9494 ;; A normal search string
9495 (when (equal (string-to-char s) ?*)
9496 ;; Anchor on headlines, post may include tags.
9499 s (substring s 1)))
9500 (remove-text-properties
9501 0 (length s)
9502 '(face nil mouse-face nil keymap nil fontified nil) s)
9503 ;; Make a series of regular expressions to find a match
9512 re4 (concat "[^a-zA-Z_]" re4_)
9514 re1 (concat pre re2 post)
9515 re3 (concat pre (if pre re4_ re4) post)
9516 re5 (concat pre ".*" re4)
9517 re2 (concat pre re2)
9518 re2a (concat pre (if pre re2a_ re2a))
9519 re4 (concat pre (if pre re4_ re4))
9523 ))
9524 (cond
9525 ((eq type 'org-occur) (org-occur reall))
9526 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9527 (t (goto-char (point-min))
9528 (setq type 'fuzzy)
9529 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9530 (org-search-not-self 1 re1 nil t)
9531 (org-search-not-self 1 re2 nil t)
9532 (org-search-not-self 1 re2a nil t)
9533 (org-search-not-self 1 re3 nil t)
9534 (org-search-not-self 1 re4 nil t)
9535 (org-search-not-self 1 re5 nil t)
9536 )
9537 (goto-char (match-beginning 1))
9538 (goto-char pos)
9539 (error "No match"))))))
9540 (and (org-mode-p) (org-show-context 'link-search))
9541 type))
9543 (defun org-search-not-self (group &rest args)
9544 "Execute `re-search-forward', but only accept matches that do not
9545 enclose the position of `org-open-link-marker'."
9546 (let ((m org-open-link-marker))
9547 (catch 'exit
9548 (while (apply 're-search-forward args)
9549 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9550 (goto-char (match-end group))
9551 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9552 (> (match-beginning 0) (marker-position m))
9553 (< (match-end 0) (marker-position m)))
9554 (save-match-data
9555 (or (not (org-in-regexp
9556 org-bracket-link-analytic-regexp 1))
9557 (not (match-end 4)) ; no description
9558 (and (<= (match-beginning 4) (point))
9559 (>= (match-end 4) (point))))))
9560 (throw 'exit (point))))))))
9562 (defun org-get-buffer-for-internal-link (buffer)
9563 "Return a buffer to be used for displaying the link target of internal links."
9564 (cond
9565 ((not org-display-internal-link-with-indirect-buffer)
9566 buffer)
9567 ((string-match "(Clone)$" (buffer-name buffer))
9568 (message "Buffer is already a clone, not making another one")
9569 ;; we also do not modify visibility in this case
9570 buffer)
9571 (t ; make a new indirect buffer for displaying the link
9572 (let* ((bn (buffer-name buffer))
9573 (ibn (concat bn "(Clone)"))
9574 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9575 (with-current-buffer ib (org-overview))
9576 ib))))
9578 (defun org-do-occur (regexp &optional cleanup)
9579 "Call the Emacs command `occur'.
9580 If CLEANUP is non-nil, remove the printout of the regular expression
9581 in the *Occur* buffer. This is useful if the regex is long and not useful
9582 to read."
9583 (occur regexp)
9584 (when cleanup
9585 (let ((cwin (selected-window)) win beg end)
9586 (when (setq win (get-buffer-window "*Occur*"))
9587 (select-window win))
9588 (goto-char (point-min))
9589 (when (re-search-forward "match[a-z]+" nil t)
9590 (setq beg (match-end 0))
9592 (setq end (1- (match-beginning 0)))))
9593 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9594 (goto-char (point-min))
9595 (select-window cwin))))
9597 ;;; The mark ring for links jumps
9599 (defvar org-mark-ring nil
9600 "Mark ring for positions before jumps in Org-mode.")
9601 (defvar org-mark-ring-last-goto nil
9602 "Last position in the mark ring used to go back.")
9603 ;; Fill and close the ring
9604 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9605 (loop for i from 1 to org-mark-ring-length do
9606 (push (make-marker) org-mark-ring))
9607 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9608 org-mark-ring)
9610 (defun org-mark-ring-push (&optional pos buffer)
9611 "Put the current position or POS into the mark ring and rotate it."
9612 (interactive)
9613 (setq pos (or pos (point)))
9614 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9615 (move-marker (car org-mark-ring)
9616 (or pos (point))
9617 (or buffer (current-buffer)))
9618 (message "%s"
9619 (substitute-command-keys
9622 (defun org-mark-ring-goto (&optional n)
9623 "Jump to the previous position in the mark ring.
9624 With prefix arg N, jump back that many stored positions. When
9625 called several times in succession, walk through the entire ring.
9626 Org-mode commands jumping to a different position in the current file,
9627 or to another Org-mode file, automatically push the old position
9628 onto the ring."
9629 (interactive "p")
9630 (let (p m)
9631 (if (eq last-command this-command)
9632 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9633 (setq p org-mark-ring))
9634 (setq org-mark-ring-last-goto p)
9635 (setq m (car p))
9636 (switch-to-buffer (marker-buffer m))
9637 (goto-char m)
9638 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9640 (defun org-remove-angle-brackets (s)
9641 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9642 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9643 s)
9644 (defun org-add-angle-brackets (s)
9645 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9646 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9647 s)
9648 (defun org-remove-double-quotes (s)
9651 s)
9653 ;;; Following specific links
9655 (defun org-follow-timestamp-link ()
9656 (cond
9657 ((org-at-date-range-p t)
9658 (let ((org-agenda-start-on-weekday)
9659 (t1 (match-string 1))
9660 (t2 (match-string 2)))
9661 (setq t1 (time-to-days (org-time-string-to-time t1))
9662 t2 (time-to-days (org-time-string-to-time t2)))
9663 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9664 ((org-at-timestamp-p t)
9665 (org-agenda-list nil (time-to-days (org-time-string-to-time
9666 (substring (match-string 1) 0 10)))
9667 1))
9668 (t (error "This should not happen"))))
9671 ;;; Following file links
9672 (defvar org-wait nil)
9673 (defun org-open-file (path &optional in-emacs line search)
9674 "Open the file at PATH.
9675 First, this expands any special file name abbreviations. Then the
9676 configuration variable `org-file-apps' is checked if it contains an
9677 entry for this file type, and if yes, the corresponding command is launched.
9679 If no application is found, Emacs simply visits the file.
9681 With optional prefix argument IN-EMACS, Emacs will visit the file.
9683 prefix arg, Org tries to avoid opening in Emacs
9684 and to use an external application to visit the file.
9686 Optional LINE specifies a line to go to, optional SEARCH a string
9687 to search for. If LINE or SEARCH is given, the file will be
9688 opened in Emacs, unless an entry from org-file-apps that makes
9689 use of groups in a regexp matches.
9690 If the file does not exist, an error is thrown."
9691 (let* ((file (if (equal path "")
9692 buffer-file-name
9693 (substitute-in-file-name (expand-file-name path))))
9694 (file-apps (append org-file-apps (org-default-apps)))
9695 (apps (org-remove-if
9696 'org-file-apps-entry-match-against-dlink-p file-apps))
9697 (apps-dlink (org-remove-if-not
9698 'org-file-apps-entry-match-against-dlink-p file-apps))
9699 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9700 (dirp (if remp nil (file-directory-p file)))
9701 (file (if (and dirp org-open-directory-means-index-dot-org)
9702 (concat (file-name-as-directory file) "index.org")
9703 file))
9704 (a-m-a-p (assq 'auto-mode apps))
9705 (dfile (downcase file))
9706 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9707 (link (cond ((and (eq line nil)
9708 (eq search nil))
9709 file)
9710 (line
9711 (concat file "::" (number-to-string line)))
9712 (search
9713 (concat file "::" search))))
9714 (dlink (downcase link))
9715 (old-buffer (current-buffer))
9716 (old-pos (point))
9717 (old-mode major-mode)
9718 ext cmd link-match-data)
9720 (setq ext (match-string 1 dfile))
9722 (setq ext (match-string 1 dfile))))
9723 (cond
9724 ((member in-emacs '((16) system))
9725 (setq cmd (cdr (assoc 'system apps))))
9726 (in-emacs (setq cmd 'emacs))
9727 (t
9728 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9729 (and dirp (cdr (assoc 'directory apps)))
9730 ; first, try matching against apps-dlink
9731 ; if we get a match here, store the match data for later
9732 (let ((match (assoc-default dlink apps-dlink
9733 'string-match)))
9734 (if match
9735 (progn (setq link-match-data (match-data))
9736 match)
9737 (progn (setq in-emacs (or in-emacs line search))
9738 nil))) ; if we have no match in apps-dlink,
9739 ; always open the file in emacs if line or search
9740 ; is given (for backwards compatibility)
9741 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9742 'string-match)
9743 (cdr (assoc ext apps))
9744 (cdr (assoc t apps))))))
9745 (when (eq cmd 'system)
9746 (setq cmd (cdr (assoc 'system apps))))
9747 (when (eq cmd 'default)
9748 (setq cmd (cdr (assoc t apps))))
9749 (when (eq cmd 'mailcap)
9750 (require 'mailcap)
9751 (mailcap-parse-mailcaps)
9752 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9753 (command (mailcap-mime-info mime-type)))
9754 (if (stringp command)
9755 (setq cmd command)
9756 (setq cmd 'emacs))))
9757 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9758 (not (file-exists-p file))
9759 (not org-open-non-existing-files))
9760 (error "No such file: %s" file))
9761 (cond
9763 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9765 (setq cmd (replace-match "%s" t t cmd)))
9766 (while (string-match "%s" cmd)
9767 (setq cmd (replace-match
9768 (save-match-data
9769 (shell-quote-argument
9770 (convert-standard-filename file)))
9771 t t cmd)))
9773 ;; Replace "%1", "%2" etc. in command with group matches from regex
9774 (save-match-data
9775 (let ((match-index 1)
9776 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9777 (set-match-data link-match-data)
9778 (while (<= match-index number-of-groups)
9779 (let ((regex (concat "%" (number-to-string match-index)))
9780 (replace-with (match-string match-index dlink)))
9781 (while (string-match regex cmd)
9782 (setq cmd (replace-match replace-with t t cmd))))
9783 (setq match-index (+ match-index 1)))))
9785 (save-window-excursion
9786 (start-process-shell-command cmd nil cmd)
9787 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9788 ))
9789 ((or (stringp cmd)
9790 (eq cmd 'emacs))
9791 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9792 (widen)
9793 (if line (org-goto-line line)
9794 (if search (org-link-search search))))
9795 ((consp cmd)
9796 (let ((file (convert-standard-filename file)))
9797 (save-match-data
9798 (set-match-data link-match-data)
9799 (eval cmd))))
9800 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9801 (and (org-mode-p) (eq old-mode 'org-mode)
9802 (or (not (equal old-buffer (current-buffer)))
9803 (not (equal old-pos (point))))
9804 (org-mark-ring-push old-pos old-buffer))))
9806 (defun org-file-apps-entry-match-against-dlink-p (entry)
9807 "This function returns non-nil if `entry' uses a regular
9808 expression which should be matched against the whole link by
9809 org-open-file.
9811 It assumes that is the case when the entry uses a regular
9812 expression which has at least one grouping construct and the
9813 action is either a lisp form or a command string containing
9814 '%1', i.e. using at least one subexpression match as a
9815 parameter."
9816 (let ((selector (car entry))
9817 (action (cdr entry)))
9818 (if (stringp selector)
9819 (and (> (regexp-opt-depth selector) 0)
9820 (or (and (stringp action)
9821 (string-match "%[0-9]" action))
9822 (consp action)))
9823 nil)))
9825 (defun org-default-apps ()
9826 "Return the default applications for this operating system."
9827 (cond
9828 ((eq system-type 'darwin)
9829 org-file-apps-defaults-macosx)
9830 ((eq system-type 'windows-nt)
9831 org-file-apps-defaults-windowsnt)
9832 (t org-file-apps-defaults-gnu)))
9834 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9835 "Convert extensions to regular expressions in the cars of LIST.
9836 Also, weed out any non-string entries, because the return value is used
9837 only for regexp matching.
9838 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9839 point to the symbol `emacs', indicating that the file should
9840 be opened in Emacs."
9841 (append
9842 (delq nil
9843 (mapcar (lambda (x)
9844 (if (not (stringp (car x)))
9845 nil
9847 x
9849 list))
9850 (if add-auto-mode
9851 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9853 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9854 (defun org-file-remote-p (file)
9855 "Test whether FILE specifies a location on a remote system.
9856 Return non-nil if the location is indeed remote.
9860 (cond ((fboundp 'file-remote-p)
9861 (file-remote-p file))
9862 ((fboundp 'tramp-handle-file-remote-p)
9863 (tramp-handle-file-remote-p file))
9864 ((and (boundp 'ange-ftp-name-format)
9865 (string-match (car ange-ftp-name-format) file))
9866 t)
9867 (t nil)))
9870 ;;;; Refiling
9872 (defun org-get-org-file ()
9873 "Read a filename, with default directory `org-directory'."
9874 (let ((default (or org-default-notes-file remember-data-file)))
9875 (read-file-name (format "File name [%s]: " default)
9876 (file-name-as-directory org-directory)
9877 default)))
9879 (defun org-notes-order-reversed-p ()
9880 "Check if the current file should receive notes in reversed order."
9881 (cond
9882 ((not org-reverse-note-order) nil)
9883 ((eq t org-reverse-note-order) t)
9884 ((not (listp org-reverse-note-order)) nil)
9885 (t (catch 'exit
9886 (let ((all org-reverse-note-order)
9887 entry)
9888 (while (setq entry (pop all))
9889 (if (string-match (car entry) buffer-file-name)
9890 (throw 'exit (cdr entry))))
9891 nil)))))
9893 (defvar org-refile-target-table nil
9894 "The list of refile targets, created by `org-refile'.")
9896 (defvar org-agenda-new-buffers nil
9897 "Buffers created to visit agenda files.")
9899 (defvar org-refile-cache nil
9900 "Cache for refile targets.")
9903 (defvar org-refile-markers nil
9904 "All the markers used for caching refile locations.")
9906 (defun org-refile-marker (pos)
9907 "Get a new refile marker, but only if caching is in use."
9908 (if (not org-refile-use-cache)
9909 pos
9910 (let ((m (make-marker)))
9911 (move-marker m pos)
9912 (push m org-refile-markers)
9913 m)))
9915 (defun org-refile-cache-clear ()
9916 "Clear the refile cache and disable all the markers."
9917 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
9918 (setq org-refile-markers nil)
9919 (setq org-refile-cache nil)
9920 (message "Refile cache has been cleared"))
9922 (defun org-refile-cache-check-set (set)
9923 "Check if all the markers in the cache still have live buffers."
9924 (let (marker)
9925 (catch 'exit
9926 (while (and set (setq marker (nth 3 (pop set))))
9927 ;; if org-refile-use-outline-path is 'file, marker may be nil
9928 (when (and marker (null (marker-buffer marker)))
9929 (message "not found") (sit-for 3)
9930 (throw 'exit nil)))
9931 t)))
9933 (defun org-refile-cache-put (set &rest identifiers)
9934 "Push the refile targets SET into the cache, under IDENTIFIERS."
9935 (let* ((key (sha1 (prin1-to-string identifiers)))
9936 (entry (assoc key org-refile-cache)))
9937 (if entry
9938 (setcdr entry set)
9939 (push (cons key set) org-refile-cache))))
9941 (defun org-refile-cache-get (&rest identifiers)
9942 "Retrieve the cached value for refile targets given by IDENTIFIERS."
9943 (cond
9944 ((not org-refile-cache) nil)
9945 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
9946 (t
9947 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
9948 org-refile-cache))))
9949 (and set (org-refile-cache-check-set set) set)))))
9951 (defun org-get-refile-targets (&optional default-buffer)
9952 "Produce a table with refile targets."
9953 (let ((case-fold-search nil)
9954 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
9955 (entries (or org-refile-targets '((nil . (:level . 1)))))
9956 targets tgs txt re files f desc descre fast-path-p level pos0)
9957 (message "Getting targets...")
9958 (with-current-buffer (or default-buffer (current-buffer))
9959 (while (setq entry (pop entries))
9960 (setq files (car entry) desc (cdr entry))
9961 (setq fast-path-p nil)
9962 (cond
9963 ((null files) (setq files (list (current-buffer))))
9964 ((eq files 'org-agenda-files)
9965 (setq files (org-agenda-files 'unrestricted)))
9966 ((and (symbolp files) (fboundp files))
9967 (setq files (funcall files)))
9968 ((and (symbolp files) (boundp files))
9969 (setq files (symbol-value files))))
9970 (if (stringp files) (setq files (list files)))
9971 (cond
9972 ((eq (car desc) :tag)
9974 ((eq (car desc) :todo)
9976 ((eq (car desc) :regexp)
9977 (setq descre (cdr desc)))
9978 ((eq (car desc) :level)
9980 (if org-odd-levels-only
9981 (1- (* 2 (cdr desc)))
9982 (cdr desc)))
9984 ((eq (car desc) :maxlevel)
9985 (setq fast-path-p t)
9987 (if org-odd-levels-only
9988 (1- (* 2 (cdr desc)))
9989 (cdr desc)))
9991 (t (error "Bad refiling target description %s" desc)))
9992 (while (setq f (pop files))
9993 (with-current-buffer
9994 (if (bufferp f) f (org-get-agenda-file-buffer f))
9995 (or
9996 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
9997 (progn
9998 (if (bufferp f) (setq f (buffer-file-name
9999 (buffer-base-buffer f))))
10000 (setq f (and f (expand-file-name f)))
10001 (if (eq org-refile-use-outline-path 'file)
10002 (push (list (file-name-nondirectory f) f nil nil) tgs))
10003 (save-excursion
10004 (save-restriction
10005 (widen)
10006 (goto-char (point-min))
10007 (while (re-search-forward descre nil t)
10008 (goto-char (setq pos0 (point-at-bol)))
10009 (catch 'next
10010 (when org-refile-target-verify-function
10011 (save-match-data
10012 (or (funcall org-refile-target-verify-function)
10013 (throw 'next t))))
10014 (when (looking-at org-complex-heading-regexp)
10015 (setq level (org-reduced-level
10016 (- (match-end 1) (match-beginning 1)))
10017 txt (org-link-display-format (match-string 4))
10019 re (format org-complex-heading-regexp-format
10020 (regexp-quote (match-string 4))))
10021 (when org-refile-use-outline-path
10022 (setq txt (mapconcat
10023 'org-protect-slash
10024 (append
10025 (if (eq org-refile-use-outline-path
10026 'file)
10027 (list (file-name-nondirectory
10028 (buffer-file-name
10029 (buffer-base-buffer))))
10030 (if (eq org-refile-use-outline-path
10031 'full-file-path)
10032 (list (buffer-file-name
10033 (buffer-base-buffer)))))
10034 (org-get-outline-path fast-path-p
10035 level txt)
10036 (list txt))
10037 "/")))
10038 (push (list txt f re (org-refile-marker (point)))
10039 tgs)))
10040 (when (= (point) pos0)
10041 ;; verification function has not moved point
10042 (goto-char (point-at-eol))))))))
10043 (when org-refile-use-cache
10044 (org-refile-cache-put tgs (buffer-file-name) descre))
10045 (setq targets (append tgs targets))
10046 ))))
10047 (message "Getting targets...done")
10048 (nreverse targets)))
10050 (defun org-protect-slash (s)
10051 (while (string-match "/" s)
10053 s)
10055 (defvar org-olpa (make-vector 20 nil))
10057 (defun org-get-outline-path (&optional fastp level heading)
10058 "Return the outline path to the current entry, as a list.
10060 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10061 routine which makes outline path derivations for an entire file,
10062 avoiding backtracing. Refile target collection makes use of that."
10063 (if fastp
10064 (progn
10065 (if (> level 19)
10066 (error "Outline path failure, more than 19 levels"))
10067 (loop for i from level upto 19 do
10068 (aset org-olpa i nil))
10069 (prog1
10070 (delq nil (append org-olpa nil))
10071 (aset org-olpa level heading)))
10072 (let (rtn case-fold-search)
10073 (save-excursion
10074 (save-restriction
10075 (widen)
10076 (while (org-up-heading-safe)
10077 (when (looking-at org-complex-heading-regexp)
10078 (push (org-match-string-no-properties 4) rtn)))
10079 rtn)))))
10081 (defun org-format-outline-path (path &optional width prefix)
10082 "Format the outline path PATH for display.
10083 Width is the maximum number of characters that is available.
10084 Prefix is a prefix to be included in the returned string,
10085 such as the file name."
10086 (setq width (or width 79))
10087 (if prefix (setq width (- width (length prefix))))
10088 (if (not path)
10089 (or prefix "")
10090 (let* ((nsteps (length path))
10091 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10092 (maxwidth (if (<= total-width width)
10093 10000 ;; everything fits
10094 ;; we need to shorten the level headings
10095 (/ (- width nsteps) nsteps)))
10096 (org-odd-levels-only nil)
10097 (n 0)
10098 (total (1+ (length prefix))))
10099 (setq maxwidth (max maxwidth 10))
10100 (concat prefix
10101 (mapconcat
10102 (lambda (h)
10103 (setq n (1+ n))
10104 (if (and (= n nsteps) (< maxwidth 10000))
10105 (setq maxwidth (- total-width total)))
10106 (if (< (length h) maxwidth)
10107 (progn (setq total (+ total (length h) 1)) h)
10108 (setq h (substring h 0 (- maxwidth 2))
10109 total (+ total maxwidth 1))
10111 (setq h (substring h 0 (match-beginning 0))))
10112 (setq h (concat h "..")))
10113 (org-add-props h nil 'face
10114 (nth (% (1- n) org-n-level-faces)
10115 org-level-faces))
10116 h)
10117 path "/")))))
10119 (defun org-display-outline-path (&optional file current)
10120 "Display the current outline path in the echo area."
10121 (interactive "P")
10122 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10123 (case-fold-search nil)
10124 (path (and (org-mode-p) (org-get-outline-path))))
10125 (if current (setq path (append path
10126 (save-excursion
10127 (org-back-to-heading t)
10128 (if (looking-at org-complex-heading-regexp)
10129 (list (match-string 4)))))))
10130 (message "%s"
10131 (org-format-outline-path
10132 path
10133 (1- (frame-width))
10134 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10136 (defvar org-refile-history nil
10137 "History for refiling operations.")
10139 (defvar org-after-refile-insert-hook nil
10140 "Hook run after `org-refile' has inserted its stuff at the new location.
10141 Note that this is still *before* the stuff will be removed from
10142 the *old* location.")
10144 (defvar org-capture-last-stored-marker)
10145 (defun org-refile (&optional goto default-buffer rfloc)
10146 "Move the entry at point to another heading.
10147 The list of target headings is compiled using the information in
10148 `org-refile-targets', which see. This list is created before each use
10149 and will therefore always be up-to-date.
10151 At the target location, the entry is filed as a subitem of the target heading.
10152 Depending on `org-reverse-note-order', the new subitem will either be the
10153 first or the last subitem.
10155 If there is an active region, all entries in that region will be moved.
10156 However, the region must fulfill the requirement that the first heading
10157 is the first one sets the top-level of the moved text - at most siblings
10158 below it are allowed.
10160 With prefix arg GOTO, the command will only visit the target location,
10161 not actually move anything.
10163 go to the location where the last refiling
10164 operation has put the subtree.
10165 With a prefix argument of `2', refile to the running clock.
10167 RFLOC can be a refile location obtained in a different way.
10169 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10171 If you are using target caching (see `org-refile-use-cache'),
10172 You have to clear the target cache in order to find new targets.
10173 This can be done with a 0 prefix: `C-0 C-c C-w'"
10174 (interactive "P")
10175 (if (member goto '(0 (64)))
10176 (org-refile-cache-clear)
10177 (let* ((cbuf (current-buffer))
10178 (regionp (org-region-active-p))
10179 (region-start (and regionp (region-beginning)))
10180 (region-end (and regionp (region-end)))
10181 (region-length (and regionp (- region-end region-start)))
10182 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10183 pos it nbuf file re level reversed)
10184 (setq last-command nil)
10185 (when regionp
10186 (goto-char region-start)
10187 (or (bolp) (goto-char (point-at-bol)))
10188 (setq region-start (point))
10189 (unless (org-kill-is-subtree-p
10190 (buffer-substring region-start region-end))
10191 (error "The region is not a (sequence of) subtree(s)")))
10192 (if (equal goto '(16))
10193 (org-refile-goto-last-stored)
10194 (when (or
10195 (and (equal goto 2)
10196 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10197 (prog1
10198 (setq it (list (or org-clock-heading "running clock")
10199 (buffer-file-name
10200 (marker-buffer org-clock-hd-marker))
10201 ""
10202 (marker-position org-clock-hd-marker)))
10203 (setq goto nil)))
10204 (setq it (or rfloc
10205 (save-excursion
10206 (org-refile-get-location
10207 (if goto "Goto: " "Refile to: ") default-buffer
10208 org-refile-allow-creating-parent-nodes)))))
10209 (setq file (nth 1 it)
10210 re (nth 2 it)
10211 pos (nth 3 it))
10212 (if (and (not goto)
10213 pos
10214 (equal (buffer-file-name) file)
10215 (if regionp
10216 (and (>= pos region-start)
10217 (<= pos region-end))
10218 (and (>= pos (point))
10219 (< pos (save-excursion
10220 (org-end-of-subtree t t))))))
10221 (error "Cannot refile to position inside the tree or region"))
10223 (setq nbuf (or (find-buffer-visiting file)
10224 (find-file-noselect file)))
10225 (if goto
10226 (progn
10227 (switch-to-buffer nbuf)
10228 (goto-char pos)
10229 (org-show-context 'org-goto))
10230 (if regionp
10231 (progn
10232 (org-kill-new (buffer-substring region-start region-end))
10233 (org-save-markers-in-region region-start region-end))
10234 (org-copy-subtree 1 nil t))
10235 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10236 (find-file-noselect file)))
10237 (setq reversed (org-notes-order-reversed-p))
10238 (save-excursion
10239 (save-restriction
10240 (widen)
10241 (if pos
10242 (progn
10243 (goto-char pos)
10244 (looking-at outline-regexp)
10245 (setq level (org-get-valid-level (funcall outline-level) 1))
10246 (goto-char
10247 (if reversed
10248 (or (outline-next-heading) (point-max))
10249 (or (save-excursion (org-get-next-sibling))
10250 (org-end-of-subtree t t)
10251 (point-max)))))
10252 (setq level 1)
10253 (if (not reversed)
10254 (goto-char (point-max))
10255 (goto-char (point-min))
10256 (or (outline-next-heading) (goto-char (point-max)))))
10257 (if (not (bolp)) (newline))
10258 (org-paste-subtree level)
10259 (when org-log-refile
10260 (org-add-log-setup 'refile nil nil 'findpos
10261 org-log-refile)
10262 (unless (eq org-log-refile 'note)
10263 (save-excursion (org-add-log-note))))
10264 (and org-auto-align-tags (org-set-tags nil t))
10265 (bookmark-set "org-refile-last-stored")
10266 ;; If we are refiling for capture, make sure that the
10267 ;; last-capture pointers point here
10268 (when (org-bound-and-true-p org-refile-for-capture)
10269 (bookmark-set "org-capture-last-stored-marker")
10270 (move-marker org-capture-last-stored-marker (point)))
10271 (if (fboundp 'deactivate-mark) (deactivate-mark))
10272 (run-hooks 'org-after-refile-insert-hook))))
10273 (if regionp
10274 (delete-region (point) (+ (point) region-length))
10275 (org-cut-subtree))
10276 (when (featurep 'org-inlinetask)
10277 (org-inlinetask-remove-END-maybe))
10278 (setq org-markers-to-move nil)
10281 (defun org-refile-goto-last-stored ()
10282 "Go to the location where the last refile was stored."
10283 (interactive)
10284 (bookmark-jump "org-refile-last-stored")
10285 (message "This is the location of the last refile"))
10287 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10288 "Prompt the user for a refile location, using PROMPT."
10289 (let ((org-refile-targets org-refile-targets)
10290 (org-refile-use-outline-path org-refile-use-outline-path))
10291 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
10292 (unless org-refile-target-table
10293 (error "No refile targets"))
10294 (let* ((cbuf (current-buffer))
10295 (partial-completion-mode nil)
10296 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10297 (cfunc (if (and org-refile-use-outline-path
10298 org-outline-path-complete-in-steps)
10299 'org-olpath-completing-read
10300 'org-icompleting-read))
10301 (extra (if org-refile-use-outline-path "/" ""))
10302 (filename (and cfn (expand-file-name cfn)))
10303 (tbl (mapcar
10304 (lambda (x)
10305 (if (and (not (member org-refile-use-outline-path
10306 '(file full-file-path)))
10307 (not (equal filename (nth 1 x))))
10308 (cons (concat (car x) extra " ("
10309 (file-name-nondirectory (nth 1 x)) ")")
10310 (cdr x))
10311 (cons (concat (car x) extra) (cdr x))))
10312 org-refile-target-table))
10313 (completion-ignore-case t)
10314 pa answ parent-target child parent old-hist)
10315 (setq old-hist org-refile-history)
10316 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10317 nil 'org-refile-history))
10318 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10319 (org-refile-check-position pa)
10320 (if pa
10321 (progn
10322 (when (or (not org-refile-history)
10323 (not (eq old-hist org-refile-history))
10324 (not (equal (car pa) (car org-refile-history))))
10325 (setq org-refile-history
10326 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10327 org-refile-history
10328 (cdr org-refile-history))))
10329 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10330 (pop org-refile-history)))
10331 pa)
10333 (progn
10334 (setq parent (match-string 1 answ)
10335 child (match-string 2 answ))
10336 (setq parent-target (or (assoc parent tbl)
10337 (assoc (concat parent "/") tbl)))
10338 (when (and parent-target
10339 (or (eq new-nodes t)
10340 (and (eq new-nodes 'confirm)
10342 child)))))
10343 (org-refile-new-child parent-target child)))
10344 (error "Invalid target location")))))
10346 (defun org-refile-check-position (refile-pointer)
10347 "Check if the refile pointer matches the readline to which it points."
10348 (let* ((file (nth 1 refile-pointer))
10349 (re (nth 2 refile-pointer))
10350 (pos (nth 3 refile-pointer))
10351 buffer)
10352 (when (org-string-nw-p re)
10353 (setq buffer (if (markerp pos)
10354 (marker-buffer pos)
10355 (or (find-buffer-visiting file)
10356 (find-file-noselect file))))
10357 (with-current-buffer buffer
10358 (save-excursion
10359 (save-restriction
10360 (widen)
10361 (goto-char pos)
10362 (beginning-of-line 1)
10363 (unless (org-looking-at-p re)
10364 (error "Invalid refile position, please rebuild the cache"))))))))
10366 (defun org-refile-new-child (parent-target child)
10367 "Use refile target PARENT-TARGET to add new CHILD below it."
10368 (unless parent-target
10369 (error "Cannot find parent for new node"))
10370 (let ((file (nth 1 parent-target))
10371 (pos (nth 3 parent-target))
10372 level)
10373 (with-current-buffer (or (find-buffer-visiting file)
10374 (find-file-noselect file))
10375 (save-excursion
10376 (save-restriction
10377 (widen)
10378 (if pos
10379 (goto-char pos)
10380 (goto-char (point-max))
10381 (if (not (bolp)) (newline)))
10382 (when (looking-at outline-regexp)
10383 (setq level (funcall outline-level))
10384 (org-end-of-subtree t t))
10385 (org-back-over-empty-lines)
10387 (if pos (org-get-valid-level level 1) 1) ?*)
10389 (beginning-of-line 0)
10390 (list (concat (car parent-target) "/" child) file "" (point)))))))
10392 (defun org-olpath-completing-read (prompt collection &rest args)
10393 "Read an outline path like a file name."
10394 (let ((thetable collection)
10395 (org-completion-use-ido nil) ; does not work with ido.
10396 (org-completion-use-iswitchb nil)) ; or iswitchb
10397 (apply
10398 'org-icompleting-read prompt
10399 (lambda (string predicate &optional flag)
10400 (let (rtn r f (l (length string)))
10401 (cond
10402 ((eq flag nil)
10403 ;; try completion
10404 (try-completion string thetable))
10405 ((eq flag t)
10406 ;; all-completions
10407 (setq rtn (all-completions string thetable predicate))
10408 (mapcar
10409 (lambda (x)
10410 (setq r (substring x l))
10411 (if (string-match " ([^)]*)$" x)
10412 (setq f (match-string 0 x))
10413 (setq f ""))
10414 (if (string-match "/" r)
10415 (concat string (substring r 0 (match-end 0)) f)
10416 x))
10417 rtn))
10418 ((eq flag 'lambda)
10419 ;; exact match?
10420 (assoc string thetable)))
10421 ))
10422 args)))
10424 ;;;; Dynamic blocks
10426 (defun org-find-dblock (name)
10427 "Find the first dynamic block with name NAME in the buffer.
10428 If not found, stay at current position and return nil."
10429 (let (pos)
10430 (save-excursion
10431 (goto-char (point-min))
10433 nil t)
10434 (match-beginning 0))))
10435 (if pos (goto-char pos))
10436 pos))
10438 (defconst org-dblock-start-re
10440 "Matches the start line of a dynamic block, with parameters.")
10443 "Matches the end of a dynamic block.")
10445 (defun org-create-dblock (plist)
10446 "Create a dynamic block section, with parameters taken from PLIST.
10447 PLIST must contain a :name entry which is used as name of the block."
10449 (end-of-line 1)
10450 (newline))
10451 (let ((col (current-column))
10452 (name (plist-get plist :name)))
10453 (insert "#+BEGIN: " name)
10454 (while plist
10455 (if (eq (car plist) :name)
10456 (setq plist (cddr plist))
10457 (insert " " (prin1-to-string (pop plist)))))
10459 (beginning-of-line -2)))
10461 (defun org-prepare-dblock ()
10462 "Prepare dynamic block for refresh.
10463 This empties the block, puts the cursor at the insert position and returns
10464 the property list including an extra property :name with the block name."
10465 (unless (looking-at org-dblock-start-re)
10466 (error "Not at a dynamic block"))
10467 (let* ((begdel (1+ (match-end 0)))
10468 (name (org-no-properties (match-string 1)))
10469 (params (append (list :name name)
10470 (read (concat "(" (match-string 3) ")")))))
10471 (save-excursion
10472 (beginning-of-line 1)
10474 (setq params (plist-put params :indentation-column (current-column))))
10475 (unless (re-search-forward org-dblock-end-re nil t)
10476 (error "Dynamic block not terminated"))
10477 (setq params
10478 (append params
10479 (list :content (buffer-substring
10480 begdel (match-beginning 0)))))
10481 (delete-region begdel (match-beginning 0))
10482 (goto-char begdel)
10483 (open-line 1)
10484 params))
10486 (defun org-map-dblocks (&optional command)
10487 "Apply COMMAND to all dynamic blocks in the current buffer.
10488 If COMMAND is not given, use `org-update-dblock'."
10489 (let ((cmd (or command 'org-update-dblock)))
10490 (save-excursion
10491 (goto-char (point-min))
10492 (while (re-search-forward org-dblock-start-re nil t)
10493 (goto-char (match-beginning 0))
10494 (save-excursion
10495 (condition-case nil
10496 (funcall cmd)
10497 (error (message "Error during update of dynamic block"))))
10498 (unless (re-search-forward org-dblock-end-re nil t)
10499 (error "Dynamic block not terminated"))))))
10501 (defun org-dblock-update (&optional arg)
10502 "User command for updating dynamic blocks.
10503 Update the dynamic block at point. With prefix ARG, update all dynamic
10504 blocks in the buffer."
10505 (interactive "P")
10506 (if arg
10507 (org-update-all-dblocks)
10508 (or (looking-at org-dblock-start-re)
10509 (org-beginning-of-dblock))
10510 (org-update-dblock)))
10512 (defun org-update-dblock ()
10513 "Update the dynamic block at point.
10514 This means to empty the block, parse for parameters and then call
10515 the correct writing function."
10516 (interactive)
10517 (save-window-excursion
10518 (let* ((pos (point))
10519 (line (org-current-line))
10520 (params (org-prepare-dblock))
10521 (name (plist-get params :name))
10522 (indent (plist-get params :indentation-column))
10523 (cmd (intern (concat "org-dblock-write:" name))))
10524 (message "Updating dynamic block `%s' at line %d..." name line)
10525 (funcall cmd params)
10526 (message "Updating dynamic block `%s' at line %d...done" name line)
10527 (goto-char pos)
10528 (when (and indent (> indent 0))
10529 (setq indent (make-string indent ?\ ))
10530 (save-excursion
10531 (org-beginning-of-dblock)
10532 (forward-line 1)
10533 (while (not (looking-at org-dblock-end-re))
10534 (insert indent)
10535 (beginning-of-line 2))
10536 (when (looking-at org-dblock-end-re)
10538 (replace-match ""))
10539 (insert indent)))))))
10541 (defun org-beginning-of-dblock ()
10542 "Find the beginning of the dynamic block at point.
10543 Error if there is no such block at point."
10544 (let ((pos (point))
10545 beg)
10546 (end-of-line 1)
10547 (if (and (re-search-backward org-dblock-start-re nil t)
10548 (setq beg (match-beginning 0))
10549 (re-search-forward org-dblock-end-re nil t)
10550 (> (match-end 0) pos))
10551 (goto-char beg)
10552 (goto-char pos)
10553 (error "Not in a dynamic block"))))
10555 (defun org-update-all-dblocks ()
10556 "Update all dynamic blocks in the buffer.
10557 This function can be used in a hook."
10558 (interactive)
10559 (when (org-mode-p)
10560 (org-map-dblocks 'org-update-dblock)))
10563 ;;;; Completion
10565 (defconst org-additional-option-like-keywords
10566 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10567 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10568 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10569 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10570 "BEGIN:" "END:"
10571 "ORGTBL" "TBLFM:" "TBLNAME:"
10572 "BEGIN_EXAMPLE" "END_EXAMPLE"
10573 "BEGIN_QUOTE" "END_QUOTE"
10574 "BEGIN_VERSE" "END_VERSE"
10575 "BEGIN_CENTER" "END_CENTER"
10576 "BEGIN_SRC" "END_SRC"
10577 "BEGIN_RESULT" "END_RESULT"
10578 "SOURCE:" "SRCNAME:" "FUNCTION:"
10579 "RESULTS:"
10580 "HEADER:" "HEADERS:"
10581 "BABEL:"
10582 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10583 "CAPTION:" "LABEL:"
10584 "SETUPFILE:"
10585 "INCLUDE:"
10586 "BIND:"
10587 "MACRO:"))
10589 (defcustom org-structure-template-alist
10590 '(
10603 ("L" "#+latex: "
10607 ("H" "#+html: "
10610 ("A" "#+ascii: ")
10611 ("i" "#+include %file ?"
10613 )
10614 "Structure completion elements.
10615 This is a list of abbreviation keys and values. The value gets inserted
10616 if you type `<' followed by the key and then press the completion key,
10617 usually `M-TAB'. %file will be replaced by a file name after prompting
10618 for the file using completion.
10619 There are two templates for each key, the first uses the original Org syntax,
10620 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10621 the default when the /org-mtags.el/ module has been loaded. See also the
10622 variable `org-mtags-prefer-muse-templates'.
10623 This is an experimental feature, it is undecided if it is going to stay in."
10624 :group 'org-completion
10625 :type '(repeat
10626 (string :tag "Key")
10627 (string :tag "Template")
10628 (string :tag "Muse Template")))
10630 (defun org-try-structure-completion ()
10631 "Try to complete a structure template before point.
10633 expands them."
10634 (let ((l (buffer-substring (point-at-bol) (point)))
10635 a)
10638 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10639 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10640 (match-beginning 1)) a)
10641 t)))
10643 (defun org-complete-expand-structure-template (start cell)
10644 "Expand a structure template."
10645 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10646 (rpl (nth (if musep 2 1) cell))
10647 (ind ""))
10648 (delete-region start (point))
10650 (cond
10651 ((bolp))
10653 (setq ind (buffer-substring (point-at-bol) (point))))
10654 (t (newline))))
10655 (setq start (point))
10656 (if (string-match "%file" rpl)
10657 (setq rpl (replace-match
10658 (concat
10660 (save-match-data
10661 (abbreviate-file-name (read-file-name "Include file: ")))
10663 t t rpl)))
10666 (insert rpl)
10669 ;;;; TODO, DEADLINE, Comments
10671 (defun org-toggle-comment ()
10672 "Change the COMMENT state of an entry."
10673 (interactive)
10674 (save-excursion
10675 (org-back-to-heading)
10676 (let (case-fold-search)
10677 (if (looking-at (concat outline-regexp
10679 (replace-match "" t t nil 1)
10680 (if (looking-at outline-regexp)
10681 (progn
10682 (goto-char (match-end 0))
10683 (insert org-comment-string " ")))))))
10685 (defvar org-last-todo-state-is-todo nil
10686 "This is non-nil when the last TODO state change led to a TODO state.
10687 If the last change removed the TODO tag or switched to DONE, then
10688 this is nil.")
10690 (defvar org-setting-tags nil) ; dynamically skipped
10692 (defvar org-todo-setup-filter-hook nil
10693 "Hook for functions that pre-filter todo specs.
10694 Each function takes a todo spec and returns either nil or the spec
10695 transformed into canonical form." )
10697 (defvar org-todo-get-default-hook nil
10698 "Hook for functions that get a default item for todo.
10699 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10700 nil or a string to be used for the todo mark." )
10702 (defvar org-agenda-headline-snapshot-before-repeat)
10704 (defun org-todo (&optional arg)
10705 "Change the TODO state of an item.
10706 The state of an item is given by a keyword at the start of the heading,
10707 like
10708 *** TODO Write paper
10709 *** DONE Call mom
10711 The different keywords are specified in the variable `org-todo-keywords'.
10713 So for this example: when the item starts with TODO, it is changed to DONE.
10714 When it starts with DONE, the DONE is removed. And when neither TODO nor
10715 DONE are present, add TODO at the beginning of the heading.
10718 state.
10719 With numeric prefix arg, switch to that state.
10721 keywords (nextset).
10724 For calling through lisp, arg is also interpreted in the following way:
10725 'none -> empty state
10727 'done -> switch to DONE
10728 'nextset -> switch to the next set of keywords
10729 'previousset -> switch to the previous set of keywords
10731 really is a member of `org-todo-keywords'."
10732 (interactive "P")
10733 (if (equal arg '(16)) (setq arg 'nextset))
10734 (let ((org-blocker-hook org-blocker-hook)
10735 (case-fold-search nil))
10736 (when (equal arg '(64))
10737 (setq arg nil org-blocker-hook nil))
10738 (when (and org-blocker-hook
10739 (or org-inhibit-blocking
10740 (org-entry-get nil "NOBLOCKING")))
10741 (setq org-blocker-hook nil))
10742 (save-excursion
10743 (catch 'exit
10744 (org-back-to-heading t)
10745 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10747 (looking-at " *"))
10748 (let* ((match-data (match-data))
10749 (startpos (point-at-bol))
10750 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10751 (org-log-done org-log-done)
10752 (org-log-repeat org-log-repeat)
10753 (org-todo-log-states org-todo-log-states)
10754 (this (match-string 1))
10755 (hl-pos (match-beginning 0))
10756 (head (org-get-todo-sequence-head this))
10757 (ass (assoc head org-todo-kwd-alist))
10758 (interpret (nth 1 ass))
10759 (done-word (nth 3 ass))
10760 (final-done-word (nth 4 ass))
10761 (last-state (or this ""))
10762 (completion-ignore-case t)
10763 (member (member this org-todo-keywords-1))
10764 (tail (cdr member))
10765 (state (cond
10766 ((and org-todo-key-trigger
10767 (or (and (equal arg '(4))
10768 (eq org-use-fast-todo-selection 'prefix))
10769 (and (not arg) org-use-fast-todo-selection
10770 (not (eq org-use-fast-todo-selection
10771 'prefix)))))
10772 ;; Use fast selection
10773 (org-fast-todo-selection))
10774 ((and (equal arg '(4))
10775 (or (not org-use-fast-todo-selection)
10776 (not org-todo-key-trigger)))
10777 ;; Read a state with completion
10778 (org-icompleting-read
10779 "State: " (mapcar (lambda(x) (list x))
10780 org-todo-keywords-1)
10781 nil t))
10782 ((eq arg 'right)
10783 (if this
10784 (if tail (car tail) nil)
10785 (car org-todo-keywords-1)))
10786 ((eq arg 'left)
10787 (if (equal member org-todo-keywords-1)
10788 nil
10789 (if this
10790 (nth (- (length org-todo-keywords-1)
10791 (length tail) 2)
10792 org-todo-keywords-1)
10793 (org-last org-todo-keywords-1))))
10794 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10795 (setq arg nil))) ; hack to fall back to cycling
10796 (arg
10797 ;; user or caller requests a specific state
10798 (cond
10799 ((equal arg "") nil)
10800 ((eq arg 'none) nil)
10801 ((eq arg 'done) (or done-word (car org-done-keywords)))
10802 ((eq arg 'nextset)
10803 (or (car (cdr (member head org-todo-heads)))
10804 (car org-todo-heads)))
10805 ((eq arg 'previousset)
10806 (let ((org-todo-heads (reverse org-todo-heads)))
10807 (or (car (cdr (member head org-todo-heads)))
10808 (car org-todo-heads))))
10809 ((car (member arg org-todo-keywords-1)))
10810 ((stringp arg)
10811 (error "State `%s' not valid in this file" arg))
10812 ((nth (1- (prefix-numeric-value arg))
10813 org-todo-keywords-1))))
10814 ((null member) (or head (car org-todo-keywords-1)))
10815 ((equal this final-done-word) nil) ;; -> make empty
10816 ((null tail) nil) ;; -> first entry
10817 ((memq interpret '(type priority))
10818 (if (eq this-command last-command)
10819 (car tail)
10820 (if (> (length tail) 0)
10821 (or done-word (car org-done-keywords))
10822 nil)))
10823 (t
10824 (car tail))))
10825 (state (or
10826 (run-hook-with-args-until-success
10827 'org-todo-get-default-hook state last-state)
10828 state))
10829 (next (if state (concat " " state " ") " "))
10830 (change-plist (list :type 'todo-state-change :from this :to state
10831 :position startpos))
10832 dolog now-done-p)
10833 (when org-blocker-hook
10834 (setq org-last-todo-state-is-todo
10835 (not (member this org-done-keywords)))
10836 (unless (save-excursion
10837 (save-match-data
10838 (run-hook-with-args-until-failure
10839 'org-blocker-hook change-plist)))
10840 (if (interactive-p)
10841 (error "TODO state change from %s to %s blocked" this state)
10842 ;; fail silently
10843 (message "TODO state change from %s to %s blocked" this state)
10844 (throw 'exit nil))))
10845 (store-match-data match-data)
10846 (replace-match next t t)
10847 (unless (pos-visible-in-window-p hl-pos)
10848 (message "TODO state changed to %s" (org-trim next)))
10849 (unless head
10850 (setq head (org-get-todo-sequence-head state)
10851 ass (assoc head org-todo-kwd-alist)
10852 interpret (nth 1 ass)
10853 done-word (nth 3 ass)
10854 final-done-word (nth 4 ass)))
10855 (when (memq arg '(nextset previousset))
10856 (message "Keyword-Set %d/%d: %s"
10857 (- (length org-todo-sets) -1
10858 (length (memq (assoc state org-todo-sets) org-todo-sets)))
10859 (length org-todo-sets)
10860 (mapconcat 'identity (assoc state org-todo-sets) " ")))
10861 (setq org-last-todo-state-is-todo
10862 (not (member state org-done-keywords)))
10863 (setq now-done-p (and (member state org-done-keywords)
10864 (not (member this org-done-keywords))))
10865 (and logging (org-local-logging logging))
10866 (when (and (or org-todo-log-states org-log-done)
10867 (not (eq org-inhibit-logging t))
10868 (not (memq arg '(nextset previousset))))
10869 ;; we need to look at recording a time and note
10870 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
10871 (nth 2 (assoc this org-todo-log-states))))
10872 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
10873 (setq dolog 'time))
10874 (when (and state
10875 (member state org-not-done-keywords)
10876 (not (member this org-not-done-keywords)))
10877 ;; This is now a todo state and was not one before
10878 ;; If there was a CLOSED time stamp, get rid of it.
10879 (org-add-planning-info nil nil 'closed))
10880 (when (and now-done-p org-log-done)
10881 ;; It is now done, and it was not done before
10882 (org-add-planning-info 'closed (org-current-time))
10883 (if (and (not dolog) (eq 'note org-log-done))
10884 (org-add-log-setup 'done state this 'findpos 'note)))
10885 (when (and state dolog)
10886 ;; This is a non-nil state, and we need to log it
10887 (org-add-log-setup 'state state this 'findpos dolog)))
10888 ;; Fixup tag positioning
10889 (org-todo-trigger-tag-changes state)
10890 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
10891 (when org-provide-todo-statistics
10892 (org-update-parent-todo-statistics))
10893 (run-hooks 'org-after-todo-state-change-hook)
10894 (if (and arg (not (member state org-done-keywords)))
10895 (setq head (org-get-todo-sequence-head state)))
10896 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
10897 ;; Do we need to trigger a repeat?
10898 (when now-done-p
10899 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
10900 ;; This is for the agenda, take a snapshot of the headline.
10901 (save-match-data
10902 (setq org-agenda-headline-snapshot-before-repeat
10903 (org-get-heading))))
10904 (org-auto-repeat-maybe state))
10905 ;; Fixup cursor location if close to the keyword
10906 (if (and (outline-on-heading-p)
10907 (not (bolp))
10908 (save-excursion (beginning-of-line 1)
10909 (looking-at org-todo-line-regexp))
10910 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
10911 (progn
10912 (goto-char (or (match-end 2) (match-end 1)))
10913 (and (looking-at " ") (just-one-space))))
10914 (when org-trigger-hook
10915 (save-excursion
10916 (run-hook-with-args 'org-trigger-hook change-plist))))))))
10918 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
10919 "Block turning an entry into a TODO, using the hierarchy.
10920 This checks whether the current task should be blocked from state
10921 changes. Such blocking occurs when:
10923 1. The task has children which are not all in a completed state.
10925 2. A task has a parent with the property :ORDERED:, and there
10926 are siblings prior to the current task with incomplete
10927 status.
10929 3. The parent of the task is blocked because it has siblings that should
10930 be done first, or is child of a block grandparent TODO entry."
10932 (if (not org-enforce-todo-dependencies)
10933 t ; if locally turned off don't block
10934 (catch 'dont-block
10935 ;; If this is not a todo state change, or if this entry is already DONE,
10936 ;; do not block
10937 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
10938 (member (plist-get change-plist :from)
10939 (cons 'done org-done-keywords))
10940 (member (plist-get change-plist :to)
10941 (cons 'todo org-not-done-keywords))
10942 (not (plist-get change-plist :to)))
10943 (throw 'dont-block t))
10944 ;; If this task has children, and any are undone, it's blocked
10945 (save-excursion
10946 (org-back-to-heading t)
10947 (let ((this-level (funcall outline-level)))
10948 (outline-next-heading)
10949 (let ((child-level (funcall outline-level)))
10950 (while (and (not (eobp))
10951 (> child-level this-level))
10952 ;; this todo has children, check whether they are all
10953 ;; completed
10954 (if (and (not (org-entry-is-done-p))
10955 (org-entry-is-todo-p))
10956 (throw 'dont-block nil))
10957 (outline-next-heading)
10958 (setq child-level (funcall outline-level))))))
10959 ;; Otherwise, if the task's parent has the :ORDERED: property, and
10960 ;; any previous siblings are undone, it's blocked
10961 (save-excursion
10962 (org-back-to-heading t)
10963 (let* ((pos (point))
10964 (parent-pos (and (org-up-heading-safe) (point))))
10965 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10966 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
10967 (forward-line 1)
10968 (re-search-forward org-not-done-heading-regexp pos t))
10969 (throw 'dont-block nil)) ; block, there is an older sibling not done.
10970 ;; Search further up the hierarchy, to see if an anchestor is blocked
10971 (while t
10972 (goto-char parent-pos)
10973 (if (not (looking-at org-not-done-heading-regexp))
10974 (throw 'dont-block t)) ; do not block, parent is not a TODO
10975 (setq pos (point))
10976 (setq parent-pos (and (org-up-heading-safe) (point)))
10977 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10978 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
10979 (forward-line 1)
10980 (re-search-forward org-not-done-heading-regexp pos t))
10981 (throw 'dont-block nil)))))))) ; block, older sibling not done.
10983 (defcustom org-track-ordered-property-with-tag nil
10984 "Should the ORDERED property also be shown as a tag?
10985 The ORDERED property decides if an entry should require subtasks to be
10986 completed in sequence. Since a property is not very visible, setting
10987 this option means that toggling the ORDERED property with the command
10988 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
10989 not relevant for the behavior, but it makes things more visible.
10991 Note that toggling the tag with tags commands will not change the property
10992 and therefore not influence behavior!
10994 This can be t, meaning the tag ORDERED should be used, It can also be a
10995 string to select a different tag for this task."
10996 :group 'org-todo
10997 :type '(choice
10998 (const :tag "No tracking" nil)
10999 (const :tag "Track with ORDERED tag" t)
11000 (string :tag "Use other tag")))
11002 (defun org-toggle-ordered-property ()
11003 "Toggle the ORDERED property of the current entry.
11004 For better visibility, you can track the value of this property with a tag.
11005 See variable `org-track-ordered-property-with-tag'."
11006 (interactive)
11007 (let* ((t1 org-track-ordered-property-with-tag)
11008 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11009 (save-excursion
11010 (org-back-to-heading)
11011 (if (org-entry-get nil "ORDERED")
11012 (progn
11013 (org-delete-property "ORDERED")
11014 (and tag (org-toggle-tag tag 'off))
11015 (message "Subtasks can be completed in arbitrary order"))
11016 (org-entry-put nil "ORDERED" "t")
11017 (and tag (org-toggle-tag tag 'on))
11018 (message "Subtasks must be completed in sequence")))))
11020 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11021 (defun org-block-todo-from-checkboxes (change-plist)
11022 "Block turning an entry into a TODO, using checkboxes.
11023 This checks whether the current task should be blocked from state
11024 changes because there are unchecked boxes in this entry."
11025 (if (not org-enforce-todo-checkbox-dependencies)
11026 t ; if locally turned off don't block
11027 (catch 'dont-block
11028 ;; If this is not a todo state change, or if this entry is already DONE,
11029 ;; do not block
11030 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11031 (member (plist-get change-plist :from)
11032 (cons 'done org-done-keywords))
11033 (member (plist-get change-plist :to)
11034 (cons 'todo org-not-done-keywords))
11035 (not (plist-get change-plist :to)))
11036 (throw 'dont-block t))
11037 ;; If this task has checkboxes that are not checked, it's blocked
11038 (save-excursion
11039 (org-back-to-heading t)
11040 (let ((beg (point)) end)
11041 (outline-next-heading)
11042 (setq end (point))
11043 (goto-char beg)
11045 end t)
11046 (progn
11047 (if (boundp 'org-blocked-by-checkboxes)
11048 (setq org-blocked-by-checkboxes t))
11049 (throw 'dont-block nil)))))
11050 t))) ; do not block
11052 (defun org-entry-blocked-p ()
11053 "Is the current entry blocked?"
11054 (if (org-entry-get nil "NOBLOCKING")
11055 nil ;; Never block this entry
11056 (not
11057 (run-hook-with-args-until-failure
11058 'org-blocker-hook
11059 (list :type 'todo-state-change
11060 :position (point)
11061 :from 'todo
11062 :to 'done)))))
11064 (defun org-update-statistics-cookies (all)
11065 "Update the statistics cookie, either from TODO or from checkboxes.
11066 This should be called with the cursor in a line with a statistics cookie."
11067 (interactive "P")
11068 (if all
11069 (progn
11070 (org-update-checkbox-count 'all)
11071 (org-map-entries 'org-update-parent-todo-statistics))
11072 (if (not (org-on-heading-p))
11073 (org-update-checkbox-count)
11074 (let ((pos (move-marker (make-marker) (point)))
11075 end l1 l2)
11076 (ignore-errors (org-back-to-heading t))
11077 (if (not (org-on-heading-p))
11078 (org-update-checkbox-count)
11079 (setq l1 (org-outline-level))
11080 (setq end (save-excursion
11081 (outline-next-heading)
11082 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11083 (point)))
11084 (if (and (save-excursion
11085 (re-search-forward
11087 (not (save-excursion (re-search-forward
11089 (org-update-checkbox-count)
11090 (if (and l2 (> l2 l1))
11091 (progn
11092 (goto-char end)
11093 (org-update-parent-todo-statistics))
11094 (goto-char pos)
11095 (beginning-of-line 1)
11096 (while (re-search-forward
11098 (point-at-eol) t)
11099 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11100 (goto-char pos)
11101 (move-marker pos nil)))))
11103 (defvar org-entry-property-inherited-from) ;; defined below
11104 (defun org-update-parent-todo-statistics ()
11105 "Update any statistics cookie in the parent of the current headline.
11106 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11107 the entire subtree and this will travel up the hierarchy and update
11108 statistics everywhere."
11109 (interactive)
11110 (let* ((lim 0) prop
11111 (recursive (or (not org-hierarchical-todo-statistics)
11112 (string-match
11114 (or (setq prop (org-entry-get
11115 nil "COOKIE_DATA" 'inherit)) ""))))
11116 (lim (or (and prop (marker-position
11117 org-entry-property-inherited-from))
11118 lim))
11119 (first t)
11121 level ltoggle l1 new ndel
11122 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
11123 (catch 'exit
11124 (save-excursion
11125 (beginning-of-line 1)
11126 (if (org-at-heading-p)
11127 (setq ltoggle (funcall outline-level))
11128 (error "This should not happen"))
11129 (while (and (setq level (org-up-heading-safe))
11130 (or recursive first)
11131 (>= (point) lim))
11132 (setq first nil cookie-present nil)
11133 (unless (and level
11134 (not (string-match
11136 (downcase
11137 (or (org-entry-get
11138 nil "COOKIE_DATA")
11139 "")))))
11140 (throw 'exit nil))
11141 (while (re-search-forward box-re (point-at-eol) t)
11142 (setq cnt-all 0 cnt-done 0 cookie-present t)
11143 (setq is-percent (match-end 2))
11144 (save-match-data
11145 (unless (outline-next-heading) (throw 'exit nil))
11146 (while (and (looking-at org-complex-heading-regexp)
11147 (> (setq l1 (length (match-string 1))) level))
11148 (setq kwd (and (or recursive (= l1 ltoggle))
11149 (match-string 2)))
11150 (if (or (eq org-provide-todo-statistics 'all-headlines)
11151 (and (listp org-provide-todo-statistics)
11152 (or (member kwd org-provide-todo-statistics)
11153 (member kwd org-done-keywords))))
11154 (setq cnt-all (1+ cnt-all))
11155 (if (eq org-provide-todo-statistics t)
11156 (and kwd (setq cnt-all (1+ cnt-all)))))
11157 (and (member kwd org-done-keywords)
11158 (setq cnt-done (1+ cnt-done)))
11159 (outline-next-heading)))
11160 (setq new
11161 (if is-percent
11162 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11163 (format "[%d/%d]" cnt-done cnt-all))
11164 ndel (- (match-end 0) (match-beginning 0)))
11165 (goto-char (match-beginning 0))
11166 (insert new)
11167 (delete-region (point) (+ (point) ndel)))
11168 (when cookie-present
11169 (run-hook-with-args 'org-after-todo-statistics-hook
11170 cnt-done (- cnt-all cnt-done))))))
11171 (run-hooks 'org-todo-statistics-hook)))
11173 (defvar org-after-todo-statistics-hook nil
11174 "Hook that is called after a TODO statistics cookie has been updated.
11175 Each function is called with two arguments: the number of not-done entries
11176 and the number of done entries.
11178 For example, the following function, when added to this hook, will switch
11179 an entry to DONE when all children are done, and back to TODO when new
11180 entries are set to a TODO status. Note that this hook is only called
11181 when there is a statistics cookie in the headline!
11183 (defun org-summary-todo (n-done n-not-done)
11185 (let (org-log-done org-log-states) ; turn off logging
11187 ")
11189 (defvar org-todo-statistics-hook nil
11190 "Hook that is run whenever Org thinks TODO statistics should be updated.
11191 This hook runs even if there is no statistics cookie present, in which case
11192 `org-after-todo-statistics-hook' would not run.")
11194 (defun org-todo-trigger-tag-changes (state)
11195 "Apply the changes defined in `org-todo-state-tags-triggers'."
11196 (let ((l org-todo-state-tags-triggers)
11197 changes)
11198 (when (or (not state) (equal state ""))
11199 (setq changes (append changes (cdr (assoc "" l)))))
11200 (when (and (stringp state) (> (length state) 0))
11201 (setq changes (append changes (cdr (assoc state l)))))
11202 (when (member state org-not-done-keywords)
11203 (setq changes (append changes (cdr (assoc 'todo l)))))
11204 (when (member state org-done-keywords)
11205 (setq changes (append changes (cdr (assoc 'done l)))))
11206 (dolist (c changes)
11207 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11209 (defun org-local-logging (value)
11210 "Get logging settings from a property VALUE."
11211 (let* (words w a)
11212 ;; directly set the variables, they are already local.
11213 (setq org-log-done nil
11214 org-log-repeat nil
11215 org-todo-log-states nil)
11216 (setq words (org-split-string value))
11217 (while (setq w (pop words))
11218 (cond
11219 ((setq a (assoc w org-startup-options))
11220 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11221 (set (nth 1 a) (nth 2 a))))
11222 ((setq a (org-extract-log-state-settings w))
11223 (and (member (car a) org-todo-keywords-1)
11224 (push a org-todo-log-states)))))))
11226 (defun org-get-todo-sequence-head (kwd)
11227 "Return the head of the TODO sequence to which KWD belongs.
11228 If KWD is not set, check if there is a text property remembering the
11229 right sequence."
11230 (let (p)
11231 (cond
11232 ((not kwd)
11233 (or (get-text-property (point-at-bol) 'org-todo-head)
11234 (progn
11235 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11236 nil (point-at-eol)))
11237 (get-text-property p 'org-todo-head))))
11238 ((not (member kwd org-todo-keywords-1))
11239 (car org-todo-keywords-1))
11240 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11242 (defun org-fast-todo-selection ()
11243 "Fast TODO keyword selection with single keys.
11244 Returns the new TODO keyword, or nil if no state change should occur."
11245 (let* ((fulltable org-todo-key-alist)
11246 (done-keywords org-done-keywords) ;; needed for the faces.
11247 (maxlen (apply 'max (mapcar
11248 (lambda (x)
11249 (if (stringp (car x)) (string-width (car x)) 0))
11250 fulltable)))
11251 (expert nil)
11252 (fwidth (+ maxlen 3 1 3))
11253 (ncol (/ (- (window-width) 4) fwidth))
11254 tg cnt e c tbl
11255 groups ingroup)
11256 (save-excursion
11257 (save-window-excursion
11258 (if expert
11259 (set-buffer (get-buffer-create " *Org todo*"))
11260 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11261 (erase-buffer)
11262 (org-set-local 'org-done-keywords done-keywords)
11263 (setq tbl fulltable cnt 0)
11264 (while (setq e (pop tbl))
11265 (cond
11266 ((equal e '(:startgroup))
11267 (push '() groups) (setq ingroup t)
11268 (when (not (= cnt 0))
11269 (setq cnt 0)
11271 (insert "{ "))
11272 ((equal e '(:endgroup))
11273 (setq ingroup nil cnt 0)
11275 ((equal e '(:newline))
11276 (when (not (= cnt 0))
11277 (setq cnt 0)
11279 (setq e (car tbl))
11280 (while (equal (car tbl) '(:newline))
11282 (setq tbl (cdr tbl)))))
11283 (t
11284 (setq tg (car e) c (cdr e))
11285 (if ingroup (push tg (car groups)))
11286 (setq tg (org-add-props tg nil 'face
11287 (org-get-todo-face tg)))
11288 (if (and (= cnt 0) (not ingroup)) (insert " "))
11289 (insert "[" c "] " tg (make-string
11290 (- fwidth 4 (length tg)) ?\ ))
11291 (when (= (setq cnt (1+ cnt)) ncol)
11293 (if ingroup (insert " "))
11294 (setq cnt 0)))))
11296 (goto-char (point-min))
11297 (if (not expert) (org-fit-window-to-buffer))
11298 (message "[a-z..]:Set [SPC]:clear")
11299 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11300 (cond
11301 ((or (= c ?\C-g)
11302 (and (= c ?q) (not (rassoc c fulltable))))
11303 (setq quit-flag t))
11304 ((= c ?\ ) nil)
11305 ((setq e (rassoc c fulltable) tg (car e))
11306 tg)
11307 (t (setq quit-flag t)))))))
11309 (defun org-entry-is-todo-p ()
11310 (member (org-get-todo-state) org-not-done-keywords))
11312 (defun org-entry-is-done-p ()
11313 (member (org-get-todo-state) org-done-keywords))
11315 (defun org-get-todo-state ()
11316 (save-excursion
11317 (org-back-to-heading t)
11318 (and (looking-at org-todo-line-regexp)
11319 (match-end 2)
11320 (match-string 2))))
11322 (defun org-at-date-range-p (&optional inactive-ok)
11323 "Is the cursor inside a date range?"
11324 (interactive)
11325 (save-excursion
11326 (catch 'exit
11327 (let ((pos (point)))
11329 (skip-chars-backward "<[")
11330 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11331 (>= (match-end 0) pos)
11332 (throw 'exit t))
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)))
11338 nil)))
11340 (defun org-get-repeat (&optional tagline)
11341 "Check if there is a deadline/schedule with repeater in this entry."
11342 (save-match-data
11343 (save-excursion
11344 (org-back-to-heading t)
11345 (and (re-search-forward (if tagline
11347 org-repeat-re)
11348 (org-entry-end-position) t)
11349 (match-string-no-properties 1)))))
11351 (defvar org-last-changed-timestamp)
11352 (defvar org-last-inserted-timestamp)
11353 (defvar org-log-post-message)
11354 (defvar org-log-note-purpose)
11355 (defvar org-log-note-how)
11356 (defvar org-log-note-extra)
11357 (defun org-auto-repeat-maybe (done-word)
11358 "Check if the current headline contains a repeated deadline/schedule.
11359 If yes, set TODO state back to what it was and change the base date
11360 of repeating deadline/scheduled time stamps to new date.
11361 This function is run automatically after each state change to a DONE state."
11362 ;; last-state is dynamically scoped into this function
11363 (let* ((repeat (org-get-repeat))
11364 (aa (assoc last-state org-todo-kwd-alist))
11365 (interpret (nth 1 aa))
11366 (head (nth 2 aa))
11367 (whata '(("d" . day) ("m" . month) ("y" . year)))
11368 (msg "Entry repeats: ")
11369 (org-log-done nil)
11370 (org-todo-log-states nil)
11371 re type n what ts time to-state)
11372 (when repeat
11373 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11374 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11375 org-todo-repeat-to-state))
11376 (unless (and to-state (member to-state org-todo-keywords-1))
11377 (setq to-state (if (eq interpret 'type) last-state head)))
11378 (org-todo to-state)
11379 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11380 (org-entry-put nil "LAST_REPEAT" (format-time-string
11381 (org-time-stamp-format t t))))
11382 (when org-log-repeat
11383 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11384 (memq 'org-add-log-note post-command-hook))
11385 ;; OK, we are already setup for some record
11386 (if (eq org-log-repeat 'note)
11387 ;; make sure we take a note, not only a time stamp
11388 (setq org-log-note-how 'note))
11389 ;; Set up for taking a record
11390 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11391 last-state
11392 'findpos org-log-repeat)))
11393 (org-back-to-heading t)
11394 (org-add-planning-info nil nil 'closed)
11398 (while (re-search-forward
11399 re (save-excursion (outline-next-heading) (point)) t)
11400 (setq type (if (match-end 1) org-scheduled-string
11401 (if (match-end 3) org-deadline-string "Plain:"))
11402 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11404 (setq n (string-to-number (match-string 2 ts))
11405 what (match-string 3 ts))
11406 (if (equal what "w") (setq n (* n 7) what "d"))
11407 ;; Preparation, see if we need to modify the start date for the change
11408 (when (match-end 1)
11409 (setq time (save-match-data (org-time-string-to-time ts)))
11410 (cond
11411 ((equal (match-string 1 ts) ".")
11412 ;; Shift starting date to today
11413 (org-timestamp-change
11414 (- (time-to-days (current-time)) (time-to-days time))
11415 'day))
11416 ((equal (match-string 1 ts) "+")
11417 (let ((nshiftmax 10) (nshift 0))
11418 (while (or (= nshift 0)
11419 (<= (time-to-days time)
11420 (time-to-days (current-time))))
11421 (when (= (incf nshift) nshiftmax)
11422 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11423 (error "Abort")))
11424 (org-timestamp-change n (cdr (assoc what whata)))
11425 (org-at-timestamp-p t)
11426 (setq ts (match-string 1))
11427 (setq time (save-match-data (org-time-string-to-time ts)))))
11428 (org-timestamp-change (- n) (cdr (assoc what whata)))
11429 ;; rematch, so that we have everything in place for the real shift
11430 (org-at-timestamp-p t)
11431 (setq ts (match-string 1))
11433 (org-timestamp-change n (cdr (assoc what whata)))
11434 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11435 (setq org-log-post-message msg)
11436 (message "%s" msg))))
11438 (defun org-show-todo-tree (arg)
11439 "Make a compact tree which shows all headlines marked with TODO.
11440 The tree will show the lines where the regexp matches, and all higher
11441 headlines above the match.
11443 With a numeric prefix N, construct a sparse tree for the Nth element
11444 of `org-todo-keywords-1'."
11445 (interactive "P")
11446 (let ((case-fold-search nil)
11447 (kwd-re
11448 (cond ((null arg) org-not-done-regexp)
11449 ((equal arg '(4))
11450 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11451 (mapcar 'list org-todo-keywords-1))))
11455 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11456 (regexp-quote (nth (1- (prefix-numeric-value arg))
11457 org-todo-keywords-1)))
11458 (t (error "Invalid prefix argument: %s" arg)))))
11459 (message "%d TODO entries found"
11460 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
11462 (defun org-deadline (&optional remove time)
11464 With argument REMOVE, remove any deadline from the item.
11465 When TIME is set, it should be an internal time specification, and the
11466 scheduling will use the corresponding date."
11467 (interactive "P")
11468 (let* ((old-date (org-entry-get nil "DEADLINE"))
11469 (repeater (and old-date
11471 (match-string 1 old-date))))
11472 (if remove
11473 (progn
11474 (when (and old-date org-log-redeadline)
11475 (org-add-log-setup 'deldeadline nil old-date 'findpos
11476 org-log-redeadline))
11477 (org-remove-timestamp-with-keyword org-deadline-string)
11478 (message "Item no longer has a deadline."))
11479 (org-add-planning-info 'deadline time 'closed)
11480 (when (and old-date org-log-redeadline
11481 (not (equal old-date
11482 (substring org-last-inserted-timestamp 1 -1))))
11483 (org-add-log-setup 'redeadline nil old-date 'findpos
11484 org-log-redeadline))
11485 (when repeater
11486 (save-excursion
11487 (org-back-to-heading t)
11488 (when (re-search-forward (concat org-deadline-string " "
11489 org-last-inserted-timestamp)
11490 (save-excursion
11491 (outline-next-heading) (point)) t)
11492 (goto-char (1- (match-end 0)))
11493 (insert " " repeater)
11494 (setq org-last-inserted-timestamp
11495 (concat (substring org-last-inserted-timestamp 0 -1)
11496 " " repeater
11497 (substring org-last-inserted-timestamp -1))))))
11498 (message "Deadline on %s" org-last-inserted-timestamp))))
11500 (defun org-schedule (&optional remove time)
11501 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11502 With argument REMOVE, remove any scheduling date from the item.
11503 When TIME is set, it should be an internal time specification, and the
11504 scheduling will use the corresponding date."
11505 (interactive "P")
11506 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11507 (repeater (and old-date
11509 (match-string 1 old-date))))
11510 (if remove
11511 (progn
11512 (when (and old-date org-log-reschedule)
11513 (org-add-log-setup 'delschedule nil old-date 'findpos
11514 org-log-reschedule))
11515 (org-remove-timestamp-with-keyword org-scheduled-string)
11516 (message "Item is no longer scheduled."))
11517 (org-add-planning-info 'scheduled time 'closed)
11518 (when (and old-date org-log-reschedule
11519 (not (equal old-date
11520 (substring org-last-inserted-timestamp 1 -1))))
11521 (org-add-log-setup 'reschedule nil old-date 'findpos
11522 org-log-reschedule))
11523 (when repeater
11524 (save-excursion
11525 (org-back-to-heading t)
11526 (when (re-search-forward (concat org-scheduled-string " "
11527 org-last-inserted-timestamp)
11528 (save-excursion
11529 (outline-next-heading) (point)) t)
11530 (goto-char (1- (match-end 0)))
11531 (insert " " repeater)
11532 (setq org-last-inserted-timestamp
11533 (concat (substring org-last-inserted-timestamp 0 -1)
11534 " " repeater
11535 (substring org-last-inserted-timestamp -1))))))
11536 (message "Scheduled to %s" org-last-inserted-timestamp))))
11538 (defun org-get-scheduled-time (pom &optional inherit)
11539 "Get the scheduled time as a time tuple, of a format suitable
11540 for calling org-schedule with, or if there is no scheduling,
11541 returns nil."
11542 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11543 (when time
11544 (apply 'encode-time (org-parse-time-string time)))))
11546 (defun org-get-deadline-time (pom &optional inherit)
11547 "Get the deadline as a time tuple, of a format suitable for
11548 calling org-deadline with, or if there is no scheduling, returns
11549 nil."
11550 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11551 (when time
11552 (apply 'encode-time (org-parse-time-string time)))))
11554 (defun org-remove-timestamp-with-keyword (keyword)
11555 "Remove all time stamps with KEYWORD in the current entry."
11557 beg)
11558 (save-excursion
11559 (org-back-to-heading t)
11560 (setq beg (point))
11561 (outline-next-heading)
11562 (while (re-search-backward re beg t)
11563 (replace-match "")
11565 (equal (char-before) ?\ ))
11566 (backward-delete-char 1)
11568 (point-at-bol) (point-at-eol)))
11569 (delete-region (point-at-bol)
11570 (min (point-max) (1+ (point-at-eol))))))))))
11572 (defun org-add-planning-info (what &optional time &rest remove)
11573 "Insert new timestamp with keyword in the line directly after the headline.
11574 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11575 If non is given, the user is prompted for a date.
11576 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11577 be removed."
11578 (interactive)
11579 (let (org-time-was-given org-end-time-was-given ts
11580 end default-time default-input)
11582 (catch 'exit
11583 (when (and (not time) (memq what '(scheduled deadline)))
11584 ;; Try to get a default date/time from existing timestamp
11585 (save-excursion
11586 (org-back-to-heading t)
11587 (setq end (save-excursion (outline-next-heading) (point)))
11588 (when (re-search-forward (if (eq what 'scheduled)
11589 org-scheduled-time-regexp
11590 org-deadline-time-regexp)
11591 end t)
11592 (setq ts (match-string 1)
11593 default-time
11594 (apply 'encode-time (org-parse-time-string ts))
11595 default-input (and ts (org-get-compact-tod ts))))))
11596 (when what
11597 ;; If necessary, get the time from the user
11598 (setq time (or time (org-read-date nil 'to-time nil nil
11599 default-time default-input))))
11601 (when (and org-insert-labeled-timestamps-at-point
11602 (member what '(scheduled deadline)))
11603 (insert
11604 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11605 (org-insert-time-stamp time org-time-was-given
11606 nil nil nil (list org-end-time-was-given))
11607 (setq what nil))
11608 (save-excursion
11609 (save-restriction
11610 (let (col list elt ts buffer-invisibility-spec)
11611 (org-back-to-heading t)
11613 (goto-char (match-end 1))
11614 (setq col (current-column))
11615 (goto-char (match-end 0))
11617 (when (and (not what)
11618 (not (looking-at
11620 org-keyword-time-not-clock-regexp))))
11621 ;; Nothing to add, nothing to remove...... :-)
11622 (throw 'exit nil))
11623 (if (and (not (looking-at outline-regexp))
11626 (not (equal (match-string 1) org-clock-string)))
11627 (narrow-to-region (match-beginning 0) (match-end 0))
11629 (backward-char 1)
11630 (narrow-to-region (point) (point))
11631 (and org-adapt-indentation (org-indent-to-column col)))
11632 ;; Check if we have to remove something.
11633 (setq list (cons what remove))
11634 (while list
11635 (setq elt (pop list))
11636 (goto-char (point-min))
11637 (when (or (and (eq elt 'scheduled)
11638 (re-search-forward org-scheduled-time-regexp nil t))
11639 (and (eq elt 'deadline)
11640 (re-search-forward org-deadline-time-regexp nil t))
11641 (and (eq elt 'closed)
11642 (re-search-forward org-closed-time-regexp nil t)))
11643 (replace-match "")
11644 (if (looking-at "--+<[^>]+>") (replace-match ""))
11645 (skip-chars-backward " ")
11646 (if (looking-at " +") (replace-match ""))))
11647 (goto-char (point-max))
11648 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11649 (when what
11650 (insert
11651 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11652 (cond ((eq what 'scheduled) org-scheduled-string)
11653 ((eq what 'deadline) org-deadline-string)
11654 ((eq what 'closed) org-closed-string))
11655 " ")
11656 (setq ts (org-insert-time-stamp
11657 time
11658 (or org-time-was-given
11659 (and (eq what 'closed) org-log-done-with-time))
11660 (eq what 'closed)
11661 nil nil (list org-end-time-was-given)))
11662 (end-of-line 1))
11663 (goto-char (point-min))
11664 (widen)
11667 (delete-region (1- (point)) (point-at-eol)))
11668 ts))))))
11670 (defvar org-log-note-marker (make-marker))
11671 (defvar org-log-note-purpose nil)
11672 (defvar org-log-note-state nil)
11673 (defvar org-log-note-previous-state nil)
11674 (defvar org-log-note-how nil)
11675 (defvar org-log-note-extra nil)
11676 (defvar org-log-note-window-configuration nil)
11677 (defvar org-log-note-return-to (make-marker))
11678 (defvar org-log-post-message nil
11679 "Message to be displayed after a log note has been stored.
11680 The auto-repeater uses this.")
11682 (defun org-add-note ()
11683 "Add a note to the current entry.
11684 This is done in the same way as adding a state change note."
11685 (interactive)
11686 (org-add-log-setup 'note nil nil 'findpos nil))
11688 (defvar org-property-end-re)
11689 (defun org-add-log-setup (&optional purpose state prev-state
11690 findpos how extra)
11691 "Set up the post command hook to take a note.
11692 If this is about to TODO state change, the new state is expected in STATE.
11693 When FINDPOS is non-nil, find the correct position for the note in
11694 the current entry. If not, assume that it can be inserted at point.
11695 HOW is an indicator what kind of note should be created.
11696 EXTRA is additional text that will be inserted into the notes buffer."
11697 (let* ((org-log-into-drawer (org-log-into-drawer))
11698 (drawer (cond ((stringp org-log-into-drawer)
11699 org-log-into-drawer)
11700 (org-log-into-drawer "LOGBOOK")
11701 (t nil))))
11702 (save-restriction
11703 (save-excursion
11704 (when findpos
11705 (org-back-to-heading t)
11706 (narrow-to-region (point) (save-excursion
11707 (outline-next-heading) (point)))
11711 (goto-char (match-end 0))
11712 (cond
11713 (drawer
11715 nil t)
11716 (progn
11717 (goto-char (match-end 0))
11718 (or org-log-states-order-reversed
11719 (and (re-search-forward org-property-end-re nil t)
11720 (goto-char (1- (match-beginning 0))))))
11722 (beginning-of-line 0)
11723 (org-indent-line-function)
11724 (beginning-of-line 2)
11725 (org-indent-line-function)
11726 (end-of-line 0)))
11727 ((and org-log-state-notes-insert-after-drawers
11728 (save-excursion
11729 (forward-line) (looking-at org-drawer-regexp)))
11730 (forward-line)
11731 (while (looking-at org-drawer-regexp)
11732 (goto-char (match-end 0))
11733 (re-search-forward org-property-end-re (point-max) t)
11734 (forward-line))
11735 (forward-line -1)))
11736 (unless org-log-states-order-reversed
11738 (org-skip-over-state-notes)
11740 (move-marker org-log-note-marker (point))
11741 (setq org-log-note-purpose purpose
11742 org-log-note-state state
11743 org-log-note-previous-state prev-state
11744 org-log-note-how how
11745 org-log-note-extra extra)
11746 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11748 (defun org-skip-over-state-notes ()
11749 "Skip past the list of State notes in an entry."
11751 (when (org-in-item-p)
11752 (let ((limit (org-list-bottom-point)))
11754 (goto-char (or (org-get-next-item (point) limit)
11755 (org-get-end-of-item limit)))))))
11757 (defun org-add-log-note (&optional purpose)
11758 "Pop up a window for taking a note, and add this note later at point."
11759 (remove-hook 'post-command-hook 'org-add-log-note)
11760 (setq org-log-note-window-configuration (current-window-configuration))
11761 (delete-other-windows)
11762 (move-marker org-log-note-return-to (point))
11763 (switch-to-buffer (marker-buffer org-log-note-marker))
11764 (goto-char org-log-note-marker)
11765 (org-switch-to-buffer-other-window "*Org Note*")
11766 (erase-buffer)
11767 (if (memq org-log-note-how '(time state))
11768 (let (current-prefix-arg) (org-store-log-note))
11769 (let ((org-inhibit-startup t)) (org-mode))
11770 (insert (format "# Insert note for %s.
11772 (cond
11773 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11774 ((eq org-log-note-purpose 'done) "closed todo item")
11775 ((eq org-log-note-purpose 'state)
11777 (or org-log-note-previous-state "")
11778 (or org-log-note-state "")))
11779 ((eq org-log-note-purpose 'reschedule)
11780 "rescheduling")
11781 ((eq org-log-note-purpose 'delschedule)
11782 "no longer scheduled")
11783 ((eq org-log-note-purpose 'redeadline)
11784 "changing deadline")
11785 ((eq org-log-note-purpose 'deldeadline)
11786 "removing deadline")
11787 ((eq org-log-note-purpose 'refile)
11788 "refiling")
11789 ((eq org-log-note-purpose 'note)
11790 "this entry")
11791 (t (error "This should not happen")))))
11792 (if org-log-note-extra (insert org-log-note-extra))
11793 (org-set-local 'org-finish-function 'org-store-log-note)))
11795 (defvar org-note-abort nil) ; dynamically scoped
11796 (defun org-store-log-note ()
11797 "Finish taking a log note, and insert it to where it belongs."
11798 (let ((txt (buffer-string))
11799 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11800 lines ind bul)
11801 (kill-buffer (current-buffer))
11803 (setq txt (replace-match "" t t txt)))
11805 (setq txt (replace-match "" t t txt)))
11808 (setq note
11809 (org-replace-escapes
11810 note
11811 (list (cons "%u" (user-login-name))
11812 (cons "%U" user-full-name)
11813 (cons "%t" (format-time-string
11814 (org-time-stamp-format 'long 'inactive)
11815 (current-time)))
11816 (cons "%T" (format-time-string
11817 (org-time-stamp-format 'long nil)
11818 (current-time)))
11819 (cons "%s" (if org-log-note-state
11821 ""))
11822 (cons "%S" (if org-log-note-previous-state
11826 (push note lines))
11827 (when (or current-prefix-arg org-note-abort)
11828 (when org-log-into-drawer
11829 (org-remove-empty-drawer-at
11830 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11831 org-log-note-marker))
11832 (setq lines nil))
11833 (when lines
11834 (with-current-buffer (marker-buffer org-log-note-marker)
11835 (save-excursion
11836 (goto-char org-log-note-marker)
11837 (move-marker org-log-note-marker nil)
11838 (end-of-line 1)
11840 (setq ind (save-excursion
11841 (if (org-in-item-p)
11842 (progn
11843 (goto-char (org-list-top-point))
11844 (org-get-indentation))
11846 (cond
11847 ((and (org-at-heading-p)
11848 org-adapt-indentation)
11849 (1+ (org-current-level)))
11850 ((org-at-heading-p) 0)
11851 (t (org-get-indentation))))))
11852 (setq bul (org-list-bullet-string "-"))
11853 (org-indent-line-to ind)
11854 (insert bul (pop lines))
11855 (let ((ind-body (+ (length bul) ind)))
11856 (while lines
11858 (org-indent-line-to ind-body)
11859 (insert (pop lines))))
11860 (message "Note stored")
11861 (org-back-to-heading t)
11862 (org-cycle-hide-drawers 'children)))))
11863 (set-window-configuration org-log-note-window-configuration)
11864 (with-current-buffer (marker-buffer org-log-note-return-to)
11865 (goto-char org-log-note-return-to))
11866 (move-marker org-log-note-return-to nil)
11867 (and org-log-post-message (message "%s" org-log-post-message)))
11869 (defun org-remove-empty-drawer-at (drawer pos)
11870 "Remove an empty drawer DRAWER at position POS.
11871 POS may also be a marker."
11872 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
11873 (save-excursion
11874 (save-restriction
11875 (widen)
11876 (goto-char pos)
11877 (if (org-in-regexp
11879 (replace-match ""))))))
11881 (defun org-sparse-tree (&optional arg)
11882 "Create a sparse tree, prompt for the details.
11883 This command can create sparse trees. You first need to select the type
11884 of match used to create the tree:
11886 t Show all TODO entries.
11887 T Show entries with a specific TODO keyword.
11888 m Show entries selected by a tags/property match.
11889 p Enter a property name and its value (both with completion on existing
11890 names/values) and show entries with that property.
11891 r Show entries matching a regular expression (`/' can be used as well)
11892 d Show deadlines due within `org-deadline-warning-days'.
11893 b Show deadlines and scheduled items before a date.
11894 a Show deadlines and scheduled items after a date."
11895 (interactive "P")
11896 (let (ans kwd value)
11897 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
11898 (setq ans (read-char-exclusive))
11899 (cond
11900 ((equal ans ?d)
11901 (call-interactively 'org-check-deadlines))
11902 ((equal ans ?b)
11903 (call-interactively 'org-check-before-date))
11904 ((equal ans ?a)
11905 (call-interactively 'org-check-after-date))
11906 ((equal ans ?t)
11907 (org-show-todo-tree nil))
11908 ((equal ans ?T)
11909 (org-show-todo-tree '(4)))
11910 ((member ans '(?T ?m))
11911 (call-interactively 'org-match-sparse-tree))
11912 ((member ans '(?p ?P))
11913 (setq kwd (org-icompleting-read "Property: "
11914 (mapcar 'list (org-buffer-property-keys))))
11915 (setq value (org-icompleting-read "Value: "
11916 (mapcar 'list (org-property-values kwd))))
11919 (org-match-sparse-tree arg (concat kwd "=" value)))
11920 ((member ans '(?r ?R ?/))
11921 (call-interactively 'org-occur))
11924 (defvar org-occur-highlights nil
11925 "List of overlays used for occur matches.")
11926 (make-variable-buffer-local 'org-occur-highlights)
11927 (defvar org-occur-parameters nil
11928 "Parameters of the active org-occur calls.
11929 This is a list, each call to org-occur pushes as cons cell,
11930 containing the regular expression and the callback, onto the list.
11931 The list can contain several entries if `org-occur' has been called
11932 several time with the KEEP-PREVIOUS argument. Otherwise, this list
11933 will only contain one set of parameters. When the highlights are
11934 removed (for example with `C-c C-c', or with the next edit (depending
11935 on `org-remove-highlights-with-change'), this variable is emptied
11936 as well.")
11937 (make-variable-buffer-local 'org-occur-parameters)
11939 (defun org-occur (regexp &optional keep-previous callback)
11940 "Make a compact tree which shows all matches of REGEXP.
11941 The tree will show the lines where the regexp matches, and all higher
11942 headlines above the match. It will also show the heading after the match,
11943 to make sure editing the matching entry is easy.
11944 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
11945 call to `org-occur' will be kept, to allow stacking of calls to this
11946 command.
11947 If CALLBACK is non-nil, it is a function which is called to confirm
11948 that the match should indeed be shown."
11950 (when (equal regexp "")
11951 (error "Regexp cannot be empty"))
11952 (unless keep-previous
11953 (org-remove-occur-highlights nil nil t))
11954 (push (cons regexp callback) org-occur-parameters)
11955 (let ((cnt 0))
11956 (save-excursion
11957 (goto-char (point-min))
11958 (if (or (not keep-previous) ; do not want to keep
11959 (not org-occur-highlights)) ; no previous matches
11960 ;; hide everything
11961 (org-overview))
11962 (while (re-search-forward regexp nil t)
11963 (when (or (not callback)
11964 (save-match-data (funcall callback)))
11965 (setq cnt (1+ cnt))
11966 (when org-highlight-sparse-tree-matches
11967 (org-highlight-new-match (match-beginning 0) (match-end 0)))
11968 (org-show-context 'occur-tree))))
11969 (when org-remove-highlights-with-change
11970 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
11971 nil 'local))
11972 (unless org-sparse-tree-open-archived-trees
11973 (org-hide-archived-subtrees (point-min) (point-max)))
11974 (run-hooks 'org-occur-hook)
11975 (if (interactive-p)
11976 (message "%d match(es) for regexp %s" cnt regexp))
11977 cnt))
11979 (defun org-show-context (&optional key)
11980 "Make sure point and context are visible.
11981 How much context is shown depends upon the variables
11982 `org-show-hierarchy-above', `org-show-following-heading'. and
11983 `org-show-siblings'."
11984 (let ((heading-p (org-on-heading-p t))
11985 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
11986 (following-p (org-get-alist-option org-show-following-heading key))
11987 (entry-p (org-get-alist-option org-show-entry-below key))
11988 (siblings-p (org-get-alist-option org-show-siblings key)))
11989 (catch 'exit
11990 ;; Show heading or entry text
11991 (if (and heading-p (not entry-p))
11992 (org-flag-heading nil) ; only show the heading
11993 (and (or entry-p (org-invisible-p) (org-invisible-p2))
11994 (org-show-hidden-entry))) ; show entire entry
11995 (when following-p
11996 ;; Show next sibling, or heading below text
11997 (save-excursion
11998 (and (if heading-p (org-goto-sibling) (outline-next-heading))
11999 (org-flag-heading nil))))
12000 (when siblings-p (org-show-siblings))
12001 (when hierarchy-p
12002 ;; show all higher headings, possibly with siblings
12003 (save-excursion
12004 (while (and (condition-case nil
12005 (progn (org-up-heading-all 1) t)
12006 (error nil))
12007 (not (bobp)))
12008 (org-flag-heading nil)
12009 (when siblings-p (org-show-siblings))))))))
12011 (defvar org-reveal-start-hook nil
12012 "Hook run before revealing a location.")
12014 (defun org-reveal (&optional siblings)
12015 "Show current entry, hierarchy above it, and the following headline.
12016 This can be used to show a consistent set of context around locations
12017 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12018 not t for the search context.
12020 With optional argument SIBLINGS, on each level of the hierarchy all
12021 siblings are shown. This repairs the tree structure to what it would
12022 look like when opened with hierarchical calls to `org-cycle'.
12024 go to the parent and show the
12025 entire tree."
12026 (interactive "P")
12027 (run-hooks 'org-reveal-start-hook)
12028 (let ((org-show-hierarchy-above t)
12029 (org-show-following-heading t)
12030 (org-show-siblings (if siblings t org-show-siblings)))
12031 (org-show-context nil))
12032 (when (equal siblings '(16))
12033 (save-excursion
12034 (when (org-up-heading-safe)
12035 (org-show-subtree)
12036 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12038 (defun org-highlight-new-match (beg end)
12039 "Highlight from BEG to END and mark the highlight is an occur headline."
12040 (let ((ov (make-overlay beg end)))
12041 (overlay-put ov 'face 'secondary-selection)
12042 (push ov org-occur-highlights)))
12044 (defun org-remove-occur-highlights (&optional beg end noremove)
12045 "Remove the occur highlights from the buffer.
12046 BEG and END are ignored. If NOREMOVE is nil, remove this function
12047 from the `before-change-functions' in the current buffer."
12048 (interactive)
12049 (unless org-inhibit-highlight-removal
12050 (mapc 'delete-overlay org-occur-highlights)
12051 (setq org-occur-highlights nil)
12052 (setq org-occur-parameters nil)
12053 (unless noremove
12054 (remove-hook 'before-change-functions
12055 'org-remove-occur-highlights 'local))))
12057 ;;;; Priorities
12060 "Regular expression matching the priority indicator.")
12062 (defvar org-remove-priority-next-time nil)
12064 (defun org-priority-up ()
12065 "Increase the priority of the current item."
12066 (interactive)
12067 (org-priority 'up))
12069 (defun org-priority-down ()
12070 "Decrease the priority of the current item."
12071 (interactive)
12072 (org-priority 'down))
12074 (defun org-priority (&optional action)
12075 "Change the priority of an item by ARG.
12076 ACTION can be `set', `up', `down', or a character."
12077 (interactive)
12078 (unless org-enable-priority-commands
12079 (error "Priority commands are disabled"))
12080 (setq action (or action 'set))
12081 (let (current new news have remove)
12082 (save-excursion
12083 (org-back-to-heading t)
12084 (if (looking-at org-priority-regexp)
12085 (setq current (string-to-char (match-string 2))
12086 have t)
12087 (setq current org-default-priority))
12088 (cond
12089 ((eq action 'remove)
12090 (setq remove t new ?\ ))
12091 ((or (eq action 'set)
12092 (if (featurep 'xemacs) (characterp action) (integerp action)))
12093 (if (not (eq action 'set))
12094 (setq new action)
12095 (message "Priority %c-%c, SPC to remove: "
12096 org-highest-priority org-lowest-priority)
12097 (save-match-data
12098 (setq new (read-char-exclusive))))
12099 (if (and (= (upcase org-highest-priority) org-highest-priority)
12100 (= (upcase org-lowest-priority) org-lowest-priority))
12101 (setq new (upcase new)))
12102 (cond ((equal new ?\ ) (setq remove t))
12103 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12104 (error "Priority must be between `%c' and `%c'"
12105 org-highest-priority org-lowest-priority))))
12106 ((eq action 'up)
12107 (if (and (not have) (eq last-command this-command))
12108 (setq new org-lowest-priority)
12109 (setq new (if (and org-priority-start-cycle-with-default (not have))
12110 org-default-priority (1- current)))))
12111 ((eq action 'down)
12112 (if (and (not have) (eq last-command this-command))
12113 (setq new org-highest-priority)
12114 (setq new (if (and org-priority-start-cycle-with-default (not have))
12115 org-default-priority (1+ current)))))
12116 (t (error "Invalid action")))
12117 (if (or (< (upcase new) org-highest-priority)
12118 (> (upcase new) org-lowest-priority))
12119 (setq remove t))
12120 (setq news (format "%c" new))
12121 (if have
12122 (if remove
12123 (replace-match "" t t nil 1)
12124 (replace-match news t t nil 2))
12125 (if remove
12126 (error "No priority cookie found in line")
12127 (let ((case-fold-search nil))
12128 (looking-at org-todo-line-regexp))
12129 (if (match-end 2)
12130 (progn
12131 (goto-char (match-end 2))
12132 (insert " [#" news "]"))
12133 (goto-char (match-beginning 3))
12134 (insert "[#" news "] "))))
12135 (org-preserve-lc (org-set-tags nil 'align)))
12136 (if remove
12137 (message "Priority removed")
12138 (message "Priority of current item set to %s" news))))
12140 (defun org-get-priority (s)
12141 "Find priority cookie and return priority."
12142 (if (functionp org-get-priority-function)
12143 (funcall org-get-priority-function)
12144 (save-match-data
12145 (if (not (string-match org-priority-regexp s))
12146 (* 1000 (- org-lowest-priority org-default-priority))
12147 (* 1000 (- org-lowest-priority
12148 (string-to-char (match-string 2 s))))))))
12150 ;;;; Tags
12152 (defvar org-agenda-archives-mode)
12153 (defvar org-map-continue-from nil
12154 "Position from where mapping should continue.
12155 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12157 (defvar org-scanner-tags nil
12158 "The current tag list while the tags scanner is running.")
12159 (defvar org-trust-scanner-tags nil
12160 "Should `org-get-tags-at' use the tags fro the scanner.
12161 This is for internal dynamical scoping only.
12162 When this is non-nil, the function `org-get-tags-at' will return the value
12163 of `org-scanner-tags' instead of building the list by itself. This
12164 can lead to large speed-ups when the tags scanner is used in a file with
12165 many entries, and when the list of tags is retrieved, for example to
12166 obtain a list of properties. Building the tags list for each entry in such
12167 a file becomes an N^2 operation - but with this variable set, it scales
12168 as N.")
12170 (defun org-scan-tags (action matcher &optional todo-only)
12171 "Scan headline tags with inheritance and produce output ACTION.
12173 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12174 or `agenda' to produce an entry list for an agenda view. It can also be
12175 a Lisp form or a function that should be called at each matched headline, in
12176 this case the return value is a list of all return values from these calls.
12178 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12179 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12180 only lines with a TODO keyword are included in the output."
12181 (require 'org-agenda)
12184 (org-re
12186 (props (list 'face 'default
12187 'done-face 'org-agenda-done
12188 'undone-face 'default
12189 'mouse-face 'highlight
12190 'org-not-done-regexp org-not-done-regexp
12191 'org-todo-regexp org-todo-regexp
12192 'help-echo
12193 (format "mouse-2 or RET jump to org file %s"
12194 (abbreviate-file-name
12195 (or (buffer-file-name (buffer-base-buffer))
12196 (buffer-name (buffer-base-buffer)))))))
12197 (case-fold-search nil)
12198 (org-map-continue-from nil)
12199 lspos tags tags-list
12200 (tags-alist (list (cons 0 org-file-tags)))
12201 (llast 0) rtn rtn1 level category i txt
12202 todo marker entry priority)
12203 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12204 (setq action (list 'lambda nil action)))
12205 (save-excursion
12206 (goto-char (point-min))
12207 (when (eq action 'sparse-tree)
12208 (org-overview)
12209 (org-remove-occur-highlights))
12210 (while (re-search-forward re nil t)
12211 (catch :skip
12212 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12213 tags (if (match-end 4) (org-match-string-no-properties 4)))
12214 (goto-char (setq lspos (match-beginning 0)))
12215 (setq level (org-reduced-level (funcall outline-level))
12216 category (org-get-category))
12217 (setq i llast llast level)
12218 ;; remove tag lists from same and sublevels
12219 (while (>= i level)
12220 (when (setq entry (assoc i tags-alist))
12221 (setq tags-alist (delete entry tags-alist)))
12222 (setq i (1- i)))
12223 ;; add the next tags
12224 (when tags
12225 (setq tags (org-split-string tags ":")
12226 tags-alist
12227 (cons (cons level tags) tags-alist)))
12228 ;; compile tags for current headline
12229 (setq tags-list
12230 (if org-use-tag-inheritance
12231 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12232 tags)
12233 org-scanner-tags tags-list)
12234 (when org-use-tag-inheritance
12235 (setcdr (car tags-alist)
12236 (mapcar (lambda (x)
12237 (setq x (copy-sequence x))
12238 (org-add-prop-inherited x))
12239 (cdar tags-alist))))
12240 (when (and tags org-use-tag-inheritance
12241 (or (not (eq t org-use-tag-inheritance))
12242 org-tags-exclude-from-inheritance))
12243 ;; selective inheritance, remove uninherited ones
12244 (setcdr (car tags-alist)
12245 (org-remove-uniherited-tags (cdar tags-alist))))
12246 (when (and (or (not todo-only)
12247 (and (member todo org-not-done-keywords)
12248 (or (not org-agenda-tags-todo-honor-ignore-options)
12249 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12250 (let ((case-fold-search t)) (eval matcher))
12251 (or
12252 (not (member org-archive-tag tags-list))
12253 ;; we have an archive tag, should we use this anyway?
12254 (or (not org-agenda-skip-archived-trees)
12255 (and (eq action 'agenda) org-agenda-archives-mode))))
12256 (unless (eq action 'sparse-tree) (org-agenda-skip))
12258 ;; select this headline
12260 (cond
12261 ((eq action 'sparse-tree)
12262 (and org-highlight-sparse-tree-matches
12263 (org-get-heading) (match-end 0)
12264 (org-highlight-new-match
12265 (match-beginning 0) (match-beginning 1)))
12266 (org-show-context 'tags-tree))
12267 ((eq action 'agenda)
12268 (setq txt (org-format-agenda-item
12269 ""
12270 (concat
12271 (if (eq org-tags-match-list-sublevels 'indented)
12272 (make-string (1- level) ?.) "")
12273 (org-get-heading))
12274 category
12275 tags-list
12276 )
12277 priority (org-get-priority txt))
12278 (goto-char lspos)
12279 (setq marker (org-agenda-new-marker))
12280 (org-add-props txt props
12281 'org-marker marker 'org-hd-marker marker 'org-category category
12282 'todo-state todo
12283 'priority priority 'type "tagsmatch")
12284 (push txt rtn))
12285 ((functionp action)
12286 (setq org-map-continue-from nil)
12287 (save-excursion
12288 (setq rtn1 (funcall action))
12289 (push rtn1 rtn)))
12290 (t (error "Invalid action")))
12292 ;; if we are to skip sublevels, jump to end of subtree
12293 (unless org-tags-match-list-sublevels
12294 (org-end-of-subtree t)
12295 (backward-char 1))))
12296 ;; Get the correct position from where to continue
12297 (if org-map-continue-from
12298 (goto-char org-map-continue-from)
12299 (and (= (point) lspos) (end-of-line 1)))))
12300 (when (and (eq action 'sparse-tree)
12301 (not org-sparse-tree-open-archived-trees))
12302 (org-hide-archived-subtrees (point-min) (point-max)))
12303 (nreverse rtn)))
12305 (defun org-remove-uniherited-tags (tags)
12306 "Remove all tags that are not inherited from the list TAGS."
12307 (cond
12308 ((eq org-use-tag-inheritance t)
12309 (if org-tags-exclude-from-inheritance
12310 (org-delete-all org-tags-exclude-from-inheritance tags)
12311 tags))
12312 ((not org-use-tag-inheritance) nil)
12313 ((stringp org-use-tag-inheritance)
12314 (delq nil (mapcar
12315 (lambda (x)
12316 (if (and (string-match org-use-tag-inheritance x)
12317 (not (member x org-tags-exclude-from-inheritance)))
12318 x nil))
12319 tags)))
12320 ((listp org-use-tag-inheritance)
12321 (delq nil (mapcar
12322 (lambda (x)
12323 (if (member x org-use-tag-inheritance) x nil))
12324 tags)))))
12326 (defvar todo-only) ;; dynamically scoped
12328 (defun org-match-sparse-tree (&optional todo-only match)
12329 "Create a sparse tree according to tags string MATCH.
12330 MATCH can contain positive and negative selection of tags, like
12332 If optional argument TODO-ONLY is non-nil, only select lines that are
12333 also TODO lines."
12334 (interactive "P")
12335 (org-prepare-agenda-buffers (list (current-buffer)))
12336 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12338 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12340 (defvar org-cached-props nil)
12341 (defun org-cached-entry-get (pom property)
12342 (if (or (eq t org-use-property-inheritance)
12343 (and (stringp org-use-property-inheritance)
12344 (string-match org-use-property-inheritance property))
12345 (and (listp org-use-property-inheritance)
12346 (member property org-use-property-inheritance)))
12347 ;; Caching is not possible, check it directly
12348 (org-entry-get pom property 'inherit)
12349 ;; Get all properties, so that we can do complicated checks easily
12350 (cdr (assoc property (or org-cached-props
12351 (setq org-cached-props
12352 (org-entry-properties pom)))))))
12354 (defun org-global-tags-completion-table (&optional files)
12355 "Return the list of all tags in all agenda buffer/files."
12356 (save-excursion
12357 (org-uniquify
12358 (delq nil
12359 (apply 'append
12360 (mapcar
12361 (lambda (file)
12362 (set-buffer (find-file-noselect file))
12363 (append (org-get-buffer-tags)
12364 (mapcar (lambda (x) (if (stringp (car-safe x))
12365 (list (car-safe x)) nil))
12366 org-tag-alist)))
12367 (if (and files (car files))
12368 files
12369 (org-agenda-files))))))))
12371 (defun org-make-tags-matcher (match)
12372 "Create the TAGS//TODO matcher form for the selection string MATCH."
12373 ;; todo-only is scoped dynamically into this function, and the function
12374 ;; may change it if the matcher asks for it.
12375 (unless match
12376 ;; Get a new match request, with completion
12377 (let ((org-last-tags-completion-table
12378 (org-global-tags-completion-table)))
12379 (setq match (org-completing-read-no-i
12380 "Match: " 'org-tags-completion-function nil nil nil
12381 'org-tags-history))))
12383 ;; Parse the string and create a lisp form
12384 (let ((match0 match)
12385 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12386 minus tag mm
12387 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12388 orterms term orlist re-p str-p level-p level-op time-p
12389 prop-p pn pv po gv rest)
12390 (if (string-match "/+" match)
12391 ;; match contains also a todo-matching request
12392 (progn
12393 (setq tagsmatch (substring match 0 (match-beginning 0))
12394 todomatch (substring match (match-end 0)))
12395 (if (string-match "^!" todomatch)
12396 (setq todo-only t todomatch (substring todomatch 1)))
12398 (setq todomatch nil)))
12399 ;; only matching tags
12400 (setq tagsmatch match todomatch nil))
12402 ;; Make the tags matcher
12404 (setq tagsmatcher t)
12405 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12406 (while (setq term (pop orterms))
12408 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12409 (while (string-match re term)
12410 (setq rest (substring term (match-end 0))
12411 minus (and (match-end 1)
12412 (equal (match-string 1 term) "-"))
12413 tag (save-match-data (replace-regexp-in-string
12415 (match-string 2 term)))
12416 re-p (equal (string-to-char tag) ?{)
12417 level-p (match-end 4)
12418 prop-p (match-end 5)
12419 mm (cond
12420 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12421 (level-p
12422 (setq level-op (org-op-to-function (match-string 3 term)))
12423 `(,level-op level ,(string-to-number
12424 (match-string 4 term))))
12425 (prop-p
12426 (setq pn (match-string 5 term)
12427 po (match-string 6 term)
12428 pv (match-string 7 term)
12429 re-p (equal (string-to-char pv) ?{)
12431 time-p (save-match-data
12433 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12434 (if time-p (setq pv (org-matcher-time pv)))
12435 (setq po (org-op-to-function po (if time-p 'time str-p)))
12436 (cond
12437 ((equal pn "CATEGORY")
12438 (setq gv '(get-text-property (point) 'org-category)))
12439 ((equal pn "TODO")
12440 (setq gv 'todo))
12441 (t
12442 (setq gv `(org-cached-entry-get nil ,pn))))
12443 (if re-p
12444 (if (eq po 'org<>)
12445 `(not (string-match ,pv (or ,gv "")))
12446 `(string-match ,pv (or ,gv "")))
12447 (if str-p
12448 `(,po (or ,gv "") ,pv)
12449 `(,po (string-to-number (or ,gv ""))
12450 ,(string-to-number pv) ))))
12451 (t `(member ,tag tags-list)))
12452 mm (if minus (list 'not mm) mm)
12453 term rest)
12454 (push mm tagsmatcher))
12455 (push (if (> (length tagsmatcher) 1)
12456 (cons 'and tagsmatcher)
12457 (car tagsmatcher))
12458 orlist)
12459 (setq tagsmatcher nil))
12460 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12461 (setq tagsmatcher
12462 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12463 ;; Make the todo matcher
12465 (setq todomatcher t)
12466 (setq orterms (org-split-string todomatch "|") orlist nil)
12467 (while (setq term (pop orterms))
12468 (while (string-match re term)
12469 (setq minus (and (match-end 1)
12470 (equal (match-string 1 term) "-"))
12471 kwd (match-string 2 term)
12472 re-p (equal (string-to-char kwd) ?{)
12473 term (substring term (match-end 0))
12474 mm (if re-p
12475 `(string-match ,(substring kwd 1 -1) todo)
12476 (list 'equal 'todo kwd))
12477 mm (if minus (list 'not mm) mm))
12478 (push mm todomatcher))
12479 (push (if (> (length todomatcher) 1)
12480 (cons 'and todomatcher)
12481 (car todomatcher))
12482 orlist)
12483 (setq todomatcher nil))
12484 (setq todomatcher (if (> (length orlist) 1)
12485 (cons 'or orlist) (car orlist))))
12487 ;; Return the string and lisp forms of the matcher
12488 (setq matcher (if todomatcher
12489 (list 'and tagsmatcher todomatcher)
12490 tagsmatcher))
12491 (cons match0 matcher)))
12493 (defun org-op-to-function (op &optional stringp)
12494 "Turn an operator into the appropriate function."
12495 (setq op
12496 (cond
12497 ((equal op "<" ) '(< string< org-time<))
12498 ((equal op ">" ) '(> org-string> org-time>))
12499 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12500 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12501 ((member op '("=" "==")) '(= string= org-time=))
12502 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12503 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12505 (defun org<> (a b) (not (= a b)))
12506 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12507 (defun org-string>= (a b) (not (string< a b)))
12508 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12509 (defun org-string<> (a b) (not (string= a b)))
12510 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12511 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12512 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12513 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12514 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12515 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12516 (defun org-2ft (s)
12517 "Convert S to a floating point time.
12518 If S is already a number, just return it. If it is a string, parse
12519 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12520 (cond
12521 ((numberp s) s)
12522 ((stringp s)
12523 (condition-case nil
12524 (float-time (apply 'encode-time (org-parse-time-string s)))
12525 (error 0.)))
12526 (t 0.)))
12528 (defun org-time-today ()
12529 "Time in seconds today at 0:00.
12530 Returns the float number of seconds since the beginning of the
12531 epoch to the beginning of today (00:00)."
12532 (float-time (apply 'encode-time
12533 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12535 (defun org-matcher-time (s)
12536 "Interpret a time comparison value."
12537 (save-match-data
12538 (cond
12539 ((string= s "<now>") (float-time))
12540 ((string= s "<today>") (org-time-today))
12541 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12542 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12544 (+ (org-time-today)
12545 (* (string-to-number (match-string 1 s))
12546 (cdr (assoc (match-string 2 s)
12547 '(("d" . 86400.0) ("w" . 604800.0)
12548 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12549 (t (org-2ft s)))))
12551 (defun org-match-any-p (re list)
12552 "Does re match any element of list?"
12553 (setq list (mapcar (lambda (x) (string-match re x)) list))
12554 (delq nil list))
12556 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12557 (defvar org-tags-overlay (make-overlay 1 1))
12558 (org-detach-overlay org-tags-overlay)
12560 (defun org-get-local-tags-at (&optional pos)
12561 "Get a list of tags defined in the current headline."
12562 (org-get-tags-at pos 'local))
12564 (defun org-get-local-tags ()
12565 "Get a list of tags defined in the current headline."
12566 (org-get-tags-at nil 'local))
12568 (defun org-get-tags-at (&optional pos local)
12569 "Get a list of all headline tags applicable at POS.
12570 POS defaults to point. If tags are inherited, the list contains
12571 the targets in the same sequence as the headlines appear, i.e.
12572 the tags of the current headline come last.
12573 When LOCAL is non-nil, only return tags from the current headline,
12574 ignore inherited ones."
12575 (interactive)
12576 (if (and org-trust-scanner-tags
12577 (or (not pos) (equal pos (point)))
12578 (not local))
12579 org-scanner-tags
12580 (let (tags ltags lastpos parent)
12581 (save-excursion
12582 (save-restriction
12583 (widen)
12584 (goto-char (or pos (point)))
12585 (save-match-data
12586 (catch 'done
12587 (condition-case nil
12588 (progn
12589 (org-back-to-heading t)
12590 (while (not (equal lastpos (point)))
12591 (setq lastpos (point))
12592 (when (looking-at
12594 (setq ltags (org-split-string
12595 (org-match-string-no-properties 1) ":"))
12596 (when parent
12597 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12598 (setq tags (append
12599 (if parent
12600 (org-remove-uniherited-tags ltags)
12601 ltags)
12602 tags)))
12603 (or org-use-tag-inheritance (throw 'done t))
12604 (if local (throw 'done t))
12605 (or (org-up-heading-safe) (error nil))
12606 (setq parent t)))
12607 (error nil)))))
12608 (append (org-remove-uniherited-tags org-file-tags) tags)))))
12610 (defun org-add-prop-inherited (s)
12611 (add-text-properties 0 (length s) '(inherited t) s)
12612 s)
12614 (defun org-toggle-tag (tag &optional onoff)
12615 "Toggle the tag TAG for the current line.
12616 If ONOFF is `on' or `off', don't toggle but set to this state."
12617 (let (res current)
12618 (save-excursion
12619 (org-back-to-heading t)
12621 (point-at-eol) t)
12622 (progn
12623 (setq current (match-string 1))
12624 (replace-match ""))
12625 (setq current ""))
12626 (setq current (nreverse (org-split-string current ":")))
12627 (cond
12628 ((eq onoff 'on)
12629 (setq res t)
12630 (or (member tag current) (push tag current)))
12631 ((eq onoff 'off)
12632 (or (not (member tag current)) (setq current (delete tag current))))
12633 (t (if (member tag current)
12634 (setq current (delete tag current))
12635 (setq res t)
12636 (push tag current))))
12637 (end-of-line 1)
12638 (if current
12639 (progn
12640 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12641 (org-set-tags nil t))
12642 (delete-horizontal-space))
12643 (run-hooks 'org-after-tags-change-hook))
12644 res))
12646 (defun org-align-tags-here (to-col)
12647 ;; Assumes that this is a headline
12648 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12649 (beginning-of-line 1)
12651 (< pos (match-beginning 2)))
12652 (progn
12653 (setq tags-l (- (match-end 2) (match-beginning 2)))
12654 (goto-char (match-beginning 1))
12655 (insert " ")
12656 (delete-region (point) (1+ (match-beginning 2)))
12657 (setq ncol (max (1+ (current-column))
12658 (1+ col)
12659 (if (> to-col 0)
12660 to-col
12661 (- (abs to-col) tags-l))))
12662 (setq p (point))
12663 (insert (make-string (- ncol (current-column)) ?\ ))
12664 (setq ncol (current-column))
12665 (when indent-tabs-mode (tabify p (point-at-eol)))
12666 (org-move-to-column (min ncol col) t))
12667 (goto-char pos))))
12669 (defun org-set-tags-command (&optional arg just-align)
12670 "Call the set-tags command for the current entry."
12671 (interactive "P")
12672 (if (org-on-heading-p)
12673 (org-set-tags arg just-align)
12674 (save-excursion
12675 (org-back-to-heading t)
12676 (org-set-tags arg just-align))))
12678 (defun org-set-tags-to (data)
12679 "Set the tags of the current entry to DATA, replacing the current tags.
12680 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12681 If DATA is nil or the empty string, any tags will be removed."
12682 (interactive "sTags: ")
12683 (setq data
12684 (cond
12685 ((eq data nil) "")
12686 ((equal data "") "")
12687 ((stringp data)
12688 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12689 ":"))
12690 ((listp data)
12691 (concat ":" (mapconcat 'identity data ":") ":"))
12692 (t nil)))
12693 (when data
12694 (save-excursion
12695 (org-back-to-heading t)
12696 (when (looking-at org-complex-heading-regexp)
12697 (if (match-end 5)
12698 (progn
12699 (goto-char (match-beginning 5))
12700 (insert data)
12701 (delete-region (point) (point-at-eol))
12702 (org-set-tags nil 'align))
12703 (goto-char (point-at-eol))
12704 (insert " " data)
12705 (org-set-tags nil 'align)))
12706 (beginning-of-line 1)
12708 (delete-region (match-beginning 1) (match-end 1))))))
12710 (defun org-align-all-tags ()
12711 "Align the tags i all headings."
12712 (interactive)
12713 (save-excursion
12714 (or (ignore-errors (org-back-to-heading t))
12715 (outline-next-heading))
12716 (if (org-on-heading-p)
12717 (org-set-tags t)
12718 (message "No headings"))))
12720 (defvar org-indent-indentation-per-level)
12721 (defun org-set-tags (&optional arg just-align)
12722 "Set the tags for the current headline.
12723 With prefix ARG, realign all tags in headings in the current buffer."
12724 (interactive "P")
12725 (let* ((re (concat "^" outline-regexp))
12726 (current (org-get-tags-string))
12727 (col (current-column))
12728 (org-setting-tags t)
12729 table current-tags inherited-tags ; computed below when needed
12730 tags p0 c0 c1 rpl di tc level)
12731 (if arg
12732 (save-excursion
12733 (goto-char (point-min))
12734 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12735 (while (re-search-forward re nil t)
12736 (org-set-tags nil t)
12737 (end-of-line 1)))
12738 (message "All tags realigned to column %d" org-tags-column))
12739 (if just-align
12740 (setq tags current)
12741 ;; Get a new set of tags from the user
12742 (save-excursion
12743 (setq table (append org-tag-persistent-alist
12744 (or org-tag-alist (org-get-buffer-tags))
12745 (and
12746 org-complete-tags-always-offer-all-agenda-tags
12747 (org-global-tags-completion-table
12748 (org-agenda-files))))
12749 org-last-tags-completion-table table
12750 current-tags (org-split-string current ":")
12751 inherited-tags (nreverse
12752 (nthcdr (length current-tags)
12753 (nreverse (org-get-tags-at))))
12754 tags
12755 (if (or (eq t org-use-fast-tag-selection)
12756 (and org-use-fast-tag-selection
12757 (delq nil (mapcar 'cdr table))))
12758 (org-fast-tag-selection
12759 current-tags inherited-tags table
12760 (if org-fast-tag-selection-include-todo
12761 org-todo-key-alist))
12762 (let ((org-add-colon-after-tag-completion t))
12763 (org-trim
12764 (org-without-partial-completion
12765 (org-icompleting-read "Tags: "
12766 'org-tags-completion-function
12767 nil nil current 'org-tags-history)))))))
12768 (while (string-match "[-+&]+" tags)
12769 ;; No boolean logic, just a list
12770 (setq tags (replace-match ":" t t tags))))
12772 (setq tags (replace-regexp-in-string "[ ,]" ":" tags))
12774 (if org-tags-sort-function
12775 (setq tags (mapconcat 'identity
12776 (sort (org-split-string
12777 tags (org-re "[^[:alnum:]_@#%]+"))
12778 org-tags-sort-function) ":")))
12781 (setq tags "")
12782 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12783 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12785 ;; Insert new tags at the correct column
12786 (beginning-of-line 1)
12787 (setq level (or (and (looking-at org-outline-regexp)
12788 (- (match-end 0) (point) 1))
12789 1))
12790 (cond
12791 ((and (equal current "") (equal tags "")))
12792 ((re-search-forward
12794 (point-at-eol) t)
12795 (if (equal tags "")
12796 (setq rpl "")
12797 (goto-char (match-beginning 0))
12798 (setq c0 (current-column)
12799 ;; compute offset for the case of org-indent-mode active
12800 di (if org-indent-mode
12801 (* (1- org-indent-indentation-per-level) (1- level))
12802 0)
12803 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
12804 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
12805 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
12806 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12807 (replace-match rpl t t)
12808 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
12809 tags)
12810 (t (error "Tags alignment failed")))
12811 (org-move-to-column col)
12812 (unless just-align
12813 (run-hooks 'org-after-tags-change-hook)))))
12815 (defun org-change-tag-in-region (beg end tag off)
12816 "Add or remove TAG for each entry in the region.
12817 This works in the agenda, and also in an org-mode buffer."
12818 (interactive
12819 (list (region-beginning) (region-end)
12820 (let ((org-last-tags-completion-table
12821 (if (org-mode-p)
12822 (org-get-buffer-tags)
12823 (org-global-tags-completion-table))))
12824 (org-icompleting-read
12825 "Tag: " 'org-tags-completion-function nil nil nil
12826 'org-tags-history))
12827 (progn
12829 (equal (read-char-exclusive) ?r))))
12830 (if (fboundp 'deactivate-mark) (deactivate-mark))
12831 (let ((agendap (equal major-mode 'org-agenda-mode))
12832 l1 l2 m buf pos newhead (cnt 0))
12833 (goto-char end)
12834 (setq l2 (1- (org-current-line)))
12835 (goto-char beg)
12836 (setq l1 (org-current-line))
12837 (loop for l from l1 to l2 do
12838 (org-goto-line l)
12839 (setq m (get-text-property (point) 'org-hd-marker))
12840 (when (or (and (org-mode-p) (org-on-heading-p))
12841 (and agendap m))
12842 (setq buf (if agendap (marker-buffer m) (current-buffer))
12843 pos (if agendap m (point)))
12844 (with-current-buffer buf
12845 (save-excursion
12846 (save-restriction
12847 (goto-char pos)
12848 (setq cnt (1+ cnt))
12849 (org-toggle-tag tag (if off 'off 'on))
12850 (setq newhead (org-get-heading)))))
12851 (and agendap (org-agenda-change-all-lines newhead m))))
12852 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
12854 (defun org-tags-completion-function (string predicate &optional flag)
12855 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12856 (confirm (lambda (x) (stringp (car x)))))
12858 (setq s1 (match-string 1 string)
12859 s2 (match-string 2 string))
12860 (setq s1 "" s2 string))
12861 (cond
12862 ((eq flag nil)
12863 ;; try completion
12864 (setq rtn (try-completion s2 ctable confirm))
12865 (if (stringp rtn)
12866 (setq rtn
12867 (concat s1 s2 (substring rtn (length s2))
12868 (if (and org-add-colon-after-tag-completion
12869 (assoc rtn ctable))
12870 ":" ""))))
12871 rtn)
12872 ((eq flag t)
12873 ;; all-completions
12874 (all-completions s2 ctable confirm)
12875 )
12876 ((eq flag 'lambda)
12877 ;; exact match?
12878 (assoc s2 ctable)))
12879 ))
12881 (defun org-fast-tag-insert (kwd tags face &optional end)
12882 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
12883 (insert (format "%-12s" (concat kwd ":"))
12884 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
12885 (or end "")))
12887 (defun org-fast-tag-show-exit (flag)
12888 (save-excursion
12889 (org-goto-line 3)
12891 (replace-match ""))
12892 (when flag
12893 (end-of-line 1)
12894 (org-move-to-column (- (window-width) 19) t)
12895 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
12897 (defun org-set-current-tags-overlay (current prefix)
12898 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
12899 (if (featurep 'xemacs)
12900 (org-overlay-display org-tags-overlay (concat prefix s)
12901 'secondary-selection)
12902 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
12903 (org-overlay-display org-tags-overlay (concat prefix s)))))
12905 (defvar org-last-tag-selection-key nil)
12906 (defun org-fast-tag-selection (current inherited table &optional todo-table)
12907 "Fast tag selection with single keys.
12908 CURRENT is the current list of tags in the headline, INHERITED is the
12909 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
12910 possibly with grouping information. TODO-TABLE is a similar table with
12911 TODO keywords, should these have keys assigned to them.
12912 If the keys are nil, a-z are automatically assigned.
12913 Returns the new tags string, or nil to not change the current settings."
12914 (let* ((fulltable (append table todo-table))
12915 (maxlen (apply 'max (mapcar
12916 (lambda (x)
12917 (if (stringp (car x)) (string-width (car x)) 0))
12918 fulltable)))
12919 (buf (current-buffer))
12920 (expert (eq org-fast-tag-selection-single-key 'expert))
12921 (buffer-tags nil)
12922 (fwidth (+ maxlen 3 1 3))
12923 (ncol (/ (- (window-width) 4) fwidth))
12924 (i-face 'org-done)
12925 (c-face 'org-todo)
12926 tg cnt e c char c1 c2 ntable tbl rtn
12927 ov-start ov-end ov-prefix
12928 (exit-after-next org-fast-tag-selection-single-key)
12929 (done-keywords org-done-keywords)
12930 groups ingroup)
12931 (save-excursion
12932 (beginning-of-line 1)
12933 (if (looking-at
12935 (setq ov-start (match-beginning 1)
12936 ov-end (match-end 1)
12937 ov-prefix "")
12938 (setq ov-start (1- (point-at-eol))
12939 ov-end (1+ ov-start))
12941 (setq ov-prefix
12942 (concat
12943 (buffer-substring (1- (point)) (point))
12944 (if (> (current-column) org-tags-column)
12945 " "
12946 (make-string (- org-tags-column (current-column)) ?\ ))))))
12947 (move-overlay org-tags-overlay ov-start ov-end)
12948 (save-window-excursion
12949 (if expert
12950 (set-buffer (get-buffer-create " *Org tags*"))
12951 (delete-other-windows)
12952 (split-window-vertically)
12953 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
12954 (erase-buffer)
12955 (org-set-local 'org-done-keywords done-keywords)
12958 (org-fast-tag-show-exit exit-after-next)
12959 (org-set-current-tags-overlay current ov-prefix)
12960 (setq tbl fulltable char ?a cnt 0)
12961 (while (setq e (pop tbl))
12962 (cond
12963 ((equal (car e) :startgroup)
12964 (push '() groups) (setq ingroup t)
12965 (when (not (= cnt 0))
12966 (setq cnt 0)
12968 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
12969 ((equal (car e) :endgroup)
12970 (setq ingroup nil cnt 0)
12972 ((equal e '(:newline))
12973 (when (not (= cnt 0))
12974 (setq cnt 0)
12976 (setq e (car tbl))
12977 (while (equal (car tbl) '(:newline))
12979 (setq tbl (cdr tbl)))))
12980 (t
12981 (setq tg (copy-sequence (car e)) c2 nil)
12982 (if (cdr e)
12983 (setq c (cdr e))
12984 ;; automatically assign a character.
12985 (setq c1 (string-to-char
12986 (downcase (substring
12987 tg (if (= (string-to-char tg) ?@) 1 0)))))
12988 (if (or (rassoc c1 ntable) (rassoc c1 table))
12989 (while (or (rassoc char ntable) (rassoc char table))
12990 (setq char (1+ char)))
12991 (setq c2 c1))
12992 (setq c (or c2 char)))
12993 (if ingroup (push tg (car groups)))
12994 (setq tg (org-add-props tg nil 'face
12995 (cond
12996 ((not (assoc tg table))
12997 (org-get-todo-face tg))
12998 ((member tg current) c-face)
12999 ((member tg inherited) i-face)
13000 (t nil))))
13001 (if (and (= cnt 0) (not ingroup)) (insert " "))
13002 (insert "[" c "] " tg (make-string
13003 (- fwidth 4 (length tg)) ?\ ))
13004 (push (cons tg c) ntable)
13005 (when (= (setq cnt (1+ cnt)) ncol)
13007 (if ingroup (insert " "))
13008 (setq cnt 0)))))
13009 (setq ntable (nreverse ntable))
13011 (goto-char (point-min))
13012 (if (not expert) (org-fit-window-to-buffer))
13013 (setq rtn
13014 (catch 'exit
13015 (while t
13016 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13017 (if (not groups) "no " "")
13018 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13019 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13020 (setq org-last-tag-selection-key c)
13021 (cond
13023 ((= c ?!)
13024 (setq groups (not groups))
13025 (goto-char (point-min))
13026 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13027 ((= c ?\C-c)
13028 (if (not expert)
13029 (org-fast-tag-show-exit
13030 (setq exit-after-next (not exit-after-next)))
13031 (setq expert nil)
13032 (delete-other-windows)
13033 (set-window-buffer (split-window-vertically) " *Org tags*")
13034 (org-switch-to-buffer-other-window " *Org tags*")
13035 (org-fit-window-to-buffer)))
13036 ((or (= c ?\C-g)
13037 (and (= c ?q) (not (rassoc c ntable))))
13038 (org-detach-overlay org-tags-overlay)
13039 (setq quit-flag t))
13040 ((= c ?\ )
13041 (setq current nil)
13042 (if exit-after-next (setq exit-after-next 'now)))
13044 (condition-case nil
13045 (setq tg (org-icompleting-read
13046 "Tag: "
13047 (or buffer-tags
13048 (with-current-buffer buf
13049 (org-get-buffer-tags)))))
13050 (quit (setq tg "")))
13052 (add-to-list 'buffer-tags (list tg))
13053 (if (member tg current)
13054 (setq current (delete tg current))
13055 (push tg current)))
13056 (if exit-after-next (setq exit-after-next 'now)))
13057 ((setq e (rassoc c todo-table) tg (car e))
13058 (with-current-buffer buf
13059 (save-excursion (org-todo tg)))
13060 (if exit-after-next (setq exit-after-next 'now)))
13061 ((setq e (rassoc c ntable) tg (car e))
13062 (if (member tg current)
13063 (setq current (delete tg current))
13064 (loop for g in groups do
13065 (if (member tg g)
13066 (mapc (lambda (x)
13067 (setq current (delete x current)))
13068 g)))
13069 (push tg current))
13070 (if exit-after-next (setq exit-after-next 'now))))
13072 ;; Create a sorted list
13073 (setq current
13074 (sort current
13075 (lambda (a b)
13076 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13077 (if (eq exit-after-next 'now) (throw 'exit t))
13078 (goto-char (point-min))
13079 (beginning-of-line 2)
13080 (delete-region (point) (point-at-eol))
13081 (org-fast-tag-insert "Current" current c-face)
13082 (org-set-current-tags-overlay current ov-prefix)
13083 (while (re-search-forward
13085 (setq tg (match-string 1))
13086 (add-text-properties
13087 (match-beginning 1) (match-end 1)
13088 (list 'face
13089 (cond
13090 ((member tg current) c-face)
13091 ((member tg inherited) i-face)
13092 (t (get-text-property (match-beginning 1) 'face))))))
13093 (goto-char (point-min)))))
13094 (org-detach-overlay org-tags-overlay)
13095 (if rtn
13096 (mapconcat 'identity current ":")
13097 nil))))
13099 (defun org-get-tags-string ()
13100 "Get the TAGS string in the current headline."
13101 (unless (org-on-heading-p t)
13102 (error "Not on a heading"))
13103 (save-excursion
13104 (beginning-of-line 1)
13106 (org-match-string-no-properties 1)
13107 "")))
13109 (defun org-get-tags ()
13110 "Get the list of tags specified in the current headline."
13111 (org-split-string (org-get-tags-string) ":"))
13113 (defun org-get-buffer-tags ()
13114 "Get a table of all tags used in the buffer, for completion."
13115 (let (tags)
13116 (save-excursion
13117 (goto-char (point-min))
13118 (while (re-search-forward
13120 (when (equal (char-after (point-at-bol 0)) ?*)
13121 (mapc (lambda (x) (add-to-list 'tags x))
13122 (org-split-string (org-match-string-no-properties 1) ":")))))
13123 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13124 (mapcar 'list tags)))
13126 ;;;; The mapping API
13128 ;;;###autoload
13129 (defun org-map-entries (func &optional match scope &rest skip)
13130 "Call FUNC at each headline selected by MATCH in SCOPE.
13132 FUNC is a function or a lisp form. The function will be called without
13133 arguments, with the cursor positioned at the beginning of the headline.
13134 The return values of all calls to the function will be collected and
13135 returned as a list.
13137 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13138 does not need to preserve point. After evaluation, the cursor will be
13139 moved to the end of the line (presumably of the headline of the
13140 processed entry) and search continues from there. Under some
13141 circumstances, this may not produce the wanted results. For example,
13142 if you have removed (e.g. archived) the current (sub)tree it could
13143 mean that the next entry will be skipped entirely. In such cases, you
13144 can specify the position from where search should continue by making
13145 FUNC set the variable `org-map-continue-from' to the desired buffer
13146 position.
13148 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13149 Only headlines that are matched by this query will be considered during
13150 the iteration. When MATCH is nil or t, all headlines will be
13151 visited by the iteration.
13153 SCOPE determines the scope of this command. It can be any of:
13155 nil The current buffer, respecting the restriction if any
13156 tree The subtree started with the entry at point
13157 file The current buffer, without restriction
13158 file-with-archives
13159 The current buffer, and any archives associated with it
13160 agenda All agenda files
13161 agenda-with-archives
13162 All agenda files with any archive files associated with them
13163 \(file1 file2 ...)
13164 If this is a list, all files in the list will be scanned
13166 The remaining args are treated as settings for the skipping facilities of
13167 the scanner. The following items can be given here:
13169 archive skip trees with the archive tag.
13170 comment skip trees with the COMMENT keyword
13171 function or Emacs Lisp form:
13172 will be used as value for `org-agenda-skip-function', so whenever
13173 the function returns t, FUNC will not be called for that
13174 entry and search will continue from the point where the
13175 function leaves it.
13177 If your function needs to retrieve the tags including inherited tags
13178 at the *current* entry, you can use the value of the variable
13179 `org-scanner-tags' which will be much faster than getting the value
13180 with `org-get-tags-at'. If your function gets properties with
13181 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13182 to t around the call to `org-entry-properties' to get the same speedup.
13183 Note that if your function moves around to retrieve tags and properties at
13184 a *different* entry, you cannot use these techniques."
13185 (let* ((org-agenda-archives-mode nil) ; just to make sure
13186 (org-agenda-skip-archived-trees (memq 'archive skip))
13187 (org-agenda-skip-comment-trees (memq 'comment skip))
13188 (org-agenda-skip-function
13189 (car (org-delete-all '(comment archive) skip)))
13190 (org-tags-match-list-sublevels t)
13191 matcher file res
13192 org-todo-keywords-for-agenda
13193 org-done-keywords-for-agenda
13194 org-todo-keyword-alist-for-agenda
13195 org-drawers-for-agenda
13196 org-tag-alist-for-agenda)
13198 (cond
13199 ((eq match t) (setq matcher t))
13200 ((eq match nil) (setq matcher t))
13201 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13203 (save-excursion
13204 (save-restriction
13205 (when (eq scope 'tree)
13206 (org-back-to-heading t)
13207 (org-narrow-to-subtree)
13208 (setq scope nil))
13210 (if (not scope)
13211 (progn
13212 (org-prepare-agenda-buffers
13213 (list (buffer-file-name (current-buffer))))
13214 (setq res (org-scan-tags func matcher)))
13215 ;; Get the right scope
13216 (cond
13217 ((and scope (listp scope) (symbolp (car scope)))
13218 (setq scope (eval scope)))
13219 ((eq scope 'agenda)
13220 (setq scope (org-agenda-files t)))
13221 ((eq scope 'agenda-with-archives)
13222 (setq scope (org-agenda-files t))
13223 (setq scope (org-add-archive-files scope)))
13224 ((eq scope 'file)
13225 (setq scope (list (buffer-file-name))))
13226 ((eq scope 'file-with-archives)
13227 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13228 (org-prepare-agenda-buffers scope)
13229 (while (setq file (pop scope))
13230 (with-current-buffer (org-find-base-buffer-visiting file)
13231 (save-excursion
13232 (save-restriction
13233 (widen)
13234 (goto-char (point-min))
13235 (setq res (append res (org-scan-tags func matcher))))))))))
13236 res))
13238 ;;;; Properties
13240 ;;; Setting and retrieving properties
13242 (defconst org-special-properties
13243 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13244 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE")
13245 "The special properties valid in Org-mode.
13247 These are properties that are not defined in the property drawer,
13248 but in some other way.")
13250 (defconst org-default-properties
13251 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13252 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13253 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13254 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13255 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13256 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13257 "Some properties that are used by Org-mode for various purposes.
13258 Being in this list makes sure that they are offered for completion.")
13261 "Regular expression matching the first line of a property drawer.")
13264 "Regular expression matching the last line of a property drawer.")
13267 "Regular expression matching the first line of a property drawer.")
13270 "Regular expression matching the first line of a property drawer.")
13272 (defconst org-property-drawer-re
13275 "Matches an entire property drawer.")
13277 (defconst org-clock-drawer-re
13280 "Matches an entire clock drawer.")
13282 (defun org-property-action ()
13283 "Do an action on properties."
13284 (interactive)
13285 (let (c)
13286 (org-at-property-p)
13287 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13288 (setq c (read-char-exclusive))
13289 (cond
13290 ((equal c ?s)
13291 (call-interactively 'org-set-property))
13292 ((equal c ?d)
13293 (call-interactively 'org-delete-property))
13294 ((equal c ?D)
13295 (call-interactively 'org-delete-property-globally))
13296 ((equal c ?c)
13297 (call-interactively 'org-compute-property-at-point))
13298 (t (error "No such property action %c" c)))))
13300 (defun org-set-effort (&optional value)
13301 "Set the effort property of the current entry.
13302 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13303 allowed value."
13304 (interactive "P")
13305 (if (equal value 0) (setq value 10))
13306 (let* ((completion-ignore-case t)
13307 (prop org-effort-property)
13308 (cur (org-entry-get nil prop))
13309 (allowed (org-property-get-allowed-values nil prop 'table))
13310 (existing (mapcar 'list (org-property-values prop)))
13311 rpl
13312 (val (cond
13313 ((stringp value) value)
13314 ((and allowed (integerp value))
13315 (or (car (nth (1- value) allowed))
13316 (car (org-last allowed))))
13317 (allowed
13318 (message "Select 1-9,0, [RET%s]: %s"
13319 (if cur (concat "=" cur) "")
13320 (mapconcat 'car allowed " "))
13321 (setq rpl (read-char-exclusive))
13323 cur
13324 (setq rpl (- rpl ?0))
13325 (if (equal rpl 0) (setq rpl 10))
13326 (if (and (> rpl 0) (<= rpl (length allowed)))
13327 (car (nth (1- rpl) allowed))
13328 (org-completing-read "Effort: " allowed nil))))
13329 (t
13330 (let (org-completion-use-ido org-completion-use-iswitchb)
13331 (org-completing-read
13333 (concat "[" cur "]") "")
13334 ": ")
13335 existing nil nil "" nil cur))))))
13336 (unless (equal (org-entry-get nil prop) val)
13337 (org-entry-put nil prop val))
13338 (message "%s is now %s" prop val)))
13340 (defun org-at-property-p ()
13341 "Is cursor inside a property drawer?"
13342 (save-excursion
13343 (beginning-of-line 1)
13345 (save-match-data ;; Used by calling procedures
13346 (let ((p (point))
13347 (range (unless (org-before-first-heading-p)
13348 (org-get-property-block))))
13349 (and range (<= (car range) p) (< p (cdr range))))))))
13351 (defun org-get-property-block (&optional beg end force)
13352 "Return the (beg . end) range of the body of the property drawer.
13353 BEG and END can be beginning and end of subtree, if not given
13354 they will be found.
13355 If the drawer does not exist and FORCE is non-nil, create the drawer."
13356 (catch 'exit
13357 (save-excursion
13358 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13359 (end (or end (progn (outline-next-heading) (point)))))
13360 (goto-char beg)
13361 (if (re-search-forward org-property-start-re end t)
13362 (setq beg (1+ (match-end 0)))
13363 (if force
13364 (save-excursion
13365 (org-insert-property-drawer)
13366 (setq end (progn (outline-next-heading) (point))))
13367 (throw 'exit nil))
13368 (goto-char beg)
13369 (if (re-search-forward org-property-start-re end t)
13370 (setq beg (1+ (match-end 0)))))
13371 (if (re-search-forward org-property-end-re end t)
13372 (setq end (match-beginning 0))
13373 (or force (throw 'exit nil))
13374 (goto-char beg)
13375 (setq end beg)
13376 (org-indent-line-function)
13378 (cons beg end)))))
13380 (defun org-entry-properties (&optional pom which specific)
13381 "Get all properties of the entry at point-or-marker POM.
13382 This includes the TODO keyword, the tags, time strings for deadline,
13383 scheduled, and clocking, and any additional properties defined in the
13384 entry. The return value is an alist, keys may occur multiple times
13385 if the property key was used several times.
13386 POM may also be nil, in which case the current entry is used.
13387 If WHICH is nil or `all', get all properties. If WHICH is
13388 `special' or `standard', only get that subclass. If WHICH
13389 is a string only get exactly this property. SPECIFIC can be a string, the
13390 specific property we are interested in. Specifying it can speed
13391 things up because then unnecessary parsing is avoided."
13392 (setq which (or which 'all))
13393 (org-with-point-at pom
13394 (let ((clockstr (substring org-clock-string 0 -1))
13395 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13396 (case-fold-search nil)
13397 beg end range props sum-props key key1 value string clocksum)
13398 (save-excursion
13399 (when (condition-case nil
13400 (and (org-mode-p) (org-back-to-heading t))
13401 (error nil))
13402 (setq beg (point))
13403 (setq sum-props (get-text-property (point) 'org-summaries))
13404 (setq clocksum (get-text-property (point) :org-clock-minutes))
13405 (outline-next-heading)
13406 (setq end (point))
13407 (when (memq which '(all special))
13408 ;; Get the special properties, like TODO and tags
13409 (goto-char beg)
13410 (when (and (or (not specific) (string= specific "TODO"))
13411 (looking-at org-todo-line-regexp) (match-end 2))
13412 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13413 (when (and (or (not specific) (string= specific "PRIORITY"))
13414 (looking-at org-priority-regexp))
13415 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13416 (when (or (not specific) (string= specific "FILE"))
13417 (push (cons "FILE" buffer-file-name) props))
13418 (when (and (or (not specific) (string= specific "TAGS"))
13419 (setq value (org-get-tags-string))
13421 (push (cons "TAGS" value) props))
13422 (when (and (or (not specific) (string= specific "ALLTAGS"))
13423 (setq value (org-get-tags-at)))
13424 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13425 ":"))
13426 props))
13427 (when (or (not specific) (string= specific "BLOCKED"))
13428 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13429 (when (or (not specific)
13430 (member specific
13431 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13432 "TIMESTAMP" "TIMESTAMP_IA")))
13433 (catch 'match
13434 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13435 (setq key (if (match-end 1)
13436 (substring (org-match-string-no-properties 1)
13437 0 -1))
13438 string (if (equal key clockstr)
13439 (org-no-properties
13440 (org-trim
13441 (buffer-substring
13442 (match-beginning 3) (goto-char
13443 (point-at-eol)))))
13444 (substring (org-match-string-no-properties 3)
13445 1 -1)))
13446 ;; Get the correct property name from the key. This is
13447 ;; necessary if the user has configured time keywords.
13448 (setq key1 (concat key ":"))
13449 (cond
13450 ((not key)
13451 (setq key
13452 (if (= (char-after (match-beginning 3)) ?\[)
13453 "TIMESTAMP_IA" "TIMESTAMP")))
13454 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13455 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13456 ((equal key1 org-closed-string) (setq key "CLOSED"))
13457 ((equal key1 org-clock-string) (setq key "CLOCK")))
13458 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13459 (progn
13460 (push (cons key string) props)
13461 ;; no need to search further if match is found
13462 (throw 'match t))
13463 (when (or (equal key "CLOCK") (not (assoc key props)))
13464 (push (cons key string) props))))))
13465 )
13467 (when (memq which '(all standard))
13468 ;; Get the standard properties, like :PROP: ...
13469 (setq range (org-get-property-block beg end))
13470 (when range
13471 (goto-char (car range))
13472 (while (re-search-forward
13474 (cdr range) t)
13475 (setq key (org-match-string-no-properties 1)
13476 value (org-trim (or (org-match-string-no-properties 2) "")))
13477 (unless (member key excluded)
13478 (push (cons key (or value "")) props)))))
13479 (if clocksum
13480 (push (cons "CLOCKSUM"
13481 (org-columns-number-to-string (/ (float clocksum) 60.)
13482 'add_times))
13483 props))
13484 (unless (assoc "CATEGORY" props)
13485 (setq value (or (org-get-category)
13486 (progn (org-refresh-category-properties)
13487 (org-get-category))))
13488 (push (cons "CATEGORY" value) props))
13489 (append sum-props (nreverse props)))))))
13491 (defun org-entry-get (pom property &optional inherit literal-nil)
13492 "Get value of PROPERTY for entry at point-or-marker POM.
13493 If INHERIT is non-nil and the entry does not have the property,
13494 then also check higher levels of the hierarchy.
13495 If INHERIT is the symbol `selective', use inheritance only if the setting
13496 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13497 If the property is present but empty, the return value is the empty string.
13498 If the property is not present at all, nil is returned.
13501 do not interpret it as the list atom nil. This is used for inheritance
13503 (org-with-point-at pom
13504 (if (and inherit (if (eq inherit 'selective)
13505 (org-property-inherit-p property)
13506 t))
13507 (org-entry-get-with-inheritance property literal-nil)
13508 (if (member property org-special-properties)
13509 ;; We need a special property. Use `org-entry-properties' to
13510 ;; retrieve it, but specify the wanted property
13511 (cdr (assoc property (org-entry-properties nil 'special property)))
13512 (let ((range (org-get-property-block)))
13513 (if (and range
13514 (goto-char (car range))
13515 (re-search-forward
13517 (cdr range) t))
13518 ;; Found the property, return it.
13519 (if (match-end 1)
13520 (if literal-nil
13521 (org-match-string-no-properties 1)
13522 (org-not-nil (org-match-string-no-properties 1)))
13523 "")))))))
13525 (defun org-property-or-variable-value (var &optional inherit)
13526 "Check if there is a property fixing the value of VAR.
13527 If yes, return this value. If not, return the current value of the variable."
13528 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13530 (read prop)
13531 (symbol-value var))))
13533 (defun org-entry-delete (pom property)
13534 "Delete the property PROPERTY from entry at point-or-marker POM."
13535 (org-with-point-at pom
13536 (if (member property org-special-properties)
13537 nil ; cannot delete these properties.
13538 (let ((range (org-get-property-block)))
13539 (if (and range
13540 (goto-char (car range))
13541 (re-search-forward
13543 (cdr range) t))
13544 (progn
13545 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13546 t)
13547 nil)))))
13549 ;; Multi-values properties are properties that contain multiple values
13550 ;; These values are assumed to be single words, separated by whitespace.
13551 (defun org-entry-add-to-multivalued-property (pom property value)
13552 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13553 (let* ((old (org-entry-get pom property))
13555 (setq value (org-entry-protect-space value))
13556 (unless (member value values)
13557 (setq values (cons value values))
13558 (org-entry-put pom property
13559 (mapconcat 'identity values " ")))))
13561 (defun org-entry-remove-from-multivalued-property (pom property value)
13562 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13563 (let* ((old (org-entry-get pom property))
13565 (setq value (org-entry-protect-space value))
13566 (when (member value values)
13567 (setq values (delete value values))
13568 (org-entry-put pom property
13569 (mapconcat 'identity values " ")))))
13571 (defun org-entry-member-in-multivalued-property (pom property value)
13572 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13573 (let* ((old (org-entry-get pom property))
13575 (setq value (org-entry-protect-space value))
13576 (member value values)))
13578 (defun org-entry-get-multivalued-property (pom property)
13579 "Return a list of values in a multivalued property."
13580 (let* ((value (org-entry-get pom property))
13582 (mapcar 'org-entry-restore-space values)))
13584 (defun org-entry-put-multivalued-property (pom property &rest values)
13585 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13586 VALUES should be a list of strings. Spaces will be protected."
13587 (org-entry-put pom property
13588 (mapconcat 'org-entry-protect-space values " "))
13589 (let* ((value (org-entry-get pom property))
13591 (mapcar 'org-entry-restore-space values)))
13593 (defun org-entry-protect-space (s)
13594 "Protect spaces and newline in string S."
13595 (while (string-match " " s)
13596 (setq s (replace-match "%20" t t s)))
13598 (setq s (replace-match "%0A" t t s)))
13599 s)
13601 (defun org-entry-restore-space (s)
13602 "Restore spaces and newline in string S."
13603 (while (string-match "%20" s)
13604 (setq s (replace-match " " t t s)))
13605 (while (string-match "%0A" s)
13607 s)
13609 (defvar org-entry-property-inherited-from (make-marker)
13610 "Marker pointing to the entry from where a property was inherited.
13611 Each call to `org-entry-get-with-inheritance' will set this marker to the
13612 location of the entry where the inheritance search matched. If there was
13613 no match, the marker will point nowhere.
13614 Note that also `org-entry-get' calls this function, if the INHERIT flag
13615 is set.")
13617 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13618 "Get entry property, and search higher levels if not present.
13619 The search will stop at the first ancestor which has the property defined.
13621 should be considered as undefined (this is the meaning of nil here).
13623 (move-marker org-entry-property-inherited-from nil)
13624 (let (tmp)
13625 (save-excursion
13626 (save-restriction
13627 (widen)
13628 (catch 'ex
13629 (while t
13630 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13631 (org-back-to-heading t)
13632 (move-marker org-entry-property-inherited-from (point))
13633 (throw 'ex tmp))
13634 (or (org-up-heading-safe) (throw 'ex nil)))))
13635 (setq tmp (or tmp
13636 (cdr (assoc property org-file-properties))
13637 (cdr (assoc property org-global-properties))
13638 (cdr (assoc property org-global-properties-fixed))))
13639 (if literal-nil tmp (org-not-nil tmp)))))
13641 (defvar org-property-changed-functions nil
13642 "Hook called when the value of a property has changed.
13643 Each hook function should accept two arguments, the name of the property
13644 and the new value.")
13646 (defun org-entry-put (pom property value)
13647 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13648 (org-with-point-at pom
13649 (org-back-to-heading t)
13650 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13651 range)
13652 (cond
13653 ((equal property "TODO")
13655 (not (member value org-todo-keywords-1)))
13657 (if (or (not value)
13659 (setq value 'none))
13660 (org-todo value)
13661 (org-set-tags nil 'align))
13662 ((equal property "PRIORITY")
13664 (string-to-char value) ?\ ))
13665 (org-set-tags nil 'align))
13666 ((equal property "SCHEDULED")
13667 (if (re-search-forward org-scheduled-time-regexp end t)
13668 (cond
13669 ((eq value 'earlier) (org-timestamp-change -1 'day))
13670 ((eq value 'later) (org-timestamp-change 1 'day))
13671 (t (call-interactively 'org-schedule)))
13672 (call-interactively 'org-schedule)))
13673 ((equal property "DEADLINE")
13674 (if (re-search-forward org-deadline-time-regexp end t)
13675 (cond
13676 ((eq value 'earlier) (org-timestamp-change -1 'day))
13677 ((eq value 'later) (org-timestamp-change 1 'day))
13678 (t (call-interactively 'org-deadline)))
13679 (call-interactively 'org-deadline)))
13680 ((member property org-special-properties)
13681 (error "The %s property can not yet be set with `org-entry-put'"
13682 property))
13683 (t ; a non-special property
13684 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13685 (setq range (org-get-property-block beg end 'force))
13686 (goto-char (car range))
13687 (if (re-search-forward
13689 (progn
13690 (delete-region (match-beginning 1) (match-end 1))
13691 (goto-char (match-beginning 1)))
13692 (goto-char (cdr range))
13694 (backward-char 1)
13695 (org-indent-line-function)
13696 (insert ":" property ":"))
13697 (and value (insert " " value))
13698 (org-indent-line-function)))))
13699 (run-hook-with-args 'org-property-changed-functions property value)))
13701 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13702 "Get all property keys in the current buffer.
13703 With INCLUDE-SPECIALS, also list the special properties that reflect things
13704 like tags and TODO state.
13705 With INCLUDE-DEFAULTS, also include properties that has special meaning
13706 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
13707 With INCLUDE-COLUMNS, also include property names given in COLUMN
13708 formats in the current buffer."
13709 (let (rtn range cfmt s p)
13710 (save-excursion
13711 (save-restriction
13712 (widen)
13713 (goto-char (point-min))
13714 (while (re-search-forward org-property-start-re nil t)
13715 (setq range (org-get-property-block))
13716 (goto-char (car range))
13717 (while (re-search-forward
13719 (cdr range) t)
13720 (add-to-list 'rtn (org-match-string-no-properties 1)))
13721 (outline-next-heading))))
13723 (when include-specials
13724 (setq rtn (append org-special-properties rtn)))
13726 (when include-defaults
13727 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13728 (add-to-list 'rtn org-effort-property))
13730 (when include-columns
13731 (save-excursion
13732 (save-restriction
13733 (widen)
13734 (goto-char (point-min))
13735 (while (re-search-forward
13737 nil t)
13738 (setq cfmt (match-string 2) s 0)
13740 cfmt s)
13741 (setq s (match-end 0)
13742 p (match-string 1 cfmt))
13743 (unless (or (equal p "ITEM")
13744 (member p org-special-properties))
13745 (add-to-list 'rtn (match-string 1 cfmt))))))))
13747 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13749 (defun org-property-values (key)
13750 "Return a list of all values of property KEY."
13751 (save-excursion
13752 (save-restriction
13753 (widen)
13754 (goto-char (point-min))
13756 values)
13757 (while (re-search-forward re nil t)
13758 (add-to-list 'values (org-trim (match-string 1))))
13759 (delete "" values)))))
13761 (defun org-insert-property-drawer ()
13762 "Insert a property drawer into the current entry."
13763 (interactive)
13764 (org-back-to-heading t)
13765 (looking-at outline-regexp)
13766 (let ((indent (if org-adapt-indentation
13767 (- (match-end 0)(match-beginning 0))
13768 0))
13769 (beg (point))
13771 end hiddenp)
13772 (outline-next-heading)
13773 (setq end (point))
13774 (goto-char beg)
13775 (while (re-search-forward re end t))
13776 (setq hiddenp (org-invisible-p))
13777 (end-of-line 1)
13780 (if (member (match-string 1) '("CLOCK:" ":END:"))
13781 ;; just skip this line
13782 (beginning-of-line 2)
13783 ;; Drawer start, find the end
13785 (beginning-of-line 1)))
13786 (org-skip-over-state-notes)
13788 (if (eq (char-before) ?*) (forward-char 1))
13790 (beginning-of-line 0)
13791 (org-indent-to-column indent)
13792 (beginning-of-line 2)
13793 (org-indent-to-column indent)
13794 (beginning-of-line 0)
13795 (if hiddenp
13796 (save-excursion
13797 (org-back-to-heading t)
13798 (hide-entry))
13799 (org-flag-drawer t))))
13801 (defvar org-property-set-functions-alist nil
13802 "Property set function alist.
13803 Each entry should have the following format:
13805 (PROPERTY . READ-FUNCTION)
13807 The read function will be called with the same argument as
13808 `org-completing-read.")
13810 (defun org-set-property-function (property)
13811 "Get the function that should be used to set PROPERTY.
13812 This is computed according to `org-property-set-functions-alist'."
13813 (or (cdr (assoc property org-property-set-functions-alist))
13814 'org-completing-read))
13816 (defun org-read-property-value (property)
13817 "Read PROPERTY value from user."
13818 (let* ((completion-ignore-case t)
13819 (allowed (org-property-get-allowed-values nil property 'table))
13820 (cur (org-entry-get nil property))
13821 (prompt (concat property " value"
13823 (concat " [" cur "]") "") ": "))
13824 (set-function (org-set-property-function property))
13825 (val (if allowed
13826 (funcall set-function prompt allowed nil
13827 (not (get-text-property 0 'org-unrestricted
13828 (caar allowed))))
13829 (let (org-completion-use-ido org-completion-use-iswitchb)
13830 (funcall set-function prompt
13831 (mapcar 'list (org-property-values property))
13832 nil nil "" nil cur)))))
13833 (if (equal val "")
13834 cur
13835 val)))
13837 (defun org-read-property-name ()
13838 "Read a property name."
13839 (let* ((completion-ignore-case t)
13840 (keys (org-buffer-property-keys nil t t))
13841 (property (org-icompleting-read "Property: " (mapcar 'list keys))))
13842 (if (member property keys)
13843 property
13844 (or (cdr (assoc (downcase property)
13845 (mapcar (lambda (x) (cons (downcase x) x))
13846 keys)))
13847 property))))
13849 (defun org-set-property (property value)
13850 "In the current entry, set PROPERTY to VALUE.
13851 When called interactively, this will prompt for a property name, offering
13852 completion on existing and default properties. And then it will prompt
13853 for a value, offering completion either on allowed values (via an inherited
13854 xxx_ALL property) or on existing values in other instances of this property
13855 in the current file."
13856 (interactive (list nil nil))
13857 (let* ((property (or property (org-read-property-name)))
13858 (value (or value (org-read-property-value property))))
13859 (unless (equal (org-entry-get nil property) value)
13860 (org-entry-put nil property value))))
13862 (defun org-delete-property (property)
13863 "In the current entry, delete PROPERTY."
13864 (interactive
13865 (let* ((completion-ignore-case t)
13866 (prop (org-icompleting-read "Property: "
13867 (org-entry-properties nil 'standard))))
13868 (list prop)))
13869 (message "Property %s %s" property
13870 (if (org-entry-delete nil property)
13871 "deleted"
13872 "was not present in the entry")))
13874 (defun org-delete-property-globally (property)
13875 "Remove PROPERTY globally, from all entries."
13876 (interactive
13877 (let* ((completion-ignore-case t)
13878 (prop (org-icompleting-read
13879 "Globally remove property: "
13880 (mapcar 'list (org-buffer-property-keys)))))
13881 (list prop)))
13882 (save-excursion
13883 (save-restriction
13884 (widen)
13885 (goto-char (point-min))
13886 (let ((cnt 0))
13887 (while (re-search-forward
13889 nil t)
13890 (setq cnt (1+ cnt))
13891 (replace-match ""))
13894 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
13896 (defun org-compute-property-at-point ()
13897 "Compute the property at point.
13898 This looks for an enclosing column format, extracts the operator and
13899 then applies it to the property in the column format's scope."
13900 (interactive)
13901 (unless (org-at-property-p)
13902 (error "Not at a property"))
13903 (let ((prop (org-match-string-no-properties 2)))
13904 (org-columns-get-format-and-top-level)
13905 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
13906 (error "No operator defined for property %s" prop))
13907 (org-columns-compute prop)))
13909 (defvar org-property-allowed-value-functions nil
13910 "Hook for functions supplying allowed values for a specific property.
13911 The functions must take a single argument, the name of the property, and
13913 the values, this means that these values are intended as defaults for
13914 completion, but that other values should be allowed too.
13915 The functions must return nil if they are not responsible for this
13916 property.")
13918 (defun org-property-get-allowed-values (pom property &optional table)
13919 "Get allowed values for the property PROPERTY.
13920 When TABLE is non-nil, return an alist that can directly be used for
13921 completion."
13922 (let (vals)
13923 (cond
13924 ((equal property "TODO")
13925 (setq vals (org-with-point-at pom
13926 (append org-todo-keywords-1 '("")))))
13927 ((equal property "PRIORITY")
13928 (let ((n org-lowest-priority))
13929 (while (>= n org-highest-priority)
13930 (push (char-to-string n) vals)
13931 (setq n (1- n)))))
13932 ((member property org-special-properties))
13933 ((setq vals (run-hook-with-args-until-success
13934 'org-property-allowed-value-functions property)))
13935 (t
13936 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
13938 (setq vals (car (read-from-string (concat "(" vals ")"))))
13939 (setq vals (mapcar (lambda (x)
13940 (cond ((stringp x) x)
13941 ((numberp x) (number-to-string x))
13942 ((symbolp x) (symbol-name x))
13943 (t "???")))
13944 vals)))))
13945 (when (member ":ETC" vals)
13946 (setq vals (remove ":ETC" vals))
13947 (org-add-props (car vals) '(org-unrestricted t)))
13948 (if table (mapcar 'list vals) vals)))
13950 (defun org-property-previous-allowed-value (&optional previous)
13951 "Switch to the next allowed value for this property."
13952 (interactive)
13953 (org-property-next-allowed-value t))
13955 (defun org-property-next-allowed-value (&optional previous)
13956 "Switch to the next allowed value for this property."
13957 (interactive)
13958 (unless (org-at-property-p)
13959 (error "Not at a property"))
13960 (let* ((key (match-string 2))
13961 (value (match-string 3))
13962 (allowed (or (org-property-get-allowed-values (point) key)
13963 (and (member value '("[ ]" "[-]" "[X]"))
13964 '("[ ]" "[X]"))))
13965 nval)
13966 (unless allowed
13967 (error "Allowed values for this property have not been defined"))
13968 (if previous (setq allowed (reverse allowed)))
13969 (if (member value allowed)
13970 (setq nval (car (cdr (member value allowed)))))
13971 (setq nval (or nval (car allowed)))
13972 (if (equal nval value)
13973 (error "Only one allowed value for this property"))
13974 (org-at-property-p)
13975 (replace-match (concat " :" key ": " nval) t t)
13976 (org-indent-line-function)
13977 (beginning-of-line 1)
13979 (run-hook-with-args 'org-property-changed-functions key nval)))
13981 (defun org-find-olp (path &optional this-buffer)
13982 "Return a marker pointing to the entry at outline path OLP.
13983 If anything goes wrong, throw an error.
13984 You can wrap this call to catch the error like this:
13986 (condition-case msg
13987 (org-mobile-locate-entry (match-string 4))
13988 (error (nth 1 msg)))
13990 The return value will then be either a string with the error message,
13991 or a marker if everything is OK.
13993 If THIS-BUFFER is set, the outline path does not contain a file,
13994 only headings."
13995 (let* ((file (if this-buffer buffer-file-name (pop path)))
13996 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
13997 (level 1)
13998 (lmin 1)
13999 (lmax 1)
14000 limit re end found pos heading cnt)
14001 (unless buffer (error "File not found :%s" file))
14002 (with-current-buffer buffer
14003 (save-excursion
14004 (save-restriction
14005 (widen)
14006 (setq limit (point-max))
14007 (goto-char (point-min))
14008 (while (setq heading (pop path))
14009 (setq re (format org-complex-heading-regexp-format
14010 (regexp-quote heading)))
14011 (setq cnt 0 pos (point))
14012 (while (re-search-forward re end t)
14013 (setq level (- (match-end 1) (match-beginning 1)))
14014 (if (and (>= level lmin) (<= level lmax))
14015 (setq found (match-beginning 0) cnt (1+ cnt))))
14016 (when (= cnt 0) (error "Heading not found on level %d: %s"
14017 lmax heading))
14018 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14019 lmax heading))
14020 (goto-char found)
14021 (setq lmin (1+ level) lmax (+ lmin (if org-odd-levels-only 1 0)))
14022 (setq end (save-excursion (org-end-of-subtree t t))))
14023 (when (org-on-heading-p)
14024 (move-marker (make-marker) (point))))))))
14026 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14027 "Find node HEADING in BUFFER.
14028 Return a marker to the heading if it was found, or nil if not.
14029 If POS-ONLY is set, return just the position instead of a marker.
14031 The heading text must match exact, but it may have a TODO keyword,
14032 a priority cookie and tags in the standard locations."
14033 (with-current-buffer (or buffer (current-buffer))
14034 (save-excursion
14035 (save-restriction
14036 (widen)
14037 (goto-char (point-min))
14038 (let (case-fold-search)
14039 (if (re-search-forward
14040 (format org-complex-heading-regexp-format
14041 (regexp-quote heading)) nil t)
14042 (if pos-only
14043 (match-beginning 0)
14044 (move-marker (make-marker) (match-beginning 0)))))))))
14046 (defun org-find-exact-heading-in-directory (heading &optional dir)
14047 "Find Org node headline HEADING in all .org files in directory DIR.
14048 When the target headline is found, return a marker to this location."
14049 (let ((files (directory-files (or dir default-directory)
14051 file visiting m buffer)
14052 (catch 'found
14053 (while (setq file (pop files))
14054 (message "trying %s" file)
14055 (setq visiting (org-find-base-buffer-visiting file))
14056 (setq buffer (or visiting (find-file-noselect file)))
14057 (setq m (org-find-exact-headline-in-buffer
14058 heading buffer))
14059 (when (and (not m) (not visiting)) (kill-buffer buffer))
14060 (and m (throw 'found m))))))
14062 (defun org-find-entry-with-id (ident)
14063 "Locate the entry that contains the ID property with exact value IDENT.
14064 IDENT can be a string, a symbol or a number, this function will search for
14065 the string representation of it.
14066 Return the position where this entry starts, or nil if there is no such entry."
14067 (interactive "sID: ")
14068 (let ((id (cond
14069 ((stringp ident) ident)
14070 ((symbol-name ident) (symbol-name ident))
14071 ((numberp ident) (number-to-string ident))
14072 (t (error "IDENT %s must be a string, symbol or number" ident))))
14073 (case-fold-search nil))
14074 (save-excursion
14075 (save-restriction
14076 (widen)
14077 (goto-char (point-min))
14078 (when (re-search-forward
14080 nil t)
14081 (org-back-to-heading t)
14082 (point))))))
14084 ;;;; Timestamps
14086 (defvar org-last-changed-timestamp nil)
14087 (defvar org-last-inserted-timestamp nil
14088 "The last time stamp inserted with `org-insert-time-stamp'.")
14089 (defvar org-time-was-given) ; dynamically scoped parameter
14090 (defvar org-end-time-was-given) ; dynamically scoped parameter
14091 (defvar org-ts-what) ; dynamically scoped parameter
14093 (defun org-time-stamp (arg &optional inactive)
14094 "Prompt for a date/time and insert a time stamp.
14095 If the user specifies a time like HH:MM, or if this command is called
14096 with a prefix argument, the time stamp will contain date and time.
14097 Otherwise, only the date will be included. All parts of a date not
14098 specified by the user will be filled in from the current date/time.
14099 So if you press just return without typing anything, the time stamp
14100 will represent the current date/time. If there is already a timestamp
14101 at the cursor, it will be modified."
14102 (interactive "P")
14103 (let* ((ts nil)
14104 (default-time
14105 ;; Default time is either today, or, when entering a range,
14106 ;; the range start.
14107 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14108 (save-excursion
14109 (re-search-backward
14111 (- (point) 20) t)))
14112 (apply 'encode-time (org-parse-time-string (match-string 1)))
14113 (current-time)))
14114 (default-input (and ts (org-get-compact-tod ts)))
14115 org-time-was-given org-end-time-was-given time)
14116 (cond
14117 ((and (org-at-timestamp-p t)
14118 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14119 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14120 (insert "--")
14121 (setq time (let ((this-command this-command))
14122 (org-read-date arg 'totime nil nil
14123 default-time default-input)))
14124 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14125 ((org-at-timestamp-p t)
14126 (setq time (let ((this-command this-command))
14127 (org-read-date arg 'totime nil nil default-time default-input)))
14128 (when (org-at-timestamp-p t) ; just to get the match data
14129 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14130 (replace-match "")
14131 (setq org-last-changed-timestamp
14132 (org-insert-time-stamp
14133 time (or org-time-was-given arg)
14134 inactive nil nil (list org-end-time-was-given))))
14135 (message "Timestamp updated"))
14136 (t
14137 (setq time (let ((this-command this-command))
14138 (org-read-date arg 'totime nil nil default-time default-input)))
14139 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14140 nil nil (list org-end-time-was-given))))))
14142 ;; FIXME: can we use this for something else, like computing time differences?
14143 (defun org-get-compact-tod (s)
14144 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14145 (let* ((t1 (match-string 1 s))
14146 (h1 (string-to-number (match-string 2 s)))
14147 (m1 (string-to-number (match-string 3 s)))
14148 (t2 (and (match-end 4) (match-string 5 s)))
14149 (h2 (and t2 (string-to-number (match-string 6 s))))
14150 (m2 (and t2 (string-to-number (match-string 7 s))))
14151 dh dm)
14152 (if (not t2)
14153 t1
14154 (setq dh (- h2 h1) dm (- m2 m1))
14155 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14156 (concat t1 "+" (number-to-string dh)
14157 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14159 (defun org-time-stamp-inactive (&optional arg)
14160 "Insert an inactive time stamp.
14161 An inactive time stamp is enclosed in square brackets instead of angle
14162 brackets. It is inactive in the sense that it does not trigger agenda entries,
14163 does not link to the calendar and cannot be changed with the S-cursor keys.
14164 So these are more for recording a certain time/date."
14165 (interactive "P")
14166 (org-time-stamp arg 'inactive))
14168 (defvar org-date-ovl (make-overlay 1 1))
14169 (overlay-put org-date-ovl 'face 'org-warning)
14170 (org-detach-overlay org-date-ovl)
14172 (defvar org-ans1) ; dynamically scoped parameter
14173 (defvar org-ans2) ; dynamically scoped parameter
14175 (defvar org-plain-time-of-day-regexp) ; defined below
14177 (defvar org-overriding-default-time nil) ; dynamically scoped
14178 (defvar org-read-date-overlay nil)
14179 (defvar org-dcst nil) ; dynamically scoped
14180 (defvar org-read-date-history nil)
14181 (defvar org-read-date-final-answer nil)
14183 (defun org-read-date (&optional with-time to-time from-string prompt
14184 default-time default-input)
14185 "Read a date, possibly a time, and make things smooth for the user.
14186 The prompt will suggest to enter an ISO date, but you can also enter anything
14187 which will at least partially be understood by `parse-time-string'.
14188 Unrecognized parts of the date will default to the current day, month, year,
14189 hour and minute. If this command is called to replace a timestamp at point,
14190 of to enter the second timestamp of a range, the default time is taken
14191 from the existing stamp. Furthermore, the command prefers the future,
14192 so if you are giving a date where the year is not given, and the day-month
14193 combination is already past in the current year, it will assume you
14194 mean next year. For details, see the manual. A few examples:
14196 3-2-5 --> 2003-02-05
14197 feb 15 --> currentyear-02-15
14198 2/15 --> currentyear-02-15
14199 sep 12 9 --> 2009-09-12
14200 12:45 --> today 12:45
14201 22 sept 0:34 --> currentyear-09-22 0:34
14202 12 --> currentyear-currentmonth-12
14203 Fri --> nearest Friday (today or later)
14204 etc.
14206 Furthermore you can specify a relative date by giving, as the *first* thing
14207 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14208 change in days weeks, months, years.
14209 With a single plus or minus, the date is relative to today. With a double
14210 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14211 +4d --> four days from today
14212 +4 --> same as above
14213 +2w --> two weeks from today
14214 ++5 --> five days from default date
14216 The function understands only English month and weekday abbreviations,
14217 but this can be configured with the variables `parse-time-months' and
14218 `parse-time-weekdays'.
14220 While prompting, a calendar is popped up - you can also select the
14221 date with the mouse (button 1). The calendar shows a period of three
14222 months. To scroll it to other months, use the keys `>' and `<'.
14223 If you don't like the calendar, turn it off with
14224 \(setq org-read-date-popup-calendar nil)
14226 With optional argument TO-TIME, the date will immediately be converted
14227 to an internal time.
14228 With an optional argument WITH-TIME, the prompt will suggest to also
14229 insert a time. Note that when WITH-TIME is not set, you can still
14230 enter a time, and this function will inform the calling routine about
14231 this change. The calling routine may then choose to change the format
14232 used to insert the time stamp into the buffer to include the time.
14233 With optional argument FROM-STRING, read from this string instead from
14234 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14235 the time/date that is used for everything that is not specified by the
14236 user."
14237 (require 'parse-time)
14238 (let* ((org-time-stamp-rounding-minutes
14239 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14240 (org-dcst org-display-custom-times)
14241 (ct (org-current-time))
14242 (def (or org-overriding-default-time default-time ct))
14243 (defdecode (decode-time def))
14244 (dummy (progn
14245 (when (< (nth 2 defdecode) org-extend-today-until)
14246 (setcar (nthcdr 2 defdecode) -1)
14247 (setcar (nthcdr 1 defdecode) 59)
14248 (setq def (apply 'encode-time defdecode)
14249 defdecode (decode-time def)))))
14250 (calendar-frame-setup nil)
14251 (calendar-setup nil)
14252 (calendar-move-hook nil)
14253 (calendar-view-diary-initially-flag nil)
14254 (calendar-view-holidays-initially-flag nil)
14255 (timestr (format-time-string
14256 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14257 (prompt (concat (if prompt (concat prompt " ") "")
14258 (format "Date+time [%s]: " timestr)))
14259 ans (org-ans0 "") org-ans1 org-ans2 final)
14261 (cond
14262 (from-string (setq ans from-string))
14263 (org-read-date-popup-calendar
14264 (save-excursion
14265 (save-window-excursion
14266 (calendar)
14267 (calendar-forward-day (- (time-to-days def)
14268 (calendar-absolute-from-gregorian
14269 (calendar-current-date))))
14270 (org-eval-in-calendar nil t)
14271 (let* ((old-map (current-local-map))
14272 (map (copy-keymap calendar-mode-map))
14273 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14274 (org-defkey map (kbd "RET") 'org-calendar-select)
14275 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14276 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14277 (org-defkey minibuffer-local-map [(meta shift left)]
14278 (lambda () (interactive)
14279 (org-eval-in-calendar '(calendar-backward-month 1))))
14280 (org-defkey minibuffer-local-map [(meta shift right)]
14281 (lambda () (interactive)
14282 (org-eval-in-calendar '(calendar-forward-month 1))))
14283 (org-defkey minibuffer-local-map [(meta shift up)]
14284 (lambda () (interactive)
14285 (org-eval-in-calendar '(calendar-backward-year 1))))
14286 (org-defkey minibuffer-local-map [(meta shift down)]
14287 (lambda () (interactive)
14288 (org-eval-in-calendar '(calendar-forward-year 1))))
14289 (org-defkey minibuffer-local-map [?\e (shift left)]
14290 (lambda () (interactive)
14291 (org-eval-in-calendar '(calendar-backward-month 1))))
14292 (org-defkey minibuffer-local-map [?\e (shift right)]
14293 (lambda () (interactive)
14294 (org-eval-in-calendar '(calendar-forward-month 1))))
14295 (org-defkey minibuffer-local-map [?\e (shift up)]
14296 (lambda () (interactive)
14297 (org-eval-in-calendar '(calendar-backward-year 1))))
14298 (org-defkey minibuffer-local-map [?\e (shift down)]
14299 (lambda () (interactive)
14300 (org-eval-in-calendar '(calendar-forward-year 1))))
14301 (org-defkey minibuffer-local-map [(shift up)]
14302 (lambda () (interactive)
14303 (org-eval-in-calendar '(calendar-backward-week 1))))
14304 (org-defkey minibuffer-local-map [(shift down)]
14305 (lambda () (interactive)
14306 (org-eval-in-calendar '(calendar-forward-week 1))))
14307 (org-defkey minibuffer-local-map [(shift left)]
14308 (lambda () (interactive)
14309 (org-eval-in-calendar '(calendar-backward-day 1))))
14310 (org-defkey minibuffer-local-map [(shift right)]
14311 (lambda () (interactive)
14312 (org-eval-in-calendar '(calendar-forward-day 1))))
14313 (org-defkey minibuffer-local-map ">"
14314 (lambda () (interactive)
14315 (org-eval-in-calendar '(scroll-calendar-left 1))))
14316 (org-defkey minibuffer-local-map "<"
14317 (lambda () (interactive)
14318 (org-eval-in-calendar '(scroll-calendar-right 1))))
14319 (org-defkey minibuffer-local-map "\C-v"
14320 (lambda () (interactive)
14321 (org-eval-in-calendar
14322 '(calendar-scroll-left-three-months 1))))
14323 (org-defkey minibuffer-local-map "\M-v"
14324 (lambda () (interactive)
14325 (org-eval-in-calendar
14326 '(calendar-scroll-right-three-months 1))))
14327 (run-hooks 'org-read-date-minibuffer-setup-hook)
14328 (unwind-protect
14329 (progn
14330 (use-local-map map)
14331 (add-hook 'post-command-hook 'org-read-date-display)
14332 (setq org-ans0 (read-string prompt default-input
14333 'org-read-date-history nil))
14334 ;; org-ans0: from prompt
14335 ;; org-ans1: from mouse click
14336 ;; org-ans2: from calendar motion
14337 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14338 (remove-hook 'post-command-hook 'org-read-date-display)
14339 (use-local-map old-map)
14340 (when org-read-date-overlay
14341 (delete-overlay org-read-date-overlay)
14342 (setq org-read-date-overlay nil)))))))
14344 (t ; Naked prompt only
14345 (unwind-protect
14346 (setq ans (read-string prompt default-input
14347 'org-read-date-history timestr))
14348 (when org-read-date-overlay
14349 (delete-overlay org-read-date-overlay)
14350 (setq org-read-date-overlay nil)))))
14352 (setq final (org-read-date-analyze ans def defdecode))
14354 ;; One round trip to get rid of 34th of August and stuff like that....
14355 (setq final (decode-time (apply 'encode-time final)))
14357 (setq org-read-date-final-answer ans)
14359 (if to-time
14360 (apply 'encode-time final)
14361 (if (and (boundp 'org-time-was-given) org-time-was-given)
14362 (format "%04d-%02d-%02d %02d:%02d"
14363 (nth 5 final) (nth 4 final) (nth 3 final)
14364 (nth 2 final) (nth 1 final))
14365 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14367 (defvar def)
14368 (defvar defdecode)
14369 (defvar with-time)
14370 (defvar org-read-date-analyze-futurep nil)
14371 (defun org-read-date-display ()
14372 "Display the current date prompt interpretation in the minibuffer."
14373 (when org-read-date-display-live
14374 (when org-read-date-overlay
14375 (delete-overlay org-read-date-overlay))
14376 (let ((p (point)))
14377 (end-of-line 1)
14378 (while (not (equal (buffer-substring
14379 (max (point-min) (- (point) 4)) (point))
14380 " "))
14381 (insert " "))
14382 (goto-char p))
14383 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14384 " " (or org-ans1 org-ans2)))
14385 (org-end-time-was-given nil)
14386 (f (org-read-date-analyze ans def defdecode))
14387 (fmts (if org-dcst
14388 org-time-stamp-custom-formats
14389 org-time-stamp-formats))
14390 (fmt (if (or with-time
14391 (and (boundp 'org-time-was-given) org-time-was-given))
14392 (cdr fmts)
14393 (car fmts)))
14394 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14395 (when (and org-end-time-was-given
14396 (string-match org-plain-time-of-day-regexp txt))
14397 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14398 org-end-time-was-given
14399 (substring txt (match-end 0)))))
14400 (when org-read-date-analyze-futurep
14401 (setq txt (concat txt " (=>F)")))
14402 (setq org-read-date-overlay
14403 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14404 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14406 (defun org-read-date-analyze (ans def defdecode)
14407 "Analyze the combined answer of the date prompt."
14408 ;; FIXME: cleanup and comment
14409 (let ((nowdecode (decode-time (current-time)))
14410 delta deltan deltaw deltadef year month day
14411 hour minute second wday pm h2 m2 tl wday1
14412 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14413 (setq org-read-date-analyze-futurep nil)
14415 (setq ans "+0"))
14417 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14418 (setq ans (replace-match "" t t ans)
14419 deltan (car delta)
14420 deltaw (nth 1 delta)
14421 deltadef (nth 2 delta)))
14423 ;; Check if there is an iso week date in there
14424 ;; If yes, store the info and postpone interpreting it until the rest
14425 ;; of the parsing is done
14426 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14427 (setq iso-year (if (match-end 1)
14428 (org-small-year-to-year
14429 (string-to-number (match-string 1 ans))))
14430 iso-weekday (if (match-end 3)
14431 (string-to-number (match-string 3 ans)))
14432 iso-week (string-to-number (match-string 2 ans)))
14433 (setq ans (replace-match "" t t ans)))
14435 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14436 (when (string-match
14438 (setq year (if (match-end 2)
14439 (string-to-number (match-string 2 ans))
14440 (progn (setq kill-year t)
14441 (string-to-number (format-time-string "%Y"))))
14442 month (string-to-number (match-string 3 ans))
14443 day (string-to-number (match-string 4 ans)))
14444 (if (< year 100) (setq year (+ 2000 year)))
14446 t nil ans)))
14447 ;; Help matching american dates, like 5/30 or 5/30/7
14448 (when (string-match
14449 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14450 (setq year (if (match-end 4)
14451 (string-to-number (match-string 4 ans))
14452 (progn (setq kill-year t)
14453 (string-to-number (format-time-string "%Y"))))
14454 month (string-to-number (match-string 1 ans))
14455 day (string-to-number (match-string 2 ans)))
14456 (if (< year 100) (setq year (+ 2000 year)))
14458 t nil ans)))
14459 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14460 ;; If there is a time with am/pm, and *no* time without it, we convert
14461 ;; so that matching will be successful.
14462 (loop for i from 1 to 2 do ; twice, for end time as well
14465 (setq hour (string-to-number (match-string 1 ans))
14466 minute (if (match-end 3)
14467 (string-to-number (match-string 3 ans))
14468 0)
14469 pm (equal ?p
14470 (string-to-char (downcase (match-string 4 ans)))))
14471 (if (and (= hour 12) (not pm))
14472 (setq hour 0)
14473 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14474 (setq ans (replace-match (format "%02d:%02d" hour minute)
14475 t t ans))))
14477 ;; Check if a time range is given as a duration
14478 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14479 (setq hour (string-to-number (match-string 1 ans))
14480 h2 (+ hour (string-to-number (match-string 3 ans)))
14481 minute (string-to-number (match-string 2 ans))
14482 m2 (+ minute (if (match-end 5) (string-to-number
14483 (match-string 5 ans))0)))
14484 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14485 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14486 t t ans)))
14488 ;; Check if there is a time range
14489 (when (boundp 'org-end-time-was-given)
14490 (setq org-time-was-given nil)
14491 (when (and (string-match org-plain-time-of-day-regexp ans)
14492 (match-end 8))
14493 (setq org-end-time-was-given (match-string 8 ans))
14494 (setq ans (concat (substring ans 0 (match-beginning 7))
14495 (substring ans (match-end 7))))))
14497 (setq tl (parse-time-string ans)
14498 day (or (nth 3 tl) (nth 3 defdecode))
14499 month (or (nth 4 tl)
14500 (if (and org-read-date-prefer-future
14501 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14502 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14503 (nth 4 defdecode)))
14504 year (or (and (not kill-year) (nth 5 tl))
14505 (if (and org-read-date-prefer-future
14506 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14507 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14508 (nth 5 defdecode)))
14509 hour (or (nth 2 tl) (nth 2 defdecode))
14510 minute (or (nth 1 tl) (nth 1 defdecode))
14511 second (or (nth 0 tl) 0)
14512 wday (nth 6 tl))
14514 (when (and (eq org-read-date-prefer-future 'time)
14515 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14516 (equal day (nth 3 nowdecode))
14517 (equal month (nth 4 nowdecode))
14518 (equal year (nth 5 nowdecode))
14519 (nth 2 tl)
14520 (or (< (nth 2 tl) (nth 2 nowdecode))
14521 (and (= (nth 2 tl) (nth 2 nowdecode))
14522 (nth 1 tl)
14523 (< (nth 1 tl) (nth 1 nowdecode)))))
14524 (setq day (1+ day)
14525 futurep t))
14527 ;; Special date definitions below
14528 (cond
14529 (iso-week
14530 ;; There was an iso week
14531 (require 'cal-iso)
14532 (setq futurep nil)
14533 (setq year (or iso-year year)
14534 day (or iso-weekday wday 1)
14535 wday nil ; to make sure that the trigger below does not match
14536 iso-date (calendar-gregorian-from-absolute
14537 (calendar-absolute-from-iso
14538 (list iso-week day year))))
14539 ; FIXME: Should we also push ISO weeks into the future?
14540 ; (when (and org-read-date-prefer-future
14541 ; (not iso-year)
14542 ; (< (calendar-absolute-from-gregorian iso-date)
14543 ; (time-to-days (current-time))))
14544 ; (setq year (1+ year)
14545 ; iso-date (calendar-gregorian-from-absolute
14546 ; (calendar-absolute-from-iso
14547 ; (list iso-week day year)))))
14548 (setq month (car iso-date)
14549 year (nth 2 iso-date)
14550 day (nth 1 iso-date)))
14551 (deltan
14552 (setq futurep nil)
14553 (unless deltadef
14554 (let ((now (decode-time (current-time))))
14555 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14556 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14557 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14558 ((equal deltaw "m") (setq month (+ month deltan)))
14559 ((equal deltaw "y") (setq year (+ year deltan)))))
14560 ((and wday (not (nth 3 tl)))
14561 (setq futurep nil)
14562 ;; Weekday was given, but no day, so pick that day in the week
14563 ;; on or after the derived date.
14564 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14565 (unless (equal wday wday1)
14566 (setq day (+ day (% (- wday wday1 -7) 7))))))
14567 (if (and (boundp 'org-time-was-given)
14568 (nth 2 tl))
14569 (setq org-time-was-given t))
14570 (if (< year 100) (setq year (+ 2000 year)))
14571 (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
14572 (setq org-read-date-analyze-futurep futurep)
14573 (list second minute hour day month year)))
14575 (defvar parse-time-weekdays)
14577 (defun org-read-date-get-relative (s today default)
14578 "Check string S for special relative date string.
14579 TODAY and DEFAULT are internal times, for today and for a default.
14580 Return shift list (N what def-flag)
14582 N is the number of WHATs to shift.
14583 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14584 the DEFAULT date rather than TODAY."
14585 (when (and
14586 (string-match
14587 (concat
14592 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14593 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14594 (string-to-char (substring (match-string 1 s) -1))
14595 ?+))
14596 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14597 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14598 (what (if (match-end 3) (match-string 3 s) "d"))
14599 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14600 (date (if rel default today))
14601 (wday (nth 6 (decode-time date)))
14602 delta)
14603 (if wday1
14604 (progn
14605 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14606 (if (= dir ?-) (setq delta (- delta 7)))
14607 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14608 (list delta "d" rel))
14609 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14611 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14612 "Turn a user-specified date into the internal representation.
14613 The internal representation needed by the calendar is (month day year).
14614 This is a wrapper to handle the brain-dead convention in calendar that
14615 user function argument order change dependent on argument order."
14616 (if (boundp 'calendar-date-style)
14617 (cond
14618 ((eq calendar-date-style 'american)
14619 (list arg1 arg2 arg3))
14620 ((eq calendar-date-style 'european)
14621 (list arg2 arg1 arg3))
14622 ((eq calendar-date-style 'iso)
14623 (list arg2 arg3 arg1)))
14624 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
14625 (if (org-bound-and-true-p european-calendar-style)
14626 (list arg2 arg1 arg3)
14627 (list arg1 arg2 arg3)))))
14629 (defun org-eval-in-calendar (form &optional keepdate)
14630 "Eval FORM in the calendar window and return to current window.
14631 Also, store the cursor date in variable org-ans2."
14632 (let ((sf (selected-frame))
14633 (sw (selected-window)))
14634 (select-window (get-buffer-window "*Calendar*" t))
14635 (eval form)
14636 (when (and (not keepdate) (calendar-cursor-to-date))
14637 (let* ((date (calendar-cursor-to-date))
14638 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14639 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
14640 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
14641 (select-window sw)
14642 (org-select-frame-set-input-focus sf)))
14644 (defun org-calendar-select ()
14645 "Return to `org-read-date' with the date currently selected.
14646 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14647 (interactive)
14648 (when (calendar-cursor-to-date)
14649 (let* ((date (calendar-cursor-to-date))
14650 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14651 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14652 (if (active-minibuffer-window) (exit-minibuffer))))
14654 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
14655 "Insert a date stamp for the date given by the internal TIME.
14656 WITH-HM means use the stamp format that includes the time of the day.
14657 INACTIVE means use square brackets instead of angular ones, so that the
14658 stamp will not contribute to the agenda.
14659 PRE and POST are optional strings to be inserted before and after the
14660 stamp.
14661 The command returns the inserted time stamp."
14662 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
14663 stamp)
14664 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
14665 (insert-before-markers (or pre ""))
14666 (when (listp extra)
14667 (setq extra (car extra))
14668 (if (and (stringp extra)
14670 (setq extra (format "-%02d:%02d"
14671 (string-to-number (match-string 1 extra))
14672 (string-to-number (match-string 2 extra))))
14673 (setq extra nil)))
14674 (when extra
14675 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
14676 (insert-before-markers (setq stamp (format-time-string fmt time)))
14677 (insert-before-markers (or post ""))
14678 (setq org-last-inserted-timestamp stamp)))
14680 (defun org-toggle-time-stamp-overlays ()
14681 "Toggle the use of custom time stamp formats."
14682 (interactive)
14683 (setq org-display-custom-times (not org-display-custom-times))
14684 (unless org-display-custom-times
14685 (let ((p (point-min)) (bmp (buffer-modified-p)))
14686 (while (setq p (next-single-property-change p 'display))
14687 (if (and (get-text-property p 'display)
14688 (eq (get-text-property p 'face) 'org-date))
14689 (remove-text-properties
14690 p (setq p (next-single-property-change p 'display))
14691 '(display t))))
14692 (set-buffer-modified-p bmp)))
14693 (if (featurep 'xemacs)
14694 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
14695 (org-restart-font-lock)
14696 (setq org-table-may-need-update t)
14697 (if org-display-custom-times
14698 (message "Time stamps are overlayed with custom format")
14699 (message "Time stamp overlays removed")))
14701 (defun org-display-custom-time (beg end)
14702 "Overlay modified time stamp format over timestamp between BEG and END."
14703 (let* ((ts (buffer-substring beg end))
14704 t1 w1 with-hm tf time str w2 (off 0))
14705 (save-match-data
14706 (setq t1 (org-parse-time-string ts t))
14707 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
14708 (setq off (- (match-end 0) (match-beginning 0)))))
14709 (setq end (- end off))
14710 (setq w1 (- end beg)
14711 with-hm (and (nth 1 t1) (nth 2 t1))
14712 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
14713 time (org-fix-decoded-time t1)
14714 str (org-add-props
14715 (format-time-string
14716 (substring tf 1 -1) (apply 'encode-time time))
14717 nil 'mouse-face 'highlight)
14718 w2 (length str))
14719 (if (not (= w2 w1))
14720 (add-text-properties (1+ beg) (+ 2 beg)
14721 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
14722 (if (featurep 'xemacs)
14723 (progn
14724 (put-text-property beg end 'invisible t)
14725 (put-text-property beg end 'end-glyph (make-glyph str)))
14726 (put-text-property beg end 'display str))))
14728 (defun org-translate-time (string)
14729 "Translate all timestamps in STRING to custom format.
14730 But do this only if the variable `org-display-custom-times' is set."
14731 (when org-display-custom-times
14732 (save-match-data
14733 (let* ((start 0)
14734 (re org-ts-regexp-both)
14735 t1 with-hm inactive tf time str beg end)
14736 (while (setq start (string-match re string start))
14737 (setq beg (match-beginning 0)
14738 end (match-end 0)
14739 t1 (save-match-data
14740 (org-parse-time-string (substring string beg end) t))
14741 with-hm (and (nth 1 t1) (nth 2 t1))
14742 inactive (equal (substring string beg (1+ beg)) "[")
14743 tf (funcall (if with-hm 'cdr 'car)
14744 org-time-stamp-custom-formats)
14745 time (org-fix-decoded-time t1)
14746 str (format-time-string
14747 (concat
14748 (if inactive "[" "<") (substring tf 1 -1)
14749 (if inactive "]" ">"))
14750 (apply 'encode-time time))
14751 string (replace-match str t t string)
14752 start (+ start (length str)))))))
14753 string)
14755 (defun org-fix-decoded-time (time)
14756 "Set 0 instead of nil for the first 6 elements of time.
14757 Don't touch the rest."
14758 (let ((n 0))
14759 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
14761 (defun org-days-to-time (timestamp-string)
14762 "Difference between TIMESTAMP-STRING and now in days."
14763 (- (time-to-days (org-time-string-to-time timestamp-string))
14764 (time-to-days (current-time))))
14766 (defun org-deadline-close (timestamp-string &optional ndays)
14767 "Is the time in TIMESTAMP-STRING close to the current date?"
14768 (setq ndays (or ndays (org-get-wdays timestamp-string)))
14769 (and (< (org-days-to-time timestamp-string) ndays)
14770 (not (org-entry-is-done-p))))
14772 (defun org-get-wdays (ts)
14773 "Get the deadline lead time appropriate for timestring TS."
14774 (cond
14775 ((<= org-deadline-warning-days 0)
14776 ;; 0 or negative, enforce this value no matter what
14777 (- org-deadline-warning-days))
14779 ;; lead time is specified.
14780 (floor (* (string-to-number (match-string 1 ts))
14781 (cdr (assoc (match-string 2 ts)
14782 '(("d" . 1) ("w" . 7)
14783 ("m" . 30.4) ("y" . 365.25)))))))
14784 ;; go for the default.
14785 (t org-deadline-warning-days)))
14787 (defun org-calendar-select-mouse (ev)
14788 "Return to `org-read-date' with the date currently selected.
14789 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14790 (interactive "e")
14791 (mouse-set-point ev)
14792 (when (calendar-cursor-to-date)
14793 (let* ((date (calendar-cursor-to-date))
14794 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14795 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14796 (if (active-minibuffer-window) (exit-minibuffer))))
14798 (defun org-check-deadlines (ndays)
14799 "Check if there are any deadlines due or past due.
14800 A deadline is considered due if it happens within `org-deadline-warning-days'
14801 days from today's date. If the deadline appears in an entry marked DONE,
14802 it is not shown. The prefix arg NDAYS can be used to test that many
14804 (interactive "P")
14805 (let* ((org-warn-days
14806 (cond
14807 ((equal ndays '(4)) 100000)
14808 (ndays (prefix-numeric-value ndays))
14809 (t (abs org-deadline-warning-days))))
14810 (case-fold-search nil)
14812 (callback
14813 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
14815 (message "%d deadlines past-due or due within %d days"
14816 (org-occur regexp nil callback)
14817 org-warn-days)))
14819 (defun org-check-before-date (date)
14820 "Check if there are deadlines or scheduled entries before DATE."
14821 (interactive (list (org-read-date)))
14822 (let ((case-fold-search nil)
14826 (callback
14827 (lambda () (time-less-p
14828 (org-time-string-to-time (match-string 2))
14829 (org-time-string-to-time date)))))
14830 (message "%d entries before %s"
14831 (org-occur regexp nil callback) date)))
14833 (defun org-check-after-date (date)
14834 "Check if there are deadlines or scheduled entries after DATE."
14835 (interactive (list (org-read-date)))
14836 (let ((case-fold-search nil)
14840 (callback
14841 (lambda () (not
14842 (time-less-p
14843 (org-time-string-to-time (match-string 2))
14844 (org-time-string-to-time date))))))
14845 (message "%d entries after %s"
14846 (org-occur regexp nil callback) date)))
14848 (defun org-evaluate-time-range (&optional to-buffer)
14849 "Evaluate a time range by computing the difference between start and end.
14850 Normally the result is just printed in the echo area, but with prefix arg
14851 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
14852 If the time range is actually in a table, the result is inserted into the
14853 next column.
14854 For time difference computation, a year is assumed to be exactly 365
14855 days in order to avoid rounding problems."
14856 (interactive "P")
14857 (or
14858 (org-clock-update-time-maybe)
14859 (save-excursion
14860 (unless (org-at-date-range-p t)
14861 (goto-char (point-at-bol))
14862 (re-search-forward org-tr-regexp-both (point-at-eol) t))
14863 (if (not (org-at-date-range-p t))
14864 (error "Not at a time-stamp range, and none found in current line")))
14865 (let* ((ts1 (match-string 1))
14866 (ts2 (match-string 2))
14867 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
14868 (match-end (match-end 0))
14869 (time1 (org-time-string-to-time ts1))
14870 (time2 (org-time-string-to-time ts2))
14871 (t1 (org-float-time time1))
14872 (t2 (org-float-time time2))
14873 (diff (abs (- t2 t1)))
14874 (negative (< (- t2 t1) 0))
14875 ;; (ys (floor (* 365 24 60 60)))
14876 (ds (* 24 60 60))
14877 (hs (* 60 60))
14878 (fy "%dy %dd %02d:%02d")
14879 (fy1 "%dy %dd")
14880 (fd "%dd %02d:%02d")
14881 (fd1 "%dd")
14882 (fh "%02d:%02d")
14883 y d h m align)
14884 (if havetime
14885 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14886 y 0
14887 d (floor (/ diff ds)) diff (mod diff ds)
14888 h (floor (/ diff hs)) diff (mod diff hs)
14889 m (floor (/ diff 60)))
14890 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14891 y 0
14892 d (floor (+ (/ diff ds) 0.5))
14893 h 0 m 0))
14894 (if (not to-buffer)
14895 (message "%s" (org-make-tdiff-string y d h m))
14896 (if (org-at-table-p)
14897 (progn
14898 (goto-char match-end)
14899 (setq align t)
14900 (and (looking-at " *|") (goto-char (match-end 0))))
14901 (goto-char match-end))
14902 (if (looking-at
14904 (replace-match ""))
14905 (if negative (insert " -"))
14906 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
14907 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
14908 (insert " " (format fh h m))))
14909 (if align (org-table-align))
14910 (message "Time difference inserted")))))
14912 (defun org-make-tdiff-string (y d h m)
14913 (let ((fmt "")
14914 (l nil))
14915 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
14916 l (push y l)))
14917 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
14918 l (push d l)))
14919 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
14920 l (push h l)))
14921 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
14922 l (push m l)))
14923 (apply 'format fmt (nreverse l))))
14925 (defun org-time-string-to-time (s)
14926 (apply 'encode-time (org-parse-time-string s)))
14927 (defun org-time-string-to-seconds (s)
14928 (org-float-time (org-time-string-to-time s)))
14930 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
14931 "Convert a time stamp to an absolute day number.
14932 If there is a specifier for a cyclic time stamp, get the closest date to
14933 DAYNR.
14934 PREFER and SHOW-ALL are passed through to `org-closest-date'.
14935 the variable date is bound by the calendar when this is called."
14936 (cond
14938 (if (org-diary-sexp-entry (match-string 1 s) "" date)
14939 daynr
14940 (+ daynr 1000)))
14942 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
14943 (time-to-days (current-time))) (match-string 0 s)
14944 prefer show-all))
14945 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
14947 (defun org-days-to-iso-week (days)
14948 "Return the iso week number."
14949 (require 'cal-iso)
14950 (car (calendar-iso-from-absolute days)))
14952 (defun org-small-year-to-year (year)
14953 "Convert 2-digit years into 4-digit years.
14954 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
14955 The year 2000 cannot be abbreviated. Any year larger than 99
14956 is returned unchanged."
14957 (if (< year 38)
14958 (setq year (+ 2000 year))
14959 (if (< year 100)
14960 (setq year (+ 1900 year))))
14961 year)
14963 (defun org-time-from-absolute (d)
14964 "Return the time corresponding to date D.
14965 D may be an absolute day number, or a calendar-type list (month day year)."
14966 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
14967 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
14969 (defun org-calendar-holiday ()
14970 "List of holidays, for Diary display in Org-mode."
14971 (require 'holidays)
14972 (let ((hl (funcall
14973 (if (fboundp 'calendar-check-holidays)
14974 'calendar-check-holidays 'check-calendar-holidays) date)))
14975 (if hl (mapconcat 'identity hl "; "))))
14977 (defun org-diary-sexp-entry (sexp entry date)
14978 "Process a SEXP diary ENTRY for DATE."
14979 (require 'diary-lib)
14980 (let ((result (if calendar-debug-sexp
14981 (let ((stack-trace-on-error t))
14982 (eval (car (read-from-string sexp))))
14983 (condition-case nil
14984 (eval (car (read-from-string sexp)))
14985 (error
14986 (beep)
14987 (message "Bad sexp at line %d in %s: %s"
14988 (org-current-line)
14989 (buffer-file-name) sexp)
14990 (sleep-for 2))))))
14991 (cond ((stringp result) (split-string result "; "))
14992 ((and (consp result)
14993 (not (consp (cdr result)))
14994 (stringp (cdr result))) (cdr result))
14995 ((and (consp result)
14996 (stringp (car result))) result)
14997 (result entry)
14998 (t nil))))
15000 (defun org-diary-to-ical-string (frombuf)
15001 "Get iCalendar entries from diary entries in buffer FROMBUF.
15002 This uses the icalendar.el library."
15003 (let* ((tmpdir (if (featurep 'xemacs)
15004 (temp-directory)
15005 temporary-file-directory))
15006 (tmpfile (make-temp-name
15007 (expand-file-name "orgics" tmpdir)))
15008 buf rtn b e)
15009 (with-current-buffer frombuf
15010 (icalendar-export-region (point-min) (point-max) tmpfile)
15011 (setq buf (find-buffer-visiting tmpfile))
15012 (set-buffer buf)
15013 (goto-char (point-min))
15014 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15015 (setq b (match-beginning 0)))
15016 (goto-char (point-max))
15017 (if (re-search-backward "^END:VEVENT" nil t)
15018 (setq e (match-end 0)))
15020 (kill-buffer buf)
15021 (delete-file tmpfile)
15022 rtn))
15024 (defun org-closest-date (start current change prefer show-all)
15025 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15026 When PREFER is `past' return a date that is either CURRENT or past.
15027 When PREFER is `future', return a date that is either CURRENT or future.
15028 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15029 ;; Make the proper lists from the dates
15030 (catch 'exit
15031 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15032 dn dw sday cday n1 n2 n0
15033 d m y y1 y2 date1 date2 nmonths nm ny m2)
15035 (setq start (org-date-to-gregorian start)
15036 current (org-date-to-gregorian
15037 (if show-all
15038 current
15039 (time-to-days (current-time))))
15040 sday (calendar-absolute-from-gregorian start)
15041 cday (calendar-absolute-from-gregorian current))
15043 (if (<= cday sday) (throw 'exit sday))
15046 (setq dn (string-to-number (match-string 1 change))
15047 dw (cdr (assoc (match-string 2 change) a1)))
15048 (error "Invalid change specifier: %s" change))
15049 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15050 (cond
15051 ((eq dw 'day)
15052 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15053 n2 (+ n1 dn)))
15054 ((eq dw 'year)
15055 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15056 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15057 (setq date1 (list m d y1)
15058 n1 (calendar-absolute-from-gregorian date1)
15059 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15060 n2 (calendar-absolute-from-gregorian date2)))
15061 ((eq dw 'month)
15062 ;; approx number of month between the two dates
15063 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15064 ;; How often does dn fit in there?
15065 (setq d (nth 1 start) m (car start) y (nth 2 start)
15066 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15067 m (+ m nm)
15068 ny (floor (/ m 12))
15069 y (+ y ny)
15070 m (- m (* ny 12)))
15071 (while (> m 12) (setq m (- m 12) y (1+ y)))
15072 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15073 (setq m2 (+ m dn) y2 y)
15074 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15075 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15076 (while (<= n2 cday)
15077 (setq n1 n2 m m2 y y2)
15078 (setq m2 (+ m dn) y2 y)
15079 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15080 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15081 ;; Make sure n1 is the earlier date
15082 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15083 (if show-all
15084 (cond
15085 ((eq prefer 'past) (if (= cday n2) n2 n1))
15086 ((eq prefer 'future) (if (= cday n1) n1 n2))
15087 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15088 (cond
15089 ((eq prefer 'past) (if (= cday n2) n2 n1))
15090 ((eq prefer 'future) (if (= cday n1) n1 n2))
15091 (t (if (= cday n1) n1 n2)))))))
15093 (defun org-date-to-gregorian (date)
15094 "Turn any specification of DATE into a Gregorian date for the calendar."
15095 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15096 ((and (listp date) (= (length date) 3)) date)
15097 ((stringp date)
15098 (setq date (org-parse-time-string date))
15099 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15100 ((listp date)
15101 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15103 (defun org-parse-time-string (s &optional nodefault)
15104 "Parse the standard Org-mode time string.
15105 This should be a lot faster than the normal `parse-time-string'.
15106 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15107 hour and minute fields will be nil if not given."
15108 (if (string-match org-ts-regexp0 s)
15109 (list 0
15110 (if (or (match-beginning 8) (not nodefault))
15111 (string-to-number (or (match-string 8 s) "0")))
15112 (if (or (match-beginning 7) (not nodefault))
15113 (string-to-number (or (match-string 7 s) "0")))
15114 (string-to-number (match-string 4 s))
15115 (string-to-number (match-string 3 s))
15116 (string-to-number (match-string 2 s))
15117 nil nil nil)
15118 (error "Not a standard Org-mode time string: %s" s)))
15120 (defun org-timestamp-up (&optional arg)
15121 "Increase the date item at the cursor by one.
15122 If the cursor is on the year, change the year. If it is on the month or
15123 the day, change that.
15124 With prefix ARG, change by that many units."
15125 (interactive "p")
15126 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15128 (defun org-timestamp-down (&optional arg)
15129 "Decrease the date item at the cursor by one.
15130 If the cursor is on the year, change the year. If it is on the month or
15131 the day, change that.
15132 With prefix ARG, change by that many units."
15133 (interactive "p")
15134 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15136 (defun org-timestamp-up-day (&optional arg)
15137 "Increase the date in the time stamp by one day.
15138 With prefix ARG, change that many days."
15139 (interactive "p")
15140 (if (and (not (org-at-timestamp-p t))
15141 (org-on-heading-p))
15142 (org-todo 'up)
15143 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15145 (defun org-timestamp-down-day (&optional arg)
15146 "Decrease the date in the time stamp by one day.
15147 With prefix ARG, change that many days."
15148 (interactive "p")
15149 (if (and (not (org-at-timestamp-p t))
15150 (org-on-heading-p))
15151 (org-todo 'down)
15152 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15154 (defun org-at-timestamp-p (&optional inactive-ok)
15155 "Determine if the cursor is in or at a timestamp."
15156 (interactive)
15157 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15158 (pos (point))
15159 (ans (or (looking-at tsr)
15160 (save-excursion
15162 (if (> (point) (point-min)) (backward-char 1))
15163 (and (looking-at tsr)
15164 (> (- (match-end 0) pos) -1))))))
15165 (and ans
15166 (boundp 'org-ts-what)
15167 (setq org-ts-what
15168 (cond
15169 ((= pos (match-beginning 0)) 'bracket)
15170 ((= pos (1- (match-end 0))) 'bracket)
15171 ((org-pos-in-match-range pos 2) 'year)
15172 ((org-pos-in-match-range pos 3) 'month)
15173 ((org-pos-in-match-range pos 7) 'hour)
15174 ((org-pos-in-match-range pos 8) 'minute)
15175 ((or (org-pos-in-match-range pos 4)
15176 (org-pos-in-match-range pos 5)) 'day)
15177 ((and (> pos (or (match-end 8) (match-end 5)))
15178 (< pos (match-end 0)))
15179 (- pos (or (match-end 8) (match-end 5))))
15180 (t 'day))))
15181 ans))
15183 (defun org-toggle-timestamp-type ()
15184 "Toggle the type (<active> or [inactive]) of a time stamp."
15185 (interactive)
15186 (when (org-at-timestamp-p t)
15187 (let ((beg (match-beginning 0)) (end (match-end 0))
15188 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15189 (save-excursion
15190 (goto-char beg)
15191 (while (re-search-forward "[][<>]" end t)
15192 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15193 t t)))
15194 (message "Timestamp is now %sactive"
15195 (if (equal (char-after beg) ?<) "" "in")))))
15197 (defun org-timestamp-change (n &optional what updown)
15198 "Change the date in the time stamp at point.
15199 The date will be changed by N times WHAT. WHAT can be `day', `month',
15200 `year', `minute', `second'. If WHAT is not given, the cursor position
15201 in the timestamp determines what will be changed."
15202 (let ((pos (point))
15203 with-hm inactive
15204 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15205 org-ts-what
15206 extra rem
15207 ts time time0)
15208 (if (not (org-at-timestamp-p t))
15209 (error "Not at a timestamp"))
15210 (if (and (not what) (eq org-ts-what 'bracket))
15211 (org-toggle-timestamp-type)
15212 (if (and (not what) (not (eq org-ts-what 'day))
15213 org-display-custom-times
15214 (get-text-property (point) 'display)
15215 (not (get-text-property (1- (point)) 'display)))
15216 (setq org-ts-what 'day))
15217 (setq org-ts-what (or what org-ts-what)
15218 inactive (= (char-after (match-beginning 0)) ?\[)
15219 ts (match-string 0))
15220 (replace-match "")
15221 (if (string-match
15223 ts)
15224 (setq extra (match-string 1 ts)))
15226 (setq with-hm t))
15227 (setq time0 (org-parse-time-string ts))
15228 (when (and updown
15229 (eq org-ts-what 'minute)
15230 (not current-prefix-arg))
15231 ;; This looks like s-up and s-down. Change by one rounding step.
15232 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15233 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15234 (setcar (cdr time0) (+ (nth 1 time0)
15235 (if (> n 0) (- rem) (- dm rem))))))
15236 (setq time
15237 (encode-time (or (car time0) 0)
15238 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15239 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15240 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15241 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15242 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15243 (nthcdr 6 time0)))
15244 (when (and (member org-ts-what '(hour minute))
15245 extra
15247 (setq extra (org-modify-ts-extra
15248 extra
15249 (if (eq org-ts-what 'hour) 2 5)
15250 n dm)))
15251 (when (integerp org-ts-what)
15252 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15253 (if (eq what 'calendar)
15254 (let ((cal-date (org-get-date-from-calendar)))
15255 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15256 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15257 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15258 (setcar time0 (or (car time0) 0))
15259 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15260 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15261 (setq time (apply 'encode-time time0))))
15262 (setq org-last-changed-timestamp
15263 (org-insert-time-stamp time with-hm inactive nil nil extra))
15264 (org-clock-update-time-maybe)
15265 (goto-char pos)
15266 ;; Try to recenter the calendar window, if any
15267 (if (and org-calendar-follow-timestamp-change
15268 (get-buffer-window "*Calendar*" t)
15269 (memq org-ts-what '(day month year)))
15270 (org-recenter-calendar (time-to-days time))))))
15272 (defun org-modify-ts-extra (s pos n dm)
15273 "Change the different parts of the lead-time and repeat fields in timestamp."
15274 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15275 ng h m new rem)
15276 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15277 (cond
15278 ((or (org-pos-in-match-range pos 2)
15279 (org-pos-in-match-range pos 3))
15280 (setq m (string-to-number (match-string 3 s))
15281 h (string-to-number (match-string 2 s)))
15282 (if (org-pos-in-match-range pos 2)
15283 (setq h (+ h n))
15284 (setq n (* dm (org-no-warnings (signum n))))
15285 (when (not (= 0 (setq rem (% m dm))))
15286 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15287 (setq m (+ m n)))
15288 (if (< m 0) (setq m (+ m 60) h (1- h)))
15289 (if (> m 59) (setq m (- m 60) h (1+ h)))
15290 (setq h (min 24 (max 0 h)))
15291 (setq ng 1 new (format "-%02d:%02d" h m)))
15292 ((org-pos-in-match-range pos 6)
15293 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15294 ((org-pos-in-match-range pos 5)
15295 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15297 ((org-pos-in-match-range pos 9)
15298 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15299 ((org-pos-in-match-range pos 8)
15300 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15302 (when ng
15303 (setq s (concat
15304 (substring s 0 (match-beginning ng))
15305 new
15306 (substring s (match-end ng))))))
15307 s))
15309 (defun org-recenter-calendar (date)
15310 "If the calendar is visible, recenter it to DATE."
15311 (let* ((win (selected-window))
15312 (cwin (get-buffer-window "*Calendar*" t))
15313 (calendar-move-hook nil))
15314 (when cwin
15315 (select-window cwin)
15316 (calendar-goto-date (if (listp date) date
15317 (calendar-gregorian-from-absolute date)))
15318 (select-window win))))
15320 (defun org-goto-calendar (&optional arg)
15321 "Go to the Emacs calendar at the current date.
15322 If there is a time stamp in the current line, go to that date.
15323 A prefix ARG can be used to force the current date."
15324 (interactive "P")
15325 (let ((tsr org-ts-regexp) diff
15326 (calendar-move-hook nil)
15327 (calendar-view-holidays-initially-flag nil)
15328 (calendar-view-diary-initially-flag nil))
15329 (if (or (org-at-timestamp-p)
15330 (save-excursion
15331 (beginning-of-line 1)
15332 (looking-at (concat ".*" tsr))))
15333 (let ((d1 (time-to-days (current-time)))
15334 (d2 (time-to-days
15335 (org-time-string-to-time (match-string 1)))))
15336 (setq diff (- d2 d1))))
15337 (calendar)
15338 (calendar-goto-today)
15339 (if (and diff (not arg)) (calendar-forward-day diff))))
15341 (defun org-get-date-from-calendar ()
15342 "Return a list (month day year) of date at point in calendar."
15343 (with-current-buffer "*Calendar*"
15344 (save-match-data
15345 (calendar-cursor-to-date))))
15347 (defun org-date-from-calendar ()
15348 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15349 If there is already a time stamp at the cursor position, update it."
15350 (interactive)
15351 (if (org-at-timestamp-p t)
15352 (org-timestamp-change 0 'calendar)
15353 (let ((cal-date (org-get-date-from-calendar)))
15354 (org-insert-time-stamp
15355 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15357 (defun org-minutes-to-hh:mm-string (m)
15358 "Compute H:MM from a number of minutes."
15359 (let ((h (/ m 60)))
15360 (setq m (- m (* 60 h)))
15361 (format org-time-clocksum-format h m)))
15363 (defun org-hh:mm-string-to-minutes (s)
15364 "Convert a string H:MM to a number of minutes.
15365 If the string is just a number, interpret it as minutes.
15366 In fact, the first hh:mm or number in the string will be taken,
15367 there can be extra stuff in the string.
15368 If no number is found, the return value is 0."
15369 (cond
15371 (+ (* (string-to-number (match-string 1 s)) 60)
15372 (string-to-number (match-string 2 s))))
15374 (string-to-number (match-string 1 s)))
15375 (t 0)))
15377 ;;;; Files
15379 (defun org-save-all-org-buffers ()
15380 "Save all Org-mode buffers without user confirmation."
15381 (interactive)
15382 (message "Saving all Org-mode buffers...")
15383 (save-some-buffers t 'org-mode-p)
15384 (when (featurep 'org-id) (org-id-locations-save))
15385 (message "Saving all Org-mode buffers... done"))
15387 (defun org-revert-all-org-buffers ()
15388 "Revert all Org-mode buffers.
15389 Prompt for confirmation when there are unsaved changes.
15390 Be sure you know what you are doing before letting this function
15391 overwrite your changes.
15393 This function is useful in a setup where one tracks org files
15394 with a version control system, to revert on one machine after pulling
15395 changes from another. I believe the procedure must be like this:
15397 1. M-x org-save-all-org-buffers
15398 2. Pull changes from the other machine, resolve conflicts
15399 3. M-x org-revert-all-org-buffers"
15400 (interactive)
15401 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15402 (error "Abort"))
15403 (save-excursion
15404 (save-window-excursion
15405 (mapc
15406 (lambda (b)
15407 (when (and (with-current-buffer b (org-mode-p))
15408 (with-current-buffer b buffer-file-name))
15409 (switch-to-buffer b)
15410 (revert-buffer t 'no-confirm)))
15411 (buffer-list))
15412 (when (and (featurep 'org-id) org-id-track-globally)
15413 (org-id-locations-load)))))
15415 ;;;; Agenda files
15417 ;;;###autoload
15418 (defun org-switchb (&optional arg)
15419 "Switch between Org buffers.
15420 With a prefix argument, restrict available to files.
15421 With two prefix arguments, restrict available buffers to agenda files.
15423 Defaults to `iswitchb' for buffer name completion.
15424 Set `org-completion-use-ido' to make it use ido instead."
15425 (interactive "P")
15426 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15427 ((equal arg '(16)) (org-buffer-list 'agenda))
15428 (t (org-buffer-list))))
15429 (org-completion-use-iswitchb org-completion-use-iswitchb)
15430 (org-completion-use-ido org-completion-use-ido))
15431 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15432 (setq org-completion-use-iswitchb t))
15433 (switch-to-buffer
15434 (org-icompleting-read "Org buffer: "
15435 (mapcar 'list (mapcar 'buffer-name blist))
15436 nil t))))
15438 ;;; Define some older names previously used for this functionality
15439 ;;;###autoload
15440 (defalias 'org-ido-switchb 'org-switchb)
15441 ;;;###autoload
15442 (defalias 'org-iswitchb 'org-switchb)
15444 (defun org-buffer-list (&optional predicate exclude-tmp)
15445 "Return a list of Org buffers.
15446 PREDICATE can be `export', `files' or `agenda'.
15448 export restrict the list to Export buffers.
15449 files restrict the list to buffers visiting Org files.
15450 agenda restrict the list to buffers visiting agenda files.
15452 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15453 (let* ((bfn nil)
15454 (agenda-files (and (eq predicate 'agenda)
15455 (mapcar 'file-truename (org-agenda-files t))))
15456 (filter
15457 (cond
15458 ((eq predicate 'files)
15459 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
15460 ((eq predicate 'export)
15461 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15462 ((eq predicate 'agenda)
15463 (lambda (b)
15464 (with-current-buffer b
15465 (and (eq major-mode 'org-mode)
15466 (setq bfn (buffer-file-name b))
15467 (member (file-truename bfn) agenda-files)))))
15468 (t (lambda (b) (with-current-buffer b
15469 (or (eq major-mode 'org-mode)
15470 (string-match "\*Org .*Export"
15471 (buffer-name b)))))))))
15472 (delq nil
15473 (mapcar
15474 (lambda(b)
15475 (if (and (funcall filter b)
15476 (or (not exclude-tmp)
15477 (not (string-match "tmp" (buffer-name b)))))
15478 b
15479 nil))
15480 (buffer-list)))))
15482 (defun org-agenda-files (&optional unrestricted archives)
15483 "Get the list of agenda files.
15484 Optional UNRESTRICTED means return the full list even if a restriction
15485 is currently in place.
15486 When ARCHIVES is t, include all archive files that are really being
15487 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15488 `org-agenda-archives-mode' is t."
15489 (let ((files
15490 (cond
15491 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15492 ((stringp org-agenda-files) (org-read-agenda-file-list))
15493 ((listp org-agenda-files) org-agenda-files)
15494 (t (error "Invalid value of `org-agenda-files'")))))
15495 (setq files (apply 'append
15496 (mapcar (lambda (f)
15497 (if (file-directory-p f)
15498 (directory-files
15499 f t org-agenda-file-regexp)
15500 (list f)))
15501 files)))
15502 (when org-agenda-skip-unavailable-files
15503 (setq files (delq nil
15504 (mapcar (function
15505 (lambda (file)
15506 (and (file-readable-p file) file)))
15507 files))))
15508 (when (or (eq archives t)
15509 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15510 (setq files (org-add-archive-files files)))
15511 files))
15513 (defun org-agenda-file-p (&optional file)
15514 "Return non-nil, if FILE is an agenda file.
15515 If FILE is omitted, use the file associated with the current
15516 buffer."
15517 (member (or file (buffer-file-name))
15518 (org-agenda-files t)))
15520 (defun org-edit-agenda-file-list ()
15521 "Edit the list of agenda files.
15522 Depending on setup, this either uses customize to edit the variable
15523 `org-agenda-files', or it visits the file that is holding the list. In the
15524 latter case, the buffer is set up in a way that saving it automatically kills
15525 the buffer and restores the previous window configuration."
15526 (interactive)
15527 (if (stringp org-agenda-files)
15528 (let ((cw (current-window-configuration)))
15529 (find-file org-agenda-files)
15530 (org-set-local 'org-window-configuration cw)
15531 (org-add-hook 'after-save-hook
15532 (lambda ()
15533 (set-window-configuration
15534 (prog1 org-window-configuration
15535 (kill-buffer (current-buffer))))
15536 (org-install-agenda-files-menu)
15537 (message "New agenda file list installed"))
15538 nil 'local)
15539 (message "%s" (substitute-command-keys
15541 (customize-variable 'org-agenda-files)))
15543 (defun org-store-new-agenda-file-list (list)
15544 "Set new value for the agenda file list and save it correctly."
15545 (if (stringp org-agenda-files)
15546 (let ((fe (org-read-agenda-file-list t)) b u)
15547 (while (setq b (find-buffer-visiting org-agenda-files))
15548 (kill-buffer b))
15549 (with-temp-file org-agenda-files
15550 (insert
15551 (mapconcat
15552 (lambda (f) ;; Keep un-expanded entries.
15553 (if (setq u (assoc f fe))
15554 (cdr u)
15555 f))
15558 (let ((org-mode-hook nil) (org-inhibit-startup t)
15559 (org-insert-mode-line-in-empty-file nil))
15560 (setq org-agenda-files list)
15561 (customize-save-variable 'org-agenda-files org-agenda-files))))
15563 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15564 "Read the list of agenda files from a file.
15565 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15566 filenames, used by `org-store-new-agenda-file-list' to write back
15567 un-expanded file names."
15568 (when (file-directory-p org-agenda-files)
15569 (error "`org-agenda-files' cannot be a single directory"))
15570 (when (stringp org-agenda-files)
15571 (with-temp-buffer
15572 (insert-file-contents org-agenda-files)
15573 (mapcar
15574 (lambda (f)
15575 (let ((e (expand-file-name (substitute-in-file-name f)
15576 org-directory)))
15577 (if pair-with-expansion
15578 (cons e f)
15579 e)))
15582 ;;;###autoload
15583 (defun org-cycle-agenda-files ()
15584 "Cycle through the files in `org-agenda-files'.
15585 If the current buffer visits an agenda file, find the next one in the list.
15586 If the current buffer does not, find the first agenda file."
15587 (interactive)
15588 (let* ((fs (org-agenda-files t))
15589 (files (append fs (list (car fs))))
15590 (tcf (if buffer-file-name (file-truename buffer-file-name)))
15591 file)
15592 (unless files (error "No agenda files"))
15593 (catch 'exit
15594 (while (setq file (pop files))
15595 (if (equal (file-truename file) tcf)
15596 (when (car files)
15597 (find-file (car files))
15598 (throw 'exit t))))
15599 (find-file (car fs)))
15600 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
15602 (defun org-agenda-file-to-front (&optional to-end)
15603 "Move/add the current file to the top of the agenda file list.
15604 If the file is not present in the list, it is added to the front. If it is
15605 present, it is moved there. With optional argument TO-END, add/move to the
15606 end of the list."
15607 (interactive "P")
15608 (let ((org-agenda-skip-unavailable-files nil)
15609 (file-alist (mapcar (lambda (x)
15610 (cons (file-truename x) x))
15611 (org-agenda-files t)))
15612 (ctf (file-truename buffer-file-name))
15613 x had)
15614 (setq x (assoc ctf file-alist) had x)
15616 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
15617 (if to-end
15618 (setq file-alist (append (delq x file-alist) (list x)))
15619 (setq file-alist (cons x (delq x file-alist))))
15620 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
15621 (org-install-agenda-files-menu)
15622 (message "File %s to %s of agenda file list"
15623 (if had "moved" "added") (if to-end "end" "front"))))
15625 (defun org-remove-file (&optional file)
15626 "Remove current file from the list of files in variable `org-agenda-files'.
15627 These are the files which are being checked for agenda entries.
15628 Optional argument FILE means use this file instead of the current."
15629 (interactive)
15630 (let* ((org-agenda-skip-unavailable-files nil)
15631 (file (or file buffer-file-name))
15632 (true-file (file-truename file))
15633 (afile (abbreviate-file-name file))
15634 (files (delq nil (mapcar
15635 (lambda (x)
15636 (if (equal true-file
15637 (file-truename x))
15638 nil x))
15639 (org-agenda-files t)))))
15640 (if (not (= (length files) (length (org-agenda-files t))))
15641 (progn
15642 (org-store-new-agenda-file-list files)
15643 (org-install-agenda-files-menu)
15644 (message "Removed file: %s" afile))
15645 (message "File was not in list: %s (not removed)" afile))))
15647 (defun org-file-menu-entry (file)
15648 (vector file (list 'find-file file) t))
15650 (defun org-check-agenda-file (file)
15651 "Make sure FILE exists. If not, ask user what to do."
15652 (when (not (file-exists-p file))
15653 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
15654 (abbreviate-file-name file))
15655 (let ((r (downcase (read-char-exclusive))))
15656 (cond
15657 ((equal r ?r)
15658 (org-remove-file file)
15659 (throw 'nextfile t))
15660 (t (error "Abort"))))))
15662 (defun org-get-agenda-file-buffer (file)
15663 "Get a buffer visiting FILE. If the buffer needs to be created, add
15664 it to the list of buffers which might be released later."
15665 (let ((buf (org-find-base-buffer-visiting file)))
15666 (if buf
15667 buf ; just return it
15668 ;; Make a new buffer and remember it
15669 (setq buf (find-file-noselect file))
15670 (if buf (push buf org-agenda-new-buffers))
15671 buf)))
15673 (defun org-release-buffers (blist)
15674 "Release all buffers in list, asking the user for confirmation when needed.
15675 When a buffer is unmodified, it is just killed. When modified, it is saved
15676 \(if the user agrees) and then killed."
15677 (let (buf file)
15678 (while (setq buf (pop blist))
15679 (setq file (buffer-file-name buf))
15680 (when (and (buffer-modified-p buf)
15681 file
15682 (y-or-n-p (format "Save file %s? " file)))
15683 (with-current-buffer buf (save-buffer)))
15684 (kill-buffer buf))))
15686 (defun org-prepare-agenda-buffers (files)
15687 "Create buffers for all agenda files, protect archived trees and comments."
15688 (interactive)
15689 (let ((pa '(:org-archived t))
15690 (pc '(:org-comment t))
15691 (pall '(:org-archived t :org-comment t))
15692 (inhibit-read-only t)
15693 (rea (concat ":" org-archive-tag ":"))
15694 bmp file re)
15695 (save-excursion
15696 (save-restriction
15697 (while (setq file (pop files))
15698 (catch 'nextfile
15699 (if (bufferp file)
15700 (set-buffer file)
15701 (org-check-agenda-file file)
15702 (set-buffer (org-get-agenda-file-buffer file)))
15703 (widen)
15704 (setq bmp (buffer-modified-p))
15705 (org-refresh-category-properties)
15706 (setq org-todo-keywords-for-agenda
15707 (append org-todo-keywords-for-agenda org-todo-keywords-1))
15708 (setq org-done-keywords-for-agenda
15709 (append org-done-keywords-for-agenda org-done-keywords))
15710 (setq org-todo-keyword-alist-for-agenda
15711 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
15712 (setq org-drawers-for-agenda
15713 (append org-drawers-for-agenda org-drawers))
15714 (setq org-tag-alist-for-agenda
15715 (append org-tag-alist-for-agenda org-tag-alist))
15717 (save-excursion
15718 (remove-text-properties (point-min) (point-max) pall)
15719 (when org-agenda-skip-archived-trees
15720 (goto-char (point-min))
15721 (while (re-search-forward rea nil t)
15722 (if (org-on-heading-p t)
15723 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
15724 (goto-char (point-min))
15726 (while (re-search-forward re nil t)
15727 (add-text-properties
15728 (match-beginning 0) (org-end-of-subtree t) pc)))
15729 (set-buffer-modified-p bmp)))))
15730 (setq org-todo-keywords-for-agenda
15731 (org-uniquify org-todo-keywords-for-agenda))
15732 (setq org-todo-keyword-alist-for-agenda
15733 (org-uniquify org-todo-keyword-alist-for-agenda)
15734 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
15736 ;;;; Embedded LaTeX
15738 (defvar org-cdlatex-mode-map (make-sparse-keymap)
15739 "Keymap for the minor `org-cdlatex-mode'.")
15741 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
15742 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
15743 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
15744 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
15745 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
15747 (defvar org-cdlatex-texmathp-advice-is-done nil
15748 "Flag remembering if we have applied the advice to texmathp already.")
15750 (define-minor-mode org-cdlatex-mode
15751 "Toggle the minor `org-cdlatex-mode'.
15752 This mode supports entering LaTeX environment and math in LaTeX fragments
15753 in Org-mode.
15755 nil " OCDL" nil
15756 (when org-cdlatex-mode (require 'cdlatex))
15757 (unless org-cdlatex-texmathp-advice-is-done
15758 (setq org-cdlatex-texmathp-advice-is-done t)
15759 (defadvice texmathp (around org-math-always-on activate)
15760 "Always return t in org-mode buffers.
15761 This is because we want to insert math symbols without dollars even outside
15762 the LaTeX math segments. If Orgmode thinks that point is actually inside
15763 an embedded LaTeX fragment, let texmathp do its job.
15765 (interactive)
15766 (let (p)
15767 (cond
15768 ((not (org-mode-p)) ad-do-it)
15769 ((eq this-command 'cdlatex-math-symbol)
15770 (setq ad-return-value t
15771 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
15772 (t
15773 (let ((p (org-inside-LaTeX-fragment-p)))
15774 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
15775 (setq ad-return-value t
15776 texmathp-why '("Org-mode embedded math" . 0))
15777 (if p ad-do-it)))))))))
15779 (defun turn-on-org-cdlatex ()
15780 "Unconditionally turn on `org-cdlatex-mode'."
15781 (org-cdlatex-mode 1))
15783 (defun org-inside-LaTeX-fragment-p ()
15784 "Test if point is inside a LaTeX fragment.
15786 sequence appearing also before point.
15787 Even though the matchers for math are configurable, this function assumes
15789 delimiters are skipped when they have been removed by customization.
15790 The return value is nil, or a cons cell with the delimiter and
15791 and the position of this delimiter.
15793 This function does a reasonably good job, but can locally be fooled by
15794 for example currency specifications. For example it will assume being in
15796 fragments that are properly closed, but during editing, we have to live
15797 with the uncertainty caused by missing closing delimiters. This function
15798 looks only before point, not after."
15799 (catch 'exit
15800 (let ((pos (point))
15801 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
15802 (lim (progn
15804 (point)))
15805 dd-on str (start 0) m re)
15806 (goto-char pos)
15807 (when dodollar
15809 re (nth 1 (assoc "$" org-latex-regexps)))
15810 (while (string-match re str start)
15811 (cond
15812 ((= (match-end 0) (length str))
15813 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
15814 ((= (match-end 0) (- (length str) 5))
15815 (throw 'exit nil))
15816 (t (setq start (match-end 0))))))
15817 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
15818 (goto-char pos)
15819 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
15820 (and (match-beginning 2) (throw 'exit nil))
15821 ;; count $$
15823 (setq dd-on (not dd-on)))
15824 (goto-char pos)
15825 (if dd-on (cons "$$" m))))))
15827 (defun org-inside-latex-macro-p ()
15828 "Is point inside a LaTeX macro or its arguments?"
15829 (save-match-data
15830 (org-in-regexp
15833 (defun org-try-cdlatex-tab ()
15834 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15835 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15836 - inside a LaTeX fragment, or
15837 - after the first word in a line, where an abbreviation expansion could
15838 insert a LaTeX environment."
15839 (when org-cdlatex-mode
15840 (cond
15841 ((save-excursion
15842 (skip-chars-backward "a-zA-Z0-9*")
15844 (bolp))
15845 (cdlatex-tab) t)
15846 ((org-inside-LaTeX-fragment-p)
15847 (cdlatex-tab) t)
15848 (t nil))))
15850 (defun org-cdlatex-underscore-caret (&optional arg)
15851 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15852 Revert to the normal definition outside of these fragments."
15853 (interactive "P")
15854 (if (org-inside-LaTeX-fragment-p)
15855 (call-interactively 'cdlatex-sub-superscript)
15856 (let (org-cdlatex-mode)
15857 (call-interactively (key-binding (vector last-input-event))))))
15859 (defun org-cdlatex-math-modify (&optional arg)
15860 "Execute `cdlatex-math-modify' in LaTeX fragments.
15861 Revert to the normal definition outside of these fragments."
15862 (interactive "P")
15863 (if (org-inside-LaTeX-fragment-p)
15864 (call-interactively 'cdlatex-math-modify)
15865 (let (org-cdlatex-mode)
15866 (call-interactively (key-binding (vector last-input-event))))))
15868 (defvar org-latex-fragment-image-overlays nil
15869 "List of overlays carrying the images of latex fragments.")
15870 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
15872 (defun org-remove-latex-fragment-image-overlays ()
15873 "Remove all overlays with LaTeX fragment images in current buffer."
15874 (mapc 'delete-overlay org-latex-fragment-image-overlays)
15875 (setq org-latex-fragment-image-overlays nil))
15877 (defun org-preview-latex-fragment (&optional subtree)
15878 "Preview the LaTeX fragment at point, or all locally or globally.
15879 If the cursor is in a LaTeX fragment, create the image and overlay
15880 it over the source code. If there is no fragment at point, display
15881 all fragments in the current text, from one headline to the next. With
15882 prefix SUBTREE, display all fragments in the current subtree. With a
15884 the cursor is before the first headline,
15885 display all fragments in the buffer.
15887 (interactive "P")
15888 (org-remove-latex-fragment-image-overlays)
15889 (save-excursion
15890 (save-restriction
15891 (let (beg end at msg)
15892 (cond
15893 ((or (equal subtree '(16))
15894 (not (save-excursion
15895 (re-search-backward (concat "^" outline-regexp) nil t))))
15896 (setq beg (point-min) end (point-max)
15897 msg "Creating images for buffer...%s"))
15898 ((equal subtree '(4))
15899 (org-back-to-heading)
15900 (setq beg (point) end (org-end-of-subtree t)
15901 msg "Creating images for subtree...%s"))
15902 (t
15903 (if (setq at (org-inside-LaTeX-fragment-p))
15904 (goto-char (max (point-min) (- (cdr at) 2)))
15905 (org-back-to-heading))
15906 (setq beg (point) end (progn (outline-next-heading) (point))
15907 msg (if at "Creating image...%s"
15908 "Creating images for entry...%s"))))
15909 (message msg "")
15910 (narrow-to-region beg end)
15911 (goto-char beg)
15912 (org-format-latex
15913 (concat "ltxpng/" (file-name-sans-extension
15914 (file-name-nondirectory
15915 buffer-file-name)))
15916 default-directory 'overlays msg at 'forbuffer 'dvipng)
15917 (message msg "done. Use `C-c C-c' to remove images.")))))
15919 (defvar org-latex-regexps
15921 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
15924 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
15928 "Regular expressions for matching embedded LaTeX.")
15930 (defvar org-export-have-math nil) ;; dynamic scoping
15931 (defun org-format-latex (prefix &optional dir overlays msg at
15932 forbuffer processing-type)
15933 "Replace LaTeX fragments with links to an image, and produce images.
15934 Some of the options can be changed using the variable
15935 `org-format-latex-options'."
15936 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
15937 (let* ((prefixnodir (file-name-nondirectory prefix))
15938 (absprefix (expand-file-name prefix dir))
15939 (todir (file-name-directory absprefix))
15940 (opt org-format-latex-options)
15941 (matchers (plist-get opt :matchers))
15942 (re-list org-latex-regexps)
15943 (org-format-latex-header-extra
15944 (plist-get (org-infile-export-plist) :latex-header-extra))
15945 (cnt 0) txt hash link beg end re e checkdir
15946 executables-checked string
15947 m n block linkfile movefile ov)
15948 ;; Check the different regular expressions
15949 (while (setq e (pop re-list))
15950 (setq m (car e) re (nth 1 e) n (nth 2 e)
15952 (when (member m matchers)
15953 (goto-char (point-min))
15954 (while (re-search-forward re nil t)
15955 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
15956 (not (get-text-property (match-beginning n)
15957 'org-protected))
15958 (or (not overlays)
15959 (not (eq (get-char-property (match-beginning n)
15960 'org-overlay-type)
15961 'org-latex-overlay))))
15962 (setq org-export-have-math t)
15963 (cond
15964 ((eq processing-type 'verbatim)
15965 ;; Leave the text verbatim, just protect it
15966 (add-text-properties (match-beginning n) (match-end n)
15967 '(org-protected t)))
15968 ((eq processing-type 'mathjax)
15969 ;; Prepare for MathJax processing
15970 (setq string (match-string n))
15971 (if (member m '("$" "$1"))
15972 (save-excursion
15973 (delete-region (match-beginning n) (match-end n))
15974 (goto-char (match-beginning n))
15977 '(org-protected t))))
15978 (add-text-properties (match-beginning n) (match-end n)
15979 '(org-protected t))))
15980 ((or (eq processing-type 'dvipng) t)
15981 ;; Process to an image
15982 (setq txt (match-string n)
15983 beg (match-beginning n) end (match-end n)
15984 cnt (1+ cnt))
15985 (let (print-length print-level) ; make sure full list is printed
15986 (setq hash (sha1 (prin1-to-string
15987 (list org-format-latex-header
15988 org-format-latex-header-extra
15989 org-export-latex-default-packages-alist
15990 org-export-latex-packages-alist
15991 org-format-latex-options
15992 forbuffer txt)))
15993 linkfile (format "%s_%s.png" prefix hash)
15994 movefile (format "%s_%s.png" absprefix hash)))
15995 (setq link (concat block "[[file:" linkfile "]]" block))
15996 (if msg (message msg cnt))
15997 (goto-char beg)
15998 (unless checkdir ; make sure the directory exists
15999 (setq checkdir t)
16000 (or (file-directory-p todir) (make-directory todir t)))
16002 (unless executables-checked
16003 (org-check-external-command
16004 "latex" "needed to convert LaTeX fragments to images")
16005 (org-check-external-command
16006 "dvipng" "needed to convert LaTeX fragments to images")
16007 (setq executables-checked t))
16009 (unless (file-exists-p movefile)
16010 (org-create-formula-image
16011 txt movefile opt forbuffer))
16012 (if overlays
16013 (progn
16014 (mapc (lambda (o)
16015 (if (eq (overlay-get o 'org-overlay-type)
16016 'org-latex-overlay)
16017 (delete-overlay o)))
16018 (overlays-in beg end))
16019 (setq ov (make-overlay beg end))
16020 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16021 (if (featurep 'xemacs)
16022 (progn
16023 (overlay-put ov 'invisible t)
16024 (overlay-put
16025 ov 'end-glyph
16026 (make-glyph (vector 'png :file movefile))))
16027 (overlay-put
16028 ov 'display
16029 (list 'image :type 'png :file movefile :ascent 'center)))
16030 (push ov org-latex-fragment-image-overlays)
16031 (goto-char end))
16032 (delete-region beg end)
16033 (insert (org-add-props link
16034 (list 'org-latex-src
16035 (replace-regexp-in-string
16038 ;; This function borrows from Ganesh Swami's latex2png.el
16039 (defun org-create-formula-image (string tofile options buffer)
16040 "This calls dvipng."
16041 (require 'org-latex)
16042 (let* ((tmpdir (if (featurep 'xemacs)
16043 (temp-directory)
16044 temporary-file-directory))
16045 (texfilebase (make-temp-name
16046 (expand-file-name "orgtex" tmpdir)))
16047 (texfile (concat texfilebase ".tex"))
16048 (dvifile (concat texfilebase ".dvi"))
16049 (pngfile (concat texfilebase ".png"))
16050 (fnh (if (featurep 'xemacs)
16051 (font-height (get-face-font 'default))
16052 (face-attribute 'default :height nil)))
16053 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16054 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16055 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16056 "Black"))
16057 (bg (or (plist-get options (if buffer :background :html-background))
16058 "Transparent")))
16059 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16060 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16061 (with-temp-file texfile
16062 (insert (org-splice-latex-header
16063 org-format-latex-header
16064 org-export-latex-default-packages-alist
16065 org-export-latex-packages-alist t
16066 org-format-latex-header-extra))
16068 (require 'org-latex)
16069 (org-export-latex-fix-inputenc))
16070 (let ((dir default-directory))
16071 (condition-case nil
16072 (progn
16073 (cd tmpdir)
16074 (call-process "latex" nil nil nil texfile))
16075 (error nil))
16076 (cd dir))
16077 (if (not (file-exists-p dvifile))
16078 (progn (message "Failed to create dvi file from %s" texfile) nil)
16079 (condition-case nil
16080 (call-process "dvipng" nil nil nil
16081 "-fg" fg "-bg" bg
16082 "-D" dpi
16083 ;;"-x" scale "-y" scale
16084 "-T" "tight"
16085 "-o" pngfile
16086 dvifile)
16087 (error nil))
16088 (if (not (file-exists-p pngfile))
16089 (if org-format-latex-signal-error
16090 (error "Failed to create png file from %s" texfile)
16091 (message "Failed to create png file from %s" texfile)
16092 nil)
16093 ;; Use the requested file name and clean up
16094 (copy-file pngfile tofile 'replace)
16095 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16096 (delete-file (concat texfilebase e)))
16097 pngfile))))
16099 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16100 "Fill a LaTeX header template TPL.
16101 In the template, the following place holders will be recognized:
16104 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16106 [NO-PACKAGES] do not include PKG
16107 [EXTRA] the string EXTRA
16108 [NO-EXTRA] do not include EXTRA
16110 For backward compatibility, if both the positive and the negative place
16112 assumed to be present at the end of the template.
16113 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16114 EXTRA is a string.
16115 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16116 (let (rpl (end ""))
16118 (setq rpl (if (or (match-end 1) (not def-pkg))
16119 "" (org-latex-packages-to-string def-pkg snippets-p t))
16120 tpl (replace-match rpl t t tpl))
16121 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16124 (setq rpl (if (or (match-end 1) (not pkg))
16125 "" (org-latex-packages-to-string pkg snippets-p t))
16126 tpl (replace-match rpl t t tpl))
16127 (if pkg (setq end
16129 (org-latex-packages-to-string pkg snippets-p)))))
16132 (setq rpl (if (or (match-end 1) (not extra))
16134 tpl (replace-match rpl t t tpl))
16140 tpl)))
16142 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16144 (setq pkg (mapconcat (lambda(p)
16145 (cond
16146 ((stringp p) p)
16147 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16148 (format "%% Package %s omitted" (cadr p)))
16149 ((equal "" (car p))
16151 (t
16153 (car p) (cadr p)))))
16154 pkg
16158 (defun org-dvipng-color (attr)
16159 "Return an rgb color specification for dvipng."
16160 (apply 'format "rgb %s %s %s"
16161 (mapcar 'org-normalize-color
16162 (color-values (face-attribute 'default attr nil)))))
16164 (defun org-normalize-color (value)
16165 "Return string to be used as color value for an RGB component."
16166 (format "%g" (/ value 65535.0)))
16168 ;; Image display
16171 (defvar org-inline-image-overlays nil)
16172 (make-variable-buffer-local 'org-inline-image-overlays)
16174 (defun org-toggle-inline-images (&optional include-linked)
16175 "Toggle the display of inline images.
16176 INCLUDE-LINKED is passed to `org-display-inline-images'."
16177 (interactive "P")
16178 (if org-inline-image-overlays
16179 (progn
16180 (org-remove-inline-images)
16181 (message "Inline image display turned off"))
16182 (org-display-inline-images include-linked)
16183 (if org-inline-image-overlays
16184 (message "%d images displayed inline"
16185 (length org-inline-image-overlays))
16186 (message "No images to display inline"))))
16188 (defun org-display-inline-images (&optional include-linked refresh beg end)
16189 "Display inline images.
16190 Normally only links without a description part are inlined, because this
16191 is how it will work for export. When INCLUDE-LINKED is set, also links
16192 with a description part will be inlined. This can be nice for a quick
16193 look at those images, but it does not reflect what exported files will look
16194 like.
16195 When REFRESH is set, refresh existing images between BEG and END.
16196 This will create new image displays only if necessary.
16197 BEG and END default to the buffer boundaries."
16198 (interactive "P")
16199 (unless refresh
16200 (org-remove-inline-images)
16201 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16202 (save-excursion
16203 (save-restriction
16204 (widen)
16205 (setq beg (or beg (point-min)) end (or end (point-max)))
16206 (goto-char (point-min))
16208 (substring (org-image-file-name-regexp) 0 -2)
16210 old file ov img)
16211 (while (re-search-forward re end t)
16212 (setq old (get-char-property-and-overlay (match-beginning 1)
16213 'org-image-overlay))
16214 (setq file (expand-file-name
16215 (concat (or (match-string 3) "") (match-string 4))))
16216 (when (file-exists-p file)
16217 (if (and (car-safe old) refresh)
16218 (image-refresh (overlay-get (cdr old) 'display))
16219 (setq img (save-match-data (create-image file)))
16220 (when img
16221 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16222 (overlay-put ov 'display img)
16223 (overlay-put ov 'face 'default)
16224 (overlay-put ov 'org-image-overlay t)
16225 (overlay-put ov 'modification-hooks
16226 (list 'org-display-inline-modification-hook))
16227 (push ov org-inline-image-overlays)))))))))
16229 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16230 "Remove inline-display overlay if a corresponding region is modified."
16231 (let ((inhibit-modification-hooks t))
16232 (when (and ov after)
16233 (delete ov org-inline-image-overlays)
16234 (delete-overlay ov))))
16236 (defun org-remove-inline-images ()
16237 "Remove inline display of images."
16238 (interactive)
16239 (mapc 'delete-overlay org-inline-image-overlays)
16240 (setq org-inline-image-overlays nil))
16242 ;;;; Key bindings
16244 ;; Make `C-c C-x' a prefix key
16245 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16247 ;; TAB key with modifiers
16248 (org-defkey org-mode-map "\C-i" 'org-cycle)
16249 (org-defkey org-mode-map [(tab)] 'org-cycle)
16250 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16251 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16253 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16254 ;; The following line is necessary under Suse GNU/Linux
16255 (unless (featurep 'xemacs)
16256 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16257 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16258 (define-key org-mode-map [backtab] 'org-shifttab)
16260 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16261 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16262 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16264 ;; Cursor keys with modifiers
16265 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16266 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16267 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16268 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16270 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16271 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16272 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16273 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16275 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16276 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16277 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16278 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16280 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16281 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16283 ;; Babel keys
16284 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16285 (mapc (lambda (pair)
16286 (define-key org-babel-map (car pair) (cdr pair)))
16287 org-babel-key-bindings)
16289 ;;; Extra keys for tty access.
16290 ;; We only set them when really needed because otherwise the
16291 ;; menus don't show the simple keys
16293 (when (or org-use-extra-keys
16294 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16295 (not window-system))
16296 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16297 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16298 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16299 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16300 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16301 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16302 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16303 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16304 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16305 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16306 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16307 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16308 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16309 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16310 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16311 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16312 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16313 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16314 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16315 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16316 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16317 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16318 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16319 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16320 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16321 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16322 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16323 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16325 ;; All the other keys
16327 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16328 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16329 (if (boundp 'narrow-map)
16330 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16331 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16332 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16333 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16334 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16335 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16336 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16337 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16338 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16339 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16340 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16341 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16342 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16343 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16344 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16345 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16346 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16347 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16349 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16350 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16351 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16352 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16353 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16354 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16355 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16356 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16357 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16358 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16359 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16360 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16361 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16362 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16363 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16364 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16365 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16366 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16367 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16369 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16370 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16371 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16372 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16373 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16374 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16375 (org-defkey org-mode-map "\C-c^" 'org-sort)
16376 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16377 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16378 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16379 (org-defkey org-mode-map "\C-m" 'org-return)
16380 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16381 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16382 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16383 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16384 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16385 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16386 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16387 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16388 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16389 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16390 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16391 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16392 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16393 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16394 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16395 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16396 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16397 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16398 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16399 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16400 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16401 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16403 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16404 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16405 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16406 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16408 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16409 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16410 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16411 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16412 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16413 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16414 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16415 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16416 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16417 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16419 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16420 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16421 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16422 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16423 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16424 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16425 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16427 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16428 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16429 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16430 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16431 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16433 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16435 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16437 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16438 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16440 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16443 (when (featurep 'xemacs)
16444 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16447 (defconst org-speed-commands-default
16448 '(
16449 ("Outline Navigation")
16450 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16451 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16452 ("f" . (org-speed-move-safe 'org-forward-same-level))
16453 ("b" . (org-speed-move-safe 'org-backward-same-level))
16454 ("u" . (org-speed-move-safe 'outline-up-heading))
16455 ("j" . org-goto)
16456 ("g" . (org-refile t))
16457 ("Outline Visibility")
16458 ("c" . org-cycle)
16459 ("C" . org-shifttab)
16460 (" " . org-display-outline-path)
16461 ("Outline Structure Editing")
16462 ("U" . org-shiftmetaup)
16463 ("D" . org-shiftmetadown)
16464 ("r" . org-metaright)
16465 ("l" . org-metaleft)
16466 ("R" . org-shiftmetaright)
16467 ("L" . org-shiftmetaleft)
16468 ("i" . (progn (forward-char 1) (call-interactively
16469 'org-insert-heading-respect-content)))
16470 ("^" . org-sort)
16471 ("w" . org-refile)
16472 ("a" . org-archive-subtree-default-with-confirmation)
16473 ("." . org-mark-subtree)
16474 ("Clock Commands")
16475 ("I" . org-clock-in)
16476 ("O" . org-clock-out)
16477 ("Meta Data Editing")
16478 ("t" . org-todo)
16479 ("0" . (org-priority ?\ ))
16480 ("1" . (org-priority ?A))
16481 ("2" . (org-priority ?B))
16482 ("3" . (org-priority ?C))
16483 (";" . org-set-tags-command)
16484 ("e" . org-set-effort)
16485 ("Agenda Views etc")
16486 ("v" . org-agenda)
16487 ("/" . org-sparse-tree)
16488 ("Misc")
16489 ("o" . org-open-at-point)
16490 ("?" . org-speed-command-help)
16491 ("<" . (org-agenda-set-restriction-lock 'subtree))
16492 (">" . (org-agenda-remove-restriction-lock))
16493 )
16494 "The default speed commands.")
16496 (defun org-print-speed-command (e)
16497 (if (> (length (car e)) 1)
16498 (progn
16500 (princ (car e))
16502 (princ (make-string (length (car e)) ?-))
16504 (princ (car e))
16505 (princ " ")
16506 (if (symbolp (cdr e))
16507 (princ (symbol-name (cdr e)))
16508 (prin1 (cdr e)))
16511 (defun org-speed-command-help ()
16512 "Show the available speed commands."
16513 (interactive)
16514 (if (not org-use-speed-commands)
16515 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16516 (with-output-to-temp-buffer "*Help*"
16518 (mapc 'org-print-speed-command org-speed-commands-user)
16521 (mapc 'org-print-speed-command org-speed-commands-default))
16522 (with-current-buffer "*Help*"
16523 (setq truncate-lines t))))
16525 (defun org-speed-move-safe (cmd)
16526 "Execute CMD, but make sure that the cursor always ends up in a headline.
16527 If not, return to the original position and throw an error."
16528 (interactive)
16529 (let ((pos (point)))
16530 (call-interactively cmd)
16531 (unless (and (bolp) (org-on-heading-p))
16532 (goto-char pos)
16533 (error "Boundary reached while executing %s" cmd))))
16535 (defvar org-self-insert-command-undo-counter 0)
16537 (defvar org-table-auto-blank-field) ; defined in org-table.el
16538 (defvar org-speed-command nil)
16540 (defun org-speed-command-default-hook (keys)
16541 "Hook for activating single-letter speed commands.
16542 `org-speed-commands-default' specifies a minimal command set. Use
16543 `org-speed-commands-user' for further customization."
16544 (when (or (and (bolp) (looking-at outline-regexp))
16545 (and (functionp org-use-speed-commands)
16546 (funcall org-use-speed-commands)))
16547 (cdr (assoc keys (append org-speed-commands-user
16548 org-speed-commands-default)))))
16550 (defun org-babel-speed-command-hook (keys)
16551 "Hook for activating single-letter code block commands."
16552 (when (and (bolp) (looking-at org-babel-src-block-regexp))
16553 (cdr (assoc keys org-babel-key-bindings))))
16555 (defcustom org-speed-command-hook
16556 '(org-speed-command-default-hook org-babel-speed-command-hook)
16557 "Hook for activating speed commands at strategic locations.
16558 Hook functions are called in sequence until a valid handler is
16559 found.
16561 Each hook takes a single argument, a user-pressed command key
16562 which is also a `self-insert-command' from the global map.
16564 Within the hook, examine the cursor position and the command key
16565 and return nil or a valid handler as appropriate. Handler could
16566 be one of an interactive command, a function, or a form.
16568 Set `org-use-speed-commands' to non-nil value to enable this
16569 hook. The default setting is `org-speed-command-default-hook'."
16570 :group 'org-structure
16571 :type 'hook)
16573 (defun org-self-insert-command (N)
16574 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
16575 If the cursor is in a table looking at whitespace, the whitespace is
16576 overwritten, and the table is not marked as requiring realignment."
16577 (interactive "p")
16578 (cond
16579 ((and org-use-speed-commands
16580 (setq org-speed-command
16581 (run-hook-with-args-until-success
16582 'org-speed-command-hook (this-command-keys))))
16583 (cond
16584 ((commandp org-speed-command)
16585 (setq this-command org-speed-command)
16586 (call-interactively org-speed-command))
16587 ((functionp org-speed-command)
16588 (funcall org-speed-command))
16589 ((and org-speed-command (listp org-speed-command))
16590 (eval org-speed-command))
16591 (t (let (org-use-speed-commands)
16592 (call-interactively 'org-self-insert-command)))))
16593 ((and
16594 (org-table-p)
16595 (progn
16596 ;; check if we blank the field, and if that triggers align
16597 (and (featurep 'org-table) org-table-auto-blank-field
16598 (member last-command
16599 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
16601 ;; got extra space, this field does not determine column width
16602 (let (org-table-may-need-update) (org-table-blank-field))
16603 ;; no extra space, this field may determine column width
16604 (org-table-blank-field)))
16605 t)
16606 (eq N 1)
16608 (let (org-table-may-need-update)
16609 (goto-char (1- (match-end 0)))
16610 (delete-backward-char 1)
16611 (goto-char (match-beginning 0))
16612 (self-insert-command N)))
16613 (t
16614 (setq org-table-may-need-update t)
16615 (self-insert-command N)
16616 (org-fix-tags-on-the-fly)
16617 (if org-self-insert-cluster-for-undo
16618 (if (not (eq last-command 'org-self-insert-command))
16619 (setq org-self-insert-command-undo-counter 1)
16620 (if (>= org-self-insert-command-undo-counter 20)
16621 (setq org-self-insert-command-undo-counter 1)
16622 (and (> org-self-insert-command-undo-counter 0)
16623 buffer-undo-list
16624 (not (cadr buffer-undo-list)) ; remove nil entry
16625 (setcdr buffer-undo-list (cddr buffer-undo-list)))
16626 (setq org-self-insert-command-undo-counter
16627 (1+ org-self-insert-command-undo-counter))))))))
16629 (defun org-fix-tags-on-the-fly ()
16630 (when (and (equal (char-after (point-at-bol)) ?*)
16631 (org-on-heading-p))
16632 (org-align-tags-here org-tags-column)))
16634 (defun org-delete-backward-char (N)
16635 "Like `delete-backward-char', insert whitespace at field end in tables.
16636 When deleting backwards, in tables this function will insert whitespace in
16638 still be marked for re-alignment if the field did fill the entire column,
16639 because, in this case the deletion might narrow the column."
16640 (interactive "p")
16641 (if (and (org-table-p)
16642 (eq N 1)
16643 (string-match "|" (buffer-substring (point-at-bol) (point)))
16644 (looking-at ".*?|"))
16645 (let ((pos (point))
16647 (c org-table-may-need-update))
16648 (backward-delete-char N)
16649 (if (not overwrite-mode)
16650 (progn
16651 (skip-chars-forward "^|")
16652 (insert " ")
16653 (goto-char (1- pos))))
16654 ;; noalign: if there were two spaces at the end, this field
16655 ;; does not determine the width of the column.
16656 (if noalign (setq org-table-may-need-update c)))
16657 (backward-delete-char N)
16658 (org-fix-tags-on-the-fly)))
16660 (defun org-delete-char (N)
16661 "Like `delete-char', but insert whitespace at field end in tables.
16662 When deleting characters, in tables this function will insert whitespace in
16664 still be marked for re-alignment if the field did fill the entire column,
16665 because, in this case the deletion might narrow the column."
16666 (interactive "p")
16667 (if (and (org-table-p)
16668 (not (bolp))
16669 (not (= (char-after) ?|))
16670 (eq N 1))
16671 (if (looking-at ".*?|")
16672 (let ((pos (point))
16674 (c org-table-may-need-update))
16675 (replace-match (concat
16676 (substring (match-string 0) 1 -1)
16677 " |"))
16678 (goto-char pos)
16679 ;; noalign: if there were two spaces at the end, this field
16680 ;; does not determine the width of the column.
16681 (if noalign (setq org-table-may-need-update c)))
16682 (delete-char N))
16683 (delete-char N)
16684 (org-fix-tags-on-the-fly)))
16686 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
16687 (put 'org-self-insert-command 'delete-selection t)
16688 (put 'orgtbl-self-insert-command 'delete-selection t)
16689 (put 'org-delete-char 'delete-selection 'supersede)
16690 (put 'org-delete-backward-char 'delete-selection 'supersede)
16691 (put 'org-yank 'delete-selection 'yank)
16693 ;; Make `flyspell-mode' delay after some commands
16694 (put 'org-self-insert-command 'flyspell-delayed t)
16695 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
16696 (put 'org-delete-char 'flyspell-delayed t)
16697 (put 'org-delete-backward-char 'flyspell-delayed t)
16699 ;; Make pabbrev-mode expand after org-mode commands
16700 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
16701 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
16703 ;; How to do this: Measure non-white length of current string
16704 ;; If equal to column width, we should realign.
16706 (defun org-remap (map &rest commands)
16707 "In MAP, remap the functions given in COMMANDS.
16708 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
16709 (let (new old)
16710 (while commands
16711 (setq old (pop commands) new (pop commands))
16712 (if (fboundp 'command-remapping)
16713 (org-defkey map (vector 'remap old) new)
16714 (substitute-key-definition old new map global-map)))))
16716 (when (eq org-enable-table-editor 'optimized)
16717 ;; If the user wants maximum table support, we need to hijack
16718 ;; some standard editing functions
16719 (org-remap org-mode-map
16720 'self-insert-command 'org-self-insert-command
16721 'delete-char 'org-delete-char
16722 'delete-backward-char 'org-delete-backward-char)
16723 (org-defkey org-mode-map "|" 'org-force-self-insert))
16725 (defvar org-ctrl-c-ctrl-c-hook nil
16726 "Hook for functions attaching themselves to `C-c C-c'.
16727 This can be used to add additional functionality to the C-c C-c key which
16728 executes context-dependent commands.
16729 Each function will be called with no arguments. The function must check
16730 if the context is appropriate for it to act. If yes, it should do its
16731 thing and then return a non-nil value. If the context is wrong,
16732 just do nothing and return nil.")
16734 (defvar org-tab-first-hook nil
16735 "Hook for functions to attach themselves to TAB.
16736 See `org-ctrl-c-ctrl-c-hook' for more information.
16737 This hook runs as the first action when TAB is pressed, even before
16738 `org-cycle' messes around with the `outline-regexp' to cater for
16739 inline tasks and plain list item folding.
16740 If any function in this hook returns t, any other actions that
16741 would have been caused by TAB (such as table field motion or visibility
16742 cycling) will not occur.")
16744 (defvar org-tab-after-check-for-table-hook nil
16745 "Hook for functions to attach themselves to TAB.
16746 See `org-ctrl-c-ctrl-c-hook' for more information.
16747 This hook runs after it has been established that the cursor is not in a
16748 table, but before checking if the cursor is in a headline or if global cycling
16749 should be done.
16750 If any function in this hook returns t, not other actions like visibility
16751 cycling will be done.")
16753 (defvar org-tab-after-check-for-cycling-hook nil
16754 "Hook for functions to attach themselves to TAB.
16755 See `org-ctrl-c-ctrl-c-hook' for more information.
16756 This hook runs after it has been established that not table field motion and
16757 not visibility should be done because of current context. This is probably
16758 the place where a package like yasnippets can hook in.")
16760 (defvar org-tab-before-tab-emulation-hook nil
16761 "Hook for functions to attach themselves to TAB.
16762 See `org-ctrl-c-ctrl-c-hook' for more information.
16763 This hook runs after every other options for TAB have been exhausted, but
16766 (defvar org-metaleft-hook nil
16767 "Hook for functions attaching themselves to `M-left'.
16768 See `org-ctrl-c-ctrl-c-hook' for more information.")
16769 (defvar org-metaright-hook nil
16770 "Hook for functions attaching themselves to `M-right'.
16771 See `org-ctrl-c-ctrl-c-hook' for more information.")
16772 (defvar org-metaup-hook nil
16773 "Hook for functions attaching themselves to `M-up'.
16774 See `org-ctrl-c-ctrl-c-hook' for more information.")
16775 (defvar org-metadown-hook nil
16776 "Hook for functions attaching themselves to `M-down'.
16777 See `org-ctrl-c-ctrl-c-hook' for more information.")
16778 (defvar org-shiftmetaleft-hook nil
16779 "Hook for functions attaching themselves to `M-S-left'.
16780 See `org-ctrl-c-ctrl-c-hook' for more information.")
16781 (defvar org-shiftmetaright-hook nil
16782 "Hook for functions attaching themselves to `M-S-right'.
16783 See `org-ctrl-c-ctrl-c-hook' for more information.")
16784 (defvar org-shiftmetaup-hook nil
16785 "Hook for functions attaching themselves to `M-S-up'.
16786 See `org-ctrl-c-ctrl-c-hook' for more information.")
16787 (defvar org-shiftmetadown-hook nil
16788 "Hook for functions attaching themselves to `M-S-down'.
16789 See `org-ctrl-c-ctrl-c-hook' for more information.")
16790 (defvar org-metareturn-hook nil
16791 "Hook for functions attaching themselves to `M-RET'.
16792 See `org-ctrl-c-ctrl-c-hook' for more information.")
16793 (defvar org-shiftup-hook nil
16794 "Hook for functions attaching themselves to `S-up'.
16795 See `org-ctrl-c-ctrl-c-hook' for more information.")
16796 (defvar org-shiftup-final-hook nil
16797 "Hook for functions attaching themselves to `S-up'.
16798 This one runs after all other options except shift-select have been excluded.
16799 See `org-ctrl-c-ctrl-c-hook' for more information.")
16800 (defvar org-shiftdown-hook nil
16801 "Hook for functions attaching themselves to `S-down'.
16802 See `org-ctrl-c-ctrl-c-hook' for more information.")
16803 (defvar org-shiftdown-final-hook nil
16804 "Hook for functions attaching themselves to `S-down'.
16805 This one runs after all other options except shift-select have been excluded.
16806 See `org-ctrl-c-ctrl-c-hook' for more information.")
16807 (defvar org-shiftleft-hook nil
16808 "Hook for functions attaching themselves to `S-left'.
16809 See `org-ctrl-c-ctrl-c-hook' for more information.")
16810 (defvar org-shiftleft-final-hook nil
16811 "Hook for functions attaching themselves to `S-left'.
16812 This one runs after all other options except shift-select have been excluded.
16813 See `org-ctrl-c-ctrl-c-hook' for more information.")
16814 (defvar org-shiftright-hook nil
16815 "Hook for functions attaching themselves to `S-right'.
16816 See `org-ctrl-c-ctrl-c-hook' for more information.")
16817 (defvar org-shiftright-final-hook nil
16818 "Hook for functions attaching themselves to `S-right'.
16819 This one runs after all other options except shift-select have been excluded.
16820 See `org-ctrl-c-ctrl-c-hook' for more information.")
16822 (defun org-modifier-cursor-error ()
16823 "Throw an error, a modified cursor command was applied in wrong context."
16824 (error "This command is active in special context like tables, headlines or items"))
16826 (defun org-shiftselect-error ()
16827 "Throw an error because Shift-Cursor command was applied in wrong context."
16828 (if (and (boundp 'shift-select-mode) shift-select-mode)
16829 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
16830 (error "This command works only in special context like headlines or timestamps")))
16832 (defun org-call-for-shift-select (cmd)
16833 (let ((this-command-keys-shift-translated t))
16834 (call-interactively cmd)))
16836 (defun org-shifttab (&optional arg)
16837 "Global visibility cycling or move to previous table field.
16838 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
16839 on context.
16840 See the individual commands for more information."
16841 (interactive "P")
16842 (cond
16843 ((org-at-table-p) (call-interactively 'org-table-previous-field))
16844 ((integerp arg)
16845 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
16846 (message "Content view to level: %d" arg)
16847 (org-content (prefix-numeric-value arg2))
16848 (setq org-cycle-global-status 'overview)))
16849 (t (call-interactively 'org-global-cycle))))
16851 (defun org-shiftmetaleft ()
16852 "Promote subtree or delete table column.
16853 Calls `org-promote-subtree', `org-outdent-item',
16854 or `org-table-delete-column', depending on context.
16855 See the individual commands for more information."
16856 (interactive)
16857 (cond
16858 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
16859 ((org-at-table-p) (call-interactively 'org-table-delete-column))
16860 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
16861 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
16862 (t (org-modifier-cursor-error))))
16864 (defun org-shiftmetaright ()
16865 "Demote subtree or insert table column.
16866 Calls `org-demote-subtree', `org-indent-item',
16867 or `org-table-insert-column', depending on context.
16868 See the individual commands for more information."
16869 (interactive)
16870 (cond
16871 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
16872 ((org-at-table-p) (call-interactively 'org-table-insert-column))
16873 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
16874 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
16875 (t (org-modifier-cursor-error))))
16877 (defun org-shiftmetaup (&optional arg)
16878 "Move subtree up or kill table row.
16879 Calls `org-move-subtree-up' or `org-table-kill-row' or
16880 `org-move-item-up' depending on context. See the individual commands
16881 for more information."
16882 (interactive "P")
16883 (cond
16884 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
16885 ((org-at-table-p) (call-interactively 'org-table-kill-row))
16886 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16887 ((org-at-item-p) (call-interactively 'org-move-item-up))
16888 (t (org-modifier-cursor-error))))
16890 (defun org-shiftmetadown (&optional arg)
16891 "Move subtree down or insert table row.
16892 Calls `org-move-subtree-down' or `org-table-insert-row' or
16893 `org-move-item-down', depending on context. See the individual
16894 commands for more information."
16895 (interactive "P")
16896 (cond
16897 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
16898 ((org-at-table-p) (call-interactively 'org-table-insert-row))
16899 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16900 ((org-at-item-p) (call-interactively 'org-move-item-down))
16901 (t (org-modifier-cursor-error))))
16903 (defsubst org-hidden-tree-error ()
16904 (error
16905 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
16907 (defun org-metaleft (&optional arg)
16908 "Promote heading or move table column to left.
16909 Calls `org-do-promote' or `org-table-move-column', depending on context.
16910 With no specific context, calls the Emacs default `backward-word'.
16911 See the individual commands for more information."
16912 (interactive "P")
16913 (cond
16914 ((run-hook-with-args-until-success 'org-metaleft-hook))
16915 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
16916 ((or (org-on-heading-p)
16917 (and (org-region-active-p)
16918 (save-excursion
16919 (goto-char (region-beginning))
16920 (org-on-heading-p))))
16921 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16922 (call-interactively 'org-do-promote))
16923 ((or (org-at-item-p)
16924 (and (org-region-active-p)
16925 (save-excursion
16926 (goto-char (region-beginning))
16927 (org-at-item-p))))
16928 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16929 (call-interactively 'org-outdent-item))
16930 (t (call-interactively 'backward-word))))
16932 (defun org-metaright (&optional arg)
16933 "Demote subtree or move table column to right.
16934 Calls `org-do-demote' or `org-table-move-column', depending on context.
16935 With no specific context, calls the Emacs default `forward-word'.
16936 See the individual commands for more information."
16937 (interactive "P")
16938 (cond
16939 ((run-hook-with-args-until-success 'org-metaright-hook))
16940 ((org-at-table-p) (call-interactively 'org-table-move-column))
16941 ((or (org-on-heading-p)
16942 (and (org-region-active-p)
16943 (save-excursion
16944 (goto-char (region-beginning))
16945 (org-on-heading-p))))
16946 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16947 (call-interactively 'org-do-demote))
16948 ((or (org-at-item-p)
16949 (and (org-region-active-p)
16950 (save-excursion
16951 (goto-char (region-beginning))
16952 (org-at-item-p))))
16953 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16954 (call-interactively 'org-indent-item))
16955 (t (call-interactively 'forward-word))))
16957 (defun org-check-for-hidden (what)
16958 "Check if there are hidden headlines/items in the current visual line.
16959 WHAT can be either `headlines' or `items'. If the current line is
16960 an outline or item heading and it has a folded subtree below it,
16961 this function returns t, nil otherwise."
16962 (let ((re (cond
16963 ((eq what 'headlines) (concat "^" org-outline-regexp))
16964 ((eq what 'items) (concat "^" (org-item-re t)))
16965 (t (error "This should not happen"))))
16966 beg end)
16967 (save-excursion
16968 (catch 'exit
16969 (unless (org-region-active-p)
16970 (setq beg (point-at-bol))
16971 (beginning-of-line 2)
16972 (while (and (not (eobp)) ;; this is like `next-line'
16973 (get-char-property (1- (point)) 'invisible))
16974 (beginning-of-line 2))
16975 (setq end (point))
16976 (goto-char beg)
16977 (goto-char (point-at-eol))
16978 (setq end (max end (point)))
16979 (while (re-search-forward re end t)
16980 (if (get-char-property (match-beginning 0) 'invisible)
16981 (throw 'exit t))))
16982 nil))))
16984 (defun org-metaup (&optional arg)
16985 "Move subtree up or move table row up.
16986 Calls `org-move-subtree-up' or `org-table-move-row' or
16987 `org-move-item-up', depending on context. See the individual commands
16988 for more information."
16989 (interactive "P")
16990 (cond
16991 ((run-hook-with-args-until-success 'org-metaup-hook))
16992 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
16993 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16994 ((org-at-item-p) (call-interactively 'org-move-item-up))
16995 (t (transpose-lines 1) (beginning-of-line -1))))
16997 (defun org-metadown (&optional arg)
16998 "Move subtree down or move table row down.
16999 Calls `org-move-subtree-down' or `org-table-move-row' or
17000 `org-move-item-down', depending on context. See the individual
17001 commands for more information."
17002 (interactive "P")
17003 (cond
17004 ((run-hook-with-args-until-success 'org-metadown-hook))
17005 ((org-at-table-p) (call-interactively 'org-table-move-row))
17006 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17007 ((org-at-item-p) (call-interactively 'org-move-item-down))
17008 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17010 (defun org-shiftup (&optional arg)
17011 "Increase item in timestamp or increase priority of current headline.
17012 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17013 depending on context. See the individual commands for more information."
17014 (interactive "P")
17015 (cond
17016 ((run-hook-with-args-until-success 'org-shiftup-hook))
17017 ((and org-support-shift-select (org-region-active-p))
17018 (org-call-for-shift-select 'previous-line))
17019 ((org-at-timestamp-p t)
17020 (call-interactively (if org-edit-timestamp-down-means-later
17021 'org-timestamp-down 'org-timestamp-up)))
17022 ((and (not (eq org-support-shift-select 'always))
17023 org-enable-priority-commands
17024 (org-on-heading-p))
17025 (call-interactively 'org-priority-up))
17026 ((and (not org-support-shift-select) (org-at-item-p))
17027 (call-interactively 'org-previous-item))
17028 ((org-clocktable-try-shift 'up arg))
17029 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17030 (org-support-shift-select
17031 (org-call-for-shift-select 'previous-line))
17032 (t (org-shiftselect-error))))
17034 (defun org-shiftdown (&optional arg)
17035 "Decrease item in timestamp or decrease priority of current headline.
17036 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17037 depending on context. See the individual commands for more information."
17038 (interactive "P")
17039 (cond
17040 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17041 ((and org-support-shift-select (org-region-active-p))
17042 (org-call-for-shift-select 'next-line))
17043 ((org-at-timestamp-p t)
17044 (call-interactively (if org-edit-timestamp-down-means-later
17045 'org-timestamp-up 'org-timestamp-down)))
17046 ((and (not (eq org-support-shift-select 'always))
17047 org-enable-priority-commands
17048 (org-on-heading-p))
17049 (call-interactively 'org-priority-down))
17050 ((and (not org-support-shift-select) (org-at-item-p))
17051 (call-interactively 'org-next-item))
17052 ((org-clocktable-try-shift 'down arg))
17053 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17054 (org-support-shift-select
17055 (org-call-for-shift-select 'next-line))
17056 (t (org-shiftselect-error))))
17058 (defun org-shiftright (&optional arg)
17059 "Cycle the thing at point or in the current line, depending on context.
17060 Depending on context, this does one of the following:
17062 - switch a timestamp at point one day into the future
17063 - on a headline, switch to the next TODO keyword.
17064 - on an item, switch entire list to the next bullet type
17065 - on a property line, switch to the next allowed value
17066 - on a clocktable definition line, move time block into the future"
17067 (interactive "P")
17068 (cond
17069 ((run-hook-with-args-until-success 'org-shiftright-hook))
17070 ((and org-support-shift-select (org-region-active-p))
17071 (org-call-for-shift-select 'forward-char))
17072 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17073 ((and (not (eq org-support-shift-select 'always))
17074 (org-on-heading-p))
17075 (let ((org-inhibit-logging
17076 (not org-treat-S-cursor-todo-selection-as-state-change))
17077 (org-inhibit-blocking
17078 (not org-treat-S-cursor-todo-selection-as-state-change)))
17079 (org-call-with-arg 'org-todo 'right)))
17080 ((or (and org-support-shift-select
17081 (not (eq org-support-shift-select 'always))
17082 (org-at-item-bullet-p))
17083 (and (not org-support-shift-select) (org-at-item-p)))
17084 (org-call-with-arg 'org-cycle-list-bullet nil))
17085 ((and (not (eq org-support-shift-select 'always))
17086 (org-at-property-p))
17087 (call-interactively 'org-property-next-allowed-value))
17088 ((org-clocktable-try-shift 'right arg))
17089 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17090 (org-support-shift-select
17091 (org-call-for-shift-select 'forward-char))
17092 (t (org-shiftselect-error))))
17094 (defun org-shiftleft (&optional arg)
17095 "Cycle the thing at point or in the current line, depending on context.
17096 Depending on context, this does one of the following:
17098 - switch a timestamp at point one day into the past
17099 - on a headline, switch to the previous TODO keyword.
17100 - on an item, switch entire list to the previous bullet type
17101 - on a property line, switch to the previous allowed value
17102 - on a clocktable definition line, move time block into the past"
17103 (interactive "P")
17104 (cond
17105 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17106 ((and org-support-shift-select (org-region-active-p))
17107 (org-call-for-shift-select 'backward-char))
17108 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17109 ((and (not (eq org-support-shift-select 'always))
17110 (org-on-heading-p))
17111 (let ((org-inhibit-logging
17112 (not org-treat-S-cursor-todo-selection-as-state-change))
17113 (org-inhibit-blocking
17114 (not org-treat-S-cursor-todo-selection-as-state-change)))
17115 (org-call-with-arg 'org-todo 'left)))
17116 ((or (and org-support-shift-select
17117 (not (eq org-support-shift-select 'always))
17118 (org-at-item-bullet-p))
17119 (and (not org-support-shift-select) (org-at-item-p)))
17120 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17121 ((and (not (eq org-support-shift-select 'always))
17122 (org-at-property-p))
17123 (call-interactively 'org-property-previous-allowed-value))
17124 ((org-clocktable-try-shift 'left arg))
17125 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17126 (org-support-shift-select
17127 (org-call-for-shift-select 'backward-char))
17128 (t (org-shiftselect-error))))
17130 (defun org-shiftcontrolright ()
17131 "Switch to next TODO set."
17132 (interactive)
17133 (cond
17134 ((and org-support-shift-select (org-region-active-p))
17135 (org-call-for-shift-select 'forward-word))
17136 ((and (not (eq org-support-shift-select 'always))
17137 (org-on-heading-p))
17138 (org-call-with-arg 'org-todo 'nextset))
17139 (org-support-shift-select
17140 (org-call-for-shift-select 'forward-word))
17141 (t (org-shiftselect-error))))
17143 (defun org-shiftcontrolleft ()
17144 "Switch to previous TODO set."
17145 (interactive)
17146 (cond
17147 ((and org-support-shift-select (org-region-active-p))
17148 (org-call-for-shift-select 'backward-word))
17149 ((and (not (eq org-support-shift-select 'always))
17150 (org-on-heading-p))
17151 (org-call-with-arg 'org-todo 'previousset))
17152 (org-support-shift-select
17153 (org-call-for-shift-select 'backward-word))
17154 (t (org-shiftselect-error))))
17156 (defun org-ctrl-c-ret ()
17157 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17158 (interactive)
17159 (cond
17160 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17161 (t (call-interactively 'org-insert-heading))))
17163 (defun org-copy-special ()
17164 "Copy region in table or copy current subtree.
17165 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17166 See the individual commands for more information."
17167 (interactive)
17168 (call-interactively
17169 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17171 (defun org-cut-special ()
17172 "Cut region in table or cut current subtree.
17173 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17174 See the individual commands for more information."
17175 (interactive)
17176 (call-interactively
17177 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17179 (defun org-paste-special (arg)
17180 "Paste rectangular region into table, or past subtree relative to level.
17181 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17182 See the individual commands for more information."
17183 (interactive "P")
17184 (if (org-at-table-p)
17185 (org-table-paste-rectangle)
17186 (org-paste-subtree arg)))
17188 (defun org-edit-special (&optional arg)
17189 "Call a special editor for the stuff at point.
17190 When at a table, call the formula editor with `org-table-edit-formulas'.
17191 When at the first line of an src example, call `org-edit-src-code'.
17192 When in an #+include line, visit the include file. Otherwise call
17193 `ffap' to visit the file at point."
17194 (interactive)
17195 ;; possibly prep session before editing source
17196 (when arg
17197 (let* ((info (org-babel-get-src-block-info))
17198 (lang (nth 0 info))
17199 (params (nth 2 info))
17200 (session (cdr (assoc :session params))))
17201 (when (and info session) ;; we are in a source-code block with a session
17202 (funcall
17203 (intern (concat "org-babel-prep-session:" lang)) session params))))
17204 (cond ;; proceed with `org-edit-special'
17205 ((save-excursion
17206 (beginning-of-line 1)
17207 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17208 (find-file (org-trim (match-string 1))))
17209 ((org-edit-src-code))
17210 ((org-edit-fixed-width-region))
17211 ((org-at-table.el-p)
17212 (org-edit-src-code))
17213 ((or (org-at-table-p)
17214 (save-excursion
17215 (beginning-of-line 1)
17217 (call-interactively 'org-table-edit-formulas))
17218 (t (call-interactively 'ffap))))
17220 (defun org-ctrl-c-ctrl-c (&optional arg)
17221 "Set tags in headline, or update according to changed information at point.
17223 This command does many different things, depending on context:
17225 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17226 this is what we do.
17228 - If the cursor is on a statistics cookie, update it.
17230 - If the cursor is in a headline, prompt for tags and insert them
17231 into the current line, aligned to `org-tags-column'. When called
17232 with prefix arg, realign all tags in the current buffer.
17234 - If the cursor is in one of the special #+KEYWORD lines, this
17235 triggers scanning the buffer for these lines and updating the
17236 information.
17238 - If the cursor is inside a table, realign the table. This command
17239 works even if the automatic table editor has been turned off.
17241 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17242 the entire table.
17244 - If the cursor is at a footnote reference or definition, jump to
17245 the corresponding definition or references, respectively.
17247 - If the cursor is a the beginning of a dynamic block, update it.
17249 - If the current buffer is a capture buffer, close note and file it.
17251 - If the cursor is on a <<<target>>>, update radio targets and
17252 corresponding links in this buffer.
17254 - If the cursor is on a numbered item in a plain list, renumber the
17255 ordered list.
17257 - If the cursor is on a checkbox, toggle it.
17259 - If the cursor is on a code block, evaluate it. The variable
17260 `org-confirm-babel-evaluate' can be used to control prompting
17261 before code block evaluation, by default every code block
17262 evaluation requires confirmation. Code block evaluation can be
17263 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17264 (interactive "P")
17265 (let ((org-enable-table-editor t))
17266 (cond
17267 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17268 org-occur-highlights
17269 org-latex-fragment-image-overlays)
17270 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17271 (org-remove-occur-highlights)
17272 (org-remove-latex-fragment-image-overlays)
17273 (message "Temporary highlights/overlays removed from current buffer"))
17274 ((and (local-variable-p 'org-finish-function (current-buffer))
17275 (fboundp org-finish-function))
17276 (funcall org-finish-function))
17277 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17278 ((or (looking-at org-property-start-re)
17279 (org-at-property-p))
17280 (call-interactively 'org-property-action))
17281 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17283 (or (org-on-heading-p) (org-at-item-p)))
17284 (call-interactively 'org-update-statistics-cookies))
17285 ((org-on-heading-p) (call-interactively 'org-set-tags))
17286 ((org-at-table.el-p)
17287 (message "Use C-c ' to edit table.el tables"))
17288 ((org-at-table-p)
17289 (org-table-maybe-eval-formula)
17290 (if arg
17291 (call-interactively 'org-table-recalculate)
17292 (org-table-maybe-recalculate-line))
17293 (call-interactively 'org-table-align)
17294 (orgtbl-send-table 'maybe))
17295 ((or (org-footnote-at-reference-p)
17296 (org-footnote-at-definition-p))
17297 (call-interactively 'org-footnote-action))
17298 ((org-at-item-checkbox-p)
17299 (call-interactively 'org-list-repair)
17300 (call-interactively 'org-toggle-checkbox)
17301 (org-list-send-list 'maybe))
17302 ((org-at-item-p)
17303 (call-interactively 'org-list-repair)
17304 (when arg (call-interactively 'org-toggle-checkbox))
17305 (org-list-send-list 'maybe))
17306 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17307 ;; Dynamic block
17308 (beginning-of-line 1)
17309 (save-excursion (org-update-dblock)))
17310 ((save-excursion
17311 (beginning-of-line 1)
17313 (cond
17314 ((equal (match-string 1) "TBLFM")
17315 ;; Recalculate the table before this line
17316 (save-excursion
17317 (beginning-of-line 1)
17319 (if (org-at-table-p)
17320 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17321 (t
17322 (let ((org-inhibit-startup-visibility-stuff t)
17323 (org-startup-align-all-tables nil))
17324 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17325 (message "Local setup has been refreshed"))))
17326 ((org-clock-update-time-maybe))
17327 (t (error "C-c C-c can do nothing useful at this location")))))
17329 (defun org-mode-restart ()
17330 "Restart Org-mode, to scan again for special lines.
17331 Also updates the keyword regular expressions."
17332 (interactive)
17333 (org-mode)
17334 (message "Org-mode restarted"))
17336 (defun org-kill-note-or-show-branches ()
17337 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17338 (interactive)
17339 (if (not org-finish-function)
17340 (progn
17341 (hide-subtree)
17342 (call-interactively 'show-branches))
17343 (let ((org-note-abort t))
17344 (funcall org-finish-function))))
17346 (defun org-return (&optional indent)
17347 "Goto next table row or insert a newline.
17348 Calls `org-table-next-row' or `newline', depending on context.
17349 See the individual commands for more information."
17350 (interactive)
17351 (cond
17352 ((bobp) (if indent (newline-and-indent) (newline)))
17353 ((org-at-table-p)
17354 (org-table-justify-field-maybe)
17355 (call-interactively 'org-table-next-row))
17356 ((and org-return-follows-link
17357 (eq (get-text-property (point) 'face) 'org-link))
17358 (call-interactively 'org-open-at-point))
17359 ((and (org-at-heading-p)
17360 (looking-at
17362 (org-show-entry)
17363 (end-of-line 1)
17364 (newline))
17365 (t (if indent (newline-and-indent) (newline)))))
17367 (defun org-return-indent ()
17368 "Goto next table row or insert a newline and indent.
17369 Calls `org-table-next-row' or `newline-and-indent', depending on
17370 context. See the individual commands for more information."
17371 (interactive)
17372 (org-return t))
17374 (defun org-ctrl-c-star ()
17375 "Compute table, or change heading status of lines.
17376 Calls `org-table-recalculate' or `org-toggle-heading',
17377 depending on context."
17378 (interactive)
17379 (cond
17380 ((org-at-table-p)
17381 (call-interactively 'org-table-recalculate))
17382 (t
17383 ;; Convert all lines in region to list items
17384 (call-interactively 'org-toggle-heading))))
17386 (defun org-ctrl-c-minus ()
17387 "Insert separator line in table or modify bullet status of line.
17388 Also turns a plain line or a region of lines into list items.
17389 Calls `org-table-insert-hline', `org-toggle-item', or
17390 `org-cycle-list-bullet', depending on context."
17391 (interactive)
17392 (cond
17393 ((org-at-table-p)
17394 (call-interactively 'org-table-insert-hline))
17395 ((org-region-active-p)
17396 (call-interactively 'org-toggle-item))
17397 ((org-in-item-p)
17398 (call-interactively 'org-cycle-list-bullet))
17399 (t
17400 (call-interactively 'org-toggle-item))))
17402 (defun org-toggle-item ()
17403 "Convert headings or normal lines to items, items to normal lines.
17404 If there is no active region, only the current line is considered.
17406 If the first line in the region is a headline, convert all headlines to items.
17408 If the first line in the region is an item, convert all items to normal lines.
17410 If the first line is normal text, add an item bullet to each line."
17411 (interactive)
17412 (let (l2 l beg end)
17413 (if (org-region-active-p)
17414 (setq beg (region-beginning) end (region-end))
17415 (setq beg (point-at-bol)
17416 end (min (1+ (point-at-eol)) (point-max))))
17417 (save-excursion
17418 (goto-char end)
17419 (setq l2 (org-current-line))
17420 (goto-char beg)
17421 (beginning-of-line 1)
17422 (setq l (1- (org-current-line)))
17423 (if (org-at-item-p)
17424 ;; We already have items, de-itemize
17425 (while (< (setq l (1+ l)) l2)
17426 (when (org-at-item-p)
17428 (delete-region (point) (match-end 0)))
17429 (beginning-of-line 2))
17430 (if (org-on-heading-p)
17431 ;; Headings, convert to items
17432 (while (< (setq l (1+ l)) l2)
17433 (if (looking-at org-outline-regexp)
17434 (replace-match (org-list-bullet-string "-") t t))
17435 (beginning-of-line 2))
17436 ;; normal lines, turn them into items
17437 (while (< (setq l (1+ l)) l2)
17438 (unless (org-at-item-p)
17440 (replace-match
17442 (beginning-of-line 2)))))))
17444 (defun org-toggle-heading (&optional nstars)
17445 "Convert headings to normal text, or items or text to headings.
17446 If there is no active region, only the current line is considered.
17448 If the first line is a heading, remove the stars from all headlines
17449 in the region.
17451 If the first line is a plain list item, turn all plain list items
17452 into headings.
17454 If the first line is a normal line, turn each and every line in the
17455 region into a heading.
17457 When converting a line into a heading, the number of stars is chosen
17458 such that the lines become children of the current entry. However,
17459 when a prefix argument is given, its value determines the number of
17460 stars to add."
17461 (interactive "P")
17462 (let (l2 l itemp beg end)
17463 (if (org-region-active-p)
17464 (setq beg (region-beginning) end (region-end))
17465 (setq beg (point-at-bol)
17466 end (min (1+ (point-at-eol)) (point-max))))
17467 (save-excursion
17468 (goto-char end)
17469 (setq l2 (org-current-line))
17470 (goto-char beg)
17471 (beginning-of-line 1)
17472 (setq l (1- (org-current-line)))
17473 (if (org-on-heading-p)
17474 ;; We already have headlines, de-star them
17475 (while (< (setq l (1+ l)) l2)
17476 (when (org-on-heading-p t)
17477 (and (looking-at outline-regexp) (replace-match "")))
17478 (beginning-of-line 2))
17479 (setq itemp (org-at-item-p))
17480 (let* ((stars
17481 (if nstars
17482 (make-string (prefix-numeric-value current-prefix-arg)
17483 ?*)
17484 (save-excursion
17485 (if (re-search-backward org-complex-heading-regexp nil t)
17486 (match-string 1) ""))))
17487 (add-stars (cond (nstars "")
17488 ((equal stars "") "*")
17489 (org-odd-levels-only "**")
17490 (t "*")))
17491 (rpl (concat stars add-stars " ")))
17492 (while (< (setq l (1+ l)) l2)
17493 (if itemp
17494 (and (org-at-item-p) (replace-match rpl t t))
17495 (unless (org-on-heading-p)
17497 (replace-match (concat rpl (match-string 2))))))
17498 (beginning-of-line 2)))))))
17500 (defun org-meta-return (&optional arg)
17501 "Insert a new heading or wrap a region in a table.
17502 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17503 See the individual commands for more information."
17504 (interactive "P")
17505 (cond
17506 ((run-hook-with-args-until-success 'org-metareturn-hook))
17507 ((org-at-table-p)
17508 (call-interactively 'org-table-wrap-region))
17509 (t (call-interactively 'org-insert-heading))))
17511 ;;; Menu entries
17513 ;; Define the Org-mode menus
17514 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
17515 '("Tbl"
17516 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
17517 ["Next Field" org-cycle (org-at-table-p)]
17518 ["Previous Field" org-shifttab (org-at-table-p)]
17519 ["Next Row" org-return (org-at-table-p)]
17520 "--"
17521 ["Blank Field" org-table-blank-field (org-at-table-p)]
17522 ["Edit Field" org-table-edit-field (org-at-table-p)]
17523 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
17524 "--"
17525 ("Column"
17526 ["Move Column Left" org-metaleft (org-at-table-p)]
17527 ["Move Column Right" org-metaright (org-at-table-p)]
17528 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
17529 ["Insert Column" org-shiftmetaright (org-at-table-p)])
17530 ("Row"
17531 ["Move Row Up" org-metaup (org-at-table-p)]
17532 ["Move Row Down" org-metadown (org-at-table-p)]
17533 ["Delete Row" org-shiftmetaup (org-at-table-p)]
17534 ["Insert Row" org-shiftmetadown (org-at-table-p)]
17535 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
17536 "--"
17537 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
17538 ("Rectangle"
17539 ["Copy Rectangle" org-copy-special (org-at-table-p)]
17540 ["Cut Rectangle" org-cut-special (org-at-table-p)]
17541 ["Paste Rectangle" org-paste-special (org-at-table-p)]
17542 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
17543 "--"
17544 ("Calculate"
17545 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
17546 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17547 ["Edit Formulas" org-edit-special (org-at-table-p)]
17548 "--"
17549 ["Recalculate line" org-table-recalculate (org-at-table-p)]
17550 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17551 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
17552 "--"
17553 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
17554 "--"
17555 ["Sum Column/Rectangle" org-table-sum
17556 (or (org-at-table-p) (org-region-active-p))]
17557 ["Which Column?" org-table-current-column (org-at-table-p)])
17558 ["Debug Formulas"
17559 org-table-toggle-formula-debugger
17560 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
17561 ["Show Col/Row Numbers"
17562 org-table-toggle-coordinate-overlays
17563 :style toggle
17564 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
17565 "--"
17566 ["Create" org-table-create (and (not (org-at-table-p))
17567 org-enable-table-editor)]
17568 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
17569 ["Import from File" org-table-import (not (org-at-table-p))]
17570 ["Export to File" org-table-export (org-at-table-p)]
17571 "--"
17572 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
17574 (easy-menu-define org-org-menu org-mode-map "Org menu"
17575 '("Org"
17576 ("Show/Hide"
17577 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
17578 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
17579 ["Sparse Tree..." org-sparse-tree t]
17580 ["Reveal Context" org-reveal t]
17581 ["Show All" show-all t]
17582 "--"
17583 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
17584 "--"
17585 ["New Heading" org-insert-heading t]
17586 ("Navigate Headings"
17587 ["Up" outline-up-heading t]
17588 ["Next" outline-next-visible-heading t]
17589 ["Previous" outline-previous-visible-heading t]
17590 ["Next Same Level" outline-forward-same-level t]
17591 ["Previous Same Level" outline-backward-same-level t]
17592 "--"
17593 ["Jump" org-goto t])
17594 ("Edit Structure"
17595 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
17596 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
17597 "--"
17598 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
17599 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
17600 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
17601 "--"
17602 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
17603 "--"
17604 ["Promote Heading" org-metaleft (not (org-at-table-p))]
17605 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
17606 ["Demote Heading" org-metaright (not (org-at-table-p))]
17607 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
17608 "--"
17609 ["Sort Region/Children" org-sort (not (org-at-table-p))]
17610 "--"
17611 ["Convert to odd levels" org-convert-to-odd-levels t]
17612 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
17613 ("Editing"
17614 ["Emphasis..." org-emphasize t]
17615 ["Edit Source Example" org-edit-special t]
17616 "--"
17617 ["Footnote new/jump" org-footnote-action t]
17618 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
17619 ("Archive"
17620 ["Archive (default method)" org-archive-subtree-default t]
17621 "--"
17622 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
17623 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
17624 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
17625 )
17626 "--"
17627 ("Hyperlinks"
17628 ["Store Link (Global)" org-store-link t]
17629 ["Find existing link to here" org-occur-link-in-agenda-files t]
17630 ["Insert Link" org-insert-link t]
17631 ["Follow Link" org-open-at-point t]
17632 "--"
17633 ["Next link" org-next-link t]
17634 ["Previous link" org-previous-link t]
17635 "--"
17636 ["Descriptive Links"
17637 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
17638 :style radio
17639 :selected (member '(org-link) buffer-invisibility-spec)]
17640 ["Literal Links"
17641 (progn
17642 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
17643 :style radio
17644 :selected (not (member '(org-link) buffer-invisibility-spec))])
17645 "--"
17646 ("TODO Lists"
17647 ["TODO/DONE/-" org-todo t]
17648 ("Select keyword"
17649 ["Next keyword" org-shiftright (org-on-heading-p)]
17650 ["Previous keyword" org-shiftleft (org-on-heading-p)]
17651 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
17652 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
17653 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
17654 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
17655 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
17656 "--"
17657 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
17658 :selected org-enforce-todo-dependencies :style toggle :active t]
17659 "Settings for tree at point"
17660 ["Do Children sequentially" org-toggle-ordered-property :style radio
17661 :selected (ignore-errors (org-entry-get nil "ORDERED"))
17662 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17663 ["Do Children parallel" org-toggle-ordered-property :style radio
17664 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
17665 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17666 "--"
17667 ["Set Priority" org-priority t]
17668 ["Priority Up" org-shiftup t]
17669 ["Priority Down" org-shiftdown t]
17670 "--"
17671 ["Get news from all feeds" org-feed-update-all t]
17672 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
17673 ["Customize feeds" (customize-variable 'org-feed-alist) t])
17674 ("TAGS and Properties"
17675 ["Set Tags" org-set-tags-command t]
17676 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
17677 "--"
17678 ["Set property" org-set-property t]
17679 ["Column view of properties" org-columns t]
17680 ["Insert Column View DBlock" org-insert-columns-dblock t])
17681 ("Dates and Scheduling"
17682 ["Timestamp" org-time-stamp t]
17683 ["Timestamp (inactive)" org-time-stamp-inactive t]
17684 ("Change Date"
17685 ["1 Day Later" org-shiftright t]
17686 ["1 Day Earlier" org-shiftleft t]
17687 ["1 ... Later" org-shiftup t]
17688 ["1 ... Earlier" org-shiftdown t])
17689 ["Compute Time Range" org-evaluate-time-range t]
17690 ["Schedule Item" org-schedule t]
17691 ["Deadline" org-deadline t]
17692 "--"
17693 ["Custom time format" org-toggle-time-stamp-overlays
17694 :style radio :selected org-display-custom-times]
17695 "--"
17696 ["Goto Calendar" org-goto-calendar t]
17697 ["Date from Calendar" org-date-from-calendar t]
17698 "--"
17699 ["Start/Restart Timer" org-timer-start t]
17700 ["Pause/Continue Timer" org-timer-pause-or-continue t]
17701 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
17702 ["Insert Timer String" org-timer t]
17703 ["Insert Timer Item" org-timer-item t])
17704 ("Logging work"
17705 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
17706 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
17707 ["Clock out" org-clock-out t]
17708 ["Clock cancel" org-clock-cancel t]
17709 "--"
17710 ["Mark as default task" org-clock-mark-default-task t]
17711 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
17712 ["Goto running clock" org-clock-goto t]
17713 "--"
17714 ["Display times" org-clock-display t]
17715 ["Create clock table" org-clock-report t]
17716 "--"
17717 ["Record DONE time"
17718 (progn (setq org-log-done (not org-log-done))
17719 (message "Switching to %s will %s record a timestamp"
17720 (car org-done-keywords)
17721 (if org-log-done "automatically" "not")))
17722 :style toggle :selected org-log-done])
17723 "--"
17724 ["Agenda Command..." org-agenda t]
17725 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
17726 ("File List for Agenda")
17727 ("Special views current file"
17728 ["TODO Tree" org-show-todo-tree t]
17729 ["Check Deadlines" org-check-deadlines t]
17730 ["Timeline" org-timeline t]
17731 ["Tags/Property tree" org-match-sparse-tree t])
17732 "--"
17733 ["Export/Publish..." org-export t]
17734 ("LaTeX"
17735 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
17736 :selected org-cdlatex-mode]
17737 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
17738 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
17739 ["Modify math symbol" org-cdlatex-math-modify
17740 (org-inside-LaTeX-fragment-p)]
17741 ["Insert citation" org-reftex-citation t]
17742 "--"
17743 ["Template for BEAMER" org-insert-beamer-options-template t])
17744 "--"
17745 ("MobileOrg"
17746 ["Push Files and Views" org-mobile-push t]
17747 ["Get Captured and Flagged" org-mobile-pull t]
17748 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
17749 "--"
17750 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
17751 "--"
17752 ("Documentation"
17753 ["Show Version" org-version t]
17754 ["Info Documentation" org-info t])
17755 ("Customize"
17756 ["Browse Org Group" org-customize t]
17757 "--"
17758 ["Expand This Menu" org-create-customize-menu
17759 (fboundp 'customize-menu-create)])
17760 ["Send bug report" org-submit-bug-report t]
17761 "--"
17762 ("Refresh/Reload"
17763 ["Refresh setup current buffer" org-mode-restart t]
17764 ["Reload Org (after update)" org-reload t]
17765 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
17766 ))
17768 (defun org-info (&optional node)
17769 "Read documentation for Org-mode in the info system.
17770 With optional NODE, go directly to that node."
17771 (interactive)
17772 (info (format "(org)%s" (or node ""))))
17774 ;;;###autoload
17775 (defun org-submit-bug-report ()
17776 "Submit a bug report on Org-mode via mail.
17778 Don't hesitate to report any problems or inaccurate documentation.
17780 If you don't have setup sending mail from (X)Emacs, please copy the
17781 output buffer into your mail program, as it gives us important
17782 information about your Org-mode version and configuration."
17783 (interactive)
17784 (require 'reporter)
17785 (org-load-modules-maybe)
17786 (org-require-autoloaded-modules)
17787 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
17788 (reporter-submit-bug-report
17789 "emacs-orgmode@gnu.org"
17790 (org-version)
17791 (let (list)
17792 (save-window-excursion
17793 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
17794 (delete-other-windows)
17795 (erase-buffer)
17796 (insert "You are about to submit a bug report to the Org-mode mailing list.
17798 We would like to add your full Org-mode and Outline configuration to the
17799 bug report. This greatly simplifies the work of the maintainer and
17800 other experts on the mailing list.
17802 HOWEVER, some variables you have customized may contain private
17803 information. The names of customers, colleagues, or friends, might
17804 appear in the form of file names, tags, todo states, or search strings.
17805 If you answer yes to the prompt, you might want to check and remove
17806 such private information before sending the email.")
17807 (add-text-properties (point-min) (point-max) '(face org-warning))
17808 (when (yes-or-no-p "Include your Org-mode configuration ")
17809 (mapatoms
17810 (lambda (v)
17811 (and (boundp v)
17813 (or (and (symbol-value v)
17815 (and
17816 (get v 'custom-type) (get v 'standard-value)
17817 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
17818 (push v list)))))
17819 (kill-buffer (get-buffer "*Warn about privacy*"))
17820 list))
17821 nil nil
17822 "Remember to cover the basics, that is, what you expected to happen and
17823 what in fact did happen. You don't know how to make a good report? See
17825 http://orgmode.org/manual/Feedback.html#Feedback
17827 Your bug report will be posted to the Org-mode mailing list.
17828 ------------------------------------------------------------------------")
17829 (save-excursion
17834 (defun org-install-agenda-files-menu ()
17835 (let ((bl (buffer-list)))
17836 (save-excursion
17837 (while bl
17838 (set-buffer (pop bl))
17839 (if (org-mode-p) (setq bl nil)))
17840 (when (org-mode-p)
17841 (easy-menu-change
17842 '("Org") "File List for Agenda"
17843 (append
17844 (list
17845 ["Edit File List" (org-edit-agenda-file-list) t]
17846 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
17847 ["Remove Current File from List" org-remove-file t]
17848 ["Cycle through agenda files" org-cycle-agenda-files t]
17849 ["Occur in all agenda files" org-occur-in-agenda-files t]
17850 "--")
17851 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
17853 ;;;; Documentation
17855 ;;;###autoload
17856 (defun org-require-autoloaded-modules ()
17857 (interactive)
17858 (mapc 'require
17859 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
17860 org-docbook org-exp org-html org-icalendar
17861 org-id org-latex
17862 org-publish org-remember org-table
17863 org-timer org-xoxo)))
17865 ;;;###autoload
17866 (defun org-reload (&optional uncompiled)
17867 "Reload all org lisp files.
17868 With prefix arg UNCOMPILED, load the uncompiled versions."
17869 (interactive "P")
17870 (require 'find-func)
17872 (dir-org (file-name-directory (org-find-library-name "org")))
17873 (dir-org-contrib (ignore-errors
17874 (file-name-directory
17875 (org-find-library-name "org-contribdir"))))
17876 (babel-files
17877 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
17878 (append (list nil "comint" "eval" "exp" "keys"
17879 "lob" "ref" "table" "tangle")
17880 (delq nil
17881 (mapcar
17882 (lambda (lang)
17883 (when (cdr lang) (symbol-name (car lang))))
17884 org-babel-load-languages)))))
17885 (files
17886 (append (directory-files dir-org t file-re)
17887 babel-files
17888 (and dir-org-contrib
17889 (directory-files dir-org-contrib t file-re))))
17890 (remove-re (concat (if (featurep 'xemacs)
17891 "org-colview" "org-colview-xemacs")
17893 (setq files (mapcar 'file-name-sans-extension files))
17894 (setq files (mapcar
17895 (lambda (x) (if (string-match remove-re x) nil x))
17896 files))
17897 (setq files (delq nil files))
17898 (mapc
17899 (lambda (f)
17900 (when (featurep (intern (file-name-nondirectory f)))
17901 (if (and (not uncompiled)
17902 (file-exists-p (concat f ".elc")))
17903 (load (concat f ".elc") nil nil t)
17904 (load (concat f ".el") nil nil t))))
17905 files))
17906 (org-version))
17908 ;;;###autoload
17909 (defun org-customize ()
17910 "Call the customize function with org as argument."
17911 (interactive)
17912 (org-load-modules-maybe)
17913 (org-require-autoloaded-modules)
17914 (customize-browse 'org))
17916 (defun org-create-customize-menu ()
17917 "Create a full customization menu for Org-mode, insert it into the menu."
17918 (interactive)
17919 (org-load-modules-maybe)
17920 (org-require-autoloaded-modules)
17921 (if (fboundp 'customize-menu-create)
17922 (progn
17923 (easy-menu-change
17924 '("Org") "Customize"
17925 `(["Browse Org group" org-customize t]
17926 "--"
17927 ,(customize-menu-create 'org)
17928 ["Set" Custom-set t]
17929 ["Save" Custom-save t]
17930 ["Reset to Current" Custom-reset-current t]
17931 ["Reset to Saved" Custom-reset-saved t]
17932 ["Reset to Standard Settings" Custom-reset-standard t]))
17934 (error "Cannot expand menu (outdated version of cus-edit.el)")))
17936 ;;;; Miscellaneous stuff
17938 ;;; Generally useful functions
17940 (defun org-get-at-bol (property)
17941 "Get text property PROPERTY at beginning of line."
17942 (get-text-property (point-at-bol) property))
17944 (defun org-find-text-property-in-string (prop s)
17945 "Return the first non-nil value of property PROP in string S."
17946 (or (get-text-property 0 prop s)
17947 (get-text-property (or (next-single-property-change 0 prop s) 0)
17948 prop s)))
17950 (defun org-display-warning (message) ;; Copied from Emacs-Muse
17951 "Display the given MESSAGE as a warning."
17952 (if (fboundp 'display-warning)
17953 (display-warning 'org message
17954 (if (featurep 'xemacs) 'warning :warning))
17955 (let ((buf (get-buffer-create "*Org warnings*")))
17956 (with-current-buffer buf
17957 (goto-char (point-max))
17958 (insert "Warning (Org): " message)
17959 (unless (bolp)
17960 (newline)))
17961 (display-buffer buf)
17962 (sit-for 0))))
17964 (defun org-in-commented-line ()
17965 "Is point in a line starting with `#'?"
17966 (equal (char-after (point-at-bol)) ?#))
17968 (defun org-in-indented-comment-line ()
17969 "Is point in a line starting with `#' after some white space?"
17970 (save-excursion
17971 (save-match-data
17972 (goto-char (point-at-bol))
17975 (defun org-in-verbatim-emphasis ()
17976 (save-match-data
17977 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
17979 (defun org-goto-marker-or-bmk (marker &optional bookmark)
17980 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
17981 (if (and marker (marker-buffer marker)
17982 (buffer-live-p (marker-buffer marker)))
17983 (progn
17984 (switch-to-buffer (marker-buffer marker))
17985 (if (or (> marker (point-max)) (< marker (point-min)))
17986 (widen))
17987 (goto-char marker)
17988 (org-show-context 'org-goto))
17989 (if bookmark
17990 (bookmark-jump bookmark)
17991 (error "Cannot find location"))))
17993 (defun org-quote-csv-field (s)
17994 "Quote field for inclusion in CSV material."
17997 s))
17999 (defun org-plist-delete (plist property)
18000 "Delete PROPERTY from PLIST.
18001 This is in contrast to merely setting it to 0."
18002 (let (p)
18003 (while plist
18004 (if (not (eq property (car plist)))
18005 (setq p (plist-put p (car plist) (nth 1 plist))))
18006 (setq plist (cddr plist)))
18007 p))
18009 (defun org-force-self-insert (N)
18010 "Needed to enforce self-insert under remapping."
18011 (interactive "p")
18012 (self-insert-command N))
18014 (defun org-string-width (s)
18015 "Compute width of string, ignoring invisible characters.
18016 This ignores character with invisibility property `org-link', and also
18017 characters with property `org-cwidth', because these will become invisible
18018 upon the next fontification round."
18019 (let (b l)
18020 (when (or (eq t buffer-invisibility-spec)
18021 (assq 'org-link buffer-invisibility-spec))
18022 (while (setq b (text-property-any 0 (length s)
18023 'invisible 'org-link s))
18024 (setq s (concat (substring s 0 b)
18025 (substring s (or (next-single-property-change
18026 b 'invisible s) (length s)))))))
18027 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18028 (setq s (concat (substring s 0 b)
18029 (substring s (or (next-single-property-change
18030 b 'org-cwidth s) (length s))))))
18031 (setq l (string-width s) b -1)
18032 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18033 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18034 l))
18036 (defun org-shorten-string (s maxlength)
18037 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18038 If the string is shorter or has length MAXLENGTH, just return the
18039 original string. If it is longer, the functions finds a space in the
18040 string, breaks this string off at that locations and adds three dots
18041 as ellipsis. Including the ellipsis, the string will not be longer
18042 than MAXLENGTH. If finding a good breaking point in the string does
18043 not work, the string is just chopped off in the middle of a word
18044 if necessary."
18045 (if (<= (length s) maxlength)
18046 s
18047 (let* ((n (max (- maxlength 4) 1))
18049 (if (string-match re s)
18050 (concat (match-string 1 s) "...")
18051 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18053 (defun org-get-indentation (&optional line)
18054 "Get the indentation of the current line, interpreting tabs.
18055 When LINE is given, assume it represents a line and compute its indentation."
18056 (if line
18057 (if (string-match "^ *" (org-remove-tabs line))
18058 (match-end 0))
18059 (save-excursion
18060 (beginning-of-line 1)
18062 (current-column))))
18064 (defun org-remove-tabs (s &optional width)
18065 "Replace tabulators in S with spaces.
18066 Assumes that s is a single line, starting in column 0."
18067 (setq width (or width tab-width))
18069 (setq s (replace-match
18070 (make-string
18071 (- (* width (/ (+ (match-beginning 0) width) width))
18072 (match-beginning 0)) ?\ )
18073 t t s)))
18074 s)
18076 (defun org-fix-indentation (line ind)
18077 "Fix indentation in LINE.
18078 IND is a cons cell with target and minimum indentation.
18079 If the current indentation in LINE is smaller than the minimum,
18080 leave it alone. If it is larger than ind, set it to the target."
18081 (let* ((l (org-remove-tabs line))
18082 (i (org-get-indentation l))
18083 (i1 (car ind)) (i2 (cdr ind)))
18084 (if (>= i i2) (setq l (substring line i2)))
18085 (if (> i1 0)
18086 (concat (make-string i1 ?\ ) l)
18087 l)))
18089 (defun org-remove-indentation (code &optional n)
18090 "Remove the maximum common indentation from the lines in CODE.
18091 N may optionally be the number of spaces to remove."
18092 (with-temp-buffer
18093 (insert code)
18094 (org-do-remove-indentation n)
18095 (buffer-string)))
18097 (defun org-do-remove-indentation (&optional n)
18098 "Remove the maximum common indentation from the buffer."
18099 (untabify (point-min) (point-max))
18100 (let ((min 10000) re)
18101 (if n
18102 (setq min n)
18103 (goto-char (point-min))
18105 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18106 (unless (or (= min 0) (= min 10000))
18108 (goto-char (point-min))
18109 (while (re-search-forward re nil t)
18110 (replace-match "")
18111 (end-of-line 1))
18112 min)))
18114 (defun org-fill-template (template alist)
18115 "Find each %key of ALIST in TEMPLATE and replace it."
18116 (let ((case-fold-search nil)
18117 entry key value)
18118 (setq alist (sort (copy-sequence alist)
18119 (lambda (a b) (< (length (car a)) (length (car b))))))
18120 (while (setq entry (pop alist))
18121 (setq template
18122 (replace-regexp-in-string
18123 (concat "%" (regexp-quote (car entry)))
18124 (cdr entry) template t t)))
18125 template))
18127 (defun org-base-buffer (buffer)
18128 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18129 (if (not buffer)
18130 buffer
18131 (or (buffer-base-buffer buffer)
18132 buffer)))
18134 (defun org-trim (s)
18135 "Remove whitespace at beginning and end of string."
18138 s)
18140 (defun org-wrap (string &optional width lines)
18141 "Wrap string to either a number of lines, or a width in characters.
18142 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18143 that costs. If there is a word longer than WIDTH, the text is actually
18144 wrapped to the length of that word.
18145 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18146 many lines, whatever width that takes.
18147 The return value is a list of lines, without newlines at the end."
18149 (maxword (apply 'max (mapcar 'org-string-width words)))
18150 w ll)
18151 (cond (width
18152 (org-do-wrap words (max maxword width)))
18153 (lines
18154 (setq w maxword)
18155 (setq ll (org-do-wrap words maxword))
18156 (if (<= (length ll) lines)
18157 ll
18158 (setq ll words)
18159 (while (> (length ll) lines)
18160 (setq w (1+ w))
18161 (setq ll (org-do-wrap words w)))
18162 ll))
18163 (t (error "Cannot wrap this")))))
18165 (defun org-do-wrap (words width)
18166 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18167 (let (lines line)
18168 (while words
18169 (setq line (pop words))
18170 (while (and words (< (+ (length line) (length (car words))) width))
18171 (setq line (concat line " " (pop words))))
18172 (setq lines (push line lines)))
18173 (nreverse lines)))
18175 (defun org-split-string (string &optional separators)
18176 "Splits STRING into substrings at SEPARATORS.
18177 No empty strings are returned if there are matches at the beginning
18178 and end of string."
18180 (start 0)
18181 notfirst
18182 (list nil))
18183 (while (and (string-match rexp string
18184 (if (and notfirst
18185 (= start (match-beginning 0))
18186 (< start (length string)))
18187 (1+ start) start))
18188 (< (match-beginning 0) (length string)))
18189 (setq notfirst t)
18190 (or (eq (match-beginning 0) 0)
18191 (and (eq (match-beginning 0) (match-end 0))
18192 (eq (match-beginning 0) start))
18193 (setq list
18194 (cons (substring string start (match-beginning 0))
18195 list)))
18196 (setq start (match-end 0)))
18197 (or (eq start (length string))
18198 (setq list
18199 (cons (substring string start)
18200 list)))
18201 (nreverse list)))
18203 (defun org-quote-vert (s)
18205 (while (string-match "|" s)
18207 s)
18209 (defun org-uuidgen-p (s)
18210 "Is S an ID created by UUIDGEN?"
18211 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18213 (defun org-context ()
18214 "Return a list of contexts of the current cursor position.
18215 If several contexts apply, all are returned.
18216 Each context entry is a list with a symbol naming the context, and
18217 two positions indicating start and end of the context. Possible
18218 contexts are:
18220 :headline anywhere in a headline
18221 :headline-stars on the leading stars in a headline
18222 :todo-keyword on a TODO keyword (including DONE) in a headline
18223 :tags on the TAGS in a headline
18224 :priority on the priority cookie in a headline
18225 :item on the first line of a plain list item
18226 :item-bullet on the bullet/number of a plain list item
18227 :checkbox on the checkbox in a plain list item
18228 :table in an org-mode table
18229 :table-special on a special filed in a table
18230 :table-table in a table.el table
18231 :link on a hyperlink
18232 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18233 :target on a <<target>>
18234 :radio-target on a <<<radio-target>>>
18235 :latex-fragment on a LaTeX fragment
18236 :latex-preview on a LaTeX fragment with overlayed preview image
18238 This function expects the position to be visible because it uses font-lock
18239 faces as a help to recognize the following contexts: :table-special, :link,
18240 and :keyword."
18241 (let* ((f (get-text-property (point) 'face))
18242 (faces (if (listp f) f (list f)))
18243 (p (point)) clist o)
18244 ;; First the large context
18245 (cond
18246 ((org-on-heading-p t)
18247 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18248 (when (progn
18249 (beginning-of-line 1)
18250 (looking-at org-todo-line-tags-regexp))
18251 (push (org-point-in-group p 1 :headline-stars) clist)
18252 (push (org-point-in-group p 2 :todo-keyword) clist)
18253 (push (org-point-in-group p 4 :tags) clist))
18254 (goto-char p)
18257 (push (org-point-in-group p 0 :priority) clist)))
18259 ((org-at-item-p)
18260 (push (org-point-in-group p 2 :item-bullet) clist)
18261 (push (list :item (point-at-bol)
18262 (save-excursion (org-end-of-item) (point)))
18263 clist)
18264 (and (org-at-item-checkbox-p)
18265 (push (org-point-in-group p 0 :checkbox) clist)))
18267 ((org-at-table-p)
18268 (push (list :table (org-table-begin) (org-table-end)) clist)
18269 (if (memq 'org-formula faces)
18270 (push (list :table-special
18271 (previous-single-property-change p 'face)
18272 (next-single-property-change p 'face)) clist)))
18273 ((org-at-table-p 'any)
18274 (push (list :table-table) clist)))
18275 (goto-char p)
18277 ;; Now the small context
18278 (cond
18279 ((org-at-timestamp-p)
18280 (push (org-point-in-group p 0 :timestamp) clist))
18281 ((memq 'org-link faces)
18282 (push (list :link
18283 (previous-single-property-change p 'face)
18284 (next-single-property-change p 'face)) clist))
18285 ((memq 'org-special-keyword faces)
18286 (push (list :keyword
18287 (previous-single-property-change p 'face)
18288 (next-single-property-change p 'face)) clist))
18289 ((org-on-target-p)
18290 (push (org-point-in-group p 0 :target) clist)
18291 (goto-char (1- (match-beginning 0)))
18292 (if (looking-at org-radio-target-regexp)
18293 (push (org-point-in-group p 0 :radio-target) clist))
18294 (goto-char p))
18295 ((setq o (car (delq nil
18296 (mapcar
18297 (lambda (x)
18298 (if (memq x org-latex-fragment-image-overlays) x))
18299 (overlays-at (point))))))
18300 (push (list :latex-fragment
18301 (overlay-start o) (overlay-end o)) clist)
18302 (push (list :latex-preview
18303 (overlay-start o) (overlay-end o)) clist))
18304 ((org-inside-LaTeX-fragment-p)
18305 ;; FIXME: positions wrong.
18306 (push (list :latex-fragment (point) (point)) clist)))
18308 (setq clist (nreverse (delq nil clist)))
18309 clist))
18311 ;; FIXME: Compare with at-regexp-p Do we need both?
18312 (defun org-in-regexp (re &optional nlines visually)
18313 "Check if point is inside a match of regexp.
18314 Normally only the current line is checked, but you can include NLINES extra
18315 lines both before and after point into the search.
18316 If VISUALLY is set, require that the cursor is not after the match but
18317 really on, so that the block visually is on the match."
18318 (catch 'exit
18319 (let ((pos (point))
18320 (eol (point-at-eol (+ 1 (or nlines 0))))
18321 (inc (if visually 1 0)))
18322 (save-excursion
18323 (beginning-of-line (- 1 (or nlines 0)))
18324 (while (re-search-forward re eol t)
18325 (if (and (<= (match-beginning 0) pos)
18326 (>= (+ inc (match-end 0)) pos))
18327 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18329 (defun org-at-regexp-p (regexp)
18330 "Is point inside a match of REGEXP in the current line?"
18331 (catch 'exit
18332 (save-excursion
18333 (let ((pos (point)) (end (point-at-eol)))
18334 (beginning-of-line 1)
18335 (while (re-search-forward regexp end t)
18336 (if (and (<= (match-beginning 0) pos)
18337 (>= (match-end 0) pos))
18338 (throw 'exit t)))
18339 nil))))
18341 (defun org-in-regexps-block-p (start-re end-re &optional bound)
18342 "Return t if the current point is between matches of START-RE and END-RE.
18343 This will also return t if point is on one of the two matches or
18344 in an unfinished block. END-RE can be a string or a form
18345 returning a string.
18347 An optional third argument bounds the search for START-RE. It
18348 defaults to previous heading or `point-min'."
18349 (let ((pos (point))
18350 (limit (or bound (save-excursion (outline-previous-heading)))))
18351 (save-excursion
18352 ;; we're on a block when point is on start-re...
18353 (or (org-at-regexp-p start-re)
18354 ;; ... or start-re can be found above...
18355 (and (re-search-backward start-re limit t)
18356 ;; ... but no end-re between start-re and point.
18357 (not (re-search-forward (eval end-re) pos t)))))))
18359 (defun org-occur-in-agenda-files (regexp &optional nlines)
18360 "Call `multi-occur' with buffers for all agenda files."
18362 (let* ((files (org-agenda-files))
18363 (tnames (mapcar 'file-truename files))
18364 (extra org-agenda-text-search-extra-files)
18365 f)
18366 (when (eq (car extra) 'agenda-archives)
18367 (setq extra (cdr extra))
18368 (setq files (org-add-archive-files files)))
18369 (while (setq f (pop extra))
18370 (unless (member (file-truename f) tnames)
18371 (add-to-list 'files f 'append)
18372 (add-to-list 'tnames (file-truename f) 'append)))
18373 (multi-occur
18374 (mapcar (lambda (x)
18375 (with-current-buffer
18376 (or (get-file-buffer x) (find-file-noselect x))
18377 (widen)
18378 (current-buffer)))
18379 files)
18380 regexp)))
18382 (if (boundp 'occur-mode-find-occurrence-hook)
18383 ;; Emacs 23
18384 (add-hook 'occur-mode-find-occurrence-hook
18385 (lambda ()
18386 (when (org-mode-p)
18387 (org-reveal))))
18388 ;; Emacs 22
18389 (defadvice occur-mode-goto-occurrence
18390 (after org-occur-reveal activate)
18391 (and (org-mode-p) (org-reveal)))
18392 (defadvice occur-mode-goto-occurrence-other-window
18393 (after org-occur-reveal activate)
18394 (and (org-mode-p) (org-reveal)))
18395 (defadvice occur-mode-display-occurrence
18396 (after org-occur-reveal activate)
18397 (when (org-mode-p)
18398 (let ((pos (occur-mode-find-occurrence)))
18399 (with-current-buffer (marker-buffer pos)
18400 (save-excursion
18401 (goto-char pos)
18402 (org-reveal)))))))
18404 (defun org-occur-link-in-agenda-files ()
18405 "Create a link and search for it in the agendas.
18406 The link is not stored in `org-stored-links', it is just created
18407 for the search purpose."
18408 (interactive)
18409 (let ((link (condition-case nil
18410 (org-store-link nil)
18411 (error "Unable to create a link to here"))))
18412 (org-occur-in-agenda-files (regexp-quote link))))
18414 (defun org-uniquify (list)
18415 "Remove duplicate elements from LIST."
18416 (let (res)
18417 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
18418 res))
18420 (defun org-delete-all (elts list)
18421 "Remove all elements in ELTS from LIST."
18422 (while elts
18423 (setq list (delete (pop elts) list)))
18424 list)
18426 (defun org-count (cl-item cl-seq)
18427 "Count the number of occurrences of ITEM in SEQ.
18428 Taken from `count' in cl-seq.el with all keyword arguments removed."
18429 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
18430 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
18431 (while (< cl-start cl-end)
18432 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
18433 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
18434 (setq cl-start (1+ cl-start)))
18435 cl-count))
18437 (defun org-remove-if (predicate seq)
18438 "Remove everything from SEQ that fulfills PREDICATE."
18439 (let (res e)
18440 (while seq
18441 (setq e (pop seq))
18442 (if (not (funcall predicate e)) (push e res)))
18443 (nreverse res)))
18445 (defun org-remove-if-not (predicate seq)
18446 "Remove everything from SEQ that does not fulfill PREDICATE."
18447 (let (res e)
18448 (while seq
18449 (setq e (pop seq))
18450 (if (funcall predicate e) (push e res)))
18451 (nreverse res)))
18453 (defun org-back-over-empty-lines ()
18454 "Move backwards over whitespace, to the beginning of the first empty line.
18455 Returns the number of empty lines passed."
18456 (let ((pos (point)))
18458 (beginning-of-line 2)
18459 (goto-char (min (point) pos))
18460 (count-lines (point) pos)))
18462 (defun org-skip-whitespace ()
18465 (defun org-point-in-group (point group &optional context)
18466 "Check if POINT is in match-group GROUP.
18467 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18468 match. If the match group does not exist or point is not inside it,
18469 return nil."
18470 (and (match-beginning group)
18471 (>= point (match-beginning group))
18472 (<= point (match-end group))
18473 (if context
18474 (list context (match-beginning group) (match-end group))
18475 t)))
18477 (defun org-switch-to-buffer-other-window (&rest args)
18478 "Switch to buffer in a second window on the current frame.
18479 In particular, do not allow pop-up frames.
18480 Returns the newly created buffer."
18481 (let (pop-up-frames special-display-buffer-names special-display-regexps
18482 special-display-function)
18483 (apply 'switch-to-buffer-other-window args)))
18485 (defun org-combine-plists (&rest plists)
18486 "Create a single property list from all plists in PLISTS.
18487 The process starts by copying the first list, and then setting properties
18488 from the other lists. Settings in the last list are the most significant
18489 ones and overrule settings in the other lists."
18490 (let ((rtn (copy-sequence (pop plists)))
18491 p v ls)
18492 (while plists
18493 (setq ls (pop plists))
18494 (while ls
18495 (setq p (pop ls) v (pop ls))
18496 (setq rtn (plist-put rtn p v))))
18497 rtn))
18499 (defun org-move-line-down (arg)
18500 "Move the current line down. With prefix argument, move it past ARG lines."
18501 (interactive "p")
18502 (let ((col (current-column))
18503 beg end pos)
18504 (beginning-of-line 1) (setq beg (point))
18505 (beginning-of-line 2) (setq end (point))
18506 (beginning-of-line (+ 1 arg))
18507 (setq pos (move-marker (make-marker) (point)))
18508 (insert (delete-and-extract-region beg end))
18509 (goto-char pos)
18510 (org-move-to-column col)))
18512 (defun org-move-line-up (arg)
18513 "Move the current line up. With prefix argument, move it past ARG lines."
18514 (interactive "p")
18515 (let ((col (current-column))
18516 beg end pos)
18517 (beginning-of-line 1) (setq beg (point))
18518 (beginning-of-line 2) (setq end (point))
18519 (beginning-of-line (- arg))
18520 (setq pos (move-marker (make-marker) (point)))
18521 (insert (delete-and-extract-region beg end))
18522 (goto-char pos)
18523 (org-move-to-column col)))
18525 (defun org-replace-escapes (string table)
18526 "Replace %-escapes in STRING with values in TABLE.
18528 The sequences in STRING may contain normal field width and padding information,
18530 so values can contain further %-escapes if they are define later in TABLE."
18531 (let ((tbl (copy-alist table))
18532 (case-fold-search nil)
18533 (pchg 0)
18534 e re rpl)
18535 (while (setq e (pop tbl))
18536 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
18537 (when (and (cdr e) (string-match re (cdr e)))
18538 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
18539 (safe "SREF"))
18540 (add-text-properties 0 3 (list 'sref sref) safe)
18541 (setcdr e (replace-match safe t t (cdr e)))))
18542 (while (string-match re string)
18543 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
18544 (cdr e)))
18545 (setq string (replace-match rpl t t string))))
18546 (while (setq pchg (next-property-change pchg string))
18547 (let ((sref (get-text-property pchg 'sref string)))
18548 (when (and sref (string-match "SREF" string pchg))
18549 (setq string (replace-match sref t t string)))))
18550 string))
18552 (defun org-sublist (list start end)
18553 "Return a section of LIST, from START to END.
18554 Counting starts at 1."
18555 (let (rtn (c start))
18556 (setq list (nthcdr (1- start) list))
18557 (while (and list (<= c end))
18558 (push (pop list) rtn)
18559 (setq c (1+ c)))
18560 (nreverse rtn)))
18562 (defun org-find-base-buffer-visiting (file)
18563 "Like `find-buffer-visiting' but always return the base buffer and
18564 not an indirect buffer."
18565 (let ((buf (or (get-file-buffer file)
18566 (find-buffer-visiting file))))
18567 (if buf
18568 (or (buffer-base-buffer buf) buf)
18569 nil)))
18571 (defun org-image-file-name-regexp (&optional extensions)
18572 "Return regexp matching the file names of images.
18573 If EXTENSIONS is given, only match these."
18574 (if (and (not extensions) (fboundp 'image-file-name-regexp))
18575 (image-file-name-regexp)
18576 (let ((image-file-name-extensions
18577 (or extensions
18578 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
18579 "xbm" "xpm" "pbm" "pgm" "ppm"))))
18581 (regexp-opt (nconc (mapcar 'upcase
18582 image-file-name-extensions)
18583 image-file-name-extensions)
18584 t)
18587 (defun org-file-image-p (file &optional extensions)
18588 "Return non-nil if FILE is an image."
18589 (save-match-data
18590 (string-match (org-image-file-name-regexp extensions) file)))
18592 (defun org-get-cursor-date ()
18593 "Return the date at cursor in as a time.
18594 This works in the calendar and in the agenda, anywhere else it just
18595 returns the current time."
18596 (let (date day defd)
18597 (cond
18598 ((eq major-mode 'calendar-mode)
18599 (setq date (calendar-cursor-to-date)
18600 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
18601 ((eq major-mode 'org-agenda-mode)
18602 (setq day (get-text-property (point) 'day))
18603 (if day
18604 (setq date (calendar-gregorian-from-absolute day)
18605 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
18606 (nth 2 date))))))
18607 (or defd (current-time))))
18609 (defvar org-agenda-action-marker (make-marker)
18610 "Marker pointing to the entry for the next agenda action.")
18612 (defun org-mark-entry-for-agenda-action ()
18613 "Mark the current entry as target of an agenda action.
18614 Agenda actions are actions executed from the agenda with the key `k',
18615 which make use of the date at the cursor."
18616 (interactive)
18617 (move-marker org-agenda-action-marker
18618 (save-excursion (org-back-to-heading t) (point))
18619 (current-buffer))
18620 (message
18621 "Entry marked for action; press `k' at desired date in agenda or calendar"))
18623 (defun org-mark-subtree ()
18624 "Mark the current subtree.
18625 This puts point at the start of the current subtree, and mark at the end.
18627 If point is in an inline task, mark that task instead."
18628 (interactive)
18629 (let ((inline-task-p
18630 (and (featurep 'org-inlinetask)
18631 (org-inlinetask-in-task-p)))
18632 (beg))
18633 ;; Get beginning of subtree
18634 (cond
18635 (inline-task-p (org-inlinetask-goto-beginning))
18636 ((org-at-heading-p) (beginning-of-line))
18637 (t (let ((outline-regexp (org-get-limited-outline-regexp)))
18638 (outline-previous-visible-heading 1))))
18639 (setq beg (point))
18640 ;; Get end of it
18641 (if inline-task-p
18642 (org-inlinetask-goto-end)
18643 (org-end-of-subtree))
18644 ;; Mark zone
18645 (push-mark (point) nil t)
18646 (goto-char beg)))
18648 ;;; Paragraph filling stuff.
18649 ;; We want this to be just right, so use the full arsenal.
18651 (defun org-indent-line-function ()
18652 "Indent line depending on context."
18653 (interactive)
18654 (let* ((pos (point))
18655 (itemp (org-at-item-p))
18656 (case-fold-search t)
18658 (inline-task-p (and (featurep 'org-inlinetask)
18659 (org-inlinetask-in-task-p)))
18660 column bpos bcol tpos tcol)
18661 (beginning-of-line 1)
18662 (cond
18663 ;; Comments
18664 ((looking-at "# ") (setq column 0))
18665 ;; Headings
18667 ;; Literal examples
18669 (setq column (org-get-indentation))) ; do nothing
18670 ;; Drawers
18672 (save-excursion (re-search-backward org-drawer-regexp nil t)))
18673 (save-excursion
18674 (goto-char (1- (match-beginning 1)))
18675 (setq column (current-column))))
18676 ;; Special blocks
18678 (save-excursion
18679 (re-search-backward
18681 (setq column (org-get-indentation (match-string 0))))
18684 (save-excursion
18686 (setq column
18687 (if (equal (downcase (match-string 1)) "src")
18688 ;; src blocks: let `org-edit-src-exit' handle them
18689 (org-get-indentation)
18690 (org-get-indentation (match-string 0)))))
18691 ;; Lists
18692 ((org-in-item-p)
18693 (org-beginning-of-item)
18694 (looking-at "[ \t]*\\(\\S-+\\)[ \t]*\\(\\(:?\\[@\\(:?start:\\)?[0-9]+\\][ \t]*\\)?\\[[- X]\\][ \t]*\\|.*? :: \\)?")
18695 (setq bpos (match-beginning 1) tpos (match-end 0)
18696 bcol (progn (goto-char bpos) (current-column))
18697 tcol (progn (goto-char tpos) (current-column)))
18698 (if (> tcol (+ bcol org-description-max-indent))
18699 (setq tcol (+ bcol 5)))
18700 (goto-char pos)
18701 (setq column (if itemp (org-get-indentation) tcol)))
18702 ;; This line has nothing special, look at the previous relevant
18703 ;; line to compute indentation
18704 (t
18705 (beginning-of-line 0)
18706 (while (and (not (bobp))
18707 (not (looking-at org-drawer-regexp))
18708 ;; skip comments, verbatim, empty lines, tables,
18709 ;; inline tasks, lists, drawers and blocks
18711 (re-search-backward org-drawer-regexp nil t))
18715 (and (org-in-item-p) (goto-char (org-list-top-point)))
18716 (and (not inline-task-p)
18717 (featurep 'org-inlinetask)
18718 (org-inlinetask-in-task-p)
18719 (or (org-inlinetask-goto-beginning) t))))
18720 (beginning-of-line 0))
18721 (cond
18722 ;; There was an heading above.
18724 (if (not org-adapt-indentation)
18725 (setq column 0)
18726 (goto-char (match-end 0))
18727 (setq column (current-column))))
18728 ;; A drawer had started and is unfinished
18729 ((looking-at org-drawer-regexp)
18730 (goto-char (1- (match-beginning 1)))
18731 (setq column (current-column)))
18732 ;; Else, nothing noticeable found: get indentation and go on.
18733 (t (setq column (org-get-indentation))))))
18734 ;; Now apply indentation and move cursor accordingly
18735 (goto-char pos)
18736 (if (<= (current-column) (current-indentation))
18737 (org-indent-line-to column)
18738 (save-excursion (org-indent-line-to column)))
18739 ;; Special polishing for properties, see `org-property-format'
18740 (setq column (current-column))
18741 (beginning-of-line 1)
18742 (if (looking-at
18744 (replace-match (concat (match-string 1)
18745 (format org-property-format
18746 (match-string 2) (match-string 3)))
18747 t t))
18748 (org-move-to-column column)))
18750 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
18751 "Variable to store copy of `adaptive-fill-regexp'.
18752 Since `adaptive-fill-regexp' is set to never match, we need to
18753 store a backup of its value before entering `org-mode' so that
18754 the functionality can be provided as a fall-back.")
18756 (defun org-set-autofill-regexps ()
18757 (interactive)
18758 ;; In the paragraph separator we include headlines, because filling
18759 ;; text in a line directly attached to a headline would otherwise
18760 ;; fill the headline as well.
18763 ;; The paragraph starter includes hand-formatted lists.
18764 (org-set-local
18765 'paragraph-start
18766 (concat
18775 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
18776 ;; But only if the user has not turned off tables or fixed-width regions
18777 (org-set-local
18778 'auto-fill-inhibit-regexp
18781 (if (or org-enable-table-editor org-enable-fixed-width-editor)
18782 (concat
18784 (if org-enable-table-editor "|" "")
18785 (if org-enable-fixed-width-editor ":" "")
18786 "]"))))
18787 ;; We use our own fill-paragraph function, to make sure that tables
18788 ;; and fixed-width regions are not wrapped. That function will pass
18789 ;; through to `fill-paragraph' when appropriate.
18790 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
18791 ;; Adaptive filling: To get full control, first make sure that
18792 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
18793 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
18794 (org-set-local 'org-adaptive-fill-regexp-backup
18795 adaptive-fill-regexp))
18797 (org-set-local 'adaptive-fill-function
18798 'org-adaptive-fill-function)
18799 (org-set-local
18800 'align-mode-rules-list
18801 '((org-in-buffer-settings
18803 (modes . '(org-mode))))))
18805 (defun org-fill-paragraph (&optional justify)
18806 "Re-align a table, pass through to fill-paragraph if no table."
18807 (let ((table-p (org-at-table-p))
18808 (table.el-p (org-at-table.el-p)))
18809 (cond ((and (equal (char-after (point-at-bol)) ?*)
18810 (save-excursion (goto-char (point-at-bol))
18811 (looking-at outline-regexp)))
18812 t) ; skip headlines
18813 (table.el-p t) ; skip table.el tables
18814 (table-p (org-table-align) t) ; align org-mode tables
18815 (t nil)))) ; call paragraph-fill
18817 ;; For reference, this is the default value of adaptive-fill-regexp
18820 (defun org-adaptive-fill-function ()
18821 "Return a fill prefix for org-mode files.
18822 In particular, this makes sure hanging paragraphs for hand-formatted lists
18823 work correctly."
18824 (cond
18825 ;; Comment line
18827 (match-string-no-properties 0))
18828 ;; Description list
18830 (save-excursion
18831 (if (> (match-end 1) (+ (match-beginning 1)
18832 org-description-max-indent))
18833 (goto-char (+ (match-beginning 1) 5))
18834 (goto-char (match-end 0)))
18835 (make-string (current-column) ?\ )))
18836 ;; Ordered or unordered list
18838 (save-excursion
18839 (goto-char (match-end 0))
18840 (make-string (current-column) ?\ )))
18841 ;; Other text
18842 ((looking-at org-adaptive-fill-regexp-backup)
18843 (match-string-no-properties 0))))
18845 ;;; Other stuff.
18847 (defun org-toggle-fixed-width-section (arg)
18848 "Toggle the fixed-width export.
18849 If there is no active region, the QUOTE keyword at the current headline is
18850 inserted or removed. When present, it causes the text between this headline
18851 and the next to be exported as fixed-width text, and unmodified.
18852 If there is an active region, this command adds or removes a colon as the
18853 first character of this line. If the first character of a line is a colon,
18854 this line is also exported in fixed-width font."
18855 (interactive "P")
18856 (let* ((cc 0)
18857 (regionp (org-region-active-p))
18858 (beg (if regionp (region-beginning) (point)))
18859 (end (if regionp (region-end)))
18860 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
18861 (case-fold-search nil)
18863 off)
18864 (if regionp
18865 (save-excursion
18866 (goto-char beg)
18867 (setq cc (current-column))
18868 (beginning-of-line 1)
18869 (setq off (looking-at re))
18870 (while (> nlines 0)
18871 (setq nlines (1- nlines))
18872 (beginning-of-line 1)
18873 (cond
18874 (arg
18875 (org-move-to-column cc t)
18877 (forward-line -1))
18878 ((and off (looking-at re))
18879 (replace-match "" t t nil 1))
18880 ((not off) (org-move-to-column cc t) (insert ": ")))
18881 (forward-line 1)))
18882 (save-excursion
18883 (org-back-to-heading)
18884 (if (looking-at (concat outline-regexp
18886 (replace-match "" t t nil 1)
18887 (if (looking-at outline-regexp)
18888 (progn
18889 (goto-char (match-end 0))
18890 (insert org-quote-string " "))))))))
18892 (defun org-reftex-citation ()
18893 "Use reftex-citation to insert a citation into the buffer.
18894 This looks for a line like
18896 #+BIBLIOGRAPHY: foo plain option:-d
18898 and derives from it that foo.bib is the bibliography file relevant
18899 for this document. It then installs the necessary environment for RefTeX
18900 to work in this buffer and calls `reftex-citation' to insert a citation
18901 into the buffer.
18903 Export of such citations to both LaTeX and HTML is handled by the contributed
18904 package org-exp-bibtex by Taru Karttunen."
18905 (interactive)
18906 (let ((reftex-docstruct-symbol 'rds)
18908 rds bib)
18909 (save-excursion
18910 (save-restriction
18911 (widen)
18912 (let ((case-fold-search t)
18914 (if (not (save-excursion
18915 (or (re-search-forward re nil t)
18916 (re-search-backward re nil t))))
18917 (error "No bibliography defined in file")
18918 (setq bib (concat (match-string 1) ".bib")
18919 rds (list (list 'bib bib)))))))
18920 (call-interactively 'reftex-citation)))
18922 ;;;; Functions extending outline functionality
18924 (defun org-beginning-of-line (&optional arg)
18925 "Go to the beginning of the current line. If that is invisible, continue
18926 to a visible line beginning. This makes the function of C-a more intuitive.
18927 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18928 first attempt, and only move to after the tags when the cursor is already
18929 beyond the end of the headline."
18930 (interactive "P")
18931 (let ((pos (point))
18932 (special (if (consp org-special-ctrl-a/e)
18933 (car org-special-ctrl-a/e)
18934 org-special-ctrl-a/e))
18935 refpos)
18936 (if (org-bound-and-true-p line-move-visual)
18937 (beginning-of-visual-line 1)
18938 (beginning-of-line 1))
18939 (if (and arg (fboundp 'move-beginning-of-line))
18940 (call-interactively 'move-beginning-of-line)
18941 (if (bobp)
18942 nil
18943 (backward-char 1)
18944 (if (org-truely-invisible-p)
18945 (while (and (not (bobp)) (org-truely-invisible-p))
18946 (backward-char 1)
18947 (beginning-of-line 1))
18948 (forward-char 1))))
18949 (when special
18950 (cond
18951 ((and (looking-at org-complex-heading-regexp)
18952 (= (char-after (match-end 1)) ?\ ))
18953 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
18954 (point-at-eol)))
18955 (goto-char
18956 (if (eq special t)
18957 (cond ((> pos refpos) refpos)
18958 ((= pos (point)) refpos)
18959 (t (point)))
18960 (cond ((> pos (point)) (point))
18961 ((not (eq last-command this-command)) (point))
18962 (t refpos)))))
18963 ((org-at-item-p)
18964 (goto-char
18965 (if (eq special t)
18966 (cond ((> pos (match-end 4)) (match-end 4))
18967 ((= pos (point)) (match-end 4))
18968 (t (point)))
18969 (cond ((> pos (point)) (point))
18970 ((not (eq last-command this-command)) (point))
18971 (t (match-end 4))))))))
18972 (org-no-warnings
18973 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18975 (defun org-end-of-line (&optional arg)
18976 "Go to the end of the line.
18977 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18978 first attempt, and only move to after the tags when the cursor is already
18979 beyond the end of the headline."
18980 (interactive "P")
18981 (let ((special (if (consp org-special-ctrl-a/e)
18982 (cdr org-special-ctrl-a/e)
18983 org-special-ctrl-a/e)))
18984 (if (or (not special)
18985 (not (org-on-heading-p))
18986 arg)
18987 (call-interactively
18988 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
18989 ((fboundp 'move-end-of-line) 'move-end-of-line)
18990 (t 'end-of-line)))
18991 (let ((pos (point)))
18992 (beginning-of-line 1)
18994 (if (eq special t)
18995 (if (or (< pos (match-beginning 1))
18996 (= pos (match-end 0)))
18997 (goto-char (match-beginning 1))
18998 (goto-char (match-end 0)))
18999 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19000 (goto-char (match-end 0))
19001 (goto-char (match-beginning 1))))
19002 (call-interactively (if (fboundp 'move-end-of-line)
19003 'move-end-of-line
19004 'end-of-line)))))
19005 (org-no-warnings
19006 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19008 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19009 (define-key org-mode-map "\C-e" 'org-end-of-line)
19011 (defun org-backward-sentence (&optional arg)
19012 "Go to beginning of sentence, or beginning of table field.
19013 This will call `backward-sentence' or `org-table-beginning-of-field',
19014 depending on context."
19015 (interactive "P")
19016 (cond
19017 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19018 (t (call-interactively 'backward-sentence))))
19020 (defun org-forward-sentence (&optional arg)
19021 "Go to end of sentence, or end of table field.
19022 This will call `forward-sentence' or `org-table-end-of-field',
19023 depending on context."
19024 (interactive "P")
19025 (cond
19026 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19027 (t (call-interactively 'forward-sentence))))
19029 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19030 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19032 (defun org-kill-line (&optional arg)
19033 "Kill line, to tags or end of line."
19034 (interactive "P")
19035 (cond
19036 ((or (not org-special-ctrl-k)
19037 (bolp)
19038 (not (org-on-heading-p)))
19039 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19040 org-ctrl-k-protect-subtree)
19041 (if (or (eq org-ctrl-k-protect-subtree 'error)
19042 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19043 (error "C-k aborted - would kill hidden subtree")))
19044 (call-interactively 'kill-line))
19046 (kill-region (point) (match-beginning 1))
19047 (org-set-tags nil t))
19048 (t (kill-region (point) (point-at-eol)))))
19050 (define-key org-mode-map "\C-k" 'org-kill-line)
19052 (defun org-yank (&optional arg)
19053 "Yank. If the kill is a subtree, treat it specially.
19054 This command will look at the current kill and check if is a single
19055 subtree, or a series of subtrees[1]. If it passes the test, and if the
19056 cursor is at the beginning of a line or after the stars of a currently
19057 empty headline, then the yank is handled specially. How exactly depends
19058 on the value of the following variables, both set by default.
19060 org-yank-folded-subtrees
19061 When set, the subtree(s) will be folded after insertion, but only
19062 if doing so would now swallow text after the yanked text.
19064 org-yank-adjusted-subtrees
19065 When set, the subtree will be promoted or demoted in order to
19066 fit into the local outline tree structure, which means that the level
19067 will be adjusted so that it becomes the smaller one of the two
19068 *visible* surrounding headings.
19070 Any prefix to this command will cause `yank' to be called directly with
19072 will just
19073 plainly yank the text as it is.
19075 \[1] The test checks if the first non-white line is a heading
19076 and if there are no other headings with fewer stars."
19077 (interactive "P")
19078 (org-yank-generic 'yank arg))
19080 (defun org-yank-generic (command arg)
19081 "Perform some yank-like command.
19083 This function implements the behavior described in the `org-yank'
19084 documentation. However, it has been generalized to work for any
19085 interactive command with similar behavior."
19087 ;; pretend to be command COMMAND
19088 (setq this-command command)
19090 (if arg
19091 (call-interactively command)
19093 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19094 (and (org-kill-is-subtree-p)
19095 (or (bolp)
19097 (string-match
19099 (buffer-substring (point-at-bol) (point)))))))
19100 swallowp)
19101 (cond
19102 ((and subtreep org-yank-folded-subtrees)
19103 (let ((beg (point))
19104 end)
19105 (if (and subtreep org-yank-adjusted-subtrees)
19106 (org-paste-subtree nil nil 'for-yank)
19107 (call-interactively command))
19109 (setq end (point))
19110 (goto-char beg)
19111 (when (and (bolp) subtreep
19112 (not (setq swallowp
19113 (org-yank-folding-would-swallow-text beg end))))
19114 (or (looking-at outline-regexp)
19115 (re-search-forward (concat "^" outline-regexp) end t))
19116 (while (and (< (point) end) (looking-at outline-regexp))
19117 (hide-subtree)
19118 (org-cycle-show-empty-lines 'folded)
19119 (condition-case nil
19120 (outline-forward-same-level 1)
19121 (error (goto-char end)))))
19122 (when swallowp
19123 (message
19124 "Inserted text not folded because that would swallow text"))
19126 (goto-char end)
19128 (beginning-of-line 1)
19129 (push-mark beg 'nomsg)))
19130 ((and subtreep org-yank-adjusted-subtrees)
19131 (let ((beg (point-at-bol)))
19132 (org-paste-subtree nil nil 'for-yank)
19133 (push-mark beg 'nomsg)))
19134 (t
19135 (call-interactively command))))))
19137 (defun org-yank-folding-would-swallow-text (beg end)
19138 "Would hide-subtree at BEG swallow any text after END?"
19139 (let (level)
19140 (save-excursion
19141 (goto-char beg)
19142 (when (or (looking-at outline-regexp)
19143 (re-search-forward (concat "^" outline-regexp) end t))
19144 (setq level (org-outline-level)))
19145 (goto-char end)
19147 (if (or (eobp)
19148 (and (bolp) (looking-at org-outline-regexp)
19149 (<= (org-outline-level) level)))
19150 nil ; Nothing would be swallowed
19151 t)))) ; something would swallow
19153 (define-key org-mode-map "\C-y" 'org-yank)
19155 (defun org-invisible-p ()
19156 "Check if point is at a character currently not visible."
19157 ;; Early versions of noutline don't have `outline-invisible-p'.
19158 (if (fboundp 'outline-invisible-p)
19159 (outline-invisible-p)
19160 (get-char-property (point) 'invisible)))
19162 (defun org-truely-invisible-p ()
19163 "Check if point is at a character currently not visible.
19164 This version does not only check the character property, but also
19165 `visible-mode'."
19166 ;; Early versions of noutline don't have `outline-invisible-p'.
19167 (if (org-bound-and-true-p visible-mode)
19168 nil
19169 (if (fboundp 'outline-invisible-p)
19170 (outline-invisible-p)
19171 (get-char-property (point) 'invisible))))
19173 (defun org-invisible-p2 ()
19174 "Check if point is at a character currently not visible."
19175 (save-excursion
19176 (if (and (eolp) (not (bobp))) (backward-char 1))
19177 ;; Early versions of noutline don't have `outline-invisible-p'.
19178 (if (fboundp 'outline-invisible-p)
19179 (outline-invisible-p)
19180 (get-char-property (point) 'invisible))))
19182 (defun org-back-to-heading (&optional invisible-ok)
19183 "Call `outline-back-to-heading', but provide a better error message."
19184 (condition-case nil
19185 (outline-back-to-heading invisible-ok)
19186 (error (error "Before first headline at position %d in buffer %s"
19187 (point) (current-buffer)))))
19189 (defun org-beginning-of-defun ()
19190 "Go to the beginning of the subtree, i.e. back to the heading."
19191 (org-back-to-heading))
19192 (defun org-end-of-defun ()
19193 "Go to the end of the subtree."
19194 (org-end-of-subtree nil t))
19196 (defun org-before-first-heading-p ()
19197 "Before first heading?"
19198 (save-excursion
19199 (end-of-line)
19202 (defun org-on-heading-p (&optional ignored)
19203 (outline-on-heading-p t))
19204 (defun org-at-heading-p (&optional ignored)
19205 (outline-on-heading-p t))
19207 (defun org-point-at-end-of-empty-headline ()
19208 "If point is at the end of an empty headline, return t, else nil.
19209 If the heading only contains a TODO keyword, it is still still considered
19210 empty."
19212 (save-excursion
19213 (beginning-of-line 1)
19216 (defun org-at-heading-or-item-p ()
19217 (or (org-on-heading-p) (org-at-item-p)))
19219 (defun org-on-target-p ()
19220 (or (org-in-regexp org-radio-target-regexp)
19221 (org-in-regexp org-target-regexp)))
19223 (defun org-up-heading-all (arg)
19224 "Move to the heading line of which the present line is a subheading.
19225 This function considers both visible and invisible heading lines.
19226 With argument, move up ARG levels."
19227 (if (fboundp 'outline-up-heading-all)
19228 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19229 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19231 (defun org-up-heading-safe ()
19232 "Move to the heading line of which the present line is a subheading.
19233 This version will not throw an error. It will return the level of the
19234 headline found, or nil if no higher level is found.
19236 Also, this function will be a lot faster than `outline-up-heading',
19237 because it relies on stars being the outline starters. This can really
19238 make a significant difference in outlines with very many siblings."
19239 (let (start-level re)
19240 (org-back-to-heading t)
19241 (setq start-level (funcall outline-level))
19242 (if (equal start-level 1)
19243 nil
19245 (if (re-search-backward re nil t)
19246 (funcall outline-level)))))
19248 (defun org-first-sibling-p ()
19249 "Is this heading the first child of its parents?"
19250 (interactive)
19251 (let ((re (concat "^" outline-regexp))
19252 level l)
19253 (unless (org-at-heading-p t)
19254 (error "Not at a heading"))
19255 (setq level (funcall outline-level))
19256 (save-excursion
19257 (if (not (re-search-backward re nil t))
19258 t
19259 (setq l (funcall outline-level))
19260 (< l level)))))
19262 (defun org-goto-sibling (&optional previous)
19263 "Goto the next sibling, even if it is invisible.
19264 When PREVIOUS is set, go to the previous sibling instead. Returns t
19265 when a sibling was found. When none is found, return nil and don't
19266 move point."
19267 (let ((fun (if previous 're-search-backward 're-search-forward))
19268 (pos (point))
19269 (re (concat "^" outline-regexp))
19270 level l)
19271 (when (condition-case nil (org-back-to-heading t) (error nil))
19272 (setq level (funcall outline-level))
19273 (catch 'exit
19274 (or previous (forward-char 1))
19275 (while (funcall fun re nil t)
19276 (setq l (funcall outline-level))
19277 (when (< l level) (goto-char pos) (throw 'exit nil))
19278 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
19279 (goto-char pos)
19280 nil))))
19282 (defun org-show-siblings ()
19283 "Show all siblings of the current headline."
19284 (save-excursion
19285 (while (org-goto-sibling) (org-flag-heading nil)))
19286 (save-excursion
19287 (while (org-goto-sibling 'previous)
19288 (org-flag-heading nil))))
19290 (defun org-goto-first-child ()
19291 "Goto the first child, even if it is invisible.
19292 Return t when a child was found. Otherwise don't move point and
19293 return nil."
19294 (let (level (pos (point)) (re (concat "^" outline-regexp)))
19295 (when (condition-case nil (org-back-to-heading t) (error nil))
19296 (setq level (outline-level))
19297 (forward-char 1)
19298 (if (and (re-search-forward re nil t) (> (outline-level) level))
19299 (progn (goto-char (match-beginning 0)) t)
19300 (goto-char pos) nil))))
19302 (defun org-show-hidden-entry ()
19303 "Show an entry where even the heading is hidden."
19304 (save-excursion
19305 (org-show-entry)))
19307 (defun org-flag-heading (flag &optional entry)
19308 "Flag the current heading. FLAG non-nil means make invisible.
19309 When ENTRY is non-nil, show the entire entry."
19310 (save-excursion
19311 (org-back-to-heading t)
19312 ;; Check if we should show the entire entry
19313 (if entry
19314 (progn
19315 (org-show-entry)
19316 (save-excursion
19317 (and (outline-next-heading)
19318 (org-flag-heading nil))))
19319 (outline-flag-region (max (point-min) (1- (point)))
19320 (save-excursion (outline-end-of-heading) (point))
19321 flag))))
19323 (defun org-get-next-sibling ()
19324 "Move to next heading of the same level, and return point.
19325 If there is no such heading, return nil.
19326 This is like outline-next-sibling, but invisible headings are ok."
19327 (let ((level (funcall outline-level)))
19328 (outline-next-heading)
19329 (while (and (not (eobp)) (> (funcall outline-level) level))
19330 (outline-next-heading))
19331 (if (or (eobp) (< (funcall outline-level) level))
19332 nil
19333 (point))))
19335 (defun org-get-last-sibling ()
19336 "Move to previous heading of the same level, and return point.
19337 If there is no such heading, return nil."
19338 (let ((opoint (point))
19339 (level (funcall outline-level)))
19340 (outline-previous-heading)
19341 (when (and (/= (point) opoint) (outline-on-heading-p t))
19342 (while (and (> (funcall outline-level) level)
19343 (not (bobp)))
19344 (outline-previous-heading))
19345 (if (< (funcall outline-level) level)
19346 nil
19347 (point)))))
19349 (defun org-end-of-subtree (&optional invisible-OK to-heading)
19350 ;; This contains an exact copy of the original function, but it uses
19351 ;; `org-back-to-heading', to make it work also in invisible
19352 ;; trees. And is uses an invisible-OK argument.
19353 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
19354 ;; Furthermore, when used inside Org, finding the end of a large subtree
19355 ;; with many children and grandchildren etc, this can be much faster
19356 ;; than the outline version.
19357 (org-back-to-heading invisible-OK)
19358 (let ((first t)
19359 (level (funcall outline-level)))
19360 (if (and (org-mode-p) (< level 1000))
19361 ;; A true heading (not a plain list item), in Org-mode
19362 ;; This means we can easily find the end by looking
19363 ;; only for the right number of stars. Using a regexp to do
19364 ;; this is so much faster than using a Lisp loop.
19366 (forward-char 1)
19367 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
19368 ;; something else, do it the slow way
19369 (while (and (not (eobp))
19370 (or first (> (funcall outline-level) level)))
19371 (setq first nil)
19372 (outline-next-heading)))
19373 (unless to-heading
19375 (progn
19376 ;; Go to end of line before heading
19377 (forward-char -1)
19379 ;; leave blank line before heading
19380 (forward-char -1))))))
19381 (point))
19383 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
19384 "Use Org version in org-mode, for dramatic speed-up."
19385 (if (eq major-mode 'org-mode)
19386 (progn
19387 (org-end-of-subtree nil t)
19388 (unless (eobp) (backward-char 1)))
19389 ad-do-it))
19391 (defun org-forward-same-level (arg &optional invisible-ok)
19392 "Move forward to the arg'th subheading at same level as this one.
19393 Stop at the first and last subheadings of a superior heading.
19394 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
19395 it wil also look at invisible ones."
19396 (interactive "p")
19397 (org-back-to-heading invisible-ok)
19398 (org-on-heading-p)
19399 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19401 l)
19402 (forward-char 1)
19403 (while (> arg 0)
19404 (while (and (re-search-forward re nil 'move)
19405 (setq l (- (match-end 0) (match-beginning 0) 1))
19406 (= l level)
19407 (not invisible-ok)
19408 (progn (backward-char 1) (org-invisible-p)))
19409 (if (< l level) (setq arg 1)))
19410 (setq arg (1- arg)))
19411 (beginning-of-line 1)))
19413 (defun org-backward-same-level (arg &optional invisible-ok)
19414 "Move backward to the arg'th subheading at same level as this one.
19415 Stop at the first and last subheadings of a superior heading."
19416 (interactive "p")
19417 (org-back-to-heading)
19418 (org-on-heading-p)
19419 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19421 l)
19422 (while (> arg 0)
19423 (while (and (re-search-backward re nil 'move)
19424 (setq l (- (match-end 0) (match-beginning 0) 1))
19425 (= l level)
19426 (not invisible-ok)
19427 (org-invisible-p))
19428 (if (< l level) (setq arg 1)))
19429 (setq arg (1- arg)))))
19431 (defun org-show-subtree ()
19432 "Show everything after this heading at deeper levels."
19433 (outline-flag-region
19434 (point)
19435 (save-excursion
19436 (org-end-of-subtree t t))
19437 nil))
19439 (defun org-show-entry ()
19440 "Show the body directly following this heading.
19441 Show the heading too, if it is currently invisible."
19442 (interactive)
19443 (save-excursion
19444 (condition-case nil
19445 (progn
19446 (org-back-to-heading t)
19447 (outline-flag-region
19448 (max (point-min) (1- (point)))
19449 (save-excursion
19450 (if (re-search-forward
19452 (match-beginning 1)
19453 (point-max)))
19454 nil)
19455 (org-cycle-hide-drawers 'children))
19456 (error nil))))
19458 (defun org-make-options-regexp (kwds &optional extra)
19459 "Make a regular expression for keyword lines."
19460 (concat
19461 "^"
19468 ;; Make isearch reveal the necessary context
19469 (defun org-isearch-end ()
19470 "Reveal context after isearch exits."
19471 (when isearch-success ; only if search was successful
19472 (if (featurep 'xemacs)
19473 ;; Under XEmacs, the hook is run in the correct place,
19474 ;; we directly show the context.
19475 (org-show-context 'isearch)
19476 ;; In Emacs the hook runs *before* restoring the overlays.
19477 ;; So we have to use a one-time post-command-hook to do this.
19478 ;; (Emacs 22 has a special variable, see function `org-mode')
19479 (unless (and (boundp 'isearch-mode-end-hook-quit)
19480 isearch-mode-end-hook-quit)
19481 ;; Only when the isearch was not quitted.
19482 (org-add-hook 'post-command-hook 'org-isearch-post-command
19483 'append 'local)))))
19485 (defun org-isearch-post-command ()
19486 "Remove self from hook, and show context."
19487 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
19488 (org-show-context 'isearch))
19491 ;;;; Integration with and fixes for other packages
19493 ;;; Imenu support
19495 (defvar org-imenu-markers nil
19496 "All markers currently used by Imenu.")
19497 (make-variable-buffer-local 'org-imenu-markers)
19499 (defun org-imenu-new-marker (&optional pos)
19500 "Return a new marker for use by Imenu, and remember the marker."
19501 (let ((m (make-marker)))
19502 (move-marker m (or pos (point)))
19503 (push m org-imenu-markers)
19504 m))
19506 (defun org-imenu-get-tree ()
19507 "Produce the index for Imenu."
19508 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
19509 (setq org-imenu-markers nil)
19510 (let* ((n org-imenu-depth)
19511 (re (concat "^" outline-regexp))
19512 (subs (make-vector (1+ n) nil))
19513 (last-level 0)
19514 m level head)
19515 (save-excursion
19516 (save-restriction
19517 (widen)
19518 (goto-char (point-max))
19519 (while (re-search-backward re nil t)
19520 (setq level (org-reduced-level (funcall outline-level)))
19521 (when (<= level n)
19522 (looking-at org-complex-heading-regexp)
19523 (setq head (org-link-display-format
19524 (org-match-string-no-properties 4))
19525 m (org-imenu-new-marker))
19526 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
19527 (if (>= level last-level)
19528 (push (cons head m) (aref subs level))
19529 (push (cons head (aref subs (1+ level))) (aref subs level))
19530 (loop for i from (1+ level) to n do (aset subs i nil)))
19531 (setq last-level level)))))
19532 (aref subs 1)))
19534 (eval-after-load "imenu"
19535 '(progn
19536 (add-hook 'imenu-after-jump-hook
19537 (lambda ()
19538 (if (eq major-mode 'org-mode)
19539 (org-show-context 'org-goto))))))
19541 (defun org-link-display-format (link)
19542 "Replace a link with either the description, or the link target
19543 if no description is present"
19544 (save-match-data
19545 (if (string-match org-bracket-link-analytic-regexp link)
19546 (replace-match (if (match-end 5)
19547 (match-string 5 link)
19548 (concat (match-string 1 link)
19549 (match-string 3 link)))
19550 nil t link)
19551 link)))
19553 ;; Speedbar support
19555 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
19556 "Overlay marking the agenda restriction line in speedbar.")
19557 (overlay-put org-speedbar-restriction-lock-overlay
19558 'face 'org-agenda-restriction-lock)
19559 (overlay-put org-speedbar-restriction-lock-overlay
19560 'help-echo "Agendas are currently limited to this item.")
19561 (org-detach-overlay org-speedbar-restriction-lock-overlay)
19563 (defun org-speedbar-set-agenda-restriction ()
19564 "Restrict future agenda commands to the location at point in speedbar.
19566 (interactive)
19567 (require 'org-agenda)
19568 (let (p m tp np dir txt)
19569 (cond
19570 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19571 'org-imenu t))
19572 (setq m (get-text-property p 'org-imenu-marker))
19573 (with-current-buffer (marker-buffer m)
19574 (goto-char m)
19575 (org-agenda-set-restriction-lock 'subtree)))
19576 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19577 'speedbar-function 'speedbar-find-file))
19578 (setq tp (previous-single-property-change
19579 (1+ p) 'speedbar-function)
19580 np (next-single-property-change
19581 tp 'speedbar-function)
19582 dir (speedbar-line-directory)
19583 txt (buffer-substring-no-properties (or tp (point-min))
19584 (or np (point-max))))
19585 (with-current-buffer (find-file-noselect
19586 (let ((default-directory dir))
19587 (expand-file-name txt)))
19588 (unless (org-mode-p)
19589 (error "Cannot restrict to non-Org-mode file"))
19590 (org-agenda-set-restriction-lock 'file)))
19591 (t (error "Don't know how to restrict Org-mode's agenda")))
19592 (move-overlay org-speedbar-restriction-lock-overlay
19593 (point-at-bol) (point-at-eol))
19594 (setq current-prefix-arg nil)
19595 (org-agenda-maybe-redo)))
19597 (eval-after-load "speedbar"
19598 '(progn
19599 (speedbar-add-supported-extension ".org")
19600 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
19601 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
19602 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
19603 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19604 (add-hook 'speedbar-visiting-tag-hook
19605 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
19607 ;;; Fixes and Hacks for problems with other packages
19609 ;; Make flyspell not check words in links, to not mess up our keymap
19610 (defun org-mode-flyspell-verify ()
19611 "Don't let flyspell put overlays at active buttons."
19612 (and (not (get-text-property (max (1- (point)) (point-min)) 'keymap))
19613 (not (get-text-property (max (1- (point)) (point-min)) 'org-no-flyspell))))
19615 (defun org-remove-flyspell-overlays-in (beg end)
19616 "Remove flyspell overlays in region."
19617 (and (org-bound-and-true-p flyspell-mode)
19618 (fboundp 'flyspell-delete-region-overlays)
19619 (flyspell-delete-region-overlays beg end))
19620 (add-text-properties beg end '(org-no-flyspell t)))
19622 ;; Make `bookmark-jump' shows the jump location if it was hidden.
19623 (eval-after-load "bookmark"
19624 '(if (boundp 'bookmark-after-jump-hook)
19625 ;; We can use the hook
19626 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
19627 ;; Hook not available, use advice
19628 (defadvice bookmark-jump (after org-make-visible activate)
19629 "Make the position visible."
19630 (org-bookmark-jump-unhide))))
19632 ;; Make sure saveplace shows the location if it was hidden
19633 (eval-after-load "saveplace"
19634 '(defadvice save-place-find-file-hook (after org-make-visible activate)
19635 "Make the position visible."
19636 (org-bookmark-jump-unhide)))
19638 ;; Make sure ecb shows the location if it was hidden
19639 (eval-after-load "ecb"
19640 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
19641 "Make hierarchy visible when jumping into location from ECB tree buffer."
19642 (if (eq major-mode 'org-mode)
19643 (org-show-context))))
19645 (defun org-bookmark-jump-unhide ()
19646 "Unhide the current position, to show the bookmark location."
19647 (and (org-mode-p)
19648 (or (org-invisible-p)
19649 (save-excursion (goto-char (max (point-min) (1- (point))))
19650 (org-invisible-p)))
19651 (org-show-context 'bookmark-jump)))
19653 ;; Make session.el ignore our circular variable
19654 (eval-after-load "session"
19655 '(add-to-list 'session-globals-exclude 'org-mark-ring))
19657 ;;;; Experimental code
19659 (defun org-closed-in-range ()
19660 "Sparse tree of items closed in a certain time range.
19661 Still experimental, may disappear in the future."
19662 (interactive)
19663 ;; Get the time interval from the user.
19664 (let* ((time1 (org-float-time
19665 (org-read-date nil 'to-time nil "Starting date: ")))
19666 (time2 (org-float-time
19667 (org-read-date nil 'to-time nil "End date:")))
19668 ;; callback function
19669 (callback (lambda ()
19670 (let ((time
19671 (org-float-time
19672 (apply 'encode-time
19673 (org-parse-time-string
19674 (match-string 1))))))
19675 ;; check if time in interval
19676 (and (>= time time1) (<= time time2))))))
19677 ;; make tree, check each match with the callback
19680 ;;;; Finish up
19682 (provide 'org)
19684 (run-hooks 'org-load-hook)
19686 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
19688 ;;; org.el ends here