| blob | bff345b3c8a700573851aad2fc1c7b28531f4e24 |
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, 2011
4 ;; Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.4
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
28 ;;
29 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
30 ;; project planning with a fast and effective plain-text system.
31 ;;
32 ;; Org-mode develops organizational tasks around NOTES files that contain
33 ;; information about projects as plain text. Org-mode is implemented on
34 ;; top of outline-mode, which makes it possible to keep the content of
35 ;; large files well structured. Visibility cycling and structure editing
36 ;; help to work with the tree. Tables are easily created with a built-in
37 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
38 ;; and scheduling. It dynamically compiles entries into an agenda that
39 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
40 ;; Plain text URL-like links connect to websites, emails, Usenet
41 ;; messages, BBDB entries, and any files related to the projects. For
42 ;; printing and sharing of notes, an Org-mode file can be exported as a
43 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
44 ;; iCalendar file. It can also serve as a publishing tool for a set of
45 ;; linked webpages.
46 ;;
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
50 ;;
51 ;; http://orgmode.org/org.html#Installation
52 ;;
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org-mode can be found in the TeXInfo file. The
56 ;; distribution also contains a PDF version of it. At the homepage of
57 ;; Org-mode, you can read the same text online as HTML. There is also an
58 ;; excellent reference card made by Philip Rooke. This card can be found
59 ;; in the etc/ directory of Emacs 22.
60 ;;
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
63 ;;
64 ;;; Code:
71 ;;;; Require other packages
79 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
91 ;; Other stuff we need.
106 ;; babel
115 ;; load languages based on value of `org-babel-load-languages'
117 ;;;###autoload
119 "Load the languages defined in `org-babel-load-languages'."
131 org-babel-load-languages))
134 "Languages which can be evaluated in Org-mode buffers.
135 This list can be used to load support for any of the languages
136 below, note that each language will depend on a different set of
137 system executables and/or Emacs modes. When a language is
139 with `org-babel-execute-src-block' bound by default to C-c
140 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
141 be set to remove code block evaluation from the C-c C-c
142 keybinding. By default only Emacs Lisp (which has no
143 requirements) is loaded."
147 :key-type
180 ;;;; Customization variables
182 "Remove ID property of clones of a subtree.
183 When non-nil, clones of a subtree don't inherit the ID property.
184 Otherwise they inherit the ID property with a new unique
185 identifier."
189 ;;; Version
195 "Show the org-mode version in the echo area.
196 With prefix arg HERE, insert it at point."
222 ;;; Compatibility constants
224 ;;; The custom variables
227 "Outline-based notes management and organizer."
233 "Mode hook for Org-mode, run after the mode was turned on."
238 "Hook that is run after org.el has been loaded."
247 "Load all extensions listed in `org-modules'."
252 org-modules)
256 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
265 (defcustom org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
266 "Modules that should always be loaded together with org.el.
267 If a description starts with <C>, the file is not part of Emacs
268 and loading it will require that you have downloaded and properly installed
269 the org-mode distribution.
271 You can also use this system to load external packages (i.e. neither Org
272 core modules, nor modules from the CONTRIB directory). Just add symbols
273 to the end of the list. If the package is called org-xyz.el, then you need
274 to add the symbol `xyz', and the package must have a call to
276 (provide 'org-xyz)"
279 :type
310 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
318 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
327 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
343 "Non-nil means make shift-cursor commands select text when possible.
345 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
346 selecting a region, or enlarge regions started in this way.
347 In Org-mode, in special contexts, these same keys are used for other
348 purposes, important enough to compete with shift selection. Org tries
349 to balance these needs by supporting `shift-select-mode' outside these
350 special contexts, under control of this variable.
352 The default of this variable is nil, to avoid confusing behavior. Shifted
353 cursor keys will then execute Org commands in the following contexts:
354 - on a headline, changing TODO state (left/right) and priority (up/down)
355 - on a time stamp, changing the time
356 - in a plain list item, changing the bullet type
357 - in a property definition line, switching between allowed values
358 - in the BEGIN line of a clock table (changing the time block).
359 Outside these contexts, the commands will throw an error.
361 When this variable is t and the cursor is not in a special context,
362 Org-mode will support shift-selection for making and enlarging regions.
363 To make this more effective, the bullet cycling will no longer happen
364 anywhere in an item line, but only if the cursor is exactly on the bullet.
366 If you set this variable to the symbol `always', then the keys
367 will not be special in headlines, property lines, and item lines, to make
368 shift selection work there as well. If this is what you want, you can
369 use the following alternative commands: `C-c C-t' and `C-c ,' to
370 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
371 TODO sets, `C-c -' to cycle item bullet types, and properties can be
372 edited by hand or in column view.
374 However, when the cursor is on a timestamp, shift-cursor commands
375 will still edit the time stamp - this is just too good to give up.
377 XEmacs user should have this variable set to nil, because shift-select-mode
378 is Emacs 23 only."
386 "Options concerning startup of Org-mode."
391 "Non-nil means entering Org-mode will switch to OVERVIEW.
392 This can also be configured on a per-file basis by adding one of
393 the following lines anywhere in the buffer:
395 #+STARTUP: fold (or `overview', this is equivalent)
396 #+STARTUP: nofold (or `showall', this is equivalent)
397 #+STARTUP: content
398 #+STARTUP: showeverything"
407 "Non-nil means entering Org-mode will set `truncate-lines'.
408 This is useful since some lines containing links can be very long and
409 uninteresting. Also tables look terrible when wrapped."
414 "Non-nil means turn on `org-indent-mode' on startup.
415 This can also be configured on a per-file basis by adding one of
416 the following lines anywhere in the buffer:
418 #+STARTUP: indent
419 #+STARTUP: noindent"
427 When this option is turned on, you can use TeX-like syntax for sub- and
429 considered as a single item - so grouping with {} is normally not
430 needed. For example, the following things will be parsed as single
431 sub- or superscripts.
433 10^24 or 10^tau several digits will be considered 1 item.
434 10^-12 or 10^-tau a leading sign with digits or a word
435 x^2-y^3 will be read as x^2 - y^3, because items are
436 terminated by almost any nonword/nondigit char.
437 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
439 Still, ambiguity is possible - so when in doubt use {} to enclose the
440 sub/superscript. If you set this variable to the symbol `{}',
441 the braces are *required* in order to trigger interpretations as
443 frequently in plain text.
445 Not all export backends support this, but HTML does.
460 "Non-nil means turn on `org-beamer-mode' on startup.
461 This can also be configured on a per-file basis by adding one of
462 the following lines anywhere in the buffer:
464 #+STARTUP: beamer"
469 "Non-nil means align all tables when visiting a file.
470 This is useful when the column width in tables is forced with <N> cookies
471 in table fields. Such tables will look correct only after the first re-align.
472 This can also be configured on a per-file basis by adding one of
473 the following lines anywhere in the buffer:
474 #+STARTUP: align
475 #+STARTUP: noalign"
480 "Non-nil means show inline images when loading a new Org file.
481 This can also be configured on a per-file basis by adding one of
482 the following lines anywhere in the buffer:
483 #+STARTUP: inlineimages
484 #+STARTUP: noinlineimages"
489 "Non-nil means insert the first line setting Org-mode in empty files.
490 When the function `org-mode' is called interactively in an empty file, this
491 normally means that the file name does not automatically trigger Org-mode.
492 To ensure that the file will always be in Org-mode in the future, a
493 line enforcing Org-mode will be inserted into the buffer, if this option
494 has been set."
499 "Non-nil means use alternative key bindings for some keys.
500 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
501 These keys are also used by other packages like shift-selection-mode'
502 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
503 If you want to use Org-mode together with one of these other modes,
504 or more generally if you would like to move some Org-mode commands to
505 other keys, set this variable and configure the keys with the variable
506 `org-disputed-keys'.
508 This option is only relevant at load-time of Org-mode, and must be set
509 *before* org.el is loaded. Changing it requires a restart of Emacs to
510 become effective."
515 "Non-nil means use extra key sequence definitions for certain commands.
516 This happens automatically if you run XEmacs or if `window-system'
517 is nil. This variable lets you do the same manually. You must
518 set it before loading org.
520 Example: on Carbon Emacs 22 running graphically, with an external
521 keyboard on a Powerbook, the default way of setting M-left might
522 not work for either Alt or ESC. Setting this variable will make
523 it work for ESC."
537 "Keys for which Org-mode and other modes compete.
538 This is an alist, cars are the default keys, second element specifies
539 the alternative to use when `org-replace-disputed-keys' is t.
541 Keys can be specified in any syntax supported by `define-key'.
542 The value of this option takes effect only at Org-mode's startup,
543 therefore you'll have to restart Emacs to apply it after changing."
548 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
549 Or return the original if not disputed.
550 Also apply the translations defined in `org-xemacs-key-equivalents'."
555 org-disputed-keys)))
559 key)
569 "Define a key, possibly translated, as returned by `org-key'."
573 "The ellipsis to use in the Org-mode outline.
574 When nil, just use the standard three dots. When a string, use that instead,
575 When a face, use the standard 3 dots, but with the specified face.
576 The change affects only Org-mode (which will then use its own display table).
577 Changing this requires executing `M-x org-mode' in a buffer to become
578 effective."
588 "Keywords in Org-mode."
593 "String to mark deadline entries.
594 A deadline is this string, followed by a time stamp. Should be a word,
595 terminated by a colon. You can insert a schedule keyword and
597 Changes become only effective after restarting Emacs."
602 "String to mark scheduled TODO entries.
603 A schedule is this string, followed by a time stamp. Should be a word,
604 terminated by a colon. You can insert a schedule keyword and
606 Changes become only effective after restarting Emacs."
611 "String used as the prefix for timestamps logging closing a TODO entry."
616 "String used as prefix for timestamps clocking work hours on an item."
621 "Entries starting with this keyword will never be exported.
622 An entry can be toggled between COMMENT and normal with
624 Changes become only effective after restarting Emacs."
629 "Entries starting with this keyword will be exported in fixed-width font.
630 Quoting applies only to the text in the entry following the headline, and does
631 not extend beyond the next headline, even if that is lower level.
632 An entry can be toggled between QUOTE and normal with
639 "Regular expression for specifying repeated events.
643 "Options concerning the general structure of Org-mode files."
648 "Options about how to make context of a location visible."
672 "Non-nil means show full hierarchy when revealing a location.
673 Org-mode often shows locations in an org-mode file which might have
674 been invisible before. When this is set, the hierarchy of headings
675 above the exposed location is shown.
676 Turning this off for example for sparse trees makes them very compact.
677 Instead of t, this can also be an alist specifying this option for different
678 contexts. Valid contexts are
679 agenda when exposing an entry from the agenda
680 org-goto when using the command `org-goto' on key C-c C-j
681 occur-tree when using the command `org-occur' on key C-c /
682 tags-tree when constructing a sparse tree based on tags matches
683 link-search when exposing search matches associated with a link
684 mark-goto when exposing the jump goal of a mark
685 bookmark-jump when exposing a bookmark location
686 isearch when exiting from an incremental search
687 default default for all contexts not set explicitly"
692 "Non-nil means show following heading when revealing a location.
693 Org-mode often shows locations in an org-mode file which might have
694 been invisible before. When this is set, the heading following the
695 match is shown.
696 Turning this off for example for sparse trees makes them very compact,
697 but makes it harder to edit the location of the match. In such a case,
699 Instead of t, this can also be an alist specifying this option for different
700 contexts. See `org-show-hierarchy-above' for valid contexts."
705 "Non-nil means show all sibling heading when revealing a location.
706 Org-mode often shows locations in an org-mode file which might have
707 been invisible before. When this is set, the sibling of the current entry
708 heading are all made visible. If `org-show-hierarchy-above' is t,
709 the same happens on each level of the hierarchy above the current entry.
711 By default this is on for the isearch context, off for all other contexts.
712 Turning this off for example for sparse trees makes them very compact,
713 but makes it harder to edit the location of the match. In such a case,
715 Instead of t, this can also be an alist specifying this option for different
716 contexts. See `org-show-hierarchy-above' for valid contexts."
721 "Non-nil means show the entry below a headline when revealing a location.
722 Org-mode often shows locations in an org-mode file which might have
723 been invisible before. When this is set, the text below the headline that is
724 exposed is also shown.
726 By default this is off for all contexts.
727 Instead of t, this can also be an alist specifying this option for different
728 contexts. See `org-show-hierarchy-above' for valid contexts."
733 "How should indirect tree buffers be displayed?
734 This applies to indirect buffers created with the commands
736 Valid values are:
737 current-window Display in the current window
738 other-window Just display in another window.
739 dedicated-frame Create one new frame, and re-use it each time.
740 new-frame Make a new frame each time. Note that in this case
741 previously-made indirect buffers are kept, and you need to
742 kill these buffers yourself."
752 "Non-nil means activate single letter commands at beginning of a headline.
753 This may also be a function to test for appropriate locations where speed
754 commands should be active."
762 "Alist of additional speed commands.
763 This list will be checked before `org-speed-commands-default'
764 when the variable `org-use-speed-commands' is non-nil
765 and when the cursor is at the beginning of a headline.
766 The car if each entry is a string with a single letter, which must
767 be assigned to `self-insert-command' in the global map.
768 The cdr is either a command to be called interactively, a function
769 to be called, or a form to be evaluated.
770 An entry that is just a list with a single string will be interpreted
771 as a descriptive headline that will be added when listing the speed
772 commands in the Help buffer using the `?' speed command."
784 "Options concerning visibility cycling in Org-mode."
789 "Non-nil means skip CHILDREN state in entries that don't have any."
794 "Maximum level which should still be subject to visibility cycling.
795 Levels higher than this will, for cycling, be treated as text, not a headline.
796 When `org-odd-levels-only' is set, a value of N in this variable actually
797 means 2N-1 stars as the limiting headline.
798 When nil, cycle all levels.
799 Note that the limiting level of cycling is also influenced by
800 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
801 `org-inlinetask-min-level' is, cycling will be limited to levels one less
802 than its value."
809 "Names of drawers. Drawers are not opened by cycling on the headline above.
810 Drawers only open with a TAB on the drawer line itself. A drawer looks like
811 this:
812 :DRAWERNAME:
813 .....
814 :END:
816 the property API.
818 Drawers can be defined on the per-file basis with a line like:
820 #+DRAWERS: HIDDEN STATE PROPERTIES"
826 "Non-nil means entering Org-mode will fold all blocks.
827 This can also be set in on a per-file basis with
829 #+STARTUP: hideblocks
830 #+STARTUP: showblocks"
836 "Cycle globally if cursor is at beginning of buffer and not at a headline.
837 This makes it possible to do global cycling without having to use S-TAB or
839 of the buffer
840 must not be a headline - it may be empty or some other text. When used in
841 this way, `org-cycle-hook' is disables temporarily, to make sure the
842 cursor stays at the beginning of the buffer.
843 When this option is nil, don't do anything special at the beginning
844 of the buffer."
849 "Non-nil means cycle entry level or item indentation in new empty entries.
851 When the cursor is at the end of an empty headline, i.e with only stars
852 and maybe a TODO keyword, TAB will then switch the entry to become a child,
853 and then all possible ancestor states, before returning to the original state.
854 This makes data entry extremely fast: M-RET to create a new headline,
855 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
857 When the cursor is at the end of an empty plain list item, one TAB will
858 make it a subitem, two or more tabs will back up to make this an item
859 higher up in the item hierarchy."
864 "Where should `org-cycle' emulate TAB.
865 nil Never
866 white Only in completely white lines
867 whitestart Only at the beginning of lines, before the first non-white char
868 t Everywhere except in headlines
869 exc-hl-bol Everywhere except at the start of a headline
870 If TAB is used in a place where it does not emulate TAB, the current subtree
871 visibility is cycled."
878 ))
881 "Number of empty lines needed to keep an empty line between collapsed trees.
882 If you leave an empty line between the end of a subtree and the following
883 headline, this empty line is hidden when the subtree is folded.
884 Org-mode will leave (exactly) one empty line visible if the number of
885 empty lines is equal or larger to the number given in this variable.
886 So the default 2 means at least 2 empty lines after the end of a subtree
887 are needed to produce free space between a collapsed subtree and the
888 following headline.
890 If the number is negative, and the number of empty lines is at least -N,
891 all empty lines are shown.
893 Special case: when 0, never leave empty lines in collapsed view."
899 "Hook that is run before visibility cycling is happening.
900 The function(s) in this hook must accept a single argument which indicates
901 the new state that will be set right after running this hook. The
902 argument is a symbol. Before a global state change, it can have the values
903 `overview', `content', or `all'. Before a local state change, it can have
904 the values `folded', `children', or `subtree'."
909 org-cycle-hide-drawers
910 org-cycle-show-empty-lines
911 org-optimize-window-after-visibility-change)
912 "Hook that is run after `org-cycle' has changed the buffer visibility.
913 The function(s) in this hook must accept a single argument which indicates
914 the new state that was set by the most recent `org-cycle' command. The
915 argument is a symbol. After a global state change, it can have the values
916 `overview', `content', or `all'. After a local state change, it can have
917 the values `folded', `children', or `subtree'."
922 "Options concerning structure editing in Org-mode."
927 "Non-nil means skip even levels and only use odd levels for the outline.
928 This has the effect that two stars are being added/taken away in
929 promotion/demotion commands. It also influences how levels are
930 handled by the exporters.
931 Changing it requires restart of `font-lock-mode' to become effective
932 for fontification also in regions already fontified.
933 You may also set this on a per-file basis by adding one of the following
934 lines to the buffer:
936 #+STARTUP: odd
937 #+STARTUP: oddeven"
943 "Non-nil means adapt indentation to outline node level.
945 When this variable is set, Org assumes that you write outlines by
946 indenting text in each node to align with the headline (after the stars).
947 The following issues are influenced by this variable:
949 - When this is set and the *entire* text in an entry is indented, the
950 indentation is increased by one space in a demotion command, and
951 decreased by one in a promotion command. If any line in the entry
952 body starts with text at column 0, indentation is not changed at all.
954 - Property drawers and planning information is inserted indented when
955 this variable s set. When nil, they will not be indented.
957 - TAB indents a line relative to context. The lines below a headline
958 will be indented when this variable is set.
960 Note that this is all about true indentation, by adding and removing
961 space characters. See also `org-indent.el' which does level-dependent
962 indentation in a virtual way, i.e. at display time in Emacs."
967 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
969 When t, `C-a' will bring back the cursor to the beginning of the
970 headline text, i.e. after the stars and after a possible TODO keyword.
971 In an item, this will be the position after the bullet.
972 When the cursor is already at that position, another `C-a' will bring
973 it to the beginning of the line.
975 `C-e' will jump to the end of the headline, ignoring the presence of tags
976 in the headline. A second `C-e' will then jump to the true end of the
977 line, after any tags. This also means that, when this variable is
978 non-nil, `C-e' also will never jump beyond the end of the heading of a
979 folded section, i.e. not after the ellipses.
981 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
982 going to the true line boundary first. Only a directly following, identical
983 keypress will bring the cursor to the special positions.
985 This may also be a cons cell where the behavior for `C-a' and `C-e' is
986 set separately."
1005 "Non-nil means `C-k' will behave specially in headlines.
1006 When nil, `C-k' will call the default `kill-line' command.
1007 When t, the following will happen while the cursor is in the headline:
1009 - When the cursor is at the beginning of a headline, kill the entire
1010 line and possible the folded subtree below the line.
1011 - When in the middle of the headline text, kill the headline up to the tags.
1012 - When after the headline text, kill the tags."
1017 "Non-nil means, do not delete a hidden subtree with C-k.
1018 When set to the symbol `error', simply throw an error when C-k is
1019 used to kill (part-of) a headline that has hidden text behind it.
1020 Any other non-nil value will result in a query to the user, if it is
1021 OK to kill that hidden subtree. When nil, kill without remorse."
1029 "Non-nil means when yanking subtrees, fold them.
1030 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1031 it starts with a heading and all other headings in it are either children
1032 or siblings, then fold all the subtrees. However, do this only if no
1033 text after the yank would be swallowed into a folded tree by this action."
1038 "Non-nil means when yanking subtrees, adjust the level.
1039 With this setting, `org-paste-subtree' is used to insert the subtree, see
1040 this function for details."
1045 "Non-nil means M-RET will split the line at the cursor position.
1046 When nil, it will go to the end of the line before making a
1047 new line.
1048 You may also set this option in a different way for different
1049 contexts. Valid contexts are:
1051 headline when creating a new headline
1052 item when creating a new item
1053 table in a table field
1054 default the value to be used for all contexts not explicitly
1055 customized"
1072 "Non-nil means insert new headings after the current subtree.
1073 When nil, the new heading is created directly after the current line.
1076 for the duration of the command."
1082 "Should `org-insert-heading' leave a blank line before new heading/item?
1083 The value is an alist, with `heading' and `plain-list-item' as car,
1084 and a boolean flag as cdr. The cdr may also be the symbol `auto', and then
1085 Org will look at the surrounding headings/items and try to make an
1086 intelligent decision whether to insert a blank line or not.
1088 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1089 set, the setting here is ignored and no empty line is inserted, to avoid
1090 breaking the list structure."
1103 "Hook being run after inserting a new heading."
1109 This currently only means they are never auto-wrapped.
1110 When nil, such lines will be treated like ordinary lines.
1111 See also the QUOTE keyword."
1116 "Non-nil means typing characters in `org-goto' starts incremental search."
1121 "Options concerning sparse trees in Org-mode."
1126 "Non-nil means highlight all matches that define a sparse tree.
1127 The highlights will automatically disappear the next time the buffer is
1128 changed by an edit command."
1133 "Non-nil means any change to the buffer will remove temporary highlights.
1134 Such highlights are created by `org-occur' and `org-clock-display'.
1135 When nil, `C-c C-c needs to be used to get rid of the highlights.
1136 The highlights created by `org-preview-latex-fragment' always need
1137 `C-c C-c' to be removed."
1144 "Hook that is run after `org-occur' has constructed a sparse tree.
1145 This can be used to recenter the window to show as much of the structure
1146 as possible."
1151 "Options concerning imenu and speedbar in Org-mode."
1156 "The maximum level for Imenu access to Org-mode headlines.
1157 This also applied for speedbar access."
1162 "Options concerning tables in Org-mode."
1168 When nil, such lines will be treated like ordinary lines.
1170 When equal to the symbol `optimized', the table editor will be optimized to
1171 do the following:
1172 - Automatic overwrite mode in front of whitespace in table fields.
1173 This makes the structure of the table stay in tact as long as the edited
1174 field does not exceed the column width.
1175 - Minimize the number of realigns. Normally, the table is aligned each time
1176 TAB or RET are pressed to move to another field. With optimization this
1177 happens only if changes to a field might have changed the column width.
1178 Optimization requires replacing the functions `self-insert-command',
1179 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1180 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1181 very good at guessing when a re-align will be necessary, but you can always
1184 If you would like to use the optimized version in Org-mode, but the
1185 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1187 This variable can be used to turn on and off the table editor during a session,
1188 but in order to toggle optimization, a restart is required.
1190 See also the variable `org-table-auto-blank-field'."
1198 "Non-nil means cluster self-insert commands for undo when possible.
1199 If this is set, then, like in the Emacs command loop, 20 consecutive
1200 characters will be undone together.
1201 This is configurable, because there is some impact on typing performance."
1206 "Non-nil means TAB will automatically notice a table.el table.
1207 When it sees such a table, it moves point into it and - if necessary -
1208 calls `table-recognize-table'."
1213 "Options concerning links in Org-mode."
1218 "Buffer-local version of `org-link-abbrev-alist', which see.
1223 "Alist of link abbreviations.
1224 The car of each element is a string, to be replaced at the start of a link.
1226 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1228 [[linkkey:tag][description]]
1230 The 'linkkey' must be a word word, starting with a letter, followed
1231 by letters, numbers, '-' or '_'.
1233 If REPLACE is a string, the tag will simply be appended to create the link.
1236 be inserted at that point (see the function `url-hexify-string').
1238 REPLACE may also be a function that will be called with the tag as the
1239 only argument to create the link, which should be returned as a string.
1241 See the manual for examples."
1251 "Non-nil means hide link part and only show description of bracket links.
1252 Bracket links are like [[link][description]]. This variable sets the initial
1253 state in new org-mode buffers. The setting can then be toggled on a
1254 per-buffer basis from the Org->Hyperlinks menu."
1259 "How the path name in file links should be stored.
1260 Valid values are:
1262 relative Relative to the current directory, i.e. the directory of the file
1263 into which the link is being inserted.
1264 absolute Absolute path, if possible with ~ for home directory.
1265 noabbrev Absolute path, no abbreviation of home directory.
1266 adaptive Use relative path for files in the current directory and sub-
1267 directories of it. For other files, use an absolute path."
1276 "Types of links that should be activated in Org-mode files.
1277 This is a list of symbols, each leading to the activation of a certain link
1278 type. In principle, it does not hurt to turn on most link types - there may
1279 be a small gain when turning off unused link types. The types are:
1281 bracket The recommended [[link][description]] or [[link]] links with hiding.
1282 angle Links in angular brackets that may contain whitespace like
1283 <bbdb:Carsten Dominik>.
1284 plain Plain links in normal text, no whitespace, like http://google.com.
1285 radio Text that is matched by a radio target, see manual for details.
1286 tag Tag settings in a headline (link to tag search).
1287 date Time stamps (link to calendar).
1288 footnote Footnote labels.
1290 Changing this variable requires a restart of Emacs to become effective."
1302 "Function to use to generate link descriptions from links.
1303 If nil the link location will be used. This function must take
1304 two parameters; the first is the link and the second the
1305 description `org-insert-link' has generated, and should return the
1306 description to use."
1311 "Options concerning storing links in Org-mode."
1316 "Format of the description part of a link to an email or usenet message.
1317 The following %-escapes will be replaced by corresponding information:
1325 %s subject
1326 %d date
1327 %m message-id.
1329 You may use normal field width specification between the % and the letter.
1330 This is for example useful to limit the length of the subject.
1344 It should match if the message is from the user him/herself."
1349 "Non-nil means storing a link to an Org file will use entry IDs.
1351 Note that before this variable is even considered, org-id must be loaded,
1352 so please customize `org-modules' and turn it on.
1354 The variable can have the following values:
1356 t Create an ID if needed to make a link to the current entry.
1358 create-if-interactive
1359 If `org-store-link' is called directly (interactively, as a user
1360 command), do create an ID to support the link. But when doing the
1361 job for remember, only use the ID if it already exists. The
1362 purpose of this setting is to avoid proliferation of unwanted
1363 IDs, just because you happen to be in an Org file when you
1364 call `org-remember' that automatically and preemptively
1365 creates a link. If you do want to get an ID link in a remember
1366 template to an entry not having an ID, create it first by
1367 explicitly creating a link to it, using `C-c C-l' first.
1369 create-if-interactive-and-no-custom-id
1370 Like create-if-interactive, but do not create an ID if there is
1371 a CUSTOM_ID property defined in the entry. This is the default.
1373 use-existing
1374 Use existing ID, do not create one.
1376 nil Never use an ID to make a link, instead link using a text search for
1377 the headline text."
1382 create-if-interactive)
1384 create-if-interactive-and-no-custom-id)
1389 "Non-nil means file links from `org-store-link' contain context.
1390 A search string will be added to the file name with :: as separator and
1391 used to find the context when the link is activated by the command
1392 `org-open-at-point'. When this option is t, the entire active region
1393 will be placed in the search string of the file link. If set to a
1394 positive integer, only the first n lines of context will be stored.
1397 negates this setting for the duration of the command."
1402 "Non-nil means keep link in list for entire session.
1404 The command `org-store-link' adds a link pointing to the current
1405 location to an internal list. These links accumulate during a session.
1406 The command `org-insert-link' can be used to insert links into any
1407 Org-mode file (offering completion for all stored links). When this
1409 will be removed from the list, to make completing the unused links
1410 more efficient."
1415 "Options concerning following links in Org-mode."
1420 "Function to translate links with different syntax to Org syntax.
1421 This can be used to translate links created for example by the Planner
1422 or emacs-wiki packages to Org syntax.
1423 The function must accept two parameters, a TYPE containing the link
1425 which is everything after the link protocol. It should return a cons
1426 with possibly modified values of type and path.
1427 Org contains a function for this, so if you set this variable to
1428 `org-translate-link-from-planner', you should be able follow many
1429 links created by planner."
1434 "Hook that is run after a link has been followed."
1439 "Non-nil means on links TAB will follow the link.
1440 Needs to be set before org.el is loaded.
1441 This really should not be used, it does not make sense, and the
1442 implementation is bad."
1447 "Non-nil means on links RET will follow the link."
1453 "Non-nil means mouse-1 on a link will follow the link.
1454 A longer mouse click will still set point. Does not work on XEmacs.
1455 Needs to be set before org.el is loaded."
1460 "Number of different positions to be recorded in the ring.
1461 Changing this requires a restart of Emacs to work correctly."
1466 "Non-nil means internal links in Org files must exactly match a headline.
1467 When nil, the link search tries to match a phrase with all words
1468 in the search text."
1474 query-to-create)))
1481 "Setup the frame configuration for following links.
1482 When following a link with Emacs, it may often be useful to display
1483 this link in another window or frame. This variable can be used to
1484 set this up for the different types of links.
1485 For VM, use any of
1486 `vm-visit-folder'
1487 `vm-visit-folder-other-window'
1488 `vm-visit-folder-other-frame'
1489 For Gnus, use any of
1490 `gnus'
1491 `gnus-other-frame'
1492 `org-gnus-no-new-news'
1493 For FILE, use any of
1494 `find-file'
1495 `find-file-other-window'
1496 `find-file-other-frame'
1497 For Wanderlust use any of
1498 `wl'
1499 `wl-other-frame'
1500 For the calendar, use the variable `calendar-setup'.
1501 For BBDB, it is currently only possible to display the matches in
1502 another window."
1526 "Non-nil means use indirect buffer to display infile links.
1527 Activating internal links (from one location in a file to another location
1528 in the same file) normally just jumps to the location. When the link is
1530 is displayed in
1531 another window. When this option is set, the other window actually displays
1532 an indirect buffer clone of the current buffer, to avoid any visibility
1533 changes to the current buffer."
1538 "Non-nil means `org-open-file' will open non-existing files.
1539 When nil, an error will be generated.
1540 This variable applies only to external applications because they
1541 might choke on non-existing files. If the link is to a file that
1542 will be opened in Emacs, the variable is ignored."
1547 "Non-nil means a link to a directory really means to index.org.
1548 When nil, following a directory link will run dired or open a finder/explorer
1549 window on that directory."
1554 "Function and arguments to call for following mailto links.
1555 This is a list with the first element being a Lisp function, and the
1556 remaining elements being arguments to the function. In string arguments,
1557 %a will be replaced by the address, and %s will be replaced by the subject
1558 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1567 "Non-nil means ask for confirmation before executing shell links.
1568 Shell links can be dangerous: just think about a link
1570 [[shell:rm -rf ~/*][Google Search]]
1573 but really it would remove your entire home directory.
1574 Therefore we advise against setting this variable to nil.
1575 Just change it to `y-or-n-p' if you want to confirm with a
1583 'safe-local-variable
1587 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1588 Elisp links can be dangerous: just think about a link
1593 but really it would remove your entire home directory.
1594 Therefore we advise against setting this variable to nil.
1595 Just change it to `y-or-n-p' if you want to confirm with a
1603 'safe-local-variable
1610 "Default file applications on a UNIX or GNU/Linux system.
1621 "Default file applications on a MacOS X system.
1623 for some files for which the OS does not have a good default.
1631 'mswindows-shell-execute
1636 'mswindows-shell-execute
1639 "Default file applications on a Windows NT system.
1644 '(
1649 )
1650 "External applications for opening `file:path' items in a document.
1651 Org-mode uses system defaults for different file types, but
1652 you can use this variable to set the application for a given file
1653 extension. The entries in this list are cons cells where the car identifies
1654 files and the cdr the corresponding command. Possible values for the
1655 file identifier are
1657 ways, depending on its contents:
1659 - Alphanumeric characters only:
1660 Match links with this file extension.
1662 to open PDFs with evince.
1664 - Regular expression: Match links where the
1665 filename matches the regexp. If you want to
1666 use groups here, use shy groups.
1670 to open *.html and *.xhtml with firefox.
1672 - Regular expression which contains (non-shy) groups:
1674 anything after that, matches the regexp.
1675 In a custom command string, %1, %2, etc. are replaced with
1676 the parts of the link that were matched by the groups.
1677 For backwards compatibility, if a command string is given
1678 that does not use any of the group matches, this case is
1679 handled identically to the second one (i.e. match against
1680 file name only).
1681 In a custom lisp form, you can access the group matches with
1682 (match-string n link).
1685 to open [[file:document.pdf::5]] with evince at page 5.
1687 `directory' Matches a directory
1688 `remote' Matches a remote file, accessible through tramp or efs.
1689 Remote files most likely should be visited through Emacs
1690 because external applications cannot handle such paths.
1691 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1692 so all files Emacs knows how to handle. Using this with
1693 command `emacs' will open most files in Emacs. Beware that this
1694 will also open html files inside Emacs, unless you add
1696 t Default for files not matched by any of the other options.
1697 `system' The system command to open files, like `open' on Windows
1698 and Mac OS X, and mailcap under GNU/Linux. This is the command
1699 that will be selected if you call `C-c C-o' with a double
1702 Possible values for the command are:
1703 `emacs' The file will be visited by the current Emacs process.
1704 `default' Use the default application for this file type, which is the
1705 association for t in the list, most likely in the system-specific
1706 part.
1707 This can be used to overrule an unwanted setting in the
1708 system-specific variable.
1710 This command is specified by the entry whose car is `system'.
1711 Most likely, the system-specific version of this variable
1712 does define this command, but you can overrule/replace it
1713 here.
1714 string A command to be executed by a shell; %s will be replaced
1715 by the path to the file.
1716 sexp A Lisp form which will be evaluated. The file path will
1717 be available in the Lisp variable `file'.
1718 For more examples, see the system specific constants
1719 `org-file-apps-defaults-macosx'
1720 `org-file-apps-defaults-windowsnt'
1721 `org-file-apps-defaults-gnu'."
1731 auto-mode))
1742 "Options concerning refiling entries in Org-mode."
1747 "Directory with org files.
1748 This is just a default location to look for Org files. There is no need
1749 at all to put your files into this directory. It is only used in the
1750 following situations:
1752 1. When a remember template specifies a target file that is not an
1753 absolute path. The path will then be interpreted relative to
1754 `org-directory'
1755 2. When a remember note is filed away in an interactive way (when exiting the
1756 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1757 with `org-directory' as the default path."
1763 "Default target for storing notes.
1764 Used as a fall back file for org-remember.el and org-capture.el, for
1765 templates that do not specify a target file."
1770 file))
1773 "The default interface to be used for `org-goto'.
1774 Allowed values are:
1775 outline The interface shows an outline of the relevant file
1776 and the correct heading is found by moving through
1777 the outline or by searching with incremental search.
1778 outline-path-completion Headlines in the current buffer are offered via
1779 completion. This is the interface also used by
1780 the refile command."
1787 "Maximum target level when running `org-goto' with refile interface."
1792 "Non-nil means store new notes at the beginning of a file or entry.
1793 When nil, new notes will be filed to the end of a file or entry.
1794 This can also be a list with cons cells of regular expressions that
1795 are matched against file names, and values."
1805 "Information to record when a task is refiled.
1807 Possible values are:
1809 nil Don't add anything
1810 time Add a time stamp to the task
1811 note Prompt for a note and add it with template `org-log-note-headings'
1813 This option can also be set with on a per-file-basis with
1815 #+STARTUP: nologrefile
1816 #+STARTUP: logrefile
1817 #+STARTUP: lognoterefile
1819 You can have local logging settings for a subtree by setting the LOGGING
1820 property to one or more of these keywords.
1822 When bulk-refiling from the agenda, the value `note' is forbidden and
1823 will temporarily be changed to `time'."
1833 This is list of cons cells. Each cell contains:
1834 - a specification of the files to be considered, either a list of files,
1835 or a symbol whose function or variable value will be used to retrieve
1836 a file name or a list of file names. If you use `org-agenda-files' for
1837 that, all agenda files will be scanned for targets. Nil means consider
1838 headings in the current buffer.
1839 - A specification of how to find candidate refile targets. This may be
1840 any of:
1842 This tag has to be present in all target headlines, inheritance will
1843 not be considered.
1845 todo keyword.
1847 headlines that are refiling targets.
1848 - a cons cell (:level . N). Any headline of level N is considered a target.
1849 Note that, when `org-odd-levels-only' is set, level corresponds to
1850 order in hierarchy, not to the number of stars.
1851 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1852 Note that, when `org-odd-levels-only' is set, level corresponds to
1853 order in hierarchy, not to the number of stars.
1855 You can set the variable `org-refile-target-verify-function' to a function
1856 to verify each headline found by the simple criteria above.
1858 When this variable is nil, all top-level headlines in the current buffer
1859 are used, equivalent to the value `((nil . (:level . 1))'."
1875 "Function to verify if the headline at point should be a refile target.
1876 The function will be called without arguments, with point at the
1877 beginning of the headline. It should return t and leave point
1878 where it is if the headline is a valid target for refiling.
1880 If the target should not be selected, the function must return nil.
1881 In addition to this, it may move point to a place from where the search
1882 should be continued. For example, the function may decide that the entire
1883 subtree of the current entry should be excluded and move point to the end
1884 of the subtree."
1889 "Non-nil means cache refile targets to speed up the process.
1890 The cache for a particular file will be updated automatically when
1891 the buffer has been killed, or when any of the marker used for flagging
1892 refile targets no longer points at a live buffer.
1893 If you have added new entries to a buffer that might themselves be targets,
1894 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1895 find that easier, `C-u C-u C-u C-c C-w'."
1900 "Non-nil means provide refile targets as paths.
1901 So a level 3 headline will be available as level1/level2/level3.
1903 When the value is `file', also include the file name (without directory)
1904 into the path. In this case, you can also stop the completion after
1905 the file name, to get entries inserted as top level in the file.
1907 When `full-file-path', include the full file path."
1916 "Non-nil means complete the outline path in hierarchical steps.
1917 When Org-mode uses the refile interface to select an outline path
1918 \(see variable `org-refile-use-outline-path'), the completion of
1919 the path can be done is a single go, or if can be done in steps down
1920 the headline hierarchy. Going in steps is probably the best if you
1921 do not use a special completion package like `ido' or `icicles'.
1922 However, when using these packages, going in one step can be very
1923 fast, while still showing the whole path to the entry."
1928 "Non-nil means allow to create new nodes as refile targets.
1930 of an existing node. When the value of this variable is `confirm',
1931 new node creation must be confirmed by the user (recommended)
1932 When nil, the completion must match an existing entry.
1934 Note that, if the new heading is not seen by the criteria
1935 listed in `org-refile-targets', multiple instances of the same
1936 heading would be created by trying again to file under the new
1937 heading."
1945 "Options concerning TODO items in Org-mode."
1950 "Options concerning Progress logging in Org-mode."
1955 '(
1958 "The available interpretation symbols for customizing `org-todo-keywords'.
1962 "List of TODO entry keyword sequences and their interpretation.
1965 Each sequence starts with a symbol, either `sequence' or `type',
1966 indicating if the keywords should be interpreted as a sequence of
1967 action steps, or as different types of TODO items. The first
1968 keywords are states requiring action - these states will select a headline
1969 for inclusion into the global TODO list Org-mode produces. If one of
1972 the last keyword is treated as the only DONE state of the sequence.
1975 additional state where no keyword is present. For details about this
1976 cycling, see the manual.
1978 TODO keywords and interpretation can also be set on a per-file basis with
1979 the special #+SEQ_TODO and #+TYP_TODO lines.
1981 Each keyword can optionally specify a character for fast state selection
1982 \(in combination with the variable `org-use-fast-todo-selection')
1983 and specifiers for state change logging, using the same syntax
1986 indicates to record a time stamp each time this state is selected.
1988 Each keyword may also specify if a timestamp or a note should be
1989 recorded when entering or leaving the state, by adding additional
1990 characters in the parenthesis after the keyword. This looks like this:
1992 record only the time of the state change. With X and Y being either
1994 Y when leaving the state if and only if the *target* state does not
1995 define X. You may omit any of the fast-selection key or X or /Y,
1996 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1998 For backward compatibility, this variable may also be just a list
1999 of keywords - in this case the interpretation (sequence or type) will be
2000 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2010 ;;Quick and dirty way to see
2011 ;;`org-todo-interpretations'. This takes the
2012 ;;place of item arguments
2013 :convert-widget
2020 org-todo-interpretation-widgets))
2021 widget))
2052 "Controls how TODO keywords are interpreted.
2053 This variable is in principle obsolete and is only used for
2054 backward compatibility, if the interpretation of todo keywords is
2055 not given already in `org-todo-keywords'. See that variable for
2056 more information."
2063 "Non-nil means use the fast todo selection scheme with C-c C-t.
2064 This variable describes if and under what circumstances the cycling
2065 mechanism for TODO keywords will be replaced by a single-key, direct
2066 selection scheme.
2068 When nil, fast selection is never used.
2070 When the symbol `prefix', it will be used when `org-todo' is called with
2071 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2072 in an agenda buffer.
2074 When t, fast selection is used by default. In this case, the prefix
2075 argument forces cycling instead.
2077 In all cases, the special interface is only used if access keys have actually
2078 been assigned by the user, i.e. if keywords in the configuration are followed
2079 by a letter in parenthesis, like TODO(t)."
2087 "Non-nil means update todo statistics after insert and toggle.
2088 ALL-HEADLINES means update todo statistics by including headlines
2089 with no TODO keyword as well, counting them as not done.
2090 A list of TODO keywords means the same, but skip keywords that are
2091 not in this list.
2093 When this is set, todo statistics is updated in the parent of the
2094 current entry each time a todo state is changed."
2104 "Non-nil means TODO statistics covers just direct children.
2105 When nil, all entries in the subtree are considered.
2106 This has only an effect if `org-provide-todo-statistics' is set.
2107 To set this to nil for only a single subtree, use a COOKIE_DATA
2113 "Hook which is run after the state of a TODO item was changed.
2114 The new state (a string with a TODO keyword, or nil) is available in the
2115 Lisp variable `state'."
2120 "Hook for functions that are allowed to block a state change.
2122 Each function gets as its single argument a property list, see
2123 `org-trigger-hook' for more information about this list.
2125 If any of the functions in this hook returns nil, the state change
2129 "Hook for functions that are triggered by a state change.
2131 Each function gets as its single argument a property list with at least
2132 the following elements:
2134 (:type type-of-change :position pos-at-entry-start
2135 :from old-state :to new-state)
2137 Depending on the type, more properties may be present.
2139 This mechanism is currently implemented for:
2141 TODO state changes
2142 ------------------
2143 :type todo-state-change
2144 :from previous state (keyword as a string), or nil, or a symbol
2145 'todo' or 'done', to indicate the general type of state.
2149 "Non-nil means undone TODO entries will block switching the parent to DONE.
2150 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2151 be blocked if any prior sibling is not yet done.
2152 Finally, if the parent is blocked because of ordered siblings of its own,
2153 the child will also be blocked.
2154 This variable needs to be set before org.el is loaded, and you need to
2155 restart Emacs after a change to make the change effective. The only way
2156 to change is while Emacs is running is through the customize interface."
2168 "Non-nil means unchecked boxes will block switching the parent to DONE.
2169 When this is nil, checkboxes have no influence on switching TODO states.
2170 When non-nil, you first need to check off all check boxes before the TODO
2171 entry can be switched to DONE.
2172 This variable needs to be set before org.el is loaded, and you need to
2173 restart Emacs after a change to make the change effective. The only way
2174 to change is while Emacs is running is through the customize interface."
2186 "Non-nil means inserting a TODO heading is treated as state change.
2188 logging will apply if appropriate. When nil, the new TODO item will
2189 be inserted directly, and no logging will take place."
2194 "Non-nil means switching TODO states with S-cursor counts as state change.
2195 This is the default behavior. However, setting this to nil allows a
2196 convenient way to select a TODO state and bypass any logging associated
2197 with that."
2202 "Tag changes that should be triggered by TODO state changes.
2203 This is a list. Each entry is
2205 (state-change (tag . flag) .......)
2207 State-change can be a string with a state, and empty string to indicate the
2208 state that has no TODO keyword, or it can be one of the symbols `todo'
2209 or `done', meaning any not-done or done state, respectively."
2223 "Information to record when a task moves to the DONE state.
2225 Possible values are:
2227 nil Don't add anything, just change the keyword
2228 time Add a time stamp to the task
2229 note Prompt for a note and add it with template `org-log-note-headings'
2231 This option can also be set with on a per-file-basis with
2233 #+STARTUP: nologdone
2234 #+STARTUP: logdone
2235 #+STARTUP: lognotedone
2237 You can have local logging settings for a subtree by setting the LOGGING
2238 property to one or more of these keywords."
2246 ;; Normalize old uses of org-log-done.
2253 "Information to record when the scheduling date of a tasks is modified.
2255 Possible values are:
2257 nil Don't add anything, just change the date
2258 time Add a time stamp to the task
2259 note Prompt for a note and add it with template `org-log-note-headings'
2261 This option can also be set with on a per-file-basis with
2263 #+STARTUP: nologreschedule
2264 #+STARTUP: logreschedule
2265 #+STARTUP: lognotereschedule"
2274 "Information to record when the deadline date of a tasks is modified.
2276 Possible values are:
2278 nil Don't add anything, just change the date
2279 time Add a time stamp to the task
2280 note Prompt for a note and add it with template `org-log-note-headings'
2282 This option can also be set with on a per-file-basis with
2284 #+STARTUP: nologredeadline
2285 #+STARTUP: logredeadline
2286 #+STARTUP: lognoteredeadline
2288 You can have local logging settings for a subtree by setting the LOGGING
2289 property to one or more of these keywords."
2298 "Non-nil means record a note when clocking out of an item.
2299 This can also be configured on a per-file basis by adding one of
2300 the following lines anywhere in the buffer:
2302 #+STARTUP: lognoteclock-out
2303 #+STARTUP: nolognoteclock-out"
2309 "Non-nil means the CLOSED time stamp will contain date and time.
2310 When nil, only the date will be recorded."
2324 "Headings for notes added to entries.
2325 The value is an alist, with the car being a symbol indicating the note
2326 context, and the cdr is the heading to be used. The heading may also be the
2327 empty string.
2328 %t in the heading will be replaced by a time stamp.
2329 %T will be an active time stamp instead the default inactive one
2330 %s will be replaced by the new TODO state, in double quotes.
2331 %S will be replaced by the old TODO state, in double quotes.
2332 %u will be replaced by the user name.
2333 %U will be replaced by the full user name.
2335 In fact, it is not a good idea to change the `state' entry, because
2336 agenda log mode depends on the format of these entries."
2342 "Heading when changing todo state (todo sequence only)"
2356 "Non-nil means insert state change notes and time stamps into a drawer.
2357 When nil, state changes notes will be inserted after the headline and
2358 any scheduling and clock lines, but not inside a drawer.
2360 The value of this variable should be the name of the drawer to use.
2361 LOGBOOK is proposed at the default drawer for this purpose, you can
2362 also set this to a string to define the drawer of your choice.
2366 If this variable is set, `org-log-state-notes-insert-after-drawers'
2367 will be ignored.
2369 You can set the property LOG_INTO_DRAWER to overrule this setting for
2370 a subtree."
2382 "Return the value of `org-log-into-drawer', but let properties overrule.
2383 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2384 used instead of the default value."
2392 "Non-nil means insert state change notes after any drawers in entry.
2393 Only the drawers that *immediately* follow the headline and the
2394 deadline/scheduled line are skipped.
2395 When nil, insert notes right after the heading and perhaps the line
2396 with deadline/scheduling if present.
2398 This variable will have no effect if `org-log-into-drawer' is
2399 set."
2405 "Non-nil means the latest state note will be directly after heading.
2406 When nil, the state change notes will be ordered according to time."
2412 "The TODO state to which a repeater should return the repeating task.
2413 By default this is the first task in a TODO sequence, or the previous state
2414 in a TODO_TYP set. But you can specify another task here.
2415 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2421 "Non-nil means record moving through the DONE state when triggering repeat.
2422 An auto-repeating task is immediately switched back to TODO when
2425 record a closing note, there will be no record of the task moving
2426 through DONE. This variable forces taking a note anyway.
2428 nil Don't force a record
2429 time Record a time stamp
2430 note Record a note
2432 This option can also be set with on a per-file-basis with
2434 #+STARTUP: logrepeat
2435 #+STARTUP: lognoterepeat
2436 #+STARTUP: nologrepeat
2438 You can have local logging settings for a subtree by setting the LOGGING
2439 property to one or more of these keywords."
2449 "Priorities in Org-mode."
2454 "Non-nil means priority commands are active.
2455 When nil, these commands will be disabled, so that you never accidentally
2456 set a priority."
2461 "The highest priority of TODO items. A character like ?A, ?B etc.
2462 Must have a smaller ASCII number than `org-lowest-priority'."
2467 "The lowest priority of TODO items. A character like ?A, ?B etc.
2468 Must have a larger ASCII number than `org-highest-priority'."
2473 "The default priority of TODO items.
2474 This is the priority an item get if no explicit priority is given."
2479 "Non-nil means start with default priority when starting to cycle.
2480 When this is nil, the first step in the cycle will be (depending on the
2481 command used) one higher or lower that the default priority."
2486 "Function to extract the priority from a string.
2487 The string is normally the headline. If this is nil Org computes the
2488 priority from the priority cookie like [#A] in the headline. It returns
2489 an integer, increasing by 1000 for each priority level.
2490 The user can set a different function here, which should take a string
2491 as an argument and return the numeric priority."
2496 "Options concerning time stamps and deadlines in Org-mode."
2501 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2502 When nil, these labeled time stamps are forces into the second line of an
2503 entry, just after the headline. When scheduling from the global TODO list,
2504 the time stamp will always be forced into the second line."
2509 "Formats for `format-time-string' which are used for time stamps.
2513 "Number of minutes to round time stamps to.
2514 These are two values, the first applies when first creating a time stamp.
2515 The second applies when changing it with the commands `S-up' and `S-down'.
2516 When changing the time stamp, this means that it will change in steps
2517 of N minutes, as given by the second value.
2519 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2520 numbers should be factors of 60, so for example 5, 10, 15.
2522 When this is larger than 1, you can still force an exact time stamp by using
2523 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2524 and by using a prefix arg to `S-up/down' to specify the exact number
2525 of minutes to shift."
2535 ;; Normalize old customizations of this variable.
2539 org-time-stamp-rounding-minutes)))
2542 "Non-nil means overlay custom formats over all time stamps.
2543 The formats are defined through the variable `org-time-stamp-custom-formats'.
2544 To turn this on on a per-file basis, insert anywhere in the file:
2545 #+STARTUP: customtime"
2553 "Custom formats for time stamps. See `format-time-string' for the syntax.
2554 These are overlayed over the default ISO format if the variable
2555 `org-display-custom-times' is set. Time like %H:%M should be at the
2556 end of the second format. The custom formats are also honored by export
2557 commands, if custom time display is turned on at the time of export."
2562 "Get the right format for a time string."
2567 f)))
2570 "The format string used when creating CLOCKSUM lines.
2571 This is also used when org-mode generates a time duration."
2577 org-mode generates a time duration."
2582 "The format string used when creating CLOCKSUM lines, or when
2583 org-mode generates a time duration."
2588 "No. of days before expiration during which a deadline becomes active.
2589 This variable governs the display in sparse trees and in the agenda.
2590 When 0 or negative, it means use this number (the absolute value of it)
2591 even if a deadline has a different individual lead time specified.
2593 Custom commands can set this variable in the options section."
2599 "Non-nil means assume future for incomplete date input from user.
2600 This affects the following situations:
2601 1. The user gives a month but not a year.
2604 2. The user gives a day, but no month.
2607 it will be considered as *this* month.
2609 If you set this variable to the symbol `time', then also the following
2610 will work:
2612 3. If the user gives a time, but no day. If the time is before now,
2613 to will be interpreted as tomorrow.
2615 Currently none of this works for ISO week specifications.
2617 When this option is nil, the current day, month and year will always be
2618 used as defaults.
2620 See also `org-agenda-jump-prefer-future'."
2628 "Should the agenda jump command prefer the future for incomplete dates?
2629 The default is to do the same as configured in `org-read-date-prefer-future'.
2630 But you can also set a deviating value here.
2631 This may t or nil, or the symbol `org-read-date-prefer-future'."
2636 org-read-date-prefer-future)
2641 "Non-nil means display current interpretation of date prompt live.
2642 This display will be in an overlay, in the minibuffer."
2647 "Non-nil means pop up a calendar when prompting for a date.
2648 In the calendar, the date can be selected with mouse-1. However, the
2649 minibuffer will also be active, and you can simply enter the date as well.
2650 When nil, only the minibuffer will be available."
2658 "Hook to be used to set up keys for the date/time interface.
2659 Add key definitions to `minibuffer-local-map', which will be a temporary
2660 copy."
2665 "The hour when your day really ends. Must be an integer.
2666 This has influence for the following applications:
2668 the time given here, the day recognized as TODAY is actually yesterday.
2669 - When a date is read from the user and it is still before the time given
2670 here, the current date and time will be assumed to be yesterday, 23:59.
2671 Also, timestamps inserted in remember templates follow this rule.
2673 IMPORTANT: This is a feature whose implementation is and likely will
2674 remain incomplete. Really, it is only here because past midnight seems to
2675 be the favorite working time of John Wiegley :-)"
2680 "Non-nil means S-down will increase the time in a time stamp.
2681 When nil, S-up will increase."
2686 "Non-nil means make the calendar window follow timestamp changes.
2687 When a timestamp is modified and the calendar window is visible, it will be
2688 moved to the new date."
2693 "Options concerning tags in Org-mode."
2698 "List of tags allowed in Org-mode files.
2699 When this list is nil, Org-mode will base TAG input on what is already in the
2700 buffer.
2701 The value of this variable is an alist, the car of each entry must be a
2702 keyword as a string, the cdr may be a character that is used to select
2703 that tag through the fast-tag-selection interface.
2704 See the manual for details."
2719 "List of tags that will always appear in all Org-mode files.
2720 This is in addition to any in buffer settings or customizations
2721 of `org-tag-alist'.
2722 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2723 The value of this variable is an alist, the car of each entry must be a
2724 keyword as a string, the cdr may be a character that is used to select
2725 that tag through the fast-tag-selection interface.
2726 See the manual for details.
2727 To disable these tags on a per-file basis, insert anywhere in the file:
2728 #+STARTUP: noptag"
2739 "If non-nil, always offer completion for all tags of all agenda files.
2740 Instead of customizing this variable directly, you might want to
2741 set it locally for capture buffers, because there no list of
2742 tags in that file can be created dynamically (there are none).
2744 (add-hook 'org-capture-mode-hook
2745 (lambda ()
2746 (set (make-local-variable
2747 'org-complete-tags-always-offer-all-agenda-tags)
2748 t)))"
2753 "List of tags that can be inherited by all entries in the file.
2754 The tags will be inherited if the variable `org-use-tag-inheritance'
2755 says they should be.
2759 "Non-nil means use fast tag selection scheme.
2760 This is a special interface to select and deselect tags with single keys.
2761 When nil, fast selection is never used.
2762 When the symbol `auto', fast selection is used if and only if selection
2763 characters for tags have been configured, either through the variable
2764 `org-tag-alist' or through a #+TAGS line in the buffer.
2765 When t, fast selection is always used and selection keys are assigned
2766 automatically if necessary."
2774 "Non-nil means fast tag selection exits after first change.
2775 When nil, you have to press RET to exit it.
2776 During fast tag selection, you can toggle this flag with `C-c'.
2777 This variable can also have the value `expert'. In this case, the window
2778 displaying the tags menu is not even shown, until you press C-c again."
2786 "Non-nil means fast tags selection interface will also offer TODO states.
2790 "The column to which tags should be indented in a headline.
2791 If this number is positive, it specifies the column. If it is negative,
2792 it means that the tags should be flushright to that column. For example,
2793 -80 works well for a normal 80 character screen."
2798 "Non-nil means realign tags after pro/demotion of TODO state change.
2799 These operations change the length of a headline and therefore shift
2800 the tags around. With this options turned on, after each such operation
2801 the tags are again aligned to `org-tags-column'."
2806 "Non-nil means tags in levels apply also for sublevels.
2807 When nil, only the tags directly given in a specific line apply there.
2808 This may also be a list of tags that should be inherited, or a regexp that
2809 matches tags that should be inherited. Additional control is possible
2810 with the variable `org-tags-exclude-from-inheritance' which gives an
2811 explicit list of tags to be excluded from inheritance., even if the value of
2812 `org-use-tag-inheritance' would select it for inheritance.
2814 If this option is t, a match early-on in a tree can lead to a large
2815 number of matches in the subtree when constructing the agenda or creating
2816 a sparse tree. If you only want to see the first match in a tree during
2817 a search, check out the variable `org-tags-match-list-sublevels'."
2826 "List of tags that should never be inherited.
2827 This is a way to exclude a few tags from inheritance. For way to do
2828 the opposite, to actively allow inheritance for selected tags,
2829 see the variable `org-use-tag-inheritance'."
2834 "Check if TAG is one that should be inherited."
2846 "Non-nil means list also sublevels of headlines matching a search.
2847 This variable applies to tags/property searches, and also to stuck
2848 projects because this search is based on a tags match as well.
2850 When set to the symbol `indented', sublevels are indented with
2851 leading dots.
2853 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2854 the sublevels of a headline matching a tag search often also match
2855 the same search. Listing all of them can create very long lists.
2856 Setting this variable to nil causes subtrees of a match to be skipped.
2858 This variable is semi-obsolete and probably should always be true. It
2859 is better to limit inheritance to certain tags using the variables
2860 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2868 "When set, tags are sorted using this function as a comparator."
2884 "Options concerning properties in Org-mode."
2889 "How property key/value pairs should be formatted by `indent-line'.
2890 When `indent-line' hits a property definition, it will format the line
2891 according to this format, mainly to make sure that the values are
2892 lined-up with respect to each other."
2897 "Non-nil means properties apply also for sublevels.
2899 This setting is chiefly used during property searches. Turning it on can
2900 cause significant overhead when doing a search, which is why it is not
2901 on by default.
2903 When nil, only the properties directly given in the current entry count.
2904 When t, every property is inherited. The value may also be a list of
2905 properties that should have inheritance, or a regular expression matching
2906 properties that should be inherited.
2908 However, note that some special properties use inheritance under special
2909 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2911 for valid values of a property.
2913 Note for programmers:
2914 When querying an entry with `org-entry-get', you can control if inheritance
2915 should be used. By default, `org-entry-get' looks only at the local
2916 properties. You can request inheritance by setting the inherit argument
2917 to t (to force inheritance) or to `selective' (to respect the setting
2918 in this variable)."
2927 "Check if PROPERTY is one that should be inherited."
2938 "The default column format, if no other format has been defined.
2939 This variable can be set on the per-file basis by inserting a line
2941 #+COLUMNS: %25ITEM ....."
2946 "The ellipses to be used when a field in column view is truncated.
2947 When this is the empty string, as many characters as possible are shown,
2948 but then there will be no visual indication that the field has been truncated.
2949 When this is a string of length N, the last N characters of a truncated
2950 field are replaced by this string. If the column is narrower than the
2951 ellipses string, only part of the ellipses string will be shown."
2956 "Function that modifies values for display in column view.
2957 For example, it can be used to cut out a certain part from a time stamp.
2958 The function must take 2 arguments:
2960 column-title The title of the column (*not* the property name)
2961 value The value that should be modified.
2963 The function should return the value that should be displayed,
2964 or nil if the normal value should be used."
2969 "The property that is being used to keep track of effort estimates.
2970 Effort estimates given in this property need to have the format H:MM."
2978 "List of property/value pairs that can be inherited by any entry.
2980 These are fixed values, for the preset properties. The user variable
2981 that can be used to add to this list is `org-global-properties'.
2983 The entries in this list are cons cells where the car is a property
2984 name and cdr is a string with the value. If the value represents
2989 "List of property/value pairs that can be inherited by any entry.
2991 This list will be combined with the constant `org-global-properties-fixed'.
2993 The entries in this list are cons cells where the car is a property
2994 name and cdr is a string with the value.
2996 You can set buffer-local values for the same purpose in the variable
2997 `org-file-properties' this by adding lines like
2999 #+PROPERTY: NAME VALUE"
3006 "List of property/value pairs that can be inherited by any entry.
3007 Valid for the current buffer.
3012 "Options concerning agenda views in Org-mode."
3017 "Variable used by org files to set a category for agenda display.
3018 Such files should use a file variable to set it, for example
3022 or contain a special line
3024 #+CATEGORY: ELisp
3026 If the file does not specify a category, then file's base name
3032 "The files to be used for agenda display.
3036 If an entry is a directory, all files in that directory that are matched by
3037 `org-agenda-file-regexp' will be part of the file list.
3039 If the value of the variable is not a list but a single file name, then
3040 the list of agenda files is actually stored and maintained in that file, one
3041 agenda file per line. In this file paths can be given relative to
3042 `org-directory'. Tilde expansion and environment variable substitution
3043 are also made."
3050 "Regular expression to match files for `org-agenda-files'.
3051 If any element in the list in that variable contains a directory instead
3052 of a normal file, all files in that directory that are matched by this
3053 regular expression will be included."
3058 "List of extra files to be searched by text search commands.
3059 These files will be search in addition to the agenda files by the
3060 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3061 Note that these files will only be searched for text search commands,
3062 not for the other agenda views like todo lists, tag searches or the weekly
3063 agenda. This variable is intended to list notes and possibly archive files
3064 that should also be searched by these two commands.
3065 In fact, if the first element in the list is the symbol `agenda-archives',
3066 than all archive files of all agenda files will be added to the search
3067 scope."
3078 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3079 A nil value means to remove them, after a query, from the list."
3084 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3085 The command `org-calendar-goto-agenda' will be bound to this key. The
3086 default is the character `c' because then `c' can be used to switch back and
3087 forth between agenda and calendar."
3092 "The key to be installed in `calendar-mode-map' for agenda-action.
3093 The command `org-agenda-action' will be bound to this key. The
3094 default is the character `k' because we use the same key in the agenda."
3099 "The key to be installed in `calendar-mode-map' for adding diary entries.
3100 This option is irrelevant until `org-agenda-diary-file' has been configured
3101 to point to an Org-mode file. When that is the case, the command
3102 `org-agenda-diary-entry' will be bound to the key given here, by default
3103 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3104 if you want to continue doing this, you need to change this to a different
3105 key."
3110 "File to which to add new entries with the `i' key in agenda and calendar.
3111 When this is the symbol `diary-file', the functionality in the Emacs
3112 calendar will be used to add entries to the `diary-file'. But when this
3113 points to a file, `org-agenda-diary-entry' will be used instead."
3129 org-calendar-insert-diary-entry-key
3133 "Options for embedding LaTeX code into Org-mode."
3141 "Options for creating images from LaTeX fragments.
3142 This is a property list with the following properties:
3144 `default' means use the foreground of the default face.
3146 `default' means use the background of the default face.
3147 :scale a scaling factor for the size of the images, to get more pixels
3148 :html-foreground, :html-background, :html-scale
3149 the same numbers for HTML export.
3150 :matchers a list indicating which matchers should be used to
3151 find LaTeX fragments. Valid members of this list are:
3162 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3163 When nil, just push out a message."
3172 \[PACKAGES]
3173 \[DEFAULT-PACKAGES]
3174 % The settings below are copied from fullpage.sty
3187 "The document header used for processing LaTeX fragments.
3188 It is imperative that this header make sure that no page number
3189 appears on the page. The package defined in the variables
3190 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3192 will be appended."
3199 "Set the packages alist and make sure it has 3 elements per entry."
3203 x))
3204 val)))
3208 "Get the packages alist and make sure it has 3 elements per entry."
3212 x))
3215 ;; The following variables are defined here because is it also used
3216 ;; when formatting latex fragments. Originally it was part of the
3217 ;; LaTeX exporter, which is why the name includes "export".
3234 )
3235 "Alist of default packages to be inserted in the header.
3236 Change this only if one of the packages here causes an incompatibility
3237 with another package you are using.
3238 The packages in this list are needed by one part or another of Org-mode
3239 to function properly.
3241 - inputenc, fontenc: for basic font and character selection
3242 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3243 for interpreting the entities in `org-entities'. You can skip some of these
3244 packages if you don't use any of the symbols in it.
3245 - graphicx: for including images
3246 - float, wrapfig: for figure placement
3247 - longtable: for long tables
3248 - hyperref: for cross references
3250 Therefore you should not modify this variable unless you know what you
3251 are doing. The one reason to change it anyway is that you might be loading
3252 some other package that conflicts with one of the default packages.
3254 If SNIPPET-FLAG is t, the package also needs to be included when
3255 compiling LaTeX snippets into images for inclusion into HTML."
3268 "Alist of packages to be inserted in every LaTeX header.
3269 These will be inserted after `org-export-latex-default-packages-alist'.
3271 SNIPPET-FLAG, when t, indicates that this package is also needed when
3272 turning LaTeX snippets into images for inclusion into HTML.
3273 Make sure that you only list packages here which:
3274 - you want in every file
3275 - do not conflict with the default packages in
3276 `org-export-latex-default-packages-alist'
3277 - do not conflict with the setup in `org-format-latex-header'."
3291 "Settings for Org-mode appearance."
3296 "Non-nil means fontify only the stars in each headline.
3297 When nil, the entire headline is fontified.
3298 Changing it requires restart of `font-lock-mode' to become effective
3299 also in regions already fontified."
3304 "Non-nil means hide the first N-1 stars in a headline.
3305 This works by using the face `org-hide' for these stars. This
3306 face is white for a light background, and black for a dark
3307 background. You may have to customize the face `org-hide' to
3308 make this work.
3309 Changing it requires restart of `font-lock-mode' to become effective
3310 also in regions already fontified.
3311 You may also set this on a per-file basis by adding one of the following
3312 lines to the buffer:
3314 #+STARTUP: hidestars
3315 #+STARTUP: showstars"
3320 "List of symbols corresponding to keywords to be hidden the org buffer.
3321 For example, a value '(title) for this list will make the document's title
3322 appear in the buffer without the initial #+TITLE: keyword."
3330 "Non-nil means change the face of a headline if it is marked DONE.
3331 Normally, only the TODO/DONE keyword indicates the state of a headline.
3332 When this is non-nil, the headline after the keyword is set to the
3333 `org-headline-done' as an additional indication."
3338 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3339 Changing this variable requires a restart of Emacs to take effect."
3344 "Non-nil means fontify the whole line for headings.
3345 This is useful when setting a background color for the
3346 org-level-* faces."
3351 "Non-nil means fontify what is treated specially by the exporters."
3356 "Non-nil mean font-lock should hide the emphasis marker characters."
3361 "Non-nil means show entities as UTF8 characters.
3367 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3372 "Regular expression for matching emphasis.
3373 After a match, the match groups contain these elements:
3374 0 The match of the full regular expression, including the characters
3375 before and after the proper match
3376 1 The character before the proper match, or empty at beginning of line
3377 2 The proper match, including the leading and trailing markers
3378 3 The leading marker like * or /, indicating the type of highlighting
3379 4 The text between the emphasis markers, not including the markers
3386 "Set variable and compute the emphasis regular expression."
3390 org-emphasis-alist org-emphasis-regexp-components)
3402 ;; make sure special characters appear at the right position in the class
3414 ;; Make the regexp
3422 body1
3434 body1
3442 "Components used to build the regular expression for emphasis.
3443 This is a list with five entries. Terminology: In an emphasis string
3447 specify what is allowed/forbidden in each part:
3449 pre Chars allowed as prematch. Beginning of line will be allowed too.
3450 post Chars allowed as postmatch. End of line will be allowed too.
3451 border The chars *forbidden* as border characters.
3453 non-shy groups here, and don't allow newline here.
3454 newline The maximum number of newlines allowed in an emphasis exp.
3456 Use customize to modify this, or restart Emacs after changing it."
3475 )
3476 "Special syntax for emphasized text.
3477 Text starting and ending with a special character will be emphasized, for
3478 example *bold*, _underlined_ and /italic/. This variable sets the marker
3479 characters, the face to be used by font-lock for highlighting in Org-mode
3480 Emacs buffers, and the HTML tags to be used for this.
3481 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3482 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3483 Use customize to modify this, or restart Emacs after changing it."
3498 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3501 ;;; Miscellaneous options
3504 "Completion in Org-mode."
3509 "Non-nil means use ido completion wherever possible.
3510 Note that `ido-mode' must be active for this variable to be relevant.
3511 If you decide to turn this variable on, you might well want to turn off
3512 `org-outline-path-complete-in-steps'.
3513 See also `org-completion-use-iswitchb'."
3518 "Non-nil means use iswitchb completion wherever possible.
3519 Note that `iswitchb-mode' must be active for this variable to be relevant.
3520 If you decide to turn this variable on, you might well want to turn off
3521 `org-outline-path-complete-in-steps'.
3522 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3528 Normal means, no org-mode-specific context."
3532 ;;; Functions and variables from their packages
3533 ;; Declared here to avoid compiler warnings
3535 ;; XEmacs only
3541 ;; Emacs only
3544 ;; Various packages
3562 org-format-agenda-item "org-agenda"
3593 ;;; Autoload and prepare some org modules
3595 ;; Some table stuff that needs to be defined here, because it is used
3596 ;; by the functions setting up org-mode or checking for table context.
3609 "Detect the first line outside a table when searching from within it.
3612 ;; Autoload the functions in org-table.el that are needed by functions here.
3617 org-table-convert org-table-convert-region org-table-copy-down
3618 org-table-copy-region org-table-create
3619 org-table-create-or-convert-from-region
3620 org-table-create-with-table.el org-table-current-dline
3621 org-table-cut-region org-table-delete-column org-table-edit-field
3622 org-table-edit-formulas org-table-end org-table-eval-formula
3623 org-table-export org-table-field-info
3624 org-table-get-stored-formulas org-table-goto-column
3625 org-table-hline-and-move org-table-import org-table-insert-column
3626 org-table-insert-hline org-table-insert-row org-table-iterate
3627 org-table-justify-field-maybe org-table-kill-row
3628 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3629 org-table-move-column org-table-move-column-left
3630 org-table-move-column-right org-table-move-row
3631 org-table-move-row-down org-table-move-row-up
3632 org-table-next-field org-table-next-row org-table-paste-rectangle
3633 org-table-previous-field org-table-recalculate
3634 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3635 org-table-toggle-coordinate-overlays
3636 org-table-toggle-formula-debugger org-table-wrap-region
3637 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3638 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3639 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3642 "Return t if the cursor is inside an org-type table.
3643 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3648 org-table-line-regexp)))
3649 nil))
3653 "Return t if and only if we are at a table.el table."
3659 "If there is a table.el table nearby, recognize it and move into it."
3665 nil
3675 t
3680 t)
3681 nil)
3682 nil))
3685 "Return t if the cursor is inside a hline in a table."
3690 nil))
3695 "Apply FUNCTION to the start of all tables in the buffer."
3711 ;; Declare and autoload functions from org-exp.el & Co
3719 org-insert-export-options-template
3720 org-table-clean-before-export))
3723 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3724 org-export-region-as-ascii))
3727 org-replace-region-by-latex org-export-region-as-latex
3728 org-export-as-latex org-export-as-pdf
3729 org-export-as-pdf-and-open))
3732 org-export-as-html-batch org-export-as-html-to-buffer
3733 org-replace-region-by-html org-export-region-as-html
3734 org-export-as-html))
3737 org-replace-region-by-docbook org-export-region-as-docbook
3738 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3739 org-export-as-docbook))
3742 org-export-icalendar-all-agenda-files
3743 org-export-icalendar-combine-agenda-files))
3747 ;; Declare and autoload functions from org-agenda.el
3752 org-todo-list org-tags-view org-agenda-list-stuck-projects
3753 org-diary org-agenda-to-appt
3754 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3756 ;; Autoload org-remember
3761 org-remember-apply-template org-remember org-remember-handler)))
3766 org-capture-import-remember-templates)))
3768 ;; Autoload org-clock.el
3783 "Return non-nil if clock is currently running.
3784 The return value is actually the clock marker."
3789 "org-clock"
3791 org-clock-goto org-clock-sum org-clock-display
3792 org-clock-remove-overlays org-clock-report
3793 org-clocktable-shift org-dblock-write:clocktable
3794 org-get-clocktable org-resolve-clocks)))
3797 "If this is a CLOCK line, update it and return t.
3798 Otherwise, return nil."
3807 ts te h m s neg)
3810 nil)
3815 ;; The clock is running here
3836 t))))))
3839 "Check if the current buffer contains the running clock.
3840 If yes, offer to stop it and to save the buffer with the changes."
3849 "Check if this line starts a clock table, if yes, shift the time block."
3853 ;; Autoload org-timer.el
3857 "org-timer"
3859 org-timer-change-times-in-region
3860 org-timer-set-timer
3861 org-timer-reset-timers
3862 org-timer-show-remaining-time)))
3864 ;; Autoload org-feed.el
3868 "org-feed"
3872 ;; Autoload org-indent.el
3874 ;; Define the variable already here, to make sure we have it.
3876 "Non-nil if Org-Indent mode is enabled.
3881 "org-indent"
3884 ;; Autoload org-mobile.el
3888 "org-mobile"
3891 ;; Autoload archiving code
3892 ;; The stuff that is needed for cycling and tags has to be defined here.
3895 "Options concerning archiving in Org-mode."
3900 "The location where subtrees should be archived.
3902 The value of this variable is a string, consisting of two parts,
3903 separated by a double-colon. The first part is a filename and
3904 the second part is a headline.
3906 When the filename is omitted, archiving happens in the same file.
3907 %s in the filename will be replaced by the current file
3908 name (without the directory part). Archiving to a different file
3909 is useful to keep archived entries from contributing to the
3910 Org-mode Agenda.
3912 The archived entries will be filed as subtrees of the specified
3913 headline. When the headline is omitted, the subtrees are simply
3914 filed away at the end of the file, as top-level entries. Also in
3915 the heading you can use %s to represent the file name, this can be
3916 useful when using the same archive for a number of different files.
3918 Here are a few examples:
3920 If the current file is Projects.org, archive in file
3921 Projects.org_archive, as top-level trees. This is the default.
3924 Archive in the current file, under the top-level headline
3928 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3931 Archive in file ~/org/archive.org (absolute path), under headlines
3935 Archive in file ./basement (relative path), as level 3 trees
3938 You may set this option on a per-file basis by adding to the buffer a
3939 line like
3941 #+ARCHIVE: basement::** Finished Tasks
3943 You may also define it locally for a subtree by setting an ARCHIVE property
3944 in the entry. If such a property is found in an entry, or anywhere up
3945 the hierarchy, it will be used."
3950 "The tag that marks a subtree as archived.
3951 An archived subtree does not open during visibility cycling, and does
3952 not contribute to the agenda listings.
3953 After changing this, font-lock must be restarted in the relevant buffers to
3954 get the proper fontification."
3960 "Non-nil means the agenda will skip any items located in archived trees.
3961 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3962 variable is no longer recommended, you should leave it at the value t.
3963 Instead, use the key `v' to cycle the archives-mode in the agenda."
3969 "Non-nil means ignore archived trees when creating column view."
3975 "Non-nil means `org-cycle' will open archived trees.
3976 An archived tree is a tree marked with the tag ARCHIVE.
3977 When nil, archived trees will stay folded. You can still open them with
3978 normal outline commands like `show-all', but not with the cycling commands."
3984 "Non-nil means sparse tree construction shows matches in archived trees.
3985 When nil, matches in these trees are highlighted, but the trees are kept in
3986 collapsed state."
3992 "Re-hide all archived subtrees after a visibility state change."
4003 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4006 "Cycle subtree even if it is archived."
4013 "Re-hide all archived subtrees after a visibility state change."
4028 flag)))
4035 org-archive-to-archive-sibling org-toggle-archive-tag
4036 org-archive-subtree-default
4037 org-archive-subtree-default-with-confirmation)))
4039 ;; Autoload Column View Code
4047 org-columns-compute org-agenda-columns org-columns-remove-overlays
4050 ;; Autoload ID code
4058 org-id-get-with-outline-path-completion
4059 org-id-get-with-outline-drilling org-id-store-link
4060 org-id-goto org-id-find org-id-store-link))
4062 ;; Autoload Plotting Code
4067 ;;; Variables for pre-computed regular expressions, all buffer local
4085 "Matches a headline and puts everything into groups:
4086 group 1: the stars
4087 group 2: The todo keyword, maybe
4088 group 3: Priority cookie
4089 group 4: True headline
4093 "Printf format to make regexp to match an exact headline.
4094 This regexp will match the headline of any node which hase the exact
4095 headline text that is put into the format, but may have any TODO state,
4099 "Matches a headline and puts TODO state into group 2 if present.
4154 "Regular expression to match a plain time or time range.
4155 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4156 groups carry important information:
4157 0 the full match
4158 1 the first time, range or not
4166 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4167 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4168 groups carry important information:
4169 0 the full match
4170 7 hours of duration
4179 "Regular expression to match a timestamp time or time range.
4180 After a match, the following groups carry important information:
4181 0 the full match
4182 1 date plus weekday, for back referencing to make sure both times are on the same day
4183 2 the first time, range or not
4238 "Variable associated with STARTUP options for org-mode.
4239 Each element is a list of three items: The startup options as written
4240 in the #+STARTUP line, the corresponding variable, and the value to
4241 set this variable to if the option is found. An optional forth element PUSH
4245 "Precompute regular expressions for current buffer."
4265 kwds kws0 kwsa key log value cat arch tags const links hw dws
4266 tail sep kws1 prio props ftags drawers beamer-p
4288 ;; general TODO-like setup
4300 links)))
4306 props)))
4311 ftags
4321 l var val)
4351 ))))
4368 ;; Process the TODO keywords
4370 ;; Use the global values as if they had been given locally.
4382 kws)))
4385 kwsa nil
4388 ;; 1 2
4396 kw)
4398 kws0)
4415 ;; Process the constants
4423 ;; Process the tags.
4434 tgs))
4442 ;; Compute the regular expressions and other local variables
4450 org-drawer-regexp
4454 org-not-done-keywords
4456 org-todo-regexp
4459 org-not-done-regexp
4463 org-not-done-heading-regexp
4467 org-todo-line-regexp
4471 org-complex-heading-regexp
4476 org-complex-heading-regexp-format
4485 org-nl-done-regexp
4489 org-todo-line-tags-regexp
4494 org-looking-at-done-regexp
4499 org-deadline-time-regexp
4501 org-deadline-line-regexp
4503 org-scheduled-regexp
4505 org-scheduled-time-regexp
4507 org-closed-time-regexp
4509 org-keyword-time-regexp
4515 org-keyword-time-not-clock-regexp
4521 org-maybe-keyword-time-regexp
4527 org-planning-or-clock-line-re
4532 org-all-time-keywords
4535 org-clock-string org-closed-string))
4536 )
4541 "Return the contents of FILE, as a string."
4555 "Extract the log state setting from a TODO keyword string.
4569 "Remove a pair of parenthesis at the end of each string in LIST."
4573 x))
4574 list))
4577 "Assign fast keys to a keyword-key alist.
4578 Respect keys that are already there."
4596 ;;; Some variables used in various places
4603 "Function to be called when `C-c C-c' is used.
4607 ;; FIXME: Occasionally check by commenting these, to make sure
4608 ;; no other functions uses these, forgetting to let-bind them.
4613 ;; Defined somewhere in this file, but used before definition.
4619 ;;;; Define the Org-mode
4622 (error "Conflict with outdated version of allout.el. Load org.el before allout.el, or upgrade to newer allout, for example by switching to Emacs 22"))
4625 ;; We use a before-change function to check if a table might need
4626 ;; an update.
4628 "Indicates that a table might need an update.
4629 This variable is set by `org-before-change-function'.
4632 "Every change indicates that a table might need an update."
4643 ;;;###autoload
4645 "Outline-based notes management and organizer, alias
4648 Org-mode develops organizational tasks around a NOTES file which
4649 contains information about projects as plain text. Org-mode is
4650 implemented on top of outline-mode, which is ideal to keep the content
4651 of large files well structured. It supports ToDo items, deadlines and
4652 time stamps, which magically appear in the diary listing of the Emacs
4653 calendar. Tables are easily created with a built-in table editor.
4654 Plain text URL-like links connect to websites, emails (VM), Usenet
4655 messages (Gnus), BBDB entries, and any files related to the project.
4656 For printing and sharing of notes, an Org-mode file (or a part of it)
4657 can be exported as a structured ASCII or HTML file.
4659 The following commands are available:
4663 ;; Get rid of Outline menus, they are not needed
4664 ;; Need to do this here because define-derived-mode sets up
4665 ;; the keymap so late. Still, it is a waste to call this each time
4666 ;; we switch another buffer into org-mode.
4669 ;; Assume this is Greg's port, it uses easymenu
4694 org-display-table 4
4697 org-ellipsis)))
4702 ;; tag faces set outside customize.... force initialization.
4704 ;; Calc embedded
4710 ;; Activate before-change-function
4714 ;; Check for running clock before killing a buffer
4716 ;; Paragraphs and auto-filling
4720 ;; Beginning/end of defun
4723 ;; Next error for sparse trees
4725 ;; Make sure dependence stuff works reliably, even for users who set it
4726 ;; too late :-(
4738 ;; Comment characters
4742 ;; Align options lines
4744 'align-mode-rules-list
4749 ;; Imenu
4753 ;; Make isearch reveal context
4756 ;; Emacs 21 and XEmacs make use of the hook
4758 ;; Emacs 22 deals with this through a special variable
4762 ;; Turn on org-beamer-mode?
4765 ;; Setup the pcomplete hooks
4776 ;; If empty file that did not turn on org-mode automatically, make it to.
4801 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4811 "Return today date, considering `org-extend-today-until'."
4816 ;;;; Font-Lock stuff, including the activators
4847 "Regular expression used to analyze links.
4848 Here is what the match groups contain after a match:
4849 1: http:
4850 2: http
4851 3: path
4852 4: [desc]
4860 "Number of stacked braces for sub/superscript matching.
4861 This has to be set before loading org.el to be effective."
4866 "Create a regular expression which will match a balanced sexp.
4867 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4868 as single character strings.
4869 The regexp returned will match the entire expression including the
4870 delimiters. It will also define a single group which contains the
4871 match except for the outermost delimiters. The maximum depth of
4872 stacked delimiters is N. Escaping delimiters is not possible."
4901 "Update the link regular expressions.
4902 This should be called after the variable `org-link-types' has changed."
4906 org-link-re-with-space
4912 org-link-re-with-space2
4918 org-link-re-with-space3
4923 org-angle-link-re
4929 org-plain-link-re
4933 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
4934 org-bracket-link-regexp
4936 org-bracket-link-analytic-regexp
4944 org-bracket-link-analytic-regexp++
4952 org-any-link-re
4963 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4964 "Regular expression matching time strings for analysis.
4965 This one does not require the space after the date, so it can be used
4967 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4983 "Regular expression matching a time stamp or time stamp range.
4989 "Run through the buffer and add overlays to links."
4998 'face
5011 rtn))
5014 "Insert or change an emphasis, i.e. a font like bold or italic.
5015 If there is an active region, change that region to a new emphasis.
5016 If there is no region, just insert the marker characters and position
5017 the cursor between them.
5018 CHAR should be either the marker character, or the first character of the
5019 HTML tag associated with that emphasis. If CHAR is a space, the means
5020 to remove the emphasis of the selected region.
5021 If char is not given (for example in an interactive call) it
5022 will be prompted for."
5073 "Run through the buffer and add overlays to links."
5082 nil
5088 t)))))
5096 t)))
5099 "When non-nil, fontify code in code blocks."
5105 "Fontify #+ lines and blocks, in the correct ways."
5108 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5109 limit t)
5117 end end1 quoting block-type)
5120 ;; a single line of backend-specific content
5128 ; for backend-specific code
5129 t)
5131 ;; Truly a block
5143 beg end
5147 ; for end_src
5155 ; end of source block
5163 t))
5176 ;; just any other in-buffer setting, but not indented
5180 t)
5188 t)
5196 "Run through the buffer and add overlays to links."
5204 t)))
5207 "Run through the buffer and add overlays to links."
5209 limit t)
5214 'keymap org-mouse-map
5215 'help-echo
5217 "Footnote definition"
5219 ))
5221 t)))
5224 "Run through the buffer and add overlays to bracketed links."
5228 ;; FIXME: above we should remove the escapes.
5229 ;; but that requires another match, protecting match data,
5230 ;; a lot of overhead for font-lock.
5237 ;; We need to remove the invisible property here. Table narrowing
5238 ;; may have made some of this invisible.
5256 t)))
5259 "Run through the buffer and add overlays to dates."
5271 t)))
5280 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5284 "Run through the buffer and add overlays to target matches."
5292 'keymap org-mouse-map
5296 t)))))
5299 "Find all radio targets in this file and update the regular expression."
5314 t)))
5321 ;; This should be with the exporter code, but we also use if for font-locking
5331 "Compute regular expression for stuff treated specially by exporters."
5338 org-latex-regexps)))
5366 org-entities)))
5370 org-latex-entities)
5371 nil))
5373 ))
5374 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5377 org-export-html-special-string-regexps)))
5382 ))))
5384 'org-latex-and-specials-regexp
5389 "Run through the buffer and add overlays to links."
5393 limit t))
5407 rtn)))
5410 "Restart `font-lock-mode', to force refontification."
5416 "Return a list of all targets in this file.
5417 With optional argument RADIO, only find radio targets."
5419 rtn)
5424 rtn)))
5427 "Make regular expression matching all strings in TARGETS.
5428 The regular expression finds the targets also if there is a line break
5429 between words."
5438 x)
5439 targets
5451 t)))
5454 "Compute the outline level of the heading at point.
5455 This function assumes that the cursor is at the beginning of a line matched
5456 by `outline-regexp'. Otherwise it returns garbage.
5457 If this is called at a normal headline, the level is the number of stars.
5458 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5465 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5472 "Functions that can manipulate `org-font-lock-extra-keywords'.
5473 This is calles after `org-font-lock-extra-keywords' is defined, but before
5474 it is installed to be used by font lock. This can be useful if something
5485 ;; Call the hook
5487 ;; Headlines
5494 ;; Table lines
5497 ;; Table internals
5502 ;; Drawers
5505 ;; Properties
5509 ;; Links
5520 ;; TODO lines
5523 ;; DONE
5529 nil)
5530 ;; Priorities
5532 ;; Tags
5534 ;; Special keywords
5539 ;; Emphasis
5544 ;; Checkboxes
5545 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5550 ;; Description list items
5553 ;; ARCHIVEd headings
5556 ;; Specials
5560 ;; Code
5562 ;; COMMENT
5567 ;; Blocks and meta lines
5569 )))
5572 ;; Now set the full font-lock-keywords
5579 "Toggle the composition display of entities as UTF8 characters."
5591 "Find an entity to fontify."
5597 limit t)
5609 nil))))
5612 "Fontify string S like in Org-mode."
5624 "Get the right face for match N in font-lock matching of headlines."
5637 "Get the right face for a TODO keyword KWD.
5638 If KWD is a number, get the corresponding match group."
5646 "Create a face list that inherits INHERIT, but sets the foreground color.
5647 When FACE-OR-COLOR is not a string, just return it."
5651 face-or-color)
5652 face-or-color))
5655 "Add the special tag faces."
5664 "Add the special priority faces."
5671 org-priority-faces)))
5676 "Get the right face for a TODO keyword KWD.
5677 If KWD is a number, get the corresponding match group."
5684 "Remove fontification and activation overlays from links."
5689 deactivate-mark buffer-file-name buffer-file-truename)
5692 beg end
5694 ;; also remove line-prefix and wrap-prefix properties
5696 invisible t intangible t
5697 line-prefix t wrap-prefix t
5698 org-no-flyspell t org-emphasis t)
5700 invisible t intangible t
5701 org-no-flyspell t org-emphasis t)))
5711 "Remove specific display properties that have been added by font lock.
5712 The will remove the raise properties that are used to show superscripts
5713 and subscripts."
5723 "Add raise properties to sub/superscripts."
5727 org-match-substring-regexp
5728 org-match-substring-with-braces-regexp)
5729 limit t)
5739 ;; FIXME: Should we go back one character here, for a_b^c
5740 ;; (goto-char (1- pos)) ;????????????????????
5742 t
5744 'display
5760 t)))))
5762 ;;;; Visibility cycling, including org-goto and indirect buffer
5764 ;;; Cycling
5771 ;;;###autoload
5776 "TAB-action and visibility cycling for Org-mode.
5778 This is the command invoked in Org-mode by the TAB key. Its main purpose
5779 is outline visibility cycling, but it also invokes other actions
5780 in special contexts.
5782 - When this function is called with a prefix argument, rotate the entire
5783 buffer through 3 states (global cycling)
5784 1. OVERVIEW: Show only top-level headlines.
5785 2. CONTENTS: Show all headlines of all levels, but no body text.
5786 3. SHOW ALL: Show everything.
5787 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5788 determined by the variable `org-startup-folded', and by any VISIBILITY
5789 properties in the buffer.
5790 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5791 including any drawers.
5793 - When inside a table, re-align the table and move to the next field.
5795 - When point is at the beginning of a headline, rotate the subtree started
5796 by this line through 3 different states (local cycling)
5797 1. FOLDED: Only the main headline is shown.
5798 2. CHILDREN: The main headline and the direct children are shown.
5799 From this state, you can move to one of the children
5800 and zoom in further.
5801 3. SUBTREE: Show the entire subtree, including body text.
5802 If there is no subtree, switch directly from CHILDREN to FOLDED.
5804 - When point is at the beginning of an empty headline and the variable
5805 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5806 of the headline by demoting and promoting it to likely levels. This
5807 speeds up creation document structure by pressing TAB once or several
5808 times right after creating a new headline.
5810 - When there is a numeric prefix, go up to a heading with level ARG, do
5811 a `show-subtree' and return to the previous cursor position. If ARG
5812 is negative, go up that many levels.
5814 - When point is not at the beginning of a headline, execute the global
5815 binding for TAB, which is re-indenting the line. See the option
5816 `org-cycle-emulate-tab' for details.
5818 - Special case: if point is at the beginning of the buffer and there is
5819 no headline in line 1, this function will act as if called with prefix arg
5820 (C-u TAB, same as S-TAB) also when called without prefix arg.
5821 But only if also the variable `org-cycle-global-at-bob' is t."
5831 org-inlinetask-min-level
5836 limit-level)))
5839 outline-regexp
5847 org-cycle-hook))
5851 ;; special case: use global cycling
5865 ;; Table: enter it or move to the next field.
5876 ;; Global cycling: delegate to `org-cycle-internal-global'.
5879 ;; Drawers: delegate to `org-flag-drawer'.
5887 ;; Show-subtree, ARG levels up from here.
5895 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
5901 ;; At an item/headline: delegate to `org-cycle-internal-local'.
5908 ;; From there: TAB emulation and template completion.
5932 t
5941 "Do the global cycling action."
5945 ;; We just created the overview - now do table of contents
5946 ;; This can be slow in very large buffers, so indicate action
5956 ;; We just showed the table of contents - now show everything
5964 ;; Default action: go to overview
5972 "Do the local cycling action."
5974 ;; First, determine end of headline (EOH), end of subtree or item
5975 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
5999 ;; Determine end invisible part of buffer (EOL)
6001 ;; XEmacs doesn't have `next-single-char-property-change'
6011 ;; Find out what to do next and set `this-command'
6014 ;; Nothing is hidden behind this heading
6026 org-cycle-skip-children-state-if-no-children))))
6027 ;; Entire subtree is hidden in one line: children view
6033 ;; Fold every list in subtree to top-level items.
6055 ;; We just showed the children, or no children are there,
6056 ;; now show everything.
6063 ;; Default action: hide the subtree.
6070 ;;;###autoload
6072 "Cycle the global visibility. For details see `org-cycle'.
6074 With a numeric prefix, show all headlines up to that level."
6090 "Set the visibility required by startup options and properties."
6105 "Switch subtree visibilities according to :VISIBILITY: property."
6112 nil t)
6137 "Switch to overview mode, showing only top-level headlines.
6138 Really, this shows all headlines with level equal or greater than the level
6139 of the first headline in the buffer. This is important, because if the
6140 first headline is not level one, then (hide-sublevels 1) gives confusing
6141 results."
6152 "Show all headlines in the buffer, like a table of contents.
6153 With numerical argument N, show content up to level N."
6156 ;; Visit all headings and show their offspring
6163 t)
6172 "Adjust the window after a change in outline visibility.
6173 This function is the default value of the hook `org-cycle-hook'."
6183 "Remove outline overlays that do not contain non-white stuff."
6193 "Fix visibility issues after moving a subtree."
6194 ;; First, find a reasonable region to look at:
6195 ;; Start two siblings above, end three below
6213 ;; Properly fold already folded siblings
6224 "Show empty lines above all visible headlines.
6225 The region to be covered depends on STATE when called through
6226 `org-cycle-hook'. Lisp program can use t for STATE to get the
6227 entire buffer covered. Note that an empty line is only shown if there
6228 are at least `org-cycle-separator-lines' empty lines before the headline."
6238 beg end b e)
6262 ;; Never hide empty lines at the end of the file.
6272 "Move to the parent and re-show empty lines before visible headlines."
6278 "Return `org-agenda-files' list, plus all open org-mode files.
6279 This is useful for operations that need to scan all of a user's
6280 open and agenda-wise Org files."
6288 files))
6291 "Return the beginning position of the current entry."
6295 "Return the end position of the current entry."
6299 "Re-hide all drawers after a visibility state change."
6326 "Is the end of the current subtree visible?"
6331 "Move cursor to the first headline and recenter the headline.
6332 Optional argument N means put the headline into the Nth line of the window."
6338 ;;; Saving and restoring visibility
6341 "Return a list of the locations of all outline overlays.
6342 These are overlays with the `invisible' property value `outline'.
6343 The return value is a list of cons cells, with start and stop
6344 positions for each overlay.
6345 If USE-MARKERS is set, return the positions as markers."
6363 "Create visibility overlays for all positions in DATA.
6364 DATA should have been made by `org-outline-overlay-data'."
6373 data)))))
6375 ;;; Folding of blocks
6386 "Call FUNCTION at the head of all source blocks in the current buffer.
6387 Optional arguments START and END can be used to limit the range."
6399 "Toggle the visibility of all blocks in the current buffer."
6403 "Fold all blocks in the current buffer."
6409 "Unfold all blocks in the current buffer."
6415 "Toggle visibility of block at point."
6426 "Toggle the visibility of the current block."
6433 ov)
6449 ;; make the block accessible to isearch
6451 ov 'isearch-open-invisible
6462 ;; org-tab-after-check-for-cycling-hook
6464 ;; Remove overlays when changing major mode
6469 ;;; Org-goto
6475 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6491 nil)
6492 (org-defkey map "q" 'org-goto-quit)
6493 (org-defkey map "n" 'outline-next-visible-heading)
6494 (org-defkey map "p" 'outline-previous-visible-heading)
6495 (org-defkey map "f" 'outline-forward-same-level)
6496 (org-defkey map "b" 'outline-backward-same-level)
6497 (org-defkey map "u" 'outline-up-heading))
6498 (org-defkey map "/" 'org-occur)
6499 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6500 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6501 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6502 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6503 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6504 map))
6506 (defconst org-goto-help
6507 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6508 RET=jump to location [Q]uit and return to previous location
6509 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6511 (defvar org-goto-start-pos) ; dynamically scoped parameter
6513 ;; FIXME: Docstring does not mention both interfaces
6514 (defun org-goto (&optional alternative-interface)
6515 "Look up a different location in the current file, keeping current visibility.
6517 When you want look-up or go to a different location in a document, the
6518 fastest way is often to fold the entire buffer and then dive into the tree.
6519 This method has the disadvantage, that the previous location will be folded,
6520 which may not be what you want.
6522 This command works around this by showing a copy of the current buffer
6523 in an indirect buffer, in overview mode. You can dive into the tree in
6524 that copy, use org-occur and incremental search to find a location.
6525 When pressing RET or `Q', the command returns to the original buffer in
6526 which the visibility is still unchanged. After RET is will also jump to
6527 the location selected in the indirect buffer and expose the
6528 the headline hierarchy above."
6529 (interactive "P")
6530 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6531 (org-refile-use-outline-path t)
6532 (org-refile-target-verify-function nil)
6533 (interface
6534 (if (not alternative-interface)
6535 org-goto-interface
6536 (if (eq org-goto-interface 'outline)
6537 'outline-path-completion
6538 'outline)))
6539 (org-goto-start-pos (point))
6540 (selected-point
6541 (if (eq interface 'outline)
6542 (car (org-get-location (current-buffer) org-goto-help))
6543 (let ((pa (org-refile-get-location "Goto: ")))
6544 (org-refile-check-position pa)
6545 (nth 3 pa)))))
6546 (if selected-point
6547 (progn
6548 (org-mark-ring-push org-goto-start-pos)
6549 (goto-char selected-point)
6550 (if (or (outline-invisible-p) (org-invisible-p2))
6551 (org-show-context 'org-goto)))
6552 (message "Quit"))))
6554 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6555 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6556 (defvar org-goto-local-auto-isearch-map) ; defined below
6558 (defun org-get-location (buf help)
6559 "Let the user select a location in the Org-mode buffer BUF.
6560 This function uses a recursive edit. It returns the selected position
6561 or nil."
6562 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6563 (isearch-hide-immediately nil)
6564 (isearch-search-fun-function
6565 (lambda () 'org-goto-local-search-headings))
6566 (org-goto-selected-point org-goto-exit-command)
6567 (pop-up-frames nil)
6568 (special-display-buffer-names nil)
6569 (special-display-regexps nil)
6570 (special-display-function nil))
6571 (save-excursion
6572 (save-window-excursion
6573 (delete-other-windows)
6574 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6575 (switch-to-buffer
6576 (condition-case nil
6577 (make-indirect-buffer (current-buffer) "*org-goto*")
6578 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6579 (with-output-to-temp-buffer "*Help*"
6580 (princ help))
6581 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6582 (setq buffer-read-only nil)
6583 (let ((org-startup-truncated t)
6584 (org-startup-folded nil)
6585 (org-startup-align-all-tables nil))
6586 (org-mode)
6587 (org-overview))
6588 (setq buffer-read-only t)
6589 (if (and (boundp 'org-goto-start-pos)
6590 (integer-or-marker-p org-goto-start-pos))
6591 (let ((org-show-hierarchy-above t)
6592 (org-show-siblings t)
6593 (org-show-following-heading t))
6594 (goto-char org-goto-start-pos)
6595 (and (outline-invisible-p) (org-show-context)))
6596 (goto-char (point-min)))
6597 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6598 (message "Select location and press RET")
6599 (use-local-map org-goto-map)
6600 (recursive-edit)
6601 ))
6602 (kill-buffer "*org-goto*")
6603 (cons org-goto-selected-point org-goto-exit-command)))
6605 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6606 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6607 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6608 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6610 (defun org-goto-local-search-headings (string bound noerror)
6611 "Search and make sure that any matches are in headlines."
6612 (catch 'return
6613 (while (if isearch-forward
6614 (search-forward string bound noerror)
6615 (search-backward string bound noerror))
6616 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6617 (and (member :headline context)
6618 (not (member :tags context))))
6619 (throw 'return (point))))))
6621 (defun org-goto-local-auto-isearch ()
6622 "Start isearch."
6623 (interactive)
6624 (goto-char (point-min))
6625 (let ((keys (this-command-keys)))
6626 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6627 (isearch-mode t)
6628 (isearch-process-search-char (string-to-char keys)))))
6630 (defun org-goto-ret (&optional arg)
6631 "Finish `org-goto' by going to the new location."
6632 (interactive "P")
6633 (setq org-goto-selected-point (point)
6634 org-goto-exit-command 'return)
6635 (throw 'exit nil))
6637 (defun org-goto-left ()
6638 "Finish `org-goto' by going to the new location."
6639 (interactive)
6640 (if (org-on-heading-p)
6641 (progn
6642 (beginning-of-line 1)
6643 (setq org-goto-selected-point (point)
6644 org-goto-exit-command 'left)
6645 (throw 'exit nil))
6646 (error "Not on a heading")))
6648 (defun org-goto-right ()
6649 "Finish `org-goto' by going to the new location."
6650 (interactive)
6651 (if (org-on-heading-p)
6652 (progn
6653 (setq org-goto-selected-point (point)
6654 org-goto-exit-command 'right)
6655 (throw 'exit nil))
6656 (error "Not on a heading")))
6658 (defun org-goto-quit ()
6659 "Finish `org-goto' without cursor motion."
6660 (interactive)
6661 (setq org-goto-selected-point nil)
6662 (setq org-goto-exit-command 'quit)
6663 (throw 'exit nil))
6665 ;;; Indirect buffer display of subtrees
6667 (defvar org-indirect-dedicated-frame nil
6668 "This is the frame being used for indirect tree display.")
6669 (defvar org-last-indirect-buffer nil)
6671 (defun org-tree-to-indirect-buffer (&optional arg)
6672 "Create indirect buffer and narrow it to current subtree.
6673 With numerical prefix ARG, go up to this level and then take that tree.
6674 If ARG is negative, go up that many levels.
6675 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6676 indirect buffer previously made with this command, to avoid proliferation of
6677 indirect buffers. However, when you call the command with a \
6679 when `org-indirect-buffer-display' is `new-frame', the last buffer
6680 is kept so that you can work with several indirect buffers at the same time.
6681 If `org-indirect-buffer-display' is `dedicated-frame', the \
6683 requests that a new frame be made for the new buffer, so that the dedicated
6684 frame is not changed."
6685 (interactive "P")
6686 (let ((cbuf (current-buffer))
6687 (cwin (selected-window))
6688 (pos (point))
6689 beg end level heading ibuf)
6690 (save-excursion
6691 (org-back-to-heading t)
6692 (when (numberp arg)
6693 (setq level (org-outline-level))
6694 (if (< arg 0) (setq arg (+ level arg)))
6695 (while (> (setq level (org-outline-level)) arg)
6696 (outline-up-heading 1 t)))
6697 (setq beg (point)
6698 heading (org-get-heading))
6699 (org-end-of-subtree t t)
6700 (if (org-on-heading-p) (backward-char 1))
6701 (setq end (point)))
6702 (if (and (buffer-live-p org-last-indirect-buffer)
6703 (not (eq org-indirect-buffer-display 'new-frame))
6704 (not arg))
6705 (kill-buffer org-last-indirect-buffer))
6706 (setq ibuf (org-get-indirect-buffer cbuf)
6707 org-last-indirect-buffer ibuf)
6708 (cond
6709 ((or (eq org-indirect-buffer-display 'new-frame)
6710 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6711 (select-frame (make-frame))
6712 (delete-other-windows)
6713 (switch-to-buffer ibuf)
6714 (org-set-frame-title heading))
6715 ((eq org-indirect-buffer-display 'dedicated-frame)
6716 (raise-frame
6717 (select-frame (or (and org-indirect-dedicated-frame
6718 (frame-live-p org-indirect-dedicated-frame)
6719 org-indirect-dedicated-frame)
6720 (setq org-indirect-dedicated-frame (make-frame)))))
6721 (delete-other-windows)
6722 (switch-to-buffer ibuf)
6723 (org-set-frame-title (concat "Indirect: " heading)))
6724 ((eq org-indirect-buffer-display 'current-window)
6725 (switch-to-buffer ibuf))
6726 ((eq org-indirect-buffer-display 'other-window)
6727 (pop-to-buffer ibuf))
6728 (t (error "Invalid value")))
6729 (if (featurep 'xemacs)
6730 (save-excursion (org-mode) (turn-on-font-lock)))
6731 (narrow-to-region beg end)
6732 (show-all)
6733 (goto-char pos)
6734 (and (window-live-p cwin) (select-window cwin))))
6736 (defun org-get-indirect-buffer (&optional buffer)
6737 (setq buffer (or buffer (current-buffer)))
6738 (let ((n 1) (base (buffer-name buffer)) bname)
6739 (while (buffer-live-p
6740 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6741 (setq n (1+ n)))
6742 (condition-case nil
6743 (make-indirect-buffer buffer bname 'clone)
6744 (error (make-indirect-buffer buffer bname)))))
6746 (defun org-set-frame-title (title)
6747 "Set the title of the current frame to the string TITLE."
6748 ;; FIXME: how to name a single frame in XEmacs???
6749 (unless (featurep 'xemacs)
6750 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6752 ;;;; Structure editing
6754 ;;; Inserting headlines
6756 (defun org-previous-line-empty-p ()
6757 (save-excursion
6758 (and (not (bobp))
6759 (or (beginning-of-line 0) t)
6760 (save-match-data
6763 (defun org-insert-heading (&optional force-heading invisible-ok)
6764 "Insert a new heading or item with same depth at point.
6765 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6766 If point is at the beginning of a headline, insert a sibling before the
6767 current headline. If point is not at the beginning, split the line,
6768 create the new headline with the text in the current line after point
6769 \(but see also the variable `org-M-RET-may-split-line').
6771 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6772 This is important for non-interactive uses of the command."
6773 (interactive "P")
6774 (if (or (= (buffer-size) 0)
6775 (and (not (save-excursion
6776 (and (ignore-errors (org-back-to-heading invisible-ok))
6777 (org-on-heading-p))))
6778 (not (org-in-item-p))))
6779 (progn
6781 (run-hooks 'org-insert-heading-hook))
6782 (when (or force-heading (not (org-insert-item)))
6783 (let* ((empty-line-p nil)
6784 (level nil)
6785 (on-heading (org-on-heading-p))
6786 (head (save-excursion
6787 (condition-case nil
6788 (progn
6789 (org-back-to-heading invisible-ok)
6790 (when (and (not on-heading)
6791 (featurep 'org-inlinetask)
6792 (integerp org-inlinetask-min-level)
6793 (>= (length (match-string 0))
6794 org-inlinetask-min-level))
6795 ;; Find a heading level before the inline task
6796 (while (and (setq level (org-up-heading-safe))
6797 (>= level org-inlinetask-min-level)))
6798 (if (org-on-heading-p)
6799 (org-back-to-heading invisible-ok)
6800 (error "This should not happen")))
6801 (setq empty-line-p (org-previous-line-empty-p))
6802 (match-string 0))
6803 (error "*"))))
6804 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6805 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6806 pos hide-previous previous-pos)
6807 (cond
6808 ((and (org-on-heading-p) (bolp)
6809 (or (bobp)
6810 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
6811 ;; insert before the current line
6812 (open-line (if blank 2 1)))
6813 ((and (bolp)
6814 (not org-insert-heading-respect-content)
6815 (or (bobp)
6816 (save-excursion
6817 (backward-char 1) (not (outline-invisible-p)))))
6818 ;; insert right here
6819 nil)
6820 (t
6821 ;; somewhere in the line
6822 (save-excursion
6823 (setq previous-pos (point-at-bol))
6824 (end-of-line)
6825 (setq hide-previous (outline-invisible-p)))
6826 (and org-insert-heading-respect-content (org-show-subtree))
6827 (let ((split
6828 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6829 (save-excursion
6830 (let ((p (point)))
6831 (goto-char (point-at-bol))
6832 (and (looking-at org-complex-heading-regexp)
6833 (> p (match-beginning 4)))))))
6834 tags pos)
6835 (cond
6836 (org-insert-heading-respect-content
6837 (org-end-of-subtree nil t)
6838 (when (featurep 'org-inlinetask)
6839 (while (and (not (eobp))
6841 (>= (length (match-string 1))
6842 org-inlinetask-min-level))
6843 (org-end-of-subtree nil t)))
6844 (or (bolp) (newline))
6845 (or (org-previous-line-empty-p)
6846 (and blank (newline)))
6847 (open-line 1))
6848 ((org-on-heading-p)
6849 (when hide-previous
6850 (show-children)
6851 (org-show-entry))
6853 (setq tags (and (match-end 2) (match-string 2)))
6854 (and (match-end 1)
6855 (delete-region (match-beginning 1) (match-end 1)))
6856 (setq pos (point-at-bol))
6857 (or split (end-of-line 1))
6858 (delete-horizontal-space)
6860 (buffer-substring (point-at-bol) (point)))
6861 (insert " "))
6862 (newline (if blank 2 1))
6863 (when tags
6864 (save-excursion
6865 (goto-char pos)
6866 (end-of-line 1)
6867 (insert " " tags)
6868 (org-set-tags nil 'align))))
6869 (t
6870 (or split (end-of-line 1))
6871 (newline (if blank 2 1)))))))
6872 (insert head) (just-one-space)
6873 (setq pos (point))
6874 (end-of-line 1)
6875 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6876 (when (and org-insert-heading-respect-content hide-previous)
6877 (save-excursion
6878 (goto-char previous-pos)
6879 (hide-subtree)))
6880 (run-hooks 'org-insert-heading-hook)))))
6882 (defun org-get-heading (&optional no-tags)
6883 "Return the heading of the current entry, without the stars."
6884 (save-excursion
6885 (org-back-to-heading t)
6886 (if (looking-at
6887 (if no-tags
6890 (match-string 1) "")))
6892 (defun org-heading-components ()
6893 "Return the components of the current heading.
6894 This is a list with the following elements:
6895 - the level as an integer
6896 - the reduced level, different if `org-odd-levels-only' is set.
6897 - the TODO keyword, or nil
6898 - the priority character, like ?A, or nil if no priority is given
6899 - the headline text itself, or the tags string if no headline text
6900 - the tags string, or nil."
6901 (save-excursion
6902 (org-back-to-heading t)
6903 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6904 (list (length (match-string 1))
6905 (org-reduced-level (length (match-string 1)))
6906 (org-match-string-no-properties 2)
6907 (and (match-end 3) (aref (match-string 3) 2))
6908 (org-match-string-no-properties 4)
6909 (org-match-string-no-properties 5)))))
6911 (defun org-get-entry ()
6912 "Get the entry text, after heading, entire subtree."
6913 (save-excursion
6914 (org-back-to-heading t)
6915 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6917 (defun org-insert-heading-after-current ()
6918 "Insert a new heading with same level as current, after current subtree."
6919 (interactive)
6920 (org-back-to-heading)
6921 (org-insert-heading)
6922 (org-move-subtree-down)
6923 (end-of-line 1))
6925 (defun org-insert-heading-respect-content ()
6926 (interactive)
6927 (let ((org-insert-heading-respect-content t))
6928 (org-insert-heading t)))
6930 (defun org-insert-todo-heading-respect-content (&optional force-state)
6931 (interactive "P")
6932 (let ((org-insert-heading-respect-content t))
6933 (org-insert-todo-heading force-state t)))
6935 (defun org-insert-todo-heading (arg &optional force-heading)
6936 "Insert a new heading with the same level and TODO state as current heading.
6937 If the heading has no TODO state, or if the state is DONE, use the first
6938 state (TODO by default). Also with prefix arg, force first state."
6939 (interactive "P")
6940 (when (or force-heading (not (org-insert-item 'checkbox)))
6941 (org-insert-heading force-heading)
6942 (save-excursion
6943 (org-back-to-heading)
6944 (outline-previous-heading)
6945 (looking-at org-todo-line-regexp))
6946 (let*
6947 ((new-mark-x
6948 (if (or arg
6949 (not (match-beginning 2))
6950 (member (match-string 2) org-done-keywords))
6951 (car org-todo-keywords-1)
6952 (match-string 2)))
6953 (new-mark
6954 (or
6955 (run-hook-with-args-until-success
6956 'org-todo-get-default-hook new-mark-x nil)
6957 new-mark-x)))
6958 (beginning-of-line 1)
6960 (if org-treat-insert-todo-heading-as-state-change
6961 (org-todo new-mark)
6962 (insert new-mark " "))))
6963 (when org-provide-todo-statistics
6964 (org-update-parent-todo-statistics))))
6966 (defun org-insert-subheading (arg)
6967 "Insert a new subheading and demote it.
6968 Works for outline headings and for plain lists alike."
6969 (interactive "P")
6970 (org-insert-heading arg)
6971 (cond
6972 ((org-on-heading-p) (org-do-demote))
6973 ((org-at-item-p) (org-indent-item))))
6975 (defun org-insert-todo-subheading (arg)
6976 "Insert a new subheading with TODO keyword or checkbox and demote it.
6977 Works for outline headings and for plain lists alike."
6978 (interactive "P")
6979 (org-insert-todo-heading arg)
6980 (cond
6981 ((org-on-heading-p) (org-do-demote))
6982 ((org-at-item-p) (org-indent-item))))
6984 ;;; Promotion and Demotion
6986 (defvar org-after-demote-entry-hook nil
6987 "Hook run after an entry has been demoted.
6988 The cursor will be at the beginning of the entry.
6989 When a subtree is being demoted, the hook will be called for each node.")
6991 (defvar org-after-promote-entry-hook nil
6992 "Hook run after an entry has been promoted.
6993 The cursor will be at the beginning of the entry.
6994 When a subtree is being promoted, the hook will be called for each node.")
6996 (defun org-promote-subtree ()
6997 "Promote the entire subtree.
6998 See also `org-promote'."
6999 (interactive)
7000 (save-excursion
7001 (org-map-tree 'org-promote))
7002 (org-fix-position-after-promote))
7004 (defun org-demote-subtree ()
7005 "Demote the entire subtree. See `org-demote'.
7006 See also `org-promote'."
7007 (interactive)
7008 (save-excursion
7009 (org-map-tree 'org-demote))
7010 (org-fix-position-after-promote))
7013 (defun org-do-promote ()
7014 "Promote the current heading higher up the tree.
7015 If the region is active in `transient-mark-mode', promote all headings
7016 in the region."
7017 (interactive)
7018 (save-excursion
7019 (if (org-region-active-p)
7020 (org-map-region 'org-promote (region-beginning) (region-end))
7021 (org-promote)))
7022 (org-fix-position-after-promote))
7024 (defun org-do-demote ()
7025 "Demote the current heading lower down the tree.
7026 If the region is active in `transient-mark-mode', demote all headings
7027 in the region."
7028 (interactive)
7029 (save-excursion
7030 (if (org-region-active-p)
7031 (org-map-region 'org-demote (region-beginning) (region-end))
7032 (org-demote)))
7033 (org-fix-position-after-promote))
7035 (defun org-fix-position-after-promote ()
7036 "Make sure that after pro/demotion cursor position is right."
7037 (let ((pos (point)))
7038 (when (save-excursion
7039 (beginning-of-line 1)
7040 (looking-at org-todo-line-regexp)
7041 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7042 (cond ((eobp) (insert " "))
7043 ((eolp) (insert " "))
7044 ((equal (char-after) ?\ ) (forward-char 1))))))
7046 (defun org-current-level ()
7047 "Return the level of the current entry, or nil if before the first headline.
7048 The level is the number of stars at the beginning of the headline."
7049 (save-excursion
7050 (org-with-limited-levels
7051 (ignore-errors
7052 (org-back-to-heading t)
7053 (funcall outline-level)))))
7055 (defun org-get-previous-line-level ()
7056 "Return the outline depth of the last headline before the current line.
7057 Returns 0 for the first headline in the buffer, and nil if before the
7058 first headline."
7059 (let ((current-level (org-current-level))
7060 (prev-level (when (> (line-number-at-pos) 1)
7061 (save-excursion
7062 (beginning-of-line 0)
7063 (org-current-level)))))
7064 (cond ((null current-level) nil) ; Before first headline
7065 ((null prev-level) 0) ; At first headline
7066 (prev-level))))
7068 (defun org-reduced-level (l)
7069 "Compute the effective level of a heading.
7070 This takes into account the setting of `org-odd-levels-only'."
7071 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
7073 (defun org-level-increment ()
7074 "Return the number of stars that will be added or removed at a
7075 time to headlines when structure editing, based on the value of
7076 `org-odd-levels-only'."
7077 (if org-odd-levels-only 2 1))
7079 (defun org-get-valid-level (level &optional change)
7080 "Rectify a level change under the influence of `org-odd-levels-only'
7081 LEVEL is a current level, CHANGE is by how much the level should be
7082 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7083 even level numbers will become the next higher odd number."
7084 (if org-odd-levels-only
7085 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7086 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7087 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7088 (max 1 (+ level (or change 0)))))
7090 (if (boundp 'define-obsolete-function-alias)
7091 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7092 (define-obsolete-function-alias 'org-get-legal-level
7093 'org-get-valid-level)
7094 (define-obsolete-function-alias 'org-get-legal-level
7095 'org-get-valid-level "23.1")))
7097 (defun org-promote ()
7098 "Promote the current heading higher up the tree.
7099 If the region is active in `transient-mark-mode', promote all headings
7100 in the region."
7101 (org-back-to-heading t)
7102 (let* ((level (save-match-data (funcall outline-level)))
7103 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7104 (diff (abs (- level (length up-head) -1))))
7105 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7106 (replace-match up-head nil t)
7107 ;; Fixup tag positioning
7108 (and org-auto-align-tags (org-set-tags nil t))
7109 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7110 (run-hooks 'org-after-promote-entry-hook)))
7112 (defun org-demote ()
7113 "Demote the current heading lower down the tree.
7114 If the region is active in `transient-mark-mode', demote all headings
7115 in the region."
7116 (org-back-to-heading t)
7117 (let* ((level (save-match-data (funcall outline-level)))
7118 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7119 (diff (abs (- level (length down-head) -1))))
7120 (replace-match down-head nil t)
7121 ;; Fixup tag positioning
7122 (and org-auto-align-tags (org-set-tags nil t))
7123 (if org-adapt-indentation (org-fixup-indentation diff))
7124 (run-hooks 'org-after-demote-entry-hook)))
7126 (defun org-cycle-level ()
7127 "Cycle the level of an empty headline through possible states.
7128 This goes first to child, then to parent, level, then up the hierarchy.
7129 After top level, it switches back to sibling level."
7130 (interactive)
7131 (let ((org-adapt-indentation nil))
7132 (when (org-point-at-end-of-empty-headline)
7133 (setq this-command 'org-cycle-level) ; Only needed for caching
7134 (let ((cur-level (org-current-level))
7135 (prev-level (org-get-previous-line-level)))
7136 (cond
7137 ;; If first headline in file, promote to top-level.
7138 ((= prev-level 0)
7139 (loop repeat (/ (- cur-level 1) (org-level-increment))
7140 do (org-do-promote)))
7141 ;; If same level as prev, demote one.
7142 ((= prev-level cur-level)
7143 (org-do-demote))
7144 ;; If parent is top-level, promote to top level if not already.
7145 ((= prev-level 1)
7146 (loop repeat (/ (- cur-level 1) (org-level-increment))
7147 do (org-do-promote)))
7148 ;; If top-level, return to prev-level.
7149 ((= cur-level 1)
7150 (loop repeat (/ (- prev-level 1) (org-level-increment))
7151 do (org-do-demote)))
7152 ;; If less than prev-level, promote one.
7153 ((< cur-level prev-level)
7154 (org-do-promote))
7155 ;; If deeper than prev-level, promote until higher than
7156 ;; prev-level.
7157 ((> cur-level prev-level)
7158 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7159 do (org-do-promote))))
7160 t))))
7162 (defun org-map-tree (fun)
7163 "Call FUN for every heading underneath the current one."
7164 (org-back-to-heading)
7165 (let ((level (funcall outline-level)))
7166 (save-excursion
7167 (funcall fun)
7168 (while (and (progn
7169 (outline-next-heading)
7170 (> (funcall outline-level) level))
7171 (not (eobp)))
7172 (funcall fun)))))
7174 (defun org-map-region (fun beg end)
7175 "Call FUN for every heading between BEG and END."
7176 (let ((org-ignore-region t))
7177 (save-excursion
7178 (setq end (copy-marker end))
7179 (goto-char beg)
7180 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
7181 (< (point) end))
7182 (funcall fun))
7183 (while (and (progn
7184 (outline-next-heading)
7185 (< (point) end))
7186 (not (eobp)))
7187 (funcall fun)))))
7189 (defun org-fixup-indentation (diff)
7190 "Change the indentation in the current entry by DIFF.
7191 However, if any line in the current entry has no indentation, or if it
7192 would end up with no indentation after the change, nothing at all is done."
7193 (save-excursion
7194 (let ((end (save-excursion (outline-next-heading)
7195 (point-marker)))
7196 (prohibit (if (> diff 0)
7199 col)
7200 (unless (save-excursion (end-of-line 1)
7201 (re-search-forward prohibit end t))
7202 (while (and (< (point) end)
7204 (goto-char (match-end 0))
7205 (setq col (current-column))
7206 (if (< diff 0) (replace-match ""))
7207 (org-indent-to-column (+ diff col))))
7208 (move-marker end nil))))
7210 (defun org-convert-to-odd-levels ()
7211 "Convert an org-mode file with all levels allowed to one with odd levels.
7212 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7213 level 5 etc."
7214 (interactive)
7215 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7216 (let ((outline-regexp org-outline-regexp)
7217 (outline-level 'org-outline-level)
7218 (org-odd-levels-only nil) n)
7219 (save-excursion
7220 (goto-char (point-min))
7222 (setq n (- (length (match-string 0)) 2))
7223 (while (>= (setq n (1- n)) 0)
7224 (org-demote))
7225 (end-of-line 1))))))
7227 (defun org-convert-to-oddeven-levels ()
7228 "Convert an org-mode file with only odd levels to one with odd/even levels.
7229 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7230 file contains a section with an even level, conversion would
7231 destroy the structure of the file. An error is signaled in this
7232 case."
7233 (interactive)
7234 (goto-char (point-min))
7235 ;; First check if there are no even levels
7237 (org-show-context t)
7238 (error "Not all levels are odd in this file. Conversion not possible"))
7239 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7240 (let ((outline-regexp org-outline-regexp)
7241 (outline-level 'org-outline-level)
7242 (org-odd-levels-only nil) n)
7243 (save-excursion
7244 (goto-char (point-min))
7246 (setq n (/ (1- (length (match-string 0))) 2))
7247 (while (>= (setq n (1- n)) 0)
7248 (org-promote))
7249 (end-of-line 1))))))
7251 (defun org-tr-level (n)
7252 "Make N odd if required."
7253 (if org-odd-levels-only (1+ (/ n 2)) n))
7255 ;;; Vertical tree motion, cutting and pasting of subtrees
7257 (defun org-move-subtree-up (&optional arg)
7258 "Move the current subtree up past ARG headlines of the same level."
7259 (interactive "p")
7260 (org-move-subtree-down (- (prefix-numeric-value arg))))
7262 (defun org-move-subtree-down (&optional arg)
7263 "Move the current subtree down past ARG headlines of the same level."
7264 (interactive "p")
7265 (setq arg (prefix-numeric-value arg))
7266 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7267 'org-get-last-sibling))
7268 (ins-point (make-marker))
7269 (cnt (abs arg))
7270 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7271 ;; Select the tree
7272 (org-back-to-heading)
7273 (setq beg0 (point))
7274 (save-excursion
7275 (setq ne-beg (org-back-over-empty-lines))
7276 (setq beg (point)))
7277 (save-match-data
7278 (save-excursion (outline-end-of-heading)
7279 (setq folded (outline-invisible-p)))
7280 (outline-end-of-subtree))
7281 (outline-next-heading)
7282 (setq ne-end (org-back-over-empty-lines))
7283 (setq end (point))
7284 (goto-char beg0)
7285 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7286 ;; include less whitespace
7287 (save-excursion
7288 (goto-char beg)
7289 (forward-line (- ne-beg ne-end))
7290 (setq beg (point))))
7291 ;; Find insertion point, with error handling
7292 (while (> cnt 0)
7293 (or (and (funcall movfunc) (looking-at outline-regexp))
7294 (progn (goto-char beg0)
7295 (error "Cannot move past superior level or buffer limit")))
7296 (setq cnt (1- cnt)))
7297 (if (> arg 0)
7298 ;; Moving forward - still need to move over subtree
7299 (progn (org-end-of-subtree t t)
7300 (save-excursion
7301 (org-back-over-empty-lines)
7302 (or (bolp) (newline)))))
7303 (setq ne-ins (org-back-over-empty-lines))
7304 (move-marker ins-point (point))
7305 (setq txt (buffer-substring beg end))
7306 (org-save-markers-in-region beg end)
7307 (delete-region beg end)
7308 (org-remove-empty-overlays-at beg)
7309 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7310 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7312 (let ((bbb (point)))
7313 (insert-before-markers txt)
7314 (org-reinstall-markers-in-region bbb)
7315 (move-marker ins-point bbb))
7317 (setq ins-end (point))
7318 (goto-char ins-point)
7319 (org-skip-whitespace)
7320 (when (and (< arg 0)
7321 (org-first-sibling-p)
7322 (> ne-ins ne-beg))
7323 ;; Move whitespace back to beginning
7324 (save-excursion
7325 (goto-char ins-end)
7326 (let ((kill-whole-line t))
7327 (kill-line (- ne-ins ne-beg)) (point)))
7329 (move-marker ins-point nil)
7330 (if folded
7331 (hide-subtree)
7332 (org-show-entry)
7333 (show-children)
7334 (org-cycle-hide-drawers 'children))
7335 (org-clean-visibility-after-subtree-move)))
7337 (defvar org-subtree-clip ""
7338 "Clipboard for cut and paste of subtrees.
7339 This is actually only a copy of the kill, because we use the normal kill
7340 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7342 (defvar org-subtree-clip-folded nil
7343 "Was the last copied subtree folded?
7344 This is used to fold the tree back after pasting.")
7346 (defun org-cut-subtree (&optional n)
7347 "Cut the current subtree into the clipboard.
7348 With prefix arg N, cut this many sequential subtrees.
7349 This is a short-hand for marking the subtree and then cutting it."
7350 (interactive "p")
7351 (org-copy-subtree n 'cut))
7353 (defun org-copy-subtree (&optional n cut force-store-markers)
7354 "Cut the current subtree into the clipboard.
7355 With prefix arg N, cut this many sequential subtrees.
7356 This is a short-hand for marking the subtree and then copying it.
7357 If CUT is non-nil, actually cut the subtree.
7358 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7359 of some markers in the region, even if CUT is non-nil. This is
7360 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7361 (interactive "p")
7362 (let (beg end folded (beg0 (point)))
7363 (if (interactive-p)
7364 (org-back-to-heading nil) ; take what looks like a subtree
7365 (org-back-to-heading t)) ; take what is really there
7366 (org-back-over-empty-lines)
7367 (setq beg (point))
7369 (save-match-data
7370 (save-excursion (outline-end-of-heading)
7371 (setq folded (outline-invisible-p)))
7372 (condition-case nil
7373 (org-forward-same-level (1- n) t)
7374 (error nil))
7375 (org-end-of-subtree t t))
7376 (org-back-over-empty-lines)
7377 (setq end (point))
7378 (goto-char beg0)
7379 (when (> end beg)
7380 (setq org-subtree-clip-folded folded)
7381 (when (or cut force-store-markers)
7382 (org-save-markers-in-region beg end))
7383 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7384 (setq org-subtree-clip (current-kill 0))
7385 (message "%s: Subtree(s) with %d characters"
7386 (if cut "Cut" "Copied")
7387 (length org-subtree-clip)))))
7389 (defun org-paste-subtree (&optional level tree for-yank)
7390 "Paste the clipboard as a subtree, with modification of headline level.
7391 The entire subtree is promoted or demoted in order to match a new headline
7392 level.
7394 If the cursor is at the beginning of a headline, the same level as
7395 that headline is used to paste the tree
7397 If not, the new level is derived from the *visible* headings
7398 before and after the insertion point, and taken to be the inferior headline
7399 level of the two. So if the previous visible heading is level 3 and the
7400 next is level 4 (or vice versa), level 4 will be used for insertion.
7401 This makes sure that the subtree remains an independent subtree and does
7402 not swallow low level entries.
7404 You can also force a different level, either by using a numeric prefix
7405 argument, or by inserting the heading marker by hand. For example, if the
7408 If optional TREE is given, use this text instead of the kill ring.
7410 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7411 move back over whitespace before inserting, and move point to the end of
7412 the inserted text when done."
7413 (interactive "P")
7414 (setq tree (or tree (and kill-ring (current-kill 0))))
7415 (unless (org-kill-is-subtree-p tree)
7416 (error "%s"
7417 (substitute-command-keys
7419 (let* ((visp (not (outline-invisible-p)))
7420 (txt tree)
7425 (old-level (if (string-match ^re txt)
7426 (- (match-end 0) (match-beginning 0) 1)
7427 -1))
7428 (force-level (cond (level (prefix-numeric-value level))
7430 (string-match
7431 ^re_ (buffer-substring
7432 (point-at-bol) (point))))
7433 (- (match-end 1) (match-beginning 1)))
7434 ((and (bolp)
7435 (looking-at org-outline-regexp))
7436 (- (match-end 0) (point) 1))
7437 (t nil)))
7438 (previous-level (save-excursion
7439 (condition-case nil
7440 (progn
7441 (outline-previous-visible-heading 1)
7442 (if (looking-at re)
7443 (- (match-end 0) (match-beginning 0) 1)
7444 1))
7445 (error 1))))
7446 (next-level (save-excursion
7447 (condition-case nil
7448 (progn
7449 (or (looking-at outline-regexp)
7450 (outline-next-visible-heading 1))
7451 (if (looking-at re)
7452 (- (match-end 0) (match-beginning 0) 1)
7453 1))
7454 (error 1))))
7455 (new-level (or force-level (max previous-level next-level)))
7456 (shift (if (or (= old-level -1)
7457 (= new-level -1)
7458 (= old-level new-level))
7459 0
7460 (- new-level old-level)))
7461 (delta (if (> shift 0) -1 1))
7462 (func (if (> shift 0) 'org-demote 'org-promote))
7463 (org-odd-levels-only nil)
7464 beg end newend)
7465 ;; Remove the forced level indicator
7466 (if force-level
7467 (delete-region (point-at-bol) (point)))
7468 ;; Paste
7469 (beginning-of-line 1)
7470 (unless for-yank (org-back-over-empty-lines))
7471 (setq beg (point))
7472 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7473 (insert-before-markers txt)
7475 (setq newend (point))
7476 (org-reinstall-markers-in-region beg)
7477 (setq end (point))
7478 (goto-char beg)
7480 (setq beg (point))
7481 (if (and (outline-invisible-p) visp)
7482 (save-excursion (outline-show-heading)))
7483 ;; Shift if necessary
7484 (unless (= shift 0)
7485 (save-restriction
7486 (narrow-to-region beg end)
7487 (while (not (= shift 0))
7488 (org-map-region func (point-min) (point-max))
7489 (setq shift (+ delta shift)))
7490 (goto-char (point-min))
7491 (setq newend (point-max))))
7492 (when (or (interactive-p) for-yank)
7493 (message "Clipboard pasted as level %d subtree" new-level))
7494 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7495 kill-ring
7496 (eq org-subtree-clip (current-kill 0))
7497 org-subtree-clip-folded)
7498 ;; The tree was folded before it was killed/copied
7499 (hide-subtree))
7500 (and for-yank (goto-char newend))))
7502 (defun org-kill-is-subtree-p (&optional txt)
7503 "Check if the current kill is an outline subtree, or a set of trees.
7504 Returns nil if kill does not start with a headline, or if the first
7505 headline level is not the largest headline level in the tree.
7506 So this will actually accept several entries of equal levels as well,
7507 which is OK for `org-paste-subtree'.
7508 If optional TXT is given, check this string instead of the current kill."
7509 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7510 (start-level (and kill
7513 kill)
7514 (- (match-end 2) (match-beginning 2) 1)))
7515 (re (concat "^" org-outline-regexp))
7516 (start (1+ (or (match-beginning 2) -1))))
7517 (if (not start-level)
7518 (progn
7519 nil) ;; does not even start with a heading
7520 (catch 'exit
7521 (while (setq start (string-match re kill (1+ start)))
7522 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7523 (throw 'exit nil)))
7524 t))))
7526 (defvar org-markers-to-move nil
7527 "Markers that should be moved with a cut-and-paste operation.
7528 Those markers are stored together with their positions relative to
7529 the start of the region.")
7531 (defun org-save-markers-in-region (beg end)
7532 "Check markers in region.
7533 If these markers are between BEG and END, record their position relative
7534 to BEG, so that after moving the block of text, we can put the markers back
7535 into place.
7536 This function gets called just before an entry or tree gets cut from the
7537 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7538 called immediately, to move the markers with the entries."
7539 (setq org-markers-to-move nil)
7540 (when (featurep 'org-clock)
7541 (org-clock-save-markers-for-cut-and-paste beg end))
7542 (when (featurep 'org-agenda)
7543 (org-agenda-save-markers-for-cut-and-paste beg end)))
7545 (defun org-check-and-save-marker (marker beg end)
7546 "Check if MARKER is between BEG and END.
7547 If yes, remember the marker and the distance to BEG."
7548 (when (and (marker-buffer marker)
7549 (equal (marker-buffer marker) (current-buffer)))
7550 (if (and (>= marker beg) (< marker end))
7551 (push (cons marker (- marker beg)) org-markers-to-move))))
7553 (defun org-reinstall-markers-in-region (beg)
7554 "Move all remembered markers to their position relative to BEG."
7555 (mapc (lambda (x)
7556 (move-marker (car x) (+ beg (cdr x))))
7557 org-markers-to-move)
7558 (setq org-markers-to-move nil))
7560 (defun org-narrow-to-subtree ()
7561 "Narrow buffer to the current subtree."
7562 (interactive)
7563 (save-excursion
7564 (save-match-data
7565 (narrow-to-region
7566 (progn (org-back-to-heading t) (point))
7567 (progn (org-end-of-subtree t t)
7568 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7569 (point))))))
7571 (defun org-narrow-to-block ()
7572 "Narrow buffer to the current block."
7573 (interactive)
7576 (case-fold-search t) ;; allow #+BEGIN
7577 b_start b_end)
7578 (if (org-in-regexps-block-p bstart bend)
7579 (progn
7580 (save-excursion (re-search-backward bstart nil t)
7581 (setq b_start (match-beginning 0)))
7582 (save-excursion (re-search-forward bend nil t)
7583 (setq b_end (match-end 0)))
7584 (narrow-to-region b_start b_end))
7585 (error "Not in a block"))))
7587 (eval-when-compile
7588 (defvar org-property-drawer-re))
7590 (defvar org-property-start-re) ;; defined below
7591 (defun org-clone-subtree-with-time-shift (n &optional shift)
7592 "Clone the task (subtree) at point N times.
7593 The clones will be inserted as siblings.
7595 In interactive use, the user will be prompted for the number of
7596 clones to be produced, and for a time SHIFT, which may be a
7597 repeater as used in time stamps, for example `+3d'.
7599 When a valid repeater is given and the entry contains any time
7600 stamps, the clones will become a sequence in time, with time
7601 stamps in the subtree shifted for each clone produced. If SHIFT
7602 is nil or the empty string, time stamps will be left alone. The
7603 ID property of the original subtree is removed.
7605 If the original subtree did contain time stamps with a repeater,
7606 the following will happen:
7607 - the repeater will be removed in each clone
7608 - an additional clone will be produced, with the current, unshifted
7609 date(s) in the entry.
7610 - the original entry will be placed *after* all the clones, with
7611 repeater intact.
7612 - the start days in the repeater in the original entry will be shifted
7613 to past the last clone.
7614 I this way you can spell out a number of instances of a repeating task,
7615 and still retain the repeater to cover future instances of the task."
7616 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7617 (let (beg end template task idprop
7618 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7619 (if (not (and (integerp n) (> n 0)))
7620 (error "Invalid number of replications %s" n))
7623 shift)))
7624 (error "Invalid shift specification %s" shift))
7625 (when doshift
7626 (setq shift-n (string-to-number (match-string 1 shift))
7627 shift-what (cdr (assoc (match-string 2 shift)
7628 '(("d" . day) ("w" . week)
7629 ("m" . month) ("y" . year))))))
7630 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7631 (setq nmin 1 nmax n)
7632 (org-back-to-heading t)
7633 (setq beg (point))
7634 (setq idprop (org-entry-get nil "ID"))
7635 (org-end-of-subtree t t)
7637 (setq end (point))
7638 (setq template (buffer-substring beg end))
7639 (when (and doshift
7641 (delete-region beg end)
7642 (setq end beg)
7643 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7644 (goto-char end)
7645 (loop for n from nmin to nmax do
7646 ;; prepare clone
7647 (with-temp-buffer
7648 (insert template)
7649 (org-mode)
7650 (goto-char (point-min))
7651 (and idprop (if org-clone-delete-id
7652 (org-entry-delete nil "ID")
7653 (org-id-get-create t)))
7654 (while (re-search-forward org-property-start-re nil t)
7655 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7656 (goto-char (point-min))
7657 (when doshift
7658 (while (re-search-forward org-ts-regexp-both nil t)
7659 (org-timestamp-change (* n shift-n) shift-what))
7660 (unless (= n n-no-remove)
7661 (goto-char (point-min))
7662 (while (re-search-forward org-ts-regexp nil t)
7663 (save-excursion
7664 (goto-char (match-beginning 0))
7666 (delete-region (match-beginning 1) (match-end 1)))))))
7667 (setq task (buffer-string)))
7668 (insert task))
7669 (goto-char beg)))
7671 ;;; Outline Sorting
7673 (defun org-sort (with-case)
7674 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7675 Optional argument WITH-CASE means sort case-sensitively.
7676 With a double prefix argument, also remove duplicate entries."
7677 (interactive "P")
7678 (cond
7679 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7680 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7681 (t
7682 (org-call-with-arg 'org-sort-entries with-case))))
7684 (defun org-sort-remove-invisible (s)
7685 (remove-text-properties 0 (length s) org-rm-props s)
7686 (while (string-match org-bracket-link-regexp s)
7687 (setq s (replace-match (if (match-end 2)
7688 (match-string 3 s)
7689 (match-string 1 s)) t t s)))
7690 s)
7692 (defvar org-priority-regexp) ; defined later in the file
7694 (defvar org-after-sorting-entries-or-items-hook nil
7695 "Hook that is run after a bunch of entries or items have been sorted.
7696 When children are sorted, the cursor is in the parent line when this
7697 hook gets called. When a region or a plain list is sorted, the cursor
7698 will be in the first entry of the sorted region/list.")
7700 (defun org-sort-entries
7701 (&optional with-case sorting-type getkey-func compare-func property)
7702 "Sort entries on a certain level of an outline tree.
7703 If there is an active region, the entries in the region are sorted.
7704 Else, if the cursor is before the first entry, sort the top-level items.
7705 Else, the children of the entry at point are sorted.
7707 Sorting can be alphabetically, numerically, by date/time as given by
7708 a time stamp, by a property or by priority.
7710 The command prompts for the sorting type unless it has been given to the
7711 function through the SORTING-TYPE argument, which needs to be a character,
7712 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7713 precise meaning of each character:
7715 n Numerically, by converting the beginning of the entry/item to a number.
7716 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7717 t By date/time, either the first active time stamp in the entry, or, if
7718 none exist, by the first inactive one.
7719 s By the scheduled date/time.
7720 d By deadline date/time.
7721 c By creation time, which is assumed to be the first inactive time stamp
7722 at the beginning of a line.
7723 p By priority according to the cookie.
7724 r By the value of a property.
7726 Capital letters will reverse the sort order.
7728 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7729 called with point at the beginning of the record. It must return either
7730 a string or a number that should serve as the sorting key for that record.
7732 Comparing entries ignores case by default. However, with an optional argument
7733 WITH-CASE, the sorting considers case as well."
7734 (interactive "P")
7735 (let ((case-func (if with-case 'identity 'downcase))
7736 start beg end stars re re2
7737 txt what tmp)
7738 ;; Find beginning and end of region to sort
7739 (cond
7740 ((org-region-active-p)
7741 ;; we will sort the region
7742 (setq end (region-end)
7743 what "region")
7744 (goto-char (region-beginning))
7745 (if (not (org-on-heading-p)) (outline-next-heading))
7746 (setq start (point)))
7747 ((or (org-on-heading-p)
7748 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7749 ;; we will sort the children of the current headline
7750 (org-back-to-heading)
7751 (setq start (point)
7752 end (progn (org-end-of-subtree t t)
7754 (org-back-over-empty-lines)
7755 (point))
7756 what "children")
7757 (goto-char start)
7758 (show-subtree)
7759 (outline-next-heading))
7760 (t
7761 ;; we will sort the top-level entries in this file
7762 (goto-char (point-min))
7763 (or (org-on-heading-p) (outline-next-heading))
7764 (setq start (point))
7765 (goto-char (point-max))
7766 (beginning-of-line 1)
7768 ;; File ends in a non-white line
7769 (end-of-line 1)
7771 (setq end (point-max))
7772 (setq what "top-level")
7773 (goto-char start)
7774 (show-all)))
7776 (setq beg (point))
7777 (if (>= beg end) (error "Nothing to sort"))
7780 (setq stars (match-string 1)
7781 re (concat "^" (regexp-quote stars) " +")
7783 txt (buffer-substring beg end))
7785 (if (and (not (equal stars "*")) (string-match re2 txt))
7786 (error "Region to sort contains a level above the first entry"))
7788 (unless sorting-type
7789 (message
7790 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7792 A/N/T/S/D/C/P/O/F means reversed:"
7793 what)
7794 (setq sorting-type (read-char-exclusive))
7796 (and (= (downcase sorting-type) ?f)
7797 (setq getkey-func
7798 (org-icompleting-read "Sort using function: "
7799 obarray 'fboundp t nil nil))
7800 (setq getkey-func (intern getkey-func)))
7802 (and (= (downcase sorting-type) ?r)
7803 (setq property
7804 (org-icompleting-read "Property: "
7805 (mapcar 'list (org-buffer-property-keys t))
7806 nil t))))
7808 (message "Sorting entries...")
7810 (save-restriction
7811 (narrow-to-region start end)
7812 (let ((dcst (downcase sorting-type))
7813 (case-fold-search nil)
7814 (now (current-time)))
7815 (sort-subr
7816 (/= dcst sorting-type)
7817 ;; This function moves to the beginning character of the "record" to
7818 ;; be sorted.
7819 (lambda nil
7820 (if (re-search-forward re nil t)
7821 (goto-char (match-beginning 0))
7822 (goto-char (point-max))))
7823 ;; This function moves to the last character of the "record" being
7824 ;; sorted.
7825 (lambda nil
7826 (save-match-data
7827 (condition-case nil
7828 (outline-forward-same-level 1)
7829 (error
7830 (goto-char (point-max))))))
7831 ;; This function returns the value that gets sorted against.
7832 (lambda nil
7833 (cond
7834 ((= dcst ?n)
7835 (if (looking-at org-complex-heading-regexp)
7836 (string-to-number (match-string 4))
7837 nil))
7838 ((= dcst ?a)
7839 (if (looking-at org-complex-heading-regexp)
7840 (funcall case-func (match-string 4))
7841 nil))
7842 ((= dcst ?t)
7843 (let ((end (save-excursion (outline-next-heading) (point))))
7844 (if (or (re-search-forward org-ts-regexp end t)
7845 (re-search-forward org-ts-regexp-both end t))
7846 (org-time-string-to-seconds (match-string 0))
7847 (org-float-time now))))
7848 ((= dcst ?c)
7849 (let ((end (save-excursion (outline-next-heading) (point))))
7850 (if (re-search-forward
7852 end t)
7853 (org-time-string-to-seconds (match-string 0))
7854 (org-float-time now))))
7855 ((= dcst ?s)
7856 (let ((end (save-excursion (outline-next-heading) (point))))
7857 (if (re-search-forward org-scheduled-time-regexp end t)
7858 (org-time-string-to-seconds (match-string 1))
7859 (org-float-time now))))
7860 ((= dcst ?d)
7861 (let ((end (save-excursion (outline-next-heading) (point))))
7862 (if (re-search-forward org-deadline-time-regexp end t)
7863 (org-time-string-to-seconds (match-string 1))
7864 (org-float-time now))))
7865 ((= dcst ?p)
7866 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7867 (string-to-char (match-string 2))
7868 org-default-priority))
7869 ((= dcst ?r)
7870 (or (org-entry-get nil property) ""))
7871 ((= dcst ?o)
7872 (if (looking-at org-complex-heading-regexp)
7873 (- 9999 (length (member (match-string 2)
7874 org-todo-keywords-1)))))
7875 ((= dcst ?f)
7876 (if getkey-func
7877 (progn
7878 (setq tmp (funcall getkey-func))
7879 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7880 tmp)
7881 (error "Invalid key function `%s'" getkey-func)))
7882 (t (error "Invalid sorting type `%c'" sorting-type))))
7883 nil
7884 (cond
7885 ((= dcst ?a) 'string<)
7886 ((= dcst ?f) compare-func)
7887 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7888 (t nil)))))
7889 (run-hooks 'org-after-sorting-entries-or-items-hook)
7890 (message "Sorting entries...done")))
7892 (defun org-do-sort (table what &optional with-case sorting-type)
7893 "Sort TABLE of WHAT according to SORTING-TYPE.
7894 The user will be prompted for the SORTING-TYPE if the call to this
7895 function does not specify it. WHAT is only for the prompt, to indicate
7896 what is being sorted. The sorting key will be extracted from
7897 the car of the elements of the table.
7898 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7899 (unless sorting-type
7900 (message
7901 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7902 what)
7903 (setq sorting-type (read-char-exclusive)))
7904 (let ((dcst (downcase sorting-type))
7905 extractfun comparefun)
7906 ;; Define the appropriate functions
7907 (cond
7908 ((= dcst ?n)
7909 (setq extractfun 'string-to-number
7910 comparefun (if (= dcst sorting-type) '< '>)))
7911 ((= dcst ?a)
7912 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7913 (lambda(x) (downcase (org-sort-remove-invisible x))))
7914 comparefun (if (= dcst sorting-type)
7915 'string<
7916 (lambda (a b) (and (not (string< a b))
7917 (not (string= a b)))))))
7918 ((= dcst ?t)
7919 (setq extractfun
7920 (lambda (x)
7921 (if (or (string-match org-ts-regexp x)
7922 (string-match org-ts-regexp-both x))
7923 (org-float-time
7924 (org-time-string-to-time (match-string 0 x)))
7925 0))
7926 comparefun (if (= dcst sorting-type) '< '>)))
7927 (t (error "Invalid sorting type `%c'" sorting-type)))
7929 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7930 table)
7931 (lambda (a b) (funcall comparefun (car a) (car b))))))
7934 ;;; The orgstruct minor mode
7936 ;; Define a minor mode which can be used in other modes in order to
7937 ;; integrate the org-mode structure editing commands.
7939 ;; This is really a hack, because the org-mode structure commands use
7940 ;; keys which normally belong to the major mode. Here is how it
7941 ;; works: The minor mode defines all the keys necessary to operate the
7942 ;; structure commands, but wraps the commands into a function which
7943 ;; tests if the cursor is currently at a headline or a plain list
7944 ;; item. If that is the case, the structure command is used,
7945 ;; temporarily setting many Org-mode variables like regular
7946 ;; expressions for filling etc. However, when any of those keys is
7947 ;; used at a different location, function uses `key-binding' to look
7948 ;; up if the key has an associated command in another currently active
7949 ;; keymap (minor modes, major mode, global), and executes that
7950 ;; command. There might be problems if any of the keys is otherwise
7951 ;; used as a prefix key.
7953 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7954 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7955 ;; addresses this by checking explicitly for both bindings.
7957 (defvar orgstruct-mode-map (make-sparse-keymap)
7958 "Keymap for the minor `orgstruct-mode'.")
7960 (defvar org-local-vars nil
7961 "List of local variables, for use by `orgstruct-mode'.")
7963 ;;;###autoload
7964 (define-minor-mode orgstruct-mode
7965 "Toggle the minor mode `orgstruct-mode'.
7966 This mode is for using Org-mode structure commands in other
7967 modes. The following keys behave as if Org-mode were active, if
7968 the cursor is on a headline, or on a plain list item (both as
7969 defined by Org-mode).
7971 M-up Move entry/item up
7972 M-down Move entry/item down
7973 M-left Promote
7974 M-right Demote
7975 M-S-up Move entry/item up
7976 M-S-down Move entry/item down
7977 M-S-left Promote subtree
7978 M-S-right Demote subtree
7979 M-q Fill paragraph and items like in Org-mode
7980 C-c ^ Sort entries
7981 C-c - Cycle list bullet
7982 TAB Cycle item visibility
7983 M-RET Insert new heading/item
7984 S-M-RET Insert new TODO heading / Checkbox item
7985 C-c C-c Set tags / toggle checkbox"
7986 nil " OrgStruct" nil
7987 (org-load-modules-maybe)
7988 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7990 ;;;###autoload
7991 (defun turn-on-orgstruct ()
7992 "Unconditionally turn on `orgstruct-mode'."
7993 (orgstruct-mode 1))
7995 (defun orgstruct++-mode (&optional arg)
7996 "Toggle `orgstruct-mode', the enhanced version of it.
7997 In addition to setting orgstruct-mode, this also exports all indentation
7998 and autofilling variables from org-mode into the buffer. It will also
7999 recognize item context in multiline items.
8000 Note that turning off orgstruct-mode will *not* remove the
8001 indentation/paragraph settings. This can only be done by refreshing the
8003 (interactive "P")
8004 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8005 (if (< arg 1)
8006 (orgstruct-mode -1)
8007 (orgstruct-mode 1)
8008 (let (var val)
8009 (mapc
8010 (lambda (x)
8011 (when (string-match
8013 (symbol-name (car x)))
8014 (setq var (car x) val (nth 1 x))
8015 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8016 org-local-vars)
8017 (org-set-local 'orgstruct-is-++ t))))
8019 (defvar orgstruct-is-++ nil
8020 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8021 (make-variable-buffer-local 'orgstruct-is-++)
8023 ;;;###autoload
8024 (defun turn-on-orgstruct++ ()
8025 "Unconditionally turn on `orgstruct++-mode'."
8026 (orgstruct++-mode 1))
8028 (defun orgstruct-error ()
8029 "Error when there is no default binding for a structure key."
8030 (interactive)
8031 (error "This key has no function outside structure elements"))
8033 (defun orgstruct-setup ()
8034 "Setup orgstruct keymaps."
8035 (let ((nfunc 0)
8036 (bindings
8037 (list
8038 '([(meta up)] org-metaup)
8039 '([(meta down)] org-metadown)
8040 '([(meta left)] org-metaleft)
8041 '([(meta right)] org-metaright)
8042 '([(meta shift up)] org-shiftmetaup)
8043 '([(meta shift down)] org-shiftmetadown)
8044 '([(meta shift left)] org-shiftmetaleft)
8045 '([(meta shift right)] org-shiftmetaright)
8046 '([?\e (up)] org-metaup)
8047 '([?\e (down)] org-metadown)
8048 '([?\e (left)] org-metaleft)
8049 '([?\e (right)] org-metaright)
8050 '([?\e (shift up)] org-shiftmetaup)
8051 '([?\e (shift down)] org-shiftmetadown)
8052 '([?\e (shift left)] org-shiftmetaleft)
8053 '([?\e (shift right)] org-shiftmetaright)
8054 '([(shift up)] org-shiftup)
8055 '([(shift down)] org-shiftdown)
8056 '([(shift left)] org-shiftleft)
8057 '([(shift right)] org-shiftright)
8058 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8059 '("\M-q" fill-paragraph)
8060 '("\C-c^" org-sort)
8061 '("\C-c-" org-cycle-list-bullet)))
8062 elt key fun cmd)
8063 (while (setq elt (pop bindings))
8064 (setq nfunc (1+ nfunc))
8065 (setq key (org-key (car elt))
8066 fun (nth 1 elt)
8067 cmd (orgstruct-make-binding fun nfunc key))
8068 (org-defkey orgstruct-mode-map key cmd))
8070 ;; Special treatment needed for TAB and RET
8071 (org-defkey orgstruct-mode-map [(tab)]
8072 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8073 (org-defkey orgstruct-mode-map "\C-i"
8074 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8076 (org-defkey orgstruct-mode-map "\M-\C-m"
8077 (orgstruct-make-binding 'org-insert-heading 105
8078 "\M-\C-m" [(meta return)]))
8079 (org-defkey orgstruct-mode-map [(meta return)]
8080 (orgstruct-make-binding 'org-insert-heading 106
8081 [(meta return)] "\M-\C-m"))
8083 (org-defkey orgstruct-mode-map [(shift meta return)]
8084 (orgstruct-make-binding 'org-insert-todo-heading 107
8085 [(meta return)] "\M-\C-m"))
8087 (org-defkey orgstruct-mode-map "\e\C-m"
8088 (orgstruct-make-binding 'org-insert-heading 108
8089 "\e\C-m" [?\e (return)]))
8090 (org-defkey orgstruct-mode-map [?\e (return)]
8091 (orgstruct-make-binding 'org-insert-heading 109
8092 [?\e (return)] "\e\C-m"))
8093 (org-defkey orgstruct-mode-map [?\e (shift return)]
8094 (orgstruct-make-binding 'org-insert-todo-heading 110
8095 [?\e (return)] "\e\C-m"))
8097 (unless org-local-vars
8098 (setq org-local-vars (org-get-local-variables)))
8100 t))
8102 (defun orgstruct-make-binding (fun n &rest keys)
8103 "Create a function for binding in the structure minor mode.
8104 FUN is the command to call inside a table. N is used to create a unique
8105 command name. KEYS are keys that should be checked in for a command
8106 to execute outside of tables."
8107 (eval
8108 (list 'defun
8109 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8110 '(arg)
8112 "Outside of structure, run the binding of `"
8113 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8114 "'.")
8115 '(interactive "p")
8116 (list 'if
8117 `(org-context-p 'headline 'item
8118 (and orgstruct-is-++
8119 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8120 'item-body))
8121 (list 'org-run-like-in-org-mode (list 'quote fun))
8122 (list 'let '(orgstruct-mode)
8123 (list 'call-interactively
8124 (append '(or)
8125 (mapcar (lambda (k)
8126 (list 'key-binding k))
8127 keys)
8128 '('orgstruct-error))))))))
8130 (defun org-context-p (&rest contexts)
8131 "Check if local context is any of CONTEXTS.
8132 Possible values in the list of contexts are `table', `headline', and `item'."
8133 (let ((pos (point)))
8134 (goto-char (point-at-bol))
8135 (prog1 (or (and (memq 'table contexts)
8137 (and (memq 'headline contexts)
8139 (looking-at outline-regexp))
8140 (and (memq 'item contexts)
8142 (and (memq 'item-body contexts)
8143 (org-in-item-p)))
8144 (goto-char pos))))
8146 (defun org-get-local-variables ()
8147 "Return a list of all local variables in an org-mode buffer."
8148 (let (varlist)
8149 (with-current-buffer (get-buffer-create "*Org tmp*")
8150 (erase-buffer)
8151 (org-mode)
8152 (setq varlist (buffer-local-variables)))
8153 (kill-buffer "*Org tmp*")
8154 (delq nil
8155 (mapcar
8156 (lambda (x)
8157 (setq x
8158 (if (symbolp x)
8159 (list x)
8160 (list (car x) (list 'quote (cdr x)))))
8161 (if (string-match
8162 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8163 (symbol-name (car x)))
8164 x nil))
8165 varlist))))
8167 (defun org-clone-local-variables (from-buffer &optional regexp)
8168 "Clone local variables from FROM-BUFFER.
8169 Optional argument REGEXP selects variables to clone."
8170 (mapc
8171 (lambda (pair)
8172 (and (symbolp (car pair))
8173 (or (null regexp)
8174 (string-match regexp (symbol-name (car pair))))
8175 (set (make-local-variable (car pair))
8176 (cdr pair))))
8177 (buffer-local-variables from-buffer)))
8179 ;;;###autoload
8180 (defun org-run-like-in-org-mode (cmd)
8181 "Run a command, pretending that the current buffer is in Org-mode.
8182 This will temporarily bind local variables that are typically bound in
8183 Org-mode to the values they have in Org-mode, and then interactively
8184 call CMD."
8185 (org-load-modules-maybe)
8186 (unless org-local-vars
8187 (setq org-local-vars (org-get-local-variables)))
8188 (eval (list 'let org-local-vars
8189 (list 'call-interactively (list 'quote cmd)))))
8191 ;;;; Archiving
8193 (defun org-get-category (&optional pos force-refresh)
8194 "Get the category applying to position POS."
8195 (if force-refresh (org-refresh-category-properties))
8196 (let ((pos (or pos (point))))
8197 (or (get-text-property pos 'org-category)
8198 (progn (org-refresh-category-properties)
8199 (get-text-property pos 'org-category)))))
8201 (defun org-refresh-category-properties ()
8202 "Refresh category text properties in the buffer."
8203 (let ((def-cat (cond
8204 ((null org-category)
8205 (if buffer-file-name
8206 (file-name-sans-extension
8207 (file-name-nondirectory buffer-file-name))
8208 "???"))
8209 ((symbolp org-category) (symbol-name org-category))
8210 (t org-category)))
8211 beg end cat pos optionp)
8212 (org-unmodified
8213 (save-excursion
8214 (save-restriction
8215 (widen)
8216 (goto-char (point-min))
8217 (put-text-property (point) (point-max) 'org-category def-cat)
8218 (while (re-search-forward
8220 (setq pos (match-end 0)
8221 optionp (equal (char-after (match-beginning 0)) ?#)
8222 cat (org-trim (match-string 2)))
8223 (if optionp
8224 (setq beg (point-at-bol) end (point-max))
8225 (org-back-to-heading t)
8226 (setq beg (point) end (org-end-of-subtree t t)))
8227 (put-text-property beg end 'org-category cat)
8228 (goto-char pos)))))))
8231 ;;;; Link Stuff
8233 ;;; Link abbreviations
8235 (defun org-link-expand-abbrev (link)
8236 "Apply replacements as defined in `org-link-abbrev-alist."
8238 (let* ((key (match-string 1 link))
8239 (as (or (assoc key org-link-abbrev-alist-local)
8240 (assoc key org-link-abbrev-alist)))
8241 (tag (and (match-end 2) (match-string 3 link)))
8242 rpl)
8243 (if (not as)
8244 link
8245 (setq rpl (cdr as))
8246 (cond
8247 ((symbolp rpl) (funcall rpl tag))
8248 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8249 ((string-match "%h" rpl)
8250 (replace-match (url-hexify-string (or tag "")) t t rpl))
8251 (t (concat rpl tag)))))
8252 link))
8254 ;;; Storing and inserting links
8256 (defvar org-insert-link-history nil
8257 "Minibuffer history for links inserted with `org-insert-link'.")
8259 (defvar org-stored-links nil
8260 "Contains the links stored with `org-store-link'.")
8262 (defvar org-store-link-plist nil
8263 "Plist with info about the most recently link created with `org-store-link'.")
8265 (defvar org-link-protocols nil
8266 "Link protocols added to Org-mode using `org-add-link-type'.")
8268 (defvar org-store-link-functions nil
8269 "List of functions that are called to create and store a link.
8270 Each function will be called in turn until one returns a non-nil
8271 value. Each function should check if it is responsible for creating
8272 this link (for example by looking at the major mode).
8273 If not, it must exit and return nil.
8274 If yes, it should return a non-nil value after a calling
8275 `org-store-link-props' with a list of properties and values.
8276 Special properties are:
8280 This is obligatory as well.
8281 :description Optional default description for the second pair
8282 of brackets in an Org-mode link. The user can still change
8283 this when inserting this link into an Org-mode buffer.
8285 In addition to these, any additional properties can be specified
8286 and then used in remember templates.")
8288 (defun org-add-link-type (type &optional follow export)
8289 "Add TYPE to the list of `org-link-types'.
8290 Re-compute all regular expressions depending on `org-link-types'
8292 FOLLOW and EXPORT are two functions.
8294 FOLLOW should take the link path as the single argument and do whatever
8295 is necessary to follow the link, for example find a file or display
8296 a mail message.
8298 EXPORT should format the link path for export to one of the export formats.
8299 It should be a function accepting three arguments:
8302 desc the description of the link, if any, or a description added by
8303 org-export-normalize-links if there is none
8304 format the export format, a symbol like `html' or `latex' or `ascii'..
8306 The function may use the FORMAT information to return different values
8307 depending on the format. The return value will be put literally into
8308 the exported file. If the return value is nil, this means Org should
8309 do what it normally does with links which do not have EXPORT defined.
8311 Org-mode has a built-in default for exporting links. If you are happy with
8312 this default, there is no need to define an export function for the link
8313 type. For a simple example of an export function, see `org-bbdb.el'."
8314 (add-to-list 'org-link-types type t)
8315 (org-make-link-regexps)
8316 (if (assoc type org-link-protocols)
8317 (setcdr (assoc type org-link-protocols) (list follow export))
8318 (push (list type follow export) org-link-protocols)))
8320 (defvar org-agenda-buffer-name)
8322 ;;;###autoload
8323 (defun org-store-link (arg)
8325 This link is added to `org-stored-links' and can later be inserted
8328 For some link types, a prefix arg is interpreted:
8329 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8330 For file links, arg negates `org-context-in-file-links'."
8331 (interactive "P")
8332 (org-load-modules-maybe)
8333 (setq org-store-link-plist nil) ; reset
8334 (org-with-limited-levels
8335 (let (link cpltxt desc description search txt custom-id agenda-link)
8336 (cond
8338 ((run-hook-with-args-until-success 'org-store-link-functions)
8339 (setq link (plist-get org-store-link-plist :link)
8340 desc (or (plist-get org-store-link-plist :description) link)))
8342 ((equal (buffer-name) "*Org Edit Src Example*")
8343 (let (label gc)
8344 (while (or (not label)
8345 (save-excursion
8346 (save-restriction
8347 (widen)
8348 (goto-char (point-min))
8349 (re-search-forward
8350 (regexp-quote (format org-coderef-label-format label))
8351 nil t))))
8352 (when label (message "Label exists already") (sit-for 2))
8353 (setq label (read-string "Code line label: " label)))
8354 (end-of-line 1)
8355 (setq link (format org-coderef-label-format label))
8356 (setq gc (- 79 (length link)))
8357 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8358 (insert link)
8359 (setq link (concat "(" label ")") desc nil)))
8361 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8362 ;; We are in the agenda, link to referenced location
8363 (let ((m (or (get-text-property (point) 'org-hd-marker)
8364 (get-text-property (point) 'org-marker))))
8365 (when m
8366 (org-with-point-at m
8367 (setq agenda-link
8368 (if (interactive-p)
8369 (call-interactively 'org-store-link)
8370 (org-store-link nil)))))))
8372 ((eq major-mode 'calendar-mode)
8373 (let ((cd (calendar-cursor-to-date)))
8374 (setq link
8375 (format-time-string
8376 (car org-time-stamp-formats)
8377 (apply 'encode-time
8378 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8379 nil nil nil))))
8380 (org-store-link-props :type "calendar" :date cd)))
8382 ((eq major-mode 'w3-mode)
8383 (setq cpltxt (if (and (buffer-name)
8384 (not (string-match "Untitled" (buffer-name))))
8385 (buffer-name)
8386 (url-view-url t))
8387 link (org-make-link (url-view-url t)))
8388 (org-store-link-props :type "w3" :url (url-view-url t)))
8390 ((eq major-mode 'w3m-mode)
8391 (setq cpltxt (or w3m-current-title w3m-current-url)
8392 link (org-make-link w3m-current-url))
8393 (org-store-link-props :type "w3m" :url (url-view-url t)))
8395 ((setq search (run-hook-with-args-until-success
8396 'org-create-file-search-functions))
8397 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8398 "::" search))
8399 (setq cpltxt (or description link)))
8401 ((eq major-mode 'image-mode)
8402 (setq cpltxt (concat "file:"
8403 (abbreviate-file-name buffer-file-name))
8404 link (org-make-link cpltxt))
8405 (org-store-link-props :type "image" :file buffer-file-name))
8407 ((eq major-mode 'dired-mode)
8408 ;; link to the file in the current line
8409 (let ((file (dired-get-filename nil t)))
8410 (setq file (if file
8411 (abbreviate-file-name
8412 (expand-file-name (dired-get-filename nil t)))
8413 ;; otherwise, no file so use current directory.
8414 default-directory))
8415 (setq cpltxt (concat "file:" file)
8416 link (org-make-link cpltxt))))
8418 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8419 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8420 (cond
8422 (setq cpltxt
8423 (concat "file:"
8424 (abbreviate-file-name
8425 (buffer-file-name (buffer-base-buffer)))
8426 "::" (match-string 1))
8427 link (org-make-link cpltxt)))
8428 ((and (featurep 'org-id)
8429 (or (eq org-link-to-org-use-id t)
8430 (and (eq org-link-to-org-use-id 'create-if-interactive)
8431 (interactive-p))
8432 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
8433 (interactive-p)
8434 (not custom-id))
8435 (and org-link-to-org-use-id
8436 (org-entry-get nil "ID"))))
8437 ;; We can make a link using the ID.
8438 (setq link (condition-case nil
8439 (prog1 (org-id-store-link)
8440 (setq desc (plist-get org-store-link-plist
8441 :description)))
8442 (error
8443 ;; probably before first headline, link to file only
8444 (concat "file:"
8445 (abbreviate-file-name
8446 (buffer-file-name (buffer-base-buffer))))))))
8447 (t
8448 ;; Just link to current headline
8449 (setq cpltxt (concat "file:"
8450 (abbreviate-file-name
8451 (buffer-file-name (buffer-base-buffer)))))
8452 ;; Add a context search string
8453 (when (org-xor org-context-in-file-links arg)
8454 (setq txt (cond
8455 ((org-on-heading-p) nil)
8456 ((org-region-active-p)
8457 (buffer-substring (region-beginning) (region-end)))
8458 (t nil)))
8460 (setq cpltxt
8461 (concat cpltxt "::"
8462 (condition-case nil
8463 (org-make-org-heading-search-string txt)
8464 (error "")))
8465 desc (or (nth 4 (ignore-errors
8466 (org-heading-components))) "NONE"))))
8468 (setq cpltxt (substring cpltxt 0 -2)))
8469 (setq link (org-make-link cpltxt)))))
8471 ((buffer-file-name (buffer-base-buffer))
8472 ;; Just link to this file here.
8473 (setq cpltxt (concat "file:"
8474 (abbreviate-file-name
8475 (buffer-file-name (buffer-base-buffer)))))
8476 ;; Add a context string
8477 (when (org-xor org-context-in-file-links arg)
8478 (setq txt (if (org-region-active-p)
8479 (buffer-substring (region-beginning) (region-end))
8480 (buffer-substring (point-at-bol) (point-at-eol))))
8481 ;; Only use search option if there is some text.
8483 (setq cpltxt
8484 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8485 desc "NONE")))
8486 (setq link (org-make-link cpltxt)))
8488 ((interactive-p)
8489 (error "Cannot link to a buffer which is not visiting a file"))
8491 (t (setq link nil)))
8493 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8494 (setq link (or link cpltxt)
8495 desc (or desc cpltxt))
8496 (if (equal desc "NONE") (setq desc nil))
8498 (if (and (or (interactive-p) executing-kbd-macro) link)
8499 (progn
8500 (setq org-stored-links
8501 (cons (list link desc) org-stored-links))
8502 (message "Stored: %s" (or desc link))
8503 (when custom-id
8504 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8505 "::#" custom-id))
8506 (setq org-stored-links
8507 (cons (list link desc) org-stored-links))))
8508 (or agenda-link (and link (org-make-link-string link desc)))))))
8510 (defun org-store-link-props (&rest plist)
8511 "Store link properties, extract names and addresses."
8512 (let (x adr)
8513 (when (setq x (plist-get plist :from))
8514 (setq adr (mail-extract-address-components x))
8515 (setq plist (plist-put plist :fromname (car adr)))
8516 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8517 (when (setq x (plist-get plist :to))
8518 (setq adr (mail-extract-address-components x))
8519 (setq plist (plist-put plist :toname (car adr)))
8520 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8521 (let ((from (plist-get plist :from))
8522 (to (plist-get plist :to)))
8523 (when (and from to org-from-is-user-regexp)
8524 (setq plist
8525 (plist-put plist :fromto
8526 (if (string-match org-from-is-user-regexp from)
8527 (concat "to %t")
8528 (concat "from %f"))))))
8529 (setq org-store-link-plist plist))
8531 (defun org-add-link-props (&rest plist)
8532 "Add these properties to the link property list."
8533 (let (key value)
8534 (while plist
8535 (setq key (pop plist) value (pop plist))
8536 (setq org-store-link-plist
8537 (plist-put org-store-link-plist key value)))))
8539 (defun org-email-link-description (&optional fmt)
8540 "Return the description part of an email link.
8541 This takes information from `org-store-link-plist' and formats it
8542 according to FMT (default from `org-email-link-description-format')."
8543 (setq fmt (or fmt org-email-link-description-format))
8544 (let* ((p org-store-link-plist)
8545 (to (plist-get p :toaddress))
8546 (from (plist-get p :fromaddress))
8547 (table
8548 (list
8549 (cons "%c" (plist-get p :fromto))
8550 (cons "%F" (plist-get p :from))
8551 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8552 (cons "%T" (plist-get p :to))
8553 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8554 (cons "%s" (plist-get p :subject))
8555 (cons "%d" (plist-get p :date))
8556 (cons "%m" (plist-get p :message-id)))))
8557 (when (string-match "%c" fmt)
8558 ;; Check if the user wrote this message
8559 (if (and org-from-is-user-regexp from to
8560 (save-match-data (string-match org-from-is-user-regexp from)))
8561 (setq fmt (replace-match "to %t" t t fmt))
8562 (setq fmt (replace-match "from %f" t t fmt))))
8563 (org-replace-escapes fmt table)))
8565 (defun org-make-org-heading-search-string (&optional string heading)
8566 "Make search string for STRING or current headline."
8567 (interactive)
8568 (let ((s (or string (org-get-heading)))
8569 (lines org-context-in-file-links))
8570 (unless (and string (not heading))
8571 ;; We are using a headline, clean up garbage in there.
8572 (if (string-match org-todo-regexp s)
8573 (setq s (replace-match "" t t s)))
8575 (setq s (replace-match "" t t s)))
8576 (setq s (org-trim s))
8579 (setq s (replace-match "" t t s)))
8580 (while (string-match org-ts-regexp s)
8581 (setq s (replace-match "" t t s))))
8582 (or string (setq s (concat "*" s))) ; Add * for headlines
8583 (when (and string (integerp lines) (> lines 0))
8585 (when (< lines (length slines))
8586 (setq s (mapconcat
8587 'identity
8588 (reverse (nthcdr (- (length slines) lines)
8592 (defun org-make-link (&rest strings)
8593 "Concatenate STRINGS."
8594 (apply 'concat strings))
8596 (defun org-make-link-string (link &optional description)
8597 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8599 (error "Empty link"))
8600 (when (and description
8601 (stringp description)
8603 (setq description nil))
8604 (when (stringp description)
8605 ;; Remove brackets from the description, they are fatal.
8607 (setq description (replace-match "{" t t description)))
8609 (setq description (replace-match "}" t t description))))
8610 (when (equal (org-link-escape link) description)
8611 ;; No description needed, it is identical
8612 (setq description nil))
8613 (when (and (not description)
8614 (not (equal link (org-link-escape link))))
8615 (setq description (org-extract-attributes link)))
8616 (setq link (if (string-match org-link-types-re link)
8617 (concat (match-string 1 link)
8618 (org-link-escape (substring link (match-end 1))))
8619 (org-link-escape link)))
8620 (concat "[[" link "]"
8621 (if description (concat "[" description "]") "")
8622 "]"))
8624 (defconst org-link-escape-chars
8625 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8626 "List of characters that should be escaped in link.
8627 This is the list that is used for internal purposes.")
8629 (defvar org-url-encoding-use-url-hexify nil)
8631 (defconst org-link-escape-chars-browser
8632 '(?\ )
8633 "List of escapes for characters that are problematic in links.
8634 This is the list that is used before handing over to the browser.")
8636 (defun org-link-escape (text &optional table merge)
8637 "Return percent escaped representation of TEXT.
8638 TEXT is a string with the text to escape.
8639 Optional argument TABLE is a list with characters that should be
8640 escaped. When nil, `org-link-escape-chars' is used.
8641 If optional argument MERGE is set, merge TABLE into
8642 `org-link-escape-chars'."
8643 (if (and org-url-encoding-use-url-hexify (not table))
8644 (url-hexify-string text)
8645 (cond
8646 ((and table merge)
8647 (mapc (lambda (defchr)
8648 (unless (member defchr table)
8649 (setq table (cons defchr table)))) org-link-escape-chars))
8650 ((null table)
8651 (setq table org-link-escape-chars)))
8652 (mapconcat
8653 (lambda (char)
8654 (if (or (member char table)
8655 (< char 32) (= char 37) (> char 126))
8656 (mapconcat (lambda (sequence-element)
8657 (format "%%%.2X" sequence-element))
8658 (or (encode-coding-char char 'utf-8)
8659 (error "Unable to percent escape character: %s"
8660 (char-to-string char))) "")
8661 (char-to-string char))) text "")))
8663 (defun org-link-unescape (str)
8664 "Unhex hexified unicode strings as returned from the JavaScript function
8665 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8666 (unless (and (null str) (string= "" str))
8667 (let ((pos 0) (case-fold-search t) unhexed)
8669 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8670 (setq str (replace-match unhexed t t str))
8671 (setq pos (+ pos (length unhexed))))))
8672 str)
8674 (defun org-link-unescape-compound (hex)
8675 "Unhexify unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8676 Note: this function also decodes single byte encodings like
8678 (save-match-data
8679 (let* ((bytes (cdr (split-string hex "%")))
8680 (ret "")
8681 (eat 0)
8682 (sum 0))
8683 (while bytes
8684 (let* ((val (string-to-number (pop bytes) 16))
8685 (shift-xor
8686 (if (= 0 eat)
8687 (cond
8688 ((>= val 252) (cons 6 252))
8689 ((>= val 248) (cons 5 248))
8690 ((>= val 240) (cons 4 240))
8691 ((>= val 224) (cons 3 224))
8692 ((>= val 192) (cons 2 192))
8693 (t (cons 0 0)))
8694 (cons 6 128))))
8695 (if (>= val 192) (setq eat (car shift-xor)))
8696 (setq val (logxor val (cdr shift-xor)))
8697 (setq sum (+ (lsh sum (car shift-xor)) val))
8698 (if (> eat 0) (setq eat (- eat 1)))
8699 (cond
8700 ((= 0 eat) ;multi byte
8701 (setq ret (concat ret (org-char-to-string sum)))
8702 (setq sum 0))
8703 ((not bytes) ; single byte(s)
8704 (setq ret (org-link-unescape-single-byte-sequence hex))))
8705 )) ;; end (while bytes
8706 ret )))
8708 (defun org-link-unescape-single-byte-sequence (hex)
8709 "Unhexify hex-encoded single byte character sequences."
8710 (mapconcat (lambda (byte)
8711 (char-to-string (string-to-number byte 16)))
8712 (cdr (split-string hex "%")) ""))
8714 (defun org-xor (a b)
8715 "Exclusive or."
8716 (if a (not b) b))
8718 (defun org-fixup-message-id-for-http (s)
8719 "Replace special characters in a message id, so it can be used in an http query."
8720 (when (string-match "%" s)
8721 (setq s (mapconcat (lambda (c)
8722 (if (eq c ?%)
8723 "%25"
8724 (char-to-string c)))
8725 s "")))
8726 (while (string-match "<" s)
8727 (setq s (replace-match "%3C" t t s)))
8728 (while (string-match ">" s)
8729 (setq s (replace-match "%3E" t t s)))
8730 (while (string-match "@" s)
8731 (setq s (replace-match "%40" t t s)))
8732 s)
8734 ;;;###autoload
8735 (defun org-insert-link-global ()
8736 "Insert a link like Org-mode does.
8737 This command can be called in any mode to insert a link in Org-mode syntax."
8738 (interactive)
8739 (org-load-modules-maybe)
8740 (org-run-like-in-org-mode 'org-insert-link))
8742 (defun org-insert-link (&optional complete-file link-location)
8743 "Insert a link. At the prompt, enter the link.
8745 Completion can be used to insert any of the link protocol prefixes like
8746 http or ftp in use.
8748 The history can be used to select a link previously stored with
8749 `org-store-link'. When the empty string is entered (i.e. if you just
8750 press RET at the prompt), the link defaults to the most recently
8751 stored link. As SPC triggers completion in the minibuffer, you need to
8752 use M-SPC or C-q SPC to force the insertion of a space character.
8754 You will also be prompted for a description, and if one is given, it will
8755 be displayed in the buffer instead of the link.
8757 If there is already a link at point, this command will allow you to edit link
8758 and description parts.
8761 be selected using completion. The path to the file will be relative to the
8762 current directory if the file is in the current directory or a subdirectory.
8763 Otherwise, the link will be the absolute path as completed in the minibuffer
8764 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8765 option `org-link-file-path-type'.
8768 the current directory or below.
8771 `org-keep-stored-link-after-insertion'.
8773 If `org-make-link-description-function' is non-nil, this function will be
8774 called with the link target, and the result will be the default
8775 link description.
8777 If the LINK-LOCATION parameter is non-nil, this value will be
8778 used as the link location instead of reading one interactively."
8779 (interactive "P")
8780 (let* ((wcf (current-window-configuration))
8781 (region (if (org-region-active-p)
8782 (buffer-substring (region-beginning) (region-end))))
8783 (remove (and region (list (region-beginning) (region-end))))
8784 (desc region)
8785 tmphist ; byte-compile incorrectly complains about this
8786 (link link-location)
8787 entry file all-prefixes)
8788 (cond
8789 (link-location) ; specified by arg, just use it.
8790 ((org-in-regexp org-bracket-link-regexp 1)
8791 ;; We do have a link at point, and we are going to edit it.
8792 (setq remove (list (match-beginning 0) (match-end 0)))
8793 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8794 (setq link (read-string "Link: "
8795 (org-link-unescape
8796 (org-match-string-no-properties 1)))))
8797 ((or (org-in-regexp org-angle-link-re)
8798 (org-in-regexp org-plain-link-re))
8799 ;; Convert to bracket link
8800 (setq remove (list (match-beginning 0) (match-end 0))
8801 link (read-string "Link: "
8802 (org-remove-angle-brackets (match-string 0)))))
8803 ((member complete-file '((4) (16)))
8804 ;; Completing read for file names.
8805 (setq link (org-file-complete-link complete-file)))
8806 (t
8807 ;; Read link, with completion for stored links.
8808 (with-output-to-temp-buffer "*Org Links*"
8809 (princ "Insert a link.
8811 (when org-stored-links
8813 (princ (mapconcat
8814 (lambda (x)
8815 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8817 (let ((cw (selected-window)))
8818 (select-window (get-buffer-window "*Org Links*" 'visible))
8819 (setq truncate-lines t)
8820 (unless (pos-visible-in-window-p (point-max))
8821 (org-fit-window-to-buffer))
8822 (and (window-live-p cw) (select-window cw)))
8823 ;; Fake a link history, containing the stored links.
8824 (setq tmphist (append (mapcar 'car org-stored-links)
8825 org-insert-link-history))
8826 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8827 (mapcar 'car org-link-abbrev-alist)
8828 org-link-types))
8829 (unwind-protect
8830 (progn
8831 (setq link
8832 (let ((org-completion-use-ido nil)
8833 (org-completion-use-iswitchb nil))
8834 (org-completing-read
8835 "Link: "
8836 (append
8837 (mapcar (lambda (x) (list (concat x ":")))
8838 all-prefixes)
8839 (mapcar 'car org-stored-links))
8840 nil nil nil
8841 'tmphist
8842 (car (car org-stored-links)))))
8844 (error "No link selected"))
8845 (if (or (member link all-prefixes)
8846 (and (equal ":" (substring link -1))
8847 (member (substring link 0 -1) all-prefixes)
8848 (setq link (substring link 0 -1))))
8849 (setq link (org-link-try-special-completion link))))
8850 (set-window-configuration wcf)
8851 (kill-buffer "*Org Links*"))
8852 (setq entry (assoc link org-stored-links))
8853 (or entry (push link org-insert-link-history))
8854 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8855 (not org-keep-stored-link-after-insertion))
8856 (setq org-stored-links (delq (assoc link org-stored-links)
8857 org-stored-links)))
8858 (setq desc (or desc (nth 1 entry)))))
8860 (if (string-match org-plain-link-re link)
8861 ;; URL-like link, normalize the use of angular brackets.
8862 (setq link (org-make-link (org-remove-angle-brackets link))))
8864 ;; Check if we are linking to the current file with a search option
8865 ;; If yes, simplify the link by using only the search option.
8866 (when (and buffer-file-name
8868 (let* ((path (match-string 1 link))
8869 (case-fold-search nil)
8870 (search (match-string 2 link)))
8871 (save-match-data
8872 (if (equal (file-truename buffer-file-name) (file-truename path))
8873 ;; We are linking to this same file, with a search option
8874 (setq link search)))))
8876 ;; Check if we can/should use a relative path. If yes, simplify the link
8878 (let* ((type (match-string 1 link))
8879 (path (match-string 2 link))
8880 (origpath path)
8881 (case-fold-search nil))
8882 (cond
8883 ((or (eq org-link-file-path-type 'absolute)
8884 (equal complete-file '(16)))
8885 (setq path (abbreviate-file-name (expand-file-name path))))
8886 ((eq org-link-file-path-type 'noabbrev)
8887 (setq path (expand-file-name path)))
8888 ((eq org-link-file-path-type 'relative)
8889 (setq path (file-relative-name path)))
8890 (t
8891 (save-match-data
8892 (if (string-match (concat "^" (regexp-quote
8893 (expand-file-name
8894 (file-name-as-directory
8895 default-directory))))
8896 (expand-file-name path))
8897 ;; We are linking a file with relative path name.
8898 (setq path (substring (expand-file-name path)
8899 (match-end 0)))
8900 (setq path (abbreviate-file-name (expand-file-name path)))))))
8901 (setq link (concat type path))
8902 (if (equal desc origpath)
8903 (setq desc path))))
8905 (if org-make-link-description-function
8906 (setq desc (funcall org-make-link-description-function link desc)))
8908 (setq desc (read-string "Description: " desc))
8910 (if remove (apply 'delete-region remove))
8911 (insert (org-make-link-string link desc))))
8913 (defun org-link-try-special-completion (type)
8914 "If there is completion support for link type TYPE, offer it."
8915 (let ((fun (intern (concat "org-" type "-complete-link"))))
8916 (if (functionp fun)
8917 (funcall fun)
8918 (read-string "Link (no completion support): " (concat type ":")))))
8920 (defun org-file-complete-link (&optional arg)
8921 "Create a file link using completion."
8922 (let (file link)
8923 (setq file (read-file-name "File: "))
8924 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8925 (pwd1 (file-name-as-directory (abbreviate-file-name
8926 (expand-file-name ".")))))
8927 (cond
8928 ((equal arg '(16))
8929 (setq link (org-make-link
8930 "file:"
8931 (abbreviate-file-name (expand-file-name file)))))
8933 (setq link (org-make-link "file:" (match-string 1 file))))
8935 (expand-file-name file))
8936 (setq link (org-make-link
8937 "file:" (match-string 1 (expand-file-name file)))))
8938 (t (setq link (org-make-link "file:" file)))))
8939 link))
8941 (defun org-completing-read (&rest args)
8942 "Completing-read with SPACE being a normal character."
8943 (let ((minibuffer-local-completion-map
8944 (copy-keymap minibuffer-local-completion-map)))
8945 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
8946 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
8947 (apply 'org-icompleting-read args)))
8949 (defun org-completing-read-no-i (&rest args)
8950 (let (org-completion-use-ido org-completion-use-iswitchb)
8951 (apply 'org-completing-read args)))
8953 (defun org-iswitchb-completing-read (prompt choices &rest args)
8954 "Use iswitch as a completing-read replacement to choose from choices.
8955 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
8956 from."
8957 (let* ((iswitchb-use-virtual-buffers nil)
8958 (iswitchb-make-buflist-hook
8959 (lambda ()
8960 (setq iswitchb-temp-buflist choices))))
8961 (iswitchb-read-buffer prompt)))
8963 (defun org-icompleting-read (&rest args)
8964 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
8965 (org-without-partial-completion
8966 (if (and org-completion-use-ido
8967 (fboundp 'ido-completing-read)
8968 (boundp 'ido-mode) ido-mode
8969 (listp (second args)))
8970 (let ((ido-enter-matching-directory nil))
8971 (apply 'ido-completing-read (concat (car args))
8972 (if (consp (car (nth 1 args)))
8973 (mapcar (lambda (x) (car x)) (nth 1 args))
8974 (nth 1 args))
8975 (cddr args)))
8976 (if (and org-completion-use-iswitchb
8977 (boundp 'iswitchb-mode) iswitchb-mode
8978 (listp (second args)))
8979 (apply 'org-iswitchb-completing-read (concat (car args))
8980 (if (consp (car (nth 1 args)))
8981 (mapcar (lambda (x) (car x)) (nth 1 args))
8982 (nth 1 args))
8983 (cddr args))
8984 (apply 'completing-read args)))))
8986 (defun org-extract-attributes (s)
8987 "Extract the attributes cookie from a string and set as text property."
8988 (let (a attr (start 0) key value)
8989 (save-match-data
8991 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
8993 (setq key (match-string 1 a) value (match-string 2 a)
8994 start (match-end 0)
8995 attr (plist-put attr (intern key) value))))
8996 (org-add-props s nil 'org-attr attr))
8997 s))
8999 (defun org-extract-attributes-from-string (tag)
9000 (let (key value attr)
9002 (setq key (match-string 1 tag) value (match-string 2 tag)
9003 tag (replace-match "" t t tag)
9004 attr (plist-put attr (intern key) value)))
9005 (cons tag attr)))
9007 (defun org-attributes-to-string (plist)
9008 "Format a property list into an HTML attribute list."
9009 (let ((s "") key value)
9010 (while plist
9011 (setq key (pop plist) value (pop plist))
9012 (and value
9014 s))
9016 ;;; Opening/following a link
9018 (defvar org-link-search-failed nil)
9020 (defvar org-open-link-functions nil
9021 "Hook for functions finding a plain text link.
9022 These functions must take a single argument, the link content.
9023 They will be called for links that look like [[link text][description]]
9027 These functions will be called *before* Org attempts to resolve the
9028 link by doing text searches in the current buffer - so if you want a
9030 handle this as a special case.
9032 When the function does handle the link, it must return a non-nil value.
9033 If it decides that it is not responsible for this link, it must return
9034 nil to indicate that that Org-mode can continue with other options
9035 like exact and fuzzy text search.")
9037 (defun org-next-link ()
9038 "Move forward to the next link.
9039 If the link is in hidden text, expose it."
9040 (interactive)
9041 (when (and org-link-search-failed (eq this-command last-command))
9042 (goto-char (point-min))
9043 (message "Link search wrapped back to beginning of buffer"))
9044 (setq org-link-search-failed nil)
9045 (let* ((pos (point))
9046 (ct (org-context))
9047 (a (assoc :link ct)))
9048 (if a (goto-char (nth 2 a)))
9049 (if (re-search-forward org-any-link-re nil t)
9050 (progn
9051 (goto-char (match-beginning 0))
9052 (if (outline-invisible-p) (org-show-context)))
9053 (goto-char pos)
9054 (setq org-link-search-failed t)
9055 (error "No further link found"))))
9057 (defun org-previous-link ()
9058 "Move backward to the previous link.
9059 If the link is in hidden text, expose it."
9060 (interactive)
9061 (when (and org-link-search-failed (eq this-command last-command))
9062 (goto-char (point-max))
9063 (message "Link search wrapped back to end of buffer"))
9064 (setq org-link-search-failed nil)
9065 (let* ((pos (point))
9066 (ct (org-context))
9067 (a (assoc :link ct)))
9068 (if a (goto-char (nth 1 a)))
9069 (if (re-search-backward org-any-link-re nil t)
9070 (progn
9071 (goto-char (match-beginning 0))
9072 (if (outline-invisible-p) (org-show-context)))
9073 (goto-char pos)
9074 (setq org-link-search-failed t)
9075 (error "No further link found"))))
9077 (defun org-translate-link (s)
9078 "Translate a link string if a translation function has been defined."
9079 (if (and org-link-translation-function
9080 (fboundp org-link-translation-function)
9082 (progn
9083 (setq s (funcall org-link-translation-function
9084 (match-string 1) (match-string 2)))
9085 (concat (car s) ":" (cdr s)))
9086 s))
9088 (defun org-translate-link-from-planner (type path)
9089 "Translate a link from Emacs Planner syntax so that Org can follow it.
9090 This is still an experimental function, your mileage may vary."
9091 (cond
9092 ((member type '("http" "https" "news" "ftp"))
9093 ;; standard Internet links are the same.
9094 nil)
9095 ((and (equal type "irc") (string-match "^//" path))
9096 ;; Planner has two / at the beginning of an irc link, we have 1.
9097 ;; We should have zero, actually....
9098 (setq path (substring path 1)))
9099 ((and (equal type "lisp") (string-match "^/" path))
9100 ;; Planner has a slash, we do not.
9101 (setq type "elisp" path (substring path 1)))
9103 ;; A typical message link. Planner has the id after the final slash,
9104 ;; we separate it with a hash mark
9105 (setq path (concat (match-string 1 path) "#"
9106 (org-remove-angle-brackets (match-string 2 path)))))
9107 )
9108 (cons type path))
9110 (defun org-find-file-at-mouse (ev)
9111 "Open file link or URL at mouse."
9112 (interactive "e")
9113 (mouse-set-point ev)
9114 (org-open-at-point 'in-emacs))
9116 (defun org-open-at-mouse (ev)
9117 "Open file link or URL at mouse."
9118 (interactive "e")
9119 (mouse-set-point ev)
9120 (if (eq major-mode 'org-agenda-mode)
9121 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9122 (org-open-at-point))
9124 (defvar org-window-config-before-follow-link nil
9125 "The window configuration before following a link.
9126 This is saved in case the need arises to restore it.")
9128 (defvar org-open-link-marker (make-marker)
9129 "Marker pointing to the location where `org-open-at-point; was called.")
9131 ;;;###autoload
9132 (defun org-open-at-point-global ()
9133 "Follow a link like Org-mode does.
9134 This command can be called in any mode to follow a link that has
9135 Org-mode syntax."
9136 (interactive)
9137 (org-run-like-in-org-mode 'org-open-at-point))
9139 ;;;###autoload
9140 (defun org-open-link-from-string (s &optional arg reference-buffer)
9141 "Open a link in the string S, as if it was in Org-mode."
9143 (let ((reference-buffer (or reference-buffer (current-buffer))))
9144 (with-temp-buffer
9145 (let ((org-inhibit-startup t))
9146 (org-mode)
9147 (insert s)
9148 (goto-char (point-min))
9149 (when reference-buffer
9150 (setq org-link-abbrev-alist-local
9151 (with-current-buffer reference-buffer
9152 org-link-abbrev-alist-local)))
9153 (org-open-at-point arg reference-buffer)))))
9155 (defvar org-open-at-point-functions nil
9156 "Hook that is run when following a link at point.
9158 Functions in this hook must return t if they identify and follow
9159 a link at point. If they don't find anything interesting at point,
9160 they must return nil.")
9162 (defun org-open-at-point (&optional arg reference-buffer)
9163 "Open link at or after point.
9164 If there is no link at point, this function will search forward up to
9165 the end of the current line.
9166 Normally, files will be opened by an appropriate application. If the
9167 optional prefix argument ARG is non-nil, Emacs will visit the file.
9168 With a double prefix argument, try to open outside of Emacs, in the
9169 application the system uses for this file type."
9170 (interactive "P")
9171 ;; if in a code block, then open the block's results
9172 (unless (call-interactively #'org-babel-open-src-block-result)
9173 (org-load-modules-maybe)
9174 (move-marker org-open-link-marker (point))
9175 (setq org-window-config-before-follow-link (current-window-configuration))
9176 (org-remove-occur-highlights nil nil t)
9177 (cond
9178 ((and (org-on-heading-p)
9179 (not (org-in-regexp
9184 (not (get-text-property (point) 'org-linked-text)))
9185 (or (org-offer-links-in-entry arg)
9186 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9187 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9188 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9189 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9190 (not (org-in-regexp org-bracket-link-regexp)))
9191 (org-footnote-action))
9192 (t
9193 (let (type path link line search (pos (point)))
9194 (catch 'match
9195 (save-excursion
9197 (when (org-in-regexp org-bracket-link-regexp 1)
9198 (setq link (org-extract-attributes
9199 (org-link-unescape (org-match-string-no-properties 1))))
9201 (setq link (replace-match " " t t link)))
9202 (setq link (org-link-expand-abbrev link))
9203 (cond
9204 ((or (file-name-absolute-p link)
9206 (setq type "file" path link))
9207 ((string-match org-link-re-with-space3 link)
9208 (setq type (match-string 1 link) path (match-string 2 link)))
9209 (t (setq type "thisfile" path link)))
9210 (throw 'match t)))
9212 (when (get-text-property (point) 'org-linked-text)
9213 (setq type "thisfile"
9214 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9215 (1+ (point)) (point))
9216 path (buffer-substring
9217 (previous-single-property-change pos 'org-linked-text)
9218 (next-single-property-change pos 'org-linked-text)))
9219 (throw 'match t))
9221 (save-excursion
9222 (when (or (org-in-regexp org-angle-link-re)
9223 (org-in-regexp org-plain-link-re))
9224 (setq type (match-string 1) path (match-string 2))
9225 (throw 'match t)))
9226 (save-excursion
9228 (setq type "tags"
9229 path (match-string 1))
9230 (while (string-match ":" path)
9231 (setq path (replace-match "+" t t path)))
9232 (throw 'match t)))
9234 (setq type "tree-match"
9235 path (match-string 1))
9236 (throw 'match t)))
9237 (unless path
9238 (error "No link found"))
9240 ;; switch back to reference buffer
9241 ;; needed when if called in a temporary buffer through
9242 ;; org-open-link-from-string
9243 (with-current-buffer (or reference-buffer (current-buffer))
9245 ;; Remove any trailing spaces in path
9247 (setq path (replace-match "" t t path)))
9248 (if (and org-link-translation-function
9249 (fboundp org-link-translation-function))
9250 ;; Check if we need to translate the link
9251 (let ((tmp (funcall org-link-translation-function type path)))
9252 (setq type (car tmp) path (cdr tmp))))
9254 (cond
9256 ((assoc type org-link-protocols)
9257 (funcall (nth 1 (assoc type org-link-protocols)) path))
9259 ((equal type "mailto")
9260 (let ((cmd (car org-link-mailto-program))
9261 (args (cdr org-link-mailto-program)) args1
9262 (address path) (subject "") a)
9264 (setq address (match-string 1 path)
9265 subject (org-link-escape (match-string 2 path))))
9266 (while args
9267 (cond
9268 ((not (stringp (car args))) (push (pop args) args1))
9269 (t (setq a (pop args))
9270 (if (string-match "%a" a)
9271 (setq a (replace-match address t t a)))
9272 (if (string-match "%s" a)
9273 (setq a (replace-match subject t t a)))
9274 (push a args1))))
9275 (apply cmd (nreverse args1))))
9277 ((member type '("http" "https" "ftp" "news"))
9278 (browse-url (concat type ":" (org-link-escape
9279 path org-link-escape-chars-browser))))
9281 ((string= type "doi")
9282 (browse-url (concat "http://dx.doi.org/"
9283 (org-link-escape
9284 path org-link-escape-chars-browser))))
9286 ((member type '("message"))
9287 (browse-url (concat type ":" path)))
9289 ((string= type "tags")
9290 (org-tags-view arg path))
9292 ((string= type "tree-match")
9295 ((string= type "file")
9297 (setq line (string-to-number (match-string 1 path))
9298 path (substring path 0 (match-beginning 0)))
9300 (setq search (match-string 1 path)
9301 path (substring path 0 (match-beginning 0)))))
9302 (if (string-match "[*?{]" (file-name-nondirectory path))
9303 (dired path)
9304 (org-open-file path arg line search)))
9306 ((string= type "shell")
9307 (let ((cmd path))
9308 (if (or (not org-confirm-shell-link-function)
9309 (funcall org-confirm-shell-link-function
9311 (org-add-props cmd nil
9312 'face 'org-warning))))
9313 (progn
9314 (message "Executing %s" cmd)
9315 (shell-command cmd))
9316 (error "Abort"))))
9318 ((string= type "elisp")
9319 (let ((cmd path))
9320 (if (or (not org-confirm-elisp-link-function)
9321 (funcall org-confirm-elisp-link-function
9323 (org-add-props cmd nil
9324 'face 'org-warning))))
9325 (message "%s => %s" cmd
9326 (if (equal (string-to-char cmd) ?\()
9327 (eval (read cmd))
9328 (call-interactively (read cmd))))
9329 (error "Abort"))))
9331 ((and (string= type "thisfile")
9332 (run-hook-with-args-until-success
9333 'org-open-link-functions path)))
9335 ((string= type "thisfile")
9336 (if arg
9337 (switch-to-buffer-other-window
9338 (org-get-buffer-for-internal-link (current-buffer)))
9339 (org-mark-ring-push))
9340 (let ((cmd `(org-link-search
9341 ,path
9342 ,(cond ((equal arg '(4)) ''occur)
9343 ((equal arg '(16)) ''org-occur)
9344 (t nil))
9345 ,pos)))
9346 (condition-case nil (eval cmd)
9347 (error (progn (widen) (eval cmd))))))
9349 (t
9350 (browse-url-at-point)))))))
9351 (move-marker org-open-link-marker nil)
9352 (run-hook-with-args 'org-follow-link-hook)))
9354 (defun org-offer-links-in-entry (&optional nth zero)
9355 "Offer links in the current entry and follow the selected link.
9356 If there is only one link, follow it immediately as well.
9357 If NTH is an integer, immediately pick the NTH link found.
9358 If ZERO is a string, check also this string for a link, and if
9359 there is one, offer it as link number zero."
9363 (cnt ?0)
9364 (in-emacs (if (integerp nth) nil nth))
9365 have-zero end links link c)
9366 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9367 (push (match-string 0 zero) links)
9368 (setq cnt (1- cnt) have-zero t))
9369 (save-excursion
9370 (org-back-to-heading t)
9371 (setq end (save-excursion (outline-next-heading) (point)))
9372 (while (re-search-forward re end t)
9373 (push (match-string 0) links))
9374 (setq links (org-uniquify (reverse links))))
9376 (cond
9377 ((null links)
9378 (message "No links"))
9379 ((equal (length links) 1)
9380 (setq link (list (car links))))
9381 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9382 (setq link (nth (if have-zero nth (1- nth)) links)))
9383 (t ; we have to select a link
9384 (save-excursion
9385 (save-window-excursion
9386 (delete-other-windows)
9387 (with-output-to-temp-buffer "*Select Link*"
9388 (mapc (lambda (l)
9389 (if (not (string-match org-bracket-link-regexp l))
9391 (org-remove-angle-brackets l)))
9392 (if (match-end 3)
9394 (match-string 3 l) (match-string 1 l)))
9396 (match-string 1 l))))))
9397 links))
9398 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9399 (message "Select link to open, RET to open all:")
9400 (setq c (read-char-exclusive))
9401 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9402 (when (equal c ?q) (error "Abort"))
9403 (if (equal c ?\C-m)
9404 (setq link links)
9405 (setq nth (- c ?0))
9406 (if have-zero (setq nth (1+ nth)))
9407 (unless (and (integerp nth) (>= (length links) nth))
9408 (error "Invalid link selection"))
9409 (setq link (list (nth (1- nth) links))))))
9410 (if link
9411 (let ((buf (current-buffer)))
9412 (dolist (l link)
9413 (org-open-link-from-string l in-emacs buf))
9414 t)
9415 nil)))
9417 ;; Add special file links that specify the way of opening
9419 (org-add-link-type "file+sys" 'org-open-file-with-system)
9420 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9421 (defun org-open-file-with-system (path)
9422 "Open file at PATH using the system way of opening it."
9423 (org-open-file path 'system))
9424 (defun org-open-file-with-emacs (path)
9425 "Open file at PATH in Emacs."
9426 (org-open-file path 'emacs))
9427 (defun org-remove-file-link-modifiers ()
9428 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9429 (goto-char (point-min))
9431 (org-if-unprotected
9432 (replace-match "file:" t t))))
9433 (eval-after-load "org-exp"
9434 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9435 'org-remove-file-link-modifiers))
9437 ;;;; Time estimates
9439 (defun org-get-effort (&optional pom)
9440 "Get the effort estimate for the current entry."
9441 (org-entry-get pom org-effort-property))
9443 ;;; File search
9445 (defvar org-create-file-search-functions nil
9446 "List of functions to construct the right search string for a file link.
9447 These functions are called in turn with point at the location to
9448 which the link should point.
9450 A function in the hook should first test if it would like to
9451 handle this file type, for example by checking the `major-mode'
9452 or the file extension. If it decides not to handle this file, it
9453 should just return nil to give other functions a chance. If it
9454 does handle the file, it must return the search string to be used
9455 when following the link. The search string will be part of the
9456 file link, given after a double colon, and `org-open-at-point'
9457 will automatically search for it. If special measures must be
9458 taken to make the search successful, another function should be
9459 added to the companion hook `org-execute-file-search-functions',
9460 which see.
9462 A function in this hook may also use `setq' to set the variable
9463 `description' to provide a suggestion for the descriptive text to
9464 be used for this link when it gets inserted into an Org-mode
9467 (defvar org-execute-file-search-functions nil
9468 "List of functions to execute a file search triggered by a link.
9470 Functions added to this hook must accept a single argument, the
9471 search string that was part of the file link, the part after the
9472 double colon. The function must first check if it would like to
9473 handle this search, for example by checking the `major-mode' or
9474 the file extension. If it decides not to handle this search, it
9475 should just return nil to give other functions a chance. If it
9476 does handle the search, it must return a non-nil value to keep
9477 other functions from trying.
9479 Each function can access the current prefix argument through the
9480 variable `current-prefix-argument'. Note that a single prefix is
9481 used to force opening a link in Emacs, so it may be good to only
9482 use a numeric or double prefix to guide the search function.
9484 In case this is needed, a function in this hook can also restore
9485 the window configuration before `org-open-at-point' was called using:
9487 (set-window-configuration org-window-config-before-follow-link)")
9489 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9490 (defun org-link-search (s &optional type avoid-pos)
9491 "Search for a link search option.
9492 If S is surrounded by forward slashes, it is interpreted as a
9493 regular expression. In org-mode files, this will create an `org-occur'
9494 sparse tree. In ordinary files, `occur' will be used to list matches.
9495 If the current buffer is in `dired-mode', grep will be used to search
9496 in all files. If AVOID-POS is given, ignore matches near that position."
9497 (let ((case-fold-search t)
9501 org-emphasis-alist)
9503 (pos (point))
9504 (pre nil) (post nil)
9505 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9506 (cond
9507 ;; First check if there are any special search functions
9508 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9509 ;; Now try the builtin stuff
9510 ((and (equal (string-to-char s0) ?#)
9511 (> (length s0) 1)
9512 (save-excursion
9513 (goto-char (point-min))
9514 (and
9515 (re-search-forward
9517 (setq type 'dedicated
9518 pos (match-beginning 0))))
9519 ;; There is an exact target for this
9520 (goto-char pos)
9521 (org-back-to-heading t)))
9522 ((save-excursion
9523 (goto-char (point-min))
9524 (and
9525 (re-search-forward
9526 (concat "<<" (regexp-quote s0) ">>") nil t)
9527 (setq type 'dedicated
9528 pos (match-beginning 0))))
9529 ;; There is an exact target for this
9530 (goto-char pos))
9532 (save-excursion
9533 (goto-char (point-min))
9534 (and
9535 (re-search-forward
9536 (concat "[^[]" (regexp-quote
9537 (format org-coderef-label-format
9538 (match-string 1 s0))))
9539 nil t)
9540 (setq type 'dedicated
9541 pos (1+ (match-beginning 0))))))
9542 ;; There is a coderef target for this
9543 (goto-char pos))
9545 ;; A regular expression
9546 (cond
9547 ((org-mode-p)
9548 (org-occur (match-string 1 s)))
9549 ;;((eq major-mode 'dired-mode)
9550 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9551 (t (org-do-occur (match-string 1 s)))))
9552 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9553 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9554 (goto-char (point-min))
9555 (cond
9556 ((let (case-fold-search)
9557 (re-search-forward (format org-complex-heading-regexp-format
9558 (regexp-quote s))
9559 nil t))
9560 ;; OK, found a match
9561 (setq type 'dedicated)
9562 (goto-char (match-beginning 0)))
9563 ((and (not org-link-search-inhibit-query)
9564 (eq org-link-search-must-match-exact-headline 'query-to-create)
9565 (y-or-n-p "No match - create this as a new heading? "))
9566 (goto-char (point-max))
9567 (or (bolp) (newline))
9569 (beginning-of-line 0))
9570 (t
9571 (goto-char pos)
9572 (error "No match"))))
9573 (t
9574 ;; A normal search string
9575 (when (equal (string-to-char s) ?*)
9576 ;; Anchor on headlines, post may include tags.
9579 s (substring s 1)))
9580 (remove-text-properties
9581 0 (length s)
9582 '(face nil mouse-face nil keymap nil fontified nil) s)
9583 ;; Make a series of regular expressions to find a match
9592 re4 (concat "[^a-zA-Z_]" re4_)
9594 re1 (concat pre re2 post)
9595 re3 (concat pre (if pre re4_ re4) post)
9596 re5 (concat pre ".*" re4)
9597 re2 (concat pre re2)
9598 re2a (concat pre (if pre re2a_ re2a))
9599 re4 (concat pre (if pre re4_ re4))
9603 ))
9604 (cond
9605 ((eq type 'org-occur) (org-occur reall))
9606 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9607 (t (goto-char (point-min))
9608 (setq type 'fuzzy)
9609 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9610 (org-search-not-self 1 re1 nil t)
9611 (org-search-not-self 1 re2 nil t)
9612 (org-search-not-self 1 re2a nil t)
9613 (org-search-not-self 1 re3 nil t)
9614 (org-search-not-self 1 re4 nil t)
9615 (org-search-not-self 1 re5 nil t)
9616 )
9617 (goto-char (match-beginning 1))
9618 (goto-char pos)
9619 (error "No match"))))))
9620 (and (org-mode-p) (org-show-context 'link-search))
9621 type))
9623 (defun org-search-not-self (group &rest args)
9624 "Execute `re-search-forward', but only accept matches that do not
9625 enclose the position of `org-open-link-marker'."
9626 (let ((m org-open-link-marker))
9627 (catch 'exit
9628 (while (apply 're-search-forward args)
9629 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9630 (goto-char (match-end group))
9631 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9632 (> (match-beginning 0) (marker-position m))
9633 (< (match-end 0) (marker-position m)))
9634 (save-match-data
9635 (or (not (org-in-regexp
9636 org-bracket-link-analytic-regexp 1))
9637 (not (match-end 4)) ; no description
9638 (and (<= (match-beginning 4) (point))
9639 (>= (match-end 4) (point))))))
9640 (throw 'exit (point))))))))
9642 (defun org-get-buffer-for-internal-link (buffer)
9643 "Return a buffer to be used for displaying the link target of internal links."
9644 (cond
9645 ((not org-display-internal-link-with-indirect-buffer)
9646 buffer)
9647 ((string-match "(Clone)$" (buffer-name buffer))
9648 (message "Buffer is already a clone, not making another one")
9649 ;; we also do not modify visibility in this case
9650 buffer)
9651 (t ; make a new indirect buffer for displaying the link
9652 (let* ((bn (buffer-name buffer))
9653 (ibn (concat bn "(Clone)"))
9654 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9655 (with-current-buffer ib (org-overview))
9656 ib))))
9658 (defun org-do-occur (regexp &optional cleanup)
9659 "Call the Emacs command `occur'.
9660 If CLEANUP is non-nil, remove the printout of the regular expression
9661 in the *Occur* buffer. This is useful if the regex is long and not useful
9662 to read."
9663 (occur regexp)
9664 (when cleanup
9665 (let ((cwin (selected-window)) win beg end)
9666 (when (setq win (get-buffer-window "*Occur*"))
9667 (select-window win))
9668 (goto-char (point-min))
9669 (when (re-search-forward "match[a-z]+" nil t)
9670 (setq beg (match-end 0))
9672 (setq end (1- (match-beginning 0)))))
9673 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9674 (goto-char (point-min))
9675 (select-window cwin))))
9677 ;;; The mark ring for links jumps
9679 (defvar org-mark-ring nil
9680 "Mark ring for positions before jumps in Org-mode.")
9681 (defvar org-mark-ring-last-goto nil
9682 "Last position in the mark ring used to go back.")
9683 ;; Fill and close the ring
9684 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9685 (loop for i from 1 to org-mark-ring-length do
9686 (push (make-marker) org-mark-ring))
9687 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9688 org-mark-ring)
9690 (defun org-mark-ring-push (&optional pos buffer)
9691 "Put the current position or POS into the mark ring and rotate it."
9692 (interactive)
9693 (setq pos (or pos (point)))
9694 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9695 (move-marker (car org-mark-ring)
9696 (or pos (point))
9697 (or buffer (current-buffer)))
9698 (message "%s"
9699 (substitute-command-keys
9702 (defun org-mark-ring-goto (&optional n)
9703 "Jump to the previous position in the mark ring.
9704 With prefix arg N, jump back that many stored positions. When
9705 called several times in succession, walk through the entire ring.
9706 Org-mode commands jumping to a different position in the current file,
9707 or to another Org-mode file, automatically push the old position
9708 onto the ring."
9709 (interactive "p")
9710 (let (p m)
9711 (if (eq last-command this-command)
9712 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9713 (setq p org-mark-ring))
9714 (setq org-mark-ring-last-goto p)
9715 (setq m (car p))
9716 (switch-to-buffer (marker-buffer m))
9717 (goto-char m)
9718 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9720 (defun org-remove-angle-brackets (s)
9721 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9722 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9723 s)
9724 (defun org-add-angle-brackets (s)
9725 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9726 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9727 s)
9728 (defun org-remove-double-quotes (s)
9731 s)
9733 ;;; Following specific links
9735 (defun org-follow-timestamp-link ()
9736 (cond
9737 ((org-at-date-range-p t)
9738 (let ((org-agenda-start-on-weekday)
9739 (t1 (match-string 1))
9740 (t2 (match-string 2)))
9741 (setq t1 (time-to-days (org-time-string-to-time t1))
9742 t2 (time-to-days (org-time-string-to-time t2)))
9743 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9744 ((org-at-timestamp-p t)
9745 (org-agenda-list nil (time-to-days (org-time-string-to-time
9746 (substring (match-string 1) 0 10)))
9747 1))
9748 (t (error "This should not happen"))))
9751 ;;; Following file links
9752 (defvar org-wait nil)
9753 (defun org-open-file (path &optional in-emacs line search)
9754 "Open the file at PATH.
9755 First, this expands any special file name abbreviations. Then the
9756 configuration variable `org-file-apps' is checked if it contains an
9757 entry for this file type, and if yes, the corresponding command is launched.
9759 If no application is found, Emacs simply visits the file.
9761 With optional prefix argument IN-EMACS, Emacs will visit the file.
9763 prefix arg, Org tries to avoid opening in Emacs
9764 and to use an external application to visit the file.
9766 Optional LINE specifies a line to go to, optional SEARCH a string
9767 to search for. If LINE or SEARCH is given, the file will be
9768 opened in Emacs, unless an entry from org-file-apps that makes
9769 use of groups in a regexp matches.
9770 If the file does not exist, an error is thrown."
9771 (let* ((file (if (equal path "")
9772 buffer-file-name
9773 (substitute-in-file-name (expand-file-name path))))
9774 (file-apps (append org-file-apps (org-default-apps)))
9775 (apps (org-remove-if
9776 'org-file-apps-entry-match-against-dlink-p file-apps))
9777 (apps-dlink (org-remove-if-not
9778 'org-file-apps-entry-match-against-dlink-p file-apps))
9779 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9780 (dirp (if remp nil (file-directory-p file)))
9781 (file (if (and dirp org-open-directory-means-index-dot-org)
9782 (concat (file-name-as-directory file) "index.org")
9783 file))
9784 (a-m-a-p (assq 'auto-mode apps))
9785 (dfile (downcase file))
9786 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9787 (link (cond ((and (eq line nil)
9788 (eq search nil))
9789 file)
9790 (line
9791 (concat file "::" (number-to-string line)))
9792 (search
9793 (concat file "::" search))))
9794 (dlink (downcase link))
9795 (old-buffer (current-buffer))
9796 (old-pos (point))
9797 (old-mode major-mode)
9798 ext cmd link-match-data)
9800 (setq ext (match-string 1 dfile))
9802 (setq ext (match-string 1 dfile))))
9803 (cond
9804 ((member in-emacs '((16) system))
9805 (setq cmd (cdr (assoc 'system apps))))
9806 (in-emacs (setq cmd 'emacs))
9807 (t
9808 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9809 (and dirp (cdr (assoc 'directory apps)))
9810 ; first, try matching against apps-dlink
9811 ; if we get a match here, store the match data for later
9812 (let ((match (assoc-default dlink apps-dlink
9813 'string-match)))
9814 (if match
9815 (progn (setq link-match-data (match-data))
9816 match)
9817 (progn (setq in-emacs (or in-emacs line search))
9818 nil))) ; if we have no match in apps-dlink,
9819 ; always open the file in emacs if line or search
9820 ; is given (for backwards compatibility)
9821 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9822 'string-match)
9823 (cdr (assoc ext apps))
9824 (cdr (assoc t apps))))))
9825 (when (eq cmd 'system)
9826 (setq cmd (cdr (assoc 'system apps))))
9827 (when (eq cmd 'default)
9828 (setq cmd (cdr (assoc t apps))))
9829 (when (eq cmd 'mailcap)
9830 (require 'mailcap)
9831 (mailcap-parse-mailcaps)
9832 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9833 (command (mailcap-mime-info mime-type)))
9834 (if (stringp command)
9835 (setq cmd command)
9836 (setq cmd 'emacs))))
9837 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9838 (not (file-exists-p file))
9839 (not org-open-non-existing-files))
9840 (error "No such file: %s" file))
9841 (cond
9843 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9845 (setq cmd (replace-match "%s" t t cmd)))
9846 (while (string-match "%s" cmd)
9847 (setq cmd (replace-match
9848 (save-match-data
9849 (shell-quote-argument
9850 (convert-standard-filename file)))
9851 t t cmd)))
9853 ;; Replace "%1", "%2" etc. in command with group matches from regex
9854 (save-match-data
9855 (let ((match-index 1)
9856 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9857 (set-match-data link-match-data)
9858 (while (<= match-index number-of-groups)
9859 (let ((regex (concat "%" (number-to-string match-index)))
9860 (replace-with (match-string match-index dlink)))
9861 (while (string-match regex cmd)
9862 (setq cmd (replace-match replace-with t t cmd))))
9863 (setq match-index (+ match-index 1)))))
9865 (save-window-excursion
9866 (start-process-shell-command cmd nil cmd)
9867 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9868 ))
9869 ((or (stringp cmd)
9870 (eq cmd 'emacs))
9871 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9872 (widen)
9873 (if line (org-goto-line line)
9874 (if search (org-link-search search))))
9875 ((consp cmd)
9876 (let ((file (convert-standard-filename file)))
9877 (save-match-data
9878 (set-match-data link-match-data)
9879 (eval cmd))))
9880 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9881 (and (org-mode-p) (eq old-mode 'org-mode)
9882 (or (not (equal old-buffer (current-buffer)))
9883 (not (equal old-pos (point))))
9884 (org-mark-ring-push old-pos old-buffer))))
9886 (defun org-file-apps-entry-match-against-dlink-p (entry)
9887 "This function returns non-nil if `entry' uses a regular
9888 expression which should be matched against the whole link by
9889 org-open-file.
9891 It assumes that is the case when the entry uses a regular
9892 expression which has at least one grouping construct and the
9893 action is either a lisp form or a command string containing
9894 '%1', i.e. using at least one subexpression match as a
9895 parameter."
9896 (let ((selector (car entry))
9897 (action (cdr entry)))
9898 (if (stringp selector)
9899 (and (> (regexp-opt-depth selector) 0)
9900 (or (and (stringp action)
9901 (string-match "%[0-9]" action))
9902 (consp action)))
9903 nil)))
9905 (defun org-default-apps ()
9906 "Return the default applications for this operating system."
9907 (cond
9908 ((eq system-type 'darwin)
9909 org-file-apps-defaults-macosx)
9910 ((eq system-type 'windows-nt)
9911 org-file-apps-defaults-windowsnt)
9912 (t org-file-apps-defaults-gnu)))
9914 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9915 "Convert extensions to regular expressions in the cars of LIST.
9916 Also, weed out any non-string entries, because the return value is used
9917 only for regexp matching.
9918 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9919 point to the symbol `emacs', indicating that the file should
9920 be opened in Emacs."
9921 (append
9922 (delq nil
9923 (mapcar (lambda (x)
9924 (if (not (stringp (car x)))
9925 nil
9927 x
9929 list))
9930 (if add-auto-mode
9931 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9933 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9934 (defun org-file-remote-p (file)
9935 "Test whether FILE specifies a location on a remote system.
9936 Return non-nil if the location is indeed remote.
9940 (cond ((fboundp 'file-remote-p)
9941 (file-remote-p file))
9942 ((fboundp 'tramp-handle-file-remote-p)
9943 (tramp-handle-file-remote-p file))
9944 ((and (boundp 'ange-ftp-name-format)
9945 (string-match (car ange-ftp-name-format) file))
9946 t)
9947 (t nil)))
9950 ;;;; Refiling
9952 (defun org-get-org-file ()
9953 "Read a filename, with default directory `org-directory'."
9954 (let ((default (or org-default-notes-file remember-data-file)))
9955 (read-file-name (format "File name [%s]: " default)
9956 (file-name-as-directory org-directory)
9957 default)))
9959 (defun org-notes-order-reversed-p ()
9960 "Check if the current file should receive notes in reversed order."
9961 (cond
9962 ((not org-reverse-note-order) nil)
9963 ((eq t org-reverse-note-order) t)
9964 ((not (listp org-reverse-note-order)) nil)
9965 (t (catch 'exit
9966 (let ((all org-reverse-note-order)
9967 entry)
9968 (while (setq entry (pop all))
9969 (if (string-match (car entry) buffer-file-name)
9970 (throw 'exit (cdr entry))))
9971 nil)))))
9973 (defvar org-refile-target-table nil
9974 "The list of refile targets, created by `org-refile'.")
9976 (defvar org-agenda-new-buffers nil
9977 "Buffers created to visit agenda files.")
9979 (defvar org-refile-cache nil
9980 "Cache for refile targets.")
9983 (defvar org-refile-markers nil
9984 "All the markers used for caching refile locations.")
9986 (defun org-refile-marker (pos)
9987 "Get a new refile marker, but only if caching is in use."
9988 (if (not org-refile-use-cache)
9989 pos
9990 (let ((m (make-marker)))
9991 (move-marker m pos)
9992 (push m org-refile-markers)
9993 m)))
9995 (defun org-refile-cache-clear ()
9996 "Clear the refile cache and disable all the markers."
9997 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
9998 (setq org-refile-markers nil)
9999 (setq org-refile-cache nil)
10000 (message "Refile cache has been cleared"))
10002 (defun org-refile-cache-check-set (set)
10003 "Check if all the markers in the cache still have live buffers."
10004 (let (marker)
10005 (catch 'exit
10006 (while (and set (setq marker (nth 3 (pop set))))
10007 ;; if org-refile-use-outline-path is 'file, marker may be nil
10008 (when (and marker (null (marker-buffer marker)))
10009 (message "not found") (sit-for 3)
10010 (throw 'exit nil)))
10011 t)))
10013 (defun org-refile-cache-put (set &rest identifiers)
10014 "Push the refile targets SET into the cache, under IDENTIFIERS."
10015 (let* ((key (sha1 (prin1-to-string identifiers)))
10016 (entry (assoc key org-refile-cache)))
10017 (if entry
10018 (setcdr entry set)
10019 (push (cons key set) org-refile-cache))))
10021 (defun org-refile-cache-get (&rest identifiers)
10022 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10023 (cond
10024 ((not org-refile-cache) nil)
10025 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10026 (t
10027 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10028 org-refile-cache))))
10029 (and set (org-refile-cache-check-set set) set)))))
10031 (defun org-get-refile-targets (&optional default-buffer)
10032 "Produce a table with refile targets."
10033 (let ((case-fold-search nil)
10034 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10035 (entries (or org-refile-targets '((nil . (:level . 1)))))
10036 targets tgs txt re files f desc descre fast-path-p level pos0)
10037 (message "Getting targets...")
10038 (with-current-buffer (or default-buffer (current-buffer))
10039 (while (setq entry (pop entries))
10040 (setq files (car entry) desc (cdr entry))
10041 (setq fast-path-p nil)
10042 (cond
10043 ((null files) (setq files (list (current-buffer))))
10044 ((eq files 'org-agenda-files)
10045 (setq files (org-agenda-files 'unrestricted)))
10046 ((and (symbolp files) (fboundp files))
10047 (setq files (funcall files)))
10048 ((and (symbolp files) (boundp files))
10049 (setq files (symbol-value files))))
10050 (if (stringp files) (setq files (list files)))
10051 (cond
10052 ((eq (car desc) :tag)
10054 ((eq (car desc) :todo)
10056 ((eq (car desc) :regexp)
10057 (setq descre (cdr desc)))
10058 ((eq (car desc) :level)
10060 (if org-odd-levels-only
10061 (1- (* 2 (cdr desc)))
10062 (cdr desc)))
10064 ((eq (car desc) :maxlevel)
10065 (setq fast-path-p t)
10067 (if org-odd-levels-only
10068 (1- (* 2 (cdr desc)))
10069 (cdr desc)))
10071 (t (error "Bad refiling target description %s" desc)))
10072 (while (setq f (pop files))
10073 (with-current-buffer
10074 (if (bufferp f) f (org-get-agenda-file-buffer f))
10075 (or
10076 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10077 (progn
10078 (if (bufferp f) (setq f (buffer-file-name
10079 (buffer-base-buffer f))))
10080 (setq f (and f (expand-file-name f)))
10081 (if (eq org-refile-use-outline-path 'file)
10082 (push (list (file-name-nondirectory f) f nil nil) tgs))
10083 (save-excursion
10084 (save-restriction
10085 (widen)
10086 (goto-char (point-min))
10087 (while (re-search-forward descre nil t)
10088 (goto-char (setq pos0 (point-at-bol)))
10089 (catch 'next
10090 (when org-refile-target-verify-function
10091 (save-match-data
10092 (or (funcall org-refile-target-verify-function)
10093 (throw 'next t))))
10094 (when (looking-at org-complex-heading-regexp)
10095 (setq level (org-reduced-level
10096 (- (match-end 1) (match-beginning 1)))
10097 txt (org-link-display-format (match-string 4))
10099 re (format org-complex-heading-regexp-format
10100 (regexp-quote (match-string 4))))
10101 (when org-refile-use-outline-path
10102 (setq txt (mapconcat
10103 'org-protect-slash
10104 (append
10105 (if (eq org-refile-use-outline-path
10106 'file)
10107 (list (file-name-nondirectory
10108 (buffer-file-name
10109 (buffer-base-buffer))))
10110 (if (eq org-refile-use-outline-path
10111 'full-file-path)
10112 (list (buffer-file-name
10113 (buffer-base-buffer)))))
10114 (org-get-outline-path fast-path-p
10115 level txt)
10116 (list txt))
10117 "/")))
10118 (push (list txt f re (org-refile-marker (point)))
10119 tgs)))
10120 (when (= (point) pos0)
10121 ;; verification function has not moved point
10122 (goto-char (point-at-eol))))))))
10123 (when org-refile-use-cache
10124 (org-refile-cache-put tgs (buffer-file-name) descre))
10125 (setq targets (append tgs targets))
10126 ))))
10127 (message "Getting targets...done")
10128 (nreverse targets)))
10130 (defun org-protect-slash (s)
10131 (while (string-match "/" s)
10133 s)
10135 (defvar org-olpa (make-vector 20 nil))
10137 (defun org-get-outline-path (&optional fastp level heading)
10138 "Return the outline path to the current entry, as a list.
10140 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10141 routine which makes outline path derivations for an entire file,
10142 avoiding backtracing. Refile target collection makes use of that."
10143 (if fastp
10144 (progn
10145 (if (> level 19)
10146 (error "Outline path failure, more than 19 levels"))
10147 (loop for i from level upto 19 do
10148 (aset org-olpa i nil))
10149 (prog1
10150 (delq nil (append org-olpa nil))
10151 (aset org-olpa level heading)))
10152 (let (rtn case-fold-search)
10153 (save-excursion
10154 (save-restriction
10155 (widen)
10156 (while (org-up-heading-safe)
10157 (when (looking-at org-complex-heading-regexp)
10158 (push (org-match-string-no-properties 4) rtn)))
10159 rtn)))))
10161 (defun org-format-outline-path (path &optional width prefix)
10162 "Format the outline path PATH for display.
10163 Width is the maximum number of characters that is available.
10164 Prefix is a prefix to be included in the returned string,
10165 such as the file name."
10166 (setq width (or width 79))
10167 (if prefix (setq width (- width (length prefix))))
10168 (if (not path)
10169 (or prefix "")
10170 (let* ((nsteps (length path))
10171 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10172 (maxwidth (if (<= total-width width)
10173 10000 ;; everything fits
10174 ;; we need to shorten the level headings
10175 (/ (- width nsteps) nsteps)))
10176 (org-odd-levels-only nil)
10177 (n 0)
10178 (total (1+ (length prefix))))
10179 (setq maxwidth (max maxwidth 10))
10180 (concat prefix
10181 (mapconcat
10182 (lambda (h)
10183 (setq n (1+ n))
10184 (if (and (= n nsteps) (< maxwidth 10000))
10185 (setq maxwidth (- total-width total)))
10186 (if (< (length h) maxwidth)
10187 (progn (setq total (+ total (length h) 1)) h)
10188 (setq h (substring h 0 (- maxwidth 2))
10189 total (+ total maxwidth 1))
10191 (setq h (substring h 0 (match-beginning 0))))
10192 (setq h (concat h "..")))
10193 (org-add-props h nil 'face
10194 (nth (% (1- n) org-n-level-faces)
10195 org-level-faces))
10196 h)
10197 path "/")))))
10199 (defun org-display-outline-path (&optional file current)
10200 "Display the current outline path in the echo area."
10201 (interactive "P")
10202 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10203 (case-fold-search nil)
10204 (path (and (org-mode-p) (org-get-outline-path))))
10205 (if current (setq path (append path
10206 (save-excursion
10207 (org-back-to-heading t)
10208 (if (looking-at org-complex-heading-regexp)
10209 (list (match-string 4)))))))
10210 (message "%s"
10211 (org-format-outline-path
10212 path
10213 (1- (frame-width))
10214 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10216 (defvar org-refile-history nil
10217 "History for refiling operations.")
10219 (defvar org-after-refile-insert-hook nil
10220 "Hook run after `org-refile' has inserted its stuff at the new location.
10221 Note that this is still *before* the stuff will be removed from
10222 the *old* location.")
10224 (defvar org-capture-last-stored-marker)
10225 (defun org-refile (&optional goto default-buffer rfloc)
10226 "Move the entry at point to another heading.
10227 The list of target headings is compiled using the information in
10228 `org-refile-targets', which see. This list is created before each use
10229 and will therefore always be up-to-date.
10231 At the target location, the entry is filed as a subitem of the target heading.
10232 Depending on `org-reverse-note-order', the new subitem will either be the
10233 first or the last subitem.
10235 If there is an active region, all entries in that region will be moved.
10236 However, the region must fulfill the requirement that the first heading
10237 is the first one sets the top-level of the moved text - at most siblings
10238 below it are allowed.
10240 With prefix arg GOTO, the command will only visit the target location,
10241 not actually move anything.
10243 go to the location where the last refiling
10244 operation has put the subtree.
10245 With a prefix argument of `2', refile to the running clock.
10247 RFLOC can be a refile location obtained in a different way.
10249 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10251 If you are using target caching (see `org-refile-use-cache'),
10252 You have to clear the target cache in order to find new targets.
10253 This can be done with a 0 prefix: `C-0 C-c C-w'"
10254 (interactive "P")
10255 (if (member goto '(0 (64)))
10256 (org-refile-cache-clear)
10257 (let* ((cbuf (current-buffer))
10258 (regionp (org-region-active-p))
10259 (region-start (and regionp (region-beginning)))
10260 (region-end (and regionp (region-end)))
10261 (region-length (and regionp (- region-end region-start)))
10262 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10263 pos it nbuf file re level reversed)
10264 (setq last-command nil)
10265 (when regionp
10266 (goto-char region-start)
10267 (or (bolp) (goto-char (point-at-bol)))
10268 (setq region-start (point))
10269 (unless (org-kill-is-subtree-p
10270 (buffer-substring region-start region-end))
10271 (error "The region is not a (sequence of) subtree(s)")))
10272 (if (equal goto '(16))
10273 (org-refile-goto-last-stored)
10274 (when (or
10275 (and (equal goto 2)
10276 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10277 (prog1
10278 (setq it (list (or org-clock-heading "running clock")
10279 (buffer-file-name
10280 (marker-buffer org-clock-hd-marker))
10281 ""
10282 (marker-position org-clock-hd-marker)))
10283 (setq goto nil)))
10284 (setq it (or rfloc
10285 (save-excursion
10286 (org-refile-get-location
10287 (if goto "Goto: " "Refile to: ") default-buffer
10288 org-refile-allow-creating-parent-nodes)))))
10289 (setq file (nth 1 it)
10290 re (nth 2 it)
10291 pos (nth 3 it))
10292 (if (and (not goto)
10293 pos
10294 (equal (buffer-file-name) file)
10295 (if regionp
10296 (and (>= pos region-start)
10297 (<= pos region-end))
10298 (and (>= pos (point))
10299 (< pos (save-excursion
10300 (org-end-of-subtree t t))))))
10301 (error "Cannot refile to position inside the tree or region"))
10303 (setq nbuf (or (find-buffer-visiting file)
10304 (find-file-noselect file)))
10305 (if goto
10306 (progn
10307 (switch-to-buffer nbuf)
10308 (goto-char pos)
10309 (org-show-context 'org-goto))
10310 (if regionp
10311 (progn
10312 (org-kill-new (buffer-substring region-start region-end))
10313 (org-save-markers-in-region region-start region-end))
10314 (org-copy-subtree 1 nil t))
10315 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10316 (find-file-noselect file)))
10317 (setq reversed (org-notes-order-reversed-p))
10318 (save-excursion
10319 (save-restriction
10320 (widen)
10321 (if pos
10322 (progn
10323 (goto-char pos)
10324 (looking-at outline-regexp)
10325 (setq level (org-get-valid-level (funcall outline-level) 1))
10326 (goto-char
10327 (if reversed
10328 (or (outline-next-heading) (point-max))
10329 (or (save-excursion (org-get-next-sibling))
10330 (org-end-of-subtree t t)
10331 (point-max)))))
10332 (setq level 1)
10333 (if (not reversed)
10334 (goto-char (point-max))
10335 (goto-char (point-min))
10336 (or (outline-next-heading) (goto-char (point-max)))))
10337 (if (not (bolp)) (newline))
10338 (org-paste-subtree level)
10339 (when org-log-refile
10340 (org-add-log-setup 'refile nil nil 'findpos
10341 org-log-refile)
10342 (unless (eq org-log-refile 'note)
10343 (save-excursion (org-add-log-note))))
10344 (and org-auto-align-tags (org-set-tags nil t))
10345 (bookmark-set "org-refile-last-stored")
10346 ;; If we are refiling for capture, make sure that the
10347 ;; last-capture pointers point here
10348 (when (org-bound-and-true-p org-refile-for-capture)
10349 (bookmark-set "org-capture-last-stored-marker")
10350 (move-marker org-capture-last-stored-marker (point)))
10351 (if (fboundp 'deactivate-mark) (deactivate-mark))
10352 (run-hooks 'org-after-refile-insert-hook))))
10353 (if regionp
10354 (delete-region (point) (+ (point) region-length))
10355 (org-cut-subtree))
10356 (when (featurep 'org-inlinetask)
10357 (org-inlinetask-remove-END-maybe))
10358 (setq org-markers-to-move nil)
10361 (defun org-refile-goto-last-stored ()
10362 "Go to the location where the last refile was stored."
10363 (interactive)
10364 (bookmark-jump "org-refile-last-stored")
10365 (message "This is the location of the last refile"))
10367 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10368 "Prompt the user for a refile location, using PROMPT."
10369 (let ((org-refile-targets org-refile-targets)
10370 (org-refile-use-outline-path org-refile-use-outline-path))
10371 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
10372 (unless org-refile-target-table
10373 (error "No refile targets"))
10374 (let* ((cbuf (current-buffer))
10375 (partial-completion-mode nil)
10376 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10377 (cfunc (if (and org-refile-use-outline-path
10378 org-outline-path-complete-in-steps)
10379 'org-olpath-completing-read
10380 'org-icompleting-read))
10381 (extra (if org-refile-use-outline-path "/" ""))
10382 (filename (and cfn (expand-file-name cfn)))
10383 (tbl (mapcar
10384 (lambda (x)
10385 (if (and (not (member org-refile-use-outline-path
10386 '(file full-file-path)))
10387 (not (equal filename (nth 1 x))))
10388 (cons (concat (car x) extra " ("
10389 (file-name-nondirectory (nth 1 x)) ")")
10390 (cdr x))
10391 (cons (concat (car x) extra) (cdr x))))
10392 org-refile-target-table))
10393 (completion-ignore-case t)
10394 pa answ parent-target child parent old-hist)
10395 (setq old-hist org-refile-history)
10396 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10397 nil 'org-refile-history))
10398 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10399 (org-refile-check-position pa)
10400 (if pa
10401 (progn
10402 (when (or (not org-refile-history)
10403 (not (eq old-hist org-refile-history))
10404 (not (equal (car pa) (car org-refile-history))))
10405 (setq org-refile-history
10406 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10407 org-refile-history
10408 (cdr org-refile-history))))
10409 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10410 (pop org-refile-history)))
10411 pa)
10413 (progn
10414 (setq parent (match-string 1 answ)
10415 child (match-string 2 answ))
10416 (setq parent-target (or (assoc parent tbl)
10417 (assoc (concat parent "/") tbl)))
10418 (when (and parent-target
10419 (or (eq new-nodes t)
10420 (and (eq new-nodes 'confirm)
10422 child)))))
10423 (org-refile-new-child parent-target child)))
10424 (error "Invalid target location")))))
10426 (defun org-refile-check-position (refile-pointer)
10427 "Check if the refile pointer matches the readline to which it points."
10428 (let* ((file (nth 1 refile-pointer))
10429 (re (nth 2 refile-pointer))
10430 (pos (nth 3 refile-pointer))
10431 buffer)
10432 (when (org-string-nw-p re)
10433 (setq buffer (if (markerp pos)
10434 (marker-buffer pos)
10435 (or (find-buffer-visiting file)
10436 (find-file-noselect file))))
10437 (with-current-buffer buffer
10438 (save-excursion
10439 (save-restriction
10440 (widen)
10441 (goto-char pos)
10442 (beginning-of-line 1)
10443 (unless (org-looking-at-p re)
10444 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10446 (defun org-refile-new-child (parent-target child)
10447 "Use refile target PARENT-TARGET to add new CHILD below it."
10448 (unless parent-target
10449 (error "Cannot find parent for new node"))
10450 (let ((file (nth 1 parent-target))
10451 (pos (nth 3 parent-target))
10452 level)
10453 (with-current-buffer (or (find-buffer-visiting file)
10454 (find-file-noselect file))
10455 (save-excursion
10456 (save-restriction
10457 (widen)
10458 (if pos
10459 (goto-char pos)
10460 (goto-char (point-max))
10461 (if (not (bolp)) (newline)))
10462 (when (looking-at outline-regexp)
10463 (setq level (funcall outline-level))
10464 (org-end-of-subtree t t))
10465 (org-back-over-empty-lines)
10467 (if pos (org-get-valid-level level 1) 1) ?*)
10469 (beginning-of-line 0)
10470 (list (concat (car parent-target) "/" child) file "" (point)))))))
10472 (defun org-olpath-completing-read (prompt collection &rest args)
10473 "Read an outline path like a file name."
10474 (let ((thetable collection)
10475 (org-completion-use-ido nil) ; does not work with ido.
10476 (org-completion-use-iswitchb nil)) ; or iswitchb
10477 (apply
10478 'org-icompleting-read prompt
10479 (lambda (string predicate &optional flag)
10480 (let (rtn r f (l (length string)))
10481 (cond
10482 ((eq flag nil)
10483 ;; try completion
10484 (try-completion string thetable))
10485 ((eq flag t)
10486 ;; all-completions
10487 (setq rtn (all-completions string thetable predicate))
10488 (mapcar
10489 (lambda (x)
10490 (setq r (substring x l))
10491 (if (string-match " ([^)]*)$" x)
10492 (setq f (match-string 0 x))
10493 (setq f ""))
10494 (if (string-match "/" r)
10495 (concat string (substring r 0 (match-end 0)) f)
10496 x))
10497 rtn))
10498 ((eq flag 'lambda)
10499 ;; exact match?
10500 (assoc string thetable)))
10501 ))
10502 args)))
10504 ;;;; Dynamic blocks
10506 (defun org-find-dblock (name)
10507 "Find the first dynamic block with name NAME in the buffer.
10508 If not found, stay at current position and return nil."
10509 (let (pos)
10510 (save-excursion
10511 (goto-char (point-min))
10513 nil t)
10514 (match-beginning 0))))
10515 (if pos (goto-char pos))
10516 pos))
10518 (defconst org-dblock-start-re
10520 "Matches the start line of a dynamic block, with parameters.")
10523 "Matches the end of a dynamic block.")
10525 (defun org-create-dblock (plist)
10526 "Create a dynamic block section, with parameters taken from PLIST.
10527 PLIST must contain a :name entry which is used as name of the block."
10529 (end-of-line 1)
10530 (newline))
10531 (let ((col (current-column))
10532 (name (plist-get plist :name)))
10533 (insert "#+BEGIN: " name)
10534 (while plist
10535 (if (eq (car plist) :name)
10536 (setq plist (cddr plist))
10537 (insert " " (prin1-to-string (pop plist)))))
10539 (beginning-of-line -2)))
10541 (defun org-prepare-dblock ()
10542 "Prepare dynamic block for refresh.
10543 This empties the block, puts the cursor at the insert position and returns
10544 the property list including an extra property :name with the block name."
10545 (unless (looking-at org-dblock-start-re)
10546 (error "Not at a dynamic block"))
10547 (let* ((begdel (1+ (match-end 0)))
10548 (name (org-no-properties (match-string 1)))
10549 (params (append (list :name name)
10550 (read (concat "(" (match-string 3) ")")))))
10551 (save-excursion
10552 (beginning-of-line 1)
10554 (setq params (plist-put params :indentation-column (current-column))))
10555 (unless (re-search-forward org-dblock-end-re nil t)
10556 (error "Dynamic block not terminated"))
10557 (setq params
10558 (append params
10559 (list :content (buffer-substring
10560 begdel (match-beginning 0)))))
10561 (delete-region begdel (match-beginning 0))
10562 (goto-char begdel)
10563 (open-line 1)
10564 params))
10566 (defun org-map-dblocks (&optional command)
10567 "Apply COMMAND to all dynamic blocks in the current buffer.
10568 If COMMAND is not given, use `org-update-dblock'."
10569 (let ((cmd (or command 'org-update-dblock)))
10570 (save-excursion
10571 (goto-char (point-min))
10572 (while (re-search-forward org-dblock-start-re nil t)
10573 (goto-char (match-beginning 0))
10574 (save-excursion
10575 (condition-case nil
10576 (funcall cmd)
10577 (error (message "Error during update of dynamic block"))))
10578 (unless (re-search-forward org-dblock-end-re nil t)
10579 (error "Dynamic block not terminated"))))))
10581 (defun org-dblock-update (&optional arg)
10582 "User command for updating dynamic blocks.
10583 Update the dynamic block at point. With prefix ARG, update all dynamic
10584 blocks in the buffer."
10585 (interactive "P")
10586 (if arg
10587 (org-update-all-dblocks)
10588 (or (looking-at org-dblock-start-re)
10589 (org-beginning-of-dblock))
10590 (org-update-dblock)))
10592 (defun org-update-dblock ()
10593 "Update the dynamic block at point.
10594 This means to empty the block, parse for parameters and then call
10595 the correct writing function."
10596 (interactive)
10597 (save-window-excursion
10598 (let* ((pos (point))
10599 (line (org-current-line))
10600 (params (org-prepare-dblock))
10601 (name (plist-get params :name))
10602 (indent (plist-get params :indentation-column))
10603 (cmd (intern (concat "org-dblock-write:" name))))
10604 (message "Updating dynamic block `%s' at line %d..." name line)
10605 (funcall cmd params)
10606 (message "Updating dynamic block `%s' at line %d...done" name line)
10607 (goto-char pos)
10608 (when (and indent (> indent 0))
10609 (setq indent (make-string indent ?\ ))
10610 (save-excursion
10611 (org-beginning-of-dblock)
10612 (forward-line 1)
10613 (while (not (looking-at org-dblock-end-re))
10614 (insert indent)
10615 (beginning-of-line 2))
10616 (when (looking-at org-dblock-end-re)
10618 (replace-match ""))
10619 (insert indent)))))))
10621 (defun org-beginning-of-dblock ()
10622 "Find the beginning of the dynamic block at point.
10623 Error if there is no such block at point."
10624 (let ((pos (point))
10625 beg)
10626 (end-of-line 1)
10627 (if (and (re-search-backward org-dblock-start-re nil t)
10628 (setq beg (match-beginning 0))
10629 (re-search-forward org-dblock-end-re nil t)
10630 (> (match-end 0) pos))
10631 (goto-char beg)
10632 (goto-char pos)
10633 (error "Not in a dynamic block"))))
10635 (defun org-update-all-dblocks ()
10636 "Update all dynamic blocks in the buffer.
10637 This function can be used in a hook."
10638 (interactive)
10639 (when (org-mode-p)
10640 (org-map-dblocks 'org-update-dblock)))
10643 ;;;; Completion
10645 (defconst org-additional-option-like-keywords
10646 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10647 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10648 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10649 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10650 "BEGIN:" "END:"
10651 "ORGTBL" "TBLFM:" "TBLNAME:"
10652 "BEGIN_EXAMPLE" "END_EXAMPLE"
10653 "BEGIN_QUOTE" "END_QUOTE"
10654 "BEGIN_VERSE" "END_VERSE"
10655 "BEGIN_CENTER" "END_CENTER"
10656 "BEGIN_SRC" "END_SRC"
10657 "BEGIN_RESULT" "END_RESULT"
10658 "SOURCE:" "SRCNAME:" "FUNCTION:"
10659 "RESULTS:"
10660 "HEADER:" "HEADERS:"
10661 "BABEL:"
10662 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10663 "CAPTION:" "LABEL:"
10664 "SETUPFILE:"
10665 "INCLUDE:"
10666 "BIND:"
10667 "MACRO:"))
10669 (defcustom org-structure-template-alist
10670 '(
10683 ("L" "#+latex: "
10687 ("H" "#+html: "
10690 ("A" "#+ascii: ")
10691 ("i" "#+include %file ?"
10693 )
10694 "Structure completion elements.
10695 This is a list of abbreviation keys and values. The value gets inserted
10696 if you type `<' followed by the key and then press the completion key,
10697 usually `M-TAB'. %file will be replaced by a file name after prompting
10698 for the file using completion.
10699 There are two templates for each key, the first uses the original Org syntax,
10700 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10701 the default when the /org-mtags.el/ module has been loaded. See also the
10702 variable `org-mtags-prefer-muse-templates'.
10703 This is an experimental feature, it is undecided if it is going to stay in."
10704 :group 'org-completion
10705 :type '(repeat
10706 (string :tag "Key")
10707 (string :tag "Template")
10708 (string :tag "Muse Template")))
10710 (defun org-try-structure-completion ()
10711 "Try to complete a structure template before point.
10713 expands them."
10714 (let ((l (buffer-substring (point-at-bol) (point)))
10715 a)
10718 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10719 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10720 (match-beginning 1)) a)
10721 t)))
10723 (defun org-complete-expand-structure-template (start cell)
10724 "Expand a structure template."
10725 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10726 (rpl (nth (if musep 2 1) cell))
10727 (ind ""))
10728 (delete-region start (point))
10730 (cond
10731 ((bolp))
10733 (setq ind (buffer-substring (point-at-bol) (point))))
10734 (t (newline))))
10735 (setq start (point))
10736 (if (string-match "%file" rpl)
10737 (setq rpl (replace-match
10738 (concat
10740 (save-match-data
10741 (abbreviate-file-name (read-file-name "Include file: ")))
10743 t t rpl)))
10746 (insert rpl)
10749 ;;;; TODO, DEADLINE, Comments
10751 (defun org-toggle-comment ()
10752 "Change the COMMENT state of an entry."
10753 (interactive)
10754 (save-excursion
10755 (org-back-to-heading)
10756 (let (case-fold-search)
10757 (if (looking-at (concat outline-regexp
10759 (replace-match "" t t nil 1)
10760 (if (looking-at outline-regexp)
10761 (progn
10762 (goto-char (match-end 0))
10763 (insert org-comment-string " ")))))))
10765 (defvar org-last-todo-state-is-todo nil
10766 "This is non-nil when the last TODO state change led to a TODO state.
10767 If the last change removed the TODO tag or switched to DONE, then
10768 this is nil.")
10770 (defvar org-setting-tags nil) ; dynamically skipped
10772 (defvar org-todo-setup-filter-hook nil
10773 "Hook for functions that pre-filter todo specs.
10774 Each function takes a todo spec and returns either nil or the spec
10775 transformed into canonical form." )
10777 (defvar org-todo-get-default-hook nil
10778 "Hook for functions that get a default item for todo.
10779 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10780 nil or a string to be used for the todo mark." )
10782 (defvar org-agenda-headline-snapshot-before-repeat)
10784 (defun org-todo (&optional arg)
10785 "Change the TODO state of an item.
10786 The state of an item is given by a keyword at the start of the heading,
10787 like
10788 *** TODO Write paper
10789 *** DONE Call mom
10791 The different keywords are specified in the variable `org-todo-keywords'.
10793 So for this example: when the item starts with TODO, it is changed to DONE.
10794 When it starts with DONE, the DONE is removed. And when neither TODO nor
10795 DONE are present, add TODO at the beginning of the heading.
10798 state.
10799 With numeric prefix arg, switch to that state.
10801 keywords (nextset).
10804 For calling through lisp, arg is also interpreted in the following way:
10805 'none -> empty state
10807 'done -> switch to DONE
10808 'nextset -> switch to the next set of keywords
10809 'previousset -> switch to the previous set of keywords
10811 really is a member of `org-todo-keywords'."
10812 (interactive "P")
10813 (if (equal arg '(16)) (setq arg 'nextset))
10814 (let ((org-blocker-hook org-blocker-hook)
10815 (case-fold-search nil))
10816 (when (equal arg '(64))
10817 (setq arg nil org-blocker-hook nil))
10818 (when (and org-blocker-hook
10819 (or org-inhibit-blocking
10820 (org-entry-get nil "NOBLOCKING")))
10821 (setq org-blocker-hook nil))
10822 (save-excursion
10823 (catch 'exit
10824 (org-back-to-heading t)
10825 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10827 (looking-at " *"))
10828 (let* ((match-data (match-data))
10829 (startpos (point-at-bol))
10830 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10831 (org-log-done org-log-done)
10832 (org-log-repeat org-log-repeat)
10833 (org-todo-log-states org-todo-log-states)
10834 (this (match-string 1))
10835 (hl-pos (match-beginning 0))
10836 (head (org-get-todo-sequence-head this))
10837 (ass (assoc head org-todo-kwd-alist))
10838 (interpret (nth 1 ass))
10839 (done-word (nth 3 ass))
10840 (final-done-word (nth 4 ass))
10841 (last-state (or this ""))
10842 (completion-ignore-case t)
10843 (member (member this org-todo-keywords-1))
10844 (tail (cdr member))
10845 (state (cond
10846 ((and org-todo-key-trigger
10847 (or (and (equal arg '(4))
10848 (eq org-use-fast-todo-selection 'prefix))
10849 (and (not arg) org-use-fast-todo-selection
10850 (not (eq org-use-fast-todo-selection
10851 'prefix)))))
10852 ;; Use fast selection
10853 (org-fast-todo-selection))
10854 ((and (equal arg '(4))
10855 (or (not org-use-fast-todo-selection)
10856 (not org-todo-key-trigger)))
10857 ;; Read a state with completion
10858 (org-icompleting-read
10859 "State: " (mapcar (lambda(x) (list x))
10860 org-todo-keywords-1)
10861 nil t))
10862 ((eq arg 'right)
10863 (if this
10864 (if tail (car tail) nil)
10865 (car org-todo-keywords-1)))
10866 ((eq arg 'left)
10867 (if (equal member org-todo-keywords-1)
10868 nil
10869 (if this
10870 (nth (- (length org-todo-keywords-1)
10871 (length tail) 2)
10872 org-todo-keywords-1)
10873 (org-last org-todo-keywords-1))))
10874 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10875 (setq arg nil))) ; hack to fall back to cycling
10876 (arg
10877 ;; user or caller requests a specific state
10878 (cond
10879 ((equal arg "") nil)
10880 ((eq arg 'none) nil)
10881 ((eq arg 'done) (or done-word (car org-done-keywords)))
10882 ((eq arg 'nextset)
10883 (or (car (cdr (member head org-todo-heads)))
10884 (car org-todo-heads)))
10885 ((eq arg 'previousset)
10886 (let ((org-todo-heads (reverse org-todo-heads)))
10887 (or (car (cdr (member head org-todo-heads)))
10888 (car org-todo-heads))))
10889 ((car (member arg org-todo-keywords-1)))
10890 ((stringp arg)
10891 (error "State `%s' not valid in this file" arg))
10892 ((nth (1- (prefix-numeric-value arg))
10893 org-todo-keywords-1))))
10894 ((null member) (or head (car org-todo-keywords-1)))
10895 ((equal this final-done-word) nil) ;; -> make empty
10896 ((null tail) nil) ;; -> first entry
10897 ((memq interpret '(type priority))
10898 (if (eq this-command last-command)
10899 (car tail)
10900 (if (> (length tail) 0)
10901 (or done-word (car org-done-keywords))
10902 nil)))
10903 (t
10904 (car tail))))
10905 (state (or
10906 (run-hook-with-args-until-success
10907 'org-todo-get-default-hook state last-state)
10908 state))
10909 (next (if state (concat " " state " ") " "))
10910 (change-plist (list :type 'todo-state-change :from this :to state
10911 :position startpos))
10912 dolog now-done-p)
10913 (when org-blocker-hook
10914 (setq org-last-todo-state-is-todo
10915 (not (member this org-done-keywords)))
10916 (unless (save-excursion
10917 (save-match-data
10918 (run-hook-with-args-until-failure
10919 'org-blocker-hook change-plist)))
10920 (if (interactive-p)
10921 (error "TODO state change from %s to %s blocked" this state)
10922 ;; fail silently
10923 (message "TODO state change from %s to %s blocked" this state)
10924 (throw 'exit nil))))
10925 (store-match-data match-data)
10926 (replace-match next t t)
10927 (unless (pos-visible-in-window-p hl-pos)
10928 (message "TODO state changed to %s" (org-trim next)))
10929 (unless head
10930 (setq head (org-get-todo-sequence-head state)
10931 ass (assoc head org-todo-kwd-alist)
10932 interpret (nth 1 ass)
10933 done-word (nth 3 ass)
10934 final-done-word (nth 4 ass)))
10935 (when (memq arg '(nextset previousset))
10936 (message "Keyword-Set %d/%d: %s"
10937 (- (length org-todo-sets) -1
10938 (length (memq (assoc state org-todo-sets) org-todo-sets)))
10939 (length org-todo-sets)
10940 (mapconcat 'identity (assoc state org-todo-sets) " ")))
10941 (setq org-last-todo-state-is-todo
10942 (not (member state org-done-keywords)))
10943 (setq now-done-p (and (member state org-done-keywords)
10944 (not (member this org-done-keywords))))
10945 (and logging (org-local-logging logging))
10946 (when (and (or org-todo-log-states org-log-done)
10947 (not (eq org-inhibit-logging t))
10948 (not (memq arg '(nextset previousset))))
10949 ;; we need to look at recording a time and note
10950 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
10951 (nth 2 (assoc this org-todo-log-states))))
10952 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
10953 (setq dolog 'time))
10954 (when (and state
10955 (member state org-not-done-keywords)
10956 (not (member this org-not-done-keywords)))
10957 ;; This is now a todo state and was not one before
10958 ;; If there was a CLOSED time stamp, get rid of it.
10959 (org-add-planning-info nil nil 'closed))
10960 (when (and now-done-p org-log-done)
10961 ;; It is now done, and it was not done before
10962 (org-add-planning-info 'closed (org-current-time))
10963 (if (and (not dolog) (eq 'note org-log-done))
10964 (org-add-log-setup 'done state this 'findpos 'note)))
10965 (when (and state dolog)
10966 ;; This is a non-nil state, and we need to log it
10967 (org-add-log-setup 'state state this 'findpos dolog)))
10968 ;; Fixup tag positioning
10969 (org-todo-trigger-tag-changes state)
10970 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
10971 (when org-provide-todo-statistics
10972 (org-update-parent-todo-statistics))
10973 (run-hooks 'org-after-todo-state-change-hook)
10974 (if (and arg (not (member state org-done-keywords)))
10975 (setq head (org-get-todo-sequence-head state)))
10976 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
10977 ;; Do we need to trigger a repeat?
10978 (when now-done-p
10979 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
10980 ;; This is for the agenda, take a snapshot of the headline.
10981 (save-match-data
10982 (setq org-agenda-headline-snapshot-before-repeat
10983 (org-get-heading))))
10984 (org-auto-repeat-maybe state))
10985 ;; Fixup cursor location if close to the keyword
10986 (if (and (outline-on-heading-p)
10987 (not (bolp))
10988 (save-excursion (beginning-of-line 1)
10989 (looking-at org-todo-line-regexp))
10990 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
10991 (progn
10992 (goto-char (or (match-end 2) (match-end 1)))
10993 (and (looking-at " ") (just-one-space))))
10994 (when org-trigger-hook
10995 (save-excursion
10996 (run-hook-with-args 'org-trigger-hook change-plist))))))))
10998 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
10999 "Block turning an entry into a TODO, using the hierarchy.
11000 This checks whether the current task should be blocked from state
11001 changes. Such blocking occurs when:
11003 1. The task has children which are not all in a completed state.
11005 2. A task has a parent with the property :ORDERED:, and there
11006 are siblings prior to the current task with incomplete
11007 status.
11009 3. The parent of the task is blocked because it has siblings that should
11010 be done first, or is child of a block grandparent TODO entry."
11012 (if (not org-enforce-todo-dependencies)
11013 t ; if locally turned off don't block
11014 (catch 'dont-block
11015 ;; If this is not a todo state change, or if this entry is already DONE,
11016 ;; do not block
11017 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11018 (member (plist-get change-plist :from)
11019 (cons 'done org-done-keywords))
11020 (member (plist-get change-plist :to)
11021 (cons 'todo org-not-done-keywords))
11022 (not (plist-get change-plist :to)))
11023 (throw 'dont-block t))
11024 ;; If this task has children, and any are undone, it's blocked
11025 (save-excursion
11026 (org-back-to-heading t)
11027 (let ((this-level (funcall outline-level)))
11028 (outline-next-heading)
11029 (let ((child-level (funcall outline-level)))
11030 (while (and (not (eobp))
11031 (> child-level this-level))
11032 ;; this todo has children, check whether they are all
11033 ;; completed
11034 (if (and (not (org-entry-is-done-p))
11035 (org-entry-is-todo-p))
11036 (throw 'dont-block nil))
11037 (outline-next-heading)
11038 (setq child-level (funcall outline-level))))))
11039 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11040 ;; any previous siblings are undone, it's blocked
11041 (save-excursion
11042 (org-back-to-heading t)
11043 (let* ((pos (point))
11044 (parent-pos (and (org-up-heading-safe) (point))))
11045 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11046 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11047 (forward-line 1)
11048 (re-search-forward org-not-done-heading-regexp pos t))
11049 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11050 ;; Search further up the hierarchy, to see if an anchestor is blocked
11051 (while t
11052 (goto-char parent-pos)
11053 (if (not (looking-at org-not-done-heading-regexp))
11054 (throw 'dont-block t)) ; do not block, parent is not a TODO
11055 (setq pos (point))
11056 (setq parent-pos (and (org-up-heading-safe) (point)))
11057 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11058 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11059 (forward-line 1)
11060 (re-search-forward org-not-done-heading-regexp pos t))
11061 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11063 (defcustom org-track-ordered-property-with-tag nil
11064 "Should the ORDERED property also be shown as a tag?
11065 The ORDERED property decides if an entry should require subtasks to be
11066 completed in sequence. Since a property is not very visible, setting
11067 this option means that toggling the ORDERED property with the command
11068 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11069 not relevant for the behavior, but it makes things more visible.
11071 Note that toggling the tag with tags commands will not change the property
11072 and therefore not influence behavior!
11074 This can be t, meaning the tag ORDERED should be used, It can also be a
11075 string to select a different tag for this task."
11076 :group 'org-todo
11077 :type '(choice
11078 (const :tag "No tracking" nil)
11079 (const :tag "Track with ORDERED tag" t)
11080 (string :tag "Use other tag")))
11082 (defun org-toggle-ordered-property ()
11083 "Toggle the ORDERED property of the current entry.
11084 For better visibility, you can track the value of this property with a tag.
11085 See variable `org-track-ordered-property-with-tag'."
11086 (interactive)
11087 (let* ((t1 org-track-ordered-property-with-tag)
11088 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11089 (save-excursion
11090 (org-back-to-heading)
11091 (if (org-entry-get nil "ORDERED")
11092 (progn
11093 (org-delete-property "ORDERED")
11094 (and tag (org-toggle-tag tag 'off))
11095 (message "Subtasks can be completed in arbitrary order"))
11096 (org-entry-put nil "ORDERED" "t")
11097 (and tag (org-toggle-tag tag 'on))
11098 (message "Subtasks must be completed in sequence")))))
11100 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11101 (defun org-block-todo-from-checkboxes (change-plist)
11102 "Block turning an entry into a TODO, using checkboxes.
11103 This checks whether the current task should be blocked from state
11104 changes because there are unchecked boxes in this entry."
11105 (if (not org-enforce-todo-checkbox-dependencies)
11106 t ; if locally turned off don't block
11107 (catch 'dont-block
11108 ;; If this is not a todo state change, or if this entry is already DONE,
11109 ;; do not block
11110 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11111 (member (plist-get change-plist :from)
11112 (cons 'done org-done-keywords))
11113 (member (plist-get change-plist :to)
11114 (cons 'todo org-not-done-keywords))
11115 (not (plist-get change-plist :to)))
11116 (throw 'dont-block t))
11117 ;; If this task has checkboxes that are not checked, it's blocked
11118 (save-excursion
11119 (org-back-to-heading t)
11120 (let ((beg (point)) end)
11121 (outline-next-heading)
11122 (setq end (point))
11123 (goto-char beg)
11125 end t)
11126 (progn
11127 (if (boundp 'org-blocked-by-checkboxes)
11128 (setq org-blocked-by-checkboxes t))
11129 (throw 'dont-block nil)))))
11130 t))) ; do not block
11132 (defun org-entry-blocked-p ()
11133 "Is the current entry blocked?"
11134 (if (org-entry-get nil "NOBLOCKING")
11135 nil ;; Never block this entry
11136 (not
11137 (run-hook-with-args-until-failure
11138 'org-blocker-hook
11139 (list :type 'todo-state-change
11140 :position (point)
11141 :from 'todo
11142 :to 'done)))))
11144 (defun org-update-statistics-cookies (all)
11145 "Update the statistics cookie, either from TODO or from checkboxes.
11146 This should be called with the cursor in a line with a statistics cookie."
11147 (interactive "P")
11148 (if all
11149 (progn
11150 (org-update-checkbox-count 'all)
11151 (org-map-entries 'org-update-parent-todo-statistics))
11152 (if (not (org-on-heading-p))
11153 (org-update-checkbox-count)
11154 (let ((pos (move-marker (make-marker) (point)))
11155 end l1 l2)
11156 (ignore-errors (org-back-to-heading t))
11157 (if (not (org-on-heading-p))
11158 (org-update-checkbox-count)
11159 (setq l1 (org-outline-level))
11160 (setq end (save-excursion
11161 (outline-next-heading)
11162 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11163 (point)))
11164 (if (and (save-excursion
11165 (re-search-forward
11167 (not (save-excursion (re-search-forward
11169 (org-update-checkbox-count)
11170 (if (and l2 (> l2 l1))
11171 (progn
11172 (goto-char end)
11173 (org-update-parent-todo-statistics))
11174 (goto-char pos)
11175 (beginning-of-line 1)
11176 (while (re-search-forward
11178 (point-at-eol) t)
11179 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11180 (goto-char pos)
11181 (move-marker pos nil)))))
11183 (defvar org-entry-property-inherited-from) ;; defined below
11184 (defun org-update-parent-todo-statistics ()
11185 "Update any statistics cookie in the parent of the current headline.
11186 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11187 the entire subtree and this will travel up the hierarchy and update
11188 statistics everywhere."
11189 (interactive)
11190 (let* ((lim 0) prop
11191 (recursive (or (not org-hierarchical-todo-statistics)
11192 (string-match
11194 (or (setq prop (org-entry-get
11195 nil "COOKIE_DATA" 'inherit)) ""))))
11196 (lim (or (and prop (marker-position
11197 org-entry-property-inherited-from))
11198 lim))
11199 (first t)
11201 level ltoggle l1 new ndel
11202 (cnt-all 0) (cnt-done 0) is-percent kwd
11203 checkbox-beg ov ovs ove cookie-present)
11204 (catch 'exit
11205 (save-excursion
11206 (beginning-of-line 1)
11207 (if (org-at-heading-p)
11208 (setq ltoggle (funcall outline-level))
11209 (error "This should not happen"))
11210 (while (and (setq level (org-up-heading-safe))
11211 (or recursive first)
11212 (>= (point) lim))
11213 (setq first nil cookie-present nil)
11214 (unless (and level
11215 (not (string-match
11217 (downcase
11218 (or (org-entry-get
11219 nil "COOKIE_DATA")
11220 "")))))
11221 (throw 'exit nil))
11222 (while (re-search-forward box-re (point-at-eol) t)
11223 (setq cnt-all 0 cnt-done 0 cookie-present t)
11224 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11225 (save-match-data
11226 (unless (outline-next-heading) (throw 'exit nil))
11227 (while (and (looking-at org-complex-heading-regexp)
11228 (> (setq l1 (length (match-string 1))) level))
11229 (setq kwd (and (or recursive (= l1 ltoggle))
11230 (match-string 2)))
11231 (if (or (eq org-provide-todo-statistics 'all-headlines)
11232 (and (listp org-provide-todo-statistics)
11233 (or (member kwd org-provide-todo-statistics)
11234 (member kwd org-done-keywords))))
11235 (setq cnt-all (1+ cnt-all))
11236 (if (eq org-provide-todo-statistics t)
11237 (and kwd (setq cnt-all (1+ cnt-all)))))
11238 (and (member kwd org-done-keywords)
11239 (setq cnt-done (1+ cnt-done)))
11240 (outline-next-heading)))
11241 (setq new
11242 (if is-percent
11243 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11244 (format "[%d/%d]" cnt-done cnt-all))
11245 ndel (- (match-end 0) checkbox-beg))
11246 ;; handle overlays when updating cookie from column view
11247 (when (setq ov (car (overlays-at checkbox-beg)))
11248 (setq ovs (overlay-start ov) ove (overlay-end ov))
11249 (delete-overlay ov))
11250 (goto-char checkbox-beg)
11251 (insert new)
11252 (delete-region (point) (+ (point) ndel))
11253 (when ov (move-overlay ov ovs ove)))
11254 (when cookie-present
11255 (run-hook-with-args 'org-after-todo-statistics-hook
11256 cnt-done (- cnt-all cnt-done))))))
11257 (run-hooks 'org-todo-statistics-hook)))
11259 (defvar org-after-todo-statistics-hook nil
11260 "Hook that is called after a TODO statistics cookie has been updated.
11261 Each function is called with two arguments: the number of not-done entries
11262 and the number of done entries.
11264 For example, the following function, when added to this hook, will switch
11265 an entry to DONE when all children are done, and back to TODO when new
11266 entries are set to a TODO status. Note that this hook is only called
11267 when there is a statistics cookie in the headline!
11269 (defun org-summary-todo (n-done n-not-done)
11271 (let (org-log-done org-log-states) ; turn off logging
11273 ")
11275 (defvar org-todo-statistics-hook nil
11276 "Hook that is run whenever Org thinks TODO statistics should be updated.
11277 This hook runs even if there is no statistics cookie present, in which case
11278 `org-after-todo-statistics-hook' would not run.")
11280 (defun org-todo-trigger-tag-changes (state)
11281 "Apply the changes defined in `org-todo-state-tags-triggers'."
11282 (let ((l org-todo-state-tags-triggers)
11283 changes)
11284 (when (or (not state) (equal state ""))
11285 (setq changes (append changes (cdr (assoc "" l)))))
11286 (when (and (stringp state) (> (length state) 0))
11287 (setq changes (append changes (cdr (assoc state l)))))
11288 (when (member state org-not-done-keywords)
11289 (setq changes (append changes (cdr (assoc 'todo l)))))
11290 (when (member state org-done-keywords)
11291 (setq changes (append changes (cdr (assoc 'done l)))))
11292 (dolist (c changes)
11293 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11295 (defun org-local-logging (value)
11296 "Get logging settings from a property VALUE."
11297 (let* (words w a)
11298 ;; directly set the variables, they are already local.
11299 (setq org-log-done nil
11300 org-log-repeat nil
11301 org-todo-log-states nil)
11302 (setq words (org-split-string value))
11303 (while (setq w (pop words))
11304 (cond
11305 ((setq a (assoc w org-startup-options))
11306 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11307 (set (nth 1 a) (nth 2 a))))
11308 ((setq a (org-extract-log-state-settings w))
11309 (and (member (car a) org-todo-keywords-1)
11310 (push a org-todo-log-states)))))))
11312 (defun org-get-todo-sequence-head (kwd)
11313 "Return the head of the TODO sequence to which KWD belongs.
11314 If KWD is not set, check if there is a text property remembering the
11315 right sequence."
11316 (let (p)
11317 (cond
11318 ((not kwd)
11319 (or (get-text-property (point-at-bol) 'org-todo-head)
11320 (progn
11321 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11322 nil (point-at-eol)))
11323 (get-text-property p 'org-todo-head))))
11324 ((not (member kwd org-todo-keywords-1))
11325 (car org-todo-keywords-1))
11326 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11328 (defun org-fast-todo-selection ()
11329 "Fast TODO keyword selection with single keys.
11330 Returns the new TODO keyword, or nil if no state change should occur."
11331 (let* ((fulltable org-todo-key-alist)
11332 (done-keywords org-done-keywords) ;; needed for the faces.
11333 (maxlen (apply 'max (mapcar
11334 (lambda (x)
11335 (if (stringp (car x)) (string-width (car x)) 0))
11336 fulltable)))
11337 (expert nil)
11338 (fwidth (+ maxlen 3 1 3))
11339 (ncol (/ (- (window-width) 4) fwidth))
11340 tg cnt e c tbl
11341 groups ingroup)
11342 (save-excursion
11343 (save-window-excursion
11344 (if expert
11345 (set-buffer (get-buffer-create " *Org todo*"))
11346 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11347 (erase-buffer)
11348 (org-set-local 'org-done-keywords done-keywords)
11349 (setq tbl fulltable cnt 0)
11350 (while (setq e (pop tbl))
11351 (cond
11352 ((equal e '(:startgroup))
11353 (push '() groups) (setq ingroup t)
11354 (when (not (= cnt 0))
11355 (setq cnt 0)
11357 (insert "{ "))
11358 ((equal e '(:endgroup))
11359 (setq ingroup nil cnt 0)
11361 ((equal e '(:newline))
11362 (when (not (= cnt 0))
11363 (setq cnt 0)
11365 (setq e (car tbl))
11366 (while (equal (car tbl) '(:newline))
11368 (setq tbl (cdr tbl)))))
11369 (t
11370 (setq tg (car e) c (cdr e))
11371 (if ingroup (push tg (car groups)))
11372 (setq tg (org-add-props tg nil 'face
11373 (org-get-todo-face tg)))
11374 (if (and (= cnt 0) (not ingroup)) (insert " "))
11375 (insert "[" c "] " tg (make-string
11376 (- fwidth 4 (length tg)) ?\ ))
11377 (when (= (setq cnt (1+ cnt)) ncol)
11379 (if ingroup (insert " "))
11380 (setq cnt 0)))))
11382 (goto-char (point-min))
11383 (if (not expert) (org-fit-window-to-buffer))
11384 (message "[a-z..]:Set [SPC]:clear")
11385 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11386 (cond
11387 ((or (= c ?\C-g)
11388 (and (= c ?q) (not (rassoc c fulltable))))
11389 (setq quit-flag t))
11390 ((= c ?\ ) nil)
11391 ((setq e (rassoc c fulltable) tg (car e))
11392 tg)
11393 (t (setq quit-flag t)))))))
11395 (defun org-entry-is-todo-p ()
11396 (member (org-get-todo-state) org-not-done-keywords))
11398 (defun org-entry-is-done-p ()
11399 (member (org-get-todo-state) org-done-keywords))
11401 (defun org-get-todo-state ()
11402 (save-excursion
11403 (org-back-to-heading t)
11404 (and (looking-at org-todo-line-regexp)
11405 (match-end 2)
11406 (match-string 2))))
11408 (defun org-at-date-range-p (&optional inactive-ok)
11409 "Is the cursor inside a date range?"
11410 (interactive)
11411 (save-excursion
11412 (catch 'exit
11413 (let ((pos (point)))
11415 (skip-chars-backward "<[")
11416 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11417 (>= (match-end 0) pos)
11418 (throw 'exit t))
11420 (skip-chars-backward "<[")
11421 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11422 (>= (match-end 0) pos)
11423 (throw 'exit t)))
11424 nil)))
11426 (defun org-get-repeat (&optional tagline)
11427 "Check if there is a deadline/schedule with repeater in this entry."
11428 (save-match-data
11429 (save-excursion
11430 (org-back-to-heading t)
11431 (and (re-search-forward (if tagline
11433 org-repeat-re)
11434 (org-entry-end-position) t)
11435 (match-string-no-properties 1)))))
11437 (defvar org-last-changed-timestamp)
11438 (defvar org-last-inserted-timestamp)
11439 (defvar org-log-post-message)
11440 (defvar org-log-note-purpose)
11441 (defvar org-log-note-how)
11442 (defvar org-log-note-extra)
11443 (defun org-auto-repeat-maybe (done-word)
11444 "Check if the current headline contains a repeated deadline/schedule.
11445 If yes, set TODO state back to what it was and change the base date
11446 of repeating deadline/scheduled time stamps to new date.
11447 This function is run automatically after each state change to a DONE state."
11448 ;; last-state is dynamically scoped into this function
11449 (let* ((repeat (org-get-repeat))
11450 (aa (assoc last-state org-todo-kwd-alist))
11451 (interpret (nth 1 aa))
11452 (head (nth 2 aa))
11453 (whata '(("d" . day) ("m" . month) ("y" . year)))
11454 (msg "Entry repeats: ")
11455 (org-log-done nil)
11456 (org-todo-log-states nil)
11457 re type n what ts time to-state)
11458 (when repeat
11459 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11460 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11461 org-todo-repeat-to-state))
11462 (unless (and to-state (member to-state org-todo-keywords-1))
11463 (setq to-state (if (eq interpret 'type) last-state head)))
11464 (org-todo to-state)
11465 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11466 (org-entry-put nil "LAST_REPEAT" (format-time-string
11467 (org-time-stamp-format t t))))
11468 (when org-log-repeat
11469 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11470 (memq 'org-add-log-note post-command-hook))
11471 ;; OK, we are already setup for some record
11472 (if (eq org-log-repeat 'note)
11473 ;; make sure we take a note, not only a time stamp
11474 (setq org-log-note-how 'note))
11475 ;; Set up for taking a record
11476 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11477 last-state
11478 'findpos org-log-repeat)))
11479 (org-back-to-heading t)
11480 (org-add-planning-info nil nil 'closed)
11484 (while (re-search-forward
11485 re (save-excursion (outline-next-heading) (point)) t)
11486 (setq type (if (match-end 1) org-scheduled-string
11487 (if (match-end 3) org-deadline-string "Plain:"))
11488 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11490 (setq n (string-to-number (match-string 2 ts))
11491 what (match-string 3 ts))
11492 (if (equal what "w") (setq n (* n 7) what "d"))
11493 ;; Preparation, see if we need to modify the start date for the change
11494 (when (match-end 1)
11495 (setq time (save-match-data (org-time-string-to-time ts)))
11496 (cond
11497 ((equal (match-string 1 ts) ".")
11498 ;; Shift starting date to today
11499 (org-timestamp-change
11500 (- (time-to-days (current-time)) (time-to-days time))
11501 'day))
11502 ((equal (match-string 1 ts) "+")
11503 (let ((nshiftmax 10) (nshift 0))
11504 (while (or (= nshift 0)
11505 (<= (time-to-days time)
11506 (time-to-days (current-time))))
11507 (when (= (incf nshift) nshiftmax)
11508 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11509 (error "Abort")))
11510 (org-timestamp-change n (cdr (assoc what whata)))
11511 (org-at-timestamp-p t)
11512 (setq ts (match-string 1))
11513 (setq time (save-match-data (org-time-string-to-time ts)))))
11514 (org-timestamp-change (- n) (cdr (assoc what whata)))
11515 ;; rematch, so that we have everything in place for the real shift
11516 (org-at-timestamp-p t)
11517 (setq ts (match-string 1))
11519 (org-timestamp-change n (cdr (assoc what whata)))
11520 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11521 (setq org-log-post-message msg)
11522 (message "%s" msg))))
11524 (defun org-show-todo-tree (arg)
11525 "Make a compact tree which shows all headlines marked with TODO.
11526 The tree will show the lines where the regexp matches, and all higher
11527 headlines above the match.
11529 With a numeric prefix N, construct a sparse tree for the Nth element
11530 of `org-todo-keywords-1'."
11531 (interactive "P")
11532 (let ((case-fold-search nil)
11533 (kwd-re
11534 (cond ((null arg) org-not-done-regexp)
11535 ((equal arg '(4))
11536 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11537 (mapcar 'list org-todo-keywords-1))))
11541 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11542 (regexp-quote (nth (1- (prefix-numeric-value arg))
11543 org-todo-keywords-1)))
11544 (t (error "Invalid prefix argument: %s" arg)))))
11545 (message "%d TODO entries found"
11546 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
11548 (defun org-deadline (&optional remove time)
11550 With argument REMOVE, remove any deadline from the item.
11551 When TIME is set, it should be an internal time specification, and the
11552 scheduling will use the corresponding date."
11553 (interactive "P")
11554 (let* ((old-date (org-entry-get nil "DEADLINE"))
11555 (repeater (and old-date
11556 (string-match
11558 old-date)
11559 (match-string 1 old-date))))
11560 (if remove
11561 (progn
11562 (when (and old-date org-log-redeadline)
11563 (org-add-log-setup 'deldeadline nil old-date 'findpos
11564 org-log-redeadline))
11565 (org-remove-timestamp-with-keyword org-deadline-string)
11566 (message "Item no longer has a deadline."))
11567 (org-add-planning-info 'deadline time 'closed)
11568 (when (and old-date org-log-redeadline
11569 (not (equal old-date
11570 (substring org-last-inserted-timestamp 1 -1))))
11571 (org-add-log-setup 'redeadline nil old-date 'findpos
11572 org-log-redeadline))
11573 (when repeater
11574 (save-excursion
11575 (org-back-to-heading t)
11576 (when (re-search-forward (concat org-deadline-string " "
11577 org-last-inserted-timestamp)
11578 (save-excursion
11579 (outline-next-heading) (point)) t)
11580 (goto-char (1- (match-end 0)))
11581 (insert " " repeater)
11582 (setq org-last-inserted-timestamp
11583 (concat (substring org-last-inserted-timestamp 0 -1)
11584 " " repeater
11585 (substring org-last-inserted-timestamp -1))))))
11586 (message "Deadline on %s" org-last-inserted-timestamp))))
11588 (defun org-schedule (&optional remove time)
11589 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11590 With argument REMOVE, remove any scheduling date from the item.
11591 When TIME is set, it should be an internal time specification, and the
11592 scheduling will use the corresponding date."
11593 (interactive "P")
11594 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11595 (repeater (and old-date
11596 (string-match
11598 old-date)
11599 (match-string 1 old-date))))
11600 (if remove
11601 (progn
11602 (when (and old-date org-log-reschedule)
11603 (org-add-log-setup 'delschedule nil old-date 'findpos
11604 org-log-reschedule))
11605 (org-remove-timestamp-with-keyword org-scheduled-string)
11606 (message "Item is no longer scheduled."))
11607 (org-add-planning-info 'scheduled time 'closed)
11608 (when (and old-date org-log-reschedule
11609 (not (equal old-date
11610 (substring org-last-inserted-timestamp 1 -1))))
11611 (org-add-log-setup 'reschedule nil old-date 'findpos
11612 org-log-reschedule))
11613 (when repeater
11614 (save-excursion
11615 (org-back-to-heading t)
11616 (when (re-search-forward (concat org-scheduled-string " "
11617 org-last-inserted-timestamp)
11618 (save-excursion
11619 (outline-next-heading) (point)) t)
11620 (goto-char (1- (match-end 0)))
11621 (insert " " repeater)
11622 (setq org-last-inserted-timestamp
11623 (concat (substring org-last-inserted-timestamp 0 -1)
11624 " " repeater
11625 (substring org-last-inserted-timestamp -1))))))
11626 (message "Scheduled to %s" org-last-inserted-timestamp))))
11628 (defun org-get-scheduled-time (pom &optional inherit)
11629 "Get the scheduled time as a time tuple, of a format suitable
11630 for calling org-schedule with, or if there is no scheduling,
11631 returns nil."
11632 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11633 (when time
11634 (apply 'encode-time (org-parse-time-string time)))))
11636 (defun org-get-deadline-time (pom &optional inherit)
11637 "Get the deadline as a time tuple, of a format suitable for
11638 calling org-deadline with, or if there is no scheduling, returns
11639 nil."
11640 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11641 (when time
11642 (apply 'encode-time (org-parse-time-string time)))))
11644 (defun org-remove-timestamp-with-keyword (keyword)
11645 "Remove all time stamps with KEYWORD in the current entry."
11647 beg)
11648 (save-excursion
11649 (org-back-to-heading t)
11650 (setq beg (point))
11651 (outline-next-heading)
11652 (while (re-search-backward re beg t)
11653 (replace-match "")
11655 (equal (char-before) ?\ ))
11656 (backward-delete-char 1)
11658 (point-at-bol) (point-at-eol)))
11659 (delete-region (point-at-bol)
11660 (min (point-max) (1+ (point-at-eol))))))))))
11662 (defun org-add-planning-info (what &optional time &rest remove)
11663 "Insert new timestamp with keyword in the line directly after the headline.
11664 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11665 If non is given, the user is prompted for a date.
11666 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11667 be removed."
11668 (interactive)
11669 (let (org-time-was-given org-end-time-was-given ts
11670 end default-time default-input)
11672 (catch 'exit
11673 (when (and (not time) (memq what '(scheduled deadline)))
11674 ;; Try to get a default date/time from existing timestamp
11675 (save-excursion
11676 (org-back-to-heading t)
11677 (setq end (save-excursion (outline-next-heading) (point)))
11678 (when (re-search-forward (if (eq what 'scheduled)
11679 org-scheduled-time-regexp
11680 org-deadline-time-regexp)
11681 end t)
11682 (setq ts (match-string 1)
11683 default-time
11684 (apply 'encode-time (org-parse-time-string ts))
11685 default-input (and ts (org-get-compact-tod ts))))))
11686 (when what
11687 ;; If necessary, get the time from the user
11688 (setq time (or time (org-read-date nil 'to-time nil nil
11689 default-time default-input))))
11691 (when (and org-insert-labeled-timestamps-at-point
11692 (member what '(scheduled deadline)))
11693 (insert
11694 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11695 (org-insert-time-stamp time org-time-was-given
11696 nil nil nil (list org-end-time-was-given))
11697 (setq what nil))
11698 (save-excursion
11699 (save-restriction
11700 (let (col list elt ts buffer-invisibility-spec)
11701 (org-back-to-heading t)
11703 (goto-char (match-end 1))
11704 (setq col (current-column))
11705 (goto-char (match-end 0))
11707 (when (and (not what)
11708 (not (looking-at
11710 org-keyword-time-not-clock-regexp))))
11711 ;; Nothing to add, nothing to remove...... :-)
11712 (throw 'exit nil))
11713 (if (and (not (looking-at outline-regexp))
11716 (not (equal (match-string 1) org-clock-string)))
11717 (narrow-to-region (match-beginning 0) (match-end 0))
11719 (backward-char 1)
11720 (narrow-to-region (point) (point))
11721 (and org-adapt-indentation (org-indent-to-column col)))
11722 ;; Check if we have to remove something.
11723 (setq list (cons what remove))
11724 (while list
11725 (setq elt (pop list))
11726 (goto-char (point-min))
11727 (when (or (and (eq elt 'scheduled)
11728 (re-search-forward org-scheduled-time-regexp nil t))
11729 (and (eq elt 'deadline)
11730 (re-search-forward org-deadline-time-regexp nil t))
11731 (and (eq elt 'closed)
11732 (re-search-forward org-closed-time-regexp nil t)))
11733 (replace-match "")
11734 (if (looking-at "--+<[^>]+>") (replace-match ""))
11735 (skip-chars-backward " ")
11736 (if (looking-at " +") (replace-match ""))))
11737 (goto-char (point-max))
11738 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11739 (when what
11740 (insert
11741 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11742 (cond ((eq what 'scheduled) org-scheduled-string)
11743 ((eq what 'deadline) org-deadline-string)
11744 ((eq what 'closed) org-closed-string))
11745 " ")
11746 (setq ts (org-insert-time-stamp
11747 time
11748 (or org-time-was-given
11749 (and (eq what 'closed) org-log-done-with-time))
11750 (eq what 'closed)
11751 nil nil (list org-end-time-was-given)))
11752 (end-of-line 1))
11753 (goto-char (point-min))
11754 (widen)
11757 (delete-region (1- (point)) (point-at-eol)))
11758 ts))))))
11760 (defvar org-log-note-marker (make-marker))
11761 (defvar org-log-note-purpose nil)
11762 (defvar org-log-note-state nil)
11763 (defvar org-log-note-previous-state nil)
11764 (defvar org-log-note-how nil)
11765 (defvar org-log-note-extra nil)
11766 (defvar org-log-note-window-configuration nil)
11767 (defvar org-log-note-return-to (make-marker))
11768 (defvar org-log-post-message nil
11769 "Message to be displayed after a log note has been stored.
11770 The auto-repeater uses this.")
11772 (defun org-add-note ()
11773 "Add a note to the current entry.
11774 This is done in the same way as adding a state change note."
11775 (interactive)
11776 (org-add-log-setup 'note nil nil 'findpos nil))
11778 (defvar org-property-end-re)
11779 (defun org-add-log-setup (&optional purpose state prev-state
11780 findpos how extra)
11781 "Set up the post command hook to take a note.
11782 If this is about to TODO state change, the new state is expected in STATE.
11783 When FINDPOS is non-nil, find the correct position for the note in
11784 the current entry. If not, assume that it can be inserted at point.
11785 HOW is an indicator what kind of note should be created.
11786 EXTRA is additional text that will be inserted into the notes buffer."
11787 (let* ((org-log-into-drawer (org-log-into-drawer))
11788 (drawer (cond ((stringp org-log-into-drawer)
11789 org-log-into-drawer)
11790 (org-log-into-drawer "LOGBOOK")
11791 (t nil))))
11792 (save-restriction
11793 (save-excursion
11794 (when findpos
11795 (org-back-to-heading t)
11796 (narrow-to-region (point) (save-excursion
11797 (outline-next-heading) (point)))
11801 (goto-char (match-end 0))
11802 (cond
11803 (drawer
11805 nil t)
11806 (progn
11807 (goto-char (match-end 0))
11808 (or org-log-states-order-reversed
11809 (and (re-search-forward org-property-end-re nil t)
11810 (goto-char (1- (match-beginning 0))))))
11812 (beginning-of-line 0)
11813 (org-indent-line-function)
11814 (beginning-of-line 2)
11815 (org-indent-line-function)
11816 (end-of-line 0)))
11817 ((and org-log-state-notes-insert-after-drawers
11818 (save-excursion
11819 (forward-line) (looking-at org-drawer-regexp)))
11820 (forward-line)
11821 (while (looking-at org-drawer-regexp)
11822 (goto-char (match-end 0))
11823 (re-search-forward org-property-end-re (point-max) t)
11824 (forward-line))
11825 (forward-line -1)))
11826 (unless org-log-states-order-reversed
11828 (org-skip-over-state-notes)
11830 (move-marker org-log-note-marker (point))
11831 (setq org-log-note-purpose purpose
11832 org-log-note-state state
11833 org-log-note-previous-state prev-state
11834 org-log-note-how how
11835 org-log-note-extra extra)
11836 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11838 (defun org-skip-over-state-notes ()
11839 "Skip past the list of State notes in an entry."
11841 (when (ignore-errors (goto-char (org-in-item-p)))
11842 (let* ((struct (org-list-struct))
11843 (prevs (org-list-prevs-alist struct)))
11845 (goto-char (or (org-list-get-next-item (point) struct prevs)
11846 (org-list-get-item-end (point) struct)))))))
11848 (defun org-add-log-note (&optional purpose)
11849 "Pop up a window for taking a note, and add this note later at point."
11850 (remove-hook 'post-command-hook 'org-add-log-note)
11851 (setq org-log-note-window-configuration (current-window-configuration))
11852 (delete-other-windows)
11853 (move-marker org-log-note-return-to (point))
11854 (switch-to-buffer (marker-buffer org-log-note-marker))
11855 (goto-char org-log-note-marker)
11856 (org-switch-to-buffer-other-window "*Org Note*")
11857 (erase-buffer)
11858 (if (memq org-log-note-how '(time state))
11859 (let (current-prefix-arg) (org-store-log-note))
11860 (let ((org-inhibit-startup t)) (org-mode))
11861 (insert (format "# Insert note for %s.
11863 (cond
11864 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11865 ((eq org-log-note-purpose 'done) "closed todo item")
11866 ((eq org-log-note-purpose 'state)
11868 (or org-log-note-previous-state "")
11869 (or org-log-note-state "")))
11870 ((eq org-log-note-purpose 'reschedule)
11871 "rescheduling")
11872 ((eq org-log-note-purpose 'delschedule)
11873 "no longer scheduled")
11874 ((eq org-log-note-purpose 'redeadline)
11875 "changing deadline")
11876 ((eq org-log-note-purpose 'deldeadline)
11877 "removing deadline")
11878 ((eq org-log-note-purpose 'refile)
11879 "refiling")
11880 ((eq org-log-note-purpose 'note)
11881 "this entry")
11882 (t (error "This should not happen")))))
11883 (if org-log-note-extra (insert org-log-note-extra))
11884 (org-set-local 'org-finish-function 'org-store-log-note)))
11886 (defvar org-note-abort nil) ; dynamically scoped
11887 (defun org-store-log-note ()
11888 "Finish taking a log note, and insert it to where it belongs."
11889 (let ((txt (buffer-string))
11890 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11891 lines ind bul)
11892 (kill-buffer (current-buffer))
11894 (setq txt (replace-match "" t t txt)))
11896 (setq txt (replace-match "" t t txt)))
11899 (setq note
11900 (org-replace-escapes
11901 note
11902 (list (cons "%u" (user-login-name))
11903 (cons "%U" user-full-name)
11904 (cons "%t" (format-time-string
11905 (org-time-stamp-format 'long 'inactive)
11906 (current-time)))
11907 (cons "%T" (format-time-string
11908 (org-time-stamp-format 'long nil)
11909 (current-time)))
11910 (cons "%s" (if org-log-note-state
11912 ""))
11913 (cons "%S" (if org-log-note-previous-state
11917 (push note lines))
11918 (when (or current-prefix-arg org-note-abort)
11919 (when org-log-into-drawer
11920 (org-remove-empty-drawer-at
11921 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11922 org-log-note-marker))
11923 (setq lines nil))
11924 (when lines
11925 (with-current-buffer (marker-buffer org-log-note-marker)
11926 (save-excursion
11927 (goto-char org-log-note-marker)
11928 (move-marker org-log-note-marker nil)
11929 (end-of-line 1)
11931 (setq ind (save-excursion
11932 (if (ignore-errors (goto-char (org-in-item-p)))
11933 (let ((struct (org-list-struct)))
11934 (org-list-get-ind
11935 (org-list-get-top-point struct) struct))
11937 (cond
11938 ((and (org-at-heading-p)
11939 org-adapt-indentation)
11940 (1+ (org-current-level)))
11941 ((org-at-heading-p) 0)
11942 (t (org-get-indentation))))))
11943 (setq bul (org-list-bullet-string "-"))
11944 (org-indent-line-to ind)
11945 (insert bul (pop lines))
11946 (let ((ind-body (+ (length bul) ind)))
11947 (while lines
11949 (org-indent-line-to ind-body)
11950 (insert (pop lines))))
11951 (message "Note stored")
11952 (org-back-to-heading t)
11953 (org-cycle-hide-drawers 'children)))))
11954 (set-window-configuration org-log-note-window-configuration)
11955 (with-current-buffer (marker-buffer org-log-note-return-to)
11956 (goto-char org-log-note-return-to))
11957 (move-marker org-log-note-return-to nil)
11958 (and org-log-post-message (message "%s" org-log-post-message)))
11960 (defun org-remove-empty-drawer-at (drawer pos)
11961 "Remove an empty drawer DRAWER at position POS.
11962 POS may also be a marker."
11963 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
11964 (save-excursion
11965 (save-restriction
11966 (widen)
11967 (goto-char pos)
11968 (if (org-in-regexp
11970 (replace-match ""))))))
11972 (defun org-sparse-tree (&optional arg)
11973 "Create a sparse tree, prompt for the details.
11974 This command can create sparse trees. You first need to select the type
11975 of match used to create the tree:
11977 t Show all TODO entries.
11978 T Show entries with a specific TODO keyword.
11979 m Show entries selected by a tags/property match.
11980 p Enter a property name and its value (both with completion on existing
11981 names/values) and show entries with that property.
11982 r Show entries matching a regular expression (`/' can be used as well)
11983 d Show deadlines due within `org-deadline-warning-days'.
11984 b Show deadlines and scheduled items before a date.
11985 a Show deadlines and scheduled items after a date."
11986 (interactive "P")
11987 (let (ans kwd value)
11988 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
11989 (setq ans (read-char-exclusive))
11990 (cond
11991 ((equal ans ?d)
11992 (call-interactively 'org-check-deadlines))
11993 ((equal ans ?b)
11994 (call-interactively 'org-check-before-date))
11995 ((equal ans ?a)
11996 (call-interactively 'org-check-after-date))
11997 ((equal ans ?t)
11998 (org-show-todo-tree nil))
11999 ((equal ans ?T)
12000 (org-show-todo-tree '(4)))
12001 ((member ans '(?T ?m))
12002 (call-interactively 'org-match-sparse-tree))
12003 ((member ans '(?p ?P))
12004 (setq kwd (org-icompleting-read "Property: "
12005 (mapcar 'list (org-buffer-property-keys))))
12006 (setq value (org-icompleting-read "Value: "
12007 (mapcar 'list (org-property-values kwd))))
12010 (org-match-sparse-tree arg (concat kwd "=" value)))
12011 ((member ans '(?r ?R ?/))
12012 (call-interactively 'org-occur))
12015 (defvar org-occur-highlights nil
12016 "List of overlays used for occur matches.")
12017 (make-variable-buffer-local 'org-occur-highlights)
12018 (defvar org-occur-parameters nil
12019 "Parameters of the active org-occur calls.
12020 This is a list, each call to org-occur pushes as cons cell,
12021 containing the regular expression and the callback, onto the list.
12022 The list can contain several entries if `org-occur' has been called
12023 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12024 will only contain one set of parameters. When the highlights are
12025 removed (for example with `C-c C-c', or with the next edit (depending
12026 on `org-remove-highlights-with-change'), this variable is emptied
12027 as well.")
12028 (make-variable-buffer-local 'org-occur-parameters)
12030 (defun org-occur (regexp &optional keep-previous callback)
12031 "Make a compact tree which shows all matches of REGEXP.
12032 The tree will show the lines where the regexp matches, and all higher
12033 headlines above the match. It will also show the heading after the match,
12034 to make sure editing the matching entry is easy.
12035 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12036 call to `org-occur' will be kept, to allow stacking of calls to this
12037 command.
12038 If CALLBACK is non-nil, it is a function which is called to confirm
12039 that the match should indeed be shown."
12041 (when (equal regexp "")
12042 (error "Regexp cannot be empty"))
12043 (unless keep-previous
12044 (org-remove-occur-highlights nil nil t))
12045 (push (cons regexp callback) org-occur-parameters)
12046 (let ((cnt 0))
12047 (save-excursion
12048 (goto-char (point-min))
12049 (if (or (not keep-previous) ; do not want to keep
12050 (not org-occur-highlights)) ; no previous matches
12051 ;; hide everything
12052 (org-overview))
12053 (while (re-search-forward regexp nil t)
12054 (when (or (not callback)
12055 (save-match-data (funcall callback)))
12056 (setq cnt (1+ cnt))
12057 (when org-highlight-sparse-tree-matches
12058 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12059 (org-show-context 'occur-tree))))
12060 (when org-remove-highlights-with-change
12061 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12062 nil 'local))
12063 (unless org-sparse-tree-open-archived-trees
12064 (org-hide-archived-subtrees (point-min) (point-max)))
12065 (run-hooks 'org-occur-hook)
12066 (if (interactive-p)
12067 (message "%d match(es) for regexp %s" cnt regexp))
12068 cnt))
12070 (defun org-occur-next-match (&optional n reset)
12071 "Function for `next-error-function' to find sparse tree matches.
12072 N is the number of matches to move, when negative move backwards.
12073 RESET is entirely ignored - this function always goes back to the
12074 starting point when no match is found."
12075 (let* ((limit (if (< n 0) (point-min) (point-max)))
12076 (search-func (if (< n 0)
12077 'previous-single-char-property-change
12078 'next-single-char-property-change))
12079 (n (abs n))
12080 (pos (point))
12081 p1)
12082 (catch 'exit
12083 (while (setq p1 (funcall search-func (point) 'org-type))
12084 (when (equal p1 limit)
12085 (goto-char pos)
12086 (error "No more matches"))
12087 (when (equal (get-char-property p1 'org-type) 'org-occur)
12088 (setq n (1- n))
12089 (when (= n 0)
12090 (goto-char p1)
12091 (throw 'exit (point))))
12092 (goto-char p1))
12093 (goto-char p1)
12094 (error "No more matches"))))
12096 (defun org-show-context (&optional key)
12097 "Make sure point and context are visible.
12098 How much context is shown depends upon the variables
12099 `org-show-hierarchy-above', `org-show-following-heading'. and
12100 `org-show-siblings'."
12101 (let ((heading-p (org-on-heading-p t))
12102 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12103 (following-p (org-get-alist-option org-show-following-heading key))
12104 (entry-p (org-get-alist-option org-show-entry-below key))
12105 (siblings-p (org-get-alist-option org-show-siblings key)))
12106 (catch 'exit
12107 ;; Show heading or entry text
12108 (if (and heading-p (not entry-p))
12109 (org-flag-heading nil) ; only show the heading
12110 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12111 (org-show-hidden-entry))) ; show entire entry
12112 (when following-p
12113 ;; Show next sibling, or heading below text
12114 (save-excursion
12115 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12116 (org-flag-heading nil))))
12117 (when siblings-p (org-show-siblings))
12118 (when hierarchy-p
12119 ;; show all higher headings, possibly with siblings
12120 (save-excursion
12121 (while (and (condition-case nil
12122 (progn (org-up-heading-all 1) t)
12123 (error nil))
12124 (not (bobp)))
12125 (org-flag-heading nil)
12126 (when siblings-p (org-show-siblings))))))))
12128 (defvar org-reveal-start-hook nil
12129 "Hook run before revealing a location.")
12131 (defun org-reveal (&optional siblings)
12132 "Show current entry, hierarchy above it, and the following headline.
12133 This can be used to show a consistent set of context around locations
12134 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12135 not t for the search context.
12137 With optional argument SIBLINGS, on each level of the hierarchy all
12138 siblings are shown. This repairs the tree structure to what it would
12139 look like when opened with hierarchical calls to `org-cycle'.
12141 go to the parent and show the
12142 entire tree."
12143 (interactive "P")
12144 (run-hooks 'org-reveal-start-hook)
12145 (let ((org-show-hierarchy-above t)
12146 (org-show-following-heading t)
12147 (org-show-siblings (if siblings t org-show-siblings)))
12148 (org-show-context nil))
12149 (when (equal siblings '(16))
12150 (save-excursion
12151 (when (org-up-heading-safe)
12152 (org-show-subtree)
12153 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12155 (defun org-highlight-new-match (beg end)
12156 "Highlight from BEG to END and mark the highlight is an occur headline."
12157 (let ((ov (make-overlay beg end)))
12158 (overlay-put ov 'face 'secondary-selection)
12159 (overlay-put ov 'org-type 'org-occur)
12160 (push ov org-occur-highlights)))
12162 (defun org-remove-occur-highlights (&optional beg end noremove)
12163 "Remove the occur highlights from the buffer.
12164 BEG and END are ignored. If NOREMOVE is nil, remove this function
12165 from the `before-change-functions' in the current buffer."
12166 (interactive)
12167 (unless org-inhibit-highlight-removal
12168 (mapc 'delete-overlay org-occur-highlights)
12169 (setq org-occur-highlights nil)
12170 (setq org-occur-parameters nil)
12171 (unless noremove
12172 (remove-hook 'before-change-functions
12173 'org-remove-occur-highlights 'local))))
12175 ;;;; Priorities
12178 "Regular expression matching the priority indicator.")
12180 (defvar org-remove-priority-next-time nil)
12182 (defun org-priority-up ()
12183 "Increase the priority of the current item."
12184 (interactive)
12185 (org-priority 'up))
12187 (defun org-priority-down ()
12188 "Decrease the priority of the current item."
12189 (interactive)
12190 (org-priority 'down))
12192 (defun org-priority (&optional action)
12193 "Change the priority of an item by ARG.
12194 ACTION can be `set', `up', `down', or a character."
12195 (interactive)
12196 (unless org-enable-priority-commands
12197 (error "Priority commands are disabled"))
12198 (setq action (or action 'set))
12199 (let (current new news have remove)
12200 (save-excursion
12201 (org-back-to-heading t)
12202 (if (looking-at org-priority-regexp)
12203 (setq current (string-to-char (match-string 2))
12204 have t)
12205 (setq current org-default-priority))
12206 (cond
12207 ((eq action 'remove)
12208 (setq remove t new ?\ ))
12209 ((or (eq action 'set)
12210 (if (featurep 'xemacs) (characterp action) (integerp action)))
12211 (if (not (eq action 'set))
12212 (setq new action)
12213 (message "Priority %c-%c, SPC to remove: "
12214 org-highest-priority org-lowest-priority)
12215 (save-match-data
12216 (setq new (read-char-exclusive))))
12217 (if (and (= (upcase org-highest-priority) org-highest-priority)
12218 (= (upcase org-lowest-priority) org-lowest-priority))
12219 (setq new (upcase new)))
12220 (cond ((equal new ?\ ) (setq remove t))
12221 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12222 (error "Priority must be between `%c' and `%c'"
12223 org-highest-priority org-lowest-priority))))
12224 ((eq action 'up)
12225 (if (and (not have) (eq last-command this-command))
12226 (setq new org-lowest-priority)
12227 (setq new (if (and org-priority-start-cycle-with-default (not have))
12228 org-default-priority (1- current)))))
12229 ((eq action 'down)
12230 (if (and (not have) (eq last-command this-command))
12231 (setq new org-highest-priority)
12232 (setq new (if (and org-priority-start-cycle-with-default (not have))
12233 org-default-priority (1+ current)))))
12234 (t (error "Invalid action")))
12235 (if (or (< (upcase new) org-highest-priority)
12236 (> (upcase new) org-lowest-priority))
12237 (setq remove t))
12238 (setq news (format "%c" new))
12239 (if have
12240 (if remove
12241 (replace-match "" t t nil 1)
12242 (replace-match news t t nil 2))
12243 (if remove
12244 (error "No priority cookie found in line")
12245 (let ((case-fold-search nil))
12246 (looking-at org-todo-line-regexp))
12247 (if (match-end 2)
12248 (progn
12249 (goto-char (match-end 2))
12250 (insert " [#" news "]"))
12251 (goto-char (match-beginning 3))
12252 (insert "[#" news "] "))))
12253 (org-preserve-lc (org-set-tags nil 'align)))
12254 (if remove
12255 (message "Priority removed")
12256 (message "Priority of current item set to %s" news))))
12258 (defun org-get-priority (s)
12259 "Find priority cookie and return priority."
12260 (if (functionp org-get-priority-function)
12261 (funcall org-get-priority-function)
12262 (save-match-data
12263 (if (not (string-match org-priority-regexp s))
12264 (* 1000 (- org-lowest-priority org-default-priority))
12265 (* 1000 (- org-lowest-priority
12266 (string-to-char (match-string 2 s))))))))
12268 ;;;; Tags
12270 (defvar org-agenda-archives-mode)
12271 (defvar org-map-continue-from nil
12272 "Position from where mapping should continue.
12273 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12275 (defvar org-scanner-tags nil
12276 "The current tag list while the tags scanner is running.")
12277 (defvar org-trust-scanner-tags nil
12278 "Should `org-get-tags-at' use the tags for the scanner.
12279 This is for internal dynamical scoping only.
12280 When this is non-nil, the function `org-get-tags-at' will return the value
12281 of `org-scanner-tags' instead of building the list by itself. This
12282 can lead to large speed-ups when the tags scanner is used in a file with
12283 many entries, and when the list of tags is retrieved, for example to
12284 obtain a list of properties. Building the tags list for each entry in such
12285 a file becomes an N^2 operation - but with this variable set, it scales
12286 as N.")
12288 (defun org-scan-tags (action matcher &optional todo-only)
12289 "Scan headline tags with inheritance and produce output ACTION.
12291 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12292 or `agenda' to produce an entry list for an agenda view. It can also be
12293 a Lisp form or a function that should be called at each matched headline, in
12294 this case the return value is a list of all return values from these calls.
12296 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12297 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12298 only lines with a TODO keyword are included in the output."
12299 (require 'org-agenda)
12302 (org-re
12304 (props (list 'face 'default
12305 'done-face 'org-agenda-done
12306 'undone-face 'default
12307 'mouse-face 'highlight
12308 'org-not-done-regexp org-not-done-regexp
12309 'org-todo-regexp org-todo-regexp
12310 'help-echo
12311 (format "mouse-2 or RET jump to org file %s"
12312 (abbreviate-file-name
12313 (or (buffer-file-name (buffer-base-buffer))
12314 (buffer-name (buffer-base-buffer)))))))
12315 (case-fold-search nil)
12316 (org-map-continue-from nil)
12317 lspos tags tags-list
12318 (tags-alist (list (cons 0 org-file-tags)))
12319 (llast 0) rtn rtn1 level category i txt
12320 todo marker entry priority)
12321 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12322 (setq action (list 'lambda nil action)))
12323 (save-excursion
12324 (goto-char (point-min))
12325 (when (eq action 'sparse-tree)
12326 (org-overview)
12327 (org-remove-occur-highlights))
12328 (while (re-search-forward re nil t)
12329 (catch :skip
12330 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12331 tags (if (match-end 4) (org-match-string-no-properties 4)))
12332 (goto-char (setq lspos (match-beginning 0)))
12333 (setq level (org-reduced-level (funcall outline-level))
12334 category (org-get-category))
12335 (setq i llast llast level)
12336 ;; remove tag lists from same and sublevels
12337 (while (>= i level)
12338 (when (setq entry (assoc i tags-alist))
12339 (setq tags-alist (delete entry tags-alist)))
12340 (setq i (1- i)))
12341 ;; add the next tags
12342 (when tags
12343 (setq tags (org-split-string tags ":")
12344 tags-alist
12345 (cons (cons level tags) tags-alist)))
12346 ;; compile tags for current headline
12347 (setq tags-list
12348 (if org-use-tag-inheritance
12349 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12350 tags)
12351 org-scanner-tags tags-list)
12352 (when org-use-tag-inheritance
12353 (setcdr (car tags-alist)
12354 (mapcar (lambda (x)
12355 (setq x (copy-sequence x))
12356 (org-add-prop-inherited x))
12357 (cdar tags-alist))))
12358 (when (and tags org-use-tag-inheritance
12359 (or (not (eq t org-use-tag-inheritance))
12360 org-tags-exclude-from-inheritance))
12361 ;; selective inheritance, remove uninherited ones
12362 (setcdr (car tags-alist)
12363 (org-remove-uniherited-tags (cdar tags-alist))))
12364 (when (and (or (not todo-only)
12365 (and (member todo org-not-done-keywords)
12366 (or (not org-agenda-tags-todo-honor-ignore-options)
12367 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12368 (let ((case-fold-search t)) (eval matcher))
12369 (or
12370 (not (member org-archive-tag tags-list))
12371 ;; we have an archive tag, should we use this anyway?
12372 (or (not org-agenda-skip-archived-trees)
12373 (and (eq action 'agenda) org-agenda-archives-mode))))
12374 (unless (eq action 'sparse-tree) (org-agenda-skip))
12376 ;; select this headline
12378 (cond
12379 ((eq action 'sparse-tree)
12380 (and org-highlight-sparse-tree-matches
12381 (org-get-heading) (match-end 0)
12382 (org-highlight-new-match
12383 (match-beginning 0) (match-beginning 1)))
12384 (org-show-context 'tags-tree))
12385 ((eq action 'agenda)
12386 (setq txt (org-format-agenda-item
12387 ""
12388 (concat
12389 (if (eq org-tags-match-list-sublevels 'indented)
12390 (make-string (1- level) ?.) "")
12391 (org-get-heading))
12392 category
12393 tags-list
12394 )
12395 priority (org-get-priority txt))
12396 (goto-char lspos)
12397 (setq marker (org-agenda-new-marker))
12398 (org-add-props txt props
12399 'org-marker marker 'org-hd-marker marker 'org-category category
12400 'todo-state todo
12401 'priority priority 'type "tagsmatch")
12402 (push txt rtn))
12403 ((functionp action)
12404 (setq org-map-continue-from nil)
12405 (save-excursion
12406 (setq rtn1 (funcall action))
12407 (push rtn1 rtn)))
12408 (t (error "Invalid action")))
12410 ;; if we are to skip sublevels, jump to end of subtree
12411 (unless org-tags-match-list-sublevels
12412 (org-end-of-subtree t)
12413 (backward-char 1))))
12414 ;; Get the correct position from where to continue
12415 (if org-map-continue-from
12416 (goto-char org-map-continue-from)
12417 (and (= (point) lspos) (end-of-line 1)))))
12418 (when (and (eq action 'sparse-tree)
12419 (not org-sparse-tree-open-archived-trees))
12420 (org-hide-archived-subtrees (point-min) (point-max)))
12421 (nreverse rtn)))
12423 (defun org-remove-uniherited-tags (tags)
12424 "Remove all tags that are not inherited from the list TAGS."
12425 (cond
12426 ((eq org-use-tag-inheritance t)
12427 (if org-tags-exclude-from-inheritance
12428 (org-delete-all org-tags-exclude-from-inheritance tags)
12429 tags))
12430 ((not org-use-tag-inheritance) nil)
12431 ((stringp org-use-tag-inheritance)
12432 (delq nil (mapcar
12433 (lambda (x)
12434 (if (and (string-match org-use-tag-inheritance x)
12435 (not (member x org-tags-exclude-from-inheritance)))
12436 x nil))
12437 tags)))
12438 ((listp org-use-tag-inheritance)
12439 (delq nil (mapcar
12440 (lambda (x)
12441 (if (member x org-use-tag-inheritance) x nil))
12442 tags)))))
12444 (defvar todo-only) ;; dynamically scoped
12446 (defun org-match-sparse-tree (&optional todo-only match)
12447 "Create a sparse tree according to tags string MATCH.
12448 MATCH can contain positive and negative selection of tags, like
12450 If optional argument TODO-ONLY is non-nil, only select lines that are
12451 also TODO lines."
12452 (interactive "P")
12453 (org-prepare-agenda-buffers (list (current-buffer)))
12454 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12456 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12458 (defvar org-cached-props nil)
12459 (defun org-cached-entry-get (pom property)
12460 (if (or (eq t org-use-property-inheritance)
12461 (and (stringp org-use-property-inheritance)
12462 (string-match org-use-property-inheritance property))
12463 (and (listp org-use-property-inheritance)
12464 (member property org-use-property-inheritance)))
12465 ;; Caching is not possible, check it directly
12466 (org-entry-get pom property 'inherit)
12467 ;; Get all properties, so that we can do complicated checks easily
12468 (cdr (assoc property (or org-cached-props
12469 (setq org-cached-props
12470 (org-entry-properties pom)))))))
12472 (defun org-global-tags-completion-table (&optional files)
12473 "Return the list of all tags in all agenda buffer/files.
12474 Optional FILES argument is a list of files to which can be used
12475 instead of the agenda files."
12476 (save-excursion
12477 (org-uniquify
12478 (delq nil
12479 (apply 'append
12480 (mapcar
12481 (lambda (file)
12482 (set-buffer (find-file-noselect file))
12483 (append (org-get-buffer-tags)
12484 (mapcar (lambda (x) (if (stringp (car-safe x))
12485 (list (car-safe x)) nil))
12486 org-tag-alist)))
12487 (if (and files (car files))
12488 files
12489 (org-agenda-files))))))))
12491 (defun org-make-tags-matcher (match)
12492 "Create the TAGS//TODO matcher form for the selection string MATCH."
12493 ;; todo-only is scoped dynamically into this function, and the function
12494 ;; may change it if the matcher asks for it.
12495 (unless match
12496 ;; Get a new match request, with completion
12497 (let ((org-last-tags-completion-table
12498 (org-global-tags-completion-table)))
12499 (setq match (org-completing-read-no-i
12500 "Match: " 'org-tags-completion-function nil nil nil
12501 'org-tags-history))))
12503 ;; Parse the string and create a lisp form
12504 (let ((match0 match)
12505 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12506 minus tag mm
12507 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12508 orterms term orlist re-p str-p level-p level-op time-p
12509 prop-p pn pv po gv rest)
12510 (if (string-match "/+" match)
12511 ;; match contains also a todo-matching request
12512 (progn
12513 (setq tagsmatch (substring match 0 (match-beginning 0))
12514 todomatch (substring match (match-end 0)))
12515 (if (string-match "^!" todomatch)
12516 (setq todo-only t todomatch (substring todomatch 1)))
12518 (setq todomatch nil)))
12519 ;; only matching tags
12520 (setq tagsmatch match todomatch nil))
12522 ;; Make the tags matcher
12524 (setq tagsmatcher t)
12525 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12526 (while (setq term (pop orterms))
12528 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12529 (while (string-match re term)
12530 (setq rest (substring term (match-end 0))
12531 minus (and (match-end 1)
12532 (equal (match-string 1 term) "-"))
12533 tag (save-match-data (replace-regexp-in-string
12535 (match-string 2 term)))
12536 re-p (equal (string-to-char tag) ?{)
12537 level-p (match-end 4)
12538 prop-p (match-end 5)
12539 mm (cond
12540 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12541 (level-p
12542 (setq level-op (org-op-to-function (match-string 3 term)))
12543 `(,level-op level ,(string-to-number
12544 (match-string 4 term))))
12545 (prop-p
12546 (setq pn (match-string 5 term)
12547 po (match-string 6 term)
12548 pv (match-string 7 term)
12549 re-p (equal (string-to-char pv) ?{)
12551 time-p (save-match-data
12553 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12554 (if time-p (setq pv (org-matcher-time pv)))
12555 (setq po (org-op-to-function po (if time-p 'time str-p)))
12556 (cond
12557 ((equal pn "CATEGORY")
12558 (setq gv '(get-text-property (point) 'org-category)))
12559 ((equal pn "TODO")
12560 (setq gv 'todo))
12561 (t
12562 (setq gv `(org-cached-entry-get nil ,pn))))
12563 (if re-p
12564 (if (eq po 'org<>)
12565 `(not (string-match ,pv (or ,gv "")))
12566 `(string-match ,pv (or ,gv "")))
12567 (if str-p
12568 `(,po (or ,gv "") ,pv)
12569 `(,po (string-to-number (or ,gv ""))
12570 ,(string-to-number pv) ))))
12571 (t `(member ,tag tags-list)))
12572 mm (if minus (list 'not mm) mm)
12573 term rest)
12574 (push mm tagsmatcher))
12575 (push (if (> (length tagsmatcher) 1)
12576 (cons 'and tagsmatcher)
12577 (car tagsmatcher))
12578 orlist)
12579 (setq tagsmatcher nil))
12580 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12581 (setq tagsmatcher
12582 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12583 ;; Make the todo matcher
12585 (setq todomatcher t)
12586 (setq orterms (org-split-string todomatch "|") orlist nil)
12587 (while (setq term (pop orterms))
12588 (while (string-match re term)
12589 (setq minus (and (match-end 1)
12590 (equal (match-string 1 term) "-"))
12591 kwd (match-string 2 term)
12592 re-p (equal (string-to-char kwd) ?{)
12593 term (substring term (match-end 0))
12594 mm (if re-p
12595 `(string-match ,(substring kwd 1 -1) todo)
12596 (list 'equal 'todo kwd))
12597 mm (if minus (list 'not mm) mm))
12598 (push mm todomatcher))
12599 (push (if (> (length todomatcher) 1)
12600 (cons 'and todomatcher)
12601 (car todomatcher))
12602 orlist)
12603 (setq todomatcher nil))
12604 (setq todomatcher (if (> (length orlist) 1)
12605 (cons 'or orlist) (car orlist))))
12607 ;; Return the string and lisp forms of the matcher
12608 (setq matcher (if todomatcher
12609 (list 'and tagsmatcher todomatcher)
12610 tagsmatcher))
12611 (cons match0 matcher)))
12613 (defun org-op-to-function (op &optional stringp)
12614 "Turn an operator into the appropriate function."
12615 (setq op
12616 (cond
12617 ((equal op "<" ) '(< string< org-time<))
12618 ((equal op ">" ) '(> org-string> org-time>))
12619 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12620 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12621 ((member op '("=" "==")) '(= string= org-time=))
12622 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12623 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12625 (defun org<> (a b) (not (= a b)))
12626 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12627 (defun org-string>= (a b) (not (string< a b)))
12628 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12629 (defun org-string<> (a b) (not (string= a b)))
12630 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12631 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12632 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12633 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12634 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12635 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12636 (defun org-2ft (s)
12637 "Convert S to a floating point time.
12638 If S is already a number, just return it. If it is a string, parse
12639 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12640 (cond
12641 ((numberp s) s)
12642 ((stringp s)
12643 (condition-case nil
12644 (float-time (apply 'encode-time (org-parse-time-string s)))
12645 (error 0.)))
12646 (t 0.)))
12648 (defun org-time-today ()
12649 "Time in seconds today at 0:00.
12650 Returns the float number of seconds since the beginning of the
12651 epoch to the beginning of today (00:00)."
12652 (float-time (apply 'encode-time
12653 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12655 (defun org-matcher-time (s)
12656 "Interpret a time comparison value."
12657 (save-match-data
12658 (cond
12659 ((string= s "<now>") (float-time))
12660 ((string= s "<today>") (org-time-today))
12661 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12662 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12664 (+ (org-time-today)
12665 (* (string-to-number (match-string 1 s))
12666 (cdr (assoc (match-string 2 s)
12667 '(("d" . 86400.0) ("w" . 604800.0)
12668 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12669 (t (org-2ft s)))))
12671 (defun org-match-any-p (re list)
12672 "Does re match any element of list?"
12673 (setq list (mapcar (lambda (x) (string-match re x)) list))
12674 (delq nil list))
12676 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12677 (defvar org-tags-overlay (make-overlay 1 1))
12678 (org-detach-overlay org-tags-overlay)
12680 (defun org-get-local-tags-at (&optional pos)
12681 "Get a list of tags defined in the current headline."
12682 (org-get-tags-at pos 'local))
12684 (defun org-get-local-tags ()
12685 "Get a list of tags defined in the current headline."
12686 (org-get-tags-at nil 'local))
12688 (defun org-get-tags-at (&optional pos local)
12689 "Get a list of all headline tags applicable at POS.
12690 POS defaults to point. If tags are inherited, the list contains
12691 the targets in the same sequence as the headlines appear, i.e.
12692 the tags of the current headline come last.
12693 When LOCAL is non-nil, only return tags from the current headline,
12694 ignore inherited ones."
12695 (interactive)
12696 (if (and org-trust-scanner-tags
12697 (or (not pos) (equal pos (point)))
12698 (not local))
12699 org-scanner-tags
12700 (let (tags ltags lastpos parent)
12701 (save-excursion
12702 (save-restriction
12703 (widen)
12704 (goto-char (or pos (point)))
12705 (save-match-data
12706 (catch 'done
12707 (condition-case nil
12708 (progn
12709 (org-back-to-heading t)
12710 (while (not (equal lastpos (point)))
12711 (setq lastpos (point))
12712 (when (looking-at
12714 (setq ltags (org-split-string
12715 (org-match-string-no-properties 1) ":"))
12716 (when parent
12717 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12718 (setq tags (append
12719 (if parent
12720 (org-remove-uniherited-tags ltags)
12721 ltags)
12722 tags)))
12723 (or org-use-tag-inheritance (throw 'done t))
12724 (if local (throw 'done t))
12725 (or (org-up-heading-safe) (error nil))
12726 (setq parent t)))
12727 (error nil)))))
12728 (append (org-remove-uniherited-tags org-file-tags) tags)))))
12730 (defun org-add-prop-inherited (s)
12731 (add-text-properties 0 (length s) '(inherited t) s)
12732 s)
12734 (defun org-toggle-tag (tag &optional onoff)
12735 "Toggle the tag TAG for the current line.
12736 If ONOFF is `on' or `off', don't toggle but set to this state."
12737 (let (res current)
12738 (save-excursion
12739 (org-back-to-heading t)
12741 (point-at-eol) t)
12742 (progn
12743 (setq current (match-string 1))
12744 (replace-match ""))
12745 (setq current ""))
12746 (setq current (nreverse (org-split-string current ":")))
12747 (cond
12748 ((eq onoff 'on)
12749 (setq res t)
12750 (or (member tag current) (push tag current)))
12751 ((eq onoff 'off)
12752 (or (not (member tag current)) (setq current (delete tag current))))
12753 (t (if (member tag current)
12754 (setq current (delete tag current))
12755 (setq res t)
12756 (push tag current))))
12757 (end-of-line 1)
12758 (if current
12759 (progn
12760 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12761 (org-set-tags nil t))
12762 (delete-horizontal-space))
12763 (run-hooks 'org-after-tags-change-hook))
12764 res))
12766 (defun org-align-tags-here (to-col)
12767 ;; Assumes that this is a headline
12768 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12769 (beginning-of-line 1)
12771 (< pos (match-beginning 2)))
12772 (progn
12773 (setq tags-l (- (match-end 2) (match-beginning 2)))
12774 (goto-char (match-beginning 1))
12775 (insert " ")
12776 (delete-region (point) (1+ (match-beginning 2)))
12777 (setq ncol (max (1+ (current-column))
12778 (1+ col)
12779 (if (> to-col 0)
12780 to-col
12781 (- (abs to-col) tags-l))))
12782 (setq p (point))
12783 (insert (make-string (- ncol (current-column)) ?\ ))
12784 (setq ncol (current-column))
12785 (when indent-tabs-mode (tabify p (point-at-eol)))
12786 (org-move-to-column (min ncol col) t))
12787 (goto-char pos))))
12789 (defun org-set-tags-command (&optional arg just-align)
12790 "Call the set-tags command for the current entry."
12791 (interactive "P")
12792 (if (org-on-heading-p)
12793 (org-set-tags arg just-align)
12794 (save-excursion
12795 (org-back-to-heading t)
12796 (org-set-tags arg just-align))))
12798 (defun org-set-tags-to (data)
12799 "Set the tags of the current entry to DATA, replacing the current tags.
12800 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12801 If DATA is nil or the empty string, any tags will be removed."
12802 (interactive "sTags: ")
12803 (setq data
12804 (cond
12805 ((eq data nil) "")
12806 ((equal data "") "")
12807 ((stringp data)
12808 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12809 ":"))
12810 ((listp data)
12811 (concat ":" (mapconcat 'identity data ":") ":"))
12812 (t nil)))
12813 (when data
12814 (save-excursion
12815 (org-back-to-heading t)
12816 (when (looking-at org-complex-heading-regexp)
12817 (if (match-end 5)
12818 (progn
12819 (goto-char (match-beginning 5))
12820 (insert data)
12821 (delete-region (point) (point-at-eol))
12822 (org-set-tags nil 'align))
12823 (goto-char (point-at-eol))
12824 (insert " " data)
12825 (org-set-tags nil 'align)))
12826 (beginning-of-line 1)
12828 (delete-region (match-beginning 1) (match-end 1))))))
12830 (defun org-align-all-tags ()
12831 "Align the tags i all headings."
12832 (interactive)
12833 (save-excursion
12834 (or (ignore-errors (org-back-to-heading t))
12835 (outline-next-heading))
12836 (if (org-on-heading-p)
12837 (org-set-tags t)
12838 (message "No headings"))))
12840 (defvar org-indent-indentation-per-level)
12841 (defun org-set-tags (&optional arg just-align)
12842 "Set the tags for the current headline.
12843 With prefix ARG, realign all tags in headings in the current buffer."
12844 (interactive "P")
12845 (let* ((re (concat "^" outline-regexp))
12846 (current (org-get-tags-string))
12847 (col (current-column))
12848 (org-setting-tags t)
12849 table current-tags inherited-tags ; computed below when needed
12850 tags p0 c0 c1 rpl di tc level)
12851 (if arg
12852 (save-excursion
12853 (goto-char (point-min))
12854 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12855 (while (re-search-forward re nil t)
12856 (org-set-tags nil t)
12857 (end-of-line 1)))
12858 (message "All tags realigned to column %d" org-tags-column))
12859 (if just-align
12860 (setq tags current)
12861 ;; Get a new set of tags from the user
12862 (save-excursion
12863 (setq table (append org-tag-persistent-alist
12864 (or org-tag-alist (org-get-buffer-tags))
12865 (and
12866 org-complete-tags-always-offer-all-agenda-tags
12867 (org-global-tags-completion-table
12868 (org-agenda-files))))
12869 org-last-tags-completion-table table
12870 current-tags (org-split-string current ":")
12871 inherited-tags (nreverse
12872 (nthcdr (length current-tags)
12873 (nreverse (org-get-tags-at))))
12874 tags
12875 (if (or (eq t org-use-fast-tag-selection)
12876 (and org-use-fast-tag-selection
12877 (delq nil (mapcar 'cdr table))))
12878 (org-fast-tag-selection
12879 current-tags inherited-tags table
12880 (if org-fast-tag-selection-include-todo
12881 org-todo-key-alist))
12882 (let ((org-add-colon-after-tag-completion t))
12883 (org-trim
12884 (org-without-partial-completion
12885 (org-icompleting-read "Tags: "
12886 'org-tags-completion-function
12887 nil nil current 'org-tags-history)))))))
12888 (while (string-match "[-+&]+" tags)
12889 ;; No boolean logic, just a list
12890 (setq tags (replace-match ":" t t tags))))
12892 (setq tags (replace-regexp-in-string "[,]" ":" tags))
12894 (if org-tags-sort-function
12895 (setq tags (mapconcat 'identity
12896 (sort (org-split-string
12897 tags (org-re "[^[:alnum:]_@#%]+"))
12898 org-tags-sort-function) ":")))
12901 (setq tags "")
12902 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12903 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12905 ;; Insert new tags at the correct column
12906 (beginning-of-line 1)
12907 (setq level (or (and (looking-at org-outline-regexp)
12908 (- (match-end 0) (point) 1))
12909 1))
12910 (cond
12911 ((and (equal current "") (equal tags "")))
12912 ((re-search-forward
12914 (point-at-eol) t)
12915 (if (equal tags "")
12916 (setq rpl "")
12917 (goto-char (match-beginning 0))
12918 (setq c0 (current-column)
12919 ;; compute offset for the case of org-indent-mode active
12920 di (if org-indent-mode
12921 (* (1- org-indent-indentation-per-level) (1- level))
12922 0)
12923 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
12924 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
12925 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
12926 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12927 (replace-match rpl t t)
12928 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
12929 tags)
12930 (t (error "Tags alignment failed")))
12931 (org-move-to-column col)
12932 (unless just-align
12933 (run-hooks 'org-after-tags-change-hook)))))
12935 (defun org-change-tag-in-region (beg end tag off)
12936 "Add or remove TAG for each entry in the region.
12937 This works in the agenda, and also in an org-mode buffer."
12938 (interactive
12939 (list (region-beginning) (region-end)
12940 (let ((org-last-tags-completion-table
12941 (if (org-mode-p)
12942 (org-get-buffer-tags)
12943 (org-global-tags-completion-table))))
12944 (org-icompleting-read
12945 "Tag: " 'org-tags-completion-function nil nil nil
12946 'org-tags-history))
12947 (progn
12949 (equal (read-char-exclusive) ?r))))
12950 (if (fboundp 'deactivate-mark) (deactivate-mark))
12951 (let ((agendap (equal major-mode 'org-agenda-mode))
12952 l1 l2 m buf pos newhead (cnt 0))
12953 (goto-char end)
12954 (setq l2 (1- (org-current-line)))
12955 (goto-char beg)
12956 (setq l1 (org-current-line))
12957 (loop for l from l1 to l2 do
12958 (org-goto-line l)
12959 (setq m (get-text-property (point) 'org-hd-marker))
12960 (when (or (and (org-mode-p) (org-on-heading-p))
12961 (and agendap m))
12962 (setq buf (if agendap (marker-buffer m) (current-buffer))
12963 pos (if agendap m (point)))
12964 (with-current-buffer buf
12965 (save-excursion
12966 (save-restriction
12967 (goto-char pos)
12968 (setq cnt (1+ cnt))
12969 (org-toggle-tag tag (if off 'off 'on))
12970 (setq newhead (org-get-heading)))))
12971 (and agendap (org-agenda-change-all-lines newhead m))))
12972 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
12974 (defun org-tags-completion-function (string predicate &optional flag)
12975 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12976 (confirm (lambda (x) (stringp (car x)))))
12978 (setq s1 (match-string 1 string)
12979 s2 (match-string 2 string))
12980 (setq s1 "" s2 string))
12981 (cond
12982 ((eq flag nil)
12983 ;; try completion
12984 (setq rtn (try-completion s2 ctable confirm))
12985 (if (stringp rtn)
12986 (setq rtn
12987 (concat s1 s2 (substring rtn (length s2))
12988 (if (and org-add-colon-after-tag-completion
12989 (assoc rtn ctable))
12990 ":" ""))))
12991 rtn)
12992 ((eq flag t)
12993 ;; all-completions
12994 (all-completions s2 ctable confirm)
12995 )
12996 ((eq flag 'lambda)
12997 ;; exact match?
12998 (assoc s2 ctable)))
12999 ))
13001 (defun org-fast-tag-insert (kwd tags face &optional end)
13002 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13003 (insert (format "%-12s" (concat kwd ":"))
13004 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13005 (or end "")))
13007 (defun org-fast-tag-show-exit (flag)
13008 (save-excursion
13009 (org-goto-line 3)
13011 (replace-match ""))
13012 (when flag
13013 (end-of-line 1)
13014 (org-move-to-column (- (window-width) 19) t)
13015 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13017 (defun org-set-current-tags-overlay (current prefix)
13018 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13019 (if (featurep 'xemacs)
13020 (org-overlay-display org-tags-overlay (concat prefix s)
13021 'secondary-selection)
13022 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13023 (org-overlay-display org-tags-overlay (concat prefix s)))))
13025 (defvar org-last-tag-selection-key nil)
13026 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13027 "Fast tag selection with single keys.
13028 CURRENT is the current list of tags in the headline, INHERITED is the
13029 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13030 possibly with grouping information. TODO-TABLE is a similar table with
13031 TODO keywords, should these have keys assigned to them.
13032 If the keys are nil, a-z are automatically assigned.
13033 Returns the new tags string, or nil to not change the current settings."
13034 (let* ((fulltable (append table todo-table))
13035 (maxlen (apply 'max (mapcar
13036 (lambda (x)
13037 (if (stringp (car x)) (string-width (car x)) 0))
13038 fulltable)))
13039 (buf (current-buffer))
13040 (expert (eq org-fast-tag-selection-single-key 'expert))
13041 (buffer-tags nil)
13042 (fwidth (+ maxlen 3 1 3))
13043 (ncol (/ (- (window-width) 4) fwidth))
13044 (i-face 'org-done)
13045 (c-face 'org-todo)
13046 tg cnt e c char c1 c2 ntable tbl rtn
13047 ov-start ov-end ov-prefix
13048 (exit-after-next org-fast-tag-selection-single-key)
13049 (done-keywords org-done-keywords)
13050 groups ingroup)
13051 (save-excursion
13052 (beginning-of-line 1)
13053 (if (looking-at
13055 (setq ov-start (match-beginning 1)
13056 ov-end (match-end 1)
13057 ov-prefix "")
13058 (setq ov-start (1- (point-at-eol))
13059 ov-end (1+ ov-start))
13061 (setq ov-prefix
13062 (concat
13063 (buffer-substring (1- (point)) (point))
13064 (if (> (current-column) org-tags-column)
13065 " "
13066 (make-string (- org-tags-column (current-column)) ?\ ))))))
13067 (move-overlay org-tags-overlay ov-start ov-end)
13068 (save-window-excursion
13069 (if expert
13070 (set-buffer (get-buffer-create " *Org tags*"))
13071 (delete-other-windows)
13072 (split-window-vertically)
13073 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13074 (erase-buffer)
13075 (org-set-local 'org-done-keywords done-keywords)
13078 (org-fast-tag-show-exit exit-after-next)
13079 (org-set-current-tags-overlay current ov-prefix)
13080 (setq tbl fulltable char ?a cnt 0)
13081 (while (setq e (pop tbl))
13082 (cond
13083 ((equal (car e) :startgroup)
13084 (push '() groups) (setq ingroup t)
13085 (when (not (= cnt 0))
13086 (setq cnt 0)
13088 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13089 ((equal (car e) :endgroup)
13090 (setq ingroup nil cnt 0)
13092 ((equal e '(:newline))
13093 (when (not (= cnt 0))
13094 (setq cnt 0)
13096 (setq e (car tbl))
13097 (while (equal (car tbl) '(:newline))
13099 (setq tbl (cdr tbl)))))
13100 (t
13101 (setq tg (copy-sequence (car e)) c2 nil)
13102 (if (cdr e)
13103 (setq c (cdr e))
13104 ;; automatically assign a character.
13105 (setq c1 (string-to-char
13106 (downcase (substring
13107 tg (if (= (string-to-char tg) ?@) 1 0)))))
13108 (if (or (rassoc c1 ntable) (rassoc c1 table))
13109 (while (or (rassoc char ntable) (rassoc char table))
13110 (setq char (1+ char)))
13111 (setq c2 c1))
13112 (setq c (or c2 char)))
13113 (if ingroup (push tg (car groups)))
13114 (setq tg (org-add-props tg nil 'face
13115 (cond
13116 ((not (assoc tg table))
13117 (org-get-todo-face tg))
13118 ((member tg current) c-face)
13119 ((member tg inherited) i-face)
13120 (t nil))))
13121 (if (and (= cnt 0) (not ingroup)) (insert " "))
13122 (insert "[" c "] " tg (make-string
13123 (- fwidth 4 (length tg)) ?\ ))
13124 (push (cons tg c) ntable)
13125 (when (= (setq cnt (1+ cnt)) ncol)
13127 (if ingroup (insert " "))
13128 (setq cnt 0)))))
13129 (setq ntable (nreverse ntable))
13131 (goto-char (point-min))
13132 (if (not expert) (org-fit-window-to-buffer))
13133 (setq rtn
13134 (catch 'exit
13135 (while t
13136 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13137 (if (not groups) "no " "")
13138 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13139 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13140 (setq org-last-tag-selection-key c)
13141 (cond
13143 ((= c ?!)
13144 (setq groups (not groups))
13145 (goto-char (point-min))
13146 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13147 ((= c ?\C-c)
13148 (if (not expert)
13149 (org-fast-tag-show-exit
13150 (setq exit-after-next (not exit-after-next)))
13151 (setq expert nil)
13152 (delete-other-windows)
13153 (set-window-buffer (split-window-vertically) " *Org tags*")
13154 (org-switch-to-buffer-other-window " *Org tags*")
13155 (org-fit-window-to-buffer)))
13156 ((or (= c ?\C-g)
13157 (and (= c ?q) (not (rassoc c ntable))))
13158 (org-detach-overlay org-tags-overlay)
13159 (setq quit-flag t))
13160 ((= c ?\ )
13161 (setq current nil)
13162 (if exit-after-next (setq exit-after-next 'now)))
13164 (condition-case nil
13165 (setq tg (org-icompleting-read
13166 "Tag: "
13167 (or buffer-tags
13168 (with-current-buffer buf
13169 (org-get-buffer-tags)))))
13170 (quit (setq tg "")))
13172 (add-to-list 'buffer-tags (list tg))
13173 (if (member tg current)
13174 (setq current (delete tg current))
13175 (push tg current)))
13176 (if exit-after-next (setq exit-after-next 'now)))
13177 ((setq e (rassoc c todo-table) tg (car e))
13178 (with-current-buffer buf
13179 (save-excursion (org-todo tg)))
13180 (if exit-after-next (setq exit-after-next 'now)))
13181 ((setq e (rassoc c ntable) tg (car e))
13182 (if (member tg current)
13183 (setq current (delete tg current))
13184 (loop for g in groups do
13185 (if (member tg g)
13186 (mapc (lambda (x)
13187 (setq current (delete x current)))
13188 g)))
13189 (push tg current))
13190 (if exit-after-next (setq exit-after-next 'now))))
13192 ;; Create a sorted list
13193 (setq current
13194 (sort current
13195 (lambda (a b)
13196 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13197 (if (eq exit-after-next 'now) (throw 'exit t))
13198 (goto-char (point-min))
13199 (beginning-of-line 2)
13200 (delete-region (point) (point-at-eol))
13201 (org-fast-tag-insert "Current" current c-face)
13202 (org-set-current-tags-overlay current ov-prefix)
13203 (while (re-search-forward
13205 (setq tg (match-string 1))
13206 (add-text-properties
13207 (match-beginning 1) (match-end 1)
13208 (list 'face
13209 (cond
13210 ((member tg current) c-face)
13211 ((member tg inherited) i-face)
13212 (t (get-text-property (match-beginning 1) 'face))))))
13213 (goto-char (point-min)))))
13214 (org-detach-overlay org-tags-overlay)
13215 (if rtn
13216 (mapconcat 'identity current ":")
13217 nil))))
13219 (defun org-get-tags-string ()
13220 "Get the TAGS string in the current headline."
13221 (unless (org-on-heading-p t)
13222 (error "Not on a heading"))
13223 (save-excursion
13224 (beginning-of-line 1)
13226 (org-match-string-no-properties 1)
13227 "")))
13229 (defun org-get-tags ()
13230 "Get the list of tags specified in the current headline."
13231 (org-split-string (org-get-tags-string) ":"))
13233 (defun org-get-buffer-tags ()
13234 "Get a table of all tags used in the buffer, for completion."
13235 (let (tags)
13236 (save-excursion
13237 (goto-char (point-min))
13238 (while (re-search-forward
13240 (when (equal (char-after (point-at-bol 0)) ?*)
13241 (mapc (lambda (x) (add-to-list 'tags x))
13242 (org-split-string (org-match-string-no-properties 1) ":")))))
13243 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13244 (mapcar 'list tags)))
13246 ;;;; The mapping API
13248 ;;;###autoload
13249 (defun org-map-entries (func &optional match scope &rest skip)
13250 "Call FUNC at each headline selected by MATCH in SCOPE.
13252 FUNC is a function or a lisp form. The function will be called without
13253 arguments, with the cursor positioned at the beginning of the headline.
13254 The return values of all calls to the function will be collected and
13255 returned as a list.
13257 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13258 does not need to preserve point. After evaluation, the cursor will be
13259 moved to the end of the line (presumably of the headline of the
13260 processed entry) and search continues from there. Under some
13261 circumstances, this may not produce the wanted results. For example,
13262 if you have removed (e.g. archived) the current (sub)tree it could
13263 mean that the next entry will be skipped entirely. In such cases, you
13264 can specify the position from where search should continue by making
13265 FUNC set the variable `org-map-continue-from' to the desired buffer
13266 position.
13268 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13269 Only headlines that are matched by this query will be considered during
13270 the iteration. When MATCH is nil or t, all headlines will be
13271 visited by the iteration.
13273 SCOPE determines the scope of this command. It can be any of:
13275 nil The current buffer, respecting the restriction if any
13276 tree The subtree started with the entry at point
13277 file The current buffer, without restriction
13278 file-with-archives
13279 The current buffer, and any archives associated with it
13280 agenda All agenda files
13281 agenda-with-archives
13282 All agenda files with any archive files associated with them
13283 \(file1 file2 ...)
13284 If this is a list, all files in the list will be scanned
13286 The remaining args are treated as settings for the skipping facilities of
13287 the scanner. The following items can be given here:
13289 archive skip trees with the archive tag.
13290 comment skip trees with the COMMENT keyword
13291 function or Emacs Lisp form:
13292 will be used as value for `org-agenda-skip-function', so whenever
13293 the function returns t, FUNC will not be called for that
13294 entry and search will continue from the point where the
13295 function leaves it.
13297 If your function needs to retrieve the tags including inherited tags
13298 at the *current* entry, you can use the value of the variable
13299 `org-scanner-tags' which will be much faster than getting the value
13300 with `org-get-tags-at'. If your function gets properties with
13301 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13302 to t around the call to `org-entry-properties' to get the same speedup.
13303 Note that if your function moves around to retrieve tags and properties at
13304 a *different* entry, you cannot use these techniques."
13305 (let* ((org-agenda-archives-mode nil) ; just to make sure
13306 (org-agenda-skip-archived-trees (memq 'archive skip))
13307 (org-agenda-skip-comment-trees (memq 'comment skip))
13308 (org-agenda-skip-function
13309 (car (org-delete-all '(comment archive) skip)))
13310 (org-tags-match-list-sublevels t)
13311 matcher file res
13312 org-todo-keywords-for-agenda
13313 org-done-keywords-for-agenda
13314 org-todo-keyword-alist-for-agenda
13315 org-drawers-for-agenda
13316 org-tag-alist-for-agenda)
13318 (cond
13319 ((eq match t) (setq matcher t))
13320 ((eq match nil) (setq matcher t))
13321 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13323 (save-excursion
13324 (save-restriction
13325 (when (eq scope 'tree)
13326 (org-back-to-heading t)
13327 (org-narrow-to-subtree)
13328 (setq scope nil))
13330 (if (not scope)
13331 (progn
13332 (org-prepare-agenda-buffers
13333 (list (buffer-file-name (current-buffer))))
13334 (setq res (org-scan-tags func matcher)))
13335 ;; Get the right scope
13336 (cond
13337 ((and scope (listp scope) (symbolp (car scope)))
13338 (setq scope (eval scope)))
13339 ((eq scope 'agenda)
13340 (setq scope (org-agenda-files t)))
13341 ((eq scope 'agenda-with-archives)
13342 (setq scope (org-agenda-files t))
13343 (setq scope (org-add-archive-files scope)))
13344 ((eq scope 'file)
13345 (setq scope (list (buffer-file-name))))
13346 ((eq scope 'file-with-archives)
13347 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13348 (org-prepare-agenda-buffers scope)
13349 (while (setq file (pop scope))
13350 (with-current-buffer (org-find-base-buffer-visiting file)
13351 (save-excursion
13352 (save-restriction
13353 (widen)
13354 (goto-char (point-min))
13355 (setq res (append res (org-scan-tags func matcher))))))))))
13356 res))
13358 ;;;; Properties
13360 ;;; Setting and retrieving properties
13362 (defconst org-special-properties
13363 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13364 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE")
13365 "The special properties valid in Org-mode.
13367 These are properties that are not defined in the property drawer,
13368 but in some other way.")
13370 (defconst org-default-properties
13371 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13372 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13373 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13374 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13375 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13376 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13377 "Some properties that are used by Org-mode for various purposes.
13378 Being in this list makes sure that they are offered for completion.")
13381 "Regular expression matching the first line of a property drawer.")
13384 "Regular expression matching the last line of a property drawer.")
13387 "Regular expression matching the first line of a property drawer.")
13390 "Regular expression matching the first line of a property drawer.")
13392 (defconst org-property-drawer-re
13395 "Matches an entire property drawer.")
13397 (defconst org-clock-drawer-re
13400 "Matches an entire clock drawer.")
13402 (defun org-property-action ()
13403 "Do an action on properties."
13404 (interactive)
13405 (let (c)
13406 (org-at-property-p)
13407 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13408 (setq c (read-char-exclusive))
13409 (cond
13410 ((equal c ?s)
13411 (call-interactively 'org-set-property))
13412 ((equal c ?d)
13413 (call-interactively 'org-delete-property))
13414 ((equal c ?D)
13415 (call-interactively 'org-delete-property-globally))
13416 ((equal c ?c)
13417 (call-interactively 'org-compute-property-at-point))
13418 (t (error "No such property action %c" c)))))
13420 (defun org-set-effort (&optional value)
13421 "Set the effort property of the current entry.
13422 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13423 allowed value."
13424 (interactive "P")
13425 (if (equal value 0) (setq value 10))
13426 (let* ((completion-ignore-case t)
13427 (prop org-effort-property)
13428 (cur (org-entry-get nil prop))
13429 (allowed (org-property-get-allowed-values nil prop 'table))
13430 (existing (mapcar 'list (org-property-values prop)))
13431 rpl
13432 (val (cond
13433 ((stringp value) value)
13434 ((and allowed (integerp value))
13435 (or (car (nth (1- value) allowed))
13436 (car (org-last allowed))))
13437 (allowed
13438 (message "Select 1-9,0, [RET%s]: %s"
13439 (if cur (concat "=" cur) "")
13440 (mapconcat 'car allowed " "))
13441 (setq rpl (read-char-exclusive))
13443 cur
13444 (setq rpl (- rpl ?0))
13445 (if (equal rpl 0) (setq rpl 10))
13446 (if (and (> rpl 0) (<= rpl (length allowed)))
13447 (car (nth (1- rpl) allowed))
13448 (org-completing-read "Effort: " allowed nil))))
13449 (t
13450 (let (org-completion-use-ido org-completion-use-iswitchb)
13451 (org-completing-read
13453 (concat "[" cur "]") "")
13454 ": ")
13455 existing nil nil "" nil cur))))))
13456 (unless (equal (org-entry-get nil prop) val)
13457 (org-entry-put nil prop val))
13458 (message "%s is now %s" prop val)))
13460 (defun org-at-property-p ()
13461 "Is cursor inside a property drawer?"
13462 (save-excursion
13463 (beginning-of-line 1)
13465 (save-match-data ;; Used by calling procedures
13466 (let ((p (point))
13467 (range (unless (org-before-first-heading-p)
13468 (org-get-property-block))))
13469 (and range (<= (car range) p) (< p (cdr range))))))))
13471 (defun org-get-property-block (&optional beg end force)
13472 "Return the (beg . end) range of the body of the property drawer.
13473 BEG and END can be beginning and end of subtree, if not given
13474 they will be found.
13475 If the drawer does not exist and FORCE is non-nil, create the drawer."
13476 (catch 'exit
13477 (save-excursion
13478 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13479 (end (or end (progn (outline-next-heading) (point)))))
13480 (goto-char beg)
13481 (if (re-search-forward org-property-start-re end t)
13482 (setq beg (1+ (match-end 0)))
13483 (if force
13484 (save-excursion
13485 (org-insert-property-drawer)
13486 (setq end (progn (outline-next-heading) (point))))
13487 (throw 'exit nil))
13488 (goto-char beg)
13489 (if (re-search-forward org-property-start-re end t)
13490 (setq beg (1+ (match-end 0)))))
13491 (if (re-search-forward org-property-end-re end t)
13492 (setq end (match-beginning 0))
13493 (or force (throw 'exit nil))
13494 (goto-char beg)
13495 (setq end beg)
13496 (org-indent-line-function)
13498 (cons beg end)))))
13500 (defun org-entry-properties (&optional pom which specific)
13501 "Get all properties of the entry at point-or-marker POM.
13502 This includes the TODO keyword, the tags, time strings for deadline,
13503 scheduled, and clocking, and any additional properties defined in the
13504 entry. The return value is an alist, keys may occur multiple times
13505 if the property key was used several times.
13506 POM may also be nil, in which case the current entry is used.
13507 If WHICH is nil or `all', get all properties. If WHICH is
13508 `special' or `standard', only get that subclass. If WHICH
13509 is a string only get exactly this property. SPECIFIC can be a string, the
13510 specific property we are interested in. Specifying it can speed
13511 things up because then unnecessary parsing is avoided."
13512 (setq which (or which 'all))
13513 (org-with-point-at pom
13514 (let ((clockstr (substring org-clock-string 0 -1))
13515 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13516 (case-fold-search nil)
13517 beg end range props sum-props key key1 value string clocksum)
13518 (save-excursion
13519 (when (condition-case nil
13520 (and (org-mode-p) (org-back-to-heading t))
13521 (error nil))
13522 (setq beg (point))
13523 (setq sum-props (get-text-property (point) 'org-summaries))
13524 (setq clocksum (get-text-property (point) :org-clock-minutes))
13525 (outline-next-heading)
13526 (setq end (point))
13527 (when (memq which '(all special))
13528 ;; Get the special properties, like TODO and tags
13529 (goto-char beg)
13530 (when (and (or (not specific) (string= specific "TODO"))
13531 (looking-at org-todo-line-regexp) (match-end 2))
13532 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13533 (when (and (or (not specific) (string= specific "PRIORITY"))
13534 (looking-at org-priority-regexp))
13535 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13536 (when (or (not specific) (string= specific "FILE"))
13537 (push (cons "FILE" buffer-file-name) props))
13538 (when (and (or (not specific) (string= specific "TAGS"))
13539 (setq value (org-get-tags-string))
13541 (push (cons "TAGS" value) props))
13542 (when (and (or (not specific) (string= specific "ALLTAGS"))
13543 (setq value (org-get-tags-at)))
13544 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13545 ":"))
13546 props))
13547 (when (or (not specific) (string= specific "BLOCKED"))
13548 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13549 (when (or (not specific)
13550 (member specific
13551 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13552 "TIMESTAMP" "TIMESTAMP_IA")))
13553 (catch 'match
13554 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13555 (setq key (if (match-end 1)
13556 (substring (org-match-string-no-properties 1)
13557 0 -1))
13558 string (if (equal key clockstr)
13559 (org-no-properties
13560 (org-trim
13561 (buffer-substring
13562 (match-beginning 3) (goto-char
13563 (point-at-eol)))))
13564 (substring (org-match-string-no-properties 3)
13565 1 -1)))
13566 ;; Get the correct property name from the key. This is
13567 ;; necessary if the user has configured time keywords.
13568 (setq key1 (concat key ":"))
13569 (cond
13570 ((not key)
13571 (setq key
13572 (if (= (char-after (match-beginning 3)) ?\[)
13573 "TIMESTAMP_IA" "TIMESTAMP")))
13574 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13575 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13576 ((equal key1 org-closed-string) (setq key "CLOSED"))
13577 ((equal key1 org-clock-string) (setq key "CLOCK")))
13578 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13579 (progn
13580 (push (cons key string) props)
13581 ;; no need to search further if match is found
13582 (throw 'match t))
13583 (when (or (equal key "CLOCK") (not (assoc key props)))
13584 (push (cons key string) props))))))
13585 )
13587 (when (memq which '(all standard))
13588 ;; Get the standard properties, like :PROP: ...
13589 (setq range (org-get-property-block beg end))
13590 (when range
13591 (goto-char (car range))
13592 (while (re-search-forward
13594 (cdr range) t)
13595 (setq key (org-match-string-no-properties 1)
13596 value (org-trim (or (org-match-string-no-properties 2) "")))
13597 (unless (member key excluded)
13598 (push (cons key (or value "")) props)))))
13599 (if clocksum
13600 (push (cons "CLOCKSUM"
13601 (org-columns-number-to-string (/ (float clocksum) 60.)
13602 'add_times))
13603 props))
13604 (unless (assoc "CATEGORY" props)
13605 (push (cons "CATEGORY" (org-get-category)) props))
13606 (append sum-props (nreverse props)))))))
13608 (defun org-entry-get (pom property &optional inherit literal-nil)
13609 "Get value of PROPERTY for entry at point-or-marker POM.
13610 If INHERIT is non-nil and the entry does not have the property,
13611 then also check higher levels of the hierarchy.
13612 If INHERIT is the symbol `selective', use inheritance only if the setting
13613 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13614 If the property is present but empty, the return value is the empty string.
13615 If the property is not present at all, nil is returned.
13618 do not interpret it as the list atom nil. This is used for inheritance
13620 (org-with-point-at pom
13621 (if (and inherit (if (eq inherit 'selective)
13622 (org-property-inherit-p property)
13623 t))
13624 (org-entry-get-with-inheritance property literal-nil)
13625 (if (member property org-special-properties)
13626 ;; We need a special property. Use `org-entry-properties' to
13627 ;; retrieve it, but specify the wanted property
13628 (cdr (assoc property (org-entry-properties nil 'special property)))
13629 (let ((range (unless (org-before-first-heading-p)
13630 (org-get-property-block))))
13631 (if (and range
13632 (goto-char (car range))
13633 (re-search-forward
13635 (cdr range) t))
13636 ;; Found the property, return it.
13637 (if (match-end 1)
13638 (if literal-nil
13639 (org-match-string-no-properties 1)
13640 (org-not-nil (org-match-string-no-properties 1)))
13641 "")))))))
13643 (defun org-property-or-variable-value (var &optional inherit)
13644 "Check if there is a property fixing the value of VAR.
13645 If yes, return this value. If not, return the current value of the variable."
13646 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13648 (read prop)
13649 (symbol-value var))))
13651 (defun org-entry-delete (pom property)
13652 "Delete the property PROPERTY from entry at point-or-marker POM."
13653 (org-with-point-at pom
13654 (if (member property org-special-properties)
13655 nil ; cannot delete these properties.
13656 (let ((range (org-get-property-block)))
13657 (if (and range
13658 (goto-char (car range))
13659 (re-search-forward
13661 (cdr range) t))
13662 (progn
13663 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13664 t)
13665 nil)))))
13667 ;; Multi-values properties are properties that contain multiple values
13668 ;; These values are assumed to be single words, separated by whitespace.
13669 (defun org-entry-add-to-multivalued-property (pom property value)
13670 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13671 (let* ((old (org-entry-get pom property))
13673 (setq value (org-entry-protect-space value))
13674 (unless (member value values)
13675 (setq values (cons value values))
13676 (org-entry-put pom property
13677 (mapconcat 'identity values " ")))))
13679 (defun org-entry-remove-from-multivalued-property (pom property value)
13680 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13681 (let* ((old (org-entry-get pom property))
13683 (setq value (org-entry-protect-space value))
13684 (when (member value values)
13685 (setq values (delete value values))
13686 (org-entry-put pom property
13687 (mapconcat 'identity values " ")))))
13689 (defun org-entry-member-in-multivalued-property (pom property value)
13690 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13691 (let* ((old (org-entry-get pom property))
13693 (setq value (org-entry-protect-space value))
13694 (member value values)))
13696 (defun org-entry-get-multivalued-property (pom property)
13697 "Return a list of values in a multivalued property."
13698 (let* ((value (org-entry-get pom property))
13700 (mapcar 'org-entry-restore-space values)))
13702 (defun org-entry-put-multivalued-property (pom property &rest values)
13703 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13704 VALUES should be a list of strings. Spaces will be protected."
13705 (org-entry-put pom property
13706 (mapconcat 'org-entry-protect-space values " "))
13707 (let* ((value (org-entry-get pom property))
13709 (mapcar 'org-entry-restore-space values)))
13711 (defun org-entry-protect-space (s)
13712 "Protect spaces and newline in string S."
13713 (while (string-match " " s)
13714 (setq s (replace-match "%20" t t s)))
13716 (setq s (replace-match "%0A" t t s)))
13717 s)
13719 (defun org-entry-restore-space (s)
13720 "Restore spaces and newline in string S."
13721 (while (string-match "%20" s)
13722 (setq s (replace-match " " t t s)))
13723 (while (string-match "%0A" s)
13725 s)
13727 (defvar org-entry-property-inherited-from (make-marker)
13728 "Marker pointing to the entry from where a property was inherited.
13729 Each call to `org-entry-get-with-inheritance' will set this marker to the
13730 location of the entry where the inheritance search matched. If there was
13731 no match, the marker will point nowhere.
13732 Note that also `org-entry-get' calls this function, if the INHERIT flag
13733 is set.")
13735 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13736 "Get entry property, and search higher levels if not present.
13737 The search will stop at the first ancestor which has the property defined.
13739 should be considered as undefined (this is the meaning of nil here).
13741 (move-marker org-entry-property-inherited-from nil)
13742 (let (tmp)
13743 (unless (org-before-first-heading-p)
13744 (save-excursion
13745 (save-restriction
13746 (widen)
13747 (catch 'ex
13748 (while t
13749 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13750 (org-back-to-heading t)
13751 (move-marker org-entry-property-inherited-from (point))
13752 (throw 'ex tmp))
13753 (or (org-up-heading-safe) (throw 'ex nil)))))))
13754 (setq tmp (or tmp
13755 (cdr (assoc property org-file-properties))
13756 (cdr (assoc property org-global-properties))
13757 (cdr (assoc property org-global-properties-fixed))))
13758 (if literal-nil tmp (org-not-nil tmp))))
13760 (defvar org-property-changed-functions nil
13761 "Hook called when the value of a property has changed.
13762 Each hook function should accept two arguments, the name of the property
13763 and the new value.")
13765 (defun org-entry-put (pom property value)
13766 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13767 (org-with-point-at pom
13768 (org-back-to-heading t)
13769 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13770 range)
13771 (cond
13772 ((equal property "TODO")
13774 (not (member value org-todo-keywords-1)))
13776 (if (or (not value)
13778 (setq value 'none))
13779 (org-todo value)
13780 (org-set-tags nil 'align))
13781 ((equal property "PRIORITY")
13783 (string-to-char value) ?\ ))
13784 (org-set-tags nil 'align))
13785 ((equal property "SCHEDULED")
13786 (if (re-search-forward org-scheduled-time-regexp end t)
13787 (cond
13788 ((eq value 'earlier) (org-timestamp-change -1 'day))
13789 ((eq value 'later) (org-timestamp-change 1 'day))
13790 (t (call-interactively 'org-schedule)))
13791 (call-interactively 'org-schedule)))
13792 ((equal property "DEADLINE")
13793 (if (re-search-forward org-deadline-time-regexp end t)
13794 (cond
13795 ((eq value 'earlier) (org-timestamp-change -1 'day))
13796 ((eq value 'later) (org-timestamp-change 1 'day))
13797 (t (call-interactively 'org-deadline)))
13798 (call-interactively 'org-deadline)))
13799 ((member property org-special-properties)
13800 (error "The %s property can not yet be set with `org-entry-put'"
13801 property))
13802 (t ; a non-special property
13803 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13804 (setq range (org-get-property-block beg end 'force))
13805 (goto-char (car range))
13806 (if (re-search-forward
13808 (progn
13809 (delete-region (match-beginning 1) (match-end 1))
13810 (goto-char (match-beginning 1)))
13811 (goto-char (cdr range))
13813 (backward-char 1)
13814 (org-indent-line-function)
13815 (insert ":" property ":"))
13816 (and value (insert " " value))
13817 (org-indent-line-function)))))
13818 (run-hook-with-args 'org-property-changed-functions property value)))
13820 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13821 "Get all property keys in the current buffer.
13822 With INCLUDE-SPECIALS, also list the special properties that reflect things
13823 like tags and TODO state.
13824 With INCLUDE-DEFAULTS, also include properties that has special meaning
13825 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
13826 With INCLUDE-COLUMNS, also include property names given in COLUMN
13827 formats in the current buffer."
13828 (let (rtn range cfmt s p)
13829 (save-excursion
13830 (save-restriction
13831 (widen)
13832 (goto-char (point-min))
13833 (while (re-search-forward org-property-start-re nil t)
13834 (setq range (org-get-property-block))
13835 (goto-char (car range))
13836 (while (re-search-forward
13838 (cdr range) t)
13839 (add-to-list 'rtn (org-match-string-no-properties 1)))
13840 (outline-next-heading))))
13842 (when include-specials
13843 (setq rtn (append org-special-properties rtn)))
13845 (when include-defaults
13846 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13847 (add-to-list 'rtn org-effort-property))
13849 (when include-columns
13850 (save-excursion
13851 (save-restriction
13852 (widen)
13853 (goto-char (point-min))
13854 (while (re-search-forward
13856 nil t)
13857 (setq cfmt (match-string 2) s 0)
13859 cfmt s)
13860 (setq s (match-end 0)
13861 p (match-string 1 cfmt))
13862 (unless (or (equal p "ITEM")
13863 (member p org-special-properties))
13864 (add-to-list 'rtn (match-string 1 cfmt))))))))
13866 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13868 (defun org-property-values (key)
13869 "Return a list of all values of property KEY."
13870 (save-excursion
13871 (save-restriction
13872 (widen)
13873 (goto-char (point-min))
13875 values)
13876 (while (re-search-forward re nil t)
13877 (add-to-list 'values (org-trim (match-string 1))))
13878 (delete "" values)))))
13880 (defun org-insert-property-drawer ()
13881 "Insert a property drawer into the current entry."
13882 (interactive)
13883 (org-back-to-heading t)
13884 (looking-at outline-regexp)
13885 (let ((indent (if org-adapt-indentation
13886 (- (match-end 0)(match-beginning 0))
13887 0))
13888 (beg (point))
13890 end hiddenp)
13891 (outline-next-heading)
13892 (setq end (point))
13893 (goto-char beg)
13894 (while (re-search-forward re end t))
13895 (setq hiddenp (outline-invisible-p))
13896 (end-of-line 1)
13899 (if (member (match-string 1) '("CLOCK:" ":END:"))
13900 ;; just skip this line
13901 (beginning-of-line 2)
13902 ;; Drawer start, find the end
13904 (beginning-of-line 1)))
13905 (org-skip-over-state-notes)
13907 (if (eq (char-before) ?*) (forward-char 1))
13909 (beginning-of-line 0)
13910 (org-indent-to-column indent)
13911 (beginning-of-line 2)
13912 (org-indent-to-column indent)
13913 (beginning-of-line 0)
13914 (if hiddenp
13915 (save-excursion
13916 (org-back-to-heading t)
13917 (hide-entry))
13918 (org-flag-drawer t))))
13920 (defvar org-property-set-functions-alist nil
13921 "Property set function alist.
13922 Each entry should have the following format:
13924 (PROPERTY . READ-FUNCTION)
13926 The read function will be called with the same argument as
13927 `org-completing-read.")
13929 (defun org-set-property-function (property)
13930 "Get the function that should be used to set PROPERTY.
13931 This is computed according to `org-property-set-functions-alist'."
13932 (or (cdr (assoc property org-property-set-functions-alist))
13933 'org-completing-read))
13935 (defun org-read-property-value (property)
13936 "Read PROPERTY value from user."
13937 (let* ((completion-ignore-case t)
13938 (allowed (org-property-get-allowed-values nil property 'table))
13939 (cur (org-entry-get nil property))
13940 (prompt (concat property " value"
13942 (concat " [" cur "]") "") ": "))
13943 (set-function (org-set-property-function property))
13944 (val (if allowed
13945 (funcall set-function prompt allowed nil
13946 (not (get-text-property 0 'org-unrestricted
13947 (caar allowed))))
13948 (let (org-completion-use-ido org-completion-use-iswitchb)
13949 (funcall set-function prompt
13950 (mapcar 'list (org-property-values property))
13951 nil nil "" nil cur)))))
13952 (if (equal val "")
13953 cur
13954 val)))
13956 (defun org-read-property-name ()
13957 "Read a property name."
13958 (let* ((completion-ignore-case t)
13959 (keys (org-buffer-property-keys nil t t))
13960 (property (org-icompleting-read "Property: " (mapcar 'list keys))))
13961 (if (member property keys)
13962 property
13963 (or (cdr (assoc (downcase property)
13964 (mapcar (lambda (x) (cons (downcase x) x))
13965 keys)))
13966 property))))
13968 (defun org-set-property (property value)
13969 "In the current entry, set PROPERTY to VALUE.
13970 When called interactively, this will prompt for a property name, offering
13971 completion on existing and default properties. And then it will prompt
13972 for a value, offering completion either on allowed values (via an inherited
13973 xxx_ALL property) or on existing values in other instances of this property
13974 in the current file."
13975 (interactive (list nil nil))
13976 (let* ((property (or property (org-read-property-name)))
13977 (value (or value (org-read-property-value property))))
13978 (unless (equal (org-entry-get nil property) value)
13979 (org-entry-put nil property value))))
13981 (defun org-delete-property (property)
13982 "In the current entry, delete PROPERTY."
13983 (interactive
13984 (let* ((completion-ignore-case t)
13985 (prop (org-icompleting-read "Property: "
13986 (org-entry-properties nil 'standard))))
13987 (list prop)))
13988 (message "Property %s %s" property
13989 (if (org-entry-delete nil property)
13990 "deleted"
13991 "was not present in the entry")))
13993 (defun org-delete-property-globally (property)
13994 "Remove PROPERTY globally, from all entries."
13995 (interactive
13996 (let* ((completion-ignore-case t)
13997 (prop (org-icompleting-read
13998 "Globally remove property: "
13999 (mapcar 'list (org-buffer-property-keys)))))
14000 (list prop)))
14001 (save-excursion
14002 (save-restriction
14003 (widen)
14004 (goto-char (point-min))
14005 (let ((cnt 0))
14006 (while (re-search-forward
14008 nil t)
14009 (setq cnt (1+ cnt))
14010 (replace-match ""))
14013 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14015 (defun org-compute-property-at-point ()
14016 "Compute the property at point.
14017 This looks for an enclosing column format, extracts the operator and
14018 then applies it to the property in the column format's scope."
14019 (interactive)
14020 (unless (org-at-property-p)
14021 (error "Not at a property"))
14022 (let ((prop (org-match-string-no-properties 2)))
14023 (org-columns-get-format-and-top-level)
14024 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14025 (error "No operator defined for property %s" prop))
14026 (org-columns-compute prop)))
14028 (defvar org-property-allowed-value-functions nil
14029 "Hook for functions supplying allowed values for a specific property.
14030 The functions must take a single argument, the name of the property, and
14032 the values, this means that these values are intended as defaults for
14033 completion, but that other values should be allowed too.
14034 The functions must return nil if they are not responsible for this
14035 property.")
14037 (defun org-property-get-allowed-values (pom property &optional table)
14038 "Get allowed values for the property PROPERTY.
14039 When TABLE is non-nil, return an alist that can directly be used for
14040 completion."
14041 (let (vals)
14042 (cond
14043 ((equal property "TODO")
14044 (setq vals (org-with-point-at pom
14045 (append org-todo-keywords-1 '("")))))
14046 ((equal property "PRIORITY")
14047 (let ((n org-lowest-priority))
14048 (while (>= n org-highest-priority)
14049 (push (char-to-string n) vals)
14050 (setq n (1- n)))))
14051 ((member property org-special-properties))
14052 ((setq vals (run-hook-with-args-until-success
14053 'org-property-allowed-value-functions property)))
14054 (t
14055 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14057 (setq vals (car (read-from-string (concat "(" vals ")"))))
14058 (setq vals (mapcar (lambda (x)
14059 (cond ((stringp x) x)
14060 ((numberp x) (number-to-string x))
14061 ((symbolp x) (symbol-name x))
14062 (t "???")))
14063 vals)))))
14064 (when (member ":ETC" vals)
14065 (setq vals (remove ":ETC" vals))
14066 (org-add-props (car vals) '(org-unrestricted t)))
14067 (if table (mapcar 'list vals) vals)))
14069 (defun org-property-previous-allowed-value (&optional previous)
14070 "Switch to the next allowed value for this property."
14071 (interactive)
14072 (org-property-next-allowed-value t))
14074 (defun org-property-next-allowed-value (&optional previous)
14075 "Switch to the next allowed value for this property."
14076 (interactive)
14077 (unless (org-at-property-p)
14078 (error "Not at a property"))
14079 (let* ((key (match-string 2))
14080 (value (match-string 3))
14081 (allowed (or (org-property-get-allowed-values (point) key)
14082 (and (member value '("[ ]" "[-]" "[X]"))
14083 '("[ ]" "[X]"))))
14084 nval)
14085 (unless allowed
14086 (error "Allowed values for this property have not been defined"))
14087 (if previous (setq allowed (reverse allowed)))
14088 (if (member value allowed)
14089 (setq nval (car (cdr (member value allowed)))))
14090 (setq nval (or nval (car allowed)))
14091 (if (equal nval value)
14092 (error "Only one allowed value for this property"))
14093 (org-at-property-p)
14094 (replace-match (concat " :" key ": " nval) t t)
14095 (org-indent-line-function)
14096 (beginning-of-line 1)
14098 (run-hook-with-args 'org-property-changed-functions key nval)))
14100 (defun org-find-olp (path &optional this-buffer)
14101 "Return a marker pointing to the entry at outline path OLP.
14102 If anything goes wrong, throw an error.
14103 You can wrap this call to catch the error like this:
14105 (condition-case msg
14106 (org-mobile-locate-entry (match-string 4))
14107 (error (nth 1 msg)))
14109 The return value will then be either a string with the error message,
14110 or a marker if everything is OK.
14112 If THIS-BUFFER is set, the outline path does not contain a file,
14113 only headings."
14114 (let* ((file (if this-buffer buffer-file-name (pop path)))
14115 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14116 (level 1)
14117 (lmin 1)
14118 (lmax 1)
14119 limit re end found pos heading cnt)
14120 (unless buffer (error "File not found :%s" file))
14121 (with-current-buffer buffer
14122 (save-excursion
14123 (save-restriction
14124 (widen)
14125 (setq limit (point-max))
14126 (goto-char (point-min))
14127 (while (setq heading (pop path))
14128 (setq re (format org-complex-heading-regexp-format
14129 (regexp-quote heading)))
14130 (setq cnt 0 pos (point))
14131 (while (re-search-forward re end t)
14132 (setq level (- (match-end 1) (match-beginning 1)))
14133 (if (and (>= level lmin) (<= level lmax))
14134 (setq found (match-beginning 0) cnt (1+ cnt))))
14135 (when (= cnt 0) (error "Heading not found on level %d: %s"
14136 lmax heading))
14137 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14138 lmax heading))
14139 (goto-char found)
14140 (setq lmin (1+ level) lmax (+ lmin (if org-odd-levels-only 1 0)))
14141 (setq end (save-excursion (org-end-of-subtree t t))))
14142 (when (org-on-heading-p)
14143 (move-marker (make-marker) (point))))))))
14145 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14146 "Find node HEADING in BUFFER.
14147 Return a marker to the heading if it was found, or nil if not.
14148 If POS-ONLY is set, return just the position instead of a marker.
14150 The heading text must match exact, but it may have a TODO keyword,
14151 a priority cookie and tags in the standard locations."
14152 (with-current-buffer (or buffer (current-buffer))
14153 (save-excursion
14154 (save-restriction
14155 (widen)
14156 (goto-char (point-min))
14157 (let (case-fold-search)
14158 (if (re-search-forward
14159 (format org-complex-heading-regexp-format
14160 (regexp-quote heading)) nil t)
14161 (if pos-only
14162 (match-beginning 0)
14163 (move-marker (make-marker) (match-beginning 0)))))))))
14165 (defun org-find-exact-heading-in-directory (heading &optional dir)
14166 "Find Org node headline HEADING in all .org files in directory DIR.
14167 When the target headline is found, return a marker to this location."
14168 (let ((files (directory-files (or dir default-directory)
14170 file visiting m buffer)
14171 (catch 'found
14172 (while (setq file (pop files))
14173 (message "trying %s" file)
14174 (setq visiting (org-find-base-buffer-visiting file))
14175 (setq buffer (or visiting (find-file-noselect file)))
14176 (setq m (org-find-exact-headline-in-buffer
14177 heading buffer))
14178 (when (and (not m) (not visiting)) (kill-buffer buffer))
14179 (and m (throw 'found m))))))
14181 (defun org-find-entry-with-id (ident)
14182 "Locate the entry that contains the ID property with exact value IDENT.
14183 IDENT can be a string, a symbol or a number, this function will search for
14184 the string representation of it.
14185 Return the position where this entry starts, or nil if there is no such entry."
14186 (interactive "sID: ")
14187 (let ((id (cond
14188 ((stringp ident) ident)
14189 ((symbol-name ident) (symbol-name ident))
14190 ((numberp ident) (number-to-string ident))
14191 (t (error "IDENT %s must be a string, symbol or number" ident))))
14192 (case-fold-search nil))
14193 (save-excursion
14194 (save-restriction
14195 (widen)
14196 (goto-char (point-min))
14197 (when (re-search-forward
14199 nil t)
14200 (org-back-to-heading t)
14201 (point))))))
14203 ;;;; Timestamps
14205 (defvar org-last-changed-timestamp nil)
14206 (defvar org-last-inserted-timestamp nil
14207 "The last time stamp inserted with `org-insert-time-stamp'.")
14208 (defvar org-time-was-given) ; dynamically scoped parameter
14209 (defvar org-end-time-was-given) ; dynamically scoped parameter
14210 (defvar org-ts-what) ; dynamically scoped parameter
14212 (defun org-time-stamp (arg &optional inactive)
14213 "Prompt for a date/time and insert a time stamp.
14214 If the user specifies a time like HH:MM, or if this command is called
14215 with a prefix argument, the time stamp will contain date and time.
14216 Otherwise, only the date will be included. All parts of a date not
14217 specified by the user will be filled in from the current date/time.
14218 So if you press just return without typing anything, the time stamp
14219 will represent the current date/time. If there is already a timestamp
14220 at the cursor, it will be modified."
14221 (interactive "P")
14222 (let* ((ts nil)
14223 (default-time
14224 ;; Default time is either today, or, when entering a range,
14225 ;; the range start.
14226 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14227 (save-excursion
14228 (re-search-backward
14230 (- (point) 20) t)))
14231 (apply 'encode-time (org-parse-time-string (match-string 1)))
14232 (current-time)))
14233 (default-input (and ts (org-get-compact-tod ts)))
14234 org-time-was-given org-end-time-was-given time)
14235 (cond
14236 ((and (org-at-timestamp-p t)
14237 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14238 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14239 (insert "--")
14240 (setq time (let ((this-command this-command))
14241 (org-read-date arg 'totime nil nil
14242 default-time default-input)))
14243 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14244 ((org-at-timestamp-p t)
14245 (setq time (let ((this-command this-command))
14246 (org-read-date arg 'totime nil nil default-time default-input)))
14247 (when (org-at-timestamp-p t) ; just to get the match data
14248 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14249 (replace-match "")
14250 (setq org-last-changed-timestamp
14251 (org-insert-time-stamp
14252 time (or org-time-was-given arg)
14253 inactive nil nil (list org-end-time-was-given))))
14254 (message "Timestamp updated"))
14255 (t
14256 (setq time (let ((this-command this-command))
14257 (org-read-date arg 'totime nil nil default-time default-input)))
14258 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14259 nil nil (list org-end-time-was-given))))))
14261 ;; FIXME: can we use this for something else, like computing time differences?
14262 (defun org-get-compact-tod (s)
14263 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14264 (let* ((t1 (match-string 1 s))
14265 (h1 (string-to-number (match-string 2 s)))
14266 (m1 (string-to-number (match-string 3 s)))
14267 (t2 (and (match-end 4) (match-string 5 s)))
14268 (h2 (and t2 (string-to-number (match-string 6 s))))
14269 (m2 (and t2 (string-to-number (match-string 7 s))))
14270 dh dm)
14271 (if (not t2)
14272 t1
14273 (setq dh (- h2 h1) dm (- m2 m1))
14274 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14275 (concat t1 "+" (number-to-string dh)
14276 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14278 (defun org-time-stamp-inactive (&optional arg)
14279 "Insert an inactive time stamp.
14280 An inactive time stamp is enclosed in square brackets instead of angle
14281 brackets. It is inactive in the sense that it does not trigger agenda entries,
14282 does not link to the calendar and cannot be changed with the S-cursor keys.
14283 So these are more for recording a certain time/date."
14284 (interactive "P")
14285 (org-time-stamp arg 'inactive))
14287 (defvar org-date-ovl (make-overlay 1 1))
14288 (overlay-put org-date-ovl 'face 'org-warning)
14289 (org-detach-overlay org-date-ovl)
14291 (defvar org-ans1) ; dynamically scoped parameter
14292 (defvar org-ans2) ; dynamically scoped parameter
14294 (defvar org-plain-time-of-day-regexp) ; defined below
14296 (defvar org-overriding-default-time nil) ; dynamically scoped
14297 (defvar org-read-date-overlay nil)
14298 (defvar org-dcst nil) ; dynamically scoped
14299 (defvar org-read-date-history nil)
14300 (defvar org-read-date-final-answer nil)
14302 (defun org-read-date (&optional with-time to-time from-string prompt
14303 default-time default-input)
14304 "Read a date, possibly a time, and make things smooth for the user.
14305 The prompt will suggest to enter an ISO date, but you can also enter anything
14306 which will at least partially be understood by `parse-time-string'.
14307 Unrecognized parts of the date will default to the current day, month, year,
14308 hour and minute. If this command is called to replace a timestamp at point,
14309 of to enter the second timestamp of a range, the default time is taken
14310 from the existing stamp. Furthermore, the command prefers the future,
14311 so if you are giving a date where the year is not given, and the day-month
14312 combination is already past in the current year, it will assume you
14313 mean next year. For details, see the manual. A few examples:
14315 3-2-5 --> 2003-02-05
14316 feb 15 --> currentyear-02-15
14317 2/15 --> currentyear-02-15
14318 sep 12 9 --> 2009-09-12
14319 12:45 --> today 12:45
14320 22 sept 0:34 --> currentyear-09-22 0:34
14321 12 --> currentyear-currentmonth-12
14322 Fri --> nearest Friday (today or later)
14323 etc.
14325 Furthermore you can specify a relative date by giving, as the *first* thing
14326 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14327 change in days weeks, months, years.
14328 With a single plus or minus, the date is relative to today. With a double
14329 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14330 +4d --> four days from today
14331 +4 --> same as above
14332 +2w --> two weeks from today
14333 ++5 --> five days from default date
14335 The function understands only English month and weekday abbreviations,
14336 but this can be configured with the variables `parse-time-months' and
14337 `parse-time-weekdays'.
14339 While prompting, a calendar is popped up - you can also select the
14340 date with the mouse (button 1). The calendar shows a period of three
14341 months. To scroll it to other months, use the keys `>' and `<'.
14342 If you don't like the calendar, turn it off with
14343 \(setq org-read-date-popup-calendar nil)
14345 With optional argument TO-TIME, the date will immediately be converted
14346 to an internal time.
14347 With an optional argument WITH-TIME, the prompt will suggest to also
14348 insert a time. Note that when WITH-TIME is not set, you can still
14349 enter a time, and this function will inform the calling routine about
14350 this change. The calling routine may then choose to change the format
14351 used to insert the time stamp into the buffer to include the time.
14352 With optional argument FROM-STRING, read from this string instead from
14353 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14354 the time/date that is used for everything that is not specified by the
14355 user."
14356 (require 'parse-time)
14357 (let* ((org-time-stamp-rounding-minutes
14358 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14359 (org-dcst org-display-custom-times)
14360 (ct (org-current-time))
14361 (def (or org-overriding-default-time default-time ct))
14362 (defdecode (decode-time def))
14363 (dummy (progn
14364 (when (< (nth 2 defdecode) org-extend-today-until)
14365 (setcar (nthcdr 2 defdecode) -1)
14366 (setcar (nthcdr 1 defdecode) 59)
14367 (setq def (apply 'encode-time defdecode)
14368 defdecode (decode-time def)))))
14369 (calendar-frame-setup nil)
14370 (calendar-setup nil)
14371 (calendar-move-hook nil)
14372 (calendar-view-diary-initially-flag nil)
14373 (calendar-view-holidays-initially-flag nil)
14374 (timestr (format-time-string
14375 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14376 (prompt (concat (if prompt (concat prompt " ") "")
14377 (format "Date+time [%s]: " timestr)))
14378 ans (org-ans0 "") org-ans1 org-ans2 final)
14380 (cond
14381 (from-string (setq ans from-string))
14382 (org-read-date-popup-calendar
14383 (save-excursion
14384 (save-window-excursion
14385 (calendar)
14386 (calendar-forward-day (- (time-to-days def)
14387 (calendar-absolute-from-gregorian
14388 (calendar-current-date))))
14389 (org-eval-in-calendar nil t)
14390 (let* ((old-map (current-local-map))
14391 (map (copy-keymap calendar-mode-map))
14392 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14393 (org-defkey map (kbd "RET") 'org-calendar-select)
14394 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14395 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14396 (org-defkey minibuffer-local-map [(meta shift left)]
14397 (lambda () (interactive)
14398 (org-eval-in-calendar '(calendar-backward-month 1))))
14399 (org-defkey minibuffer-local-map [(meta shift right)]
14400 (lambda () (interactive)
14401 (org-eval-in-calendar '(calendar-forward-month 1))))
14402 (org-defkey minibuffer-local-map [(meta shift up)]
14403 (lambda () (interactive)
14404 (org-eval-in-calendar '(calendar-backward-year 1))))
14405 (org-defkey minibuffer-local-map [(meta shift down)]
14406 (lambda () (interactive)
14407 (org-eval-in-calendar '(calendar-forward-year 1))))
14408 (org-defkey minibuffer-local-map [?\e (shift left)]
14409 (lambda () (interactive)
14410 (org-eval-in-calendar '(calendar-backward-month 1))))
14411 (org-defkey minibuffer-local-map [?\e (shift right)]
14412 (lambda () (interactive)
14413 (org-eval-in-calendar '(calendar-forward-month 1))))
14414 (org-defkey minibuffer-local-map [?\e (shift up)]
14415 (lambda () (interactive)
14416 (org-eval-in-calendar '(calendar-backward-year 1))))
14417 (org-defkey minibuffer-local-map [?\e (shift down)]
14418 (lambda () (interactive)
14419 (org-eval-in-calendar '(calendar-forward-year 1))))
14420 (org-defkey minibuffer-local-map [(shift up)]
14421 (lambda () (interactive)
14422 (org-eval-in-calendar '(calendar-backward-week 1))))
14423 (org-defkey minibuffer-local-map [(shift down)]
14424 (lambda () (interactive)
14425 (org-eval-in-calendar '(calendar-forward-week 1))))
14426 (org-defkey minibuffer-local-map [(shift left)]
14427 (lambda () (interactive)
14428 (org-eval-in-calendar '(calendar-backward-day 1))))
14429 (org-defkey minibuffer-local-map [(shift right)]
14430 (lambda () (interactive)
14431 (org-eval-in-calendar '(calendar-forward-day 1))))
14432 (org-defkey minibuffer-local-map ">"
14433 (lambda () (interactive)
14434 (org-eval-in-calendar '(scroll-calendar-left 1))))
14435 (org-defkey minibuffer-local-map "<"
14436 (lambda () (interactive)
14437 (org-eval-in-calendar '(scroll-calendar-right 1))))
14438 (org-defkey minibuffer-local-map "\C-v"
14439 (lambda () (interactive)
14440 (org-eval-in-calendar
14441 '(calendar-scroll-left-three-months 1))))
14442 (org-defkey minibuffer-local-map "\M-v"
14443 (lambda () (interactive)
14444 (org-eval-in-calendar
14445 '(calendar-scroll-right-three-months 1))))
14446 (run-hooks 'org-read-date-minibuffer-setup-hook)
14447 (unwind-protect
14448 (progn
14449 (use-local-map map)
14450 (add-hook 'post-command-hook 'org-read-date-display)
14451 (setq org-ans0 (read-string prompt default-input
14452 'org-read-date-history nil))
14453 ;; org-ans0: from prompt
14454 ;; org-ans1: from mouse click
14455 ;; org-ans2: from calendar motion
14456 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14457 (remove-hook 'post-command-hook 'org-read-date-display)
14458 (use-local-map old-map)
14459 (when org-read-date-overlay
14460 (delete-overlay org-read-date-overlay)
14461 (setq org-read-date-overlay nil)))))))
14463 (t ; Naked prompt only
14464 (unwind-protect
14465 (setq ans (read-string prompt default-input
14466 'org-read-date-history timestr))
14467 (when org-read-date-overlay
14468 (delete-overlay org-read-date-overlay)
14469 (setq org-read-date-overlay nil)))))
14471 (setq final (org-read-date-analyze ans def defdecode))
14473 ;; One round trip to get rid of 34th of August and stuff like that....
14474 (setq final (decode-time (apply 'encode-time final)))
14476 (setq org-read-date-final-answer ans)
14478 (if to-time
14479 (apply 'encode-time final)
14480 (if (and (boundp 'org-time-was-given) org-time-was-given)
14481 (format "%04d-%02d-%02d %02d:%02d"
14482 (nth 5 final) (nth 4 final) (nth 3 final)
14483 (nth 2 final) (nth 1 final))
14484 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14486 (defvar def)
14487 (defvar defdecode)
14488 (defvar with-time)
14489 (defvar org-read-date-analyze-futurep nil)
14490 (defun org-read-date-display ()
14491 "Display the current date prompt interpretation in the minibuffer."
14492 (when org-read-date-display-live
14493 (when org-read-date-overlay
14494 (delete-overlay org-read-date-overlay))
14495 (let ((p (point)))
14496 (end-of-line 1)
14497 (while (not (equal (buffer-substring
14498 (max (point-min) (- (point) 4)) (point))
14499 " "))
14500 (insert " "))
14501 (goto-char p))
14502 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14503 " " (or org-ans1 org-ans2)))
14504 (org-end-time-was-given nil)
14505 (f (org-read-date-analyze ans def defdecode))
14506 (fmts (if org-dcst
14507 org-time-stamp-custom-formats
14508 org-time-stamp-formats))
14509 (fmt (if (or with-time
14510 (and (boundp 'org-time-was-given) org-time-was-given))
14511 (cdr fmts)
14512 (car fmts)))
14513 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14514 (when (and org-end-time-was-given
14515 (string-match org-plain-time-of-day-regexp txt))
14516 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14517 org-end-time-was-given
14518 (substring txt (match-end 0)))))
14519 (when org-read-date-analyze-futurep
14520 (setq txt (concat txt " (=>F)")))
14521 (setq org-read-date-overlay
14522 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14523 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14525 (defun org-read-date-analyze (ans def defdecode)
14526 "Analyze the combined answer of the date prompt."
14527 ;; FIXME: cleanup and comment
14528 (let ((nowdecode (decode-time (current-time)))
14529 delta deltan deltaw deltadef year month day
14530 hour minute second wday pm h2 m2 tl wday1
14531 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14532 (setq org-read-date-analyze-futurep nil)
14534 (setq ans "+0"))
14536 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14537 (setq ans (replace-match "" t t ans)
14538 deltan (car delta)
14539 deltaw (nth 1 delta)
14540 deltadef (nth 2 delta)))
14542 ;; Check if there is an iso week date in there
14543 ;; If yes, store the info and postpone interpreting it until the rest
14544 ;; of the parsing is done
14545 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14546 (setq iso-year (if (match-end 1)
14547 (org-small-year-to-year
14548 (string-to-number (match-string 1 ans))))
14549 iso-weekday (if (match-end 3)
14550 (string-to-number (match-string 3 ans)))
14551 iso-week (string-to-number (match-string 2 ans)))
14552 (setq ans (replace-match "" t t ans)))
14554 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14555 (when (string-match
14557 (setq year (if (match-end 2)
14558 (string-to-number (match-string 2 ans))
14559 (progn (setq kill-year t)
14560 (string-to-number (format-time-string "%Y"))))
14561 month (string-to-number (match-string 3 ans))
14562 day (string-to-number (match-string 4 ans)))
14563 (if (< year 100) (setq year (+ 2000 year)))
14565 t nil ans)))
14566 ;; Help matching american dates, like 5/30 or 5/30/7
14567 (when (string-match
14568 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14569 (setq year (if (match-end 4)
14570 (string-to-number (match-string 4 ans))
14571 (progn (setq kill-year t)
14572 (string-to-number (format-time-string "%Y"))))
14573 month (string-to-number (match-string 1 ans))
14574 day (string-to-number (match-string 2 ans)))
14575 (if (< year 100) (setq year (+ 2000 year)))
14577 t nil ans)))
14578 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14579 ;; If there is a time with am/pm, and *no* time without it, we convert
14580 ;; so that matching will be successful.
14581 (loop for i from 1 to 2 do ; twice, for end time as well
14584 (setq hour (string-to-number (match-string 1 ans))
14585 minute (if (match-end 3)
14586 (string-to-number (match-string 3 ans))
14587 0)
14588 pm (equal ?p
14589 (string-to-char (downcase (match-string 4 ans)))))
14590 (if (and (= hour 12) (not pm))
14591 (setq hour 0)
14592 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14593 (setq ans (replace-match (format "%02d:%02d" hour minute)
14594 t t ans))))
14596 ;; Check if a time range is given as a duration
14597 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14598 (setq hour (string-to-number (match-string 1 ans))
14599 h2 (+ hour (string-to-number (match-string 3 ans)))
14600 minute (string-to-number (match-string 2 ans))
14601 m2 (+ minute (if (match-end 5) (string-to-number
14602 (match-string 5 ans))0)))
14603 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14604 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14605 t t ans)))
14607 ;; Check if there is a time range
14608 (when (boundp 'org-end-time-was-given)
14609 (setq org-time-was-given nil)
14610 (when (and (string-match org-plain-time-of-day-regexp ans)
14611 (match-end 8))
14612 (setq org-end-time-was-given (match-string 8 ans))
14613 (setq ans (concat (substring ans 0 (match-beginning 7))
14614 (substring ans (match-end 7))))))
14616 (setq tl (parse-time-string ans)
14617 day (or (nth 3 tl) (nth 3 defdecode))
14618 month (or (nth 4 tl)
14619 (if (and org-read-date-prefer-future
14620 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14621 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14622 (nth 4 defdecode)))
14623 year (or (and (not kill-year) (nth 5 tl))
14624 (if (and org-read-date-prefer-future
14625 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14626 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14627 (nth 5 defdecode)))
14628 hour (or (nth 2 tl) (nth 2 defdecode))
14629 minute (or (nth 1 tl) (nth 1 defdecode))
14630 second (or (nth 0 tl) 0)
14631 wday (nth 6 tl))
14633 (when (and (eq org-read-date-prefer-future 'time)
14634 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14635 (equal day (nth 3 nowdecode))
14636 (equal month (nth 4 nowdecode))
14637 (equal year (nth 5 nowdecode))
14638 (nth 2 tl)
14639 (or (< (nth 2 tl) (nth 2 nowdecode))
14640 (and (= (nth 2 tl) (nth 2 nowdecode))
14641 (nth 1 tl)
14642 (< (nth 1 tl) (nth 1 nowdecode)))))
14643 (setq day (1+ day)
14644 futurep t))
14646 ;; Special date definitions below
14647 (cond
14648 (iso-week
14649 ;; There was an iso week
14650 (require 'cal-iso)
14651 (setq futurep nil)
14652 (setq year (or iso-year year)
14653 day (or iso-weekday wday 1)
14654 wday nil ; to make sure that the trigger below does not match
14655 iso-date (calendar-gregorian-from-absolute
14656 (calendar-absolute-from-iso
14657 (list iso-week day year))))
14658 ; FIXME: Should we also push ISO weeks into the future?
14659 ; (when (and org-read-date-prefer-future
14660 ; (not iso-year)
14661 ; (< (calendar-absolute-from-gregorian iso-date)
14662 ; (time-to-days (current-time))))
14663 ; (setq year (1+ year)
14664 ; iso-date (calendar-gregorian-from-absolute
14665 ; (calendar-absolute-from-iso
14666 ; (list iso-week day year)))))
14667 (setq month (car iso-date)
14668 year (nth 2 iso-date)
14669 day (nth 1 iso-date)))
14670 (deltan
14671 (setq futurep nil)
14672 (unless deltadef
14673 (let ((now (decode-time (current-time))))
14674 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14675 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14676 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14677 ((equal deltaw "m") (setq month (+ month deltan)))
14678 ((equal deltaw "y") (setq year (+ year deltan)))))
14679 ((and wday (not (nth 3 tl)))
14680 (setq futurep nil)
14681 ;; Weekday was given, but no day, so pick that day in the week
14682 ;; on or after the derived date.
14683 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14684 (unless (equal wday wday1)
14685 (setq day (+ day (% (- wday wday1 -7) 7))))))
14686 (if (and (boundp 'org-time-was-given)
14687 (nth 2 tl))
14688 (setq org-time-was-given t))
14689 (if (< year 100) (setq year (+ 2000 year)))
14690 (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
14691 (setq org-read-date-analyze-futurep futurep)
14692 (list second minute hour day month year)))
14694 (defvar parse-time-weekdays)
14696 (defun org-read-date-get-relative (s today default)
14697 "Check string S for special relative date string.
14698 TODAY and DEFAULT are internal times, for today and for a default.
14699 Return shift list (N what def-flag)
14701 N is the number of WHATs to shift.
14702 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14703 the DEFAULT date rather than TODAY."
14704 (when (and
14705 (string-match
14706 (concat
14711 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14712 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14713 (string-to-char (substring (match-string 1 s) -1))
14714 ?+))
14715 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14716 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14717 (what (if (match-end 3) (match-string 3 s) "d"))
14718 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14719 (date (if rel default today))
14720 (wday (nth 6 (decode-time date)))
14721 delta)
14722 (if wday1
14723 (progn
14724 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14725 (if (= dir ?-) (setq delta (- delta 7)))
14726 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14727 (list delta "d" rel))
14728 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14730 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14731 "Turn a user-specified date into the internal representation.
14732 The internal representation needed by the calendar is (month day year).
14733 This is a wrapper to handle the brain-dead convention in calendar that
14734 user function argument order change dependent on argument order."
14735 (if (boundp 'calendar-date-style)
14736 (cond
14737 ((eq calendar-date-style 'american)
14738 (list arg1 arg2 arg3))
14739 ((eq calendar-date-style 'european)
14740 (list arg2 arg1 arg3))
14741 ((eq calendar-date-style 'iso)
14742 (list arg2 arg3 arg1)))
14743 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
14744 (if (org-bound-and-true-p european-calendar-style)
14745 (list arg2 arg1 arg3)
14746 (list arg1 arg2 arg3)))))
14748 (defun org-eval-in-calendar (form &optional keepdate)
14749 "Eval FORM in the calendar window and return to current window.
14750 Also, store the cursor date in variable org-ans2."
14751 (let ((sf (selected-frame))
14752 (sw (selected-window)))
14753 (select-window (get-buffer-window "*Calendar*" t))
14754 (eval form)
14755 (when (and (not keepdate) (calendar-cursor-to-date))
14756 (let* ((date (calendar-cursor-to-date))
14757 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14758 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
14759 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
14760 (select-window sw)
14761 (org-select-frame-set-input-focus sf)))
14763 (defun org-calendar-select ()
14764 "Return to `org-read-date' with the date currently selected.
14765 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14766 (interactive)
14767 (when (calendar-cursor-to-date)
14768 (let* ((date (calendar-cursor-to-date))
14769 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14770 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14771 (if (active-minibuffer-window) (exit-minibuffer))))
14773 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
14774 "Insert a date stamp for the date given by the internal TIME.
14775 WITH-HM means use the stamp format that includes the time of the day.
14776 INACTIVE means use square brackets instead of angular ones, so that the
14777 stamp will not contribute to the agenda.
14778 PRE and POST are optional strings to be inserted before and after the
14779 stamp.
14780 The command returns the inserted time stamp."
14781 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
14782 stamp)
14783 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
14784 (insert-before-markers (or pre ""))
14785 (when (listp extra)
14786 (setq extra (car extra))
14787 (if (and (stringp extra)
14789 (setq extra (format "-%02d:%02d"
14790 (string-to-number (match-string 1 extra))
14791 (string-to-number (match-string 2 extra))))
14792 (setq extra nil)))
14793 (when extra
14794 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
14795 (insert-before-markers (setq stamp (format-time-string fmt time)))
14796 (insert-before-markers (or post ""))
14797 (setq org-last-inserted-timestamp stamp)))
14799 (defun org-toggle-time-stamp-overlays ()
14800 "Toggle the use of custom time stamp formats."
14801 (interactive)
14802 (setq org-display-custom-times (not org-display-custom-times))
14803 (unless org-display-custom-times
14804 (let ((p (point-min)) (bmp (buffer-modified-p)))
14805 (while (setq p (next-single-property-change p 'display))
14806 (if (and (get-text-property p 'display)
14807 (eq (get-text-property p 'face) 'org-date))
14808 (remove-text-properties
14809 p (setq p (next-single-property-change p 'display))
14810 '(display t))))
14811 (set-buffer-modified-p bmp)))
14812 (if (featurep 'xemacs)
14813 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
14814 (org-restart-font-lock)
14815 (setq org-table-may-need-update t)
14816 (if org-display-custom-times
14817 (message "Time stamps are overlayed with custom format")
14818 (message "Time stamp overlays removed")))
14820 (defun org-display-custom-time (beg end)
14821 "Overlay modified time stamp format over timestamp between BEG and END."
14822 (let* ((ts (buffer-substring beg end))
14823 t1 w1 with-hm tf time str w2 (off 0))
14824 (save-match-data
14825 (setq t1 (org-parse-time-string ts t))
14826 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
14827 (setq off (- (match-end 0) (match-beginning 0)))))
14828 (setq end (- end off))
14829 (setq w1 (- end beg)
14830 with-hm (and (nth 1 t1) (nth 2 t1))
14831 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
14832 time (org-fix-decoded-time t1)
14833 str (org-add-props
14834 (format-time-string
14835 (substring tf 1 -1) (apply 'encode-time time))
14836 nil 'mouse-face 'highlight)
14837 w2 (length str))
14838 (if (not (= w2 w1))
14839 (add-text-properties (1+ beg) (+ 2 beg)
14840 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
14841 (if (featurep 'xemacs)
14842 (progn
14843 (put-text-property beg end 'invisible t)
14844 (put-text-property beg end 'end-glyph (make-glyph str)))
14845 (put-text-property beg end 'display str))))
14847 (defun org-translate-time (string)
14848 "Translate all timestamps in STRING to custom format.
14849 But do this only if the variable `org-display-custom-times' is set."
14850 (when org-display-custom-times
14851 (save-match-data
14852 (let* ((start 0)
14853 (re org-ts-regexp-both)
14854 t1 with-hm inactive tf time str beg end)
14855 (while (setq start (string-match re string start))
14856 (setq beg (match-beginning 0)
14857 end (match-end 0)
14858 t1 (save-match-data
14859 (org-parse-time-string (substring string beg end) t))
14860 with-hm (and (nth 1 t1) (nth 2 t1))
14861 inactive (equal (substring string beg (1+ beg)) "[")
14862 tf (funcall (if with-hm 'cdr 'car)
14863 org-time-stamp-custom-formats)
14864 time (org-fix-decoded-time t1)
14865 str (format-time-string
14866 (concat
14867 (if inactive "[" "<") (substring tf 1 -1)
14868 (if inactive "]" ">"))
14869 (apply 'encode-time time))
14870 string (replace-match str t t string)
14871 start (+ start (length str)))))))
14872 string)
14874 (defun org-fix-decoded-time (time)
14875 "Set 0 instead of nil for the first 6 elements of time.
14876 Don't touch the rest."
14877 (let ((n 0))
14878 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
14880 (defun org-days-to-time (timestamp-string)
14881 "Difference between TIMESTAMP-STRING and now in days."
14882 (- (time-to-days (org-time-string-to-time timestamp-string))
14883 (time-to-days (current-time))))
14885 (defun org-deadline-close (timestamp-string &optional ndays)
14886 "Is the time in TIMESTAMP-STRING close to the current date?"
14887 (setq ndays (or ndays (org-get-wdays timestamp-string)))
14888 (and (< (org-days-to-time timestamp-string) ndays)
14889 (not (org-entry-is-done-p))))
14891 (defun org-get-wdays (ts)
14892 "Get the deadline lead time appropriate for timestring TS."
14893 (cond
14894 ((<= org-deadline-warning-days 0)
14895 ;; 0 or negative, enforce this value no matter what
14896 (- org-deadline-warning-days))
14898 ;; lead time is specified.
14899 (floor (* (string-to-number (match-string 1 ts))
14900 (cdr (assoc (match-string 2 ts)
14901 '(("d" . 1) ("w" . 7)
14902 ("m" . 30.4) ("y" . 365.25)))))))
14903 ;; go for the default.
14904 (t org-deadline-warning-days)))
14906 (defun org-calendar-select-mouse (ev)
14907 "Return to `org-read-date' with the date currently selected.
14908 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14909 (interactive "e")
14910 (mouse-set-point ev)
14911 (when (calendar-cursor-to-date)
14912 (let* ((date (calendar-cursor-to-date))
14913 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14914 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14915 (if (active-minibuffer-window) (exit-minibuffer))))
14917 (defun org-check-deadlines (ndays)
14918 "Check if there are any deadlines due or past due.
14919 A deadline is considered due if it happens within `org-deadline-warning-days'
14920 days from today's date. If the deadline appears in an entry marked DONE,
14921 it is not shown. The prefix arg NDAYS can be used to test that many
14923 (interactive "P")
14924 (let* ((org-warn-days
14925 (cond
14926 ((equal ndays '(4)) 100000)
14927 (ndays (prefix-numeric-value ndays))
14928 (t (abs org-deadline-warning-days))))
14929 (case-fold-search nil)
14931 (callback
14932 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
14934 (message "%d deadlines past-due or due within %d days"
14935 (org-occur regexp nil callback)
14936 org-warn-days)))
14938 (defun org-check-before-date (date)
14939 "Check if there are deadlines or scheduled entries before DATE."
14940 (interactive (list (org-read-date)))
14941 (let ((case-fold-search nil)
14945 (callback
14946 (lambda () (time-less-p
14947 (org-time-string-to-time (match-string 2))
14948 (org-time-string-to-time date)))))
14949 (message "%d entries before %s"
14950 (org-occur regexp nil callback) date)))
14952 (defun org-check-after-date (date)
14953 "Check if there are deadlines or scheduled entries after DATE."
14954 (interactive (list (org-read-date)))
14955 (let ((case-fold-search nil)
14959 (callback
14960 (lambda () (not
14961 (time-less-p
14962 (org-time-string-to-time (match-string 2))
14963 (org-time-string-to-time date))))))
14964 (message "%d entries after %s"
14965 (org-occur regexp nil callback) date)))
14967 (defun org-evaluate-time-range (&optional to-buffer)
14968 "Evaluate a time range by computing the difference between start and end.
14969 Normally the result is just printed in the echo area, but with prefix arg
14970 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
14971 If the time range is actually in a table, the result is inserted into the
14972 next column.
14973 For time difference computation, a year is assumed to be exactly 365
14974 days in order to avoid rounding problems."
14975 (interactive "P")
14976 (or
14977 (org-clock-update-time-maybe)
14978 (save-excursion
14979 (unless (org-at-date-range-p t)
14980 (goto-char (point-at-bol))
14981 (re-search-forward org-tr-regexp-both (point-at-eol) t))
14982 (if (not (org-at-date-range-p t))
14983 (error "Not at a time-stamp range, and none found in current line")))
14984 (let* ((ts1 (match-string 1))
14985 (ts2 (match-string 2))
14986 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
14987 (match-end (match-end 0))
14988 (time1 (org-time-string-to-time ts1))
14989 (time2 (org-time-string-to-time ts2))
14990 (t1 (org-float-time time1))
14991 (t2 (org-float-time time2))
14992 (diff (abs (- t2 t1)))
14993 (negative (< (- t2 t1) 0))
14994 ;; (ys (floor (* 365 24 60 60)))
14995 (ds (* 24 60 60))
14996 (hs (* 60 60))
14997 (fy "%dy %dd %02d:%02d")
14998 (fy1 "%dy %dd")
14999 (fd "%dd %02d:%02d")
15000 (fd1 "%dd")
15001 (fh "%02d:%02d")
15002 y d h m align)
15003 (if havetime
15004 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15005 y 0
15006 d (floor (/ diff ds)) diff (mod diff ds)
15007 h (floor (/ diff hs)) diff (mod diff hs)
15008 m (floor (/ diff 60)))
15009 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15010 y 0
15011 d (floor (+ (/ diff ds) 0.5))
15012 h 0 m 0))
15013 (if (not to-buffer)
15014 (message "%s" (org-make-tdiff-string y d h m))
15015 (if (org-at-table-p)
15016 (progn
15017 (goto-char match-end)
15018 (setq align t)
15019 (and (looking-at " *|") (goto-char (match-end 0))))
15020 (goto-char match-end))
15021 (if (looking-at
15023 (replace-match ""))
15024 (if negative (insert " -"))
15025 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15026 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15027 (insert " " (format fh h m))))
15028 (if align (org-table-align))
15029 (message "Time difference inserted")))))
15031 (defun org-make-tdiff-string (y d h m)
15032 (let ((fmt "")
15033 (l nil))
15034 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15035 l (push y l)))
15036 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15037 l (push d l)))
15038 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15039 l (push h l)))
15040 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15041 l (push m l)))
15042 (apply 'format fmt (nreverse l))))
15044 (defun org-time-string-to-time (s)
15045 (apply 'encode-time (org-parse-time-string s)))
15046 (defun org-time-string-to-seconds (s)
15047 (org-float-time (org-time-string-to-time s)))
15049 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
15050 "Convert a time stamp to an absolute day number.
15051 If there is a specifier for a cyclic time stamp, get the closest date to
15052 DAYNR.
15053 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15054 The variable date is bound by the calendar when this is called."
15055 (cond
15057 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15058 daynr
15059 (+ daynr 1000)))
15061 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15062 (time-to-days (current-time))) (match-string 0 s)
15063 prefer show-all))
15064 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
15066 (defun org-days-to-iso-week (days)
15067 "Return the iso week number."
15068 (require 'cal-iso)
15069 (car (calendar-iso-from-absolute days)))
15071 (defun org-small-year-to-year (year)
15072 "Convert 2-digit years into 4-digit years.
15073 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15074 The year 2000 cannot be abbreviated. Any year larger than 99
15075 is returned unchanged."
15076 (if (< year 38)
15077 (setq year (+ 2000 year))
15078 (if (< year 100)
15079 (setq year (+ 1900 year))))
15080 year)
15082 (defun org-time-from-absolute (d)
15083 "Return the time corresponding to date D.
15084 D may be an absolute day number, or a calendar-type list (month day year)."
15085 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15086 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15088 (defun org-calendar-holiday ()
15089 "List of holidays, for Diary display in Org-mode."
15090 (require 'holidays)
15091 (let ((hl (funcall
15092 (if (fboundp 'calendar-check-holidays)
15093 'calendar-check-holidays 'check-calendar-holidays) date)))
15094 (if hl (mapconcat 'identity hl "; "))))
15096 (defun org-diary-sexp-entry (sexp entry date)
15097 "Process a SEXP diary ENTRY for DATE."
15098 (require 'diary-lib)
15099 (let ((result (if calendar-debug-sexp
15100 (let ((stack-trace-on-error t))
15101 (eval (car (read-from-string sexp))))
15102 (condition-case nil
15103 (eval (car (read-from-string sexp)))
15104 (error
15105 (beep)
15106 (message "Bad sexp at line %d in %s: %s"
15107 (org-current-line)
15108 (buffer-file-name) sexp)
15109 (sleep-for 2))))))
15110 (cond ((stringp result) (split-string result "; "))
15111 ((and (consp result)
15112 (not (consp (cdr result)))
15113 (stringp (cdr result))) (cdr result))
15114 ((and (consp result)
15115 (stringp (car result))) result)
15116 (result entry)
15117 (t nil))))
15119 (defun org-diary-to-ical-string (frombuf)
15120 "Get iCalendar entries from diary entries in buffer FROMBUF.
15121 This uses the icalendar.el library."
15122 (let* ((tmpdir (if (featurep 'xemacs)
15123 (temp-directory)
15124 temporary-file-directory))
15125 (tmpfile (make-temp-name
15126 (expand-file-name "orgics" tmpdir)))
15127 buf rtn b e)
15128 (with-current-buffer frombuf
15129 (icalendar-export-region (point-min) (point-max) tmpfile)
15130 (setq buf (find-buffer-visiting tmpfile))
15131 (set-buffer buf)
15132 (goto-char (point-min))
15133 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15134 (setq b (match-beginning 0)))
15135 (goto-char (point-max))
15136 (if (re-search-backward "^END:VEVENT" nil t)
15137 (setq e (match-end 0)))
15139 (kill-buffer buf)
15140 (delete-file tmpfile)
15141 rtn))
15143 (defun org-closest-date (start current change prefer show-all)
15144 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15145 When PREFER is `past', return a date that is either CURRENT or past.
15146 When PREFER is `future', return a date that is either CURRENT or future.
15147 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15148 ;; Make the proper lists from the dates
15149 (catch 'exit
15150 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15151 dn dw sday cday n1 n2 n0
15152 d m y y1 y2 date1 date2 nmonths nm ny m2)
15154 (setq start (org-date-to-gregorian start)
15155 current (org-date-to-gregorian
15156 (if show-all
15157 current
15158 (time-to-days (current-time))))
15159 sday (calendar-absolute-from-gregorian start)
15160 cday (calendar-absolute-from-gregorian current))
15162 (if (<= cday sday) (throw 'exit sday))
15165 (setq dn (string-to-number (match-string 1 change))
15166 dw (cdr (assoc (match-string 2 change) a1)))
15167 (error "Invalid change specifier: %s" change))
15168 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15169 (cond
15170 ((eq dw 'day)
15171 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15172 n2 (+ n1 dn)))
15173 ((eq dw 'year)
15174 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15175 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15176 (setq date1 (list m d y1)
15177 n1 (calendar-absolute-from-gregorian date1)
15178 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15179 n2 (calendar-absolute-from-gregorian date2)))
15180 ((eq dw 'month)
15181 ;; approx number of month between the two dates
15182 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15183 ;; How often does dn fit in there?
15184 (setq d (nth 1 start) m (car start) y (nth 2 start)
15185 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15186 m (+ m nm)
15187 ny (floor (/ m 12))
15188 y (+ y ny)
15189 m (- m (* ny 12)))
15190 (while (> m 12) (setq m (- m 12) y (1+ y)))
15191 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15192 (setq m2 (+ m dn) y2 y)
15193 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15194 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15195 (while (<= n2 cday)
15196 (setq n1 n2 m m2 y y2)
15197 (setq m2 (+ m dn) y2 y)
15198 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15199 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15200 ;; Make sure n1 is the earlier date
15201 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15202 (if show-all
15203 (cond
15204 ((eq prefer 'past) (if (= cday n2) n2 n1))
15205 ((eq prefer 'future) (if (= cday n1) n1 n2))
15206 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15207 (cond
15208 ((eq prefer 'past) (if (= cday n2) n2 n1))
15209 ((eq prefer 'future) (if (= cday n1) n1 n2))
15210 (t (if (= cday n1) n1 n2)))))))
15212 (defun org-date-to-gregorian (date)
15213 "Turn any specification of DATE into a Gregorian date for the calendar."
15214 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15215 ((and (listp date) (= (length date) 3)) date)
15216 ((stringp date)
15217 (setq date (org-parse-time-string date))
15218 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15219 ((listp date)
15220 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15222 (defun org-parse-time-string (s &optional nodefault)
15223 "Parse the standard Org-mode time string.
15224 This should be a lot faster than the normal `parse-time-string'.
15225 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15226 hour and minute fields will be nil if not given."
15227 (if (string-match org-ts-regexp0 s)
15228 (list 0
15229 (if (or (match-beginning 8) (not nodefault))
15230 (string-to-number (or (match-string 8 s) "0")))
15231 (if (or (match-beginning 7) (not nodefault))
15232 (string-to-number (or (match-string 7 s) "0")))
15233 (string-to-number (match-string 4 s))
15234 (string-to-number (match-string 3 s))
15235 (string-to-number (match-string 2 s))
15236 nil nil nil)
15237 (error "Not a standard Org-mode time string: %s" s)))
15239 (defun org-timestamp-up (&optional arg)
15240 "Increase the date item at the cursor by one.
15241 If the cursor is on the year, change the year. If it is on the month or
15242 the day, change that.
15243 With prefix ARG, change by that many units."
15244 (interactive "p")
15245 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15247 (defun org-timestamp-down (&optional arg)
15248 "Decrease the date item at the cursor by one.
15249 If the cursor is on the year, change the year. If it is on the month or
15250 the day, change that.
15251 With prefix ARG, change by that many units."
15252 (interactive "p")
15253 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15255 (defun org-timestamp-up-day (&optional arg)
15256 "Increase the date in the time stamp by one day.
15257 With prefix ARG, change that many days."
15258 (interactive "p")
15259 (if (and (not (org-at-timestamp-p t))
15260 (org-on-heading-p))
15261 (org-todo 'up)
15262 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15264 (defun org-timestamp-down-day (&optional arg)
15265 "Decrease the date in the time stamp by one day.
15266 With prefix ARG, change that many days."
15267 (interactive "p")
15268 (if (and (not (org-at-timestamp-p t))
15269 (org-on-heading-p))
15270 (org-todo 'down)
15271 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15273 (defun org-at-timestamp-p (&optional inactive-ok)
15274 "Determine if the cursor is in or at a timestamp."
15275 (interactive)
15276 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15277 (pos (point))
15278 (ans (or (looking-at tsr)
15279 (save-excursion
15281 (if (> (point) (point-min)) (backward-char 1))
15282 (and (looking-at tsr)
15283 (> (- (match-end 0) pos) -1))))))
15284 (and ans
15285 (boundp 'org-ts-what)
15286 (setq org-ts-what
15287 (cond
15288 ((= pos (match-beginning 0)) 'bracket)
15289 ((= pos (1- (match-end 0))) 'bracket)
15290 ((org-pos-in-match-range pos 2) 'year)
15291 ((org-pos-in-match-range pos 3) 'month)
15292 ((org-pos-in-match-range pos 7) 'hour)
15293 ((org-pos-in-match-range pos 8) 'minute)
15294 ((or (org-pos-in-match-range pos 4)
15295 (org-pos-in-match-range pos 5)) 'day)
15296 ((and (> pos (or (match-end 8) (match-end 5)))
15297 (< pos (match-end 0)))
15298 (- pos (or (match-end 8) (match-end 5))))
15299 (t 'day))))
15300 ans))
15302 (defun org-toggle-timestamp-type ()
15303 "Toggle the type (<active> or [inactive]) of a time stamp."
15304 (interactive)
15305 (when (org-at-timestamp-p t)
15306 (let ((beg (match-beginning 0)) (end (match-end 0))
15307 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15308 (save-excursion
15309 (goto-char beg)
15310 (while (re-search-forward "[][<>]" end t)
15311 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15312 t t)))
15313 (message "Timestamp is now %sactive"
15314 (if (equal (char-after beg) ?<) "" "in")))))
15316 (defun org-timestamp-change (n &optional what updown)
15317 "Change the date in the time stamp at point.
15318 The date will be changed by N times WHAT. WHAT can be `day', `month',
15319 `year', `minute', `second'. If WHAT is not given, the cursor position
15320 in the timestamp determines what will be changed."
15321 (let ((pos (point))
15322 with-hm inactive
15323 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15324 org-ts-what
15325 extra rem
15326 ts time time0)
15327 (if (not (org-at-timestamp-p t))
15328 (error "Not at a timestamp"))
15329 (if (and (not what) (eq org-ts-what 'bracket))
15330 (org-toggle-timestamp-type)
15331 (if (and (not what) (not (eq org-ts-what 'day))
15332 org-display-custom-times
15333 (get-text-property (point) 'display)
15334 (not (get-text-property (1- (point)) 'display)))
15335 (setq org-ts-what 'day))
15336 (setq org-ts-what (or what org-ts-what)
15337 inactive (= (char-after (match-beginning 0)) ?\[)
15338 ts (match-string 0))
15339 (replace-match "")
15340 (if (string-match
15342 ts)
15343 (setq extra (match-string 1 ts)))
15345 (setq with-hm t))
15346 (setq time0 (org-parse-time-string ts))
15347 (when (and updown
15348 (eq org-ts-what 'minute)
15349 (not current-prefix-arg))
15350 ;; This looks like s-up and s-down. Change by one rounding step.
15351 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15352 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15353 (setcar (cdr time0) (+ (nth 1 time0)
15354 (if (> n 0) (- rem) (- dm rem))))))
15355 (setq time
15356 (encode-time (or (car time0) 0)
15357 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15358 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15359 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15360 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15361 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15362 (nthcdr 6 time0)))
15363 (when (and (member org-ts-what '(hour minute))
15364 extra
15366 (setq extra (org-modify-ts-extra
15367 extra
15368 (if (eq org-ts-what 'hour) 2 5)
15369 n dm)))
15370 (when (integerp org-ts-what)
15371 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15372 (if (eq what 'calendar)
15373 (let ((cal-date (org-get-date-from-calendar)))
15374 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15375 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15376 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15377 (setcar time0 (or (car time0) 0))
15378 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15379 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15380 (setq time (apply 'encode-time time0))))
15381 (setq org-last-changed-timestamp
15382 (org-insert-time-stamp time with-hm inactive nil nil extra))
15383 (org-clock-update-time-maybe)
15384 (goto-char pos)
15385 ;; Try to recenter the calendar window, if any
15386 (if (and org-calendar-follow-timestamp-change
15387 (get-buffer-window "*Calendar*" t)
15388 (memq org-ts-what '(day month year)))
15389 (org-recenter-calendar (time-to-days time))))))
15391 (defun org-modify-ts-extra (s pos n dm)
15392 "Change the different parts of the lead-time and repeat fields in timestamp."
15393 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15394 ng h m new rem)
15395 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15396 (cond
15397 ((or (org-pos-in-match-range pos 2)
15398 (org-pos-in-match-range pos 3))
15399 (setq m (string-to-number (match-string 3 s))
15400 h (string-to-number (match-string 2 s)))
15401 (if (org-pos-in-match-range pos 2)
15402 (setq h (+ h n))
15403 (setq n (* dm (org-no-warnings (signum n))))
15404 (when (not (= 0 (setq rem (% m dm))))
15405 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15406 (setq m (+ m n)))
15407 (if (< m 0) (setq m (+ m 60) h (1- h)))
15408 (if (> m 59) (setq m (- m 60) h (1+ h)))
15409 (setq h (min 24 (max 0 h)))
15410 (setq ng 1 new (format "-%02d:%02d" h m)))
15411 ((org-pos-in-match-range pos 6)
15412 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15413 ((org-pos-in-match-range pos 5)
15414 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15416 ((org-pos-in-match-range pos 9)
15417 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15418 ((org-pos-in-match-range pos 8)
15419 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15421 (when ng
15422 (setq s (concat
15423 (substring s 0 (match-beginning ng))
15424 new
15425 (substring s (match-end ng))))))
15426 s))
15428 (defun org-recenter-calendar (date)
15429 "If the calendar is visible, recenter it to DATE."
15430 (let* ((win (selected-window))
15431 (cwin (get-buffer-window "*Calendar*" t))
15432 (calendar-move-hook nil))
15433 (when cwin
15434 (select-window cwin)
15435 (calendar-goto-date (if (listp date) date
15436 (calendar-gregorian-from-absolute date)))
15437 (select-window win))))
15439 (defun org-goto-calendar (&optional arg)
15440 "Go to the Emacs calendar at the current date.
15441 If there is a time stamp in the current line, go to that date.
15442 A prefix ARG can be used to force the current date."
15443 (interactive "P")
15444 (let ((tsr org-ts-regexp) diff
15445 (calendar-move-hook nil)
15446 (calendar-view-holidays-initially-flag nil)
15447 (calendar-view-diary-initially-flag nil))
15448 (if (or (org-at-timestamp-p)
15449 (save-excursion
15450 (beginning-of-line 1)
15451 (looking-at (concat ".*" tsr))))
15452 (let ((d1 (time-to-days (current-time)))
15453 (d2 (time-to-days
15454 (org-time-string-to-time (match-string 1)))))
15455 (setq diff (- d2 d1))))
15456 (calendar)
15457 (calendar-goto-today)
15458 (if (and diff (not arg)) (calendar-forward-day diff))))
15460 (defun org-get-date-from-calendar ()
15461 "Return a list (month day year) of date at point in calendar."
15462 (with-current-buffer "*Calendar*"
15463 (save-match-data
15464 (calendar-cursor-to-date))))
15466 (defun org-date-from-calendar ()
15467 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15468 If there is already a time stamp at the cursor position, update it."
15469 (interactive)
15470 (if (org-at-timestamp-p t)
15471 (org-timestamp-change 0 'calendar)
15472 (let ((cal-date (org-get-date-from-calendar)))
15473 (org-insert-time-stamp
15474 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15476 (defun org-minutes-to-hh:mm-string (m)
15477 "Compute H:MM from a number of minutes."
15478 (let ((h (/ m 60)))
15479 (setq m (- m (* 60 h)))
15480 (format org-time-clocksum-format h m)))
15482 (defun org-hh:mm-string-to-minutes (s)
15483 "Convert a string H:MM to a number of minutes.
15484 If the string is just a number, interpret it as minutes.
15485 In fact, the first hh:mm or number in the string will be taken,
15486 there can be extra stuff in the string.
15487 If no number is found, the return value is 0."
15488 (cond
15490 (+ (* (string-to-number (match-string 1 s)) 60)
15491 (string-to-number (match-string 2 s))))
15493 (string-to-number (match-string 1 s)))
15494 (t 0)))
15496 ;;;; Files
15498 (defun org-save-all-org-buffers ()
15499 "Save all Org-mode buffers without user confirmation."
15500 (interactive)
15501 (message "Saving all Org-mode buffers...")
15502 (save-some-buffers t 'org-mode-p)
15503 (when (featurep 'org-id) (org-id-locations-save))
15504 (message "Saving all Org-mode buffers... done"))
15506 (defun org-revert-all-org-buffers ()
15507 "Revert all Org-mode buffers.
15508 Prompt for confirmation when there are unsaved changes.
15509 Be sure you know what you are doing before letting this function
15510 overwrite your changes.
15512 This function is useful in a setup where one tracks org files
15513 with a version control system, to revert on one machine after pulling
15514 changes from another. I believe the procedure must be like this:
15516 1. M-x org-save-all-org-buffers
15517 2. Pull changes from the other machine, resolve conflicts
15518 3. M-x org-revert-all-org-buffers"
15519 (interactive)
15520 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15521 (error "Abort"))
15522 (save-excursion
15523 (save-window-excursion
15524 (mapc
15525 (lambda (b)
15526 (when (and (with-current-buffer b (org-mode-p))
15527 (with-current-buffer b buffer-file-name))
15528 (switch-to-buffer b)
15529 (revert-buffer t 'no-confirm)))
15530 (buffer-list))
15531 (when (and (featurep 'org-id) org-id-track-globally)
15532 (org-id-locations-load)))))
15534 ;;;; Agenda files
15536 ;;;###autoload
15537 (defun org-switchb (&optional arg)
15538 "Switch between Org buffers.
15539 With a prefix argument, restrict available to files.
15540 With two prefix arguments, restrict available buffers to agenda files.
15542 Defaults to `iswitchb' for buffer name completion.
15543 Set `org-completion-use-ido' to make it use ido instead."
15544 (interactive "P")
15545 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15546 ((equal arg '(16)) (org-buffer-list 'agenda))
15547 (t (org-buffer-list))))
15548 (org-completion-use-iswitchb org-completion-use-iswitchb)
15549 (org-completion-use-ido org-completion-use-ido))
15550 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15551 (setq org-completion-use-iswitchb t))
15552 (switch-to-buffer
15553 (org-icompleting-read "Org buffer: "
15554 (mapcar 'list (mapcar 'buffer-name blist))
15555 nil t))))
15557 ;;; Define some older names previously used for this functionality
15558 ;;;###autoload
15559 (defalias 'org-ido-switchb 'org-switchb)
15560 ;;;###autoload
15561 (defalias 'org-iswitchb 'org-switchb)
15563 (defun org-buffer-list (&optional predicate exclude-tmp)
15564 "Return a list of Org buffers.
15565 PREDICATE can be `export', `files' or `agenda'.
15567 export restrict the list to Export buffers.
15568 files restrict the list to buffers visiting Org files.
15569 agenda restrict the list to buffers visiting agenda files.
15571 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15572 (let* ((bfn nil)
15573 (agenda-files (and (eq predicate 'agenda)
15574 (mapcar 'file-truename (org-agenda-files t))))
15575 (filter
15576 (cond
15577 ((eq predicate 'files)
15578 (lambda (b) (with-current-buffer b (org-mode-p))))
15579 ((eq predicate 'export)
15580 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15581 ((eq predicate 'agenda)
15582 (lambda (b)
15583 (with-current-buffer b
15584 (and (org-mode-p)
15585 (setq bfn (buffer-file-name b))
15586 (member (file-truename bfn) agenda-files)))))
15587 (t (lambda (b) (with-current-buffer b
15588 (or (org-mode-p)
15589 (string-match "\*Org .*Export"
15590 (buffer-name b)))))))))
15591 (delq nil
15592 (mapcar
15593 (lambda(b)
15594 (if (and (funcall filter b)
15595 (or (not exclude-tmp)
15596 (not (string-match "tmp" (buffer-name b)))))
15597 b
15598 nil))
15599 (buffer-list)))))
15601 (defun org-agenda-files (&optional unrestricted archives)
15602 "Get the list of agenda files.
15603 Optional UNRESTRICTED means return the full list even if a restriction
15604 is currently in place.
15605 When ARCHIVES is t, include all archive files that are really being
15606 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15607 `org-agenda-archives-mode' is t."
15608 (let ((files
15609 (cond
15610 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15611 ((stringp org-agenda-files) (org-read-agenda-file-list))
15612 ((listp org-agenda-files) org-agenda-files)
15613 (t (error "Invalid value of `org-agenda-files'")))))
15614 (setq files (apply 'append
15615 (mapcar (lambda (f)
15616 (if (file-directory-p f)
15617 (directory-files
15618 f t org-agenda-file-regexp)
15619 (list f)))
15620 files)))
15621 (when org-agenda-skip-unavailable-files
15622 (setq files (delq nil
15623 (mapcar (function
15624 (lambda (file)
15625 (and (file-readable-p file) file)))
15626 files))))
15627 (when (or (eq archives t)
15628 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15629 (setq files (org-add-archive-files files)))
15630 files))
15632 (defun org-agenda-file-p (&optional file)
15633 "Return non-nil, if FILE is an agenda file.
15634 If FILE is omitted, use the file associated with the current
15635 buffer."
15636 (member (or file (buffer-file-name))
15637 (org-agenda-files t)))
15639 (defun org-edit-agenda-file-list ()
15640 "Edit the list of agenda files.
15641 Depending on setup, this either uses customize to edit the variable
15642 `org-agenda-files', or it visits the file that is holding the list. In the
15643 latter case, the buffer is set up in a way that saving it automatically kills
15644 the buffer and restores the previous window configuration."
15645 (interactive)
15646 (if (stringp org-agenda-files)
15647 (let ((cw (current-window-configuration)))
15648 (find-file org-agenda-files)
15649 (org-set-local 'org-window-configuration cw)
15650 (org-add-hook 'after-save-hook
15651 (lambda ()
15652 (set-window-configuration
15653 (prog1 org-window-configuration
15654 (kill-buffer (current-buffer))))
15655 (org-install-agenda-files-menu)
15656 (message "New agenda file list installed"))
15657 nil 'local)
15658 (message "%s" (substitute-command-keys
15660 (customize-variable 'org-agenda-files)))
15662 (defun org-store-new-agenda-file-list (list)
15663 "Set new value for the agenda file list and save it correctly."
15664 (if (stringp org-agenda-files)
15665 (let ((fe (org-read-agenda-file-list t)) b u)
15666 (while (setq b (find-buffer-visiting org-agenda-files))
15667 (kill-buffer b))
15668 (with-temp-file org-agenda-files
15669 (insert
15670 (mapconcat
15671 (lambda (f) ;; Keep un-expanded entries.
15672 (if (setq u (assoc f fe))
15673 (cdr u)
15674 f))
15677 (let ((org-mode-hook nil) (org-inhibit-startup t)
15678 (org-insert-mode-line-in-empty-file nil))
15679 (setq org-agenda-files list)
15680 (customize-save-variable 'org-agenda-files org-agenda-files))))
15682 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15683 "Read the list of agenda files from a file.
15684 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15685 filenames, used by `org-store-new-agenda-file-list' to write back
15686 un-expanded file names."
15687 (when (file-directory-p org-agenda-files)
15688 (error "`org-agenda-files' cannot be a single directory"))
15689 (when (stringp org-agenda-files)
15690 (with-temp-buffer
15691 (insert-file-contents org-agenda-files)
15692 (mapcar
15693 (lambda (f)
15694 (let ((e (expand-file-name (substitute-in-file-name f)
15695 org-directory)))
15696 (if pair-with-expansion
15697 (cons e f)
15698 e)))
15701 ;;;###autoload
15702 (defun org-cycle-agenda-files ()
15703 "Cycle through the files in `org-agenda-files'.
15704 If the current buffer visits an agenda file, find the next one in the list.
15705 If the current buffer does not, find the first agenda file."
15706 (interactive)
15707 (let* ((fs (org-agenda-files t))
15708 (files (append fs (list (car fs))))
15709 (tcf (if buffer-file-name (file-truename buffer-file-name)))
15710 file)
15711 (unless files (error "No agenda files"))
15712 (catch 'exit
15713 (while (setq file (pop files))
15714 (if (equal (file-truename file) tcf)
15715 (when (car files)
15716 (find-file (car files))
15717 (throw 'exit t))))
15718 (find-file (car fs)))
15719 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
15721 (defun org-agenda-file-to-front (&optional to-end)
15722 "Move/add the current file to the top of the agenda file list.
15723 If the file is not present in the list, it is added to the front. If it is
15724 present, it is moved there. With optional argument TO-END, add/move to the
15725 end of the list."
15726 (interactive "P")
15727 (let ((org-agenda-skip-unavailable-files nil)
15728 (file-alist (mapcar (lambda (x)
15729 (cons (file-truename x) x))
15730 (org-agenda-files t)))
15731 (ctf (file-truename buffer-file-name))
15732 x had)
15733 (setq x (assoc ctf file-alist) had x)
15735 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
15736 (if to-end
15737 (setq file-alist (append (delq x file-alist) (list x)))
15738 (setq file-alist (cons x (delq x file-alist))))
15739 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
15740 (org-install-agenda-files-menu)
15741 (message "File %s to %s of agenda file list"
15742 (if had "moved" "added") (if to-end "end" "front"))))
15744 (defun org-remove-file (&optional file)
15745 "Remove current file from the list of files in variable `org-agenda-files'.
15746 These are the files which are being checked for agenda entries.
15747 Optional argument FILE means use this file instead of the current."
15748 (interactive)
15749 (let* ((org-agenda-skip-unavailable-files nil)
15750 (file (or file buffer-file-name))
15751 (true-file (file-truename file))
15752 (afile (abbreviate-file-name file))
15753 (files (delq nil (mapcar
15754 (lambda (x)
15755 (if (equal true-file
15756 (file-truename x))
15757 nil x))
15758 (org-agenda-files t)))))
15759 (if (not (= (length files) (length (org-agenda-files t))))
15760 (progn
15761 (org-store-new-agenda-file-list files)
15762 (org-install-agenda-files-menu)
15763 (message "Removed file: %s" afile))
15764 (message "File was not in list: %s (not removed)" afile))))
15766 (defun org-file-menu-entry (file)
15767 (vector file (list 'find-file file) t))
15769 (defun org-check-agenda-file (file)
15770 "Make sure FILE exists. If not, ask user what to do."
15771 (when (not (file-exists-p file))
15772 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
15773 (abbreviate-file-name file))
15774 (let ((r (downcase (read-char-exclusive))))
15775 (cond
15776 ((equal r ?r)
15777 (org-remove-file file)
15778 (throw 'nextfile t))
15779 (t (error "Abort"))))))
15781 (defun org-get-agenda-file-buffer (file)
15782 "Get a buffer visiting FILE. If the buffer needs to be created, add
15783 it to the list of buffers which might be released later."
15784 (let ((buf (org-find-base-buffer-visiting file)))
15785 (if buf
15786 buf ; just return it
15787 ;; Make a new buffer and remember it
15788 (setq buf (find-file-noselect file))
15789 (if buf (push buf org-agenda-new-buffers))
15790 buf)))
15792 (defun org-release-buffers (blist)
15793 "Release all buffers in list, asking the user for confirmation when needed.
15794 When a buffer is unmodified, it is just killed. When modified, it is saved
15795 \(if the user agrees) and then killed."
15796 (let (buf file)
15797 (while (setq buf (pop blist))
15798 (setq file (buffer-file-name buf))
15799 (when (and (buffer-modified-p buf)
15800 file
15801 (y-or-n-p (format "Save file %s? " file)))
15802 (with-current-buffer buf (save-buffer)))
15803 (kill-buffer buf))))
15805 (defun org-prepare-agenda-buffers (files)
15806 "Create buffers for all agenda files, protect archived trees and comments."
15807 (interactive)
15808 (let ((pa '(:org-archived t))
15809 (pc '(:org-comment t))
15810 (pall '(:org-archived t :org-comment t))
15811 (inhibit-read-only t)
15812 (rea (concat ":" org-archive-tag ":"))
15813 bmp file re)
15814 (save-excursion
15815 (save-restriction
15816 (while (setq file (pop files))
15817 (catch 'nextfile
15818 (if (bufferp file)
15819 (set-buffer file)
15820 (org-check-agenda-file file)
15821 (set-buffer (org-get-agenda-file-buffer file)))
15822 (widen)
15823 (setq bmp (buffer-modified-p))
15824 (org-refresh-category-properties)
15825 (setq org-todo-keywords-for-agenda
15826 (append org-todo-keywords-for-agenda org-todo-keywords-1))
15827 (setq org-done-keywords-for-agenda
15828 (append org-done-keywords-for-agenda org-done-keywords))
15829 (setq org-todo-keyword-alist-for-agenda
15830 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
15831 (setq org-drawers-for-agenda
15832 (append org-drawers-for-agenda org-drawers))
15833 (setq org-tag-alist-for-agenda
15834 (append org-tag-alist-for-agenda org-tag-alist))
15836 (save-excursion
15837 (remove-text-properties (point-min) (point-max) pall)
15838 (when org-agenda-skip-archived-trees
15839 (goto-char (point-min))
15840 (while (re-search-forward rea nil t)
15841 (if (org-on-heading-p t)
15842 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
15843 (goto-char (point-min))
15845 (while (re-search-forward re nil t)
15846 (add-text-properties
15847 (match-beginning 0) (org-end-of-subtree t) pc)))
15848 (set-buffer-modified-p bmp)))))
15849 (setq org-todo-keywords-for-agenda
15850 (org-uniquify org-todo-keywords-for-agenda))
15851 (setq org-todo-keyword-alist-for-agenda
15852 (org-uniquify org-todo-keyword-alist-for-agenda)
15853 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
15855 ;;;; Embedded LaTeX
15857 (defvar org-cdlatex-mode-map (make-sparse-keymap)
15858 "Keymap for the minor `org-cdlatex-mode'.")
15860 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
15861 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
15862 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
15863 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
15864 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
15866 (defvar org-cdlatex-texmathp-advice-is-done nil
15867 "Flag remembering if we have applied the advice to texmathp already.")
15869 (define-minor-mode org-cdlatex-mode
15870 "Toggle the minor `org-cdlatex-mode'.
15871 This mode supports entering LaTeX environment and math in LaTeX fragments
15872 in Org-mode.
15874 nil " OCDL" nil
15875 (when org-cdlatex-mode (require 'cdlatex))
15876 (unless org-cdlatex-texmathp-advice-is-done
15877 (setq org-cdlatex-texmathp-advice-is-done t)
15878 (defadvice texmathp (around org-math-always-on activate)
15879 "Always return t in org-mode buffers.
15880 This is because we want to insert math symbols without dollars even outside
15881 the LaTeX math segments. If Orgmode thinks that point is actually inside
15882 an embedded LaTeX fragment, let texmathp do its job.
15884 (interactive)
15885 (let (p)
15886 (cond
15887 ((not (org-mode-p)) ad-do-it)
15888 ((eq this-command 'cdlatex-math-symbol)
15889 (setq ad-return-value t
15890 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
15891 (t
15892 (let ((p (org-inside-LaTeX-fragment-p)))
15893 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
15894 (setq ad-return-value t
15895 texmathp-why '("Org-mode embedded math" . 0))
15896 (if p ad-do-it)))))))))
15898 (defun turn-on-org-cdlatex ()
15899 "Unconditionally turn on `org-cdlatex-mode'."
15900 (org-cdlatex-mode 1))
15902 (defun org-inside-LaTeX-fragment-p ()
15903 "Test if point is inside a LaTeX fragment.
15905 sequence appearing also before point.
15906 Even though the matchers for math are configurable, this function assumes
15908 delimiters are skipped when they have been removed by customization.
15909 The return value is nil, or a cons cell with the delimiter and
15910 and the position of this delimiter.
15912 This function does a reasonably good job, but can locally be fooled by
15913 for example currency specifications. For example it will assume being in
15915 fragments that are properly closed, but during editing, we have to live
15916 with the uncertainty caused by missing closing delimiters. This function
15917 looks only before point, not after."
15918 (catch 'exit
15919 (let ((pos (point))
15920 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
15921 (lim (progn
15923 (point)))
15924 dd-on str (start 0) m re)
15925 (goto-char pos)
15926 (when dodollar
15928 re (nth 1 (assoc "$" org-latex-regexps)))
15929 (while (string-match re str start)
15930 (cond
15931 ((= (match-end 0) (length str))
15932 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
15933 ((= (match-end 0) (- (length str) 5))
15934 (throw 'exit nil))
15935 (t (setq start (match-end 0))))))
15936 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
15937 (goto-char pos)
15938 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
15939 (and (match-beginning 2) (throw 'exit nil))
15940 ;; count $$
15942 (setq dd-on (not dd-on)))
15943 (goto-char pos)
15944 (if dd-on (cons "$$" m))))))
15946 (defun org-inside-latex-macro-p ()
15947 "Is point inside a LaTeX macro or its arguments?"
15948 (save-match-data
15949 (org-in-regexp
15952 (defun org-try-cdlatex-tab ()
15953 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15954 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15955 - inside a LaTeX fragment, or
15956 - after the first word in a line, where an abbreviation expansion could
15957 insert a LaTeX environment."
15958 (when org-cdlatex-mode
15959 (cond
15960 ((save-excursion
15961 (skip-chars-backward "a-zA-Z0-9*")
15963 (bolp))
15964 (cdlatex-tab) t)
15965 ((org-inside-LaTeX-fragment-p)
15966 (cdlatex-tab) t)
15967 (t nil))))
15969 (defun org-cdlatex-underscore-caret (&optional arg)
15970 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15971 Revert to the normal definition outside of these fragments."
15972 (interactive "P")
15973 (if (org-inside-LaTeX-fragment-p)
15974 (call-interactively 'cdlatex-sub-superscript)
15975 (let (org-cdlatex-mode)
15976 (call-interactively (key-binding (vector last-input-event))))))
15978 (defun org-cdlatex-math-modify (&optional arg)
15979 "Execute `cdlatex-math-modify' in LaTeX fragments.
15980 Revert to the normal definition outside of these fragments."
15981 (interactive "P")
15982 (if (org-inside-LaTeX-fragment-p)
15983 (call-interactively 'cdlatex-math-modify)
15984 (let (org-cdlatex-mode)
15985 (call-interactively (key-binding (vector last-input-event))))))
15987 (defvar org-latex-fragment-image-overlays nil
15988 "List of overlays carrying the images of latex fragments.")
15989 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
15991 (defun org-remove-latex-fragment-image-overlays ()
15992 "Remove all overlays with LaTeX fragment images in current buffer."
15993 (mapc 'delete-overlay org-latex-fragment-image-overlays)
15994 (setq org-latex-fragment-image-overlays nil))
15996 (defun org-preview-latex-fragment (&optional subtree)
15997 "Preview the LaTeX fragment at point, or all locally or globally.
15998 If the cursor is in a LaTeX fragment, create the image and overlay
15999 it over the source code. If there is no fragment at point, display
16000 all fragments in the current text, from one headline to the next. With
16001 prefix SUBTREE, display all fragments in the current subtree. With a
16003 the cursor is before the first headline,
16004 display all fragments in the buffer.
16006 (interactive "P")
16007 (org-remove-latex-fragment-image-overlays)
16008 (save-excursion
16009 (save-restriction
16010 (let (beg end at msg)
16011 (cond
16012 ((or (equal subtree '(16))
16013 (not (save-excursion
16014 (re-search-backward (concat "^" outline-regexp) nil t))))
16015 (setq beg (point-min) end (point-max)
16016 msg "Creating images for buffer...%s"))
16017 ((equal subtree '(4))
16018 (org-back-to-heading)
16019 (setq beg (point) end (org-end-of-subtree t)
16020 msg "Creating images for subtree...%s"))
16021 (t
16022 (if (setq at (org-inside-LaTeX-fragment-p))
16023 (goto-char (max (point-min) (- (cdr at) 2)))
16024 (org-back-to-heading))
16025 (setq beg (point) end (progn (outline-next-heading) (point))
16026 msg (if at "Creating image...%s"
16027 "Creating images for entry...%s"))))
16028 (message msg "")
16029 (narrow-to-region beg end)
16030 (goto-char beg)
16031 (org-format-latex
16032 (concat "ltxpng/" (file-name-sans-extension
16033 (file-name-nondirectory
16034 buffer-file-name)))
16035 default-directory 'overlays msg at 'forbuffer 'dvipng)
16036 (message msg "done. Use `C-c C-c' to remove images.")))))
16038 (defvar org-latex-regexps
16040 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16043 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16047 "Regular expressions for matching embedded LaTeX.")
16049 (defvar org-export-have-math nil) ;; dynamic scoping
16050 (defun org-format-latex (prefix &optional dir overlays msg at
16051 forbuffer processing-type)
16052 "Replace LaTeX fragments with links to an image, and produce images.
16053 Some of the options can be changed using the variable
16054 `org-format-latex-options'."
16055 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16056 (let* ((prefixnodir (file-name-nondirectory prefix))
16057 (absprefix (expand-file-name prefix dir))
16058 (todir (file-name-directory absprefix))
16059 (opt org-format-latex-options)
16060 (matchers (plist-get opt :matchers))
16061 (re-list org-latex-regexps)
16062 (org-format-latex-header-extra
16063 (plist-get (org-infile-export-plist) :latex-header-extra))
16064 (cnt 0) txt hash link beg end re e checkdir
16065 executables-checked string
16066 m n block linkfile movefile ov)
16067 ;; Check the different regular expressions
16068 (while (setq e (pop re-list))
16069 (setq m (car e) re (nth 1 e) n (nth 2 e)
16071 (when (member m matchers)
16072 (goto-char (point-min))
16073 (while (re-search-forward re nil t)
16074 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16075 (not (get-text-property (match-beginning n)
16076 'org-protected))
16077 (or (not overlays)
16078 (not (eq (get-char-property (match-beginning n)
16079 'org-overlay-type)
16080 'org-latex-overlay))))
16081 (setq org-export-have-math t)
16082 (cond
16083 ((eq processing-type 'verbatim)
16084 ;; Leave the text verbatim, just protect it
16085 (add-text-properties (match-beginning n) (match-end n)
16086 '(org-protected t)))
16087 ((eq processing-type 'mathjax)
16088 ;; Prepare for MathJax processing
16089 (setq string (match-string n))
16090 (if (member m '("$" "$1"))
16091 (save-excursion
16092 (delete-region (match-beginning n) (match-end n))
16093 (goto-char (match-beginning n))
16096 '(org-protected t))))
16097 (add-text-properties (match-beginning n) (match-end n)
16098 '(org-protected t))))
16099 ((or (eq processing-type 'dvipng) t)
16100 ;; Process to an image
16101 (setq txt (match-string n)
16102 beg (match-beginning n) end (match-end n)
16103 cnt (1+ cnt))
16104 (let (print-length print-level) ; make sure full list is printed
16105 (setq hash (sha1 (prin1-to-string
16106 (list org-format-latex-header
16107 org-format-latex-header-extra
16108 org-export-latex-default-packages-alist
16109 org-export-latex-packages-alist
16110 org-format-latex-options
16111 forbuffer txt)))
16112 linkfile (format "%s_%s.png" prefix hash)
16113 movefile (format "%s_%s.png" absprefix hash)))
16114 (setq link (concat block "[[file:" linkfile "]]" block))
16115 (if msg (message msg cnt))
16116 (goto-char beg)
16117 (unless checkdir ; make sure the directory exists
16118 (setq checkdir t)
16119 (or (file-directory-p todir) (make-directory todir t)))
16121 (unless executables-checked
16122 (org-check-external-command
16123 "latex" "needed to convert LaTeX fragments to images")
16124 (org-check-external-command
16125 "dvipng" "needed to convert LaTeX fragments to images")
16126 (setq executables-checked t))
16128 (unless (file-exists-p movefile)
16129 (org-create-formula-image
16130 txt movefile opt forbuffer))
16131 (if overlays
16132 (progn
16133 (mapc (lambda (o)
16134 (if (eq (overlay-get o 'org-overlay-type)
16135 'org-latex-overlay)
16136 (delete-overlay o)))
16137 (overlays-in beg end))
16138 (setq ov (make-overlay beg end))
16139 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16140 (if (featurep 'xemacs)
16141 (progn
16142 (overlay-put ov 'invisible t)
16143 (overlay-put
16144 ov 'end-glyph
16145 (make-glyph (vector 'png :file movefile))))
16146 (overlay-put
16147 ov 'display
16148 (list 'image :type 'png :file movefile :ascent 'center)))
16149 (push ov org-latex-fragment-image-overlays)
16150 (goto-char end))
16151 (delete-region beg end)
16152 (insert (org-add-props link
16153 (list 'org-latex-src
16154 (replace-regexp-in-string
16157 ;; This function borrows from Ganesh Swami's latex2png.el
16158 (defun org-create-formula-image (string tofile options buffer)
16159 "This calls dvipng."
16160 (require 'org-latex)
16161 (let* ((tmpdir (if (featurep 'xemacs)
16162 (temp-directory)
16163 temporary-file-directory))
16164 (texfilebase (make-temp-name
16165 (expand-file-name "orgtex" tmpdir)))
16166 (texfile (concat texfilebase ".tex"))
16167 (dvifile (concat texfilebase ".dvi"))
16168 (pngfile (concat texfilebase ".png"))
16169 (fnh (if (featurep 'xemacs)
16170 (font-height (get-face-font 'default))
16171 (face-attribute 'default :height nil)))
16172 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16173 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16174 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16175 "Black"))
16176 (bg (or (plist-get options (if buffer :background :html-background))
16177 "Transparent")))
16178 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16179 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16180 (with-temp-file texfile
16181 (insert (org-splice-latex-header
16182 org-format-latex-header
16183 org-export-latex-default-packages-alist
16184 org-export-latex-packages-alist t
16185 org-format-latex-header-extra))
16187 (require 'org-latex)
16188 (org-export-latex-fix-inputenc))
16189 (let ((dir default-directory))
16190 (condition-case nil
16191 (progn
16192 (cd tmpdir)
16193 (call-process "latex" nil nil nil texfile))
16194 (error nil))
16195 (cd dir))
16196 (if (not (file-exists-p dvifile))
16197 (progn (message "Failed to create dvi file from %s" texfile) nil)
16198 (condition-case nil
16199 (call-process "dvipng" nil nil nil
16200 "-fg" fg "-bg" bg
16201 "-D" dpi
16202 ;;"-x" scale "-y" scale
16203 "-T" "tight"
16204 "-o" pngfile
16205 dvifile)
16206 (error nil))
16207 (if (not (file-exists-p pngfile))
16208 (if org-format-latex-signal-error
16209 (error "Failed to create png file from %s" texfile)
16210 (message "Failed to create png file from %s" texfile)
16211 nil)
16212 ;; Use the requested file name and clean up
16213 (copy-file pngfile tofile 'replace)
16214 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16215 (delete-file (concat texfilebase e)))
16216 pngfile))))
16218 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16219 "Fill a LaTeX header template TPL.
16220 In the template, the following place holders will be recognized:
16223 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16225 [NO-PACKAGES] do not include PKG
16226 [EXTRA] the string EXTRA
16227 [NO-EXTRA] do not include EXTRA
16229 For backward compatibility, if both the positive and the negative place
16231 assumed to be present at the end of the template.
16232 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16233 EXTRA is a string.
16234 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16235 (let (rpl (end ""))
16237 (setq rpl (if (or (match-end 1) (not def-pkg))
16238 "" (org-latex-packages-to-string def-pkg snippets-p t))
16239 tpl (replace-match rpl t t tpl))
16240 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16243 (setq rpl (if (or (match-end 1) (not pkg))
16244 "" (org-latex-packages-to-string pkg snippets-p t))
16245 tpl (replace-match rpl t t tpl))
16246 (if pkg (setq end
16248 (org-latex-packages-to-string pkg snippets-p)))))
16251 (setq rpl (if (or (match-end 1) (not extra))
16253 tpl (replace-match rpl t t tpl))
16259 tpl)))
16261 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16263 (setq pkg (mapconcat (lambda(p)
16264 (cond
16265 ((stringp p) p)
16266 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16267 (format "%% Package %s omitted" (cadr p)))
16268 ((equal "" (car p))
16270 (t
16272 (car p) (cadr p)))))
16273 pkg
16277 (defun org-dvipng-color (attr)
16278 "Return an rgb color specification for dvipng."
16279 (apply 'format "rgb %s %s %s"
16280 (mapcar 'org-normalize-color
16281 (color-values (face-attribute 'default attr nil)))))
16283 (defun org-normalize-color (value)
16284 "Return string to be used as color value for an RGB component."
16285 (format "%g" (/ value 65535.0)))
16287 ;; Image display
16290 (defvar org-inline-image-overlays nil)
16291 (make-variable-buffer-local 'org-inline-image-overlays)
16293 (defun org-toggle-inline-images (&optional include-linked)
16294 "Toggle the display of inline images.
16295 INCLUDE-LINKED is passed to `org-display-inline-images'."
16296 (interactive "P")
16297 (if org-inline-image-overlays
16298 (progn
16299 (org-remove-inline-images)
16300 (message "Inline image display turned off"))
16301 (org-display-inline-images include-linked)
16302 (if org-inline-image-overlays
16303 (message "%d images displayed inline"
16304 (length org-inline-image-overlays))
16305 (message "No images to display inline"))))
16307 (defun org-display-inline-images (&optional include-linked refresh beg end)
16308 "Display inline images.
16309 Normally only links without a description part are inlined, because this
16310 is how it will work for export. When INCLUDE-LINKED is set, also links
16311 with a description part will be inlined. This can be nice for a quick
16312 look at those images, but it does not reflect what exported files will look
16313 like.
16314 When REFRESH is set, refresh existing images between BEG and END.
16315 This will create new image displays only if necessary.
16316 BEG and END default to the buffer boundaries."
16317 (interactive "P")
16318 (unless refresh
16319 (org-remove-inline-images)
16320 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16321 (save-excursion
16322 (save-restriction
16323 (widen)
16324 (setq beg (or beg (point-min)) end (or end (point-max)))
16325 (goto-char (point-min))
16327 (substring (org-image-file-name-regexp) 0 -2)
16329 old file ov img)
16330 (while (re-search-forward re end t)
16331 (setq old (get-char-property-and-overlay (match-beginning 1)
16332 'org-image-overlay))
16333 (setq file (expand-file-name
16334 (concat (or (match-string 3) "") (match-string 4))))
16335 (when (file-exists-p file)
16336 (if (and (car-safe old) refresh)
16337 (image-refresh (overlay-get (cdr old) 'display))
16338 (setq img (save-match-data (create-image file)))
16339 (when img
16340 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16341 (overlay-put ov 'display img)
16342 (overlay-put ov 'face 'default)
16343 (overlay-put ov 'org-image-overlay t)
16344 (overlay-put ov 'modification-hooks
16345 (list 'org-display-inline-modification-hook))
16346 (push ov org-inline-image-overlays)))))))))
16348 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16349 "Remove inline-display overlay if a corresponding region is modified."
16350 (let ((inhibit-modification-hooks t))
16351 (when (and ov after)
16352 (delete ov org-inline-image-overlays)
16353 (delete-overlay ov))))
16355 (defun org-remove-inline-images ()
16356 "Remove inline display of images."
16357 (interactive)
16358 (mapc 'delete-overlay org-inline-image-overlays)
16359 (setq org-inline-image-overlays nil))
16361 ;;;; Key bindings
16363 ;; Make `C-c C-x' a prefix key
16364 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16366 ;; TAB key with modifiers
16367 (org-defkey org-mode-map "\C-i" 'org-cycle)
16368 (org-defkey org-mode-map [(tab)] 'org-cycle)
16369 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16370 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16372 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16373 ;; The following line is necessary under Suse GNU/Linux
16374 (unless (featurep 'xemacs)
16375 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16376 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16377 (define-key org-mode-map [backtab] 'org-shifttab)
16379 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16380 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16381 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16383 ;; Cursor keys with modifiers
16384 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16385 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16386 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16387 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16389 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16390 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16391 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16392 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16394 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16395 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16396 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16397 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16399 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16400 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16402 ;; Babel keys
16403 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16404 (mapc (lambda (pair)
16405 (define-key org-babel-map (car pair) (cdr pair)))
16406 org-babel-key-bindings)
16408 ;;; Extra keys for tty access.
16409 ;; We only set them when really needed because otherwise the
16410 ;; menus don't show the simple keys
16412 (when (or org-use-extra-keys
16413 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16414 (not window-system))
16415 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16416 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16417 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16418 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16419 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16420 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16421 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16422 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16423 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16424 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16425 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16426 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16427 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16428 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16429 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16430 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16431 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16432 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16433 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16434 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16435 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16436 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16437 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16438 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16439 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16440 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16441 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16442 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16444 ;; All the other keys
16446 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16447 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16448 (if (boundp 'narrow-map)
16449 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16450 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16451 (if (boundp 'narrow-map)
16452 (org-defkey narrow-map "b" 'org-narrow-to-block)
16453 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
16454 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16455 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16456 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16457 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16458 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16459 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16460 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16461 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16462 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16463 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16464 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16465 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16466 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16467 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16468 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16469 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16471 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16472 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16473 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16474 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16475 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16476 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16477 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16478 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16479 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16480 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16481 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16482 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16483 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16484 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16485 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16486 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16487 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16488 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16489 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16491 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16492 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16493 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16494 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16495 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16496 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16497 (org-defkey org-mode-map "\C-c^" 'org-sort)
16498 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16499 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16500 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16501 (org-defkey org-mode-map "\C-m" 'org-return)
16502 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16503 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16504 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16505 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16506 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16507 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16508 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16509 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16510 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16511 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16512 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16513 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16514 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16515 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16516 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16517 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16518 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16519 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16520 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16521 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16522 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16523 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16525 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16526 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16527 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16528 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16530 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16531 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16532 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16533 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16534 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16535 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16536 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16537 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16538 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16539 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16541 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16542 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16543 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16544 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16545 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16546 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16547 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16549 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16550 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16551 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16552 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16553 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16555 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16557 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16559 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16560 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16562 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16565 (when (featurep 'xemacs)
16566 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16569 (defconst org-speed-commands-default
16570 '(
16571 ("Outline Navigation")
16572 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16573 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16574 ("f" . (org-speed-move-safe 'org-forward-same-level))
16575 ("b" . (org-speed-move-safe 'org-backward-same-level))
16576 ("u" . (org-speed-move-safe 'outline-up-heading))
16577 ("j" . org-goto)
16578 ("g" . (org-refile t))
16579 ("Outline Visibility")
16580 ("c" . org-cycle)
16581 ("C" . org-shifttab)
16582 (" " . org-display-outline-path)
16583 ("Outline Structure Editing")
16584 ("U" . org-shiftmetaup)
16585 ("D" . org-shiftmetadown)
16586 ("r" . org-metaright)
16587 ("l" . org-metaleft)
16588 ("R" . org-shiftmetaright)
16589 ("L" . org-shiftmetaleft)
16590 ("i" . (progn (forward-char 1) (call-interactively
16591 'org-insert-heading-respect-content)))
16592 ("^" . org-sort)
16593 ("w" . org-refile)
16594 ("a" . org-archive-subtree-default-with-confirmation)
16595 ("." . org-mark-subtree)
16596 ("Clock Commands")
16597 ("I" . org-clock-in)
16598 ("O" . org-clock-out)
16599 ("Meta Data Editing")
16600 ("t" . org-todo)
16601 ("0" . (org-priority ?\ ))
16602 ("1" . (org-priority ?A))
16603 ("2" . (org-priority ?B))
16604 ("3" . (org-priority ?C))
16605 (";" . org-set-tags-command)
16606 ("e" . org-set-effort)
16607 ("Agenda Views etc")
16608 ("v" . org-agenda)
16609 ("/" . org-sparse-tree)
16610 ("Misc")
16611 ("o" . org-open-at-point)
16612 ("?" . org-speed-command-help)
16613 ("<" . (org-agenda-set-restriction-lock 'subtree))
16614 (">" . (org-agenda-remove-restriction-lock))
16615 )
16616 "The default speed commands.")
16618 (defun org-print-speed-command (e)
16619 (if (> (length (car e)) 1)
16620 (progn
16622 (princ (car e))
16624 (princ (make-string (length (car e)) ?-))
16626 (princ (car e))
16627 (princ " ")
16628 (if (symbolp (cdr e))
16629 (princ (symbol-name (cdr e)))
16630 (prin1 (cdr e)))
16633 (defun org-speed-command-help ()
16634 "Show the available speed commands."
16635 (interactive)
16636 (if (not org-use-speed-commands)
16637 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16638 (with-output-to-temp-buffer "*Help*"
16640 (mapc 'org-print-speed-command org-speed-commands-user)
16643 (mapc 'org-print-speed-command org-speed-commands-default))
16644 (with-current-buffer "*Help*"
16645 (setq truncate-lines t))))
16647 (defun org-speed-move-safe (cmd)
16648 "Execute CMD, but make sure that the cursor always ends up in a headline.
16649 If not, return to the original position and throw an error."
16650 (interactive)
16651 (let ((pos (point)))
16652 (call-interactively cmd)
16653 (unless (and (bolp) (org-on-heading-p))
16654 (goto-char pos)
16655 (error "Boundary reached while executing %s" cmd))))
16657 (defvar org-self-insert-command-undo-counter 0)
16659 (defvar org-table-auto-blank-field) ; defined in org-table.el
16660 (defvar org-speed-command nil)
16662 (defun org-speed-command-default-hook (keys)
16663 "Hook for activating single-letter speed commands.
16664 `org-speed-commands-default' specifies a minimal command set. Use
16665 `org-speed-commands-user' for further customization."
16666 (when (or (and (bolp) (looking-at outline-regexp))
16667 (and (functionp org-use-speed-commands)
16668 (funcall org-use-speed-commands)))
16669 (cdr (assoc keys (append org-speed-commands-user
16670 org-speed-commands-default)))))
16672 (defun org-babel-speed-command-hook (keys)
16673 "Hook for activating single-letter code block commands."
16674 (when (and (bolp) (looking-at org-babel-src-block-regexp))
16675 (cdr (assoc keys org-babel-key-bindings))))
16677 (defcustom org-speed-command-hook
16678 '(org-speed-command-default-hook org-babel-speed-command-hook)
16679 "Hook for activating speed commands at strategic locations.
16680 Hook functions are called in sequence until a valid handler is
16681 found.
16683 Each hook takes a single argument, a user-pressed command key
16684 which is also a `self-insert-command' from the global map.
16686 Within the hook, examine the cursor position and the command key
16687 and return nil or a valid handler as appropriate. Handler could
16688 be one of an interactive command, a function, or a form.
16690 Set `org-use-speed-commands' to non-nil value to enable this
16691 hook. The default setting is `org-speed-command-default-hook'."
16692 :group 'org-structure
16693 :type 'hook)
16695 (defun org-self-insert-command (N)
16696 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
16697 If the cursor is in a table looking at whitespace, the whitespace is
16698 overwritten, and the table is not marked as requiring realignment."
16699 (interactive "p")
16700 (cond
16701 ((and org-use-speed-commands
16702 (setq org-speed-command
16703 (run-hook-with-args-until-success
16704 'org-speed-command-hook (this-command-keys))))
16705 (cond
16706 ((commandp org-speed-command)
16707 (setq this-command org-speed-command)
16708 (call-interactively org-speed-command))
16709 ((functionp org-speed-command)
16710 (funcall org-speed-command))
16711 ((and org-speed-command (listp org-speed-command))
16712 (eval org-speed-command))
16713 (t (let (org-use-speed-commands)
16714 (call-interactively 'org-self-insert-command)))))
16715 ((and
16716 (org-table-p)
16717 (progn
16718 ;; check if we blank the field, and if that triggers align
16719 (and (featurep 'org-table) org-table-auto-blank-field
16720 (member last-command
16721 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
16723 ;; got extra space, this field does not determine column width
16724 (let (org-table-may-need-update) (org-table-blank-field))
16725 ;; no extra space, this field may determine column width
16726 (org-table-blank-field)))
16727 t)
16728 (eq N 1)
16730 (let (org-table-may-need-update)
16731 (goto-char (1- (match-end 0)))
16732 (delete-backward-char 1)
16733 (goto-char (match-beginning 0))
16734 (self-insert-command N)))
16735 (t
16736 (setq org-table-may-need-update t)
16737 (self-insert-command N)
16738 (org-fix-tags-on-the-fly)
16739 (if org-self-insert-cluster-for-undo
16740 (if (not (eq last-command 'org-self-insert-command))
16741 (setq org-self-insert-command-undo-counter 1)
16742 (if (>= org-self-insert-command-undo-counter 20)
16743 (setq org-self-insert-command-undo-counter 1)
16744 (and (> org-self-insert-command-undo-counter 0)
16745 buffer-undo-list
16746 (not (cadr buffer-undo-list)) ; remove nil entry
16747 (setcdr buffer-undo-list (cddr buffer-undo-list)))
16748 (setq org-self-insert-command-undo-counter
16749 (1+ org-self-insert-command-undo-counter))))))))
16751 (defun org-fix-tags-on-the-fly ()
16752 (when (and (equal (char-after (point-at-bol)) ?*)
16753 (org-on-heading-p))
16754 (org-align-tags-here org-tags-column)))
16756 (defun org-delete-backward-char (N)
16757 "Like `delete-backward-char', insert whitespace at field end in tables.
16758 When deleting backwards, in tables this function will insert whitespace in
16760 still be marked for re-alignment if the field did fill the entire column,
16761 because, in this case the deletion might narrow the column."
16762 (interactive "p")
16763 (if (and (org-table-p)
16764 (eq N 1)
16765 (string-match "|" (buffer-substring (point-at-bol) (point)))
16766 (looking-at ".*?|"))
16767 (let ((pos (point))
16769 (c org-table-may-need-update))
16770 (backward-delete-char N)
16771 (if (not overwrite-mode)
16772 (progn
16773 (skip-chars-forward "^|")
16774 (insert " ")
16775 (goto-char (1- pos))))
16776 ;; noalign: if there were two spaces at the end, this field
16777 ;; does not determine the width of the column.
16778 (if noalign (setq org-table-may-need-update c)))
16779 (backward-delete-char N)
16780 (org-fix-tags-on-the-fly)))
16782 (defun org-delete-char (N)
16783 "Like `delete-char', but insert whitespace at field end in tables.
16784 When deleting characters, in tables this function will insert whitespace in
16786 still be marked for re-alignment if the field did fill the entire column,
16787 because, in this case the deletion might narrow the column."
16788 (interactive "p")
16789 (if (and (org-table-p)
16790 (not (bolp))
16791 (not (= (char-after) ?|))
16792 (eq N 1))
16793 (if (looking-at ".*?|")
16794 (let ((pos (point))
16796 (c org-table-may-need-update))
16797 (replace-match (concat
16798 (substring (match-string 0) 1 -1)
16799 " |"))
16800 (goto-char pos)
16801 ;; noalign: if there were two spaces at the end, this field
16802 ;; does not determine the width of the column.
16803 (if noalign (setq org-table-may-need-update c)))
16804 (delete-char N))
16805 (delete-char N)
16806 (org-fix-tags-on-the-fly)))
16808 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
16809 (put 'org-self-insert-command 'delete-selection t)
16810 (put 'orgtbl-self-insert-command 'delete-selection t)
16811 (put 'org-delete-char 'delete-selection 'supersede)
16812 (put 'org-delete-backward-char 'delete-selection 'supersede)
16813 (put 'org-yank 'delete-selection 'yank)
16815 ;; Make `flyspell-mode' delay after some commands
16816 (put 'org-self-insert-command 'flyspell-delayed t)
16817 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
16818 (put 'org-delete-char 'flyspell-delayed t)
16819 (put 'org-delete-backward-char 'flyspell-delayed t)
16821 ;; Make pabbrev-mode expand after org-mode commands
16822 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
16823 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
16825 ;; How to do this: Measure non-white length of current string
16826 ;; If equal to column width, we should realign.
16828 (defun org-remap (map &rest commands)
16829 "In MAP, remap the functions given in COMMANDS.
16830 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
16831 (let (new old)
16832 (while commands
16833 (setq old (pop commands) new (pop commands))
16834 (if (fboundp 'command-remapping)
16835 (org-defkey map (vector 'remap old) new)
16836 (substitute-key-definition old new map global-map)))))
16838 (when (eq org-enable-table-editor 'optimized)
16839 ;; If the user wants maximum table support, we need to hijack
16840 ;; some standard editing functions
16841 (org-remap org-mode-map
16842 'self-insert-command 'org-self-insert-command
16843 'delete-char 'org-delete-char
16844 'delete-backward-char 'org-delete-backward-char)
16845 (org-defkey org-mode-map "|" 'org-force-self-insert))
16847 (defvar org-ctrl-c-ctrl-c-hook nil
16848 "Hook for functions attaching themselves to `C-c C-c'.
16849 This can be used to add additional functionality to the C-c C-c key which
16850 executes context-dependent commands.
16851 Each function will be called with no arguments. The function must check
16852 if the context is appropriate for it to act. If yes, it should do its
16853 thing and then return a non-nil value. If the context is wrong,
16854 just do nothing and return nil.")
16856 (defvar org-tab-first-hook nil
16857 "Hook for functions to attach themselves to TAB.
16858 See `org-ctrl-c-ctrl-c-hook' for more information.
16859 This hook runs as the first action when TAB is pressed, even before
16860 `org-cycle' messes around with the `outline-regexp' to cater for
16861 inline tasks and plain list item folding.
16862 If any function in this hook returns t, any other actions that
16863 would have been caused by TAB (such as table field motion or visibility
16864 cycling) will not occur.")
16866 (defvar org-tab-after-check-for-table-hook nil
16867 "Hook for functions to attach themselves to TAB.
16868 See `org-ctrl-c-ctrl-c-hook' for more information.
16869 This hook runs after it has been established that the cursor is not in a
16870 table, but before checking if the cursor is in a headline or if global cycling
16871 should be done.
16872 If any function in this hook returns t, not other actions like visibility
16873 cycling will be done.")
16875 (defvar org-tab-after-check-for-cycling-hook nil
16876 "Hook for functions to attach themselves to TAB.
16877 See `org-ctrl-c-ctrl-c-hook' for more information.
16878 This hook runs after it has been established that not table field motion and
16879 not visibility should be done because of current context. This is probably
16880 the place where a package like yasnippets can hook in.")
16882 (defvar org-tab-before-tab-emulation-hook nil
16883 "Hook for functions to attach themselves to TAB.
16884 See `org-ctrl-c-ctrl-c-hook' for more information.
16885 This hook runs after every other options for TAB have been exhausted, but
16888 (defvar org-metaleft-hook nil
16889 "Hook for functions attaching themselves to `M-left'.
16890 See `org-ctrl-c-ctrl-c-hook' for more information.")
16891 (defvar org-metaright-hook nil
16892 "Hook for functions attaching themselves to `M-right'.
16893 See `org-ctrl-c-ctrl-c-hook' for more information.")
16894 (defvar org-metaup-hook nil
16895 "Hook for functions attaching themselves to `M-up'.
16896 See `org-ctrl-c-ctrl-c-hook' for more information.")
16897 (defvar org-metadown-hook nil
16898 "Hook for functions attaching themselves to `M-down'.
16899 See `org-ctrl-c-ctrl-c-hook' for more information.")
16900 (defvar org-shiftmetaleft-hook nil
16901 "Hook for functions attaching themselves to `M-S-left'.
16902 See `org-ctrl-c-ctrl-c-hook' for more information.")
16903 (defvar org-shiftmetaright-hook nil
16904 "Hook for functions attaching themselves to `M-S-right'.
16905 See `org-ctrl-c-ctrl-c-hook' for more information.")
16906 (defvar org-shiftmetaup-hook nil
16907 "Hook for functions attaching themselves to `M-S-up'.
16908 See `org-ctrl-c-ctrl-c-hook' for more information.")
16909 (defvar org-shiftmetadown-hook nil
16910 "Hook for functions attaching themselves to `M-S-down'.
16911 See `org-ctrl-c-ctrl-c-hook' for more information.")
16912 (defvar org-metareturn-hook nil
16913 "Hook for functions attaching themselves to `M-RET'.
16914 See `org-ctrl-c-ctrl-c-hook' for more information.")
16915 (defvar org-shiftup-hook nil
16916 "Hook for functions attaching themselves to `S-up'.
16917 See `org-ctrl-c-ctrl-c-hook' for more information.")
16918 (defvar org-shiftup-final-hook nil
16919 "Hook for functions attaching themselves to `S-up'.
16920 This one runs after all other options except shift-select have been excluded.
16921 See `org-ctrl-c-ctrl-c-hook' for more information.")
16922 (defvar org-shiftdown-hook nil
16923 "Hook for functions attaching themselves to `S-down'.
16924 See `org-ctrl-c-ctrl-c-hook' for more information.")
16925 (defvar org-shiftdown-final-hook nil
16926 "Hook for functions attaching themselves to `S-down'.
16927 This one runs after all other options except shift-select have been excluded.
16928 See `org-ctrl-c-ctrl-c-hook' for more information.")
16929 (defvar org-shiftleft-hook nil
16930 "Hook for functions attaching themselves to `S-left'.
16931 See `org-ctrl-c-ctrl-c-hook' for more information.")
16932 (defvar org-shiftleft-final-hook nil
16933 "Hook for functions attaching themselves to `S-left'.
16934 This one runs after all other options except shift-select have been excluded.
16935 See `org-ctrl-c-ctrl-c-hook' for more information.")
16936 (defvar org-shiftright-hook nil
16937 "Hook for functions attaching themselves to `S-right'.
16938 See `org-ctrl-c-ctrl-c-hook' for more information.")
16939 (defvar org-shiftright-final-hook nil
16940 "Hook for functions attaching themselves to `S-right'.
16941 This one runs after all other options except shift-select have been excluded.
16942 See `org-ctrl-c-ctrl-c-hook' for more information.")
16944 (defun org-modifier-cursor-error ()
16945 "Throw an error, a modified cursor command was applied in wrong context."
16946 (error "This command is active in special context like tables, headlines or items"))
16948 (defun org-shiftselect-error ()
16949 "Throw an error because Shift-Cursor command was applied in wrong context."
16950 (if (and (boundp 'shift-select-mode) shift-select-mode)
16951 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
16952 (error "This command works only in special context like headlines or timestamps")))
16954 (defun org-call-for-shift-select (cmd)
16955 (let ((this-command-keys-shift-translated t))
16956 (call-interactively cmd)))
16958 (defun org-shifttab (&optional arg)
16959 "Global visibility cycling or move to previous table field.
16960 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
16961 on context.
16962 See the individual commands for more information."
16963 (interactive "P")
16964 (cond
16965 ((org-at-table-p) (call-interactively 'org-table-previous-field))
16966 ((integerp arg)
16967 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
16968 (message "Content view to level: %d" arg)
16969 (org-content (prefix-numeric-value arg2))
16970 (setq org-cycle-global-status 'overview)))
16971 (t (call-interactively 'org-global-cycle))))
16973 (defun org-shiftmetaleft ()
16974 "Promote subtree or delete table column.
16975 Calls `org-promote-subtree', `org-outdent-item',
16976 or `org-table-delete-column', depending on context.
16977 See the individual commands for more information."
16978 (interactive)
16979 (cond
16980 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
16981 ((org-at-table-p) (call-interactively 'org-table-delete-column))
16982 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
16983 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
16984 (t (org-modifier-cursor-error))))
16986 (defun org-shiftmetaright ()
16987 "Demote subtree or insert table column.
16988 Calls `org-demote-subtree', `org-indent-item',
16989 or `org-table-insert-column', depending on context.
16990 See the individual commands for more information."
16991 (interactive)
16992 (cond
16993 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
16994 ((org-at-table-p) (call-interactively 'org-table-insert-column))
16995 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
16996 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
16997 (t (org-modifier-cursor-error))))
16999 (defun org-shiftmetaup (&optional arg)
17000 "Move subtree up or kill table row.
17001 Calls `org-move-subtree-up' or `org-table-kill-row' or
17002 `org-move-item-up' depending on context. See the individual commands
17003 for more information."
17004 (interactive "P")
17005 (cond
17006 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17007 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17008 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17009 ((org-at-item-p) (call-interactively 'org-move-item-up))
17010 (t (org-modifier-cursor-error))))
17012 (defun org-shiftmetadown (&optional arg)
17013 "Move subtree down or insert table row.
17014 Calls `org-move-subtree-down' or `org-table-insert-row' or
17015 `org-move-item-down', depending on context. See the individual
17016 commands for more information."
17017 (interactive "P")
17018 (cond
17019 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17020 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17021 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17022 ((org-at-item-p) (call-interactively 'org-move-item-down))
17023 (t (org-modifier-cursor-error))))
17025 (defsubst org-hidden-tree-error ()
17026 (error
17027 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17029 (defun org-metaleft (&optional arg)
17030 "Promote heading or move table column to left.
17031 Calls `org-do-promote' or `org-table-move-column', depending on context.
17032 With no specific context, calls the Emacs default `backward-word'.
17033 See the individual commands for more information."
17034 (interactive "P")
17035 (cond
17036 ((run-hook-with-args-until-success 'org-metaleft-hook))
17037 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17038 ((or (org-on-heading-p)
17039 (and (org-region-active-p)
17040 (save-excursion
17041 (goto-char (region-beginning))
17042 (org-on-heading-p))))
17043 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17044 (call-interactively 'org-do-promote))
17045 ((or (org-at-item-p)
17046 (and (org-region-active-p)
17047 (save-excursion
17048 (goto-char (region-beginning))
17049 (org-at-item-p))))
17050 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17051 (call-interactively 'org-outdent-item))
17052 (t (call-interactively 'backward-word))))
17054 (defun org-metaright (&optional arg)
17055 "Demote subtree or move table column to right.
17056 Calls `org-do-demote' or `org-table-move-column', depending on context.
17057 With no specific context, calls the Emacs default `forward-word'.
17058 See the individual commands for more information."
17059 (interactive "P")
17060 (cond
17061 ((run-hook-with-args-until-success 'org-metaright-hook))
17062 ((org-at-table-p) (call-interactively 'org-table-move-column))
17063 ((or (org-on-heading-p)
17064 (and (org-region-active-p)
17065 (save-excursion
17066 (goto-char (region-beginning))
17067 (org-on-heading-p))))
17068 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17069 (call-interactively 'org-do-demote))
17070 ((or (org-at-item-p)
17071 (and (org-region-active-p)
17072 (save-excursion
17073 (goto-char (region-beginning))
17074 (org-at-item-p))))
17075 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17076 (call-interactively 'org-indent-item))
17077 (t (call-interactively 'forward-word))))
17079 (defun org-check-for-hidden (what)
17080 "Check if there are hidden headlines/items in the current visual line.
17081 WHAT can be either `headlines' or `items'. If the current line is
17082 an outline or item heading and it has a folded subtree below it,
17083 this function returns t, nil otherwise."
17084 (let ((re (cond
17085 ((eq what 'headlines) (concat "^" org-outline-regexp))
17086 ((eq what 'items) (org-item-beginning-re))
17087 (t (error "This should not happen"))))
17088 beg end)
17089 (save-excursion
17090 (catch 'exit
17091 (unless (org-region-active-p)
17092 (setq beg (point-at-bol))
17093 (beginning-of-line 2)
17094 (while (and (not (eobp)) ;; this is like `next-line'
17095 (get-char-property (1- (point)) 'invisible))
17096 (beginning-of-line 2))
17097 (setq end (point))
17098 (goto-char beg)
17099 (goto-char (point-at-eol))
17100 (setq end (max end (point)))
17101 (while (re-search-forward re end t)
17102 (if (get-char-property (match-beginning 0) 'invisible)
17103 (throw 'exit t))))
17104 nil))))
17106 (defun org-metaup (&optional arg)
17107 "Move subtree up or move table row up.
17108 Calls `org-move-subtree-up' or `org-table-move-row' or
17109 `org-move-item-up', depending on context. See the individual commands
17110 for more information."
17111 (interactive "P")
17112 (cond
17113 ((run-hook-with-args-until-success 'org-metaup-hook))
17114 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17115 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17116 ((org-at-item-p) (call-interactively 'org-move-item-up))
17117 (t (transpose-lines 1) (beginning-of-line -1))))
17119 (defun org-metadown (&optional arg)
17120 "Move subtree down or move table row down.
17121 Calls `org-move-subtree-down' or `org-table-move-row' or
17122 `org-move-item-down', depending on context. See the individual
17123 commands for more information."
17124 (interactive "P")
17125 (cond
17126 ((run-hook-with-args-until-success 'org-metadown-hook))
17127 ((org-at-table-p) (call-interactively 'org-table-move-row))
17128 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17129 ((org-at-item-p) (call-interactively 'org-move-item-down))
17130 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17132 (defun org-shiftup (&optional arg)
17133 "Increase item in timestamp or increase priority of current headline.
17134 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17135 depending on context. See the individual commands for more information."
17136 (interactive "P")
17137 (cond
17138 ((run-hook-with-args-until-success 'org-shiftup-hook))
17139 ((and org-support-shift-select (org-region-active-p))
17140 (org-call-for-shift-select 'previous-line))
17141 ((org-at-timestamp-p t)
17142 (call-interactively (if org-edit-timestamp-down-means-later
17143 'org-timestamp-down 'org-timestamp-up)))
17144 ((and (not (eq org-support-shift-select 'always))
17145 org-enable-priority-commands
17146 (org-on-heading-p))
17147 (call-interactively 'org-priority-up))
17148 ((and (not org-support-shift-select) (org-at-item-p))
17149 (call-interactively 'org-previous-item))
17150 ((org-clocktable-try-shift 'up arg))
17151 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17152 (org-support-shift-select
17153 (org-call-for-shift-select 'previous-line))
17154 (t (org-shiftselect-error))))
17156 (defun org-shiftdown (&optional arg)
17157 "Decrease item in timestamp or decrease priority of current headline.
17158 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17159 depending on context. See the individual commands for more information."
17160 (interactive "P")
17161 (cond
17162 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17163 ((and org-support-shift-select (org-region-active-p))
17164 (org-call-for-shift-select 'next-line))
17165 ((org-at-timestamp-p t)
17166 (call-interactively (if org-edit-timestamp-down-means-later
17167 'org-timestamp-up 'org-timestamp-down)))
17168 ((and (not (eq org-support-shift-select 'always))
17169 org-enable-priority-commands
17170 (org-on-heading-p))
17171 (call-interactively 'org-priority-down))
17172 ((and (not org-support-shift-select) (org-at-item-p))
17173 (call-interactively 'org-next-item))
17174 ((org-clocktable-try-shift 'down arg))
17175 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17176 (org-support-shift-select
17177 (org-call-for-shift-select 'next-line))
17178 (t (org-shiftselect-error))))
17180 (defun org-shiftright (&optional arg)
17181 "Cycle the thing at point or in the current line, depending on context.
17182 Depending on context, this does one of the following:
17184 - switch a timestamp at point one day into the future
17185 - on a headline, switch to the next TODO keyword.
17186 - on an item, switch entire list to the next bullet type
17187 - on a property line, switch to the next allowed value
17188 - on a clocktable definition line, move time block into the future"
17189 (interactive "P")
17190 (cond
17191 ((run-hook-with-args-until-success 'org-shiftright-hook))
17192 ((and org-support-shift-select (org-region-active-p))
17193 (org-call-for-shift-select 'forward-char))
17194 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17195 ((and (not (eq org-support-shift-select 'always))
17196 (org-on-heading-p))
17197 (let ((org-inhibit-logging
17198 (not org-treat-S-cursor-todo-selection-as-state-change))
17199 (org-inhibit-blocking
17200 (not org-treat-S-cursor-todo-selection-as-state-change)))
17201 (org-call-with-arg 'org-todo 'right)))
17202 ((or (and org-support-shift-select
17203 (not (eq org-support-shift-select 'always))
17204 (org-at-item-bullet-p))
17205 (and (not org-support-shift-select) (org-at-item-p)))
17206 (org-call-with-arg 'org-cycle-list-bullet nil))
17207 ((and (not (eq org-support-shift-select 'always))
17208 (org-at-property-p))
17209 (call-interactively 'org-property-next-allowed-value))
17210 ((org-clocktable-try-shift 'right arg))
17211 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17212 (org-support-shift-select
17213 (org-call-for-shift-select 'forward-char))
17214 (t (org-shiftselect-error))))
17216 (defun org-shiftleft (&optional arg)
17217 "Cycle the thing at point or in the current line, depending on context.
17218 Depending on context, this does one of the following:
17220 - switch a timestamp at point one day into the past
17221 - on a headline, switch to the previous TODO keyword.
17222 - on an item, switch entire list to the previous bullet type
17223 - on a property line, switch to the previous allowed value
17224 - on a clocktable definition line, move time block into the past"
17225 (interactive "P")
17226 (cond
17227 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17228 ((and org-support-shift-select (org-region-active-p))
17229 (org-call-for-shift-select 'backward-char))
17230 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17231 ((and (not (eq org-support-shift-select 'always))
17232 (org-on-heading-p))
17233 (let ((org-inhibit-logging
17234 (not org-treat-S-cursor-todo-selection-as-state-change))
17235 (org-inhibit-blocking
17236 (not org-treat-S-cursor-todo-selection-as-state-change)))
17237 (org-call-with-arg 'org-todo 'left)))
17238 ((or (and org-support-shift-select
17239 (not (eq org-support-shift-select 'always))
17240 (org-at-item-bullet-p))
17241 (and (not org-support-shift-select) (org-at-item-p)))
17242 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17243 ((and (not (eq org-support-shift-select 'always))
17244 (org-at-property-p))
17245 (call-interactively 'org-property-previous-allowed-value))
17246 ((org-clocktable-try-shift 'left arg))
17247 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17248 (org-support-shift-select
17249 (org-call-for-shift-select 'backward-char))
17250 (t (org-shiftselect-error))))
17252 (defun org-shiftcontrolright ()
17253 "Switch to next TODO set."
17254 (interactive)
17255 (cond
17256 ((and org-support-shift-select (org-region-active-p))
17257 (org-call-for-shift-select 'forward-word))
17258 ((and (not (eq org-support-shift-select 'always))
17259 (org-on-heading-p))
17260 (org-call-with-arg 'org-todo 'nextset))
17261 (org-support-shift-select
17262 (org-call-for-shift-select 'forward-word))
17263 (t (org-shiftselect-error))))
17265 (defun org-shiftcontrolleft ()
17266 "Switch to previous TODO set."
17267 (interactive)
17268 (cond
17269 ((and org-support-shift-select (org-region-active-p))
17270 (org-call-for-shift-select 'backward-word))
17271 ((and (not (eq org-support-shift-select 'always))
17272 (org-on-heading-p))
17273 (org-call-with-arg 'org-todo 'previousset))
17274 (org-support-shift-select
17275 (org-call-for-shift-select 'backward-word))
17276 (t (org-shiftselect-error))))
17278 (defun org-ctrl-c-ret ()
17279 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17280 (interactive)
17281 (cond
17282 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17283 (t (call-interactively 'org-insert-heading))))
17285 (defun org-copy-special ()
17286 "Copy region in table or copy current subtree.
17287 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17288 See the individual commands for more information."
17289 (interactive)
17290 (call-interactively
17291 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17293 (defun org-cut-special ()
17294 "Cut region in table or cut current subtree.
17295 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17296 See the individual commands for more information."
17297 (interactive)
17298 (call-interactively
17299 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17301 (defun org-paste-special (arg)
17302 "Paste rectangular region into table, or past subtree relative to level.
17303 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17304 See the individual commands for more information."
17305 (interactive "P")
17306 (if (org-at-table-p)
17307 (org-table-paste-rectangle)
17308 (org-paste-subtree arg)))
17310 (defun org-edit-special (&optional arg)
17311 "Call a special editor for the stuff at point.
17312 When at a table, call the formula editor with `org-table-edit-formulas'.
17313 When at the first line of an src example, call `org-edit-src-code'.
17314 When in an #+include line, visit the include file. Otherwise call
17315 `ffap' to visit the file at point."
17316 (interactive)
17317 ;; possibly prep session before editing source
17318 (when arg
17319 (let* ((info (org-babel-get-src-block-info))
17320 (lang (nth 0 info))
17321 (params (nth 2 info))
17322 (session (cdr (assoc :session params))))
17323 (when (and info session) ;; we are in a source-code block with a session
17324 (funcall
17325 (intern (concat "org-babel-prep-session:" lang)) session params))))
17326 (cond ;; proceed with `org-edit-special'
17327 ((save-excursion
17328 (beginning-of-line 1)
17329 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17330 (find-file (org-trim (match-string 1))))
17331 ((org-edit-src-code))
17332 ((org-edit-fixed-width-region))
17333 ((org-at-table.el-p)
17334 (org-edit-src-code))
17335 ((or (org-at-table-p)
17336 (save-excursion
17337 (beginning-of-line 1)
17339 (call-interactively 'org-table-edit-formulas))
17340 (t (call-interactively 'ffap))))
17342 (defun org-ctrl-c-ctrl-c (&optional arg)
17343 "Set tags in headline, or update according to changed information at point.
17345 This command does many different things, depending on context:
17347 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17348 this is what we do.
17350 - If the cursor is on a statistics cookie, update it.
17352 - If the cursor is in a headline, prompt for tags and insert them
17353 into the current line, aligned to `org-tags-column'. When called
17354 with prefix arg, realign all tags in the current buffer.
17356 - If the cursor is in one of the special #+KEYWORD lines, this
17357 triggers scanning the buffer for these lines and updating the
17358 information.
17360 - If the cursor is inside a table, realign the table. This command
17361 works even if the automatic table editor has been turned off.
17363 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17364 the entire table.
17366 - If the cursor is at a footnote reference or definition, jump to
17367 the corresponding definition or references, respectively.
17369 - If the cursor is a the beginning of a dynamic block, update it.
17371 - If the current buffer is a capture buffer, close note and file it.
17373 - If the cursor is on a <<<target>>>, update radio targets and
17374 corresponding links in this buffer.
17376 - If the cursor is on a numbered item in a plain list, renumber the
17377 ordered list.
17379 - If the cursor is on a checkbox, toggle it.
17381 - If the cursor is on a code block, evaluate it. The variable
17382 `org-confirm-babel-evaluate' can be used to control prompting
17383 before code block evaluation, by default every code block
17384 evaluation requires confirmation. Code block evaluation can be
17385 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17386 (interactive "P")
17387 (let ((org-enable-table-editor t))
17388 (cond
17389 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17390 org-occur-highlights
17391 org-latex-fragment-image-overlays)
17392 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17393 (org-remove-occur-highlights)
17394 (org-remove-latex-fragment-image-overlays)
17395 (message "Temporary highlights/overlays removed from current buffer"))
17396 ((and (local-variable-p 'org-finish-function (current-buffer))
17397 (fboundp org-finish-function))
17398 (funcall org-finish-function))
17399 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17400 ((or (looking-at org-property-start-re)
17401 (org-at-property-p))
17402 (call-interactively 'org-property-action))
17403 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17405 (or (org-on-heading-p) (org-at-item-p)))
17406 (call-interactively 'org-update-statistics-cookies))
17407 ((org-on-heading-p) (call-interactively 'org-set-tags))
17408 ((org-at-table.el-p)
17409 (message "Use C-c ' to edit table.el tables"))
17410 ((org-at-table-p)
17411 (org-table-maybe-eval-formula)
17412 (if arg
17413 (call-interactively 'org-table-recalculate)
17414 (org-table-maybe-recalculate-line))
17415 (call-interactively 'org-table-align)
17416 (orgtbl-send-table 'maybe))
17417 ((or (org-footnote-at-reference-p)
17418 (org-footnote-at-definition-p))
17419 (call-interactively 'org-footnote-action))
17420 ((org-at-item-checkbox-p)
17421 ;; Cursor at a checkbox: repair list and update checkboxes. Send
17422 ;; list only if at top item.
17423 (let* ((cbox (match-string 1))
17424 (struct (org-list-struct))
17425 (old-struct (copy-tree struct))
17426 (parents (org-list-parents-alist struct))
17427 (prevs (org-list-prevs-alist struct))
17428 (orderedp (org-entry-get nil "ORDERED"))
17429 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
17430 block-item)
17431 ;; Use a light version of `org-toggle-checkbox' to avoid
17432 ;; computing list structure twice.
17433 (org-list-set-checkbox (point-at-bol) struct
17434 (cond
17435 ((equal arg '(16)) "[-]")
17436 ((equal arg '(4)) nil)
17437 ((equal "[ ]" cbox) "[X]")
17438 (t "[ ]")))
17439 (org-list-struct-fix-ind struct parents)
17440 (org-list-struct-fix-bul struct prevs)
17441 (setq block-item
17442 (org-list-struct-fix-box struct parents prevs orderedp))
17443 (when block-item
17444 (message
17445 "Checkboxes were removed due to unchecked box at line %d"
17446 (org-current-line block-item)))
17447 (org-list-struct-apply-struct struct old-struct)
17448 (org-update-checkbox-count-maybe)
17449 (when firstp (org-list-send-list 'maybe))))
17450 ((org-at-item-p)
17451 ;; Cursor at an item: repair list. Do checkbox related actions
17452 ;; only if function was called with an argument. Send list only
17453 ;; if at top item.
17454 (let* ((struct (org-list-struct))
17455 (old-struct (copy-tree struct))
17456 (parents (org-list-parents-alist struct))
17457 (prevs (org-list-prevs-alist struct))
17458 (firstp (= (org-list-get-top-point struct) (point-at-bol))))
17459 (org-list-struct-fix-ind struct parents)
17460 (org-list-struct-fix-bul struct prevs)
17461 (when arg
17462 (org-list-set-checkbox (point-at-bol) struct "[ ]")
17463 (org-list-struct-fix-box struct parents prevs))
17464 (org-list-struct-apply-struct struct old-struct)
17465 (when arg (org-update-checkbox-count-maybe))
17466 (when firstp (org-list-send-list 'maybe))))
17467 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17468 ;; Dynamic block
17469 (beginning-of-line 1)
17470 (save-excursion (org-update-dblock)))
17471 ((save-excursion
17472 (beginning-of-line 1)
17474 (cond
17475 ((equal (match-string 1) "TBLFM")
17476 ;; Recalculate the table before this line
17477 (save-excursion
17478 (beginning-of-line 1)
17480 (if (org-at-table-p)
17481 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17482 (t
17483 (let ((org-inhibit-startup-visibility-stuff t)
17484 (org-startup-align-all-tables nil))
17485 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17486 (message "Local setup has been refreshed"))))
17487 ((org-clock-update-time-maybe))
17488 (t (error "C-c C-c can do nothing useful at this location")))))
17490 (defun org-mode-restart ()
17491 "Restart Org-mode, to scan again for special lines.
17492 Also updates the keyword regular expressions."
17493 (interactive)
17494 (org-mode)
17495 (message "Org-mode restarted"))
17497 (defun org-kill-note-or-show-branches ()
17498 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17499 (interactive)
17500 (if (not org-finish-function)
17501 (progn
17502 (hide-subtree)
17503 (call-interactively 'show-branches))
17504 (let ((org-note-abort t))
17505 (funcall org-finish-function))))
17507 (defun org-return (&optional indent)
17508 "Goto next table row or insert a newline.
17509 Calls `org-table-next-row' or `newline', depending on context.
17510 See the individual commands for more information."
17511 (interactive)
17512 (cond
17513 ((bobp) (if indent (newline-and-indent) (newline)))
17514 ((org-at-table-p)
17515 (org-table-justify-field-maybe)
17516 (call-interactively 'org-table-next-row))
17517 ;; when `newline-and-indent' is called within a list, make sure
17518 ;; text moved stays inside the item.
17519 ((and (org-in-item-p) indent)
17520 (if (and (org-at-item-p) (>= (point) (match-end 0)))
17521 (progn
17522 (newline)
17523 (org-indent-line-to (length (match-string 0))))
17524 (let ((ind (org-get-indentation)))
17525 (newline)
17526 (if (org-looking-back org-list-end-re)
17527 (org-indent-line-function)
17528 (org-indent-line-to ind)))))
17529 ((and org-return-follows-link
17530 (eq (get-text-property (point) 'face) 'org-link))
17531 (call-interactively 'org-open-at-point))
17532 ((and (org-at-heading-p)
17533 (looking-at
17535 (org-show-entry)
17536 (end-of-line 1)
17537 (newline))
17538 (t (if indent (newline-and-indent) (newline)))))
17540 (defun org-return-indent ()
17541 "Goto next table row or insert a newline and indent.
17542 Calls `org-table-next-row' or `newline-and-indent', depending on
17543 context. See the individual commands for more information."
17544 (interactive)
17545 (org-return t))
17547 (defun org-ctrl-c-star ()
17548 "Compute table, or change heading status of lines.
17549 Calls `org-table-recalculate' or `org-toggle-heading',
17550 depending on context."
17551 (interactive)
17552 (cond
17553 ((org-at-table-p)
17554 (call-interactively 'org-table-recalculate))
17555 (t
17556 ;; Convert all lines in region to list items
17557 (call-interactively 'org-toggle-heading))))
17559 (defun org-ctrl-c-minus ()
17560 "Insert separator line in table or modify bullet status of line.
17561 Also turns a plain line or a region of lines into list items.
17562 Calls `org-table-insert-hline', `org-toggle-item', or
17563 `org-cycle-list-bullet', depending on context."
17564 (interactive)
17565 (cond
17566 ((org-at-table-p)
17567 (call-interactively 'org-table-insert-hline))
17568 ((org-region-active-p)
17569 (call-interactively 'org-toggle-item))
17570 ((org-in-item-p)
17571 (call-interactively 'org-cycle-list-bullet))
17572 (t
17573 (call-interactively 'org-toggle-item))))
17575 (defun org-toggle-item (arg)
17576 "Convert headings or normal lines to items, items to normal lines.
17577 If there is no active region, only the current line is considered.
17579 If the first non blank line in the region is an headline, convert
17580 all headlines to items.
17582 If it is an item, convert all items to normal lines.
17584 If it is normal text, change region into an item. With a prefix
17585 argument ARG, change each line in region into an item."
17586 (interactive "P")
17587 (let (l2 l beg end)
17588 (if (org-region-active-p)
17589 (setq beg (region-beginning) end (region-end))
17590 (setq beg (point-at-bol)
17591 end (min (1+ (point-at-eol)) (point-max))))
17592 (org-with-limited-levels
17593 (save-excursion
17594 (goto-char end)
17595 (setq l2 (org-current-line))
17596 (goto-char beg)
17597 (beginning-of-line 1)
17598 ;; Ignore blank lines at beginning of region
17600 (beginning-of-line 1)
17601 (setq l (1- (org-current-line)))
17602 (cond
17603 ;; Case 1. Start at an item: de-itemize.
17604 ((org-at-item-p)
17605 (while (< (setq l (1+ l)) l2)
17606 (when (org-at-item-p)
17608 (delete-region (point) (match-end 0)))
17609 (beginning-of-line 2)))
17610 ;; Case 2. Start an an heading: convert to items.
17611 ((org-on-heading-p)
17612 (let* ((bul (org-list-bullet-string "-"))
17613 (len (length bul))
17614 (ind 0) (level 0))
17615 (while (< (setq l (1+ l)) l2)
17616 (cond
17617 ((looking-at outline-regexp)
17618 (let* ((lvl (org-reduced-level
17619 (- (length (match-string 0)) 2)))
17620 (s (concat (make-string (* len lvl) ? ) bul)))
17621 (replace-match s t t)
17622 (setq ind (length s) level lvl)))
17623 ;; Ignore blank lines and inline tasks.
17626 ;; Ensure normal text belongs to the new item.
17627 (t (org-indent-line-to (+ (max (- (org-get-indentation) level 2) 0)
17628 ind))))
17629 (beginning-of-line 2))))
17630 ;; Case 3. Normal line with ARG: turn each of them into items
17631 ;; unless they are already one.
17632 (arg
17633 (while (< (setq l (1+ l)) l2)
17634 (unless (or (org-on-heading-p) (org-at-item-p))
17636 (replace-match
17638 (beginning-of-line 2)))
17639 ;; Case 4. Normal line without ARG: make the first line of
17640 ;; region an item, and shift indentation of others
17641 ;; lines to set them as item's body.
17642 (t (let* ((bul (org-list-bullet-string "-"))
17643 (bul-len (length bul))
17644 (ref-ind (org-get-indentation)))
17646 (insert bul)
17647 (beginning-of-line 2)
17648 (while (and (< (setq l (1+ l)) l2) (< (point) end))
17649 ;; Ensure that lines less indented than first one
17650 ;; still get included in item body.
17651 (org-indent-line-to (+ (max ref-ind (org-get-indentation))
17652 bul-len))
17653 (beginning-of-line 2)))))))))
17655 (defun org-toggle-heading (&optional nstars)
17656 "Convert headings to normal text, or items or text to headings.
17657 If there is no active region, only the current line is considered.
17659 If the first non blank line is an headline, remove the stars from
17660 all headlines in the region.
17662 If it is a plain list item, turn all plain list items into headings.
17664 If it is a normal line, turn each and every normal line (i.e. not
17665 an heading or an item) in the region into a heading.
17667 When converting a line into a heading, the number of stars is chosen
17668 such that the lines become children of the current entry. However,
17669 when a prefix argument is given, its value determines the number of
17670 stars to add."
17671 (interactive "P")
17672 (let (l2 l itemp beg end)
17673 (if (org-region-active-p)
17674 (setq beg (region-beginning) end (copy-marker (region-end)))
17675 (setq beg (point-at-bol)
17676 end (min (1+ (point-at-eol)) (point-max))))
17677 ;; Ensure inline tasks don't count as headings.
17678 (org-with-limited-levels
17679 (save-excursion
17680 (goto-char end)
17681 (setq l2 (org-current-line))
17682 (goto-char beg)
17683 (beginning-of-line 1)
17684 ;; Ignore blank lines at beginning of region
17686 (beginning-of-line 1)
17687 (setq l (1- (org-current-line)))
17688 (cond
17689 ;; Case 1. Started at an heading: de-star headings.
17690 ((org-on-heading-p)
17691 (while (< (setq l (1+ l)) l2)
17692 (when (org-on-heading-p t)
17693 (looking-at outline-regexp) (replace-match ""))
17694 (beginning-of-line 2)))
17695 ;; Case 2. Started at an item: change items into headlines.
17696 ((org-at-item-p)
17697 (let ((stars (make-string
17698 (if nstars
17699 (prefix-numeric-value current-prefix-arg)
17700 (or (org-current-level) 0))
17701 ?*)))
17702 (while (< (point) end)
17703 (when (org-at-item-p)
17704 ;; Pay attention to cases when region ends before list.
17705 (let* ((struct (org-list-struct))
17706 (list-end (min (org-list-get-bottom-point struct) end)))
17707 (save-restriction
17708 (narrow-to-region (point) list-end)
17709 (insert
17710 (org-list-to-subtree
17711 (org-list-parse-list t)
17712 '(:istart (concat stars (funcall get-stars depth))
17713 :icount (concat stars
17714 (funcall get-stars depth))))))))
17715 (beginning-of-line 2))))
17716 ;; Case 3. Started at normal text: make every line an heading,
17717 ;; skipping headlines and items.
17718 (t (let* ((stars (make-string
17719 (if nstars
17720 (prefix-numeric-value current-prefix-arg)
17721 (or (org-current-level) 0))
17722 ?*))
17723 (add-stars (cond (nstars "")
17724 ((equal stars "") "*")
17725 (org-odd-levels-only "**")
17726 (t "*")))
17727 (rpl (concat stars add-stars " ")))
17728 (while (< (setq l (1+ l)) l2)
17729 (unless (or (org-on-heading-p) (org-at-item-p))
17731 (replace-match (concat rpl (match-string 2)))))
17732 (beginning-of-line 2)))))))))
17734 (defun org-meta-return (&optional arg)
17735 "Insert a new heading or wrap a region in a table.
17736 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17737 See the individual commands for more information."
17738 (interactive "P")
17739 (cond
17740 ((run-hook-with-args-until-success 'org-metareturn-hook))
17741 ((org-at-table-p)
17742 (call-interactively 'org-table-wrap-region))
17743 (t (call-interactively 'org-insert-heading))))
17745 ;;; Menu entries
17747 ;; Define the Org-mode menus
17748 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
17749 '("Tbl"
17750 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
17751 ["Next Field" org-cycle (org-at-table-p)]
17752 ["Previous Field" org-shifttab (org-at-table-p)]
17753 ["Next Row" org-return (org-at-table-p)]
17754 "--"
17755 ["Blank Field" org-table-blank-field (org-at-table-p)]
17756 ["Edit Field" org-table-edit-field (org-at-table-p)]
17757 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
17758 "--"
17759 ("Column"
17760 ["Move Column Left" org-metaleft (org-at-table-p)]
17761 ["Move Column Right" org-metaright (org-at-table-p)]
17762 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
17763 ["Insert Column" org-shiftmetaright (org-at-table-p)])
17764 ("Row"
17765 ["Move Row Up" org-metaup (org-at-table-p)]
17766 ["Move Row Down" org-metadown (org-at-table-p)]
17767 ["Delete Row" org-shiftmetaup (org-at-table-p)]
17768 ["Insert Row" org-shiftmetadown (org-at-table-p)]
17769 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
17770 "--"
17771 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
17772 ("Rectangle"
17773 ["Copy Rectangle" org-copy-special (org-at-table-p)]
17774 ["Cut Rectangle" org-cut-special (org-at-table-p)]
17775 ["Paste Rectangle" org-paste-special (org-at-table-p)]
17776 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
17777 "--"
17778 ("Calculate"
17779 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
17780 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17781 ["Edit Formulas" org-edit-special (org-at-table-p)]
17782 "--"
17783 ["Recalculate line" org-table-recalculate (org-at-table-p)]
17784 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17785 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
17786 "--"
17787 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
17788 "--"
17789 ["Sum Column/Rectangle" org-table-sum
17790 (or (org-at-table-p) (org-region-active-p))]
17791 ["Which Column?" org-table-current-column (org-at-table-p)])
17792 ["Debug Formulas"
17793 org-table-toggle-formula-debugger
17794 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
17795 ["Show Col/Row Numbers"
17796 org-table-toggle-coordinate-overlays
17797 :style toggle
17798 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
17799 "--"
17800 ["Create" org-table-create (and (not (org-at-table-p))
17801 org-enable-table-editor)]
17802 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
17803 ["Import from File" org-table-import (not (org-at-table-p))]
17804 ["Export to File" org-table-export (org-at-table-p)]
17805 "--"
17806 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
17808 (easy-menu-define org-org-menu org-mode-map "Org menu"
17809 '("Org"
17810 ("Show/Hide"
17811 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
17812 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
17813 ["Sparse Tree..." org-sparse-tree t]
17814 ["Reveal Context" org-reveal t]
17815 ["Show All" show-all t]
17816 "--"
17817 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
17818 "--"
17819 ["New Heading" org-insert-heading t]
17820 ("Navigate Headings"
17821 ["Up" outline-up-heading t]
17822 ["Next" outline-next-visible-heading t]
17823 ["Previous" outline-previous-visible-heading t]
17824 ["Next Same Level" outline-forward-same-level t]
17825 ["Previous Same Level" outline-backward-same-level t]
17826 "--"
17827 ["Jump" org-goto t])
17828 ("Edit Structure"
17829 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
17830 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
17831 "--"
17832 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
17833 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
17834 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
17835 "--"
17836 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
17837 "--"
17838 ["Promote Heading" org-metaleft (not (org-at-table-p))]
17839 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
17840 ["Demote Heading" org-metaright (not (org-at-table-p))]
17841 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
17842 "--"
17843 ["Sort Region/Children" org-sort (not (org-at-table-p))]
17844 "--"
17845 ["Convert to odd levels" org-convert-to-odd-levels t]
17846 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
17847 ("Editing"
17848 ["Emphasis..." org-emphasize t]
17849 ["Edit Source Example" org-edit-special t]
17850 "--"
17851 ["Footnote new/jump" org-footnote-action t]
17852 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
17853 ("Archive"
17854 ["Archive (default method)" org-archive-subtree-default t]
17855 "--"
17856 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
17857 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
17858 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
17859 )
17860 "--"
17861 ("Hyperlinks"
17862 ["Store Link (Global)" org-store-link t]
17863 ["Find existing link to here" org-occur-link-in-agenda-files t]
17864 ["Insert Link" org-insert-link t]
17865 ["Follow Link" org-open-at-point t]
17866 "--"
17867 ["Next link" org-next-link t]
17868 ["Previous link" org-previous-link t]
17869 "--"
17870 ["Descriptive Links"
17871 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
17872 :style radio
17873 :selected (member '(org-link) buffer-invisibility-spec)]
17874 ["Literal Links"
17875 (progn
17876 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
17877 :style radio
17878 :selected (not (member '(org-link) buffer-invisibility-spec))])
17879 "--"
17880 ("TODO Lists"
17881 ["TODO/DONE/-" org-todo t]
17882 ("Select keyword"
17883 ["Next keyword" org-shiftright (org-on-heading-p)]
17884 ["Previous keyword" org-shiftleft (org-on-heading-p)]
17885 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
17886 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
17887 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
17888 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
17889 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
17890 "--"
17891 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
17892 :selected org-enforce-todo-dependencies :style toggle :active t]
17893 "Settings for tree at point"
17894 ["Do Children sequentially" org-toggle-ordered-property :style radio
17895 :selected (org-entry-get nil "ORDERED")
17896 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17897 ["Do Children parallel" org-toggle-ordered-property :style radio
17898 :selected (not (org-entry-get nil "ORDERED"))
17899 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17900 "--"
17901 ["Set Priority" org-priority t]
17902 ["Priority Up" org-shiftup t]
17903 ["Priority Down" org-shiftdown t]
17904 "--"
17905 ["Get news from all feeds" org-feed-update-all t]
17906 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
17907 ["Customize feeds" (customize-variable 'org-feed-alist) t])
17908 ("TAGS and Properties"
17909 ["Set Tags" org-set-tags-command t]
17910 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
17911 "--"
17912 ["Set property" org-set-property t]
17913 ["Column view of properties" org-columns t]
17914 ["Insert Column View DBlock" org-insert-columns-dblock t])
17915 ("Dates and Scheduling"
17916 ["Timestamp" org-time-stamp t]
17917 ["Timestamp (inactive)" org-time-stamp-inactive t]
17918 ("Change Date"
17919 ["1 Day Later" org-shiftright t]
17920 ["1 Day Earlier" org-shiftleft t]
17921 ["1 ... Later" org-shiftup t]
17922 ["1 ... Earlier" org-shiftdown t])
17923 ["Compute Time Range" org-evaluate-time-range t]
17924 ["Schedule Item" org-schedule t]
17925 ["Deadline" org-deadline t]
17926 "--"
17927 ["Custom time format" org-toggle-time-stamp-overlays
17928 :style radio :selected org-display-custom-times]
17929 "--"
17930 ["Goto Calendar" org-goto-calendar t]
17931 ["Date from Calendar" org-date-from-calendar t]
17932 "--"
17933 ["Start/Restart Timer" org-timer-start t]
17934 ["Pause/Continue Timer" org-timer-pause-or-continue t]
17935 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
17936 ["Insert Timer String" org-timer t]
17937 ["Insert Timer Item" org-timer-item t])
17938 ("Logging work"
17939 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
17940 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
17941 ["Clock out" org-clock-out t]
17942 ["Clock cancel" org-clock-cancel t]
17943 "--"
17944 ["Mark as default task" org-clock-mark-default-task t]
17945 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
17946 ["Goto running clock" org-clock-goto t]
17947 "--"
17948 ["Display times" org-clock-display t]
17949 ["Create clock table" org-clock-report t]
17950 "--"
17951 ["Record DONE time"
17952 (progn (setq org-log-done (not org-log-done))
17953 (message "Switching to %s will %s record a timestamp"
17954 (car org-done-keywords)
17955 (if org-log-done "automatically" "not")))
17956 :style toggle :selected org-log-done])
17957 "--"
17958 ["Agenda Command..." org-agenda t]
17959 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
17960 ("File List for Agenda")
17961 ("Special views current file"
17962 ["TODO Tree" org-show-todo-tree t]
17963 ["Check Deadlines" org-check-deadlines t]
17964 ["Timeline" org-timeline t]
17965 ["Tags/Property tree" org-match-sparse-tree t])
17966 "--"
17967 ["Export/Publish..." org-export t]
17968 ("LaTeX"
17969 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
17970 :selected org-cdlatex-mode]
17971 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
17972 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
17973 ["Modify math symbol" org-cdlatex-math-modify
17974 (org-inside-LaTeX-fragment-p)]
17975 ["Insert citation" org-reftex-citation t]
17976 "--"
17977 ["Template for BEAMER" org-insert-beamer-options-template t])
17978 "--"
17979 ("MobileOrg"
17980 ["Push Files and Views" org-mobile-push t]
17981 ["Get Captured and Flagged" org-mobile-pull t]
17982 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
17983 "--"
17984 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
17985 "--"
17986 ("Documentation"
17987 ["Show Version" org-version t]
17988 ["Info Documentation" org-info t])
17989 ("Customize"
17990 ["Browse Org Group" org-customize t]
17991 "--"
17992 ["Expand This Menu" org-create-customize-menu
17993 (fboundp 'customize-menu-create)])
17994 ["Send bug report" org-submit-bug-report t]
17995 "--"
17996 ("Refresh/Reload"
17997 ["Refresh setup current buffer" org-mode-restart t]
17998 ["Reload Org (after update)" org-reload t]
17999 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
18000 ))
18002 (defun org-info (&optional node)
18003 "Read documentation for Org-mode in the info system.
18004 With optional NODE, go directly to that node."
18005 (interactive)
18006 (info (format "(org)%s" (or node ""))))
18008 ;;;###autoload
18009 (defun org-submit-bug-report ()
18010 "Submit a bug report on Org-mode via mail.
18012 Don't hesitate to report any problems or inaccurate documentation.
18014 If you don't have setup sending mail from (X)Emacs, please copy the
18015 output buffer into your mail program, as it gives us important
18016 information about your Org-mode version and configuration."
18017 (interactive)
18018 (require 'reporter)
18019 (org-load-modules-maybe)
18020 (org-require-autoloaded-modules)
18021 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
18022 (reporter-submit-bug-report
18023 "emacs-orgmode@gnu.org"
18024 (org-version)
18025 (let (list)
18026 (save-window-excursion
18027 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
18028 (delete-other-windows)
18029 (erase-buffer)
18030 (insert "You are about to submit a bug report to the Org-mode mailing list.
18032 We would like to add your full Org-mode and Outline configuration to the
18033 bug report. This greatly simplifies the work of the maintainer and
18034 other experts on the mailing list.
18036 HOWEVER, some variables you have customized may contain private
18037 information. The names of customers, colleagues, or friends, might
18038 appear in the form of file names, tags, todo states, or search strings.
18039 If you answer yes to the prompt, you might want to check and remove
18040 such private information before sending the email.")
18041 (add-text-properties (point-min) (point-max) '(face org-warning))
18042 (when (yes-or-no-p "Include your Org-mode configuration ")
18043 (mapatoms
18044 (lambda (v)
18045 (and (boundp v)
18047 (or (and (symbol-value v)
18049 (and
18050 (get v 'custom-type) (get v 'standard-value)
18051 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
18052 (push v list)))))
18053 (kill-buffer (get-buffer "*Warn about privacy*"))
18054 list))
18055 nil nil
18056 "Remember to cover the basics, that is, what you expected to happen and
18057 what in fact did happen. You don't know how to make a good report? See
18059 http://orgmode.org/manual/Feedback.html#Feedback
18061 Your bug report will be posted to the Org-mode mailing list.
18062 ------------------------------------------------------------------------")
18063 (save-excursion
18068 (defun org-install-agenda-files-menu ()
18069 (let ((bl (buffer-list)))
18070 (save-excursion
18071 (while bl
18072 (set-buffer (pop bl))
18073 (if (org-mode-p) (setq bl nil)))
18074 (when (org-mode-p)
18075 (easy-menu-change
18076 '("Org") "File List for Agenda"
18077 (append
18078 (list
18079 ["Edit File List" (org-edit-agenda-file-list) t]
18080 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
18081 ["Remove Current File from List" org-remove-file t]
18082 ["Cycle through agenda files" org-cycle-agenda-files t]
18083 ["Occur in all agenda files" org-occur-in-agenda-files t]
18084 "--")
18085 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
18087 ;;;; Documentation
18089 ;;;###autoload
18090 (defun org-require-autoloaded-modules ()
18091 (interactive)
18092 (mapc 'require
18093 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
18094 org-docbook org-exp org-html org-icalendar
18095 org-id org-latex
18096 org-publish org-remember org-table
18097 org-timer org-xoxo)))
18099 ;;;###autoload
18100 (defun org-reload (&optional uncompiled)
18101 "Reload all org lisp files.
18102 With prefix arg UNCOMPILED, load the uncompiled versions."
18103 (interactive "P")
18104 (require 'find-func)
18106 (dir-org (file-name-directory (org-find-library-name "org")))
18107 (dir-org-contrib (ignore-errors
18108 (file-name-directory
18109 (org-find-library-name "org-contribdir"))))
18110 (babel-files
18111 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
18112 (append (list nil "comint" "eval" "exp" "keys"
18113 "lob" "ref" "table" "tangle")
18114 (delq nil
18115 (mapcar
18116 (lambda (lang)
18117 (when (cdr lang) (symbol-name (car lang))))
18118 org-babel-load-languages)))))
18119 (files
18120 (append (directory-files dir-org t file-re)
18121 babel-files
18122 (and dir-org-contrib
18123 (directory-files dir-org-contrib t file-re))))
18124 (remove-re (concat (if (featurep 'xemacs)
18125 "org-colview" "org-colview-xemacs")
18127 (setq files (mapcar 'file-name-sans-extension files))
18128 (setq files (mapcar
18129 (lambda (x) (if (string-match remove-re x) nil x))
18130 files))
18131 (setq files (delq nil files))
18132 (mapc
18133 (lambda (f)
18134 (when (featurep (intern (file-name-nondirectory f)))
18135 (if (and (not uncompiled)
18136 (file-exists-p (concat f ".elc")))
18137 (load (concat f ".elc") nil nil t)
18138 (load (concat f ".el") nil nil t))))
18139 files))
18140 (org-version))
18142 ;;;###autoload
18143 (defun org-customize ()
18144 "Call the customize function with org as argument."
18145 (interactive)
18146 (org-load-modules-maybe)
18147 (org-require-autoloaded-modules)
18148 (customize-browse 'org))
18150 (defun org-create-customize-menu ()
18151 "Create a full customization menu for Org-mode, insert it into the menu."
18152 (interactive)
18153 (org-load-modules-maybe)
18154 (org-require-autoloaded-modules)
18155 (if (fboundp 'customize-menu-create)
18156 (progn
18157 (easy-menu-change
18158 '("Org") "Customize"
18159 `(["Browse Org group" org-customize t]
18160 "--"
18161 ,(customize-menu-create 'org)
18162 ["Set" Custom-set t]
18163 ["Save" Custom-save t]
18164 ["Reset to Current" Custom-reset-current t]
18165 ["Reset to Saved" Custom-reset-saved t]
18166 ["Reset to Standard Settings" Custom-reset-standard t]))
18168 (error "Cannot expand menu (outdated version of cus-edit.el)")))
18170 ;;;; Miscellaneous stuff
18172 ;;; Generally useful functions
18174 (defun org-get-at-bol (property)
18175 "Get text property PROPERTY at beginning of line."
18176 (get-text-property (point-at-bol) property))
18178 (defun org-find-text-property-in-string (prop s)
18179 "Return the first non-nil value of property PROP in string S."
18180 (or (get-text-property 0 prop s)
18181 (get-text-property (or (next-single-property-change 0 prop s) 0)
18182 prop s)))
18184 (defun org-display-warning (message) ;; Copied from Emacs-Muse
18185 "Display the given MESSAGE as a warning."
18186 (if (fboundp 'display-warning)
18187 (display-warning 'org message
18188 (if (featurep 'xemacs) 'warning :warning))
18189 (let ((buf (get-buffer-create "*Org warnings*")))
18190 (with-current-buffer buf
18191 (goto-char (point-max))
18192 (insert "Warning (Org): " message)
18193 (unless (bolp)
18194 (newline)))
18195 (display-buffer buf)
18196 (sit-for 0))))
18198 (defun org-in-commented-line ()
18199 "Is point in a line starting with `#'?"
18200 (equal (char-after (point-at-bol)) ?#))
18202 (defun org-in-indented-comment-line ()
18203 "Is point in a line starting with `#' after some white space?"
18204 (save-excursion
18205 (save-match-data
18206 (goto-char (point-at-bol))
18209 (defun org-in-verbatim-emphasis ()
18210 (save-match-data
18211 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18213 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18214 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18215 (if (and marker (marker-buffer marker)
18216 (buffer-live-p (marker-buffer marker)))
18217 (progn
18218 (switch-to-buffer (marker-buffer marker))
18219 (if (or (> marker (point-max)) (< marker (point-min)))
18220 (widen))
18221 (goto-char marker)
18222 (org-show-context 'org-goto))
18223 (if bookmark
18224 (bookmark-jump bookmark)
18225 (error "Cannot find location"))))
18227 (defun org-quote-csv-field (s)
18228 "Quote field for inclusion in CSV material."
18231 s))
18233 (defun org-force-self-insert (N)
18234 "Needed to enforce self-insert under remapping."
18235 (interactive "p")
18236 (self-insert-command N))
18238 (defun org-string-width (s)
18239 "Compute width of string, ignoring invisible characters.
18240 This ignores character with invisibility property `org-link', and also
18241 characters with property `org-cwidth', because these will become invisible
18242 upon the next fontification round."
18243 (let (b l)
18244 (when (or (eq t buffer-invisibility-spec)
18245 (assq 'org-link buffer-invisibility-spec))
18246 (while (setq b (text-property-any 0 (length s)
18247 'invisible 'org-link s))
18248 (setq s (concat (substring s 0 b)
18249 (substring s (or (next-single-property-change
18250 b 'invisible s) (length s)))))))
18251 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18252 (setq s (concat (substring s 0 b)
18253 (substring s (or (next-single-property-change
18254 b 'org-cwidth s) (length s))))))
18255 (setq l (string-width s) b -1)
18256 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18257 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18258 l))
18260 (defun org-shorten-string (s maxlength)
18261 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18262 If the string is shorter or has length MAXLENGTH, just return the
18263 original string. If it is longer, the functions finds a space in the
18264 string, breaks this string off at that locations and adds three dots
18265 as ellipsis. Including the ellipsis, the string will not be longer
18266 than MAXLENGTH. If finding a good breaking point in the string does
18267 not work, the string is just chopped off in the middle of a word
18268 if necessary."
18269 (if (<= (length s) maxlength)
18270 s
18271 (let* ((n (max (- maxlength 4) 1))
18273 (if (string-match re s)
18274 (concat (match-string 1 s) "...")
18275 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18277 (defun org-get-indentation (&optional line)
18278 "Get the indentation of the current line, interpreting tabs.
18279 When LINE is given, assume it represents a line and compute its indentation."
18280 (if line
18281 (if (string-match "^ *" (org-remove-tabs line))
18282 (match-end 0))
18283 (save-excursion
18284 (beginning-of-line 1)
18286 (current-column))))
18288 (defun org-get-string-indentation (s)
18289 "What indentation has S due to SPACE and TAB at the beginning of the string?"
18290 (let ((n -1) (i 0) (w tab-width) c)
18291 (catch 'exit
18292 (while (< (setq n (1+ n)) (length s))
18293 (setq c (aref s n))
18294 (cond ((= c ?\ ) (setq i (1+ i)))
18296 (t (throw 'exit t)))))
18297 i))
18299 (defun org-remove-tabs (s &optional width)
18300 "Replace tabulators in S with spaces.
18301 Assumes that s is a single line, starting in column 0."
18302 (setq width (or width tab-width))
18304 (setq s (replace-match
18305 (make-string
18306 (- (* width (/ (+ (match-beginning 0) width) width))
18307 (match-beginning 0)) ?\ )
18308 t t s)))
18309 s)
18311 (defun org-fix-indentation (line ind)
18312 "Fix indentation in LINE.
18313 IND is a cons cell with target and minimum indentation.
18314 If the current indentation in LINE is smaller than the minimum,
18315 leave it alone. If it is larger than ind, set it to the target."
18316 (let* ((l (org-remove-tabs line))
18317 (i (org-get-indentation l))
18318 (i1 (car ind)) (i2 (cdr ind)))
18319 (if (>= i i2) (setq l (substring line i2)))
18320 (if (> i1 0)
18321 (concat (make-string i1 ?\ ) l)
18322 l)))
18324 (defun org-remove-indentation (code &optional n)
18325 "Remove the maximum common indentation from the lines in CODE.
18326 N may optionally be the number of spaces to remove."
18327 (with-temp-buffer
18328 (insert code)
18329 (org-do-remove-indentation n)
18330 (buffer-string)))
18332 (defun org-do-remove-indentation (&optional n)
18333 "Remove the maximum common indentation from the buffer."
18334 (untabify (point-min) (point-max))
18335 (let ((min 10000) re)
18336 (if n
18337 (setq min n)
18338 (goto-char (point-min))
18340 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18341 (unless (or (= min 0) (= min 10000))
18343 (goto-char (point-min))
18344 (while (re-search-forward re nil t)
18345 (replace-match "")
18346 (end-of-line 1))
18347 min)))
18349 (defun org-fill-template (template alist)
18350 "Find each %key of ALIST in TEMPLATE and replace it."
18351 (let ((case-fold-search nil)
18352 entry key value)
18353 (setq alist (sort (copy-sequence alist)
18354 (lambda (a b) (< (length (car a)) (length (car b))))))
18355 (while (setq entry (pop alist))
18356 (setq template
18357 (replace-regexp-in-string
18358 (concat "%" (regexp-quote (car entry)))
18359 (cdr entry) template t t)))
18360 template))
18362 (defun org-base-buffer (buffer)
18363 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18364 (if (not buffer)
18365 buffer
18366 (or (buffer-base-buffer buffer)
18367 buffer)))
18369 (defun org-trim (s)
18370 "Remove whitespace at beginning and end of string."
18373 s)
18375 (defun org-wrap (string &optional width lines)
18376 "Wrap string to either a number of lines, or a width in characters.
18377 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18378 that costs. If there is a word longer than WIDTH, the text is actually
18379 wrapped to the length of that word.
18380 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18381 many lines, whatever width that takes.
18382 The return value is a list of lines, without newlines at the end."
18384 (maxword (apply 'max (mapcar 'org-string-width words)))
18385 w ll)
18386 (cond (width
18387 (org-do-wrap words (max maxword width)))
18388 (lines
18389 (setq w maxword)
18390 (setq ll (org-do-wrap words maxword))
18391 (if (<= (length ll) lines)
18392 ll
18393 (setq ll words)
18394 (while (> (length ll) lines)
18395 (setq w (1+ w))
18396 (setq ll (org-do-wrap words w)))
18397 ll))
18398 (t (error "Cannot wrap this")))))
18400 (defun org-do-wrap (words width)
18401 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18402 (let (lines line)
18403 (while words
18404 (setq line (pop words))
18405 (while (and words (< (+ (length line) (length (car words))) width))
18406 (setq line (concat line " " (pop words))))
18407 (setq lines (push line lines)))
18408 (nreverse lines)))
18410 (defun org-split-string (string &optional separators)
18411 "Splits STRING into substrings at SEPARATORS.
18412 No empty strings are returned if there are matches at the beginning
18413 and end of string."
18415 (start 0)
18416 notfirst
18417 (list nil))
18418 (while (and (string-match rexp string
18419 (if (and notfirst
18420 (= start (match-beginning 0))
18421 (< start (length string)))
18422 (1+ start) start))
18423 (< (match-beginning 0) (length string)))
18424 (setq notfirst t)
18425 (or (eq (match-beginning 0) 0)
18426 (and (eq (match-beginning 0) (match-end 0))
18427 (eq (match-beginning 0) start))
18428 (setq list
18429 (cons (substring string start (match-beginning 0))
18430 list)))
18431 (setq start (match-end 0)))
18432 (or (eq start (length string))
18433 (setq list
18434 (cons (substring string start)
18435 list)))
18436 (nreverse list)))
18438 (defun org-quote-vert (s)
18440 (while (string-match "|" s)
18442 s)
18444 (defun org-uuidgen-p (s)
18445 "Is S an ID created by UUIDGEN?"
18446 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18448 (defun org-context ()
18449 "Return a list of contexts of the current cursor position.
18450 If several contexts apply, all are returned.
18451 Each context entry is a list with a symbol naming the context, and
18452 two positions indicating start and end of the context. Possible
18453 contexts are:
18455 :headline anywhere in a headline
18456 :headline-stars on the leading stars in a headline
18457 :todo-keyword on a TODO keyword (including DONE) in a headline
18458 :tags on the TAGS in a headline
18459 :priority on the priority cookie in a headline
18460 :item on the first line of a plain list item
18461 :item-bullet on the bullet/number of a plain list item
18462 :checkbox on the checkbox in a plain list item
18463 :table in an org-mode table
18464 :table-special on a special filed in a table
18465 :table-table in a table.el table
18466 :link on a hyperlink
18467 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18468 :target on a <<target>>
18469 :radio-target on a <<<radio-target>>>
18470 :latex-fragment on a LaTeX fragment
18471 :latex-preview on a LaTeX fragment with overlayed preview image
18473 This function expects the position to be visible because it uses font-lock
18474 faces as a help to recognize the following contexts: :table-special, :link,
18475 and :keyword."
18476 (let* ((f (get-text-property (point) 'face))
18477 (faces (if (listp f) f (list f)))
18478 (p (point)) clist o)
18479 ;; First the large context
18480 (cond
18481 ((org-on-heading-p t)
18482 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18483 (when (progn
18484 (beginning-of-line 1)
18485 (looking-at org-todo-line-tags-regexp))
18486 (push (org-point-in-group p 1 :headline-stars) clist)
18487 (push (org-point-in-group p 2 :todo-keyword) clist)
18488 (push (org-point-in-group p 4 :tags) clist))
18489 (goto-char p)
18492 (push (org-point-in-group p 0 :priority) clist)))
18494 ((org-at-item-p)
18495 (push (org-point-in-group p 2 :item-bullet) clist)
18496 (push (list :item (point-at-bol)
18497 (save-excursion (org-end-of-item) (point)))
18498 clist)
18499 (and (org-at-item-checkbox-p)
18500 (push (org-point-in-group p 0 :checkbox) clist)))
18502 ((org-at-table-p)
18503 (push (list :table (org-table-begin) (org-table-end)) clist)
18504 (if (memq 'org-formula faces)
18505 (push (list :table-special
18506 (previous-single-property-change p 'face)
18507 (next-single-property-change p 'face)) clist)))
18508 ((org-at-table-p 'any)
18509 (push (list :table-table) clist)))
18510 (goto-char p)
18512 ;; Now the small context
18513 (cond
18514 ((org-at-timestamp-p)
18515 (push (org-point-in-group p 0 :timestamp) clist))
18516 ((memq 'org-link faces)
18517 (push (list :link
18518 (previous-single-property-change p 'face)
18519 (next-single-property-change p 'face)) clist))
18520 ((memq 'org-special-keyword faces)
18521 (push (list :keyword
18522 (previous-single-property-change p 'face)
18523 (next-single-property-change p 'face)) clist))
18524 ((org-on-target-p)
18525 (push (org-point-in-group p 0 :target) clist)
18526 (goto-char (1- (match-beginning 0)))
18527 (if (looking-at org-radio-target-regexp)
18528 (push (org-point-in-group p 0 :radio-target) clist))
18529 (goto-char p))
18530 ((setq o (car (delq nil
18531 (mapcar
18532 (lambda (x)
18533 (if (memq x org-latex-fragment-image-overlays) x))
18534 (overlays-at (point))))))
18535 (push (list :latex-fragment
18536 (overlay-start o) (overlay-end o)) clist)
18537 (push (list :latex-preview
18538 (overlay-start o) (overlay-end o)) clist))
18539 ((org-inside-LaTeX-fragment-p)
18540 ;; FIXME: positions wrong.
18541 (push (list :latex-fragment (point) (point)) clist)))
18543 (setq clist (nreverse (delq nil clist)))
18544 clist))
18546 ;; FIXME: Compare with at-regexp-p Do we need both?
18547 (defun org-in-regexp (re &optional nlines visually)
18548 "Check if point is inside a match of regexp.
18549 Normally only the current line is checked, but you can include NLINES extra
18550 lines both before and after point into the search.
18551 If VISUALLY is set, require that the cursor is not after the match but
18552 really on, so that the block visually is on the match."
18553 (catch 'exit
18554 (let ((pos (point))
18555 (eol (point-at-eol (+ 1 (or nlines 0))))
18556 (inc (if visually 1 0)))
18557 (save-excursion
18558 (beginning-of-line (- 1 (or nlines 0)))
18559 (while (re-search-forward re eol t)
18560 (if (and (<= (match-beginning 0) pos)
18561 (>= (+ inc (match-end 0)) pos))
18562 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18564 (defun org-at-regexp-p (regexp)
18565 "Is point inside a match of REGEXP in the current line?"
18566 (catch 'exit
18567 (save-excursion
18568 (let ((pos (point)) (end (point-at-eol)))
18569 (beginning-of-line 1)
18570 (while (re-search-forward regexp end t)
18571 (if (and (<= (match-beginning 0) pos)
18572 (>= (match-end 0) pos))
18573 (throw 'exit t)))
18574 nil))))
18576 (defun org-in-regexps-block-p (start-re end-re &optional bound)
18577 "Return t if the current point is between matches of START-RE and END-RE.
18578 This will also return t if point is on one of the two matches or
18579 in an unfinished block. END-RE can be a string or a form
18580 returning a string.
18582 An optional third argument bounds the search for START-RE. It
18583 defaults to previous heading or `point-min'."
18584 (let ((pos (point))
18585 (limit (or bound (save-excursion (outline-previous-heading)))))
18586 (save-excursion
18587 ;; we're on a block when point is on start-re...
18588 (or (org-at-regexp-p start-re)
18589 ;; ... or start-re can be found above...
18590 (and (re-search-backward start-re limit t)
18591 ;; ... but no end-re between start-re and point.
18592 (not (re-search-forward (eval end-re) pos t)))))))
18594 (defun org-occur-in-agenda-files (regexp &optional nlines)
18595 "Call `multi-occur' with buffers for all agenda files."
18597 (let* ((files (org-agenda-files))
18598 (tnames (mapcar 'file-truename files))
18599 (extra org-agenda-text-search-extra-files)
18600 f)
18601 (when (eq (car extra) 'agenda-archives)
18602 (setq extra (cdr extra))
18603 (setq files (org-add-archive-files files)))
18604 (while (setq f (pop extra))
18605 (unless (member (file-truename f) tnames)
18606 (add-to-list 'files f 'append)
18607 (add-to-list 'tnames (file-truename f) 'append)))
18608 (multi-occur
18609 (mapcar (lambda (x)
18610 (with-current-buffer
18611 (or (get-file-buffer x) (find-file-noselect x))
18612 (widen)
18613 (current-buffer)))
18614 files)
18615 regexp)))
18617 (if (boundp 'occur-mode-find-occurrence-hook)
18618 ;; Emacs 23
18619 (add-hook 'occur-mode-find-occurrence-hook
18620 (lambda ()
18621 (when (org-mode-p)
18622 (org-reveal))))
18623 ;; Emacs 22
18624 (defadvice occur-mode-goto-occurrence
18625 (after org-occur-reveal activate)
18626 (and (org-mode-p) (org-reveal)))
18627 (defadvice occur-mode-goto-occurrence-other-window
18628 (after org-occur-reveal activate)
18629 (and (org-mode-p) (org-reveal)))
18630 (defadvice occur-mode-display-occurrence
18631 (after org-occur-reveal activate)
18632 (when (org-mode-p)
18633 (let ((pos (occur-mode-find-occurrence)))
18634 (with-current-buffer (marker-buffer pos)
18635 (save-excursion
18636 (goto-char pos)
18637 (org-reveal)))))))
18639 (defun org-occur-link-in-agenda-files ()
18640 "Create a link and search for it in the agendas.
18641 The link is not stored in `org-stored-links', it is just created
18642 for the search purpose."
18643 (interactive)
18644 (let ((link (condition-case nil
18645 (org-store-link nil)
18646 (error "Unable to create a link to here"))))
18647 (org-occur-in-agenda-files (regexp-quote link))))
18649 (defun org-uniquify (list)
18650 "Remove duplicate elements from LIST."
18651 (let (res)
18652 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
18653 res))
18655 (defun org-delete-all (elts list)
18656 "Remove all elements in ELTS from LIST."
18657 (while elts
18658 (setq list (delete (pop elts) list)))
18659 list)
18661 (defun org-count (cl-item cl-seq)
18662 "Count the number of occurrences of ITEM in SEQ.
18663 Taken from `count' in cl-seq.el with all keyword arguments removed."
18664 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
18665 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
18666 (while (< cl-start cl-end)
18667 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
18668 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
18669 (setq cl-start (1+ cl-start)))
18670 cl-count))
18672 (defun org-remove-if (predicate seq)
18673 "Remove everything from SEQ that fulfills PREDICATE."
18674 (let (res e)
18675 (while seq
18676 (setq e (pop seq))
18677 (if (not (funcall predicate e)) (push e res)))
18678 (nreverse res)))
18680 (defun org-remove-if-not (predicate seq)
18681 "Remove everything from SEQ that does not fulfill PREDICATE."
18682 (let (res e)
18683 (while seq
18684 (setq e (pop seq))
18685 (if (funcall predicate e) (push e res)))
18686 (nreverse res)))
18688 (defun org-back-over-empty-lines ()
18689 "Move backwards over whitespace, to the beginning of the first empty line.
18690 Returns the number of empty lines passed."
18691 (let ((pos (point)))
18693 ;; (if (cdr (assoc 'heading org-blank-before-new-entry))
18695 ;; (forward-line -1))
18696 (beginning-of-line 2)
18697 (goto-char (min (point) pos))
18698 (count-lines (point) pos)))
18700 (defun org-skip-whitespace ()
18703 (defun org-point-in-group (point group &optional context)
18704 "Check if POINT is in match-group GROUP.
18705 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18706 match. If the match group does not exist or point is not inside it,
18707 return nil."
18708 (and (match-beginning group)
18709 (>= point (match-beginning group))
18710 (<= point (match-end group))
18711 (if context
18712 (list context (match-beginning group) (match-end group))
18713 t)))
18715 (defun org-switch-to-buffer-other-window (&rest args)
18716 "Switch to buffer in a second window on the current frame.
18717 In particular, do not allow pop-up frames.
18718 Returns the newly created buffer."
18719 (let (pop-up-frames special-display-buffer-names special-display-regexps
18720 special-display-function)
18721 (apply 'switch-to-buffer-other-window args)))
18723 (defun org-combine-plists (&rest plists)
18724 "Create a single property list from all plists in PLISTS.
18725 The process starts by copying the first list, and then setting properties
18726 from the other lists. Settings in the last list are the most significant
18727 ones and overrule settings in the other lists."
18728 (let ((rtn (copy-sequence (pop plists)))
18729 p v ls)
18730 (while plists
18731 (setq ls (pop plists))
18732 (while ls
18733 (setq p (pop ls) v (pop ls))
18734 (setq rtn (plist-put rtn p v))))
18735 rtn))
18737 (defun org-move-line-down (arg)
18738 "Move the current line down. With prefix argument, move it past ARG lines."
18739 (interactive "p")
18740 (let ((col (current-column))
18741 beg end pos)
18742 (beginning-of-line 1) (setq beg (point))
18743 (beginning-of-line 2) (setq end (point))
18744 (beginning-of-line (+ 1 arg))
18745 (setq pos (move-marker (make-marker) (point)))
18746 (insert (delete-and-extract-region beg end))
18747 (goto-char pos)
18748 (org-move-to-column col)))
18750 (defun org-move-line-up (arg)
18751 "Move the current line up. With prefix argument, move it past ARG lines."
18752 (interactive "p")
18753 (let ((col (current-column))
18754 beg end pos)
18755 (beginning-of-line 1) (setq beg (point))
18756 (beginning-of-line 2) (setq end (point))
18757 (beginning-of-line (- arg))
18758 (setq pos (move-marker (make-marker) (point)))
18759 (insert (delete-and-extract-region beg end))
18760 (goto-char pos)
18761 (org-move-to-column col)))
18763 (defun org-replace-escapes (string table)
18764 "Replace %-escapes in STRING with values in TABLE.
18766 The sequences in STRING may contain normal field width and padding information,
18768 so values can contain further %-escapes if they are define later in TABLE."
18769 (let ((tbl (copy-alist table))
18770 (case-fold-search nil)
18771 (pchg 0)
18772 e re rpl)
18773 (while (setq e (pop tbl))
18774 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
18775 (when (and (cdr e) (string-match re (cdr e)))
18776 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
18777 (safe "SREF"))
18778 (add-text-properties 0 3 (list 'sref sref) safe)
18779 (setcdr e (replace-match safe t t (cdr e)))))
18780 (while (string-match re string)
18781 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
18782 (cdr e)))
18783 (setq string (replace-match rpl t t string))))
18784 (while (setq pchg (next-property-change pchg string))
18785 (let ((sref (get-text-property pchg 'sref string)))
18786 (when (and sref (string-match "SREF" string pchg))
18787 (setq string (replace-match sref t t string)))))
18788 string))
18790 (defun org-sublist (list start end)
18791 "Return a section of LIST, from START to END.
18792 Counting starts at 1."
18793 (let (rtn (c start))
18794 (setq list (nthcdr (1- start) list))
18795 (while (and list (<= c end))
18796 (push (pop list) rtn)
18797 (setq c (1+ c)))
18798 (nreverse rtn)))
18800 (defun org-find-base-buffer-visiting (file)
18801 "Like `find-buffer-visiting' but always return the base buffer and
18802 not an indirect buffer."
18803 (let ((buf (or (get-file-buffer file)
18804 (find-buffer-visiting file))))
18805 (if buf
18806 (or (buffer-base-buffer buf) buf)
18807 nil)))
18809 (defun org-image-file-name-regexp (&optional extensions)
18810 "Return regexp matching the file names of images.
18811 If EXTENSIONS is given, only match these."
18812 (if (and (not extensions) (fboundp 'image-file-name-regexp))
18813 (image-file-name-regexp)
18814 (let ((image-file-name-extensions
18815 (or extensions
18816 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
18817 "xbm" "xpm" "pbm" "pgm" "ppm"))))
18819 (regexp-opt (nconc (mapcar 'upcase
18820 image-file-name-extensions)
18821 image-file-name-extensions)
18822 t)
18825 (defun org-file-image-p (file &optional extensions)
18826 "Return non-nil if FILE is an image."
18827 (save-match-data
18828 (string-match (org-image-file-name-regexp extensions) file)))
18830 (defun org-get-cursor-date ()
18831 "Return the date at cursor in as a time.
18832 This works in the calendar and in the agenda, anywhere else it just
18833 returns the current time."
18834 (let (date day defd)
18835 (cond
18836 ((eq major-mode 'calendar-mode)
18837 (setq date (calendar-cursor-to-date)
18838 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
18839 ((eq major-mode 'org-agenda-mode)
18840 (setq day (get-text-property (point) 'day))
18841 (if day
18842 (setq date (calendar-gregorian-from-absolute day)
18843 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
18844 (nth 2 date))))))
18845 (or defd (current-time))))
18847 (defvar org-agenda-action-marker (make-marker)
18848 "Marker pointing to the entry for the next agenda action.")
18850 (defun org-mark-entry-for-agenda-action ()
18851 "Mark the current entry as target of an agenda action.
18852 Agenda actions are actions executed from the agenda with the key `k',
18853 which make use of the date at the cursor."
18854 (interactive)
18855 (move-marker org-agenda-action-marker
18856 (save-excursion (org-back-to-heading t) (point))
18857 (current-buffer))
18858 (message
18859 "Entry marked for action; press `k' at desired date in agenda or calendar"))
18861 (defun org-mark-subtree ()
18862 "Mark the current subtree.
18863 This puts point at the start of the current subtree, and mark at the end.
18865 If point is in an inline task, mark that task instead."
18866 (interactive)
18867 (let ((inline-task-p
18868 (and (featurep 'org-inlinetask)
18869 (org-inlinetask-in-task-p)))
18870 (beg))
18871 ;; Get beginning of subtree
18872 (cond
18873 (inline-task-p (org-inlinetask-goto-beginning))
18874 ((org-at-heading-p) (beginning-of-line))
18875 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
18876 (setq beg (point))
18877 ;; Get end of it
18878 (if inline-task-p
18879 (org-inlinetask-goto-end)
18880 (org-end-of-subtree))
18881 ;; Mark zone
18882 (push-mark (point) nil t)
18883 (goto-char beg)))
18885 ;;; Paragraph filling stuff.
18886 ;; We want this to be just right, so use the full arsenal.
18888 (defun org-indent-line-function ()
18889 "Indent line depending on context."
18890 (interactive)
18891 (let* ((pos (point))
18892 (itemp (org-at-item-p))
18893 (case-fold-search t)
18895 (inline-task-p (and (featurep 'org-inlinetask)
18896 (org-inlinetask-in-task-p)))
18897 (inline-re (and inline-task-p
18898 (org-inlinetask-outline-regexp)))
18899 column)
18900 (beginning-of-line 1)
18901 (cond
18902 ;; Comments
18903 ((looking-at "# ") (setq column 0))
18904 ;; Headings
18906 ;; Literal examples
18908 (setq column (org-get-indentation))) ; do nothing
18909 ;; Drawers
18911 (save-excursion (re-search-backward org-drawer-regexp nil t)))
18912 (save-excursion
18913 (goto-char (1- (match-beginning 1)))
18914 (setq column (current-column))))
18915 ;; Special blocks
18917 (save-excursion
18918 (re-search-backward
18920 (setq column (org-get-indentation (match-string 0))))
18923 (save-excursion
18925 (setq column
18926 (if (equal (downcase (match-string 1)) "src")
18927 ;; src blocks: let `org-edit-src-exit' handle them
18928 (org-get-indentation)
18929 (org-get-indentation (match-string 0)))))
18930 ;; Lists
18931 ((ignore-errors (goto-char (org-in-item-p)))
18932 (setq column (if itemp
18933 (org-get-indentation)
18934 (org-list-item-body-column (point))))
18935 (goto-char pos))
18936 ;; This line has nothing special, look at the previous relevant
18937 ;; line to compute indentation
18938 (t
18939 (beginning-of-line 0)
18940 (while (and (not (bobp))
18941 (not (looking-at org-drawer-regexp))
18942 ;; When point started in an inline task, do not move
18943 ;; above task starting line.
18944 (not (and inline-task-p
18945 (looking-at inline-re)))
18946 ;; Skip comments, verbatim, empty lines, tables,
18947 ;; inline tasks, lists, drawers and blocks.
18949 (re-search-backward org-drawer-regexp nil t))
18953 (and (ignore-errors (goto-char (org-in-item-p)))
18954 (goto-char
18955 (org-list-get-top-point (org-list-struct))))
18956 (and (not inline-task-p)
18957 (featurep 'org-inlinetask)
18958 (org-inlinetask-in-task-p)
18959 (or (org-inlinetask-goto-beginning) t))))
18960 (beginning-of-line 0))
18961 (cond
18962 ;; There was an heading above.
18964 (if (not org-adapt-indentation)
18965 (setq column 0)
18966 (goto-char (match-end 0))
18967 (setq column (current-column))))
18968 ;; A drawer had started and is unfinished
18969 ((looking-at org-drawer-regexp)
18970 (goto-char (1- (match-beginning 1)))
18971 (setq column (current-column)))
18972 ;; Else, nothing noticeable found: get indentation and go on.
18973 (t (setq column (org-get-indentation))))))
18974 ;; Now apply indentation and move cursor accordingly
18975 (goto-char pos)
18976 (if (<= (current-column) (current-indentation))
18977 (org-indent-line-to column)
18978 (save-excursion (org-indent-line-to column)))
18979 ;; Special polishing for properties, see `org-property-format'
18980 (setq column (current-column))
18981 (beginning-of-line 1)
18982 (if (looking-at
18984 (replace-match (concat (match-string 1)
18985 (format org-property-format
18986 (match-string 2) (match-string 3)))
18987 t t))
18988 (org-move-to-column column)))
18990 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
18991 "Variable to store copy of `adaptive-fill-regexp'.
18992 Since `adaptive-fill-regexp' is set to never match, we need to
18993 store a backup of its value before entering `org-mode' so that
18994 the functionality can be provided as a fall-back.")
18996 (defun org-set-autofill-regexps ()
18997 (interactive)
18998 ;; In the paragraph separator we include headlines, because filling
18999 ;; text in a line directly attached to a headline would otherwise
19000 ;; fill the headline as well.
19003 ;; The paragraph starter includes hand-formatted lists.
19004 (org-set-local
19005 'paragraph-start
19006 (concat
19015 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
19016 ;; But only if the user has not turned off tables or fixed-width regions
19017 (org-set-local
19018 'auto-fill-inhibit-regexp
19021 (if (or org-enable-table-editor org-enable-fixed-width-editor)
19022 (concat
19024 (if org-enable-table-editor "|" "")
19025 (if org-enable-fixed-width-editor ":" "")
19026 "]"))))
19027 ;; We use our own fill-paragraph function, to make sure that tables
19028 ;; and fixed-width regions are not wrapped. That function will pass
19029 ;; through to `fill-paragraph' when appropriate.
19030 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
19031 ;; Adaptive filling: To get full control, first make sure that
19032 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
19033 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
19034 (org-set-local 'org-adaptive-fill-regexp-backup
19035 adaptive-fill-regexp))
19037 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
19038 (org-set-local 'adaptive-fill-function
19039 'org-adaptive-fill-function)
19040 (org-set-local
19041 'align-mode-rules-list
19042 '((org-in-buffer-settings
19044 (modes . '(org-mode))))))
19046 (defun org-fill-paragraph (&optional justify)
19047 "Re-align a table, pass through to fill-paragraph if no table."
19048 (let ((table-p (org-at-table-p))
19049 (table.el-p (org-at-table.el-p))
19050 (itemp (org-in-item-p)))
19051 (cond ((and (equal (char-after (point-at-bol)) ?*)
19052 (save-excursion (goto-char (point-at-bol))
19053 (looking-at outline-regexp)))
19054 t) ; skip headlines
19055 (table.el-p t) ; skip table.el tables
19056 (table-p (org-table-align) t) ; align Org tables
19057 (itemp ; align text in items
19058 (let* ((struct (save-excursion (goto-char itemp)
19059 (org-list-struct)))
19060 (parents (org-list-parents-alist struct))
19061 (children (org-list-get-children itemp struct parents))
19062 beg end prev next prefix)
19063 ;; Determine in which part of item point is: before
19064 ;; first child, after last child, between two
19065 ;; sub-lists, or simply in item if there's no child.
19066 (cond
19067 ((not children)
19068 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19069 beg itemp
19070 end (org-list-get-item-end itemp struct)))
19071 ((< (point) (setq next (car children)))
19072 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19073 beg itemp
19074 end next))
19075 ((> (point) (setq prev (car (last children))))
19076 (setq beg (org-list-get-item-end prev struct)
19077 end (org-list-get-item-end itemp struct)
19078 prefix (save-excursion
19079 (goto-char beg)
19081 (make-string (current-column) ?\ ))))
19082 (t (catch 'exit
19083 (while (setq next (pop children))
19084 (if (> (point) next)
19085 (setq prev next)
19086 (setq beg (org-list-get-item-end prev struct)
19087 end next
19088 prefix (save-excursion
19089 (goto-char beg)
19091 (make-string (current-column) ?\ )))
19092 (throw 'exit nil))))))
19093 ;; Use `fill-paragraph' with buffer narrowed to item
19094 ;; without any child, and with our computed PREFIX.
19095 (flet ((fill-context-prefix (from to &optional flr) prefix))
19096 (save-restriction
19097 (narrow-to-region beg end)
19098 (save-excursion (fill-paragraph justify)))) t))
19099 ;; Special case where point is not in a list but is on a
19100 ;; paragraph adjacent to a list: make sure this paragraph
19101 ;; doesn't get merged with the end of the list by narrowing
19102 ;; buffer first.
19103 ((save-excursion
19104 (fill-forward-paragraph -1)
19105 (setq itemp (org-in-item-p)))
19106 (save-excursion
19107 (goto-char itemp)
19108 (setq struct (org-list-struct)))
19109 (save-restriction
19110 (narrow-to-region (org-list-get-bottom-point struct)
19111 (save-excursion
19112 (fill-forward-paragraph 1)
19113 (point)))
19114 (fill-paragraph justify) t))
19115 (t nil)))) ; call `fill-paragraph'
19117 ;; For reference, this is the default value of adaptive-fill-regexp
19120 (defun org-adaptive-fill-function ()
19121 "Return a fill prefix for org-mode files."
19122 (let (itemp)
19123 (save-excursion
19124 (cond
19125 ;; Comment line
19127 (match-string-no-properties 0))
19128 ;; Point is in a list after `backward-paragraph': original
19129 ;; point wasn't in the list, or filling would have been taken
19130 ;; care of by `org-auto-fill-function', but the list and the
19131 ;; real paragraph are not separated by a blank line. Thus, move
19132 ;; point after the list to go back to real paragraph and
19133 ;; determine fill-prefix. If point is at an item, do not
19134 ;; compute prefix and list structure, as first line of
19135 ;; paragraph will be skipped anyway.
19136 ((org-at-item-p) "")
19137 ((setq itemp (org-in-item-p))
19138 (goto-char itemp)
19139 (let* ((struct (org-list-struct))
19140 (bottom (org-list-get-bottom-point struct)))
19141 (goto-char bottom)
19142 (make-string (org-get-indentation) ?\ )))
19143 ;; Other text
19144 ((looking-at org-adaptive-fill-regexp-backup)
19145 (match-string-no-properties 0))))))
19147 (defun org-auto-fill-function ()
19148 "Auto-fill function."
19149 (let (itemp prefix)
19150 ;; When in a list, compute an appropriate fill-prefix and make
19151 ;; sure it will be used by `do-auto-fill'.
19152 (if (setq itemp (org-in-item-p))
19153 (progn
19154 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
19155 (flet ((fill-context-prefix (from to &optional flr) prefix))
19156 (do-auto-fill)))
19157 ;; Else just use `do-auto-fill'.
19158 (do-auto-fill))))
19160 ;;; Other stuff.
19162 (defun org-toggle-fixed-width-section (arg)
19163 "Toggle the fixed-width export.
19164 If there is no active region, the QUOTE keyword at the current headline is
19165 inserted or removed. When present, it causes the text between this headline
19166 and the next to be exported as fixed-width text, and unmodified.
19167 If there is an active region, this command adds or removes a colon as the
19168 first character of this line. If the first character of a line is a colon,
19169 this line is also exported in fixed-width font."
19170 (interactive "P")
19171 (let* ((cc 0)
19172 (regionp (org-region-active-p))
19173 (beg (if regionp (region-beginning) (point)))
19174 (end (if regionp (region-end)))
19175 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
19176 (case-fold-search nil)
19178 off)
19179 (if regionp
19180 (save-excursion
19181 (goto-char beg)
19182 (setq cc (current-column))
19183 (beginning-of-line 1)
19184 (setq off (looking-at re))
19185 (while (> nlines 0)
19186 (setq nlines (1- nlines))
19187 (beginning-of-line 1)
19188 (cond
19189 (arg
19190 (org-move-to-column cc t)
19192 (forward-line -1))
19193 ((and off (looking-at re))
19194 (replace-match "" t t nil 1))
19195 ((not off) (org-move-to-column cc t) (insert ": ")))
19196 (forward-line 1)))
19197 (save-excursion
19198 (org-back-to-heading)
19199 (if (looking-at (concat outline-regexp
19201 (replace-match "" t t nil 1)
19202 (if (looking-at outline-regexp)
19203 (progn
19204 (goto-char (match-end 0))
19205 (insert org-quote-string " "))))))))
19207 (defun org-reftex-citation ()
19208 "Use reftex-citation to insert a citation into the buffer.
19209 This looks for a line like
19211 #+BIBLIOGRAPHY: foo plain option:-d
19213 and derives from it that foo.bib is the bibliography file relevant
19214 for this document. It then installs the necessary environment for RefTeX
19215 to work in this buffer and calls `reftex-citation' to insert a citation
19216 into the buffer.
19218 Export of such citations to both LaTeX and HTML is handled by the contributed
19219 package org-exp-bibtex by Taru Karttunen."
19220 (interactive)
19221 (let ((reftex-docstruct-symbol 'rds)
19223 rds bib)
19224 (save-excursion
19225 (save-restriction
19226 (widen)
19227 (let ((case-fold-search t)
19229 (if (not (save-excursion
19230 (or (re-search-forward re nil t)
19231 (re-search-backward re nil t))))
19232 (error "No bibliography defined in file")
19233 (setq bib (concat (match-string 1) ".bib")
19234 rds (list (list 'bib bib)))))))
19235 (call-interactively 'reftex-citation)))
19237 ;;;; Functions extending outline functionality
19239 (defun org-beginning-of-line (&optional arg)
19240 "Go to the beginning of the current line. If that is invisible, continue
19241 to a visible line beginning. This makes the function of C-a more intuitive.
19242 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19243 first attempt, and only move to after the tags when the cursor is already
19244 beyond the end of the headline."
19245 (interactive "P")
19246 (let ((pos (point))
19247 (special (if (consp org-special-ctrl-a/e)
19248 (car org-special-ctrl-a/e)
19249 org-special-ctrl-a/e))
19250 refpos)
19251 (if (org-bound-and-true-p line-move-visual)
19252 (beginning-of-visual-line 1)
19253 (beginning-of-line 1))
19254 (if (and arg (fboundp 'move-beginning-of-line))
19255 (call-interactively 'move-beginning-of-line)
19256 (if (bobp)
19257 nil
19258 (backward-char 1)
19259 (if (org-truely-invisible-p)
19260 (while (and (not (bobp)) (org-truely-invisible-p))
19261 (backward-char 1)
19262 (beginning-of-line 1))
19263 (forward-char 1))))
19264 (when special
19265 (cond
19266 ((and (looking-at org-complex-heading-regexp)
19267 (= (char-after (match-end 1)) ?\ ))
19268 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
19269 (point-at-eol)))
19270 (goto-char
19271 (if (eq special t)
19272 (cond ((> pos refpos) refpos)
19273 ((= pos (point)) refpos)
19274 (t (point)))
19275 (cond ((> pos (point)) (point))
19276 ((not (eq last-command this-command)) (point))
19277 (t refpos)))))
19278 ((org-at-item-p)
19279 (goto-char
19280 (if (eq special t)
19281 (cond ((> pos (match-end 0)) (match-end 0))
19282 ((= pos (point)) (match-end 0))
19283 (t (point)))
19284 (cond ((> pos (point)) (point))
19285 ((not (eq last-command this-command)) (point))
19286 (t (match-end 0))))))))
19287 (org-no-warnings
19288 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19290 (defun org-end-of-line (&optional arg)
19291 "Go to the end of the line.
19292 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19293 first attempt, and only move to after the tags when the cursor is already
19294 beyond the end of the headline."
19295 (interactive "P")
19296 (let ((special (if (consp org-special-ctrl-a/e)
19297 (cdr org-special-ctrl-a/e)
19298 org-special-ctrl-a/e)))
19299 (if (or (not special)
19300 (not (org-on-heading-p))
19301 arg)
19302 (call-interactively
19303 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
19304 ((fboundp 'move-end-of-line) 'move-end-of-line)
19305 (t 'end-of-line)))
19306 (let ((pos (point)))
19307 (beginning-of-line 1)
19309 (if (eq special t)
19310 (if (or (< pos (match-beginning 1))
19311 (= pos (match-end 0)))
19312 (goto-char (match-beginning 1))
19313 (goto-char (match-end 0)))
19314 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19315 (goto-char (match-end 0))
19316 (goto-char (match-beginning 1))))
19317 (call-interactively (if (fboundp 'move-end-of-line)
19318 'move-end-of-line
19319 'end-of-line)))))
19320 (org-no-warnings
19321 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19323 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19324 (define-key org-mode-map "\C-e" 'org-end-of-line)
19326 (defun org-backward-sentence (&optional arg)
19327 "Go to beginning of sentence, or beginning of table field.
19328 This will call `backward-sentence' or `org-table-beginning-of-field',
19329 depending on context."
19330 (interactive "P")
19331 (cond
19332 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19333 (t (call-interactively 'backward-sentence))))
19335 (defun org-forward-sentence (&optional arg)
19336 "Go to end of sentence, or end of table field.
19337 This will call `forward-sentence' or `org-table-end-of-field',
19338 depending on context."
19339 (interactive "P")
19340 (cond
19341 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19342 (t (call-interactively 'forward-sentence))))
19344 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19345 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19347 (defun org-kill-line (&optional arg)
19348 "Kill line, to tags or end of line."
19349 (interactive "P")
19350 (cond
19351 ((or (not org-special-ctrl-k)
19352 (bolp)
19353 (not (org-on-heading-p)))
19354 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19355 org-ctrl-k-protect-subtree)
19356 (if (or (eq org-ctrl-k-protect-subtree 'error)
19357 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19358 (error "C-k aborted - would kill hidden subtree")))
19359 (call-interactively 'kill-line))
19361 (kill-region (point) (match-beginning 1))
19362 (org-set-tags nil t))
19363 (t (kill-region (point) (point-at-eol)))))
19365 (define-key org-mode-map "\C-k" 'org-kill-line)
19367 (defun org-yank (&optional arg)
19368 "Yank. If the kill is a subtree, treat it specially.
19369 This command will look at the current kill and check if is a single
19370 subtree, or a series of subtrees[1]. If it passes the test, and if the
19371 cursor is at the beginning of a line or after the stars of a currently
19372 empty headline, then the yank is handled specially. How exactly depends
19373 on the value of the following variables, both set by default.
19375 org-yank-folded-subtrees
19376 When set, the subtree(s) will be folded after insertion, but only
19377 if doing so would now swallow text after the yanked text.
19379 org-yank-adjusted-subtrees
19380 When set, the subtree will be promoted or demoted in order to
19381 fit into the local outline tree structure, which means that the level
19382 will be adjusted so that it becomes the smaller one of the two
19383 *visible* surrounding headings.
19385 Any prefix to this command will cause `yank' to be called directly with
19387 will just
19388 plainly yank the text as it is.
19390 \[1] The test checks if the first non-white line is a heading
19391 and if there are no other headings with fewer stars."
19392 (interactive "P")
19393 (org-yank-generic 'yank arg))
19395 (defun org-yank-generic (command arg)
19396 "Perform some yank-like command.
19398 This function implements the behavior described in the `org-yank'
19399 documentation. However, it has been generalized to work for any
19400 interactive command with similar behavior."
19402 ;; pretend to be command COMMAND
19403 (setq this-command command)
19405 (if arg
19406 (call-interactively command)
19408 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19409 (and (org-kill-is-subtree-p)
19410 (or (bolp)
19412 (string-match
19414 (buffer-substring (point-at-bol) (point)))))))
19415 swallowp)
19416 (cond
19417 ((and subtreep org-yank-folded-subtrees)
19418 (let ((beg (point))
19419 end)
19420 (if (and subtreep org-yank-adjusted-subtrees)
19421 (org-paste-subtree nil nil 'for-yank)
19422 (call-interactively command))
19424 (setq end (point))
19425 (goto-char beg)
19426 (when (and (bolp) subtreep
19427 (not (setq swallowp
19428 (org-yank-folding-would-swallow-text beg end))))
19429 (or (looking-at outline-regexp)
19430 (re-search-forward (concat "^" outline-regexp) end t))
19431 (while (and (< (point) end) (looking-at outline-regexp))
19432 (hide-subtree)
19433 (org-cycle-show-empty-lines 'folded)
19434 (condition-case nil
19435 (outline-forward-same-level 1)
19436 (error (goto-char end)))))
19437 (when swallowp
19438 (message
19439 "Inserted text not folded because that would swallow text"))
19441 (goto-char end)
19443 (beginning-of-line 1)
19444 (push-mark beg 'nomsg)))
19445 ((and subtreep org-yank-adjusted-subtrees)
19446 (let ((beg (point-at-bol)))
19447 (org-paste-subtree nil nil 'for-yank)
19448 (push-mark beg 'nomsg)))
19449 (t
19450 (call-interactively command))))))
19452 (defun org-yank-folding-would-swallow-text (beg end)
19453 "Would hide-subtree at BEG swallow any text after END?"
19454 (let (level)
19455 (save-excursion
19456 (goto-char beg)
19457 (when (or (looking-at outline-regexp)
19458 (re-search-forward (concat "^" outline-regexp) end t))
19459 (setq level (org-outline-level)))
19460 (goto-char end)
19462 (if (or (eobp)
19463 (and (bolp) (looking-at org-outline-regexp)
19464 (<= (org-outline-level) level)))
19465 nil ; Nothing would be swallowed
19466 t)))) ; something would swallow
19468 (define-key org-mode-map "\C-y" 'org-yank)
19470 (defun org-truely-invisible-p ()
19471 "Check if point is at a character currently not visible.
19472 This version does not only check the character property, but also
19473 `visible-mode'."
19474 ;; Early versions of noutline don't have `outline-invisible-p'.
19475 (if (org-bound-and-true-p visible-mode)
19476 nil
19477 (outline-invisible-p)))
19479 (defun org-invisible-p2 ()
19480 "Check if point is at a character currently not visible."
19481 (save-excursion
19482 (if (and (eolp) (not (bobp))) (backward-char 1))
19483 ;; Early versions of noutline don't have `outline-invisible-p'.
19484 (outline-invisible-p)))
19486 (defun org-back-to-heading (&optional invisible-ok)
19487 "Call `outline-back-to-heading', but provide a better error message."
19488 (condition-case nil
19489 (outline-back-to-heading invisible-ok)
19490 (error (error "Before first headline at position %d in buffer %s"
19491 (point) (current-buffer)))))
19493 (defun org-beginning-of-defun ()
19494 "Go to the beginning of the subtree, i.e. back to the heading."
19495 (org-back-to-heading))
19496 (defun org-end-of-defun ()
19497 "Go to the end of the subtree."
19498 (org-end-of-subtree nil t))
19500 (defun org-before-first-heading-p ()
19501 "Before first heading?"
19502 (save-excursion
19503 (end-of-line)
19506 (defun org-on-heading-p (&optional ignored)
19507 (outline-on-heading-p t))
19508 (defun org-at-heading-p (&optional ignored)
19509 (outline-on-heading-p t))
19511 (defun org-point-at-end-of-empty-headline ()
19512 "If point is at the end of an empty headline, return t, else nil.
19513 If the heading only contains a TODO keyword, it is still still considered
19514 empty."
19516 (save-excursion
19517 (beginning-of-line 1)
19520 (defun org-at-heading-or-item-p ()
19521 (or (org-on-heading-p) (org-at-item-p)))
19523 (defun org-on-target-p ()
19524 (or (org-in-regexp org-radio-target-regexp)
19525 (org-in-regexp org-target-regexp)))
19527 (defun org-up-heading-all (arg)
19528 "Move to the heading line of which the present line is a subheading.
19529 This function considers both visible and invisible heading lines.
19530 With argument, move up ARG levels."
19531 (if (fboundp 'outline-up-heading-all)
19532 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19533 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19535 (defun org-up-heading-safe ()
19536 "Move to the heading line of which the present line is a subheading.
19537 This version will not throw an error. It will return the level of the
19538 headline found, or nil if no higher level is found.
19540 Also, this function will be a lot faster than `outline-up-heading',
19541 because it relies on stars being the outline starters. This can really
19542 make a significant difference in outlines with very many siblings."
19543 (let (start-level re)
19544 (org-back-to-heading t)
19545 (setq start-level (funcall outline-level))
19546 (if (equal start-level 1)
19547 nil
19549 (if (re-search-backward re nil t)
19550 (funcall outline-level)))))
19552 (defun org-first-sibling-p ()
19553 "Is this heading the first child of its parents?"
19554 (interactive)
19555 (let ((re (concat "^" outline-regexp))
19556 level l)
19557 (unless (org-at-heading-p t)
19558 (error "Not at a heading"))
19559 (setq level (funcall outline-level))
19560 (save-excursion
19561 (if (not (re-search-backward re nil t))
19562 t
19563 (setq l (funcall outline-level))
19564 (< l level)))))
19566 (defun org-goto-sibling (&optional previous)
19567 "Goto the next sibling, even if it is invisible.
19568 When PREVIOUS is set, go to the previous sibling instead. Returns t
19569 when a sibling was found. When none is found, return nil and don't
19570 move point."
19571 (let ((fun (if previous 're-search-backward 're-search-forward))
19572 (pos (point))
19573 (re (concat "^" outline-regexp))
19574 level l)
19575 (when (condition-case nil (org-back-to-heading t) (error nil))
19576 (setq level (funcall outline-level))
19577 (catch 'exit
19578 (or previous (forward-char 1))
19579 (while (funcall fun re nil t)
19580 (setq l (funcall outline-level))
19581 (when (< l level) (goto-char pos) (throw 'exit nil))
19582 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
19583 (goto-char pos)
19584 nil))))
19586 (defun org-show-siblings ()
19587 "Show all siblings of the current headline."
19588 (save-excursion
19589 (while (org-goto-sibling) (org-flag-heading nil)))
19590 (save-excursion
19591 (while (org-goto-sibling 'previous)
19592 (org-flag-heading nil))))
19594 (defun org-goto-first-child ()
19595 "Goto the first child, even if it is invisible.
19596 Return t when a child was found. Otherwise don't move point and
19597 return nil."
19598 (let (level (pos (point)) (re (concat "^" outline-regexp)))
19599 (when (condition-case nil (org-back-to-heading t) (error nil))
19600 (setq level (outline-level))
19601 (forward-char 1)
19602 (if (and (re-search-forward re nil t) (> (outline-level) level))
19603 (progn (goto-char (match-beginning 0)) t)
19604 (goto-char pos) nil))))
19606 (defun org-show-hidden-entry ()
19607 "Show an entry where even the heading is hidden."
19608 (save-excursion
19609 (org-show-entry)))
19611 (defun org-flag-heading (flag &optional entry)
19612 "Flag the current heading. FLAG non-nil means make invisible.
19613 When ENTRY is non-nil, show the entire entry."
19614 (save-excursion
19615 (org-back-to-heading t)
19616 ;; Check if we should show the entire entry
19617 (if entry
19618 (progn
19619 (org-show-entry)
19620 (save-excursion
19621 (and (outline-next-heading)
19622 (org-flag-heading nil))))
19623 (outline-flag-region (max (point-min) (1- (point)))
19624 (save-excursion (outline-end-of-heading) (point))
19625 flag))))
19627 (defun org-get-next-sibling ()
19628 "Move to next heading of the same level, and return point.
19629 If there is no such heading, return nil.
19630 This is like outline-next-sibling, but invisible headings are ok."
19631 (let ((level (funcall outline-level)))
19632 (outline-next-heading)
19633 (while (and (not (eobp)) (> (funcall outline-level) level))
19634 (outline-next-heading))
19635 (if (or (eobp) (< (funcall outline-level) level))
19636 nil
19637 (point))))
19639 (defun org-get-last-sibling ()
19640 "Move to previous heading of the same level, and return point.
19641 If there is no such heading, return nil."
19642 (let ((opoint (point))
19643 (level (funcall outline-level)))
19644 (outline-previous-heading)
19645 (when (and (/= (point) opoint) (outline-on-heading-p t))
19646 (while (and (> (funcall outline-level) level)
19647 (not (bobp)))
19648 (outline-previous-heading))
19649 (if (< (funcall outline-level) level)
19650 nil
19651 (point)))))
19653 (defun org-end-of-subtree (&optional invisible-OK to-heading)
19654 ;; This contains an exact copy of the original function, but it uses
19655 ;; `org-back-to-heading', to make it work also in invisible
19656 ;; trees. And is uses an invisible-OK argument.
19657 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
19658 ;; Furthermore, when used inside Org, finding the end of a large subtree
19659 ;; with many children and grandchildren etc, this can be much faster
19660 ;; than the outline version.
19661 (org-back-to-heading invisible-OK)
19662 (let ((first t)
19663 (level (funcall outline-level)))
19664 (if (and (org-mode-p) (< level 1000))
19665 ;; A true heading (not a plain list item), in Org-mode
19666 ;; This means we can easily find the end by looking
19667 ;; only for the right number of stars. Using a regexp to do
19668 ;; this is so much faster than using a Lisp loop.
19670 (forward-char 1)
19671 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
19672 ;; something else, do it the slow way
19673 (while (and (not (eobp))
19674 (or first (> (funcall outline-level) level)))
19675 (setq first nil)
19676 (outline-next-heading)))
19677 (unless to-heading
19679 (progn
19680 ;; Go to end of line before heading
19681 (forward-char -1)
19683 ;; leave blank line before heading
19684 (forward-char -1))))))
19685 (point))
19687 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
19688 "Use Org version in org-mode, for dramatic speed-up."
19689 (if (org-mode-p)
19690 (progn
19691 (org-end-of-subtree nil t)
19692 (unless (eobp) (backward-char 1)))
19693 ad-do-it))
19695 (defun org-forward-same-level (arg &optional invisible-ok)
19696 "Move forward to the arg'th subheading at same level as this one.
19697 Stop at the first and last subheadings of a superior heading.
19698 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
19699 it wil also look at invisible ones."
19700 (interactive "p")
19701 (org-back-to-heading invisible-ok)
19702 (org-on-heading-p)
19703 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19705 l)
19706 (forward-char 1)
19707 (while (> arg 0)
19708 (while (and (re-search-forward re nil 'move)
19709 (setq l (- (match-end 0) (match-beginning 0) 1))
19710 (= l level)
19711 (not invisible-ok)
19712 (progn (backward-char 1) (outline-invisible-p)))
19713 (if (< l level) (setq arg 1)))
19714 (setq arg (1- arg)))
19715 (beginning-of-line 1)))
19717 (defun org-backward-same-level (arg &optional invisible-ok)
19718 "Move backward to the arg'th subheading at same level as this one.
19719 Stop at the first and last subheadings of a superior heading."
19720 (interactive "p")
19721 (org-back-to-heading)
19722 (org-on-heading-p)
19723 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19725 l)
19726 (while (> arg 0)
19727 (while (and (re-search-backward re nil 'move)
19728 (setq l (- (match-end 0) (match-beginning 0) 1))
19729 (= l level)
19730 (not invisible-ok)
19731 (outline-invisible-p))
19732 (if (< l level) (setq arg 1)))
19733 (setq arg (1- arg)))))
19735 (defun org-show-subtree ()
19736 "Show everything after this heading at deeper levels."
19737 (outline-flag-region
19738 (point)
19739 (save-excursion
19740 (org-end-of-subtree t t))
19741 nil))
19743 (defun org-show-entry ()
19744 "Show the body directly following this heading.
19745 Show the heading too, if it is currently invisible."
19746 (interactive)
19747 (save-excursion
19748 (condition-case nil
19749 (progn
19750 (org-back-to-heading t)
19751 (outline-flag-region
19752 (max (point-min) (1- (point)))
19753 (save-excursion
19754 (if (re-search-forward
19756 (match-beginning 1)
19757 (point-max)))
19758 nil)
19759 (org-cycle-hide-drawers 'children))
19760 (error nil))))
19762 (defun org-make-options-regexp (kwds &optional extra)
19763 "Make a regular expression for keyword lines."
19764 (concat
19765 "^"
19772 ;; Make isearch reveal the necessary context
19773 (defun org-isearch-end ()
19774 "Reveal context after isearch exits."
19775 (when isearch-success ; only if search was successful
19776 (if (featurep 'xemacs)
19777 ;; Under XEmacs, the hook is run in the correct place,
19778 ;; we directly show the context.
19779 (org-show-context 'isearch)
19780 ;; In Emacs the hook runs *before* restoring the overlays.
19781 ;; So we have to use a one-time post-command-hook to do this.
19782 ;; (Emacs 22 has a special variable, see function `org-mode')
19783 (unless (and (boundp 'isearch-mode-end-hook-quit)
19784 isearch-mode-end-hook-quit)
19785 ;; Only when the isearch was not quitted.
19786 (org-add-hook 'post-command-hook 'org-isearch-post-command
19787 'append 'local)))))
19789 (defun org-isearch-post-command ()
19790 "Remove self from hook, and show context."
19791 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
19792 (org-show-context 'isearch))
19795 ;;;; Integration with and fixes for other packages
19797 ;;; Imenu support
19799 (defvar org-imenu-markers nil
19800 "All markers currently used by Imenu.")
19801 (make-variable-buffer-local 'org-imenu-markers)
19803 (defun org-imenu-new-marker (&optional pos)
19804 "Return a new marker for use by Imenu, and remember the marker."
19805 (let ((m (make-marker)))
19806 (move-marker m (or pos (point)))
19807 (push m org-imenu-markers)
19808 m))
19810 (defun org-imenu-get-tree ()
19811 "Produce the index for Imenu."
19812 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
19813 (setq org-imenu-markers nil)
19814 (let* ((n org-imenu-depth)
19815 (re (concat "^" outline-regexp))
19816 (subs (make-vector (1+ n) nil))
19817 (last-level 0)
19818 m level head)
19819 (save-excursion
19820 (save-restriction
19821 (widen)
19822 (goto-char (point-max))
19823 (while (re-search-backward re nil t)
19824 (setq level (org-reduced-level (funcall outline-level)))
19825 (when (<= level n)
19826 (looking-at org-complex-heading-regexp)
19827 (setq head (org-link-display-format
19828 (org-match-string-no-properties 4))
19829 m (org-imenu-new-marker))
19830 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
19831 (if (>= level last-level)
19832 (push (cons head m) (aref subs level))
19833 (push (cons head (aref subs (1+ level))) (aref subs level))
19834 (loop for i from (1+ level) to n do (aset subs i nil)))
19835 (setq last-level level)))))
19836 (aref subs 1)))
19838 (eval-after-load "imenu"
19839 '(progn
19840 (add-hook 'imenu-after-jump-hook
19841 (lambda ()
19842 (if (org-mode-p)
19843 (org-show-context 'org-goto))))))
19845 (defun org-link-display-format (link)
19846 "Replace a link with either the description, or the link target
19847 if no description is present"
19848 (save-match-data
19849 (if (string-match org-bracket-link-analytic-regexp link)
19850 (replace-match (if (match-end 5)
19851 (match-string 5 link)
19852 (concat (match-string 1 link)
19853 (match-string 3 link)))
19854 nil t link)
19855 link)))
19857 ;; Speedbar support
19859 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
19860 "Overlay marking the agenda restriction line in speedbar.")
19861 (overlay-put org-speedbar-restriction-lock-overlay
19862 'face 'org-agenda-restriction-lock)
19863 (overlay-put org-speedbar-restriction-lock-overlay
19864 'help-echo "Agendas are currently limited to this item.")
19865 (org-detach-overlay org-speedbar-restriction-lock-overlay)
19867 (defun org-speedbar-set-agenda-restriction ()
19868 "Restrict future agenda commands to the location at point in speedbar.
19870 (interactive)
19871 (require 'org-agenda)
19872 (let (p m tp np dir txt)
19873 (cond
19874 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19875 'org-imenu t))
19876 (setq m (get-text-property p 'org-imenu-marker))
19877 (with-current-buffer (marker-buffer m)
19878 (goto-char m)
19879 (org-agenda-set-restriction-lock 'subtree)))
19880 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19881 'speedbar-function 'speedbar-find-file))
19882 (setq tp (previous-single-property-change
19883 (1+ p) 'speedbar-function)
19884 np (next-single-property-change
19885 tp 'speedbar-function)
19886 dir (speedbar-line-directory)
19887 txt (buffer-substring-no-properties (or tp (point-min))
19888 (or np (point-max))))
19889 (with-current-buffer (find-file-noselect
19890 (let ((default-directory dir))
19891 (expand-file-name txt)))
19892 (unless (org-mode-p)
19893 (error "Cannot restrict to non-Org-mode file"))
19894 (org-agenda-set-restriction-lock 'file)))
19895 (t (error "Don't know how to restrict Org-mode's agenda")))
19896 (move-overlay org-speedbar-restriction-lock-overlay
19897 (point-at-bol) (point-at-eol))
19898 (setq current-prefix-arg nil)
19899 (org-agenda-maybe-redo)))
19901 (eval-after-load "speedbar"
19902 '(progn
19903 (speedbar-add-supported-extension ".org")
19904 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
19905 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
19906 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
19907 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19908 (add-hook 'speedbar-visiting-tag-hook
19909 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
19911 ;;; Fixes and Hacks for problems with other packages
19913 ;; Make flyspell not check words in links, to not mess up our keymap
19914 (defun org-mode-flyspell-verify ()
19915 "Don't let flyspell put overlays at active buttons."
19916 (and (not (get-text-property (max (1- (point)) (point-min)) 'keymap))
19917 (not (get-text-property (max (1- (point)) (point-min)) 'org-no-flyspell))))
19919 (defun org-remove-flyspell-overlays-in (beg end)
19920 "Remove flyspell overlays in region."
19921 (and (org-bound-and-true-p flyspell-mode)
19922 (fboundp 'flyspell-delete-region-overlays)
19923 (flyspell-delete-region-overlays beg end))
19924 (add-text-properties beg end '(org-no-flyspell t)))
19926 ;; Make `bookmark-jump' shows the jump location if it was hidden.
19927 (eval-after-load "bookmark"
19928 '(if (boundp 'bookmark-after-jump-hook)
19929 ;; We can use the hook
19930 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
19931 ;; Hook not available, use advice
19932 (defadvice bookmark-jump (after org-make-visible activate)
19933 "Make the position visible."
19934 (org-bookmark-jump-unhide))))
19936 ;; Make sure saveplace shows the location if it was hidden
19937 (eval-after-load "saveplace"
19938 '(defadvice save-place-find-file-hook (after org-make-visible activate)
19939 "Make the position visible."
19940 (org-bookmark-jump-unhide)))
19942 ;; Make sure ecb shows the location if it was hidden
19943 (eval-after-load "ecb"
19944 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
19945 "Make hierarchy visible when jumping into location from ECB tree buffer."
19946 (if (org-mode-p)
19947 (org-show-context))))
19949 (defun org-bookmark-jump-unhide ()
19950 "Unhide the current position, to show the bookmark location."
19951 (and (org-mode-p)
19952 (or (outline-invisible-p)
19953 (save-excursion (goto-char (max (point-min) (1- (point))))
19954 (outline-invisible-p)))
19955 (org-show-context 'bookmark-jump)))
19957 ;; Make session.el ignore our circular variable
19958 (eval-after-load "session"
19959 '(add-to-list 'session-globals-exclude 'org-mark-ring))
19961 ;;;; Experimental code
19963 (defun org-closed-in-range ()
19964 "Sparse tree of items closed in a certain time range.
19965 Still experimental, may disappear in the future."
19966 (interactive)
19967 ;; Get the time interval from the user.
19968 (let* ((time1 (org-float-time
19969 (org-read-date nil 'to-time nil "Starting date: ")))
19970 (time2 (org-float-time
19971 (org-read-date nil 'to-time nil "End date:")))
19972 ;; callback function
19973 (callback (lambda ()
19974 (let ((time
19975 (org-float-time
19976 (apply 'encode-time
19977 (org-parse-time-string
19978 (match-string 1))))))
19979 ;; check if time in interval
19980 (and (>= time time1) (<= time time2))))))
19981 ;; make tree, check each match with the callback
19984 ;;;; Finish up
19986 (provide 'org)
19988 (run-hooks 'org-load-hook)
19990 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
19992 ;;; org.el ends here