| blob | 3349dbea606d079ecbcb4a9521e4e230b9272fae |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.4
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
28 ;;
29 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
30 ;; project planning with a fast and effective plain-text system.
31 ;;
32 ;; Org-mode develops organizational tasks around NOTES files that contain
33 ;; information about projects as plain text. Org-mode is implemented on
34 ;; top of outline-mode, which makes it possible to keep the content of
35 ;; large files well structured. Visibility cycling and structure editing
36 ;; help to work with the tree. Tables are easily created with a built-in
37 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
38 ;; and scheduling. It dynamically compiles entries into an agenda that
39 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
40 ;; Plain text URL-like links connect to websites, emails, Usenet
41 ;; messages, BBDB entries, and any files related to the projects. For
42 ;; printing and sharing of notes, an Org-mode file can be exported as a
43 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
44 ;; iCalendar file. It can also serve as a publishing tool for a set of
45 ;; linked webpages.
46 ;;
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
50 ;;
51 ;; http://orgmode.org/org.html#Installation
52 ;;
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org-mode can be found in the TeXInfo file. The
56 ;; distribution also contains a PDF version of it. At the homepage of
57 ;; Org-mode, you can read the same text online as HTML. There is also an
58 ;; excellent reference card made by Philip Rooke. This card can be found
59 ;; in the etc/ directory of Emacs 22.
60 ;;
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
63 ;;
64 ;;; Code:
71 ;;;; Require other packages
79 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
91 ;; Other stuff we need.
106 ;; babel
115 ;; load languages based on value of `org-babel-load-languages'
117 ;;;###autoload
119 "Load the languages defined in `org-babel-load-languages'."
131 org-babel-load-languages))
134 "Languages which can be evaluated in Org-mode buffers.
135 This list can be used to load support for any of the languages
136 below, note that each language will depend on a different set of
137 system executables and/or Emacs modes. When a language is
139 with `org-babel-execute-src-block' bound by default to C-c
140 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
141 be set to remove code block evaluation from the C-c C-c
142 keybinding. By default only Emacs Lisp (which has no
143 requirements) is loaded."
147 :key-type
180 ;;;; Customization variables
182 "Remove ID property of clones of a subtree.
183 When non-nil, clones of a subtree don't inherit the ID property.
184 Otherwise they inherit the ID property with a new unique
185 identifier."
189 ;;; Version
195 "Show the org-mode version in the echo area.
196 With prefix arg HERE, insert it at point."
222 ;;; Compatibility constants
224 ;;; The custom variables
227 "Outline-based notes management and organizer."
233 "Mode hook for Org-mode, run after the mode was turned on."
238 "Hook that is run after org.el has been loaded."
247 "Load all extensions listed in `org-modules'."
252 org-modules)
256 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
265 (defcustom org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
266 "Modules that should always be loaded together with org.el.
267 If a description starts with <C>, the file is not part of Emacs
268 and loading it will require that you have downloaded and properly installed
269 the org-mode distribution.
271 You can also use this system to load external packages (i.e. neither Org
272 core modules, nor modules from the CONTRIB directory). Just add symbols
273 to the end of the list. If the package is called org-xyz.el, then you need
274 to add the symbol `xyz', and the package must have a call to
276 (provide 'org-xyz)"
279 :type
310 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
317 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
325 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
341 "Non-nil means make shift-cursor commands select text when possible.
343 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
344 selecting a region, or enlarge regions started in this way.
345 In Org-mode, in special contexts, these same keys are used for other
346 purposes, important enough to compete with shift selection. Org tries
347 to balance these needs by supporting `shift-select-mode' outside these
348 special contexts, under control of this variable.
350 The default of this variable is nil, to avoid confusing behavior. Shifted
351 cursor keys will then execute Org commands in the following contexts:
352 - on a headline, changing TODO state (left/right) and priority (up/down)
353 - on a time stamp, changing the time
354 - in a plain list item, changing the bullet type
355 - in a property definition line, switching between allowed values
356 - in the BEGIN line of a clock table (changing the time block).
357 Outside these contexts, the commands will throw an error.
359 When this variable is t and the cursor is not in a special context,
360 Org-mode will support shift-selection for making and enlarging regions.
361 To make this more effective, the bullet cycling will no longer happen
362 anywhere in an item line, but only if the cursor is exactly on the bullet.
364 If you set this variable to the symbol `always', then the keys
365 will not be special in headlines, property lines, and item lines, to make
366 shift selection work there as well. If this is what you want, you can
367 use the following alternative commands: `C-c C-t' and `C-c ,' to
368 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
369 TODO sets, `C-c -' to cycle item bullet types, and properties can be
370 edited by hand or in column view.
372 However, when the cursor is on a timestamp, shift-cursor commands
373 will still edit the time stamp - this is just too good to give up.
375 XEmacs user should have this variable set to nil, because shift-select-mode
376 is Emacs 23 only."
384 "Options concerning startup of Org-mode."
389 "Non-nil means entering Org-mode will switch to OVERVIEW.
390 This can also be configured on a per-file basis by adding one of
391 the following lines anywhere in the buffer:
393 #+STARTUP: fold (or `overview', this is equivalent)
394 #+STARTUP: nofold (or `showall', this is equivalent)
395 #+STARTUP: content
396 #+STARTUP: showeverything"
405 "Non-nil means entering Org-mode will set `truncate-lines'.
406 This is useful since some lines containing links can be very long and
407 uninteresting. Also tables look terrible when wrapped."
412 "Non-nil means turn on `org-indent-mode' on startup.
413 This can also be configured on a per-file basis by adding one of
414 the following lines anywhere in the buffer:
416 #+STARTUP: indent
417 #+STARTUP: noindent"
425 When this option is turned on, you can use TeX-like syntax for sub- and
427 considered as a single item - so grouping with {} is normally not
428 needed. For example, the following things will be parsed as single
429 sub- or superscripts.
431 10^24 or 10^tau several digits will be considered 1 item.
432 10^-12 or 10^-tau a leading sign with digits or a word
433 x^2-y^3 will be read as x^2 - y^3, because items are
434 terminated by almost any nonword/nondigit char.
435 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
437 Still, ambiguity is possible - so when in doubt use {} to enclose the
438 sub/superscript. If you set this variable to the symbol `{}',
439 the braces are *required* in order to trigger interpretations as
441 frequently in plain text.
443 Not all export backends support this, but HTML does.
458 "Non-nil means turn on `org-beamer-mode' on startup.
459 This can also be configured on a per-file basis by adding one of
460 the following lines anywhere in the buffer:
462 #+STARTUP: beamer"
467 "Non-nil means align all tables when visiting a file.
468 This is useful when the column width in tables is forced with <N> cookies
469 in table fields. Such tables will look correct only after the first re-align.
470 This can also be configured on a per-file basis by adding one of
471 the following lines anywhere in the buffer:
472 #+STARTUP: align
473 #+STARTUP: noalign"
478 "Non-nil means show inline images when loading a new Org file.
479 This can also be configured on a per-file basis by adding one of
480 the following lines anywhere in the buffer:
481 #+STARTUP: inlineimages
482 #+STARTUP: noinlineimages"
487 "Non-nil means insert the first line setting Org-mode in empty files.
488 When the function `org-mode' is called interactively in an empty file, this
489 normally means that the file name does not automatically trigger Org-mode.
490 To ensure that the file will always be in Org-mode in the future, a
491 line enforcing Org-mode will be inserted into the buffer, if this option
492 has been set."
497 "Non-nil means use alternative key bindings for some keys.
498 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
499 These keys are also used by other packages like shift-selection-mode'
500 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
501 If you want to use Org-mode together with one of these other modes,
502 or more generally if you would like to move some Org-mode commands to
503 other keys, set this variable and configure the keys with the variable
504 `org-disputed-keys'.
506 This option is only relevant at load-time of Org-mode, and must be set
507 *before* org.el is loaded. Changing it requires a restart of Emacs to
508 become effective."
513 "Non-nil means use extra key sequence definitions for certain commands.
514 This happens automatically if you run XEmacs or if `window-system'
515 is nil. This variable lets you do the same manually. You must
516 set it before loading org.
518 Example: on Carbon Emacs 22 running graphically, with an external
519 keyboard on a Powerbook, the default way of setting M-left might
520 not work for either Alt or ESC. Setting this variable will make
521 it work for ESC."
535 "Keys for which Org-mode and other modes compete.
536 This is an alist, cars are the default keys, second element specifies
537 the alternative to use when `org-replace-disputed-keys' is t.
539 Keys can be specified in any syntax supported by `define-key'.
540 The value of this option takes effect only at Org-mode's startup,
541 therefore you'll have to restart Emacs to apply it after changing."
546 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
547 Or return the original if not disputed.
548 Also apply the translations defined in `org-xemacs-key-equivalents'."
553 org-disputed-keys)))
557 key)
567 "Define a key, possibly translated, as returned by `org-key'."
571 "The ellipsis to use in the Org-mode outline.
572 When nil, just use the standard three dots. When a string, use that instead,
573 When a face, use the standard 3 dots, but with the specified face.
574 The change affects only Org-mode (which will then use its own display table).
575 Changing this requires executing `M-x org-mode' in a buffer to become
576 effective."
586 "Keywords in Org-mode."
591 "String to mark deadline entries.
592 A deadline is this string, followed by a time stamp. Should be a word,
593 terminated by a colon. You can insert a schedule keyword and
595 Changes become only effective after restarting Emacs."
600 "String to mark scheduled TODO entries.
601 A schedule is this string, followed by a time stamp. Should be a word,
602 terminated by a colon. You can insert a schedule keyword and
604 Changes become only effective after restarting Emacs."
609 "String used as the prefix for timestamps logging closing a TODO entry."
614 "String used as prefix for timestamps clocking work hours on an item."
619 "Entries starting with this keyword will never be exported.
620 An entry can be toggled between COMMENT and normal with
622 Changes become only effective after restarting Emacs."
627 "Entries starting with this keyword will be exported in fixed-width font.
628 Quoting applies only to the text in the entry following the headline, and does
629 not extend beyond the next headline, even if that is lower level.
630 An entry can be toggled between QUOTE and normal with
637 "Regular expression for specifying repeated events.
641 "Options concerning the general structure of Org-mode files."
646 "Options about how to make context of a location visible."
670 "Non-nil means show full hierarchy when revealing a location.
671 Org-mode often shows locations in an org-mode file which might have
672 been invisible before. When this is set, the hierarchy of headings
673 above the exposed location is shown.
674 Turning this off for example for sparse trees makes them very compact.
675 Instead of t, this can also be an alist specifying this option for different
676 contexts. Valid contexts are
677 agenda when exposing an entry from the agenda
678 org-goto when using the command `org-goto' on key C-c C-j
679 occur-tree when using the command `org-occur' on key C-c /
680 tags-tree when constructing a sparse tree based on tags matches
681 link-search when exposing search matches associated with a link
682 mark-goto when exposing the jump goal of a mark
683 bookmark-jump when exposing a bookmark location
684 isearch when exiting from an incremental search
685 default default for all contexts not set explicitly"
690 "Non-nil means show following heading when revealing a location.
691 Org-mode often shows locations in an org-mode file which might have
692 been invisible before. When this is set, the heading following the
693 match is shown.
694 Turning this off for example for sparse trees makes them very compact,
695 but makes it harder to edit the location of the match. In such a case,
697 Instead of t, this can also be an alist specifying this option for different
698 contexts. See `org-show-hierarchy-above' for valid contexts."
703 "Non-nil means show all sibling heading when revealing a location.
704 Org-mode often shows locations in an org-mode file which might have
705 been invisible before. When this is set, the sibling of the current entry
706 heading are all made visible. If `org-show-hierarchy-above' is t,
707 the same happens on each level of the hierarchy above the current entry.
709 By default this is on for the isearch context, off for all other contexts.
710 Turning this off for example for sparse trees makes them very compact,
711 but makes it harder to edit the location of the match. In such a case,
713 Instead of t, this can also be an alist specifying this option for different
714 contexts. See `org-show-hierarchy-above' for valid contexts."
719 "Non-nil means show the entry below a headline when revealing a location.
720 Org-mode often shows locations in an org-mode file which might have
721 been invisible before. When this is set, the text below the headline that is
722 exposed is also shown.
724 By default this is off for all contexts.
725 Instead of t, this can also be an alist specifying this option for different
726 contexts. See `org-show-hierarchy-above' for valid contexts."
731 "How should indirect tree buffers be displayed?
732 This applies to indirect buffers created with the commands
734 Valid values are:
735 current-window Display in the current window
736 other-window Just display in another window.
737 dedicated-frame Create one new frame, and re-use it each time.
738 new-frame Make a new frame each time. Note that in this case
739 previously-made indirect buffers are kept, and you need to
740 kill these buffers yourself."
750 "Non-nil means activate single letter commands at beginning of a headline.
751 This may also be a function to test for appropriate locations where speed
752 commands should be active."
760 "Alist of additional speed commands.
761 This list will be checked before `org-speed-commands-default'
762 when the variable `org-use-speed-commands' is non-nil
763 and when the cursor is at the beginning of a headline.
764 The car if each entry is a string with a single letter, which must
765 be assigned to `self-insert-command' in the global map.
766 The cdr is either a command to be called interactively, a function
767 to be called, or a form to be evaluated.
768 An entry that is just a list with a single string will be interpreted
769 as a descriptive headline that will be added when listing the speed
770 commands in the Help buffer using the `?' speed command."
782 "Options concerning visibility cycling in Org-mode."
787 "Non-nil means skip CHILDREN state in entries that don't have any."
792 "Maximum level which should still be subject to visibility cycling.
793 Levels higher than this will, for cycling, be treated as text, not a headline.
794 When `org-odd-levels-only' is set, a value of N in this variable actually
795 means 2N-1 stars as the limiting headline.
796 When nil, cycle all levels.
797 Note that the limiting level of cycling is also influenced by
798 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
799 `org-inlinetask-min-level' is, cycling will be limited to levels one less
800 than its value."
807 "Names of drawers. Drawers are not opened by cycling on the headline above.
808 Drawers only open with a TAB on the drawer line itself. A drawer looks like
809 this:
810 :DRAWERNAME:
811 .....
812 :END:
814 the property API.
816 Drawers can be defined on the per-file basis with a line like:
818 #+DRAWERS: HIDDEN STATE PROPERTIES"
824 "Non-nil means entering Org-mode will fold all blocks.
825 This can also be set in on a per-file basis with
827 #+STARTUP: hideblocks
828 #+STARTUP: showblocks"
834 "Cycle globally if cursor is at beginning of buffer and not at a headline.
835 This makes it possible to do global cycling without having to use S-TAB or
837 of the buffer
838 must not be a headline - it may be empty or some other text. When used in
839 this way, `org-cycle-hook' is disables temporarily, to make sure the
840 cursor stays at the beginning of the buffer.
841 When this option is nil, don't do anything special at the beginning
842 of the buffer."
847 "Non-nil means cycle entry level or item indentation in new empty entries.
849 When the cursor is at the end of an empty headline, i.e with only stars
850 and maybe a TODO keyword, TAB will then switch the entry to become a child,
851 and then all possible ancestor states, before returning to the original state.
852 This makes data entry extremely fast: M-RET to create a new headline,
853 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
855 When the cursor is at the end of an empty plain list item, one TAB will
856 make it a subitem, two or more tabs will back up to make this an item
857 higher up in the item hierarchy."
862 "Where should `org-cycle' emulate TAB.
863 nil Never
864 white Only in completely white lines
865 whitestart Only at the beginning of lines, before the first non-white char
866 t Everywhere except in headlines
867 exc-hl-bol Everywhere except at the start of a headline
868 If TAB is used in a place where it does not emulate TAB, the current subtree
869 visibility is cycled."
876 ))
879 "Number of empty lines needed to keep an empty line between collapsed trees.
880 If you leave an empty line between the end of a subtree and the following
881 headline, this empty line is hidden when the subtree is folded.
882 Org-mode will leave (exactly) one empty line visible if the number of
883 empty lines is equal or larger to the number given in this variable.
884 So the default 2 means at least 2 empty lines after the end of a subtree
885 are needed to produce free space between a collapsed subtree and the
886 following headline.
888 If the number is negative, and the number of empty lines is at least -N,
889 all empty lines are shown.
891 Special case: when 0, never leave empty lines in collapsed view."
897 "Hook that is run before visibility cycling is happening.
898 The function(s) in this hook must accept a single argument which indicates
899 the new state that will be set right after running this hook. The
900 argument is a symbol. Before a global state change, it can have the values
901 `overview', `content', or `all'. Before a local state change, it can have
902 the values `folded', `children', or `subtree'."
907 org-cycle-hide-drawers
908 org-cycle-show-empty-lines
909 org-optimize-window-after-visibility-change)
910 "Hook that is run after `org-cycle' has changed the buffer visibility.
911 The function(s) in this hook must accept a single argument which indicates
912 the new state that was set by the most recent `org-cycle' command. The
913 argument is a symbol. After a global state change, it can have the values
914 `overview', `content', or `all'. After a local state change, it can have
915 the values `folded', `children', or `subtree'."
920 "Options concerning structure editing in Org-mode."
925 "Non-nil means skip even levels and only use odd levels for the outline.
926 This has the effect that two stars are being added/taken away in
927 promotion/demotion commands. It also influences how levels are
928 handled by the exporters.
929 Changing it requires restart of `font-lock-mode' to become effective
930 for fontification also in regions already fontified.
931 You may also set this on a per-file basis by adding one of the following
932 lines to the buffer:
934 #+STARTUP: odd
935 #+STARTUP: oddeven"
941 "Non-nil means adapt indentation to outline node level.
943 When this variable is set, Org assumes that you write outlines by
944 indenting text in each node to align with the headline (after the stars).
945 The following issues are influenced by this variable:
947 - When this is set and the *entire* text in an entry is indented, the
948 indentation is increased by one space in a demotion command, and
949 decreased by one in a promotion command. If any line in the entry
950 body starts with text at column 0, indentation is not changed at all.
952 - Property drawers and planning information is inserted indented when
953 this variable s set. When nil, they will not be indented.
955 - TAB indents a line relative to context. The lines below a headline
956 will be indented when this variable is set.
958 Note that this is all about true indentation, by adding and removing
959 space characters. See also `org-indent.el' which does level-dependent
960 indentation in a virtual way, i.e. at display time in Emacs."
965 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
967 When t, `C-a' will bring back the cursor to the beginning of the
968 headline text, i.e. after the stars and after a possible TODO keyword.
969 In an item, this will be the position after the bullet.
970 When the cursor is already at that position, another `C-a' will bring
971 it to the beginning of the line.
973 `C-e' will jump to the end of the headline, ignoring the presence of tags
974 in the headline. A second `C-e' will then jump to the true end of the
975 line, after any tags. This also means that, when this variable is
976 non-nil, `C-e' also will never jump beyond the end of the heading of a
977 folded section, i.e. not after the ellipses.
979 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
980 going to the true line boundary first. Only a directly following, identical
981 keypress will bring the cursor to the special positions.
983 This may also be a cons cell where the behavior for `C-a' and `C-e' is
984 set separately."
1003 "Non-nil means `C-k' will behave specially in headlines.
1004 When nil, `C-k' will call the default `kill-line' command.
1005 When t, the following will happen while the cursor is in the headline:
1007 - When the cursor is at the beginning of a headline, kill the entire
1008 line and possible the folded subtree below the line.
1009 - When in the middle of the headline text, kill the headline up to the tags.
1010 - When after the headline text, kill the tags."
1015 "Non-nil means, do not delete a hidden subtree with C-k.
1016 When set to the symbol `error', simply throw an error when C-k is
1017 used to kill (part-of) a headline that has hidden text behind it.
1018 Any other non-nil value will result in a query to the user, if it is
1019 OK to kill that hidden subtree. When nil, kill without remorse."
1027 "Non-nil means when yanking subtrees, fold them.
1028 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1029 it starts with a heading and all other headings in it are either children
1030 or siblings, then fold all the subtrees. However, do this only if no
1031 text after the yank would be swallowed into a folded tree by this action."
1036 "Non-nil means when yanking subtrees, adjust the level.
1037 With this setting, `org-paste-subtree' is used to insert the subtree, see
1038 this function for details."
1043 "Non-nil means M-RET will split the line at the cursor position.
1044 When nil, it will go to the end of the line before making a
1045 new line.
1046 You may also set this option in a different way for different
1047 contexts. Valid contexts are:
1049 headline when creating a new headline
1050 item when creating a new item
1051 table in a table field
1052 default the value to be used for all contexts not explicitly
1053 customized"
1070 "Non-nil means insert new headings after the current subtree.
1071 When nil, the new heading is created directly after the current line.
1074 for the duration of the command."
1080 "Should `org-insert-heading' leave a blank line before new heading/item?
1081 The value is an alist, with `heading' and `plain-list-item' as car,
1082 and a boolean flag as cdr. The cdr may lso be the symbol `auto', and then
1083 Org will look at the surrounding headings/items and try to make an
1084 intelligent decision wether to insert a blank line or not.
1086 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1087 set, the setting here is ignored and no empty line is inserted, to avoid
1088 breaking the list structure."
1101 "Hook being run after inserting a new heading."
1107 This currently only means they are never auto-wrapped.
1108 When nil, such lines will be treated like ordinary lines.
1109 See also the QUOTE keyword."
1114 "Non-nil means typing characters in `org-goto' starts incremental search."
1119 "Options concerning sparse trees in Org-mode."
1124 "Non-nil means highlight all matches that define a sparse tree.
1125 The highlights will automatically disappear the next time the buffer is
1126 changed by an edit command."
1131 "Non-nil means any change to the buffer will remove temporary highlights.
1132 Such highlights are created by `org-occur' and `org-clock-display'.
1133 When nil, `C-c C-c needs to be used to get rid of the highlights.
1134 The highlights created by `org-preview-latex-fragment' always need
1135 `C-c C-c' to be removed."
1142 "Hook that is run after `org-occur' has constructed a sparse tree.
1143 This can be used to recenter the window to show as much of the structure
1144 as possible."
1149 "Options concerning imenu and speedbar in Org-mode."
1154 "The maximum level for Imenu access to Org-mode headlines.
1155 This also applied for speedbar access."
1160 "Options concerning tables in Org-mode."
1166 When nil, such lines will be treated like ordinary lines.
1168 When equal to the symbol `optimized', the table editor will be optimized to
1169 do the following:
1170 - Automatic overwrite mode in front of whitespace in table fields.
1171 This makes the structure of the table stay in tact as long as the edited
1172 field does not exceed the column width.
1173 - Minimize the number of realigns. Normally, the table is aligned each time
1174 TAB or RET are pressed to move to another field. With optimization this
1175 happens only if changes to a field might have changed the column width.
1176 Optimization requires replacing the functions `self-insert-command',
1177 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1178 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1179 very good at guessing when a re-align will be necessary, but you can always
1182 If you would like to use the optimized version in Org-mode, but the
1183 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1185 This variable can be used to turn on and off the table editor during a session,
1186 but in order to toggle optimization, a restart is required.
1188 See also the variable `org-table-auto-blank-field'."
1196 "Non-nil means cluster self-insert commands for undo when possible.
1197 If this is set, then, like in the Emacs command loop, 20 consecutive
1198 characters will be undone together.
1199 This is configurable, because there is some impact on typing performance."
1204 "Non-nil means TAB will automatically notice a table.el table.
1205 When it sees such a table, it moves point into it and - if necessary -
1206 calls `table-recognize-table'."
1211 "Options concerning links in Org-mode."
1216 "Buffer-local version of `org-link-abbrev-alist', which see.
1221 "Alist of link abbreviations.
1222 The car of each element is a string, to be replaced at the start of a link.
1224 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1226 [[linkkey:tag][description]]
1228 The 'linkkey' must be a word word, starting with a letter, followed
1229 by letters, numbers, '-' or '_'.
1231 If REPLACE is a string, the tag will simply be appended to create the link.
1234 be inserted at that point (see the function `url-hexify-string').
1236 REPLACE may also be a function that will be called with the tag as the
1237 only argument to create the link, which should be returned as a string.
1239 See the manual for examples."
1249 "Non-nil means hide link part and only show description of bracket links.
1250 Bracket links are like [[link][description]]. This variable sets the initial
1251 state in new org-mode buffers. The setting can then be toggled on a
1252 per-buffer basis from the Org->Hyperlinks menu."
1257 "How the path name in file links should be stored.
1258 Valid values are:
1260 relative Relative to the current directory, i.e. the directory of the file
1261 into which the link is being inserted.
1262 absolute Absolute path, if possible with ~ for home directory.
1263 noabbrev Absolute path, no abbreviation of home directory.
1264 adaptive Use relative path for files in the current directory and sub-
1265 directories of it. For other files, use an absolute path."
1274 "Types of links that should be activated in Org-mode files.
1275 This is a list of symbols, each leading to the activation of a certain link
1276 type. In principle, it does not hurt to turn on most link types - there may
1277 be a small gain when turning off unused link types. The types are:
1279 bracket The recommended [[link][description]] or [[link]] links with hiding.
1280 angle Links in angular brackets that may contain whitespace like
1281 <bbdb:Carsten Dominik>.
1282 plain Plain links in normal text, no whitespace, like http://google.com.
1283 radio Text that is matched by a radio target, see manual for details.
1284 tag Tag settings in a headline (link to tag search).
1285 date Time stamps (link to calendar).
1286 footnote Footnote labels.
1288 Changing this variable requires a restart of Emacs to become effective."
1300 "Function to use to generate link descriptions from links.
1301 If nil the link location will be used. This function must take
1302 two parameters; the first is the link and the second the
1303 description `org-insert-link' has generated, and should return the
1304 description to use."
1309 "Options concerning storing links in Org-mode."
1314 "Format of the description part of a link to an email or usenet message.
1315 The following %-escapes will be replaced by corresponding information:
1323 %s subject
1324 %d date
1325 %m message-id.
1327 You may use normal field width specification between the % and the letter.
1328 This is for example useful to limit the length of the subject.
1342 It should match if the message is from the user him/herself."
1347 "Non-nil means storing a link to an Org file will use entry IDs.
1349 Note that before this variable is even considered, org-id must be loaded,
1350 so please customize `org-modules' and turn it on.
1352 The variable can have the following values:
1354 t Create an ID if needed to make a link to the current entry.
1356 create-if-interactive
1357 If `org-store-link' is called directly (interactively, as a user
1358 command), do create an ID to support the link. But when doing the
1359 job for remember, only use the ID if it already exists. The
1360 purpose of this setting is to avoid proliferation of unwanted
1361 IDs, just because you happen to be in an Org file when you
1362 call `org-remember' that automatically and preemptively
1363 creates a link. If you do want to get an ID link in a remember
1364 template to an entry not having an ID, create it first by
1365 explicitly creating a link to it, using `C-c C-l' first.
1367 create-if-interactive-and-no-custom-id
1368 Like create-if-interactive, but do not create an ID if there is
1369 a CUSTOM_ID property defined in the entry. This is the default.
1371 use-existing
1372 Use existing ID, do not create one.
1374 nil Never use an ID to make a link, instead link using a text search for
1375 the headline text."
1380 create-if-interactive)
1382 create-if-interactive-and-no-custom-id)
1387 "Non-nil means file links from `org-store-link' contain context.
1388 A search string will be added to the file name with :: as separator and
1389 used to find the context when the link is activated by the command
1390 `org-open-at-point'. When this option is t, the entire active region
1391 will be placed in the search string of the file link. If set to a
1392 positive integer, only the first n lines of context will be stored.
1395 negates this setting for the duration of the command."
1400 "Non-nil means keep link in list for entire session.
1402 The command `org-store-link' adds a link pointing to the current
1403 location to an internal list. These links accumulate during a session.
1404 The command `org-insert-link' can be used to insert links into any
1405 Org-mode file (offering completion for all stored links). When this
1407 will be removed from the list, to make completing the unused links
1408 more efficient."
1413 "Options concerning following links in Org-mode."
1418 "Function to translate links with different syntax to Org syntax.
1419 This can be used to translate links created for example by the Planner
1420 or emacs-wiki packages to Org syntax.
1421 The function must accept two parameters, a TYPE containing the link
1423 which is everything after the link protocol. It should return a cons
1424 with possibly modified values of type and path.
1425 Org contains a function for this, so if you set this variable to
1426 `org-translate-link-from-planner', you should be able follow many
1427 links created by planner."
1432 "Hook that is run after a link has been followed."
1437 "Non-nil means on links TAB will follow the link.
1438 Needs to be set before org.el is loaded.
1439 This really should not be used, it does not make sense, and the
1440 implementation is bad."
1445 "Non-nil means on links RET will follow the link."
1451 "Non-nil means mouse-1 on a link will follow the link.
1452 A longer mouse click will still set point. Does not work on XEmacs.
1453 Needs to be set before org.el is loaded."
1458 "Number of different positions to be recorded in the ring.
1459 Changing this requires a restart of Emacs to work correctly."
1464 "Non-nil means internal links in Org files must exactly match a headline.
1465 When nil, the link search tries to match a phrase will all words
1466 in the search text."
1472 query-to-create)))
1479 "Setup the frame configuration for following links.
1480 When following a link with Emacs, it may often be useful to display
1481 this link in another window or frame. This variable can be used to
1482 set this up for the different types of links.
1483 For VM, use any of
1484 `vm-visit-folder'
1485 `vm-visit-folder-other-window'
1486 `vm-visit-folder-other-frame'
1487 For Gnus, use any of
1488 `gnus'
1489 `gnus-other-frame'
1490 `org-gnus-no-new-news'
1491 For FILE, use any of
1492 `find-file'
1493 `find-file-other-window'
1494 `find-file-other-frame'
1495 For Wanderlust use any of
1496 `wl'
1497 `wl-other-frame'
1498 For the calendar, use the variable `calendar-setup'.
1499 For BBDB, it is currently only possible to display the matches in
1500 another window."
1524 "Non-nil means use indirect buffer to display infile links.
1525 Activating internal links (from one location in a file to another location
1526 in the same file) normally just jumps to the location. When the link is
1528 is displayed in
1529 another window. When this option is set, the other window actually displays
1530 an indirect buffer clone of the current buffer, to avoid any visibility
1531 changes to the current buffer."
1536 "Non-nil means `org-open-file' will open non-existing files.
1537 When nil, an error will be generated.
1538 This variable applies only to external applications because they
1539 might choke on non-existing files. If the link is to a file that
1540 will be opened in Emacs, the variable is ignored."
1545 "Non-nil means a link to a directory really means to index.org.
1546 When nil, following a directory link will run dired or open a finder/explorer
1547 window on that directory."
1552 "Function and arguments to call for following mailto links.
1553 This is a list with the first element being a Lisp function, and the
1554 remaining elements being arguments to the function. In string arguments,
1555 %a will be replaced by the address, and %s will be replaced by the subject
1556 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1565 "Non-nil means ask for confirmation before executing shell links.
1566 Shell links can be dangerous: just think about a link
1568 [[shell:rm -rf ~/*][Google Search]]
1571 but really it would remove your entire home directory.
1572 Therefore we advise against setting this variable to nil.
1573 Just change it to `y-or-n-p' if you want to confirm with a
1581 'safe-local-variable
1585 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1586 Elisp links can be dangerous: just think about a link
1591 but really it would remove your entire home directory.
1592 Therefore we advise against setting this variable to nil.
1593 Just change it to `y-or-n-p' if you want to confirm with a
1601 'safe-local-variable
1608 "Default file applications on a UNIX or GNU/Linux system.
1619 "Default file applications on a MacOS X system.
1621 for some files for which the OS does not have a good default.
1629 'mswindows-shell-execute
1634 'mswindows-shell-execute
1637 "Default file applications on a Windows NT system.
1642 '(
1647 )
1648 "External applications for opening `file:path' items in a document.
1649 Org-mode uses system defaults for different file types, but
1650 you can use this variable to set the application for a given file
1651 extension. The entries in this list are cons cells where the car identifies
1652 files and the cdr the corresponding command. Possible values for the
1653 file identifier are
1655 ways, depending on its contents:
1657 - Alphanumeric characters only:
1658 Match links with this file extension.
1660 to open PDFs with evince.
1662 - Regular expression: Match links where the
1663 filename matches the regexp. If you want to
1664 use groups here, use shy groups.
1668 to open *.html and *.xhtml with firefox.
1670 - Regular expression which contains (non-shy) groups:
1672 anything after that, matches the regexp.
1673 In a custom command string, %1, %2, etc. are replaced with
1674 the parts of the link that were matched by the groups.
1675 For backwards compatibility, if a command string is given
1676 that does not use any of the group matches, this case is
1677 handled identically to the second one (i.e. match against
1678 file name only).
1679 In a custom lisp form, you can access the group matches with
1680 (match-string n link).
1683 to open [[file:document.pdf::5]] with evince at page 5.
1685 `directory' Matches a directory
1686 `remote' Matches a remote file, accessible through tramp or efs.
1687 Remote files most likely should be visited through Emacs
1688 because external applications cannot handle such paths.
1689 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1690 so all files Emacs knows how to handle. Using this with
1691 command `emacs' will open most files in Emacs. Beware that this
1692 will also open html files inside Emacs, unless you add
1694 t Default for files not matched by any of the other options.
1695 `system' The system command to open files, like `open' on Windows
1696 and Mac OS X, and mailcap under GNU/Linux. This is the command
1697 that will be selected if you call `C-c C-o' with a double
1700 Possible values for the command are:
1701 `emacs' The file will be visited by the current Emacs process.
1702 `default' Use the default application for this file type, which is the
1703 association for t in the list, most likely in the system-specific
1704 part.
1705 This can be used to overrule an unwanted setting in the
1706 system-specific variable.
1708 This command is specified by the entry whose car is `system'.
1709 Most likely, the system-specific version of this variable
1710 does define this command, but you can overrule/replace it
1711 here.
1712 string A command to be executed by a shell; %s will be replaced
1713 by the path to the file.
1714 sexp A Lisp form which will be evaluated. The file path will
1715 be available in the Lisp variable `file'.
1716 For more examples, see the system specific constants
1717 `org-file-apps-defaults-macosx'
1718 `org-file-apps-defaults-windowsnt'
1719 `org-file-apps-defaults-gnu'."
1729 auto-mode))
1740 "Options concerning refiling entries in Org-mode."
1745 "Directory with org files.
1746 This is just a default location to look for Org files. There is no need
1747 at all to put your files into this directory. It is only used in the
1748 following situations:
1750 1. When a remember template specifies a target file that is not an
1751 absolute path. The path will then be interpreted relative to
1752 `org-directory'
1753 2. When a remember note is filed away in an interactive way (when exiting the
1754 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1755 with `org-directory' as the default path."
1761 "Default target for storing notes.
1762 Used as a fall back file for org-remember.el and org-capture.el, for
1763 templates that do not specify a target file."
1768 file))
1771 "The default interface to be used for `org-goto'.
1772 Allowed values are:
1773 outline The interface shows an outline of the relevant file
1774 and the correct heading is found by moving through
1775 the outline or by searching with incremental search.
1776 outline-path-completion Headlines in the current buffer are offered via
1777 completion. This is the interface also used by
1778 the refile command."
1785 "Maximum target level when running `org-goto' with refile interface."
1790 "Non-nil means store new notes at the beginning of a file or entry.
1791 When nil, new notes will be filed to the end of a file or entry.
1792 This can also be a list with cons cells of regular expressions that
1793 are matched against file names, and values."
1803 "Information to record when a task is refiled.
1805 Possible values are:
1807 nil Don't add anything
1808 time Add a time stamp to the task
1809 note Prompt for a note and add it with template `org-log-note-headings'
1811 This option can also be set with on a per-file-basis with
1813 #+STARTUP: nologrefile
1814 #+STARTUP: logrefile
1815 #+STARTUP: lognoterefile
1817 You can have local logging settings for a subtree by setting the LOGGING
1818 property to one or more of these keywords.
1820 When bulk-refiling from the agenda, the value `note' is forbidden and
1821 will temporarily be changed to `time'."
1831 This is list of cons cells. Each cell contains:
1832 - a specification of the files to be considered, either a list of files,
1833 or a symbol whose function or variable value will be used to retrieve
1834 a file name or a list of file names. If you use `org-agenda-files' for
1835 that, all agenda files will be scanned for targets. Nil means consider
1836 headings in the current buffer.
1837 - A specification of how to find candidate refile targets. This may be
1838 any of:
1840 This tag has to be present in all target headlines, inheritance will
1841 not be considered.
1843 todo keyword.
1845 headlines that are refiling targets.
1846 - a cons cell (:level . N). Any headline of level N is considered a target.
1847 Note that, when `org-odd-levels-only' is set, level corresponds to
1848 order in hierarchy, not to the number of stars.
1849 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1850 Note that, when `org-odd-levels-only' is set, level corresponds to
1851 order in hierarchy, not to the number of stars.
1853 You can set the variable `org-refile-target-verify-function' to a function
1854 to verify each headline found by the simple criteria above.
1856 When this variable is nil, all top-level headlines in the current buffer
1857 are used, equivalent to the value `((nil . (:level . 1))'."
1873 "Function to verify if the headline at point should be a refile target.
1874 The function will be called without arguments, with point at the
1875 beginning of the headline. It should return t and leave point
1876 where it is if the headline is a valid target for refiling.
1878 If the target should not be selected, the function must return nil.
1879 In addition to this, it may move point to a place from where the search
1880 should be continued. For example, the function may decide that the entire
1881 subtree of the current entry should be excluded and move point to the end
1882 of the subtree."
1887 "Non-nil means cache refile targets to speed up the process.
1888 The cache for a particular file will be updated automatically when
1889 the buffer has been killed, or when any of the marker used for flagging
1890 refile targets no longer points at a live buffer.
1891 If you have added new entries to a buffer that might themselves be targets,
1892 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1893 find that easier, `C-u C-u C-u C-c C-w'."
1898 "Non-nil means provide refile targets as paths.
1899 So a level 3 headline will be available as level1/level2/level3.
1901 When the value is `file', also include the file name (without directory)
1902 into the path. In this case, you can also stop the completion after
1903 the file name, to get entries inserted as top level in the file.
1905 When `full-file-path', include the full file path."
1914 "Non-nil means complete the outline path in hierarchical steps.
1915 When Org-mode uses the refile interface to select an outline path
1916 \(see variable `org-refile-use-outline-path'), the completion of
1917 the path can be done is a single go, or if can be done in steps down
1918 the headline hierarchy. Going in steps is probably the best if you
1919 do not use a special completion package like `ido' or `icicles'.
1920 However, when using these packages, going in one step can be very
1921 fast, while still showing the whole path to the entry."
1926 "Non-nil means allow to create new nodes as refile targets.
1928 of an existing node. When the value of this variable is `confirm',
1929 new node creation must be confirmed by the user (recommended)
1930 When nil, the completion must match an existing entry.
1932 Note that, if the new heading is not seen by the criteria
1933 listed in `org-refile-targets', multiple instances of the same
1934 heading would be created by trying again to file under the new
1935 heading."
1943 "Options concerning TODO items in Org-mode."
1948 "Options concerning Progress logging in Org-mode."
1953 '(
1956 "The available interpretation symbols for customizing `org-todo-keywords'.
1960 "List of TODO entry keyword sequences and their interpretation.
1963 Each sequence starts with a symbol, either `sequence' or `type',
1964 indicating if the keywords should be interpreted as a sequence of
1965 action steps, or as different types of TODO items. The first
1966 keywords are states requiring action - these states will select a headline
1967 for inclusion into the global TODO list Org-mode produces. If one of
1970 the last keyword is treated as the only DONE state of the sequence.
1973 additional state where no keyword is present. For details about this
1974 cycling, see the manual.
1976 TODO keywords and interpretation can also be set on a per-file basis with
1977 the special #+SEQ_TODO and #+TYP_TODO lines.
1979 Each keyword can optionally specify a character for fast state selection
1980 \(in combination with the variable `org-use-fast-todo-selection')
1981 and specifiers for state change logging, using the same syntax
1984 indicates to record a time stamp each time this state is selected.
1986 Each keyword may also specify if a timestamp or a note should be
1987 recorded when entering or leaving the state, by adding additional
1988 characters in the parenthesis after the keyword. This looks like this:
1990 record only the time of the state change. With X and Y being either
1992 Y when leaving the state if and only if the *target* state does not
1993 define X. You may omit any of the fast-selection key or X or /Y,
1994 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1996 For backward compatibility, this variable may also be just a list
1997 of keywords - in this case the interpretation (sequence or type) will be
1998 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2008 ;;Quick and dirty way to see
2009 ;;`org-todo-interpretations'. This takes the
2010 ;;place of item arguments
2011 :convert-widget
2018 org-todo-interpretation-widgets))
2019 widget))
2050 "Controls how TODO keywords are interpreted.
2051 This variable is in principle obsolete and is only used for
2052 backward compatibility, if the interpretation of todo keywords is
2053 not given already in `org-todo-keywords'. See that variable for
2054 more information."
2061 "Non-nil means use the fast todo selection scheme with C-c C-t.
2062 This variable describes if and under what circumstances the cycling
2063 mechanism for TODO keywords will be replaced by a single-key, direct
2064 selection scheme.
2066 When nil, fast selection is never used.
2068 When the symbol `prefix', it will be used when `org-todo' is called with
2069 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2070 in an agenda buffer.
2072 When t, fast selection is used by default. In this case, the prefix
2073 argument forces cycling instead.
2075 In all cases, the special interface is only used if access keys have actually
2076 been assigned by the user, i.e. if keywords in the configuration are followed
2077 by a letter in parenthesis, like TODO(t)."
2085 "Non-nil means update todo statistics after insert and toggle.
2086 ALL-HEADLINES means update todo statistics by including headlines
2087 with no TODO keyword as well, counting them as not done.
2088 A list of TODO keywords means the same, but skip keywords that are
2089 not in this list.
2091 When this is set, todo statistics is updated in the parent of the
2092 current entry each time a todo state is changed."
2102 "Non-nil means TODO statistics covers just direct children.
2103 When nil, all entries in the subtree are considered.
2104 This has only an effect if `org-provide-todo-statistics' is set.
2105 To set this to nil for only a single subtree, use a COOKIE_DATA
2111 "Hook which is run after the state of a TODO item was changed.
2112 The new state (a string with a TODO keyword, or nil) is available in the
2113 Lisp variable `state'."
2118 "Hook for functions that are allowed to block a state change.
2120 Each function gets as its single argument a property list, see
2121 `org-trigger-hook' for more information about this list.
2123 If any of the functions in this hook returns nil, the state change
2127 "Hook for functions that are triggered by a state change.
2129 Each function gets as its single argument a property list with at least
2130 the following elements:
2132 (:type type-of-change :position pos-at-entry-start
2133 :from old-state :to new-state)
2135 Depending on the type, more properties may be present.
2137 This mechanism is currently implemented for:
2139 TODO state changes
2140 ------------------
2141 :type todo-state-change
2142 :from previous state (keyword as a string), or nil, or a symbol
2143 'todo' or 'done', to indicate the general type of state.
2147 "Non-nil means undone TODO entries will block switching the parent to DONE.
2148 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2149 be blocked if any prior sibling is not yet done.
2150 Finally, if the parent is blocked because of ordered siblings of its own,
2151 the child will also be blocked.
2152 This variable needs to be set before org.el is loaded, and you need to
2153 restart Emacs after a change to make the change effective. The only way
2154 to change is while Emacs is running is through the customize interface."
2166 "Non-nil means unchecked boxes will block switching the parent to DONE.
2167 When this is nil, checkboxes have no influence on switching TODO states.
2168 When non-nil, you first need to check off all check boxes before the TODO
2169 entry can be switched to DONE.
2170 This variable needs to be set before org.el is loaded, and you need to
2171 restart Emacs after a change to make the change effective. The only way
2172 to change is while Emacs is running is through the customize interface."
2184 "Non-nil means inserting a TODO heading is treated as state change.
2186 logging will apply if appropriate. When nil, the new TODO item will
2187 be inserted directly, and no logging will take place."
2192 "Non-nil means switching TODO states with S-cursor counts as state change.
2193 This is the default behavior. However, setting this to nil allows a
2194 convenient way to select a TODO state and bypass any logging associated
2195 with that."
2200 "Tag changes that should be triggered by TODO state changes.
2201 This is a list. Each entry is
2203 (state-change (tag . flag) .......)
2205 State-change can be a string with a state, and empty string to indicate the
2206 state that has no TODO keyword, or it can be one of the symbols `todo'
2207 or `done', meaning any not-done or done state, respectively."
2221 "Information to record when a task moves to the DONE state.
2223 Possible values are:
2225 nil Don't add anything, just change the keyword
2226 time Add a time stamp to the task
2227 note Prompt for a note and add it with template `org-log-note-headings'
2229 This option can also be set with on a per-file-basis with
2231 #+STARTUP: nologdone
2232 #+STARTUP: logdone
2233 #+STARTUP: lognotedone
2235 You can have local logging settings for a subtree by setting the LOGGING
2236 property to one or more of these keywords."
2244 ;; Normalize old uses of org-log-done.
2251 "Information to record when the scheduling date of a tasks is modified.
2253 Possible values are:
2255 nil Don't add anything, just change the date
2256 time Add a time stamp to the task
2257 note Prompt for a note and add it with template `org-log-note-headings'
2259 This option can also be set with on a per-file-basis with
2261 #+STARTUP: nologreschedule
2262 #+STARTUP: logreschedule
2263 #+STARTUP: lognotereschedule"
2272 "Information to record when the deadline date of a tasks is modified.
2274 Possible values are:
2276 nil Don't add anything, just change the date
2277 time Add a time stamp to the task
2278 note Prompt for a note and add it with template `org-log-note-headings'
2280 This option can also be set with on a per-file-basis with
2282 #+STARTUP: nologredeadline
2283 #+STARTUP: logredeadline
2284 #+STARTUP: lognoteredeadline
2286 You can have local logging settings for a subtree by setting the LOGGING
2287 property to one or more of these keywords."
2296 "Non-nil means record a note when clocking out of an item.
2297 This can also be configured on a per-file basis by adding one of
2298 the following lines anywhere in the buffer:
2300 #+STARTUP: lognoteclock-out
2301 #+STARTUP: nolognoteclock-out"
2307 "Non-nil means the CLOSED time stamp will contain date and time.
2308 When nil, only the date will be recorded."
2322 "Headings for notes added to entries.
2323 The value is an alist, with the car being a symbol indicating the note
2324 context, and the cdr is the heading to be used. The heading may also be the
2325 empty string.
2326 %t in the heading will be replaced by a time stamp.
2327 %T will be an active time stamp instead the default inactive one
2328 %s will be replaced by the new TODO state, in double quotes.
2329 %S will be replaced by the old TODO state, in double quotes.
2330 %u will be replaced by the user name.
2331 %U will be replaced by the full user name.
2333 In fact, it is not a good idea to change the `state' entry, because
2334 agenda log mode depends on the format of these entries."
2340 "Heading when changing todo state (todo sequence only)"
2354 "Non-nil means insert state change notes and time stamps into a drawer.
2355 When nil, state changes notes will be inserted after the headline and
2356 any scheduling and clock lines, but not inside a drawer.
2358 The value of this variable should be the name of the drawer to use.
2359 LOGBOOK is proposed at the default drawer for this purpose, you can
2360 also set this to a string to define the drawer of your choice.
2364 If this variable is set, `org-log-state-notes-insert-after-drawers'
2365 will be ignored.
2367 You can set the property LOG_INTO_DRAWER to overrule this setting for
2368 a subtree."
2380 "Return the value of `org-log-into-drawer', but let properties overrule.
2381 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2382 used instead of the default value."
2390 "Non-nil means insert state change notes after any drawers in entry.
2391 Only the drawers that *immediately* follow the headline and the
2392 deadline/scheduled line are skipped.
2393 When nil, insert notes right after the heading and perhaps the line
2394 with deadline/scheduling if present.
2396 This variable will have no effect if `org-log-into-drawer' is
2397 set."
2403 "Non-nil means the latest state note will be directly after heading.
2404 When nil, the state change notes will be ordered according to time."
2410 "The TODO state to which a repeater should return the repeating task.
2411 By default this is the first task in a TODO sequence, or the previous state
2412 in a TODO_TYP set. But you can specify another task here.
2413 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2419 "Non-nil means record moving through the DONE state when triggering repeat.
2420 An auto-repeating task is immediately switched back to TODO when
2423 record a closing note, there will be no record of the task moving
2424 through DONE. This variable forces taking a note anyway.
2426 nil Don't force a record
2427 time Record a time stamp
2428 note Record a note
2430 This option can also be set with on a per-file-basis with
2432 #+STARTUP: logrepeat
2433 #+STARTUP: lognoterepeat
2434 #+STARTUP: nologrepeat
2436 You can have local logging settings for a subtree by setting the LOGGING
2437 property to one or more of these keywords."
2447 "Priorities in Org-mode."
2452 "Non-nil means priority commands are active.
2453 When nil, these commands will be disabled, so that you never accidentally
2454 set a priority."
2459 "The highest priority of TODO items. A character like ?A, ?B etc.
2460 Must have a smaller ASCII number than `org-lowest-priority'."
2465 "The lowest priority of TODO items. A character like ?A, ?B etc.
2466 Must have a larger ASCII number than `org-highest-priority'."
2471 "The default priority of TODO items.
2472 This is the priority an item get if no explicit priority is given."
2477 "Non-nil means start with default priority when starting to cycle.
2478 When this is nil, the first step in the cycle will be (depending on the
2479 command used) one higher or lower that the default priority."
2484 "Function to extract the priority from a string.
2485 The string is normally the headline. If this is nil Org computes the
2486 priority from the priority cookie like [#A] in the headline. It returns
2487 an integer, increasing by 1000 for each priority level.
2488 The user can set a different function here, which should take a string
2489 as an argument and return the numeric priority."
2494 "Options concerning time stamps and deadlines in Org-mode."
2499 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2500 When nil, these labeled time stamps are forces into the second line of an
2501 entry, just after the headline. When scheduling from the global TODO list,
2502 the time stamp will always be forced into the second line."
2507 "Formats for `format-time-string' which are used for time stamps.
2511 "Number of minutes to round time stamps to.
2512 These are two values, the first applies when first creating a time stamp.
2513 The second applies when changing it with the commands `S-up' and `S-down'.
2514 When changing the time stamp, this means that it will change in steps
2515 of N minutes, as given by the second value.
2517 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2518 numbers should be factors of 60, so for example 5, 10, 15.
2520 When this is larger than 1, you can still force an exact time stamp by using
2521 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2522 and by using a prefix arg to `S-up/down' to specify the exact number
2523 of minutes to shift."
2533 ;; Normalize old customizations of this variable.
2537 org-time-stamp-rounding-minutes)))
2540 "Non-nil means overlay custom formats over all time stamps.
2541 The formats are defined through the variable `org-time-stamp-custom-formats'.
2542 To turn this on on a per-file basis, insert anywhere in the file:
2543 #+STARTUP: customtime"
2551 "Custom formats for time stamps. See `format-time-string' for the syntax.
2552 These are overlayed over the default ISO format if the variable
2553 `org-display-custom-times' is set. Time like %H:%M should be at the
2554 end of the second format. The custom formats are also honored by export
2555 commands, if custom time display is turned on at the time of export."
2560 "Get the right format for a time string."
2565 f)))
2568 "The format string used when creating CLOCKSUM lines.
2569 This is also used when org-mode generates a time duration."
2575 org-mode generates a time duration."
2580 "The format string used when creating CLOCKSUM lines, or when
2581 org-mode generates a time duration."
2586 "No. of days before expiration during which a deadline becomes active.
2587 This variable governs the display in sparse trees and in the agenda.
2588 When 0 or negative, it means use this number (the absolute value of it)
2589 even if a deadline has a different individual lead time specified.
2591 Custom commands can set this variable in the options section."
2597 "Non-nil means assume future for incomplete date input from user.
2598 This affects the following situations:
2599 1. The user gives a month but not a year.
2602 2. The user gives a day, but no month.
2605 it will be considered as *this* month.
2607 If you set this variable to the symbol `time', then also the following
2608 will work:
2610 3. If the user gives a time, but no day. If the time is before now,
2611 to will be interpreted as tomorrow.
2613 Currently none of this works for ISO week specifications.
2615 When this option is nil, the current day, month and year will always be
2616 used as defaults.
2618 See also `org-agenda-jump-prefer-future'."
2626 "Should the agenda jump command prefer the future for incomplete dates?
2627 The default is to do the same as configured in `org-read-date-prefer-future'.
2628 But you can alse set a deviating value here.
2629 This may t or nil, or the symbol `org-read-date-prefer-future'."
2634 org-read-date-prefer-future)
2639 "Non-nil means display current interpretation of date prompt live.
2640 This display will be in an overlay, in the minibuffer."
2645 "Non-nil means pop up a calendar when prompting for a date.
2646 In the calendar, the date can be selected with mouse-1. However, the
2647 minibuffer will also be active, and you can simply enter the date as well.
2648 When nil, only the minibuffer will be available."
2656 "Hook to be used to set up keys for the date/time interface.
2657 Add key definitions to `minibuffer-local-map', which will be a temporary
2658 copy."
2663 "The hour when your day really ends. Must be an integer.
2664 This has influence for the following applications:
2666 the time given here, the day recognized as TODAY is actually yesterday.
2667 - When a date is read from the user and it is still before the time given
2668 here, the current date and time will be assumed to be yesterday, 23:59.
2669 Also, timestamps inserted in remember templates follow this rule.
2671 IMPORTANT: This is a feature whose implementation is and likely will
2672 remain incomplete. Really, it is only here because past midnight seems to
2673 be the favorite working time of John Wiegley :-)"
2678 "Non-nil means S-down will increase the time in a time stamp.
2679 When nil, S-up will increase."
2684 "Non-nil means make the calendar window follow timestamp changes.
2685 When a timestamp is modified and the calendar window is visible, it will be
2686 moved to the new date."
2691 "Options concerning tags in Org-mode."
2696 "List of tags allowed in Org-mode files.
2697 When this list is nil, Org-mode will base TAG input on what is already in the
2698 buffer.
2699 The value of this variable is an alist, the car of each entry must be a
2700 keyword as a string, the cdr may be a character that is used to select
2701 that tag through the fast-tag-selection interface.
2702 See the manual for details."
2717 "List of tags that will always appear in all Org-mode files.
2718 This is in addition to any in buffer settings or customizations
2719 of `org-tag-alist'.
2720 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2721 The value of this variable is an alist, the car of each entry must be a
2722 keyword as a string, the cdr may be a character that is used to select
2723 that tag through the fast-tag-selection interface.
2724 See the manual for details.
2725 To disable these tags on a per-file basis, insert anywhere in the file:
2726 #+STARTUP: noptag"
2737 "If non-nil, always offer completion for all tags of all agenda files.
2738 Instead of customizing this variable directly, you might want to
2739 set it locally for capture buffers, because there no list of
2740 tags in that file can be created dynamically (there are none).
2742 (add-hook 'org-capture-mode-hook
2743 (lambda ()
2744 (set (make-local-variable
2745 'org-complete-tags-always-offer-all-agenda-tags)
2746 t)))"
2751 "List of tags that can be inherited by all entries in the file.
2752 The tags will be inherited if the variable `org-use-tag-inheritance'
2753 says they should be.
2757 "Non-nil means use fast tag selection scheme.
2758 This is a special interface to select and deselect tags with single keys.
2759 When nil, fast selection is never used.
2760 When the symbol `auto', fast selection is used if and only if selection
2761 characters for tags have been configured, either through the variable
2762 `org-tag-alist' or through a #+TAGS line in the buffer.
2763 When t, fast selection is always used and selection keys are assigned
2764 automatically if necessary."
2772 "Non-nil means fast tag selection exits after first change.
2773 When nil, you have to press RET to exit it.
2774 During fast tag selection, you can toggle this flag with `C-c'.
2775 This variable can also have the value `expert'. In this case, the window
2776 displaying the tags menu is not even shown, until you press C-c again."
2784 "Non-nil means fast tags selection interface will also offer TODO states.
2788 "The column to which tags should be indented in a headline.
2789 If this number is positive, it specifies the column. If it is negative,
2790 it means that the tags should be flushright to that column. For example,
2791 -80 works well for a normal 80 character screen."
2796 "Non-nil means realign tags after pro/demotion of TODO state change.
2797 These operations change the length of a headline and therefore shift
2798 the tags around. With this options turned on, after each such operation
2799 the tags are again aligned to `org-tags-column'."
2804 "Non-nil means tags in levels apply also for sublevels.
2805 When nil, only the tags directly given in a specific line apply there.
2806 This may also be a list of tags that should be inherited, or a regexp that
2807 matches tags that should be inherited. Additional control is possible
2808 with the variable `org-tags-exclude-from-inheritance' which gives an
2809 explicit list of tags to be excluded from inheritance., even if the value of
2810 `org-use-tag-inheritance' would select it for inheritance.
2812 If this option is t, a match early-on in a tree can lead to a large
2813 number of matches in the subtree when constructing the agenda or creating
2814 a sparse tree. If you only want to see the first match in a tree during
2815 a search, check out the variable `org-tags-match-list-sublevels'."
2824 "List of tags that should never be inherited.
2825 This is a way to exclude a few tags from inheritance. For way to do
2826 the opposite, to actively allow inheritance for selected tags,
2827 see the variable `org-use-tag-inheritance'."
2832 "Check if TAG is one that should be inherited."
2844 "Non-nil means list also sublevels of headlines matching a search.
2845 This variable applies to tags/property searches, and also to stuck
2846 projects because this search is based on a tags match as well.
2848 When set to the symbol `indented', sublevels are indented with
2849 leading dots.
2851 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2852 the sublevels of a headline matching a tag search often also match
2853 the same search. Listing all of them can create very long lists.
2854 Setting this variable to nil causes subtrees of a match to be skipped.
2856 This variable is semi-obsolete and probably should always be true. It
2857 is better to limit inheritance to certain tags using the variables
2858 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2866 "When set, tags are sorted using this function as a comparator."
2882 "Options concerning properties in Org-mode."
2887 "How property key/value pairs should be formatted by `indent-line'.
2888 When `indent-line' hits a property definition, it will format the line
2889 according to this format, mainly to make sure that the values are
2890 lined-up with respect to each other."
2895 "Non-nil means properties apply also for sublevels.
2897 This setting is chiefly used during property searches. Turning it on can
2898 cause significant overhead when doing a search, which is why it is not
2899 on by default.
2901 When nil, only the properties directly given in the current entry count.
2902 When t, every property is inherited. The value may also be a list of
2903 properties that should have inheritance, or a regular expression matching
2904 properties that should be inherited.
2906 However, note that some special properties use inheritance under special
2907 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2909 for valid values of a property.
2911 Note for programmers:
2912 When querying an entry with `org-entry-get', you can control if inheritance
2913 should be used. By default, `org-entry-get' looks only at the local
2914 properties. You can request inheritance by setting the inherit argument
2915 to t (to force inheritance) or to `selective' (to respect the setting
2916 in this variable)."
2925 "Check if PROPERTY is one that should be inherited."
2936 "The default column format, if no other format has been defined.
2937 This variable can be set on the per-file basis by inserting a line
2939 #+COLUMNS: %25ITEM ....."
2944 "The ellipses to be used when a field in column view is truncated.
2945 When this is the empty string, as many characters as possible are shown,
2946 but then there will be no visual indication that the field has been truncated.
2947 When this is a string of length N, the last N characters of a truncated
2948 field are replaced by this string. If the column is narrower than the
2949 ellipses string, only part of the ellipses string will be shown."
2954 "Function that modifies values for display in column view.
2955 For example, it can be used to cut out a certain part from a time stamp.
2956 The function must take 2 arguments:
2958 column-title The title of the column (*not* the property name)
2959 value The value that should be modified.
2961 The function should return the value that should be displayed,
2962 or nil if the normal value should be used."
2967 "The property that is being used to keep track of effort estimates.
2968 Effort estimates given in this property need to have the format H:MM."
2976 "List of property/value pairs that can be inherited by any entry.
2978 These are fixed values, for the preset properties. The user variable
2979 that can be used to add to this list is `org-global-properties'.
2981 The entries in this list are cons cells where the car is a property
2982 name and cdr is a string with the value. If the value represents
2987 "List of property/value pairs that can be inherited by any entry.
2989 This list will be combined with the constant `org-global-properties-fixed'.
2991 The entries in this list are cons cells where the car is a property
2992 name and cdr is a string with the value.
2994 You can set buffer-local values for the same purpose in the variable
2995 `org-file-properties' this by adding lines like
2997 #+PROPERTY: NAME VALUE"
3004 "List of property/value pairs that can be inherited by any entry.
3005 Valid for the current buffer.
3010 "Options concerning agenda views in Org-mode."
3015 "Variable used by org files to set a category for agenda display.
3016 Such files should use a file variable to set it, for example
3020 or contain a special line
3022 #+CATEGORY: ELisp
3024 If the file does not specify a category, then file's base name
3030 "The files to be used for agenda display.
3034 If an entry is a directory, all files in that directory that are matched by
3035 `org-agenda-file-regexp' will be part of the file list.
3037 If the value of the variable is not a list but a single file name, then
3038 the list of agenda files is actually stored and maintained in that file, one
3039 agenda file per line. In this file paths can be given relative to
3040 `org-directory'. Tilde expansion and environment variable substitution
3041 are also made."
3048 "Regular expression to match files for `org-agenda-files'.
3049 If any element in the list in that variable contains a directory instead
3050 of a normal file, all files in that directory that are matched by this
3051 regular expression will be included."
3056 "List of extra files to be searched by text search commands.
3057 These files will be search in addition to the agenda files by the
3058 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3059 Note that these files will only be searched for text search commands,
3060 not for the other agenda views like todo lists, tag searches or the weekly
3061 agenda. This variable is intended to list notes and possibly archive files
3062 that should also be searched by these two commands.
3063 In fact, if the first element in the list is the symbol `agenda-archives',
3064 than all archive files of all agenda files will be added to the search
3065 scope."
3076 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3077 A nil value means to remove them, after a query, from the list."
3082 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3083 The command `org-calendar-goto-agenda' will be bound to this key. The
3084 default is the character `c' because then `c' can be used to switch back and
3085 forth between agenda and calendar."
3090 "The key to be installed in `calendar-mode-map' for agenda-action.
3091 The command `org-agenda-action' will be bound to this key. The
3092 default is the character `k' because we use the same key in the agenda."
3097 "The key to be installed in `calendar-mode-map' for adding diary entries.
3098 This option is irrelevant until `org-agenda-diary-file' has been configured
3099 to point to an Org-mode file. When that is the case, the command
3100 `org-agenda-diary-entry' will be bound to the key given here, by default
3101 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3102 if you want to continue doing this, you need to change this to a different
3103 key."
3108 "File to which to add new entries with the `i' key in agenda and calendar.
3109 When this is the symbol `diary-file', the functionality in the Emacs
3110 calendar will be used to add entries to the `diary-file'. But when this
3111 points to a file, `org-agenda-diary-entry' will be used instead."
3127 org-calendar-insert-diary-entry-key
3131 "Options for embedding LaTeX code into Org-mode."
3139 "Options for creating images from LaTeX fragments.
3140 This is a property list with the following properties:
3142 `default' means use the foreground of the default face.
3144 `default' means use the background of the default face.
3145 :scale a scaling factor for the size of the images, to get more pixels
3146 :html-foreground, :html-background, :html-scale
3147 the same numbers for HTML export.
3148 :matchers a list indicating which matchers should be used to
3149 find LaTeX fragments. Valid members of this list are:
3160 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3161 When nil, just push out a message."
3170 \[PACKAGES]
3171 \[DEFAULT-PACKAGES]
3172 % The settings below are copied from fullpage.sty
3185 "The document header used for processing LaTeX fragments.
3186 It is imperative that this header make sure that no page number
3187 appears on the page. The package defined in the variables
3188 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3190 will be appended."
3197 "Set the packages alist and make sure it has 3 elements per entry."
3201 x))
3202 val)))
3206 "Get the packages alist and make sure it has 3 elements per entry."
3210 x))
3213 ;; The following variables are defined here because is it also used
3214 ;; when formatting latex fragments. Originally it was part of the
3215 ;; LaTeX exporter, which is why the name includes "export".
3232 )
3233 "Alist of default packages to be inserted in the header.
3234 Change this only if one of the packages here causes an incompatibility
3235 with another package you are using.
3236 The packages in this list are needed by one part or another of Org-mode
3237 to function properly.
3239 - inputenc, fontenc: for basic font and character selection
3240 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3241 for interpreting the entities in `org-entities'. You can skip some of these
3242 packages if you don't use any of the symbols in it.
3243 - graphicx: for including images
3244 - float, wrapfig: for figure placement
3245 - longtable: for long tables
3246 - hyperref: for cross references
3248 Therefore you should not modify this variable unless you know what you
3249 are doing. The one reason to change it anyway is that you might be loading
3250 some other package that conflicts with one of the default packages.
3252 If SNIPPET-FLAG is t, the package also needs to be included when
3253 compiling LaTeX snippets into images for inclusion into HTML."
3266 "Alist of packages to be inserted in every LaTeX header.
3267 These will be inserted after `org-export-latex-default-packages-alist'.
3269 SNIPPET-FLAG, when t, indicates that this package is also needed when
3270 turning LaTeX snippets into images for inclusion into HTML.
3271 Make sure that you only list packages here which:
3272 - you want in every file
3273 - do not conflict with the default packages in
3274 `org-export-latex-default-packages-alist'
3275 - do not conflict with the setup in `org-format-latex-header'."
3289 "Settings for Org-mode appearance."
3294 "Non-nil means fontify only the stars in each headline.
3295 When nil, the entire headline is fontified.
3296 Changing it requires restart of `font-lock-mode' to become effective
3297 also in regions already fontified."
3302 "Non-nil means hide the first N-1 stars in a headline.
3303 This works by using the face `org-hide' for these stars. This
3304 face is white for a light background, and black for a dark
3305 background. You may have to customize the face `org-hide' to
3306 make this work.
3307 Changing it requires restart of `font-lock-mode' to become effective
3308 also in regions already fontified.
3309 You may also set this on a per-file basis by adding one of the following
3310 lines to the buffer:
3312 #+STARTUP: hidestars
3313 #+STARTUP: showstars"
3318 "List of keywords that should be hidden when typed in the org buffer.
3319 For example, add #+TITLE to this list in order to make the
3320 document title appear in the buffer without the initial #+TITLE:
3321 keyword."
3329 "Non-nil means change the face of a headline if it is marked DONE.
3330 Normally, only the TODO/DONE keyword indicates the state of a headline.
3331 When this is non-nil, the headline after the keyword is set to the
3332 `org-headline-done' as an additional indication."
3337 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3338 Changing this variable requires a restart of Emacs to take effect."
3343 "Non-nil means fontify the whole line for headings.
3344 This is useful when setting a background color for the
3345 org-level-* faces."
3350 "Non-nil means fontify what is treated specially by the exporters."
3355 "Non-nil mean font-lock should hide the emphasis marker characters."
3360 "Non-nil means show entities as UTF8 characters.
3366 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3371 "Regular expression for matching emphasis.
3372 After a match, the match groups contain these elements:
3373 0 The match of the full regular expression, including the characters
3374 before and after the proper match
3375 1 The character before the proper match, or empty at beginning of line
3376 2 The proper match, including the leading and trailing markers
3377 3 The leading marker like * or /, indicating the type of highlighting
3378 4 The text between the emphasis markers, not including the markers
3385 "Set variable and compute the emphasis regular expression."
3389 org-emphasis-alist org-emphasis-regexp-components)
3401 ;; make sure special characters appear at the right position in the class
3413 ;; Make the regexp
3421 body1
3433 body1
3441 "Components used to build the regular expression for emphasis.
3442 This is a list with five entries. Terminology: In an emphasis string
3446 specify what is allowed/forbidden in each part:
3448 pre Chars allowed as prematch. Beginning of line will be allowed too.
3449 post Chars allowed as postmatch. End of line will be allowed too.
3450 border The chars *forbidden* as border characters.
3452 non-shy groups here, and don't allow newline here.
3453 newline The maximum number of newlines allowed in an emphasis exp.
3455 Use customize to modify this, or restart Emacs after changing it."
3474 )
3475 "Special syntax for emphasized text.
3476 Text starting and ending with a special character will be emphasized, for
3477 example *bold*, _underlined_ and /italic/. This variable sets the marker
3478 characters, the face to be used by font-lock for highlighting in Org-mode
3479 Emacs buffers, and the HTML tags to be used for this.
3480 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3481 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3482 Use customize to modify this, or restart Emacs after changing it."
3497 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3500 ;;; Miscellaneous options
3503 "Completion in Org-mode."
3508 "Non-nil means use ido completion wherever possible.
3509 Note that `ido-mode' must be active for this variable to be relevant.
3510 If you decide to turn this variable on, you might well want to turn off
3511 `org-outline-path-complete-in-steps'.
3512 See also `org-completion-use-iswitchb'."
3517 "Non-nil means use iswitchb completion wherever possible.
3518 Note that `iswitchb-mode' must be active for this variable to be relevant.
3519 If you decide to turn this variable on, you might well want to turn off
3520 `org-outline-path-complete-in-steps'.
3521 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3527 Normal means, no org-mode-specific context."
3531 ;;; Functions and variables from their packages
3532 ;; Declared here to avoid compiler warnings
3534 ;; XEmacs only
3540 ;; Emacs only
3543 ;; Various packages
3561 org-format-agenda-item "org-agenda"
3592 ;;; Autoload and prepare some org modules
3594 ;; Some table stuff that needs to be defined here, because it is used
3595 ;; by the functions setting up org-mode or checking for table context.
3608 "Detect the first line outside a table when searching from within it.
3611 ;; Autoload the functions in org-table.el that are needed by functions here.
3616 org-table-convert org-table-convert-region org-table-copy-down
3617 org-table-copy-region org-table-create
3618 org-table-create-or-convert-from-region
3619 org-table-create-with-table.el org-table-current-dline
3620 org-table-cut-region org-table-delete-column org-table-edit-field
3621 org-table-edit-formulas org-table-end org-table-eval-formula
3622 org-table-export org-table-field-info
3623 org-table-get-stored-formulas org-table-goto-column
3624 org-table-hline-and-move org-table-import org-table-insert-column
3625 org-table-insert-hline org-table-insert-row org-table-iterate
3626 org-table-justify-field-maybe org-table-kill-row
3627 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3628 org-table-move-column org-table-move-column-left
3629 org-table-move-column-right org-table-move-row
3630 org-table-move-row-down org-table-move-row-up
3631 org-table-next-field org-table-next-row org-table-paste-rectangle
3632 org-table-previous-field org-table-recalculate
3633 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3634 org-table-toggle-coordinate-overlays
3635 org-table-toggle-formula-debugger org-table-wrap-region
3636 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3637 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3638 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3641 "Return t if the cursor is inside an org-type table.
3642 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3647 org-table-line-regexp)))
3648 nil))
3652 "Return t if and only if we are at a table.el table."
3658 "If there is a table.el table nearby, recognize it and move into it."
3664 nil
3674 t
3679 t)
3680 nil)
3681 nil))
3684 "Return t if the cursor is inside a hline in a table."
3689 nil))
3694 "Apply FUNCTION to the start of all tables in the buffer."
3710 ;; Declare and autoload functions from org-exp.el & Co
3718 org-insert-export-options-template
3719 org-table-clean-before-export))
3722 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3723 org-export-region-as-ascii))
3726 org-replace-region-by-latex org-export-region-as-latex
3727 org-export-as-latex org-export-as-pdf
3728 org-export-as-pdf-and-open))
3731 org-export-as-html-batch org-export-as-html-to-buffer
3732 org-replace-region-by-html org-export-region-as-html
3733 org-export-as-html))
3736 org-replace-region-by-docbook org-export-region-as-docbook
3737 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3738 org-export-as-docbook))
3741 org-export-icalendar-all-agenda-files
3742 org-export-icalendar-combine-agenda-files))
3746 ;; Declare and autoload functions from org-agenda.el
3751 org-todo-list org-tags-view org-agenda-list-stuck-projects
3752 org-diary org-agenda-to-appt
3753 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3755 ;; Autoload org-remember
3760 org-remember-apply-template org-remember org-remember-handler)))
3765 org-capture-import-remember-templates)))
3767 ;; Autoload org-clock.el
3782 "Return non-nil if clock is currently running.
3783 The return value is actually the clock marker."
3788 "org-clock"
3790 org-clock-goto org-clock-sum org-clock-display
3791 org-clock-remove-overlays org-clock-report
3792 org-clocktable-shift org-dblock-write:clocktable
3793 org-get-clocktable org-resolve-clocks)))
3796 "If this is a CLOCK line, update it and return t.
3797 Otherwise, return nil."
3806 ts te h m s neg)
3809 nil)
3814 ;; The clock is running here
3835 t))))))
3838 "Check if the current buffer contains the running clock.
3839 If yes, offer to stop it and to save the buffer with the changes."
3848 "Check if this line starts a clock table, if yes, shift the time block."
3852 ;; Autoload org-timer.el
3856 "org-timer"
3858 org-timer-change-times-in-region
3859 org-timer-set-timer
3860 org-timer-reset-timers
3861 org-timer-show-remaining-time)))
3863 ;; Autoload org-feed.el
3867 "org-feed"
3871 ;; Autoload org-indent.el
3873 ;; Define the variable already here, to make sure we have it.
3875 "Non-nil if Org-Indent mode is enabled.
3880 "org-indent"
3883 ;; Autoload org-mobile.el
3887 "org-mobile"
3890 ;; Autoload archiving code
3891 ;; The stuff that is needed for cycling and tags has to be defined here.
3894 "Options concerning archiving in Org-mode."
3899 "The location where subtrees should be archived.
3901 The value of this variable is a string, consisting of two parts,
3902 separated by a double-colon. The first part is a filename and
3903 the second part is a headline.
3905 When the filename is omitted, archiving happens in the same file.
3906 %s in the filename will be replaced by the current file
3907 name (without the directory part). Archiving to a different file
3908 is useful to keep archived entries from contributing to the
3909 Org-mode Agenda.
3911 The archived entries will be filed as subtrees of the specified
3912 headline. When the headline is omitted, the subtrees are simply
3913 filed away at the end of the file, as top-level entries. Also in
3914 the heading you can use %s to represent the file name, this can be
3915 useful when using the same archive for a number of different files.
3917 Here are a few examples:
3919 If the current file is Projects.org, archive in file
3920 Projects.org_archive, as top-level trees. This is the default.
3923 Archive in the current file, under the top-level headline
3927 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3930 Archive in file ~/org/archive.org (absolute path), under headlines
3934 Archive in file ./basement (relative path), as level 3 trees
3937 You may set this option on a per-file basis by adding to the buffer a
3938 line like
3940 #+ARCHIVE: basement::** Finished Tasks
3942 You may also define it locally for a subtree by setting an ARCHIVE property
3943 in the entry. If such a property is found in an entry, or anywhere up
3944 the hierarchy, it will be used."
3949 "The tag that marks a subtree as archived.
3950 An archived subtree does not open during visibility cycling, and does
3951 not contribute to the agenda listings.
3952 After changing this, font-lock must be restarted in the relevant buffers to
3953 get the proper fontification."
3959 "Non-nil means the agenda will skip any items located in archived trees.
3960 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3961 variable is no longer recommended, you should leave it at the value t.
3962 Instead, use the key `v' to cycle the archives-mode in the agenda."
3968 "Non-nil means ignore archived trees when creating column view."
3974 "Non-nil means `org-cycle' will open archived trees.
3975 An archived tree is a tree marked with the tag ARCHIVE.
3976 When nil, archived trees will stay folded. You can still open them with
3977 normal outline commands like `show-all', but not with the cycling commands."
3983 "Non-nil means sparse tree construction shows matches in archived trees.
3984 When nil, matches in these trees are highlighted, but the trees are kept in
3985 collapsed state."
3991 "Re-hide all archived subtrees after a visibility state change."
4002 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4005 "Cycle subtree even if it is archived."
4012 "Re-hide all archived subtrees after a visibility state change."
4027 flag)))
4034 org-archive-to-archive-sibling org-toggle-archive-tag
4035 org-archive-subtree-default
4036 org-archive-subtree-default-with-confirmation)))
4038 ;; Autoload Column View Code
4046 org-columns-compute org-agenda-columns org-columns-remove-overlays
4049 ;; Autoload ID code
4057 org-id-get-with-outline-path-completion
4058 org-id-get-with-outline-drilling org-id-store-link
4059 org-id-goto org-id-find org-id-store-link))
4061 ;; Autoload Plotting Code
4066 ;;; Variables for pre-computed regular expressions, all buffer local
4084 "Matches a headline and puts everything into groups:
4085 group 1: the stars
4086 group 2: The todo keyword, maybe
4087 group 3: Priority cookie
4088 group 4: True headline
4092 "Printf format to make regexp to match an exact headline.
4093 This regexp will match the headline of any node which hase the exact
4094 headline text that is put into the format, but may have any TODO state,
4098 "Matches a headline and puts TODO state into group 2 if present.
4153 "Regular expression to match a plain time or time range.
4154 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4155 groups carry important information:
4156 0 the full match
4157 1 the first time, range or not
4165 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4166 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4167 groups carry important information:
4168 0 the full match
4169 7 hours of duration
4178 "Regular expression to match a timestamp time or time range.
4179 After a match, the following groups carry important information:
4180 0 the full match
4181 1 date plus weekday, for back referencing to make sure both times are on the same day
4182 2 the first time, range or not
4237 "Variable associated with STARTUP options for org-mode.
4238 Each element is a list of three items: The startup options as written
4239 in the #+STARTUP line, the corresponding variable, and the value to
4240 set this variable to if the option is found. An optional forth element PUSH
4244 "Precompute regular expressions for current buffer."
4264 kwds kws0 kwsa key log value cat arch tags const links hw dws
4265 tail sep kws1 prio props ftags drawers beamer-p
4287 ;; general TODO-like setup
4299 links)))
4305 props)))
4310 ftags
4320 l var val)
4350 ))))
4367 ;; Process the TODO keywords
4369 ;; Use the global values as if they had been given locally.
4381 kws)))
4384 kwsa nil
4387 ;; 1 2
4395 kw)
4397 kws0)
4414 ;; Process the constants
4422 ;; Process the tags.
4433 tgs))
4441 ;; Compute the regular expressions and other local variables
4449 org-drawer-regexp
4453 org-not-done-keywords
4455 org-todo-regexp
4458 org-not-done-regexp
4462 org-not-done-heading-regexp
4466 org-todo-line-regexp
4470 org-complex-heading-regexp
4475 org-complex-heading-regexp-format
4484 org-nl-done-regexp
4488 org-todo-line-tags-regexp
4493 org-looking-at-done-regexp
4498 org-deadline-time-regexp
4500 org-deadline-line-regexp
4502 org-scheduled-regexp
4504 org-scheduled-time-regexp
4506 org-closed-time-regexp
4508 org-keyword-time-regexp
4514 org-keyword-time-not-clock-regexp
4520 org-maybe-keyword-time-regexp
4526 org-planning-or-clock-line-re
4531 org-all-time-keywords
4534 org-clock-string org-closed-string))
4535 )
4540 "Return the contents of FILE, as a string."
4554 "Extract the log state setting from a TODO keyword string.
4568 "Remove a pair of parenthesis at the end of each string in LIST."
4572 x))
4573 list))
4576 "Assign fast keys to a keyword-key alist.
4577 Respect keys that are already there."
4595 ;;; Some variables used in various places
4602 "Function to be called when `C-c C-c' is used.
4606 ;; FIXME: Occasionally check by commenting these, to make sure
4607 ;; no other functions uses these, forgetting to let-bind them.
4612 ;; Defined somewhere in this file, but used before definition.
4618 ;;;; Define the Org-mode
4621 (error "Conflict with outdated version of allout.el. Load org.el before allout.el, or upgrade to newer allout, for example by switching to Emacs 22"))
4624 ;; We use a before-change function to check if a table might need
4625 ;; an update.
4627 "Indicates that a table might need an update.
4628 This variable is set by `org-before-change-function'.
4631 "Every change indicates that a table might need an update."
4642 ;;;###autoload
4644 "Outline-based notes management and organizer, alias
4647 Org-mode develops organizational tasks around a NOTES file which
4648 contains information about projects as plain text. Org-mode is
4649 implemented on top of outline-mode, which is ideal to keep the content
4650 of large files well structured. It supports ToDo items, deadlines and
4651 time stamps, which magically appear in the diary listing of the Emacs
4652 calendar. Tables are easily created with a built-in table editor.
4653 Plain text URL-like links connect to websites, emails (VM), Usenet
4654 messages (Gnus), BBDB entries, and any files related to the project.
4655 For printing and sharing of notes, an Org-mode file (or a part of it)
4656 can be exported as a structured ASCII or HTML file.
4658 The following commands are available:
4662 ;; Get rid of Outline menus, they are not needed
4663 ;; Need to do this here because define-derived-mode sets up
4664 ;; the keymap so late. Still, it is a waste to call this each time
4665 ;; we switch another buffer into org-mode.
4668 ;; Assume this is Greg's port, it uses easymenu
4693 org-display-table 4
4696 org-ellipsis)))
4701 ;; tag faces set outside customize.... force initialization.
4703 ;; Calc embedded
4709 ;; Activate before-change-function
4713 ;; Check for running clock before killing a buffer
4715 ;; Paragraphs and auto-filling
4719 ;; Beginning/end of defun
4722 ;; Make sure dependence stuff works reliably, even for users who set it
4723 ;; too late :-(
4735 ;; Comment characters
4739 ;; Align options lines
4741 'align-mode-rules-list
4746 ;; Imenu
4750 ;; Make isearch reveal context
4753 ;; Emacs 21 and XEmacs make use of the hook
4755 ;; Emacs 22 deals with this through a special variable
4759 ;; Turn on org-beamer-mode?
4762 ;; Setup the pcomplete hooks
4773 ;; If empty file that did not turn on org-mode automatically, make it to.
4798 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4808 "Return today date, considering `org-extend-today-until'."
4813 ;;;; Font-Lock stuff, including the activators
4844 "Regular expression used to analyze links.
4845 Here is what the match groups contain after a match:
4846 1: http:
4847 2: http
4848 3: path
4849 4: [desc]
4857 "Number of stacked braces for sub/superscript matching.
4858 This has to be set before loading org.el to be effective."
4863 "Create a regular expression which will match a balanced sexp.
4864 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4865 as single character strings.
4866 The regexp returned will match the entire expression including the
4867 delimiters. It will also define a single group which contains the
4868 match except for the outermost delimiters. The maximum depth of
4869 stacked delimiters is N. Escaping delimiters is not possible."
4898 "Update the link regular expressions.
4899 This should be called after the variable `org-link-types' has changed."
4903 org-link-re-with-space
4909 org-link-re-with-space2
4915 org-link-re-with-space3
4920 org-angle-link-re
4926 org-plain-link-re
4930 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
4931 org-bracket-link-regexp
4933 org-bracket-link-analytic-regexp
4941 org-bracket-link-analytic-regexp++
4949 org-any-link-re
4960 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4961 "Regular expression matching time strings for analysis.
4962 This one does not require the space after the date, so it can be used
4964 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4980 "Regular expression matching a time stamp or time stamp range.
4986 "Run through the buffer and add overlays to links."
4995 'face
5008 rtn))
5011 "Insert or change an emphasis, i.e. a font like bold or italic.
5012 If there is an active region, change that region to a new emphasis.
5013 If there is no region, just insert the marker characters and position
5014 the cursor between them.
5015 CHAR should be either the marker character, or the first character of the
5016 HTML tag associated with that emphasis. If CHAR is a space, the means
5017 to remove the emphasis of the selected region.
5018 If char is not given (for example in an interactive call) it
5019 will be prompted for."
5070 "Run through the buffer and add overlays to links."
5079 nil
5085 t)))))
5093 t)))
5096 "When non-nil, fontify code in code blocks."
5102 "Fontify #+ lines and blocks, in the correct ways."
5105 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5106 limit t)
5114 end end1 quoting block-type)
5117 ;; a single line of backend-specific content
5125 ; for backend-specific code
5126 t)
5128 ;; Truly a block
5140 beg end
5144 ; for end_src
5150 org-block)))
5151 ; end of source block
5157 t))
5170 ;; just any other in-buffer setting, but not indented
5174 t)
5182 t)
5190 "Run through the buffer and add overlays to links."
5198 t)))
5201 "Run through the buffer and add overlays to links."
5203 limit t)
5208 'keymap org-mouse-map
5209 'help-echo
5211 "Footnote definition"
5213 ))
5215 t)))
5218 "Run through the buffer and add overlays to bracketed links."
5222 ;; FIXME: above we should remove the escapes.
5223 ;; but that requires another match, protecting match data,
5224 ;; a lot of overhead for font-lock.
5231 ;; We need to remove the invisible property here. Table narrowing
5232 ;; may have made some of this invisible.
5250 t)))
5253 "Run through the buffer and add overlays to dates."
5265 t)))
5274 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5278 "Run through the buffer and add overlays to target matches."
5286 'keymap org-mouse-map
5290 t)))))
5293 "Find all radio targets in this file and update the regular expression."
5308 t)))
5315 ;; This should be with the exporter code, but we also use if for font-locking
5325 "Compute regular expression for stuff treated specially by exporters."
5332 org-latex-regexps)))
5360 org-entities)))
5364 org-latex-entities)
5365 nil))
5367 ))
5368 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5371 org-export-html-special-string-regexps)))
5376 ))))
5378 'org-latex-and-specials-regexp
5383 "Run through the buffer and add overlays to links."
5387 limit t))
5401 rtn)))
5404 "Restart `font-lock-mode', to force refontification."
5410 "Return a list of all targets in this file.
5411 With optional argument RADIO, only find radio targets."
5413 rtn)
5418 rtn)))
5421 "Make regular expression matching all strings in TARGETS.
5422 The regular expression finds the targets also if there is a line break
5423 between words."
5432 x)
5433 targets
5445 t)))
5448 "Compute the outline level of the heading at point.
5449 This function assumes that the cursor is at the beginning of a line matched
5450 by `outline-regexp'. Otherwise it returns garbage.
5451 If this is called at a normal headline, the level is the number of stars.
5452 Use `org-reduced-level' to remove the effect of `org-odd-levels'.
5453 For plain list items, if they are matched by `outline-regexp', this returns
5454 1000 plus the line indentation."
5463 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5470 "Functions that can manipulate `org-font-lock-extra-keywords'.
5471 This is calles after `org-font-lock-extra-keywords' is defined, but before
5472 it is installed to be used by font lock. This can be useful if something
5483 ;; Call the hook
5485 ;; Headlines
5492 ;; Table lines
5495 ;; Table internals
5500 ;; Drawers
5503 ;; Properties
5507 ;; Links
5518 ;; TODO lines
5521 ;; DONE
5527 nil)
5528 ;; Priorities
5530 ;; Tags
5532 ;; Special keywords
5537 ;; Emphasis
5542 ;; Checkboxes
5543 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5548 ;; Description list items
5551 ;; ARCHIVEd headings
5554 ;; Specials
5558 ;; Code
5560 ;; COMMENT
5565 ;; Blocks and meta lines
5567 )))
5570 ;; Now set the full font-lock-keywords
5577 "Toggle the composition display of entities as UTF8 characters."
5589 "Find an entity to fontify."
5595 limit t)
5607 nil))))
5610 "Fontify string S like in Org-mode."
5622 "Get the right face for match N in font-lock matching of headlines."
5635 "Get the right face for a TODO keyword KWD.
5636 If KWD is a number, get the corresponding match group."
5644 "Create a face list that inherits INHERIT, but sets the foreground color.
5645 When FACE-OR-COLOR is not a string, just return it."
5649 face-or-color)
5650 face-or-color))
5653 "Add the special tag faces."
5662 "Add the special priority faces."
5669 org-priority-faces)))
5674 "Get the right face for a TODO keyword KWD.
5675 If KWD is a number, get the corresponding match group."
5682 "Remove fontification and activation overlays from links."
5687 deactivate-mark buffer-file-name buffer-file-truename)
5690 beg end
5692 ;; also remove line-prefix and wrap-prefix properties
5694 invisible t intangible t
5695 line-prefix t wrap-prefix t
5696 org-no-flyspell t org-emphasis t)
5698 invisible t intangible t
5699 org-no-flyspell t org-emphasis t)))
5709 "Remove specific display properties that have been added by font lock.
5710 The will remove the raise properties that are used to show superscripts
5711 and subscripts."
5721 "Add raise properties to sub/superscripts."
5725 org-match-substring-regexp
5726 org-match-substring-with-braces-regexp)
5727 limit t)
5737 ;; FIXME: Should we go back one character here, for a_b^c
5738 ;; (goto-char (1- pos)) ;????????????????????
5740 t
5742 'display
5758 t)))))
5760 ;;;; Visibility cycling, including org-goto and indirect buffer
5762 ;;; Cycling
5769 ;;;###autoload
5774 "TAB-action and visibility cycling for Org-mode.
5776 This is the command invoked in Org-mode by the TAB key. Its main purpose
5777 is outline visibility cycling, but it also invokes other actions
5778 in special contexts.
5780 - When this function is called with a prefix argument, rotate the entire
5781 buffer through 3 states (global cycling)
5782 1. OVERVIEW: Show only top-level headlines.
5783 2. CONTENTS: Show all headlines of all levels, but no body text.
5784 3. SHOW ALL: Show everything.
5785 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5786 determined by the variable `org-startup-folded', and by any VISIBILITY
5787 properties in the buffer.
5788 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5789 including any drawers.
5791 - When inside a table, re-align the table and move to the next field.
5793 - When point is at the beginning of a headline, rotate the subtree started
5794 by this line through 3 different states (local cycling)
5795 1. FOLDED: Only the main headline is shown.
5796 2. CHILDREN: The main headline and the direct children are shown.
5797 From this state, you can move to one of the children
5798 and zoom in further.
5799 3. SUBTREE: Show the entire subtree, including body text.
5800 If there is no subtree, switch directly from CHILDREN to FOLDED.
5802 - When point is at the beginning of an empty headline and the variable
5803 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5804 of the headline by demoting and promoting it to likely levels. This
5805 speeds up creation document structure by pressing TAB once or several
5806 times right after creating a new headline.
5808 - When there is a numeric prefix, go up to a heading with level ARG, do
5809 a `show-subtree' and return to the previous cursor position. If ARG
5810 is negative, go up that many levels.
5812 - When point is not at the beginning of a headline, execute the global
5813 binding for TAB, which is re-indenting the line. See the option
5814 `org-cycle-emulate-tab' for details.
5816 - Special case: if point is at the beginning of the buffer and there is
5817 no headline in line 1, this function will act as if called with prefix arg
5818 (C-u TAB, same as S-TAB) also when called without prefix arg.
5819 But only if also the variable `org-cycle-global-at-bob' is t."
5829 org-inlinetask-min-level
5834 limit-level)))
5850 org-cycle-hook))
5854 ;; special case: use global cycling
5869 ;; Enter the table or move to the next field in the table
5886 ;; Toggle block visibility
5891 ;; Show-subtree, ARG levels up from here.
5903 ;; TAB emulation and template completion
5927 t
5936 "Do the global cycling action."
5940 ;; We just created the overview - now do table of contents
5941 ;; This can be slow in very large buffers, so indicate action
5951 ;; We just showed the table of contents - now show everything
5959 ;; Default action: go to overview
5967 "Do the local cycling action."
5969 ;; First, some boundaries
5976 ; XEmacs does not have `next-single-char-property-change'
5977 ; I'm not sure about Emacs 21.
5991 ;; if we're in a list, org-end-of-subtree is in fact org-end-of-item.
6000 ;; Find out what to do next and set `this-command'
6003 ;; Nothing is hidden behind this heading
6015 org-cycle-skip-children-state-if-no-children))))
6016 ;; Entire subtree is hidden in one line: children view
6030 ;; We just showed the children, or no children are there,
6031 ;; now show everything.
6038 ;; Default action: hide the subtree.
6045 ;;;###autoload
6047 "Cycle the global visibility. For details see `org-cycle'.
6049 With a numeric prefix, show all headlines up to that level."
6065 "Set the visibility required by startup options and properties."
6080 "Switch subtree visibilities according to :VISIBILITY: property."
6087 nil t)
6112 "Switch to overview mode, showing only top-level headlines.
6113 Really, this shows all headlines with level equal or greater than the level
6114 of the first headline in the buffer. This is important, because if the
6115 first headline is not level one, then (hide-sublevels 1) gives confusing
6116 results."
6127 "Show all headlines in the buffer, like a table of contents.
6128 With numerical argument N, show content up to level N."
6131 ;; Visit all headings and show their offspring
6138 t)
6147 "Adjust the window after a change in outline visibility.
6148 This function is the default value of the hook `org-cycle-hook'."
6158 "Remove outline overlays that do not contain non-white stuff."
6168 "Fix visibility issues after moving a subtree."
6169 ;; First, find a reasonable region to look at:
6170 ;; Start two siblings above, end three below
6188 ;; Properly fold already folded siblings
6199 "Show empty lines above all visible headlines.
6200 The region to be covered depends on STATE when called through
6201 `org-cycle-hook'. Lisp program can use t for STATE to get the
6202 entire buffer covered. Note that an empty line is only shown if there
6203 are at least `org-cycle-separator-lines' empty lines before the headline."
6213 beg end b e)
6237 ;; Never hide empty lines at the end of the file.
6247 "Move to the parent and re-show empty lines before visible headlines."
6253 "Return `org-agenda-files' list, plus all open org-mode files.
6254 This is useful for operations that need to scan all of a user's
6255 open and agenda-wise Org files."
6263 files))
6266 "Return the beginning position of the current entry."
6270 "Return the end position of the current entry."
6274 "Re-hide all drawers after a visibility state change."
6301 "Is the end of the current subtree visible?"
6306 "Move cursor to the first headline and recenter the headline.
6307 Optional argument N means put the headline into the Nth line of the window."
6313 ;;; Saving and restoring visibility
6316 "Return a list of the locations of all outline overlays.
6317 These are overlays with the `invisible' property value `outline'.
6318 The return value is a list of cons cells, with start and stop
6319 positions for each overlay.
6320 If USE-MARKERS is set, return the positions as markers."
6338 "Create visibility overlays for all positions in DATA.
6339 DATA should have been made by `org-outline-overlay-data'."
6348 data)))))
6350 ;;; Folding of blocks
6362 "Call FUNCTION at the head of all source blocks in the current buffer.
6363 Optional arguments START and END can be used to limit the range."
6375 "Toggle the visibility of all blocks in the current buffer."
6379 "Fold all blocks in the current buffer."
6385 "Unfold all blocks in the current buffer."
6391 "Toggle visibility of block at point."
6402 "Toggle the visibility of the current block."
6409 ov)
6425 ;; make the block accessible to isearch
6427 ov 'isearch-open-invisible
6438 ;; org-tab-after-check-for-cycling-hook
6440 ;; Remove overlays when changing major mode
6445 ;;; Org-goto
6451 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6467 nil)
6468 (org-defkey map "q" 'org-goto-quit)
6469 (org-defkey map "n" 'outline-next-visible-heading)
6470 (org-defkey map "p" 'outline-previous-visible-heading)
6471 (org-defkey map "f" 'outline-forward-same-level)
6472 (org-defkey map "b" 'outline-backward-same-level)
6473 (org-defkey map "u" 'outline-up-heading))
6474 (org-defkey map "/" 'org-occur)
6475 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6476 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6477 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6478 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6479 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6480 map))
6482 (defconst org-goto-help
6483 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6484 RET=jump to location [Q]uit and return to previous location
6485 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6487 (defvar org-goto-start-pos) ; dynamically scoped parameter
6489 ;; FIXME: Docstring does not mention both interfaces
6490 (defun org-goto (&optional alternative-interface)
6491 "Look up a different location in the current file, keeping current visibility.
6493 When you want look-up or go to a different location in a document, the
6494 fastest way is often to fold the entire buffer and then dive into the tree.
6495 This method has the disadvantage, that the previous location will be folded,
6496 which may not be what you want.
6498 This command works around this by showing a copy of the current buffer
6499 in an indirect buffer, in overview mode. You can dive into the tree in
6500 that copy, use org-occur and incremental search to find a location.
6501 When pressing RET or `Q', the command returns to the original buffer in
6502 which the visibility is still unchanged. After RET is will also jump to
6503 the location selected in the indirect buffer and expose the
6504 the headline hierarchy above."
6505 (interactive "P")
6506 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6507 (org-refile-use-outline-path t)
6508 (org-refile-target-verify-function nil)
6509 (interface
6510 (if (not alternative-interface)
6511 org-goto-interface
6512 (if (eq org-goto-interface 'outline)
6513 'outline-path-completion
6514 'outline)))
6515 (org-goto-start-pos (point))
6516 (selected-point
6517 (if (eq interface 'outline)
6518 (car (org-get-location (current-buffer) org-goto-help))
6519 (let ((pa (org-refile-get-location "Goto: ")))
6520 (org-refile-check-position pa)
6521 (nth 3 pa)))))
6522 (if selected-point
6523 (progn
6524 (org-mark-ring-push org-goto-start-pos)
6525 (goto-char selected-point)
6526 (if (or (org-invisible-p) (org-invisible-p2))
6527 (org-show-context 'org-goto)))
6528 (message "Quit"))))
6530 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6531 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6532 (defvar org-goto-local-auto-isearch-map) ; defined below
6534 (defun org-get-location (buf help)
6535 "Let the user select a location in the Org-mode buffer BUF.
6536 This function uses a recursive edit. It returns the selected position
6537 or nil."
6538 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6539 (isearch-hide-immediately nil)
6540 (isearch-search-fun-function
6541 (lambda () 'org-goto-local-search-headings))
6542 (org-goto-selected-point org-goto-exit-command)
6543 (pop-up-frames nil)
6544 (special-display-buffer-names nil)
6545 (special-display-regexps nil)
6546 (special-display-function nil))
6547 (save-excursion
6548 (save-window-excursion
6549 (delete-other-windows)
6550 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6551 (switch-to-buffer
6552 (condition-case nil
6553 (make-indirect-buffer (current-buffer) "*org-goto*")
6554 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6555 (with-output-to-temp-buffer "*Help*"
6556 (princ help))
6557 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6558 (setq buffer-read-only nil)
6559 (let ((org-startup-truncated t)
6560 (org-startup-folded nil)
6561 (org-startup-align-all-tables nil))
6562 (org-mode)
6563 (org-overview))
6564 (setq buffer-read-only t)
6565 (if (and (boundp 'org-goto-start-pos)
6566 (integer-or-marker-p org-goto-start-pos))
6567 (let ((org-show-hierarchy-above t)
6568 (org-show-siblings t)
6569 (org-show-following-heading t))
6570 (goto-char org-goto-start-pos)
6571 (and (org-invisible-p) (org-show-context)))
6572 (goto-char (point-min)))
6573 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6574 (message "Select location and press RET")
6575 (use-local-map org-goto-map)
6576 (recursive-edit)
6577 ))
6578 (kill-buffer "*org-goto*")
6579 (cons org-goto-selected-point org-goto-exit-command)))
6581 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6582 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6583 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6584 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6586 (defun org-goto-local-search-headings (string bound noerror)
6587 "Search and make sure that any matches are in headlines."
6588 (catch 'return
6589 (while (if isearch-forward
6590 (search-forward string bound noerror)
6591 (search-backward string bound noerror))
6592 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6593 (and (member :headline context)
6594 (not (member :tags context))))
6595 (throw 'return (point))))))
6597 (defun org-goto-local-auto-isearch ()
6598 "Start isearch."
6599 (interactive)
6600 (goto-char (point-min))
6601 (let ((keys (this-command-keys)))
6602 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6603 (isearch-mode t)
6604 (isearch-process-search-char (string-to-char keys)))))
6606 (defun org-goto-ret (&optional arg)
6607 "Finish `org-goto' by going to the new location."
6608 (interactive "P")
6609 (setq org-goto-selected-point (point)
6610 org-goto-exit-command 'return)
6611 (throw 'exit nil))
6613 (defun org-goto-left ()
6614 "Finish `org-goto' by going to the new location."
6615 (interactive)
6616 (if (org-on-heading-p)
6617 (progn
6618 (beginning-of-line 1)
6619 (setq org-goto-selected-point (point)
6620 org-goto-exit-command 'left)
6621 (throw 'exit nil))
6622 (error "Not on a heading")))
6624 (defun org-goto-right ()
6625 "Finish `org-goto' by going to the new location."
6626 (interactive)
6627 (if (org-on-heading-p)
6628 (progn
6629 (setq org-goto-selected-point (point)
6630 org-goto-exit-command 'right)
6631 (throw 'exit nil))
6632 (error "Not on a heading")))
6634 (defun org-goto-quit ()
6635 "Finish `org-goto' without cursor motion."
6636 (interactive)
6637 (setq org-goto-selected-point nil)
6638 (setq org-goto-exit-command 'quit)
6639 (throw 'exit nil))
6641 ;;; Indirect buffer display of subtrees
6643 (defvar org-indirect-dedicated-frame nil
6644 "This is the frame being used for indirect tree display.")
6645 (defvar org-last-indirect-buffer nil)
6647 (defun org-tree-to-indirect-buffer (&optional arg)
6648 "Create indirect buffer and narrow it to current subtree.
6649 With numerical prefix ARG, go up to this level and then take that tree.
6650 If ARG is negative, go up that many levels.
6651 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6652 indirect buffer previously made with this command, to avoid proliferation of
6653 indirect buffers. However, when you call the command with a \
6655 when `org-indirect-buffer-display' is `new-frame', the last buffer
6656 is kept so that you can work with several indirect buffers at the same time.
6657 If `org-indirect-buffer-display' is `dedicated-frame', the \
6659 requests that a new frame be made for the new buffer, so that the dedicated
6660 frame is not changed."
6661 (interactive "P")
6662 (let ((cbuf (current-buffer))
6663 (cwin (selected-window))
6664 (pos (point))
6665 beg end level heading ibuf)
6666 (save-excursion
6667 (org-back-to-heading t)
6668 (when (numberp arg)
6669 (setq level (org-outline-level))
6670 (if (< arg 0) (setq arg (+ level arg)))
6671 (while (> (setq level (org-outline-level)) arg)
6672 (outline-up-heading 1 t)))
6673 (setq beg (point)
6674 heading (org-get-heading))
6675 (org-end-of-subtree t t)
6676 (if (org-on-heading-p) (backward-char 1))
6677 (setq end (point)))
6678 (if (and (buffer-live-p org-last-indirect-buffer)
6679 (not (eq org-indirect-buffer-display 'new-frame))
6680 (not arg))
6681 (kill-buffer org-last-indirect-buffer))
6682 (setq ibuf (org-get-indirect-buffer cbuf)
6683 org-last-indirect-buffer ibuf)
6684 (cond
6685 ((or (eq org-indirect-buffer-display 'new-frame)
6686 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6687 (select-frame (make-frame))
6688 (delete-other-windows)
6689 (switch-to-buffer ibuf)
6690 (org-set-frame-title heading))
6691 ((eq org-indirect-buffer-display 'dedicated-frame)
6692 (raise-frame
6693 (select-frame (or (and org-indirect-dedicated-frame
6694 (frame-live-p org-indirect-dedicated-frame)
6695 org-indirect-dedicated-frame)
6696 (setq org-indirect-dedicated-frame (make-frame)))))
6697 (delete-other-windows)
6698 (switch-to-buffer ibuf)
6699 (org-set-frame-title (concat "Indirect: " heading)))
6700 ((eq org-indirect-buffer-display 'current-window)
6701 (switch-to-buffer ibuf))
6702 ((eq org-indirect-buffer-display 'other-window)
6703 (pop-to-buffer ibuf))
6704 (t (error "Invalid value")))
6705 (if (featurep 'xemacs)
6706 (save-excursion (org-mode) (turn-on-font-lock)))
6707 (narrow-to-region beg end)
6708 (show-all)
6709 (goto-char pos)
6710 (and (window-live-p cwin) (select-window cwin))))
6712 (defun org-get-indirect-buffer (&optional buffer)
6713 (setq buffer (or buffer (current-buffer)))
6714 (let ((n 1) (base (buffer-name buffer)) bname)
6715 (while (buffer-live-p
6716 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6717 (setq n (1+ n)))
6718 (condition-case nil
6719 (make-indirect-buffer buffer bname 'clone)
6720 (error (make-indirect-buffer buffer bname)))))
6722 (defun org-set-frame-title (title)
6723 "Set the title of the current frame to the string TITLE."
6724 ;; FIXME: how to name a single frame in XEmacs???
6725 (unless (featurep 'xemacs)
6726 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6728 ;;;; Structure editing
6730 ;;; Inserting headlines
6732 (defun org-previous-line-empty-p ()
6733 (save-excursion
6734 (and (not (bobp))
6735 (or (beginning-of-line 0) t)
6736 (save-match-data
6739 (defun org-insert-heading (&optional force-heading invisible-ok)
6740 "Insert a new heading or item with same depth at point.
6741 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6742 If point is at the beginning of a headline, insert a sibling before the
6743 current headline. If point is not at the beginning, split the line,
6744 create the new headline with the text in the current line after point
6745 \(but see also the variable `org-M-RET-may-split-line').
6747 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6748 This is important for non-interactive uses of the command."
6749 (interactive "P")
6750 (if (or (= (buffer-size) 0)
6751 (and (not (save-excursion
6752 (and (ignore-errors (org-back-to-heading invisible-ok))
6753 (org-on-heading-p))))
6754 (not (org-in-item-p))))
6755 (progn
6757 (run-hooks 'org-insert-heading-hook))
6758 (when (or force-heading (not (org-insert-item)))
6759 (let* ((empty-line-p nil)
6760 (level nil)
6761 (on-heading (org-on-heading-p))
6762 (head (save-excursion
6763 (condition-case nil
6764 (progn
6765 (org-back-to-heading invisible-ok)
6766 (when (and (not on-heading)
6767 (featurep 'org-inlinetask)
6768 (integerp org-inlinetask-min-level)
6769 (>= (length (match-string 0))
6770 org-inlinetask-min-level))
6771 ;; Find a heading level before the inline task
6772 (while (and (setq level (org-up-heading-safe))
6773 (>= level org-inlinetask-min-level)))
6774 (if (org-on-heading-p)
6775 (org-back-to-heading invisible-ok)
6776 (error "This should not happen")))
6777 (setq empty-line-p (org-previous-line-empty-p))
6778 (match-string 0))
6779 (error "*"))))
6780 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6781 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6782 pos hide-previous previous-pos)
6783 (cond
6784 ((and (org-on-heading-p) (bolp)
6785 (or (bobp)
6786 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6787 ;; insert before the current line
6788 (open-line (if blank 2 1)))
6789 ((and (bolp)
6790 (not org-insert-heading-respect-content)
6791 (or (bobp)
6792 (save-excursion
6793 (backward-char 1) (not (org-invisible-p)))))
6794 ;; insert right here
6795 nil)
6796 (t
6797 ;; somewhere in the line
6798 (save-excursion
6799 (setq previous-pos (point-at-bol))
6800 (end-of-line)
6801 (setq hide-previous (org-invisible-p)))
6802 (and org-insert-heading-respect-content (org-show-subtree))
6803 (let ((split
6804 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6805 (save-excursion
6806 (let ((p (point)))
6807 (goto-char (point-at-bol))
6808 (and (looking-at org-complex-heading-regexp)
6809 (> p (match-beginning 4)))))))
6810 tags pos)
6811 (cond
6812 (org-insert-heading-respect-content
6813 (org-end-of-subtree nil t)
6814 (when (featurep 'org-inlinetask)
6815 (while (and (not (eobp))
6817 (>= (length (match-string 1))
6818 org-inlinetask-min-level))
6819 (org-end-of-subtree nil t)))
6820 (or (bolp) (newline))
6821 (or (org-previous-line-empty-p)
6822 (and blank (newline)))
6823 (open-line 1))
6824 ((org-on-heading-p)
6825 (when hide-previous
6826 (show-children)
6827 (org-show-entry))
6829 (setq tags (and (match-end 2) (match-string 2)))
6830 (and (match-end 1)
6831 (delete-region (match-beginning 1) (match-end 1)))
6832 (setq pos (point-at-bol))
6833 (or split (end-of-line 1))
6834 (delete-horizontal-space)
6836 (buffer-substring (point-at-bol) (point)))
6837 (insert " "))
6838 (newline (if blank 2 1))
6839 (when tags
6840 (save-excursion
6841 (goto-char pos)
6842 (end-of-line 1)
6843 (insert " " tags)
6844 (org-set-tags nil 'align))))
6845 (t
6846 (or split (end-of-line 1))
6847 (newline (if blank 2 1)))))))
6848 (insert head) (just-one-space)
6849 (setq pos (point))
6850 (end-of-line 1)
6851 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6852 (when (and org-insert-heading-respect-content hide-previous)
6853 (save-excursion
6854 (goto-char previous-pos)
6855 (hide-subtree)))
6856 (run-hooks 'org-insert-heading-hook)))))
6858 (defun org-get-heading (&optional no-tags)
6859 "Return the heading of the current entry, without the stars."
6860 (save-excursion
6861 (org-back-to-heading t)
6862 (if (looking-at
6863 (if no-tags
6866 (match-string 1) "")))
6868 (defun org-heading-components ()
6869 "Return the components of the current heading.
6870 This is a list with the following elements:
6871 - the level as an integer
6872 - the reduced level, different if `org-odd-levels-only' is set.
6873 - the TODO keyword, or nil
6874 - the priority character, like ?A, or nil if no priority is given
6875 - the headline text itself, or the tags string if no headline text
6876 - the tags string, or nil."
6877 (save-excursion
6878 (org-back-to-heading t)
6879 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6880 (list (length (match-string 1))
6881 (org-reduced-level (length (match-string 1)))
6882 (org-match-string-no-properties 2)
6883 (and (match-end 3) (aref (match-string 3) 2))
6884 (org-match-string-no-properties 4)
6885 (org-match-string-no-properties 5)))))
6887 (defun org-get-entry ()
6888 "Get the entry text, after heading, entire subtree."
6889 (save-excursion
6890 (org-back-to-heading t)
6891 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6893 (defun org-insert-heading-after-current ()
6894 "Insert a new heading with same level as current, after current subtree."
6895 (interactive)
6896 (org-back-to-heading)
6897 (org-insert-heading)
6898 (org-move-subtree-down)
6899 (end-of-line 1))
6901 (defun org-insert-heading-respect-content ()
6902 (interactive)
6903 (let ((org-insert-heading-respect-content t))
6904 (org-insert-heading t)))
6906 (defun org-insert-todo-heading-respect-content (&optional force-state)
6907 (interactive "P")
6908 (let ((org-insert-heading-respect-content t))
6909 (org-insert-todo-heading force-state t)))
6911 (defun org-insert-todo-heading (arg &optional force-heading)
6912 "Insert a new heading with the same level and TODO state as current heading.
6913 If the heading has no TODO state, or if the state is DONE, use the first
6914 state (TODO by default). Also with prefix arg, force first state."
6915 (interactive "P")
6916 (when (or force-heading (not (org-insert-item 'checkbox)))
6917 (org-insert-heading force-heading)
6918 (save-excursion
6919 (org-back-to-heading)
6920 (outline-previous-heading)
6921 (looking-at org-todo-line-regexp))
6922 (let*
6923 ((new-mark-x
6924 (if (or arg
6925 (not (match-beginning 2))
6926 (member (match-string 2) org-done-keywords))
6927 (car org-todo-keywords-1)
6928 (match-string 2)))
6929 (new-mark
6930 (or
6931 (run-hook-with-args-until-success
6932 'org-todo-get-default-hook new-mark-x nil)
6933 new-mark-x)))
6934 (beginning-of-line 1)
6936 (if org-treat-insert-todo-heading-as-state-change
6937 (org-todo new-mark)
6938 (insert new-mark " "))))
6939 (when org-provide-todo-statistics
6940 (org-update-parent-todo-statistics))))
6942 (defun org-insert-subheading (arg)
6943 "Insert a new subheading and demote it.
6944 Works for outline headings and for plain lists alike."
6945 (interactive "P")
6946 (org-insert-heading arg)
6947 (cond
6948 ((org-on-heading-p) (org-do-demote))
6949 ((org-at-item-p) (org-indent-item))))
6951 (defun org-insert-todo-subheading (arg)
6952 "Insert a new subheading with TODO keyword or checkbox and demote it.
6953 Works for outline headings and for plain lists alike."
6954 (interactive "P")
6955 (org-insert-todo-heading arg)
6956 (cond
6957 ((org-on-heading-p) (org-do-demote))
6958 ((org-at-item-p) (org-indent-item))))
6960 ;;; Promotion and Demotion
6962 (defvar org-after-demote-entry-hook nil
6963 "Hook run after an entry has been demoted.
6964 The cursor will be at the beginning of the entry.
6965 When a subtree is being demoted, the hook will be called for each node.")
6967 (defvar org-after-promote-entry-hook nil
6968 "Hook run after an entry has been promoted.
6969 The cursor will be at the beginning of the entry.
6970 When a subtree is being promoted, the hook will be called for each node.")
6972 (defun org-promote-subtree ()
6973 "Promote the entire subtree.
6974 See also `org-promote'."
6975 (interactive)
6976 (save-excursion
6977 (org-map-tree 'org-promote))
6978 (org-fix-position-after-promote))
6980 (defun org-demote-subtree ()
6981 "Demote the entire subtree. See `org-demote'.
6982 See also `org-promote'."
6983 (interactive)
6984 (save-excursion
6985 (org-map-tree 'org-demote))
6986 (org-fix-position-after-promote))
6989 (defun org-do-promote ()
6990 "Promote the current heading higher up the tree.
6991 If the region is active in `transient-mark-mode', promote all headings
6992 in the region."
6993 (interactive)
6994 (save-excursion
6995 (if (org-region-active-p)
6996 (org-map-region 'org-promote (region-beginning) (region-end))
6997 (org-promote)))
6998 (org-fix-position-after-promote))
7000 (defun org-do-demote ()
7001 "Demote the current heading lower down the tree.
7002 If the region is active in `transient-mark-mode', demote all headings
7003 in the region."
7004 (interactive)
7005 (save-excursion
7006 (if (org-region-active-p)
7007 (org-map-region 'org-demote (region-beginning) (region-end))
7008 (org-demote)))
7009 (org-fix-position-after-promote))
7011 (defun org-fix-position-after-promote ()
7012 "Make sure that after pro/demotion cursor position is right."
7013 (let ((pos (point)))
7014 (when (save-excursion
7015 (beginning-of-line 1)
7016 (looking-at org-todo-line-regexp)
7017 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7018 (cond ((eobp) (insert " "))
7019 ((eolp) (insert " "))
7020 ((equal (char-after) ?\ ) (forward-char 1))))))
7022 (defun org-current-level ()
7023 "Return the level of the current entry, or nil if before the first headline.
7024 The level is the number of stars at the beginning of the headline."
7025 (save-excursion
7026 (let ((outline-regexp (org-get-limited-outline-regexp)))
7027 (condition-case nil
7028 (progn
7029 (org-back-to-heading t)
7030 (funcall outline-level))
7031 (error nil)))))
7033 (defun org-get-previous-line-level ()
7034 "Return the outline depth of the last headline before the current line.
7035 Returns 0 for the first headline in the buffer, and nil if before the
7036 first headline."
7037 (let ((current-level (org-current-level))
7038 (prev-level (when (> (line-number-at-pos) 1)
7039 (save-excursion
7040 (beginning-of-line 0)
7041 (org-current-level)))))
7042 (cond ((null current-level) nil) ; Before first headline
7043 ((null prev-level) 0) ; At first headline
7044 (prev-level))))
7046 (defun org-reduced-level (l)
7047 "Compute the effective level of a heading.
7048 This takes into account the setting of `org-odd-levels-only'."
7049 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
7051 (defun org-level-increment ()
7052 "Return the number of stars that will be added or removed at a
7053 time to headlines when structure editing, based on the value of
7054 `org-odd-levels-only'."
7055 (if org-odd-levels-only 2 1))
7057 (defun org-get-valid-level (level &optional change)
7058 "Rectify a level change under the influence of `org-odd-levels-only'
7059 LEVEL is a current level, CHANGE is by how much the level should be
7060 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7061 even level numbers will become the next higher odd number."
7062 (if org-odd-levels-only
7063 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7064 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7065 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7066 (max 1 (+ level (or change 0)))))
7068 (if (boundp 'define-obsolete-function-alias)
7069 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7070 (define-obsolete-function-alias 'org-get-legal-level
7071 'org-get-valid-level)
7072 (define-obsolete-function-alias 'org-get-legal-level
7073 'org-get-valid-level "23.1")))
7075 (defun org-promote ()
7076 "Promote the current heading higher up the tree.
7077 If the region is active in `transient-mark-mode', promote all headings
7078 in the region."
7079 (org-back-to-heading t)
7080 (let* ((level (save-match-data (funcall outline-level)))
7081 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7082 (diff (abs (- level (length up-head) -1))))
7083 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7084 (replace-match up-head nil t)
7085 ;; Fixup tag positioning
7086 (and org-auto-align-tags (org-set-tags nil t))
7087 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7088 (run-hooks 'org-after-promote-entry-hook)))
7090 (defun org-demote ()
7091 "Demote the current heading lower down the tree.
7092 If the region is active in `transient-mark-mode', demote all headings
7093 in the region."
7094 (org-back-to-heading t)
7095 (let* ((level (save-match-data (funcall outline-level)))
7096 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7097 (diff (abs (- level (length down-head) -1))))
7098 (replace-match down-head nil t)
7099 ;; Fixup tag positioning
7100 (and org-auto-align-tags (org-set-tags nil t))
7101 (if org-adapt-indentation (org-fixup-indentation diff))
7102 (run-hooks 'org-after-demote-entry-hook)))
7104 (defun org-cycle-level ()
7105 "Cycle the level of an empty headline through possible states.
7106 This goes first to child, then to parent, level, then up the hierarchy.
7107 After top level, it switches back to sibling level."
7108 (interactive)
7109 (let ((org-adapt-indentation nil))
7110 (when (org-point-at-end-of-empty-headline)
7111 (setq this-command 'org-cycle-level) ; Only needed for caching
7112 (let ((cur-level (org-current-level))
7113 (prev-level (org-get-previous-line-level)))
7114 (cond
7115 ;; If first headline in file, promote to top-level.
7116 ((= prev-level 0)
7117 (loop repeat (/ (- cur-level 1) (org-level-increment))
7118 do (org-do-promote)))
7119 ;; If same level as prev, demote one.
7120 ((= prev-level cur-level)
7121 (org-do-demote))
7122 ;; If parent is top-level, promote to top level if not already.
7123 ((= prev-level 1)
7124 (loop repeat (/ (- cur-level 1) (org-level-increment))
7125 do (org-do-promote)))
7126 ;; If top-level, return to prev-level.
7127 ((= cur-level 1)
7128 (loop repeat (/ (- prev-level 1) (org-level-increment))
7129 do (org-do-demote)))
7130 ;; If less than prev-level, promote one.
7131 ((< cur-level prev-level)
7132 (org-do-promote))
7133 ;; If deeper than prev-level, promote until higher than
7134 ;; prev-level.
7135 ((> cur-level prev-level)
7136 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7137 do (org-do-promote))))
7138 t))))
7140 (defun org-map-tree (fun)
7141 "Call FUN for every heading underneath the current one."
7142 (org-back-to-heading)
7143 (let ((level (funcall outline-level)))
7144 (save-excursion
7145 (funcall fun)
7146 (while (and (progn
7147 (outline-next-heading)
7148 (> (funcall outline-level) level))
7149 (not (eobp)))
7150 (funcall fun)))))
7152 (defun org-map-region (fun beg end)
7153 "Call FUN for every heading between BEG and END."
7154 (let ((org-ignore-region t))
7155 (save-excursion
7156 (setq end (copy-marker end))
7157 (goto-char beg)
7158 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
7159 (< (point) end))
7160 (funcall fun))
7161 (while (and (progn
7162 (outline-next-heading)
7163 (< (point) end))
7164 (not (eobp)))
7165 (funcall fun)))))
7167 (defun org-fixup-indentation (diff)
7168 "Change the indentation in the current entry by DIFF.
7169 However, if any line in the current entry has no indentation, or if it
7170 would end up with no indentation after the change, nothing at all is done."
7171 (save-excursion
7172 (let ((end (save-excursion (outline-next-heading)
7173 (point-marker)))
7174 (prohibit (if (> diff 0)
7177 col)
7178 (unless (save-excursion (end-of-line 1)
7179 (re-search-forward prohibit end t))
7180 (while (and (< (point) end)
7182 (goto-char (match-end 0))
7183 (setq col (current-column))
7184 (if (< diff 0) (replace-match ""))
7185 (org-indent-to-column (+ diff col))))
7186 (move-marker end nil))))
7188 (defun org-convert-to-odd-levels ()
7189 "Convert an org-mode file with all levels allowed to one with odd levels.
7190 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7191 level 5 etc."
7192 (interactive)
7193 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7194 (let ((outline-regexp org-outline-regexp)
7195 (outline-level 'org-outline-level)
7196 (org-odd-levels-only nil) n)
7197 (save-excursion
7198 (goto-char (point-min))
7200 (setq n (- (length (match-string 0)) 2))
7201 (while (>= (setq n (1- n)) 0)
7202 (org-demote))
7203 (end-of-line 1))))))
7205 (defun org-convert-to-oddeven-levels ()
7206 "Convert an org-mode file with only odd levels to one with odd/even levels.
7207 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7208 file contains a section with an even level, conversion would
7209 destroy the structure of the file. An error is signaled in this
7210 case."
7211 (interactive)
7212 (goto-char (point-min))
7213 ;; First check if there are no even levels
7215 (org-show-context t)
7216 (error "Not all levels are odd in this file. Conversion not possible"))
7217 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7218 (let ((outline-regexp org-outline-regexp)
7219 (outline-level 'org-outline-level)
7220 (org-odd-levels-only nil) n)
7221 (save-excursion
7222 (goto-char (point-min))
7224 (setq n (/ (1- (length (match-string 0))) 2))
7225 (while (>= (setq n (1- n)) 0)
7226 (org-promote))
7227 (end-of-line 1))))))
7229 (defun org-tr-level (n)
7230 "Make N odd if required."
7231 (if org-odd-levels-only (1+ (/ n 2)) n))
7233 ;;; Vertical tree motion, cutting and pasting of subtrees
7235 (defun org-move-subtree-up (&optional arg)
7236 "Move the current subtree up past ARG headlines of the same level."
7237 (interactive "p")
7238 (org-move-subtree-down (- (prefix-numeric-value arg))))
7240 (defun org-move-subtree-down (&optional arg)
7241 "Move the current subtree down past ARG headlines of the same level."
7242 (interactive "p")
7243 (setq arg (prefix-numeric-value arg))
7244 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7245 'org-get-last-sibling))
7246 (ins-point (make-marker))
7247 (cnt (abs arg))
7248 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7249 ;; Select the tree
7250 (org-back-to-heading)
7251 (setq beg0 (point))
7252 (save-excursion
7253 (setq ne-beg (org-back-over-empty-lines))
7254 (setq beg (point)))
7255 (save-match-data
7256 (save-excursion (outline-end-of-heading)
7257 (setq folded (org-invisible-p)))
7258 (outline-end-of-subtree))
7259 (outline-next-heading)
7260 (setq ne-end (org-back-over-empty-lines))
7261 (setq end (point))
7262 (goto-char beg0)
7263 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7264 ;; include less whitespace
7265 (save-excursion
7266 (goto-char beg)
7267 (forward-line (- ne-beg ne-end))
7268 (setq beg (point))))
7269 ;; Find insertion point, with error handling
7270 (while (> cnt 0)
7271 (or (and (funcall movfunc) (looking-at outline-regexp))
7272 (progn (goto-char beg0)
7273 (error "Cannot move past superior level or buffer limit")))
7274 (setq cnt (1- cnt)))
7275 (if (> arg 0)
7276 ;; Moving forward - still need to move over subtree
7277 (progn (org-end-of-subtree t t)
7278 (save-excursion
7279 (org-back-over-empty-lines)
7280 (or (bolp) (newline)))))
7281 (setq ne-ins (org-back-over-empty-lines))
7282 (move-marker ins-point (point))
7283 (setq txt (buffer-substring beg end))
7284 (org-save-markers-in-region beg end)
7285 (delete-region beg end)
7286 (org-remove-empty-overlays-at beg)
7287 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7288 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7290 (let ((bbb (point)))
7291 (insert-before-markers txt)
7292 (org-reinstall-markers-in-region bbb)
7293 (move-marker ins-point bbb))
7295 (setq ins-end (point))
7296 (goto-char ins-point)
7297 (org-skip-whitespace)
7298 (when (and (< arg 0)
7299 (org-first-sibling-p)
7300 (> ne-ins ne-beg))
7301 ;; Move whitespace back to beginning
7302 (save-excursion
7303 (goto-char ins-end)
7304 (let ((kill-whole-line t))
7305 (kill-line (- ne-ins ne-beg)) (point)))
7307 (move-marker ins-point nil)
7308 (if folded
7309 (hide-subtree)
7310 (org-show-entry)
7311 (show-children)
7312 (org-cycle-hide-drawers 'children))
7313 (org-clean-visibility-after-subtree-move)))
7315 (defvar org-subtree-clip ""
7316 "Clipboard for cut and paste of subtrees.
7317 This is actually only a copy of the kill, because we use the normal kill
7318 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7320 (defvar org-subtree-clip-folded nil
7321 "Was the last copied subtree folded?
7322 This is used to fold the tree back after pasting.")
7324 (defun org-cut-subtree (&optional n)
7325 "Cut the current subtree into the clipboard.
7326 With prefix arg N, cut this many sequential subtrees.
7327 This is a short-hand for marking the subtree and then cutting it."
7328 (interactive "p")
7329 (org-copy-subtree n 'cut))
7331 (defun org-copy-subtree (&optional n cut force-store-markers)
7332 "Cut the current subtree into the clipboard.
7333 With prefix arg N, cut this many sequential subtrees.
7334 This is a short-hand for marking the subtree and then copying it.
7335 If CUT is non-nil, actually cut the subtree.
7336 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7337 of some markers in the region, even if CUT is non-nil. This is
7338 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7339 (interactive "p")
7340 (let (beg end folded (beg0 (point)))
7341 (if (interactive-p)
7342 (org-back-to-heading nil) ; take what looks like a subtree
7343 (org-back-to-heading t)) ; take what is really there
7344 (org-back-over-empty-lines)
7345 (setq beg (point))
7347 (save-match-data
7348 (save-excursion (outline-end-of-heading)
7349 (setq folded (org-invisible-p)))
7350 (condition-case nil
7351 (org-forward-same-level (1- n) t)
7352 (error nil))
7353 (org-end-of-subtree t t))
7354 (org-back-over-empty-lines)
7355 (setq end (point))
7356 (goto-char beg0)
7357 (when (> end beg)
7358 (setq org-subtree-clip-folded folded)
7359 (when (or cut force-store-markers)
7360 (org-save-markers-in-region beg end))
7361 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7362 (setq org-subtree-clip (current-kill 0))
7363 (message "%s: Subtree(s) with %d characters"
7364 (if cut "Cut" "Copied")
7365 (length org-subtree-clip)))))
7367 (defun org-paste-subtree (&optional level tree for-yank)
7368 "Paste the clipboard as a subtree, with modification of headline level.
7369 The entire subtree is promoted or demoted in order to match a new headline
7370 level.
7372 If the cursor is at the beginning of a headline, the same level as
7373 that headline is used to paste the tree
7375 If not, the new level is derived from the *visible* headings
7376 before and after the insertion point, and taken to be the inferior headline
7377 level of the two. So if the previous visible heading is level 3 and the
7378 next is level 4 (or vice versa), level 4 will be used for insertion.
7379 This makes sure that the subtree remains an independent subtree and does
7380 not swallow low level entries.
7382 You can also force a different level, either by using a numeric prefix
7383 argument, or by inserting the heading marker by hand. For example, if the
7386 If optional TREE is given, use this text instead of the kill ring.
7388 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7389 move back over whitespace before inserting, and move point to the end of
7390 the inserted text when done."
7391 (interactive "P")
7392 (setq tree (or tree (and kill-ring (current-kill 0))))
7393 (unless (org-kill-is-subtree-p tree)
7394 (error "%s"
7395 (substitute-command-keys
7397 (let* ((visp (not (org-invisible-p)))
7398 (txt tree)
7403 (old-level (if (string-match ^re txt)
7404 (- (match-end 0) (match-beginning 0) 1)
7405 -1))
7406 (force-level (cond (level (prefix-numeric-value level))
7408 (string-match
7409 ^re_ (buffer-substring
7410 (point-at-bol) (point))))
7411 (- (match-end 1) (match-beginning 1)))
7412 ((and (bolp)
7413 (looking-at org-outline-regexp))
7414 (- (match-end 0) (point) 1))
7415 (t nil)))
7416 (previous-level (save-excursion
7417 (condition-case nil
7418 (progn
7419 (outline-previous-visible-heading 1)
7420 (if (looking-at re)
7421 (- (match-end 0) (match-beginning 0) 1)
7422 1))
7423 (error 1))))
7424 (next-level (save-excursion
7425 (condition-case nil
7426 (progn
7427 (or (looking-at outline-regexp)
7428 (outline-next-visible-heading 1))
7429 (if (looking-at re)
7430 (- (match-end 0) (match-beginning 0) 1)
7431 1))
7432 (error 1))))
7433 (new-level (or force-level (max previous-level next-level)))
7434 (shift (if (or (= old-level -1)
7435 (= new-level -1)
7436 (= old-level new-level))
7437 0
7438 (- new-level old-level)))
7439 (delta (if (> shift 0) -1 1))
7440 (func (if (> shift 0) 'org-demote 'org-promote))
7441 (org-odd-levels-only nil)
7442 beg end newend)
7443 ;; Remove the forced level indicator
7444 (if force-level
7445 (delete-region (point-at-bol) (point)))
7446 ;; Paste
7447 (beginning-of-line 1)
7448 (unless for-yank (org-back-over-empty-lines))
7449 (setq beg (point))
7450 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7451 (insert-before-markers txt)
7453 (setq newend (point))
7454 (org-reinstall-markers-in-region beg)
7455 (setq end (point))
7456 (goto-char beg)
7458 (setq beg (point))
7459 (if (and (org-invisible-p) visp)
7460 (save-excursion (outline-show-heading)))
7461 ;; Shift if necessary
7462 (unless (= shift 0)
7463 (save-restriction
7464 (narrow-to-region beg end)
7465 (while (not (= shift 0))
7466 (org-map-region func (point-min) (point-max))
7467 (setq shift (+ delta shift)))
7468 (goto-char (point-min))
7469 (setq newend (point-max))))
7470 (when (or (interactive-p) for-yank)
7471 (message "Clipboard pasted as level %d subtree" new-level))
7472 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7473 kill-ring
7474 (eq org-subtree-clip (current-kill 0))
7475 org-subtree-clip-folded)
7476 ;; The tree was folded before it was killed/copied
7477 (hide-subtree))
7478 (and for-yank (goto-char newend))))
7480 (defun org-kill-is-subtree-p (&optional txt)
7481 "Check if the current kill is an outline subtree, or a set of trees.
7482 Returns nil if kill does not start with a headline, or if the first
7483 headline level is not the largest headline level in the tree.
7484 So this will actually accept several entries of equal levels as well,
7485 which is OK for `org-paste-subtree'.
7486 If optional TXT is given, check this string instead of the current kill."
7487 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7488 (start-level (and kill
7491 kill)
7492 (- (match-end 2) (match-beginning 2) 1)))
7493 (re (concat "^" org-outline-regexp))
7494 (start (1+ (or (match-beginning 2) -1))))
7495 (if (not start-level)
7496 (progn
7497 nil) ;; does not even start with a heading
7498 (catch 'exit
7499 (while (setq start (string-match re kill (1+ start)))
7500 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7501 (throw 'exit nil)))
7502 t))))
7504 (defvar org-markers-to-move nil
7505 "Markers that should be moved with a cut-and-paste operation.
7506 Those markers are stored together with their positions relative to
7507 the start of the region.")
7509 (defun org-save-markers-in-region (beg end)
7510 "Check markers in region.
7511 If these markers are between BEG and END, record their position relative
7512 to BEG, so that after moving the block of text, we can put the markers back
7513 into place.
7514 This function gets called just before an entry or tree gets cut from the
7515 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7516 called immediately, to move the markers with the entries."
7517 (setq org-markers-to-move nil)
7518 (when (featurep 'org-clock)
7519 (org-clock-save-markers-for-cut-and-paste beg end))
7520 (when (featurep 'org-agenda)
7521 (org-agenda-save-markers-for-cut-and-paste beg end)))
7523 (defun org-check-and-save-marker (marker beg end)
7524 "Check if MARKER is between BEG and END.
7525 If yes, remember the marker and the distance to BEG."
7526 (when (and (marker-buffer marker)
7527 (equal (marker-buffer marker) (current-buffer)))
7528 (if (and (>= marker beg) (< marker end))
7529 (push (cons marker (- marker beg)) org-markers-to-move))))
7531 (defun org-reinstall-markers-in-region (beg)
7532 "Move all remembered markers to their position relative to BEG."
7533 (mapc (lambda (x)
7534 (move-marker (car x) (+ beg (cdr x))))
7535 org-markers-to-move)
7536 (setq org-markers-to-move nil))
7538 (defun org-narrow-to-subtree ()
7539 "Narrow buffer to the current subtree."
7540 (interactive)
7541 (save-excursion
7542 (save-match-data
7543 (narrow-to-region
7544 (progn (org-back-to-heading t) (point))
7545 (progn (org-end-of-subtree t t)
7546 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7547 (point))))))
7549 (eval-when-compile
7550 (defvar org-property-drawer-re))
7552 (defvar org-property-start-re) ;; defined below
7553 (defun org-clone-subtree-with-time-shift (n &optional shift)
7554 "Clone the task (subtree) at point N times.
7555 The clones will be inserted as siblings.
7557 In interactive use, the user will be prompted for the number of
7558 clones to be produced, and for a time SHIFT, which may be a
7559 repeater as used in time stamps, for example `+3d'.
7561 When a valid repeater is given and the entry contains any time
7562 stamps, the clones will become a sequence in time, with time
7563 stamps in the subtree shifted for each clone produced. If SHIFT
7564 is nil or the empty string, time stamps will be left alone. The
7565 ID property of the original subtree is removed.
7567 If the original subtree did contain time stamps with a repeater,
7568 the following will happen:
7569 - the repeater will be removed in each clone
7570 - an additional clone will be produced, with the current, unshifted
7571 date(s) in the entry.
7572 - the original entry will be placed *after* all the clones, with
7573 repeater intact.
7574 - the start days in the repeater in the original entry will be shifted
7575 to past the last clone.
7576 I this way you can spell out a number of instances of a repeating task,
7577 and still retain the repeater to cover future instances of the task."
7578 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7579 (let (beg end template task idprop
7580 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7581 (if (not (and (integerp n) (> n 0)))
7582 (error "Invalid number of replications %s" n))
7585 shift)))
7586 (error "Invalid shift specification %s" shift))
7587 (when doshift
7588 (setq shift-n (string-to-number (match-string 1 shift))
7589 shift-what (cdr (assoc (match-string 2 shift)
7590 '(("d" . day) ("w" . week)
7591 ("m" . month) ("y" . year))))))
7592 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7593 (setq nmin 1 nmax n)
7594 (org-back-to-heading t)
7595 (setq beg (point))
7596 (setq idprop (org-entry-get nil "ID"))
7597 (org-end-of-subtree t t)
7599 (setq end (point))
7600 (setq template (buffer-substring beg end))
7601 (when (and doshift
7603 (delete-region beg end)
7604 (setq end beg)
7605 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7606 (goto-char end)
7607 (loop for n from nmin to nmax do
7608 ;; prepare clone
7609 (with-temp-buffer
7610 (insert template)
7611 (org-mode)
7612 (goto-char (point-min))
7613 (and idprop (if org-clone-delete-id
7614 (org-entry-delete nil "ID")
7615 (org-id-get-create t)))
7616 (while (re-search-forward org-property-start-re nil t)
7617 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7618 (goto-char (point-min))
7619 (when doshift
7620 (while (re-search-forward org-ts-regexp-both nil t)
7621 (org-timestamp-change (* n shift-n) shift-what))
7622 (unless (= n n-no-remove)
7623 (goto-char (point-min))
7624 (while (re-search-forward org-ts-regexp nil t)
7625 (save-excursion
7626 (goto-char (match-beginning 0))
7628 (delete-region (match-beginning 1) (match-end 1)))))))
7629 (setq task (buffer-string)))
7630 (insert task))
7631 (goto-char beg)))
7633 ;;; Outline Sorting
7635 (defun org-sort (with-case)
7636 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7637 Optional argument WITH-CASE means sort case-sensitively.
7638 With a double prefix argument, also remove duplicate entries."
7639 (interactive "P")
7640 (cond
7641 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7642 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7643 (t
7644 (org-call-with-arg 'org-sort-entries with-case))))
7646 (defun org-sort-remove-invisible (s)
7647 (remove-text-properties 0 (length s) org-rm-props s)
7648 (while (string-match org-bracket-link-regexp s)
7649 (setq s (replace-match (if (match-end 2)
7650 (match-string 3 s)
7651 (match-string 1 s)) t t s)))
7652 s)
7654 (defvar org-priority-regexp) ; defined later in the file
7656 (defvar org-after-sorting-entries-or-items-hook nil
7657 "Hook that is run after a bunch of entries or items have been sorted.
7658 When children are sorted, the cursor is in the parent line when this
7659 hook gets called. When a region or a plain list is sorted, the cursor
7660 will be in the first entry of the sorted region/list.")
7662 (defun org-sort-entries
7663 (&optional with-case sorting-type getkey-func compare-func property)
7664 "Sort entries on a certain level of an outline tree.
7665 If there is an active region, the entries in the region are sorted.
7666 Else, if the cursor is before the first entry, sort the top-level items.
7667 Else, the children of the entry at point are sorted.
7669 Sorting can be alphabetically, numerically, by date/time as given by
7670 a time stamp, by a property or by priority.
7672 The command prompts for the sorting type unless it has been given to the
7673 function through the SORTING-TYPE argument, which needs to be a character,
7674 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7675 precise meaning of each character:
7677 n Numerically, by converting the beginning of the entry/item to a number.
7678 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7679 t By date/time, either the first active time stamp in the entry, or, if
7680 none exist, by the first inactive one.
7681 s By the scheduled date/time.
7682 d By deadline date/time.
7683 c By creation time, which is assumed to be the first inactive time stamp
7684 at the beginning of a line.
7685 p By priority according to the cookie.
7686 r By the value of a property.
7688 Capital letters will reverse the sort order.
7690 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7691 called with point at the beginning of the record. It must return either
7692 a string or a number that should serve as the sorting key for that record.
7694 Comparing entries ignores case by default. However, with an optional argument
7695 WITH-CASE, the sorting considers case as well."
7696 (interactive "P")
7697 (let ((case-func (if with-case 'identity 'downcase))
7698 start beg end stars re re2
7699 txt what tmp)
7700 ;; Find beginning and end of region to sort
7701 (cond
7702 ((org-region-active-p)
7703 ;; we will sort the region
7704 (setq end (region-end)
7705 what "region")
7706 (goto-char (region-beginning))
7707 (if (not (org-on-heading-p)) (outline-next-heading))
7708 (setq start (point)))
7709 ((or (org-on-heading-p)
7710 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7711 ;; we will sort the children of the current headline
7712 (org-back-to-heading)
7713 (setq start (point)
7714 end (progn (org-end-of-subtree t t)
7716 (org-back-over-empty-lines)
7717 (point))
7718 what "children")
7719 (goto-char start)
7720 (show-subtree)
7721 (outline-next-heading))
7722 (t
7723 ;; we will sort the top-level entries in this file
7724 (goto-char (point-min))
7725 (or (org-on-heading-p) (outline-next-heading))
7726 (setq start (point))
7727 (goto-char (point-max))
7728 (beginning-of-line 1)
7730 ;; File ends in a non-white line
7731 (end-of-line 1)
7733 (setq end (point-max))
7734 (setq what "top-level")
7735 (goto-char start)
7736 (show-all)))
7738 (setq beg (point))
7739 (if (>= beg end) (error "Nothing to sort"))
7742 (setq stars (match-string 1)
7743 re (concat "^" (regexp-quote stars) " +")
7744 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
7745 txt (buffer-substring beg end))
7747 (if (and (not (equal stars "*")) (string-match re2 txt))
7748 (error "Region to sort contains a level above the first entry"))
7750 (unless sorting-type
7751 (message
7752 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7754 A/N/T/S/D/C/P/O/F means reversed:"
7755 what)
7756 (setq sorting-type (read-char-exclusive))
7758 (and (= (downcase sorting-type) ?f)
7759 (setq getkey-func
7760 (org-icompleting-read "Sort using function: "
7761 obarray 'fboundp t nil nil))
7762 (setq getkey-func (intern getkey-func)))
7764 (and (= (downcase sorting-type) ?r)
7765 (setq property
7766 (org-icompleting-read "Property: "
7767 (mapcar 'list (org-buffer-property-keys t))
7768 nil t))))
7770 (message "Sorting entries...")
7772 (save-restriction
7773 (narrow-to-region start end)
7774 (let ((dcst (downcase sorting-type))
7775 (case-fold-search nil)
7776 (now (current-time)))
7777 (sort-subr
7778 (/= dcst sorting-type)
7779 ;; This function moves to the beginning character of the "record" to
7780 ;; be sorted.
7781 (lambda nil
7782 (if (re-search-forward re nil t)
7783 (goto-char (match-beginning 0))
7784 (goto-char (point-max))))
7785 ;; This function moves to the last character of the "record" being
7786 ;; sorted.
7787 (lambda nil
7788 (save-match-data
7789 (condition-case nil
7790 (outline-forward-same-level 1)
7791 (error
7792 (goto-char (point-max))))))
7793 ;; This function returns the value that gets sorted against.
7794 (lambda nil
7795 (cond
7796 ((= dcst ?n)
7797 (if (looking-at org-complex-heading-regexp)
7798 (string-to-number (match-string 4))
7799 nil))
7800 ((= dcst ?a)
7801 (if (looking-at org-complex-heading-regexp)
7802 (funcall case-func (match-string 4))
7803 nil))
7804 ((= dcst ?t)
7805 (let ((end (save-excursion (outline-next-heading) (point))))
7806 (if (or (re-search-forward org-ts-regexp end t)
7807 (re-search-forward org-ts-regexp-both end t))
7808 (org-time-string-to-seconds (match-string 0))
7809 (org-float-time now))))
7810 ((= dcst ?c)
7811 (let ((end (save-excursion (outline-next-heading) (point))))
7812 (if (re-search-forward
7814 end t)
7815 (org-time-string-to-seconds (match-string 0))
7816 (org-float-time now))))
7817 ((= dcst ?s)
7818 (let ((end (save-excursion (outline-next-heading) (point))))
7819 (if (re-search-forward org-scheduled-time-regexp end t)
7820 (org-time-string-to-seconds (match-string 1))
7821 (org-float-time now))))
7822 ((= dcst ?d)
7823 (let ((end (save-excursion (outline-next-heading) (point))))
7824 (if (re-search-forward org-deadline-time-regexp end t)
7825 (org-time-string-to-seconds (match-string 1))
7826 (org-float-time now))))
7827 ((= dcst ?p)
7828 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7829 (string-to-char (match-string 2))
7830 org-default-priority))
7831 ((= dcst ?r)
7832 (or (org-entry-get nil property) ""))
7833 ((= dcst ?o)
7834 (if (looking-at org-complex-heading-regexp)
7835 (- 9999 (length (member (match-string 2)
7836 org-todo-keywords-1)))))
7837 ((= dcst ?f)
7838 (if getkey-func
7839 (progn
7840 (setq tmp (funcall getkey-func))
7841 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7842 tmp)
7843 (error "Invalid key function `%s'" getkey-func)))
7844 (t (error "Invalid sorting type `%c'" sorting-type))))
7845 nil
7846 (cond
7847 ((= dcst ?a) 'string<)
7848 ((= dcst ?f) compare-func)
7849 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7850 (t nil)))))
7851 (run-hooks 'org-after-sorting-entries-or-items-hook)
7852 (message "Sorting entries...done")))
7854 (defun org-do-sort (table what &optional with-case sorting-type)
7855 "Sort TABLE of WHAT according to SORTING-TYPE.
7856 The user will be prompted for the SORTING-TYPE if the call to this
7857 function does not specify it. WHAT is only for the prompt, to indicate
7858 what is being sorted. The sorting key will be extracted from
7859 the car of the elements of the table.
7860 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7861 (unless sorting-type
7862 (message
7863 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7864 what)
7865 (setq sorting-type (read-char-exclusive)))
7866 (let ((dcst (downcase sorting-type))
7867 extractfun comparefun)
7868 ;; Define the appropriate functions
7869 (cond
7870 ((= dcst ?n)
7871 (setq extractfun 'string-to-number
7872 comparefun (if (= dcst sorting-type) '< '>)))
7873 ((= dcst ?a)
7874 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7875 (lambda(x) (downcase (org-sort-remove-invisible x))))
7876 comparefun (if (= dcst sorting-type)
7877 'string<
7878 (lambda (a b) (and (not (string< a b))
7879 (not (string= a b)))))))
7880 ((= dcst ?t)
7881 (setq extractfun
7882 (lambda (x)
7883 (if (or (string-match org-ts-regexp x)
7884 (string-match org-ts-regexp-both x))
7885 (org-float-time
7886 (org-time-string-to-time (match-string 0 x)))
7887 0))
7888 comparefun (if (= dcst sorting-type) '< '>)))
7889 (t (error "Invalid sorting type `%c'" sorting-type)))
7891 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7892 table)
7893 (lambda (a b) (funcall comparefun (car a) (car b))))))
7896 ;;; The orgstruct minor mode
7898 ;; Define a minor mode which can be used in other modes in order to
7899 ;; integrate the org-mode structure editing commands.
7901 ;; This is really a hack, because the org-mode structure commands use
7902 ;; keys which normally belong to the major mode. Here is how it
7903 ;; works: The minor mode defines all the keys necessary to operate the
7904 ;; structure commands, but wraps the commands into a function which
7905 ;; tests if the cursor is currently at a headline or a plain list
7906 ;; item. If that is the case, the structure command is used,
7907 ;; temporarily setting many Org-mode variables like regular
7908 ;; expressions for filling etc. However, when any of those keys is
7909 ;; used at a different location, function uses `key-binding' to look
7910 ;; up if the key has an associated command in another currently active
7911 ;; keymap (minor modes, major mode, global), and executes that
7912 ;; command. There might be problems if any of the keys is otherwise
7913 ;; used as a prefix key.
7915 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7916 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7917 ;; addresses this by checking explicitly for both bindings.
7919 (defvar orgstruct-mode-map (make-sparse-keymap)
7920 "Keymap for the minor `orgstruct-mode'.")
7922 (defvar org-local-vars nil
7923 "List of local variables, for use by `orgstruct-mode'.")
7925 ;;;###autoload
7926 (define-minor-mode orgstruct-mode
7927 "Toggle the minor mode `orgstruct-mode'.
7928 This mode is for using Org-mode structure commands in other
7929 modes. The following keys behave as if Org-mode were active, if
7930 the cursor is on a headline, or on a plain list item (both as
7931 defined by Org-mode).
7933 M-up Move entry/item up
7934 M-down Move entry/item down
7935 M-left Promote
7936 M-right Demote
7937 M-S-up Move entry/item up
7938 M-S-down Move entry/item down
7939 M-S-left Promote subtree
7940 M-S-right Demote subtree
7941 M-q Fill paragraph and items like in Org-mode
7942 C-c ^ Sort entries
7943 C-c - Cycle list bullet
7944 TAB Cycle item visibility
7945 M-RET Insert new heading/item
7946 S-M-RET Insert new TODO heading / Checkbox item
7947 C-c C-c Set tags / toggle checkbox"
7948 nil " OrgStruct" nil
7949 (org-load-modules-maybe)
7950 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7952 ;;;###autoload
7953 (defun turn-on-orgstruct ()
7954 "Unconditionally turn on `orgstruct-mode'."
7955 (orgstruct-mode 1))
7957 (defun orgstruct++-mode (&optional arg)
7958 "Toggle `orgstruct-mode', the enhanced version of it.
7959 In addition to setting orgstruct-mode, this also exports all indentation
7960 and autofilling variables from org-mode into the buffer. It will also
7961 recognize item context in multiline items.
7962 Note that turning off orgstruct-mode will *not* remove the
7963 indentation/paragraph settings. This can only be done by refreshing the
7965 (interactive "P")
7966 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
7967 (if (< arg 1)
7968 (orgstruct-mode -1)
7969 (orgstruct-mode 1)
7970 (let (var val)
7971 (mapc
7972 (lambda (x)
7973 (when (string-match
7975 (symbol-name (car x)))
7976 (setq var (car x) val (nth 1 x))
7977 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7978 org-local-vars)
7979 (org-set-local 'orgstruct-is-++ t))))
7981 (defvar orgstruct-is-++ nil
7982 "Is `orgstruct-mode' in ++ version in the current-buffer?")
7983 (make-variable-buffer-local 'orgstruct-is-++)
7985 ;;;###autoload
7986 (defun turn-on-orgstruct++ ()
7987 "Unconditionally turn on `orgstruct++-mode'."
7988 (orgstruct++-mode 1))
7990 (defun orgstruct-error ()
7991 "Error when there is no default binding for a structure key."
7992 (interactive)
7993 (error "This key has no function outside structure elements"))
7995 (defun orgstruct-setup ()
7996 "Setup orgstruct keymaps."
7997 (let ((nfunc 0)
7998 (bindings
7999 (list
8000 '([(meta up)] org-metaup)
8001 '([(meta down)] org-metadown)
8002 '([(meta left)] org-metaleft)
8003 '([(meta right)] org-metaright)
8004 '([(meta shift up)] org-shiftmetaup)
8005 '([(meta shift down)] org-shiftmetadown)
8006 '([(meta shift left)] org-shiftmetaleft)
8007 '([(meta shift right)] org-shiftmetaright)
8008 '([?\e (up)] org-metaup)
8009 '([?\e (down)] org-metadown)
8010 '([?\e (left)] org-metaleft)
8011 '([?\e (right)] org-metaright)
8012 '([?\e (shift up)] org-shiftmetaup)
8013 '([?\e (shift down)] org-shiftmetadown)
8014 '([?\e (shift left)] org-shiftmetaleft)
8015 '([?\e (shift right)] org-shiftmetaright)
8016 '([(shift up)] org-shiftup)
8017 '([(shift down)] org-shiftdown)
8018 '([(shift left)] org-shiftleft)
8019 '([(shift right)] org-shiftright)
8020 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8021 '("\M-q" fill-paragraph)
8022 '("\C-c^" org-sort)
8023 '("\C-c-" org-cycle-list-bullet)))
8024 elt key fun cmd)
8025 (while (setq elt (pop bindings))
8026 (setq nfunc (1+ nfunc))
8027 (setq key (org-key (car elt))
8028 fun (nth 1 elt)
8029 cmd (orgstruct-make-binding fun nfunc key))
8030 (org-defkey orgstruct-mode-map key cmd))
8032 ;; Special treatment needed for TAB and RET
8033 (org-defkey orgstruct-mode-map [(tab)]
8034 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8035 (org-defkey orgstruct-mode-map "\C-i"
8036 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8038 (org-defkey orgstruct-mode-map "\M-\C-m"
8039 (orgstruct-make-binding 'org-insert-heading 105
8040 "\M-\C-m" [(meta return)]))
8041 (org-defkey orgstruct-mode-map [(meta return)]
8042 (orgstruct-make-binding 'org-insert-heading 106
8043 [(meta return)] "\M-\C-m"))
8045 (org-defkey orgstruct-mode-map [(shift meta return)]
8046 (orgstruct-make-binding 'org-insert-todo-heading 107
8047 [(meta return)] "\M-\C-m"))
8049 (org-defkey orgstruct-mode-map "\e\C-m"
8050 (orgstruct-make-binding 'org-insert-heading 108
8051 "\e\C-m" [?\e (return)]))
8052 (org-defkey orgstruct-mode-map [?\e (return)]
8053 (orgstruct-make-binding 'org-insert-heading 109
8054 [?\e (return)] "\e\C-m"))
8055 (org-defkey orgstruct-mode-map [?\e (shift return)]
8056 (orgstruct-make-binding 'org-insert-todo-heading 110
8057 [?\e (return)] "\e\C-m"))
8059 (unless org-local-vars
8060 (setq org-local-vars (org-get-local-variables)))
8062 t))
8064 (defun orgstruct-make-binding (fun n &rest keys)
8065 "Create a function for binding in the structure minor mode.
8066 FUN is the command to call inside a table. N is used to create a unique
8067 command name. KEYS are keys that should be checked in for a command
8068 to execute outside of tables."
8069 (eval
8070 (list 'defun
8071 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8072 '(arg)
8074 "Outside of structure, run the binding of `"
8075 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8076 "'.")
8077 '(interactive "p")
8078 (list 'if
8079 `(org-context-p 'headline 'item
8080 (and orgstruct-is-++
8081 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8082 'item-body))
8083 (list 'org-run-like-in-org-mode (list 'quote fun))
8084 (list 'let '(orgstruct-mode)
8085 (list 'call-interactively
8086 (append '(or)
8087 (mapcar (lambda (k)
8088 (list 'key-binding k))
8089 keys)
8090 '('orgstruct-error))))))))
8092 (defun org-context-p (&rest contexts)
8093 "Check if local context is any of CONTEXTS.
8094 Possible values in the list of contexts are `table', `headline', and `item'."
8095 (let ((pos (point)))
8096 (goto-char (point-at-bol))
8097 (prog1 (or (and (memq 'table contexts)
8099 (and (memq 'headline contexts)
8101 (looking-at outline-regexp))
8102 (and (memq 'item contexts)
8104 (and (memq 'item-body contexts)
8105 (org-in-item-p)))
8106 (goto-char pos))))
8108 (defun org-get-local-variables ()
8109 "Return a list of all local variables in an org-mode buffer."
8110 (let (varlist)
8111 (with-current-buffer (get-buffer-create "*Org tmp*")
8112 (erase-buffer)
8113 (org-mode)
8114 (setq varlist (buffer-local-variables)))
8115 (kill-buffer "*Org tmp*")
8116 (delq nil
8117 (mapcar
8118 (lambda (x)
8119 (setq x
8120 (if (symbolp x)
8121 (list x)
8122 (list (car x) (list 'quote (cdr x)))))
8123 (if (string-match
8124 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8125 (symbol-name (car x)))
8126 x nil))
8127 varlist))))
8129 ;;;###autoload
8130 (defun org-run-like-in-org-mode (cmd)
8131 "Run a command, pretending that the current buffer is in Org-mode.
8132 This will temporarily bind local variables that are typically bound in
8133 Org-mode to the values they have in Org-mode, and then interactively
8134 call CMD."
8135 (org-load-modules-maybe)
8136 (unless org-local-vars
8137 (setq org-local-vars (org-get-local-variables)))
8138 (eval (list 'let org-local-vars
8139 (list 'call-interactively (list 'quote cmd)))))
8141 ;;;; Archiving
8143 (defun org-get-category (&optional pos force-refresh)
8144 "Get the category applying to position POS."
8145 (if force-refresh (org-refresh-category-properties))
8146 (let ((pos (or pos (point))))
8147 (or (get-text-property pos 'org-category)
8148 (progn (org-refresh-category-properties)
8149 (get-text-property pos 'org-category)))))
8151 (defun org-refresh-category-properties ()
8152 "Refresh category text properties in the buffer."
8153 (let ((def-cat (cond
8154 ((null org-category)
8155 (if buffer-file-name
8156 (file-name-sans-extension
8157 (file-name-nondirectory buffer-file-name))
8158 "???"))
8159 ((symbolp org-category) (symbol-name org-category))
8160 (t org-category)))
8161 beg end cat pos optionp)
8162 (org-unmodified
8163 (save-excursion
8164 (save-restriction
8165 (widen)
8166 (goto-char (point-min))
8167 (put-text-property (point) (point-max) 'org-category def-cat)
8168 (while (re-search-forward
8170 (setq pos (match-end 0)
8171 optionp (equal (char-after (match-beginning 0)) ?#)
8172 cat (org-trim (match-string 2)))
8173 (if optionp
8174 (setq beg (point-at-bol) end (point-max))
8175 (org-back-to-heading t)
8176 (setq beg (point) end (org-end-of-subtree t t)))
8177 (put-text-property beg end 'org-category cat)
8178 (goto-char pos)))))))
8181 ;;;; Link Stuff
8183 ;;; Link abbreviations
8185 (defun org-link-expand-abbrev (link)
8186 "Apply replacements as defined in `org-link-abbrev-alist."
8188 (let* ((key (match-string 1 link))
8189 (as (or (assoc key org-link-abbrev-alist-local)
8190 (assoc key org-link-abbrev-alist)))
8191 (tag (and (match-end 2) (match-string 3 link)))
8192 rpl)
8193 (if (not as)
8194 link
8195 (setq rpl (cdr as))
8196 (cond
8197 ((symbolp rpl) (funcall rpl tag))
8198 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8199 ((string-match "%h" rpl)
8200 (replace-match (url-hexify-string (or tag "")) t t rpl))
8201 (t (concat rpl tag)))))
8202 link))
8204 ;;; Storing and inserting links
8206 (defvar org-insert-link-history nil
8207 "Minibuffer history for links inserted with `org-insert-link'.")
8209 (defvar org-stored-links nil
8210 "Contains the links stored with `org-store-link'.")
8212 (defvar org-store-link-plist nil
8213 "Plist with info about the most recently link created with `org-store-link'.")
8215 (defvar org-link-protocols nil
8216 "Link protocols added to Org-mode using `org-add-link-type'.")
8218 (defvar org-store-link-functions nil
8219 "List of functions that are called to create and store a link.
8220 Each function will be called in turn until one returns a non-nil
8221 value. Each function should check if it is responsible for creating
8222 this link (for example by looking at the major mode).
8223 If not, it must exit and return nil.
8224 If yes, it should return a non-nil value after a calling
8225 `org-store-link-props' with a list of properties and values.
8226 Special properties are:
8230 This is obligatory as well.
8231 :description Optional default description for the second pair
8232 of brackets in an Org-mode link. The user can still change
8233 this when inserting this link into an Org-mode buffer.
8235 In addition to these, any additional properties can be specified
8236 and then used in remember templates.")
8238 (defun org-add-link-type (type &optional follow export)
8239 "Add TYPE to the list of `org-link-types'.
8240 Re-compute all regular expressions depending on `org-link-types'
8242 FOLLOW and EXPORT are two functions.
8244 FOLLOW should take the link path as the single argument and do whatever
8245 is necessary to follow the link, for example find a file or display
8246 a mail message.
8248 EXPORT should format the link path for export to one of the export formats.
8249 It should be a function accepting three arguments:
8252 desc the description of the link, if any, nil if there was no description
8253 format the export format, a symbol like `html' or `latex' or `ascii'..
8255 The function may use the FORMAT information to return different values
8256 depending on the format. The return value will be put literally into
8257 the exported file. If the return value is nil, this means Org should
8258 do what it normally does with links which do not have EXPORT defined.
8260 Org-mode has a built-in default for exporting links. If you are happy with
8261 this default, there is no need to define an export function for the link
8262 type. For a simple example of an export function, see `org-bbdb.el'."
8263 (add-to-list 'org-link-types type t)
8264 (org-make-link-regexps)
8265 (if (assoc type org-link-protocols)
8266 (setcdr (assoc type org-link-protocols) (list follow export))
8267 (push (list type follow export) org-link-protocols)))
8269 (defvar org-agenda-buffer-name)
8271 ;;;###autoload
8272 (defun org-store-link (arg)
8274 This link is added to `org-stored-links' and can later be inserted
8277 For some link types, a prefix arg is interpreted:
8278 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8279 For file links, arg negates `org-context-in-file-links'."
8280 (interactive "P")
8281 (org-load-modules-maybe)
8282 (setq org-store-link-plist nil) ; reset
8283 (let ((outline-regexp (org-get-limited-outline-regexp))
8284 link cpltxt desc description search txt custom-id agenda-link)
8285 (cond
8287 ((run-hook-with-args-until-success 'org-store-link-functions)
8288 (setq link (plist-get org-store-link-plist :link)
8289 desc (or (plist-get org-store-link-plist :description) link)))
8291 ((equal (buffer-name) "*Org Edit Src Example*")
8292 (let (label gc)
8293 (while (or (not label)
8294 (save-excursion
8295 (save-restriction
8296 (widen)
8297 (goto-char (point-min))
8298 (re-search-forward
8299 (regexp-quote (format org-coderef-label-format label))
8300 nil t))))
8301 (when label (message "Label exists already") (sit-for 2))
8302 (setq label (read-string "Code line label: " label)))
8303 (end-of-line 1)
8304 (setq link (format org-coderef-label-format label))
8305 (setq gc (- 79 (length link)))
8306 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8307 (insert link)
8308 (setq link (concat "(" label ")") desc nil)))
8310 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8311 ;; We are in the agenda, link to referenced location
8312 (let ((m (or (get-text-property (point) 'org-hd-marker)
8313 (get-text-property (point) 'org-marker))))
8314 (when m
8315 (org-with-point-at m
8316 (setq agenda-link
8317 (if (interactive-p)
8318 (call-interactively 'org-store-link)
8319 (org-store-link nil)))))))
8321 ((eq major-mode 'calendar-mode)
8322 (let ((cd (calendar-cursor-to-date)))
8323 (setq link
8324 (format-time-string
8325 (car org-time-stamp-formats)
8326 (apply 'encode-time
8327 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8328 nil nil nil))))
8329 (org-store-link-props :type "calendar" :date cd)))
8331 ((eq major-mode 'w3-mode)
8332 (setq cpltxt (if (and (buffer-name)
8333 (not (string-match "Untitled" (buffer-name))))
8334 (buffer-name)
8335 (url-view-url t))
8336 link (org-make-link (url-view-url t)))
8337 (org-store-link-props :type "w3" :url (url-view-url t)))
8339 ((eq major-mode 'w3m-mode)
8340 (setq cpltxt (or w3m-current-title w3m-current-url)
8341 link (org-make-link w3m-current-url))
8342 (org-store-link-props :type "w3m" :url (url-view-url t)))
8344 ((setq search (run-hook-with-args-until-success
8345 'org-create-file-search-functions))
8346 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8347 "::" search))
8348 (setq cpltxt (or description link)))
8350 ((eq major-mode 'image-mode)
8351 (setq cpltxt (concat "file:"
8352 (abbreviate-file-name buffer-file-name))
8353 link (org-make-link cpltxt))
8354 (org-store-link-props :type "image" :file buffer-file-name))
8356 ((eq major-mode 'dired-mode)
8357 ;; link to the file in the current line
8358 (let ((file (dired-get-filename nil t)))
8359 (setq file (if file
8360 (abbreviate-file-name
8361 (expand-file-name (dired-get-filename nil t)))
8362 ;; otherwise, no file so use current directory.
8363 default-directory))
8364 (setq cpltxt (concat "file:" file)
8365 link (org-make-link cpltxt))))
8367 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8368 (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
8369 (cond
8371 (setq cpltxt
8372 (concat "file:"
8373 (abbreviate-file-name
8374 (buffer-file-name (buffer-base-buffer)))
8375 "::" (match-string 1))
8376 link (org-make-link cpltxt)))
8377 ((and (featurep 'org-id)
8378 (or (eq org-link-to-org-use-id t)
8379 (and (eq org-link-to-org-use-id 'create-if-interactive)
8380 (interactive-p))
8381 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
8382 (interactive-p)
8383 (not custom-id))
8384 (and org-link-to-org-use-id
8385 (condition-case nil
8386 (org-entry-get nil "ID")
8387 (error nil)))))
8388 ;; We can make a link using the ID.
8389 (setq link (condition-case nil
8390 (prog1 (org-id-store-link)
8391 (setq desc (plist-get org-store-link-plist
8392 :description)))
8393 (error
8394 ;; probably before first headline, link to file only
8395 (concat "file:"
8396 (abbreviate-file-name
8397 (buffer-file-name (buffer-base-buffer))))))))
8398 (t
8399 ;; Just link to current headline
8400 (setq cpltxt (concat "file:"
8401 (abbreviate-file-name
8402 (buffer-file-name (buffer-base-buffer)))))
8403 ;; Add a context search string
8404 (when (org-xor org-context-in-file-links arg)
8405 (setq txt (cond
8406 ((org-on-heading-p) nil)
8407 ((org-region-active-p)
8408 (buffer-substring (region-beginning) (region-end)))
8409 (t nil)))
8411 (setq cpltxt
8412 (concat cpltxt "::"
8413 (condition-case nil
8414 (org-make-org-heading-search-string txt)
8415 (error "")))
8416 desc (or (nth 4 (ignore-errors
8417 (org-heading-components))) "NONE"))))
8419 (setq cpltxt (substring cpltxt 0 -2)))
8420 (setq link (org-make-link cpltxt)))))
8422 ((buffer-file-name (buffer-base-buffer))
8423 ;; Just link to this file here.
8424 (setq cpltxt (concat "file:"
8425 (abbreviate-file-name
8426 (buffer-file-name (buffer-base-buffer)))))
8427 ;; Add a context string
8428 (when (org-xor org-context-in-file-links arg)
8429 (setq txt (if (org-region-active-p)
8430 (buffer-substring (region-beginning) (region-end))
8431 (buffer-substring (point-at-bol) (point-at-eol))))
8432 ;; Only use search option if there is some text.
8434 (setq cpltxt
8435 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8436 desc "NONE")))
8437 (setq link (org-make-link cpltxt)))
8439 ((interactive-p)
8440 (error "Cannot link to a buffer which is not visiting a file"))
8442 (t (setq link nil)))
8444 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8445 (setq link (or link cpltxt)
8446 desc (or desc cpltxt))
8447 (if (equal desc "NONE") (setq desc nil))
8449 (if (and (or (interactive-p) executing-kbd-macro) link)
8450 (progn
8451 (setq org-stored-links
8452 (cons (list link desc) org-stored-links))
8453 (message "Stored: %s" (or desc link))
8454 (when custom-id
8455 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8456 "::#" custom-id))
8457 (setq org-stored-links
8458 (cons (list link desc) org-stored-links))))
8459 (or agenda-link (and link (org-make-link-string link desc))))))
8461 (defun org-store-link-props (&rest plist)
8462 "Store link properties, extract names and addresses."
8463 (let (x adr)
8464 (when (setq x (plist-get plist :from))
8465 (setq adr (mail-extract-address-components x))
8466 (setq plist (plist-put plist :fromname (car adr)))
8467 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8468 (when (setq x (plist-get plist :to))
8469 (setq adr (mail-extract-address-components x))
8470 (setq plist (plist-put plist :toname (car adr)))
8471 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8472 (let ((from (plist-get plist :from))
8473 (to (plist-get plist :to)))
8474 (when (and from to org-from-is-user-regexp)
8475 (setq plist
8476 (plist-put plist :fromto
8477 (if (string-match org-from-is-user-regexp from)
8478 (concat "to %t")
8479 (concat "from %f"))))))
8480 (setq org-store-link-plist plist))
8482 (defun org-add-link-props (&rest plist)
8483 "Add these properties to the link property list."
8484 (let (key value)
8485 (while plist
8486 (setq key (pop plist) value (pop plist))
8487 (setq org-store-link-plist
8488 (plist-put org-store-link-plist key value)))))
8490 (defun org-email-link-description (&optional fmt)
8491 "Return the description part of an email link.
8492 This takes information from `org-store-link-plist' and formats it
8493 according to FMT (default from `org-email-link-description-format')."
8494 (setq fmt (or fmt org-email-link-description-format))
8495 (let* ((p org-store-link-plist)
8496 (to (plist-get p :toaddress))
8497 (from (plist-get p :fromaddress))
8498 (table
8499 (list
8500 (cons "%c" (plist-get p :fromto))
8501 (cons "%F" (plist-get p :from))
8502 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8503 (cons "%T" (plist-get p :to))
8504 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8505 (cons "%s" (plist-get p :subject))
8506 (cons "%d" (plist-get p :date))
8507 (cons "%m" (plist-get p :message-id)))))
8508 (when (string-match "%c" fmt)
8509 ;; Check if the user wrote this message
8510 (if (and org-from-is-user-regexp from to
8511 (save-match-data (string-match org-from-is-user-regexp from)))
8512 (setq fmt (replace-match "to %t" t t fmt))
8513 (setq fmt (replace-match "from %f" t t fmt))))
8514 (org-replace-escapes fmt table)))
8516 (defun org-make-org-heading-search-string (&optional string heading)
8517 "Make search string for STRING or current headline."
8518 (interactive)
8519 (let ((s (or string (org-get-heading)))
8520 (lines org-context-in-file-links))
8521 (unless (and string (not heading))
8522 ;; We are using a headline, clean up garbage in there.
8523 (if (string-match org-todo-regexp s)
8524 (setq s (replace-match "" t t s)))
8526 (setq s (replace-match "" t t s)))
8527 (setq s (org-trim s))
8530 (setq s (replace-match "" t t s)))
8531 (while (string-match org-ts-regexp s)
8532 (setq s (replace-match "" t t s))))
8533 (or string (setq s (concat "*" s))) ; Add * for headlines
8534 (when (and string (integerp lines) (> lines 0))
8536 (when (< lines (length slines))
8537 (setq s (mapconcat
8538 'identity
8539 (reverse (nthcdr (- (length slines) lines)
8543 (defun org-make-link (&rest strings)
8544 "Concatenate STRINGS."
8545 (apply 'concat strings))
8547 (defun org-make-link-string (link &optional description)
8548 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8550 (error "Empty link"))
8551 (when (and description
8552 (stringp description)
8554 (setq description nil))
8555 (when (stringp description)
8556 ;; Remove brackets from the description, they are fatal.
8558 (setq description (replace-match "{" t t description)))
8560 (setq description (replace-match "}" t t description))))
8561 (when (equal (org-link-escape link) description)
8562 ;; No description needed, it is identical
8563 (setq description nil))
8564 (when (and (not description)
8565 (not (equal link (org-link-escape link))))
8566 (setq description (org-extract-attributes link)))
8567 (setq link (if (string-match org-link-types-re link)
8568 (concat (match-string 1 link)
8569 (org-link-escape (substring link (match-end 1))))
8570 (org-link-escape link)))
8571 (concat "[[" link "]"
8572 (if description (concat "[" description "]") "")
8573 "]"))
8575 (defconst org-link-escape-chars
8576 '((?\ . "%20")
8577 (?\[ . "%5B")
8578 (?\] . "%5D")
8589 (?\; . "%3B")
8590 ;; (?? . "%3F")
8591 (?= . "%3D")
8592 (?+ . "%2B")
8593 )
8594 "Association list of escapes for some characters problematic in links.
8595 This is the list that is used for internal purposes.")
8597 (defvar org-url-encoding-use-url-hexify nil)
8599 (defconst org-link-escape-chars-browser
8600 '((?\ . "%20")) ; 32 for the SPC char
8601 "Association list of escapes for some characters problematic in links.
8602 This is the list that is used before handing over to the browser.")
8604 (defun org-link-escape (text &optional table)
8605 "Escape characters in TEXT that are problematic for links."
8606 (if (and org-url-encoding-use-url-hexify (not table))
8607 (url-hexify-string text)
8608 (setq table (or table org-link-escape-chars))
8609 (when text
8610 (let ((re (mapconcat (lambda (x) (regexp-quote
8611 (char-to-string (car x))))
8613 (while (string-match re text)
8614 (setq text
8615 (replace-match
8616 (cdr (assoc (string-to-char (match-string 0 text))
8617 table))
8618 t t text)))
8619 text))))
8621 (defun org-link-unescape (text &optional table)
8622 "Reverse the action of `org-link-escape'."
8623 (if (and org-url-encoding-use-url-hexify (not table))
8624 (url-unhex-string text)
8625 (setq table (or table org-link-escape-chars))
8626 (when text
8627 (let ((case-fold-search t)
8628 (re (mapconcat (lambda (x) (regexp-quote (downcase (cdr x))))
8630 (while (string-match re text)
8631 (setq text
8632 (replace-match
8633 (char-to-string (car (rassoc (upcase (match-string 0 text))
8634 table)))
8635 t t text)))
8636 text))))
8638 (defun org-xor (a b)
8639 "Exclusive or."
8640 (if a (not b) b))
8642 (defun org-fixup-message-id-for-http (s)
8643 "Replace special characters in a message id, so it can be used in an http query."
8644 (when (string-match "%" s)
8645 (setq s (mapconcat (lambda (c)
8646 (if (eq c ?%)
8647 "%25"
8648 (char-to-string c)))
8649 s "")))
8650 (while (string-match "<" s)
8651 (setq s (replace-match "%3C" t t s)))
8652 (while (string-match ">" s)
8653 (setq s (replace-match "%3E" t t s)))
8654 (while (string-match "@" s)
8655 (setq s (replace-match "%40" t t s)))
8656 s)
8658 ;;;###autoload
8659 (defun org-insert-link-global ()
8660 "Insert a link like Org-mode does.
8661 This command can be called in any mode to insert a link in Org-mode syntax."
8662 (interactive)
8663 (org-load-modules-maybe)
8664 (org-run-like-in-org-mode 'org-insert-link))
8666 (defun org-insert-link (&optional complete-file link-location)
8667 "Insert a link. At the prompt, enter the link.
8669 Completion can be used to insert any of the link protocol prefixes like
8670 http or ftp in use.
8672 The history can be used to select a link previously stored with
8673 `org-store-link'. When the empty string is entered (i.e. if you just
8674 press RET at the prompt), the link defaults to the most recently
8675 stored link. As SPC triggers completion in the minibuffer, you need to
8676 use M-SPC or C-q SPC to force the insertion of a space character.
8678 You will also be prompted for a description, and if one is given, it will
8679 be displayed in the buffer instead of the link.
8681 If there is already a link at point, this command will allow you to edit link
8682 and description parts.
8685 be selected using completion. The path to the file will be relative to the
8686 current directory if the file is in the current directory or a subdirectory.
8687 Otherwise, the link will be the absolute path as completed in the minibuffer
8688 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8689 option `org-link-file-path-type'.
8692 the current directory or below.
8695 `org-keep-stored-link-after-insertion'.
8697 If `org-make-link-description-function' is non-nil, this function will be
8698 called with the link target, and the result will be the default
8699 link description.
8701 If the LINK-LOCATION parameter is non-nil, this value will be
8702 used as the link location instead of reading one interactively."
8703 (interactive "P")
8704 (let* ((wcf (current-window-configuration))
8705 (region (if (org-region-active-p)
8706 (buffer-substring (region-beginning) (region-end))))
8707 (remove (and region (list (region-beginning) (region-end))))
8708 (desc region)
8709 tmphist ; byte-compile incorrectly complains about this
8710 (link link-location)
8711 entry file all-prefixes)
8712 (cond
8713 (link-location) ; specified by arg, just use it.
8714 ((org-in-regexp org-bracket-link-regexp 1)
8715 ;; We do have a link at point, and we are going to edit it.
8716 (setq remove (list (match-beginning 0) (match-end 0)))
8717 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8718 (setq link (read-string "Link: "
8719 (org-link-unescape
8720 (org-match-string-no-properties 1)))))
8721 ((or (org-in-regexp org-angle-link-re)
8722 (org-in-regexp org-plain-link-re))
8723 ;; Convert to bracket link
8724 (setq remove (list (match-beginning 0) (match-end 0))
8725 link (read-string "Link: "
8726 (org-remove-angle-brackets (match-string 0)))))
8727 ((member complete-file '((4) (16)))
8728 ;; Completing read for file names.
8729 (setq link (org-file-complete-link complete-file)))
8730 (t
8731 ;; Read link, with completion for stored links.
8732 (with-output-to-temp-buffer "*Org Links*"
8733 (princ "Insert a link.
8735 (when org-stored-links
8737 (princ (mapconcat
8738 (lambda (x)
8739 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8741 (let ((cw (selected-window)))
8742 (select-window (get-buffer-window "*Org Links*" 'visible))
8743 (setq truncate-lines t)
8744 (unless (pos-visible-in-window-p (point-max))
8745 (org-fit-window-to-buffer))
8746 (and (window-live-p cw) (select-window cw)))
8747 ;; Fake a link history, containing the stored links.
8748 (setq tmphist (append (mapcar 'car org-stored-links)
8749 org-insert-link-history))
8750 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8751 (mapcar 'car org-link-abbrev-alist)
8752 org-link-types))
8753 (unwind-protect
8754 (progn
8755 (setq link
8756 (let ((org-completion-use-ido nil)
8757 (org-completion-use-iswitchb nil))
8758 (org-completing-read
8759 "Link: "
8760 (append
8761 (mapcar (lambda (x) (list (concat x ":")))
8762 all-prefixes)
8763 (mapcar 'car org-stored-links))
8764 nil nil nil
8765 'tmphist
8766 (car (car org-stored-links)))))
8768 (error "No link selected"))
8769 (if (or (member link all-prefixes)
8770 (and (equal ":" (substring link -1))
8771 (member (substring link 0 -1) all-prefixes)
8772 (setq link (substring link 0 -1))))
8773 (setq link (org-link-try-special-completion link))))
8774 (set-window-configuration wcf)
8775 (kill-buffer "*Org Links*"))
8776 (setq entry (assoc link org-stored-links))
8777 (or entry (push link org-insert-link-history))
8778 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8779 (not org-keep-stored-link-after-insertion))
8780 (setq org-stored-links (delq (assoc link org-stored-links)
8781 org-stored-links)))
8782 (setq desc (or desc (nth 1 entry)))))
8784 (if (string-match org-plain-link-re link)
8785 ;; URL-like link, normalize the use of angular brackets.
8786 (setq link (org-make-link (org-remove-angle-brackets link))))
8788 ;; Check if we are linking to the current file with a search option
8789 ;; If yes, simplify the link by using only the search option.
8790 (when (and buffer-file-name
8792 (let* ((path (match-string 1 link))
8793 (case-fold-search nil)
8794 (search (match-string 2 link)))
8795 (save-match-data
8796 (if (equal (file-truename buffer-file-name) (file-truename path))
8797 ;; We are linking to this same file, with a search option
8798 (setq link search)))))
8800 ;; Check if we can/should use a relative path. If yes, simplify the link
8802 (let* ((type (match-string 1 link))
8803 (path (match-string 2 link))
8804 (origpath path)
8805 (case-fold-search nil))
8806 (cond
8807 ((or (eq org-link-file-path-type 'absolute)
8808 (equal complete-file '(16)))
8809 (setq path (abbreviate-file-name (expand-file-name path))))
8810 ((eq org-link-file-path-type 'noabbrev)
8811 (setq path (expand-file-name path)))
8812 ((eq org-link-file-path-type 'relative)
8813 (setq path (file-relative-name path)))
8814 (t
8815 (save-match-data
8816 (if (string-match (concat "^" (regexp-quote
8817 (expand-file-name
8818 (file-name-as-directory
8819 default-directory))))
8820 (expand-file-name path))
8821 ;; We are linking a file with relative path name.
8822 (setq path (substring (expand-file-name path)
8823 (match-end 0)))
8824 (setq path (abbreviate-file-name (expand-file-name path)))))))
8825 (setq link (concat type path))
8826 (if (equal desc origpath)
8827 (setq desc path))))
8829 (if org-make-link-description-function
8830 (setq desc (funcall org-make-link-description-function link desc)))
8832 (setq desc (read-string "Description: " desc))
8834 (if remove (apply 'delete-region remove))
8835 (insert (org-make-link-string link desc))))
8837 (defun org-link-try-special-completion (type)
8838 "If there is completion support for link type TYPE, offer it."
8839 (let ((fun (intern (concat "org-" type "-complete-link"))))
8840 (if (functionp fun)
8841 (funcall fun)
8842 (read-string "Link (no completion support): " (concat type ":")))))
8844 (defun org-file-complete-link (&optional arg)
8845 "Create a file link using completion."
8846 (let (file link)
8847 (setq file (read-file-name "File: "))
8848 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8849 (pwd1 (file-name-as-directory (abbreviate-file-name
8850 (expand-file-name ".")))))
8851 (cond
8852 ((equal arg '(16))
8853 (setq link (org-make-link
8854 "file:"
8855 (abbreviate-file-name (expand-file-name file)))))
8857 (setq link (org-make-link "file:" (match-string 1 file))))
8859 (expand-file-name file))
8860 (setq link (org-make-link
8861 "file:" (match-string 1 (expand-file-name file)))))
8862 (t (setq link (org-make-link "file:" file)))))
8863 link))
8865 (defun org-completing-read (&rest args)
8866 "Completing-read with SPACE being a normal character."
8867 (let ((minibuffer-local-completion-map
8868 (copy-keymap minibuffer-local-completion-map)))
8869 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
8870 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
8871 (apply 'org-icompleting-read args)))
8873 (defun org-completing-read-no-i (&rest args)
8874 (let (org-completion-use-ido org-completion-use-iswitchb)
8875 (apply 'org-completing-read args)))
8877 (defun org-iswitchb-completing-read (prompt choices &rest args)
8878 "Use iswitch as a completing-read replacement to choose from choices.
8879 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
8880 from."
8881 (let* ((iswitchb-use-virtual-buffers nil)
8882 (iswitchb-make-buflist-hook
8883 (lambda ()
8884 (setq iswitchb-temp-buflist choices))))
8885 (iswitchb-read-buffer prompt)))
8887 (defun org-icompleting-read (&rest args)
8888 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
8889 (org-without-partial-completion
8890 (if (and org-completion-use-ido
8891 (fboundp 'ido-completing-read)
8892 (boundp 'ido-mode) ido-mode
8893 (listp (second args)))
8894 (let ((ido-enter-matching-directory nil))
8895 (apply 'ido-completing-read (concat (car args))
8896 (if (consp (car (nth 1 args)))
8897 (mapcar (lambda (x) (car x)) (nth 1 args))
8898 (nth 1 args))
8899 (cddr args)))
8900 (if (and org-completion-use-iswitchb
8901 (boundp 'iswitchb-mode) iswitchb-mode
8902 (listp (second args)))
8903 (apply 'org-iswitchb-completing-read (concat (car args))
8904 (if (consp (car (nth 1 args)))
8905 (mapcar (lambda (x) (car x)) (nth 1 args))
8906 (nth 1 args))
8907 (cddr args))
8908 (apply 'completing-read args)))))
8910 (defun org-extract-attributes (s)
8911 "Extract the attributes cookie from a string and set as text property."
8912 (let (a attr (start 0) key value)
8913 (save-match-data
8915 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
8917 (setq key (match-string 1 a) value (match-string 2 a)
8918 start (match-end 0)
8919 attr (plist-put attr (intern key) value))))
8920 (org-add-props s nil 'org-attr attr))
8921 s))
8923 (defun org-extract-attributes-from-string (tag)
8924 (let (key value attr)
8926 (setq key (match-string 1 tag) value (match-string 2 tag)
8927 tag (replace-match "" t t tag)
8928 attr (plist-put attr (intern key) value)))
8929 (cons tag attr)))
8931 (defun org-attributes-to-string (plist)
8932 "Format a property list into an HTML attribute list."
8933 (let ((s "") key value)
8934 (while plist
8935 (setq key (pop plist) value (pop plist))
8936 (and value
8938 s))
8940 ;;; Opening/following a link
8942 (defvar org-link-search-failed nil)
8944 (defvar org-open-link-functions nil
8945 "Hook for functions finding a plain text link.
8946 These functions must take a single argument, the link content.
8947 They will be called for links that look like [[link text][description]]
8951 These functions will be called *before* Org attempts to resolve the
8952 link by doing text searches in the current buffer - so if you want a
8954 handle this as a special case.
8956 When the function does handle the link, it must return a non-nil value.
8957 If it decides that it is not responsible for this link, it must return
8958 nil to indicate that that Org-mode can continue with other options
8959 like exact and fuzzy text search.")
8961 (defun org-next-link ()
8962 "Move forward to the next link.
8963 If the link is in hidden text, expose it."
8964 (interactive)
8965 (when (and org-link-search-failed (eq this-command last-command))
8966 (goto-char (point-min))
8967 (message "Link search wrapped back to beginning of buffer"))
8968 (setq org-link-search-failed nil)
8969 (let* ((pos (point))
8970 (ct (org-context))
8971 (a (assoc :link ct)))
8972 (if a (goto-char (nth 2 a)))
8973 (if (re-search-forward org-any-link-re nil t)
8974 (progn
8975 (goto-char (match-beginning 0))
8976 (if (org-invisible-p) (org-show-context)))
8977 (goto-char pos)
8978 (setq org-link-search-failed t)
8979 (error "No further link found"))))
8981 (defun org-previous-link ()
8982 "Move backward to the previous link.
8983 If the link is in hidden text, expose it."
8984 (interactive)
8985 (when (and org-link-search-failed (eq this-command last-command))
8986 (goto-char (point-max))
8987 (message "Link search wrapped back to end of buffer"))
8988 (setq org-link-search-failed nil)
8989 (let* ((pos (point))
8990 (ct (org-context))
8991 (a (assoc :link ct)))
8992 (if a (goto-char (nth 1 a)))
8993 (if (re-search-backward org-any-link-re nil t)
8994 (progn
8995 (goto-char (match-beginning 0))
8996 (if (org-invisible-p) (org-show-context)))
8997 (goto-char pos)
8998 (setq org-link-search-failed t)
8999 (error "No further link found"))))
9001 (defun org-translate-link (s)
9002 "Translate a link string if a translation function has been defined."
9003 (if (and org-link-translation-function
9004 (fboundp org-link-translation-function)
9006 (progn
9007 (setq s (funcall org-link-translation-function
9008 (match-string 1) (match-string 2)))
9009 (concat (car s) ":" (cdr s)))
9010 s))
9012 (defun org-translate-link-from-planner (type path)
9013 "Translate a link from Emacs Planner syntax so that Org can follow it.
9014 This is still an experimental function, your mileage may vary."
9015 (cond
9016 ((member type '("http" "https" "news" "ftp"))
9017 ;; standard Internet links are the same.
9018 nil)
9019 ((and (equal type "irc") (string-match "^//" path))
9020 ;; Planner has two / at the beginning of an irc link, we have 1.
9021 ;; We should have zero, actually....
9022 (setq path (substring path 1)))
9023 ((and (equal type "lisp") (string-match "^/" path))
9024 ;; Planner has a slash, we do not.
9025 (setq type "elisp" path (substring path 1)))
9027 ;; A typical message link. Planner has the id after the final slash,
9028 ;; we separate it with a hash mark
9029 (setq path (concat (match-string 1 path) "#"
9030 (org-remove-angle-brackets (match-string 2 path)))))
9031 )
9032 (cons type path))
9034 (defun org-find-file-at-mouse (ev)
9035 "Open file link or URL at mouse."
9036 (interactive "e")
9037 (mouse-set-point ev)
9038 (org-open-at-point 'in-emacs))
9040 (defun org-open-at-mouse (ev)
9041 "Open file link or URL at mouse."
9042 (interactive "e")
9043 (mouse-set-point ev)
9044 (if (eq major-mode 'org-agenda-mode)
9045 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9046 (org-open-at-point))
9048 (defvar org-window-config-before-follow-link nil
9049 "The window configuration before following a link.
9050 This is saved in case the need arises to restore it.")
9052 (defvar org-open-link-marker (make-marker)
9053 "Marker pointing to the location where `org-open-at-point; was called.")
9055 ;;;###autoload
9056 (defun org-open-at-point-global ()
9057 "Follow a link like Org-mode does.
9058 This command can be called in any mode to follow a link that has
9059 Org-mode syntax."
9060 (interactive)
9061 (org-run-like-in-org-mode 'org-open-at-point))
9063 ;;;###autoload
9064 (defun org-open-link-from-string (s &optional arg reference-buffer)
9065 "Open a link in the string S, as if it was in Org-mode."
9067 (let ((reference-buffer (or reference-buffer (current-buffer))))
9068 (with-temp-buffer
9069 (let ((org-inhibit-startup t))
9070 (org-mode)
9071 (insert s)
9072 (goto-char (point-min))
9073 (when reference-buffer
9074 (setq org-link-abbrev-alist-local
9075 (with-current-buffer reference-buffer
9076 org-link-abbrev-alist-local)))
9077 (org-open-at-point arg reference-buffer)))))
9079 (defvar org-open-at-point-functions nil
9080 "Hook that is run when following a link at point.
9082 Functions in this hook must return t if they identify and follow
9083 a link at point. If they don't find anything interesting at point,
9084 they must return nil.")
9086 (defun org-open-at-point (&optional in-emacs reference-buffer)
9087 "Open link at or after point.
9088 If there is no link at point, this function will search forward up to
9089 the end of the current line.
9090 Normally, files will be opened by an appropriate application. If the
9091 optional argument IN-EMACS is non-nil, Emacs will visit the file.
9092 With a double prefix argument, try to open outside of Emacs, in the
9093 application the system uses for this file type."
9094 (interactive "P")
9095 ;; if in a code block, then open the block's results
9096 (unless (call-interactively #'org-babel-open-src-block-result)
9097 (org-load-modules-maybe)
9098 (move-marker org-open-link-marker (point))
9099 (setq org-window-config-before-follow-link (current-window-configuration))
9100 (org-remove-occur-highlights nil nil t)
9101 (cond
9102 ((and (org-on-heading-p)
9103 (not (org-in-regexp
9108 (not (get-text-property (point) 'org-linked-text)))
9109 (or (org-offer-links-in-entry in-emacs)
9110 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9111 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9112 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9113 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9114 (not (org-in-regexp org-bracket-link-regexp)))
9115 (org-footnote-action))
9116 (t
9117 (let (type path link line search (pos (point)))
9118 (catch 'match
9119 (save-excursion
9121 (when (org-in-regexp org-bracket-link-regexp 1)
9122 (setq link (org-extract-attributes
9123 (org-link-unescape (org-match-string-no-properties 1))))
9125 (setq link (replace-match " " t t link)))
9126 (setq link (org-link-expand-abbrev link))
9127 (cond
9128 ((or (file-name-absolute-p link)
9130 (setq type "file" path link))
9131 ((string-match org-link-re-with-space3 link)
9132 (setq type (match-string 1 link) path (match-string 2 link)))
9133 (t (setq type "thisfile" path link)))
9134 (throw 'match t)))
9136 (when (get-text-property (point) 'org-linked-text)
9137 (setq type "thisfile"
9138 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9139 (1+ (point)) (point))
9140 path (buffer-substring
9141 (previous-single-property-change pos 'org-linked-text)
9142 (next-single-property-change pos 'org-linked-text)))
9143 (throw 'match t))
9145 (save-excursion
9146 (when (or (org-in-regexp org-angle-link-re)
9147 (org-in-regexp org-plain-link-re))
9148 (setq type (match-string 1) path (match-string 2))
9149 (throw 'match t)))
9150 (save-excursion
9152 (setq type "tags"
9153 path (match-string 1))
9154 (while (string-match ":" path)
9155 (setq path (replace-match "+" t t path)))
9156 (throw 'match t)))
9158 (setq type "tree-match"
9159 path (match-string 1))
9160 (throw 'match t)))
9161 (unless path
9162 (error "No link found"))
9164 ;; switch back to reference buffer
9165 ;; needed when if called in a temporary buffer through
9166 ;; org-open-link-from-string
9167 (with-current-buffer (or reference-buffer (current-buffer))
9169 ;; Remove any trailing spaces in path
9171 (setq path (replace-match "" t t path)))
9172 (if (and org-link-translation-function
9173 (fboundp org-link-translation-function))
9174 ;; Check if we need to translate the link
9175 (let ((tmp (funcall org-link-translation-function type path)))
9176 (setq type (car tmp) path (cdr tmp))))
9178 (cond
9180 ((assoc type org-link-protocols)
9181 (funcall (nth 1 (assoc type org-link-protocols)) path))
9183 ((equal type "mailto")
9184 (let ((cmd (car org-link-mailto-program))
9185 (args (cdr org-link-mailto-program)) args1
9186 (address path) (subject "") a)
9188 (setq address (match-string 1 path)
9189 subject (org-link-escape (match-string 2 path))))
9190 (while args
9191 (cond
9192 ((not (stringp (car args))) (push (pop args) args1))
9193 (t (setq a (pop args))
9194 (if (string-match "%a" a)
9195 (setq a (replace-match address t t a)))
9196 (if (string-match "%s" a)
9197 (setq a (replace-match subject t t a)))
9198 (push a args1))))
9199 (apply cmd (nreverse args1))))
9201 ((member type '("http" "https" "ftp" "news"))
9202 (browse-url (concat type ":" (org-link-escape
9203 path org-link-escape-chars-browser))))
9205 ((string= type "doi")
9206 (browse-url (concat "http://dx.doi.org/"
9207 (org-link-escape
9208 path org-link-escape-chars-browser))))
9210 ((member type '("message"))
9211 (browse-url (concat type ":" path)))
9213 ((string= type "tags")
9214 (org-tags-view in-emacs path))
9216 ((string= type "tree-match")
9219 ((string= type "file")
9221 (setq line (string-to-number (match-string 1 path))
9222 path (substring path 0 (match-beginning 0)))
9224 (setq search (match-string 1 path)
9225 path (substring path 0 (match-beginning 0)))))
9226 (if (string-match "[*?{]" (file-name-nondirectory path))
9227 (dired path)
9228 (org-open-file path in-emacs line search)))
9230 ((string= type "shell")
9231 (let ((cmd path))
9232 (if (or (not org-confirm-shell-link-function)
9233 (funcall org-confirm-shell-link-function
9235 (org-add-props cmd nil
9236 'face 'org-warning))))
9237 (progn
9238 (message "Executing %s" cmd)
9239 (shell-command cmd))
9240 (error "Abort"))))
9242 ((string= type "elisp")
9243 (let ((cmd path))
9244 (if (or (not org-confirm-elisp-link-function)
9245 (funcall org-confirm-elisp-link-function
9247 (org-add-props cmd nil
9248 'face 'org-warning))))
9249 (message "%s => %s" cmd
9250 (if (equal (string-to-char cmd) ?\()
9251 (eval (read cmd))
9252 (call-interactively (read cmd))))
9253 (error "Abort"))))
9255 ((and (string= type "thisfile")
9256 (run-hook-with-args-until-success
9257 'org-open-link-functions path)))
9259 ((string= type "thisfile")
9260 (if in-emacs
9261 (switch-to-buffer-other-window
9262 (org-get-buffer-for-internal-link (current-buffer)))
9263 (org-mark-ring-push))
9264 (let ((cmd `(org-link-search
9265 ,path
9266 ,(cond ((equal in-emacs '(4)) 'occur)
9267 ((equal in-emacs '(16)) 'org-occur)
9268 (t nil))
9269 ,pos)))
9270 (condition-case nil (eval cmd)
9271 (error (progn (widen) (eval cmd))))))
9273 (t
9274 (browse-url-at-point)))))))
9275 (move-marker org-open-link-marker nil)
9276 (run-hook-with-args 'org-follow-link-hook)))
9278 (defun org-offer-links-in-entry (&optional nth zero)
9279 "Offer links in the current entry and follow the selected link.
9280 If there is only one link, follow it immediately as well.
9281 If NTH is an integer, immediately pick the NTH link found.
9282 If ZERO is a string, check also this string for a link, and if
9283 there is one, offer it as link number zero."
9287 (cnt ?0)
9288 (in-emacs (if (integerp nth) nil nth))
9289 have-zero end links link c)
9290 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9291 (push (match-string 0 zero) links)
9292 (setq cnt (1- cnt) have-zero t))
9293 (save-excursion
9294 (org-back-to-heading t)
9295 (setq end (save-excursion (outline-next-heading) (point)))
9296 (while (re-search-forward re end t)
9297 (push (match-string 0) links))
9298 (setq links (org-uniquify (reverse links))))
9300 (cond
9301 ((null links)
9302 (message "No links"))
9303 ((equal (length links) 1)
9304 (setq link (list (car links))))
9305 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9306 (setq link (nth (if have-zero nth (1- nth)) links)))
9307 (t ; we have to select a link
9308 (save-excursion
9309 (save-window-excursion
9310 (delete-other-windows)
9311 (with-output-to-temp-buffer "*Select Link*"
9312 (mapc (lambda (l)
9313 (if (not (string-match org-bracket-link-regexp l))
9315 (org-remove-angle-brackets l)))
9316 (if (match-end 3)
9318 (match-string 3 l) (match-string 1 l)))
9320 (match-string 1 l))))))
9321 links))
9322 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9323 (message "Select link to open, RET to open all:")
9324 (setq c (read-char-exclusive))
9325 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9326 (when (equal c ?q) (error "Abort"))
9327 (if (equal c ?\C-m)
9328 (setq link links)
9329 (setq nth (- c ?0))
9330 (if have-zero (setq nth (1+ nth)))
9331 (unless (and (integerp nth) (>= (length links) nth))
9332 (error "Invalid link selection"))
9333 (setq link (list (nth (1- nth) links))))))
9334 (if link
9335 (let ((buf (current-buffer)))
9336 (dolist (l link)
9337 (org-open-link-from-string l in-emacs buf))
9338 t)
9339 nil)))
9341 ;; Add special file links that specify the way of opening
9343 (org-add-link-type "file+sys" 'org-open-file-with-system)
9344 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9345 (defun org-open-file-with-system (path)
9346 "Open file at PATH using the system way of opening it."
9347 (org-open-file path 'system))
9348 (defun org-open-file-with-emacs (path)
9349 "Open file at PATH in Emacs."
9350 (org-open-file path 'emacs))
9351 (defun org-remove-file-link-modifiers ()
9352 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9353 (goto-char (point-min))
9355 (org-if-unprotected
9356 (replace-match "file:" t t))))
9357 (eval-after-load "org-exp"
9358 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9359 'org-remove-file-link-modifiers))
9361 ;;;; Time estimates
9363 (defun org-get-effort (&optional pom)
9364 "Get the effort estimate for the current entry."
9365 (org-entry-get pom org-effort-property))
9367 ;;; File search
9369 (defvar org-create-file-search-functions nil
9370 "List of functions to construct the right search string for a file link.
9371 These functions are called in turn with point at the location to
9372 which the link should point.
9374 A function in the hook should first test if it would like to
9375 handle this file type, for example by checking the `major-mode'
9376 or the file extension. If it decides not to handle this file, it
9377 should just return nil to give other functions a chance. If it
9378 does handle the file, it must return the search string to be used
9379 when following the link. The search string will be part of the
9380 file link, given after a double colon, and `org-open-at-point'
9381 will automatically search for it. If special measures must be
9382 taken to make the search successful, another function should be
9383 added to the companion hook `org-execute-file-search-functions',
9384 which see.
9386 A function in this hook may also use `setq' to set the variable
9387 `description' to provide a suggestion for the descriptive text to
9388 be used for this link when it gets inserted into an Org-mode
9391 (defvar org-execute-file-search-functions nil
9392 "List of functions to execute a file search triggered by a link.
9394 Functions added to this hook must accept a single argument, the
9395 search string that was part of the file link, the part after the
9396 double colon. The function must first check if it would like to
9397 handle this search, for example by checking the `major-mode' or
9398 the file extension. If it decides not to handle this search, it
9399 should just return nil to give other functions a chance. If it
9400 does handle the search, it must return a non-nil value to keep
9401 other functions from trying.
9403 Each function can access the current prefix argument through the
9404 variable `current-prefix-argument'. Note that a single prefix is
9405 used to force opening a link in Emacs, so it may be good to only
9406 use a numeric or double prefix to guide the search function.
9408 In case this is needed, a function in this hook can also restore
9409 the window configuration before `org-open-at-point' was called using:
9411 (set-window-configuration org-window-config-before-follow-link)")
9413 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9414 (defun org-link-search (s &optional type avoid-pos)
9415 "Search for a link search option.
9416 If S is surrounded by forward slashes, it is interpreted as a
9417 regular expression. In org-mode files, this will create an `org-occur'
9418 sparse tree. In ordinary files, `occur' will be used to list matches.
9419 If the current buffer is in `dired-mode', grep will be used to search
9420 in all files. If AVOID-POS is given, ignore matches near that position."
9421 (let ((case-fold-search t)
9425 org-emphasis-alist)
9427 (pos (point))
9428 (pre nil) (post nil)
9429 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9430 (cond
9431 ;; First check if there are any special search functions
9432 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9433 ;; Now try the builtin stuff
9434 ((and (equal (string-to-char s0) ?#)
9435 (> (length s0) 1)
9436 (save-excursion
9437 (goto-char (point-min))
9438 (and
9439 (re-search-forward
9441 (setq type 'dedicated
9442 pos (match-beginning 0))))
9443 ;; There is an exact target for this
9444 (goto-char pos)
9445 (org-back-to-heading t)))
9446 ((save-excursion
9447 (goto-char (point-min))
9448 (and
9449 (re-search-forward
9450 (concat "<<" (regexp-quote s0) ">>") nil t)
9451 (setq type 'dedicated
9452 pos (match-beginning 0))))
9453 ;; There is an exact target for this
9454 (goto-char pos))
9456 (save-excursion
9457 (goto-char (point-min))
9458 (and
9459 (re-search-forward
9460 (concat "[^[]" (regexp-quote
9461 (format org-coderef-label-format
9462 (match-string 1 s0))))
9463 nil t)
9464 (setq type 'dedicated
9465 pos (1+ (match-beginning 0))))))
9466 ;; There is a coderef target for this
9467 (goto-char pos))
9469 ;; A regular expression
9470 (cond
9471 ((org-mode-p)
9472 (org-occur (match-string 1 s)))
9473 ;;((eq major-mode 'dired-mode)
9474 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9475 (t (org-do-occur (match-string 1 s)))))
9476 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9477 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9478 (goto-char (point-min))
9479 (cond
9480 ((let (case-fold-search)
9481 (re-search-forward (format org-complex-heading-regexp-format
9482 (regexp-quote s))
9483 nil t))
9484 ;; OK, found a match
9485 (setq type 'dedicated)
9486 (goto-char (match-beginning 0)))
9487 ((and (not org-link-search-inhibit-query)
9488 (eq org-link-search-must-match-exact-headline 'query-to-create)
9489 (y-or-n-p "No match - create this as a new heading? "))
9490 (goto-char (point-max))
9491 (or (bolp) (newline))
9493 (beginning-of-line 0))
9494 (t
9495 (goto-char pos)
9496 (error "No match"))))
9497 (t
9498 ;; A normal search string
9499 (when (equal (string-to-char s) ?*)
9500 ;; Anchor on headlines, post may include tags.
9503 s (substring s 1)))
9504 (remove-text-properties
9505 0 (length s)
9506 '(face nil mouse-face nil keymap nil fontified nil) s)
9507 ;; Make a series of regular expressions to find a match
9516 re4 (concat "[^a-zA-Z_]" re4_)
9518 re1 (concat pre re2 post)
9519 re3 (concat pre (if pre re4_ re4) post)
9520 re5 (concat pre ".*" re4)
9521 re2 (concat pre re2)
9522 re2a (concat pre (if pre re2a_ re2a))
9523 re4 (concat pre (if pre re4_ re4))
9527 ))
9528 (cond
9529 ((eq type 'org-occur) (org-occur reall))
9530 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9531 (t (goto-char (point-min))
9532 (setq type 'fuzzy)
9533 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9534 (org-search-not-self 1 re1 nil t)
9535 (org-search-not-self 1 re2 nil t)
9536 (org-search-not-self 1 re2a nil t)
9537 (org-search-not-self 1 re3 nil t)
9538 (org-search-not-self 1 re4 nil t)
9539 (org-search-not-self 1 re5 nil t)
9540 )
9541 (goto-char (match-beginning 1))
9542 (goto-char pos)
9543 (error "No match"))))))
9544 (and (org-mode-p) (org-show-context 'link-search))
9545 type))
9547 (defun org-search-not-self (group &rest args)
9548 "Execute `re-search-forward', but only accept matches that do not
9549 enclose the position of `org-open-link-marker'."
9550 (let ((m org-open-link-marker))
9551 (catch 'exit
9552 (while (apply 're-search-forward args)
9553 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9554 (goto-char (match-end group))
9555 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9556 (> (match-beginning 0) (marker-position m))
9557 (< (match-end 0) (marker-position m)))
9558 (save-match-data
9559 (or (not (org-in-regexp
9560 org-bracket-link-analytic-regexp 1))
9561 (not (match-end 4)) ; no description
9562 (and (<= (match-beginning 4) (point))
9563 (>= (match-end 4) (point))))))
9564 (throw 'exit (point))))))))
9566 (defun org-get-buffer-for-internal-link (buffer)
9567 "Return a buffer to be used for displaying the link target of internal links."
9568 (cond
9569 ((not org-display-internal-link-with-indirect-buffer)
9570 buffer)
9571 ((string-match "(Clone)$" (buffer-name buffer))
9572 (message "Buffer is already a clone, not making another one")
9573 ;; we also do not modify visibility in this case
9574 buffer)
9575 (t ; make a new indirect buffer for displaying the link
9576 (let* ((bn (buffer-name buffer))
9577 (ibn (concat bn "(Clone)"))
9578 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9579 (with-current-buffer ib (org-overview))
9580 ib))))
9582 (defun org-do-occur (regexp &optional cleanup)
9583 "Call the Emacs command `occur'.
9584 If CLEANUP is non-nil, remove the printout of the regular expression
9585 in the *Occur* buffer. This is useful if the regex is long and not useful
9586 to read."
9587 (occur regexp)
9588 (when cleanup
9589 (let ((cwin (selected-window)) win beg end)
9590 (when (setq win (get-buffer-window "*Occur*"))
9591 (select-window win))
9592 (goto-char (point-min))
9593 (when (re-search-forward "match[a-z]+" nil t)
9594 (setq beg (match-end 0))
9596 (setq end (1- (match-beginning 0)))))
9597 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9598 (goto-char (point-min))
9599 (select-window cwin))))
9601 ;;; The mark ring for links jumps
9603 (defvar org-mark-ring nil
9604 "Mark ring for positions before jumps in Org-mode.")
9605 (defvar org-mark-ring-last-goto nil
9606 "Last position in the mark ring used to go back.")
9607 ;; Fill and close the ring
9608 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9609 (loop for i from 1 to org-mark-ring-length do
9610 (push (make-marker) org-mark-ring))
9611 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9612 org-mark-ring)
9614 (defun org-mark-ring-push (&optional pos buffer)
9615 "Put the current position or POS into the mark ring and rotate it."
9616 (interactive)
9617 (setq pos (or pos (point)))
9618 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9619 (move-marker (car org-mark-ring)
9620 (or pos (point))
9621 (or buffer (current-buffer)))
9622 (message "%s"
9623 (substitute-command-keys
9626 (defun org-mark-ring-goto (&optional n)
9627 "Jump to the previous position in the mark ring.
9628 With prefix arg N, jump back that many stored positions. When
9629 called several times in succession, walk through the entire ring.
9630 Org-mode commands jumping to a different position in the current file,
9631 or to another Org-mode file, automatically push the old position
9632 onto the ring."
9633 (interactive "p")
9634 (let (p m)
9635 (if (eq last-command this-command)
9636 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9637 (setq p org-mark-ring))
9638 (setq org-mark-ring-last-goto p)
9639 (setq m (car p))
9640 (switch-to-buffer (marker-buffer m))
9641 (goto-char m)
9642 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9644 (defun org-remove-angle-brackets (s)
9645 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9646 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9647 s)
9648 (defun org-add-angle-brackets (s)
9649 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9650 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9651 s)
9652 (defun org-remove-double-quotes (s)
9655 s)
9657 ;;; Following specific links
9659 (defun org-follow-timestamp-link ()
9660 (cond
9661 ((org-at-date-range-p t)
9662 (let ((org-agenda-start-on-weekday)
9663 (t1 (match-string 1))
9664 (t2 (match-string 2)))
9665 (setq t1 (time-to-days (org-time-string-to-time t1))
9666 t2 (time-to-days (org-time-string-to-time t2)))
9667 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9668 ((org-at-timestamp-p t)
9669 (org-agenda-list nil (time-to-days (org-time-string-to-time
9670 (substring (match-string 1) 0 10)))
9671 1))
9672 (t (error "This should not happen"))))
9675 ;;; Following file links
9676 (defvar org-wait nil)
9677 (defun org-open-file (path &optional in-emacs line search)
9678 "Open the file at PATH.
9679 First, this expands any special file name abbreviations. Then the
9680 configuration variable `org-file-apps' is checked if it contains an
9681 entry for this file type, and if yes, the corresponding command is launched.
9683 If no application is found, Emacs simply visits the file.
9685 With optional prefix argument IN-EMACS, Emacs will visit the file.
9687 prefix arg, Org tries to avoid opening in Emacs
9688 and to use an external application to visit the file.
9690 Optional LINE specifies a line to go to, optional SEARCH a string
9691 to search for. If LINE or SEARCH is given, the file will be
9692 opened in Emacs, unless an entry from org-file-apps that makes
9693 use of groups in a regexp matches.
9694 If the file does not exist, an error is thrown."
9695 (let* ((file (if (equal path "")
9696 buffer-file-name
9697 (substitute-in-file-name (expand-file-name path))))
9698 (file-apps (append org-file-apps (org-default-apps)))
9699 (apps (org-remove-if
9700 'org-file-apps-entry-match-against-dlink-p file-apps))
9701 (apps-dlink (org-remove-if-not
9702 'org-file-apps-entry-match-against-dlink-p file-apps))
9703 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9704 (dirp (if remp nil (file-directory-p file)))
9705 (file (if (and dirp org-open-directory-means-index-dot-org)
9706 (concat (file-name-as-directory file) "index.org")
9707 file))
9708 (a-m-a-p (assq 'auto-mode apps))
9709 (dfile (downcase file))
9710 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9711 (link (cond ((and (eq line nil)
9712 (eq search nil))
9713 file)
9714 (line
9715 (concat file "::" (number-to-string line)))
9716 (search
9717 (concat file "::" search))))
9718 (dlink (downcase link))
9719 (old-buffer (current-buffer))
9720 (old-pos (point))
9721 (old-mode major-mode)
9722 ext cmd link-match-data)
9724 (setq ext (match-string 1 dfile))
9726 (setq ext (match-string 1 dfile))))
9727 (cond
9728 ((member in-emacs '((16) system))
9729 (setq cmd (cdr (assoc 'system apps))))
9730 (in-emacs (setq cmd 'emacs))
9731 (t
9732 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9733 (and dirp (cdr (assoc 'directory apps)))
9734 ; first, try matching against apps-dlink
9735 ; if we get a match here, store the match data for later
9736 (let ((match (assoc-default dlink apps-dlink
9737 'string-match)))
9738 (if match
9739 (progn (setq link-match-data (match-data))
9740 match)
9741 (progn (setq in-emacs (or in-emacs line search))
9742 nil))) ; if we have no match in apps-dlink,
9743 ; always open the file in emacs if line or search
9744 ; is given (for backwards compatibility)
9745 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9746 'string-match)
9747 (cdr (assoc ext apps))
9748 (cdr (assoc t apps))))))
9749 (when (eq cmd 'system)
9750 (setq cmd (cdr (assoc 'system apps))))
9751 (when (eq cmd 'default)
9752 (setq cmd (cdr (assoc t apps))))
9753 (when (eq cmd 'mailcap)
9754 (require 'mailcap)
9755 (mailcap-parse-mailcaps)
9756 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9757 (command (mailcap-mime-info mime-type)))
9758 (if (stringp command)
9759 (setq cmd command)
9760 (setq cmd 'emacs))))
9761 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9762 (not (file-exists-p file))
9763 (not org-open-non-existing-files))
9764 (error "No such file: %s" file))
9765 (cond
9767 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9769 (setq cmd (replace-match "%s" t t cmd)))
9770 (while (string-match "%s" cmd)
9771 (setq cmd (replace-match
9772 (save-match-data
9773 (shell-quote-argument
9774 (convert-standard-filename file)))
9775 t t cmd)))
9777 ;; Replace "%1", "%2" etc. in command with group matches from regex
9778 (save-match-data
9779 (let ((match-index 1)
9780 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9781 (set-match-data link-match-data)
9782 (while (<= match-index number-of-groups)
9783 (let ((regex (concat "%" (number-to-string match-index)))
9784 (replace-with (match-string match-index dlink)))
9785 (while (string-match regex cmd)
9786 (setq cmd (replace-match replace-with t t cmd))))
9787 (setq match-index (+ match-index 1)))))
9789 (save-window-excursion
9790 (start-process-shell-command cmd nil cmd)
9791 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9792 ))
9793 ((or (stringp cmd)
9794 (eq cmd 'emacs))
9795 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9796 (widen)
9797 (if line (org-goto-line line)
9798 (if search (org-link-search search))))
9799 ((consp cmd)
9800 (let ((file (convert-standard-filename file)))
9801 (save-match-data
9802 (set-match-data link-match-data)
9803 (eval cmd))))
9804 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9805 (and (org-mode-p) (eq old-mode 'org-mode)
9806 (or (not (equal old-buffer (current-buffer)))
9807 (not (equal old-pos (point))))
9808 (org-mark-ring-push old-pos old-buffer))))
9810 (defun org-file-apps-entry-match-against-dlink-p (entry)
9811 "This function returns non-nil if `entry' uses a regular
9812 expression which should be matched against the whole link by
9813 org-open-file.
9815 It assumes that is the case when the entry uses a regular
9816 expression which has at least one grouping construct and the
9817 action is either a lisp form or a command string containing
9818 '%1', i.e. using at least one subexpression match as a
9819 parameter."
9820 (let ((selector (car entry))
9821 (action (cdr entry)))
9822 (if (stringp selector)
9823 (and (> (regexp-opt-depth selector) 0)
9824 (or (and (stringp action)
9825 (string-match "%[0-9]" action))
9826 (consp action)))
9827 nil)))
9829 (defun org-default-apps ()
9830 "Return the default applications for this operating system."
9831 (cond
9832 ((eq system-type 'darwin)
9833 org-file-apps-defaults-macosx)
9834 ((eq system-type 'windows-nt)
9835 org-file-apps-defaults-windowsnt)
9836 (t org-file-apps-defaults-gnu)))
9838 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9839 "Convert extensions to regular expressions in the cars of LIST.
9840 Also, weed out any non-string entries, because the return value is used
9841 only for regexp matching.
9842 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9843 point to the symbol `emacs', indicating that the file should
9844 be opened in Emacs."
9845 (append
9846 (delq nil
9847 (mapcar (lambda (x)
9848 (if (not (stringp (car x)))
9849 nil
9851 x
9853 list))
9854 (if add-auto-mode
9855 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9857 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9858 (defun org-file-remote-p (file)
9859 "Test whether FILE specifies a location on a remote system.
9860 Return non-nil if the location is indeed remote.
9864 (cond ((fboundp 'file-remote-p)
9865 (file-remote-p file))
9866 ((fboundp 'tramp-handle-file-remote-p)
9867 (tramp-handle-file-remote-p file))
9868 ((and (boundp 'ange-ftp-name-format)
9869 (string-match (car ange-ftp-name-format) file))
9870 t)
9871 (t nil)))
9874 ;;;; Refiling
9876 (defun org-get-org-file ()
9877 "Read a filename, with default directory `org-directory'."
9878 (let ((default (or org-default-notes-file remember-data-file)))
9879 (read-file-name (format "File name [%s]: " default)
9880 (file-name-as-directory org-directory)
9881 default)))
9883 (defun org-notes-order-reversed-p ()
9884 "Check if the current file should receive notes in reversed order."
9885 (cond
9886 ((not org-reverse-note-order) nil)
9887 ((eq t org-reverse-note-order) t)
9888 ((not (listp org-reverse-note-order)) nil)
9889 (t (catch 'exit
9890 (let ((all org-reverse-note-order)
9891 entry)
9892 (while (setq entry (pop all))
9893 (if (string-match (car entry) buffer-file-name)
9894 (throw 'exit (cdr entry))))
9895 nil)))))
9897 (defvar org-refile-target-table nil
9898 "The list of refile targets, created by `org-refile'.")
9900 (defvar org-agenda-new-buffers nil
9901 "Buffers created to visit agenda files.")
9903 (defvar org-refile-cache nil
9904 "Cache for refile targets.")
9907 (defvar org-refile-markers nil
9908 "All the markers used for caching refile locations.")
9910 (defun org-refile-marker (pos)
9911 "Get a new refile marker, but only if caching is in use."
9912 (if (not org-refile-use-cache)
9913 pos
9914 (let ((m (make-marker)))
9915 (move-marker m pos)
9916 (push m org-refile-markers)
9917 m)))
9919 (defun org-refile-cache-clear ()
9920 "Clear the refile cache and disable all the markers."
9921 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
9922 (setq org-refile-markers nil)
9923 (setq org-refile-cache nil)
9924 (message "Refile cache has been cleared"))
9926 (defun org-refile-cache-check-set (set)
9927 "Check if all the markers in the cache still have live buffers."
9928 (let (marker)
9929 (catch 'exit
9930 (while (and set (setq marker (nth 3 (pop set))))
9931 ;; if org-refile-use-outline-path is 'file, marker may be nil
9932 (when (and marker (null (marker-buffer marker)))
9933 (message "not found") (sit-for 3)
9934 (throw 'exit nil)))
9935 t)))
9937 (defun org-refile-cache-put (set &rest identifiers)
9938 "Push the refile targets SET into the cache, under IDENTIFIERS."
9939 (let* ((key (sha1 (prin1-to-string identifiers)))
9940 (entry (assoc key org-refile-cache)))
9941 (if entry
9942 (setcdr entry set)
9943 (push (cons key set) org-refile-cache))))
9945 (defun org-refile-cache-get (&rest identifiers)
9946 "Retrieve the cached value for refile targets given by IDENTIFIERS."
9947 (cond
9948 ((not org-refile-cache) nil)
9949 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
9950 (t
9951 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
9952 org-refile-cache))))
9953 (and set (org-refile-cache-check-set set) set)))))
9955 (defun org-get-refile-targets (&optional default-buffer)
9956 "Produce a table with refile targets."
9957 (let ((case-fold-search nil)
9958 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
9959 (entries (or org-refile-targets '((nil . (:level . 1)))))
9960 targets tgs txt re files f desc descre fast-path-p level pos0)
9961 (message "Getting targets...")
9962 (with-current-buffer (or default-buffer (current-buffer))
9963 (while (setq entry (pop entries))
9964 (setq files (car entry) desc (cdr entry))
9965 (setq fast-path-p nil)
9966 (cond
9967 ((null files) (setq files (list (current-buffer))))
9968 ((eq files 'org-agenda-files)
9969 (setq files (org-agenda-files 'unrestricted)))
9970 ((and (symbolp files) (fboundp files))
9971 (setq files (funcall files)))
9972 ((and (symbolp files) (boundp files))
9973 (setq files (symbol-value files))))
9974 (if (stringp files) (setq files (list files)))
9975 (cond
9976 ((eq (car desc) :tag)
9978 ((eq (car desc) :todo)
9980 ((eq (car desc) :regexp)
9981 (setq descre (cdr desc)))
9982 ((eq (car desc) :level)
9984 (if org-odd-levels-only
9985 (1- (* 2 (cdr desc)))
9986 (cdr desc)))
9988 ((eq (car desc) :maxlevel)
9989 (setq fast-path-p t)
9991 (if org-odd-levels-only
9992 (1- (* 2 (cdr desc)))
9993 (cdr desc)))
9995 (t (error "Bad refiling target description %s" desc)))
9996 (while (setq f (pop files))
9997 (with-current-buffer
9998 (if (bufferp f) f (org-get-agenda-file-buffer f))
9999 (or
10000 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10001 (progn
10002 (if (bufferp f) (setq f (buffer-file-name
10003 (buffer-base-buffer f))))
10004 (setq f (and f (expand-file-name f)))
10005 (if (eq org-refile-use-outline-path 'file)
10006 (push (list (file-name-nondirectory f) f nil nil) tgs))
10007 (save-excursion
10008 (save-restriction
10009 (widen)
10010 (goto-char (point-min))
10011 (while (re-search-forward descre nil t)
10012 (goto-char (setq pos0 (point-at-bol)))
10013 (catch 'next
10014 (when org-refile-target-verify-function
10015 (save-match-data
10016 (or (funcall org-refile-target-verify-function)
10017 (throw 'next t))))
10018 (when (looking-at org-complex-heading-regexp)
10019 (setq level (org-reduced-level
10020 (- (match-end 1) (match-beginning 1)))
10021 txt (org-link-display-format (match-string 4))
10023 re (format org-complex-heading-regexp-format
10024 (regexp-quote (match-string 4))))
10025 (when org-refile-use-outline-path
10026 (setq txt (mapconcat
10027 'org-protect-slash
10028 (append
10029 (if (eq org-refile-use-outline-path
10030 'file)
10031 (list (file-name-nondirectory
10032 (buffer-file-name
10033 (buffer-base-buffer))))
10034 (if (eq org-refile-use-outline-path
10035 'full-file-path)
10036 (list (buffer-file-name
10037 (buffer-base-buffer)))))
10038 (org-get-outline-path fast-path-p
10039 level txt)
10040 (list txt))
10041 "/")))
10042 (push (list txt f re (org-refile-marker (point)))
10043 tgs)))
10044 (when (= (point) pos0)
10045 ;; verification function has not moved point
10046 (goto-char (point-at-eol))))))))
10047 (when org-refile-use-cache
10048 (org-refile-cache-put tgs (buffer-file-name) descre))
10049 (setq targets (append tgs targets))
10050 ))))
10051 (message "Getting targets...done")
10052 (nreverse targets)))
10054 (defun org-protect-slash (s)
10055 (while (string-match "/" s)
10057 s)
10059 (defvar org-olpa (make-vector 20 nil))
10061 (defun org-get-outline-path (&optional fastp level heading)
10062 "Return the outline path to the current entry, as a list.
10064 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10065 routine which makes outline path derivations for an entire file,
10066 avoiding backtracing. Refile target collection makes use of that."
10067 (if fastp
10068 (progn
10069 (if (> level 19)
10070 (error "Outline path failure, more than 19 levels"))
10071 (loop for i from level upto 19 do
10072 (aset org-olpa i nil))
10073 (prog1
10074 (delq nil (append org-olpa nil))
10075 (aset org-olpa level heading)))
10076 (let (rtn case-fold-search)
10077 (save-excursion
10078 (save-restriction
10079 (widen)
10080 (while (org-up-heading-safe)
10081 (when (looking-at org-complex-heading-regexp)
10082 (push (org-match-string-no-properties 4) rtn)))
10083 rtn)))))
10085 (defun org-format-outline-path (path &optional width prefix)
10086 "Format the outline path PATH for display.
10087 Width is the maximum number of characters that is available.
10088 Prefix is a prefix to be included in the returned string,
10089 such as the file name."
10090 (setq width (or width 79))
10091 (if prefix (setq width (- width (length prefix))))
10092 (if (not path)
10093 (or prefix "")
10094 (let* ((nsteps (length path))
10095 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10096 (maxwidth (if (<= total-width width)
10097 10000 ;; everything fits
10098 ;; we need to shorten the level headings
10099 (/ (- width nsteps) nsteps)))
10100 (org-odd-levels-only nil)
10101 (n 0)
10102 (total (1+ (length prefix))))
10103 (setq maxwidth (max maxwidth 10))
10104 (concat prefix
10105 (mapconcat
10106 (lambda (h)
10107 (setq n (1+ n))
10108 (if (and (= n nsteps) (< maxwidth 10000))
10109 (setq maxwidth (- total-width total)))
10110 (if (< (length h) maxwidth)
10111 (progn (setq total (+ total (length h) 1)) h)
10112 (setq h (substring h 0 (- maxwidth 2))
10113 total (+ total maxwidth 1))
10115 (setq h (substring h 0 (match-beginning 0))))
10116 (setq h (concat h "..")))
10117 (org-add-props h nil 'face
10118 (nth (% (1- n) org-n-level-faces)
10119 org-level-faces))
10120 h)
10121 path "/")))))
10123 (defun org-display-outline-path (&optional file current)
10124 "Display the current outline path in the echo area."
10125 (interactive "P")
10126 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10127 (case-fold-search nil)
10128 (path (and (org-mode-p) (org-get-outline-path))))
10129 (if current (setq path (append path
10130 (save-excursion
10131 (org-back-to-heading t)
10132 (if (looking-at org-complex-heading-regexp)
10133 (list (match-string 4)))))))
10134 (message "%s"
10135 (org-format-outline-path
10136 path
10137 (1- (frame-width))
10138 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10140 (defvar org-refile-history nil
10141 "History for refiling operations.")
10143 (defvar org-after-refile-insert-hook nil
10144 "Hook run after `org-refile' has inserted its stuff at the new location.
10145 Note that this is still *before* the stuff will be removed from
10146 the *old* location.")
10148 (defvar org-capture-last-stored-marker)
10149 (defun org-refile (&optional goto default-buffer rfloc)
10150 "Move the entry at point to another heading.
10151 The list of target headings is compiled using the information in
10152 `org-refile-targets', which see. This list is created before each use
10153 and will therefore always be up-to-date.
10155 At the target location, the entry is filed as a subitem of the target heading.
10156 Depending on `org-reverse-note-order', the new subitem will either be the
10157 first or the last subitem.
10159 If there is an active region, all entries in that region will be moved.
10160 However, the region must fulfill the requirement that the first heading
10161 is the first one sets the top-level of the moved text - at most siblings
10162 below it are allowed.
10164 With prefix arg GOTO, the command will only visit the target location,
10165 not actually move anything.
10167 go to the location where the last refiling
10168 operation has put the subtree.
10169 With a prefix argument of `2', refile to the running clock.
10171 RFLOC can be a refile location obtained in a different way.
10173 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10175 If you are using target caching (see `org-refile-use-cache'),
10176 You have to clear the target cache in order to find new targets.
10177 This can be done with a 0 prefix: `C-0 C-c C-w'"
10178 (interactive "P")
10179 (if (member goto '(0 (64)))
10180 (org-refile-cache-clear)
10181 (let* ((cbuf (current-buffer))
10182 (regionp (org-region-active-p))
10183 (region-start (and regionp (region-beginning)))
10184 (region-end (and regionp (region-end)))
10185 (region-length (and regionp (- region-end region-start)))
10186 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10187 pos it nbuf file re level reversed)
10188 (setq last-command nil)
10189 (when regionp
10190 (goto-char region-start)
10191 (or (bolp) (goto-char (point-at-bol)))
10192 (setq region-start (point))
10193 (unless (org-kill-is-subtree-p
10194 (buffer-substring region-start region-end))
10195 (error "The region is not a (sequence of) subtree(s)")))
10196 (if (equal goto '(16))
10197 (org-refile-goto-last-stored)
10198 (when (or
10199 (and (equal goto 2)
10200 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10201 (prog1
10202 (setq it (list (or org-clock-heading "running clock")
10203 (buffer-file-name
10204 (marker-buffer org-clock-hd-marker))
10205 ""
10206 (marker-position org-clock-hd-marker)))
10207 (setq goto nil)))
10208 (setq it (or rfloc
10209 (save-excursion
10210 (org-refile-get-location
10211 (if goto "Goto: " "Refile to: ") default-buffer
10212 org-refile-allow-creating-parent-nodes)))))
10213 (setq file (nth 1 it)
10214 re (nth 2 it)
10215 pos (nth 3 it))
10216 (if (and (not goto)
10217 pos
10218 (equal (buffer-file-name) file)
10219 (if regionp
10220 (and (>= pos region-start)
10221 (<= pos region-end))
10222 (and (>= pos (point))
10223 (< pos (save-excursion
10224 (org-end-of-subtree t t))))))
10225 (error "Cannot refile to position inside the tree or region"))
10227 (setq nbuf (or (find-buffer-visiting file)
10228 (find-file-noselect file)))
10229 (if goto
10230 (progn
10231 (switch-to-buffer nbuf)
10232 (goto-char pos)
10233 (org-show-context 'org-goto))
10234 (if regionp
10235 (progn
10236 (org-kill-new (buffer-substring region-start region-end))
10237 (org-save-markers-in-region region-start region-end))
10238 (org-copy-subtree 1 nil t))
10239 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10240 (find-file-noselect file)))
10241 (setq reversed (org-notes-order-reversed-p))
10242 (save-excursion
10243 (save-restriction
10244 (widen)
10245 (if pos
10246 (progn
10247 (goto-char pos)
10248 (looking-at outline-regexp)
10249 (setq level (org-get-valid-level (funcall outline-level) 1))
10250 (goto-char
10251 (if reversed
10252 (or (outline-next-heading) (point-max))
10253 (or (save-excursion (org-get-next-sibling))
10254 (org-end-of-subtree t t)
10255 (point-max)))))
10256 (setq level 1)
10257 (if (not reversed)
10258 (goto-char (point-max))
10259 (goto-char (point-min))
10260 (or (outline-next-heading) (goto-char (point-max)))))
10261 (if (not (bolp)) (newline))
10262 (org-paste-subtree level)
10263 (when org-log-refile
10264 (org-add-log-setup 'refile nil nil 'findpos
10265 org-log-refile)
10266 (unless (eq org-log-refile 'note)
10267 (save-excursion (org-add-log-note))))
10268 (and org-auto-align-tags (org-set-tags nil t))
10269 (bookmark-set "org-refile-last-stored")
10270 ;; If we are refiling for capture, make sure that the
10271 ;; last-capture pointers point here
10272 (when (org-bound-and-true-p org-refile-for-capture)
10273 (bookmark-set "org-capture-last-stored-marker")
10274 (move-marker org-capture-last-stored-marker (point)))
10275 (if (fboundp 'deactivate-mark) (deactivate-mark))
10276 (run-hooks 'org-after-refile-insert-hook))))
10277 (if regionp
10278 (delete-region (point) (+ (point) region-length))
10279 (org-cut-subtree))
10280 (when (featurep 'org-inlinetask)
10281 (org-inlinetask-remove-END-maybe))
10282 (setq org-markers-to-move nil)
10285 (defun org-refile-goto-last-stored ()
10286 "Go to the location where the last refile was stored."
10287 (interactive)
10288 (bookmark-jump "org-refile-last-stored")
10289 (message "This is the location of the last refile"))
10291 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10292 "Prompt the user for a refile location, using PROMPT."
10293 (let ((org-refile-targets org-refile-targets)
10294 (org-refile-use-outline-path org-refile-use-outline-path))
10295 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
10296 (unless org-refile-target-table
10297 (error "No refile targets"))
10298 (let* ((cbuf (current-buffer))
10299 (partial-completion-mode nil)
10300 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10301 (cfunc (if (and org-refile-use-outline-path
10302 org-outline-path-complete-in-steps)
10303 'org-olpath-completing-read
10304 'org-icompleting-read))
10305 (extra (if org-refile-use-outline-path "/" ""))
10306 (filename (and cfn (expand-file-name cfn)))
10307 (tbl (mapcar
10308 (lambda (x)
10309 (if (and (not (member org-refile-use-outline-path
10310 '(file full-file-path)))
10311 (not (equal filename (nth 1 x))))
10312 (cons (concat (car x) extra " ("
10313 (file-name-nondirectory (nth 1 x)) ")")
10314 (cdr x))
10315 (cons (concat (car x) extra) (cdr x))))
10316 org-refile-target-table))
10317 (completion-ignore-case t)
10318 pa answ parent-target child parent old-hist)
10319 (setq old-hist org-refile-history)
10320 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10321 nil 'org-refile-history))
10322 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10323 (org-refile-check-position pa)
10324 (if pa
10325 (progn
10326 (when (or (not org-refile-history)
10327 (not (eq old-hist org-refile-history))
10328 (not (equal (car pa) (car org-refile-history))))
10329 (setq org-refile-history
10330 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10331 org-refile-history
10332 (cdr org-refile-history))))
10333 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10334 (pop org-refile-history)))
10335 pa)
10337 (progn
10338 (setq parent (match-string 1 answ)
10339 child (match-string 2 answ))
10340 (setq parent-target (or (assoc parent tbl)
10341 (assoc (concat parent "/") tbl)))
10342 (when (and parent-target
10343 (or (eq new-nodes t)
10344 (and (eq new-nodes 'confirm)
10346 child)))))
10347 (org-refile-new-child parent-target child)))
10348 (error "Invalid target location")))))
10350 (defun org-refile-check-position (refile-pointer)
10351 "Check if the refile pointer matches the readline to which it points."
10352 (let* ((file (nth 1 refile-pointer))
10353 (re (nth 2 refile-pointer))
10354 (pos (nth 3 refile-pointer))
10355 buffer)
10356 (when (org-string-nw-p re)
10357 (setq buffer (if (markerp pos)
10358 (marker-buffer pos)
10359 (or (find-buffer-visiting file)
10360 (find-file-noselect file))))
10361 (with-current-buffer buffer
10362 (save-excursion
10363 (save-restriction
10364 (widen)
10365 (goto-char pos)
10366 (beginning-of-line 1)
10367 (unless (org-looking-at-p re)
10368 (error "Invalid refile position, please rebuild the cache"))))))))
10370 (defun org-refile-new-child (parent-target child)
10371 "Use refile target PARENT-TARGET to add new CHILD below it."
10372 (unless parent-target
10373 (error "Cannot find parent for new node"))
10374 (let ((file (nth 1 parent-target))
10375 (pos (nth 3 parent-target))
10376 level)
10377 (with-current-buffer (or (find-buffer-visiting file)
10378 (find-file-noselect file))
10379 (save-excursion
10380 (save-restriction
10381 (widen)
10382 (if pos
10383 (goto-char pos)
10384 (goto-char (point-max))
10385 (if (not (bolp)) (newline)))
10386 (when (looking-at outline-regexp)
10387 (setq level (funcall outline-level))
10388 (org-end-of-subtree t t))
10389 (org-back-over-empty-lines)
10391 (if pos (org-get-valid-level level 1) 1) ?*)
10393 (beginning-of-line 0)
10394 (list (concat (car parent-target) "/" child) file "" (point)))))))
10396 (defun org-olpath-completing-read (prompt collection &rest args)
10397 "Read an outline path like a file name."
10398 (let ((thetable collection)
10399 (org-completion-use-ido nil) ; does not work with ido.
10400 (org-completion-use-iswitchb nil)) ; or iswitchb
10401 (apply
10402 'org-icompleting-read prompt
10403 (lambda (string predicate &optional flag)
10404 (let (rtn r f (l (length string)))
10405 (cond
10406 ((eq flag nil)
10407 ;; try completion
10408 (try-completion string thetable))
10409 ((eq flag t)
10410 ;; all-completions
10411 (setq rtn (all-completions string thetable predicate))
10412 (mapcar
10413 (lambda (x)
10414 (setq r (substring x l))
10415 (if (string-match " ([^)]*)$" x)
10416 (setq f (match-string 0 x))
10417 (setq f ""))
10418 (if (string-match "/" r)
10419 (concat string (substring r 0 (match-end 0)) f)
10420 x))
10421 rtn))
10422 ((eq flag 'lambda)
10423 ;; exact match?
10424 (assoc string thetable)))
10425 ))
10426 args)))
10428 ;;;; Dynamic blocks
10430 (defun org-find-dblock (name)
10431 "Find the first dynamic block with name NAME in the buffer.
10432 If not found, stay at current position and return nil."
10433 (let (pos)
10434 (save-excursion
10435 (goto-char (point-min))
10437 nil t)
10438 (match-beginning 0))))
10439 (if pos (goto-char pos))
10440 pos))
10442 (defconst org-dblock-start-re
10444 "Matches the start line of a dynamic block, with parameters.")
10447 "Matches the end of a dynamic block.")
10449 (defun org-create-dblock (plist)
10450 "Create a dynamic block section, with parameters taken from PLIST.
10451 PLIST must contain a :name entry which is used as name of the block."
10453 (end-of-line 1)
10454 (newline))
10455 (let ((col (current-column))
10456 (name (plist-get plist :name)))
10457 (insert "#+BEGIN: " name)
10458 (while plist
10459 (if (eq (car plist) :name)
10460 (setq plist (cddr plist))
10461 (insert " " (prin1-to-string (pop plist)))))
10463 (beginning-of-line -2)))
10465 (defun org-prepare-dblock ()
10466 "Prepare dynamic block for refresh.
10467 This empties the block, puts the cursor at the insert position and returns
10468 the property list including an extra property :name with the block name."
10469 (unless (looking-at org-dblock-start-re)
10470 (error "Not at a dynamic block"))
10471 (let* ((begdel (1+ (match-end 0)))
10472 (name (org-no-properties (match-string 1)))
10473 (params (append (list :name name)
10474 (read (concat "(" (match-string 3) ")")))))
10475 (save-excursion
10476 (beginning-of-line 1)
10478 (setq params (plist-put params :indentation-column (current-column))))
10479 (unless (re-search-forward org-dblock-end-re nil t)
10480 (error "Dynamic block not terminated"))
10481 (setq params
10482 (append params
10483 (list :content (buffer-substring
10484 begdel (match-beginning 0)))))
10485 (delete-region begdel (match-beginning 0))
10486 (goto-char begdel)
10487 (open-line 1)
10488 params))
10490 (defun org-map-dblocks (&optional command)
10491 "Apply COMMAND to all dynamic blocks in the current buffer.
10492 If COMMAND is not given, use `org-update-dblock'."
10493 (let ((cmd (or command 'org-update-dblock)))
10494 (save-excursion
10495 (goto-char (point-min))
10496 (while (re-search-forward org-dblock-start-re nil t)
10497 (goto-char (match-beginning 0))
10498 (save-excursion
10499 (condition-case nil
10500 (funcall cmd)
10501 (error (message "Error during update of dynamic block"))))
10502 (unless (re-search-forward org-dblock-end-re nil t)
10503 (error "Dynamic block not terminated"))))))
10505 (defun org-dblock-update (&optional arg)
10506 "User command for updating dynamic blocks.
10507 Update the dynamic block at point. With prefix ARG, update all dynamic
10508 blocks in the buffer."
10509 (interactive "P")
10510 (if arg
10511 (org-update-all-dblocks)
10512 (or (looking-at org-dblock-start-re)
10513 (org-beginning-of-dblock))
10514 (org-update-dblock)))
10516 (defun org-update-dblock ()
10517 "Update the dynamic block at point.
10518 This means to empty the block, parse for parameters and then call
10519 the correct writing function."
10520 (interactive)
10521 (save-window-excursion
10522 (let* ((pos (point))
10523 (line (org-current-line))
10524 (params (org-prepare-dblock))
10525 (name (plist-get params :name))
10526 (indent (plist-get params :indentation-column))
10527 (cmd (intern (concat "org-dblock-write:" name))))
10528 (message "Updating dynamic block `%s' at line %d..." name line)
10529 (funcall cmd params)
10530 (message "Updating dynamic block `%s' at line %d...done" name line)
10531 (goto-char pos)
10532 (when (and indent (> indent 0))
10533 (setq indent (make-string indent ?\ ))
10534 (save-excursion
10535 (org-beginning-of-dblock)
10536 (forward-line 1)
10537 (while (not (looking-at org-dblock-end-re))
10538 (insert indent)
10539 (beginning-of-line 2))
10540 (when (looking-at org-dblock-end-re)
10542 (replace-match ""))
10543 (insert indent)))))))
10545 (defun org-beginning-of-dblock ()
10546 "Find the beginning of the dynamic block at point.
10547 Error if there is no such block at point."
10548 (let ((pos (point))
10549 beg)
10550 (end-of-line 1)
10551 (if (and (re-search-backward org-dblock-start-re nil t)
10552 (setq beg (match-beginning 0))
10553 (re-search-forward org-dblock-end-re nil t)
10554 (> (match-end 0) pos))
10555 (goto-char beg)
10556 (goto-char pos)
10557 (error "Not in a dynamic block"))))
10559 (defun org-update-all-dblocks ()
10560 "Update all dynamic blocks in the buffer.
10561 This function can be used in a hook."
10562 (interactive)
10563 (when (org-mode-p)
10564 (org-map-dblocks 'org-update-dblock)))
10567 ;;;; Completion
10569 (defconst org-additional-option-like-keywords
10570 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10571 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10572 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10573 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10574 "BEGIN:" "END:"
10575 "ORGTBL" "TBLFM:" "TBLNAME:"
10576 "BEGIN_EXAMPLE" "END_EXAMPLE"
10577 "BEGIN_QUOTE" "END_QUOTE"
10578 "BEGIN_VERSE" "END_VERSE"
10579 "BEGIN_CENTER" "END_CENTER"
10580 "BEGIN_SRC" "END_SRC"
10581 "BEGIN_RESULT" "END_RESULT"
10582 "SOURCE:" "SRCNAME:" "FUNCTION:"
10583 "RESULTS:"
10584 "HEADER:" "HEADERS:"
10585 "BABEL:"
10586 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10587 "CAPTION:" "LABEL:"
10588 "SETUPFILE:"
10589 "INCLUDE:"
10590 "BIND:"
10591 "MACRO:"))
10593 (defcustom org-structure-template-alist
10594 '(
10607 ("L" "#+latex: "
10611 ("H" "#+html: "
10614 ("A" "#+ascii: ")
10615 ("i" "#+include %file ?"
10617 )
10618 "Structure completion elements.
10619 This is a list of abbreviation keys and values. The value gets inserted
10620 if you type `<' followed by the key and then press the completion key,
10621 usually `M-TAB'. %file will be replaced by a file name after prompting
10622 for the file using completion.
10623 There are two templates for each key, the first uses the original Org syntax,
10624 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10625 the default when the /org-mtags.el/ module has been loaded. See also the
10626 variable `org-mtags-prefer-muse-templates'.
10627 This is an experimental feature, it is undecided if it is going to stay in."
10628 :group 'org-completion
10629 :type '(repeat
10630 (string :tag "Key")
10631 (string :tag "Template")
10632 (string :tag "Muse Template")))
10634 (defun org-try-structure-completion ()
10635 "Try to complete a structure template before point.
10637 expands them."
10638 (let ((l (buffer-substring (point-at-bol) (point)))
10639 a)
10642 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10643 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10644 (match-beginning 1)) a)
10645 t)))
10647 (defun org-complete-expand-structure-template (start cell)
10648 "Expand a structure template."
10649 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10650 (rpl (nth (if musep 2 1) cell))
10651 (ind ""))
10652 (delete-region start (point))
10654 (cond
10655 ((bolp))
10657 (setq ind (buffer-substring (point-at-bol) (point))))
10658 (t (newline))))
10659 (setq start (point))
10660 (if (string-match "%file" rpl)
10661 (setq rpl (replace-match
10662 (concat
10664 (save-match-data
10665 (abbreviate-file-name (read-file-name "Include file: ")))
10667 t t rpl)))
10670 (insert rpl)
10673 ;;;; TODO, DEADLINE, Comments
10675 (defun org-toggle-comment ()
10676 "Change the COMMENT state of an entry."
10677 (interactive)
10678 (save-excursion
10679 (org-back-to-heading)
10680 (let (case-fold-search)
10681 (if (looking-at (concat outline-regexp
10683 (replace-match "" t t nil 1)
10684 (if (looking-at outline-regexp)
10685 (progn
10686 (goto-char (match-end 0))
10687 (insert org-comment-string " ")))))))
10689 (defvar org-last-todo-state-is-todo nil
10690 "This is non-nil when the last TODO state change led to a TODO state.
10691 If the last change removed the TODO tag or switched to DONE, then
10692 this is nil.")
10694 (defvar org-setting-tags nil) ; dynamically skipped
10696 (defvar org-todo-setup-filter-hook nil
10697 "Hook for functions that pre-filter todo specs.
10698 Each function takes a todo spec and returns either nil or the spec
10699 transformed into canonical form." )
10701 (defvar org-todo-get-default-hook nil
10702 "Hook for functions that get a default item for todo.
10703 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10704 nil or a string to be used for the todo mark." )
10706 (defvar org-agenda-headline-snapshot-before-repeat)
10708 (defun org-todo (&optional arg)
10709 "Change the TODO state of an item.
10710 The state of an item is given by a keyword at the start of the heading,
10711 like
10712 *** TODO Write paper
10713 *** DONE Call mom
10715 The different keywords are specified in the variable `org-todo-keywords'.
10717 So for this example: when the item starts with TODO, it is changed to DONE.
10718 When it starts with DONE, the DONE is removed. And when neither TODO nor
10719 DONE are present, add TODO at the beginning of the heading.
10722 state.
10723 With numeric prefix arg, switch to that state.
10725 keywords (nextset).
10728 For calling through lisp, arg is also interpreted in the following way:
10729 'none -> empty state
10731 'done -> switch to DONE
10732 'nextset -> switch to the next set of keywords
10733 'previousset -> switch to the previous set of keywords
10735 really is a member of `org-todo-keywords'."
10736 (interactive "P")
10737 (if (equal arg '(16)) (setq arg 'nextset))
10738 (let ((org-blocker-hook org-blocker-hook)
10739 (case-fold-search nil))
10740 (when (equal arg '(64))
10741 (setq arg nil org-blocker-hook nil))
10742 (when (and org-blocker-hook
10743 (or org-inhibit-blocking
10744 (org-entry-get nil "NOBLOCKING")))
10745 (setq org-blocker-hook nil))
10746 (save-excursion
10747 (catch 'exit
10748 (org-back-to-heading t)
10749 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10751 (looking-at " *"))
10752 (let* ((match-data (match-data))
10753 (startpos (point-at-bol))
10754 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10755 (org-log-done org-log-done)
10756 (org-log-repeat org-log-repeat)
10757 (org-todo-log-states org-todo-log-states)
10758 (this (match-string 1))
10759 (hl-pos (match-beginning 0))
10760 (head (org-get-todo-sequence-head this))
10761 (ass (assoc head org-todo-kwd-alist))
10762 (interpret (nth 1 ass))
10763 (done-word (nth 3 ass))
10764 (final-done-word (nth 4 ass))
10765 (last-state (or this ""))
10766 (completion-ignore-case t)
10767 (member (member this org-todo-keywords-1))
10768 (tail (cdr member))
10769 (state (cond
10770 ((and org-todo-key-trigger
10771 (or (and (equal arg '(4))
10772 (eq org-use-fast-todo-selection 'prefix))
10773 (and (not arg) org-use-fast-todo-selection
10774 (not (eq org-use-fast-todo-selection
10775 'prefix)))))
10776 ;; Use fast selection
10777 (org-fast-todo-selection))
10778 ((and (equal arg '(4))
10779 (or (not org-use-fast-todo-selection)
10780 (not org-todo-key-trigger)))
10781 ;; Read a state with completion
10782 (org-icompleting-read
10783 "State: " (mapcar (lambda(x) (list x))
10784 org-todo-keywords-1)
10785 nil t))
10786 ((eq arg 'right)
10787 (if this
10788 (if tail (car tail) nil)
10789 (car org-todo-keywords-1)))
10790 ((eq arg 'left)
10791 (if (equal member org-todo-keywords-1)
10792 nil
10793 (if this
10794 (nth (- (length org-todo-keywords-1)
10795 (length tail) 2)
10796 org-todo-keywords-1)
10797 (org-last org-todo-keywords-1))))
10798 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10799 (setq arg nil))) ; hack to fall back to cycling
10800 (arg
10801 ;; user or caller requests a specific state
10802 (cond
10803 ((equal arg "") nil)
10804 ((eq arg 'none) nil)
10805 ((eq arg 'done) (or done-word (car org-done-keywords)))
10806 ((eq arg 'nextset)
10807 (or (car (cdr (member head org-todo-heads)))
10808 (car org-todo-heads)))
10809 ((eq arg 'previousset)
10810 (let ((org-todo-heads (reverse org-todo-heads)))
10811 (or (car (cdr (member head org-todo-heads)))
10812 (car org-todo-heads))))
10813 ((car (member arg org-todo-keywords-1)))
10814 ((stringp arg)
10815 (error "State `%s' not valid in this file" arg))
10816 ((nth (1- (prefix-numeric-value arg))
10817 org-todo-keywords-1))))
10818 ((null member) (or head (car org-todo-keywords-1)))
10819 ((equal this final-done-word) nil) ;; -> make empty
10820 ((null tail) nil) ;; -> first entry
10821 ((memq interpret '(type priority))
10822 (if (eq this-command last-command)
10823 (car tail)
10824 (if (> (length tail) 0)
10825 (or done-word (car org-done-keywords))
10826 nil)))
10827 (t
10828 (car tail))))
10829 (state (or
10830 (run-hook-with-args-until-success
10831 'org-todo-get-default-hook state last-state)
10832 state))
10833 (next (if state (concat " " state " ") " "))
10834 (change-plist (list :type 'todo-state-change :from this :to state
10835 :position startpos))
10836 dolog now-done-p)
10837 (when org-blocker-hook
10838 (setq org-last-todo-state-is-todo
10839 (not (member this org-done-keywords)))
10840 (unless (save-excursion
10841 (save-match-data
10842 (run-hook-with-args-until-failure
10843 'org-blocker-hook change-plist)))
10844 (if (interactive-p)
10845 (error "TODO state change from %s to %s blocked" this state)
10846 ;; fail silently
10847 (message "TODO state change from %s to %s blocked" this state)
10848 (throw 'exit nil))))
10849 (store-match-data match-data)
10850 (replace-match next t t)
10851 (unless (pos-visible-in-window-p hl-pos)
10852 (message "TODO state changed to %s" (org-trim next)))
10853 (unless head
10854 (setq head (org-get-todo-sequence-head state)
10855 ass (assoc head org-todo-kwd-alist)
10856 interpret (nth 1 ass)
10857 done-word (nth 3 ass)
10858 final-done-word (nth 4 ass)))
10859 (when (memq arg '(nextset previousset))
10860 (message "Keyword-Set %d/%d: %s"
10861 (- (length org-todo-sets) -1
10862 (length (memq (assoc state org-todo-sets) org-todo-sets)))
10863 (length org-todo-sets)
10864 (mapconcat 'identity (assoc state org-todo-sets) " ")))
10865 (setq org-last-todo-state-is-todo
10866 (not (member state org-done-keywords)))
10867 (setq now-done-p (and (member state org-done-keywords)
10868 (not (member this org-done-keywords))))
10869 (and logging (org-local-logging logging))
10870 (when (and (or org-todo-log-states org-log-done)
10871 (not (eq org-inhibit-logging t))
10872 (not (memq arg '(nextset previousset))))
10873 ;; we need to look at recording a time and note
10874 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
10875 (nth 2 (assoc this org-todo-log-states))))
10876 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
10877 (setq dolog 'time))
10878 (when (and state
10879 (member state org-not-done-keywords)
10880 (not (member this org-not-done-keywords)))
10881 ;; This is now a todo state and was not one before
10882 ;; If there was a CLOSED time stamp, get rid of it.
10883 (org-add-planning-info nil nil 'closed))
10884 (when (and now-done-p org-log-done)
10885 ;; It is now done, and it was not done before
10886 (org-add-planning-info 'closed (org-current-time))
10887 (if (and (not dolog) (eq 'note org-log-done))
10888 (org-add-log-setup 'done state this 'findpos 'note)))
10889 (when (and state dolog)
10890 ;; This is a non-nil state, and we need to log it
10891 (org-add-log-setup 'state state this 'findpos dolog)))
10892 ;; Fixup tag positioning
10893 (org-todo-trigger-tag-changes state)
10894 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
10895 (when org-provide-todo-statistics
10896 (org-update-parent-todo-statistics))
10897 (run-hooks 'org-after-todo-state-change-hook)
10898 (if (and arg (not (member state org-done-keywords)))
10899 (setq head (org-get-todo-sequence-head state)))
10900 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
10901 ;; Do we need to trigger a repeat?
10902 (when now-done-p
10903 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
10904 ;; This is for the agenda, take a snapshot of the headline.
10905 (save-match-data
10906 (setq org-agenda-headline-snapshot-before-repeat
10907 (org-get-heading))))
10908 (org-auto-repeat-maybe state))
10909 ;; Fixup cursor location if close to the keyword
10910 (if (and (outline-on-heading-p)
10911 (not (bolp))
10912 (save-excursion (beginning-of-line 1)
10913 (looking-at org-todo-line-regexp))
10914 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
10915 (progn
10916 (goto-char (or (match-end 2) (match-end 1)))
10917 (and (looking-at " ") (just-one-space))))
10918 (when org-trigger-hook
10919 (save-excursion
10920 (run-hook-with-args 'org-trigger-hook change-plist))))))))
10922 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
10923 "Block turning an entry into a TODO, using the hierarchy.
10924 This checks whether the current task should be blocked from state
10925 changes. Such blocking occurs when:
10927 1. The task has children which are not all in a completed state.
10929 2. A task has a parent with the property :ORDERED:, and there
10930 are siblings prior to the current task with incomplete
10931 status.
10933 3. The parent of the task is blocked because it has siblings that should
10934 be done first, or is child of a block grandparent TODO entry."
10936 (if (not org-enforce-todo-dependencies)
10937 t ; if locally turned off don't block
10938 (catch 'dont-block
10939 ;; If this is not a todo state change, or if this entry is already DONE,
10940 ;; do not block
10941 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
10942 (member (plist-get change-plist :from)
10943 (cons 'done org-done-keywords))
10944 (member (plist-get change-plist :to)
10945 (cons 'todo org-not-done-keywords))
10946 (not (plist-get change-plist :to)))
10947 (throw 'dont-block t))
10948 ;; If this task has children, and any are undone, it's blocked
10949 (save-excursion
10950 (org-back-to-heading t)
10951 (let ((this-level (funcall outline-level)))
10952 (outline-next-heading)
10953 (let ((child-level (funcall outline-level)))
10954 (while (and (not (eobp))
10955 (> child-level this-level))
10956 ;; this todo has children, check whether they are all
10957 ;; completed
10958 (if (and (not (org-entry-is-done-p))
10959 (org-entry-is-todo-p))
10960 (throw 'dont-block nil))
10961 (outline-next-heading)
10962 (setq child-level (funcall outline-level))))))
10963 ;; Otherwise, if the task's parent has the :ORDERED: property, and
10964 ;; any previous siblings are undone, it's blocked
10965 (save-excursion
10966 (org-back-to-heading t)
10967 (let* ((pos (point))
10968 (parent-pos (and (org-up-heading-safe) (point))))
10969 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10970 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
10971 (forward-line 1)
10972 (re-search-forward org-not-done-heading-regexp pos t))
10973 (throw 'dont-block nil)) ; block, there is an older sibling not done.
10974 ;; Search further up the hierarchy, to see if an anchestor is blocked
10975 (while t
10976 (goto-char parent-pos)
10977 (if (not (looking-at org-not-done-heading-regexp))
10978 (throw 'dont-block t)) ; do not block, parent is not a TODO
10979 (setq pos (point))
10980 (setq parent-pos (and (org-up-heading-safe) (point)))
10981 (if (not parent-pos) (throw 'dont-block t)) ; no parent
10982 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
10983 (forward-line 1)
10984 (re-search-forward org-not-done-heading-regexp pos t))
10985 (throw 'dont-block nil)))))))) ; block, older sibling not done.
10987 (defcustom org-track-ordered-property-with-tag nil
10988 "Should the ORDERED property also be shown as a tag?
10989 The ORDERED property decides if an entry should require subtasks to be
10990 completed in sequence. Since a property is not very visible, setting
10991 this option means that toggling the ORDERED property with the command
10992 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
10993 not relevant for the behavior, but it makes things more visible.
10995 Note that toggling the tag with tags commands will not change the property
10996 and therefore not influence behavior!
10998 This can be t, meaning the tag ORDERED should be used, It can also be a
10999 string to select a different tag for this task."
11000 :group 'org-todo
11001 :type '(choice
11002 (const :tag "No tracking" nil)
11003 (const :tag "Track with ORDERED tag" t)
11004 (string :tag "Use other tag")))
11006 (defun org-toggle-ordered-property ()
11007 "Toggle the ORDERED property of the current entry.
11008 For better visibility, you can track the value of this property with a tag.
11009 See variable `org-track-ordered-property-with-tag'."
11010 (interactive)
11011 (let* ((t1 org-track-ordered-property-with-tag)
11012 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11013 (save-excursion
11014 (org-back-to-heading)
11015 (if (org-entry-get nil "ORDERED")
11016 (progn
11017 (org-delete-property "ORDERED")
11018 (and tag (org-toggle-tag tag 'off))
11019 (message "Subtasks can be completed in arbitrary order"))
11020 (org-entry-put nil "ORDERED" "t")
11021 (and tag (org-toggle-tag tag 'on))
11022 (message "Subtasks must be completed in sequence")))))
11024 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11025 (defun org-block-todo-from-checkboxes (change-plist)
11026 "Block turning an entry into a TODO, using checkboxes.
11027 This checks whether the current task should be blocked from state
11028 changes because there are unchecked boxes in this entry."
11029 (if (not org-enforce-todo-checkbox-dependencies)
11030 t ; if locally turned off don't block
11031 (catch 'dont-block
11032 ;; If this is not a todo state change, or if this entry is already DONE,
11033 ;; do not block
11034 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11035 (member (plist-get change-plist :from)
11036 (cons 'done org-done-keywords))
11037 (member (plist-get change-plist :to)
11038 (cons 'todo org-not-done-keywords))
11039 (not (plist-get change-plist :to)))
11040 (throw 'dont-block t))
11041 ;; If this task has checkboxes that are not checked, it's blocked
11042 (save-excursion
11043 (org-back-to-heading t)
11044 (let ((beg (point)) end)
11045 (outline-next-heading)
11046 (setq end (point))
11047 (goto-char beg)
11049 end t)
11050 (progn
11051 (if (boundp 'org-blocked-by-checkboxes)
11052 (setq org-blocked-by-checkboxes t))
11053 (throw 'dont-block nil)))))
11054 t))) ; do not block
11056 (defun org-entry-blocked-p ()
11057 "Is the current entry blocked?"
11058 (if (org-entry-get nil "NOBLOCKING")
11059 nil ;; Never block this entry
11060 (not
11061 (run-hook-with-args-until-failure
11062 'org-blocker-hook
11063 (list :type 'todo-state-change
11064 :position (point)
11065 :from 'todo
11066 :to 'done)))))
11068 (defun org-update-statistics-cookies (all)
11069 "Update the statistics cookie, either from TODO or from checkboxes.
11070 This should be called with the cursor in a line with a statistics cookie."
11071 (interactive "P")
11072 (if all
11073 (progn
11074 (org-update-checkbox-count 'all)
11075 (org-map-entries 'org-update-parent-todo-statistics))
11076 (if (not (org-on-heading-p))
11077 (org-update-checkbox-count)
11078 (let ((pos (move-marker (make-marker) (point)))
11079 end l1 l2)
11080 (ignore-errors (org-back-to-heading t))
11081 (if (not (org-on-heading-p))
11082 (org-update-checkbox-count)
11083 (setq l1 (org-outline-level))
11084 (setq end (save-excursion
11085 (outline-next-heading)
11086 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11087 (point)))
11088 (if (and (save-excursion
11089 (re-search-forward
11091 (not (save-excursion (re-search-forward
11093 (org-update-checkbox-count)
11094 (if (and l2 (> l2 l1))
11095 (progn
11096 (goto-char end)
11097 (org-update-parent-todo-statistics))
11098 (goto-char pos)
11099 (beginning-of-line 1)
11100 (while (re-search-forward
11102 (point-at-eol) t)
11103 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11104 (goto-char pos)
11105 (move-marker pos nil)))))
11107 (defvar org-entry-property-inherited-from) ;; defined below
11108 (defun org-update-parent-todo-statistics ()
11109 "Update any statistics cookie in the parent of the current headline.
11110 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11111 the entire subtree and this will travel up the hierarchy and update
11112 statistics everywhere."
11113 (interactive)
11114 (let* ((lim 0) prop
11115 (recursive (or (not org-hierarchical-todo-statistics)
11116 (string-match
11118 (or (setq prop (org-entry-get
11119 nil "COOKIE_DATA" 'inherit)) ""))))
11120 (lim (or (and prop (marker-position
11121 org-entry-property-inherited-from))
11122 lim))
11123 (first t)
11125 level ltoggle l1 new ndel
11126 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
11127 (catch 'exit
11128 (save-excursion
11129 (beginning-of-line 1)
11130 (if (org-at-heading-p)
11131 (setq ltoggle (funcall outline-level))
11132 (error "This should not happen"))
11133 (while (and (setq level (org-up-heading-safe))
11134 (or recursive first)
11135 (>= (point) lim))
11136 (setq first nil cookie-present nil)
11137 (unless (and level
11138 (not (string-match
11140 (downcase
11141 (or (org-entry-get
11142 nil "COOKIE_DATA")
11143 "")))))
11144 (throw 'exit nil))
11145 (while (re-search-forward box-re (point-at-eol) t)
11146 (setq cnt-all 0 cnt-done 0 cookie-present t)
11147 (setq is-percent (match-end 2))
11148 (save-match-data
11149 (unless (outline-next-heading) (throw 'exit nil))
11150 (while (and (looking-at org-complex-heading-regexp)
11151 (> (setq l1 (length (match-string 1))) level))
11152 (setq kwd (and (or recursive (= l1 ltoggle))
11153 (match-string 2)))
11154 (if (or (eq org-provide-todo-statistics 'all-headlines)
11155 (and (listp org-provide-todo-statistics)
11156 (or (member kwd org-provide-todo-statistics)
11157 (member kwd org-done-keywords))))
11158 (setq cnt-all (1+ cnt-all))
11159 (if (eq org-provide-todo-statistics t)
11160 (and kwd (setq cnt-all (1+ cnt-all)))))
11161 (and (member kwd org-done-keywords)
11162 (setq cnt-done (1+ cnt-done)))
11163 (outline-next-heading)))
11164 (setq new
11165 (if is-percent
11166 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11167 (format "[%d/%d]" cnt-done cnt-all))
11168 ndel (- (match-end 0) (match-beginning 0)))
11169 (goto-char (match-beginning 0))
11170 (insert new)
11171 (delete-region (point) (+ (point) ndel)))
11172 (when cookie-present
11173 (run-hook-with-args 'org-after-todo-statistics-hook
11174 cnt-done (- cnt-all cnt-done))))))
11175 (run-hooks 'org-todo-statistics-hook)))
11177 (defvar org-after-todo-statistics-hook nil
11178 "Hook that is called after a TODO statistics cookie has been updated.
11179 Each function is called with two arguments: the number of not-done entries
11180 and the number of done entries.
11182 For example, the following function, when added to this hook, will switch
11183 an entry to DONE when all children are done, and back to TODO when new
11184 entries are set to a TODO status. Note that this hook is only called
11185 when there is a statistics cookie in the headline!
11187 (defun org-summary-todo (n-done n-not-done)
11189 (let (org-log-done org-log-states) ; turn off logging
11191 ")
11193 (defvar org-todo-statistics-hook nil
11194 "Hook that is run whenever Org thinks TODO statistics should be updated.
11195 This hook runs even if there is no statistics cookie present, in which case
11196 `org-after-todo-statistics-hook' would not run.")
11198 (defun org-todo-trigger-tag-changes (state)
11199 "Apply the changes defined in `org-todo-state-tags-triggers'."
11200 (let ((l org-todo-state-tags-triggers)
11201 changes)
11202 (when (or (not state) (equal state ""))
11203 (setq changes (append changes (cdr (assoc "" l)))))
11204 (when (and (stringp state) (> (length state) 0))
11205 (setq changes (append changes (cdr (assoc state l)))))
11206 (when (member state org-not-done-keywords)
11207 (setq changes (append changes (cdr (assoc 'todo l)))))
11208 (when (member state org-done-keywords)
11209 (setq changes (append changes (cdr (assoc 'done l)))))
11210 (dolist (c changes)
11211 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11213 (defun org-local-logging (value)
11214 "Get logging settings from a property VALUE."
11215 (let* (words w a)
11216 ;; directly set the variables, they are already local.
11217 (setq org-log-done nil
11218 org-log-repeat nil
11219 org-todo-log-states nil)
11220 (setq words (org-split-string value))
11221 (while (setq w (pop words))
11222 (cond
11223 ((setq a (assoc w org-startup-options))
11224 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11225 (set (nth 1 a) (nth 2 a))))
11226 ((setq a (org-extract-log-state-settings w))
11227 (and (member (car a) org-todo-keywords-1)
11228 (push a org-todo-log-states)))))))
11230 (defun org-get-todo-sequence-head (kwd)
11231 "Return the head of the TODO sequence to which KWD belongs.
11232 If KWD is not set, check if there is a text property remembering the
11233 right sequence."
11234 (let (p)
11235 (cond
11236 ((not kwd)
11237 (or (get-text-property (point-at-bol) 'org-todo-head)
11238 (progn
11239 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11240 nil (point-at-eol)))
11241 (get-text-property p 'org-todo-head))))
11242 ((not (member kwd org-todo-keywords-1))
11243 (car org-todo-keywords-1))
11244 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11246 (defun org-fast-todo-selection ()
11247 "Fast TODO keyword selection with single keys.
11248 Returns the new TODO keyword, or nil if no state change should occur."
11249 (let* ((fulltable org-todo-key-alist)
11250 (done-keywords org-done-keywords) ;; needed for the faces.
11251 (maxlen (apply 'max (mapcar
11252 (lambda (x)
11253 (if (stringp (car x)) (string-width (car x)) 0))
11254 fulltable)))
11255 (expert nil)
11256 (fwidth (+ maxlen 3 1 3))
11257 (ncol (/ (- (window-width) 4) fwidth))
11258 tg cnt e c tbl
11259 groups ingroup)
11260 (save-excursion
11261 (save-window-excursion
11262 (if expert
11263 (set-buffer (get-buffer-create " *Org todo*"))
11264 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11265 (erase-buffer)
11266 (org-set-local 'org-done-keywords done-keywords)
11267 (setq tbl fulltable cnt 0)
11268 (while (setq e (pop tbl))
11269 (cond
11270 ((equal e '(:startgroup))
11271 (push '() groups) (setq ingroup t)
11272 (when (not (= cnt 0))
11273 (setq cnt 0)
11275 (insert "{ "))
11276 ((equal e '(:endgroup))
11277 (setq ingroup nil cnt 0)
11279 ((equal e '(:newline))
11280 (when (not (= cnt 0))
11281 (setq cnt 0)
11283 (setq e (car tbl))
11284 (while (equal (car tbl) '(:newline))
11286 (setq tbl (cdr tbl)))))
11287 (t
11288 (setq tg (car e) c (cdr e))
11289 (if ingroup (push tg (car groups)))
11290 (setq tg (org-add-props tg nil 'face
11291 (org-get-todo-face tg)))
11292 (if (and (= cnt 0) (not ingroup)) (insert " "))
11293 (insert "[" c "] " tg (make-string
11294 (- fwidth 4 (length tg)) ?\ ))
11295 (when (= (setq cnt (1+ cnt)) ncol)
11297 (if ingroup (insert " "))
11298 (setq cnt 0)))))
11300 (goto-char (point-min))
11301 (if (not expert) (org-fit-window-to-buffer))
11302 (message "[a-z..]:Set [SPC]:clear")
11303 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11304 (cond
11305 ((or (= c ?\C-g)
11306 (and (= c ?q) (not (rassoc c fulltable))))
11307 (setq quit-flag t))
11308 ((= c ?\ ) nil)
11309 ((setq e (rassoc c fulltable) tg (car e))
11310 tg)
11311 (t (setq quit-flag t)))))))
11313 (defun org-entry-is-todo-p ()
11314 (member (org-get-todo-state) org-not-done-keywords))
11316 (defun org-entry-is-done-p ()
11317 (member (org-get-todo-state) org-done-keywords))
11319 (defun org-get-todo-state ()
11320 (save-excursion
11321 (org-back-to-heading t)
11322 (and (looking-at org-todo-line-regexp)
11323 (match-end 2)
11324 (match-string 2))))
11326 (defun org-at-date-range-p (&optional inactive-ok)
11327 "Is the cursor inside a date range?"
11328 (interactive)
11329 (save-excursion
11330 (catch 'exit
11331 (let ((pos (point)))
11333 (skip-chars-backward "<[")
11334 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11335 (>= (match-end 0) pos)
11336 (throw 'exit t))
11338 (skip-chars-backward "<[")
11339 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11340 (>= (match-end 0) pos)
11341 (throw 'exit t)))
11342 nil)))
11344 (defun org-get-repeat (&optional tagline)
11345 "Check if there is a deadline/schedule with repeater in this entry."
11346 (save-match-data
11347 (save-excursion
11348 (org-back-to-heading t)
11349 (and (re-search-forward (if tagline
11351 org-repeat-re)
11352 (org-entry-end-position) t)
11353 (match-string-no-properties 1)))))
11355 (defvar org-last-changed-timestamp)
11356 (defvar org-last-inserted-timestamp)
11357 (defvar org-log-post-message)
11358 (defvar org-log-note-purpose)
11359 (defvar org-log-note-how)
11360 (defvar org-log-note-extra)
11361 (defun org-auto-repeat-maybe (done-word)
11362 "Check if the current headline contains a repeated deadline/schedule.
11363 If yes, set TODO state back to what it was and change the base date
11364 of repeating deadline/scheduled time stamps to new date.
11365 This function is run automatically after each state change to a DONE state."
11366 ;; last-state is dynamically scoped into this function
11367 (let* ((repeat (org-get-repeat))
11368 (aa (assoc last-state org-todo-kwd-alist))
11369 (interpret (nth 1 aa))
11370 (head (nth 2 aa))
11371 (whata '(("d" . day) ("m" . month) ("y" . year)))
11372 (msg "Entry repeats: ")
11373 (org-log-done nil)
11374 (org-todo-log-states nil)
11375 re type n what ts time to-state)
11376 (when repeat
11377 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11378 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11379 org-todo-repeat-to-state))
11380 (unless (and to-state (member to-state org-todo-keywords-1))
11381 (setq to-state (if (eq interpret 'type) last-state head)))
11382 (org-todo to-state)
11383 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11384 (org-entry-put nil "LAST_REPEAT" (format-time-string
11385 (org-time-stamp-format t t))))
11386 (when org-log-repeat
11387 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11388 (memq 'org-add-log-note post-command-hook))
11389 ;; OK, we are already setup for some record
11390 (if (eq org-log-repeat 'note)
11391 ;; make sure we take a note, not only a time stamp
11392 (setq org-log-note-how 'note))
11393 ;; Set up for taking a record
11394 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11395 last-state
11396 'findpos org-log-repeat)))
11397 (org-back-to-heading t)
11398 (org-add-planning-info nil nil 'closed)
11402 (while (re-search-forward
11403 re (save-excursion (outline-next-heading) (point)) t)
11404 (setq type (if (match-end 1) org-scheduled-string
11405 (if (match-end 3) org-deadline-string "Plain:"))
11406 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11408 (setq n (string-to-number (match-string 2 ts))
11409 what (match-string 3 ts))
11410 (if (equal what "w") (setq n (* n 7) what "d"))
11411 ;; Preparation, see if we need to modify the start date for the change
11412 (when (match-end 1)
11413 (setq time (save-match-data (org-time-string-to-time ts)))
11414 (cond
11415 ((equal (match-string 1 ts) ".")
11416 ;; Shift starting date to today
11417 (org-timestamp-change
11418 (- (time-to-days (current-time)) (time-to-days time))
11419 'day))
11420 ((equal (match-string 1 ts) "+")
11421 (let ((nshiftmax 10) (nshift 0))
11422 (while (or (= nshift 0)
11423 (<= (time-to-days time)
11424 (time-to-days (current-time))))
11425 (when (= (incf nshift) nshiftmax)
11426 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11427 (error "Abort")))
11428 (org-timestamp-change n (cdr (assoc what whata)))
11429 (org-at-timestamp-p t)
11430 (setq ts (match-string 1))
11431 (setq time (save-match-data (org-time-string-to-time ts)))))
11432 (org-timestamp-change (- n) (cdr (assoc what whata)))
11433 ;; rematch, so that we have everything in place for the real shift
11434 (org-at-timestamp-p t)
11435 (setq ts (match-string 1))
11437 (org-timestamp-change n (cdr (assoc what whata)))
11438 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11439 (setq org-log-post-message msg)
11440 (message "%s" msg))))
11442 (defun org-show-todo-tree (arg)
11443 "Make a compact tree which shows all headlines marked with TODO.
11444 The tree will show the lines where the regexp matches, and all higher
11445 headlines above the match.
11447 With a numeric prefix N, construct a sparse tree for the Nth element
11448 of `org-todo-keywords-1'."
11449 (interactive "P")
11450 (let ((case-fold-search nil)
11451 (kwd-re
11452 (cond ((null arg) org-not-done-regexp)
11453 ((equal arg '(4))
11454 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11455 (mapcar 'list org-todo-keywords-1))))
11459 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11460 (regexp-quote (nth (1- (prefix-numeric-value arg))
11461 org-todo-keywords-1)))
11462 (t (error "Invalid prefix argument: %s" arg)))))
11463 (message "%d TODO entries found"
11464 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
11466 (defun org-deadline (&optional remove time)
11468 With argument REMOVE, remove any deadline from the item.
11469 When TIME is set, it should be an internal time specification, and the
11470 scheduling will use the corresponding date."
11471 (interactive "P")
11472 (let* ((old-date (org-entry-get nil "DEADLINE"))
11473 (repeater (and old-date
11475 (match-string 1 old-date))))
11476 (if remove
11477 (progn
11478 (when (and old-date org-log-redeadline)
11479 (org-add-log-setup 'deldeadline nil old-date 'findpos
11480 org-log-redeadline))
11481 (org-remove-timestamp-with-keyword org-deadline-string)
11482 (message "Item no longer has a deadline."))
11483 (org-add-planning-info 'deadline time 'closed)
11484 (when (and old-date org-log-redeadline
11485 (not (equal old-date
11486 (substring org-last-inserted-timestamp 1 -1))))
11487 (org-add-log-setup 'redeadline nil old-date 'findpos
11488 org-log-redeadline))
11489 (when repeater
11490 (save-excursion
11491 (org-back-to-heading t)
11492 (when (re-search-forward (concat org-deadline-string " "
11493 org-last-inserted-timestamp)
11494 (save-excursion
11495 (outline-next-heading) (point)) t)
11496 (goto-char (1- (match-end 0)))
11497 (insert " " repeater)
11498 (setq org-last-inserted-timestamp
11499 (concat (substring org-last-inserted-timestamp 0 -1)
11500 " " repeater
11501 (substring org-last-inserted-timestamp -1))))))
11502 (message "Deadline on %s" org-last-inserted-timestamp))))
11504 (defun org-schedule (&optional remove time)
11505 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11506 With argument REMOVE, remove any scheduling date from the item.
11507 When TIME is set, it should be an internal time specification, and the
11508 scheduling will use the corresponding date."
11509 (interactive "P")
11510 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11511 (repeater (and old-date
11513 (match-string 1 old-date))))
11514 (if remove
11515 (progn
11516 (when (and old-date org-log-reschedule)
11517 (org-add-log-setup 'delschedule nil old-date 'findpos
11518 org-log-reschedule))
11519 (org-remove-timestamp-with-keyword org-scheduled-string)
11520 (message "Item is no longer scheduled."))
11521 (org-add-planning-info 'scheduled time 'closed)
11522 (when (and old-date org-log-reschedule
11523 (not (equal old-date
11524 (substring org-last-inserted-timestamp 1 -1))))
11525 (org-add-log-setup 'reschedule nil old-date 'findpos
11526 org-log-reschedule))
11527 (when repeater
11528 (save-excursion
11529 (org-back-to-heading t)
11530 (when (re-search-forward (concat org-scheduled-string " "
11531 org-last-inserted-timestamp)
11532 (save-excursion
11533 (outline-next-heading) (point)) t)
11534 (goto-char (1- (match-end 0)))
11535 (insert " " repeater)
11536 (setq org-last-inserted-timestamp
11537 (concat (substring org-last-inserted-timestamp 0 -1)
11538 " " repeater
11539 (substring org-last-inserted-timestamp -1))))))
11540 (message "Scheduled to %s" org-last-inserted-timestamp))))
11542 (defun org-get-scheduled-time (pom &optional inherit)
11543 "Get the scheduled time as a time tuple, of a format suitable
11544 for calling org-schedule with, or if there is no scheduling,
11545 returns nil."
11546 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11547 (when time
11548 (apply 'encode-time (org-parse-time-string time)))))
11550 (defun org-get-deadline-time (pom &optional inherit)
11551 "Get the deadline as a time tuple, of a format suitable for
11552 calling org-deadline with, or if there is no scheduling, returns
11553 nil."
11554 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11555 (when time
11556 (apply 'encode-time (org-parse-time-string time)))))
11558 (defun org-remove-timestamp-with-keyword (keyword)
11559 "Remove all time stamps with KEYWORD in the current entry."
11561 beg)
11562 (save-excursion
11563 (org-back-to-heading t)
11564 (setq beg (point))
11565 (outline-next-heading)
11566 (while (re-search-backward re beg t)
11567 (replace-match "")
11569 (equal (char-before) ?\ ))
11570 (backward-delete-char 1)
11572 (point-at-bol) (point-at-eol)))
11573 (delete-region (point-at-bol)
11574 (min (point-max) (1+ (point-at-eol))))))))))
11576 (defun org-add-planning-info (what &optional time &rest remove)
11577 "Insert new timestamp with keyword in the line directly after the headline.
11578 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11579 If non is given, the user is prompted for a date.
11580 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11581 be removed."
11582 (interactive)
11583 (let (org-time-was-given org-end-time-was-given ts
11584 end default-time default-input)
11586 (catch 'exit
11587 (when (and (not time) (memq what '(scheduled deadline)))
11588 ;; Try to get a default date/time from existing timestamp
11589 (save-excursion
11590 (org-back-to-heading t)
11591 (setq end (save-excursion (outline-next-heading) (point)))
11592 (when (re-search-forward (if (eq what 'scheduled)
11593 org-scheduled-time-regexp
11594 org-deadline-time-regexp)
11595 end t)
11596 (setq ts (match-string 1)
11597 default-time
11598 (apply 'encode-time (org-parse-time-string ts))
11599 default-input (and ts (org-get-compact-tod ts))))))
11600 (when what
11601 ;; If necessary, get the time from the user
11602 (setq time (or time (org-read-date nil 'to-time nil nil
11603 default-time default-input))))
11605 (when (and org-insert-labeled-timestamps-at-point
11606 (member what '(scheduled deadline)))
11607 (insert
11608 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11609 (org-insert-time-stamp time org-time-was-given
11610 nil nil nil (list org-end-time-was-given))
11611 (setq what nil))
11612 (save-excursion
11613 (save-restriction
11614 (let (col list elt ts buffer-invisibility-spec)
11615 (org-back-to-heading t)
11617 (goto-char (match-end 1))
11618 (setq col (current-column))
11619 (goto-char (match-end 0))
11621 (when (and (not what)
11622 (not (looking-at
11624 org-keyword-time-not-clock-regexp))))
11625 ;; Nothing to add, nothing to remove...... :-)
11626 (throw 'exit nil))
11627 (if (and (not (looking-at outline-regexp))
11630 (not (equal (match-string 1) org-clock-string)))
11631 (narrow-to-region (match-beginning 0) (match-end 0))
11633 (backward-char 1)
11634 (narrow-to-region (point) (point))
11635 (and org-adapt-indentation (org-indent-to-column col)))
11636 ;; Check if we have to remove something.
11637 (setq list (cons what remove))
11638 (while list
11639 (setq elt (pop list))
11640 (goto-char (point-min))
11641 (when (or (and (eq elt 'scheduled)
11642 (re-search-forward org-scheduled-time-regexp nil t))
11643 (and (eq elt 'deadline)
11644 (re-search-forward org-deadline-time-regexp nil t))
11645 (and (eq elt 'closed)
11646 (re-search-forward org-closed-time-regexp nil t)))
11647 (replace-match "")
11648 (if (looking-at "--+<[^>]+>") (replace-match ""))
11649 (skip-chars-backward " ")
11650 (if (looking-at " +") (replace-match ""))))
11651 (goto-char (point-max))
11652 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11653 (when what
11654 (insert
11655 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11656 (cond ((eq what 'scheduled) org-scheduled-string)
11657 ((eq what 'deadline) org-deadline-string)
11658 ((eq what 'closed) org-closed-string))
11659 " ")
11660 (setq ts (org-insert-time-stamp
11661 time
11662 (or org-time-was-given
11663 (and (eq what 'closed) org-log-done-with-time))
11664 (eq what 'closed)
11665 nil nil (list org-end-time-was-given)))
11666 (end-of-line 1))
11667 (goto-char (point-min))
11668 (widen)
11671 (delete-region (1- (point)) (point-at-eol)))
11672 ts))))))
11674 (defvar org-log-note-marker (make-marker))
11675 (defvar org-log-note-purpose nil)
11676 (defvar org-log-note-state nil)
11677 (defvar org-log-note-previous-state nil)
11678 (defvar org-log-note-how nil)
11679 (defvar org-log-note-extra nil)
11680 (defvar org-log-note-window-configuration nil)
11681 (defvar org-log-note-return-to (make-marker))
11682 (defvar org-log-post-message nil
11683 "Message to be displayed after a log note has been stored.
11684 The auto-repeater uses this.")
11686 (defun org-add-note ()
11687 "Add a note to the current entry.
11688 This is done in the same way as adding a state change note."
11689 (interactive)
11690 (org-add-log-setup 'note nil nil 'findpos nil))
11692 (defvar org-property-end-re)
11693 (defun org-add-log-setup (&optional purpose state prev-state
11694 findpos how extra)
11695 "Set up the post command hook to take a note.
11696 If this is about to TODO state change, the new state is expected in STATE.
11697 When FINDPOS is non-nil, find the correct position for the note in
11698 the current entry. If not, assume that it can be inserted at point.
11699 HOW is an indicator what kind of note should be created.
11700 EXTRA is additional text that will be inserted into the notes buffer."
11701 (let* ((org-log-into-drawer (org-log-into-drawer))
11702 (drawer (cond ((stringp org-log-into-drawer)
11703 org-log-into-drawer)
11704 (org-log-into-drawer "LOGBOOK")
11705 (t nil))))
11706 (save-restriction
11707 (save-excursion
11708 (when findpos
11709 (org-back-to-heading t)
11710 (narrow-to-region (point) (save-excursion
11711 (outline-next-heading) (point)))
11715 (goto-char (match-end 0))
11716 (cond
11717 (drawer
11719 nil t)
11720 (progn
11721 (goto-char (match-end 0))
11722 (or org-log-states-order-reversed
11723 (and (re-search-forward org-property-end-re nil t)
11724 (goto-char (1- (match-beginning 0))))))
11726 (beginning-of-line 0)
11727 (org-indent-line-function)
11728 (beginning-of-line 2)
11729 (org-indent-line-function)
11730 (end-of-line 0)))
11731 ((and org-log-state-notes-insert-after-drawers
11732 (save-excursion
11733 (forward-line) (looking-at org-drawer-regexp)))
11734 (forward-line)
11735 (while (looking-at org-drawer-regexp)
11736 (goto-char (match-end 0))
11737 (re-search-forward org-property-end-re (point-max) t)
11738 (forward-line))
11739 (forward-line -1)))
11740 (unless org-log-states-order-reversed
11742 (org-skip-over-state-notes)
11744 (move-marker org-log-note-marker (point))
11745 (setq org-log-note-purpose purpose
11746 org-log-note-state state
11747 org-log-note-previous-state prev-state
11748 org-log-note-how how
11749 org-log-note-extra extra)
11750 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11752 (defun org-skip-over-state-notes ()
11753 "Skip past the list of State notes in an entry."
11755 (when (org-in-item-p)
11756 (let ((limit (org-list-bottom-point)))
11758 (goto-char (or (org-get-next-item (point) limit)
11759 (org-get-end-of-item limit)))))))
11761 (defun org-add-log-note (&optional purpose)
11762 "Pop up a window for taking a note, and add this note later at point."
11763 (remove-hook 'post-command-hook 'org-add-log-note)
11764 (setq org-log-note-window-configuration (current-window-configuration))
11765 (delete-other-windows)
11766 (move-marker org-log-note-return-to (point))
11767 (switch-to-buffer (marker-buffer org-log-note-marker))
11768 (goto-char org-log-note-marker)
11769 (org-switch-to-buffer-other-window "*Org Note*")
11770 (erase-buffer)
11771 (if (memq org-log-note-how '(time state))
11772 (let (current-prefix-arg) (org-store-log-note))
11773 (let ((org-inhibit-startup t)) (org-mode))
11774 (insert (format "# Insert note for %s.
11776 (cond
11777 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11778 ((eq org-log-note-purpose 'done) "closed todo item")
11779 ((eq org-log-note-purpose 'state)
11781 (or org-log-note-previous-state "")
11782 (or org-log-note-state "")))
11783 ((eq org-log-note-purpose 'reschedule)
11784 "rescheduling")
11785 ((eq org-log-note-purpose 'delschedule)
11786 "no longer scheduled")
11787 ((eq org-log-note-purpose 'redeadline)
11788 "changing deadline")
11789 ((eq org-log-note-purpose 'deldeadline)
11790 "removing deadline")
11791 ((eq org-log-note-purpose 'refile)
11792 "refiling")
11793 ((eq org-log-note-purpose 'note)
11794 "this entry")
11795 (t (error "This should not happen")))))
11796 (if org-log-note-extra (insert org-log-note-extra))
11797 (org-set-local 'org-finish-function 'org-store-log-note)))
11799 (defvar org-note-abort nil) ; dynamically scoped
11800 (defun org-store-log-note ()
11801 "Finish taking a log note, and insert it to where it belongs."
11802 (let ((txt (buffer-string))
11803 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11804 lines ind bul)
11805 (kill-buffer (current-buffer))
11807 (setq txt (replace-match "" t t txt)))
11809 (setq txt (replace-match "" t t txt)))
11812 (setq note
11813 (org-replace-escapes
11814 note
11815 (list (cons "%u" (user-login-name))
11816 (cons "%U" user-full-name)
11817 (cons "%t" (format-time-string
11818 (org-time-stamp-format 'long 'inactive)
11819 (current-time)))
11820 (cons "%T" (format-time-string
11821 (org-time-stamp-format 'long nil)
11822 (current-time)))
11823 (cons "%s" (if org-log-note-state
11825 ""))
11826 (cons "%S" (if org-log-note-previous-state
11830 (push note lines))
11831 (when (or current-prefix-arg org-note-abort)
11832 (when org-log-into-drawer
11833 (org-remove-empty-drawer-at
11834 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11835 org-log-note-marker))
11836 (setq lines nil))
11837 (when lines
11838 (with-current-buffer (marker-buffer org-log-note-marker)
11839 (save-excursion
11840 (goto-char org-log-note-marker)
11841 (move-marker org-log-note-marker nil)
11842 (end-of-line 1)
11844 (setq ind (save-excursion
11845 (if (org-in-item-p)
11846 (progn
11847 (goto-char (org-list-top-point))
11848 (org-get-indentation))
11850 (cond
11851 ((and (org-at-heading-p)
11852 org-adapt-indentation)
11853 (1+ (org-current-level)))
11854 ((org-at-heading-p) 0)
11855 (t (org-get-indentation))))))
11856 (setq bul (org-list-bullet-string "-"))
11857 (org-indent-line-to ind)
11858 (insert bul (pop lines))
11859 (let ((ind-body (+ (length bul) ind)))
11860 (while lines
11862 (org-indent-line-to ind-body)
11863 (insert (pop lines))))
11864 (message "Note stored")
11865 (org-back-to-heading t)
11866 (org-cycle-hide-drawers 'children)))))
11867 (set-window-configuration org-log-note-window-configuration)
11868 (with-current-buffer (marker-buffer org-log-note-return-to)
11869 (goto-char org-log-note-return-to))
11870 (move-marker org-log-note-return-to nil)
11871 (and org-log-post-message (message "%s" org-log-post-message)))
11873 (defun org-remove-empty-drawer-at (drawer pos)
11874 "Remove an empty drawer DRAWER at position POS.
11875 POS may also be a marker."
11876 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
11877 (save-excursion
11878 (save-restriction
11879 (widen)
11880 (goto-char pos)
11881 (if (org-in-regexp
11883 (replace-match ""))))))
11885 (defun org-sparse-tree (&optional arg)
11886 "Create a sparse tree, prompt for the details.
11887 This command can create sparse trees. You first need to select the type
11888 of match used to create the tree:
11890 t Show all TODO entries.
11891 T Show entries with a specific TODO keyword.
11892 m Show entries selected by a tags/property match.
11893 p Enter a property name and its value (both with completion on existing
11894 names/values) and show entries with that property.
11895 r Show entries matching a regular expression (`/' can be used as well)
11896 d Show deadlines due within `org-deadline-warning-days'.
11897 b Show deadlines and scheduled items before a date.
11898 a Show deadlines and scheduled items after a date."
11899 (interactive "P")
11900 (let (ans kwd value)
11901 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
11902 (setq ans (read-char-exclusive))
11903 (cond
11904 ((equal ans ?d)
11905 (call-interactively 'org-check-deadlines))
11906 ((equal ans ?b)
11907 (call-interactively 'org-check-before-date))
11908 ((equal ans ?a)
11909 (call-interactively 'org-check-after-date))
11910 ((equal ans ?t)
11911 (org-show-todo-tree nil))
11912 ((equal ans ?T)
11913 (org-show-todo-tree '(4)))
11914 ((member ans '(?T ?m))
11915 (call-interactively 'org-match-sparse-tree))
11916 ((member ans '(?p ?P))
11917 (setq kwd (org-icompleting-read "Property: "
11918 (mapcar 'list (org-buffer-property-keys))))
11919 (setq value (org-icompleting-read "Value: "
11920 (mapcar 'list (org-property-values kwd))))
11923 (org-match-sparse-tree arg (concat kwd "=" value)))
11924 ((member ans '(?r ?R ?/))
11925 (call-interactively 'org-occur))
11928 (defvar org-occur-highlights nil
11929 "List of overlays used for occur matches.")
11930 (make-variable-buffer-local 'org-occur-highlights)
11931 (defvar org-occur-parameters nil
11932 "Parameters of the active org-occur calls.
11933 This is a list, each call to org-occur pushes as cons cell,
11934 containing the regular expression and the callback, onto the list.
11935 The list can contain several entries if `org-occur' has been called
11936 several time with the KEEP-PREVIOUS argument. Otherwise, this list
11937 will only contain one set of parameters. When the highlights are
11938 removed (for example with `C-c C-c', or with the next edit (depending
11939 on `org-remove-highlights-with-change'), this variable is emptied
11940 as well.")
11941 (make-variable-buffer-local 'org-occur-parameters)
11943 (defun org-occur (regexp &optional keep-previous callback)
11944 "Make a compact tree which shows all matches of REGEXP.
11945 The tree will show the lines where the regexp matches, and all higher
11946 headlines above the match. It will also show the heading after the match,
11947 to make sure editing the matching entry is easy.
11948 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
11949 call to `org-occur' will be kept, to allow stacking of calls to this
11950 command.
11951 If CALLBACK is non-nil, it is a function which is called to confirm
11952 that the match should indeed be shown."
11954 (when (equal regexp "")
11955 (error "Regexp cannot be empty"))
11956 (unless keep-previous
11957 (org-remove-occur-highlights nil nil t))
11958 (push (cons regexp callback) org-occur-parameters)
11959 (let ((cnt 0))
11960 (save-excursion
11961 (goto-char (point-min))
11962 (if (or (not keep-previous) ; do not want to keep
11963 (not org-occur-highlights)) ; no previous matches
11964 ;; hide everything
11965 (org-overview))
11966 (while (re-search-forward regexp nil t)
11967 (when (or (not callback)
11968 (save-match-data (funcall callback)))
11969 (setq cnt (1+ cnt))
11970 (when org-highlight-sparse-tree-matches
11971 (org-highlight-new-match (match-beginning 0) (match-end 0)))
11972 (org-show-context 'occur-tree))))
11973 (when org-remove-highlights-with-change
11974 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
11975 nil 'local))
11976 (unless org-sparse-tree-open-archived-trees
11977 (org-hide-archived-subtrees (point-min) (point-max)))
11978 (run-hooks 'org-occur-hook)
11979 (if (interactive-p)
11980 (message "%d match(es) for regexp %s" cnt regexp))
11981 cnt))
11983 (defun org-show-context (&optional key)
11984 "Make sure point and context are visible.
11985 How much context is shown depends upon the variables
11986 `org-show-hierarchy-above', `org-show-following-heading'. and
11987 `org-show-siblings'."
11988 (let ((heading-p (org-on-heading-p t))
11989 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
11990 (following-p (org-get-alist-option org-show-following-heading key))
11991 (entry-p (org-get-alist-option org-show-entry-below key))
11992 (siblings-p (org-get-alist-option org-show-siblings key)))
11993 (catch 'exit
11994 ;; Show heading or entry text
11995 (if (and heading-p (not entry-p))
11996 (org-flag-heading nil) ; only show the heading
11997 (and (or entry-p (org-invisible-p) (org-invisible-p2))
11998 (org-show-hidden-entry))) ; show entire entry
11999 (when following-p
12000 ;; Show next sibling, or heading below text
12001 (save-excursion
12002 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12003 (org-flag-heading nil))))
12004 (when siblings-p (org-show-siblings))
12005 (when hierarchy-p
12006 ;; show all higher headings, possibly with siblings
12007 (save-excursion
12008 (while (and (condition-case nil
12009 (progn (org-up-heading-all 1) t)
12010 (error nil))
12011 (not (bobp)))
12012 (org-flag-heading nil)
12013 (when siblings-p (org-show-siblings))))))))
12015 (defvar org-reveal-start-hook nil
12016 "Hook run before revealing a location.")
12018 (defun org-reveal (&optional siblings)
12019 "Show current entry, hierarchy above it, and the following headline.
12020 This can be used to show a consistent set of context around locations
12021 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12022 not t for the search context.
12024 With optional argument SIBLINGS, on each level of the hierarchy all
12025 siblings are shown. This repairs the tree structure to what it would
12026 look like when opened with hierarchical calls to `org-cycle'.
12028 go to the parent and show the
12029 entire tree."
12030 (interactive "P")
12031 (run-hooks 'org-reveal-start-hook)
12032 (let ((org-show-hierarchy-above t)
12033 (org-show-following-heading t)
12034 (org-show-siblings (if siblings t org-show-siblings)))
12035 (org-show-context nil))
12036 (when (equal siblings '(16))
12037 (save-excursion
12038 (when (org-up-heading-safe)
12039 (org-show-subtree)
12040 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12042 (defun org-highlight-new-match (beg end)
12043 "Highlight from BEG to END and mark the highlight is an occur headline."
12044 (let ((ov (make-overlay beg end)))
12045 (overlay-put ov 'face 'secondary-selection)
12046 (push ov org-occur-highlights)))
12048 (defun org-remove-occur-highlights (&optional beg end noremove)
12049 "Remove the occur highlights from the buffer.
12050 BEG and END are ignored. If NOREMOVE is nil, remove this function
12051 from the `before-change-functions' in the current buffer."
12052 (interactive)
12053 (unless org-inhibit-highlight-removal
12054 (mapc 'delete-overlay org-occur-highlights)
12055 (setq org-occur-highlights nil)
12056 (setq org-occur-parameters nil)
12057 (unless noremove
12058 (remove-hook 'before-change-functions
12059 'org-remove-occur-highlights 'local))))
12061 ;;;; Priorities
12064 "Regular expression matching the priority indicator.")
12066 (defvar org-remove-priority-next-time nil)
12068 (defun org-priority-up ()
12069 "Increase the priority of the current item."
12070 (interactive)
12071 (org-priority 'up))
12073 (defun org-priority-down ()
12074 "Decrease the priority of the current item."
12075 (interactive)
12076 (org-priority 'down))
12078 (defun org-priority (&optional action)
12079 "Change the priority of an item by ARG.
12080 ACTION can be `set', `up', `down', or a character."
12081 (interactive)
12082 (unless org-enable-priority-commands
12083 (error "Priority commands are disabled"))
12084 (setq action (or action 'set))
12085 (let (current new news have remove)
12086 (save-excursion
12087 (org-back-to-heading t)
12088 (if (looking-at org-priority-regexp)
12089 (setq current (string-to-char (match-string 2))
12090 have t)
12091 (setq current org-default-priority))
12092 (cond
12093 ((eq action 'remove)
12094 (setq remove t new ?\ ))
12095 ((or (eq action 'set)
12096 (if (featurep 'xemacs) (characterp action) (integerp action)))
12097 (if (not (eq action 'set))
12098 (setq new action)
12099 (message "Priority %c-%c, SPC to remove: "
12100 org-highest-priority org-lowest-priority)
12101 (save-match-data
12102 (setq new (read-char-exclusive))))
12103 (if (and (= (upcase org-highest-priority) org-highest-priority)
12104 (= (upcase org-lowest-priority) org-lowest-priority))
12105 (setq new (upcase new)))
12106 (cond ((equal new ?\ ) (setq remove t))
12107 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12108 (error "Priority must be between `%c' and `%c'"
12109 org-highest-priority org-lowest-priority))))
12110 ((eq action 'up)
12111 (if (and (not have) (eq last-command this-command))
12112 (setq new org-lowest-priority)
12113 (setq new (if (and org-priority-start-cycle-with-default (not have))
12114 org-default-priority (1- current)))))
12115 ((eq action 'down)
12116 (if (and (not have) (eq last-command this-command))
12117 (setq new org-highest-priority)
12118 (setq new (if (and org-priority-start-cycle-with-default (not have))
12119 org-default-priority (1+ current)))))
12120 (t (error "Invalid action")))
12121 (if (or (< (upcase new) org-highest-priority)
12122 (> (upcase new) org-lowest-priority))
12123 (setq remove t))
12124 (setq news (format "%c" new))
12125 (if have
12126 (if remove
12127 (replace-match "" t t nil 1)
12128 (replace-match news t t nil 2))
12129 (if remove
12130 (error "No priority cookie found in line")
12131 (let ((case-fold-search nil))
12132 (looking-at org-todo-line-regexp))
12133 (if (match-end 2)
12134 (progn
12135 (goto-char (match-end 2))
12136 (insert " [#" news "]"))
12137 (goto-char (match-beginning 3))
12138 (insert "[#" news "] "))))
12139 (org-preserve-lc (org-set-tags nil 'align)))
12140 (if remove
12141 (message "Priority removed")
12142 (message "Priority of current item set to %s" news))))
12144 (defun org-get-priority (s)
12145 "Find priority cookie and return priority."
12146 (if (functionp org-get-priority-function)
12147 (funcall org-get-priority-function)
12148 (save-match-data
12149 (if (not (string-match org-priority-regexp s))
12150 (* 1000 (- org-lowest-priority org-default-priority))
12151 (* 1000 (- org-lowest-priority
12152 (string-to-char (match-string 2 s))))))))
12154 ;;;; Tags
12156 (defvar org-agenda-archives-mode)
12157 (defvar org-map-continue-from nil
12158 "Position from where mapping should continue.
12159 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12161 (defvar org-scanner-tags nil
12162 "The current tag list while the tags scanner is running.")
12163 (defvar org-trust-scanner-tags nil
12164 "Should `org-get-tags-at' use the tags fro the scanner.
12165 This is for internal dynamical scoping only.
12166 When this is non-nil, the function `org-get-tags-at' will return the value
12167 of `org-scanner-tags' instead of building the list by itself. This
12168 can lead to large speed-ups when the tags scanner is used in a file with
12169 many entries, and when the list of tags is retrieved, for example to
12170 obtain a list of properties. Building the tags list for each entry in such
12171 a file becomes an N^2 operation - but with this variable set, it scales
12172 as N.")
12174 (defun org-scan-tags (action matcher &optional todo-only)
12175 "Scan headline tags with inheritance and produce output ACTION.
12177 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12178 or `agenda' to produce an entry list for an agenda view. It can also be
12179 a Lisp form or a function that should be called at each matched headline, in
12180 this case the return value is a list of all return values from these calls.
12182 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12183 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12184 only lines with a TODO keyword are included in the output."
12185 (require 'org-agenda)
12188 (org-re
12190 (props (list 'face 'default
12191 'done-face 'org-agenda-done
12192 'undone-face 'default
12193 'mouse-face 'highlight
12194 'org-not-done-regexp org-not-done-regexp
12195 'org-todo-regexp org-todo-regexp
12196 'help-echo
12197 (format "mouse-2 or RET jump to org file %s"
12198 (abbreviate-file-name
12199 (or (buffer-file-name (buffer-base-buffer))
12200 (buffer-name (buffer-base-buffer)))))))
12201 (case-fold-search nil)
12202 (org-map-continue-from nil)
12203 lspos tags tags-list
12204 (tags-alist (list (cons 0 org-file-tags)))
12205 (llast 0) rtn rtn1 level category i txt
12206 todo marker entry priority)
12207 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12208 (setq action (list 'lambda nil action)))
12209 (save-excursion
12210 (goto-char (point-min))
12211 (when (eq action 'sparse-tree)
12212 (org-overview)
12213 (org-remove-occur-highlights))
12214 (while (re-search-forward re nil t)
12215 (catch :skip
12216 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12217 tags (if (match-end 4) (org-match-string-no-properties 4)))
12218 (goto-char (setq lspos (match-beginning 0)))
12219 (setq level (org-reduced-level (funcall outline-level))
12220 category (org-get-category))
12221 (setq i llast llast level)
12222 ;; remove tag lists from same and sublevels
12223 (while (>= i level)
12224 (when (setq entry (assoc i tags-alist))
12225 (setq tags-alist (delete entry tags-alist)))
12226 (setq i (1- i)))
12227 ;; add the next tags
12228 (when tags
12229 (setq tags (org-split-string tags ":")
12230 tags-alist
12231 (cons (cons level tags) tags-alist)))
12232 ;; compile tags for current headline
12233 (setq tags-list
12234 (if org-use-tag-inheritance
12235 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12236 tags)
12237 org-scanner-tags tags-list)
12238 (when org-use-tag-inheritance
12239 (setcdr (car tags-alist)
12240 (mapcar (lambda (x)
12241 (setq x (copy-sequence x))
12242 (org-add-prop-inherited x))
12243 (cdar tags-alist))))
12244 (when (and tags org-use-tag-inheritance
12245 (or (not (eq t org-use-tag-inheritance))
12246 org-tags-exclude-from-inheritance))
12247 ;; selective inheritance, remove uninherited ones
12248 (setcdr (car tags-alist)
12249 (org-remove-uniherited-tags (cdar tags-alist))))
12250 (when (and (or (not todo-only)
12251 (and (member todo org-not-done-keywords)
12252 (or (not org-agenda-tags-todo-honor-ignore-options)
12253 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12254 (let ((case-fold-search t)) (eval matcher))
12255 (or
12256 (not (member org-archive-tag tags-list))
12257 ;; we have an archive tag, should we use this anyway?
12258 (or (not org-agenda-skip-archived-trees)
12259 (and (eq action 'agenda) org-agenda-archives-mode))))
12260 (unless (eq action 'sparse-tree) (org-agenda-skip))
12262 ;; select this headline
12264 (cond
12265 ((eq action 'sparse-tree)
12266 (and org-highlight-sparse-tree-matches
12267 (org-get-heading) (match-end 0)
12268 (org-highlight-new-match
12269 (match-beginning 0) (match-beginning 1)))
12270 (org-show-context 'tags-tree))
12271 ((eq action 'agenda)
12272 (setq txt (org-format-agenda-item
12273 ""
12274 (concat
12275 (if (eq org-tags-match-list-sublevels 'indented)
12276 (make-string (1- level) ?.) "")
12277 (org-get-heading))
12278 category
12279 tags-list
12280 )
12281 priority (org-get-priority txt))
12282 (goto-char lspos)
12283 (setq marker (org-agenda-new-marker))
12284 (org-add-props txt props
12285 'org-marker marker 'org-hd-marker marker 'org-category category
12286 'todo-state todo
12287 'priority priority 'type "tagsmatch")
12288 (push txt rtn))
12289 ((functionp action)
12290 (setq org-map-continue-from nil)
12291 (save-excursion
12292 (setq rtn1 (funcall action))
12293 (push rtn1 rtn)))
12294 (t (error "Invalid action")))
12296 ;; if we are to skip sublevels, jump to end of subtree
12297 (unless org-tags-match-list-sublevels
12298 (org-end-of-subtree t)
12299 (backward-char 1))))
12300 ;; Get the correct position from where to continue
12301 (if org-map-continue-from
12302 (goto-char org-map-continue-from)
12303 (and (= (point) lspos) (end-of-line 1)))))
12304 (when (and (eq action 'sparse-tree)
12305 (not org-sparse-tree-open-archived-trees))
12306 (org-hide-archived-subtrees (point-min) (point-max)))
12307 (nreverse rtn)))
12309 (defun org-remove-uniherited-tags (tags)
12310 "Remove all tags that are not inherited from the list TAGS."
12311 (cond
12312 ((eq org-use-tag-inheritance t)
12313 (if org-tags-exclude-from-inheritance
12314 (org-delete-all org-tags-exclude-from-inheritance tags)
12315 tags))
12316 ((not org-use-tag-inheritance) nil)
12317 ((stringp org-use-tag-inheritance)
12318 (delq nil (mapcar
12319 (lambda (x)
12320 (if (and (string-match org-use-tag-inheritance x)
12321 (not (member x org-tags-exclude-from-inheritance)))
12322 x nil))
12323 tags)))
12324 ((listp org-use-tag-inheritance)
12325 (delq nil (mapcar
12326 (lambda (x)
12327 (if (member x org-use-tag-inheritance) x nil))
12328 tags)))))
12330 (defvar todo-only) ;; dynamically scoped
12332 (defun org-match-sparse-tree (&optional todo-only match)
12333 "Create a sparse tree according to tags string MATCH.
12334 MATCH can contain positive and negative selection of tags, like
12336 If optional argument TODO-ONLY is non-nil, only select lines that are
12337 also TODO lines."
12338 (interactive "P")
12339 (org-prepare-agenda-buffers (list (current-buffer)))
12340 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12342 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12344 (defvar org-cached-props nil)
12345 (defun org-cached-entry-get (pom property)
12346 (if (or (eq t org-use-property-inheritance)
12347 (and (stringp org-use-property-inheritance)
12348 (string-match org-use-property-inheritance property))
12349 (and (listp org-use-property-inheritance)
12350 (member property org-use-property-inheritance)))
12351 ;; Caching is not possible, check it directly
12352 (org-entry-get pom property 'inherit)
12353 ;; Get all properties, so that we can do complicated checks easily
12354 (cdr (assoc property (or org-cached-props
12355 (setq org-cached-props
12356 (org-entry-properties pom)))))))
12358 (defun org-global-tags-completion-table (&optional files)
12359 "Return the list of all tags in all agenda buffer/files."
12360 (save-excursion
12361 (org-uniquify
12362 (delq nil
12363 (apply 'append
12364 (mapcar
12365 (lambda (file)
12366 (set-buffer (find-file-noselect file))
12367 (append (org-get-buffer-tags)
12368 (mapcar (lambda (x) (if (stringp (car-safe x))
12369 (list (car-safe x)) nil))
12370 org-tag-alist)))
12371 (if (and files (car files))
12372 files
12373 (org-agenda-files))))))))
12375 (defun org-make-tags-matcher (match)
12376 "Create the TAGS//TODO matcher form for the selection string MATCH."
12377 ;; todo-only is scoped dynamically into this function, and the function
12378 ;; may change it if the matcher asks for it.
12379 (unless match
12380 ;; Get a new match request, with completion
12381 (let ((org-last-tags-completion-table
12382 (org-global-tags-completion-table)))
12383 (setq match (org-completing-read-no-i
12384 "Match: " 'org-tags-completion-function nil nil nil
12385 'org-tags-history))))
12387 ;; Parse the string and create a lisp form
12388 (let ((match0 match)
12389 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12390 minus tag mm
12391 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12392 orterms term orlist re-p str-p level-p level-op time-p
12393 prop-p pn pv po gv rest)
12394 (if (string-match "/+" match)
12395 ;; match contains also a todo-matching request
12396 (progn
12397 (setq tagsmatch (substring match 0 (match-beginning 0))
12398 todomatch (substring match (match-end 0)))
12399 (if (string-match "^!" todomatch)
12400 (setq todo-only t todomatch (substring todomatch 1)))
12402 (setq todomatch nil)))
12403 ;; only matching tags
12404 (setq tagsmatch match todomatch nil))
12406 ;; Make the tags matcher
12408 (setq tagsmatcher t)
12409 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12410 (while (setq term (pop orterms))
12412 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12413 (while (string-match re term)
12414 (setq rest (substring term (match-end 0))
12415 minus (and (match-end 1)
12416 (equal (match-string 1 term) "-"))
12417 tag (save-match-data (replace-regexp-in-string
12419 (match-string 2 term)))
12420 re-p (equal (string-to-char tag) ?{)
12421 level-p (match-end 4)
12422 prop-p (match-end 5)
12423 mm (cond
12424 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12425 (level-p
12426 (setq level-op (org-op-to-function (match-string 3 term)))
12427 `(,level-op level ,(string-to-number
12428 (match-string 4 term))))
12429 (prop-p
12430 (setq pn (match-string 5 term)
12431 po (match-string 6 term)
12432 pv (match-string 7 term)
12433 re-p (equal (string-to-char pv) ?{)
12435 time-p (save-match-data
12437 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12438 (if time-p (setq pv (org-matcher-time pv)))
12439 (setq po (org-op-to-function po (if time-p 'time str-p)))
12440 (cond
12441 ((equal pn "CATEGORY")
12442 (setq gv '(get-text-property (point) 'org-category)))
12443 ((equal pn "TODO")
12444 (setq gv 'todo))
12445 (t
12446 (setq gv `(org-cached-entry-get nil ,pn))))
12447 (if re-p
12448 (if (eq po 'org<>)
12449 `(not (string-match ,pv (or ,gv "")))
12450 `(string-match ,pv (or ,gv "")))
12451 (if str-p
12452 `(,po (or ,gv "") ,pv)
12453 `(,po (string-to-number (or ,gv ""))
12454 ,(string-to-number pv) ))))
12455 (t `(member ,tag tags-list)))
12456 mm (if minus (list 'not mm) mm)
12457 term rest)
12458 (push mm tagsmatcher))
12459 (push (if (> (length tagsmatcher) 1)
12460 (cons 'and tagsmatcher)
12461 (car tagsmatcher))
12462 orlist)
12463 (setq tagsmatcher nil))
12464 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12465 (setq tagsmatcher
12466 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12467 ;; Make the todo matcher
12469 (setq todomatcher t)
12470 (setq orterms (org-split-string todomatch "|") orlist nil)
12471 (while (setq term (pop orterms))
12472 (while (string-match re term)
12473 (setq minus (and (match-end 1)
12474 (equal (match-string 1 term) "-"))
12475 kwd (match-string 2 term)
12476 re-p (equal (string-to-char kwd) ?{)
12477 term (substring term (match-end 0))
12478 mm (if re-p
12479 `(string-match ,(substring kwd 1 -1) todo)
12480 (list 'equal 'todo kwd))
12481 mm (if minus (list 'not mm) mm))
12482 (push mm todomatcher))
12483 (push (if (> (length todomatcher) 1)
12484 (cons 'and todomatcher)
12485 (car todomatcher))
12486 orlist)
12487 (setq todomatcher nil))
12488 (setq todomatcher (if (> (length orlist) 1)
12489 (cons 'or orlist) (car orlist))))
12491 ;; Return the string and lisp forms of the matcher
12492 (setq matcher (if todomatcher
12493 (list 'and tagsmatcher todomatcher)
12494 tagsmatcher))
12495 (cons match0 matcher)))
12497 (defun org-op-to-function (op &optional stringp)
12498 "Turn an operator into the appropriate function."
12499 (setq op
12500 (cond
12501 ((equal op "<" ) '(< string< org-time<))
12502 ((equal op ">" ) '(> org-string> org-time>))
12503 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12504 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12505 ((member op '("=" "==")) '(= string= org-time=))
12506 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12507 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12509 (defun org<> (a b) (not (= a b)))
12510 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12511 (defun org-string>= (a b) (not (string< a b)))
12512 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12513 (defun org-string<> (a b) (not (string= a b)))
12514 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12515 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12516 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12517 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12518 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12519 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12520 (defun org-2ft (s)
12521 "Convert S to a floating point time.
12522 If S is already a number, just return it. If it is a string, parse
12523 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12524 (cond
12525 ((numberp s) s)
12526 ((stringp s)
12527 (condition-case nil
12528 (float-time (apply 'encode-time (org-parse-time-string s)))
12529 (error 0.)))
12530 (t 0.)))
12532 (defun org-time-today ()
12533 "Time in seconds today at 0:00.
12534 Returns the float number of seconds since the beginning of the
12535 epoch to the beginning of today (00:00)."
12536 (float-time (apply 'encode-time
12537 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12539 (defun org-matcher-time (s)
12540 "Interpret a time comparison value."
12541 (save-match-data
12542 (cond
12543 ((string= s "<now>") (float-time))
12544 ((string= s "<today>") (org-time-today))
12545 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12546 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12548 (+ (org-time-today)
12549 (* (string-to-number (match-string 1 s))
12550 (cdr (assoc (match-string 2 s)
12551 '(("d" . 86400.0) ("w" . 604800.0)
12552 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12553 (t (org-2ft s)))))
12555 (defun org-match-any-p (re list)
12556 "Does re match any element of list?"
12557 (setq list (mapcar (lambda (x) (string-match re x)) list))
12558 (delq nil list))
12560 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12561 (defvar org-tags-overlay (make-overlay 1 1))
12562 (org-detach-overlay org-tags-overlay)
12564 (defun org-get-local-tags-at (&optional pos)
12565 "Get a list of tags defined in the current headline."
12566 (org-get-tags-at pos 'local))
12568 (defun org-get-local-tags ()
12569 "Get a list of tags defined in the current headline."
12570 (org-get-tags-at nil 'local))
12572 (defun org-get-tags-at (&optional pos local)
12573 "Get a list of all headline tags applicable at POS.
12574 POS defaults to point. If tags are inherited, the list contains
12575 the targets in the same sequence as the headlines appear, i.e.
12576 the tags of the current headline come last.
12577 When LOCAL is non-nil, only return tags from the current headline,
12578 ignore inherited ones."
12579 (interactive)
12580 (if (and org-trust-scanner-tags
12581 (or (not pos) (equal pos (point)))
12582 (not local))
12583 org-scanner-tags
12584 (let (tags ltags lastpos parent)
12585 (save-excursion
12586 (save-restriction
12587 (widen)
12588 (goto-char (or pos (point)))
12589 (save-match-data
12590 (catch 'done
12591 (condition-case nil
12592 (progn
12593 (org-back-to-heading t)
12594 (while (not (equal lastpos (point)))
12595 (setq lastpos (point))
12596 (when (looking-at
12598 (setq ltags (org-split-string
12599 (org-match-string-no-properties 1) ":"))
12600 (when parent
12601 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12602 (setq tags (append
12603 (if parent
12604 (org-remove-uniherited-tags ltags)
12605 ltags)
12606 tags)))
12607 (or org-use-tag-inheritance (throw 'done t))
12608 (if local (throw 'done t))
12609 (or (org-up-heading-safe) (error nil))
12610 (setq parent t)))
12611 (error nil)))))
12612 (append (org-remove-uniherited-tags org-file-tags) tags)))))
12614 (defun org-add-prop-inherited (s)
12615 (add-text-properties 0 (length s) '(inherited t) s)
12616 s)
12618 (defun org-toggle-tag (tag &optional onoff)
12619 "Toggle the tag TAG for the current line.
12620 If ONOFF is `on' or `off', don't toggle but set to this state."
12621 (let (res current)
12622 (save-excursion
12623 (org-back-to-heading t)
12625 (point-at-eol) t)
12626 (progn
12627 (setq current (match-string 1))
12628 (replace-match ""))
12629 (setq current ""))
12630 (setq current (nreverse (org-split-string current ":")))
12631 (cond
12632 ((eq onoff 'on)
12633 (setq res t)
12634 (or (member tag current) (push tag current)))
12635 ((eq onoff 'off)
12636 (or (not (member tag current)) (setq current (delete tag current))))
12637 (t (if (member tag current)
12638 (setq current (delete tag current))
12639 (setq res t)
12640 (push tag current))))
12641 (end-of-line 1)
12642 (if current
12643 (progn
12644 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12645 (org-set-tags nil t))
12646 (delete-horizontal-space))
12647 (run-hooks 'org-after-tags-change-hook))
12648 res))
12650 (defun org-align-tags-here (to-col)
12651 ;; Assumes that this is a headline
12652 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12653 (beginning-of-line 1)
12655 (< pos (match-beginning 2)))
12656 (progn
12657 (setq tags-l (- (match-end 2) (match-beginning 2)))
12658 (goto-char (match-beginning 1))
12659 (insert " ")
12660 (delete-region (point) (1+ (match-beginning 2)))
12661 (setq ncol (max (1+ (current-column))
12662 (1+ col)
12663 (if (> to-col 0)
12664 to-col
12665 (- (abs to-col) tags-l))))
12666 (setq p (point))
12667 (insert (make-string (- ncol (current-column)) ?\ ))
12668 (setq ncol (current-column))
12669 (when indent-tabs-mode (tabify p (point-at-eol)))
12670 (org-move-to-column (min ncol col) t))
12671 (goto-char pos))))
12673 (defun org-set-tags-command (&optional arg just-align)
12674 "Call the set-tags command for the current entry."
12675 (interactive "P")
12676 (if (org-on-heading-p)
12677 (org-set-tags arg just-align)
12678 (save-excursion
12679 (org-back-to-heading t)
12680 (org-set-tags arg just-align))))
12682 (defun org-set-tags-to (data)
12683 "Set the tags of the current entry to DATA, replacing the current tags.
12684 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12685 If DATA is nil or the empty string, any tags will be removed."
12686 (interactive "sTags: ")
12687 (setq data
12688 (cond
12689 ((eq data nil) "")
12690 ((equal data "") "")
12691 ((stringp data)
12692 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12693 ":"))
12694 ((listp data)
12695 (concat ":" (mapconcat 'identity data ":") ":"))
12696 (t nil)))
12697 (when data
12698 (save-excursion
12699 (org-back-to-heading t)
12700 (when (looking-at org-complex-heading-regexp)
12701 (if (match-end 5)
12702 (progn
12703 (goto-char (match-beginning 5))
12704 (insert data)
12705 (delete-region (point) (point-at-eol))
12706 (org-set-tags nil 'align))
12707 (goto-char (point-at-eol))
12708 (insert " " data)
12709 (org-set-tags nil 'align)))
12710 (beginning-of-line 1)
12712 (delete-region (match-beginning 1) (match-end 1))))))
12714 (defun org-align-all-tags ()
12715 "Align the tags i all headings."
12716 (interactive)
12717 (save-excursion
12718 (or (ignore-errors (org-back-to-heading t))
12719 (outline-next-heading))
12720 (if (org-on-heading-p)
12721 (org-set-tags t)
12722 (message "No headings"))))
12724 (defvar org-indent-indentation-per-level)
12725 (defun org-set-tags (&optional arg just-align)
12726 "Set the tags for the current headline.
12727 With prefix ARG, realign all tags in headings in the current buffer."
12728 (interactive "P")
12729 (let* ((re (concat "^" outline-regexp))
12730 (current (org-get-tags-string))
12731 (col (current-column))
12732 (org-setting-tags t)
12733 table current-tags inherited-tags ; computed below when needed
12734 tags p0 c0 c1 rpl di tc level)
12735 (if arg
12736 (save-excursion
12737 (goto-char (point-min))
12738 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12739 (while (re-search-forward re nil t)
12740 (org-set-tags nil t)
12741 (end-of-line 1)))
12742 (message "All tags realigned to column %d" org-tags-column))
12743 (if just-align
12744 (setq tags current)
12745 ;; Get a new set of tags from the user
12746 (save-excursion
12747 (setq table (append org-tag-persistent-alist
12748 (or org-tag-alist (org-get-buffer-tags))
12749 (and
12750 org-complete-tags-always-offer-all-agenda-tags
12751 (org-global-tags-completion-table
12752 (org-agenda-files))))
12753 org-last-tags-completion-table table
12754 current-tags (org-split-string current ":")
12755 inherited-tags (nreverse
12756 (nthcdr (length current-tags)
12757 (nreverse (org-get-tags-at))))
12758 tags
12759 (if (or (eq t org-use-fast-tag-selection)
12760 (and org-use-fast-tag-selection
12761 (delq nil (mapcar 'cdr table))))
12762 (org-fast-tag-selection
12763 current-tags inherited-tags table
12764 (if org-fast-tag-selection-include-todo
12765 org-todo-key-alist))
12766 (let ((org-add-colon-after-tag-completion t))
12767 (org-trim
12768 (org-without-partial-completion
12769 (org-icompleting-read "Tags: "
12770 'org-tags-completion-function
12771 nil nil current 'org-tags-history)))))))
12772 (while (string-match "[-+&]+" tags)
12773 ;; No boolean logic, just a list
12774 (setq tags (replace-match ":" t t tags))))
12776 (setq tags (replace-regexp-in-string "[ ,]" ":" tags))
12778 (if org-tags-sort-function
12779 (setq tags (mapconcat 'identity
12780 (sort (org-split-string
12781 tags (org-re "[^[:alnum:]_@#%]+"))
12782 org-tags-sort-function) ":")))
12785 (setq tags "")
12786 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12787 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12789 ;; Insert new tags at the correct column
12790 (beginning-of-line 1)
12791 (setq level (or (and (looking-at org-outline-regexp)
12792 (- (match-end 0) (point) 1))
12793 1))
12794 (cond
12795 ((and (equal current "") (equal tags "")))
12796 ((re-search-forward
12798 (point-at-eol) t)
12799 (if (equal tags "")
12800 (setq rpl "")
12801 (goto-char (match-beginning 0))
12802 (setq c0 (current-column)
12803 ;; compute offset for the case of org-indent-mode active
12804 di (if org-indent-mode
12805 (* (1- org-indent-indentation-per-level) (1- level))
12806 0)
12807 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
12808 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
12809 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
12810 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12811 (replace-match rpl t t)
12812 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
12813 tags)
12814 (t (error "Tags alignment failed")))
12815 (org-move-to-column col)
12816 (unless just-align
12817 (run-hooks 'org-after-tags-change-hook)))))
12819 (defun org-change-tag-in-region (beg end tag off)
12820 "Add or remove TAG for each entry in the region.
12821 This works in the agenda, and also in an org-mode buffer."
12822 (interactive
12823 (list (region-beginning) (region-end)
12824 (let ((org-last-tags-completion-table
12825 (if (org-mode-p)
12826 (org-get-buffer-tags)
12827 (org-global-tags-completion-table))))
12828 (org-icompleting-read
12829 "Tag: " 'org-tags-completion-function nil nil nil
12830 'org-tags-history))
12831 (progn
12833 (equal (read-char-exclusive) ?r))))
12834 (if (fboundp 'deactivate-mark) (deactivate-mark))
12835 (let ((agendap (equal major-mode 'org-agenda-mode))
12836 l1 l2 m buf pos newhead (cnt 0))
12837 (goto-char end)
12838 (setq l2 (1- (org-current-line)))
12839 (goto-char beg)
12840 (setq l1 (org-current-line))
12841 (loop for l from l1 to l2 do
12842 (org-goto-line l)
12843 (setq m (get-text-property (point) 'org-hd-marker))
12844 (when (or (and (org-mode-p) (org-on-heading-p))
12845 (and agendap m))
12846 (setq buf (if agendap (marker-buffer m) (current-buffer))
12847 pos (if agendap m (point)))
12848 (with-current-buffer buf
12849 (save-excursion
12850 (save-restriction
12851 (goto-char pos)
12852 (setq cnt (1+ cnt))
12853 (org-toggle-tag tag (if off 'off 'on))
12854 (setq newhead (org-get-heading)))))
12855 (and agendap (org-agenda-change-all-lines newhead m))))
12856 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
12858 (defun org-tags-completion-function (string predicate &optional flag)
12859 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12860 (confirm (lambda (x) (stringp (car x)))))
12862 (setq s1 (match-string 1 string)
12863 s2 (match-string 2 string))
12864 (setq s1 "" s2 string))
12865 (cond
12866 ((eq flag nil)
12867 ;; try completion
12868 (setq rtn (try-completion s2 ctable confirm))
12869 (if (stringp rtn)
12870 (setq rtn
12871 (concat s1 s2 (substring rtn (length s2))
12872 (if (and org-add-colon-after-tag-completion
12873 (assoc rtn ctable))
12874 ":" ""))))
12875 rtn)
12876 ((eq flag t)
12877 ;; all-completions
12878 (all-completions s2 ctable confirm)
12879 )
12880 ((eq flag 'lambda)
12881 ;; exact match?
12882 (assoc s2 ctable)))
12883 ))
12885 (defun org-fast-tag-insert (kwd tags face &optional end)
12886 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
12887 (insert (format "%-12s" (concat kwd ":"))
12888 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
12889 (or end "")))
12891 (defun org-fast-tag-show-exit (flag)
12892 (save-excursion
12893 (org-goto-line 3)
12895 (replace-match ""))
12896 (when flag
12897 (end-of-line 1)
12898 (org-move-to-column (- (window-width) 19) t)
12899 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
12901 (defun org-set-current-tags-overlay (current prefix)
12902 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
12903 (if (featurep 'xemacs)
12904 (org-overlay-display org-tags-overlay (concat prefix s)
12905 'secondary-selection)
12906 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
12907 (org-overlay-display org-tags-overlay (concat prefix s)))))
12909 (defvar org-last-tag-selection-key nil)
12910 (defun org-fast-tag-selection (current inherited table &optional todo-table)
12911 "Fast tag selection with single keys.
12912 CURRENT is the current list of tags in the headline, INHERITED is the
12913 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
12914 possibly with grouping information. TODO-TABLE is a similar table with
12915 TODO keywords, should these have keys assigned to them.
12916 If the keys are nil, a-z are automatically assigned.
12917 Returns the new tags string, or nil to not change the current settings."
12918 (let* ((fulltable (append table todo-table))
12919 (maxlen (apply 'max (mapcar
12920 (lambda (x)
12921 (if (stringp (car x)) (string-width (car x)) 0))
12922 fulltable)))
12923 (buf (current-buffer))
12924 (expert (eq org-fast-tag-selection-single-key 'expert))
12925 (buffer-tags nil)
12926 (fwidth (+ maxlen 3 1 3))
12927 (ncol (/ (- (window-width) 4) fwidth))
12928 (i-face 'org-done)
12929 (c-face 'org-todo)
12930 tg cnt e c char c1 c2 ntable tbl rtn
12931 ov-start ov-end ov-prefix
12932 (exit-after-next org-fast-tag-selection-single-key)
12933 (done-keywords org-done-keywords)
12934 groups ingroup)
12935 (save-excursion
12936 (beginning-of-line 1)
12937 (if (looking-at
12939 (setq ov-start (match-beginning 1)
12940 ov-end (match-end 1)
12941 ov-prefix "")
12942 (setq ov-start (1- (point-at-eol))
12943 ov-end (1+ ov-start))
12945 (setq ov-prefix
12946 (concat
12947 (buffer-substring (1- (point)) (point))
12948 (if (> (current-column) org-tags-column)
12949 " "
12950 (make-string (- org-tags-column (current-column)) ?\ ))))))
12951 (move-overlay org-tags-overlay ov-start ov-end)
12952 (save-window-excursion
12953 (if expert
12954 (set-buffer (get-buffer-create " *Org tags*"))
12955 (delete-other-windows)
12956 (split-window-vertically)
12957 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
12958 (erase-buffer)
12959 (org-set-local 'org-done-keywords done-keywords)
12962 (org-fast-tag-show-exit exit-after-next)
12963 (org-set-current-tags-overlay current ov-prefix)
12964 (setq tbl fulltable char ?a cnt 0)
12965 (while (setq e (pop tbl))
12966 (cond
12967 ((equal (car e) :startgroup)
12968 (push '() groups) (setq ingroup t)
12969 (when (not (= cnt 0))
12970 (setq cnt 0)
12972 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
12973 ((equal (car e) :endgroup)
12974 (setq ingroup nil cnt 0)
12976 ((equal e '(:newline))
12977 (when (not (= cnt 0))
12978 (setq cnt 0)
12980 (setq e (car tbl))
12981 (while (equal (car tbl) '(:newline))
12983 (setq tbl (cdr tbl)))))
12984 (t
12985 (setq tg (copy-sequence (car e)) c2 nil)
12986 (if (cdr e)
12987 (setq c (cdr e))
12988 ;; automatically assign a character.
12989 (setq c1 (string-to-char
12990 (downcase (substring
12991 tg (if (= (string-to-char tg) ?@) 1 0)))))
12992 (if (or (rassoc c1 ntable) (rassoc c1 table))
12993 (while (or (rassoc char ntable) (rassoc char table))
12994 (setq char (1+ char)))
12995 (setq c2 c1))
12996 (setq c (or c2 char)))
12997 (if ingroup (push tg (car groups)))
12998 (setq tg (org-add-props tg nil 'face
12999 (cond
13000 ((not (assoc tg table))
13001 (org-get-todo-face tg))
13002 ((member tg current) c-face)
13003 ((member tg inherited) i-face)
13004 (t nil))))
13005 (if (and (= cnt 0) (not ingroup)) (insert " "))
13006 (insert "[" c "] " tg (make-string
13007 (- fwidth 4 (length tg)) ?\ ))
13008 (push (cons tg c) ntable)
13009 (when (= (setq cnt (1+ cnt)) ncol)
13011 (if ingroup (insert " "))
13012 (setq cnt 0)))))
13013 (setq ntable (nreverse ntable))
13015 (goto-char (point-min))
13016 (if (not expert) (org-fit-window-to-buffer))
13017 (setq rtn
13018 (catch 'exit
13019 (while t
13020 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13021 (if (not groups) "no " "")
13022 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13023 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13024 (setq org-last-tag-selection-key c)
13025 (cond
13027 ((= c ?!)
13028 (setq groups (not groups))
13029 (goto-char (point-min))
13030 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13031 ((= c ?\C-c)
13032 (if (not expert)
13033 (org-fast-tag-show-exit
13034 (setq exit-after-next (not exit-after-next)))
13035 (setq expert nil)
13036 (delete-other-windows)
13037 (set-window-buffer (split-window-vertically) " *Org tags*")
13038 (org-switch-to-buffer-other-window " *Org tags*")
13039 (org-fit-window-to-buffer)))
13040 ((or (= c ?\C-g)
13041 (and (= c ?q) (not (rassoc c ntable))))
13042 (org-detach-overlay org-tags-overlay)
13043 (setq quit-flag t))
13044 ((= c ?\ )
13045 (setq current nil)
13046 (if exit-after-next (setq exit-after-next 'now)))
13048 (condition-case nil
13049 (setq tg (org-icompleting-read
13050 "Tag: "
13051 (or buffer-tags
13052 (with-current-buffer buf
13053 (org-get-buffer-tags)))))
13054 (quit (setq tg "")))
13056 (add-to-list 'buffer-tags (list tg))
13057 (if (member tg current)
13058 (setq current (delete tg current))
13059 (push tg current)))
13060 (if exit-after-next (setq exit-after-next 'now)))
13061 ((setq e (rassoc c todo-table) tg (car e))
13062 (with-current-buffer buf
13063 (save-excursion (org-todo tg)))
13064 (if exit-after-next (setq exit-after-next 'now)))
13065 ((setq e (rassoc c ntable) tg (car e))
13066 (if (member tg current)
13067 (setq current (delete tg current))
13068 (loop for g in groups do
13069 (if (member tg g)
13070 (mapc (lambda (x)
13071 (setq current (delete x current)))
13072 g)))
13073 (push tg current))
13074 (if exit-after-next (setq exit-after-next 'now))))
13076 ;; Create a sorted list
13077 (setq current
13078 (sort current
13079 (lambda (a b)
13080 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13081 (if (eq exit-after-next 'now) (throw 'exit t))
13082 (goto-char (point-min))
13083 (beginning-of-line 2)
13084 (delete-region (point) (point-at-eol))
13085 (org-fast-tag-insert "Current" current c-face)
13086 (org-set-current-tags-overlay current ov-prefix)
13087 (while (re-search-forward
13089 (setq tg (match-string 1))
13090 (add-text-properties
13091 (match-beginning 1) (match-end 1)
13092 (list 'face
13093 (cond
13094 ((member tg current) c-face)
13095 ((member tg inherited) i-face)
13096 (t (get-text-property (match-beginning 1) 'face))))))
13097 (goto-char (point-min)))))
13098 (org-detach-overlay org-tags-overlay)
13099 (if rtn
13100 (mapconcat 'identity current ":")
13101 nil))))
13103 (defun org-get-tags-string ()
13104 "Get the TAGS string in the current headline."
13105 (unless (org-on-heading-p t)
13106 (error "Not on a heading"))
13107 (save-excursion
13108 (beginning-of-line 1)
13110 (org-match-string-no-properties 1)
13111 "")))
13113 (defun org-get-tags ()
13114 "Get the list of tags specified in the current headline."
13115 (org-split-string (org-get-tags-string) ":"))
13117 (defun org-get-buffer-tags ()
13118 "Get a table of all tags used in the buffer, for completion."
13119 (let (tags)
13120 (save-excursion
13121 (goto-char (point-min))
13122 (while (re-search-forward
13124 (when (equal (char-after (point-at-bol 0)) ?*)
13125 (mapc (lambda (x) (add-to-list 'tags x))
13126 (org-split-string (org-match-string-no-properties 1) ":")))))
13127 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13128 (mapcar 'list tags)))
13130 ;;;; The mapping API
13132 ;;;###autoload
13133 (defun org-map-entries (func &optional match scope &rest skip)
13134 "Call FUNC at each headline selected by MATCH in SCOPE.
13136 FUNC is a function or a lisp form. The function will be called without
13137 arguments, with the cursor positioned at the beginning of the headline.
13138 The return values of all calls to the function will be collected and
13139 returned as a list.
13141 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13142 does not need to preserve point. After evaluation, the cursor will be
13143 moved to the end of the line (presumably of the headline of the
13144 processed entry) and search continues from there. Under some
13145 circumstances, this may not produce the wanted results. For example,
13146 if you have removed (e.g. archived) the current (sub)tree it could
13147 mean that the next entry will be skipped entirely. In such cases, you
13148 can specify the position from where search should continue by making
13149 FUNC set the variable `org-map-continue-from' to the desired buffer
13150 position.
13152 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13153 Only headlines that are matched by this query will be considered during
13154 the iteration. When MATCH is nil or t, all headlines will be
13155 visited by the iteration.
13157 SCOPE determines the scope of this command. It can be any of:
13159 nil The current buffer, respecting the restriction if any
13160 tree The subtree started with the entry at point
13161 file The current buffer, without restriction
13162 file-with-archives
13163 The current buffer, and any archives associated with it
13164 agenda All agenda files
13165 agenda-with-archives
13166 All agenda files with any archive files associated with them
13167 \(file1 file2 ...)
13168 If this is a list, all files in the list will be scanned
13170 The remaining args are treated as settings for the skipping facilities of
13171 the scanner. The following items can be given here:
13173 archive skip trees with the archive tag.
13174 comment skip trees with the COMMENT keyword
13175 function or Emacs Lisp form:
13176 will be used as value for `org-agenda-skip-function', so whenever
13177 the function returns t, FUNC will not be called for that
13178 entry and search will continue from the point where the
13179 function leaves it.
13181 If your function needs to retrieve the tags including inherited tags
13182 at the *current* entry, you can use the value of the variable
13183 `org-scanner-tags' which will be much faster than getting the value
13184 with `org-get-tags-at'. If your function gets properties with
13185 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13186 to t around the call to `org-entry-properties' to get the same speedup.
13187 Note that if your function moves around to retrieve tags and properties at
13188 a *different* entry, you cannot use these techniques."
13189 (let* ((org-agenda-archives-mode nil) ; just to make sure
13190 (org-agenda-skip-archived-trees (memq 'archive skip))
13191 (org-agenda-skip-comment-trees (memq 'comment skip))
13192 (org-agenda-skip-function
13193 (car (org-delete-all '(comment archive) skip)))
13194 (org-tags-match-list-sublevels t)
13195 matcher file res
13196 org-todo-keywords-for-agenda
13197 org-done-keywords-for-agenda
13198 org-todo-keyword-alist-for-agenda
13199 org-drawers-for-agenda
13200 org-tag-alist-for-agenda)
13202 (cond
13203 ((eq match t) (setq matcher t))
13204 ((eq match nil) (setq matcher t))
13205 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13207 (save-excursion
13208 (save-restriction
13209 (when (eq scope 'tree)
13210 (org-back-to-heading t)
13211 (org-narrow-to-subtree)
13212 (setq scope nil))
13214 (if (not scope)
13215 (progn
13216 (org-prepare-agenda-buffers
13217 (list (buffer-file-name (current-buffer))))
13218 (setq res (org-scan-tags func matcher)))
13219 ;; Get the right scope
13220 (cond
13221 ((and scope (listp scope) (symbolp (car scope)))
13222 (setq scope (eval scope)))
13223 ((eq scope 'agenda)
13224 (setq scope (org-agenda-files t)))
13225 ((eq scope 'agenda-with-archives)
13226 (setq scope (org-agenda-files t))
13227 (setq scope (org-add-archive-files scope)))
13228 ((eq scope 'file)
13229 (setq scope (list (buffer-file-name))))
13230 ((eq scope 'file-with-archives)
13231 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13232 (org-prepare-agenda-buffers scope)
13233 (while (setq file (pop scope))
13234 (with-current-buffer (org-find-base-buffer-visiting file)
13235 (save-excursion
13236 (save-restriction
13237 (widen)
13238 (goto-char (point-min))
13239 (setq res (append res (org-scan-tags func matcher))))))))))
13240 res))
13242 ;;;; Properties
13244 ;;; Setting and retrieving properties
13246 (defconst org-special-properties
13247 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13248 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE")
13249 "The special properties valid in Org-mode.
13251 These are properties that are not defined in the property drawer,
13252 but in some other way.")
13254 (defconst org-default-properties
13255 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13256 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13257 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13258 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13259 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13260 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13261 "Some properties that are used by Org-mode for various purposes.
13262 Being in this list makes sure that they are offered for completion.")
13265 "Regular expression matching the first line of a property drawer.")
13268 "Regular expression matching the last line of a property drawer.")
13271 "Regular expression matching the first line of a property drawer.")
13274 "Regular expression matching the first line of a property drawer.")
13276 (defconst org-property-drawer-re
13279 "Matches an entire property drawer.")
13281 (defconst org-clock-drawer-re
13284 "Matches an entire clock drawer.")
13286 (defun org-property-action ()
13287 "Do an action on properties."
13288 (interactive)
13289 (let (c)
13290 (org-at-property-p)
13291 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13292 (setq c (read-char-exclusive))
13293 (cond
13294 ((equal c ?s)
13295 (call-interactively 'org-set-property))
13296 ((equal c ?d)
13297 (call-interactively 'org-delete-property))
13298 ((equal c ?D)
13299 (call-interactively 'org-delete-property-globally))
13300 ((equal c ?c)
13301 (call-interactively 'org-compute-property-at-point))
13302 (t (error "No such property action %c" c)))))
13304 (defun org-set-effort (&optional value)
13305 "Set the effort property of the current entry.
13306 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13307 allowed value."
13308 (interactive "P")
13309 (if (equal value 0) (setq value 10))
13310 (let* ((completion-ignore-case t)
13311 (prop org-effort-property)
13312 (cur (org-entry-get nil prop))
13313 (allowed (org-property-get-allowed-values nil prop 'table))
13314 (existing (mapcar 'list (org-property-values prop)))
13315 rpl
13316 (val (cond
13317 ((stringp value) value)
13318 ((and allowed (integerp value))
13319 (or (car (nth (1- value) allowed))
13320 (car (org-last allowed))))
13321 (allowed
13322 (message "Select 1-9,0, [RET%s]: %s"
13323 (if cur (concat "=" cur) "")
13324 (mapconcat 'car allowed " "))
13325 (setq rpl (read-char-exclusive))
13327 cur
13328 (setq rpl (- rpl ?0))
13329 (if (equal rpl 0) (setq rpl 10))
13330 (if (and (> rpl 0) (<= rpl (length allowed)))
13331 (car (nth (1- rpl) allowed))
13332 (org-completing-read "Effort: " allowed nil))))
13333 (t
13334 (let (org-completion-use-ido org-completion-use-iswitchb)
13335 (org-completing-read
13337 (concat "[" cur "]") "")
13338 ": ")
13339 existing nil nil "" nil cur))))))
13340 (unless (equal (org-entry-get nil prop) val)
13341 (org-entry-put nil prop val))
13342 (message "%s is now %s" prop val)))
13344 (defun org-at-property-p ()
13345 "Is cursor inside a property drawer?"
13346 (save-excursion
13347 (beginning-of-line 1)
13349 (save-match-data ;; Used by calling procedures
13350 (let ((p (point))
13351 (range (unless (org-before-first-heading-p)
13352 (org-get-property-block))))
13353 (and range (<= (car range) p) (< p (cdr range))))))))
13355 (defun org-get-property-block (&optional beg end force)
13356 "Return the (beg . end) range of the body of the property drawer.
13357 BEG and END can be beginning and end of subtree, if not given
13358 they will be found.
13359 If the drawer does not exist and FORCE is non-nil, create the drawer."
13360 (catch 'exit
13361 (save-excursion
13362 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13363 (end (or end (progn (outline-next-heading) (point)))))
13364 (goto-char beg)
13365 (if (re-search-forward org-property-start-re end t)
13366 (setq beg (1+ (match-end 0)))
13367 (if force
13368 (save-excursion
13369 (org-insert-property-drawer)
13370 (setq end (progn (outline-next-heading) (point))))
13371 (throw 'exit nil))
13372 (goto-char beg)
13373 (if (re-search-forward org-property-start-re end t)
13374 (setq beg (1+ (match-end 0)))))
13375 (if (re-search-forward org-property-end-re end t)
13376 (setq end (match-beginning 0))
13377 (or force (throw 'exit nil))
13378 (goto-char beg)
13379 (setq end beg)
13380 (org-indent-line-function)
13382 (cons beg end)))))
13384 (defun org-entry-properties (&optional pom which specific)
13385 "Get all properties of the entry at point-or-marker POM.
13386 This includes the TODO keyword, the tags, time strings for deadline,
13387 scheduled, and clocking, and any additional properties defined in the
13388 entry. The return value is an alist, keys may occur multiple times
13389 if the property key was used several times.
13390 POM may also be nil, in which case the current entry is used.
13391 If WHICH is nil or `all', get all properties. If WHICH is
13392 `special' or `standard', only get that subclass. If WHICH
13393 is a string only get exactly this property. SPECIFIC can be a string, the
13394 specific property we are interested in. Specifying it can speed
13395 things up because then unnecessary parsing is avoided."
13396 (setq which (or which 'all))
13397 (org-with-point-at pom
13398 (let ((clockstr (substring org-clock-string 0 -1))
13399 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13400 (case-fold-search nil)
13401 beg end range props sum-props key key1 value string clocksum)
13402 (save-excursion
13403 (when (condition-case nil
13404 (and (org-mode-p) (org-back-to-heading t))
13405 (error nil))
13406 (setq beg (point))
13407 (setq sum-props (get-text-property (point) 'org-summaries))
13408 (setq clocksum (get-text-property (point) :org-clock-minutes))
13409 (outline-next-heading)
13410 (setq end (point))
13411 (when (memq which '(all special))
13412 ;; Get the special properties, like TODO and tags
13413 (goto-char beg)
13414 (when (and (or (not specific) (string= specific "TODO"))
13415 (looking-at org-todo-line-regexp) (match-end 2))
13416 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13417 (when (and (or (not specific) (string= specific "PRIORITY"))
13418 (looking-at org-priority-regexp))
13419 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13420 (when (or (not specific) (string= specific "FILE"))
13421 (push (cons "FILE" buffer-file-name) props))
13422 (when (and (or (not specific) (string= specific "TAGS"))
13423 (setq value (org-get-tags-string))
13425 (push (cons "TAGS" value) props))
13426 (when (and (or (not specific) (string= specific "ALLTAGS"))
13427 (setq value (org-get-tags-at)))
13428 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13429 ":"))
13430 props))
13431 (when (or (not specific) (string= specific "BLOCKED"))
13432 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13433 (when (or (not specific)
13434 (member specific
13435 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13436 "TIMESTAMP" "TIMESTAMP_IA")))
13437 (catch 'match
13438 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13439 (setq key (if (match-end 1)
13440 (substring (org-match-string-no-properties 1)
13441 0 -1))
13442 string (if (equal key clockstr)
13443 (org-no-properties
13444 (org-trim
13445 (buffer-substring
13446 (match-beginning 3) (goto-char
13447 (point-at-eol)))))
13448 (substring (org-match-string-no-properties 3)
13449 1 -1)))
13450 ;; Get the correct property name from the key. This is
13451 ;; necessary if the user has configured time keywords.
13452 (setq key1 (concat key ":"))
13453 (cond
13454 ((not key)
13455 (setq key
13456 (if (= (char-after (match-beginning 3)) ?\[)
13457 "TIMESTAMP_IA" "TIMESTAMP")))
13458 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13459 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13460 ((equal key1 org-closed-string) (setq key "CLOSED"))
13461 ((equal key1 org-clock-string) (setq key "CLOCK")))
13462 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13463 (progn
13464 (push (cons key string) props)
13465 ;; no need to search further if match is found
13466 (throw 'match t))
13467 (when (or (equal key "CLOCK") (not (assoc key props)))
13468 (push (cons key string) props))))))
13469 )
13471 (when (memq which '(all standard))
13472 ;; Get the standard properties, like :PROP: ...
13473 (setq range (org-get-property-block beg end))
13474 (when range
13475 (goto-char (car range))
13476 (while (re-search-forward
13478 (cdr range) t)
13479 (setq key (org-match-string-no-properties 1)
13480 value (org-trim (or (org-match-string-no-properties 2) "")))
13481 (unless (member key excluded)
13482 (push (cons key (or value "")) props)))))
13483 (if clocksum
13484 (push (cons "CLOCKSUM"
13485 (org-columns-number-to-string (/ (float clocksum) 60.)
13486 'add_times))
13487 props))
13488 (unless (assoc "CATEGORY" props)
13489 (push (cons "CATEGORY" (org-get-category)) props))
13490 (append sum-props (nreverse props)))))))
13492 (defun org-entry-get (pom property &optional inherit literal-nil)
13493 "Get value of PROPERTY for entry at point-or-marker POM.
13494 If INHERIT is non-nil and the entry does not have the property,
13495 then also check higher levels of the hierarchy.
13496 If INHERIT is the symbol `selective', use inheritance only if the setting
13497 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13498 If the property is present but empty, the return value is the empty string.
13499 If the property is not present at all, nil is returned.
13502 do not interpret it as the list atom nil. This is used for inheritance
13504 (org-with-point-at pom
13505 (if (and inherit (if (eq inherit 'selective)
13506 (org-property-inherit-p property)
13507 t))
13508 (org-entry-get-with-inheritance property literal-nil)
13509 (if (member property org-special-properties)
13510 ;; We need a special property. Use `org-entry-properties' to
13511 ;; retrieve it, but specify the wanted property
13512 (cdr (assoc property (org-entry-properties nil 'special property)))
13513 (let ((range (org-get-property-block)))
13514 (if (and range
13515 (goto-char (car range))
13516 (re-search-forward
13518 (cdr range) t))
13519 ;; Found the property, return it.
13520 (if (match-end 1)
13521 (if literal-nil
13522 (org-match-string-no-properties 1)
13523 (org-not-nil (org-match-string-no-properties 1)))
13524 "")))))))
13526 (defun org-property-or-variable-value (var &optional inherit)
13527 "Check if there is a property fixing the value of VAR.
13528 If yes, return this value. If not, return the current value of the variable."
13529 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13531 (read prop)
13532 (symbol-value var))))
13534 (defun org-entry-delete (pom property)
13535 "Delete the property PROPERTY from entry at point-or-marker POM."
13536 (org-with-point-at pom
13537 (if (member property org-special-properties)
13538 nil ; cannot delete these properties.
13539 (let ((range (org-get-property-block)))
13540 (if (and range
13541 (goto-char (car range))
13542 (re-search-forward
13544 (cdr range) t))
13545 (progn
13546 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13547 t)
13548 nil)))))
13550 ;; Multi-values properties are properties that contain multiple values
13551 ;; These values are assumed to be single words, separated by whitespace.
13552 (defun org-entry-add-to-multivalued-property (pom property value)
13553 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13554 (let* ((old (org-entry-get pom property))
13556 (setq value (org-entry-protect-space value))
13557 (unless (member value values)
13558 (setq values (cons value values))
13559 (org-entry-put pom property
13560 (mapconcat 'identity values " ")))))
13562 (defun org-entry-remove-from-multivalued-property (pom property value)
13563 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13564 (let* ((old (org-entry-get pom property))
13566 (setq value (org-entry-protect-space value))
13567 (when (member value values)
13568 (setq values (delete value values))
13569 (org-entry-put pom property
13570 (mapconcat 'identity values " ")))))
13572 (defun org-entry-member-in-multivalued-property (pom property value)
13573 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13574 (let* ((old (org-entry-get pom property))
13576 (setq value (org-entry-protect-space value))
13577 (member value values)))
13579 (defun org-entry-get-multivalued-property (pom property)
13580 "Return a list of values in a multivalued property."
13581 (let* ((value (org-entry-get pom property))
13583 (mapcar 'org-entry-restore-space values)))
13585 (defun org-entry-put-multivalued-property (pom property &rest values)
13586 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13587 VALUES should be a list of strings. Spaces will be protected."
13588 (org-entry-put pom property
13589 (mapconcat 'org-entry-protect-space values " "))
13590 (let* ((value (org-entry-get pom property))
13592 (mapcar 'org-entry-restore-space values)))
13594 (defun org-entry-protect-space (s)
13595 "Protect spaces and newline in string S."
13596 (while (string-match " " s)
13597 (setq s (replace-match "%20" t t s)))
13599 (setq s (replace-match "%0A" t t s)))
13600 s)
13602 (defun org-entry-restore-space (s)
13603 "Restore spaces and newline in string S."
13604 (while (string-match "%20" s)
13605 (setq s (replace-match " " t t s)))
13606 (while (string-match "%0A" s)
13608 s)
13610 (defvar org-entry-property-inherited-from (make-marker)
13611 "Marker pointing to the entry from where a property was inherited.
13612 Each call to `org-entry-get-with-inheritance' will set this marker to the
13613 location of the entry where the inheritance search matched. If there was
13614 no match, the marker will point nowhere.
13615 Note that also `org-entry-get' calls this function, if the INHERIT flag
13616 is set.")
13618 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13619 "Get entry property, and search higher levels if not present.
13620 The search will stop at the first ancestor which has the property defined.
13622 should be considered as undefined (this is the meaning of nil here).
13624 (move-marker org-entry-property-inherited-from nil)
13625 (let (tmp)
13626 (save-excursion
13627 (save-restriction
13628 (widen)
13629 (catch 'ex
13630 (while t
13631 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13632 (org-back-to-heading t)
13633 (move-marker org-entry-property-inherited-from (point))
13634 (throw 'ex tmp))
13635 (or (org-up-heading-safe) (throw 'ex nil)))))
13636 (setq tmp (or tmp
13637 (cdr (assoc property org-file-properties))
13638 (cdr (assoc property org-global-properties))
13639 (cdr (assoc property org-global-properties-fixed))))
13640 (if literal-nil tmp (org-not-nil tmp)))))
13642 (defvar org-property-changed-functions nil
13643 "Hook called when the value of a property has changed.
13644 Each hook function should accept two arguments, the name of the property
13645 and the new value.")
13647 (defun org-entry-put (pom property value)
13648 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13649 (org-with-point-at pom
13650 (org-back-to-heading t)
13651 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13652 range)
13653 (cond
13654 ((equal property "TODO")
13656 (not (member value org-todo-keywords-1)))
13658 (if (or (not value)
13660 (setq value 'none))
13661 (org-todo value)
13662 (org-set-tags nil 'align))
13663 ((equal property "PRIORITY")
13665 (string-to-char value) ?\ ))
13666 (org-set-tags nil 'align))
13667 ((equal property "SCHEDULED")
13668 (if (re-search-forward org-scheduled-time-regexp end t)
13669 (cond
13670 ((eq value 'earlier) (org-timestamp-change -1 'day))
13671 ((eq value 'later) (org-timestamp-change 1 'day))
13672 (t (call-interactively 'org-schedule)))
13673 (call-interactively 'org-schedule)))
13674 ((equal property "DEADLINE")
13675 (if (re-search-forward org-deadline-time-regexp end t)
13676 (cond
13677 ((eq value 'earlier) (org-timestamp-change -1 'day))
13678 ((eq value 'later) (org-timestamp-change 1 'day))
13679 (t (call-interactively 'org-deadline)))
13680 (call-interactively 'org-deadline)))
13681 ((member property org-special-properties)
13682 (error "The %s property can not yet be set with `org-entry-put'"
13683 property))
13684 (t ; a non-special property
13685 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13686 (setq range (org-get-property-block beg end 'force))
13687 (goto-char (car range))
13688 (if (re-search-forward
13690 (progn
13691 (delete-region (match-beginning 1) (match-end 1))
13692 (goto-char (match-beginning 1)))
13693 (goto-char (cdr range))
13695 (backward-char 1)
13696 (org-indent-line-function)
13697 (insert ":" property ":"))
13698 (and value (insert " " value))
13699 (org-indent-line-function)))))
13700 (run-hook-with-args 'org-property-changed-functions property value)))
13702 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13703 "Get all property keys in the current buffer.
13704 With INCLUDE-SPECIALS, also list the special properties that reflect things
13705 like tags and TODO state.
13706 With INCLUDE-DEFAULTS, also include properties that has special meaning
13707 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
13708 With INCLUDE-COLUMNS, also include property names given in COLUMN
13709 formats in the current buffer."
13710 (let (rtn range cfmt s p)
13711 (save-excursion
13712 (save-restriction
13713 (widen)
13714 (goto-char (point-min))
13715 (while (re-search-forward org-property-start-re nil t)
13716 (setq range (org-get-property-block))
13717 (goto-char (car range))
13718 (while (re-search-forward
13720 (cdr range) t)
13721 (add-to-list 'rtn (org-match-string-no-properties 1)))
13722 (outline-next-heading))))
13724 (when include-specials
13725 (setq rtn (append org-special-properties rtn)))
13727 (when include-defaults
13728 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13729 (add-to-list 'rtn org-effort-property))
13731 (when include-columns
13732 (save-excursion
13733 (save-restriction
13734 (widen)
13735 (goto-char (point-min))
13736 (while (re-search-forward
13738 nil t)
13739 (setq cfmt (match-string 2) s 0)
13741 cfmt s)
13742 (setq s (match-end 0)
13743 p (match-string 1 cfmt))
13744 (unless (or (equal p "ITEM")
13745 (member p org-special-properties))
13746 (add-to-list 'rtn (match-string 1 cfmt))))))))
13748 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13750 (defun org-property-values (key)
13751 "Return a list of all values of property KEY."
13752 (save-excursion
13753 (save-restriction
13754 (widen)
13755 (goto-char (point-min))
13757 values)
13758 (while (re-search-forward re nil t)
13759 (add-to-list 'values (org-trim (match-string 1))))
13760 (delete "" values)))))
13762 (defun org-insert-property-drawer ()
13763 "Insert a property drawer into the current entry."
13764 (interactive)
13765 (org-back-to-heading t)
13766 (looking-at outline-regexp)
13767 (let ((indent (if org-adapt-indentation
13768 (- (match-end 0)(match-beginning 0))
13769 0))
13770 (beg (point))
13772 end hiddenp)
13773 (outline-next-heading)
13774 (setq end (point))
13775 (goto-char beg)
13776 (while (re-search-forward re end t))
13777 (setq hiddenp (org-invisible-p))
13778 (end-of-line 1)
13781 (if (member (match-string 1) '("CLOCK:" ":END:"))
13782 ;; just skip this line
13783 (beginning-of-line 2)
13784 ;; Drawer start, find the end
13786 (beginning-of-line 1)))
13787 (org-skip-over-state-notes)
13789 (if (eq (char-before) ?*) (forward-char 1))
13791 (beginning-of-line 0)
13792 (org-indent-to-column indent)
13793 (beginning-of-line 2)
13794 (org-indent-to-column indent)
13795 (beginning-of-line 0)
13796 (if hiddenp
13797 (save-excursion
13798 (org-back-to-heading t)
13799 (hide-entry))
13800 (org-flag-drawer t))))
13802 (defvar org-property-set-functions-alist nil
13803 "Property set function alist.
13804 Each entry should have the following format:
13806 (PROPERTY . READ-FUNCTION)
13808 The read function will be called with the same argument as
13809 `org-completing-read.")
13811 (defun org-set-property-function (property)
13812 "Get the function that should be used to set PROPERTY.
13813 This is computed according to `org-property-set-functions-alist'."
13814 (or (cdr (assoc property org-property-set-functions-alist))
13815 'org-completing-read))
13817 (defun org-read-property-value (property)
13818 "Read PROPERTY value from user."
13819 (let* ((completion-ignore-case t)
13820 (allowed (org-property-get-allowed-values nil property 'table))
13821 (cur (org-entry-get nil property))
13822 (prompt (concat property " value"
13824 (concat " [" cur "]") "") ": "))
13825 (set-function (org-set-property-function property))
13826 (val (if allowed
13827 (funcall set-function prompt allowed nil
13828 (not (get-text-property 0 'org-unrestricted
13829 (caar allowed))))
13830 (let (org-completion-use-ido org-completion-use-iswitchb)
13831 (funcall set-function prompt
13832 (mapcar 'list (org-property-values property))
13833 nil nil "" nil cur)))))
13834 (if (equal val "")
13835 cur
13836 val)))
13838 (defun org-read-property-name ()
13839 "Read a property name."
13840 (let* ((completion-ignore-case t)
13841 (keys (org-buffer-property-keys nil t t))
13842 (property (org-icompleting-read "Property: " (mapcar 'list keys))))
13843 (if (member property keys)
13844 property
13845 (or (cdr (assoc (downcase property)
13846 (mapcar (lambda (x) (cons (downcase x) x))
13847 keys)))
13848 property))))
13850 (defun org-set-property (property value)
13851 "In the current entry, set PROPERTY to VALUE.
13852 When called interactively, this will prompt for a property name, offering
13853 completion on existing and default properties. And then it will prompt
13854 for a value, offering completion either on allowed values (via an inherited
13855 xxx_ALL property) or on existing values in other instances of this property
13856 in the current file."
13857 (interactive (list nil nil))
13858 (let* ((property (or property (org-read-property-name)))
13859 (value (or value (org-read-property-value property))))
13860 (unless (equal (org-entry-get nil property) value)
13861 (org-entry-put nil property value))))
13863 (defun org-delete-property (property)
13864 "In the current entry, delete PROPERTY."
13865 (interactive
13866 (let* ((completion-ignore-case t)
13867 (prop (org-icompleting-read "Property: "
13868 (org-entry-properties nil 'standard))))
13869 (list prop)))
13870 (message "Property %s %s" property
13871 (if (org-entry-delete nil property)
13872 "deleted"
13873 "was not present in the entry")))
13875 (defun org-delete-property-globally (property)
13876 "Remove PROPERTY globally, from all entries."
13877 (interactive
13878 (let* ((completion-ignore-case t)
13879 (prop (org-icompleting-read
13880 "Globally remove property: "
13881 (mapcar 'list (org-buffer-property-keys)))))
13882 (list prop)))
13883 (save-excursion
13884 (save-restriction
13885 (widen)
13886 (goto-char (point-min))
13887 (let ((cnt 0))
13888 (while (re-search-forward
13890 nil t)
13891 (setq cnt (1+ cnt))
13892 (replace-match ""))
13895 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
13897 (defun org-compute-property-at-point ()
13898 "Compute the property at point.
13899 This looks for an enclosing column format, extracts the operator and
13900 then applies it to the property in the column format's scope."
13901 (interactive)
13902 (unless (org-at-property-p)
13903 (error "Not at a property"))
13904 (let ((prop (org-match-string-no-properties 2)))
13905 (org-columns-get-format-and-top-level)
13906 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
13907 (error "No operator defined for property %s" prop))
13908 (org-columns-compute prop)))
13910 (defvar org-property-allowed-value-functions nil
13911 "Hook for functions supplying allowed values for a specific property.
13912 The functions must take a single argument, the name of the property, and
13914 the values, this means that these values are intended as defaults for
13915 completion, but that other values should be allowed too.
13916 The functions must return nil if they are not responsible for this
13917 property.")
13919 (defun org-property-get-allowed-values (pom property &optional table)
13920 "Get allowed values for the property PROPERTY.
13921 When TABLE is non-nil, return an alist that can directly be used for
13922 completion."
13923 (let (vals)
13924 (cond
13925 ((equal property "TODO")
13926 (setq vals (org-with-point-at pom
13927 (append org-todo-keywords-1 '("")))))
13928 ((equal property "PRIORITY")
13929 (let ((n org-lowest-priority))
13930 (while (>= n org-highest-priority)
13931 (push (char-to-string n) vals)
13932 (setq n (1- n)))))
13933 ((member property org-special-properties))
13934 ((setq vals (run-hook-with-args-until-success
13935 'org-property-allowed-value-functions property)))
13936 (t
13937 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
13939 (setq vals (car (read-from-string (concat "(" vals ")"))))
13940 (setq vals (mapcar (lambda (x)
13941 (cond ((stringp x) x)
13942 ((numberp x) (number-to-string x))
13943 ((symbolp x) (symbol-name x))
13944 (t "???")))
13945 vals)))))
13946 (when (member ":ETC" vals)
13947 (setq vals (remove ":ETC" vals))
13948 (org-add-props (car vals) '(org-unrestricted t)))
13949 (if table (mapcar 'list vals) vals)))
13951 (defun org-property-previous-allowed-value (&optional previous)
13952 "Switch to the next allowed value for this property."
13953 (interactive)
13954 (org-property-next-allowed-value t))
13956 (defun org-property-next-allowed-value (&optional previous)
13957 "Switch to the next allowed value for this property."
13958 (interactive)
13959 (unless (org-at-property-p)
13960 (error "Not at a property"))
13961 (let* ((key (match-string 2))
13962 (value (match-string 3))
13963 (allowed (or (org-property-get-allowed-values (point) key)
13964 (and (member value '("[ ]" "[-]" "[X]"))
13965 '("[ ]" "[X]"))))
13966 nval)
13967 (unless allowed
13968 (error "Allowed values for this property have not been defined"))
13969 (if previous (setq allowed (reverse allowed)))
13970 (if (member value allowed)
13971 (setq nval (car (cdr (member value allowed)))))
13972 (setq nval (or nval (car allowed)))
13973 (if (equal nval value)
13974 (error "Only one allowed value for this property"))
13975 (org-at-property-p)
13976 (replace-match (concat " :" key ": " nval) t t)
13977 (org-indent-line-function)
13978 (beginning-of-line 1)
13980 (run-hook-with-args 'org-property-changed-functions key nval)))
13982 (defun org-find-olp (path &optional this-buffer)
13983 "Return a marker pointing to the entry at outline path OLP.
13984 If anything goes wrong, throw an error.
13985 You can wrap this call to catch the error like this:
13987 (condition-case msg
13988 (org-mobile-locate-entry (match-string 4))
13989 (error (nth 1 msg)))
13991 The return value will then be either a string with the error message,
13992 or a marker if everything is OK.
13994 If THIS-BUFFER is set, the outline path does not contain a file,
13995 only headings."
13996 (let* ((file (if this-buffer buffer-file-name (pop path)))
13997 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
13998 (level 1)
13999 (lmin 1)
14000 (lmax 1)
14001 limit re end found pos heading cnt)
14002 (unless buffer (error "File not found :%s" file))
14003 (with-current-buffer buffer
14004 (save-excursion
14005 (save-restriction
14006 (widen)
14007 (setq limit (point-max))
14008 (goto-char (point-min))
14009 (while (setq heading (pop path))
14010 (setq re (format org-complex-heading-regexp-format
14011 (regexp-quote heading)))
14012 (setq cnt 0 pos (point))
14013 (while (re-search-forward re end t)
14014 (setq level (- (match-end 1) (match-beginning 1)))
14015 (if (and (>= level lmin) (<= level lmax))
14016 (setq found (match-beginning 0) cnt (1+ cnt))))
14017 (when (= cnt 0) (error "Heading not found on level %d: %s"
14018 lmax heading))
14019 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14020 lmax heading))
14021 (goto-char found)
14022 (setq lmin (1+ level) lmax (+ lmin (if org-odd-levels-only 1 0)))
14023 (setq end (save-excursion (org-end-of-subtree t t))))
14024 (when (org-on-heading-p)
14025 (move-marker (make-marker) (point))))))))
14027 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14028 "Find node HEADING in BUFFER.
14029 Return a marker to the heading if it was found, or nil if not.
14030 If POS-ONLY is set, return just the position instead of a marker.
14032 The heading text must match exact, but it may have a TODO keyword,
14033 a priority cookie and tags in the standard locations."
14034 (with-current-buffer (or buffer (current-buffer))
14035 (save-excursion
14036 (save-restriction
14037 (widen)
14038 (goto-char (point-min))
14039 (let (case-fold-search)
14040 (if (re-search-forward
14041 (format org-complex-heading-regexp-format
14042 (regexp-quote heading)) nil t)
14043 (if pos-only
14044 (match-beginning 0)
14045 (move-marker (make-marker) (match-beginning 0)))))))))
14047 (defun org-find-exact-heading-in-directory (heading &optional dir)
14048 "Find Org node headline HEADING in all .org files in directory DIR.
14049 When the target headline is found, return a marker to this location."
14050 (let ((files (directory-files (or dir default-directory)
14052 file visiting m buffer)
14053 (catch 'found
14054 (while (setq file (pop files))
14055 (message "trying %s" file)
14056 (setq visiting (org-find-base-buffer-visiting file))
14057 (setq buffer (or visiting (find-file-noselect file)))
14058 (setq m (org-find-exact-headline-in-buffer
14059 heading buffer))
14060 (when (and (not m) (not visiting)) (kill-buffer buffer))
14061 (and m (throw 'found m))))))
14063 (defun org-find-entry-with-id (ident)
14064 "Locate the entry that contains the ID property with exact value IDENT.
14065 IDENT can be a string, a symbol or a number, this function will search for
14066 the string representation of it.
14067 Return the position where this entry starts, or nil if there is no such entry."
14068 (interactive "sID: ")
14069 (let ((id (cond
14070 ((stringp ident) ident)
14071 ((symbol-name ident) (symbol-name ident))
14072 ((numberp ident) (number-to-string ident))
14073 (t (error "IDENT %s must be a string, symbol or number" ident))))
14074 (case-fold-search nil))
14075 (save-excursion
14076 (save-restriction
14077 (widen)
14078 (goto-char (point-min))
14079 (when (re-search-forward
14081 nil t)
14082 (org-back-to-heading t)
14083 (point))))))
14085 ;;;; Timestamps
14087 (defvar org-last-changed-timestamp nil)
14088 (defvar org-last-inserted-timestamp nil
14089 "The last time stamp inserted with `org-insert-time-stamp'.")
14090 (defvar org-time-was-given) ; dynamically scoped parameter
14091 (defvar org-end-time-was-given) ; dynamically scoped parameter
14092 (defvar org-ts-what) ; dynamically scoped parameter
14094 (defun org-time-stamp (arg &optional inactive)
14095 "Prompt for a date/time and insert a time stamp.
14096 If the user specifies a time like HH:MM, or if this command is called
14097 with a prefix argument, the time stamp will contain date and time.
14098 Otherwise, only the date will be included. All parts of a date not
14099 specified by the user will be filled in from the current date/time.
14100 So if you press just return without typing anything, the time stamp
14101 will represent the current date/time. If there is already a timestamp
14102 at the cursor, it will be modified."
14103 (interactive "P")
14104 (let* ((ts nil)
14105 (default-time
14106 ;; Default time is either today, or, when entering a range,
14107 ;; the range start.
14108 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14109 (save-excursion
14110 (re-search-backward
14112 (- (point) 20) t)))
14113 (apply 'encode-time (org-parse-time-string (match-string 1)))
14114 (current-time)))
14115 (default-input (and ts (org-get-compact-tod ts)))
14116 org-time-was-given org-end-time-was-given time)
14117 (cond
14118 ((and (org-at-timestamp-p t)
14119 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14120 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14121 (insert "--")
14122 (setq time (let ((this-command this-command))
14123 (org-read-date arg 'totime nil nil
14124 default-time default-input)))
14125 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14126 ((org-at-timestamp-p t)
14127 (setq time (let ((this-command this-command))
14128 (org-read-date arg 'totime nil nil default-time default-input)))
14129 (when (org-at-timestamp-p t) ; just to get the match data
14130 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14131 (replace-match "")
14132 (setq org-last-changed-timestamp
14133 (org-insert-time-stamp
14134 time (or org-time-was-given arg)
14135 inactive nil nil (list org-end-time-was-given))))
14136 (message "Timestamp updated"))
14137 (t
14138 (setq time (let ((this-command this-command))
14139 (org-read-date arg 'totime nil nil default-time default-input)))
14140 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14141 nil nil (list org-end-time-was-given))))))
14143 ;; FIXME: can we use this for something else, like computing time differences?
14144 (defun org-get-compact-tod (s)
14145 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14146 (let* ((t1 (match-string 1 s))
14147 (h1 (string-to-number (match-string 2 s)))
14148 (m1 (string-to-number (match-string 3 s)))
14149 (t2 (and (match-end 4) (match-string 5 s)))
14150 (h2 (and t2 (string-to-number (match-string 6 s))))
14151 (m2 (and t2 (string-to-number (match-string 7 s))))
14152 dh dm)
14153 (if (not t2)
14154 t1
14155 (setq dh (- h2 h1) dm (- m2 m1))
14156 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14157 (concat t1 "+" (number-to-string dh)
14158 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14160 (defun org-time-stamp-inactive (&optional arg)
14161 "Insert an inactive time stamp.
14162 An inactive time stamp is enclosed in square brackets instead of angle
14163 brackets. It is inactive in the sense that it does not trigger agenda entries,
14164 does not link to the calendar and cannot be changed with the S-cursor keys.
14165 So these are more for recording a certain time/date."
14166 (interactive "P")
14167 (org-time-stamp arg 'inactive))
14169 (defvar org-date-ovl (make-overlay 1 1))
14170 (overlay-put org-date-ovl 'face 'org-warning)
14171 (org-detach-overlay org-date-ovl)
14173 (defvar org-ans1) ; dynamically scoped parameter
14174 (defvar org-ans2) ; dynamically scoped parameter
14176 (defvar org-plain-time-of-day-regexp) ; defined below
14178 (defvar org-overriding-default-time nil) ; dynamically scoped
14179 (defvar org-read-date-overlay nil)
14180 (defvar org-dcst nil) ; dynamically scoped
14181 (defvar org-read-date-history nil)
14182 (defvar org-read-date-final-answer nil)
14184 (defun org-read-date (&optional with-time to-time from-string prompt
14185 default-time default-input)
14186 "Read a date, possibly a time, and make things smooth for the user.
14187 The prompt will suggest to enter an ISO date, but you can also enter anything
14188 which will at least partially be understood by `parse-time-string'.
14189 Unrecognized parts of the date will default to the current day, month, year,
14190 hour and minute. If this command is called to replace a timestamp at point,
14191 of to enter the second timestamp of a range, the default time is taken
14192 from the existing stamp. Furthermore, the command prefers the future,
14193 so if you are giving a date where the year is not given, and the day-month
14194 combination is already past in the current year, it will assume you
14195 mean next year. For details, see the manual. A few examples:
14197 3-2-5 --> 2003-02-05
14198 feb 15 --> currentyear-02-15
14199 2/15 --> currentyear-02-15
14200 sep 12 9 --> 2009-09-12
14201 12:45 --> today 12:45
14202 22 sept 0:34 --> currentyear-09-22 0:34
14203 12 --> currentyear-currentmonth-12
14204 Fri --> nearest Friday (today or later)
14205 etc.
14207 Furthermore you can specify a relative date by giving, as the *first* thing
14208 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14209 change in days weeks, months, years.
14210 With a single plus or minus, the date is relative to today. With a double
14211 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14212 +4d --> four days from today
14213 +4 --> same as above
14214 +2w --> two weeks from today
14215 ++5 --> five days from default date
14217 The function understands only English month and weekday abbreviations,
14218 but this can be configured with the variables `parse-time-months' and
14219 `parse-time-weekdays'.
14221 While prompting, a calendar is popped up - you can also select the
14222 date with the mouse (button 1). The calendar shows a period of three
14223 months. To scroll it to other months, use the keys `>' and `<'.
14224 If you don't like the calendar, turn it off with
14225 \(setq org-read-date-popup-calendar nil)
14227 With optional argument TO-TIME, the date will immediately be converted
14228 to an internal time.
14229 With an optional argument WITH-TIME, the prompt will suggest to also
14230 insert a time. Note that when WITH-TIME is not set, you can still
14231 enter a time, and this function will inform the calling routine about
14232 this change. The calling routine may then choose to change the format
14233 used to insert the time stamp into the buffer to include the time.
14234 With optional argument FROM-STRING, read from this string instead from
14235 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14236 the time/date that is used for everything that is not specified by the
14237 user."
14238 (require 'parse-time)
14239 (let* ((org-time-stamp-rounding-minutes
14240 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14241 (org-dcst org-display-custom-times)
14242 (ct (org-current-time))
14243 (def (or org-overriding-default-time default-time ct))
14244 (defdecode (decode-time def))
14245 (dummy (progn
14246 (when (< (nth 2 defdecode) org-extend-today-until)
14247 (setcar (nthcdr 2 defdecode) -1)
14248 (setcar (nthcdr 1 defdecode) 59)
14249 (setq def (apply 'encode-time defdecode)
14250 defdecode (decode-time def)))))
14251 (calendar-frame-setup nil)
14252 (calendar-setup nil)
14253 (calendar-move-hook nil)
14254 (calendar-view-diary-initially-flag nil)
14255 (calendar-view-holidays-initially-flag nil)
14256 (timestr (format-time-string
14257 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14258 (prompt (concat (if prompt (concat prompt " ") "")
14259 (format "Date+time [%s]: " timestr)))
14260 ans (org-ans0 "") org-ans1 org-ans2 final)
14262 (cond
14263 (from-string (setq ans from-string))
14264 (org-read-date-popup-calendar
14265 (save-excursion
14266 (save-window-excursion
14267 (calendar)
14268 (calendar-forward-day (- (time-to-days def)
14269 (calendar-absolute-from-gregorian
14270 (calendar-current-date))))
14271 (org-eval-in-calendar nil t)
14272 (let* ((old-map (current-local-map))
14273 (map (copy-keymap calendar-mode-map))
14274 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14275 (org-defkey map (kbd "RET") 'org-calendar-select)
14276 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14277 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14278 (org-defkey minibuffer-local-map [(meta shift left)]
14279 (lambda () (interactive)
14280 (org-eval-in-calendar '(calendar-backward-month 1))))
14281 (org-defkey minibuffer-local-map [(meta shift right)]
14282 (lambda () (interactive)
14283 (org-eval-in-calendar '(calendar-forward-month 1))))
14284 (org-defkey minibuffer-local-map [(meta shift up)]
14285 (lambda () (interactive)
14286 (org-eval-in-calendar '(calendar-backward-year 1))))
14287 (org-defkey minibuffer-local-map [(meta shift down)]
14288 (lambda () (interactive)
14289 (org-eval-in-calendar '(calendar-forward-year 1))))
14290 (org-defkey minibuffer-local-map [?\e (shift left)]
14291 (lambda () (interactive)
14292 (org-eval-in-calendar '(calendar-backward-month 1))))
14293 (org-defkey minibuffer-local-map [?\e (shift right)]
14294 (lambda () (interactive)
14295 (org-eval-in-calendar '(calendar-forward-month 1))))
14296 (org-defkey minibuffer-local-map [?\e (shift up)]
14297 (lambda () (interactive)
14298 (org-eval-in-calendar '(calendar-backward-year 1))))
14299 (org-defkey minibuffer-local-map [?\e (shift down)]
14300 (lambda () (interactive)
14301 (org-eval-in-calendar '(calendar-forward-year 1))))
14302 (org-defkey minibuffer-local-map [(shift up)]
14303 (lambda () (interactive)
14304 (org-eval-in-calendar '(calendar-backward-week 1))))
14305 (org-defkey minibuffer-local-map [(shift down)]
14306 (lambda () (interactive)
14307 (org-eval-in-calendar '(calendar-forward-week 1))))
14308 (org-defkey minibuffer-local-map [(shift left)]
14309 (lambda () (interactive)
14310 (org-eval-in-calendar '(calendar-backward-day 1))))
14311 (org-defkey minibuffer-local-map [(shift right)]
14312 (lambda () (interactive)
14313 (org-eval-in-calendar '(calendar-forward-day 1))))
14314 (org-defkey minibuffer-local-map ">"
14315 (lambda () (interactive)
14316 (org-eval-in-calendar '(scroll-calendar-left 1))))
14317 (org-defkey minibuffer-local-map "<"
14318 (lambda () (interactive)
14319 (org-eval-in-calendar '(scroll-calendar-right 1))))
14320 (org-defkey minibuffer-local-map "\C-v"
14321 (lambda () (interactive)
14322 (org-eval-in-calendar
14323 '(calendar-scroll-left-three-months 1))))
14324 (org-defkey minibuffer-local-map "\M-v"
14325 (lambda () (interactive)
14326 (org-eval-in-calendar
14327 '(calendar-scroll-right-three-months 1))))
14328 (run-hooks 'org-read-date-minibuffer-setup-hook)
14329 (unwind-protect
14330 (progn
14331 (use-local-map map)
14332 (add-hook 'post-command-hook 'org-read-date-display)
14333 (setq org-ans0 (read-string prompt default-input
14334 'org-read-date-history nil))
14335 ;; org-ans0: from prompt
14336 ;; org-ans1: from mouse click
14337 ;; org-ans2: from calendar motion
14338 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14339 (remove-hook 'post-command-hook 'org-read-date-display)
14340 (use-local-map old-map)
14341 (when org-read-date-overlay
14342 (delete-overlay org-read-date-overlay)
14343 (setq org-read-date-overlay nil)))))))
14345 (t ; Naked prompt only
14346 (unwind-protect
14347 (setq ans (read-string prompt default-input
14348 'org-read-date-history timestr))
14349 (when org-read-date-overlay
14350 (delete-overlay org-read-date-overlay)
14351 (setq org-read-date-overlay nil)))))
14353 (setq final (org-read-date-analyze ans def defdecode))
14355 ;; One round trip to get rid of 34th of August and stuff like that....
14356 (setq final (decode-time (apply 'encode-time final)))
14358 (setq org-read-date-final-answer ans)
14360 (if to-time
14361 (apply 'encode-time final)
14362 (if (and (boundp 'org-time-was-given) org-time-was-given)
14363 (format "%04d-%02d-%02d %02d:%02d"
14364 (nth 5 final) (nth 4 final) (nth 3 final)
14365 (nth 2 final) (nth 1 final))
14366 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14368 (defvar def)
14369 (defvar defdecode)
14370 (defvar with-time)
14371 (defvar org-read-date-analyze-futurep nil)
14372 (defun org-read-date-display ()
14373 "Display the current date prompt interpretation in the minibuffer."
14374 (when org-read-date-display-live
14375 (when org-read-date-overlay
14376 (delete-overlay org-read-date-overlay))
14377 (let ((p (point)))
14378 (end-of-line 1)
14379 (while (not (equal (buffer-substring
14380 (max (point-min) (- (point) 4)) (point))
14381 " "))
14382 (insert " "))
14383 (goto-char p))
14384 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14385 " " (or org-ans1 org-ans2)))
14386 (org-end-time-was-given nil)
14387 (f (org-read-date-analyze ans def defdecode))
14388 (fmts (if org-dcst
14389 org-time-stamp-custom-formats
14390 org-time-stamp-formats))
14391 (fmt (if (or with-time
14392 (and (boundp 'org-time-was-given) org-time-was-given))
14393 (cdr fmts)
14394 (car fmts)))
14395 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14396 (when (and org-end-time-was-given
14397 (string-match org-plain-time-of-day-regexp txt))
14398 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14399 org-end-time-was-given
14400 (substring txt (match-end 0)))))
14401 (when org-read-date-analyze-futurep
14402 (setq txt (concat txt " (=>F)")))
14403 (setq org-read-date-overlay
14404 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14405 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14407 (defun org-read-date-analyze (ans def defdecode)
14408 "Analyze the combined answer of the date prompt."
14409 ;; FIXME: cleanup and comment
14410 (let ((nowdecode (decode-time (current-time)))
14411 delta deltan deltaw deltadef year month day
14412 hour minute second wday pm h2 m2 tl wday1
14413 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14414 (setq org-read-date-analyze-futurep nil)
14416 (setq ans "+0"))
14418 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14419 (setq ans (replace-match "" t t ans)
14420 deltan (car delta)
14421 deltaw (nth 1 delta)
14422 deltadef (nth 2 delta)))
14424 ;; Check if there is an iso week date in there
14425 ;; If yes, store the info and postpone interpreting it until the rest
14426 ;; of the parsing is done
14427 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14428 (setq iso-year (if (match-end 1)
14429 (org-small-year-to-year
14430 (string-to-number (match-string 1 ans))))
14431 iso-weekday (if (match-end 3)
14432 (string-to-number (match-string 3 ans)))
14433 iso-week (string-to-number (match-string 2 ans)))
14434 (setq ans (replace-match "" t t ans)))
14436 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14437 (when (string-match
14439 (setq year (if (match-end 2)
14440 (string-to-number (match-string 2 ans))
14441 (progn (setq kill-year t)
14442 (string-to-number (format-time-string "%Y"))))
14443 month (string-to-number (match-string 3 ans))
14444 day (string-to-number (match-string 4 ans)))
14445 (if (< year 100) (setq year (+ 2000 year)))
14447 t nil ans)))
14448 ;; Help matching american dates, like 5/30 or 5/30/7
14449 (when (string-match
14450 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14451 (setq year (if (match-end 4)
14452 (string-to-number (match-string 4 ans))
14453 (progn (setq kill-year t)
14454 (string-to-number (format-time-string "%Y"))))
14455 month (string-to-number (match-string 1 ans))
14456 day (string-to-number (match-string 2 ans)))
14457 (if (< year 100) (setq year (+ 2000 year)))
14459 t nil ans)))
14460 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14461 ;; If there is a time with am/pm, and *no* time without it, we convert
14462 ;; so that matching will be successful.
14463 (loop for i from 1 to 2 do ; twice, for end time as well
14466 (setq hour (string-to-number (match-string 1 ans))
14467 minute (if (match-end 3)
14468 (string-to-number (match-string 3 ans))
14469 0)
14470 pm (equal ?p
14471 (string-to-char (downcase (match-string 4 ans)))))
14472 (if (and (= hour 12) (not pm))
14473 (setq hour 0)
14474 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14475 (setq ans (replace-match (format "%02d:%02d" hour minute)
14476 t t ans))))
14478 ;; Check if a time range is given as a duration
14479 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14480 (setq hour (string-to-number (match-string 1 ans))
14481 h2 (+ hour (string-to-number (match-string 3 ans)))
14482 minute (string-to-number (match-string 2 ans))
14483 m2 (+ minute (if (match-end 5) (string-to-number
14484 (match-string 5 ans))0)))
14485 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14486 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14487 t t ans)))
14489 ;; Check if there is a time range
14490 (when (boundp 'org-end-time-was-given)
14491 (setq org-time-was-given nil)
14492 (when (and (string-match org-plain-time-of-day-regexp ans)
14493 (match-end 8))
14494 (setq org-end-time-was-given (match-string 8 ans))
14495 (setq ans (concat (substring ans 0 (match-beginning 7))
14496 (substring ans (match-end 7))))))
14498 (setq tl (parse-time-string ans)
14499 day (or (nth 3 tl) (nth 3 defdecode))
14500 month (or (nth 4 tl)
14501 (if (and org-read-date-prefer-future
14502 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14503 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14504 (nth 4 defdecode)))
14505 year (or (and (not kill-year) (nth 5 tl))
14506 (if (and org-read-date-prefer-future
14507 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14508 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14509 (nth 5 defdecode)))
14510 hour (or (nth 2 tl) (nth 2 defdecode))
14511 minute (or (nth 1 tl) (nth 1 defdecode))
14512 second (or (nth 0 tl) 0)
14513 wday (nth 6 tl))
14515 (when (and (eq org-read-date-prefer-future 'time)
14516 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14517 (equal day (nth 3 nowdecode))
14518 (equal month (nth 4 nowdecode))
14519 (equal year (nth 5 nowdecode))
14520 (nth 2 tl)
14521 (or (< (nth 2 tl) (nth 2 nowdecode))
14522 (and (= (nth 2 tl) (nth 2 nowdecode))
14523 (nth 1 tl)
14524 (< (nth 1 tl) (nth 1 nowdecode)))))
14525 (setq day (1+ day)
14526 futurep t))
14528 ;; Special date definitions below
14529 (cond
14530 (iso-week
14531 ;; There was an iso week
14532 (require 'cal-iso)
14533 (setq futurep nil)
14534 (setq year (or iso-year year)
14535 day (or iso-weekday wday 1)
14536 wday nil ; to make sure that the trigger below does not match
14537 iso-date (calendar-gregorian-from-absolute
14538 (calendar-absolute-from-iso
14539 (list iso-week day year))))
14540 ; FIXME: Should we also push ISO weeks into the future?
14541 ; (when (and org-read-date-prefer-future
14542 ; (not iso-year)
14543 ; (< (calendar-absolute-from-gregorian iso-date)
14544 ; (time-to-days (current-time))))
14545 ; (setq year (1+ year)
14546 ; iso-date (calendar-gregorian-from-absolute
14547 ; (calendar-absolute-from-iso
14548 ; (list iso-week day year)))))
14549 (setq month (car iso-date)
14550 year (nth 2 iso-date)
14551 day (nth 1 iso-date)))
14552 (deltan
14553 (setq futurep nil)
14554 (unless deltadef
14555 (let ((now (decode-time (current-time))))
14556 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14557 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14558 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14559 ((equal deltaw "m") (setq month (+ month deltan)))
14560 ((equal deltaw "y") (setq year (+ year deltan)))))
14561 ((and wday (not (nth 3 tl)))
14562 (setq futurep nil)
14563 ;; Weekday was given, but no day, so pick that day in the week
14564 ;; on or after the derived date.
14565 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14566 (unless (equal wday wday1)
14567 (setq day (+ day (% (- wday wday1 -7) 7))))))
14568 (if (and (boundp 'org-time-was-given)
14569 (nth 2 tl))
14570 (setq org-time-was-given t))
14571 (if (< year 100) (setq year (+ 2000 year)))
14572 (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
14573 (setq org-read-date-analyze-futurep futurep)
14574 (list second minute hour day month year)))
14576 (defvar parse-time-weekdays)
14578 (defun org-read-date-get-relative (s today default)
14579 "Check string S for special relative date string.
14580 TODAY and DEFAULT are internal times, for today and for a default.
14581 Return shift list (N what def-flag)
14583 N is the number of WHATs to shift.
14584 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14585 the DEFAULT date rather than TODAY."
14586 (when (and
14587 (string-match
14588 (concat
14593 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14594 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14595 (string-to-char (substring (match-string 1 s) -1))
14596 ?+))
14597 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14598 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14599 (what (if (match-end 3) (match-string 3 s) "d"))
14600 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14601 (date (if rel default today))
14602 (wday (nth 6 (decode-time date)))
14603 delta)
14604 (if wday1
14605 (progn
14606 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14607 (if (= dir ?-) (setq delta (- delta 7)))
14608 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14609 (list delta "d" rel))
14610 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14612 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14613 "Turn a user-specified date into the internal representation.
14614 The internal representation needed by the calendar is (month day year).
14615 This is a wrapper to handle the brain-dead convention in calendar that
14616 user function argument order change dependent on argument order."
14617 (if (boundp 'calendar-date-style)
14618 (cond
14619 ((eq calendar-date-style 'american)
14620 (list arg1 arg2 arg3))
14621 ((eq calendar-date-style 'european)
14622 (list arg2 arg1 arg3))
14623 ((eq calendar-date-style 'iso)
14624 (list arg2 arg3 arg1)))
14625 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
14626 (if (org-bound-and-true-p european-calendar-style)
14627 (list arg2 arg1 arg3)
14628 (list arg1 arg2 arg3)))))
14630 (defun org-eval-in-calendar (form &optional keepdate)
14631 "Eval FORM in the calendar window and return to current window.
14632 Also, store the cursor date in variable org-ans2."
14633 (let ((sf (selected-frame))
14634 (sw (selected-window)))
14635 (select-window (get-buffer-window "*Calendar*" t))
14636 (eval form)
14637 (when (and (not keepdate) (calendar-cursor-to-date))
14638 (let* ((date (calendar-cursor-to-date))
14639 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14640 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
14641 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
14642 (select-window sw)
14643 (org-select-frame-set-input-focus sf)))
14645 (defun org-calendar-select ()
14646 "Return to `org-read-date' with the date currently selected.
14647 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14648 (interactive)
14649 (when (calendar-cursor-to-date)
14650 (let* ((date (calendar-cursor-to-date))
14651 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14652 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14653 (if (active-minibuffer-window) (exit-minibuffer))))
14655 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
14656 "Insert a date stamp for the date given by the internal TIME.
14657 WITH-HM means use the stamp format that includes the time of the day.
14658 INACTIVE means use square brackets instead of angular ones, so that the
14659 stamp will not contribute to the agenda.
14660 PRE and POST are optional strings to be inserted before and after the
14661 stamp.
14662 The command returns the inserted time stamp."
14663 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
14664 stamp)
14665 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
14666 (insert-before-markers (or pre ""))
14667 (when (listp extra)
14668 (setq extra (car extra))
14669 (if (and (stringp extra)
14671 (setq extra (format "-%02d:%02d"
14672 (string-to-number (match-string 1 extra))
14673 (string-to-number (match-string 2 extra))))
14674 (setq extra nil)))
14675 (when extra
14676 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
14677 (insert-before-markers (setq stamp (format-time-string fmt time)))
14678 (insert-before-markers (or post ""))
14679 (setq org-last-inserted-timestamp stamp)))
14681 (defun org-toggle-time-stamp-overlays ()
14682 "Toggle the use of custom time stamp formats."
14683 (interactive)
14684 (setq org-display-custom-times (not org-display-custom-times))
14685 (unless org-display-custom-times
14686 (let ((p (point-min)) (bmp (buffer-modified-p)))
14687 (while (setq p (next-single-property-change p 'display))
14688 (if (and (get-text-property p 'display)
14689 (eq (get-text-property p 'face) 'org-date))
14690 (remove-text-properties
14691 p (setq p (next-single-property-change p 'display))
14692 '(display t))))
14693 (set-buffer-modified-p bmp)))
14694 (if (featurep 'xemacs)
14695 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
14696 (org-restart-font-lock)
14697 (setq org-table-may-need-update t)
14698 (if org-display-custom-times
14699 (message "Time stamps are overlayed with custom format")
14700 (message "Time stamp overlays removed")))
14702 (defun org-display-custom-time (beg end)
14703 "Overlay modified time stamp format over timestamp between BEG and END."
14704 (let* ((ts (buffer-substring beg end))
14705 t1 w1 with-hm tf time str w2 (off 0))
14706 (save-match-data
14707 (setq t1 (org-parse-time-string ts t))
14708 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
14709 (setq off (- (match-end 0) (match-beginning 0)))))
14710 (setq end (- end off))
14711 (setq w1 (- end beg)
14712 with-hm (and (nth 1 t1) (nth 2 t1))
14713 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
14714 time (org-fix-decoded-time t1)
14715 str (org-add-props
14716 (format-time-string
14717 (substring tf 1 -1) (apply 'encode-time time))
14718 nil 'mouse-face 'highlight)
14719 w2 (length str))
14720 (if (not (= w2 w1))
14721 (add-text-properties (1+ beg) (+ 2 beg)
14722 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
14723 (if (featurep 'xemacs)
14724 (progn
14725 (put-text-property beg end 'invisible t)
14726 (put-text-property beg end 'end-glyph (make-glyph str)))
14727 (put-text-property beg end 'display str))))
14729 (defun org-translate-time (string)
14730 "Translate all timestamps in STRING to custom format.
14731 But do this only if the variable `org-display-custom-times' is set."
14732 (when org-display-custom-times
14733 (save-match-data
14734 (let* ((start 0)
14735 (re org-ts-regexp-both)
14736 t1 with-hm inactive tf time str beg end)
14737 (while (setq start (string-match re string start))
14738 (setq beg (match-beginning 0)
14739 end (match-end 0)
14740 t1 (save-match-data
14741 (org-parse-time-string (substring string beg end) t))
14742 with-hm (and (nth 1 t1) (nth 2 t1))
14743 inactive (equal (substring string beg (1+ beg)) "[")
14744 tf (funcall (if with-hm 'cdr 'car)
14745 org-time-stamp-custom-formats)
14746 time (org-fix-decoded-time t1)
14747 str (format-time-string
14748 (concat
14749 (if inactive "[" "<") (substring tf 1 -1)
14750 (if inactive "]" ">"))
14751 (apply 'encode-time time))
14752 string (replace-match str t t string)
14753 start (+ start (length str)))))))
14754 string)
14756 (defun org-fix-decoded-time (time)
14757 "Set 0 instead of nil for the first 6 elements of time.
14758 Don't touch the rest."
14759 (let ((n 0))
14760 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
14762 (defun org-days-to-time (timestamp-string)
14763 "Difference between TIMESTAMP-STRING and now in days."
14764 (- (time-to-days (org-time-string-to-time timestamp-string))
14765 (time-to-days (current-time))))
14767 (defun org-deadline-close (timestamp-string &optional ndays)
14768 "Is the time in TIMESTAMP-STRING close to the current date?"
14769 (setq ndays (or ndays (org-get-wdays timestamp-string)))
14770 (and (< (org-days-to-time timestamp-string) ndays)
14771 (not (org-entry-is-done-p))))
14773 (defun org-get-wdays (ts)
14774 "Get the deadline lead time appropriate for timestring TS."
14775 (cond
14776 ((<= org-deadline-warning-days 0)
14777 ;; 0 or negative, enforce this value no matter what
14778 (- org-deadline-warning-days))
14780 ;; lead time is specified.
14781 (floor (* (string-to-number (match-string 1 ts))
14782 (cdr (assoc (match-string 2 ts)
14783 '(("d" . 1) ("w" . 7)
14784 ("m" . 30.4) ("y" . 365.25)))))))
14785 ;; go for the default.
14786 (t org-deadline-warning-days)))
14788 (defun org-calendar-select-mouse (ev)
14789 "Return to `org-read-date' with the date currently selected.
14790 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14791 (interactive "e")
14792 (mouse-set-point ev)
14793 (when (calendar-cursor-to-date)
14794 (let* ((date (calendar-cursor-to-date))
14795 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14796 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14797 (if (active-minibuffer-window) (exit-minibuffer))))
14799 (defun org-check-deadlines (ndays)
14800 "Check if there are any deadlines due or past due.
14801 A deadline is considered due if it happens within `org-deadline-warning-days'
14802 days from today's date. If the deadline appears in an entry marked DONE,
14803 it is not shown. The prefix arg NDAYS can be used to test that many
14805 (interactive "P")
14806 (let* ((org-warn-days
14807 (cond
14808 ((equal ndays '(4)) 100000)
14809 (ndays (prefix-numeric-value ndays))
14810 (t (abs org-deadline-warning-days))))
14811 (case-fold-search nil)
14813 (callback
14814 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
14816 (message "%d deadlines past-due or due within %d days"
14817 (org-occur regexp nil callback)
14818 org-warn-days)))
14820 (defun org-check-before-date (date)
14821 "Check if there are deadlines or scheduled entries before DATE."
14822 (interactive (list (org-read-date)))
14823 (let ((case-fold-search nil)
14827 (callback
14828 (lambda () (time-less-p
14829 (org-time-string-to-time (match-string 2))
14830 (org-time-string-to-time date)))))
14831 (message "%d entries before %s"
14832 (org-occur regexp nil callback) date)))
14834 (defun org-check-after-date (date)
14835 "Check if there are deadlines or scheduled entries after DATE."
14836 (interactive (list (org-read-date)))
14837 (let ((case-fold-search nil)
14841 (callback
14842 (lambda () (not
14843 (time-less-p
14844 (org-time-string-to-time (match-string 2))
14845 (org-time-string-to-time date))))))
14846 (message "%d entries after %s"
14847 (org-occur regexp nil callback) date)))
14849 (defun org-evaluate-time-range (&optional to-buffer)
14850 "Evaluate a time range by computing the difference between start and end.
14851 Normally the result is just printed in the echo area, but with prefix arg
14852 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
14853 If the time range is actually in a table, the result is inserted into the
14854 next column.
14855 For time difference computation, a year is assumed to be exactly 365
14856 days in order to avoid rounding problems."
14857 (interactive "P")
14858 (or
14859 (org-clock-update-time-maybe)
14860 (save-excursion
14861 (unless (org-at-date-range-p t)
14862 (goto-char (point-at-bol))
14863 (re-search-forward org-tr-regexp-both (point-at-eol) t))
14864 (if (not (org-at-date-range-p t))
14865 (error "Not at a time-stamp range, and none found in current line")))
14866 (let* ((ts1 (match-string 1))
14867 (ts2 (match-string 2))
14868 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
14869 (match-end (match-end 0))
14870 (time1 (org-time-string-to-time ts1))
14871 (time2 (org-time-string-to-time ts2))
14872 (t1 (org-float-time time1))
14873 (t2 (org-float-time time2))
14874 (diff (abs (- t2 t1)))
14875 (negative (< (- t2 t1) 0))
14876 ;; (ys (floor (* 365 24 60 60)))
14877 (ds (* 24 60 60))
14878 (hs (* 60 60))
14879 (fy "%dy %dd %02d:%02d")
14880 (fy1 "%dy %dd")
14881 (fd "%dd %02d:%02d")
14882 (fd1 "%dd")
14883 (fh "%02d:%02d")
14884 y d h m align)
14885 (if havetime
14886 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14887 y 0
14888 d (floor (/ diff ds)) diff (mod diff ds)
14889 h (floor (/ diff hs)) diff (mod diff hs)
14890 m (floor (/ diff 60)))
14891 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14892 y 0
14893 d (floor (+ (/ diff ds) 0.5))
14894 h 0 m 0))
14895 (if (not to-buffer)
14896 (message "%s" (org-make-tdiff-string y d h m))
14897 (if (org-at-table-p)
14898 (progn
14899 (goto-char match-end)
14900 (setq align t)
14901 (and (looking-at " *|") (goto-char (match-end 0))))
14902 (goto-char match-end))
14903 (if (looking-at
14905 (replace-match ""))
14906 (if negative (insert " -"))
14907 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
14908 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
14909 (insert " " (format fh h m))))
14910 (if align (org-table-align))
14911 (message "Time difference inserted")))))
14913 (defun org-make-tdiff-string (y d h m)
14914 (let ((fmt "")
14915 (l nil))
14916 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
14917 l (push y l)))
14918 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
14919 l (push d l)))
14920 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
14921 l (push h l)))
14922 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
14923 l (push m l)))
14924 (apply 'format fmt (nreverse l))))
14926 (defun org-time-string-to-time (s)
14927 (apply 'encode-time (org-parse-time-string s)))
14928 (defun org-time-string-to-seconds (s)
14929 (org-float-time (org-time-string-to-time s)))
14931 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
14932 "Convert a time stamp to an absolute day number.
14933 If there is a specifier for a cyclic time stamp, get the closest date to
14934 DAYNR.
14935 PREFER and SHOW-ALL are passed through to `org-closest-date'.
14936 the variable date is bound by the calendar when this is called."
14937 (cond
14939 (if (org-diary-sexp-entry (match-string 1 s) "" date)
14940 daynr
14941 (+ daynr 1000)))
14943 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
14944 (time-to-days (current-time))) (match-string 0 s)
14945 prefer show-all))
14946 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
14948 (defun org-days-to-iso-week (days)
14949 "Return the iso week number."
14950 (require 'cal-iso)
14951 (car (calendar-iso-from-absolute days)))
14953 (defun org-small-year-to-year (year)
14954 "Convert 2-digit years into 4-digit years.
14955 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
14956 The year 2000 cannot be abbreviated. Any year larger than 99
14957 is returned unchanged."
14958 (if (< year 38)
14959 (setq year (+ 2000 year))
14960 (if (< year 100)
14961 (setq year (+ 1900 year))))
14962 year)
14964 (defun org-time-from-absolute (d)
14965 "Return the time corresponding to date D.
14966 D may be an absolute day number, or a calendar-type list (month day year)."
14967 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
14968 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
14970 (defun org-calendar-holiday ()
14971 "List of holidays, for Diary display in Org-mode."
14972 (require 'holidays)
14973 (let ((hl (funcall
14974 (if (fboundp 'calendar-check-holidays)
14975 'calendar-check-holidays 'check-calendar-holidays) date)))
14976 (if hl (mapconcat 'identity hl "; "))))
14978 (defun org-diary-sexp-entry (sexp entry date)
14979 "Process a SEXP diary ENTRY for DATE."
14980 (require 'diary-lib)
14981 (let ((result (if calendar-debug-sexp
14982 (let ((stack-trace-on-error t))
14983 (eval (car (read-from-string sexp))))
14984 (condition-case nil
14985 (eval (car (read-from-string sexp)))
14986 (error
14987 (beep)
14988 (message "Bad sexp at line %d in %s: %s"
14989 (org-current-line)
14990 (buffer-file-name) sexp)
14991 (sleep-for 2))))))
14992 (cond ((stringp result) (split-string result "; "))
14993 ((and (consp result)
14994 (not (consp (cdr result)))
14995 (stringp (cdr result))) (cdr result))
14996 ((and (consp result)
14997 (stringp (car result))) result)
14998 (result entry)
14999 (t nil))))
15001 (defun org-diary-to-ical-string (frombuf)
15002 "Get iCalendar entries from diary entries in buffer FROMBUF.
15003 This uses the icalendar.el library."
15004 (let* ((tmpdir (if (featurep 'xemacs)
15005 (temp-directory)
15006 temporary-file-directory))
15007 (tmpfile (make-temp-name
15008 (expand-file-name "orgics" tmpdir)))
15009 buf rtn b e)
15010 (with-current-buffer frombuf
15011 (icalendar-export-region (point-min) (point-max) tmpfile)
15012 (setq buf (find-buffer-visiting tmpfile))
15013 (set-buffer buf)
15014 (goto-char (point-min))
15015 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15016 (setq b (match-beginning 0)))
15017 (goto-char (point-max))
15018 (if (re-search-backward "^END:VEVENT" nil t)
15019 (setq e (match-end 0)))
15021 (kill-buffer buf)
15022 (delete-file tmpfile)
15023 rtn))
15025 (defun org-closest-date (start current change prefer show-all)
15026 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15027 When PREFER is `past' return a date that is either CURRENT or past.
15028 When PREFER is `future', return a date that is either CURRENT or future.
15029 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15030 ;; Make the proper lists from the dates
15031 (catch 'exit
15032 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15033 dn dw sday cday n1 n2 n0
15034 d m y y1 y2 date1 date2 nmonths nm ny m2)
15036 (setq start (org-date-to-gregorian start)
15037 current (org-date-to-gregorian
15038 (if show-all
15039 current
15040 (time-to-days (current-time))))
15041 sday (calendar-absolute-from-gregorian start)
15042 cday (calendar-absolute-from-gregorian current))
15044 (if (<= cday sday) (throw 'exit sday))
15047 (setq dn (string-to-number (match-string 1 change))
15048 dw (cdr (assoc (match-string 2 change) a1)))
15049 (error "Invalid change specifier: %s" change))
15050 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15051 (cond
15052 ((eq dw 'day)
15053 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15054 n2 (+ n1 dn)))
15055 ((eq dw 'year)
15056 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15057 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15058 (setq date1 (list m d y1)
15059 n1 (calendar-absolute-from-gregorian date1)
15060 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15061 n2 (calendar-absolute-from-gregorian date2)))
15062 ((eq dw 'month)
15063 ;; approx number of month between the two dates
15064 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15065 ;; How often does dn fit in there?
15066 (setq d (nth 1 start) m (car start) y (nth 2 start)
15067 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15068 m (+ m nm)
15069 ny (floor (/ m 12))
15070 y (+ y ny)
15071 m (- m (* ny 12)))
15072 (while (> m 12) (setq m (- m 12) y (1+ y)))
15073 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15074 (setq m2 (+ m dn) y2 y)
15075 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15076 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15077 (while (<= n2 cday)
15078 (setq n1 n2 m m2 y y2)
15079 (setq m2 (+ m dn) y2 y)
15080 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15081 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15082 ;; Make sure n1 is the earlier date
15083 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15084 (if show-all
15085 (cond
15086 ((eq prefer 'past) (if (= cday n2) n2 n1))
15087 ((eq prefer 'future) (if (= cday n1) n1 n2))
15088 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15089 (cond
15090 ((eq prefer 'past) (if (= cday n2) n2 n1))
15091 ((eq prefer 'future) (if (= cday n1) n1 n2))
15092 (t (if (= cday n1) n1 n2)))))))
15094 (defun org-date-to-gregorian (date)
15095 "Turn any specification of DATE into a Gregorian date for the calendar."
15096 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15097 ((and (listp date) (= (length date) 3)) date)
15098 ((stringp date)
15099 (setq date (org-parse-time-string date))
15100 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15101 ((listp date)
15102 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15104 (defun org-parse-time-string (s &optional nodefault)
15105 "Parse the standard Org-mode time string.
15106 This should be a lot faster than the normal `parse-time-string'.
15107 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15108 hour and minute fields will be nil if not given."
15109 (if (string-match org-ts-regexp0 s)
15110 (list 0
15111 (if (or (match-beginning 8) (not nodefault))
15112 (string-to-number (or (match-string 8 s) "0")))
15113 (if (or (match-beginning 7) (not nodefault))
15114 (string-to-number (or (match-string 7 s) "0")))
15115 (string-to-number (match-string 4 s))
15116 (string-to-number (match-string 3 s))
15117 (string-to-number (match-string 2 s))
15118 nil nil nil)
15119 (error "Not a standard Org-mode time string: %s" s)))
15121 (defun org-timestamp-up (&optional arg)
15122 "Increase the date item at the cursor by one.
15123 If the cursor is on the year, change the year. If it is on the month or
15124 the day, change that.
15125 With prefix ARG, change by that many units."
15126 (interactive "p")
15127 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15129 (defun org-timestamp-down (&optional arg)
15130 "Decrease the date item at the cursor by one.
15131 If the cursor is on the year, change the year. If it is on the month or
15132 the day, change that.
15133 With prefix ARG, change by that many units."
15134 (interactive "p")
15135 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15137 (defun org-timestamp-up-day (&optional arg)
15138 "Increase the date in the time stamp by one day.
15139 With prefix ARG, change that many days."
15140 (interactive "p")
15141 (if (and (not (org-at-timestamp-p t))
15142 (org-on-heading-p))
15143 (org-todo 'up)
15144 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15146 (defun org-timestamp-down-day (&optional arg)
15147 "Decrease the date in the time stamp by one day.
15148 With prefix ARG, change that many days."
15149 (interactive "p")
15150 (if (and (not (org-at-timestamp-p t))
15151 (org-on-heading-p))
15152 (org-todo 'down)
15153 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15155 (defun org-at-timestamp-p (&optional inactive-ok)
15156 "Determine if the cursor is in or at a timestamp."
15157 (interactive)
15158 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15159 (pos (point))
15160 (ans (or (looking-at tsr)
15161 (save-excursion
15163 (if (> (point) (point-min)) (backward-char 1))
15164 (and (looking-at tsr)
15165 (> (- (match-end 0) pos) -1))))))
15166 (and ans
15167 (boundp 'org-ts-what)
15168 (setq org-ts-what
15169 (cond
15170 ((= pos (match-beginning 0)) 'bracket)
15171 ((= pos (1- (match-end 0))) 'bracket)
15172 ((org-pos-in-match-range pos 2) 'year)
15173 ((org-pos-in-match-range pos 3) 'month)
15174 ((org-pos-in-match-range pos 7) 'hour)
15175 ((org-pos-in-match-range pos 8) 'minute)
15176 ((or (org-pos-in-match-range pos 4)
15177 (org-pos-in-match-range pos 5)) 'day)
15178 ((and (> pos (or (match-end 8) (match-end 5)))
15179 (< pos (match-end 0)))
15180 (- pos (or (match-end 8) (match-end 5))))
15181 (t 'day))))
15182 ans))
15184 (defun org-toggle-timestamp-type ()
15185 "Toggle the type (<active> or [inactive]) of a time stamp."
15186 (interactive)
15187 (when (org-at-timestamp-p t)
15188 (let ((beg (match-beginning 0)) (end (match-end 0))
15189 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15190 (save-excursion
15191 (goto-char beg)
15192 (while (re-search-forward "[][<>]" end t)
15193 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15194 t t)))
15195 (message "Timestamp is now %sactive"
15196 (if (equal (char-after beg) ?<) "" "in")))))
15198 (defun org-timestamp-change (n &optional what updown)
15199 "Change the date in the time stamp at point.
15200 The date will be changed by N times WHAT. WHAT can be `day', `month',
15201 `year', `minute', `second'. If WHAT is not given, the cursor position
15202 in the timestamp determines what will be changed."
15203 (let ((pos (point))
15204 with-hm inactive
15205 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15206 org-ts-what
15207 extra rem
15208 ts time time0)
15209 (if (not (org-at-timestamp-p t))
15210 (error "Not at a timestamp"))
15211 (if (and (not what) (eq org-ts-what 'bracket))
15212 (org-toggle-timestamp-type)
15213 (if (and (not what) (not (eq org-ts-what 'day))
15214 org-display-custom-times
15215 (get-text-property (point) 'display)
15216 (not (get-text-property (1- (point)) 'display)))
15217 (setq org-ts-what 'day))
15218 (setq org-ts-what (or what org-ts-what)
15219 inactive (= (char-after (match-beginning 0)) ?\[)
15220 ts (match-string 0))
15221 (replace-match "")
15222 (if (string-match
15224 ts)
15225 (setq extra (match-string 1 ts)))
15227 (setq with-hm t))
15228 (setq time0 (org-parse-time-string ts))
15229 (when (and updown
15230 (eq org-ts-what 'minute)
15231 (not current-prefix-arg))
15232 ;; This looks like s-up and s-down. Change by one rounding step.
15233 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15234 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15235 (setcar (cdr time0) (+ (nth 1 time0)
15236 (if (> n 0) (- rem) (- dm rem))))))
15237 (setq time
15238 (encode-time (or (car time0) 0)
15239 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15240 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15241 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15242 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15243 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15244 (nthcdr 6 time0)))
15245 (when (and (member org-ts-what '(hour minute))
15246 extra
15248 (setq extra (org-modify-ts-extra
15249 extra
15250 (if (eq org-ts-what 'hour) 2 5)
15251 n dm)))
15252 (when (integerp org-ts-what)
15253 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15254 (if (eq what 'calendar)
15255 (let ((cal-date (org-get-date-from-calendar)))
15256 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15257 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15258 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15259 (setcar time0 (or (car time0) 0))
15260 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15261 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15262 (setq time (apply 'encode-time time0))))
15263 (setq org-last-changed-timestamp
15264 (org-insert-time-stamp time with-hm inactive nil nil extra))
15265 (org-clock-update-time-maybe)
15266 (goto-char pos)
15267 ;; Try to recenter the calendar window, if any
15268 (if (and org-calendar-follow-timestamp-change
15269 (get-buffer-window "*Calendar*" t)
15270 (memq org-ts-what '(day month year)))
15271 (org-recenter-calendar (time-to-days time))))))
15273 (defun org-modify-ts-extra (s pos n dm)
15274 "Change the different parts of the lead-time and repeat fields in timestamp."
15275 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15276 ng h m new rem)
15277 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15278 (cond
15279 ((or (org-pos-in-match-range pos 2)
15280 (org-pos-in-match-range pos 3))
15281 (setq m (string-to-number (match-string 3 s))
15282 h (string-to-number (match-string 2 s)))
15283 (if (org-pos-in-match-range pos 2)
15284 (setq h (+ h n))
15285 (setq n (* dm (org-no-warnings (signum n))))
15286 (when (not (= 0 (setq rem (% m dm))))
15287 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15288 (setq m (+ m n)))
15289 (if (< m 0) (setq m (+ m 60) h (1- h)))
15290 (if (> m 59) (setq m (- m 60) h (1+ h)))
15291 (setq h (min 24 (max 0 h)))
15292 (setq ng 1 new (format "-%02d:%02d" h m)))
15293 ((org-pos-in-match-range pos 6)
15294 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15295 ((org-pos-in-match-range pos 5)
15296 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15298 ((org-pos-in-match-range pos 9)
15299 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15300 ((org-pos-in-match-range pos 8)
15301 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15303 (when ng
15304 (setq s (concat
15305 (substring s 0 (match-beginning ng))
15306 new
15307 (substring s (match-end ng))))))
15308 s))
15310 (defun org-recenter-calendar (date)
15311 "If the calendar is visible, recenter it to DATE."
15312 (let* ((win (selected-window))
15313 (cwin (get-buffer-window "*Calendar*" t))
15314 (calendar-move-hook nil))
15315 (when cwin
15316 (select-window cwin)
15317 (calendar-goto-date (if (listp date) date
15318 (calendar-gregorian-from-absolute date)))
15319 (select-window win))))
15321 (defun org-goto-calendar (&optional arg)
15322 "Go to the Emacs calendar at the current date.
15323 If there is a time stamp in the current line, go to that date.
15324 A prefix ARG can be used to force the current date."
15325 (interactive "P")
15326 (let ((tsr org-ts-regexp) diff
15327 (calendar-move-hook nil)
15328 (calendar-view-holidays-initially-flag nil)
15329 (calendar-view-diary-initially-flag nil))
15330 (if (or (org-at-timestamp-p)
15331 (save-excursion
15332 (beginning-of-line 1)
15333 (looking-at (concat ".*" tsr))))
15334 (let ((d1 (time-to-days (current-time)))
15335 (d2 (time-to-days
15336 (org-time-string-to-time (match-string 1)))))
15337 (setq diff (- d2 d1))))
15338 (calendar)
15339 (calendar-goto-today)
15340 (if (and diff (not arg)) (calendar-forward-day diff))))
15342 (defun org-get-date-from-calendar ()
15343 "Return a list (month day year) of date at point in calendar."
15344 (with-current-buffer "*Calendar*"
15345 (save-match-data
15346 (calendar-cursor-to-date))))
15348 (defun org-date-from-calendar ()
15349 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15350 If there is already a time stamp at the cursor position, update it."
15351 (interactive)
15352 (if (org-at-timestamp-p t)
15353 (org-timestamp-change 0 'calendar)
15354 (let ((cal-date (org-get-date-from-calendar)))
15355 (org-insert-time-stamp
15356 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15358 (defun org-minutes-to-hh:mm-string (m)
15359 "Compute H:MM from a number of minutes."
15360 (let ((h (/ m 60)))
15361 (setq m (- m (* 60 h)))
15362 (format org-time-clocksum-format h m)))
15364 (defun org-hh:mm-string-to-minutes (s)
15365 "Convert a string H:MM to a number of minutes.
15366 If the string is just a number, interpret it as minutes.
15367 In fact, the first hh:mm or number in the string will be taken,
15368 there can be extra stuff in the string.
15369 If no number is found, the return value is 0."
15370 (cond
15372 (+ (* (string-to-number (match-string 1 s)) 60)
15373 (string-to-number (match-string 2 s))))
15375 (string-to-number (match-string 1 s)))
15376 (t 0)))
15378 ;;;; Files
15380 (defun org-save-all-org-buffers ()
15381 "Save all Org-mode buffers without user confirmation."
15382 (interactive)
15383 (message "Saving all Org-mode buffers...")
15384 (save-some-buffers t 'org-mode-p)
15385 (when (featurep 'org-id) (org-id-locations-save))
15386 (message "Saving all Org-mode buffers... done"))
15388 (defun org-revert-all-org-buffers ()
15389 "Revert all Org-mode buffers.
15390 Prompt for confirmation when there are unsaved changes.
15391 Be sure you know what you are doing before letting this function
15392 overwrite your changes.
15394 This function is useful in a setup where one tracks org files
15395 with a version control system, to revert on one machine after pulling
15396 changes from another. I believe the procedure must be like this:
15398 1. M-x org-save-all-org-buffers
15399 2. Pull changes from the other machine, resolve conflicts
15400 3. M-x org-revert-all-org-buffers"
15401 (interactive)
15402 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15403 (error "Abort"))
15404 (save-excursion
15405 (save-window-excursion
15406 (mapc
15407 (lambda (b)
15408 (when (and (with-current-buffer b (org-mode-p))
15409 (with-current-buffer b buffer-file-name))
15410 (switch-to-buffer b)
15411 (revert-buffer t 'no-confirm)))
15412 (buffer-list))
15413 (when (and (featurep 'org-id) org-id-track-globally)
15414 (org-id-locations-load)))))
15416 ;;;; Agenda files
15418 ;;;###autoload
15419 (defun org-switchb (&optional arg)
15420 "Switch between Org buffers.
15421 With a prefix argument, restrict available to files.
15422 With two prefix arguments, restrict available buffers to agenda files.
15424 Defaults to `iswitchb' for buffer name completion.
15425 Set `org-completion-use-ido' to make it use ido instead."
15426 (interactive "P")
15427 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15428 ((equal arg '(16)) (org-buffer-list 'agenda))
15429 (t (org-buffer-list))))
15430 (org-completion-use-iswitchb org-completion-use-iswitchb)
15431 (org-completion-use-ido org-completion-use-ido))
15432 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15433 (setq org-completion-use-iswitchb t))
15434 (switch-to-buffer
15435 (org-icompleting-read "Org buffer: "
15436 (mapcar 'list (mapcar 'buffer-name blist))
15437 nil t))))
15439 ;;; Define some older names previously used for this functionality
15440 ;;;###autoload
15441 (defalias 'org-ido-switchb 'org-switchb)
15442 ;;;###autoload
15443 (defalias 'org-iswitchb 'org-switchb)
15445 (defun org-buffer-list (&optional predicate exclude-tmp)
15446 "Return a list of Org buffers.
15447 PREDICATE can be `export', `files' or `agenda'.
15449 export restrict the list to Export buffers.
15450 files restrict the list to buffers visiting Org files.
15451 agenda restrict the list to buffers visiting agenda files.
15453 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15454 (let* ((bfn nil)
15455 (agenda-files (and (eq predicate 'agenda)
15456 (mapcar 'file-truename (org-agenda-files t))))
15457 (filter
15458 (cond
15459 ((eq predicate 'files)
15460 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
15461 ((eq predicate 'export)
15462 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15463 ((eq predicate 'agenda)
15464 (lambda (b)
15465 (with-current-buffer b
15466 (and (eq major-mode 'org-mode)
15467 (setq bfn (buffer-file-name b))
15468 (member (file-truename bfn) agenda-files)))))
15469 (t (lambda (b) (with-current-buffer b
15470 (or (eq major-mode 'org-mode)
15471 (string-match "\*Org .*Export"
15472 (buffer-name b)))))))))
15473 (delq nil
15474 (mapcar
15475 (lambda(b)
15476 (if (and (funcall filter b)
15477 (or (not exclude-tmp)
15478 (not (string-match "tmp" (buffer-name b)))))
15479 b
15480 nil))
15481 (buffer-list)))))
15483 (defun org-agenda-files (&optional unrestricted archives)
15484 "Get the list of agenda files.
15485 Optional UNRESTRICTED means return the full list even if a restriction
15486 is currently in place.
15487 When ARCHIVES is t, include all archive files that are really being
15488 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15489 `org-agenda-archives-mode' is t."
15490 (let ((files
15491 (cond
15492 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15493 ((stringp org-agenda-files) (org-read-agenda-file-list))
15494 ((listp org-agenda-files) org-agenda-files)
15495 (t (error "Invalid value of `org-agenda-files'")))))
15496 (setq files (apply 'append
15497 (mapcar (lambda (f)
15498 (if (file-directory-p f)
15499 (directory-files
15500 f t org-agenda-file-regexp)
15501 (list f)))
15502 files)))
15503 (when org-agenda-skip-unavailable-files
15504 (setq files (delq nil
15505 (mapcar (function
15506 (lambda (file)
15507 (and (file-readable-p file) file)))
15508 files))))
15509 (when (or (eq archives t)
15510 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15511 (setq files (org-add-archive-files files)))
15512 files))
15514 (defun org-agenda-file-p (&optional file)
15515 "Return non-nil, if FILE is an agenda file.
15516 If FILE is omitted, use the file associated with the current
15517 buffer."
15518 (member (or file (buffer-file-name))
15519 (org-agenda-files t)))
15521 (defun org-edit-agenda-file-list ()
15522 "Edit the list of agenda files.
15523 Depending on setup, this either uses customize to edit the variable
15524 `org-agenda-files', or it visits the file that is holding the list. In the
15525 latter case, the buffer is set up in a way that saving it automatically kills
15526 the buffer and restores the previous window configuration."
15527 (interactive)
15528 (if (stringp org-agenda-files)
15529 (let ((cw (current-window-configuration)))
15530 (find-file org-agenda-files)
15531 (org-set-local 'org-window-configuration cw)
15532 (org-add-hook 'after-save-hook
15533 (lambda ()
15534 (set-window-configuration
15535 (prog1 org-window-configuration
15536 (kill-buffer (current-buffer))))
15537 (org-install-agenda-files-menu)
15538 (message "New agenda file list installed"))
15539 nil 'local)
15540 (message "%s" (substitute-command-keys
15542 (customize-variable 'org-agenda-files)))
15544 (defun org-store-new-agenda-file-list (list)
15545 "Set new value for the agenda file list and save it correctly."
15546 (if (stringp org-agenda-files)
15547 (let ((fe (org-read-agenda-file-list t)) b u)
15548 (while (setq b (find-buffer-visiting org-agenda-files))
15549 (kill-buffer b))
15550 (with-temp-file org-agenda-files
15551 (insert
15552 (mapconcat
15553 (lambda (f) ;; Keep un-expanded entries.
15554 (if (setq u (assoc f fe))
15555 (cdr u)
15556 f))
15559 (let ((org-mode-hook nil) (org-inhibit-startup t)
15560 (org-insert-mode-line-in-empty-file nil))
15561 (setq org-agenda-files list)
15562 (customize-save-variable 'org-agenda-files org-agenda-files))))
15564 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15565 "Read the list of agenda files from a file.
15566 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15567 filenames, used by `org-store-new-agenda-file-list' to write back
15568 un-expanded file names."
15569 (when (file-directory-p org-agenda-files)
15570 (error "`org-agenda-files' cannot be a single directory"))
15571 (when (stringp org-agenda-files)
15572 (with-temp-buffer
15573 (insert-file-contents org-agenda-files)
15574 (mapcar
15575 (lambda (f)
15576 (let ((e (expand-file-name (substitute-in-file-name f)
15577 org-directory)))
15578 (if pair-with-expansion
15579 (cons e f)
15580 e)))
15583 ;;;###autoload
15584 (defun org-cycle-agenda-files ()
15585 "Cycle through the files in `org-agenda-files'.
15586 If the current buffer visits an agenda file, find the next one in the list.
15587 If the current buffer does not, find the first agenda file."
15588 (interactive)
15589 (let* ((fs (org-agenda-files t))
15590 (files (append fs (list (car fs))))
15591 (tcf (if buffer-file-name (file-truename buffer-file-name)))
15592 file)
15593 (unless files (error "No agenda files"))
15594 (catch 'exit
15595 (while (setq file (pop files))
15596 (if (equal (file-truename file) tcf)
15597 (when (car files)
15598 (find-file (car files))
15599 (throw 'exit t))))
15600 (find-file (car fs)))
15601 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
15603 (defun org-agenda-file-to-front (&optional to-end)
15604 "Move/add the current file to the top of the agenda file list.
15605 If the file is not present in the list, it is added to the front. If it is
15606 present, it is moved there. With optional argument TO-END, add/move to the
15607 end of the list."
15608 (interactive "P")
15609 (let ((org-agenda-skip-unavailable-files nil)
15610 (file-alist (mapcar (lambda (x)
15611 (cons (file-truename x) x))
15612 (org-agenda-files t)))
15613 (ctf (file-truename buffer-file-name))
15614 x had)
15615 (setq x (assoc ctf file-alist) had x)
15617 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
15618 (if to-end
15619 (setq file-alist (append (delq x file-alist) (list x)))
15620 (setq file-alist (cons x (delq x file-alist))))
15621 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
15622 (org-install-agenda-files-menu)
15623 (message "File %s to %s of agenda file list"
15624 (if had "moved" "added") (if to-end "end" "front"))))
15626 (defun org-remove-file (&optional file)
15627 "Remove current file from the list of files in variable `org-agenda-files'.
15628 These are the files which are being checked for agenda entries.
15629 Optional argument FILE means use this file instead of the current."
15630 (interactive)
15631 (let* ((org-agenda-skip-unavailable-files nil)
15632 (file (or file buffer-file-name))
15633 (true-file (file-truename file))
15634 (afile (abbreviate-file-name file))
15635 (files (delq nil (mapcar
15636 (lambda (x)
15637 (if (equal true-file
15638 (file-truename x))
15639 nil x))
15640 (org-agenda-files t)))))
15641 (if (not (= (length files) (length (org-agenda-files t))))
15642 (progn
15643 (org-store-new-agenda-file-list files)
15644 (org-install-agenda-files-menu)
15645 (message "Removed file: %s" afile))
15646 (message "File was not in list: %s (not removed)" afile))))
15648 (defun org-file-menu-entry (file)
15649 (vector file (list 'find-file file) t))
15651 (defun org-check-agenda-file (file)
15652 "Make sure FILE exists. If not, ask user what to do."
15653 (when (not (file-exists-p file))
15654 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
15655 (abbreviate-file-name file))
15656 (let ((r (downcase (read-char-exclusive))))
15657 (cond
15658 ((equal r ?r)
15659 (org-remove-file file)
15660 (throw 'nextfile t))
15661 (t (error "Abort"))))))
15663 (defun org-get-agenda-file-buffer (file)
15664 "Get a buffer visiting FILE. If the buffer needs to be created, add
15665 it to the list of buffers which might be released later."
15666 (let ((buf (org-find-base-buffer-visiting file)))
15667 (if buf
15668 buf ; just return it
15669 ;; Make a new buffer and remember it
15670 (setq buf (find-file-noselect file))
15671 (if buf (push buf org-agenda-new-buffers))
15672 buf)))
15674 (defun org-release-buffers (blist)
15675 "Release all buffers in list, asking the user for confirmation when needed.
15676 When a buffer is unmodified, it is just killed. When modified, it is saved
15677 \(if the user agrees) and then killed."
15678 (let (buf file)
15679 (while (setq buf (pop blist))
15680 (setq file (buffer-file-name buf))
15681 (when (and (buffer-modified-p buf)
15682 file
15683 (y-or-n-p (format "Save file %s? " file)))
15684 (with-current-buffer buf (save-buffer)))
15685 (kill-buffer buf))))
15687 (defun org-prepare-agenda-buffers (files)
15688 "Create buffers for all agenda files, protect archived trees and comments."
15689 (interactive)
15690 (let ((pa '(:org-archived t))
15691 (pc '(:org-comment t))
15692 (pall '(:org-archived t :org-comment t))
15693 (inhibit-read-only t)
15694 (rea (concat ":" org-archive-tag ":"))
15695 bmp file re)
15696 (save-excursion
15697 (save-restriction
15698 (while (setq file (pop files))
15699 (catch 'nextfile
15700 (if (bufferp file)
15701 (set-buffer file)
15702 (org-check-agenda-file file)
15703 (set-buffer (org-get-agenda-file-buffer file)))
15704 (widen)
15705 (setq bmp (buffer-modified-p))
15706 (org-refresh-category-properties)
15707 (setq org-todo-keywords-for-agenda
15708 (append org-todo-keywords-for-agenda org-todo-keywords-1))
15709 (setq org-done-keywords-for-agenda
15710 (append org-done-keywords-for-agenda org-done-keywords))
15711 (setq org-todo-keyword-alist-for-agenda
15712 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
15713 (setq org-drawers-for-agenda
15714 (append org-drawers-for-agenda org-drawers))
15715 (setq org-tag-alist-for-agenda
15716 (append org-tag-alist-for-agenda org-tag-alist))
15718 (save-excursion
15719 (remove-text-properties (point-min) (point-max) pall)
15720 (when org-agenda-skip-archived-trees
15721 (goto-char (point-min))
15722 (while (re-search-forward rea nil t)
15723 (if (org-on-heading-p t)
15724 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
15725 (goto-char (point-min))
15727 (while (re-search-forward re nil t)
15728 (add-text-properties
15729 (match-beginning 0) (org-end-of-subtree t) pc)))
15730 (set-buffer-modified-p bmp)))))
15731 (setq org-todo-keywords-for-agenda
15732 (org-uniquify org-todo-keywords-for-agenda))
15733 (setq org-todo-keyword-alist-for-agenda
15734 (org-uniquify org-todo-keyword-alist-for-agenda)
15735 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
15737 ;;;; Embedded LaTeX
15739 (defvar org-cdlatex-mode-map (make-sparse-keymap)
15740 "Keymap for the minor `org-cdlatex-mode'.")
15742 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
15743 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
15744 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
15745 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
15746 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
15748 (defvar org-cdlatex-texmathp-advice-is-done nil
15749 "Flag remembering if we have applied the advice to texmathp already.")
15751 (define-minor-mode org-cdlatex-mode
15752 "Toggle the minor `org-cdlatex-mode'.
15753 This mode supports entering LaTeX environment and math in LaTeX fragments
15754 in Org-mode.
15756 nil " OCDL" nil
15757 (when org-cdlatex-mode (require 'cdlatex))
15758 (unless org-cdlatex-texmathp-advice-is-done
15759 (setq org-cdlatex-texmathp-advice-is-done t)
15760 (defadvice texmathp (around org-math-always-on activate)
15761 "Always return t in org-mode buffers.
15762 This is because we want to insert math symbols without dollars even outside
15763 the LaTeX math segments. If Orgmode thinks that point is actually inside
15764 an embedded LaTeX fragment, let texmathp do its job.
15766 (interactive)
15767 (let (p)
15768 (cond
15769 ((not (org-mode-p)) ad-do-it)
15770 ((eq this-command 'cdlatex-math-symbol)
15771 (setq ad-return-value t
15772 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
15773 (t
15774 (let ((p (org-inside-LaTeX-fragment-p)))
15775 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
15776 (setq ad-return-value t
15777 texmathp-why '("Org-mode embedded math" . 0))
15778 (if p ad-do-it)))))))))
15780 (defun turn-on-org-cdlatex ()
15781 "Unconditionally turn on `org-cdlatex-mode'."
15782 (org-cdlatex-mode 1))
15784 (defun org-inside-LaTeX-fragment-p ()
15785 "Test if point is inside a LaTeX fragment.
15787 sequence appearing also before point.
15788 Even though the matchers for math are configurable, this function assumes
15790 delimiters are skipped when they have been removed by customization.
15791 The return value is nil, or a cons cell with the delimiter and
15792 and the position of this delimiter.
15794 This function does a reasonably good job, but can locally be fooled by
15795 for example currency specifications. For example it will assume being in
15797 fragments that are properly closed, but during editing, we have to live
15798 with the uncertainty caused by missing closing delimiters. This function
15799 looks only before point, not after."
15800 (catch 'exit
15801 (let ((pos (point))
15802 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
15803 (lim (progn
15805 (point)))
15806 dd-on str (start 0) m re)
15807 (goto-char pos)
15808 (when dodollar
15810 re (nth 1 (assoc "$" org-latex-regexps)))
15811 (while (string-match re str start)
15812 (cond
15813 ((= (match-end 0) (length str))
15814 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
15815 ((= (match-end 0) (- (length str) 5))
15816 (throw 'exit nil))
15817 (t (setq start (match-end 0))))))
15818 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
15819 (goto-char pos)
15820 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
15821 (and (match-beginning 2) (throw 'exit nil))
15822 ;; count $$
15824 (setq dd-on (not dd-on)))
15825 (goto-char pos)
15826 (if dd-on (cons "$$" m))))))
15828 (defun org-inside-latex-macro-p ()
15829 "Is point inside a LaTeX macro or its arguments?"
15830 (save-match-data
15831 (org-in-regexp
15834 (defun org-try-cdlatex-tab ()
15835 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15836 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15837 - inside a LaTeX fragment, or
15838 - after the first word in a line, where an abbreviation expansion could
15839 insert a LaTeX environment."
15840 (when org-cdlatex-mode
15841 (cond
15842 ((save-excursion
15843 (skip-chars-backward "a-zA-Z0-9*")
15845 (bolp))
15846 (cdlatex-tab) t)
15847 ((org-inside-LaTeX-fragment-p)
15848 (cdlatex-tab) t)
15849 (t nil))))
15851 (defun org-cdlatex-underscore-caret (&optional arg)
15852 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15853 Revert to the normal definition outside of these fragments."
15854 (interactive "P")
15855 (if (org-inside-LaTeX-fragment-p)
15856 (call-interactively 'cdlatex-sub-superscript)
15857 (let (org-cdlatex-mode)
15858 (call-interactively (key-binding (vector last-input-event))))))
15860 (defun org-cdlatex-math-modify (&optional arg)
15861 "Execute `cdlatex-math-modify' in LaTeX fragments.
15862 Revert to the normal definition outside of these fragments."
15863 (interactive "P")
15864 (if (org-inside-LaTeX-fragment-p)
15865 (call-interactively 'cdlatex-math-modify)
15866 (let (org-cdlatex-mode)
15867 (call-interactively (key-binding (vector last-input-event))))))
15869 (defvar org-latex-fragment-image-overlays nil
15870 "List of overlays carrying the images of latex fragments.")
15871 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
15873 (defun org-remove-latex-fragment-image-overlays ()
15874 "Remove all overlays with LaTeX fragment images in current buffer."
15875 (mapc 'delete-overlay org-latex-fragment-image-overlays)
15876 (setq org-latex-fragment-image-overlays nil))
15878 (defun org-preview-latex-fragment (&optional subtree)
15879 "Preview the LaTeX fragment at point, or all locally or globally.
15880 If the cursor is in a LaTeX fragment, create the image and overlay
15881 it over the source code. If there is no fragment at point, display
15882 all fragments in the current text, from one headline to the next. With
15883 prefix SUBTREE, display all fragments in the current subtree. With a
15885 the cursor is before the first headline,
15886 display all fragments in the buffer.
15888 (interactive "P")
15889 (org-remove-latex-fragment-image-overlays)
15890 (save-excursion
15891 (save-restriction
15892 (let (beg end at msg)
15893 (cond
15894 ((or (equal subtree '(16))
15895 (not (save-excursion
15896 (re-search-backward (concat "^" outline-regexp) nil t))))
15897 (setq beg (point-min) end (point-max)
15898 msg "Creating images for buffer...%s"))
15899 ((equal subtree '(4))
15900 (org-back-to-heading)
15901 (setq beg (point) end (org-end-of-subtree t)
15902 msg "Creating images for subtree...%s"))
15903 (t
15904 (if (setq at (org-inside-LaTeX-fragment-p))
15905 (goto-char (max (point-min) (- (cdr at) 2)))
15906 (org-back-to-heading))
15907 (setq beg (point) end (progn (outline-next-heading) (point))
15908 msg (if at "Creating image...%s"
15909 "Creating images for entry...%s"))))
15910 (message msg "")
15911 (narrow-to-region beg end)
15912 (goto-char beg)
15913 (org-format-latex
15914 (concat "ltxpng/" (file-name-sans-extension
15915 (file-name-nondirectory
15916 buffer-file-name)))
15917 default-directory 'overlays msg at 'forbuffer 'dvipng)
15918 (message msg "done. Use `C-c C-c' to remove images.")))))
15920 (defvar org-latex-regexps
15922 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
15925 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
15929 "Regular expressions for matching embedded LaTeX.")
15931 (defvar org-export-have-math nil) ;; dynamic scoping
15932 (defun org-format-latex (prefix &optional dir overlays msg at
15933 forbuffer processing-type)
15934 "Replace LaTeX fragments with links to an image, and produce images.
15935 Some of the options can be changed using the variable
15936 `org-format-latex-options'."
15937 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
15938 (let* ((prefixnodir (file-name-nondirectory prefix))
15939 (absprefix (expand-file-name prefix dir))
15940 (todir (file-name-directory absprefix))
15941 (opt org-format-latex-options)
15942 (matchers (plist-get opt :matchers))
15943 (re-list org-latex-regexps)
15944 (org-format-latex-header-extra
15945 (plist-get (org-infile-export-plist) :latex-header-extra))
15946 (cnt 0) txt hash link beg end re e checkdir
15947 executables-checked string
15948 m n block linkfile movefile ov)
15949 ;; Check the different regular expressions
15950 (while (setq e (pop re-list))
15951 (setq m (car e) re (nth 1 e) n (nth 2 e)
15953 (when (member m matchers)
15954 (goto-char (point-min))
15955 (while (re-search-forward re nil t)
15956 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
15957 (not (get-text-property (match-beginning n)
15958 'org-protected))
15959 (or (not overlays)
15960 (not (eq (get-char-property (match-beginning n)
15961 'org-overlay-type)
15962 'org-latex-overlay))))
15963 (setq org-export-have-math t)
15964 (cond
15965 ((eq processing-type 'verbatim)
15966 ;; Leave the text verbatim, just protect it
15967 (add-text-properties (match-beginning n) (match-end n)
15968 '(org-protected t)))
15969 ((eq processing-type 'mathjax)
15970 ;; Prepare for MathJax processing
15971 (setq string (match-string n))
15972 (if (member m '("$" "$1"))
15973 (save-excursion
15974 (delete-region (match-beginning n) (match-end n))
15975 (goto-char (match-beginning n))
15978 '(org-protected t))))
15979 (add-text-properties (match-beginning n) (match-end n)
15980 '(org-protected t))))
15981 ((or (eq processing-type 'dvipng) t)
15982 ;; Process to an image
15983 (setq txt (match-string n)
15984 beg (match-beginning n) end (match-end n)
15985 cnt (1+ cnt))
15986 (let (print-length print-level) ; make sure full list is printed
15987 (setq hash (sha1 (prin1-to-string
15988 (list org-format-latex-header
15989 org-format-latex-header-extra
15990 org-export-latex-default-packages-alist
15991 org-export-latex-packages-alist
15992 org-format-latex-options
15993 forbuffer txt)))
15994 linkfile (format "%s_%s.png" prefix hash)
15995 movefile (format "%s_%s.png" absprefix hash)))
15996 (setq link (concat block "[[file:" linkfile "]]" block))
15997 (if msg (message msg cnt))
15998 (goto-char beg)
15999 (unless checkdir ; make sure the directory exists
16000 (setq checkdir t)
16001 (or (file-directory-p todir) (make-directory todir t)))
16003 (unless executables-checked
16004 (org-check-external-command
16005 "latex" "needed to convert LaTeX fragments to images")
16006 (org-check-external-command
16007 "dvipng" "needed to convert LaTeX fragments to images")
16008 (setq executables-checked t))
16010 (unless (file-exists-p movefile)
16011 (org-create-formula-image
16012 txt movefile opt forbuffer))
16013 (if overlays
16014 (progn
16015 (mapc (lambda (o)
16016 (if (eq (overlay-get o 'org-overlay-type)
16017 'org-latex-overlay)
16018 (delete-overlay o)))
16019 (overlays-in beg end))
16020 (setq ov (make-overlay beg end))
16021 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16022 (if (featurep 'xemacs)
16023 (progn
16024 (overlay-put ov 'invisible t)
16025 (overlay-put
16026 ov 'end-glyph
16027 (make-glyph (vector 'png :file movefile))))
16028 (overlay-put
16029 ov 'display
16030 (list 'image :type 'png :file movefile :ascent 'center)))
16031 (push ov org-latex-fragment-image-overlays)
16032 (goto-char end))
16033 (delete-region beg end)
16034 (insert (org-add-props link
16035 (list 'org-latex-src
16036 (replace-regexp-in-string
16039 ;; This function borrows from Ganesh Swami's latex2png.el
16040 (defun org-create-formula-image (string tofile options buffer)
16041 "This calls dvipng."
16042 (require 'org-latex)
16043 (let* ((tmpdir (if (featurep 'xemacs)
16044 (temp-directory)
16045 temporary-file-directory))
16046 (texfilebase (make-temp-name
16047 (expand-file-name "orgtex" tmpdir)))
16048 (texfile (concat texfilebase ".tex"))
16049 (dvifile (concat texfilebase ".dvi"))
16050 (pngfile (concat texfilebase ".png"))
16051 (fnh (if (featurep 'xemacs)
16052 (font-height (get-face-font 'default))
16053 (face-attribute 'default :height nil)))
16054 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16055 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16056 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16057 "Black"))
16058 (bg (or (plist-get options (if buffer :background :html-background))
16059 "Transparent")))
16060 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16061 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16062 (with-temp-file texfile
16063 (insert (org-splice-latex-header
16064 org-format-latex-header
16065 org-export-latex-default-packages-alist
16066 org-export-latex-packages-alist t
16067 org-format-latex-header-extra))
16069 (require 'org-latex)
16070 (org-export-latex-fix-inputenc))
16071 (let ((dir default-directory))
16072 (condition-case nil
16073 (progn
16074 (cd tmpdir)
16075 (call-process "latex" nil nil nil texfile))
16076 (error nil))
16077 (cd dir))
16078 (if (not (file-exists-p dvifile))
16079 (progn (message "Failed to create dvi file from %s" texfile) nil)
16080 (condition-case nil
16081 (call-process "dvipng" nil nil nil
16082 "-fg" fg "-bg" bg
16083 "-D" dpi
16084 ;;"-x" scale "-y" scale
16085 "-T" "tight"
16086 "-o" pngfile
16087 dvifile)
16088 (error nil))
16089 (if (not (file-exists-p pngfile))
16090 (if org-format-latex-signal-error
16091 (error "Failed to create png file from %s" texfile)
16092 (message "Failed to create png file from %s" texfile)
16093 nil)
16094 ;; Use the requested file name and clean up
16095 (copy-file pngfile tofile 'replace)
16096 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16097 (delete-file (concat texfilebase e)))
16098 pngfile))))
16100 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16101 "Fill a LaTeX header template TPL.
16102 In the template, the following place holders will be recognized:
16105 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16107 [NO-PACKAGES] do not include PKG
16108 [EXTRA] the string EXTRA
16109 [NO-EXTRA] do not include EXTRA
16111 For backward compatibility, if both the positive and the negative place
16113 assumed to be present at the end of the template.
16114 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16115 EXTRA is a string.
16116 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16117 (let (rpl (end ""))
16119 (setq rpl (if (or (match-end 1) (not def-pkg))
16120 "" (org-latex-packages-to-string def-pkg snippets-p t))
16121 tpl (replace-match rpl t t tpl))
16122 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16125 (setq rpl (if (or (match-end 1) (not pkg))
16126 "" (org-latex-packages-to-string pkg snippets-p t))
16127 tpl (replace-match rpl t t tpl))
16128 (if pkg (setq end
16130 (org-latex-packages-to-string pkg snippets-p)))))
16133 (setq rpl (if (or (match-end 1) (not extra))
16135 tpl (replace-match rpl t t tpl))
16141 tpl)))
16143 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16145 (setq pkg (mapconcat (lambda(p)
16146 (cond
16147 ((stringp p) p)
16148 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16149 (format "%% Package %s omitted" (cadr p)))
16150 ((equal "" (car p))
16152 (t
16154 (car p) (cadr p)))))
16155 pkg
16159 (defun org-dvipng-color (attr)
16160 "Return an rgb color specification for dvipng."
16161 (apply 'format "rgb %s %s %s"
16162 (mapcar 'org-normalize-color
16163 (color-values (face-attribute 'default attr nil)))))
16165 (defun org-normalize-color (value)
16166 "Return string to be used as color value for an RGB component."
16167 (format "%g" (/ value 65535.0)))
16169 ;; Image display
16172 (defvar org-inline-image-overlays nil)
16173 (make-variable-buffer-local 'org-inline-image-overlays)
16175 (defun org-toggle-inline-images (&optional include-linked)
16176 "Toggle the display of inline images.
16177 INCLUDE-LINKED is passed to `org-display-inline-images'."
16178 (interactive "P")
16179 (if org-inline-image-overlays
16180 (progn
16181 (org-remove-inline-images)
16182 (message "Inline image display turned off"))
16183 (org-display-inline-images include-linked)
16184 (if org-inline-image-overlays
16185 (message "%d images displayed inline"
16186 (length org-inline-image-overlays))
16187 (message "No images to display inline"))))
16189 (defun org-display-inline-images (&optional include-linked refresh beg end)
16190 "Display inline images.
16191 Normally only links without a description part are inlined, because this
16192 is how it will work for export. When INCLUDE-LINKED is set, also links
16193 with a description part will be inlined. This can be nice for a quick
16194 look at those images, but it does not reflect what exported files will look
16195 like.
16196 When REFRESH is set, refresh existing images between BEG and END.
16197 This will create new image displays only if necessary.
16198 BEG and END default to the buffer boundaries."
16199 (interactive "P")
16200 (unless refresh
16201 (org-remove-inline-images)
16202 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16203 (save-excursion
16204 (save-restriction
16205 (widen)
16206 (setq beg (or beg (point-min)) end (or end (point-max)))
16207 (goto-char (point-min))
16209 (substring (org-image-file-name-regexp) 0 -2)
16211 old file ov img)
16212 (while (re-search-forward re end t)
16213 (setq old (get-char-property-and-overlay (match-beginning 1)
16214 'org-image-overlay))
16215 (setq file (expand-file-name
16216 (concat (or (match-string 3) "") (match-string 4))))
16217 (when (file-exists-p file)
16218 (if (and (car-safe old) refresh)
16219 (image-refresh (overlay-get (cdr old) 'display))
16220 (setq img (save-match-data (create-image file)))
16221 (when img
16222 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16223 (overlay-put ov 'display img)
16224 (overlay-put ov 'face 'default)
16225 (overlay-put ov 'org-image-overlay t)
16226 (overlay-put ov 'modification-hooks
16227 (list 'org-display-inline-modification-hook))
16228 (push ov org-inline-image-overlays)))))))))
16230 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16231 "Remove inline-display overlay if a corresponding region is modified."
16232 (let ((inhibit-modification-hooks t))
16233 (when (and ov after)
16234 (delete ov org-inline-image-overlays)
16235 (delete-overlay ov))))
16237 (defun org-remove-inline-images ()
16238 "Remove inline display of images."
16239 (interactive)
16240 (mapc 'delete-overlay org-inline-image-overlays)
16241 (setq org-inline-image-overlays nil))
16243 ;;;; Key bindings
16245 ;; Make `C-c C-x' a prefix key
16246 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16248 ;; TAB key with modifiers
16249 (org-defkey org-mode-map "\C-i" 'org-cycle)
16250 (org-defkey org-mode-map [(tab)] 'org-cycle)
16251 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16252 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16254 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16255 ;; The following line is necessary under Suse GNU/Linux
16256 (unless (featurep 'xemacs)
16257 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16258 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16259 (define-key org-mode-map [backtab] 'org-shifttab)
16261 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16262 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16263 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16265 ;; Cursor keys with modifiers
16266 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16267 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16268 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16269 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16271 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16272 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16273 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16274 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16276 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16277 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16278 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16279 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16281 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16282 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16284 ;; Babel keys
16285 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16286 (mapc (lambda (pair)
16287 (define-key org-babel-map (car pair) (cdr pair)))
16288 org-babel-key-bindings)
16290 ;;; Extra keys for tty access.
16291 ;; We only set them when really needed because otherwise the
16292 ;; menus don't show the simple keys
16294 (when (or org-use-extra-keys
16295 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16296 (not window-system))
16297 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16298 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16299 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16300 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16301 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16302 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16303 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16304 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16305 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16306 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16307 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16308 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16309 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16310 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16311 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16312 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16313 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16314 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16315 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16316 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16317 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16318 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16319 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16320 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16321 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16322 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16323 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16324 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16326 ;; All the other keys
16328 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16329 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16330 (if (boundp 'narrow-map)
16331 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16332 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16333 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16334 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16335 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16336 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16337 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16338 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16339 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16340 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16341 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16342 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16343 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16344 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16345 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16346 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16347 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16348 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16350 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16351 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16352 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16353 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16354 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16355 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16356 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16357 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16358 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16359 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16360 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16361 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16362 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16363 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16364 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16365 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16366 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16367 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16368 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16370 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16371 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16372 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16373 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16374 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16375 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16376 (org-defkey org-mode-map "\C-c^" 'org-sort)
16377 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16378 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16379 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16380 (org-defkey org-mode-map "\C-m" 'org-return)
16381 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16382 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16383 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16384 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16385 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16386 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16387 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16388 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16389 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16390 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16391 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16392 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16393 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16394 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16395 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16396 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16397 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16398 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16399 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16400 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16401 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16402 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16404 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16405 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16406 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16407 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16409 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16410 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16411 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16412 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16413 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16414 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16415 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16416 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16417 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16418 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16420 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16421 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16422 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16423 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16424 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16425 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16426 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16428 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16429 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16430 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16431 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16432 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16434 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16436 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16438 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16439 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16441 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16444 (when (featurep 'xemacs)
16445 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16448 (defconst org-speed-commands-default
16449 '(
16450 ("Outline Navigation")
16451 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16452 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16453 ("f" . (org-speed-move-safe 'org-forward-same-level))
16454 ("b" . (org-speed-move-safe 'org-backward-same-level))
16455 ("u" . (org-speed-move-safe 'outline-up-heading))
16456 ("j" . org-goto)
16457 ("g" . (org-refile t))
16458 ("Outline Visibility")
16459 ("c" . org-cycle)
16460 ("C" . org-shifttab)
16461 (" " . org-display-outline-path)
16462 ("Outline Structure Editing")
16463 ("U" . org-shiftmetaup)
16464 ("D" . org-shiftmetadown)
16465 ("r" . org-metaright)
16466 ("l" . org-metaleft)
16467 ("R" . org-shiftmetaright)
16468 ("L" . org-shiftmetaleft)
16469 ("i" . (progn (forward-char 1) (call-interactively
16470 'org-insert-heading-respect-content)))
16471 ("^" . org-sort)
16472 ("w" . org-refile)
16473 ("a" . org-archive-subtree-default-with-confirmation)
16474 ("." . org-mark-subtree)
16475 ("Clock Commands")
16476 ("I" . org-clock-in)
16477 ("O" . org-clock-out)
16478 ("Meta Data Editing")
16479 ("t" . org-todo)
16480 ("0" . (org-priority ?\ ))
16481 ("1" . (org-priority ?A))
16482 ("2" . (org-priority ?B))
16483 ("3" . (org-priority ?C))
16484 (";" . org-set-tags-command)
16485 ("e" . org-set-effort)
16486 ("Agenda Views etc")
16487 ("v" . org-agenda)
16488 ("/" . org-sparse-tree)
16489 ("Misc")
16490 ("o" . org-open-at-point)
16491 ("?" . org-speed-command-help)
16492 ("<" . (org-agenda-set-restriction-lock 'subtree))
16493 (">" . (org-agenda-remove-restriction-lock))
16494 )
16495 "The default speed commands.")
16497 (defun org-print-speed-command (e)
16498 (if (> (length (car e)) 1)
16499 (progn
16501 (princ (car e))
16503 (princ (make-string (length (car e)) ?-))
16505 (princ (car e))
16506 (princ " ")
16507 (if (symbolp (cdr e))
16508 (princ (symbol-name (cdr e)))
16509 (prin1 (cdr e)))
16512 (defun org-speed-command-help ()
16513 "Show the available speed commands."
16514 (interactive)
16515 (if (not org-use-speed-commands)
16516 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16517 (with-output-to-temp-buffer "*Help*"
16519 (mapc 'org-print-speed-command org-speed-commands-user)
16522 (mapc 'org-print-speed-command org-speed-commands-default))
16523 (with-current-buffer "*Help*"
16524 (setq truncate-lines t))))
16526 (defun org-speed-move-safe (cmd)
16527 "Execute CMD, but make sure that the cursor always ends up in a headline.
16528 If not, return to the original position and throw an error."
16529 (interactive)
16530 (let ((pos (point)))
16531 (call-interactively cmd)
16532 (unless (and (bolp) (org-on-heading-p))
16533 (goto-char pos)
16534 (error "Boundary reached while executing %s" cmd))))
16536 (defvar org-self-insert-command-undo-counter 0)
16538 (defvar org-table-auto-blank-field) ; defined in org-table.el
16539 (defvar org-speed-command nil)
16541 (defun org-speed-command-default-hook (keys)
16542 "Hook for activating single-letter speed commands.
16543 `org-speed-commands-default' specifies a minimal command set. Use
16544 `org-speed-commands-user' for further customization."
16545 (when (or (and (bolp) (looking-at outline-regexp))
16546 (and (functionp org-use-speed-commands)
16547 (funcall org-use-speed-commands)))
16548 (cdr (assoc keys (append org-speed-commands-user
16549 org-speed-commands-default)))))
16551 (defun org-babel-speed-command-hook (keys)
16552 "Hook for activating single-letter code block commands."
16553 (when (and (bolp) (looking-at org-babel-src-block-regexp))
16554 (cdr (assoc keys org-babel-key-bindings))))
16556 (defcustom org-speed-command-hook
16557 '(org-speed-command-default-hook org-babel-speed-command-hook)
16558 "Hook for activating speed commands at strategic locations.
16559 Hook functions are called in sequence until a valid handler is
16560 found.
16562 Each hook takes a single argument, a user-pressed command key
16563 which is also a `self-insert-command' from the global map.
16565 Within the hook, examine the cursor position and the command key
16566 and return nil or a valid handler as appropriate. Handler could
16567 be one of an interactive command, a function, or a form.
16569 Set `org-use-speed-commands' to non-nil value to enable this
16570 hook. The default setting is `org-speed-command-default-hook'."
16571 :group 'org-structure
16572 :type 'hook)
16574 (defun org-self-insert-command (N)
16575 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
16576 If the cursor is in a table looking at whitespace, the whitespace is
16577 overwritten, and the table is not marked as requiring realignment."
16578 (interactive "p")
16579 (cond
16580 ((and org-use-speed-commands
16581 (setq org-speed-command
16582 (run-hook-with-args-until-success
16583 'org-speed-command-hook (this-command-keys))))
16584 (cond
16585 ((commandp org-speed-command)
16586 (setq this-command org-speed-command)
16587 (call-interactively org-speed-command))
16588 ((functionp org-speed-command)
16589 (funcall org-speed-command))
16590 ((and org-speed-command (listp org-speed-command))
16591 (eval org-speed-command))
16592 (t (let (org-use-speed-commands)
16593 (call-interactively 'org-self-insert-command)))))
16594 ((and
16595 (org-table-p)
16596 (progn
16597 ;; check if we blank the field, and if that triggers align
16598 (and (featurep 'org-table) org-table-auto-blank-field
16599 (member last-command
16600 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
16602 ;; got extra space, this field does not determine column width
16603 (let (org-table-may-need-update) (org-table-blank-field))
16604 ;; no extra space, this field may determine column width
16605 (org-table-blank-field)))
16606 t)
16607 (eq N 1)
16609 (let (org-table-may-need-update)
16610 (goto-char (1- (match-end 0)))
16611 (delete-backward-char 1)
16612 (goto-char (match-beginning 0))
16613 (self-insert-command N)))
16614 (t
16615 (setq org-table-may-need-update t)
16616 (self-insert-command N)
16617 (org-fix-tags-on-the-fly)
16618 (if org-self-insert-cluster-for-undo
16619 (if (not (eq last-command 'org-self-insert-command))
16620 (setq org-self-insert-command-undo-counter 1)
16621 (if (>= org-self-insert-command-undo-counter 20)
16622 (setq org-self-insert-command-undo-counter 1)
16623 (and (> org-self-insert-command-undo-counter 0)
16624 buffer-undo-list
16625 (not (cadr buffer-undo-list)) ; remove nil entry
16626 (setcdr buffer-undo-list (cddr buffer-undo-list)))
16627 (setq org-self-insert-command-undo-counter
16628 (1+ org-self-insert-command-undo-counter))))))))
16630 (defun org-fix-tags-on-the-fly ()
16631 (when (and (equal (char-after (point-at-bol)) ?*)
16632 (org-on-heading-p))
16633 (org-align-tags-here org-tags-column)))
16635 (defun org-delete-backward-char (N)
16636 "Like `delete-backward-char', insert whitespace at field end in tables.
16637 When deleting backwards, in tables this function will insert whitespace in
16639 still be marked for re-alignment if the field did fill the entire column,
16640 because, in this case the deletion might narrow the column."
16641 (interactive "p")
16642 (if (and (org-table-p)
16643 (eq N 1)
16644 (string-match "|" (buffer-substring (point-at-bol) (point)))
16645 (looking-at ".*?|"))
16646 (let ((pos (point))
16648 (c org-table-may-need-update))
16649 (backward-delete-char N)
16650 (if (not overwrite-mode)
16651 (progn
16652 (skip-chars-forward "^|")
16653 (insert " ")
16654 (goto-char (1- pos))))
16655 ;; noalign: if there were two spaces at the end, this field
16656 ;; does not determine the width of the column.
16657 (if noalign (setq org-table-may-need-update c)))
16658 (backward-delete-char N)
16659 (org-fix-tags-on-the-fly)))
16661 (defun org-delete-char (N)
16662 "Like `delete-char', but insert whitespace at field end in tables.
16663 When deleting characters, in tables this function will insert whitespace in
16665 still be marked for re-alignment if the field did fill the entire column,
16666 because, in this case the deletion might narrow the column."
16667 (interactive "p")
16668 (if (and (org-table-p)
16669 (not (bolp))
16670 (not (= (char-after) ?|))
16671 (eq N 1))
16672 (if (looking-at ".*?|")
16673 (let ((pos (point))
16675 (c org-table-may-need-update))
16676 (replace-match (concat
16677 (substring (match-string 0) 1 -1)
16678 " |"))
16679 (goto-char pos)
16680 ;; noalign: if there were two spaces at the end, this field
16681 ;; does not determine the width of the column.
16682 (if noalign (setq org-table-may-need-update c)))
16683 (delete-char N))
16684 (delete-char N)
16685 (org-fix-tags-on-the-fly)))
16687 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
16688 (put 'org-self-insert-command 'delete-selection t)
16689 (put 'orgtbl-self-insert-command 'delete-selection t)
16690 (put 'org-delete-char 'delete-selection 'supersede)
16691 (put 'org-delete-backward-char 'delete-selection 'supersede)
16692 (put 'org-yank 'delete-selection 'yank)
16694 ;; Make `flyspell-mode' delay after some commands
16695 (put 'org-self-insert-command 'flyspell-delayed t)
16696 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
16697 (put 'org-delete-char 'flyspell-delayed t)
16698 (put 'org-delete-backward-char 'flyspell-delayed t)
16700 ;; Make pabbrev-mode expand after org-mode commands
16701 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
16702 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
16704 ;; How to do this: Measure non-white length of current string
16705 ;; If equal to column width, we should realign.
16707 (defun org-remap (map &rest commands)
16708 "In MAP, remap the functions given in COMMANDS.
16709 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
16710 (let (new old)
16711 (while commands
16712 (setq old (pop commands) new (pop commands))
16713 (if (fboundp 'command-remapping)
16714 (org-defkey map (vector 'remap old) new)
16715 (substitute-key-definition old new map global-map)))))
16717 (when (eq org-enable-table-editor 'optimized)
16718 ;; If the user wants maximum table support, we need to hijack
16719 ;; some standard editing functions
16720 (org-remap org-mode-map
16721 'self-insert-command 'org-self-insert-command
16722 'delete-char 'org-delete-char
16723 'delete-backward-char 'org-delete-backward-char)
16724 (org-defkey org-mode-map "|" 'org-force-self-insert))
16726 (defvar org-ctrl-c-ctrl-c-hook nil
16727 "Hook for functions attaching themselves to `C-c C-c'.
16728 This can be used to add additional functionality to the C-c C-c key which
16729 executes context-dependent commands.
16730 Each function will be called with no arguments. The function must check
16731 if the context is appropriate for it to act. If yes, it should do its
16732 thing and then return a non-nil value. If the context is wrong,
16733 just do nothing and return nil.")
16735 (defvar org-tab-first-hook nil
16736 "Hook for functions to attach themselves to TAB.
16737 See `org-ctrl-c-ctrl-c-hook' for more information.
16738 This hook runs as the first action when TAB is pressed, even before
16739 `org-cycle' messes around with the `outline-regexp' to cater for
16740 inline tasks and plain list item folding.
16741 If any function in this hook returns t, any other actions that
16742 would have been caused by TAB (such as table field motion or visibility
16743 cycling) will not occur.")
16745 (defvar org-tab-after-check-for-table-hook nil
16746 "Hook for functions to attach themselves to TAB.
16747 See `org-ctrl-c-ctrl-c-hook' for more information.
16748 This hook runs after it has been established that the cursor is not in a
16749 table, but before checking if the cursor is in a headline or if global cycling
16750 should be done.
16751 If any function in this hook returns t, not other actions like visibility
16752 cycling will be done.")
16754 (defvar org-tab-after-check-for-cycling-hook nil
16755 "Hook for functions to attach themselves to TAB.
16756 See `org-ctrl-c-ctrl-c-hook' for more information.
16757 This hook runs after it has been established that not table field motion and
16758 not visibility should be done because of current context. This is probably
16759 the place where a package like yasnippets can hook in.")
16761 (defvar org-tab-before-tab-emulation-hook nil
16762 "Hook for functions to attach themselves to TAB.
16763 See `org-ctrl-c-ctrl-c-hook' for more information.
16764 This hook runs after every other options for TAB have been exhausted, but
16767 (defvar org-metaleft-hook nil
16768 "Hook for functions attaching themselves to `M-left'.
16769 See `org-ctrl-c-ctrl-c-hook' for more information.")
16770 (defvar org-metaright-hook nil
16771 "Hook for functions attaching themselves to `M-right'.
16772 See `org-ctrl-c-ctrl-c-hook' for more information.")
16773 (defvar org-metaup-hook nil
16774 "Hook for functions attaching themselves to `M-up'.
16775 See `org-ctrl-c-ctrl-c-hook' for more information.")
16776 (defvar org-metadown-hook nil
16777 "Hook for functions attaching themselves to `M-down'.
16778 See `org-ctrl-c-ctrl-c-hook' for more information.")
16779 (defvar org-shiftmetaleft-hook nil
16780 "Hook for functions attaching themselves to `M-S-left'.
16781 See `org-ctrl-c-ctrl-c-hook' for more information.")
16782 (defvar org-shiftmetaright-hook nil
16783 "Hook for functions attaching themselves to `M-S-right'.
16784 See `org-ctrl-c-ctrl-c-hook' for more information.")
16785 (defvar org-shiftmetaup-hook nil
16786 "Hook for functions attaching themselves to `M-S-up'.
16787 See `org-ctrl-c-ctrl-c-hook' for more information.")
16788 (defvar org-shiftmetadown-hook nil
16789 "Hook for functions attaching themselves to `M-S-down'.
16790 See `org-ctrl-c-ctrl-c-hook' for more information.")
16791 (defvar org-metareturn-hook nil
16792 "Hook for functions attaching themselves to `M-RET'.
16793 See `org-ctrl-c-ctrl-c-hook' for more information.")
16794 (defvar org-shiftup-hook nil
16795 "Hook for functions attaching themselves to `S-up'.
16796 See `org-ctrl-c-ctrl-c-hook' for more information.")
16797 (defvar org-shiftup-final-hook nil
16798 "Hook for functions attaching themselves to `S-up'.
16799 This one runs after all other options except shift-select have been excluded.
16800 See `org-ctrl-c-ctrl-c-hook' for more information.")
16801 (defvar org-shiftdown-hook nil
16802 "Hook for functions attaching themselves to `S-down'.
16803 See `org-ctrl-c-ctrl-c-hook' for more information.")
16804 (defvar org-shiftdown-final-hook nil
16805 "Hook for functions attaching themselves to `S-down'.
16806 This one runs after all other options except shift-select have been excluded.
16807 See `org-ctrl-c-ctrl-c-hook' for more information.")
16808 (defvar org-shiftleft-hook nil
16809 "Hook for functions attaching themselves to `S-left'.
16810 See `org-ctrl-c-ctrl-c-hook' for more information.")
16811 (defvar org-shiftleft-final-hook nil
16812 "Hook for functions attaching themselves to `S-left'.
16813 This one runs after all other options except shift-select have been excluded.
16814 See `org-ctrl-c-ctrl-c-hook' for more information.")
16815 (defvar org-shiftright-hook nil
16816 "Hook for functions attaching themselves to `S-right'.
16817 See `org-ctrl-c-ctrl-c-hook' for more information.")
16818 (defvar org-shiftright-final-hook nil
16819 "Hook for functions attaching themselves to `S-right'.
16820 This one runs after all other options except shift-select have been excluded.
16821 See `org-ctrl-c-ctrl-c-hook' for more information.")
16823 (defun org-modifier-cursor-error ()
16824 "Throw an error, a modified cursor command was applied in wrong context."
16825 (error "This command is active in special context like tables, headlines or items"))
16827 (defun org-shiftselect-error ()
16828 "Throw an error because Shift-Cursor command was applied in wrong context."
16829 (if (and (boundp 'shift-select-mode) shift-select-mode)
16830 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
16831 (error "This command works only in special context like headlines or timestamps")))
16833 (defun org-call-for-shift-select (cmd)
16834 (let ((this-command-keys-shift-translated t))
16835 (call-interactively cmd)))
16837 (defun org-shifttab (&optional arg)
16838 "Global visibility cycling or move to previous table field.
16839 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
16840 on context.
16841 See the individual commands for more information."
16842 (interactive "P")
16843 (cond
16844 ((org-at-table-p) (call-interactively 'org-table-previous-field))
16845 ((integerp arg)
16846 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
16847 (message "Content view to level: %d" arg)
16848 (org-content (prefix-numeric-value arg2))
16849 (setq org-cycle-global-status 'overview)))
16850 (t (call-interactively 'org-global-cycle))))
16852 (defun org-shiftmetaleft ()
16853 "Promote subtree or delete table column.
16854 Calls `org-promote-subtree', `org-outdent-item',
16855 or `org-table-delete-column', depending on context.
16856 See the individual commands for more information."
16857 (interactive)
16858 (cond
16859 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
16860 ((org-at-table-p) (call-interactively 'org-table-delete-column))
16861 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
16862 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
16863 (t (org-modifier-cursor-error))))
16865 (defun org-shiftmetaright ()
16866 "Demote subtree or insert table column.
16867 Calls `org-demote-subtree', `org-indent-item',
16868 or `org-table-insert-column', depending on context.
16869 See the individual commands for more information."
16870 (interactive)
16871 (cond
16872 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
16873 ((org-at-table-p) (call-interactively 'org-table-insert-column))
16874 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
16875 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
16876 (t (org-modifier-cursor-error))))
16878 (defun org-shiftmetaup (&optional arg)
16879 "Move subtree up or kill table row.
16880 Calls `org-move-subtree-up' or `org-table-kill-row' or
16881 `org-move-item-up' depending on context. See the individual commands
16882 for more information."
16883 (interactive "P")
16884 (cond
16885 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
16886 ((org-at-table-p) (call-interactively 'org-table-kill-row))
16887 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16888 ((org-at-item-p) (call-interactively 'org-move-item-up))
16889 (t (org-modifier-cursor-error))))
16891 (defun org-shiftmetadown (&optional arg)
16892 "Move subtree down or insert table row.
16893 Calls `org-move-subtree-down' or `org-table-insert-row' or
16894 `org-move-item-down', depending on context. See the individual
16895 commands for more information."
16896 (interactive "P")
16897 (cond
16898 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
16899 ((org-at-table-p) (call-interactively 'org-table-insert-row))
16900 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16901 ((org-at-item-p) (call-interactively 'org-move-item-down))
16902 (t (org-modifier-cursor-error))))
16904 (defsubst org-hidden-tree-error ()
16905 (error
16906 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
16908 (defun org-metaleft (&optional arg)
16909 "Promote heading or move table column to left.
16910 Calls `org-do-promote' or `org-table-move-column', depending on context.
16911 With no specific context, calls the Emacs default `backward-word'.
16912 See the individual commands for more information."
16913 (interactive "P")
16914 (cond
16915 ((run-hook-with-args-until-success 'org-metaleft-hook))
16916 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
16917 ((or (org-on-heading-p)
16918 (and (org-region-active-p)
16919 (save-excursion
16920 (goto-char (region-beginning))
16921 (org-on-heading-p))))
16922 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16923 (call-interactively 'org-do-promote))
16924 ((or (org-at-item-p)
16925 (and (org-region-active-p)
16926 (save-excursion
16927 (goto-char (region-beginning))
16928 (org-at-item-p))))
16929 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16930 (call-interactively 'org-outdent-item))
16931 (t (call-interactively 'backward-word))))
16933 (defun org-metaright (&optional arg)
16934 "Demote subtree or move table column to right.
16935 Calls `org-do-demote' or `org-table-move-column', depending on context.
16936 With no specific context, calls the Emacs default `forward-word'.
16937 See the individual commands for more information."
16938 (interactive "P")
16939 (cond
16940 ((run-hook-with-args-until-success 'org-metaright-hook))
16941 ((org-at-table-p) (call-interactively 'org-table-move-column))
16942 ((or (org-on-heading-p)
16943 (and (org-region-active-p)
16944 (save-excursion
16945 (goto-char (region-beginning))
16946 (org-on-heading-p))))
16947 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16948 (call-interactively 'org-do-demote))
16949 ((or (org-at-item-p)
16950 (and (org-region-active-p)
16951 (save-excursion
16952 (goto-char (region-beginning))
16953 (org-at-item-p))))
16954 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16955 (call-interactively 'org-indent-item))
16956 (t (call-interactively 'forward-word))))
16958 (defun org-check-for-hidden (what)
16959 "Check if there are hidden headlines/items in the current visual line.
16960 WHAT can be either `headlines' or `items'. If the current line is
16961 an outline or item heading and it has a folded subtree below it,
16962 this function returns t, nil otherwise."
16963 (let ((re (cond
16964 ((eq what 'headlines) (concat "^" org-outline-regexp))
16965 ((eq what 'items) (concat "^" (org-item-re t)))
16966 (t (error "This should not happen"))))
16967 beg end)
16968 (save-excursion
16969 (catch 'exit
16970 (unless (org-region-active-p)
16971 (setq beg (point-at-bol))
16972 (beginning-of-line 2)
16973 (while (and (not (eobp)) ;; this is like `next-line'
16974 (get-char-property (1- (point)) 'invisible))
16975 (beginning-of-line 2))
16976 (setq end (point))
16977 (goto-char beg)
16978 (goto-char (point-at-eol))
16979 (setq end (max end (point)))
16980 (while (re-search-forward re end t)
16981 (if (get-char-property (match-beginning 0) 'invisible)
16982 (throw 'exit t))))
16983 nil))))
16985 (defun org-metaup (&optional arg)
16986 "Move subtree up or move table row up.
16987 Calls `org-move-subtree-up' or `org-table-move-row' or
16988 `org-move-item-up', depending on context. See the individual commands
16989 for more information."
16990 (interactive "P")
16991 (cond
16992 ((run-hook-with-args-until-success 'org-metaup-hook))
16993 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
16994 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16995 ((org-at-item-p) (call-interactively 'org-move-item-up))
16996 (t (transpose-lines 1) (beginning-of-line -1))))
16998 (defun org-metadown (&optional arg)
16999 "Move subtree down or move table row down.
17000 Calls `org-move-subtree-down' or `org-table-move-row' or
17001 `org-move-item-down', depending on context. See the individual
17002 commands for more information."
17003 (interactive "P")
17004 (cond
17005 ((run-hook-with-args-until-success 'org-metadown-hook))
17006 ((org-at-table-p) (call-interactively 'org-table-move-row))
17007 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17008 ((org-at-item-p) (call-interactively 'org-move-item-down))
17009 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17011 (defun org-shiftup (&optional arg)
17012 "Increase item in timestamp or increase priority of current headline.
17013 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17014 depending on context. See the individual commands for more information."
17015 (interactive "P")
17016 (cond
17017 ((run-hook-with-args-until-success 'org-shiftup-hook))
17018 ((and org-support-shift-select (org-region-active-p))
17019 (org-call-for-shift-select 'previous-line))
17020 ((org-at-timestamp-p t)
17021 (call-interactively (if org-edit-timestamp-down-means-later
17022 'org-timestamp-down 'org-timestamp-up)))
17023 ((and (not (eq org-support-shift-select 'always))
17024 org-enable-priority-commands
17025 (org-on-heading-p))
17026 (call-interactively 'org-priority-up))
17027 ((and (not org-support-shift-select) (org-at-item-p))
17028 (call-interactively 'org-previous-item))
17029 ((org-clocktable-try-shift 'up arg))
17030 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17031 (org-support-shift-select
17032 (org-call-for-shift-select 'previous-line))
17033 (t (org-shiftselect-error))))
17035 (defun org-shiftdown (&optional arg)
17036 "Decrease item in timestamp or decrease priority of current headline.
17037 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17038 depending on context. See the individual commands for more information."
17039 (interactive "P")
17040 (cond
17041 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17042 ((and org-support-shift-select (org-region-active-p))
17043 (org-call-for-shift-select 'next-line))
17044 ((org-at-timestamp-p t)
17045 (call-interactively (if org-edit-timestamp-down-means-later
17046 'org-timestamp-up 'org-timestamp-down)))
17047 ((and (not (eq org-support-shift-select 'always))
17048 org-enable-priority-commands
17049 (org-on-heading-p))
17050 (call-interactively 'org-priority-down))
17051 ((and (not org-support-shift-select) (org-at-item-p))
17052 (call-interactively 'org-next-item))
17053 ((org-clocktable-try-shift 'down arg))
17054 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17055 (org-support-shift-select
17056 (org-call-for-shift-select 'next-line))
17057 (t (org-shiftselect-error))))
17059 (defun org-shiftright (&optional arg)
17060 "Cycle the thing at point or in the current line, depending on context.
17061 Depending on context, this does one of the following:
17063 - switch a timestamp at point one day into the future
17064 - on a headline, switch to the next TODO keyword.
17065 - on an item, switch entire list to the next bullet type
17066 - on a property line, switch to the next allowed value
17067 - on a clocktable definition line, move time block into the future"
17068 (interactive "P")
17069 (cond
17070 ((run-hook-with-args-until-success 'org-shiftright-hook))
17071 ((and org-support-shift-select (org-region-active-p))
17072 (org-call-for-shift-select 'forward-char))
17073 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17074 ((and (not (eq org-support-shift-select 'always))
17075 (org-on-heading-p))
17076 (let ((org-inhibit-logging
17077 (not org-treat-S-cursor-todo-selection-as-state-change))
17078 (org-inhibit-blocking
17079 (not org-treat-S-cursor-todo-selection-as-state-change)))
17080 (org-call-with-arg 'org-todo 'right)))
17081 ((or (and org-support-shift-select
17082 (not (eq org-support-shift-select 'always))
17083 (org-at-item-bullet-p))
17084 (and (not org-support-shift-select) (org-at-item-p)))
17085 (org-call-with-arg 'org-cycle-list-bullet nil))
17086 ((and (not (eq org-support-shift-select 'always))
17087 (org-at-property-p))
17088 (call-interactively 'org-property-next-allowed-value))
17089 ((org-clocktable-try-shift 'right arg))
17090 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17091 (org-support-shift-select
17092 (org-call-for-shift-select 'forward-char))
17093 (t (org-shiftselect-error))))
17095 (defun org-shiftleft (&optional arg)
17096 "Cycle the thing at point or in the current line, depending on context.
17097 Depending on context, this does one of the following:
17099 - switch a timestamp at point one day into the past
17100 - on a headline, switch to the previous TODO keyword.
17101 - on an item, switch entire list to the previous bullet type
17102 - on a property line, switch to the previous allowed value
17103 - on a clocktable definition line, move time block into the past"
17104 (interactive "P")
17105 (cond
17106 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17107 ((and org-support-shift-select (org-region-active-p))
17108 (org-call-for-shift-select 'backward-char))
17109 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17110 ((and (not (eq org-support-shift-select 'always))
17111 (org-on-heading-p))
17112 (let ((org-inhibit-logging
17113 (not org-treat-S-cursor-todo-selection-as-state-change))
17114 (org-inhibit-blocking
17115 (not org-treat-S-cursor-todo-selection-as-state-change)))
17116 (org-call-with-arg 'org-todo 'left)))
17117 ((or (and org-support-shift-select
17118 (not (eq org-support-shift-select 'always))
17119 (org-at-item-bullet-p))
17120 (and (not org-support-shift-select) (org-at-item-p)))
17121 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17122 ((and (not (eq org-support-shift-select 'always))
17123 (org-at-property-p))
17124 (call-interactively 'org-property-previous-allowed-value))
17125 ((org-clocktable-try-shift 'left arg))
17126 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17127 (org-support-shift-select
17128 (org-call-for-shift-select 'backward-char))
17129 (t (org-shiftselect-error))))
17131 (defun org-shiftcontrolright ()
17132 "Switch to next TODO set."
17133 (interactive)
17134 (cond
17135 ((and org-support-shift-select (org-region-active-p))
17136 (org-call-for-shift-select 'forward-word))
17137 ((and (not (eq org-support-shift-select 'always))
17138 (org-on-heading-p))
17139 (org-call-with-arg 'org-todo 'nextset))
17140 (org-support-shift-select
17141 (org-call-for-shift-select 'forward-word))
17142 (t (org-shiftselect-error))))
17144 (defun org-shiftcontrolleft ()
17145 "Switch to previous TODO set."
17146 (interactive)
17147 (cond
17148 ((and org-support-shift-select (org-region-active-p))
17149 (org-call-for-shift-select 'backward-word))
17150 ((and (not (eq org-support-shift-select 'always))
17151 (org-on-heading-p))
17152 (org-call-with-arg 'org-todo 'previousset))
17153 (org-support-shift-select
17154 (org-call-for-shift-select 'backward-word))
17155 (t (org-shiftselect-error))))
17157 (defun org-ctrl-c-ret ()
17158 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17159 (interactive)
17160 (cond
17161 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17162 (t (call-interactively 'org-insert-heading))))
17164 (defun org-copy-special ()
17165 "Copy region in table or copy current subtree.
17166 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17167 See the individual commands for more information."
17168 (interactive)
17169 (call-interactively
17170 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17172 (defun org-cut-special ()
17173 "Cut region in table or cut current subtree.
17174 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17175 See the individual commands for more information."
17176 (interactive)
17177 (call-interactively
17178 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17180 (defun org-paste-special (arg)
17181 "Paste rectangular region into table, or past subtree relative to level.
17182 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17183 See the individual commands for more information."
17184 (interactive "P")
17185 (if (org-at-table-p)
17186 (org-table-paste-rectangle)
17187 (org-paste-subtree arg)))
17189 (defun org-edit-special (&optional arg)
17190 "Call a special editor for the stuff at point.
17191 When at a table, call the formula editor with `org-table-edit-formulas'.
17192 When at the first line of an src example, call `org-edit-src-code'.
17193 When in an #+include line, visit the include file. Otherwise call
17194 `ffap' to visit the file at point."
17195 (interactive)
17196 ;; possibly prep session before editing source
17197 (when arg
17198 (let* ((info (org-babel-get-src-block-info))
17199 (lang (nth 0 info))
17200 (params (nth 2 info))
17201 (session (cdr (assoc :session params))))
17202 (when (and info session) ;; we are in a source-code block with a session
17203 (funcall
17204 (intern (concat "org-babel-prep-session:" lang)) session params))))
17205 (cond ;; proceed with `org-edit-special'
17206 ((save-excursion
17207 (beginning-of-line 1)
17208 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17209 (find-file (org-trim (match-string 1))))
17210 ((org-edit-src-code))
17211 ((org-edit-fixed-width-region))
17212 ((org-at-table.el-p)
17213 (org-edit-src-code))
17214 ((or (org-at-table-p)
17215 (save-excursion
17216 (beginning-of-line 1)
17218 (call-interactively 'org-table-edit-formulas))
17219 (t (call-interactively 'ffap))))
17221 (defun org-ctrl-c-ctrl-c (&optional arg)
17222 "Set tags in headline, or update according to changed information at point.
17224 This command does many different things, depending on context:
17226 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17227 this is what we do.
17229 - If the cursor is on a statistics cookie, update it.
17231 - If the cursor is in a headline, prompt for tags and insert them
17232 into the current line, aligned to `org-tags-column'. When called
17233 with prefix arg, realign all tags in the current buffer.
17235 - If the cursor is in one of the special #+KEYWORD lines, this
17236 triggers scanning the buffer for these lines and updating the
17237 information.
17239 - If the cursor is inside a table, realign the table. This command
17240 works even if the automatic table editor has been turned off.
17242 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17243 the entire table.
17245 - If the cursor is at a footnote reference or definition, jump to
17246 the corresponding definition or references, respectively.
17248 - If the cursor is a the beginning of a dynamic block, update it.
17250 - If the current buffer is a capture buffer, close note and file it.
17252 - If the cursor is on a <<<target>>>, update radio targets and
17253 corresponding links in this buffer.
17255 - If the cursor is on a numbered item in a plain list, renumber the
17256 ordered list.
17258 - If the cursor is on a checkbox, toggle it.
17260 - If the cursor is on a code block, evaluate it. The variable
17261 `org-confirm-babel-evaluate' can be used to control prompting
17262 before code block evaluation, by default every code block
17263 evaluation requires confirmation. Code block evaluation can be
17264 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17265 (interactive "P")
17266 (let ((org-enable-table-editor t))
17267 (cond
17268 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17269 org-occur-highlights
17270 org-latex-fragment-image-overlays)
17271 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17272 (org-remove-occur-highlights)
17273 (org-remove-latex-fragment-image-overlays)
17274 (message "Temporary highlights/overlays removed from current buffer"))
17275 ((and (local-variable-p 'org-finish-function (current-buffer))
17276 (fboundp org-finish-function))
17277 (funcall org-finish-function))
17278 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17279 ((or (looking-at org-property-start-re)
17280 (org-at-property-p))
17281 (call-interactively 'org-property-action))
17282 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17284 (or (org-on-heading-p) (org-at-item-p)))
17285 (call-interactively 'org-update-statistics-cookies))
17286 ((org-on-heading-p) (call-interactively 'org-set-tags))
17287 ((org-at-table.el-p)
17288 (message "Use C-c ' to edit table.el tables"))
17289 ((org-at-table-p)
17290 (org-table-maybe-eval-formula)
17291 (if arg
17292 (call-interactively 'org-table-recalculate)
17293 (org-table-maybe-recalculate-line))
17294 (call-interactively 'org-table-align)
17295 (orgtbl-send-table 'maybe))
17296 ((or (org-footnote-at-reference-p)
17297 (org-footnote-at-definition-p))
17298 (call-interactively 'org-footnote-action))
17299 ((org-at-item-checkbox-p)
17300 (call-interactively 'org-list-repair)
17301 (call-interactively 'org-toggle-checkbox)
17302 (org-list-send-list 'maybe))
17303 ((org-at-item-p)
17304 (call-interactively 'org-list-repair)
17305 (when arg (call-interactively 'org-toggle-checkbox))
17306 (org-list-send-list 'maybe))
17307 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17308 ;; Dynamic block
17309 (beginning-of-line 1)
17310 (save-excursion (org-update-dblock)))
17311 ((save-excursion
17312 (beginning-of-line 1)
17314 (cond
17315 ((equal (match-string 1) "TBLFM")
17316 ;; Recalculate the table before this line
17317 (save-excursion
17318 (beginning-of-line 1)
17320 (if (org-at-table-p)
17321 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17322 (t
17323 (let ((org-inhibit-startup-visibility-stuff t)
17324 (org-startup-align-all-tables nil))
17325 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17326 (message "Local setup has been refreshed"))))
17327 ((org-clock-update-time-maybe))
17328 (t (error "C-c C-c can do nothing useful at this location")))))
17330 (defun org-mode-restart ()
17331 "Restart Org-mode, to scan again for special lines.
17332 Also updates the keyword regular expressions."
17333 (interactive)
17334 (org-mode)
17335 (message "Org-mode restarted"))
17337 (defun org-kill-note-or-show-branches ()
17338 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17339 (interactive)
17340 (if (not org-finish-function)
17341 (progn
17342 (hide-subtree)
17343 (call-interactively 'show-branches))
17344 (let ((org-note-abort t))
17345 (funcall org-finish-function))))
17347 (defun org-return (&optional indent)
17348 "Goto next table row or insert a newline.
17349 Calls `org-table-next-row' or `newline', depending on context.
17350 See the individual commands for more information."
17351 (interactive)
17352 (cond
17353 ((bobp) (if indent (newline-and-indent) (newline)))
17354 ((org-at-table-p)
17355 (org-table-justify-field-maybe)
17356 (call-interactively 'org-table-next-row))
17357 ((and org-return-follows-link
17358 (eq (get-text-property (point) 'face) 'org-link))
17359 (call-interactively 'org-open-at-point))
17360 ((and (org-at-heading-p)
17361 (looking-at
17363 (org-show-entry)
17364 (end-of-line 1)
17365 (newline))
17366 (t (if indent (newline-and-indent) (newline)))))
17368 (defun org-return-indent ()
17369 "Goto next table row or insert a newline and indent.
17370 Calls `org-table-next-row' or `newline-and-indent', depending on
17371 context. See the individual commands for more information."
17372 (interactive)
17373 (org-return t))
17375 (defun org-ctrl-c-star ()
17376 "Compute table, or change heading status of lines.
17377 Calls `org-table-recalculate' or `org-toggle-heading',
17378 depending on context."
17379 (interactive)
17380 (cond
17381 ((org-at-table-p)
17382 (call-interactively 'org-table-recalculate))
17383 (t
17384 ;; Convert all lines in region to list items
17385 (call-interactively 'org-toggle-heading))))
17387 (defun org-ctrl-c-minus ()
17388 "Insert separator line in table or modify bullet status of line.
17389 Also turns a plain line or a region of lines into list items.
17390 Calls `org-table-insert-hline', `org-toggle-item', or
17391 `org-cycle-list-bullet', depending on context."
17392 (interactive)
17393 (cond
17394 ((org-at-table-p)
17395 (call-interactively 'org-table-insert-hline))
17396 ((org-region-active-p)
17397 (call-interactively 'org-toggle-item))
17398 ((org-in-item-p)
17399 (call-interactively 'org-cycle-list-bullet))
17400 (t
17401 (call-interactively 'org-toggle-item))))
17403 (defun org-toggle-item ()
17404 "Convert headings or normal lines to items, items to normal lines.
17405 If there is no active region, only the current line is considered.
17407 If the first line in the region is a headline, convert all headlines to items.
17409 If the first line in the region is an item, convert all items to normal lines.
17411 If the first line is normal text, add an item bullet to each line."
17412 (interactive)
17413 (let (l2 l beg end)
17414 (if (org-region-active-p)
17415 (setq beg (region-beginning) end (region-end))
17416 (setq beg (point-at-bol)
17417 end (min (1+ (point-at-eol)) (point-max))))
17418 (save-excursion
17419 (goto-char end)
17420 (setq l2 (org-current-line))
17421 (goto-char beg)
17422 (beginning-of-line 1)
17423 (setq l (1- (org-current-line)))
17424 (if (org-at-item-p)
17425 ;; We already have items, de-itemize
17426 (while (< (setq l (1+ l)) l2)
17427 (when (org-at-item-p)
17429 (delete-region (point) (match-end 0)))
17430 (beginning-of-line 2))
17431 (if (org-on-heading-p)
17432 ;; Headings, convert to items
17433 (while (< (setq l (1+ l)) l2)
17434 (if (looking-at org-outline-regexp)
17435 (replace-match (org-list-bullet-string "-") t t))
17436 (beginning-of-line 2))
17437 ;; normal lines, turn them into items
17438 (while (< (setq l (1+ l)) l2)
17439 (unless (org-at-item-p)
17441 (replace-match
17443 (beginning-of-line 2)))))))
17445 (defun org-toggle-heading (&optional nstars)
17446 "Convert headings to normal text, or items or text to headings.
17447 If there is no active region, only the current line is considered.
17449 If the first line is a heading, remove the stars from all headlines
17450 in the region.
17452 If the first line is a plain list item, turn all plain list items
17453 into headings.
17455 If the first line is a normal line, turn each and every line in the
17456 region into a heading.
17458 When converting a line into a heading, the number of stars is chosen
17459 such that the lines become children of the current entry. However,
17460 when a prefix argument is given, its value determines the number of
17461 stars to add."
17462 (interactive "P")
17463 (let (l2 l itemp beg end)
17464 (if (org-region-active-p)
17465 (setq beg (region-beginning) end (region-end))
17466 (setq beg (point-at-bol)
17467 end (min (1+ (point-at-eol)) (point-max))))
17468 (save-excursion
17469 (goto-char end)
17470 (setq l2 (org-current-line))
17471 (goto-char beg)
17472 (beginning-of-line 1)
17473 (setq l (1- (org-current-line)))
17474 (if (org-on-heading-p)
17475 ;; We already have headlines, de-star them
17476 (while (< (setq l (1+ l)) l2)
17477 (when (org-on-heading-p t)
17478 (and (looking-at outline-regexp) (replace-match "")))
17479 (beginning-of-line 2))
17480 (setq itemp (org-at-item-p))
17481 (let* ((stars
17482 (if nstars
17483 (make-string (prefix-numeric-value current-prefix-arg)
17484 ?*)
17485 (save-excursion
17486 (if (re-search-backward org-complex-heading-regexp nil t)
17487 (match-string 1) ""))))
17488 (add-stars (cond (nstars "")
17489 ((equal stars "") "*")
17490 (org-odd-levels-only "**")
17491 (t "*")))
17492 (rpl (concat stars add-stars " ")))
17493 (while (< (setq l (1+ l)) l2)
17494 (if itemp
17495 (and (org-at-item-p) (replace-match rpl t t))
17496 (unless (org-on-heading-p)
17498 (replace-match (concat rpl (match-string 2))))))
17499 (beginning-of-line 2)))))))
17501 (defun org-meta-return (&optional arg)
17502 "Insert a new heading or wrap a region in a table.
17503 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17504 See the individual commands for more information."
17505 (interactive "P")
17506 (cond
17507 ((run-hook-with-args-until-success 'org-metareturn-hook))
17508 ((org-at-table-p)
17509 (call-interactively 'org-table-wrap-region))
17510 (t (call-interactively 'org-insert-heading))))
17512 ;;; Menu entries
17514 ;; Define the Org-mode menus
17515 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
17516 '("Tbl"
17517 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
17518 ["Next Field" org-cycle (org-at-table-p)]
17519 ["Previous Field" org-shifttab (org-at-table-p)]
17520 ["Next Row" org-return (org-at-table-p)]
17521 "--"
17522 ["Blank Field" org-table-blank-field (org-at-table-p)]
17523 ["Edit Field" org-table-edit-field (org-at-table-p)]
17524 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
17525 "--"
17526 ("Column"
17527 ["Move Column Left" org-metaleft (org-at-table-p)]
17528 ["Move Column Right" org-metaright (org-at-table-p)]
17529 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
17530 ["Insert Column" org-shiftmetaright (org-at-table-p)])
17531 ("Row"
17532 ["Move Row Up" org-metaup (org-at-table-p)]
17533 ["Move Row Down" org-metadown (org-at-table-p)]
17534 ["Delete Row" org-shiftmetaup (org-at-table-p)]
17535 ["Insert Row" org-shiftmetadown (org-at-table-p)]
17536 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
17537 "--"
17538 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
17539 ("Rectangle"
17540 ["Copy Rectangle" org-copy-special (org-at-table-p)]
17541 ["Cut Rectangle" org-cut-special (org-at-table-p)]
17542 ["Paste Rectangle" org-paste-special (org-at-table-p)]
17543 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
17544 "--"
17545 ("Calculate"
17546 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
17547 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17548 ["Edit Formulas" org-edit-special (org-at-table-p)]
17549 "--"
17550 ["Recalculate line" org-table-recalculate (org-at-table-p)]
17551 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17552 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
17553 "--"
17554 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
17555 "--"
17556 ["Sum Column/Rectangle" org-table-sum
17557 (or (org-at-table-p) (org-region-active-p))]
17558 ["Which Column?" org-table-current-column (org-at-table-p)])
17559 ["Debug Formulas"
17560 org-table-toggle-formula-debugger
17561 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
17562 ["Show Col/Row Numbers"
17563 org-table-toggle-coordinate-overlays
17564 :style toggle
17565 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
17566 "--"
17567 ["Create" org-table-create (and (not (org-at-table-p))
17568 org-enable-table-editor)]
17569 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
17570 ["Import from File" org-table-import (not (org-at-table-p))]
17571 ["Export to File" org-table-export (org-at-table-p)]
17572 "--"
17573 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
17575 (easy-menu-define org-org-menu org-mode-map "Org menu"
17576 '("Org"
17577 ("Show/Hide"
17578 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
17579 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
17580 ["Sparse Tree..." org-sparse-tree t]
17581 ["Reveal Context" org-reveal t]
17582 ["Show All" show-all t]
17583 "--"
17584 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
17585 "--"
17586 ["New Heading" org-insert-heading t]
17587 ("Navigate Headings"
17588 ["Up" outline-up-heading t]
17589 ["Next" outline-next-visible-heading t]
17590 ["Previous" outline-previous-visible-heading t]
17591 ["Next Same Level" outline-forward-same-level t]
17592 ["Previous Same Level" outline-backward-same-level t]
17593 "--"
17594 ["Jump" org-goto t])
17595 ("Edit Structure"
17596 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
17597 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
17598 "--"
17599 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
17600 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
17601 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
17602 "--"
17603 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
17604 "--"
17605 ["Promote Heading" org-metaleft (not (org-at-table-p))]
17606 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
17607 ["Demote Heading" org-metaright (not (org-at-table-p))]
17608 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
17609 "--"
17610 ["Sort Region/Children" org-sort (not (org-at-table-p))]
17611 "--"
17612 ["Convert to odd levels" org-convert-to-odd-levels t]
17613 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
17614 ("Editing"
17615 ["Emphasis..." org-emphasize t]
17616 ["Edit Source Example" org-edit-special t]
17617 "--"
17618 ["Footnote new/jump" org-footnote-action t]
17619 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
17620 ("Archive"
17621 ["Archive (default method)" org-archive-subtree-default t]
17622 "--"
17623 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
17624 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
17625 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
17626 )
17627 "--"
17628 ("Hyperlinks"
17629 ["Store Link (Global)" org-store-link t]
17630 ["Find existing link to here" org-occur-link-in-agenda-files t]
17631 ["Insert Link" org-insert-link t]
17632 ["Follow Link" org-open-at-point t]
17633 "--"
17634 ["Next link" org-next-link t]
17635 ["Previous link" org-previous-link t]
17636 "--"
17637 ["Descriptive Links"
17638 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
17639 :style radio
17640 :selected (member '(org-link) buffer-invisibility-spec)]
17641 ["Literal Links"
17642 (progn
17643 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
17644 :style radio
17645 :selected (not (member '(org-link) buffer-invisibility-spec))])
17646 "--"
17647 ("TODO Lists"
17648 ["TODO/DONE/-" org-todo t]
17649 ("Select keyword"
17650 ["Next keyword" org-shiftright (org-on-heading-p)]
17651 ["Previous keyword" org-shiftleft (org-on-heading-p)]
17652 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
17653 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
17654 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
17655 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
17656 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
17657 "--"
17658 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
17659 :selected org-enforce-todo-dependencies :style toggle :active t]
17660 "Settings for tree at point"
17661 ["Do Children sequentially" org-toggle-ordered-property :style radio
17662 :selected (ignore-errors (org-entry-get nil "ORDERED"))
17663 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17664 ["Do Children parallel" org-toggle-ordered-property :style radio
17665 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
17666 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17667 "--"
17668 ["Set Priority" org-priority t]
17669 ["Priority Up" org-shiftup t]
17670 ["Priority Down" org-shiftdown t]
17671 "--"
17672 ["Get news from all feeds" org-feed-update-all t]
17673 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
17674 ["Customize feeds" (customize-variable 'org-feed-alist) t])
17675 ("TAGS and Properties"
17676 ["Set Tags" org-set-tags-command t]
17677 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
17678 "--"
17679 ["Set property" org-set-property t]
17680 ["Column view of properties" org-columns t]
17681 ["Insert Column View DBlock" org-insert-columns-dblock t])
17682 ("Dates and Scheduling"
17683 ["Timestamp" org-time-stamp t]
17684 ["Timestamp (inactive)" org-time-stamp-inactive t]
17685 ("Change Date"
17686 ["1 Day Later" org-shiftright t]
17687 ["1 Day Earlier" org-shiftleft t]
17688 ["1 ... Later" org-shiftup t]
17689 ["1 ... Earlier" org-shiftdown t])
17690 ["Compute Time Range" org-evaluate-time-range t]
17691 ["Schedule Item" org-schedule t]
17692 ["Deadline" org-deadline t]
17693 "--"
17694 ["Custom time format" org-toggle-time-stamp-overlays
17695 :style radio :selected org-display-custom-times]
17696 "--"
17697 ["Goto Calendar" org-goto-calendar t]
17698 ["Date from Calendar" org-date-from-calendar t]
17699 "--"
17700 ["Start/Restart Timer" org-timer-start t]
17701 ["Pause/Continue Timer" org-timer-pause-or-continue t]
17702 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
17703 ["Insert Timer String" org-timer t]
17704 ["Insert Timer Item" org-timer-item t])
17705 ("Logging work"
17706 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
17707 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
17708 ["Clock out" org-clock-out t]
17709 ["Clock cancel" org-clock-cancel t]
17710 "--"
17711 ["Mark as default task" org-clock-mark-default-task t]
17712 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
17713 ["Goto running clock" org-clock-goto t]
17714 "--"
17715 ["Display times" org-clock-display t]
17716 ["Create clock table" org-clock-report t]
17717 "--"
17718 ["Record DONE time"
17719 (progn (setq org-log-done (not org-log-done))
17720 (message "Switching to %s will %s record a timestamp"
17721 (car org-done-keywords)
17722 (if org-log-done "automatically" "not")))
17723 :style toggle :selected org-log-done])
17724 "--"
17725 ["Agenda Command..." org-agenda t]
17726 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
17727 ("File List for Agenda")
17728 ("Special views current file"
17729 ["TODO Tree" org-show-todo-tree t]
17730 ["Check Deadlines" org-check-deadlines t]
17731 ["Timeline" org-timeline t]
17732 ["Tags/Property tree" org-match-sparse-tree t])
17733 "--"
17734 ["Export/Publish..." org-export t]
17735 ("LaTeX"
17736 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
17737 :selected org-cdlatex-mode]
17738 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
17739 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
17740 ["Modify math symbol" org-cdlatex-math-modify
17741 (org-inside-LaTeX-fragment-p)]
17742 ["Insert citation" org-reftex-citation t]
17743 "--"
17744 ["Template for BEAMER" org-insert-beamer-options-template t])
17745 "--"
17746 ("MobileOrg"
17747 ["Push Files and Views" org-mobile-push t]
17748 ["Get Captured and Flagged" org-mobile-pull t]
17749 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
17750 "--"
17751 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
17752 "--"
17753 ("Documentation"
17754 ["Show Version" org-version t]
17755 ["Info Documentation" org-info t])
17756 ("Customize"
17757 ["Browse Org Group" org-customize t]
17758 "--"
17759 ["Expand This Menu" org-create-customize-menu
17760 (fboundp 'customize-menu-create)])
17761 ["Send bug report" org-submit-bug-report t]
17762 "--"
17763 ("Refresh/Reload"
17764 ["Refresh setup current buffer" org-mode-restart t]
17765 ["Reload Org (after update)" org-reload t]
17766 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
17767 ))
17769 (defun org-info (&optional node)
17770 "Read documentation for Org-mode in the info system.
17771 With optional NODE, go directly to that node."
17772 (interactive)
17773 (info (format "(org)%s" (or node ""))))
17775 ;;;###autoload
17776 (defun org-submit-bug-report ()
17777 "Submit a bug report on Org-mode via mail.
17779 Don't hesitate to report any problems or inaccurate documentation.
17781 If you don't have setup sending mail from (X)Emacs, please copy the
17782 output buffer into your mail program, as it gives us important
17783 information about your Org-mode version and configuration."
17784 (interactive)
17785 (require 'reporter)
17786 (org-load-modules-maybe)
17787 (org-require-autoloaded-modules)
17788 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
17789 (reporter-submit-bug-report
17790 "emacs-orgmode@gnu.org"
17791 (org-version)
17792 (let (list)
17793 (save-window-excursion
17794 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
17795 (delete-other-windows)
17796 (erase-buffer)
17797 (insert "You are about to submit a bug report to the Org-mode mailing list.
17799 We would like to add your full Org-mode and Outline configuration to the
17800 bug report. This greatly simplifies the work of the maintainer and
17801 other experts on the mailing list.
17803 HOWEVER, some variables you have customized may contain private
17804 information. The names of customers, colleagues, or friends, might
17805 appear in the form of file names, tags, todo states, or search strings.
17806 If you answer yes to the prompt, you might want to check and remove
17807 such private information before sending the email.")
17808 (add-text-properties (point-min) (point-max) '(face org-warning))
17809 (when (yes-or-no-p "Include your Org-mode configuration ")
17810 (mapatoms
17811 (lambda (v)
17812 (and (boundp v)
17814 (or (and (symbol-value v)
17816 (and
17817 (get v 'custom-type) (get v 'standard-value)
17818 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
17819 (push v list)))))
17820 (kill-buffer (get-buffer "*Warn about privacy*"))
17821 list))
17822 nil nil
17823 "Remember to cover the basics, that is, what you expected to happen and
17824 what in fact did happen. You don't know how to make a good report? See
17826 http://orgmode.org/manual/Feedback.html#Feedback
17828 Your bug report will be posted to the Org-mode mailing list.
17829 ------------------------------------------------------------------------")
17830 (save-excursion
17835 (defun org-install-agenda-files-menu ()
17836 (let ((bl (buffer-list)))
17837 (save-excursion
17838 (while bl
17839 (set-buffer (pop bl))
17840 (if (org-mode-p) (setq bl nil)))
17841 (when (org-mode-p)
17842 (easy-menu-change
17843 '("Org") "File List for Agenda"
17844 (append
17845 (list
17846 ["Edit File List" (org-edit-agenda-file-list) t]
17847 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
17848 ["Remove Current File from List" org-remove-file t]
17849 ["Cycle through agenda files" org-cycle-agenda-files t]
17850 ["Occur in all agenda files" org-occur-in-agenda-files t]
17851 "--")
17852 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
17854 ;;;; Documentation
17856 ;;;###autoload
17857 (defun org-require-autoloaded-modules ()
17858 (interactive)
17859 (mapc 'require
17860 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
17861 org-docbook org-exp org-html org-icalendar
17862 org-id org-latex
17863 org-publish org-remember org-table
17864 org-timer org-xoxo)))
17866 ;;;###autoload
17867 (defun org-reload (&optional uncompiled)
17868 "Reload all org lisp files.
17869 With prefix arg UNCOMPILED, load the uncompiled versions."
17870 (interactive "P")
17871 (require 'find-func)
17873 (dir-org (file-name-directory (org-find-library-name "org")))
17874 (dir-org-contrib (ignore-errors
17875 (file-name-directory
17876 (org-find-library-name "org-contribdir"))))
17877 (babel-files
17878 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
17879 (append (list nil "comint" "eval" "exp" "keys"
17880 "lob" "ref" "table" "tangle")
17881 (delq nil
17882 (mapcar
17883 (lambda (lang)
17884 (when (cdr lang) (symbol-name (car lang))))
17885 org-babel-load-languages)))))
17886 (files
17887 (append (directory-files dir-org t file-re)
17888 babel-files
17889 (and dir-org-contrib
17890 (directory-files dir-org-contrib t file-re))))
17891 (remove-re (concat (if (featurep 'xemacs)
17892 "org-colview" "org-colview-xemacs")
17894 (setq files (mapcar 'file-name-sans-extension files))
17895 (setq files (mapcar
17896 (lambda (x) (if (string-match remove-re x) nil x))
17897 files))
17898 (setq files (delq nil files))
17899 (mapc
17900 (lambda (f)
17901 (when (featurep (intern (file-name-nondirectory f)))
17902 (if (and (not uncompiled)
17903 (file-exists-p (concat f ".elc")))
17904 (load (concat f ".elc") nil nil t)
17905 (load (concat f ".el") nil nil t))))
17906 files))
17907 (org-version))
17909 ;;;###autoload
17910 (defun org-customize ()
17911 "Call the customize function with org as argument."
17912 (interactive)
17913 (org-load-modules-maybe)
17914 (org-require-autoloaded-modules)
17915 (customize-browse 'org))
17917 (defun org-create-customize-menu ()
17918 "Create a full customization menu for Org-mode, insert it into the menu."
17919 (interactive)
17920 (org-load-modules-maybe)
17921 (org-require-autoloaded-modules)
17922 (if (fboundp 'customize-menu-create)
17923 (progn
17924 (easy-menu-change
17925 '("Org") "Customize"
17926 `(["Browse Org group" org-customize t]
17927 "--"
17928 ,(customize-menu-create 'org)
17929 ["Set" Custom-set t]
17930 ["Save" Custom-save t]
17931 ["Reset to Current" Custom-reset-current t]
17932 ["Reset to Saved" Custom-reset-saved t]
17933 ["Reset to Standard Settings" Custom-reset-standard t]))
17935 (error "Cannot expand menu (outdated version of cus-edit.el)")))
17937 ;;;; Miscellaneous stuff
17939 ;;; Generally useful functions
17941 (defun org-get-at-bol (property)
17942 "Get text property PROPERTY at beginning of line."
17943 (get-text-property (point-at-bol) property))
17945 (defun org-find-text-property-in-string (prop s)
17946 "Return the first non-nil value of property PROP in string S."
17947 (or (get-text-property 0 prop s)
17948 (get-text-property (or (next-single-property-change 0 prop s) 0)
17949 prop s)))
17951 (defun org-display-warning (message) ;; Copied from Emacs-Muse
17952 "Display the given MESSAGE as a warning."
17953 (if (fboundp 'display-warning)
17954 (display-warning 'org message
17955 (if (featurep 'xemacs) 'warning :warning))
17956 (let ((buf (get-buffer-create "*Org warnings*")))
17957 (with-current-buffer buf
17958 (goto-char (point-max))
17959 (insert "Warning (Org): " message)
17960 (unless (bolp)
17961 (newline)))
17962 (display-buffer buf)
17963 (sit-for 0))))
17965 (defun org-in-commented-line ()
17966 "Is point in a line starting with `#'?"
17967 (equal (char-after (point-at-bol)) ?#))
17969 (defun org-in-indented-comment-line ()
17970 "Is point in a line starting with `#' after some white space?"
17971 (save-excursion
17972 (save-match-data
17973 (goto-char (point-at-bol))
17976 (defun org-in-verbatim-emphasis ()
17977 (save-match-data
17978 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
17980 (defun org-goto-marker-or-bmk (marker &optional bookmark)
17981 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
17982 (if (and marker (marker-buffer marker)
17983 (buffer-live-p (marker-buffer marker)))
17984 (progn
17985 (switch-to-buffer (marker-buffer marker))
17986 (if (or (> marker (point-max)) (< marker (point-min)))
17987 (widen))
17988 (goto-char marker)
17989 (org-show-context 'org-goto))
17990 (if bookmark
17991 (bookmark-jump bookmark)
17992 (error "Cannot find location"))))
17994 (defun org-quote-csv-field (s)
17995 "Quote field for inclusion in CSV material."
17998 s))
18000 (defun org-force-self-insert (N)
18001 "Needed to enforce self-insert under remapping."
18002 (interactive "p")
18003 (self-insert-command N))
18005 (defun org-string-width (s)
18006 "Compute width of string, ignoring invisible characters.
18007 This ignores character with invisibility property `org-link', and also
18008 characters with property `org-cwidth', because these will become invisible
18009 upon the next fontification round."
18010 (let (b l)
18011 (when (or (eq t buffer-invisibility-spec)
18012 (assq 'org-link buffer-invisibility-spec))
18013 (while (setq b (text-property-any 0 (length s)
18014 'invisible 'org-link s))
18015 (setq s (concat (substring s 0 b)
18016 (substring s (or (next-single-property-change
18017 b 'invisible s) (length s)))))))
18018 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18019 (setq s (concat (substring s 0 b)
18020 (substring s (or (next-single-property-change
18021 b 'org-cwidth s) (length s))))))
18022 (setq l (string-width s) b -1)
18023 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18024 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18025 l))
18027 (defun org-shorten-string (s maxlength)
18028 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18029 If the string is shorter or has length MAXLENGTH, just return the
18030 original string. If it is longer, the functions finds a space in the
18031 string, breaks this string off at that locations and adds three dots
18032 as ellipsis. Including the ellipsis, the string will not be longer
18033 than MAXLENGTH. If finding a good breaking point in the string does
18034 not work, the string is just chopped off in the middle of a word
18035 if necessary."
18036 (if (<= (length s) maxlength)
18037 s
18038 (let* ((n (max (- maxlength 4) 1))
18040 (if (string-match re s)
18041 (concat (match-string 1 s) "...")
18042 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18044 (defun org-get-indentation (&optional line)
18045 "Get the indentation of the current line, interpreting tabs.
18046 When LINE is given, assume it represents a line and compute its indentation."
18047 (if line
18048 (if (string-match "^ *" (org-remove-tabs line))
18049 (match-end 0))
18050 (save-excursion
18051 (beginning-of-line 1)
18053 (current-column))))
18055 (defun org-remove-tabs (s &optional width)
18056 "Replace tabulators in S with spaces.
18057 Assumes that s is a single line, starting in column 0."
18058 (setq width (or width tab-width))
18060 (setq s (replace-match
18061 (make-string
18062 (- (* width (/ (+ (match-beginning 0) width) width))
18063 (match-beginning 0)) ?\ )
18064 t t s)))
18065 s)
18067 (defun org-fix-indentation (line ind)
18068 "Fix indentation in LINE.
18069 IND is a cons cell with target and minimum indentation.
18070 If the current indentation in LINE is smaller than the minimum,
18071 leave it alone. If it is larger than ind, set it to the target."
18072 (let* ((l (org-remove-tabs line))
18073 (i (org-get-indentation l))
18074 (i1 (car ind)) (i2 (cdr ind)))
18075 (if (>= i i2) (setq l (substring line i2)))
18076 (if (> i1 0)
18077 (concat (make-string i1 ?\ ) l)
18078 l)))
18080 (defun org-remove-indentation (code &optional n)
18081 "Remove the maximum common indentation from the lines in CODE.
18082 N may optionally be the number of spaces to remove."
18083 (with-temp-buffer
18084 (insert code)
18085 (org-do-remove-indentation n)
18086 (buffer-string)))
18088 (defun org-do-remove-indentation (&optional n)
18089 "Remove the maximum common indentation from the buffer."
18090 (untabify (point-min) (point-max))
18091 (let ((min 10000) re)
18092 (if n
18093 (setq min n)
18094 (goto-char (point-min))
18096 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18097 (unless (or (= min 0) (= min 10000))
18099 (goto-char (point-min))
18100 (while (re-search-forward re nil t)
18101 (replace-match "")
18102 (end-of-line 1))
18103 min)))
18105 (defun org-fill-template (template alist)
18106 "Find each %key of ALIST in TEMPLATE and replace it."
18107 (let ((case-fold-search nil)
18108 entry key value)
18109 (setq alist (sort (copy-sequence alist)
18110 (lambda (a b) (< (length (car a)) (length (car b))))))
18111 (while (setq entry (pop alist))
18112 (setq template
18113 (replace-regexp-in-string
18114 (concat "%" (regexp-quote (car entry)))
18115 (cdr entry) template t t)))
18116 template))
18118 (defun org-base-buffer (buffer)
18119 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18120 (if (not buffer)
18121 buffer
18122 (or (buffer-base-buffer buffer)
18123 buffer)))
18125 (defun org-trim (s)
18126 "Remove whitespace at beginning and end of string."
18129 s)
18131 (defun org-wrap (string &optional width lines)
18132 "Wrap string to either a number of lines, or a width in characters.
18133 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18134 that costs. If there is a word longer than WIDTH, the text is actually
18135 wrapped to the length of that word.
18136 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18137 many lines, whatever width that takes.
18138 The return value is a list of lines, without newlines at the end."
18140 (maxword (apply 'max (mapcar 'org-string-width words)))
18141 w ll)
18142 (cond (width
18143 (org-do-wrap words (max maxword width)))
18144 (lines
18145 (setq w maxword)
18146 (setq ll (org-do-wrap words maxword))
18147 (if (<= (length ll) lines)
18148 ll
18149 (setq ll words)
18150 (while (> (length ll) lines)
18151 (setq w (1+ w))
18152 (setq ll (org-do-wrap words w)))
18153 ll))
18154 (t (error "Cannot wrap this")))))
18156 (defun org-do-wrap (words width)
18157 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18158 (let (lines line)
18159 (while words
18160 (setq line (pop words))
18161 (while (and words (< (+ (length line) (length (car words))) width))
18162 (setq line (concat line " " (pop words))))
18163 (setq lines (push line lines)))
18164 (nreverse lines)))
18166 (defun org-split-string (string &optional separators)
18167 "Splits STRING into substrings at SEPARATORS.
18168 No empty strings are returned if there are matches at the beginning
18169 and end of string."
18171 (start 0)
18172 notfirst
18173 (list nil))
18174 (while (and (string-match rexp string
18175 (if (and notfirst
18176 (= start (match-beginning 0))
18177 (< start (length string)))
18178 (1+ start) start))
18179 (< (match-beginning 0) (length string)))
18180 (setq notfirst t)
18181 (or (eq (match-beginning 0) 0)
18182 (and (eq (match-beginning 0) (match-end 0))
18183 (eq (match-beginning 0) start))
18184 (setq list
18185 (cons (substring string start (match-beginning 0))
18186 list)))
18187 (setq start (match-end 0)))
18188 (or (eq start (length string))
18189 (setq list
18190 (cons (substring string start)
18191 list)))
18192 (nreverse list)))
18194 (defun org-quote-vert (s)
18196 (while (string-match "|" s)
18198 s)
18200 (defun org-uuidgen-p (s)
18201 "Is S an ID created by UUIDGEN?"
18202 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18204 (defun org-context ()
18205 "Return a list of contexts of the current cursor position.
18206 If several contexts apply, all are returned.
18207 Each context entry is a list with a symbol naming the context, and
18208 two positions indicating start and end of the context. Possible
18209 contexts are:
18211 :headline anywhere in a headline
18212 :headline-stars on the leading stars in a headline
18213 :todo-keyword on a TODO keyword (including DONE) in a headline
18214 :tags on the TAGS in a headline
18215 :priority on the priority cookie in a headline
18216 :item on the first line of a plain list item
18217 :item-bullet on the bullet/number of a plain list item
18218 :checkbox on the checkbox in a plain list item
18219 :table in an org-mode table
18220 :table-special on a special filed in a table
18221 :table-table in a table.el table
18222 :link on a hyperlink
18223 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18224 :target on a <<target>>
18225 :radio-target on a <<<radio-target>>>
18226 :latex-fragment on a LaTeX fragment
18227 :latex-preview on a LaTeX fragment with overlayed preview image
18229 This function expects the position to be visible because it uses font-lock
18230 faces as a help to recognize the following contexts: :table-special, :link,
18231 and :keyword."
18232 (let* ((f (get-text-property (point) 'face))
18233 (faces (if (listp f) f (list f)))
18234 (p (point)) clist o)
18235 ;; First the large context
18236 (cond
18237 ((org-on-heading-p t)
18238 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18239 (when (progn
18240 (beginning-of-line 1)
18241 (looking-at org-todo-line-tags-regexp))
18242 (push (org-point-in-group p 1 :headline-stars) clist)
18243 (push (org-point-in-group p 2 :todo-keyword) clist)
18244 (push (org-point-in-group p 4 :tags) clist))
18245 (goto-char p)
18248 (push (org-point-in-group p 0 :priority) clist)))
18250 ((org-at-item-p)
18251 (push (org-point-in-group p 2 :item-bullet) clist)
18252 (push (list :item (point-at-bol)
18253 (save-excursion (org-end-of-item) (point)))
18254 clist)
18255 (and (org-at-item-checkbox-p)
18256 (push (org-point-in-group p 0 :checkbox) clist)))
18258 ((org-at-table-p)
18259 (push (list :table (org-table-begin) (org-table-end)) clist)
18260 (if (memq 'org-formula faces)
18261 (push (list :table-special
18262 (previous-single-property-change p 'face)
18263 (next-single-property-change p 'face)) clist)))
18264 ((org-at-table-p 'any)
18265 (push (list :table-table) clist)))
18266 (goto-char p)
18268 ;; Now the small context
18269 (cond
18270 ((org-at-timestamp-p)
18271 (push (org-point-in-group p 0 :timestamp) clist))
18272 ((memq 'org-link faces)
18273 (push (list :link
18274 (previous-single-property-change p 'face)
18275 (next-single-property-change p 'face)) clist))
18276 ((memq 'org-special-keyword faces)
18277 (push (list :keyword
18278 (previous-single-property-change p 'face)
18279 (next-single-property-change p 'face)) clist))
18280 ((org-on-target-p)
18281 (push (org-point-in-group p 0 :target) clist)
18282 (goto-char (1- (match-beginning 0)))
18283 (if (looking-at org-radio-target-regexp)
18284 (push (org-point-in-group p 0 :radio-target) clist))
18285 (goto-char p))
18286 ((setq o (car (delq nil
18287 (mapcar
18288 (lambda (x)
18289 (if (memq x org-latex-fragment-image-overlays) x))
18290 (overlays-at (point))))))
18291 (push (list :latex-fragment
18292 (overlay-start o) (overlay-end o)) clist)
18293 (push (list :latex-preview
18294 (overlay-start o) (overlay-end o)) clist))
18295 ((org-inside-LaTeX-fragment-p)
18296 ;; FIXME: positions wrong.
18297 (push (list :latex-fragment (point) (point)) clist)))
18299 (setq clist (nreverse (delq nil clist)))
18300 clist))
18302 ;; FIXME: Compare with at-regexp-p Do we need both?
18303 (defun org-in-regexp (re &optional nlines visually)
18304 "Check if point is inside a match of regexp.
18305 Normally only the current line is checked, but you can include NLINES extra
18306 lines both before and after point into the search.
18307 If VISUALLY is set, require that the cursor is not after the match but
18308 really on, so that the block visually is on the match."
18309 (catch 'exit
18310 (let ((pos (point))
18311 (eol (point-at-eol (+ 1 (or nlines 0))))
18312 (inc (if visually 1 0)))
18313 (save-excursion
18314 (beginning-of-line (- 1 (or nlines 0)))
18315 (while (re-search-forward re eol t)
18316 (if (and (<= (match-beginning 0) pos)
18317 (>= (+ inc (match-end 0)) pos))
18318 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18320 (defun org-at-regexp-p (regexp)
18321 "Is point inside a match of REGEXP in the current line?"
18322 (catch 'exit
18323 (save-excursion
18324 (let ((pos (point)) (end (point-at-eol)))
18325 (beginning-of-line 1)
18326 (while (re-search-forward regexp end t)
18327 (if (and (<= (match-beginning 0) pos)
18328 (>= (match-end 0) pos))
18329 (throw 'exit t)))
18330 nil))))
18332 (defun org-in-regexps-block-p (start-re end-re &optional bound)
18333 "Return t if the current point is between matches of START-RE and END-RE.
18334 This will also return t if point is on one of the two matches or
18335 in an unfinished block. END-RE can be a string or a form
18336 returning a string.
18338 An optional third argument bounds the search for START-RE. It
18339 defaults to previous heading or `point-min'."
18340 (let ((pos (point))
18341 (limit (or bound (save-excursion (outline-previous-heading)))))
18342 (save-excursion
18343 ;; we're on a block when point is on start-re...
18344 (or (org-at-regexp-p start-re)
18345 ;; ... or start-re can be found above...
18346 (and (re-search-backward start-re limit t)
18347 ;; ... but no end-re between start-re and point.
18348 (not (re-search-forward (eval end-re) pos t)))))))
18350 (defun org-occur-in-agenda-files (regexp &optional nlines)
18351 "Call `multi-occur' with buffers for all agenda files."
18353 (let* ((files (org-agenda-files))
18354 (tnames (mapcar 'file-truename files))
18355 (extra org-agenda-text-search-extra-files)
18356 f)
18357 (when (eq (car extra) 'agenda-archives)
18358 (setq extra (cdr extra))
18359 (setq files (org-add-archive-files files)))
18360 (while (setq f (pop extra))
18361 (unless (member (file-truename f) tnames)
18362 (add-to-list 'files f 'append)
18363 (add-to-list 'tnames (file-truename f) 'append)))
18364 (multi-occur
18365 (mapcar (lambda (x)
18366 (with-current-buffer
18367 (or (get-file-buffer x) (find-file-noselect x))
18368 (widen)
18369 (current-buffer)))
18370 files)
18371 regexp)))
18373 (if (boundp 'occur-mode-find-occurrence-hook)
18374 ;; Emacs 23
18375 (add-hook 'occur-mode-find-occurrence-hook
18376 (lambda ()
18377 (when (org-mode-p)
18378 (org-reveal))))
18379 ;; Emacs 22
18380 (defadvice occur-mode-goto-occurrence
18381 (after org-occur-reveal activate)
18382 (and (org-mode-p) (org-reveal)))
18383 (defadvice occur-mode-goto-occurrence-other-window
18384 (after org-occur-reveal activate)
18385 (and (org-mode-p) (org-reveal)))
18386 (defadvice occur-mode-display-occurrence
18387 (after org-occur-reveal activate)
18388 (when (org-mode-p)
18389 (let ((pos (occur-mode-find-occurrence)))
18390 (with-current-buffer (marker-buffer pos)
18391 (save-excursion
18392 (goto-char pos)
18393 (org-reveal)))))))
18395 (defun org-occur-link-in-agenda-files ()
18396 "Create a link and search for it in the agendas.
18397 The link is not stored in `org-stored-links', it is just created
18398 for the search purpose."
18399 (interactive)
18400 (let ((link (condition-case nil
18401 (org-store-link nil)
18402 (error "Unable to create a link to here"))))
18403 (org-occur-in-agenda-files (regexp-quote link))))
18405 (defun org-uniquify (list)
18406 "Remove duplicate elements from LIST."
18407 (let (res)
18408 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
18409 res))
18411 (defun org-delete-all (elts list)
18412 "Remove all elements in ELTS from LIST."
18413 (while elts
18414 (setq list (delete (pop elts) list)))
18415 list)
18417 (defun org-count (cl-item cl-seq)
18418 "Count the number of occurrences of ITEM in SEQ.
18419 Taken from `count' in cl-seq.el with all keyword arguments removed."
18420 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
18421 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
18422 (while (< cl-start cl-end)
18423 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
18424 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
18425 (setq cl-start (1+ cl-start)))
18426 cl-count))
18428 (defun org-remove-if (predicate seq)
18429 "Remove everything from SEQ that fulfills PREDICATE."
18430 (let (res e)
18431 (while seq
18432 (setq e (pop seq))
18433 (if (not (funcall predicate e)) (push e res)))
18434 (nreverse res)))
18436 (defun org-remove-if-not (predicate seq)
18437 "Remove everything from SEQ that does not fulfill PREDICATE."
18438 (let (res e)
18439 (while seq
18440 (setq e (pop seq))
18441 (if (funcall predicate e) (push e res)))
18442 (nreverse res)))
18444 (defun org-back-over-empty-lines ()
18445 "Move backwards over whitespace, to the beginning of the first empty line.
18446 Returns the number of empty lines passed."
18447 (let ((pos (point)))
18449 (beginning-of-line 2)
18450 (goto-char (min (point) pos))
18451 (count-lines (point) pos)))
18453 (defun org-skip-whitespace ()
18456 (defun org-point-in-group (point group &optional context)
18457 "Check if POINT is in match-group GROUP.
18458 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18459 match. If the match group does not exist or point is not inside it,
18460 return nil."
18461 (and (match-beginning group)
18462 (>= point (match-beginning group))
18463 (<= point (match-end group))
18464 (if context
18465 (list context (match-beginning group) (match-end group))
18466 t)))
18468 (defun org-switch-to-buffer-other-window (&rest args)
18469 "Switch to buffer in a second window on the current frame.
18470 In particular, do not allow pop-up frames.
18471 Returns the newly created buffer."
18472 (let (pop-up-frames special-display-buffer-names special-display-regexps
18473 special-display-function)
18474 (apply 'switch-to-buffer-other-window args)))
18476 (defun org-combine-plists (&rest plists)
18477 "Create a single property list from all plists in PLISTS.
18478 The process starts by copying the first list, and then setting properties
18479 from the other lists. Settings in the last list are the most significant
18480 ones and overrule settings in the other lists."
18481 (let ((rtn (copy-sequence (pop plists)))
18482 p v ls)
18483 (while plists
18484 (setq ls (pop plists))
18485 (while ls
18486 (setq p (pop ls) v (pop ls))
18487 (setq rtn (plist-put rtn p v))))
18488 rtn))
18490 (defun org-move-line-down (arg)
18491 "Move the current line down. With prefix argument, move it past ARG lines."
18492 (interactive "p")
18493 (let ((col (current-column))
18494 beg end pos)
18495 (beginning-of-line 1) (setq beg (point))
18496 (beginning-of-line 2) (setq end (point))
18497 (beginning-of-line (+ 1 arg))
18498 (setq pos (move-marker (make-marker) (point)))
18499 (insert (delete-and-extract-region beg end))
18500 (goto-char pos)
18501 (org-move-to-column col)))
18503 (defun org-move-line-up (arg)
18504 "Move the current line up. With prefix argument, move it past ARG lines."
18505 (interactive "p")
18506 (let ((col (current-column))
18507 beg end pos)
18508 (beginning-of-line 1) (setq beg (point))
18509 (beginning-of-line 2) (setq end (point))
18510 (beginning-of-line (- arg))
18511 (setq pos (move-marker (make-marker) (point)))
18512 (insert (delete-and-extract-region beg end))
18513 (goto-char pos)
18514 (org-move-to-column col)))
18516 (defun org-replace-escapes (string table)
18517 "Replace %-escapes in STRING with values in TABLE.
18519 The sequences in STRING may contain normal field width and padding information,
18521 so values can contain further %-escapes if they are define later in TABLE."
18522 (let ((tbl (copy-alist table))
18523 (case-fold-search nil)
18524 (pchg 0)
18525 e re rpl)
18526 (while (setq e (pop tbl))
18527 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
18528 (when (and (cdr e) (string-match re (cdr e)))
18529 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
18530 (safe "SREF"))
18531 (add-text-properties 0 3 (list 'sref sref) safe)
18532 (setcdr e (replace-match safe t t (cdr e)))))
18533 (while (string-match re string)
18534 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
18535 (cdr e)))
18536 (setq string (replace-match rpl t t string))))
18537 (while (setq pchg (next-property-change pchg string))
18538 (let ((sref (get-text-property pchg 'sref string)))
18539 (when (and sref (string-match "SREF" string pchg))
18540 (setq string (replace-match sref t t string)))))
18541 string))
18543 (defun org-sublist (list start end)
18544 "Return a section of LIST, from START to END.
18545 Counting starts at 1."
18546 (let (rtn (c start))
18547 (setq list (nthcdr (1- start) list))
18548 (while (and list (<= c end))
18549 (push (pop list) rtn)
18550 (setq c (1+ c)))
18551 (nreverse rtn)))
18553 (defun org-find-base-buffer-visiting (file)
18554 "Like `find-buffer-visiting' but always return the base buffer and
18555 not an indirect buffer."
18556 (let ((buf (or (get-file-buffer file)
18557 (find-buffer-visiting file))))
18558 (if buf
18559 (or (buffer-base-buffer buf) buf)
18560 nil)))
18562 (defun org-image-file-name-regexp (&optional extensions)
18563 "Return regexp matching the file names of images.
18564 If EXTENSIONS is given, only match these."
18565 (if (and (not extensions) (fboundp 'image-file-name-regexp))
18566 (image-file-name-regexp)
18567 (let ((image-file-name-extensions
18568 (or extensions
18569 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
18570 "xbm" "xpm" "pbm" "pgm" "ppm"))))
18572 (regexp-opt (nconc (mapcar 'upcase
18573 image-file-name-extensions)
18574 image-file-name-extensions)
18575 t)
18578 (defun org-file-image-p (file &optional extensions)
18579 "Return non-nil if FILE is an image."
18580 (save-match-data
18581 (string-match (org-image-file-name-regexp extensions) file)))
18583 (defun org-get-cursor-date ()
18584 "Return the date at cursor in as a time.
18585 This works in the calendar and in the agenda, anywhere else it just
18586 returns the current time."
18587 (let (date day defd)
18588 (cond
18589 ((eq major-mode 'calendar-mode)
18590 (setq date (calendar-cursor-to-date)
18591 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
18592 ((eq major-mode 'org-agenda-mode)
18593 (setq day (get-text-property (point) 'day))
18594 (if day
18595 (setq date (calendar-gregorian-from-absolute day)
18596 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
18597 (nth 2 date))))))
18598 (or defd (current-time))))
18600 (defvar org-agenda-action-marker (make-marker)
18601 "Marker pointing to the entry for the next agenda action.")
18603 (defun org-mark-entry-for-agenda-action ()
18604 "Mark the current entry as target of an agenda action.
18605 Agenda actions are actions executed from the agenda with the key `k',
18606 which make use of the date at the cursor."
18607 (interactive)
18608 (move-marker org-agenda-action-marker
18609 (save-excursion (org-back-to-heading t) (point))
18610 (current-buffer))
18611 (message
18612 "Entry marked for action; press `k' at desired date in agenda or calendar"))
18614 (defun org-mark-subtree ()
18615 "Mark the current subtree.
18616 This puts point at the start of the current subtree, and mark at the end.
18618 If point is in an inline task, mark that task instead."
18619 (interactive)
18620 (let ((inline-task-p
18621 (and (featurep 'org-inlinetask)
18622 (org-inlinetask-in-task-p)))
18623 (beg))
18624 ;; Get beginning of subtree
18625 (cond
18626 (inline-task-p (org-inlinetask-goto-beginning))
18627 ((org-at-heading-p) (beginning-of-line))
18628 (t (let ((outline-regexp (org-get-limited-outline-regexp)))
18629 (outline-previous-visible-heading 1))))
18630 (setq beg (point))
18631 ;; Get end of it
18632 (if inline-task-p
18633 (org-inlinetask-goto-end)
18634 (org-end-of-subtree))
18635 ;; Mark zone
18636 (push-mark (point) nil t)
18637 (goto-char beg)))
18639 ;;; Paragraph filling stuff.
18640 ;; We want this to be just right, so use the full arsenal.
18642 (defun org-indent-line-function ()
18643 "Indent line depending on context."
18644 (interactive)
18645 (let* ((pos (point))
18646 (itemp (org-at-item-p))
18647 (case-fold-search t)
18649 (inline-task-p (and (featurep 'org-inlinetask)
18650 (org-inlinetask-in-task-p)))
18651 column bpos bcol tpos tcol)
18652 (beginning-of-line 1)
18653 (cond
18654 ;; Comments
18655 ((looking-at "# ") (setq column 0))
18656 ;; Headings
18658 ;; Literal examples
18660 (setq column (org-get-indentation))) ; do nothing
18661 ;; Drawers
18663 (save-excursion (re-search-backward org-drawer-regexp nil t)))
18664 (save-excursion
18665 (goto-char (1- (match-beginning 1)))
18666 (setq column (current-column))))
18667 ;; Special blocks
18669 (save-excursion
18670 (re-search-backward
18672 (setq column (org-get-indentation (match-string 0))))
18675 (save-excursion
18677 (setq column
18678 (if (equal (downcase (match-string 1)) "src")
18679 ;; src blocks: let `org-edit-src-exit' handle them
18680 (org-get-indentation)
18681 (org-get-indentation (match-string 0)))))
18682 ;; Lists
18683 ((org-in-item-p)
18684 (org-beginning-of-item)
18685 (looking-at "[ \t]*\\(\\S-+\\)[ \t]*\\(\\(:?\\[@\\(:?start:\\)?[0-9]+\\][ \t]*\\)?\\[[- X]\\][ \t]*\\|.*? :: \\)?")
18686 (setq bpos (match-beginning 1) tpos (match-end 0)
18687 bcol (progn (goto-char bpos) (current-column))
18688 tcol (progn (goto-char tpos) (current-column)))
18689 (if (> tcol (+ bcol org-description-max-indent))
18690 (setq tcol (+ bcol 5)))
18691 (goto-char pos)
18692 (setq column (if itemp (org-get-indentation) tcol)))
18693 ;; This line has nothing special, look at the previous relevant
18694 ;; line to compute indentation
18695 (t
18696 (beginning-of-line 0)
18697 (while (and (not (bobp))
18698 (not (looking-at org-drawer-regexp))
18699 ;; skip comments, verbatim, empty lines, tables,
18700 ;; inline tasks, lists, drawers and blocks
18702 (re-search-backward org-drawer-regexp nil t))
18706 (and (org-in-item-p) (goto-char (org-list-top-point)))
18707 (and (not inline-task-p)
18708 (featurep 'org-inlinetask)
18709 (org-inlinetask-in-task-p)
18710 (or (org-inlinetask-goto-beginning) t))))
18711 (beginning-of-line 0))
18712 (cond
18713 ;; There was an heading above.
18715 (if (not org-adapt-indentation)
18716 (setq column 0)
18717 (goto-char (match-end 0))
18718 (setq column (current-column))))
18719 ;; A drawer had started and is unfinished
18720 ((looking-at org-drawer-regexp)
18721 (goto-char (1- (match-beginning 1)))
18722 (setq column (current-column)))
18723 ;; Else, nothing noticeable found: get indentation and go on.
18724 (t (setq column (org-get-indentation))))))
18725 ;; Now apply indentation and move cursor accordingly
18726 (goto-char pos)
18727 (if (<= (current-column) (current-indentation))
18728 (org-indent-line-to column)
18729 (save-excursion (org-indent-line-to column)))
18730 ;; Special polishing for properties, see `org-property-format'
18731 (setq column (current-column))
18732 (beginning-of-line 1)
18733 (if (looking-at
18735 (replace-match (concat (match-string 1)
18736 (format org-property-format
18737 (match-string 2) (match-string 3)))
18738 t t))
18739 (org-move-to-column column)))
18741 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
18742 "Variable to store copy of `adaptive-fill-regexp'.
18743 Since `adaptive-fill-regexp' is set to never match, we need to
18744 store a backup of its value before entering `org-mode' so that
18745 the functionality can be provided as a fall-back.")
18747 (defun org-set-autofill-regexps ()
18748 (interactive)
18749 ;; In the paragraph separator we include headlines, because filling
18750 ;; text in a line directly attached to a headline would otherwise
18751 ;; fill the headline as well.
18754 ;; The paragraph starter includes hand-formatted lists.
18755 (org-set-local
18756 'paragraph-start
18757 (concat
18766 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
18767 ;; But only if the user has not turned off tables or fixed-width regions
18768 (org-set-local
18769 'auto-fill-inhibit-regexp
18772 (if (or org-enable-table-editor org-enable-fixed-width-editor)
18773 (concat
18775 (if org-enable-table-editor "|" "")
18776 (if org-enable-fixed-width-editor ":" "")
18777 "]"))))
18778 ;; We use our own fill-paragraph function, to make sure that tables
18779 ;; and fixed-width regions are not wrapped. That function will pass
18780 ;; through to `fill-paragraph' when appropriate.
18781 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
18782 ;; Adaptive filling: To get full control, first make sure that
18783 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
18784 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
18785 (org-set-local 'org-adaptive-fill-regexp-backup
18786 adaptive-fill-regexp))
18788 (org-set-local 'adaptive-fill-function
18789 'org-adaptive-fill-function)
18790 (org-set-local
18791 'align-mode-rules-list
18792 '((org-in-buffer-settings
18794 (modes . '(org-mode))))))
18796 (defun org-fill-paragraph (&optional justify)
18797 "Re-align a table, pass through to fill-paragraph if no table."
18798 (let ((table-p (org-at-table-p))
18799 (table.el-p (org-at-table.el-p)))
18800 (cond ((and (equal (char-after (point-at-bol)) ?*)
18801 (save-excursion (goto-char (point-at-bol))
18802 (looking-at outline-regexp)))
18803 t) ; skip headlines
18804 (table.el-p t) ; skip table.el tables
18805 (table-p (org-table-align) t) ; align org-mode tables
18806 (t nil)))) ; call paragraph-fill
18808 ;; For reference, this is the default value of adaptive-fill-regexp
18811 (defun org-adaptive-fill-function ()
18812 "Return a fill prefix for org-mode files.
18813 In particular, this makes sure hanging paragraphs for hand-formatted lists
18814 work correctly."
18815 (cond
18816 ;; Comment line
18818 (match-string-no-properties 0))
18819 ;; Description list
18821 (save-excursion
18822 (if (> (match-end 1) (+ (match-beginning 1)
18823 org-description-max-indent))
18824 (goto-char (+ (match-beginning 1) 5))
18825 (goto-char (match-end 0)))
18826 (make-string (current-column) ?\ )))
18827 ;; Ordered or unordered list
18829 (save-excursion
18830 (goto-char (match-end 0))
18831 (make-string (current-column) ?\ )))
18832 ;; Other text
18833 ((looking-at org-adaptive-fill-regexp-backup)
18834 (match-string-no-properties 0))))
18836 ;;; Other stuff.
18838 (defun org-toggle-fixed-width-section (arg)
18839 "Toggle the fixed-width export.
18840 If there is no active region, the QUOTE keyword at the current headline is
18841 inserted or removed. When present, it causes the text between this headline
18842 and the next to be exported as fixed-width text, and unmodified.
18843 If there is an active region, this command adds or removes a colon as the
18844 first character of this line. If the first character of a line is a colon,
18845 this line is also exported in fixed-width font."
18846 (interactive "P")
18847 (let* ((cc 0)
18848 (regionp (org-region-active-p))
18849 (beg (if regionp (region-beginning) (point)))
18850 (end (if regionp (region-end)))
18851 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
18852 (case-fold-search nil)
18854 off)
18855 (if regionp
18856 (save-excursion
18857 (goto-char beg)
18858 (setq cc (current-column))
18859 (beginning-of-line 1)
18860 (setq off (looking-at re))
18861 (while (> nlines 0)
18862 (setq nlines (1- nlines))
18863 (beginning-of-line 1)
18864 (cond
18865 (arg
18866 (org-move-to-column cc t)
18868 (forward-line -1))
18869 ((and off (looking-at re))
18870 (replace-match "" t t nil 1))
18871 ((not off) (org-move-to-column cc t) (insert ": ")))
18872 (forward-line 1)))
18873 (save-excursion
18874 (org-back-to-heading)
18875 (if (looking-at (concat outline-regexp
18877 (replace-match "" t t nil 1)
18878 (if (looking-at outline-regexp)
18879 (progn
18880 (goto-char (match-end 0))
18881 (insert org-quote-string " "))))))))
18883 (defun org-reftex-citation ()
18884 "Use reftex-citation to insert a citation into the buffer.
18885 This looks for a line like
18887 #+BIBLIOGRAPHY: foo plain option:-d
18889 and derives from it that foo.bib is the bibliography file relevant
18890 for this document. It then installs the necessary environment for RefTeX
18891 to work in this buffer and calls `reftex-citation' to insert a citation
18892 into the buffer.
18894 Export of such citations to both LaTeX and HTML is handled by the contributed
18895 package org-exp-bibtex by Taru Karttunen."
18896 (interactive)
18897 (let ((reftex-docstruct-symbol 'rds)
18899 rds bib)
18900 (save-excursion
18901 (save-restriction
18902 (widen)
18903 (let ((case-fold-search t)
18905 (if (not (save-excursion
18906 (or (re-search-forward re nil t)
18907 (re-search-backward re nil t))))
18908 (error "No bibliography defined in file")
18909 (setq bib (concat (match-string 1) ".bib")
18910 rds (list (list 'bib bib)))))))
18911 (call-interactively 'reftex-citation)))
18913 ;;;; Functions extending outline functionality
18915 (defun org-beginning-of-line (&optional arg)
18916 "Go to the beginning of the current line. If that is invisible, continue
18917 to a visible line beginning. This makes the function of C-a more intuitive.
18918 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18919 first attempt, and only move to after the tags when the cursor is already
18920 beyond the end of the headline."
18921 (interactive "P")
18922 (let ((pos (point))
18923 (special (if (consp org-special-ctrl-a/e)
18924 (car org-special-ctrl-a/e)
18925 org-special-ctrl-a/e))
18926 refpos)
18927 (if (org-bound-and-true-p line-move-visual)
18928 (beginning-of-visual-line 1)
18929 (beginning-of-line 1))
18930 (if (and arg (fboundp 'move-beginning-of-line))
18931 (call-interactively 'move-beginning-of-line)
18932 (if (bobp)
18933 nil
18934 (backward-char 1)
18935 (if (org-truely-invisible-p)
18936 (while (and (not (bobp)) (org-truely-invisible-p))
18937 (backward-char 1)
18938 (beginning-of-line 1))
18939 (forward-char 1))))
18940 (when special
18941 (cond
18942 ((and (looking-at org-complex-heading-regexp)
18943 (= (char-after (match-end 1)) ?\ ))
18944 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
18945 (point-at-eol)))
18946 (goto-char
18947 (if (eq special t)
18948 (cond ((> pos refpos) refpos)
18949 ((= pos (point)) refpos)
18950 (t (point)))
18951 (cond ((> pos (point)) (point))
18952 ((not (eq last-command this-command)) (point))
18953 (t refpos)))))
18954 ((org-at-item-p)
18955 (goto-char
18956 (if (eq special t)
18957 (cond ((> pos (match-end 4)) (match-end 4))
18958 ((= pos (point)) (match-end 4))
18959 (t (point)))
18960 (cond ((> pos (point)) (point))
18961 ((not (eq last-command this-command)) (point))
18962 (t (match-end 4))))))))
18963 (org-no-warnings
18964 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18966 (defun org-end-of-line (&optional arg)
18967 "Go to the end of the line.
18968 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18969 first attempt, and only move to after the tags when the cursor is already
18970 beyond the end of the headline."
18971 (interactive "P")
18972 (let ((special (if (consp org-special-ctrl-a/e)
18973 (cdr org-special-ctrl-a/e)
18974 org-special-ctrl-a/e)))
18975 (if (or (not special)
18976 (not (org-on-heading-p))
18977 arg)
18978 (call-interactively
18979 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
18980 ((fboundp 'move-end-of-line) 'move-end-of-line)
18981 (t 'end-of-line)))
18982 (let ((pos (point)))
18983 (beginning-of-line 1)
18985 (if (eq special t)
18986 (if (or (< pos (match-beginning 1))
18987 (= pos (match-end 0)))
18988 (goto-char (match-beginning 1))
18989 (goto-char (match-end 0)))
18990 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
18991 (goto-char (match-end 0))
18992 (goto-char (match-beginning 1))))
18993 (call-interactively (if (fboundp 'move-end-of-line)
18994 'move-end-of-line
18995 'end-of-line)))))
18996 (org-no-warnings
18997 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18999 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19000 (define-key org-mode-map "\C-e" 'org-end-of-line)
19002 (defun org-backward-sentence (&optional arg)
19003 "Go to beginning of sentence, or beginning of table field.
19004 This will call `backward-sentence' or `org-table-beginning-of-field',
19005 depending on context."
19006 (interactive "P")
19007 (cond
19008 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19009 (t (call-interactively 'backward-sentence))))
19011 (defun org-forward-sentence (&optional arg)
19012 "Go to end of sentence, or end of table field.
19013 This will call `forward-sentence' or `org-table-end-of-field',
19014 depending on context."
19015 (interactive "P")
19016 (cond
19017 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19018 (t (call-interactively 'forward-sentence))))
19020 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19021 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19023 (defun org-kill-line (&optional arg)
19024 "Kill line, to tags or end of line."
19025 (interactive "P")
19026 (cond
19027 ((or (not org-special-ctrl-k)
19028 (bolp)
19029 (not (org-on-heading-p)))
19030 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19031 org-ctrl-k-protect-subtree)
19032 (if (or (eq org-ctrl-k-protect-subtree 'error)
19033 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19034 (error "C-k aborted - would kill hidden subtree")))
19035 (call-interactively 'kill-line))
19037 (kill-region (point) (match-beginning 1))
19038 (org-set-tags nil t))
19039 (t (kill-region (point) (point-at-eol)))))
19041 (define-key org-mode-map "\C-k" 'org-kill-line)
19043 (defun org-yank (&optional arg)
19044 "Yank. If the kill is a subtree, treat it specially.
19045 This command will look at the current kill and check if is a single
19046 subtree, or a series of subtrees[1]. If it passes the test, and if the
19047 cursor is at the beginning of a line or after the stars of a currently
19048 empty headline, then the yank is handled specially. How exactly depends
19049 on the value of the following variables, both set by default.
19051 org-yank-folded-subtrees
19052 When set, the subtree(s) will be folded after insertion, but only
19053 if doing so would now swallow text after the yanked text.
19055 org-yank-adjusted-subtrees
19056 When set, the subtree will be promoted or demoted in order to
19057 fit into the local outline tree structure, which means that the level
19058 will be adjusted so that it becomes the smaller one of the two
19059 *visible* surrounding headings.
19061 Any prefix to this command will cause `yank' to be called directly with
19063 will just
19064 plainly yank the text as it is.
19066 \[1] The test checks if the first non-white line is a heading
19067 and if there are no other headings with fewer stars."
19068 (interactive "P")
19069 (org-yank-generic 'yank arg))
19071 (defun org-yank-generic (command arg)
19072 "Perform some yank-like command.
19074 This function implements the behavior described in the `org-yank'
19075 documentation. However, it has been generalized to work for any
19076 interactive command with similar behavior."
19078 ;; pretend to be command COMMAND
19079 (setq this-command command)
19081 (if arg
19082 (call-interactively command)
19084 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19085 (and (org-kill-is-subtree-p)
19086 (or (bolp)
19088 (string-match
19090 (buffer-substring (point-at-bol) (point)))))))
19091 swallowp)
19092 (cond
19093 ((and subtreep org-yank-folded-subtrees)
19094 (let ((beg (point))
19095 end)
19096 (if (and subtreep org-yank-adjusted-subtrees)
19097 (org-paste-subtree nil nil 'for-yank)
19098 (call-interactively command))
19100 (setq end (point))
19101 (goto-char beg)
19102 (when (and (bolp) subtreep
19103 (not (setq swallowp
19104 (org-yank-folding-would-swallow-text beg end))))
19105 (or (looking-at outline-regexp)
19106 (re-search-forward (concat "^" outline-regexp) end t))
19107 (while (and (< (point) end) (looking-at outline-regexp))
19108 (hide-subtree)
19109 (org-cycle-show-empty-lines 'folded)
19110 (condition-case nil
19111 (outline-forward-same-level 1)
19112 (error (goto-char end)))))
19113 (when swallowp
19114 (message
19115 "Inserted text not folded because that would swallow text"))
19117 (goto-char end)
19119 (beginning-of-line 1)
19120 (push-mark beg 'nomsg)))
19121 ((and subtreep org-yank-adjusted-subtrees)
19122 (let ((beg (point-at-bol)))
19123 (org-paste-subtree nil nil 'for-yank)
19124 (push-mark beg 'nomsg)))
19125 (t
19126 (call-interactively command))))))
19128 (defun org-yank-folding-would-swallow-text (beg end)
19129 "Would hide-subtree at BEG swallow any text after END?"
19130 (let (level)
19131 (save-excursion
19132 (goto-char beg)
19133 (when (or (looking-at outline-regexp)
19134 (re-search-forward (concat "^" outline-regexp) end t))
19135 (setq level (org-outline-level)))
19136 (goto-char end)
19138 (if (or (eobp)
19139 (and (bolp) (looking-at org-outline-regexp)
19140 (<= (org-outline-level) level)))
19141 nil ; Nothing would be swallowed
19142 t)))) ; something would swallow
19144 (define-key org-mode-map "\C-y" 'org-yank)
19146 (defun org-invisible-p ()
19147 "Check if point is at a character currently not visible."
19148 ;; Early versions of noutline don't have `outline-invisible-p'.
19149 (if (fboundp 'outline-invisible-p)
19150 (outline-invisible-p)
19151 (get-char-property (point) 'invisible)))
19153 (defun org-truely-invisible-p ()
19154 "Check if point is at a character currently not visible.
19155 This version does not only check the character property, but also
19156 `visible-mode'."
19157 ;; Early versions of noutline don't have `outline-invisible-p'.
19158 (if (org-bound-and-true-p visible-mode)
19159 nil
19160 (if (fboundp 'outline-invisible-p)
19161 (outline-invisible-p)
19162 (get-char-property (point) 'invisible))))
19164 (defun org-invisible-p2 ()
19165 "Check if point is at a character currently not visible."
19166 (save-excursion
19167 (if (and (eolp) (not (bobp))) (backward-char 1))
19168 ;; Early versions of noutline don't have `outline-invisible-p'.
19169 (if (fboundp 'outline-invisible-p)
19170 (outline-invisible-p)
19171 (get-char-property (point) 'invisible))))
19173 (defun org-back-to-heading (&optional invisible-ok)
19174 "Call `outline-back-to-heading', but provide a better error message."
19175 (condition-case nil
19176 (outline-back-to-heading invisible-ok)
19177 (error (error "Before first headline at position %d in buffer %s"
19178 (point) (current-buffer)))))
19180 (defun org-beginning-of-defun ()
19181 "Go to the beginning of the subtree, i.e. back to the heading."
19182 (org-back-to-heading))
19183 (defun org-end-of-defun ()
19184 "Go to the end of the subtree."
19185 (org-end-of-subtree nil t))
19187 (defun org-before-first-heading-p ()
19188 "Before first heading?"
19189 (save-excursion
19190 (end-of-line)
19193 (defun org-on-heading-p (&optional ignored)
19194 (outline-on-heading-p t))
19195 (defun org-at-heading-p (&optional ignored)
19196 (outline-on-heading-p t))
19198 (defun org-point-at-end-of-empty-headline ()
19199 "If point is at the end of an empty headline, return t, else nil.
19200 If the heading only contains a TODO keyword, it is still still considered
19201 empty."
19203 (save-excursion
19204 (beginning-of-line 1)
19207 (defun org-at-heading-or-item-p ()
19208 (or (org-on-heading-p) (org-at-item-p)))
19210 (defun org-on-target-p ()
19211 (or (org-in-regexp org-radio-target-regexp)
19212 (org-in-regexp org-target-regexp)))
19214 (defun org-up-heading-all (arg)
19215 "Move to the heading line of which the present line is a subheading.
19216 This function considers both visible and invisible heading lines.
19217 With argument, move up ARG levels."
19218 (if (fboundp 'outline-up-heading-all)
19219 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19220 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19222 (defun org-up-heading-safe ()
19223 "Move to the heading line of which the present line is a subheading.
19224 This version will not throw an error. It will return the level of the
19225 headline found, or nil if no higher level is found.
19227 Also, this function will be a lot faster than `outline-up-heading',
19228 because it relies on stars being the outline starters. This can really
19229 make a significant difference in outlines with very many siblings."
19230 (let (start-level re)
19231 (org-back-to-heading t)
19232 (setq start-level (funcall outline-level))
19233 (if (equal start-level 1)
19234 nil
19236 (if (re-search-backward re nil t)
19237 (funcall outline-level)))))
19239 (defun org-first-sibling-p ()
19240 "Is this heading the first child of its parents?"
19241 (interactive)
19242 (let ((re (concat "^" outline-regexp))
19243 level l)
19244 (unless (org-at-heading-p t)
19245 (error "Not at a heading"))
19246 (setq level (funcall outline-level))
19247 (save-excursion
19248 (if (not (re-search-backward re nil t))
19249 t
19250 (setq l (funcall outline-level))
19251 (< l level)))))
19253 (defun org-goto-sibling (&optional previous)
19254 "Goto the next sibling, even if it is invisible.
19255 When PREVIOUS is set, go to the previous sibling instead. Returns t
19256 when a sibling was found. When none is found, return nil and don't
19257 move point."
19258 (let ((fun (if previous 're-search-backward 're-search-forward))
19259 (pos (point))
19260 (re (concat "^" outline-regexp))
19261 level l)
19262 (when (condition-case nil (org-back-to-heading t) (error nil))
19263 (setq level (funcall outline-level))
19264 (catch 'exit
19265 (or previous (forward-char 1))
19266 (while (funcall fun re nil t)
19267 (setq l (funcall outline-level))
19268 (when (< l level) (goto-char pos) (throw 'exit nil))
19269 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
19270 (goto-char pos)
19271 nil))))
19273 (defun org-show-siblings ()
19274 "Show all siblings of the current headline."
19275 (save-excursion
19276 (while (org-goto-sibling) (org-flag-heading nil)))
19277 (save-excursion
19278 (while (org-goto-sibling 'previous)
19279 (org-flag-heading nil))))
19281 (defun org-goto-first-child ()
19282 "Goto the first child, even if it is invisible.
19283 Return t when a child was found. Otherwise don't move point and
19284 return nil."
19285 (let (level (pos (point)) (re (concat "^" outline-regexp)))
19286 (when (condition-case nil (org-back-to-heading t) (error nil))
19287 (setq level (outline-level))
19288 (forward-char 1)
19289 (if (and (re-search-forward re nil t) (> (outline-level) level))
19290 (progn (goto-char (match-beginning 0)) t)
19291 (goto-char pos) nil))))
19293 (defun org-show-hidden-entry ()
19294 "Show an entry where even the heading is hidden."
19295 (save-excursion
19296 (org-show-entry)))
19298 (defun org-flag-heading (flag &optional entry)
19299 "Flag the current heading. FLAG non-nil means make invisible.
19300 When ENTRY is non-nil, show the entire entry."
19301 (save-excursion
19302 (org-back-to-heading t)
19303 ;; Check if we should show the entire entry
19304 (if entry
19305 (progn
19306 (org-show-entry)
19307 (save-excursion
19308 (and (outline-next-heading)
19309 (org-flag-heading nil))))
19310 (outline-flag-region (max (point-min) (1- (point)))
19311 (save-excursion (outline-end-of-heading) (point))
19312 flag))))
19314 (defun org-get-next-sibling ()
19315 "Move to next heading of the same level, and return point.
19316 If there is no such heading, return nil.
19317 This is like outline-next-sibling, but invisible headings are ok."
19318 (let ((level (funcall outline-level)))
19319 (outline-next-heading)
19320 (while (and (not (eobp)) (> (funcall outline-level) level))
19321 (outline-next-heading))
19322 (if (or (eobp) (< (funcall outline-level) level))
19323 nil
19324 (point))))
19326 (defun org-get-last-sibling ()
19327 "Move to previous heading of the same level, and return point.
19328 If there is no such heading, return nil."
19329 (let ((opoint (point))
19330 (level (funcall outline-level)))
19331 (outline-previous-heading)
19332 (when (and (/= (point) opoint) (outline-on-heading-p t))
19333 (while (and (> (funcall outline-level) level)
19334 (not (bobp)))
19335 (outline-previous-heading))
19336 (if (< (funcall outline-level) level)
19337 nil
19338 (point)))))
19340 (defun org-end-of-subtree (&optional invisible-OK to-heading)
19341 ;; This contains an exact copy of the original function, but it uses
19342 ;; `org-back-to-heading', to make it work also in invisible
19343 ;; trees. And is uses an invisible-OK argument.
19344 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
19345 ;; Furthermore, when used inside Org, finding the end of a large subtree
19346 ;; with many children and grandchildren etc, this can be much faster
19347 ;; than the outline version.
19348 (org-back-to-heading invisible-OK)
19349 (let ((first t)
19350 (level (funcall outline-level)))
19351 (if (and (org-mode-p) (< level 1000))
19352 ;; A true heading (not a plain list item), in Org-mode
19353 ;; This means we can easily find the end by looking
19354 ;; only for the right number of stars. Using a regexp to do
19355 ;; this is so much faster than using a Lisp loop.
19357 (forward-char 1)
19358 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
19359 ;; something else, do it the slow way
19360 (while (and (not (eobp))
19361 (or first (> (funcall outline-level) level)))
19362 (setq first nil)
19363 (outline-next-heading)))
19364 (unless to-heading
19366 (progn
19367 ;; Go to end of line before heading
19368 (forward-char -1)
19370 ;; leave blank line before heading
19371 (forward-char -1))))))
19372 (point))
19374 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
19375 "Use Org version in org-mode, for dramatic speed-up."
19376 (if (eq major-mode 'org-mode)
19377 (progn
19378 (org-end-of-subtree nil t)
19379 (unless (eobp) (backward-char 1)))
19380 ad-do-it))
19382 (defun org-forward-same-level (arg &optional invisible-ok)
19383 "Move forward to the arg'th subheading at same level as this one.
19384 Stop at the first and last subheadings of a superior heading.
19385 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
19386 it wil also look at invisible ones."
19387 (interactive "p")
19388 (org-back-to-heading invisible-ok)
19389 (org-on-heading-p)
19390 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19392 l)
19393 (forward-char 1)
19394 (while (> arg 0)
19395 (while (and (re-search-forward re nil 'move)
19396 (setq l (- (match-end 0) (match-beginning 0) 1))
19397 (= l level)
19398 (not invisible-ok)
19399 (progn (backward-char 1) (org-invisible-p)))
19400 (if (< l level) (setq arg 1)))
19401 (setq arg (1- arg)))
19402 (beginning-of-line 1)))
19404 (defun org-backward-same-level (arg &optional invisible-ok)
19405 "Move backward to the arg'th subheading at same level as this one.
19406 Stop at the first and last subheadings of a superior heading."
19407 (interactive "p")
19408 (org-back-to-heading)
19409 (org-on-heading-p)
19410 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19412 l)
19413 (while (> arg 0)
19414 (while (and (re-search-backward re nil 'move)
19415 (setq l (- (match-end 0) (match-beginning 0) 1))
19416 (= l level)
19417 (not invisible-ok)
19418 (org-invisible-p))
19419 (if (< l level) (setq arg 1)))
19420 (setq arg (1- arg)))))
19422 (defun org-show-subtree ()
19423 "Show everything after this heading at deeper levels."
19424 (outline-flag-region
19425 (point)
19426 (save-excursion
19427 (org-end-of-subtree t t))
19428 nil))
19430 (defun org-show-entry ()
19431 "Show the body directly following this heading.
19432 Show the heading too, if it is currently invisible."
19433 (interactive)
19434 (save-excursion
19435 (condition-case nil
19436 (progn
19437 (org-back-to-heading t)
19438 (outline-flag-region
19439 (max (point-min) (1- (point)))
19440 (save-excursion
19441 (if (re-search-forward
19443 (match-beginning 1)
19444 (point-max)))
19445 nil)
19446 (org-cycle-hide-drawers 'children))
19447 (error nil))))
19449 (defun org-make-options-regexp (kwds &optional extra)
19450 "Make a regular expression for keyword lines."
19451 (concat
19452 "^"
19459 ;; Make isearch reveal the necessary context
19460 (defun org-isearch-end ()
19461 "Reveal context after isearch exits."
19462 (when isearch-success ; only if search was successful
19463 (if (featurep 'xemacs)
19464 ;; Under XEmacs, the hook is run in the correct place,
19465 ;; we directly show the context.
19466 (org-show-context 'isearch)
19467 ;; In Emacs the hook runs *before* restoring the overlays.
19468 ;; So we have to use a one-time post-command-hook to do this.
19469 ;; (Emacs 22 has a special variable, see function `org-mode')
19470 (unless (and (boundp 'isearch-mode-end-hook-quit)
19471 isearch-mode-end-hook-quit)
19472 ;; Only when the isearch was not quitted.
19473 (org-add-hook 'post-command-hook 'org-isearch-post-command
19474 'append 'local)))))
19476 (defun org-isearch-post-command ()
19477 "Remove self from hook, and show context."
19478 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
19479 (org-show-context 'isearch))
19482 ;;;; Integration with and fixes for other packages
19484 ;;; Imenu support
19486 (defvar org-imenu-markers nil
19487 "All markers currently used by Imenu.")
19488 (make-variable-buffer-local 'org-imenu-markers)
19490 (defun org-imenu-new-marker (&optional pos)
19491 "Return a new marker for use by Imenu, and remember the marker."
19492 (let ((m (make-marker)))
19493 (move-marker m (or pos (point)))
19494 (push m org-imenu-markers)
19495 m))
19497 (defun org-imenu-get-tree ()
19498 "Produce the index for Imenu."
19499 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
19500 (setq org-imenu-markers nil)
19501 (let* ((n org-imenu-depth)
19502 (re (concat "^" outline-regexp))
19503 (subs (make-vector (1+ n) nil))
19504 (last-level 0)
19505 m level head)
19506 (save-excursion
19507 (save-restriction
19508 (widen)
19509 (goto-char (point-max))
19510 (while (re-search-backward re nil t)
19511 (setq level (org-reduced-level (funcall outline-level)))
19512 (when (<= level n)
19513 (looking-at org-complex-heading-regexp)
19514 (setq head (org-link-display-format
19515 (org-match-string-no-properties 4))
19516 m (org-imenu-new-marker))
19517 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
19518 (if (>= level last-level)
19519 (push (cons head m) (aref subs level))
19520 (push (cons head (aref subs (1+ level))) (aref subs level))
19521 (loop for i from (1+ level) to n do (aset subs i nil)))
19522 (setq last-level level)))))
19523 (aref subs 1)))
19525 (eval-after-load "imenu"
19526 '(progn
19527 (add-hook 'imenu-after-jump-hook
19528 (lambda ()
19529 (if (eq major-mode 'org-mode)
19530 (org-show-context 'org-goto))))))
19532 (defun org-link-display-format (link)
19533 "Replace a link with either the description, or the link target
19534 if no description is present"
19535 (save-match-data
19536 (if (string-match org-bracket-link-analytic-regexp link)
19537 (replace-match (if (match-end 5)
19538 (match-string 5 link)
19539 (concat (match-string 1 link)
19540 (match-string 3 link)))
19541 nil t link)
19542 link)))
19544 ;; Speedbar support
19546 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
19547 "Overlay marking the agenda restriction line in speedbar.")
19548 (overlay-put org-speedbar-restriction-lock-overlay
19549 'face 'org-agenda-restriction-lock)
19550 (overlay-put org-speedbar-restriction-lock-overlay
19551 'help-echo "Agendas are currently limited to this item.")
19552 (org-detach-overlay org-speedbar-restriction-lock-overlay)
19554 (defun org-speedbar-set-agenda-restriction ()
19555 "Restrict future agenda commands to the location at point in speedbar.
19557 (interactive)
19558 (require 'org-agenda)
19559 (let (p m tp np dir txt)
19560 (cond
19561 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19562 'org-imenu t))
19563 (setq m (get-text-property p 'org-imenu-marker))
19564 (with-current-buffer (marker-buffer m)
19565 (goto-char m)
19566 (org-agenda-set-restriction-lock 'subtree)))
19567 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19568 'speedbar-function 'speedbar-find-file))
19569 (setq tp (previous-single-property-change
19570 (1+ p) 'speedbar-function)
19571 np (next-single-property-change
19572 tp 'speedbar-function)
19573 dir (speedbar-line-directory)
19574 txt (buffer-substring-no-properties (or tp (point-min))
19575 (or np (point-max))))
19576 (with-current-buffer (find-file-noselect
19577 (let ((default-directory dir))
19578 (expand-file-name txt)))
19579 (unless (org-mode-p)
19580 (error "Cannot restrict to non-Org-mode file"))
19581 (org-agenda-set-restriction-lock 'file)))
19582 (t (error "Don't know how to restrict Org-mode's agenda")))
19583 (move-overlay org-speedbar-restriction-lock-overlay
19584 (point-at-bol) (point-at-eol))
19585 (setq current-prefix-arg nil)
19586 (org-agenda-maybe-redo)))
19588 (eval-after-load "speedbar"
19589 '(progn
19590 (speedbar-add-supported-extension ".org")
19591 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
19592 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
19593 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
19594 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19595 (add-hook 'speedbar-visiting-tag-hook
19596 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
19598 ;;; Fixes and Hacks for problems with other packages
19600 ;; Make flyspell not check words in links, to not mess up our keymap
19601 (defun org-mode-flyspell-verify ()
19602 "Don't let flyspell put overlays at active buttons."
19603 (and (not (get-text-property (max (1- (point)) (point-min)) 'keymap))
19604 (not (get-text-property (max (1- (point)) (point-min)) 'org-no-flyspell))))
19606 (defun org-remove-flyspell-overlays-in (beg end)
19607 "Remove flyspell overlays in region."
19608 (and (org-bound-and-true-p flyspell-mode)
19609 (fboundp 'flyspell-delete-region-overlays)
19610 (flyspell-delete-region-overlays beg end))
19611 (add-text-properties beg end '(org-no-flyspell t)))
19613 ;; Make `bookmark-jump' shows the jump location if it was hidden.
19614 (eval-after-load "bookmark"
19615 '(if (boundp 'bookmark-after-jump-hook)
19616 ;; We can use the hook
19617 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
19618 ;; Hook not available, use advice
19619 (defadvice bookmark-jump (after org-make-visible activate)
19620 "Make the position visible."
19621 (org-bookmark-jump-unhide))))
19623 ;; Make sure saveplace shows the location if it was hidden
19624 (eval-after-load "saveplace"
19625 '(defadvice save-place-find-file-hook (after org-make-visible activate)
19626 "Make the position visible."
19627 (org-bookmark-jump-unhide)))
19629 ;; Make sure ecb shows the location if it was hidden
19630 (eval-after-load "ecb"
19631 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
19632 "Make hierarchy visible when jumping into location from ECB tree buffer."
19633 (if (eq major-mode 'org-mode)
19634 (org-show-context))))
19636 (defun org-bookmark-jump-unhide ()
19637 "Unhide the current position, to show the bookmark location."
19638 (and (org-mode-p)
19639 (or (org-invisible-p)
19640 (save-excursion (goto-char (max (point-min) (1- (point))))
19641 (org-invisible-p)))
19642 (org-show-context 'bookmark-jump)))
19644 ;; Make session.el ignore our circular variable
19645 (eval-after-load "session"
19646 '(add-to-list 'session-globals-exclude 'org-mark-ring))
19648 ;;;; Experimental code
19650 (defun org-closed-in-range ()
19651 "Sparse tree of items closed in a certain time range.
19652 Still experimental, may disappear in the future."
19653 (interactive)
19654 ;; Get the time interval from the user.
19655 (let* ((time1 (org-float-time
19656 (org-read-date nil 'to-time nil "Starting date: ")))
19657 (time2 (org-float-time
19658 (org-read-date nil 'to-time nil "End date:")))
19659 ;; callback function
19660 (callback (lambda ()
19661 (let ((time
19662 (org-float-time
19663 (apply 'encode-time
19664 (org-parse-time-string
19665 (match-string 1))))))
19666 ;; check if time in interval
19667 (and (>= time time1) (<= time time2))))))
19668 ;; make tree, check each match with the callback
19671 ;;;; Finish up
19673 (provide 'org)
19675 (run-hooks 'org-load-hook)
19677 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
19679 ;;; org.el ends here