| blob | 6ea9d259fae269c5162f53eb07c4baf290ccff48 |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010
4 ;; Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.01trans
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
78 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
90 ;; Other stuff we need.
104 ;; babel
113 ;; load languages based on value of `org-babel-load-languages'
115 ;;;###autoload
117 "Load the languages defined in `org-babel-load-languages'."
129 org-babel-load-languages))
132 "Languages which can be evaluated in Org-mode buffers.
133 This list can be used to load support for any of the languages
134 below, note that each language will depend on a different set of
135 system executables and/or Emacs modes. When a language is
137 with `org-babel-execute-src-block' bound by default to C-c
138 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
139 be set to remove code block evaluation from the C-c C-c
140 keybinding. By default only Emacs Lisp (which has no
141 requirements) is loaded."
145 :key-type
177 ;;;; Customization variables
179 "Remove ID property of clones of a subtree.
180 When non-nil, clones of a subtree don't inherit the ID property.
181 Otherwise they inherit the ID property with a new unique
182 identifier."
186 ;;; Version
192 "Show the org-mode version in the echo area.
193 With prefix arg HERE, insert it at point."
219 ;;; Compatibility constants
221 ;;; The custom variables
224 "Outline-based notes management and organizer."
230 "Mode hook for Org-mode, run after the mode was turned on."
235 "Hook that is run after org.el has been loaded."
244 "Load all extensions listed in `org-modules'."
249 org-modules)
253 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
262 (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)
263 "Modules that should always be loaded together with org.el.
264 If a description starts with <C>, the file is not part of Emacs
265 and loading it will require that you have downloaded and properly installed
266 the org-mode distribution.
268 You can also use this system to load external packages (i.e. neither Org
269 core modules, nor modules from the CONTRIB directory). Just add symbols
270 to the end of the list. If the package is called org-xyz.el, then you need
271 to add the symbol `xyz', and the package must have a call to
273 (provide 'org-xyz)"
276 :type
306 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
313 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
321 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
338 "Non-nil means make shift-cursor commands select text when possible.
340 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
341 selecting a region, or enlarge regions started in this way.
342 In Org-mode, in special contexts, these same keys are used for other
343 purposes, important enough to compete with shift selection. Org tries
344 to balance these needs by supporting `shift-select-mode' outside these
345 special contexts, under control of this variable.
347 The default of this variable is nil, to avoid confusing behavior. Shifted
348 cursor keys will then execute Org commands in the following contexts:
349 - on a headline, changing TODO state (left/right) and priority (up/down)
350 - on a time stamp, changing the time
351 - in a plain list item, changing the bullet type
352 - in a property definition line, switching between allowed values
353 - in the BEGIN line of a clock table (changing the time block).
354 Outside these contexts, the commands will throw an error.
356 When this variable is t and the cursor is not in a special context,
357 Org-mode will support shift-selection for making and enlarging regions.
358 To make this more effective, the bullet cycling will no longer happen
359 anywhere in an item line, but only if the cursor is exactly on the bullet.
361 If you set this variable to the symbol `always', then the keys
362 will not be special in headlines, property lines, and item lines, to make
363 shift selection work there as well. If this is what you want, you can
364 use the following alternative commands: `C-c C-t' and `C-c ,' to
365 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
366 TODO sets, `C-c -' to cycle item bullet types, and properties can be
367 edited by hand or in column view.
369 However, when the cursor is on a timestamp, shift-cursor commands
370 will still edit the time stamp - this is just too good to give up.
372 XEmacs user should have this variable set to nil, because shift-select-mode
373 is Emacs 23 only."
381 "Options concerning startup of Org-mode."
386 "Non-nil means entering Org-mode will switch to OVERVIEW.
387 This can also be configured on a per-file basis by adding one of
388 the following lines anywhere in the buffer:
390 #+STARTUP: fold (or `overview', this is equivalent)
391 #+STARTUP: nofold (or `showall', this is equivalent)
392 #+STARTUP: content
393 #+STARTUP: showeverything"
402 "Non-nil means entering Org-mode will set `truncate-lines'.
403 This is useful since some lines containing links can be very long and
404 uninteresting. Also tables look terrible when wrapped."
409 "Non-nil means turn on `org-indent-mode' on startup.
410 This can also be configured on a per-file basis by adding one of
411 the following lines anywhere in the buffer:
413 #+STARTUP: indent
414 #+STARTUP: noindent"
422 When this option is turned on, you can use TeX-like syntax for sub- and
424 considered as a single item - so grouping with {} is normally not
425 needed. For example, the following things will be parsed as single
426 sub- or superscripts.
428 10^24 or 10^tau several digits will be considered 1 item.
429 10^-12 or 10^-tau a leading sign with digits or a word
430 x^2-y^3 will be read as x^2 - y^3, because items are
431 terminated by almost any nonword/nondigit char.
432 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
434 Still, ambiguity is possible - so when in doubt use {} to enclose the
435 sub/superscript. If you set this variable to the symbol `{}',
436 the braces are *required* in order to trigger interpretations as
438 frequently in plain text.
440 Not all export backends support this, but HTML does.
455 "Non-nil means turn on `org-beamer-mode' on startup.
456 This can also be configured on a per-file basis by adding one of
457 the following lines anywhere in the buffer:
459 #+STARTUP: beamer"
464 "Non-nil means align all tables when visiting a file.
465 This is useful when the column width in tables is forced with <N> cookies
466 in table fields. Such tables will look correct only after the first re-align.
467 This can also be configured on a per-file basis by adding one of
468 the following lines anywhere in the buffer:
469 #+STARTUP: align
470 #+STARTUP: noalign"
475 "Non-nil means show inline images when loading a new Org file.
476 This can also be configured on a per-file basis by adding one of
477 the following lines anywhere in the buffer:
478 #+STARTUP: inlineimages
479 #+STARTUP: noinlineimages"
484 "Non-nil means insert the first line setting Org-mode in empty files.
485 When the function `org-mode' is called interactively in an empty file, this
486 normally means that the file name does not automatically trigger Org-mode.
487 To ensure that the file will always be in Org-mode in the future, a
488 line enforcing Org-mode will be inserted into the buffer, if this option
489 has been set."
494 "Non-nil means use alternative key bindings for some keys.
495 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
496 These keys are also used by other packages like shift-selection-mode'
497 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
498 If you want to use Org-mode together with one of these other modes,
499 or more generally if you would like to move some Org-mode commands to
500 other keys, set this variable and configure the keys with the variable
501 `org-disputed-keys'.
503 This option is only relevant at load-time of Org-mode, and must be set
504 *before* org.el is loaded. Changing it requires a restart of Emacs to
505 become effective."
510 "Non-nil means use extra key sequence definitions for certain commands.
511 This happens automatically if you run XEmacs or if `window-system'
512 is nil. This variable lets you do the same manually. You must
513 set it before loading org.
515 Example: on Carbon Emacs 22 running graphically, with an external
516 keyboard on a Powerbook, the default way of setting M-left might
517 not work for either Alt or ESC. Setting this variable will make
518 it work for ESC."
532 "Keys for which Org-mode and other modes compete.
533 This is an alist, cars are the default keys, second element specifies
534 the alternative to use when `org-replace-disputed-keys' is t.
536 Keys can be specified in any syntax supported by `define-key'.
537 The value of this option takes effect only at Org-mode's startup,
538 therefore you'll have to restart Emacs to apply it after changing."
543 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
544 Or return the original if not disputed.
545 Also apply the translations defined in `org-xemacs-key-equivalents'."
550 org-disputed-keys)))
554 key)
564 "Define a key, possibly translated, as returned by `org-key'."
568 "The ellipsis to use in the Org-mode outline.
569 When nil, just use the standard three dots. When a string, use that instead,
570 When a face, use the standard 3 dots, but with the specified face.
571 The change affects only Org-mode (which will then use its own display table).
572 Changing this requires executing `M-x org-mode' in a buffer to become
573 effective."
583 "Keywords in Org-mode."
588 "String to mark deadline entries.
589 A deadline is this string, followed by a time stamp. Should be a word,
590 terminated by a colon. You can insert a schedule keyword and
592 Changes become only effective after restarting Emacs."
597 "String to mark scheduled TODO entries.
598 A schedule is this string, followed by a time stamp. Should be a word,
599 terminated by a colon. You can insert a schedule keyword and
601 Changes become only effective after restarting Emacs."
606 "String used as the prefix for timestamps logging closing a TODO entry."
611 "String used as prefix for timestamps clocking work hours on an item."
616 "Entries starting with this keyword will never be exported.
617 An entry can be toggled between COMMENT and normal with
619 Changes become only effective after restarting Emacs."
624 "Entries starting with this keyword will be exported in fixed-width font.
625 Quoting applies only to the text in the entry following the headline, and does
626 not extend beyond the next headline, even if that is lower level.
627 An entry can be toggled between QUOTE and normal with
634 "Regular expression for specifying repeated events.
638 "Options concerning the general structure of Org-mode files."
643 "Options about how to make context of a location visible."
667 "Non-nil means show full hierarchy when revealing a location.
668 Org-mode often shows locations in an org-mode file which might have
669 been invisible before. When this is set, the hierarchy of headings
670 above the exposed location is shown.
671 Turning this off for example for sparse trees makes them very compact.
672 Instead of t, this can also be an alist specifying this option for different
673 contexts. Valid contexts are
674 agenda when exposing an entry from the agenda
675 org-goto when using the command `org-goto' on key C-c C-j
676 occur-tree when using the command `org-occur' on key C-c /
677 tags-tree when constructing a sparse tree based on tags matches
678 link-search when exposing search matches associated with a link
679 mark-goto when exposing the jump goal of a mark
680 bookmark-jump when exposing a bookmark location
681 isearch when exiting from an incremental search
682 default default for all contexts not set explicitly"
687 "Non-nil means show following heading when revealing a location.
688 Org-mode often shows locations in an org-mode file which might have
689 been invisible before. When this is set, the heading following the
690 match is shown.
691 Turning this off for example for sparse trees makes them very compact,
692 but makes it harder to edit the location of the match. In such a case,
694 Instead of t, this can also be an alist specifying this option for different
695 contexts. See `org-show-hierarchy-above' for valid contexts."
700 "Non-nil means show all sibling heading when revealing a location.
701 Org-mode often shows locations in an org-mode file which might have
702 been invisible before. When this is set, the sibling of the current entry
703 heading are all made visible. If `org-show-hierarchy-above' is t,
704 the same happens on each level of the hierarchy above the current entry.
706 By default this is on for the isearch context, off for all other contexts.
707 Turning this off for example for sparse trees makes them very compact,
708 but makes it harder to edit the location of the match. In such a case,
710 Instead of t, this can also be an alist specifying this option for different
711 contexts. See `org-show-hierarchy-above' for valid contexts."
716 "Non-nil means show the entry below a headline when revealing a location.
717 Org-mode often shows locations in an org-mode file which might have
718 been invisible before. When this is set, the text below the headline that is
719 exposed is also shown.
721 By default this is off for all contexts.
722 Instead of t, this can also be an alist specifying this option for different
723 contexts. See `org-show-hierarchy-above' for valid contexts."
728 "How should indirect tree buffers be displayed?
729 This applies to indirect buffers created with the commands
731 Valid values are:
732 current-window Display in the current window
733 other-window Just display in another window.
734 dedicated-frame Create one new frame, and re-use it each time.
735 new-frame Make a new frame each time. Note that in this case
736 previously-made indirect buffers are kept, and you need to
737 kill these buffers yourself."
747 "Non-nil means activate single letter commands at beginning of a headline.
748 This may also be a function to test for appropriate locations where speed
749 commands should be active."
757 "Alist of additional speed commands.
758 This list will be checked before `org-speed-commands-default'
759 when the variable `org-use-speed-commands' is non-nil
760 and when the cursor is at the beginning of a headline.
761 The car if each entry is a string with a single letter, which must
762 be assigned to `self-insert-command' in the global map.
763 The cdr is either a command to be called interactively, a function
764 to be called, or a form to be evaluated.
765 An entry that is just a list with a single string will be interpreted
766 as a descriptive headline that will be added when listing the speed
767 commands in the Help buffer using the `?' speed command."
779 "Options concerning visibility cycling in Org-mode."
784 "Non-nil means skip CHILDREN state in entries that don't have any."
789 "Maximum level which should still be subject to visibility cycling.
790 Levels higher than this will, for cycling, be treated as text, not a headline.
791 When `org-odd-levels-only' is set, a value of N in this variable actually
792 means 2N-1 stars as the limiting headline.
793 When nil, cycle all levels.
794 Note that the limiting level of cycling is also influenced by
795 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
796 `org-inlinetask-min-level' is, cycling will be limited to levels one less
797 than its value."
804 "Names of drawers. Drawers are not opened by cycling on the headline above.
805 Drawers only open with a TAB on the drawer line itself. A drawer looks like
806 this:
807 :DRAWERNAME:
808 .....
809 :END:
811 the property API.
813 Drawers can be defined on the per-file basis with a line like:
815 #+DRAWERS: HIDDEN STATE PROPERTIES"
821 "Non-nil means entering Org-mode will fold all blocks.
822 This can also be set in on a per-file basis with
824 #+STARTUP: hideblocks
825 #+STARTUP: showblocks"
831 "Cycle globally if cursor is at beginning of buffer and not at a headline.
832 This makes it possible to do global cycling without having to use S-TAB or
834 of the buffer
835 must not be a headline - it may be empty or some other text. When used in
836 this way, `org-cycle-hook' is disables temporarily, to make sure the
837 cursor stays at the beginning of the buffer.
838 When this option is nil, don't do anything special at the beginning
839 of the buffer."
844 "Non-nil means cycle entry level or item indentation in new empty entries.
846 When the cursor is at the end of an empty headline, i.e with only stars
847 and maybe a TODO keyword, TAB will then switch the entry to become a child,
848 and then all possible ancestor states, before returning to the original state.
849 This makes data entry extremely fast: M-RET to create a new headline,
850 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
852 When the cursor is at the end of an empty plain list item, one TAB will
853 make it a subitem, two or more tabs will back up to make this an item
854 higher up in the item hierarchy."
859 "Where should `org-cycle' emulate TAB.
860 nil Never
861 white Only in completely white lines
862 whitestart Only at the beginning of lines, before the first non-white char
863 t Everywhere except in headlines
864 exc-hl-bol Everywhere except at the start of a headline
865 If TAB is used in a place where it does not emulate TAB, the current subtree
866 visibility is cycled."
873 ))
876 "Number of empty lines needed to keep an empty line between collapsed trees.
877 If you leave an empty line between the end of a subtree and the following
878 headline, this empty line is hidden when the subtree is folded.
879 Org-mode will leave (exactly) one empty line visible if the number of
880 empty lines is equal or larger to the number given in this variable.
881 So the default 2 means at least 2 empty lines after the end of a subtree
882 are needed to produce free space between a collapsed subtree and the
883 following headline.
885 If the number is negative, and the number of empty lines is at least -N,
886 all empty lines are shown.
888 Special case: when 0, never leave empty lines in collapsed view."
894 "Hook that is run before visibility cycling is happening.
895 The function(s) in this hook must accept a single argument which indicates
896 the new state that will be set right after running this hook. The
897 argument is a symbol. Before a global state change, it can have the values
898 `overview', `content', or `all'. Before a local state change, it can have
899 the values `folded', `children', or `subtree'."
904 org-cycle-hide-drawers
905 org-cycle-show-empty-lines
906 org-optimize-window-after-visibility-change)
907 "Hook that is run after `org-cycle' has changed the buffer visibility.
908 The function(s) in this hook must accept a single argument which indicates
909 the new state that was set by the most recent `org-cycle' command. The
910 argument is a symbol. After a global state change, it can have the values
911 `overview', `content', or `all'. After a local state change, it can have
912 the values `folded', `children', or `subtree'."
917 "Options concerning structure editing in Org-mode."
922 "Non-nil means skip even levels and only use odd levels for the outline.
923 This has the effect that two stars are being added/taken away in
924 promotion/demotion commands. It also influences how levels are
925 handled by the exporters.
926 Changing it requires restart of `font-lock-mode' to become effective
927 for fontification also in regions already fontified.
928 You may also set this on a per-file basis by adding one of the following
929 lines to the buffer:
931 #+STARTUP: odd
932 #+STARTUP: oddeven"
938 "Non-nil means adapt indentation to outline node level.
940 When this variable is set, Org assumes that you write outlines by
941 indenting text in each node to align with the headline (after the stars).
942 The following issues are influenced by this variable:
944 - When this is set and the *entire* text in an entry is indented, the
945 indentation is increased by one space in a demotion command, and
946 decreased by one in a promotion command. If any line in the entry
947 body starts with text at column 0, indentation is not changed at all.
949 - Property drawers and planning information is inserted indented when
950 this variable s set. When nil, they will not be indented.
952 - TAB indents a line relative to context. The lines below a headline
953 will be indented when this variable is set.
955 Note that this is all about true indentation, by adding and removing
956 space characters. See also `org-indent.el' which does level-dependent
957 indentation in a virtual way, i.e. at display time in Emacs."
962 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
964 When t, `C-a' will bring back the cursor to the beginning of the
965 headline text, i.e. after the stars and after a possible TODO keyword.
966 In an item, this will be the position after the bullet.
967 When the cursor is already at that position, another `C-a' will bring
968 it to the beginning of the line.
970 `C-e' will jump to the end of the headline, ignoring the presence of tags
971 in the headline. A second `C-e' will then jump to the true end of the
972 line, after any tags. This also means that, when this variable is
973 non-nil, `C-e' also will never jump beyond the end of the heading of a
974 folded section, i.e. not after the ellipses.
976 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
977 going to the true line boundary first. Only a directly following, identical
978 keypress will bring the cursor to the special positions.
980 This may also be a cons cell where the behavior for `C-a' and `C-e' is
981 set separately."
1000 "Non-nil means `C-k' will behave specially in headlines.
1001 When nil, `C-k' will call the default `kill-line' command.
1002 When t, the following will happen while the cursor is in the headline:
1004 - When the cursor is at the beginning of a headline, kill the entire
1005 line and possible the folded subtree below the line.
1006 - When in the middle of the headline text, kill the headline up to the tags.
1007 - When after the headline text, kill the tags."
1012 "Non-nil means, do not delete a hidden subtree with C-k.
1013 When set to the symbol `error', simply throw an error when C-k is
1014 used to kill (part-of) a headline that has hidden text behind it.
1015 Any other non-nil value will result in a query to the user, if it is
1016 OK to kill that hidden subtree. When nil, kill without remorse."
1024 "Non-nil means when yanking subtrees, fold them.
1025 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1026 it starts with a heading and all other headings in it are either children
1027 or siblings, then fold all the subtrees. However, do this only if no
1028 text after the yank would be swallowed into a folded tree by this action."
1033 "Non-nil means when yanking subtrees, adjust the level.
1034 With this setting, `org-paste-subtree' is used to insert the subtree, see
1035 this function for details."
1040 "Non-nil means M-RET will split the line at the cursor position.
1041 When nil, it will go to the end of the line before making a
1042 new line.
1043 You may also set this option in a different way for different
1044 contexts. Valid contexts are:
1046 headline when creating a new headline
1047 item when creating a new item
1048 table in a table field
1049 default the value to be used for all contexts not explicitly
1050 customized"
1067 "Non-nil means insert new headings after the current subtree.
1068 When nil, the new heading is created directly after the current line.
1071 for the duration of the command."
1077 "Should `org-insert-heading' leave a blank line before new heading/item?
1078 The value is an alist, with `heading' and `plain-list-item' as car,
1079 and a boolean flag as cdr. The cdr may lso be the symbol `auto', and then
1080 Org will look at the surrounding headings/items and try to make an
1081 intelligent decision wether to insert a blank line or not.
1083 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1084 set, the setting here is ignored and no empty line is inserted, to avoid
1085 breaking the list structure."
1098 "Hook being run after inserting a new heading."
1104 This currently only means they are never auto-wrapped.
1105 When nil, such lines will be treated like ordinary lines.
1106 See also the QUOTE keyword."
1111 "Non-nil means typing characters in `org-goto' starts incremental search."
1116 "Options concerning sparse trees in Org-mode."
1121 "Non-nil means highlight all matches that define a sparse tree.
1122 The highlights will automatically disappear the next time the buffer is
1123 changed by an edit command."
1128 "Non-nil means any change to the buffer will remove temporary highlights.
1129 Such highlights are created by `org-occur' and `org-clock-display'.
1130 When nil, `C-c C-c needs to be used to get rid of the highlights.
1131 The highlights created by `org-preview-latex-fragment' always need
1132 `C-c C-c' to be removed."
1139 "Hook that is run after `org-occur' has constructed a sparse tree.
1140 This can be used to recenter the window to show as much of the structure
1141 as possible."
1146 "Options concerning imenu and speedbar in Org-mode."
1151 "The maximum level for Imenu access to Org-mode headlines.
1152 This also applied for speedbar access."
1157 "Options concerning tables in Org-mode."
1163 When nil, such lines will be treated like ordinary lines.
1165 When equal to the symbol `optimized', the table editor will be optimized to
1166 do the following:
1167 - Automatic overwrite mode in front of whitespace in table fields.
1168 This makes the structure of the table stay in tact as long as the edited
1169 field does not exceed the column width.
1170 - Minimize the number of realigns. Normally, the table is aligned each time
1171 TAB or RET are pressed to move to another field. With optimization this
1172 happens only if changes to a field might have changed the column width.
1173 Optimization requires replacing the functions `self-insert-command',
1174 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1175 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1176 very good at guessing when a re-align will be necessary, but you can always
1179 If you would like to use the optimized version in Org-mode, but the
1180 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1182 This variable can be used to turn on and off the table editor during a session,
1183 but in order to toggle optimization, a restart is required.
1185 See also the variable `org-table-auto-blank-field'."
1193 "Non-nil means cluster self-insert commands for undo when possible.
1194 If this is set, then, like in the Emacs command loop, 20 consecutive
1195 characters will be undone together.
1196 This is configurable, because there is some impact on typing performance."
1201 "Non-nil means TAB will automatically notice a table.el table.
1202 When it sees such a table, it moves point into it and - if necessary -
1203 calls `table-recognize-table'."
1208 "Options concerning links in Org-mode."
1213 "Buffer-local version of `org-link-abbrev-alist', which see.
1218 "Alist of link abbreviations.
1219 The car of each element is a string, to be replaced at the start of a link.
1221 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1223 [[linkkey:tag][description]]
1225 The 'linkkey' must be a word word, starting with a letter, followed
1226 by letters, numbers, '-' or '_'.
1228 If REPLACE is a string, the tag will simply be appended to create the link.
1231 be inserted at that point (see the function `url-hexify-string').
1233 REPLACE may also be a function that will be called with the tag as the
1234 only argument to create the link, which should be returned as a string.
1236 See the manual for examples."
1246 "Non-nil means hide link part and only show description of bracket links.
1247 Bracket links are like [[link][description]]. This variable sets the initial
1248 state in new org-mode buffers. The setting can then be toggled on a
1249 per-buffer basis from the Org->Hyperlinks menu."
1254 "How the path name in file links should be stored.
1255 Valid values are:
1257 relative Relative to the current directory, i.e. the directory of the file
1258 into which the link is being inserted.
1259 absolute Absolute path, if possible with ~ for home directory.
1260 noabbrev Absolute path, no abbreviation of home directory.
1261 adaptive Use relative path for files in the current directory and sub-
1262 directories of it. For other files, use an absolute path."
1271 "Types of links that should be activated in Org-mode files.
1272 This is a list of symbols, each leading to the activation of a certain link
1273 type. In principle, it does not hurt to turn on most link types - there may
1274 be a small gain when turning off unused link types. The types are:
1276 bracket The recommended [[link][description]] or [[link]] links with hiding.
1277 angle Links in angular brackets that may contain whitespace like
1278 <bbdb:Carsten Dominik>.
1279 plain Plain links in normal text, no whitespace, like http://google.com.
1280 radio Text that is matched by a radio target, see manual for details.
1281 tag Tag settings in a headline (link to tag search).
1282 date Time stamps (link to calendar).
1283 footnote Footnote labels.
1285 Changing this variable requires a restart of Emacs to become effective."
1297 "Function to use to generate link descriptions from links.
1298 If nil the link location will be used. This function must take
1299 two parameters; the first is the link and the second the
1300 description `org-insert-link' has generated, and should return the
1301 description to use."
1306 "Options concerning storing links in Org-mode."
1311 "Format of the description part of a link to an email or usenet message.
1312 The following %-escapes will be replaced by corresponding information:
1320 %s subject
1321 %m message-id.
1323 You may use normal field width specification between the % and the letter.
1324 This is for example useful to limit the length of the subject.
1338 It should match if the message is from the user him/herself."
1343 "Non-nil means storing a link to an Org file will use entry IDs.
1345 Note that before this variable is even considered, org-id must be loaded,
1346 so please customize `org-modules' and turn it on.
1348 The variable can have the following values:
1350 t Create an ID if needed to make a link to the current entry.
1352 create-if-interactive
1353 If `org-store-link' is called directly (interactively, as a user
1354 command), do create an ID to support the link. But when doing the
1355 job for remember, only use the ID if it already exists. The
1356 purpose of this setting is to avoid proliferation of unwanted
1357 IDs, just because you happen to be in an Org file when you
1358 call `org-remember' that automatically and preemptively
1359 creates a link. If you do want to get an ID link in a remember
1360 template to an entry not having an ID, create it first by
1361 explicitly creating a link to it, using `C-c C-l' first.
1363 create-if-interactive-and-no-custom-id
1364 Like create-if-interactive, but do not create an ID if there is
1365 a CUSTOM_ID property defined in the entry. This is the default.
1367 use-existing
1368 Use existing ID, do not create one.
1370 nil Never use an ID to make a link, instead link using a text search for
1371 the headline text."
1376 create-if-interactive)
1378 create-if-interactive-and-no-custom-id)
1383 "Non-nil means file links from `org-store-link' contain context.
1384 A search string will be added to the file name with :: as separator and
1385 used to find the context when the link is activated by the command
1386 `org-open-at-point'.
1388 negates this setting for the duration of the command."
1393 "Non-nil means keep link in list for entire session.
1395 The command `org-store-link' adds a link pointing to the current
1396 location to an internal list. These links accumulate during a session.
1397 The command `org-insert-link' can be used to insert links into any
1398 Org-mode file (offering completion for all stored links). When this
1400 will be removed from the list, to make completing the unused links
1401 more efficient."
1406 "Options concerning following links in Org-mode."
1411 "Function to translate links with different syntax to Org syntax.
1412 This can be used to translate links created for example by the Planner
1413 or emacs-wiki packages to Org syntax.
1414 The function must accept two parameters, a TYPE containing the link
1416 which is everything after the link protocol. It should return a cons
1417 with possibly modified values of type and path.
1418 Org contains a function for this, so if you set this variable to
1419 `org-translate-link-from-planner', you should be able follow many
1420 links created by planner."
1425 "Hook that is run after a link has been followed."
1430 "Non-nil means on links TAB will follow the link.
1431 Needs to be set before org.el is loaded.
1432 This really should not be used, it does not make sense, and the
1433 implementation is bad."
1438 "Non-nil means on links RET will follow the link."
1444 "Non-nil means mouse-1 on a link will follow the link.
1445 A longer mouse click will still set point. Does not work on XEmacs.
1446 Needs to be set before org.el is loaded."
1451 "Number of different positions to be recorded in the ring.
1452 Changing this requires a restart of Emacs to work correctly."
1457 "Non-nil means internal links in Org files must exactly match a headline.
1458 When nil, the link search tries to match a phrase will all words
1459 in the search text."
1465 query-to-create)))
1472 "Setup the frame configuration for following links.
1473 When following a link with Emacs, it may often be useful to display
1474 this link in another window or frame. This variable can be used to
1475 set this up for the different types of links.
1476 For VM, use any of
1477 `vm-visit-folder'
1478 `vm-visit-folder-other-frame'
1479 For Gnus, use any of
1480 `gnus'
1481 `gnus-other-frame'
1482 `org-gnus-no-new-news'
1483 For FILE, use any of
1484 `find-file'
1485 `find-file-other-window'
1486 `find-file-other-frame'
1487 For Wanderlust use any of
1488 `wl'
1489 `wl-other-frame'
1490 For the calendar, use the variable `calendar-setup'.
1491 For BBDB, it is currently only possible to display the matches in
1492 another window."
1516 "Non-nil means use indirect buffer to display infile links.
1517 Activating internal links (from one location in a file to another location
1518 in the same file) normally just jumps to the location. When the link is
1520 is displayed in
1521 another window. When this option is set, the other window actually displays
1522 an indirect buffer clone of the current buffer, to avoid any visibility
1523 changes to the current buffer."
1528 "Non-nil means `org-open-file' will open non-existing files.
1529 When nil, an error will be generated.
1530 This variable applies only to external applications because they
1531 might choke on non-existing files. If the link is to a file that
1532 will be opened in Emacs, the variable is ignored."
1537 "Non-nil means a link to a directory really means to index.org.
1538 When nil, following a directory link will run dired or open a finder/explorer
1539 window on that directory."
1544 "Function and arguments to call for following mailto links.
1545 This is a list with the first element being a Lisp function, and the
1546 remaining elements being arguments to the function. In string arguments,
1547 %a will be replaced by the address, and %s will be replaced by the subject
1548 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1557 "Non-nil means ask for confirmation before executing shell links.
1558 Shell links can be dangerous: just think about a link
1560 [[shell:rm -rf ~/*][Google Search]]
1563 but really it would remove your entire home directory.
1564 Therefore we advise against setting this variable to nil.
1565 Just change it to `y-or-n-p' if you want to confirm with a
1573 'safe-local-variable
1577 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1578 Elisp links can be dangerous: just think about a link
1583 but really it would remove your entire home directory.
1584 Therefore we advise against setting this variable to nil.
1585 Just change it to `y-or-n-p' if you want to confirm with a
1593 'safe-local-variable
1600 "Default file applications on a UNIX or GNU/Linux system.
1611 "Default file applications on a MacOS X system.
1613 for some files for which the OS does not have a good default.
1621 'mswindows-shell-execute
1626 'mswindows-shell-execute
1629 "Default file applications on a Windows NT system.
1634 '(
1639 )
1640 "External applications for opening `file:path' items in a document.
1641 Org-mode uses system defaults for different file types, but
1642 you can use this variable to set the application for a given file
1643 extension. The entries in this list are cons cells where the car identifies
1644 files and the cdr the corresponding command. Possible values for the
1645 file identifier are
1647 ways, depending on its contents:
1649 - Alphanumeric characters only:
1650 Match links with this file extension.
1652 to open PDFs with evince.
1654 - Regular expression: Match links where the
1655 filename matches the regexp. If you want to
1656 use groups here, use shy groups.
1660 to open *.html and *.xhtml with firefox.
1662 - Regular expression which contains (non-shy) groups:
1664 anything after that, matches the regexp.
1665 In a custom command string, %1, %2, etc. are replaced with
1666 the parts of the link that were matched by the groups.
1667 For backwards compatibility, if a command string is given
1668 that does not use any of the group matches, this case is
1669 handled identically to the second one (i.e. match against
1670 file name only).
1671 In a custom lisp form, you can access the group matches with
1672 (match-string n link).
1675 to open [[file:document.pdf::5]] with evince at page 5.
1677 `directory' Matches a directory
1678 `remote' Matches a remote file, accessible through tramp or efs.
1679 Remote files most likely should be visited through Emacs
1680 because external applications cannot handle such paths.
1681 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1682 so all files Emacs knows how to handle. Using this with
1683 command `emacs' will open most files in Emacs. Beware that this
1684 will also open html files inside Emacs, unless you add
1686 t Default for files not matched by any of the other options.
1687 `system' The system command to open files, like `open' on Windows
1688 and Mac OS X, and mailcap under GNU/Linux. This is the command
1689 that will be selected if you call `C-c C-o' with a double
1692 Possible values for the command are:
1693 `emacs' The file will be visited by the current Emacs process.
1694 `default' Use the default application for this file type, which is the
1695 association for t in the list, most likely in the system-specific
1696 part.
1697 This can be used to overrule an unwanted setting in the
1698 system-specific variable.
1700 This command is specified by the entry whose car is `system'.
1701 Most likely, the system-specific version of this variable
1702 does define this command, but you can overrule/replace it
1703 here.
1704 string A command to be executed by a shell; %s will be replaced
1705 by the path to the file.
1706 sexp A Lisp form which will be evaluated. The file path will
1707 be available in the Lisp variable `file'.
1708 For more examples, see the system specific constants
1709 `org-file-apps-defaults-macosx'
1710 `org-file-apps-defaults-windowsnt'
1711 `org-file-apps-defaults-gnu'."
1721 auto-mode))
1732 "Options concerning refiling entries in Org-mode."
1737 "Directory with org files.
1738 This is just a default location to look for Org files. There is no need
1739 at all to put your files into this directory. It is only used in the
1740 following situations:
1742 1. When a remember template specifies a target file that is not an
1743 absolute path. The path will then be interpreted relative to
1744 `org-directory'
1745 2. When a remember note is filed away in an interactive way (when exiting the
1746 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1747 with `org-directory' as the default path."
1753 "Default target for storing notes.
1754 Used as a fall back file for org-remember.el and org-capture.el, for
1755 templates that do not specify a target file."
1760 file))
1763 "The default interface to be used for `org-goto'.
1764 Allowed values are:
1765 outline The interface shows an outline of the relevant file
1766 and the correct heading is found by moving through
1767 the outline or by searching with incremental search.
1768 outline-path-completion Headlines in the current buffer are offered via
1769 completion. This is the interface also used by
1770 the refile command."
1777 "Maximum target level when running `org-goto' with refile interface."
1782 "Non-nil means store new notes at the beginning of a file or entry.
1783 When nil, new notes will be filed to the end of a file or entry.
1784 This can also be a list with cons cells of regular expressions that
1785 are matched against file names, and values."
1795 "Information to record when a task is refiled.
1797 Possible values are:
1799 nil Don't add anything
1800 time Add a time stamp to the task
1801 note Prompt for a note and add it with template `org-log-note-headings'
1803 This option can also be set with on a per-file-basis with
1805 #+STARTUP: nologrefile
1806 #+STARTUP: logrefile
1807 #+STARTUP: lognoterefile
1809 You can have local logging settings for a subtree by setting the LOGGING
1810 property to one or more of these keywords.
1812 When bulk-refiling from the agenda, the value `note' is forbidden and
1813 will temporarily be changed to `time'."
1823 This is list of cons cells. Each cell contains:
1824 - a specification of the files to be considered, either a list of files,
1825 or a symbol whose function or variable value will be used to retrieve
1826 a file name or a list of file names. If you use `org-agenda-files' for
1827 that, all agenda files will be scanned for targets. Nil means consider
1828 headings in the current buffer.
1829 - A specification of how to find candidate refile targets. This may be
1830 any of:
1832 This tag has to be present in all target headlines, inheritance will
1833 not be considered.
1835 todo keyword.
1837 headlines that are refiling targets.
1838 - a cons cell (:level . N). Any headline of level N is considered a target.
1839 Note that, when `org-odd-levels-only' is set, level corresponds to
1840 order in hierarchy, not to the number of stars.
1841 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1842 Note that, when `org-odd-levels-only' is set, level corresponds to
1843 order in hierarchy, not to the number of stars.
1845 You can set the variable `org-refile-target-verify-function' to a function
1846 to verify each headline found by the simple criteria above.
1848 When this variable is nil, all top-level headlines in the current buffer
1849 are used, equivalent to the value `((nil . (:level . 1))'."
1865 "Function to verify if the headline at point should be a refile target.
1866 The function will be called without arguments, with point at the
1867 beginning of the headline. It should return t and leave point
1868 where it is if the headline is a valid target for refiling.
1870 If the target should not be selected, the function must return nil.
1871 In addition to this, it may move point to a place from where the search
1872 should be continued. For example, the function may decide that the entire
1873 subtree of the current entry should be excluded and move point to the end
1874 of the subtree."
1879 "Non-nil means cache refile targets to speed up the process.
1880 The cache for a particular file will be updated automatically when
1881 the buffer has been killed, or when any of the marker used for flagging
1882 refile targets no longer points at a live buffer.
1883 If you have added new entries to a buffer that might themselves be targets,
1884 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1885 find that easier, `C-u C-u C-u C-c C-w'."
1890 "Non-nil means provide refile targets as paths.
1891 So a level 3 headline will be available as level1/level2/level3.
1893 When the value is `file', also include the file name (without directory)
1894 into the path. In this case, you can also stop the completion after
1895 the file name, to get entries inserted as top level in the file.
1897 When `full-file-path', include the full file path."
1906 "Non-nil means complete the outline path in hierarchical steps.
1907 When Org-mode uses the refile interface to select an outline path
1908 \(see variable `org-refile-use-outline-path'), the completion of
1909 the path can be done is a single go, or if can be done in steps down
1910 the headline hierarchy. Going in steps is probably the best if you
1911 do not use a special completion package like `ido' or `icicles'.
1912 However, when using these packages, going in one step can be very
1913 fast, while still showing the whole path to the entry."
1918 "Non-nil means allow to create new nodes as refile targets.
1920 of an existing node. When the value of this variable is `confirm',
1921 new node creation must be confirmed by the user (recommended)
1922 When nil, the completion must match an existing entry.
1924 Note that, if the new heading is not seen by the criteria
1925 listed in `org-refile-targets', multiple instances of the same
1926 heading would be created by trying again to file under the new
1927 heading."
1935 "Options concerning TODO items in Org-mode."
1940 "Options concerning Progress logging in Org-mode."
1945 '(
1948 "The available interpretation symbols for customizing `org-todo-keywords'.
1952 "List of TODO entry keyword sequences and their interpretation.
1955 Each sequence starts with a symbol, either `sequence' or `type',
1956 indicating if the keywords should be interpreted as a sequence of
1957 action steps, or as different types of TODO items. The first
1958 keywords are states requiring action - these states will select a headline
1959 for inclusion into the global TODO list Org-mode produces. If one of
1962 the last keyword is treated as the only DONE state of the sequence.
1965 additional state where no keyword is present. For details about this
1966 cycling, see the manual.
1968 TODO keywords and interpretation can also be set on a per-file basis with
1969 the special #+SEQ_TODO and #+TYP_TODO lines.
1971 Each keyword can optionally specify a character for fast state selection
1972 \(in combination with the variable `org-use-fast-todo-selection')
1973 and specifiers for state change logging, using the same syntax
1976 indicates to record a time stamp each time this state is selected.
1978 Each keyword may also specify if a timestamp or a note should be
1979 recorded when entering or leaving the state, by adding additional
1980 characters in the parenthesis after the keyword. This looks like this:
1982 record only the time of the state change. With X and Y being either
1984 Y when leaving the state if and only if the *target* state does not
1985 define X. You may omit any of the fast-selection key or X or /Y,
1986 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
1988 For backward compatibility, this variable may also be just a list
1989 of keywords - in this case the interpretation (sequence or type) will be
1990 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2000 ;;Quick and dirty way to see
2001 ;;`org-todo-interpretations'. This takes the
2002 ;;place of item arguments
2003 :convert-widget
2010 org-todo-interpretation-widgets))
2011 widget))
2042 "Controls how TODO keywords are interpreted.
2043 This variable is in principle obsolete and is only used for
2044 backward compatibility, if the interpretation of todo keywords is
2045 not given already in `org-todo-keywords'. See that variable for
2046 more information."
2053 "Non-nil means use the fast todo selection scheme with C-c C-t.
2054 This variable describes if and under what circumstances the cycling
2055 mechanism for TODO keywords will be replaced by a single-key, direct
2056 selection scheme.
2058 When nil, fast selection is never used.
2060 When the symbol `prefix', it will be used when `org-todo' is called with
2061 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2062 in an agenda buffer.
2064 When t, fast selection is used by default. In this case, the prefix
2065 argument forces cycling instead.
2067 In all cases, the special interface is only used if access keys have actually
2068 been assigned by the user, i.e. if keywords in the configuration are followed
2069 by a letter in parenthesis, like TODO(t)."
2077 "Non-nil means update todo statistics after insert and toggle.
2078 ALL-HEADLINES means update todo statistics by including headlines
2079 with no TODO keyword as well, counting them as not done.
2080 A list of TODO keywords means the same, but skip keywords that are
2081 not in this list.
2083 When this is set, todo statistics is updated in the parent of the
2084 current entry each time a todo state is changed."
2094 "Non-nil means TODO statistics covers just direct children.
2095 When nil, all entries in the subtree are considered.
2096 This has only an effect if `org-provide-todo-statistics' is set.
2097 To set this to nil for only a single subtree, use a COOKIE_DATA
2103 "Hook which is run after the state of a TODO item was changed.
2104 The new state (a string with a TODO keyword, or nil) is available in the
2105 Lisp variable `state'."
2110 "Hook for functions that are allowed to block a state change.
2112 Each function gets as its single argument a property list, see
2113 `org-trigger-hook' for more information about this list.
2115 If any of the functions in this hook returns nil, the state change
2119 "Hook for functions that are triggered by a state change.
2121 Each function gets as its single argument a property list with at least
2122 the following elements:
2124 (:type type-of-change :position pos-at-entry-start
2125 :from old-state :to new-state)
2127 Depending on the type, more properties may be present.
2129 This mechanism is currently implemented for:
2131 TODO state changes
2132 ------------------
2133 :type todo-state-change
2134 :from previous state (keyword as a string), or nil, or a symbol
2135 'todo' or 'done', to indicate the general type of state.
2139 "Non-nil means undone TODO entries will block switching the parent to DONE.
2140 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2141 be blocked if any prior sibling is not yet done.
2142 Finally, if the parent is blocked because of ordered siblings of its own,
2143 the child will also be blocked.
2144 This variable needs to be set before org.el is loaded, and you need to
2145 restart Emacs after a change to make the change effective. The only way
2146 to change is while Emacs is running is through the customize interface."
2158 "Non-nil means unchecked boxes will block switching the parent to DONE.
2159 When this is nil, checkboxes have no influence on switching TODO states.
2160 When non-nil, you first need to check off all check boxes before the TODO
2161 entry can be switched to DONE.
2162 This variable needs to be set before org.el is loaded, and you need to
2163 restart Emacs after a change to make the change effective. The only way
2164 to change is while Emacs is running is through the customize interface."
2176 "Non-nil means inserting a TODO heading is treated as state change.
2178 logging will apply if appropriate. When nil, the new TODO item will
2179 be inserted directly, and no logging will take place."
2184 "Non-nil means switching TODO states with S-cursor counts as state change.
2185 This is the default behavior. However, setting this to nil allows a
2186 convenient way to select a TODO state and bypass any logging associated
2187 with that."
2192 "Tag changes that should be triggered by TODO state changes.
2193 This is a list. Each entry is
2195 (state-change (tag . flag) .......)
2197 State-change can be a string with a state, and empty string to indicate the
2198 state that has no TODO keyword, or it can be one of the symbols `todo'
2199 or `done', meaning any not-done or done state, respectively."
2213 "Information to record when a task moves to the DONE state.
2215 Possible values are:
2217 nil Don't add anything, just change the keyword
2218 time Add a time stamp to the task
2219 note Prompt for a note and add it with template `org-log-note-headings'
2221 This option can also be set with on a per-file-basis with
2223 #+STARTUP: nologdone
2224 #+STARTUP: logdone
2225 #+STARTUP: lognotedone
2227 You can have local logging settings for a subtree by setting the LOGGING
2228 property to one or more of these keywords."
2236 ;; Normalize old uses of org-log-done.
2243 "Information to record when the scheduling date of a tasks is modified.
2245 Possible values are:
2247 nil Don't add anything, just change the date
2248 time Add a time stamp to the task
2249 note Prompt for a note and add it with template `org-log-note-headings'
2251 This option can also be set with on a per-file-basis with
2253 #+STARTUP: nologreschedule
2254 #+STARTUP: logreschedule
2255 #+STARTUP: lognotereschedule"
2264 "Information to record when the deadline date of a tasks is modified.
2266 Possible values are:
2268 nil Don't add anything, just change the date
2269 time Add a time stamp to the task
2270 note Prompt for a note and add it with template `org-log-note-headings'
2272 This option can also be set with on a per-file-basis with
2274 #+STARTUP: nologredeadline
2275 #+STARTUP: logredeadline
2276 #+STARTUP: lognoteredeadline
2278 You can have local logging settings for a subtree by setting the LOGGING
2279 property to one or more of these keywords."
2288 "Non-nil means record a note when clocking out of an item.
2289 This can also be configured on a per-file basis by adding one of
2290 the following lines anywhere in the buffer:
2292 #+STARTUP: lognoteclock-out
2293 #+STARTUP: nolognoteclock-out"
2299 "Non-nil means the CLOSED time stamp will contain date and time.
2300 When nil, only the date will be recorded."
2314 "Headings for notes added to entries.
2315 The value is an alist, with the car being a symbol indicating the note
2316 context, and the cdr is the heading to be used. The heading may also be the
2317 empty string.
2318 %t in the heading will be replaced by a time stamp.
2319 %T will be an active time stamp instead the default inactive one
2320 %s will be replaced by the new TODO state, in double quotes.
2321 %S will be replaced by the old TODO state, in double quotes.
2322 %u will be replaced by the user name.
2323 %U will be replaced by the full user name.
2325 In fact, it is not a good idea to change the `state' entry, because
2326 agenda log mode depends on the format of these entries."
2332 "Heading when changing todo state (todo sequence only)"
2346 "Non-nil means insert state change notes and time stamps into a drawer.
2347 When nil, state changes notes will be inserted after the headline and
2348 any scheduling and clock lines, but not inside a drawer.
2350 The value of this variable should be the name of the drawer to use.
2351 LOGBOOK is proposed at the default drawer for this purpose, you can
2352 also set this to a string to define the drawer of your choice.
2356 If this variable is set, `org-log-state-notes-insert-after-drawers'
2357 will be ignored.
2359 You can set the property LOG_INTO_DRAWER to overrule this setting for
2360 a subtree."
2372 "Return the value of `org-log-into-drawer', but let properties overrule.
2373 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2374 used instead of the default value."
2382 "Non-nil means insert state change notes after any drawers in entry.
2383 Only the drawers that *immediately* follow the headline and the
2384 deadline/scheduled line are skipped.
2385 When nil, insert notes right after the heading and perhaps the line
2386 with deadline/scheduling if present.
2388 This variable will have no effect if `org-log-into-drawer' is
2389 set."
2395 "Non-nil means the latest state note will be directly after heading.
2396 When nil, the state change notes will be ordered according to time."
2402 "The TODO state to which a repeater should return the repeating task.
2403 By default this is the first task in a TODO sequence, or the previous state
2404 in a TODO_TYP set. But you can specify another task here.
2405 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2411 "Non-nil means record moving through the DONE state when triggering repeat.
2412 An auto-repeating task is immediately switched back to TODO when
2415 record a closing note, there will be no record of the task moving
2416 through DONE. This variable forces taking a note anyway.
2418 nil Don't force a record
2419 time Record a time stamp
2420 note Record a note
2422 This option can also be set with on a per-file-basis with
2424 #+STARTUP: logrepeat
2425 #+STARTUP: lognoterepeat
2426 #+STARTUP: nologrepeat
2428 You can have local logging settings for a subtree by setting the LOGGING
2429 property to one or more of these keywords."
2439 "Priorities in Org-mode."
2444 "Non-nil means priority commands are active.
2445 When nil, these commands will be disabled, so that you never accidentally
2446 set a priority."
2451 "The highest priority of TODO items. A character like ?A, ?B etc.
2452 Must have a smaller ASCII number than `org-lowest-priority'."
2457 "The lowest priority of TODO items. A character like ?A, ?B etc.
2458 Must have a larger ASCII number than `org-highest-priority'."
2463 "The default priority of TODO items.
2464 This is the priority an item get if no explicit priority is given."
2469 "Non-nil means start with default priority when starting to cycle.
2470 When this is nil, the first step in the cycle will be (depending on the
2471 command used) one higher or lower that the default priority."
2476 "Options concerning time stamps and deadlines in Org-mode."
2481 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2482 When nil, these labeled time stamps are forces into the second line of an
2483 entry, just after the headline. When scheduling from the global TODO list,
2484 the time stamp will always be forced into the second line."
2489 "Formats for `format-time-string' which are used for time stamps.
2493 "Number of minutes to round time stamps to.
2494 These are two values, the first applies when first creating a time stamp.
2495 The second applies when changing it with the commands `S-up' and `S-down'.
2496 When changing the time stamp, this means that it will change in steps
2497 of N minutes, as given by the second value.
2499 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2500 numbers should be factors of 60, so for example 5, 10, 15.
2502 When this is larger than 1, you can still force an exact time stamp by using
2503 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2504 and by using a prefix arg to `S-up/down' to specify the exact number
2505 of minutes to shift."
2515 ;; Normalize old customizations of this variable.
2519 org-time-stamp-rounding-minutes)))
2522 "Non-nil means overlay custom formats over all time stamps.
2523 The formats are defined through the variable `org-time-stamp-custom-formats'.
2524 To turn this on on a per-file basis, insert anywhere in the file:
2525 #+STARTUP: customtime"
2533 "Custom formats for time stamps. See `format-time-string' for the syntax.
2534 These are overlayed over the default ISO format if the variable
2535 `org-display-custom-times' is set. Time like %H:%M should be at the
2536 end of the second format. The custom formats are also honored by export
2537 commands, if custom time display is turned on at the time of export."
2542 "Get the right format for a time string."
2547 f)))
2550 "The format string used when creating CLOCKSUM lines.
2551 This is also used when org-mode generates a time duration."
2557 org-mode generates a time duration."
2562 "The format string used when creating CLOCKSUM lines, or when
2563 org-mode generates a time duration."
2568 "No. of days before expiration during which a deadline becomes active.
2569 This variable governs the display in sparse trees and in the agenda.
2570 When 0 or negative, it means use this number (the absolute value of it)
2571 even if a deadline has a different individual lead time specified.
2573 Custom commands can set this variable in the options section."
2579 "Non-nil means assume future for incomplete date input from user.
2580 This affects the following situations:
2581 1. The user gives a month but not a year.
2584 2. The user gives a day, but no month.
2587 it will be considered as *this* month.
2589 If you set this variable to the symbol `time', then also the following
2590 will work:
2592 3. If the user gives a time, but no day. If the time is before now,
2593 to will be interpreted as tomorrow.
2595 Currently none of this works for ISO week specifications.
2597 When this option is nil, the current day, month and year will always be
2598 used as defaults.
2600 See also `org-agenda-jump-prefer-future'."
2608 "Should the agenda jump command prefer the future for incomplete dates?
2609 The default is to do the same as configured in `org-read-date-prefer-future'.
2610 But you can alse set a deviating value here.
2611 This may t or nil, or the symbol `org-read-date-prefer-future'."
2616 org-read-date-prefer-future)
2621 "Non-nil means display current interpretation of date prompt live.
2622 This display will be in an overlay, in the minibuffer."
2627 "Non-nil means pop up a calendar when prompting for a date.
2628 In the calendar, the date can be selected with mouse-1. However, the
2629 minibuffer will also be active, and you can simply enter the date as well.
2630 When nil, only the minibuffer will be available."
2638 "Hook to be used to set up keys for the date/time interface.
2639 Add key definitions to `minibuffer-local-map', which will be a temporary
2640 copy."
2645 "The hour when your day really ends. Must be an integer.
2646 This has influence for the following applications:
2648 the time given here, the day recognized as TODAY is actually yesterday.
2649 - When a date is read from the user and it is still before the time given
2650 here, the current date and time will be assumed to be yesterday, 23:59.
2651 Also, timestamps inserted in remember templates follow this rule.
2653 IMPORTANT: This is a feature whose implementation is and likely will
2654 remain incomplete. Really, it is only here because past midnight seems to
2655 be the favorite working time of John Wiegley :-)"
2660 "Non-nil means S-down will increase the time in a time stamp.
2661 When nil, S-up will increase."
2666 "Non-nil means make the calendar window follow timestamp changes.
2667 When a timestamp is modified and the calendar window is visible, it will be
2668 moved to the new date."
2673 "Options concerning tags in Org-mode."
2678 "List of tags allowed in Org-mode files.
2679 When this list is nil, Org-mode will base TAG input on what is already in the
2680 buffer.
2681 The value of this variable is an alist, the car of each entry must be a
2682 keyword as a string, the cdr may be a character that is used to select
2683 that tag through the fast-tag-selection interface.
2684 See the manual for details."
2699 "List of tags that will always appear in all Org-mode files.
2700 This is in addition to any in buffer settings or customizations
2701 of `org-tag-alist'.
2702 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2703 The value of this variable is an alist, the car of each entry must be a
2704 keyword as a string, the cdr may be a character that is used to select
2705 that tag through the fast-tag-selection interface.
2706 See the manual for details.
2707 To disable these tags on a per-file basis, insert anywhere in the file:
2708 #+STARTUP: noptag"
2719 "If non-nil, always offer completion for all tags of all agenda files.
2720 Instead of customizing this variable directly, you might want to
2721 set it locally for remember buffers, because there no list of
2722 tags in that file can be created dynamically (there are none).
2724 (add-hook 'org-remember-mode-hook
2725 (lambda ()
2726 (set (make-local-variable
2727 'org-complete-tags-always-offer-all-agenda-tags)
2728 t)))"
2733 "List of tags that can be inherited by all entries in the file.
2734 The tags will be inherited if the variable `org-use-tag-inheritance'
2735 says they should be.
2739 "Non-nil means use fast tag selection scheme.
2740 This is a special interface to select and deselect tags with single keys.
2741 When nil, fast selection is never used.
2742 When the symbol `auto', fast selection is used if and only if selection
2743 characters for tags have been configured, either through the variable
2744 `org-tag-alist' or through a #+TAGS line in the buffer.
2745 When t, fast selection is always used and selection keys are assigned
2746 automatically if necessary."
2754 "Non-nil means fast tag selection exits after first change.
2755 When nil, you have to press RET to exit it.
2756 During fast tag selection, you can toggle this flag with `C-c'.
2757 This variable can also have the value `expert'. In this case, the window
2758 displaying the tags menu is not even shown, until you press C-c again."
2766 "Non-nil means fast tags selection interface will also offer TODO states.
2770 "The column to which tags should be indented in a headline.
2771 If this number is positive, it specifies the column. If it is negative,
2772 it means that the tags should be flushright to that column. For example,
2773 -80 works well for a normal 80 character screen."
2778 "Non-nil means realign tags after pro/demotion of TODO state change.
2779 These operations change the length of a headline and therefore shift
2780 the tags around. With this options turned on, after each such operation
2781 the tags are again aligned to `org-tags-column'."
2786 "Non-nil means tags in levels apply also for sublevels.
2787 When nil, only the tags directly given in a specific line apply there.
2788 This may also be a list of tags that should be inherited, or a regexp that
2789 matches tags that should be inherited. Additional control is possible
2790 with the variable `org-tags-exclude-from-inheritance' which gives an
2791 explicit list of tags to be excluded from inheritance., even if the value of
2792 `org-use-tag-inheritance' would select it for inheritance.
2794 If this option is t, a match early-on in a tree can lead to a large
2795 number of matches in the subtree when constructing the agenda or creating
2796 a sparse tree. If you only want to see the first match in a tree during
2797 a search, check out the variable `org-tags-match-list-sublevels'."
2806 "List of tags that should never be inherited.
2807 This is a way to exclude a few tags from inheritance. For way to do
2808 the opposite, to actively allow inheritance for selected tags,
2809 see the variable `org-use-tag-inheritance'."
2814 "Check if TAG is one that should be inherited."
2826 "Non-nil means list also sublevels of headlines matching a search.
2827 This variable applies to tags/property searches, and also to stuck
2828 projects because this search is based on a tags match as well.
2830 When set to the symbol `indented', sublevels are indented with
2831 leading dots.
2833 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2834 the sublevels of a headline matching a tag search often also match
2835 the same search. Listing all of them can create very long lists.
2836 Setting this variable to nil causes subtrees of a match to be skipped.
2838 This variable is semi-obsolete and probably should always be true. It
2839 is better to limit inheritance to certain tags using the variables
2840 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2848 "When set, tags are sorted using this function as a comparator."
2864 "Options concerning properties in Org-mode."
2869 "How property key/value pairs should be formatted by `indent-line'.
2870 When `indent-line' hits a property definition, it will format the line
2871 according to this format, mainly to make sure that the values are
2872 lined-up with respect to each other."
2877 "Non-nil means properties apply also for sublevels.
2879 This setting is chiefly used during property searches. Turning it on can
2880 cause significant overhead when doing a search, which is why it is not
2881 on by default.
2883 When nil, only the properties directly given in the current entry count.
2884 When t, every property is inherited. The value may also be a list of
2885 properties that should have inheritance, or a regular expression matching
2886 properties that should be inherited.
2888 However, note that some special properties use inheritance under special
2889 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2891 for valid values of a property.
2893 Note for programmers:
2894 When querying an entry with `org-entry-get', you can control if inheritance
2895 should be used. By default, `org-entry-get' looks only at the local
2896 properties. You can request inheritance by setting the inherit argument
2897 to t (to force inheritance) or to `selective' (to respect the setting
2898 in this variable)."
2907 "Check if PROPERTY is one that should be inherited."
2918 "The default column format, if no other format has been defined.
2919 This variable can be set on the per-file basis by inserting a line
2921 #+COLUMNS: %25ITEM ....."
2926 "The ellipses to be used when a field in column view is truncated.
2927 When this is the empty string, as many characters as possible are shown,
2928 but then there will be no visual indication that the field has been truncated.
2929 When this is a string of length N, the last N characters of a truncated
2930 field are replaced by this string. If the column is narrower than the
2931 ellipses string, only part of the ellipses string will be shown."
2936 "Function that modifies values for display in column view.
2937 For example, it can be used to cut out a certain part from a time stamp.
2938 The function must take 2 arguments:
2940 column-title The title of the column (*not* the property name)
2941 value The value that should be modified.
2943 The function should return the value that should be displayed,
2944 or nil if the normal value should be used."
2949 "The property that is being used to keep track of effort estimates.
2950 Effort estimates given in this property need to have the format H:MM."
2958 "List of property/value pairs that can be inherited by any entry.
2960 These are fixed values, for the preset properties. The user variable
2961 that can be used to add to this list is `org-global-properties'.
2963 The entries in this list are cons cells where the car is a property
2964 name and cdr is a string with the value. If the value represents
2969 "List of property/value pairs that can be inherited by any entry.
2971 This list will be combined with the constant `org-global-properties-fixed'.
2973 The entries in this list are cons cells where the car is a property
2974 name and cdr is a string with the value.
2976 You can set buffer-local values for the same purpose in the variable
2977 `org-file-properties' this by adding lines like
2979 #+PROPERTY: NAME VALUE"
2986 "List of property/value pairs that can be inherited by any entry.
2987 Valid for the current buffer.
2992 "Options concerning agenda views in Org-mode."
2997 "Variable used by org files to set a category for agenda display.
2998 Such files should use a file variable to set it, for example
3002 or contain a special line
3004 #+CATEGORY: ELisp
3006 If the file does not specify a category, then file's base name
3012 "The files to be used for agenda display.
3016 If an entry is a directory, all files in that directory that are matched by
3017 `org-agenda-file-regexp' will be part of the file list.
3019 If the value of the variable is not a list but a single file name, then
3020 the list of agenda files is actually stored and maintained in that file, one
3021 agenda file per line. In this file paths can be given relative to
3022 `org-directory'. Tilde expansion and environment variable substitution
3023 are also made."
3030 "Regular expression to match files for `org-agenda-files'.
3031 If any element in the list in that variable contains a directory instead
3032 of a normal file, all files in that directory that are matched by this
3033 regular expression will be included."
3038 "List of extra files to be searched by text search commands.
3039 These files will be search in addition to the agenda files by the
3040 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3041 Note that these files will only be searched for text search commands,
3042 not for the other agenda views like todo lists, tag searches or the weekly
3043 agenda. This variable is intended to list notes and possibly archive files
3044 that should also be searched by these two commands.
3045 In fact, if the first element in the list is the symbol `agenda-archives',
3046 than all archive files of all agenda files will be added to the search
3047 scope."
3058 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3059 A nil value means to remove them, after a query, from the list."
3064 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3065 The command `org-calendar-goto-agenda' will be bound to this key. The
3066 default is the character `c' because then `c' can be used to switch back and
3067 forth between agenda and calendar."
3072 "The key to be installed in `calendar-mode-map' for agenda-action.
3073 The command `org-agenda-action' will be bound to this key. The
3074 default is the character `k' because we use the same key in the agenda."
3079 "The key to be installed in `calendar-mode-map' for adding diary entries.
3080 This option is irrelevant until `org-agenda-diary-file' has been configured
3081 to point to an Org-mode file. When that is the case, the command
3082 `org-agenda-diary-entry' will be bound to the key given here, by default
3083 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3084 if you want to continue doing this, you need to change this to a different
3085 key."
3090 "File to which to add new entries with the `i' key in agenda and calendar.
3091 When this is the symbol `diary-file', the functionality in the Emacs
3092 calendar will be used to add entries to the `diary-file'. But when this
3093 points to a file, `org-agenda-diary-entry' will be used instead."
3109 org-calendar-insert-diary-entry-key
3113 "Options for embedding LaTeX code into Org-mode."
3121 "Options for creating images from LaTeX fragments.
3122 This is a property list with the following properties:
3124 `default' means use the foreground of the default face.
3126 `default' means use the background of the default face.
3127 :scale a scaling factor for the size of the images, to get more pixels
3128 :html-foreground, :html-background, :html-scale
3129 the same numbers for HTML export.
3130 :matchers a list indicating which matchers should be used to
3131 find LaTeX fragments. Valid members of this list are:
3142 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3143 When nil, just push out a message."
3152 \[PACKAGES]
3153 \[DEFAULT-PACKAGES]
3154 % The settings below are copied from fullpage.sty
3167 "The document header used for processing LaTeX fragments.
3168 It is imperative that this header make sure that no page number
3169 appears on the page. The package defined in the variables
3170 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3172 will be appended."
3179 "Set the packages alist and make sure it has 3 elements per entry."
3183 x))
3184 val)))
3188 "Get the packages alist and make sure it has 3 elements per entry."
3192 x))
3195 ;; The following variables are defined here because is it also used
3196 ;; when formatting latex fragments. Originally it was part of the
3197 ;; LaTeX exporter, which is why the name includes "export".
3214 )
3215 "Alist of default packages to be inserted in the header.
3216 Change this only if one of the packages here causes an incompatibility
3217 with another package you are using.
3218 The packages in this list are needed by one part or another of Org-mode
3219 to function properly.
3221 - inputenc, fontenc: for basic font and character selection
3222 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3223 for interpreting the entities in `org-entities'. You can skip some of these
3224 packages if you don't use any of the symbols in it.
3225 - graphicx: for including images
3226 - float, wrapfig: for figure placement
3227 - longtable: for long tables
3228 - hyperref: for cross references
3230 Therefore you should not modify this variable unless you know what you
3231 are doing. The one reason to change it anyway is that you might be loading
3232 some other package that conflicts with one of the default packages.
3234 If SNIPPET-FLAG is t, the package also needs to be included when
3235 compiling LaTeX snippets into images for inclusion into HTML."
3248 "Alist of packages to be inserted in every LaTeX header.
3249 These will be inserted after `org-export-latex-default-packages-alist'.
3251 SNIPPET-FLAG, when t, indicates that this package is also needed when
3252 turning LaTeX snippets into images for inclusion into HTML.
3253 Make sure that you only list packages here which:
3254 - you want in every file
3255 - do not conflict with the default packages in
3256 `org-export-latex-default-packages-alist'
3257 - do not conflict with the setup in `org-format-latex-header'."
3271 "Settings for Org-mode appearance."
3276 "Non-nil means fontify only the stars in each headline.
3277 When nil, the entire headline is fontified.
3278 Changing it requires restart of `font-lock-mode' to become effective
3279 also in regions already fontified."
3284 "Non-nil means hide the first N-1 stars in a headline.
3285 This works by using the face `org-hide' for these stars. This
3286 face is white for a light background, and black for a dark
3287 background. You may have to customize the face `org-hide' to
3288 make this work.
3289 Changing it requires restart of `font-lock-mode' to become effective
3290 also in regions already fontified.
3291 You may also set this on a per-file basis by adding one of the following
3292 lines to the buffer:
3294 #+STARTUP: hidestars
3295 #+STARTUP: showstars"
3300 "List of keywords that should be hidden when typed in the org buffer.
3301 For example, add #+TITLE to this list in order to make the
3302 document title appear in the buffer without the initial #+TITLE:
3303 keyword."
3311 "Non-nil means change the face of a headline if it is marked DONE.
3312 Normally, only the TODO/DONE keyword indicates the state of a headline.
3313 When this is non-nil, the headline after the keyword is set to the
3314 `org-headline-done' as an additional indication."
3319 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3320 Changing this variable requires a restart of Emacs to take effect."
3325 "Non-nil means fontify the whole line for headings.
3326 This is useful when setting a background color for the
3327 org-level-* faces."
3332 "Non-nil means fontify what is treated specially by the exporters."
3337 "Non-nil mean font-lock should hide the emphasis marker characters."
3342 "Non-nil means show entities as UTF8 characters.
3348 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3353 "Regular expression for matching emphasis.
3354 After a match, the match groups contain these elements:
3355 0 The match of the full regular expression, including the characters
3356 before and after the proper match
3357 1 The character before the proper match, or empty at beginning of line
3358 2 The proper match, including the leading and trailing markers
3359 3 The leading marker like * or /, indicating the type of highlighting
3360 4 The text between the emphasis markers, not including the markers
3367 "Set variable and compute the emphasis regular expression."
3371 org-emphasis-alist org-emphasis-regexp-components)
3383 ;; make sure special characters appear at the right position in the class
3395 ;; Make the regexp
3403 body1
3415 body1
3423 "Components used to build the regular expression for emphasis.
3424 This is a list with 6 entries. Terminology: In an emphasis string
3428 specify what is allowed/forbidden in each part:
3430 pre Chars allowed as prematch. Beginning of line will be allowed too.
3431 post Chars allowed as postmatch. End of line will be allowed too.
3432 border The chars *forbidden* as border characters.
3434 non-shy groups here, and don't allow newline here.
3435 newline The maximum number of newlines allowed in an emphasis exp.
3437 Use customize to modify this, or restart Emacs after changing it."
3456 )
3457 "Special syntax for emphasized text.
3458 Text starting and ending with a special character will be emphasized, for
3459 example *bold*, _underlined_ and /italic/. This variable sets the marker
3460 characters, the face to be used by font-lock for highlighting in Org-mode
3461 Emacs buffers, and the HTML tags to be used for this.
3462 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3463 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3464 Use customize to modify this, or restart Emacs after changing it."
3479 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3482 ;;; Miscellaneous options
3485 "Completion in Org-mode."
3490 "Non-nil means use ido completion wherever possible.
3491 Note that `ido-mode' must be active for this variable to be relevant.
3492 If you decide to turn this variable on, you might well want to turn off
3493 `org-outline-path-complete-in-steps'.
3494 See also `org-completion-use-iswitchb'."
3499 "Non-nil means use iswitchb completion wherever possible.
3500 Note that `iswitchb-mode' must be active for this variable to be relevant.
3501 If you decide to turn this variable on, you might well want to turn off
3502 `org-outline-path-complete-in-steps'.
3503 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3509 Normal means no org-mode-specific context."
3513 ;;; Functions and variables from their packages
3514 ;; Declared here to avoid compiler warnings
3516 ;; XEmacs only
3522 ;; Emacs only
3525 ;; Various packages
3543 org-format-agenda-item "org-agenda"
3571 ;;; Autoload and prepare some org modules
3573 ;; Some table stuff that needs to be defined here, because it is used
3574 ;; by the functions setting up org-mode or checking for table context.
3587 "Detect the first line outside a table when searching from within it.
3590 ;; Autoload the functions in org-table.el that are needed by functions here.
3595 org-table-convert org-table-convert-region org-table-copy-down
3596 org-table-copy-region org-table-create
3597 org-table-create-or-convert-from-region
3598 org-table-create-with-table.el org-table-current-dline
3599 org-table-cut-region org-table-delete-column org-table-edit-field
3600 org-table-edit-formulas org-table-end org-table-eval-formula
3601 org-table-export org-table-field-info
3602 org-table-get-stored-formulas org-table-goto-column
3603 org-table-hline-and-move org-table-import org-table-insert-column
3604 org-table-insert-hline org-table-insert-row org-table-iterate
3605 org-table-justify-field-maybe org-table-kill-row
3606 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3607 org-table-move-column org-table-move-column-left
3608 org-table-move-column-right org-table-move-row
3609 org-table-move-row-down org-table-move-row-up
3610 org-table-next-field org-table-next-row org-table-paste-rectangle
3611 org-table-previous-field org-table-recalculate
3612 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3613 org-table-toggle-coordinate-overlays
3614 org-table-toggle-formula-debugger org-table-wrap-region
3615 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3616 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3617 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3620 "Return t if the cursor is inside an org-type table.
3621 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3626 org-table-line-regexp)))
3627 nil))
3631 "Return t if and only if we are at a table.el table."
3637 "If there is a table.el table nearby, recognize it and move into it."
3643 nil
3653 t
3658 t)
3659 nil)
3660 nil))
3663 "Return t if the cursor is inside a hline in a table."
3668 nil))
3673 "Apply FUNCTION to the start of all tables in the buffer."
3689 ;; Declare and autoload functions from org-exp.el & Co
3697 org-insert-export-options-template
3698 org-table-clean-before-export))
3701 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3702 org-export-region-as-ascii))
3705 org-replace-region-by-latex org-export-region-as-latex
3706 org-export-as-latex org-export-as-pdf
3707 org-export-as-pdf-and-open))
3710 org-export-as-html-batch org-export-as-html-to-buffer
3711 org-replace-region-by-html org-export-region-as-html
3712 org-export-as-html))
3715 org-replace-region-by-docbook org-export-region-as-docbook
3716 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3717 org-export-as-docbook))
3720 org-export-icalendar-all-agenda-files
3721 org-export-icalendar-combine-agenda-files))
3725 ;; Declare and autoload functions from org-agenda.el
3730 org-todo-list org-tags-view org-agenda-list-stuck-projects
3731 org-diary org-agenda-to-appt
3732 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3734 ;; Autoload org-remember
3739 org-remember-apply-template org-remember org-remember-handler)))
3744 org-capture-import-remember-templates)))
3746 ;; Autoload org-clock.el
3761 "Return non-nil if clock is currently running.
3762 The return value is actually the clock marker."
3767 "org-clock"
3769 org-clock-goto org-clock-sum org-clock-display
3770 org-clock-remove-overlays org-clock-report
3771 org-clocktable-shift org-dblock-write:clocktable
3772 org-get-clocktable org-resolve-clocks)))
3775 "If this is a CLOCK line, update it and return t.
3776 Otherwise, return nil."
3785 ts te h m s neg)
3788 nil)
3793 ;; The clock is running here
3814 t))))))
3817 "Check if the current buffer contains the running clock.
3818 If yes, offer to stop it and to save the buffer with the changes."
3827 "Check if this line starts a clock table, if yes, shift the time block."
3831 ;; Autoload org-timer.el
3835 "org-timer"
3837 org-timer-change-times-in-region
3838 org-timer-set-timer
3839 org-timer-reset-timers
3840 org-timer-show-remaining-time)))
3842 ;; Autoload org-feed.el
3846 "org-feed"
3850 ;; Autoload org-indent.el
3852 ;; Define the variable already here, to make sure we have it.
3854 "Non-nil if Org-Indent mode is enabled.
3859 "org-indent"
3862 ;; Autoload org-mobile.el
3866 "org-mobile"
3869 ;; Autoload archiving code
3870 ;; The stuff that is needed for cycling and tags has to be defined here.
3873 "Options concerning archiving in Org-mode."
3878 "The location where subtrees should be archived.
3880 The value of this variable is a string, consisting of two parts,
3881 separated by a double-colon. The first part is a filename and
3882 the second part is a headline.
3884 When the filename is omitted, archiving happens in the same file.
3885 %s in the filename will be replaced by the current file
3886 name (without the directory part). Archiving to a different file
3887 is useful to keep archived entries from contributing to the
3888 Org-mode Agenda.
3890 The archived entries will be filed as subtrees of the specified
3891 headline. When the headline is omitted, the subtrees are simply
3892 filed away at the end of the file, as top-level entries. Also in
3893 the heading you can use %s to represent the file name, this can be
3894 useful when using the same archive for a number of different files.
3896 Here are a few examples:
3898 If the current file is Projects.org, archive in file
3899 Projects.org_archive, as top-level trees. This is the default.
3902 Archive in the current file, under the top-level headline
3906 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3909 Archive in file ~/org/archive.org (absolute path), under headlines
3913 Archive in file ./basement (relative path), as level 3 trees
3916 You may set this option on a per-file basis by adding to the buffer a
3917 line like
3919 #+ARCHIVE: basement::** Finished Tasks
3921 You may also define it locally for a subtree by setting an ARCHIVE property
3922 in the entry. If such a property is found in an entry, or anywhere up
3923 the hierarchy, it will be used."
3928 "The tag that marks a subtree as archived.
3929 An archived subtree does not open during visibility cycling, and does
3930 not contribute to the agenda listings.
3931 After changing this, font-lock must be restarted in the relevant buffers to
3932 get the proper fontification."
3938 "Non-nil means the agenda will skip any items located in archived trees.
3939 An archived tree is a tree marked with the tag ARCHIVE. The use of this
3940 variable is no longer recommended, you should leave it at the value t.
3941 Instead, use the key `v' to cycle the archives-mode in the agenda."
3947 "Non-nil means ignore archived trees when creating column view."
3953 "Non-nil means `org-cycle' will open archived trees.
3954 An archived tree is a tree marked with the tag ARCHIVE.
3955 When nil, archived trees will stay folded. You can still open them with
3956 normal outline commands like `show-all', but not with the cycling commands."
3962 "Non-nil means sparse tree construction shows matches in archived trees.
3963 When nil, matches in these trees are highlighted, but the trees are kept in
3964 collapsed state."
3970 "Re-hide all archived subtrees after a visibility state change."
3981 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
3984 "Cycle subtree even if it is archived."
3991 "Re-hide all archived subtrees after a visibility state change."
4006 flag)))
4013 org-archive-to-archive-sibling org-toggle-archive-tag
4014 org-archive-subtree-default
4015 org-archive-subtree-default-with-confirmation)))
4017 ;; Autoload Column View Code
4025 org-columns-compute org-agenda-columns org-columns-remove-overlays
4028 ;; Autoload ID code
4036 org-id-get-with-outline-path-completion
4037 org-id-get-with-outline-drilling org-id-store-link
4038 org-id-goto org-id-find org-id-store-link))
4040 ;; Autoload Plotting Code
4045 ;;; Variables for pre-computed regular expressions, all buffer local
4063 "Matches a headline and puts everything into groups:
4064 group 1: the stars
4065 group 2: The todo keyword, maybe
4066 group 3: Priority cookie
4067 group 4: True headline
4071 "Printf format to make regexp to match an exact headline.
4072 This regexp will match the headline of any node which hase the exact
4073 headline text that is put into the format, but may have any TODO state,
4077 "Matches a headline and puts TODO state into group 2 if present.
4132 "Regular expression to match a plain time or time range.
4133 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4134 groups carry important information:
4135 0 the full match
4136 1 the first time, range or not
4144 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4145 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4146 groups carry important information:
4147 0 the full match
4148 7 hours of duration
4157 "Regular expression to match a timestamp time or time range.
4158 After a match, the following groups carry important information:
4159 0 the full match
4160 1 date plus weekday, for back referencing to make sure both times are on the same day
4161 2 the first time, range or not
4216 "Variable associated with STARTUP options for org-mode.
4217 Each element is a list of three items: The startup options as written
4218 in the #+STARTUP line, the corresponding variable, and the value to
4219 set this variable to if the option is found. An optional forth element PUSH
4223 "Precompute regular expressions for current buffer."
4243 kwds kws0 kwsa key log value cat arch tags const links hw dws
4244 tail sep kws1 prio props ftags drawers beamer-p
4266 ;; general TODO-like setup
4278 links)))
4284 props)))
4289 ftags
4299 l var val)
4329 ))))
4346 ;; Process the TODO keywords
4348 ;; Use the global values as if they had been given locally.
4360 kws)))
4363 kwsa nil
4366 ;; 1 2
4374 kw)
4376 kws0)
4393 ;; Process the constants
4401 ;; Process the tags.
4412 tgs))
4420 ;; Compute the regular expressions and other local variables
4428 org-drawer-regexp
4432 org-not-done-keywords
4434 org-todo-regexp
4437 org-not-done-regexp
4441 org-not-done-heading-regexp
4445 org-todo-line-regexp
4449 org-complex-heading-regexp
4454 org-complex-heading-regexp-format
4463 org-nl-done-regexp
4467 org-todo-line-tags-regexp
4472 org-looking-at-done-regexp
4477 org-deadline-time-regexp
4479 org-deadline-line-regexp
4481 org-scheduled-regexp
4483 org-scheduled-time-regexp
4485 org-closed-time-regexp
4487 org-keyword-time-regexp
4493 org-keyword-time-not-clock-regexp
4499 org-maybe-keyword-time-regexp
4505 org-planning-or-clock-line-re
4510 org-all-time-keywords
4513 org-clock-string org-closed-string))
4514 )
4519 "Return the contents of FILE, as a string."
4533 "Extract the log state setting from a TODO keyword string.
4547 "Remove a pair of parenthesis at the end of each string in LIST."
4551 x))
4552 list))
4555 "Assign fast keys to a keyword-key alist.
4556 Respect keys that are already there."
4574 ;;; Some variables used in various places
4581 "Function to be called when `C-c C-c' is used.
4585 ;; FIXME: Occasionally check by commenting these, to make sure
4586 ;; no other functions uses these, forgetting to let-bind them.
4591 ;; Defined somewhere in this file, but used before definition.
4597 ;;;; Define the Org-mode
4600 (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"))
4603 ;; We use a before-change function to check if a table might need
4604 ;; an update.
4606 "Indicates that a table might need an update.
4607 This variable is set by `org-before-change-function'.
4610 "Every change indicates that a table might need an update."
4621 ;;;###autoload
4623 "Outline-based notes management and organizer, alias
4626 Org-mode develops organizational tasks around a NOTES file which
4627 contains information about projects as plain text. Org-mode is
4628 implemented on top of outline-mode, which is ideal to keep the content
4629 of large files well structured. It supports ToDo items, deadlines and
4630 time stamps, which magically appear in the diary listing of the Emacs
4631 calendar. Tables are easily created with a built-in table editor.
4632 Plain text URL-like links connect to websites, emails (VM), Usenet
4633 messages (Gnus), BBDB entries, and any files related to the project.
4634 For printing and sharing of notes, an Org-mode file (or a part of it)
4635 can be exported as a structured ASCII or HTML file.
4637 The following commands are available:
4641 ;; Get rid of Outline menus, they are not needed
4642 ;; Need to do this here because define-derived-mode sets up
4643 ;; the keymap so late. Still, it is a waste to call this each time
4644 ;; we switch another buffer into org-mode.
4647 ;; Assume this is Greg's port, it uses easymenu
4672 org-display-table 4
4675 org-ellipsis)))
4680 ;; tag faces set outside customize.... force initialization.
4682 ;; Calc embedded
4688 ;; Activate before-change-function
4692 ;; Check for running clock before killing a buffer
4694 ;; Paragraphs and auto-filling
4698 ;; Beginning/end of defun
4701 ;; Make sure dependence stuff works reliably, even for users who set it
4702 ;; too late :-(
4714 ;; Comment characters
4718 ;; Align options lines
4720 'align-mode-rules-list
4725 ;; Imenu
4729 ;; Make isearch reveal context
4732 ;; Emacs 21 and XEmacs make use of the hook
4734 ;; Emacs 22 deals with this through a special variable
4738 ;; Turn on org-beamer-mode?
4741 ;; If empty file that did not turn on org-mode automatically, make it to.
4766 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4775 ;;;; Font-Lock stuff, including the activators
4806 "Regular expression used to analyze links.
4807 Here is what the match groups contain after a match:
4808 1: http:
4809 2: http
4810 3: path
4811 4: [desc]
4819 "Number of stacked braces for sub/superscript matching.
4820 This has to be set before loading org.el to be effective."
4825 "Create a regular expression which will match a balanced sexp.
4826 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4827 as single character strings.
4828 The regexp returned will match the entire expression including the
4829 delimiters. It will also define a single group which contains the
4830 match except for the outermost delimiters. The maximum depth of
4831 stacked delimiters is N. Escaping delimiters is not possible."
4860 "Update the link regular expressions.
4861 This should be called after the variable `org-link-types' has changed."
4865 org-link-re-with-space
4871 org-link-re-with-space2
4877 org-link-re-with-space3
4882 org-angle-link-re
4888 org-plain-link-re
4892 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
4893 org-bracket-link-regexp
4895 org-bracket-link-analytic-regexp
4903 org-bracket-link-analytic-regexp++
4911 org-any-link-re
4922 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4923 "Regular expression matching time strings for analysis.
4924 This one does not require the space after the date, so it can be used
4926 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]-+0-9>\r\n ]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
4942 "Regular expression matching a time stamp or time stamp range.
4948 "Run through the buffer and add overlays to links."
4957 'face
4970 rtn))
4973 "Insert or change an emphasis, i.e. a font like bold or italic.
4974 If there is an active region, change that region to a new emphasis.
4975 If there is no region, just insert the marker characters and position
4976 the cursor between them.
4977 CHAR should be either the marker character, or the first character of the
4978 HTML tag associated with that emphasis. If CHAR is a space, the means
4979 to remove the emphasis of the selected region.
4980 If char is not given (for example in an interactive call) it
4981 will be prompted for."
5032 "Run through the buffer and add overlays to links."
5041 nil
5047 t)))))
5055 t)))
5058 "When non-nil, fontify code in code blocks."
5064 "Fontify #+ lines and blocks, in the correct ways."
5067 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5068 limit t)
5076 end end1 quoting block-type)
5079 ;; a single line of backend-specific content
5087 ; for backend-specific code
5088 t)
5090 ;; Truly a block
5102 beg end
5106 ; for end_src
5112 org-block)))
5113 ; end of source block
5119 t))
5132 ;; just any other in-buffer setting, but not indented
5136 t)
5144 t)
5152 "Run through the buffer and add overlays to links."
5160 t)))
5163 "Run through the buffer and add overlays to links."
5165 limit t)
5170 'keymap org-mouse-map
5171 'help-echo
5173 "Footnote definition"
5175 ))
5177 t)))
5180 "Run through the buffer and add overlays to bracketed links."
5184 ;; FIXME: above we should remove the escapes.
5185 ;; but that requires another match, protecting match data,
5186 ;; a lot of overhead for font-lock.
5193 ;; We need to remove the invisible property here. Table narrowing
5194 ;; may have made some of this invisible.
5212 t)))
5215 "Run through the buffer and add overlays to dates."
5227 t)))
5236 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5240 "Run through the buffer and add overlays to target matches."
5248 'keymap org-mouse-map
5252 t)))))
5255 "Find all radio targets in this file and update the regular expression."
5270 t)))
5277 ;; This should be with the exporter code, but we also use if for font-locking
5287 "Compute regular expression for stuff treated specially by exporters."
5294 org-latex-regexps)))
5322 org-entities)))
5326 org-latex-entities)
5327 nil))
5329 ))
5330 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5333 org-export-html-special-string-regexps)))
5338 ))))
5340 'org-latex-and-specials-regexp
5345 "Run through the buffer and add overlays to links."
5349 limit t))
5363 rtn)))
5366 "Restart `font-lock-mode', to force refontification."
5372 "Return a list of all targets in this file.
5373 With optional argument RADIO, only find radio targets."
5375 rtn)
5380 rtn)))
5383 "Make regular expression matching all strings in TARGETS.
5384 The regular expression finds the targets also if there is a line break
5385 between words."
5393 x)
5394 targets
5406 t)))
5409 "Compute the outline level of the heading at point.
5410 This function assumes that the cursor is at the beginning of a line matched
5411 by `outline-regexp'. Otherwise it returns garbage.
5412 If this is called at a normal headline, the level is the number of stars.
5413 Use `org-reduced-level' to remove the effect of `org-odd-levels'.
5414 For plain list items, if they are matched by `outline-regexp', this returns
5415 1000 plus the line indentation."
5424 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5431 "Functions that can manipulate `org-font-lock-extra-keywords'.
5432 This is calles after `org-font-lock-extra-keywords' is defined, but before
5433 it is installed to be used by font lock. This can be useful if something
5444 ;; Call the hook
5446 ;; Headlines
5453 ;; Table lines
5456 ;; Table internals
5461 ;; Drawers
5464 ;; Properties
5468 ;; Links
5479 ;; TODO lines
5482 ;; DONE
5488 nil)
5489 ;; Priorities
5491 ;; Tags
5493 ;; Special keywords
5498 ;; Emphasis
5503 ;; Checkboxes
5504 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5509 ;; Description list items
5512 ;; ARCHIVEd headings
5515 ;; Specials
5519 ;; Code
5521 ;; COMMENT
5526 ;; Blocks and meta lines
5528 )))
5531 ;; Now set the full font-lock-keywords
5538 "Toggle the composition display of entities as UTF8 characters."
5550 "Find an entity to fontify."
5556 limit t)
5568 nil))))
5571 "Fontify string S like in Org-mode."
5583 "Get the right face for match N in font-lock matching of headlines."
5593 "Get the right face for a TODO keyword KWD.
5594 If KWD is a number, get the corresponding match group."
5602 "Create a face list that inherits INHERIT, but sets the foreground color.
5603 When FACE-OR-COLOR is not a string, just return it."
5607 face-or-color)
5608 face-or-color))
5611 "Add the special tag faces."
5620 "Add the special priority faces."
5627 org-priority-faces)))
5632 "Get the right face for a TODO keyword KWD.
5633 If KWD is a number, get the corresponding match group."
5640 "Remove fontification and activation overlays from links."
5645 deactivate-mark buffer-file-name buffer-file-truename)
5648 beg end
5650 ;; also remove line-prefix and wrap-prefix properties
5652 invisible t intangible t
5653 line-prefix t wrap-prefix t
5654 org-no-flyspell t org-emphasis t)
5656 invisible t intangible t
5657 org-no-flyspell t org-emphasis t)))
5667 "Remove specific display properties that have been added by font lock.
5668 The will remove the raise properties that are used to show superscripts
5669 and subscripts."
5679 "Add raise properties to sub/superscripts."
5683 org-match-substring-regexp
5684 org-match-substring-with-braces-regexp)
5685 limit t)
5695 ;; FIXME: Should we go back one character here, for a_b^c
5696 ;; (goto-char (1- pos)) ;????????????????????
5698 t
5700 'display
5716 t)))))
5718 ;;;; Visibility cycling, including org-goto and indirect buffer
5720 ;;; Cycling
5727 ;;;###autoload
5732 "TAB-action and visibility cycling for Org-mode.
5734 This is the command invoked in Org-mode by the TAB key. Its main purpose
5735 is outline visibility cycling, but it also invokes other actions
5736 in special contexts.
5738 - When this function is called with a prefix argument, rotate the entire
5739 buffer through 3 states (global cycling)
5740 1. OVERVIEW: Show only top-level headlines.
5741 2. CONTENTS: Show all headlines of all levels, but no body text.
5742 3. SHOW ALL: Show everything.
5743 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5744 determined by the variable `org-startup-folded', and by any VISIBILITY
5745 properties in the buffer.
5746 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5747 including any drawers.
5749 - When inside a table, re-align the table and move to the next field.
5751 - When point is at the beginning of a headline, rotate the subtree started
5752 by this line through 3 different states (local cycling)
5753 1. FOLDED: Only the main headline is shown.
5754 2. CHILDREN: The main headline and the direct children are shown.
5755 From this state, you can move to one of the children
5756 and zoom in further.
5757 3. SUBTREE: Show the entire subtree, including body text.
5758 If there is no subtree, switch directly from CHILDREN to FOLDED.
5760 - When point is at the beginning of an empty headline and the variable
5761 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5762 of the headline by demoting and promoting it to likely levels. This
5763 speeds up creation document structure by pressing TAB once or several
5764 times right after creating a new headline.
5766 - When there is a numeric prefix, go up to a heading with level ARG, do
5767 a `show-subtree' and return to the previous cursor position. If ARG
5768 is negative, go up that many levels.
5770 - When point is not at the beginning of a headline, execute the global
5771 binding for TAB, which is re-indenting the line. See the option
5772 `org-cycle-emulate-tab' for details.
5774 - Special case: if point is at the beginning of the buffer and there is
5775 no headline in line 1, this function will act as if called with prefix arg.
5776 But only if also the variable `org-cycle-global-at-bob' is t."
5786 org-inlinetask-min-level
5791 limit-level)))
5807 org-cycle-hook))
5811 ;; special case: use global cycling
5825 ;; Enter the table or move to the next field in the table
5842 ;; Toggle block visibility
5847 ;; Show-subtree, ARG levels up from here.
5859 ;; TAB emulation and template completion
5883 t
5892 "Do the global cycling action."
5896 ;; We just created the overview - now do table of contents
5897 ;; This can be slow in very large buffers, so indicate action
5907 ;; We just showed the table of contents - now show everything
5915 ;; Default action: go to overview
5923 "Do the local cycling action."
5925 ;; First, some boundaries
5932 ; XEmacs does not have `next-single-char-property-change'
5933 ; I'm not sure about Emacs 21.
5947 ;; if we're in a list, org-end-of-subtree is in fact org-end-of-item.
5956 ;; Find out what to do next and set `this-command'
5959 ;; Nothing is hidden behind this heading
5971 org-cycle-skip-children-state-if-no-children))))
5972 ;; Entire subtree is hidden in one line: children view
5986 ;; We just showed the children, or no children are there,
5987 ;; now show everything.
5994 ;; Default action: hide the subtree.
6001 ;;;###autoload
6003 "Cycle the global visibility. For details see `org-cycle'.
6005 With a numeric prefix, show all headlines up to that level."
6021 "Set the visibility required by startup options and properties."
6036 "Switch subtree visibilities according to :VISIBILITY: property."
6043 nil t)
6068 "Switch to overview mode, showing only top-level headlines.
6069 Really, this shows all headlines with level equal or greater than the level
6070 of the first headline in the buffer. This is important, because if the
6071 first headline is not level one, then (hide-sublevels 1) gives confusing
6072 results."
6083 "Show all headlines in the buffer, like a table of contents.
6084 With numerical argument N, show content up to level N."
6087 ;; Visit all headings and show their offspring
6094 t)
6103 "Adjust the window after a change in outline visibility.
6104 This function is the default value of the hook `org-cycle-hook'."
6114 "Remove outline overlays that do not contain non-white stuff."
6124 "Fix visibility issues after moving a subtree."
6125 ;; First, find a reasonable region to look at:
6126 ;; Start two siblings above, end three below
6144 ;; Properly fold already folded siblings
6155 "Show empty lines above all visible headlines.
6156 The region to be covered depends on STATE when called through
6157 `org-cycle-hook'. Lisp program can use t for STATE to get the
6158 entire buffer covered. Note that an empty line is only shown if there
6159 are at least `org-cycle-separator-lines' empty lines before the headline."
6169 beg end b e)
6193 ;; Never hide empty lines at the end of the file.
6203 "Move to the parent and re-show empty lines before visible headlines."
6209 "Return `org-agenda-files' list, plus all open org-mode files.
6210 This is useful for operations that need to scan all of a user's
6211 open and agenda-wise Org files."
6219 files))
6222 "Return the beginning position of the current entry."
6226 "Return the end position of the current entry."
6230 "Re-hide all drawers after a visibility state change."
6257 "Is the end of the current subtree visible?"
6262 "Move cursor to the first headline and recenter the headline.
6263 Optional argument N means put the headline into the Nth line of the window."
6269 ;;; Saving and restoring visibility
6272 "Return a list of the locations of all outline overlays.
6273 These are overlays with the `invisible' property value `outline'.
6274 The return value is a list of cons cells, with start and stop
6275 positions for each overlay.
6276 If USE-MARKERS is set, return the positions as markers."
6294 "Create visibility overlays for all positions in DATA.
6295 DATA should have been made by `org-outline-overlay-data'."
6304 data)))))
6306 ;;; Folding of blocks
6318 "Call FUNCTION at the head of all source blocks in the current buffer.
6319 Optional arguments START and END can be used to limit the range."
6331 "Toggle the visibility of all blocks in the current buffer."
6335 "Fold all blocks in the current buffer."
6341 "Unfold all blocks in the current buffer."
6347 "Toggle visibility of block at point."
6358 "Toggle the visibility of the current block."
6365 ov)
6381 ;; make the block accessible to isearch
6383 ov 'isearch-open-invisible
6394 ;; org-tab-after-check-for-cycling-hook
6396 ;; Remove overlays when changing major mode
6401 ;;; Org-goto
6407 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6423 nil)
6424 (org-defkey map "q" 'org-goto-quit)
6425 (org-defkey map "n" 'outline-next-visible-heading)
6426 (org-defkey map "p" 'outline-previous-visible-heading)
6427 (org-defkey map "f" 'outline-forward-same-level)
6428 (org-defkey map "b" 'outline-backward-same-level)
6429 (org-defkey map "u" 'outline-up-heading))
6430 (org-defkey map "/" 'org-occur)
6431 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6432 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6433 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6434 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6435 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6436 map))
6438 (defconst org-goto-help
6439 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6440 RET=jump to location [Q]uit and return to previous location
6441 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6443 (defvar org-goto-start-pos) ; dynamically scoped parameter
6445 ;; FIXME: Docstring does not mention both interfaces
6446 (defun org-goto (&optional alternative-interface)
6447 "Look up a different location in the current file, keeping current visibility.
6449 When you want look-up or go to a different location in a document, the
6450 fastest way is often to fold the entire buffer and then dive into the tree.
6451 This method has the disadvantage, that the previous location will be folded,
6452 which may not be what you want.
6454 This command works around this by showing a copy of the current buffer
6455 in an indirect buffer, in overview mode. You can dive into the tree in
6456 that copy, use org-occur and incremental search to find a location.
6457 When pressing RET or `Q', the command returns to the original buffer in
6458 which the visibility is still unchanged. After RET is will also jump to
6459 the location selected in the indirect buffer and expose the
6460 the headline hierarchy above."
6461 (interactive "P")
6462 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6463 (org-refile-use-outline-path t)
6464 (org-refile-target-verify-function nil)
6465 (interface
6466 (if (not alternative-interface)
6467 org-goto-interface
6468 (if (eq org-goto-interface 'outline)
6469 'outline-path-completion
6470 'outline)))
6471 (org-goto-start-pos (point))
6472 (selected-point
6473 (if (eq interface 'outline)
6474 (car (org-get-location (current-buffer) org-goto-help))
6475 (let ((pa (org-refile-get-location "Goto: ")))
6476 (org-refile-check-position pa)
6477 (nth 3 pa)))))
6478 (if selected-point
6479 (progn
6480 (org-mark-ring-push org-goto-start-pos)
6481 (goto-char selected-point)
6482 (if (or (org-invisible-p) (org-invisible-p2))
6483 (org-show-context 'org-goto)))
6484 (message "Quit"))))
6486 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6487 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6488 (defvar org-goto-local-auto-isearch-map) ; defined below
6490 (defun org-get-location (buf help)
6491 "Let the user select a location in the Org-mode buffer BUF.
6492 This function uses a recursive edit. It returns the selected position
6493 or nil."
6494 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6495 (isearch-hide-immediately nil)
6496 (isearch-search-fun-function
6497 (lambda () 'org-goto-local-search-headings))
6498 (org-goto-selected-point org-goto-exit-command)
6499 (pop-up-frames nil)
6500 (special-display-buffer-names nil)
6501 (special-display-regexps nil)
6502 (special-display-function nil))
6503 (save-excursion
6504 (save-window-excursion
6505 (delete-other-windows)
6506 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6507 (switch-to-buffer
6508 (condition-case nil
6509 (make-indirect-buffer (current-buffer) "*org-goto*")
6510 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6511 (with-output-to-temp-buffer "*Help*"
6512 (princ help))
6513 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6514 (setq buffer-read-only nil)
6515 (let ((org-startup-truncated t)
6516 (org-startup-folded nil)
6517 (org-startup-align-all-tables nil))
6518 (org-mode)
6519 (org-overview))
6520 (setq buffer-read-only t)
6521 (if (and (boundp 'org-goto-start-pos)
6522 (integer-or-marker-p org-goto-start-pos))
6523 (let ((org-show-hierarchy-above t)
6524 (org-show-siblings t)
6525 (org-show-following-heading t))
6526 (goto-char org-goto-start-pos)
6527 (and (org-invisible-p) (org-show-context)))
6528 (goto-char (point-min)))
6529 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6530 (message "Select location and press RET")
6531 (use-local-map org-goto-map)
6532 (recursive-edit)
6533 ))
6534 (kill-buffer "*org-goto*")
6535 (cons org-goto-selected-point org-goto-exit-command)))
6537 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6538 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6539 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6540 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6542 (defun org-goto-local-search-headings (string bound noerror)
6543 "Search and make sure that any matches are in headlines."
6544 (catch 'return
6545 (while (if isearch-forward
6546 (search-forward string bound noerror)
6547 (search-backward string bound noerror))
6548 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6549 (and (member :headline context)
6550 (not (member :tags context))))
6551 (throw 'return (point))))))
6553 (defun org-goto-local-auto-isearch ()
6554 "Start isearch."
6555 (interactive)
6556 (goto-char (point-min))
6557 (let ((keys (this-command-keys)))
6558 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6559 (isearch-mode t)
6560 (isearch-process-search-char (string-to-char keys)))))
6562 (defun org-goto-ret (&optional arg)
6563 "Finish `org-goto' by going to the new location."
6564 (interactive "P")
6565 (setq org-goto-selected-point (point)
6566 org-goto-exit-command 'return)
6567 (throw 'exit nil))
6569 (defun org-goto-left ()
6570 "Finish `org-goto' by going to the new location."
6571 (interactive)
6572 (if (org-on-heading-p)
6573 (progn
6574 (beginning-of-line 1)
6575 (setq org-goto-selected-point (point)
6576 org-goto-exit-command 'left)
6577 (throw 'exit nil))
6578 (error "Not on a heading")))
6580 (defun org-goto-right ()
6581 "Finish `org-goto' by going to the new location."
6582 (interactive)
6583 (if (org-on-heading-p)
6584 (progn
6585 (setq org-goto-selected-point (point)
6586 org-goto-exit-command 'right)
6587 (throw 'exit nil))
6588 (error "Not on a heading")))
6590 (defun org-goto-quit ()
6591 "Finish `org-goto' without cursor motion."
6592 (interactive)
6593 (setq org-goto-selected-point nil)
6594 (setq org-goto-exit-command 'quit)
6595 (throw 'exit nil))
6597 ;;; Indirect buffer display of subtrees
6599 (defvar org-indirect-dedicated-frame nil
6600 "This is the frame being used for indirect tree display.")
6601 (defvar org-last-indirect-buffer nil)
6603 (defun org-tree-to-indirect-buffer (&optional arg)
6604 "Create indirect buffer and narrow it to current subtree.
6605 With numerical prefix ARG, go up to this level and then take that tree.
6606 If ARG is negative, go up that many levels.
6607 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6608 indirect buffer previously made with this command, to avoid proliferation of
6609 indirect buffers. However, when you call the command with a \
6611 when `org-indirect-buffer-display' is `new-frame', the last buffer
6612 is kept so that you can work with several indirect buffers at the same time.
6613 If `org-indirect-buffer-display' is `dedicated-frame', the \
6615 requests that a new frame be made for the new buffer, so that the dedicated
6616 frame is not changed."
6617 (interactive "P")
6618 (let ((cbuf (current-buffer))
6619 (cwin (selected-window))
6620 (pos (point))
6621 beg end level heading ibuf)
6622 (save-excursion
6623 (org-back-to-heading t)
6624 (when (numberp arg)
6625 (setq level (org-outline-level))
6626 (if (< arg 0) (setq arg (+ level arg)))
6627 (while (> (setq level (org-outline-level)) arg)
6628 (outline-up-heading 1 t)))
6629 (setq beg (point)
6630 heading (org-get-heading))
6631 (org-end-of-subtree t t)
6632 (if (org-on-heading-p) (backward-char 1))
6633 (setq end (point)))
6634 (if (and (buffer-live-p org-last-indirect-buffer)
6635 (not (eq org-indirect-buffer-display 'new-frame))
6636 (not arg))
6637 (kill-buffer org-last-indirect-buffer))
6638 (setq ibuf (org-get-indirect-buffer cbuf)
6639 org-last-indirect-buffer ibuf)
6640 (cond
6641 ((or (eq org-indirect-buffer-display 'new-frame)
6642 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6643 (select-frame (make-frame))
6644 (delete-other-windows)
6645 (switch-to-buffer ibuf)
6646 (org-set-frame-title heading))
6647 ((eq org-indirect-buffer-display 'dedicated-frame)
6648 (raise-frame
6649 (select-frame (or (and org-indirect-dedicated-frame
6650 (frame-live-p org-indirect-dedicated-frame)
6651 org-indirect-dedicated-frame)
6652 (setq org-indirect-dedicated-frame (make-frame)))))
6653 (delete-other-windows)
6654 (switch-to-buffer ibuf)
6655 (org-set-frame-title (concat "Indirect: " heading)))
6656 ((eq org-indirect-buffer-display 'current-window)
6657 (switch-to-buffer ibuf))
6658 ((eq org-indirect-buffer-display 'other-window)
6659 (pop-to-buffer ibuf))
6660 (t (error "Invalid value")))
6661 (if (featurep 'xemacs)
6662 (save-excursion (org-mode) (turn-on-font-lock)))
6663 (narrow-to-region beg end)
6664 (show-all)
6665 (goto-char pos)
6666 (and (window-live-p cwin) (select-window cwin))))
6668 (defun org-get-indirect-buffer (&optional buffer)
6669 (setq buffer (or buffer (current-buffer)))
6670 (let ((n 1) (base (buffer-name buffer)) bname)
6671 (while (buffer-live-p
6672 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6673 (setq n (1+ n)))
6674 (condition-case nil
6675 (make-indirect-buffer buffer bname 'clone)
6676 (error (make-indirect-buffer buffer bname)))))
6678 (defun org-set-frame-title (title)
6679 "Set the title of the current frame to the string TITLE."
6680 ;; FIXME: how to name a single frame in XEmacs???
6681 (unless (featurep 'xemacs)
6682 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6684 ;;;; Structure editing
6686 ;;; Inserting headlines
6688 (defun org-previous-line-empty-p ()
6689 (save-excursion
6690 (and (not (bobp))
6691 (or (beginning-of-line 0) t)
6692 (save-match-data
6695 (defun org-insert-heading (&optional force-heading invisible-ok)
6696 "Insert a new heading or item with same depth at point.
6697 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6698 If point is at the beginning of a headline, insert a sibling before the
6699 current headline. If point is not at the beginning, split the line,
6700 create the new headline with the text in the current line after point
6701 \(but see also the variable `org-M-RET-may-split-line').
6703 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6704 This is important for non-interactive uses of the command."
6705 (interactive "P")
6706 (if (or (= (buffer-size) 0)
6707 (and (not (save-excursion
6708 (and (ignore-errors (org-back-to-heading invisible-ok))
6709 (org-on-heading-p))))
6710 (not (org-in-item-p))))
6711 (progn
6713 (run-hooks 'org-insert-heading-hook))
6714 (when (or force-heading (not (org-insert-item)))
6715 (let* ((empty-line-p nil)
6716 (level nil)
6717 (on-heading (org-on-heading-p))
6718 (head (save-excursion
6719 (condition-case nil
6720 (progn
6721 (org-back-to-heading invisible-ok)
6722 (when (and (not on-heading)
6723 (featurep 'org-inlinetask)
6724 (integerp org-inlinetask-min-level)
6725 (>= (length (match-string 0))
6726 org-inlinetask-min-level))
6727 ;; Find a heading level before the inline task
6728 (while (and (setq level (org-up-heading-safe))
6729 (>= level org-inlinetask-min-level)))
6730 (if (org-on-heading-p)
6731 (org-back-to-heading invisible-ok)
6732 (error "This should not happen")))
6733 (setq empty-line-p (org-previous-line-empty-p))
6734 (match-string 0))
6735 (error "*"))))
6736 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6737 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6738 pos hide-previous previous-pos)
6739 (cond
6740 ((and (org-on-heading-p) (bolp)
6741 (or (bobp)
6742 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6743 ;; insert before the current line
6744 (open-line (if blank 2 1)))
6745 ((and (bolp)
6746 (not org-insert-heading-respect-content)
6747 (or (bobp)
6748 (save-excursion
6749 (backward-char 1) (not (org-invisible-p)))))
6750 ;; insert right here
6751 nil)
6752 (t
6753 ;; somewhere in the line
6754 (save-excursion
6755 (setq previous-pos (point-at-bol))
6756 (end-of-line)
6757 (setq hide-previous (org-invisible-p)))
6758 (and org-insert-heading-respect-content (org-show-subtree))
6759 (let ((split
6760 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6761 (save-excursion
6762 (let ((p (point)))
6763 (goto-char (point-at-bol))
6764 (and (looking-at org-complex-heading-regexp)
6765 (> p (match-beginning 4)))))))
6766 tags pos)
6767 (cond
6768 (org-insert-heading-respect-content
6769 (org-end-of-subtree nil t)
6770 (when (featurep 'org-inlinetask)
6771 (while (and (not (eobp))
6773 (>= (length (match-string 1))
6774 org-inlinetask-min-level))
6775 (org-end-of-subtree nil t)))
6776 (or (bolp) (newline))
6777 (or (org-previous-line-empty-p)
6778 (and blank (newline)))
6779 (open-line 1))
6780 ((org-on-heading-p)
6781 (when hide-previous
6782 (show-children)
6783 (org-show-entry))
6785 (setq tags (and (match-end 2) (match-string 2)))
6786 (and (match-end 1)
6787 (delete-region (match-beginning 1) (match-end 1)))
6788 (setq pos (point-at-bol))
6789 (or split (end-of-line 1))
6790 (delete-horizontal-space)
6792 (buffer-substring (point-at-bol) (point)))
6793 (insert " "))
6794 (newline (if blank 2 1))
6795 (when tags
6796 (save-excursion
6797 (goto-char pos)
6798 (end-of-line 1)
6799 (insert " " tags)
6800 (org-set-tags nil 'align))))
6801 (t
6802 (or split (end-of-line 1))
6803 (newline (if blank 2 1)))))))
6804 (insert head) (just-one-space)
6805 (setq pos (point))
6806 (end-of-line 1)
6807 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6808 (when (and org-insert-heading-respect-content hide-previous)
6809 (save-excursion
6810 (goto-char previous-pos)
6811 (hide-subtree)))
6812 (run-hooks 'org-insert-heading-hook)))))
6814 (defun org-get-heading (&optional no-tags)
6815 "Return the heading of the current entry, without the stars."
6816 (save-excursion
6817 (org-back-to-heading t)
6818 (if (looking-at
6819 (if no-tags
6822 (match-string 1) "")))
6824 (defun org-heading-components ()
6825 "Return the components of the current heading.
6826 This is a list with the following elements:
6827 - the level as an integer
6828 - the reduced level, different if `org-odd-levels-only' is set.
6829 - the TODO keyword, or nil
6830 - the priority character, like ?A, or nil if no priority is given
6831 - the headline text itself, or the tags string if no headline text
6832 - the tags string, or nil."
6833 (save-excursion
6834 (org-back-to-heading t)
6835 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6836 (list (length (match-string 1))
6837 (org-reduced-level (length (match-string 1)))
6838 (org-match-string-no-properties 2)
6839 (and (match-end 3) (aref (match-string 3) 2))
6840 (org-match-string-no-properties 4)
6841 (org-match-string-no-properties 5)))))
6843 (defun org-get-entry ()
6844 "Get the entry text, after heading, entire subtree."
6845 (save-excursion
6846 (org-back-to-heading t)
6847 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6849 (defun org-insert-heading-after-current ()
6850 "Insert a new heading with same level as current, after current subtree."
6851 (interactive)
6852 (org-back-to-heading)
6853 (org-insert-heading)
6854 (org-move-subtree-down)
6855 (end-of-line 1))
6857 (defun org-insert-heading-respect-content ()
6858 (interactive)
6859 (let ((org-insert-heading-respect-content t))
6860 (org-insert-heading t)))
6862 (defun org-insert-todo-heading-respect-content (&optional force-state)
6863 (interactive "P")
6864 (let ((org-insert-heading-respect-content t))
6865 (org-insert-todo-heading force-state t)))
6867 (defun org-insert-todo-heading (arg &optional force-heading)
6868 "Insert a new heading with the same level and TODO state as current heading.
6869 If the heading has no TODO state, or if the state is DONE, use the first
6870 state (TODO by default). Also with prefix arg, force first state."
6871 (interactive "P")
6872 (when (or force-heading (not (org-insert-item 'checkbox)))
6873 (org-insert-heading force-heading)
6874 (save-excursion
6875 (org-back-to-heading)
6876 (outline-previous-heading)
6877 (looking-at org-todo-line-regexp))
6878 (let*
6879 ((new-mark-x
6880 (if (or arg
6881 (not (match-beginning 2))
6882 (member (match-string 2) org-done-keywords))
6883 (car org-todo-keywords-1)
6884 (match-string 2)))
6885 (new-mark
6886 (or
6887 (run-hook-with-args-until-success
6888 'org-todo-get-default-hook new-mark-x nil)
6889 new-mark-x)))
6890 (beginning-of-line 1)
6892 (if org-treat-insert-todo-heading-as-state-change
6893 (org-todo new-mark)
6894 (insert new-mark " "))))
6895 (when org-provide-todo-statistics
6896 (org-update-parent-todo-statistics))))
6898 (defun org-insert-subheading (arg)
6899 "Insert a new subheading and demote it.
6900 Works for outline headings and for plain lists alike."
6901 (interactive "P")
6902 (org-insert-heading arg)
6903 (cond
6904 ((org-on-heading-p) (org-do-demote))
6905 ((org-at-item-p) (org-indent-item))))
6907 (defun org-insert-todo-subheading (arg)
6908 "Insert a new subheading with TODO keyword or checkbox and demote it.
6909 Works for outline headings and for plain lists alike."
6910 (interactive "P")
6911 (org-insert-todo-heading arg)
6912 (cond
6913 ((org-on-heading-p) (org-do-demote))
6914 ((org-at-item-p) (org-indent-item))))
6916 ;;; Promotion and Demotion
6918 (defvar org-after-demote-entry-hook nil
6919 "Hook run after an entry has been demoted.
6920 The cursor will be at the beginning of the entry.
6921 When a subtree is being demoted, the hook will be called for each node.")
6923 (defvar org-after-promote-entry-hook nil
6924 "Hook run after an entry has been promoted.
6925 The cursor will be at the beginning of the entry.
6926 When a subtree is being promoted, the hook will be called for each node.")
6928 (defun org-promote-subtree ()
6929 "Promote the entire subtree.
6930 See also `org-promote'."
6931 (interactive)
6932 (save-excursion
6933 (org-map-tree 'org-promote))
6934 (org-fix-position-after-promote))
6936 (defun org-demote-subtree ()
6937 "Demote the entire subtree. See `org-demote'.
6938 See also `org-promote'."
6939 (interactive)
6940 (save-excursion
6941 (org-map-tree 'org-demote))
6942 (org-fix-position-after-promote))
6945 (defun org-do-promote ()
6946 "Promote the current heading higher up the tree.
6947 If the region is active in `transient-mark-mode', promote all headings
6948 in the region."
6949 (interactive)
6950 (save-excursion
6951 (if (org-region-active-p)
6952 (org-map-region 'org-promote (region-beginning) (region-end))
6953 (org-promote)))
6954 (org-fix-position-after-promote))
6956 (defun org-do-demote ()
6957 "Demote the current heading lower down the tree.
6958 If the region is active in `transient-mark-mode', demote all headings
6959 in the region."
6960 (interactive)
6961 (save-excursion
6962 (if (org-region-active-p)
6963 (org-map-region 'org-demote (region-beginning) (region-end))
6964 (org-demote)))
6965 (org-fix-position-after-promote))
6967 (defun org-fix-position-after-promote ()
6968 "Make sure that after pro/demotion cursor position is right."
6969 (let ((pos (point)))
6970 (when (save-excursion
6971 (beginning-of-line 1)
6972 (looking-at org-todo-line-regexp)
6973 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6974 (cond ((eobp) (insert " "))
6975 ((eolp) (insert " "))
6976 ((equal (char-after) ?\ ) (forward-char 1))))))
6978 (defun org-current-level ()
6979 "Return the level of the current entry, or nil if before the first headline.
6980 The level is the number of stars at the beginning of the headline."
6981 (save-excursion
6982 (condition-case nil
6983 (progn
6984 (org-back-to-heading t)
6985 (funcall outline-level))
6986 (error nil))))
6988 (defun org-get-previous-line-level ()
6989 "Return the outline depth of the last headline before the current line.
6990 Returns 0 for the first headline in the buffer, and nil if before the
6991 first headline."
6992 (let ((current-level (org-current-level))
6993 (prev-level (when (> (line-number-at-pos) 1)
6994 (save-excursion
6995 (beginning-of-line 0)
6996 (org-current-level)))))
6997 (cond ((null current-level) nil) ; Before first headline
6998 ((null prev-level) 0) ; At first headline
6999 (prev-level))))
7001 (defun org-reduced-level (l)
7002 "Compute the effective level of a heading.
7003 This takes into account the setting of `org-odd-levels-only'."
7004 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
7006 (defun org-level-increment ()
7007 "Return the number of stars that will be added or removed at a
7008 time to headlines when structure editing, based on the value of
7009 `org-odd-levels-only'."
7010 (if org-odd-levels-only 2 1))
7012 (defun org-get-valid-level (level &optional change)
7013 "Rectify a level change under the influence of `org-odd-levels-only'
7014 LEVEL is a current level, CHANGE is by how much the level should be
7015 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7016 even level numbers will become the next higher odd number."
7017 (if org-odd-levels-only
7018 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7019 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7020 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7021 (max 1 (+ level (or change 0)))))
7023 (if (boundp 'define-obsolete-function-alias)
7024 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7025 (define-obsolete-function-alias 'org-get-legal-level
7026 'org-get-valid-level)
7027 (define-obsolete-function-alias 'org-get-legal-level
7028 'org-get-valid-level "23.1")))
7030 (defun org-promote ()
7031 "Promote the current heading higher up the tree.
7032 If the region is active in `transient-mark-mode', promote all headings
7033 in the region."
7034 (org-back-to-heading t)
7035 (let* ((level (save-match-data (funcall outline-level)))
7036 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7037 (diff (abs (- level (length up-head) -1))))
7038 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7039 (replace-match up-head nil t)
7040 ;; Fixup tag positioning
7041 (and org-auto-align-tags (org-set-tags nil t))
7042 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7043 (run-hooks 'org-after-promote-entry-hook)))
7045 (defun org-demote ()
7046 "Demote the current heading lower down the tree.
7047 If the region is active in `transient-mark-mode', demote all headings
7048 in the region."
7049 (org-back-to-heading t)
7050 (let* ((level (save-match-data (funcall outline-level)))
7051 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7052 (diff (abs (- level (length down-head) -1))))
7053 (replace-match down-head nil t)
7054 ;; Fixup tag positioning
7055 (and org-auto-align-tags (org-set-tags nil t))
7056 (if org-adapt-indentation (org-fixup-indentation diff))
7057 (run-hooks 'org-after-demote-entry-hook)))
7059 (defun org-cycle-level ()
7060 "Cycle the level of an empty headline through possible states.
7061 This goes first to child, then to parent, level, then up the hierarchy.
7062 After top level, it switches back to sibling level."
7063 (interactive)
7064 (let ((org-adapt-indentation nil))
7065 (when (org-point-at-end-of-empty-headline)
7066 (setq this-command 'org-cycle-level) ; Only needed for caching
7067 (let ((cur-level (org-current-level))
7068 (prev-level (org-get-previous-line-level)))
7069 (cond
7070 ;; If first headline in file, promote to top-level.
7071 ((= prev-level 0)
7072 (loop repeat (/ (- cur-level 1) (org-level-increment))
7073 do (org-do-promote)))
7074 ;; If same level as prev, demote one.
7075 ((= prev-level cur-level)
7076 (org-do-demote))
7077 ;; If parent is top-level, promote to top level if not already.
7078 ((= prev-level 1)
7079 (loop repeat (/ (- cur-level 1) (org-level-increment))
7080 do (org-do-promote)))
7081 ;; If top-level, return to prev-level.
7082 ((= cur-level 1)
7083 (loop repeat (/ (- prev-level 1) (org-level-increment))
7084 do (org-do-demote)))
7085 ;; If less than prev-level, promote one.
7086 ((< cur-level prev-level)
7087 (org-do-promote))
7088 ;; If deeper than prev-level, promote until higher than
7089 ;; prev-level.
7090 ((> cur-level prev-level)
7091 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7092 do (org-do-promote))))
7093 t))))
7095 (defun org-map-tree (fun)
7096 "Call FUN for every heading underneath the current one."
7097 (org-back-to-heading)
7098 (let ((level (funcall outline-level)))
7099 (save-excursion
7100 (funcall fun)
7101 (while (and (progn
7102 (outline-next-heading)
7103 (> (funcall outline-level) level))
7104 (not (eobp)))
7105 (funcall fun)))))
7107 (defun org-map-region (fun beg end)
7108 "Call FUN for every heading between BEG and END."
7109 (let ((org-ignore-region t))
7110 (save-excursion
7111 (setq end (copy-marker end))
7112 (goto-char beg)
7113 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
7114 (< (point) end))
7115 (funcall fun))
7116 (while (and (progn
7117 (outline-next-heading)
7118 (< (point) end))
7119 (not (eobp)))
7120 (funcall fun)))))
7122 (defun org-fixup-indentation (diff)
7123 "Change the indentation in the current entry by DIFF.
7124 However, if any line in the current entry has no indentation, or if it
7125 would end up with no indentation after the change, nothing at all is done."
7126 (save-excursion
7127 (let ((end (save-excursion (outline-next-heading)
7128 (point-marker)))
7129 (prohibit (if (> diff 0)
7132 col)
7133 (unless (save-excursion (end-of-line 1)
7134 (re-search-forward prohibit end t))
7135 (while (and (< (point) end)
7137 (goto-char (match-end 0))
7138 (setq col (current-column))
7139 (if (< diff 0) (replace-match ""))
7140 (org-indent-to-column (+ diff col))))
7141 (move-marker end nil))))
7143 (defun org-convert-to-odd-levels ()
7144 "Convert an org-mode file with all levels allowed to one with odd levels.
7145 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7146 level 5 etc."
7147 (interactive)
7148 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7149 (let ((outline-regexp org-outline-regexp)
7150 (outline-level 'org-outline-level)
7151 (org-odd-levels-only nil) n)
7152 (save-excursion
7153 (goto-char (point-min))
7155 (setq n (- (length (match-string 0)) 2))
7156 (while (>= (setq n (1- n)) 0)
7157 (org-demote))
7158 (end-of-line 1))))))
7160 (defun org-convert-to-oddeven-levels ()
7161 "Convert an org-mode file with only odd levels to one with odd/even levels.
7162 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7163 file contains a section with an even level, conversion would
7164 destroy the structure of the file. An error is signaled in this
7165 case."
7166 (interactive)
7167 (goto-char (point-min))
7168 ;; First check if there are no even levels
7170 (org-show-context t)
7171 (error "Not all levels are odd in this file. Conversion not possible"))
7172 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7173 (let ((outline-regexp org-outline-regexp)
7174 (outline-level 'org-outline-level)
7175 (org-odd-levels-only nil) n)
7176 (save-excursion
7177 (goto-char (point-min))
7179 (setq n (/ (1- (length (match-string 0))) 2))
7180 (while (>= (setq n (1- n)) 0)
7181 (org-promote))
7182 (end-of-line 1))))))
7184 (defun org-tr-level (n)
7185 "Make N odd if required."
7186 (if org-odd-levels-only (1+ (/ n 2)) n))
7188 ;;; Vertical tree motion, cutting and pasting of subtrees
7190 (defun org-move-subtree-up (&optional arg)
7191 "Move the current subtree up past ARG headlines of the same level."
7192 (interactive "p")
7193 (org-move-subtree-down (- (prefix-numeric-value arg))))
7195 (defun org-move-subtree-down (&optional arg)
7196 "Move the current subtree down past ARG headlines of the same level."
7197 (interactive "p")
7198 (setq arg (prefix-numeric-value arg))
7199 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7200 'org-get-last-sibling))
7201 (ins-point (make-marker))
7202 (cnt (abs arg))
7203 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7204 ;; Select the tree
7205 (org-back-to-heading)
7206 (setq beg0 (point))
7207 (save-excursion
7208 (setq ne-beg (org-back-over-empty-lines))
7209 (setq beg (point)))
7210 (save-match-data
7211 (save-excursion (outline-end-of-heading)
7212 (setq folded (org-invisible-p)))
7213 (outline-end-of-subtree))
7214 (outline-next-heading)
7215 (setq ne-end (org-back-over-empty-lines))
7216 (setq end (point))
7217 (goto-char beg0)
7218 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7219 ;; include less whitespace
7220 (save-excursion
7221 (goto-char beg)
7222 (forward-line (- ne-beg ne-end))
7223 (setq beg (point))))
7224 ;; Find insertion point, with error handling
7225 (while (> cnt 0)
7226 (or (and (funcall movfunc) (looking-at outline-regexp))
7227 (progn (goto-char beg0)
7228 (error "Cannot move past superior level or buffer limit")))
7229 (setq cnt (1- cnt)))
7230 (if (> arg 0)
7231 ;; Moving forward - still need to move over subtree
7232 (progn (org-end-of-subtree t t)
7233 (save-excursion
7234 (org-back-over-empty-lines)
7235 (or (bolp) (newline)))))
7236 (setq ne-ins (org-back-over-empty-lines))
7237 (move-marker ins-point (point))
7238 (setq txt (buffer-substring beg end))
7239 (org-save-markers-in-region beg end)
7240 (delete-region beg end)
7241 (org-remove-empty-overlays-at beg)
7242 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7243 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7245 (let ((bbb (point)))
7246 (insert-before-markers txt)
7247 (org-reinstall-markers-in-region bbb)
7248 (move-marker ins-point bbb))
7250 (setq ins-end (point))
7251 (goto-char ins-point)
7252 (org-skip-whitespace)
7253 (when (and (< arg 0)
7254 (org-first-sibling-p)
7255 (> ne-ins ne-beg))
7256 ;; Move whitespace back to beginning
7257 (save-excursion
7258 (goto-char ins-end)
7259 (let ((kill-whole-line t))
7260 (kill-line (- ne-ins ne-beg)) (point)))
7262 (move-marker ins-point nil)
7263 (if folded
7264 (hide-subtree)
7265 (org-show-entry)
7266 (show-children)
7267 (org-cycle-hide-drawers 'children))
7268 (org-clean-visibility-after-subtree-move)))
7270 (defvar org-subtree-clip ""
7271 "Clipboard for cut and paste of subtrees.
7272 This is actually only a copy of the kill, because we use the normal kill
7273 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7275 (defvar org-subtree-clip-folded nil
7276 "Was the last copied subtree folded?
7277 This is used to fold the tree back after pasting.")
7279 (defun org-cut-subtree (&optional n)
7280 "Cut the current subtree into the clipboard.
7281 With prefix arg N, cut this many sequential subtrees.
7282 This is a short-hand for marking the subtree and then cutting it."
7283 (interactive "p")
7284 (org-copy-subtree n 'cut))
7286 (defun org-copy-subtree (&optional n cut force-store-markers)
7287 "Cut the current subtree into the clipboard.
7288 With prefix arg N, cut this many sequential subtrees.
7289 This is a short-hand for marking the subtree and then copying it.
7290 If CUT is non-nil, actually cut the subtree.
7291 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7292 of some markers in the region, even if CUT is non-nil. This is
7293 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7294 (interactive "p")
7295 (let (beg end folded (beg0 (point)))
7296 (if (interactive-p)
7297 (org-back-to-heading nil) ; take what looks like a subtree
7298 (org-back-to-heading t)) ; take what is really there
7299 (org-back-over-empty-lines)
7300 (setq beg (point))
7302 (save-match-data
7303 (save-excursion (outline-end-of-heading)
7304 (setq folded (org-invisible-p)))
7305 (condition-case nil
7306 (org-forward-same-level (1- n) t)
7307 (error nil))
7308 (org-end-of-subtree t t))
7309 (org-back-over-empty-lines)
7310 (setq end (point))
7311 (goto-char beg0)
7312 (when (> end beg)
7313 (setq org-subtree-clip-folded folded)
7314 (when (or cut force-store-markers)
7315 (org-save-markers-in-region beg end))
7316 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7317 (setq org-subtree-clip (current-kill 0))
7318 (message "%s: Subtree(s) with %d characters"
7319 (if cut "Cut" "Copied")
7320 (length org-subtree-clip)))))
7322 (defun org-paste-subtree (&optional level tree for-yank)
7323 "Paste the clipboard as a subtree, with modification of headline level.
7324 The entire subtree is promoted or demoted in order to match a new headline
7325 level.
7327 If the cursor is at the beginning of a headline, the same level as
7328 that headline is used to paste the tree
7330 If not, the new level is derived from the *visible* headings
7331 before and after the insertion point, and taken to be the inferior headline
7332 level of the two. So if the previous visible heading is level 3 and the
7333 next is level 4 (or vice versa), level 4 will be used for insertion.
7334 This makes sure that the subtree remains an independent subtree and does
7335 not swallow low level entries.
7337 You can also force a different level, either by using a numeric prefix
7338 argument, or by inserting the heading marker by hand. For example, if the
7341 If optional TREE is given, use this text instead of the kill ring.
7343 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7344 move back over whitespace before inserting, and move point to the end of
7345 the inserted text when done."
7346 (interactive "P")
7347 (setq tree (or tree (and kill-ring (current-kill 0))))
7348 (unless (org-kill-is-subtree-p tree)
7349 (error "%s"
7350 (substitute-command-keys
7352 (let* ((visp (not (org-invisible-p)))
7353 (txt tree)
7358 (old-level (if (string-match ^re txt)
7359 (- (match-end 0) (match-beginning 0) 1)
7360 -1))
7361 (force-level (cond (level (prefix-numeric-value level))
7363 (string-match
7364 ^re_ (buffer-substring
7365 (point-at-bol) (point))))
7366 (- (match-end 1) (match-beginning 1)))
7367 ((and (bolp)
7368 (looking-at org-outline-regexp))
7369 (- (match-end 0) (point) 1))
7370 (t nil)))
7371 (previous-level (save-excursion
7372 (condition-case nil
7373 (progn
7374 (outline-previous-visible-heading 1)
7375 (if (looking-at re)
7376 (- (match-end 0) (match-beginning 0) 1)
7377 1))
7378 (error 1))))
7379 (next-level (save-excursion
7380 (condition-case nil
7381 (progn
7382 (or (looking-at outline-regexp)
7383 (outline-next-visible-heading 1))
7384 (if (looking-at re)
7385 (- (match-end 0) (match-beginning 0) 1)
7386 1))
7387 (error 1))))
7388 (new-level (or force-level (max previous-level next-level)))
7389 (shift (if (or (= old-level -1)
7390 (= new-level -1)
7391 (= old-level new-level))
7392 0
7393 (- new-level old-level)))
7394 (delta (if (> shift 0) -1 1))
7395 (func (if (> shift 0) 'org-demote 'org-promote))
7396 (org-odd-levels-only nil)
7397 beg end newend)
7398 ;; Remove the forced level indicator
7399 (if force-level
7400 (delete-region (point-at-bol) (point)))
7401 ;; Paste
7402 (beginning-of-line 1)
7403 (unless for-yank (org-back-over-empty-lines))
7404 (setq beg (point))
7405 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7406 (insert-before-markers txt)
7408 (setq newend (point))
7409 (org-reinstall-markers-in-region beg)
7410 (setq end (point))
7411 (goto-char beg)
7413 (setq beg (point))
7414 (if (and (org-invisible-p) visp)
7415 (save-excursion (outline-show-heading)))
7416 ;; Shift if necessary
7417 (unless (= shift 0)
7418 (save-restriction
7419 (narrow-to-region beg end)
7420 (while (not (= shift 0))
7421 (org-map-region func (point-min) (point-max))
7422 (setq shift (+ delta shift)))
7423 (goto-char (point-min))
7424 (setq newend (point-max))))
7425 (when (or (interactive-p) for-yank)
7426 (message "Clipboard pasted as level %d subtree" new-level))
7427 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7428 kill-ring
7429 (eq org-subtree-clip (current-kill 0))
7430 org-subtree-clip-folded)
7431 ;; The tree was folded before it was killed/copied
7432 (hide-subtree))
7433 (and for-yank (goto-char newend))))
7435 (defun org-kill-is-subtree-p (&optional txt)
7436 "Check if the current kill is an outline subtree, or a set of trees.
7437 Returns nil if kill does not start with a headline, or if the first
7438 headline level is not the largest headline level in the tree.
7439 So this will actually accept several entries of equal levels as well,
7440 which is OK for `org-paste-subtree'.
7441 If optional TXT is given, check this string instead of the current kill."
7442 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7443 (start-level (and kill
7446 kill)
7447 (- (match-end 2) (match-beginning 2) 1)))
7448 (re (concat "^" org-outline-regexp))
7449 (start (1+ (or (match-beginning 2) -1))))
7450 (if (not start-level)
7451 (progn
7452 nil) ;; does not even start with a heading
7453 (catch 'exit
7454 (while (setq start (string-match re kill (1+ start)))
7455 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7456 (throw 'exit nil)))
7457 t))))
7459 (defvar org-markers-to-move nil
7460 "Markers that should be moved with a cut-and-paste operation.
7461 Those markers are stored together with their positions relative to
7462 the start of the region.")
7464 (defun org-save-markers-in-region (beg end)
7465 "Check markers in region.
7466 If these markers are between BEG and END, record their position relative
7467 to BEG, so that after moving the block of text, we can put the markers back
7468 into place.
7469 This function gets called just before an entry or tree gets cut from the
7470 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7471 called immediately, to move the markers with the entries."
7472 (setq org-markers-to-move nil)
7473 (when (featurep 'org-clock)
7474 (org-clock-save-markers-for-cut-and-paste beg end))
7475 (when (featurep 'org-agenda)
7476 (org-agenda-save-markers-for-cut-and-paste beg end)))
7478 (defun org-check-and-save-marker (marker beg end)
7479 "Check if MARKER is between BEG and END.
7480 If yes, remember the marker and the distance to BEG."
7481 (when (and (marker-buffer marker)
7482 (equal (marker-buffer marker) (current-buffer)))
7483 (if (and (>= marker beg) (< marker end))
7484 (push (cons marker (- marker beg)) org-markers-to-move))))
7486 (defun org-reinstall-markers-in-region (beg)
7487 "Move all remembered markers to their position relative to BEG."
7488 (mapc (lambda (x)
7489 (move-marker (car x) (+ beg (cdr x))))
7490 org-markers-to-move)
7491 (setq org-markers-to-move nil))
7493 (defun org-narrow-to-subtree ()
7494 "Narrow buffer to the current subtree."
7495 (interactive)
7496 (save-excursion
7497 (save-match-data
7498 (narrow-to-region
7499 (progn (org-back-to-heading t) (point))
7500 (progn (org-end-of-subtree t t)
7501 (if (org-on-heading-p) (backward-char 1))
7502 (point))))))
7504 (eval-when-compile
7505 (defvar org-property-drawer-re))
7507 (defun org-clone-subtree-with-time-shift (n &optional shift)
7508 "Clone the task (subtree) at point N times.
7509 The clones will be inserted as siblings.
7511 In interactive use, the user will be prompted for the number of
7512 clones to be produced, and for a time SHIFT, which may be a
7513 repeater as used in time stamps, for example `+3d'.
7515 When a valid repeater is given and the entry contains any time
7516 stamps, the clones will become a sequence in time, with time
7517 stamps in the subtree shifted for each clone produced. If SHIFT
7518 is nil or the empty string, time stamps will be left alone. The
7519 ID property of the original subtree is removed.
7521 If the original subtree did contain time stamps with a repeater,
7522 the following will happen:
7523 - the repeater will be removed in each clone
7524 - an additional clone will be produced, with the current, unshifted
7525 date(s) in the entry.
7526 - the original entry will be placed *after* all the clones, with
7527 repeater intact.
7528 - the start days in the repeater in the original entry will be shifted
7529 to past the last clone.
7530 I this way you can spell out a number of instances of a repeating task,
7531 and still retain the repeater to cover future instances of the task."
7532 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7533 (let (beg end template task idprop
7534 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7535 (if (not (and (integerp n) (> n 0)))
7536 (error "Invalid number of replications %s" n))
7539 shift)))
7540 (error "Invalid shift specification %s" shift))
7541 (when doshift
7542 (setq shift-n (string-to-number (match-string 1 shift))
7543 shift-what (cdr (assoc (match-string 2 shift)
7544 '(("d" . day) ("w" . week)
7545 ("m" . month) ("y" . year))))))
7546 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7547 (setq nmin 1 nmax n)
7548 (org-back-to-heading t)
7549 (setq beg (point))
7550 (setq idprop (org-entry-get nil "ID"))
7551 (org-end-of-subtree t t)
7553 (setq end (point))
7554 (setq template (buffer-substring beg end))
7555 (when (and doshift
7557 (delete-region beg end)
7558 (setq end beg)
7559 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7560 (goto-char end)
7561 (loop for n from nmin to nmax do
7562 ;; prepare clone
7563 (with-temp-buffer
7564 (insert template)
7565 (org-mode)
7566 (goto-char (point-min))
7567 (and idprop (if org-clone-delete-id
7568 (org-entry-delete nil "ID")
7569 (org-id-get-create t)))
7570 (while (re-search-forward org-property-drawer-re nil t)
7571 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7572 (goto-char (point-min))
7573 (when doshift
7574 (while (re-search-forward org-ts-regexp-both nil t)
7575 (org-timestamp-change (* n shift-n) shift-what))
7576 (unless (= n n-no-remove)
7577 (goto-char (point-min))
7578 (while (re-search-forward org-ts-regexp nil t)
7579 (save-excursion
7580 (goto-char (match-beginning 0))
7582 (delete-region (match-beginning 1) (match-end 1)))))))
7583 (setq task (buffer-string)))
7584 (insert task))
7585 (goto-char beg)))
7587 ;;; Outline Sorting
7589 (defun org-sort (with-case)
7590 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7591 Optional argument WITH-CASE means sort case-sensitively.
7592 With a double prefix argument, also remove duplicate entries."
7593 (interactive "P")
7594 (cond
7595 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7596 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7597 (t
7598 (org-call-with-arg 'org-sort-entries with-case))))
7600 (defun org-sort-remove-invisible (s)
7601 (remove-text-properties 0 (length s) org-rm-props s)
7602 (while (string-match org-bracket-link-regexp s)
7603 (setq s (replace-match (if (match-end 2)
7604 (match-string 3 s)
7605 (match-string 1 s)) t t s)))
7606 s)
7608 (defvar org-priority-regexp) ; defined later in the file
7610 (defvar org-after-sorting-entries-or-items-hook nil
7611 "Hook that is run after a bunch of entries or items have been sorted.
7612 When children are sorted, the cursor is in the parent line when this
7613 hook gets called. When a region or a plain list is sorted, the cursor
7614 will be in the first entry of the sorted region/list.")
7616 (defun org-sort-entries
7617 (&optional with-case sorting-type getkey-func compare-func property)
7618 "Sort entries on a certain level of an outline tree.
7619 If there is an active region, the entries in the region are sorted.
7620 Else, if the cursor is before the first entry, sort the top-level items.
7621 Else, the children of the entry at point are sorted.
7623 Sorting can be alphabetically, numerically, by date/time as given by
7624 a time stamp, by a property or by priority.
7626 The command prompts for the sorting type unless it has been given to the
7627 function through the SORTING-TYPE argument, which needs to be a character,
7628 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7629 precise meaning of each character:
7631 n Numerically, by converting the beginning of the entry/item to a number.
7632 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7633 t By date/time, either the first active time stamp in the entry, or, if
7634 none exist, by the first inactive one.
7635 s By the scheduled date/time.
7636 d By deadline date/time.
7637 c By creation time, which is assumed to be the first inactive time stamp
7638 at the beginning of a line.
7639 p By priority according to the cookie.
7640 r By the value of a property.
7642 Capital letters will reverse the sort order.
7644 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7645 called with point at the beginning of the record. It must return either
7646 a string or a number that should serve as the sorting key for that record.
7648 Comparing entries ignores case by default. However, with an optional argument
7649 WITH-CASE, the sorting considers case as well."
7650 (interactive "P")
7651 (let ((case-func (if with-case 'identity 'downcase))
7652 start beg end stars re re2
7653 txt what tmp)
7654 ;; Find beginning and end of region to sort
7655 (cond
7656 ((org-region-active-p)
7657 ;; we will sort the region
7658 (setq end (region-end)
7659 what "region")
7660 (goto-char (region-beginning))
7661 (if (not (org-on-heading-p)) (outline-next-heading))
7662 (setq start (point)))
7663 ((or (org-on-heading-p)
7664 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7665 ;; we will sort the children of the current headline
7666 (org-back-to-heading)
7667 (setq start (point)
7668 end (progn (org-end-of-subtree t t)
7670 (org-back-over-empty-lines)
7671 (point))
7672 what "children")
7673 (goto-char start)
7674 (show-subtree)
7675 (outline-next-heading))
7676 (t
7677 ;; we will sort the top-level entries in this file
7678 (goto-char (point-min))
7679 (or (org-on-heading-p) (outline-next-heading))
7680 (setq start (point))
7681 (goto-char (point-max))
7682 (beginning-of-line 1)
7684 ;; File ends in a non-white line
7685 (end-of-line 1)
7687 (setq end (point-max))
7688 (setq what "top-level")
7689 (goto-char start)
7690 (show-all)))
7692 (setq beg (point))
7693 (if (>= beg end) (error "Nothing to sort"))
7696 (setq stars (match-string 1)
7697 re (concat "^" (regexp-quote stars) " +")
7698 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
7699 txt (buffer-substring beg end))
7701 (if (and (not (equal stars "*")) (string-match re2 txt))
7702 (error "Region to sort contains a level above the first entry"))
7704 (unless sorting-type
7705 (message
7706 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7708 A/N/T/S/D/C/P/O/F means reversed:"
7709 what)
7710 (setq sorting-type (read-char-exclusive))
7712 (and (= (downcase sorting-type) ?f)
7713 (setq getkey-func
7714 (org-icompleting-read "Sort using function: "
7715 obarray 'fboundp t nil nil))
7716 (setq getkey-func (intern getkey-func)))
7718 (and (= (downcase sorting-type) ?r)
7719 (setq property
7720 (org-icompleting-read "Property: "
7721 (mapcar 'list (org-buffer-property-keys t))
7722 nil t))))
7724 (message "Sorting entries...")
7726 (save-restriction
7727 (narrow-to-region start end)
7728 (let ((dcst (downcase sorting-type))
7729 (case-fold-search nil)
7730 (now (current-time)))
7731 (sort-subr
7732 (/= dcst sorting-type)
7733 ;; This function moves to the beginning character of the "record" to
7734 ;; be sorted.
7735 (lambda nil
7736 (if (re-search-forward re nil t)
7737 (goto-char (match-beginning 0))
7738 (goto-char (point-max))))
7739 ;; This function moves to the last character of the "record" being
7740 ;; sorted.
7741 (lambda nil
7742 (save-match-data
7743 (condition-case nil
7744 (outline-forward-same-level 1)
7745 (error
7746 (goto-char (point-max))))))
7747 ;; This function returns the value that gets sorted against.
7748 (lambda nil
7749 (cond
7750 ((= dcst ?n)
7751 (if (looking-at org-complex-heading-regexp)
7752 (string-to-number (match-string 4))
7753 nil))
7754 ((= dcst ?a)
7755 (if (looking-at org-complex-heading-regexp)
7756 (funcall case-func (match-string 4))
7757 nil))
7758 ((= dcst ?t)
7759 (let ((end (save-excursion (outline-next-heading) (point))))
7760 (if (or (re-search-forward org-ts-regexp end t)
7761 (re-search-forward org-ts-regexp-both end t))
7762 (org-time-string-to-seconds (match-string 0))
7763 (org-float-time now))))
7764 ((= dcst ?c)
7765 (let ((end (save-excursion (outline-next-heading) (point))))
7766 (if (re-search-forward
7768 end t)
7769 (org-time-string-to-seconds (match-string 0))
7770 (org-float-time now))))
7771 ((= dcst ?s)
7772 (let ((end (save-excursion (outline-next-heading) (point))))
7773 (if (re-search-forward org-scheduled-time-regexp end t)
7774 (org-time-string-to-seconds (match-string 1))
7775 (org-float-time now))))
7776 ((= dcst ?d)
7777 (let ((end (save-excursion (outline-next-heading) (point))))
7778 (if (re-search-forward org-deadline-time-regexp end t)
7779 (org-time-string-to-seconds (match-string 1))
7780 (org-float-time now))))
7781 ((= dcst ?p)
7782 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7783 (string-to-char (match-string 2))
7784 org-default-priority))
7785 ((= dcst ?r)
7786 (or (org-entry-get nil property) ""))
7787 ((= dcst ?o)
7788 (if (looking-at org-complex-heading-regexp)
7789 (- 9999 (length (member (match-string 2)
7790 org-todo-keywords-1)))))
7791 ((= dcst ?f)
7792 (if getkey-func
7793 (progn
7794 (setq tmp (funcall getkey-func))
7795 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7796 tmp)
7797 (error "Invalid key function `%s'" getkey-func)))
7798 (t (error "Invalid sorting type `%c'" sorting-type))))
7799 nil
7800 (cond
7801 ((= dcst ?a) 'string<)
7802 ((= dcst ?f) compare-func)
7803 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7804 (t nil)))))
7805 (run-hooks 'org-after-sorting-entries-or-items-hook)
7806 (message "Sorting entries...done")))
7808 (defun org-do-sort (table what &optional with-case sorting-type)
7809 "Sort TABLE of WHAT according to SORTING-TYPE.
7810 The user will be prompted for the SORTING-TYPE if the call to this
7811 function does not specify it. WHAT is only for the prompt, to indicate
7812 what is being sorted. The sorting key will be extracted from
7813 the car of the elements of the table.
7814 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7815 (unless sorting-type
7816 (message
7817 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7818 what)
7819 (setq sorting-type (read-char-exclusive)))
7820 (let ((dcst (downcase sorting-type))
7821 extractfun comparefun)
7822 ;; Define the appropriate functions
7823 (cond
7824 ((= dcst ?n)
7825 (setq extractfun 'string-to-number
7826 comparefun (if (= dcst sorting-type) '< '>)))
7827 ((= dcst ?a)
7828 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7829 (lambda(x) (downcase (org-sort-remove-invisible x))))
7830 comparefun (if (= dcst sorting-type)
7831 'string<
7832 (lambda (a b) (and (not (string< a b))
7833 (not (string= a b)))))))
7834 ((= dcst ?t)
7835 (setq extractfun
7836 (lambda (x)
7837 (if (or (string-match org-ts-regexp x)
7838 (string-match org-ts-regexp-both x))
7839 (org-float-time
7840 (org-time-string-to-time (match-string 0 x)))
7841 0))
7842 comparefun (if (= dcst sorting-type) '< '>)))
7843 (t (error "Invalid sorting type `%c'" sorting-type)))
7845 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7846 table)
7847 (lambda (a b) (funcall comparefun (car a) (car b))))))
7850 ;;; The orgstruct minor mode
7852 ;; Define a minor mode which can be used in other modes in order to
7853 ;; integrate the org-mode structure editing commands.
7855 ;; This is really a hack, because the org-mode structure commands use
7856 ;; keys which normally belong to the major mode. Here is how it
7857 ;; works: The minor mode defines all the keys necessary to operate the
7858 ;; structure commands, but wraps the commands into a function which
7859 ;; tests if the cursor is currently at a headline or a plain list
7860 ;; item. If that is the case, the structure command is used,
7861 ;; temporarily setting many Org-mode variables like regular
7862 ;; expressions for filling etc. However, when any of those keys is
7863 ;; used at a different location, function uses `key-binding' to look
7864 ;; up if the key has an associated command in another currently active
7865 ;; keymap (minor modes, major mode, global), and executes that
7866 ;; command. There might be problems if any of the keys is otherwise
7867 ;; used as a prefix key.
7869 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7870 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7871 ;; addresses this by checking explicitly for both bindings.
7873 (defvar orgstruct-mode-map (make-sparse-keymap)
7874 "Keymap for the minor `orgstruct-mode'.")
7876 (defvar org-local-vars nil
7877 "List of local variables, for use by `orgstruct-mode'.")
7879 ;;;###autoload
7880 (define-minor-mode orgstruct-mode
7881 "Toggle the minor mode `orgstruct-mode'.
7882 This mode is for using Org-mode structure commands in other
7883 modes. The following keys behave as if Org-mode were active, if
7884 the cursor is on a headline, or on a plain list item (both as
7885 defined by Org-mode).
7887 M-up Move entry/item up
7888 M-down Move entry/item down
7889 M-left Promote
7890 M-right Demote
7891 M-S-up Move entry/item up
7892 M-S-down Move entry/item down
7893 M-S-left Promote subtree
7894 M-S-right Demote subtree
7895 M-q Fill paragraph and items like in Org-mode
7896 C-c ^ Sort entries
7897 C-c - Cycle list bullet
7898 TAB Cycle item visibility
7899 M-RET Insert new heading/item
7900 S-M-RET Insert new TODO heading / Checkbox item
7901 C-c C-c Set tags / toggle checkbox"
7902 nil " OrgStruct" nil
7903 (org-load-modules-maybe)
7904 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7906 ;;;###autoload
7907 (defun turn-on-orgstruct ()
7908 "Unconditionally turn on `orgstruct-mode'."
7909 (orgstruct-mode 1))
7911 (defun orgstruct++-mode (&optional arg)
7912 "Toggle `orgstruct-mode', the enhanced version of it.
7913 In addition to setting orgstruct-mode, this also exports all indentation
7914 and autofilling variables from org-mode into the buffer. It will also
7915 recognize item context in multiline items.
7916 Note that turning off orgstruct-mode will *not* remove the
7917 indentation/paragraph settings. This can only be done by refreshing the
7919 (interactive "P")
7920 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
7921 (if (< arg 1)
7922 (orgstruct-mode -1)
7923 (orgstruct-mode 1)
7924 (let (var val)
7925 (mapc
7926 (lambda (x)
7927 (when (string-match
7929 (symbol-name (car x)))
7930 (setq var (car x) val (nth 1 x))
7931 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7932 org-local-vars)
7933 (org-set-local 'orgstruct-is-++ t))))
7935 (defvar orgstruct-is-++ nil
7936 "Is `orgstruct-mode' in ++ version in the current-buffer?")
7937 (make-variable-buffer-local 'orgstruct-is-++)
7939 ;;;###autoload
7940 (defun turn-on-orgstruct++ ()
7941 "Unconditionally turn on `orgstruct++-mode'."
7942 (orgstruct++-mode 1))
7944 (defun orgstruct-error ()
7945 "Error when there is no default binding for a structure key."
7946 (interactive)
7947 (error "This key has no function outside structure elements"))
7949 (defun orgstruct-setup ()
7950 "Setup orgstruct keymaps."
7951 (let ((nfunc 0)
7952 (bindings
7953 (list
7954 '([(meta up)] org-metaup)
7955 '([(meta down)] org-metadown)
7956 '([(meta left)] org-metaleft)
7957 '([(meta right)] org-metaright)
7958 '([(meta shift up)] org-shiftmetaup)
7959 '([(meta shift down)] org-shiftmetadown)
7960 '([(meta shift left)] org-shiftmetaleft)
7961 '([(meta shift right)] org-shiftmetaright)
7962 '([?\e (up)] org-metaup)
7963 '([?\e (down)] org-metadown)
7964 '([?\e (left)] org-metaleft)
7965 '([?\e (right)] org-metaright)
7966 '([?\e (shift up)] org-shiftmetaup)
7967 '([?\e (shift down)] org-shiftmetadown)
7968 '([?\e (shift left)] org-shiftmetaleft)
7969 '([?\e (shift right)] org-shiftmetaright)
7970 '([(shift up)] org-shiftup)
7971 '([(shift down)] org-shiftdown)
7972 '([(shift left)] org-shiftleft)
7973 '([(shift right)] org-shiftright)
7974 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7975 '("\M-q" fill-paragraph)
7976 '("\C-c^" org-sort)
7977 '("\C-c-" org-cycle-list-bullet)))
7978 elt key fun cmd)
7979 (while (setq elt (pop bindings))
7980 (setq nfunc (1+ nfunc))
7981 (setq key (org-key (car elt))
7982 fun (nth 1 elt)
7983 cmd (orgstruct-make-binding fun nfunc key))
7984 (org-defkey orgstruct-mode-map key cmd))
7986 ;; Special treatment needed for TAB and RET
7987 (org-defkey orgstruct-mode-map [(tab)]
7988 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7989 (org-defkey orgstruct-mode-map "\C-i"
7990 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7992 (org-defkey orgstruct-mode-map "\M-\C-m"
7993 (orgstruct-make-binding 'org-insert-heading 105
7994 "\M-\C-m" [(meta return)]))
7995 (org-defkey orgstruct-mode-map [(meta return)]
7996 (orgstruct-make-binding 'org-insert-heading 106
7997 [(meta return)] "\M-\C-m"))
7999 (org-defkey orgstruct-mode-map [(shift meta return)]
8000 (orgstruct-make-binding 'org-insert-todo-heading 107
8001 [(meta return)] "\M-\C-m"))
8003 (org-defkey orgstruct-mode-map "\e\C-m"
8004 (orgstruct-make-binding 'org-insert-heading 108
8005 "\e\C-m" [?\e (return)]))
8006 (org-defkey orgstruct-mode-map [?\e (return)]
8007 (orgstruct-make-binding 'org-insert-heading 109
8008 [?\e (return)] "\e\C-m"))
8009 (org-defkey orgstruct-mode-map [?\e (shift return)]
8010 (orgstruct-make-binding 'org-insert-todo-heading 110
8011 [?\e (return)] "\e\C-m"))
8013 (unless org-local-vars
8014 (setq org-local-vars (org-get-local-variables)))
8016 t))
8018 (defun orgstruct-make-binding (fun n &rest keys)
8019 "Create a function for binding in the structure minor mode.
8020 FUN is the command to call inside a table. N is used to create a unique
8021 command name. KEYS are keys that should be checked in for a command
8022 to execute outside of tables."
8023 (eval
8024 (list 'defun
8025 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8026 '(arg)
8028 "Outside of structure, run the binding of `"
8029 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8030 "'.")
8031 '(interactive "p")
8032 (list 'if
8033 `(org-context-p 'headline 'item
8034 (and orgstruct-is-++
8035 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8036 'item-body))
8037 (list 'org-run-like-in-org-mode (list 'quote fun))
8038 (list 'let '(orgstruct-mode)
8039 (list 'call-interactively
8040 (append '(or)
8041 (mapcar (lambda (k)
8042 (list 'key-binding k))
8043 keys)
8044 '('orgstruct-error))))))))
8046 (defun org-context-p (&rest contexts)
8047 "Check if local context is any of CONTEXTS.
8048 Possible values in the list of contexts are `table', `headline', and `item'."
8049 (let ((pos (point)))
8050 (goto-char (point-at-bol))
8051 (prog1 (or (and (memq 'table contexts)
8053 (and (memq 'headline contexts)
8055 (looking-at outline-regexp))
8056 (and (memq 'item contexts)
8058 (and (memq 'item-body contexts)
8059 (org-in-item-p)))
8060 (goto-char pos))))
8062 (defun org-get-local-variables ()
8063 "Return a list of all local variables in an org-mode buffer."
8064 (let (varlist)
8065 (with-current-buffer (get-buffer-create "*Org tmp*")
8066 (erase-buffer)
8067 (org-mode)
8068 (setq varlist (buffer-local-variables)))
8069 (kill-buffer "*Org tmp*")
8070 (delq nil
8071 (mapcar
8072 (lambda (x)
8073 (setq x
8074 (if (symbolp x)
8075 (list x)
8076 (list (car x) (list 'quote (cdr x)))))
8077 (if (string-match
8078 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8079 (symbol-name (car x)))
8080 x nil))
8081 varlist))))
8083 ;;;###autoload
8084 (defun org-run-like-in-org-mode (cmd)
8085 "Run a command, pretending that the current buffer is in Org-mode.
8086 This will temporarily bind local variables that are typically bound in
8087 Org-mode to the values they have in Org-mode, and then interactively
8088 call CMD."
8089 (org-load-modules-maybe)
8090 (unless org-local-vars
8091 (setq org-local-vars (org-get-local-variables)))
8092 (eval (list 'let org-local-vars
8093 (list 'call-interactively (list 'quote cmd)))))
8095 ;;;; Archiving
8097 (defun org-get-category (&optional pos)
8098 "Get the category applying to position POS."
8099 (get-text-property (or pos (point)) 'org-category))
8101 (defun org-refresh-category-properties ()
8102 "Refresh category text properties in the buffer."
8103 (let ((def-cat (cond
8104 ((null org-category)
8105 (if buffer-file-name
8106 (file-name-sans-extension
8107 (file-name-nondirectory buffer-file-name))
8108 "???"))
8109 ((symbolp org-category) (symbol-name org-category))
8110 (t org-category)))
8111 beg end cat pos optionp)
8112 (org-unmodified
8113 (save-excursion
8114 (save-restriction
8115 (widen)
8116 (goto-char (point-min))
8117 (put-text-property (point) (point-max) 'org-category def-cat)
8118 (while (re-search-forward
8120 (setq pos (match-end 0)
8121 optionp (equal (char-after (match-beginning 0)) ?#)
8122 cat (org-trim (match-string 2)))
8123 (if optionp
8124 (setq beg (point-at-bol) end (point-max))
8125 (org-back-to-heading t)
8126 (setq beg (point) end (org-end-of-subtree t t)))
8127 (put-text-property beg end 'org-category cat)
8128 (goto-char pos)))))))
8131 ;;;; Link Stuff
8133 ;;; Link abbreviations
8135 (defun org-link-expand-abbrev (link)
8136 "Apply replacements as defined in `org-link-abbrev-alist."
8138 (let* ((key (match-string 1 link))
8139 (as (or (assoc key org-link-abbrev-alist-local)
8140 (assoc key org-link-abbrev-alist)))
8141 (tag (and (match-end 2) (match-string 3 link)))
8142 rpl)
8143 (if (not as)
8144 link
8145 (setq rpl (cdr as))
8146 (cond
8147 ((symbolp rpl) (funcall rpl tag))
8148 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8149 ((string-match "%h" rpl)
8150 (replace-match (url-hexify-string (or tag "")) t t rpl))
8151 (t (concat rpl tag)))))
8152 link))
8154 ;;; Storing and inserting links
8156 (defvar org-insert-link-history nil
8157 "Minibuffer history for links inserted with `org-insert-link'.")
8159 (defvar org-stored-links nil
8160 "Contains the links stored with `org-store-link'.")
8162 (defvar org-store-link-plist nil
8163 "Plist with info about the most recently link created with `org-store-link'.")
8165 (defvar org-link-protocols nil
8166 "Link protocols added to Org-mode using `org-add-link-type'.")
8168 (defvar org-store-link-functions nil
8169 "List of functions that are called to create and store a link.
8170 Each function will be called in turn until one returns a non-nil
8171 value. Each function should check if it is responsible for creating
8172 this link (for example by looking at the major mode).
8173 If not, it must exit and return nil.
8174 If yes, it should return a non-nil value after a calling
8175 `org-store-link-props' with a list of properties and values.
8176 Special properties are:
8180 This is obligatory as well.
8181 :description Optional default description for the second pair
8182 of brackets in an Org-mode link. The user can still change
8183 this when inserting this link into an Org-mode buffer.
8185 In addition to these, any additional properties can be specified
8186 and then used in remember templates.")
8188 (defun org-add-link-type (type &optional follow export)
8189 "Add TYPE to the list of `org-link-types'.
8190 Re-compute all regular expressions depending on `org-link-types'
8192 FOLLOW and EXPORT are two functions.
8194 FOLLOW should take the link path as the single argument and do whatever
8195 is necessary to follow the link, for example find a file or display
8196 a mail message.
8198 EXPORT should format the link path for export to one of the export formats.
8199 It should be a function accepting three arguments:
8202 desc the description of the link, if any, nil if there was no description
8203 format the export format, a symbol like `html' or `latex' or `ascii'..
8205 The function may use the FORMAT information to return different values
8206 depending on the format. The return value will be put literally into
8207 the exported file. If the return value is nil, this means Org should
8208 do what it normally does with links which do not have EXPORT defined.
8210 Org-mode has a built-in default for exporting links. If you are happy with
8211 this default, there is no need to define an export function for the link
8212 type. For a simple example of an export function, see `org-bbdb.el'."
8213 (add-to-list 'org-link-types type t)
8214 (org-make-link-regexps)
8215 (if (assoc type org-link-protocols)
8216 (setcdr (assoc type org-link-protocols) (list follow export))
8217 (push (list type follow export) org-link-protocols)))
8219 (defvar org-agenda-buffer-name)
8221 ;;;###autoload
8222 (defun org-store-link (arg)
8224 This link is added to `org-stored-links' and can later be inserted
8227 For some link types, a prefix arg is interpreted:
8228 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8229 For file links, arg negates `org-context-in-file-links'."
8230 (interactive "P")
8231 (org-load-modules-maybe)
8232 (setq org-store-link-plist nil) ; reset
8233 (let ((outline-regexp (org-get-limited-outline-regexp))
8234 link cpltxt desc description search txt custom-id agenda-link)
8235 (cond
8237 ((run-hook-with-args-until-success 'org-store-link-functions)
8238 (setq link (plist-get org-store-link-plist :link)
8239 desc (or (plist-get org-store-link-plist :description) link)))
8241 ((equal (buffer-name) "*Org Edit Src Example*")
8242 (let (label gc)
8243 (while (or (not label)
8244 (save-excursion
8245 (save-restriction
8246 (widen)
8247 (goto-char (point-min))
8248 (re-search-forward
8249 (regexp-quote (format org-coderef-label-format label))
8250 nil t))))
8251 (when label (message "Label exists already") (sit-for 2))
8252 (setq label (read-string "Code line label: " label)))
8253 (end-of-line 1)
8254 (setq link (format org-coderef-label-format label))
8255 (setq gc (- 79 (length link)))
8256 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8257 (insert link)
8258 (setq link (concat "(" label ")") desc nil)))
8260 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8261 ;; We are in the agenda, link to referenced location
8262 (let ((m (or (get-text-property (point) 'org-hd-marker)
8263 (get-text-property (point) 'org-marker))))
8264 (when m
8265 (org-with-point-at m
8266 (setq agenda-link
8267 (if (interactive-p)
8268 (call-interactively 'org-store-link)
8269 (org-store-link nil)))))))
8271 ((eq major-mode 'calendar-mode)
8272 (let ((cd (calendar-cursor-to-date)))
8273 (setq link
8274 (format-time-string
8275 (car org-time-stamp-formats)
8276 (apply 'encode-time
8277 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8278 nil nil nil))))
8279 (org-store-link-props :type "calendar" :date cd)))
8281 ((eq major-mode 'w3-mode)
8282 (setq cpltxt (if (and (buffer-name)
8283 (not (string-match "Untitled" (buffer-name))))
8284 (buffer-name)
8285 (url-view-url t))
8286 link (org-make-link (url-view-url t)))
8287 (org-store-link-props :type "w3" :url (url-view-url t)))
8289 ((eq major-mode 'w3m-mode)
8290 (setq cpltxt (or w3m-current-title w3m-current-url)
8291 link (org-make-link w3m-current-url))
8292 (org-store-link-props :type "w3m" :url (url-view-url t)))
8294 ((setq search (run-hook-with-args-until-success
8295 'org-create-file-search-functions))
8296 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8297 "::" search))
8298 (setq cpltxt (or description link)))
8300 ((eq major-mode 'image-mode)
8301 (setq cpltxt (concat "file:"
8302 (abbreviate-file-name buffer-file-name))
8303 link (org-make-link cpltxt))
8304 (org-store-link-props :type "image" :file buffer-file-name))
8306 ((eq major-mode 'dired-mode)
8307 ;; link to the file in the current line
8308 (let ((file (dired-get-filename nil t)))
8309 (setq file (if file
8310 (abbreviate-file-name
8311 (expand-file-name (dired-get-filename nil t)))
8312 ;; otherwise, no file so use current directory.
8313 default-directory))
8314 (setq cpltxt (concat "file:" file)
8315 link (org-make-link cpltxt))))
8317 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8318 (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
8319 (cond
8321 (setq cpltxt
8322 (concat "file:"
8323 (abbreviate-file-name
8324 (buffer-file-name (buffer-base-buffer)))
8325 "::" (match-string 1))
8326 link (org-make-link cpltxt)))
8327 ((and (featurep 'org-id)
8328 (or (eq org-link-to-org-use-id t)
8329 (and (eq org-link-to-org-use-id 'create-if-interactive)
8330 (interactive-p))
8331 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
8332 (interactive-p)
8333 (not custom-id))
8334 (and org-link-to-org-use-id
8335 (condition-case nil
8336 (org-entry-get nil "ID")
8337 (error nil)))))
8338 ;; We can make a link using the ID.
8339 (setq link (condition-case nil
8340 (prog1 (org-id-store-link)
8341 (setq desc (plist-get org-store-link-plist
8342 :description)))
8343 (error
8344 ;; probably before first headline, link to file only
8345 (concat "file:"
8346 (abbreviate-file-name
8347 (buffer-file-name (buffer-base-buffer))))))))
8348 (t
8349 ;; Just link to current headline
8350 (setq cpltxt (concat "file:"
8351 (abbreviate-file-name
8352 (buffer-file-name (buffer-base-buffer)))))
8353 ;; Add a context search string
8354 (when (org-xor org-context-in-file-links arg)
8355 (setq txt (cond
8356 ((org-on-heading-p) nil)
8357 ((org-region-active-p)
8358 (buffer-substring (region-beginning) (region-end)))
8359 (t nil)))
8361 (setq cpltxt
8362 (concat cpltxt "::"
8363 (condition-case nil
8364 (org-make-org-heading-search-string txt)
8365 (error "")))
8366 desc (or (nth 4 (ignore-errors
8367 (org-heading-components))) "NONE"))))
8369 (setq cpltxt (substring cpltxt 0 -2)))
8370 (setq link (org-make-link cpltxt)))))
8372 ((buffer-file-name (buffer-base-buffer))
8373 ;; Just link to this file here.
8374 (setq cpltxt (concat "file:"
8375 (abbreviate-file-name
8376 (buffer-file-name (buffer-base-buffer)))))
8377 ;; Add a context string
8378 (when (org-xor org-context-in-file-links arg)
8379 (setq txt (if (org-region-active-p)
8380 (buffer-substring (region-beginning) (region-end))
8381 (buffer-substring (point-at-bol) (point-at-eol))))
8382 ;; Only use search option if there is some text.
8384 (setq cpltxt
8385 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8386 desc "NONE")))
8387 (setq link (org-make-link cpltxt)))
8389 ((interactive-p)
8390 (error "Cannot link to a buffer which is not visiting a file"))
8392 (t (setq link nil)))
8394 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8395 (setq link (or link cpltxt)
8396 desc (or desc cpltxt))
8397 (if (equal desc "NONE") (setq desc nil))
8399 (if (and (or (interactive-p) executing-kbd-macro) link)
8400 (progn
8401 (setq org-stored-links
8402 (cons (list link desc) org-stored-links))
8403 (message "Stored: %s" (or desc link))
8404 (when custom-id
8405 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8406 "::#" custom-id))
8407 (setq org-stored-links
8408 (cons (list link desc) org-stored-links))))
8409 (or agenda-link (and link (org-make-link-string link desc))))))
8411 (defun org-store-link-props (&rest plist)
8412 "Store link properties, extract names and addresses."
8413 (let (x adr)
8414 (when (setq x (plist-get plist :from))
8415 (setq adr (mail-extract-address-components x))
8416 (setq plist (plist-put plist :fromname (car adr)))
8417 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8418 (when (setq x (plist-get plist :to))
8419 (setq adr (mail-extract-address-components x))
8420 (setq plist (plist-put plist :toname (car adr)))
8421 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8422 (let ((from (plist-get plist :from))
8423 (to (plist-get plist :to)))
8424 (when (and from to org-from-is-user-regexp)
8425 (setq plist
8426 (plist-put plist :fromto
8427 (if (string-match org-from-is-user-regexp from)
8428 (concat "to %t")
8429 (concat "from %f"))))))
8430 (setq org-store-link-plist plist))
8432 (defun org-add-link-props (&rest plist)
8433 "Add these properties to the link property list."
8434 (let (key value)
8435 (while plist
8436 (setq key (pop plist) value (pop plist))
8437 (setq org-store-link-plist
8438 (plist-put org-store-link-plist key value)))))
8440 (defun org-email-link-description (&optional fmt)
8441 "Return the description part of an email link.
8442 This takes information from `org-store-link-plist' and formats it
8443 according to FMT (default from `org-email-link-description-format')."
8444 (setq fmt (or fmt org-email-link-description-format))
8445 (let* ((p org-store-link-plist)
8446 (to (plist-get p :toaddress))
8447 (from (plist-get p :fromaddress))
8448 (table
8449 (list
8450 (cons "%c" (plist-get p :fromto))
8451 (cons "%F" (plist-get p :from))
8452 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8453 (cons "%T" (plist-get p :to))
8454 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8455 (cons "%s" (plist-get p :subject))
8456 (cons "%m" (plist-get p :message-id)))))
8457 (when (string-match "%c" fmt)
8458 ;; Check if the user wrote this message
8459 (if (and org-from-is-user-regexp from to
8460 (save-match-data (string-match org-from-is-user-regexp from)))
8461 (setq fmt (replace-match "to %t" t t fmt))
8462 (setq fmt (replace-match "from %f" t t fmt))))
8463 (org-replace-escapes fmt table)))
8465 (defun org-make-org-heading-search-string (&optional string heading)
8466 "Make search string for STRING or current headline."
8467 (interactive)
8468 (let ((s (or string (org-get-heading))))
8469 (unless (and string (not heading))
8470 ;; We are using a headline, clean up garbage in there.
8471 (if (string-match org-todo-regexp s)
8472 (setq s (replace-match "" t t s)))
8474 (setq s (replace-match "" t t s)))
8475 (setq s (org-trim s))
8478 (setq s (replace-match "" t t s)))
8479 (while (string-match org-ts-regexp s)
8480 (setq s (replace-match "" t t s))))
8481 (or string (setq s (concat "*" s))) ; Add * for headlines
8484 (defun org-make-link (&rest strings)
8485 "Concatenate STRINGS."
8486 (apply 'concat strings))
8488 (defun org-make-link-string (link &optional description)
8489 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8491 (error "Empty link"))
8492 (when (and description
8493 (stringp description)
8495 (setq description nil))
8496 (when (stringp description)
8497 ;; Remove brackets from the description, they are fatal.
8499 (setq description (replace-match "{" t t description)))
8501 (setq description (replace-match "}" t t description))))
8502 (when (equal (org-link-escape link) description)
8503 ;; No description needed, it is identical
8504 (setq description nil))
8505 (when (and (not description)
8506 (not (equal link (org-link-escape link))))
8507 (setq description (org-extract-attributes link)))
8508 (setq link (if (string-match org-link-types-re link)
8509 (concat (match-string 1 link)
8510 (org-link-escape (substring link (match-end 1))))
8511 (org-link-escape link)))
8512 (concat "[[" link "]"
8513 (if description (concat "[" description "]") "")
8514 "]"))
8516 (defconst org-link-escape-chars
8517 '((?\ . "%20")
8518 (?\[ . "%5B")
8519 (?\] . "%5D")
8530 (?\; . "%3B")
8531 ;; (?? . "%3F")
8532 (?= . "%3D")
8533 (?+ . "%2B")
8534 )
8535 "Association list of escapes for some characters problematic in links.
8536 This is the list that is used for internal purposes.")
8538 (defvar org-url-encoding-use-url-hexify nil)
8540 (defconst org-link-escape-chars-browser
8541 '((?\ . "%20")) ; 32 for the SPC char
8542 "Association list of escapes for some characters problematic in links.
8543 This is the list that is used before handing over to the browser.")
8545 (defun org-link-escape (text &optional table)
8546 "Escape characters in TEXT that are problematic for links."
8547 (if (and org-url-encoding-use-url-hexify (not table))
8548 (url-hexify-string text)
8549 (setq table (or table org-link-escape-chars))
8550 (when text
8551 (let ((re (mapconcat (lambda (x) (regexp-quote
8552 (char-to-string (car x))))
8554 (while (string-match re text)
8555 (setq text
8556 (replace-match
8557 (cdr (assoc (string-to-char (match-string 0 text))
8558 table))
8559 t t text)))
8560 text))))
8562 (defun org-link-unescape (text &optional table)
8563 "Reverse the action of `org-link-escape'."
8564 (if (and org-url-encoding-use-url-hexify (not table))
8565 (url-unhex-string text)
8566 (setq table (or table org-link-escape-chars))
8567 (when text
8568 (let ((case-fold-search t)
8569 (re (mapconcat (lambda (x) (regexp-quote (downcase (cdr x))))
8571 (while (string-match re text)
8572 (setq text
8573 (replace-match
8574 (char-to-string (car (rassoc (upcase (match-string 0 text))
8575 table)))
8576 t t text)))
8577 text))))
8579 (defun org-xor (a b)
8580 "Exclusive or."
8581 (if a (not b) b))
8583 (defun org-fixup-message-id-for-http (s)
8584 "Replace special characters in a message id, so it can be used in an http query."
8585 (when (string-match "%" s)
8586 (setq s (mapconcat (lambda (c)
8587 (if (eq c ?%)
8588 "%25"
8589 (char-to-string c)))
8590 s "")))
8591 (while (string-match "<" s)
8592 (setq s (replace-match "%3C" t t s)))
8593 (while (string-match ">" s)
8594 (setq s (replace-match "%3E" t t s)))
8595 (while (string-match "@" s)
8596 (setq s (replace-match "%40" t t s)))
8597 s)
8599 ;;;###autoload
8600 (defun org-insert-link-global ()
8601 "Insert a link like Org-mode does.
8602 This command can be called in any mode to insert a link in Org-mode syntax."
8603 (interactive)
8604 (org-load-modules-maybe)
8605 (org-run-like-in-org-mode 'org-insert-link))
8607 (defun org-insert-link (&optional complete-file link-location)
8608 "Insert a link. At the prompt, enter the link.
8610 Completion can be used to insert any of the link protocol prefixes like
8611 http or ftp in use.
8613 The history can be used to select a link previously stored with
8614 `org-store-link'. When the empty string is entered (i.e. if you just
8615 press RET at the prompt), the link defaults to the most recently
8616 stored link. As SPC triggers completion in the minibuffer, you need to
8617 use M-SPC or C-q SPC to force the insertion of a space character.
8619 You will also be prompted for a description, and if one is given, it will
8620 be displayed in the buffer instead of the link.
8622 If there is already a link at point, this command will allow you to edit link
8623 and description parts.
8626 be selected using completion. The path to the file will be relative to the
8627 current directory if the file is in the current directory or a subdirectory.
8628 Otherwise, the link will be the absolute path as completed in the minibuffer
8629 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8630 option `org-link-file-path-type'.
8633 the current directory or below.
8636 `org-keep-stored-link-after-insertion'.
8638 If `org-make-link-description-function' is non-nil, this function will be
8639 called with the link target, and the result will be the default
8640 link description.
8642 If the LINK-LOCATION parameter is non-nil, this value will be
8643 used as the link location instead of reading one interactively."
8644 (interactive "P")
8645 (let* ((wcf (current-window-configuration))
8646 (region (if (org-region-active-p)
8647 (buffer-substring (region-beginning) (region-end))))
8648 (remove (and region (list (region-beginning) (region-end))))
8649 (desc region)
8650 tmphist ; byte-compile incorrectly complains about this
8651 (link link-location)
8652 entry file all-prefixes)
8653 (cond
8654 (link-location) ; specified by arg, just use it.
8655 ((org-in-regexp org-bracket-link-regexp 1)
8656 ;; We do have a link at point, and we are going to edit it.
8657 (setq remove (list (match-beginning 0) (match-end 0)))
8658 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8659 (setq link (read-string "Link: "
8660 (org-link-unescape
8661 (org-match-string-no-properties 1)))))
8662 ((or (org-in-regexp org-angle-link-re)
8663 (org-in-regexp org-plain-link-re))
8664 ;; Convert to bracket link
8665 (setq remove (list (match-beginning 0) (match-end 0))
8666 link (read-string "Link: "
8667 (org-remove-angle-brackets (match-string 0)))))
8668 ((member complete-file '((4) (16)))
8669 ;; Completing read for file names.
8670 (setq link (org-file-complete-link complete-file)))
8671 (t
8672 ;; Read link, with completion for stored links.
8673 (with-output-to-temp-buffer "*Org Links*"
8674 (princ "Insert a link.
8676 (when org-stored-links
8678 (princ (mapconcat
8679 (lambda (x)
8680 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8682 (let ((cw (selected-window)))
8683 (select-window (get-buffer-window "*Org Links*" 'visible))
8684 (setq truncate-lines t)
8685 (unless (pos-visible-in-window-p (point-max))
8686 (org-fit-window-to-buffer))
8687 (and (window-live-p cw) (select-window cw)))
8688 ;; Fake a link history, containing the stored links.
8689 (setq tmphist (append (mapcar 'car org-stored-links)
8690 org-insert-link-history))
8691 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8692 (mapcar 'car org-link-abbrev-alist)
8693 org-link-types))
8694 (unwind-protect
8695 (progn
8696 (setq link
8697 (let ((org-completion-use-ido nil)
8698 (org-completion-use-iswitchb nil))
8699 (org-completing-read
8700 "Link: "
8701 (append
8702 (mapcar (lambda (x) (list (concat x ":")))
8703 all-prefixes)
8704 (mapcar 'car org-stored-links))
8705 nil nil nil
8706 'tmphist
8707 (car (car org-stored-links)))))
8709 (error "No link selected"))
8710 (if (or (member link all-prefixes)
8711 (and (equal ":" (substring link -1))
8712 (member (substring link 0 -1) all-prefixes)
8713 (setq link (substring link 0 -1))))
8714 (setq link (org-link-try-special-completion link))))
8715 (set-window-configuration wcf)
8716 (kill-buffer "*Org Links*"))
8717 (setq entry (assoc link org-stored-links))
8718 (or entry (push link org-insert-link-history))
8719 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8720 (not org-keep-stored-link-after-insertion))
8721 (setq org-stored-links (delq (assoc link org-stored-links)
8722 org-stored-links)))
8723 (setq desc (or desc (nth 1 entry)))))
8725 (if (string-match org-plain-link-re link)
8726 ;; URL-like link, normalize the use of angular brackets.
8727 (setq link (org-make-link (org-remove-angle-brackets link))))
8729 ;; Check if we are linking to the current file with a search option
8730 ;; If yes, simplify the link by using only the search option.
8731 (when (and buffer-file-name
8733 (let* ((path (match-string 1 link))
8734 (case-fold-search nil)
8735 (search (match-string 2 link)))
8736 (save-match-data
8737 (if (equal (file-truename buffer-file-name) (file-truename path))
8738 ;; We are linking to this same file, with a search option
8739 (setq link search)))))
8741 ;; Check if we can/should use a relative path. If yes, simplify the link
8743 (let* ((type (match-string 1 link))
8744 (path (match-string 2 link))
8745 (origpath path)
8746 (case-fold-search nil))
8747 (cond
8748 ((or (eq org-link-file-path-type 'absolute)
8749 (equal complete-file '(16)))
8750 (setq path (abbreviate-file-name (expand-file-name path))))
8751 ((eq org-link-file-path-type 'noabbrev)
8752 (setq path (expand-file-name path)))
8753 ((eq org-link-file-path-type 'relative)
8754 (setq path (file-relative-name path)))
8755 (t
8756 (save-match-data
8757 (if (string-match (concat "^" (regexp-quote
8758 (expand-file-name
8759 (file-name-as-directory
8760 default-directory))))
8761 (expand-file-name path))
8762 ;; We are linking a file with relative path name.
8763 (setq path (substring (expand-file-name path)
8764 (match-end 0)))
8765 (setq path (abbreviate-file-name (expand-file-name path)))))))
8766 (setq link (concat type path))
8767 (if (equal desc origpath)
8768 (setq desc path))))
8770 (if org-make-link-description-function
8771 (setq desc (funcall org-make-link-description-function link desc)))
8773 (setq desc (read-string "Description: " desc))
8775 (if remove (apply 'delete-region remove))
8776 (insert (org-make-link-string link desc))))
8778 (defun org-link-try-special-completion (type)
8779 "If there is completion support for link type TYPE, offer it."
8780 (let ((fun (intern (concat "org-" type "-complete-link"))))
8781 (if (functionp fun)
8782 (funcall fun)
8783 (read-string "Link (no completion support): " (concat type ":")))))
8785 (defun org-file-complete-link (&optional arg)
8786 "Create a file link using completion."
8787 (let (file link)
8788 (setq file (read-file-name "File: "))
8789 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8790 (pwd1 (file-name-as-directory (abbreviate-file-name
8791 (expand-file-name ".")))))
8792 (cond
8793 ((equal arg '(16))
8794 (setq link (org-make-link
8795 "file:"
8796 (abbreviate-file-name (expand-file-name file)))))
8798 (setq link (org-make-link "file:" (match-string 1 file))))
8800 (expand-file-name file))
8801 (setq link (org-make-link
8802 "file:" (match-string 1 (expand-file-name file)))))
8803 (t (setq link (org-make-link "file:" file)))))
8804 link))
8806 (defun org-completing-read (&rest args)
8807 "Completing-read with SPACE being a normal character."
8808 (let ((minibuffer-local-completion-map
8809 (copy-keymap minibuffer-local-completion-map)))
8810 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
8811 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
8812 (apply 'org-icompleting-read args)))
8814 (defun org-completing-read-no-i (&rest args)
8815 (let (org-completion-use-ido org-completion-use-iswitchb)
8816 (apply 'org-completing-read args)))
8818 (defun org-iswitchb-completing-read (prompt choices &rest args)
8819 "Use iswitch as a completing-read replacement to choose from choices.
8820 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
8821 from."
8822 (let* ((iswitchb-use-virtual-buffers nil)
8823 (iswitchb-make-buflist-hook
8824 (lambda ()
8825 (setq iswitchb-temp-buflist choices))))
8826 (iswitchb-read-buffer prompt)))
8828 (defun org-icompleting-read (&rest args)
8829 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
8830 (org-without-partial-completion
8831 (if (and org-completion-use-ido
8832 (fboundp 'ido-completing-read)
8833 (boundp 'ido-mode) ido-mode
8834 (listp (second args)))
8835 (let ((ido-enter-matching-directory nil))
8836 (apply 'ido-completing-read (concat (car args))
8837 (if (consp (car (nth 1 args)))
8838 (mapcar (lambda (x) (car x)) (nth 1 args))
8839 (nth 1 args))
8840 (cddr args)))
8841 (if (and org-completion-use-iswitchb
8842 (boundp 'iswitchb-mode) iswitchb-mode
8843 (listp (second args)))
8844 (apply 'org-iswitchb-completing-read (concat (car args))
8845 (if (consp (car (nth 1 args)))
8846 (mapcar (lambda (x) (car x)) (nth 1 args))
8847 (nth 1 args))
8848 (cddr args))
8849 (apply 'completing-read args)))))
8851 (defun org-extract-attributes (s)
8852 "Extract the attributes cookie from a string and set as text property."
8853 (let (a attr (start 0) key value)
8854 (save-match-data
8856 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
8858 (setq key (match-string 1 a) value (match-string 2 a)
8859 start (match-end 0)
8860 attr (plist-put attr (intern key) value))))
8861 (org-add-props s nil 'org-attr attr))
8862 s))
8864 (defun org-extract-attributes-from-string (tag)
8865 (let (key value attr)
8867 (setq key (match-string 1 tag) value (match-string 2 tag)
8868 tag (replace-match "" t t tag)
8869 attr (plist-put attr (intern key) value)))
8870 (cons tag attr)))
8872 (defun org-attributes-to-string (plist)
8873 "Format a property list into an HTML attribute list."
8874 (let ((s "") key value)
8875 (while plist
8876 (setq key (pop plist) value (pop plist))
8877 (and value
8879 s))
8881 ;;; Opening/following a link
8883 (defvar org-link-search-failed nil)
8885 (defvar org-open-link-functions nil
8886 "Hook for functions finding a plain text link.
8887 These functions must take a single argument, the link content.
8888 They will be called for links that look like [[link text][description]]
8892 These functions will be called *before* Org attempts to resolve the
8893 link by doing text searches in the current buffer - so if you want a
8895 handle this as a special case.
8897 When the function does handle the link, it must return a non-nil value.
8898 If it decides that it is not responsible for this link, it must return
8899 nil to indicate that that Org-mode can continue with other options
8900 like exact and fuzzy text search.")
8902 (defun org-next-link ()
8903 "Move forward to the next link.
8904 If the link is in hidden text, expose it."
8905 (interactive)
8906 (when (and org-link-search-failed (eq this-command last-command))
8907 (goto-char (point-min))
8908 (message "Link search wrapped back to beginning of buffer"))
8909 (setq org-link-search-failed nil)
8910 (let* ((pos (point))
8911 (ct (org-context))
8912 (a (assoc :link ct)))
8913 (if a (goto-char (nth 2 a)))
8914 (if (re-search-forward org-any-link-re nil t)
8915 (progn
8916 (goto-char (match-beginning 0))
8917 (if (org-invisible-p) (org-show-context)))
8918 (goto-char pos)
8919 (setq org-link-search-failed t)
8920 (error "No further link found"))))
8922 (defun org-previous-link ()
8923 "Move backward to the previous link.
8924 If the link is in hidden text, expose it."
8925 (interactive)
8926 (when (and org-link-search-failed (eq this-command last-command))
8927 (goto-char (point-max))
8928 (message "Link search wrapped back to end of buffer"))
8929 (setq org-link-search-failed nil)
8930 (let* ((pos (point))
8931 (ct (org-context))
8932 (a (assoc :link ct)))
8933 (if a (goto-char (nth 1 a)))
8934 (if (re-search-backward org-any-link-re nil t)
8935 (progn
8936 (goto-char (match-beginning 0))
8937 (if (org-invisible-p) (org-show-context)))
8938 (goto-char pos)
8939 (setq org-link-search-failed t)
8940 (error "No further link found"))))
8942 (defun org-translate-link (s)
8943 "Translate a link string if a translation function has been defined."
8944 (if (and org-link-translation-function
8945 (fboundp org-link-translation-function)
8947 (progn
8948 (setq s (funcall org-link-translation-function
8949 (match-string 1) (match-string 2)))
8950 (concat (car s) ":" (cdr s)))
8951 s))
8953 (defun org-translate-link-from-planner (type path)
8954 "Translate a link from Emacs Planner syntax so that Org can follow it.
8955 This is still an experimental function, your mileage may vary."
8956 (cond
8957 ((member type '("http" "https" "news" "ftp"))
8958 ;; standard Internet links are the same.
8959 nil)
8960 ((and (equal type "irc") (string-match "^//" path))
8961 ;; Planner has two / at the beginning of an irc link, we have 1.
8962 ;; We should have zero, actually....
8963 (setq path (substring path 1)))
8964 ((and (equal type "lisp") (string-match "^/" path))
8965 ;; Planner has a slash, we do not.
8966 (setq type "elisp" path (substring path 1)))
8968 ;; A typical message link. Planner has the id after the final slash,
8969 ;; we separate it with a hash mark
8970 (setq path (concat (match-string 1 path) "#"
8971 (org-remove-angle-brackets (match-string 2 path)))))
8972 )
8973 (cons type path))
8975 (defun org-find-file-at-mouse (ev)
8976 "Open file link or URL at mouse."
8977 (interactive "e")
8978 (mouse-set-point ev)
8979 (org-open-at-point 'in-emacs))
8981 (defun org-open-at-mouse (ev)
8982 "Open file link or URL at mouse."
8983 (interactive "e")
8984 (mouse-set-point ev)
8985 (if (eq major-mode 'org-agenda-mode)
8986 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
8987 (org-open-at-point))
8989 (defvar org-window-config-before-follow-link nil
8990 "The window configuration before following a link.
8991 This is saved in case the need arises to restore it.")
8993 (defvar org-open-link-marker (make-marker)
8994 "Marker pointing to the location where `org-open-at-point; was called.")
8996 ;;;###autoload
8997 (defun org-open-at-point-global ()
8998 "Follow a link like Org-mode does.
8999 This command can be called in any mode to follow a link that has
9000 Org-mode syntax."
9001 (interactive)
9002 (org-run-like-in-org-mode 'org-open-at-point))
9004 ;;;###autoload
9005 (defun org-open-link-from-string (s &optional arg reference-buffer)
9006 "Open a link in the string S, as if it was in Org-mode."
9008 (let ((reference-buffer (or reference-buffer (current-buffer))))
9009 (with-temp-buffer
9010 (let ((org-inhibit-startup t))
9011 (org-mode)
9012 (insert s)
9013 (goto-char (point-min))
9014 (when reference-buffer
9015 (setq org-link-abbrev-alist-local
9016 (with-current-buffer reference-buffer
9017 org-link-abbrev-alist-local)))
9018 (org-open-at-point arg reference-buffer)))))
9020 (defvar org-open-at-point-functions nil
9021 "Hook that is run when following a link at point.
9023 Functions in this hook must return t if they identify and follow
9024 a link at point. If they don't find anything interesting at point,
9025 they must return nil.")
9027 (defun org-open-at-point (&optional in-emacs reference-buffer)
9028 "Open link at or after point.
9029 If there is no link at point, this function will search forward up to
9030 the end of the current line.
9031 Normally, files will be opened by an appropriate application. If the
9032 optional argument IN-EMACS is non-nil, Emacs will visit the file.
9033 With a double prefix argument, try to open outside of Emacs, in the
9034 application the system uses for this file type."
9035 (interactive "P")
9036 ;; if in a code block, then open the block's results
9037 (unless (call-interactively #'org-babel-open-src-block-result)
9038 (org-load-modules-maybe)
9039 (move-marker org-open-link-marker (point))
9040 (setq org-window-config-before-follow-link (current-window-configuration))
9041 (org-remove-occur-highlights nil nil t)
9042 (cond
9043 ((and (org-on-heading-p)
9044 (not (org-in-regexp
9049 (not (get-text-property (point) 'org-linked-text)))
9050 (or (org-offer-links-in-entry in-emacs)
9051 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9052 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9053 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9054 ((or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9055 (org-footnote-action))
9056 (t
9057 (let (type path link line search (pos (point)))
9058 (catch 'match
9059 (save-excursion
9061 (when (org-in-regexp org-bracket-link-regexp 1)
9062 (setq link (org-extract-attributes
9063 (org-link-unescape (org-match-string-no-properties 1))))
9065 (setq link (replace-match " " t t link)))
9066 (setq link (org-link-expand-abbrev link))
9067 (cond
9068 ((or (file-name-absolute-p link)
9070 (setq type "file" path link))
9071 ((string-match org-link-re-with-space3 link)
9072 (setq type (match-string 1 link) path (match-string 2 link)))
9073 (t (setq type "thisfile" path link)))
9074 (throw 'match t)))
9076 (when (get-text-property (point) 'org-linked-text)
9077 (setq type "thisfile"
9078 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9079 (1+ (point)) (point))
9080 path (buffer-substring
9081 (previous-single-property-change pos 'org-linked-text)
9082 (next-single-property-change pos 'org-linked-text)))
9083 (throw 'match t))
9085 (save-excursion
9086 (when (or (org-in-regexp org-angle-link-re)
9087 (org-in-regexp org-plain-link-re))
9088 (setq type (match-string 1) path (match-string 2))
9089 (throw 'match t)))
9090 (save-excursion
9092 (setq type "tags"
9093 path (match-string 1))
9094 (while (string-match ":" path)
9095 (setq path (replace-match "+" t t path)))
9096 (throw 'match t)))
9098 (setq type "tree-match"
9099 path (match-string 1))
9100 (throw 'match t)))
9101 (unless path
9102 (error "No link found"))
9104 ;; switch back to reference buffer
9105 ;; needed when if called in a temporary buffer through
9106 ;; org-open-link-from-string
9107 (with-current-buffer (or reference-buffer (current-buffer))
9109 ;; Remove any trailing spaces in path
9111 (setq path (replace-match "" t t path)))
9112 (if (and org-link-translation-function
9113 (fboundp org-link-translation-function))
9114 ;; Check if we need to translate the link
9115 (let ((tmp (funcall org-link-translation-function type path)))
9116 (setq type (car tmp) path (cdr tmp))))
9118 (cond
9120 ((assoc type org-link-protocols)
9121 (funcall (nth 1 (assoc type org-link-protocols)) path))
9123 ((equal type "mailto")
9124 (let ((cmd (car org-link-mailto-program))
9125 (args (cdr org-link-mailto-program)) args1
9126 (address path) (subject "") a)
9128 (setq address (match-string 1 path)
9129 subject (org-link-escape (match-string 2 path))))
9130 (while args
9131 (cond
9132 ((not (stringp (car args))) (push (pop args) args1))
9133 (t (setq a (pop args))
9134 (if (string-match "%a" a)
9135 (setq a (replace-match address t t a)))
9136 (if (string-match "%s" a)
9137 (setq a (replace-match subject t t a)))
9138 (push a args1))))
9139 (apply cmd (nreverse args1))))
9141 ((member type '("http" "https" "ftp" "news"))
9142 (browse-url (concat type ":" (org-link-escape
9143 path org-link-escape-chars-browser))))
9145 ((string= type "doi")
9146 (browse-url (concat "http://dx.doi.org/"
9147 (org-link-escape
9148 path org-link-escape-chars-browser))))
9150 ((member type '("message"))
9151 (browse-url (concat type ":" path)))
9153 ((string= type "tags")
9154 (org-tags-view in-emacs path))
9156 ((string= type "tree-match")
9159 ((string= type "file")
9161 (setq line (string-to-number (match-string 1 path))
9162 path (substring path 0 (match-beginning 0)))
9164 (setq search (match-string 1 path)
9165 path (substring path 0 (match-beginning 0)))))
9166 (if (string-match "[*?{]" (file-name-nondirectory path))
9167 (dired path)
9168 (org-open-file path in-emacs line search)))
9170 ((string= type "news")
9171 (require 'org-gnus)
9172 (org-gnus-follow-link path))
9174 ((string= type "shell")
9175 (let ((cmd path))
9176 (if (or (not org-confirm-shell-link-function)
9177 (funcall org-confirm-shell-link-function
9179 (org-add-props cmd nil
9180 'face 'org-warning))))
9181 (progn
9182 (message "Executing %s" cmd)
9183 (shell-command cmd))
9184 (error "Abort"))))
9186 ((string= type "elisp")
9187 (let ((cmd path))
9188 (if (or (not org-confirm-elisp-link-function)
9189 (funcall org-confirm-elisp-link-function
9191 (org-add-props cmd nil
9192 'face 'org-warning))))
9193 (message "%s => %s" cmd
9194 (if (equal (string-to-char cmd) ?\()
9195 (eval (read cmd))
9196 (call-interactively (read cmd))))
9197 (error "Abort"))))
9199 ((and (string= type "thisfile")
9200 (run-hook-with-args-until-success
9201 'org-open-link-functions path)))
9203 ((string= type "thisfile")
9204 (if in-emacs
9205 (switch-to-buffer-other-window
9206 (org-get-buffer-for-internal-link (current-buffer)))
9207 (org-mark-ring-push))
9208 (let ((cmd `(org-link-search
9209 ,path
9210 ,(cond ((equal in-emacs '(4)) 'occur)
9211 ((equal in-emacs '(16)) 'org-occur)
9212 (t nil))
9213 ,pos)))
9214 (condition-case nil (eval cmd)
9215 (error (progn (widen) (eval cmd))))))
9217 (t
9218 (browse-url-at-point)))))))
9219 (move-marker org-open-link-marker nil)
9220 (run-hook-with-args 'org-follow-link-hook)))
9222 (defun org-offer-links-in-entry (&optional nth zero)
9223 "Offer links in the current entry and follow the selected link.
9224 If there is only one link, follow it immediately as well.
9225 If NTH is an integer, immediately pick the NTH link found.
9226 If ZERO is a string, check also this string for a link, and if
9227 there is one, offer it as link number zero."
9231 (cnt ?0)
9232 (in-emacs (if (integerp nth) nil nth))
9233 have-zero end links link c)
9234 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9235 (push (match-string 0 zero) links)
9236 (setq cnt (1- cnt) have-zero t))
9237 (save-excursion
9238 (org-back-to-heading t)
9239 (setq end (save-excursion (outline-next-heading) (point)))
9240 (while (re-search-forward re end t)
9241 (push (match-string 0) links))
9242 (setq links (org-uniquify (reverse links))))
9244 (cond
9245 ((null links)
9246 (message "No links"))
9247 ((equal (length links) 1)
9248 (setq link (list (car links))))
9249 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9250 (setq link (nth (if have-zero nth (1- nth)) links)))
9251 (t ; we have to select a link
9252 (save-excursion
9253 (save-window-excursion
9254 (delete-other-windows)
9255 (with-output-to-temp-buffer "*Select Link*"
9256 (mapc (lambda (l)
9257 (if (not (string-match org-bracket-link-regexp l))
9259 (org-remove-angle-brackets l)))
9260 (if (match-end 3)
9262 (match-string 3 l) (match-string 1 l)))
9264 (match-string 1 l))))))
9265 links))
9266 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9267 (message "Select link to open, RET to open all:")
9268 (setq c (read-char-exclusive))
9269 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9270 (when (equal c ?q) (error "Abort"))
9271 (if (equal c ?\C-m)
9272 (setq link links)
9273 (setq nth (- c ?0))
9274 (if have-zero (setq nth (1+ nth)))
9275 (unless (and (integerp nth) (>= (length links) nth))
9276 (error "Invalid link selection"))
9277 (setq link (list (nth (1- nth) links))))))
9278 (if link
9279 (let ((buf (current-buffer)))
9280 (dolist (l link)
9281 (org-open-link-from-string l in-emacs buf))
9282 t)
9283 nil)))
9285 ;; Add special file links that specify the way of opening
9287 (org-add-link-type "file+sys" 'org-open-file-with-system)
9288 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9289 (defun org-open-file-with-system (path)
9290 "Open file at PATH using the system way of opening it."
9291 (org-open-file path 'system))
9292 (defun org-open-file-with-emacs (path)
9293 "Open file at PATH in Emacs."
9294 (org-open-file path 'emacs))
9295 (defun org-remove-file-link-modifiers ()
9296 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9297 (goto-char (point-min))
9299 (org-if-unprotected
9300 (replace-match "file:" t t))))
9301 (eval-after-load "org-exp"
9302 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9303 'org-remove-file-link-modifiers))
9305 ;;;; Time estimates
9307 (defun org-get-effort (&optional pom)
9308 "Get the effort estimate for the current entry."
9309 (org-entry-get pom org-effort-property))
9311 ;;; File search
9313 (defvar org-create-file-search-functions nil
9314 "List of functions to construct the right search string for a file link.
9315 These functions are called in turn with point at the location to
9316 which the link should point.
9318 A function in the hook should first test if it would like to
9319 handle this file type, for example by checking the `major-mode'
9320 or the file extension. If it decides not to handle this file, it
9321 should just return nil to give other functions a chance. If it
9322 does handle the file, it must return the search string to be used
9323 when following the link. The search string will be part of the
9324 file link, given after a double colon, and `org-open-at-point'
9325 will automatically search for it. If special measures must be
9326 taken to make the search successful, another function should be
9327 added to the companion hook `org-execute-file-search-functions',
9328 which see.
9330 A function in this hook may also use `setq' to set the variable
9331 `description' to provide a suggestion for the descriptive text to
9332 be used for this link when it gets inserted into an Org-mode
9335 (defvar org-execute-file-search-functions nil
9336 "List of functions to execute a file search triggered by a link.
9338 Functions added to this hook must accept a single argument, the
9339 search string that was part of the file link, the part after the
9340 double colon. The function must first check if it would like to
9341 handle this search, for example by checking the `major-mode' or
9342 the file extension. If it decides not to handle this search, it
9343 should just return nil to give other functions a chance. If it
9344 does handle the search, it must return a non-nil value to keep
9345 other functions from trying.
9347 Each function can access the current prefix argument through the
9348 variable `current-prefix-argument'. Note that a single prefix is
9349 used to force opening a link in Emacs, so it may be good to only
9350 use a numeric or double prefix to guide the search function.
9352 In case this is needed, a function in this hook can also restore
9353 the window configuration before `org-open-at-point' was called using:
9355 (set-window-configuration org-window-config-before-follow-link)")
9357 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9358 (defun org-link-search (s &optional type avoid-pos)
9359 "Search for a link search option.
9360 If S is surrounded by forward slashes, it is interpreted as a
9361 regular expression. In org-mode files, this will create an `org-occur'
9362 sparse tree. In ordinary files, `occur' will be used to list matches.
9363 If the current buffer is in `dired-mode', grep will be used to search
9364 in all files. If AVOID-POS is given, ignore matches near that position."
9365 (let ((case-fold-search t)
9369 org-emphasis-alist)
9371 (pos (point))
9372 (pre nil) (post nil)
9373 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9374 (cond
9375 ;; First check if there are any special search functions
9376 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9377 ;; Now try the builtin stuff
9378 ((and (equal (string-to-char s0) ?#)
9379 (> (length s0) 1)
9380 (save-excursion
9381 (goto-char (point-min))
9382 (and
9383 (re-search-forward
9385 (setq type 'dedicated
9386 pos (match-beginning 0))))
9387 ;; There is an exact target for this
9388 (goto-char pos)
9389 (org-back-to-heading t)))
9390 ((save-excursion
9391 (goto-char (point-min))
9392 (and
9393 (re-search-forward
9394 (concat "<<" (regexp-quote s0) ">>") nil t)
9395 (setq type 'dedicated
9396 pos (match-beginning 0))))
9397 ;; There is an exact target for this
9398 (goto-char pos))
9400 (save-excursion
9401 (goto-char (point-min))
9402 (and
9403 (re-search-forward
9404 (concat "[^[]" (regexp-quote
9405 (format org-coderef-label-format
9406 (match-string 1 s0))))
9407 nil t)
9408 (setq type 'dedicated
9409 pos (1+ (match-beginning 0))))))
9410 ;; There is a coderef target for this
9411 (goto-char pos))
9413 ;; A regular expression
9414 (cond
9415 ((org-mode-p)
9416 (org-occur (match-string 1 s)))
9417 ;;((eq major-mode 'dired-mode)
9418 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9419 (t (org-do-occur (match-string 1 s)))))
9420 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9421 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9422 (goto-char (point-min))
9423 (cond
9424 ((let (case-fold-search)
9425 (re-search-forward (format org-complex-heading-regexp-format
9426 (regexp-quote s))
9427 nil t))
9428 ;; OK, found a match
9429 (goto-char (match-beginning 0)))
9430 ((and (not org-link-search-inhibit-query)
9431 (eq org-link-search-must-match-exact-headline 'query-to-create)
9432 (y-or-n-p "No match - create this as a new heading? "))
9433 (goto-char (point-max))
9434 (or (bolp) (newline))
9436 (beginning-of-line 0))
9437 (t
9438 (goto-char pos)
9439 (error "No match"))))
9440 (t
9441 ;; A normal search string
9442 (when (equal (string-to-char s) ?*)
9443 ;; Anchor on headlines, post may include tags.
9446 s (substring s 1)))
9447 (remove-text-properties
9448 0 (length s)
9449 '(face nil mouse-face nil keymap nil fontified nil) s)
9450 ;; Make a series of regular expressions to find a match
9459 re4 (concat "[^a-zA-Z_]" re4_)
9461 re1 (concat pre re2 post)
9462 re3 (concat pre (if pre re4_ re4) post)
9463 re5 (concat pre ".*" re4)
9464 re2 (concat pre re2)
9465 re2a (concat pre (if pre re2a_ re2a))
9466 re4 (concat pre (if pre re4_ re4))
9470 ))
9471 (cond
9472 ((eq type 'org-occur) (org-occur reall))
9473 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9474 (t (goto-char (point-min))
9475 (setq type 'fuzzy)
9476 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9477 (org-search-not-self 1 re1 nil t)
9478 (org-search-not-self 1 re2 nil t)
9479 (org-search-not-self 1 re2a nil t)
9480 (org-search-not-self 1 re3 nil t)
9481 (org-search-not-self 1 re4 nil t)
9482 (org-search-not-self 1 re5 nil t)
9483 )
9484 (goto-char (match-beginning 1))
9485 (goto-char pos)
9486 (error "No match"))))))
9487 (and (org-mode-p) (org-show-context 'link-search))
9488 type))
9490 (defun org-search-not-self (group &rest args)
9491 "Execute `re-search-forward', but only accept matches that do not
9492 enclose the position of `org-open-link-marker'."
9493 (let ((m org-open-link-marker))
9494 (catch 'exit
9495 (while (apply 're-search-forward args)
9496 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9497 (goto-char (match-end group))
9498 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9499 (> (match-beginning 0) (marker-position m))
9500 (< (match-end 0) (marker-position m)))
9501 (save-match-data
9502 (or (not (org-in-regexp
9503 org-bracket-link-analytic-regexp 1))
9504 (not (match-end 4)) ; no description
9505 (and (<= (match-beginning 4) (point))
9506 (>= (match-end 4) (point))))))
9507 (throw 'exit (point))))))))
9509 (defun org-get-buffer-for-internal-link (buffer)
9510 "Return a buffer to be used for displaying the link target of internal links."
9511 (cond
9512 ((not org-display-internal-link-with-indirect-buffer)
9513 buffer)
9514 ((string-match "(Clone)$" (buffer-name buffer))
9515 (message "Buffer is already a clone, not making another one")
9516 ;; we also do not modify visibility in this case
9517 buffer)
9518 (t ; make a new indirect buffer for displaying the link
9519 (let* ((bn (buffer-name buffer))
9520 (ibn (concat bn "(Clone)"))
9521 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9522 (with-current-buffer ib (org-overview))
9523 ib))))
9525 (defun org-do-occur (regexp &optional cleanup)
9526 "Call the Emacs command `occur'.
9527 If CLEANUP is non-nil, remove the printout of the regular expression
9528 in the *Occur* buffer. This is useful if the regex is long and not useful
9529 to read."
9530 (occur regexp)
9531 (when cleanup
9532 (let ((cwin (selected-window)) win beg end)
9533 (when (setq win (get-buffer-window "*Occur*"))
9534 (select-window win))
9535 (goto-char (point-min))
9536 (when (re-search-forward "match[a-z]+" nil t)
9537 (setq beg (match-end 0))
9539 (setq end (1- (match-beginning 0)))))
9540 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9541 (goto-char (point-min))
9542 (select-window cwin))))
9544 ;;; The mark ring for links jumps
9546 (defvar org-mark-ring nil
9547 "Mark ring for positions before jumps in Org-mode.")
9548 (defvar org-mark-ring-last-goto nil
9549 "Last position in the mark ring used to go back.")
9550 ;; Fill and close the ring
9551 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9552 (loop for i from 1 to org-mark-ring-length do
9553 (push (make-marker) org-mark-ring))
9554 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9555 org-mark-ring)
9557 (defun org-mark-ring-push (&optional pos buffer)
9558 "Put the current position or POS into the mark ring and rotate it."
9559 (interactive)
9560 (setq pos (or pos (point)))
9561 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9562 (move-marker (car org-mark-ring)
9563 (or pos (point))
9564 (or buffer (current-buffer)))
9565 (message "%s"
9566 (substitute-command-keys
9569 (defun org-mark-ring-goto (&optional n)
9570 "Jump to the previous position in the mark ring.
9571 With prefix arg N, jump back that many stored positions. When
9572 called several times in succession, walk through the entire ring.
9573 Org-mode commands jumping to a different position in the current file,
9574 or to another Org-mode file, automatically push the old position
9575 onto the ring."
9576 (interactive "p")
9577 (let (p m)
9578 (if (eq last-command this-command)
9579 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9580 (setq p org-mark-ring))
9581 (setq org-mark-ring-last-goto p)
9582 (setq m (car p))
9583 (switch-to-buffer (marker-buffer m))
9584 (goto-char m)
9585 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9587 (defun org-remove-angle-brackets (s)
9588 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9589 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9590 s)
9591 (defun org-add-angle-brackets (s)
9592 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9593 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9594 s)
9595 (defun org-remove-double-quotes (s)
9598 s)
9600 ;;; Following specific links
9602 (defun org-follow-timestamp-link ()
9603 (cond
9604 ((org-at-date-range-p t)
9605 (let ((org-agenda-start-on-weekday)
9606 (t1 (match-string 1))
9607 (t2 (match-string 2)))
9608 (setq t1 (time-to-days (org-time-string-to-time t1))
9609 t2 (time-to-days (org-time-string-to-time t2)))
9610 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9611 ((org-at-timestamp-p t)
9612 (org-agenda-list nil (time-to-days (org-time-string-to-time
9613 (substring (match-string 1) 0 10)))
9614 1))
9615 (t (error "This should not happen"))))
9618 ;;; Following file links
9619 (defvar org-wait nil)
9620 (defun org-open-file (path &optional in-emacs line search)
9621 "Open the file at PATH.
9622 First, this expands any special file name abbreviations. Then the
9623 configuration variable `org-file-apps' is checked if it contains an
9624 entry for this file type, and if yes, the corresponding command is launched.
9626 If no application is found, Emacs simply visits the file.
9628 With optional prefix argument IN-EMACS, Emacs will visit the file.
9630 prefix arg, Org tries to avoid opening in Emacs
9631 and to use an external application to visit the file.
9633 Optional LINE specifies a line to go to, optional SEARCH a string
9634 to search for. If LINE or SEARCH is given, the file will be
9635 opened in Emacs, unless an entry from org-file-apps that makes
9636 use of groups in a regexp matches.
9637 If the file does not exist, an error is thrown."
9638 (let* ((file (if (equal path "")
9639 buffer-file-name
9640 (substitute-in-file-name (expand-file-name path))))
9641 (file-apps (append org-file-apps (org-default-apps)))
9642 (apps (org-remove-if
9643 'org-file-apps-entry-match-against-dlink-p file-apps))
9644 (apps-dlink (org-remove-if-not
9645 'org-file-apps-entry-match-against-dlink-p file-apps))
9646 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9647 (dirp (if remp nil (file-directory-p file)))
9648 (file (if (and dirp org-open-directory-means-index-dot-org)
9649 (concat (file-name-as-directory file) "index.org")
9650 file))
9651 (a-m-a-p (assq 'auto-mode apps))
9652 (dfile (downcase file))
9653 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9654 (link (cond ((and (eq line nil)
9655 (eq search nil))
9656 file)
9657 (line
9658 (concat file "::" (number-to-string line)))
9659 (search
9660 (concat file "::" search))))
9661 (dlink (downcase link))
9662 (old-buffer (current-buffer))
9663 (old-pos (point))
9664 (old-mode major-mode)
9665 ext cmd link-match-data)
9667 (setq ext (match-string 1 dfile))
9669 (setq ext (match-string 1 dfile))))
9670 (cond
9671 ((member in-emacs '((16) system))
9672 (setq cmd (cdr (assoc 'system apps))))
9673 (in-emacs (setq cmd 'emacs))
9674 (t
9675 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9676 (and dirp (cdr (assoc 'directory apps)))
9677 ; first, try matching against apps-dlink
9678 ; if we get a match here, store the match data for later
9679 (let ((match (assoc-default dlink apps-dlink
9680 'string-match)))
9681 (if match
9682 (progn (setq link-match-data (match-data))
9683 match)
9684 (progn (setq in-emacs (or in-emacs line search))
9685 nil))) ; if we have no match in apps-dlink,
9686 ; always open the file in emacs if line or search
9687 ; is given (for backwards compatibility)
9688 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9689 'string-match)
9690 (cdr (assoc ext apps))
9691 (cdr (assoc t apps))))))
9692 (when (eq cmd 'system)
9693 (setq cmd (cdr (assoc 'system apps))))
9694 (when (eq cmd 'default)
9695 (setq cmd (cdr (assoc t apps))))
9696 (when (eq cmd 'mailcap)
9697 (require 'mailcap)
9698 (mailcap-parse-mailcaps)
9699 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9700 (command (mailcap-mime-info mime-type)))
9701 (if (stringp command)
9702 (setq cmd command)
9703 (setq cmd 'emacs))))
9704 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9705 (not (file-exists-p file))
9706 (not org-open-non-existing-files))
9707 (error "No such file: %s" file))
9708 (cond
9710 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9712 (setq cmd (replace-match "%s" t t cmd)))
9713 (while (string-match "%s" cmd)
9714 (setq cmd (replace-match
9715 (save-match-data
9716 (shell-quote-argument
9717 (convert-standard-filename file)))
9718 t t cmd)))
9720 ;; Replace "%1", "%2" etc. in command with group matches from regex
9721 (save-match-data
9722 (let ((match-index 1)
9723 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9724 (set-match-data link-match-data)
9725 (while (<= match-index number-of-groups)
9726 (let ((regex (concat "%" (number-to-string match-index)))
9727 (replace-with (match-string match-index dlink)))
9728 (while (string-match regex cmd)
9729 (setq cmd (replace-match replace-with t t cmd))))
9730 (setq match-index (+ match-index 1)))))
9732 (save-window-excursion
9733 (start-process-shell-command cmd nil cmd)
9734 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9735 ))
9736 ((or (stringp cmd)
9737 (eq cmd 'emacs))
9738 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9739 (widen)
9740 (if line (org-goto-line line)
9741 (if search (org-link-search search))))
9742 ((consp cmd)
9743 (let ((file (convert-standard-filename file)))
9744 (save-match-data
9745 (set-match-data link-match-data)
9746 (eval cmd))))
9747 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9748 (and (org-mode-p) (eq old-mode 'org-mode)
9749 (or (not (equal old-buffer (current-buffer)))
9750 (not (equal old-pos (point))))
9751 (org-mark-ring-push old-pos old-buffer))))
9753 (defun org-file-apps-entry-match-against-dlink-p (entry)
9754 "This function returns non-nil if `entry' uses a regular
9755 expression which should be matched against the whole link by
9756 org-open-file.
9758 It assumes that is the case when the entry uses a regular
9759 expression which has at least one grouping construct and the
9760 action is either a lisp form or a command string containing
9761 '%1', i.e. using at least one subexpression match as a
9762 parameter."
9763 (let ((selector (car entry))
9764 (action (cdr entry)))
9765 (if (stringp selector)
9766 (and (> (regexp-opt-depth selector) 0)
9767 (or (and (stringp action)
9768 (string-match "%[0-9]" action))
9769 (consp action)))
9770 nil)))
9772 (defun org-default-apps ()
9773 "Return the default applications for this operating system."
9774 (cond
9775 ((eq system-type 'darwin)
9776 org-file-apps-defaults-macosx)
9777 ((eq system-type 'windows-nt)
9778 org-file-apps-defaults-windowsnt)
9779 (t org-file-apps-defaults-gnu)))
9781 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9782 "Convert extensions to regular expressions in the cars of LIST.
9783 Also, weed out any non-string entries, because the return value is used
9784 only for regexp matching.
9785 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9786 point to the symbol `emacs', indicating that the file should
9787 be opened in Emacs."
9788 (append
9789 (delq nil
9790 (mapcar (lambda (x)
9791 (if (not (stringp (car x)))
9792 nil
9794 x
9796 list))
9797 (if add-auto-mode
9798 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9800 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9801 (defun org-file-remote-p (file)
9802 "Test whether FILE specifies a location on a remote system.
9803 Return non-nil if the location is indeed remote.
9807 (cond ((fboundp 'file-remote-p)
9808 (file-remote-p file))
9809 ((fboundp 'tramp-handle-file-remote-p)
9810 (tramp-handle-file-remote-p file))
9811 ((and (boundp 'ange-ftp-name-format)
9812 (string-match (car ange-ftp-name-format) file))
9813 t)
9814 (t nil)))
9817 ;;;; Refiling
9819 (defun org-get-org-file ()
9820 "Read a filename, with default directory `org-directory'."
9821 (let ((default (or org-default-notes-file remember-data-file)))
9822 (read-file-name (format "File name [%s]: " default)
9823 (file-name-as-directory org-directory)
9824 default)))
9826 (defun org-notes-order-reversed-p ()
9827 "Check if the current file should receive notes in reversed order."
9828 (cond
9829 ((not org-reverse-note-order) nil)
9830 ((eq t org-reverse-note-order) t)
9831 ((not (listp org-reverse-note-order)) nil)
9832 (t (catch 'exit
9833 (let ((all org-reverse-note-order)
9834 entry)
9835 (while (setq entry (pop all))
9836 (if (string-match (car entry) buffer-file-name)
9837 (throw 'exit (cdr entry))))
9838 nil)))))
9840 (defvar org-refile-target-table nil
9841 "The list of refile targets, created by `org-refile'.")
9843 (defvar org-agenda-new-buffers nil
9844 "Buffers created to visit agenda files.")
9846 (defvar org-refile-cache nil
9847 "Cache for refile targets.")
9850 (defvar org-refile-markers nil
9851 "All the markers used for caching refile locations.")
9853 (defun org-refile-marker (pos)
9854 "Get a new refile marker, but only if caching is in use."
9855 (if (not org-refile-use-cache)
9856 pos
9857 (let ((m (make-marker)))
9858 (move-marker m pos)
9859 (push m org-refile-markers)
9860 m)))
9862 (defun org-refile-cache-clear ()
9863 "Clear the refile cache and disable all the markers."
9864 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
9865 (setq org-refile-markers nil)
9866 (setq org-refile-cache nil)
9867 (message "Refile cache has been cleared"))
9869 (defun org-refile-cache-check-set (set)
9870 "Check if all the markers in the cache still have live buffers."
9871 (let (marker)
9872 (catch 'exit
9873 (while (and set (setq marker (nth 3 (pop set))))
9874 ;; if org-refile-use-outline-path is 'file, marker may be nil
9875 (when (and marker (null (marker-buffer marker)))
9876 (message "not found") (sit-for 3)
9877 (throw 'exit nil)))
9878 t)))
9880 (defun org-refile-cache-put (set &rest identifiers)
9881 "Push the refile targets SET into the cache, under IDENTIFIERS."
9882 (let* ((key (sha1 (prin1-to-string identifiers)))
9883 (entry (assoc key org-refile-cache)))
9884 (if entry
9885 (setcdr entry set)
9886 (push (cons key set) org-refile-cache))))
9888 (defun org-refile-cache-get (&rest identifiers)
9889 "Retrieve the cached value for refile targets given by IDENTIFIERS."
9890 (cond
9891 ((not org-refile-cache) nil)
9892 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
9893 (t
9894 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
9895 org-refile-cache))))
9896 (and set (org-refile-cache-check-set set) set)))))
9898 (defun org-get-refile-targets (&optional default-buffer)
9899 "Produce a table with refile targets."
9900 (let ((case-fold-search nil)
9901 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
9902 (entries (or org-refile-targets '((nil . (:level . 1)))))
9903 targets tgs txt re files f desc descre fast-path-p level pos0)
9904 (message "Getting targets...")
9905 (with-current-buffer (or default-buffer (current-buffer))
9906 (while (setq entry (pop entries))
9907 (setq files (car entry) desc (cdr entry))
9908 (setq fast-path-p nil)
9909 (cond
9910 ((null files) (setq files (list (current-buffer))))
9911 ((eq files 'org-agenda-files)
9912 (setq files (org-agenda-files 'unrestricted)))
9913 ((and (symbolp files) (fboundp files))
9914 (setq files (funcall files)))
9915 ((and (symbolp files) (boundp files))
9916 (setq files (symbol-value files))))
9917 (if (stringp files) (setq files (list files)))
9918 (cond
9919 ((eq (car desc) :tag)
9921 ((eq (car desc) :todo)
9923 ((eq (car desc) :regexp)
9924 (setq descre (cdr desc)))
9925 ((eq (car desc) :level)
9927 (if org-odd-levels-only
9928 (1- (* 2 (cdr desc)))
9929 (cdr desc)))
9931 ((eq (car desc) :maxlevel)
9932 (setq fast-path-p t)
9934 (if org-odd-levels-only
9935 (1- (* 2 (cdr desc)))
9936 (cdr desc)))
9938 (t (error "Bad refiling target description %s" desc)))
9939 (while (setq f (pop files))
9940 (with-current-buffer
9941 (if (bufferp f) f (org-get-agenda-file-buffer f))
9942 (or
9943 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
9944 (progn
9945 (if (bufferp f) (setq f (buffer-file-name
9946 (buffer-base-buffer f))))
9947 (setq f (and f (expand-file-name f)))
9948 (if (eq org-refile-use-outline-path 'file)
9949 (push (list (file-name-nondirectory f) f nil nil) tgs))
9950 (save-excursion
9951 (save-restriction
9952 (widen)
9953 (goto-char (point-min))
9954 (while (re-search-forward descre nil t)
9955 (goto-char (setq pos0 (point-at-bol)))
9956 (catch 'next
9957 (when org-refile-target-verify-function
9958 (save-match-data
9959 (or (funcall org-refile-target-verify-function)
9960 (throw 'next t))))
9961 (when (looking-at org-complex-heading-regexp)
9962 (setq level (org-reduced-level
9963 (- (match-end 1) (match-beginning 1)))
9964 txt (org-link-display-format (match-string 4))
9966 re (format org-complex-heading-regexp-format
9967 (regexp-quote (match-string 4))))
9968 (when org-refile-use-outline-path
9969 (setq txt (mapconcat
9970 'org-protect-slash
9971 (append
9972 (if (eq org-refile-use-outline-path
9973 'file)
9974 (list (file-name-nondirectory
9975 (buffer-file-name
9976 (buffer-base-buffer))))
9977 (if (eq org-refile-use-outline-path
9978 'full-file-path)
9979 (list (buffer-file-name
9980 (buffer-base-buffer)))))
9981 (org-get-outline-path fast-path-p
9982 level txt)
9983 (list txt))
9984 "/")))
9985 (push (list txt f re (org-refile-marker (point)))
9986 tgs)))
9987 (when (= (point) pos0)
9988 ;; verification function has not moved point
9989 (goto-char (point-at-eol))))))))
9990 (when org-refile-use-cache
9991 (org-refile-cache-put tgs (buffer-file-name) descre))
9992 (setq targets (append tgs targets))
9993 ))))
9994 (message "Getting targets...done")
9995 (nreverse targets)))
9997 (defun org-protect-slash (s)
9998 (while (string-match "/" s)
10000 s)
10002 (defvar org-olpa (make-vector 20 nil))
10004 (defun org-get-outline-path (&optional fastp level heading)
10005 "Return the outline path to the current entry, as a list.
10007 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10008 routine which makes outline path derivations for an entire file,
10009 avoiding backtracing. Refile target collection makes use of that."
10010 (if fastp
10011 (progn
10012 (if (> level 19)
10013 (error "Outline path failure, more than 19 levels"))
10014 (loop for i from level upto 19 do
10015 (aset org-olpa i nil))
10016 (prog1
10017 (delq nil (append org-olpa nil))
10018 (aset org-olpa level heading)))
10019 (let (rtn case-fold-search)
10020 (save-excursion
10021 (save-restriction
10022 (widen)
10023 (while (org-up-heading-safe)
10024 (when (looking-at org-complex-heading-regexp)
10025 (push (org-match-string-no-properties 4) rtn)))
10026 rtn)))))
10028 (defun org-format-outline-path (path &optional width prefix)
10029 "Format the outline path PATH for display.
10030 Width is the maximum number of characters that is available.
10031 Prefix is a prefix to be included in the returned string,
10032 such as the file name."
10033 (setq width (or width 79))
10034 (if prefix (setq width (- width (length prefix))))
10035 (if (not path)
10036 (or prefix "")
10037 (let* ((nsteps (length path))
10038 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10039 (maxwidth (if (<= total-width width)
10040 10000 ;; everything fits
10041 ;; we need to shorten the level headings
10042 (/ (- width nsteps) nsteps)))
10043 (org-odd-levels-only nil)
10044 (n 0)
10045 (total (1+ (length prefix))))
10046 (setq maxwidth (max maxwidth 10))
10047 (concat prefix
10048 (mapconcat
10049 (lambda (h)
10050 (setq n (1+ n))
10051 (if (and (= n nsteps) (< maxwidth 10000))
10052 (setq maxwidth (- total-width total)))
10053 (if (< (length h) maxwidth)
10054 (progn (setq total (+ total (length h) 1)) h)
10055 (setq h (substring h 0 (- maxwidth 2))
10056 total (+ total maxwidth 1))
10058 (setq h (substring h 0 (match-beginning 0))))
10059 (setq h (concat h "..")))
10060 (org-add-props h nil 'face
10061 (nth (% (1- n) org-n-level-faces)
10062 org-level-faces))
10063 h)
10064 path "/")))))
10066 (defun org-display-outline-path (&optional file current)
10067 "Display the current outline path in the echo area."
10068 (interactive "P")
10069 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10070 (case-fold-search nil)
10071 (path (and (org-mode-p) (org-get-outline-path))))
10072 (if current (setq path (append path
10073 (save-excursion
10074 (org-back-to-heading t)
10075 (if (looking-at org-complex-heading-regexp)
10076 (list (match-string 4)))))))
10077 (message "%s"
10078 (org-format-outline-path
10079 path
10080 (1- (frame-width))
10081 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10083 (defvar org-refile-history nil
10084 "History for refiling operations.")
10086 (defvar org-after-refile-insert-hook nil
10087 "Hook run after `org-refile' has inserted its stuff at the new location.
10088 Note that this is still *before* the stuff will be removed from
10089 the *old* location.")
10091 (defvar org-capture-last-stored-marker)
10092 (defun org-refile (&optional goto default-buffer rfloc)
10093 "Move the entry at point to another heading.
10094 The list of target headings is compiled using the information in
10095 `org-refile-targets', which see. This list is created before each use
10096 and will therefore always be up-to-date.
10098 At the target location, the entry is filed as a subitem of the target heading.
10099 Depending on `org-reverse-note-order', the new subitem will either be the
10100 first or the last subitem.
10102 If there is an active region, all entries in that region will be moved.
10103 However, the region must fulfill the requirement that the first heading
10104 is the first one sets the top-level of the moved text - at most siblings
10105 below it are allowed.
10107 With prefix arg GOTO, the command will only visit the target location,
10108 not actually move anything.
10110 go to the location where the last refiling
10111 operation has put the subtree.
10112 With a prefix argument of `2', refile to the running clock.
10114 RFLOC can be a refile location obtained in a different way.
10116 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10118 If you are using target caching (see `org-refile-use-cache'),
10119 You have to clear the target cache in order to find new targets.
10120 This can be done with a 0 prefix: `C-0 C-c C-w'"
10121 (interactive "P")
10122 (if (member goto '(0 (64)))
10123 (org-refile-cache-clear)
10124 (let* ((cbuf (current-buffer))
10125 (regionp (org-region-active-p))
10126 (region-start (and regionp (region-beginning)))
10127 (region-end (and regionp (region-end)))
10128 (region-length (and regionp (- region-end region-start)))
10129 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10130 pos it nbuf file re level reversed)
10131 (setq last-command nil)
10132 (when regionp
10133 (goto-char region-start)
10134 (or (bolp) (goto-char (point-at-bol)))
10135 (setq region-start (point))
10136 (unless (org-kill-is-subtree-p
10137 (buffer-substring region-start region-end))
10138 (error "The region is not a (sequence of) subtree(s)")))
10139 (if (equal goto '(16))
10140 (org-refile-goto-last-stored)
10141 (when (or
10142 (and (equal goto 2)
10143 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10144 (prog1
10145 (setq it (list (or org-clock-heading "running clock")
10146 (buffer-file-name
10147 (marker-buffer org-clock-hd-marker))
10148 ""
10149 (marker-position org-clock-hd-marker)))
10150 (setq goto nil)))
10151 (setq it (or rfloc
10152 (save-excursion
10153 (org-refile-get-location
10154 (if goto "Goto: " "Refile to: ") default-buffer
10155 org-refile-allow-creating-parent-nodes)))))
10156 (setq file (nth 1 it)
10157 re (nth 2 it)
10158 pos (nth 3 it))
10159 (if (and (not goto)
10160 pos
10161 (equal (buffer-file-name) file)
10162 (if regionp
10163 (and (>= pos region-start)
10164 (<= pos region-end))
10165 (and (>= pos (point))
10166 (< pos (save-excursion
10167 (org-end-of-subtree t t))))))
10168 (error "Cannot refile to position inside the tree or region"))
10170 (setq nbuf (or (find-buffer-visiting file)
10171 (find-file-noselect file)))
10172 (if goto
10173 (progn
10174 (switch-to-buffer nbuf)
10175 (goto-char pos)
10176 (org-show-context 'org-goto))
10177 (if regionp
10178 (progn
10179 (org-kill-new (buffer-substring region-start region-end))
10180 (org-save-markers-in-region region-start region-end))
10181 (org-copy-subtree 1 nil t))
10182 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10183 (find-file-noselect file)))
10184 (setq reversed (org-notes-order-reversed-p))
10185 (save-excursion
10186 (save-restriction
10187 (widen)
10188 (if pos
10189 (progn
10190 (goto-char pos)
10191 (looking-at outline-regexp)
10192 (setq level (org-get-valid-level (funcall outline-level) 1))
10193 (goto-char
10194 (if reversed
10195 (or (outline-next-heading) (point-max))
10196 (or (save-excursion (org-get-next-sibling))
10197 (org-end-of-subtree t t)
10198 (point-max)))))
10199 (setq level 1)
10200 (if (not reversed)
10201 (goto-char (point-max))
10202 (goto-char (point-min))
10203 (or (outline-next-heading) (goto-char (point-max)))))
10204 (if (not (bolp)) (newline))
10205 (org-paste-subtree level)
10206 (when org-log-refile
10207 (org-add-log-setup 'refile nil nil 'findpos
10208 org-log-refile)
10209 (unless (eq org-log-refile 'note)
10210 (save-excursion (org-add-log-note))))
10211 (and org-auto-align-tags (org-set-tags nil t))
10212 (bookmark-set "org-refile-last-stored")
10213 ;; If we are refiling for capture, make sure that the
10214 ;; last-capture pointers point here
10215 (when (org-bound-and-true-p org-refile-for-capture)
10216 (bookmark-set "org-capture-last-stored-marker")
10217 (move-marker org-capture-last-stored-marker (point)))
10218 (if (fboundp 'deactivate-mark) (deactivate-mark))
10219 (run-hooks 'org-after-refile-insert-hook))))
10220 (if regionp
10221 (delete-region (point) (+ (point) region-length))
10222 (org-cut-subtree))
10223 (when (featurep 'org-inlinetask)
10224 (org-inlinetask-remove-END-maybe))
10225 (setq org-markers-to-move nil)
10228 (defun org-refile-goto-last-stored ()
10229 "Go to the location where the last refile was stored."
10230 (interactive)
10231 (bookmark-jump "org-refile-last-stored")
10232 (message "This is the location of the last refile"))
10234 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10235 "Prompt the user for a refile location, using PROMPT."
10236 (let ((org-refile-targets org-refile-targets)
10237 (org-refile-use-outline-path org-refile-use-outline-path))
10238 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
10239 (unless org-refile-target-table
10240 (error "No refile targets"))
10241 (let* ((cbuf (current-buffer))
10242 (partial-completion-mode nil)
10243 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10244 (cfunc (if (and org-refile-use-outline-path
10245 org-outline-path-complete-in-steps)
10246 'org-olpath-completing-read
10247 'org-icompleting-read))
10248 (extra (if org-refile-use-outline-path "/" ""))
10249 (filename (and cfn (expand-file-name cfn)))
10250 (tbl (mapcar
10251 (lambda (x)
10252 (if (and (not (member org-refile-use-outline-path
10253 '(file full-file-path)))
10254 (not (equal filename (nth 1 x))))
10255 (cons (concat (car x) extra " ("
10256 (file-name-nondirectory (nth 1 x)) ")")
10257 (cdr x))
10258 (cons (concat (car x) extra) (cdr x))))
10259 org-refile-target-table))
10260 (completion-ignore-case t)
10261 pa answ parent-target child parent old-hist)
10262 (setq old-hist org-refile-history)
10263 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10264 nil 'org-refile-history))
10265 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10266 (org-refile-check-position pa)
10267 (if pa
10268 (progn
10269 (when (or (not org-refile-history)
10270 (not (eq old-hist org-refile-history))
10271 (not (equal (car pa) (car org-refile-history))))
10272 (setq org-refile-history
10273 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10274 org-refile-history
10275 (cdr org-refile-history))))
10276 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10277 (pop org-refile-history)))
10278 pa)
10280 (progn
10281 (setq parent (match-string 1 answ)
10282 child (match-string 2 answ))
10283 (setq parent-target (or (assoc parent tbl)
10284 (assoc (concat parent "/") tbl)))
10285 (when (and parent-target
10286 (or (eq new-nodes t)
10287 (and (eq new-nodes 'confirm)
10289 child)))))
10290 (org-refile-new-child parent-target child)))
10291 (error "Invalid target location")))))
10293 (defun org-refile-check-position (refile-pointer)
10294 "Check if the refile pointer matches the readline to which it points."
10295 (let* ((file (nth 1 refile-pointer))
10296 (re (nth 2 refile-pointer))
10297 (pos (nth 3 refile-pointer))
10298 buffer)
10299 (when (org-string-nw-p re)
10300 (setq buffer (if (markerp pos)
10301 (marker-buffer pos)
10302 (or (find-buffer-visiting file)
10303 (find-file-noselect file))))
10304 (with-current-buffer buffer
10305 (save-excursion
10306 (save-restriction
10307 (widen)
10308 (goto-char pos)
10309 (beginning-of-line 1)
10310 (unless (org-looking-at-p re)
10311 (error "Invalid refile position, please rebuild the cache"))))))))
10313 (defun org-refile-new-child (parent-target child)
10314 "Use refile target PARENT-TARGET to add new CHILD below it."
10315 (unless parent-target
10316 (error "Cannot find parent for new node"))
10317 (let ((file (nth 1 parent-target))
10318 (pos (nth 3 parent-target))
10319 level)
10320 (with-current-buffer (or (find-buffer-visiting file)
10321 (find-file-noselect file))
10322 (save-excursion
10323 (save-restriction
10324 (widen)
10325 (if pos
10326 (goto-char pos)
10327 (goto-char (point-max))
10328 (if (not (bolp)) (newline)))
10329 (when (looking-at outline-regexp)
10330 (setq level (funcall outline-level))
10331 (org-end-of-subtree t t))
10332 (org-back-over-empty-lines)
10334 (if pos (org-get-valid-level level 1) 1) ?*)
10336 (beginning-of-line 0)
10337 (list (concat (car parent-target) "/" child) file "" (point)))))))
10339 (defun org-olpath-completing-read (prompt collection &rest args)
10340 "Read an outline path like a file name."
10341 (let ((thetable collection)
10342 (org-completion-use-ido nil) ; does not work with ido.
10343 (org-completion-use-iswitchb nil)) ; or iswitchb
10344 (apply
10345 'org-icompleting-read prompt
10346 (lambda (string predicate &optional flag)
10347 (let (rtn r f (l (length string)))
10348 (cond
10349 ((eq flag nil)
10350 ;; try completion
10351 (try-completion string thetable))
10352 ((eq flag t)
10353 ;; all-completions
10354 (setq rtn (all-completions string thetable predicate))
10355 (mapcar
10356 (lambda (x)
10357 (setq r (substring x l))
10358 (if (string-match " ([^)]*)$" x)
10359 (setq f (match-string 0 x))
10360 (setq f ""))
10361 (if (string-match "/" r)
10362 (concat string (substring r 0 (match-end 0)) f)
10363 x))
10364 rtn))
10365 ((eq flag 'lambda)
10366 ;; exact match?
10367 (assoc string thetable)))
10368 ))
10369 args)))
10371 ;;;; Dynamic blocks
10373 (defun org-find-dblock (name)
10374 "Find the first dynamic block with name NAME in the buffer.
10375 If not found, stay at current position and return nil."
10376 (let (pos)
10377 (save-excursion
10378 (goto-char (point-min))
10380 nil t)
10381 (match-beginning 0))))
10382 (if pos (goto-char pos))
10383 pos))
10385 (defconst org-dblock-start-re
10387 "Matches the start line of a dynamic block, with parameters.")
10390 "Matches the end of a dynamic block.")
10392 (defun org-create-dblock (plist)
10393 "Create a dynamic block section, with parameters taken from PLIST.
10394 PLIST must contain a :name entry which is used as name of the block."
10396 (end-of-line 1)
10397 (newline))
10398 (let ((col (current-column))
10399 (name (plist-get plist :name)))
10400 (insert "#+BEGIN: " name)
10401 (while plist
10402 (if (eq (car plist) :name)
10403 (setq plist (cddr plist))
10404 (insert " " (prin1-to-string (pop plist)))))
10406 (beginning-of-line -2)))
10408 (defun org-prepare-dblock ()
10409 "Prepare dynamic block for refresh.
10410 This empties the block, puts the cursor at the insert position and returns
10411 the property list including an extra property :name with the block name."
10412 (unless (looking-at org-dblock-start-re)
10413 (error "Not at a dynamic block"))
10414 (let* ((begdel (1+ (match-end 0)))
10415 (name (org-no-properties (match-string 1)))
10416 (params (append (list :name name)
10417 (read (concat "(" (match-string 3) ")")))))
10418 (save-excursion
10419 (beginning-of-line 1)
10421 (setq params (plist-put params :indentation-column (current-column))))
10422 (unless (re-search-forward org-dblock-end-re nil t)
10423 (error "Dynamic block not terminated"))
10424 (setq params
10425 (append params
10426 (list :content (buffer-substring
10427 begdel (match-beginning 0)))))
10428 (delete-region begdel (match-beginning 0))
10429 (goto-char begdel)
10430 (open-line 1)
10431 params))
10433 (defun org-map-dblocks (&optional command)
10434 "Apply COMMAND to all dynamic blocks in the current buffer.
10435 If COMMAND is not given, use `org-update-dblock'."
10436 (let ((cmd (or command 'org-update-dblock)))
10437 (save-excursion
10438 (goto-char (point-min))
10439 (while (re-search-forward org-dblock-start-re nil t)
10440 (goto-char (match-beginning 0))
10441 (save-excursion
10442 (condition-case nil
10443 (funcall cmd)
10444 (error (message "Error during update of dynamic block"))))
10445 (unless (re-search-forward org-dblock-end-re nil t)
10446 (error "Dynamic block not terminated"))))))
10448 (defun org-dblock-update (&optional arg)
10449 "User command for updating dynamic blocks.
10450 Update the dynamic block at point. With prefix ARG, update all dynamic
10451 blocks in the buffer."
10452 (interactive "P")
10453 (if arg
10454 (org-update-all-dblocks)
10455 (or (looking-at org-dblock-start-re)
10456 (org-beginning-of-dblock))
10457 (org-update-dblock)))
10459 (defun org-update-dblock ()
10460 "Update the dynamic block at point.
10461 This means to empty the block, parse for parameters and then call
10462 the correct writing function."
10463 (save-window-excursion
10464 (let* ((pos (point))
10465 (line (org-current-line))
10466 (params (org-prepare-dblock))
10467 (name (plist-get params :name))
10468 (indent (plist-get params :indentation-column))
10469 (cmd (intern (concat "org-dblock-write:" name))))
10470 (message "Updating dynamic block `%s' at line %d..." name line)
10471 (funcall cmd params)
10472 (message "Updating dynamic block `%s' at line %d...done" name line)
10473 (goto-char pos)
10474 (when (and indent (> indent 0))
10475 (setq indent (make-string indent ?\ ))
10476 (save-excursion
10477 (org-beginning-of-dblock)
10478 (forward-line 1)
10479 (while (not (looking-at org-dblock-end-re))
10480 (insert indent)
10481 (beginning-of-line 2))
10482 (when (looking-at org-dblock-end-re)
10484 (replace-match ""))
10485 (insert indent)))))))
10487 (defun org-beginning-of-dblock ()
10488 "Find the beginning of the dynamic block at point.
10489 Error if there is no such block at point."
10490 (let ((pos (point))
10491 beg)
10492 (end-of-line 1)
10493 (if (and (re-search-backward org-dblock-start-re nil t)
10494 (setq beg (match-beginning 0))
10495 (re-search-forward org-dblock-end-re nil t)
10496 (> (match-end 0) pos))
10497 (goto-char beg)
10498 (goto-char pos)
10499 (error "Not in a dynamic block"))))
10501 (defun org-update-all-dblocks ()
10502 "Update all dynamic blocks in the buffer.
10503 This function can be used in a hook."
10504 (when (org-mode-p)
10505 (org-map-dblocks 'org-update-dblock)))
10508 ;;;; Completion
10510 (defconst org-additional-option-like-keywords
10511 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML"
10512 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook"
10513 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10514 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX"
10515 "BEGIN:" "END:"
10516 "ORGTBL" "TBLFM:" "TBLNAME:"
10517 "BEGIN_EXAMPLE" "END_EXAMPLE"
10518 "BEGIN_QUOTE" "END_QUOTE"
10519 "BEGIN_VERSE" "END_VERSE"
10520 "BEGIN_CENTER" "END_CENTER"
10521 "BEGIN_SRC" "END_SRC"
10522 "CATEGORY" "COLUMNS" "PROPERTY"
10523 "CAPTION" "LABEL"
10524 "SETUPFILE"
10525 "BIND"
10526 "MACRO"))
10528 (defcustom org-structure-template-alist
10529 '(
10542 ("L" "#+latex: "
10546 ("H" "#+html: "
10549 ("A" "#+ascii: ")
10550 ("i" "#+include %file ?"
10552 )
10553 "Structure completion elements.
10554 This is a list of abbreviation keys and values. The value gets inserted
10555 if you type `<' followed by the key and then press the completion key,
10556 usually `M-TAB'. %file will be replaced by a file name after prompting
10557 for the file using completion.
10558 There are two templates for each key, the first uses the original Org syntax,
10559 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10560 the default when the /org-mtags.el/ module has been loaded. See also the
10561 variable `org-mtags-prefer-muse-templates'.
10562 This is an experimental feature, it is undecided if it is going to stay in."
10563 :group 'org-completion
10564 :type '(repeat
10565 (string :tag "Key")
10566 (string :tag "Template")
10567 (string :tag "Muse Template")))
10569 (defun org-try-structure-completion ()
10570 "Try to complete a structure template before point.
10572 expands them."
10573 (let ((l (buffer-substring (point-at-bol) (point)))
10574 a)
10577 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10578 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10579 (match-beginning 1)) a)
10580 t)))
10582 (defun org-complete-expand-structure-template (start cell)
10583 "Expand a structure template."
10584 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10585 (rpl (nth (if musep 2 1) cell))
10586 (ind ""))
10587 (delete-region start (point))
10589 (cond
10590 ((bolp))
10592 (setq ind (buffer-substring (point-at-bol) (point))))
10593 (t (newline))))
10594 (setq start (point))
10595 (if (string-match "%file" rpl)
10596 (setq rpl (replace-match
10597 (concat
10599 (save-match-data
10600 (abbreviate-file-name (read-file-name "Include file: ")))
10602 t t rpl)))
10605 (insert rpl)
10609 (defun org-complete (&optional arg)
10610 "Perform completion on word at point.
10611 At the beginning of a headline, this completes TODO keywords as given in
10612 `org-todo-keywords'.
10613 If the current word is preceded by a backslash, completes the TeX symbols
10614 that are supported for HTML support.
10616 setting file options.
10618 At all other locations, this simply calls the value of
10619 `org-completion-fallback-command'."
10620 (interactive "P")
10621 (org-without-partial-completion
10622 (catch 'exit
10623 (let* ((a nil)
10624 (end (point))
10625 (beg1 (save-excursion
10626 (skip-chars-backward (org-re "[:alnum:]_@#%"))
10627 (point)))
10628 (beg (save-excursion
10629 (skip-chars-backward "a-zA-Z0-9_:$")
10630 (point)))
10631 (confirm (lambda (x) (stringp (car x))))
10632 (searchhead (equal (char-before beg) ?*))
10633 (struct
10634 (when (and (member (char-before beg1) '(?. ?<))
10635 (setq a (assoc (buffer-substring beg1 (point))
10636 org-structure-template-alist)))
10637 (org-complete-expand-structure-template (1- beg1) a)
10638 (throw 'exit t)))
10639 (tag (and (equal (char-before beg1) ?:)
10640 (equal (char-after (point-at-bol)) ?*)))
10641 (prop (or (and (equal (char-before beg1) ?:)
10642 (not (equal (char-after (point-at-bol)) ?*)))
10644 (buffer-substring (point-at-bol) (point)))))
10646 (link (equal (char-before beg) ?\[))
10647 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
10648 beg)
10649 "#+"))
10651 (buffer-substring (point-at-bol) (point))))
10652 (completion-ignore-case opt)
10653 (type nil)
10654 (tbl nil)
10655 (table (cond
10656 (opt
10657 (setq type :opt)
10658 (require 'org-exp)
10659 (append
10660 (delq nil
10661 (mapcar
10662 (lambda (x)
10663 (if (string-match
10665 (cons (match-string 2 x)
10666 (match-string 1 x))))
10668 (mapcar 'list org-additional-option-like-keywords)))
10669 (startup
10670 (setq type :startup)
10671 org-startup-options)
10672 (link (append org-link-abbrev-alist-local
10673 org-link-abbrev-alist))
10674 (texp
10675 (setq type :tex)
10676 (append org-entities-user org-entities))
10678 (buffer-substring (point-at-bol) beg))
10679 (setq type :todo)
10680 (mapcar 'list org-todo-keywords-1))
10681 (searchhead
10682 (setq type :searchhead)
10683 (save-excursion
10684 (goto-char (point-min))
10685 (while (re-search-forward org-todo-line-regexp nil t)
10686 (push (list
10687 (org-make-org-heading-search-string
10688 (match-string 3) t))
10689 tbl)))
10690 tbl)
10691 (tag (setq type :tag beg beg1)
10692 (or org-tag-alist (org-get-buffer-tags)))
10693 (prop (setq type :prop beg beg1)
10694 (mapcar 'list (org-buffer-property-keys nil t t)))
10695 (t (progn
10696 (call-interactively org-completion-fallback-command)
10697 (throw 'exit nil)))))
10698 (pattern (buffer-substring-no-properties beg end))
10699 (completion (try-completion pattern table confirm)))
10700 (cond ((eq completion t)
10701 (if (not (assoc (upcase pattern) table))
10702 (message "Already complete")
10703 (if (and (equal type :opt)
10704 (not (member (car (assoc (upcase pattern) table))
10705 org-additional-option-like-keywords)))
10706 (insert (substring (cdr (assoc (upcase pattern) table))
10707 (length pattern)))
10708 (if (memq type '(:tag :prop)) (insert ":")))))
10709 ((null completion)
10711 (ding))
10712 ((not (string= pattern completion))
10713 (delete-region beg end)
10714 (if (string-match " +$" completion)
10715 (setq completion (replace-match "" t t completion)))
10716 (insert completion)
10717 (if (get-buffer-window "*Completions*")
10718 (delete-window (get-buffer-window "*Completions*")))
10719 (if (assoc completion table)
10720 (if (eq type :todo) (insert " ")
10721 (if (and (memq type '(:tag :prop))
10723 (org-current-line-string t))))
10724 (insert ":"))))
10725 (if (and (equal type :opt) (assoc completion table))
10726 (message "%s" (substitute-command-keys
10728 (t
10729 (message "Making completion list...")
10730 (let ((list (sort (all-completions pattern table confirm)
10731 'string<)))
10732 (with-output-to-temp-buffer "*Completions*"
10733 (condition-case nil
10734 ;; Protection needed for XEmacs and emacs 21
10735 (display-completion-list list pattern)
10736 (error (display-completion-list list)))))
10737 (message "Making completion list...%s" "done")))))))
10739 ;;;; TODO, DEADLINE, Comments
10741 (defun org-toggle-comment ()
10742 "Change the COMMENT state of an entry."
10743 (interactive)
10744 (save-excursion
10745 (org-back-to-heading)
10746 (let (case-fold-search)
10747 (if (looking-at (concat outline-regexp
10749 (replace-match "" t t nil 1)
10750 (if (looking-at outline-regexp)
10751 (progn
10752 (goto-char (match-end 0))
10753 (insert org-comment-string " ")))))))
10755 (defvar org-last-todo-state-is-todo nil
10756 "This is non-nil when the last TODO state change led to a TODO state.
10757 If the last change removed the TODO tag or switched to DONE, then
10758 this is nil.")
10760 (defvar org-setting-tags nil) ; dynamically skipped
10762 (defvar org-todo-setup-filter-hook nil
10763 "Hook for functions that pre-filter todo specs.
10764 Each function takes a todo spec and returns either nil or the spec
10765 transformed into canonical form." )
10767 (defvar org-todo-get-default-hook nil
10768 "Hook for functions that get a default item for todo.
10769 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10770 nil or a string to be used for the todo mark." )
10772 (defvar org-agenda-headline-snapshot-before-repeat)
10774 (defun org-todo (&optional arg)
10775 "Change the TODO state of an item.
10776 The state of an item is given by a keyword at the start of the heading,
10777 like
10778 *** TODO Write paper
10779 *** DONE Call mom
10781 The different keywords are specified in the variable `org-todo-keywords'.
10783 So for this example: when the item starts with TODO, it is changed to DONE.
10784 When it starts with DONE, the DONE is removed. And when neither TODO nor
10785 DONE are present, add TODO at the beginning of the heading.
10788 state.
10789 With numeric prefix arg, switch to that state.
10791 keywords (nextset).
10794 For calling through lisp, arg is also interpreted in the following way:
10795 'none -> empty state
10797 'done -> switch to DONE
10798 'nextset -> switch to the next set of keywords
10799 'previousset -> switch to the previous set of keywords
10801 really is a member of `org-todo-keywords'."
10802 (interactive "P")
10803 (if (equal arg '(16)) (setq arg 'nextset))
10804 (let ((org-blocker-hook org-blocker-hook)
10805 (case-fold-search nil))
10806 (when (equal arg '(64))
10807 (setq arg nil org-blocker-hook nil))
10808 (when (and org-blocker-hook
10809 (or org-inhibit-blocking
10810 (org-entry-get nil "NOBLOCKING")))
10811 (setq org-blocker-hook nil))
10812 (save-excursion
10813 (catch 'exit
10814 (org-back-to-heading t)
10815 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10817 (looking-at " *"))
10818 (let* ((match-data (match-data))
10819 (startpos (point-at-bol))
10820 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10821 (org-log-done org-log-done)
10822 (org-log-repeat org-log-repeat)
10823 (org-todo-log-states org-todo-log-states)
10824 (this (match-string 1))
10825 (hl-pos (match-beginning 0))
10826 (head (org-get-todo-sequence-head this))
10827 (ass (assoc head org-todo-kwd-alist))
10828 (interpret (nth 1 ass))
10829 (done-word (nth 3 ass))
10830 (final-done-word (nth 4 ass))
10831 (last-state (or this ""))
10832 (completion-ignore-case t)
10833 (member (member this org-todo-keywords-1))
10834 (tail (cdr member))
10835 (state (cond
10836 ((and org-todo-key-trigger
10837 (or (and (equal arg '(4))
10838 (eq org-use-fast-todo-selection 'prefix))
10839 (and (not arg) org-use-fast-todo-selection
10840 (not (eq org-use-fast-todo-selection
10841 'prefix)))))
10842 ;; Use fast selection
10843 (org-fast-todo-selection))
10844 ((and (equal arg '(4))
10845 (or (not org-use-fast-todo-selection)
10846 (not org-todo-key-trigger)))
10847 ;; Read a state with completion
10848 (org-icompleting-read
10849 "State: " (mapcar (lambda(x) (list x))
10850 org-todo-keywords-1)
10851 nil t))
10852 ((eq arg 'right)
10853 (if this
10854 (if tail (car tail) nil)
10855 (car org-todo-keywords-1)))
10856 ((eq arg 'left)
10857 (if (equal member org-todo-keywords-1)
10858 nil
10859 (if this
10860 (nth (- (length org-todo-keywords-1)
10861 (length tail) 2)
10862 org-todo-keywords-1)
10863 (org-last org-todo-keywords-1))))
10864 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10865 (setq arg nil))) ; hack to fall back to cycling
10866 (arg
10867 ;; user or caller requests a specific state
10868 (cond
10869 ((equal arg "") nil)
10870 ((eq arg 'none) nil)
10871 ((eq arg 'done) (or done-word (car org-done-keywords)))
10872 ((eq arg 'nextset)
10873 (or (car (cdr (member head org-todo-heads)))
10874 (car org-todo-heads)))
10875 ((eq arg 'previousset)
10876 (let ((org-todo-heads (reverse org-todo-heads)))
10877 (or (car (cdr (member head org-todo-heads)))
10878 (car org-todo-heads))))
10879 ((car (member arg org-todo-keywords-1)))
10880 ((stringp arg)
10881 (error "State `%s' not valid in this file" arg))
10882 ((nth (1- (prefix-numeric-value arg))
10883 org-todo-keywords-1))))
10884 ((null member) (or head (car org-todo-keywords-1)))
10885 ((equal this final-done-word) nil) ;; -> make empty
10886 ((null tail) nil) ;; -> first entry
10887 ((memq interpret '(type priority))
10888 (if (eq this-command last-command)
10889 (car tail)
10890 (if (> (length tail) 0)
10891 (or done-word (car org-done-keywords))
10892 nil)))
10893 (t
10894 (car tail))))
10895 (state (or
10896 (run-hook-with-args-until-success
10897 'org-todo-get-default-hook state last-state)
10898 state))
10899 (next (if state (concat " " state " ") " "))
10900 (change-plist (list :type 'todo-state-change :from this :to state
10901 :position startpos))
10902 dolog now-done-p)
10903 (when org-blocker-hook
10904 (setq org-last-todo-state-is-todo
10905 (not (member this org-done-keywords)))
10906 (unless (save-excursion
10907 (save-match-data
10908 (run-hook-with-args-until-failure
10909 'org-blocker-hook change-plist)))
10910 (if (interactive-p)
10911 (error "TODO state change from %s to %s blocked" this state)
10912 ;; fail silently
10913 (message "TODO state change from %s to %s blocked" this state)
10914 (throw 'exit nil))))
10915 (store-match-data match-data)
10916 (replace-match next t t)
10917 (unless (pos-visible-in-window-p hl-pos)
10918 (message "TODO state changed to %s" (org-trim next)))
10919 (unless head
10920 (setq head (org-get-todo-sequence-head state)
10921 ass (assoc head org-todo-kwd-alist)
10922 interpret (nth 1 ass)
10923 done-word (nth 3 ass)
10924 final-done-word (nth 4 ass)))
10925 (when (memq arg '(nextset previousset))
10926 (message "Keyword-Set %d/%d: %s"
10927 (- (length org-todo-sets) -1
10928 (length (memq (assoc state org-todo-sets) org-todo-sets)))
10929 (length org-todo-sets)
10930 (mapconcat 'identity (assoc state org-todo-sets) " ")))
10931 (setq org-last-todo-state-is-todo
10932 (not (member state org-done-keywords)))
10933 (setq now-done-p (and (member state org-done-keywords)
10934 (not (member this org-done-keywords))))
10935 (and logging (org-local-logging logging))
10936 (when (and (or org-todo-log-states org-log-done)
10937 (not (eq org-inhibit-logging t))
10938 (not (memq arg '(nextset previousset))))
10939 ;; we need to look at recording a time and note
10940 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
10941 (nth 2 (assoc this org-todo-log-states))))
10942 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
10943 (setq dolog 'time))
10944 (when (and state
10945 (member state org-not-done-keywords)
10946 (not (member this org-not-done-keywords)))
10947 ;; This is now a todo state and was not one before
10948 ;; If there was a CLOSED time stamp, get rid of it.
10949 (org-add-planning-info nil nil 'closed))
10950 (when (and now-done-p org-log-done)
10951 ;; It is now done, and it was not done before
10952 (org-add-planning-info 'closed (org-current-time))
10953 (if (and (not dolog) (eq 'note org-log-done))
10954 (org-add-log-setup 'done state this 'findpos 'note)))
10955 (when (and state dolog)
10956 ;; This is a non-nil state, and we need to log it
10957 (org-add-log-setup 'state state this 'findpos dolog)))
10958 ;; Fixup tag positioning
10959 (org-todo-trigger-tag-changes state)
10960 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
10961 (when org-provide-todo-statistics
10962 (org-update-parent-todo-statistics))
10963 (run-hooks 'org-after-todo-state-change-hook)
10964 (if (and arg (not (member state org-done-keywords)))
10965 (setq head (org-get-todo-sequence-head state)))
10966 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
10967 ;; Do we need to trigger a repeat?
10968 (when now-done-p
10969 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
10970 ;; This is for the agenda, take a snapshot of the headline.
10971 (save-match-data
10972 (setq org-agenda-headline-snapshot-before-repeat
10973 (org-get-heading))))
10974 (org-auto-repeat-maybe state))
10975 ;; Fixup cursor location if close to the keyword
10976 (if (and (outline-on-heading-p)
10977 (not (bolp))
10978 (save-excursion (beginning-of-line 1)
10979 (looking-at org-todo-line-regexp))
10980 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
10981 (progn
10982 (goto-char (or (match-end 2) (match-end 1)))
10983 (and (looking-at " ") (just-one-space))))
10984 (when org-trigger-hook
10985 (save-excursion
10986 (run-hook-with-args 'org-trigger-hook change-plist))))))))
10988 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
10989 "Block turning an entry into a TODO, using the hierarchy.
10990 This checks whether the current task should be blocked from state
10991 changes. Such blocking occurs when:
10993 1. The task has children which are not all in a completed state.
10995 2. A task has a parent with the property :ORDERED:, and there
10996 are siblings prior to the current task with incomplete
10997 status.
10999 3. The parent of the task is blocked because it has siblings that should
11000 be done first, or is child of a block grandparent TODO entry."
11002 (if (not org-enforce-todo-dependencies)
11003 t ; if locally turned off don't block
11004 (catch 'dont-block
11005 ;; If this is not a todo state change, or if this entry is already DONE,
11006 ;; do not block
11007 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11008 (member (plist-get change-plist :from)
11009 (cons 'done org-done-keywords))
11010 (member (plist-get change-plist :to)
11011 (cons 'todo org-not-done-keywords))
11012 (not (plist-get change-plist :to)))
11013 (throw 'dont-block t))
11014 ;; If this task has children, and any are undone, it's blocked
11015 (save-excursion
11016 (org-back-to-heading t)
11017 (let ((this-level (funcall outline-level)))
11018 (outline-next-heading)
11019 (let ((child-level (funcall outline-level)))
11020 (while (and (not (eobp))
11021 (> child-level this-level))
11022 ;; this todo has children, check whether they are all
11023 ;; completed
11024 (if (and (not (org-entry-is-done-p))
11025 (org-entry-is-todo-p))
11026 (throw 'dont-block nil))
11027 (outline-next-heading)
11028 (setq child-level (funcall outline-level))))))
11029 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11030 ;; any previous siblings are undone, it's blocked
11031 (save-excursion
11032 (org-back-to-heading t)
11033 (let* ((pos (point))
11034 (parent-pos (and (org-up-heading-safe) (point))))
11035 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11036 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11037 (forward-line 1)
11038 (re-search-forward org-not-done-heading-regexp pos t))
11039 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11040 ;; Search further up the hierarchy, to see if an anchestor is blocked
11041 (while t
11042 (goto-char parent-pos)
11043 (if (not (looking-at org-not-done-heading-regexp))
11044 (throw 'dont-block t)) ; do not block, parent is not a TODO
11045 (setq pos (point))
11046 (setq parent-pos (and (org-up-heading-safe) (point)))
11047 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11048 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11049 (forward-line 1)
11050 (re-search-forward org-not-done-heading-regexp pos t))
11051 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11053 (defcustom org-track-ordered-property-with-tag nil
11054 "Should the ORDERED property also be shown as a tag?
11055 The ORDERED property decides if an entry should require subtasks to be
11056 completed in sequence. Since a property is not very visible, setting
11057 this option means that toggling the ORDERED property with the command
11058 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11059 not relevant for the behavior, but it makes things more visible.
11061 Note that toggling the tag with tags commands will not change the property
11062 and therefore not influence behavior!
11064 This can be t, meaning the tag ORDERED should be used, It can also be a
11065 string to select a different tag for this task."
11066 :group 'org-todo
11067 :type '(choice
11068 (const :tag "No tracking" nil)
11069 (const :tag "Track with ORDERED tag" t)
11070 (string :tag "Use other tag")))
11072 (defun org-toggle-ordered-property ()
11073 "Toggle the ORDERED property of the current entry.
11074 For better visibility, you can track the value of this property with a tag.
11075 See variable `org-track-ordered-property-with-tag'."
11076 (interactive)
11077 (let* ((t1 org-track-ordered-property-with-tag)
11078 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11079 (save-excursion
11080 (org-back-to-heading)
11081 (if (org-entry-get nil "ORDERED")
11082 (progn
11083 (org-delete-property "ORDERED")
11084 (and tag (org-toggle-tag tag 'off))
11085 (message "Subtasks can be completed in arbitrary order"))
11086 (org-entry-put nil "ORDERED" "t")
11087 (and tag (org-toggle-tag tag 'on))
11088 (message "Subtasks must be completed in sequence")))))
11090 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11091 (defun org-block-todo-from-checkboxes (change-plist)
11092 "Block turning an entry into a TODO, using checkboxes.
11093 This checks whether the current task should be blocked from state
11094 changes because there are unchecked boxes in this entry."
11095 (if (not org-enforce-todo-checkbox-dependencies)
11096 t ; if locally turned off don't block
11097 (catch 'dont-block
11098 ;; If this is not a todo state change, or if this entry is already DONE,
11099 ;; do not block
11100 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11101 (member (plist-get change-plist :from)
11102 (cons 'done org-done-keywords))
11103 (member (plist-get change-plist :to)
11104 (cons 'todo org-not-done-keywords))
11105 (not (plist-get change-plist :to)))
11106 (throw 'dont-block t))
11107 ;; If this task has checkboxes that are not checked, it's blocked
11108 (save-excursion
11109 (org-back-to-heading t)
11110 (let ((beg (point)) end)
11111 (outline-next-heading)
11112 (setq end (point))
11113 (goto-char beg)
11115 end t)
11116 (progn
11117 (if (boundp 'org-blocked-by-checkboxes)
11118 (setq org-blocked-by-checkboxes t))
11119 (throw 'dont-block nil)))))
11120 t))) ; do not block
11122 (defun org-entry-blocked-p ()
11123 "Is the current entry blocked?"
11124 (if (org-entry-get nil "NOBLOCKING")
11125 nil ;; Never block this entry
11126 (not
11127 (run-hook-with-args-until-failure
11128 'org-blocker-hook
11129 (list :type 'todo-state-change
11130 :position (point)
11131 :from 'todo
11132 :to 'done)))))
11134 (defun org-update-statistics-cookies (all)
11135 "Update the statistics cookie, either from TODO or from checkboxes.
11136 This should be called with the cursor in a line with a statistics cookie."
11137 (interactive "P")
11138 (if all
11139 (progn
11140 (org-update-checkbox-count 'all)
11141 (org-map-entries 'org-update-parent-todo-statistics))
11142 (if (not (org-on-heading-p))
11143 (org-update-checkbox-count)
11144 (let ((pos (move-marker (make-marker) (point)))
11145 end l1 l2)
11146 (ignore-errors (org-back-to-heading t))
11147 (if (not (org-on-heading-p))
11148 (org-update-checkbox-count)
11149 (setq l1 (org-outline-level))
11150 (setq end (save-excursion
11151 (outline-next-heading)
11152 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11153 (point)))
11154 (if (and (save-excursion
11155 (re-search-forward
11157 (not (save-excursion (re-search-forward
11159 (org-update-checkbox-count)
11160 (if (and l2 (> l2 l1))
11161 (progn
11162 (goto-char end)
11163 (org-update-parent-todo-statistics))
11164 (goto-char pos)
11165 (beginning-of-line 1)
11166 (while (re-search-forward
11168 (point-at-eol) t)
11169 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11170 (goto-char pos)
11171 (move-marker pos nil)))))
11173 (defvar org-entry-property-inherited-from) ;; defined below
11174 (defun org-update-parent-todo-statistics ()
11175 "Update any statistics cookie in the parent of the current headline.
11176 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11177 the entire subtree and this will travel up the hierarchy and update
11178 statistics everywhere."
11179 (interactive)
11180 (let* ((lim 0) prop
11181 (recursive (or (not org-hierarchical-todo-statistics)
11182 (string-match
11184 (or (setq prop (org-entry-get
11185 nil "COOKIE_DATA" 'inherit)) ""))))
11186 (lim (or (and prop (marker-position
11187 org-entry-property-inherited-from))
11188 lim))
11189 (first t)
11191 level ltoggle l1 new ndel
11192 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
11193 (catch 'exit
11194 (save-excursion
11195 (beginning-of-line 1)
11196 (if (org-at-heading-p)
11197 (setq ltoggle (funcall outline-level))
11198 (error "This should not happen"))
11199 (while (and (setq level (org-up-heading-safe))
11200 (or recursive first)
11201 (>= (point) lim))
11202 (setq first nil cookie-present nil)
11203 (unless (and level
11204 (not (string-match
11206 (downcase
11207 (or (org-entry-get
11208 nil "COOKIE_DATA")
11209 "")))))
11210 (throw 'exit nil))
11211 (while (re-search-forward box-re (point-at-eol) t)
11212 (setq cnt-all 0 cnt-done 0 cookie-present t)
11213 (setq is-percent (match-end 2))
11214 (save-match-data
11215 (unless (outline-next-heading) (throw 'exit nil))
11216 (while (and (looking-at org-complex-heading-regexp)
11217 (> (setq l1 (length (match-string 1))) level))
11218 (setq kwd (and (or recursive (= l1 ltoggle))
11219 (match-string 2)))
11220 (if (or (eq org-provide-todo-statistics 'all-headlines)
11221 (and (listp org-provide-todo-statistics)
11222 (or (member kwd org-provide-todo-statistics)
11223 (member kwd org-done-keywords))))
11224 (setq cnt-all (1+ cnt-all))
11225 (if (eq org-provide-todo-statistics t)
11226 (and kwd (setq cnt-all (1+ cnt-all)))))
11227 (and (member kwd org-done-keywords)
11228 (setq cnt-done (1+ cnt-done)))
11229 (outline-next-heading)))
11230 (setq new
11231 (if is-percent
11232 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11233 (format "[%d/%d]" cnt-done cnt-all))
11234 ndel (- (match-end 0) (match-beginning 0)))
11235 (goto-char (match-beginning 0))
11236 (insert new)
11237 (delete-region (point) (+ (point) ndel)))
11238 (when cookie-present
11239 (run-hook-with-args 'org-after-todo-statistics-hook
11240 cnt-done (- cnt-all cnt-done))))))
11241 (run-hooks 'org-todo-statistics-hook)))
11243 (defvar org-after-todo-statistics-hook nil
11244 "Hook that is called after a TODO statistics cookie has been updated.
11245 Each function is called with two arguments: the number of not-done entries
11246 and the number of done entries.
11248 For example, the following function, when added to this hook, will switch
11249 an entry to DONE when all children are done, and back to TODO when new
11250 entries are set to a TODO status. Note that this hook is only called
11251 when there is a statistics cookie in the headline!
11253 (defun org-summary-todo (n-done n-not-done)
11255 (let (org-log-done org-log-states) ; turn off logging
11257 ")
11259 (defvar org-todo-statistics-hook nil
11260 "Hook that is run whenever Org thinks TODO statistics should be updated.
11261 This hook runs even if there is no statistics cookie present, in which case
11262 `org-after-todo-statistics-hook' would not run.")
11264 (defun org-todo-trigger-tag-changes (state)
11265 "Apply the changes defined in `org-todo-state-tags-triggers'."
11266 (let ((l org-todo-state-tags-triggers)
11267 changes)
11268 (when (or (not state) (equal state ""))
11269 (setq changes (append changes (cdr (assoc "" l)))))
11270 (when (and (stringp state) (> (length state) 0))
11271 (setq changes (append changes (cdr (assoc state l)))))
11272 (when (member state org-not-done-keywords)
11273 (setq changes (append changes (cdr (assoc 'todo l)))))
11274 (when (member state org-done-keywords)
11275 (setq changes (append changes (cdr (assoc 'done l)))))
11276 (dolist (c changes)
11277 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11279 (defun org-local-logging (value)
11280 "Get logging settings from a property VALUE."
11281 (let* (words w a)
11282 ;; directly set the variables, they are already local.
11283 (setq org-log-done nil
11284 org-log-repeat nil
11285 org-todo-log-states nil)
11286 (setq words (org-split-string value))
11287 (while (setq w (pop words))
11288 (cond
11289 ((setq a (assoc w org-startup-options))
11290 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11291 (set (nth 1 a) (nth 2 a))))
11292 ((setq a (org-extract-log-state-settings w))
11293 (and (member (car a) org-todo-keywords-1)
11294 (push a org-todo-log-states)))))))
11296 (defun org-get-todo-sequence-head (kwd)
11297 "Return the head of the TODO sequence to which KWD belongs.
11298 If KWD is not set, check if there is a text property remembering the
11299 right sequence."
11300 (let (p)
11301 (cond
11302 ((not kwd)
11303 (or (get-text-property (point-at-bol) 'org-todo-head)
11304 (progn
11305 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11306 nil (point-at-eol)))
11307 (get-text-property p 'org-todo-head))))
11308 ((not (member kwd org-todo-keywords-1))
11309 (car org-todo-keywords-1))
11310 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11312 (defun org-fast-todo-selection ()
11313 "Fast TODO keyword selection with single keys.
11314 Returns the new TODO keyword, or nil if no state change should occur."
11315 (let* ((fulltable org-todo-key-alist)
11316 (done-keywords org-done-keywords) ;; needed for the faces.
11317 (maxlen (apply 'max (mapcar
11318 (lambda (x)
11319 (if (stringp (car x)) (string-width (car x)) 0))
11320 fulltable)))
11321 (expert nil)
11322 (fwidth (+ maxlen 3 1 3))
11323 (ncol (/ (- (window-width) 4) fwidth))
11324 tg cnt e c tbl
11325 groups ingroup)
11326 (save-excursion
11327 (save-window-excursion
11328 (if expert
11329 (set-buffer (get-buffer-create " *Org todo*"))
11330 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11331 (erase-buffer)
11332 (org-set-local 'org-done-keywords done-keywords)
11333 (setq tbl fulltable cnt 0)
11334 (while (setq e (pop tbl))
11335 (cond
11336 ((equal e '(:startgroup))
11337 (push '() groups) (setq ingroup t)
11338 (when (not (= cnt 0))
11339 (setq cnt 0)
11341 (insert "{ "))
11342 ((equal e '(:endgroup))
11343 (setq ingroup nil cnt 0)
11345 ((equal e '(:newline))
11346 (when (not (= cnt 0))
11347 (setq cnt 0)
11349 (setq e (car tbl))
11350 (while (equal (car tbl) '(:newline))
11352 (setq tbl (cdr tbl)))))
11353 (t
11354 (setq tg (car e) c (cdr e))
11355 (if ingroup (push tg (car groups)))
11356 (setq tg (org-add-props tg nil 'face
11357 (org-get-todo-face tg)))
11358 (if (and (= cnt 0) (not ingroup)) (insert " "))
11359 (insert "[" c "] " tg (make-string
11360 (- fwidth 4 (length tg)) ?\ ))
11361 (when (= (setq cnt (1+ cnt)) ncol)
11363 (if ingroup (insert " "))
11364 (setq cnt 0)))))
11366 (goto-char (point-min))
11367 (if (not expert) (org-fit-window-to-buffer))
11368 (message "[a-z..]:Set [SPC]:clear")
11369 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11370 (cond
11371 ((or (= c ?\C-g)
11372 (and (= c ?q) (not (rassoc c fulltable))))
11373 (setq quit-flag t))
11374 ((= c ?\ ) nil)
11375 ((setq e (rassoc c fulltable) tg (car e))
11376 tg)
11377 (t (setq quit-flag t)))))))
11379 (defun org-entry-is-todo-p ()
11380 (member (org-get-todo-state) org-not-done-keywords))
11382 (defun org-entry-is-done-p ()
11383 (member (org-get-todo-state) org-done-keywords))
11385 (defun org-get-todo-state ()
11386 (save-excursion
11387 (org-back-to-heading t)
11388 (and (looking-at org-todo-line-regexp)
11389 (match-end 2)
11390 (match-string 2))))
11392 (defun org-at-date-range-p (&optional inactive-ok)
11393 "Is the cursor inside a date range?"
11394 (interactive)
11395 (save-excursion
11396 (catch 'exit
11397 (let ((pos (point)))
11399 (skip-chars-backward "<[")
11400 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11401 (>= (match-end 0) pos)
11402 (throw 'exit t))
11404 (skip-chars-backward "<[")
11405 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11406 (>= (match-end 0) pos)
11407 (throw 'exit t)))
11408 nil)))
11410 (defun org-get-repeat (&optional tagline)
11411 "Check if there is a deadline/schedule with repeater in this entry."
11412 (save-match-data
11413 (save-excursion
11414 (org-back-to-heading t)
11415 (and (re-search-forward (if tagline
11417 org-repeat-re)
11418 (org-entry-end-position) t)
11419 (match-string-no-properties 1)))))
11421 (defvar org-last-changed-timestamp)
11422 (defvar org-last-inserted-timestamp)
11423 (defvar org-log-post-message)
11424 (defvar org-log-note-purpose)
11425 (defvar org-log-note-how)
11426 (defvar org-log-note-extra)
11427 (defun org-auto-repeat-maybe (done-word)
11428 "Check if the current headline contains a repeated deadline/schedule.
11429 If yes, set TODO state back to what it was and change the base date
11430 of repeating deadline/scheduled time stamps to new date.
11431 This function is run automatically after each state change to a DONE state."
11432 ;; last-state is dynamically scoped into this function
11433 (let* ((repeat (org-get-repeat))
11434 (aa (assoc last-state org-todo-kwd-alist))
11435 (interpret (nth 1 aa))
11436 (head (nth 2 aa))
11437 (whata '(("d" . day) ("m" . month) ("y" . year)))
11438 (msg "Entry repeats: ")
11439 (org-log-done nil)
11440 (org-todo-log-states nil)
11441 (nshiftmax 10) (nshift 0)
11442 re type n what ts time to-state)
11443 (when repeat
11444 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11445 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11446 org-todo-repeat-to-state))
11447 (unless (and to-state (member to-state org-todo-keywords-1))
11448 (setq to-state (if (eq interpret 'type) last-state head)))
11449 (org-todo to-state)
11450 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11451 (org-entry-put nil "LAST_REPEAT" (format-time-string
11452 (org-time-stamp-format t t))))
11453 (when org-log-repeat
11454 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11455 (memq 'org-add-log-note post-command-hook))
11456 ;; OK, we are already setup for some record
11457 (if (eq org-log-repeat 'note)
11458 ;; make sure we take a note, not only a time stamp
11459 (setq org-log-note-how 'note))
11460 ;; Set up for taking a record
11461 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11462 last-state
11463 'findpos org-log-repeat)))
11464 (org-back-to-heading t)
11465 (org-add-planning-info nil nil 'closed)
11469 (while (re-search-forward
11470 re (save-excursion (outline-next-heading) (point)) t)
11471 (setq type (if (match-end 1) org-scheduled-string
11472 (if (match-end 3) org-deadline-string "Plain:"))
11473 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11475 (setq n (string-to-number (match-string 2 ts))
11476 what (match-string 3 ts))
11477 (if (equal what "w") (setq n (* n 7) what "d"))
11478 ;; Preparation, see if we need to modify the start date for the change
11479 (when (match-end 1)
11480 (setq time (save-match-data (org-time-string-to-time ts)))
11481 (cond
11482 ((equal (match-string 1 ts) ".")
11483 ;; Shift starting date to today
11484 (org-timestamp-change
11485 (- (time-to-days (current-time)) (time-to-days time))
11486 'day))
11487 ((equal (match-string 1 ts) "+")
11488 (while (or (= nshift 0)
11489 (<= (time-to-days time) (time-to-days (current-time))))
11490 (when (= (incf nshift) nshiftmax)
11491 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11492 (error "Abort")))
11493 (org-timestamp-change n (cdr (assoc what whata)))
11494 (org-at-timestamp-p t)
11495 (setq ts (match-string 1))
11496 (setq time (save-match-data (org-time-string-to-time ts))))
11497 (org-timestamp-change (- n) (cdr (assoc what whata)))
11498 ;; rematch, so that we have everything in place for the real shift
11499 (org-at-timestamp-p t)
11500 (setq ts (match-string 1))
11502 (org-timestamp-change n (cdr (assoc what whata)))
11503 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11504 (setq org-log-post-message msg)
11505 (message "%s" msg))))
11507 (defun org-show-todo-tree (arg)
11508 "Make a compact tree which shows all headlines marked with TODO.
11509 The tree will show the lines where the regexp matches, and all higher
11510 headlines above the match.
11512 With a numeric prefix N, construct a sparse tree for the Nth element
11513 of `org-todo-keywords-1'."
11514 (interactive "P")
11515 (let ((case-fold-search nil)
11516 (kwd-re
11517 (cond ((null arg) org-not-done-regexp)
11518 ((equal arg '(4))
11519 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11520 (mapcar 'list org-todo-keywords-1))))
11524 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11525 (regexp-quote (nth (1- (prefix-numeric-value arg))
11526 org-todo-keywords-1)))
11527 (t (error "Invalid prefix argument: %s" arg)))))
11528 (message "%d TODO entries found"
11529 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
11531 (defun org-deadline (&optional remove time)
11533 With argument REMOVE, remove any deadline from the item.
11534 When TIME is set, it should be an internal time specification, and the
11535 scheduling will use the corresponding date."
11536 (interactive "P")
11537 (let* ((old-date (org-entry-get nil "DEADLINE"))
11538 (repeater (and old-date
11540 (match-string 1 old-date))))
11541 (if remove
11542 (progn
11543 (when (and old-date org-log-redeadline)
11544 (org-add-log-setup 'deldeadline nil old-date 'findpos
11545 org-log-redeadline))
11546 (org-remove-timestamp-with-keyword org-deadline-string)
11547 (message "Item no longer has a deadline."))
11548 (org-add-planning-info 'deadline time 'closed)
11549 (when (and old-date org-log-redeadline
11550 (not (equal old-date
11551 (substring org-last-inserted-timestamp 1 -1))))
11552 (org-add-log-setup 'redeadline nil old-date 'findpos
11553 org-log-redeadline))
11554 (when repeater
11555 (save-excursion
11556 (org-back-to-heading t)
11557 (when (re-search-forward (concat org-deadline-string " "
11558 org-last-inserted-timestamp)
11559 (save-excursion
11560 (outline-next-heading) (point)) t)
11561 (goto-char (1- (match-end 0)))
11562 (insert " " repeater)
11563 (setq org-last-inserted-timestamp
11564 (concat (substring org-last-inserted-timestamp 0 -1)
11565 " " repeater
11566 (substring org-last-inserted-timestamp -1))))))
11567 (message "Deadline on %s" org-last-inserted-timestamp))))
11569 (defun org-schedule (&optional remove time)
11570 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11571 With argument REMOVE, remove any scheduling date from the item.
11572 When TIME is set, it should be an internal time specification, and the
11573 scheduling will use the corresponding date."
11574 (interactive "P")
11575 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11576 (repeater (and old-date
11578 (match-string 1 old-date))))
11579 (if remove
11580 (progn
11581 (when (and old-date org-log-reschedule)
11582 (org-add-log-setup 'delschedule nil old-date 'findpos
11583 org-log-reschedule))
11584 (org-remove-timestamp-with-keyword org-scheduled-string)
11585 (message "Item is no longer scheduled."))
11586 (org-add-planning-info 'scheduled time 'closed)
11587 (when (and old-date org-log-reschedule
11588 (not (equal old-date
11589 (substring org-last-inserted-timestamp 1 -1))))
11590 (org-add-log-setup 'reschedule nil old-date 'findpos
11591 org-log-reschedule))
11592 (when repeater
11593 (save-excursion
11594 (org-back-to-heading t)
11595 (when (re-search-forward (concat org-scheduled-string " "
11596 org-last-inserted-timestamp)
11597 (save-excursion
11598 (outline-next-heading) (point)) t)
11599 (goto-char (1- (match-end 0)))
11600 (insert " " repeater)
11601 (setq org-last-inserted-timestamp
11602 (concat (substring org-last-inserted-timestamp 0 -1)
11603 " " repeater
11604 (substring org-last-inserted-timestamp -1))))))
11605 (message "Scheduled to %s" org-last-inserted-timestamp))))
11607 (defun org-get-scheduled-time (pom &optional inherit)
11608 "Get the scheduled time as a time tuple, of a format suitable
11609 for calling org-schedule with, or if there is no scheduling,
11610 returns nil."
11611 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11612 (when time
11613 (apply 'encode-time (org-parse-time-string time)))))
11615 (defun org-get-deadline-time (pom &optional inherit)
11616 "Get the deadline as a time tuple, of a format suitable for
11617 calling org-deadline with, or if there is no scheduling, returns
11618 nil."
11619 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11620 (when time
11621 (apply 'encode-time (org-parse-time-string time)))))
11623 (defun org-remove-timestamp-with-keyword (keyword)
11624 "Remove all time stamps with KEYWORD in the current entry."
11626 beg)
11627 (save-excursion
11628 (org-back-to-heading t)
11629 (setq beg (point))
11630 (outline-next-heading)
11631 (while (re-search-backward re beg t)
11632 (replace-match "")
11634 (equal (char-before) ?\ ))
11635 (backward-delete-char 1)
11637 (point-at-bol) (point-at-eol)))
11638 (delete-region (point-at-bol)
11639 (min (point-max) (1+ (point-at-eol))))))))))
11641 (defun org-add-planning-info (what &optional time &rest remove)
11642 "Insert new timestamp with keyword in the line directly after the headline.
11643 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11644 If non is given, the user is prompted for a date.
11645 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11646 be removed."
11647 (interactive)
11648 (let (org-time-was-given org-end-time-was-given ts
11649 end default-time default-input)
11651 (catch 'exit
11652 (when (and (not time) (memq what '(scheduled deadline)))
11653 ;; Try to get a default date/time from existing timestamp
11654 (save-excursion
11655 (org-back-to-heading t)
11656 (setq end (save-excursion (outline-next-heading) (point)))
11657 (when (re-search-forward (if (eq what 'scheduled)
11658 org-scheduled-time-regexp
11659 org-deadline-time-regexp)
11660 end t)
11661 (setq ts (match-string 1)
11662 default-time
11663 (apply 'encode-time (org-parse-time-string ts))
11664 default-input (and ts (org-get-compact-tod ts))))))
11665 (when what
11666 ;; If necessary, get the time from the user
11667 (setq time (or time (org-read-date nil 'to-time nil nil
11668 default-time default-input))))
11670 (when (and org-insert-labeled-timestamps-at-point
11671 (member what '(scheduled deadline)))
11672 (insert
11673 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11674 (org-insert-time-stamp time org-time-was-given
11675 nil nil nil (list org-end-time-was-given))
11676 (setq what nil))
11677 (save-excursion
11678 (save-restriction
11679 (let (col list elt ts buffer-invisibility-spec)
11680 (org-back-to-heading t)
11682 (goto-char (match-end 1))
11683 (setq col (current-column))
11684 (goto-char (match-end 0))
11686 (when (and (not what)
11687 (not (looking-at
11689 org-keyword-time-not-clock-regexp))))
11690 ;; Nothing to add, nothing to remove...... :-)
11691 (throw 'exit nil))
11692 (if (and (not (looking-at outline-regexp))
11695 (not (equal (match-string 1) org-clock-string)))
11696 (narrow-to-region (match-beginning 0) (match-end 0))
11698 (backward-char 1)
11699 (narrow-to-region (point) (point))
11700 (and org-adapt-indentation (org-indent-to-column col)))
11701 ;; Check if we have to remove something.
11702 (setq list (cons what remove))
11703 (while list
11704 (setq elt (pop list))
11705 (goto-char (point-min))
11706 (when (or (and (eq elt 'scheduled)
11707 (re-search-forward org-scheduled-time-regexp nil t))
11708 (and (eq elt 'deadline)
11709 (re-search-forward org-deadline-time-regexp nil t))
11710 (and (eq elt 'closed)
11711 (re-search-forward org-closed-time-regexp nil t)))
11712 (replace-match "")
11713 (if (looking-at "--+<[^>]+>") (replace-match ""))
11714 (skip-chars-backward " ")
11715 (if (looking-at " +") (replace-match ""))))
11716 (goto-char (point-max))
11717 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11718 (when what
11719 (insert
11720 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11721 (cond ((eq what 'scheduled) org-scheduled-string)
11722 ((eq what 'deadline) org-deadline-string)
11723 ((eq what 'closed) org-closed-string))
11724 " ")
11725 (setq ts (org-insert-time-stamp
11726 time
11727 (or org-time-was-given
11728 (and (eq what 'closed) org-log-done-with-time))
11729 (eq what 'closed)
11730 nil nil (list org-end-time-was-given)))
11731 (end-of-line 1))
11732 (goto-char (point-min))
11733 (widen)
11736 (delete-region (1- (point)) (point-at-eol)))
11737 ts))))))
11739 (defvar org-log-note-marker (make-marker))
11740 (defvar org-log-note-purpose nil)
11741 (defvar org-log-note-state nil)
11742 (defvar org-log-note-previous-state nil)
11743 (defvar org-log-note-how nil)
11744 (defvar org-log-note-extra nil)
11745 (defvar org-log-note-window-configuration nil)
11746 (defvar org-log-note-return-to (make-marker))
11747 (defvar org-log-post-message nil
11748 "Message to be displayed after a log note has been stored.
11749 The auto-repeater uses this.")
11751 (defun org-add-note ()
11752 "Add a note to the current entry.
11753 This is done in the same way as adding a state change note."
11754 (interactive)
11755 (org-add-log-setup 'note nil nil 'findpos nil))
11757 (defvar org-property-end-re)
11758 (defun org-add-log-setup (&optional purpose state prev-state
11759 findpos how extra)
11760 "Set up the post command hook to take a note.
11761 If this is about to TODO state change, the new state is expected in STATE.
11762 When FINDPOS is non-nil, find the correct position for the note in
11763 the current entry. If not, assume that it can be inserted at point.
11764 HOW is an indicator what kind of note should be created.
11765 EXTRA is additional text that will be inserted into the notes buffer."
11766 (let* ((org-log-into-drawer (org-log-into-drawer))
11767 (drawer (cond ((stringp org-log-into-drawer)
11768 org-log-into-drawer)
11769 (org-log-into-drawer "LOGBOOK")
11770 (t nil))))
11771 (save-restriction
11772 (save-excursion
11773 (when findpos
11774 (org-back-to-heading t)
11775 (narrow-to-region (point) (save-excursion
11776 (outline-next-heading) (point)))
11780 (goto-char (match-end 0))
11781 (cond
11782 (drawer
11784 nil t)
11785 (progn
11786 (goto-char (match-end 0))
11787 (or org-log-states-order-reversed
11788 (and (re-search-forward org-property-end-re nil t)
11789 (goto-char (1- (match-beginning 0))))))
11791 (beginning-of-line 0)
11792 (org-indent-line-function)
11793 (beginning-of-line 2)
11794 (org-indent-line-function)
11795 (end-of-line 0)))
11796 ((and org-log-state-notes-insert-after-drawers
11797 (save-excursion
11798 (forward-line) (looking-at org-drawer-regexp)))
11799 (forward-line)
11800 (while (looking-at org-drawer-regexp)
11801 (goto-char (match-end 0))
11802 (re-search-forward org-property-end-re (point-max) t)
11803 (forward-line))
11804 (forward-line -1)))
11805 (unless org-log-states-order-reversed
11807 (org-skip-over-state-notes)
11809 (move-marker org-log-note-marker (point))
11810 (setq org-log-note-purpose purpose
11811 org-log-note-state state
11812 org-log-note-previous-state prev-state
11813 org-log-note-how how
11814 org-log-note-extra extra)
11815 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11817 (defun org-skip-over-state-notes ()
11818 "Skip past the list of State notes in an entry."
11820 (when (org-in-item-p)
11821 (let ((limit (org-list-bottom-point)))
11823 (goto-char (or (org-get-next-item (point) limit)
11824 (org-get-end-of-item limit)))))))
11826 (defun org-add-log-note (&optional purpose)
11827 "Pop up a window for taking a note, and add this note later at point."
11828 (remove-hook 'post-command-hook 'org-add-log-note)
11829 (setq org-log-note-window-configuration (current-window-configuration))
11830 (delete-other-windows)
11831 (move-marker org-log-note-return-to (point))
11832 (switch-to-buffer (marker-buffer org-log-note-marker))
11833 (goto-char org-log-note-marker)
11834 (org-switch-to-buffer-other-window "*Org Note*")
11835 (erase-buffer)
11836 (if (memq org-log-note-how '(time state))
11837 (let (current-prefix-arg) (org-store-log-note))
11838 (let ((org-inhibit-startup t)) (org-mode))
11839 (insert (format "# Insert note for %s.
11841 (cond
11842 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11843 ((eq org-log-note-purpose 'done) "closed todo item")
11844 ((eq org-log-note-purpose 'state)
11846 (or org-log-note-previous-state "")
11847 (or org-log-note-state "")))
11848 ((eq org-log-note-purpose 'reschedule)
11849 "rescheduling")
11850 ((eq org-log-note-purpose 'delschedule)
11851 "no longer scheduled")
11852 ((eq org-log-note-purpose 'redeadline)
11853 "changing deadline")
11854 ((eq org-log-note-purpose 'deldeadline)
11855 "removing deadline")
11856 ((eq org-log-note-purpose 'refile)
11857 "refiling")
11858 ((eq org-log-note-purpose 'note)
11859 "this entry")
11860 (t (error "This should not happen")))))
11861 (if org-log-note-extra (insert org-log-note-extra))
11862 (org-set-local 'org-finish-function 'org-store-log-note)))
11864 (defvar org-note-abort nil) ; dynamically scoped
11865 (defun org-store-log-note ()
11866 "Finish taking a log note, and insert it to where it belongs."
11867 (let ((txt (buffer-string))
11868 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11869 lines ind bul)
11870 (kill-buffer (current-buffer))
11872 (setq txt (replace-match "" t t txt)))
11874 (setq txt (replace-match "" t t txt)))
11877 (setq note
11878 (org-replace-escapes
11879 note
11880 (list (cons "%u" (user-login-name))
11881 (cons "%U" user-full-name)
11882 (cons "%t" (format-time-string
11883 (org-time-stamp-format 'long 'inactive)
11884 (current-time)))
11885 (cons "%T" (format-time-string
11886 (org-time-stamp-format 'long nil)
11887 (current-time)))
11888 (cons "%s" (if org-log-note-state
11890 ""))
11891 (cons "%S" (if org-log-note-previous-state
11895 (push note lines))
11896 (when (or current-prefix-arg org-note-abort)
11897 (when org-log-into-drawer
11898 (org-remove-empty-drawer-at
11899 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11900 org-log-note-marker))
11901 (setq lines nil))
11902 (when lines
11903 (with-current-buffer (marker-buffer org-log-note-marker)
11904 (save-excursion
11905 (goto-char org-log-note-marker)
11906 (move-marker org-log-note-marker nil)
11907 (end-of-line 1)
11909 (setq ind (save-excursion
11910 (if (org-in-item-p)
11911 (progn
11912 (goto-char (org-list-top-point))
11913 (org-get-indentation))
11915 (cond
11916 ((and (org-at-heading-p)
11917 org-adapt-indentation)
11918 (1+ (org-current-level)))
11919 ((org-at-heading-p) 0)
11920 (t (org-get-indentation))))))
11921 (setq bul (org-list-bullet-string "-"))
11922 (org-indent-line-to ind)
11923 (insert bul (pop lines))
11924 (let ((ind-body (+ (length bul) ind)))
11925 (while lines
11927 (org-indent-line-to ind-body)
11928 (insert (pop lines))))
11929 (message "Note stored")
11930 (org-back-to-heading t)
11931 (org-cycle-hide-drawers 'children)))))
11932 (set-window-configuration org-log-note-window-configuration)
11933 (with-current-buffer (marker-buffer org-log-note-return-to)
11934 (goto-char org-log-note-return-to))
11935 (move-marker org-log-note-return-to nil)
11936 (and org-log-post-message (message "%s" org-log-post-message)))
11938 (defun org-remove-empty-drawer-at (drawer pos)
11939 "Remove an empty drawer DRAWER at position POS.
11940 POS may also be a marker."
11941 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
11942 (save-excursion
11943 (save-restriction
11944 (widen)
11945 (goto-char pos)
11946 (if (org-in-regexp
11948 (replace-match ""))))))
11950 (defun org-sparse-tree (&optional arg)
11951 "Create a sparse tree, prompt for the details.
11952 This command can create sparse trees. You first need to select the type
11953 of match used to create the tree:
11955 t Show all TODO entries.
11956 T Show entries with a specific TODO keyword.
11957 m Show entries selected by a tags/property match.
11958 p Enter a property name and its value (both with completion on existing
11959 names/values) and show entries with that property.
11960 / Show entries matching a regular expression (`r' can be used as well)
11961 d Show deadlines due within `org-deadline-warning-days'.
11962 b Show deadlines and scheduled items before a date.
11963 a Show deadlines and scheduled items after a date."
11964 (interactive "P")
11965 (let (ans kwd value)
11966 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty [d]eadlines\n [b]efore-date [a]fter-date")
11967 (setq ans (read-char-exclusive))
11968 (cond
11969 ((equal ans ?d)
11970 (call-interactively 'org-check-deadlines))
11971 ((equal ans ?b)
11972 (call-interactively 'org-check-before-date))
11973 ((equal ans ?a)
11974 (call-interactively 'org-check-after-date))
11975 ((equal ans ?t)
11976 (org-show-todo-tree nil))
11977 ((equal ans ?T)
11978 (org-show-todo-tree '(4)))
11979 ((member ans '(?T ?m))
11980 (call-interactively 'org-match-sparse-tree))
11981 ((member ans '(?p ?P))
11982 (setq kwd (org-icompleting-read "Property: "
11983 (mapcar 'list (org-buffer-property-keys))))
11984 (setq value (org-icompleting-read "Value: "
11985 (mapcar 'list (org-property-values kwd))))
11988 (org-match-sparse-tree arg (concat kwd "=" value)))
11989 ((member ans '(?r ?R ?/))
11990 (call-interactively 'org-occur))
11993 (defvar org-occur-highlights nil
11994 "List of overlays used for occur matches.")
11995 (make-variable-buffer-local 'org-occur-highlights)
11996 (defvar org-occur-parameters nil
11997 "Parameters of the active org-occur calls.
11998 This is a list, each call to org-occur pushes as cons cell,
11999 containing the regular expression and the callback, onto the list.
12000 The list can contain several entries if `org-occur' has been called
12001 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12002 will only contain one set of parameters. When the highlights are
12003 removed (for example with `C-c C-c', or with the next edit (depending
12004 on `org-remove-highlights-with-change'), this variable is emptied
12005 as well.")
12006 (make-variable-buffer-local 'org-occur-parameters)
12008 (defun org-occur (regexp &optional keep-previous callback)
12009 "Make a compact tree which shows all matches of REGEXP.
12010 The tree will show the lines where the regexp matches, and all higher
12011 headlines above the match. It will also show the heading after the match,
12012 to make sure editing the matching entry is easy.
12013 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12014 call to `org-occur' will be kept, to allow stacking of calls to this
12015 command.
12016 If CALLBACK is non-nil, it is a function which is called to confirm
12017 that the match should indeed be shown."
12019 (when (equal regexp "")
12020 (error "Regexp cannot be empty"))
12021 (unless keep-previous
12022 (org-remove-occur-highlights nil nil t))
12023 (push (cons regexp callback) org-occur-parameters)
12024 (let ((cnt 0))
12025 (save-excursion
12026 (goto-char (point-min))
12027 (if (or (not keep-previous) ; do not want to keep
12028 (not org-occur-highlights)) ; no previous matches
12029 ;; hide everything
12030 (org-overview))
12031 (while (re-search-forward regexp nil t)
12032 (when (or (not callback)
12033 (save-match-data (funcall callback)))
12034 (setq cnt (1+ cnt))
12035 (when org-highlight-sparse-tree-matches
12036 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12037 (org-show-context 'occur-tree))))
12038 (when org-remove-highlights-with-change
12039 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12040 nil 'local))
12041 (unless org-sparse-tree-open-archived-trees
12042 (org-hide-archived-subtrees (point-min) (point-max)))
12043 (run-hooks 'org-occur-hook)
12044 (if (interactive-p)
12045 (message "%d match(es) for regexp %s" cnt regexp))
12046 cnt))
12048 (defun org-show-context (&optional key)
12049 "Make sure point and context are visible.
12050 How much context is shown depends upon the variables
12051 `org-show-hierarchy-above', `org-show-following-heading'. and
12052 `org-show-siblings'."
12053 (let ((heading-p (org-on-heading-p t))
12054 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12055 (following-p (org-get-alist-option org-show-following-heading key))
12056 (entry-p (org-get-alist-option org-show-entry-below key))
12057 (siblings-p (org-get-alist-option org-show-siblings key)))
12058 (catch 'exit
12059 ;; Show heading or entry text
12060 (if (and heading-p (not entry-p))
12061 (org-flag-heading nil) ; only show the heading
12062 (and (or entry-p (org-invisible-p) (org-invisible-p2))
12063 (org-show-hidden-entry))) ; show entire entry
12064 (when following-p
12065 ;; Show next sibling, or heading below text
12066 (save-excursion
12067 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12068 (org-flag-heading nil))))
12069 (when siblings-p (org-show-siblings))
12070 (when hierarchy-p
12071 ;; show all higher headings, possibly with siblings
12072 (save-excursion
12073 (while (and (condition-case nil
12074 (progn (org-up-heading-all 1) t)
12075 (error nil))
12076 (not (bobp)))
12077 (org-flag-heading nil)
12078 (when siblings-p (org-show-siblings))))))))
12080 (defvar org-reveal-start-hook nil
12081 "Hook run before revealing a location.")
12083 (defun org-reveal (&optional siblings)
12084 "Show current entry, hierarchy above it, and the following headline.
12085 This can be used to show a consistent set of context around locations
12086 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12087 not t for the search context.
12089 With optional argument SIBLINGS, on each level of the hierarchy all
12090 siblings are shown. This repairs the tree structure to what it would
12091 look like when opened with hierarchical calls to `org-cycle'.
12093 go to the parent and show the
12094 entire tree."
12095 (interactive "P")
12096 (run-hooks 'org-reveal-start-hook)
12097 (let ((org-show-hierarchy-above t)
12098 (org-show-following-heading t)
12099 (org-show-siblings (if siblings t org-show-siblings)))
12100 (org-show-context nil))
12101 (when (equal siblings '(16))
12102 (save-excursion
12103 (when (org-up-heading-safe)
12104 (org-show-subtree)
12105 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12107 (defun org-highlight-new-match (beg end)
12108 "Highlight from BEG to END and mark the highlight is an occur headline."
12109 (let ((ov (make-overlay beg end)))
12110 (overlay-put ov 'face 'secondary-selection)
12111 (push ov org-occur-highlights)))
12113 (defun org-remove-occur-highlights (&optional beg end noremove)
12114 "Remove the occur highlights from the buffer.
12115 BEG and END are ignored. If NOREMOVE is nil, remove this function
12116 from the `before-change-functions' in the current buffer."
12117 (interactive)
12118 (unless org-inhibit-highlight-removal
12119 (mapc 'delete-overlay org-occur-highlights)
12120 (setq org-occur-highlights nil)
12121 (setq org-occur-parameters nil)
12122 (unless noremove
12123 (remove-hook 'before-change-functions
12124 'org-remove-occur-highlights 'local))))
12126 ;;;; Priorities
12129 "Regular expression matching the priority indicator.")
12131 (defvar org-remove-priority-next-time nil)
12133 (defun org-priority-up ()
12134 "Increase the priority of the current item."
12135 (interactive)
12136 (org-priority 'up))
12138 (defun org-priority-down ()
12139 "Decrease the priority of the current item."
12140 (interactive)
12141 (org-priority 'down))
12143 (defun org-priority (&optional action)
12144 "Change the priority of an item by ARG.
12145 ACTION can be `set', `up', `down', or a character."
12146 (interactive)
12147 (unless org-enable-priority-commands
12148 (error "Priority commands are disabled"))
12149 (setq action (or action 'set))
12150 (let (current new news have remove)
12151 (save-excursion
12152 (org-back-to-heading t)
12153 (if (looking-at org-priority-regexp)
12154 (setq current (string-to-char (match-string 2))
12155 have t)
12156 (setq current org-default-priority))
12157 (cond
12158 ((eq action 'remove)
12159 (setq remove t new ?\ ))
12160 ((or (eq action 'set)
12161 (if (featurep 'xemacs) (characterp action) (integerp action)))
12162 (if (not (eq action 'set))
12163 (setq new action)
12164 (message "Priority %c-%c, SPC to remove: "
12165 org-highest-priority org-lowest-priority)
12166 (save-match-data
12167 (setq new (read-char-exclusive))))
12168 (if (and (= (upcase org-highest-priority) org-highest-priority)
12169 (= (upcase org-lowest-priority) org-lowest-priority))
12170 (setq new (upcase new)))
12171 (cond ((equal new ?\ ) (setq remove t))
12172 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12173 (error "Priority must be between `%c' and `%c'"
12174 org-highest-priority org-lowest-priority))))
12175 ((eq action 'up)
12176 (if (and (not have) (eq last-command this-command))
12177 (setq new org-lowest-priority)
12178 (setq new (if (and org-priority-start-cycle-with-default (not have))
12179 org-default-priority (1- current)))))
12180 ((eq action 'down)
12181 (if (and (not have) (eq last-command this-command))
12182 (setq new org-highest-priority)
12183 (setq new (if (and org-priority-start-cycle-with-default (not have))
12184 org-default-priority (1+ current)))))
12185 (t (error "Invalid action")))
12186 (if (or (< (upcase new) org-highest-priority)
12187 (> (upcase new) org-lowest-priority))
12188 (setq remove t))
12189 (setq news (format "%c" new))
12190 (if have
12191 (if remove
12192 (replace-match "" t t nil 1)
12193 (replace-match news t t nil 2))
12194 (if remove
12195 (error "No priority cookie found in line")
12196 (let ((case-fold-search nil))
12197 (looking-at org-todo-line-regexp))
12198 (if (match-end 2)
12199 (progn
12200 (goto-char (match-end 2))
12201 (insert " [#" news "]"))
12202 (goto-char (match-beginning 3))
12203 (insert "[#" news "] "))))
12204 (org-preserve-lc (org-set-tags nil 'align)))
12205 (if remove
12206 (message "Priority removed")
12207 (message "Priority of current item set to %s" news))))
12209 (defun org-get-priority (s)
12210 "Find priority cookie and return priority."
12211 (save-match-data
12212 (if (not (string-match org-priority-regexp s))
12213 (* 1000 (- org-lowest-priority org-default-priority))
12214 (* 1000 (- org-lowest-priority
12215 (string-to-char (match-string 2 s)))))))
12217 ;;;; Tags
12219 (defvar org-agenda-archives-mode)
12220 (defvar org-map-continue-from nil
12221 "Position from where mapping should continue.
12222 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12224 (defvar org-scanner-tags nil
12225 "The current tag list while the tags scanner is running.")
12226 (defvar org-trust-scanner-tags nil
12227 "Should `org-get-tags-at' use the tags fro the scanner.
12228 This is for internal dynamical scoping only.
12229 When this is non-nil, the function `org-get-tags-at' will return the value
12230 of `org-scanner-tags' instead of building the list by itself. This
12231 can lead to large speed-ups when the tags scanner is used in a file with
12232 many entries, and when the list of tags is retrieved, for example to
12233 obtain a list of properties. Building the tags list for each entry in such
12234 a file becomes an N^2 operation - but with this variable set, it scales
12235 as N.")
12237 (defun org-scan-tags (action matcher &optional todo-only)
12238 "Scan headline tags with inheritance and produce output ACTION.
12240 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12241 or `agenda' to produce an entry list for an agenda view. It can also be
12242 a Lisp form or a function that should be called at each matched headline, in
12243 this case the return value is a list of all return values from these calls.
12245 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12246 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12247 only lines with a TODO keyword are included in the output."
12248 (require 'org-agenda)
12251 (org-re
12253 (props (list 'face 'default
12254 'done-face 'org-agenda-done
12255 'undone-face 'default
12256 'mouse-face 'highlight
12257 'org-not-done-regexp org-not-done-regexp
12258 'org-todo-regexp org-todo-regexp
12259 'help-echo
12260 (format "mouse-2 or RET jump to org file %s"
12261 (abbreviate-file-name
12262 (or (buffer-file-name (buffer-base-buffer))
12263 (buffer-name (buffer-base-buffer)))))))
12264 (case-fold-search nil)
12265 (org-map-continue-from nil)
12266 lspos tags tags-list
12267 (tags-alist (list (cons 0 org-file-tags)))
12268 (llast 0) rtn rtn1 level category i txt
12269 todo marker entry priority)
12270 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12271 (setq action (list 'lambda nil action)))
12272 (save-excursion
12273 (goto-char (point-min))
12274 (when (eq action 'sparse-tree)
12275 (org-overview)
12276 (org-remove-occur-highlights))
12277 (while (re-search-forward re nil t)
12278 (catch :skip
12279 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12280 tags (if (match-end 4) (org-match-string-no-properties 4)))
12281 (goto-char (setq lspos (match-beginning 0)))
12282 (setq level (org-reduced-level (funcall outline-level))
12283 category (org-get-category))
12284 (setq i llast llast level)
12285 ;; remove tag lists from same and sublevels
12286 (while (>= i level)
12287 (when (setq entry (assoc i tags-alist))
12288 (setq tags-alist (delete entry tags-alist)))
12289 (setq i (1- i)))
12290 ;; add the next tags
12291 (when tags
12292 (setq tags (org-split-string tags ":")
12293 tags-alist
12294 (cons (cons level tags) tags-alist)))
12295 ;; compile tags for current headline
12296 (setq tags-list
12297 (if org-use-tag-inheritance
12298 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12299 tags)
12300 org-scanner-tags tags-list)
12301 (when org-use-tag-inheritance
12302 (setcdr (car tags-alist)
12303 (mapcar (lambda (x)
12304 (setq x (copy-sequence x))
12305 (org-add-prop-inherited x))
12306 (cdar tags-alist))))
12307 (when (and tags org-use-tag-inheritance
12308 (or (not (eq t org-use-tag-inheritance))
12309 org-tags-exclude-from-inheritance))
12310 ;; selective inheritance, remove uninherited ones
12311 (setcdr (car tags-alist)
12312 (org-remove-uniherited-tags (cdar tags-alist))))
12313 (when (and (or (not todo-only)
12314 (and (member todo org-not-done-keywords)
12315 (or (not org-agenda-tags-todo-honor-ignore-options)
12316 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12317 (let ((case-fold-search t)) (eval matcher))
12318 (or
12319 (not (member org-archive-tag tags-list))
12320 ;; we have an archive tag, should we use this anyway?
12321 (or (not org-agenda-skip-archived-trees)
12322 (and (eq action 'agenda) org-agenda-archives-mode))))
12323 (unless (eq action 'sparse-tree) (org-agenda-skip))
12325 ;; select this headline
12327 (cond
12328 ((eq action 'sparse-tree)
12329 (and org-highlight-sparse-tree-matches
12330 (org-get-heading) (match-end 0)
12331 (org-highlight-new-match
12332 (match-beginning 0) (match-beginning 1)))
12333 (org-show-context 'tags-tree))
12334 ((eq action 'agenda)
12335 (setq txt (org-format-agenda-item
12336 ""
12337 (concat
12338 (if (eq org-tags-match-list-sublevels 'indented)
12339 (make-string (1- level) ?.) "")
12340 (org-get-heading))
12341 category
12342 tags-list
12343 )
12344 priority (org-get-priority txt))
12345 (goto-char lspos)
12346 (setq marker (org-agenda-new-marker))
12347 (org-add-props txt props
12348 'org-marker marker 'org-hd-marker marker 'org-category category
12349 'todo-state todo
12350 'priority priority 'type "tagsmatch")
12351 (push txt rtn))
12352 ((functionp action)
12353 (setq org-map-continue-from nil)
12354 (save-excursion
12355 (setq rtn1 (funcall action))
12356 (push rtn1 rtn)))
12357 (t (error "Invalid action")))
12359 ;; if we are to skip sublevels, jump to end of subtree
12360 (unless org-tags-match-list-sublevels
12361 (org-end-of-subtree t)
12362 (backward-char 1))))
12363 ;; Get the correct position from where to continue
12364 (if org-map-continue-from
12365 (goto-char org-map-continue-from)
12366 (and (= (point) lspos) (end-of-line 1)))))
12367 (when (and (eq action 'sparse-tree)
12368 (not org-sparse-tree-open-archived-trees))
12369 (org-hide-archived-subtrees (point-min) (point-max)))
12370 (nreverse rtn)))
12372 (defun org-remove-uniherited-tags (tags)
12373 "Remove all tags that are not inherited from the list TAGS."
12374 (cond
12375 ((eq org-use-tag-inheritance t)
12376 (if org-tags-exclude-from-inheritance
12377 (org-delete-all org-tags-exclude-from-inheritance tags)
12378 tags))
12379 ((not org-use-tag-inheritance) nil)
12380 ((stringp org-use-tag-inheritance)
12381 (delq nil (mapcar
12382 (lambda (x)
12383 (if (and (string-match org-use-tag-inheritance x)
12384 (not (member x org-tags-exclude-from-inheritance)))
12385 x nil))
12386 tags)))
12387 ((listp org-use-tag-inheritance)
12388 (delq nil (mapcar
12389 (lambda (x)
12390 (if (member x org-use-tag-inheritance) x nil))
12391 tags)))))
12393 (defvar todo-only) ;; dynamically scoped
12395 (defun org-match-sparse-tree (&optional todo-only match)
12396 "Create a sparse tree according to tags string MATCH.
12397 MATCH can contain positive and negative selection of tags, like
12399 If optional argument TODO-ONLY is non-nil, only select lines that are
12400 also TODO lines."
12401 (interactive "P")
12402 (org-prepare-agenda-buffers (list (current-buffer)))
12403 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12405 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12407 (defvar org-cached-props nil)
12408 (defun org-cached-entry-get (pom property)
12409 (if (or (eq t org-use-property-inheritance)
12410 (and (stringp org-use-property-inheritance)
12411 (string-match org-use-property-inheritance property))
12412 (and (listp org-use-property-inheritance)
12413 (member property org-use-property-inheritance)))
12414 ;; Caching is not possible, check it directly
12415 (org-entry-get pom property 'inherit)
12416 ;; Get all properties, so that we can do complicated checks easily
12417 (cdr (assoc property (or org-cached-props
12418 (setq org-cached-props
12419 (org-entry-properties pom)))))))
12421 (defun org-global-tags-completion-table (&optional files)
12422 "Return the list of all tags in all agenda buffer/files."
12423 (save-excursion
12424 (org-uniquify
12425 (delq nil
12426 (apply 'append
12427 (mapcar
12428 (lambda (file)
12429 (set-buffer (find-file-noselect file))
12430 (append (org-get-buffer-tags)
12431 (mapcar (lambda (x) (if (stringp (car-safe x))
12432 (list (car-safe x)) nil))
12433 org-tag-alist)))
12434 (if (and files (car files))
12435 files
12436 (org-agenda-files))))))))
12438 (defun org-make-tags-matcher (match)
12439 "Create the TAGS//TODO matcher form for the selection string MATCH."
12440 ;; todo-only is scoped dynamically into this function, and the function
12441 ;; may change it if the matcher asks for it.
12442 (unless match
12443 ;; Get a new match request, with completion
12444 (let ((org-last-tags-completion-table
12445 (org-global-tags-completion-table)))
12446 (setq match (org-completing-read-no-i
12447 "Match: " 'org-tags-completion-function nil nil nil
12448 'org-tags-history))))
12450 ;; Parse the string and create a lisp form
12451 (let ((match0 match)
12452 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12453 minus tag mm
12454 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12455 orterms term orlist re-p str-p level-p level-op time-p
12456 prop-p pn pv po cat-p gv rest)
12457 (if (string-match "/+" match)
12458 ;; match contains also a todo-matching request
12459 (progn
12460 (setq tagsmatch (substring match 0 (match-beginning 0))
12461 todomatch (substring match (match-end 0)))
12462 (if (string-match "^!" todomatch)
12463 (setq todo-only t todomatch (substring todomatch 1)))
12465 (setq todomatch nil)))
12466 ;; only matching tags
12467 (setq tagsmatch match todomatch nil))
12469 ;; Make the tags matcher
12471 (setq tagsmatcher t)
12472 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12473 (while (setq term (pop orterms))
12475 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12476 (while (string-match re term)
12477 (setq rest (substring term (match-end 0))
12478 minus (and (match-end 1)
12479 (equal (match-string 1 term) "-"))
12480 tag (save-match-data (replace-regexp-in-string
12482 (match-string 2 term)))
12483 re-p (equal (string-to-char tag) ?{)
12484 level-p (match-end 4)
12485 prop-p (match-end 5)
12486 mm (cond
12487 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12488 (level-p
12489 (setq level-op (org-op-to-function (match-string 3 term)))
12490 `(,level-op level ,(string-to-number
12491 (match-string 4 term))))
12492 (prop-p
12493 (setq pn (match-string 5 term)
12494 po (match-string 6 term)
12495 pv (match-string 7 term)
12496 cat-p (equal pn "CATEGORY")
12497 re-p (equal (string-to-char pv) ?{)
12499 time-p (save-match-data
12501 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12502 (if time-p (setq pv (org-matcher-time pv)))
12503 (setq po (org-op-to-function po (if time-p 'time str-p)))
12504 (cond
12505 ((equal pn "CATEGORY")
12506 (setq gv '(get-text-property (point) 'org-category)))
12507 ((equal pn "TODO")
12508 (setq gv 'todo))
12509 (t
12510 (setq gv `(org-cached-entry-get nil ,pn))))
12511 (if re-p
12512 (if (eq po 'org<>)
12513 `(not (string-match ,pv (or ,gv "")))
12514 `(string-match ,pv (or ,gv "")))
12515 (if str-p
12516 `(,po (or ,gv "") ,pv)
12517 `(,po (string-to-number (or ,gv ""))
12518 ,(string-to-number pv) ))))
12519 (t `(member ,tag tags-list)))
12520 mm (if minus (list 'not mm) mm)
12521 term rest)
12522 (push mm tagsmatcher))
12523 (push (if (> (length tagsmatcher) 1)
12524 (cons 'and tagsmatcher)
12525 (car tagsmatcher))
12526 orlist)
12527 (setq tagsmatcher nil))
12528 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12529 (setq tagsmatcher
12530 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12531 ;; Make the todo matcher
12533 (setq todomatcher t)
12534 (setq orterms (org-split-string todomatch "|") orlist nil)
12535 (while (setq term (pop orterms))
12536 (while (string-match re term)
12537 (setq minus (and (match-end 1)
12538 (equal (match-string 1 term) "-"))
12539 kwd (match-string 2 term)
12540 re-p (equal (string-to-char kwd) ?{)
12541 term (substring term (match-end 0))
12542 mm (if re-p
12543 `(string-match ,(substring kwd 1 -1) todo)
12544 (list 'equal 'todo kwd))
12545 mm (if minus (list 'not mm) mm))
12546 (push mm todomatcher))
12547 (push (if (> (length todomatcher) 1)
12548 (cons 'and todomatcher)
12549 (car todomatcher))
12550 orlist)
12551 (setq todomatcher nil))
12552 (setq todomatcher (if (> (length orlist) 1)
12553 (cons 'or orlist) (car orlist))))
12555 ;; Return the string and lisp forms of the matcher
12556 (setq matcher (if todomatcher
12557 (list 'and tagsmatcher todomatcher)
12558 tagsmatcher))
12559 (cons match0 matcher)))
12561 (defun org-op-to-function (op &optional stringp)
12562 "Turn an operator into the appropriate function."
12563 (setq op
12564 (cond
12565 ((equal op "<" ) '(< string< org-time<))
12566 ((equal op ">" ) '(> org-string> org-time>))
12567 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12568 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12569 ((member op '("=" "==")) '(= string= org-time=))
12570 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12571 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12573 (defun org<> (a b) (not (= a b)))
12574 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12575 (defun org-string>= (a b) (not (string< a b)))
12576 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12577 (defun org-string<> (a b) (not (string= a b)))
12578 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12579 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12580 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12581 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12582 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12583 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12584 (defun org-2ft (s)
12585 "Convert S to a floating point time.
12586 If S is already a number, just return it. If it is a string, parse
12587 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12588 (cond
12589 ((numberp s) s)
12590 ((stringp s)
12591 (condition-case nil
12592 (float-time (apply 'encode-time (org-parse-time-string s)))
12593 (error 0.)))
12594 (t 0.)))
12596 (defun org-time-today ()
12597 "Time in seconds today at 0:00.
12598 Returns the float number of seconds since the beginning of the
12599 epoch to the beginning of today (00:00)."
12600 (float-time (apply 'encode-time
12601 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12603 (defun org-matcher-time (s)
12604 "Interpret a time comparison value."
12605 (save-match-data
12606 (cond
12607 ((string= s "<now>") (float-time))
12608 ((string= s "<today>") (org-time-today))
12609 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12610 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12612 (+ (org-time-today)
12613 (* (string-to-number (match-string 1 s))
12614 (cdr (assoc (match-string 2 s)
12615 '(("d" . 86400.0) ("w" . 604800.0)
12616 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12617 (t (org-2ft s)))))
12619 (defun org-match-any-p (re list)
12620 "Does re match any element of list?"
12621 (setq list (mapcar (lambda (x) (string-match re x)) list))
12622 (delq nil list))
12624 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12625 (defvar org-tags-overlay (make-overlay 1 1))
12626 (org-detach-overlay org-tags-overlay)
12628 (defun org-get-local-tags-at (&optional pos)
12629 "Get a list of tags defined in the current headline."
12630 (org-get-tags-at pos 'local))
12632 (defun org-get-local-tags ()
12633 "Get a list of tags defined in the current headline."
12634 (org-get-tags-at nil 'local))
12636 (defun org-get-tags-at (&optional pos local)
12637 "Get a list of all headline tags applicable at POS.
12638 POS defaults to point. If tags are inherited, the list contains
12639 the targets in the same sequence as the headlines appear, i.e.
12640 the tags of the current headline come last.
12641 When LOCAL is non-nil, only return tags from the current headline,
12642 ignore inherited ones."
12643 (interactive)
12644 (if (and org-trust-scanner-tags
12645 (or (not pos) (equal pos (point)))
12646 (not local))
12647 org-scanner-tags
12648 (let (tags ltags lastpos parent)
12649 (save-excursion
12650 (save-restriction
12651 (widen)
12652 (goto-char (or pos (point)))
12653 (save-match-data
12654 (catch 'done
12655 (condition-case nil
12656 (progn
12657 (org-back-to-heading t)
12658 (while (not (equal lastpos (point)))
12659 (setq lastpos (point))
12660 (when (looking-at
12662 (setq ltags (org-split-string
12663 (org-match-string-no-properties 1) ":"))
12664 (when parent
12665 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12666 (setq tags (append
12667 (if parent
12668 (org-remove-uniherited-tags ltags)
12669 ltags)
12670 tags)))
12671 (or org-use-tag-inheritance (throw 'done t))
12672 (if local (throw 'done t))
12673 (or (org-up-heading-safe) (error nil))
12674 (setq parent t)))
12675 (error nil)))))
12676 (append (org-remove-uniherited-tags org-file-tags) tags)))))
12678 (defun org-add-prop-inherited (s)
12679 (add-text-properties 0 (length s) '(inherited t) s)
12680 s)
12682 (defun org-toggle-tag (tag &optional onoff)
12683 "Toggle the tag TAG for the current line.
12684 If ONOFF is `on' or `off', don't toggle but set to this state."
12685 (let (res current)
12686 (save-excursion
12687 (org-back-to-heading t)
12689 (point-at-eol) t)
12690 (progn
12691 (setq current (match-string 1))
12692 (replace-match ""))
12693 (setq current ""))
12694 (setq current (nreverse (org-split-string current ":")))
12695 (cond
12696 ((eq onoff 'on)
12697 (setq res t)
12698 (or (member tag current) (push tag current)))
12699 ((eq onoff 'off)
12700 (or (not (member tag current)) (setq current (delete tag current))))
12701 (t (if (member tag current)
12702 (setq current (delete tag current))
12703 (setq res t)
12704 (push tag current))))
12705 (end-of-line 1)
12706 (if current
12707 (progn
12708 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12709 (org-set-tags nil t))
12710 (delete-horizontal-space))
12711 (run-hooks 'org-after-tags-change-hook))
12712 res))
12714 (defun org-align-tags-here (to-col)
12715 ;; Assumes that this is a headline
12716 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12717 (beginning-of-line 1)
12719 (< pos (match-beginning 2)))
12720 (progn
12721 (setq tags-l (- (match-end 2) (match-beginning 2)))
12722 (goto-char (match-beginning 1))
12723 (insert " ")
12724 (delete-region (point) (1+ (match-beginning 2)))
12725 (setq ncol (max (1+ (current-column))
12726 (1+ col)
12727 (if (> to-col 0)
12728 to-col
12729 (- (abs to-col) tags-l))))
12730 (setq p (point))
12731 (insert (make-string (- ncol (current-column)) ?\ ))
12732 (setq ncol (current-column))
12733 (when indent-tabs-mode (tabify p (point-at-eol)))
12734 (org-move-to-column (min ncol col) t))
12735 (goto-char pos))))
12737 (defun org-set-tags-command (&optional arg just-align)
12738 "Call the set-tags command for the current entry."
12739 (interactive "P")
12740 (if (org-on-heading-p)
12741 (org-set-tags arg just-align)
12742 (save-excursion
12743 (org-back-to-heading t)
12744 (org-set-tags arg just-align))))
12746 (defun org-set-tags-to (data)
12747 "Set the tags of the current entry to DATA, replacing the current tags.
12748 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12749 If DATA is nil or the empty string, any tags will be removed."
12750 (interactive "sTags: ")
12751 (setq data
12752 (cond
12753 ((eq data nil) "")
12754 ((equal data "") "")
12755 ((stringp data)
12756 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12757 ":"))
12758 ((listp data)
12759 (concat ":" (mapconcat 'identity data ":") ":"))
12760 (t nil)))
12761 (when data
12762 (save-excursion
12763 (org-back-to-heading t)
12764 (when (looking-at org-complex-heading-regexp)
12765 (if (match-end 5)
12766 (progn
12767 (goto-char (match-beginning 5))
12768 (insert data)
12769 (delete-region (point) (point-at-eol))
12770 (org-set-tags nil 'align))
12771 (goto-char (point-at-eol))
12772 (insert " " data)
12773 (org-set-tags nil 'align)))
12774 (beginning-of-line 1)
12776 (delete-region (match-beginning 1) (match-end 1))))))
12778 (defun org-align-all-tags ()
12779 "Align the tags i all headings."
12780 (interactive)
12781 (save-excursion
12782 (or (ignore-errors (org-back-to-heading t))
12783 (outline-next-heading))
12784 (if (org-on-heading-p)
12785 (org-set-tags t)
12786 (message "No headings"))))
12788 (defvar org-indent-indentation-per-level)
12789 (defun org-set-tags (&optional arg just-align)
12790 "Set the tags for the current headline.
12791 With prefix ARG, realign all tags in headings in the current buffer."
12792 (interactive "P")
12793 (let* ((re (concat "^" outline-regexp))
12794 (current (org-get-tags-string))
12795 (col (current-column))
12796 (org-setting-tags t)
12797 table current-tags inherited-tags ; computed below when needed
12798 tags p0 c0 c1 rpl di tc level)
12799 (if arg
12800 (save-excursion
12801 (goto-char (point-min))
12802 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12803 (while (re-search-forward re nil t)
12804 (org-set-tags nil t)
12805 (end-of-line 1)))
12806 (message "All tags realigned to column %d" org-tags-column))
12807 (if just-align
12808 (setq tags current)
12809 ;; Get a new set of tags from the user
12810 (save-excursion
12811 (setq table (append org-tag-persistent-alist
12812 (or org-tag-alist (org-get-buffer-tags))
12813 (and
12814 org-complete-tags-always-offer-all-agenda-tags
12815 (org-global-tags-completion-table
12816 (org-agenda-files))))
12817 org-last-tags-completion-table table
12818 current-tags (org-split-string current ":")
12819 inherited-tags (nreverse
12820 (nthcdr (length current-tags)
12821 (nreverse (org-get-tags-at))))
12822 tags
12823 (if (or (eq t org-use-fast-tag-selection)
12824 (and org-use-fast-tag-selection
12825 (delq nil (mapcar 'cdr table))))
12826 (org-fast-tag-selection
12827 current-tags inherited-tags table
12828 (if org-fast-tag-selection-include-todo
12829 org-todo-key-alist))
12830 (let ((org-add-colon-after-tag-completion t))
12831 (org-trim
12832 (org-without-partial-completion
12833 (org-icompleting-read "Tags: "
12834 'org-tags-completion-function
12835 nil nil current 'org-tags-history)))))))
12836 (while (string-match "[-+&]+" tags)
12837 ;; No boolean logic, just a list
12838 (setq tags (replace-match ":" t t tags))))
12840 (setq tags (replace-regexp-in-string "[ ,]" ":" tags))
12842 (if org-tags-sort-function
12843 (setq tags (mapconcat 'identity
12844 (sort (org-split-string
12845 tags (org-re "[^[:alnum:]_@#%]+"))
12846 org-tags-sort-function) ":")))
12849 (setq tags "")
12850 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12851 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12853 ;; Insert new tags at the correct column
12854 (beginning-of-line 1)
12855 (setq level (or (and (looking-at org-outline-regexp)
12856 (- (match-end 0) (point) 1))
12857 1))
12858 (cond
12859 ((and (equal current "") (equal tags "")))
12860 ((re-search-forward
12862 (point-at-eol) t)
12863 (if (equal tags "")
12864 (setq rpl "")
12865 (goto-char (match-beginning 0))
12866 (setq c0 (current-column)
12867 ;; compute offset for the case of org-indent-mode active
12868 di (if org-indent-mode
12869 (* (1- org-indent-indentation-per-level) (1- level))
12870 0)
12871 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
12872 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
12873 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
12874 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12875 (replace-match rpl t t)
12876 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
12877 tags)
12878 (t (error "Tags alignment failed")))
12879 (org-move-to-column col)
12880 (unless just-align
12881 (run-hooks 'org-after-tags-change-hook)))))
12883 (defun org-change-tag-in-region (beg end tag off)
12884 "Add or remove TAG for each entry in the region.
12885 This works in the agenda, and also in an org-mode buffer."
12886 (interactive
12887 (list (region-beginning) (region-end)
12888 (let ((org-last-tags-completion-table
12889 (if (org-mode-p)
12890 (org-get-buffer-tags)
12891 (org-global-tags-completion-table))))
12892 (org-icompleting-read
12893 "Tag: " 'org-tags-completion-function nil nil nil
12894 'org-tags-history))
12895 (progn
12897 (equal (read-char-exclusive) ?r))))
12898 (if (fboundp 'deactivate-mark) (deactivate-mark))
12899 (let ((agendap (equal major-mode 'org-agenda-mode))
12900 l1 l2 m buf pos newhead (cnt 0))
12901 (goto-char end)
12902 (setq l2 (1- (org-current-line)))
12903 (goto-char beg)
12904 (setq l1 (org-current-line))
12905 (loop for l from l1 to l2 do
12906 (org-goto-line l)
12907 (setq m (get-text-property (point) 'org-hd-marker))
12908 (when (or (and (org-mode-p) (org-on-heading-p))
12909 (and agendap m))
12910 (setq buf (if agendap (marker-buffer m) (current-buffer))
12911 pos (if agendap m (point)))
12912 (with-current-buffer buf
12913 (save-excursion
12914 (save-restriction
12915 (goto-char pos)
12916 (setq cnt (1+ cnt))
12917 (org-toggle-tag tag (if off 'off 'on))
12918 (setq newhead (org-get-heading)))))
12919 (and agendap (org-agenda-change-all-lines newhead m))))
12920 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
12922 (defun org-tags-completion-function (string predicate &optional flag)
12923 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12924 (confirm (lambda (x) (stringp (car x)))))
12926 (setq s1 (match-string 1 string)
12927 s2 (match-string 2 string))
12928 (setq s1 "" s2 string))
12929 (cond
12930 ((eq flag nil)
12931 ;; try completion
12932 (setq rtn (try-completion s2 ctable confirm))
12933 (if (stringp rtn)
12934 (setq rtn
12935 (concat s1 s2 (substring rtn (length s2))
12936 (if (and org-add-colon-after-tag-completion
12937 (assoc rtn ctable))
12938 ":" ""))))
12939 rtn)
12940 ((eq flag t)
12941 ;; all-completions
12942 (all-completions s2 ctable confirm)
12943 )
12944 ((eq flag 'lambda)
12945 ;; exact match?
12946 (assoc s2 ctable)))
12947 ))
12949 (defun org-fast-tag-insert (kwd tags face &optional end)
12950 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
12951 (insert (format "%-12s" (concat kwd ":"))
12952 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
12953 (or end "")))
12955 (defun org-fast-tag-show-exit (flag)
12956 (save-excursion
12957 (org-goto-line 3)
12959 (replace-match ""))
12960 (when flag
12961 (end-of-line 1)
12962 (org-move-to-column (- (window-width) 19) t)
12963 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
12965 (defun org-set-current-tags-overlay (current prefix)
12966 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
12967 (if (featurep 'xemacs)
12968 (org-overlay-display org-tags-overlay (concat prefix s)
12969 'secondary-selection)
12970 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
12971 (org-overlay-display org-tags-overlay (concat prefix s)))))
12973 (defvar org-last-tag-selection-key nil)
12974 (defun org-fast-tag-selection (current inherited table &optional todo-table)
12975 "Fast tag selection with single keys.
12976 CURRENT is the current list of tags in the headline, INHERITED is the
12977 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
12978 possibly with grouping information. TODO-TABLE is a similar table with
12979 TODO keywords, should these have keys assigned to them.
12980 If the keys are nil, a-z are automatically assigned.
12981 Returns the new tags string, or nil to not change the current settings."
12982 (let* ((fulltable (append table todo-table))
12983 (maxlen (apply 'max (mapcar
12984 (lambda (x)
12985 (if (stringp (car x)) (string-width (car x)) 0))
12986 fulltable)))
12987 (buf (current-buffer))
12988 (expert (eq org-fast-tag-selection-single-key 'expert))
12989 (buffer-tags nil)
12990 (fwidth (+ maxlen 3 1 3))
12991 (ncol (/ (- (window-width) 4) fwidth))
12992 (i-face 'org-done)
12993 (c-face 'org-todo)
12994 tg cnt e c char c1 c2 ntable tbl rtn
12995 ov-start ov-end ov-prefix
12996 (exit-after-next org-fast-tag-selection-single-key)
12997 (done-keywords org-done-keywords)
12998 groups ingroup)
12999 (save-excursion
13000 (beginning-of-line 1)
13001 (if (looking-at
13003 (setq ov-start (match-beginning 1)
13004 ov-end (match-end 1)
13005 ov-prefix "")
13006 (setq ov-start (1- (point-at-eol))
13007 ov-end (1+ ov-start))
13009 (setq ov-prefix
13010 (concat
13011 (buffer-substring (1- (point)) (point))
13012 (if (> (current-column) org-tags-column)
13013 " "
13014 (make-string (- org-tags-column (current-column)) ?\ ))))))
13015 (move-overlay org-tags-overlay ov-start ov-end)
13016 (save-window-excursion
13017 (if expert
13018 (set-buffer (get-buffer-create " *Org tags*"))
13019 (delete-other-windows)
13020 (split-window-vertically)
13021 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13022 (erase-buffer)
13023 (org-set-local 'org-done-keywords done-keywords)
13026 (org-fast-tag-show-exit exit-after-next)
13027 (org-set-current-tags-overlay current ov-prefix)
13028 (setq tbl fulltable char ?a cnt 0)
13029 (while (setq e (pop tbl))
13030 (cond
13031 ((equal (car e) :startgroup)
13032 (push '() groups) (setq ingroup t)
13033 (when (not (= cnt 0))
13034 (setq cnt 0)
13036 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13037 ((equal (car e) :endgroup)
13038 (setq ingroup nil cnt 0)
13040 ((equal e '(:newline))
13041 (when (not (= cnt 0))
13042 (setq cnt 0)
13044 (setq e (car tbl))
13045 (while (equal (car tbl) '(:newline))
13047 (setq tbl (cdr tbl)))))
13048 (t
13049 (setq tg (copy-sequence (car e)) c2 nil)
13050 (if (cdr e)
13051 (setq c (cdr e))
13052 ;; automatically assign a character.
13053 (setq c1 (string-to-char
13054 (downcase (substring
13055 tg (if (= (string-to-char tg) ?@) 1 0)))))
13056 (if (or (rassoc c1 ntable) (rassoc c1 table))
13057 (while (or (rassoc char ntable) (rassoc char table))
13058 (setq char (1+ char)))
13059 (setq c2 c1))
13060 (setq c (or c2 char)))
13061 (if ingroup (push tg (car groups)))
13062 (setq tg (org-add-props tg nil 'face
13063 (cond
13064 ((not (assoc tg table))
13065 (org-get-todo-face tg))
13066 ((member tg current) c-face)
13067 ((member tg inherited) i-face)
13068 (t nil))))
13069 (if (and (= cnt 0) (not ingroup)) (insert " "))
13070 (insert "[" c "] " tg (make-string
13071 (- fwidth 4 (length tg)) ?\ ))
13072 (push (cons tg c) ntable)
13073 (when (= (setq cnt (1+ cnt)) ncol)
13075 (if ingroup (insert " "))
13076 (setq cnt 0)))))
13077 (setq ntable (nreverse ntable))
13079 (goto-char (point-min))
13080 (if (not expert) (org-fit-window-to-buffer))
13081 (setq rtn
13082 (catch 'exit
13083 (while t
13084 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13085 (if (not groups) "no " "")
13086 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13087 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13088 (setq org-last-tag-selection-key c)
13089 (cond
13091 ((= c ?!)
13092 (setq groups (not groups))
13093 (goto-char (point-min))
13094 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13095 ((= c ?\C-c)
13096 (if (not expert)
13097 (org-fast-tag-show-exit
13098 (setq exit-after-next (not exit-after-next)))
13099 (setq expert nil)
13100 (delete-other-windows)
13101 (split-window-vertically)
13102 (org-switch-to-buffer-other-window " *Org tags*")
13103 (org-fit-window-to-buffer)))
13104 ((or (= c ?\C-g)
13105 (and (= c ?q) (not (rassoc c ntable))))
13106 (org-detach-overlay org-tags-overlay)
13107 (setq quit-flag t))
13108 ((= c ?\ )
13109 (setq current nil)
13110 (if exit-after-next (setq exit-after-next 'now)))
13112 (condition-case nil
13113 (setq tg (org-icompleting-read
13114 "Tag: "
13115 (or buffer-tags
13116 (with-current-buffer buf
13117 (org-get-buffer-tags)))))
13118 (quit (setq tg "")))
13120 (add-to-list 'buffer-tags (list tg))
13121 (if (member tg current)
13122 (setq current (delete tg current))
13123 (push tg current)))
13124 (if exit-after-next (setq exit-after-next 'now)))
13125 ((setq e (rassoc c todo-table) tg (car e))
13126 (with-current-buffer buf
13127 (save-excursion (org-todo tg)))
13128 (if exit-after-next (setq exit-after-next 'now)))
13129 ((setq e (rassoc c ntable) tg (car e))
13130 (if (member tg current)
13131 (setq current (delete tg current))
13132 (loop for g in groups do
13133 (if (member tg g)
13134 (mapc (lambda (x)
13135 (setq current (delete x current)))
13136 g)))
13137 (push tg current))
13138 (if exit-after-next (setq exit-after-next 'now))))
13140 ;; Create a sorted list
13141 (setq current
13142 (sort current
13143 (lambda (a b)
13144 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13145 (if (eq exit-after-next 'now) (throw 'exit t))
13146 (goto-char (point-min))
13147 (beginning-of-line 2)
13148 (delete-region (point) (point-at-eol))
13149 (org-fast-tag-insert "Current" current c-face)
13150 (org-set-current-tags-overlay current ov-prefix)
13151 (while (re-search-forward
13153 (setq tg (match-string 1))
13154 (add-text-properties
13155 (match-beginning 1) (match-end 1)
13156 (list 'face
13157 (cond
13158 ((member tg current) c-face)
13159 ((member tg inherited) i-face)
13160 (t (get-text-property (match-beginning 1) 'face))))))
13161 (goto-char (point-min)))))
13162 (org-detach-overlay org-tags-overlay)
13163 (if rtn
13164 (mapconcat 'identity current ":")
13165 nil))))
13167 (defun org-get-tags-string ()
13168 "Get the TAGS string in the current headline."
13169 (unless (org-on-heading-p t)
13170 (error "Not on a heading"))
13171 (save-excursion
13172 (beginning-of-line 1)
13174 (org-match-string-no-properties 1)
13175 "")))
13177 (defun org-get-tags ()
13178 "Get the list of tags specified in the current headline."
13179 (org-split-string (org-get-tags-string) ":"))
13181 (defun org-get-buffer-tags ()
13182 "Get a table of all tags used in the buffer, for completion."
13183 (let (tags)
13184 (save-excursion
13185 (goto-char (point-min))
13186 (while (re-search-forward
13188 (when (equal (char-after (point-at-bol 0)) ?*)
13189 (mapc (lambda (x) (add-to-list 'tags x))
13190 (org-split-string (org-match-string-no-properties 1) ":")))))
13191 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13192 (mapcar 'list tags)))
13194 ;;;; The mapping API
13196 ;;;###autoload
13197 (defun org-map-entries (func &optional match scope &rest skip)
13198 "Call FUNC at each headline selected by MATCH in SCOPE.
13200 FUNC is a function or a lisp form. The function will be called without
13201 arguments, with the cursor positioned at the beginning of the headline.
13202 The return values of all calls to the function will be collected and
13203 returned as a list.
13205 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13206 does not need to preserve point. After evaluation, the cursor will be
13207 moved to the end of the line (presumably of the headline of the
13208 processed entry) and search continues from there. Under some
13209 circumstances, this may not produce the wanted results. For example,
13210 if you have removed (e.g. archived) the current (sub)tree it could
13211 mean that the next entry will be skipped entirely. In such cases, you
13212 can specify the position from where search should continue by making
13213 FUNC set the variable `org-map-continue-from' to the desired buffer
13214 position.
13216 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13217 Only headlines that are matched by this query will be considered during
13218 the iteration. When MATCH is nil or t, all headlines will be
13219 visited by the iteration.
13221 SCOPE determines the scope of this command. It can be any of:
13223 nil The current buffer, respecting the restriction if any
13224 tree The subtree started with the entry at point
13225 file The current buffer, without restriction
13226 file-with-archives
13227 The current buffer, and any archives associated with it
13228 agenda All agenda files
13229 agenda-with-archives
13230 All agenda files with any archive files associated with them
13231 \(file1 file2 ...)
13232 If this is a list, all files in the list will be scanned
13234 The remaining args are treated as settings for the skipping facilities of
13235 the scanner. The following items can be given here:
13237 archive skip trees with the archive tag.
13238 comment skip trees with the COMMENT keyword
13239 function or Emacs Lisp form:
13240 will be used as value for `org-agenda-skip-function', so whenever
13241 the function returns t, FUNC will not be called for that
13242 entry and search will continue from the point where the
13243 function leaves it.
13245 If your function needs to retrieve the tags including inherited tags
13246 at the *current* entry, you can use the value of the variable
13247 `org-scanner-tags' which will be much faster than getting the value
13248 with `org-get-tags-at'. If your function gets properties with
13249 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13250 to t around the call to `org-entry-properties' to get the same speedup.
13251 Note that if your function moves around to retrieve tags and properties at
13252 a *different* entry, you cannot use these techniques."
13253 (let* ((org-agenda-archives-mode nil) ; just to make sure
13254 (org-agenda-skip-archived-trees (memq 'archive skip))
13255 (org-agenda-skip-comment-trees (memq 'comment skip))
13256 (org-agenda-skip-function
13257 (car (org-delete-all '(comment archive) skip)))
13258 (org-tags-match-list-sublevels t)
13259 matcher file res
13260 org-todo-keywords-for-agenda
13261 org-done-keywords-for-agenda
13262 org-todo-keyword-alist-for-agenda
13263 org-drawers-for-agenda
13264 org-tag-alist-for-agenda)
13266 (cond
13267 ((eq match t) (setq matcher t))
13268 ((eq match nil) (setq matcher t))
13269 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13271 (save-excursion
13272 (save-restriction
13273 (when (eq scope 'tree)
13274 (org-back-to-heading t)
13275 (org-narrow-to-subtree)
13276 (setq scope nil))
13278 (if (not scope)
13279 (progn
13280 (org-prepare-agenda-buffers
13281 (list (buffer-file-name (current-buffer))))
13282 (setq res (org-scan-tags func matcher)))
13283 ;; Get the right scope
13284 (cond
13285 ((and scope (listp scope) (symbolp (car scope)))
13286 (setq scope (eval scope)))
13287 ((eq scope 'agenda)
13288 (setq scope (org-agenda-files t)))
13289 ((eq scope 'agenda-with-archives)
13290 (setq scope (org-agenda-files t))
13291 (setq scope (org-add-archive-files scope)))
13292 ((eq scope 'file)
13293 (setq scope (list (buffer-file-name))))
13294 ((eq scope 'file-with-archives)
13295 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13296 (org-prepare-agenda-buffers scope)
13297 (while (setq file (pop scope))
13298 (with-current-buffer (org-find-base-buffer-visiting file)
13299 (save-excursion
13300 (save-restriction
13301 (widen)
13302 (goto-char (point-min))
13303 (setq res (append res (org-scan-tags func matcher))))))))))
13304 res))
13306 ;;;; Properties
13308 ;;; Setting and retrieving properties
13310 (defconst org-special-properties
13311 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13312 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED")
13313 "The special properties valid in Org-mode.
13315 These are properties that are not defined in the property drawer,
13316 but in some other way.")
13318 (defconst org-default-properties
13319 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13320 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13321 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13322 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13323 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13324 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13325 "Some properties that are used by Org-mode for various purposes.
13326 Being in this list makes sure that they are offered for completion.")
13329 "Regular expression matching the first line of a property drawer.")
13332 "Regular expression matching the last line of a property drawer.")
13335 "Regular expression matching the first line of a property drawer.")
13338 "Regular expression matching the first line of a property drawer.")
13340 (defconst org-property-drawer-re
13343 "Matches an entire property drawer.")
13345 (defconst org-clock-drawer-re
13348 "Matches an entire clock drawer.")
13350 (defun org-property-action ()
13351 "Do an action on properties."
13352 (interactive)
13353 (let (c)
13354 (org-at-property-p)
13355 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13356 (setq c (read-char-exclusive))
13357 (cond
13358 ((equal c ?s)
13359 (call-interactively 'org-set-property))
13360 ((equal c ?d)
13361 (call-interactively 'org-delete-property))
13362 ((equal c ?D)
13363 (call-interactively 'org-delete-property-globally))
13364 ((equal c ?c)
13365 (call-interactively 'org-compute-property-at-point))
13366 (t (error "No such property action %c" c)))))
13368 (defun org-set-effort (&optional value)
13369 "Set the effort property of the current entry.
13370 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13371 allowed value."
13372 (interactive "P")
13373 (if (equal value 0) (setq value 10))
13374 (let* ((completion-ignore-case t)
13375 (prop org-effort-property)
13376 (cur (org-entry-get nil prop))
13377 (allowed (org-property-get-allowed-values nil prop 'table))
13378 (existing (mapcar 'list (org-property-values prop)))
13379 rpl
13380 (val (cond
13381 ((stringp value) value)
13382 ((and allowed (integerp value))
13383 (or (car (nth (1- value) allowed))
13384 (car (org-last allowed))))
13385 (allowed
13386 (message "Select 1-9,0, [RET%s]: %s"
13387 (if cur (concat "=" cur) "")
13388 (mapconcat 'car allowed " "))
13389 (setq rpl (read-char-exclusive))
13391 cur
13392 (setq rpl (- rpl ?0))
13393 (if (equal rpl 0) (setq rpl 10))
13394 (if (and (> rpl 0) (<= rpl (length allowed)))
13395 (car (nth (1- rpl) allowed))
13396 (org-completing-read "Effort: " allowed nil))))
13397 (t
13398 (let (org-completion-use-ido org-completion-use-iswitchb)
13399 (org-completing-read
13401 (concat "[" cur "]") "")
13402 ": ")
13403 existing nil nil "" nil cur))))))
13404 (unless (equal (org-entry-get nil prop) val)
13405 (org-entry-put nil prop val))
13406 (message "%s is now %s" prop val)))
13408 (defun org-at-property-p ()
13409 "Is cursor inside a property drawer?"
13410 (save-excursion
13411 (beginning-of-line 1)
13413 (save-match-data ;; Used by calling procedures
13414 (let ((p (point))
13415 (range (unless (org-before-first-heading-p)
13416 (org-get-property-block))))
13417 (and range (<= (car range) p) (< p (cdr range))))))))
13419 (defun org-get-property-block (&optional beg end force)
13420 "Return the (beg . end) range of the body of the property drawer.
13421 BEG and END can be beginning and end of subtree, if not given
13422 they will be found.
13423 If the drawer does not exist and FORCE is non-nil, create the drawer."
13424 (catch 'exit
13425 (save-excursion
13426 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13427 (end (or end (progn (outline-next-heading) (point)))))
13428 (goto-char beg)
13429 (if (re-search-forward org-property-start-re end t)
13430 (setq beg (1+ (match-end 0)))
13431 (if force
13432 (save-excursion
13433 (org-insert-property-drawer)
13434 (setq end (progn (outline-next-heading) (point))))
13435 (throw 'exit nil))
13436 (goto-char beg)
13437 (if (re-search-forward org-property-start-re end t)
13438 (setq beg (1+ (match-end 0)))))
13439 (if (re-search-forward org-property-end-re end t)
13440 (setq end (match-beginning 0))
13441 (or force (throw 'exit nil))
13442 (goto-char beg)
13443 (setq end beg)
13444 (org-indent-line-function)
13446 (cons beg end)))))
13448 (defun org-entry-properties (&optional pom which specific)
13449 "Get all properties of the entry at point-or-marker POM.
13450 This includes the TODO keyword, the tags, time strings for deadline,
13451 scheduled, and clocking, and any additional properties defined in the
13452 entry. The return value is an alist, keys may occur multiple times
13453 if the property key was used several times.
13454 POM may also be nil, in which case the current entry is used.
13455 If WHICH is nil or `all', get all properties. If WHICH is
13456 `special' or `standard', only get that subclass. If WHICH
13457 is a string only get exactly this property. Specific can be a string, the
13458 specific property we are interested in. Specifying it can speed
13459 things up because then unnecessary parsing is avoided."
13460 (setq which (or which 'all))
13461 (org-with-point-at pom
13462 (let ((clockstr (substring org-clock-string 0 -1))
13463 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13464 (case-fold-search nil)
13465 beg end range props sum-props key key1 value string clocksum)
13466 (save-excursion
13467 (when (condition-case nil
13468 (and (org-mode-p) (org-back-to-heading t))
13469 (error nil))
13470 (setq beg (point))
13471 (setq sum-props (get-text-property (point) 'org-summaries))
13472 (setq clocksum (get-text-property (point) :org-clock-minutes))
13473 (outline-next-heading)
13474 (setq end (point))
13475 (when (memq which '(all special))
13476 ;; Get the special properties, like TODO and tags
13477 (goto-char beg)
13478 (when (and (or (not specific) (string= specific "TODO"))
13479 (looking-at org-todo-line-regexp) (match-end 2))
13480 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13481 (when (and (or (not specific) (string= specific "PRIORITY"))
13482 (looking-at org-priority-regexp))
13483 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13484 (when (and (or (not specific) (string= specific "TAGS"))
13485 (setq value (org-get-tags-string))
13487 (push (cons "TAGS" value) props))
13488 (when (and (or (not specific) (string= specific "ALLTAGS"))
13489 (setq value (org-get-tags-at)))
13490 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13491 ":"))
13492 props))
13493 (when (or (not specific) (string= specific "BLOCKED"))
13494 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13495 (when (or (not specific)
13496 (member specific
13497 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13498 "TIMESTAMP" "TIMESTAMP_IA")))
13499 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13500 (setq key (if (match-end 1)
13501 (substring (org-match-string-no-properties 1)
13502 0 -1))
13503 string (if (equal key clockstr)
13504 (org-no-properties
13505 (org-trim
13506 (buffer-substring
13507 (match-beginning 3) (goto-char
13508 (point-at-eol)))))
13509 (substring (org-match-string-no-properties 3)
13510 1 -1)))
13511 ;; Get the correct property name from the key. This is
13512 ;; necessary if the user has configured time keywords.
13513 (setq key1 (concat key ":"))
13514 (cond
13515 ((not key)
13516 (setq key
13517 (if (= (char-after (match-beginning 3)) ?\[)
13518 "TIMESTAMP_IA" "TIMESTAMP")))
13519 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13520 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13521 ((equal key1 org-closed-string) (setq key "CLOSED"))
13522 ((equal key1 org-clock-string) (setq key "CLOCK")))
13523 (when (or (equal key "CLOCK") (not (assoc key props)))
13524 (push (cons key string) props))))
13525 )
13527 (when (memq which '(all standard))
13528 ;; Get the standard properties, like :PROP: ...
13529 (setq range (org-get-property-block beg end))
13530 (when range
13531 (goto-char (car range))
13532 (while (re-search-forward
13534 (cdr range) t)
13535 (setq key (org-match-string-no-properties 1)
13536 value (org-trim (or (org-match-string-no-properties 2) "")))
13537 (unless (member key excluded)
13538 (push (cons key (or value "")) props)))))
13539 (if clocksum
13540 (push (cons "CLOCKSUM"
13541 (org-columns-number-to-string (/ (float clocksum) 60.)
13542 'add_times))
13543 props))
13544 (unless (assoc "CATEGORY" props)
13545 (setq value (or (org-get-category)
13546 (progn (org-refresh-category-properties)
13547 (org-get-category))))
13548 (push (cons "CATEGORY" value) props))
13549 (append sum-props (nreverse props)))))))
13551 (defun org-entry-get (pom property &optional inherit literal-nil)
13552 "Get value of PROPERTY for entry at point-or-marker POM.
13553 If INHERIT is non-nil and the entry does not have the property,
13554 then also check higher levels of the hierarchy.
13555 If INHERIT is the symbol `selective', use inheritance only if the setting
13556 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13557 If the property is present but empty, the return value is the empty string.
13558 If the property is not present at all, nil is returned.
13561 do not interpret it as the list atom nil. This is used for inheritance
13563 (org-with-point-at pom
13564 (if (and inherit (if (eq inherit 'selective)
13565 (org-property-inherit-p property)
13566 t))
13567 (org-entry-get-with-inheritance property literal-nil)
13568 (if (member property org-special-properties)
13569 ;; We need a special property. Use `org-entry-properties' to
13570 ;; retrieve it, but specify the wanted property
13571 (cdr (assoc property (org-entry-properties nil 'special property)))
13572 (let ((range (org-get-property-block)))
13573 (if (and range
13574 (goto-char (car range))
13575 (re-search-forward
13577 (cdr range) t))
13578 ;; Found the property, return it.
13579 (if (match-end 1)
13580 (if literal-nil
13581 (org-match-string-no-properties 1)
13582 (org-not-nil (org-match-string-no-properties 1)))
13583 "")))))))
13585 (defun org-property-or-variable-value (var &optional inherit)
13586 "Check if there is a property fixing the value of VAR.
13587 If yes, return this value. If not, return the current value of the variable."
13588 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13590 (read prop)
13591 (symbol-value var))))
13593 (defun org-entry-delete (pom property)
13594 "Delete the property PROPERTY from entry at point-or-marker POM."
13595 (org-with-point-at pom
13596 (if (member property org-special-properties)
13597 nil ; cannot delete these properties.
13598 (let ((range (org-get-property-block)))
13599 (if (and range
13600 (goto-char (car range))
13601 (re-search-forward
13603 (cdr range) t))
13604 (progn
13605 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13606 t)
13607 nil)))))
13609 ;; Multi-values properties are properties that contain multiple values
13610 ;; These values are assumed to be single words, separated by whitespace.
13611 (defun org-entry-add-to-multivalued-property (pom property value)
13612 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13613 (let* ((old (org-entry-get pom property))
13615 (setq value (org-entry-protect-space value))
13616 (unless (member value values)
13617 (setq values (cons value values))
13618 (org-entry-put pom property
13619 (mapconcat 'identity values " ")))))
13621 (defun org-entry-remove-from-multivalued-property (pom property value)
13622 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13623 (let* ((old (org-entry-get pom property))
13625 (setq value (org-entry-protect-space value))
13626 (when (member value values)
13627 (setq values (delete value values))
13628 (org-entry-put pom property
13629 (mapconcat 'identity values " ")))))
13631 (defun org-entry-member-in-multivalued-property (pom property value)
13632 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13633 (let* ((old (org-entry-get pom property))
13635 (setq value (org-entry-protect-space value))
13636 (member value values)))
13638 (defun org-entry-get-multivalued-property (pom property)
13639 "Return a list of values in a multivalued property."
13640 (let* ((value (org-entry-get pom property))
13642 (mapcar 'org-entry-restore-space values)))
13644 (defun org-entry-put-multivalued-property (pom property &rest values)
13645 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13646 VALUES should be a list of strings. Spaces will be protected."
13647 (org-entry-put pom property
13648 (mapconcat 'org-entry-protect-space values " "))
13649 (let* ((value (org-entry-get pom property))
13651 (mapcar 'org-entry-restore-space values)))
13653 (defun org-entry-protect-space (s)
13654 "Protect spaces and newline in string S."
13655 (while (string-match " " s)
13656 (setq s (replace-match "%20" t t s)))
13658 (setq s (replace-match "%0A" t t s)))
13659 s)
13661 (defun org-entry-restore-space (s)
13662 "Restore spaces and newline in string S."
13663 (while (string-match "%20" s)
13664 (setq s (replace-match " " t t s)))
13665 (while (string-match "%0A" s)
13667 s)
13669 (defvar org-entry-property-inherited-from (make-marker)
13670 "Marker pointing to the entry from where a property was inherited.
13671 Each call to `org-entry-get-with-inheritance' will set this marker to the
13672 location of the entry where the inheritance search matched. If there was
13673 no match, the marker will point nowhere.
13674 Note that also `org-entry-get' calls this function, if the INHERIT flag
13675 is set.")
13677 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13678 "Get entry property, and search higher levels if not present.
13679 The search will stop at the first ancestor which has the property defined.
13681 should be considered as undefined (this is the meaning of nil here).
13683 (move-marker org-entry-property-inherited-from nil)
13684 (let (tmp)
13685 (save-excursion
13686 (save-restriction
13687 (widen)
13688 (catch 'ex
13689 (while t
13690 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13691 (org-back-to-heading t)
13692 (move-marker org-entry-property-inherited-from (point))
13693 (throw 'ex tmp))
13694 (or (org-up-heading-safe) (throw 'ex nil)))))
13695 (setq tmp (or tmp
13696 (cdr (assoc property org-file-properties))
13697 (cdr (assoc property org-global-properties))
13698 (cdr (assoc property org-global-properties-fixed))))
13699 (if literal-nil tmp (org-not-nil tmp)))))
13701 (defvar org-property-changed-functions nil
13702 "Hook called when the value of a property has changed.
13703 Each hook function should accept two arguments, the name of the property
13704 and the new value.")
13706 (defun org-entry-put (pom property value)
13707 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13708 (org-with-point-at pom
13709 (org-back-to-heading t)
13710 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13711 range)
13712 (cond
13713 ((equal property "TODO")
13715 (not (member value org-todo-keywords-1)))
13717 (if (or (not value)
13719 (setq value 'none))
13720 (org-todo value)
13721 (org-set-tags nil 'align))
13722 ((equal property "PRIORITY")
13724 (string-to-char value) ?\ ))
13725 (org-set-tags nil 'align))
13726 ((equal property "SCHEDULED")
13727 (if (re-search-forward org-scheduled-time-regexp end t)
13728 (cond
13729 ((eq value 'earlier) (org-timestamp-change -1 'day))
13730 ((eq value 'later) (org-timestamp-change 1 'day))
13731 (t (call-interactively 'org-schedule)))
13732 (call-interactively 'org-schedule)))
13733 ((equal property "DEADLINE")
13734 (if (re-search-forward org-deadline-time-regexp end t)
13735 (cond
13736 ((eq value 'earlier) (org-timestamp-change -1 'day))
13737 ((eq value 'later) (org-timestamp-change 1 'day))
13738 (t (call-interactively 'org-deadline)))
13739 (call-interactively 'org-deadline)))
13740 ((member property org-special-properties)
13741 (error "The %s property can not yet be set with `org-entry-put'"
13742 property))
13743 (t ; a non-special property
13744 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13745 (setq range (org-get-property-block beg end 'force))
13746 (goto-char (car range))
13747 (if (re-search-forward
13749 (progn
13750 (delete-region (match-beginning 1) (match-end 1))
13751 (goto-char (match-beginning 1)))
13752 (goto-char (cdr range))
13754 (backward-char 1)
13755 (org-indent-line-function)
13756 (insert ":" property ":"))
13757 (and value (insert " " value))
13758 (org-indent-line-function)))))
13759 (run-hook-with-args 'org-property-changed-functions property value)))
13761 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13762 "Get all property keys in the current buffer.
13763 With INCLUDE-SPECIALS, also list the special properties that reflect things
13764 like tags and TODO state.
13765 With INCLUDE-DEFAULTS, also include properties that has special meaning
13766 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
13767 With INCLUDE-COLUMNS, also include property names given in COLUMN
13768 formats in the current buffer."
13769 (let (rtn range cfmt s p)
13770 (save-excursion
13771 (save-restriction
13772 (widen)
13773 (goto-char (point-min))
13774 (while (re-search-forward org-property-start-re nil t)
13775 (setq range (org-get-property-block))
13776 (goto-char (car range))
13777 (while (re-search-forward
13779 (cdr range) t)
13780 (add-to-list 'rtn (org-match-string-no-properties 1)))
13781 (outline-next-heading))))
13783 (when include-specials
13784 (setq rtn (append org-special-properties rtn)))
13786 (when include-defaults
13787 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13788 (add-to-list 'rtn org-effort-property))
13790 (when include-columns
13791 (save-excursion
13792 (save-restriction
13793 (widen)
13794 (goto-char (point-min))
13795 (while (re-search-forward
13797 nil t)
13798 (setq cfmt (match-string 2) s 0)
13800 cfmt s)
13801 (setq s (match-end 0)
13802 p (match-string 1 cfmt))
13803 (unless (or (equal p "ITEM")
13804 (member p org-special-properties))
13805 (add-to-list 'rtn (match-string 1 cfmt))))))))
13807 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13809 (defun org-property-values (key)
13810 "Return a list of all values of property KEY."
13811 (save-excursion
13812 (save-restriction
13813 (widen)
13814 (goto-char (point-min))
13816 values)
13817 (while (re-search-forward re nil t)
13818 (add-to-list 'values (org-trim (match-string 1))))
13819 (delete "" values)))))
13821 (defun org-insert-property-drawer ()
13822 "Insert a property drawer into the current entry."
13823 (interactive)
13824 (org-back-to-heading t)
13825 (looking-at outline-regexp)
13826 (let ((indent (if org-adapt-indentation
13827 (- (match-end 0)(match-beginning 0))
13828 0))
13829 (beg (point))
13831 end hiddenp)
13832 (outline-next-heading)
13833 (setq end (point))
13834 (goto-char beg)
13835 (while (re-search-forward re end t))
13836 (setq hiddenp (org-invisible-p))
13837 (end-of-line 1)
13840 (if (member (match-string 1) '("CLOCK:" ":END:"))
13841 ;; just skip this line
13842 (beginning-of-line 2)
13843 ;; Drawer start, find the end
13845 (beginning-of-line 1)))
13846 (org-skip-over-state-notes)
13848 (if (eq (char-before) ?*) (forward-char 1))
13850 (beginning-of-line 0)
13851 (org-indent-to-column indent)
13852 (beginning-of-line 2)
13853 (org-indent-to-column indent)
13854 (beginning-of-line 0)
13855 (if hiddenp
13856 (save-excursion
13857 (org-back-to-heading t)
13858 (hide-entry))
13859 (org-flag-drawer t))))
13861 (defun org-set-property (property value)
13862 "In the current entry, set PROPERTY to VALUE.
13863 When called interactively, this will prompt for a property name, offering
13864 completion on existing and default properties. And then it will prompt
13865 for a value, offering completion either on allowed values (via an inherited
13866 xxx_ALL property) or on existing values in other instances of this property
13867 in the current file."
13868 (interactive
13869 (let* ((completion-ignore-case t)
13870 (keys (org-buffer-property-keys nil t t))
13871 (prop0 (org-icompleting-read "Property: " (mapcar 'list keys)))
13872 (prop (if (member prop0 keys)
13873 prop0
13874 (or (cdr (assoc (downcase prop0)
13875 (mapcar (lambda (x) (cons (downcase x) x))
13876 keys)))
13877 prop0)))
13878 (cur (org-entry-get nil prop))
13879 (prompt (concat prop " value"
13881 (concat " [" cur "]") "") ": "))
13882 (allowed (org-property-get-allowed-values nil prop 'table))
13883 (existing (mapcar 'list (org-property-values prop)))
13884 (val (if allowed
13885 (org-completing-read prompt allowed nil
13886 (not (get-text-property 0 'org-unrestricted
13887 (caar allowed))))
13888 (let (org-completion-use-ido org-completion-use-iswitchb)
13889 (org-completing-read prompt existing nil nil "" nil cur)))))
13890 (list prop (if (equal val "") cur val))))
13891 (unless (equal (org-entry-get nil property) value)
13892 (org-entry-put nil property value)))
13894 (defun org-delete-property (property)
13895 "In the current entry, delete PROPERTY."
13896 (interactive
13897 (let* ((completion-ignore-case t)
13898 (prop (org-icompleting-read "Property: "
13899 (org-entry-properties nil 'standard))))
13900 (list prop)))
13901 (message "Property %s %s" property
13902 (if (org-entry-delete nil property)
13903 "deleted"
13904 "was not present in the entry")))
13906 (defun org-delete-property-globally (property)
13907 "Remove PROPERTY globally, from all entries."
13908 (interactive
13909 (let* ((completion-ignore-case t)
13910 (prop (org-icompleting-read
13911 "Globally remove property: "
13912 (mapcar 'list (org-buffer-property-keys)))))
13913 (list prop)))
13914 (save-excursion
13915 (save-restriction
13916 (widen)
13917 (goto-char (point-min))
13918 (let ((cnt 0))
13919 (while (re-search-forward
13921 nil t)
13922 (setq cnt (1+ cnt))
13923 (replace-match ""))
13926 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
13928 (defun org-compute-property-at-point ()
13929 "Compute the property at point.
13930 This looks for an enclosing column format, extracts the operator and
13931 then applies it to the property in the column format's scope."
13932 (interactive)
13933 (unless (org-at-property-p)
13934 (error "Not at a property"))
13935 (let ((prop (org-match-string-no-properties 2)))
13936 (org-columns-get-format-and-top-level)
13937 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
13938 (error "No operator defined for property %s" prop))
13939 (org-columns-compute prop)))
13941 (defvar org-property-allowed-value-functions nil
13942 "Hook for functions supplying allowed values for a specific property.
13943 The functions must take a single argument, the name of the property, and
13945 the values, this means that these values are intended as defaults for
13946 completion, but that other values should be allowed too.
13947 The functions must return nil if they are not responsible for this
13948 property.")
13950 (defun org-property-get-allowed-values (pom property &optional table)
13951 "Get allowed values for the property PROPERTY.
13952 When TABLE is non-nil, return an alist that can directly be used for
13953 completion."
13954 (let (vals)
13955 (cond
13956 ((equal property "TODO")
13957 (setq vals (org-with-point-at pom
13958 (append org-todo-keywords-1 '("")))))
13959 ((equal property "PRIORITY")
13960 (let ((n org-lowest-priority))
13961 (while (>= n org-highest-priority)
13962 (push (char-to-string n) vals)
13963 (setq n (1- n)))))
13964 ((member property org-special-properties))
13965 ((setq vals (run-hook-with-args-until-success
13966 'org-property-allowed-value-functions property)))
13967 (t
13968 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
13970 (setq vals (car (read-from-string (concat "(" vals ")"))))
13971 (setq vals (mapcar (lambda (x)
13972 (cond ((stringp x) x)
13973 ((numberp x) (number-to-string x))
13974 ((symbolp x) (symbol-name x))
13975 (t "???")))
13976 vals)))))
13977 (when (member ":ETC" vals)
13978 (setq vals (remove ":ETC" vals))
13979 (org-add-props (car vals) '(org-unrestricted t)))
13980 (if table (mapcar 'list vals) vals)))
13982 (defun org-property-previous-allowed-value (&optional previous)
13983 "Switch to the next allowed value for this property."
13984 (interactive)
13985 (org-property-next-allowed-value t))
13987 (defun org-property-next-allowed-value (&optional previous)
13988 "Switch to the next allowed value for this property."
13989 (interactive)
13990 (unless (org-at-property-p)
13991 (error "Not at a property"))
13992 (let* ((key (match-string 2))
13993 (value (match-string 3))
13994 (allowed (or (org-property-get-allowed-values (point) key)
13995 (and (member value '("[ ]" "[-]" "[X]"))
13996 '("[ ]" "[X]"))))
13997 nval)
13998 (unless allowed
13999 (error "Allowed values for this property have not been defined"))
14000 (if previous (setq allowed (reverse allowed)))
14001 (if (member value allowed)
14002 (setq nval (car (cdr (member value allowed)))))
14003 (setq nval (or nval (car allowed)))
14004 (if (equal nval value)
14005 (error "Only one allowed value for this property"))
14006 (org-at-property-p)
14007 (replace-match (concat " :" key ": " nval) t t)
14008 (org-indent-line-function)
14009 (beginning-of-line 1)
14011 (run-hook-with-args 'org-property-changed-functions key nval)))
14013 (defun org-find-olp (path &optional this-buffer)
14014 "Return a marker pointing to the entry at outline path OLP.
14015 If anything goes wrong, throw an error.
14016 You can wrap this call to catch the error like this:
14018 (condition-case msg
14019 (org-mobile-locate-entry (match-string 4))
14020 (error (nth 1 msg)))
14022 The return value will then be either a string with the error message,
14023 or a marker if everything is OK.
14025 If THIS-BUFFER is set, the outline path does not contain a file,
14026 only headings."
14027 (let* ((file (if this-buffer buffer-file-name (pop path)))
14028 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14029 (level 1)
14030 (lmin 1)
14031 (lmax 1)
14032 limit re end found pos heading cnt)
14033 (unless buffer (error "File not found :%s" file))
14034 (with-current-buffer buffer
14035 (save-excursion
14036 (save-restriction
14037 (widen)
14038 (setq limit (point-max))
14039 (goto-char (point-min))
14040 (while (setq heading (pop path))
14041 (setq re (format org-complex-heading-regexp-format
14042 (regexp-quote heading)))
14043 (setq cnt 0 pos (point))
14044 (while (re-search-forward re end t)
14045 (setq level (- (match-end 1) (match-beginning 1)))
14046 (if (and (>= level lmin) (<= level lmax))
14047 (setq found (match-beginning 0) cnt (1+ cnt))))
14048 (when (= cnt 0) (error "Heading not found on level %d: %s"
14049 lmax heading))
14050 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14051 lmax heading))
14052 (goto-char found)
14053 (setq lmin (1+ level) lmax (+ lmin (if org-odd-levels-only 1 0)))
14054 (setq end (save-excursion (org-end-of-subtree t t))))
14055 (when (org-on-heading-p)
14056 (move-marker (make-marker) (point))))))))
14058 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14059 "Find node HEADING in BUFFER.
14060 Return a marker to the heading if it was found, or nil if not.
14061 If POS-ONLY is set, return just the position instead of a marker.
14063 The heading text must match exact, but it may have a TODO keyword,
14064 a priority cookie and tags in the standard locations."
14065 (with-current-buffer (or buffer (current-buffer))
14066 (save-excursion
14067 (save-restriction
14068 (widen)
14069 (goto-char (point-min))
14070 (let (case-fold-search)
14071 (if (re-search-forward
14072 (format org-complex-heading-regexp-format
14073 (regexp-quote heading)) nil t)
14074 (if pos-only
14075 (match-beginning 0)
14076 (move-marker (make-marker) (match-beginning 0)))))))))
14078 (defun org-find-exact-heading-in-directory (heading &optional dir)
14079 "Find Org node headline HEADING in all .org files in directory DIR.
14080 When the target headline is found, return a marker to this location."
14081 (let ((files (directory-files (or dir default-directory)
14083 file visiting m buffer)
14084 (catch 'found
14085 (while (setq file (pop files))
14086 (message "trying %s" file)
14087 (setq visiting (org-find-base-buffer-visiting file))
14088 (setq buffer (or visiting (find-file-noselect file)))
14089 (setq m (org-find-exact-headline-in-buffer
14090 heading buffer))
14091 (when (and (not m) (not visiting)) (kill-buffer buffer))
14092 (and m (throw 'found m))))))
14094 (defun org-find-entry-with-id (ident)
14095 "Locate the entry that contains the ID property with exact value IDENT.
14096 IDENT can be a string, a symbol or a number, this function will search for
14097 the string representation of it.
14098 Return the position where this entry starts, or nil if there is no such entry."
14099 (interactive "sID: ")
14100 (let ((id (cond
14101 ((stringp ident) ident)
14102 ((symbol-name ident) (symbol-name ident))
14103 ((numberp ident) (number-to-string ident))
14104 (t (error "IDENT %s must be a string, symbol or number" ident))))
14105 (case-fold-search nil))
14106 (save-excursion
14107 (save-restriction
14108 (widen)
14109 (goto-char (point-min))
14110 (when (re-search-forward
14112 nil t)
14113 (org-back-to-heading t)
14114 (point))))))
14116 ;;;; Timestamps
14118 (defvar org-last-changed-timestamp nil)
14119 (defvar org-last-inserted-timestamp nil
14120 "The last time stamp inserted with `org-insert-time-stamp'.")
14121 (defvar org-time-was-given) ; dynamically scoped parameter
14122 (defvar org-end-time-was-given) ; dynamically scoped parameter
14123 (defvar org-ts-what) ; dynamically scoped parameter
14125 (defun org-time-stamp (arg &optional inactive)
14126 "Prompt for a date/time and insert a time stamp.
14127 If the user specifies a time like HH:MM, or if this command is called
14128 with a prefix argument, the time stamp will contain date and time.
14129 Otherwise, only the date will be included. All parts of a date not
14130 specified by the user will be filled in from the current date/time.
14131 So if you press just return without typing anything, the time stamp
14132 will represent the current date/time. If there is already a timestamp
14133 at the cursor, it will be modified."
14134 (interactive "P")
14135 (let* ((ts nil)
14136 (default-time
14137 ;; Default time is either today, or, when entering a range,
14138 ;; the range start.
14139 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14140 (save-excursion
14141 (re-search-backward
14143 (- (point) 20) t)))
14144 (apply 'encode-time (org-parse-time-string (match-string 1)))
14145 (current-time)))
14146 (default-input (and ts (org-get-compact-tod ts)))
14147 org-time-was-given org-end-time-was-given time)
14148 (cond
14149 ((and (org-at-timestamp-p t)
14150 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14151 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14152 (insert "--")
14153 (setq time (let ((this-command this-command))
14154 (org-read-date arg 'totime nil nil
14155 default-time default-input)))
14156 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14157 ((org-at-timestamp-p t)
14158 (setq time (let ((this-command this-command))
14159 (org-read-date arg 'totime nil nil default-time default-input)))
14160 (when (org-at-timestamp-p t) ; just to get the match data
14161 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14162 (replace-match "")
14163 (setq org-last-changed-timestamp
14164 (org-insert-time-stamp
14165 time (or org-time-was-given arg)
14166 inactive nil nil (list org-end-time-was-given))))
14167 (message "Timestamp updated"))
14168 (t
14169 (setq time (let ((this-command this-command))
14170 (org-read-date arg 'totime nil nil default-time default-input)))
14171 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14172 nil nil (list org-end-time-was-given))))))
14174 ;; FIXME: can we use this for something else, like computing time differences?
14175 (defun org-get-compact-tod (s)
14176 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14177 (let* ((t1 (match-string 1 s))
14178 (h1 (string-to-number (match-string 2 s)))
14179 (m1 (string-to-number (match-string 3 s)))
14180 (t2 (and (match-end 4) (match-string 5 s)))
14181 (h2 (and t2 (string-to-number (match-string 6 s))))
14182 (m2 (and t2 (string-to-number (match-string 7 s))))
14183 dh dm)
14184 (if (not t2)
14185 t1
14186 (setq dh (- h2 h1) dm (- m2 m1))
14187 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14188 (concat t1 "+" (number-to-string dh)
14189 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14191 (defun org-time-stamp-inactive (&optional arg)
14192 "Insert an inactive time stamp.
14193 An inactive time stamp is enclosed in square brackets instead of angle
14194 brackets. It is inactive in the sense that it does not trigger agenda entries,
14195 does not link to the calendar and cannot be changed with the S-cursor keys.
14196 So these are more for recording a certain time/date."
14197 (interactive "P")
14198 (org-time-stamp arg 'inactive))
14200 (defvar org-date-ovl (make-overlay 1 1))
14201 (overlay-put org-date-ovl 'face 'org-warning)
14202 (org-detach-overlay org-date-ovl)
14204 (defvar org-ans1) ; dynamically scoped parameter
14205 (defvar org-ans2) ; dynamically scoped parameter
14207 (defvar org-plain-time-of-day-regexp) ; defined below
14209 (defvar org-overriding-default-time nil) ; dynamically scoped
14210 (defvar org-read-date-overlay nil)
14211 (defvar org-dcst nil) ; dynamically scoped
14212 (defvar org-read-date-history nil)
14213 (defvar org-read-date-final-answer nil)
14215 (defun org-read-date (&optional with-time to-time from-string prompt
14216 default-time default-input)
14217 "Read a date, possibly a time, and make things smooth for the user.
14218 The prompt will suggest to enter an ISO date, but you can also enter anything
14219 which will at least partially be understood by `parse-time-string'.
14220 Unrecognized parts of the date will default to the current day, month, year,
14221 hour and minute. If this command is called to replace a timestamp at point,
14222 of to enter the second timestamp of a range, the default time is taken
14223 from the existing stamp. Furthermore, the command prefers the future,
14224 so if you are giving a date where the year is not given, and the day-month
14225 combination is already past in the current year, it will assume you
14226 mean next year. For details, see the manual. A few examples:
14228 3-2-5 --> 2003-02-05
14229 feb 15 --> currentyear-02-15
14230 2/15 --> currentyear-02-15
14231 sep 12 9 --> 2009-09-12
14232 12:45 --> today 12:45
14233 22 sept 0:34 --> currentyear-09-22 0:34
14234 12 --> currentyear-currentmonth-12
14235 Fri --> nearest Friday (today or later)
14236 etc.
14238 Furthermore you can specify a relative date by giving, as the *first* thing
14239 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14240 change in days weeks, months, years.
14241 With a single plus or minus, the date is relative to today. With a double
14242 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14243 +4d --> four days from today
14244 +4 --> same as above
14245 +2w --> two weeks from today
14246 ++5 --> five days from default date
14248 The function understands only English month and weekday abbreviations,
14249 but this can be configured with the variables `parse-time-months' and
14250 `parse-time-weekdays'.
14252 While prompting, a calendar is popped up - you can also select the
14253 date with the mouse (button 1). The calendar shows a period of three
14254 months. To scroll it to other months, use the keys `>' and `<'.
14255 If you don't like the calendar, turn it off with
14256 \(setq org-read-date-popup-calendar nil)
14258 With optional argument TO-TIME, the date will immediately be converted
14259 to an internal time.
14260 With an optional argument WITH-TIME, the prompt will suggest to also
14261 insert a time. Note that when WITH-TIME is not set, you can still
14262 enter a time, and this function will inform the calling routine about
14263 this change. The calling routine may then choose to change the format
14264 used to insert the time stamp into the buffer to include the time.
14265 With optional argument FROM-STRING, read from this string instead from
14266 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14267 the time/date that is used for everything that is not specified by the
14268 user."
14269 (require 'parse-time)
14270 (let* ((org-time-stamp-rounding-minutes
14271 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14272 (org-dcst org-display-custom-times)
14273 (ct (org-current-time))
14274 (def (or org-overriding-default-time default-time ct))
14275 (defdecode (decode-time def))
14276 (dummy (progn
14277 (when (< (nth 2 defdecode) org-extend-today-until)
14278 (setcar (nthcdr 2 defdecode) -1)
14279 (setcar (nthcdr 1 defdecode) 59)
14280 (setq def (apply 'encode-time defdecode)
14281 defdecode (decode-time def)))))
14282 (calendar-frame-setup nil)
14283 (calendar-setup nil)
14284 (calendar-move-hook nil)
14285 (calendar-view-diary-initially-flag nil)
14286 (calendar-view-holidays-initially-flag nil)
14287 (timestr (format-time-string
14288 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14289 (prompt (concat (if prompt (concat prompt " ") "")
14290 (format "Date+time [%s]: " timestr)))
14291 ans (org-ans0 "") org-ans1 org-ans2 final)
14293 (cond
14294 (from-string (setq ans from-string))
14295 (org-read-date-popup-calendar
14296 (save-excursion
14297 (save-window-excursion
14298 (calendar)
14299 (calendar-forward-day (- (time-to-days def)
14300 (calendar-absolute-from-gregorian
14301 (calendar-current-date))))
14302 (org-eval-in-calendar nil t)
14303 (let* ((old-map (current-local-map))
14304 (map (copy-keymap calendar-mode-map))
14305 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14306 (org-defkey map (kbd "RET") 'org-calendar-select)
14307 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14308 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14309 (org-defkey minibuffer-local-map [(meta shift left)]
14310 (lambda () (interactive)
14311 (org-eval-in-calendar '(calendar-backward-month 1))))
14312 (org-defkey minibuffer-local-map [(meta shift right)]
14313 (lambda () (interactive)
14314 (org-eval-in-calendar '(calendar-forward-month 1))))
14315 (org-defkey minibuffer-local-map [(meta shift up)]
14316 (lambda () (interactive)
14317 (org-eval-in-calendar '(calendar-backward-year 1))))
14318 (org-defkey minibuffer-local-map [(meta shift down)]
14319 (lambda () (interactive)
14320 (org-eval-in-calendar '(calendar-forward-year 1))))
14321 (org-defkey minibuffer-local-map [?\e (shift left)]
14322 (lambda () (interactive)
14323 (org-eval-in-calendar '(calendar-backward-month 1))))
14324 (org-defkey minibuffer-local-map [?\e (shift right)]
14325 (lambda () (interactive)
14326 (org-eval-in-calendar '(calendar-forward-month 1))))
14327 (org-defkey minibuffer-local-map [?\e (shift up)]
14328 (lambda () (interactive)
14329 (org-eval-in-calendar '(calendar-backward-year 1))))
14330 (org-defkey minibuffer-local-map [?\e (shift down)]
14331 (lambda () (interactive)
14332 (org-eval-in-calendar '(calendar-forward-year 1))))
14333 (org-defkey minibuffer-local-map [(shift up)]
14334 (lambda () (interactive)
14335 (org-eval-in-calendar '(calendar-backward-week 1))))
14336 (org-defkey minibuffer-local-map [(shift down)]
14337 (lambda () (interactive)
14338 (org-eval-in-calendar '(calendar-forward-week 1))))
14339 (org-defkey minibuffer-local-map [(shift left)]
14340 (lambda () (interactive)
14341 (org-eval-in-calendar '(calendar-backward-day 1))))
14342 (org-defkey minibuffer-local-map [(shift right)]
14343 (lambda () (interactive)
14344 (org-eval-in-calendar '(calendar-forward-day 1))))
14345 (org-defkey minibuffer-local-map ">"
14346 (lambda () (interactive)
14347 (org-eval-in-calendar '(scroll-calendar-left 1))))
14348 (org-defkey minibuffer-local-map "<"
14349 (lambda () (interactive)
14350 (org-eval-in-calendar '(scroll-calendar-right 1))))
14351 (org-defkey minibuffer-local-map "\C-v"
14352 (lambda () (interactive)
14353 (org-eval-in-calendar
14354 '(calendar-scroll-left-three-months 1))))
14355 (org-defkey minibuffer-local-map "\M-v"
14356 (lambda () (interactive)
14357 (org-eval-in-calendar
14358 '(calendar-scroll-right-three-months 1))))
14359 (run-hooks 'org-read-date-minibuffer-setup-hook)
14360 (unwind-protect
14361 (progn
14362 (use-local-map map)
14363 (add-hook 'post-command-hook 'org-read-date-display)
14364 (setq org-ans0 (read-string prompt default-input
14365 'org-read-date-history nil))
14366 ;; org-ans0: from prompt
14367 ;; org-ans1: from mouse click
14368 ;; org-ans2: from calendar motion
14369 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14370 (remove-hook 'post-command-hook 'org-read-date-display)
14371 (use-local-map old-map)
14372 (when org-read-date-overlay
14373 (delete-overlay org-read-date-overlay)
14374 (setq org-read-date-overlay nil)))))))
14376 (t ; Naked prompt only
14377 (unwind-protect
14378 (setq ans (read-string prompt default-input
14379 'org-read-date-history timestr))
14380 (when org-read-date-overlay
14381 (delete-overlay org-read-date-overlay)
14382 (setq org-read-date-overlay nil)))))
14384 (setq final (org-read-date-analyze ans def defdecode))
14386 ;; One round trip to get rid of 34th of August and stuff like that....
14387 (setq final (decode-time (apply 'encode-time final)))
14389 (setq org-read-date-final-answer ans)
14391 (if to-time
14392 (apply 'encode-time final)
14393 (if (and (boundp 'org-time-was-given) org-time-was-given)
14394 (format "%04d-%02d-%02d %02d:%02d"
14395 (nth 5 final) (nth 4 final) (nth 3 final)
14396 (nth 2 final) (nth 1 final))
14397 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14399 (defvar def)
14400 (defvar defdecode)
14401 (defvar with-time)
14402 (defvar org-read-date-analyze-futurep nil)
14403 (defun org-read-date-display ()
14404 "Display the current date prompt interpretation in the minibuffer."
14405 (when org-read-date-display-live
14406 (when org-read-date-overlay
14407 (delete-overlay org-read-date-overlay))
14408 (let ((p (point)))
14409 (end-of-line 1)
14410 (while (not (equal (buffer-substring
14411 (max (point-min) (- (point) 4)) (point))
14412 " "))
14413 (insert " "))
14414 (goto-char p))
14415 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14416 " " (or org-ans1 org-ans2)))
14417 (org-end-time-was-given nil)
14418 (f (org-read-date-analyze ans def defdecode))
14419 (fmts (if org-dcst
14420 org-time-stamp-custom-formats
14421 org-time-stamp-formats))
14422 (fmt (if (or with-time
14423 (and (boundp 'org-time-was-given) org-time-was-given))
14424 (cdr fmts)
14425 (car fmts)))
14426 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14427 (when (and org-end-time-was-given
14428 (string-match org-plain-time-of-day-regexp txt))
14429 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14430 org-end-time-was-given
14431 (substring txt (match-end 0)))))
14432 (when org-read-date-analyze-futurep
14433 (setq txt (concat txt " (=>F)")))
14434 (setq org-read-date-overlay
14435 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14436 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14438 (defun org-read-date-analyze (ans def defdecode)
14439 "Analyze the combined answer of the date prompt."
14440 ;; FIXME: cleanup and comment
14441 (let ((nowdecode (decode-time (current-time)))
14442 delta deltan deltaw deltadef year month day
14443 hour minute second wday pm h2 m2 tl wday1
14444 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14445 (setq org-read-date-analyze-futurep nil)
14447 (setq ans "+0"))
14449 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14450 (setq ans (replace-match "" t t ans)
14451 deltan (car delta)
14452 deltaw (nth 1 delta)
14453 deltadef (nth 2 delta)))
14455 ;; Check if there is an iso week date in there
14456 ;; If yes, store the info and postpone interpreting it until the rest
14457 ;; of the parsing is done
14458 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14459 (setq iso-year (if (match-end 1)
14460 (org-small-year-to-year
14461 (string-to-number (match-string 1 ans))))
14462 iso-weekday (if (match-end 3)
14463 (string-to-number (match-string 3 ans)))
14464 iso-week (string-to-number (match-string 2 ans)))
14465 (setq ans (replace-match "" t t ans)))
14467 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14468 (when (string-match
14470 (setq year (if (match-end 2)
14471 (string-to-number (match-string 2 ans))
14472 (progn (setq kill-year t)
14473 (string-to-number (format-time-string "%Y"))))
14474 month (string-to-number (match-string 3 ans))
14475 day (string-to-number (match-string 4 ans)))
14476 (if (< year 100) (setq year (+ 2000 year)))
14478 t nil ans)))
14479 ;; Help matching american dates, like 5/30 or 5/30/7
14480 (when (string-match
14481 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14482 (setq year (if (match-end 4)
14483 (string-to-number (match-string 4 ans))
14484 (progn (setq kill-year t)
14485 (string-to-number (format-time-string "%Y"))))
14486 month (string-to-number (match-string 1 ans))
14487 day (string-to-number (match-string 2 ans)))
14488 (if (< year 100) (setq year (+ 2000 year)))
14490 t nil ans)))
14491 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14492 ;; If there is a time with am/pm, and *no* time without it, we convert
14493 ;; so that matching will be successful.
14494 (loop for i from 1 to 2 do ; twice, for end time as well
14497 (setq hour (string-to-number (match-string 1 ans))
14498 minute (if (match-end 3)
14499 (string-to-number (match-string 3 ans))
14500 0)
14501 pm (equal ?p
14502 (string-to-char (downcase (match-string 4 ans)))))
14503 (if (and (= hour 12) (not pm))
14504 (setq hour 0)
14505 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14506 (setq ans (replace-match (format "%02d:%02d" hour minute)
14507 t t ans))))
14509 ;; Check if a time range is given as a duration
14510 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14511 (setq hour (string-to-number (match-string 1 ans))
14512 h2 (+ hour (string-to-number (match-string 3 ans)))
14513 minute (string-to-number (match-string 2 ans))
14514 m2 (+ minute (if (match-end 5) (string-to-number
14515 (match-string 5 ans))0)))
14516 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14517 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14518 t t ans)))
14520 ;; Check if there is a time range
14521 (when (boundp 'org-end-time-was-given)
14522 (setq org-time-was-given nil)
14523 (when (and (string-match org-plain-time-of-day-regexp ans)
14524 (match-end 8))
14525 (setq org-end-time-was-given (match-string 8 ans))
14526 (setq ans (concat (substring ans 0 (match-beginning 7))
14527 (substring ans (match-end 7))))))
14529 (setq tl (parse-time-string ans)
14530 day (or (nth 3 tl) (nth 3 defdecode))
14531 month (or (nth 4 tl)
14532 (if (and org-read-date-prefer-future
14533 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14534 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14535 (nth 4 defdecode)))
14536 year (or (and (not kill-year) (nth 5 tl))
14537 (if (and org-read-date-prefer-future
14538 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14539 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14540 (nth 5 defdecode)))
14541 hour (or (nth 2 tl) (nth 2 defdecode))
14542 minute (or (nth 1 tl) (nth 1 defdecode))
14543 second (or (nth 0 tl) 0)
14544 wday (nth 6 tl))
14546 (when (and (eq org-read-date-prefer-future 'time)
14547 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14548 (equal day (nth 3 nowdecode))
14549 (equal month (nth 4 nowdecode))
14550 (equal year (nth 5 nowdecode))
14551 (nth 2 tl)
14552 (or (< (nth 2 tl) (nth 2 nowdecode))
14553 (and (= (nth 2 tl) (nth 2 nowdecode))
14554 (nth 1 tl)
14555 (< (nth 1 tl) (nth 1 nowdecode)))))
14556 (setq day (1+ day)
14557 futurep t))
14559 ;; Special date definitions below
14560 (cond
14561 (iso-week
14562 ;; There was an iso week
14563 (require 'cal-iso)
14564 (setq futurep nil)
14565 (setq year (or iso-year year)
14566 day (or iso-weekday wday 1)
14567 wday nil ; to make sure that the trigger below does not match
14568 iso-date (calendar-gregorian-from-absolute
14569 (calendar-absolute-from-iso
14570 (list iso-week day year))))
14571 ; FIXME: Should we also push ISO weeks into the future?
14572 ; (when (and org-read-date-prefer-future
14573 ; (not iso-year)
14574 ; (< (calendar-absolute-from-gregorian iso-date)
14575 ; (time-to-days (current-time))))
14576 ; (setq year (1+ year)
14577 ; iso-date (calendar-gregorian-from-absolute
14578 ; (calendar-absolute-from-iso
14579 ; (list iso-week day year)))))
14580 (setq month (car iso-date)
14581 year (nth 2 iso-date)
14582 day (nth 1 iso-date)))
14583 (deltan
14584 (setq futurep nil)
14585 (unless deltadef
14586 (let ((now (decode-time (current-time))))
14587 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14588 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14589 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14590 ((equal deltaw "m") (setq month (+ month deltan)))
14591 ((equal deltaw "y") (setq year (+ year deltan)))))
14592 ((and wday (not (nth 3 tl)))
14593 (setq futurep nil)
14594 ;; Weekday was given, but no day, so pick that day in the week
14595 ;; on or after the derived date.
14596 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14597 (unless (equal wday wday1)
14598 (setq day (+ day (% (- wday wday1 -7) 7))))))
14599 (if (and (boundp 'org-time-was-given)
14600 (nth 2 tl))
14601 (setq org-time-was-given t))
14602 (if (< year 100) (setq year (+ 2000 year)))
14603 (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
14604 (setq org-read-date-analyze-futurep futurep)
14605 (list second minute hour day month year)))
14607 (defvar parse-time-weekdays)
14609 (defun org-read-date-get-relative (s today default)
14610 "Check string S for special relative date string.
14611 TODAY and DEFAULT are internal times, for today and for a default.
14612 Return shift list (N what def-flag)
14614 N is the number of WHATs to shift.
14615 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14616 the DEFAULT date rather than TODAY."
14617 (when (and
14618 (string-match
14619 (concat
14624 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14625 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14626 (string-to-char (substring (match-string 1 s) -1))
14627 ?+))
14628 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14629 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14630 (what (if (match-end 3) (match-string 3 s) "d"))
14631 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14632 (date (if rel default today))
14633 (wday (nth 6 (decode-time date)))
14634 delta)
14635 (if wday1
14636 (progn
14637 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14638 (if (= dir ?-) (setq delta (- delta 7)))
14639 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14640 (list delta "d" rel))
14641 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14643 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14644 "Turn a user-specified date into the internal representation.
14645 The internal representation needed by the calendar is (month day year).
14646 This is a wrapper to handle the brain-dead convention in calendar that
14647 user function argument order change dependent on argument order."
14648 (if (boundp 'calendar-date-style)
14649 (cond
14650 ((eq calendar-date-style 'american)
14651 (list arg1 arg2 arg3))
14652 ((eq calendar-date-style 'european)
14653 (list arg2 arg1 arg3))
14654 ((eq calendar-date-style 'iso)
14655 (list arg2 arg3 arg1)))
14656 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
14657 (if (org-bound-and-true-p european-calendar-style)
14658 (list arg2 arg1 arg3)
14659 (list arg1 arg2 arg3)))))
14661 (defun org-eval-in-calendar (form &optional keepdate)
14662 "Eval FORM in the calendar window and return to current window.
14663 Also, store the cursor date in variable org-ans2."
14664 (let ((sf (selected-frame))
14665 (sw (selected-window)))
14666 (select-window (get-buffer-window "*Calendar*" t))
14667 (eval form)
14668 (when (and (not keepdate) (calendar-cursor-to-date))
14669 (let* ((date (calendar-cursor-to-date))
14670 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14671 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
14672 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
14673 (select-window sw)
14674 (org-select-frame-set-input-focus sf)))
14676 (defun org-calendar-select ()
14677 "Return to `org-read-date' with the date currently selected.
14678 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14679 (interactive)
14680 (when (calendar-cursor-to-date)
14681 (let* ((date (calendar-cursor-to-date))
14682 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14683 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14684 (if (active-minibuffer-window) (exit-minibuffer))))
14686 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
14687 "Insert a date stamp for the date given by the internal TIME.
14688 WITH-HM means use the stamp format that includes the time of the day.
14689 INACTIVE means use square brackets instead of angular ones, so that the
14690 stamp will not contribute to the agenda.
14691 PRE and POST are optional strings to be inserted before and after the
14692 stamp.
14693 The command returns the inserted time stamp."
14694 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
14695 stamp)
14696 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
14697 (insert-before-markers (or pre ""))
14698 (when (listp extra)
14699 (setq extra (car extra))
14700 (if (and (stringp extra)
14702 (setq extra (format "-%02d:%02d"
14703 (string-to-number (match-string 1 extra))
14704 (string-to-number (match-string 2 extra))))
14705 (setq extra nil)))
14706 (when extra
14707 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
14708 (insert-before-markers (setq stamp (format-time-string fmt time)))
14709 (insert-before-markers (or post ""))
14710 (setq org-last-inserted-timestamp stamp)))
14712 (defun org-toggle-time-stamp-overlays ()
14713 "Toggle the use of custom time stamp formats."
14714 (interactive)
14715 (setq org-display-custom-times (not org-display-custom-times))
14716 (unless org-display-custom-times
14717 (let ((p (point-min)) (bmp (buffer-modified-p)))
14718 (while (setq p (next-single-property-change p 'display))
14719 (if (and (get-text-property p 'display)
14720 (eq (get-text-property p 'face) 'org-date))
14721 (remove-text-properties
14722 p (setq p (next-single-property-change p 'display))
14723 '(display t))))
14724 (set-buffer-modified-p bmp)))
14725 (if (featurep 'xemacs)
14726 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
14727 (org-restart-font-lock)
14728 (setq org-table-may-need-update t)
14729 (if org-display-custom-times
14730 (message "Time stamps are overlayed with custom format")
14731 (message "Time stamp overlays removed")))
14733 (defun org-display-custom-time (beg end)
14734 "Overlay modified time stamp format over timestamp between BEG and END."
14735 (let* ((ts (buffer-substring beg end))
14736 t1 w1 with-hm tf time str w2 (off 0))
14737 (save-match-data
14738 (setq t1 (org-parse-time-string ts t))
14739 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
14740 (setq off (- (match-end 0) (match-beginning 0)))))
14741 (setq end (- end off))
14742 (setq w1 (- end beg)
14743 with-hm (and (nth 1 t1) (nth 2 t1))
14744 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
14745 time (org-fix-decoded-time t1)
14746 str (org-add-props
14747 (format-time-string
14748 (substring tf 1 -1) (apply 'encode-time time))
14749 nil 'mouse-face 'highlight)
14750 w2 (length str))
14751 (if (not (= w2 w1))
14752 (add-text-properties (1+ beg) (+ 2 beg)
14753 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
14754 (if (featurep 'xemacs)
14755 (progn
14756 (put-text-property beg end 'invisible t)
14757 (put-text-property beg end 'end-glyph (make-glyph str)))
14758 (put-text-property beg end 'display str))))
14760 (defun org-translate-time (string)
14761 "Translate all timestamps in STRING to custom format.
14762 But do this only if the variable `org-display-custom-times' is set."
14763 (when org-display-custom-times
14764 (save-match-data
14765 (let* ((start 0)
14766 (re org-ts-regexp-both)
14767 t1 with-hm inactive tf time str beg end)
14768 (while (setq start (string-match re string start))
14769 (setq beg (match-beginning 0)
14770 end (match-end 0)
14771 t1 (save-match-data
14772 (org-parse-time-string (substring string beg end) t))
14773 with-hm (and (nth 1 t1) (nth 2 t1))
14774 inactive (equal (substring string beg (1+ beg)) "[")
14775 tf (funcall (if with-hm 'cdr 'car)
14776 org-time-stamp-custom-formats)
14777 time (org-fix-decoded-time t1)
14778 str (format-time-string
14779 (concat
14780 (if inactive "[" "<") (substring tf 1 -1)
14781 (if inactive "]" ">"))
14782 (apply 'encode-time time))
14783 string (replace-match str t t string)
14784 start (+ start (length str)))))))
14785 string)
14787 (defun org-fix-decoded-time (time)
14788 "Set 0 instead of nil for the first 6 elements of time.
14789 Don't touch the rest."
14790 (let ((n 0))
14791 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
14793 (defun org-days-to-time (timestamp-string)
14794 "Difference between TIMESTAMP-STRING and now in days."
14795 (- (time-to-days (org-time-string-to-time timestamp-string))
14796 (time-to-days (current-time))))
14798 (defun org-deadline-close (timestamp-string &optional ndays)
14799 "Is the time in TIMESTAMP-STRING close to the current date?"
14800 (setq ndays (or ndays (org-get-wdays timestamp-string)))
14801 (and (< (org-days-to-time timestamp-string) ndays)
14802 (not (org-entry-is-done-p))))
14804 (defun org-get-wdays (ts)
14805 "Get the deadline lead time appropriate for timestring TS."
14806 (cond
14807 ((<= org-deadline-warning-days 0)
14808 ;; 0 or negative, enforce this value no matter what
14809 (- org-deadline-warning-days))
14811 ;; lead time is specified.
14812 (floor (* (string-to-number (match-string 1 ts))
14813 (cdr (assoc (match-string 2 ts)
14814 '(("d" . 1) ("w" . 7)
14815 ("m" . 30.4) ("y" . 365.25)))))))
14816 ;; go for the default.
14817 (t org-deadline-warning-days)))
14819 (defun org-calendar-select-mouse (ev)
14820 "Return to `org-read-date' with the date currently selected.
14821 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14822 (interactive "e")
14823 (mouse-set-point ev)
14824 (when (calendar-cursor-to-date)
14825 (let* ((date (calendar-cursor-to-date))
14826 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14827 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14828 (if (active-minibuffer-window) (exit-minibuffer))))
14830 (defun org-check-deadlines (ndays)
14831 "Check if there are any deadlines due or past due.
14832 A deadline is considered due if it happens within `org-deadline-warning-days'
14833 days from today's date. If the deadline appears in an entry marked DONE,
14834 it is not shown. The prefix arg NDAYS can be used to test that many
14836 (interactive "P")
14837 (let* ((org-warn-days
14838 (cond
14839 ((equal ndays '(4)) 100000)
14840 (ndays (prefix-numeric-value ndays))
14841 (t (abs org-deadline-warning-days))))
14842 (case-fold-search nil)
14844 (callback
14845 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
14847 (message "%d deadlines past-due or due within %d days"
14848 (org-occur regexp nil callback)
14849 org-warn-days)))
14851 (defun org-check-before-date (date)
14852 "Check if there are deadlines or scheduled entries before DATE."
14853 (interactive (list (org-read-date)))
14854 (let ((case-fold-search nil)
14858 (callback
14859 (lambda () (time-less-p
14860 (org-time-string-to-time (match-string 2))
14861 (org-time-string-to-time date)))))
14862 (message "%d entries before %s"
14863 (org-occur regexp nil callback) date)))
14865 (defun org-check-after-date (date)
14866 "Check if there are deadlines or scheduled entries after DATE."
14867 (interactive (list (org-read-date)))
14868 (let ((case-fold-search nil)
14872 (callback
14873 (lambda () (not
14874 (time-less-p
14875 (org-time-string-to-time (match-string 2))
14876 (org-time-string-to-time date))))))
14877 (message "%d entries after %s"
14878 (org-occur regexp nil callback) date)))
14880 (defun org-evaluate-time-range (&optional to-buffer)
14881 "Evaluate a time range by computing the difference between start and end.
14882 Normally the result is just printed in the echo area, but with prefix arg
14883 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
14884 If the time range is actually in a table, the result is inserted into the
14885 next column.
14886 For time difference computation, a year is assumed to be exactly 365
14887 days in order to avoid rounding problems."
14888 (interactive "P")
14889 (or
14890 (org-clock-update-time-maybe)
14891 (save-excursion
14892 (unless (org-at-date-range-p t)
14893 (goto-char (point-at-bol))
14894 (re-search-forward org-tr-regexp-both (point-at-eol) t))
14895 (if (not (org-at-date-range-p t))
14896 (error "Not at a time-stamp range, and none found in current line")))
14897 (let* ((ts1 (match-string 1))
14898 (ts2 (match-string 2))
14899 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
14900 (match-end (match-end 0))
14901 (time1 (org-time-string-to-time ts1))
14902 (time2 (org-time-string-to-time ts2))
14903 (t1 (org-float-time time1))
14904 (t2 (org-float-time time2))
14905 (diff (abs (- t2 t1)))
14906 (negative (< (- t2 t1) 0))
14907 ;; (ys (floor (* 365 24 60 60)))
14908 (ds (* 24 60 60))
14909 (hs (* 60 60))
14910 (fy "%dy %dd %02d:%02d")
14911 (fy1 "%dy %dd")
14912 (fd "%dd %02d:%02d")
14913 (fd1 "%dd")
14914 (fh "%02d:%02d")
14915 y d h m align)
14916 (if havetime
14917 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14918 y 0
14919 d (floor (/ diff ds)) diff (mod diff ds)
14920 h (floor (/ diff hs)) diff (mod diff hs)
14921 m (floor (/ diff 60)))
14922 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14923 y 0
14924 d (floor (+ (/ diff ds) 0.5))
14925 h 0 m 0))
14926 (if (not to-buffer)
14927 (message "%s" (org-make-tdiff-string y d h m))
14928 (if (org-at-table-p)
14929 (progn
14930 (goto-char match-end)
14931 (setq align t)
14932 (and (looking-at " *|") (goto-char (match-end 0))))
14933 (goto-char match-end))
14934 (if (looking-at
14936 (replace-match ""))
14937 (if negative (insert " -"))
14938 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
14939 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
14940 (insert " " (format fh h m))))
14941 (if align (org-table-align))
14942 (message "Time difference inserted")))))
14944 (defun org-make-tdiff-string (y d h m)
14945 (let ((fmt "")
14946 (l nil))
14947 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
14948 l (push y l)))
14949 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
14950 l (push d l)))
14951 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
14952 l (push h l)))
14953 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
14954 l (push m l)))
14955 (apply 'format fmt (nreverse l))))
14957 (defun org-time-string-to-time (s)
14958 (apply 'encode-time (org-parse-time-string s)))
14959 (defun org-time-string-to-seconds (s)
14960 (org-float-time (org-time-string-to-time s)))
14962 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
14963 "Convert a time stamp to an absolute day number.
14964 If there is a specifier for a cyclic time stamp, get the closest date to
14965 DAYNR.
14966 PREFER and SHOW-ALL are passed through to `org-closest-date'.
14967 the variable date is bound by the calendar when this is called."
14968 (cond
14970 (if (org-diary-sexp-entry (match-string 1 s) "" date)
14971 daynr
14972 (+ daynr 1000)))
14974 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
14975 (time-to-days (current-time))) (match-string 0 s)
14976 prefer show-all))
14977 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
14979 (defun org-days-to-iso-week (days)
14980 "Return the iso week number."
14981 (require 'cal-iso)
14982 (car (calendar-iso-from-absolute days)))
14984 (defun org-small-year-to-year (year)
14985 "Convert 2-digit years into 4-digit years.
14986 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
14987 The year 2000 cannot be abbreviated. Any year larger than 99
14988 is returned unchanged."
14989 (if (< year 38)
14990 (setq year (+ 2000 year))
14991 (if (< year 100)
14992 (setq year (+ 1900 year))))
14993 year)
14995 (defun org-time-from-absolute (d)
14996 "Return the time corresponding to date D.
14997 D may be an absolute day number, or a calendar-type list (month day year)."
14998 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
14999 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15001 (defun org-calendar-holiday ()
15002 "List of holidays, for Diary display in Org-mode."
15003 (require 'holidays)
15004 (let ((hl (funcall
15005 (if (fboundp 'calendar-check-holidays)
15006 'calendar-check-holidays 'check-calendar-holidays) date)))
15007 (if hl (mapconcat 'identity hl "; "))))
15009 (defun org-diary-sexp-entry (sexp entry date)
15010 "Process a SEXP diary ENTRY for DATE."
15011 (require 'diary-lib)
15012 (let ((result (if calendar-debug-sexp
15013 (let ((stack-trace-on-error t))
15014 (eval (car (read-from-string sexp))))
15015 (condition-case nil
15016 (eval (car (read-from-string sexp)))
15017 (error
15018 (beep)
15019 (message "Bad sexp at line %d in %s: %s"
15020 (org-current-line)
15021 (buffer-file-name) sexp)
15022 (sleep-for 2))))))
15023 (cond ((stringp result) result)
15024 ((and (consp result)
15025 (stringp (cdr result))) (cdr result))
15026 (result entry)
15027 (t nil))))
15029 (defun org-diary-to-ical-string (frombuf)
15030 "Get iCalendar entries from diary entries in buffer FROMBUF.
15031 This uses the icalendar.el library."
15032 (let* ((tmpdir (if (featurep 'xemacs)
15033 (temp-directory)
15034 temporary-file-directory))
15035 (tmpfile (make-temp-name
15036 (expand-file-name "orgics" tmpdir)))
15037 buf rtn b e)
15038 (with-current-buffer frombuf
15039 (icalendar-export-region (point-min) (point-max) tmpfile)
15040 (setq buf (find-buffer-visiting tmpfile))
15041 (set-buffer buf)
15042 (goto-char (point-min))
15043 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15044 (setq b (match-beginning 0)))
15045 (goto-char (point-max))
15046 (if (re-search-backward "^END:VEVENT" nil t)
15047 (setq e (match-end 0)))
15049 (kill-buffer buf)
15050 (delete-file tmpfile)
15051 rtn))
15053 (defun org-closest-date (start current change prefer show-all)
15054 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15055 When PREFER is `past' return a date that is either CURRENT or past.
15056 When PREFER is `future', return a date that is either CURRENT or future.
15057 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15058 ;; Make the proper lists from the dates
15059 (catch 'exit
15060 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15061 dn dw sday cday n1 n2 n0
15062 d m y y1 y2 date1 date2 nmonths nm ny m2)
15064 (setq start (org-date-to-gregorian start)
15065 current (org-date-to-gregorian
15066 (if show-all
15067 current
15068 (time-to-days (current-time))))
15069 sday (calendar-absolute-from-gregorian start)
15070 cday (calendar-absolute-from-gregorian current))
15072 (if (<= cday sday) (throw 'exit sday))
15075 (setq dn (string-to-number (match-string 1 change))
15076 dw (cdr (assoc (match-string 2 change) a1)))
15077 (error "Invalid change specifier: %s" change))
15078 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15079 (cond
15080 ((eq dw 'day)
15081 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15082 n2 (+ n1 dn)))
15083 ((eq dw 'year)
15084 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15085 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15086 (setq date1 (list m d y1)
15087 n1 (calendar-absolute-from-gregorian date1)
15088 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15089 n2 (calendar-absolute-from-gregorian date2)))
15090 ((eq dw 'month)
15091 ;; approx number of month between the two dates
15092 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15093 ;; How often does dn fit in there?
15094 (setq d (nth 1 start) m (car start) y (nth 2 start)
15095 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15096 m (+ m nm)
15097 ny (floor (/ m 12))
15098 y (+ y ny)
15099 m (- m (* ny 12)))
15100 (while (> m 12) (setq m (- m 12) y (1+ y)))
15101 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15102 (setq m2 (+ m dn) y2 y)
15103 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15104 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15105 (while (<= n2 cday)
15106 (setq n1 n2 m m2 y y2)
15107 (setq m2 (+ m dn) y2 y)
15108 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15109 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15110 ;; Make sure n1 is the earlier date
15111 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15112 (if show-all
15113 (cond
15114 ((eq prefer 'past) (if (= cday n2) n2 n1))
15115 ((eq prefer 'future) (if (= cday n1) n1 n2))
15116 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15117 (cond
15118 ((eq prefer 'past) (if (= cday n2) n2 n1))
15119 ((eq prefer 'future) (if (= cday n1) n1 n2))
15120 (t (if (= cday n1) n1 n2)))))))
15122 (defun org-date-to-gregorian (date)
15123 "Turn any specification of DATE into a Gregorian date for the calendar."
15124 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15125 ((and (listp date) (= (length date) 3)) date)
15126 ((stringp date)
15127 (setq date (org-parse-time-string date))
15128 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15129 ((listp date)
15130 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15132 (defun org-parse-time-string (s &optional nodefault)
15133 "Parse the standard Org-mode time string.
15134 This should be a lot faster than the normal `parse-time-string'.
15135 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15136 hour and minute fields will be nil if not given."
15137 (if (string-match org-ts-regexp0 s)
15138 (list 0
15139 (if (or (match-beginning 8) (not nodefault))
15140 (string-to-number (or (match-string 8 s) "0")))
15141 (if (or (match-beginning 7) (not nodefault))
15142 (string-to-number (or (match-string 7 s) "0")))
15143 (string-to-number (match-string 4 s))
15144 (string-to-number (match-string 3 s))
15145 (string-to-number (match-string 2 s))
15146 nil nil nil)
15147 (error "Not a standard Org-mode time string: %s" s)))
15149 (defun org-timestamp-up (&optional arg)
15150 "Increase the date item at the cursor by one.
15151 If the cursor is on the year, change the year. If it is on the month or
15152 the day, change that.
15153 With prefix ARG, change by that many units."
15154 (interactive "p")
15155 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15157 (defun org-timestamp-down (&optional arg)
15158 "Decrease the date item at the cursor by one.
15159 If the cursor is on the year, change the year. If it is on the month or
15160 the day, change that.
15161 With prefix ARG, change by that many units."
15162 (interactive "p")
15163 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15165 (defun org-timestamp-up-day (&optional arg)
15166 "Increase the date in the time stamp by one day.
15167 With prefix ARG, change that many days."
15168 (interactive "p")
15169 (if (and (not (org-at-timestamp-p t))
15170 (org-on-heading-p))
15171 (org-todo 'up)
15172 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15174 (defun org-timestamp-down-day (&optional arg)
15175 "Decrease the date in the time stamp by one day.
15176 With prefix ARG, change that many days."
15177 (interactive "p")
15178 (if (and (not (org-at-timestamp-p t))
15179 (org-on-heading-p))
15180 (org-todo 'down)
15181 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15183 (defun org-at-timestamp-p (&optional inactive-ok)
15184 "Determine if the cursor is in or at a timestamp."
15185 (interactive)
15186 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15187 (pos (point))
15188 (ans (or (looking-at tsr)
15189 (save-excursion
15191 (if (> (point) (point-min)) (backward-char 1))
15192 (and (looking-at tsr)
15193 (> (- (match-end 0) pos) -1))))))
15194 (and ans
15195 (boundp 'org-ts-what)
15196 (setq org-ts-what
15197 (cond
15198 ((= pos (match-beginning 0)) 'bracket)
15199 ((= pos (1- (match-end 0))) 'bracket)
15200 ((org-pos-in-match-range pos 2) 'year)
15201 ((org-pos-in-match-range pos 3) 'month)
15202 ((org-pos-in-match-range pos 7) 'hour)
15203 ((org-pos-in-match-range pos 8) 'minute)
15204 ((or (org-pos-in-match-range pos 4)
15205 (org-pos-in-match-range pos 5)) 'day)
15206 ((and (> pos (or (match-end 8) (match-end 5)))
15207 (< pos (match-end 0)))
15208 (- pos (or (match-end 8) (match-end 5))))
15209 (t 'day))))
15210 ans))
15212 (defun org-toggle-timestamp-type ()
15213 "Toggle the type (<active> or [inactive]) of a time stamp."
15214 (interactive)
15215 (when (org-at-timestamp-p t)
15216 (let ((beg (match-beginning 0)) (end (match-end 0))
15217 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15218 (save-excursion
15219 (goto-char beg)
15220 (while (re-search-forward "[][<>]" end t)
15221 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15222 t t)))
15223 (message "Timestamp is now %sactive"
15224 (if (equal (char-after beg) ?<) "" "in")))))
15226 (defun org-timestamp-change (n &optional what updown)
15227 "Change the date in the time stamp at point.
15228 The date will be changed by N times WHAT. WHAT can be `day', `month',
15229 `year', `minute', `second'. If WHAT is not given, the cursor position
15230 in the timestamp determines what will be changed."
15231 (let ((pos (point))
15232 with-hm inactive
15233 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15234 org-ts-what
15235 extra rem
15236 ts time time0)
15237 (if (not (org-at-timestamp-p t))
15238 (error "Not at a timestamp"))
15239 (if (and (not what) (eq org-ts-what 'bracket))
15240 (org-toggle-timestamp-type)
15241 (if (and (not what) (not (eq org-ts-what 'day))
15242 org-display-custom-times
15243 (get-text-property (point) 'display)
15244 (not (get-text-property (1- (point)) 'display)))
15245 (setq org-ts-what 'day))
15246 (setq org-ts-what (or what org-ts-what)
15247 inactive (= (char-after (match-beginning 0)) ?\[)
15248 ts (match-string 0))
15249 (replace-match "")
15250 (if (string-match
15252 ts)
15253 (setq extra (match-string 1 ts)))
15255 (setq with-hm t))
15256 (setq time0 (org-parse-time-string ts))
15257 (when (and updown
15258 (eq org-ts-what 'minute)
15259 (not current-prefix-arg))
15260 ;; This looks like s-up and s-down. Change by one rounding step.
15261 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15262 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15263 (setcar (cdr time0) (+ (nth 1 time0)
15264 (if (> n 0) (- rem) (- dm rem))))))
15265 (setq time
15266 (encode-time (or (car time0) 0)
15267 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15268 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15269 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15270 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15271 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15272 (nthcdr 6 time0)))
15273 (when (and (member org-ts-what '(hour minute))
15274 extra
15276 (setq extra (org-modify-ts-extra
15277 extra
15278 (if (eq org-ts-what 'hour) 2 5)
15279 n dm)))
15280 (when (integerp org-ts-what)
15281 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15282 (if (eq what 'calendar)
15283 (let ((cal-date (org-get-date-from-calendar)))
15284 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15285 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15286 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15287 (setcar time0 (or (car time0) 0))
15288 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15289 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15290 (setq time (apply 'encode-time time0))))
15291 (setq org-last-changed-timestamp
15292 (org-insert-time-stamp time with-hm inactive nil nil extra))
15293 (org-clock-update-time-maybe)
15294 (goto-char pos)
15295 ;; Try to recenter the calendar window, if any
15296 (if (and org-calendar-follow-timestamp-change
15297 (get-buffer-window "*Calendar*" t)
15298 (memq org-ts-what '(day month year)))
15299 (org-recenter-calendar (time-to-days time))))))
15301 (defun org-modify-ts-extra (s pos n dm)
15302 "Change the different parts of the lead-time and repeat fields in timestamp."
15303 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15304 ng h m new rem)
15305 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15306 (cond
15307 ((or (org-pos-in-match-range pos 2)
15308 (org-pos-in-match-range pos 3))
15309 (setq m (string-to-number (match-string 3 s))
15310 h (string-to-number (match-string 2 s)))
15311 (if (org-pos-in-match-range pos 2)
15312 (setq h (+ h n))
15313 (setq n (* dm (org-no-warnings (signum n))))
15314 (when (not (= 0 (setq rem (% m dm))))
15315 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15316 (setq m (+ m n)))
15317 (if (< m 0) (setq m (+ m 60) h (1- h)))
15318 (if (> m 59) (setq m (- m 60) h (1+ h)))
15319 (setq h (min 24 (max 0 h)))
15320 (setq ng 1 new (format "-%02d:%02d" h m)))
15321 ((org-pos-in-match-range pos 6)
15322 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15323 ((org-pos-in-match-range pos 5)
15324 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15326 ((org-pos-in-match-range pos 9)
15327 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15328 ((org-pos-in-match-range pos 8)
15329 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15331 (when ng
15332 (setq s (concat
15333 (substring s 0 (match-beginning ng))
15334 new
15335 (substring s (match-end ng))))))
15336 s))
15338 (defun org-recenter-calendar (date)
15339 "If the calendar is visible, recenter it to DATE."
15340 (let* ((win (selected-window))
15341 (cwin (get-buffer-window "*Calendar*" t))
15342 (calendar-move-hook nil))
15343 (when cwin
15344 (select-window cwin)
15345 (calendar-goto-date (if (listp date) date
15346 (calendar-gregorian-from-absolute date)))
15347 (select-window win))))
15349 (defun org-goto-calendar (&optional arg)
15350 "Go to the Emacs calendar at the current date.
15351 If there is a time stamp in the current line, go to that date.
15352 A prefix ARG can be used to force the current date."
15353 (interactive "P")
15354 (let ((tsr org-ts-regexp) diff
15355 (calendar-move-hook nil)
15356 (calendar-view-holidays-initially-flag nil)
15357 (calendar-view-diary-initially-flag nil))
15358 (if (or (org-at-timestamp-p)
15359 (save-excursion
15360 (beginning-of-line 1)
15361 (looking-at (concat ".*" tsr))))
15362 (let ((d1 (time-to-days (current-time)))
15363 (d2 (time-to-days
15364 (org-time-string-to-time (match-string 1)))))
15365 (setq diff (- d2 d1))))
15366 (calendar)
15367 (calendar-goto-today)
15368 (if (and diff (not arg)) (calendar-forward-day diff))))
15370 (defun org-get-date-from-calendar ()
15371 "Return a list (month day year) of date at point in calendar."
15372 (with-current-buffer "*Calendar*"
15373 (save-match-data
15374 (calendar-cursor-to-date))))
15376 (defun org-date-from-calendar ()
15377 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15378 If there is already a time stamp at the cursor position, update it."
15379 (interactive)
15380 (if (org-at-timestamp-p t)
15381 (org-timestamp-change 0 'calendar)
15382 (let ((cal-date (org-get-date-from-calendar)))
15383 (org-insert-time-stamp
15384 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15386 (defun org-minutes-to-hh:mm-string (m)
15387 "Compute H:MM from a number of minutes."
15388 (let ((h (/ m 60)))
15389 (setq m (- m (* 60 h)))
15390 (format org-time-clocksum-format h m)))
15392 (defun org-hh:mm-string-to-minutes (s)
15393 "Convert a string H:MM to a number of minutes.
15394 If the string is just a number, interpret it as minutes.
15395 In fact, the first hh:mm or number in the string will be taken,
15396 there can be extra stuff in the string.
15397 If no number is found, the return value is 0."
15398 (cond
15400 (+ (* (string-to-number (match-string 1 s)) 60)
15401 (string-to-number (match-string 2 s))))
15403 (string-to-number (match-string 1 s)))
15404 (t 0)))
15406 ;;;; Files
15408 (defun org-save-all-org-buffers ()
15409 "Save all Org-mode buffers without user confirmation."
15410 (interactive)
15411 (message "Saving all Org-mode buffers...")
15412 (save-some-buffers t 'org-mode-p)
15413 (when (featurep 'org-id) (org-id-locations-save))
15414 (message "Saving all Org-mode buffers... done"))
15416 (defun org-revert-all-org-buffers ()
15417 "Revert all Org-mode buffers.
15418 Prompt for confirmation when there are unsaved changes.
15419 Be sure you know what you are doing before letting this function
15420 overwrite your changes.
15422 This function is useful in a setup where one tracks org files
15423 with a version control system, to revert on one machine after pulling
15424 changes from another. I believe the procedure must be like this:
15426 1. M-x org-save-all-org-buffers
15427 2. Pull changes from the other machine, resolve conflicts
15428 3. M-x org-revert-all-org-buffers"
15429 (interactive)
15430 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15431 (error "Abort"))
15432 (save-excursion
15433 (save-window-excursion
15434 (mapc
15435 (lambda (b)
15436 (when (and (with-current-buffer b (org-mode-p))
15437 (with-current-buffer b buffer-file-name))
15438 (switch-to-buffer b)
15439 (revert-buffer t 'no-confirm)))
15440 (buffer-list))
15441 (when (and (featurep 'org-id) org-id-track-globally)
15442 (org-id-locations-load)))))
15444 ;;;; Agenda files
15446 ;;;###autoload
15447 (defun org-switchb (&optional arg)
15448 "Switch between Org buffers.
15449 With a prefix argument, restrict available to files.
15450 With two prefix arguments, restrict available buffers to agenda files.
15452 Defaults to `iswitchb' for buffer name completion.
15453 Set `org-completion-use-ido' to make it use ido instead."
15454 (interactive "P")
15455 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15456 ((equal arg '(16)) (org-buffer-list 'agenda))
15457 (t (org-buffer-list))))
15458 (org-completion-use-iswitchb org-completion-use-iswitchb)
15459 (org-completion-use-ido org-completion-use-ido))
15460 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15461 (setq org-completion-use-iswitchb t))
15462 (switch-to-buffer
15463 (org-icompleting-read "Org buffer: "
15464 (mapcar 'list (mapcar 'buffer-name blist))
15465 nil t))))
15467 ;;; Define some older names previously used for this functionality
15468 ;;;###autoload
15469 (defalias 'org-ido-switchb 'org-switchb)
15470 ;;;###autoload
15471 (defalias 'org-iswitchb 'org-switchb)
15473 (defun org-buffer-list (&optional predicate exclude-tmp)
15474 "Return a list of Org buffers.
15475 PREDICATE can be `export', `files' or `agenda'.
15477 export restrict the list to Export buffers.
15478 files restrict the list to buffers visiting Org files.
15479 agenda restrict the list to buffers visiting agenda files.
15481 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15482 (let* ((bfn nil)
15483 (agenda-files (and (eq predicate 'agenda)
15484 (mapcar 'file-truename (org-agenda-files t))))
15485 (filter
15486 (cond
15487 ((eq predicate 'files)
15488 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
15489 ((eq predicate 'export)
15490 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15491 ((eq predicate 'agenda)
15492 (lambda (b)
15493 (with-current-buffer b
15494 (and (eq major-mode 'org-mode)
15495 (setq bfn (buffer-file-name b))
15496 (member (file-truename bfn) agenda-files)))))
15497 (t (lambda (b) (with-current-buffer b
15498 (or (eq major-mode 'org-mode)
15499 (string-match "\*Org .*Export"
15500 (buffer-name b)))))))))
15501 (delq nil
15502 (mapcar
15503 (lambda(b)
15504 (if (and (funcall filter b)
15505 (or (not exclude-tmp)
15506 (not (string-match "tmp" (buffer-name b)))))
15507 b
15508 nil))
15509 (buffer-list)))))
15511 (defun org-agenda-files (&optional unrestricted archives)
15512 "Get the list of agenda files.
15513 Optional UNRESTRICTED means return the full list even if a restriction
15514 is currently in place.
15515 When ARCHIVES is t, include all archive files that are really being
15516 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15517 `org-agenda-archives-mode' is t."
15518 (let ((files
15519 (cond
15520 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15521 ((stringp org-agenda-files) (org-read-agenda-file-list))
15522 ((listp org-agenda-files) org-agenda-files)
15523 (t (error "Invalid value of `org-agenda-files'")))))
15524 (setq files (apply 'append
15525 (mapcar (lambda (f)
15526 (if (file-directory-p f)
15527 (directory-files
15528 f t org-agenda-file-regexp)
15529 (list f)))
15530 files)))
15531 (when org-agenda-skip-unavailable-files
15532 (setq files (delq nil
15533 (mapcar (function
15534 (lambda (file)
15535 (and (file-readable-p file) file)))
15536 files))))
15537 (when (or (eq archives t)
15538 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15539 (setq files (org-add-archive-files files)))
15540 files))
15542 (defun org-agenda-file-p (&optional file)
15543 "Return non-nil, if FILE is an agenda file.
15544 If FILE is omitted, use the file associated with the current
15545 buffer."
15546 (member (or file (buffer-file-name))
15547 (org-agenda-files t)))
15549 (defun org-edit-agenda-file-list ()
15550 "Edit the list of agenda files.
15551 Depending on setup, this either uses customize to edit the variable
15552 `org-agenda-files', or it visits the file that is holding the list. In the
15553 latter case, the buffer is set up in a way that saving it automatically kills
15554 the buffer and restores the previous window configuration."
15555 (interactive)
15556 (if (stringp org-agenda-files)
15557 (let ((cw (current-window-configuration)))
15558 (find-file org-agenda-files)
15559 (org-set-local 'org-window-configuration cw)
15560 (org-add-hook 'after-save-hook
15561 (lambda ()
15562 (set-window-configuration
15563 (prog1 org-window-configuration
15564 (kill-buffer (current-buffer))))
15565 (org-install-agenda-files-menu)
15566 (message "New agenda file list installed"))
15567 nil 'local)
15568 (message "%s" (substitute-command-keys
15570 (customize-variable 'org-agenda-files)))
15572 (defun org-store-new-agenda-file-list (list)
15573 "Set new value for the agenda file list and save it correctly."
15574 (if (stringp org-agenda-files)
15575 (let ((fe (org-read-agenda-file-list t)) b u)
15576 (while (setq b (find-buffer-visiting org-agenda-files))
15577 (kill-buffer b))
15578 (with-temp-file org-agenda-files
15579 (insert
15580 (mapconcat
15581 (lambda (f) ;; Keep un-expanded entries.
15582 (if (setq u (assoc f fe))
15583 (cdr u)
15584 f))
15587 (let ((org-mode-hook nil) (org-inhibit-startup t)
15588 (org-insert-mode-line-in-empty-file nil))
15589 (setq org-agenda-files list)
15590 (customize-save-variable 'org-agenda-files org-agenda-files))))
15592 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15593 "Read the list of agenda files from a file.
15594 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15595 filenames, used by `org-store-new-agenda-file-list' to write back
15596 un-expanded file names."
15597 (when (file-directory-p org-agenda-files)
15598 (error "`org-agenda-files' cannot be a single directory"))
15599 (when (stringp org-agenda-files)
15600 (with-temp-buffer
15601 (insert-file-contents org-agenda-files)
15602 (mapcar
15603 (lambda (f)
15604 (let ((e (expand-file-name (substitute-in-file-name f)
15605 org-directory)))
15606 (if pair-with-expansion
15607 (cons e f)
15608 e)))
15611 ;;;###autoload
15612 (defun org-cycle-agenda-files ()
15613 "Cycle through the files in `org-agenda-files'.
15614 If the current buffer visits an agenda file, find the next one in the list.
15615 If the current buffer does not, find the first agenda file."
15616 (interactive)
15617 (let* ((fs (org-agenda-files t))
15618 (files (append fs (list (car fs))))
15619 (tcf (if buffer-file-name (file-truename buffer-file-name)))
15620 file)
15621 (unless files (error "No agenda files"))
15622 (catch 'exit
15623 (while (setq file (pop files))
15624 (if (equal (file-truename file) tcf)
15625 (when (car files)
15626 (find-file (car files))
15627 (throw 'exit t))))
15628 (find-file (car fs)))
15629 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
15631 (defun org-agenda-file-to-front (&optional to-end)
15632 "Move/add the current file to the top of the agenda file list.
15633 If the file is not present in the list, it is added to the front. If it is
15634 present, it is moved there. With optional argument TO-END, add/move to the
15635 end of the list."
15636 (interactive "P")
15637 (let ((org-agenda-skip-unavailable-files nil)
15638 (file-alist (mapcar (lambda (x)
15639 (cons (file-truename x) x))
15640 (org-agenda-files t)))
15641 (ctf (file-truename buffer-file-name))
15642 x had)
15643 (setq x (assoc ctf file-alist) had x)
15645 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
15646 (if to-end
15647 (setq file-alist (append (delq x file-alist) (list x)))
15648 (setq file-alist (cons x (delq x file-alist))))
15649 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
15650 (org-install-agenda-files-menu)
15651 (message "File %s to %s of agenda file list"
15652 (if had "moved" "added") (if to-end "end" "front"))))
15654 (defun org-remove-file (&optional file)
15655 "Remove current file from the list of files in variable `org-agenda-files'.
15656 These are the files which are being checked for agenda entries.
15657 Optional argument FILE means use this file instead of the current."
15658 (interactive)
15659 (let* ((org-agenda-skip-unavailable-files nil)
15660 (file (or file buffer-file-name))
15661 (true-file (file-truename file))
15662 (afile (abbreviate-file-name file))
15663 (files (delq nil (mapcar
15664 (lambda (x)
15665 (if (equal true-file
15666 (file-truename x))
15667 nil x))
15668 (org-agenda-files t)))))
15669 (if (not (= (length files) (length (org-agenda-files t))))
15670 (progn
15671 (org-store-new-agenda-file-list files)
15672 (org-install-agenda-files-menu)
15673 (message "Removed file: %s" afile))
15674 (message "File was not in list: %s (not removed)" afile))))
15676 (defun org-file-menu-entry (file)
15677 (vector file (list 'find-file file) t))
15679 (defun org-check-agenda-file (file)
15680 "Make sure FILE exists. If not, ask user what to do."
15681 (when (not (file-exists-p file))
15682 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
15683 (abbreviate-file-name file))
15684 (let ((r (downcase (read-char-exclusive))))
15685 (cond
15686 ((equal r ?r)
15687 (org-remove-file file)
15688 (throw 'nextfile t))
15689 (t (error "Abort"))))))
15691 (defun org-get-agenda-file-buffer (file)
15692 "Get a buffer visiting FILE. If the buffer needs to be created, add
15693 it to the list of buffers which might be released later."
15694 (let ((buf (org-find-base-buffer-visiting file)))
15695 (if buf
15696 buf ; just return it
15697 ;; Make a new buffer and remember it
15698 (setq buf (find-file-noselect file))
15699 (if buf (push buf org-agenda-new-buffers))
15700 buf)))
15702 (defun org-release-buffers (blist)
15703 "Release all buffers in list, asking the user for confirmation when needed.
15704 When a buffer is unmodified, it is just killed. When modified, it is saved
15705 \(if the user agrees) and then killed."
15706 (let (buf file)
15707 (while (setq buf (pop blist))
15708 (setq file (buffer-file-name buf))
15709 (when (and (buffer-modified-p buf)
15710 file
15711 (y-or-n-p (format "Save file %s? " file)))
15712 (with-current-buffer buf (save-buffer)))
15713 (kill-buffer buf))))
15715 (defun org-prepare-agenda-buffers (files)
15716 "Create buffers for all agenda files, protect archived trees and comments."
15717 (interactive)
15718 (let ((pa '(:org-archived t))
15719 (pc '(:org-comment t))
15720 (pall '(:org-archived t :org-comment t))
15721 (inhibit-read-only t)
15722 (rea (concat ":" org-archive-tag ":"))
15723 bmp file re)
15724 (save-excursion
15725 (save-restriction
15726 (while (setq file (pop files))
15727 (catch 'nextfile
15728 (if (bufferp file)
15729 (set-buffer file)
15730 (org-check-agenda-file file)
15731 (set-buffer (org-get-agenda-file-buffer file)))
15732 (widen)
15733 (setq bmp (buffer-modified-p))
15734 (org-refresh-category-properties)
15735 (setq org-todo-keywords-for-agenda
15736 (append org-todo-keywords-for-agenda org-todo-keywords-1))
15737 (setq org-done-keywords-for-agenda
15738 (append org-done-keywords-for-agenda org-done-keywords))
15739 (setq org-todo-keyword-alist-for-agenda
15740 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
15741 (setq org-drawers-for-agenda
15742 (append org-drawers-for-agenda org-drawers))
15743 (setq org-tag-alist-for-agenda
15744 (append org-tag-alist-for-agenda org-tag-alist))
15746 (save-excursion
15747 (remove-text-properties (point-min) (point-max) pall)
15748 (when org-agenda-skip-archived-trees
15749 (goto-char (point-min))
15750 (while (re-search-forward rea nil t)
15751 (if (org-on-heading-p t)
15752 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
15753 (goto-char (point-min))
15755 (while (re-search-forward re nil t)
15756 (add-text-properties
15757 (match-beginning 0) (org-end-of-subtree t) pc)))
15758 (set-buffer-modified-p bmp)))))
15759 (setq org-todo-keywords-for-agenda
15760 (org-uniquify org-todo-keywords-for-agenda))
15761 (setq org-todo-keyword-alist-for-agenda
15762 (org-uniquify org-todo-keyword-alist-for-agenda)
15763 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
15765 ;;;; Embedded LaTeX
15767 (defvar org-cdlatex-mode-map (make-sparse-keymap)
15768 "Keymap for the minor `org-cdlatex-mode'.")
15770 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
15771 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
15772 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
15773 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
15774 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
15776 (defvar org-cdlatex-texmathp-advice-is-done nil
15777 "Flag remembering if we have applied the advice to texmathp already.")
15779 (define-minor-mode org-cdlatex-mode
15780 "Toggle the minor `org-cdlatex-mode'.
15781 This mode supports entering LaTeX environment and math in LaTeX fragments
15782 in Org-mode.
15784 nil " OCDL" nil
15785 (when org-cdlatex-mode (require 'cdlatex))
15786 (unless org-cdlatex-texmathp-advice-is-done
15787 (setq org-cdlatex-texmathp-advice-is-done t)
15788 (defadvice texmathp (around org-math-always-on activate)
15789 "Always return t in org-mode buffers.
15790 This is because we want to insert math symbols without dollars even outside
15791 the LaTeX math segments. If Orgmode thinks that point is actually inside
15792 an embedded LaTeX fragment, let texmathp do its job.
15794 (interactive)
15795 (let (p)
15796 (cond
15797 ((not (org-mode-p)) ad-do-it)
15798 ((eq this-command 'cdlatex-math-symbol)
15799 (setq ad-return-value t
15800 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
15801 (t
15802 (let ((p (org-inside-LaTeX-fragment-p)))
15803 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
15804 (setq ad-return-value t
15805 texmathp-why '("Org-mode embedded math" . 0))
15806 (if p ad-do-it)))))))))
15808 (defun turn-on-org-cdlatex ()
15809 "Unconditionally turn on `org-cdlatex-mode'."
15810 (org-cdlatex-mode 1))
15812 (defun org-inside-LaTeX-fragment-p ()
15813 "Test if point is inside a LaTeX fragment.
15815 sequence appearing also before point.
15816 Even though the matchers for math are configurable, this function assumes
15818 delimiters are skipped when they have been removed by customization.
15819 The return value is nil, or a cons cell with the delimiter and
15820 and the position of this delimiter.
15822 This function does a reasonably good job, but can locally be fooled by
15823 for example currency specifications. For example it will assume being in
15825 fragments that are properly closed, but during editing, we have to live
15826 with the uncertainty caused by missing closing delimiters. This function
15827 looks only before point, not after."
15828 (catch 'exit
15829 (let ((pos (point))
15830 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
15831 (lim (progn
15833 (point)))
15834 dd-on str (start 0) m re)
15835 (goto-char pos)
15836 (when dodollar
15838 re (nth 1 (assoc "$" org-latex-regexps)))
15839 (while (string-match re str start)
15840 (cond
15841 ((= (match-end 0) (length str))
15842 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
15843 ((= (match-end 0) (- (length str) 5))
15844 (throw 'exit nil))
15845 (t (setq start (match-end 0))))))
15846 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
15847 (goto-char pos)
15848 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
15849 (and (match-beginning 2) (throw 'exit nil))
15850 ;; count $$
15852 (setq dd-on (not dd-on)))
15853 (goto-char pos)
15854 (if dd-on (cons "$$" m))))))
15856 (defun org-inside-latex-macro-p ()
15857 "Is point inside a LaTeX macro or its arguments?"
15858 (save-match-data
15859 (org-in-regexp
15862 (defun org-try-cdlatex-tab ()
15863 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15864 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15865 - inside a LaTeX fragment, or
15866 - after the first word in a line, where an abbreviation expansion could
15867 insert a LaTeX environment."
15868 (when org-cdlatex-mode
15869 (cond
15870 ((save-excursion
15871 (skip-chars-backward "a-zA-Z0-9*")
15873 (bolp))
15874 (cdlatex-tab) t)
15875 ((org-inside-LaTeX-fragment-p)
15876 (cdlatex-tab) t)
15877 (t nil))))
15879 (defun org-cdlatex-underscore-caret (&optional arg)
15880 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15881 Revert to the normal definition outside of these fragments."
15882 (interactive "P")
15883 (if (org-inside-LaTeX-fragment-p)
15884 (call-interactively 'cdlatex-sub-superscript)
15885 (let (org-cdlatex-mode)
15886 (call-interactively (key-binding (vector last-input-event))))))
15888 (defun org-cdlatex-math-modify (&optional arg)
15889 "Execute `cdlatex-math-modify' in LaTeX fragments.
15890 Revert to the normal definition outside of these fragments."
15891 (interactive "P")
15892 (if (org-inside-LaTeX-fragment-p)
15893 (call-interactively 'cdlatex-math-modify)
15894 (let (org-cdlatex-mode)
15895 (call-interactively (key-binding (vector last-input-event))))))
15897 (defvar org-latex-fragment-image-overlays nil
15898 "List of overlays carrying the images of latex fragments.")
15899 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
15901 (defun org-remove-latex-fragment-image-overlays ()
15902 "Remove all overlays with LaTeX fragment images in current buffer."
15903 (mapc 'delete-overlay org-latex-fragment-image-overlays)
15904 (setq org-latex-fragment-image-overlays nil))
15906 (defun org-preview-latex-fragment (&optional subtree)
15907 "Preview the LaTeX fragment at point, or all locally or globally.
15908 If the cursor is in a LaTeX fragment, create the image and overlay
15909 it over the source code. If there is no fragment at point, display
15910 all fragments in the current text, from one headline to the next. With
15911 prefix SUBTREE, display all fragments in the current subtree. With a
15913 the cursor is before the first headline,
15914 display all fragments in the buffer.
15916 (interactive "P")
15917 (org-remove-latex-fragment-image-overlays)
15918 (save-excursion
15919 (save-restriction
15920 (let (beg end at msg)
15921 (cond
15922 ((or (equal subtree '(16))
15923 (not (save-excursion
15924 (re-search-backward (concat "^" outline-regexp) nil t))))
15925 (setq beg (point-min) end (point-max)
15926 msg "Creating images for buffer...%s"))
15927 ((equal subtree '(4))
15928 (org-back-to-heading)
15929 (setq beg (point) end (org-end-of-subtree t)
15930 msg "Creating images for subtree...%s"))
15931 (t
15932 (if (setq at (org-inside-LaTeX-fragment-p))
15933 (goto-char (max (point-min) (- (cdr at) 2)))
15934 (org-back-to-heading))
15935 (setq beg (point) end (progn (outline-next-heading) (point))
15936 msg (if at "Creating image...%s"
15937 "Creating images for entry...%s"))))
15938 (message msg "")
15939 (narrow-to-region beg end)
15940 (goto-char beg)
15941 (org-format-latex
15942 (concat "ltxpng/" (file-name-sans-extension
15943 (file-name-nondirectory
15944 buffer-file-name)))
15945 default-directory 'overlays msg at 'forbuffer 'dvipng)
15946 (message msg "done. Use `C-c C-c' to remove images.")))))
15948 (defvar org-latex-regexps
15950 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
15953 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
15957 "Regular expressions for matching embedded LaTeX.")
15959 (defvar org-export-have-math nil) ;; dynamic scoping
15960 (defun org-format-latex (prefix &optional dir overlays msg at
15961 forbuffer processing-type)
15962 "Replace LaTeX fragments with links to an image, and produce images.
15963 Some of the options can be changed using the variable
15964 `org-format-latex-options'."
15965 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
15966 (let* ((prefixnodir (file-name-nondirectory prefix))
15967 (absprefix (expand-file-name prefix dir))
15968 (todir (file-name-directory absprefix))
15969 (opt org-format-latex-options)
15970 (matchers (plist-get opt :matchers))
15971 (re-list org-latex-regexps)
15972 (org-format-latex-header-extra
15973 (plist-get (org-infile-export-plist) :latex-header-extra))
15974 (cnt 0) txt hash link beg end re e checkdir
15975 executables-checked string
15976 m n block linkfile movefile ov)
15977 ;; Check the different regular expressions
15978 (while (setq e (pop re-list))
15979 (setq m (car e) re (nth 1 e) n (nth 2 e)
15981 (when (member m matchers)
15982 (goto-char (point-min))
15983 (while (re-search-forward re nil t)
15984 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
15985 (not (get-text-property (match-beginning n)
15986 'org-protected))
15987 (or (not overlays)
15988 (not (eq (get-char-property (match-beginning n)
15989 'org-overlay-type)
15990 'org-latex-overlay))))
15991 (setq org-export-have-math t)
15992 (cond
15993 ((eq processing-type 'verbatim)
15994 ;; Leave the text verbatim, just protect it
15995 (add-text-properties (match-beginning n) (match-end n)
15996 '(org-protected t)))
15997 ((eq processing-type 'mathjax)
15998 ;; Prepare for MathJax processing
15999 (setq string (match-string n))
16000 (if (member m '("$" "$1"))
16001 (save-excursion
16002 (delete-region (match-beginning n) (match-end n))
16003 (goto-char (match-beginning n))
16006 '(org-protected t))))
16007 (add-text-properties (match-beginning n) (match-end n)
16008 '(org-protected t))))
16009 ((or (eq processing-type 'dvipng) t)
16010 ;; Process to an image
16011 (setq txt (match-string n)
16012 beg (match-beginning n) end (match-end n)
16013 cnt (1+ cnt))
16014 (let (print-length print-level) ; make sure full list is printed
16015 (setq hash (sha1 (prin1-to-string
16016 (list org-format-latex-header
16017 org-format-latex-header-extra
16018 org-export-latex-default-packages-alist
16019 org-export-latex-packages-alist
16020 org-format-latex-options
16021 forbuffer txt)))
16022 linkfile (format "%s_%s.png" prefix hash)
16023 movefile (format "%s_%s.png" absprefix hash)))
16024 (setq link (concat block "[[file:" linkfile "]]" block))
16025 (if msg (message msg cnt))
16026 (goto-char beg)
16027 (unless checkdir ; make sure the directory exists
16028 (setq checkdir t)
16029 (or (file-directory-p todir) (make-directory todir t)))
16031 (unless executables-checked
16032 (org-check-external-command
16033 "latex" "needed to convert LaTeX fragments to images")
16034 (org-check-external-command
16035 "dvipng" "needed to convert LaTeX fragments to images")
16036 (setq executables-checked t))
16038 (unless (file-exists-p movefile)
16039 (org-create-formula-image
16040 txt movefile opt forbuffer))
16041 (if overlays
16042 (progn
16043 (mapc (lambda (o)
16044 (if (eq (overlay-get o 'org-overlay-type)
16045 'org-latex-overlay)
16046 (delete-overlay o)))
16047 (overlays-in beg end))
16048 (setq ov (make-overlay beg end))
16049 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16050 (if (featurep 'xemacs)
16051 (progn
16052 (overlay-put ov 'invisible t)
16053 (overlay-put
16054 ov 'end-glyph
16055 (make-glyph (vector 'png :file movefile))))
16056 (overlay-put
16057 ov 'display
16058 (list 'image :type 'png :file movefile :ascent 'center)))
16059 (push ov org-latex-fragment-image-overlays)
16060 (goto-char end))
16061 (delete-region beg end)
16062 (insert (org-add-props link
16063 (list 'org-latex-src
16064 (replace-regexp-in-string
16067 ;; This function borrows from Ganesh Swami's latex2png.el
16068 (defun org-create-formula-image (string tofile options buffer)
16069 "This calls dvipng."
16070 (require 'org-latex)
16071 (let* ((tmpdir (if (featurep 'xemacs)
16072 (temp-directory)
16073 temporary-file-directory))
16074 (texfilebase (make-temp-name
16075 (expand-file-name "orgtex" tmpdir)))
16076 (texfile (concat texfilebase ".tex"))
16077 (dvifile (concat texfilebase ".dvi"))
16078 (pngfile (concat texfilebase ".png"))
16079 (fnh (if (featurep 'xemacs)
16080 (font-height (get-face-font 'default))
16081 (face-attribute 'default :height nil)))
16082 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16083 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16084 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16085 "Black"))
16086 (bg (or (plist-get options (if buffer :background :html-background))
16087 "Transparent")))
16088 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16089 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16090 (with-temp-file texfile
16091 (insert (org-splice-latex-header
16092 org-format-latex-header
16093 org-export-latex-default-packages-alist
16094 org-export-latex-packages-alist t
16095 org-format-latex-header-extra))
16097 (require 'org-latex)
16098 (org-export-latex-fix-inputenc))
16099 (let ((dir default-directory))
16100 (condition-case nil
16101 (progn
16102 (cd tmpdir)
16103 (call-process "latex" nil nil nil texfile))
16104 (error nil))
16105 (cd dir))
16106 (if (not (file-exists-p dvifile))
16107 (progn (message "Failed to create dvi file from %s" texfile) nil)
16108 (condition-case nil
16109 (call-process "dvipng" nil nil nil
16110 "-fg" fg "-bg" bg
16111 "-D" dpi
16112 ;;"-x" scale "-y" scale
16113 "-T" "tight"
16114 "-o" pngfile
16115 dvifile)
16116 (error nil))
16117 (if (not (file-exists-p pngfile))
16118 (if org-format-latex-signal-error
16119 (error "Failed to create png file from %s" texfile)
16120 (message "Failed to create png file from %s" texfile)
16121 nil)
16122 ;; Use the requested file name and clean up
16123 (copy-file pngfile tofile 'replace)
16124 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16125 (delete-file (concat texfilebase e)))
16126 pngfile))))
16128 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16129 "Fill a LaTeX header template TPL.
16130 In the template, the following place holders will be recognized:
16133 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16135 [NO-PACKAGES] do not include PKG
16136 [EXTRA] the string EXTRA
16137 [NO-EXTRA] do not include EXTRA
16139 For backward compatibility, if both the positive and the negative place
16141 assumed to be present at the end of the template.
16142 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16143 EXTRA is a string.
16144 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16145 (let (rpl (end ""))
16147 (setq rpl (if (or (match-end 1) (not def-pkg))
16148 "" (org-latex-packages-to-string def-pkg snippets-p t))
16149 tpl (replace-match rpl t t tpl))
16150 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16153 (setq rpl (if (or (match-end 1) (not pkg))
16154 "" (org-latex-packages-to-string pkg snippets-p t))
16155 tpl (replace-match rpl t t tpl))
16156 (if pkg (setq end
16158 (org-latex-packages-to-string pkg snippets-p)))))
16161 (setq rpl (if (or (match-end 1) (not extra))
16163 tpl (replace-match rpl t t tpl))
16169 tpl)))
16171 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16173 (setq pkg (mapconcat (lambda(p)
16174 (cond
16175 ((stringp p) p)
16176 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16177 (format "%% Package %s omitted" (cadr p)))
16178 ((equal "" (car p))
16180 (t
16182 (car p) (cadr p)))))
16183 pkg
16187 (defun org-dvipng-color (attr)
16188 "Return an rgb color specification for dvipng."
16189 (apply 'format "rgb %s %s %s"
16190 (mapcar 'org-normalize-color
16191 (color-values (face-attribute 'default attr nil)))))
16193 (defun org-normalize-color (value)
16194 "Return string to be used as color value for an RGB component."
16195 (format "%g" (/ value 65535.0)))
16197 ;; Image display
16200 (defvar org-inline-image-overlays nil)
16201 (make-variable-buffer-local 'org-inline-image-overlays)
16203 (defun org-toggle-inline-images (&optional include-linked)
16204 "Toggle the display of inline images.
16205 INCLUDE-LINKED is passed to `org-display-inline-images'."
16206 (interactive "P")
16207 (if org-inline-image-overlays
16208 (progn
16209 (org-remove-inline-images)
16210 (message "Inline image display turned off"))
16211 (org-display-inline-images include-linked)
16212 (if org-inline-image-overlays
16213 (message "%d images displayed inline"
16214 (length org-inline-image-overlays))
16215 (message "No images to display inline"))))
16217 (defun org-display-inline-images (&optional include-linked refresh beg end)
16218 "Display inline images.
16219 Normally only links without a description part are inlined, because this
16220 is how it will work for export. When INCLUDE-LINKED is set, also links
16221 with a description part will be inlined. This can be nice for a quick
16222 look at those images, but it does not reflect what exported files will look
16223 like.
16224 When REFRESH is set, refresh existing images between BEG and END.
16225 This will create new image displays only if necessary.
16226 BEG and END default to the buffer boundaries."
16227 (interactive "P")
16228 (unless refresh
16229 (org-remove-inline-images)
16230 (clear-image-cache))
16231 (save-excursion
16232 (save-restriction
16233 (widen)
16234 (setq beg (or beg (point-min)) end (or end (point-max)))
16235 (goto-char (point-min))
16237 (substring (org-image-file-name-regexp) 0 -2)
16239 old file ov img)
16240 (while (re-search-forward re end t)
16241 (setq old (get-char-property-and-overlay (match-beginning 1)
16242 'org-image-overlay))
16243 (setq file (expand-file-name
16244 (concat (or (match-string 3) "") (match-string 4))))
16245 (when (file-exists-p file)
16246 (if (and (car-safe old) refresh)
16247 (image-refresh (overlay-get (cdr old) 'display))
16248 (setq img (create-image file))
16249 (when img
16250 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16251 (overlay-put ov 'display img)
16252 (overlay-put ov 'face 'default)
16253 (overlay-put ov 'org-image-overlay t)
16254 (overlay-put ov 'modification-hooks
16255 (list 'org-display-inline-modification-hook))
16256 (push ov org-inline-image-overlays)))))))))
16258 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16259 "Remove inline-display overlay if a corresponding region is modified."
16260 (let ((inhibit-modification-hooks t))
16261 (when (and ov after)
16262 (delete ov org-inline-image-overlays)
16263 (delete-overlay ov))))
16265 (defun org-remove-inline-images ()
16266 "Remove inline display of images."
16267 (interactive)
16268 (mapc 'delete-overlay org-inline-image-overlays)
16269 (setq org-inline-image-overlays nil))
16271 ;;;; Key bindings
16273 ;; Make `C-c C-x' a prefix key
16274 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16276 ;; TAB key with modifiers
16277 (org-defkey org-mode-map "\C-i" 'org-cycle)
16278 (org-defkey org-mode-map [(tab)] 'org-cycle)
16279 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16280 (org-defkey org-mode-map [(meta tab)] 'org-complete)
16282 (org-defkey org-mode-map "\M-\C-i" 'org-complete)
16283 ;; The following line is necessary under Suse GNU/Linux
16284 (unless (featurep 'xemacs)
16285 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16286 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16287 (define-key org-mode-map [backtab] 'org-shifttab)
16289 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16290 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16291 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16293 ;; Cursor keys with modifiers
16294 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16295 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16296 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16297 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16299 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16300 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16301 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16302 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16304 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16305 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16306 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16307 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16309 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16310 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16312 ;; Babel keys
16313 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16314 (mapc (lambda (pair)
16315 (define-key org-babel-map (car pair) (cdr pair)))
16316 org-babel-key-bindings)
16318 ;;; Extra keys for tty access.
16319 ;; We only set them when really needed because otherwise the
16320 ;; menus don't show the simple keys
16322 (when (or org-use-extra-keys
16323 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16324 (not window-system))
16325 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16326 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16327 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16328 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16329 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16330 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16331 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16332 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16333 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16334 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16335 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16336 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16337 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16338 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16339 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16340 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16341 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16342 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16343 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16344 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16345 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16346 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16347 (org-defkey org-mode-map [?\e (tab)] 'org-complete)
16348 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16349 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16350 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16351 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16352 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16354 ;; All the other keys
16356 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16357 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16358 (if (boundp 'narrow-map)
16359 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16360 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16361 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16362 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16363 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16364 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16365 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16366 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16367 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16368 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16369 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16370 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16371 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16372 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16373 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16374 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16375 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16376 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16378 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16379 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16380 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16381 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16382 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16383 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16384 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16385 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16386 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16387 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16388 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16389 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16390 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16391 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16392 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16393 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16394 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16395 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16396 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16398 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16399 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16400 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16401 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16402 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16403 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16404 (org-defkey org-mode-map "\C-c^" 'org-sort)
16405 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16406 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16407 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16408 (org-defkey org-mode-map "\C-m" 'org-return)
16409 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16410 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16411 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16412 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16413 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16414 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16415 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16416 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16417 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16418 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16419 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16420 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16421 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16422 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16423 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16424 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16425 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16426 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16427 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16428 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16429 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16431 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16432 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16433 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16434 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16436 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16437 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16438 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16439 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16440 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16441 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16442 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16443 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16444 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16445 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16447 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16448 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16449 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16450 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16451 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16452 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16453 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16455 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16456 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16457 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16458 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16459 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16461 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16463 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16465 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16466 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16468 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16471 (when (featurep 'xemacs)
16472 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16475 (defconst org-speed-commands-default
16476 '(
16477 ("Outline Navigation")
16478 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16479 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16480 ("f" . (org-speed-move-safe 'org-forward-same-level))
16481 ("b" . (org-speed-move-safe 'org-backward-same-level))
16482 ("u" . (org-speed-move-safe 'outline-up-heading))
16483 ("j" . org-goto)
16484 ("g" . (org-refile t))
16485 ("Outline Visibility")
16486 ("c" . org-cycle)
16487 ("C" . org-shifttab)
16488 (" " . org-display-outline-path)
16489 ("Outline Structure Editing")
16490 ("U" . org-shiftmetaup)
16491 ("D" . org-shiftmetadown)
16492 ("r" . org-metaright)
16493 ("l" . org-metaleft)
16494 ("R" . org-shiftmetaright)
16495 ("L" . org-shiftmetaleft)
16496 ("i" . (progn (forward-char 1) (call-interactively
16497 'org-insert-heading-respect-content)))
16498 ("^" . org-sort)
16499 ("w" . org-refile)
16500 ("a" . org-archive-subtree-default-with-confirmation)
16501 ("." . outline-mark-subtree)
16502 ("Clock Commands")
16503 ("I" . org-clock-in)
16504 ("O" . org-clock-out)
16505 ("Meta Data Editing")
16506 ("t" . org-todo)
16507 ("0" . (org-priority ?\ ))
16508 ("1" . (org-priority ?A))
16509 ("2" . (org-priority ?B))
16510 ("3" . (org-priority ?C))
16511 (";" . org-set-tags-command)
16512 ("e" . org-set-effort)
16513 ("Agenda Views etc")
16514 ("v" . org-agenda)
16515 ("/" . org-sparse-tree)
16516 ("Misc")
16517 ("o" . org-open-at-point)
16518 ("?" . org-speed-command-help)
16519 ("<" . (org-agenda-set-restriction-lock 'subtree))
16520 (">" . (org-agenda-remove-restriction-lock))
16521 )
16522 "The default speed commands.")
16524 (defun org-print-speed-command (e)
16525 (if (> (length (car e)) 1)
16526 (progn
16528 (princ (car e))
16530 (princ (make-string (length (car e)) ?-))
16532 (princ (car e))
16533 (princ " ")
16534 (if (symbolp (cdr e))
16535 (princ (symbol-name (cdr e)))
16536 (prin1 (cdr e)))
16539 (defun org-speed-command-help ()
16540 "Show the available speed commands."
16541 (interactive)
16542 (if (not org-use-speed-commands)
16543 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16544 (with-output-to-temp-buffer "*Help*"
16546 (mapc 'org-print-speed-command org-speed-commands-user)
16549 (mapc 'org-print-speed-command org-speed-commands-default))
16550 (with-current-buffer "*Help*"
16551 (setq truncate-lines t))))
16553 (defun org-speed-move-safe (cmd)
16554 "Execute CMD, but make sure that the cursor always ends up in a headline.
16555 If not, return to the original position and throw an error."
16556 (interactive)
16557 (let ((pos (point)))
16558 (call-interactively cmd)
16559 (unless (and (bolp) (org-on-heading-p))
16560 (goto-char pos)
16561 (error "Boundary reached while executing %s" cmd))))
16563 (defvar org-self-insert-command-undo-counter 0)
16565 (defvar org-table-auto-blank-field) ; defined in org-table.el
16566 (defvar org-speed-command nil)
16568 (defun org-speed-command-default-hook (keys)
16569 "Hook for activating single-letter speed commands.
16570 `org-speed-commands-default' specifies a minimal command set. Use
16571 `org-speed-commands-user' for further customization."
16572 (when (or (and (bolp) (looking-at outline-regexp))
16573 (and (functionp org-use-speed-commands)
16574 (funcall org-use-speed-commands)))
16575 (cdr (assoc keys (append org-speed-commands-user
16576 org-speed-commands-default)))))
16578 (defun org-babel-speed-command-hook (keys)
16579 "Hook for activating single-letter code block commands."
16580 (when (and (bolp) (looking-at org-babel-src-block-regexp))
16581 (cdr (assoc keys org-babel-key-bindings))))
16583 (defcustom org-speed-command-hook
16584 '(org-speed-command-default-hook org-babel-speed-command-hook)
16585 "Hook for activating speed commands at strategic locations.
16586 Hook functions are called in sequence until a valid handler is
16587 found.
16589 Each hook takes a single argument, a user-pressed command key
16590 which is also a `self-insert-command' from the global map.
16592 Within the hook, examine the cursor position and the command key
16593 and return nil or a valid handler as appropriate. Handler could
16594 be one of an interactive command, a function, or a form.
16596 Set `org-use-speed-commands' to non-nil value to enable this
16597 hook. The default setting is `org-speed-command-default-hook'."
16598 :group 'org-structure
16599 :type 'hook)
16601 (defun org-self-insert-command (N)
16602 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
16603 If the cursor is in a table looking at whitespace, the whitespace is
16604 overwritten, and the table is not marked as requiring realignment."
16605 (interactive "p")
16606 (cond
16607 ((and org-use-speed-commands
16608 (setq org-speed-command
16609 (run-hook-with-args-until-success
16610 'org-speed-command-hook (this-command-keys))))
16611 (cond
16612 ((commandp org-speed-command)
16613 (setq this-command org-speed-command)
16614 (call-interactively org-speed-command))
16615 ((functionp org-speed-command)
16616 (funcall org-speed-command))
16617 ((and org-speed-command (listp org-speed-command))
16618 (eval org-speed-command))
16619 (t (let (org-use-speed-commands)
16620 (call-interactively 'org-self-insert-command)))))
16621 ((and
16622 (org-table-p)
16623 (progn
16624 ;; check if we blank the field, and if that triggers align
16625 (and (featurep 'org-table) org-table-auto-blank-field
16626 (member last-command
16627 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
16629 ;; got extra space, this field does not determine column width
16630 (let (org-table-may-need-update) (org-table-blank-field))
16631 ;; no extra space, this field may determine column width
16632 (org-table-blank-field)))
16633 t)
16634 (eq N 1)
16636 (let (org-table-may-need-update)
16637 (goto-char (1- (match-end 0)))
16638 (delete-backward-char 1)
16639 (goto-char (match-beginning 0))
16640 (self-insert-command N)))
16641 (t
16642 (setq org-table-may-need-update t)
16643 (self-insert-command N)
16644 (org-fix-tags-on-the-fly)
16645 (if org-self-insert-cluster-for-undo
16646 (if (not (eq last-command 'org-self-insert-command))
16647 (setq org-self-insert-command-undo-counter 1)
16648 (if (>= org-self-insert-command-undo-counter 20)
16649 (setq org-self-insert-command-undo-counter 1)
16650 (and (> org-self-insert-command-undo-counter 0)
16651 buffer-undo-list
16652 (not (cadr buffer-undo-list)) ; remove nil entry
16653 (setcdr buffer-undo-list (cddr buffer-undo-list)))
16654 (setq org-self-insert-command-undo-counter
16655 (1+ org-self-insert-command-undo-counter))))))))
16657 (defun org-fix-tags-on-the-fly ()
16658 (when (and (equal (char-after (point-at-bol)) ?*)
16659 (org-on-heading-p))
16660 (org-align-tags-here org-tags-column)))
16662 (defun org-delete-backward-char (N)
16663 "Like `delete-backward-char', insert whitespace at field end in tables.
16664 When deleting backwards, in tables this function will insert whitespace in
16666 still be marked for re-alignment if the field did fill the entire column,
16667 because, in this case the deletion might narrow the column."
16668 (interactive "p")
16669 (if (and (org-table-p)
16670 (eq N 1)
16671 (string-match "|" (buffer-substring (point-at-bol) (point)))
16672 (looking-at ".*?|"))
16673 (let ((pos (point))
16675 (c org-table-may-need-update))
16676 (backward-delete-char N)
16677 (if (not overwrite-mode)
16678 (progn
16679 (skip-chars-forward "^|")
16680 (insert " ")
16681 (goto-char (1- pos))))
16682 ;; noalign: if there were two spaces at the end, this field
16683 ;; does not determine the width of the column.
16684 (if noalign (setq org-table-may-need-update c)))
16685 (backward-delete-char N)
16686 (org-fix-tags-on-the-fly)))
16688 (defun org-delete-char (N)
16689 "Like `delete-char', but insert whitespace at field end in tables.
16690 When deleting characters, in tables this function will insert whitespace in
16692 still be marked for re-alignment if the field did fill the entire column,
16693 because, in this case the deletion might narrow the column."
16694 (interactive "p")
16695 (if (and (org-table-p)
16696 (not (bolp))
16697 (not (= (char-after) ?|))
16698 (eq N 1))
16699 (if (looking-at ".*?|")
16700 (let ((pos (point))
16702 (c org-table-may-need-update))
16703 (replace-match (concat
16704 (substring (match-string 0) 1 -1)
16705 " |"))
16706 (goto-char pos)
16707 ;; noalign: if there were two spaces at the end, this field
16708 ;; does not determine the width of the column.
16709 (if noalign (setq org-table-may-need-update c)))
16710 (delete-char N))
16711 (delete-char N)
16712 (org-fix-tags-on-the-fly)))
16714 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
16715 (put 'org-self-insert-command 'delete-selection t)
16716 (put 'orgtbl-self-insert-command 'delete-selection t)
16717 (put 'org-delete-char 'delete-selection 'supersede)
16718 (put 'org-delete-backward-char 'delete-selection 'supersede)
16719 (put 'org-yank 'delete-selection 'yank)
16721 ;; Make `flyspell-mode' delay after some commands
16722 (put 'org-self-insert-command 'flyspell-delayed t)
16723 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
16724 (put 'org-delete-char 'flyspell-delayed t)
16725 (put 'org-delete-backward-char 'flyspell-delayed t)
16727 ;; Make pabbrev-mode expand after org-mode commands
16728 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
16729 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
16731 ;; How to do this: Measure non-white length of current string
16732 ;; If equal to column width, we should realign.
16734 (defun org-remap (map &rest commands)
16735 "In MAP, remap the functions given in COMMANDS.
16736 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
16737 (let (new old)
16738 (while commands
16739 (setq old (pop commands) new (pop commands))
16740 (if (fboundp 'command-remapping)
16741 (org-defkey map (vector 'remap old) new)
16742 (substitute-key-definition old new map global-map)))))
16744 (when (eq org-enable-table-editor 'optimized)
16745 ;; If the user wants maximum table support, we need to hijack
16746 ;; some standard editing functions
16747 (org-remap org-mode-map
16748 'self-insert-command 'org-self-insert-command
16749 'delete-char 'org-delete-char
16750 'delete-backward-char 'org-delete-backward-char)
16751 (org-defkey org-mode-map "|" 'org-force-self-insert))
16753 (defvar org-ctrl-c-ctrl-c-hook nil
16754 "Hook for functions attaching themselves to `C-c C-c'.
16755 This can be used to add additional functionality to the C-c C-c key which
16756 executes context-dependent commands.
16757 Each function will be called with no arguments. The function must check
16758 if the context is appropriate for it to act. If yes, it should do its
16759 thing and then return a non-nil value. If the context is wrong,
16760 just do nothing and return nil.")
16762 (defvar org-tab-first-hook nil
16763 "Hook for functions to attach themselves to TAB.
16764 See `org-ctrl-c-ctrl-c-hook' for more information.
16765 This hook runs as the first action when TAB is pressed, even before
16766 `org-cycle' messes around with the `outline-regexp' to cater for
16767 inline tasks and plain list item folding.
16768 If any function in this hook returns t, any other actions that
16769 would have been caused by TAB (such as table field motion or visibility
16770 cycling) will not occur.")
16772 (defvar org-tab-after-check-for-table-hook nil
16773 "Hook for functions to attach themselves to TAB.
16774 See `org-ctrl-c-ctrl-c-hook' for more information.
16775 This hook runs after it has been established that the cursor is not in a
16776 table, but before checking if the cursor is in a headline or if global cycling
16777 should be done.
16778 If any function in this hook returns t, not other actions like visibility
16779 cycling will be done.")
16781 (defvar org-tab-after-check-for-cycling-hook nil
16782 "Hook for functions to attach themselves to TAB.
16783 See `org-ctrl-c-ctrl-c-hook' for more information.
16784 This hook runs after it has been established that not table field motion and
16785 not visibility should be done because of current context. This is probably
16786 the place where a package like yasnippets can hook in.")
16788 (defvar org-tab-before-tab-emulation-hook nil
16789 "Hook for functions to attach themselves to TAB.
16790 See `org-ctrl-c-ctrl-c-hook' for more information.
16791 This hook runs after every other options for TAB have been exhausted, but
16794 (defvar org-metaleft-hook nil
16795 "Hook for functions attaching themselves to `M-left'.
16796 See `org-ctrl-c-ctrl-c-hook' for more information.")
16797 (defvar org-metaright-hook nil
16798 "Hook for functions attaching themselves to `M-right'.
16799 See `org-ctrl-c-ctrl-c-hook' for more information.")
16800 (defvar org-metaup-hook nil
16801 "Hook for functions attaching themselves to `M-up'.
16802 See `org-ctrl-c-ctrl-c-hook' for more information.")
16803 (defvar org-metadown-hook nil
16804 "Hook for functions attaching themselves to `M-down'.
16805 See `org-ctrl-c-ctrl-c-hook' for more information.")
16806 (defvar org-shiftmetaleft-hook nil
16807 "Hook for functions attaching themselves to `M-S-left'.
16808 See `org-ctrl-c-ctrl-c-hook' for more information.")
16809 (defvar org-shiftmetaright-hook nil
16810 "Hook for functions attaching themselves to `M-S-right'.
16811 See `org-ctrl-c-ctrl-c-hook' for more information.")
16812 (defvar org-shiftmetaup-hook nil
16813 "Hook for functions attaching themselves to `M-S-up'.
16814 See `org-ctrl-c-ctrl-c-hook' for more information.")
16815 (defvar org-shiftmetadown-hook nil
16816 "Hook for functions attaching themselves to `M-S-down'.
16817 See `org-ctrl-c-ctrl-c-hook' for more information.")
16818 (defvar org-metareturn-hook nil
16819 "Hook for functions attaching themselves to `M-RET'.
16820 See `org-ctrl-c-ctrl-c-hook' for more information.")
16821 (defvar org-shiftup-hook nil
16822 "Hook for functions attaching themselves to `S-up'.
16823 See `org-ctrl-c-ctrl-c-hook' for more information.")
16824 (defvar org-shiftup-final-hook nil
16825 "Hook for functions attaching themselves to `S-up'.
16826 This one runs after all other options except shift-select have been excluded.
16827 See `org-ctrl-c-ctrl-c-hook' for more information.")
16828 (defvar org-shiftdown-hook nil
16829 "Hook for functions attaching themselves to `S-down'.
16830 See `org-ctrl-c-ctrl-c-hook' for more information.")
16831 (defvar org-shiftdown-final-hook nil
16832 "Hook for functions attaching themselves to `S-down'.
16833 This one runs after all other options except shift-select have been excluded.
16834 See `org-ctrl-c-ctrl-c-hook' for more information.")
16835 (defvar org-shiftleft-hook nil
16836 "Hook for functions attaching themselves to `S-left'.
16837 See `org-ctrl-c-ctrl-c-hook' for more information.")
16838 (defvar org-shiftleft-final-hook nil
16839 "Hook for functions attaching themselves to `S-left'.
16840 This one runs after all other options except shift-select have been excluded.
16841 See `org-ctrl-c-ctrl-c-hook' for more information.")
16842 (defvar org-shiftright-hook nil
16843 "Hook for functions attaching themselves to `S-right'.
16844 See `org-ctrl-c-ctrl-c-hook' for more information.")
16845 (defvar org-shiftright-final-hook nil
16846 "Hook for functions attaching themselves to `S-right'.
16847 This one runs after all other options except shift-select have been excluded.
16848 See `org-ctrl-c-ctrl-c-hook' for more information.")
16850 (defun org-modifier-cursor-error ()
16851 "Throw an error, a modified cursor command was applied in wrong context."
16852 (error "This command is active in special context like tables, headlines or items"))
16854 (defun org-shiftselect-error ()
16855 "Throw an error because Shift-Cursor command was applied in wrong context."
16856 (if (and (boundp 'shift-select-mode) shift-select-mode)
16857 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
16858 (error "This command works only in special context like headlines or timestamps")))
16860 (defun org-call-for-shift-select (cmd)
16861 (let ((this-command-keys-shift-translated t))
16862 (call-interactively cmd)))
16864 (defun org-shifttab (&optional arg)
16865 "Global visibility cycling or move to previous table field.
16866 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
16867 on context.
16868 See the individual commands for more information."
16869 (interactive "P")
16870 (cond
16871 ((org-at-table-p) (call-interactively 'org-table-previous-field))
16872 ((integerp arg)
16873 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
16874 (message "Content view to level: %d" arg)
16875 (org-content (prefix-numeric-value arg2))
16876 (setq org-cycle-global-status 'overview)))
16877 (t (call-interactively 'org-global-cycle))))
16879 (defun org-shiftmetaleft ()
16880 "Promote subtree or delete table column.
16881 Calls `org-promote-subtree', `org-outdent-item',
16882 or `org-table-delete-column', depending on context.
16883 See the individual commands for more information."
16884 (interactive)
16885 (cond
16886 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
16887 ((org-at-table-p) (call-interactively 'org-table-delete-column))
16888 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
16889 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
16890 (t (org-modifier-cursor-error))))
16892 (defun org-shiftmetaright ()
16893 "Demote subtree or insert table column.
16894 Calls `org-demote-subtree', `org-indent-item',
16895 or `org-table-insert-column', depending on context.
16896 See the individual commands for more information."
16897 (interactive)
16898 (cond
16899 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
16900 ((org-at-table-p) (call-interactively 'org-table-insert-column))
16901 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
16902 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
16903 (t (org-modifier-cursor-error))))
16905 (defun org-shiftmetaup (&optional arg)
16906 "Move subtree up or kill table row.
16907 Calls `org-move-subtree-up' or `org-table-kill-row' or
16908 `org-move-item-up' depending on context. See the individual commands
16909 for more information."
16910 (interactive "P")
16911 (cond
16912 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
16913 ((org-at-table-p) (call-interactively 'org-table-kill-row))
16914 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16915 ((org-at-item-p) (call-interactively 'org-move-item-up))
16916 (t (org-modifier-cursor-error))))
16918 (defun org-shiftmetadown (&optional arg)
16919 "Move subtree down or insert table row.
16920 Calls `org-move-subtree-down' or `org-table-insert-row' or
16921 `org-move-item-down', depending on context. See the individual
16922 commands for more information."
16923 (interactive "P")
16924 (cond
16925 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
16926 ((org-at-table-p) (call-interactively 'org-table-insert-row))
16927 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16928 ((org-at-item-p) (call-interactively 'org-move-item-down))
16929 (t (org-modifier-cursor-error))))
16931 (defsubst org-hidden-tree-error ()
16932 (error
16933 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
16935 (defun org-metaleft (&optional arg)
16936 "Promote heading or move table column to left.
16937 Calls `org-do-promote' or `org-table-move-column', depending on context.
16938 With no specific context, calls the Emacs default `backward-word'.
16939 See the individual commands for more information."
16940 (interactive "P")
16941 (cond
16942 ((run-hook-with-args-until-success 'org-metaleft-hook))
16943 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
16944 ((or (org-on-heading-p)
16945 (and (org-region-active-p)
16946 (save-excursion
16947 (goto-char (region-beginning))
16948 (org-on-heading-p))))
16949 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16950 (call-interactively 'org-do-promote))
16951 ((or (org-at-item-p)
16952 (and (org-region-active-p)
16953 (save-excursion
16954 (goto-char (region-beginning))
16955 (org-at-item-p))))
16956 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16957 (call-interactively 'org-outdent-item))
16958 (t (call-interactively 'backward-word))))
16960 (defun org-metaright (&optional arg)
16961 "Demote subtree or move table column to right.
16962 Calls `org-do-demote' or `org-table-move-column', depending on context.
16963 With no specific context, calls the Emacs default `forward-word'.
16964 See the individual commands for more information."
16965 (interactive "P")
16966 (cond
16967 ((run-hook-with-args-until-success 'org-metaright-hook))
16968 ((org-at-table-p) (call-interactively 'org-table-move-column))
16969 ((or (org-on-heading-p)
16970 (and (org-region-active-p)
16971 (save-excursion
16972 (goto-char (region-beginning))
16973 (org-on-heading-p))))
16974 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16975 (call-interactively 'org-do-demote))
16976 ((or (org-at-item-p)
16977 (and (org-region-active-p)
16978 (save-excursion
16979 (goto-char (region-beginning))
16980 (org-at-item-p))))
16981 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16982 (call-interactively 'org-indent-item))
16983 (t (call-interactively 'forward-word))))
16985 (defun org-check-for-hidden (what)
16986 "Check if there are hidden headlines/items in the current visual line.
16987 WHAT can be either `headlines' or `items'. If the current line is
16988 an outline or item heading and it has a folded subtree below it,
16989 this function returns t, nil otherwise."
16990 (let ((re (cond
16991 ((eq what 'headlines) (concat "^" org-outline-regexp))
16992 ((eq what 'items) (concat "^" (org-item-re t)))
16993 (t (error "This should not happen"))))
16994 beg end)
16995 (save-excursion
16996 (catch 'exit
16997 (unless (org-region-active-p)
16998 (setq beg (point-at-bol))
16999 (beginning-of-line 2)
17000 (while (and (not (eobp)) ;; this is like `next-line'
17001 (get-char-property (1- (point)) 'invisible))
17002 (beginning-of-line 2))
17003 (setq end (point))
17004 (goto-char beg)
17005 (goto-char (point-at-eol))
17006 (setq end (max end (point)))
17007 (while (re-search-forward re end t)
17008 (if (get-char-property (match-beginning 0) 'invisible)
17009 (throw 'exit t))))
17010 nil))))
17012 (defun org-metaup (&optional arg)
17013 "Move subtree up or move table row up.
17014 Calls `org-move-subtree-up' or `org-table-move-row' or
17015 `org-move-item-up', depending on context. See the individual commands
17016 for more information."
17017 (interactive "P")
17018 (cond
17019 ((run-hook-with-args-until-success 'org-metaup-hook))
17020 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17021 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17022 ((org-at-item-p) (call-interactively 'org-move-item-up))
17023 (t (transpose-lines 1) (beginning-of-line -1))))
17025 (defun org-metadown (&optional arg)
17026 "Move subtree down or move table row down.
17027 Calls `org-move-subtree-down' or `org-table-move-row' or
17028 `org-move-item-down', depending on context. See the individual
17029 commands for more information."
17030 (interactive "P")
17031 (cond
17032 ((run-hook-with-args-until-success 'org-metadown-hook))
17033 ((org-at-table-p) (call-interactively 'org-table-move-row))
17034 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17035 ((org-at-item-p) (call-interactively 'org-move-item-down))
17036 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17038 (defun org-shiftup (&optional arg)
17039 "Increase item in timestamp or increase priority of current headline.
17040 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17041 depending on context. See the individual commands for more information."
17042 (interactive "P")
17043 (cond
17044 ((run-hook-with-args-until-success 'org-shiftup-hook))
17045 ((and org-support-shift-select (org-region-active-p))
17046 (org-call-for-shift-select 'previous-line))
17047 ((org-at-timestamp-p t)
17048 (call-interactively (if org-edit-timestamp-down-means-later
17049 'org-timestamp-down 'org-timestamp-up)))
17050 ((and (not (eq org-support-shift-select 'always))
17051 org-enable-priority-commands
17052 (org-on-heading-p))
17053 (call-interactively 'org-priority-up))
17054 ((and (not org-support-shift-select) (org-at-item-p))
17055 (call-interactively 'org-previous-item))
17056 ((org-clocktable-try-shift 'up arg))
17057 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17058 (org-support-shift-select
17059 (org-call-for-shift-select 'previous-line))
17060 (t (org-shiftselect-error))))
17062 (defun org-shiftdown (&optional arg)
17063 "Decrease item in timestamp or decrease priority of current headline.
17064 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17065 depending on context. See the individual commands for more information."
17066 (interactive "P")
17067 (cond
17068 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17069 ((and org-support-shift-select (org-region-active-p))
17070 (org-call-for-shift-select 'next-line))
17071 ((org-at-timestamp-p t)
17072 (call-interactively (if org-edit-timestamp-down-means-later
17073 'org-timestamp-up 'org-timestamp-down)))
17074 ((and (not (eq org-support-shift-select 'always))
17075 org-enable-priority-commands
17076 (org-on-heading-p))
17077 (call-interactively 'org-priority-down))
17078 ((and (not org-support-shift-select) (org-at-item-p))
17079 (call-interactively 'org-next-item))
17080 ((org-clocktable-try-shift 'down arg))
17081 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17082 (org-support-shift-select
17083 (org-call-for-shift-select 'next-line))
17084 (t (org-shiftselect-error))))
17086 (defun org-shiftright (&optional arg)
17087 "Cycle the thing at point or in the current line, depending on context.
17088 Depending on context, this does one of the following:
17090 - switch a timestamp at point one day into the future
17091 - on a headline, switch to the next TODO keyword.
17092 - on an item, switch entire list to the next bullet type
17093 - on a property line, switch to the next allowed value
17094 - on a clocktable definition line, move time block into the future"
17095 (interactive "P")
17096 (cond
17097 ((run-hook-with-args-until-success 'org-shiftright-hook))
17098 ((and org-support-shift-select (org-region-active-p))
17099 (org-call-for-shift-select 'forward-char))
17100 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17101 ((and (not (eq org-support-shift-select 'always))
17102 (org-on-heading-p))
17103 (let ((org-inhibit-logging
17104 (not org-treat-S-cursor-todo-selection-as-state-change))
17105 (org-inhibit-blocking
17106 (not org-treat-S-cursor-todo-selection-as-state-change)))
17107 (org-call-with-arg 'org-todo 'right)))
17108 ((or (and org-support-shift-select
17109 (not (eq org-support-shift-select 'always))
17110 (org-at-item-bullet-p))
17111 (and (not org-support-shift-select) (org-at-item-p)))
17112 (org-call-with-arg 'org-cycle-list-bullet nil))
17113 ((and (not (eq org-support-shift-select 'always))
17114 (org-at-property-p))
17115 (call-interactively 'org-property-next-allowed-value))
17116 ((org-clocktable-try-shift 'right arg))
17117 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17118 (org-support-shift-select
17119 (org-call-for-shift-select 'forward-char))
17120 (t (org-shiftselect-error))))
17122 (defun org-shiftleft (&optional arg)
17123 "Cycle the thing at point or in the current line, depending on context.
17124 Depending on context, this does one of the following:
17126 - switch a timestamp at point one day into the past
17127 - on a headline, switch to the previous TODO keyword.
17128 - on an item, switch entire list to the previous bullet type
17129 - on a property line, switch to the previous allowed value
17130 - on a clocktable definition line, move time block into the past"
17131 (interactive "P")
17132 (cond
17133 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17134 ((and org-support-shift-select (org-region-active-p))
17135 (org-call-for-shift-select 'backward-char))
17136 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17137 ((and (not (eq org-support-shift-select 'always))
17138 (org-on-heading-p))
17139 (let ((org-inhibit-logging
17140 (not org-treat-S-cursor-todo-selection-as-state-change))
17141 (org-inhibit-blocking
17142 (not org-treat-S-cursor-todo-selection-as-state-change)))
17143 (org-call-with-arg 'org-todo 'left)))
17144 ((or (and org-support-shift-select
17145 (not (eq org-support-shift-select 'always))
17146 (org-at-item-bullet-p))
17147 (and (not org-support-shift-select) (org-at-item-p)))
17148 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17149 ((and (not (eq org-support-shift-select 'always))
17150 (org-at-property-p))
17151 (call-interactively 'org-property-previous-allowed-value))
17152 ((org-clocktable-try-shift 'left arg))
17153 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17154 (org-support-shift-select
17155 (org-call-for-shift-select 'backward-char))
17156 (t (org-shiftselect-error))))
17158 (defun org-shiftcontrolright ()
17159 "Switch to next TODO set."
17160 (interactive)
17161 (cond
17162 ((and org-support-shift-select (org-region-active-p))
17163 (org-call-for-shift-select 'forward-word))
17164 ((and (not (eq org-support-shift-select 'always))
17165 (org-on-heading-p))
17166 (org-call-with-arg 'org-todo 'nextset))
17167 (org-support-shift-select
17168 (org-call-for-shift-select 'forward-word))
17169 (t (org-shiftselect-error))))
17171 (defun org-shiftcontrolleft ()
17172 "Switch to previous TODO set."
17173 (interactive)
17174 (cond
17175 ((and org-support-shift-select (org-region-active-p))
17176 (org-call-for-shift-select 'backward-word))
17177 ((and (not (eq org-support-shift-select 'always))
17178 (org-on-heading-p))
17179 (org-call-with-arg 'org-todo 'previousset))
17180 (org-support-shift-select
17181 (org-call-for-shift-select 'backward-word))
17182 (t (org-shiftselect-error))))
17184 (defun org-ctrl-c-ret ()
17185 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17186 (interactive)
17187 (cond
17188 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17189 (t (call-interactively 'org-insert-heading))))
17191 (defun org-copy-special ()
17192 "Copy region in table or copy current subtree.
17193 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17194 See the individual commands for more information."
17195 (interactive)
17196 (call-interactively
17197 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17199 (defun org-cut-special ()
17200 "Cut region in table or cut current subtree.
17201 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17202 See the individual commands for more information."
17203 (interactive)
17204 (call-interactively
17205 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17207 (defun org-paste-special (arg)
17208 "Paste rectangular region into table, or past subtree relative to level.
17209 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17210 See the individual commands for more information."
17211 (interactive "P")
17212 (if (org-at-table-p)
17213 (org-table-paste-rectangle)
17214 (org-paste-subtree arg)))
17216 (defun org-edit-special (&optional arg)
17217 "Call a special editor for the stuff at point.
17218 When at a table, call the formula editor with `org-table-edit-formulas'.
17219 When at the first line of an src example, call `org-edit-src-code'.
17220 When in an #+include line, visit the include file. Otherwise call
17221 `ffap' to visit the file at point."
17222 (interactive)
17223 ;; possibly prep session before editing source
17224 (when arg
17225 (let* ((info (org-babel-get-src-block-info))
17226 (lang (nth 0 info))
17227 (params (nth 2 info))
17228 (session (cdr (assoc :session params))))
17229 (when (and info session) ;; we are in a source-code block with a session
17230 (funcall
17231 (intern (concat "org-babel-prep-session:" lang)) session params))))
17232 (cond ;; proceed with `org-edit-special'
17233 ((save-excursion
17234 (beginning-of-line 1)
17235 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17236 (find-file (org-trim (match-string 1))))
17237 ((org-edit-src-code))
17238 ((org-edit-fixed-width-region))
17239 ((org-at-table.el-p)
17240 (org-edit-src-code))
17241 ((org-at-table-p)
17242 (call-interactively 'org-table-edit-formulas))
17243 (t (call-interactively 'ffap))))
17246 (defun org-ctrl-c-ctrl-c (&optional arg)
17247 "Set tags in headline, or update according to changed information at point.
17249 This command does many different things, depending on context:
17251 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17252 this is what we do.
17254 - If the cursor is on a statistics cookie, update it.
17256 - If the cursor is in a headline, prompt for tags and insert them
17257 into the current line, aligned to `org-tags-column'. When called
17258 with prefix arg, realign all tags in the current buffer.
17260 - If the cursor is in one of the special #+KEYWORD lines, this
17261 triggers scanning the buffer for these lines and updating the
17262 information.
17264 - If the cursor is inside a table, realign the table. This command
17265 works even if the automatic table editor has been turned off.
17267 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17268 the entire table.
17270 - If the cursor is at a footnote reference or definition, jump to
17271 the corresponding definition or references, respectively.
17273 - If the cursor is a the beginning of a dynamic block, update it.
17275 - If the current buffer is a capture buffer, close note and file it.
17277 - If the cursor is on a <<<target>>>, update radio targets and
17278 corresponding links in this buffer.
17280 - If the cursor is on a numbered item in a plain list, renumber the
17281 ordered list.
17283 - If the cursor is on a checkbox, toggle it.
17285 - If the cursor is on a code block, evaluate it. The variable
17286 `org-confirm-babel-evaluate' can be used to control prompting
17287 before code block evaluation, by default every code block
17288 evaluation requires confirmation. Code block evaluation can be
17289 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17290 (interactive "P")
17291 (let ((org-enable-table-editor t))
17292 (cond
17293 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17294 org-occur-highlights
17295 org-latex-fragment-image-overlays)
17296 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17297 (org-remove-occur-highlights)
17298 (org-remove-latex-fragment-image-overlays)
17299 (message "Temporary highlights/overlays removed from current buffer"))
17300 ((and (local-variable-p 'org-finish-function (current-buffer))
17301 (fboundp org-finish-function))
17302 (funcall org-finish-function))
17303 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17304 ((or (looking-at org-property-start-re)
17305 (org-at-property-p))
17306 (call-interactively 'org-property-action))
17307 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17309 (or (org-on-heading-p) (org-at-item-p)))
17310 (call-interactively 'org-update-statistics-cookies))
17311 ((org-on-heading-p) (call-interactively 'org-set-tags))
17312 ((org-at-table.el-p)
17313 (message "Use C-c ' to edit table.el tables"))
17314 ((org-at-table-p)
17315 (org-table-maybe-eval-formula)
17316 (if arg
17317 (call-interactively 'org-table-recalculate)
17318 (org-table-maybe-recalculate-line))
17319 (call-interactively 'org-table-align))
17320 ((or (org-footnote-at-reference-p)
17321 (org-footnote-at-definition-p))
17322 (call-interactively 'org-footnote-action))
17323 ((org-at-item-checkbox-p)
17324 (call-interactively 'org-list-repair)
17325 (call-interactively 'org-toggle-checkbox)
17326 (org-list-send-list 'maybe))
17327 ((org-at-item-p)
17328 (call-interactively 'org-list-repair)
17329 (when arg (call-interactively 'org-toggle-checkbox))
17330 (org-list-send-list 'maybe))
17331 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17332 ;; Dynamic block
17333 (beginning-of-line 1)
17334 (save-excursion (org-update-dblock)))
17335 ((save-excursion
17336 (beginning-of-line 1)
17338 (cond
17339 ((equal (match-string 1) "TBLFM")
17340 ;; Recalculate the table before this line
17341 (save-excursion
17342 (beginning-of-line 1)
17344 (if (org-at-table-p)
17345 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17346 (t
17347 (let ((org-inhibit-startup-visibility-stuff t)
17348 (org-startup-align-all-tables nil))
17349 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17350 (message "Local setup has been refreshed"))))
17351 ((org-clock-update-time-maybe))
17352 (t (error "C-c C-c can do nothing useful at this location")))))
17354 (defun org-mode-restart ()
17355 "Restart Org-mode, to scan again for special lines.
17356 Also updates the keyword regular expressions."
17357 (interactive)
17358 (org-mode)
17359 (message "Org-mode restarted"))
17361 (defun org-kill-note-or-show-branches ()
17362 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17363 (interactive)
17364 (if (not org-finish-function)
17365 (progn
17366 (hide-subtree)
17367 (call-interactively 'show-branches))
17368 (let ((org-note-abort t))
17369 (funcall org-finish-function))))
17371 (defun org-return (&optional indent)
17372 "Goto next table row or insert a newline.
17373 Calls `org-table-next-row' or `newline', depending on context.
17374 See the individual commands for more information."
17375 (interactive)
17376 (cond
17377 ((bobp) (if indent (newline-and-indent) (newline)))
17378 ((org-at-table-p)
17379 (org-table-justify-field-maybe)
17380 (call-interactively 'org-table-next-row))
17381 ((and org-return-follows-link
17382 (eq (get-text-property (point) 'face) 'org-link))
17383 (call-interactively 'org-open-at-point))
17384 ((and (org-at-heading-p)
17385 (looking-at
17387 (org-show-entry)
17388 (end-of-line 1)
17389 (newline))
17390 (t (if indent (newline-and-indent) (newline)))))
17392 (defun org-return-indent ()
17393 "Goto next table row or insert a newline and indent.
17394 Calls `org-table-next-row' or `newline-and-indent', depending on
17395 context. See the individual commands for more information."
17396 (interactive)
17397 (org-return t))
17399 (defun org-ctrl-c-star ()
17400 "Compute table, or change heading status of lines.
17401 Calls `org-table-recalculate' or `org-toggle-heading',
17402 depending on context."
17403 (interactive)
17404 (cond
17405 ((org-at-table-p)
17406 (call-interactively 'org-table-recalculate))
17407 (t
17408 ;; Convert all lines in region to list items
17409 (call-interactively 'org-toggle-heading))))
17411 (defun org-ctrl-c-minus ()
17412 "Insert separator line in table or modify bullet status of line.
17413 Also turns a plain line or a region of lines into list items.
17414 Calls `org-table-insert-hline', `org-toggle-item', or
17415 `org-cycle-list-bullet', depending on context."
17416 (interactive)
17417 (cond
17418 ((org-at-table-p)
17419 (call-interactively 'org-table-insert-hline))
17420 ((org-region-active-p)
17421 (call-interactively 'org-toggle-item))
17422 ((org-in-item-p)
17423 (call-interactively 'org-cycle-list-bullet))
17424 (t
17425 (call-interactively 'org-toggle-item))))
17427 (defun org-toggle-item ()
17428 "Convert headings or normal lines to items, items to normal lines.
17429 If there is no active region, only the current line is considered.
17431 If the first line in the region is a headline, convert all headlines to items.
17433 If the first line in the region is an item, convert all items to normal lines.
17435 If the first line is normal text, add an item bullet to each line."
17436 (interactive)
17437 (let (l2 l beg end)
17438 (if (org-region-active-p)
17439 (setq beg (region-beginning) end (region-end))
17440 (setq beg (point-at-bol)
17441 end (min (1+ (point-at-eol)) (point-max))))
17442 (save-excursion
17443 (goto-char end)
17444 (setq l2 (org-current-line))
17445 (goto-char beg)
17446 (beginning-of-line 1)
17447 (setq l (1- (org-current-line)))
17448 (if (org-at-item-p)
17449 ;; We already have items, de-itemize
17450 (while (< (setq l (1+ l)) l2)
17451 (when (org-at-item-p)
17453 (delete-region (point) (match-end 0)))
17454 (beginning-of-line 2))
17455 (if (org-on-heading-p)
17456 ;; Headings, convert to items
17457 (while (< (setq l (1+ l)) l2)
17458 (if (looking-at org-outline-regexp)
17459 (replace-match (org-list-bullet-string "-") t t))
17460 (beginning-of-line 2))
17461 ;; normal lines, turn them into items
17462 (while (< (setq l (1+ l)) l2)
17463 (unless (org-at-item-p)
17465 (replace-match
17467 (beginning-of-line 2)))))))
17469 (defun org-toggle-heading (&optional nstars)
17470 "Convert headings to normal text, or items or text to headings.
17471 If there is no active region, only the current line is considered.
17473 If the first line is a heading, remove the stars from all headlines
17474 in the region.
17476 If the first line is a plain list item, turn all plain list items
17477 into headings.
17479 If the first line is a normal line, turn each and every line in the
17480 region into a heading.
17482 When converting a line into a heading, the number of stars is chosen
17483 such that the lines become children of the current entry. However,
17484 when a prefix argument is given, its value determines the number of
17485 stars to add."
17486 (interactive "P")
17487 (let (l2 l itemp beg end)
17488 (if (org-region-active-p)
17489 (setq beg (region-beginning) end (region-end))
17490 (setq beg (point-at-bol)
17491 end (min (1+ (point-at-eol)) (point-max))))
17492 (save-excursion
17493 (goto-char end)
17494 (setq l2 (org-current-line))
17495 (goto-char beg)
17496 (beginning-of-line 1)
17497 (setq l (1- (org-current-line)))
17498 (if (org-on-heading-p)
17499 ;; We already have headlines, de-star them
17500 (while (< (setq l (1+ l)) l2)
17501 (when (org-on-heading-p t)
17502 (and (looking-at outline-regexp) (replace-match "")))
17503 (beginning-of-line 2))
17504 (setq itemp (org-at-item-p))
17505 (let* ((stars
17506 (if nstars
17507 (make-string (prefix-numeric-value current-prefix-arg)
17508 ?*)
17509 (save-excursion
17510 (if (re-search-backward org-complex-heading-regexp nil t)
17511 (match-string 1) ""))))
17512 (add-stars (cond (nstars "")
17513 ((equal stars "") "*")
17514 (org-odd-levels-only "**")
17515 (t "*")))
17516 (rpl (concat stars add-stars " ")))
17517 (while (< (setq l (1+ l)) l2)
17518 (if itemp
17519 (and (org-at-item-p) (replace-match rpl t t))
17520 (unless (org-on-heading-p)
17522 (replace-match (concat rpl (match-string 2))))))
17523 (beginning-of-line 2)))))))
17525 (defun org-meta-return (&optional arg)
17526 "Insert a new heading or wrap a region in a table.
17527 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17528 See the individual commands for more information."
17529 (interactive "P")
17530 (cond
17531 ((run-hook-with-args-until-success 'org-metareturn-hook))
17532 ((org-at-table-p)
17533 (call-interactively 'org-table-wrap-region))
17534 (t (call-interactively 'org-insert-heading))))
17536 ;;; Menu entries
17538 ;; Define the Org-mode menus
17539 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
17540 '("Tbl"
17541 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
17542 ["Next Field" org-cycle (org-at-table-p)]
17543 ["Previous Field" org-shifttab (org-at-table-p)]
17544 ["Next Row" org-return (org-at-table-p)]
17545 "--"
17546 ["Blank Field" org-table-blank-field (org-at-table-p)]
17547 ["Edit Field" org-table-edit-field (org-at-table-p)]
17548 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
17549 "--"
17550 ("Column"
17551 ["Move Column Left" org-metaleft (org-at-table-p)]
17552 ["Move Column Right" org-metaright (org-at-table-p)]
17553 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
17554 ["Insert Column" org-shiftmetaright (org-at-table-p)])
17555 ("Row"
17556 ["Move Row Up" org-metaup (org-at-table-p)]
17557 ["Move Row Down" org-metadown (org-at-table-p)]
17558 ["Delete Row" org-shiftmetaup (org-at-table-p)]
17559 ["Insert Row" org-shiftmetadown (org-at-table-p)]
17560 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
17561 "--"
17562 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
17563 ("Rectangle"
17564 ["Copy Rectangle" org-copy-special (org-at-table-p)]
17565 ["Cut Rectangle" org-cut-special (org-at-table-p)]
17566 ["Paste Rectangle" org-paste-special (org-at-table-p)]
17567 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
17568 "--"
17569 ("Calculate"
17570 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
17571 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17572 ["Edit Formulas" org-edit-special (org-at-table-p)]
17573 "--"
17574 ["Recalculate line" org-table-recalculate (org-at-table-p)]
17575 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17576 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
17577 "--"
17578 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
17579 "--"
17580 ["Sum Column/Rectangle" org-table-sum
17581 (or (org-at-table-p) (org-region-active-p))]
17582 ["Which Column?" org-table-current-column (org-at-table-p)])
17583 ["Debug Formulas"
17584 org-table-toggle-formula-debugger
17585 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
17586 ["Show Col/Row Numbers"
17587 org-table-toggle-coordinate-overlays
17588 :style toggle
17589 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
17590 "--"
17591 ["Create" org-table-create (and (not (org-at-table-p))
17592 org-enable-table-editor)]
17593 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
17594 ["Import from File" org-table-import (not (org-at-table-p))]
17595 ["Export to File" org-table-export (org-at-table-p)]
17596 "--"
17597 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
17599 (easy-menu-define org-org-menu org-mode-map "Org menu"
17600 '("Org"
17601 ("Show/Hide"
17602 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
17603 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
17604 ["Sparse Tree..." org-sparse-tree t]
17605 ["Reveal Context" org-reveal t]
17606 ["Show All" show-all t]
17607 "--"
17608 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
17609 "--"
17610 ["New Heading" org-insert-heading t]
17611 ("Navigate Headings"
17612 ["Up" outline-up-heading t]
17613 ["Next" outline-next-visible-heading t]
17614 ["Previous" outline-previous-visible-heading t]
17615 ["Next Same Level" outline-forward-same-level t]
17616 ["Previous Same Level" outline-backward-same-level t]
17617 "--"
17618 ["Jump" org-goto t])
17619 ("Edit Structure"
17620 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
17621 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
17622 "--"
17623 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
17624 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
17625 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
17626 "--"
17627 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
17628 "--"
17629 ["Promote Heading" org-metaleft (not (org-at-table-p))]
17630 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
17631 ["Demote Heading" org-metaright (not (org-at-table-p))]
17632 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
17633 "--"
17634 ["Sort Region/Children" org-sort (not (org-at-table-p))]
17635 "--"
17636 ["Convert to odd levels" org-convert-to-odd-levels t]
17637 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
17638 ("Editing"
17639 ["Emphasis..." org-emphasize t]
17640 ["Edit Source Example" org-edit-special t]
17641 "--"
17642 ["Footnote new/jump" org-footnote-action t]
17643 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
17644 ("Archive"
17645 ["Archive (default method)" org-archive-subtree-default t]
17646 "--"
17647 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
17648 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
17649 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
17650 )
17651 "--"
17652 ("Hyperlinks"
17653 ["Store Link (Global)" org-store-link t]
17654 ["Find existing link to here" org-occur-link-in-agenda-files t]
17655 ["Insert Link" org-insert-link t]
17656 ["Follow Link" org-open-at-point t]
17657 "--"
17658 ["Next link" org-next-link t]
17659 ["Previous link" org-previous-link t]
17660 "--"
17661 ["Descriptive Links"
17662 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
17663 :style radio
17664 :selected (member '(org-link) buffer-invisibility-spec)]
17665 ["Literal Links"
17666 (progn
17667 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
17668 :style radio
17669 :selected (not (member '(org-link) buffer-invisibility-spec))])
17670 "--"
17671 ("TODO Lists"
17672 ["TODO/DONE/-" org-todo t]
17673 ("Select keyword"
17674 ["Next keyword" org-shiftright (org-on-heading-p)]
17675 ["Previous keyword" org-shiftleft (org-on-heading-p)]
17676 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
17677 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
17678 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
17679 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
17680 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
17681 "--"
17682 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
17683 :selected org-enforce-todo-dependencies :style toggle :active t]
17684 "Settings for tree at point"
17685 ["Do Children sequentially" org-toggle-ordered-property :style radio
17686 :selected (ignore-errors (org-entry-get nil "ORDERED"))
17687 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17688 ["Do Children parallel" org-toggle-ordered-property :style radio
17689 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
17690 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17691 "--"
17692 ["Set Priority" org-priority t]
17693 ["Priority Up" org-shiftup t]
17694 ["Priority Down" org-shiftdown t]
17695 "--"
17696 ["Get news from all feeds" org-feed-update-all t]
17697 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
17698 ["Customize feeds" (customize-variable 'org-feed-alist) t])
17699 ("TAGS and Properties"
17700 ["Set Tags" org-set-tags-command t]
17701 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
17702 "--"
17703 ["Set property" org-set-property t]
17704 ["Column view of properties" org-columns t]
17705 ["Insert Column View DBlock" org-insert-columns-dblock t])
17706 ("Dates and Scheduling"
17707 ["Timestamp" org-time-stamp t]
17708 ["Timestamp (inactive)" org-time-stamp-inactive t]
17709 ("Change Date"
17710 ["1 Day Later" org-shiftright t]
17711 ["1 Day Earlier" org-shiftleft t]
17712 ["1 ... Later" org-shiftup t]
17713 ["1 ... Earlier" org-shiftdown t])
17714 ["Compute Time Range" org-evaluate-time-range t]
17715 ["Schedule Item" org-schedule t]
17716 ["Deadline" org-deadline t]
17717 "--"
17718 ["Custom time format" org-toggle-time-stamp-overlays
17719 :style radio :selected org-display-custom-times]
17720 "--"
17721 ["Goto Calendar" org-goto-calendar t]
17722 ["Date from Calendar" org-date-from-calendar t]
17723 "--"
17724 ["Start/Restart Timer" org-timer-start t]
17725 ["Pause/Continue Timer" org-timer-pause-or-continue t]
17726 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
17727 ["Insert Timer String" org-timer t]
17728 ["Insert Timer Item" org-timer-item t])
17729 ("Logging work"
17730 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
17731 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
17732 ["Clock out" org-clock-out t]
17733 ["Clock cancel" org-clock-cancel t]
17734 "--"
17735 ["Mark as default task" org-clock-mark-default-task t]
17736 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
17737 ["Goto running clock" org-clock-goto t]
17738 "--"
17739 ["Display times" org-clock-display t]
17740 ["Create clock table" org-clock-report t]
17741 "--"
17742 ["Record DONE time"
17743 (progn (setq org-log-done (not org-log-done))
17744 (message "Switching to %s will %s record a timestamp"
17745 (car org-done-keywords)
17746 (if org-log-done "automatically" "not")))
17747 :style toggle :selected org-log-done])
17748 "--"
17749 ["Agenda Command..." org-agenda t]
17750 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
17751 ("File List for Agenda")
17752 ("Special views current file"
17753 ["TODO Tree" org-show-todo-tree t]
17754 ["Check Deadlines" org-check-deadlines t]
17755 ["Timeline" org-timeline t]
17756 ["Tags/Property tree" org-match-sparse-tree t])
17757 "--"
17758 ["Export/Publish..." org-export t]
17759 ("LaTeX"
17760 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
17761 :selected org-cdlatex-mode]
17762 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
17763 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
17764 ["Modify math symbol" org-cdlatex-math-modify
17765 (org-inside-LaTeX-fragment-p)]
17766 ["Insert citation" org-reftex-citation t]
17767 "--"
17768 ["Template for BEAMER" org-insert-beamer-options-template t])
17769 "--"
17770 ("MobileOrg"
17771 ["Push Files and Views" org-mobile-push t]
17772 ["Get Captured and Flagged" org-mobile-pull t]
17773 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
17774 "--"
17775 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
17776 "--"
17777 ("Documentation"
17778 ["Show Version" org-version t]
17779 ["Info Documentation" org-info t])
17780 ("Customize"
17781 ["Browse Org Group" org-customize t]
17782 "--"
17783 ["Expand This Menu" org-create-customize-menu
17784 (fboundp 'customize-menu-create)])
17785 ["Send bug report" org-submit-bug-report t]
17786 "--"
17787 ("Refresh/Reload"
17788 ["Refresh setup current buffer" org-mode-restart t]
17789 ["Reload Org (after update)" org-reload t]
17790 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
17791 ))
17793 (defun org-info (&optional node)
17794 "Read documentation for Org-mode in the info system.
17795 With optional NODE, go directly to that node."
17796 (interactive)
17797 (info (format "(org)%s" (or node ""))))
17799 ;;;###autoload
17800 (defun org-submit-bug-report ()
17801 "Submit a bug report on Org-mode via mail.
17803 Don't hesitate to report any problems or inaccurate documentation.
17805 If you don't have setup sending mail from (X)Emacs, please copy the
17806 output buffer into your mail program, as it gives us important
17807 information about your Org-mode version and configuration."
17808 (interactive)
17809 (require 'reporter)
17810 (org-load-modules-maybe)
17811 (org-require-autoloaded-modules)
17812 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
17813 (reporter-submit-bug-report
17814 "emacs-orgmode@gnu.org"
17815 (org-version)
17816 (let (list)
17817 (save-window-excursion
17818 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
17819 (delete-other-windows)
17820 (erase-buffer)
17821 (insert "You are about to submit a bug report to the Org-mode mailing list.
17823 We would like to add your full Org-mode and Outline configuration to the
17824 bug report. This greatly simplifies the work of the maintainer and
17825 other experts on the mailing list.
17827 HOWEVER, some variables you have customized may contain private
17828 information. The names of customers, colleagues, or friends, might
17829 appear in the form of file names, tags, todo states, or search strings.
17830 If you answer yes to the prompt, you might want to check and remove
17831 such private information before sending the email.")
17832 (add-text-properties (point-min) (point-max) '(face org-warning))
17833 (when (yes-or-no-p "Include your Org-mode configuration ")
17834 (mapatoms
17835 (lambda (v)
17836 (and (boundp v)
17838 (or (and (symbol-value v)
17840 (and
17841 (get v 'custom-type) (get v 'standard-value)
17842 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
17843 (push v list)))))
17844 (kill-buffer (get-buffer "*Warn about privacy*"))
17845 list))
17846 nil nil
17847 "Remember to cover the basics, that is, what you expected to happen and
17848 what in fact did happen. You don't know how to make a good report? See
17850 http://orgmode.org/manual/Feedback.html#Feedback
17852 Your bug report will be posted to the Org-mode mailing list.
17853 ------------------------------------------------------------------------")
17854 (save-excursion
17859 (defun org-install-agenda-files-menu ()
17860 (let ((bl (buffer-list)))
17861 (save-excursion
17862 (while bl
17863 (set-buffer (pop bl))
17864 (if (org-mode-p) (setq bl nil)))
17865 (when (org-mode-p)
17866 (easy-menu-change
17867 '("Org") "File List for Agenda"
17868 (append
17869 (list
17870 ["Edit File List" (org-edit-agenda-file-list) t]
17871 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
17872 ["Remove Current File from List" org-remove-file t]
17873 ["Cycle through agenda files" org-cycle-agenda-files t]
17874 ["Occur in all agenda files" org-occur-in-agenda-files t]
17875 "--")
17876 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
17878 ;;;; Documentation
17880 ;;;###autoload
17881 (defun org-require-autoloaded-modules ()
17882 (interactive)
17883 (mapc 'require
17884 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
17885 org-docbook org-exp org-html org-icalendar
17886 org-id org-latex
17887 org-publish org-remember org-table
17888 org-timer org-xoxo)))
17890 ;;;###autoload
17891 (defun org-reload (&optional uncompiled)
17892 "Reload all org lisp files.
17893 With prefix arg UNCOMPILED, load the uncompiled versions."
17894 (interactive "P")
17895 (require 'find-func)
17897 (dir-org (file-name-directory (org-find-library-name "org")))
17898 (dir-org-contrib (ignore-errors
17899 (file-name-directory
17900 (org-find-library-name "org-contribdir"))))
17901 (babel-files
17902 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
17903 (append (list nil "comint" "eval" "exp" "keys"
17904 "lob" "ref" "table" "tangle")
17905 (delq nil
17906 (mapcar
17907 (lambda (lang)
17908 (when (cdr lang) (symbol-name (car lang))))
17909 org-babel-load-languages)))))
17910 (files
17911 (append (directory-files dir-org t file-re)
17912 babel-files
17913 (and dir-org-contrib
17914 (directory-files dir-org-contrib t file-re))))
17915 (remove-re (concat (if (featurep 'xemacs)
17916 "org-colview" "org-colview-xemacs")
17918 (setq files (mapcar 'file-name-sans-extension files))
17919 (setq files (mapcar
17920 (lambda (x) (if (string-match remove-re x) nil x))
17921 files))
17922 (setq files (delq nil files))
17923 (mapc
17924 (lambda (f)
17925 (when (featurep (intern (file-name-nondirectory f)))
17926 (if (and (not uncompiled)
17927 (file-exists-p (concat f ".elc")))
17928 (load (concat f ".elc") nil nil t)
17929 (load (concat f ".el") nil nil t))))
17930 files))
17931 (org-version))
17933 ;;;###autoload
17934 (defun org-customize ()
17935 "Call the customize function with org as argument."
17936 (interactive)
17937 (org-load-modules-maybe)
17938 (org-require-autoloaded-modules)
17939 (customize-browse 'org))
17941 (defun org-create-customize-menu ()
17942 "Create a full customization menu for Org-mode, insert it into the menu."
17943 (interactive)
17944 (org-load-modules-maybe)
17945 (org-require-autoloaded-modules)
17946 (if (fboundp 'customize-menu-create)
17947 (progn
17948 (easy-menu-change
17949 '("Org") "Customize"
17950 `(["Browse Org group" org-customize t]
17951 "--"
17952 ,(customize-menu-create 'org)
17953 ["Set" Custom-set t]
17954 ["Save" Custom-save t]
17955 ["Reset to Current" Custom-reset-current t]
17956 ["Reset to Saved" Custom-reset-saved t]
17957 ["Reset to Standard Settings" Custom-reset-standard t]))
17959 (error "Cannot expand menu (outdated version of cus-edit.el)")))
17961 ;;;; Miscellaneous stuff
17963 ;;; Generally useful functions
17965 (defun org-get-at-bol (property)
17966 "Get text property PROPERTY at beginning of line."
17967 (get-text-property (point-at-bol) property))
17969 (defun org-find-text-property-in-string (prop s)
17970 "Return the first non-nil value of property PROP in string S."
17971 (or (get-text-property 0 prop s)
17972 (get-text-property (or (next-single-property-change 0 prop s) 0)
17973 prop s)))
17975 (defun org-display-warning (message) ;; Copied from Emacs-Muse
17976 "Display the given MESSAGE as a warning."
17977 (if (fboundp 'display-warning)
17978 (display-warning 'org message
17979 (if (featurep 'xemacs) 'warning :warning))
17980 (let ((buf (get-buffer-create "*Org warnings*")))
17981 (with-current-buffer buf
17982 (goto-char (point-max))
17983 (insert "Warning (Org): " message)
17984 (unless (bolp)
17985 (newline)))
17986 (display-buffer buf)
17987 (sit-for 0))))
17989 (defun org-in-commented-line ()
17990 "Is point in a line starting with `#'?"
17991 (equal (char-after (point-at-bol)) ?#))
17993 (defun org-in-indented-comment-line ()
17994 "Is point in a line starting with `#' after some white space?"
17995 (save-excursion
17996 (save-match-data
17997 (goto-char (point-at-bol))
18000 (defun org-in-verbatim-emphasis ()
18001 (save-match-data
18002 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18004 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18005 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18006 (if (and marker (marker-buffer marker)
18007 (buffer-live-p (marker-buffer marker)))
18008 (progn
18009 (switch-to-buffer (marker-buffer marker))
18010 (if (or (> marker (point-max)) (< marker (point-min)))
18011 (widen))
18012 (goto-char marker)
18013 (org-show-context 'org-goto))
18014 (if bookmark
18015 (bookmark-jump bookmark)
18016 (error "Cannot find location"))))
18018 (defun org-quote-csv-field (s)
18019 "Quote field for inclusion in CSV material."
18022 s))
18024 (defun org-plist-delete (plist property)
18025 "Delete PROPERTY from PLIST.
18026 This is in contrast to merely setting it to 0."
18027 (let (p)
18028 (while plist
18029 (if (not (eq property (car plist)))
18030 (setq p (plist-put p (car plist) (nth 1 plist))))
18031 (setq plist (cddr plist)))
18032 p))
18034 (defun org-force-self-insert (N)
18035 "Needed to enforce self-insert under remapping."
18036 (interactive "p")
18037 (self-insert-command N))
18039 (defun org-string-width (s)
18040 "Compute width of string, ignoring invisible characters.
18041 This ignores character with invisibility property `org-link', and also
18042 characters with property `org-cwidth', because these will become invisible
18043 upon the next fontification round."
18044 (let (b l)
18045 (when (or (eq t buffer-invisibility-spec)
18046 (assq 'org-link buffer-invisibility-spec))
18047 (while (setq b (text-property-any 0 (length s)
18048 'invisible 'org-link s))
18049 (setq s (concat (substring s 0 b)
18050 (substring s (or (next-single-property-change
18051 b 'invisible s) (length s)))))))
18052 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18053 (setq s (concat (substring s 0 b)
18054 (substring s (or (next-single-property-change
18055 b 'org-cwidth s) (length s))))))
18056 (setq l (string-width s) b -1)
18057 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18058 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18059 l))
18061 (defun org-get-indentation (&optional line)
18062 "Get the indentation of the current line, interpreting tabs.
18063 When LINE is given, assume it represents a line and compute its indentation."
18064 (if line
18065 (if (string-match "^ *" (org-remove-tabs line))
18066 (match-end 0))
18067 (save-excursion
18068 (beginning-of-line 1)
18070 (current-column))))
18072 (defun org-remove-tabs (s &optional width)
18073 "Replace tabulators in S with spaces.
18074 Assumes that s is a single line, starting in column 0."
18075 (setq width (or width tab-width))
18077 (setq s (replace-match
18078 (make-string
18079 (- (* width (/ (+ (match-beginning 0) width) width))
18080 (match-beginning 0)) ?\ )
18081 t t s)))
18082 s)
18084 (defun org-fix-indentation (line ind)
18085 "Fix indentation in LINE.
18086 IND is a cons cell with target and minimum indentation.
18087 If the current indentation in LINE is smaller than the minimum,
18088 leave it alone. If it is larger than ind, set it to the target."
18089 (let* ((l (org-remove-tabs line))
18090 (i (org-get-indentation l))
18091 (i1 (car ind)) (i2 (cdr ind)))
18092 (if (>= i i2) (setq l (substring line i2)))
18093 (if (> i1 0)
18094 (concat (make-string i1 ?\ ) l)
18095 l)))
18097 (defun org-remove-indentation (code &optional n)
18098 "Remove the maximum common indentation from the lines in CODE.
18099 N may optionally be the number of spaces to remove."
18100 (with-temp-buffer
18101 (insert code)
18102 (org-do-remove-indentation n)
18103 (buffer-string)))
18105 (defun org-do-remove-indentation (&optional n)
18106 "Remove the maximum common indentation from the buffer."
18107 (untabify (point-min) (point-max))
18108 (let ((min 10000) re)
18109 (if n
18110 (setq min n)
18111 (goto-char (point-min))
18113 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18114 (unless (or (= min 0) (= min 10000))
18116 (goto-char (point-min))
18117 (while (re-search-forward re nil t)
18118 (replace-match "")
18119 (end-of-line 1))
18120 min)))
18122 (defun org-fill-template (template alist)
18123 "Find each %key of ALIST in TEMPLATE and replace it."
18124 (let ((case-fold-search nil)
18125 entry key value)
18126 (setq alist (sort (copy-sequence alist)
18127 (lambda (a b) (< (length (car a)) (length (car b))))))
18128 (while (setq entry (pop alist))
18129 (setq template
18130 (replace-regexp-in-string
18131 (concat "%" (regexp-quote (car entry)))
18132 (cdr entry) template t t)))
18133 template))
18135 (defun org-base-buffer (buffer)
18136 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18137 (if (not buffer)
18138 buffer
18139 (or (buffer-base-buffer buffer)
18140 buffer)))
18142 (defun org-trim (s)
18143 "Remove whitespace at beginning and end of string."
18146 s)
18148 (defun org-wrap (string &optional width lines)
18149 "Wrap string to either a number of lines, or a width in characters.
18150 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18151 that costs. If there is a word longer than WIDTH, the text is actually
18152 wrapped to the length of that word.
18153 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18154 many lines, whatever width that takes.
18155 The return value is a list of lines, without newlines at the end."
18157 (maxword (apply 'max (mapcar 'org-string-width words)))
18158 w ll)
18159 (cond (width
18160 (org-do-wrap words (max maxword width)))
18161 (lines
18162 (setq w maxword)
18163 (setq ll (org-do-wrap words maxword))
18164 (if (<= (length ll) lines)
18165 ll
18166 (setq ll words)
18167 (while (> (length ll) lines)
18168 (setq w (1+ w))
18169 (setq ll (org-do-wrap words w)))
18170 ll))
18171 (t (error "Cannot wrap this")))))
18173 (defun org-do-wrap (words width)
18174 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18175 (let (lines line)
18176 (while words
18177 (setq line (pop words))
18178 (while (and words (< (+ (length line) (length (car words))) width))
18179 (setq line (concat line " " (pop words))))
18180 (setq lines (push line lines)))
18181 (nreverse lines)))
18183 (defun org-split-string (string &optional separators)
18184 "Splits STRING into substrings at SEPARATORS.
18185 No empty strings are returned if there are matches at the beginning
18186 and end of string."
18188 (start 0)
18189 notfirst
18190 (list nil))
18191 (while (and (string-match rexp string
18192 (if (and notfirst
18193 (= start (match-beginning 0))
18194 (< start (length string)))
18195 (1+ start) start))
18196 (< (match-beginning 0) (length string)))
18197 (setq notfirst t)
18198 (or (eq (match-beginning 0) 0)
18199 (and (eq (match-beginning 0) (match-end 0))
18200 (eq (match-beginning 0) start))
18201 (setq list
18202 (cons (substring string start (match-beginning 0))
18203 list)))
18204 (setq start (match-end 0)))
18205 (or (eq start (length string))
18206 (setq list
18207 (cons (substring string start)
18208 list)))
18209 (nreverse list)))
18211 (defun org-quote-vert (s)
18213 (while (string-match "|" s)
18215 s)
18217 (defun org-uuidgen-p (s)
18218 "Is S an ID created by UUIDGEN?"
18219 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18221 (defun org-context ()
18222 "Return a list of contexts of the current cursor position.
18223 If several contexts apply, all are returned.
18224 Each context entry is a list with a symbol naming the context, and
18225 two positions indicating start and end of the context. Possible
18226 contexts are:
18228 :headline anywhere in a headline
18229 :headline-stars on the leading stars in a headline
18230 :todo-keyword on a TODO keyword (including DONE) in a headline
18231 :tags on the TAGS in a headline
18232 :priority on the priority cookie in a headline
18233 :item on the first line of a plain list item
18234 :item-bullet on the bullet/number of a plain list item
18235 :checkbox on the checkbox in a plain list item
18236 :table in an org-mode table
18237 :table-special on a special filed in a table
18238 :table-table in a table.el table
18239 :link on a hyperlink
18240 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18241 :target on a <<target>>
18242 :radio-target on a <<<radio-target>>>
18243 :latex-fragment on a LaTeX fragment
18244 :latex-preview on a LaTeX fragment with overlayed preview image
18246 This function expects the position to be visible because it uses font-lock
18247 faces as a help to recognize the following contexts: :table-special, :link,
18248 and :keyword."
18249 (let* ((f (get-text-property (point) 'face))
18250 (faces (if (listp f) f (list f)))
18251 (p (point)) clist o)
18252 ;; First the large context
18253 (cond
18254 ((org-on-heading-p t)
18255 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18256 (when (progn
18257 (beginning-of-line 1)
18258 (looking-at org-todo-line-tags-regexp))
18259 (push (org-point-in-group p 1 :headline-stars) clist)
18260 (push (org-point-in-group p 2 :todo-keyword) clist)
18261 (push (org-point-in-group p 4 :tags) clist))
18262 (goto-char p)
18265 (push (org-point-in-group p 0 :priority) clist)))
18267 ((org-at-item-p)
18268 (push (org-point-in-group p 2 :item-bullet) clist)
18269 (push (list :item (point-at-bol)
18270 (save-excursion (org-end-of-item) (point)))
18271 clist)
18272 (and (org-at-item-checkbox-p)
18273 (push (org-point-in-group p 0 :checkbox) clist)))
18275 ((org-at-table-p)
18276 (push (list :table (org-table-begin) (org-table-end)) clist)
18277 (if (memq 'org-formula faces)
18278 (push (list :table-special
18279 (previous-single-property-change p 'face)
18280 (next-single-property-change p 'face)) clist)))
18281 ((org-at-table-p 'any)
18282 (push (list :table-table) clist)))
18283 (goto-char p)
18285 ;; Now the small context
18286 (cond
18287 ((org-at-timestamp-p)
18288 (push (org-point-in-group p 0 :timestamp) clist))
18289 ((memq 'org-link faces)
18290 (push (list :link
18291 (previous-single-property-change p 'face)
18292 (next-single-property-change p 'face)) clist))
18293 ((memq 'org-special-keyword faces)
18294 (push (list :keyword
18295 (previous-single-property-change p 'face)
18296 (next-single-property-change p 'face)) clist))
18297 ((org-on-target-p)
18298 (push (org-point-in-group p 0 :target) clist)
18299 (goto-char (1- (match-beginning 0)))
18300 (if (looking-at org-radio-target-regexp)
18301 (push (org-point-in-group p 0 :radio-target) clist))
18302 (goto-char p))
18303 ((setq o (car (delq nil
18304 (mapcar
18305 (lambda (x)
18306 (if (memq x org-latex-fragment-image-overlays) x))
18307 (overlays-at (point))))))
18308 (push (list :latex-fragment
18309 (overlay-start o) (overlay-end o)) clist)
18310 (push (list :latex-preview
18311 (overlay-start o) (overlay-end o)) clist))
18312 ((org-inside-LaTeX-fragment-p)
18313 ;; FIXME: positions wrong.
18314 (push (list :latex-fragment (point) (point)) clist)))
18316 (setq clist (nreverse (delq nil clist)))
18317 clist))
18319 ;; FIXME: Compare with at-regexp-p Do we need both?
18320 (defun org-in-regexp (re &optional nlines visually)
18321 "Check if point is inside a match of regexp.
18322 Normally only the current line is checked, but you can include NLINES extra
18323 lines both before and after point into the search.
18324 If VISUALLY is set, require that the cursor is not after the match but
18325 really on, so that the block visually is on the match."
18326 (catch 'exit
18327 (let ((pos (point))
18328 (eol (point-at-eol (+ 1 (or nlines 0))))
18329 (inc (if visually 1 0)))
18330 (save-excursion
18331 (beginning-of-line (- 1 (or nlines 0)))
18332 (while (re-search-forward re eol t)
18333 (if (and (<= (match-beginning 0) pos)
18334 (>= (+ inc (match-end 0)) pos))
18335 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18337 (defun org-at-regexp-p (regexp)
18338 "Is point inside a match of REGEXP in the current line?"
18339 (catch 'exit
18340 (save-excursion
18341 (let ((pos (point)) (end (point-at-eol)))
18342 (beginning-of-line 1)
18343 (while (re-search-forward regexp end t)
18344 (if (and (<= (match-beginning 0) pos)
18345 (>= (match-end 0) pos))
18346 (throw 'exit t)))
18347 nil))))
18349 (defun org-in-regexps-block-p (start-re end-re &optional bound)
18350 "Return t if the current point is between matches of START-RE and END-RE.
18351 This will also return t if point is on one of the two matches or
18352 in an unfinished block. END-RE can be a string or a form
18353 returning a string.
18355 An optional third argument bounds the search for START-RE. It
18356 defaults to previous heading or `point-min'."
18357 (let ((pos (point))
18358 (limit (or bound (save-excursion (outline-previous-heading)))))
18359 (save-excursion
18360 ;; we're on a block when point is on start-re...
18361 (or (org-at-regexp-p start-re)
18362 ;; ... or start-re can be found above...
18363 (and (re-search-backward start-re limit t)
18364 ;; ... but no end-re between start-re and point.
18365 (not (re-search-forward (eval end-re) pos t)))))))
18367 (defun org-occur-in-agenda-files (regexp &optional nlines)
18368 "Call `multi-occur' with buffers for all agenda files."
18370 (let* ((files (org-agenda-files))
18371 (tnames (mapcar 'file-truename files))
18372 (extra org-agenda-text-search-extra-files)
18373 f)
18374 (when (eq (car extra) 'agenda-archives)
18375 (setq extra (cdr extra))
18376 (setq files (org-add-archive-files files)))
18377 (while (setq f (pop extra))
18378 (unless (member (file-truename f) tnames)
18379 (add-to-list 'files f 'append)
18380 (add-to-list 'tnames (file-truename f) 'append)))
18381 (multi-occur
18382 (mapcar (lambda (x)
18383 (with-current-buffer
18384 (or (get-file-buffer x) (find-file-noselect x))
18385 (widen)
18386 (current-buffer)))
18387 files)
18388 regexp)))
18390 (if (boundp 'occur-mode-find-occurrence-hook)
18391 ;; Emacs 23
18392 (add-hook 'occur-mode-find-occurrence-hook
18393 (lambda ()
18394 (when (org-mode-p)
18395 (org-reveal))))
18396 ;; Emacs 22
18397 (defadvice occur-mode-goto-occurrence
18398 (after org-occur-reveal activate)
18399 (and (org-mode-p) (org-reveal)))
18400 (defadvice occur-mode-goto-occurrence-other-window
18401 (after org-occur-reveal activate)
18402 (and (org-mode-p) (org-reveal)))
18403 (defadvice occur-mode-display-occurrence
18404 (after org-occur-reveal activate)
18405 (when (org-mode-p)
18406 (let ((pos (occur-mode-find-occurrence)))
18407 (with-current-buffer (marker-buffer pos)
18408 (save-excursion
18409 (goto-char pos)
18410 (org-reveal)))))))
18412 (defun org-occur-link-in-agenda-files ()
18413 "Create a link and search for it in the agendas.
18414 The link is not stored in `org-stored-links', it is just created
18415 for the search purpose."
18416 (interactive)
18417 (let ((link (condition-case nil
18418 (org-store-link nil)
18419 (error "Unable to create a link to here"))))
18420 (org-occur-in-agenda-files (regexp-quote link))))
18422 (defun org-uniquify (list)
18423 "Remove duplicate elements from LIST."
18424 (let (res)
18425 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
18426 res))
18428 (defun org-delete-all (elts list)
18429 "Remove all elements in ELTS from LIST."
18430 (while elts
18431 (setq list (delete (pop elts) list)))
18432 list)
18434 (defun org-count (cl-item cl-seq)
18435 "Count the number of occurrences of ITEM in SEQ.
18436 Taken from `count' in cl-seq.el with all keyword arguments removed."
18437 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
18438 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
18439 (while (< cl-start cl-end)
18440 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
18441 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
18442 (setq cl-start (1+ cl-start)))
18443 cl-count))
18445 (defun org-remove-if (predicate seq)
18446 "Remove everything from SEQ that fulfills PREDICATE."
18447 (let (res e)
18448 (while seq
18449 (setq e (pop seq))
18450 (if (not (funcall predicate e)) (push e res)))
18451 (nreverse res)))
18453 (defun org-remove-if-not (predicate seq)
18454 "Remove everything from SEQ that does not fulfill PREDICATE."
18455 (let (res e)
18456 (while seq
18457 (setq e (pop seq))
18458 (if (funcall predicate e) (push e res)))
18459 (nreverse res)))
18461 (defun org-back-over-empty-lines ()
18462 "Move backwards over whitespace, to the beginning of the first empty line.
18463 Returns the number of empty lines passed."
18464 (let ((pos (point)))
18466 (beginning-of-line 2)
18467 (goto-char (min (point) pos))
18468 (count-lines (point) pos)))
18470 (defun org-skip-whitespace ()
18473 (defun org-point-in-group (point group &optional context)
18474 "Check if POINT is in match-group GROUP.
18475 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18476 match. If the match group does not exist or point is not inside it,
18477 return nil."
18478 (and (match-beginning group)
18479 (>= point (match-beginning group))
18480 (<= point (match-end group))
18481 (if context
18482 (list context (match-beginning group) (match-end group))
18483 t)))
18485 (defun org-switch-to-buffer-other-window (&rest args)
18486 "Switch to buffer in a second window on the current frame.
18487 In particular, do not allow pop-up frames.
18488 Returns the newly created buffer."
18489 (let (pop-up-frames special-display-buffer-names special-display-regexps
18490 special-display-function)
18491 (apply 'switch-to-buffer-other-window args)))
18493 (defun org-combine-plists (&rest plists)
18494 "Create a single property list from all plists in PLISTS.
18495 The process starts by copying the first list, and then setting properties
18496 from the other lists. Settings in the last list are the most significant
18497 ones and overrule settings in the other lists."
18498 (let ((rtn (copy-sequence (pop plists)))
18499 p v ls)
18500 (while plists
18501 (setq ls (pop plists))
18502 (while ls
18503 (setq p (pop ls) v (pop ls))
18504 (setq rtn (plist-put rtn p v))))
18505 rtn))
18507 (defun org-move-line-down (arg)
18508 "Move the current line down. With prefix argument, move it past ARG lines."
18509 (interactive "p")
18510 (let ((col (current-column))
18511 beg end pos)
18512 (beginning-of-line 1) (setq beg (point))
18513 (beginning-of-line 2) (setq end (point))
18514 (beginning-of-line (+ 1 arg))
18515 (setq pos (move-marker (make-marker) (point)))
18516 (insert (delete-and-extract-region beg end))
18517 (goto-char pos)
18518 (org-move-to-column col)))
18520 (defun org-move-line-up (arg)
18521 "Move the current line up. With prefix argument, move it past ARG lines."
18522 (interactive "p")
18523 (let ((col (current-column))
18524 beg end pos)
18525 (beginning-of-line 1) (setq beg (point))
18526 (beginning-of-line 2) (setq end (point))
18527 (beginning-of-line (- arg))
18528 (setq pos (move-marker (make-marker) (point)))
18529 (insert (delete-and-extract-region beg end))
18530 (goto-char pos)
18531 (org-move-to-column col)))
18533 (defun org-replace-escapes (string table)
18534 "Replace %-escapes in STRING with values in TABLE.
18536 The sequences in STRING may contain normal field width and padding information,
18538 so values can contain further %-escapes if they are define later in TABLE."
18539 (let ((tbl (copy-alist table))
18540 (case-fold-search nil)
18541 (pchg 0)
18542 e re rpl)
18543 (while (setq e (pop tbl))
18544 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
18545 (when (and (cdr e) (string-match re (cdr e)))
18546 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
18547 (safe "SREF"))
18548 (add-text-properties 0 3 (list 'sref sref) safe)
18549 (setcdr e (replace-match safe t t (cdr e)))))
18550 (while (string-match re string)
18551 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
18552 (cdr e)))
18553 (setq string (replace-match rpl t t string))))
18554 (while (setq pchg (next-property-change pchg string))
18555 (let ((sref (get-text-property pchg 'sref string)))
18556 (when (and sref (string-match "SREF" string pchg))
18557 (setq string (replace-match sref t t string)))))
18558 string))
18560 (defun org-sublist (list start end)
18561 "Return a section of LIST, from START to END.
18562 Counting starts at 1."
18563 (let (rtn (c start))
18564 (setq list (nthcdr (1- start) list))
18565 (while (and list (<= c end))
18566 (push (pop list) rtn)
18567 (setq c (1+ c)))
18568 (nreverse rtn)))
18570 (defun org-find-base-buffer-visiting (file)
18571 "Like `find-buffer-visiting' but always return the base buffer and
18572 not an indirect buffer."
18573 (let ((buf (or (get-file-buffer file)
18574 (find-buffer-visiting file))))
18575 (if buf
18576 (or (buffer-base-buffer buf) buf)
18577 nil)))
18579 (defun org-image-file-name-regexp (&optional extensions)
18580 "Return regexp matching the file names of images.
18581 If EXTENSIONS is given, only match these."
18582 (if (and (not extensions) (fboundp 'image-file-name-regexp))
18583 (image-file-name-regexp)
18584 (let ((image-file-name-extensions
18585 (or extensions
18586 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
18587 "xbm" "xpm" "pbm" "pgm" "ppm"))))
18589 (regexp-opt (nconc (mapcar 'upcase
18590 image-file-name-extensions)
18591 image-file-name-extensions)
18592 t)
18595 (defun org-file-image-p (file &optional extensions)
18596 "Return non-nil if FILE is an image."
18597 (save-match-data
18598 (string-match (org-image-file-name-regexp extensions) file)))
18600 (defun org-get-cursor-date ()
18601 "Return the date at cursor in as a time.
18602 This works in the calendar and in the agenda, anywhere else it just
18603 returns the current time."
18604 (let (date day defd)
18605 (cond
18606 ((eq major-mode 'calendar-mode)
18607 (setq date (calendar-cursor-to-date)
18608 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
18609 ((eq major-mode 'org-agenda-mode)
18610 (setq day (get-text-property (point) 'day))
18611 (if day
18612 (setq date (calendar-gregorian-from-absolute day)
18613 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
18614 (nth 2 date))))))
18615 (or defd (current-time))))
18617 (defvar org-agenda-action-marker (make-marker)
18618 "Marker pointing to the entry for the next agenda action.")
18620 (defun org-mark-entry-for-agenda-action ()
18621 "Mark the current entry as target of an agenda action.
18622 Agenda actions are actions executed from the agenda with the key `k',
18623 which make use of the date at the cursor."
18624 (interactive)
18625 (move-marker org-agenda-action-marker
18626 (save-excursion (org-back-to-heading t) (point))
18627 (current-buffer))
18628 (message
18629 "Entry marked for action; press `k' at desired date in agenda or calendar"))
18631 ;;; Paragraph filling stuff.
18632 ;; We want this to be just right, so use the full arsenal.
18634 (defun org-indent-line-function ()
18635 "Indent line like previous, but further if previous was headline or item."
18636 (interactive)
18637 (let* ((pos (point))
18638 (itemp (org-at-item-p))
18639 (case-fold-search t)
18641 (inline-task-p (and (featurep 'org-inlinetask)
18642 (org-inlinetask-in-task-p)))
18643 column bpos bcol tpos tcol bullet btype bullet-type)
18644 ;; Find the previous relevant line
18645 (beginning-of-line 1)
18646 (cond
18647 ;; Comments
18648 ((looking-at "#") (setq column 0))
18649 ;; Headings
18651 ;; Drawers
18653 (save-excursion (re-search-backward org-drawer-regexp nil t)))
18654 (save-excursion
18655 (goto-char (1- (match-beginning 1)))
18656 (setq column (current-column))))
18657 ;; Special blocks
18659 (save-excursion
18660 (re-search-backward
18662 (setq column (org-get-indentation (match-string 0))))
18665 (save-excursion
18667 (setq column
18668 (if (equal (downcase (match-string 1)) "src")
18669 ;; src blocks: let `org-edit-src-exit' handle them
18670 (org-get-indentation)
18671 (org-get-indentation (match-string 0)))))
18672 ;; Lists
18673 ((org-in-item-p)
18674 (org-beginning-of-item)
18675 (looking-at "[ \t]*\\(\\S-+\\)[ \t]*\\(\\(:?\\[@\\(:?start:\\)?[0-9]+\\][ \t]*\\)?\\[[- X]\\][ \t]*\\|.*? :: \\)?")
18676 (setq bpos (match-beginning 1) tpos (match-end 0)
18677 bcol (progn (goto-char bpos) (current-column))
18678 tcol (progn (goto-char tpos) (current-column))
18679 bullet (match-string 1)
18680 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
18681 (if (> tcol (+ bcol org-description-max-indent))
18682 (setq tcol (+ bcol 5)))
18683 (if (not itemp)
18684 (setq column tcol)
18685 (beginning-of-line 1)
18686 (goto-char pos)
18688 (progn
18690 (setq bullet (match-string 1)
18691 btype (if (string-match "[0-9]" bullet) "n" bullet))
18692 (setq column (if (equal btype bullet-type) bcol tcol)))
18693 (setq column (org-get-indentation)))))
18694 ;; This line has nothing special, look upside to get a clue about
18695 ;; what to do.
18696 (t
18697 (beginning-of-line 0)
18698 (while (and (not (bobp))
18699 ;; skip comments, verbatim, empty lines, tables,
18700 ;; inline tasks
18702 (and (org-in-item-p) (goto-char (org-list-top-point)))
18703 (and (not inline-task-p)
18704 (featurep 'org-inlinetask)
18705 (org-inlinetask-in-task-p)))
18707 (not (looking-at org-drawer-regexp)))
18708 (beginning-of-line 0))
18709 (cond
18710 ;; There was an heading above.
18712 (if (not org-adapt-indentation)
18713 (setq column 0)
18714 (goto-char (match-end 0))
18715 (setq column (current-column))))
18716 ;; A drawer had started and is unfinished: indent consequently.
18717 ((looking-at org-drawer-regexp)
18718 (goto-char (1- (match-beginning 1)))
18719 (setq column (current-column)))
18720 ;; The drawer had ended: indent like its :END: line.
18722 (goto-char (match-end 1))
18723 (setq column (current-column)))
18724 ;; Else, nothing noticeable found: get indentation and go on.
18725 (t (setq column (org-get-indentation))))))
18726 (goto-char pos)
18727 (if (<= (current-column) (current-indentation))
18728 (org-indent-line-to column)
18729 (save-excursion (org-indent-line-to column)))
18730 (setq column (current-column))
18731 (beginning-of-line 1)
18732 (if (looking-at
18734 (replace-match (concat (match-string 1)
18735 (format org-property-format
18736 (match-string 2) (match-string 3)))
18737 t t))
18738 (org-move-to-column column)))
18740 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
18741 "Variable to store copy of `adaptive-fill-regexp'.
18742 Since `adaptive-fill-regexp' is set to never match, we need to
18743 store a backup of its value before entering `org-mode' so that
18744 the functionality can be provided as a fall-back.")
18746 (defun org-set-autofill-regexps ()
18747 (interactive)
18748 ;; In the paragraph separator we include headlines, because filling
18749 ;; text in a line directly attached to a headline would otherwise
18750 ;; fill the headline as well.
18753 ;; The paragraph starter includes hand-formatted lists.
18754 (org-set-local
18755 'paragraph-start
18756 (concat
18765 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
18766 ;; But only if the user has not turned off tables or fixed-width regions
18767 (org-set-local
18768 'auto-fill-inhibit-regexp
18771 (if (or org-enable-table-editor org-enable-fixed-width-editor)
18772 (concat
18774 (if org-enable-table-editor "|" "")
18775 (if org-enable-fixed-width-editor ":" "")
18776 "]"))))
18777 ;; We use our own fill-paragraph function, to make sure that tables
18778 ;; and fixed-width regions are not wrapped. That function will pass
18779 ;; through to `fill-paragraph' when appropriate.
18780 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
18781 ;; Adaptive filling: To get full control, first make sure that
18782 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
18783 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
18784 (org-set-local 'org-adaptive-fill-regexp-backup
18785 adaptive-fill-regexp))
18787 (org-set-local 'adaptive-fill-function
18788 'org-adaptive-fill-function)
18789 (org-set-local
18790 'align-mode-rules-list
18791 '((org-in-buffer-settings
18793 (modes . '(org-mode))))))
18795 (defun org-fill-paragraph (&optional justify)
18796 "Re-align a table, pass through to fill-paragraph if no table."
18797 (let ((table-p (org-at-table-p))
18798 (table.el-p (org-at-table.el-p)))
18799 (cond ((and (equal (char-after (point-at-bol)) ?*)
18800 (save-excursion (goto-char (point-at-bol))
18801 (looking-at outline-regexp)))
18802 t) ; skip headlines
18803 (table.el-p t) ; skip table.el tables
18804 (table-p (org-table-align) t) ; align org-mode tables
18805 (t nil)))) ; call paragraph-fill
18807 ;; For reference, this is the default value of adaptive-fill-regexp
18810 (defun org-adaptive-fill-function ()
18811 "Return a fill prefix for org-mode files.
18812 In particular, this makes sure hanging paragraphs for hand-formatted lists
18813 work correctly."
18814 (cond
18815 ;; Comment line
18817 (match-string-no-properties 0))
18818 ;; Description list
18820 (save-excursion
18821 (if (> (match-end 1) (+ (match-beginning 1)
18822 org-description-max-indent))
18823 (goto-char (+ (match-beginning 1) 5))
18824 (goto-char (match-end 0)))
18825 (make-string (current-column) ?\ )))
18826 ;; Ordered or unordered list
18828 (save-excursion
18829 (goto-char (match-end 0))
18830 (make-string (current-column) ?\ )))
18831 ;; Other text
18832 ((looking-at org-adaptive-fill-regexp-backup)
18833 (match-string-no-properties 0))))
18835 ;;; Other stuff.
18837 (defun org-toggle-fixed-width-section (arg)
18838 "Toggle the fixed-width export.
18839 If there is no active region, the QUOTE keyword at the current headline is
18840 inserted or removed. When present, it causes the text between this headline
18841 and the next to be exported as fixed-width text, and unmodified.
18842 If there is an active region, this command adds or removes a colon as the
18843 first character of this line. If the first character of a line is a colon,
18844 this line is also exported in fixed-width font."
18845 (interactive "P")
18846 (let* ((cc 0)
18847 (regionp (org-region-active-p))
18848 (beg (if regionp (region-beginning) (point)))
18849 (end (if regionp (region-end)))
18850 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
18851 (case-fold-search nil)
18853 off)
18854 (if regionp
18855 (save-excursion
18856 (goto-char beg)
18857 (setq cc (current-column))
18858 (beginning-of-line 1)
18859 (setq off (looking-at re))
18860 (while (> nlines 0)
18861 (setq nlines (1- nlines))
18862 (beginning-of-line 1)
18863 (cond
18864 (arg
18865 (org-move-to-column cc t)
18867 (forward-line -1))
18868 ((and off (looking-at re))
18869 (replace-match "" t t nil 1))
18870 ((not off) (org-move-to-column cc t) (insert ": ")))
18871 (forward-line 1)))
18872 (save-excursion
18873 (org-back-to-heading)
18874 (if (looking-at (concat outline-regexp
18876 (replace-match "" t t nil 1)
18877 (if (looking-at outline-regexp)
18878 (progn
18879 (goto-char (match-end 0))
18880 (insert org-quote-string " "))))))))
18882 (defun org-reftex-citation ()
18883 "Use reftex-citation to insert a citation into the buffer.
18884 This looks for a line like
18886 #+BIBLIOGRAPHY: foo plain option:-d
18888 and derives from it that foo.bib is the bibliography file relevant
18889 for this document. It then installs the necessary environment for RefTeX
18890 to work in this buffer and calls `reftex-citation' to insert a citation
18891 into the buffer.
18893 Export of such citations to both LaTeX and HTML is handled by the contributed
18894 package org-exp-bibtex by Taru Karttunen."
18895 (interactive)
18896 (let ((reftex-docstruct-symbol 'rds)
18898 rds bib)
18899 (save-excursion
18900 (save-restriction
18901 (widen)
18902 (let ((case-fold-search t)
18904 (if (not (save-excursion
18905 (or (re-search-forward re nil t)
18906 (re-search-backward re nil t))))
18907 (error "No bibliography defined in file")
18908 (setq bib (concat (match-string 1) ".bib")
18909 rds (list (list 'bib bib)))))))
18910 (call-interactively 'reftex-citation)))
18912 ;;;; Functions extending outline functionality
18914 (defun org-beginning-of-line (&optional arg)
18915 "Go to the beginning of the current line. If that is invisible, continue
18916 to a visible line beginning. This makes the function of C-a more intuitive.
18917 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18918 first attempt, and only move to after the tags when the cursor is already
18919 beyond the end of the headline."
18920 (interactive "P")
18921 (let ((pos (point))
18922 (special (if (consp org-special-ctrl-a/e)
18923 (car org-special-ctrl-a/e)
18924 org-special-ctrl-a/e))
18925 refpos)
18926 (if (org-bound-and-true-p line-move-visual)
18927 (beginning-of-visual-line 1)
18928 (beginning-of-line 1))
18929 (if (and arg (fboundp 'move-beginning-of-line))
18930 (call-interactively 'move-beginning-of-line)
18931 (if (bobp)
18932 nil
18933 (backward-char 1)
18934 (if (org-truely-invisible-p)
18935 (while (and (not (bobp)) (org-truely-invisible-p))
18936 (backward-char 1)
18937 (beginning-of-line 1))
18938 (forward-char 1))))
18939 (when special
18940 (cond
18941 ((and (looking-at org-complex-heading-regexp)
18942 (= (char-after (match-end 1)) ?\ ))
18943 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
18944 (point-at-eol)))
18945 (goto-char
18946 (if (eq special t)
18947 (cond ((> pos refpos) refpos)
18948 ((= pos (point)) refpos)
18949 (t (point)))
18950 (cond ((> pos (point)) (point))
18951 ((not (eq last-command this-command)) (point))
18952 (t refpos)))))
18953 ((org-at-item-p)
18954 (goto-char
18955 (if (eq special t)
18956 (cond ((> pos (match-end 4)) (match-end 4))
18957 ((= pos (point)) (match-end 4))
18958 (t (point)))
18959 (cond ((> pos (point)) (point))
18960 ((not (eq last-command this-command)) (point))
18961 (t (match-end 4))))))))
18962 (org-no-warnings
18963 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18965 (defun org-end-of-line (&optional arg)
18966 "Go to the end of the line.
18967 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18968 first attempt, and only move to after the tags when the cursor is already
18969 beyond the end of the headline."
18970 (interactive "P")
18971 (let ((special (if (consp org-special-ctrl-a/e)
18972 (cdr org-special-ctrl-a/e)
18973 org-special-ctrl-a/e)))
18974 (if (or (not special)
18975 (not (org-on-heading-p))
18976 arg)
18977 (call-interactively
18978 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
18979 ((fboundp 'move-end-of-line) 'move-end-of-line)
18980 (t 'end-of-line)))
18981 (let ((pos (point)))
18982 (beginning-of-line 1)
18984 (if (eq special t)
18985 (if (or (< pos (match-beginning 1))
18986 (= pos (match-end 0)))
18987 (goto-char (match-beginning 1))
18988 (goto-char (match-end 0)))
18989 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
18990 (goto-char (match-end 0))
18991 (goto-char (match-beginning 1))))
18992 (call-interactively (if (fboundp 'move-end-of-line)
18993 'move-end-of-line
18994 'end-of-line)))))
18995 (org-no-warnings
18996 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18998 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
18999 (define-key org-mode-map "\C-e" 'org-end-of-line)
19000 (define-key org-mode-map [home] 'org-beginning-of-line)
19001 (define-key org-mode-map [end] 'org-end-of-line)
19003 (defun org-backward-sentence (&optional arg)
19004 "Go to beginning of sentence, or beginning of table field.
19005 This will call `backward-sentence' or `org-table-beginning-of-field',
19006 depending on context."
19007 (interactive "P")
19008 (cond
19009 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19010 (t (call-interactively 'backward-sentence))))
19012 (defun org-forward-sentence (&optional arg)
19013 "Go to end of sentence, or end of table field.
19014 This will call `forward-sentence' or `org-table-end-of-field',
19015 depending on context."
19016 (interactive "P")
19017 (cond
19018 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19019 (t (call-interactively 'forward-sentence))))
19021 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19022 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19024 (defun org-kill-line (&optional arg)
19025 "Kill line, to tags or end of line."
19026 (interactive "P")
19027 (cond
19028 ((or (not org-special-ctrl-k)
19029 (bolp)
19030 (not (org-on-heading-p)))
19031 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19032 org-ctrl-k-protect-subtree)
19033 (if (or (eq org-ctrl-k-protect-subtree 'error)
19034 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19035 (error "C-k aborted - would kill hidden subtree")))
19036 (call-interactively 'kill-line))
19038 (kill-region (point) (match-beginning 1))
19039 (org-set-tags nil t))
19040 (t (kill-region (point) (point-at-eol)))))
19042 (define-key org-mode-map "\C-k" 'org-kill-line)
19044 (defun org-yank (&optional arg)
19045 "Yank. If the kill is a subtree, treat it specially.
19046 This command will look at the current kill and check if is a single
19047 subtree, or a series of subtrees[1]. If it passes the test, and if the
19048 cursor is at the beginning of a line or after the stars of a currently
19049 empty headline, then the yank is handled specially. How exactly depends
19050 on the value of the following variables, both set by default.
19052 org-yank-folded-subtrees
19053 When set, the subtree(s) will be folded after insertion, but only
19054 if doing so would now swallow text after the yanked text.
19056 org-yank-adjusted-subtrees
19057 When set, the subtree will be promoted or demoted in order to
19058 fit into the local outline tree structure, which means that the level
19059 will be adjusted so that it becomes the smaller one of the two
19060 *visible* surrounding headings.
19062 Any prefix to this command will cause `yank' to be called directly with
19064 will just
19065 plainly yank the text as it is.
19067 \[1] The test checks if the first non-white line is a heading
19068 and if there are no other headings with fewer stars."
19069 (interactive "P")
19070 (org-yank-generic 'yank arg))
19072 (defun org-yank-generic (command arg)
19073 "Perform some yank-like command.
19075 This function implements the behavior described in the `org-yank'
19076 documentation. However, it has been generalized to work for any
19077 interactive command with similar behavior."
19079 ;; pretend to be command COMMAND
19080 (setq this-command command)
19082 (if arg
19083 (call-interactively command)
19085 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19086 (and (org-kill-is-subtree-p)
19087 (or (bolp)
19089 (string-match
19091 (buffer-substring (point-at-bol) (point)))))))
19092 swallowp)
19093 (cond
19094 ((and subtreep org-yank-folded-subtrees)
19095 (let ((beg (point))
19096 end)
19097 (if (and subtreep org-yank-adjusted-subtrees)
19098 (org-paste-subtree nil nil 'for-yank)
19099 (call-interactively command))
19101 (setq end (point))
19102 (goto-char beg)
19103 (when (and (bolp) subtreep
19104 (not (setq swallowp
19105 (org-yank-folding-would-swallow-text beg end))))
19106 (or (looking-at outline-regexp)
19107 (re-search-forward (concat "^" outline-regexp) end t))
19108 (while (and (< (point) end) (looking-at outline-regexp))
19109 (hide-subtree)
19110 (org-cycle-show-empty-lines 'folded)
19111 (condition-case nil
19112 (outline-forward-same-level 1)
19113 (error (goto-char end)))))
19114 (when swallowp
19115 (message
19116 "Inserted text not folded because that would swallow text"))
19118 (goto-char end)
19120 (beginning-of-line 1)
19121 (push-mark beg 'nomsg)))
19122 ((and subtreep org-yank-adjusted-subtrees)
19123 (let ((beg (point-at-bol)))
19124 (org-paste-subtree nil nil 'for-yank)
19125 (push-mark beg 'nomsg)))
19126 (t
19127 (call-interactively command))))))
19129 (defun org-yank-folding-would-swallow-text (beg end)
19130 "Would hide-subtree at BEG swallow any text after END?"
19131 (let (level)
19132 (save-excursion
19133 (goto-char beg)
19134 (when (or (looking-at outline-regexp)
19135 (re-search-forward (concat "^" outline-regexp) end t))
19136 (setq level (org-outline-level)))
19137 (goto-char end)
19139 (if (or (eobp)
19140 (and (bolp) (looking-at org-outline-regexp)
19141 (<= (org-outline-level) level)))
19142 nil ; Nothing would be swallowed
19143 t)))) ; something would swallow
19145 (define-key org-mode-map "\C-y" 'org-yank)
19147 (defun org-invisible-p ()
19148 "Check if point is at a character currently not visible."
19149 ;; Early versions of noutline don't have `outline-invisible-p'.
19150 (if (fboundp 'outline-invisible-p)
19151 (outline-invisible-p)
19152 (get-char-property (point) 'invisible)))
19154 (defun org-truely-invisible-p ()
19155 "Check if point is at a character currently not visible.
19156 This version does not only check the character property, but also
19157 `visible-mode'."
19158 ;; Early versions of noutline don't have `outline-invisible-p'.
19159 (if (org-bound-and-true-p visible-mode)
19160 nil
19161 (if (fboundp 'outline-invisible-p)
19162 (outline-invisible-p)
19163 (get-char-property (point) 'invisible))))
19165 (defun org-invisible-p2 ()
19166 "Check if point is at a character currently not visible."
19167 (save-excursion
19168 (if (and (eolp) (not (bobp))) (backward-char 1))
19169 ;; Early versions of noutline don't have `outline-invisible-p'.
19170 (if (fboundp 'outline-invisible-p)
19171 (outline-invisible-p)
19172 (get-char-property (point) 'invisible))))
19174 (defun org-back-to-heading (&optional invisible-ok)
19175 "Call `outline-back-to-heading', but provide a better error message."
19176 (condition-case nil
19177 (outline-back-to-heading invisible-ok)
19178 (error (error "Before first headline at position %d in buffer %s"
19179 (point) (current-buffer)))))
19181 (defun org-beginning-of-defun ()
19182 "Go to the beginning of the subtree, i.e. back to the heading."
19183 (org-back-to-heading))
19184 (defun org-end-of-defun ()
19185 "Go to the end of the subtree."
19186 (org-end-of-subtree nil t))
19188 (defun org-before-first-heading-p ()
19189 "Before first heading?"
19190 (save-excursion
19193 (defun org-on-heading-p (&optional ignored)
19194 (outline-on-heading-p t))
19195 (defun org-at-heading-p (&optional ignored)
19196 (outline-on-heading-p t))
19198 (defun org-point-at-end-of-empty-headline ()
19199 "If point is at the end of an empty headline, return t, else nil.
19200 If the heading only contains a TODO keyword, it is still still considered
19201 empty."
19203 (save-excursion
19204 (beginning-of-line 1)
19207 (defun org-at-heading-or-item-p ()
19208 (or (org-on-heading-p) (org-at-item-p)))
19210 (defun org-on-target-p ()
19211 (or (org-in-regexp org-radio-target-regexp)
19212 (org-in-regexp org-target-regexp)))
19214 (defun org-up-heading-all (arg)
19215 "Move to the heading line of which the present line is a subheading.
19216 This function considers both visible and invisible heading lines.
19217 With argument, move up ARG levels."
19218 (if (fboundp 'outline-up-heading-all)
19219 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19220 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19222 (defun org-up-heading-safe ()
19223 "Move to the heading line of which the present line is a subheading.
19224 This version will not throw an error. It will return the level of the
19225 headline found, or nil if no higher level is found.
19227 Also, this function will be a lot faster than `outline-up-heading',
19228 because it relies on stars being the outline starters. This can really
19229 make a significant difference in outlines with very many siblings."
19230 (let (start-level re)
19231 (org-back-to-heading t)
19232 (setq start-level (funcall outline-level))
19233 (if (equal start-level 1)
19234 nil
19236 (if (re-search-backward re nil t)
19237 (funcall outline-level)))))
19239 (defun org-first-sibling-p ()
19240 "Is this heading the first child of its parents?"
19241 (interactive)
19242 (let ((re (concat "^" outline-regexp))
19243 level l)
19244 (unless (org-at-heading-p t)
19245 (error "Not at a heading"))
19246 (setq level (funcall outline-level))
19247 (save-excursion
19248 (if (not (re-search-backward re nil t))
19249 t
19250 (setq l (funcall outline-level))
19251 (< l level)))))
19253 (defun org-goto-sibling (&optional previous)
19254 "Goto the next sibling, even if it is invisible.
19255 When PREVIOUS is set, go to the previous sibling instead. Returns t
19256 when a sibling was found. When none is found, return nil and don't
19257 move point."
19258 (let ((fun (if previous 're-search-backward 're-search-forward))
19259 (pos (point))
19260 (re (concat "^" outline-regexp))
19261 level l)
19262 (when (condition-case nil (org-back-to-heading t) (error nil))
19263 (setq level (funcall outline-level))
19264 (catch 'exit
19265 (or previous (forward-char 1))
19266 (while (funcall fun re nil t)
19267 (setq l (funcall outline-level))
19268 (when (< l level) (goto-char pos) (throw 'exit nil))
19269 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
19270 (goto-char pos)
19271 nil))))
19273 (defun org-show-siblings ()
19274 "Show all siblings of the current headline."
19275 (save-excursion
19276 (while (org-goto-sibling) (org-flag-heading nil)))
19277 (save-excursion
19278 (while (org-goto-sibling 'previous)
19279 (org-flag-heading nil))))
19281 (defun org-goto-first-child ()
19282 "Goto the first child, even if it is invisible.
19283 Return t when a child was found. Otherwise don't move point and
19284 return nil."
19285 (let (level (pos (point)) (re (concat "^" outline-regexp)))
19286 (when (condition-case nil (org-back-to-heading t) (error nil))
19287 (setq level (outline-level))
19288 (forward-char 1)
19289 (if (and (re-search-forward re nil t) (> (outline-level) level))
19290 (progn (goto-char (match-beginning 0)) t)
19291 (goto-char pos) nil))))
19293 (defun org-show-hidden-entry ()
19294 "Show an entry where even the heading is hidden."
19295 (save-excursion
19296 (org-show-entry)))
19298 (defun org-flag-heading (flag &optional entry)
19299 "Flag the current heading. FLAG non-nil means make invisible.
19300 When ENTRY is non-nil, show the entire entry."
19301 (save-excursion
19302 (org-back-to-heading t)
19303 ;; Check if we should show the entire entry
19304 (if entry
19305 (progn
19306 (org-show-entry)
19307 (save-excursion
19308 (and (outline-next-heading)
19309 (org-flag-heading nil))))
19310 (outline-flag-region (max (point-min) (1- (point)))
19311 (save-excursion (outline-end-of-heading) (point))
19312 flag))))
19314 (defun org-get-next-sibling ()
19315 "Move to next heading of the same level, and return point.
19316 If there is no such heading, return nil.
19317 This is like outline-next-sibling, but invisible headings are ok."
19318 (let ((level (funcall outline-level)))
19319 (outline-next-heading)
19320 (while (and (not (eobp)) (> (funcall outline-level) level))
19321 (outline-next-heading))
19322 (if (or (eobp) (< (funcall outline-level) level))
19323 nil
19324 (point))))
19326 (defun org-get-last-sibling ()
19327 "Move to previous heading of the same level, and return point.
19328 If there is no such heading, return nil."
19329 (let ((opoint (point))
19330 (level (funcall outline-level)))
19331 (outline-previous-heading)
19332 (when (and (/= (point) opoint) (outline-on-heading-p t))
19333 (while (and (> (funcall outline-level) level)
19334 (not (bobp)))
19335 (outline-previous-heading))
19336 (if (< (funcall outline-level) level)
19337 nil
19338 (point)))))
19340 (defun org-end-of-subtree (&optional invisible-OK to-heading)
19341 ;; This contains an exact copy of the original function, but it uses
19342 ;; `org-back-to-heading', to make it work also in invisible
19343 ;; trees. And is uses an invisible-OK argument.
19344 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
19345 ;; Furthermore, when used inside Org, finding the end of a large subtree
19346 ;; with many children and grandchildren etc, this can be much faster
19347 ;; than the outline version.
19348 (org-back-to-heading invisible-OK)
19349 (let ((first t)
19350 (level (funcall outline-level)))
19351 (if (and (org-mode-p) (< level 1000))
19352 ;; A true heading (not a plain list item), in Org-mode
19353 ;; This means we can easily find the end by looking
19354 ;; only for the right number of stars. Using a regexp to do
19355 ;; this is so much faster than using a Lisp loop.
19357 (forward-char 1)
19358 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
19359 ;; something else, do it the slow way
19360 (while (and (not (eobp))
19361 (or first (> (funcall outline-level) level)))
19362 (setq first nil)
19363 (outline-next-heading)))
19364 (unless to-heading
19366 (progn
19367 ;; Go to end of line before heading
19368 (forward-char -1)
19370 ;; leave blank line before heading
19371 (forward-char -1))))))
19372 (point))
19374 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
19375 "Use Org version in org-mode, for dramatic speed-up."
19376 (if (eq major-mode 'org-mode)
19377 (progn
19378 (org-end-of-subtree nil t)
19379 (unless (eobp) (backward-char 1)))
19380 ad-do-it))
19382 (defun org-forward-same-level (arg &optional invisible-ok)
19383 "Move forward to the arg'th subheading at same level as this one.
19384 Stop at the first and last subheadings of a superior heading.
19385 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
19386 it wil also look at invisible ones."
19387 (interactive "p")
19388 (org-back-to-heading invisible-ok)
19389 (org-on-heading-p)
19390 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19392 l)
19393 (forward-char 1)
19394 (while (> arg 0)
19395 (while (and (re-search-forward re nil 'move)
19396 (setq l (- (match-end 0) (match-beginning 0) 1))
19397 (= l level)
19398 (not invisible-ok)
19399 (progn (backward-char 1) (org-invisible-p)))
19400 (if (< l level) (setq arg 1)))
19401 (setq arg (1- arg)))
19402 (beginning-of-line 1)))
19404 (defun org-backward-same-level (arg &optional invisible-ok)
19405 "Move backward to the arg'th subheading at same level as this one.
19406 Stop at the first and last subheadings of a superior heading."
19407 (interactive "p")
19408 (org-back-to-heading)
19409 (org-on-heading-p)
19410 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19412 l)
19413 (while (> arg 0)
19414 (while (and (re-search-backward re nil 'move)
19415 (setq l (- (match-end 0) (match-beginning 0) 1))
19416 (= l level)
19417 (not invisible-ok)
19418 (org-invisible-p))
19419 (if (< l level) (setq arg 1)))
19420 (setq arg (1- arg)))))
19422 (defun org-show-subtree ()
19423 "Show everything after this heading at deeper levels."
19424 (outline-flag-region
19425 (point)
19426 (save-excursion
19427 (org-end-of-subtree t t))
19428 nil))
19430 (defun org-show-entry ()
19431 "Show the body directly following this heading.
19432 Show the heading too, if it is currently invisible."
19433 (interactive)
19434 (save-excursion
19435 (condition-case nil
19436 (progn
19437 (org-back-to-heading t)
19438 (outline-flag-region
19439 (max (point-min) (1- (point)))
19440 (save-excursion
19441 (if (re-search-forward
19443 (match-beginning 1)
19444 (point-max)))
19445 nil)
19446 (org-cycle-hide-drawers 'children))
19447 (error nil))))
19449 (defun org-make-options-regexp (kwds &optional extra)
19450 "Make a regular expression for keyword lines."
19451 (concat
19452 "^"
19459 ;; Make isearch reveal the necessary context
19460 (defun org-isearch-end ()
19461 "Reveal context after isearch exits."
19462 (when isearch-success ; only if search was successful
19463 (if (featurep 'xemacs)
19464 ;; Under XEmacs, the hook is run in the correct place,
19465 ;; we directly show the context.
19466 (org-show-context 'isearch)
19467 ;; In Emacs the hook runs *before* restoring the overlays.
19468 ;; So we have to use a one-time post-command-hook to do this.
19469 ;; (Emacs 22 has a special variable, see function `org-mode')
19470 (unless (and (boundp 'isearch-mode-end-hook-quit)
19471 isearch-mode-end-hook-quit)
19472 ;; Only when the isearch was not quitted.
19473 (org-add-hook 'post-command-hook 'org-isearch-post-command
19474 'append 'local)))))
19476 (defun org-isearch-post-command ()
19477 "Remove self from hook, and show context."
19478 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
19479 (org-show-context 'isearch))
19482 ;;;; Integration with and fixes for other packages
19484 ;;; Imenu support
19486 (defvar org-imenu-markers nil
19487 "All markers currently used by Imenu.")
19488 (make-variable-buffer-local 'org-imenu-markers)
19490 (defun org-imenu-new-marker (&optional pos)
19491 "Return a new marker for use by Imenu, and remember the marker."
19492 (let ((m (make-marker)))
19493 (move-marker m (or pos (point)))
19494 (push m org-imenu-markers)
19495 m))
19497 (defun org-imenu-get-tree ()
19498 "Produce the index for Imenu."
19499 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
19500 (setq org-imenu-markers nil)
19501 (let* ((n org-imenu-depth)
19502 (re (concat "^" outline-regexp))
19503 (subs (make-vector (1+ n) nil))
19504 (last-level 0)
19505 m level head)
19506 (save-excursion
19507 (save-restriction
19508 (widen)
19509 (goto-char (point-max))
19510 (while (re-search-backward re nil t)
19511 (setq level (org-reduced-level (funcall outline-level)))
19512 (when (<= level n)
19513 (looking-at org-complex-heading-regexp)
19514 (setq head (org-link-display-format
19515 (org-match-string-no-properties 4))
19516 m (org-imenu-new-marker))
19517 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
19518 (if (>= level last-level)
19519 (push (cons head m) (aref subs level))
19520 (push (cons head (aref subs (1+ level))) (aref subs level))
19521 (loop for i from (1+ level) to n do (aset subs i nil)))
19522 (setq last-level level)))))
19523 (aref subs 1)))
19525 (eval-after-load "imenu"
19526 '(progn
19527 (add-hook 'imenu-after-jump-hook
19528 (lambda ()
19529 (if (eq major-mode 'org-mode)
19530 (org-show-context 'org-goto))))))
19532 (defun org-link-display-format (link)
19533 "Replace a link with either the description, or the link target
19534 if no description is present"
19535 (save-match-data
19536 (if (string-match org-bracket-link-analytic-regexp link)
19537 (replace-match (if (match-end 5)
19538 (match-string 5 link)
19539 (concat (match-string 1 link)
19540 (match-string 3 link)))
19541 nil t link)
19542 link)))
19544 ;; Speedbar support
19546 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
19547 "Overlay marking the agenda restriction line in speedbar.")
19548 (overlay-put org-speedbar-restriction-lock-overlay
19549 'face 'org-agenda-restriction-lock)
19550 (overlay-put org-speedbar-restriction-lock-overlay
19551 'help-echo "Agendas are currently limited to this item.")
19552 (org-detach-overlay org-speedbar-restriction-lock-overlay)
19554 (defun org-speedbar-set-agenda-restriction ()
19555 "Restrict future agenda commands to the location at point in speedbar.
19557 (interactive)
19558 (require 'org-agenda)
19559 (let (p m tp np dir txt)
19560 (cond
19561 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19562 'org-imenu t))
19563 (setq m (get-text-property p 'org-imenu-marker))
19564 (with-current-buffer (marker-buffer m)
19565 (goto-char m)
19566 (org-agenda-set-restriction-lock 'subtree)))
19567 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19568 'speedbar-function 'speedbar-find-file))
19569 (setq tp (previous-single-property-change
19570 (1+ p) 'speedbar-function)
19571 np (next-single-property-change
19572 tp 'speedbar-function)
19573 dir (speedbar-line-directory)
19574 txt (buffer-substring-no-properties (or tp (point-min))
19575 (or np (point-max))))
19576 (with-current-buffer (find-file-noselect
19577 (let ((default-directory dir))
19578 (expand-file-name txt)))
19579 (unless (org-mode-p)
19580 (error "Cannot restrict to non-Org-mode file"))
19581 (org-agenda-set-restriction-lock 'file)))
19582 (t (error "Don't know how to restrict Org-mode's agenda")))
19583 (move-overlay org-speedbar-restriction-lock-overlay
19584 (point-at-bol) (point-at-eol))
19585 (setq current-prefix-arg nil)
19586 (org-agenda-maybe-redo)))
19588 (eval-after-load "speedbar"
19589 '(progn
19590 (speedbar-add-supported-extension ".org")
19591 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
19592 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
19593 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
19594 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19595 (add-hook 'speedbar-visiting-tag-hook
19596 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
19598 ;;; Fixes and Hacks for problems with other packages
19600 ;; Make flyspell not check words in links, to not mess up our keymap
19601 (defun org-mode-flyspell-verify ()
19602 "Don't let flyspell put overlays at active buttons."
19603 (and (not (get-text-property (max (1- (point)) (point-min)) 'keymap))
19604 (not (get-text-property (max (1- (point)) (point-min)) 'org-no-flyspell))))
19606 (defun org-remove-flyspell-overlays-in (beg end)
19607 "Remove flyspell overlays in region."
19608 (and (org-bound-and-true-p flyspell-mode)
19609 (fboundp 'flyspell-delete-region-overlays)
19610 (flyspell-delete-region-overlays beg end))
19611 (add-text-properties beg end '(org-no-flyspell t)))
19613 ;; Make `bookmark-jump' shows the jump location if it was hidden.
19614 (eval-after-load "bookmark"
19615 '(if (boundp 'bookmark-after-jump-hook)
19616 ;; We can use the hook
19617 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
19618 ;; Hook not available, use advice
19619 (defadvice bookmark-jump (after org-make-visible activate)
19620 "Make the position visible."
19621 (org-bookmark-jump-unhide))))
19623 ;; Make sure saveplace shows the location if it was hidden
19624 (eval-after-load "saveplace"
19625 '(defadvice save-place-find-file-hook (after org-make-visible activate)
19626 "Make the position visible."
19627 (org-bookmark-jump-unhide)))
19629 ;; Make sure ecb shows the location if it was hidden
19630 (eval-after-load "ecb"
19631 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
19632 "Make hierarchy visible when jumping into location from ECB tree buffer."
19633 (if (eq major-mode 'org-mode)
19634 (org-show-context))))
19636 (defun org-bookmark-jump-unhide ()
19637 "Unhide the current position, to show the bookmark location."
19638 (and (org-mode-p)
19639 (or (org-invisible-p)
19640 (save-excursion (goto-char (max (point-min) (1- (point))))
19641 (org-invisible-p)))
19642 (org-show-context 'bookmark-jump)))
19644 ;; Make session.el ignore our circular variable
19645 (eval-after-load "session"
19646 '(add-to-list 'session-globals-exclude 'org-mark-ring))
19648 ;;;; Experimental code
19650 (defun org-closed-in-range ()
19651 "Sparse tree of items closed in a certain time range.
19652 Still experimental, may disappear in the future."
19653 (interactive)
19654 ;; Get the time interval from the user.
19655 (let* ((time1 (org-float-time
19656 (org-read-date nil 'to-time nil "Starting date: ")))
19657 (time2 (org-float-time
19658 (org-read-date nil 'to-time nil "End date:")))
19659 ;; callback function
19660 (callback (lambda ()
19661 (let ((time
19662 (org-float-time
19663 (apply 'encode-time
19664 (org-parse-time-string
19665 (match-string 1))))))
19666 ;; check if time in interval
19667 (and (>= time time1) (<= time time2))))))
19668 ;; make tree, check each match with the callback
19671 ;;;; Finish up
19673 (provide 'org)
19675 (run-hooks 'org-load-hook)
19677 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
19679 ;;; org.el ends here