| blob | 9e9cf83955c40c98fe9563bc498348866cb468de |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.3
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
28 ;;
29 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
30 ;; project planning with a fast and effective plain-text system.
31 ;;
32 ;; Org-mode develops organizational tasks around NOTES files that contain
33 ;; information about projects as plain text. Org-mode is implemented on
34 ;; top of outline-mode, which makes it possible to keep the content of
35 ;; large files well structured. Visibility cycling and structure editing
36 ;; help to work with the tree. Tables are easily created with a built-in
37 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
38 ;; and scheduling. It dynamically compiles entries into an agenda that
39 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
40 ;; Plain text URL-like links connect to websites, emails, Usenet
41 ;; messages, BBDB entries, and any files related to the projects. For
42 ;; printing and sharing of notes, an Org-mode file can be exported as a
43 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
44 ;; iCalendar file. It can also serve as a publishing tool for a set of
45 ;; linked webpages.
46 ;;
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
50 ;;
51 ;; http://orgmode.org/org.html#Installation
52 ;;
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org-mode can be found in the TeXInfo file. The
56 ;; distribution also contains a PDF version of it. At the homepage of
57 ;; Org-mode, you can read the same text online as HTML. There is also an
58 ;; excellent reference card made by Philip Rooke. This card can be found
59 ;; in the etc/ directory of Emacs 22.
60 ;;
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
63 ;;
64 ;;; Code:
71 ;;;; Require other packages
79 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
91 ;; Other stuff we need.
106 ;; babel
115 ;; load languages based on value of `org-babel-load-languages'
117 ;;;###autoload
119 "Load the languages defined in `org-babel-load-languages'."
131 org-babel-load-languages))
134 "Languages which can be evaluated in Org-mode buffers.
135 This list can be used to load support for any of the languages
136 below, note that each language will depend on a different set of
137 system executables and/or Emacs modes. When a language is
139 with `org-babel-execute-src-block' bound by default to C-c
140 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
141 be set to remove code block evaluation from the C-c C-c
142 keybinding. By default only Emacs Lisp (which has no
143 requirements) is loaded."
147 :key-type
180 ;;;; Customization variables
182 "Remove ID property of clones of a subtree.
183 When non-nil, clones of a subtree don't inherit the ID property.
184 Otherwise they inherit the ID property with a new unique
185 identifier."
189 ;;; Version
195 "Show the org-mode version in the echo area.
196 With prefix arg HERE, insert it at point."
222 ;;; Compatibility constants
224 ;;; The custom variables
227 "Outline-based notes management and organizer."
233 "Mode hook for Org-mode, run after the mode was turned on."
238 "Hook that is run after org.el has been loaded."
247 "Load all extensions listed in `org-modules'."
252 org-modules)
256 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
265 (defcustom org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
266 "Modules that should always be loaded together with org.el.
267 If a description starts with <C>, the file is not part of Emacs
268 and loading it will require that you have downloaded and properly installed
269 the org-mode distribution.
271 You can also use this system to load external packages (i.e. neither Org
272 core modules, nor modules from the CONTRIB directory). Just add symbols
273 to the end of the list. If the package is called org-xyz.el, then you need
274 to add the symbol `xyz', and the package must have a call to
276 (provide 'org-xyz)"
279 :type
309 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
316 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
324 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
341 "Non-nil means make shift-cursor commands select text when possible.
343 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
344 selecting a region, or enlarge regions started in this way.
345 In Org-mode, in special contexts, these same keys are used for other
346 purposes, important enough to compete with shift selection. Org tries
347 to balance these needs by supporting `shift-select-mode' outside these
348 special contexts, under control of this variable.
350 The default of this variable is nil, to avoid confusing behavior. Shifted
351 cursor keys will then execute Org commands in the following contexts:
352 - on a headline, changing TODO state (left/right) and priority (up/down)
353 - on a time stamp, changing the time
354 - in a plain list item, changing the bullet type
355 - in a property definition line, switching between allowed values
356 - in the BEGIN line of a clock table (changing the time block).
357 Outside these contexts, the commands will throw an error.
359 When this variable is t and the cursor is not in a special context,
360 Org-mode will support shift-selection for making and enlarging regions.
361 To make this more effective, the bullet cycling will no longer happen
362 anywhere in an item line, but only if the cursor is exactly on the bullet.
364 If you set this variable to the symbol `always', then the keys
365 will not be special in headlines, property lines, and item lines, to make
366 shift selection work there as well. If this is what you want, you can
367 use the following alternative commands: `C-c C-t' and `C-c ,' to
368 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
369 TODO sets, `C-c -' to cycle item bullet types, and properties can be
370 edited by hand or in column view.
372 However, when the cursor is on a timestamp, shift-cursor commands
373 will still edit the time stamp - this is just too good to give up.
375 XEmacs user should have this variable set to nil, because shift-select-mode
376 is Emacs 23 only."
384 "Options concerning startup of Org-mode."
389 "Non-nil means entering Org-mode will switch to OVERVIEW.
390 This can also be configured on a per-file basis by adding one of
391 the following lines anywhere in the buffer:
393 #+STARTUP: fold (or `overview', this is equivalent)
394 #+STARTUP: nofold (or `showall', this is equivalent)
395 #+STARTUP: content
396 #+STARTUP: showeverything"
405 "Non-nil means entering Org-mode will set `truncate-lines'.
406 This is useful since some lines containing links can be very long and
407 uninteresting. Also tables look terrible when wrapped."
412 "Non-nil means turn on `org-indent-mode' on startup.
413 This can also be configured on a per-file basis by adding one of
414 the following lines anywhere in the buffer:
416 #+STARTUP: indent
417 #+STARTUP: noindent"
425 When this option is turned on, you can use TeX-like syntax for sub- and
427 considered as a single item - so grouping with {} is normally not
428 needed. For example, the following things will be parsed as single
429 sub- or superscripts.
431 10^24 or 10^tau several digits will be considered 1 item.
432 10^-12 or 10^-tau a leading sign with digits or a word
433 x^2-y^3 will be read as x^2 - y^3, because items are
434 terminated by almost any nonword/nondigit char.
435 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
437 Still, ambiguity is possible - so when in doubt use {} to enclose the
438 sub/superscript. If you set this variable to the symbol `{}',
439 the braces are *required* in order to trigger interpretations as
441 frequently in plain text.
443 Not all export backends support this, but HTML does.
458 "Non-nil means turn on `org-beamer-mode' on startup.
459 This can also be configured on a per-file basis by adding one of
460 the following lines anywhere in the buffer:
462 #+STARTUP: beamer"
467 "Non-nil means align all tables when visiting a file.
468 This is useful when the column width in tables is forced with <N> cookies
469 in table fields. Such tables will look correct only after the first re-align.
470 This can also be configured on a per-file basis by adding one of
471 the following lines anywhere in the buffer:
472 #+STARTUP: align
473 #+STARTUP: noalign"
478 "Non-nil means show inline images when loading a new Org file.
479 This can also be configured on a per-file basis by adding one of
480 the following lines anywhere in the buffer:
481 #+STARTUP: inlineimages
482 #+STARTUP: noinlineimages"
487 "Non-nil means insert the first line setting Org-mode in empty files.
488 When the function `org-mode' is called interactively in an empty file, this
489 normally means that the file name does not automatically trigger Org-mode.
490 To ensure that the file will always be in Org-mode in the future, a
491 line enforcing Org-mode will be inserted into the buffer, if this option
492 has been set."
497 "Non-nil means use alternative key bindings for some keys.
498 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
499 These keys are also used by other packages like shift-selection-mode'
500 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
501 If you want to use Org-mode together with one of these other modes,
502 or more generally if you would like to move some Org-mode commands to
503 other keys, set this variable and configure the keys with the variable
504 `org-disputed-keys'.
506 This option is only relevant at load-time of Org-mode, and must be set
507 *before* org.el is loaded. Changing it requires a restart of Emacs to
508 become effective."
513 "Non-nil means use extra key sequence definitions for certain commands.
514 This happens automatically if you run XEmacs or if `window-system'
515 is nil. This variable lets you do the same manually. You must
516 set it before loading org.
518 Example: on Carbon Emacs 22 running graphically, with an external
519 keyboard on a Powerbook, the default way of setting M-left might
520 not work for either Alt or ESC. Setting this variable will make
521 it work for ESC."
535 "Keys for which Org-mode and other modes compete.
536 This is an alist, cars are the default keys, second element specifies
537 the alternative to use when `org-replace-disputed-keys' is t.
539 Keys can be specified in any syntax supported by `define-key'.
540 The value of this option takes effect only at Org-mode's startup,
541 therefore you'll have to restart Emacs to apply it after changing."
546 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
547 Or return the original if not disputed.
548 Also apply the translations defined in `org-xemacs-key-equivalents'."
553 org-disputed-keys)))
557 key)
567 "Define a key, possibly translated, as returned by `org-key'."
571 "The ellipsis to use in the Org-mode outline.
572 When nil, just use the standard three dots. When a string, use that instead,
573 When a face, use the standard 3 dots, but with the specified face.
574 The change affects only Org-mode (which will then use its own display table).
575 Changing this requires executing `M-x org-mode' in a buffer to become
576 effective."
586 "Keywords in Org-mode."
591 "String to mark deadline entries.
592 A deadline is this string, followed by a time stamp. Should be a word,
593 terminated by a colon. You can insert a schedule keyword and
595 Changes become only effective after restarting Emacs."
600 "String to mark scheduled TODO entries.
601 A schedule is this string, followed by a time stamp. Should be a word,
602 terminated by a colon. You can insert a schedule keyword and
604 Changes become only effective after restarting Emacs."
609 "String used as the prefix for timestamps logging closing a TODO entry."
614 "String used as prefix for timestamps clocking work hours on an item."
619 "Entries starting with this keyword will never be exported.
620 An entry can be toggled between COMMENT and normal with
622 Changes become only effective after restarting Emacs."
627 "Entries starting with this keyword will be exported in fixed-width font.
628 Quoting applies only to the text in the entry following the headline, and does
629 not extend beyond the next headline, even if that is lower level.
630 An entry can be toggled between QUOTE and normal with
637 "Regular expression for specifying repeated events.
641 "Options concerning the general structure of Org-mode files."
646 "Options about how to make context of a location visible."
670 "Non-nil means show full hierarchy when revealing a location.
671 Org-mode often shows locations in an org-mode file which might have
672 been invisible before. When this is set, the hierarchy of headings
673 above the exposed location is shown.
674 Turning this off for example for sparse trees makes them very compact.
675 Instead of t, this can also be an alist specifying this option for different
676 contexts. Valid contexts are
677 agenda when exposing an entry from the agenda
678 org-goto when using the command `org-goto' on key C-c C-j
679 occur-tree when using the command `org-occur' on key C-c /
680 tags-tree when constructing a sparse tree based on tags matches
681 link-search when exposing search matches associated with a link
682 mark-goto when exposing the jump goal of a mark
683 bookmark-jump when exposing a bookmark location
684 isearch when exiting from an incremental search
685 default default for all contexts not set explicitly"
690 "Non-nil means show following heading when revealing a location.
691 Org-mode often shows locations in an org-mode file which might have
692 been invisible before. When this is set, the heading following the
693 match is shown.
694 Turning this off for example for sparse trees makes them very compact,
695 but makes it harder to edit the location of the match. In such a case,
697 Instead of t, this can also be an alist specifying this option for different
698 contexts. See `org-show-hierarchy-above' for valid contexts."
703 "Non-nil means show all sibling heading when revealing a location.
704 Org-mode often shows locations in an org-mode file which might have
705 been invisible before. When this is set, the sibling of the current entry
706 heading are all made visible. If `org-show-hierarchy-above' is t,
707 the same happens on each level of the hierarchy above the current entry.
709 By default this is on for the isearch context, off for all other contexts.
710 Turning this off for example for sparse trees makes them very compact,
711 but makes it harder to edit the location of the match. In such a case,
713 Instead of t, this can also be an alist specifying this option for different
714 contexts. See `org-show-hierarchy-above' for valid contexts."
719 "Non-nil means show the entry below a headline when revealing a location.
720 Org-mode often shows locations in an org-mode file which might have
721 been invisible before. When this is set, the text below the headline that is
722 exposed is also shown.
724 By default this is off for all contexts.
725 Instead of t, this can also be an alist specifying this option for different
726 contexts. See `org-show-hierarchy-above' for valid contexts."
731 "How should indirect tree buffers be displayed?
732 This applies to indirect buffers created with the commands
734 Valid values are:
735 current-window Display in the current window
736 other-window Just display in another window.
737 dedicated-frame Create one new frame, and re-use it each time.
738 new-frame Make a new frame each time. Note that in this case
739 previously-made indirect buffers are kept, and you need to
740 kill these buffers yourself."
750 "Non-nil means activate single letter commands at beginning of a headline.
751 This may also be a function to test for appropriate locations where speed
752 commands should be active."
760 "Alist of additional speed commands.
761 This list will be checked before `org-speed-commands-default'
762 when the variable `org-use-speed-commands' is non-nil
763 and when the cursor is at the beginning of a headline.
764 The car if each entry is a string with a single letter, which must
765 be assigned to `self-insert-command' in the global map.
766 The cdr is either a command to be called interactively, a function
767 to be called, or a form to be evaluated.
768 An entry that is just a list with a single string will be interpreted
769 as a descriptive headline that will be added when listing the speed
770 commands in the Help buffer using the `?' speed command."
782 "Options concerning visibility cycling in Org-mode."
787 "Non-nil means skip CHILDREN state in entries that don't have any."
792 "Maximum level which should still be subject to visibility cycling.
793 Levels higher than this will, for cycling, be treated as text, not a headline.
794 When `org-odd-levels-only' is set, a value of N in this variable actually
795 means 2N-1 stars as the limiting headline.
796 When nil, cycle all levels.
797 Note that the limiting level of cycling is also influenced by
798 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
799 `org-inlinetask-min-level' is, cycling will be limited to levels one less
800 than its value."
807 "Names of drawers. Drawers are not opened by cycling on the headline above.
808 Drawers only open with a TAB on the drawer line itself. A drawer looks like
809 this:
810 :DRAWERNAME:
811 .....
812 :END:
814 the property API.
816 Drawers can be defined on the per-file basis with a line like:
818 #+DRAWERS: HIDDEN STATE PROPERTIES"
824 "Non-nil means entering Org-mode will fold all blocks.
825 This can also be set in on a per-file basis with
827 #+STARTUP: hideblocks
828 #+STARTUP: showblocks"
834 "Cycle globally if cursor is at beginning of buffer and not at a headline.
835 This makes it possible to do global cycling without having to use S-TAB or
837 of the buffer
838 must not be a headline - it may be empty or some other text. When used in
839 this way, `org-cycle-hook' is disables temporarily, to make sure the
840 cursor stays at the beginning of the buffer.
841 When this option is nil, don't do anything special at the beginning
842 of the buffer."
847 "Non-nil means cycle entry level or item indentation in new empty entries.
849 When the cursor is at the end of an empty headline, i.e with only stars
850 and maybe a TODO keyword, TAB will then switch the entry to become a child,
851 and then all possible ancestor states, before returning to the original state.
852 This makes data entry extremely fast: M-RET to create a new headline,
853 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
855 When the cursor is at the end of an empty plain list item, one TAB will
856 make it a subitem, two or more tabs will back up to make this an item
857 higher up in the item hierarchy."
862 "Where should `org-cycle' emulate TAB.
863 nil Never
864 white Only in completely white lines
865 whitestart Only at the beginning of lines, before the first non-white char
866 t Everywhere except in headlines
867 exc-hl-bol Everywhere except at the start of a headline
868 If TAB is used in a place where it does not emulate TAB, the current subtree
869 visibility is cycled."
876 ))
879 "Number of empty lines needed to keep an empty line between collapsed trees.
880 If you leave an empty line between the end of a subtree and the following
881 headline, this empty line is hidden when the subtree is folded.
882 Org-mode will leave (exactly) one empty line visible if the number of
883 empty lines is equal or larger to the number given in this variable.
884 So the default 2 means at least 2 empty lines after the end of a subtree
885 are needed to produce free space between a collapsed subtree and the
886 following headline.
888 If the number is negative, and the number of empty lines is at least -N,
889 all empty lines are shown.
891 Special case: when 0, never leave empty lines in collapsed view."
897 "Hook that is run before visibility cycling is happening.
898 The function(s) in this hook must accept a single argument which indicates
899 the new state that will be set right after running this hook. The
900 argument is a symbol. Before a global state change, it can have the values
901 `overview', `content', or `all'. Before a local state change, it can have
902 the values `folded', `children', or `subtree'."
907 org-cycle-hide-drawers
908 org-cycle-show-empty-lines
909 org-optimize-window-after-visibility-change)
910 "Hook that is run after `org-cycle' has changed the buffer visibility.
911 The function(s) in this hook must accept a single argument which indicates
912 the new state that was set by the most recent `org-cycle' command. The
913 argument is a symbol. After a global state change, it can have the values
914 `overview', `content', or `all'. After a local state change, it can have
915 the values `folded', `children', or `subtree'."
920 "Options concerning structure editing in Org-mode."
925 "Non-nil means skip even levels and only use odd levels for the outline.
926 This has the effect that two stars are being added/taken away in
927 promotion/demotion commands. It also influences how levels are
928 handled by the exporters.
929 Changing it requires restart of `font-lock-mode' to become effective
930 for fontification also in regions already fontified.
931 You may also set this on a per-file basis by adding one of the following
932 lines to the buffer:
934 #+STARTUP: odd
935 #+STARTUP: oddeven"
941 "Non-nil means adapt indentation to outline node level.
943 When this variable is set, Org assumes that you write outlines by
944 indenting text in each node to align with the headline (after the stars).
945 The following issues are influenced by this variable:
947 - When this is set and the *entire* text in an entry is indented, the
948 indentation is increased by one space in a demotion command, and
949 decreased by one in a promotion command. If any line in the entry
950 body starts with text at column 0, indentation is not changed at all.
952 - Property drawers and planning information is inserted indented when
953 this variable s set. When nil, they will not be indented.
955 - TAB indents a line relative to context. The lines below a headline
956 will be indented when this variable is set.
958 Note that this is all about true indentation, by adding and removing
959 space characters. See also `org-indent.el' which does level-dependent
960 indentation in a virtual way, i.e. at display time in Emacs."
965 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
967 When t, `C-a' will bring back the cursor to the beginning of the
968 headline text, i.e. after the stars and after a possible TODO keyword.
969 In an item, this will be the position after the bullet.
970 When the cursor is already at that position, another `C-a' will bring
971 it to the beginning of the line.
973 `C-e' will jump to the end of the headline, ignoring the presence of tags
974 in the headline. A second `C-e' will then jump to the true end of the
975 line, after any tags. This also means that, when this variable is
976 non-nil, `C-e' also will never jump beyond the end of the heading of a
977 folded section, i.e. not after the ellipses.
979 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
980 going to the true line boundary first. Only a directly following, identical
981 keypress will bring the cursor to the special positions.
983 This may also be a cons cell where the behavior for `C-a' and `C-e' is
984 set separately."
1003 "Non-nil means `C-k' will behave specially in headlines.
1004 When nil, `C-k' will call the default `kill-line' command.
1005 When t, the following will happen while the cursor is in the headline:
1007 - When the cursor is at the beginning of a headline, kill the entire
1008 line and possible the folded subtree below the line.
1009 - When in the middle of the headline text, kill the headline up to the tags.
1010 - When after the headline text, kill the tags."
1015 "Non-nil means, do not delete a hidden subtree with C-k.
1016 When set to the symbol `error', simply throw an error when C-k is
1017 used to kill (part-of) a headline that has hidden text behind it.
1018 Any other non-nil value will result in a query to the user, if it is
1019 OK to kill that hidden subtree. When nil, kill without remorse."
1027 "Non-nil means when yanking subtrees, fold them.
1028 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1029 it starts with a heading and all other headings in it are either children
1030 or siblings, then fold all the subtrees. However, do this only if no
1031 text after the yank would be swallowed into a folded tree by this action."
1036 "Non-nil means when yanking subtrees, adjust the level.
1037 With this setting, `org-paste-subtree' is used to insert the subtree, see
1038 this function for details."
1043 "Non-nil means M-RET will split the line at the cursor position.
1044 When nil, it will go to the end of the line before making a
1045 new line.
1046 You may also set this option in a different way for different
1047 contexts. Valid contexts are:
1049 headline when creating a new headline
1050 item when creating a new item
1051 table in a table field
1052 default the value to be used for all contexts not explicitly
1053 customized"
1070 "Non-nil means insert new headings after the current subtree.
1071 When nil, the new heading is created directly after the current line.
1074 for the duration of the command."
1080 "Should `org-insert-heading' leave a blank line before new heading/item?
1081 The value is an alist, with `heading' and `plain-list-item' as car,
1082 and a boolean flag as cdr. The cdr may lso be the symbol `auto', and then
1083 Org will look at the surrounding headings/items and try to make an
1084 intelligent decision wether to insert a blank line or not.
1086 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1087 set, the setting here is ignored and no empty line is inserted, to avoid
1088 breaking the list structure."
1101 "Hook being run after inserting a new heading."
1107 This currently only means they are never auto-wrapped.
1108 When nil, such lines will be treated like ordinary lines.
1109 See also the QUOTE keyword."
1114 "Non-nil means typing characters in `org-goto' starts incremental search."
1119 "Options concerning sparse trees in Org-mode."
1124 "Non-nil means highlight all matches that define a sparse tree.
1125 The highlights will automatically disappear the next time the buffer is
1126 changed by an edit command."
1131 "Non-nil means any change to the buffer will remove temporary highlights.
1132 Such highlights are created by `org-occur' and `org-clock-display'.
1133 When nil, `C-c C-c needs to be used to get rid of the highlights.
1134 The highlights created by `org-preview-latex-fragment' always need
1135 `C-c C-c' to be removed."
1142 "Hook that is run after `org-occur' has constructed a sparse tree.
1143 This can be used to recenter the window to show as much of the structure
1144 as possible."
1149 "Options concerning imenu and speedbar in Org-mode."
1154 "The maximum level for Imenu access to Org-mode headlines.
1155 This also applied for speedbar access."
1160 "Options concerning tables in Org-mode."
1166 When nil, such lines will be treated like ordinary lines.
1168 When equal to the symbol `optimized', the table editor will be optimized to
1169 do the following:
1170 - Automatic overwrite mode in front of whitespace in table fields.
1171 This makes the structure of the table stay in tact as long as the edited
1172 field does not exceed the column width.
1173 - Minimize the number of realigns. Normally, the table is aligned each time
1174 TAB or RET are pressed to move to another field. With optimization this
1175 happens only if changes to a field might have changed the column width.
1176 Optimization requires replacing the functions `self-insert-command',
1177 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1178 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1179 very good at guessing when a re-align will be necessary, but you can always
1182 If you would like to use the optimized version in Org-mode, but the
1183 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1185 This variable can be used to turn on and off the table editor during a session,
1186 but in order to toggle optimization, a restart is required.
1188 See also the variable `org-table-auto-blank-field'."
1196 "Non-nil means cluster self-insert commands for undo when possible.
1197 If this is set, then, like in the Emacs command loop, 20 consecutive
1198 characters will be undone together.
1199 This is configurable, because there is some impact on typing performance."
1204 "Non-nil means TAB will automatically notice a table.el table.
1205 When it sees such a table, it moves point into it and - if necessary -
1206 calls `table-recognize-table'."
1211 "Options concerning links in Org-mode."
1216 "Buffer-local version of `org-link-abbrev-alist', which see.
1221 "Alist of link abbreviations.
1222 The car of each element is a string, to be replaced at the start of a link.
1224 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1226 [[linkkey:tag][description]]
1228 The 'linkkey' must be a word word, starting with a letter, followed
1229 by letters, numbers, '-' or '_'.
1231 If REPLACE is a string, the tag will simply be appended to create the link.
1234 be inserted at that point (see the function `url-hexify-string').
1236 REPLACE may also be a function that will be called with the tag as the
1237 only argument to create the link, which should be returned as a string.
1239 See the manual for examples."
1249 "Non-nil means hide link part and only show description of bracket links.
1250 Bracket links are like [[link][description]]. This variable sets the initial
1251 state in new org-mode buffers. The setting can then be toggled on a
1252 per-buffer basis from the Org->Hyperlinks menu."
1257 "How the path name in file links should be stored.
1258 Valid values are:
1260 relative Relative to the current directory, i.e. the directory of the file
1261 into which the link is being inserted.
1262 absolute Absolute path, if possible with ~ for home directory.
1263 noabbrev Absolute path, no abbreviation of home directory.
1264 adaptive Use relative path for files in the current directory and sub-
1265 directories of it. For other files, use an absolute path."
1274 "Types of links that should be activated in Org-mode files.
1275 This is a list of symbols, each leading to the activation of a certain link
1276 type. In principle, it does not hurt to turn on most link types - there may
1277 be a small gain when turning off unused link types. The types are:
1279 bracket The recommended [[link][description]] or [[link]] links with hiding.
1280 angle Links in angular brackets that may contain whitespace like
1281 <bbdb:Carsten Dominik>.
1282 plain Plain links in normal text, no whitespace, like http://google.com.
1283 radio Text that is matched by a radio target, see manual for details.
1284 tag Tag settings in a headline (link to tag search).
1285 date Time stamps (link to calendar).
1286 footnote Footnote labels.
1288 Changing this variable requires a restart of Emacs to become effective."
1300 "Function to use to generate link descriptions from links.
1301 If nil the link location will be used. This function must take
1302 two parameters; the first is the link and the second the
1303 description `org-insert-link' has generated, and should return the
1304 description to use."
1309 "Options concerning storing links in Org-mode."
1314 "Format of the description part of a link to an email or usenet message.
1315 The following %-escapes will be replaced by corresponding information:
1323 %s subject
1324 %m message-id.
1326 You may use normal field width specification between the % and the letter.
1327 This is for example useful to limit the length of the subject.
1341 It should match if the message is from the user him/herself."
1346 "Non-nil means storing a link to an Org file will use entry IDs.
1348 Note that before this variable is even considered, org-id must be loaded,
1349 so please customize `org-modules' and turn it on.
1351 The variable can have the following values:
1353 t Create an ID if needed to make a link to the current entry.
1355 create-if-interactive
1356 If `org-store-link' is called directly (interactively, as a user
1357 command), do create an ID to support the link. But when doing the
1358 job for remember, only use the ID if it already exists. The
1359 purpose of this setting is to avoid proliferation of unwanted
1360 IDs, just because you happen to be in an Org file when you
1361 call `org-remember' that automatically and preemptively
1362 creates a link. If you do want to get an ID link in a remember
1363 template to an entry not having an ID, create it first by
1364 explicitly creating a link to it, using `C-c C-l' first.
1366 create-if-interactive-and-no-custom-id
1367 Like create-if-interactive, but do not create an ID if there is
1368 a CUSTOM_ID property defined in the entry. This is the default.
1370 use-existing
1371 Use existing ID, do not create one.
1373 nil Never use an ID to make a link, instead link using a text search for
1374 the headline text."
1379 create-if-interactive)
1381 create-if-interactive-and-no-custom-id)
1386 "Non-nil means file links from `org-store-link' contain context.
1387 A search string will be added to the file name with :: as separator and
1388 used to find the context when the link is activated by the command
1389 `org-open-at-point'. When this option is t, the entire active region
1390 will be placed in the search string of the file link. If set to a
1391 positive integer, only the first n lines of context will be stored.
1394 negates this setting for the duration of the command."
1399 "Non-nil means keep link in list for entire session.
1401 The command `org-store-link' adds a link pointing to the current
1402 location to an internal list. These links accumulate during a session.
1403 The command `org-insert-link' can be used to insert links into any
1404 Org-mode file (offering completion for all stored links). When this
1406 will be removed from the list, to make completing the unused links
1407 more efficient."
1412 "Options concerning following links in Org-mode."
1417 "Function to translate links with different syntax to Org syntax.
1418 This can be used to translate links created for example by the Planner
1419 or emacs-wiki packages to Org syntax.
1420 The function must accept two parameters, a TYPE containing the link
1422 which is everything after the link protocol. It should return a cons
1423 with possibly modified values of type and path.
1424 Org contains a function for this, so if you set this variable to
1425 `org-translate-link-from-planner', you should be able follow many
1426 links created by planner."
1431 "Hook that is run after a link has been followed."
1436 "Non-nil means on links TAB will follow the link.
1437 Needs to be set before org.el is loaded.
1438 This really should not be used, it does not make sense, and the
1439 implementation is bad."
1444 "Non-nil means on links RET will follow the link."
1450 "Non-nil means mouse-1 on a link will follow the link.
1451 A longer mouse click will still set point. Does not work on XEmacs.
1452 Needs to be set before org.el is loaded."
1457 "Number of different positions to be recorded in the ring.
1458 Changing this requires a restart of Emacs to work correctly."
1463 "Non-nil means internal links in Org files must exactly match a headline.
1464 When nil, the link search tries to match a phrase will all words
1465 in the search text."
1471 query-to-create)))
1478 "Setup the frame configuration for following links.
1479 When following a link with Emacs, it may often be useful to display
1480 this link in another window or frame. This variable can be used to
1481 set this up for the different types of links.
1482 For VM, use any of
1483 `vm-visit-folder'
1484 `vm-visit-folder-other-frame'
1485 For Gnus, use any of
1486 `gnus'
1487 `gnus-other-frame'
1488 `org-gnus-no-new-news'
1489 For FILE, use any of
1490 `find-file'
1491 `find-file-other-window'
1492 `find-file-other-frame'
1493 For Wanderlust use any of
1494 `wl'
1495 `wl-other-frame'
1496 For the calendar, use the variable `calendar-setup'.
1497 For BBDB, it is currently only possible to display the matches in
1498 another window."
1522 "Non-nil means use indirect buffer to display infile links.
1523 Activating internal links (from one location in a file to another location
1524 in the same file) normally just jumps to the location. When the link is
1526 is displayed in
1527 another window. When this option is set, the other window actually displays
1528 an indirect buffer clone of the current buffer, to avoid any visibility
1529 changes to the current buffer."
1534 "Non-nil means `org-open-file' will open non-existing files.
1535 When nil, an error will be generated.
1536 This variable applies only to external applications because they
1537 might choke on non-existing files. If the link is to a file that
1538 will be opened in Emacs, the variable is ignored."
1543 "Non-nil means a link to a directory really means to index.org.
1544 When nil, following a directory link will run dired or open a finder/explorer
1545 window on that directory."
1550 "Function and arguments to call for following mailto links.
1551 This is a list with the first element being a Lisp function, and the
1552 remaining elements being arguments to the function. In string arguments,
1553 %a will be replaced by the address, and %s will be replaced by the subject
1554 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1563 "Non-nil means ask for confirmation before executing shell links.
1564 Shell links can be dangerous: just think about a link
1566 [[shell:rm -rf ~/*][Google Search]]
1569 but really it would remove your entire home directory.
1570 Therefore we advise against setting this variable to nil.
1571 Just change it to `y-or-n-p' if you want to confirm with a
1579 'safe-local-variable
1583 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1584 Elisp links can be dangerous: just think about a link
1589 but really it would remove your entire home directory.
1590 Therefore we advise against setting this variable to nil.
1591 Just change it to `y-or-n-p' if you want to confirm with a
1599 'safe-local-variable
1606 "Default file applications on a UNIX or GNU/Linux system.
1617 "Default file applications on a MacOS X system.
1619 for some files for which the OS does not have a good default.
1627 'mswindows-shell-execute
1632 'mswindows-shell-execute
1635 "Default file applications on a Windows NT system.
1640 '(
1645 )
1646 "External applications for opening `file:path' items in a document.
1647 Org-mode uses system defaults for different file types, but
1648 you can use this variable to set the application for a given file
1649 extension. The entries in this list are cons cells where the car identifies
1650 files and the cdr the corresponding command. Possible values for the
1651 file identifier are
1653 ways, depending on its contents:
1655 - Alphanumeric characters only:
1656 Match links with this file extension.
1658 to open PDFs with evince.
1660 - Regular expression: Match links where the
1661 filename matches the regexp. If you want to
1662 use groups here, use shy groups.
1666 to open *.html and *.xhtml with firefox.
1668 - Regular expression which contains (non-shy) groups:
1670 anything after that, matches the regexp.
1671 In a custom command string, %1, %2, etc. are replaced with
1672 the parts of the link that were matched by the groups.
1673 For backwards compatibility, if a command string is given
1674 that does not use any of the group matches, this case is
1675 handled identically to the second one (i.e. match against
1676 file name only).
1677 In a custom lisp form, you can access the group matches with
1678 (match-string n link).
1681 to open [[file:document.pdf::5]] with evince at page 5.
1683 `directory' Matches a directory
1684 `remote' Matches a remote file, accessible through tramp or efs.
1685 Remote files most likely should be visited through Emacs
1686 because external applications cannot handle such paths.
1687 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1688 so all files Emacs knows how to handle. Using this with
1689 command `emacs' will open most files in Emacs. Beware that this
1690 will also open html files inside Emacs, unless you add
1692 t Default for files not matched by any of the other options.
1693 `system' The system command to open files, like `open' on Windows
1694 and Mac OS X, and mailcap under GNU/Linux. This is the command
1695 that will be selected if you call `C-c C-o' with a double
1698 Possible values for the command are:
1699 `emacs' The file will be visited by the current Emacs process.
1700 `default' Use the default application for this file type, which is the
1701 association for t in the list, most likely in the system-specific
1702 part.
1703 This can be used to overrule an unwanted setting in the
1704 system-specific variable.
1706 This command is specified by the entry whose car is `system'.
1707 Most likely, the system-specific version of this variable
1708 does define this command, but you can overrule/replace it
1709 here.
1710 string A command to be executed by a shell; %s will be replaced
1711 by the path to the file.
1712 sexp A Lisp form which will be evaluated. The file path will
1713 be available in the Lisp variable `file'.
1714 For more examples, see the system specific constants
1715 `org-file-apps-defaults-macosx'
1716 `org-file-apps-defaults-windowsnt'
1717 `org-file-apps-defaults-gnu'."
1727 auto-mode))
1738 "Options concerning refiling entries in Org-mode."
1743 "Directory with org files.
1744 This is just a default location to look for Org files. There is no need
1745 at all to put your files into this directory. It is only used in the
1746 following situations:
1748 1. When a remember template specifies a target file that is not an
1749 absolute path. The path will then be interpreted relative to
1750 `org-directory'
1751 2. When a remember note is filed away in an interactive way (when exiting the
1752 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1753 with `org-directory' as the default path."
1759 "Default target for storing notes.
1760 Used as a fall back file for org-remember.el and org-capture.el, for
1761 templates that do not specify a target file."
1766 file))
1769 "The default interface to be used for `org-goto'.
1770 Allowed values are:
1771 outline The interface shows an outline of the relevant file
1772 and the correct heading is found by moving through
1773 the outline or by searching with incremental search.
1774 outline-path-completion Headlines in the current buffer are offered via
1775 completion. This is the interface also used by
1776 the refile command."
1783 "Maximum target level when running `org-goto' with refile interface."
1788 "Non-nil means store new notes at the beginning of a file or entry.
1789 When nil, new notes will be filed to the end of a file or entry.
1790 This can also be a list with cons cells of regular expressions that
1791 are matched against file names, and values."
1801 "Information to record when a task is refiled.
1803 Possible values are:
1805 nil Don't add anything
1806 time Add a time stamp to the task
1807 note Prompt for a note and add it with template `org-log-note-headings'
1809 This option can also be set with on a per-file-basis with
1811 #+STARTUP: nologrefile
1812 #+STARTUP: logrefile
1813 #+STARTUP: lognoterefile
1815 You can have local logging settings for a subtree by setting the LOGGING
1816 property to one or more of these keywords.
1818 When bulk-refiling from the agenda, the value `note' is forbidden and
1819 will temporarily be changed to `time'."
1829 This is list of cons cells. Each cell contains:
1830 - a specification of the files to be considered, either a list of files,
1831 or a symbol whose function or variable value will be used to retrieve
1832 a file name or a list of file names. If you use `org-agenda-files' for
1833 that, all agenda files will be scanned for targets. Nil means consider
1834 headings in the current buffer.
1835 - A specification of how to find candidate refile targets. This may be
1836 any of:
1838 This tag has to be present in all target headlines, inheritance will
1839 not be considered.
1841 todo keyword.
1843 headlines that are refiling targets.
1844 - a cons cell (:level . N). Any headline of level N is considered a target.
1845 Note that, when `org-odd-levels-only' is set, level corresponds to
1846 order in hierarchy, not to the number of stars.
1847 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1848 Note that, when `org-odd-levels-only' is set, level corresponds to
1849 order in hierarchy, not to the number of stars.
1851 You can set the variable `org-refile-target-verify-function' to a function
1852 to verify each headline found by the simple criteria above.
1854 When this variable is nil, all top-level headlines in the current buffer
1855 are used, equivalent to the value `((nil . (:level . 1))'."
1871 "Function to verify if the headline at point should be a refile target.
1872 The function will be called without arguments, with point at the
1873 beginning of the headline. It should return t and leave point
1874 where it is if the headline is a valid target for refiling.
1876 If the target should not be selected, the function must return nil.
1877 In addition to this, it may move point to a place from where the search
1878 should be continued. For example, the function may decide that the entire
1879 subtree of the current entry should be excluded and move point to the end
1880 of the subtree."
1885 "Non-nil means cache refile targets to speed up the process.
1886 The cache for a particular file will be updated automatically when
1887 the buffer has been killed, or when any of the marker used for flagging
1888 refile targets no longer points at a live buffer.
1889 If you have added new entries to a buffer that might themselves be targets,
1890 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1891 find that easier, `C-u C-u C-u C-c C-w'."
1896 "Non-nil means provide refile targets as paths.
1897 So a level 3 headline will be available as level1/level2/level3.
1899 When the value is `file', also include the file name (without directory)
1900 into the path. In this case, you can also stop the completion after
1901 the file name, to get entries inserted as top level in the file.
1903 When `full-file-path', include the full file path."
1912 "Non-nil means complete the outline path in hierarchical steps.
1913 When Org-mode uses the refile interface to select an outline path
1914 \(see variable `org-refile-use-outline-path'), the completion of
1915 the path can be done is a single go, or if can be done in steps down
1916 the headline hierarchy. Going in steps is probably the best if you
1917 do not use a special completion package like `ido' or `icicles'.
1918 However, when using these packages, going in one step can be very
1919 fast, while still showing the whole path to the entry."
1924 "Non-nil means allow to create new nodes as refile targets.
1926 of an existing node. When the value of this variable is `confirm',
1927 new node creation must be confirmed by the user (recommended)
1928 When nil, the completion must match an existing entry.
1930 Note that, if the new heading is not seen by the criteria
1931 listed in `org-refile-targets', multiple instances of the same
1932 heading would be created by trying again to file under the new
1933 heading."
1941 "Options concerning TODO items in Org-mode."
1946 "Options concerning Progress logging in Org-mode."
1951 '(
1954 "The available interpretation symbols for customizing `org-todo-keywords'.
1958 "List of TODO entry keyword sequences and their interpretation.
1961 Each sequence starts with a symbol, either `sequence' or `type',
1962 indicating if the keywords should be interpreted as a sequence of
1963 action steps, or as different types of TODO items. The first
1964 keywords are states requiring action - these states will select a headline
1965 for inclusion into the global TODO list Org-mode produces. If one of
1968 the last keyword is treated as the only DONE state of the sequence.
1971 additional state where no keyword is present. For details about this
1972 cycling, see the manual.
1974 TODO keywords and interpretation can also be set on a per-file basis with
1975 the special #+SEQ_TODO and #+TYP_TODO lines.
1977 Each keyword can optionally specify a character for fast state selection
1978 \(in combination with the variable `org-use-fast-todo-selection')
1979 and specifiers for state change logging, using the same syntax
1982 indicates to record a time stamp each time this state is selected.
1984 Each keyword may also specify if a timestamp or a note should be
1985 recorded when entering or leaving the state, by adding additional
1986 characters in the parenthesis after the keyword. This looks like this:
1988 record only the time of the state change. With X and Y being either
1990 Y when leaving the state if and only if the *target* state does not
1991 define X. You may omit any of the fast-selection key or X or /Y,
1992 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1994 For backward compatibility, this variable may also be just a list
1995 of keywords - in this case the interpretation (sequence or type) will be
1996 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2006 ;;Quick and dirty way to see
2007 ;;`org-todo-interpretations'. This takes the
2008 ;;place of item arguments
2009 :convert-widget
2016 org-todo-interpretation-widgets))
2017 widget))
2048 "Controls how TODO keywords are interpreted.
2049 This variable is in principle obsolete and is only used for
2050 backward compatibility, if the interpretation of todo keywords is
2051 not given already in `org-todo-keywords'. See that variable for
2052 more information."
2059 "Non-nil means use the fast todo selection scheme with C-c C-t.
2060 This variable describes if and under what circumstances the cycling
2061 mechanism for TODO keywords will be replaced by a single-key, direct
2062 selection scheme.
2064 When nil, fast selection is never used.
2066 When the symbol `prefix', it will be used when `org-todo' is called with
2067 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2068 in an agenda buffer.
2070 When t, fast selection is used by default. In this case, the prefix
2071 argument forces cycling instead.
2073 In all cases, the special interface is only used if access keys have actually
2074 been assigned by the user, i.e. if keywords in the configuration are followed
2075 by a letter in parenthesis, like TODO(t)."
2083 "Non-nil means update todo statistics after insert and toggle.
2084 ALL-HEADLINES means update todo statistics by including headlines
2085 with no TODO keyword as well, counting them as not done.
2086 A list of TODO keywords means the same, but skip keywords that are
2087 not in this list.
2089 When this is set, todo statistics is updated in the parent of the
2090 current entry each time a todo state is changed."
2100 "Non-nil means TODO statistics covers just direct children.
2101 When nil, all entries in the subtree are considered.
2102 This has only an effect if `org-provide-todo-statistics' is set.
2103 To set this to nil for only a single subtree, use a COOKIE_DATA
2109 "Hook which is run after the state of a TODO item was changed.
2110 The new state (a string with a TODO keyword, or nil) is available in the
2111 Lisp variable `state'."
2116 "Hook for functions that are allowed to block a state change.
2118 Each function gets as its single argument a property list, see
2119 `org-trigger-hook' for more information about this list.
2121 If any of the functions in this hook returns nil, the state change
2125 "Hook for functions that are triggered by a state change.
2127 Each function gets as its single argument a property list with at least
2128 the following elements:
2130 (:type type-of-change :position pos-at-entry-start
2131 :from old-state :to new-state)
2133 Depending on the type, more properties may be present.
2135 This mechanism is currently implemented for:
2137 TODO state changes
2138 ------------------
2139 :type todo-state-change
2140 :from previous state (keyword as a string), or nil, or a symbol
2141 'todo' or 'done', to indicate the general type of state.
2145 "Non-nil means undone TODO entries will block switching the parent to DONE.
2146 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2147 be blocked if any prior sibling is not yet done.
2148 Finally, if the parent is blocked because of ordered siblings of its own,
2149 the child will also be blocked.
2150 This variable needs to be set before org.el is loaded, and you need to
2151 restart Emacs after a change to make the change effective. The only way
2152 to change is while Emacs is running is through the customize interface."
2164 "Non-nil means unchecked boxes will block switching the parent to DONE.
2165 When this is nil, checkboxes have no influence on switching TODO states.
2166 When non-nil, you first need to check off all check boxes before the TODO
2167 entry can be switched to DONE.
2168 This variable needs to be set before org.el is loaded, and you need to
2169 restart Emacs after a change to make the change effective. The only way
2170 to change is while Emacs is running is through the customize interface."
2182 "Non-nil means inserting a TODO heading is treated as state change.
2184 logging will apply if appropriate. When nil, the new TODO item will
2185 be inserted directly, and no logging will take place."
2190 "Non-nil means switching TODO states with S-cursor counts as state change.
2191 This is the default behavior. However, setting this to nil allows a
2192 convenient way to select a TODO state and bypass any logging associated
2193 with that."
2198 "Tag changes that should be triggered by TODO state changes.
2199 This is a list. Each entry is
2201 (state-change (tag . flag) .......)
2203 State-change can be a string with a state, and empty string to indicate the
2204 state that has no TODO keyword, or it can be one of the symbols `todo'
2205 or `done', meaning any not-done or done state, respectively."
2219 "Information to record when a task moves to the DONE state.
2221 Possible values are:
2223 nil Don't add anything, just change the keyword
2224 time Add a time stamp to the task
2225 note Prompt for a note and add it with template `org-log-note-headings'
2227 This option can also be set with on a per-file-basis with
2229 #+STARTUP: nologdone
2230 #+STARTUP: logdone
2231 #+STARTUP: lognotedone
2233 You can have local logging settings for a subtree by setting the LOGGING
2234 property to one or more of these keywords."
2242 ;; Normalize old uses of org-log-done.
2249 "Information to record when the scheduling date of a tasks is modified.
2251 Possible values are:
2253 nil Don't add anything, just change the date
2254 time Add a time stamp to the task
2255 note Prompt for a note and add it with template `org-log-note-headings'
2257 This option can also be set with on a per-file-basis with
2259 #+STARTUP: nologreschedule
2260 #+STARTUP: logreschedule
2261 #+STARTUP: lognotereschedule"
2270 "Information to record when the deadline date of a tasks is modified.
2272 Possible values are:
2274 nil Don't add anything, just change the date
2275 time Add a time stamp to the task
2276 note Prompt for a note and add it with template `org-log-note-headings'
2278 This option can also be set with on a per-file-basis with
2280 #+STARTUP: nologredeadline
2281 #+STARTUP: logredeadline
2282 #+STARTUP: lognoteredeadline
2284 You can have local logging settings for a subtree by setting the LOGGING
2285 property to one or more of these keywords."
2294 "Non-nil means record a note when clocking out of an item.
2295 This can also be configured on a per-file basis by adding one of
2296 the following lines anywhere in the buffer:
2298 #+STARTUP: lognoteclock-out
2299 #+STARTUP: nolognoteclock-out"
2305 "Non-nil means the CLOSED time stamp will contain date and time.
2306 When nil, only the date will be recorded."
2320 "Headings for notes added to entries.
2321 The value is an alist, with the car being a symbol indicating the note
2322 context, and the cdr is the heading to be used. The heading may also be the
2323 empty string.
2324 %t in the heading will be replaced by a time stamp.
2325 %T will be an active time stamp instead the default inactive one
2326 %s will be replaced by the new TODO state, in double quotes.
2327 %S will be replaced by the old TODO state, in double quotes.
2328 %u will be replaced by the user name.
2329 %U will be replaced by the full user name.
2331 In fact, it is not a good idea to change the `state' entry, because
2332 agenda log mode depends on the format of these entries."
2338 "Heading when changing todo state (todo sequence only)"
2352 "Non-nil means insert state change notes and time stamps into a drawer.
2353 When nil, state changes notes will be inserted after the headline and
2354 any scheduling and clock lines, but not inside a drawer.
2356 The value of this variable should be the name of the drawer to use.
2357 LOGBOOK is proposed at the default drawer for this purpose, you can
2358 also set this to a string to define the drawer of your choice.
2362 If this variable is set, `org-log-state-notes-insert-after-drawers'
2363 will be ignored.
2365 You can set the property LOG_INTO_DRAWER to overrule this setting for
2366 a subtree."
2378 "Return the value of `org-log-into-drawer', but let properties overrule.
2379 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2380 used instead of the default value."
2388 "Non-nil means insert state change notes after any drawers in entry.
2389 Only the drawers that *immediately* follow the headline and the
2390 deadline/scheduled line are skipped.
2391 When nil, insert notes right after the heading and perhaps the line
2392 with deadline/scheduling if present.
2394 This variable will have no effect if `org-log-into-drawer' is
2395 set."
2401 "Non-nil means the latest state note will be directly after heading.
2402 When nil, the state change notes will be ordered according to time."
2408 "The TODO state to which a repeater should return the repeating task.
2409 By default this is the first task in a TODO sequence, or the previous state
2410 in a TODO_TYP set. But you can specify another task here.
2411 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2417 "Non-nil means record moving through the DONE state when triggering repeat.
2418 An auto-repeating task is immediately switched back to TODO when
2421 record a closing note, there will be no record of the task moving
2422 through DONE. This variable forces taking a note anyway.
2424 nil Don't force a record
2425 time Record a time stamp
2426 note Record a note
2428 This option can also be set with on a per-file-basis with
2430 #+STARTUP: logrepeat
2431 #+STARTUP: lognoterepeat
2432 #+STARTUP: nologrepeat
2434 You can have local logging settings for a subtree by setting the LOGGING
2435 property to one or more of these keywords."
2445 "Priorities in Org-mode."
2450 "Non-nil means priority commands are active.
2451 When nil, these commands will be disabled, so that you never accidentally
2452 set a priority."
2457 "The highest priority of TODO items. A character like ?A, ?B etc.
2458 Must have a smaller ASCII number than `org-lowest-priority'."
2463 "The lowest priority of TODO items. A character like ?A, ?B etc.
2464 Must have a larger ASCII number than `org-highest-priority'."
2469 "The default priority of TODO items.
2470 This is the priority an item get if no explicit priority is given."
2475 "Non-nil means start with default priority when starting to cycle.
2476 When this is nil, the first step in the cycle will be (depending on the
2477 command used) one higher or lower that the default priority."
2482 "Function to extract the priority from a string.
2483 The string is normally the headline. If this is nil Org computes the
2484 priority from the priority cookie like [#A] in the headline. It returns
2485 an integer, increasing by 1000 for each priority level.
2486 The user can set a different function here, which should take a string
2487 as an argument and return the numeric priority."
2492 "Options concerning time stamps and deadlines in Org-mode."
2497 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2498 When nil, these labeled time stamps are forces into the second line of an
2499 entry, just after the headline. When scheduling from the global TODO list,
2500 the time stamp will always be forced into the second line."
2505 "Formats for `format-time-string' which are used for time stamps.
2509 "Number of minutes to round time stamps to.
2510 These are two values, the first applies when first creating a time stamp.
2511 The second applies when changing it with the commands `S-up' and `S-down'.
2512 When changing the time stamp, this means that it will change in steps
2513 of N minutes, as given by the second value.
2515 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2516 numbers should be factors of 60, so for example 5, 10, 15.
2518 When this is larger than 1, you can still force an exact time stamp by using
2519 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2520 and by using a prefix arg to `S-up/down' to specify the exact number
2521 of minutes to shift."
2531 ;; Normalize old customizations of this variable.
2535 org-time-stamp-rounding-minutes)))
2538 "Non-nil means overlay custom formats over all time stamps.
2539 The formats are defined through the variable `org-time-stamp-custom-formats'.
2540 To turn this on on a per-file basis, insert anywhere in the file:
2541 #+STARTUP: customtime"
2549 "Custom formats for time stamps. See `format-time-string' for the syntax.
2550 These are overlayed over the default ISO format if the variable
2551 `org-display-custom-times' is set. Time like %H:%M should be at the
2552 end of the second format. The custom formats are also honored by export
2553 commands, if custom time display is turned on at the time of export."
2558 "Get the right format for a time string."
2563 f)))
2566 "The format string used when creating CLOCKSUM lines.
2567 This is also used when org-mode generates a time duration."
2573 org-mode generates a time duration."
2578 "The format string used when creating CLOCKSUM lines, or when
2579 org-mode generates a time duration."
2584 "No. of days before expiration during which a deadline becomes active.
2585 This variable governs the display in sparse trees and in the agenda.
2586 When 0 or negative, it means use this number (the absolute value of it)
2587 even if a deadline has a different individual lead time specified.
2589 Custom commands can set this variable in the options section."
2595 "Non-nil means assume future for incomplete date input from user.
2596 This affects the following situations:
2597 1. The user gives a month but not a year.
2600 2. The user gives a day, but no month.
2603 it will be considered as *this* month.
2605 If you set this variable to the symbol `time', then also the following
2606 will work:
2608 3. If the user gives a time, but no day. If the time is before now,
2609 to will be interpreted as tomorrow.
2611 Currently none of this works for ISO week specifications.
2613 When this option is nil, the current day, month and year will always be
2614 used as defaults.
2616 See also `org-agenda-jump-prefer-future'."
2624 "Should the agenda jump command prefer the future for incomplete dates?
2625 The default is to do the same as configured in `org-read-date-prefer-future'.
2626 But you can alse set a deviating value here.
2627 This may t or nil, or the symbol `org-read-date-prefer-future'."
2632 org-read-date-prefer-future)
2637 "Non-nil means display current interpretation of date prompt live.
2638 This display will be in an overlay, in the minibuffer."
2643 "Non-nil means pop up a calendar when prompting for a date.
2644 In the calendar, the date can be selected with mouse-1. However, the
2645 minibuffer will also be active, and you can simply enter the date as well.
2646 When nil, only the minibuffer will be available."
2654 "Hook to be used to set up keys for the date/time interface.
2655 Add key definitions to `minibuffer-local-map', which will be a temporary
2656 copy."
2661 "The hour when your day really ends. Must be an integer.
2662 This has influence for the following applications:
2664 the time given here, the day recognized as TODAY is actually yesterday.
2665 - When a date is read from the user and it is still before the time given
2666 here, the current date and time will be assumed to be yesterday, 23:59.
2667 Also, timestamps inserted in remember templates follow this rule.
2669 IMPORTANT: This is a feature whose implementation is and likely will
2670 remain incomplete. Really, it is only here because past midnight seems to
2671 be the favorite working time of John Wiegley :-)"
2676 "Non-nil means S-down will increase the time in a time stamp.
2677 When nil, S-up will increase."
2682 "Non-nil means make the calendar window follow timestamp changes.
2683 When a timestamp is modified and the calendar window is visible, it will be
2684 moved to the new date."
2689 "Options concerning tags in Org-mode."
2694 "List of tags allowed in Org-mode files.
2695 When this list is nil, Org-mode will base TAG input on what is already in the
2696 buffer.
2697 The value of this variable is an alist, the car of each entry must be a
2698 keyword as a string, the cdr may be a character that is used to select
2699 that tag through the fast-tag-selection interface.
2700 See the manual for details."
2715 "List of tags that will always appear in all Org-mode files.
2716 This is in addition to any in buffer settings or customizations
2717 of `org-tag-alist'.
2718 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2719 The value of this variable is an alist, the car of each entry must be a
2720 keyword as a string, the cdr may be a character that is used to select
2721 that tag through the fast-tag-selection interface.
2722 See the manual for details.
2723 To disable these tags on a per-file basis, insert anywhere in the file:
2724 #+STARTUP: noptag"
2735 "If non-nil, always offer completion for all tags of all agenda files.
2736 Instead of customizing this variable directly, you might want to
2737 set it locally for capture buffers, because there no list of
2738 tags in that file can be created dynamically (there are none).
2740 (add-hook 'org-capture-mode-hook
2741 (lambda ()
2742 (set (make-local-variable
2743 'org-complete-tags-always-offer-all-agenda-tags)
2744 t)))"
2749 "List of tags that can be inherited by all entries in the file.
2750 The tags will be inherited if the variable `org-use-tag-inheritance'
2751 says they should be.
2755 "Non-nil means use fast tag selection scheme.
2756 This is a special interface to select and deselect tags with single keys.
2757 When nil, fast selection is never used.
2758 When the symbol `auto', fast selection is used if and only if selection
2759 characters for tags have been configured, either through the variable
2760 `org-tag-alist' or through a #+TAGS line in the buffer.
2761 When t, fast selection is always used and selection keys are assigned
2762 automatically if necessary."
2770 "Non-nil means fast tag selection exits after first change.
2771 When nil, you have to press RET to exit it.
2772 During fast tag selection, you can toggle this flag with `C-c'.
2773 This variable can also have the value `expert'. In this case, the window
2774 displaying the tags menu is not even shown, until you press C-c again."
2782 "Non-nil means fast tags selection interface will also offer TODO states.
2786 "The column to which tags should be indented in a headline.
2787 If this number is positive, it specifies the column. If it is negative,
2788 it means that the tags should be flushright to that column. For example,
2789 -80 works well for a normal 80 character screen."
2794 "Non-nil means realign tags after pro/demotion of TODO state change.
2795 These operations change the length of a headline and therefore shift
2796 the tags around. With this options turned on, after each such operation
2797 the tags are again aligned to `org-tags-column'."
2802 "Non-nil means tags in levels apply also for sublevels.
2803 When nil, only the tags directly given in a specific line apply there.
2804 This may also be a list of tags that should be inherited, or a regexp that
2805 matches tags that should be inherited. Additional control is possible
2806 with the variable `org-tags-exclude-from-inheritance' which gives an
2807 explicit list of tags to be excluded from inheritance., even if the value of
2808 `org-use-tag-inheritance' would select it for inheritance.
2810 If this option is t, a match early-on in a tree can lead to a large
2811 number of matches in the subtree when constructing the agenda or creating
2812 a sparse tree. If you only want to see the first match in a tree during
2813 a search, check out the variable `org-tags-match-list-sublevels'."
2822 "List of tags that should never be inherited.
2823 This is a way to exclude a few tags from inheritance. For way to do
2824 the opposite, to actively allow inheritance for selected tags,
2825 see the variable `org-use-tag-inheritance'."
2830 "Check if TAG is one that should be inherited."
2842 "Non-nil means list also sublevels of headlines matching a search.
2843 This variable applies to tags/property searches, and also to stuck
2844 projects because this search is based on a tags match as well.
2846 When set to the symbol `indented', sublevels are indented with
2847 leading dots.
2849 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2850 the sublevels of a headline matching a tag search often also match
2851 the same search. Listing all of them can create very long lists.
2852 Setting this variable to nil causes subtrees of a match to be skipped.
2854 This variable is semi-obsolete and probably should always be true. It
2855 is better to limit inheritance to certain tags using the variables
2856 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2864 "When set, tags are sorted using this function as a comparator."
2880 "Options concerning properties in Org-mode."
2885 "How property key/value pairs should be formatted by `indent-line'.
2886 When `indent-line' hits a property definition, it will format the line
2887 according to this format, mainly to make sure that the values are
2888 lined-up with respect to each other."
2893 "Non-nil means properties apply also for sublevels.
2895 This setting is chiefly used during property searches. Turning it on can
2896 cause significant overhead when doing a search, which is why it is not
2897 on by default.
2899 When nil, only the properties directly given in the current entry count.
2900 When t, every property is inherited. The value may also be a list of
2901 properties that should have inheritance, or a regular expression matching
2902 properties that should be inherited.
2904 However, note that some special properties use inheritance under special
2905 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2907 for valid values of a property.
2909 Note for programmers:
2910 When querying an entry with `org-entry-get', you can control if inheritance
2911 should be used. By default, `org-entry-get' looks only at the local
2912 properties. You can request inheritance by setting the inherit argument
2913 to t (to force inheritance) or to `selective' (to respect the setting
2914 in this variable)."
2923 "Check if PROPERTY is one that should be inherited."
2934 "The default column format, if no other format has been defined.
2935 This variable can be set on the per-file basis by inserting a line
2937 #+COLUMNS: %25ITEM ....."
2942 "The ellipses to be used when a field in column view is truncated.
2943 When this is the empty string, as many characters as possible are shown,
2944 but then there will be no visual indication that the field has been truncated.
2945 When this is a string of length N, the last N characters of a truncated
2946 field are replaced by this string. If the column is narrower than the
2947 ellipses string, only part of the ellipses string will be shown."
2952 "Function that modifies values for display in column view.
2953 For example, it can be used to cut out a certain part from a time stamp.
2954 The function must take 2 arguments:
2956 column-title The title of the column (*not* the property name)
2957 value The value that should be modified.
2959 The function should return the value that should be displayed,
2960 or nil if the normal value should be used."
2965 "The property that is being used to keep track of effort estimates.
2966 Effort estimates given in this property need to have the format H:MM."
2974 "List of property/value pairs that can be inherited by any entry.
2976 These are fixed values, for the preset properties. The user variable
2977 that can be used to add to this list is `org-global-properties'.
2979 The entries in this list are cons cells where the car is a property
2980 name and cdr is a string with the value. If the value represents
2985 "List of property/value pairs that can be inherited by any entry.
2987 This list will be combined with the constant `org-global-properties-fixed'.
2989 The entries in this list are cons cells where the car is a property
2990 name and cdr is a string with the value.
2992 You can set buffer-local values for the same purpose in the variable
2993 `org-file-properties' this by adding lines like
2995 #+PROPERTY: NAME VALUE"
3002 "List of property/value pairs that can be inherited by any entry.
3003 Valid for the current buffer.
3008 "Options concerning agenda views in Org-mode."
3013 "Variable used by org files to set a category for agenda display.
3014 Such files should use a file variable to set it, for example
3018 or contain a special line
3020 #+CATEGORY: ELisp
3022 If the file does not specify a category, then file's base name
3028 "The files to be used for agenda display.
3032 If an entry is a directory, all files in that directory that are matched by
3033 `org-agenda-file-regexp' will be part of the file list.
3035 If the value of the variable is not a list but a single file name, then
3036 the list of agenda files is actually stored and maintained in that file, one
3037 agenda file per line. In this file paths can be given relative to
3038 `org-directory'. Tilde expansion and environment variable substitution
3039 are also made."
3046 "Regular expression to match files for `org-agenda-files'.
3047 If any element in the list in that variable contains a directory instead
3048 of a normal file, all files in that directory that are matched by this
3049 regular expression will be included."
3054 "List of extra files to be searched by text search commands.
3055 These files will be search in addition to the agenda files by the
3056 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3057 Note that these files will only be searched for text search commands,
3058 not for the other agenda views like todo lists, tag searches or the weekly
3059 agenda. This variable is intended to list notes and possibly archive files
3060 that should also be searched by these two commands.
3061 In fact, if the first element in the list is the symbol `agenda-archives',
3062 than all archive files of all agenda files will be added to the search
3063 scope."
3074 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3075 A nil value means to remove them, after a query, from the list."
3080 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3081 The command `org-calendar-goto-agenda' will be bound to this key. The
3082 default is the character `c' because then `c' can be used to switch back and
3083 forth between agenda and calendar."
3088 "The key to be installed in `calendar-mode-map' for agenda-action.
3089 The command `org-agenda-action' will be bound to this key. The
3090 default is the character `k' because we use the same key in the agenda."
3095 "The key to be installed in `calendar-mode-map' for adding diary entries.
3096 This option is irrelevant until `org-agenda-diary-file' has been configured
3097 to point to an Org-mode file. When that is the case, the command
3098 `org-agenda-diary-entry' will be bound to the key given here, by default
3099 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3100 if you want to continue doing this, you need to change this to a different
3101 key."
3106 "File to which to add new entries with the `i' key in agenda and calendar.
3107 When this is the symbol `diary-file', the functionality in the Emacs
3108 calendar will be used to add entries to the `diary-file'. But when this
3109 points to a file, `org-agenda-diary-entry' will be used instead."
3125 org-calendar-insert-diary-entry-key
3129 "Options for embedding LaTeX code into Org-mode."
3137 "Options for creating images from LaTeX fragments.
3138 This is a property list with the following properties:
3140 `default' means use the foreground of the default face.
3142 `default' means use the background of the default face.
3143 :scale a scaling factor for the size of the images, to get more pixels
3144 :html-foreground, :html-background, :html-scale
3145 the same numbers for HTML export.
3146 :matchers a list indicating which matchers should be used to
3147 find LaTeX fragments. Valid members of this list are:
3158 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3159 When nil, just push out a message."
3168 \[PACKAGES]
3169 \[DEFAULT-PACKAGES]
3170 % The settings below are copied from fullpage.sty
3183 "The document header used for processing LaTeX fragments.
3184 It is imperative that this header make sure that no page number
3185 appears on the page. The package defined in the variables
3186 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3188 will be appended."
3195 "Set the packages alist and make sure it has 3 elements per entry."
3199 x))
3200 val)))
3204 "Get the packages alist and make sure it has 3 elements per entry."
3208 x))
3211 ;; The following variables are defined here because is it also used
3212 ;; when formatting latex fragments. Originally it was part of the
3213 ;; LaTeX exporter, which is why the name includes "export".
3230 )
3231 "Alist of default packages to be inserted in the header.
3232 Change this only if one of the packages here causes an incompatibility
3233 with another package you are using.
3234 The packages in this list are needed by one part or another of Org-mode
3235 to function properly.
3237 - inputenc, fontenc: for basic font and character selection
3238 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3239 for interpreting the entities in `org-entities'. You can skip some of these
3240 packages if you don't use any of the symbols in it.
3241 - graphicx: for including images
3242 - float, wrapfig: for figure placement
3243 - longtable: for long tables
3244 - hyperref: for cross references
3246 Therefore you should not modify this variable unless you know what you
3247 are doing. The one reason to change it anyway is that you might be loading
3248 some other package that conflicts with one of the default packages.
3250 If SNIPPET-FLAG is t, the package also needs to be included when
3251 compiling LaTeX snippets into images for inclusion into HTML."
3264 "Alist of packages to be inserted in every LaTeX header.
3265 These will be inserted after `org-export-latex-default-packages-alist'.
3267 SNIPPET-FLAG, when t, indicates that this package is also needed when
3268 turning LaTeX snippets into images for inclusion into HTML.
3269 Make sure that you only list packages here which:
3270 - you want in every file
3271 - do not conflict with the default packages in
3272 `org-export-latex-default-packages-alist'
3273 - do not conflict with the setup in `org-format-latex-header'."
3287 "Settings for Org-mode appearance."
3292 "Non-nil means fontify only the stars in each headline.
3293 When nil, the entire headline is fontified.
3294 Changing it requires restart of `font-lock-mode' to become effective
3295 also in regions already fontified."
3300 "Non-nil means hide the first N-1 stars in a headline.
3301 This works by using the face `org-hide' for these stars. This
3302 face is white for a light background, and black for a dark
3303 background. You may have to customize the face `org-hide' to
3304 make this work.
3305 Changing it requires restart of `font-lock-mode' to become effective
3306 also in regions already fontified.
3307 You may also set this on a per-file basis by adding one of the following
3308 lines to the buffer:
3310 #+STARTUP: hidestars
3311 #+STARTUP: showstars"
3316 "List of keywords that should be hidden when typed in the org buffer.
3317 For example, add #+TITLE to this list in order to make the
3318 document title appear in the buffer without the initial #+TITLE:
3319 keyword."
3327 "Non-nil means change the face of a headline if it is marked DONE.
3328 Normally, only the TODO/DONE keyword indicates the state of a headline.
3329 When this is non-nil, the headline after the keyword is set to the
3330 `org-headline-done' as an additional indication."
3335 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3336 Changing this variable requires a restart of Emacs to take effect."
3341 "Non-nil means fontify the whole line for headings.
3342 This is useful when setting a background color for the
3343 org-level-* faces."
3348 "Non-nil means fontify what is treated specially by the exporters."
3353 "Non-nil mean font-lock should hide the emphasis marker characters."
3358 "Non-nil means show entities as UTF8 characters.
3364 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3369 "Regular expression for matching emphasis.
3370 After a match, the match groups contain these elements:
3371 0 The match of the full regular expression, including the characters
3372 before and after the proper match
3373 1 The character before the proper match, or empty at beginning of line
3374 2 The proper match, including the leading and trailing markers
3375 3 The leading marker like * or /, indicating the type of highlighting
3376 4 The text between the emphasis markers, not including the markers
3383 "Set variable and compute the emphasis regular expression."
3387 org-emphasis-alist org-emphasis-regexp-components)
3399 ;; make sure special characters appear at the right position in the class
3411 ;; Make the regexp
3419 body1
3431 body1
3439 "Components used to build the regular expression for emphasis.
3440 This is a list with five entries. Terminology: In an emphasis string
3444 specify what is allowed/forbidden in each part:
3446 pre Chars allowed as prematch. Beginning of line will be allowed too.
3447 post Chars allowed as postmatch. End of line will be allowed too.
3448 border The chars *forbidden* as border characters.
3450 non-shy groups here, and don't allow newline here.
3451 newline The maximum number of newlines allowed in an emphasis exp.
3453 Use customize to modify this, or restart Emacs after changing it."
3472 )
3473 "Special syntax for emphasized text.
3474 Text starting and ending with a special character will be emphasized, for
3475 example *bold*, _underlined_ and /italic/. This variable sets the marker
3476 characters, the face to be used by font-lock for highlighting in Org-mode
3477 Emacs buffers, and the HTML tags to be used for this.
3478 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3479 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3480 Use customize to modify this, or restart Emacs after changing it."
3495 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3498 ;;; Miscellaneous options
3501 "Completion in Org-mode."
3506 "Non-nil means use ido completion wherever possible.
3507 Note that `ido-mode' must be active for this variable to be relevant.
3508 If you decide to turn this variable on, you might well want to turn off
3509 `org-outline-path-complete-in-steps'.
3510 See also `org-completion-use-iswitchb'."
3515 "Non-nil means use iswitchb completion wherever possible.
3516 Note that `iswitchb-mode' must be active for this variable to be relevant.
3517 If you decide to turn this variable on, you might well want to turn off
3518 `org-outline-path-complete-in-steps'.
3519 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3525 Normal means, no org-mode-specific context."
3529 ;;; Functions and variables from their packages
3530 ;; Declared here to avoid compiler warnings
3532 ;; XEmacs only
3538 ;; Emacs only
3541 ;; Various packages
3559 org-format-agenda-item "org-agenda"
3590 ;;; Autoload and prepare some org modules
3592 ;; Some table stuff that needs to be defined here, because it is used
3593 ;; by the functions setting up org-mode or checking for table context.
3606 "Detect the first line outside a table when searching from within it.
3609 ;; Autoload the functions in org-table.el that are needed by functions here.
3614 org-table-convert org-table-convert-region org-table-copy-down
3615 org-table-copy-region org-table-create
3616 org-table-create-or-convert-from-region
3617 org-table-create-with-table.el org-table-current-dline
3618 org-table-cut-region org-table-delete-column org-table-edit-field
3619 org-table-edit-formulas org-table-end org-table-eval-formula
3620 org-table-export org-table-field-info
3621 org-table-get-stored-formulas org-table-goto-column
3622 org-table-hline-and-move org-table-import org-table-insert-column
3623 org-table-insert-hline org-table-insert-row org-table-iterate
3624 org-table-justify-field-maybe org-table-kill-row
3625 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3626 org-table-move-column org-table-move-column-left
3627 org-table-move-column-right org-table-move-row
3628 org-table-move-row-down org-table-move-row-up
3629 org-table-next-field org-table-next-row org-table-paste-rectangle
3630 org-table-previous-field org-table-recalculate
3631 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3632 org-table-toggle-coordinate-overlays
3633 org-table-toggle-formula-debugger org-table-wrap-region
3634 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3635 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3636 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3639 "Return t if the cursor is inside an org-type table.
3640 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3645 org-table-line-regexp)))
3646 nil))
3650 "Return t if and only if we are at a table.el table."
3656 "If there is a table.el table nearby, recognize it and move into it."
3662 nil
3672 t
3677 t)
3678 nil)
3679 nil))
3682 "Return t if the cursor is inside a hline in a table."
3687 nil))
3692 "Apply FUNCTION to the start of all tables in the buffer."
3708 ;; Declare and autoload functions from org-exp.el & Co
3716 org-insert-export-options-template
3717 org-table-clean-before-export))
3720 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3721 org-export-region-as-ascii))
3724 org-replace-region-by-latex org-export-region-as-latex
3725 org-export-as-latex org-export-as-pdf
3726 org-export-as-pdf-and-open))
3729 org-export-as-html-batch org-export-as-html-to-buffer
3730 org-replace-region-by-html org-export-region-as-html
3731 org-export-as-html))
3734 org-replace-region-by-docbook org-export-region-as-docbook
3735 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3736 org-export-as-docbook))
3739 org-export-icalendar-all-agenda-files
3740 org-export-icalendar-combine-agenda-files))
3744 ;; Declare and autoload functions from org-agenda.el
3749 org-todo-list org-tags-view org-agenda-list-stuck-projects
3750 org-diary org-agenda-to-appt
3751 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3753 ;; Autoload org-remember
3758 org-remember-apply-template org-remember org-remember-handler)))
3763 org-capture-import-remember-templates)))
3765 ;; Autoload org-clock.el
3780 "Return non-nil if clock is currently running.
3781 The return value is actually the clock marker."
3786 "org-clock"
3788 org-clock-goto org-clock-sum org-clock-display
3789 org-clock-remove-overlays org-clock-report
3790 org-clocktable-shift org-dblock-write:clocktable
3791 org-get-clocktable org-resolve-clocks)))
3794 "If this is a CLOCK line, update it and return t.
3795 Otherwise, return nil."
3804 ts te h m s neg)
3807 nil)
3812 ;; The clock is running here
3833 t))))))
3836 "Check if the current buffer contains the running clock.
3837 If yes, offer to stop it and to save the buffer with the changes."
3846 "Check if this line starts a clock table, if yes, shift the time block."
3850 ;; Autoload org-timer.el
3854 "org-timer"
3856 org-timer-change-times-in-region
3857 org-timer-set-timer
3858 org-timer-reset-timers
3859 org-timer-show-remaining-time)))
3861 ;; Autoload org-feed.el
3865 "org-feed"
3869 ;; Autoload org-indent.el
3871 ;; Define the variable already here, to make sure we have it.
3873 "Non-nil if Org-Indent mode is enabled.
3878 "org-indent"
3881 ;; Autoload org-mobile.el
3885 "org-mobile"
3888 ;; Autoload archiving code
3889 ;; The stuff that is needed for cycling and tags has to be defined here.
3892 "Options concerning archiving in Org-mode."
3897 "The location where subtrees should be archived.
3899 The value of this variable is a string, consisting of two parts,
3900 separated by a double-colon. The first part is a filename and
3901 the second part is a headline.
3903 When the filename is omitted, archiving happens in the same file.
3904 %s in the filename will be replaced by the current file
3905 name (without the directory part). Archiving to a different file
3906 is useful to keep archived entries from contributing to the
3907 Org-mode Agenda.
3909 The archived entries will be filed as subtrees of the specified
3910 headline. When the headline is omitted, the subtrees are simply
3911 filed away at the end of the file, as top-level entries. Also in
3912 the heading you can use %s to represent the file name, this can be
3913 useful when using the same archive for a number of different files.
3915 Here are a few examples:
3917 If the current file is Projects.org, archive in file
3918 Projects.org_archive, as top-level trees. This is the default.
3921 Archive in the current file, under the top-level headline
3925 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3928 Archive in file ~/org/archive.org (absolute path), under headlines
3932 Archive in file ./basement (relative path), as level 3 trees
3935 You may set this option on a per-file basis by adding to the buffer a
3936 line like
3938 #+ARCHIVE: basement::** Finished Tasks
3940 You may also define it locally for a subtree by setting an ARCHIVE property
3941 in the entry. If such a property is found in an entry, or anywhere up
3942 the hierarchy, it will be used."
3947 "The tag that marks a subtree as archived.
3948 An archived subtree does not open during visibility cycling, and does
3949 not contribute to the agenda listings.
3950 After changing this, font-lock must be restarted in the relevant buffers to
3951 get the proper fontification."
3957 "Non-nil means the agenda will skip any items located in archived trees.
3958 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3959 variable is no longer recommended, you should leave it at the value t.
3960 Instead, use the key `v' to cycle the archives-mode in the agenda."
3966 "Non-nil means ignore archived trees when creating column view."
3972 "Non-nil means `org-cycle' will open archived trees.
3973 An archived tree is a tree marked with the tag ARCHIVE.
3974 When nil, archived trees will stay folded. You can still open them with
3975 normal outline commands like `show-all', but not with the cycling commands."
3981 "Non-nil means sparse tree construction shows matches in archived trees.
3982 When nil, matches in these trees are highlighted, but the trees are kept in
3983 collapsed state."
3989 "Re-hide all archived subtrees after a visibility state change."
4000 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4003 "Cycle subtree even if it is archived."
4010 "Re-hide all archived subtrees after a visibility state change."
4025 flag)))
4032 org-archive-to-archive-sibling org-toggle-archive-tag
4033 org-archive-subtree-default
4034 org-archive-subtree-default-with-confirmation)))
4036 ;; Autoload Column View Code
4044 org-columns-compute org-agenda-columns org-columns-remove-overlays
4047 ;; Autoload ID code
4055 org-id-get-with-outline-path-completion
4056 org-id-get-with-outline-drilling org-id-store-link
4057 org-id-goto org-id-find org-id-store-link))
4059 ;; Autoload Plotting Code
4064 ;;; Variables for pre-computed regular expressions, all buffer local
4082 "Matches a headline and puts everything into groups:
4083 group 1: the stars
4084 group 2: The todo keyword, maybe
4085 group 3: Priority cookie
4086 group 4: True headline
4090 "Printf format to make regexp to match an exact headline.
4091 This regexp will match the headline of any node which hase the exact
4092 headline text that is put into the format, but may have any TODO state,
4096 "Matches a headline and puts TODO state into group 2 if present.
4151 "Regular expression to match a plain time or time range.
4152 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4153 groups carry important information:
4154 0 the full match
4155 1 the first time, range or not
4163 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4164 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4165 groups carry important information:
4166 0 the full match
4167 7 hours of duration
4176 "Regular expression to match a timestamp time or time range.
4177 After a match, the following groups carry important information:
4178 0 the full match
4179 1 date plus weekday, for back referencing to make sure both times are on the same day
4180 2 the first time, range or not
4235 "Variable associated with STARTUP options for org-mode.
4236 Each element is a list of three items: The startup options as written
4237 in the #+STARTUP line, the corresponding variable, and the value to
4238 set this variable to if the option is found. An optional forth element PUSH
4242 "Precompute regular expressions for current buffer."
4262 kwds kws0 kwsa key log value cat arch tags const links hw dws
4263 tail sep kws1 prio props ftags drawers beamer-p
4285 ;; general TODO-like setup
4297 links)))
4303 props)))
4308 ftags
4318 l var val)
4348 ))))
4365 ;; Process the TODO keywords
4367 ;; Use the global values as if they had been given locally.
4379 kws)))
4382 kwsa nil
4385 ;; 1 2
4393 kw)
4395 kws0)
4412 ;; Process the constants
4420 ;; Process the tags.
4431 tgs))
4439 ;; Compute the regular expressions and other local variables
4447 org-drawer-regexp
4451 org-not-done-keywords
4453 org-todo-regexp
4456 org-not-done-regexp
4460 org-not-done-heading-regexp
4464 org-todo-line-regexp
4468 org-complex-heading-regexp
4473 org-complex-heading-regexp-format
4482 org-nl-done-regexp
4486 org-todo-line-tags-regexp
4491 org-looking-at-done-regexp
4496 org-deadline-time-regexp
4498 org-deadline-line-regexp
4500 org-scheduled-regexp
4502 org-scheduled-time-regexp
4504 org-closed-time-regexp
4506 org-keyword-time-regexp
4512 org-keyword-time-not-clock-regexp
4518 org-maybe-keyword-time-regexp
4524 org-planning-or-clock-line-re
4529 org-all-time-keywords
4532 org-clock-string org-closed-string))
4533 )
4538 "Return the contents of FILE, as a string."
4552 "Extract the log state setting from a TODO keyword string.
4566 "Remove a pair of parenthesis at the end of each string in LIST."
4570 x))
4571 list))
4574 "Assign fast keys to a keyword-key alist.
4575 Respect keys that are already there."
4593 ;;; Some variables used in various places
4600 "Function to be called when `C-c C-c' is used.
4604 ;; FIXME: Occasionally check by commenting these, to make sure
4605 ;; no other functions uses these, forgetting to let-bind them.
4610 ;; Defined somewhere in this file, but used before definition.
4616 ;;;; Define the Org-mode
4619 (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"))
4622 ;; We use a before-change function to check if a table might need
4623 ;; an update.
4625 "Indicates that a table might need an update.
4626 This variable is set by `org-before-change-function'.
4629 "Every change indicates that a table might need an update."
4640 ;;;###autoload
4642 "Outline-based notes management and organizer, alias
4645 Org-mode develops organizational tasks around a NOTES file which
4646 contains information about projects as plain text. Org-mode is
4647 implemented on top of outline-mode, which is ideal to keep the content
4648 of large files well structured. It supports ToDo items, deadlines and
4649 time stamps, which magically appear in the diary listing of the Emacs
4650 calendar. Tables are easily created with a built-in table editor.
4651 Plain text URL-like links connect to websites, emails (VM), Usenet
4652 messages (Gnus), BBDB entries, and any files related to the project.
4653 For printing and sharing of notes, an Org-mode file (or a part of it)
4654 can be exported as a structured ASCII or HTML file.
4656 The following commands are available:
4660 ;; Get rid of Outline menus, they are not needed
4661 ;; Need to do this here because define-derived-mode sets up
4662 ;; the keymap so late. Still, it is a waste to call this each time
4663 ;; we switch another buffer into org-mode.
4666 ;; Assume this is Greg's port, it uses easymenu
4691 org-display-table 4
4694 org-ellipsis)))
4699 ;; tag faces set outside customize.... force initialization.
4701 ;; Calc embedded
4707 ;; Activate before-change-function
4711 ;; Check for running clock before killing a buffer
4713 ;; Paragraphs and auto-filling
4717 ;; Beginning/end of defun
4720 ;; Make sure dependence stuff works reliably, even for users who set it
4721 ;; too late :-(
4733 ;; Comment characters
4737 ;; Align options lines
4739 'align-mode-rules-list
4744 ;; Imenu
4748 ;; Make isearch reveal context
4751 ;; Emacs 21 and XEmacs make use of the hook
4753 ;; Emacs 22 deals with this through a special variable
4757 ;; Turn on org-beamer-mode?
4760 ;; Setup the pcomplete hooks
4771 ;; If empty file that did not turn on org-mode automatically, make it to.
4796 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4806 "Return today date, considering `org-extend-today-until'."
4811 ;;;; Font-Lock stuff, including the activators
4842 "Regular expression used to analyze links.
4843 Here is what the match groups contain after a match:
4844 1: http:
4845 2: http
4846 3: path
4847 4: [desc]
4855 "Number of stacked braces for sub/superscript matching.
4856 This has to be set before loading org.el to be effective."
4861 "Create a regular expression which will match a balanced sexp.
4862 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4863 as single character strings.
4864 The regexp returned will match the entire expression including the
4865 delimiters. It will also define a single group which contains the
4866 match except for the outermost delimiters. The maximum depth of
4867 stacked delimiters is N. Escaping delimiters is not possible."
4896 "Update the link regular expressions.
4897 This should be called after the variable `org-link-types' has changed."
4901 org-link-re-with-space
4907 org-link-re-with-space2
4913 org-link-re-with-space3
4918 org-angle-link-re
4924 org-plain-link-re
4928 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
4929 org-bracket-link-regexp
4931 org-bracket-link-analytic-regexp
4939 org-bracket-link-analytic-regexp++
4947 org-any-link-re
4958 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4959 "Regular expression matching time strings for analysis.
4960 This one does not require the space after the date, so it can be used
4962 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4978 "Regular expression matching a time stamp or time stamp range.
4984 "Run through the buffer and add overlays to links."
4993 'face
5006 rtn))
5009 "Insert or change an emphasis, i.e. a font like bold or italic.
5010 If there is an active region, change that region to a new emphasis.
5011 If there is no region, just insert the marker characters and position
5012 the cursor between them.
5013 CHAR should be either the marker character, or the first character of the
5014 HTML tag associated with that emphasis. If CHAR is a space, the means
5015 to remove the emphasis of the selected region.
5016 If char is not given (for example in an interactive call) it
5017 will be prompted for."
5068 "Run through the buffer and add overlays to links."
5077 nil
5083 t)))))
5091 t)))
5094 "When non-nil, fontify code in code blocks."
5100 "Fontify #+ lines and blocks, in the correct ways."
5103 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5104 limit t)
5112 end end1 quoting block-type)
5115 ;; a single line of backend-specific content
5123 ; for backend-specific code
5124 t)
5126 ;; Truly a block
5138 beg end
5142 ; for end_src
5148 org-block)))
5149 ; end of source block
5155 t))
5168 ;; just any other in-buffer setting, but not indented
5172 t)
5180 t)
5188 "Run through the buffer and add overlays to links."
5196 t)))
5199 "Run through the buffer and add overlays to links."
5201 limit t)
5206 'keymap org-mouse-map
5207 'help-echo
5209 "Footnote definition"
5211 ))
5213 t)))
5216 "Run through the buffer and add overlays to bracketed links."
5220 ;; FIXME: above we should remove the escapes.
5221 ;; but that requires another match, protecting match data,
5222 ;; a lot of overhead for font-lock.
5229 ;; We need to remove the invisible property here. Table narrowing
5230 ;; may have made some of this invisible.
5248 t)))
5251 "Run through the buffer and add overlays to dates."
5263 t)))
5272 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5276 "Run through the buffer and add overlays to target matches."
5284 'keymap org-mouse-map
5288 t)))))
5291 "Find all radio targets in this file and update the regular expression."
5306 t)))
5313 ;; This should be with the exporter code, but we also use if for font-locking
5323 "Compute regular expression for stuff treated specially by exporters."
5330 org-latex-regexps)))
5358 org-entities)))
5362 org-latex-entities)
5363 nil))
5365 ))
5366 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5369 org-export-html-special-string-regexps)))
5374 ))))
5376 'org-latex-and-specials-regexp
5381 "Run through the buffer and add overlays to links."
5385 limit t))
5399 rtn)))
5402 "Restart `font-lock-mode', to force refontification."
5408 "Return a list of all targets in this file.
5409 With optional argument RADIO, only find radio targets."
5411 rtn)
5416 rtn)))
5419 "Make regular expression matching all strings in TARGETS.
5420 The regular expression finds the targets also if there is a line break
5421 between words."
5429 x)
5430 targets
5442 t)))
5445 "Compute the outline level of the heading at point.
5446 This function assumes that the cursor is at the beginning of a line matched
5447 by `outline-regexp'. Otherwise it returns garbage.
5448 If this is called at a normal headline, the level is the number of stars.
5449 Use `org-reduced-level' to remove the effect of `org-odd-levels'.
5450 For plain list items, if they are matched by `outline-regexp', this returns
5451 1000 plus the line indentation."
5460 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5467 "Functions that can manipulate `org-font-lock-extra-keywords'.
5468 This is calles after `org-font-lock-extra-keywords' is defined, but before
5469 it is installed to be used by font lock. This can be useful if something
5480 ;; Call the hook
5482 ;; Headlines
5489 ;; Table lines
5492 ;; Table internals
5497 ;; Drawers
5500 ;; Properties
5504 ;; Links
5515 ;; TODO lines
5518 ;; DONE
5524 nil)
5525 ;; Priorities
5527 ;; Tags
5529 ;; Special keywords
5534 ;; Emphasis
5539 ;; Checkboxes
5540 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5545 ;; Description list items
5548 ;; ARCHIVEd headings
5551 ;; Specials
5555 ;; Code
5557 ;; COMMENT
5562 ;; Blocks and meta lines
5564 )))
5567 ;; Now set the full font-lock-keywords
5574 "Toggle the composition display of entities as UTF8 characters."
5586 "Find an entity to fontify."
5592 limit t)
5604 nil))))
5607 "Fontify string S like in Org-mode."
5619 "Get the right face for match N in font-lock matching of headlines."
5632 "Get the right face for a TODO keyword KWD.
5633 If KWD is a number, get the corresponding match group."
5641 "Create a face list that inherits INHERIT, but sets the foreground color.
5642 When FACE-OR-COLOR is not a string, just return it."
5646 face-or-color)
5647 face-or-color))
5650 "Add the special tag faces."
5659 "Add the special priority faces."
5666 org-priority-faces)))
5671 "Get the right face for a TODO keyword KWD.
5672 If KWD is a number, get the corresponding match group."
5679 "Remove fontification and activation overlays from links."
5684 deactivate-mark buffer-file-name buffer-file-truename)
5687 beg end
5689 ;; also remove line-prefix and wrap-prefix properties
5691 invisible t intangible t
5692 line-prefix t wrap-prefix t
5693 org-no-flyspell t org-emphasis t)
5695 invisible t intangible t
5696 org-no-flyspell t org-emphasis t)))
5706 "Remove specific display properties that have been added by font lock.
5707 The will remove the raise properties that are used to show superscripts
5708 and subscripts."
5718 "Add raise properties to sub/superscripts."
5722 org-match-substring-regexp
5723 org-match-substring-with-braces-regexp)
5724 limit t)
5734 ;; FIXME: Should we go back one character here, for a_b^c
5735 ;; (goto-char (1- pos)) ;????????????????????
5737 t
5739 'display
5755 t)))))
5757 ;;;; Visibility cycling, including org-goto and indirect buffer
5759 ;;; Cycling
5766 ;;;###autoload
5771 "TAB-action and visibility cycling for Org-mode.
5773 This is the command invoked in Org-mode by the TAB key. Its main purpose
5774 is outline visibility cycling, but it also invokes other actions
5775 in special contexts.
5777 - When this function is called with a prefix argument, rotate the entire
5778 buffer through 3 states (global cycling)
5779 1. OVERVIEW: Show only top-level headlines.
5780 2. CONTENTS: Show all headlines of all levels, but no body text.
5781 3. SHOW ALL: Show everything.
5782 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5783 determined by the variable `org-startup-folded', and by any VISIBILITY
5784 properties in the buffer.
5785 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5786 including any drawers.
5788 - When inside a table, re-align the table and move to the next field.
5790 - When point is at the beginning of a headline, rotate the subtree started
5791 by this line through 3 different states (local cycling)
5792 1. FOLDED: Only the main headline is shown.
5793 2. CHILDREN: The main headline and the direct children are shown.
5794 From this state, you can move to one of the children
5795 and zoom in further.
5796 3. SUBTREE: Show the entire subtree, including body text.
5797 If there is no subtree, switch directly from CHILDREN to FOLDED.
5799 - When point is at the beginning of an empty headline and the variable
5800 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5801 of the headline by demoting and promoting it to likely levels. This
5802 speeds up creation document structure by pressing TAB once or several
5803 times right after creating a new headline.
5805 - When there is a numeric prefix, go up to a heading with level ARG, do
5806 a `show-subtree' and return to the previous cursor position. If ARG
5807 is negative, go up that many levels.
5809 - When point is not at the beginning of a headline, execute the global
5810 binding for TAB, which is re-indenting the line. See the option
5811 `org-cycle-emulate-tab' for details.
5813 - Special case: if point is at the beginning of the buffer and there is
5814 no headline in line 1, this function will act as if called with prefix arg
5815 (C-u TAB, same as S-TAB) also when called without prefix arg.
5816 But only if also the variable `org-cycle-global-at-bob' is t."
5826 org-inlinetask-min-level
5831 limit-level)))
5847 org-cycle-hook))
5851 ;; special case: use global cycling
5866 ;; Enter the table or move to the next field in the table
5883 ;; Toggle block visibility
5888 ;; Show-subtree, ARG levels up from here.
5900 ;; TAB emulation and template completion
5924 t
5933 "Do the global cycling action."
5937 ;; We just created the overview - now do table of contents
5938 ;; This can be slow in very large buffers, so indicate action
5948 ;; We just showed the table of contents - now show everything
5956 ;; Default action: go to overview
5964 "Do the local cycling action."
5966 ;; First, some boundaries
5973 ; XEmacs does not have `next-single-char-property-change'
5974 ; I'm not sure about Emacs 21.
5988 ;; if we're in a list, org-end-of-subtree is in fact org-end-of-item.
5997 ;; Find out what to do next and set `this-command'
6000 ;; Nothing is hidden behind this heading
6012 org-cycle-skip-children-state-if-no-children))))
6013 ;; Entire subtree is hidden in one line: children view
6027 ;; We just showed the children, or no children are there,
6028 ;; now show everything.
6035 ;; Default action: hide the subtree.
6042 ;;;###autoload
6044 "Cycle the global visibility. For details see `org-cycle'.
6046 With a numeric prefix, show all headlines up to that level."
6062 "Set the visibility required by startup options and properties."
6077 "Switch subtree visibilities according to :VISIBILITY: property."
6084 nil t)
6109 "Switch to overview mode, showing only top-level headlines.
6110 Really, this shows all headlines with level equal or greater than the level
6111 of the first headline in the buffer. This is important, because if the
6112 first headline is not level one, then (hide-sublevels 1) gives confusing
6113 results."
6124 "Show all headlines in the buffer, like a table of contents.
6125 With numerical argument N, show content up to level N."
6128 ;; Visit all headings and show their offspring
6135 t)
6144 "Adjust the window after a change in outline visibility.
6145 This function is the default value of the hook `org-cycle-hook'."
6155 "Remove outline overlays that do not contain non-white stuff."
6165 "Fix visibility issues after moving a subtree."
6166 ;; First, find a reasonable region to look at:
6167 ;; Start two siblings above, end three below
6185 ;; Properly fold already folded siblings
6196 "Show empty lines above all visible headlines.
6197 The region to be covered depends on STATE when called through
6198 `org-cycle-hook'. Lisp program can use t for STATE to get the
6199 entire buffer covered. Note that an empty line is only shown if there
6200 are at least `org-cycle-separator-lines' empty lines before the headline."
6210 beg end b e)
6234 ;; Never hide empty lines at the end of the file.
6244 "Move to the parent and re-show empty lines before visible headlines."
6250 "Return `org-agenda-files' list, plus all open org-mode files.
6251 This is useful for operations that need to scan all of a user's
6252 open and agenda-wise Org files."
6260 files))
6263 "Return the beginning position of the current entry."
6267 "Return the end position of the current entry."
6271 "Re-hide all drawers after a visibility state change."
6298 "Is the end of the current subtree visible?"
6303 "Move cursor to the first headline and recenter the headline.
6304 Optional argument N means put the headline into the Nth line of the window."
6310 ;;; Saving and restoring visibility
6313 "Return a list of the locations of all outline overlays.
6314 These are overlays with the `invisible' property value `outline'.
6315 The return value is a list of cons cells, with start and stop
6316 positions for each overlay.
6317 If USE-MARKERS is set, return the positions as markers."
6335 "Create visibility overlays for all positions in DATA.
6336 DATA should have been made by `org-outline-overlay-data'."
6345 data)))))
6347 ;;; Folding of blocks
6359 "Call FUNCTION at the head of all source blocks in the current buffer.
6360 Optional arguments START and END can be used to limit the range."
6372 "Toggle the visibility of all blocks in the current buffer."
6376 "Fold all blocks in the current buffer."
6382 "Unfold all blocks in the current buffer."
6388 "Toggle visibility of block at point."
6399 "Toggle the visibility of the current block."
6406 ov)
6422 ;; make the block accessible to isearch
6424 ov 'isearch-open-invisible
6435 ;; org-tab-after-check-for-cycling-hook
6437 ;; Remove overlays when changing major mode
6442 ;;; Org-goto
6448 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6464 nil)
6465 (org-defkey map "q" 'org-goto-quit)
6466 (org-defkey map "n" 'outline-next-visible-heading)
6467 (org-defkey map "p" 'outline-previous-visible-heading)
6468 (org-defkey map "f" 'outline-forward-same-level)
6469 (org-defkey map "b" 'outline-backward-same-level)
6470 (org-defkey map "u" 'outline-up-heading))
6471 (org-defkey map "/" 'org-occur)
6472 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6473 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6474 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6475 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6476 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6477 map))
6479 (defconst org-goto-help
6480 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6481 RET=jump to location [Q]uit and return to previous location
6482 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6484 (defvar org-goto-start-pos) ; dynamically scoped parameter
6486 ;; FIXME: Docstring does not mention both interfaces
6487 (defun org-goto (&optional alternative-interface)
6488 "Look up a different location in the current file, keeping current visibility.
6490 When you want look-up or go to a different location in a document, the
6491 fastest way is often to fold the entire buffer and then dive into the tree.
6492 This method has the disadvantage, that the previous location will be folded,
6493 which may not be what you want.
6495 This command works around this by showing a copy of the current buffer
6496 in an indirect buffer, in overview mode. You can dive into the tree in
6497 that copy, use org-occur and incremental search to find a location.
6498 When pressing RET or `Q', the command returns to the original buffer in
6499 which the visibility is still unchanged. After RET is will also jump to
6500 the location selected in the indirect buffer and expose the
6501 the headline hierarchy above."
6502 (interactive "P")
6503 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6504 (org-refile-use-outline-path t)
6505 (org-refile-target-verify-function nil)
6506 (interface
6507 (if (not alternative-interface)
6508 org-goto-interface
6509 (if (eq org-goto-interface 'outline)
6510 'outline-path-completion
6511 'outline)))
6512 (org-goto-start-pos (point))
6513 (selected-point
6514 (if (eq interface 'outline)
6515 (car (org-get-location (current-buffer) org-goto-help))
6516 (let ((pa (org-refile-get-location "Goto: ")))
6517 (org-refile-check-position pa)
6518 (nth 3 pa)))))
6519 (if selected-point
6520 (progn
6521 (org-mark-ring-push org-goto-start-pos)
6522 (goto-char selected-point)
6523 (if (or (org-invisible-p) (org-invisible-p2))
6524 (org-show-context 'org-goto)))
6525 (message "Quit"))))
6527 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6528 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6529 (defvar org-goto-local-auto-isearch-map) ; defined below
6531 (defun org-get-location (buf help)
6532 "Let the user select a location in the Org-mode buffer BUF.
6533 This function uses a recursive edit. It returns the selected position
6534 or nil."
6535 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6536 (isearch-hide-immediately nil)
6537 (isearch-search-fun-function
6538 (lambda () 'org-goto-local-search-headings))
6539 (org-goto-selected-point org-goto-exit-command)
6540 (pop-up-frames nil)
6541 (special-display-buffer-names nil)
6542 (special-display-regexps nil)
6543 (special-display-function nil))
6544 (save-excursion
6545 (save-window-excursion
6546 (delete-other-windows)
6547 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6548 (switch-to-buffer
6549 (condition-case nil
6550 (make-indirect-buffer (current-buffer) "*org-goto*")
6551 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6552 (with-output-to-temp-buffer "*Help*"
6553 (princ help))
6554 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6555 (setq buffer-read-only nil)
6556 (let ((org-startup-truncated t)
6557 (org-startup-folded nil)
6558 (org-startup-align-all-tables nil))
6559 (org-mode)
6560 (org-overview))
6561 (setq buffer-read-only t)
6562 (if (and (boundp 'org-goto-start-pos)
6563 (integer-or-marker-p org-goto-start-pos))
6564 (let ((org-show-hierarchy-above t)
6565 (org-show-siblings t)
6566 (org-show-following-heading t))
6567 (goto-char org-goto-start-pos)
6568 (and (org-invisible-p) (org-show-context)))
6569 (goto-char (point-min)))
6570 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6571 (message "Select location and press RET")
6572 (use-local-map org-goto-map)
6573 (recursive-edit)
6574 ))
6575 (kill-buffer "*org-goto*")
6576 (cons org-goto-selected-point org-goto-exit-command)))
6578 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6579 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6580 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6581 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6583 (defun org-goto-local-search-headings (string bound noerror)
6584 "Search and make sure that any matches are in headlines."
6585 (catch 'return
6586 (while (if isearch-forward
6587 (search-forward string bound noerror)
6588 (search-backward string bound noerror))
6589 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6590 (and (member :headline context)
6591 (not (member :tags context))))
6592 (throw 'return (point))))))
6594 (defun org-goto-local-auto-isearch ()
6595 "Start isearch."
6596 (interactive)
6597 (goto-char (point-min))
6598 (let ((keys (this-command-keys)))
6599 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6600 (isearch-mode t)
6601 (isearch-process-search-char (string-to-char keys)))))
6603 (defun org-goto-ret (&optional arg)
6604 "Finish `org-goto' by going to the new location."
6605 (interactive "P")
6606 (setq org-goto-selected-point (point)
6607 org-goto-exit-command 'return)
6608 (throw 'exit nil))
6610 (defun org-goto-left ()
6611 "Finish `org-goto' by going to the new location."
6612 (interactive)
6613 (if (org-on-heading-p)
6614 (progn
6615 (beginning-of-line 1)
6616 (setq org-goto-selected-point (point)
6617 org-goto-exit-command 'left)
6618 (throw 'exit nil))
6619 (error "Not on a heading")))
6621 (defun org-goto-right ()
6622 "Finish `org-goto' by going to the new location."
6623 (interactive)
6624 (if (org-on-heading-p)
6625 (progn
6626 (setq org-goto-selected-point (point)
6627 org-goto-exit-command 'right)
6628 (throw 'exit nil))
6629 (error "Not on a heading")))
6631 (defun org-goto-quit ()
6632 "Finish `org-goto' without cursor motion."
6633 (interactive)
6634 (setq org-goto-selected-point nil)
6635 (setq org-goto-exit-command 'quit)
6636 (throw 'exit nil))
6638 ;;; Indirect buffer display of subtrees
6640 (defvar org-indirect-dedicated-frame nil
6641 "This is the frame being used for indirect tree display.")
6642 (defvar org-last-indirect-buffer nil)
6644 (defun org-tree-to-indirect-buffer (&optional arg)
6645 "Create indirect buffer and narrow it to current subtree.
6646 With numerical prefix ARG, go up to this level and then take that tree.
6647 If ARG is negative, go up that many levels.
6648 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6649 indirect buffer previously made with this command, to avoid proliferation of
6650 indirect buffers. However, when you call the command with a \
6652 when `org-indirect-buffer-display' is `new-frame', the last buffer
6653 is kept so that you can work with several indirect buffers at the same time.
6654 If `org-indirect-buffer-display' is `dedicated-frame', the \
6656 requests that a new frame be made for the new buffer, so that the dedicated
6657 frame is not changed."
6658 (interactive "P")
6659 (let ((cbuf (current-buffer))
6660 (cwin (selected-window))
6661 (pos (point))
6662 beg end level heading ibuf)
6663 (save-excursion
6664 (org-back-to-heading t)
6665 (when (numberp arg)
6666 (setq level (org-outline-level))
6667 (if (< arg 0) (setq arg (+ level arg)))
6668 (while (> (setq level (org-outline-level)) arg)
6669 (outline-up-heading 1 t)))
6670 (setq beg (point)
6671 heading (org-get-heading))
6672 (org-end-of-subtree t t)
6673 (if (org-on-heading-p) (backward-char 1))
6674 (setq end (point)))
6675 (if (and (buffer-live-p org-last-indirect-buffer)
6676 (not (eq org-indirect-buffer-display 'new-frame))
6677 (not arg))
6678 (kill-buffer org-last-indirect-buffer))
6679 (setq ibuf (org-get-indirect-buffer cbuf)
6680 org-last-indirect-buffer ibuf)
6681 (cond
6682 ((or (eq org-indirect-buffer-display 'new-frame)
6683 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6684 (select-frame (make-frame))
6685 (delete-other-windows)
6686 (switch-to-buffer ibuf)
6687 (org-set-frame-title heading))
6688 ((eq org-indirect-buffer-display 'dedicated-frame)
6689 (raise-frame
6690 (select-frame (or (and org-indirect-dedicated-frame
6691 (frame-live-p org-indirect-dedicated-frame)
6692 org-indirect-dedicated-frame)
6693 (setq org-indirect-dedicated-frame (make-frame)))))
6694 (delete-other-windows)
6695 (switch-to-buffer ibuf)
6696 (org-set-frame-title (concat "Indirect: " heading)))
6697 ((eq org-indirect-buffer-display 'current-window)
6698 (switch-to-buffer ibuf))
6699 ((eq org-indirect-buffer-display 'other-window)
6700 (pop-to-buffer ibuf))
6701 (t (error "Invalid value")))
6702 (if (featurep 'xemacs)
6703 (save-excursion (org-mode) (turn-on-font-lock)))
6704 (narrow-to-region beg end)
6705 (show-all)
6706 (goto-char pos)
6707 (and (window-live-p cwin) (select-window cwin))))
6709 (defun org-get-indirect-buffer (&optional buffer)
6710 (setq buffer (or buffer (current-buffer)))
6711 (let ((n 1) (base (buffer-name buffer)) bname)
6712 (while (buffer-live-p
6713 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6714 (setq n (1+ n)))
6715 (condition-case nil
6716 (make-indirect-buffer buffer bname 'clone)
6717 (error (make-indirect-buffer buffer bname)))))
6719 (defun org-set-frame-title (title)
6720 "Set the title of the current frame to the string TITLE."
6721 ;; FIXME: how to name a single frame in XEmacs???
6722 (unless (featurep 'xemacs)
6723 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6725 ;;;; Structure editing
6727 ;;; Inserting headlines
6729 (defun org-previous-line-empty-p ()
6730 (save-excursion
6731 (and (not (bobp))
6732 (or (beginning-of-line 0) t)
6733 (save-match-data
6736 (defun org-insert-heading (&optional force-heading invisible-ok)
6737 "Insert a new heading or item with same depth at point.
6738 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6739 If point is at the beginning of a headline, insert a sibling before the
6740 current headline. If point is not at the beginning, split the line,
6741 create the new headline with the text in the current line after point
6742 \(but see also the variable `org-M-RET-may-split-line').
6744 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6745 This is important for non-interactive uses of the command."
6746 (interactive "P")
6747 (if (or (= (buffer-size) 0)
6748 (and (not (save-excursion
6749 (and (ignore-errors (org-back-to-heading invisible-ok))
6750 (org-on-heading-p))))
6751 (not (org-in-item-p))))
6752 (progn
6754 (run-hooks 'org-insert-heading-hook))
6755 (when (or force-heading (not (org-insert-item)))
6756 (let* ((empty-line-p nil)
6757 (level nil)
6758 (on-heading (org-on-heading-p))
6759 (head (save-excursion
6760 (condition-case nil
6761 (progn
6762 (org-back-to-heading invisible-ok)
6763 (when (and (not on-heading)
6764 (featurep 'org-inlinetask)
6765 (integerp org-inlinetask-min-level)
6766 (>= (length (match-string 0))
6767 org-inlinetask-min-level))
6768 ;; Find a heading level before the inline task
6769 (while (and (setq level (org-up-heading-safe))
6770 (>= level org-inlinetask-min-level)))
6771 (if (org-on-heading-p)
6772 (org-back-to-heading invisible-ok)
6773 (error "This should not happen")))
6774 (setq empty-line-p (org-previous-line-empty-p))
6775 (match-string 0))
6776 (error "*"))))
6777 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6778 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6779 pos hide-previous previous-pos)
6780 (cond
6781 ((and (org-on-heading-p) (bolp)
6782 (or (bobp)
6783 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6784 ;; insert before the current line
6785 (open-line (if blank 2 1)))
6786 ((and (bolp)
6787 (not org-insert-heading-respect-content)
6788 (or (bobp)
6789 (save-excursion
6790 (backward-char 1) (not (org-invisible-p)))))
6791 ;; insert right here
6792 nil)
6793 (t
6794 ;; somewhere in the line
6795 (save-excursion
6796 (setq previous-pos (point-at-bol))
6797 (end-of-line)
6798 (setq hide-previous (org-invisible-p)))
6799 (and org-insert-heading-respect-content (org-show-subtree))
6800 (let ((split
6801 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6802 (save-excursion
6803 (let ((p (point)))
6804 (goto-char (point-at-bol))
6805 (and (looking-at org-complex-heading-regexp)
6806 (> p (match-beginning 4)))))))
6807 tags pos)
6808 (cond
6809 (org-insert-heading-respect-content
6810 (org-end-of-subtree nil t)
6811 (when (featurep 'org-inlinetask)
6812 (while (and (not (eobp))
6814 (>= (length (match-string 1))
6815 org-inlinetask-min-level))
6816 (org-end-of-subtree nil t)))
6817 (or (bolp) (newline))
6818 (or (org-previous-line-empty-p)
6819 (and blank (newline)))
6820 (open-line 1))
6821 ((org-on-heading-p)
6822 (when hide-previous
6823 (show-children)
6824 (org-show-entry))
6826 (setq tags (and (match-end 2) (match-string 2)))
6827 (and (match-end 1)
6828 (delete-region (match-beginning 1) (match-end 1)))
6829 (setq pos (point-at-bol))
6830 (or split (end-of-line 1))
6831 (delete-horizontal-space)
6833 (buffer-substring (point-at-bol) (point)))
6834 (insert " "))
6835 (newline (if blank 2 1))
6836 (when tags
6837 (save-excursion
6838 (goto-char pos)
6839 (end-of-line 1)
6840 (insert " " tags)
6841 (org-set-tags nil 'align))))
6842 (t
6843 (or split (end-of-line 1))
6844 (newline (if blank 2 1)))))))
6845 (insert head) (just-one-space)
6846 (setq pos (point))
6847 (end-of-line 1)
6848 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6849 (when (and org-insert-heading-respect-content hide-previous)
6850 (save-excursion
6851 (goto-char previous-pos)
6852 (hide-subtree)))
6853 (run-hooks 'org-insert-heading-hook)))))
6855 (defun org-get-heading (&optional no-tags)
6856 "Return the heading of the current entry, without the stars."
6857 (save-excursion
6858 (org-back-to-heading t)
6859 (if (looking-at
6860 (if no-tags
6863 (match-string 1) "")))
6865 (defun org-heading-components ()
6866 "Return the components of the current heading.
6867 This is a list with the following elements:
6868 - the level as an integer
6869 - the reduced level, different if `org-odd-levels-only' is set.
6870 - the TODO keyword, or nil
6871 - the priority character, like ?A, or nil if no priority is given
6872 - the headline text itself, or the tags string if no headline text
6873 - the tags string, or nil."
6874 (save-excursion
6875 (org-back-to-heading t)
6876 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6877 (list (length (match-string 1))
6878 (org-reduced-level (length (match-string 1)))
6879 (org-match-string-no-properties 2)
6880 (and (match-end 3) (aref (match-string 3) 2))
6881 (org-match-string-no-properties 4)
6882 (org-match-string-no-properties 5)))))
6884 (defun org-get-entry ()
6885 "Get the entry text, after heading, entire subtree."
6886 (save-excursion
6887 (org-back-to-heading t)
6888 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6890 (defun org-insert-heading-after-current ()
6891 "Insert a new heading with same level as current, after current subtree."
6892 (interactive)
6893 (org-back-to-heading)
6894 (org-insert-heading)
6895 (org-move-subtree-down)
6896 (end-of-line 1))
6898 (defun org-insert-heading-respect-content ()
6899 (interactive)
6900 (let ((org-insert-heading-respect-content t))
6901 (org-insert-heading t)))
6903 (defun org-insert-todo-heading-respect-content (&optional force-state)
6904 (interactive "P")
6905 (let ((org-insert-heading-respect-content t))
6906 (org-insert-todo-heading force-state t)))
6908 (defun org-insert-todo-heading (arg &optional force-heading)
6909 "Insert a new heading with the same level and TODO state as current heading.
6910 If the heading has no TODO state, or if the state is DONE, use the first
6911 state (TODO by default). Also with prefix arg, force first state."
6912 (interactive "P")
6913 (when (or force-heading (not (org-insert-item 'checkbox)))
6914 (org-insert-heading force-heading)
6915 (save-excursion
6916 (org-back-to-heading)
6917 (outline-previous-heading)
6918 (looking-at org-todo-line-regexp))
6919 (let*
6920 ((new-mark-x
6921 (if (or arg
6922 (not (match-beginning 2))
6923 (member (match-string 2) org-done-keywords))
6924 (car org-todo-keywords-1)
6925 (match-string 2)))
6926 (new-mark
6927 (or
6928 (run-hook-with-args-until-success
6929 'org-todo-get-default-hook new-mark-x nil)
6930 new-mark-x)))
6931 (beginning-of-line 1)
6933 (if org-treat-insert-todo-heading-as-state-change
6934 (org-todo new-mark)
6935 (insert new-mark " "))))
6936 (when org-provide-todo-statistics
6937 (org-update-parent-todo-statistics))))
6939 (defun org-insert-subheading (arg)
6940 "Insert a new subheading and demote it.
6941 Works for outline headings and for plain lists alike."
6942 (interactive "P")
6943 (org-insert-heading arg)
6944 (cond
6945 ((org-on-heading-p) (org-do-demote))
6946 ((org-at-item-p) (org-indent-item))))
6948 (defun org-insert-todo-subheading (arg)
6949 "Insert a new subheading with TODO keyword or checkbox and demote it.
6950 Works for outline headings and for plain lists alike."
6951 (interactive "P")
6952 (org-insert-todo-heading arg)
6953 (cond
6954 ((org-on-heading-p) (org-do-demote))
6955 ((org-at-item-p) (org-indent-item))))
6957 ;;; Promotion and Demotion
6959 (defvar org-after-demote-entry-hook nil
6960 "Hook run after an entry has been demoted.
6961 The cursor will be at the beginning of the entry.
6962 When a subtree is being demoted, the hook will be called for each node.")
6964 (defvar org-after-promote-entry-hook nil
6965 "Hook run after an entry has been promoted.
6966 The cursor will be at the beginning of the entry.
6967 When a subtree is being promoted, the hook will be called for each node.")
6969 (defun org-promote-subtree ()
6970 "Promote the entire subtree.
6971 See also `org-promote'."
6972 (interactive)
6973 (save-excursion
6974 (org-map-tree 'org-promote))
6975 (org-fix-position-after-promote))
6977 (defun org-demote-subtree ()
6978 "Demote the entire subtree. See `org-demote'.
6979 See also `org-promote'."
6980 (interactive)
6981 (save-excursion
6982 (org-map-tree 'org-demote))
6983 (org-fix-position-after-promote))
6986 (defun org-do-promote ()
6987 "Promote the current heading higher up the tree.
6988 If the region is active in `transient-mark-mode', promote all headings
6989 in the region."
6990 (interactive)
6991 (save-excursion
6992 (if (org-region-active-p)
6993 (org-map-region 'org-promote (region-beginning) (region-end))
6994 (org-promote)))
6995 (org-fix-position-after-promote))
6997 (defun org-do-demote ()
6998 "Demote the current heading lower down the tree.
6999 If the region is active in `transient-mark-mode', demote all headings
7000 in the region."
7001 (interactive)
7002 (save-excursion
7003 (if (org-region-active-p)
7004 (org-map-region 'org-demote (region-beginning) (region-end))
7005 (org-demote)))
7006 (org-fix-position-after-promote))
7008 (defun org-fix-position-after-promote ()
7009 "Make sure that after pro/demotion cursor position is right."
7010 (let ((pos (point)))
7011 (when (save-excursion
7012 (beginning-of-line 1)
7013 (looking-at org-todo-line-regexp)
7014 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7015 (cond ((eobp) (insert " "))
7016 ((eolp) (insert " "))
7017 ((equal (char-after) ?\ ) (forward-char 1))))))
7019 (defun org-current-level ()
7020 "Return the level of the current entry, or nil if before the first headline.
7021 The level is the number of stars at the beginning of the headline."
7022 (save-excursion
7023 (let ((outline-regexp (org-get-limited-outline-regexp)))
7024 (condition-case nil
7025 (progn
7026 (org-back-to-heading t)
7027 (funcall outline-level))
7028 (error nil)))))
7030 (defun org-get-previous-line-level ()
7031 "Return the outline depth of the last headline before the current line.
7032 Returns 0 for the first headline in the buffer, and nil if before the
7033 first headline."
7034 (let ((current-level (org-current-level))
7035 (prev-level (when (> (line-number-at-pos) 1)
7036 (save-excursion
7037 (beginning-of-line 0)
7038 (org-current-level)))))
7039 (cond ((null current-level) nil) ; Before first headline
7040 ((null prev-level) 0) ; At first headline
7041 (prev-level))))
7043 (defun org-reduced-level (l)
7044 "Compute the effective level of a heading.
7045 This takes into account the setting of `org-odd-levels-only'."
7046 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
7048 (defun org-level-increment ()
7049 "Return the number of stars that will be added or removed at a
7050 time to headlines when structure editing, based on the value of
7051 `org-odd-levels-only'."
7052 (if org-odd-levels-only 2 1))
7054 (defun org-get-valid-level (level &optional change)
7055 "Rectify a level change under the influence of `org-odd-levels-only'
7056 LEVEL is a current level, CHANGE is by how much the level should be
7057 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7058 even level numbers will become the next higher odd number."
7059 (if org-odd-levels-only
7060 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7061 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7062 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7063 (max 1 (+ level (or change 0)))))
7065 (if (boundp 'define-obsolete-function-alias)
7066 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7067 (define-obsolete-function-alias 'org-get-legal-level
7068 'org-get-valid-level)
7069 (define-obsolete-function-alias 'org-get-legal-level
7070 'org-get-valid-level "23.1")))
7072 (defun org-promote ()
7073 "Promote the current heading higher up the tree.
7074 If the region is active in `transient-mark-mode', promote all headings
7075 in the region."
7076 (org-back-to-heading t)
7077 (let* ((level (save-match-data (funcall outline-level)))
7078 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7079 (diff (abs (- level (length up-head) -1))))
7080 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7081 (replace-match up-head nil t)
7082 ;; Fixup tag positioning
7083 (and org-auto-align-tags (org-set-tags nil t))
7084 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7085 (run-hooks 'org-after-promote-entry-hook)))
7087 (defun org-demote ()
7088 "Demote the current heading lower down the tree.
7089 If the region is active in `transient-mark-mode', demote all headings
7090 in the region."
7091 (org-back-to-heading t)
7092 (let* ((level (save-match-data (funcall outline-level)))
7093 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7094 (diff (abs (- level (length down-head) -1))))
7095 (replace-match down-head nil t)
7096 ;; Fixup tag positioning
7097 (and org-auto-align-tags (org-set-tags nil t))
7098 (if org-adapt-indentation (org-fixup-indentation diff))
7099 (run-hooks 'org-after-demote-entry-hook)))
7101 (defun org-cycle-level ()
7102 "Cycle the level of an empty headline through possible states.
7103 This goes first to child, then to parent, level, then up the hierarchy.
7104 After top level, it switches back to sibling level."
7105 (interactive)
7106 (let ((org-adapt-indentation nil))
7107 (when (org-point-at-end-of-empty-headline)
7108 (setq this-command 'org-cycle-level) ; Only needed for caching
7109 (let ((cur-level (org-current-level))
7110 (prev-level (org-get-previous-line-level)))
7111 (cond
7112 ;; If first headline in file, promote to top-level.
7113 ((= prev-level 0)
7114 (loop repeat (/ (- cur-level 1) (org-level-increment))
7115 do (org-do-promote)))
7116 ;; If same level as prev, demote one.
7117 ((= prev-level cur-level)
7118 (org-do-demote))
7119 ;; If parent is top-level, promote to top level if not already.
7120 ((= prev-level 1)
7121 (loop repeat (/ (- cur-level 1) (org-level-increment))
7122 do (org-do-promote)))
7123 ;; If top-level, return to prev-level.
7124 ((= cur-level 1)
7125 (loop repeat (/ (- prev-level 1) (org-level-increment))
7126 do (org-do-demote)))
7127 ;; If less than prev-level, promote one.
7128 ((< cur-level prev-level)
7129 (org-do-promote))
7130 ;; If deeper than prev-level, promote until higher than
7131 ;; prev-level.
7132 ((> cur-level prev-level)
7133 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7134 do (org-do-promote))))
7135 t))))
7137 (defun org-map-tree (fun)
7138 "Call FUN for every heading underneath the current one."
7139 (org-back-to-heading)
7140 (let ((level (funcall outline-level)))
7141 (save-excursion
7142 (funcall fun)
7143 (while (and (progn
7144 (outline-next-heading)
7145 (> (funcall outline-level) level))
7146 (not (eobp)))
7147 (funcall fun)))))
7149 (defun org-map-region (fun beg end)
7150 "Call FUN for every heading between BEG and END."
7151 (let ((org-ignore-region t))
7152 (save-excursion
7153 (setq end (copy-marker end))
7154 (goto-char beg)
7155 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
7156 (< (point) end))
7157 (funcall fun))
7158 (while (and (progn
7159 (outline-next-heading)
7160 (< (point) end))
7161 (not (eobp)))
7162 (funcall fun)))))
7164 (defun org-fixup-indentation (diff)
7165 "Change the indentation in the current entry by DIFF.
7166 However, if any line in the current entry has no indentation, or if it
7167 would end up with no indentation after the change, nothing at all is done."
7168 (save-excursion
7169 (let ((end (save-excursion (outline-next-heading)
7170 (point-marker)))
7171 (prohibit (if (> diff 0)
7174 col)
7175 (unless (save-excursion (end-of-line 1)
7176 (re-search-forward prohibit end t))
7177 (while (and (< (point) end)
7179 (goto-char (match-end 0))
7180 (setq col (current-column))
7181 (if (< diff 0) (replace-match ""))
7182 (org-indent-to-column (+ diff col))))
7183 (move-marker end nil))))
7185 (defun org-convert-to-odd-levels ()
7186 "Convert an org-mode file with all levels allowed to one with odd levels.
7187 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7188 level 5 etc."
7189 (interactive)
7190 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7191 (let ((outline-regexp org-outline-regexp)
7192 (outline-level 'org-outline-level)
7193 (org-odd-levels-only nil) n)
7194 (save-excursion
7195 (goto-char (point-min))
7197 (setq n (- (length (match-string 0)) 2))
7198 (while (>= (setq n (1- n)) 0)
7199 (org-demote))
7200 (end-of-line 1))))))
7202 (defun org-convert-to-oddeven-levels ()
7203 "Convert an org-mode file with only odd levels to one with odd/even levels.
7204 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7205 file contains a section with an even level, conversion would
7206 destroy the structure of the file. An error is signaled in this
7207 case."
7208 (interactive)
7209 (goto-char (point-min))
7210 ;; First check if there are no even levels
7212 (org-show-context t)
7213 (error "Not all levels are odd in this file. Conversion not possible"))
7214 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7215 (let ((outline-regexp org-outline-regexp)
7216 (outline-level 'org-outline-level)
7217 (org-odd-levels-only nil) n)
7218 (save-excursion
7219 (goto-char (point-min))
7221 (setq n (/ (1- (length (match-string 0))) 2))
7222 (while (>= (setq n (1- n)) 0)
7223 (org-promote))
7224 (end-of-line 1))))))
7226 (defun org-tr-level (n)
7227 "Make N odd if required."
7228 (if org-odd-levels-only (1+ (/ n 2)) n))
7230 ;;; Vertical tree motion, cutting and pasting of subtrees
7232 (defun org-move-subtree-up (&optional arg)
7233 "Move the current subtree up past ARG headlines of the same level."
7234 (interactive "p")
7235 (org-move-subtree-down (- (prefix-numeric-value arg))))
7237 (defun org-move-subtree-down (&optional arg)
7238 "Move the current subtree down past ARG headlines of the same level."
7239 (interactive "p")
7240 (setq arg (prefix-numeric-value arg))
7241 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7242 'org-get-last-sibling))
7243 (ins-point (make-marker))
7244 (cnt (abs arg))
7245 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7246 ;; Select the tree
7247 (org-back-to-heading)
7248 (setq beg0 (point))
7249 (save-excursion
7250 (setq ne-beg (org-back-over-empty-lines))
7251 (setq beg (point)))
7252 (save-match-data
7253 (save-excursion (outline-end-of-heading)
7254 (setq folded (org-invisible-p)))
7255 (outline-end-of-subtree))
7256 (outline-next-heading)
7257 (setq ne-end (org-back-over-empty-lines))
7258 (setq end (point))
7259 (goto-char beg0)
7260 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7261 ;; include less whitespace
7262 (save-excursion
7263 (goto-char beg)
7264 (forward-line (- ne-beg ne-end))
7265 (setq beg (point))))
7266 ;; Find insertion point, with error handling
7267 (while (> cnt 0)
7268 (or (and (funcall movfunc) (looking-at outline-regexp))
7269 (progn (goto-char beg0)
7270 (error "Cannot move past superior level or buffer limit")))
7271 (setq cnt (1- cnt)))
7272 (if (> arg 0)
7273 ;; Moving forward - still need to move over subtree
7274 (progn (org-end-of-subtree t t)
7275 (save-excursion
7276 (org-back-over-empty-lines)
7277 (or (bolp) (newline)))))
7278 (setq ne-ins (org-back-over-empty-lines))
7279 (move-marker ins-point (point))
7280 (setq txt (buffer-substring beg end))
7281 (org-save-markers-in-region beg end)
7282 (delete-region beg end)
7283 (org-remove-empty-overlays-at beg)
7284 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7285 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7287 (let ((bbb (point)))
7288 (insert-before-markers txt)
7289 (org-reinstall-markers-in-region bbb)
7290 (move-marker ins-point bbb))
7292 (setq ins-end (point))
7293 (goto-char ins-point)
7294 (org-skip-whitespace)
7295 (when (and (< arg 0)
7296 (org-first-sibling-p)
7297 (> ne-ins ne-beg))
7298 ;; Move whitespace back to beginning
7299 (save-excursion
7300 (goto-char ins-end)
7301 (let ((kill-whole-line t))
7302 (kill-line (- ne-ins ne-beg)) (point)))
7304 (move-marker ins-point nil)
7305 (if folded
7306 (hide-subtree)
7307 (org-show-entry)
7308 (show-children)
7309 (org-cycle-hide-drawers 'children))
7310 (org-clean-visibility-after-subtree-move)))
7312 (defvar org-subtree-clip ""
7313 "Clipboard for cut and paste of subtrees.
7314 This is actually only a copy of the kill, because we use the normal kill
7315 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7317 (defvar org-subtree-clip-folded nil
7318 "Was the last copied subtree folded?
7319 This is used to fold the tree back after pasting.")
7321 (defun org-cut-subtree (&optional n)
7322 "Cut the current subtree into the clipboard.
7323 With prefix arg N, cut this many sequential subtrees.
7324 This is a short-hand for marking the subtree and then cutting it."
7325 (interactive "p")
7326 (org-copy-subtree n 'cut))
7328 (defun org-copy-subtree (&optional n cut force-store-markers)
7329 "Cut the current subtree into the clipboard.
7330 With prefix arg N, cut this many sequential subtrees.
7331 This is a short-hand for marking the subtree and then copying it.
7332 If CUT is non-nil, actually cut the subtree.
7333 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7334 of some markers in the region, even if CUT is non-nil. This is
7335 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7336 (interactive "p")
7337 (let (beg end folded (beg0 (point)))
7338 (if (interactive-p)
7339 (org-back-to-heading nil) ; take what looks like a subtree
7340 (org-back-to-heading t)) ; take what is really there
7341 (org-back-over-empty-lines)
7342 (setq beg (point))
7344 (save-match-data
7345 (save-excursion (outline-end-of-heading)
7346 (setq folded (org-invisible-p)))
7347 (condition-case nil
7348 (org-forward-same-level (1- n) t)
7349 (error nil))
7350 (org-end-of-subtree t t))
7351 (org-back-over-empty-lines)
7352 (setq end (point))
7353 (goto-char beg0)
7354 (when (> end beg)
7355 (setq org-subtree-clip-folded folded)
7356 (when (or cut force-store-markers)
7357 (org-save-markers-in-region beg end))
7358 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7359 (setq org-subtree-clip (current-kill 0))
7360 (message "%s: Subtree(s) with %d characters"
7361 (if cut "Cut" "Copied")
7362 (length org-subtree-clip)))))
7364 (defun org-paste-subtree (&optional level tree for-yank)
7365 "Paste the clipboard as a subtree, with modification of headline level.
7366 The entire subtree is promoted or demoted in order to match a new headline
7367 level.
7369 If the cursor is at the beginning of a headline, the same level as
7370 that headline is used to paste the tree
7372 If not, the new level is derived from the *visible* headings
7373 before and after the insertion point, and taken to be the inferior headline
7374 level of the two. So if the previous visible heading is level 3 and the
7375 next is level 4 (or vice versa), level 4 will be used for insertion.
7376 This makes sure that the subtree remains an independent subtree and does
7377 not swallow low level entries.
7379 You can also force a different level, either by using a numeric prefix
7380 argument, or by inserting the heading marker by hand. For example, if the
7383 If optional TREE is given, use this text instead of the kill ring.
7385 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7386 move back over whitespace before inserting, and move point to the end of
7387 the inserted text when done."
7388 (interactive "P")
7389 (setq tree (or tree (and kill-ring (current-kill 0))))
7390 (unless (org-kill-is-subtree-p tree)
7391 (error "%s"
7392 (substitute-command-keys
7394 (let* ((visp (not (org-invisible-p)))
7395 (txt tree)
7400 (old-level (if (string-match ^re txt)
7401 (- (match-end 0) (match-beginning 0) 1)
7402 -1))
7403 (force-level (cond (level (prefix-numeric-value level))
7405 (string-match
7406 ^re_ (buffer-substring
7407 (point-at-bol) (point))))
7408 (- (match-end 1) (match-beginning 1)))
7409 ((and (bolp)
7410 (looking-at org-outline-regexp))
7411 (- (match-end 0) (point) 1))
7412 (t nil)))
7413 (previous-level (save-excursion
7414 (condition-case nil
7415 (progn
7416 (outline-previous-visible-heading 1)
7417 (if (looking-at re)
7418 (- (match-end 0) (match-beginning 0) 1)
7419 1))
7420 (error 1))))
7421 (next-level (save-excursion
7422 (condition-case nil
7423 (progn
7424 (or (looking-at outline-regexp)
7425 (outline-next-visible-heading 1))
7426 (if (looking-at re)
7427 (- (match-end 0) (match-beginning 0) 1)
7428 1))
7429 (error 1))))
7430 (new-level (or force-level (max previous-level next-level)))
7431 (shift (if (or (= old-level -1)
7432 (= new-level -1)
7433 (= old-level new-level))
7434 0
7435 (- new-level old-level)))
7436 (delta (if (> shift 0) -1 1))
7437 (func (if (> shift 0) 'org-demote 'org-promote))
7438 (org-odd-levels-only nil)
7439 beg end newend)
7440 ;; Remove the forced level indicator
7441 (if force-level
7442 (delete-region (point-at-bol) (point)))
7443 ;; Paste
7444 (beginning-of-line 1)
7445 (unless for-yank (org-back-over-empty-lines))
7446 (setq beg (point))
7447 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7448 (insert-before-markers txt)
7450 (setq newend (point))
7451 (org-reinstall-markers-in-region beg)
7452 (setq end (point))
7453 (goto-char beg)
7455 (setq beg (point))
7456 (if (and (org-invisible-p) visp)
7457 (save-excursion (outline-show-heading)))
7458 ;; Shift if necessary
7459 (unless (= shift 0)
7460 (save-restriction
7461 (narrow-to-region beg end)
7462 (while (not (= shift 0))
7463 (org-map-region func (point-min) (point-max))
7464 (setq shift (+ delta shift)))
7465 (goto-char (point-min))
7466 (setq newend (point-max))))
7467 (when (or (interactive-p) for-yank)
7468 (message "Clipboard pasted as level %d subtree" new-level))
7469 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7470 kill-ring
7471 (eq org-subtree-clip (current-kill 0))
7472 org-subtree-clip-folded)
7473 ;; The tree was folded before it was killed/copied
7474 (hide-subtree))
7475 (and for-yank (goto-char newend))))
7477 (defun org-kill-is-subtree-p (&optional txt)
7478 "Check if the current kill is an outline subtree, or a set of trees.
7479 Returns nil if kill does not start with a headline, or if the first
7480 headline level is not the largest headline level in the tree.
7481 So this will actually accept several entries of equal levels as well,
7482 which is OK for `org-paste-subtree'.
7483 If optional TXT is given, check this string instead of the current kill."
7484 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7485 (start-level (and kill
7488 kill)
7489 (- (match-end 2) (match-beginning 2) 1)))
7490 (re (concat "^" org-outline-regexp))
7491 (start (1+ (or (match-beginning 2) -1))))
7492 (if (not start-level)
7493 (progn
7494 nil) ;; does not even start with a heading
7495 (catch 'exit
7496 (while (setq start (string-match re kill (1+ start)))
7497 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7498 (throw 'exit nil)))
7499 t))))
7501 (defvar org-markers-to-move nil
7502 "Markers that should be moved with a cut-and-paste operation.
7503 Those markers are stored together with their positions relative to
7504 the start of the region.")
7506 (defun org-save-markers-in-region (beg end)
7507 "Check markers in region.
7508 If these markers are between BEG and END, record their position relative
7509 to BEG, so that after moving the block of text, we can put the markers back
7510 into place.
7511 This function gets called just before an entry or tree gets cut from the
7512 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7513 called immediately, to move the markers with the entries."
7514 (setq org-markers-to-move nil)
7515 (when (featurep 'org-clock)
7516 (org-clock-save-markers-for-cut-and-paste beg end))
7517 (when (featurep 'org-agenda)
7518 (org-agenda-save-markers-for-cut-and-paste beg end)))
7520 (defun org-check-and-save-marker (marker beg end)
7521 "Check if MARKER is between BEG and END.
7522 If yes, remember the marker and the distance to BEG."
7523 (when (and (marker-buffer marker)
7524 (equal (marker-buffer marker) (current-buffer)))
7525 (if (and (>= marker beg) (< marker end))
7526 (push (cons marker (- marker beg)) org-markers-to-move))))
7528 (defun org-reinstall-markers-in-region (beg)
7529 "Move all remembered markers to their position relative to BEG."
7530 (mapc (lambda (x)
7531 (move-marker (car x) (+ beg (cdr x))))
7532 org-markers-to-move)
7533 (setq org-markers-to-move nil))
7535 (defun org-narrow-to-subtree ()
7536 "Narrow buffer to the current subtree."
7537 (interactive)
7538 (save-excursion
7539 (save-match-data
7540 (narrow-to-region
7541 (progn (org-back-to-heading t) (point))
7542 (progn (org-end-of-subtree t t)
7543 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7544 (point))))))
7546 (eval-when-compile
7547 (defvar org-property-drawer-re))
7549 (defun org-clone-subtree-with-time-shift (n &optional shift)
7550 "Clone the task (subtree) at point N times.
7551 The clones will be inserted as siblings.
7553 In interactive use, the user will be prompted for the number of
7554 clones to be produced, and for a time SHIFT, which may be a
7555 repeater as used in time stamps, for example `+3d'.
7557 When a valid repeater is given and the entry contains any time
7558 stamps, the clones will become a sequence in time, with time
7559 stamps in the subtree shifted for each clone produced. If SHIFT
7560 is nil or the empty string, time stamps will be left alone. The
7561 ID property of the original subtree is removed.
7563 If the original subtree did contain time stamps with a repeater,
7564 the following will happen:
7565 - the repeater will be removed in each clone
7566 - an additional clone will be produced, with the current, unshifted
7567 date(s) in the entry.
7568 - the original entry will be placed *after* all the clones, with
7569 repeater intact.
7570 - the start days in the repeater in the original entry will be shifted
7571 to past the last clone.
7572 I this way you can spell out a number of instances of a repeating task,
7573 and still retain the repeater to cover future instances of the task."
7574 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7575 (let (beg end template task idprop
7576 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7577 (if (not (and (integerp n) (> n 0)))
7578 (error "Invalid number of replications %s" n))
7581 shift)))
7582 (error "Invalid shift specification %s" shift))
7583 (when doshift
7584 (setq shift-n (string-to-number (match-string 1 shift))
7585 shift-what (cdr (assoc (match-string 2 shift)
7586 '(("d" . day) ("w" . week)
7587 ("m" . month) ("y" . year))))))
7588 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7589 (setq nmin 1 nmax n)
7590 (org-back-to-heading t)
7591 (setq beg (point))
7592 (setq idprop (org-entry-get nil "ID"))
7593 (org-end-of-subtree t t)
7595 (setq end (point))
7596 (setq template (buffer-substring beg end))
7597 (when (and doshift
7599 (delete-region beg end)
7600 (setq end beg)
7601 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7602 (goto-char end)
7603 (loop for n from nmin to nmax do
7604 ;; prepare clone
7605 (with-temp-buffer
7606 (insert template)
7607 (org-mode)
7608 (goto-char (point-min))
7609 (and idprop (if org-clone-delete-id
7610 (org-entry-delete nil "ID")
7611 (org-id-get-create t)))
7612 (while (re-search-forward org-property-start-re nil t)
7613 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7614 (goto-char (point-min))
7615 (when doshift
7616 (while (re-search-forward org-ts-regexp-both nil t)
7617 (org-timestamp-change (* n shift-n) shift-what))
7618 (unless (= n n-no-remove)
7619 (goto-char (point-min))
7620 (while (re-search-forward org-ts-regexp nil t)
7621 (save-excursion
7622 (goto-char (match-beginning 0))
7624 (delete-region (match-beginning 1) (match-end 1)))))))
7625 (setq task (buffer-string)))
7626 (insert task))
7627 (goto-char beg)))
7629 ;;; Outline Sorting
7631 (defun org-sort (with-case)
7632 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7633 Optional argument WITH-CASE means sort case-sensitively.
7634 With a double prefix argument, also remove duplicate entries."
7635 (interactive "P")
7636 (cond
7637 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7638 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7639 (t
7640 (org-call-with-arg 'org-sort-entries with-case))))
7642 (defun org-sort-remove-invisible (s)
7643 (remove-text-properties 0 (length s) org-rm-props s)
7644 (while (string-match org-bracket-link-regexp s)
7645 (setq s (replace-match (if (match-end 2)
7646 (match-string 3 s)
7647 (match-string 1 s)) t t s)))
7648 s)
7650 (defvar org-priority-regexp) ; defined later in the file
7652 (defvar org-after-sorting-entries-or-items-hook nil
7653 "Hook that is run after a bunch of entries or items have been sorted.
7654 When children are sorted, the cursor is in the parent line when this
7655 hook gets called. When a region or a plain list is sorted, the cursor
7656 will be in the first entry of the sorted region/list.")
7658 (defun org-sort-entries
7659 (&optional with-case sorting-type getkey-func compare-func property)
7660 "Sort entries on a certain level of an outline tree.
7661 If there is an active region, the entries in the region are sorted.
7662 Else, if the cursor is before the first entry, sort the top-level items.
7663 Else, the children of the entry at point are sorted.
7665 Sorting can be alphabetically, numerically, by date/time as given by
7666 a time stamp, by a property or by priority.
7668 The command prompts for the sorting type unless it has been given to the
7669 function through the SORTING-TYPE argument, which needs to be a character,
7670 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7671 precise meaning of each character:
7673 n Numerically, by converting the beginning of the entry/item to a number.
7674 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7675 t By date/time, either the first active time stamp in the entry, or, if
7676 none exist, by the first inactive one.
7677 s By the scheduled date/time.
7678 d By deadline date/time.
7679 c By creation time, which is assumed to be the first inactive time stamp
7680 at the beginning of a line.
7681 p By priority according to the cookie.
7682 r By the value of a property.
7684 Capital letters will reverse the sort order.
7686 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7687 called with point at the beginning of the record. It must return either
7688 a string or a number that should serve as the sorting key for that record.
7690 Comparing entries ignores case by default. However, with an optional argument
7691 WITH-CASE, the sorting considers case as well."
7692 (interactive "P")
7693 (let ((case-func (if with-case 'identity 'downcase))
7694 start beg end stars re re2
7695 txt what tmp)
7696 ;; Find beginning and end of region to sort
7697 (cond
7698 ((org-region-active-p)
7699 ;; we will sort the region
7700 (setq end (region-end)
7701 what "region")
7702 (goto-char (region-beginning))
7703 (if (not (org-on-heading-p)) (outline-next-heading))
7704 (setq start (point)))
7705 ((or (org-on-heading-p)
7706 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7707 ;; we will sort the children of the current headline
7708 (org-back-to-heading)
7709 (setq start (point)
7710 end (progn (org-end-of-subtree t t)
7712 (org-back-over-empty-lines)
7713 (point))
7714 what "children")
7715 (goto-char start)
7716 (show-subtree)
7717 (outline-next-heading))
7718 (t
7719 ;; we will sort the top-level entries in this file
7720 (goto-char (point-min))
7721 (or (org-on-heading-p) (outline-next-heading))
7722 (setq start (point))
7723 (goto-char (point-max))
7724 (beginning-of-line 1)
7726 ;; File ends in a non-white line
7727 (end-of-line 1)
7729 (setq end (point-max))
7730 (setq what "top-level")
7731 (goto-char start)
7732 (show-all)))
7734 (setq beg (point))
7735 (if (>= beg end) (error "Nothing to sort"))
7738 (setq stars (match-string 1)
7739 re (concat "^" (regexp-quote stars) " +")
7740 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
7741 txt (buffer-substring beg end))
7743 (if (and (not (equal stars "*")) (string-match re2 txt))
7744 (error "Region to sort contains a level above the first entry"))
7746 (unless sorting-type
7747 (message
7748 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7750 A/N/T/S/D/C/P/O/F means reversed:"
7751 what)
7752 (setq sorting-type (read-char-exclusive))
7754 (and (= (downcase sorting-type) ?f)
7755 (setq getkey-func
7756 (org-icompleting-read "Sort using function: "
7757 obarray 'fboundp t nil nil))
7758 (setq getkey-func (intern getkey-func)))
7760 (and (= (downcase sorting-type) ?r)
7761 (setq property
7762 (org-icompleting-read "Property: "
7763 (mapcar 'list (org-buffer-property-keys t))
7764 nil t))))
7766 (message "Sorting entries...")
7768 (save-restriction
7769 (narrow-to-region start end)
7770 (let ((dcst (downcase sorting-type))
7771 (case-fold-search nil)
7772 (now (current-time)))
7773 (sort-subr
7774 (/= dcst sorting-type)
7775 ;; This function moves to the beginning character of the "record" to
7776 ;; be sorted.
7777 (lambda nil
7778 (if (re-search-forward re nil t)
7779 (goto-char (match-beginning 0))
7780 (goto-char (point-max))))
7781 ;; This function moves to the last character of the "record" being
7782 ;; sorted.
7783 (lambda nil
7784 (save-match-data
7785 (condition-case nil
7786 (outline-forward-same-level 1)
7787 (error
7788 (goto-char (point-max))))))
7789 ;; This function returns the value that gets sorted against.
7790 (lambda nil
7791 (cond
7792 ((= dcst ?n)
7793 (if (looking-at org-complex-heading-regexp)
7794 (string-to-number (match-string 4))
7795 nil))
7796 ((= dcst ?a)
7797 (if (looking-at org-complex-heading-regexp)
7798 (funcall case-func (match-string 4))
7799 nil))
7800 ((= dcst ?t)
7801 (let ((end (save-excursion (outline-next-heading) (point))))
7802 (if (or (re-search-forward org-ts-regexp end t)
7803 (re-search-forward org-ts-regexp-both end t))
7804 (org-time-string-to-seconds (match-string 0))
7805 (org-float-time now))))
7806 ((= dcst ?c)
7807 (let ((end (save-excursion (outline-next-heading) (point))))
7808 (if (re-search-forward
7810 end t)
7811 (org-time-string-to-seconds (match-string 0))
7812 (org-float-time now))))
7813 ((= dcst ?s)
7814 (let ((end (save-excursion (outline-next-heading) (point))))
7815 (if (re-search-forward org-scheduled-time-regexp end t)
7816 (org-time-string-to-seconds (match-string 1))
7817 (org-float-time now))))
7818 ((= dcst ?d)
7819 (let ((end (save-excursion (outline-next-heading) (point))))
7820 (if (re-search-forward org-deadline-time-regexp end t)
7821 (org-time-string-to-seconds (match-string 1))
7822 (org-float-time now))))
7823 ((= dcst ?p)
7824 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7825 (string-to-char (match-string 2))
7826 org-default-priority))
7827 ((= dcst ?r)
7828 (or (org-entry-get nil property) ""))
7829 ((= dcst ?o)
7830 (if (looking-at org-complex-heading-regexp)
7831 (- 9999 (length (member (match-string 2)
7832 org-todo-keywords-1)))))
7833 ((= dcst ?f)
7834 (if getkey-func
7835 (progn
7836 (setq tmp (funcall getkey-func))
7837 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7838 tmp)
7839 (error "Invalid key function `%s'" getkey-func)))
7840 (t (error "Invalid sorting type `%c'" sorting-type))))
7841 nil
7842 (cond
7843 ((= dcst ?a) 'string<)
7844 ((= dcst ?f) compare-func)
7845 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7846 (t nil)))))
7847 (run-hooks 'org-after-sorting-entries-or-items-hook)
7848 (message "Sorting entries...done")))
7850 (defun org-do-sort (table what &optional with-case sorting-type)
7851 "Sort TABLE of WHAT according to SORTING-TYPE.
7852 The user will be prompted for the SORTING-TYPE if the call to this
7853 function does not specify it. WHAT is only for the prompt, to indicate
7854 what is being sorted. The sorting key will be extracted from
7855 the car of the elements of the table.
7856 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7857 (unless sorting-type
7858 (message
7859 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7860 what)
7861 (setq sorting-type (read-char-exclusive)))
7862 (let ((dcst (downcase sorting-type))
7863 extractfun comparefun)
7864 ;; Define the appropriate functions
7865 (cond
7866 ((= dcst ?n)
7867 (setq extractfun 'string-to-number
7868 comparefun (if (= dcst sorting-type) '< '>)))
7869 ((= dcst ?a)
7870 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7871 (lambda(x) (downcase (org-sort-remove-invisible x))))
7872 comparefun (if (= dcst sorting-type)
7873 'string<
7874 (lambda (a b) (and (not (string< a b))
7875 (not (string= a b)))))))
7876 ((= dcst ?t)
7877 (setq extractfun
7878 (lambda (x)
7879 (if (or (string-match org-ts-regexp x)
7880 (string-match org-ts-regexp-both x))
7881 (org-float-time
7882 (org-time-string-to-time (match-string 0 x)))
7883 0))
7884 comparefun (if (= dcst sorting-type) '< '>)))
7885 (t (error "Invalid sorting type `%c'" sorting-type)))
7887 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7888 table)
7889 (lambda (a b) (funcall comparefun (car a) (car b))))))
7892 ;;; The orgstruct minor mode
7894 ;; Define a minor mode which can be used in other modes in order to
7895 ;; integrate the org-mode structure editing commands.
7897 ;; This is really a hack, because the org-mode structure commands use
7898 ;; keys which normally belong to the major mode. Here is how it
7899 ;; works: The minor mode defines all the keys necessary to operate the
7900 ;; structure commands, but wraps the commands into a function which
7901 ;; tests if the cursor is currently at a headline or a plain list
7902 ;; item. If that is the case, the structure command is used,
7903 ;; temporarily setting many Org-mode variables like regular
7904 ;; expressions for filling etc. However, when any of those keys is
7905 ;; used at a different location, function uses `key-binding' to look
7906 ;; up if the key has an associated command in another currently active
7907 ;; keymap (minor modes, major mode, global), and executes that
7908 ;; command. There might be problems if any of the keys is otherwise
7909 ;; used as a prefix key.
7911 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7912 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7913 ;; addresses this by checking explicitly for both bindings.
7915 (defvar orgstruct-mode-map (make-sparse-keymap)
7916 "Keymap for the minor `orgstruct-mode'.")
7918 (defvar org-local-vars nil
7919 "List of local variables, for use by `orgstruct-mode'.")
7921 ;;;###autoload
7922 (define-minor-mode orgstruct-mode
7923 "Toggle the minor mode `orgstruct-mode'.
7924 This mode is for using Org-mode structure commands in other
7925 modes. The following keys behave as if Org-mode were active, if
7926 the cursor is on a headline, or on a plain list item (both as
7927 defined by Org-mode).
7929 M-up Move entry/item up
7930 M-down Move entry/item down
7931 M-left Promote
7932 M-right Demote
7933 M-S-up Move entry/item up
7934 M-S-down Move entry/item down
7935 M-S-left Promote subtree
7936 M-S-right Demote subtree
7937 M-q Fill paragraph and items like in Org-mode
7938 C-c ^ Sort entries
7939 C-c - Cycle list bullet
7940 TAB Cycle item visibility
7941 M-RET Insert new heading/item
7942 S-M-RET Insert new TODO heading / Checkbox item
7943 C-c C-c Set tags / toggle checkbox"
7944 nil " OrgStruct" nil
7945 (org-load-modules-maybe)
7946 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7948 ;;;###autoload
7949 (defun turn-on-orgstruct ()
7950 "Unconditionally turn on `orgstruct-mode'."
7951 (orgstruct-mode 1))
7953 (defun orgstruct++-mode (&optional arg)
7954 "Toggle `orgstruct-mode', the enhanced version of it.
7955 In addition to setting orgstruct-mode, this also exports all indentation
7956 and autofilling variables from org-mode into the buffer. It will also
7957 recognize item context in multiline items.
7958 Note that turning off orgstruct-mode will *not* remove the
7959 indentation/paragraph settings. This can only be done by refreshing the
7961 (interactive "P")
7962 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
7963 (if (< arg 1)
7964 (orgstruct-mode -1)
7965 (orgstruct-mode 1)
7966 (let (var val)
7967 (mapc
7968 (lambda (x)
7969 (when (string-match
7971 (symbol-name (car x)))
7972 (setq var (car x) val (nth 1 x))
7973 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7974 org-local-vars)
7975 (org-set-local 'orgstruct-is-++ t))))
7977 (defvar orgstruct-is-++ nil
7978 "Is `orgstruct-mode' in ++ version in the current-buffer?")
7979 (make-variable-buffer-local 'orgstruct-is-++)
7981 ;;;###autoload
7982 (defun turn-on-orgstruct++ ()
7983 "Unconditionally turn on `orgstruct++-mode'."
7984 (orgstruct++-mode 1))
7986 (defun orgstruct-error ()
7987 "Error when there is no default binding for a structure key."
7988 (interactive)
7989 (error "This key has no function outside structure elements"))
7991 (defun orgstruct-setup ()
7992 "Setup orgstruct keymaps."
7993 (let ((nfunc 0)
7994 (bindings
7995 (list
7996 '([(meta up)] org-metaup)
7997 '([(meta down)] org-metadown)
7998 '([(meta left)] org-metaleft)
7999 '([(meta right)] org-metaright)
8000 '([(meta shift up)] org-shiftmetaup)
8001 '([(meta shift down)] org-shiftmetadown)
8002 '([(meta shift left)] org-shiftmetaleft)
8003 '([(meta shift right)] org-shiftmetaright)
8004 '([?\e (up)] org-metaup)
8005 '([?\e (down)] org-metadown)
8006 '([?\e (left)] org-metaleft)
8007 '([?\e (right)] org-metaright)
8008 '([?\e (shift up)] org-shiftmetaup)
8009 '([?\e (shift down)] org-shiftmetadown)
8010 '([?\e (shift left)] org-shiftmetaleft)
8011 '([?\e (shift right)] org-shiftmetaright)
8012 '([(shift up)] org-shiftup)
8013 '([(shift down)] org-shiftdown)
8014 '([(shift left)] org-shiftleft)
8015 '([(shift right)] org-shiftright)
8016 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8017 '("\M-q" fill-paragraph)
8018 '("\C-c^" org-sort)
8019 '("\C-c-" org-cycle-list-bullet)))
8020 elt key fun cmd)
8021 (while (setq elt (pop bindings))
8022 (setq nfunc (1+ nfunc))
8023 (setq key (org-key (car elt))
8024 fun (nth 1 elt)
8025 cmd (orgstruct-make-binding fun nfunc key))
8026 (org-defkey orgstruct-mode-map key cmd))
8028 ;; Special treatment needed for TAB and RET
8029 (org-defkey orgstruct-mode-map [(tab)]
8030 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8031 (org-defkey orgstruct-mode-map "\C-i"
8032 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8034 (org-defkey orgstruct-mode-map "\M-\C-m"
8035 (orgstruct-make-binding 'org-insert-heading 105
8036 "\M-\C-m" [(meta return)]))
8037 (org-defkey orgstruct-mode-map [(meta return)]
8038 (orgstruct-make-binding 'org-insert-heading 106
8039 [(meta return)] "\M-\C-m"))
8041 (org-defkey orgstruct-mode-map [(shift meta return)]
8042 (orgstruct-make-binding 'org-insert-todo-heading 107
8043 [(meta return)] "\M-\C-m"))
8045 (org-defkey orgstruct-mode-map "\e\C-m"
8046 (orgstruct-make-binding 'org-insert-heading 108
8047 "\e\C-m" [?\e (return)]))
8048 (org-defkey orgstruct-mode-map [?\e (return)]
8049 (orgstruct-make-binding 'org-insert-heading 109
8050 [?\e (return)] "\e\C-m"))
8051 (org-defkey orgstruct-mode-map [?\e (shift return)]
8052 (orgstruct-make-binding 'org-insert-todo-heading 110
8053 [?\e (return)] "\e\C-m"))
8055 (unless org-local-vars
8056 (setq org-local-vars (org-get-local-variables)))
8058 t))
8060 (defun orgstruct-make-binding (fun n &rest keys)
8061 "Create a function for binding in the structure minor mode.
8062 FUN is the command to call inside a table. N is used to create a unique
8063 command name. KEYS are keys that should be checked in for a command
8064 to execute outside of tables."
8065 (eval
8066 (list 'defun
8067 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8068 '(arg)
8070 "Outside of structure, run the binding of `"
8071 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8072 "'.")
8073 '(interactive "p")
8074 (list 'if
8075 `(org-context-p 'headline 'item
8076 (and orgstruct-is-++
8077 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8078 'item-body))
8079 (list 'org-run-like-in-org-mode (list 'quote fun))
8080 (list 'let '(orgstruct-mode)
8081 (list 'call-interactively
8082 (append '(or)
8083 (mapcar (lambda (k)
8084 (list 'key-binding k))
8085 keys)
8086 '('orgstruct-error))))))))
8088 (defun org-context-p (&rest contexts)
8089 "Check if local context is any of CONTEXTS.
8090 Possible values in the list of contexts are `table', `headline', and `item'."
8091 (let ((pos (point)))
8092 (goto-char (point-at-bol))
8093 (prog1 (or (and (memq 'table contexts)
8095 (and (memq 'headline contexts)
8097 (looking-at outline-regexp))
8098 (and (memq 'item contexts)
8100 (and (memq 'item-body contexts)
8101 (org-in-item-p)))
8102 (goto-char pos))))
8104 (defun org-get-local-variables ()
8105 "Return a list of all local variables in an org-mode buffer."
8106 (let (varlist)
8107 (with-current-buffer (get-buffer-create "*Org tmp*")
8108 (erase-buffer)
8109 (org-mode)
8110 (setq varlist (buffer-local-variables)))
8111 (kill-buffer "*Org tmp*")
8112 (delq nil
8113 (mapcar
8114 (lambda (x)
8115 (setq x
8116 (if (symbolp x)
8117 (list x)
8118 (list (car x) (list 'quote (cdr x)))))
8119 (if (string-match
8120 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8121 (symbol-name (car x)))
8122 x nil))
8123 varlist))))
8125 ;;;###autoload
8126 (defun org-run-like-in-org-mode (cmd)
8127 "Run a command, pretending that the current buffer is in Org-mode.
8128 This will temporarily bind local variables that are typically bound in
8129 Org-mode to the values they have in Org-mode, and then interactively
8130 call CMD."
8131 (org-load-modules-maybe)
8132 (unless org-local-vars
8133 (setq org-local-vars (org-get-local-variables)))
8134 (eval (list 'let org-local-vars
8135 (list 'call-interactively (list 'quote cmd)))))
8137 ;;;; Archiving
8139 (defun org-get-category (&optional pos)
8140 "Get the category applying to position POS."
8141 (get-text-property (or pos (point)) 'org-category))
8143 (defun org-refresh-category-properties ()
8144 "Refresh category text properties in the buffer."
8145 (let ((def-cat (cond
8146 ((null org-category)
8147 (if buffer-file-name
8148 (file-name-sans-extension
8149 (file-name-nondirectory buffer-file-name))
8150 "???"))
8151 ((symbolp org-category) (symbol-name org-category))
8152 (t org-category)))
8153 beg end cat pos optionp)
8154 (org-unmodified
8155 (save-excursion
8156 (save-restriction
8157 (widen)
8158 (goto-char (point-min))
8159 (put-text-property (point) (point-max) 'org-category def-cat)
8160 (while (re-search-forward
8162 (setq pos (match-end 0)
8163 optionp (equal (char-after (match-beginning 0)) ?#)
8164 cat (org-trim (match-string 2)))
8165 (if optionp
8166 (setq beg (point-at-bol) end (point-max))
8167 (org-back-to-heading t)
8168 (setq beg (point) end (org-end-of-subtree t t)))
8169 (put-text-property beg end 'org-category cat)
8170 (goto-char pos)))))))
8173 ;;;; Link Stuff
8175 ;;; Link abbreviations
8177 (defun org-link-expand-abbrev (link)
8178 "Apply replacements as defined in `org-link-abbrev-alist."
8180 (let* ((key (match-string 1 link))
8181 (as (or (assoc key org-link-abbrev-alist-local)
8182 (assoc key org-link-abbrev-alist)))
8183 (tag (and (match-end 2) (match-string 3 link)))
8184 rpl)
8185 (if (not as)
8186 link
8187 (setq rpl (cdr as))
8188 (cond
8189 ((symbolp rpl) (funcall rpl tag))
8190 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8191 ((string-match "%h" rpl)
8192 (replace-match (url-hexify-string (or tag "")) t t rpl))
8193 (t (concat rpl tag)))))
8194 link))
8196 ;;; Storing and inserting links
8198 (defvar org-insert-link-history nil
8199 "Minibuffer history for links inserted with `org-insert-link'.")
8201 (defvar org-stored-links nil
8202 "Contains the links stored with `org-store-link'.")
8204 (defvar org-store-link-plist nil
8205 "Plist with info about the most recently link created with `org-store-link'.")
8207 (defvar org-link-protocols nil
8208 "Link protocols added to Org-mode using `org-add-link-type'.")
8210 (defvar org-store-link-functions nil
8211 "List of functions that are called to create and store a link.
8212 Each function will be called in turn until one returns a non-nil
8213 value. Each function should check if it is responsible for creating
8214 this link (for example by looking at the major mode).
8215 If not, it must exit and return nil.
8216 If yes, it should return a non-nil value after a calling
8217 `org-store-link-props' with a list of properties and values.
8218 Special properties are:
8222 This is obligatory as well.
8223 :description Optional default description for the second pair
8224 of brackets in an Org-mode link. The user can still change
8225 this when inserting this link into an Org-mode buffer.
8227 In addition to these, any additional properties can be specified
8228 and then used in remember templates.")
8230 (defun org-add-link-type (type &optional follow export)
8231 "Add TYPE to the list of `org-link-types'.
8232 Re-compute all regular expressions depending on `org-link-types'
8234 FOLLOW and EXPORT are two functions.
8236 FOLLOW should take the link path as the single argument and do whatever
8237 is necessary to follow the link, for example find a file or display
8238 a mail message.
8240 EXPORT should format the link path for export to one of the export formats.
8241 It should be a function accepting three arguments:
8244 desc the description of the link, if any, nil if there was no description
8245 format the export format, a symbol like `html' or `latex' or `ascii'..
8247 The function may use the FORMAT information to return different values
8248 depending on the format. The return value will be put literally into
8249 the exported file. If the return value is nil, this means Org should
8250 do what it normally does with links which do not have EXPORT defined.
8252 Org-mode has a built-in default for exporting links. If you are happy with
8253 this default, there is no need to define an export function for the link
8254 type. For a simple example of an export function, see `org-bbdb.el'."
8255 (add-to-list 'org-link-types type t)
8256 (org-make-link-regexps)
8257 (if (assoc type org-link-protocols)
8258 (setcdr (assoc type org-link-protocols) (list follow export))
8259 (push (list type follow export) org-link-protocols)))
8261 (defvar org-agenda-buffer-name)
8263 ;;;###autoload
8264 (defun org-store-link (arg)
8266 This link is added to `org-stored-links' and can later be inserted
8269 For some link types, a prefix arg is interpreted:
8270 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8271 For file links, arg negates `org-context-in-file-links'."
8272 (interactive "P")
8273 (org-load-modules-maybe)
8274 (setq org-store-link-plist nil) ; reset
8275 (let ((outline-regexp (org-get-limited-outline-regexp))
8276 link cpltxt desc description search txt custom-id agenda-link)
8277 (cond
8279 ((run-hook-with-args-until-success 'org-store-link-functions)
8280 (setq link (plist-get org-store-link-plist :link)
8281 desc (or (plist-get org-store-link-plist :description) link)))
8283 ((equal (buffer-name) "*Org Edit Src Example*")
8284 (let (label gc)
8285 (while (or (not label)
8286 (save-excursion
8287 (save-restriction
8288 (widen)
8289 (goto-char (point-min))
8290 (re-search-forward
8291 (regexp-quote (format org-coderef-label-format label))
8292 nil t))))
8293 (when label (message "Label exists already") (sit-for 2))
8294 (setq label (read-string "Code line label: " label)))
8295 (end-of-line 1)
8296 (setq link (format org-coderef-label-format label))
8297 (setq gc (- 79 (length link)))
8298 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8299 (insert link)
8300 (setq link (concat "(" label ")") desc nil)))
8302 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8303 ;; We are in the agenda, link to referenced location
8304 (let ((m (or (get-text-property (point) 'org-hd-marker)
8305 (get-text-property (point) 'org-marker))))
8306 (when m
8307 (org-with-point-at m
8308 (setq agenda-link
8309 (if (interactive-p)
8310 (call-interactively 'org-store-link)
8311 (org-store-link nil)))))))
8313 ((eq major-mode 'calendar-mode)
8314 (let ((cd (calendar-cursor-to-date)))
8315 (setq link
8316 (format-time-string
8317 (car org-time-stamp-formats)
8318 (apply 'encode-time
8319 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8320 nil nil nil))))
8321 (org-store-link-props :type "calendar" :date cd)))
8323 ((eq major-mode 'w3-mode)
8324 (setq cpltxt (if (and (buffer-name)
8325 (not (string-match "Untitled" (buffer-name))))
8326 (buffer-name)
8327 (url-view-url t))
8328 link (org-make-link (url-view-url t)))
8329 (org-store-link-props :type "w3" :url (url-view-url t)))
8331 ((eq major-mode 'w3m-mode)
8332 (setq cpltxt (or w3m-current-title w3m-current-url)
8333 link (org-make-link w3m-current-url))
8334 (org-store-link-props :type "w3m" :url (url-view-url t)))
8336 ((setq search (run-hook-with-args-until-success
8337 'org-create-file-search-functions))
8338 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8339 "::" search))
8340 (setq cpltxt (or description link)))
8342 ((eq major-mode 'image-mode)
8343 (setq cpltxt (concat "file:"
8344 (abbreviate-file-name buffer-file-name))
8345 link (org-make-link cpltxt))
8346 (org-store-link-props :type "image" :file buffer-file-name))
8348 ((eq major-mode 'dired-mode)
8349 ;; link to the file in the current line
8350 (let ((file (dired-get-filename nil t)))
8351 (setq file (if file
8352 (abbreviate-file-name
8353 (expand-file-name (dired-get-filename nil t)))
8354 ;; otherwise, no file so use current directory.
8355 default-directory))
8356 (setq cpltxt (concat "file:" file)
8357 link (org-make-link cpltxt))))
8359 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8360 (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
8361 (cond
8363 (setq cpltxt
8364 (concat "file:"
8365 (abbreviate-file-name
8366 (buffer-file-name (buffer-base-buffer)))
8367 "::" (match-string 1))
8368 link (org-make-link cpltxt)))
8369 ((and (featurep 'org-id)
8370 (or (eq org-link-to-org-use-id t)
8371 (and (eq org-link-to-org-use-id 'create-if-interactive)
8372 (interactive-p))
8373 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
8374 (interactive-p)
8375 (not custom-id))
8376 (and org-link-to-org-use-id
8377 (condition-case nil
8378 (org-entry-get nil "ID")
8379 (error nil)))))
8380 ;; We can make a link using the ID.
8381 (setq link (condition-case nil
8382 (prog1 (org-id-store-link)
8383 (setq desc (plist-get org-store-link-plist
8384 :description)))
8385 (error
8386 ;; probably before first headline, link to file only
8387 (concat "file:"
8388 (abbreviate-file-name
8389 (buffer-file-name (buffer-base-buffer))))))))
8390 (t
8391 ;; Just link to current headline
8392 (setq cpltxt (concat "file:"
8393 (abbreviate-file-name
8394 (buffer-file-name (buffer-base-buffer)))))
8395 ;; Add a context search string
8396 (when (org-xor org-context-in-file-links arg)
8397 (setq txt (cond
8398 ((org-on-heading-p) nil)
8399 ((org-region-active-p)
8400 (buffer-substring (region-beginning) (region-end)))
8401 (t nil)))
8403 (setq cpltxt
8404 (concat cpltxt "::"
8405 (condition-case nil
8406 (org-make-org-heading-search-string txt)
8407 (error "")))
8408 desc (or (nth 4 (ignore-errors
8409 (org-heading-components))) "NONE"))))
8411 (setq cpltxt (substring cpltxt 0 -2)))
8412 (setq link (org-make-link cpltxt)))))
8414 ((buffer-file-name (buffer-base-buffer))
8415 ;; Just link to this file here.
8416 (setq cpltxt (concat "file:"
8417 (abbreviate-file-name
8418 (buffer-file-name (buffer-base-buffer)))))
8419 ;; Add a context string
8420 (when (org-xor org-context-in-file-links arg)
8421 (setq txt (if (org-region-active-p)
8422 (buffer-substring (region-beginning) (region-end))
8423 (buffer-substring (point-at-bol) (point-at-eol))))
8424 ;; Only use search option if there is some text.
8426 (setq cpltxt
8427 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8428 desc "NONE")))
8429 (setq link (org-make-link cpltxt)))
8431 ((interactive-p)
8432 (error "Cannot link to a buffer which is not visiting a file"))
8434 (t (setq link nil)))
8436 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8437 (setq link (or link cpltxt)
8438 desc (or desc cpltxt))
8439 (if (equal desc "NONE") (setq desc nil))
8441 (if (and (or (interactive-p) executing-kbd-macro) link)
8442 (progn
8443 (setq org-stored-links
8444 (cons (list link desc) org-stored-links))
8445 (message "Stored: %s" (or desc link))
8446 (when custom-id
8447 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8448 "::#" custom-id))
8449 (setq org-stored-links
8450 (cons (list link desc) org-stored-links))))
8451 (or agenda-link (and link (org-make-link-string link desc))))))
8453 (defun org-store-link-props (&rest plist)
8454 "Store link properties, extract names and addresses."
8455 (let (x adr)
8456 (when (setq x (plist-get plist :from))
8457 (setq adr (mail-extract-address-components x))
8458 (setq plist (plist-put plist :fromname (car adr)))
8459 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8460 (when (setq x (plist-get plist :to))
8461 (setq adr (mail-extract-address-components x))
8462 (setq plist (plist-put plist :toname (car adr)))
8463 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8464 (let ((from (plist-get plist :from))
8465 (to (plist-get plist :to)))
8466 (when (and from to org-from-is-user-regexp)
8467 (setq plist
8468 (plist-put plist :fromto
8469 (if (string-match org-from-is-user-regexp from)
8470 (concat "to %t")
8471 (concat "from %f"))))))
8472 (setq org-store-link-plist plist))
8474 (defun org-add-link-props (&rest plist)
8475 "Add these properties to the link property list."
8476 (let (key value)
8477 (while plist
8478 (setq key (pop plist) value (pop plist))
8479 (setq org-store-link-plist
8480 (plist-put org-store-link-plist key value)))))
8482 (defun org-email-link-description (&optional fmt)
8483 "Return the description part of an email link.
8484 This takes information from `org-store-link-plist' and formats it
8485 according to FMT (default from `org-email-link-description-format')."
8486 (setq fmt (or fmt org-email-link-description-format))
8487 (let* ((p org-store-link-plist)
8488 (to (plist-get p :toaddress))
8489 (from (plist-get p :fromaddress))
8490 (table
8491 (list
8492 (cons "%c" (plist-get p :fromto))
8493 (cons "%F" (plist-get p :from))
8494 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8495 (cons "%T" (plist-get p :to))
8496 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8497 (cons "%s" (plist-get p :subject))
8498 (cons "%m" (plist-get p :message-id)))))
8499 (when (string-match "%c" fmt)
8500 ;; Check if the user wrote this message
8501 (if (and org-from-is-user-regexp from to
8502 (save-match-data (string-match org-from-is-user-regexp from)))
8503 (setq fmt (replace-match "to %t" t t fmt))
8504 (setq fmt (replace-match "from %f" t t fmt))))
8505 (org-replace-escapes fmt table)))
8507 (defun org-make-org-heading-search-string (&optional string heading)
8508 "Make search string for STRING or current headline."
8509 (interactive)
8510 (let ((s (or string (org-get-heading)))
8511 (lines org-context-in-file-links))
8512 (unless (and string (not heading))
8513 ;; We are using a headline, clean up garbage in there.
8514 (if (string-match org-todo-regexp s)
8515 (setq s (replace-match "" t t s)))
8517 (setq s (replace-match "" t t s)))
8518 (setq s (org-trim s))
8521 (setq s (replace-match "" t t s)))
8522 (while (string-match org-ts-regexp s)
8523 (setq s (replace-match "" t t s))))
8524 (or string (setq s (concat "*" s))) ; Add * for headlines
8525 (when (and string (integerp lines) (> lines 0))
8527 (when (< lines (length slines))
8528 (setq s (mapconcat
8529 'identity
8530 (reverse (nthcdr (- (length slines) lines)
8534 (defun org-make-link (&rest strings)
8535 "Concatenate STRINGS."
8536 (apply 'concat strings))
8538 (defun org-make-link-string (link &optional description)
8539 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8541 (error "Empty link"))
8542 (when (and description
8543 (stringp description)
8545 (setq description nil))
8546 (when (stringp description)
8547 ;; Remove brackets from the description, they are fatal.
8549 (setq description (replace-match "{" t t description)))
8551 (setq description (replace-match "}" t t description))))
8552 (when (equal (org-link-escape link) description)
8553 ;; No description needed, it is identical
8554 (setq description nil))
8555 (when (and (not description)
8556 (not (equal link (org-link-escape link))))
8557 (setq description (org-extract-attributes link)))
8558 (setq link (if (string-match org-link-types-re link)
8559 (concat (match-string 1 link)
8560 (org-link-escape (substring link (match-end 1))))
8561 (org-link-escape link)))
8562 (concat "[[" link "]"
8563 (if description (concat "[" description "]") "")
8564 "]"))
8566 (defconst org-link-escape-chars
8567 '((?\ . "%20")
8568 (?\[ . "%5B")
8569 (?\] . "%5D")
8580 (?\; . "%3B")
8581 ;; (?? . "%3F")
8582 (?= . "%3D")
8583 (?+ . "%2B")
8584 )
8585 "Association list of escapes for some characters problematic in links.
8586 This is the list that is used for internal purposes.")
8588 (defvar org-url-encoding-use-url-hexify nil)
8590 (defconst org-link-escape-chars-browser
8591 '((?\ . "%20")) ; 32 for the SPC char
8592 "Association list of escapes for some characters problematic in links.
8593 This is the list that is used before handing over to the browser.")
8595 (defun org-link-escape (text &optional table)
8596 "Escape characters in TEXT that are problematic for links."
8597 (if (and org-url-encoding-use-url-hexify (not table))
8598 (url-hexify-string text)
8599 (setq table (or table org-link-escape-chars))
8600 (when text
8601 (let ((re (mapconcat (lambda (x) (regexp-quote
8602 (char-to-string (car x))))
8604 (while (string-match re text)
8605 (setq text
8606 (replace-match
8607 (cdr (assoc (string-to-char (match-string 0 text))
8608 table))
8609 t t text)))
8610 text))))
8612 (defun org-link-unescape (text &optional table)
8613 "Reverse the action of `org-link-escape'."
8614 (if (and org-url-encoding-use-url-hexify (not table))
8615 (url-unhex-string text)
8616 (setq table (or table org-link-escape-chars))
8617 (when text
8618 (let ((case-fold-search t)
8619 (re (mapconcat (lambda (x) (regexp-quote (downcase (cdr x))))
8621 (while (string-match re text)
8622 (setq text
8623 (replace-match
8624 (char-to-string (car (rassoc (upcase (match-string 0 text))
8625 table)))
8626 t t text)))
8627 text))))
8629 (defun org-xor (a b)
8630 "Exclusive or."
8631 (if a (not b) b))
8633 (defun org-fixup-message-id-for-http (s)
8634 "Replace special characters in a message id, so it can be used in an http query."
8635 (when (string-match "%" s)
8636 (setq s (mapconcat (lambda (c)
8637 (if (eq c ?%)
8638 "%25"
8639 (char-to-string c)))
8640 s "")))
8641 (while (string-match "<" s)
8642 (setq s (replace-match "%3C" t t s)))
8643 (while (string-match ">" s)
8644 (setq s (replace-match "%3E" t t s)))
8645 (while (string-match "@" s)
8646 (setq s (replace-match "%40" t t s)))
8647 s)
8649 ;;;###autoload
8650 (defun org-insert-link-global ()
8651 "Insert a link like Org-mode does.
8652 This command can be called in any mode to insert a link in Org-mode syntax."
8653 (interactive)
8654 (org-load-modules-maybe)
8655 (org-run-like-in-org-mode 'org-insert-link))
8657 (defun org-insert-link (&optional complete-file link-location)
8658 "Insert a link. At the prompt, enter the link.
8660 Completion can be used to insert any of the link protocol prefixes like
8661 http or ftp in use.
8663 The history can be used to select a link previously stored with
8664 `org-store-link'. When the empty string is entered (i.e. if you just
8665 press RET at the prompt), the link defaults to the most recently
8666 stored link. As SPC triggers completion in the minibuffer, you need to
8667 use M-SPC or C-q SPC to force the insertion of a space character.
8669 You will also be prompted for a description, and if one is given, it will
8670 be displayed in the buffer instead of the link.
8672 If there is already a link at point, this command will allow you to edit link
8673 and description parts.
8676 be selected using completion. The path to the file will be relative to the
8677 current directory if the file is in the current directory or a subdirectory.
8678 Otherwise, the link will be the absolute path as completed in the minibuffer
8679 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8680 option `org-link-file-path-type'.
8683 the current directory or below.
8686 `org-keep-stored-link-after-insertion'.
8688 If `org-make-link-description-function' is non-nil, this function will be
8689 called with the link target, and the result will be the default
8690 link description.
8692 If the LINK-LOCATION parameter is non-nil, this value will be
8693 used as the link location instead of reading one interactively."
8694 (interactive "P")
8695 (let* ((wcf (current-window-configuration))
8696 (region (if (org-region-active-p)
8697 (buffer-substring (region-beginning) (region-end))))
8698 (remove (and region (list (region-beginning) (region-end))))
8699 (desc region)
8700 tmphist ; byte-compile incorrectly complains about this
8701 (link link-location)
8702 entry file all-prefixes)
8703 (cond
8704 (link-location) ; specified by arg, just use it.
8705 ((org-in-regexp org-bracket-link-regexp 1)
8706 ;; We do have a link at point, and we are going to edit it.
8707 (setq remove (list (match-beginning 0) (match-end 0)))
8708 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8709 (setq link (read-string "Link: "
8710 (org-link-unescape
8711 (org-match-string-no-properties 1)))))
8712 ((or (org-in-regexp org-angle-link-re)
8713 (org-in-regexp org-plain-link-re))
8714 ;; Convert to bracket link
8715 (setq remove (list (match-beginning 0) (match-end 0))
8716 link (read-string "Link: "
8717 (org-remove-angle-brackets (match-string 0)))))
8718 ((member complete-file '((4) (16)))
8719 ;; Completing read for file names.
8720 (setq link (org-file-complete-link complete-file)))
8721 (t
8722 ;; Read link, with completion for stored links.
8723 (with-output-to-temp-buffer "*Org Links*"
8724 (princ "Insert a link.
8726 (when org-stored-links
8728 (princ (mapconcat
8729 (lambda (x)
8730 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8732 (let ((cw (selected-window)))
8733 (select-window (get-buffer-window "*Org Links*" 'visible))
8734 (setq truncate-lines t)
8735 (unless (pos-visible-in-window-p (point-max))
8736 (org-fit-window-to-buffer))
8737 (and (window-live-p cw) (select-window cw)))
8738 ;; Fake a link history, containing the stored links.
8739 (setq tmphist (append (mapcar 'car org-stored-links)
8740 org-insert-link-history))
8741 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8742 (mapcar 'car org-link-abbrev-alist)
8743 org-link-types))
8744 (unwind-protect
8745 (progn
8746 (setq link
8747 (let ((org-completion-use-ido nil)
8748 (org-completion-use-iswitchb nil))
8749 (org-completing-read
8750 "Link: "
8751 (append
8752 (mapcar (lambda (x) (list (concat x ":")))
8753 all-prefixes)
8754 (mapcar 'car org-stored-links))
8755 nil nil nil
8756 'tmphist
8757 (car (car org-stored-links)))))
8759 (error "No link selected"))
8760 (if (or (member link all-prefixes)
8761 (and (equal ":" (substring link -1))
8762 (member (substring link 0 -1) all-prefixes)
8763 (setq link (substring link 0 -1))))
8764 (setq link (org-link-try-special-completion link))))
8765 (set-window-configuration wcf)
8766 (kill-buffer "*Org Links*"))
8767 (setq entry (assoc link org-stored-links))
8768 (or entry (push link org-insert-link-history))
8769 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8770 (not org-keep-stored-link-after-insertion))
8771 (setq org-stored-links (delq (assoc link org-stored-links)
8772 org-stored-links)))
8773 (setq desc (or desc (nth 1 entry)))))
8775 (if (string-match org-plain-link-re link)
8776 ;; URL-like link, normalize the use of angular brackets.
8777 (setq link (org-make-link (org-remove-angle-brackets link))))
8779 ;; Check if we are linking to the current file with a search option
8780 ;; If yes, simplify the link by using only the search option.
8781 (when (and buffer-file-name
8783 (let* ((path (match-string 1 link))
8784 (case-fold-search nil)
8785 (search (match-string 2 link)))
8786 (save-match-data
8787 (if (equal (file-truename buffer-file-name) (file-truename path))
8788 ;; We are linking to this same file, with a search option
8789 (setq link search)))))
8791 ;; Check if we can/should use a relative path. If yes, simplify the link
8793 (let* ((type (match-string 1 link))
8794 (path (match-string 2 link))
8795 (origpath path)
8796 (case-fold-search nil))
8797 (cond
8798 ((or (eq org-link-file-path-type 'absolute)
8799 (equal complete-file '(16)))
8800 (setq path (abbreviate-file-name (expand-file-name path))))
8801 ((eq org-link-file-path-type 'noabbrev)
8802 (setq path (expand-file-name path)))
8803 ((eq org-link-file-path-type 'relative)
8804 (setq path (file-relative-name path)))
8805 (t
8806 (save-match-data
8807 (if (string-match (concat "^" (regexp-quote
8808 (expand-file-name
8809 (file-name-as-directory
8810 default-directory))))
8811 (expand-file-name path))
8812 ;; We are linking a file with relative path name.
8813 (setq path (substring (expand-file-name path)
8814 (match-end 0)))
8815 (setq path (abbreviate-file-name (expand-file-name path)))))))
8816 (setq link (concat type path))
8817 (if (equal desc origpath)
8818 (setq desc path))))
8820 (if org-make-link-description-function
8821 (setq desc (funcall org-make-link-description-function link desc)))
8823 (setq desc (read-string "Description: " desc))
8825 (if remove (apply 'delete-region remove))
8826 (insert (org-make-link-string link desc))))
8828 (defun org-link-try-special-completion (type)
8829 "If there is completion support for link type TYPE, offer it."
8830 (let ((fun (intern (concat "org-" type "-complete-link"))))
8831 (if (functionp fun)
8832 (funcall fun)
8833 (read-string "Link (no completion support): " (concat type ":")))))
8835 (defun org-file-complete-link (&optional arg)
8836 "Create a file link using completion."
8837 (let (file link)
8838 (setq file (read-file-name "File: "))
8839 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8840 (pwd1 (file-name-as-directory (abbreviate-file-name
8841 (expand-file-name ".")))))
8842 (cond
8843 ((equal arg '(16))
8844 (setq link (org-make-link
8845 "file:"
8846 (abbreviate-file-name (expand-file-name file)))))
8848 (setq link (org-make-link "file:" (match-string 1 file))))
8850 (expand-file-name file))
8851 (setq link (org-make-link
8852 "file:" (match-string 1 (expand-file-name file)))))
8853 (t (setq link (org-make-link "file:" file)))))
8854 link))
8856 (defun org-completing-read (&rest args)
8857 "Completing-read with SPACE being a normal character."
8858 (let ((minibuffer-local-completion-map
8859 (copy-keymap minibuffer-local-completion-map)))
8860 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
8861 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
8862 (apply 'org-icompleting-read args)))
8864 (defun org-completing-read-no-i (&rest args)
8865 (let (org-completion-use-ido org-completion-use-iswitchb)
8866 (apply 'org-completing-read args)))
8868 (defun org-iswitchb-completing-read (prompt choices &rest args)
8869 "Use iswitch as a completing-read replacement to choose from choices.
8870 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
8871 from."
8872 (let* ((iswitchb-use-virtual-buffers nil)
8873 (iswitchb-make-buflist-hook
8874 (lambda ()
8875 (setq iswitchb-temp-buflist choices))))
8876 (iswitchb-read-buffer prompt)))
8878 (defun org-icompleting-read (&rest args)
8879 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
8880 (org-without-partial-completion
8881 (if (and org-completion-use-ido
8882 (fboundp 'ido-completing-read)
8883 (boundp 'ido-mode) ido-mode
8884 (listp (second args)))
8885 (let ((ido-enter-matching-directory nil))
8886 (apply 'ido-completing-read (concat (car args))
8887 (if (consp (car (nth 1 args)))
8888 (mapcar (lambda (x) (car x)) (nth 1 args))
8889 (nth 1 args))
8890 (cddr args)))
8891 (if (and org-completion-use-iswitchb
8892 (boundp 'iswitchb-mode) iswitchb-mode
8893 (listp (second args)))
8894 (apply 'org-iswitchb-completing-read (concat (car args))
8895 (if (consp (car (nth 1 args)))
8896 (mapcar (lambda (x) (car x)) (nth 1 args))
8897 (nth 1 args))
8898 (cddr args))
8899 (apply 'completing-read args)))))
8901 (defun org-extract-attributes (s)
8902 "Extract the attributes cookie from a string and set as text property."
8903 (let (a attr (start 0) key value)
8904 (save-match-data
8906 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
8908 (setq key (match-string 1 a) value (match-string 2 a)
8909 start (match-end 0)
8910 attr (plist-put attr (intern key) value))))
8911 (org-add-props s nil 'org-attr attr))
8912 s))
8914 (defun org-extract-attributes-from-string (tag)
8915 (let (key value attr)
8917 (setq key (match-string 1 tag) value (match-string 2 tag)
8918 tag (replace-match "" t t tag)
8919 attr (plist-put attr (intern key) value)))
8920 (cons tag attr)))
8922 (defun org-attributes-to-string (plist)
8923 "Format a property list into an HTML attribute list."
8924 (let ((s "") key value)
8925 (while plist
8926 (setq key (pop plist) value (pop plist))
8927 (and value
8929 s))
8931 ;;; Opening/following a link
8933 (defvar org-link-search-failed nil)
8935 (defvar org-open-link-functions nil
8936 "Hook for functions finding a plain text link.
8937 These functions must take a single argument, the link content.
8938 They will be called for links that look like [[link text][description]]
8942 These functions will be called *before* Org attempts to resolve the
8943 link by doing text searches in the current buffer - so if you want a
8945 handle this as a special case.
8947 When the function does handle the link, it must return a non-nil value.
8948 If it decides that it is not responsible for this link, it must return
8949 nil to indicate that that Org-mode can continue with other options
8950 like exact and fuzzy text search.")
8952 (defun org-next-link ()
8953 "Move forward to the next link.
8954 If the link is in hidden text, expose it."
8955 (interactive)
8956 (when (and org-link-search-failed (eq this-command last-command))
8957 (goto-char (point-min))
8958 (message "Link search wrapped back to beginning of buffer"))
8959 (setq org-link-search-failed nil)
8960 (let* ((pos (point))
8961 (ct (org-context))
8962 (a (assoc :link ct)))
8963 (if a (goto-char (nth 2 a)))
8964 (if (re-search-forward org-any-link-re nil t)
8965 (progn
8966 (goto-char (match-beginning 0))
8967 (if (org-invisible-p) (org-show-context)))
8968 (goto-char pos)
8969 (setq org-link-search-failed t)
8970 (error "No further link found"))))
8972 (defun org-previous-link ()
8973 "Move backward to the previous link.
8974 If the link is in hidden text, expose it."
8975 (interactive)
8976 (when (and org-link-search-failed (eq this-command last-command))
8977 (goto-char (point-max))
8978 (message "Link search wrapped back to end of buffer"))
8979 (setq org-link-search-failed nil)
8980 (let* ((pos (point))
8981 (ct (org-context))
8982 (a (assoc :link ct)))
8983 (if a (goto-char (nth 1 a)))
8984 (if (re-search-backward org-any-link-re nil t)
8985 (progn
8986 (goto-char (match-beginning 0))
8987 (if (org-invisible-p) (org-show-context)))
8988 (goto-char pos)
8989 (setq org-link-search-failed t)
8990 (error "No further link found"))))
8992 (defun org-translate-link (s)
8993 "Translate a link string if a translation function has been defined."
8994 (if (and org-link-translation-function
8995 (fboundp org-link-translation-function)
8997 (progn
8998 (setq s (funcall org-link-translation-function
8999 (match-string 1) (match-string 2)))
9000 (concat (car s) ":" (cdr s)))
9001 s))
9003 (defun org-translate-link-from-planner (type path)
9004 "Translate a link from Emacs Planner syntax so that Org can follow it.
9005 This is still an experimental function, your mileage may vary."
9006 (cond
9007 ((member type '("http" "https" "news" "ftp"))
9008 ;; standard Internet links are the same.
9009 nil)
9010 ((and (equal type "irc") (string-match "^//" path))
9011 ;; Planner has two / at the beginning of an irc link, we have 1.
9012 ;; We should have zero, actually....
9013 (setq path (substring path 1)))
9014 ((and (equal type "lisp") (string-match "^/" path))
9015 ;; Planner has a slash, we do not.
9016 (setq type "elisp" path (substring path 1)))
9018 ;; A typical message link. Planner has the id after the final slash,
9019 ;; we separate it with a hash mark
9020 (setq path (concat (match-string 1 path) "#"
9021 (org-remove-angle-brackets (match-string 2 path)))))
9022 )
9023 (cons type path))
9025 (defun org-find-file-at-mouse (ev)
9026 "Open file link or URL at mouse."
9027 (interactive "e")
9028 (mouse-set-point ev)
9029 (org-open-at-point 'in-emacs))
9031 (defun org-open-at-mouse (ev)
9032 "Open file link or URL at mouse."
9033 (interactive "e")
9034 (mouse-set-point ev)
9035 (if (eq major-mode 'org-agenda-mode)
9036 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9037 (org-open-at-point))
9039 (defvar org-window-config-before-follow-link nil
9040 "The window configuration before following a link.
9041 This is saved in case the need arises to restore it.")
9043 (defvar org-open-link-marker (make-marker)
9044 "Marker pointing to the location where `org-open-at-point; was called.")
9046 ;;;###autoload
9047 (defun org-open-at-point-global ()
9048 "Follow a link like Org-mode does.
9049 This command can be called in any mode to follow a link that has
9050 Org-mode syntax."
9051 (interactive)
9052 (org-run-like-in-org-mode 'org-open-at-point))
9054 ;;;###autoload
9055 (defun org-open-link-from-string (s &optional arg reference-buffer)
9056 "Open a link in the string S, as if it was in Org-mode."
9058 (let ((reference-buffer (or reference-buffer (current-buffer))))
9059 (with-temp-buffer
9060 (let ((org-inhibit-startup t))
9061 (org-mode)
9062 (insert s)
9063 (goto-char (point-min))
9064 (when reference-buffer
9065 (setq org-link-abbrev-alist-local
9066 (with-current-buffer reference-buffer
9067 org-link-abbrev-alist-local)))
9068 (org-open-at-point arg reference-buffer)))))
9070 (defvar org-open-at-point-functions nil
9071 "Hook that is run when following a link at point.
9073 Functions in this hook must return t if they identify and follow
9074 a link at point. If they don't find anything interesting at point,
9075 they must return nil.")
9077 (defun org-open-at-point (&optional in-emacs reference-buffer)
9078 "Open link at or after point.
9079 If there is no link at point, this function will search forward up to
9080 the end of the current line.
9081 Normally, files will be opened by an appropriate application. If the
9082 optional argument IN-EMACS is non-nil, Emacs will visit the file.
9083 With a double prefix argument, try to open outside of Emacs, in the
9084 application the system uses for this file type."
9085 (interactive "P")
9086 ;; if in a code block, then open the block's results
9087 (unless (call-interactively #'org-babel-open-src-block-result)
9088 (org-load-modules-maybe)
9089 (move-marker org-open-link-marker (point))
9090 (setq org-window-config-before-follow-link (current-window-configuration))
9091 (org-remove-occur-highlights nil nil t)
9092 (cond
9093 ((and (org-on-heading-p)
9094 (not (org-in-regexp
9099 (not (get-text-property (point) 'org-linked-text)))
9100 (or (org-offer-links-in-entry in-emacs)
9101 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9102 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9103 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9104 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9105 (not (org-in-regexp org-bracket-link-regexp)))
9106 (org-footnote-action))
9107 (t
9108 (let (type path link line search (pos (point)))
9109 (catch 'match
9110 (save-excursion
9112 (when (org-in-regexp org-bracket-link-regexp 1)
9113 (setq link (org-extract-attributes
9114 (org-link-unescape (org-match-string-no-properties 1))))
9116 (setq link (replace-match " " t t link)))
9117 (setq link (org-link-expand-abbrev link))
9118 (cond
9119 ((or (file-name-absolute-p link)
9121 (setq type "file" path link))
9122 ((string-match org-link-re-with-space3 link)
9123 (setq type (match-string 1 link) path (match-string 2 link)))
9124 (t (setq type "thisfile" path link)))
9125 (throw 'match t)))
9127 (when (get-text-property (point) 'org-linked-text)
9128 (setq type "thisfile"
9129 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9130 (1+ (point)) (point))
9131 path (buffer-substring
9132 (previous-single-property-change pos 'org-linked-text)
9133 (next-single-property-change pos 'org-linked-text)))
9134 (throw 'match t))
9136 (save-excursion
9137 (when (or (org-in-regexp org-angle-link-re)
9138 (org-in-regexp org-plain-link-re))
9139 (setq type (match-string 1) path (match-string 2))
9140 (throw 'match t)))
9141 (save-excursion
9143 (setq type "tags"
9144 path (match-string 1))
9145 (while (string-match ":" path)
9146 (setq path (replace-match "+" t t path)))
9147 (throw 'match t)))
9149 (setq type "tree-match"
9150 path (match-string 1))
9151 (throw 'match t)))
9152 (unless path
9153 (error "No link found"))
9155 ;; switch back to reference buffer
9156 ;; needed when if called in a temporary buffer through
9157 ;; org-open-link-from-string
9158 (with-current-buffer (or reference-buffer (current-buffer))
9160 ;; Remove any trailing spaces in path
9162 (setq path (replace-match "" t t path)))
9163 (if (and org-link-translation-function
9164 (fboundp org-link-translation-function))
9165 ;; Check if we need to translate the link
9166 (let ((tmp (funcall org-link-translation-function type path)))
9167 (setq type (car tmp) path (cdr tmp))))
9169 (cond
9171 ((assoc type org-link-protocols)
9172 (funcall (nth 1 (assoc type org-link-protocols)) path))
9174 ((equal type "mailto")
9175 (let ((cmd (car org-link-mailto-program))
9176 (args (cdr org-link-mailto-program)) args1
9177 (address path) (subject "") a)
9179 (setq address (match-string 1 path)
9180 subject (org-link-escape (match-string 2 path))))
9181 (while args
9182 (cond
9183 ((not (stringp (car args))) (push (pop args) args1))
9184 (t (setq a (pop args))
9185 (if (string-match "%a" a)
9186 (setq a (replace-match address t t a)))
9187 (if (string-match "%s" a)
9188 (setq a (replace-match subject t t a)))
9189 (push a args1))))
9190 (apply cmd (nreverse args1))))
9192 ((member type '("http" "https" "ftp" "news"))
9193 (browse-url (concat type ":" (org-link-escape
9194 path org-link-escape-chars-browser))))
9196 ((string= type "doi")
9197 (browse-url (concat "http://dx.doi.org/"
9198 (org-link-escape
9199 path org-link-escape-chars-browser))))
9201 ((member type '("message"))
9202 (browse-url (concat type ":" path)))
9204 ((string= type "tags")
9205 (org-tags-view in-emacs path))
9207 ((string= type "tree-match")
9210 ((string= type "file")
9212 (setq line (string-to-number (match-string 1 path))
9213 path (substring path 0 (match-beginning 0)))
9215 (setq search (match-string 1 path)
9216 path (substring path 0 (match-beginning 0)))))
9217 (if (string-match "[*?{]" (file-name-nondirectory path))
9218 (dired path)
9219 (org-open-file path in-emacs line search)))
9221 ((string= type "shell")
9222 (let ((cmd path))
9223 (if (or (not org-confirm-shell-link-function)
9224 (funcall org-confirm-shell-link-function
9226 (org-add-props cmd nil
9227 'face 'org-warning))))
9228 (progn
9229 (message "Executing %s" cmd)
9230 (shell-command cmd))
9231 (error "Abort"))))
9233 ((string= type "elisp")
9234 (let ((cmd path))
9235 (if (or (not org-confirm-elisp-link-function)
9236 (funcall org-confirm-elisp-link-function
9238 (org-add-props cmd nil
9239 'face 'org-warning))))
9240 (message "%s => %s" cmd
9241 (if (equal (string-to-char cmd) ?\()
9242 (eval (read cmd))
9243 (call-interactively (read cmd))))
9244 (error "Abort"))))
9246 ((and (string= type "thisfile")
9247 (run-hook-with-args-until-success
9248 'org-open-link-functions path)))
9250 ((string= type "thisfile")
9251 (if in-emacs
9252 (switch-to-buffer-other-window
9253 (org-get-buffer-for-internal-link (current-buffer)))
9254 (org-mark-ring-push))
9255 (let ((cmd `(org-link-search
9256 ,path
9257 ,(cond ((equal in-emacs '(4)) 'occur)
9258 ((equal in-emacs '(16)) 'org-occur)
9259 (t nil))
9260 ,pos)))
9261 (condition-case nil (eval cmd)
9262 (error (progn (widen) (eval cmd))))))
9264 (t
9265 (browse-url-at-point)))))))
9266 (move-marker org-open-link-marker nil)
9267 (run-hook-with-args 'org-follow-link-hook)))
9269 (defun org-offer-links-in-entry (&optional nth zero)
9270 "Offer links in the current entry and follow the selected link.
9271 If there is only one link, follow it immediately as well.
9272 If NTH is an integer, immediately pick the NTH link found.
9273 If ZERO is a string, check also this string for a link, and if
9274 there is one, offer it as link number zero."
9278 (cnt ?0)
9279 (in-emacs (if (integerp nth) nil nth))
9280 have-zero end links link c)
9281 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9282 (push (match-string 0 zero) links)
9283 (setq cnt (1- cnt) have-zero t))
9284 (save-excursion
9285 (org-back-to-heading t)
9286 (setq end (save-excursion (outline-next-heading) (point)))
9287 (while (re-search-forward re end t)
9288 (push (match-string 0) links))
9289 (setq links (org-uniquify (reverse links))))
9291 (cond
9292 ((null links)
9293 (message "No links"))
9294 ((equal (length links) 1)
9295 (setq link (list (car links))))
9296 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9297 (setq link (nth (if have-zero nth (1- nth)) links)))
9298 (t ; we have to select a link
9299 (save-excursion
9300 (save-window-excursion
9301 (delete-other-windows)
9302 (with-output-to-temp-buffer "*Select Link*"
9303 (mapc (lambda (l)
9304 (if (not (string-match org-bracket-link-regexp l))
9306 (org-remove-angle-brackets l)))
9307 (if (match-end 3)
9309 (match-string 3 l) (match-string 1 l)))
9311 (match-string 1 l))))))
9312 links))
9313 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9314 (message "Select link to open, RET to open all:")
9315 (setq c (read-char-exclusive))
9316 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9317 (when (equal c ?q) (error "Abort"))
9318 (if (equal c ?\C-m)
9319 (setq link links)
9320 (setq nth (- c ?0))
9321 (if have-zero (setq nth (1+ nth)))
9322 (unless (and (integerp nth) (>= (length links) nth))
9323 (error "Invalid link selection"))
9324 (setq link (list (nth (1- nth) links))))))
9325 (if link
9326 (let ((buf (current-buffer)))
9327 (dolist (l link)
9328 (org-open-link-from-string l in-emacs buf))
9329 t)
9330 nil)))
9332 ;; Add special file links that specify the way of opening
9334 (org-add-link-type "file+sys" 'org-open-file-with-system)
9335 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9336 (defun org-open-file-with-system (path)
9337 "Open file at PATH using the system way of opening it."
9338 (org-open-file path 'system))
9339 (defun org-open-file-with-emacs (path)
9340 "Open file at PATH in Emacs."
9341 (org-open-file path 'emacs))
9342 (defun org-remove-file-link-modifiers ()
9343 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9344 (goto-char (point-min))
9346 (org-if-unprotected
9347 (replace-match "file:" t t))))
9348 (eval-after-load "org-exp"
9349 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9350 'org-remove-file-link-modifiers))
9352 ;;;; Time estimates
9354 (defun org-get-effort (&optional pom)
9355 "Get the effort estimate for the current entry."
9356 (org-entry-get pom org-effort-property))
9358 ;;; File search
9360 (defvar org-create-file-search-functions nil
9361 "List of functions to construct the right search string for a file link.
9362 These functions are called in turn with point at the location to
9363 which the link should point.
9365 A function in the hook should first test if it would like to
9366 handle this file type, for example by checking the `major-mode'
9367 or the file extension. If it decides not to handle this file, it
9368 should just return nil to give other functions a chance. If it
9369 does handle the file, it must return the search string to be used
9370 when following the link. The search string will be part of the
9371 file link, given after a double colon, and `org-open-at-point'
9372 will automatically search for it. If special measures must be
9373 taken to make the search successful, another function should be
9374 added to the companion hook `org-execute-file-search-functions',
9375 which see.
9377 A function in this hook may also use `setq' to set the variable
9378 `description' to provide a suggestion for the descriptive text to
9379 be used for this link when it gets inserted into an Org-mode
9382 (defvar org-execute-file-search-functions nil
9383 "List of functions to execute a file search triggered by a link.
9385 Functions added to this hook must accept a single argument, the
9386 search string that was part of the file link, the part after the
9387 double colon. The function must first check if it would like to
9388 handle this search, for example by checking the `major-mode' or
9389 the file extension. If it decides not to handle this search, it
9390 should just return nil to give other functions a chance. If it
9391 does handle the search, it must return a non-nil value to keep
9392 other functions from trying.
9394 Each function can access the current prefix argument through the
9395 variable `current-prefix-argument'. Note that a single prefix is
9396 used to force opening a link in Emacs, so it may be good to only
9397 use a numeric or double prefix to guide the search function.
9399 In case this is needed, a function in this hook can also restore
9400 the window configuration before `org-open-at-point' was called using:
9402 (set-window-configuration org-window-config-before-follow-link)")
9404 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9405 (defun org-link-search (s &optional type avoid-pos)
9406 "Search for a link search option.
9407 If S is surrounded by forward slashes, it is interpreted as a
9408 regular expression. In org-mode files, this will create an `org-occur'
9409 sparse tree. In ordinary files, `occur' will be used to list matches.
9410 If the current buffer is in `dired-mode', grep will be used to search
9411 in all files. If AVOID-POS is given, ignore matches near that position."
9412 (let ((case-fold-search t)
9416 org-emphasis-alist)
9418 (pos (point))
9419 (pre nil) (post nil)
9420 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9421 (cond
9422 ;; First check if there are any special search functions
9423 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9424 ;; Now try the builtin stuff
9425 ((and (equal (string-to-char s0) ?#)
9426 (> (length s0) 1)
9427 (save-excursion
9428 (goto-char (point-min))
9429 (and
9430 (re-search-forward
9432 (setq type 'dedicated
9433 pos (match-beginning 0))))
9434 ;; There is an exact target for this
9435 (goto-char pos)
9436 (org-back-to-heading t)))
9437 ((save-excursion
9438 (goto-char (point-min))
9439 (and
9440 (re-search-forward
9441 (concat "<<" (regexp-quote s0) ">>") nil t)
9442 (setq type 'dedicated
9443 pos (match-beginning 0))))
9444 ;; There is an exact target for this
9445 (goto-char pos))
9447 (save-excursion
9448 (goto-char (point-min))
9449 (and
9450 (re-search-forward
9451 (concat "[^[]" (regexp-quote
9452 (format org-coderef-label-format
9453 (match-string 1 s0))))
9454 nil t)
9455 (setq type 'dedicated
9456 pos (1+ (match-beginning 0))))))
9457 ;; There is a coderef target for this
9458 (goto-char pos))
9460 ;; A regular expression
9461 (cond
9462 ((org-mode-p)
9463 (org-occur (match-string 1 s)))
9464 ;;((eq major-mode 'dired-mode)
9465 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9466 (t (org-do-occur (match-string 1 s)))))
9467 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9468 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9469 (goto-char (point-min))
9470 (cond
9471 ((let (case-fold-search)
9472 (re-search-forward (format org-complex-heading-regexp-format
9473 (regexp-quote s))
9474 nil t))
9475 ;; OK, found a match
9476 (setq type 'dedicated)
9477 (goto-char (match-beginning 0)))
9478 ((and (not org-link-search-inhibit-query)
9479 (eq org-link-search-must-match-exact-headline 'query-to-create)
9480 (y-or-n-p "No match - create this as a new heading? "))
9481 (goto-char (point-max))
9482 (or (bolp) (newline))
9484 (beginning-of-line 0))
9485 (t
9486 (goto-char pos)
9487 (error "No match"))))
9488 (t
9489 ;; A normal search string
9490 (when (equal (string-to-char s) ?*)
9491 ;; Anchor on headlines, post may include tags.
9494 s (substring s 1)))
9495 (remove-text-properties
9496 0 (length s)
9497 '(face nil mouse-face nil keymap nil fontified nil) s)
9498 ;; Make a series of regular expressions to find a match
9507 re4 (concat "[^a-zA-Z_]" re4_)
9509 re1 (concat pre re2 post)
9510 re3 (concat pre (if pre re4_ re4) post)
9511 re5 (concat pre ".*" re4)
9512 re2 (concat pre re2)
9513 re2a (concat pre (if pre re2a_ re2a))
9514 re4 (concat pre (if pre re4_ re4))
9518 ))
9519 (cond
9520 ((eq type 'org-occur) (org-occur reall))
9521 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9522 (t (goto-char (point-min))
9523 (setq type 'fuzzy)
9524 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9525 (org-search-not-self 1 re1 nil t)
9526 (org-search-not-self 1 re2 nil t)
9527 (org-search-not-self 1 re2a nil t)
9528 (org-search-not-self 1 re3 nil t)
9529 (org-search-not-self 1 re4 nil t)
9530 (org-search-not-self 1 re5 nil t)
9531 )
9532 (goto-char (match-beginning 1))
9533 (goto-char pos)
9534 (error "No match"))))))
9535 (and (org-mode-p) (org-show-context 'link-search))
9536 type))
9538 (defun org-search-not-self (group &rest args)
9539 "Execute `re-search-forward', but only accept matches that do not
9540 enclose the position of `org-open-link-marker'."
9541 (let ((m org-open-link-marker))
9542 (catch 'exit
9543 (while (apply 're-search-forward args)
9544 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9545 (goto-char (match-end group))
9546 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9547 (> (match-beginning 0) (marker-position m))
9548 (< (match-end 0) (marker-position m)))
9549 (save-match-data
9550 (or (not (org-in-regexp
9551 org-bracket-link-analytic-regexp 1))
9552 (not (match-end 4)) ; no description
9553 (and (<= (match-beginning 4) (point))
9554 (>= (match-end 4) (point))))))
9555 (throw 'exit (point))))))))
9557 (defun org-get-buffer-for-internal-link (buffer)
9558 "Return a buffer to be used for displaying the link target of internal links."
9559 (cond
9560 ((not org-display-internal-link-with-indirect-buffer)
9561 buffer)
9562 ((string-match "(Clone)$" (buffer-name buffer))
9563 (message "Buffer is already a clone, not making another one")
9564 ;; we also do not modify visibility in this case
9565 buffer)
9566 (t ; make a new indirect buffer for displaying the link
9567 (let* ((bn (buffer-name buffer))
9568 (ibn (concat bn "(Clone)"))
9569 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9570 (with-current-buffer ib (org-overview))
9571 ib))))
9573 (defun org-do-occur (regexp &optional cleanup)
9574 "Call the Emacs command `occur'.
9575 If CLEANUP is non-nil, remove the printout of the regular expression
9576 in the *Occur* buffer. This is useful if the regex is long and not useful
9577 to read."
9578 (occur regexp)
9579 (when cleanup
9580 (let ((cwin (selected-window)) win beg end)
9581 (when (setq win (get-buffer-window "*Occur*"))
9582 (select-window win))
9583 (goto-char (point-min))
9584 (when (re-search-forward "match[a-z]+" nil t)
9585 (setq beg (match-end 0))
9587 (setq end (1- (match-beginning 0)))))
9588 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9589 (goto-char (point-min))
9590 (select-window cwin))))
9592 ;;; The mark ring for links jumps
9594 (defvar org-mark-ring nil
9595 "Mark ring for positions before jumps in Org-mode.")
9596 (defvar org-mark-ring-last-goto nil
9597 "Last position in the mark ring used to go back.")
9598 ;; Fill and close the ring
9599 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9600 (loop for i from 1 to org-mark-ring-length do
9601 (push (make-marker) org-mark-ring))
9602 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9603 org-mark-ring)
9605 (defun org-mark-ring-push (&optional pos buffer)
9606 "Put the current position or POS into the mark ring and rotate it."
9607 (interactive)
9608 (setq pos (or pos (point)))
9609 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9610 (move-marker (car org-mark-ring)
9611 (or pos (point))
9612 (or buffer (current-buffer)))
9613 (message "%s"
9614 (substitute-command-keys
9617 (defun org-mark-ring-goto (&optional n)
9618 "Jump to the previous position in the mark ring.
9619 With prefix arg N, jump back that many stored positions. When
9620 called several times in succession, walk through the entire ring.
9621 Org-mode commands jumping to a different position in the current file,
9622 or to another Org-mode file, automatically push the old position
9623 onto the ring."
9624 (interactive "p")
9625 (let (p m)
9626 (if (eq last-command this-command)
9627 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9628 (setq p org-mark-ring))
9629 (setq org-mark-ring-last-goto p)
9630 (setq m (car p))
9631 (switch-to-buffer (marker-buffer m))
9632 (goto-char m)
9633 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9635 (defun org-remove-angle-brackets (s)
9636 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9637 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9638 s)
9639 (defun org-add-angle-brackets (s)
9640 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9641 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9642 s)
9643 (defun org-remove-double-quotes (s)
9646 s)
9648 ;;; Following specific links
9650 (defun org-follow-timestamp-link ()
9651 (cond
9652 ((org-at-date-range-p t)
9653 (let ((org-agenda-start-on-weekday)
9654 (t1 (match-string 1))
9655 (t2 (match-string 2)))
9656 (setq t1 (time-to-days (org-time-string-to-time t1))
9657 t2 (time-to-days (org-time-string-to-time t2)))
9658 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9659 ((org-at-timestamp-p t)
9660 (org-agenda-list nil (time-to-days (org-time-string-to-time
9661 (substring (match-string 1) 0 10)))
9662 1))
9663 (t (error "This should not happen"))))
9666 ;;; Following file links
9667 (defvar org-wait nil)
9668 (defun org-open-file (path &optional in-emacs line search)
9669 "Open the file at PATH.
9670 First, this expands any special file name abbreviations. Then the
9671 configuration variable `org-file-apps' is checked if it contains an
9672 entry for this file type, and if yes, the corresponding command is launched.
9674 If no application is found, Emacs simply visits the file.
9676 With optional prefix argument IN-EMACS, Emacs will visit the file.
9678 prefix arg, Org tries to avoid opening in Emacs
9679 and to use an external application to visit the file.
9681 Optional LINE specifies a line to go to, optional SEARCH a string
9682 to search for. If LINE or SEARCH is given, the file will be
9683 opened in Emacs, unless an entry from org-file-apps that makes
9684 use of groups in a regexp matches.
9685 If the file does not exist, an error is thrown."
9686 (let* ((file (if (equal path "")
9687 buffer-file-name
9688 (substitute-in-file-name (expand-file-name path))))
9689 (file-apps (append org-file-apps (org-default-apps)))
9690 (apps (org-remove-if
9691 'org-file-apps-entry-match-against-dlink-p file-apps))
9692 (apps-dlink (org-remove-if-not
9693 'org-file-apps-entry-match-against-dlink-p file-apps))
9694 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9695 (dirp (if remp nil (file-directory-p file)))
9696 (file (if (and dirp org-open-directory-means-index-dot-org)
9697 (concat (file-name-as-directory file) "index.org")
9698 file))
9699 (a-m-a-p (assq 'auto-mode apps))
9700 (dfile (downcase file))
9701 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9702 (link (cond ((and (eq line nil)
9703 (eq search nil))
9704 file)
9705 (line
9706 (concat file "::" (number-to-string line)))
9707 (search
9708 (concat file "::" search))))
9709 (dlink (downcase link))
9710 (old-buffer (current-buffer))
9711 (old-pos (point))
9712 (old-mode major-mode)
9713 ext cmd link-match-data)
9715 (setq ext (match-string 1 dfile))
9717 (setq ext (match-string 1 dfile))))
9718 (cond
9719 ((member in-emacs '((16) system))
9720 (setq cmd (cdr (assoc 'system apps))))
9721 (in-emacs (setq cmd 'emacs))
9722 (t
9723 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9724 (and dirp (cdr (assoc 'directory apps)))
9725 ; first, try matching against apps-dlink
9726 ; if we get a match here, store the match data for later
9727 (let ((match (assoc-default dlink apps-dlink
9728 'string-match)))
9729 (if match
9730 (progn (setq link-match-data (match-data))
9731 match)
9732 (progn (setq in-emacs (or in-emacs line search))
9733 nil))) ; if we have no match in apps-dlink,
9734 ; always open the file in emacs if line or search
9735 ; is given (for backwards compatibility)
9736 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9737 'string-match)
9738 (cdr (assoc ext apps))
9739 (cdr (assoc t apps))))))
9740 (when (eq cmd 'system)
9741 (setq cmd (cdr (assoc 'system apps))))
9742 (when (eq cmd 'default)
9743 (setq cmd (cdr (assoc t apps))))
9744 (when (eq cmd 'mailcap)
9745 (require 'mailcap)
9746 (mailcap-parse-mailcaps)
9747 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9748 (command (mailcap-mime-info mime-type)))
9749 (if (stringp command)
9750 (setq cmd command)
9751 (setq cmd 'emacs))))
9752 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9753 (not (file-exists-p file))
9754 (not org-open-non-existing-files))
9755 (error "No such file: %s" file))
9756 (cond
9758 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9760 (setq cmd (replace-match "%s" t t cmd)))
9761 (while (string-match "%s" cmd)
9762 (setq cmd (replace-match
9763 (save-match-data
9764 (shell-quote-argument
9765 (convert-standard-filename file)))
9766 t t cmd)))
9768 ;; Replace "%1", "%2" etc. in command with group matches from regex
9769 (save-match-data
9770 (let ((match-index 1)
9771 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9772 (set-match-data link-match-data)
9773 (while (<= match-index number-of-groups)
9774 (let ((regex (concat "%" (number-to-string match-index)))
9775 (replace-with (match-string match-index dlink)))
9776 (while (string-match regex cmd)
9777 (setq cmd (replace-match replace-with t t cmd))))
9778 (setq match-index (+ match-index 1)))))
9780 (save-window-excursion
9781 (start-process-shell-command cmd nil cmd)
9782 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9783 ))
9784 ((or (stringp cmd)
9785 (eq cmd 'emacs))
9786 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9787 (widen)
9788 (if line (org-goto-line line)
9789 (if search (org-link-search search))))
9790 ((consp cmd)
9791 (let ((file (convert-standard-filename file)))
9792 (save-match-data
9793 (set-match-data link-match-data)
9794 (eval cmd))))
9795 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9796 (and (org-mode-p) (eq old-mode 'org-mode)
9797 (or (not (equal old-buffer (current-buffer)))
9798 (not (equal old-pos (point))))
9799 (org-mark-ring-push old-pos old-buffer))))
9801 (defun org-file-apps-entry-match-against-dlink-p (entry)
9802 "This function returns non-nil if `entry' uses a regular
9803 expression which should be matched against the whole link by
9804 org-open-file.
9806 It assumes that is the case when the entry uses a regular
9807 expression which has at least one grouping construct and the
9808 action is either a lisp form or a command string containing
9809 '%1', i.e. using at least one subexpression match as a
9810 parameter."
9811 (let ((selector (car entry))
9812 (action (cdr entry)))
9813 (if (stringp selector)
9814 (and (> (regexp-opt-depth selector) 0)
9815 (or (and (stringp action)
9816 (string-match "%[0-9]" action))
9817 (consp action)))
9818 nil)))
9820 (defun org-default-apps ()
9821 "Return the default applications for this operating system."
9822 (cond
9823 ((eq system-type 'darwin)
9824 org-file-apps-defaults-macosx)
9825 ((eq system-type 'windows-nt)
9826 org-file-apps-defaults-windowsnt)
9827 (t org-file-apps-defaults-gnu)))
9829 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9830 "Convert extensions to regular expressions in the cars of LIST.
9831 Also, weed out any non-string entries, because the return value is used
9832 only for regexp matching.
9833 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9834 point to the symbol `emacs', indicating that the file should
9835 be opened in Emacs."
9836 (append
9837 (delq nil
9838 (mapcar (lambda (x)
9839 (if (not (stringp (car x)))
9840 nil
9842 x
9844 list))
9845 (if add-auto-mode
9846 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9848 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9849 (defun org-file-remote-p (file)
9850 "Test whether FILE specifies a location on a remote system.
9851 Return non-nil if the location is indeed remote.
9855 (cond ((fboundp 'file-remote-p)
9856 (file-remote-p file))
9857 ((fboundp 'tramp-handle-file-remote-p)
9858 (tramp-handle-file-remote-p file))
9859 ((and (boundp 'ange-ftp-name-format)
9860 (string-match (car ange-ftp-name-format) file))
9861 t)
9862 (t nil)))
9865 ;;;; Refiling
9867 (defun org-get-org-file ()
9868 "Read a filename, with default directory `org-directory'."
9869 (let ((default (or org-default-notes-file remember-data-file)))
9870 (read-file-name (format "File name [%s]: " default)
9871 (file-name-as-directory org-directory)
9872 default)))
9874 (defun org-notes-order-reversed-p ()
9875 "Check if the current file should receive notes in reversed order."
9876 (cond
9877 ((not org-reverse-note-order) nil)
9878 ((eq t org-reverse-note-order) t)
9879 ((not (listp org-reverse-note-order)) nil)
9880 (t (catch 'exit
9881 (let ((all org-reverse-note-order)
9882 entry)
9883 (while (setq entry (pop all))
9884 (if (string-match (car entry) buffer-file-name)
9885 (throw 'exit (cdr entry))))
9886 nil)))))
9888 (defvar org-refile-target-table nil
9889 "The list of refile targets, created by `org-refile'.")
9891 (defvar org-agenda-new-buffers nil
9892 "Buffers created to visit agenda files.")
9894 (defvar org-refile-cache nil
9895 "Cache for refile targets.")
9898 (defvar org-refile-markers nil
9899 "All the markers used for caching refile locations.")
9901 (defun org-refile-marker (pos)
9902 "Get a new refile marker, but only if caching is in use."
9903 (if (not org-refile-use-cache)
9904 pos
9905 (let ((m (make-marker)))
9906 (move-marker m pos)
9907 (push m org-refile-markers)
9908 m)))
9910 (defun org-refile-cache-clear ()
9911 "Clear the refile cache and disable all the markers."
9912 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
9913 (setq org-refile-markers nil)
9914 (setq org-refile-cache nil)
9915 (message "Refile cache has been cleared"))
9917 (defun org-refile-cache-check-set (set)
9918 "Check if all the markers in the cache still have live buffers."
9919 (let (marker)
9920 (catch 'exit
9921 (while (and set (setq marker (nth 3 (pop set))))
9922 ;; if org-refile-use-outline-path is 'file, marker may be nil
9923 (when (and marker (null (marker-buffer marker)))
9924 (message "not found") (sit-for 3)
9925 (throw 'exit nil)))
9926 t)))
9928 (defun org-refile-cache-put (set &rest identifiers)
9929 "Push the refile targets SET into the cache, under IDENTIFIERS."
9930 (let* ((key (sha1 (prin1-to-string identifiers)))
9931 (entry (assoc key org-refile-cache)))
9932 (if entry
9933 (setcdr entry set)
9934 (push (cons key set) org-refile-cache))))
9936 (defun org-refile-cache-get (&rest identifiers)
9937 "Retrieve the cached value for refile targets given by IDENTIFIERS."
9938 (cond
9939 ((not org-refile-cache) nil)
9940 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
9941 (t
9942 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
9943 org-refile-cache))))
9944 (and set (org-refile-cache-check-set set) set)))))
9946 (defun org-get-refile-targets (&optional default-buffer)
9947 "Produce a table with refile targets."
9948 (let ((case-fold-search nil)
9949 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
9950 (entries (or org-refile-targets '((nil . (:level . 1)))))
9951 targets tgs txt re files f desc descre fast-path-p level pos0)
9952 (message "Getting targets...")
9953 (with-current-buffer (or default-buffer (current-buffer))
9954 (while (setq entry (pop entries))
9955 (setq files (car entry) desc (cdr entry))
9956 (setq fast-path-p nil)
9957 (cond
9958 ((null files) (setq files (list (current-buffer))))
9959 ((eq files 'org-agenda-files)
9960 (setq files (org-agenda-files 'unrestricted)))
9961 ((and (symbolp files) (fboundp files))
9962 (setq files (funcall files)))
9963 ((and (symbolp files) (boundp files))
9964 (setq files (symbol-value files))))
9965 (if (stringp files) (setq files (list files)))
9966 (cond
9967 ((eq (car desc) :tag)
9969 ((eq (car desc) :todo)
9971 ((eq (car desc) :regexp)
9972 (setq descre (cdr desc)))
9973 ((eq (car desc) :level)
9975 (if org-odd-levels-only
9976 (1- (* 2 (cdr desc)))
9977 (cdr desc)))
9979 ((eq (car desc) :maxlevel)
9980 (setq fast-path-p t)
9982 (if org-odd-levels-only
9983 (1- (* 2 (cdr desc)))
9984 (cdr desc)))
9986 (t (error "Bad refiling target description %s" desc)))
9987 (while (setq f (pop files))
9988 (with-current-buffer
9989 (if (bufferp f) f (org-get-agenda-file-buffer f))
9990 (or
9991 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
9992 (progn
9993 (if (bufferp f) (setq f (buffer-file-name
9994 (buffer-base-buffer f))))
9995 (setq f (and f (expand-file-name f)))
9996 (if (eq org-refile-use-outline-path 'file)
9997 (push (list (file-name-nondirectory f) f nil nil) tgs))
9998 (save-excursion
9999 (save-restriction
10000 (widen)
10001 (goto-char (point-min))
10002 (while (re-search-forward descre nil t)
10003 (goto-char (setq pos0 (point-at-bol)))
10004 (catch 'next
10005 (when org-refile-target-verify-function
10006 (save-match-data
10007 (or (funcall org-refile-target-verify-function)
10008 (throw 'next t))))
10009 (when (looking-at org-complex-heading-regexp)
10010 (setq level (org-reduced-level
10011 (- (match-end 1) (match-beginning 1)))
10012 txt (org-link-display-format (match-string 4))
10014 re (format org-complex-heading-regexp-format
10015 (regexp-quote (match-string 4))))
10016 (when org-refile-use-outline-path
10017 (setq txt (mapconcat
10018 'org-protect-slash
10019 (append
10020 (if (eq org-refile-use-outline-path
10021 'file)
10022 (list (file-name-nondirectory
10023 (buffer-file-name
10024 (buffer-base-buffer))))
10025 (if (eq org-refile-use-outline-path
10026 'full-file-path)
10027 (list (buffer-file-name
10028 (buffer-base-buffer)))))
10029 (org-get-outline-path fast-path-p
10030 level txt)
10031 (list txt))
10032 "/")))
10033 (push (list txt f re (org-refile-marker (point)))
10034 tgs)))
10035 (when (= (point) pos0)
10036 ;; verification function has not moved point
10037 (goto-char (point-at-eol))))))))
10038 (when org-refile-use-cache
10039 (org-refile-cache-put tgs (buffer-file-name) descre))
10040 (setq targets (append tgs targets))
10041 ))))
10042 (message "Getting targets...done")
10043 (nreverse targets)))
10045 (defun org-protect-slash (s)
10046 (while (string-match "/" s)
10048 s)
10050 (defvar org-olpa (make-vector 20 nil))
10052 (defun org-get-outline-path (&optional fastp level heading)
10053 "Return the outline path to the current entry, as a list.
10055 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10056 routine which makes outline path derivations for an entire file,
10057 avoiding backtracing. Refile target collection makes use of that."
10058 (if fastp
10059 (progn
10060 (if (> level 19)
10061 (error "Outline path failure, more than 19 levels"))
10062 (loop for i from level upto 19 do
10063 (aset org-olpa i nil))
10064 (prog1
10065 (delq nil (append org-olpa nil))
10066 (aset org-olpa level heading)))
10067 (let (rtn case-fold-search)
10068 (save-excursion
10069 (save-restriction
10070 (widen)
10071 (while (org-up-heading-safe)
10072 (when (looking-at org-complex-heading-regexp)
10073 (push (org-match-string-no-properties 4) rtn)))
10074 rtn)))))
10076 (defun org-format-outline-path (path &optional width prefix)
10077 "Format the outline path PATH for display.
10078 Width is the maximum number of characters that is available.
10079 Prefix is a prefix to be included in the returned string,
10080 such as the file name."
10081 (setq width (or width 79))
10082 (if prefix (setq width (- width (length prefix))))
10083 (if (not path)
10084 (or prefix "")
10085 (let* ((nsteps (length path))
10086 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10087 (maxwidth (if (<= total-width width)
10088 10000 ;; everything fits
10089 ;; we need to shorten the level headings
10090 (/ (- width nsteps) nsteps)))
10091 (org-odd-levels-only nil)
10092 (n 0)
10093 (total (1+ (length prefix))))
10094 (setq maxwidth (max maxwidth 10))
10095 (concat prefix
10096 (mapconcat
10097 (lambda (h)
10098 (setq n (1+ n))
10099 (if (and (= n nsteps) (< maxwidth 10000))
10100 (setq maxwidth (- total-width total)))
10101 (if (< (length h) maxwidth)
10102 (progn (setq total (+ total (length h) 1)) h)
10103 (setq h (substring h 0 (- maxwidth 2))
10104 total (+ total maxwidth 1))
10106 (setq h (substring h 0 (match-beginning 0))))
10107 (setq h (concat h "..")))
10108 (org-add-props h nil 'face
10109 (nth (% (1- n) org-n-level-faces)
10110 org-level-faces))
10111 h)
10112 path "/")))))
10114 (defun org-display-outline-path (&optional file current)
10115 "Display the current outline path in the echo area."
10116 (interactive "P")
10117 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10118 (case-fold-search nil)
10119 (path (and (org-mode-p) (org-get-outline-path))))
10120 (if current (setq path (append path
10121 (save-excursion
10122 (org-back-to-heading t)
10123 (if (looking-at org-complex-heading-regexp)
10124 (list (match-string 4)))))))
10125 (message "%s"
10126 (org-format-outline-path
10127 path
10128 (1- (frame-width))
10129 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10131 (defvar org-refile-history nil
10132 "History for refiling operations.")
10134 (defvar org-after-refile-insert-hook nil
10135 "Hook run after `org-refile' has inserted its stuff at the new location.
10136 Note that this is still *before* the stuff will be removed from
10137 the *old* location.")
10139 (defvar org-capture-last-stored-marker)
10140 (defun org-refile (&optional goto default-buffer rfloc)
10141 "Move the entry at point to another heading.
10142 The list of target headings is compiled using the information in
10143 `org-refile-targets', which see. This list is created before each use
10144 and will therefore always be up-to-date.
10146 At the target location, the entry is filed as a subitem of the target heading.
10147 Depending on `org-reverse-note-order', the new subitem will either be the
10148 first or the last subitem.
10150 If there is an active region, all entries in that region will be moved.
10151 However, the region must fulfill the requirement that the first heading
10152 is the first one sets the top-level of the moved text - at most siblings
10153 below it are allowed.
10155 With prefix arg GOTO, the command will only visit the target location,
10156 not actually move anything.
10158 go to the location where the last refiling
10159 operation has put the subtree.
10160 With a prefix argument of `2', refile to the running clock.
10162 RFLOC can be a refile location obtained in a different way.
10164 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10166 If you are using target caching (see `org-refile-use-cache'),
10167 You have to clear the target cache in order to find new targets.
10168 This can be done with a 0 prefix: `C-0 C-c C-w'"
10169 (interactive "P")
10170 (if (member goto '(0 (64)))
10171 (org-refile-cache-clear)
10172 (let* ((cbuf (current-buffer))
10173 (regionp (org-region-active-p))
10174 (region-start (and regionp (region-beginning)))
10175 (region-end (and regionp (region-end)))
10176 (region-length (and regionp (- region-end region-start)))
10177 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10178 pos it nbuf file re level reversed)
10179 (setq last-command nil)
10180 (when regionp
10181 (goto-char region-start)
10182 (or (bolp) (goto-char (point-at-bol)))
10183 (setq region-start (point))
10184 (unless (org-kill-is-subtree-p
10185 (buffer-substring region-start region-end))
10186 (error "The region is not a (sequence of) subtree(s)")))
10187 (if (equal goto '(16))
10188 (org-refile-goto-last-stored)
10189 (when (or
10190 (and (equal goto 2)
10191 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10192 (prog1
10193 (setq it (list (or org-clock-heading "running clock")
10194 (buffer-file-name
10195 (marker-buffer org-clock-hd-marker))
10196 ""
10197 (marker-position org-clock-hd-marker)))
10198 (setq goto nil)))
10199 (setq it (or rfloc
10200 (save-excursion
10201 (org-refile-get-location
10202 (if goto "Goto: " "Refile to: ") default-buffer
10203 org-refile-allow-creating-parent-nodes)))))
10204 (setq file (nth 1 it)
10205 re (nth 2 it)
10206 pos (nth 3 it))
10207 (if (and (not goto)
10208 pos
10209 (equal (buffer-file-name) file)
10210 (if regionp
10211 (and (>= pos region-start)
10212 (<= pos region-end))
10213 (and (>= pos (point))
10214 (< pos (save-excursion
10215 (org-end-of-subtree t t))))))
10216 (error "Cannot refile to position inside the tree or region"))
10218 (setq nbuf (or (find-buffer-visiting file)
10219 (find-file-noselect file)))
10220 (if goto
10221 (progn
10222 (switch-to-buffer nbuf)
10223 (goto-char pos)
10224 (org-show-context 'org-goto))
10225 (if regionp
10226 (progn
10227 (org-kill-new (buffer-substring region-start region-end))
10228 (org-save-markers-in-region region-start region-end))
10229 (org-copy-subtree 1 nil t))
10230 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10231 (find-file-noselect file)))
10232 (setq reversed (org-notes-order-reversed-p))
10233 (save-excursion
10234 (save-restriction
10235 (widen)
10236 (if pos
10237 (progn
10238 (goto-char pos)
10239 (looking-at outline-regexp)
10240 (setq level (org-get-valid-level (funcall outline-level) 1))
10241 (goto-char
10242 (if reversed
10243 (or (outline-next-heading) (point-max))
10244 (or (save-excursion (org-get-next-sibling))
10245 (org-end-of-subtree t t)
10246 (point-max)))))
10247 (setq level 1)
10248 (if (not reversed)
10249 (goto-char (point-max))
10250 (goto-char (point-min))
10251 (or (outline-next-heading) (goto-char (point-max)))))
10252 (if (not (bolp)) (newline))
10253 (org-paste-subtree level)
10254 (when org-log-refile
10255 (org-add-log-setup 'refile nil nil 'findpos
10256 org-log-refile)
10257 (unless (eq org-log-refile 'note)
10258 (save-excursion (org-add-log-note))))
10259 (and org-auto-align-tags (org-set-tags nil t))
10260 (bookmark-set "org-refile-last-stored")
10261 ;; If we are refiling for capture, make sure that the
10262 ;; last-capture pointers point here
10263 (when (org-bound-and-true-p org-refile-for-capture)
10264 (bookmark-set "org-capture-last-stored-marker")
10265 (move-marker org-capture-last-stored-marker (point)))
10266 (if (fboundp 'deactivate-mark) (deactivate-mark))
10267 (run-hooks 'org-after-refile-insert-hook))))
10268 (if regionp
10269 (delete-region (point) (+ (point) region-length))
10270 (org-cut-subtree))
10271 (when (featurep 'org-inlinetask)
10272 (org-inlinetask-remove-END-maybe))
10273 (setq org-markers-to-move nil)
10276 (defun org-refile-goto-last-stored ()
10277 "Go to the location where the last refile was stored."
10278 (interactive)
10279 (bookmark-jump "org-refile-last-stored")
10280 (message "This is the location of the last refile"))
10282 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10283 "Prompt the user for a refile location, using PROMPT."
10284 (let ((org-refile-targets org-refile-targets)
10285 (org-refile-use-outline-path org-refile-use-outline-path))
10286 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
10287 (unless org-refile-target-table
10288 (error "No refile targets"))
10289 (let* ((cbuf (current-buffer))
10290 (partial-completion-mode nil)
10291 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10292 (cfunc (if (and org-refile-use-outline-path
10293 org-outline-path-complete-in-steps)
10294 'org-olpath-completing-read
10295 'org-icompleting-read))
10296 (extra (if org-refile-use-outline-path "/" ""))
10297 (filename (and cfn (expand-file-name cfn)))
10298 (tbl (mapcar
10299 (lambda (x)
10300 (if (and (not (member org-refile-use-outline-path
10301 '(file full-file-path)))
10302 (not (equal filename (nth 1 x))))
10303 (cons (concat (car x) extra " ("
10304 (file-name-nondirectory (nth 1 x)) ")")
10305 (cdr x))
10306 (cons (concat (car x) extra) (cdr x))))
10307 org-refile-target-table))
10308 (completion-ignore-case t)
10309 pa answ parent-target child parent old-hist)
10310 (setq old-hist org-refile-history)
10311 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10312 nil 'org-refile-history))
10313 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10314 (org-refile-check-position pa)
10315 (if pa
10316 (progn
10317 (when (or (not org-refile-history)
10318 (not (eq old-hist org-refile-history))
10319 (not (equal (car pa) (car org-refile-history))))
10320 (setq org-refile-history
10321 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10322 org-refile-history
10323 (cdr org-refile-history))))
10324 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10325 (pop org-refile-history)))
10326 pa)
10328 (progn
10329 (setq parent (match-string 1 answ)
10330 child (match-string 2 answ))
10331 (setq parent-target (or (assoc parent tbl)
10332 (assoc (concat parent "/") tbl)))
10333 (when (and parent-target
10334 (or (eq new-nodes t)
10335 (and (eq new-nodes 'confirm)
10337 child)))))
10338 (org-refile-new-child parent-target child)))
10339 (error "Invalid target location")))))
10341 (defun org-refile-check-position (refile-pointer)
10342 "Check if the refile pointer matches the readline to which it points."
10343 (let* ((file (nth 1 refile-pointer))
10344 (re (nth 2 refile-pointer))
10345 (pos (nth 3 refile-pointer))
10346 buffer)
10347 (when (org-string-nw-p re)
10348 (setq buffer (if (markerp pos)
10349 (marker-buffer pos)
10350 (or (find-buffer-visiting file)
10351 (find-file-noselect file))))
10352 (with-current-buffer buffer
10353 (save-excursion
10354 (save-restriction
10355 (widen)
10356 (goto-char pos)
10357 (beginning-of-line 1)
10358 (unless (org-looking-at-p re)
10359 (error "Invalid refile position, please rebuild the cache"))))))))
10361 (defun org-refile-new-child (parent-target child)
10362 "Use refile target PARENT-TARGET to add new CHILD below it."
10363 (unless parent-target
10364 (error "Cannot find parent for new node"))
10365 (let ((file (nth 1 parent-target))
10366 (pos (nth 3 parent-target))
10367 level)
10368 (with-current-buffer (or (find-buffer-visiting file)
10369 (find-file-noselect file))
10370 (save-excursion
10371 (save-restriction
10372 (widen)
10373 (if pos
10374 (goto-char pos)
10375 (goto-char (point-max))
10376 (if (not (bolp)) (newline)))
10377 (when (looking-at outline-regexp)
10378 (setq level (funcall outline-level))
10379 (org-end-of-subtree t t))
10380 (org-back-over-empty-lines)
10382 (if pos (org-get-valid-level level 1) 1) ?*)
10384 (beginning-of-line 0)
10385 (list (concat (car parent-target) "/" child) file "" (point)))))))
10387 (defun org-olpath-completing-read (prompt collection &rest args)
10388 "Read an outline path like a file name."
10389 (let ((thetable collection)
10390 (org-completion-use-ido nil) ; does not work with ido.
10391 (org-completion-use-iswitchb nil)) ; or iswitchb
10392 (apply
10393 'org-icompleting-read prompt
10394 (lambda (string predicate &optional flag)
10395 (let (rtn r f (l (length string)))
10396 (cond
10397 ((eq flag nil)
10398 ;; try completion
10399 (try-completion string thetable))
10400 ((eq flag t)
10401 ;; all-completions
10402 (setq rtn (all-completions string thetable predicate))
10403 (mapcar
10404 (lambda (x)
10405 (setq r (substring x l))
10406 (if (string-match " ([^)]*)$" x)
10407 (setq f (match-string 0 x))
10408 (setq f ""))
10409 (if (string-match "/" r)
10410 (concat string (substring r 0 (match-end 0)) f)
10411 x))
10412 rtn))
10413 ((eq flag 'lambda)
10414 ;; exact match?
10415 (assoc string thetable)))
10416 ))
10417 args)))
10419 ;;;; Dynamic blocks
10421 (defun org-find-dblock (name)
10422 "Find the first dynamic block with name NAME in the buffer.
10423 If not found, stay at current position and return nil."
10424 (let (pos)
10425 (save-excursion
10426 (goto-char (point-min))
10428 nil t)
10429 (match-beginning 0))))
10430 (if pos (goto-char pos))
10431 pos))
10433 (defconst org-dblock-start-re
10435 "Matches the start line of a dynamic block, with parameters.")
10438 "Matches the end of a dynamic block.")
10440 (defun org-create-dblock (plist)
10441 "Create a dynamic block section, with parameters taken from PLIST.
10442 PLIST must contain a :name entry which is used as name of the block."
10444 (end-of-line 1)
10445 (newline))
10446 (let ((col (current-column))
10447 (name (plist-get plist :name)))
10448 (insert "#+BEGIN: " name)
10449 (while plist
10450 (if (eq (car plist) :name)
10451 (setq plist (cddr plist))
10452 (insert " " (prin1-to-string (pop plist)))))
10454 (beginning-of-line -2)))
10456 (defun org-prepare-dblock ()
10457 "Prepare dynamic block for refresh.
10458 This empties the block, puts the cursor at the insert position and returns
10459 the property list including an extra property :name with the block name."
10460 (unless (looking-at org-dblock-start-re)
10461 (error "Not at a dynamic block"))
10462 (let* ((begdel (1+ (match-end 0)))
10463 (name (org-no-properties (match-string 1)))
10464 (params (append (list :name name)
10465 (read (concat "(" (match-string 3) ")")))))
10466 (save-excursion
10467 (beginning-of-line 1)
10469 (setq params (plist-put params :indentation-column (current-column))))
10470 (unless (re-search-forward org-dblock-end-re nil t)
10471 (error "Dynamic block not terminated"))
10472 (setq params
10473 (append params
10474 (list :content (buffer-substring
10475 begdel (match-beginning 0)))))
10476 (delete-region begdel (match-beginning 0))
10477 (goto-char begdel)
10478 (open-line 1)
10479 params))
10481 (defun org-map-dblocks (&optional command)
10482 "Apply COMMAND to all dynamic blocks in the current buffer.
10483 If COMMAND is not given, use `org-update-dblock'."
10484 (let ((cmd (or command 'org-update-dblock)))
10485 (save-excursion
10486 (goto-char (point-min))
10487 (while (re-search-forward org-dblock-start-re nil t)
10488 (goto-char (match-beginning 0))
10489 (save-excursion
10490 (condition-case nil
10491 (funcall cmd)
10492 (error (message "Error during update of dynamic block"))))
10493 (unless (re-search-forward org-dblock-end-re nil t)
10494 (error "Dynamic block not terminated"))))))
10496 (defun org-dblock-update (&optional arg)
10497 "User command for updating dynamic blocks.
10498 Update the dynamic block at point. With prefix ARG, update all dynamic
10499 blocks in the buffer."
10500 (interactive "P")
10501 (if arg
10502 (org-update-all-dblocks)
10503 (or (looking-at org-dblock-start-re)
10504 (org-beginning-of-dblock))
10505 (org-update-dblock)))
10507 (defun org-update-dblock ()
10508 "Update the dynamic block at point.
10509 This means to empty the block, parse for parameters and then call
10510 the correct writing function."
10511 (interactive)
10512 (save-window-excursion
10513 (let* ((pos (point))
10514 (line (org-current-line))
10515 (params (org-prepare-dblock))
10516 (name (plist-get params :name))
10517 (indent (plist-get params :indentation-column))
10518 (cmd (intern (concat "org-dblock-write:" name))))
10519 (message "Updating dynamic block `%s' at line %d..." name line)
10520 (funcall cmd params)
10521 (message "Updating dynamic block `%s' at line %d...done" name line)
10522 (goto-char pos)
10523 (when (and indent (> indent 0))
10524 (setq indent (make-string indent ?\ ))
10525 (save-excursion
10526 (org-beginning-of-dblock)
10527 (forward-line 1)
10528 (while (not (looking-at org-dblock-end-re))
10529 (insert indent)
10530 (beginning-of-line 2))
10531 (when (looking-at org-dblock-end-re)
10533 (replace-match ""))
10534 (insert indent)))))))
10536 (defun org-beginning-of-dblock ()
10537 "Find the beginning of the dynamic block at point.
10538 Error if there is no such block at point."
10539 (let ((pos (point))
10540 beg)
10541 (end-of-line 1)
10542 (if (and (re-search-backward org-dblock-start-re nil t)
10543 (setq beg (match-beginning 0))
10544 (re-search-forward org-dblock-end-re nil t)
10545 (> (match-end 0) pos))
10546 (goto-char beg)
10547 (goto-char pos)
10548 (error "Not in a dynamic block"))))
10550 (defun org-update-all-dblocks ()
10551 "Update all dynamic blocks in the buffer.
10552 This function can be used in a hook."
10553 (interactive)
10554 (when (org-mode-p)
10555 (org-map-dblocks 'org-update-dblock)))
10558 ;;;; Completion
10560 (defconst org-additional-option-like-keywords
10561 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10562 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10563 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10564 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10565 "BEGIN:" "END:"
10566 "ORGTBL" "TBLFM:" "TBLNAME:"
10567 "BEGIN_EXAMPLE" "END_EXAMPLE"
10568 "BEGIN_QUOTE" "END_QUOTE"
10569 "BEGIN_VERSE" "END_VERSE"
10570 "BEGIN_CENTER" "END_CENTER"
10571 "BEGIN_SRC" "END_SRC"
10572 "BEGIN_RESULT" "END_RESULT"
10573 "SOURCE:" "SRCNAME:" "FUNCTION:"
10574 "RESULTS:"
10575 "HEADER:" "HEADERS:"
10576 "BABEL:"
10577 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10578 "CAPTION:" "LABEL:"
10579 "SETUPFILE:"
10580 "INCLUDE:"
10581 "BIND:"
10582 "MACRO:"))
10584 (defcustom org-structure-template-alist
10585 '(
10598 ("L" "#+latex: "
10602 ("H" "#+html: "
10605 ("A" "#+ascii: ")
10606 ("i" "#+include %file ?"
10608 )
10609 "Structure completion elements.
10610 This is a list of abbreviation keys and values. The value gets inserted
10611 if you type `<' followed by the key and then press the completion key,
10612 usually `M-TAB'. %file will be replaced by a file name after prompting
10613 for the file using completion.
10614 There are two templates for each key, the first uses the original Org syntax,
10615 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10616 the default when the /org-mtags.el/ module has been loaded. See also the
10617 variable `org-mtags-prefer-muse-templates'.
10618 This is an experimental feature, it is undecided if it is going to stay in."
10619 :group 'org-completion
10620 :type '(repeat
10621 (string :tag "Key")
10622 (string :tag "Template")
10623 (string :tag "Muse Template")))
10625 (defun org-try-structure-completion ()
10626 "Try to complete a structure template before point.
10628 expands them."
10629 (let ((l (buffer-substring (point-at-bol) (point)))
10630 a)
10633 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10634 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10635 (match-beginning 1)) a)
10636 t)))
10638 (defun org-complete-expand-structure-template (start cell)
10639 "Expand a structure template."
10640 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10641 (rpl (nth (if musep 2 1) cell))
10642 (ind ""))
10643 (delete-region start (point))
10645 (cond
10646 ((bolp))
10648 (setq ind (buffer-substring (point-at-bol) (point))))
10649 (t (newline))))
10650 (setq start (point))
10651 (if (string-match "%file" rpl)
10652 (setq rpl (replace-match
10653 (concat
10655 (save-match-data
10656 (abbreviate-file-name (read-file-name "Include file: ")))
10658 t t rpl)))
10661 (insert rpl)
10664 ;;;; TODO, DEADLINE, Comments
10666 (defun org-toggle-comment ()
10667 "Change the COMMENT state of an entry."
10668 (interactive)
10669 (save-excursion
10670 (org-back-to-heading)
10671 (let (case-fold-search)
10672 (if (looking-at (concat outline-regexp
10674 (replace-match "" t t nil 1)
10675 (if (looking-at outline-regexp)
10676 (progn
10677 (goto-char (match-end 0))
10678 (insert org-comment-string " ")))))))
10680 (defvar org-last-todo-state-is-todo nil
10681 "This is non-nil when the last TODO state change led to a TODO state.
10682 If the last change removed the TODO tag or switched to DONE, then
10683 this is nil.")
10685 (defvar org-setting-tags nil) ; dynamically skipped
10687 (defvar org-todo-setup-filter-hook nil
10688 "Hook for functions that pre-filter todo specs.
10689 Each function takes a todo spec and returns either nil or the spec
10690 transformed into canonical form." )
10692 (defvar org-todo-get-default-hook nil
10693 "Hook for functions that get a default item for todo.
10694 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10695 nil or a string to be used for the todo mark." )
10697 (defvar org-agenda-headline-snapshot-before-repeat)
10699 (defun org-todo (&optional arg)
10700 "Change the TODO state of an item.
10701 The state of an item is given by a keyword at the start of the heading,
10702 like
10703 *** TODO Write paper
10704 *** DONE Call mom
10706 The different keywords are specified in the variable `org-todo-keywords'.
10708 So for this example: when the item starts with TODO, it is changed to DONE.
10709 When it starts with DONE, the DONE is removed. And when neither TODO nor
10710 DONE are present, add TODO at the beginning of the heading.
10713 state.
10714 With numeric prefix arg, switch to that state.
10716 keywords (nextset).
10719 For calling through lisp, arg is also interpreted in the following way:
10720 'none -> empty state
10722 'done -> switch to DONE
10723 'nextset -> switch to the next set of keywords
10724 'previousset -> switch to the previous set of keywords
10726 really is a member of `org-todo-keywords'."
10727 (interactive "P")
10728 (if (equal arg '(16)) (setq arg 'nextset))
10729 (let ((org-blocker-hook org-blocker-hook)
10730 (case-fold-search nil))
10731 (when (equal arg '(64))
10732 (setq arg nil org-blocker-hook nil))
10733 (when (and org-blocker-hook
10734 (or org-inhibit-blocking
10735 (org-entry-get nil "NOBLOCKING")))
10736 (setq org-blocker-hook nil))
10737 (save-excursion
10738 (catch 'exit
10739 (org-back-to-heading t)
10740 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10742 (looking-at " *"))
10743 (let* ((match-data (match-data))
10744 (startpos (point-at-bol))
10745 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10746 (org-log-done org-log-done)
10747 (org-log-repeat org-log-repeat)
10748 (org-todo-log-states org-todo-log-states)
10749 (this (match-string 1))
10750 (hl-pos (match-beginning 0))
10751 (head (org-get-todo-sequence-head this))
10752 (ass (assoc head org-todo-kwd-alist))
10753 (interpret (nth 1 ass))
10754 (done-word (nth 3 ass))
10755 (final-done-word (nth 4 ass))
10756 (last-state (or this ""))
10757 (completion-ignore-case t)
10758 (member (member this org-todo-keywords-1))
10759 (tail (cdr member))
10760 (state (cond
10761 ((and org-todo-key-trigger
10762 (or (and (equal arg '(4))
10763 (eq org-use-fast-todo-selection 'prefix))
10764 (and (not arg) org-use-fast-todo-selection
10765 (not (eq org-use-fast-todo-selection
10766 'prefix)))))
10767 ;; Use fast selection
10768 (org-fast-todo-selection))
10769 ((and (equal arg '(4))
10770 (or (not org-use-fast-todo-selection)
10771 (not org-todo-key-trigger)))
10772 ;; Read a state with completion
10773 (org-icompleting-read
10774 "State: " (mapcar (lambda(x) (list x))
10775 org-todo-keywords-1)
10776 nil t))
10777 ((eq arg 'right)
10778 (if this
10779 (if tail (car tail) nil)
10780 (car org-todo-keywords-1)))
10781 ((eq arg 'left)
10782 (if (equal member org-todo-keywords-1)
10783 nil
10784 (if this
10785 (nth (- (length org-todo-keywords-1)
10786 (length tail) 2)
10787 org-todo-keywords-1)
10788 (org-last org-todo-keywords-1))))
10789 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10790 (setq arg nil))) ; hack to fall back to cycling
10791 (arg
10792 ;; user or caller requests a specific state
10793 (cond
10794 ((equal arg "") nil)
10795 ((eq arg 'none) nil)
10796 ((eq arg 'done) (or done-word (car org-done-keywords)))
10797 ((eq arg 'nextset)
10798 (or (car (cdr (member head org-todo-heads)))
10799 (car org-todo-heads)))
10800 ((eq arg 'previousset)
10801 (let ((org-todo-heads (reverse org-todo-heads)))
10802 (or (car (cdr (member head org-todo-heads)))
10803 (car org-todo-heads))))
10804 ((car (member arg org-todo-keywords-1)))
10805 ((stringp arg)
10806 (error "State `%s' not valid in this file" arg))
10807 ((nth (1- (prefix-numeric-value arg))
10808 org-todo-keywords-1))))
10809 ((null member) (or head (car org-todo-keywords-1)))
10810 ((equal this final-done-word) nil) ;; -> make empty
10811 ((null tail) nil) ;; -> first entry
10812 ((memq interpret '(type priority))
10813 (if (eq this-command last-command)
10814 (car tail)
10815 (if (> (length tail) 0)
10816 (or done-word (car org-done-keywords))
10817 nil)))
10818 (t
10819 (car tail))))
10820 (state (or
10821 (run-hook-with-args-until-success
10822 'org-todo-get-default-hook state last-state)
10823 state))
10824 (next (if state (concat " " state " ") " "))
10825 (change-plist (list :type 'todo-state-change :from this :to state
10826 :position startpos))
10827 dolog now-done-p)
10828 (when org-blocker-hook
10829 (setq org-last-todo-state-is-todo
10830 (not (member this org-done-keywords)))
10831 (unless (save-excursion
10832 (save-match-data
10833 (run-hook-with-args-until-failure
10834 'org-blocker-hook change-plist)))
10835 (if (interactive-p)
10836 (error "TODO state change from %s to %s blocked" this state)
10837 ;; fail silently
10838 (message "TODO state change from %s to %s blocked" this state)
10839 (throw 'exit nil))))
10840 (store-match-data match-data)
10841 (replace-match next t t)
10842 (unless (pos-visible-in-window-p hl-pos)
10843 (message "TODO state changed to %s" (org-trim next)))
10844 (unless head
10845 (setq head (org-get-todo-sequence-head state)
10846 ass (assoc head org-todo-kwd-alist)
10847 interpret (nth 1 ass)
10848 done-word (nth 3 ass)
10849 final-done-word (nth 4 ass)))
10850 (when (memq arg '(nextset previousset))
10851 (message "Keyword-Set %d/%d: %s"
10852 (- (length org-todo-sets) -1
10853 (length (memq (assoc state org-todo-sets) org-todo-sets)))
10854 (length org-todo-sets)
10855 (mapconcat 'identity (assoc state org-todo-sets) " ")))
10856 (setq org-last-todo-state-is-todo
10857 (not (member state org-done-keywords)))
10858 (setq now-done-p (and (member state org-done-keywords)
10859 (not (member this org-done-keywords))))
10860 (and logging (org-local-logging logging))
10861 (when (and (or org-todo-log-states org-log-done)
10862 (not (eq org-inhibit-logging t))
10863 (not (memq arg '(nextset previousset))))
10864 ;; we need to look at recording a time and note
10865 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
10866 (nth 2 (assoc this org-todo-log-states))))
10867 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
10868 (setq dolog 'time))
10869 (when (and state
10870 (member state org-not-done-keywords)
10871 (not (member this org-not-done-keywords)))
10872 ;; This is now a todo state and was not one before
10873 ;; If there was a CLOSED time stamp, get rid of it.
10874 (org-add-planning-info nil nil 'closed))
10875 (when (and now-done-p org-log-done)
10876 ;; It is now done, and it was not done before
10877 (org-add-planning-info 'closed (org-current-time))
10878 (if (and (not dolog) (eq 'note org-log-done))
10879 (org-add-log-setup 'done state this 'findpos 'note)))
10880 (when (and state dolog)
10881 ;; This is a non-nil state, and we need to log it
10882 (org-add-log-setup 'state state this 'findpos dolog)))
10883 ;; Fixup tag positioning
10884 (org-todo-trigger-tag-changes state)
10885 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
10886 (when org-provide-todo-statistics
10887 (org-update-parent-todo-statistics))
10888 (run-hooks 'org-after-todo-state-change-hook)
10889 (if (and arg (not (member state org-done-keywords)))
10890 (setq head (org-get-todo-sequence-head state)))
10891 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
10892 ;; Do we need to trigger a repeat?
10893 (when now-done-p
10894 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
10895 ;; This is for the agenda, take a snapshot of the headline.
10896 (save-match-data
10897 (setq org-agenda-headline-snapshot-before-repeat
10898 (org-get-heading))))
10899 (org-auto-repeat-maybe state))
10900 ;; Fixup cursor location if close to the keyword
10901 (if (and (outline-on-heading-p)
10902 (not (bolp))
10903 (save-excursion (beginning-of-line 1)
10904 (looking-at org-todo-line-regexp))
10905 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
10906 (progn
10907 (goto-char (or (match-end 2) (match-end 1)))
10908 (and (looking-at " ") (just-one-space))))
10909 (when org-trigger-hook
10910 (save-excursion
10911 (run-hook-with-args 'org-trigger-hook change-plist))))))))
10913 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
10914 "Block turning an entry into a TODO, using the hierarchy.
10915 This checks whether the current task should be blocked from state
10916 changes. Such blocking occurs when:
10918 1. The task has children which are not all in a completed state.
10920 2. A task has a parent with the property :ORDERED:, and there
10921 are siblings prior to the current task with incomplete
10922 status.
10924 3. The parent of the task is blocked because it has siblings that should
10925 be done first, or is child of a block grandparent TODO entry."
10927 (if (not org-enforce-todo-dependencies)
10928 t ; if locally turned off don't block
10929 (catch 'dont-block
10930 ;; If this is not a todo state change, or if this entry is already DONE,
10931 ;; do not block
10932 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
10933 (member (plist-get change-plist :from)
10934 (cons 'done org-done-keywords))
10935 (member (plist-get change-plist :to)
10936 (cons 'todo org-not-done-keywords))
10937 (not (plist-get change-plist :to)))
10938 (throw 'dont-block t))
10939 ;; If this task has children, and any are undone, it's blocked
10940 (save-excursion
10941 (org-back-to-heading t)
10942 (let ((this-level (funcall outline-level)))
10943 (outline-next-heading)
10944 (let ((child-level (funcall outline-level)))
10945 (while (and (not (eobp))
10946 (> child-level this-level))
10947 ;; this todo has children, check whether they are all
10948 ;; completed
10949 (if (and (not (org-entry-is-done-p))
10950 (org-entry-is-todo-p))
10951 (throw 'dont-block nil))
10952 (outline-next-heading)
10953 (setq child-level (funcall outline-level))))))
10954 ;; Otherwise, if the task's parent has the :ORDERED: property, and
10955 ;; any previous siblings are undone, it's blocked
10956 (save-excursion
10957 (org-back-to-heading t)
10958 (let* ((pos (point))
10959 (parent-pos (and (org-up-heading-safe) (point))))
10960 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10961 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
10962 (forward-line 1)
10963 (re-search-forward org-not-done-heading-regexp pos t))
10964 (throw 'dont-block nil)) ; block, there is an older sibling not done.
10965 ;; Search further up the hierarchy, to see if an anchestor is blocked
10966 (while t
10967 (goto-char parent-pos)
10968 (if (not (looking-at org-not-done-heading-regexp))
10969 (throw 'dont-block t)) ; do not block, parent is not a TODO
10970 (setq pos (point))
10971 (setq parent-pos (and (org-up-heading-safe) (point)))
10972 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10973 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
10974 (forward-line 1)
10975 (re-search-forward org-not-done-heading-regexp pos t))
10976 (throw 'dont-block nil)))))))) ; block, older sibling not done.
10978 (defcustom org-track-ordered-property-with-tag nil
10979 "Should the ORDERED property also be shown as a tag?
10980 The ORDERED property decides if an entry should require subtasks to be
10981 completed in sequence. Since a property is not very visible, setting
10982 this option means that toggling the ORDERED property with the command
10983 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
10984 not relevant for the behavior, but it makes things more visible.
10986 Note that toggling the tag with tags commands will not change the property
10987 and therefore not influence behavior!
10989 This can be t, meaning the tag ORDERED should be used, It can also be a
10990 string to select a different tag for this task."
10991 :group 'org-todo
10992 :type '(choice
10993 (const :tag "No tracking" nil)
10994 (const :tag "Track with ORDERED tag" t)
10995 (string :tag "Use other tag")))
10997 (defun org-toggle-ordered-property ()
10998 "Toggle the ORDERED property of the current entry.
10999 For better visibility, you can track the value of this property with a tag.
11000 See variable `org-track-ordered-property-with-tag'."
11001 (interactive)
11002 (let* ((t1 org-track-ordered-property-with-tag)
11003 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11004 (save-excursion
11005 (org-back-to-heading)
11006 (if (org-entry-get nil "ORDERED")
11007 (progn
11008 (org-delete-property "ORDERED")
11009 (and tag (org-toggle-tag tag 'off))
11010 (message "Subtasks can be completed in arbitrary order"))
11011 (org-entry-put nil "ORDERED" "t")
11012 (and tag (org-toggle-tag tag 'on))
11013 (message "Subtasks must be completed in sequence")))))
11015 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11016 (defun org-block-todo-from-checkboxes (change-plist)
11017 "Block turning an entry into a TODO, using checkboxes.
11018 This checks whether the current task should be blocked from state
11019 changes because there are unchecked boxes in this entry."
11020 (if (not org-enforce-todo-checkbox-dependencies)
11021 t ; if locally turned off don't block
11022 (catch 'dont-block
11023 ;; If this is not a todo state change, or if this entry is already DONE,
11024 ;; do not block
11025 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11026 (member (plist-get change-plist :from)
11027 (cons 'done org-done-keywords))
11028 (member (plist-get change-plist :to)
11029 (cons 'todo org-not-done-keywords))
11030 (not (plist-get change-plist :to)))
11031 (throw 'dont-block t))
11032 ;; If this task has checkboxes that are not checked, it's blocked
11033 (save-excursion
11034 (org-back-to-heading t)
11035 (let ((beg (point)) end)
11036 (outline-next-heading)
11037 (setq end (point))
11038 (goto-char beg)
11040 end t)
11041 (progn
11042 (if (boundp 'org-blocked-by-checkboxes)
11043 (setq org-blocked-by-checkboxes t))
11044 (throw 'dont-block nil)))))
11045 t))) ; do not block
11047 (defun org-entry-blocked-p ()
11048 "Is the current entry blocked?"
11049 (if (org-entry-get nil "NOBLOCKING")
11050 nil ;; Never block this entry
11051 (not
11052 (run-hook-with-args-until-failure
11053 'org-blocker-hook
11054 (list :type 'todo-state-change
11055 :position (point)
11056 :from 'todo
11057 :to 'done)))))
11059 (defun org-update-statistics-cookies (all)
11060 "Update the statistics cookie, either from TODO or from checkboxes.
11061 This should be called with the cursor in a line with a statistics cookie."
11062 (interactive "P")
11063 (if all
11064 (progn
11065 (org-update-checkbox-count 'all)
11066 (org-map-entries 'org-update-parent-todo-statistics))
11067 (if (not (org-on-heading-p))
11068 (org-update-checkbox-count)
11069 (let ((pos (move-marker (make-marker) (point)))
11070 end l1 l2)
11071 (ignore-errors (org-back-to-heading t))
11072 (if (not (org-on-heading-p))
11073 (org-update-checkbox-count)
11074 (setq l1 (org-outline-level))
11075 (setq end (save-excursion
11076 (outline-next-heading)
11077 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11078 (point)))
11079 (if (and (save-excursion
11080 (re-search-forward
11082 (not (save-excursion (re-search-forward
11084 (org-update-checkbox-count)
11085 (if (and l2 (> l2 l1))
11086 (progn
11087 (goto-char end)
11088 (org-update-parent-todo-statistics))
11089 (goto-char pos)
11090 (beginning-of-line 1)
11091 (while (re-search-forward
11093 (point-at-eol) t)
11094 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11095 (goto-char pos)
11096 (move-marker pos nil)))))
11098 (defvar org-entry-property-inherited-from) ;; defined below
11099 (defun org-update-parent-todo-statistics ()
11100 "Update any statistics cookie in the parent of the current headline.
11101 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11102 the entire subtree and this will travel up the hierarchy and update
11103 statistics everywhere."
11104 (interactive)
11105 (let* ((lim 0) prop
11106 (recursive (or (not org-hierarchical-todo-statistics)
11107 (string-match
11109 (or (setq prop (org-entry-get
11110 nil "COOKIE_DATA" 'inherit)) ""))))
11111 (lim (or (and prop (marker-position
11112 org-entry-property-inherited-from))
11113 lim))
11114 (first t)
11116 level ltoggle l1 new ndel
11117 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
11118 (catch 'exit
11119 (save-excursion
11120 (beginning-of-line 1)
11121 (if (org-at-heading-p)
11122 (setq ltoggle (funcall outline-level))
11123 (error "This should not happen"))
11124 (while (and (setq level (org-up-heading-safe))
11125 (or recursive first)
11126 (>= (point) lim))
11127 (setq first nil cookie-present nil)
11128 (unless (and level
11129 (not (string-match
11131 (downcase
11132 (or (org-entry-get
11133 nil "COOKIE_DATA")
11134 "")))))
11135 (throw 'exit nil))
11136 (while (re-search-forward box-re (point-at-eol) t)
11137 (setq cnt-all 0 cnt-done 0 cookie-present t)
11138 (setq is-percent (match-end 2))
11139 (save-match-data
11140 (unless (outline-next-heading) (throw 'exit nil))
11141 (while (and (looking-at org-complex-heading-regexp)
11142 (> (setq l1 (length (match-string 1))) level))
11143 (setq kwd (and (or recursive (= l1 ltoggle))
11144 (match-string 2)))
11145 (if (or (eq org-provide-todo-statistics 'all-headlines)
11146 (and (listp org-provide-todo-statistics)
11147 (or (member kwd org-provide-todo-statistics)
11148 (member kwd org-done-keywords))))
11149 (setq cnt-all (1+ cnt-all))
11150 (if (eq org-provide-todo-statistics t)
11151 (and kwd (setq cnt-all (1+ cnt-all)))))
11152 (and (member kwd org-done-keywords)
11153 (setq cnt-done (1+ cnt-done)))
11154 (outline-next-heading)))
11155 (setq new
11156 (if is-percent
11157 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11158 (format "[%d/%d]" cnt-done cnt-all))
11159 ndel (- (match-end 0) (match-beginning 0)))
11160 (goto-char (match-beginning 0))
11161 (insert new)
11162 (delete-region (point) (+ (point) ndel)))
11163 (when cookie-present
11164 (run-hook-with-args 'org-after-todo-statistics-hook
11165 cnt-done (- cnt-all cnt-done))))))
11166 (run-hooks 'org-todo-statistics-hook)))
11168 (defvar org-after-todo-statistics-hook nil
11169 "Hook that is called after a TODO statistics cookie has been updated.
11170 Each function is called with two arguments: the number of not-done entries
11171 and the number of done entries.
11173 For example, the following function, when added to this hook, will switch
11174 an entry to DONE when all children are done, and back to TODO when new
11175 entries are set to a TODO status. Note that this hook is only called
11176 when there is a statistics cookie in the headline!
11178 (defun org-summary-todo (n-done n-not-done)
11180 (let (org-log-done org-log-states) ; turn off logging
11182 ")
11184 (defvar org-todo-statistics-hook nil
11185 "Hook that is run whenever Org thinks TODO statistics should be updated.
11186 This hook runs even if there is no statistics cookie present, in which case
11187 `org-after-todo-statistics-hook' would not run.")
11189 (defun org-todo-trigger-tag-changes (state)
11190 "Apply the changes defined in `org-todo-state-tags-triggers'."
11191 (let ((l org-todo-state-tags-triggers)
11192 changes)
11193 (when (or (not state) (equal state ""))
11194 (setq changes (append changes (cdr (assoc "" l)))))
11195 (when (and (stringp state) (> (length state) 0))
11196 (setq changes (append changes (cdr (assoc state l)))))
11197 (when (member state org-not-done-keywords)
11198 (setq changes (append changes (cdr (assoc 'todo l)))))
11199 (when (member state org-done-keywords)
11200 (setq changes (append changes (cdr (assoc 'done l)))))
11201 (dolist (c changes)
11202 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11204 (defun org-local-logging (value)
11205 "Get logging settings from a property VALUE."
11206 (let* (words w a)
11207 ;; directly set the variables, they are already local.
11208 (setq org-log-done nil
11209 org-log-repeat nil
11210 org-todo-log-states nil)
11211 (setq words (org-split-string value))
11212 (while (setq w (pop words))
11213 (cond
11214 ((setq a (assoc w org-startup-options))
11215 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11216 (set (nth 1 a) (nth 2 a))))
11217 ((setq a (org-extract-log-state-settings w))
11218 (and (member (car a) org-todo-keywords-1)
11219 (push a org-todo-log-states)))))))
11221 (defun org-get-todo-sequence-head (kwd)
11222 "Return the head of the TODO sequence to which KWD belongs.
11223 If KWD is not set, check if there is a text property remembering the
11224 right sequence."
11225 (let (p)
11226 (cond
11227 ((not kwd)
11228 (or (get-text-property (point-at-bol) 'org-todo-head)
11229 (progn
11230 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11231 nil (point-at-eol)))
11232 (get-text-property p 'org-todo-head))))
11233 ((not (member kwd org-todo-keywords-1))
11234 (car org-todo-keywords-1))
11235 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11237 (defun org-fast-todo-selection ()
11238 "Fast TODO keyword selection with single keys.
11239 Returns the new TODO keyword, or nil if no state change should occur."
11240 (let* ((fulltable org-todo-key-alist)
11241 (done-keywords org-done-keywords) ;; needed for the faces.
11242 (maxlen (apply 'max (mapcar
11243 (lambda (x)
11244 (if (stringp (car x)) (string-width (car x)) 0))
11245 fulltable)))
11246 (expert nil)
11247 (fwidth (+ maxlen 3 1 3))
11248 (ncol (/ (- (window-width) 4) fwidth))
11249 tg cnt e c tbl
11250 groups ingroup)
11251 (save-excursion
11252 (save-window-excursion
11253 (if expert
11254 (set-buffer (get-buffer-create " *Org todo*"))
11255 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11256 (erase-buffer)
11257 (org-set-local 'org-done-keywords done-keywords)
11258 (setq tbl fulltable cnt 0)
11259 (while (setq e (pop tbl))
11260 (cond
11261 ((equal e '(:startgroup))
11262 (push '() groups) (setq ingroup t)
11263 (when (not (= cnt 0))
11264 (setq cnt 0)
11266 (insert "{ "))
11267 ((equal e '(:endgroup))
11268 (setq ingroup nil cnt 0)
11270 ((equal e '(:newline))
11271 (when (not (= cnt 0))
11272 (setq cnt 0)
11274 (setq e (car tbl))
11275 (while (equal (car tbl) '(:newline))
11277 (setq tbl (cdr tbl)))))
11278 (t
11279 (setq tg (car e) c (cdr e))
11280 (if ingroup (push tg (car groups)))
11281 (setq tg (org-add-props tg nil 'face
11282 (org-get-todo-face tg)))
11283 (if (and (= cnt 0) (not ingroup)) (insert " "))
11284 (insert "[" c "] " tg (make-string
11285 (- fwidth 4 (length tg)) ?\ ))
11286 (when (= (setq cnt (1+ cnt)) ncol)
11288 (if ingroup (insert " "))
11289 (setq cnt 0)))))
11291 (goto-char (point-min))
11292 (if (not expert) (org-fit-window-to-buffer))
11293 (message "[a-z..]:Set [SPC]:clear")
11294 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11295 (cond
11296 ((or (= c ?\C-g)
11297 (and (= c ?q) (not (rassoc c fulltable))))
11298 (setq quit-flag t))
11299 ((= c ?\ ) nil)
11300 ((setq e (rassoc c fulltable) tg (car e))
11301 tg)
11302 (t (setq quit-flag t)))))))
11304 (defun org-entry-is-todo-p ()
11305 (member (org-get-todo-state) org-not-done-keywords))
11307 (defun org-entry-is-done-p ()
11308 (member (org-get-todo-state) org-done-keywords))
11310 (defun org-get-todo-state ()
11311 (save-excursion
11312 (org-back-to-heading t)
11313 (and (looking-at org-todo-line-regexp)
11314 (match-end 2)
11315 (match-string 2))))
11317 (defun org-at-date-range-p (&optional inactive-ok)
11318 "Is the cursor inside a date range?"
11319 (interactive)
11320 (save-excursion
11321 (catch 'exit
11322 (let ((pos (point)))
11324 (skip-chars-backward "<[")
11325 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11326 (>= (match-end 0) pos)
11327 (throw 'exit t))
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)))
11333 nil)))
11335 (defun org-get-repeat (&optional tagline)
11336 "Check if there is a deadline/schedule with repeater in this entry."
11337 (save-match-data
11338 (save-excursion
11339 (org-back-to-heading t)
11340 (and (re-search-forward (if tagline
11342 org-repeat-re)
11343 (org-entry-end-position) t)
11344 (match-string-no-properties 1)))))
11346 (defvar org-last-changed-timestamp)
11347 (defvar org-last-inserted-timestamp)
11348 (defvar org-log-post-message)
11349 (defvar org-log-note-purpose)
11350 (defvar org-log-note-how)
11351 (defvar org-log-note-extra)
11352 (defun org-auto-repeat-maybe (done-word)
11353 "Check if the current headline contains a repeated deadline/schedule.
11354 If yes, set TODO state back to what it was and change the base date
11355 of repeating deadline/scheduled time stamps to new date.
11356 This function is run automatically after each state change to a DONE state."
11357 ;; last-state is dynamically scoped into this function
11358 (let* ((repeat (org-get-repeat))
11359 (aa (assoc last-state org-todo-kwd-alist))
11360 (interpret (nth 1 aa))
11361 (head (nth 2 aa))
11362 (whata '(("d" . day) ("m" . month) ("y" . year)))
11363 (msg "Entry repeats: ")
11364 (org-log-done nil)
11365 (org-todo-log-states nil)
11366 re type n what ts time to-state)
11367 (when repeat
11368 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11369 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11370 org-todo-repeat-to-state))
11371 (unless (and to-state (member to-state org-todo-keywords-1))
11372 (setq to-state (if (eq interpret 'type) last-state head)))
11373 (org-todo to-state)
11374 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11375 (org-entry-put nil "LAST_REPEAT" (format-time-string
11376 (org-time-stamp-format t t))))
11377 (when org-log-repeat
11378 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11379 (memq 'org-add-log-note post-command-hook))
11380 ;; OK, we are already setup for some record
11381 (if (eq org-log-repeat 'note)
11382 ;; make sure we take a note, not only a time stamp
11383 (setq org-log-note-how 'note))
11384 ;; Set up for taking a record
11385 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11386 last-state
11387 'findpos org-log-repeat)))
11388 (org-back-to-heading t)
11389 (org-add-planning-info nil nil 'closed)
11393 (while (re-search-forward
11394 re (save-excursion (outline-next-heading) (point)) t)
11395 (setq type (if (match-end 1) org-scheduled-string
11396 (if (match-end 3) org-deadline-string "Plain:"))
11397 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11399 (setq n (string-to-number (match-string 2 ts))
11400 what (match-string 3 ts))
11401 (if (equal what "w") (setq n (* n 7) what "d"))
11402 ;; Preparation, see if we need to modify the start date for the change
11403 (when (match-end 1)
11404 (setq time (save-match-data (org-time-string-to-time ts)))
11405 (cond
11406 ((equal (match-string 1 ts) ".")
11407 ;; Shift starting date to today
11408 (org-timestamp-change
11409 (- (time-to-days (current-time)) (time-to-days time))
11410 'day))
11411 ((equal (match-string 1 ts) "+")
11412 (let ((nshiftmax 10) (nshift 0))
11413 (while (or (= nshift 0)
11414 (<= (time-to-days time)
11415 (time-to-days (current-time))))
11416 (when (= (incf nshift) nshiftmax)
11417 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11418 (error "Abort")))
11419 (org-timestamp-change n (cdr (assoc what whata)))
11420 (org-at-timestamp-p t)
11421 (setq ts (match-string 1))
11422 (setq time (save-match-data (org-time-string-to-time ts)))))
11423 (org-timestamp-change (- n) (cdr (assoc what whata)))
11424 ;; rematch, so that we have everything in place for the real shift
11425 (org-at-timestamp-p t)
11426 (setq ts (match-string 1))
11428 (org-timestamp-change n (cdr (assoc what whata)))
11429 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11430 (setq org-log-post-message msg)
11431 (message "%s" msg))))
11433 (defun org-show-todo-tree (arg)
11434 "Make a compact tree which shows all headlines marked with TODO.
11435 The tree will show the lines where the regexp matches, and all higher
11436 headlines above the match.
11438 With a numeric prefix N, construct a sparse tree for the Nth element
11439 of `org-todo-keywords-1'."
11440 (interactive "P")
11441 (let ((case-fold-search nil)
11442 (kwd-re
11443 (cond ((null arg) org-not-done-regexp)
11444 ((equal arg '(4))
11445 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11446 (mapcar 'list org-todo-keywords-1))))
11450 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11451 (regexp-quote (nth (1- (prefix-numeric-value arg))
11452 org-todo-keywords-1)))
11453 (t (error "Invalid prefix argument: %s" arg)))))
11454 (message "%d TODO entries found"
11455 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
11457 (defun org-deadline (&optional remove time)
11459 With argument REMOVE, remove any deadline from the item.
11460 When TIME is set, it should be an internal time specification, and the
11461 scheduling will use the corresponding date."
11462 (interactive "P")
11463 (let* ((old-date (org-entry-get nil "DEADLINE"))
11464 (repeater (and old-date
11466 (match-string 1 old-date))))
11467 (if remove
11468 (progn
11469 (when (and old-date org-log-redeadline)
11470 (org-add-log-setup 'deldeadline nil old-date 'findpos
11471 org-log-redeadline))
11472 (org-remove-timestamp-with-keyword org-deadline-string)
11473 (message "Item no longer has a deadline."))
11474 (org-add-planning-info 'deadline time 'closed)
11475 (when (and old-date org-log-redeadline
11476 (not (equal old-date
11477 (substring org-last-inserted-timestamp 1 -1))))
11478 (org-add-log-setup 'redeadline nil old-date 'findpos
11479 org-log-redeadline))
11480 (when repeater
11481 (save-excursion
11482 (org-back-to-heading t)
11483 (when (re-search-forward (concat org-deadline-string " "
11484 org-last-inserted-timestamp)
11485 (save-excursion
11486 (outline-next-heading) (point)) t)
11487 (goto-char (1- (match-end 0)))
11488 (insert " " repeater)
11489 (setq org-last-inserted-timestamp
11490 (concat (substring org-last-inserted-timestamp 0 -1)
11491 " " repeater
11492 (substring org-last-inserted-timestamp -1))))))
11493 (message "Deadline on %s" org-last-inserted-timestamp))))
11495 (defun org-schedule (&optional remove time)
11496 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11497 With argument REMOVE, remove any scheduling date from the item.
11498 When TIME is set, it should be an internal time specification, and the
11499 scheduling will use the corresponding date."
11500 (interactive "P")
11501 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11502 (repeater (and old-date
11504 (match-string 1 old-date))))
11505 (if remove
11506 (progn
11507 (when (and old-date org-log-reschedule)
11508 (org-add-log-setup 'delschedule nil old-date 'findpos
11509 org-log-reschedule))
11510 (org-remove-timestamp-with-keyword org-scheduled-string)
11511 (message "Item is no longer scheduled."))
11512 (org-add-planning-info 'scheduled time 'closed)
11513 (when (and old-date org-log-reschedule
11514 (not (equal old-date
11515 (substring org-last-inserted-timestamp 1 -1))))
11516 (org-add-log-setup 'reschedule nil old-date 'findpos
11517 org-log-reschedule))
11518 (when repeater
11519 (save-excursion
11520 (org-back-to-heading t)
11521 (when (re-search-forward (concat org-scheduled-string " "
11522 org-last-inserted-timestamp)
11523 (save-excursion
11524 (outline-next-heading) (point)) t)
11525 (goto-char (1- (match-end 0)))
11526 (insert " " repeater)
11527 (setq org-last-inserted-timestamp
11528 (concat (substring org-last-inserted-timestamp 0 -1)
11529 " " repeater
11530 (substring org-last-inserted-timestamp -1))))))
11531 (message "Scheduled to %s" org-last-inserted-timestamp))))
11533 (defun org-get-scheduled-time (pom &optional inherit)
11534 "Get the scheduled time as a time tuple, of a format suitable
11535 for calling org-schedule with, or if there is no scheduling,
11536 returns nil."
11537 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11538 (when time
11539 (apply 'encode-time (org-parse-time-string time)))))
11541 (defun org-get-deadline-time (pom &optional inherit)
11542 "Get the deadline as a time tuple, of a format suitable for
11543 calling org-deadline with, or if there is no scheduling, returns
11544 nil."
11545 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11546 (when time
11547 (apply 'encode-time (org-parse-time-string time)))))
11549 (defun org-remove-timestamp-with-keyword (keyword)
11550 "Remove all time stamps with KEYWORD in the current entry."
11552 beg)
11553 (save-excursion
11554 (org-back-to-heading t)
11555 (setq beg (point))
11556 (outline-next-heading)
11557 (while (re-search-backward re beg t)
11558 (replace-match "")
11560 (equal (char-before) ?\ ))
11561 (backward-delete-char 1)
11563 (point-at-bol) (point-at-eol)))
11564 (delete-region (point-at-bol)
11565 (min (point-max) (1+ (point-at-eol))))))))))
11567 (defun org-add-planning-info (what &optional time &rest remove)
11568 "Insert new timestamp with keyword in the line directly after the headline.
11569 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11570 If non is given, the user is prompted for a date.
11571 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11572 be removed."
11573 (interactive)
11574 (let (org-time-was-given org-end-time-was-given ts
11575 end default-time default-input)
11577 (catch 'exit
11578 (when (and (not time) (memq what '(scheduled deadline)))
11579 ;; Try to get a default date/time from existing timestamp
11580 (save-excursion
11581 (org-back-to-heading t)
11582 (setq end (save-excursion (outline-next-heading) (point)))
11583 (when (re-search-forward (if (eq what 'scheduled)
11584 org-scheduled-time-regexp
11585 org-deadline-time-regexp)
11586 end t)
11587 (setq ts (match-string 1)
11588 default-time
11589 (apply 'encode-time (org-parse-time-string ts))
11590 default-input (and ts (org-get-compact-tod ts))))))
11591 (when what
11592 ;; If necessary, get the time from the user
11593 (setq time (or time (org-read-date nil 'to-time nil nil
11594 default-time default-input))))
11596 (when (and org-insert-labeled-timestamps-at-point
11597 (member what '(scheduled deadline)))
11598 (insert
11599 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11600 (org-insert-time-stamp time org-time-was-given
11601 nil nil nil (list org-end-time-was-given))
11602 (setq what nil))
11603 (save-excursion
11604 (save-restriction
11605 (let (col list elt ts buffer-invisibility-spec)
11606 (org-back-to-heading t)
11608 (goto-char (match-end 1))
11609 (setq col (current-column))
11610 (goto-char (match-end 0))
11612 (when (and (not what)
11613 (not (looking-at
11615 org-keyword-time-not-clock-regexp))))
11616 ;; Nothing to add, nothing to remove...... :-)
11617 (throw 'exit nil))
11618 (if (and (not (looking-at outline-regexp))
11621 (not (equal (match-string 1) org-clock-string)))
11622 (narrow-to-region (match-beginning 0) (match-end 0))
11624 (backward-char 1)
11625 (narrow-to-region (point) (point))
11626 (and org-adapt-indentation (org-indent-to-column col)))
11627 ;; Check if we have to remove something.
11628 (setq list (cons what remove))
11629 (while list
11630 (setq elt (pop list))
11631 (goto-char (point-min))
11632 (when (or (and (eq elt 'scheduled)
11633 (re-search-forward org-scheduled-time-regexp nil t))
11634 (and (eq elt 'deadline)
11635 (re-search-forward org-deadline-time-regexp nil t))
11636 (and (eq elt 'closed)
11637 (re-search-forward org-closed-time-regexp nil t)))
11638 (replace-match "")
11639 (if (looking-at "--+<[^>]+>") (replace-match ""))
11640 (skip-chars-backward " ")
11641 (if (looking-at " +") (replace-match ""))))
11642 (goto-char (point-max))
11643 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11644 (when what
11645 (insert
11646 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11647 (cond ((eq what 'scheduled) org-scheduled-string)
11648 ((eq what 'deadline) org-deadline-string)
11649 ((eq what 'closed) org-closed-string))
11650 " ")
11651 (setq ts (org-insert-time-stamp
11652 time
11653 (or org-time-was-given
11654 (and (eq what 'closed) org-log-done-with-time))
11655 (eq what 'closed)
11656 nil nil (list org-end-time-was-given)))
11657 (end-of-line 1))
11658 (goto-char (point-min))
11659 (widen)
11662 (delete-region (1- (point)) (point-at-eol)))
11663 ts))))))
11665 (defvar org-log-note-marker (make-marker))
11666 (defvar org-log-note-purpose nil)
11667 (defvar org-log-note-state nil)
11668 (defvar org-log-note-previous-state nil)
11669 (defvar org-log-note-how nil)
11670 (defvar org-log-note-extra nil)
11671 (defvar org-log-note-window-configuration nil)
11672 (defvar org-log-note-return-to (make-marker))
11673 (defvar org-log-post-message nil
11674 "Message to be displayed after a log note has been stored.
11675 The auto-repeater uses this.")
11677 (defun org-add-note ()
11678 "Add a note to the current entry.
11679 This is done in the same way as adding a state change note."
11680 (interactive)
11681 (org-add-log-setup 'note nil nil 'findpos nil))
11683 (defvar org-property-end-re)
11684 (defun org-add-log-setup (&optional purpose state prev-state
11685 findpos how extra)
11686 "Set up the post command hook to take a note.
11687 If this is about to TODO state change, the new state is expected in STATE.
11688 When FINDPOS is non-nil, find the correct position for the note in
11689 the current entry. If not, assume that it can be inserted at point.
11690 HOW is an indicator what kind of note should be created.
11691 EXTRA is additional text that will be inserted into the notes buffer."
11692 (let* ((org-log-into-drawer (org-log-into-drawer))
11693 (drawer (cond ((stringp org-log-into-drawer)
11694 org-log-into-drawer)
11695 (org-log-into-drawer "LOGBOOK")
11696 (t nil))))
11697 (save-restriction
11698 (save-excursion
11699 (when findpos
11700 (org-back-to-heading t)
11701 (narrow-to-region (point) (save-excursion
11702 (outline-next-heading) (point)))
11706 (goto-char (match-end 0))
11707 (cond
11708 (drawer
11710 nil t)
11711 (progn
11712 (goto-char (match-end 0))
11713 (or org-log-states-order-reversed
11714 (and (re-search-forward org-property-end-re nil t)
11715 (goto-char (1- (match-beginning 0))))))
11717 (beginning-of-line 0)
11718 (org-indent-line-function)
11719 (beginning-of-line 2)
11720 (org-indent-line-function)
11721 (end-of-line 0)))
11722 ((and org-log-state-notes-insert-after-drawers
11723 (save-excursion
11724 (forward-line) (looking-at org-drawer-regexp)))
11725 (forward-line)
11726 (while (looking-at org-drawer-regexp)
11727 (goto-char (match-end 0))
11728 (re-search-forward org-property-end-re (point-max) t)
11729 (forward-line))
11730 (forward-line -1)))
11731 (unless org-log-states-order-reversed
11733 (org-skip-over-state-notes)
11735 (move-marker org-log-note-marker (point))
11736 (setq org-log-note-purpose purpose
11737 org-log-note-state state
11738 org-log-note-previous-state prev-state
11739 org-log-note-how how
11740 org-log-note-extra extra)
11741 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11743 (defun org-skip-over-state-notes ()
11744 "Skip past the list of State notes in an entry."
11746 (when (org-in-item-p)
11747 (let ((limit (org-list-bottom-point)))
11749 (goto-char (or (org-get-next-item (point) limit)
11750 (org-get-end-of-item limit)))))))
11752 (defun org-add-log-note (&optional purpose)
11753 "Pop up a window for taking a note, and add this note later at point."
11754 (remove-hook 'post-command-hook 'org-add-log-note)
11755 (setq org-log-note-window-configuration (current-window-configuration))
11756 (delete-other-windows)
11757 (move-marker org-log-note-return-to (point))
11758 (switch-to-buffer (marker-buffer org-log-note-marker))
11759 (goto-char org-log-note-marker)
11760 (org-switch-to-buffer-other-window "*Org Note*")
11761 (erase-buffer)
11762 (if (memq org-log-note-how '(time state))
11763 (let (current-prefix-arg) (org-store-log-note))
11764 (let ((org-inhibit-startup t)) (org-mode))
11765 (insert (format "# Insert note for %s.
11767 (cond
11768 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11769 ((eq org-log-note-purpose 'done) "closed todo item")
11770 ((eq org-log-note-purpose 'state)
11772 (or org-log-note-previous-state "")
11773 (or org-log-note-state "")))
11774 ((eq org-log-note-purpose 'reschedule)
11775 "rescheduling")
11776 ((eq org-log-note-purpose 'delschedule)
11777 "no longer scheduled")
11778 ((eq org-log-note-purpose 'redeadline)
11779 "changing deadline")
11780 ((eq org-log-note-purpose 'deldeadline)
11781 "removing deadline")
11782 ((eq org-log-note-purpose 'refile)
11783 "refiling")
11784 ((eq org-log-note-purpose 'note)
11785 "this entry")
11786 (t (error "This should not happen")))))
11787 (if org-log-note-extra (insert org-log-note-extra))
11788 (org-set-local 'org-finish-function 'org-store-log-note)))
11790 (defvar org-note-abort nil) ; dynamically scoped
11791 (defun org-store-log-note ()
11792 "Finish taking a log note, and insert it to where it belongs."
11793 (let ((txt (buffer-string))
11794 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11795 lines ind bul)
11796 (kill-buffer (current-buffer))
11798 (setq txt (replace-match "" t t txt)))
11800 (setq txt (replace-match "" t t txt)))
11803 (setq note
11804 (org-replace-escapes
11805 note
11806 (list (cons "%u" (user-login-name))
11807 (cons "%U" user-full-name)
11808 (cons "%t" (format-time-string
11809 (org-time-stamp-format 'long 'inactive)
11810 (current-time)))
11811 (cons "%T" (format-time-string
11812 (org-time-stamp-format 'long nil)
11813 (current-time)))
11814 (cons "%s" (if org-log-note-state
11816 ""))
11817 (cons "%S" (if org-log-note-previous-state
11821 (push note lines))
11822 (when (or current-prefix-arg org-note-abort)
11823 (when org-log-into-drawer
11824 (org-remove-empty-drawer-at
11825 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11826 org-log-note-marker))
11827 (setq lines nil))
11828 (when lines
11829 (with-current-buffer (marker-buffer org-log-note-marker)
11830 (save-excursion
11831 (goto-char org-log-note-marker)
11832 (move-marker org-log-note-marker nil)
11833 (end-of-line 1)
11835 (setq ind (save-excursion
11836 (if (org-in-item-p)
11837 (progn
11838 (goto-char (org-list-top-point))
11839 (org-get-indentation))
11841 (cond
11842 ((and (org-at-heading-p)
11843 org-adapt-indentation)
11844 (1+ (org-current-level)))
11845 ((org-at-heading-p) 0)
11846 (t (org-get-indentation))))))
11847 (setq bul (org-list-bullet-string "-"))
11848 (org-indent-line-to ind)
11849 (insert bul (pop lines))
11850 (let ((ind-body (+ (length bul) ind)))
11851 (while lines
11853 (org-indent-line-to ind-body)
11854 (insert (pop lines))))
11855 (message "Note stored")
11856 (org-back-to-heading t)
11857 (org-cycle-hide-drawers 'children)))))
11858 (set-window-configuration org-log-note-window-configuration)
11859 (with-current-buffer (marker-buffer org-log-note-return-to)
11860 (goto-char org-log-note-return-to))
11861 (move-marker org-log-note-return-to nil)
11862 (and org-log-post-message (message "%s" org-log-post-message)))
11864 (defun org-remove-empty-drawer-at (drawer pos)
11865 "Remove an empty drawer DRAWER at position POS.
11866 POS may also be a marker."
11867 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
11868 (save-excursion
11869 (save-restriction
11870 (widen)
11871 (goto-char pos)
11872 (if (org-in-regexp
11874 (replace-match ""))))))
11876 (defun org-sparse-tree (&optional arg)
11877 "Create a sparse tree, prompt for the details.
11878 This command can create sparse trees. You first need to select the type
11879 of match used to create the tree:
11881 t Show all TODO entries.
11882 T Show entries with a specific TODO keyword.
11883 m Show entries selected by a tags/property match.
11884 p Enter a property name and its value (both with completion on existing
11885 names/values) and show entries with that property.
11886 r Show entries matching a regular expression (`/' can be used as well)
11887 d Show deadlines due within `org-deadline-warning-days'.
11888 b Show deadlines and scheduled items before a date.
11889 a Show deadlines and scheduled items after a date."
11890 (interactive "P")
11891 (let (ans kwd value)
11892 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
11893 (setq ans (read-char-exclusive))
11894 (cond
11895 ((equal ans ?d)
11896 (call-interactively 'org-check-deadlines))
11897 ((equal ans ?b)
11898 (call-interactively 'org-check-before-date))
11899 ((equal ans ?a)
11900 (call-interactively 'org-check-after-date))
11901 ((equal ans ?t)
11902 (org-show-todo-tree nil))
11903 ((equal ans ?T)
11904 (org-show-todo-tree '(4)))
11905 ((member ans '(?T ?m))
11906 (call-interactively 'org-match-sparse-tree))
11907 ((member ans '(?p ?P))
11908 (setq kwd (org-icompleting-read "Property: "
11909 (mapcar 'list (org-buffer-property-keys))))
11910 (setq value (org-icompleting-read "Value: "
11911 (mapcar 'list (org-property-values kwd))))
11914 (org-match-sparse-tree arg (concat kwd "=" value)))
11915 ((member ans '(?r ?R ?/))
11916 (call-interactively 'org-occur))
11919 (defvar org-occur-highlights nil
11920 "List of overlays used for occur matches.")
11921 (make-variable-buffer-local 'org-occur-highlights)
11922 (defvar org-occur-parameters nil
11923 "Parameters of the active org-occur calls.
11924 This is a list, each call to org-occur pushes as cons cell,
11925 containing the regular expression and the callback, onto the list.
11926 The list can contain several entries if `org-occur' has been called
11927 several time with the KEEP-PREVIOUS argument. Otherwise, this list
11928 will only contain one set of parameters. When the highlights are
11929 removed (for example with `C-c C-c', or with the next edit (depending
11930 on `org-remove-highlights-with-change'), this variable is emptied
11931 as well.")
11932 (make-variable-buffer-local 'org-occur-parameters)
11934 (defun org-occur (regexp &optional keep-previous callback)
11935 "Make a compact tree which shows all matches of REGEXP.
11936 The tree will show the lines where the regexp matches, and all higher
11937 headlines above the match. It will also show the heading after the match,
11938 to make sure editing the matching entry is easy.
11939 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
11940 call to `org-occur' will be kept, to allow stacking of calls to this
11941 command.
11942 If CALLBACK is non-nil, it is a function which is called to confirm
11943 that the match should indeed be shown."
11945 (when (equal regexp "")
11946 (error "Regexp cannot be empty"))
11947 (unless keep-previous
11948 (org-remove-occur-highlights nil nil t))
11949 (push (cons regexp callback) org-occur-parameters)
11950 (let ((cnt 0))
11951 (save-excursion
11952 (goto-char (point-min))
11953 (if (or (not keep-previous) ; do not want to keep
11954 (not org-occur-highlights)) ; no previous matches
11955 ;; hide everything
11956 (org-overview))
11957 (while (re-search-forward regexp nil t)
11958 (when (or (not callback)
11959 (save-match-data (funcall callback)))
11960 (setq cnt (1+ cnt))
11961 (when org-highlight-sparse-tree-matches
11962 (org-highlight-new-match (match-beginning 0) (match-end 0)))
11963 (org-show-context 'occur-tree))))
11964 (when org-remove-highlights-with-change
11965 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
11966 nil 'local))
11967 (unless org-sparse-tree-open-archived-trees
11968 (org-hide-archived-subtrees (point-min) (point-max)))
11969 (run-hooks 'org-occur-hook)
11970 (if (interactive-p)
11971 (message "%d match(es) for regexp %s" cnt regexp))
11972 cnt))
11974 (defun org-show-context (&optional key)
11975 "Make sure point and context are visible.
11976 How much context is shown depends upon the variables
11977 `org-show-hierarchy-above', `org-show-following-heading'. and
11978 `org-show-siblings'."
11979 (let ((heading-p (org-on-heading-p t))
11980 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
11981 (following-p (org-get-alist-option org-show-following-heading key))
11982 (entry-p (org-get-alist-option org-show-entry-below key))
11983 (siblings-p (org-get-alist-option org-show-siblings key)))
11984 (catch 'exit
11985 ;; Show heading or entry text
11986 (if (and heading-p (not entry-p))
11987 (org-flag-heading nil) ; only show the heading
11988 (and (or entry-p (org-invisible-p) (org-invisible-p2))
11989 (org-show-hidden-entry))) ; show entire entry
11990 (when following-p
11991 ;; Show next sibling, or heading below text
11992 (save-excursion
11993 (and (if heading-p (org-goto-sibling) (outline-next-heading))
11994 (org-flag-heading nil))))
11995 (when siblings-p (org-show-siblings))
11996 (when hierarchy-p
11997 ;; show all higher headings, possibly with siblings
11998 (save-excursion
11999 (while (and (condition-case nil
12000 (progn (org-up-heading-all 1) t)
12001 (error nil))
12002 (not (bobp)))
12003 (org-flag-heading nil)
12004 (when siblings-p (org-show-siblings))))))))
12006 (defvar org-reveal-start-hook nil
12007 "Hook run before revealing a location.")
12009 (defun org-reveal (&optional siblings)
12010 "Show current entry, hierarchy above it, and the following headline.
12011 This can be used to show a consistent set of context around locations
12012 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12013 not t for the search context.
12015 With optional argument SIBLINGS, on each level of the hierarchy all
12016 siblings are shown. This repairs the tree structure to what it would
12017 look like when opened with hierarchical calls to `org-cycle'.
12019 go to the parent and show the
12020 entire tree."
12021 (interactive "P")
12022 (run-hooks 'org-reveal-start-hook)
12023 (let ((org-show-hierarchy-above t)
12024 (org-show-following-heading t)
12025 (org-show-siblings (if siblings t org-show-siblings)))
12026 (org-show-context nil))
12027 (when (equal siblings '(16))
12028 (save-excursion
12029 (when (org-up-heading-safe)
12030 (org-show-subtree)
12031 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12033 (defun org-highlight-new-match (beg end)
12034 "Highlight from BEG to END and mark the highlight is an occur headline."
12035 (let ((ov (make-overlay beg end)))
12036 (overlay-put ov 'face 'secondary-selection)
12037 (push ov org-occur-highlights)))
12039 (defun org-remove-occur-highlights (&optional beg end noremove)
12040 "Remove the occur highlights from the buffer.
12041 BEG and END are ignored. If NOREMOVE is nil, remove this function
12042 from the `before-change-functions' in the current buffer."
12043 (interactive)
12044 (unless org-inhibit-highlight-removal
12045 (mapc 'delete-overlay org-occur-highlights)
12046 (setq org-occur-highlights nil)
12047 (setq org-occur-parameters nil)
12048 (unless noremove
12049 (remove-hook 'before-change-functions
12050 'org-remove-occur-highlights 'local))))
12052 ;;;; Priorities
12055 "Regular expression matching the priority indicator.")
12057 (defvar org-remove-priority-next-time nil)
12059 (defun org-priority-up ()
12060 "Increase the priority of the current item."
12061 (interactive)
12062 (org-priority 'up))
12064 (defun org-priority-down ()
12065 "Decrease the priority of the current item."
12066 (interactive)
12067 (org-priority 'down))
12069 (defun org-priority (&optional action)
12070 "Change the priority of an item by ARG.
12071 ACTION can be `set', `up', `down', or a character."
12072 (interactive)
12073 (unless org-enable-priority-commands
12074 (error "Priority commands are disabled"))
12075 (setq action (or action 'set))
12076 (let (current new news have remove)
12077 (save-excursion
12078 (org-back-to-heading t)
12079 (if (looking-at org-priority-regexp)
12080 (setq current (string-to-char (match-string 2))
12081 have t)
12082 (setq current org-default-priority))
12083 (cond
12084 ((eq action 'remove)
12085 (setq remove t new ?\ ))
12086 ((or (eq action 'set)
12087 (if (featurep 'xemacs) (characterp action) (integerp action)))
12088 (if (not (eq action 'set))
12089 (setq new action)
12090 (message "Priority %c-%c, SPC to remove: "
12091 org-highest-priority org-lowest-priority)
12092 (save-match-data
12093 (setq new (read-char-exclusive))))
12094 (if (and (= (upcase org-highest-priority) org-highest-priority)
12095 (= (upcase org-lowest-priority) org-lowest-priority))
12096 (setq new (upcase new)))
12097 (cond ((equal new ?\ ) (setq remove t))
12098 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12099 (error "Priority must be between `%c' and `%c'"
12100 org-highest-priority org-lowest-priority))))
12101 ((eq action 'up)
12102 (if (and (not have) (eq last-command this-command))
12103 (setq new org-lowest-priority)
12104 (setq new (if (and org-priority-start-cycle-with-default (not have))
12105 org-default-priority (1- current)))))
12106 ((eq action 'down)
12107 (if (and (not have) (eq last-command this-command))
12108 (setq new org-highest-priority)
12109 (setq new (if (and org-priority-start-cycle-with-default (not have))
12110 org-default-priority (1+ current)))))
12111 (t (error "Invalid action")))
12112 (if (or (< (upcase new) org-highest-priority)
12113 (> (upcase new) org-lowest-priority))
12114 (setq remove t))
12115 (setq news (format "%c" new))
12116 (if have
12117 (if remove
12118 (replace-match "" t t nil 1)
12119 (replace-match news t t nil 2))
12120 (if remove
12121 (error "No priority cookie found in line")
12122 (let ((case-fold-search nil))
12123 (looking-at org-todo-line-regexp))
12124 (if (match-end 2)
12125 (progn
12126 (goto-char (match-end 2))
12127 (insert " [#" news "]"))
12128 (goto-char (match-beginning 3))
12129 (insert "[#" news "] "))))
12130 (org-preserve-lc (org-set-tags nil 'align)))
12131 (if remove
12132 (message "Priority removed")
12133 (message "Priority of current item set to %s" news))))
12135 (defun org-get-priority (s)
12136 "Find priority cookie and return priority."
12137 (if (functionp org-get-priority-function)
12138 (funcall org-get-priority-function)
12139 (save-match-data
12140 (if (not (string-match org-priority-regexp s))
12141 (* 1000 (- org-lowest-priority org-default-priority))
12142 (* 1000 (- org-lowest-priority
12143 (string-to-char (match-string 2 s))))))))
12145 ;;;; Tags
12147 (defvar org-agenda-archives-mode)
12148 (defvar org-map-continue-from nil
12149 "Position from where mapping should continue.
12150 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12152 (defvar org-scanner-tags nil
12153 "The current tag list while the tags scanner is running.")
12154 (defvar org-trust-scanner-tags nil
12155 "Should `org-get-tags-at' use the tags fro the scanner.
12156 This is for internal dynamical scoping only.
12157 When this is non-nil, the function `org-get-tags-at' will return the value
12158 of `org-scanner-tags' instead of building the list by itself. This
12159 can lead to large speed-ups when the tags scanner is used in a file with
12160 many entries, and when the list of tags is retrieved, for example to
12161 obtain a list of properties. Building the tags list for each entry in such
12162 a file becomes an N^2 operation - but with this variable set, it scales
12163 as N.")
12165 (defun org-scan-tags (action matcher &optional todo-only)
12166 "Scan headline tags with inheritance and produce output ACTION.
12168 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12169 or `agenda' to produce an entry list for an agenda view. It can also be
12170 a Lisp form or a function that should be called at each matched headline, in
12171 this case the return value is a list of all return values from these calls.
12173 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12174 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12175 only lines with a TODO keyword are included in the output."
12176 (require 'org-agenda)
12179 (org-re
12181 (props (list 'face 'default
12182 'done-face 'org-agenda-done
12183 'undone-face 'default
12184 'mouse-face 'highlight
12185 'org-not-done-regexp org-not-done-regexp
12186 'org-todo-regexp org-todo-regexp
12187 'help-echo
12188 (format "mouse-2 or RET jump to org file %s"
12189 (abbreviate-file-name
12190 (or (buffer-file-name (buffer-base-buffer))
12191 (buffer-name (buffer-base-buffer)))))))
12192 (case-fold-search nil)
12193 (org-map-continue-from nil)
12194 lspos tags tags-list
12195 (tags-alist (list (cons 0 org-file-tags)))
12196 (llast 0) rtn rtn1 level category i txt
12197 todo marker entry priority)
12198 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12199 (setq action (list 'lambda nil action)))
12200 (save-excursion
12201 (goto-char (point-min))
12202 (when (eq action 'sparse-tree)
12203 (org-overview)
12204 (org-remove-occur-highlights))
12205 (while (re-search-forward re nil t)
12206 (catch :skip
12207 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12208 tags (if (match-end 4) (org-match-string-no-properties 4)))
12209 (goto-char (setq lspos (match-beginning 0)))
12210 (setq level (org-reduced-level (funcall outline-level))
12211 category (org-get-category))
12212 (setq i llast llast level)
12213 ;; remove tag lists from same and sublevels
12214 (while (>= i level)
12215 (when (setq entry (assoc i tags-alist))
12216 (setq tags-alist (delete entry tags-alist)))
12217 (setq i (1- i)))
12218 ;; add the next tags
12219 (when tags
12220 (setq tags (org-split-string tags ":")
12221 tags-alist
12222 (cons (cons level tags) tags-alist)))
12223 ;; compile tags for current headline
12224 (setq tags-list
12225 (if org-use-tag-inheritance
12226 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12227 tags)
12228 org-scanner-tags tags-list)
12229 (when org-use-tag-inheritance
12230 (setcdr (car tags-alist)
12231 (mapcar (lambda (x)
12232 (setq x (copy-sequence x))
12233 (org-add-prop-inherited x))
12234 (cdar tags-alist))))
12235 (when (and tags org-use-tag-inheritance
12236 (or (not (eq t org-use-tag-inheritance))
12237 org-tags-exclude-from-inheritance))
12238 ;; selective inheritance, remove uninherited ones
12239 (setcdr (car tags-alist)
12240 (org-remove-uniherited-tags (cdar tags-alist))))
12241 (when (and (or (not todo-only)
12242 (and (member todo org-not-done-keywords)
12243 (or (not org-agenda-tags-todo-honor-ignore-options)
12244 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12245 (let ((case-fold-search t)) (eval matcher))
12246 (or
12247 (not (member org-archive-tag tags-list))
12248 ;; we have an archive tag, should we use this anyway?
12249 (or (not org-agenda-skip-archived-trees)
12250 (and (eq action 'agenda) org-agenda-archives-mode))))
12251 (unless (eq action 'sparse-tree) (org-agenda-skip))
12253 ;; select this headline
12255 (cond
12256 ((eq action 'sparse-tree)
12257 (and org-highlight-sparse-tree-matches
12258 (org-get-heading) (match-end 0)
12259 (org-highlight-new-match
12260 (match-beginning 0) (match-beginning 1)))
12261 (org-show-context 'tags-tree))
12262 ((eq action 'agenda)
12263 (setq txt (org-format-agenda-item
12264 ""
12265 (concat
12266 (if (eq org-tags-match-list-sublevels 'indented)
12267 (make-string (1- level) ?.) "")
12268 (org-get-heading))
12269 category
12270 tags-list
12271 )
12272 priority (org-get-priority txt))
12273 (goto-char lspos)
12274 (setq marker (org-agenda-new-marker))
12275 (org-add-props txt props
12276 'org-marker marker 'org-hd-marker marker 'org-category category
12277 'todo-state todo
12278 'priority priority 'type "tagsmatch")
12279 (push txt rtn))
12280 ((functionp action)
12281 (setq org-map-continue-from nil)
12282 (save-excursion
12283 (setq rtn1 (funcall action))
12284 (push rtn1 rtn)))
12285 (t (error "Invalid action")))
12287 ;; if we are to skip sublevels, jump to end of subtree
12288 (unless org-tags-match-list-sublevels
12289 (org-end-of-subtree t)
12290 (backward-char 1))))
12291 ;; Get the correct position from where to continue
12292 (if org-map-continue-from
12293 (goto-char org-map-continue-from)
12294 (and (= (point) lspos) (end-of-line 1)))))
12295 (when (and (eq action 'sparse-tree)
12296 (not org-sparse-tree-open-archived-trees))
12297 (org-hide-archived-subtrees (point-min) (point-max)))
12298 (nreverse rtn)))
12300 (defun org-remove-uniherited-tags (tags)
12301 "Remove all tags that are not inherited from the list TAGS."
12302 (cond
12303 ((eq org-use-tag-inheritance t)
12304 (if org-tags-exclude-from-inheritance
12305 (org-delete-all org-tags-exclude-from-inheritance tags)
12306 tags))
12307 ((not org-use-tag-inheritance) nil)
12308 ((stringp org-use-tag-inheritance)
12309 (delq nil (mapcar
12310 (lambda (x)
12311 (if (and (string-match org-use-tag-inheritance x)
12312 (not (member x org-tags-exclude-from-inheritance)))
12313 x nil))
12314 tags)))
12315 ((listp org-use-tag-inheritance)
12316 (delq nil (mapcar
12317 (lambda (x)
12318 (if (member x org-use-tag-inheritance) x nil))
12319 tags)))))
12321 (defvar todo-only) ;; dynamically scoped
12323 (defun org-match-sparse-tree (&optional todo-only match)
12324 "Create a sparse tree according to tags string MATCH.
12325 MATCH can contain positive and negative selection of tags, like
12327 If optional argument TODO-ONLY is non-nil, only select lines that are
12328 also TODO lines."
12329 (interactive "P")
12330 (org-prepare-agenda-buffers (list (current-buffer)))
12331 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12333 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12335 (defvar org-cached-props nil)
12336 (defun org-cached-entry-get (pom property)
12337 (if (or (eq t org-use-property-inheritance)
12338 (and (stringp org-use-property-inheritance)
12339 (string-match org-use-property-inheritance property))
12340 (and (listp org-use-property-inheritance)
12341 (member property org-use-property-inheritance)))
12342 ;; Caching is not possible, check it directly
12343 (org-entry-get pom property 'inherit)
12344 ;; Get all properties, so that we can do complicated checks easily
12345 (cdr (assoc property (or org-cached-props
12346 (setq org-cached-props
12347 (org-entry-properties pom)))))))
12349 (defun org-global-tags-completion-table (&optional files)
12350 "Return the list of all tags in all agenda buffer/files."
12351 (save-excursion
12352 (org-uniquify
12353 (delq nil
12354 (apply 'append
12355 (mapcar
12356 (lambda (file)
12357 (set-buffer (find-file-noselect file))
12358 (append (org-get-buffer-tags)
12359 (mapcar (lambda (x) (if (stringp (car-safe x))
12360 (list (car-safe x)) nil))
12361 org-tag-alist)))
12362 (if (and files (car files))
12363 files
12364 (org-agenda-files))))))))
12366 (defun org-make-tags-matcher (match)
12367 "Create the TAGS//TODO matcher form for the selection string MATCH."
12368 ;; todo-only is scoped dynamically into this function, and the function
12369 ;; may change it if the matcher asks for it.
12370 (unless match
12371 ;; Get a new match request, with completion
12372 (let ((org-last-tags-completion-table
12373 (org-global-tags-completion-table)))
12374 (setq match (org-completing-read-no-i
12375 "Match: " 'org-tags-completion-function nil nil nil
12376 'org-tags-history))))
12378 ;; Parse the string and create a lisp form
12379 (let ((match0 match)
12380 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12381 minus tag mm
12382 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12383 orterms term orlist re-p str-p level-p level-op time-p
12384 prop-p pn pv po cat-p gv rest)
12385 (if (string-match "/+" match)
12386 ;; match contains also a todo-matching request
12387 (progn
12388 (setq tagsmatch (substring match 0 (match-beginning 0))
12389 todomatch (substring match (match-end 0)))
12390 (if (string-match "^!" todomatch)
12391 (setq todo-only t todomatch (substring todomatch 1)))
12393 (setq todomatch nil)))
12394 ;; only matching tags
12395 (setq tagsmatch match todomatch nil))
12397 ;; Make the tags matcher
12399 (setq tagsmatcher t)
12400 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12401 (while (setq term (pop orterms))
12403 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12404 (while (string-match re term)
12405 (setq rest (substring term (match-end 0))
12406 minus (and (match-end 1)
12407 (equal (match-string 1 term) "-"))
12408 tag (save-match-data (replace-regexp-in-string
12410 (match-string 2 term)))
12411 re-p (equal (string-to-char tag) ?{)
12412 level-p (match-end 4)
12413 prop-p (match-end 5)
12414 mm (cond
12415 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12416 (level-p
12417 (setq level-op (org-op-to-function (match-string 3 term)))
12418 `(,level-op level ,(string-to-number
12419 (match-string 4 term))))
12420 (prop-p
12421 (setq pn (match-string 5 term)
12422 po (match-string 6 term)
12423 pv (match-string 7 term)
12424 cat-p (equal pn "CATEGORY")
12425 re-p (equal (string-to-char pv) ?{)
12427 time-p (save-match-data
12429 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12430 (if time-p (setq pv (org-matcher-time pv)))
12431 (setq po (org-op-to-function po (if time-p 'time str-p)))
12432 (cond
12433 ((equal pn "CATEGORY")
12434 (setq gv '(get-text-property (point) 'org-category)))
12435 ((equal pn "TODO")
12436 (setq gv 'todo))
12437 (t
12438 (setq gv `(org-cached-entry-get nil ,pn))))
12439 (if re-p
12440 (if (eq po 'org<>)
12441 `(not (string-match ,pv (or ,gv "")))
12442 `(string-match ,pv (or ,gv "")))
12443 (if str-p
12444 `(,po (or ,gv "") ,pv)
12445 `(,po (string-to-number (or ,gv ""))
12446 ,(string-to-number pv) ))))
12447 (t `(member ,tag tags-list)))
12448 mm (if minus (list 'not mm) mm)
12449 term rest)
12450 (push mm tagsmatcher))
12451 (push (if (> (length tagsmatcher) 1)
12452 (cons 'and tagsmatcher)
12453 (car tagsmatcher))
12454 orlist)
12455 (setq tagsmatcher nil))
12456 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12457 (setq tagsmatcher
12458 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12459 ;; Make the todo matcher
12461 (setq todomatcher t)
12462 (setq orterms (org-split-string todomatch "|") orlist nil)
12463 (while (setq term (pop orterms))
12464 (while (string-match re term)
12465 (setq minus (and (match-end 1)
12466 (equal (match-string 1 term) "-"))
12467 kwd (match-string 2 term)
12468 re-p (equal (string-to-char kwd) ?{)
12469 term (substring term (match-end 0))
12470 mm (if re-p
12471 `(string-match ,(substring kwd 1 -1) todo)
12472 (list 'equal 'todo kwd))
12473 mm (if minus (list 'not mm) mm))
12474 (push mm todomatcher))
12475 (push (if (> (length todomatcher) 1)
12476 (cons 'and todomatcher)
12477 (car todomatcher))
12478 orlist)
12479 (setq todomatcher nil))
12480 (setq todomatcher (if (> (length orlist) 1)
12481 (cons 'or orlist) (car orlist))))
12483 ;; Return the string and lisp forms of the matcher
12484 (setq matcher (if todomatcher
12485 (list 'and tagsmatcher todomatcher)
12486 tagsmatcher))
12487 (cons match0 matcher)))
12489 (defun org-op-to-function (op &optional stringp)
12490 "Turn an operator into the appropriate function."
12491 (setq op
12492 (cond
12493 ((equal op "<" ) '(< string< org-time<))
12494 ((equal op ">" ) '(> org-string> org-time>))
12495 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12496 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12497 ((member op '("=" "==")) '(= string= org-time=))
12498 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12499 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12501 (defun org<> (a b) (not (= a b)))
12502 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12503 (defun org-string>= (a b) (not (string< a b)))
12504 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12505 (defun org-string<> (a b) (not (string= a b)))
12506 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12507 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12508 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12509 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12510 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12511 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12512 (defun org-2ft (s)
12513 "Convert S to a floating point time.
12514 If S is already a number, just return it. If it is a string, parse
12515 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12516 (cond
12517 ((numberp s) s)
12518 ((stringp s)
12519 (condition-case nil
12520 (float-time (apply 'encode-time (org-parse-time-string s)))
12521 (error 0.)))
12522 (t 0.)))
12524 (defun org-time-today ()
12525 "Time in seconds today at 0:00.
12526 Returns the float number of seconds since the beginning of the
12527 epoch to the beginning of today (00:00)."
12528 (float-time (apply 'encode-time
12529 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12531 (defun org-matcher-time (s)
12532 "Interpret a time comparison value."
12533 (save-match-data
12534 (cond
12535 ((string= s "<now>") (float-time))
12536 ((string= s "<today>") (org-time-today))
12537 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12538 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12540 (+ (org-time-today)
12541 (* (string-to-number (match-string 1 s))
12542 (cdr (assoc (match-string 2 s)
12543 '(("d" . 86400.0) ("w" . 604800.0)
12544 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12545 (t (org-2ft s)))))
12547 (defun org-match-any-p (re list)
12548 "Does re match any element of list?"
12549 (setq list (mapcar (lambda (x) (string-match re x)) list))
12550 (delq nil list))
12552 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12553 (defvar org-tags-overlay (make-overlay 1 1))
12554 (org-detach-overlay org-tags-overlay)
12556 (defun org-get-local-tags-at (&optional pos)
12557 "Get a list of tags defined in the current headline."
12558 (org-get-tags-at pos 'local))
12560 (defun org-get-local-tags ()
12561 "Get a list of tags defined in the current headline."
12562 (org-get-tags-at nil 'local))
12564 (defun org-get-tags-at (&optional pos local)
12565 "Get a list of all headline tags applicable at POS.
12566 POS defaults to point. If tags are inherited, the list contains
12567 the targets in the same sequence as the headlines appear, i.e.
12568 the tags of the current headline come last.
12569 When LOCAL is non-nil, only return tags from the current headline,
12570 ignore inherited ones."
12571 (interactive)
12572 (if (and org-trust-scanner-tags
12573 (or (not pos) (equal pos (point)))
12574 (not local))
12575 org-scanner-tags
12576 (let (tags ltags lastpos parent)
12577 (save-excursion
12578 (save-restriction
12579 (widen)
12580 (goto-char (or pos (point)))
12581 (save-match-data
12582 (catch 'done
12583 (condition-case nil
12584 (progn
12585 (org-back-to-heading t)
12586 (while (not (equal lastpos (point)))
12587 (setq lastpos (point))
12588 (when (looking-at
12590 (setq ltags (org-split-string
12591 (org-match-string-no-properties 1) ":"))
12592 (when parent
12593 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12594 (setq tags (append
12595 (if parent
12596 (org-remove-uniherited-tags ltags)
12597 ltags)
12598 tags)))
12599 (or org-use-tag-inheritance (throw 'done t))
12600 (if local (throw 'done t))
12601 (or (org-up-heading-safe) (error nil))
12602 (setq parent t)))
12603 (error nil)))))
12604 (append (org-remove-uniherited-tags org-file-tags) tags)))))
12606 (defun org-add-prop-inherited (s)
12607 (add-text-properties 0 (length s) '(inherited t) s)
12608 s)
12610 (defun org-toggle-tag (tag &optional onoff)
12611 "Toggle the tag TAG for the current line.
12612 If ONOFF is `on' or `off', don't toggle but set to this state."
12613 (let (res current)
12614 (save-excursion
12615 (org-back-to-heading t)
12617 (point-at-eol) t)
12618 (progn
12619 (setq current (match-string 1))
12620 (replace-match ""))
12621 (setq current ""))
12622 (setq current (nreverse (org-split-string current ":")))
12623 (cond
12624 ((eq onoff 'on)
12625 (setq res t)
12626 (or (member tag current) (push tag current)))
12627 ((eq onoff 'off)
12628 (or (not (member tag current)) (setq current (delete tag current))))
12629 (t (if (member tag current)
12630 (setq current (delete tag current))
12631 (setq res t)
12632 (push tag current))))
12633 (end-of-line 1)
12634 (if current
12635 (progn
12636 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12637 (org-set-tags nil t))
12638 (delete-horizontal-space))
12639 (run-hooks 'org-after-tags-change-hook))
12640 res))
12642 (defun org-align-tags-here (to-col)
12643 ;; Assumes that this is a headline
12644 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12645 (beginning-of-line 1)
12647 (< pos (match-beginning 2)))
12648 (progn
12649 (setq tags-l (- (match-end 2) (match-beginning 2)))
12650 (goto-char (match-beginning 1))
12651 (insert " ")
12652 (delete-region (point) (1+ (match-beginning 2)))
12653 (setq ncol (max (1+ (current-column))
12654 (1+ col)
12655 (if (> to-col 0)
12656 to-col
12657 (- (abs to-col) tags-l))))
12658 (setq p (point))
12659 (insert (make-string (- ncol (current-column)) ?\ ))
12660 (setq ncol (current-column))
12661 (when indent-tabs-mode (tabify p (point-at-eol)))
12662 (org-move-to-column (min ncol col) t))
12663 (goto-char pos))))
12665 (defun org-set-tags-command (&optional arg just-align)
12666 "Call the set-tags command for the current entry."
12667 (interactive "P")
12668 (if (org-on-heading-p)
12669 (org-set-tags arg just-align)
12670 (save-excursion
12671 (org-back-to-heading t)
12672 (org-set-tags arg just-align))))
12674 (defun org-set-tags-to (data)
12675 "Set the tags of the current entry to DATA, replacing the current tags.
12676 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12677 If DATA is nil or the empty string, any tags will be removed."
12678 (interactive "sTags: ")
12679 (setq data
12680 (cond
12681 ((eq data nil) "")
12682 ((equal data "") "")
12683 ((stringp data)
12684 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12685 ":"))
12686 ((listp data)
12687 (concat ":" (mapconcat 'identity data ":") ":"))
12688 (t nil)))
12689 (when data
12690 (save-excursion
12691 (org-back-to-heading t)
12692 (when (looking-at org-complex-heading-regexp)
12693 (if (match-end 5)
12694 (progn
12695 (goto-char (match-beginning 5))
12696 (insert data)
12697 (delete-region (point) (point-at-eol))
12698 (org-set-tags nil 'align))
12699 (goto-char (point-at-eol))
12700 (insert " " data)
12701 (org-set-tags nil 'align)))
12702 (beginning-of-line 1)
12704 (delete-region (match-beginning 1) (match-end 1))))))
12706 (defun org-align-all-tags ()
12707 "Align the tags i all headings."
12708 (interactive)
12709 (save-excursion
12710 (or (ignore-errors (org-back-to-heading t))
12711 (outline-next-heading))
12712 (if (org-on-heading-p)
12713 (org-set-tags t)
12714 (message "No headings"))))
12716 (defvar org-indent-indentation-per-level)
12717 (defun org-set-tags (&optional arg just-align)
12718 "Set the tags for the current headline.
12719 With prefix ARG, realign all tags in headings in the current buffer."
12720 (interactive "P")
12721 (let* ((re (concat "^" outline-regexp))
12722 (current (org-get-tags-string))
12723 (col (current-column))
12724 (org-setting-tags t)
12725 table current-tags inherited-tags ; computed below when needed
12726 tags p0 c0 c1 rpl di tc level)
12727 (if arg
12728 (save-excursion
12729 (goto-char (point-min))
12730 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12731 (while (re-search-forward re nil t)
12732 (org-set-tags nil t)
12733 (end-of-line 1)))
12734 (message "All tags realigned to column %d" org-tags-column))
12735 (if just-align
12736 (setq tags current)
12737 ;; Get a new set of tags from the user
12738 (save-excursion
12739 (setq table (append org-tag-persistent-alist
12740 (or org-tag-alist (org-get-buffer-tags))
12741 (and
12742 org-complete-tags-always-offer-all-agenda-tags
12743 (org-global-tags-completion-table
12744 (org-agenda-files))))
12745 org-last-tags-completion-table table
12746 current-tags (org-split-string current ":")
12747 inherited-tags (nreverse
12748 (nthcdr (length current-tags)
12749 (nreverse (org-get-tags-at))))
12750 tags
12751 (if (or (eq t org-use-fast-tag-selection)
12752 (and org-use-fast-tag-selection
12753 (delq nil (mapcar 'cdr table))))
12754 (org-fast-tag-selection
12755 current-tags inherited-tags table
12756 (if org-fast-tag-selection-include-todo
12757 org-todo-key-alist))
12758 (let ((org-add-colon-after-tag-completion t))
12759 (org-trim
12760 (org-without-partial-completion
12761 (org-icompleting-read "Tags: "
12762 'org-tags-completion-function
12763 nil nil current 'org-tags-history)))))))
12764 (while (string-match "[-+&]+" tags)
12765 ;; No boolean logic, just a list
12766 (setq tags (replace-match ":" t t tags))))
12768 (setq tags (replace-regexp-in-string "[ ,]" ":" tags))
12770 (if org-tags-sort-function
12771 (setq tags (mapconcat 'identity
12772 (sort (org-split-string
12773 tags (org-re "[^[:alnum:]_@#%]+"))
12774 org-tags-sort-function) ":")))
12777 (setq tags "")
12778 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12779 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12781 ;; Insert new tags at the correct column
12782 (beginning-of-line 1)
12783 (setq level (or (and (looking-at org-outline-regexp)
12784 (- (match-end 0) (point) 1))
12785 1))
12786 (cond
12787 ((and (equal current "") (equal tags "")))
12788 ((re-search-forward
12790 (point-at-eol) t)
12791 (if (equal tags "")
12792 (setq rpl "")
12793 (goto-char (match-beginning 0))
12794 (setq c0 (current-column)
12795 ;; compute offset for the case of org-indent-mode active
12796 di (if org-indent-mode
12797 (* (1- org-indent-indentation-per-level) (1- level))
12798 0)
12799 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
12800 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
12801 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
12802 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12803 (replace-match rpl t t)
12804 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
12805 tags)
12806 (t (error "Tags alignment failed")))
12807 (org-move-to-column col)
12808 (unless just-align
12809 (run-hooks 'org-after-tags-change-hook)))))
12811 (defun org-change-tag-in-region (beg end tag off)
12812 "Add or remove TAG for each entry in the region.
12813 This works in the agenda, and also in an org-mode buffer."
12814 (interactive
12815 (list (region-beginning) (region-end)
12816 (let ((org-last-tags-completion-table
12817 (if (org-mode-p)
12818 (org-get-buffer-tags)
12819 (org-global-tags-completion-table))))
12820 (org-icompleting-read
12821 "Tag: " 'org-tags-completion-function nil nil nil
12822 'org-tags-history))
12823 (progn
12825 (equal (read-char-exclusive) ?r))))
12826 (if (fboundp 'deactivate-mark) (deactivate-mark))
12827 (let ((agendap (equal major-mode 'org-agenda-mode))
12828 l1 l2 m buf pos newhead (cnt 0))
12829 (goto-char end)
12830 (setq l2 (1- (org-current-line)))
12831 (goto-char beg)
12832 (setq l1 (org-current-line))
12833 (loop for l from l1 to l2 do
12834 (org-goto-line l)
12835 (setq m (get-text-property (point) 'org-hd-marker))
12836 (when (or (and (org-mode-p) (org-on-heading-p))
12837 (and agendap m))
12838 (setq buf (if agendap (marker-buffer m) (current-buffer))
12839 pos (if agendap m (point)))
12840 (with-current-buffer buf
12841 (save-excursion
12842 (save-restriction
12843 (goto-char pos)
12844 (setq cnt (1+ cnt))
12845 (org-toggle-tag tag (if off 'off 'on))
12846 (setq newhead (org-get-heading)))))
12847 (and agendap (org-agenda-change-all-lines newhead m))))
12848 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
12850 (defun org-tags-completion-function (string predicate &optional flag)
12851 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12852 (confirm (lambda (x) (stringp (car x)))))
12854 (setq s1 (match-string 1 string)
12855 s2 (match-string 2 string))
12856 (setq s1 "" s2 string))
12857 (cond
12858 ((eq flag nil)
12859 ;; try completion
12860 (setq rtn (try-completion s2 ctable confirm))
12861 (if (stringp rtn)
12862 (setq rtn
12863 (concat s1 s2 (substring rtn (length s2))
12864 (if (and org-add-colon-after-tag-completion
12865 (assoc rtn ctable))
12866 ":" ""))))
12867 rtn)
12868 ((eq flag t)
12869 ;; all-completions
12870 (all-completions s2 ctable confirm)
12871 )
12872 ((eq flag 'lambda)
12873 ;; exact match?
12874 (assoc s2 ctable)))
12875 ))
12877 (defun org-fast-tag-insert (kwd tags face &optional end)
12878 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
12879 (insert (format "%-12s" (concat kwd ":"))
12880 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
12881 (or end "")))
12883 (defun org-fast-tag-show-exit (flag)
12884 (save-excursion
12885 (org-goto-line 3)
12887 (replace-match ""))
12888 (when flag
12889 (end-of-line 1)
12890 (org-move-to-column (- (window-width) 19) t)
12891 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
12893 (defun org-set-current-tags-overlay (current prefix)
12894 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
12895 (if (featurep 'xemacs)
12896 (org-overlay-display org-tags-overlay (concat prefix s)
12897 'secondary-selection)
12898 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
12899 (org-overlay-display org-tags-overlay (concat prefix s)))))
12901 (defvar org-last-tag-selection-key nil)
12902 (defun org-fast-tag-selection (current inherited table &optional todo-table)
12903 "Fast tag selection with single keys.
12904 CURRENT is the current list of tags in the headline, INHERITED is the
12905 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
12906 possibly with grouping information. TODO-TABLE is a similar table with
12907 TODO keywords, should these have keys assigned to them.
12908 If the keys are nil, a-z are automatically assigned.
12909 Returns the new tags string, or nil to not change the current settings."
12910 (let* ((fulltable (append table todo-table))
12911 (maxlen (apply 'max (mapcar
12912 (lambda (x)
12913 (if (stringp (car x)) (string-width (car x)) 0))
12914 fulltable)))
12915 (buf (current-buffer))
12916 (expert (eq org-fast-tag-selection-single-key 'expert))
12917 (buffer-tags nil)
12918 (fwidth (+ maxlen 3 1 3))
12919 (ncol (/ (- (window-width) 4) fwidth))
12920 (i-face 'org-done)
12921 (c-face 'org-todo)
12922 tg cnt e c char c1 c2 ntable tbl rtn
12923 ov-start ov-end ov-prefix
12924 (exit-after-next org-fast-tag-selection-single-key)
12925 (done-keywords org-done-keywords)
12926 groups ingroup)
12927 (save-excursion
12928 (beginning-of-line 1)
12929 (if (looking-at
12931 (setq ov-start (match-beginning 1)
12932 ov-end (match-end 1)
12933 ov-prefix "")
12934 (setq ov-start (1- (point-at-eol))
12935 ov-end (1+ ov-start))
12937 (setq ov-prefix
12938 (concat
12939 (buffer-substring (1- (point)) (point))
12940 (if (> (current-column) org-tags-column)
12941 " "
12942 (make-string (- org-tags-column (current-column)) ?\ ))))))
12943 (move-overlay org-tags-overlay ov-start ov-end)
12944 (save-window-excursion
12945 (if expert
12946 (set-buffer (get-buffer-create " *Org tags*"))
12947 (delete-other-windows)
12948 (split-window-vertically)
12949 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
12950 (erase-buffer)
12951 (org-set-local 'org-done-keywords done-keywords)
12954 (org-fast-tag-show-exit exit-after-next)
12955 (org-set-current-tags-overlay current ov-prefix)
12956 (setq tbl fulltable char ?a cnt 0)
12957 (while (setq e (pop tbl))
12958 (cond
12959 ((equal (car e) :startgroup)
12960 (push '() groups) (setq ingroup t)
12961 (when (not (= cnt 0))
12962 (setq cnt 0)
12964 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
12965 ((equal (car e) :endgroup)
12966 (setq ingroup nil cnt 0)
12968 ((equal e '(:newline))
12969 (when (not (= cnt 0))
12970 (setq cnt 0)
12972 (setq e (car tbl))
12973 (while (equal (car tbl) '(:newline))
12975 (setq tbl (cdr tbl)))))
12976 (t
12977 (setq tg (copy-sequence (car e)) c2 nil)
12978 (if (cdr e)
12979 (setq c (cdr e))
12980 ;; automatically assign a character.
12981 (setq c1 (string-to-char
12982 (downcase (substring
12983 tg (if (= (string-to-char tg) ?@) 1 0)))))
12984 (if (or (rassoc c1 ntable) (rassoc c1 table))
12985 (while (or (rassoc char ntable) (rassoc char table))
12986 (setq char (1+ char)))
12987 (setq c2 c1))
12988 (setq c (or c2 char)))
12989 (if ingroup (push tg (car groups)))
12990 (setq tg (org-add-props tg nil 'face
12991 (cond
12992 ((not (assoc tg table))
12993 (org-get-todo-face tg))
12994 ((member tg current) c-face)
12995 ((member tg inherited) i-face)
12996 (t nil))))
12997 (if (and (= cnt 0) (not ingroup)) (insert " "))
12998 (insert "[" c "] " tg (make-string
12999 (- fwidth 4 (length tg)) ?\ ))
13000 (push (cons tg c) ntable)
13001 (when (= (setq cnt (1+ cnt)) ncol)
13003 (if ingroup (insert " "))
13004 (setq cnt 0)))))
13005 (setq ntable (nreverse ntable))
13007 (goto-char (point-min))
13008 (if (not expert) (org-fit-window-to-buffer))
13009 (setq rtn
13010 (catch 'exit
13011 (while t
13012 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13013 (if (not groups) "no " "")
13014 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13015 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13016 (setq org-last-tag-selection-key c)
13017 (cond
13019 ((= c ?!)
13020 (setq groups (not groups))
13021 (goto-char (point-min))
13022 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13023 ((= c ?\C-c)
13024 (if (not expert)
13025 (org-fast-tag-show-exit
13026 (setq exit-after-next (not exit-after-next)))
13027 (setq expert nil)
13028 (delete-other-windows)
13029 (split-window-vertically)
13030 (org-switch-to-buffer-other-window " *Org tags*")
13031 (org-fit-window-to-buffer)))
13032 ((or (= c ?\C-g)
13033 (and (= c ?q) (not (rassoc c ntable))))
13034 (org-detach-overlay org-tags-overlay)
13035 (setq quit-flag t))
13036 ((= c ?\ )
13037 (setq current nil)
13038 (if exit-after-next (setq exit-after-next 'now)))
13040 (condition-case nil
13041 (setq tg (org-icompleting-read
13042 "Tag: "
13043 (or buffer-tags
13044 (with-current-buffer buf
13045 (org-get-buffer-tags)))))
13046 (quit (setq tg "")))
13048 (add-to-list 'buffer-tags (list tg))
13049 (if (member tg current)
13050 (setq current (delete tg current))
13051 (push tg current)))
13052 (if exit-after-next (setq exit-after-next 'now)))
13053 ((setq e (rassoc c todo-table) tg (car e))
13054 (with-current-buffer buf
13055 (save-excursion (org-todo tg)))
13056 (if exit-after-next (setq exit-after-next 'now)))
13057 ((setq e (rassoc c ntable) tg (car e))
13058 (if (member tg current)
13059 (setq current (delete tg current))
13060 (loop for g in groups do
13061 (if (member tg g)
13062 (mapc (lambda (x)
13063 (setq current (delete x current)))
13064 g)))
13065 (push tg current))
13066 (if exit-after-next (setq exit-after-next 'now))))
13068 ;; Create a sorted list
13069 (setq current
13070 (sort current
13071 (lambda (a b)
13072 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13073 (if (eq exit-after-next 'now) (throw 'exit t))
13074 (goto-char (point-min))
13075 (beginning-of-line 2)
13076 (delete-region (point) (point-at-eol))
13077 (org-fast-tag-insert "Current" current c-face)
13078 (org-set-current-tags-overlay current ov-prefix)
13079 (while (re-search-forward
13081 (setq tg (match-string 1))
13082 (add-text-properties
13083 (match-beginning 1) (match-end 1)
13084 (list 'face
13085 (cond
13086 ((member tg current) c-face)
13087 ((member tg inherited) i-face)
13088 (t (get-text-property (match-beginning 1) 'face))))))
13089 (goto-char (point-min)))))
13090 (org-detach-overlay org-tags-overlay)
13091 (if rtn
13092 (mapconcat 'identity current ":")
13093 nil))))
13095 (defun org-get-tags-string ()
13096 "Get the TAGS string in the current headline."
13097 (unless (org-on-heading-p t)
13098 (error "Not on a heading"))
13099 (save-excursion
13100 (beginning-of-line 1)
13102 (org-match-string-no-properties 1)
13103 "")))
13105 (defun org-get-tags ()
13106 "Get the list of tags specified in the current headline."
13107 (org-split-string (org-get-tags-string) ":"))
13109 (defun org-get-buffer-tags ()
13110 "Get a table of all tags used in the buffer, for completion."
13111 (let (tags)
13112 (save-excursion
13113 (goto-char (point-min))
13114 (while (re-search-forward
13116 (when (equal (char-after (point-at-bol 0)) ?*)
13117 (mapc (lambda (x) (add-to-list 'tags x))
13118 (org-split-string (org-match-string-no-properties 1) ":")))))
13119 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13120 (mapcar 'list tags)))
13122 ;;;; The mapping API
13124 ;;;###autoload
13125 (defun org-map-entries (func &optional match scope &rest skip)
13126 "Call FUNC at each headline selected by MATCH in SCOPE.
13128 FUNC is a function or a lisp form. The function will be called without
13129 arguments, with the cursor positioned at the beginning of the headline.
13130 The return values of all calls to the function will be collected and
13131 returned as a list.
13133 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13134 does not need to preserve point. After evaluation, the cursor will be
13135 moved to the end of the line (presumably of the headline of the
13136 processed entry) and search continues from there. Under some
13137 circumstances, this may not produce the wanted results. For example,
13138 if you have removed (e.g. archived) the current (sub)tree it could
13139 mean that the next entry will be skipped entirely. In such cases, you
13140 can specify the position from where search should continue by making
13141 FUNC set the variable `org-map-continue-from' to the desired buffer
13142 position.
13144 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13145 Only headlines that are matched by this query will be considered during
13146 the iteration. When MATCH is nil or t, all headlines will be
13147 visited by the iteration.
13149 SCOPE determines the scope of this command. It can be any of:
13151 nil The current buffer, respecting the restriction if any
13152 tree The subtree started with the entry at point
13153 file The current buffer, without restriction
13154 file-with-archives
13155 The current buffer, and any archives associated with it
13156 agenda All agenda files
13157 agenda-with-archives
13158 All agenda files with any archive files associated with them
13159 \(file1 file2 ...)
13160 If this is a list, all files in the list will be scanned
13162 The remaining args are treated as settings for the skipping facilities of
13163 the scanner. The following items can be given here:
13165 archive skip trees with the archive tag.
13166 comment skip trees with the COMMENT keyword
13167 function or Emacs Lisp form:
13168 will be used as value for `org-agenda-skip-function', so whenever
13169 the function returns t, FUNC will not be called for that
13170 entry and search will continue from the point where the
13171 function leaves it.
13173 If your function needs to retrieve the tags including inherited tags
13174 at the *current* entry, you can use the value of the variable
13175 `org-scanner-tags' which will be much faster than getting the value
13176 with `org-get-tags-at'. If your function gets properties with
13177 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13178 to t around the call to `org-entry-properties' to get the same speedup.
13179 Note that if your function moves around to retrieve tags and properties at
13180 a *different* entry, you cannot use these techniques."
13181 (let* ((org-agenda-archives-mode nil) ; just to make sure
13182 (org-agenda-skip-archived-trees (memq 'archive skip))
13183 (org-agenda-skip-comment-trees (memq 'comment skip))
13184 (org-agenda-skip-function
13185 (car (org-delete-all '(comment archive) skip)))
13186 (org-tags-match-list-sublevels t)
13187 matcher file res
13188 org-todo-keywords-for-agenda
13189 org-done-keywords-for-agenda
13190 org-todo-keyword-alist-for-agenda
13191 org-drawers-for-agenda
13192 org-tag-alist-for-agenda)
13194 (cond
13195 ((eq match t) (setq matcher t))
13196 ((eq match nil) (setq matcher t))
13197 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13199 (save-excursion
13200 (save-restriction
13201 (when (eq scope 'tree)
13202 (org-back-to-heading t)
13203 (org-narrow-to-subtree)
13204 (setq scope nil))
13206 (if (not scope)
13207 (progn
13208 (org-prepare-agenda-buffers
13209 (list (buffer-file-name (current-buffer))))
13210 (setq res (org-scan-tags func matcher)))
13211 ;; Get the right scope
13212 (cond
13213 ((and scope (listp scope) (symbolp (car scope)))
13214 (setq scope (eval scope)))
13215 ((eq scope 'agenda)
13216 (setq scope (org-agenda-files t)))
13217 ((eq scope 'agenda-with-archives)
13218 (setq scope (org-agenda-files t))
13219 (setq scope (org-add-archive-files scope)))
13220 ((eq scope 'file)
13221 (setq scope (list (buffer-file-name))))
13222 ((eq scope 'file-with-archives)
13223 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13224 (org-prepare-agenda-buffers scope)
13225 (while (setq file (pop scope))
13226 (with-current-buffer (org-find-base-buffer-visiting file)
13227 (save-excursion
13228 (save-restriction
13229 (widen)
13230 (goto-char (point-min))
13231 (setq res (append res (org-scan-tags func matcher))))))))))
13232 res))
13234 ;;;; Properties
13236 ;;; Setting and retrieving properties
13238 (defconst org-special-properties
13239 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13240 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED")
13241 "The special properties valid in Org-mode.
13243 These are properties that are not defined in the property drawer,
13244 but in some other way.")
13246 (defconst org-default-properties
13247 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13248 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13249 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13250 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13251 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13252 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13253 "Some properties that are used by Org-mode for various purposes.
13254 Being in this list makes sure that they are offered for completion.")
13257 "Regular expression matching the first line of a property drawer.")
13260 "Regular expression matching the last line of a property drawer.")
13263 "Regular expression matching the first line of a property drawer.")
13266 "Regular expression matching the first line of a property drawer.")
13268 (defconst org-property-drawer-re
13271 "Matches an entire property drawer.")
13273 (defconst org-clock-drawer-re
13276 "Matches an entire clock drawer.")
13278 (defun org-property-action ()
13279 "Do an action on properties."
13280 (interactive)
13281 (let (c)
13282 (org-at-property-p)
13283 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13284 (setq c (read-char-exclusive))
13285 (cond
13286 ((equal c ?s)
13287 (call-interactively 'org-set-property))
13288 ((equal c ?d)
13289 (call-interactively 'org-delete-property))
13290 ((equal c ?D)
13291 (call-interactively 'org-delete-property-globally))
13292 ((equal c ?c)
13293 (call-interactively 'org-compute-property-at-point))
13294 (t (error "No such property action %c" c)))))
13296 (defun org-set-effort (&optional value)
13297 "Set the effort property of the current entry.
13298 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13299 allowed value."
13300 (interactive "P")
13301 (if (equal value 0) (setq value 10))
13302 (let* ((completion-ignore-case t)
13303 (prop org-effort-property)
13304 (cur (org-entry-get nil prop))
13305 (allowed (org-property-get-allowed-values nil prop 'table))
13306 (existing (mapcar 'list (org-property-values prop)))
13307 rpl
13308 (val (cond
13309 ((stringp value) value)
13310 ((and allowed (integerp value))
13311 (or (car (nth (1- value) allowed))
13312 (car (org-last allowed))))
13313 (allowed
13314 (message "Select 1-9,0, [RET%s]: %s"
13315 (if cur (concat "=" cur) "")
13316 (mapconcat 'car allowed " "))
13317 (setq rpl (read-char-exclusive))
13319 cur
13320 (setq rpl (- rpl ?0))
13321 (if (equal rpl 0) (setq rpl 10))
13322 (if (and (> rpl 0) (<= rpl (length allowed)))
13323 (car (nth (1- rpl) allowed))
13324 (org-completing-read "Effort: " allowed nil))))
13325 (t
13326 (let (org-completion-use-ido org-completion-use-iswitchb)
13327 (org-completing-read
13329 (concat "[" cur "]") "")
13330 ": ")
13331 existing nil nil "" nil cur))))))
13332 (unless (equal (org-entry-get nil prop) val)
13333 (org-entry-put nil prop val))
13334 (message "%s is now %s" prop val)))
13336 (defun org-at-property-p ()
13337 "Is cursor inside a property drawer?"
13338 (save-excursion
13339 (beginning-of-line 1)
13341 (save-match-data ;; Used by calling procedures
13342 (let ((p (point))
13343 (range (unless (org-before-first-heading-p)
13344 (org-get-property-block))))
13345 (and range (<= (car range) p) (< p (cdr range))))))))
13347 (defun org-get-property-block (&optional beg end force)
13348 "Return the (beg . end) range of the body of the property drawer.
13349 BEG and END can be beginning and end of subtree, if not given
13350 they will be found.
13351 If the drawer does not exist and FORCE is non-nil, create the drawer."
13352 (catch 'exit
13353 (save-excursion
13354 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13355 (end (or end (progn (outline-next-heading) (point)))))
13356 (goto-char beg)
13357 (if (re-search-forward org-property-start-re end t)
13358 (setq beg (1+ (match-end 0)))
13359 (if force
13360 (save-excursion
13361 (org-insert-property-drawer)
13362 (setq end (progn (outline-next-heading) (point))))
13363 (throw 'exit nil))
13364 (goto-char beg)
13365 (if (re-search-forward org-property-start-re end t)
13366 (setq beg (1+ (match-end 0)))))
13367 (if (re-search-forward org-property-end-re end t)
13368 (setq end (match-beginning 0))
13369 (or force (throw 'exit nil))
13370 (goto-char beg)
13371 (setq end beg)
13372 (org-indent-line-function)
13374 (cons beg end)))))
13376 (defun org-entry-properties (&optional pom which specific)
13377 "Get all properties of the entry at point-or-marker POM.
13378 This includes the TODO keyword, the tags, time strings for deadline,
13379 scheduled, and clocking, and any additional properties defined in the
13380 entry. The return value is an alist, keys may occur multiple times
13381 if the property key was used several times.
13382 POM may also be nil, in which case the current entry is used.
13383 If WHICH is nil or `all', get all properties. If WHICH is
13384 `special' or `standard', only get that subclass. If WHICH
13385 is a string only get exactly this property. SPECIFIC can be a string, the
13386 specific property we are interested in. Specifying it can speed
13387 things up because then unnecessary parsing is avoided."
13388 (setq which (or which 'all))
13389 (org-with-point-at pom
13390 (let ((clockstr (substring org-clock-string 0 -1))
13391 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13392 (case-fold-search nil)
13393 beg end range props sum-props key key1 value string clocksum)
13394 (save-excursion
13395 (when (condition-case nil
13396 (and (org-mode-p) (org-back-to-heading t))
13397 (error nil))
13398 (setq beg (point))
13399 (setq sum-props (get-text-property (point) 'org-summaries))
13400 (setq clocksum (get-text-property (point) :org-clock-minutes))
13401 (outline-next-heading)
13402 (setq end (point))
13403 (when (memq which '(all special))
13404 ;; Get the special properties, like TODO and tags
13405 (goto-char beg)
13406 (when (and (or (not specific) (string= specific "TODO"))
13407 (looking-at org-todo-line-regexp) (match-end 2))
13408 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13409 (when (and (or (not specific) (string= specific "PRIORITY"))
13410 (looking-at org-priority-regexp))
13411 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13412 (when (and (or (not specific) (string= specific "TAGS"))
13413 (setq value (org-get-tags-string))
13415 (push (cons "TAGS" value) props))
13416 (when (and (or (not specific) (string= specific "ALLTAGS"))
13417 (setq value (org-get-tags-at)))
13418 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13419 ":"))
13420 props))
13421 (when (or (not specific) (string= specific "BLOCKED"))
13422 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13423 (when (or (not specific)
13424 (member specific
13425 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13426 "TIMESTAMP" "TIMESTAMP_IA")))
13427 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13428 (setq key (if (match-end 1)
13429 (substring (org-match-string-no-properties 1)
13430 0 -1))
13431 string (if (equal key clockstr)
13432 (org-no-properties
13433 (org-trim
13434 (buffer-substring
13435 (match-beginning 3) (goto-char
13436 (point-at-eol)))))
13437 (substring (org-match-string-no-properties 3)
13438 1 -1)))
13439 ;; Get the correct property name from the key. This is
13440 ;; necessary if the user has configured time keywords.
13441 (setq key1 (concat key ":"))
13442 (cond
13443 ((not key)
13444 (setq key
13445 (if (= (char-after (match-beginning 3)) ?\[)
13446 "TIMESTAMP_IA" "TIMESTAMP")))
13447 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13448 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13449 ((equal key1 org-closed-string) (setq key "CLOSED"))
13450 ((equal key1 org-clock-string) (setq key "CLOCK")))
13451 (when (or (equal key "CLOCK") (not (assoc key props)))
13452 (push (cons key string) props))))
13453 )
13455 (when (memq which '(all standard))
13456 ;; Get the standard properties, like :PROP: ...
13457 (setq range (org-get-property-block beg end))
13458 (when range
13459 (goto-char (car range))
13460 (while (re-search-forward
13462 (cdr range) t)
13463 (setq key (org-match-string-no-properties 1)
13464 value (org-trim (or (org-match-string-no-properties 2) "")))
13465 (unless (member key excluded)
13466 (push (cons key (or value "")) props)))))
13467 (if clocksum
13468 (push (cons "CLOCKSUM"
13469 (org-columns-number-to-string (/ (float clocksum) 60.)
13470 'add_times))
13471 props))
13472 (unless (assoc "CATEGORY" props)
13473 (setq value (or (org-get-category)
13474 (progn (org-refresh-category-properties)
13475 (org-get-category))))
13476 (push (cons "CATEGORY" value) props))
13477 (append sum-props (nreverse props)))))))
13479 (defun org-entry-get (pom property &optional inherit literal-nil)
13480 "Get value of PROPERTY for entry at point-or-marker POM.
13481 If INHERIT is non-nil and the entry does not have the property,
13482 then also check higher levels of the hierarchy.
13483 If INHERIT is the symbol `selective', use inheritance only if the setting
13484 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13485 If the property is present but empty, the return value is the empty string.
13486 If the property is not present at all, nil is returned.
13489 do not interpret it as the list atom nil. This is used for inheritance
13491 (org-with-point-at pom
13492 (if (and inherit (if (eq inherit 'selective)
13493 (org-property-inherit-p property)
13494 t))
13495 (org-entry-get-with-inheritance property literal-nil)
13496 (if (member property org-special-properties)
13497 ;; We need a special property. Use `org-entry-properties' to
13498 ;; retrieve it, but specify the wanted property
13499 (cdr (assoc property (org-entry-properties nil 'special property)))
13500 (let ((range (org-get-property-block)))
13501 (if (and range
13502 (goto-char (car range))
13503 (re-search-forward
13505 (cdr range) t))
13506 ;; Found the property, return it.
13507 (if (match-end 1)
13508 (if literal-nil
13509 (org-match-string-no-properties 1)
13510 (org-not-nil (org-match-string-no-properties 1)))
13511 "")))))))
13513 (defun org-property-or-variable-value (var &optional inherit)
13514 "Check if there is a property fixing the value of VAR.
13515 If yes, return this value. If not, return the current value of the variable."
13516 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13518 (read prop)
13519 (symbol-value var))))
13521 (defun org-entry-delete (pom property)
13522 "Delete the property PROPERTY from entry at point-or-marker POM."
13523 (org-with-point-at pom
13524 (if (member property org-special-properties)
13525 nil ; cannot delete these properties.
13526 (let ((range (org-get-property-block)))
13527 (if (and range
13528 (goto-char (car range))
13529 (re-search-forward
13531 (cdr range) t))
13532 (progn
13533 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13534 t)
13535 nil)))))
13537 ;; Multi-values properties are properties that contain multiple values
13538 ;; These values are assumed to be single words, separated by whitespace.
13539 (defun org-entry-add-to-multivalued-property (pom property value)
13540 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13541 (let* ((old (org-entry-get pom property))
13543 (setq value (org-entry-protect-space value))
13544 (unless (member value values)
13545 (setq values (cons value values))
13546 (org-entry-put pom property
13547 (mapconcat 'identity values " ")))))
13549 (defun org-entry-remove-from-multivalued-property (pom property value)
13550 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13551 (let* ((old (org-entry-get pom property))
13553 (setq value (org-entry-protect-space value))
13554 (when (member value values)
13555 (setq values (delete value values))
13556 (org-entry-put pom property
13557 (mapconcat 'identity values " ")))))
13559 (defun org-entry-member-in-multivalued-property (pom property value)
13560 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13561 (let* ((old (org-entry-get pom property))
13563 (setq value (org-entry-protect-space value))
13564 (member value values)))
13566 (defun org-entry-get-multivalued-property (pom property)
13567 "Return a list of values in a multivalued property."
13568 (let* ((value (org-entry-get pom property))
13570 (mapcar 'org-entry-restore-space values)))
13572 (defun org-entry-put-multivalued-property (pom property &rest values)
13573 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13574 VALUES should be a list of strings. Spaces will be protected."
13575 (org-entry-put pom property
13576 (mapconcat 'org-entry-protect-space values " "))
13577 (let* ((value (org-entry-get pom property))
13579 (mapcar 'org-entry-restore-space values)))
13581 (defun org-entry-protect-space (s)
13582 "Protect spaces and newline in string S."
13583 (while (string-match " " s)
13584 (setq s (replace-match "%20" t t s)))
13586 (setq s (replace-match "%0A" t t s)))
13587 s)
13589 (defun org-entry-restore-space (s)
13590 "Restore spaces and newline in string S."
13591 (while (string-match "%20" s)
13592 (setq s (replace-match " " t t s)))
13593 (while (string-match "%0A" s)
13595 s)
13597 (defvar org-entry-property-inherited-from (make-marker)
13598 "Marker pointing to the entry from where a property was inherited.
13599 Each call to `org-entry-get-with-inheritance' will set this marker to the
13600 location of the entry where the inheritance search matched. If there was
13601 no match, the marker will point nowhere.
13602 Note that also `org-entry-get' calls this function, if the INHERIT flag
13603 is set.")
13605 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13606 "Get entry property, and search higher levels if not present.
13607 The search will stop at the first ancestor which has the property defined.
13609 should be considered as undefined (this is the meaning of nil here).
13611 (move-marker org-entry-property-inherited-from nil)
13612 (let (tmp)
13613 (save-excursion
13614 (save-restriction
13615 (widen)
13616 (catch 'ex
13617 (while t
13618 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13619 (org-back-to-heading t)
13620 (move-marker org-entry-property-inherited-from (point))
13621 (throw 'ex tmp))
13622 (or (org-up-heading-safe) (throw 'ex nil)))))
13623 (setq tmp (or tmp
13624 (cdr (assoc property org-file-properties))
13625 (cdr (assoc property org-global-properties))
13626 (cdr (assoc property org-global-properties-fixed))))
13627 (if literal-nil tmp (org-not-nil tmp)))))
13629 (defvar org-property-changed-functions nil
13630 "Hook called when the value of a property has changed.
13631 Each hook function should accept two arguments, the name of the property
13632 and the new value.")
13634 (defun org-entry-put (pom property value)
13635 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13636 (org-with-point-at pom
13637 (org-back-to-heading t)
13638 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13639 range)
13640 (cond
13641 ((equal property "TODO")
13643 (not (member value org-todo-keywords-1)))
13645 (if (or (not value)
13647 (setq value 'none))
13648 (org-todo value)
13649 (org-set-tags nil 'align))
13650 ((equal property "PRIORITY")
13652 (string-to-char value) ?\ ))
13653 (org-set-tags nil 'align))
13654 ((equal property "SCHEDULED")
13655 (if (re-search-forward org-scheduled-time-regexp end t)
13656 (cond
13657 ((eq value 'earlier) (org-timestamp-change -1 'day))
13658 ((eq value 'later) (org-timestamp-change 1 'day))
13659 (t (call-interactively 'org-schedule)))
13660 (call-interactively 'org-schedule)))
13661 ((equal property "DEADLINE")
13662 (if (re-search-forward org-deadline-time-regexp end t)
13663 (cond
13664 ((eq value 'earlier) (org-timestamp-change -1 'day))
13665 ((eq value 'later) (org-timestamp-change 1 'day))
13666 (t (call-interactively 'org-deadline)))
13667 (call-interactively 'org-deadline)))
13668 ((member property org-special-properties)
13669 (error "The %s property can not yet be set with `org-entry-put'"
13670 property))
13671 (t ; a non-special property
13672 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13673 (setq range (org-get-property-block beg end 'force))
13674 (goto-char (car range))
13675 (if (re-search-forward
13677 (progn
13678 (delete-region (match-beginning 1) (match-end 1))
13679 (goto-char (match-beginning 1)))
13680 (goto-char (cdr range))
13682 (backward-char 1)
13683 (org-indent-line-function)
13684 (insert ":" property ":"))
13685 (and value (insert " " value))
13686 (org-indent-line-function)))))
13687 (run-hook-with-args 'org-property-changed-functions property value)))
13689 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13690 "Get all property keys in the current buffer.
13691 With INCLUDE-SPECIALS, also list the special properties that reflect things
13692 like tags and TODO state.
13693 With INCLUDE-DEFAULTS, also include properties that has special meaning
13694 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
13695 With INCLUDE-COLUMNS, also include property names given in COLUMN
13696 formats in the current buffer."
13697 (let (rtn range cfmt s p)
13698 (save-excursion
13699 (save-restriction
13700 (widen)
13701 (goto-char (point-min))
13702 (while (re-search-forward org-property-start-re nil t)
13703 (setq range (org-get-property-block))
13704 (goto-char (car range))
13705 (while (re-search-forward
13707 (cdr range) t)
13708 (add-to-list 'rtn (org-match-string-no-properties 1)))
13709 (outline-next-heading))))
13711 (when include-specials
13712 (setq rtn (append org-special-properties rtn)))
13714 (when include-defaults
13715 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13716 (add-to-list 'rtn org-effort-property))
13718 (when include-columns
13719 (save-excursion
13720 (save-restriction
13721 (widen)
13722 (goto-char (point-min))
13723 (while (re-search-forward
13725 nil t)
13726 (setq cfmt (match-string 2) s 0)
13728 cfmt s)
13729 (setq s (match-end 0)
13730 p (match-string 1 cfmt))
13731 (unless (or (equal p "ITEM")
13732 (member p org-special-properties))
13733 (add-to-list 'rtn (match-string 1 cfmt))))))))
13735 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13737 (defun org-property-values (key)
13738 "Return a list of all values of property KEY."
13739 (save-excursion
13740 (save-restriction
13741 (widen)
13742 (goto-char (point-min))
13744 values)
13745 (while (re-search-forward re nil t)
13746 (add-to-list 'values (org-trim (match-string 1))))
13747 (delete "" values)))))
13749 (defun org-insert-property-drawer ()
13750 "Insert a property drawer into the current entry."
13751 (interactive)
13752 (org-back-to-heading t)
13753 (looking-at outline-regexp)
13754 (let ((indent (if org-adapt-indentation
13755 (- (match-end 0)(match-beginning 0))
13756 0))
13757 (beg (point))
13759 end hiddenp)
13760 (outline-next-heading)
13761 (setq end (point))
13762 (goto-char beg)
13763 (while (re-search-forward re end t))
13764 (setq hiddenp (org-invisible-p))
13765 (end-of-line 1)
13768 (if (member (match-string 1) '("CLOCK:" ":END:"))
13769 ;; just skip this line
13770 (beginning-of-line 2)
13771 ;; Drawer start, find the end
13773 (beginning-of-line 1)))
13774 (org-skip-over-state-notes)
13776 (if (eq (char-before) ?*) (forward-char 1))
13778 (beginning-of-line 0)
13779 (org-indent-to-column indent)
13780 (beginning-of-line 2)
13781 (org-indent-to-column indent)
13782 (beginning-of-line 0)
13783 (if hiddenp
13784 (save-excursion
13785 (org-back-to-heading t)
13786 (hide-entry))
13787 (org-flag-drawer t))))
13789 (defun org-set-property (property value)
13790 "In the current entry, set PROPERTY to VALUE.
13791 When called interactively, this will prompt for a property name, offering
13792 completion on existing and default properties. And then it will prompt
13793 for a value, offering completion either on allowed values (via an inherited
13794 xxx_ALL property) or on existing values in other instances of this property
13795 in the current file."
13796 (interactive
13797 (let* ((completion-ignore-case t)
13798 (keys (org-buffer-property-keys nil t t))
13799 (prop0 (org-icompleting-read "Property: " (mapcar 'list keys)))
13800 (prop (if (member prop0 keys)
13801 prop0
13802 (or (cdr (assoc (downcase prop0)
13803 (mapcar (lambda (x) (cons (downcase x) x))
13804 keys)))
13805 prop0)))
13806 (cur (org-entry-get nil prop))
13807 (prompt (concat prop " value"
13809 (concat " [" cur "]") "") ": "))
13810 (allowed (org-property-get-allowed-values nil prop 'table))
13811 (existing (mapcar 'list (org-property-values prop)))
13812 (val (if allowed
13813 (org-completing-read prompt allowed nil
13814 (not (get-text-property 0 'org-unrestricted
13815 (caar allowed))))
13816 (let (org-completion-use-ido org-completion-use-iswitchb)
13817 (org-completing-read prompt existing nil nil "" nil cur)))))
13818 (list prop (if (equal val "") cur val))))
13819 (unless (equal (org-entry-get nil property) value)
13820 (org-entry-put nil property value)))
13822 (defun org-delete-property (property)
13823 "In the current entry, delete PROPERTY."
13824 (interactive
13825 (let* ((completion-ignore-case t)
13826 (prop (org-icompleting-read "Property: "
13827 (org-entry-properties nil 'standard))))
13828 (list prop)))
13829 (message "Property %s %s" property
13830 (if (org-entry-delete nil property)
13831 "deleted"
13832 "was not present in the entry")))
13834 (defun org-delete-property-globally (property)
13835 "Remove PROPERTY globally, from all entries."
13836 (interactive
13837 (let* ((completion-ignore-case t)
13838 (prop (org-icompleting-read
13839 "Globally remove property: "
13840 (mapcar 'list (org-buffer-property-keys)))))
13841 (list prop)))
13842 (save-excursion
13843 (save-restriction
13844 (widen)
13845 (goto-char (point-min))
13846 (let ((cnt 0))
13847 (while (re-search-forward
13849 nil t)
13850 (setq cnt (1+ cnt))
13851 (replace-match ""))
13854 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
13856 (defun org-compute-property-at-point ()
13857 "Compute the property at point.
13858 This looks for an enclosing column format, extracts the operator and
13859 then applies it to the property in the column format's scope."
13860 (interactive)
13861 (unless (org-at-property-p)
13862 (error "Not at a property"))
13863 (let ((prop (org-match-string-no-properties 2)))
13864 (org-columns-get-format-and-top-level)
13865 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
13866 (error "No operator defined for property %s" prop))
13867 (org-columns-compute prop)))
13869 (defvar org-property-allowed-value-functions nil
13870 "Hook for functions supplying allowed values for a specific property.
13871 The functions must take a single argument, the name of the property, and
13873 the values, this means that these values are intended as defaults for
13874 completion, but that other values should be allowed too.
13875 The functions must return nil if they are not responsible for this
13876 property.")
13878 (defun org-property-get-allowed-values (pom property &optional table)
13879 "Get allowed values for the property PROPERTY.
13880 When TABLE is non-nil, return an alist that can directly be used for
13881 completion."
13882 (let (vals)
13883 (cond
13884 ((equal property "TODO")
13885 (setq vals (org-with-point-at pom
13886 (append org-todo-keywords-1 '("")))))
13887 ((equal property "PRIORITY")
13888 (let ((n org-lowest-priority))
13889 (while (>= n org-highest-priority)
13890 (push (char-to-string n) vals)
13891 (setq n (1- n)))))
13892 ((member property org-special-properties))
13893 ((setq vals (run-hook-with-args-until-success
13894 'org-property-allowed-value-functions property)))
13895 (t
13896 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
13898 (setq vals (car (read-from-string (concat "(" vals ")"))))
13899 (setq vals (mapcar (lambda (x)
13900 (cond ((stringp x) x)
13901 ((numberp x) (number-to-string x))
13902 ((symbolp x) (symbol-name x))
13903 (t "???")))
13904 vals)))))
13905 (when (member ":ETC" vals)
13906 (setq vals (remove ":ETC" vals))
13907 (org-add-props (car vals) '(org-unrestricted t)))
13908 (if table (mapcar 'list vals) vals)))
13910 (defun org-property-previous-allowed-value (&optional previous)
13911 "Switch to the next allowed value for this property."
13912 (interactive)
13913 (org-property-next-allowed-value t))
13915 (defun org-property-next-allowed-value (&optional previous)
13916 "Switch to the next allowed value for this property."
13917 (interactive)
13918 (unless (org-at-property-p)
13919 (error "Not at a property"))
13920 (let* ((key (match-string 2))
13921 (value (match-string 3))
13922 (allowed (or (org-property-get-allowed-values (point) key)
13923 (and (member value '("[ ]" "[-]" "[X]"))
13924 '("[ ]" "[X]"))))
13925 nval)
13926 (unless allowed
13927 (error "Allowed values for this property have not been defined"))
13928 (if previous (setq allowed (reverse allowed)))
13929 (if (member value allowed)
13930 (setq nval (car (cdr (member value allowed)))))
13931 (setq nval (or nval (car allowed)))
13932 (if (equal nval value)
13933 (error "Only one allowed value for this property"))
13934 (org-at-property-p)
13935 (replace-match (concat " :" key ": " nval) t t)
13936 (org-indent-line-function)
13937 (beginning-of-line 1)
13939 (run-hook-with-args 'org-property-changed-functions key nval)))
13941 (defun org-find-olp (path &optional this-buffer)
13942 "Return a marker pointing to the entry at outline path OLP.
13943 If anything goes wrong, throw an error.
13944 You can wrap this call to catch the error like this:
13946 (condition-case msg
13947 (org-mobile-locate-entry (match-string 4))
13948 (error (nth 1 msg)))
13950 The return value will then be either a string with the error message,
13951 or a marker if everything is OK.
13953 If THIS-BUFFER is set, the outline path does not contain a file,
13954 only headings."
13955 (let* ((file (if this-buffer buffer-file-name (pop path)))
13956 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
13957 (level 1)
13958 (lmin 1)
13959 (lmax 1)
13960 limit re end found pos heading cnt)
13961 (unless buffer (error "File not found :%s" file))
13962 (with-current-buffer buffer
13963 (save-excursion
13964 (save-restriction
13965 (widen)
13966 (setq limit (point-max))
13967 (goto-char (point-min))
13968 (while (setq heading (pop path))
13969 (setq re (format org-complex-heading-regexp-format
13970 (regexp-quote heading)))
13971 (setq cnt 0 pos (point))
13972 (while (re-search-forward re end t)
13973 (setq level (- (match-end 1) (match-beginning 1)))
13974 (if (and (>= level lmin) (<= level lmax))
13975 (setq found (match-beginning 0) cnt (1+ cnt))))
13976 (when (= cnt 0) (error "Heading not found on level %d: %s"
13977 lmax heading))
13978 (when (> cnt 1) (error "Heading not unique on level %d: %s"
13979 lmax heading))
13980 (goto-char found)
13981 (setq lmin (1+ level) lmax (+ lmin (if org-odd-levels-only 1 0)))
13982 (setq end (save-excursion (org-end-of-subtree t t))))
13983 (when (org-on-heading-p)
13984 (move-marker (make-marker) (point))))))))
13986 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
13987 "Find node HEADING in BUFFER.
13988 Return a marker to the heading if it was found, or nil if not.
13989 If POS-ONLY is set, return just the position instead of a marker.
13991 The heading text must match exact, but it may have a TODO keyword,
13992 a priority cookie and tags in the standard locations."
13993 (with-current-buffer (or buffer (current-buffer))
13994 (save-excursion
13995 (save-restriction
13996 (widen)
13997 (goto-char (point-min))
13998 (let (case-fold-search)
13999 (if (re-search-forward
14000 (format org-complex-heading-regexp-format
14001 (regexp-quote heading)) nil t)
14002 (if pos-only
14003 (match-beginning 0)
14004 (move-marker (make-marker) (match-beginning 0)))))))))
14006 (defun org-find-exact-heading-in-directory (heading &optional dir)
14007 "Find Org node headline HEADING in all .org files in directory DIR.
14008 When the target headline is found, return a marker to this location."
14009 (let ((files (directory-files (or dir default-directory)
14011 file visiting m buffer)
14012 (catch 'found
14013 (while (setq file (pop files))
14014 (message "trying %s" file)
14015 (setq visiting (org-find-base-buffer-visiting file))
14016 (setq buffer (or visiting (find-file-noselect file)))
14017 (setq m (org-find-exact-headline-in-buffer
14018 heading buffer))
14019 (when (and (not m) (not visiting)) (kill-buffer buffer))
14020 (and m (throw 'found m))))))
14022 (defun org-find-entry-with-id (ident)
14023 "Locate the entry that contains the ID property with exact value IDENT.
14024 IDENT can be a string, a symbol or a number, this function will search for
14025 the string representation of it.
14026 Return the position where this entry starts, or nil if there is no such entry."
14027 (interactive "sID: ")
14028 (let ((id (cond
14029 ((stringp ident) ident)
14030 ((symbol-name ident) (symbol-name ident))
14031 ((numberp ident) (number-to-string ident))
14032 (t (error "IDENT %s must be a string, symbol or number" ident))))
14033 (case-fold-search nil))
14034 (save-excursion
14035 (save-restriction
14036 (widen)
14037 (goto-char (point-min))
14038 (when (re-search-forward
14040 nil t)
14041 (org-back-to-heading t)
14042 (point))))))
14044 ;;;; Timestamps
14046 (defvar org-last-changed-timestamp nil)
14047 (defvar org-last-inserted-timestamp nil
14048 "The last time stamp inserted with `org-insert-time-stamp'.")
14049 (defvar org-time-was-given) ; dynamically scoped parameter
14050 (defvar org-end-time-was-given) ; dynamically scoped parameter
14051 (defvar org-ts-what) ; dynamically scoped parameter
14053 (defun org-time-stamp (arg &optional inactive)
14054 "Prompt for a date/time and insert a time stamp.
14055 If the user specifies a time like HH:MM, or if this command is called
14056 with a prefix argument, the time stamp will contain date and time.
14057 Otherwise, only the date will be included. All parts of a date not
14058 specified by the user will be filled in from the current date/time.
14059 So if you press just return without typing anything, the time stamp
14060 will represent the current date/time. If there is already a timestamp
14061 at the cursor, it will be modified."
14062 (interactive "P")
14063 (let* ((ts nil)
14064 (default-time
14065 ;; Default time is either today, or, when entering a range,
14066 ;; the range start.
14067 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14068 (save-excursion
14069 (re-search-backward
14071 (- (point) 20) t)))
14072 (apply 'encode-time (org-parse-time-string (match-string 1)))
14073 (current-time)))
14074 (default-input (and ts (org-get-compact-tod ts)))
14075 org-time-was-given org-end-time-was-given time)
14076 (cond
14077 ((and (org-at-timestamp-p t)
14078 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14079 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14080 (insert "--")
14081 (setq time (let ((this-command this-command))
14082 (org-read-date arg 'totime nil nil
14083 default-time default-input)))
14084 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14085 ((org-at-timestamp-p t)
14086 (setq time (let ((this-command this-command))
14087 (org-read-date arg 'totime nil nil default-time default-input)))
14088 (when (org-at-timestamp-p t) ; just to get the match data
14089 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14090 (replace-match "")
14091 (setq org-last-changed-timestamp
14092 (org-insert-time-stamp
14093 time (or org-time-was-given arg)
14094 inactive nil nil (list org-end-time-was-given))))
14095 (message "Timestamp updated"))
14096 (t
14097 (setq time (let ((this-command this-command))
14098 (org-read-date arg 'totime nil nil default-time default-input)))
14099 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14100 nil nil (list org-end-time-was-given))))))
14102 ;; FIXME: can we use this for something else, like computing time differences?
14103 (defun org-get-compact-tod (s)
14104 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14105 (let* ((t1 (match-string 1 s))
14106 (h1 (string-to-number (match-string 2 s)))
14107 (m1 (string-to-number (match-string 3 s)))
14108 (t2 (and (match-end 4) (match-string 5 s)))
14109 (h2 (and t2 (string-to-number (match-string 6 s))))
14110 (m2 (and t2 (string-to-number (match-string 7 s))))
14111 dh dm)
14112 (if (not t2)
14113 t1
14114 (setq dh (- h2 h1) dm (- m2 m1))
14115 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14116 (concat t1 "+" (number-to-string dh)
14117 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14119 (defun org-time-stamp-inactive (&optional arg)
14120 "Insert an inactive time stamp.
14121 An inactive time stamp is enclosed in square brackets instead of angle
14122 brackets. It is inactive in the sense that it does not trigger agenda entries,
14123 does not link to the calendar and cannot be changed with the S-cursor keys.
14124 So these are more for recording a certain time/date."
14125 (interactive "P")
14126 (org-time-stamp arg 'inactive))
14128 (defvar org-date-ovl (make-overlay 1 1))
14129 (overlay-put org-date-ovl 'face 'org-warning)
14130 (org-detach-overlay org-date-ovl)
14132 (defvar org-ans1) ; dynamically scoped parameter
14133 (defvar org-ans2) ; dynamically scoped parameter
14135 (defvar org-plain-time-of-day-regexp) ; defined below
14137 (defvar org-overriding-default-time nil) ; dynamically scoped
14138 (defvar org-read-date-overlay nil)
14139 (defvar org-dcst nil) ; dynamically scoped
14140 (defvar org-read-date-history nil)
14141 (defvar org-read-date-final-answer nil)
14143 (defun org-read-date (&optional with-time to-time from-string prompt
14144 default-time default-input)
14145 "Read a date, possibly a time, and make things smooth for the user.
14146 The prompt will suggest to enter an ISO date, but you can also enter anything
14147 which will at least partially be understood by `parse-time-string'.
14148 Unrecognized parts of the date will default to the current day, month, year,
14149 hour and minute. If this command is called to replace a timestamp at point,
14150 of to enter the second timestamp of a range, the default time is taken
14151 from the existing stamp. Furthermore, the command prefers the future,
14152 so if you are giving a date where the year is not given, and the day-month
14153 combination is already past in the current year, it will assume you
14154 mean next year. For details, see the manual. A few examples:
14156 3-2-5 --> 2003-02-05
14157 feb 15 --> currentyear-02-15
14158 2/15 --> currentyear-02-15
14159 sep 12 9 --> 2009-09-12
14160 12:45 --> today 12:45
14161 22 sept 0:34 --> currentyear-09-22 0:34
14162 12 --> currentyear-currentmonth-12
14163 Fri --> nearest Friday (today or later)
14164 etc.
14166 Furthermore you can specify a relative date by giving, as the *first* thing
14167 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14168 change in days weeks, months, years.
14169 With a single plus or minus, the date is relative to today. With a double
14170 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14171 +4d --> four days from today
14172 +4 --> same as above
14173 +2w --> two weeks from today
14174 ++5 --> five days from default date
14176 The function understands only English month and weekday abbreviations,
14177 but this can be configured with the variables `parse-time-months' and
14178 `parse-time-weekdays'.
14180 While prompting, a calendar is popped up - you can also select the
14181 date with the mouse (button 1). The calendar shows a period of three
14182 months. To scroll it to other months, use the keys `>' and `<'.
14183 If you don't like the calendar, turn it off with
14184 \(setq org-read-date-popup-calendar nil)
14186 With optional argument TO-TIME, the date will immediately be converted
14187 to an internal time.
14188 With an optional argument WITH-TIME, the prompt will suggest to also
14189 insert a time. Note that when WITH-TIME is not set, you can still
14190 enter a time, and this function will inform the calling routine about
14191 this change. The calling routine may then choose to change the format
14192 used to insert the time stamp into the buffer to include the time.
14193 With optional argument FROM-STRING, read from this string instead from
14194 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14195 the time/date that is used for everything that is not specified by the
14196 user."
14197 (require 'parse-time)
14198 (let* ((org-time-stamp-rounding-minutes
14199 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14200 (org-dcst org-display-custom-times)
14201 (ct (org-current-time))
14202 (def (or org-overriding-default-time default-time ct))
14203 (defdecode (decode-time def))
14204 (dummy (progn
14205 (when (< (nth 2 defdecode) org-extend-today-until)
14206 (setcar (nthcdr 2 defdecode) -1)
14207 (setcar (nthcdr 1 defdecode) 59)
14208 (setq def (apply 'encode-time defdecode)
14209 defdecode (decode-time def)))))
14210 (calendar-frame-setup nil)
14211 (calendar-setup nil)
14212 (calendar-move-hook nil)
14213 (calendar-view-diary-initially-flag nil)
14214 (calendar-view-holidays-initially-flag nil)
14215 (timestr (format-time-string
14216 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14217 (prompt (concat (if prompt (concat prompt " ") "")
14218 (format "Date+time [%s]: " timestr)))
14219 ans (org-ans0 "") org-ans1 org-ans2 final)
14221 (cond
14222 (from-string (setq ans from-string))
14223 (org-read-date-popup-calendar
14224 (save-excursion
14225 (save-window-excursion
14226 (calendar)
14227 (calendar-forward-day (- (time-to-days def)
14228 (calendar-absolute-from-gregorian
14229 (calendar-current-date))))
14230 (org-eval-in-calendar nil t)
14231 (let* ((old-map (current-local-map))
14232 (map (copy-keymap calendar-mode-map))
14233 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14234 (org-defkey map (kbd "RET") 'org-calendar-select)
14235 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14236 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14237 (org-defkey minibuffer-local-map [(meta shift left)]
14238 (lambda () (interactive)
14239 (org-eval-in-calendar '(calendar-backward-month 1))))
14240 (org-defkey minibuffer-local-map [(meta shift right)]
14241 (lambda () (interactive)
14242 (org-eval-in-calendar '(calendar-forward-month 1))))
14243 (org-defkey minibuffer-local-map [(meta shift up)]
14244 (lambda () (interactive)
14245 (org-eval-in-calendar '(calendar-backward-year 1))))
14246 (org-defkey minibuffer-local-map [(meta shift down)]
14247 (lambda () (interactive)
14248 (org-eval-in-calendar '(calendar-forward-year 1))))
14249 (org-defkey minibuffer-local-map [?\e (shift left)]
14250 (lambda () (interactive)
14251 (org-eval-in-calendar '(calendar-backward-month 1))))
14252 (org-defkey minibuffer-local-map [?\e (shift right)]
14253 (lambda () (interactive)
14254 (org-eval-in-calendar '(calendar-forward-month 1))))
14255 (org-defkey minibuffer-local-map [?\e (shift up)]
14256 (lambda () (interactive)
14257 (org-eval-in-calendar '(calendar-backward-year 1))))
14258 (org-defkey minibuffer-local-map [?\e (shift down)]
14259 (lambda () (interactive)
14260 (org-eval-in-calendar '(calendar-forward-year 1))))
14261 (org-defkey minibuffer-local-map [(shift up)]
14262 (lambda () (interactive)
14263 (org-eval-in-calendar '(calendar-backward-week 1))))
14264 (org-defkey minibuffer-local-map [(shift down)]
14265 (lambda () (interactive)
14266 (org-eval-in-calendar '(calendar-forward-week 1))))
14267 (org-defkey minibuffer-local-map [(shift left)]
14268 (lambda () (interactive)
14269 (org-eval-in-calendar '(calendar-backward-day 1))))
14270 (org-defkey minibuffer-local-map [(shift right)]
14271 (lambda () (interactive)
14272 (org-eval-in-calendar '(calendar-forward-day 1))))
14273 (org-defkey minibuffer-local-map ">"
14274 (lambda () (interactive)
14275 (org-eval-in-calendar '(scroll-calendar-left 1))))
14276 (org-defkey minibuffer-local-map "<"
14277 (lambda () (interactive)
14278 (org-eval-in-calendar '(scroll-calendar-right 1))))
14279 (org-defkey minibuffer-local-map "\C-v"
14280 (lambda () (interactive)
14281 (org-eval-in-calendar
14282 '(calendar-scroll-left-three-months 1))))
14283 (org-defkey minibuffer-local-map "\M-v"
14284 (lambda () (interactive)
14285 (org-eval-in-calendar
14286 '(calendar-scroll-right-three-months 1))))
14287 (run-hooks 'org-read-date-minibuffer-setup-hook)
14288 (unwind-protect
14289 (progn
14290 (use-local-map map)
14291 (add-hook 'post-command-hook 'org-read-date-display)
14292 (setq org-ans0 (read-string prompt default-input
14293 'org-read-date-history nil))
14294 ;; org-ans0: from prompt
14295 ;; org-ans1: from mouse click
14296 ;; org-ans2: from calendar motion
14297 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14298 (remove-hook 'post-command-hook 'org-read-date-display)
14299 (use-local-map old-map)
14300 (when org-read-date-overlay
14301 (delete-overlay org-read-date-overlay)
14302 (setq org-read-date-overlay nil)))))))
14304 (t ; Naked prompt only
14305 (unwind-protect
14306 (setq ans (read-string prompt default-input
14307 'org-read-date-history timestr))
14308 (when org-read-date-overlay
14309 (delete-overlay org-read-date-overlay)
14310 (setq org-read-date-overlay nil)))))
14312 (setq final (org-read-date-analyze ans def defdecode))
14314 ;; One round trip to get rid of 34th of August and stuff like that....
14315 (setq final (decode-time (apply 'encode-time final)))
14317 (setq org-read-date-final-answer ans)
14319 (if to-time
14320 (apply 'encode-time final)
14321 (if (and (boundp 'org-time-was-given) org-time-was-given)
14322 (format "%04d-%02d-%02d %02d:%02d"
14323 (nth 5 final) (nth 4 final) (nth 3 final)
14324 (nth 2 final) (nth 1 final))
14325 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14327 (defvar def)
14328 (defvar defdecode)
14329 (defvar with-time)
14330 (defvar org-read-date-analyze-futurep nil)
14331 (defun org-read-date-display ()
14332 "Display the current date prompt interpretation in the minibuffer."
14333 (when org-read-date-display-live
14334 (when org-read-date-overlay
14335 (delete-overlay org-read-date-overlay))
14336 (let ((p (point)))
14337 (end-of-line 1)
14338 (while (not (equal (buffer-substring
14339 (max (point-min) (- (point) 4)) (point))
14340 " "))
14341 (insert " "))
14342 (goto-char p))
14343 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14344 " " (or org-ans1 org-ans2)))
14345 (org-end-time-was-given nil)
14346 (f (org-read-date-analyze ans def defdecode))
14347 (fmts (if org-dcst
14348 org-time-stamp-custom-formats
14349 org-time-stamp-formats))
14350 (fmt (if (or with-time
14351 (and (boundp 'org-time-was-given) org-time-was-given))
14352 (cdr fmts)
14353 (car fmts)))
14354 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14355 (when (and org-end-time-was-given
14356 (string-match org-plain-time-of-day-regexp txt))
14357 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14358 org-end-time-was-given
14359 (substring txt (match-end 0)))))
14360 (when org-read-date-analyze-futurep
14361 (setq txt (concat txt " (=>F)")))
14362 (setq org-read-date-overlay
14363 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14364 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14366 (defun org-read-date-analyze (ans def defdecode)
14367 "Analyze the combined answer of the date prompt."
14368 ;; FIXME: cleanup and comment
14369 (let ((nowdecode (decode-time (current-time)))
14370 delta deltan deltaw deltadef year month day
14371 hour minute second wday pm h2 m2 tl wday1
14372 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14373 (setq org-read-date-analyze-futurep nil)
14375 (setq ans "+0"))
14377 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14378 (setq ans (replace-match "" t t ans)
14379 deltan (car delta)
14380 deltaw (nth 1 delta)
14381 deltadef (nth 2 delta)))
14383 ;; Check if there is an iso week date in there
14384 ;; If yes, store the info and postpone interpreting it until the rest
14385 ;; of the parsing is done
14386 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14387 (setq iso-year (if (match-end 1)
14388 (org-small-year-to-year
14389 (string-to-number (match-string 1 ans))))
14390 iso-weekday (if (match-end 3)
14391 (string-to-number (match-string 3 ans)))
14392 iso-week (string-to-number (match-string 2 ans)))
14393 (setq ans (replace-match "" t t ans)))
14395 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14396 (when (string-match
14398 (setq year (if (match-end 2)
14399 (string-to-number (match-string 2 ans))
14400 (progn (setq kill-year t)
14401 (string-to-number (format-time-string "%Y"))))
14402 month (string-to-number (match-string 3 ans))
14403 day (string-to-number (match-string 4 ans)))
14404 (if (< year 100) (setq year (+ 2000 year)))
14406 t nil ans)))
14407 ;; Help matching american dates, like 5/30 or 5/30/7
14408 (when (string-match
14409 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14410 (setq year (if (match-end 4)
14411 (string-to-number (match-string 4 ans))
14412 (progn (setq kill-year t)
14413 (string-to-number (format-time-string "%Y"))))
14414 month (string-to-number (match-string 1 ans))
14415 day (string-to-number (match-string 2 ans)))
14416 (if (< year 100) (setq year (+ 2000 year)))
14418 t nil ans)))
14419 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14420 ;; If there is a time with am/pm, and *no* time without it, we convert
14421 ;; so that matching will be successful.
14422 (loop for i from 1 to 2 do ; twice, for end time as well
14425 (setq hour (string-to-number (match-string 1 ans))
14426 minute (if (match-end 3)
14427 (string-to-number (match-string 3 ans))
14428 0)
14429 pm (equal ?p
14430 (string-to-char (downcase (match-string 4 ans)))))
14431 (if (and (= hour 12) (not pm))
14432 (setq hour 0)
14433 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14434 (setq ans (replace-match (format "%02d:%02d" hour minute)
14435 t t ans))))
14437 ;; Check if a time range is given as a duration
14438 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14439 (setq hour (string-to-number (match-string 1 ans))
14440 h2 (+ hour (string-to-number (match-string 3 ans)))
14441 minute (string-to-number (match-string 2 ans))
14442 m2 (+ minute (if (match-end 5) (string-to-number
14443 (match-string 5 ans))0)))
14444 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14445 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14446 t t ans)))
14448 ;; Check if there is a time range
14449 (when (boundp 'org-end-time-was-given)
14450 (setq org-time-was-given nil)
14451 (when (and (string-match org-plain-time-of-day-regexp ans)
14452 (match-end 8))
14453 (setq org-end-time-was-given (match-string 8 ans))
14454 (setq ans (concat (substring ans 0 (match-beginning 7))
14455 (substring ans (match-end 7))))))
14457 (setq tl (parse-time-string ans)
14458 day (or (nth 3 tl) (nth 3 defdecode))
14459 month (or (nth 4 tl)
14460 (if (and org-read-date-prefer-future
14461 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14462 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14463 (nth 4 defdecode)))
14464 year (or (and (not kill-year) (nth 5 tl))
14465 (if (and org-read-date-prefer-future
14466 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14467 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14468 (nth 5 defdecode)))
14469 hour (or (nth 2 tl) (nth 2 defdecode))
14470 minute (or (nth 1 tl) (nth 1 defdecode))
14471 second (or (nth 0 tl) 0)
14472 wday (nth 6 tl))
14474 (when (and (eq org-read-date-prefer-future 'time)
14475 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14476 (equal day (nth 3 nowdecode))
14477 (equal month (nth 4 nowdecode))
14478 (equal year (nth 5 nowdecode))
14479 (nth 2 tl)
14480 (or (< (nth 2 tl) (nth 2 nowdecode))
14481 (and (= (nth 2 tl) (nth 2 nowdecode))
14482 (nth 1 tl)
14483 (< (nth 1 tl) (nth 1 nowdecode)))))
14484 (setq day (1+ day)
14485 futurep t))
14487 ;; Special date definitions below
14488 (cond
14489 (iso-week
14490 ;; There was an iso week
14491 (require 'cal-iso)
14492 (setq futurep nil)
14493 (setq year (or iso-year year)
14494 day (or iso-weekday wday 1)
14495 wday nil ; to make sure that the trigger below does not match
14496 iso-date (calendar-gregorian-from-absolute
14497 (calendar-absolute-from-iso
14498 (list iso-week day year))))
14499 ; FIXME: Should we also push ISO weeks into the future?
14500 ; (when (and org-read-date-prefer-future
14501 ; (not iso-year)
14502 ; (< (calendar-absolute-from-gregorian iso-date)
14503 ; (time-to-days (current-time))))
14504 ; (setq year (1+ year)
14505 ; iso-date (calendar-gregorian-from-absolute
14506 ; (calendar-absolute-from-iso
14507 ; (list iso-week day year)))))
14508 (setq month (car iso-date)
14509 year (nth 2 iso-date)
14510 day (nth 1 iso-date)))
14511 (deltan
14512 (setq futurep nil)
14513 (unless deltadef
14514 (let ((now (decode-time (current-time))))
14515 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14516 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14517 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14518 ((equal deltaw "m") (setq month (+ month deltan)))
14519 ((equal deltaw "y") (setq year (+ year deltan)))))
14520 ((and wday (not (nth 3 tl)))
14521 (setq futurep nil)
14522 ;; Weekday was given, but no day, so pick that day in the week
14523 ;; on or after the derived date.
14524 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14525 (unless (equal wday wday1)
14526 (setq day (+ day (% (- wday wday1 -7) 7))))))
14527 (if (and (boundp 'org-time-was-given)
14528 (nth 2 tl))
14529 (setq org-time-was-given t))
14530 (if (< year 100) (setq year (+ 2000 year)))
14531 (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
14532 (setq org-read-date-analyze-futurep futurep)
14533 (list second minute hour day month year)))
14535 (defvar parse-time-weekdays)
14537 (defun org-read-date-get-relative (s today default)
14538 "Check string S for special relative date string.
14539 TODAY and DEFAULT are internal times, for today and for a default.
14540 Return shift list (N what def-flag)
14542 N is the number of WHATs to shift.
14543 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14544 the DEFAULT date rather than TODAY."
14545 (when (and
14546 (string-match
14547 (concat
14552 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14553 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14554 (string-to-char (substring (match-string 1 s) -1))
14555 ?+))
14556 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14557 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14558 (what (if (match-end 3) (match-string 3 s) "d"))
14559 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14560 (date (if rel default today))
14561 (wday (nth 6 (decode-time date)))
14562 delta)
14563 (if wday1
14564 (progn
14565 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14566 (if (= dir ?-) (setq delta (- delta 7)))
14567 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14568 (list delta "d" rel))
14569 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14571 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14572 "Turn a user-specified date into the internal representation.
14573 The internal representation needed by the calendar is (month day year).
14574 This is a wrapper to handle the brain-dead convention in calendar that
14575 user function argument order change dependent on argument order."
14576 (if (boundp 'calendar-date-style)
14577 (cond
14578 ((eq calendar-date-style 'american)
14579 (list arg1 arg2 arg3))
14580 ((eq calendar-date-style 'european)
14581 (list arg2 arg1 arg3))
14582 ((eq calendar-date-style 'iso)
14583 (list arg2 arg3 arg1)))
14584 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
14585 (if (org-bound-and-true-p european-calendar-style)
14586 (list arg2 arg1 arg3)
14587 (list arg1 arg2 arg3)))))
14589 (defun org-eval-in-calendar (form &optional keepdate)
14590 "Eval FORM in the calendar window and return to current window.
14591 Also, store the cursor date in variable org-ans2."
14592 (let ((sf (selected-frame))
14593 (sw (selected-window)))
14594 (select-window (get-buffer-window "*Calendar*" t))
14595 (eval form)
14596 (when (and (not keepdate) (calendar-cursor-to-date))
14597 (let* ((date (calendar-cursor-to-date))
14598 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14599 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
14600 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
14601 (select-window sw)
14602 (org-select-frame-set-input-focus sf)))
14604 (defun org-calendar-select ()
14605 "Return to `org-read-date' with the date currently selected.
14606 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14607 (interactive)
14608 (when (calendar-cursor-to-date)
14609 (let* ((date (calendar-cursor-to-date))
14610 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14611 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14612 (if (active-minibuffer-window) (exit-minibuffer))))
14614 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
14615 "Insert a date stamp for the date given by the internal TIME.
14616 WITH-HM means use the stamp format that includes the time of the day.
14617 INACTIVE means use square brackets instead of angular ones, so that the
14618 stamp will not contribute to the agenda.
14619 PRE and POST are optional strings to be inserted before and after the
14620 stamp.
14621 The command returns the inserted time stamp."
14622 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
14623 stamp)
14624 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
14625 (insert-before-markers (or pre ""))
14626 (when (listp extra)
14627 (setq extra (car extra))
14628 (if (and (stringp extra)
14630 (setq extra (format "-%02d:%02d"
14631 (string-to-number (match-string 1 extra))
14632 (string-to-number (match-string 2 extra))))
14633 (setq extra nil)))
14634 (when extra
14635 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
14636 (insert-before-markers (setq stamp (format-time-string fmt time)))
14637 (insert-before-markers (or post ""))
14638 (setq org-last-inserted-timestamp stamp)))
14640 (defun org-toggle-time-stamp-overlays ()
14641 "Toggle the use of custom time stamp formats."
14642 (interactive)
14643 (setq org-display-custom-times (not org-display-custom-times))
14644 (unless org-display-custom-times
14645 (let ((p (point-min)) (bmp (buffer-modified-p)))
14646 (while (setq p (next-single-property-change p 'display))
14647 (if (and (get-text-property p 'display)
14648 (eq (get-text-property p 'face) 'org-date))
14649 (remove-text-properties
14650 p (setq p (next-single-property-change p 'display))
14651 '(display t))))
14652 (set-buffer-modified-p bmp)))
14653 (if (featurep 'xemacs)
14654 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
14655 (org-restart-font-lock)
14656 (setq org-table-may-need-update t)
14657 (if org-display-custom-times
14658 (message "Time stamps are overlayed with custom format")
14659 (message "Time stamp overlays removed")))
14661 (defun org-display-custom-time (beg end)
14662 "Overlay modified time stamp format over timestamp between BEG and END."
14663 (let* ((ts (buffer-substring beg end))
14664 t1 w1 with-hm tf time str w2 (off 0))
14665 (save-match-data
14666 (setq t1 (org-parse-time-string ts t))
14667 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
14668 (setq off (- (match-end 0) (match-beginning 0)))))
14669 (setq end (- end off))
14670 (setq w1 (- end beg)
14671 with-hm (and (nth 1 t1) (nth 2 t1))
14672 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
14673 time (org-fix-decoded-time t1)
14674 str (org-add-props
14675 (format-time-string
14676 (substring tf 1 -1) (apply 'encode-time time))
14677 nil 'mouse-face 'highlight)
14678 w2 (length str))
14679 (if (not (= w2 w1))
14680 (add-text-properties (1+ beg) (+ 2 beg)
14681 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
14682 (if (featurep 'xemacs)
14683 (progn
14684 (put-text-property beg end 'invisible t)
14685 (put-text-property beg end 'end-glyph (make-glyph str)))
14686 (put-text-property beg end 'display str))))
14688 (defun org-translate-time (string)
14689 "Translate all timestamps in STRING to custom format.
14690 But do this only if the variable `org-display-custom-times' is set."
14691 (when org-display-custom-times
14692 (save-match-data
14693 (let* ((start 0)
14694 (re org-ts-regexp-both)
14695 t1 with-hm inactive tf time str beg end)
14696 (while (setq start (string-match re string start))
14697 (setq beg (match-beginning 0)
14698 end (match-end 0)
14699 t1 (save-match-data
14700 (org-parse-time-string (substring string beg end) t))
14701 with-hm (and (nth 1 t1) (nth 2 t1))
14702 inactive (equal (substring string beg (1+ beg)) "[")
14703 tf (funcall (if with-hm 'cdr 'car)
14704 org-time-stamp-custom-formats)
14705 time (org-fix-decoded-time t1)
14706 str (format-time-string
14707 (concat
14708 (if inactive "[" "<") (substring tf 1 -1)
14709 (if inactive "]" ">"))
14710 (apply 'encode-time time))
14711 string (replace-match str t t string)
14712 start (+ start (length str)))))))
14713 string)
14715 (defun org-fix-decoded-time (time)
14716 "Set 0 instead of nil for the first 6 elements of time.
14717 Don't touch the rest."
14718 (let ((n 0))
14719 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
14721 (defun org-days-to-time (timestamp-string)
14722 "Difference between TIMESTAMP-STRING and now in days."
14723 (- (time-to-days (org-time-string-to-time timestamp-string))
14724 (time-to-days (current-time))))
14726 (defun org-deadline-close (timestamp-string &optional ndays)
14727 "Is the time in TIMESTAMP-STRING close to the current date?"
14728 (setq ndays (or ndays (org-get-wdays timestamp-string)))
14729 (and (< (org-days-to-time timestamp-string) ndays)
14730 (not (org-entry-is-done-p))))
14732 (defun org-get-wdays (ts)
14733 "Get the deadline lead time appropriate for timestring TS."
14734 (cond
14735 ((<= org-deadline-warning-days 0)
14736 ;; 0 or negative, enforce this value no matter what
14737 (- org-deadline-warning-days))
14739 ;; lead time is specified.
14740 (floor (* (string-to-number (match-string 1 ts))
14741 (cdr (assoc (match-string 2 ts)
14742 '(("d" . 1) ("w" . 7)
14743 ("m" . 30.4) ("y" . 365.25)))))))
14744 ;; go for the default.
14745 (t org-deadline-warning-days)))
14747 (defun org-calendar-select-mouse (ev)
14748 "Return to `org-read-date' with the date currently selected.
14749 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14750 (interactive "e")
14751 (mouse-set-point ev)
14752 (when (calendar-cursor-to-date)
14753 (let* ((date (calendar-cursor-to-date))
14754 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14755 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14756 (if (active-minibuffer-window) (exit-minibuffer))))
14758 (defun org-check-deadlines (ndays)
14759 "Check if there are any deadlines due or past due.
14760 A deadline is considered due if it happens within `org-deadline-warning-days'
14761 days from today's date. If the deadline appears in an entry marked DONE,
14762 it is not shown. The prefix arg NDAYS can be used to test that many
14764 (interactive "P")
14765 (let* ((org-warn-days
14766 (cond
14767 ((equal ndays '(4)) 100000)
14768 (ndays (prefix-numeric-value ndays))
14769 (t (abs org-deadline-warning-days))))
14770 (case-fold-search nil)
14772 (callback
14773 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
14775 (message "%d deadlines past-due or due within %d days"
14776 (org-occur regexp nil callback)
14777 org-warn-days)))
14779 (defun org-check-before-date (date)
14780 "Check if there are deadlines or scheduled entries before DATE."
14781 (interactive (list (org-read-date)))
14782 (let ((case-fold-search nil)
14786 (callback
14787 (lambda () (time-less-p
14788 (org-time-string-to-time (match-string 2))
14789 (org-time-string-to-time date)))))
14790 (message "%d entries before %s"
14791 (org-occur regexp nil callback) date)))
14793 (defun org-check-after-date (date)
14794 "Check if there are deadlines or scheduled entries after DATE."
14795 (interactive (list (org-read-date)))
14796 (let ((case-fold-search nil)
14800 (callback
14801 (lambda () (not
14802 (time-less-p
14803 (org-time-string-to-time (match-string 2))
14804 (org-time-string-to-time date))))))
14805 (message "%d entries after %s"
14806 (org-occur regexp nil callback) date)))
14808 (defun org-evaluate-time-range (&optional to-buffer)
14809 "Evaluate a time range by computing the difference between start and end.
14810 Normally the result is just printed in the echo area, but with prefix arg
14811 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
14812 If the time range is actually in a table, the result is inserted into the
14813 next column.
14814 For time difference computation, a year is assumed to be exactly 365
14815 days in order to avoid rounding problems."
14816 (interactive "P")
14817 (or
14818 (org-clock-update-time-maybe)
14819 (save-excursion
14820 (unless (org-at-date-range-p t)
14821 (goto-char (point-at-bol))
14822 (re-search-forward org-tr-regexp-both (point-at-eol) t))
14823 (if (not (org-at-date-range-p t))
14824 (error "Not at a time-stamp range, and none found in current line")))
14825 (let* ((ts1 (match-string 1))
14826 (ts2 (match-string 2))
14827 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
14828 (match-end (match-end 0))
14829 (time1 (org-time-string-to-time ts1))
14830 (time2 (org-time-string-to-time ts2))
14831 (t1 (org-float-time time1))
14832 (t2 (org-float-time time2))
14833 (diff (abs (- t2 t1)))
14834 (negative (< (- t2 t1) 0))
14835 ;; (ys (floor (* 365 24 60 60)))
14836 (ds (* 24 60 60))
14837 (hs (* 60 60))
14838 (fy "%dy %dd %02d:%02d")
14839 (fy1 "%dy %dd")
14840 (fd "%dd %02d:%02d")
14841 (fd1 "%dd")
14842 (fh "%02d:%02d")
14843 y d h m align)
14844 (if havetime
14845 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14846 y 0
14847 d (floor (/ diff ds)) diff (mod diff ds)
14848 h (floor (/ diff hs)) diff (mod diff hs)
14849 m (floor (/ diff 60)))
14850 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14851 y 0
14852 d (floor (+ (/ diff ds) 0.5))
14853 h 0 m 0))
14854 (if (not to-buffer)
14855 (message "%s" (org-make-tdiff-string y d h m))
14856 (if (org-at-table-p)
14857 (progn
14858 (goto-char match-end)
14859 (setq align t)
14860 (and (looking-at " *|") (goto-char (match-end 0))))
14861 (goto-char match-end))
14862 (if (looking-at
14864 (replace-match ""))
14865 (if negative (insert " -"))
14866 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
14867 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
14868 (insert " " (format fh h m))))
14869 (if align (org-table-align))
14870 (message "Time difference inserted")))))
14872 (defun org-make-tdiff-string (y d h m)
14873 (let ((fmt "")
14874 (l nil))
14875 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
14876 l (push y l)))
14877 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
14878 l (push d l)))
14879 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
14880 l (push h l)))
14881 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
14882 l (push m l)))
14883 (apply 'format fmt (nreverse l))))
14885 (defun org-time-string-to-time (s)
14886 (apply 'encode-time (org-parse-time-string s)))
14887 (defun org-time-string-to-seconds (s)
14888 (org-float-time (org-time-string-to-time s)))
14890 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
14891 "Convert a time stamp to an absolute day number.
14892 If there is a specifier for a cyclic time stamp, get the closest date to
14893 DAYNR.
14894 PREFER and SHOW-ALL are passed through to `org-closest-date'.
14895 the variable date is bound by the calendar when this is called."
14896 (cond
14898 (if (org-diary-sexp-entry (match-string 1 s) "" date)
14899 daynr
14900 (+ daynr 1000)))
14902 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
14903 (time-to-days (current-time))) (match-string 0 s)
14904 prefer show-all))
14905 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
14907 (defun org-days-to-iso-week (days)
14908 "Return the iso week number."
14909 (require 'cal-iso)
14910 (car (calendar-iso-from-absolute days)))
14912 (defun org-small-year-to-year (year)
14913 "Convert 2-digit years into 4-digit years.
14914 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
14915 The year 2000 cannot be abbreviated. Any year larger than 99
14916 is returned unchanged."
14917 (if (< year 38)
14918 (setq year (+ 2000 year))
14919 (if (< year 100)
14920 (setq year (+ 1900 year))))
14921 year)
14923 (defun org-time-from-absolute (d)
14924 "Return the time corresponding to date D.
14925 D may be an absolute day number, or a calendar-type list (month day year)."
14926 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
14927 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
14929 (defun org-calendar-holiday ()
14930 "List of holidays, for Diary display in Org-mode."
14931 (require 'holidays)
14932 (let ((hl (funcall
14933 (if (fboundp 'calendar-check-holidays)
14934 'calendar-check-holidays 'check-calendar-holidays) date)))
14935 (if hl (mapconcat 'identity hl "; "))))
14937 (defun org-diary-sexp-entry (sexp entry date)
14938 "Process a SEXP diary ENTRY for DATE."
14939 (require 'diary-lib)
14940 (let ((result (if calendar-debug-sexp
14941 (let ((stack-trace-on-error t))
14942 (eval (car (read-from-string sexp))))
14943 (condition-case nil
14944 (eval (car (read-from-string sexp)))
14945 (error
14946 (beep)
14947 (message "Bad sexp at line %d in %s: %s"
14948 (org-current-line)
14949 (buffer-file-name) sexp)
14950 (sleep-for 2))))))
14951 (cond ((stringp result) (split-string result "; "))
14952 ((and (consp result)
14953 (not (consp (cdr result)))
14954 (stringp (cdr result))) (cdr result))
14955 ((and (consp result)
14956 (stringp (car result))) result)
14957 (result entry)
14958 (t nil))))
14960 (defun org-diary-to-ical-string (frombuf)
14961 "Get iCalendar entries from diary entries in buffer FROMBUF.
14962 This uses the icalendar.el library."
14963 (let* ((tmpdir (if (featurep 'xemacs)
14964 (temp-directory)
14965 temporary-file-directory))
14966 (tmpfile (make-temp-name
14967 (expand-file-name "orgics" tmpdir)))
14968 buf rtn b e)
14969 (with-current-buffer frombuf
14970 (icalendar-export-region (point-min) (point-max) tmpfile)
14971 (setq buf (find-buffer-visiting tmpfile))
14972 (set-buffer buf)
14973 (goto-char (point-min))
14974 (if (re-search-forward "^BEGIN:VEVENT" nil t)
14975 (setq b (match-beginning 0)))
14976 (goto-char (point-max))
14977 (if (re-search-backward "^END:VEVENT" nil t)
14978 (setq e (match-end 0)))
14980 (kill-buffer buf)
14981 (delete-file tmpfile)
14982 rtn))
14984 (defun org-closest-date (start current change prefer show-all)
14985 "Find the date closest to CURRENT that is consistent with START and CHANGE.
14986 When PREFER is `past' return a date that is either CURRENT or past.
14987 When PREFER is `future', return a date that is either CURRENT or future.
14988 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
14989 ;; Make the proper lists from the dates
14990 (catch 'exit
14991 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
14992 dn dw sday cday n1 n2 n0
14993 d m y y1 y2 date1 date2 nmonths nm ny m2)
14995 (setq start (org-date-to-gregorian start)
14996 current (org-date-to-gregorian
14997 (if show-all
14998 current
14999 (time-to-days (current-time))))
15000 sday (calendar-absolute-from-gregorian start)
15001 cday (calendar-absolute-from-gregorian current))
15003 (if (<= cday sday) (throw 'exit sday))
15006 (setq dn (string-to-number (match-string 1 change))
15007 dw (cdr (assoc (match-string 2 change) a1)))
15008 (error "Invalid change specifier: %s" change))
15009 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15010 (cond
15011 ((eq dw 'day)
15012 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15013 n2 (+ n1 dn)))
15014 ((eq dw 'year)
15015 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15016 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15017 (setq date1 (list m d y1)
15018 n1 (calendar-absolute-from-gregorian date1)
15019 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15020 n2 (calendar-absolute-from-gregorian date2)))
15021 ((eq dw 'month)
15022 ;; approx number of month between the two dates
15023 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15024 ;; How often does dn fit in there?
15025 (setq d (nth 1 start) m (car start) y (nth 2 start)
15026 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15027 m (+ m nm)
15028 ny (floor (/ m 12))
15029 y (+ y ny)
15030 m (- m (* ny 12)))
15031 (while (> m 12) (setq m (- m 12) y (1+ y)))
15032 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15033 (setq m2 (+ m dn) y2 y)
15034 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15035 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15036 (while (<= n2 cday)
15037 (setq n1 n2 m m2 y y2)
15038 (setq m2 (+ m dn) y2 y)
15039 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15040 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15041 ;; Make sure n1 is the earlier date
15042 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15043 (if show-all
15044 (cond
15045 ((eq prefer 'past) (if (= cday n2) n2 n1))
15046 ((eq prefer 'future) (if (= cday n1) n1 n2))
15047 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15048 (cond
15049 ((eq prefer 'past) (if (= cday n2) n2 n1))
15050 ((eq prefer 'future) (if (= cday n1) n1 n2))
15051 (t (if (= cday n1) n1 n2)))))))
15053 (defun org-date-to-gregorian (date)
15054 "Turn any specification of DATE into a Gregorian date for the calendar."
15055 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15056 ((and (listp date) (= (length date) 3)) date)
15057 ((stringp date)
15058 (setq date (org-parse-time-string date))
15059 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15060 ((listp date)
15061 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15063 (defun org-parse-time-string (s &optional nodefault)
15064 "Parse the standard Org-mode time string.
15065 This should be a lot faster than the normal `parse-time-string'.
15066 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15067 hour and minute fields will be nil if not given."
15068 (if (string-match org-ts-regexp0 s)
15069 (list 0
15070 (if (or (match-beginning 8) (not nodefault))
15071 (string-to-number (or (match-string 8 s) "0")))
15072 (if (or (match-beginning 7) (not nodefault))
15073 (string-to-number (or (match-string 7 s) "0")))
15074 (string-to-number (match-string 4 s))
15075 (string-to-number (match-string 3 s))
15076 (string-to-number (match-string 2 s))
15077 nil nil nil)
15078 (error "Not a standard Org-mode time string: %s" s)))
15080 (defun org-timestamp-up (&optional arg)
15081 "Increase the date item at the cursor by one.
15082 If the cursor is on the year, change the year. If it is on the month or
15083 the day, change that.
15084 With prefix ARG, change by that many units."
15085 (interactive "p")
15086 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15088 (defun org-timestamp-down (&optional arg)
15089 "Decrease the date item at the cursor by one.
15090 If the cursor is on the year, change the year. If it is on the month or
15091 the day, change that.
15092 With prefix ARG, change by that many units."
15093 (interactive "p")
15094 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15096 (defun org-timestamp-up-day (&optional arg)
15097 "Increase the date in the time stamp by one day.
15098 With prefix ARG, change that many days."
15099 (interactive "p")
15100 (if (and (not (org-at-timestamp-p t))
15101 (org-on-heading-p))
15102 (org-todo 'up)
15103 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15105 (defun org-timestamp-down-day (&optional arg)
15106 "Decrease the date in the time stamp by one day.
15107 With prefix ARG, change that many days."
15108 (interactive "p")
15109 (if (and (not (org-at-timestamp-p t))
15110 (org-on-heading-p))
15111 (org-todo 'down)
15112 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15114 (defun org-at-timestamp-p (&optional inactive-ok)
15115 "Determine if the cursor is in or at a timestamp."
15116 (interactive)
15117 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15118 (pos (point))
15119 (ans (or (looking-at tsr)
15120 (save-excursion
15122 (if (> (point) (point-min)) (backward-char 1))
15123 (and (looking-at tsr)
15124 (> (- (match-end 0) pos) -1))))))
15125 (and ans
15126 (boundp 'org-ts-what)
15127 (setq org-ts-what
15128 (cond
15129 ((= pos (match-beginning 0)) 'bracket)
15130 ((= pos (1- (match-end 0))) 'bracket)
15131 ((org-pos-in-match-range pos 2) 'year)
15132 ((org-pos-in-match-range pos 3) 'month)
15133 ((org-pos-in-match-range pos 7) 'hour)
15134 ((org-pos-in-match-range pos 8) 'minute)
15135 ((or (org-pos-in-match-range pos 4)
15136 (org-pos-in-match-range pos 5)) 'day)
15137 ((and (> pos (or (match-end 8) (match-end 5)))
15138 (< pos (match-end 0)))
15139 (- pos (or (match-end 8) (match-end 5))))
15140 (t 'day))))
15141 ans))
15143 (defun org-toggle-timestamp-type ()
15144 "Toggle the type (<active> or [inactive]) of a time stamp."
15145 (interactive)
15146 (when (org-at-timestamp-p t)
15147 (let ((beg (match-beginning 0)) (end (match-end 0))
15148 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15149 (save-excursion
15150 (goto-char beg)
15151 (while (re-search-forward "[][<>]" end t)
15152 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15153 t t)))
15154 (message "Timestamp is now %sactive"
15155 (if (equal (char-after beg) ?<) "" "in")))))
15157 (defun org-timestamp-change (n &optional what updown)
15158 "Change the date in the time stamp at point.
15159 The date will be changed by N times WHAT. WHAT can be `day', `month',
15160 `year', `minute', `second'. If WHAT is not given, the cursor position
15161 in the timestamp determines what will be changed."
15162 (let ((pos (point))
15163 with-hm inactive
15164 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15165 org-ts-what
15166 extra rem
15167 ts time time0)
15168 (if (not (org-at-timestamp-p t))
15169 (error "Not at a timestamp"))
15170 (if (and (not what) (eq org-ts-what 'bracket))
15171 (org-toggle-timestamp-type)
15172 (if (and (not what) (not (eq org-ts-what 'day))
15173 org-display-custom-times
15174 (get-text-property (point) 'display)
15175 (not (get-text-property (1- (point)) 'display)))
15176 (setq org-ts-what 'day))
15177 (setq org-ts-what (or what org-ts-what)
15178 inactive (= (char-after (match-beginning 0)) ?\[)
15179 ts (match-string 0))
15180 (replace-match "")
15181 (if (string-match
15183 ts)
15184 (setq extra (match-string 1 ts)))
15186 (setq with-hm t))
15187 (setq time0 (org-parse-time-string ts))
15188 (when (and updown
15189 (eq org-ts-what 'minute)
15190 (not current-prefix-arg))
15191 ;; This looks like s-up and s-down. Change by one rounding step.
15192 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15193 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15194 (setcar (cdr time0) (+ (nth 1 time0)
15195 (if (> n 0) (- rem) (- dm rem))))))
15196 (setq time
15197 (encode-time (or (car time0) 0)
15198 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15199 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15200 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15201 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15202 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15203 (nthcdr 6 time0)))
15204 (when (and (member org-ts-what '(hour minute))
15205 extra
15207 (setq extra (org-modify-ts-extra
15208 extra
15209 (if (eq org-ts-what 'hour) 2 5)
15210 n dm)))
15211 (when (integerp org-ts-what)
15212 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15213 (if (eq what 'calendar)
15214 (let ((cal-date (org-get-date-from-calendar)))
15215 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15216 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15217 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15218 (setcar time0 (or (car time0) 0))
15219 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15220 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15221 (setq time (apply 'encode-time time0))))
15222 (setq org-last-changed-timestamp
15223 (org-insert-time-stamp time with-hm inactive nil nil extra))
15224 (org-clock-update-time-maybe)
15225 (goto-char pos)
15226 ;; Try to recenter the calendar window, if any
15227 (if (and org-calendar-follow-timestamp-change
15228 (get-buffer-window "*Calendar*" t)
15229 (memq org-ts-what '(day month year)))
15230 (org-recenter-calendar (time-to-days time))))))
15232 (defun org-modify-ts-extra (s pos n dm)
15233 "Change the different parts of the lead-time and repeat fields in timestamp."
15234 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15235 ng h m new rem)
15236 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15237 (cond
15238 ((or (org-pos-in-match-range pos 2)
15239 (org-pos-in-match-range pos 3))
15240 (setq m (string-to-number (match-string 3 s))
15241 h (string-to-number (match-string 2 s)))
15242 (if (org-pos-in-match-range pos 2)
15243 (setq h (+ h n))
15244 (setq n (* dm (org-no-warnings (signum n))))
15245 (when (not (= 0 (setq rem (% m dm))))
15246 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15247 (setq m (+ m n)))
15248 (if (< m 0) (setq m (+ m 60) h (1- h)))
15249 (if (> m 59) (setq m (- m 60) h (1+ h)))
15250 (setq h (min 24 (max 0 h)))
15251 (setq ng 1 new (format "-%02d:%02d" h m)))
15252 ((org-pos-in-match-range pos 6)
15253 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15254 ((org-pos-in-match-range pos 5)
15255 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15257 ((org-pos-in-match-range pos 9)
15258 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15259 ((org-pos-in-match-range pos 8)
15260 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15262 (when ng
15263 (setq s (concat
15264 (substring s 0 (match-beginning ng))
15265 new
15266 (substring s (match-end ng))))))
15267 s))
15269 (defun org-recenter-calendar (date)
15270 "If the calendar is visible, recenter it to DATE."
15271 (let* ((win (selected-window))
15272 (cwin (get-buffer-window "*Calendar*" t))
15273 (calendar-move-hook nil))
15274 (when cwin
15275 (select-window cwin)
15276 (calendar-goto-date (if (listp date) date
15277 (calendar-gregorian-from-absolute date)))
15278 (select-window win))))
15280 (defun org-goto-calendar (&optional arg)
15281 "Go to the Emacs calendar at the current date.
15282 If there is a time stamp in the current line, go to that date.
15283 A prefix ARG can be used to force the current date."
15284 (interactive "P")
15285 (let ((tsr org-ts-regexp) diff
15286 (calendar-move-hook nil)
15287 (calendar-view-holidays-initially-flag nil)
15288 (calendar-view-diary-initially-flag nil))
15289 (if (or (org-at-timestamp-p)
15290 (save-excursion
15291 (beginning-of-line 1)
15292 (looking-at (concat ".*" tsr))))
15293 (let ((d1 (time-to-days (current-time)))
15294 (d2 (time-to-days
15295 (org-time-string-to-time (match-string 1)))))
15296 (setq diff (- d2 d1))))
15297 (calendar)
15298 (calendar-goto-today)
15299 (if (and diff (not arg)) (calendar-forward-day diff))))
15301 (defun org-get-date-from-calendar ()
15302 "Return a list (month day year) of date at point in calendar."
15303 (with-current-buffer "*Calendar*"
15304 (save-match-data
15305 (calendar-cursor-to-date))))
15307 (defun org-date-from-calendar ()
15308 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15309 If there is already a time stamp at the cursor position, update it."
15310 (interactive)
15311 (if (org-at-timestamp-p t)
15312 (org-timestamp-change 0 'calendar)
15313 (let ((cal-date (org-get-date-from-calendar)))
15314 (org-insert-time-stamp
15315 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15317 (defun org-minutes-to-hh:mm-string (m)
15318 "Compute H:MM from a number of minutes."
15319 (let ((h (/ m 60)))
15320 (setq m (- m (* 60 h)))
15321 (format org-time-clocksum-format h m)))
15323 (defun org-hh:mm-string-to-minutes (s)
15324 "Convert a string H:MM to a number of minutes.
15325 If the string is just a number, interpret it as minutes.
15326 In fact, the first hh:mm or number in the string will be taken,
15327 there can be extra stuff in the string.
15328 If no number is found, the return value is 0."
15329 (cond
15331 (+ (* (string-to-number (match-string 1 s)) 60)
15332 (string-to-number (match-string 2 s))))
15334 (string-to-number (match-string 1 s)))
15335 (t 0)))
15337 ;;;; Files
15339 (defun org-save-all-org-buffers ()
15340 "Save all Org-mode buffers without user confirmation."
15341 (interactive)
15342 (message "Saving all Org-mode buffers...")
15343 (save-some-buffers t 'org-mode-p)
15344 (when (featurep 'org-id) (org-id-locations-save))
15345 (message "Saving all Org-mode buffers... done"))
15347 (defun org-revert-all-org-buffers ()
15348 "Revert all Org-mode buffers.
15349 Prompt for confirmation when there are unsaved changes.
15350 Be sure you know what you are doing before letting this function
15351 overwrite your changes.
15353 This function is useful in a setup where one tracks org files
15354 with a version control system, to revert on one machine after pulling
15355 changes from another. I believe the procedure must be like this:
15357 1. M-x org-save-all-org-buffers
15358 2. Pull changes from the other machine, resolve conflicts
15359 3. M-x org-revert-all-org-buffers"
15360 (interactive)
15361 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15362 (error "Abort"))
15363 (save-excursion
15364 (save-window-excursion
15365 (mapc
15366 (lambda (b)
15367 (when (and (with-current-buffer b (org-mode-p))
15368 (with-current-buffer b buffer-file-name))
15369 (switch-to-buffer b)
15370 (revert-buffer t 'no-confirm)))
15371 (buffer-list))
15372 (when (and (featurep 'org-id) org-id-track-globally)
15373 (org-id-locations-load)))))
15375 ;;;; Agenda files
15377 ;;;###autoload
15378 (defun org-switchb (&optional arg)
15379 "Switch between Org buffers.
15380 With a prefix argument, restrict available to files.
15381 With two prefix arguments, restrict available buffers to agenda files.
15383 Defaults to `iswitchb' for buffer name completion.
15384 Set `org-completion-use-ido' to make it use ido instead."
15385 (interactive "P")
15386 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15387 ((equal arg '(16)) (org-buffer-list 'agenda))
15388 (t (org-buffer-list))))
15389 (org-completion-use-iswitchb org-completion-use-iswitchb)
15390 (org-completion-use-ido org-completion-use-ido))
15391 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15392 (setq org-completion-use-iswitchb t))
15393 (switch-to-buffer
15394 (org-icompleting-read "Org buffer: "
15395 (mapcar 'list (mapcar 'buffer-name blist))
15396 nil t))))
15398 ;;; Define some older names previously used for this functionality
15399 ;;;###autoload
15400 (defalias 'org-ido-switchb 'org-switchb)
15401 ;;;###autoload
15402 (defalias 'org-iswitchb 'org-switchb)
15404 (defun org-buffer-list (&optional predicate exclude-tmp)
15405 "Return a list of Org buffers.
15406 PREDICATE can be `export', `files' or `agenda'.
15408 export restrict the list to Export buffers.
15409 files restrict the list to buffers visiting Org files.
15410 agenda restrict the list to buffers visiting agenda files.
15412 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15413 (let* ((bfn nil)
15414 (agenda-files (and (eq predicate 'agenda)
15415 (mapcar 'file-truename (org-agenda-files t))))
15416 (filter
15417 (cond
15418 ((eq predicate 'files)
15419 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
15420 ((eq predicate 'export)
15421 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15422 ((eq predicate 'agenda)
15423 (lambda (b)
15424 (with-current-buffer b
15425 (and (eq major-mode 'org-mode)
15426 (setq bfn (buffer-file-name b))
15427 (member (file-truename bfn) agenda-files)))))
15428 (t (lambda (b) (with-current-buffer b
15429 (or (eq major-mode 'org-mode)
15430 (string-match "\*Org .*Export"
15431 (buffer-name b)))))))))
15432 (delq nil
15433 (mapcar
15434 (lambda(b)
15435 (if (and (funcall filter b)
15436 (or (not exclude-tmp)
15437 (not (string-match "tmp" (buffer-name b)))))
15438 b
15439 nil))
15440 (buffer-list)))))
15442 (defun org-agenda-files (&optional unrestricted archives)
15443 "Get the list of agenda files.
15444 Optional UNRESTRICTED means return the full list even if a restriction
15445 is currently in place.
15446 When ARCHIVES is t, include all archive files that are really being
15447 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15448 `org-agenda-archives-mode' is t."
15449 (let ((files
15450 (cond
15451 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15452 ((stringp org-agenda-files) (org-read-agenda-file-list))
15453 ((listp org-agenda-files) org-agenda-files)
15454 (t (error "Invalid value of `org-agenda-files'")))))
15455 (setq files (apply 'append
15456 (mapcar (lambda (f)
15457 (if (file-directory-p f)
15458 (directory-files
15459 f t org-agenda-file-regexp)
15460 (list f)))
15461 files)))
15462 (when org-agenda-skip-unavailable-files
15463 (setq files (delq nil
15464 (mapcar (function
15465 (lambda (file)
15466 (and (file-readable-p file) file)))
15467 files))))
15468 (when (or (eq archives t)
15469 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15470 (setq files (org-add-archive-files files)))
15471 files))
15473 (defun org-agenda-file-p (&optional file)
15474 "Return non-nil, if FILE is an agenda file.
15475 If FILE is omitted, use the file associated with the current
15476 buffer."
15477 (member (or file (buffer-file-name))
15478 (org-agenda-files t)))
15480 (defun org-edit-agenda-file-list ()
15481 "Edit the list of agenda files.
15482 Depending on setup, this either uses customize to edit the variable
15483 `org-agenda-files', or it visits the file that is holding the list. In the
15484 latter case, the buffer is set up in a way that saving it automatically kills
15485 the buffer and restores the previous window configuration."
15486 (interactive)
15487 (if (stringp org-agenda-files)
15488 (let ((cw (current-window-configuration)))
15489 (find-file org-agenda-files)
15490 (org-set-local 'org-window-configuration cw)
15491 (org-add-hook 'after-save-hook
15492 (lambda ()
15493 (set-window-configuration
15494 (prog1 org-window-configuration
15495 (kill-buffer (current-buffer))))
15496 (org-install-agenda-files-menu)
15497 (message "New agenda file list installed"))
15498 nil 'local)
15499 (message "%s" (substitute-command-keys
15501 (customize-variable 'org-agenda-files)))
15503 (defun org-store-new-agenda-file-list (list)
15504 "Set new value for the agenda file list and save it correctly."
15505 (if (stringp org-agenda-files)
15506 (let ((fe (org-read-agenda-file-list t)) b u)
15507 (while (setq b (find-buffer-visiting org-agenda-files))
15508 (kill-buffer b))
15509 (with-temp-file org-agenda-files
15510 (insert
15511 (mapconcat
15512 (lambda (f) ;; Keep un-expanded entries.
15513 (if (setq u (assoc f fe))
15514 (cdr u)
15515 f))
15518 (let ((org-mode-hook nil) (org-inhibit-startup t)
15519 (org-insert-mode-line-in-empty-file nil))
15520 (setq org-agenda-files list)
15521 (customize-save-variable 'org-agenda-files org-agenda-files))))
15523 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15524 "Read the list of agenda files from a file.
15525 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15526 filenames, used by `org-store-new-agenda-file-list' to write back
15527 un-expanded file names."
15528 (when (file-directory-p org-agenda-files)
15529 (error "`org-agenda-files' cannot be a single directory"))
15530 (when (stringp org-agenda-files)
15531 (with-temp-buffer
15532 (insert-file-contents org-agenda-files)
15533 (mapcar
15534 (lambda (f)
15535 (let ((e (expand-file-name (substitute-in-file-name f)
15536 org-directory)))
15537 (if pair-with-expansion
15538 (cons e f)
15539 e)))
15542 ;;;###autoload
15543 (defun org-cycle-agenda-files ()
15544 "Cycle through the files in `org-agenda-files'.
15545 If the current buffer visits an agenda file, find the next one in the list.
15546 If the current buffer does not, find the first agenda file."
15547 (interactive)
15548 (let* ((fs (org-agenda-files t))
15549 (files (append fs (list (car fs))))
15550 (tcf (if buffer-file-name (file-truename buffer-file-name)))
15551 file)
15552 (unless files (error "No agenda files"))
15553 (catch 'exit
15554 (while (setq file (pop files))
15555 (if (equal (file-truename file) tcf)
15556 (when (car files)
15557 (find-file (car files))
15558 (throw 'exit t))))
15559 (find-file (car fs)))
15560 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
15562 (defun org-agenda-file-to-front (&optional to-end)
15563 "Move/add the current file to the top of the agenda file list.
15564 If the file is not present in the list, it is added to the front. If it is
15565 present, it is moved there. With optional argument TO-END, add/move to the
15566 end of the list."
15567 (interactive "P")
15568 (let ((org-agenda-skip-unavailable-files nil)
15569 (file-alist (mapcar (lambda (x)
15570 (cons (file-truename x) x))
15571 (org-agenda-files t)))
15572 (ctf (file-truename buffer-file-name))
15573 x had)
15574 (setq x (assoc ctf file-alist) had x)
15576 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
15577 (if to-end
15578 (setq file-alist (append (delq x file-alist) (list x)))
15579 (setq file-alist (cons x (delq x file-alist))))
15580 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
15581 (org-install-agenda-files-menu)
15582 (message "File %s to %s of agenda file list"
15583 (if had "moved" "added") (if to-end "end" "front"))))
15585 (defun org-remove-file (&optional file)
15586 "Remove current file from the list of files in variable `org-agenda-files'.
15587 These are the files which are being checked for agenda entries.
15588 Optional argument FILE means use this file instead of the current."
15589 (interactive)
15590 (let* ((org-agenda-skip-unavailable-files nil)
15591 (file (or file buffer-file-name))
15592 (true-file (file-truename file))
15593 (afile (abbreviate-file-name file))
15594 (files (delq nil (mapcar
15595 (lambda (x)
15596 (if (equal true-file
15597 (file-truename x))
15598 nil x))
15599 (org-agenda-files t)))))
15600 (if (not (= (length files) (length (org-agenda-files t))))
15601 (progn
15602 (org-store-new-agenda-file-list files)
15603 (org-install-agenda-files-menu)
15604 (message "Removed file: %s" afile))
15605 (message "File was not in list: %s (not removed)" afile))))
15607 (defun org-file-menu-entry (file)
15608 (vector file (list 'find-file file) t))
15610 (defun org-check-agenda-file (file)
15611 "Make sure FILE exists. If not, ask user what to do."
15612 (when (not (file-exists-p file))
15613 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
15614 (abbreviate-file-name file))
15615 (let ((r (downcase (read-char-exclusive))))
15616 (cond
15617 ((equal r ?r)
15618 (org-remove-file file)
15619 (throw 'nextfile t))
15620 (t (error "Abort"))))))
15622 (defun org-get-agenda-file-buffer (file)
15623 "Get a buffer visiting FILE. If the buffer needs to be created, add
15624 it to the list of buffers which might be released later."
15625 (let ((buf (org-find-base-buffer-visiting file)))
15626 (if buf
15627 buf ; just return it
15628 ;; Make a new buffer and remember it
15629 (setq buf (find-file-noselect file))
15630 (if buf (push buf org-agenda-new-buffers))
15631 buf)))
15633 (defun org-release-buffers (blist)
15634 "Release all buffers in list, asking the user for confirmation when needed.
15635 When a buffer is unmodified, it is just killed. When modified, it is saved
15636 \(if the user agrees) and then killed."
15637 (let (buf file)
15638 (while (setq buf (pop blist))
15639 (setq file (buffer-file-name buf))
15640 (when (and (buffer-modified-p buf)
15641 file
15642 (y-or-n-p (format "Save file %s? " file)))
15643 (with-current-buffer buf (save-buffer)))
15644 (kill-buffer buf))))
15646 (defun org-prepare-agenda-buffers (files)
15647 "Create buffers for all agenda files, protect archived trees and comments."
15648 (interactive)
15649 (let ((pa '(:org-archived t))
15650 (pc '(:org-comment t))
15651 (pall '(:org-archived t :org-comment t))
15652 (inhibit-read-only t)
15653 (rea (concat ":" org-archive-tag ":"))
15654 bmp file re)
15655 (save-excursion
15656 (save-restriction
15657 (while (setq file (pop files))
15658 (catch 'nextfile
15659 (if (bufferp file)
15660 (set-buffer file)
15661 (org-check-agenda-file file)
15662 (set-buffer (org-get-agenda-file-buffer file)))
15663 (widen)
15664 (setq bmp (buffer-modified-p))
15665 (org-refresh-category-properties)
15666 (setq org-todo-keywords-for-agenda
15667 (append org-todo-keywords-for-agenda org-todo-keywords-1))
15668 (setq org-done-keywords-for-agenda
15669 (append org-done-keywords-for-agenda org-done-keywords))
15670 (setq org-todo-keyword-alist-for-agenda
15671 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
15672 (setq org-drawers-for-agenda
15673 (append org-drawers-for-agenda org-drawers))
15674 (setq org-tag-alist-for-agenda
15675 (append org-tag-alist-for-agenda org-tag-alist))
15677 (save-excursion
15678 (remove-text-properties (point-min) (point-max) pall)
15679 (when org-agenda-skip-archived-trees
15680 (goto-char (point-min))
15681 (while (re-search-forward rea nil t)
15682 (if (org-on-heading-p t)
15683 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
15684 (goto-char (point-min))
15686 (while (re-search-forward re nil t)
15687 (add-text-properties
15688 (match-beginning 0) (org-end-of-subtree t) pc)))
15689 (set-buffer-modified-p bmp)))))
15690 (setq org-todo-keywords-for-agenda
15691 (org-uniquify org-todo-keywords-for-agenda))
15692 (setq org-todo-keyword-alist-for-agenda
15693 (org-uniquify org-todo-keyword-alist-for-agenda)
15694 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
15696 ;;;; Embedded LaTeX
15698 (defvar org-cdlatex-mode-map (make-sparse-keymap)
15699 "Keymap for the minor `org-cdlatex-mode'.")
15701 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
15702 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
15703 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
15704 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
15705 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
15707 (defvar org-cdlatex-texmathp-advice-is-done nil
15708 "Flag remembering if we have applied the advice to texmathp already.")
15710 (define-minor-mode org-cdlatex-mode
15711 "Toggle the minor `org-cdlatex-mode'.
15712 This mode supports entering LaTeX environment and math in LaTeX fragments
15713 in Org-mode.
15715 nil " OCDL" nil
15716 (when org-cdlatex-mode (require 'cdlatex))
15717 (unless org-cdlatex-texmathp-advice-is-done
15718 (setq org-cdlatex-texmathp-advice-is-done t)
15719 (defadvice texmathp (around org-math-always-on activate)
15720 "Always return t in org-mode buffers.
15721 This is because we want to insert math symbols without dollars even outside
15722 the LaTeX math segments. If Orgmode thinks that point is actually inside
15723 an embedded LaTeX fragment, let texmathp do its job.
15725 (interactive)
15726 (let (p)
15727 (cond
15728 ((not (org-mode-p)) ad-do-it)
15729 ((eq this-command 'cdlatex-math-symbol)
15730 (setq ad-return-value t
15731 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
15732 (t
15733 (let ((p (org-inside-LaTeX-fragment-p)))
15734 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
15735 (setq ad-return-value t
15736 texmathp-why '("Org-mode embedded math" . 0))
15737 (if p ad-do-it)))))))))
15739 (defun turn-on-org-cdlatex ()
15740 "Unconditionally turn on `org-cdlatex-mode'."
15741 (org-cdlatex-mode 1))
15743 (defun org-inside-LaTeX-fragment-p ()
15744 "Test if point is inside a LaTeX fragment.
15746 sequence appearing also before point.
15747 Even though the matchers for math are configurable, this function assumes
15749 delimiters are skipped when they have been removed by customization.
15750 The return value is nil, or a cons cell with the delimiter and
15751 and the position of this delimiter.
15753 This function does a reasonably good job, but can locally be fooled by
15754 for example currency specifications. For example it will assume being in
15756 fragments that are properly closed, but during editing, we have to live
15757 with the uncertainty caused by missing closing delimiters. This function
15758 looks only before point, not after."
15759 (catch 'exit
15760 (let ((pos (point))
15761 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
15762 (lim (progn
15764 (point)))
15765 dd-on str (start 0) m re)
15766 (goto-char pos)
15767 (when dodollar
15769 re (nth 1 (assoc "$" org-latex-regexps)))
15770 (while (string-match re str start)
15771 (cond
15772 ((= (match-end 0) (length str))
15773 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
15774 ((= (match-end 0) (- (length str) 5))
15775 (throw 'exit nil))
15776 (t (setq start (match-end 0))))))
15777 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
15778 (goto-char pos)
15779 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
15780 (and (match-beginning 2) (throw 'exit nil))
15781 ;; count $$
15783 (setq dd-on (not dd-on)))
15784 (goto-char pos)
15785 (if dd-on (cons "$$" m))))))
15787 (defun org-inside-latex-macro-p ()
15788 "Is point inside a LaTeX macro or its arguments?"
15789 (save-match-data
15790 (org-in-regexp
15793 (defun org-try-cdlatex-tab ()
15794 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15795 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15796 - inside a LaTeX fragment, or
15797 - after the first word in a line, where an abbreviation expansion could
15798 insert a LaTeX environment."
15799 (when org-cdlatex-mode
15800 (cond
15801 ((save-excursion
15802 (skip-chars-backward "a-zA-Z0-9*")
15804 (bolp))
15805 (cdlatex-tab) t)
15806 ((org-inside-LaTeX-fragment-p)
15807 (cdlatex-tab) t)
15808 (t nil))))
15810 (defun org-cdlatex-underscore-caret (&optional arg)
15811 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15812 Revert to the normal definition outside of these fragments."
15813 (interactive "P")
15814 (if (org-inside-LaTeX-fragment-p)
15815 (call-interactively 'cdlatex-sub-superscript)
15816 (let (org-cdlatex-mode)
15817 (call-interactively (key-binding (vector last-input-event))))))
15819 (defun org-cdlatex-math-modify (&optional arg)
15820 "Execute `cdlatex-math-modify' in LaTeX fragments.
15821 Revert to the normal definition outside of these fragments."
15822 (interactive "P")
15823 (if (org-inside-LaTeX-fragment-p)
15824 (call-interactively 'cdlatex-math-modify)
15825 (let (org-cdlatex-mode)
15826 (call-interactively (key-binding (vector last-input-event))))))
15828 (defvar org-latex-fragment-image-overlays nil
15829 "List of overlays carrying the images of latex fragments.")
15830 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
15832 (defun org-remove-latex-fragment-image-overlays ()
15833 "Remove all overlays with LaTeX fragment images in current buffer."
15834 (mapc 'delete-overlay org-latex-fragment-image-overlays)
15835 (setq org-latex-fragment-image-overlays nil))
15837 (defun org-preview-latex-fragment (&optional subtree)
15838 "Preview the LaTeX fragment at point, or all locally or globally.
15839 If the cursor is in a LaTeX fragment, create the image and overlay
15840 it over the source code. If there is no fragment at point, display
15841 all fragments in the current text, from one headline to the next. With
15842 prefix SUBTREE, display all fragments in the current subtree. With a
15844 the cursor is before the first headline,
15845 display all fragments in the buffer.
15847 (interactive "P")
15848 (org-remove-latex-fragment-image-overlays)
15849 (save-excursion
15850 (save-restriction
15851 (let (beg end at msg)
15852 (cond
15853 ((or (equal subtree '(16))
15854 (not (save-excursion
15855 (re-search-backward (concat "^" outline-regexp) nil t))))
15856 (setq beg (point-min) end (point-max)
15857 msg "Creating images for buffer...%s"))
15858 ((equal subtree '(4))
15859 (org-back-to-heading)
15860 (setq beg (point) end (org-end-of-subtree t)
15861 msg "Creating images for subtree...%s"))
15862 (t
15863 (if (setq at (org-inside-LaTeX-fragment-p))
15864 (goto-char (max (point-min) (- (cdr at) 2)))
15865 (org-back-to-heading))
15866 (setq beg (point) end (progn (outline-next-heading) (point))
15867 msg (if at "Creating image...%s"
15868 "Creating images for entry...%s"))))
15869 (message msg "")
15870 (narrow-to-region beg end)
15871 (goto-char beg)
15872 (org-format-latex
15873 (concat "ltxpng/" (file-name-sans-extension
15874 (file-name-nondirectory
15875 buffer-file-name)))
15876 default-directory 'overlays msg at 'forbuffer 'dvipng)
15877 (message msg "done. Use `C-c C-c' to remove images.")))))
15879 (defvar org-latex-regexps
15881 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
15884 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
15888 "Regular expressions for matching embedded LaTeX.")
15890 (defvar org-export-have-math nil) ;; dynamic scoping
15891 (defun org-format-latex (prefix &optional dir overlays msg at
15892 forbuffer processing-type)
15893 "Replace LaTeX fragments with links to an image, and produce images.
15894 Some of the options can be changed using the variable
15895 `org-format-latex-options'."
15896 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
15897 (let* ((prefixnodir (file-name-nondirectory prefix))
15898 (absprefix (expand-file-name prefix dir))
15899 (todir (file-name-directory absprefix))
15900 (opt org-format-latex-options)
15901 (matchers (plist-get opt :matchers))
15902 (re-list org-latex-regexps)
15903 (org-format-latex-header-extra
15904 (plist-get (org-infile-export-plist) :latex-header-extra))
15905 (cnt 0) txt hash link beg end re e checkdir
15906 executables-checked string
15907 m n block linkfile movefile ov)
15908 ;; Check the different regular expressions
15909 (while (setq e (pop re-list))
15910 (setq m (car e) re (nth 1 e) n (nth 2 e)
15912 (when (member m matchers)
15913 (goto-char (point-min))
15914 (while (re-search-forward re nil t)
15915 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
15916 (not (get-text-property (match-beginning n)
15917 'org-protected))
15918 (or (not overlays)
15919 (not (eq (get-char-property (match-beginning n)
15920 'org-overlay-type)
15921 'org-latex-overlay))))
15922 (setq org-export-have-math t)
15923 (cond
15924 ((eq processing-type 'verbatim)
15925 ;; Leave the text verbatim, just protect it
15926 (add-text-properties (match-beginning n) (match-end n)
15927 '(org-protected t)))
15928 ((eq processing-type 'mathjax)
15929 ;; Prepare for MathJax processing
15930 (setq string (match-string n))
15931 (if (member m '("$" "$1"))
15932 (save-excursion
15933 (delete-region (match-beginning n) (match-end n))
15934 (goto-char (match-beginning n))
15937 '(org-protected t))))
15938 (add-text-properties (match-beginning n) (match-end n)
15939 '(org-protected t))))
15940 ((or (eq processing-type 'dvipng) t)
15941 ;; Process to an image
15942 (setq txt (match-string n)
15943 beg (match-beginning n) end (match-end n)
15944 cnt (1+ cnt))
15945 (let (print-length print-level) ; make sure full list is printed
15946 (setq hash (sha1 (prin1-to-string
15947 (list org-format-latex-header
15948 org-format-latex-header-extra
15949 org-export-latex-default-packages-alist
15950 org-export-latex-packages-alist
15951 org-format-latex-options
15952 forbuffer txt)))
15953 linkfile (format "%s_%s.png" prefix hash)
15954 movefile (format "%s_%s.png" absprefix hash)))
15955 (setq link (concat block "[[file:" linkfile "]]" block))
15956 (if msg (message msg cnt))
15957 (goto-char beg)
15958 (unless checkdir ; make sure the directory exists
15959 (setq checkdir t)
15960 (or (file-directory-p todir) (make-directory todir t)))
15962 (unless executables-checked
15963 (org-check-external-command
15964 "latex" "needed to convert LaTeX fragments to images")
15965 (org-check-external-command
15966 "dvipng" "needed to convert LaTeX fragments to images")
15967 (setq executables-checked t))
15969 (unless (file-exists-p movefile)
15970 (org-create-formula-image
15971 txt movefile opt forbuffer))
15972 (if overlays
15973 (progn
15974 (mapc (lambda (o)
15975 (if (eq (overlay-get o 'org-overlay-type)
15976 'org-latex-overlay)
15977 (delete-overlay o)))
15978 (overlays-in beg end))
15979 (setq ov (make-overlay beg end))
15980 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
15981 (if (featurep 'xemacs)
15982 (progn
15983 (overlay-put ov 'invisible t)
15984 (overlay-put
15985 ov 'end-glyph
15986 (make-glyph (vector 'png :file movefile))))
15987 (overlay-put
15988 ov 'display
15989 (list 'image :type 'png :file movefile :ascent 'center)))
15990 (push ov org-latex-fragment-image-overlays)
15991 (goto-char end))
15992 (delete-region beg end)
15993 (insert (org-add-props link
15994 (list 'org-latex-src
15995 (replace-regexp-in-string
15998 ;; This function borrows from Ganesh Swami's latex2png.el
15999 (defun org-create-formula-image (string tofile options buffer)
16000 "This calls dvipng."
16001 (require 'org-latex)
16002 (let* ((tmpdir (if (featurep 'xemacs)
16003 (temp-directory)
16004 temporary-file-directory))
16005 (texfilebase (make-temp-name
16006 (expand-file-name "orgtex" tmpdir)))
16007 (texfile (concat texfilebase ".tex"))
16008 (dvifile (concat texfilebase ".dvi"))
16009 (pngfile (concat texfilebase ".png"))
16010 (fnh (if (featurep 'xemacs)
16011 (font-height (get-face-font 'default))
16012 (face-attribute 'default :height nil)))
16013 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16014 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16015 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16016 "Black"))
16017 (bg (or (plist-get options (if buffer :background :html-background))
16018 "Transparent")))
16019 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16020 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16021 (with-temp-file texfile
16022 (insert (org-splice-latex-header
16023 org-format-latex-header
16024 org-export-latex-default-packages-alist
16025 org-export-latex-packages-alist t
16026 org-format-latex-header-extra))
16028 (require 'org-latex)
16029 (org-export-latex-fix-inputenc))
16030 (let ((dir default-directory))
16031 (condition-case nil
16032 (progn
16033 (cd tmpdir)
16034 (call-process "latex" nil nil nil texfile))
16035 (error nil))
16036 (cd dir))
16037 (if (not (file-exists-p dvifile))
16038 (progn (message "Failed to create dvi file from %s" texfile) nil)
16039 (condition-case nil
16040 (call-process "dvipng" nil nil nil
16041 "-fg" fg "-bg" bg
16042 "-D" dpi
16043 ;;"-x" scale "-y" scale
16044 "-T" "tight"
16045 "-o" pngfile
16046 dvifile)
16047 (error nil))
16048 (if (not (file-exists-p pngfile))
16049 (if org-format-latex-signal-error
16050 (error "Failed to create png file from %s" texfile)
16051 (message "Failed to create png file from %s" texfile)
16052 nil)
16053 ;; Use the requested file name and clean up
16054 (copy-file pngfile tofile 'replace)
16055 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16056 (delete-file (concat texfilebase e)))
16057 pngfile))))
16059 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16060 "Fill a LaTeX header template TPL.
16061 In the template, the following place holders will be recognized:
16064 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16066 [NO-PACKAGES] do not include PKG
16067 [EXTRA] the string EXTRA
16068 [NO-EXTRA] do not include EXTRA
16070 For backward compatibility, if both the positive and the negative place
16072 assumed to be present at the end of the template.
16073 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16074 EXTRA is a string.
16075 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16076 (let (rpl (end ""))
16078 (setq rpl (if (or (match-end 1) (not def-pkg))
16079 "" (org-latex-packages-to-string def-pkg snippets-p t))
16080 tpl (replace-match rpl t t tpl))
16081 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16084 (setq rpl (if (or (match-end 1) (not pkg))
16085 "" (org-latex-packages-to-string pkg snippets-p t))
16086 tpl (replace-match rpl t t tpl))
16087 (if pkg (setq end
16089 (org-latex-packages-to-string pkg snippets-p)))))
16092 (setq rpl (if (or (match-end 1) (not extra))
16094 tpl (replace-match rpl t t tpl))
16100 tpl)))
16102 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16104 (setq pkg (mapconcat (lambda(p)
16105 (cond
16106 ((stringp p) p)
16107 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16108 (format "%% Package %s omitted" (cadr p)))
16109 ((equal "" (car p))
16111 (t
16113 (car p) (cadr p)))))
16114 pkg
16118 (defun org-dvipng-color (attr)
16119 "Return an rgb color specification for dvipng."
16120 (apply 'format "rgb %s %s %s"
16121 (mapcar 'org-normalize-color
16122 (color-values (face-attribute 'default attr nil)))))
16124 (defun org-normalize-color (value)
16125 "Return string to be used as color value for an RGB component."
16126 (format "%g" (/ value 65535.0)))
16128 ;; Image display
16131 (defvar org-inline-image-overlays nil)
16132 (make-variable-buffer-local 'org-inline-image-overlays)
16134 (defun org-toggle-inline-images (&optional include-linked)
16135 "Toggle the display of inline images.
16136 INCLUDE-LINKED is passed to `org-display-inline-images'."
16137 (interactive "P")
16138 (if org-inline-image-overlays
16139 (progn
16140 (org-remove-inline-images)
16141 (message "Inline image display turned off"))
16142 (org-display-inline-images include-linked)
16143 (if org-inline-image-overlays
16144 (message "%d images displayed inline"
16145 (length org-inline-image-overlays))
16146 (message "No images to display inline"))))
16148 (defun org-display-inline-images (&optional include-linked refresh beg end)
16149 "Display inline images.
16150 Normally only links without a description part are inlined, because this
16151 is how it will work for export. When INCLUDE-LINKED is set, also links
16152 with a description part will be inlined. This can be nice for a quick
16153 look at those images, but it does not reflect what exported files will look
16154 like.
16155 When REFRESH is set, refresh existing images between BEG and END.
16156 This will create new image displays only if necessary.
16157 BEG and END default to the buffer boundaries."
16158 (interactive "P")
16159 (unless refresh
16160 (org-remove-inline-images)
16161 (clear-image-cache))
16162 (save-excursion
16163 (save-restriction
16164 (widen)
16165 (setq beg (or beg (point-min)) end (or end (point-max)))
16166 (goto-char (point-min))
16168 (substring (org-image-file-name-regexp) 0 -2)
16170 old file ov img)
16171 (while (re-search-forward re end t)
16172 (setq old (get-char-property-and-overlay (match-beginning 1)
16173 'org-image-overlay))
16174 (setq file (expand-file-name
16175 (concat (or (match-string 3) "") (match-string 4))))
16176 (when (file-exists-p file)
16177 (if (and (car-safe old) refresh)
16178 (image-refresh (overlay-get (cdr old) 'display))
16179 (setq img (save-match-data (create-image file)))
16180 (when img
16181 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16182 (overlay-put ov 'display img)
16183 (overlay-put ov 'face 'default)
16184 (overlay-put ov 'org-image-overlay t)
16185 (overlay-put ov 'modification-hooks
16186 (list 'org-display-inline-modification-hook))
16187 (push ov org-inline-image-overlays)))))))))
16189 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16190 "Remove inline-display overlay if a corresponding region is modified."
16191 (let ((inhibit-modification-hooks t))
16192 (when (and ov after)
16193 (delete ov org-inline-image-overlays)
16194 (delete-overlay ov))))
16196 (defun org-remove-inline-images ()
16197 "Remove inline display of images."
16198 (interactive)
16199 (mapc 'delete-overlay org-inline-image-overlays)
16200 (setq org-inline-image-overlays nil))
16202 ;;;; Key bindings
16204 ;; Make `C-c C-x' a prefix key
16205 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16207 ;; TAB key with modifiers
16208 (org-defkey org-mode-map "\C-i" 'org-cycle)
16209 (org-defkey org-mode-map [(tab)] 'org-cycle)
16210 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16211 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16213 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16214 ;; The following line is necessary under Suse GNU/Linux
16215 (unless (featurep 'xemacs)
16216 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16217 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16218 (define-key org-mode-map [backtab] 'org-shifttab)
16220 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16221 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16222 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16224 ;; Cursor keys with modifiers
16225 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16226 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16227 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16228 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16230 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16231 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16232 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16233 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16235 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16236 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16237 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16238 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16240 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16241 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16243 ;; Babel keys
16244 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16245 (mapc (lambda (pair)
16246 (define-key org-babel-map (car pair) (cdr pair)))
16247 org-babel-key-bindings)
16249 ;;; Extra keys for tty access.
16250 ;; We only set them when really needed because otherwise the
16251 ;; menus don't show the simple keys
16253 (when (or org-use-extra-keys
16254 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16255 (not window-system))
16256 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16257 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16258 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16259 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16260 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16261 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16262 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16263 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16264 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16265 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16266 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16267 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16268 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16269 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16270 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16271 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16272 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16273 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16274 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16275 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16276 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16277 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16278 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16279 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16280 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16281 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16282 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16283 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16285 ;; All the other keys
16287 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16288 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16289 (if (boundp 'narrow-map)
16290 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16291 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16292 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16293 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16294 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16295 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16296 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16297 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16298 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16299 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16300 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16301 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16302 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16303 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16304 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16305 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16306 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16307 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16309 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16310 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16311 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16312 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16313 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16314 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16315 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16316 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16317 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16318 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16319 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16320 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16321 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16322 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16323 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16324 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16325 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16326 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16327 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16329 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16330 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16331 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16332 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16333 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16334 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16335 (org-defkey org-mode-map "\C-c^" 'org-sort)
16336 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16337 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16338 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16339 (org-defkey org-mode-map "\C-m" 'org-return)
16340 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16341 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16342 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16343 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16344 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16345 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16346 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16347 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16348 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16349 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16350 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16351 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16352 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16353 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16354 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16355 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16356 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16357 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16358 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16359 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16360 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16361 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16363 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16364 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16365 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16366 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16368 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16369 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16370 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16371 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16372 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16373 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16374 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16375 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16376 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16377 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16379 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16380 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16381 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16382 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16383 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16384 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16385 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16387 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16388 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16389 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16390 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16391 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16393 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16395 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16397 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16398 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16400 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16403 (when (featurep 'xemacs)
16404 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16407 (defconst org-speed-commands-default
16408 '(
16409 ("Outline Navigation")
16410 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16411 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16412 ("f" . (org-speed-move-safe 'org-forward-same-level))
16413 ("b" . (org-speed-move-safe 'org-backward-same-level))
16414 ("u" . (org-speed-move-safe 'outline-up-heading))
16415 ("j" . org-goto)
16416 ("g" . (org-refile t))
16417 ("Outline Visibility")
16418 ("c" . org-cycle)
16419 ("C" . org-shifttab)
16420 (" " . org-display-outline-path)
16421 ("Outline Structure Editing")
16422 ("U" . org-shiftmetaup)
16423 ("D" . org-shiftmetadown)
16424 ("r" . org-metaright)
16425 ("l" . org-metaleft)
16426 ("R" . org-shiftmetaright)
16427 ("L" . org-shiftmetaleft)
16428 ("i" . (progn (forward-char 1) (call-interactively
16429 'org-insert-heading-respect-content)))
16430 ("^" . org-sort)
16431 ("w" . org-refile)
16432 ("a" . org-archive-subtree-default-with-confirmation)
16433 ("." . org-mark-subtree)
16434 ("Clock Commands")
16435 ("I" . org-clock-in)
16436 ("O" . org-clock-out)
16437 ("Meta Data Editing")
16438 ("t" . org-todo)
16439 ("0" . (org-priority ?\ ))
16440 ("1" . (org-priority ?A))
16441 ("2" . (org-priority ?B))
16442 ("3" . (org-priority ?C))
16443 (";" . org-set-tags-command)
16444 ("e" . org-set-effort)
16445 ("Agenda Views etc")
16446 ("v" . org-agenda)
16447 ("/" . org-sparse-tree)
16448 ("Misc")
16449 ("o" . org-open-at-point)
16450 ("?" . org-speed-command-help)
16451 ("<" . (org-agenda-set-restriction-lock 'subtree))
16452 (">" . (org-agenda-remove-restriction-lock))
16453 )
16454 "The default speed commands.")
16456 (defun org-print-speed-command (e)
16457 (if (> (length (car e)) 1)
16458 (progn
16460 (princ (car e))
16462 (princ (make-string (length (car e)) ?-))
16464 (princ (car e))
16465 (princ " ")
16466 (if (symbolp (cdr e))
16467 (princ (symbol-name (cdr e)))
16468 (prin1 (cdr e)))
16471 (defun org-speed-command-help ()
16472 "Show the available speed commands."
16473 (interactive)
16474 (if (not org-use-speed-commands)
16475 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16476 (with-output-to-temp-buffer "*Help*"
16478 (mapc 'org-print-speed-command org-speed-commands-user)
16481 (mapc 'org-print-speed-command org-speed-commands-default))
16482 (with-current-buffer "*Help*"
16483 (setq truncate-lines t))))
16485 (defun org-speed-move-safe (cmd)
16486 "Execute CMD, but make sure that the cursor always ends up in a headline.
16487 If not, return to the original position and throw an error."
16488 (interactive)
16489 (let ((pos (point)))
16490 (call-interactively cmd)
16491 (unless (and (bolp) (org-on-heading-p))
16492 (goto-char pos)
16493 (error "Boundary reached while executing %s" cmd))))
16495 (defvar org-self-insert-command-undo-counter 0)
16497 (defvar org-table-auto-blank-field) ; defined in org-table.el
16498 (defvar org-speed-command nil)
16500 (defun org-speed-command-default-hook (keys)
16501 "Hook for activating single-letter speed commands.
16502 `org-speed-commands-default' specifies a minimal command set. Use
16503 `org-speed-commands-user' for further customization."
16504 (when (or (and (bolp) (looking-at outline-regexp))
16505 (and (functionp org-use-speed-commands)
16506 (funcall org-use-speed-commands)))
16507 (cdr (assoc keys (append org-speed-commands-user
16508 org-speed-commands-default)))))
16510 (defun org-babel-speed-command-hook (keys)
16511 "Hook for activating single-letter code block commands."
16512 (when (and (bolp) (looking-at org-babel-src-block-regexp))
16513 (cdr (assoc keys org-babel-key-bindings))))
16515 (defcustom org-speed-command-hook
16516 '(org-speed-command-default-hook org-babel-speed-command-hook)
16517 "Hook for activating speed commands at strategic locations.
16518 Hook functions are called in sequence until a valid handler is
16519 found.
16521 Each hook takes a single argument, a user-pressed command key
16522 which is also a `self-insert-command' from the global map.
16524 Within the hook, examine the cursor position and the command key
16525 and return nil or a valid handler as appropriate. Handler could
16526 be one of an interactive command, a function, or a form.
16528 Set `org-use-speed-commands' to non-nil value to enable this
16529 hook. The default setting is `org-speed-command-default-hook'."
16530 :group 'org-structure
16531 :type 'hook)
16533 (defun org-self-insert-command (N)
16534 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
16535 If the cursor is in a table looking at whitespace, the whitespace is
16536 overwritten, and the table is not marked as requiring realignment."
16537 (interactive "p")
16538 (cond
16539 ((and org-use-speed-commands
16540 (setq org-speed-command
16541 (run-hook-with-args-until-success
16542 'org-speed-command-hook (this-command-keys))))
16543 (cond
16544 ((commandp org-speed-command)
16545 (setq this-command org-speed-command)
16546 (call-interactively org-speed-command))
16547 ((functionp org-speed-command)
16548 (funcall org-speed-command))
16549 ((and org-speed-command (listp org-speed-command))
16550 (eval org-speed-command))
16551 (t (let (org-use-speed-commands)
16552 (call-interactively 'org-self-insert-command)))))
16553 ((and
16554 (org-table-p)
16555 (progn
16556 ;; check if we blank the field, and if that triggers align
16557 (and (featurep 'org-table) org-table-auto-blank-field
16558 (member last-command
16559 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
16561 ;; got extra space, this field does not determine column width
16562 (let (org-table-may-need-update) (org-table-blank-field))
16563 ;; no extra space, this field may determine column width
16564 (org-table-blank-field)))
16565 t)
16566 (eq N 1)
16568 (let (org-table-may-need-update)
16569 (goto-char (1- (match-end 0)))
16570 (delete-backward-char 1)
16571 (goto-char (match-beginning 0))
16572 (self-insert-command N)))
16573 (t
16574 (setq org-table-may-need-update t)
16575 (self-insert-command N)
16576 (org-fix-tags-on-the-fly)
16577 (if org-self-insert-cluster-for-undo
16578 (if (not (eq last-command 'org-self-insert-command))
16579 (setq org-self-insert-command-undo-counter 1)
16580 (if (>= org-self-insert-command-undo-counter 20)
16581 (setq org-self-insert-command-undo-counter 1)
16582 (and (> org-self-insert-command-undo-counter 0)
16583 buffer-undo-list
16584 (not (cadr buffer-undo-list)) ; remove nil entry
16585 (setcdr buffer-undo-list (cddr buffer-undo-list)))
16586 (setq org-self-insert-command-undo-counter
16587 (1+ org-self-insert-command-undo-counter))))))))
16589 (defun org-fix-tags-on-the-fly ()
16590 (when (and (equal (char-after (point-at-bol)) ?*)
16591 (org-on-heading-p))
16592 (org-align-tags-here org-tags-column)))
16594 (defun org-delete-backward-char (N)
16595 "Like `delete-backward-char', insert whitespace at field end in tables.
16596 When deleting backwards, in tables this function will insert whitespace in
16598 still be marked for re-alignment if the field did fill the entire column,
16599 because, in this case the deletion might narrow the column."
16600 (interactive "p")
16601 (if (and (org-table-p)
16602 (eq N 1)
16603 (string-match "|" (buffer-substring (point-at-bol) (point)))
16604 (looking-at ".*?|"))
16605 (let ((pos (point))
16607 (c org-table-may-need-update))
16608 (backward-delete-char N)
16609 (if (not overwrite-mode)
16610 (progn
16611 (skip-chars-forward "^|")
16612 (insert " ")
16613 (goto-char (1- pos))))
16614 ;; noalign: if there were two spaces at the end, this field
16615 ;; does not determine the width of the column.
16616 (if noalign (setq org-table-may-need-update c)))
16617 (backward-delete-char N)
16618 (org-fix-tags-on-the-fly)))
16620 (defun org-delete-char (N)
16621 "Like `delete-char', but insert whitespace at field end in tables.
16622 When deleting characters, in tables this function will insert whitespace in
16624 still be marked for re-alignment if the field did fill the entire column,
16625 because, in this case the deletion might narrow the column."
16626 (interactive "p")
16627 (if (and (org-table-p)
16628 (not (bolp))
16629 (not (= (char-after) ?|))
16630 (eq N 1))
16631 (if (looking-at ".*?|")
16632 (let ((pos (point))
16634 (c org-table-may-need-update))
16635 (replace-match (concat
16636 (substring (match-string 0) 1 -1)
16637 " |"))
16638 (goto-char pos)
16639 ;; noalign: if there were two spaces at the end, this field
16640 ;; does not determine the width of the column.
16641 (if noalign (setq org-table-may-need-update c)))
16642 (delete-char N))
16643 (delete-char N)
16644 (org-fix-tags-on-the-fly)))
16646 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
16647 (put 'org-self-insert-command 'delete-selection t)
16648 (put 'orgtbl-self-insert-command 'delete-selection t)
16649 (put 'org-delete-char 'delete-selection 'supersede)
16650 (put 'org-delete-backward-char 'delete-selection 'supersede)
16651 (put 'org-yank 'delete-selection 'yank)
16653 ;; Make `flyspell-mode' delay after some commands
16654 (put 'org-self-insert-command 'flyspell-delayed t)
16655 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
16656 (put 'org-delete-char 'flyspell-delayed t)
16657 (put 'org-delete-backward-char 'flyspell-delayed t)
16659 ;; Make pabbrev-mode expand after org-mode commands
16660 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
16661 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
16663 ;; How to do this: Measure non-white length of current string
16664 ;; If equal to column width, we should realign.
16666 (defun org-remap (map &rest commands)
16667 "In MAP, remap the functions given in COMMANDS.
16668 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
16669 (let (new old)
16670 (while commands
16671 (setq old (pop commands) new (pop commands))
16672 (if (fboundp 'command-remapping)
16673 (org-defkey map (vector 'remap old) new)
16674 (substitute-key-definition old new map global-map)))))
16676 (when (eq org-enable-table-editor 'optimized)
16677 ;; If the user wants maximum table support, we need to hijack
16678 ;; some standard editing functions
16679 (org-remap org-mode-map
16680 'self-insert-command 'org-self-insert-command
16681 'delete-char 'org-delete-char
16682 'delete-backward-char 'org-delete-backward-char)
16683 (org-defkey org-mode-map "|" 'org-force-self-insert))
16685 (defvar org-ctrl-c-ctrl-c-hook nil
16686 "Hook for functions attaching themselves to `C-c C-c'.
16687 This can be used to add additional functionality to the C-c C-c key which
16688 executes context-dependent commands.
16689 Each function will be called with no arguments. The function must check
16690 if the context is appropriate for it to act. If yes, it should do its
16691 thing and then return a non-nil value. If the context is wrong,
16692 just do nothing and return nil.")
16694 (defvar org-tab-first-hook nil
16695 "Hook for functions to attach themselves to TAB.
16696 See `org-ctrl-c-ctrl-c-hook' for more information.
16697 This hook runs as the first action when TAB is pressed, even before
16698 `org-cycle' messes around with the `outline-regexp' to cater for
16699 inline tasks and plain list item folding.
16700 If any function in this hook returns t, any other actions that
16701 would have been caused by TAB (such as table field motion or visibility
16702 cycling) will not occur.")
16704 (defvar org-tab-after-check-for-table-hook nil
16705 "Hook for functions to attach themselves to TAB.
16706 See `org-ctrl-c-ctrl-c-hook' for more information.
16707 This hook runs after it has been established that the cursor is not in a
16708 table, but before checking if the cursor is in a headline or if global cycling
16709 should be done.
16710 If any function in this hook returns t, not other actions like visibility
16711 cycling will be done.")
16713 (defvar org-tab-after-check-for-cycling-hook nil
16714 "Hook for functions to attach themselves to TAB.
16715 See `org-ctrl-c-ctrl-c-hook' for more information.
16716 This hook runs after it has been established that not table field motion and
16717 not visibility should be done because of current context. This is probably
16718 the place where a package like yasnippets can hook in.")
16720 (defvar org-tab-before-tab-emulation-hook nil
16721 "Hook for functions to attach themselves to TAB.
16722 See `org-ctrl-c-ctrl-c-hook' for more information.
16723 This hook runs after every other options for TAB have been exhausted, but
16726 (defvar org-metaleft-hook nil
16727 "Hook for functions attaching themselves to `M-left'.
16728 See `org-ctrl-c-ctrl-c-hook' for more information.")
16729 (defvar org-metaright-hook nil
16730 "Hook for functions attaching themselves to `M-right'.
16731 See `org-ctrl-c-ctrl-c-hook' for more information.")
16732 (defvar org-metaup-hook nil
16733 "Hook for functions attaching themselves to `M-up'.
16734 See `org-ctrl-c-ctrl-c-hook' for more information.")
16735 (defvar org-metadown-hook nil
16736 "Hook for functions attaching themselves to `M-down'.
16737 See `org-ctrl-c-ctrl-c-hook' for more information.")
16738 (defvar org-shiftmetaleft-hook nil
16739 "Hook for functions attaching themselves to `M-S-left'.
16740 See `org-ctrl-c-ctrl-c-hook' for more information.")
16741 (defvar org-shiftmetaright-hook nil
16742 "Hook for functions attaching themselves to `M-S-right'.
16743 See `org-ctrl-c-ctrl-c-hook' for more information.")
16744 (defvar org-shiftmetaup-hook nil
16745 "Hook for functions attaching themselves to `M-S-up'.
16746 See `org-ctrl-c-ctrl-c-hook' for more information.")
16747 (defvar org-shiftmetadown-hook nil
16748 "Hook for functions attaching themselves to `M-S-down'.
16749 See `org-ctrl-c-ctrl-c-hook' for more information.")
16750 (defvar org-metareturn-hook nil
16751 "Hook for functions attaching themselves to `M-RET'.
16752 See `org-ctrl-c-ctrl-c-hook' for more information.")
16753 (defvar org-shiftup-hook nil
16754 "Hook for functions attaching themselves to `S-up'.
16755 See `org-ctrl-c-ctrl-c-hook' for more information.")
16756 (defvar org-shiftup-final-hook nil
16757 "Hook for functions attaching themselves to `S-up'.
16758 This one runs after all other options except shift-select have been excluded.
16759 See `org-ctrl-c-ctrl-c-hook' for more information.")
16760 (defvar org-shiftdown-hook nil
16761 "Hook for functions attaching themselves to `S-down'.
16762 See `org-ctrl-c-ctrl-c-hook' for more information.")
16763 (defvar org-shiftdown-final-hook nil
16764 "Hook for functions attaching themselves to `S-down'.
16765 This one runs after all other options except shift-select have been excluded.
16766 See `org-ctrl-c-ctrl-c-hook' for more information.")
16767 (defvar org-shiftleft-hook nil
16768 "Hook for functions attaching themselves to `S-left'.
16769 See `org-ctrl-c-ctrl-c-hook' for more information.")
16770 (defvar org-shiftleft-final-hook nil
16771 "Hook for functions attaching themselves to `S-left'.
16772 This one runs after all other options except shift-select have been excluded.
16773 See `org-ctrl-c-ctrl-c-hook' for more information.")
16774 (defvar org-shiftright-hook nil
16775 "Hook for functions attaching themselves to `S-right'.
16776 See `org-ctrl-c-ctrl-c-hook' for more information.")
16777 (defvar org-shiftright-final-hook nil
16778 "Hook for functions attaching themselves to `S-right'.
16779 This one runs after all other options except shift-select have been excluded.
16780 See `org-ctrl-c-ctrl-c-hook' for more information.")
16782 (defun org-modifier-cursor-error ()
16783 "Throw an error, a modified cursor command was applied in wrong context."
16784 (error "This command is active in special context like tables, headlines or items"))
16786 (defun org-shiftselect-error ()
16787 "Throw an error because Shift-Cursor command was applied in wrong context."
16788 (if (and (boundp 'shift-select-mode) shift-select-mode)
16789 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
16790 (error "This command works only in special context like headlines or timestamps")))
16792 (defun org-call-for-shift-select (cmd)
16793 (let ((this-command-keys-shift-translated t))
16794 (call-interactively cmd)))
16796 (defun org-shifttab (&optional arg)
16797 "Global visibility cycling or move to previous table field.
16798 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
16799 on context.
16800 See the individual commands for more information."
16801 (interactive "P")
16802 (cond
16803 ((org-at-table-p) (call-interactively 'org-table-previous-field))
16804 ((integerp arg)
16805 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
16806 (message "Content view to level: %d" arg)
16807 (org-content (prefix-numeric-value arg2))
16808 (setq org-cycle-global-status 'overview)))
16809 (t (call-interactively 'org-global-cycle))))
16811 (defun org-shiftmetaleft ()
16812 "Promote subtree or delete table column.
16813 Calls `org-promote-subtree', `org-outdent-item',
16814 or `org-table-delete-column', depending on context.
16815 See the individual commands for more information."
16816 (interactive)
16817 (cond
16818 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
16819 ((org-at-table-p) (call-interactively 'org-table-delete-column))
16820 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
16821 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
16822 (t (org-modifier-cursor-error))))
16824 (defun org-shiftmetaright ()
16825 "Demote subtree or insert table column.
16826 Calls `org-demote-subtree', `org-indent-item',
16827 or `org-table-insert-column', depending on context.
16828 See the individual commands for more information."
16829 (interactive)
16830 (cond
16831 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
16832 ((org-at-table-p) (call-interactively 'org-table-insert-column))
16833 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
16834 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
16835 (t (org-modifier-cursor-error))))
16837 (defun org-shiftmetaup (&optional arg)
16838 "Move subtree up or kill table row.
16839 Calls `org-move-subtree-up' or `org-table-kill-row' or
16840 `org-move-item-up' depending on context. See the individual commands
16841 for more information."
16842 (interactive "P")
16843 (cond
16844 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
16845 ((org-at-table-p) (call-interactively 'org-table-kill-row))
16846 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16847 ((org-at-item-p) (call-interactively 'org-move-item-up))
16848 (t (org-modifier-cursor-error))))
16850 (defun org-shiftmetadown (&optional arg)
16851 "Move subtree down or insert table row.
16852 Calls `org-move-subtree-down' or `org-table-insert-row' or
16853 `org-move-item-down', depending on context. See the individual
16854 commands for more information."
16855 (interactive "P")
16856 (cond
16857 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
16858 ((org-at-table-p) (call-interactively 'org-table-insert-row))
16859 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16860 ((org-at-item-p) (call-interactively 'org-move-item-down))
16861 (t (org-modifier-cursor-error))))
16863 (defsubst org-hidden-tree-error ()
16864 (error
16865 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
16867 (defun org-metaleft (&optional arg)
16868 "Promote heading or move table column to left.
16869 Calls `org-do-promote' or `org-table-move-column', depending on context.
16870 With no specific context, calls the Emacs default `backward-word'.
16871 See the individual commands for more information."
16872 (interactive "P")
16873 (cond
16874 ((run-hook-with-args-until-success 'org-metaleft-hook))
16875 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
16876 ((or (org-on-heading-p)
16877 (and (org-region-active-p)
16878 (save-excursion
16879 (goto-char (region-beginning))
16880 (org-on-heading-p))))
16881 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16882 (call-interactively 'org-do-promote))
16883 ((or (org-at-item-p)
16884 (and (org-region-active-p)
16885 (save-excursion
16886 (goto-char (region-beginning))
16887 (org-at-item-p))))
16888 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16889 (call-interactively 'org-outdent-item))
16890 (t (call-interactively 'backward-word))))
16892 (defun org-metaright (&optional arg)
16893 "Demote subtree or move table column to right.
16894 Calls `org-do-demote' or `org-table-move-column', depending on context.
16895 With no specific context, calls the Emacs default `forward-word'.
16896 See the individual commands for more information."
16897 (interactive "P")
16898 (cond
16899 ((run-hook-with-args-until-success 'org-metaright-hook))
16900 ((org-at-table-p) (call-interactively 'org-table-move-column))
16901 ((or (org-on-heading-p)
16902 (and (org-region-active-p)
16903 (save-excursion
16904 (goto-char (region-beginning))
16905 (org-on-heading-p))))
16906 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16907 (call-interactively 'org-do-demote))
16908 ((or (org-at-item-p)
16909 (and (org-region-active-p)
16910 (save-excursion
16911 (goto-char (region-beginning))
16912 (org-at-item-p))))
16913 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16914 (call-interactively 'org-indent-item))
16915 (t (call-interactively 'forward-word))))
16917 (defun org-check-for-hidden (what)
16918 "Check if there are hidden headlines/items in the current visual line.
16919 WHAT can be either `headlines' or `items'. If the current line is
16920 an outline or item heading and it has a folded subtree below it,
16921 this function returns t, nil otherwise."
16922 (let ((re (cond
16923 ((eq what 'headlines) (concat "^" org-outline-regexp))
16924 ((eq what 'items) (concat "^" (org-item-re t)))
16925 (t (error "This should not happen"))))
16926 beg end)
16927 (save-excursion
16928 (catch 'exit
16929 (unless (org-region-active-p)
16930 (setq beg (point-at-bol))
16931 (beginning-of-line 2)
16932 (while (and (not (eobp)) ;; this is like `next-line'
16933 (get-char-property (1- (point)) 'invisible))
16934 (beginning-of-line 2))
16935 (setq end (point))
16936 (goto-char beg)
16937 (goto-char (point-at-eol))
16938 (setq end (max end (point)))
16939 (while (re-search-forward re end t)
16940 (if (get-char-property (match-beginning 0) 'invisible)
16941 (throw 'exit t))))
16942 nil))))
16944 (defun org-metaup (&optional arg)
16945 "Move subtree up or move table row up.
16946 Calls `org-move-subtree-up' or `org-table-move-row' or
16947 `org-move-item-up', depending on context. See the individual commands
16948 for more information."
16949 (interactive "P")
16950 (cond
16951 ((run-hook-with-args-until-success 'org-metaup-hook))
16952 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
16953 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16954 ((org-at-item-p) (call-interactively 'org-move-item-up))
16955 (t (transpose-lines 1) (beginning-of-line -1))))
16957 (defun org-metadown (&optional arg)
16958 "Move subtree down or move table row down.
16959 Calls `org-move-subtree-down' or `org-table-move-row' or
16960 `org-move-item-down', depending on context. See the individual
16961 commands for more information."
16962 (interactive "P")
16963 (cond
16964 ((run-hook-with-args-until-success 'org-metadown-hook))
16965 ((org-at-table-p) (call-interactively 'org-table-move-row))
16966 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16967 ((org-at-item-p) (call-interactively 'org-move-item-down))
16968 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
16970 (defun org-shiftup (&optional arg)
16971 "Increase item in timestamp or increase priority of current headline.
16972 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
16973 depending on context. See the individual commands for more information."
16974 (interactive "P")
16975 (cond
16976 ((run-hook-with-args-until-success 'org-shiftup-hook))
16977 ((and org-support-shift-select (org-region-active-p))
16978 (org-call-for-shift-select 'previous-line))
16979 ((org-at-timestamp-p t)
16980 (call-interactively (if org-edit-timestamp-down-means-later
16981 'org-timestamp-down 'org-timestamp-up)))
16982 ((and (not (eq org-support-shift-select 'always))
16983 org-enable-priority-commands
16984 (org-on-heading-p))
16985 (call-interactively 'org-priority-up))
16986 ((and (not org-support-shift-select) (org-at-item-p))
16987 (call-interactively 'org-previous-item))
16988 ((org-clocktable-try-shift 'up arg))
16989 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
16990 (org-support-shift-select
16991 (org-call-for-shift-select 'previous-line))
16992 (t (org-shiftselect-error))))
16994 (defun org-shiftdown (&optional arg)
16995 "Decrease item in timestamp or decrease priority of current headline.
16996 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
16997 depending on context. See the individual commands for more information."
16998 (interactive "P")
16999 (cond
17000 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17001 ((and org-support-shift-select (org-region-active-p))
17002 (org-call-for-shift-select 'next-line))
17003 ((org-at-timestamp-p t)
17004 (call-interactively (if org-edit-timestamp-down-means-later
17005 'org-timestamp-up 'org-timestamp-down)))
17006 ((and (not (eq org-support-shift-select 'always))
17007 org-enable-priority-commands
17008 (org-on-heading-p))
17009 (call-interactively 'org-priority-down))
17010 ((and (not org-support-shift-select) (org-at-item-p))
17011 (call-interactively 'org-next-item))
17012 ((org-clocktable-try-shift 'down arg))
17013 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17014 (org-support-shift-select
17015 (org-call-for-shift-select 'next-line))
17016 (t (org-shiftselect-error))))
17018 (defun org-shiftright (&optional arg)
17019 "Cycle the thing at point or in the current line, depending on context.
17020 Depending on context, this does one of the following:
17022 - switch a timestamp at point one day into the future
17023 - on a headline, switch to the next TODO keyword.
17024 - on an item, switch entire list to the next bullet type
17025 - on a property line, switch to the next allowed value
17026 - on a clocktable definition line, move time block into the future"
17027 (interactive "P")
17028 (cond
17029 ((run-hook-with-args-until-success 'org-shiftright-hook))
17030 ((and org-support-shift-select (org-region-active-p))
17031 (org-call-for-shift-select 'forward-char))
17032 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17033 ((and (not (eq org-support-shift-select 'always))
17034 (org-on-heading-p))
17035 (let ((org-inhibit-logging
17036 (not org-treat-S-cursor-todo-selection-as-state-change))
17037 (org-inhibit-blocking
17038 (not org-treat-S-cursor-todo-selection-as-state-change)))
17039 (org-call-with-arg 'org-todo 'right)))
17040 ((or (and org-support-shift-select
17041 (not (eq org-support-shift-select 'always))
17042 (org-at-item-bullet-p))
17043 (and (not org-support-shift-select) (org-at-item-p)))
17044 (org-call-with-arg 'org-cycle-list-bullet nil))
17045 ((and (not (eq org-support-shift-select 'always))
17046 (org-at-property-p))
17047 (call-interactively 'org-property-next-allowed-value))
17048 ((org-clocktable-try-shift 'right arg))
17049 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17050 (org-support-shift-select
17051 (org-call-for-shift-select 'forward-char))
17052 (t (org-shiftselect-error))))
17054 (defun org-shiftleft (&optional arg)
17055 "Cycle the thing at point or in the current line, depending on context.
17056 Depending on context, this does one of the following:
17058 - switch a timestamp at point one day into the past
17059 - on a headline, switch to the previous TODO keyword.
17060 - on an item, switch entire list to the previous bullet type
17061 - on a property line, switch to the previous allowed value
17062 - on a clocktable definition line, move time block into the past"
17063 (interactive "P")
17064 (cond
17065 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17066 ((and org-support-shift-select (org-region-active-p))
17067 (org-call-for-shift-select 'backward-char))
17068 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17069 ((and (not (eq org-support-shift-select 'always))
17070 (org-on-heading-p))
17071 (let ((org-inhibit-logging
17072 (not org-treat-S-cursor-todo-selection-as-state-change))
17073 (org-inhibit-blocking
17074 (not org-treat-S-cursor-todo-selection-as-state-change)))
17075 (org-call-with-arg 'org-todo 'left)))
17076 ((or (and org-support-shift-select
17077 (not (eq org-support-shift-select 'always))
17078 (org-at-item-bullet-p))
17079 (and (not org-support-shift-select) (org-at-item-p)))
17080 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17081 ((and (not (eq org-support-shift-select 'always))
17082 (org-at-property-p))
17083 (call-interactively 'org-property-previous-allowed-value))
17084 ((org-clocktable-try-shift 'left arg))
17085 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17086 (org-support-shift-select
17087 (org-call-for-shift-select 'backward-char))
17088 (t (org-shiftselect-error))))
17090 (defun org-shiftcontrolright ()
17091 "Switch to next TODO set."
17092 (interactive)
17093 (cond
17094 ((and org-support-shift-select (org-region-active-p))
17095 (org-call-for-shift-select 'forward-word))
17096 ((and (not (eq org-support-shift-select 'always))
17097 (org-on-heading-p))
17098 (org-call-with-arg 'org-todo 'nextset))
17099 (org-support-shift-select
17100 (org-call-for-shift-select 'forward-word))
17101 (t (org-shiftselect-error))))
17103 (defun org-shiftcontrolleft ()
17104 "Switch to previous TODO set."
17105 (interactive)
17106 (cond
17107 ((and org-support-shift-select (org-region-active-p))
17108 (org-call-for-shift-select 'backward-word))
17109 ((and (not (eq org-support-shift-select 'always))
17110 (org-on-heading-p))
17111 (org-call-with-arg 'org-todo 'previousset))
17112 (org-support-shift-select
17113 (org-call-for-shift-select 'backward-word))
17114 (t (org-shiftselect-error))))
17116 (defun org-ctrl-c-ret ()
17117 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17118 (interactive)
17119 (cond
17120 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17121 (t (call-interactively 'org-insert-heading))))
17123 (defun org-copy-special ()
17124 "Copy region in table or copy current subtree.
17125 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17126 See the individual commands for more information."
17127 (interactive)
17128 (call-interactively
17129 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17131 (defun org-cut-special ()
17132 "Cut region in table or cut current subtree.
17133 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17134 See the individual commands for more information."
17135 (interactive)
17136 (call-interactively
17137 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17139 (defun org-paste-special (arg)
17140 "Paste rectangular region into table, or past subtree relative to level.
17141 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17142 See the individual commands for more information."
17143 (interactive "P")
17144 (if (org-at-table-p)
17145 (org-table-paste-rectangle)
17146 (org-paste-subtree arg)))
17148 (defun org-edit-special (&optional arg)
17149 "Call a special editor for the stuff at point.
17150 When at a table, call the formula editor with `org-table-edit-formulas'.
17151 When at the first line of an src example, call `org-edit-src-code'.
17152 When in an #+include line, visit the include file. Otherwise call
17153 `ffap' to visit the file at point."
17154 (interactive)
17155 ;; possibly prep session before editing source
17156 (when arg
17157 (let* ((info (org-babel-get-src-block-info))
17158 (lang (nth 0 info))
17159 (params (nth 2 info))
17160 (session (cdr (assoc :session params))))
17161 (when (and info session) ;; we are in a source-code block with a session
17162 (funcall
17163 (intern (concat "org-babel-prep-session:" lang)) session params))))
17164 (cond ;; proceed with `org-edit-special'
17165 ((save-excursion
17166 (beginning-of-line 1)
17167 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17168 (find-file (org-trim (match-string 1))))
17169 ((org-edit-src-code))
17170 ((org-edit-fixed-width-region))
17171 ((org-at-table.el-p)
17172 (org-edit-src-code))
17173 ((or (org-at-table-p)
17174 (save-excursion
17175 (beginning-of-line 1)
17177 (call-interactively 'org-table-edit-formulas))
17178 (t (call-interactively 'ffap))))
17180 (defun org-ctrl-c-ctrl-c (&optional arg)
17181 "Set tags in headline, or update according to changed information at point.
17183 This command does many different things, depending on context:
17185 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17186 this is what we do.
17188 - If the cursor is on a statistics cookie, update it.
17190 - If the cursor is in a headline, prompt for tags and insert them
17191 into the current line, aligned to `org-tags-column'. When called
17192 with prefix arg, realign all tags in the current buffer.
17194 - If the cursor is in one of the special #+KEYWORD lines, this
17195 triggers scanning the buffer for these lines and updating the
17196 information.
17198 - If the cursor is inside a table, realign the table. This command
17199 works even if the automatic table editor has been turned off.
17201 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17202 the entire table.
17204 - If the cursor is at a footnote reference or definition, jump to
17205 the corresponding definition or references, respectively.
17207 - If the cursor is a the beginning of a dynamic block, update it.
17209 - If the current buffer is a capture buffer, close note and file it.
17211 - If the cursor is on a <<<target>>>, update radio targets and
17212 corresponding links in this buffer.
17214 - If the cursor is on a numbered item in a plain list, renumber the
17215 ordered list.
17217 - If the cursor is on a checkbox, toggle it.
17219 - If the cursor is on a code block, evaluate it. The variable
17220 `org-confirm-babel-evaluate' can be used to control prompting
17221 before code block evaluation, by default every code block
17222 evaluation requires confirmation. Code block evaluation can be
17223 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17224 (interactive "P")
17225 (let ((org-enable-table-editor t))
17226 (cond
17227 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17228 org-occur-highlights
17229 org-latex-fragment-image-overlays)
17230 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17231 (org-remove-occur-highlights)
17232 (org-remove-latex-fragment-image-overlays)
17233 (message "Temporary highlights/overlays removed from current buffer"))
17234 ((and (local-variable-p 'org-finish-function (current-buffer))
17235 (fboundp org-finish-function))
17236 (funcall org-finish-function))
17237 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17238 ((or (looking-at org-property-start-re)
17239 (org-at-property-p))
17240 (call-interactively 'org-property-action))
17241 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17243 (or (org-on-heading-p) (org-at-item-p)))
17244 (call-interactively 'org-update-statistics-cookies))
17245 ((org-on-heading-p) (call-interactively 'org-set-tags))
17246 ((org-at-table.el-p)
17247 (message "Use C-c ' to edit table.el tables"))
17248 ((org-at-table-p)
17249 (org-table-maybe-eval-formula)
17250 (if arg
17251 (call-interactively 'org-table-recalculate)
17252 (org-table-maybe-recalculate-line))
17253 (call-interactively 'org-table-align)
17254 (orgtbl-send-table 'maybe))
17255 ((or (org-footnote-at-reference-p)
17256 (org-footnote-at-definition-p))
17257 (call-interactively 'org-footnote-action))
17258 ((org-at-item-checkbox-p)
17259 (call-interactively 'org-list-repair)
17260 (call-interactively 'org-toggle-checkbox)
17261 (org-list-send-list 'maybe))
17262 ((org-at-item-p)
17263 (call-interactively 'org-list-repair)
17264 (when arg (call-interactively 'org-toggle-checkbox))
17265 (org-list-send-list 'maybe))
17266 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17267 ;; Dynamic block
17268 (beginning-of-line 1)
17269 (save-excursion (org-update-dblock)))
17270 ((save-excursion
17271 (beginning-of-line 1)
17273 (cond
17274 ((equal (match-string 1) "TBLFM")
17275 ;; Recalculate the table before this line
17276 (save-excursion
17277 (beginning-of-line 1)
17279 (if (org-at-table-p)
17280 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17281 (t
17282 (let ((org-inhibit-startup-visibility-stuff t)
17283 (org-startup-align-all-tables nil))
17284 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17285 (message "Local setup has been refreshed"))))
17286 ((org-clock-update-time-maybe))
17287 (t (error "C-c C-c can do nothing useful at this location")))))
17289 (defun org-mode-restart ()
17290 "Restart Org-mode, to scan again for special lines.
17291 Also updates the keyword regular expressions."
17292 (interactive)
17293 (org-mode)
17294 (message "Org-mode restarted"))
17296 (defun org-kill-note-or-show-branches ()
17297 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17298 (interactive)
17299 (if (not org-finish-function)
17300 (progn
17301 (hide-subtree)
17302 (call-interactively 'show-branches))
17303 (let ((org-note-abort t))
17304 (funcall org-finish-function))))
17306 (defun org-return (&optional indent)
17307 "Goto next table row or insert a newline.
17308 Calls `org-table-next-row' or `newline', depending on context.
17309 See the individual commands for more information."
17310 (interactive)
17311 (cond
17312 ((bobp) (if indent (newline-and-indent) (newline)))
17313 ((org-at-table-p)
17314 (org-table-justify-field-maybe)
17315 (call-interactively 'org-table-next-row))
17316 ((and org-return-follows-link
17317 (eq (get-text-property (point) 'face) 'org-link))
17318 (call-interactively 'org-open-at-point))
17319 ((and (org-at-heading-p)
17320 (looking-at
17322 (org-show-entry)
17323 (end-of-line 1)
17324 (newline))
17325 (t (if indent (newline-and-indent) (newline)))))
17327 (defun org-return-indent ()
17328 "Goto next table row or insert a newline and indent.
17329 Calls `org-table-next-row' or `newline-and-indent', depending on
17330 context. See the individual commands for more information."
17331 (interactive)
17332 (org-return t))
17334 (defun org-ctrl-c-star ()
17335 "Compute table, or change heading status of lines.
17336 Calls `org-table-recalculate' or `org-toggle-heading',
17337 depending on context."
17338 (interactive)
17339 (cond
17340 ((org-at-table-p)
17341 (call-interactively 'org-table-recalculate))
17342 (t
17343 ;; Convert all lines in region to list items
17344 (call-interactively 'org-toggle-heading))))
17346 (defun org-ctrl-c-minus ()
17347 "Insert separator line in table or modify bullet status of line.
17348 Also turns a plain line or a region of lines into list items.
17349 Calls `org-table-insert-hline', `org-toggle-item', or
17350 `org-cycle-list-bullet', depending on context."
17351 (interactive)
17352 (cond
17353 ((org-at-table-p)
17354 (call-interactively 'org-table-insert-hline))
17355 ((org-region-active-p)
17356 (call-interactively 'org-toggle-item))
17357 ((org-in-item-p)
17358 (call-interactively 'org-cycle-list-bullet))
17359 (t
17360 (call-interactively 'org-toggle-item))))
17362 (defun org-toggle-item ()
17363 "Convert headings or normal lines to items, items to normal lines.
17364 If there is no active region, only the current line is considered.
17366 If the first line in the region is a headline, convert all headlines to items.
17368 If the first line in the region is an item, convert all items to normal lines.
17370 If the first line is normal text, add an item bullet to each line."
17371 (interactive)
17372 (let (l2 l beg end)
17373 (if (org-region-active-p)
17374 (setq beg (region-beginning) end (region-end))
17375 (setq beg (point-at-bol)
17376 end (min (1+ (point-at-eol)) (point-max))))
17377 (save-excursion
17378 (goto-char end)
17379 (setq l2 (org-current-line))
17380 (goto-char beg)
17381 (beginning-of-line 1)
17382 (setq l (1- (org-current-line)))
17383 (if (org-at-item-p)
17384 ;; We already have items, de-itemize
17385 (while (< (setq l (1+ l)) l2)
17386 (when (org-at-item-p)
17388 (delete-region (point) (match-end 0)))
17389 (beginning-of-line 2))
17390 (if (org-on-heading-p)
17391 ;; Headings, convert to items
17392 (while (< (setq l (1+ l)) l2)
17393 (if (looking-at org-outline-regexp)
17394 (replace-match (org-list-bullet-string "-") t t))
17395 (beginning-of-line 2))
17396 ;; normal lines, turn them into items
17397 (while (< (setq l (1+ l)) l2)
17398 (unless (org-at-item-p)
17400 (replace-match
17402 (beginning-of-line 2)))))))
17404 (defun org-toggle-heading (&optional nstars)
17405 "Convert headings to normal text, or items or text to headings.
17406 If there is no active region, only the current line is considered.
17408 If the first line is a heading, remove the stars from all headlines
17409 in the region.
17411 If the first line is a plain list item, turn all plain list items
17412 into headings.
17414 If the first line is a normal line, turn each and every line in the
17415 region into a heading.
17417 When converting a line into a heading, the number of stars is chosen
17418 such that the lines become children of the current entry. However,
17419 when a prefix argument is given, its value determines the number of
17420 stars to add."
17421 (interactive "P")
17422 (let (l2 l itemp beg end)
17423 (if (org-region-active-p)
17424 (setq beg (region-beginning) end (region-end))
17425 (setq beg (point-at-bol)
17426 end (min (1+ (point-at-eol)) (point-max))))
17427 (save-excursion
17428 (goto-char end)
17429 (setq l2 (org-current-line))
17430 (goto-char beg)
17431 (beginning-of-line 1)
17432 (setq l (1- (org-current-line)))
17433 (if (org-on-heading-p)
17434 ;; We already have headlines, de-star them
17435 (while (< (setq l (1+ l)) l2)
17436 (when (org-on-heading-p t)
17437 (and (looking-at outline-regexp) (replace-match "")))
17438 (beginning-of-line 2))
17439 (setq itemp (org-at-item-p))
17440 (let* ((stars
17441 (if nstars
17442 (make-string (prefix-numeric-value current-prefix-arg)
17443 ?*)
17444 (save-excursion
17445 (if (re-search-backward org-complex-heading-regexp nil t)
17446 (match-string 1) ""))))
17447 (add-stars (cond (nstars "")
17448 ((equal stars "") "*")
17449 (org-odd-levels-only "**")
17450 (t "*")))
17451 (rpl (concat stars add-stars " ")))
17452 (while (< (setq l (1+ l)) l2)
17453 (if itemp
17454 (and (org-at-item-p) (replace-match rpl t t))
17455 (unless (org-on-heading-p)
17457 (replace-match (concat rpl (match-string 2))))))
17458 (beginning-of-line 2)))))))
17460 (defun org-meta-return (&optional arg)
17461 "Insert a new heading or wrap a region in a table.
17462 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17463 See the individual commands for more information."
17464 (interactive "P")
17465 (cond
17466 ((run-hook-with-args-until-success 'org-metareturn-hook))
17467 ((org-at-table-p)
17468 (call-interactively 'org-table-wrap-region))
17469 (t (call-interactively 'org-insert-heading))))
17471 ;;; Menu entries
17473 ;; Define the Org-mode menus
17474 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
17475 '("Tbl"
17476 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
17477 ["Next Field" org-cycle (org-at-table-p)]
17478 ["Previous Field" org-shifttab (org-at-table-p)]
17479 ["Next Row" org-return (org-at-table-p)]
17480 "--"
17481 ["Blank Field" org-table-blank-field (org-at-table-p)]
17482 ["Edit Field" org-table-edit-field (org-at-table-p)]
17483 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
17484 "--"
17485 ("Column"
17486 ["Move Column Left" org-metaleft (org-at-table-p)]
17487 ["Move Column Right" org-metaright (org-at-table-p)]
17488 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
17489 ["Insert Column" org-shiftmetaright (org-at-table-p)])
17490 ("Row"
17491 ["Move Row Up" org-metaup (org-at-table-p)]
17492 ["Move Row Down" org-metadown (org-at-table-p)]
17493 ["Delete Row" org-shiftmetaup (org-at-table-p)]
17494 ["Insert Row" org-shiftmetadown (org-at-table-p)]
17495 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
17496 "--"
17497 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
17498 ("Rectangle"
17499 ["Copy Rectangle" org-copy-special (org-at-table-p)]
17500 ["Cut Rectangle" org-cut-special (org-at-table-p)]
17501 ["Paste Rectangle" org-paste-special (org-at-table-p)]
17502 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
17503 "--"
17504 ("Calculate"
17505 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
17506 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17507 ["Edit Formulas" org-edit-special (org-at-table-p)]
17508 "--"
17509 ["Recalculate line" org-table-recalculate (org-at-table-p)]
17510 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17511 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
17512 "--"
17513 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
17514 "--"
17515 ["Sum Column/Rectangle" org-table-sum
17516 (or (org-at-table-p) (org-region-active-p))]
17517 ["Which Column?" org-table-current-column (org-at-table-p)])
17518 ["Debug Formulas"
17519 org-table-toggle-formula-debugger
17520 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
17521 ["Show Col/Row Numbers"
17522 org-table-toggle-coordinate-overlays
17523 :style toggle
17524 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
17525 "--"
17526 ["Create" org-table-create (and (not (org-at-table-p))
17527 org-enable-table-editor)]
17528 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
17529 ["Import from File" org-table-import (not (org-at-table-p))]
17530 ["Export to File" org-table-export (org-at-table-p)]
17531 "--"
17532 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
17534 (easy-menu-define org-org-menu org-mode-map "Org menu"
17535 '("Org"
17536 ("Show/Hide"
17537 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
17538 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
17539 ["Sparse Tree..." org-sparse-tree t]
17540 ["Reveal Context" org-reveal t]
17541 ["Show All" show-all t]
17542 "--"
17543 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
17544 "--"
17545 ["New Heading" org-insert-heading t]
17546 ("Navigate Headings"
17547 ["Up" outline-up-heading t]
17548 ["Next" outline-next-visible-heading t]
17549 ["Previous" outline-previous-visible-heading t]
17550 ["Next Same Level" outline-forward-same-level t]
17551 ["Previous Same Level" outline-backward-same-level t]
17552 "--"
17553 ["Jump" org-goto t])
17554 ("Edit Structure"
17555 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
17556 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
17557 "--"
17558 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
17559 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
17560 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
17561 "--"
17562 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
17563 "--"
17564 ["Promote Heading" org-metaleft (not (org-at-table-p))]
17565 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
17566 ["Demote Heading" org-metaright (not (org-at-table-p))]
17567 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
17568 "--"
17569 ["Sort Region/Children" org-sort (not (org-at-table-p))]
17570 "--"
17571 ["Convert to odd levels" org-convert-to-odd-levels t]
17572 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
17573 ("Editing"
17574 ["Emphasis..." org-emphasize t]
17575 ["Edit Source Example" org-edit-special t]
17576 "--"
17577 ["Footnote new/jump" org-footnote-action t]
17578 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
17579 ("Archive"
17580 ["Archive (default method)" org-archive-subtree-default t]
17581 "--"
17582 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
17583 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
17584 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
17585 )
17586 "--"
17587 ("Hyperlinks"
17588 ["Store Link (Global)" org-store-link t]
17589 ["Find existing link to here" org-occur-link-in-agenda-files t]
17590 ["Insert Link" org-insert-link t]
17591 ["Follow Link" org-open-at-point t]
17592 "--"
17593 ["Next link" org-next-link t]
17594 ["Previous link" org-previous-link t]
17595 "--"
17596 ["Descriptive Links"
17597 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
17598 :style radio
17599 :selected (member '(org-link) buffer-invisibility-spec)]
17600 ["Literal Links"
17601 (progn
17602 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
17603 :style radio
17604 :selected (not (member '(org-link) buffer-invisibility-spec))])
17605 "--"
17606 ("TODO Lists"
17607 ["TODO/DONE/-" org-todo t]
17608 ("Select keyword"
17609 ["Next keyword" org-shiftright (org-on-heading-p)]
17610 ["Previous keyword" org-shiftleft (org-on-heading-p)]
17611 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
17612 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
17613 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
17614 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
17615 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
17616 "--"
17617 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
17618 :selected org-enforce-todo-dependencies :style toggle :active t]
17619 "Settings for tree at point"
17620 ["Do Children sequentially" org-toggle-ordered-property :style radio
17621 :selected (ignore-errors (org-entry-get nil "ORDERED"))
17622 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17623 ["Do Children parallel" org-toggle-ordered-property :style radio
17624 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
17625 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17626 "--"
17627 ["Set Priority" org-priority t]
17628 ["Priority Up" org-shiftup t]
17629 ["Priority Down" org-shiftdown t]
17630 "--"
17631 ["Get news from all feeds" org-feed-update-all t]
17632 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
17633 ["Customize feeds" (customize-variable 'org-feed-alist) t])
17634 ("TAGS and Properties"
17635 ["Set Tags" org-set-tags-command t]
17636 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
17637 "--"
17638 ["Set property" org-set-property t]
17639 ["Column view of properties" org-columns t]
17640 ["Insert Column View DBlock" org-insert-columns-dblock t])
17641 ("Dates and Scheduling"
17642 ["Timestamp" org-time-stamp t]
17643 ["Timestamp (inactive)" org-time-stamp-inactive t]
17644 ("Change Date"
17645 ["1 Day Later" org-shiftright t]
17646 ["1 Day Earlier" org-shiftleft t]
17647 ["1 ... Later" org-shiftup t]
17648 ["1 ... Earlier" org-shiftdown t])
17649 ["Compute Time Range" org-evaluate-time-range t]
17650 ["Schedule Item" org-schedule t]
17651 ["Deadline" org-deadline t]
17652 "--"
17653 ["Custom time format" org-toggle-time-stamp-overlays
17654 :style radio :selected org-display-custom-times]
17655 "--"
17656 ["Goto Calendar" org-goto-calendar t]
17657 ["Date from Calendar" org-date-from-calendar t]
17658 "--"
17659 ["Start/Restart Timer" org-timer-start t]
17660 ["Pause/Continue Timer" org-timer-pause-or-continue t]
17661 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
17662 ["Insert Timer String" org-timer t]
17663 ["Insert Timer Item" org-timer-item t])
17664 ("Logging work"
17665 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
17666 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
17667 ["Clock out" org-clock-out t]
17668 ["Clock cancel" org-clock-cancel t]
17669 "--"
17670 ["Mark as default task" org-clock-mark-default-task t]
17671 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
17672 ["Goto running clock" org-clock-goto t]
17673 "--"
17674 ["Display times" org-clock-display t]
17675 ["Create clock table" org-clock-report t]
17676 "--"
17677 ["Record DONE time"
17678 (progn (setq org-log-done (not org-log-done))
17679 (message "Switching to %s will %s record a timestamp"
17680 (car org-done-keywords)
17681 (if org-log-done "automatically" "not")))
17682 :style toggle :selected org-log-done])
17683 "--"
17684 ["Agenda Command..." org-agenda t]
17685 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
17686 ("File List for Agenda")
17687 ("Special views current file"
17688 ["TODO Tree" org-show-todo-tree t]
17689 ["Check Deadlines" org-check-deadlines t]
17690 ["Timeline" org-timeline t]
17691 ["Tags/Property tree" org-match-sparse-tree t])
17692 "--"
17693 ["Export/Publish..." org-export t]
17694 ("LaTeX"
17695 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
17696 :selected org-cdlatex-mode]
17697 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
17698 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
17699 ["Modify math symbol" org-cdlatex-math-modify
17700 (org-inside-LaTeX-fragment-p)]
17701 ["Insert citation" org-reftex-citation t]
17702 "--"
17703 ["Template for BEAMER" org-insert-beamer-options-template t])
17704 "--"
17705 ("MobileOrg"
17706 ["Push Files and Views" org-mobile-push t]
17707 ["Get Captured and Flagged" org-mobile-pull t]
17708 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
17709 "--"
17710 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
17711 "--"
17712 ("Documentation"
17713 ["Show Version" org-version t]
17714 ["Info Documentation" org-info t])
17715 ("Customize"
17716 ["Browse Org Group" org-customize t]
17717 "--"
17718 ["Expand This Menu" org-create-customize-menu
17719 (fboundp 'customize-menu-create)])
17720 ["Send bug report" org-submit-bug-report t]
17721 "--"
17722 ("Refresh/Reload"
17723 ["Refresh setup current buffer" org-mode-restart t]
17724 ["Reload Org (after update)" org-reload t]
17725 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
17726 ))
17728 (defun org-info (&optional node)
17729 "Read documentation for Org-mode in the info system.
17730 With optional NODE, go directly to that node."
17731 (interactive)
17732 (info (format "(org)%s" (or node ""))))
17734 ;;;###autoload
17735 (defun org-submit-bug-report ()
17736 "Submit a bug report on Org-mode via mail.
17738 Don't hesitate to report any problems or inaccurate documentation.
17740 If you don't have setup sending mail from (X)Emacs, please copy the
17741 output buffer into your mail program, as it gives us important
17742 information about your Org-mode version and configuration."
17743 (interactive)
17744 (require 'reporter)
17745 (org-load-modules-maybe)
17746 (org-require-autoloaded-modules)
17747 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
17748 (reporter-submit-bug-report
17749 "emacs-orgmode@gnu.org"
17750 (org-version)
17751 (let (list)
17752 (save-window-excursion
17753 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
17754 (delete-other-windows)
17755 (erase-buffer)
17756 (insert "You are about to submit a bug report to the Org-mode mailing list.
17758 We would like to add your full Org-mode and Outline configuration to the
17759 bug report. This greatly simplifies the work of the maintainer and
17760 other experts on the mailing list.
17762 HOWEVER, some variables you have customized may contain private
17763 information. The names of customers, colleagues, or friends, might
17764 appear in the form of file names, tags, todo states, or search strings.
17765 If you answer yes to the prompt, you might want to check and remove
17766 such private information before sending the email.")
17767 (add-text-properties (point-min) (point-max) '(face org-warning))
17768 (when (yes-or-no-p "Include your Org-mode configuration ")
17769 (mapatoms
17770 (lambda (v)
17771 (and (boundp v)
17773 (or (and (symbol-value v)
17775 (and
17776 (get v 'custom-type) (get v 'standard-value)
17777 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
17778 (push v list)))))
17779 (kill-buffer (get-buffer "*Warn about privacy*"))
17780 list))
17781 nil nil
17782 "Remember to cover the basics, that is, what you expected to happen and
17783 what in fact did happen. You don't know how to make a good report? See
17785 http://orgmode.org/manual/Feedback.html#Feedback
17787 Your bug report will be posted to the Org-mode mailing list.
17788 ------------------------------------------------------------------------")
17789 (save-excursion
17794 (defun org-install-agenda-files-menu ()
17795 (let ((bl (buffer-list)))
17796 (save-excursion
17797 (while bl
17798 (set-buffer (pop bl))
17799 (if (org-mode-p) (setq bl nil)))
17800 (when (org-mode-p)
17801 (easy-menu-change
17802 '("Org") "File List for Agenda"
17803 (append
17804 (list
17805 ["Edit File List" (org-edit-agenda-file-list) t]
17806 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
17807 ["Remove Current File from List" org-remove-file t]
17808 ["Cycle through agenda files" org-cycle-agenda-files t]
17809 ["Occur in all agenda files" org-occur-in-agenda-files t]
17810 "--")
17811 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
17813 ;;;; Documentation
17815 ;;;###autoload
17816 (defun org-require-autoloaded-modules ()
17817 (interactive)
17818 (mapc 'require
17819 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
17820 org-docbook org-exp org-html org-icalendar
17821 org-id org-latex
17822 org-publish org-remember org-table
17823 org-timer org-xoxo)))
17825 ;;;###autoload
17826 (defun org-reload (&optional uncompiled)
17827 "Reload all org lisp files.
17828 With prefix arg UNCOMPILED, load the uncompiled versions."
17829 (interactive "P")
17830 (require 'find-func)
17832 (dir-org (file-name-directory (org-find-library-name "org")))
17833 (dir-org-contrib (ignore-errors
17834 (file-name-directory
17835 (org-find-library-name "org-contribdir"))))
17836 (babel-files
17837 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
17838 (append (list nil "comint" "eval" "exp" "keys"
17839 "lob" "ref" "table" "tangle")
17840 (delq nil
17841 (mapcar
17842 (lambda (lang)
17843 (when (cdr lang) (symbol-name (car lang))))
17844 org-babel-load-languages)))))
17845 (files
17846 (append (directory-files dir-org t file-re)
17847 babel-files
17848 (and dir-org-contrib
17849 (directory-files dir-org-contrib t file-re))))
17850 (remove-re (concat (if (featurep 'xemacs)
17851 "org-colview" "org-colview-xemacs")
17853 (setq files (mapcar 'file-name-sans-extension files))
17854 (setq files (mapcar
17855 (lambda (x) (if (string-match remove-re x) nil x))
17856 files))
17857 (setq files (delq nil files))
17858 (mapc
17859 (lambda (f)
17860 (when (featurep (intern (file-name-nondirectory f)))
17861 (if (and (not uncompiled)
17862 (file-exists-p (concat f ".elc")))
17863 (load (concat f ".elc") nil nil t)
17864 (load (concat f ".el") nil nil t))))
17865 files))
17866 (org-version))
17868 ;;;###autoload
17869 (defun org-customize ()
17870 "Call the customize function with org as argument."
17871 (interactive)
17872 (org-load-modules-maybe)
17873 (org-require-autoloaded-modules)
17874 (customize-browse 'org))
17876 (defun org-create-customize-menu ()
17877 "Create a full customization menu for Org-mode, insert it into the menu."
17878 (interactive)
17879 (org-load-modules-maybe)
17880 (org-require-autoloaded-modules)
17881 (if (fboundp 'customize-menu-create)
17882 (progn
17883 (easy-menu-change
17884 '("Org") "Customize"
17885 `(["Browse Org group" org-customize t]
17886 "--"
17887 ,(customize-menu-create 'org)
17888 ["Set" Custom-set t]
17889 ["Save" Custom-save t]
17890 ["Reset to Current" Custom-reset-current t]
17891 ["Reset to Saved" Custom-reset-saved t]
17892 ["Reset to Standard Settings" Custom-reset-standard t]))
17894 (error "Cannot expand menu (outdated version of cus-edit.el)")))
17896 ;;;; Miscellaneous stuff
17898 ;;; Generally useful functions
17900 (defun org-get-at-bol (property)
17901 "Get text property PROPERTY at beginning of line."
17902 (get-text-property (point-at-bol) property))
17904 (defun org-find-text-property-in-string (prop s)
17905 "Return the first non-nil value of property PROP in string S."
17906 (or (get-text-property 0 prop s)
17907 (get-text-property (or (next-single-property-change 0 prop s) 0)
17908 prop s)))
17910 (defun org-display-warning (message) ;; Copied from Emacs-Muse
17911 "Display the given MESSAGE as a warning."
17912 (if (fboundp 'display-warning)
17913 (display-warning 'org message
17914 (if (featurep 'xemacs) 'warning :warning))
17915 (let ((buf (get-buffer-create "*Org warnings*")))
17916 (with-current-buffer buf
17917 (goto-char (point-max))
17918 (insert "Warning (Org): " message)
17919 (unless (bolp)
17920 (newline)))
17921 (display-buffer buf)
17922 (sit-for 0))))
17924 (defun org-in-commented-line ()
17925 "Is point in a line starting with `#'?"
17926 (equal (char-after (point-at-bol)) ?#))
17928 (defun org-in-indented-comment-line ()
17929 "Is point in a line starting with `#' after some white space?"
17930 (save-excursion
17931 (save-match-data
17932 (goto-char (point-at-bol))
17935 (defun org-in-verbatim-emphasis ()
17936 (save-match-data
17937 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
17939 (defun org-goto-marker-or-bmk (marker &optional bookmark)
17940 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
17941 (if (and marker (marker-buffer marker)
17942 (buffer-live-p (marker-buffer marker)))
17943 (progn
17944 (switch-to-buffer (marker-buffer marker))
17945 (if (or (> marker (point-max)) (< marker (point-min)))
17946 (widen))
17947 (goto-char marker)
17948 (org-show-context 'org-goto))
17949 (if bookmark
17950 (bookmark-jump bookmark)
17951 (error "Cannot find location"))))
17953 (defun org-quote-csv-field (s)
17954 "Quote field for inclusion in CSV material."
17957 s))
17959 (defun org-plist-delete (plist property)
17960 "Delete PROPERTY from PLIST.
17961 This is in contrast to merely setting it to 0."
17962 (let (p)
17963 (while plist
17964 (if (not (eq property (car plist)))
17965 (setq p (plist-put p (car plist) (nth 1 plist))))
17966 (setq plist (cddr plist)))
17967 p))
17969 (defun org-force-self-insert (N)
17970 "Needed to enforce self-insert under remapping."
17971 (interactive "p")
17972 (self-insert-command N))
17974 (defun org-string-width (s)
17975 "Compute width of string, ignoring invisible characters.
17976 This ignores character with invisibility property `org-link', and also
17977 characters with property `org-cwidth', because these will become invisible
17978 upon the next fontification round."
17979 (let (b l)
17980 (when (or (eq t buffer-invisibility-spec)
17981 (assq 'org-link buffer-invisibility-spec))
17982 (while (setq b (text-property-any 0 (length s)
17983 'invisible 'org-link s))
17984 (setq s (concat (substring s 0 b)
17985 (substring s (or (next-single-property-change
17986 b 'invisible s) (length s)))))))
17987 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
17988 (setq s (concat (substring s 0 b)
17989 (substring s (or (next-single-property-change
17990 b 'org-cwidth s) (length s))))))
17991 (setq l (string-width s) b -1)
17992 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
17993 (setq l (- l (get-text-property b 'org-dwidth-n s))))
17994 l))
17996 (defun org-shorten-string (s maxlength)
17997 "Shorten string S so tht it is no longer than MAXLENGTH characters.
17998 If the string is shorter or has length MAXLENGTH, just return the
17999 original string. If it is longer, the functions finds a space in the
18000 string, breaks this string off at that locations and adds three dots
18001 as ellipsis. Including the ellipsis, the string will not be longer
18002 than MAXLENGTH. If finding a good breaking point in the string does
18003 not work, the string is just chopped off in the middle of a word
18004 if necessary."
18005 (if (<= (length s) maxlength)
18006 s
18007 (let* ((n (max (- maxlength 4) 1))
18009 (if (string-match re s)
18010 (concat (match-string 1 s) "...")
18011 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18013 (defun org-get-indentation (&optional line)
18014 "Get the indentation of the current line, interpreting tabs.
18015 When LINE is given, assume it represents a line and compute its indentation."
18016 (if line
18017 (if (string-match "^ *" (org-remove-tabs line))
18018 (match-end 0))
18019 (save-excursion
18020 (beginning-of-line 1)
18022 (current-column))))
18024 (defun org-remove-tabs (s &optional width)
18025 "Replace tabulators in S with spaces.
18026 Assumes that s is a single line, starting in column 0."
18027 (setq width (or width tab-width))
18029 (setq s (replace-match
18030 (make-string
18031 (- (* width (/ (+ (match-beginning 0) width) width))
18032 (match-beginning 0)) ?\ )
18033 t t s)))
18034 s)
18036 (defun org-fix-indentation (line ind)
18037 "Fix indentation in LINE.
18038 IND is a cons cell with target and minimum indentation.
18039 If the current indentation in LINE is smaller than the minimum,
18040 leave it alone. If it is larger than ind, set it to the target."
18041 (let* ((l (org-remove-tabs line))
18042 (i (org-get-indentation l))
18043 (i1 (car ind)) (i2 (cdr ind)))
18044 (if (>= i i2) (setq l (substring line i2)))
18045 (if (> i1 0)
18046 (concat (make-string i1 ?\ ) l)
18047 l)))
18049 (defun org-remove-indentation (code &optional n)
18050 "Remove the maximum common indentation from the lines in CODE.
18051 N may optionally be the number of spaces to remove."
18052 (with-temp-buffer
18053 (insert code)
18054 (org-do-remove-indentation n)
18055 (buffer-string)))
18057 (defun org-do-remove-indentation (&optional n)
18058 "Remove the maximum common indentation from the buffer."
18059 (untabify (point-min) (point-max))
18060 (let ((min 10000) re)
18061 (if n
18062 (setq min n)
18063 (goto-char (point-min))
18065 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18066 (unless (or (= min 0) (= min 10000))
18068 (goto-char (point-min))
18069 (while (re-search-forward re nil t)
18070 (replace-match "")
18071 (end-of-line 1))
18072 min)))
18074 (defun org-fill-template (template alist)
18075 "Find each %key of ALIST in TEMPLATE and replace it."
18076 (let ((case-fold-search nil)
18077 entry key value)
18078 (setq alist (sort (copy-sequence alist)
18079 (lambda (a b) (< (length (car a)) (length (car b))))))
18080 (while (setq entry (pop alist))
18081 (setq template
18082 (replace-regexp-in-string
18083 (concat "%" (regexp-quote (car entry)))
18084 (cdr entry) template t t)))
18085 template))
18087 (defun org-base-buffer (buffer)
18088 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18089 (if (not buffer)
18090 buffer
18091 (or (buffer-base-buffer buffer)
18092 buffer)))
18094 (defun org-trim (s)
18095 "Remove whitespace at beginning and end of string."
18098 s)
18100 (defun org-wrap (string &optional width lines)
18101 "Wrap string to either a number of lines, or a width in characters.
18102 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18103 that costs. If there is a word longer than WIDTH, the text is actually
18104 wrapped to the length of that word.
18105 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18106 many lines, whatever width that takes.
18107 The return value is a list of lines, without newlines at the end."
18109 (maxword (apply 'max (mapcar 'org-string-width words)))
18110 w ll)
18111 (cond (width
18112 (org-do-wrap words (max maxword width)))
18113 (lines
18114 (setq w maxword)
18115 (setq ll (org-do-wrap words maxword))
18116 (if (<= (length ll) lines)
18117 ll
18118 (setq ll words)
18119 (while (> (length ll) lines)
18120 (setq w (1+ w))
18121 (setq ll (org-do-wrap words w)))
18122 ll))
18123 (t (error "Cannot wrap this")))))
18125 (defun org-do-wrap (words width)
18126 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18127 (let (lines line)
18128 (while words
18129 (setq line (pop words))
18130 (while (and words (< (+ (length line) (length (car words))) width))
18131 (setq line (concat line " " (pop words))))
18132 (setq lines (push line lines)))
18133 (nreverse lines)))
18135 (defun org-split-string (string &optional separators)
18136 "Splits STRING into substrings at SEPARATORS.
18137 No empty strings are returned if there are matches at the beginning
18138 and end of string."
18140 (start 0)
18141 notfirst
18142 (list nil))
18143 (while (and (string-match rexp string
18144 (if (and notfirst
18145 (= start (match-beginning 0))
18146 (< start (length string)))
18147 (1+ start) start))
18148 (< (match-beginning 0) (length string)))
18149 (setq notfirst t)
18150 (or (eq (match-beginning 0) 0)
18151 (and (eq (match-beginning 0) (match-end 0))
18152 (eq (match-beginning 0) start))
18153 (setq list
18154 (cons (substring string start (match-beginning 0))
18155 list)))
18156 (setq start (match-end 0)))
18157 (or (eq start (length string))
18158 (setq list
18159 (cons (substring string start)
18160 list)))
18161 (nreverse list)))
18163 (defun org-quote-vert (s)
18165 (while (string-match "|" s)
18167 s)
18169 (defun org-uuidgen-p (s)
18170 "Is S an ID created by UUIDGEN?"
18171 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18173 (defun org-context ()
18174 "Return a list of contexts of the current cursor position.
18175 If several contexts apply, all are returned.
18176 Each context entry is a list with a symbol naming the context, and
18177 two positions indicating start and end of the context. Possible
18178 contexts are:
18180 :headline anywhere in a headline
18181 :headline-stars on the leading stars in a headline
18182 :todo-keyword on a TODO keyword (including DONE) in a headline
18183 :tags on the TAGS in a headline
18184 :priority on the priority cookie in a headline
18185 :item on the first line of a plain list item
18186 :item-bullet on the bullet/number of a plain list item
18187 :checkbox on the checkbox in a plain list item
18188 :table in an org-mode table
18189 :table-special on a special filed in a table
18190 :table-table in a table.el table
18191 :link on a hyperlink
18192 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18193 :target on a <<target>>
18194 :radio-target on a <<<radio-target>>>
18195 :latex-fragment on a LaTeX fragment
18196 :latex-preview on a LaTeX fragment with overlayed preview image
18198 This function expects the position to be visible because it uses font-lock
18199 faces as a help to recognize the following contexts: :table-special, :link,
18200 and :keyword."
18201 (let* ((f (get-text-property (point) 'face))
18202 (faces (if (listp f) f (list f)))
18203 (p (point)) clist o)
18204 ;; First the large context
18205 (cond
18206 ((org-on-heading-p t)
18207 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18208 (when (progn
18209 (beginning-of-line 1)
18210 (looking-at org-todo-line-tags-regexp))
18211 (push (org-point-in-group p 1 :headline-stars) clist)
18212 (push (org-point-in-group p 2 :todo-keyword) clist)
18213 (push (org-point-in-group p 4 :tags) clist))
18214 (goto-char p)
18217 (push (org-point-in-group p 0 :priority) clist)))
18219 ((org-at-item-p)
18220 (push (org-point-in-group p 2 :item-bullet) clist)
18221 (push (list :item (point-at-bol)
18222 (save-excursion (org-end-of-item) (point)))
18223 clist)
18224 (and (org-at-item-checkbox-p)
18225 (push (org-point-in-group p 0 :checkbox) clist)))
18227 ((org-at-table-p)
18228 (push (list :table (org-table-begin) (org-table-end)) clist)
18229 (if (memq 'org-formula faces)
18230 (push (list :table-special
18231 (previous-single-property-change p 'face)
18232 (next-single-property-change p 'face)) clist)))
18233 ((org-at-table-p 'any)
18234 (push (list :table-table) clist)))
18235 (goto-char p)
18237 ;; Now the small context
18238 (cond
18239 ((org-at-timestamp-p)
18240 (push (org-point-in-group p 0 :timestamp) clist))
18241 ((memq 'org-link faces)
18242 (push (list :link
18243 (previous-single-property-change p 'face)
18244 (next-single-property-change p 'face)) clist))
18245 ((memq 'org-special-keyword faces)
18246 (push (list :keyword
18247 (previous-single-property-change p 'face)
18248 (next-single-property-change p 'face)) clist))
18249 ((org-on-target-p)
18250 (push (org-point-in-group p 0 :target) clist)
18251 (goto-char (1- (match-beginning 0)))
18252 (if (looking-at org-radio-target-regexp)
18253 (push (org-point-in-group p 0 :radio-target) clist))
18254 (goto-char p))
18255 ((setq o (car (delq nil
18256 (mapcar
18257 (lambda (x)
18258 (if (memq x org-latex-fragment-image-overlays) x))
18259 (overlays-at (point))))))
18260 (push (list :latex-fragment
18261 (overlay-start o) (overlay-end o)) clist)
18262 (push (list :latex-preview
18263 (overlay-start o) (overlay-end o)) clist))
18264 ((org-inside-LaTeX-fragment-p)
18265 ;; FIXME: positions wrong.
18266 (push (list :latex-fragment (point) (point)) clist)))
18268 (setq clist (nreverse (delq nil clist)))
18269 clist))
18271 ;; FIXME: Compare with at-regexp-p Do we need both?
18272 (defun org-in-regexp (re &optional nlines visually)
18273 "Check if point is inside a match of regexp.
18274 Normally only the current line is checked, but you can include NLINES extra
18275 lines both before and after point into the search.
18276 If VISUALLY is set, require that the cursor is not after the match but
18277 really on, so that the block visually is on the match."
18278 (catch 'exit
18279 (let ((pos (point))
18280 (eol (point-at-eol (+ 1 (or nlines 0))))
18281 (inc (if visually 1 0)))
18282 (save-excursion
18283 (beginning-of-line (- 1 (or nlines 0)))
18284 (while (re-search-forward re eol t)
18285 (if (and (<= (match-beginning 0) pos)
18286 (>= (+ inc (match-end 0)) pos))
18287 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18289 (defun org-at-regexp-p (regexp)
18290 "Is point inside a match of REGEXP in the current line?"
18291 (catch 'exit
18292 (save-excursion
18293 (let ((pos (point)) (end (point-at-eol)))
18294 (beginning-of-line 1)
18295 (while (re-search-forward regexp end t)
18296 (if (and (<= (match-beginning 0) pos)
18297 (>= (match-end 0) pos))
18298 (throw 'exit t)))
18299 nil))))
18301 (defun org-in-regexps-block-p (start-re end-re &optional bound)
18302 "Return t if the current point is between matches of START-RE and END-RE.
18303 This will also return t if point is on one of the two matches or
18304 in an unfinished block. END-RE can be a string or a form
18305 returning a string.
18307 An optional third argument bounds the search for START-RE. It
18308 defaults to previous heading or `point-min'."
18309 (let ((pos (point))
18310 (limit (or bound (save-excursion (outline-previous-heading)))))
18311 (save-excursion
18312 ;; we're on a block when point is on start-re...
18313 (or (org-at-regexp-p start-re)
18314 ;; ... or start-re can be found above...
18315 (and (re-search-backward start-re limit t)
18316 ;; ... but no end-re between start-re and point.
18317 (not (re-search-forward (eval end-re) pos t)))))))
18319 (defun org-occur-in-agenda-files (regexp &optional nlines)
18320 "Call `multi-occur' with buffers for all agenda files."
18322 (let* ((files (org-agenda-files))
18323 (tnames (mapcar 'file-truename files))
18324 (extra org-agenda-text-search-extra-files)
18325 f)
18326 (when (eq (car extra) 'agenda-archives)
18327 (setq extra (cdr extra))
18328 (setq files (org-add-archive-files files)))
18329 (while (setq f (pop extra))
18330 (unless (member (file-truename f) tnames)
18331 (add-to-list 'files f 'append)
18332 (add-to-list 'tnames (file-truename f) 'append)))
18333 (multi-occur
18334 (mapcar (lambda (x)
18335 (with-current-buffer
18336 (or (get-file-buffer x) (find-file-noselect x))
18337 (widen)
18338 (current-buffer)))
18339 files)
18340 regexp)))
18342 (if (boundp 'occur-mode-find-occurrence-hook)
18343 ;; Emacs 23
18344 (add-hook 'occur-mode-find-occurrence-hook
18345 (lambda ()
18346 (when (org-mode-p)
18347 (org-reveal))))
18348 ;; Emacs 22
18349 (defadvice occur-mode-goto-occurrence
18350 (after org-occur-reveal activate)
18351 (and (org-mode-p) (org-reveal)))
18352 (defadvice occur-mode-goto-occurrence-other-window
18353 (after org-occur-reveal activate)
18354 (and (org-mode-p) (org-reveal)))
18355 (defadvice occur-mode-display-occurrence
18356 (after org-occur-reveal activate)
18357 (when (org-mode-p)
18358 (let ((pos (occur-mode-find-occurrence)))
18359 (with-current-buffer (marker-buffer pos)
18360 (save-excursion
18361 (goto-char pos)
18362 (org-reveal)))))))
18364 (defun org-occur-link-in-agenda-files ()
18365 "Create a link and search for it in the agendas.
18366 The link is not stored in `org-stored-links', it is just created
18367 for the search purpose."
18368 (interactive)
18369 (let ((link (condition-case nil
18370 (org-store-link nil)
18371 (error "Unable to create a link to here"))))
18372 (org-occur-in-agenda-files (regexp-quote link))))
18374 (defun org-uniquify (list)
18375 "Remove duplicate elements from LIST."
18376 (let (res)
18377 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
18378 res))
18380 (defun org-delete-all (elts list)
18381 "Remove all elements in ELTS from LIST."
18382 (while elts
18383 (setq list (delete (pop elts) list)))
18384 list)
18386 (defun org-count (cl-item cl-seq)
18387 "Count the number of occurrences of ITEM in SEQ.
18388 Taken from `count' in cl-seq.el with all keyword arguments removed."
18389 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
18390 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
18391 (while (< cl-start cl-end)
18392 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
18393 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
18394 (setq cl-start (1+ cl-start)))
18395 cl-count))
18397 (defun org-remove-if (predicate seq)
18398 "Remove everything from SEQ that fulfills PREDICATE."
18399 (let (res e)
18400 (while seq
18401 (setq e (pop seq))
18402 (if (not (funcall predicate e)) (push e res)))
18403 (nreverse res)))
18405 (defun org-remove-if-not (predicate seq)
18406 "Remove everything from SEQ that does not fulfill PREDICATE."
18407 (let (res e)
18408 (while seq
18409 (setq e (pop seq))
18410 (if (funcall predicate e) (push e res)))
18411 (nreverse res)))
18413 (defun org-back-over-empty-lines ()
18414 "Move backwards over whitespace, to the beginning of the first empty line.
18415 Returns the number of empty lines passed."
18416 (let ((pos (point)))
18418 (beginning-of-line 2)
18419 (goto-char (min (point) pos))
18420 (count-lines (point) pos)))
18422 (defun org-skip-whitespace ()
18425 (defun org-point-in-group (point group &optional context)
18426 "Check if POINT is in match-group GROUP.
18427 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18428 match. If the match group does not exist or point is not inside it,
18429 return nil."
18430 (and (match-beginning group)
18431 (>= point (match-beginning group))
18432 (<= point (match-end group))
18433 (if context
18434 (list context (match-beginning group) (match-end group))
18435 t)))
18437 (defun org-switch-to-buffer-other-window (&rest args)
18438 "Switch to buffer in a second window on the current frame.
18439 In particular, do not allow pop-up frames.
18440 Returns the newly created buffer."
18441 (let (pop-up-frames special-display-buffer-names special-display-regexps
18442 special-display-function)
18443 (apply 'switch-to-buffer-other-window args)))
18445 (defun org-combine-plists (&rest plists)
18446 "Create a single property list from all plists in PLISTS.
18447 The process starts by copying the first list, and then setting properties
18448 from the other lists. Settings in the last list are the most significant
18449 ones and overrule settings in the other lists."
18450 (let ((rtn (copy-sequence (pop plists)))
18451 p v ls)
18452 (while plists
18453 (setq ls (pop plists))
18454 (while ls
18455 (setq p (pop ls) v (pop ls))
18456 (setq rtn (plist-put rtn p v))))
18457 rtn))
18459 (defun org-move-line-down (arg)
18460 "Move the current line down. With prefix argument, move it past ARG lines."
18461 (interactive "p")
18462 (let ((col (current-column))
18463 beg end pos)
18464 (beginning-of-line 1) (setq beg (point))
18465 (beginning-of-line 2) (setq end (point))
18466 (beginning-of-line (+ 1 arg))
18467 (setq pos (move-marker (make-marker) (point)))
18468 (insert (delete-and-extract-region beg end))
18469 (goto-char pos)
18470 (org-move-to-column col)))
18472 (defun org-move-line-up (arg)
18473 "Move the current line up. With prefix argument, move it past ARG lines."
18474 (interactive "p")
18475 (let ((col (current-column))
18476 beg end pos)
18477 (beginning-of-line 1) (setq beg (point))
18478 (beginning-of-line 2) (setq end (point))
18479 (beginning-of-line (- arg))
18480 (setq pos (move-marker (make-marker) (point)))
18481 (insert (delete-and-extract-region beg end))
18482 (goto-char pos)
18483 (org-move-to-column col)))
18485 (defun org-replace-escapes (string table)
18486 "Replace %-escapes in STRING with values in TABLE.
18488 The sequences in STRING may contain normal field width and padding information,
18490 so values can contain further %-escapes if they are define later in TABLE."
18491 (let ((tbl (copy-alist table))
18492 (case-fold-search nil)
18493 (pchg 0)
18494 e re rpl)
18495 (while (setq e (pop tbl))
18496 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
18497 (when (and (cdr e) (string-match re (cdr e)))
18498 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
18499 (safe "SREF"))
18500 (add-text-properties 0 3 (list 'sref sref) safe)
18501 (setcdr e (replace-match safe t t (cdr e)))))
18502 (while (string-match re string)
18503 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
18504 (cdr e)))
18505 (setq string (replace-match rpl t t string))))
18506 (while (setq pchg (next-property-change pchg string))
18507 (let ((sref (get-text-property pchg 'sref string)))
18508 (when (and sref (string-match "SREF" string pchg))
18509 (setq string (replace-match sref t t string)))))
18510 string))
18512 (defun org-sublist (list start end)
18513 "Return a section of LIST, from START to END.
18514 Counting starts at 1."
18515 (let (rtn (c start))
18516 (setq list (nthcdr (1- start) list))
18517 (while (and list (<= c end))
18518 (push (pop list) rtn)
18519 (setq c (1+ c)))
18520 (nreverse rtn)))
18522 (defun org-find-base-buffer-visiting (file)
18523 "Like `find-buffer-visiting' but always return the base buffer and
18524 not an indirect buffer."
18525 (let ((buf (or (get-file-buffer file)
18526 (find-buffer-visiting file))))
18527 (if buf
18528 (or (buffer-base-buffer buf) buf)
18529 nil)))
18531 (defun org-image-file-name-regexp (&optional extensions)
18532 "Return regexp matching the file names of images.
18533 If EXTENSIONS is given, only match these."
18534 (if (and (not extensions) (fboundp 'image-file-name-regexp))
18535 (image-file-name-regexp)
18536 (let ((image-file-name-extensions
18537 (or extensions
18538 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
18539 "xbm" "xpm" "pbm" "pgm" "ppm"))))
18541 (regexp-opt (nconc (mapcar 'upcase
18542 image-file-name-extensions)
18543 image-file-name-extensions)
18544 t)
18547 (defun org-file-image-p (file &optional extensions)
18548 "Return non-nil if FILE is an image."
18549 (save-match-data
18550 (string-match (org-image-file-name-regexp extensions) file)))
18552 (defun org-get-cursor-date ()
18553 "Return the date at cursor in as a time.
18554 This works in the calendar and in the agenda, anywhere else it just
18555 returns the current time."
18556 (let (date day defd)
18557 (cond
18558 ((eq major-mode 'calendar-mode)
18559 (setq date (calendar-cursor-to-date)
18560 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
18561 ((eq major-mode 'org-agenda-mode)
18562 (setq day (get-text-property (point) 'day))
18563 (if day
18564 (setq date (calendar-gregorian-from-absolute day)
18565 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
18566 (nth 2 date))))))
18567 (or defd (current-time))))
18569 (defvar org-agenda-action-marker (make-marker)
18570 "Marker pointing to the entry for the next agenda action.")
18572 (defun org-mark-entry-for-agenda-action ()
18573 "Mark the current entry as target of an agenda action.
18574 Agenda actions are actions executed from the agenda with the key `k',
18575 which make use of the date at the cursor."
18576 (interactive)
18577 (move-marker org-agenda-action-marker
18578 (save-excursion (org-back-to-heading t) (point))
18579 (current-buffer))
18580 (message
18581 "Entry marked for action; press `k' at desired date in agenda or calendar"))
18583 (defun org-mark-subtree ()
18584 "Mark the current subtree.
18585 This puts point at the start of the current subtree, and mark at the end.
18587 If point is in an inline task, mark that task instead."
18588 (interactive)
18589 (let ((inline-task-p
18590 (and (featurep 'org-inlinetask)
18591 (org-inlinetask-in-task-p)))
18592 (beg))
18593 ;; Get beginning of subtree
18594 (cond
18595 (inline-task-p (org-inlinetask-goto-beginning))
18596 ((org-at-heading-p) (beginning-of-line))
18597 (t (let ((outline-regexp (org-get-limited-outline-regexp)))
18598 (outline-previous-visible-heading 1))))
18599 (setq beg (point))
18600 ;; Get end of it
18601 (if inline-task-p
18602 (org-inlinetask-goto-end)
18603 (org-end-of-subtree))
18604 ;; Mark zone
18605 (push-mark (point) nil t)
18606 (goto-char beg)))
18608 ;;; Paragraph filling stuff.
18609 ;; We want this to be just right, so use the full arsenal.
18611 (defun org-indent-line-function ()
18612 "Indent line depending on context."
18613 (interactive)
18614 (let* ((pos (point))
18615 (itemp (org-at-item-p))
18616 (case-fold-search t)
18618 (inline-task-p (and (featurep 'org-inlinetask)
18619 (org-inlinetask-in-task-p)))
18620 column bpos bcol tpos tcol)
18621 (beginning-of-line 1)
18622 (cond
18623 ;; Comments
18624 ((looking-at "# ") (setq column 0))
18625 ;; Headings
18627 ;; Literal examples
18629 (setq column (org-get-indentation))) ; do nothing
18630 ;; Drawers
18632 (save-excursion (re-search-backward org-drawer-regexp nil t)))
18633 (save-excursion
18634 (goto-char (1- (match-beginning 1)))
18635 (setq column (current-column))))
18636 ;; Special blocks
18638 (save-excursion
18639 (re-search-backward
18641 (setq column (org-get-indentation (match-string 0))))
18644 (save-excursion
18646 (setq column
18647 (if (equal (downcase (match-string 1)) "src")
18648 ;; src blocks: let `org-edit-src-exit' handle them
18649 (org-get-indentation)
18650 (org-get-indentation (match-string 0)))))
18651 ;; Lists
18652 ((org-in-item-p)
18653 (org-beginning-of-item)
18654 (looking-at "[ \t]*\\(\\S-+\\)[ \t]*\\(\\(:?\\[@\\(:?start:\\)?[0-9]+\\][ \t]*\\)?\\[[- X]\\][ \t]*\\|.*? :: \\)?")
18655 (setq bpos (match-beginning 1) tpos (match-end 0)
18656 bcol (progn (goto-char bpos) (current-column))
18657 tcol (progn (goto-char tpos) (current-column)))
18658 (if (> tcol (+ bcol org-description-max-indent))
18659 (setq tcol (+ bcol 5)))
18660 (goto-char pos)
18661 (setq column (if itemp (org-get-indentation) tcol)))
18662 ;; This line has nothing special, look at the previous relevant
18663 ;; line to compute indentation
18664 (t
18665 (beginning-of-line 0)
18666 (while (and (not (bobp))
18667 (not (looking-at org-drawer-regexp))
18668 ;; skip comments, verbatim, empty lines, tables,
18669 ;; inline tasks, lists, drawers and blocks
18671 (re-search-backward org-drawer-regexp nil t))
18675 (and (org-in-item-p) (goto-char (org-list-top-point)))
18676 (and (not inline-task-p)
18677 (featurep 'org-inlinetask)
18678 (org-inlinetask-in-task-p)
18679 (or (org-inlinetask-goto-beginning) t))))
18680 (beginning-of-line 0))
18681 (cond
18682 ;; There was an heading above.
18684 (if (not org-adapt-indentation)
18685 (setq column 0)
18686 (goto-char (match-end 0))
18687 (setq column (current-column))))
18688 ;; A drawer had started and is unfinished
18689 ((looking-at org-drawer-regexp)
18690 (goto-char (1- (match-beginning 1)))
18691 (setq column (current-column)))
18692 ;; Else, nothing noticeable found: get indentation and go on.
18693 (t (setq column (org-get-indentation))))))
18694 ;; Now apply indentation and move cursor accordingly
18695 (goto-char pos)
18696 (if (<= (current-column) (current-indentation))
18697 (org-indent-line-to column)
18698 (save-excursion (org-indent-line-to column)))
18699 ;; Special polishing for properties, see `org-property-format'
18700 (setq column (current-column))
18701 (beginning-of-line 1)
18702 (if (looking-at
18704 (replace-match (concat (match-string 1)
18705 (format org-property-format
18706 (match-string 2) (match-string 3)))
18707 t t))
18708 (org-move-to-column column)))
18710 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
18711 "Variable to store copy of `adaptive-fill-regexp'.
18712 Since `adaptive-fill-regexp' is set to never match, we need to
18713 store a backup of its value before entering `org-mode' so that
18714 the functionality can be provided as a fall-back.")
18716 (defun org-set-autofill-regexps ()
18717 (interactive)
18718 ;; In the paragraph separator we include headlines, because filling
18719 ;; text in a line directly attached to a headline would otherwise
18720 ;; fill the headline as well.
18723 ;; The paragraph starter includes hand-formatted lists.
18724 (org-set-local
18725 'paragraph-start
18726 (concat
18735 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
18736 ;; But only if the user has not turned off tables or fixed-width regions
18737 (org-set-local
18738 'auto-fill-inhibit-regexp
18741 (if (or org-enable-table-editor org-enable-fixed-width-editor)
18742 (concat
18744 (if org-enable-table-editor "|" "")
18745 (if org-enable-fixed-width-editor ":" "")
18746 "]"))))
18747 ;; We use our own fill-paragraph function, to make sure that tables
18748 ;; and fixed-width regions are not wrapped. That function will pass
18749 ;; through to `fill-paragraph' when appropriate.
18750 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
18751 ;; Adaptive filling: To get full control, first make sure that
18752 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
18753 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
18754 (org-set-local 'org-adaptive-fill-regexp-backup
18755 adaptive-fill-regexp))
18757 (org-set-local 'adaptive-fill-function
18758 'org-adaptive-fill-function)
18759 (org-set-local
18760 'align-mode-rules-list
18761 '((org-in-buffer-settings
18763 (modes . '(org-mode))))))
18765 (defun org-fill-paragraph (&optional justify)
18766 "Re-align a table, pass through to fill-paragraph if no table."
18767 (let ((table-p (org-at-table-p))
18768 (table.el-p (org-at-table.el-p)))
18769 (cond ((and (equal (char-after (point-at-bol)) ?*)
18770 (save-excursion (goto-char (point-at-bol))
18771 (looking-at outline-regexp)))
18772 t) ; skip headlines
18773 (table.el-p t) ; skip table.el tables
18774 (table-p (org-table-align) t) ; align org-mode tables
18775 (t nil)))) ; call paragraph-fill
18777 ;; For reference, this is the default value of adaptive-fill-regexp
18780 (defun org-adaptive-fill-function ()
18781 "Return a fill prefix for org-mode files.
18782 In particular, this makes sure hanging paragraphs for hand-formatted lists
18783 work correctly."
18784 (cond
18785 ;; Comment line
18787 (match-string-no-properties 0))
18788 ;; Description list
18790 (save-excursion
18791 (if (> (match-end 1) (+ (match-beginning 1)
18792 org-description-max-indent))
18793 (goto-char (+ (match-beginning 1) 5))
18794 (goto-char (match-end 0)))
18795 (make-string (current-column) ?\ )))
18796 ;; Ordered or unordered list
18798 (save-excursion
18799 (goto-char (match-end 0))
18800 (make-string (current-column) ?\ )))
18801 ;; Other text
18802 ((looking-at org-adaptive-fill-regexp-backup)
18803 (match-string-no-properties 0))))
18805 ;;; Other stuff.
18807 (defun org-toggle-fixed-width-section (arg)
18808 "Toggle the fixed-width export.
18809 If there is no active region, the QUOTE keyword at the current headline is
18810 inserted or removed. When present, it causes the text between this headline
18811 and the next to be exported as fixed-width text, and unmodified.
18812 If there is an active region, this command adds or removes a colon as the
18813 first character of this line. If the first character of a line is a colon,
18814 this line is also exported in fixed-width font."
18815 (interactive "P")
18816 (let* ((cc 0)
18817 (regionp (org-region-active-p))
18818 (beg (if regionp (region-beginning) (point)))
18819 (end (if regionp (region-end)))
18820 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
18821 (case-fold-search nil)
18823 off)
18824 (if regionp
18825 (save-excursion
18826 (goto-char beg)
18827 (setq cc (current-column))
18828 (beginning-of-line 1)
18829 (setq off (looking-at re))
18830 (while (> nlines 0)
18831 (setq nlines (1- nlines))
18832 (beginning-of-line 1)
18833 (cond
18834 (arg
18835 (org-move-to-column cc t)
18837 (forward-line -1))
18838 ((and off (looking-at re))
18839 (replace-match "" t t nil 1))
18840 ((not off) (org-move-to-column cc t) (insert ": ")))
18841 (forward-line 1)))
18842 (save-excursion
18843 (org-back-to-heading)
18844 (if (looking-at (concat outline-regexp
18846 (replace-match "" t t nil 1)
18847 (if (looking-at outline-regexp)
18848 (progn
18849 (goto-char (match-end 0))
18850 (insert org-quote-string " "))))))))
18852 (defun org-reftex-citation ()
18853 "Use reftex-citation to insert a citation into the buffer.
18854 This looks for a line like
18856 #+BIBLIOGRAPHY: foo plain option:-d
18858 and derives from it that foo.bib is the bibliography file relevant
18859 for this document. It then installs the necessary environment for RefTeX
18860 to work in this buffer and calls `reftex-citation' to insert a citation
18861 into the buffer.
18863 Export of such citations to both LaTeX and HTML is handled by the contributed
18864 package org-exp-bibtex by Taru Karttunen."
18865 (interactive)
18866 (let ((reftex-docstruct-symbol 'rds)
18868 rds bib)
18869 (save-excursion
18870 (save-restriction
18871 (widen)
18872 (let ((case-fold-search t)
18874 (if (not (save-excursion
18875 (or (re-search-forward re nil t)
18876 (re-search-backward re nil t))))
18877 (error "No bibliography defined in file")
18878 (setq bib (concat (match-string 1) ".bib")
18879 rds (list (list 'bib bib)))))))
18880 (call-interactively 'reftex-citation)))
18882 ;;;; Functions extending outline functionality
18884 (defun org-beginning-of-line (&optional arg)
18885 "Go to the beginning of the current line. If that is invisible, continue
18886 to a visible line beginning. This makes the function of C-a more intuitive.
18887 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18888 first attempt, and only move to after the tags when the cursor is already
18889 beyond the end of the headline."
18890 (interactive "P")
18891 (let ((pos (point))
18892 (special (if (consp org-special-ctrl-a/e)
18893 (car org-special-ctrl-a/e)
18894 org-special-ctrl-a/e))
18895 refpos)
18896 (if (org-bound-and-true-p line-move-visual)
18897 (beginning-of-visual-line 1)
18898 (beginning-of-line 1))
18899 (if (and arg (fboundp 'move-beginning-of-line))
18900 (call-interactively 'move-beginning-of-line)
18901 (if (bobp)
18902 nil
18903 (backward-char 1)
18904 (if (org-truely-invisible-p)
18905 (while (and (not (bobp)) (org-truely-invisible-p))
18906 (backward-char 1)
18907 (beginning-of-line 1))
18908 (forward-char 1))))
18909 (when special
18910 (cond
18911 ((and (looking-at org-complex-heading-regexp)
18912 (= (char-after (match-end 1)) ?\ ))
18913 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
18914 (point-at-eol)))
18915 (goto-char
18916 (if (eq special t)
18917 (cond ((> pos refpos) refpos)
18918 ((= pos (point)) refpos)
18919 (t (point)))
18920 (cond ((> pos (point)) (point))
18921 ((not (eq last-command this-command)) (point))
18922 (t refpos)))))
18923 ((org-at-item-p)
18924 (goto-char
18925 (if (eq special t)
18926 (cond ((> pos (match-end 4)) (match-end 4))
18927 ((= pos (point)) (match-end 4))
18928 (t (point)))
18929 (cond ((> pos (point)) (point))
18930 ((not (eq last-command this-command)) (point))
18931 (t (match-end 4))))))))
18932 (org-no-warnings
18933 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18935 (defun org-end-of-line (&optional arg)
18936 "Go to the end of the line.
18937 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18938 first attempt, and only move to after the tags when the cursor is already
18939 beyond the end of the headline."
18940 (interactive "P")
18941 (let ((special (if (consp org-special-ctrl-a/e)
18942 (cdr org-special-ctrl-a/e)
18943 org-special-ctrl-a/e)))
18944 (if (or (not special)
18945 (not (org-on-heading-p))
18946 arg)
18947 (call-interactively
18948 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
18949 ((fboundp 'move-end-of-line) 'move-end-of-line)
18950 (t 'end-of-line)))
18951 (let ((pos (point)))
18952 (beginning-of-line 1)
18954 (if (eq special t)
18955 (if (or (< pos (match-beginning 1))
18956 (= pos (match-end 0)))
18957 (goto-char (match-beginning 1))
18958 (goto-char (match-end 0)))
18959 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
18960 (goto-char (match-end 0))
18961 (goto-char (match-beginning 1))))
18962 (call-interactively (if (fboundp 'move-end-of-line)
18963 'move-end-of-line
18964 'end-of-line)))))
18965 (org-no-warnings
18966 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18968 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
18969 (define-key org-mode-map "\C-e" 'org-end-of-line)
18971 (defun org-backward-sentence (&optional arg)
18972 "Go to beginning of sentence, or beginning of table field.
18973 This will call `backward-sentence' or `org-table-beginning-of-field',
18974 depending on context."
18975 (interactive "P")
18976 (cond
18977 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
18978 (t (call-interactively 'backward-sentence))))
18980 (defun org-forward-sentence (&optional arg)
18981 "Go to end of sentence, or end of table field.
18982 This will call `forward-sentence' or `org-table-end-of-field',
18983 depending on context."
18984 (interactive "P")
18985 (cond
18986 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
18987 (t (call-interactively 'forward-sentence))))
18989 (define-key org-mode-map "\M-a" 'org-backward-sentence)
18990 (define-key org-mode-map "\M-e" 'org-forward-sentence)
18992 (defun org-kill-line (&optional arg)
18993 "Kill line, to tags or end of line."
18994 (interactive "P")
18995 (cond
18996 ((or (not org-special-ctrl-k)
18997 (bolp)
18998 (not (org-on-heading-p)))
18999 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19000 org-ctrl-k-protect-subtree)
19001 (if (or (eq org-ctrl-k-protect-subtree 'error)
19002 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19003 (error "C-k aborted - would kill hidden subtree")))
19004 (call-interactively 'kill-line))
19006 (kill-region (point) (match-beginning 1))
19007 (org-set-tags nil t))
19008 (t (kill-region (point) (point-at-eol)))))
19010 (define-key org-mode-map "\C-k" 'org-kill-line)
19012 (defun org-yank (&optional arg)
19013 "Yank. If the kill is a subtree, treat it specially.
19014 This command will look at the current kill and check if is a single
19015 subtree, or a series of subtrees[1]. If it passes the test, and if the
19016 cursor is at the beginning of a line or after the stars of a currently
19017 empty headline, then the yank is handled specially. How exactly depends
19018 on the value of the following variables, both set by default.
19020 org-yank-folded-subtrees
19021 When set, the subtree(s) will be folded after insertion, but only
19022 if doing so would now swallow text after the yanked text.
19024 org-yank-adjusted-subtrees
19025 When set, the subtree will be promoted or demoted in order to
19026 fit into the local outline tree structure, which means that the level
19027 will be adjusted so that it becomes the smaller one of the two
19028 *visible* surrounding headings.
19030 Any prefix to this command will cause `yank' to be called directly with
19032 will just
19033 plainly yank the text as it is.
19035 \[1] The test checks if the first non-white line is a heading
19036 and if there are no other headings with fewer stars."
19037 (interactive "P")
19038 (org-yank-generic 'yank arg))
19040 (defun org-yank-generic (command arg)
19041 "Perform some yank-like command.
19043 This function implements the behavior described in the `org-yank'
19044 documentation. However, it has been generalized to work for any
19045 interactive command with similar behavior."
19047 ;; pretend to be command COMMAND
19048 (setq this-command command)
19050 (if arg
19051 (call-interactively command)
19053 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19054 (and (org-kill-is-subtree-p)
19055 (or (bolp)
19057 (string-match
19059 (buffer-substring (point-at-bol) (point)))))))
19060 swallowp)
19061 (cond
19062 ((and subtreep org-yank-folded-subtrees)
19063 (let ((beg (point))
19064 end)
19065 (if (and subtreep org-yank-adjusted-subtrees)
19066 (org-paste-subtree nil nil 'for-yank)
19067 (call-interactively command))
19069 (setq end (point))
19070 (goto-char beg)
19071 (when (and (bolp) subtreep
19072 (not (setq swallowp
19073 (org-yank-folding-would-swallow-text beg end))))
19074 (or (looking-at outline-regexp)
19075 (re-search-forward (concat "^" outline-regexp) end t))
19076 (while (and (< (point) end) (looking-at outline-regexp))
19077 (hide-subtree)
19078 (org-cycle-show-empty-lines 'folded)
19079 (condition-case nil
19080 (outline-forward-same-level 1)
19081 (error (goto-char end)))))
19082 (when swallowp
19083 (message
19084 "Inserted text not folded because that would swallow text"))
19086 (goto-char end)
19088 (beginning-of-line 1)
19089 (push-mark beg 'nomsg)))
19090 ((and subtreep org-yank-adjusted-subtrees)
19091 (let ((beg (point-at-bol)))
19092 (org-paste-subtree nil nil 'for-yank)
19093 (push-mark beg 'nomsg)))
19094 (t
19095 (call-interactively command))))))
19097 (defun org-yank-folding-would-swallow-text (beg end)
19098 "Would hide-subtree at BEG swallow any text after END?"
19099 (let (level)
19100 (save-excursion
19101 (goto-char beg)
19102 (when (or (looking-at outline-regexp)
19103 (re-search-forward (concat "^" outline-regexp) end t))
19104 (setq level (org-outline-level)))
19105 (goto-char end)
19107 (if (or (eobp)
19108 (and (bolp) (looking-at org-outline-regexp)
19109 (<= (org-outline-level) level)))
19110 nil ; Nothing would be swallowed
19111 t)))) ; something would swallow
19113 (define-key org-mode-map "\C-y" 'org-yank)
19115 (defun org-invisible-p ()
19116 "Check if point is at a character currently not visible."
19117 ;; Early versions of noutline don't have `outline-invisible-p'.
19118 (if (fboundp 'outline-invisible-p)
19119 (outline-invisible-p)
19120 (get-char-property (point) 'invisible)))
19122 (defun org-truely-invisible-p ()
19123 "Check if point is at a character currently not visible.
19124 This version does not only check the character property, but also
19125 `visible-mode'."
19126 ;; Early versions of noutline don't have `outline-invisible-p'.
19127 (if (org-bound-and-true-p visible-mode)
19128 nil
19129 (if (fboundp 'outline-invisible-p)
19130 (outline-invisible-p)
19131 (get-char-property (point) 'invisible))))
19133 (defun org-invisible-p2 ()
19134 "Check if point is at a character currently not visible."
19135 (save-excursion
19136 (if (and (eolp) (not (bobp))) (backward-char 1))
19137 ;; Early versions of noutline don't have `outline-invisible-p'.
19138 (if (fboundp 'outline-invisible-p)
19139 (outline-invisible-p)
19140 (get-char-property (point) 'invisible))))
19142 (defun org-back-to-heading (&optional invisible-ok)
19143 "Call `outline-back-to-heading', but provide a better error message."
19144 (condition-case nil
19145 (outline-back-to-heading invisible-ok)
19146 (error (error "Before first headline at position %d in buffer %s"
19147 (point) (current-buffer)))))
19149 (defun org-beginning-of-defun ()
19150 "Go to the beginning of the subtree, i.e. back to the heading."
19151 (org-back-to-heading))
19152 (defun org-end-of-defun ()
19153 "Go to the end of the subtree."
19154 (org-end-of-subtree nil t))
19156 (defun org-before-first-heading-p ()
19157 "Before first heading?"
19158 (save-excursion
19161 (defun org-on-heading-p (&optional ignored)
19162 (outline-on-heading-p t))
19163 (defun org-at-heading-p (&optional ignored)
19164 (outline-on-heading-p t))
19166 (defun org-point-at-end-of-empty-headline ()
19167 "If point is at the end of an empty headline, return t, else nil.
19168 If the heading only contains a TODO keyword, it is still still considered
19169 empty."
19171 (save-excursion
19172 (beginning-of-line 1)
19175 (defun org-at-heading-or-item-p ()
19176 (or (org-on-heading-p) (org-at-item-p)))
19178 (defun org-on-target-p ()
19179 (or (org-in-regexp org-radio-target-regexp)
19180 (org-in-regexp org-target-regexp)))
19182 (defun org-up-heading-all (arg)
19183 "Move to the heading line of which the present line is a subheading.
19184 This function considers both visible and invisible heading lines.
19185 With argument, move up ARG levels."
19186 (if (fboundp 'outline-up-heading-all)
19187 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19188 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19190 (defun org-up-heading-safe ()
19191 "Move to the heading line of which the present line is a subheading.
19192 This version will not throw an error. It will return the level of the
19193 headline found, or nil if no higher level is found.
19195 Also, this function will be a lot faster than `outline-up-heading',
19196 because it relies on stars being the outline starters. This can really
19197 make a significant difference in outlines with very many siblings."
19198 (let (start-level re)
19199 (org-back-to-heading t)
19200 (setq start-level (funcall outline-level))
19201 (if (equal start-level 1)
19202 nil
19204 (if (re-search-backward re nil t)
19205 (funcall outline-level)))))
19207 (defun org-first-sibling-p ()
19208 "Is this heading the first child of its parents?"
19209 (interactive)
19210 (let ((re (concat "^" outline-regexp))
19211 level l)
19212 (unless (org-at-heading-p t)
19213 (error "Not at a heading"))
19214 (setq level (funcall outline-level))
19215 (save-excursion
19216 (if (not (re-search-backward re nil t))
19217 t
19218 (setq l (funcall outline-level))
19219 (< l level)))))
19221 (defun org-goto-sibling (&optional previous)
19222 "Goto the next sibling, even if it is invisible.
19223 When PREVIOUS is set, go to the previous sibling instead. Returns t
19224 when a sibling was found. When none is found, return nil and don't
19225 move point."
19226 (let ((fun (if previous 're-search-backward 're-search-forward))
19227 (pos (point))
19228 (re (concat "^" outline-regexp))
19229 level l)
19230 (when (condition-case nil (org-back-to-heading t) (error nil))
19231 (setq level (funcall outline-level))
19232 (catch 'exit
19233 (or previous (forward-char 1))
19234 (while (funcall fun re nil t)
19235 (setq l (funcall outline-level))
19236 (when (< l level) (goto-char pos) (throw 'exit nil))
19237 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
19238 (goto-char pos)
19239 nil))))
19241 (defun org-show-siblings ()
19242 "Show all siblings of the current headline."
19243 (save-excursion
19244 (while (org-goto-sibling) (org-flag-heading nil)))
19245 (save-excursion
19246 (while (org-goto-sibling 'previous)
19247 (org-flag-heading nil))))
19249 (defun org-goto-first-child ()
19250 "Goto the first child, even if it is invisible.
19251 Return t when a child was found. Otherwise don't move point and
19252 return nil."
19253 (let (level (pos (point)) (re (concat "^" outline-regexp)))
19254 (when (condition-case nil (org-back-to-heading t) (error nil))
19255 (setq level (outline-level))
19256 (forward-char 1)
19257 (if (and (re-search-forward re nil t) (> (outline-level) level))
19258 (progn (goto-char (match-beginning 0)) t)
19259 (goto-char pos) nil))))
19261 (defun org-show-hidden-entry ()
19262 "Show an entry where even the heading is hidden."
19263 (save-excursion
19264 (org-show-entry)))
19266 (defun org-flag-heading (flag &optional entry)
19267 "Flag the current heading. FLAG non-nil means make invisible.
19268 When ENTRY is non-nil, show the entire entry."
19269 (save-excursion
19270 (org-back-to-heading t)
19271 ;; Check if we should show the entire entry
19272 (if entry
19273 (progn
19274 (org-show-entry)
19275 (save-excursion
19276 (and (outline-next-heading)
19277 (org-flag-heading nil))))
19278 (outline-flag-region (max (point-min) (1- (point)))
19279 (save-excursion (outline-end-of-heading) (point))
19280 flag))))
19282 (defun org-get-next-sibling ()
19283 "Move to next heading of the same level, and return point.
19284 If there is no such heading, return nil.
19285 This is like outline-next-sibling, but invisible headings are ok."
19286 (let ((level (funcall outline-level)))
19287 (outline-next-heading)
19288 (while (and (not (eobp)) (> (funcall outline-level) level))
19289 (outline-next-heading))
19290 (if (or (eobp) (< (funcall outline-level) level))
19291 nil
19292 (point))))
19294 (defun org-get-last-sibling ()
19295 "Move to previous heading of the same level, and return point.
19296 If there is no such heading, return nil."
19297 (let ((opoint (point))
19298 (level (funcall outline-level)))
19299 (outline-previous-heading)
19300 (when (and (/= (point) opoint) (outline-on-heading-p t))
19301 (while (and (> (funcall outline-level) level)
19302 (not (bobp)))
19303 (outline-previous-heading))
19304 (if (< (funcall outline-level) level)
19305 nil
19306 (point)))))
19308 (defun org-end-of-subtree (&optional invisible-OK to-heading)
19309 ;; This contains an exact copy of the original function, but it uses
19310 ;; `org-back-to-heading', to make it work also in invisible
19311 ;; trees. And is uses an invisible-OK argument.
19312 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
19313 ;; Furthermore, when used inside Org, finding the end of a large subtree
19314 ;; with many children and grandchildren etc, this can be much faster
19315 ;; than the outline version.
19316 (org-back-to-heading invisible-OK)
19317 (let ((first t)
19318 (level (funcall outline-level)))
19319 (if (and (org-mode-p) (< level 1000))
19320 ;; A true heading (not a plain list item), in Org-mode
19321 ;; This means we can easily find the end by looking
19322 ;; only for the right number of stars. Using a regexp to do
19323 ;; this is so much faster than using a Lisp loop.
19325 (forward-char 1)
19326 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
19327 ;; something else, do it the slow way
19328 (while (and (not (eobp))
19329 (or first (> (funcall outline-level) level)))
19330 (setq first nil)
19331 (outline-next-heading)))
19332 (unless to-heading
19334 (progn
19335 ;; Go to end of line before heading
19336 (forward-char -1)
19338 ;; leave blank line before heading
19339 (forward-char -1))))))
19340 (point))
19342 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
19343 "Use Org version in org-mode, for dramatic speed-up."
19344 (if (eq major-mode 'org-mode)
19345 (progn
19346 (org-end-of-subtree nil t)
19347 (unless (eobp) (backward-char 1)))
19348 ad-do-it))
19350 (defun org-forward-same-level (arg &optional invisible-ok)
19351 "Move forward to the arg'th subheading at same level as this one.
19352 Stop at the first and last subheadings of a superior heading.
19353 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
19354 it wil also look at invisible ones."
19355 (interactive "p")
19356 (org-back-to-heading invisible-ok)
19357 (org-on-heading-p)
19358 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19360 l)
19361 (forward-char 1)
19362 (while (> arg 0)
19363 (while (and (re-search-forward re nil 'move)
19364 (setq l (- (match-end 0) (match-beginning 0) 1))
19365 (= l level)
19366 (not invisible-ok)
19367 (progn (backward-char 1) (org-invisible-p)))
19368 (if (< l level) (setq arg 1)))
19369 (setq arg (1- arg)))
19370 (beginning-of-line 1)))
19372 (defun org-backward-same-level (arg &optional invisible-ok)
19373 "Move backward to the arg'th subheading at same level as this one.
19374 Stop at the first and last subheadings of a superior heading."
19375 (interactive "p")
19376 (org-back-to-heading)
19377 (org-on-heading-p)
19378 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19380 l)
19381 (while (> arg 0)
19382 (while (and (re-search-backward re nil 'move)
19383 (setq l (- (match-end 0) (match-beginning 0) 1))
19384 (= l level)
19385 (not invisible-ok)
19386 (org-invisible-p))
19387 (if (< l level) (setq arg 1)))
19388 (setq arg (1- arg)))))
19390 (defun org-show-subtree ()
19391 "Show everything after this heading at deeper levels."
19392 (outline-flag-region
19393 (point)
19394 (save-excursion
19395 (org-end-of-subtree t t))
19396 nil))
19398 (defun org-show-entry ()
19399 "Show the body directly following this heading.
19400 Show the heading too, if it is currently invisible."
19401 (interactive)
19402 (save-excursion
19403 (condition-case nil
19404 (progn
19405 (org-back-to-heading t)
19406 (outline-flag-region
19407 (max (point-min) (1- (point)))
19408 (save-excursion
19409 (if (re-search-forward
19411 (match-beginning 1)
19412 (point-max)))
19413 nil)
19414 (org-cycle-hide-drawers 'children))
19415 (error nil))))
19417 (defun org-make-options-regexp (kwds &optional extra)
19418 "Make a regular expression for keyword lines."
19419 (concat
19420 "^"
19427 ;; Make isearch reveal the necessary context
19428 (defun org-isearch-end ()
19429 "Reveal context after isearch exits."
19430 (when isearch-success ; only if search was successful
19431 (if (featurep 'xemacs)
19432 ;; Under XEmacs, the hook is run in the correct place,
19433 ;; we directly show the context.
19434 (org-show-context 'isearch)
19435 ;; In Emacs the hook runs *before* restoring the overlays.
19436 ;; So we have to use a one-time post-command-hook to do this.
19437 ;; (Emacs 22 has a special variable, see function `org-mode')
19438 (unless (and (boundp 'isearch-mode-end-hook-quit)
19439 isearch-mode-end-hook-quit)
19440 ;; Only when the isearch was not quitted.
19441 (org-add-hook 'post-command-hook 'org-isearch-post-command
19442 'append 'local)))))
19444 (defun org-isearch-post-command ()
19445 "Remove self from hook, and show context."
19446 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
19447 (org-show-context 'isearch))
19450 ;;;; Integration with and fixes for other packages
19452 ;;; Imenu support
19454 (defvar org-imenu-markers nil
19455 "All markers currently used by Imenu.")
19456 (make-variable-buffer-local 'org-imenu-markers)
19458 (defun org-imenu-new-marker (&optional pos)
19459 "Return a new marker for use by Imenu, and remember the marker."
19460 (let ((m (make-marker)))
19461 (move-marker m (or pos (point)))
19462 (push m org-imenu-markers)
19463 m))
19465 (defun org-imenu-get-tree ()
19466 "Produce the index for Imenu."
19467 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
19468 (setq org-imenu-markers nil)
19469 (let* ((n org-imenu-depth)
19470 (re (concat "^" outline-regexp))
19471 (subs (make-vector (1+ n) nil))
19472 (last-level 0)
19473 m level head)
19474 (save-excursion
19475 (save-restriction
19476 (widen)
19477 (goto-char (point-max))
19478 (while (re-search-backward re nil t)
19479 (setq level (org-reduced-level (funcall outline-level)))
19480 (when (<= level n)
19481 (looking-at org-complex-heading-regexp)
19482 (setq head (org-link-display-format
19483 (org-match-string-no-properties 4))
19484 m (org-imenu-new-marker))
19485 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
19486 (if (>= level last-level)
19487 (push (cons head m) (aref subs level))
19488 (push (cons head (aref subs (1+ level))) (aref subs level))
19489 (loop for i from (1+ level) to n do (aset subs i nil)))
19490 (setq last-level level)))))
19491 (aref subs 1)))
19493 (eval-after-load "imenu"
19494 '(progn
19495 (add-hook 'imenu-after-jump-hook
19496 (lambda ()
19497 (if (eq major-mode 'org-mode)
19498 (org-show-context 'org-goto))))))
19500 (defun org-link-display-format (link)
19501 "Replace a link with either the description, or the link target
19502 if no description is present"
19503 (save-match-data
19504 (if (string-match org-bracket-link-analytic-regexp link)
19505 (replace-match (if (match-end 5)
19506 (match-string 5 link)
19507 (concat (match-string 1 link)
19508 (match-string 3 link)))
19509 nil t link)
19510 link)))
19512 ;; Speedbar support
19514 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
19515 "Overlay marking the agenda restriction line in speedbar.")
19516 (overlay-put org-speedbar-restriction-lock-overlay
19517 'face 'org-agenda-restriction-lock)
19518 (overlay-put org-speedbar-restriction-lock-overlay
19519 'help-echo "Agendas are currently limited to this item.")
19520 (org-detach-overlay org-speedbar-restriction-lock-overlay)
19522 (defun org-speedbar-set-agenda-restriction ()
19523 "Restrict future agenda commands to the location at point in speedbar.
19525 (interactive)
19526 (require 'org-agenda)
19527 (let (p m tp np dir txt)
19528 (cond
19529 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19530 'org-imenu t))
19531 (setq m (get-text-property p 'org-imenu-marker))
19532 (with-current-buffer (marker-buffer m)
19533 (goto-char m)
19534 (org-agenda-set-restriction-lock 'subtree)))
19535 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19536 'speedbar-function 'speedbar-find-file))
19537 (setq tp (previous-single-property-change
19538 (1+ p) 'speedbar-function)
19539 np (next-single-property-change
19540 tp 'speedbar-function)
19541 dir (speedbar-line-directory)
19542 txt (buffer-substring-no-properties (or tp (point-min))
19543 (or np (point-max))))
19544 (with-current-buffer (find-file-noselect
19545 (let ((default-directory dir))
19546 (expand-file-name txt)))
19547 (unless (org-mode-p)
19548 (error "Cannot restrict to non-Org-mode file"))
19549 (org-agenda-set-restriction-lock 'file)))
19550 (t (error "Don't know how to restrict Org-mode's agenda")))
19551 (move-overlay org-speedbar-restriction-lock-overlay
19552 (point-at-bol) (point-at-eol))
19553 (setq current-prefix-arg nil)
19554 (org-agenda-maybe-redo)))
19556 (eval-after-load "speedbar"
19557 '(progn
19558 (speedbar-add-supported-extension ".org")
19559 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
19560 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
19561 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
19562 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19563 (add-hook 'speedbar-visiting-tag-hook
19564 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
19566 ;;; Fixes and Hacks for problems with other packages
19568 ;; Make flyspell not check words in links, to not mess up our keymap
19569 (defun org-mode-flyspell-verify ()
19570 "Don't let flyspell put overlays at active buttons."
19571 (and (not (get-text-property (max (1- (point)) (point-min)) 'keymap))
19572 (not (get-text-property (max (1- (point)) (point-min)) 'org-no-flyspell))))
19574 (defun org-remove-flyspell-overlays-in (beg end)
19575 "Remove flyspell overlays in region."
19576 (and (org-bound-and-true-p flyspell-mode)
19577 (fboundp 'flyspell-delete-region-overlays)
19578 (flyspell-delete-region-overlays beg end))
19579 (add-text-properties beg end '(org-no-flyspell t)))
19581 ;; Make `bookmark-jump' shows the jump location if it was hidden.
19582 (eval-after-load "bookmark"
19583 '(if (boundp 'bookmark-after-jump-hook)
19584 ;; We can use the hook
19585 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
19586 ;; Hook not available, use advice
19587 (defadvice bookmark-jump (after org-make-visible activate)
19588 "Make the position visible."
19589 (org-bookmark-jump-unhide))))
19591 ;; Make sure saveplace shows the location if it was hidden
19592 (eval-after-load "saveplace"
19593 '(defadvice save-place-find-file-hook (after org-make-visible activate)
19594 "Make the position visible."
19595 (org-bookmark-jump-unhide)))
19597 ;; Make sure ecb shows the location if it was hidden
19598 (eval-after-load "ecb"
19599 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
19600 "Make hierarchy visible when jumping into location from ECB tree buffer."
19601 (if (eq major-mode 'org-mode)
19602 (org-show-context))))
19604 (defun org-bookmark-jump-unhide ()
19605 "Unhide the current position, to show the bookmark location."
19606 (and (org-mode-p)
19607 (or (org-invisible-p)
19608 (save-excursion (goto-char (max (point-min) (1- (point))))
19609 (org-invisible-p)))
19610 (org-show-context 'bookmark-jump)))
19612 ;; Make session.el ignore our circular variable
19613 (eval-after-load "session"
19614 '(add-to-list 'session-globals-exclude 'org-mark-ring))
19616 ;;;; Experimental code
19618 (defun org-closed-in-range ()
19619 "Sparse tree of items closed in a certain time range.
19620 Still experimental, may disappear in the future."
19621 (interactive)
19622 ;; Get the time interval from the user.
19623 (let* ((time1 (org-float-time
19624 (org-read-date nil 'to-time nil "Starting date: ")))
19625 (time2 (org-float-time
19626 (org-read-date nil 'to-time nil "End date:")))
19627 ;; callback function
19628 (callback (lambda ()
19629 (let ((time
19630 (org-float-time
19631 (apply 'encode-time
19632 (org-parse-time-string
19633 (match-string 1))))))
19634 ;; check if time in interval
19635 (and (>= time time1) (<= time time2))))))
19636 ;; make tree, check each match with the callback
19639 ;;;; Finish up
19641 (provide 'org)
19643 (run-hooks 'org-load-hook)
19645 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
19647 ;;; org.el ends here