| blob | c4c64ee5d70e5b6e3ae392d5ad5596cc0ee6b91c |
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 (C-u TAB, same as S-TAB) also when called without prefix arg.
5777 But only if also the variable `org-cycle-global-at-bob' is t."
5787 org-inlinetask-min-level
5792 limit-level)))
5808 org-cycle-hook))
5812 ;; special case: use global cycling
5827 ;; Enter the table or move to the next field in the table
5844 ;; Toggle block visibility
5849 ;; Show-subtree, ARG levels up from here.
5861 ;; TAB emulation and template completion
5885 t
5894 "Do the global cycling action."
5898 ;; We just created the overview - now do table of contents
5899 ;; This can be slow in very large buffers, so indicate action
5909 ;; We just showed the table of contents - now show everything
5917 ;; Default action: go to overview
5925 "Do the local cycling action."
5927 ;; First, some boundaries
5934 ; XEmacs does not have `next-single-char-property-change'
5935 ; I'm not sure about Emacs 21.
5949 ;; if we're in a list, org-end-of-subtree is in fact org-end-of-item.
5958 ;; Find out what to do next and set `this-command'
5961 ;; Nothing is hidden behind this heading
5973 org-cycle-skip-children-state-if-no-children))))
5974 ;; Entire subtree is hidden in one line: children view
5988 ;; We just showed the children, or no children are there,
5989 ;; now show everything.
5996 ;; Default action: hide the subtree.
6003 ;;;###autoload
6005 "Cycle the global visibility. For details see `org-cycle'.
6007 With a numeric prefix, show all headlines up to that level."
6023 "Set the visibility required by startup options and properties."
6038 "Switch subtree visibilities according to :VISIBILITY: property."
6045 nil t)
6070 "Switch to overview mode, showing only top-level headlines.
6071 Really, this shows all headlines with level equal or greater than the level
6072 of the first headline in the buffer. This is important, because if the
6073 first headline is not level one, then (hide-sublevels 1) gives confusing
6074 results."
6085 "Show all headlines in the buffer, like a table of contents.
6086 With numerical argument N, show content up to level N."
6089 ;; Visit all headings and show their offspring
6096 t)
6105 "Adjust the window after a change in outline visibility.
6106 This function is the default value of the hook `org-cycle-hook'."
6116 "Remove outline overlays that do not contain non-white stuff."
6126 "Fix visibility issues after moving a subtree."
6127 ;; First, find a reasonable region to look at:
6128 ;; Start two siblings above, end three below
6146 ;; Properly fold already folded siblings
6157 "Show empty lines above all visible headlines.
6158 The region to be covered depends on STATE when called through
6159 `org-cycle-hook'. Lisp program can use t for STATE to get the
6160 entire buffer covered. Note that an empty line is only shown if there
6161 are at least `org-cycle-separator-lines' empty lines before the headline."
6171 beg end b e)
6195 ;; Never hide empty lines at the end of the file.
6205 "Move to the parent and re-show empty lines before visible headlines."
6211 "Return `org-agenda-files' list, plus all open org-mode files.
6212 This is useful for operations that need to scan all of a user's
6213 open and agenda-wise Org files."
6221 files))
6224 "Return the beginning position of the current entry."
6228 "Return the end position of the current entry."
6232 "Re-hide all drawers after a visibility state change."
6259 "Is the end of the current subtree visible?"
6264 "Move cursor to the first headline and recenter the headline.
6265 Optional argument N means put the headline into the Nth line of the window."
6271 ;;; Saving and restoring visibility
6274 "Return a list of the locations of all outline overlays.
6275 These are overlays with the `invisible' property value `outline'.
6276 The return value is a list of cons cells, with start and stop
6277 positions for each overlay.
6278 If USE-MARKERS is set, return the positions as markers."
6296 "Create visibility overlays for all positions in DATA.
6297 DATA should have been made by `org-outline-overlay-data'."
6306 data)))))
6308 ;;; Folding of blocks
6320 "Call FUNCTION at the head of all source blocks in the current buffer.
6321 Optional arguments START and END can be used to limit the range."
6333 "Toggle the visibility of all blocks in the current buffer."
6337 "Fold all blocks in the current buffer."
6343 "Unfold all blocks in the current buffer."
6349 "Toggle visibility of block at point."
6360 "Toggle the visibility of the current block."
6367 ov)
6383 ;; make the block accessible to isearch
6385 ov 'isearch-open-invisible
6396 ;; org-tab-after-check-for-cycling-hook
6398 ;; Remove overlays when changing major mode
6403 ;;; Org-goto
6409 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6425 nil)
6426 (org-defkey map "q" 'org-goto-quit)
6427 (org-defkey map "n" 'outline-next-visible-heading)
6428 (org-defkey map "p" 'outline-previous-visible-heading)
6429 (org-defkey map "f" 'outline-forward-same-level)
6430 (org-defkey map "b" 'outline-backward-same-level)
6431 (org-defkey map "u" 'outline-up-heading))
6432 (org-defkey map "/" 'org-occur)
6433 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6434 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6435 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6436 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6437 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6438 map))
6440 (defconst org-goto-help
6441 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6442 RET=jump to location [Q]uit and return to previous location
6443 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6445 (defvar org-goto-start-pos) ; dynamically scoped parameter
6447 ;; FIXME: Docstring does not mention both interfaces
6448 (defun org-goto (&optional alternative-interface)
6449 "Look up a different location in the current file, keeping current visibility.
6451 When you want look-up or go to a different location in a document, the
6452 fastest way is often to fold the entire buffer and then dive into the tree.
6453 This method has the disadvantage, that the previous location will be folded,
6454 which may not be what you want.
6456 This command works around this by showing a copy of the current buffer
6457 in an indirect buffer, in overview mode. You can dive into the tree in
6458 that copy, use org-occur and incremental search to find a location.
6459 When pressing RET or `Q', the command returns to the original buffer in
6460 which the visibility is still unchanged. After RET is will also jump to
6461 the location selected in the indirect buffer and expose the
6462 the headline hierarchy above."
6463 (interactive "P")
6464 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6465 (org-refile-use-outline-path t)
6466 (org-refile-target-verify-function nil)
6467 (interface
6468 (if (not alternative-interface)
6469 org-goto-interface
6470 (if (eq org-goto-interface 'outline)
6471 'outline-path-completion
6472 'outline)))
6473 (org-goto-start-pos (point))
6474 (selected-point
6475 (if (eq interface 'outline)
6476 (car (org-get-location (current-buffer) org-goto-help))
6477 (let ((pa (org-refile-get-location "Goto: ")))
6478 (org-refile-check-position pa)
6479 (nth 3 pa)))))
6480 (if selected-point
6481 (progn
6482 (org-mark-ring-push org-goto-start-pos)
6483 (goto-char selected-point)
6484 (if (or (org-invisible-p) (org-invisible-p2))
6485 (org-show-context 'org-goto)))
6486 (message "Quit"))))
6488 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6489 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6490 (defvar org-goto-local-auto-isearch-map) ; defined below
6492 (defun org-get-location (buf help)
6493 "Let the user select a location in the Org-mode buffer BUF.
6494 This function uses a recursive edit. It returns the selected position
6495 or nil."
6496 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6497 (isearch-hide-immediately nil)
6498 (isearch-search-fun-function
6499 (lambda () 'org-goto-local-search-headings))
6500 (org-goto-selected-point org-goto-exit-command)
6501 (pop-up-frames nil)
6502 (special-display-buffer-names nil)
6503 (special-display-regexps nil)
6504 (special-display-function nil))
6505 (save-excursion
6506 (save-window-excursion
6507 (delete-other-windows)
6508 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6509 (switch-to-buffer
6510 (condition-case nil
6511 (make-indirect-buffer (current-buffer) "*org-goto*")
6512 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6513 (with-output-to-temp-buffer "*Help*"
6514 (princ help))
6515 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6516 (setq buffer-read-only nil)
6517 (let ((org-startup-truncated t)
6518 (org-startup-folded nil)
6519 (org-startup-align-all-tables nil))
6520 (org-mode)
6521 (org-overview))
6522 (setq buffer-read-only t)
6523 (if (and (boundp 'org-goto-start-pos)
6524 (integer-or-marker-p org-goto-start-pos))
6525 (let ((org-show-hierarchy-above t)
6526 (org-show-siblings t)
6527 (org-show-following-heading t))
6528 (goto-char org-goto-start-pos)
6529 (and (org-invisible-p) (org-show-context)))
6530 (goto-char (point-min)))
6531 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6532 (message "Select location and press RET")
6533 (use-local-map org-goto-map)
6534 (recursive-edit)
6535 ))
6536 (kill-buffer "*org-goto*")
6537 (cons org-goto-selected-point org-goto-exit-command)))
6539 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6540 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6541 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6542 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6544 (defun org-goto-local-search-headings (string bound noerror)
6545 "Search and make sure that any matches are in headlines."
6546 (catch 'return
6547 (while (if isearch-forward
6548 (search-forward string bound noerror)
6549 (search-backward string bound noerror))
6550 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6551 (and (member :headline context)
6552 (not (member :tags context))))
6553 (throw 'return (point))))))
6555 (defun org-goto-local-auto-isearch ()
6556 "Start isearch."
6557 (interactive)
6558 (goto-char (point-min))
6559 (let ((keys (this-command-keys)))
6560 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6561 (isearch-mode t)
6562 (isearch-process-search-char (string-to-char keys)))))
6564 (defun org-goto-ret (&optional arg)
6565 "Finish `org-goto' by going to the new location."
6566 (interactive "P")
6567 (setq org-goto-selected-point (point)
6568 org-goto-exit-command 'return)
6569 (throw 'exit nil))
6571 (defun org-goto-left ()
6572 "Finish `org-goto' by going to the new location."
6573 (interactive)
6574 (if (org-on-heading-p)
6575 (progn
6576 (beginning-of-line 1)
6577 (setq org-goto-selected-point (point)
6578 org-goto-exit-command 'left)
6579 (throw 'exit nil))
6580 (error "Not on a heading")))
6582 (defun org-goto-right ()
6583 "Finish `org-goto' by going to the new location."
6584 (interactive)
6585 (if (org-on-heading-p)
6586 (progn
6587 (setq org-goto-selected-point (point)
6588 org-goto-exit-command 'right)
6589 (throw 'exit nil))
6590 (error "Not on a heading")))
6592 (defun org-goto-quit ()
6593 "Finish `org-goto' without cursor motion."
6594 (interactive)
6595 (setq org-goto-selected-point nil)
6596 (setq org-goto-exit-command 'quit)
6597 (throw 'exit nil))
6599 ;;; Indirect buffer display of subtrees
6601 (defvar org-indirect-dedicated-frame nil
6602 "This is the frame being used for indirect tree display.")
6603 (defvar org-last-indirect-buffer nil)
6605 (defun org-tree-to-indirect-buffer (&optional arg)
6606 "Create indirect buffer and narrow it to current subtree.
6607 With numerical prefix ARG, go up to this level and then take that tree.
6608 If ARG is negative, go up that many levels.
6609 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6610 indirect buffer previously made with this command, to avoid proliferation of
6611 indirect buffers. However, when you call the command with a \
6613 when `org-indirect-buffer-display' is `new-frame', the last buffer
6614 is kept so that you can work with several indirect buffers at the same time.
6615 If `org-indirect-buffer-display' is `dedicated-frame', the \
6617 requests that a new frame be made for the new buffer, so that the dedicated
6618 frame is not changed."
6619 (interactive "P")
6620 (let ((cbuf (current-buffer))
6621 (cwin (selected-window))
6622 (pos (point))
6623 beg end level heading ibuf)
6624 (save-excursion
6625 (org-back-to-heading t)
6626 (when (numberp arg)
6627 (setq level (org-outline-level))
6628 (if (< arg 0) (setq arg (+ level arg)))
6629 (while (> (setq level (org-outline-level)) arg)
6630 (outline-up-heading 1 t)))
6631 (setq beg (point)
6632 heading (org-get-heading))
6633 (org-end-of-subtree t t)
6634 (if (org-on-heading-p) (backward-char 1))
6635 (setq end (point)))
6636 (if (and (buffer-live-p org-last-indirect-buffer)
6637 (not (eq org-indirect-buffer-display 'new-frame))
6638 (not arg))
6639 (kill-buffer org-last-indirect-buffer))
6640 (setq ibuf (org-get-indirect-buffer cbuf)
6641 org-last-indirect-buffer ibuf)
6642 (cond
6643 ((or (eq org-indirect-buffer-display 'new-frame)
6644 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6645 (select-frame (make-frame))
6646 (delete-other-windows)
6647 (switch-to-buffer ibuf)
6648 (org-set-frame-title heading))
6649 ((eq org-indirect-buffer-display 'dedicated-frame)
6650 (raise-frame
6651 (select-frame (or (and org-indirect-dedicated-frame
6652 (frame-live-p org-indirect-dedicated-frame)
6653 org-indirect-dedicated-frame)
6654 (setq org-indirect-dedicated-frame (make-frame)))))
6655 (delete-other-windows)
6656 (switch-to-buffer ibuf)
6657 (org-set-frame-title (concat "Indirect: " heading)))
6658 ((eq org-indirect-buffer-display 'current-window)
6659 (switch-to-buffer ibuf))
6660 ((eq org-indirect-buffer-display 'other-window)
6661 (pop-to-buffer ibuf))
6662 (t (error "Invalid value")))
6663 (if (featurep 'xemacs)
6664 (save-excursion (org-mode) (turn-on-font-lock)))
6665 (narrow-to-region beg end)
6666 (show-all)
6667 (goto-char pos)
6668 (and (window-live-p cwin) (select-window cwin))))
6670 (defun org-get-indirect-buffer (&optional buffer)
6671 (setq buffer (or buffer (current-buffer)))
6672 (let ((n 1) (base (buffer-name buffer)) bname)
6673 (while (buffer-live-p
6674 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6675 (setq n (1+ n)))
6676 (condition-case nil
6677 (make-indirect-buffer buffer bname 'clone)
6678 (error (make-indirect-buffer buffer bname)))))
6680 (defun org-set-frame-title (title)
6681 "Set the title of the current frame to the string TITLE."
6682 ;; FIXME: how to name a single frame in XEmacs???
6683 (unless (featurep 'xemacs)
6684 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6686 ;;;; Structure editing
6688 ;;; Inserting headlines
6690 (defun org-previous-line-empty-p ()
6691 (save-excursion
6692 (and (not (bobp))
6693 (or (beginning-of-line 0) t)
6694 (save-match-data
6697 (defun org-insert-heading (&optional force-heading invisible-ok)
6698 "Insert a new heading or item with same depth at point.
6699 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6700 If point is at the beginning of a headline, insert a sibling before the
6701 current headline. If point is not at the beginning, split the line,
6702 create the new headline with the text in the current line after point
6703 \(but see also the variable `org-M-RET-may-split-line').
6705 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6706 This is important for non-interactive uses of the command."
6707 (interactive "P")
6708 (if (or (= (buffer-size) 0)
6709 (and (not (save-excursion
6710 (and (ignore-errors (org-back-to-heading invisible-ok))
6711 (org-on-heading-p))))
6712 (not (org-in-item-p))))
6713 (progn
6715 (run-hooks 'org-insert-heading-hook))
6716 (when (or force-heading (not (org-insert-item)))
6717 (let* ((empty-line-p nil)
6718 (level nil)
6719 (on-heading (org-on-heading-p))
6720 (head (save-excursion
6721 (condition-case nil
6722 (progn
6723 (org-back-to-heading invisible-ok)
6724 (when (and (not on-heading)
6725 (featurep 'org-inlinetask)
6726 (integerp org-inlinetask-min-level)
6727 (>= (length (match-string 0))
6728 org-inlinetask-min-level))
6729 ;; Find a heading level before the inline task
6730 (while (and (setq level (org-up-heading-safe))
6731 (>= level org-inlinetask-min-level)))
6732 (if (org-on-heading-p)
6733 (org-back-to-heading invisible-ok)
6734 (error "This should not happen")))
6735 (setq empty-line-p (org-previous-line-empty-p))
6736 (match-string 0))
6737 (error "*"))))
6738 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6739 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6740 pos hide-previous previous-pos)
6741 (cond
6742 ((and (org-on-heading-p) (bolp)
6743 (or (bobp)
6744 (save-excursion (backward-char 1) (not (org-invisible-p)))))
6745 ;; insert before the current line
6746 (open-line (if blank 2 1)))
6747 ((and (bolp)
6748 (not org-insert-heading-respect-content)
6749 (or (bobp)
6750 (save-excursion
6751 (backward-char 1) (not (org-invisible-p)))))
6752 ;; insert right here
6753 nil)
6754 (t
6755 ;; somewhere in the line
6756 (save-excursion
6757 (setq previous-pos (point-at-bol))
6758 (end-of-line)
6759 (setq hide-previous (org-invisible-p)))
6760 (and org-insert-heading-respect-content (org-show-subtree))
6761 (let ((split
6762 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6763 (save-excursion
6764 (let ((p (point)))
6765 (goto-char (point-at-bol))
6766 (and (looking-at org-complex-heading-regexp)
6767 (> p (match-beginning 4)))))))
6768 tags pos)
6769 (cond
6770 (org-insert-heading-respect-content
6771 (org-end-of-subtree nil t)
6772 (when (featurep 'org-inlinetask)
6773 (while (and (not (eobp))
6775 (>= (length (match-string 1))
6776 org-inlinetask-min-level))
6777 (org-end-of-subtree nil t)))
6778 (or (bolp) (newline))
6779 (or (org-previous-line-empty-p)
6780 (and blank (newline)))
6781 (open-line 1))
6782 ((org-on-heading-p)
6783 (when hide-previous
6784 (show-children)
6785 (org-show-entry))
6787 (setq tags (and (match-end 2) (match-string 2)))
6788 (and (match-end 1)
6789 (delete-region (match-beginning 1) (match-end 1)))
6790 (setq pos (point-at-bol))
6791 (or split (end-of-line 1))
6792 (delete-horizontal-space)
6794 (buffer-substring (point-at-bol) (point)))
6795 (insert " "))
6796 (newline (if blank 2 1))
6797 (when tags
6798 (save-excursion
6799 (goto-char pos)
6800 (end-of-line 1)
6801 (insert " " tags)
6802 (org-set-tags nil 'align))))
6803 (t
6804 (or split (end-of-line 1))
6805 (newline (if blank 2 1)))))))
6806 (insert head) (just-one-space)
6807 (setq pos (point))
6808 (end-of-line 1)
6809 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6810 (when (and org-insert-heading-respect-content hide-previous)
6811 (save-excursion
6812 (goto-char previous-pos)
6813 (hide-subtree)))
6814 (run-hooks 'org-insert-heading-hook)))))
6816 (defun org-get-heading (&optional no-tags)
6817 "Return the heading of the current entry, without the stars."
6818 (save-excursion
6819 (org-back-to-heading t)
6820 (if (looking-at
6821 (if no-tags
6824 (match-string 1) "")))
6826 (defun org-heading-components ()
6827 "Return the components of the current heading.
6828 This is a list with the following elements:
6829 - the level as an integer
6830 - the reduced level, different if `org-odd-levels-only' is set.
6831 - the TODO keyword, or nil
6832 - the priority character, like ?A, or nil if no priority is given
6833 - the headline text itself, or the tags string if no headline text
6834 - the tags string, or nil."
6835 (save-excursion
6836 (org-back-to-heading t)
6837 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6838 (list (length (match-string 1))
6839 (org-reduced-level (length (match-string 1)))
6840 (org-match-string-no-properties 2)
6841 (and (match-end 3) (aref (match-string 3) 2))
6842 (org-match-string-no-properties 4)
6843 (org-match-string-no-properties 5)))))
6845 (defun org-get-entry ()
6846 "Get the entry text, after heading, entire subtree."
6847 (save-excursion
6848 (org-back-to-heading t)
6849 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6851 (defun org-insert-heading-after-current ()
6852 "Insert a new heading with same level as current, after current subtree."
6853 (interactive)
6854 (org-back-to-heading)
6855 (org-insert-heading)
6856 (org-move-subtree-down)
6857 (end-of-line 1))
6859 (defun org-insert-heading-respect-content ()
6860 (interactive)
6861 (let ((org-insert-heading-respect-content t))
6862 (org-insert-heading t)))
6864 (defun org-insert-todo-heading-respect-content (&optional force-state)
6865 (interactive "P")
6866 (let ((org-insert-heading-respect-content t))
6867 (org-insert-todo-heading force-state t)))
6869 (defun org-insert-todo-heading (arg &optional force-heading)
6870 "Insert a new heading with the same level and TODO state as current heading.
6871 If the heading has no TODO state, or if the state is DONE, use the first
6872 state (TODO by default). Also with prefix arg, force first state."
6873 (interactive "P")
6874 (when (or force-heading (not (org-insert-item 'checkbox)))
6875 (org-insert-heading force-heading)
6876 (save-excursion
6877 (org-back-to-heading)
6878 (outline-previous-heading)
6879 (looking-at org-todo-line-regexp))
6880 (let*
6881 ((new-mark-x
6882 (if (or arg
6883 (not (match-beginning 2))
6884 (member (match-string 2) org-done-keywords))
6885 (car org-todo-keywords-1)
6886 (match-string 2)))
6887 (new-mark
6888 (or
6889 (run-hook-with-args-until-success
6890 'org-todo-get-default-hook new-mark-x nil)
6891 new-mark-x)))
6892 (beginning-of-line 1)
6894 (if org-treat-insert-todo-heading-as-state-change
6895 (org-todo new-mark)
6896 (insert new-mark " "))))
6897 (when org-provide-todo-statistics
6898 (org-update-parent-todo-statistics))))
6900 (defun org-insert-subheading (arg)
6901 "Insert a new subheading and demote it.
6902 Works for outline headings and for plain lists alike."
6903 (interactive "P")
6904 (org-insert-heading arg)
6905 (cond
6906 ((org-on-heading-p) (org-do-demote))
6907 ((org-at-item-p) (org-indent-item))))
6909 (defun org-insert-todo-subheading (arg)
6910 "Insert a new subheading with TODO keyword or checkbox and demote it.
6911 Works for outline headings and for plain lists alike."
6912 (interactive "P")
6913 (org-insert-todo-heading arg)
6914 (cond
6915 ((org-on-heading-p) (org-do-demote))
6916 ((org-at-item-p) (org-indent-item))))
6918 ;;; Promotion and Demotion
6920 (defvar org-after-demote-entry-hook nil
6921 "Hook run after an entry has been demoted.
6922 The cursor will be at the beginning of the entry.
6923 When a subtree is being demoted, the hook will be called for each node.")
6925 (defvar org-after-promote-entry-hook nil
6926 "Hook run after an entry has been promoted.
6927 The cursor will be at the beginning of the entry.
6928 When a subtree is being promoted, the hook will be called for each node.")
6930 (defun org-promote-subtree ()
6931 "Promote the entire subtree.
6932 See also `org-promote'."
6933 (interactive)
6934 (save-excursion
6935 (org-map-tree 'org-promote))
6936 (org-fix-position-after-promote))
6938 (defun org-demote-subtree ()
6939 "Demote the entire subtree. See `org-demote'.
6940 See also `org-promote'."
6941 (interactive)
6942 (save-excursion
6943 (org-map-tree 'org-demote))
6944 (org-fix-position-after-promote))
6947 (defun org-do-promote ()
6948 "Promote the current heading higher up the tree.
6949 If the region is active in `transient-mark-mode', promote all headings
6950 in the region."
6951 (interactive)
6952 (save-excursion
6953 (if (org-region-active-p)
6954 (org-map-region 'org-promote (region-beginning) (region-end))
6955 (org-promote)))
6956 (org-fix-position-after-promote))
6958 (defun org-do-demote ()
6959 "Demote the current heading lower down the tree.
6960 If the region is active in `transient-mark-mode', demote all headings
6961 in the region."
6962 (interactive)
6963 (save-excursion
6964 (if (org-region-active-p)
6965 (org-map-region 'org-demote (region-beginning) (region-end))
6966 (org-demote)))
6967 (org-fix-position-after-promote))
6969 (defun org-fix-position-after-promote ()
6970 "Make sure that after pro/demotion cursor position is right."
6971 (let ((pos (point)))
6972 (when (save-excursion
6973 (beginning-of-line 1)
6974 (looking-at org-todo-line-regexp)
6975 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
6976 (cond ((eobp) (insert " "))
6977 ((eolp) (insert " "))
6978 ((equal (char-after) ?\ ) (forward-char 1))))))
6980 (defun org-current-level ()
6981 "Return the level of the current entry, or nil if before the first headline.
6982 The level is the number of stars at the beginning of the headline."
6983 (save-excursion
6984 (condition-case nil
6985 (progn
6986 (org-back-to-heading t)
6987 (funcall outline-level))
6988 (error nil))))
6990 (defun org-get-previous-line-level ()
6991 "Return the outline depth of the last headline before the current line.
6992 Returns 0 for the first headline in the buffer, and nil if before the
6993 first headline."
6994 (let ((current-level (org-current-level))
6995 (prev-level (when (> (line-number-at-pos) 1)
6996 (save-excursion
6997 (beginning-of-line 0)
6998 (org-current-level)))))
6999 (cond ((null current-level) nil) ; Before first headline
7000 ((null prev-level) 0) ; At first headline
7001 (prev-level))))
7003 (defun org-reduced-level (l)
7004 "Compute the effective level of a heading.
7005 This takes into account the setting of `org-odd-levels-only'."
7006 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
7008 (defun org-level-increment ()
7009 "Return the number of stars that will be added or removed at a
7010 time to headlines when structure editing, based on the value of
7011 `org-odd-levels-only'."
7012 (if org-odd-levels-only 2 1))
7014 (defun org-get-valid-level (level &optional change)
7015 "Rectify a level change under the influence of `org-odd-levels-only'
7016 LEVEL is a current level, CHANGE is by how much the level should be
7017 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7018 even level numbers will become the next higher odd number."
7019 (if org-odd-levels-only
7020 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7021 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7022 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7023 (max 1 (+ level (or change 0)))))
7025 (if (boundp 'define-obsolete-function-alias)
7026 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7027 (define-obsolete-function-alias 'org-get-legal-level
7028 'org-get-valid-level)
7029 (define-obsolete-function-alias 'org-get-legal-level
7030 'org-get-valid-level "23.1")))
7032 (defun org-promote ()
7033 "Promote the current heading higher up the tree.
7034 If the region is active in `transient-mark-mode', promote all headings
7035 in the region."
7036 (org-back-to-heading t)
7037 (let* ((level (save-match-data (funcall outline-level)))
7038 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7039 (diff (abs (- level (length up-head) -1))))
7040 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7041 (replace-match up-head nil t)
7042 ;; Fixup tag positioning
7043 (and org-auto-align-tags (org-set-tags nil t))
7044 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7045 (run-hooks 'org-after-promote-entry-hook)))
7047 (defun org-demote ()
7048 "Demote the current heading lower down the tree.
7049 If the region is active in `transient-mark-mode', demote all headings
7050 in the region."
7051 (org-back-to-heading t)
7052 (let* ((level (save-match-data (funcall outline-level)))
7053 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7054 (diff (abs (- level (length down-head) -1))))
7055 (replace-match down-head nil t)
7056 ;; Fixup tag positioning
7057 (and org-auto-align-tags (org-set-tags nil t))
7058 (if org-adapt-indentation (org-fixup-indentation diff))
7059 (run-hooks 'org-after-demote-entry-hook)))
7061 (defun org-cycle-level ()
7062 "Cycle the level of an empty headline through possible states.
7063 This goes first to child, then to parent, level, then up the hierarchy.
7064 After top level, it switches back to sibling level."
7065 (interactive)
7066 (let ((org-adapt-indentation nil))
7067 (when (org-point-at-end-of-empty-headline)
7068 (setq this-command 'org-cycle-level) ; Only needed for caching
7069 (let ((cur-level (org-current-level))
7070 (prev-level (org-get-previous-line-level)))
7071 (cond
7072 ;; If first headline in file, promote to top-level.
7073 ((= prev-level 0)
7074 (loop repeat (/ (- cur-level 1) (org-level-increment))
7075 do (org-do-promote)))
7076 ;; If same level as prev, demote one.
7077 ((= prev-level cur-level)
7078 (org-do-demote))
7079 ;; If parent is top-level, promote to top level if not already.
7080 ((= prev-level 1)
7081 (loop repeat (/ (- cur-level 1) (org-level-increment))
7082 do (org-do-promote)))
7083 ;; If top-level, return to prev-level.
7084 ((= cur-level 1)
7085 (loop repeat (/ (- prev-level 1) (org-level-increment))
7086 do (org-do-demote)))
7087 ;; If less than prev-level, promote one.
7088 ((< cur-level prev-level)
7089 (org-do-promote))
7090 ;; If deeper than prev-level, promote until higher than
7091 ;; prev-level.
7092 ((> cur-level prev-level)
7093 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7094 do (org-do-promote))))
7095 t))))
7097 (defun org-map-tree (fun)
7098 "Call FUN for every heading underneath the current one."
7099 (org-back-to-heading)
7100 (let ((level (funcall outline-level)))
7101 (save-excursion
7102 (funcall fun)
7103 (while (and (progn
7104 (outline-next-heading)
7105 (> (funcall outline-level) level))
7106 (not (eobp)))
7107 (funcall fun)))))
7109 (defun org-map-region (fun beg end)
7110 "Call FUN for every heading between BEG and END."
7111 (let ((org-ignore-region t))
7112 (save-excursion
7113 (setq end (copy-marker end))
7114 (goto-char beg)
7115 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
7116 (< (point) end))
7117 (funcall fun))
7118 (while (and (progn
7119 (outline-next-heading)
7120 (< (point) end))
7121 (not (eobp)))
7122 (funcall fun)))))
7124 (defun org-fixup-indentation (diff)
7125 "Change the indentation in the current entry by DIFF.
7126 However, if any line in the current entry has no indentation, or if it
7127 would end up with no indentation after the change, nothing at all is done."
7128 (save-excursion
7129 (let ((end (save-excursion (outline-next-heading)
7130 (point-marker)))
7131 (prohibit (if (> diff 0)
7134 col)
7135 (unless (save-excursion (end-of-line 1)
7136 (re-search-forward prohibit end t))
7137 (while (and (< (point) end)
7139 (goto-char (match-end 0))
7140 (setq col (current-column))
7141 (if (< diff 0) (replace-match ""))
7142 (org-indent-to-column (+ diff col))))
7143 (move-marker end nil))))
7145 (defun org-convert-to-odd-levels ()
7146 "Convert an org-mode file with all levels allowed to one with odd levels.
7147 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7148 level 5 etc."
7149 (interactive)
7150 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7151 (let ((outline-regexp org-outline-regexp)
7152 (outline-level 'org-outline-level)
7153 (org-odd-levels-only nil) n)
7154 (save-excursion
7155 (goto-char (point-min))
7157 (setq n (- (length (match-string 0)) 2))
7158 (while (>= (setq n (1- n)) 0)
7159 (org-demote))
7160 (end-of-line 1))))))
7162 (defun org-convert-to-oddeven-levels ()
7163 "Convert an org-mode file with only odd levels to one with odd/even levels.
7164 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7165 file contains a section with an even level, conversion would
7166 destroy the structure of the file. An error is signaled in this
7167 case."
7168 (interactive)
7169 (goto-char (point-min))
7170 ;; First check if there are no even levels
7172 (org-show-context t)
7173 (error "Not all levels are odd in this file. Conversion not possible"))
7174 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7175 (let ((outline-regexp org-outline-regexp)
7176 (outline-level 'org-outline-level)
7177 (org-odd-levels-only nil) n)
7178 (save-excursion
7179 (goto-char (point-min))
7181 (setq n (/ (1- (length (match-string 0))) 2))
7182 (while (>= (setq n (1- n)) 0)
7183 (org-promote))
7184 (end-of-line 1))))))
7186 (defun org-tr-level (n)
7187 "Make N odd if required."
7188 (if org-odd-levels-only (1+ (/ n 2)) n))
7190 ;;; Vertical tree motion, cutting and pasting of subtrees
7192 (defun org-move-subtree-up (&optional arg)
7193 "Move the current subtree up past ARG headlines of the same level."
7194 (interactive "p")
7195 (org-move-subtree-down (- (prefix-numeric-value arg))))
7197 (defun org-move-subtree-down (&optional arg)
7198 "Move the current subtree down past ARG headlines of the same level."
7199 (interactive "p")
7200 (setq arg (prefix-numeric-value arg))
7201 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7202 'org-get-last-sibling))
7203 (ins-point (make-marker))
7204 (cnt (abs arg))
7205 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7206 ;; Select the tree
7207 (org-back-to-heading)
7208 (setq beg0 (point))
7209 (save-excursion
7210 (setq ne-beg (org-back-over-empty-lines))
7211 (setq beg (point)))
7212 (save-match-data
7213 (save-excursion (outline-end-of-heading)
7214 (setq folded (org-invisible-p)))
7215 (outline-end-of-subtree))
7216 (outline-next-heading)
7217 (setq ne-end (org-back-over-empty-lines))
7218 (setq end (point))
7219 (goto-char beg0)
7220 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7221 ;; include less whitespace
7222 (save-excursion
7223 (goto-char beg)
7224 (forward-line (- ne-beg ne-end))
7225 (setq beg (point))))
7226 ;; Find insertion point, with error handling
7227 (while (> cnt 0)
7228 (or (and (funcall movfunc) (looking-at outline-regexp))
7229 (progn (goto-char beg0)
7230 (error "Cannot move past superior level or buffer limit")))
7231 (setq cnt (1- cnt)))
7232 (if (> arg 0)
7233 ;; Moving forward - still need to move over subtree
7234 (progn (org-end-of-subtree t t)
7235 (save-excursion
7236 (org-back-over-empty-lines)
7237 (or (bolp) (newline)))))
7238 (setq ne-ins (org-back-over-empty-lines))
7239 (move-marker ins-point (point))
7240 (setq txt (buffer-substring beg end))
7241 (org-save-markers-in-region beg end)
7242 (delete-region beg end)
7243 (org-remove-empty-overlays-at beg)
7244 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7245 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7247 (let ((bbb (point)))
7248 (insert-before-markers txt)
7249 (org-reinstall-markers-in-region bbb)
7250 (move-marker ins-point bbb))
7252 (setq ins-end (point))
7253 (goto-char ins-point)
7254 (org-skip-whitespace)
7255 (when (and (< arg 0)
7256 (org-first-sibling-p)
7257 (> ne-ins ne-beg))
7258 ;; Move whitespace back to beginning
7259 (save-excursion
7260 (goto-char ins-end)
7261 (let ((kill-whole-line t))
7262 (kill-line (- ne-ins ne-beg)) (point)))
7264 (move-marker ins-point nil)
7265 (if folded
7266 (hide-subtree)
7267 (org-show-entry)
7268 (show-children)
7269 (org-cycle-hide-drawers 'children))
7270 (org-clean-visibility-after-subtree-move)))
7272 (defvar org-subtree-clip ""
7273 "Clipboard for cut and paste of subtrees.
7274 This is actually only a copy of the kill, because we use the normal kill
7275 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7277 (defvar org-subtree-clip-folded nil
7278 "Was the last copied subtree folded?
7279 This is used to fold the tree back after pasting.")
7281 (defun org-cut-subtree (&optional n)
7282 "Cut the current subtree into the clipboard.
7283 With prefix arg N, cut this many sequential subtrees.
7284 This is a short-hand for marking the subtree and then cutting it."
7285 (interactive "p")
7286 (org-copy-subtree n 'cut))
7288 (defun org-copy-subtree (&optional n cut force-store-markers)
7289 "Cut the current subtree into the clipboard.
7290 With prefix arg N, cut this many sequential subtrees.
7291 This is a short-hand for marking the subtree and then copying it.
7292 If CUT is non-nil, actually cut the subtree.
7293 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7294 of some markers in the region, even if CUT is non-nil. This is
7295 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7296 (interactive "p")
7297 (let (beg end folded (beg0 (point)))
7298 (if (interactive-p)
7299 (org-back-to-heading nil) ; take what looks like a subtree
7300 (org-back-to-heading t)) ; take what is really there
7301 (org-back-over-empty-lines)
7302 (setq beg (point))
7304 (save-match-data
7305 (save-excursion (outline-end-of-heading)
7306 (setq folded (org-invisible-p)))
7307 (condition-case nil
7308 (org-forward-same-level (1- n) t)
7309 (error nil))
7310 (org-end-of-subtree t t))
7311 (org-back-over-empty-lines)
7312 (setq end (point))
7313 (goto-char beg0)
7314 (when (> end beg)
7315 (setq org-subtree-clip-folded folded)
7316 (when (or cut force-store-markers)
7317 (org-save-markers-in-region beg end))
7318 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7319 (setq org-subtree-clip (current-kill 0))
7320 (message "%s: Subtree(s) with %d characters"
7321 (if cut "Cut" "Copied")
7322 (length org-subtree-clip)))))
7324 (defun org-paste-subtree (&optional level tree for-yank)
7325 "Paste the clipboard as a subtree, with modification of headline level.
7326 The entire subtree is promoted or demoted in order to match a new headline
7327 level.
7329 If the cursor is at the beginning of a headline, the same level as
7330 that headline is used to paste the tree
7332 If not, the new level is derived from the *visible* headings
7333 before and after the insertion point, and taken to be the inferior headline
7334 level of the two. So if the previous visible heading is level 3 and the
7335 next is level 4 (or vice versa), level 4 will be used for insertion.
7336 This makes sure that the subtree remains an independent subtree and does
7337 not swallow low level entries.
7339 You can also force a different level, either by using a numeric prefix
7340 argument, or by inserting the heading marker by hand. For example, if the
7343 If optional TREE is given, use this text instead of the kill ring.
7345 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7346 move back over whitespace before inserting, and move point to the end of
7347 the inserted text when done."
7348 (interactive "P")
7349 (setq tree (or tree (and kill-ring (current-kill 0))))
7350 (unless (org-kill-is-subtree-p tree)
7351 (error "%s"
7352 (substitute-command-keys
7354 (let* ((visp (not (org-invisible-p)))
7355 (txt tree)
7360 (old-level (if (string-match ^re txt)
7361 (- (match-end 0) (match-beginning 0) 1)
7362 -1))
7363 (force-level (cond (level (prefix-numeric-value level))
7365 (string-match
7366 ^re_ (buffer-substring
7367 (point-at-bol) (point))))
7368 (- (match-end 1) (match-beginning 1)))
7369 ((and (bolp)
7370 (looking-at org-outline-regexp))
7371 (- (match-end 0) (point) 1))
7372 (t nil)))
7373 (previous-level (save-excursion
7374 (condition-case nil
7375 (progn
7376 (outline-previous-visible-heading 1)
7377 (if (looking-at re)
7378 (- (match-end 0) (match-beginning 0) 1)
7379 1))
7380 (error 1))))
7381 (next-level (save-excursion
7382 (condition-case nil
7383 (progn
7384 (or (looking-at outline-regexp)
7385 (outline-next-visible-heading 1))
7386 (if (looking-at re)
7387 (- (match-end 0) (match-beginning 0) 1)
7388 1))
7389 (error 1))))
7390 (new-level (or force-level (max previous-level next-level)))
7391 (shift (if (or (= old-level -1)
7392 (= new-level -1)
7393 (= old-level new-level))
7394 0
7395 (- new-level old-level)))
7396 (delta (if (> shift 0) -1 1))
7397 (func (if (> shift 0) 'org-demote 'org-promote))
7398 (org-odd-levels-only nil)
7399 beg end newend)
7400 ;; Remove the forced level indicator
7401 (if force-level
7402 (delete-region (point-at-bol) (point)))
7403 ;; Paste
7404 (beginning-of-line 1)
7405 (unless for-yank (org-back-over-empty-lines))
7406 (setq beg (point))
7407 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7408 (insert-before-markers txt)
7410 (setq newend (point))
7411 (org-reinstall-markers-in-region beg)
7412 (setq end (point))
7413 (goto-char beg)
7415 (setq beg (point))
7416 (if (and (org-invisible-p) visp)
7417 (save-excursion (outline-show-heading)))
7418 ;; Shift if necessary
7419 (unless (= shift 0)
7420 (save-restriction
7421 (narrow-to-region beg end)
7422 (while (not (= shift 0))
7423 (org-map-region func (point-min) (point-max))
7424 (setq shift (+ delta shift)))
7425 (goto-char (point-min))
7426 (setq newend (point-max))))
7427 (when (or (interactive-p) for-yank)
7428 (message "Clipboard pasted as level %d subtree" new-level))
7429 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7430 kill-ring
7431 (eq org-subtree-clip (current-kill 0))
7432 org-subtree-clip-folded)
7433 ;; The tree was folded before it was killed/copied
7434 (hide-subtree))
7435 (and for-yank (goto-char newend))))
7437 (defun org-kill-is-subtree-p (&optional txt)
7438 "Check if the current kill is an outline subtree, or a set of trees.
7439 Returns nil if kill does not start with a headline, or if the first
7440 headline level is not the largest headline level in the tree.
7441 So this will actually accept several entries of equal levels as well,
7442 which is OK for `org-paste-subtree'.
7443 If optional TXT is given, check this string instead of the current kill."
7444 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7445 (start-level (and kill
7448 kill)
7449 (- (match-end 2) (match-beginning 2) 1)))
7450 (re (concat "^" org-outline-regexp))
7451 (start (1+ (or (match-beginning 2) -1))))
7452 (if (not start-level)
7453 (progn
7454 nil) ;; does not even start with a heading
7455 (catch 'exit
7456 (while (setq start (string-match re kill (1+ start)))
7457 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7458 (throw 'exit nil)))
7459 t))))
7461 (defvar org-markers-to-move nil
7462 "Markers that should be moved with a cut-and-paste operation.
7463 Those markers are stored together with their positions relative to
7464 the start of the region.")
7466 (defun org-save-markers-in-region (beg end)
7467 "Check markers in region.
7468 If these markers are between BEG and END, record their position relative
7469 to BEG, so that after moving the block of text, we can put the markers back
7470 into place.
7471 This function gets called just before an entry or tree gets cut from the
7472 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7473 called immediately, to move the markers with the entries."
7474 (setq org-markers-to-move nil)
7475 (when (featurep 'org-clock)
7476 (org-clock-save-markers-for-cut-and-paste beg end))
7477 (when (featurep 'org-agenda)
7478 (org-agenda-save-markers-for-cut-and-paste beg end)))
7480 (defun org-check-and-save-marker (marker beg end)
7481 "Check if MARKER is between BEG and END.
7482 If yes, remember the marker and the distance to BEG."
7483 (when (and (marker-buffer marker)
7484 (equal (marker-buffer marker) (current-buffer)))
7485 (if (and (>= marker beg) (< marker end))
7486 (push (cons marker (- marker beg)) org-markers-to-move))))
7488 (defun org-reinstall-markers-in-region (beg)
7489 "Move all remembered markers to their position relative to BEG."
7490 (mapc (lambda (x)
7491 (move-marker (car x) (+ beg (cdr x))))
7492 org-markers-to-move)
7493 (setq org-markers-to-move nil))
7495 (defun org-narrow-to-subtree ()
7496 "Narrow buffer to the current subtree."
7497 (interactive)
7498 (save-excursion
7499 (save-match-data
7500 (narrow-to-region
7501 (progn (org-back-to-heading t) (point))
7502 (progn (org-end-of-subtree t t)
7503 (if (org-on-heading-p) (backward-char 1))
7504 (point))))))
7506 (eval-when-compile
7507 (defvar org-property-drawer-re))
7509 (defun org-clone-subtree-with-time-shift (n &optional shift)
7510 "Clone the task (subtree) at point N times.
7511 The clones will be inserted as siblings.
7513 In interactive use, the user will be prompted for the number of
7514 clones to be produced, and for a time SHIFT, which may be a
7515 repeater as used in time stamps, for example `+3d'.
7517 When a valid repeater is given and the entry contains any time
7518 stamps, the clones will become a sequence in time, with time
7519 stamps in the subtree shifted for each clone produced. If SHIFT
7520 is nil or the empty string, time stamps will be left alone. The
7521 ID property of the original subtree is removed.
7523 If the original subtree did contain time stamps with a repeater,
7524 the following will happen:
7525 - the repeater will be removed in each clone
7526 - an additional clone will be produced, with the current, unshifted
7527 date(s) in the entry.
7528 - the original entry will be placed *after* all the clones, with
7529 repeater intact.
7530 - the start days in the repeater in the original entry will be shifted
7531 to past the last clone.
7532 I this way you can spell out a number of instances of a repeating task,
7533 and still retain the repeater to cover future instances of the task."
7534 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7535 (let (beg end template task idprop
7536 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7537 (if (not (and (integerp n) (> n 0)))
7538 (error "Invalid number of replications %s" n))
7541 shift)))
7542 (error "Invalid shift specification %s" shift))
7543 (when doshift
7544 (setq shift-n (string-to-number (match-string 1 shift))
7545 shift-what (cdr (assoc (match-string 2 shift)
7546 '(("d" . day) ("w" . week)
7547 ("m" . month) ("y" . year))))))
7548 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7549 (setq nmin 1 nmax n)
7550 (org-back-to-heading t)
7551 (setq beg (point))
7552 (setq idprop (org-entry-get nil "ID"))
7553 (org-end-of-subtree t t)
7555 (setq end (point))
7556 (setq template (buffer-substring beg end))
7557 (when (and doshift
7559 (delete-region beg end)
7560 (setq end beg)
7561 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7562 (goto-char end)
7563 (loop for n from nmin to nmax do
7564 ;; prepare clone
7565 (with-temp-buffer
7566 (insert template)
7567 (org-mode)
7568 (goto-char (point-min))
7569 (and idprop (if org-clone-delete-id
7570 (org-entry-delete nil "ID")
7571 (org-id-get-create t)))
7572 (while (re-search-forward org-property-drawer-re nil t)
7573 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7574 (goto-char (point-min))
7575 (when doshift
7576 (while (re-search-forward org-ts-regexp-both nil t)
7577 (org-timestamp-change (* n shift-n) shift-what))
7578 (unless (= n n-no-remove)
7579 (goto-char (point-min))
7580 (while (re-search-forward org-ts-regexp nil t)
7581 (save-excursion
7582 (goto-char (match-beginning 0))
7584 (delete-region (match-beginning 1) (match-end 1)))))))
7585 (setq task (buffer-string)))
7586 (insert task))
7587 (goto-char beg)))
7589 ;;; Outline Sorting
7591 (defun org-sort (with-case)
7592 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7593 Optional argument WITH-CASE means sort case-sensitively.
7594 With a double prefix argument, also remove duplicate entries."
7595 (interactive "P")
7596 (cond
7597 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7598 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7599 (t
7600 (org-call-with-arg 'org-sort-entries with-case))))
7602 (defun org-sort-remove-invisible (s)
7603 (remove-text-properties 0 (length s) org-rm-props s)
7604 (while (string-match org-bracket-link-regexp s)
7605 (setq s (replace-match (if (match-end 2)
7606 (match-string 3 s)
7607 (match-string 1 s)) t t s)))
7608 s)
7610 (defvar org-priority-regexp) ; defined later in the file
7612 (defvar org-after-sorting-entries-or-items-hook nil
7613 "Hook that is run after a bunch of entries or items have been sorted.
7614 When children are sorted, the cursor is in the parent line when this
7615 hook gets called. When a region or a plain list is sorted, the cursor
7616 will be in the first entry of the sorted region/list.")
7618 (defun org-sort-entries
7619 (&optional with-case sorting-type getkey-func compare-func property)
7620 "Sort entries on a certain level of an outline tree.
7621 If there is an active region, the entries in the region are sorted.
7622 Else, if the cursor is before the first entry, sort the top-level items.
7623 Else, the children of the entry at point are sorted.
7625 Sorting can be alphabetically, numerically, by date/time as given by
7626 a time stamp, by a property or by priority.
7628 The command prompts for the sorting type unless it has been given to the
7629 function through the SORTING-TYPE argument, which needs to be a character,
7630 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7631 precise meaning of each character:
7633 n Numerically, by converting the beginning of the entry/item to a number.
7634 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7635 t By date/time, either the first active time stamp in the entry, or, if
7636 none exist, by the first inactive one.
7637 s By the scheduled date/time.
7638 d By deadline date/time.
7639 c By creation time, which is assumed to be the first inactive time stamp
7640 at the beginning of a line.
7641 p By priority according to the cookie.
7642 r By the value of a property.
7644 Capital letters will reverse the sort order.
7646 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7647 called with point at the beginning of the record. It must return either
7648 a string or a number that should serve as the sorting key for that record.
7650 Comparing entries ignores case by default. However, with an optional argument
7651 WITH-CASE, the sorting considers case as well."
7652 (interactive "P")
7653 (let ((case-func (if with-case 'identity 'downcase))
7654 start beg end stars re re2
7655 txt what tmp)
7656 ;; Find beginning and end of region to sort
7657 (cond
7658 ((org-region-active-p)
7659 ;; we will sort the region
7660 (setq end (region-end)
7661 what "region")
7662 (goto-char (region-beginning))
7663 (if (not (org-on-heading-p)) (outline-next-heading))
7664 (setq start (point)))
7665 ((or (org-on-heading-p)
7666 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7667 ;; we will sort the children of the current headline
7668 (org-back-to-heading)
7669 (setq start (point)
7670 end (progn (org-end-of-subtree t t)
7672 (org-back-over-empty-lines)
7673 (point))
7674 what "children")
7675 (goto-char start)
7676 (show-subtree)
7677 (outline-next-heading))
7678 (t
7679 ;; we will sort the top-level entries in this file
7680 (goto-char (point-min))
7681 (or (org-on-heading-p) (outline-next-heading))
7682 (setq start (point))
7683 (goto-char (point-max))
7684 (beginning-of-line 1)
7686 ;; File ends in a non-white line
7687 (end-of-line 1)
7689 (setq end (point-max))
7690 (setq what "top-level")
7691 (goto-char start)
7692 (show-all)))
7694 (setq beg (point))
7695 (if (>= beg end) (error "Nothing to sort"))
7698 (setq stars (match-string 1)
7699 re (concat "^" (regexp-quote stars) " +")
7700 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[^*]")
7701 txt (buffer-substring beg end))
7703 (if (and (not (equal stars "*")) (string-match re2 txt))
7704 (error "Region to sort contains a level above the first entry"))
7706 (unless sorting-type
7707 (message
7708 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7710 A/N/T/S/D/C/P/O/F means reversed:"
7711 what)
7712 (setq sorting-type (read-char-exclusive))
7714 (and (= (downcase sorting-type) ?f)
7715 (setq getkey-func
7716 (org-icompleting-read "Sort using function: "
7717 obarray 'fboundp t nil nil))
7718 (setq getkey-func (intern getkey-func)))
7720 (and (= (downcase sorting-type) ?r)
7721 (setq property
7722 (org-icompleting-read "Property: "
7723 (mapcar 'list (org-buffer-property-keys t))
7724 nil t))))
7726 (message "Sorting entries...")
7728 (save-restriction
7729 (narrow-to-region start end)
7730 (let ((dcst (downcase sorting-type))
7731 (case-fold-search nil)
7732 (now (current-time)))
7733 (sort-subr
7734 (/= dcst sorting-type)
7735 ;; This function moves to the beginning character of the "record" to
7736 ;; be sorted.
7737 (lambda nil
7738 (if (re-search-forward re nil t)
7739 (goto-char (match-beginning 0))
7740 (goto-char (point-max))))
7741 ;; This function moves to the last character of the "record" being
7742 ;; sorted.
7743 (lambda nil
7744 (save-match-data
7745 (condition-case nil
7746 (outline-forward-same-level 1)
7747 (error
7748 (goto-char (point-max))))))
7749 ;; This function returns the value that gets sorted against.
7750 (lambda nil
7751 (cond
7752 ((= dcst ?n)
7753 (if (looking-at org-complex-heading-regexp)
7754 (string-to-number (match-string 4))
7755 nil))
7756 ((= dcst ?a)
7757 (if (looking-at org-complex-heading-regexp)
7758 (funcall case-func (match-string 4))
7759 nil))
7760 ((= dcst ?t)
7761 (let ((end (save-excursion (outline-next-heading) (point))))
7762 (if (or (re-search-forward org-ts-regexp end t)
7763 (re-search-forward org-ts-regexp-both end t))
7764 (org-time-string-to-seconds (match-string 0))
7765 (org-float-time now))))
7766 ((= dcst ?c)
7767 (let ((end (save-excursion (outline-next-heading) (point))))
7768 (if (re-search-forward
7770 end t)
7771 (org-time-string-to-seconds (match-string 0))
7772 (org-float-time now))))
7773 ((= dcst ?s)
7774 (let ((end (save-excursion (outline-next-heading) (point))))
7775 (if (re-search-forward org-scheduled-time-regexp end t)
7776 (org-time-string-to-seconds (match-string 1))
7777 (org-float-time now))))
7778 ((= dcst ?d)
7779 (let ((end (save-excursion (outline-next-heading) (point))))
7780 (if (re-search-forward org-deadline-time-regexp end t)
7781 (org-time-string-to-seconds (match-string 1))
7782 (org-float-time now))))
7783 ((= dcst ?p)
7784 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7785 (string-to-char (match-string 2))
7786 org-default-priority))
7787 ((= dcst ?r)
7788 (or (org-entry-get nil property) ""))
7789 ((= dcst ?o)
7790 (if (looking-at org-complex-heading-regexp)
7791 (- 9999 (length (member (match-string 2)
7792 org-todo-keywords-1)))))
7793 ((= dcst ?f)
7794 (if getkey-func
7795 (progn
7796 (setq tmp (funcall getkey-func))
7797 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7798 tmp)
7799 (error "Invalid key function `%s'" getkey-func)))
7800 (t (error "Invalid sorting type `%c'" sorting-type))))
7801 nil
7802 (cond
7803 ((= dcst ?a) 'string<)
7804 ((= dcst ?f) compare-func)
7805 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7806 (t nil)))))
7807 (run-hooks 'org-after-sorting-entries-or-items-hook)
7808 (message "Sorting entries...done")))
7810 (defun org-do-sort (table what &optional with-case sorting-type)
7811 "Sort TABLE of WHAT according to SORTING-TYPE.
7812 The user will be prompted for the SORTING-TYPE if the call to this
7813 function does not specify it. WHAT is only for the prompt, to indicate
7814 what is being sorted. The sorting key will be extracted from
7815 the car of the elements of the table.
7816 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7817 (unless sorting-type
7818 (message
7819 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7820 what)
7821 (setq sorting-type (read-char-exclusive)))
7822 (let ((dcst (downcase sorting-type))
7823 extractfun comparefun)
7824 ;; Define the appropriate functions
7825 (cond
7826 ((= dcst ?n)
7827 (setq extractfun 'string-to-number
7828 comparefun (if (= dcst sorting-type) '< '>)))
7829 ((= dcst ?a)
7830 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7831 (lambda(x) (downcase (org-sort-remove-invisible x))))
7832 comparefun (if (= dcst sorting-type)
7833 'string<
7834 (lambda (a b) (and (not (string< a b))
7835 (not (string= a b)))))))
7836 ((= dcst ?t)
7837 (setq extractfun
7838 (lambda (x)
7839 (if (or (string-match org-ts-regexp x)
7840 (string-match org-ts-regexp-both x))
7841 (org-float-time
7842 (org-time-string-to-time (match-string 0 x)))
7843 0))
7844 comparefun (if (= dcst sorting-type) '< '>)))
7845 (t (error "Invalid sorting type `%c'" sorting-type)))
7847 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7848 table)
7849 (lambda (a b) (funcall comparefun (car a) (car b))))))
7852 ;;; The orgstruct minor mode
7854 ;; Define a minor mode which can be used in other modes in order to
7855 ;; integrate the org-mode structure editing commands.
7857 ;; This is really a hack, because the org-mode structure commands use
7858 ;; keys which normally belong to the major mode. Here is how it
7859 ;; works: The minor mode defines all the keys necessary to operate the
7860 ;; structure commands, but wraps the commands into a function which
7861 ;; tests if the cursor is currently at a headline or a plain list
7862 ;; item. If that is the case, the structure command is used,
7863 ;; temporarily setting many Org-mode variables like regular
7864 ;; expressions for filling etc. However, when any of those keys is
7865 ;; used at a different location, function uses `key-binding' to look
7866 ;; up if the key has an associated command in another currently active
7867 ;; keymap (minor modes, major mode, global), and executes that
7868 ;; command. There might be problems if any of the keys is otherwise
7869 ;; used as a prefix key.
7871 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
7872 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
7873 ;; addresses this by checking explicitly for both bindings.
7875 (defvar orgstruct-mode-map (make-sparse-keymap)
7876 "Keymap for the minor `orgstruct-mode'.")
7878 (defvar org-local-vars nil
7879 "List of local variables, for use by `orgstruct-mode'.")
7881 ;;;###autoload
7882 (define-minor-mode orgstruct-mode
7883 "Toggle the minor mode `orgstruct-mode'.
7884 This mode is for using Org-mode structure commands in other
7885 modes. The following keys behave as if Org-mode were active, if
7886 the cursor is on a headline, or on a plain list item (both as
7887 defined by Org-mode).
7889 M-up Move entry/item up
7890 M-down Move entry/item down
7891 M-left Promote
7892 M-right Demote
7893 M-S-up Move entry/item up
7894 M-S-down Move entry/item down
7895 M-S-left Promote subtree
7896 M-S-right Demote subtree
7897 M-q Fill paragraph and items like in Org-mode
7898 C-c ^ Sort entries
7899 C-c - Cycle list bullet
7900 TAB Cycle item visibility
7901 M-RET Insert new heading/item
7902 S-M-RET Insert new TODO heading / Checkbox item
7903 C-c C-c Set tags / toggle checkbox"
7904 nil " OrgStruct" nil
7905 (org-load-modules-maybe)
7906 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
7908 ;;;###autoload
7909 (defun turn-on-orgstruct ()
7910 "Unconditionally turn on `orgstruct-mode'."
7911 (orgstruct-mode 1))
7913 (defun orgstruct++-mode (&optional arg)
7914 "Toggle `orgstruct-mode', the enhanced version of it.
7915 In addition to setting orgstruct-mode, this also exports all indentation
7916 and autofilling variables from org-mode into the buffer. It will also
7917 recognize item context in multiline items.
7918 Note that turning off orgstruct-mode will *not* remove the
7919 indentation/paragraph settings. This can only be done by refreshing the
7921 (interactive "P")
7922 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
7923 (if (< arg 1)
7924 (orgstruct-mode -1)
7925 (orgstruct-mode 1)
7926 (let (var val)
7927 (mapc
7928 (lambda (x)
7929 (when (string-match
7931 (symbol-name (car x)))
7932 (setq var (car x) val (nth 1 x))
7933 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
7934 org-local-vars)
7935 (org-set-local 'orgstruct-is-++ t))))
7937 (defvar orgstruct-is-++ nil
7938 "Is `orgstruct-mode' in ++ version in the current-buffer?")
7939 (make-variable-buffer-local 'orgstruct-is-++)
7941 ;;;###autoload
7942 (defun turn-on-orgstruct++ ()
7943 "Unconditionally turn on `orgstruct++-mode'."
7944 (orgstruct++-mode 1))
7946 (defun orgstruct-error ()
7947 "Error when there is no default binding for a structure key."
7948 (interactive)
7949 (error "This key has no function outside structure elements"))
7951 (defun orgstruct-setup ()
7952 "Setup orgstruct keymaps."
7953 (let ((nfunc 0)
7954 (bindings
7955 (list
7956 '([(meta up)] org-metaup)
7957 '([(meta down)] org-metadown)
7958 '([(meta left)] org-metaleft)
7959 '([(meta right)] org-metaright)
7960 '([(meta shift up)] org-shiftmetaup)
7961 '([(meta shift down)] org-shiftmetadown)
7962 '([(meta shift left)] org-shiftmetaleft)
7963 '([(meta shift right)] org-shiftmetaright)
7964 '([?\e (up)] org-metaup)
7965 '([?\e (down)] org-metadown)
7966 '([?\e (left)] org-metaleft)
7967 '([?\e (right)] org-metaright)
7968 '([?\e (shift up)] org-shiftmetaup)
7969 '([?\e (shift down)] org-shiftmetadown)
7970 '([?\e (shift left)] org-shiftmetaleft)
7971 '([?\e (shift right)] org-shiftmetaright)
7972 '([(shift up)] org-shiftup)
7973 '([(shift down)] org-shiftdown)
7974 '([(shift left)] org-shiftleft)
7975 '([(shift right)] org-shiftright)
7976 '("\C-c\C-c" org-ctrl-c-ctrl-c)
7977 '("\M-q" fill-paragraph)
7978 '("\C-c^" org-sort)
7979 '("\C-c-" org-cycle-list-bullet)))
7980 elt key fun cmd)
7981 (while (setq elt (pop bindings))
7982 (setq nfunc (1+ nfunc))
7983 (setq key (org-key (car elt))
7984 fun (nth 1 elt)
7985 cmd (orgstruct-make-binding fun nfunc key))
7986 (org-defkey orgstruct-mode-map key cmd))
7988 ;; Special treatment needed for TAB and RET
7989 (org-defkey orgstruct-mode-map [(tab)]
7990 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
7991 (org-defkey orgstruct-mode-map "\C-i"
7992 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
7994 (org-defkey orgstruct-mode-map "\M-\C-m"
7995 (orgstruct-make-binding 'org-insert-heading 105
7996 "\M-\C-m" [(meta return)]))
7997 (org-defkey orgstruct-mode-map [(meta return)]
7998 (orgstruct-make-binding 'org-insert-heading 106
7999 [(meta return)] "\M-\C-m"))
8001 (org-defkey orgstruct-mode-map [(shift meta return)]
8002 (orgstruct-make-binding 'org-insert-todo-heading 107
8003 [(meta return)] "\M-\C-m"))
8005 (org-defkey orgstruct-mode-map "\e\C-m"
8006 (orgstruct-make-binding 'org-insert-heading 108
8007 "\e\C-m" [?\e (return)]))
8008 (org-defkey orgstruct-mode-map [?\e (return)]
8009 (orgstruct-make-binding 'org-insert-heading 109
8010 [?\e (return)] "\e\C-m"))
8011 (org-defkey orgstruct-mode-map [?\e (shift return)]
8012 (orgstruct-make-binding 'org-insert-todo-heading 110
8013 [?\e (return)] "\e\C-m"))
8015 (unless org-local-vars
8016 (setq org-local-vars (org-get-local-variables)))
8018 t))
8020 (defun orgstruct-make-binding (fun n &rest keys)
8021 "Create a function for binding in the structure minor mode.
8022 FUN is the command to call inside a table. N is used to create a unique
8023 command name. KEYS are keys that should be checked in for a command
8024 to execute outside of tables."
8025 (eval
8026 (list 'defun
8027 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8028 '(arg)
8030 "Outside of structure, run the binding of `"
8031 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8032 "'.")
8033 '(interactive "p")
8034 (list 'if
8035 `(org-context-p 'headline 'item
8036 (and orgstruct-is-++
8037 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8038 'item-body))
8039 (list 'org-run-like-in-org-mode (list 'quote fun))
8040 (list 'let '(orgstruct-mode)
8041 (list 'call-interactively
8042 (append '(or)
8043 (mapcar (lambda (k)
8044 (list 'key-binding k))
8045 keys)
8046 '('orgstruct-error))))))))
8048 (defun org-context-p (&rest contexts)
8049 "Check if local context is any of CONTEXTS.
8050 Possible values in the list of contexts are `table', `headline', and `item'."
8051 (let ((pos (point)))
8052 (goto-char (point-at-bol))
8053 (prog1 (or (and (memq 'table contexts)
8055 (and (memq 'headline contexts)
8057 (looking-at outline-regexp))
8058 (and (memq 'item contexts)
8060 (and (memq 'item-body contexts)
8061 (org-in-item-p)))
8062 (goto-char pos))))
8064 (defun org-get-local-variables ()
8065 "Return a list of all local variables in an org-mode buffer."
8066 (let (varlist)
8067 (with-current-buffer (get-buffer-create "*Org tmp*")
8068 (erase-buffer)
8069 (org-mode)
8070 (setq varlist (buffer-local-variables)))
8071 (kill-buffer "*Org tmp*")
8072 (delq nil
8073 (mapcar
8074 (lambda (x)
8075 (setq x
8076 (if (symbolp x)
8077 (list x)
8078 (list (car x) (list 'quote (cdr x)))))
8079 (if (string-match
8080 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8081 (symbol-name (car x)))
8082 x nil))
8083 varlist))))
8085 ;;;###autoload
8086 (defun org-run-like-in-org-mode (cmd)
8087 "Run a command, pretending that the current buffer is in Org-mode.
8088 This will temporarily bind local variables that are typically bound in
8089 Org-mode to the values they have in Org-mode, and then interactively
8090 call CMD."
8091 (org-load-modules-maybe)
8092 (unless org-local-vars
8093 (setq org-local-vars (org-get-local-variables)))
8094 (eval (list 'let org-local-vars
8095 (list 'call-interactively (list 'quote cmd)))))
8097 ;;;; Archiving
8099 (defun org-get-category (&optional pos)
8100 "Get the category applying to position POS."
8101 (get-text-property (or pos (point)) 'org-category))
8103 (defun org-refresh-category-properties ()
8104 "Refresh category text properties in the buffer."
8105 (let ((def-cat (cond
8106 ((null org-category)
8107 (if buffer-file-name
8108 (file-name-sans-extension
8109 (file-name-nondirectory buffer-file-name))
8110 "???"))
8111 ((symbolp org-category) (symbol-name org-category))
8112 (t org-category)))
8113 beg end cat pos optionp)
8114 (org-unmodified
8115 (save-excursion
8116 (save-restriction
8117 (widen)
8118 (goto-char (point-min))
8119 (put-text-property (point) (point-max) 'org-category def-cat)
8120 (while (re-search-forward
8122 (setq pos (match-end 0)
8123 optionp (equal (char-after (match-beginning 0)) ?#)
8124 cat (org-trim (match-string 2)))
8125 (if optionp
8126 (setq beg (point-at-bol) end (point-max))
8127 (org-back-to-heading t)
8128 (setq beg (point) end (org-end-of-subtree t t)))
8129 (put-text-property beg end 'org-category cat)
8130 (goto-char pos)))))))
8133 ;;;; Link Stuff
8135 ;;; Link abbreviations
8137 (defun org-link-expand-abbrev (link)
8138 "Apply replacements as defined in `org-link-abbrev-alist."
8140 (let* ((key (match-string 1 link))
8141 (as (or (assoc key org-link-abbrev-alist-local)
8142 (assoc key org-link-abbrev-alist)))
8143 (tag (and (match-end 2) (match-string 3 link)))
8144 rpl)
8145 (if (not as)
8146 link
8147 (setq rpl (cdr as))
8148 (cond
8149 ((symbolp rpl) (funcall rpl tag))
8150 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8151 ((string-match "%h" rpl)
8152 (replace-match (url-hexify-string (or tag "")) t t rpl))
8153 (t (concat rpl tag)))))
8154 link))
8156 ;;; Storing and inserting links
8158 (defvar org-insert-link-history nil
8159 "Minibuffer history for links inserted with `org-insert-link'.")
8161 (defvar org-stored-links nil
8162 "Contains the links stored with `org-store-link'.")
8164 (defvar org-store-link-plist nil
8165 "Plist with info about the most recently link created with `org-store-link'.")
8167 (defvar org-link-protocols nil
8168 "Link protocols added to Org-mode using `org-add-link-type'.")
8170 (defvar org-store-link-functions nil
8171 "List of functions that are called to create and store a link.
8172 Each function will be called in turn until one returns a non-nil
8173 value. Each function should check if it is responsible for creating
8174 this link (for example by looking at the major mode).
8175 If not, it must exit and return nil.
8176 If yes, it should return a non-nil value after a calling
8177 `org-store-link-props' with a list of properties and values.
8178 Special properties are:
8182 This is obligatory as well.
8183 :description Optional default description for the second pair
8184 of brackets in an Org-mode link. The user can still change
8185 this when inserting this link into an Org-mode buffer.
8187 In addition to these, any additional properties can be specified
8188 and then used in remember templates.")
8190 (defun org-add-link-type (type &optional follow export)
8191 "Add TYPE to the list of `org-link-types'.
8192 Re-compute all regular expressions depending on `org-link-types'
8194 FOLLOW and EXPORT are two functions.
8196 FOLLOW should take the link path as the single argument and do whatever
8197 is necessary to follow the link, for example find a file or display
8198 a mail message.
8200 EXPORT should format the link path for export to one of the export formats.
8201 It should be a function accepting three arguments:
8204 desc the description of the link, if any, nil if there was no description
8205 format the export format, a symbol like `html' or `latex' or `ascii'..
8207 The function may use the FORMAT information to return different values
8208 depending on the format. The return value will be put literally into
8209 the exported file. If the return value is nil, this means Org should
8210 do what it normally does with links which do not have EXPORT defined.
8212 Org-mode has a built-in default for exporting links. If you are happy with
8213 this default, there is no need to define an export function for the link
8214 type. For a simple example of an export function, see `org-bbdb.el'."
8215 (add-to-list 'org-link-types type t)
8216 (org-make-link-regexps)
8217 (if (assoc type org-link-protocols)
8218 (setcdr (assoc type org-link-protocols) (list follow export))
8219 (push (list type follow export) org-link-protocols)))
8221 (defvar org-agenda-buffer-name)
8223 ;;;###autoload
8224 (defun org-store-link (arg)
8226 This link is added to `org-stored-links' and can later be inserted
8229 For some link types, a prefix arg is interpreted:
8230 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8231 For file links, arg negates `org-context-in-file-links'."
8232 (interactive "P")
8233 (org-load-modules-maybe)
8234 (setq org-store-link-plist nil) ; reset
8235 (let ((outline-regexp (org-get-limited-outline-regexp))
8236 link cpltxt desc description search txt custom-id agenda-link)
8237 (cond
8239 ((run-hook-with-args-until-success 'org-store-link-functions)
8240 (setq link (plist-get org-store-link-plist :link)
8241 desc (or (plist-get org-store-link-plist :description) link)))
8243 ((equal (buffer-name) "*Org Edit Src Example*")
8244 (let (label gc)
8245 (while (or (not label)
8246 (save-excursion
8247 (save-restriction
8248 (widen)
8249 (goto-char (point-min))
8250 (re-search-forward
8251 (regexp-quote (format org-coderef-label-format label))
8252 nil t))))
8253 (when label (message "Label exists already") (sit-for 2))
8254 (setq label (read-string "Code line label: " label)))
8255 (end-of-line 1)
8256 (setq link (format org-coderef-label-format label))
8257 (setq gc (- 79 (length link)))
8258 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8259 (insert link)
8260 (setq link (concat "(" label ")") desc nil)))
8262 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8263 ;; We are in the agenda, link to referenced location
8264 (let ((m (or (get-text-property (point) 'org-hd-marker)
8265 (get-text-property (point) 'org-marker))))
8266 (when m
8267 (org-with-point-at m
8268 (setq agenda-link
8269 (if (interactive-p)
8270 (call-interactively 'org-store-link)
8271 (org-store-link nil)))))))
8273 ((eq major-mode 'calendar-mode)
8274 (let ((cd (calendar-cursor-to-date)))
8275 (setq link
8276 (format-time-string
8277 (car org-time-stamp-formats)
8278 (apply 'encode-time
8279 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8280 nil nil nil))))
8281 (org-store-link-props :type "calendar" :date cd)))
8283 ((eq major-mode 'w3-mode)
8284 (setq cpltxt (if (and (buffer-name)
8285 (not (string-match "Untitled" (buffer-name))))
8286 (buffer-name)
8287 (url-view-url t))
8288 link (org-make-link (url-view-url t)))
8289 (org-store-link-props :type "w3" :url (url-view-url t)))
8291 ((eq major-mode 'w3m-mode)
8292 (setq cpltxt (or w3m-current-title w3m-current-url)
8293 link (org-make-link w3m-current-url))
8294 (org-store-link-props :type "w3m" :url (url-view-url t)))
8296 ((setq search (run-hook-with-args-until-success
8297 'org-create-file-search-functions))
8298 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8299 "::" search))
8300 (setq cpltxt (or description link)))
8302 ((eq major-mode 'image-mode)
8303 (setq cpltxt (concat "file:"
8304 (abbreviate-file-name buffer-file-name))
8305 link (org-make-link cpltxt))
8306 (org-store-link-props :type "image" :file buffer-file-name))
8308 ((eq major-mode 'dired-mode)
8309 ;; link to the file in the current line
8310 (let ((file (dired-get-filename nil t)))
8311 (setq file (if file
8312 (abbreviate-file-name
8313 (expand-file-name (dired-get-filename nil t)))
8314 ;; otherwise, no file so use current directory.
8315 default-directory))
8316 (setq cpltxt (concat "file:" file)
8317 link (org-make-link cpltxt))))
8319 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8320 (setq custom-id (ignore-errors (org-entry-get nil "CUSTOM_ID")))
8321 (cond
8323 (setq cpltxt
8324 (concat "file:"
8325 (abbreviate-file-name
8326 (buffer-file-name (buffer-base-buffer)))
8327 "::" (match-string 1))
8328 link (org-make-link cpltxt)))
8329 ((and (featurep 'org-id)
8330 (or (eq org-link-to-org-use-id t)
8331 (and (eq org-link-to-org-use-id 'create-if-interactive)
8332 (interactive-p))
8333 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
8334 (interactive-p)
8335 (not custom-id))
8336 (and org-link-to-org-use-id
8337 (condition-case nil
8338 (org-entry-get nil "ID")
8339 (error nil)))))
8340 ;; We can make a link using the ID.
8341 (setq link (condition-case nil
8342 (prog1 (org-id-store-link)
8343 (setq desc (plist-get org-store-link-plist
8344 :description)))
8345 (error
8346 ;; probably before first headline, link to file only
8347 (concat "file:"
8348 (abbreviate-file-name
8349 (buffer-file-name (buffer-base-buffer))))))))
8350 (t
8351 ;; Just link to current headline
8352 (setq cpltxt (concat "file:"
8353 (abbreviate-file-name
8354 (buffer-file-name (buffer-base-buffer)))))
8355 ;; Add a context search string
8356 (when (org-xor org-context-in-file-links arg)
8357 (setq txt (cond
8358 ((org-on-heading-p) nil)
8359 ((org-region-active-p)
8360 (buffer-substring (region-beginning) (region-end)))
8361 (t nil)))
8363 (setq cpltxt
8364 (concat cpltxt "::"
8365 (condition-case nil
8366 (org-make-org-heading-search-string txt)
8367 (error "")))
8368 desc (or (nth 4 (ignore-errors
8369 (org-heading-components))) "NONE"))))
8371 (setq cpltxt (substring cpltxt 0 -2)))
8372 (setq link (org-make-link cpltxt)))))
8374 ((buffer-file-name (buffer-base-buffer))
8375 ;; Just link to this file here.
8376 (setq cpltxt (concat "file:"
8377 (abbreviate-file-name
8378 (buffer-file-name (buffer-base-buffer)))))
8379 ;; Add a context string
8380 (when (org-xor org-context-in-file-links arg)
8381 (setq txt (if (org-region-active-p)
8382 (buffer-substring (region-beginning) (region-end))
8383 (buffer-substring (point-at-bol) (point-at-eol))))
8384 ;; Only use search option if there is some text.
8386 (setq cpltxt
8387 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8388 desc "NONE")))
8389 (setq link (org-make-link cpltxt)))
8391 ((interactive-p)
8392 (error "Cannot link to a buffer which is not visiting a file"))
8394 (t (setq link nil)))
8396 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8397 (setq link (or link cpltxt)
8398 desc (or desc cpltxt))
8399 (if (equal desc "NONE") (setq desc nil))
8401 (if (and (or (interactive-p) executing-kbd-macro) link)
8402 (progn
8403 (setq org-stored-links
8404 (cons (list link desc) org-stored-links))
8405 (message "Stored: %s" (or desc link))
8406 (when custom-id
8407 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8408 "::#" custom-id))
8409 (setq org-stored-links
8410 (cons (list link desc) org-stored-links))))
8411 (or agenda-link (and link (org-make-link-string link desc))))))
8413 (defun org-store-link-props (&rest plist)
8414 "Store link properties, extract names and addresses."
8415 (let (x adr)
8416 (when (setq x (plist-get plist :from))
8417 (setq adr (mail-extract-address-components x))
8418 (setq plist (plist-put plist :fromname (car adr)))
8419 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8420 (when (setq x (plist-get plist :to))
8421 (setq adr (mail-extract-address-components x))
8422 (setq plist (plist-put plist :toname (car adr)))
8423 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8424 (let ((from (plist-get plist :from))
8425 (to (plist-get plist :to)))
8426 (when (and from to org-from-is-user-regexp)
8427 (setq plist
8428 (plist-put plist :fromto
8429 (if (string-match org-from-is-user-regexp from)
8430 (concat "to %t")
8431 (concat "from %f"))))))
8432 (setq org-store-link-plist plist))
8434 (defun org-add-link-props (&rest plist)
8435 "Add these properties to the link property list."
8436 (let (key value)
8437 (while plist
8438 (setq key (pop plist) value (pop plist))
8439 (setq org-store-link-plist
8440 (plist-put org-store-link-plist key value)))))
8442 (defun org-email-link-description (&optional fmt)
8443 "Return the description part of an email link.
8444 This takes information from `org-store-link-plist' and formats it
8445 according to FMT (default from `org-email-link-description-format')."
8446 (setq fmt (or fmt org-email-link-description-format))
8447 (let* ((p org-store-link-plist)
8448 (to (plist-get p :toaddress))
8449 (from (plist-get p :fromaddress))
8450 (table
8451 (list
8452 (cons "%c" (plist-get p :fromto))
8453 (cons "%F" (plist-get p :from))
8454 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8455 (cons "%T" (plist-get p :to))
8456 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8457 (cons "%s" (plist-get p :subject))
8458 (cons "%m" (plist-get p :message-id)))))
8459 (when (string-match "%c" fmt)
8460 ;; Check if the user wrote this message
8461 (if (and org-from-is-user-regexp from to
8462 (save-match-data (string-match org-from-is-user-regexp from)))
8463 (setq fmt (replace-match "to %t" t t fmt))
8464 (setq fmt (replace-match "from %f" t t fmt))))
8465 (org-replace-escapes fmt table)))
8467 (defun org-make-org-heading-search-string (&optional string heading)
8468 "Make search string for STRING or current headline."
8469 (interactive)
8470 (let ((s (or string (org-get-heading))))
8471 (unless (and string (not heading))
8472 ;; We are using a headline, clean up garbage in there.
8473 (if (string-match org-todo-regexp s)
8474 (setq s (replace-match "" t t s)))
8476 (setq s (replace-match "" t t s)))
8477 (setq s (org-trim s))
8480 (setq s (replace-match "" t t s)))
8481 (while (string-match org-ts-regexp s)
8482 (setq s (replace-match "" t t s))))
8483 (or string (setq s (concat "*" s))) ; Add * for headlines
8486 (defun org-make-link (&rest strings)
8487 "Concatenate STRINGS."
8488 (apply 'concat strings))
8490 (defun org-make-link-string (link &optional description)
8491 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8493 (error "Empty link"))
8494 (when (and description
8495 (stringp description)
8497 (setq description nil))
8498 (when (stringp description)
8499 ;; Remove brackets from the description, they are fatal.
8501 (setq description (replace-match "{" t t description)))
8503 (setq description (replace-match "}" t t description))))
8504 (when (equal (org-link-escape link) description)
8505 ;; No description needed, it is identical
8506 (setq description nil))
8507 (when (and (not description)
8508 (not (equal link (org-link-escape link))))
8509 (setq description (org-extract-attributes link)))
8510 (setq link (if (string-match org-link-types-re link)
8511 (concat (match-string 1 link)
8512 (org-link-escape (substring link (match-end 1))))
8513 (org-link-escape link)))
8514 (concat "[[" link "]"
8515 (if description (concat "[" description "]") "")
8516 "]"))
8518 (defconst org-link-escape-chars
8519 '((?\ . "%20")
8520 (?\[ . "%5B")
8521 (?\] . "%5D")
8532 (?\; . "%3B")
8533 ;; (?? . "%3F")
8534 (?= . "%3D")
8535 (?+ . "%2B")
8536 )
8537 "Association list of escapes for some characters problematic in links.
8538 This is the list that is used for internal purposes.")
8540 (defvar org-url-encoding-use-url-hexify nil)
8542 (defconst org-link-escape-chars-browser
8543 '((?\ . "%20")) ; 32 for the SPC char
8544 "Association list of escapes for some characters problematic in links.
8545 This is the list that is used before handing over to the browser.")
8547 (defun org-link-escape (text &optional table)
8548 "Escape characters in TEXT that are problematic for links."
8549 (if (and org-url-encoding-use-url-hexify (not table))
8550 (url-hexify-string text)
8551 (setq table (or table org-link-escape-chars))
8552 (when text
8553 (let ((re (mapconcat (lambda (x) (regexp-quote
8554 (char-to-string (car x))))
8556 (while (string-match re text)
8557 (setq text
8558 (replace-match
8559 (cdr (assoc (string-to-char (match-string 0 text))
8560 table))
8561 t t text)))
8562 text))))
8564 (defun org-link-unescape (text &optional table)
8565 "Reverse the action of `org-link-escape'."
8566 (if (and org-url-encoding-use-url-hexify (not table))
8567 (url-unhex-string text)
8568 (setq table (or table org-link-escape-chars))
8569 (when text
8570 (let ((case-fold-search t)
8571 (re (mapconcat (lambda (x) (regexp-quote (downcase (cdr x))))
8573 (while (string-match re text)
8574 (setq text
8575 (replace-match
8576 (char-to-string (car (rassoc (upcase (match-string 0 text))
8577 table)))
8578 t t text)))
8579 text))))
8581 (defun org-xor (a b)
8582 "Exclusive or."
8583 (if a (not b) b))
8585 (defun org-fixup-message-id-for-http (s)
8586 "Replace special characters in a message id, so it can be used in an http query."
8587 (when (string-match "%" s)
8588 (setq s (mapconcat (lambda (c)
8589 (if (eq c ?%)
8590 "%25"
8591 (char-to-string c)))
8592 s "")))
8593 (while (string-match "<" s)
8594 (setq s (replace-match "%3C" t t s)))
8595 (while (string-match ">" s)
8596 (setq s (replace-match "%3E" t t s)))
8597 (while (string-match "@" s)
8598 (setq s (replace-match "%40" t t s)))
8599 s)
8601 ;;;###autoload
8602 (defun org-insert-link-global ()
8603 "Insert a link like Org-mode does.
8604 This command can be called in any mode to insert a link in Org-mode syntax."
8605 (interactive)
8606 (org-load-modules-maybe)
8607 (org-run-like-in-org-mode 'org-insert-link))
8609 (defun org-insert-link (&optional complete-file link-location)
8610 "Insert a link. At the prompt, enter the link.
8612 Completion can be used to insert any of the link protocol prefixes like
8613 http or ftp in use.
8615 The history can be used to select a link previously stored with
8616 `org-store-link'. When the empty string is entered (i.e. if you just
8617 press RET at the prompt), the link defaults to the most recently
8618 stored link. As SPC triggers completion in the minibuffer, you need to
8619 use M-SPC or C-q SPC to force the insertion of a space character.
8621 You will also be prompted for a description, and if one is given, it will
8622 be displayed in the buffer instead of the link.
8624 If there is already a link at point, this command will allow you to edit link
8625 and description parts.
8628 be selected using completion. The path to the file will be relative to the
8629 current directory if the file is in the current directory or a subdirectory.
8630 Otherwise, the link will be the absolute path as completed in the minibuffer
8631 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8632 option `org-link-file-path-type'.
8635 the current directory or below.
8638 `org-keep-stored-link-after-insertion'.
8640 If `org-make-link-description-function' is non-nil, this function will be
8641 called with the link target, and the result will be the default
8642 link description.
8644 If the LINK-LOCATION parameter is non-nil, this value will be
8645 used as the link location instead of reading one interactively."
8646 (interactive "P")
8647 (let* ((wcf (current-window-configuration))
8648 (region (if (org-region-active-p)
8649 (buffer-substring (region-beginning) (region-end))))
8650 (remove (and region (list (region-beginning) (region-end))))
8651 (desc region)
8652 tmphist ; byte-compile incorrectly complains about this
8653 (link link-location)
8654 entry file all-prefixes)
8655 (cond
8656 (link-location) ; specified by arg, just use it.
8657 ((org-in-regexp org-bracket-link-regexp 1)
8658 ;; We do have a link at point, and we are going to edit it.
8659 (setq remove (list (match-beginning 0) (match-end 0)))
8660 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8661 (setq link (read-string "Link: "
8662 (org-link-unescape
8663 (org-match-string-no-properties 1)))))
8664 ((or (org-in-regexp org-angle-link-re)
8665 (org-in-regexp org-plain-link-re))
8666 ;; Convert to bracket link
8667 (setq remove (list (match-beginning 0) (match-end 0))
8668 link (read-string "Link: "
8669 (org-remove-angle-brackets (match-string 0)))))
8670 ((member complete-file '((4) (16)))
8671 ;; Completing read for file names.
8672 (setq link (org-file-complete-link complete-file)))
8673 (t
8674 ;; Read link, with completion for stored links.
8675 (with-output-to-temp-buffer "*Org Links*"
8676 (princ "Insert a link.
8678 (when org-stored-links
8680 (princ (mapconcat
8681 (lambda (x)
8682 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8684 (let ((cw (selected-window)))
8685 (select-window (get-buffer-window "*Org Links*" 'visible))
8686 (setq truncate-lines t)
8687 (unless (pos-visible-in-window-p (point-max))
8688 (org-fit-window-to-buffer))
8689 (and (window-live-p cw) (select-window cw)))
8690 ;; Fake a link history, containing the stored links.
8691 (setq tmphist (append (mapcar 'car org-stored-links)
8692 org-insert-link-history))
8693 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8694 (mapcar 'car org-link-abbrev-alist)
8695 org-link-types))
8696 (unwind-protect
8697 (progn
8698 (setq link
8699 (let ((org-completion-use-ido nil)
8700 (org-completion-use-iswitchb nil))
8701 (org-completing-read
8702 "Link: "
8703 (append
8704 (mapcar (lambda (x) (list (concat x ":")))
8705 all-prefixes)
8706 (mapcar 'car org-stored-links))
8707 nil nil nil
8708 'tmphist
8709 (car (car org-stored-links)))))
8711 (error "No link selected"))
8712 (if (or (member link all-prefixes)
8713 (and (equal ":" (substring link -1))
8714 (member (substring link 0 -1) all-prefixes)
8715 (setq link (substring link 0 -1))))
8716 (setq link (org-link-try-special-completion link))))
8717 (set-window-configuration wcf)
8718 (kill-buffer "*Org Links*"))
8719 (setq entry (assoc link org-stored-links))
8720 (or entry (push link org-insert-link-history))
8721 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8722 (not org-keep-stored-link-after-insertion))
8723 (setq org-stored-links (delq (assoc link org-stored-links)
8724 org-stored-links)))
8725 (setq desc (or desc (nth 1 entry)))))
8727 (if (string-match org-plain-link-re link)
8728 ;; URL-like link, normalize the use of angular brackets.
8729 (setq link (org-make-link (org-remove-angle-brackets link))))
8731 ;; Check if we are linking to the current file with a search option
8732 ;; If yes, simplify the link by using only the search option.
8733 (when (and buffer-file-name
8735 (let* ((path (match-string 1 link))
8736 (case-fold-search nil)
8737 (search (match-string 2 link)))
8738 (save-match-data
8739 (if (equal (file-truename buffer-file-name) (file-truename path))
8740 ;; We are linking to this same file, with a search option
8741 (setq link search)))))
8743 ;; Check if we can/should use a relative path. If yes, simplify the link
8745 (let* ((type (match-string 1 link))
8746 (path (match-string 2 link))
8747 (origpath path)
8748 (case-fold-search nil))
8749 (cond
8750 ((or (eq org-link-file-path-type 'absolute)
8751 (equal complete-file '(16)))
8752 (setq path (abbreviate-file-name (expand-file-name path))))
8753 ((eq org-link-file-path-type 'noabbrev)
8754 (setq path (expand-file-name path)))
8755 ((eq org-link-file-path-type 'relative)
8756 (setq path (file-relative-name path)))
8757 (t
8758 (save-match-data
8759 (if (string-match (concat "^" (regexp-quote
8760 (expand-file-name
8761 (file-name-as-directory
8762 default-directory))))
8763 (expand-file-name path))
8764 ;; We are linking a file with relative path name.
8765 (setq path (substring (expand-file-name path)
8766 (match-end 0)))
8767 (setq path (abbreviate-file-name (expand-file-name path)))))))
8768 (setq link (concat type path))
8769 (if (equal desc origpath)
8770 (setq desc path))))
8772 (if org-make-link-description-function
8773 (setq desc (funcall org-make-link-description-function link desc)))
8775 (setq desc (read-string "Description: " desc))
8777 (if remove (apply 'delete-region remove))
8778 (insert (org-make-link-string link desc))))
8780 (defun org-link-try-special-completion (type)
8781 "If there is completion support for link type TYPE, offer it."
8782 (let ((fun (intern (concat "org-" type "-complete-link"))))
8783 (if (functionp fun)
8784 (funcall fun)
8785 (read-string "Link (no completion support): " (concat type ":")))))
8787 (defun org-file-complete-link (&optional arg)
8788 "Create a file link using completion."
8789 (let (file link)
8790 (setq file (read-file-name "File: "))
8791 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8792 (pwd1 (file-name-as-directory (abbreviate-file-name
8793 (expand-file-name ".")))))
8794 (cond
8795 ((equal arg '(16))
8796 (setq link (org-make-link
8797 "file:"
8798 (abbreviate-file-name (expand-file-name file)))))
8800 (setq link (org-make-link "file:" (match-string 1 file))))
8802 (expand-file-name file))
8803 (setq link (org-make-link
8804 "file:" (match-string 1 (expand-file-name file)))))
8805 (t (setq link (org-make-link "file:" file)))))
8806 link))
8808 (defun org-completing-read (&rest args)
8809 "Completing-read with SPACE being a normal character."
8810 (let ((minibuffer-local-completion-map
8811 (copy-keymap minibuffer-local-completion-map)))
8812 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
8813 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
8814 (apply 'org-icompleting-read args)))
8816 (defun org-completing-read-no-i (&rest args)
8817 (let (org-completion-use-ido org-completion-use-iswitchb)
8818 (apply 'org-completing-read args)))
8820 (defun org-iswitchb-completing-read (prompt choices &rest args)
8821 "Use iswitch as a completing-read replacement to choose from choices.
8822 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
8823 from."
8824 (let* ((iswitchb-use-virtual-buffers nil)
8825 (iswitchb-make-buflist-hook
8826 (lambda ()
8827 (setq iswitchb-temp-buflist choices))))
8828 (iswitchb-read-buffer prompt)))
8830 (defun org-icompleting-read (&rest args)
8831 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
8832 (org-without-partial-completion
8833 (if (and org-completion-use-ido
8834 (fboundp 'ido-completing-read)
8835 (boundp 'ido-mode) ido-mode
8836 (listp (second args)))
8837 (let ((ido-enter-matching-directory nil))
8838 (apply 'ido-completing-read (concat (car args))
8839 (if (consp (car (nth 1 args)))
8840 (mapcar (lambda (x) (car x)) (nth 1 args))
8841 (nth 1 args))
8842 (cddr args)))
8843 (if (and org-completion-use-iswitchb
8844 (boundp 'iswitchb-mode) iswitchb-mode
8845 (listp (second args)))
8846 (apply 'org-iswitchb-completing-read (concat (car args))
8847 (if (consp (car (nth 1 args)))
8848 (mapcar (lambda (x) (car x)) (nth 1 args))
8849 (nth 1 args))
8850 (cddr args))
8851 (apply 'completing-read args)))))
8853 (defun org-extract-attributes (s)
8854 "Extract the attributes cookie from a string and set as text property."
8855 (let (a attr (start 0) key value)
8856 (save-match-data
8858 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
8860 (setq key (match-string 1 a) value (match-string 2 a)
8861 start (match-end 0)
8862 attr (plist-put attr (intern key) value))))
8863 (org-add-props s nil 'org-attr attr))
8864 s))
8866 (defun org-extract-attributes-from-string (tag)
8867 (let (key value attr)
8869 (setq key (match-string 1 tag) value (match-string 2 tag)
8870 tag (replace-match "" t t tag)
8871 attr (plist-put attr (intern key) value)))
8872 (cons tag attr)))
8874 (defun org-attributes-to-string (plist)
8875 "Format a property list into an HTML attribute list."
8876 (let ((s "") key value)
8877 (while plist
8878 (setq key (pop plist) value (pop plist))
8879 (and value
8881 s))
8883 ;;; Opening/following a link
8885 (defvar org-link-search-failed nil)
8887 (defvar org-open-link-functions nil
8888 "Hook for functions finding a plain text link.
8889 These functions must take a single argument, the link content.
8890 They will be called for links that look like [[link text][description]]
8894 These functions will be called *before* Org attempts to resolve the
8895 link by doing text searches in the current buffer - so if you want a
8897 handle this as a special case.
8899 When the function does handle the link, it must return a non-nil value.
8900 If it decides that it is not responsible for this link, it must return
8901 nil to indicate that that Org-mode can continue with other options
8902 like exact and fuzzy text search.")
8904 (defun org-next-link ()
8905 "Move forward to the next link.
8906 If the link is in hidden text, expose it."
8907 (interactive)
8908 (when (and org-link-search-failed (eq this-command last-command))
8909 (goto-char (point-min))
8910 (message "Link search wrapped back to beginning of buffer"))
8911 (setq org-link-search-failed nil)
8912 (let* ((pos (point))
8913 (ct (org-context))
8914 (a (assoc :link ct)))
8915 (if a (goto-char (nth 2 a)))
8916 (if (re-search-forward org-any-link-re nil t)
8917 (progn
8918 (goto-char (match-beginning 0))
8919 (if (org-invisible-p) (org-show-context)))
8920 (goto-char pos)
8921 (setq org-link-search-failed t)
8922 (error "No further link found"))))
8924 (defun org-previous-link ()
8925 "Move backward to the previous link.
8926 If the link is in hidden text, expose it."
8927 (interactive)
8928 (when (and org-link-search-failed (eq this-command last-command))
8929 (goto-char (point-max))
8930 (message "Link search wrapped back to end of buffer"))
8931 (setq org-link-search-failed nil)
8932 (let* ((pos (point))
8933 (ct (org-context))
8934 (a (assoc :link ct)))
8935 (if a (goto-char (nth 1 a)))
8936 (if (re-search-backward org-any-link-re nil t)
8937 (progn
8938 (goto-char (match-beginning 0))
8939 (if (org-invisible-p) (org-show-context)))
8940 (goto-char pos)
8941 (setq org-link-search-failed t)
8942 (error "No further link found"))))
8944 (defun org-translate-link (s)
8945 "Translate a link string if a translation function has been defined."
8946 (if (and org-link-translation-function
8947 (fboundp org-link-translation-function)
8949 (progn
8950 (setq s (funcall org-link-translation-function
8951 (match-string 1) (match-string 2)))
8952 (concat (car s) ":" (cdr s)))
8953 s))
8955 (defun org-translate-link-from-planner (type path)
8956 "Translate a link from Emacs Planner syntax so that Org can follow it.
8957 This is still an experimental function, your mileage may vary."
8958 (cond
8959 ((member type '("http" "https" "news" "ftp"))
8960 ;; standard Internet links are the same.
8961 nil)
8962 ((and (equal type "irc") (string-match "^//" path))
8963 ;; Planner has two / at the beginning of an irc link, we have 1.
8964 ;; We should have zero, actually....
8965 (setq path (substring path 1)))
8966 ((and (equal type "lisp") (string-match "^/" path))
8967 ;; Planner has a slash, we do not.
8968 (setq type "elisp" path (substring path 1)))
8970 ;; A typical message link. Planner has the id after the final slash,
8971 ;; we separate it with a hash mark
8972 (setq path (concat (match-string 1 path) "#"
8973 (org-remove-angle-brackets (match-string 2 path)))))
8974 )
8975 (cons type path))
8977 (defun org-find-file-at-mouse (ev)
8978 "Open file link or URL at mouse."
8979 (interactive "e")
8980 (mouse-set-point ev)
8981 (org-open-at-point 'in-emacs))
8983 (defun org-open-at-mouse (ev)
8984 "Open file link or URL at mouse."
8985 (interactive "e")
8986 (mouse-set-point ev)
8987 (if (eq major-mode 'org-agenda-mode)
8988 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
8989 (org-open-at-point))
8991 (defvar org-window-config-before-follow-link nil
8992 "The window configuration before following a link.
8993 This is saved in case the need arises to restore it.")
8995 (defvar org-open-link-marker (make-marker)
8996 "Marker pointing to the location where `org-open-at-point; was called.")
8998 ;;;###autoload
8999 (defun org-open-at-point-global ()
9000 "Follow a link like Org-mode does.
9001 This command can be called in any mode to follow a link that has
9002 Org-mode syntax."
9003 (interactive)
9004 (org-run-like-in-org-mode 'org-open-at-point))
9006 ;;;###autoload
9007 (defun org-open-link-from-string (s &optional arg reference-buffer)
9008 "Open a link in the string S, as if it was in Org-mode."
9010 (let ((reference-buffer (or reference-buffer (current-buffer))))
9011 (with-temp-buffer
9012 (let ((org-inhibit-startup t))
9013 (org-mode)
9014 (insert s)
9015 (goto-char (point-min))
9016 (when reference-buffer
9017 (setq org-link-abbrev-alist-local
9018 (with-current-buffer reference-buffer
9019 org-link-abbrev-alist-local)))
9020 (org-open-at-point arg reference-buffer)))))
9022 (defvar org-open-at-point-functions nil
9023 "Hook that is run when following a link at point.
9025 Functions in this hook must return t if they identify and follow
9026 a link at point. If they don't find anything interesting at point,
9027 they must return nil.")
9029 (defun org-open-at-point (&optional in-emacs reference-buffer)
9030 "Open link at or after point.
9031 If there is no link at point, this function will search forward up to
9032 the end of the current line.
9033 Normally, files will be opened by an appropriate application. If the
9034 optional argument IN-EMACS is non-nil, Emacs will visit the file.
9035 With a double prefix argument, try to open outside of Emacs, in the
9036 application the system uses for this file type."
9037 (interactive "P")
9038 ;; if in a code block, then open the block's results
9039 (unless (call-interactively #'org-babel-open-src-block-result)
9040 (org-load-modules-maybe)
9041 (move-marker org-open-link-marker (point))
9042 (setq org-window-config-before-follow-link (current-window-configuration))
9043 (org-remove-occur-highlights nil nil t)
9044 (cond
9045 ((and (org-on-heading-p)
9046 (not (org-in-regexp
9051 (not (get-text-property (point) 'org-linked-text)))
9052 (or (org-offer-links-in-entry in-emacs)
9053 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9054 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9055 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9056 ((or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9057 (org-footnote-action))
9058 (t
9059 (let (type path link line search (pos (point)))
9060 (catch 'match
9061 (save-excursion
9063 (when (org-in-regexp org-bracket-link-regexp 1)
9064 (setq link (org-extract-attributes
9065 (org-link-unescape (org-match-string-no-properties 1))))
9067 (setq link (replace-match " " t t link)))
9068 (setq link (org-link-expand-abbrev link))
9069 (cond
9070 ((or (file-name-absolute-p link)
9072 (setq type "file" path link))
9073 ((string-match org-link-re-with-space3 link)
9074 (setq type (match-string 1 link) path (match-string 2 link)))
9075 (t (setq type "thisfile" path link)))
9076 (throw 'match t)))
9078 (when (get-text-property (point) 'org-linked-text)
9079 (setq type "thisfile"
9080 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9081 (1+ (point)) (point))
9082 path (buffer-substring
9083 (previous-single-property-change pos 'org-linked-text)
9084 (next-single-property-change pos 'org-linked-text)))
9085 (throw 'match t))
9087 (save-excursion
9088 (when (or (org-in-regexp org-angle-link-re)
9089 (org-in-regexp org-plain-link-re))
9090 (setq type (match-string 1) path (match-string 2))
9091 (throw 'match t)))
9092 (save-excursion
9094 (setq type "tags"
9095 path (match-string 1))
9096 (while (string-match ":" path)
9097 (setq path (replace-match "+" t t path)))
9098 (throw 'match t)))
9100 (setq type "tree-match"
9101 path (match-string 1))
9102 (throw 'match t)))
9103 (unless path
9104 (error "No link found"))
9106 ;; switch back to reference buffer
9107 ;; needed when if called in a temporary buffer through
9108 ;; org-open-link-from-string
9109 (with-current-buffer (or reference-buffer (current-buffer))
9111 ;; Remove any trailing spaces in path
9113 (setq path (replace-match "" t t path)))
9114 (if (and org-link-translation-function
9115 (fboundp org-link-translation-function))
9116 ;; Check if we need to translate the link
9117 (let ((tmp (funcall org-link-translation-function type path)))
9118 (setq type (car tmp) path (cdr tmp))))
9120 (cond
9122 ((assoc type org-link-protocols)
9123 (funcall (nth 1 (assoc type org-link-protocols)) path))
9125 ((equal type "mailto")
9126 (let ((cmd (car org-link-mailto-program))
9127 (args (cdr org-link-mailto-program)) args1
9128 (address path) (subject "") a)
9130 (setq address (match-string 1 path)
9131 subject (org-link-escape (match-string 2 path))))
9132 (while args
9133 (cond
9134 ((not (stringp (car args))) (push (pop args) args1))
9135 (t (setq a (pop args))
9136 (if (string-match "%a" a)
9137 (setq a (replace-match address t t a)))
9138 (if (string-match "%s" a)
9139 (setq a (replace-match subject t t a)))
9140 (push a args1))))
9141 (apply cmd (nreverse args1))))
9143 ((member type '("http" "https" "ftp" "news"))
9144 (browse-url (concat type ":" (org-link-escape
9145 path org-link-escape-chars-browser))))
9147 ((string= type "doi")
9148 (browse-url (concat "http://dx.doi.org/"
9149 (org-link-escape
9150 path org-link-escape-chars-browser))))
9152 ((member type '("message"))
9153 (browse-url (concat type ":" path)))
9155 ((string= type "tags")
9156 (org-tags-view in-emacs path))
9158 ((string= type "tree-match")
9161 ((string= type "file")
9163 (setq line (string-to-number (match-string 1 path))
9164 path (substring path 0 (match-beginning 0)))
9166 (setq search (match-string 1 path)
9167 path (substring path 0 (match-beginning 0)))))
9168 (if (string-match "[*?{]" (file-name-nondirectory path))
9169 (dired path)
9170 (org-open-file path in-emacs line search)))
9172 ((string= type "news")
9173 (require 'org-gnus)
9174 (org-gnus-follow-link path))
9176 ((string= type "shell")
9177 (let ((cmd path))
9178 (if (or (not org-confirm-shell-link-function)
9179 (funcall org-confirm-shell-link-function
9181 (org-add-props cmd nil
9182 'face 'org-warning))))
9183 (progn
9184 (message "Executing %s" cmd)
9185 (shell-command cmd))
9186 (error "Abort"))))
9188 ((string= type "elisp")
9189 (let ((cmd path))
9190 (if (or (not org-confirm-elisp-link-function)
9191 (funcall org-confirm-elisp-link-function
9193 (org-add-props cmd nil
9194 'face 'org-warning))))
9195 (message "%s => %s" cmd
9196 (if (equal (string-to-char cmd) ?\()
9197 (eval (read cmd))
9198 (call-interactively (read cmd))))
9199 (error "Abort"))))
9201 ((and (string= type "thisfile")
9202 (run-hook-with-args-until-success
9203 'org-open-link-functions path)))
9205 ((string= type "thisfile")
9206 (if in-emacs
9207 (switch-to-buffer-other-window
9208 (org-get-buffer-for-internal-link (current-buffer)))
9209 (org-mark-ring-push))
9210 (let ((cmd `(org-link-search
9211 ,path
9212 ,(cond ((equal in-emacs '(4)) 'occur)
9213 ((equal in-emacs '(16)) 'org-occur)
9214 (t nil))
9215 ,pos)))
9216 (condition-case nil (eval cmd)
9217 (error (progn (widen) (eval cmd))))))
9219 (t
9220 (browse-url-at-point)))))))
9221 (move-marker org-open-link-marker nil)
9222 (run-hook-with-args 'org-follow-link-hook)))
9224 (defun org-offer-links-in-entry (&optional nth zero)
9225 "Offer links in the current entry and follow the selected link.
9226 If there is only one link, follow it immediately as well.
9227 If NTH is an integer, immediately pick the NTH link found.
9228 If ZERO is a string, check also this string for a link, and if
9229 there is one, offer it as link number zero."
9233 (cnt ?0)
9234 (in-emacs (if (integerp nth) nil nth))
9235 have-zero end links link c)
9236 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9237 (push (match-string 0 zero) links)
9238 (setq cnt (1- cnt) have-zero t))
9239 (save-excursion
9240 (org-back-to-heading t)
9241 (setq end (save-excursion (outline-next-heading) (point)))
9242 (while (re-search-forward re end t)
9243 (push (match-string 0) links))
9244 (setq links (org-uniquify (reverse links))))
9246 (cond
9247 ((null links)
9248 (message "No links"))
9249 ((equal (length links) 1)
9250 (setq link (list (car links))))
9251 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9252 (setq link (nth (if have-zero nth (1- nth)) links)))
9253 (t ; we have to select a link
9254 (save-excursion
9255 (save-window-excursion
9256 (delete-other-windows)
9257 (with-output-to-temp-buffer "*Select Link*"
9258 (mapc (lambda (l)
9259 (if (not (string-match org-bracket-link-regexp l))
9261 (org-remove-angle-brackets l)))
9262 (if (match-end 3)
9264 (match-string 3 l) (match-string 1 l)))
9266 (match-string 1 l))))))
9267 links))
9268 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9269 (message "Select link to open, RET to open all:")
9270 (setq c (read-char-exclusive))
9271 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9272 (when (equal c ?q) (error "Abort"))
9273 (if (equal c ?\C-m)
9274 (setq link links)
9275 (setq nth (- c ?0))
9276 (if have-zero (setq nth (1+ nth)))
9277 (unless (and (integerp nth) (>= (length links) nth))
9278 (error "Invalid link selection"))
9279 (setq link (list (nth (1- nth) links))))))
9280 (if link
9281 (let ((buf (current-buffer)))
9282 (dolist (l link)
9283 (org-open-link-from-string l in-emacs buf))
9284 t)
9285 nil)))
9287 ;; Add special file links that specify the way of opening
9289 (org-add-link-type "file+sys" 'org-open-file-with-system)
9290 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9291 (defun org-open-file-with-system (path)
9292 "Open file at PATH using the system way of opening it."
9293 (org-open-file path 'system))
9294 (defun org-open-file-with-emacs (path)
9295 "Open file at PATH in Emacs."
9296 (org-open-file path 'emacs))
9297 (defun org-remove-file-link-modifiers ()
9298 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9299 (goto-char (point-min))
9301 (org-if-unprotected
9302 (replace-match "file:" t t))))
9303 (eval-after-load "org-exp"
9304 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9305 'org-remove-file-link-modifiers))
9307 ;;;; Time estimates
9309 (defun org-get-effort (&optional pom)
9310 "Get the effort estimate for the current entry."
9311 (org-entry-get pom org-effort-property))
9313 ;;; File search
9315 (defvar org-create-file-search-functions nil
9316 "List of functions to construct the right search string for a file link.
9317 These functions are called in turn with point at the location to
9318 which the link should point.
9320 A function in the hook should first test if it would like to
9321 handle this file type, for example by checking the `major-mode'
9322 or the file extension. If it decides not to handle this file, it
9323 should just return nil to give other functions a chance. If it
9324 does handle the file, it must return the search string to be used
9325 when following the link. The search string will be part of the
9326 file link, given after a double colon, and `org-open-at-point'
9327 will automatically search for it. If special measures must be
9328 taken to make the search successful, another function should be
9329 added to the companion hook `org-execute-file-search-functions',
9330 which see.
9332 A function in this hook may also use `setq' to set the variable
9333 `description' to provide a suggestion for the descriptive text to
9334 be used for this link when it gets inserted into an Org-mode
9337 (defvar org-execute-file-search-functions nil
9338 "List of functions to execute a file search triggered by a link.
9340 Functions added to this hook must accept a single argument, the
9341 search string that was part of the file link, the part after the
9342 double colon. The function must first check if it would like to
9343 handle this search, for example by checking the `major-mode' or
9344 the file extension. If it decides not to handle this search, it
9345 should just return nil to give other functions a chance. If it
9346 does handle the search, it must return a non-nil value to keep
9347 other functions from trying.
9349 Each function can access the current prefix argument through the
9350 variable `current-prefix-argument'. Note that a single prefix is
9351 used to force opening a link in Emacs, so it may be good to only
9352 use a numeric or double prefix to guide the search function.
9354 In case this is needed, a function in this hook can also restore
9355 the window configuration before `org-open-at-point' was called using:
9357 (set-window-configuration org-window-config-before-follow-link)")
9359 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9360 (defun org-link-search (s &optional type avoid-pos)
9361 "Search for a link search option.
9362 If S is surrounded by forward slashes, it is interpreted as a
9363 regular expression. In org-mode files, this will create an `org-occur'
9364 sparse tree. In ordinary files, `occur' will be used to list matches.
9365 If the current buffer is in `dired-mode', grep will be used to search
9366 in all files. If AVOID-POS is given, ignore matches near that position."
9367 (let ((case-fold-search t)
9371 org-emphasis-alist)
9373 (pos (point))
9374 (pre nil) (post nil)
9375 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9376 (cond
9377 ;; First check if there are any special search functions
9378 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9379 ;; Now try the builtin stuff
9380 ((and (equal (string-to-char s0) ?#)
9381 (> (length s0) 1)
9382 (save-excursion
9383 (goto-char (point-min))
9384 (and
9385 (re-search-forward
9387 (setq type 'dedicated
9388 pos (match-beginning 0))))
9389 ;; There is an exact target for this
9390 (goto-char pos)
9391 (org-back-to-heading t)))
9392 ((save-excursion
9393 (goto-char (point-min))
9394 (and
9395 (re-search-forward
9396 (concat "<<" (regexp-quote s0) ">>") nil t)
9397 (setq type 'dedicated
9398 pos (match-beginning 0))))
9399 ;; There is an exact target for this
9400 (goto-char pos))
9402 (save-excursion
9403 (goto-char (point-min))
9404 (and
9405 (re-search-forward
9406 (concat "[^[]" (regexp-quote
9407 (format org-coderef-label-format
9408 (match-string 1 s0))))
9409 nil t)
9410 (setq type 'dedicated
9411 pos (1+ (match-beginning 0))))))
9412 ;; There is a coderef target for this
9413 (goto-char pos))
9415 ;; A regular expression
9416 (cond
9417 ((org-mode-p)
9418 (org-occur (match-string 1 s)))
9419 ;;((eq major-mode 'dired-mode)
9420 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9421 (t (org-do-occur (match-string 1 s)))))
9422 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9423 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9424 (goto-char (point-min))
9425 (cond
9426 ((let (case-fold-search)
9427 (re-search-forward (format org-complex-heading-regexp-format
9428 (regexp-quote s))
9429 nil t))
9430 ;; OK, found a match
9431 (setq type 'dedicated)
9432 (goto-char (match-beginning 0)))
9433 ((and (not org-link-search-inhibit-query)
9434 (eq org-link-search-must-match-exact-headline 'query-to-create)
9435 (y-or-n-p "No match - create this as a new heading? "))
9436 (goto-char (point-max))
9437 (or (bolp) (newline))
9439 (beginning-of-line 0))
9440 (t
9441 (goto-char pos)
9442 (error "No match"))))
9443 (t
9444 ;; A normal search string
9445 (when (equal (string-to-char s) ?*)
9446 ;; Anchor on headlines, post may include tags.
9449 s (substring s 1)))
9450 (remove-text-properties
9451 0 (length s)
9452 '(face nil mouse-face nil keymap nil fontified nil) s)
9453 ;; Make a series of regular expressions to find a match
9462 re4 (concat "[^a-zA-Z_]" re4_)
9464 re1 (concat pre re2 post)
9465 re3 (concat pre (if pre re4_ re4) post)
9466 re5 (concat pre ".*" re4)
9467 re2 (concat pre re2)
9468 re2a (concat pre (if pre re2a_ re2a))
9469 re4 (concat pre (if pre re4_ re4))
9473 ))
9474 (cond
9475 ((eq type 'org-occur) (org-occur reall))
9476 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9477 (t (goto-char (point-min))
9478 (setq type 'fuzzy)
9479 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9480 (org-search-not-self 1 re1 nil t)
9481 (org-search-not-self 1 re2 nil t)
9482 (org-search-not-self 1 re2a nil t)
9483 (org-search-not-self 1 re3 nil t)
9484 (org-search-not-self 1 re4 nil t)
9485 (org-search-not-self 1 re5 nil t)
9486 )
9487 (goto-char (match-beginning 1))
9488 (goto-char pos)
9489 (error "No match"))))))
9490 (and (org-mode-p) (org-show-context 'link-search))
9491 type))
9493 (defun org-search-not-self (group &rest args)
9494 "Execute `re-search-forward', but only accept matches that do not
9495 enclose the position of `org-open-link-marker'."
9496 (let ((m org-open-link-marker))
9497 (catch 'exit
9498 (while (apply 're-search-forward args)
9499 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9500 (goto-char (match-end group))
9501 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9502 (> (match-beginning 0) (marker-position m))
9503 (< (match-end 0) (marker-position m)))
9504 (save-match-data
9505 (or (not (org-in-regexp
9506 org-bracket-link-analytic-regexp 1))
9507 (not (match-end 4)) ; no description
9508 (and (<= (match-beginning 4) (point))
9509 (>= (match-end 4) (point))))))
9510 (throw 'exit (point))))))))
9512 (defun org-get-buffer-for-internal-link (buffer)
9513 "Return a buffer to be used for displaying the link target of internal links."
9514 (cond
9515 ((not org-display-internal-link-with-indirect-buffer)
9516 buffer)
9517 ((string-match "(Clone)$" (buffer-name buffer))
9518 (message "Buffer is already a clone, not making another one")
9519 ;; we also do not modify visibility in this case
9520 buffer)
9521 (t ; make a new indirect buffer for displaying the link
9522 (let* ((bn (buffer-name buffer))
9523 (ibn (concat bn "(Clone)"))
9524 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9525 (with-current-buffer ib (org-overview))
9526 ib))))
9528 (defun org-do-occur (regexp &optional cleanup)
9529 "Call the Emacs command `occur'.
9530 If CLEANUP is non-nil, remove the printout of the regular expression
9531 in the *Occur* buffer. This is useful if the regex is long and not useful
9532 to read."
9533 (occur regexp)
9534 (when cleanup
9535 (let ((cwin (selected-window)) win beg end)
9536 (when (setq win (get-buffer-window "*Occur*"))
9537 (select-window win))
9538 (goto-char (point-min))
9539 (when (re-search-forward "match[a-z]+" nil t)
9540 (setq beg (match-end 0))
9542 (setq end (1- (match-beginning 0)))))
9543 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9544 (goto-char (point-min))
9545 (select-window cwin))))
9547 ;;; The mark ring for links jumps
9549 (defvar org-mark-ring nil
9550 "Mark ring for positions before jumps in Org-mode.")
9551 (defvar org-mark-ring-last-goto nil
9552 "Last position in the mark ring used to go back.")
9553 ;; Fill and close the ring
9554 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9555 (loop for i from 1 to org-mark-ring-length do
9556 (push (make-marker) org-mark-ring))
9557 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9558 org-mark-ring)
9560 (defun org-mark-ring-push (&optional pos buffer)
9561 "Put the current position or POS into the mark ring and rotate it."
9562 (interactive)
9563 (setq pos (or pos (point)))
9564 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9565 (move-marker (car org-mark-ring)
9566 (or pos (point))
9567 (or buffer (current-buffer)))
9568 (message "%s"
9569 (substitute-command-keys
9572 (defun org-mark-ring-goto (&optional n)
9573 "Jump to the previous position in the mark ring.
9574 With prefix arg N, jump back that many stored positions. When
9575 called several times in succession, walk through the entire ring.
9576 Org-mode commands jumping to a different position in the current file,
9577 or to another Org-mode file, automatically push the old position
9578 onto the ring."
9579 (interactive "p")
9580 (let (p m)
9581 (if (eq last-command this-command)
9582 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9583 (setq p org-mark-ring))
9584 (setq org-mark-ring-last-goto p)
9585 (setq m (car p))
9586 (switch-to-buffer (marker-buffer m))
9587 (goto-char m)
9588 (if (or (org-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9590 (defun org-remove-angle-brackets (s)
9591 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9592 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9593 s)
9594 (defun org-add-angle-brackets (s)
9595 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9596 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9597 s)
9598 (defun org-remove-double-quotes (s)
9601 s)
9603 ;;; Following specific links
9605 (defun org-follow-timestamp-link ()
9606 (cond
9607 ((org-at-date-range-p t)
9608 (let ((org-agenda-start-on-weekday)
9609 (t1 (match-string 1))
9610 (t2 (match-string 2)))
9611 (setq t1 (time-to-days (org-time-string-to-time t1))
9612 t2 (time-to-days (org-time-string-to-time t2)))
9613 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9614 ((org-at-timestamp-p t)
9615 (org-agenda-list nil (time-to-days (org-time-string-to-time
9616 (substring (match-string 1) 0 10)))
9617 1))
9618 (t (error "This should not happen"))))
9621 ;;; Following file links
9622 (defvar org-wait nil)
9623 (defun org-open-file (path &optional in-emacs line search)
9624 "Open the file at PATH.
9625 First, this expands any special file name abbreviations. Then the
9626 configuration variable `org-file-apps' is checked if it contains an
9627 entry for this file type, and if yes, the corresponding command is launched.
9629 If no application is found, Emacs simply visits the file.
9631 With optional prefix argument IN-EMACS, Emacs will visit the file.
9633 prefix arg, Org tries to avoid opening in Emacs
9634 and to use an external application to visit the file.
9636 Optional LINE specifies a line to go to, optional SEARCH a string
9637 to search for. If LINE or SEARCH is given, the file will be
9638 opened in Emacs, unless an entry from org-file-apps that makes
9639 use of groups in a regexp matches.
9640 If the file does not exist, an error is thrown."
9641 (let* ((file (if (equal path "")
9642 buffer-file-name
9643 (substitute-in-file-name (expand-file-name path))))
9644 (file-apps (append org-file-apps (org-default-apps)))
9645 (apps (org-remove-if
9646 'org-file-apps-entry-match-against-dlink-p file-apps))
9647 (apps-dlink (org-remove-if-not
9648 'org-file-apps-entry-match-against-dlink-p file-apps))
9649 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9650 (dirp (if remp nil (file-directory-p file)))
9651 (file (if (and dirp org-open-directory-means-index-dot-org)
9652 (concat (file-name-as-directory file) "index.org")
9653 file))
9654 (a-m-a-p (assq 'auto-mode apps))
9655 (dfile (downcase file))
9656 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9657 (link (cond ((and (eq line nil)
9658 (eq search nil))
9659 file)
9660 (line
9661 (concat file "::" (number-to-string line)))
9662 (search
9663 (concat file "::" search))))
9664 (dlink (downcase link))
9665 (old-buffer (current-buffer))
9666 (old-pos (point))
9667 (old-mode major-mode)
9668 ext cmd link-match-data)
9670 (setq ext (match-string 1 dfile))
9672 (setq ext (match-string 1 dfile))))
9673 (cond
9674 ((member in-emacs '((16) system))
9675 (setq cmd (cdr (assoc 'system apps))))
9676 (in-emacs (setq cmd 'emacs))
9677 (t
9678 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9679 (and dirp (cdr (assoc 'directory apps)))
9680 ; first, try matching against apps-dlink
9681 ; if we get a match here, store the match data for later
9682 (let ((match (assoc-default dlink apps-dlink
9683 'string-match)))
9684 (if match
9685 (progn (setq link-match-data (match-data))
9686 match)
9687 (progn (setq in-emacs (or in-emacs line search))
9688 nil))) ; if we have no match in apps-dlink,
9689 ; always open the file in emacs if line or search
9690 ; is given (for backwards compatibility)
9691 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9692 'string-match)
9693 (cdr (assoc ext apps))
9694 (cdr (assoc t apps))))))
9695 (when (eq cmd 'system)
9696 (setq cmd (cdr (assoc 'system apps))))
9697 (when (eq cmd 'default)
9698 (setq cmd (cdr (assoc t apps))))
9699 (when (eq cmd 'mailcap)
9700 (require 'mailcap)
9701 (mailcap-parse-mailcaps)
9702 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9703 (command (mailcap-mime-info mime-type)))
9704 (if (stringp command)
9705 (setq cmd command)
9706 (setq cmd 'emacs))))
9707 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9708 (not (file-exists-p file))
9709 (not org-open-non-existing-files))
9710 (error "No such file: %s" file))
9711 (cond
9713 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9715 (setq cmd (replace-match "%s" t t cmd)))
9716 (while (string-match "%s" cmd)
9717 (setq cmd (replace-match
9718 (save-match-data
9719 (shell-quote-argument
9720 (convert-standard-filename file)))
9721 t t cmd)))
9723 ;; Replace "%1", "%2" etc. in command with group matches from regex
9724 (save-match-data
9725 (let ((match-index 1)
9726 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9727 (set-match-data link-match-data)
9728 (while (<= match-index number-of-groups)
9729 (let ((regex (concat "%" (number-to-string match-index)))
9730 (replace-with (match-string match-index dlink)))
9731 (while (string-match regex cmd)
9732 (setq cmd (replace-match replace-with t t cmd))))
9733 (setq match-index (+ match-index 1)))))
9735 (save-window-excursion
9736 (start-process-shell-command cmd nil cmd)
9737 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9738 ))
9739 ((or (stringp cmd)
9740 (eq cmd 'emacs))
9741 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9742 (widen)
9743 (if line (org-goto-line line)
9744 (if search (org-link-search search))))
9745 ((consp cmd)
9746 (let ((file (convert-standard-filename file)))
9747 (save-match-data
9748 (set-match-data link-match-data)
9749 (eval cmd))))
9750 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9751 (and (org-mode-p) (eq old-mode 'org-mode)
9752 (or (not (equal old-buffer (current-buffer)))
9753 (not (equal old-pos (point))))
9754 (org-mark-ring-push old-pos old-buffer))))
9756 (defun org-file-apps-entry-match-against-dlink-p (entry)
9757 "This function returns non-nil if `entry' uses a regular
9758 expression which should be matched against the whole link by
9759 org-open-file.
9761 It assumes that is the case when the entry uses a regular
9762 expression which has at least one grouping construct and the
9763 action is either a lisp form or a command string containing
9764 '%1', i.e. using at least one subexpression match as a
9765 parameter."
9766 (let ((selector (car entry))
9767 (action (cdr entry)))
9768 (if (stringp selector)
9769 (and (> (regexp-opt-depth selector) 0)
9770 (or (and (stringp action)
9771 (string-match "%[0-9]" action))
9772 (consp action)))
9773 nil)))
9775 (defun org-default-apps ()
9776 "Return the default applications for this operating system."
9777 (cond
9778 ((eq system-type 'darwin)
9779 org-file-apps-defaults-macosx)
9780 ((eq system-type 'windows-nt)
9781 org-file-apps-defaults-windowsnt)
9782 (t org-file-apps-defaults-gnu)))
9784 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9785 "Convert extensions to regular expressions in the cars of LIST.
9786 Also, weed out any non-string entries, because the return value is used
9787 only for regexp matching.
9788 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9789 point to the symbol `emacs', indicating that the file should
9790 be opened in Emacs."
9791 (append
9792 (delq nil
9793 (mapcar (lambda (x)
9794 (if (not (stringp (car x)))
9795 nil
9797 x
9799 list))
9800 (if add-auto-mode
9801 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
9803 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
9804 (defun org-file-remote-p (file)
9805 "Test whether FILE specifies a location on a remote system.
9806 Return non-nil if the location is indeed remote.
9810 (cond ((fboundp 'file-remote-p)
9811 (file-remote-p file))
9812 ((fboundp 'tramp-handle-file-remote-p)
9813 (tramp-handle-file-remote-p file))
9814 ((and (boundp 'ange-ftp-name-format)
9815 (string-match (car ange-ftp-name-format) file))
9816 t)
9817 (t nil)))
9820 ;;;; Refiling
9822 (defun org-get-org-file ()
9823 "Read a filename, with default directory `org-directory'."
9824 (let ((default (or org-default-notes-file remember-data-file)))
9825 (read-file-name (format "File name [%s]: " default)
9826 (file-name-as-directory org-directory)
9827 default)))
9829 (defun org-notes-order-reversed-p ()
9830 "Check if the current file should receive notes in reversed order."
9831 (cond
9832 ((not org-reverse-note-order) nil)
9833 ((eq t org-reverse-note-order) t)
9834 ((not (listp org-reverse-note-order)) nil)
9835 (t (catch 'exit
9836 (let ((all org-reverse-note-order)
9837 entry)
9838 (while (setq entry (pop all))
9839 (if (string-match (car entry) buffer-file-name)
9840 (throw 'exit (cdr entry))))
9841 nil)))))
9843 (defvar org-refile-target-table nil
9844 "The list of refile targets, created by `org-refile'.")
9846 (defvar org-agenda-new-buffers nil
9847 "Buffers created to visit agenda files.")
9849 (defvar org-refile-cache nil
9850 "Cache for refile targets.")
9853 (defvar org-refile-markers nil
9854 "All the markers used for caching refile locations.")
9856 (defun org-refile-marker (pos)
9857 "Get a new refile marker, but only if caching is in use."
9858 (if (not org-refile-use-cache)
9859 pos
9860 (let ((m (make-marker)))
9861 (move-marker m pos)
9862 (push m org-refile-markers)
9863 m)))
9865 (defun org-refile-cache-clear ()
9866 "Clear the refile cache and disable all the markers."
9867 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
9868 (setq org-refile-markers nil)
9869 (setq org-refile-cache nil)
9870 (message "Refile cache has been cleared"))
9872 (defun org-refile-cache-check-set (set)
9873 "Check if all the markers in the cache still have live buffers."
9874 (let (marker)
9875 (catch 'exit
9876 (while (and set (setq marker (nth 3 (pop set))))
9877 ;; if org-refile-use-outline-path is 'file, marker may be nil
9878 (when (and marker (null (marker-buffer marker)))
9879 (message "not found") (sit-for 3)
9880 (throw 'exit nil)))
9881 t)))
9883 (defun org-refile-cache-put (set &rest identifiers)
9884 "Push the refile targets SET into the cache, under IDENTIFIERS."
9885 (let* ((key (sha1 (prin1-to-string identifiers)))
9886 (entry (assoc key org-refile-cache)))
9887 (if entry
9888 (setcdr entry set)
9889 (push (cons key set) org-refile-cache))))
9891 (defun org-refile-cache-get (&rest identifiers)
9892 "Retrieve the cached value for refile targets given by IDENTIFIERS."
9893 (cond
9894 ((not org-refile-cache) nil)
9895 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
9896 (t
9897 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
9898 org-refile-cache))))
9899 (and set (org-refile-cache-check-set set) set)))))
9901 (defun org-get-refile-targets (&optional default-buffer)
9902 "Produce a table with refile targets."
9903 (let ((case-fold-search nil)
9904 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
9905 (entries (or org-refile-targets '((nil . (:level . 1)))))
9906 targets tgs txt re files f desc descre fast-path-p level pos0)
9907 (message "Getting targets...")
9908 (with-current-buffer (or default-buffer (current-buffer))
9909 (while (setq entry (pop entries))
9910 (setq files (car entry) desc (cdr entry))
9911 (setq fast-path-p nil)
9912 (cond
9913 ((null files) (setq files (list (current-buffer))))
9914 ((eq files 'org-agenda-files)
9915 (setq files (org-agenda-files 'unrestricted)))
9916 ((and (symbolp files) (fboundp files))
9917 (setq files (funcall files)))
9918 ((and (symbolp files) (boundp files))
9919 (setq files (symbol-value files))))
9920 (if (stringp files) (setq files (list files)))
9921 (cond
9922 ((eq (car desc) :tag)
9924 ((eq (car desc) :todo)
9926 ((eq (car desc) :regexp)
9927 (setq descre (cdr desc)))
9928 ((eq (car desc) :level)
9930 (if org-odd-levels-only
9931 (1- (* 2 (cdr desc)))
9932 (cdr desc)))
9934 ((eq (car desc) :maxlevel)
9935 (setq fast-path-p t)
9937 (if org-odd-levels-only
9938 (1- (* 2 (cdr desc)))
9939 (cdr desc)))
9941 (t (error "Bad refiling target description %s" desc)))
9942 (while (setq f (pop files))
9943 (with-current-buffer
9944 (if (bufferp f) f (org-get-agenda-file-buffer f))
9945 (or
9946 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
9947 (progn
9948 (if (bufferp f) (setq f (buffer-file-name
9949 (buffer-base-buffer f))))
9950 (setq f (and f (expand-file-name f)))
9951 (if (eq org-refile-use-outline-path 'file)
9952 (push (list (file-name-nondirectory f) f nil nil) tgs))
9953 (save-excursion
9954 (save-restriction
9955 (widen)
9956 (goto-char (point-min))
9957 (while (re-search-forward descre nil t)
9958 (goto-char (setq pos0 (point-at-bol)))
9959 (catch 'next
9960 (when org-refile-target-verify-function
9961 (save-match-data
9962 (or (funcall org-refile-target-verify-function)
9963 (throw 'next t))))
9964 (when (looking-at org-complex-heading-regexp)
9965 (setq level (org-reduced-level
9966 (- (match-end 1) (match-beginning 1)))
9967 txt (org-link-display-format (match-string 4))
9969 re (format org-complex-heading-regexp-format
9970 (regexp-quote (match-string 4))))
9971 (when org-refile-use-outline-path
9972 (setq txt (mapconcat
9973 'org-protect-slash
9974 (append
9975 (if (eq org-refile-use-outline-path
9976 'file)
9977 (list (file-name-nondirectory
9978 (buffer-file-name
9979 (buffer-base-buffer))))
9980 (if (eq org-refile-use-outline-path
9981 'full-file-path)
9982 (list (buffer-file-name
9983 (buffer-base-buffer)))))
9984 (org-get-outline-path fast-path-p
9985 level txt)
9986 (list txt))
9987 "/")))
9988 (push (list txt f re (org-refile-marker (point)))
9989 tgs)))
9990 (when (= (point) pos0)
9991 ;; verification function has not moved point
9992 (goto-char (point-at-eol))))))))
9993 (when org-refile-use-cache
9994 (org-refile-cache-put tgs (buffer-file-name) descre))
9995 (setq targets (append tgs targets))
9996 ))))
9997 (message "Getting targets...done")
9998 (nreverse targets)))
10000 (defun org-protect-slash (s)
10001 (while (string-match "/" s)
10003 s)
10005 (defvar org-olpa (make-vector 20 nil))
10007 (defun org-get-outline-path (&optional fastp level heading)
10008 "Return the outline path to the current entry, as a list.
10010 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10011 routine which makes outline path derivations for an entire file,
10012 avoiding backtracing. Refile target collection makes use of that."
10013 (if fastp
10014 (progn
10015 (if (> level 19)
10016 (error "Outline path failure, more than 19 levels"))
10017 (loop for i from level upto 19 do
10018 (aset org-olpa i nil))
10019 (prog1
10020 (delq nil (append org-olpa nil))
10021 (aset org-olpa level heading)))
10022 (let (rtn case-fold-search)
10023 (save-excursion
10024 (save-restriction
10025 (widen)
10026 (while (org-up-heading-safe)
10027 (when (looking-at org-complex-heading-regexp)
10028 (push (org-match-string-no-properties 4) rtn)))
10029 rtn)))))
10031 (defun org-format-outline-path (path &optional width prefix)
10032 "Format the outline path PATH for display.
10033 Width is the maximum number of characters that is available.
10034 Prefix is a prefix to be included in the returned string,
10035 such as the file name."
10036 (setq width (or width 79))
10037 (if prefix (setq width (- width (length prefix))))
10038 (if (not path)
10039 (or prefix "")
10040 (let* ((nsteps (length path))
10041 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10042 (maxwidth (if (<= total-width width)
10043 10000 ;; everything fits
10044 ;; we need to shorten the level headings
10045 (/ (- width nsteps) nsteps)))
10046 (org-odd-levels-only nil)
10047 (n 0)
10048 (total (1+ (length prefix))))
10049 (setq maxwidth (max maxwidth 10))
10050 (concat prefix
10051 (mapconcat
10052 (lambda (h)
10053 (setq n (1+ n))
10054 (if (and (= n nsteps) (< maxwidth 10000))
10055 (setq maxwidth (- total-width total)))
10056 (if (< (length h) maxwidth)
10057 (progn (setq total (+ total (length h) 1)) h)
10058 (setq h (substring h 0 (- maxwidth 2))
10059 total (+ total maxwidth 1))
10061 (setq h (substring h 0 (match-beginning 0))))
10062 (setq h (concat h "..")))
10063 (org-add-props h nil 'face
10064 (nth (% (1- n) org-n-level-faces)
10065 org-level-faces))
10066 h)
10067 path "/")))))
10069 (defun org-display-outline-path (&optional file current)
10070 "Display the current outline path in the echo area."
10071 (interactive "P")
10072 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10073 (case-fold-search nil)
10074 (path (and (org-mode-p) (org-get-outline-path))))
10075 (if current (setq path (append path
10076 (save-excursion
10077 (org-back-to-heading t)
10078 (if (looking-at org-complex-heading-regexp)
10079 (list (match-string 4)))))))
10080 (message "%s"
10081 (org-format-outline-path
10082 path
10083 (1- (frame-width))
10084 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10086 (defvar org-refile-history nil
10087 "History for refiling operations.")
10089 (defvar org-after-refile-insert-hook nil
10090 "Hook run after `org-refile' has inserted its stuff at the new location.
10091 Note that this is still *before* the stuff will be removed from
10092 the *old* location.")
10094 (defvar org-capture-last-stored-marker)
10095 (defun org-refile (&optional goto default-buffer rfloc)
10096 "Move the entry at point to another heading.
10097 The list of target headings is compiled using the information in
10098 `org-refile-targets', which see. This list is created before each use
10099 and will therefore always be up-to-date.
10101 At the target location, the entry is filed as a subitem of the target heading.
10102 Depending on `org-reverse-note-order', the new subitem will either be the
10103 first or the last subitem.
10105 If there is an active region, all entries in that region will be moved.
10106 However, the region must fulfill the requirement that the first heading
10107 is the first one sets the top-level of the moved text - at most siblings
10108 below it are allowed.
10110 With prefix arg GOTO, the command will only visit the target location,
10111 not actually move anything.
10113 go to the location where the last refiling
10114 operation has put the subtree.
10115 With a prefix argument of `2', refile to the running clock.
10117 RFLOC can be a refile location obtained in a different way.
10119 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10121 If you are using target caching (see `org-refile-use-cache'),
10122 You have to clear the target cache in order to find new targets.
10123 This can be done with a 0 prefix: `C-0 C-c C-w'"
10124 (interactive "P")
10125 (if (member goto '(0 (64)))
10126 (org-refile-cache-clear)
10127 (let* ((cbuf (current-buffer))
10128 (regionp (org-region-active-p))
10129 (region-start (and regionp (region-beginning)))
10130 (region-end (and regionp (region-end)))
10131 (region-length (and regionp (- region-end region-start)))
10132 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10133 pos it nbuf file re level reversed)
10134 (setq last-command nil)
10135 (when regionp
10136 (goto-char region-start)
10137 (or (bolp) (goto-char (point-at-bol)))
10138 (setq region-start (point))
10139 (unless (org-kill-is-subtree-p
10140 (buffer-substring region-start region-end))
10141 (error "The region is not a (sequence of) subtree(s)")))
10142 (if (equal goto '(16))
10143 (org-refile-goto-last-stored)
10144 (when (or
10145 (and (equal goto 2)
10146 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10147 (prog1
10148 (setq it (list (or org-clock-heading "running clock")
10149 (buffer-file-name
10150 (marker-buffer org-clock-hd-marker))
10151 ""
10152 (marker-position org-clock-hd-marker)))
10153 (setq goto nil)))
10154 (setq it (or rfloc
10155 (save-excursion
10156 (org-refile-get-location
10157 (if goto "Goto: " "Refile to: ") default-buffer
10158 org-refile-allow-creating-parent-nodes)))))
10159 (setq file (nth 1 it)
10160 re (nth 2 it)
10161 pos (nth 3 it))
10162 (if (and (not goto)
10163 pos
10164 (equal (buffer-file-name) file)
10165 (if regionp
10166 (and (>= pos region-start)
10167 (<= pos region-end))
10168 (and (>= pos (point))
10169 (< pos (save-excursion
10170 (org-end-of-subtree t t))))))
10171 (error "Cannot refile to position inside the tree or region"))
10173 (setq nbuf (or (find-buffer-visiting file)
10174 (find-file-noselect file)))
10175 (if goto
10176 (progn
10177 (switch-to-buffer nbuf)
10178 (goto-char pos)
10179 (org-show-context 'org-goto))
10180 (if regionp
10181 (progn
10182 (org-kill-new (buffer-substring region-start region-end))
10183 (org-save-markers-in-region region-start region-end))
10184 (org-copy-subtree 1 nil t))
10185 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10186 (find-file-noselect file)))
10187 (setq reversed (org-notes-order-reversed-p))
10188 (save-excursion
10189 (save-restriction
10190 (widen)
10191 (if pos
10192 (progn
10193 (goto-char pos)
10194 (looking-at outline-regexp)
10195 (setq level (org-get-valid-level (funcall outline-level) 1))
10196 (goto-char
10197 (if reversed
10198 (or (outline-next-heading) (point-max))
10199 (or (save-excursion (org-get-next-sibling))
10200 (org-end-of-subtree t t)
10201 (point-max)))))
10202 (setq level 1)
10203 (if (not reversed)
10204 (goto-char (point-max))
10205 (goto-char (point-min))
10206 (or (outline-next-heading) (goto-char (point-max)))))
10207 (if (not (bolp)) (newline))
10208 (org-paste-subtree level)
10209 (when org-log-refile
10210 (org-add-log-setup 'refile nil nil 'findpos
10211 org-log-refile)
10212 (unless (eq org-log-refile 'note)
10213 (save-excursion (org-add-log-note))))
10214 (and org-auto-align-tags (org-set-tags nil t))
10215 (bookmark-set "org-refile-last-stored")
10216 ;; If we are refiling for capture, make sure that the
10217 ;; last-capture pointers point here
10218 (when (org-bound-and-true-p org-refile-for-capture)
10219 (bookmark-set "org-capture-last-stored-marker")
10220 (move-marker org-capture-last-stored-marker (point)))
10221 (if (fboundp 'deactivate-mark) (deactivate-mark))
10222 (run-hooks 'org-after-refile-insert-hook))))
10223 (if regionp
10224 (delete-region (point) (+ (point) region-length))
10225 (org-cut-subtree))
10226 (when (featurep 'org-inlinetask)
10227 (org-inlinetask-remove-END-maybe))
10228 (setq org-markers-to-move nil)
10231 (defun org-refile-goto-last-stored ()
10232 "Go to the location where the last refile was stored."
10233 (interactive)
10234 (bookmark-jump "org-refile-last-stored")
10235 (message "This is the location of the last refile"))
10237 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10238 "Prompt the user for a refile location, using PROMPT."
10239 (let ((org-refile-targets org-refile-targets)
10240 (org-refile-use-outline-path org-refile-use-outline-path))
10241 (setq org-refile-target-table (org-get-refile-targets default-buffer)))
10242 (unless org-refile-target-table
10243 (error "No refile targets"))
10244 (let* ((cbuf (current-buffer))
10245 (partial-completion-mode nil)
10246 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10247 (cfunc (if (and org-refile-use-outline-path
10248 org-outline-path-complete-in-steps)
10249 'org-olpath-completing-read
10250 'org-icompleting-read))
10251 (extra (if org-refile-use-outline-path "/" ""))
10252 (filename (and cfn (expand-file-name cfn)))
10253 (tbl (mapcar
10254 (lambda (x)
10255 (if (and (not (member org-refile-use-outline-path
10256 '(file full-file-path)))
10257 (not (equal filename (nth 1 x))))
10258 (cons (concat (car x) extra " ("
10259 (file-name-nondirectory (nth 1 x)) ")")
10260 (cdr x))
10261 (cons (concat (car x) extra) (cdr x))))
10262 org-refile-target-table))
10263 (completion-ignore-case t)
10264 pa answ parent-target child parent old-hist)
10265 (setq old-hist org-refile-history)
10266 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10267 nil 'org-refile-history))
10268 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10269 (org-refile-check-position pa)
10270 (if pa
10271 (progn
10272 (when (or (not org-refile-history)
10273 (not (eq old-hist org-refile-history))
10274 (not (equal (car pa) (car org-refile-history))))
10275 (setq org-refile-history
10276 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10277 org-refile-history
10278 (cdr org-refile-history))))
10279 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10280 (pop org-refile-history)))
10281 pa)
10283 (progn
10284 (setq parent (match-string 1 answ)
10285 child (match-string 2 answ))
10286 (setq parent-target (or (assoc parent tbl)
10287 (assoc (concat parent "/") tbl)))
10288 (when (and parent-target
10289 (or (eq new-nodes t)
10290 (and (eq new-nodes 'confirm)
10292 child)))))
10293 (org-refile-new-child parent-target child)))
10294 (error "Invalid target location")))))
10296 (defun org-refile-check-position (refile-pointer)
10297 "Check if the refile pointer matches the readline to which it points."
10298 (let* ((file (nth 1 refile-pointer))
10299 (re (nth 2 refile-pointer))
10300 (pos (nth 3 refile-pointer))
10301 buffer)
10302 (when (org-string-nw-p re)
10303 (setq buffer (if (markerp pos)
10304 (marker-buffer pos)
10305 (or (find-buffer-visiting file)
10306 (find-file-noselect file))))
10307 (with-current-buffer buffer
10308 (save-excursion
10309 (save-restriction
10310 (widen)
10311 (goto-char pos)
10312 (beginning-of-line 1)
10313 (unless (org-looking-at-p re)
10314 (error "Invalid refile position, please rebuild the cache"))))))))
10316 (defun org-refile-new-child (parent-target child)
10317 "Use refile target PARENT-TARGET to add new CHILD below it."
10318 (unless parent-target
10319 (error "Cannot find parent for new node"))
10320 (let ((file (nth 1 parent-target))
10321 (pos (nth 3 parent-target))
10322 level)
10323 (with-current-buffer (or (find-buffer-visiting file)
10324 (find-file-noselect file))
10325 (save-excursion
10326 (save-restriction
10327 (widen)
10328 (if pos
10329 (goto-char pos)
10330 (goto-char (point-max))
10331 (if (not (bolp)) (newline)))
10332 (when (looking-at outline-regexp)
10333 (setq level (funcall outline-level))
10334 (org-end-of-subtree t t))
10335 (org-back-over-empty-lines)
10337 (if pos (org-get-valid-level level 1) 1) ?*)
10339 (beginning-of-line 0)
10340 (list (concat (car parent-target) "/" child) file "" (point)))))))
10342 (defun org-olpath-completing-read (prompt collection &rest args)
10343 "Read an outline path like a file name."
10344 (let ((thetable collection)
10345 (org-completion-use-ido nil) ; does not work with ido.
10346 (org-completion-use-iswitchb nil)) ; or iswitchb
10347 (apply
10348 'org-icompleting-read prompt
10349 (lambda (string predicate &optional flag)
10350 (let (rtn r f (l (length string)))
10351 (cond
10352 ((eq flag nil)
10353 ;; try completion
10354 (try-completion string thetable))
10355 ((eq flag t)
10356 ;; all-completions
10357 (setq rtn (all-completions string thetable predicate))
10358 (mapcar
10359 (lambda (x)
10360 (setq r (substring x l))
10361 (if (string-match " ([^)]*)$" x)
10362 (setq f (match-string 0 x))
10363 (setq f ""))
10364 (if (string-match "/" r)
10365 (concat string (substring r 0 (match-end 0)) f)
10366 x))
10367 rtn))
10368 ((eq flag 'lambda)
10369 ;; exact match?
10370 (assoc string thetable)))
10371 ))
10372 args)))
10374 ;;;; Dynamic blocks
10376 (defun org-find-dblock (name)
10377 "Find the first dynamic block with name NAME in the buffer.
10378 If not found, stay at current position and return nil."
10379 (let (pos)
10380 (save-excursion
10381 (goto-char (point-min))
10383 nil t)
10384 (match-beginning 0))))
10385 (if pos (goto-char pos))
10386 pos))
10388 (defconst org-dblock-start-re
10390 "Matches the start line of a dynamic block, with parameters.")
10393 "Matches the end of a dynamic block.")
10395 (defun org-create-dblock (plist)
10396 "Create a dynamic block section, with parameters taken from PLIST.
10397 PLIST must contain a :name entry which is used as name of the block."
10399 (end-of-line 1)
10400 (newline))
10401 (let ((col (current-column))
10402 (name (plist-get plist :name)))
10403 (insert "#+BEGIN: " name)
10404 (while plist
10405 (if (eq (car plist) :name)
10406 (setq plist (cddr plist))
10407 (insert " " (prin1-to-string (pop plist)))))
10409 (beginning-of-line -2)))
10411 (defun org-prepare-dblock ()
10412 "Prepare dynamic block for refresh.
10413 This empties the block, puts the cursor at the insert position and returns
10414 the property list including an extra property :name with the block name."
10415 (unless (looking-at org-dblock-start-re)
10416 (error "Not at a dynamic block"))
10417 (let* ((begdel (1+ (match-end 0)))
10418 (name (org-no-properties (match-string 1)))
10419 (params (append (list :name name)
10420 (read (concat "(" (match-string 3) ")")))))
10421 (save-excursion
10422 (beginning-of-line 1)
10424 (setq params (plist-put params :indentation-column (current-column))))
10425 (unless (re-search-forward org-dblock-end-re nil t)
10426 (error "Dynamic block not terminated"))
10427 (setq params
10428 (append params
10429 (list :content (buffer-substring
10430 begdel (match-beginning 0)))))
10431 (delete-region begdel (match-beginning 0))
10432 (goto-char begdel)
10433 (open-line 1)
10434 params))
10436 (defun org-map-dblocks (&optional command)
10437 "Apply COMMAND to all dynamic blocks in the current buffer.
10438 If COMMAND is not given, use `org-update-dblock'."
10439 (let ((cmd (or command 'org-update-dblock)))
10440 (save-excursion
10441 (goto-char (point-min))
10442 (while (re-search-forward org-dblock-start-re nil t)
10443 (goto-char (match-beginning 0))
10444 (save-excursion
10445 (condition-case nil
10446 (funcall cmd)
10447 (error (message "Error during update of dynamic block"))))
10448 (unless (re-search-forward org-dblock-end-re nil t)
10449 (error "Dynamic block not terminated"))))))
10451 (defun org-dblock-update (&optional arg)
10452 "User command for updating dynamic blocks.
10453 Update the dynamic block at point. With prefix ARG, update all dynamic
10454 blocks in the buffer."
10455 (interactive "P")
10456 (if arg
10457 (org-update-all-dblocks)
10458 (or (looking-at org-dblock-start-re)
10459 (org-beginning-of-dblock))
10460 (org-update-dblock)))
10462 (defun org-update-dblock ()
10463 "Update the dynamic block at point.
10464 This means to empty the block, parse for parameters and then call
10465 the correct writing function."
10466 (save-window-excursion
10467 (let* ((pos (point))
10468 (line (org-current-line))
10469 (params (org-prepare-dblock))
10470 (name (plist-get params :name))
10471 (indent (plist-get params :indentation-column))
10472 (cmd (intern (concat "org-dblock-write:" name))))
10473 (message "Updating dynamic block `%s' at line %d..." name line)
10474 (funcall cmd params)
10475 (message "Updating dynamic block `%s' at line %d...done" name line)
10476 (goto-char pos)
10477 (when (and indent (> indent 0))
10478 (setq indent (make-string indent ?\ ))
10479 (save-excursion
10480 (org-beginning-of-dblock)
10481 (forward-line 1)
10482 (while (not (looking-at org-dblock-end-re))
10483 (insert indent)
10484 (beginning-of-line 2))
10485 (when (looking-at org-dblock-end-re)
10487 (replace-match ""))
10488 (insert indent)))))))
10490 (defun org-beginning-of-dblock ()
10491 "Find the beginning of the dynamic block at point.
10492 Error if there is no such block at point."
10493 (let ((pos (point))
10494 beg)
10495 (end-of-line 1)
10496 (if (and (re-search-backward org-dblock-start-re nil t)
10497 (setq beg (match-beginning 0))
10498 (re-search-forward org-dblock-end-re nil t)
10499 (> (match-end 0) pos))
10500 (goto-char beg)
10501 (goto-char pos)
10502 (error "Not in a dynamic block"))))
10504 (defun org-update-all-dblocks ()
10505 "Update all dynamic blocks in the buffer.
10506 This function can be used in a hook."
10507 (when (org-mode-p)
10508 (org-map-dblocks 'org-update-dblock)))
10511 ;;;; Completion
10513 (defconst org-additional-option-like-keywords
10514 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML"
10515 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook"
10516 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10517 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX"
10518 "BEGIN:" "END:"
10519 "ORGTBL" "TBLFM:" "TBLNAME:"
10520 "BEGIN_EXAMPLE" "END_EXAMPLE"
10521 "BEGIN_QUOTE" "END_QUOTE"
10522 "BEGIN_VERSE" "END_VERSE"
10523 "BEGIN_CENTER" "END_CENTER"
10524 "BEGIN_SRC" "END_SRC"
10525 "CATEGORY" "COLUMNS" "PROPERTY"
10526 "CAPTION" "LABEL"
10527 "SETUPFILE"
10528 "BIND"
10529 "MACRO"))
10531 (defcustom org-structure-template-alist
10532 '(
10545 ("L" "#+latex: "
10549 ("H" "#+html: "
10552 ("A" "#+ascii: ")
10553 ("i" "#+include %file ?"
10555 )
10556 "Structure completion elements.
10557 This is a list of abbreviation keys and values. The value gets inserted
10558 if you type `<' followed by the key and then press the completion key,
10559 usually `M-TAB'. %file will be replaced by a file name after prompting
10560 for the file using completion.
10561 There are two templates for each key, the first uses the original Org syntax,
10562 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10563 the default when the /org-mtags.el/ module has been loaded. See also the
10564 variable `org-mtags-prefer-muse-templates'.
10565 This is an experimental feature, it is undecided if it is going to stay in."
10566 :group 'org-completion
10567 :type '(repeat
10568 (string :tag "Key")
10569 (string :tag "Template")
10570 (string :tag "Muse Template")))
10572 (defun org-try-structure-completion ()
10573 "Try to complete a structure template before point.
10575 expands them."
10576 (let ((l (buffer-substring (point-at-bol) (point)))
10577 a)
10580 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10581 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10582 (match-beginning 1)) a)
10583 t)))
10585 (defun org-complete-expand-structure-template (start cell)
10586 "Expand a structure template."
10587 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10588 (rpl (nth (if musep 2 1) cell))
10589 (ind ""))
10590 (delete-region start (point))
10592 (cond
10593 ((bolp))
10595 (setq ind (buffer-substring (point-at-bol) (point))))
10596 (t (newline))))
10597 (setq start (point))
10598 (if (string-match "%file" rpl)
10599 (setq rpl (replace-match
10600 (concat
10602 (save-match-data
10603 (abbreviate-file-name (read-file-name "Include file: ")))
10605 t t rpl)))
10608 (insert rpl)
10612 (defun org-complete (&optional arg)
10613 "Perform completion on word at point.
10614 At the beginning of a headline, this completes TODO keywords as given in
10615 `org-todo-keywords'.
10616 If the current word is preceded by a backslash, completes the TeX symbols
10617 that are supported for HTML support.
10619 setting file options.
10621 At all other locations, this simply calls the value of
10622 `org-completion-fallback-command'."
10623 (interactive "P")
10624 (org-without-partial-completion
10625 (catch 'exit
10626 (let* ((a nil)
10627 (end (point))
10628 (beg1 (save-excursion
10629 (skip-chars-backward (org-re "[:alnum:]_@#%"))
10630 (point)))
10631 (beg (save-excursion
10632 (skip-chars-backward "a-zA-Z0-9_:$")
10633 (point)))
10634 (confirm (lambda (x) (stringp (car x))))
10635 (searchhead (equal (char-before beg) ?*))
10636 (struct
10637 (when (and (member (char-before beg1) '(?. ?<))
10638 (setq a (assoc (buffer-substring beg1 (point))
10639 org-structure-template-alist)))
10640 (org-complete-expand-structure-template (1- beg1) a)
10641 (throw 'exit t)))
10642 (tag (and (equal (char-before beg1) ?:)
10643 (equal (char-after (point-at-bol)) ?*)))
10644 (prop (or (and (equal (char-before beg1) ?:)
10645 (not (equal (char-after (point-at-bol)) ?*)))
10647 (buffer-substring (point-at-bol) (point)))))
10649 (link (equal (char-before beg) ?\[))
10650 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
10651 beg)
10652 "#+"))
10654 (buffer-substring (point-at-bol) (point))))
10655 (completion-ignore-case opt)
10656 (type nil)
10657 (tbl nil)
10658 (table (cond
10659 (opt
10660 (setq type :opt)
10661 (require 'org-exp)
10662 (append
10663 (delq nil
10664 (mapcar
10665 (lambda (x)
10666 (if (string-match
10668 (cons (match-string 2 x)
10669 (match-string 1 x))))
10671 (mapcar 'list org-additional-option-like-keywords)))
10672 (startup
10673 (setq type :startup)
10674 org-startup-options)
10675 (link (append org-link-abbrev-alist-local
10676 org-link-abbrev-alist))
10677 (texp
10678 (setq type :tex)
10679 (append org-entities-user org-entities))
10681 (buffer-substring (point-at-bol) beg))
10682 (setq type :todo)
10683 (mapcar 'list org-todo-keywords-1))
10684 (searchhead
10685 (setq type :searchhead)
10686 (save-excursion
10687 (goto-char (point-min))
10688 (while (re-search-forward org-todo-line-regexp nil t)
10689 (push (list
10690 (org-make-org-heading-search-string
10691 (match-string 3) t))
10692 tbl)))
10693 tbl)
10694 (tag (setq type :tag beg beg1)
10695 (or org-tag-alist (org-get-buffer-tags)))
10696 (prop (setq type :prop beg beg1)
10697 (mapcar 'list (org-buffer-property-keys nil t t)))
10698 (t (progn
10699 (call-interactively org-completion-fallback-command)
10700 (throw 'exit nil)))))
10701 (pattern (buffer-substring-no-properties beg end))
10702 (completion (try-completion pattern table confirm)))
10703 (cond ((eq completion t)
10704 (if (not (assoc (upcase pattern) table))
10705 (message "Already complete")
10706 (if (and (equal type :opt)
10707 (not (member (car (assoc (upcase pattern) table))
10708 org-additional-option-like-keywords)))
10709 (insert (substring (cdr (assoc (upcase pattern) table))
10710 (length pattern)))
10711 (if (memq type '(:tag :prop)) (insert ":")))))
10712 ((null completion)
10714 (ding))
10715 ((not (string= pattern completion))
10716 (delete-region beg end)
10717 (if (string-match " +$" completion)
10718 (setq completion (replace-match "" t t completion)))
10719 (insert completion)
10720 (if (get-buffer-window "*Completions*")
10721 (delete-window (get-buffer-window "*Completions*")))
10722 (if (assoc completion table)
10723 (if (eq type :todo) (insert " ")
10724 (if (and (memq type '(:tag :prop))
10726 (org-current-line-string t))))
10727 (insert ":"))))
10728 (if (and (equal type :opt) (assoc completion table))
10729 (message "%s" (substitute-command-keys
10731 (t
10732 (message "Making completion list...")
10733 (let ((list (sort (all-completions pattern table confirm)
10734 'string<)))
10735 (with-output-to-temp-buffer "*Completions*"
10736 (condition-case nil
10737 ;; Protection needed for XEmacs and emacs 21
10738 (display-completion-list list pattern)
10739 (error (display-completion-list list)))))
10740 (message "Making completion list...%s" "done")))))))
10742 ;;;; TODO, DEADLINE, Comments
10744 (defun org-toggle-comment ()
10745 "Change the COMMENT state of an entry."
10746 (interactive)
10747 (save-excursion
10748 (org-back-to-heading)
10749 (let (case-fold-search)
10750 (if (looking-at (concat outline-regexp
10752 (replace-match "" t t nil 1)
10753 (if (looking-at outline-regexp)
10754 (progn
10755 (goto-char (match-end 0))
10756 (insert org-comment-string " ")))))))
10758 (defvar org-last-todo-state-is-todo nil
10759 "This is non-nil when the last TODO state change led to a TODO state.
10760 If the last change removed the TODO tag or switched to DONE, then
10761 this is nil.")
10763 (defvar org-setting-tags nil) ; dynamically skipped
10765 (defvar org-todo-setup-filter-hook nil
10766 "Hook for functions that pre-filter todo specs.
10767 Each function takes a todo spec and returns either nil or the spec
10768 transformed into canonical form." )
10770 (defvar org-todo-get-default-hook nil
10771 "Hook for functions that get a default item for todo.
10772 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10773 nil or a string to be used for the todo mark." )
10775 (defvar org-agenda-headline-snapshot-before-repeat)
10777 (defun org-todo (&optional arg)
10778 "Change the TODO state of an item.
10779 The state of an item is given by a keyword at the start of the heading,
10780 like
10781 *** TODO Write paper
10782 *** DONE Call mom
10784 The different keywords are specified in the variable `org-todo-keywords'.
10786 So for this example: when the item starts with TODO, it is changed to DONE.
10787 When it starts with DONE, the DONE is removed. And when neither TODO nor
10788 DONE are present, add TODO at the beginning of the heading.
10791 state.
10792 With numeric prefix arg, switch to that state.
10794 keywords (nextset).
10797 For calling through lisp, arg is also interpreted in the following way:
10798 'none -> empty state
10800 'done -> switch to DONE
10801 'nextset -> switch to the next set of keywords
10802 'previousset -> switch to the previous set of keywords
10804 really is a member of `org-todo-keywords'."
10805 (interactive "P")
10806 (if (equal arg '(16)) (setq arg 'nextset))
10807 (let ((org-blocker-hook org-blocker-hook)
10808 (case-fold-search nil))
10809 (when (equal arg '(64))
10810 (setq arg nil org-blocker-hook nil))
10811 (when (and org-blocker-hook
10812 (or org-inhibit-blocking
10813 (org-entry-get nil "NOBLOCKING")))
10814 (setq org-blocker-hook nil))
10815 (save-excursion
10816 (catch 'exit
10817 (org-back-to-heading t)
10818 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10820 (looking-at " *"))
10821 (let* ((match-data (match-data))
10822 (startpos (point-at-bol))
10823 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10824 (org-log-done org-log-done)
10825 (org-log-repeat org-log-repeat)
10826 (org-todo-log-states org-todo-log-states)
10827 (this (match-string 1))
10828 (hl-pos (match-beginning 0))
10829 (head (org-get-todo-sequence-head this))
10830 (ass (assoc head org-todo-kwd-alist))
10831 (interpret (nth 1 ass))
10832 (done-word (nth 3 ass))
10833 (final-done-word (nth 4 ass))
10834 (last-state (or this ""))
10835 (completion-ignore-case t)
10836 (member (member this org-todo-keywords-1))
10837 (tail (cdr member))
10838 (state (cond
10839 ((and org-todo-key-trigger
10840 (or (and (equal arg '(4))
10841 (eq org-use-fast-todo-selection 'prefix))
10842 (and (not arg) org-use-fast-todo-selection
10843 (not (eq org-use-fast-todo-selection
10844 'prefix)))))
10845 ;; Use fast selection
10846 (org-fast-todo-selection))
10847 ((and (equal arg '(4))
10848 (or (not org-use-fast-todo-selection)
10849 (not org-todo-key-trigger)))
10850 ;; Read a state with completion
10851 (org-icompleting-read
10852 "State: " (mapcar (lambda(x) (list x))
10853 org-todo-keywords-1)
10854 nil t))
10855 ((eq arg 'right)
10856 (if this
10857 (if tail (car tail) nil)
10858 (car org-todo-keywords-1)))
10859 ((eq arg 'left)
10860 (if (equal member org-todo-keywords-1)
10861 nil
10862 (if this
10863 (nth (- (length org-todo-keywords-1)
10864 (length tail) 2)
10865 org-todo-keywords-1)
10866 (org-last org-todo-keywords-1))))
10867 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10868 (setq arg nil))) ; hack to fall back to cycling
10869 (arg
10870 ;; user or caller requests a specific state
10871 (cond
10872 ((equal arg "") nil)
10873 ((eq arg 'none) nil)
10874 ((eq arg 'done) (or done-word (car org-done-keywords)))
10875 ((eq arg 'nextset)
10876 (or (car (cdr (member head org-todo-heads)))
10877 (car org-todo-heads)))
10878 ((eq arg 'previousset)
10879 (let ((org-todo-heads (reverse org-todo-heads)))
10880 (or (car (cdr (member head org-todo-heads)))
10881 (car org-todo-heads))))
10882 ((car (member arg org-todo-keywords-1)))
10883 ((stringp arg)
10884 (error "State `%s' not valid in this file" arg))
10885 ((nth (1- (prefix-numeric-value arg))
10886 org-todo-keywords-1))))
10887 ((null member) (or head (car org-todo-keywords-1)))
10888 ((equal this final-done-word) nil) ;; -> make empty
10889 ((null tail) nil) ;; -> first entry
10890 ((memq interpret '(type priority))
10891 (if (eq this-command last-command)
10892 (car tail)
10893 (if (> (length tail) 0)
10894 (or done-word (car org-done-keywords))
10895 nil)))
10896 (t
10897 (car tail))))
10898 (state (or
10899 (run-hook-with-args-until-success
10900 'org-todo-get-default-hook state last-state)
10901 state))
10902 (next (if state (concat " " state " ") " "))
10903 (change-plist (list :type 'todo-state-change :from this :to state
10904 :position startpos))
10905 dolog now-done-p)
10906 (when org-blocker-hook
10907 (setq org-last-todo-state-is-todo
10908 (not (member this org-done-keywords)))
10909 (unless (save-excursion
10910 (save-match-data
10911 (run-hook-with-args-until-failure
10912 'org-blocker-hook change-plist)))
10913 (if (interactive-p)
10914 (error "TODO state change from %s to %s blocked" this state)
10915 ;; fail silently
10916 (message "TODO state change from %s to %s blocked" this state)
10917 (throw 'exit nil))))
10918 (store-match-data match-data)
10919 (replace-match next t t)
10920 (unless (pos-visible-in-window-p hl-pos)
10921 (message "TODO state changed to %s" (org-trim next)))
10922 (unless head
10923 (setq head (org-get-todo-sequence-head state)
10924 ass (assoc head org-todo-kwd-alist)
10925 interpret (nth 1 ass)
10926 done-word (nth 3 ass)
10927 final-done-word (nth 4 ass)))
10928 (when (memq arg '(nextset previousset))
10929 (message "Keyword-Set %d/%d: %s"
10930 (- (length org-todo-sets) -1
10931 (length (memq (assoc state org-todo-sets) org-todo-sets)))
10932 (length org-todo-sets)
10933 (mapconcat 'identity (assoc state org-todo-sets) " ")))
10934 (setq org-last-todo-state-is-todo
10935 (not (member state org-done-keywords)))
10936 (setq now-done-p (and (member state org-done-keywords)
10937 (not (member this org-done-keywords))))
10938 (and logging (org-local-logging logging))
10939 (when (and (or org-todo-log-states org-log-done)
10940 (not (eq org-inhibit-logging t))
10941 (not (memq arg '(nextset previousset))))
10942 ;; we need to look at recording a time and note
10943 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
10944 (nth 2 (assoc this org-todo-log-states))))
10945 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
10946 (setq dolog 'time))
10947 (when (and state
10948 (member state org-not-done-keywords)
10949 (not (member this org-not-done-keywords)))
10950 ;; This is now a todo state and was not one before
10951 ;; If there was a CLOSED time stamp, get rid of it.
10952 (org-add-planning-info nil nil 'closed))
10953 (when (and now-done-p org-log-done)
10954 ;; It is now done, and it was not done before
10955 (org-add-planning-info 'closed (org-current-time))
10956 (if (and (not dolog) (eq 'note org-log-done))
10957 (org-add-log-setup 'done state this 'findpos 'note)))
10958 (when (and state dolog)
10959 ;; This is a non-nil state, and we need to log it
10960 (org-add-log-setup 'state state this 'findpos dolog)))
10961 ;; Fixup tag positioning
10962 (org-todo-trigger-tag-changes state)
10963 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
10964 (when org-provide-todo-statistics
10965 (org-update-parent-todo-statistics))
10966 (run-hooks 'org-after-todo-state-change-hook)
10967 (if (and arg (not (member state org-done-keywords)))
10968 (setq head (org-get-todo-sequence-head state)))
10969 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
10970 ;; Do we need to trigger a repeat?
10971 (when now-done-p
10972 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
10973 ;; This is for the agenda, take a snapshot of the headline.
10974 (save-match-data
10975 (setq org-agenda-headline-snapshot-before-repeat
10976 (org-get-heading))))
10977 (org-auto-repeat-maybe state))
10978 ;; Fixup cursor location if close to the keyword
10979 (if (and (outline-on-heading-p)
10980 (not (bolp))
10981 (save-excursion (beginning-of-line 1)
10982 (looking-at org-todo-line-regexp))
10983 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
10984 (progn
10985 (goto-char (or (match-end 2) (match-end 1)))
10986 (and (looking-at " ") (just-one-space))))
10987 (when org-trigger-hook
10988 (save-excursion
10989 (run-hook-with-args 'org-trigger-hook change-plist))))))))
10991 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
10992 "Block turning an entry into a TODO, using the hierarchy.
10993 This checks whether the current task should be blocked from state
10994 changes. Such blocking occurs when:
10996 1. The task has children which are not all in a completed state.
10998 2. A task has a parent with the property :ORDERED:, and there
10999 are siblings prior to the current task with incomplete
11000 status.
11002 3. The parent of the task is blocked because it has siblings that should
11003 be done first, or is child of a block grandparent TODO entry."
11005 (if (not org-enforce-todo-dependencies)
11006 t ; if locally turned off don't block
11007 (catch 'dont-block
11008 ;; If this is not a todo state change, or if this entry is already DONE,
11009 ;; do not block
11010 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11011 (member (plist-get change-plist :from)
11012 (cons 'done org-done-keywords))
11013 (member (plist-get change-plist :to)
11014 (cons 'todo org-not-done-keywords))
11015 (not (plist-get change-plist :to)))
11016 (throw 'dont-block t))
11017 ;; If this task has children, and any are undone, it's blocked
11018 (save-excursion
11019 (org-back-to-heading t)
11020 (let ((this-level (funcall outline-level)))
11021 (outline-next-heading)
11022 (let ((child-level (funcall outline-level)))
11023 (while (and (not (eobp))
11024 (> child-level this-level))
11025 ;; this todo has children, check whether they are all
11026 ;; completed
11027 (if (and (not (org-entry-is-done-p))
11028 (org-entry-is-todo-p))
11029 (throw 'dont-block nil))
11030 (outline-next-heading)
11031 (setq child-level (funcall outline-level))))))
11032 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11033 ;; any previous siblings are undone, it's blocked
11034 (save-excursion
11035 (org-back-to-heading t)
11036 (let* ((pos (point))
11037 (parent-pos (and (org-up-heading-safe) (point))))
11038 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11039 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11040 (forward-line 1)
11041 (re-search-forward org-not-done-heading-regexp pos t))
11042 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11043 ;; Search further up the hierarchy, to see if an anchestor is blocked
11044 (while t
11045 (goto-char parent-pos)
11046 (if (not (looking-at org-not-done-heading-regexp))
11047 (throw 'dont-block t)) ; do not block, parent is not a TODO
11048 (setq pos (point))
11049 (setq parent-pos (and (org-up-heading-safe) (point)))
11050 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11051 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11052 (forward-line 1)
11053 (re-search-forward org-not-done-heading-regexp pos t))
11054 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11056 (defcustom org-track-ordered-property-with-tag nil
11057 "Should the ORDERED property also be shown as a tag?
11058 The ORDERED property decides if an entry should require subtasks to be
11059 completed in sequence. Since a property is not very visible, setting
11060 this option means that toggling the ORDERED property with the command
11061 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11062 not relevant for the behavior, but it makes things more visible.
11064 Note that toggling the tag with tags commands will not change the property
11065 and therefore not influence behavior!
11067 This can be t, meaning the tag ORDERED should be used, It can also be a
11068 string to select a different tag for this task."
11069 :group 'org-todo
11070 :type '(choice
11071 (const :tag "No tracking" nil)
11072 (const :tag "Track with ORDERED tag" t)
11073 (string :tag "Use other tag")))
11075 (defun org-toggle-ordered-property ()
11076 "Toggle the ORDERED property of the current entry.
11077 For better visibility, you can track the value of this property with a tag.
11078 See variable `org-track-ordered-property-with-tag'."
11079 (interactive)
11080 (let* ((t1 org-track-ordered-property-with-tag)
11081 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11082 (save-excursion
11083 (org-back-to-heading)
11084 (if (org-entry-get nil "ORDERED")
11085 (progn
11086 (org-delete-property "ORDERED")
11087 (and tag (org-toggle-tag tag 'off))
11088 (message "Subtasks can be completed in arbitrary order"))
11089 (org-entry-put nil "ORDERED" "t")
11090 (and tag (org-toggle-tag tag 'on))
11091 (message "Subtasks must be completed in sequence")))))
11093 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11094 (defun org-block-todo-from-checkboxes (change-plist)
11095 "Block turning an entry into a TODO, using checkboxes.
11096 This checks whether the current task should be blocked from state
11097 changes because there are unchecked boxes in this entry."
11098 (if (not org-enforce-todo-checkbox-dependencies)
11099 t ; if locally turned off don't block
11100 (catch 'dont-block
11101 ;; If this is not a todo state change, or if this entry is already DONE,
11102 ;; do not block
11103 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11104 (member (plist-get change-plist :from)
11105 (cons 'done org-done-keywords))
11106 (member (plist-get change-plist :to)
11107 (cons 'todo org-not-done-keywords))
11108 (not (plist-get change-plist :to)))
11109 (throw 'dont-block t))
11110 ;; If this task has checkboxes that are not checked, it's blocked
11111 (save-excursion
11112 (org-back-to-heading t)
11113 (let ((beg (point)) end)
11114 (outline-next-heading)
11115 (setq end (point))
11116 (goto-char beg)
11118 end t)
11119 (progn
11120 (if (boundp 'org-blocked-by-checkboxes)
11121 (setq org-blocked-by-checkboxes t))
11122 (throw 'dont-block nil)))))
11123 t))) ; do not block
11125 (defun org-entry-blocked-p ()
11126 "Is the current entry blocked?"
11127 (if (org-entry-get nil "NOBLOCKING")
11128 nil ;; Never block this entry
11129 (not
11130 (run-hook-with-args-until-failure
11131 'org-blocker-hook
11132 (list :type 'todo-state-change
11133 :position (point)
11134 :from 'todo
11135 :to 'done)))))
11137 (defun org-update-statistics-cookies (all)
11138 "Update the statistics cookie, either from TODO or from checkboxes.
11139 This should be called with the cursor in a line with a statistics cookie."
11140 (interactive "P")
11141 (if all
11142 (progn
11143 (org-update-checkbox-count 'all)
11144 (org-map-entries 'org-update-parent-todo-statistics))
11145 (if (not (org-on-heading-p))
11146 (org-update-checkbox-count)
11147 (let ((pos (move-marker (make-marker) (point)))
11148 end l1 l2)
11149 (ignore-errors (org-back-to-heading t))
11150 (if (not (org-on-heading-p))
11151 (org-update-checkbox-count)
11152 (setq l1 (org-outline-level))
11153 (setq end (save-excursion
11154 (outline-next-heading)
11155 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11156 (point)))
11157 (if (and (save-excursion
11158 (re-search-forward
11160 (not (save-excursion (re-search-forward
11162 (org-update-checkbox-count)
11163 (if (and l2 (> l2 l1))
11164 (progn
11165 (goto-char end)
11166 (org-update-parent-todo-statistics))
11167 (goto-char pos)
11168 (beginning-of-line 1)
11169 (while (re-search-forward
11171 (point-at-eol) t)
11172 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11173 (goto-char pos)
11174 (move-marker pos nil)))))
11176 (defvar org-entry-property-inherited-from) ;; defined below
11177 (defun org-update-parent-todo-statistics ()
11178 "Update any statistics cookie in the parent of the current headline.
11179 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11180 the entire subtree and this will travel up the hierarchy and update
11181 statistics everywhere."
11182 (interactive)
11183 (let* ((lim 0) prop
11184 (recursive (or (not org-hierarchical-todo-statistics)
11185 (string-match
11187 (or (setq prop (org-entry-get
11188 nil "COOKIE_DATA" 'inherit)) ""))))
11189 (lim (or (and prop (marker-position
11190 org-entry-property-inherited-from))
11191 lim))
11192 (first t)
11194 level ltoggle l1 new ndel
11195 (cnt-all 0) (cnt-done 0) is-percent kwd cookie-present)
11196 (catch 'exit
11197 (save-excursion
11198 (beginning-of-line 1)
11199 (if (org-at-heading-p)
11200 (setq ltoggle (funcall outline-level))
11201 (error "This should not happen"))
11202 (while (and (setq level (org-up-heading-safe))
11203 (or recursive first)
11204 (>= (point) lim))
11205 (setq first nil cookie-present nil)
11206 (unless (and level
11207 (not (string-match
11209 (downcase
11210 (or (org-entry-get
11211 nil "COOKIE_DATA")
11212 "")))))
11213 (throw 'exit nil))
11214 (while (re-search-forward box-re (point-at-eol) t)
11215 (setq cnt-all 0 cnt-done 0 cookie-present t)
11216 (setq is-percent (match-end 2))
11217 (save-match-data
11218 (unless (outline-next-heading) (throw 'exit nil))
11219 (while (and (looking-at org-complex-heading-regexp)
11220 (> (setq l1 (length (match-string 1))) level))
11221 (setq kwd (and (or recursive (= l1 ltoggle))
11222 (match-string 2)))
11223 (if (or (eq org-provide-todo-statistics 'all-headlines)
11224 (and (listp org-provide-todo-statistics)
11225 (or (member kwd org-provide-todo-statistics)
11226 (member kwd org-done-keywords))))
11227 (setq cnt-all (1+ cnt-all))
11228 (if (eq org-provide-todo-statistics t)
11229 (and kwd (setq cnt-all (1+ cnt-all)))))
11230 (and (member kwd org-done-keywords)
11231 (setq cnt-done (1+ cnt-done)))
11232 (outline-next-heading)))
11233 (setq new
11234 (if is-percent
11235 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11236 (format "[%d/%d]" cnt-done cnt-all))
11237 ndel (- (match-end 0) (match-beginning 0)))
11238 (goto-char (match-beginning 0))
11239 (insert new)
11240 (delete-region (point) (+ (point) ndel)))
11241 (when cookie-present
11242 (run-hook-with-args 'org-after-todo-statistics-hook
11243 cnt-done (- cnt-all cnt-done))))))
11244 (run-hooks 'org-todo-statistics-hook)))
11246 (defvar org-after-todo-statistics-hook nil
11247 "Hook that is called after a TODO statistics cookie has been updated.
11248 Each function is called with two arguments: the number of not-done entries
11249 and the number of done entries.
11251 For example, the following function, when added to this hook, will switch
11252 an entry to DONE when all children are done, and back to TODO when new
11253 entries are set to a TODO status. Note that this hook is only called
11254 when there is a statistics cookie in the headline!
11256 (defun org-summary-todo (n-done n-not-done)
11258 (let (org-log-done org-log-states) ; turn off logging
11260 ")
11262 (defvar org-todo-statistics-hook nil
11263 "Hook that is run whenever Org thinks TODO statistics should be updated.
11264 This hook runs even if there is no statistics cookie present, in which case
11265 `org-after-todo-statistics-hook' would not run.")
11267 (defun org-todo-trigger-tag-changes (state)
11268 "Apply the changes defined in `org-todo-state-tags-triggers'."
11269 (let ((l org-todo-state-tags-triggers)
11270 changes)
11271 (when (or (not state) (equal state ""))
11272 (setq changes (append changes (cdr (assoc "" l)))))
11273 (when (and (stringp state) (> (length state) 0))
11274 (setq changes (append changes (cdr (assoc state l)))))
11275 (when (member state org-not-done-keywords)
11276 (setq changes (append changes (cdr (assoc 'todo l)))))
11277 (when (member state org-done-keywords)
11278 (setq changes (append changes (cdr (assoc 'done l)))))
11279 (dolist (c changes)
11280 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11282 (defun org-local-logging (value)
11283 "Get logging settings from a property VALUE."
11284 (let* (words w a)
11285 ;; directly set the variables, they are already local.
11286 (setq org-log-done nil
11287 org-log-repeat nil
11288 org-todo-log-states nil)
11289 (setq words (org-split-string value))
11290 (while (setq w (pop words))
11291 (cond
11292 ((setq a (assoc w org-startup-options))
11293 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11294 (set (nth 1 a) (nth 2 a))))
11295 ((setq a (org-extract-log-state-settings w))
11296 (and (member (car a) org-todo-keywords-1)
11297 (push a org-todo-log-states)))))))
11299 (defun org-get-todo-sequence-head (kwd)
11300 "Return the head of the TODO sequence to which KWD belongs.
11301 If KWD is not set, check if there is a text property remembering the
11302 right sequence."
11303 (let (p)
11304 (cond
11305 ((not kwd)
11306 (or (get-text-property (point-at-bol) 'org-todo-head)
11307 (progn
11308 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11309 nil (point-at-eol)))
11310 (get-text-property p 'org-todo-head))))
11311 ((not (member kwd org-todo-keywords-1))
11312 (car org-todo-keywords-1))
11313 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11315 (defun org-fast-todo-selection ()
11316 "Fast TODO keyword selection with single keys.
11317 Returns the new TODO keyword, or nil if no state change should occur."
11318 (let* ((fulltable org-todo-key-alist)
11319 (done-keywords org-done-keywords) ;; needed for the faces.
11320 (maxlen (apply 'max (mapcar
11321 (lambda (x)
11322 (if (stringp (car x)) (string-width (car x)) 0))
11323 fulltable)))
11324 (expert nil)
11325 (fwidth (+ maxlen 3 1 3))
11326 (ncol (/ (- (window-width) 4) fwidth))
11327 tg cnt e c tbl
11328 groups ingroup)
11329 (save-excursion
11330 (save-window-excursion
11331 (if expert
11332 (set-buffer (get-buffer-create " *Org todo*"))
11333 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11334 (erase-buffer)
11335 (org-set-local 'org-done-keywords done-keywords)
11336 (setq tbl fulltable cnt 0)
11337 (while (setq e (pop tbl))
11338 (cond
11339 ((equal e '(:startgroup))
11340 (push '() groups) (setq ingroup t)
11341 (when (not (= cnt 0))
11342 (setq cnt 0)
11344 (insert "{ "))
11345 ((equal e '(:endgroup))
11346 (setq ingroup nil cnt 0)
11348 ((equal e '(:newline))
11349 (when (not (= cnt 0))
11350 (setq cnt 0)
11352 (setq e (car tbl))
11353 (while (equal (car tbl) '(:newline))
11355 (setq tbl (cdr tbl)))))
11356 (t
11357 (setq tg (car e) c (cdr e))
11358 (if ingroup (push tg (car groups)))
11359 (setq tg (org-add-props tg nil 'face
11360 (org-get-todo-face tg)))
11361 (if (and (= cnt 0) (not ingroup)) (insert " "))
11362 (insert "[" c "] " tg (make-string
11363 (- fwidth 4 (length tg)) ?\ ))
11364 (when (= (setq cnt (1+ cnt)) ncol)
11366 (if ingroup (insert " "))
11367 (setq cnt 0)))))
11369 (goto-char (point-min))
11370 (if (not expert) (org-fit-window-to-buffer))
11371 (message "[a-z..]:Set [SPC]:clear")
11372 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11373 (cond
11374 ((or (= c ?\C-g)
11375 (and (= c ?q) (not (rassoc c fulltable))))
11376 (setq quit-flag t))
11377 ((= c ?\ ) nil)
11378 ((setq e (rassoc c fulltable) tg (car e))
11379 tg)
11380 (t (setq quit-flag t)))))))
11382 (defun org-entry-is-todo-p ()
11383 (member (org-get-todo-state) org-not-done-keywords))
11385 (defun org-entry-is-done-p ()
11386 (member (org-get-todo-state) org-done-keywords))
11388 (defun org-get-todo-state ()
11389 (save-excursion
11390 (org-back-to-heading t)
11391 (and (looking-at org-todo-line-regexp)
11392 (match-end 2)
11393 (match-string 2))))
11395 (defun org-at-date-range-p (&optional inactive-ok)
11396 "Is the cursor inside a date range?"
11397 (interactive)
11398 (save-excursion
11399 (catch 'exit
11400 (let ((pos (point)))
11402 (skip-chars-backward "<[")
11403 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11404 (>= (match-end 0) pos)
11405 (throw 'exit t))
11407 (skip-chars-backward "<[")
11408 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11409 (>= (match-end 0) pos)
11410 (throw 'exit t)))
11411 nil)))
11413 (defun org-get-repeat (&optional tagline)
11414 "Check if there is a deadline/schedule with repeater in this entry."
11415 (save-match-data
11416 (save-excursion
11417 (org-back-to-heading t)
11418 (and (re-search-forward (if tagline
11420 org-repeat-re)
11421 (org-entry-end-position) t)
11422 (match-string-no-properties 1)))))
11424 (defvar org-last-changed-timestamp)
11425 (defvar org-last-inserted-timestamp)
11426 (defvar org-log-post-message)
11427 (defvar org-log-note-purpose)
11428 (defvar org-log-note-how)
11429 (defvar org-log-note-extra)
11430 (defun org-auto-repeat-maybe (done-word)
11431 "Check if the current headline contains a repeated deadline/schedule.
11432 If yes, set TODO state back to what it was and change the base date
11433 of repeating deadline/scheduled time stamps to new date.
11434 This function is run automatically after each state change to a DONE state."
11435 ;; last-state is dynamically scoped into this function
11436 (let* ((repeat (org-get-repeat))
11437 (aa (assoc last-state org-todo-kwd-alist))
11438 (interpret (nth 1 aa))
11439 (head (nth 2 aa))
11440 (whata '(("d" . day) ("m" . month) ("y" . year)))
11441 (msg "Entry repeats: ")
11442 (org-log-done nil)
11443 (org-todo-log-states nil)
11444 re type n what ts time to-state)
11445 (when repeat
11446 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11447 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11448 org-todo-repeat-to-state))
11449 (unless (and to-state (member to-state org-todo-keywords-1))
11450 (setq to-state (if (eq interpret 'type) last-state head)))
11451 (org-todo to-state)
11452 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11453 (org-entry-put nil "LAST_REPEAT" (format-time-string
11454 (org-time-stamp-format t t))))
11455 (when org-log-repeat
11456 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11457 (memq 'org-add-log-note post-command-hook))
11458 ;; OK, we are already setup for some record
11459 (if (eq org-log-repeat 'note)
11460 ;; make sure we take a note, not only a time stamp
11461 (setq org-log-note-how 'note))
11462 ;; Set up for taking a record
11463 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11464 last-state
11465 'findpos org-log-repeat)))
11466 (org-back-to-heading t)
11467 (org-add-planning-info nil nil 'closed)
11471 (while (re-search-forward
11472 re (save-excursion (outline-next-heading) (point)) t)
11473 (setq type (if (match-end 1) org-scheduled-string
11474 (if (match-end 3) org-deadline-string "Plain:"))
11475 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11477 (setq n (string-to-number (match-string 2 ts))
11478 what (match-string 3 ts))
11479 (if (equal what "w") (setq n (* n 7) what "d"))
11480 ;; Preparation, see if we need to modify the start date for the change
11481 (when (match-end 1)
11482 (setq time (save-match-data (org-time-string-to-time ts)))
11483 (cond
11484 ((equal (match-string 1 ts) ".")
11485 ;; Shift starting date to today
11486 (org-timestamp-change
11487 (- (time-to-days (current-time)) (time-to-days time))
11488 'day))
11489 ((equal (match-string 1 ts) "+")
11490 (let ((nshiftmax 10) (nshift 0))
11491 (while (or (= nshift 0)
11492 (<= (time-to-days time)
11493 (time-to-days (current-time))))
11494 (when (= (incf nshift) nshiftmax)
11495 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11496 (error "Abort")))
11497 (org-timestamp-change n (cdr (assoc what whata)))
11498 (org-at-timestamp-p t)
11499 (setq ts (match-string 1))
11500 (setq time (save-match-data (org-time-string-to-time ts)))))
11501 (org-timestamp-change (- n) (cdr (assoc what whata)))
11502 ;; rematch, so that we have everything in place for the real shift
11503 (org-at-timestamp-p t)
11504 (setq ts (match-string 1))
11506 (org-timestamp-change n (cdr (assoc what whata)))
11507 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11508 (setq org-log-post-message msg)
11509 (message "%s" msg))))
11511 (defun org-show-todo-tree (arg)
11512 "Make a compact tree which shows all headlines marked with TODO.
11513 The tree will show the lines where the regexp matches, and all higher
11514 headlines above the match.
11516 With a numeric prefix N, construct a sparse tree for the Nth element
11517 of `org-todo-keywords-1'."
11518 (interactive "P")
11519 (let ((case-fold-search nil)
11520 (kwd-re
11521 (cond ((null arg) org-not-done-regexp)
11522 ((equal arg '(4))
11523 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11524 (mapcar 'list org-todo-keywords-1))))
11528 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11529 (regexp-quote (nth (1- (prefix-numeric-value arg))
11530 org-todo-keywords-1)))
11531 (t (error "Invalid prefix argument: %s" arg)))))
11532 (message "%d TODO entries found"
11533 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
11535 (defun org-deadline (&optional remove time)
11537 With argument REMOVE, remove any deadline from the item.
11538 When TIME is set, it should be an internal time specification, and the
11539 scheduling will use the corresponding date."
11540 (interactive "P")
11541 (let* ((old-date (org-entry-get nil "DEADLINE"))
11542 (repeater (and old-date
11544 (match-string 1 old-date))))
11545 (if remove
11546 (progn
11547 (when (and old-date org-log-redeadline)
11548 (org-add-log-setup 'deldeadline nil old-date 'findpos
11549 org-log-redeadline))
11550 (org-remove-timestamp-with-keyword org-deadline-string)
11551 (message "Item no longer has a deadline."))
11552 (org-add-planning-info 'deadline time 'closed)
11553 (when (and old-date org-log-redeadline
11554 (not (equal old-date
11555 (substring org-last-inserted-timestamp 1 -1))))
11556 (org-add-log-setup 'redeadline nil old-date 'findpos
11557 org-log-redeadline))
11558 (when repeater
11559 (save-excursion
11560 (org-back-to-heading t)
11561 (when (re-search-forward (concat org-deadline-string " "
11562 org-last-inserted-timestamp)
11563 (save-excursion
11564 (outline-next-heading) (point)) t)
11565 (goto-char (1- (match-end 0)))
11566 (insert " " repeater)
11567 (setq org-last-inserted-timestamp
11568 (concat (substring org-last-inserted-timestamp 0 -1)
11569 " " repeater
11570 (substring org-last-inserted-timestamp -1))))))
11571 (message "Deadline on %s" org-last-inserted-timestamp))))
11573 (defun org-schedule (&optional remove time)
11574 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11575 With argument REMOVE, remove any scheduling date from the item.
11576 When TIME is set, it should be an internal time specification, and the
11577 scheduling will use the corresponding date."
11578 (interactive "P")
11579 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11580 (repeater (and old-date
11582 (match-string 1 old-date))))
11583 (if remove
11584 (progn
11585 (when (and old-date org-log-reschedule)
11586 (org-add-log-setup 'delschedule nil old-date 'findpos
11587 org-log-reschedule))
11588 (org-remove-timestamp-with-keyword org-scheduled-string)
11589 (message "Item is no longer scheduled."))
11590 (org-add-planning-info 'scheduled time 'closed)
11591 (when (and old-date org-log-reschedule
11592 (not (equal old-date
11593 (substring org-last-inserted-timestamp 1 -1))))
11594 (org-add-log-setup 'reschedule nil old-date 'findpos
11595 org-log-reschedule))
11596 (when repeater
11597 (save-excursion
11598 (org-back-to-heading t)
11599 (when (re-search-forward (concat org-scheduled-string " "
11600 org-last-inserted-timestamp)
11601 (save-excursion
11602 (outline-next-heading) (point)) t)
11603 (goto-char (1- (match-end 0)))
11604 (insert " " repeater)
11605 (setq org-last-inserted-timestamp
11606 (concat (substring org-last-inserted-timestamp 0 -1)
11607 " " repeater
11608 (substring org-last-inserted-timestamp -1))))))
11609 (message "Scheduled to %s" org-last-inserted-timestamp))))
11611 (defun org-get-scheduled-time (pom &optional inherit)
11612 "Get the scheduled time as a time tuple, of a format suitable
11613 for calling org-schedule with, or if there is no scheduling,
11614 returns nil."
11615 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11616 (when time
11617 (apply 'encode-time (org-parse-time-string time)))))
11619 (defun org-get-deadline-time (pom &optional inherit)
11620 "Get the deadline as a time tuple, of a format suitable for
11621 calling org-deadline with, or if there is no scheduling, returns
11622 nil."
11623 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11624 (when time
11625 (apply 'encode-time (org-parse-time-string time)))))
11627 (defun org-remove-timestamp-with-keyword (keyword)
11628 "Remove all time stamps with KEYWORD in the current entry."
11630 beg)
11631 (save-excursion
11632 (org-back-to-heading t)
11633 (setq beg (point))
11634 (outline-next-heading)
11635 (while (re-search-backward re beg t)
11636 (replace-match "")
11638 (equal (char-before) ?\ ))
11639 (backward-delete-char 1)
11641 (point-at-bol) (point-at-eol)))
11642 (delete-region (point-at-bol)
11643 (min (point-max) (1+ (point-at-eol))))))))))
11645 (defun org-add-planning-info (what &optional time &rest remove)
11646 "Insert new timestamp with keyword in the line directly after the headline.
11647 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11648 If non is given, the user is prompted for a date.
11649 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11650 be removed."
11651 (interactive)
11652 (let (org-time-was-given org-end-time-was-given ts
11653 end default-time default-input)
11655 (catch 'exit
11656 (when (and (not time) (memq what '(scheduled deadline)))
11657 ;; Try to get a default date/time from existing timestamp
11658 (save-excursion
11659 (org-back-to-heading t)
11660 (setq end (save-excursion (outline-next-heading) (point)))
11661 (when (re-search-forward (if (eq what 'scheduled)
11662 org-scheduled-time-regexp
11663 org-deadline-time-regexp)
11664 end t)
11665 (setq ts (match-string 1)
11666 default-time
11667 (apply 'encode-time (org-parse-time-string ts))
11668 default-input (and ts (org-get-compact-tod ts))))))
11669 (when what
11670 ;; If necessary, get the time from the user
11671 (setq time (or time (org-read-date nil 'to-time nil nil
11672 default-time default-input))))
11674 (when (and org-insert-labeled-timestamps-at-point
11675 (member what '(scheduled deadline)))
11676 (insert
11677 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11678 (org-insert-time-stamp time org-time-was-given
11679 nil nil nil (list org-end-time-was-given))
11680 (setq what nil))
11681 (save-excursion
11682 (save-restriction
11683 (let (col list elt ts buffer-invisibility-spec)
11684 (org-back-to-heading t)
11686 (goto-char (match-end 1))
11687 (setq col (current-column))
11688 (goto-char (match-end 0))
11690 (when (and (not what)
11691 (not (looking-at
11693 org-keyword-time-not-clock-regexp))))
11694 ;; Nothing to add, nothing to remove...... :-)
11695 (throw 'exit nil))
11696 (if (and (not (looking-at outline-regexp))
11699 (not (equal (match-string 1) org-clock-string)))
11700 (narrow-to-region (match-beginning 0) (match-end 0))
11702 (backward-char 1)
11703 (narrow-to-region (point) (point))
11704 (and org-adapt-indentation (org-indent-to-column col)))
11705 ;; Check if we have to remove something.
11706 (setq list (cons what remove))
11707 (while list
11708 (setq elt (pop list))
11709 (goto-char (point-min))
11710 (when (or (and (eq elt 'scheduled)
11711 (re-search-forward org-scheduled-time-regexp nil t))
11712 (and (eq elt 'deadline)
11713 (re-search-forward org-deadline-time-regexp nil t))
11714 (and (eq elt 'closed)
11715 (re-search-forward org-closed-time-regexp nil t)))
11716 (replace-match "")
11717 (if (looking-at "--+<[^>]+>") (replace-match ""))
11718 (skip-chars-backward " ")
11719 (if (looking-at " +") (replace-match ""))))
11720 (goto-char (point-max))
11721 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11722 (when what
11723 (insert
11724 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11725 (cond ((eq what 'scheduled) org-scheduled-string)
11726 ((eq what 'deadline) org-deadline-string)
11727 ((eq what 'closed) org-closed-string))
11728 " ")
11729 (setq ts (org-insert-time-stamp
11730 time
11731 (or org-time-was-given
11732 (and (eq what 'closed) org-log-done-with-time))
11733 (eq what 'closed)
11734 nil nil (list org-end-time-was-given)))
11735 (end-of-line 1))
11736 (goto-char (point-min))
11737 (widen)
11740 (delete-region (1- (point)) (point-at-eol)))
11741 ts))))))
11743 (defvar org-log-note-marker (make-marker))
11744 (defvar org-log-note-purpose nil)
11745 (defvar org-log-note-state nil)
11746 (defvar org-log-note-previous-state nil)
11747 (defvar org-log-note-how nil)
11748 (defvar org-log-note-extra nil)
11749 (defvar org-log-note-window-configuration nil)
11750 (defvar org-log-note-return-to (make-marker))
11751 (defvar org-log-post-message nil
11752 "Message to be displayed after a log note has been stored.
11753 The auto-repeater uses this.")
11755 (defun org-add-note ()
11756 "Add a note to the current entry.
11757 This is done in the same way as adding a state change note."
11758 (interactive)
11759 (org-add-log-setup 'note nil nil 'findpos nil))
11761 (defvar org-property-end-re)
11762 (defun org-add-log-setup (&optional purpose state prev-state
11763 findpos how extra)
11764 "Set up the post command hook to take a note.
11765 If this is about to TODO state change, the new state is expected in STATE.
11766 When FINDPOS is non-nil, find the correct position for the note in
11767 the current entry. If not, assume that it can be inserted at point.
11768 HOW is an indicator what kind of note should be created.
11769 EXTRA is additional text that will be inserted into the notes buffer."
11770 (let* ((org-log-into-drawer (org-log-into-drawer))
11771 (drawer (cond ((stringp org-log-into-drawer)
11772 org-log-into-drawer)
11773 (org-log-into-drawer "LOGBOOK")
11774 (t nil))))
11775 (save-restriction
11776 (save-excursion
11777 (when findpos
11778 (org-back-to-heading t)
11779 (narrow-to-region (point) (save-excursion
11780 (outline-next-heading) (point)))
11784 (goto-char (match-end 0))
11785 (cond
11786 (drawer
11788 nil t)
11789 (progn
11790 (goto-char (match-end 0))
11791 (or org-log-states-order-reversed
11792 (and (re-search-forward org-property-end-re nil t)
11793 (goto-char (1- (match-beginning 0))))))
11795 (beginning-of-line 0)
11796 (org-indent-line-function)
11797 (beginning-of-line 2)
11798 (org-indent-line-function)
11799 (end-of-line 0)))
11800 ((and org-log-state-notes-insert-after-drawers
11801 (save-excursion
11802 (forward-line) (looking-at org-drawer-regexp)))
11803 (forward-line)
11804 (while (looking-at org-drawer-regexp)
11805 (goto-char (match-end 0))
11806 (re-search-forward org-property-end-re (point-max) t)
11807 (forward-line))
11808 (forward-line -1)))
11809 (unless org-log-states-order-reversed
11811 (org-skip-over-state-notes)
11813 (move-marker org-log-note-marker (point))
11814 (setq org-log-note-purpose purpose
11815 org-log-note-state state
11816 org-log-note-previous-state prev-state
11817 org-log-note-how how
11818 org-log-note-extra extra)
11819 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11821 (defun org-skip-over-state-notes ()
11822 "Skip past the list of State notes in an entry."
11824 (when (org-in-item-p)
11825 (let ((limit (org-list-bottom-point)))
11827 (goto-char (or (org-get-next-item (point) limit)
11828 (org-get-end-of-item limit)))))))
11830 (defun org-add-log-note (&optional purpose)
11831 "Pop up a window for taking a note, and add this note later at point."
11832 (remove-hook 'post-command-hook 'org-add-log-note)
11833 (setq org-log-note-window-configuration (current-window-configuration))
11834 (delete-other-windows)
11835 (move-marker org-log-note-return-to (point))
11836 (switch-to-buffer (marker-buffer org-log-note-marker))
11837 (goto-char org-log-note-marker)
11838 (org-switch-to-buffer-other-window "*Org Note*")
11839 (erase-buffer)
11840 (if (memq org-log-note-how '(time state))
11841 (let (current-prefix-arg) (org-store-log-note))
11842 (let ((org-inhibit-startup t)) (org-mode))
11843 (insert (format "# Insert note for %s.
11845 (cond
11846 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11847 ((eq org-log-note-purpose 'done) "closed todo item")
11848 ((eq org-log-note-purpose 'state)
11850 (or org-log-note-previous-state "")
11851 (or org-log-note-state "")))
11852 ((eq org-log-note-purpose 'reschedule)
11853 "rescheduling")
11854 ((eq org-log-note-purpose 'delschedule)
11855 "no longer scheduled")
11856 ((eq org-log-note-purpose 'redeadline)
11857 "changing deadline")
11858 ((eq org-log-note-purpose 'deldeadline)
11859 "removing deadline")
11860 ((eq org-log-note-purpose 'refile)
11861 "refiling")
11862 ((eq org-log-note-purpose 'note)
11863 "this entry")
11864 (t (error "This should not happen")))))
11865 (if org-log-note-extra (insert org-log-note-extra))
11866 (org-set-local 'org-finish-function 'org-store-log-note)))
11868 (defvar org-note-abort nil) ; dynamically scoped
11869 (defun org-store-log-note ()
11870 "Finish taking a log note, and insert it to where it belongs."
11871 (let ((txt (buffer-string))
11872 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11873 lines ind bul)
11874 (kill-buffer (current-buffer))
11876 (setq txt (replace-match "" t t txt)))
11878 (setq txt (replace-match "" t t txt)))
11881 (setq note
11882 (org-replace-escapes
11883 note
11884 (list (cons "%u" (user-login-name))
11885 (cons "%U" user-full-name)
11886 (cons "%t" (format-time-string
11887 (org-time-stamp-format 'long 'inactive)
11888 (current-time)))
11889 (cons "%T" (format-time-string
11890 (org-time-stamp-format 'long nil)
11891 (current-time)))
11892 (cons "%s" (if org-log-note-state
11894 ""))
11895 (cons "%S" (if org-log-note-previous-state
11899 (push note lines))
11900 (when (or current-prefix-arg org-note-abort)
11901 (when org-log-into-drawer
11902 (org-remove-empty-drawer-at
11903 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11904 org-log-note-marker))
11905 (setq lines nil))
11906 (when lines
11907 (with-current-buffer (marker-buffer org-log-note-marker)
11908 (save-excursion
11909 (goto-char org-log-note-marker)
11910 (move-marker org-log-note-marker nil)
11911 (end-of-line 1)
11913 (setq ind (save-excursion
11914 (if (org-in-item-p)
11915 (progn
11916 (goto-char (org-list-top-point))
11917 (org-get-indentation))
11919 (cond
11920 ((and (org-at-heading-p)
11921 org-adapt-indentation)
11922 (1+ (org-current-level)))
11923 ((org-at-heading-p) 0)
11924 (t (org-get-indentation))))))
11925 (setq bul (org-list-bullet-string "-"))
11926 (org-indent-line-to ind)
11927 (insert bul (pop lines))
11928 (let ((ind-body (+ (length bul) ind)))
11929 (while lines
11931 (org-indent-line-to ind-body)
11932 (insert (pop lines))))
11933 (message "Note stored")
11934 (org-back-to-heading t)
11935 (org-cycle-hide-drawers 'children)))))
11936 (set-window-configuration org-log-note-window-configuration)
11937 (with-current-buffer (marker-buffer org-log-note-return-to)
11938 (goto-char org-log-note-return-to))
11939 (move-marker org-log-note-return-to nil)
11940 (and org-log-post-message (message "%s" org-log-post-message)))
11942 (defun org-remove-empty-drawer-at (drawer pos)
11943 "Remove an empty drawer DRAWER at position POS.
11944 POS may also be a marker."
11945 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
11946 (save-excursion
11947 (save-restriction
11948 (widen)
11949 (goto-char pos)
11950 (if (org-in-regexp
11952 (replace-match ""))))))
11954 (defun org-sparse-tree (&optional arg)
11955 "Create a sparse tree, prompt for the details.
11956 This command can create sparse trees. You first need to select the type
11957 of match used to create the tree:
11959 t Show all TODO entries.
11960 T Show entries with a specific TODO keyword.
11961 m Show entries selected by a tags/property match.
11962 p Enter a property name and its value (both with completion on existing
11963 names/values) and show entries with that property.
11964 / Show entries matching a regular expression (`r' can be used as well)
11965 d Show deadlines due within `org-deadline-warning-days'.
11966 b Show deadlines and scheduled items before a date.
11967 a Show deadlines and scheduled items after a date."
11968 (interactive "P")
11969 (let (ans kwd value)
11970 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty [d]eadlines\n [b]efore-date [a]fter-date")
11971 (setq ans (read-char-exclusive))
11972 (cond
11973 ((equal ans ?d)
11974 (call-interactively 'org-check-deadlines))
11975 ((equal ans ?b)
11976 (call-interactively 'org-check-before-date))
11977 ((equal ans ?a)
11978 (call-interactively 'org-check-after-date))
11979 ((equal ans ?t)
11980 (org-show-todo-tree nil))
11981 ((equal ans ?T)
11982 (org-show-todo-tree '(4)))
11983 ((member ans '(?T ?m))
11984 (call-interactively 'org-match-sparse-tree))
11985 ((member ans '(?p ?P))
11986 (setq kwd (org-icompleting-read "Property: "
11987 (mapcar 'list (org-buffer-property-keys))))
11988 (setq value (org-icompleting-read "Value: "
11989 (mapcar 'list (org-property-values kwd))))
11992 (org-match-sparse-tree arg (concat kwd "=" value)))
11993 ((member ans '(?r ?R ?/))
11994 (call-interactively 'org-occur))
11997 (defvar org-occur-highlights nil
11998 "List of overlays used for occur matches.")
11999 (make-variable-buffer-local 'org-occur-highlights)
12000 (defvar org-occur-parameters nil
12001 "Parameters of the active org-occur calls.
12002 This is a list, each call to org-occur pushes as cons cell,
12003 containing the regular expression and the callback, onto the list.
12004 The list can contain several entries if `org-occur' has been called
12005 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12006 will only contain one set of parameters. When the highlights are
12007 removed (for example with `C-c C-c', or with the next edit (depending
12008 on `org-remove-highlights-with-change'), this variable is emptied
12009 as well.")
12010 (make-variable-buffer-local 'org-occur-parameters)
12012 (defun org-occur (regexp &optional keep-previous callback)
12013 "Make a compact tree which shows all matches of REGEXP.
12014 The tree will show the lines where the regexp matches, and all higher
12015 headlines above the match. It will also show the heading after the match,
12016 to make sure editing the matching entry is easy.
12017 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12018 call to `org-occur' will be kept, to allow stacking of calls to this
12019 command.
12020 If CALLBACK is non-nil, it is a function which is called to confirm
12021 that the match should indeed be shown."
12023 (when (equal regexp "")
12024 (error "Regexp cannot be empty"))
12025 (unless keep-previous
12026 (org-remove-occur-highlights nil nil t))
12027 (push (cons regexp callback) org-occur-parameters)
12028 (let ((cnt 0))
12029 (save-excursion
12030 (goto-char (point-min))
12031 (if (or (not keep-previous) ; do not want to keep
12032 (not org-occur-highlights)) ; no previous matches
12033 ;; hide everything
12034 (org-overview))
12035 (while (re-search-forward regexp nil t)
12036 (when (or (not callback)
12037 (save-match-data (funcall callback)))
12038 (setq cnt (1+ cnt))
12039 (when org-highlight-sparse-tree-matches
12040 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12041 (org-show-context 'occur-tree))))
12042 (when org-remove-highlights-with-change
12043 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12044 nil 'local))
12045 (unless org-sparse-tree-open-archived-trees
12046 (org-hide-archived-subtrees (point-min) (point-max)))
12047 (run-hooks 'org-occur-hook)
12048 (if (interactive-p)
12049 (message "%d match(es) for regexp %s" cnt regexp))
12050 cnt))
12052 (defun org-show-context (&optional key)
12053 "Make sure point and context are visible.
12054 How much context is shown depends upon the variables
12055 `org-show-hierarchy-above', `org-show-following-heading'. and
12056 `org-show-siblings'."
12057 (let ((heading-p (org-on-heading-p t))
12058 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12059 (following-p (org-get-alist-option org-show-following-heading key))
12060 (entry-p (org-get-alist-option org-show-entry-below key))
12061 (siblings-p (org-get-alist-option org-show-siblings key)))
12062 (catch 'exit
12063 ;; Show heading or entry text
12064 (if (and heading-p (not entry-p))
12065 (org-flag-heading nil) ; only show the heading
12066 (and (or entry-p (org-invisible-p) (org-invisible-p2))
12067 (org-show-hidden-entry))) ; show entire entry
12068 (when following-p
12069 ;; Show next sibling, or heading below text
12070 (save-excursion
12071 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12072 (org-flag-heading nil))))
12073 (when siblings-p (org-show-siblings))
12074 (when hierarchy-p
12075 ;; show all higher headings, possibly with siblings
12076 (save-excursion
12077 (while (and (condition-case nil
12078 (progn (org-up-heading-all 1) t)
12079 (error nil))
12080 (not (bobp)))
12081 (org-flag-heading nil)
12082 (when siblings-p (org-show-siblings))))))))
12084 (defvar org-reveal-start-hook nil
12085 "Hook run before revealing a location.")
12087 (defun org-reveal (&optional siblings)
12088 "Show current entry, hierarchy above it, and the following headline.
12089 This can be used to show a consistent set of context around locations
12090 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12091 not t for the search context.
12093 With optional argument SIBLINGS, on each level of the hierarchy all
12094 siblings are shown. This repairs the tree structure to what it would
12095 look like when opened with hierarchical calls to `org-cycle'.
12097 go to the parent and show the
12098 entire tree."
12099 (interactive "P")
12100 (run-hooks 'org-reveal-start-hook)
12101 (let ((org-show-hierarchy-above t)
12102 (org-show-following-heading t)
12103 (org-show-siblings (if siblings t org-show-siblings)))
12104 (org-show-context nil))
12105 (when (equal siblings '(16))
12106 (save-excursion
12107 (when (org-up-heading-safe)
12108 (org-show-subtree)
12109 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12111 (defun org-highlight-new-match (beg end)
12112 "Highlight from BEG to END and mark the highlight is an occur headline."
12113 (let ((ov (make-overlay beg end)))
12114 (overlay-put ov 'face 'secondary-selection)
12115 (push ov org-occur-highlights)))
12117 (defun org-remove-occur-highlights (&optional beg end noremove)
12118 "Remove the occur highlights from the buffer.
12119 BEG and END are ignored. If NOREMOVE is nil, remove this function
12120 from the `before-change-functions' in the current buffer."
12121 (interactive)
12122 (unless org-inhibit-highlight-removal
12123 (mapc 'delete-overlay org-occur-highlights)
12124 (setq org-occur-highlights nil)
12125 (setq org-occur-parameters nil)
12126 (unless noremove
12127 (remove-hook 'before-change-functions
12128 'org-remove-occur-highlights 'local))))
12130 ;;;; Priorities
12133 "Regular expression matching the priority indicator.")
12135 (defvar org-remove-priority-next-time nil)
12137 (defun org-priority-up ()
12138 "Increase the priority of the current item."
12139 (interactive)
12140 (org-priority 'up))
12142 (defun org-priority-down ()
12143 "Decrease the priority of the current item."
12144 (interactive)
12145 (org-priority 'down))
12147 (defun org-priority (&optional action)
12148 "Change the priority of an item by ARG.
12149 ACTION can be `set', `up', `down', or a character."
12150 (interactive)
12151 (unless org-enable-priority-commands
12152 (error "Priority commands are disabled"))
12153 (setq action (or action 'set))
12154 (let (current new news have remove)
12155 (save-excursion
12156 (org-back-to-heading t)
12157 (if (looking-at org-priority-regexp)
12158 (setq current (string-to-char (match-string 2))
12159 have t)
12160 (setq current org-default-priority))
12161 (cond
12162 ((eq action 'remove)
12163 (setq remove t new ?\ ))
12164 ((or (eq action 'set)
12165 (if (featurep 'xemacs) (characterp action) (integerp action)))
12166 (if (not (eq action 'set))
12167 (setq new action)
12168 (message "Priority %c-%c, SPC to remove: "
12169 org-highest-priority org-lowest-priority)
12170 (save-match-data
12171 (setq new (read-char-exclusive))))
12172 (if (and (= (upcase org-highest-priority) org-highest-priority)
12173 (= (upcase org-lowest-priority) org-lowest-priority))
12174 (setq new (upcase new)))
12175 (cond ((equal new ?\ ) (setq remove t))
12176 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12177 (error "Priority must be between `%c' and `%c'"
12178 org-highest-priority org-lowest-priority))))
12179 ((eq action 'up)
12180 (if (and (not have) (eq last-command this-command))
12181 (setq new org-lowest-priority)
12182 (setq new (if (and org-priority-start-cycle-with-default (not have))
12183 org-default-priority (1- current)))))
12184 ((eq action 'down)
12185 (if (and (not have) (eq last-command this-command))
12186 (setq new org-highest-priority)
12187 (setq new (if (and org-priority-start-cycle-with-default (not have))
12188 org-default-priority (1+ current)))))
12189 (t (error "Invalid action")))
12190 (if (or (< (upcase new) org-highest-priority)
12191 (> (upcase new) org-lowest-priority))
12192 (setq remove t))
12193 (setq news (format "%c" new))
12194 (if have
12195 (if remove
12196 (replace-match "" t t nil 1)
12197 (replace-match news t t nil 2))
12198 (if remove
12199 (error "No priority cookie found in line")
12200 (let ((case-fold-search nil))
12201 (looking-at org-todo-line-regexp))
12202 (if (match-end 2)
12203 (progn
12204 (goto-char (match-end 2))
12205 (insert " [#" news "]"))
12206 (goto-char (match-beginning 3))
12207 (insert "[#" news "] "))))
12208 (org-preserve-lc (org-set-tags nil 'align)))
12209 (if remove
12210 (message "Priority removed")
12211 (message "Priority of current item set to %s" news))))
12213 (defun org-get-priority (s)
12214 "Find priority cookie and return priority."
12215 (save-match-data
12216 (if (not (string-match org-priority-regexp s))
12217 (* 1000 (- org-lowest-priority org-default-priority))
12218 (* 1000 (- org-lowest-priority
12219 (string-to-char (match-string 2 s)))))))
12221 ;;;; Tags
12223 (defvar org-agenda-archives-mode)
12224 (defvar org-map-continue-from nil
12225 "Position from where mapping should continue.
12226 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12228 (defvar org-scanner-tags nil
12229 "The current tag list while the tags scanner is running.")
12230 (defvar org-trust-scanner-tags nil
12231 "Should `org-get-tags-at' use the tags fro the scanner.
12232 This is for internal dynamical scoping only.
12233 When this is non-nil, the function `org-get-tags-at' will return the value
12234 of `org-scanner-tags' instead of building the list by itself. This
12235 can lead to large speed-ups when the tags scanner is used in a file with
12236 many entries, and when the list of tags is retrieved, for example to
12237 obtain a list of properties. Building the tags list for each entry in such
12238 a file becomes an N^2 operation - but with this variable set, it scales
12239 as N.")
12241 (defun org-scan-tags (action matcher &optional todo-only)
12242 "Scan headline tags with inheritance and produce output ACTION.
12244 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12245 or `agenda' to produce an entry list for an agenda view. It can also be
12246 a Lisp form or a function that should be called at each matched headline, in
12247 this case the return value is a list of all return values from these calls.
12249 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12250 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12251 only lines with a TODO keyword are included in the output."
12252 (require 'org-agenda)
12255 (org-re
12257 (props (list 'face 'default
12258 'done-face 'org-agenda-done
12259 'undone-face 'default
12260 'mouse-face 'highlight
12261 'org-not-done-regexp org-not-done-regexp
12262 'org-todo-regexp org-todo-regexp
12263 'help-echo
12264 (format "mouse-2 or RET jump to org file %s"
12265 (abbreviate-file-name
12266 (or (buffer-file-name (buffer-base-buffer))
12267 (buffer-name (buffer-base-buffer)))))))
12268 (case-fold-search nil)
12269 (org-map-continue-from nil)
12270 lspos tags tags-list
12271 (tags-alist (list (cons 0 org-file-tags)))
12272 (llast 0) rtn rtn1 level category i txt
12273 todo marker entry priority)
12274 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12275 (setq action (list 'lambda nil action)))
12276 (save-excursion
12277 (goto-char (point-min))
12278 (when (eq action 'sparse-tree)
12279 (org-overview)
12280 (org-remove-occur-highlights))
12281 (while (re-search-forward re nil t)
12282 (catch :skip
12283 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12284 tags (if (match-end 4) (org-match-string-no-properties 4)))
12285 (goto-char (setq lspos (match-beginning 0)))
12286 (setq level (org-reduced-level (funcall outline-level))
12287 category (org-get-category))
12288 (setq i llast llast level)
12289 ;; remove tag lists from same and sublevels
12290 (while (>= i level)
12291 (when (setq entry (assoc i tags-alist))
12292 (setq tags-alist (delete entry tags-alist)))
12293 (setq i (1- i)))
12294 ;; add the next tags
12295 (when tags
12296 (setq tags (org-split-string tags ":")
12297 tags-alist
12298 (cons (cons level tags) tags-alist)))
12299 ;; compile tags for current headline
12300 (setq tags-list
12301 (if org-use-tag-inheritance
12302 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12303 tags)
12304 org-scanner-tags tags-list)
12305 (when org-use-tag-inheritance
12306 (setcdr (car tags-alist)
12307 (mapcar (lambda (x)
12308 (setq x (copy-sequence x))
12309 (org-add-prop-inherited x))
12310 (cdar tags-alist))))
12311 (when (and tags org-use-tag-inheritance
12312 (or (not (eq t org-use-tag-inheritance))
12313 org-tags-exclude-from-inheritance))
12314 ;; selective inheritance, remove uninherited ones
12315 (setcdr (car tags-alist)
12316 (org-remove-uniherited-tags (cdar tags-alist))))
12317 (when (and (or (not todo-only)
12318 (and (member todo org-not-done-keywords)
12319 (or (not org-agenda-tags-todo-honor-ignore-options)
12320 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12321 (let ((case-fold-search t)) (eval matcher))
12322 (or
12323 (not (member org-archive-tag tags-list))
12324 ;; we have an archive tag, should we use this anyway?
12325 (or (not org-agenda-skip-archived-trees)
12326 (and (eq action 'agenda) org-agenda-archives-mode))))
12327 (unless (eq action 'sparse-tree) (org-agenda-skip))
12329 ;; select this headline
12331 (cond
12332 ((eq action 'sparse-tree)
12333 (and org-highlight-sparse-tree-matches
12334 (org-get-heading) (match-end 0)
12335 (org-highlight-new-match
12336 (match-beginning 0) (match-beginning 1)))
12337 (org-show-context 'tags-tree))
12338 ((eq action 'agenda)
12339 (setq txt (org-format-agenda-item
12340 ""
12341 (concat
12342 (if (eq org-tags-match-list-sublevels 'indented)
12343 (make-string (1- level) ?.) "")
12344 (org-get-heading))
12345 category
12346 tags-list
12347 )
12348 priority (org-get-priority txt))
12349 (goto-char lspos)
12350 (setq marker (org-agenda-new-marker))
12351 (org-add-props txt props
12352 'org-marker marker 'org-hd-marker marker 'org-category category
12353 'todo-state todo
12354 'priority priority 'type "tagsmatch")
12355 (push txt rtn))
12356 ((functionp action)
12357 (setq org-map-continue-from nil)
12358 (save-excursion
12359 (setq rtn1 (funcall action))
12360 (push rtn1 rtn)))
12361 (t (error "Invalid action")))
12363 ;; if we are to skip sublevels, jump to end of subtree
12364 (unless org-tags-match-list-sublevels
12365 (org-end-of-subtree t)
12366 (backward-char 1))))
12367 ;; Get the correct position from where to continue
12368 (if org-map-continue-from
12369 (goto-char org-map-continue-from)
12370 (and (= (point) lspos) (end-of-line 1)))))
12371 (when (and (eq action 'sparse-tree)
12372 (not org-sparse-tree-open-archived-trees))
12373 (org-hide-archived-subtrees (point-min) (point-max)))
12374 (nreverse rtn)))
12376 (defun org-remove-uniherited-tags (tags)
12377 "Remove all tags that are not inherited from the list TAGS."
12378 (cond
12379 ((eq org-use-tag-inheritance t)
12380 (if org-tags-exclude-from-inheritance
12381 (org-delete-all org-tags-exclude-from-inheritance tags)
12382 tags))
12383 ((not org-use-tag-inheritance) nil)
12384 ((stringp org-use-tag-inheritance)
12385 (delq nil (mapcar
12386 (lambda (x)
12387 (if (and (string-match org-use-tag-inheritance x)
12388 (not (member x org-tags-exclude-from-inheritance)))
12389 x nil))
12390 tags)))
12391 ((listp org-use-tag-inheritance)
12392 (delq nil (mapcar
12393 (lambda (x)
12394 (if (member x org-use-tag-inheritance) x nil))
12395 tags)))))
12397 (defvar todo-only) ;; dynamically scoped
12399 (defun org-match-sparse-tree (&optional todo-only match)
12400 "Create a sparse tree according to tags string MATCH.
12401 MATCH can contain positive and negative selection of tags, like
12403 If optional argument TODO-ONLY is non-nil, only select lines that are
12404 also TODO lines."
12405 (interactive "P")
12406 (org-prepare-agenda-buffers (list (current-buffer)))
12407 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12409 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12411 (defvar org-cached-props nil)
12412 (defun org-cached-entry-get (pom property)
12413 (if (or (eq t org-use-property-inheritance)
12414 (and (stringp org-use-property-inheritance)
12415 (string-match org-use-property-inheritance property))
12416 (and (listp org-use-property-inheritance)
12417 (member property org-use-property-inheritance)))
12418 ;; Caching is not possible, check it directly
12419 (org-entry-get pom property 'inherit)
12420 ;; Get all properties, so that we can do complicated checks easily
12421 (cdr (assoc property (or org-cached-props
12422 (setq org-cached-props
12423 (org-entry-properties pom)))))))
12425 (defun org-global-tags-completion-table (&optional files)
12426 "Return the list of all tags in all agenda buffer/files."
12427 (save-excursion
12428 (org-uniquify
12429 (delq nil
12430 (apply 'append
12431 (mapcar
12432 (lambda (file)
12433 (set-buffer (find-file-noselect file))
12434 (append (org-get-buffer-tags)
12435 (mapcar (lambda (x) (if (stringp (car-safe x))
12436 (list (car-safe x)) nil))
12437 org-tag-alist)))
12438 (if (and files (car files))
12439 files
12440 (org-agenda-files))))))))
12442 (defun org-make-tags-matcher (match)
12443 "Create the TAGS//TODO matcher form for the selection string MATCH."
12444 ;; todo-only is scoped dynamically into this function, and the function
12445 ;; may change it if the matcher asks for it.
12446 (unless match
12447 ;; Get a new match request, with completion
12448 (let ((org-last-tags-completion-table
12449 (org-global-tags-completion-table)))
12450 (setq match (org-completing-read-no-i
12451 "Match: " 'org-tags-completion-function nil nil nil
12452 'org-tags-history))))
12454 ;; Parse the string and create a lisp form
12455 (let ((match0 match)
12456 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12457 minus tag mm
12458 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12459 orterms term orlist re-p str-p level-p level-op time-p
12460 prop-p pn pv po cat-p gv rest)
12461 (if (string-match "/+" match)
12462 ;; match contains also a todo-matching request
12463 (progn
12464 (setq tagsmatch (substring match 0 (match-beginning 0))
12465 todomatch (substring match (match-end 0)))
12466 (if (string-match "^!" todomatch)
12467 (setq todo-only t todomatch (substring todomatch 1)))
12469 (setq todomatch nil)))
12470 ;; only matching tags
12471 (setq tagsmatch match todomatch nil))
12473 ;; Make the tags matcher
12475 (setq tagsmatcher t)
12476 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12477 (while (setq term (pop orterms))
12479 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12480 (while (string-match re term)
12481 (setq rest (substring term (match-end 0))
12482 minus (and (match-end 1)
12483 (equal (match-string 1 term) "-"))
12484 tag (save-match-data (replace-regexp-in-string
12486 (match-string 2 term)))
12487 re-p (equal (string-to-char tag) ?{)
12488 level-p (match-end 4)
12489 prop-p (match-end 5)
12490 mm (cond
12491 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12492 (level-p
12493 (setq level-op (org-op-to-function (match-string 3 term)))
12494 `(,level-op level ,(string-to-number
12495 (match-string 4 term))))
12496 (prop-p
12497 (setq pn (match-string 5 term)
12498 po (match-string 6 term)
12499 pv (match-string 7 term)
12500 cat-p (equal pn "CATEGORY")
12501 re-p (equal (string-to-char pv) ?{)
12503 time-p (save-match-data
12505 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12506 (if time-p (setq pv (org-matcher-time pv)))
12507 (setq po (org-op-to-function po (if time-p 'time str-p)))
12508 (cond
12509 ((equal pn "CATEGORY")
12510 (setq gv '(get-text-property (point) 'org-category)))
12511 ((equal pn "TODO")
12512 (setq gv 'todo))
12513 (t
12514 (setq gv `(org-cached-entry-get nil ,pn))))
12515 (if re-p
12516 (if (eq po 'org<>)
12517 `(not (string-match ,pv (or ,gv "")))
12518 `(string-match ,pv (or ,gv "")))
12519 (if str-p
12520 `(,po (or ,gv "") ,pv)
12521 `(,po (string-to-number (or ,gv ""))
12522 ,(string-to-number pv) ))))
12523 (t `(member ,tag tags-list)))
12524 mm (if minus (list 'not mm) mm)
12525 term rest)
12526 (push mm tagsmatcher))
12527 (push (if (> (length tagsmatcher) 1)
12528 (cons 'and tagsmatcher)
12529 (car tagsmatcher))
12530 orlist)
12531 (setq tagsmatcher nil))
12532 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12533 (setq tagsmatcher
12534 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12535 ;; Make the todo matcher
12537 (setq todomatcher t)
12538 (setq orterms (org-split-string todomatch "|") orlist nil)
12539 (while (setq term (pop orterms))
12540 (while (string-match re term)
12541 (setq minus (and (match-end 1)
12542 (equal (match-string 1 term) "-"))
12543 kwd (match-string 2 term)
12544 re-p (equal (string-to-char kwd) ?{)
12545 term (substring term (match-end 0))
12546 mm (if re-p
12547 `(string-match ,(substring kwd 1 -1) todo)
12548 (list 'equal 'todo kwd))
12549 mm (if minus (list 'not mm) mm))
12550 (push mm todomatcher))
12551 (push (if (> (length todomatcher) 1)
12552 (cons 'and todomatcher)
12553 (car todomatcher))
12554 orlist)
12555 (setq todomatcher nil))
12556 (setq todomatcher (if (> (length orlist) 1)
12557 (cons 'or orlist) (car orlist))))
12559 ;; Return the string and lisp forms of the matcher
12560 (setq matcher (if todomatcher
12561 (list 'and tagsmatcher todomatcher)
12562 tagsmatcher))
12563 (cons match0 matcher)))
12565 (defun org-op-to-function (op &optional stringp)
12566 "Turn an operator into the appropriate function."
12567 (setq op
12568 (cond
12569 ((equal op "<" ) '(< string< org-time<))
12570 ((equal op ">" ) '(> org-string> org-time>))
12571 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12572 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12573 ((member op '("=" "==")) '(= string= org-time=))
12574 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12575 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12577 (defun org<> (a b) (not (= a b)))
12578 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12579 (defun org-string>= (a b) (not (string< a b)))
12580 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12581 (defun org-string<> (a b) (not (string= 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) (< a b)))
12584 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12585 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12586 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12587 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12588 (defun org-2ft (s)
12589 "Convert S to a floating point time.
12590 If S is already a number, just return it. If it is a string, parse
12591 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12592 (cond
12593 ((numberp s) s)
12594 ((stringp s)
12595 (condition-case nil
12596 (float-time (apply 'encode-time (org-parse-time-string s)))
12597 (error 0.)))
12598 (t 0.)))
12600 (defun org-time-today ()
12601 "Time in seconds today at 0:00.
12602 Returns the float number of seconds since the beginning of the
12603 epoch to the beginning of today (00:00)."
12604 (float-time (apply 'encode-time
12605 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12607 (defun org-matcher-time (s)
12608 "Interpret a time comparison value."
12609 (save-match-data
12610 (cond
12611 ((string= s "<now>") (float-time))
12612 ((string= s "<today>") (org-time-today))
12613 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12614 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12616 (+ (org-time-today)
12617 (* (string-to-number (match-string 1 s))
12618 (cdr (assoc (match-string 2 s)
12619 '(("d" . 86400.0) ("w" . 604800.0)
12620 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12621 (t (org-2ft s)))))
12623 (defun org-match-any-p (re list)
12624 "Does re match any element of list?"
12625 (setq list (mapcar (lambda (x) (string-match re x)) list))
12626 (delq nil list))
12628 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12629 (defvar org-tags-overlay (make-overlay 1 1))
12630 (org-detach-overlay org-tags-overlay)
12632 (defun org-get-local-tags-at (&optional pos)
12633 "Get a list of tags defined in the current headline."
12634 (org-get-tags-at pos 'local))
12636 (defun org-get-local-tags ()
12637 "Get a list of tags defined in the current headline."
12638 (org-get-tags-at nil 'local))
12640 (defun org-get-tags-at (&optional pos local)
12641 "Get a list of all headline tags applicable at POS.
12642 POS defaults to point. If tags are inherited, the list contains
12643 the targets in the same sequence as the headlines appear, i.e.
12644 the tags of the current headline come last.
12645 When LOCAL is non-nil, only return tags from the current headline,
12646 ignore inherited ones."
12647 (interactive)
12648 (if (and org-trust-scanner-tags
12649 (or (not pos) (equal pos (point)))
12650 (not local))
12651 org-scanner-tags
12652 (let (tags ltags lastpos parent)
12653 (save-excursion
12654 (save-restriction
12655 (widen)
12656 (goto-char (or pos (point)))
12657 (save-match-data
12658 (catch 'done
12659 (condition-case nil
12660 (progn
12661 (org-back-to-heading t)
12662 (while (not (equal lastpos (point)))
12663 (setq lastpos (point))
12664 (when (looking-at
12666 (setq ltags (org-split-string
12667 (org-match-string-no-properties 1) ":"))
12668 (when parent
12669 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12670 (setq tags (append
12671 (if parent
12672 (org-remove-uniherited-tags ltags)
12673 ltags)
12674 tags)))
12675 (or org-use-tag-inheritance (throw 'done t))
12676 (if local (throw 'done t))
12677 (or (org-up-heading-safe) (error nil))
12678 (setq parent t)))
12679 (error nil)))))
12680 (append (org-remove-uniherited-tags org-file-tags) tags)))))
12682 (defun org-add-prop-inherited (s)
12683 (add-text-properties 0 (length s) '(inherited t) s)
12684 s)
12686 (defun org-toggle-tag (tag &optional onoff)
12687 "Toggle the tag TAG for the current line.
12688 If ONOFF is `on' or `off', don't toggle but set to this state."
12689 (let (res current)
12690 (save-excursion
12691 (org-back-to-heading t)
12693 (point-at-eol) t)
12694 (progn
12695 (setq current (match-string 1))
12696 (replace-match ""))
12697 (setq current ""))
12698 (setq current (nreverse (org-split-string current ":")))
12699 (cond
12700 ((eq onoff 'on)
12701 (setq res t)
12702 (or (member tag current) (push tag current)))
12703 ((eq onoff 'off)
12704 (or (not (member tag current)) (setq current (delete tag current))))
12705 (t (if (member tag current)
12706 (setq current (delete tag current))
12707 (setq res t)
12708 (push tag current))))
12709 (end-of-line 1)
12710 (if current
12711 (progn
12712 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12713 (org-set-tags nil t))
12714 (delete-horizontal-space))
12715 (run-hooks 'org-after-tags-change-hook))
12716 res))
12718 (defun org-align-tags-here (to-col)
12719 ;; Assumes that this is a headline
12720 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12721 (beginning-of-line 1)
12723 (< pos (match-beginning 2)))
12724 (progn
12725 (setq tags-l (- (match-end 2) (match-beginning 2)))
12726 (goto-char (match-beginning 1))
12727 (insert " ")
12728 (delete-region (point) (1+ (match-beginning 2)))
12729 (setq ncol (max (1+ (current-column))
12730 (1+ col)
12731 (if (> to-col 0)
12732 to-col
12733 (- (abs to-col) tags-l))))
12734 (setq p (point))
12735 (insert (make-string (- ncol (current-column)) ?\ ))
12736 (setq ncol (current-column))
12737 (when indent-tabs-mode (tabify p (point-at-eol)))
12738 (org-move-to-column (min ncol col) t))
12739 (goto-char pos))))
12741 (defun org-set-tags-command (&optional arg just-align)
12742 "Call the set-tags command for the current entry."
12743 (interactive "P")
12744 (if (org-on-heading-p)
12745 (org-set-tags arg just-align)
12746 (save-excursion
12747 (org-back-to-heading t)
12748 (org-set-tags arg just-align))))
12750 (defun org-set-tags-to (data)
12751 "Set the tags of the current entry to DATA, replacing the current tags.
12752 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12753 If DATA is nil or the empty string, any tags will be removed."
12754 (interactive "sTags: ")
12755 (setq data
12756 (cond
12757 ((eq data nil) "")
12758 ((equal data "") "")
12759 ((stringp data)
12760 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12761 ":"))
12762 ((listp data)
12763 (concat ":" (mapconcat 'identity data ":") ":"))
12764 (t nil)))
12765 (when data
12766 (save-excursion
12767 (org-back-to-heading t)
12768 (when (looking-at org-complex-heading-regexp)
12769 (if (match-end 5)
12770 (progn
12771 (goto-char (match-beginning 5))
12772 (insert data)
12773 (delete-region (point) (point-at-eol))
12774 (org-set-tags nil 'align))
12775 (goto-char (point-at-eol))
12776 (insert " " data)
12777 (org-set-tags nil 'align)))
12778 (beginning-of-line 1)
12780 (delete-region (match-beginning 1) (match-end 1))))))
12782 (defun org-align-all-tags ()
12783 "Align the tags i all headings."
12784 (interactive)
12785 (save-excursion
12786 (or (ignore-errors (org-back-to-heading t))
12787 (outline-next-heading))
12788 (if (org-on-heading-p)
12789 (org-set-tags t)
12790 (message "No headings"))))
12792 (defvar org-indent-indentation-per-level)
12793 (defun org-set-tags (&optional arg just-align)
12794 "Set the tags for the current headline.
12795 With prefix ARG, realign all tags in headings in the current buffer."
12796 (interactive "P")
12797 (let* ((re (concat "^" outline-regexp))
12798 (current (org-get-tags-string))
12799 (col (current-column))
12800 (org-setting-tags t)
12801 table current-tags inherited-tags ; computed below when needed
12802 tags p0 c0 c1 rpl di tc level)
12803 (if arg
12804 (save-excursion
12805 (goto-char (point-min))
12806 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12807 (while (re-search-forward re nil t)
12808 (org-set-tags nil t)
12809 (end-of-line 1)))
12810 (message "All tags realigned to column %d" org-tags-column))
12811 (if just-align
12812 (setq tags current)
12813 ;; Get a new set of tags from the user
12814 (save-excursion
12815 (setq table (append org-tag-persistent-alist
12816 (or org-tag-alist (org-get-buffer-tags))
12817 (and
12818 org-complete-tags-always-offer-all-agenda-tags
12819 (org-global-tags-completion-table
12820 (org-agenda-files))))
12821 org-last-tags-completion-table table
12822 current-tags (org-split-string current ":")
12823 inherited-tags (nreverse
12824 (nthcdr (length current-tags)
12825 (nreverse (org-get-tags-at))))
12826 tags
12827 (if (or (eq t org-use-fast-tag-selection)
12828 (and org-use-fast-tag-selection
12829 (delq nil (mapcar 'cdr table))))
12830 (org-fast-tag-selection
12831 current-tags inherited-tags table
12832 (if org-fast-tag-selection-include-todo
12833 org-todo-key-alist))
12834 (let ((org-add-colon-after-tag-completion t))
12835 (org-trim
12836 (org-without-partial-completion
12837 (org-icompleting-read "Tags: "
12838 'org-tags-completion-function
12839 nil nil current 'org-tags-history)))))))
12840 (while (string-match "[-+&]+" tags)
12841 ;; No boolean logic, just a list
12842 (setq tags (replace-match ":" t t tags))))
12844 (setq tags (replace-regexp-in-string "[ ,]" ":" tags))
12846 (if org-tags-sort-function
12847 (setq tags (mapconcat 'identity
12848 (sort (org-split-string
12849 tags (org-re "[^[:alnum:]_@#%]+"))
12850 org-tags-sort-function) ":")))
12853 (setq tags "")
12854 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12855 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12857 ;; Insert new tags at the correct column
12858 (beginning-of-line 1)
12859 (setq level (or (and (looking-at org-outline-regexp)
12860 (- (match-end 0) (point) 1))
12861 1))
12862 (cond
12863 ((and (equal current "") (equal tags "")))
12864 ((re-search-forward
12866 (point-at-eol) t)
12867 (if (equal tags "")
12868 (setq rpl "")
12869 (goto-char (match-beginning 0))
12870 (setq c0 (current-column)
12871 ;; compute offset for the case of org-indent-mode active
12872 di (if org-indent-mode
12873 (* (1- org-indent-indentation-per-level) (1- level))
12874 0)
12875 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
12876 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
12877 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
12878 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
12879 (replace-match rpl t t)
12880 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
12881 tags)
12882 (t (error "Tags alignment failed")))
12883 (org-move-to-column col)
12884 (unless just-align
12885 (run-hooks 'org-after-tags-change-hook)))))
12887 (defun org-change-tag-in-region (beg end tag off)
12888 "Add or remove TAG for each entry in the region.
12889 This works in the agenda, and also in an org-mode buffer."
12890 (interactive
12891 (list (region-beginning) (region-end)
12892 (let ((org-last-tags-completion-table
12893 (if (org-mode-p)
12894 (org-get-buffer-tags)
12895 (org-global-tags-completion-table))))
12896 (org-icompleting-read
12897 "Tag: " 'org-tags-completion-function nil nil nil
12898 'org-tags-history))
12899 (progn
12901 (equal (read-char-exclusive) ?r))))
12902 (if (fboundp 'deactivate-mark) (deactivate-mark))
12903 (let ((agendap (equal major-mode 'org-agenda-mode))
12904 l1 l2 m buf pos newhead (cnt 0))
12905 (goto-char end)
12906 (setq l2 (1- (org-current-line)))
12907 (goto-char beg)
12908 (setq l1 (org-current-line))
12909 (loop for l from l1 to l2 do
12910 (org-goto-line l)
12911 (setq m (get-text-property (point) 'org-hd-marker))
12912 (when (or (and (org-mode-p) (org-on-heading-p))
12913 (and agendap m))
12914 (setq buf (if agendap (marker-buffer m) (current-buffer))
12915 pos (if agendap m (point)))
12916 (with-current-buffer buf
12917 (save-excursion
12918 (save-restriction
12919 (goto-char pos)
12920 (setq cnt (1+ cnt))
12921 (org-toggle-tag tag (if off 'off 'on))
12922 (setq newhead (org-get-heading)))))
12923 (and agendap (org-agenda-change-all-lines newhead m))))
12924 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
12926 (defun org-tags-completion-function (string predicate &optional flag)
12927 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
12928 (confirm (lambda (x) (stringp (car x)))))
12930 (setq s1 (match-string 1 string)
12931 s2 (match-string 2 string))
12932 (setq s1 "" s2 string))
12933 (cond
12934 ((eq flag nil)
12935 ;; try completion
12936 (setq rtn (try-completion s2 ctable confirm))
12937 (if (stringp rtn)
12938 (setq rtn
12939 (concat s1 s2 (substring rtn (length s2))
12940 (if (and org-add-colon-after-tag-completion
12941 (assoc rtn ctable))
12942 ":" ""))))
12943 rtn)
12944 ((eq flag t)
12945 ;; all-completions
12946 (all-completions s2 ctable confirm)
12947 )
12948 ((eq flag 'lambda)
12949 ;; exact match?
12950 (assoc s2 ctable)))
12951 ))
12953 (defun org-fast-tag-insert (kwd tags face &optional end)
12954 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
12955 (insert (format "%-12s" (concat kwd ":"))
12956 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
12957 (or end "")))
12959 (defun org-fast-tag-show-exit (flag)
12960 (save-excursion
12961 (org-goto-line 3)
12963 (replace-match ""))
12964 (when flag
12965 (end-of-line 1)
12966 (org-move-to-column (- (window-width) 19) t)
12967 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
12969 (defun org-set-current-tags-overlay (current prefix)
12970 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
12971 (if (featurep 'xemacs)
12972 (org-overlay-display org-tags-overlay (concat prefix s)
12973 'secondary-selection)
12974 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
12975 (org-overlay-display org-tags-overlay (concat prefix s)))))
12977 (defvar org-last-tag-selection-key nil)
12978 (defun org-fast-tag-selection (current inherited table &optional todo-table)
12979 "Fast tag selection with single keys.
12980 CURRENT is the current list of tags in the headline, INHERITED is the
12981 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
12982 possibly with grouping information. TODO-TABLE is a similar table with
12983 TODO keywords, should these have keys assigned to them.
12984 If the keys are nil, a-z are automatically assigned.
12985 Returns the new tags string, or nil to not change the current settings."
12986 (let* ((fulltable (append table todo-table))
12987 (maxlen (apply 'max (mapcar
12988 (lambda (x)
12989 (if (stringp (car x)) (string-width (car x)) 0))
12990 fulltable)))
12991 (buf (current-buffer))
12992 (expert (eq org-fast-tag-selection-single-key 'expert))
12993 (buffer-tags nil)
12994 (fwidth (+ maxlen 3 1 3))
12995 (ncol (/ (- (window-width) 4) fwidth))
12996 (i-face 'org-done)
12997 (c-face 'org-todo)
12998 tg cnt e c char c1 c2 ntable tbl rtn
12999 ov-start ov-end ov-prefix
13000 (exit-after-next org-fast-tag-selection-single-key)
13001 (done-keywords org-done-keywords)
13002 groups ingroup)
13003 (save-excursion
13004 (beginning-of-line 1)
13005 (if (looking-at
13007 (setq ov-start (match-beginning 1)
13008 ov-end (match-end 1)
13009 ov-prefix "")
13010 (setq ov-start (1- (point-at-eol))
13011 ov-end (1+ ov-start))
13013 (setq ov-prefix
13014 (concat
13015 (buffer-substring (1- (point)) (point))
13016 (if (> (current-column) org-tags-column)
13017 " "
13018 (make-string (- org-tags-column (current-column)) ?\ ))))))
13019 (move-overlay org-tags-overlay ov-start ov-end)
13020 (save-window-excursion
13021 (if expert
13022 (set-buffer (get-buffer-create " *Org tags*"))
13023 (delete-other-windows)
13024 (split-window-vertically)
13025 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13026 (erase-buffer)
13027 (org-set-local 'org-done-keywords done-keywords)
13030 (org-fast-tag-show-exit exit-after-next)
13031 (org-set-current-tags-overlay current ov-prefix)
13032 (setq tbl fulltable char ?a cnt 0)
13033 (while (setq e (pop tbl))
13034 (cond
13035 ((equal (car e) :startgroup)
13036 (push '() groups) (setq ingroup t)
13037 (when (not (= cnt 0))
13038 (setq cnt 0)
13040 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13041 ((equal (car e) :endgroup)
13042 (setq ingroup nil cnt 0)
13044 ((equal e '(:newline))
13045 (when (not (= cnt 0))
13046 (setq cnt 0)
13048 (setq e (car tbl))
13049 (while (equal (car tbl) '(:newline))
13051 (setq tbl (cdr tbl)))))
13052 (t
13053 (setq tg (copy-sequence (car e)) c2 nil)
13054 (if (cdr e)
13055 (setq c (cdr e))
13056 ;; automatically assign a character.
13057 (setq c1 (string-to-char
13058 (downcase (substring
13059 tg (if (= (string-to-char tg) ?@) 1 0)))))
13060 (if (or (rassoc c1 ntable) (rassoc c1 table))
13061 (while (or (rassoc char ntable) (rassoc char table))
13062 (setq char (1+ char)))
13063 (setq c2 c1))
13064 (setq c (or c2 char)))
13065 (if ingroup (push tg (car groups)))
13066 (setq tg (org-add-props tg nil 'face
13067 (cond
13068 ((not (assoc tg table))
13069 (org-get-todo-face tg))
13070 ((member tg current) c-face)
13071 ((member tg inherited) i-face)
13072 (t nil))))
13073 (if (and (= cnt 0) (not ingroup)) (insert " "))
13074 (insert "[" c "] " tg (make-string
13075 (- fwidth 4 (length tg)) ?\ ))
13076 (push (cons tg c) ntable)
13077 (when (= (setq cnt (1+ cnt)) ncol)
13079 (if ingroup (insert " "))
13080 (setq cnt 0)))))
13081 (setq ntable (nreverse ntable))
13083 (goto-char (point-min))
13084 (if (not expert) (org-fit-window-to-buffer))
13085 (setq rtn
13086 (catch 'exit
13087 (while t
13088 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13089 (if (not groups) "no " "")
13090 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13091 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13092 (setq org-last-tag-selection-key c)
13093 (cond
13095 ((= c ?!)
13096 (setq groups (not groups))
13097 (goto-char (point-min))
13098 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13099 ((= c ?\C-c)
13100 (if (not expert)
13101 (org-fast-tag-show-exit
13102 (setq exit-after-next (not exit-after-next)))
13103 (setq expert nil)
13104 (delete-other-windows)
13105 (split-window-vertically)
13106 (org-switch-to-buffer-other-window " *Org tags*")
13107 (org-fit-window-to-buffer)))
13108 ((or (= c ?\C-g)
13109 (and (= c ?q) (not (rassoc c ntable))))
13110 (org-detach-overlay org-tags-overlay)
13111 (setq quit-flag t))
13112 ((= c ?\ )
13113 (setq current nil)
13114 (if exit-after-next (setq exit-after-next 'now)))
13116 (condition-case nil
13117 (setq tg (org-icompleting-read
13118 "Tag: "
13119 (or buffer-tags
13120 (with-current-buffer buf
13121 (org-get-buffer-tags)))))
13122 (quit (setq tg "")))
13124 (add-to-list 'buffer-tags (list tg))
13125 (if (member tg current)
13126 (setq current (delete tg current))
13127 (push tg current)))
13128 (if exit-after-next (setq exit-after-next 'now)))
13129 ((setq e (rassoc c todo-table) tg (car e))
13130 (with-current-buffer buf
13131 (save-excursion (org-todo tg)))
13132 (if exit-after-next (setq exit-after-next 'now)))
13133 ((setq e (rassoc c ntable) tg (car e))
13134 (if (member tg current)
13135 (setq current (delete tg current))
13136 (loop for g in groups do
13137 (if (member tg g)
13138 (mapc (lambda (x)
13139 (setq current (delete x current)))
13140 g)))
13141 (push tg current))
13142 (if exit-after-next (setq exit-after-next 'now))))
13144 ;; Create a sorted list
13145 (setq current
13146 (sort current
13147 (lambda (a b)
13148 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13149 (if (eq exit-after-next 'now) (throw 'exit t))
13150 (goto-char (point-min))
13151 (beginning-of-line 2)
13152 (delete-region (point) (point-at-eol))
13153 (org-fast-tag-insert "Current" current c-face)
13154 (org-set-current-tags-overlay current ov-prefix)
13155 (while (re-search-forward
13157 (setq tg (match-string 1))
13158 (add-text-properties
13159 (match-beginning 1) (match-end 1)
13160 (list 'face
13161 (cond
13162 ((member tg current) c-face)
13163 ((member tg inherited) i-face)
13164 (t (get-text-property (match-beginning 1) 'face))))))
13165 (goto-char (point-min)))))
13166 (org-detach-overlay org-tags-overlay)
13167 (if rtn
13168 (mapconcat 'identity current ":")
13169 nil))))
13171 (defun org-get-tags-string ()
13172 "Get the TAGS string in the current headline."
13173 (unless (org-on-heading-p t)
13174 (error "Not on a heading"))
13175 (save-excursion
13176 (beginning-of-line 1)
13178 (org-match-string-no-properties 1)
13179 "")))
13181 (defun org-get-tags ()
13182 "Get the list of tags specified in the current headline."
13183 (org-split-string (org-get-tags-string) ":"))
13185 (defun org-get-buffer-tags ()
13186 "Get a table of all tags used in the buffer, for completion."
13187 (let (tags)
13188 (save-excursion
13189 (goto-char (point-min))
13190 (while (re-search-forward
13192 (when (equal (char-after (point-at-bol 0)) ?*)
13193 (mapc (lambda (x) (add-to-list 'tags x))
13194 (org-split-string (org-match-string-no-properties 1) ":")))))
13195 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13196 (mapcar 'list tags)))
13198 ;;;; The mapping API
13200 ;;;###autoload
13201 (defun org-map-entries (func &optional match scope &rest skip)
13202 "Call FUNC at each headline selected by MATCH in SCOPE.
13204 FUNC is a function or a lisp form. The function will be called without
13205 arguments, with the cursor positioned at the beginning of the headline.
13206 The return values of all calls to the function will be collected and
13207 returned as a list.
13209 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13210 does not need to preserve point. After evaluation, the cursor will be
13211 moved to the end of the line (presumably of the headline of the
13212 processed entry) and search continues from there. Under some
13213 circumstances, this may not produce the wanted results. For example,
13214 if you have removed (e.g. archived) the current (sub)tree it could
13215 mean that the next entry will be skipped entirely. In such cases, you
13216 can specify the position from where search should continue by making
13217 FUNC set the variable `org-map-continue-from' to the desired buffer
13218 position.
13220 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13221 Only headlines that are matched by this query will be considered during
13222 the iteration. When MATCH is nil or t, all headlines will be
13223 visited by the iteration.
13225 SCOPE determines the scope of this command. It can be any of:
13227 nil The current buffer, respecting the restriction if any
13228 tree The subtree started with the entry at point
13229 file The current buffer, without restriction
13230 file-with-archives
13231 The current buffer, and any archives associated with it
13232 agenda All agenda files
13233 agenda-with-archives
13234 All agenda files with any archive files associated with them
13235 \(file1 file2 ...)
13236 If this is a list, all files in the list will be scanned
13238 The remaining args are treated as settings for the skipping facilities of
13239 the scanner. The following items can be given here:
13241 archive skip trees with the archive tag.
13242 comment skip trees with the COMMENT keyword
13243 function or Emacs Lisp form:
13244 will be used as value for `org-agenda-skip-function', so whenever
13245 the function returns t, FUNC will not be called for that
13246 entry and search will continue from the point where the
13247 function leaves it.
13249 If your function needs to retrieve the tags including inherited tags
13250 at the *current* entry, you can use the value of the variable
13251 `org-scanner-tags' which will be much faster than getting the value
13252 with `org-get-tags-at'. If your function gets properties with
13253 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13254 to t around the call to `org-entry-properties' to get the same speedup.
13255 Note that if your function moves around to retrieve tags and properties at
13256 a *different* entry, you cannot use these techniques."
13257 (let* ((org-agenda-archives-mode nil) ; just to make sure
13258 (org-agenda-skip-archived-trees (memq 'archive skip))
13259 (org-agenda-skip-comment-trees (memq 'comment skip))
13260 (org-agenda-skip-function
13261 (car (org-delete-all '(comment archive) skip)))
13262 (org-tags-match-list-sublevels t)
13263 matcher file res
13264 org-todo-keywords-for-agenda
13265 org-done-keywords-for-agenda
13266 org-todo-keyword-alist-for-agenda
13267 org-drawers-for-agenda
13268 org-tag-alist-for-agenda)
13270 (cond
13271 ((eq match t) (setq matcher t))
13272 ((eq match nil) (setq matcher t))
13273 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13275 (save-excursion
13276 (save-restriction
13277 (when (eq scope 'tree)
13278 (org-back-to-heading t)
13279 (org-narrow-to-subtree)
13280 (setq scope nil))
13282 (if (not scope)
13283 (progn
13284 (org-prepare-agenda-buffers
13285 (list (buffer-file-name (current-buffer))))
13286 (setq res (org-scan-tags func matcher)))
13287 ;; Get the right scope
13288 (cond
13289 ((and scope (listp scope) (symbolp (car scope)))
13290 (setq scope (eval scope)))
13291 ((eq scope 'agenda)
13292 (setq scope (org-agenda-files t)))
13293 ((eq scope 'agenda-with-archives)
13294 (setq scope (org-agenda-files t))
13295 (setq scope (org-add-archive-files scope)))
13296 ((eq scope 'file)
13297 (setq scope (list (buffer-file-name))))
13298 ((eq scope 'file-with-archives)
13299 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13300 (org-prepare-agenda-buffers scope)
13301 (while (setq file (pop scope))
13302 (with-current-buffer (org-find-base-buffer-visiting file)
13303 (save-excursion
13304 (save-restriction
13305 (widen)
13306 (goto-char (point-min))
13307 (setq res (append res (org-scan-tags func matcher))))))))))
13308 res))
13310 ;;;; Properties
13312 ;;; Setting and retrieving properties
13314 (defconst org-special-properties
13315 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13316 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED")
13317 "The special properties valid in Org-mode.
13319 These are properties that are not defined in the property drawer,
13320 but in some other way.")
13322 (defconst org-default-properties
13323 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13324 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13325 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13326 "EXPORT_FILE_NAME" "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13327 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13328 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13329 "Some properties that are used by Org-mode for various purposes.
13330 Being in this list makes sure that they are offered for completion.")
13333 "Regular expression matching the first line of a property drawer.")
13336 "Regular expression matching the last line of a property drawer.")
13339 "Regular expression matching the first line of a property drawer.")
13342 "Regular expression matching the first line of a property drawer.")
13344 (defconst org-property-drawer-re
13347 "Matches an entire property drawer.")
13349 (defconst org-clock-drawer-re
13352 "Matches an entire clock drawer.")
13354 (defun org-property-action ()
13355 "Do an action on properties."
13356 (interactive)
13357 (let (c)
13358 (org-at-property-p)
13359 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13360 (setq c (read-char-exclusive))
13361 (cond
13362 ((equal c ?s)
13363 (call-interactively 'org-set-property))
13364 ((equal c ?d)
13365 (call-interactively 'org-delete-property))
13366 ((equal c ?D)
13367 (call-interactively 'org-delete-property-globally))
13368 ((equal c ?c)
13369 (call-interactively 'org-compute-property-at-point))
13370 (t (error "No such property action %c" c)))))
13372 (defun org-set-effort (&optional value)
13373 "Set the effort property of the current entry.
13374 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13375 allowed value."
13376 (interactive "P")
13377 (if (equal value 0) (setq value 10))
13378 (let* ((completion-ignore-case t)
13379 (prop org-effort-property)
13380 (cur (org-entry-get nil prop))
13381 (allowed (org-property-get-allowed-values nil prop 'table))
13382 (existing (mapcar 'list (org-property-values prop)))
13383 rpl
13384 (val (cond
13385 ((stringp value) value)
13386 ((and allowed (integerp value))
13387 (or (car (nth (1- value) allowed))
13388 (car (org-last allowed))))
13389 (allowed
13390 (message "Select 1-9,0, [RET%s]: %s"
13391 (if cur (concat "=" cur) "")
13392 (mapconcat 'car allowed " "))
13393 (setq rpl (read-char-exclusive))
13395 cur
13396 (setq rpl (- rpl ?0))
13397 (if (equal rpl 0) (setq rpl 10))
13398 (if (and (> rpl 0) (<= rpl (length allowed)))
13399 (car (nth (1- rpl) allowed))
13400 (org-completing-read "Effort: " allowed nil))))
13401 (t
13402 (let (org-completion-use-ido org-completion-use-iswitchb)
13403 (org-completing-read
13405 (concat "[" cur "]") "")
13406 ": ")
13407 existing nil nil "" nil cur))))))
13408 (unless (equal (org-entry-get nil prop) val)
13409 (org-entry-put nil prop val))
13410 (message "%s is now %s" prop val)))
13412 (defun org-at-property-p ()
13413 "Is cursor inside a property drawer?"
13414 (save-excursion
13415 (beginning-of-line 1)
13417 (save-match-data ;; Used by calling procedures
13418 (let ((p (point))
13419 (range (unless (org-before-first-heading-p)
13420 (org-get-property-block))))
13421 (and range (<= (car range) p) (< p (cdr range))))))))
13423 (defun org-get-property-block (&optional beg end force)
13424 "Return the (beg . end) range of the body of the property drawer.
13425 BEG and END can be beginning and end of subtree, if not given
13426 they will be found.
13427 If the drawer does not exist and FORCE is non-nil, create the drawer."
13428 (catch 'exit
13429 (save-excursion
13430 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13431 (end (or end (progn (outline-next-heading) (point)))))
13432 (goto-char beg)
13433 (if (re-search-forward org-property-start-re end t)
13434 (setq beg (1+ (match-end 0)))
13435 (if force
13436 (save-excursion
13437 (org-insert-property-drawer)
13438 (setq end (progn (outline-next-heading) (point))))
13439 (throw 'exit nil))
13440 (goto-char beg)
13441 (if (re-search-forward org-property-start-re end t)
13442 (setq beg (1+ (match-end 0)))))
13443 (if (re-search-forward org-property-end-re end t)
13444 (setq end (match-beginning 0))
13445 (or force (throw 'exit nil))
13446 (goto-char beg)
13447 (setq end beg)
13448 (org-indent-line-function)
13450 (cons beg end)))))
13452 (defun org-entry-properties (&optional pom which specific)
13453 "Get all properties of the entry at point-or-marker POM.
13454 This includes the TODO keyword, the tags, time strings for deadline,
13455 scheduled, and clocking, and any additional properties defined in the
13456 entry. The return value is an alist, keys may occur multiple times
13457 if the property key was used several times.
13458 POM may also be nil, in which case the current entry is used.
13459 If WHICH is nil or `all', get all properties. If WHICH is
13460 `special' or `standard', only get that subclass. If WHICH
13461 is a string only get exactly this property. Specific can be a string, the
13462 specific property we are interested in. Specifying it can speed
13463 things up because then unnecessary parsing is avoided."
13464 (setq which (or which 'all))
13465 (org-with-point-at pom
13466 (let ((clockstr (substring org-clock-string 0 -1))
13467 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13468 (case-fold-search nil)
13469 beg end range props sum-props key key1 value string clocksum)
13470 (save-excursion
13471 (when (condition-case nil
13472 (and (org-mode-p) (org-back-to-heading t))
13473 (error nil))
13474 (setq beg (point))
13475 (setq sum-props (get-text-property (point) 'org-summaries))
13476 (setq clocksum (get-text-property (point) :org-clock-minutes))
13477 (outline-next-heading)
13478 (setq end (point))
13479 (when (memq which '(all special))
13480 ;; Get the special properties, like TODO and tags
13481 (goto-char beg)
13482 (when (and (or (not specific) (string= specific "TODO"))
13483 (looking-at org-todo-line-regexp) (match-end 2))
13484 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13485 (when (and (or (not specific) (string= specific "PRIORITY"))
13486 (looking-at org-priority-regexp))
13487 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13488 (when (and (or (not specific) (string= specific "TAGS"))
13489 (setq value (org-get-tags-string))
13491 (push (cons "TAGS" value) props))
13492 (when (and (or (not specific) (string= specific "ALLTAGS"))
13493 (setq value (org-get-tags-at)))
13494 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13495 ":"))
13496 props))
13497 (when (or (not specific) (string= specific "BLOCKED"))
13498 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13499 (when (or (not specific)
13500 (member specific
13501 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13502 "TIMESTAMP" "TIMESTAMP_IA")))
13503 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13504 (setq key (if (match-end 1)
13505 (substring (org-match-string-no-properties 1)
13506 0 -1))
13507 string (if (equal key clockstr)
13508 (org-no-properties
13509 (org-trim
13510 (buffer-substring
13511 (match-beginning 3) (goto-char
13512 (point-at-eol)))))
13513 (substring (org-match-string-no-properties 3)
13514 1 -1)))
13515 ;; Get the correct property name from the key. This is
13516 ;; necessary if the user has configured time keywords.
13517 (setq key1 (concat key ":"))
13518 (cond
13519 ((not key)
13520 (setq key
13521 (if (= (char-after (match-beginning 3)) ?\[)
13522 "TIMESTAMP_IA" "TIMESTAMP")))
13523 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13524 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13525 ((equal key1 org-closed-string) (setq key "CLOSED"))
13526 ((equal key1 org-clock-string) (setq key "CLOCK")))
13527 (when (or (equal key "CLOCK") (not (assoc key props)))
13528 (push (cons key string) props))))
13529 )
13531 (when (memq which '(all standard))
13532 ;; Get the standard properties, like :PROP: ...
13533 (setq range (org-get-property-block beg end))
13534 (when range
13535 (goto-char (car range))
13536 (while (re-search-forward
13538 (cdr range) t)
13539 (setq key (org-match-string-no-properties 1)
13540 value (org-trim (or (org-match-string-no-properties 2) "")))
13541 (unless (member key excluded)
13542 (push (cons key (or value "")) props)))))
13543 (if clocksum
13544 (push (cons "CLOCKSUM"
13545 (org-columns-number-to-string (/ (float clocksum) 60.)
13546 'add_times))
13547 props))
13548 (unless (assoc "CATEGORY" props)
13549 (setq value (or (org-get-category)
13550 (progn (org-refresh-category-properties)
13551 (org-get-category))))
13552 (push (cons "CATEGORY" value) props))
13553 (append sum-props (nreverse props)))))))
13555 (defun org-entry-get (pom property &optional inherit literal-nil)
13556 "Get value of PROPERTY for entry at point-or-marker POM.
13557 If INHERIT is non-nil and the entry does not have the property,
13558 then also check higher levels of the hierarchy.
13559 If INHERIT is the symbol `selective', use inheritance only if the setting
13560 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13561 If the property is present but empty, the return value is the empty string.
13562 If the property is not present at all, nil is returned.
13565 do not interpret it as the list atom nil. This is used for inheritance
13567 (org-with-point-at pom
13568 (if (and inherit (if (eq inherit 'selective)
13569 (org-property-inherit-p property)
13570 t))
13571 (org-entry-get-with-inheritance property literal-nil)
13572 (if (member property org-special-properties)
13573 ;; We need a special property. Use `org-entry-properties' to
13574 ;; retrieve it, but specify the wanted property
13575 (cdr (assoc property (org-entry-properties nil 'special property)))
13576 (let ((range (org-get-property-block)))
13577 (if (and range
13578 (goto-char (car range))
13579 (re-search-forward
13581 (cdr range) t))
13582 ;; Found the property, return it.
13583 (if (match-end 1)
13584 (if literal-nil
13585 (org-match-string-no-properties 1)
13586 (org-not-nil (org-match-string-no-properties 1)))
13587 "")))))))
13589 (defun org-property-or-variable-value (var &optional inherit)
13590 "Check if there is a property fixing the value of VAR.
13591 If yes, return this value. If not, return the current value of the variable."
13592 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13594 (read prop)
13595 (symbol-value var))))
13597 (defun org-entry-delete (pom property)
13598 "Delete the property PROPERTY from entry at point-or-marker POM."
13599 (org-with-point-at pom
13600 (if (member property org-special-properties)
13601 nil ; cannot delete these properties.
13602 (let ((range (org-get-property-block)))
13603 (if (and range
13604 (goto-char (car range))
13605 (re-search-forward
13607 (cdr range) t))
13608 (progn
13609 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13610 t)
13611 nil)))))
13613 ;; Multi-values properties are properties that contain multiple values
13614 ;; These values are assumed to be single words, separated by whitespace.
13615 (defun org-entry-add-to-multivalued-property (pom property value)
13616 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13617 (let* ((old (org-entry-get pom property))
13619 (setq value (org-entry-protect-space value))
13620 (unless (member value values)
13621 (setq values (cons value values))
13622 (org-entry-put pom property
13623 (mapconcat 'identity values " ")))))
13625 (defun org-entry-remove-from-multivalued-property (pom property value)
13626 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13627 (let* ((old (org-entry-get pom property))
13629 (setq value (org-entry-protect-space value))
13630 (when (member value values)
13631 (setq values (delete value values))
13632 (org-entry-put pom property
13633 (mapconcat 'identity values " ")))))
13635 (defun org-entry-member-in-multivalued-property (pom property value)
13636 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13637 (let* ((old (org-entry-get pom property))
13639 (setq value (org-entry-protect-space value))
13640 (member value values)))
13642 (defun org-entry-get-multivalued-property (pom property)
13643 "Return a list of values in a multivalued property."
13644 (let* ((value (org-entry-get pom property))
13646 (mapcar 'org-entry-restore-space values)))
13648 (defun org-entry-put-multivalued-property (pom property &rest values)
13649 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13650 VALUES should be a list of strings. Spaces will be protected."
13651 (org-entry-put pom property
13652 (mapconcat 'org-entry-protect-space values " "))
13653 (let* ((value (org-entry-get pom property))
13655 (mapcar 'org-entry-restore-space values)))
13657 (defun org-entry-protect-space (s)
13658 "Protect spaces and newline in string S."
13659 (while (string-match " " s)
13660 (setq s (replace-match "%20" t t s)))
13662 (setq s (replace-match "%0A" t t s)))
13663 s)
13665 (defun org-entry-restore-space (s)
13666 "Restore spaces and newline in string S."
13667 (while (string-match "%20" s)
13668 (setq s (replace-match " " t t s)))
13669 (while (string-match "%0A" s)
13671 s)
13673 (defvar org-entry-property-inherited-from (make-marker)
13674 "Marker pointing to the entry from where a property was inherited.
13675 Each call to `org-entry-get-with-inheritance' will set this marker to the
13676 location of the entry where the inheritance search matched. If there was
13677 no match, the marker will point nowhere.
13678 Note that also `org-entry-get' calls this function, if the INHERIT flag
13679 is set.")
13681 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13682 "Get entry property, and search higher levels if not present.
13683 The search will stop at the first ancestor which has the property defined.
13685 should be considered as undefined (this is the meaning of nil here).
13687 (move-marker org-entry-property-inherited-from nil)
13688 (let (tmp)
13689 (save-excursion
13690 (save-restriction
13691 (widen)
13692 (catch 'ex
13693 (while t
13694 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13695 (org-back-to-heading t)
13696 (move-marker org-entry-property-inherited-from (point))
13697 (throw 'ex tmp))
13698 (or (org-up-heading-safe) (throw 'ex nil)))))
13699 (setq tmp (or tmp
13700 (cdr (assoc property org-file-properties))
13701 (cdr (assoc property org-global-properties))
13702 (cdr (assoc property org-global-properties-fixed))))
13703 (if literal-nil tmp (org-not-nil tmp)))))
13705 (defvar org-property-changed-functions nil
13706 "Hook called when the value of a property has changed.
13707 Each hook function should accept two arguments, the name of the property
13708 and the new value.")
13710 (defun org-entry-put (pom property value)
13711 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13712 (org-with-point-at pom
13713 (org-back-to-heading t)
13714 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13715 range)
13716 (cond
13717 ((equal property "TODO")
13719 (not (member value org-todo-keywords-1)))
13721 (if (or (not value)
13723 (setq value 'none))
13724 (org-todo value)
13725 (org-set-tags nil 'align))
13726 ((equal property "PRIORITY")
13728 (string-to-char value) ?\ ))
13729 (org-set-tags nil 'align))
13730 ((equal property "SCHEDULED")
13731 (if (re-search-forward org-scheduled-time-regexp end t)
13732 (cond
13733 ((eq value 'earlier) (org-timestamp-change -1 'day))
13734 ((eq value 'later) (org-timestamp-change 1 'day))
13735 (t (call-interactively 'org-schedule)))
13736 (call-interactively 'org-schedule)))
13737 ((equal property "DEADLINE")
13738 (if (re-search-forward org-deadline-time-regexp end t)
13739 (cond
13740 ((eq value 'earlier) (org-timestamp-change -1 'day))
13741 ((eq value 'later) (org-timestamp-change 1 'day))
13742 (t (call-interactively 'org-deadline)))
13743 (call-interactively 'org-deadline)))
13744 ((member property org-special-properties)
13745 (error "The %s property can not yet be set with `org-entry-put'"
13746 property))
13747 (t ; a non-special property
13748 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13749 (setq range (org-get-property-block beg end 'force))
13750 (goto-char (car range))
13751 (if (re-search-forward
13753 (progn
13754 (delete-region (match-beginning 1) (match-end 1))
13755 (goto-char (match-beginning 1)))
13756 (goto-char (cdr range))
13758 (backward-char 1)
13759 (org-indent-line-function)
13760 (insert ":" property ":"))
13761 (and value (insert " " value))
13762 (org-indent-line-function)))))
13763 (run-hook-with-args 'org-property-changed-functions property value)))
13765 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13766 "Get all property keys in the current buffer.
13767 With INCLUDE-SPECIALS, also list the special properties that reflect things
13768 like tags and TODO state.
13769 With INCLUDE-DEFAULTS, also include properties that has special meaning
13770 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING.
13771 With INCLUDE-COLUMNS, also include property names given in COLUMN
13772 formats in the current buffer."
13773 (let (rtn range cfmt s p)
13774 (save-excursion
13775 (save-restriction
13776 (widen)
13777 (goto-char (point-min))
13778 (while (re-search-forward org-property-start-re nil t)
13779 (setq range (org-get-property-block))
13780 (goto-char (car range))
13781 (while (re-search-forward
13783 (cdr range) t)
13784 (add-to-list 'rtn (org-match-string-no-properties 1)))
13785 (outline-next-heading))))
13787 (when include-specials
13788 (setq rtn (append org-special-properties rtn)))
13790 (when include-defaults
13791 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13792 (add-to-list 'rtn org-effort-property))
13794 (when include-columns
13795 (save-excursion
13796 (save-restriction
13797 (widen)
13798 (goto-char (point-min))
13799 (while (re-search-forward
13801 nil t)
13802 (setq cfmt (match-string 2) s 0)
13804 cfmt s)
13805 (setq s (match-end 0)
13806 p (match-string 1 cfmt))
13807 (unless (or (equal p "ITEM")
13808 (member p org-special-properties))
13809 (add-to-list 'rtn (match-string 1 cfmt))))))))
13811 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13813 (defun org-property-values (key)
13814 "Return a list of all values of property KEY."
13815 (save-excursion
13816 (save-restriction
13817 (widen)
13818 (goto-char (point-min))
13820 values)
13821 (while (re-search-forward re nil t)
13822 (add-to-list 'values (org-trim (match-string 1))))
13823 (delete "" values)))))
13825 (defun org-insert-property-drawer ()
13826 "Insert a property drawer into the current entry."
13827 (interactive)
13828 (org-back-to-heading t)
13829 (looking-at outline-regexp)
13830 (let ((indent (if org-adapt-indentation
13831 (- (match-end 0)(match-beginning 0))
13832 0))
13833 (beg (point))
13835 end hiddenp)
13836 (outline-next-heading)
13837 (setq end (point))
13838 (goto-char beg)
13839 (while (re-search-forward re end t))
13840 (setq hiddenp (org-invisible-p))
13841 (end-of-line 1)
13844 (if (member (match-string 1) '("CLOCK:" ":END:"))
13845 ;; just skip this line
13846 (beginning-of-line 2)
13847 ;; Drawer start, find the end
13849 (beginning-of-line 1)))
13850 (org-skip-over-state-notes)
13852 (if (eq (char-before) ?*) (forward-char 1))
13854 (beginning-of-line 0)
13855 (org-indent-to-column indent)
13856 (beginning-of-line 2)
13857 (org-indent-to-column indent)
13858 (beginning-of-line 0)
13859 (if hiddenp
13860 (save-excursion
13861 (org-back-to-heading t)
13862 (hide-entry))
13863 (org-flag-drawer t))))
13865 (defun org-set-property (property value)
13866 "In the current entry, set PROPERTY to VALUE.
13867 When called interactively, this will prompt for a property name, offering
13868 completion on existing and default properties. And then it will prompt
13869 for a value, offering completion either on allowed values (via an inherited
13870 xxx_ALL property) or on existing values in other instances of this property
13871 in the current file."
13872 (interactive
13873 (let* ((completion-ignore-case t)
13874 (keys (org-buffer-property-keys nil t t))
13875 (prop0 (org-icompleting-read "Property: " (mapcar 'list keys)))
13876 (prop (if (member prop0 keys)
13877 prop0
13878 (or (cdr (assoc (downcase prop0)
13879 (mapcar (lambda (x) (cons (downcase x) x))
13880 keys)))
13881 prop0)))
13882 (cur (org-entry-get nil prop))
13883 (prompt (concat prop " value"
13885 (concat " [" cur "]") "") ": "))
13886 (allowed (org-property-get-allowed-values nil prop 'table))
13887 (existing (mapcar 'list (org-property-values prop)))
13888 (val (if allowed
13889 (org-completing-read prompt allowed nil
13890 (not (get-text-property 0 'org-unrestricted
13891 (caar allowed))))
13892 (let (org-completion-use-ido org-completion-use-iswitchb)
13893 (org-completing-read prompt existing nil nil "" nil cur)))))
13894 (list prop (if (equal val "") cur val))))
13895 (unless (equal (org-entry-get nil property) value)
13896 (org-entry-put nil property value)))
13898 (defun org-delete-property (property)
13899 "In the current entry, delete PROPERTY."
13900 (interactive
13901 (let* ((completion-ignore-case t)
13902 (prop (org-icompleting-read "Property: "
13903 (org-entry-properties nil 'standard))))
13904 (list prop)))
13905 (message "Property %s %s" property
13906 (if (org-entry-delete nil property)
13907 "deleted"
13908 "was not present in the entry")))
13910 (defun org-delete-property-globally (property)
13911 "Remove PROPERTY globally, from all entries."
13912 (interactive
13913 (let* ((completion-ignore-case t)
13914 (prop (org-icompleting-read
13915 "Globally remove property: "
13916 (mapcar 'list (org-buffer-property-keys)))))
13917 (list prop)))
13918 (save-excursion
13919 (save-restriction
13920 (widen)
13921 (goto-char (point-min))
13922 (let ((cnt 0))
13923 (while (re-search-forward
13925 nil t)
13926 (setq cnt (1+ cnt))
13927 (replace-match ""))
13930 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
13932 (defun org-compute-property-at-point ()
13933 "Compute the property at point.
13934 This looks for an enclosing column format, extracts the operator and
13935 then applies it to the property in the column format's scope."
13936 (interactive)
13937 (unless (org-at-property-p)
13938 (error "Not at a property"))
13939 (let ((prop (org-match-string-no-properties 2)))
13940 (org-columns-get-format-and-top-level)
13941 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
13942 (error "No operator defined for property %s" prop))
13943 (org-columns-compute prop)))
13945 (defvar org-property-allowed-value-functions nil
13946 "Hook for functions supplying allowed values for a specific property.
13947 The functions must take a single argument, the name of the property, and
13949 the values, this means that these values are intended as defaults for
13950 completion, but that other values should be allowed too.
13951 The functions must return nil if they are not responsible for this
13952 property.")
13954 (defun org-property-get-allowed-values (pom property &optional table)
13955 "Get allowed values for the property PROPERTY.
13956 When TABLE is non-nil, return an alist that can directly be used for
13957 completion."
13958 (let (vals)
13959 (cond
13960 ((equal property "TODO")
13961 (setq vals (org-with-point-at pom
13962 (append org-todo-keywords-1 '("")))))
13963 ((equal property "PRIORITY")
13964 (let ((n org-lowest-priority))
13965 (while (>= n org-highest-priority)
13966 (push (char-to-string n) vals)
13967 (setq n (1- n)))))
13968 ((member property org-special-properties))
13969 ((setq vals (run-hook-with-args-until-success
13970 'org-property-allowed-value-functions property)))
13971 (t
13972 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
13974 (setq vals (car (read-from-string (concat "(" vals ")"))))
13975 (setq vals (mapcar (lambda (x)
13976 (cond ((stringp x) x)
13977 ((numberp x) (number-to-string x))
13978 ((symbolp x) (symbol-name x))
13979 (t "???")))
13980 vals)))))
13981 (when (member ":ETC" vals)
13982 (setq vals (remove ":ETC" vals))
13983 (org-add-props (car vals) '(org-unrestricted t)))
13984 (if table (mapcar 'list vals) vals)))
13986 (defun org-property-previous-allowed-value (&optional previous)
13987 "Switch to the next allowed value for this property."
13988 (interactive)
13989 (org-property-next-allowed-value t))
13991 (defun org-property-next-allowed-value (&optional previous)
13992 "Switch to the next allowed value for this property."
13993 (interactive)
13994 (unless (org-at-property-p)
13995 (error "Not at a property"))
13996 (let* ((key (match-string 2))
13997 (value (match-string 3))
13998 (allowed (or (org-property-get-allowed-values (point) key)
13999 (and (member value '("[ ]" "[-]" "[X]"))
14000 '("[ ]" "[X]"))))
14001 nval)
14002 (unless allowed
14003 (error "Allowed values for this property have not been defined"))
14004 (if previous (setq allowed (reverse allowed)))
14005 (if (member value allowed)
14006 (setq nval (car (cdr (member value allowed)))))
14007 (setq nval (or nval (car allowed)))
14008 (if (equal nval value)
14009 (error "Only one allowed value for this property"))
14010 (org-at-property-p)
14011 (replace-match (concat " :" key ": " nval) t t)
14012 (org-indent-line-function)
14013 (beginning-of-line 1)
14015 (run-hook-with-args 'org-property-changed-functions key nval)))
14017 (defun org-find-olp (path &optional this-buffer)
14018 "Return a marker pointing to the entry at outline path OLP.
14019 If anything goes wrong, throw an error.
14020 You can wrap this call to catch the error like this:
14022 (condition-case msg
14023 (org-mobile-locate-entry (match-string 4))
14024 (error (nth 1 msg)))
14026 The return value will then be either a string with the error message,
14027 or a marker if everything is OK.
14029 If THIS-BUFFER is set, the outline path does not contain a file,
14030 only headings."
14031 (let* ((file (if this-buffer buffer-file-name (pop path)))
14032 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14033 (level 1)
14034 (lmin 1)
14035 (lmax 1)
14036 limit re end found pos heading cnt)
14037 (unless buffer (error "File not found :%s" file))
14038 (with-current-buffer buffer
14039 (save-excursion
14040 (save-restriction
14041 (widen)
14042 (setq limit (point-max))
14043 (goto-char (point-min))
14044 (while (setq heading (pop path))
14045 (setq re (format org-complex-heading-regexp-format
14046 (regexp-quote heading)))
14047 (setq cnt 0 pos (point))
14048 (while (re-search-forward re end t)
14049 (setq level (- (match-end 1) (match-beginning 1)))
14050 (if (and (>= level lmin) (<= level lmax))
14051 (setq found (match-beginning 0) cnt (1+ cnt))))
14052 (when (= cnt 0) (error "Heading not found on level %d: %s"
14053 lmax heading))
14054 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14055 lmax heading))
14056 (goto-char found)
14057 (setq lmin (1+ level) lmax (+ lmin (if org-odd-levels-only 1 0)))
14058 (setq end (save-excursion (org-end-of-subtree t t))))
14059 (when (org-on-heading-p)
14060 (move-marker (make-marker) (point))))))))
14062 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14063 "Find node HEADING in BUFFER.
14064 Return a marker to the heading if it was found, or nil if not.
14065 If POS-ONLY is set, return just the position instead of a marker.
14067 The heading text must match exact, but it may have a TODO keyword,
14068 a priority cookie and tags in the standard locations."
14069 (with-current-buffer (or buffer (current-buffer))
14070 (save-excursion
14071 (save-restriction
14072 (widen)
14073 (goto-char (point-min))
14074 (let (case-fold-search)
14075 (if (re-search-forward
14076 (format org-complex-heading-regexp-format
14077 (regexp-quote heading)) nil t)
14078 (if pos-only
14079 (match-beginning 0)
14080 (move-marker (make-marker) (match-beginning 0)))))))))
14082 (defun org-find-exact-heading-in-directory (heading &optional dir)
14083 "Find Org node headline HEADING in all .org files in directory DIR.
14084 When the target headline is found, return a marker to this location."
14085 (let ((files (directory-files (or dir default-directory)
14087 file visiting m buffer)
14088 (catch 'found
14089 (while (setq file (pop files))
14090 (message "trying %s" file)
14091 (setq visiting (org-find-base-buffer-visiting file))
14092 (setq buffer (or visiting (find-file-noselect file)))
14093 (setq m (org-find-exact-headline-in-buffer
14094 heading buffer))
14095 (when (and (not m) (not visiting)) (kill-buffer buffer))
14096 (and m (throw 'found m))))))
14098 (defun org-find-entry-with-id (ident)
14099 "Locate the entry that contains the ID property with exact value IDENT.
14100 IDENT can be a string, a symbol or a number, this function will search for
14101 the string representation of it.
14102 Return the position where this entry starts, or nil if there is no such entry."
14103 (interactive "sID: ")
14104 (let ((id (cond
14105 ((stringp ident) ident)
14106 ((symbol-name ident) (symbol-name ident))
14107 ((numberp ident) (number-to-string ident))
14108 (t (error "IDENT %s must be a string, symbol or number" ident))))
14109 (case-fold-search nil))
14110 (save-excursion
14111 (save-restriction
14112 (widen)
14113 (goto-char (point-min))
14114 (when (re-search-forward
14116 nil t)
14117 (org-back-to-heading t)
14118 (point))))))
14120 ;;;; Timestamps
14122 (defvar org-last-changed-timestamp nil)
14123 (defvar org-last-inserted-timestamp nil
14124 "The last time stamp inserted with `org-insert-time-stamp'.")
14125 (defvar org-time-was-given) ; dynamically scoped parameter
14126 (defvar org-end-time-was-given) ; dynamically scoped parameter
14127 (defvar org-ts-what) ; dynamically scoped parameter
14129 (defun org-time-stamp (arg &optional inactive)
14130 "Prompt for a date/time and insert a time stamp.
14131 If the user specifies a time like HH:MM, or if this command is called
14132 with a prefix argument, the time stamp will contain date and time.
14133 Otherwise, only the date will be included. All parts of a date not
14134 specified by the user will be filled in from the current date/time.
14135 So if you press just return without typing anything, the time stamp
14136 will represent the current date/time. If there is already a timestamp
14137 at the cursor, it will be modified."
14138 (interactive "P")
14139 (let* ((ts nil)
14140 (default-time
14141 ;; Default time is either today, or, when entering a range,
14142 ;; the range start.
14143 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14144 (save-excursion
14145 (re-search-backward
14147 (- (point) 20) t)))
14148 (apply 'encode-time (org-parse-time-string (match-string 1)))
14149 (current-time)))
14150 (default-input (and ts (org-get-compact-tod ts)))
14151 org-time-was-given org-end-time-was-given time)
14152 (cond
14153 ((and (org-at-timestamp-p t)
14154 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14155 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14156 (insert "--")
14157 (setq time (let ((this-command this-command))
14158 (org-read-date arg 'totime nil nil
14159 default-time default-input)))
14160 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14161 ((org-at-timestamp-p t)
14162 (setq time (let ((this-command this-command))
14163 (org-read-date arg 'totime nil nil default-time default-input)))
14164 (when (org-at-timestamp-p t) ; just to get the match data
14165 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14166 (replace-match "")
14167 (setq org-last-changed-timestamp
14168 (org-insert-time-stamp
14169 time (or org-time-was-given arg)
14170 inactive nil nil (list org-end-time-was-given))))
14171 (message "Timestamp updated"))
14172 (t
14173 (setq time (let ((this-command this-command))
14174 (org-read-date arg 'totime nil nil default-time default-input)))
14175 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14176 nil nil (list org-end-time-was-given))))))
14178 ;; FIXME: can we use this for something else, like computing time differences?
14179 (defun org-get-compact-tod (s)
14180 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14181 (let* ((t1 (match-string 1 s))
14182 (h1 (string-to-number (match-string 2 s)))
14183 (m1 (string-to-number (match-string 3 s)))
14184 (t2 (and (match-end 4) (match-string 5 s)))
14185 (h2 (and t2 (string-to-number (match-string 6 s))))
14186 (m2 (and t2 (string-to-number (match-string 7 s))))
14187 dh dm)
14188 (if (not t2)
14189 t1
14190 (setq dh (- h2 h1) dm (- m2 m1))
14191 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14192 (concat t1 "+" (number-to-string dh)
14193 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14195 (defun org-time-stamp-inactive (&optional arg)
14196 "Insert an inactive time stamp.
14197 An inactive time stamp is enclosed in square brackets instead of angle
14198 brackets. It is inactive in the sense that it does not trigger agenda entries,
14199 does not link to the calendar and cannot be changed with the S-cursor keys.
14200 So these are more for recording a certain time/date."
14201 (interactive "P")
14202 (org-time-stamp arg 'inactive))
14204 (defvar org-date-ovl (make-overlay 1 1))
14205 (overlay-put org-date-ovl 'face 'org-warning)
14206 (org-detach-overlay org-date-ovl)
14208 (defvar org-ans1) ; dynamically scoped parameter
14209 (defvar org-ans2) ; dynamically scoped parameter
14211 (defvar org-plain-time-of-day-regexp) ; defined below
14213 (defvar org-overriding-default-time nil) ; dynamically scoped
14214 (defvar org-read-date-overlay nil)
14215 (defvar org-dcst nil) ; dynamically scoped
14216 (defvar org-read-date-history nil)
14217 (defvar org-read-date-final-answer nil)
14219 (defun org-read-date (&optional with-time to-time from-string prompt
14220 default-time default-input)
14221 "Read a date, possibly a time, and make things smooth for the user.
14222 The prompt will suggest to enter an ISO date, but you can also enter anything
14223 which will at least partially be understood by `parse-time-string'.
14224 Unrecognized parts of the date will default to the current day, month, year,
14225 hour and minute. If this command is called to replace a timestamp at point,
14226 of to enter the second timestamp of a range, the default time is taken
14227 from the existing stamp. Furthermore, the command prefers the future,
14228 so if you are giving a date where the year is not given, and the day-month
14229 combination is already past in the current year, it will assume you
14230 mean next year. For details, see the manual. A few examples:
14232 3-2-5 --> 2003-02-05
14233 feb 15 --> currentyear-02-15
14234 2/15 --> currentyear-02-15
14235 sep 12 9 --> 2009-09-12
14236 12:45 --> today 12:45
14237 22 sept 0:34 --> currentyear-09-22 0:34
14238 12 --> currentyear-currentmonth-12
14239 Fri --> nearest Friday (today or later)
14240 etc.
14242 Furthermore you can specify a relative date by giving, as the *first* thing
14243 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14244 change in days weeks, months, years.
14245 With a single plus or minus, the date is relative to today. With a double
14246 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14247 +4d --> four days from today
14248 +4 --> same as above
14249 +2w --> two weeks from today
14250 ++5 --> five days from default date
14252 The function understands only English month and weekday abbreviations,
14253 but this can be configured with the variables `parse-time-months' and
14254 `parse-time-weekdays'.
14256 While prompting, a calendar is popped up - you can also select the
14257 date with the mouse (button 1). The calendar shows a period of three
14258 months. To scroll it to other months, use the keys `>' and `<'.
14259 If you don't like the calendar, turn it off with
14260 \(setq org-read-date-popup-calendar nil)
14262 With optional argument TO-TIME, the date will immediately be converted
14263 to an internal time.
14264 With an optional argument WITH-TIME, the prompt will suggest to also
14265 insert a time. Note that when WITH-TIME is not set, you can still
14266 enter a time, and this function will inform the calling routine about
14267 this change. The calling routine may then choose to change the format
14268 used to insert the time stamp into the buffer to include the time.
14269 With optional argument FROM-STRING, read from this string instead from
14270 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14271 the time/date that is used for everything that is not specified by the
14272 user."
14273 (require 'parse-time)
14274 (let* ((org-time-stamp-rounding-minutes
14275 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14276 (org-dcst org-display-custom-times)
14277 (ct (org-current-time))
14278 (def (or org-overriding-default-time default-time ct))
14279 (defdecode (decode-time def))
14280 (dummy (progn
14281 (when (< (nth 2 defdecode) org-extend-today-until)
14282 (setcar (nthcdr 2 defdecode) -1)
14283 (setcar (nthcdr 1 defdecode) 59)
14284 (setq def (apply 'encode-time defdecode)
14285 defdecode (decode-time def)))))
14286 (calendar-frame-setup nil)
14287 (calendar-setup nil)
14288 (calendar-move-hook nil)
14289 (calendar-view-diary-initially-flag nil)
14290 (calendar-view-holidays-initially-flag nil)
14291 (timestr (format-time-string
14292 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14293 (prompt (concat (if prompt (concat prompt " ") "")
14294 (format "Date+time [%s]: " timestr)))
14295 ans (org-ans0 "") org-ans1 org-ans2 final)
14297 (cond
14298 (from-string (setq ans from-string))
14299 (org-read-date-popup-calendar
14300 (save-excursion
14301 (save-window-excursion
14302 (calendar)
14303 (calendar-forward-day (- (time-to-days def)
14304 (calendar-absolute-from-gregorian
14305 (calendar-current-date))))
14306 (org-eval-in-calendar nil t)
14307 (let* ((old-map (current-local-map))
14308 (map (copy-keymap calendar-mode-map))
14309 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14310 (org-defkey map (kbd "RET") 'org-calendar-select)
14311 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14312 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14313 (org-defkey minibuffer-local-map [(meta shift left)]
14314 (lambda () (interactive)
14315 (org-eval-in-calendar '(calendar-backward-month 1))))
14316 (org-defkey minibuffer-local-map [(meta shift right)]
14317 (lambda () (interactive)
14318 (org-eval-in-calendar '(calendar-forward-month 1))))
14319 (org-defkey minibuffer-local-map [(meta shift up)]
14320 (lambda () (interactive)
14321 (org-eval-in-calendar '(calendar-backward-year 1))))
14322 (org-defkey minibuffer-local-map [(meta shift down)]
14323 (lambda () (interactive)
14324 (org-eval-in-calendar '(calendar-forward-year 1))))
14325 (org-defkey minibuffer-local-map [?\e (shift left)]
14326 (lambda () (interactive)
14327 (org-eval-in-calendar '(calendar-backward-month 1))))
14328 (org-defkey minibuffer-local-map [?\e (shift right)]
14329 (lambda () (interactive)
14330 (org-eval-in-calendar '(calendar-forward-month 1))))
14331 (org-defkey minibuffer-local-map [?\e (shift up)]
14332 (lambda () (interactive)
14333 (org-eval-in-calendar '(calendar-backward-year 1))))
14334 (org-defkey minibuffer-local-map [?\e (shift down)]
14335 (lambda () (interactive)
14336 (org-eval-in-calendar '(calendar-forward-year 1))))
14337 (org-defkey minibuffer-local-map [(shift up)]
14338 (lambda () (interactive)
14339 (org-eval-in-calendar '(calendar-backward-week 1))))
14340 (org-defkey minibuffer-local-map [(shift down)]
14341 (lambda () (interactive)
14342 (org-eval-in-calendar '(calendar-forward-week 1))))
14343 (org-defkey minibuffer-local-map [(shift left)]
14344 (lambda () (interactive)
14345 (org-eval-in-calendar '(calendar-backward-day 1))))
14346 (org-defkey minibuffer-local-map [(shift right)]
14347 (lambda () (interactive)
14348 (org-eval-in-calendar '(calendar-forward-day 1))))
14349 (org-defkey minibuffer-local-map ">"
14350 (lambda () (interactive)
14351 (org-eval-in-calendar '(scroll-calendar-left 1))))
14352 (org-defkey minibuffer-local-map "<"
14353 (lambda () (interactive)
14354 (org-eval-in-calendar '(scroll-calendar-right 1))))
14355 (org-defkey minibuffer-local-map "\C-v"
14356 (lambda () (interactive)
14357 (org-eval-in-calendar
14358 '(calendar-scroll-left-three-months 1))))
14359 (org-defkey minibuffer-local-map "\M-v"
14360 (lambda () (interactive)
14361 (org-eval-in-calendar
14362 '(calendar-scroll-right-three-months 1))))
14363 (run-hooks 'org-read-date-minibuffer-setup-hook)
14364 (unwind-protect
14365 (progn
14366 (use-local-map map)
14367 (add-hook 'post-command-hook 'org-read-date-display)
14368 (setq org-ans0 (read-string prompt default-input
14369 'org-read-date-history nil))
14370 ;; org-ans0: from prompt
14371 ;; org-ans1: from mouse click
14372 ;; org-ans2: from calendar motion
14373 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14374 (remove-hook 'post-command-hook 'org-read-date-display)
14375 (use-local-map old-map)
14376 (when org-read-date-overlay
14377 (delete-overlay org-read-date-overlay)
14378 (setq org-read-date-overlay nil)))))))
14380 (t ; Naked prompt only
14381 (unwind-protect
14382 (setq ans (read-string prompt default-input
14383 'org-read-date-history timestr))
14384 (when org-read-date-overlay
14385 (delete-overlay org-read-date-overlay)
14386 (setq org-read-date-overlay nil)))))
14388 (setq final (org-read-date-analyze ans def defdecode))
14390 ;; One round trip to get rid of 34th of August and stuff like that....
14391 (setq final (decode-time (apply 'encode-time final)))
14393 (setq org-read-date-final-answer ans)
14395 (if to-time
14396 (apply 'encode-time final)
14397 (if (and (boundp 'org-time-was-given) org-time-was-given)
14398 (format "%04d-%02d-%02d %02d:%02d"
14399 (nth 5 final) (nth 4 final) (nth 3 final)
14400 (nth 2 final) (nth 1 final))
14401 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14403 (defvar def)
14404 (defvar defdecode)
14405 (defvar with-time)
14406 (defvar org-read-date-analyze-futurep nil)
14407 (defun org-read-date-display ()
14408 "Display the current date prompt interpretation in the minibuffer."
14409 (when org-read-date-display-live
14410 (when org-read-date-overlay
14411 (delete-overlay org-read-date-overlay))
14412 (let ((p (point)))
14413 (end-of-line 1)
14414 (while (not (equal (buffer-substring
14415 (max (point-min) (- (point) 4)) (point))
14416 " "))
14417 (insert " "))
14418 (goto-char p))
14419 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14420 " " (or org-ans1 org-ans2)))
14421 (org-end-time-was-given nil)
14422 (f (org-read-date-analyze ans def defdecode))
14423 (fmts (if org-dcst
14424 org-time-stamp-custom-formats
14425 org-time-stamp-formats))
14426 (fmt (if (or with-time
14427 (and (boundp 'org-time-was-given) org-time-was-given))
14428 (cdr fmts)
14429 (car fmts)))
14430 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14431 (when (and org-end-time-was-given
14432 (string-match org-plain-time-of-day-regexp txt))
14433 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14434 org-end-time-was-given
14435 (substring txt (match-end 0)))))
14436 (when org-read-date-analyze-futurep
14437 (setq txt (concat txt " (=>F)")))
14438 (setq org-read-date-overlay
14439 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14440 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14442 (defun org-read-date-analyze (ans def defdecode)
14443 "Analyze the combined answer of the date prompt."
14444 ;; FIXME: cleanup and comment
14445 (let ((nowdecode (decode-time (current-time)))
14446 delta deltan deltaw deltadef year month day
14447 hour minute second wday pm h2 m2 tl wday1
14448 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14449 (setq org-read-date-analyze-futurep nil)
14451 (setq ans "+0"))
14453 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14454 (setq ans (replace-match "" t t ans)
14455 deltan (car delta)
14456 deltaw (nth 1 delta)
14457 deltadef (nth 2 delta)))
14459 ;; Check if there is an iso week date in there
14460 ;; If yes, store the info and postpone interpreting it until the rest
14461 ;; of the parsing is done
14462 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14463 (setq iso-year (if (match-end 1)
14464 (org-small-year-to-year
14465 (string-to-number (match-string 1 ans))))
14466 iso-weekday (if (match-end 3)
14467 (string-to-number (match-string 3 ans)))
14468 iso-week (string-to-number (match-string 2 ans)))
14469 (setq ans (replace-match "" t t ans)))
14471 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14472 (when (string-match
14474 (setq year (if (match-end 2)
14475 (string-to-number (match-string 2 ans))
14476 (progn (setq kill-year t)
14477 (string-to-number (format-time-string "%Y"))))
14478 month (string-to-number (match-string 3 ans))
14479 day (string-to-number (match-string 4 ans)))
14480 (if (< year 100) (setq year (+ 2000 year)))
14482 t nil ans)))
14483 ;; Help matching american dates, like 5/30 or 5/30/7
14484 (when (string-match
14485 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14486 (setq year (if (match-end 4)
14487 (string-to-number (match-string 4 ans))
14488 (progn (setq kill-year t)
14489 (string-to-number (format-time-string "%Y"))))
14490 month (string-to-number (match-string 1 ans))
14491 day (string-to-number (match-string 2 ans)))
14492 (if (< year 100) (setq year (+ 2000 year)))
14494 t nil ans)))
14495 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14496 ;; If there is a time with am/pm, and *no* time without it, we convert
14497 ;; so that matching will be successful.
14498 (loop for i from 1 to 2 do ; twice, for end time as well
14501 (setq hour (string-to-number (match-string 1 ans))
14502 minute (if (match-end 3)
14503 (string-to-number (match-string 3 ans))
14504 0)
14505 pm (equal ?p
14506 (string-to-char (downcase (match-string 4 ans)))))
14507 (if (and (= hour 12) (not pm))
14508 (setq hour 0)
14509 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14510 (setq ans (replace-match (format "%02d:%02d" hour minute)
14511 t t ans))))
14513 ;; Check if a time range is given as a duration
14514 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14515 (setq hour (string-to-number (match-string 1 ans))
14516 h2 (+ hour (string-to-number (match-string 3 ans)))
14517 minute (string-to-number (match-string 2 ans))
14518 m2 (+ minute (if (match-end 5) (string-to-number
14519 (match-string 5 ans))0)))
14520 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14521 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14522 t t ans)))
14524 ;; Check if there is a time range
14525 (when (boundp 'org-end-time-was-given)
14526 (setq org-time-was-given nil)
14527 (when (and (string-match org-plain-time-of-day-regexp ans)
14528 (match-end 8))
14529 (setq org-end-time-was-given (match-string 8 ans))
14530 (setq ans (concat (substring ans 0 (match-beginning 7))
14531 (substring ans (match-end 7))))))
14533 (setq tl (parse-time-string ans)
14534 day (or (nth 3 tl) (nth 3 defdecode))
14535 month (or (nth 4 tl)
14536 (if (and org-read-date-prefer-future
14537 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14538 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14539 (nth 4 defdecode)))
14540 year (or (and (not kill-year) (nth 5 tl))
14541 (if (and org-read-date-prefer-future
14542 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14543 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14544 (nth 5 defdecode)))
14545 hour (or (nth 2 tl) (nth 2 defdecode))
14546 minute (or (nth 1 tl) (nth 1 defdecode))
14547 second (or (nth 0 tl) 0)
14548 wday (nth 6 tl))
14550 (when (and (eq org-read-date-prefer-future 'time)
14551 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14552 (equal day (nth 3 nowdecode))
14553 (equal month (nth 4 nowdecode))
14554 (equal year (nth 5 nowdecode))
14555 (nth 2 tl)
14556 (or (< (nth 2 tl) (nth 2 nowdecode))
14557 (and (= (nth 2 tl) (nth 2 nowdecode))
14558 (nth 1 tl)
14559 (< (nth 1 tl) (nth 1 nowdecode)))))
14560 (setq day (1+ day)
14561 futurep t))
14563 ;; Special date definitions below
14564 (cond
14565 (iso-week
14566 ;; There was an iso week
14567 (require 'cal-iso)
14568 (setq futurep nil)
14569 (setq year (or iso-year year)
14570 day (or iso-weekday wday 1)
14571 wday nil ; to make sure that the trigger below does not match
14572 iso-date (calendar-gregorian-from-absolute
14573 (calendar-absolute-from-iso
14574 (list iso-week day year))))
14575 ; FIXME: Should we also push ISO weeks into the future?
14576 ; (when (and org-read-date-prefer-future
14577 ; (not iso-year)
14578 ; (< (calendar-absolute-from-gregorian iso-date)
14579 ; (time-to-days (current-time))))
14580 ; (setq year (1+ year)
14581 ; iso-date (calendar-gregorian-from-absolute
14582 ; (calendar-absolute-from-iso
14583 ; (list iso-week day year)))))
14584 (setq month (car iso-date)
14585 year (nth 2 iso-date)
14586 day (nth 1 iso-date)))
14587 (deltan
14588 (setq futurep nil)
14589 (unless deltadef
14590 (let ((now (decode-time (current-time))))
14591 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14592 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14593 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14594 ((equal deltaw "m") (setq month (+ month deltan)))
14595 ((equal deltaw "y") (setq year (+ year deltan)))))
14596 ((and wday (not (nth 3 tl)))
14597 (setq futurep nil)
14598 ;; Weekday was given, but no day, so pick that day in the week
14599 ;; on or after the derived date.
14600 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14601 (unless (equal wday wday1)
14602 (setq day (+ day (% (- wday wday1 -7) 7))))))
14603 (if (and (boundp 'org-time-was-given)
14604 (nth 2 tl))
14605 (setq org-time-was-given t))
14606 (if (< year 100) (setq year (+ 2000 year)))
14607 (if (< year 1970) (setq year (nth 5 defdecode))) ; not representable
14608 (setq org-read-date-analyze-futurep futurep)
14609 (list second minute hour day month year)))
14611 (defvar parse-time-weekdays)
14613 (defun org-read-date-get-relative (s today default)
14614 "Check string S for special relative date string.
14615 TODAY and DEFAULT are internal times, for today and for a default.
14616 Return shift list (N what def-flag)
14618 N is the number of WHATs to shift.
14619 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14620 the DEFAULT date rather than TODAY."
14621 (when (and
14622 (string-match
14623 (concat
14628 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14629 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14630 (string-to-char (substring (match-string 1 s) -1))
14631 ?+))
14632 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14633 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14634 (what (if (match-end 3) (match-string 3 s) "d"))
14635 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14636 (date (if rel default today))
14637 (wday (nth 6 (decode-time date)))
14638 delta)
14639 (if wday1
14640 (progn
14641 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14642 (if (= dir ?-) (setq delta (- delta 7)))
14643 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14644 (list delta "d" rel))
14645 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14647 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14648 "Turn a user-specified date into the internal representation.
14649 The internal representation needed by the calendar is (month day year).
14650 This is a wrapper to handle the brain-dead convention in calendar that
14651 user function argument order change dependent on argument order."
14652 (if (boundp 'calendar-date-style)
14653 (cond
14654 ((eq calendar-date-style 'american)
14655 (list arg1 arg2 arg3))
14656 ((eq calendar-date-style 'european)
14657 (list arg2 arg1 arg3))
14658 ((eq calendar-date-style 'iso)
14659 (list arg2 arg3 arg1)))
14660 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
14661 (if (org-bound-and-true-p european-calendar-style)
14662 (list arg2 arg1 arg3)
14663 (list arg1 arg2 arg3)))))
14665 (defun org-eval-in-calendar (form &optional keepdate)
14666 "Eval FORM in the calendar window and return to current window.
14667 Also, store the cursor date in variable org-ans2."
14668 (let ((sf (selected-frame))
14669 (sw (selected-window)))
14670 (select-window (get-buffer-window "*Calendar*" t))
14671 (eval form)
14672 (when (and (not keepdate) (calendar-cursor-to-date))
14673 (let* ((date (calendar-cursor-to-date))
14674 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14675 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
14676 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
14677 (select-window sw)
14678 (org-select-frame-set-input-focus sf)))
14680 (defun org-calendar-select ()
14681 "Return to `org-read-date' with the date currently selected.
14682 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14683 (interactive)
14684 (when (calendar-cursor-to-date)
14685 (let* ((date (calendar-cursor-to-date))
14686 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14687 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14688 (if (active-minibuffer-window) (exit-minibuffer))))
14690 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
14691 "Insert a date stamp for the date given by the internal TIME.
14692 WITH-HM means use the stamp format that includes the time of the day.
14693 INACTIVE means use square brackets instead of angular ones, so that the
14694 stamp will not contribute to the agenda.
14695 PRE and POST are optional strings to be inserted before and after the
14696 stamp.
14697 The command returns the inserted time stamp."
14698 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
14699 stamp)
14700 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
14701 (insert-before-markers (or pre ""))
14702 (when (listp extra)
14703 (setq extra (car extra))
14704 (if (and (stringp extra)
14706 (setq extra (format "-%02d:%02d"
14707 (string-to-number (match-string 1 extra))
14708 (string-to-number (match-string 2 extra))))
14709 (setq extra nil)))
14710 (when extra
14711 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
14712 (insert-before-markers (setq stamp (format-time-string fmt time)))
14713 (insert-before-markers (or post ""))
14714 (setq org-last-inserted-timestamp stamp)))
14716 (defun org-toggle-time-stamp-overlays ()
14717 "Toggle the use of custom time stamp formats."
14718 (interactive)
14719 (setq org-display-custom-times (not org-display-custom-times))
14720 (unless org-display-custom-times
14721 (let ((p (point-min)) (bmp (buffer-modified-p)))
14722 (while (setq p (next-single-property-change p 'display))
14723 (if (and (get-text-property p 'display)
14724 (eq (get-text-property p 'face) 'org-date))
14725 (remove-text-properties
14726 p (setq p (next-single-property-change p 'display))
14727 '(display t))))
14728 (set-buffer-modified-p bmp)))
14729 (if (featurep 'xemacs)
14730 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
14731 (org-restart-font-lock)
14732 (setq org-table-may-need-update t)
14733 (if org-display-custom-times
14734 (message "Time stamps are overlayed with custom format")
14735 (message "Time stamp overlays removed")))
14737 (defun org-display-custom-time (beg end)
14738 "Overlay modified time stamp format over timestamp between BEG and END."
14739 (let* ((ts (buffer-substring beg end))
14740 t1 w1 with-hm tf time str w2 (off 0))
14741 (save-match-data
14742 (setq t1 (org-parse-time-string ts t))
14743 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
14744 (setq off (- (match-end 0) (match-beginning 0)))))
14745 (setq end (- end off))
14746 (setq w1 (- end beg)
14747 with-hm (and (nth 1 t1) (nth 2 t1))
14748 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
14749 time (org-fix-decoded-time t1)
14750 str (org-add-props
14751 (format-time-string
14752 (substring tf 1 -1) (apply 'encode-time time))
14753 nil 'mouse-face 'highlight)
14754 w2 (length str))
14755 (if (not (= w2 w1))
14756 (add-text-properties (1+ beg) (+ 2 beg)
14757 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
14758 (if (featurep 'xemacs)
14759 (progn
14760 (put-text-property beg end 'invisible t)
14761 (put-text-property beg end 'end-glyph (make-glyph str)))
14762 (put-text-property beg end 'display str))))
14764 (defun org-translate-time (string)
14765 "Translate all timestamps in STRING to custom format.
14766 But do this only if the variable `org-display-custom-times' is set."
14767 (when org-display-custom-times
14768 (save-match-data
14769 (let* ((start 0)
14770 (re org-ts-regexp-both)
14771 t1 with-hm inactive tf time str beg end)
14772 (while (setq start (string-match re string start))
14773 (setq beg (match-beginning 0)
14774 end (match-end 0)
14775 t1 (save-match-data
14776 (org-parse-time-string (substring string beg end) t))
14777 with-hm (and (nth 1 t1) (nth 2 t1))
14778 inactive (equal (substring string beg (1+ beg)) "[")
14779 tf (funcall (if with-hm 'cdr 'car)
14780 org-time-stamp-custom-formats)
14781 time (org-fix-decoded-time t1)
14782 str (format-time-string
14783 (concat
14784 (if inactive "[" "<") (substring tf 1 -1)
14785 (if inactive "]" ">"))
14786 (apply 'encode-time time))
14787 string (replace-match str t t string)
14788 start (+ start (length str)))))))
14789 string)
14791 (defun org-fix-decoded-time (time)
14792 "Set 0 instead of nil for the first 6 elements of time.
14793 Don't touch the rest."
14794 (let ((n 0))
14795 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
14797 (defun org-days-to-time (timestamp-string)
14798 "Difference between TIMESTAMP-STRING and now in days."
14799 (- (time-to-days (org-time-string-to-time timestamp-string))
14800 (time-to-days (current-time))))
14802 (defun org-deadline-close (timestamp-string &optional ndays)
14803 "Is the time in TIMESTAMP-STRING close to the current date?"
14804 (setq ndays (or ndays (org-get-wdays timestamp-string)))
14805 (and (< (org-days-to-time timestamp-string) ndays)
14806 (not (org-entry-is-done-p))))
14808 (defun org-get-wdays (ts)
14809 "Get the deadline lead time appropriate for timestring TS."
14810 (cond
14811 ((<= org-deadline-warning-days 0)
14812 ;; 0 or negative, enforce this value no matter what
14813 (- org-deadline-warning-days))
14815 ;; lead time is specified.
14816 (floor (* (string-to-number (match-string 1 ts))
14817 (cdr (assoc (match-string 2 ts)
14818 '(("d" . 1) ("w" . 7)
14819 ("m" . 30.4) ("y" . 365.25)))))))
14820 ;; go for the default.
14821 (t org-deadline-warning-days)))
14823 (defun org-calendar-select-mouse (ev)
14824 "Return to `org-read-date' with the date currently selected.
14825 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14826 (interactive "e")
14827 (mouse-set-point ev)
14828 (when (calendar-cursor-to-date)
14829 (let* ((date (calendar-cursor-to-date))
14830 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14831 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14832 (if (active-minibuffer-window) (exit-minibuffer))))
14834 (defun org-check-deadlines (ndays)
14835 "Check if there are any deadlines due or past due.
14836 A deadline is considered due if it happens within `org-deadline-warning-days'
14837 days from today's date. If the deadline appears in an entry marked DONE,
14838 it is not shown. The prefix arg NDAYS can be used to test that many
14840 (interactive "P")
14841 (let* ((org-warn-days
14842 (cond
14843 ((equal ndays '(4)) 100000)
14844 (ndays (prefix-numeric-value ndays))
14845 (t (abs org-deadline-warning-days))))
14846 (case-fold-search nil)
14848 (callback
14849 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
14851 (message "%d deadlines past-due or due within %d days"
14852 (org-occur regexp nil callback)
14853 org-warn-days)))
14855 (defun org-check-before-date (date)
14856 "Check if there are deadlines or scheduled entries before DATE."
14857 (interactive (list (org-read-date)))
14858 (let ((case-fold-search nil)
14862 (callback
14863 (lambda () (time-less-p
14864 (org-time-string-to-time (match-string 2))
14865 (org-time-string-to-time date)))))
14866 (message "%d entries before %s"
14867 (org-occur regexp nil callback) date)))
14869 (defun org-check-after-date (date)
14870 "Check if there are deadlines or scheduled entries after DATE."
14871 (interactive (list (org-read-date)))
14872 (let ((case-fold-search nil)
14876 (callback
14877 (lambda () (not
14878 (time-less-p
14879 (org-time-string-to-time (match-string 2))
14880 (org-time-string-to-time date))))))
14881 (message "%d entries after %s"
14882 (org-occur regexp nil callback) date)))
14884 (defun org-evaluate-time-range (&optional to-buffer)
14885 "Evaluate a time range by computing the difference between start and end.
14886 Normally the result is just printed in the echo area, but with prefix arg
14887 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
14888 If the time range is actually in a table, the result is inserted into the
14889 next column.
14890 For time difference computation, a year is assumed to be exactly 365
14891 days in order to avoid rounding problems."
14892 (interactive "P")
14893 (or
14894 (org-clock-update-time-maybe)
14895 (save-excursion
14896 (unless (org-at-date-range-p t)
14897 (goto-char (point-at-bol))
14898 (re-search-forward org-tr-regexp-both (point-at-eol) t))
14899 (if (not (org-at-date-range-p t))
14900 (error "Not at a time-stamp range, and none found in current line")))
14901 (let* ((ts1 (match-string 1))
14902 (ts2 (match-string 2))
14903 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
14904 (match-end (match-end 0))
14905 (time1 (org-time-string-to-time ts1))
14906 (time2 (org-time-string-to-time ts2))
14907 (t1 (org-float-time time1))
14908 (t2 (org-float-time time2))
14909 (diff (abs (- t2 t1)))
14910 (negative (< (- t2 t1) 0))
14911 ;; (ys (floor (* 365 24 60 60)))
14912 (ds (* 24 60 60))
14913 (hs (* 60 60))
14914 (fy "%dy %dd %02d:%02d")
14915 (fy1 "%dy %dd")
14916 (fd "%dd %02d:%02d")
14917 (fd1 "%dd")
14918 (fh "%02d:%02d")
14919 y d h m align)
14920 (if havetime
14921 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14922 y 0
14923 d (floor (/ diff ds)) diff (mod diff ds)
14924 h (floor (/ diff hs)) diff (mod diff hs)
14925 m (floor (/ diff 60)))
14926 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
14927 y 0
14928 d (floor (+ (/ diff ds) 0.5))
14929 h 0 m 0))
14930 (if (not to-buffer)
14931 (message "%s" (org-make-tdiff-string y d h m))
14932 (if (org-at-table-p)
14933 (progn
14934 (goto-char match-end)
14935 (setq align t)
14936 (and (looking-at " *|") (goto-char (match-end 0))))
14937 (goto-char match-end))
14938 (if (looking-at
14940 (replace-match ""))
14941 (if negative (insert " -"))
14942 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
14943 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
14944 (insert " " (format fh h m))))
14945 (if align (org-table-align))
14946 (message "Time difference inserted")))))
14948 (defun org-make-tdiff-string (y d h m)
14949 (let ((fmt "")
14950 (l nil))
14951 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
14952 l (push y l)))
14953 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
14954 l (push d l)))
14955 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
14956 l (push h l)))
14957 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
14958 l (push m l)))
14959 (apply 'format fmt (nreverse l))))
14961 (defun org-time-string-to-time (s)
14962 (apply 'encode-time (org-parse-time-string s)))
14963 (defun org-time-string-to-seconds (s)
14964 (org-float-time (org-time-string-to-time s)))
14966 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
14967 "Convert a time stamp to an absolute day number.
14968 If there is a specifier for a cyclic time stamp, get the closest date to
14969 DAYNR.
14970 PREFER and SHOW-ALL are passed through to `org-closest-date'.
14971 the variable date is bound by the calendar when this is called."
14972 (cond
14974 (if (org-diary-sexp-entry (match-string 1 s) "" date)
14975 daynr
14976 (+ daynr 1000)))
14978 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
14979 (time-to-days (current-time))) (match-string 0 s)
14980 prefer show-all))
14981 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
14983 (defun org-days-to-iso-week (days)
14984 "Return the iso week number."
14985 (require 'cal-iso)
14986 (car (calendar-iso-from-absolute days)))
14988 (defun org-small-year-to-year (year)
14989 "Convert 2-digit years into 4-digit years.
14990 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
14991 The year 2000 cannot be abbreviated. Any year larger than 99
14992 is returned unchanged."
14993 (if (< year 38)
14994 (setq year (+ 2000 year))
14995 (if (< year 100)
14996 (setq year (+ 1900 year))))
14997 year)
14999 (defun org-time-from-absolute (d)
15000 "Return the time corresponding to date D.
15001 D may be an absolute day number, or a calendar-type list (month day year)."
15002 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15003 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15005 (defun org-calendar-holiday ()
15006 "List of holidays, for Diary display in Org-mode."
15007 (require 'holidays)
15008 (let ((hl (funcall
15009 (if (fboundp 'calendar-check-holidays)
15010 'calendar-check-holidays 'check-calendar-holidays) date)))
15011 (if hl (mapconcat 'identity hl "; "))))
15013 (defun org-diary-sexp-entry (sexp entry date)
15014 "Process a SEXP diary ENTRY for DATE."
15015 (require 'diary-lib)
15016 (let ((result (if calendar-debug-sexp
15017 (let ((stack-trace-on-error t))
15018 (eval (car (read-from-string sexp))))
15019 (condition-case nil
15020 (eval (car (read-from-string sexp)))
15021 (error
15022 (beep)
15023 (message "Bad sexp at line %d in %s: %s"
15024 (org-current-line)
15025 (buffer-file-name) sexp)
15026 (sleep-for 2))))))
15027 (cond ((stringp result) result)
15028 ((and (consp result)
15029 (not (consp (cdr result)))
15030 (stringp (cdr result))) (cdr result))
15031 ((and (consp result)
15032 (stringp (car result))) result)
15033 (result entry)
15034 (t nil))))
15036 (defun org-diary-to-ical-string (frombuf)
15037 "Get iCalendar entries from diary entries in buffer FROMBUF.
15038 This uses the icalendar.el library."
15039 (let* ((tmpdir (if (featurep 'xemacs)
15040 (temp-directory)
15041 temporary-file-directory))
15042 (tmpfile (make-temp-name
15043 (expand-file-name "orgics" tmpdir)))
15044 buf rtn b e)
15045 (with-current-buffer frombuf
15046 (icalendar-export-region (point-min) (point-max) tmpfile)
15047 (setq buf (find-buffer-visiting tmpfile))
15048 (set-buffer buf)
15049 (goto-char (point-min))
15050 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15051 (setq b (match-beginning 0)))
15052 (goto-char (point-max))
15053 (if (re-search-backward "^END:VEVENT" nil t)
15054 (setq e (match-end 0)))
15056 (kill-buffer buf)
15057 (delete-file tmpfile)
15058 rtn))
15060 (defun org-closest-date (start current change prefer show-all)
15061 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15062 When PREFER is `past' return a date that is either CURRENT or past.
15063 When PREFER is `future', return a date that is either CURRENT or future.
15064 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15065 ;; Make the proper lists from the dates
15066 (catch 'exit
15067 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15068 dn dw sday cday n1 n2 n0
15069 d m y y1 y2 date1 date2 nmonths nm ny m2)
15071 (setq start (org-date-to-gregorian start)
15072 current (org-date-to-gregorian
15073 (if show-all
15074 current
15075 (time-to-days (current-time))))
15076 sday (calendar-absolute-from-gregorian start)
15077 cday (calendar-absolute-from-gregorian current))
15079 (if (<= cday sday) (throw 'exit sday))
15082 (setq dn (string-to-number (match-string 1 change))
15083 dw (cdr (assoc (match-string 2 change) a1)))
15084 (error "Invalid change specifier: %s" change))
15085 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15086 (cond
15087 ((eq dw 'day)
15088 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15089 n2 (+ n1 dn)))
15090 ((eq dw 'year)
15091 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15092 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15093 (setq date1 (list m d y1)
15094 n1 (calendar-absolute-from-gregorian date1)
15095 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15096 n2 (calendar-absolute-from-gregorian date2)))
15097 ((eq dw 'month)
15098 ;; approx number of month between the two dates
15099 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15100 ;; How often does dn fit in there?
15101 (setq d (nth 1 start) m (car start) y (nth 2 start)
15102 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15103 m (+ m nm)
15104 ny (floor (/ m 12))
15105 y (+ y ny)
15106 m (- m (* ny 12)))
15107 (while (> m 12) (setq m (- m 12) y (1+ y)))
15108 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15109 (setq m2 (+ m dn) y2 y)
15110 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15111 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15112 (while (<= n2 cday)
15113 (setq n1 n2 m m2 y y2)
15114 (setq m2 (+ m dn) y2 y)
15115 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15116 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15117 ;; Make sure n1 is the earlier date
15118 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15119 (if show-all
15120 (cond
15121 ((eq prefer 'past) (if (= cday n2) n2 n1))
15122 ((eq prefer 'future) (if (= cday n1) n1 n2))
15123 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15124 (cond
15125 ((eq prefer 'past) (if (= cday n2) n2 n1))
15126 ((eq prefer 'future) (if (= cday n1) n1 n2))
15127 (t (if (= cday n1) n1 n2)))))))
15129 (defun org-date-to-gregorian (date)
15130 "Turn any specification of DATE into a Gregorian date for the calendar."
15131 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15132 ((and (listp date) (= (length date) 3)) date)
15133 ((stringp date)
15134 (setq date (org-parse-time-string date))
15135 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15136 ((listp date)
15137 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15139 (defun org-parse-time-string (s &optional nodefault)
15140 "Parse the standard Org-mode time string.
15141 This should be a lot faster than the normal `parse-time-string'.
15142 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15143 hour and minute fields will be nil if not given."
15144 (if (string-match org-ts-regexp0 s)
15145 (list 0
15146 (if (or (match-beginning 8) (not nodefault))
15147 (string-to-number (or (match-string 8 s) "0")))
15148 (if (or (match-beginning 7) (not nodefault))
15149 (string-to-number (or (match-string 7 s) "0")))
15150 (string-to-number (match-string 4 s))
15151 (string-to-number (match-string 3 s))
15152 (string-to-number (match-string 2 s))
15153 nil nil nil)
15154 (error "Not a standard Org-mode time string: %s" s)))
15156 (defun org-timestamp-up (&optional arg)
15157 "Increase the date item at the cursor by one.
15158 If the cursor is on the year, change the year. If it is on the month or
15159 the day, change that.
15160 With prefix ARG, change by that many units."
15161 (interactive "p")
15162 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15164 (defun org-timestamp-down (&optional arg)
15165 "Decrease the date item at the cursor by one.
15166 If the cursor is on the year, change the year. If it is on the month or
15167 the day, change that.
15168 With prefix ARG, change by that many units."
15169 (interactive "p")
15170 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15172 (defun org-timestamp-up-day (&optional arg)
15173 "Increase the date in the time stamp by one day.
15174 With prefix ARG, change that many days."
15175 (interactive "p")
15176 (if (and (not (org-at-timestamp-p t))
15177 (org-on-heading-p))
15178 (org-todo 'up)
15179 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15181 (defun org-timestamp-down-day (&optional arg)
15182 "Decrease the date in the time stamp by one day.
15183 With prefix ARG, change that many days."
15184 (interactive "p")
15185 (if (and (not (org-at-timestamp-p t))
15186 (org-on-heading-p))
15187 (org-todo 'down)
15188 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15190 (defun org-at-timestamp-p (&optional inactive-ok)
15191 "Determine if the cursor is in or at a timestamp."
15192 (interactive)
15193 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15194 (pos (point))
15195 (ans (or (looking-at tsr)
15196 (save-excursion
15198 (if (> (point) (point-min)) (backward-char 1))
15199 (and (looking-at tsr)
15200 (> (- (match-end 0) pos) -1))))))
15201 (and ans
15202 (boundp 'org-ts-what)
15203 (setq org-ts-what
15204 (cond
15205 ((= pos (match-beginning 0)) 'bracket)
15206 ((= pos (1- (match-end 0))) 'bracket)
15207 ((org-pos-in-match-range pos 2) 'year)
15208 ((org-pos-in-match-range pos 3) 'month)
15209 ((org-pos-in-match-range pos 7) 'hour)
15210 ((org-pos-in-match-range pos 8) 'minute)
15211 ((or (org-pos-in-match-range pos 4)
15212 (org-pos-in-match-range pos 5)) 'day)
15213 ((and (> pos (or (match-end 8) (match-end 5)))
15214 (< pos (match-end 0)))
15215 (- pos (or (match-end 8) (match-end 5))))
15216 (t 'day))))
15217 ans))
15219 (defun org-toggle-timestamp-type ()
15220 "Toggle the type (<active> or [inactive]) of a time stamp."
15221 (interactive)
15222 (when (org-at-timestamp-p t)
15223 (let ((beg (match-beginning 0)) (end (match-end 0))
15224 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15225 (save-excursion
15226 (goto-char beg)
15227 (while (re-search-forward "[][<>]" end t)
15228 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15229 t t)))
15230 (message "Timestamp is now %sactive"
15231 (if (equal (char-after beg) ?<) "" "in")))))
15233 (defun org-timestamp-change (n &optional what updown)
15234 "Change the date in the time stamp at point.
15235 The date will be changed by N times WHAT. WHAT can be `day', `month',
15236 `year', `minute', `second'. If WHAT is not given, the cursor position
15237 in the timestamp determines what will be changed."
15238 (let ((pos (point))
15239 with-hm inactive
15240 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15241 org-ts-what
15242 extra rem
15243 ts time time0)
15244 (if (not (org-at-timestamp-p t))
15245 (error "Not at a timestamp"))
15246 (if (and (not what) (eq org-ts-what 'bracket))
15247 (org-toggle-timestamp-type)
15248 (if (and (not what) (not (eq org-ts-what 'day))
15249 org-display-custom-times
15250 (get-text-property (point) 'display)
15251 (not (get-text-property (1- (point)) 'display)))
15252 (setq org-ts-what 'day))
15253 (setq org-ts-what (or what org-ts-what)
15254 inactive (= (char-after (match-beginning 0)) ?\[)
15255 ts (match-string 0))
15256 (replace-match "")
15257 (if (string-match
15259 ts)
15260 (setq extra (match-string 1 ts)))
15262 (setq with-hm t))
15263 (setq time0 (org-parse-time-string ts))
15264 (when (and updown
15265 (eq org-ts-what 'minute)
15266 (not current-prefix-arg))
15267 ;; This looks like s-up and s-down. Change by one rounding step.
15268 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15269 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15270 (setcar (cdr time0) (+ (nth 1 time0)
15271 (if (> n 0) (- rem) (- dm rem))))))
15272 (setq time
15273 (encode-time (or (car time0) 0)
15274 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15275 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15276 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15277 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15278 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15279 (nthcdr 6 time0)))
15280 (when (and (member org-ts-what '(hour minute))
15281 extra
15283 (setq extra (org-modify-ts-extra
15284 extra
15285 (if (eq org-ts-what 'hour) 2 5)
15286 n dm)))
15287 (when (integerp org-ts-what)
15288 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15289 (if (eq what 'calendar)
15290 (let ((cal-date (org-get-date-from-calendar)))
15291 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15292 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15293 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15294 (setcar time0 (or (car time0) 0))
15295 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15296 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15297 (setq time (apply 'encode-time time0))))
15298 (setq org-last-changed-timestamp
15299 (org-insert-time-stamp time with-hm inactive nil nil extra))
15300 (org-clock-update-time-maybe)
15301 (goto-char pos)
15302 ;; Try to recenter the calendar window, if any
15303 (if (and org-calendar-follow-timestamp-change
15304 (get-buffer-window "*Calendar*" t)
15305 (memq org-ts-what '(day month year)))
15306 (org-recenter-calendar (time-to-days time))))))
15308 (defun org-modify-ts-extra (s pos n dm)
15309 "Change the different parts of the lead-time and repeat fields in timestamp."
15310 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15311 ng h m new rem)
15312 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15313 (cond
15314 ((or (org-pos-in-match-range pos 2)
15315 (org-pos-in-match-range pos 3))
15316 (setq m (string-to-number (match-string 3 s))
15317 h (string-to-number (match-string 2 s)))
15318 (if (org-pos-in-match-range pos 2)
15319 (setq h (+ h n))
15320 (setq n (* dm (org-no-warnings (signum n))))
15321 (when (not (= 0 (setq rem (% m dm))))
15322 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15323 (setq m (+ m n)))
15324 (if (< m 0) (setq m (+ m 60) h (1- h)))
15325 (if (> m 59) (setq m (- m 60) h (1+ h)))
15326 (setq h (min 24 (max 0 h)))
15327 (setq ng 1 new (format "-%02d:%02d" h m)))
15328 ((org-pos-in-match-range pos 6)
15329 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15330 ((org-pos-in-match-range pos 5)
15331 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15333 ((org-pos-in-match-range pos 9)
15334 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15335 ((org-pos-in-match-range pos 8)
15336 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15338 (when ng
15339 (setq s (concat
15340 (substring s 0 (match-beginning ng))
15341 new
15342 (substring s (match-end ng))))))
15343 s))
15345 (defun org-recenter-calendar (date)
15346 "If the calendar is visible, recenter it to DATE."
15347 (let* ((win (selected-window))
15348 (cwin (get-buffer-window "*Calendar*" t))
15349 (calendar-move-hook nil))
15350 (when cwin
15351 (select-window cwin)
15352 (calendar-goto-date (if (listp date) date
15353 (calendar-gregorian-from-absolute date)))
15354 (select-window win))))
15356 (defun org-goto-calendar (&optional arg)
15357 "Go to the Emacs calendar at the current date.
15358 If there is a time stamp in the current line, go to that date.
15359 A prefix ARG can be used to force the current date."
15360 (interactive "P")
15361 (let ((tsr org-ts-regexp) diff
15362 (calendar-move-hook nil)
15363 (calendar-view-holidays-initially-flag nil)
15364 (calendar-view-diary-initially-flag nil))
15365 (if (or (org-at-timestamp-p)
15366 (save-excursion
15367 (beginning-of-line 1)
15368 (looking-at (concat ".*" tsr))))
15369 (let ((d1 (time-to-days (current-time)))
15370 (d2 (time-to-days
15371 (org-time-string-to-time (match-string 1)))))
15372 (setq diff (- d2 d1))))
15373 (calendar)
15374 (calendar-goto-today)
15375 (if (and diff (not arg)) (calendar-forward-day diff))))
15377 (defun org-get-date-from-calendar ()
15378 "Return a list (month day year) of date at point in calendar."
15379 (with-current-buffer "*Calendar*"
15380 (save-match-data
15381 (calendar-cursor-to-date))))
15383 (defun org-date-from-calendar ()
15384 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15385 If there is already a time stamp at the cursor position, update it."
15386 (interactive)
15387 (if (org-at-timestamp-p t)
15388 (org-timestamp-change 0 'calendar)
15389 (let ((cal-date (org-get-date-from-calendar)))
15390 (org-insert-time-stamp
15391 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15393 (defun org-minutes-to-hh:mm-string (m)
15394 "Compute H:MM from a number of minutes."
15395 (let ((h (/ m 60)))
15396 (setq m (- m (* 60 h)))
15397 (format org-time-clocksum-format h m)))
15399 (defun org-hh:mm-string-to-minutes (s)
15400 "Convert a string H:MM to a number of minutes.
15401 If the string is just a number, interpret it as minutes.
15402 In fact, the first hh:mm or number in the string will be taken,
15403 there can be extra stuff in the string.
15404 If no number is found, the return value is 0."
15405 (cond
15407 (+ (* (string-to-number (match-string 1 s)) 60)
15408 (string-to-number (match-string 2 s))))
15410 (string-to-number (match-string 1 s)))
15411 (t 0)))
15413 ;;;; Files
15415 (defun org-save-all-org-buffers ()
15416 "Save all Org-mode buffers without user confirmation."
15417 (interactive)
15418 (message "Saving all Org-mode buffers...")
15419 (save-some-buffers t 'org-mode-p)
15420 (when (featurep 'org-id) (org-id-locations-save))
15421 (message "Saving all Org-mode buffers... done"))
15423 (defun org-revert-all-org-buffers ()
15424 "Revert all Org-mode buffers.
15425 Prompt for confirmation when there are unsaved changes.
15426 Be sure you know what you are doing before letting this function
15427 overwrite your changes.
15429 This function is useful in a setup where one tracks org files
15430 with a version control system, to revert on one machine after pulling
15431 changes from another. I believe the procedure must be like this:
15433 1. M-x org-save-all-org-buffers
15434 2. Pull changes from the other machine, resolve conflicts
15435 3. M-x org-revert-all-org-buffers"
15436 (interactive)
15437 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15438 (error "Abort"))
15439 (save-excursion
15440 (save-window-excursion
15441 (mapc
15442 (lambda (b)
15443 (when (and (with-current-buffer b (org-mode-p))
15444 (with-current-buffer b buffer-file-name))
15445 (switch-to-buffer b)
15446 (revert-buffer t 'no-confirm)))
15447 (buffer-list))
15448 (when (and (featurep 'org-id) org-id-track-globally)
15449 (org-id-locations-load)))))
15451 ;;;; Agenda files
15453 ;;;###autoload
15454 (defun org-switchb (&optional arg)
15455 "Switch between Org buffers.
15456 With a prefix argument, restrict available to files.
15457 With two prefix arguments, restrict available buffers to agenda files.
15459 Defaults to `iswitchb' for buffer name completion.
15460 Set `org-completion-use-ido' to make it use ido instead."
15461 (interactive "P")
15462 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15463 ((equal arg '(16)) (org-buffer-list 'agenda))
15464 (t (org-buffer-list))))
15465 (org-completion-use-iswitchb org-completion-use-iswitchb)
15466 (org-completion-use-ido org-completion-use-ido))
15467 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15468 (setq org-completion-use-iswitchb t))
15469 (switch-to-buffer
15470 (org-icompleting-read "Org buffer: "
15471 (mapcar 'list (mapcar 'buffer-name blist))
15472 nil t))))
15474 ;;; Define some older names previously used for this functionality
15475 ;;;###autoload
15476 (defalias 'org-ido-switchb 'org-switchb)
15477 ;;;###autoload
15478 (defalias 'org-iswitchb 'org-switchb)
15480 (defun org-buffer-list (&optional predicate exclude-tmp)
15481 "Return a list of Org buffers.
15482 PREDICATE can be `export', `files' or `agenda'.
15484 export restrict the list to Export buffers.
15485 files restrict the list to buffers visiting Org files.
15486 agenda restrict the list to buffers visiting agenda files.
15488 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15489 (let* ((bfn nil)
15490 (agenda-files (and (eq predicate 'agenda)
15491 (mapcar 'file-truename (org-agenda-files t))))
15492 (filter
15493 (cond
15494 ((eq predicate 'files)
15495 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
15496 ((eq predicate 'export)
15497 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15498 ((eq predicate 'agenda)
15499 (lambda (b)
15500 (with-current-buffer b
15501 (and (eq major-mode 'org-mode)
15502 (setq bfn (buffer-file-name b))
15503 (member (file-truename bfn) agenda-files)))))
15504 (t (lambda (b) (with-current-buffer b
15505 (or (eq major-mode 'org-mode)
15506 (string-match "\*Org .*Export"
15507 (buffer-name b)))))))))
15508 (delq nil
15509 (mapcar
15510 (lambda(b)
15511 (if (and (funcall filter b)
15512 (or (not exclude-tmp)
15513 (not (string-match "tmp" (buffer-name b)))))
15514 b
15515 nil))
15516 (buffer-list)))))
15518 (defun org-agenda-files (&optional unrestricted archives)
15519 "Get the list of agenda files.
15520 Optional UNRESTRICTED means return the full list even if a restriction
15521 is currently in place.
15522 When ARCHIVES is t, include all archive files that are really being
15523 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15524 `org-agenda-archives-mode' is t."
15525 (let ((files
15526 (cond
15527 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15528 ((stringp org-agenda-files) (org-read-agenda-file-list))
15529 ((listp org-agenda-files) org-agenda-files)
15530 (t (error "Invalid value of `org-agenda-files'")))))
15531 (setq files (apply 'append
15532 (mapcar (lambda (f)
15533 (if (file-directory-p f)
15534 (directory-files
15535 f t org-agenda-file-regexp)
15536 (list f)))
15537 files)))
15538 (when org-agenda-skip-unavailable-files
15539 (setq files (delq nil
15540 (mapcar (function
15541 (lambda (file)
15542 (and (file-readable-p file) file)))
15543 files))))
15544 (when (or (eq archives t)
15545 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15546 (setq files (org-add-archive-files files)))
15547 files))
15549 (defun org-agenda-file-p (&optional file)
15550 "Return non-nil, if FILE is an agenda file.
15551 If FILE is omitted, use the file associated with the current
15552 buffer."
15553 (member (or file (buffer-file-name))
15554 (org-agenda-files t)))
15556 (defun org-edit-agenda-file-list ()
15557 "Edit the list of agenda files.
15558 Depending on setup, this either uses customize to edit the variable
15559 `org-agenda-files', or it visits the file that is holding the list. In the
15560 latter case, the buffer is set up in a way that saving it automatically kills
15561 the buffer and restores the previous window configuration."
15562 (interactive)
15563 (if (stringp org-agenda-files)
15564 (let ((cw (current-window-configuration)))
15565 (find-file org-agenda-files)
15566 (org-set-local 'org-window-configuration cw)
15567 (org-add-hook 'after-save-hook
15568 (lambda ()
15569 (set-window-configuration
15570 (prog1 org-window-configuration
15571 (kill-buffer (current-buffer))))
15572 (org-install-agenda-files-menu)
15573 (message "New agenda file list installed"))
15574 nil 'local)
15575 (message "%s" (substitute-command-keys
15577 (customize-variable 'org-agenda-files)))
15579 (defun org-store-new-agenda-file-list (list)
15580 "Set new value for the agenda file list and save it correctly."
15581 (if (stringp org-agenda-files)
15582 (let ((fe (org-read-agenda-file-list t)) b u)
15583 (while (setq b (find-buffer-visiting org-agenda-files))
15584 (kill-buffer b))
15585 (with-temp-file org-agenda-files
15586 (insert
15587 (mapconcat
15588 (lambda (f) ;; Keep un-expanded entries.
15589 (if (setq u (assoc f fe))
15590 (cdr u)
15591 f))
15594 (let ((org-mode-hook nil) (org-inhibit-startup t)
15595 (org-insert-mode-line-in-empty-file nil))
15596 (setq org-agenda-files list)
15597 (customize-save-variable 'org-agenda-files org-agenda-files))))
15599 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15600 "Read the list of agenda files from a file.
15601 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15602 filenames, used by `org-store-new-agenda-file-list' to write back
15603 un-expanded file names."
15604 (when (file-directory-p org-agenda-files)
15605 (error "`org-agenda-files' cannot be a single directory"))
15606 (when (stringp org-agenda-files)
15607 (with-temp-buffer
15608 (insert-file-contents org-agenda-files)
15609 (mapcar
15610 (lambda (f)
15611 (let ((e (expand-file-name (substitute-in-file-name f)
15612 org-directory)))
15613 (if pair-with-expansion
15614 (cons e f)
15615 e)))
15618 ;;;###autoload
15619 (defun org-cycle-agenda-files ()
15620 "Cycle through the files in `org-agenda-files'.
15621 If the current buffer visits an agenda file, find the next one in the list.
15622 If the current buffer does not, find the first agenda file."
15623 (interactive)
15624 (let* ((fs (org-agenda-files t))
15625 (files (append fs (list (car fs))))
15626 (tcf (if buffer-file-name (file-truename buffer-file-name)))
15627 file)
15628 (unless files (error "No agenda files"))
15629 (catch 'exit
15630 (while (setq file (pop files))
15631 (if (equal (file-truename file) tcf)
15632 (when (car files)
15633 (find-file (car files))
15634 (throw 'exit t))))
15635 (find-file (car fs)))
15636 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
15638 (defun org-agenda-file-to-front (&optional to-end)
15639 "Move/add the current file to the top of the agenda file list.
15640 If the file is not present in the list, it is added to the front. If it is
15641 present, it is moved there. With optional argument TO-END, add/move to the
15642 end of the list."
15643 (interactive "P")
15644 (let ((org-agenda-skip-unavailable-files nil)
15645 (file-alist (mapcar (lambda (x)
15646 (cons (file-truename x) x))
15647 (org-agenda-files t)))
15648 (ctf (file-truename buffer-file-name))
15649 x had)
15650 (setq x (assoc ctf file-alist) had x)
15652 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
15653 (if to-end
15654 (setq file-alist (append (delq x file-alist) (list x)))
15655 (setq file-alist (cons x (delq x file-alist))))
15656 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
15657 (org-install-agenda-files-menu)
15658 (message "File %s to %s of agenda file list"
15659 (if had "moved" "added") (if to-end "end" "front"))))
15661 (defun org-remove-file (&optional file)
15662 "Remove current file from the list of files in variable `org-agenda-files'.
15663 These are the files which are being checked for agenda entries.
15664 Optional argument FILE means use this file instead of the current."
15665 (interactive)
15666 (let* ((org-agenda-skip-unavailable-files nil)
15667 (file (or file buffer-file-name))
15668 (true-file (file-truename file))
15669 (afile (abbreviate-file-name file))
15670 (files (delq nil (mapcar
15671 (lambda (x)
15672 (if (equal true-file
15673 (file-truename x))
15674 nil x))
15675 (org-agenda-files t)))))
15676 (if (not (= (length files) (length (org-agenda-files t))))
15677 (progn
15678 (org-store-new-agenda-file-list files)
15679 (org-install-agenda-files-menu)
15680 (message "Removed file: %s" afile))
15681 (message "File was not in list: %s (not removed)" afile))))
15683 (defun org-file-menu-entry (file)
15684 (vector file (list 'find-file file) t))
15686 (defun org-check-agenda-file (file)
15687 "Make sure FILE exists. If not, ask user what to do."
15688 (when (not (file-exists-p file))
15689 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
15690 (abbreviate-file-name file))
15691 (let ((r (downcase (read-char-exclusive))))
15692 (cond
15693 ((equal r ?r)
15694 (org-remove-file file)
15695 (throw 'nextfile t))
15696 (t (error "Abort"))))))
15698 (defun org-get-agenda-file-buffer (file)
15699 "Get a buffer visiting FILE. If the buffer needs to be created, add
15700 it to the list of buffers which might be released later."
15701 (let ((buf (org-find-base-buffer-visiting file)))
15702 (if buf
15703 buf ; just return it
15704 ;; Make a new buffer and remember it
15705 (setq buf (find-file-noselect file))
15706 (if buf (push buf org-agenda-new-buffers))
15707 buf)))
15709 (defun org-release-buffers (blist)
15710 "Release all buffers in list, asking the user for confirmation when needed.
15711 When a buffer is unmodified, it is just killed. When modified, it is saved
15712 \(if the user agrees) and then killed."
15713 (let (buf file)
15714 (while (setq buf (pop blist))
15715 (setq file (buffer-file-name buf))
15716 (when (and (buffer-modified-p buf)
15717 file
15718 (y-or-n-p (format "Save file %s? " file)))
15719 (with-current-buffer buf (save-buffer)))
15720 (kill-buffer buf))))
15722 (defun org-prepare-agenda-buffers (files)
15723 "Create buffers for all agenda files, protect archived trees and comments."
15724 (interactive)
15725 (let ((pa '(:org-archived t))
15726 (pc '(:org-comment t))
15727 (pall '(:org-archived t :org-comment t))
15728 (inhibit-read-only t)
15729 (rea (concat ":" org-archive-tag ":"))
15730 bmp file re)
15731 (save-excursion
15732 (save-restriction
15733 (while (setq file (pop files))
15734 (catch 'nextfile
15735 (if (bufferp file)
15736 (set-buffer file)
15737 (org-check-agenda-file file)
15738 (set-buffer (org-get-agenda-file-buffer file)))
15739 (widen)
15740 (setq bmp (buffer-modified-p))
15741 (org-refresh-category-properties)
15742 (setq org-todo-keywords-for-agenda
15743 (append org-todo-keywords-for-agenda org-todo-keywords-1))
15744 (setq org-done-keywords-for-agenda
15745 (append org-done-keywords-for-agenda org-done-keywords))
15746 (setq org-todo-keyword-alist-for-agenda
15747 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
15748 (setq org-drawers-for-agenda
15749 (append org-drawers-for-agenda org-drawers))
15750 (setq org-tag-alist-for-agenda
15751 (append org-tag-alist-for-agenda org-tag-alist))
15753 (save-excursion
15754 (remove-text-properties (point-min) (point-max) pall)
15755 (when org-agenda-skip-archived-trees
15756 (goto-char (point-min))
15757 (while (re-search-forward rea nil t)
15758 (if (org-on-heading-p t)
15759 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
15760 (goto-char (point-min))
15762 (while (re-search-forward re nil t)
15763 (add-text-properties
15764 (match-beginning 0) (org-end-of-subtree t) pc)))
15765 (set-buffer-modified-p bmp)))))
15766 (setq org-todo-keywords-for-agenda
15767 (org-uniquify org-todo-keywords-for-agenda))
15768 (setq org-todo-keyword-alist-for-agenda
15769 (org-uniquify org-todo-keyword-alist-for-agenda)
15770 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
15772 ;;;; Embedded LaTeX
15774 (defvar org-cdlatex-mode-map (make-sparse-keymap)
15775 "Keymap for the minor `org-cdlatex-mode'.")
15777 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
15778 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
15779 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
15780 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
15781 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
15783 (defvar org-cdlatex-texmathp-advice-is-done nil
15784 "Flag remembering if we have applied the advice to texmathp already.")
15786 (define-minor-mode org-cdlatex-mode
15787 "Toggle the minor `org-cdlatex-mode'.
15788 This mode supports entering LaTeX environment and math in LaTeX fragments
15789 in Org-mode.
15791 nil " OCDL" nil
15792 (when org-cdlatex-mode (require 'cdlatex))
15793 (unless org-cdlatex-texmathp-advice-is-done
15794 (setq org-cdlatex-texmathp-advice-is-done t)
15795 (defadvice texmathp (around org-math-always-on activate)
15796 "Always return t in org-mode buffers.
15797 This is because we want to insert math symbols without dollars even outside
15798 the LaTeX math segments. If Orgmode thinks that point is actually inside
15799 an embedded LaTeX fragment, let texmathp do its job.
15801 (interactive)
15802 (let (p)
15803 (cond
15804 ((not (org-mode-p)) ad-do-it)
15805 ((eq this-command 'cdlatex-math-symbol)
15806 (setq ad-return-value t
15807 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
15808 (t
15809 (let ((p (org-inside-LaTeX-fragment-p)))
15810 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
15811 (setq ad-return-value t
15812 texmathp-why '("Org-mode embedded math" . 0))
15813 (if p ad-do-it)))))))))
15815 (defun turn-on-org-cdlatex ()
15816 "Unconditionally turn on `org-cdlatex-mode'."
15817 (org-cdlatex-mode 1))
15819 (defun org-inside-LaTeX-fragment-p ()
15820 "Test if point is inside a LaTeX fragment.
15822 sequence appearing also before point.
15823 Even though the matchers for math are configurable, this function assumes
15825 delimiters are skipped when they have been removed by customization.
15826 The return value is nil, or a cons cell with the delimiter and
15827 and the position of this delimiter.
15829 This function does a reasonably good job, but can locally be fooled by
15830 for example currency specifications. For example it will assume being in
15832 fragments that are properly closed, but during editing, we have to live
15833 with the uncertainty caused by missing closing delimiters. This function
15834 looks only before point, not after."
15835 (catch 'exit
15836 (let ((pos (point))
15837 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
15838 (lim (progn
15840 (point)))
15841 dd-on str (start 0) m re)
15842 (goto-char pos)
15843 (when dodollar
15845 re (nth 1 (assoc "$" org-latex-regexps)))
15846 (while (string-match re str start)
15847 (cond
15848 ((= (match-end 0) (length str))
15849 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
15850 ((= (match-end 0) (- (length str) 5))
15851 (throw 'exit nil))
15852 (t (setq start (match-end 0))))))
15853 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
15854 (goto-char pos)
15855 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
15856 (and (match-beginning 2) (throw 'exit nil))
15857 ;; count $$
15859 (setq dd-on (not dd-on)))
15860 (goto-char pos)
15861 (if dd-on (cons "$$" m))))))
15863 (defun org-inside-latex-macro-p ()
15864 "Is point inside a LaTeX macro or its arguments?"
15865 (save-match-data
15866 (org-in-regexp
15869 (defun org-try-cdlatex-tab ()
15870 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
15871 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
15872 - inside a LaTeX fragment, or
15873 - after the first word in a line, where an abbreviation expansion could
15874 insert a LaTeX environment."
15875 (when org-cdlatex-mode
15876 (cond
15877 ((save-excursion
15878 (skip-chars-backward "a-zA-Z0-9*")
15880 (bolp))
15881 (cdlatex-tab) t)
15882 ((org-inside-LaTeX-fragment-p)
15883 (cdlatex-tab) t)
15884 (t nil))))
15886 (defun org-cdlatex-underscore-caret (&optional arg)
15887 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
15888 Revert to the normal definition outside of these fragments."
15889 (interactive "P")
15890 (if (org-inside-LaTeX-fragment-p)
15891 (call-interactively 'cdlatex-sub-superscript)
15892 (let (org-cdlatex-mode)
15893 (call-interactively (key-binding (vector last-input-event))))))
15895 (defun org-cdlatex-math-modify (&optional arg)
15896 "Execute `cdlatex-math-modify' in LaTeX fragments.
15897 Revert to the normal definition outside of these fragments."
15898 (interactive "P")
15899 (if (org-inside-LaTeX-fragment-p)
15900 (call-interactively 'cdlatex-math-modify)
15901 (let (org-cdlatex-mode)
15902 (call-interactively (key-binding (vector last-input-event))))))
15904 (defvar org-latex-fragment-image-overlays nil
15905 "List of overlays carrying the images of latex fragments.")
15906 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
15908 (defun org-remove-latex-fragment-image-overlays ()
15909 "Remove all overlays with LaTeX fragment images in current buffer."
15910 (mapc 'delete-overlay org-latex-fragment-image-overlays)
15911 (setq org-latex-fragment-image-overlays nil))
15913 (defun org-preview-latex-fragment (&optional subtree)
15914 "Preview the LaTeX fragment at point, or all locally or globally.
15915 If the cursor is in a LaTeX fragment, create the image and overlay
15916 it over the source code. If there is no fragment at point, display
15917 all fragments in the current text, from one headline to the next. With
15918 prefix SUBTREE, display all fragments in the current subtree. With a
15920 the cursor is before the first headline,
15921 display all fragments in the buffer.
15923 (interactive "P")
15924 (org-remove-latex-fragment-image-overlays)
15925 (save-excursion
15926 (save-restriction
15927 (let (beg end at msg)
15928 (cond
15929 ((or (equal subtree '(16))
15930 (not (save-excursion
15931 (re-search-backward (concat "^" outline-regexp) nil t))))
15932 (setq beg (point-min) end (point-max)
15933 msg "Creating images for buffer...%s"))
15934 ((equal subtree '(4))
15935 (org-back-to-heading)
15936 (setq beg (point) end (org-end-of-subtree t)
15937 msg "Creating images for subtree...%s"))
15938 (t
15939 (if (setq at (org-inside-LaTeX-fragment-p))
15940 (goto-char (max (point-min) (- (cdr at) 2)))
15941 (org-back-to-heading))
15942 (setq beg (point) end (progn (outline-next-heading) (point))
15943 msg (if at "Creating image...%s"
15944 "Creating images for entry...%s"))))
15945 (message msg "")
15946 (narrow-to-region beg end)
15947 (goto-char beg)
15948 (org-format-latex
15949 (concat "ltxpng/" (file-name-sans-extension
15950 (file-name-nondirectory
15951 buffer-file-name)))
15952 default-directory 'overlays msg at 'forbuffer 'dvipng)
15953 (message msg "done. Use `C-c C-c' to remove images.")))))
15955 (defvar org-latex-regexps
15957 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
15960 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
15964 "Regular expressions for matching embedded LaTeX.")
15966 (defvar org-export-have-math nil) ;; dynamic scoping
15967 (defun org-format-latex (prefix &optional dir overlays msg at
15968 forbuffer processing-type)
15969 "Replace LaTeX fragments with links to an image, and produce images.
15970 Some of the options can be changed using the variable
15971 `org-format-latex-options'."
15972 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
15973 (let* ((prefixnodir (file-name-nondirectory prefix))
15974 (absprefix (expand-file-name prefix dir))
15975 (todir (file-name-directory absprefix))
15976 (opt org-format-latex-options)
15977 (matchers (plist-get opt :matchers))
15978 (re-list org-latex-regexps)
15979 (org-format-latex-header-extra
15980 (plist-get (org-infile-export-plist) :latex-header-extra))
15981 (cnt 0) txt hash link beg end re e checkdir
15982 executables-checked string
15983 m n block linkfile movefile ov)
15984 ;; Check the different regular expressions
15985 (while (setq e (pop re-list))
15986 (setq m (car e) re (nth 1 e) n (nth 2 e)
15988 (when (member m matchers)
15989 (goto-char (point-min))
15990 (while (re-search-forward re nil t)
15991 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
15992 (not (get-text-property (match-beginning n)
15993 'org-protected))
15994 (or (not overlays)
15995 (not (eq (get-char-property (match-beginning n)
15996 'org-overlay-type)
15997 'org-latex-overlay))))
15998 (setq org-export-have-math t)
15999 (cond
16000 ((eq processing-type 'verbatim)
16001 ;; Leave the text verbatim, just protect it
16002 (add-text-properties (match-beginning n) (match-end n)
16003 '(org-protected t)))
16004 ((eq processing-type 'mathjax)
16005 ;; Prepare for MathJax processing
16006 (setq string (match-string n))
16007 (if (member m '("$" "$1"))
16008 (save-excursion
16009 (delete-region (match-beginning n) (match-end n))
16010 (goto-char (match-beginning n))
16013 '(org-protected t))))
16014 (add-text-properties (match-beginning n) (match-end n)
16015 '(org-protected t))))
16016 ((or (eq processing-type 'dvipng) t)
16017 ;; Process to an image
16018 (setq txt (match-string n)
16019 beg (match-beginning n) end (match-end n)
16020 cnt (1+ cnt))
16021 (let (print-length print-level) ; make sure full list is printed
16022 (setq hash (sha1 (prin1-to-string
16023 (list org-format-latex-header
16024 org-format-latex-header-extra
16025 org-export-latex-default-packages-alist
16026 org-export-latex-packages-alist
16027 org-format-latex-options
16028 forbuffer txt)))
16029 linkfile (format "%s_%s.png" prefix hash)
16030 movefile (format "%s_%s.png" absprefix hash)))
16031 (setq link (concat block "[[file:" linkfile "]]" block))
16032 (if msg (message msg cnt))
16033 (goto-char beg)
16034 (unless checkdir ; make sure the directory exists
16035 (setq checkdir t)
16036 (or (file-directory-p todir) (make-directory todir t)))
16038 (unless executables-checked
16039 (org-check-external-command
16040 "latex" "needed to convert LaTeX fragments to images")
16041 (org-check-external-command
16042 "dvipng" "needed to convert LaTeX fragments to images")
16043 (setq executables-checked t))
16045 (unless (file-exists-p movefile)
16046 (org-create-formula-image
16047 txt movefile opt forbuffer))
16048 (if overlays
16049 (progn
16050 (mapc (lambda (o)
16051 (if (eq (overlay-get o 'org-overlay-type)
16052 'org-latex-overlay)
16053 (delete-overlay o)))
16054 (overlays-in beg end))
16055 (setq ov (make-overlay beg end))
16056 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16057 (if (featurep 'xemacs)
16058 (progn
16059 (overlay-put ov 'invisible t)
16060 (overlay-put
16061 ov 'end-glyph
16062 (make-glyph (vector 'png :file movefile))))
16063 (overlay-put
16064 ov 'display
16065 (list 'image :type 'png :file movefile :ascent 'center)))
16066 (push ov org-latex-fragment-image-overlays)
16067 (goto-char end))
16068 (delete-region beg end)
16069 (insert (org-add-props link
16070 (list 'org-latex-src
16071 (replace-regexp-in-string
16074 ;; This function borrows from Ganesh Swami's latex2png.el
16075 (defun org-create-formula-image (string tofile options buffer)
16076 "This calls dvipng."
16077 (require 'org-latex)
16078 (let* ((tmpdir (if (featurep 'xemacs)
16079 (temp-directory)
16080 temporary-file-directory))
16081 (texfilebase (make-temp-name
16082 (expand-file-name "orgtex" tmpdir)))
16083 (texfile (concat texfilebase ".tex"))
16084 (dvifile (concat texfilebase ".dvi"))
16085 (pngfile (concat texfilebase ".png"))
16086 (fnh (if (featurep 'xemacs)
16087 (font-height (get-face-font 'default))
16088 (face-attribute 'default :height nil)))
16089 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16090 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16091 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16092 "Black"))
16093 (bg (or (plist-get options (if buffer :background :html-background))
16094 "Transparent")))
16095 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16096 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16097 (with-temp-file texfile
16098 (insert (org-splice-latex-header
16099 org-format-latex-header
16100 org-export-latex-default-packages-alist
16101 org-export-latex-packages-alist t
16102 org-format-latex-header-extra))
16104 (require 'org-latex)
16105 (org-export-latex-fix-inputenc))
16106 (let ((dir default-directory))
16107 (condition-case nil
16108 (progn
16109 (cd tmpdir)
16110 (call-process "latex" nil nil nil texfile))
16111 (error nil))
16112 (cd dir))
16113 (if (not (file-exists-p dvifile))
16114 (progn (message "Failed to create dvi file from %s" texfile) nil)
16115 (condition-case nil
16116 (call-process "dvipng" nil nil nil
16117 "-fg" fg "-bg" bg
16118 "-D" dpi
16119 ;;"-x" scale "-y" scale
16120 "-T" "tight"
16121 "-o" pngfile
16122 dvifile)
16123 (error nil))
16124 (if (not (file-exists-p pngfile))
16125 (if org-format-latex-signal-error
16126 (error "Failed to create png file from %s" texfile)
16127 (message "Failed to create png file from %s" texfile)
16128 nil)
16129 ;; Use the requested file name and clean up
16130 (copy-file pngfile tofile 'replace)
16131 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16132 (delete-file (concat texfilebase e)))
16133 pngfile))))
16135 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16136 "Fill a LaTeX header template TPL.
16137 In the template, the following place holders will be recognized:
16140 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16142 [NO-PACKAGES] do not include PKG
16143 [EXTRA] the string EXTRA
16144 [NO-EXTRA] do not include EXTRA
16146 For backward compatibility, if both the positive and the negative place
16148 assumed to be present at the end of the template.
16149 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16150 EXTRA is a string.
16151 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16152 (let (rpl (end ""))
16154 (setq rpl (if (or (match-end 1) (not def-pkg))
16155 "" (org-latex-packages-to-string def-pkg snippets-p t))
16156 tpl (replace-match rpl t t tpl))
16157 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16160 (setq rpl (if (or (match-end 1) (not pkg))
16161 "" (org-latex-packages-to-string pkg snippets-p t))
16162 tpl (replace-match rpl t t tpl))
16163 (if pkg (setq end
16165 (org-latex-packages-to-string pkg snippets-p)))))
16168 (setq rpl (if (or (match-end 1) (not extra))
16170 tpl (replace-match rpl t t tpl))
16176 tpl)))
16178 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16180 (setq pkg (mapconcat (lambda(p)
16181 (cond
16182 ((stringp p) p)
16183 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16184 (format "%% Package %s omitted" (cadr p)))
16185 ((equal "" (car p))
16187 (t
16189 (car p) (cadr p)))))
16190 pkg
16194 (defun org-dvipng-color (attr)
16195 "Return an rgb color specification for dvipng."
16196 (apply 'format "rgb %s %s %s"
16197 (mapcar 'org-normalize-color
16198 (color-values (face-attribute 'default attr nil)))))
16200 (defun org-normalize-color (value)
16201 "Return string to be used as color value for an RGB component."
16202 (format "%g" (/ value 65535.0)))
16204 ;; Image display
16207 (defvar org-inline-image-overlays nil)
16208 (make-variable-buffer-local 'org-inline-image-overlays)
16210 (defun org-toggle-inline-images (&optional include-linked)
16211 "Toggle the display of inline images.
16212 INCLUDE-LINKED is passed to `org-display-inline-images'."
16213 (interactive "P")
16214 (if org-inline-image-overlays
16215 (progn
16216 (org-remove-inline-images)
16217 (message "Inline image display turned off"))
16218 (org-display-inline-images include-linked)
16219 (if org-inline-image-overlays
16220 (message "%d images displayed inline"
16221 (length org-inline-image-overlays))
16222 (message "No images to display inline"))))
16224 (defun org-display-inline-images (&optional include-linked refresh beg end)
16225 "Display inline images.
16226 Normally only links without a description part are inlined, because this
16227 is how it will work for export. When INCLUDE-LINKED is set, also links
16228 with a description part will be inlined. This can be nice for a quick
16229 look at those images, but it does not reflect what exported files will look
16230 like.
16231 When REFRESH is set, refresh existing images between BEG and END.
16232 This will create new image displays only if necessary.
16233 BEG and END default to the buffer boundaries."
16234 (interactive "P")
16235 (unless refresh
16236 (org-remove-inline-images)
16237 (clear-image-cache))
16238 (save-excursion
16239 (save-restriction
16240 (widen)
16241 (setq beg (or beg (point-min)) end (or end (point-max)))
16242 (goto-char (point-min))
16244 (substring (org-image-file-name-regexp) 0 -2)
16246 old file ov img)
16247 (while (re-search-forward re end t)
16248 (setq old (get-char-property-and-overlay (match-beginning 1)
16249 'org-image-overlay))
16250 (setq file (expand-file-name
16251 (concat (or (match-string 3) "") (match-string 4))))
16252 (when (file-exists-p file)
16253 (if (and (car-safe old) refresh)
16254 (image-refresh (overlay-get (cdr old) 'display))
16255 (setq img (save-match-data (create-image file)))
16256 (when img
16257 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16258 (overlay-put ov 'display img)
16259 (overlay-put ov 'face 'default)
16260 (overlay-put ov 'org-image-overlay t)
16261 (overlay-put ov 'modification-hooks
16262 (list 'org-display-inline-modification-hook))
16263 (push ov org-inline-image-overlays)))))))))
16265 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16266 "Remove inline-display overlay if a corresponding region is modified."
16267 (let ((inhibit-modification-hooks t))
16268 (when (and ov after)
16269 (delete ov org-inline-image-overlays)
16270 (delete-overlay ov))))
16272 (defun org-remove-inline-images ()
16273 "Remove inline display of images."
16274 (interactive)
16275 (mapc 'delete-overlay org-inline-image-overlays)
16276 (setq org-inline-image-overlays nil))
16278 ;;;; Key bindings
16280 ;; Make `C-c C-x' a prefix key
16281 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16283 ;; TAB key with modifiers
16284 (org-defkey org-mode-map "\C-i" 'org-cycle)
16285 (org-defkey org-mode-map [(tab)] 'org-cycle)
16286 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16287 (org-defkey org-mode-map [(meta tab)] 'org-complete)
16289 (org-defkey org-mode-map "\M-\C-i" 'org-complete)
16290 ;; The following line is necessary under Suse GNU/Linux
16291 (unless (featurep 'xemacs)
16292 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16293 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16294 (define-key org-mode-map [backtab] 'org-shifttab)
16296 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16297 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16298 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16300 ;; Cursor keys with modifiers
16301 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16302 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16303 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16304 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16306 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16307 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16308 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16309 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16311 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16312 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16313 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16314 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16316 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16317 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16319 ;; Babel keys
16320 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16321 (mapc (lambda (pair)
16322 (define-key org-babel-map (car pair) (cdr pair)))
16323 org-babel-key-bindings)
16325 ;;; Extra keys for tty access.
16326 ;; We only set them when really needed because otherwise the
16327 ;; menus don't show the simple keys
16329 (when (or org-use-extra-keys
16330 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16331 (not window-system))
16332 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16333 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16334 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16335 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16336 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16337 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16338 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16339 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16340 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16341 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16342 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16343 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16344 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16345 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16346 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16347 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16348 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16349 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16350 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16351 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16352 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16353 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16354 (org-defkey org-mode-map [?\e (tab)] 'org-complete)
16355 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16356 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16357 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16358 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16359 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16361 ;; All the other keys
16363 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16364 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16365 (if (boundp 'narrow-map)
16366 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16367 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16368 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16369 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16370 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16371 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16372 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16373 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16374 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16375 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16376 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16377 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16378 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16379 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16380 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16381 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16382 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16383 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16385 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16386 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16387 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16388 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16389 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16390 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16391 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16392 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16393 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16394 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16395 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16396 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16397 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16398 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16399 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16400 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16401 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16402 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16403 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16405 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16406 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16407 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16408 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16409 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16410 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16411 (org-defkey org-mode-map "\C-c^" 'org-sort)
16412 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16413 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16414 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16415 (org-defkey org-mode-map "\C-m" 'org-return)
16416 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16417 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16418 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16419 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16420 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16421 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16422 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16423 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16424 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16425 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16426 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16427 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16428 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16429 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16430 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16431 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16432 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16433 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16434 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16435 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16436 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16438 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16439 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16440 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16441 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16443 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16444 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16445 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16446 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16447 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16448 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16449 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16450 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16451 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16452 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16454 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16455 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16456 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16457 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16458 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16459 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16460 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16462 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16463 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16464 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16465 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16466 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16468 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16470 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16472 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16473 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16475 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16478 (when (featurep 'xemacs)
16479 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16482 (defconst org-speed-commands-default
16483 '(
16484 ("Outline Navigation")
16485 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16486 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16487 ("f" . (org-speed-move-safe 'org-forward-same-level))
16488 ("b" . (org-speed-move-safe 'org-backward-same-level))
16489 ("u" . (org-speed-move-safe 'outline-up-heading))
16490 ("j" . org-goto)
16491 ("g" . (org-refile t))
16492 ("Outline Visibility")
16493 ("c" . org-cycle)
16494 ("C" . org-shifttab)
16495 (" " . org-display-outline-path)
16496 ("Outline Structure Editing")
16497 ("U" . org-shiftmetaup)
16498 ("D" . org-shiftmetadown)
16499 ("r" . org-metaright)
16500 ("l" . org-metaleft)
16501 ("R" . org-shiftmetaright)
16502 ("L" . org-shiftmetaleft)
16503 ("i" . (progn (forward-char 1) (call-interactively
16504 'org-insert-heading-respect-content)))
16505 ("^" . org-sort)
16506 ("w" . org-refile)
16507 ("a" . org-archive-subtree-default-with-confirmation)
16508 ("." . outline-mark-subtree)
16509 ("Clock Commands")
16510 ("I" . org-clock-in)
16511 ("O" . org-clock-out)
16512 ("Meta Data Editing")
16513 ("t" . org-todo)
16514 ("0" . (org-priority ?\ ))
16515 ("1" . (org-priority ?A))
16516 ("2" . (org-priority ?B))
16517 ("3" . (org-priority ?C))
16518 (";" . org-set-tags-command)
16519 ("e" . org-set-effort)
16520 ("Agenda Views etc")
16521 ("v" . org-agenda)
16522 ("/" . org-sparse-tree)
16523 ("Misc")
16524 ("o" . org-open-at-point)
16525 ("?" . org-speed-command-help)
16526 ("<" . (org-agenda-set-restriction-lock 'subtree))
16527 (">" . (org-agenda-remove-restriction-lock))
16528 )
16529 "The default speed commands.")
16531 (defun org-print-speed-command (e)
16532 (if (> (length (car e)) 1)
16533 (progn
16535 (princ (car e))
16537 (princ (make-string (length (car e)) ?-))
16539 (princ (car e))
16540 (princ " ")
16541 (if (symbolp (cdr e))
16542 (princ (symbol-name (cdr e)))
16543 (prin1 (cdr e)))
16546 (defun org-speed-command-help ()
16547 "Show the available speed commands."
16548 (interactive)
16549 (if (not org-use-speed-commands)
16550 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16551 (with-output-to-temp-buffer "*Help*"
16553 (mapc 'org-print-speed-command org-speed-commands-user)
16556 (mapc 'org-print-speed-command org-speed-commands-default))
16557 (with-current-buffer "*Help*"
16558 (setq truncate-lines t))))
16560 (defun org-speed-move-safe (cmd)
16561 "Execute CMD, but make sure that the cursor always ends up in a headline.
16562 If not, return to the original position and throw an error."
16563 (interactive)
16564 (let ((pos (point)))
16565 (call-interactively cmd)
16566 (unless (and (bolp) (org-on-heading-p))
16567 (goto-char pos)
16568 (error "Boundary reached while executing %s" cmd))))
16570 (defvar org-self-insert-command-undo-counter 0)
16572 (defvar org-table-auto-blank-field) ; defined in org-table.el
16573 (defvar org-speed-command nil)
16575 (defun org-speed-command-default-hook (keys)
16576 "Hook for activating single-letter speed commands.
16577 `org-speed-commands-default' specifies a minimal command set. Use
16578 `org-speed-commands-user' for further customization."
16579 (when (or (and (bolp) (looking-at outline-regexp))
16580 (and (functionp org-use-speed-commands)
16581 (funcall org-use-speed-commands)))
16582 (cdr (assoc keys (append org-speed-commands-user
16583 org-speed-commands-default)))))
16585 (defun org-babel-speed-command-hook (keys)
16586 "Hook for activating single-letter code block commands."
16587 (when (and (bolp) (looking-at org-babel-src-block-regexp))
16588 (cdr (assoc keys org-babel-key-bindings))))
16590 (defcustom org-speed-command-hook
16591 '(org-speed-command-default-hook org-babel-speed-command-hook)
16592 "Hook for activating speed commands at strategic locations.
16593 Hook functions are called in sequence until a valid handler is
16594 found.
16596 Each hook takes a single argument, a user-pressed command key
16597 which is also a `self-insert-command' from the global map.
16599 Within the hook, examine the cursor position and the command key
16600 and return nil or a valid handler as appropriate. Handler could
16601 be one of an interactive command, a function, or a form.
16603 Set `org-use-speed-commands' to non-nil value to enable this
16604 hook. The default setting is `org-speed-command-default-hook'."
16605 :group 'org-structure
16606 :type 'hook)
16608 (defun org-self-insert-command (N)
16609 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
16610 If the cursor is in a table looking at whitespace, the whitespace is
16611 overwritten, and the table is not marked as requiring realignment."
16612 (interactive "p")
16613 (cond
16614 ((and org-use-speed-commands
16615 (setq org-speed-command
16616 (run-hook-with-args-until-success
16617 'org-speed-command-hook (this-command-keys))))
16618 (cond
16619 ((commandp org-speed-command)
16620 (setq this-command org-speed-command)
16621 (call-interactively org-speed-command))
16622 ((functionp org-speed-command)
16623 (funcall org-speed-command))
16624 ((and org-speed-command (listp org-speed-command))
16625 (eval org-speed-command))
16626 (t (let (org-use-speed-commands)
16627 (call-interactively 'org-self-insert-command)))))
16628 ((and
16629 (org-table-p)
16630 (progn
16631 ;; check if we blank the field, and if that triggers align
16632 (and (featurep 'org-table) org-table-auto-blank-field
16633 (member last-command
16634 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
16636 ;; got extra space, this field does not determine column width
16637 (let (org-table-may-need-update) (org-table-blank-field))
16638 ;; no extra space, this field may determine column width
16639 (org-table-blank-field)))
16640 t)
16641 (eq N 1)
16643 (let (org-table-may-need-update)
16644 (goto-char (1- (match-end 0)))
16645 (delete-backward-char 1)
16646 (goto-char (match-beginning 0))
16647 (self-insert-command N)))
16648 (t
16649 (setq org-table-may-need-update t)
16650 (self-insert-command N)
16651 (org-fix-tags-on-the-fly)
16652 (if org-self-insert-cluster-for-undo
16653 (if (not (eq last-command 'org-self-insert-command))
16654 (setq org-self-insert-command-undo-counter 1)
16655 (if (>= org-self-insert-command-undo-counter 20)
16656 (setq org-self-insert-command-undo-counter 1)
16657 (and (> org-self-insert-command-undo-counter 0)
16658 buffer-undo-list
16659 (not (cadr buffer-undo-list)) ; remove nil entry
16660 (setcdr buffer-undo-list (cddr buffer-undo-list)))
16661 (setq org-self-insert-command-undo-counter
16662 (1+ org-self-insert-command-undo-counter))))))))
16664 (defun org-fix-tags-on-the-fly ()
16665 (when (and (equal (char-after (point-at-bol)) ?*)
16666 (org-on-heading-p))
16667 (org-align-tags-here org-tags-column)))
16669 (defun org-delete-backward-char (N)
16670 "Like `delete-backward-char', insert whitespace at field end in tables.
16671 When deleting backwards, in tables this function will insert whitespace in
16673 still be marked for re-alignment if the field did fill the entire column,
16674 because, in this case the deletion might narrow the column."
16675 (interactive "p")
16676 (if (and (org-table-p)
16677 (eq N 1)
16678 (string-match "|" (buffer-substring (point-at-bol) (point)))
16679 (looking-at ".*?|"))
16680 (let ((pos (point))
16682 (c org-table-may-need-update))
16683 (backward-delete-char N)
16684 (if (not overwrite-mode)
16685 (progn
16686 (skip-chars-forward "^|")
16687 (insert " ")
16688 (goto-char (1- pos))))
16689 ;; noalign: if there were two spaces at the end, this field
16690 ;; does not determine the width of the column.
16691 (if noalign (setq org-table-may-need-update c)))
16692 (backward-delete-char N)
16693 (org-fix-tags-on-the-fly)))
16695 (defun org-delete-char (N)
16696 "Like `delete-char', but insert whitespace at field end in tables.
16697 When deleting characters, in tables this function will insert whitespace in
16699 still be marked for re-alignment if the field did fill the entire column,
16700 because, in this case the deletion might narrow the column."
16701 (interactive "p")
16702 (if (and (org-table-p)
16703 (not (bolp))
16704 (not (= (char-after) ?|))
16705 (eq N 1))
16706 (if (looking-at ".*?|")
16707 (let ((pos (point))
16709 (c org-table-may-need-update))
16710 (replace-match (concat
16711 (substring (match-string 0) 1 -1)
16712 " |"))
16713 (goto-char pos)
16714 ;; noalign: if there were two spaces at the end, this field
16715 ;; does not determine the width of the column.
16716 (if noalign (setq org-table-may-need-update c)))
16717 (delete-char N))
16718 (delete-char N)
16719 (org-fix-tags-on-the-fly)))
16721 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
16722 (put 'org-self-insert-command 'delete-selection t)
16723 (put 'orgtbl-self-insert-command 'delete-selection t)
16724 (put 'org-delete-char 'delete-selection 'supersede)
16725 (put 'org-delete-backward-char 'delete-selection 'supersede)
16726 (put 'org-yank 'delete-selection 'yank)
16728 ;; Make `flyspell-mode' delay after some commands
16729 (put 'org-self-insert-command 'flyspell-delayed t)
16730 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
16731 (put 'org-delete-char 'flyspell-delayed t)
16732 (put 'org-delete-backward-char 'flyspell-delayed t)
16734 ;; Make pabbrev-mode expand after org-mode commands
16735 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
16736 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
16738 ;; How to do this: Measure non-white length of current string
16739 ;; If equal to column width, we should realign.
16741 (defun org-remap (map &rest commands)
16742 "In MAP, remap the functions given in COMMANDS.
16743 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
16744 (let (new old)
16745 (while commands
16746 (setq old (pop commands) new (pop commands))
16747 (if (fboundp 'command-remapping)
16748 (org-defkey map (vector 'remap old) new)
16749 (substitute-key-definition old new map global-map)))))
16751 (when (eq org-enable-table-editor 'optimized)
16752 ;; If the user wants maximum table support, we need to hijack
16753 ;; some standard editing functions
16754 (org-remap org-mode-map
16755 'self-insert-command 'org-self-insert-command
16756 'delete-char 'org-delete-char
16757 'delete-backward-char 'org-delete-backward-char)
16758 (org-defkey org-mode-map "|" 'org-force-self-insert))
16760 (defvar org-ctrl-c-ctrl-c-hook nil
16761 "Hook for functions attaching themselves to `C-c C-c'.
16762 This can be used to add additional functionality to the C-c C-c key which
16763 executes context-dependent commands.
16764 Each function will be called with no arguments. The function must check
16765 if the context is appropriate for it to act. If yes, it should do its
16766 thing and then return a non-nil value. If the context is wrong,
16767 just do nothing and return nil.")
16769 (defvar org-tab-first-hook nil
16770 "Hook for functions to attach themselves to TAB.
16771 See `org-ctrl-c-ctrl-c-hook' for more information.
16772 This hook runs as the first action when TAB is pressed, even before
16773 `org-cycle' messes around with the `outline-regexp' to cater for
16774 inline tasks and plain list item folding.
16775 If any function in this hook returns t, any other actions that
16776 would have been caused by TAB (such as table field motion or visibility
16777 cycling) will not occur.")
16779 (defvar org-tab-after-check-for-table-hook nil
16780 "Hook for functions to attach themselves to TAB.
16781 See `org-ctrl-c-ctrl-c-hook' for more information.
16782 This hook runs after it has been established that the cursor is not in a
16783 table, but before checking if the cursor is in a headline or if global cycling
16784 should be done.
16785 If any function in this hook returns t, not other actions like visibility
16786 cycling will be done.")
16788 (defvar org-tab-after-check-for-cycling-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 it has been established that not table field motion and
16792 not visibility should be done because of current context. This is probably
16793 the place where a package like yasnippets can hook in.")
16795 (defvar org-tab-before-tab-emulation-hook nil
16796 "Hook for functions to attach themselves to TAB.
16797 See `org-ctrl-c-ctrl-c-hook' for more information.
16798 This hook runs after every other options for TAB have been exhausted, but
16801 (defvar org-metaleft-hook nil
16802 "Hook for functions attaching themselves to `M-left'.
16803 See `org-ctrl-c-ctrl-c-hook' for more information.")
16804 (defvar org-metaright-hook nil
16805 "Hook for functions attaching themselves to `M-right'.
16806 See `org-ctrl-c-ctrl-c-hook' for more information.")
16807 (defvar org-metaup-hook nil
16808 "Hook for functions attaching themselves to `M-up'.
16809 See `org-ctrl-c-ctrl-c-hook' for more information.")
16810 (defvar org-metadown-hook nil
16811 "Hook for functions attaching themselves to `M-down'.
16812 See `org-ctrl-c-ctrl-c-hook' for more information.")
16813 (defvar org-shiftmetaleft-hook nil
16814 "Hook for functions attaching themselves to `M-S-left'.
16815 See `org-ctrl-c-ctrl-c-hook' for more information.")
16816 (defvar org-shiftmetaright-hook nil
16817 "Hook for functions attaching themselves to `M-S-right'.
16818 See `org-ctrl-c-ctrl-c-hook' for more information.")
16819 (defvar org-shiftmetaup-hook nil
16820 "Hook for functions attaching themselves to `M-S-up'.
16821 See `org-ctrl-c-ctrl-c-hook' for more information.")
16822 (defvar org-shiftmetadown-hook nil
16823 "Hook for functions attaching themselves to `M-S-down'.
16824 See `org-ctrl-c-ctrl-c-hook' for more information.")
16825 (defvar org-metareturn-hook nil
16826 "Hook for functions attaching themselves to `M-RET'.
16827 See `org-ctrl-c-ctrl-c-hook' for more information.")
16828 (defvar org-shiftup-hook nil
16829 "Hook for functions attaching themselves to `S-up'.
16830 See `org-ctrl-c-ctrl-c-hook' for more information.")
16831 (defvar org-shiftup-final-hook nil
16832 "Hook for functions attaching themselves to `S-up'.
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-shiftdown-hook nil
16836 "Hook for functions attaching themselves to `S-down'.
16837 See `org-ctrl-c-ctrl-c-hook' for more information.")
16838 (defvar org-shiftdown-final-hook nil
16839 "Hook for functions attaching themselves to `S-down'.
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-shiftleft-hook nil
16843 "Hook for functions attaching themselves to `S-left'.
16844 See `org-ctrl-c-ctrl-c-hook' for more information.")
16845 (defvar org-shiftleft-final-hook nil
16846 "Hook for functions attaching themselves to `S-left'.
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.")
16849 (defvar org-shiftright-hook nil
16850 "Hook for functions attaching themselves to `S-right'.
16851 See `org-ctrl-c-ctrl-c-hook' for more information.")
16852 (defvar org-shiftright-final-hook nil
16853 "Hook for functions attaching themselves to `S-right'.
16854 This one runs after all other options except shift-select have been excluded.
16855 See `org-ctrl-c-ctrl-c-hook' for more information.")
16857 (defun org-modifier-cursor-error ()
16858 "Throw an error, a modified cursor command was applied in wrong context."
16859 (error "This command is active in special context like tables, headlines or items"))
16861 (defun org-shiftselect-error ()
16862 "Throw an error because Shift-Cursor command was applied in wrong context."
16863 (if (and (boundp 'shift-select-mode) shift-select-mode)
16864 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
16865 (error "This command works only in special context like headlines or timestamps")))
16867 (defun org-call-for-shift-select (cmd)
16868 (let ((this-command-keys-shift-translated t))
16869 (call-interactively cmd)))
16871 (defun org-shifttab (&optional arg)
16872 "Global visibility cycling or move to previous table field.
16873 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
16874 on context.
16875 See the individual commands for more information."
16876 (interactive "P")
16877 (cond
16878 ((org-at-table-p) (call-interactively 'org-table-previous-field))
16879 ((integerp arg)
16880 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
16881 (message "Content view to level: %d" arg)
16882 (org-content (prefix-numeric-value arg2))
16883 (setq org-cycle-global-status 'overview)))
16884 (t (call-interactively 'org-global-cycle))))
16886 (defun org-shiftmetaleft ()
16887 "Promote subtree or delete table column.
16888 Calls `org-promote-subtree', `org-outdent-item',
16889 or `org-table-delete-column', depending on context.
16890 See the individual commands for more information."
16891 (interactive)
16892 (cond
16893 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
16894 ((org-at-table-p) (call-interactively 'org-table-delete-column))
16895 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
16896 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
16897 (t (org-modifier-cursor-error))))
16899 (defun org-shiftmetaright ()
16900 "Demote subtree or insert table column.
16901 Calls `org-demote-subtree', `org-indent-item',
16902 or `org-table-insert-column', depending on context.
16903 See the individual commands for more information."
16904 (interactive)
16905 (cond
16906 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
16907 ((org-at-table-p) (call-interactively 'org-table-insert-column))
16908 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
16909 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
16910 (t (org-modifier-cursor-error))))
16912 (defun org-shiftmetaup (&optional arg)
16913 "Move subtree up or kill table row.
16914 Calls `org-move-subtree-up' or `org-table-kill-row' or
16915 `org-move-item-up' depending on context. See the individual commands
16916 for more information."
16917 (interactive "P")
16918 (cond
16919 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
16920 ((org-at-table-p) (call-interactively 'org-table-kill-row))
16921 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
16922 ((org-at-item-p) (call-interactively 'org-move-item-up))
16923 (t (org-modifier-cursor-error))))
16925 (defun org-shiftmetadown (&optional arg)
16926 "Move subtree down or insert table row.
16927 Calls `org-move-subtree-down' or `org-table-insert-row' or
16928 `org-move-item-down', depending on context. See the individual
16929 commands for more information."
16930 (interactive "P")
16931 (cond
16932 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
16933 ((org-at-table-p) (call-interactively 'org-table-insert-row))
16934 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
16935 ((org-at-item-p) (call-interactively 'org-move-item-down))
16936 (t (org-modifier-cursor-error))))
16938 (defsubst org-hidden-tree-error ()
16939 (error
16940 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
16942 (defun org-metaleft (&optional arg)
16943 "Promote heading or move table column to left.
16944 Calls `org-do-promote' or `org-table-move-column', depending on context.
16945 With no specific context, calls the Emacs default `backward-word'.
16946 See the individual commands for more information."
16947 (interactive "P")
16948 (cond
16949 ((run-hook-with-args-until-success 'org-metaleft-hook))
16950 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
16951 ((or (org-on-heading-p)
16952 (and (org-region-active-p)
16953 (save-excursion
16954 (goto-char (region-beginning))
16955 (org-on-heading-p))))
16956 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16957 (call-interactively 'org-do-promote))
16958 ((or (org-at-item-p)
16959 (and (org-region-active-p)
16960 (save-excursion
16961 (goto-char (region-beginning))
16962 (org-at-item-p))))
16963 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16964 (call-interactively 'org-outdent-item))
16965 (t (call-interactively 'backward-word))))
16967 (defun org-metaright (&optional arg)
16968 "Demote subtree or move table column to right.
16969 Calls `org-do-demote' or `org-table-move-column', depending on context.
16970 With no specific context, calls the Emacs default `forward-word'.
16971 See the individual commands for more information."
16972 (interactive "P")
16973 (cond
16974 ((run-hook-with-args-until-success 'org-metaright-hook))
16975 ((org-at-table-p) (call-interactively 'org-table-move-column))
16976 ((or (org-on-heading-p)
16977 (and (org-region-active-p)
16978 (save-excursion
16979 (goto-char (region-beginning))
16980 (org-on-heading-p))))
16981 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
16982 (call-interactively 'org-do-demote))
16983 ((or (org-at-item-p)
16984 (and (org-region-active-p)
16985 (save-excursion
16986 (goto-char (region-beginning))
16987 (org-at-item-p))))
16988 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
16989 (call-interactively 'org-indent-item))
16990 (t (call-interactively 'forward-word))))
16992 (defun org-check-for-hidden (what)
16993 "Check if there are hidden headlines/items in the current visual line.
16994 WHAT can be either `headlines' or `items'. If the current line is
16995 an outline or item heading and it has a folded subtree below it,
16996 this function returns t, nil otherwise."
16997 (let ((re (cond
16998 ((eq what 'headlines) (concat "^" org-outline-regexp))
16999 ((eq what 'items) (concat "^" (org-item-re t)))
17000 (t (error "This should not happen"))))
17001 beg end)
17002 (save-excursion
17003 (catch 'exit
17004 (unless (org-region-active-p)
17005 (setq beg (point-at-bol))
17006 (beginning-of-line 2)
17007 (while (and (not (eobp)) ;; this is like `next-line'
17008 (get-char-property (1- (point)) 'invisible))
17009 (beginning-of-line 2))
17010 (setq end (point))
17011 (goto-char beg)
17012 (goto-char (point-at-eol))
17013 (setq end (max end (point)))
17014 (while (re-search-forward re end t)
17015 (if (get-char-property (match-beginning 0) 'invisible)
17016 (throw 'exit t))))
17017 nil))))
17019 (defun org-metaup (&optional arg)
17020 "Move subtree up or move table row up.
17021 Calls `org-move-subtree-up' or `org-table-move-row' or
17022 `org-move-item-up', depending on context. See the individual commands
17023 for more information."
17024 (interactive "P")
17025 (cond
17026 ((run-hook-with-args-until-success 'org-metaup-hook))
17027 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17028 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17029 ((org-at-item-p) (call-interactively 'org-move-item-up))
17030 (t (transpose-lines 1) (beginning-of-line -1))))
17032 (defun org-metadown (&optional arg)
17033 "Move subtree down or move table row down.
17034 Calls `org-move-subtree-down' or `org-table-move-row' or
17035 `org-move-item-down', depending on context. See the individual
17036 commands for more information."
17037 (interactive "P")
17038 (cond
17039 ((run-hook-with-args-until-success 'org-metadown-hook))
17040 ((org-at-table-p) (call-interactively 'org-table-move-row))
17041 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17042 ((org-at-item-p) (call-interactively 'org-move-item-down))
17043 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17045 (defun org-shiftup (&optional arg)
17046 "Increase item in timestamp or increase priority of current headline.
17047 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17048 depending on context. See the individual commands for more information."
17049 (interactive "P")
17050 (cond
17051 ((run-hook-with-args-until-success 'org-shiftup-hook))
17052 ((and org-support-shift-select (org-region-active-p))
17053 (org-call-for-shift-select 'previous-line))
17054 ((org-at-timestamp-p t)
17055 (call-interactively (if org-edit-timestamp-down-means-later
17056 'org-timestamp-down 'org-timestamp-up)))
17057 ((and (not (eq org-support-shift-select 'always))
17058 org-enable-priority-commands
17059 (org-on-heading-p))
17060 (call-interactively 'org-priority-up))
17061 ((and (not org-support-shift-select) (org-at-item-p))
17062 (call-interactively 'org-previous-item))
17063 ((org-clocktable-try-shift 'up arg))
17064 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17065 (org-support-shift-select
17066 (org-call-for-shift-select 'previous-line))
17067 (t (org-shiftselect-error))))
17069 (defun org-shiftdown (&optional arg)
17070 "Decrease item in timestamp or decrease priority of current headline.
17071 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17072 depending on context. See the individual commands for more information."
17073 (interactive "P")
17074 (cond
17075 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17076 ((and org-support-shift-select (org-region-active-p))
17077 (org-call-for-shift-select 'next-line))
17078 ((org-at-timestamp-p t)
17079 (call-interactively (if org-edit-timestamp-down-means-later
17080 'org-timestamp-up 'org-timestamp-down)))
17081 ((and (not (eq org-support-shift-select 'always))
17082 org-enable-priority-commands
17083 (org-on-heading-p))
17084 (call-interactively 'org-priority-down))
17085 ((and (not org-support-shift-select) (org-at-item-p))
17086 (call-interactively 'org-next-item))
17087 ((org-clocktable-try-shift 'down arg))
17088 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17089 (org-support-shift-select
17090 (org-call-for-shift-select 'next-line))
17091 (t (org-shiftselect-error))))
17093 (defun org-shiftright (&optional arg)
17094 "Cycle the thing at point or in the current line, depending on context.
17095 Depending on context, this does one of the following:
17097 - switch a timestamp at point one day into the future
17098 - on a headline, switch to the next TODO keyword.
17099 - on an item, switch entire list to the next bullet type
17100 - on a property line, switch to the next allowed value
17101 - on a clocktable definition line, move time block into the future"
17102 (interactive "P")
17103 (cond
17104 ((run-hook-with-args-until-success 'org-shiftright-hook))
17105 ((and org-support-shift-select (org-region-active-p))
17106 (org-call-for-shift-select 'forward-char))
17107 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17108 ((and (not (eq org-support-shift-select 'always))
17109 (org-on-heading-p))
17110 (let ((org-inhibit-logging
17111 (not org-treat-S-cursor-todo-selection-as-state-change))
17112 (org-inhibit-blocking
17113 (not org-treat-S-cursor-todo-selection-as-state-change)))
17114 (org-call-with-arg 'org-todo 'right)))
17115 ((or (and org-support-shift-select
17116 (not (eq org-support-shift-select 'always))
17117 (org-at-item-bullet-p))
17118 (and (not org-support-shift-select) (org-at-item-p)))
17119 (org-call-with-arg 'org-cycle-list-bullet nil))
17120 ((and (not (eq org-support-shift-select 'always))
17121 (org-at-property-p))
17122 (call-interactively 'org-property-next-allowed-value))
17123 ((org-clocktable-try-shift 'right arg))
17124 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17125 (org-support-shift-select
17126 (org-call-for-shift-select 'forward-char))
17127 (t (org-shiftselect-error))))
17129 (defun org-shiftleft (&optional arg)
17130 "Cycle the thing at point or in the current line, depending on context.
17131 Depending on context, this does one of the following:
17133 - switch a timestamp at point one day into the past
17134 - on a headline, switch to the previous TODO keyword.
17135 - on an item, switch entire list to the previous bullet type
17136 - on a property line, switch to the previous allowed value
17137 - on a clocktable definition line, move time block into the past"
17138 (interactive "P")
17139 (cond
17140 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17141 ((and org-support-shift-select (org-region-active-p))
17142 (org-call-for-shift-select 'backward-char))
17143 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17144 ((and (not (eq org-support-shift-select 'always))
17145 (org-on-heading-p))
17146 (let ((org-inhibit-logging
17147 (not org-treat-S-cursor-todo-selection-as-state-change))
17148 (org-inhibit-blocking
17149 (not org-treat-S-cursor-todo-selection-as-state-change)))
17150 (org-call-with-arg 'org-todo 'left)))
17151 ((or (and org-support-shift-select
17152 (not (eq org-support-shift-select 'always))
17153 (org-at-item-bullet-p))
17154 (and (not org-support-shift-select) (org-at-item-p)))
17155 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17156 ((and (not (eq org-support-shift-select 'always))
17157 (org-at-property-p))
17158 (call-interactively 'org-property-previous-allowed-value))
17159 ((org-clocktable-try-shift 'left arg))
17160 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17161 (org-support-shift-select
17162 (org-call-for-shift-select 'backward-char))
17163 (t (org-shiftselect-error))))
17165 (defun org-shiftcontrolright ()
17166 "Switch to next TODO set."
17167 (interactive)
17168 (cond
17169 ((and org-support-shift-select (org-region-active-p))
17170 (org-call-for-shift-select 'forward-word))
17171 ((and (not (eq org-support-shift-select 'always))
17172 (org-on-heading-p))
17173 (org-call-with-arg 'org-todo 'nextset))
17174 (org-support-shift-select
17175 (org-call-for-shift-select 'forward-word))
17176 (t (org-shiftselect-error))))
17178 (defun org-shiftcontrolleft ()
17179 "Switch to previous TODO set."
17180 (interactive)
17181 (cond
17182 ((and org-support-shift-select (org-region-active-p))
17183 (org-call-for-shift-select 'backward-word))
17184 ((and (not (eq org-support-shift-select 'always))
17185 (org-on-heading-p))
17186 (org-call-with-arg 'org-todo 'previousset))
17187 (org-support-shift-select
17188 (org-call-for-shift-select 'backward-word))
17189 (t (org-shiftselect-error))))
17191 (defun org-ctrl-c-ret ()
17192 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17193 (interactive)
17194 (cond
17195 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17196 (t (call-interactively 'org-insert-heading))))
17198 (defun org-copy-special ()
17199 "Copy region in table or copy current subtree.
17200 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17201 See the individual commands for more information."
17202 (interactive)
17203 (call-interactively
17204 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17206 (defun org-cut-special ()
17207 "Cut region in table or cut current subtree.
17208 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17209 See the individual commands for more information."
17210 (interactive)
17211 (call-interactively
17212 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17214 (defun org-paste-special (arg)
17215 "Paste rectangular region into table, or past subtree relative to level.
17216 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17217 See the individual commands for more information."
17218 (interactive "P")
17219 (if (org-at-table-p)
17220 (org-table-paste-rectangle)
17221 (org-paste-subtree arg)))
17223 (defun org-edit-special (&optional arg)
17224 "Call a special editor for the stuff at point.
17225 When at a table, call the formula editor with `org-table-edit-formulas'.
17226 When at the first line of an src example, call `org-edit-src-code'.
17227 When in an #+include line, visit the include file. Otherwise call
17228 `ffap' to visit the file at point."
17229 (interactive)
17230 ;; possibly prep session before editing source
17231 (when arg
17232 (let* ((info (org-babel-get-src-block-info))
17233 (lang (nth 0 info))
17234 (params (nth 2 info))
17235 (session (cdr (assoc :session params))))
17236 (when (and info session) ;; we are in a source-code block with a session
17237 (funcall
17238 (intern (concat "org-babel-prep-session:" lang)) session params))))
17239 (cond ;; proceed with `org-edit-special'
17240 ((save-excursion
17241 (beginning-of-line 1)
17242 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17243 (find-file (org-trim (match-string 1))))
17244 ((org-edit-src-code))
17245 ((org-edit-fixed-width-region))
17246 ((org-at-table.el-p)
17247 (org-edit-src-code))
17248 ((org-at-table-p)
17249 (call-interactively 'org-table-edit-formulas))
17250 (t (call-interactively 'ffap))))
17253 (defun org-ctrl-c-ctrl-c (&optional arg)
17254 "Set tags in headline, or update according to changed information at point.
17256 This command does many different things, depending on context:
17258 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17259 this is what we do.
17261 - If the cursor is on a statistics cookie, update it.
17263 - If the cursor is in a headline, prompt for tags and insert them
17264 into the current line, aligned to `org-tags-column'. When called
17265 with prefix arg, realign all tags in the current buffer.
17267 - If the cursor is in one of the special #+KEYWORD lines, this
17268 triggers scanning the buffer for these lines and updating the
17269 information.
17271 - If the cursor is inside a table, realign the table. This command
17272 works even if the automatic table editor has been turned off.
17274 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17275 the entire table.
17277 - If the cursor is at a footnote reference or definition, jump to
17278 the corresponding definition or references, respectively.
17280 - If the cursor is a the beginning of a dynamic block, update it.
17282 - If the current buffer is a capture buffer, close note and file it.
17284 - If the cursor is on a <<<target>>>, update radio targets and
17285 corresponding links in this buffer.
17287 - If the cursor is on a numbered item in a plain list, renumber the
17288 ordered list.
17290 - If the cursor is on a checkbox, toggle it.
17292 - If the cursor is on a code block, evaluate it. The variable
17293 `org-confirm-babel-evaluate' can be used to control prompting
17294 before code block evaluation, by default every code block
17295 evaluation requires confirmation. Code block evaluation can be
17296 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17297 (interactive "P")
17298 (let ((org-enable-table-editor t))
17299 (cond
17300 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17301 org-occur-highlights
17302 org-latex-fragment-image-overlays)
17303 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17304 (org-remove-occur-highlights)
17305 (org-remove-latex-fragment-image-overlays)
17306 (message "Temporary highlights/overlays removed from current buffer"))
17307 ((and (local-variable-p 'org-finish-function (current-buffer))
17308 (fboundp org-finish-function))
17309 (funcall org-finish-function))
17310 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17311 ((or (looking-at org-property-start-re)
17312 (org-at-property-p))
17313 (call-interactively 'org-property-action))
17314 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17316 (or (org-on-heading-p) (org-at-item-p)))
17317 (call-interactively 'org-update-statistics-cookies))
17318 ((org-on-heading-p) (call-interactively 'org-set-tags))
17319 ((org-at-table.el-p)
17320 (message "Use C-c ' to edit table.el tables"))
17321 ((org-at-table-p)
17322 (org-table-maybe-eval-formula)
17323 (if arg
17324 (call-interactively 'org-table-recalculate)
17325 (org-table-maybe-recalculate-line))
17326 (call-interactively 'org-table-align))
17327 ((or (org-footnote-at-reference-p)
17328 (org-footnote-at-definition-p))
17329 (call-interactively 'org-footnote-action))
17330 ((org-at-item-checkbox-p)
17331 (call-interactively 'org-list-repair)
17332 (call-interactively 'org-toggle-checkbox)
17333 (org-list-send-list 'maybe))
17334 ((org-at-item-p)
17335 (call-interactively 'org-list-repair)
17336 (when arg (call-interactively 'org-toggle-checkbox))
17337 (org-list-send-list 'maybe))
17338 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17339 ;; Dynamic block
17340 (beginning-of-line 1)
17341 (save-excursion (org-update-dblock)))
17342 ((save-excursion
17343 (beginning-of-line 1)
17345 (cond
17346 ((equal (match-string 1) "TBLFM")
17347 ;; Recalculate the table before this line
17348 (save-excursion
17349 (beginning-of-line 1)
17351 (if (org-at-table-p)
17352 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17353 (t
17354 (let ((org-inhibit-startup-visibility-stuff t)
17355 (org-startup-align-all-tables nil))
17356 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17357 (message "Local setup has been refreshed"))))
17358 ((org-clock-update-time-maybe))
17359 (t (error "C-c C-c can do nothing useful at this location")))))
17361 (defun org-mode-restart ()
17362 "Restart Org-mode, to scan again for special lines.
17363 Also updates the keyword regular expressions."
17364 (interactive)
17365 (org-mode)
17366 (message "Org-mode restarted"))
17368 (defun org-kill-note-or-show-branches ()
17369 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17370 (interactive)
17371 (if (not org-finish-function)
17372 (progn
17373 (hide-subtree)
17374 (call-interactively 'show-branches))
17375 (let ((org-note-abort t))
17376 (funcall org-finish-function))))
17378 (defun org-return (&optional indent)
17379 "Goto next table row or insert a newline.
17380 Calls `org-table-next-row' or `newline', depending on context.
17381 See the individual commands for more information."
17382 (interactive)
17383 (cond
17384 ((bobp) (if indent (newline-and-indent) (newline)))
17385 ((org-at-table-p)
17386 (org-table-justify-field-maybe)
17387 (call-interactively 'org-table-next-row))
17388 ((and org-return-follows-link
17389 (eq (get-text-property (point) 'face) 'org-link))
17390 (call-interactively 'org-open-at-point))
17391 ((and (org-at-heading-p)
17392 (looking-at
17394 (org-show-entry)
17395 (end-of-line 1)
17396 (newline))
17397 (t (if indent (newline-and-indent) (newline)))))
17399 (defun org-return-indent ()
17400 "Goto next table row or insert a newline and indent.
17401 Calls `org-table-next-row' or `newline-and-indent', depending on
17402 context. See the individual commands for more information."
17403 (interactive)
17404 (org-return t))
17406 (defun org-ctrl-c-star ()
17407 "Compute table, or change heading status of lines.
17408 Calls `org-table-recalculate' or `org-toggle-heading',
17409 depending on context."
17410 (interactive)
17411 (cond
17412 ((org-at-table-p)
17413 (call-interactively 'org-table-recalculate))
17414 (t
17415 ;; Convert all lines in region to list items
17416 (call-interactively 'org-toggle-heading))))
17418 (defun org-ctrl-c-minus ()
17419 "Insert separator line in table or modify bullet status of line.
17420 Also turns a plain line or a region of lines into list items.
17421 Calls `org-table-insert-hline', `org-toggle-item', or
17422 `org-cycle-list-bullet', depending on context."
17423 (interactive)
17424 (cond
17425 ((org-at-table-p)
17426 (call-interactively 'org-table-insert-hline))
17427 ((org-region-active-p)
17428 (call-interactively 'org-toggle-item))
17429 ((org-in-item-p)
17430 (call-interactively 'org-cycle-list-bullet))
17431 (t
17432 (call-interactively 'org-toggle-item))))
17434 (defun org-toggle-item ()
17435 "Convert headings or normal lines to items, items to normal lines.
17436 If there is no active region, only the current line is considered.
17438 If the first line in the region is a headline, convert all headlines to items.
17440 If the first line in the region is an item, convert all items to normal lines.
17442 If the first line is normal text, add an item bullet to each line."
17443 (interactive)
17444 (let (l2 l beg end)
17445 (if (org-region-active-p)
17446 (setq beg (region-beginning) end (region-end))
17447 (setq beg (point-at-bol)
17448 end (min (1+ (point-at-eol)) (point-max))))
17449 (save-excursion
17450 (goto-char end)
17451 (setq l2 (org-current-line))
17452 (goto-char beg)
17453 (beginning-of-line 1)
17454 (setq l (1- (org-current-line)))
17455 (if (org-at-item-p)
17456 ;; We already have items, de-itemize
17457 (while (< (setq l (1+ l)) l2)
17458 (when (org-at-item-p)
17460 (delete-region (point) (match-end 0)))
17461 (beginning-of-line 2))
17462 (if (org-on-heading-p)
17463 ;; Headings, convert to items
17464 (while (< (setq l (1+ l)) l2)
17465 (if (looking-at org-outline-regexp)
17466 (replace-match (org-list-bullet-string "-") t t))
17467 (beginning-of-line 2))
17468 ;; normal lines, turn them into items
17469 (while (< (setq l (1+ l)) l2)
17470 (unless (org-at-item-p)
17472 (replace-match
17474 (beginning-of-line 2)))))))
17476 (defun org-toggle-heading (&optional nstars)
17477 "Convert headings to normal text, or items or text to headings.
17478 If there is no active region, only the current line is considered.
17480 If the first line is a heading, remove the stars from all headlines
17481 in the region.
17483 If the first line is a plain list item, turn all plain list items
17484 into headings.
17486 If the first line is a normal line, turn each and every line in the
17487 region into a heading.
17489 When converting a line into a heading, the number of stars is chosen
17490 such that the lines become children of the current entry. However,
17491 when a prefix argument is given, its value determines the number of
17492 stars to add."
17493 (interactive "P")
17494 (let (l2 l itemp beg end)
17495 (if (org-region-active-p)
17496 (setq beg (region-beginning) end (region-end))
17497 (setq beg (point-at-bol)
17498 end (min (1+ (point-at-eol)) (point-max))))
17499 (save-excursion
17500 (goto-char end)
17501 (setq l2 (org-current-line))
17502 (goto-char beg)
17503 (beginning-of-line 1)
17504 (setq l (1- (org-current-line)))
17505 (if (org-on-heading-p)
17506 ;; We already have headlines, de-star them
17507 (while (< (setq l (1+ l)) l2)
17508 (when (org-on-heading-p t)
17509 (and (looking-at outline-regexp) (replace-match "")))
17510 (beginning-of-line 2))
17511 (setq itemp (org-at-item-p))
17512 (let* ((stars
17513 (if nstars
17514 (make-string (prefix-numeric-value current-prefix-arg)
17515 ?*)
17516 (save-excursion
17517 (if (re-search-backward org-complex-heading-regexp nil t)
17518 (match-string 1) ""))))
17519 (add-stars (cond (nstars "")
17520 ((equal stars "") "*")
17521 (org-odd-levels-only "**")
17522 (t "*")))
17523 (rpl (concat stars add-stars " ")))
17524 (while (< (setq l (1+ l)) l2)
17525 (if itemp
17526 (and (org-at-item-p) (replace-match rpl t t))
17527 (unless (org-on-heading-p)
17529 (replace-match (concat rpl (match-string 2))))))
17530 (beginning-of-line 2)))))))
17532 (defun org-meta-return (&optional arg)
17533 "Insert a new heading or wrap a region in a table.
17534 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17535 See the individual commands for more information."
17536 (interactive "P")
17537 (cond
17538 ((run-hook-with-args-until-success 'org-metareturn-hook))
17539 ((org-at-table-p)
17540 (call-interactively 'org-table-wrap-region))
17541 (t (call-interactively 'org-insert-heading))))
17543 ;;; Menu entries
17545 ;; Define the Org-mode menus
17546 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
17547 '("Tbl"
17548 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
17549 ["Next Field" org-cycle (org-at-table-p)]
17550 ["Previous Field" org-shifttab (org-at-table-p)]
17551 ["Next Row" org-return (org-at-table-p)]
17552 "--"
17553 ["Blank Field" org-table-blank-field (org-at-table-p)]
17554 ["Edit Field" org-table-edit-field (org-at-table-p)]
17555 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
17556 "--"
17557 ("Column"
17558 ["Move Column Left" org-metaleft (org-at-table-p)]
17559 ["Move Column Right" org-metaright (org-at-table-p)]
17560 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
17561 ["Insert Column" org-shiftmetaright (org-at-table-p)])
17562 ("Row"
17563 ["Move Row Up" org-metaup (org-at-table-p)]
17564 ["Move Row Down" org-metadown (org-at-table-p)]
17565 ["Delete Row" org-shiftmetaup (org-at-table-p)]
17566 ["Insert Row" org-shiftmetadown (org-at-table-p)]
17567 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
17568 "--"
17569 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
17570 ("Rectangle"
17571 ["Copy Rectangle" org-copy-special (org-at-table-p)]
17572 ["Cut Rectangle" org-cut-special (org-at-table-p)]
17573 ["Paste Rectangle" org-paste-special (org-at-table-p)]
17574 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
17575 "--"
17576 ("Calculate"
17577 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
17578 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17579 ["Edit Formulas" org-edit-special (org-at-table-p)]
17580 "--"
17581 ["Recalculate line" org-table-recalculate (org-at-table-p)]
17582 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17583 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
17584 "--"
17585 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
17586 "--"
17587 ["Sum Column/Rectangle" org-table-sum
17588 (or (org-at-table-p) (org-region-active-p))]
17589 ["Which Column?" org-table-current-column (org-at-table-p)])
17590 ["Debug Formulas"
17591 org-table-toggle-formula-debugger
17592 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
17593 ["Show Col/Row Numbers"
17594 org-table-toggle-coordinate-overlays
17595 :style toggle
17596 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
17597 "--"
17598 ["Create" org-table-create (and (not (org-at-table-p))
17599 org-enable-table-editor)]
17600 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
17601 ["Import from File" org-table-import (not (org-at-table-p))]
17602 ["Export to File" org-table-export (org-at-table-p)]
17603 "--"
17604 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
17606 (easy-menu-define org-org-menu org-mode-map "Org menu"
17607 '("Org"
17608 ("Show/Hide"
17609 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
17610 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
17611 ["Sparse Tree..." org-sparse-tree t]
17612 ["Reveal Context" org-reveal t]
17613 ["Show All" show-all t]
17614 "--"
17615 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
17616 "--"
17617 ["New Heading" org-insert-heading t]
17618 ("Navigate Headings"
17619 ["Up" outline-up-heading t]
17620 ["Next" outline-next-visible-heading t]
17621 ["Previous" outline-previous-visible-heading t]
17622 ["Next Same Level" outline-forward-same-level t]
17623 ["Previous Same Level" outline-backward-same-level t]
17624 "--"
17625 ["Jump" org-goto t])
17626 ("Edit Structure"
17627 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
17628 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
17629 "--"
17630 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
17631 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
17632 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
17633 "--"
17634 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
17635 "--"
17636 ["Promote Heading" org-metaleft (not (org-at-table-p))]
17637 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
17638 ["Demote Heading" org-metaright (not (org-at-table-p))]
17639 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
17640 "--"
17641 ["Sort Region/Children" org-sort (not (org-at-table-p))]
17642 "--"
17643 ["Convert to odd levels" org-convert-to-odd-levels t]
17644 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
17645 ("Editing"
17646 ["Emphasis..." org-emphasize t]
17647 ["Edit Source Example" org-edit-special t]
17648 "--"
17649 ["Footnote new/jump" org-footnote-action t]
17650 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
17651 ("Archive"
17652 ["Archive (default method)" org-archive-subtree-default t]
17653 "--"
17654 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
17655 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
17656 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
17657 )
17658 "--"
17659 ("Hyperlinks"
17660 ["Store Link (Global)" org-store-link t]
17661 ["Find existing link to here" org-occur-link-in-agenda-files t]
17662 ["Insert Link" org-insert-link t]
17663 ["Follow Link" org-open-at-point t]
17664 "--"
17665 ["Next link" org-next-link t]
17666 ["Previous link" org-previous-link t]
17667 "--"
17668 ["Descriptive Links"
17669 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
17670 :style radio
17671 :selected (member '(org-link) buffer-invisibility-spec)]
17672 ["Literal Links"
17673 (progn
17674 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
17675 :style radio
17676 :selected (not (member '(org-link) buffer-invisibility-spec))])
17677 "--"
17678 ("TODO Lists"
17679 ["TODO/DONE/-" org-todo t]
17680 ("Select keyword"
17681 ["Next keyword" org-shiftright (org-on-heading-p)]
17682 ["Previous keyword" org-shiftleft (org-on-heading-p)]
17683 ["Complete Keyword" org-complete (assq :todo-keyword (org-context))]
17684 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
17685 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
17686 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
17687 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
17688 "--"
17689 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
17690 :selected org-enforce-todo-dependencies :style toggle :active t]
17691 "Settings for tree at point"
17692 ["Do Children sequentially" org-toggle-ordered-property :style radio
17693 :selected (ignore-errors (org-entry-get nil "ORDERED"))
17694 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17695 ["Do Children parallel" org-toggle-ordered-property :style radio
17696 :selected (ignore-errors (not (org-entry-get nil "ORDERED")))
17697 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
17698 "--"
17699 ["Set Priority" org-priority t]
17700 ["Priority Up" org-shiftup t]
17701 ["Priority Down" org-shiftdown t]
17702 "--"
17703 ["Get news from all feeds" org-feed-update-all t]
17704 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
17705 ["Customize feeds" (customize-variable 'org-feed-alist) t])
17706 ("TAGS and Properties"
17707 ["Set Tags" org-set-tags-command t]
17708 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
17709 "--"
17710 ["Set property" org-set-property t]
17711 ["Column view of properties" org-columns t]
17712 ["Insert Column View DBlock" org-insert-columns-dblock t])
17713 ("Dates and Scheduling"
17714 ["Timestamp" org-time-stamp t]
17715 ["Timestamp (inactive)" org-time-stamp-inactive t]
17716 ("Change Date"
17717 ["1 Day Later" org-shiftright t]
17718 ["1 Day Earlier" org-shiftleft t]
17719 ["1 ... Later" org-shiftup t]
17720 ["1 ... Earlier" org-shiftdown t])
17721 ["Compute Time Range" org-evaluate-time-range t]
17722 ["Schedule Item" org-schedule t]
17723 ["Deadline" org-deadline t]
17724 "--"
17725 ["Custom time format" org-toggle-time-stamp-overlays
17726 :style radio :selected org-display-custom-times]
17727 "--"
17728 ["Goto Calendar" org-goto-calendar t]
17729 ["Date from Calendar" org-date-from-calendar t]
17730 "--"
17731 ["Start/Restart Timer" org-timer-start t]
17732 ["Pause/Continue Timer" org-timer-pause-or-continue t]
17733 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
17734 ["Insert Timer String" org-timer t]
17735 ["Insert Timer Item" org-timer-item t])
17736 ("Logging work"
17737 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
17738 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
17739 ["Clock out" org-clock-out t]
17740 ["Clock cancel" org-clock-cancel t]
17741 "--"
17742 ["Mark as default task" org-clock-mark-default-task t]
17743 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
17744 ["Goto running clock" org-clock-goto t]
17745 "--"
17746 ["Display times" org-clock-display t]
17747 ["Create clock table" org-clock-report t]
17748 "--"
17749 ["Record DONE time"
17750 (progn (setq org-log-done (not org-log-done))
17751 (message "Switching to %s will %s record a timestamp"
17752 (car org-done-keywords)
17753 (if org-log-done "automatically" "not")))
17754 :style toggle :selected org-log-done])
17755 "--"
17756 ["Agenda Command..." org-agenda t]
17757 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
17758 ("File List for Agenda")
17759 ("Special views current file"
17760 ["TODO Tree" org-show-todo-tree t]
17761 ["Check Deadlines" org-check-deadlines t]
17762 ["Timeline" org-timeline t]
17763 ["Tags/Property tree" org-match-sparse-tree t])
17764 "--"
17765 ["Export/Publish..." org-export t]
17766 ("LaTeX"
17767 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
17768 :selected org-cdlatex-mode]
17769 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
17770 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
17771 ["Modify math symbol" org-cdlatex-math-modify
17772 (org-inside-LaTeX-fragment-p)]
17773 ["Insert citation" org-reftex-citation t]
17774 "--"
17775 ["Template for BEAMER" org-insert-beamer-options-template t])
17776 "--"
17777 ("MobileOrg"
17778 ["Push Files and Views" org-mobile-push t]
17779 ["Get Captured and Flagged" org-mobile-pull t]
17780 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
17781 "--"
17782 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
17783 "--"
17784 ("Documentation"
17785 ["Show Version" org-version t]
17786 ["Info Documentation" org-info t])
17787 ("Customize"
17788 ["Browse Org Group" org-customize t]
17789 "--"
17790 ["Expand This Menu" org-create-customize-menu
17791 (fboundp 'customize-menu-create)])
17792 ["Send bug report" org-submit-bug-report t]
17793 "--"
17794 ("Refresh/Reload"
17795 ["Refresh setup current buffer" org-mode-restart t]
17796 ["Reload Org (after update)" org-reload t]
17797 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
17798 ))
17800 (defun org-info (&optional node)
17801 "Read documentation for Org-mode in the info system.
17802 With optional NODE, go directly to that node."
17803 (interactive)
17804 (info (format "(org)%s" (or node ""))))
17806 ;;;###autoload
17807 (defun org-submit-bug-report ()
17808 "Submit a bug report on Org-mode via mail.
17810 Don't hesitate to report any problems or inaccurate documentation.
17812 If you don't have setup sending mail from (X)Emacs, please copy the
17813 output buffer into your mail program, as it gives us important
17814 information about your Org-mode version and configuration."
17815 (interactive)
17816 (require 'reporter)
17817 (org-load-modules-maybe)
17818 (org-require-autoloaded-modules)
17819 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
17820 (reporter-submit-bug-report
17821 "emacs-orgmode@gnu.org"
17822 (org-version)
17823 (let (list)
17824 (save-window-excursion
17825 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
17826 (delete-other-windows)
17827 (erase-buffer)
17828 (insert "You are about to submit a bug report to the Org-mode mailing list.
17830 We would like to add your full Org-mode and Outline configuration to the
17831 bug report. This greatly simplifies the work of the maintainer and
17832 other experts on the mailing list.
17834 HOWEVER, some variables you have customized may contain private
17835 information. The names of customers, colleagues, or friends, might
17836 appear in the form of file names, tags, todo states, or search strings.
17837 If you answer yes to the prompt, you might want to check and remove
17838 such private information before sending the email.")
17839 (add-text-properties (point-min) (point-max) '(face org-warning))
17840 (when (yes-or-no-p "Include your Org-mode configuration ")
17841 (mapatoms
17842 (lambda (v)
17843 (and (boundp v)
17845 (or (and (symbol-value v)
17847 (and
17848 (get v 'custom-type) (get v 'standard-value)
17849 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
17850 (push v list)))))
17851 (kill-buffer (get-buffer "*Warn about privacy*"))
17852 list))
17853 nil nil
17854 "Remember to cover the basics, that is, what you expected to happen and
17855 what in fact did happen. You don't know how to make a good report? See
17857 http://orgmode.org/manual/Feedback.html#Feedback
17859 Your bug report will be posted to the Org-mode mailing list.
17860 ------------------------------------------------------------------------")
17861 (save-excursion
17866 (defun org-install-agenda-files-menu ()
17867 (let ((bl (buffer-list)))
17868 (save-excursion
17869 (while bl
17870 (set-buffer (pop bl))
17871 (if (org-mode-p) (setq bl nil)))
17872 (when (org-mode-p)
17873 (easy-menu-change
17874 '("Org") "File List for Agenda"
17875 (append
17876 (list
17877 ["Edit File List" (org-edit-agenda-file-list) t]
17878 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
17879 ["Remove Current File from List" org-remove-file t]
17880 ["Cycle through agenda files" org-cycle-agenda-files t]
17881 ["Occur in all agenda files" org-occur-in-agenda-files t]
17882 "--")
17883 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
17885 ;;;; Documentation
17887 ;;;###autoload
17888 (defun org-require-autoloaded-modules ()
17889 (interactive)
17890 (mapc 'require
17891 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
17892 org-docbook org-exp org-html org-icalendar
17893 org-id org-latex
17894 org-publish org-remember org-table
17895 org-timer org-xoxo)))
17897 ;;;###autoload
17898 (defun org-reload (&optional uncompiled)
17899 "Reload all org lisp files.
17900 With prefix arg UNCOMPILED, load the uncompiled versions."
17901 (interactive "P")
17902 (require 'find-func)
17904 (dir-org (file-name-directory (org-find-library-name "org")))
17905 (dir-org-contrib (ignore-errors
17906 (file-name-directory
17907 (org-find-library-name "org-contribdir"))))
17908 (babel-files
17909 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
17910 (append (list nil "comint" "eval" "exp" "keys"
17911 "lob" "ref" "table" "tangle")
17912 (delq nil
17913 (mapcar
17914 (lambda (lang)
17915 (when (cdr lang) (symbol-name (car lang))))
17916 org-babel-load-languages)))))
17917 (files
17918 (append (directory-files dir-org t file-re)
17919 babel-files
17920 (and dir-org-contrib
17921 (directory-files dir-org-contrib t file-re))))
17922 (remove-re (concat (if (featurep 'xemacs)
17923 "org-colview" "org-colview-xemacs")
17925 (setq files (mapcar 'file-name-sans-extension files))
17926 (setq files (mapcar
17927 (lambda (x) (if (string-match remove-re x) nil x))
17928 files))
17929 (setq files (delq nil files))
17930 (mapc
17931 (lambda (f)
17932 (when (featurep (intern (file-name-nondirectory f)))
17933 (if (and (not uncompiled)
17934 (file-exists-p (concat f ".elc")))
17935 (load (concat f ".elc") nil nil t)
17936 (load (concat f ".el") nil nil t))))
17937 files))
17938 (org-version))
17940 ;;;###autoload
17941 (defun org-customize ()
17942 "Call the customize function with org as argument."
17943 (interactive)
17944 (org-load-modules-maybe)
17945 (org-require-autoloaded-modules)
17946 (customize-browse 'org))
17948 (defun org-create-customize-menu ()
17949 "Create a full customization menu for Org-mode, insert it into the menu."
17950 (interactive)
17951 (org-load-modules-maybe)
17952 (org-require-autoloaded-modules)
17953 (if (fboundp 'customize-menu-create)
17954 (progn
17955 (easy-menu-change
17956 '("Org") "Customize"
17957 `(["Browse Org group" org-customize t]
17958 "--"
17959 ,(customize-menu-create 'org)
17960 ["Set" Custom-set t]
17961 ["Save" Custom-save t]
17962 ["Reset to Current" Custom-reset-current t]
17963 ["Reset to Saved" Custom-reset-saved t]
17964 ["Reset to Standard Settings" Custom-reset-standard t]))
17966 (error "Cannot expand menu (outdated version of cus-edit.el)")))
17968 ;;;; Miscellaneous stuff
17970 ;;; Generally useful functions
17972 (defun org-get-at-bol (property)
17973 "Get text property PROPERTY at beginning of line."
17974 (get-text-property (point-at-bol) property))
17976 (defun org-find-text-property-in-string (prop s)
17977 "Return the first non-nil value of property PROP in string S."
17978 (or (get-text-property 0 prop s)
17979 (get-text-property (or (next-single-property-change 0 prop s) 0)
17980 prop s)))
17982 (defun org-display-warning (message) ;; Copied from Emacs-Muse
17983 "Display the given MESSAGE as a warning."
17984 (if (fboundp 'display-warning)
17985 (display-warning 'org message
17986 (if (featurep 'xemacs) 'warning :warning))
17987 (let ((buf (get-buffer-create "*Org warnings*")))
17988 (with-current-buffer buf
17989 (goto-char (point-max))
17990 (insert "Warning (Org): " message)
17991 (unless (bolp)
17992 (newline)))
17993 (display-buffer buf)
17994 (sit-for 0))))
17996 (defun org-in-commented-line ()
17997 "Is point in a line starting with `#'?"
17998 (equal (char-after (point-at-bol)) ?#))
18000 (defun org-in-indented-comment-line ()
18001 "Is point in a line starting with `#' after some white space?"
18002 (save-excursion
18003 (save-match-data
18004 (goto-char (point-at-bol))
18007 (defun org-in-verbatim-emphasis ()
18008 (save-match-data
18009 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18011 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18012 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18013 (if (and marker (marker-buffer marker)
18014 (buffer-live-p (marker-buffer marker)))
18015 (progn
18016 (switch-to-buffer (marker-buffer marker))
18017 (if (or (> marker (point-max)) (< marker (point-min)))
18018 (widen))
18019 (goto-char marker)
18020 (org-show-context 'org-goto))
18021 (if bookmark
18022 (bookmark-jump bookmark)
18023 (error "Cannot find location"))))
18025 (defun org-quote-csv-field (s)
18026 "Quote field for inclusion in CSV material."
18029 s))
18031 (defun org-plist-delete (plist property)
18032 "Delete PROPERTY from PLIST.
18033 This is in contrast to merely setting it to 0."
18034 (let (p)
18035 (while plist
18036 (if (not (eq property (car plist)))
18037 (setq p (plist-put p (car plist) (nth 1 plist))))
18038 (setq plist (cddr plist)))
18039 p))
18041 (defun org-force-self-insert (N)
18042 "Needed to enforce self-insert under remapping."
18043 (interactive "p")
18044 (self-insert-command N))
18046 (defun org-string-width (s)
18047 "Compute width of string, ignoring invisible characters.
18048 This ignores character with invisibility property `org-link', and also
18049 characters with property `org-cwidth', because these will become invisible
18050 upon the next fontification round."
18051 (let (b l)
18052 (when (or (eq t buffer-invisibility-spec)
18053 (assq 'org-link buffer-invisibility-spec))
18054 (while (setq b (text-property-any 0 (length s)
18055 'invisible 'org-link s))
18056 (setq s (concat (substring s 0 b)
18057 (substring s (or (next-single-property-change
18058 b 'invisible s) (length s)))))))
18059 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18060 (setq s (concat (substring s 0 b)
18061 (substring s (or (next-single-property-change
18062 b 'org-cwidth s) (length s))))))
18063 (setq l (string-width s) b -1)
18064 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18065 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18066 l))
18068 (defun org-get-indentation (&optional line)
18069 "Get the indentation of the current line, interpreting tabs.
18070 When LINE is given, assume it represents a line and compute its indentation."
18071 (if line
18072 (if (string-match "^ *" (org-remove-tabs line))
18073 (match-end 0))
18074 (save-excursion
18075 (beginning-of-line 1)
18077 (current-column))))
18079 (defun org-remove-tabs (s &optional width)
18080 "Replace tabulators in S with spaces.
18081 Assumes that s is a single line, starting in column 0."
18082 (setq width (or width tab-width))
18084 (setq s (replace-match
18085 (make-string
18086 (- (* width (/ (+ (match-beginning 0) width) width))
18087 (match-beginning 0)) ?\ )
18088 t t s)))
18089 s)
18091 (defun org-fix-indentation (line ind)
18092 "Fix indentation in LINE.
18093 IND is a cons cell with target and minimum indentation.
18094 If the current indentation in LINE is smaller than the minimum,
18095 leave it alone. If it is larger than ind, set it to the target."
18096 (let* ((l (org-remove-tabs line))
18097 (i (org-get-indentation l))
18098 (i1 (car ind)) (i2 (cdr ind)))
18099 (if (>= i i2) (setq l (substring line i2)))
18100 (if (> i1 0)
18101 (concat (make-string i1 ?\ ) l)
18102 l)))
18104 (defun org-remove-indentation (code &optional n)
18105 "Remove the maximum common indentation from the lines in CODE.
18106 N may optionally be the number of spaces to remove."
18107 (with-temp-buffer
18108 (insert code)
18109 (org-do-remove-indentation n)
18110 (buffer-string)))
18112 (defun org-do-remove-indentation (&optional n)
18113 "Remove the maximum common indentation from the buffer."
18114 (untabify (point-min) (point-max))
18115 (let ((min 10000) re)
18116 (if n
18117 (setq min n)
18118 (goto-char (point-min))
18120 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18121 (unless (or (= min 0) (= min 10000))
18123 (goto-char (point-min))
18124 (while (re-search-forward re nil t)
18125 (replace-match "")
18126 (end-of-line 1))
18127 min)))
18129 (defun org-fill-template (template alist)
18130 "Find each %key of ALIST in TEMPLATE and replace it."
18131 (let ((case-fold-search nil)
18132 entry key value)
18133 (setq alist (sort (copy-sequence alist)
18134 (lambda (a b) (< (length (car a)) (length (car b))))))
18135 (while (setq entry (pop alist))
18136 (setq template
18137 (replace-regexp-in-string
18138 (concat "%" (regexp-quote (car entry)))
18139 (cdr entry) template t t)))
18140 template))
18142 (defun org-base-buffer (buffer)
18143 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18144 (if (not buffer)
18145 buffer
18146 (or (buffer-base-buffer buffer)
18147 buffer)))
18149 (defun org-trim (s)
18150 "Remove whitespace at beginning and end of string."
18153 s)
18155 (defun org-wrap (string &optional width lines)
18156 "Wrap string to either a number of lines, or a width in characters.
18157 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18158 that costs. If there is a word longer than WIDTH, the text is actually
18159 wrapped to the length of that word.
18160 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18161 many lines, whatever width that takes.
18162 The return value is a list of lines, without newlines at the end."
18164 (maxword (apply 'max (mapcar 'org-string-width words)))
18165 w ll)
18166 (cond (width
18167 (org-do-wrap words (max maxword width)))
18168 (lines
18169 (setq w maxword)
18170 (setq ll (org-do-wrap words maxword))
18171 (if (<= (length ll) lines)
18172 ll
18173 (setq ll words)
18174 (while (> (length ll) lines)
18175 (setq w (1+ w))
18176 (setq ll (org-do-wrap words w)))
18177 ll))
18178 (t (error "Cannot wrap this")))))
18180 (defun org-do-wrap (words width)
18181 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18182 (let (lines line)
18183 (while words
18184 (setq line (pop words))
18185 (while (and words (< (+ (length line) (length (car words))) width))
18186 (setq line (concat line " " (pop words))))
18187 (setq lines (push line lines)))
18188 (nreverse lines)))
18190 (defun org-split-string (string &optional separators)
18191 "Splits STRING into substrings at SEPARATORS.
18192 No empty strings are returned if there are matches at the beginning
18193 and end of string."
18195 (start 0)
18196 notfirst
18197 (list nil))
18198 (while (and (string-match rexp string
18199 (if (and notfirst
18200 (= start (match-beginning 0))
18201 (< start (length string)))
18202 (1+ start) start))
18203 (< (match-beginning 0) (length string)))
18204 (setq notfirst t)
18205 (or (eq (match-beginning 0) 0)
18206 (and (eq (match-beginning 0) (match-end 0))
18207 (eq (match-beginning 0) start))
18208 (setq list
18209 (cons (substring string start (match-beginning 0))
18210 list)))
18211 (setq start (match-end 0)))
18212 (or (eq start (length string))
18213 (setq list
18214 (cons (substring string start)
18215 list)))
18216 (nreverse list)))
18218 (defun org-quote-vert (s)
18220 (while (string-match "|" s)
18222 s)
18224 (defun org-uuidgen-p (s)
18225 "Is S an ID created by UUIDGEN?"
18226 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18228 (defun org-context ()
18229 "Return a list of contexts of the current cursor position.
18230 If several contexts apply, all are returned.
18231 Each context entry is a list with a symbol naming the context, and
18232 two positions indicating start and end of the context. Possible
18233 contexts are:
18235 :headline anywhere in a headline
18236 :headline-stars on the leading stars in a headline
18237 :todo-keyword on a TODO keyword (including DONE) in a headline
18238 :tags on the TAGS in a headline
18239 :priority on the priority cookie in a headline
18240 :item on the first line of a plain list item
18241 :item-bullet on the bullet/number of a plain list item
18242 :checkbox on the checkbox in a plain list item
18243 :table in an org-mode table
18244 :table-special on a special filed in a table
18245 :table-table in a table.el table
18246 :link on a hyperlink
18247 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18248 :target on a <<target>>
18249 :radio-target on a <<<radio-target>>>
18250 :latex-fragment on a LaTeX fragment
18251 :latex-preview on a LaTeX fragment with overlayed preview image
18253 This function expects the position to be visible because it uses font-lock
18254 faces as a help to recognize the following contexts: :table-special, :link,
18255 and :keyword."
18256 (let* ((f (get-text-property (point) 'face))
18257 (faces (if (listp f) f (list f)))
18258 (p (point)) clist o)
18259 ;; First the large context
18260 (cond
18261 ((org-on-heading-p t)
18262 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18263 (when (progn
18264 (beginning-of-line 1)
18265 (looking-at org-todo-line-tags-regexp))
18266 (push (org-point-in-group p 1 :headline-stars) clist)
18267 (push (org-point-in-group p 2 :todo-keyword) clist)
18268 (push (org-point-in-group p 4 :tags) clist))
18269 (goto-char p)
18272 (push (org-point-in-group p 0 :priority) clist)))
18274 ((org-at-item-p)
18275 (push (org-point-in-group p 2 :item-bullet) clist)
18276 (push (list :item (point-at-bol)
18277 (save-excursion (org-end-of-item) (point)))
18278 clist)
18279 (and (org-at-item-checkbox-p)
18280 (push (org-point-in-group p 0 :checkbox) clist)))
18282 ((org-at-table-p)
18283 (push (list :table (org-table-begin) (org-table-end)) clist)
18284 (if (memq 'org-formula faces)
18285 (push (list :table-special
18286 (previous-single-property-change p 'face)
18287 (next-single-property-change p 'face)) clist)))
18288 ((org-at-table-p 'any)
18289 (push (list :table-table) clist)))
18290 (goto-char p)
18292 ;; Now the small context
18293 (cond
18294 ((org-at-timestamp-p)
18295 (push (org-point-in-group p 0 :timestamp) clist))
18296 ((memq 'org-link faces)
18297 (push (list :link
18298 (previous-single-property-change p 'face)
18299 (next-single-property-change p 'face)) clist))
18300 ((memq 'org-special-keyword faces)
18301 (push (list :keyword
18302 (previous-single-property-change p 'face)
18303 (next-single-property-change p 'face)) clist))
18304 ((org-on-target-p)
18305 (push (org-point-in-group p 0 :target) clist)
18306 (goto-char (1- (match-beginning 0)))
18307 (if (looking-at org-radio-target-regexp)
18308 (push (org-point-in-group p 0 :radio-target) clist))
18309 (goto-char p))
18310 ((setq o (car (delq nil
18311 (mapcar
18312 (lambda (x)
18313 (if (memq x org-latex-fragment-image-overlays) x))
18314 (overlays-at (point))))))
18315 (push (list :latex-fragment
18316 (overlay-start o) (overlay-end o)) clist)
18317 (push (list :latex-preview
18318 (overlay-start o) (overlay-end o)) clist))
18319 ((org-inside-LaTeX-fragment-p)
18320 ;; FIXME: positions wrong.
18321 (push (list :latex-fragment (point) (point)) clist)))
18323 (setq clist (nreverse (delq nil clist)))
18324 clist))
18326 ;; FIXME: Compare with at-regexp-p Do we need both?
18327 (defun org-in-regexp (re &optional nlines visually)
18328 "Check if point is inside a match of regexp.
18329 Normally only the current line is checked, but you can include NLINES extra
18330 lines both before and after point into the search.
18331 If VISUALLY is set, require that the cursor is not after the match but
18332 really on, so that the block visually is on the match."
18333 (catch 'exit
18334 (let ((pos (point))
18335 (eol (point-at-eol (+ 1 (or nlines 0))))
18336 (inc (if visually 1 0)))
18337 (save-excursion
18338 (beginning-of-line (- 1 (or nlines 0)))
18339 (while (re-search-forward re eol t)
18340 (if (and (<= (match-beginning 0) pos)
18341 (>= (+ inc (match-end 0)) pos))
18342 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18344 (defun org-at-regexp-p (regexp)
18345 "Is point inside a match of REGEXP in the current line?"
18346 (catch 'exit
18347 (save-excursion
18348 (let ((pos (point)) (end (point-at-eol)))
18349 (beginning-of-line 1)
18350 (while (re-search-forward regexp end t)
18351 (if (and (<= (match-beginning 0) pos)
18352 (>= (match-end 0) pos))
18353 (throw 'exit t)))
18354 nil))))
18356 (defun org-in-regexps-block-p (start-re end-re &optional bound)
18357 "Return t if the current point is between matches of START-RE and END-RE.
18358 This will also return t if point is on one of the two matches or
18359 in an unfinished block. END-RE can be a string or a form
18360 returning a string.
18362 An optional third argument bounds the search for START-RE. It
18363 defaults to previous heading or `point-min'."
18364 (let ((pos (point))
18365 (limit (or bound (save-excursion (outline-previous-heading)))))
18366 (save-excursion
18367 ;; we're on a block when point is on start-re...
18368 (or (org-at-regexp-p start-re)
18369 ;; ... or start-re can be found above...
18370 (and (re-search-backward start-re limit t)
18371 ;; ... but no end-re between start-re and point.
18372 (not (re-search-forward (eval end-re) pos t)))))))
18374 (defun org-occur-in-agenda-files (regexp &optional nlines)
18375 "Call `multi-occur' with buffers for all agenda files."
18377 (let* ((files (org-agenda-files))
18378 (tnames (mapcar 'file-truename files))
18379 (extra org-agenda-text-search-extra-files)
18380 f)
18381 (when (eq (car extra) 'agenda-archives)
18382 (setq extra (cdr extra))
18383 (setq files (org-add-archive-files files)))
18384 (while (setq f (pop extra))
18385 (unless (member (file-truename f) tnames)
18386 (add-to-list 'files f 'append)
18387 (add-to-list 'tnames (file-truename f) 'append)))
18388 (multi-occur
18389 (mapcar (lambda (x)
18390 (with-current-buffer
18391 (or (get-file-buffer x) (find-file-noselect x))
18392 (widen)
18393 (current-buffer)))
18394 files)
18395 regexp)))
18397 (if (boundp 'occur-mode-find-occurrence-hook)
18398 ;; Emacs 23
18399 (add-hook 'occur-mode-find-occurrence-hook
18400 (lambda ()
18401 (when (org-mode-p)
18402 (org-reveal))))
18403 ;; Emacs 22
18404 (defadvice occur-mode-goto-occurrence
18405 (after org-occur-reveal activate)
18406 (and (org-mode-p) (org-reveal)))
18407 (defadvice occur-mode-goto-occurrence-other-window
18408 (after org-occur-reveal activate)
18409 (and (org-mode-p) (org-reveal)))
18410 (defadvice occur-mode-display-occurrence
18411 (after org-occur-reveal activate)
18412 (when (org-mode-p)
18413 (let ((pos (occur-mode-find-occurrence)))
18414 (with-current-buffer (marker-buffer pos)
18415 (save-excursion
18416 (goto-char pos)
18417 (org-reveal)))))))
18419 (defun org-occur-link-in-agenda-files ()
18420 "Create a link and search for it in the agendas.
18421 The link is not stored in `org-stored-links', it is just created
18422 for the search purpose."
18423 (interactive)
18424 (let ((link (condition-case nil
18425 (org-store-link nil)
18426 (error "Unable to create a link to here"))))
18427 (org-occur-in-agenda-files (regexp-quote link))))
18429 (defun org-uniquify (list)
18430 "Remove duplicate elements from LIST."
18431 (let (res)
18432 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
18433 res))
18435 (defun org-delete-all (elts list)
18436 "Remove all elements in ELTS from LIST."
18437 (while elts
18438 (setq list (delete (pop elts) list)))
18439 list)
18441 (defun org-count (cl-item cl-seq)
18442 "Count the number of occurrences of ITEM in SEQ.
18443 Taken from `count' in cl-seq.el with all keyword arguments removed."
18444 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
18445 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
18446 (while (< cl-start cl-end)
18447 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
18448 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
18449 (setq cl-start (1+ cl-start)))
18450 cl-count))
18452 (defun org-remove-if (predicate seq)
18453 "Remove everything from SEQ that fulfills PREDICATE."
18454 (let (res e)
18455 (while seq
18456 (setq e (pop seq))
18457 (if (not (funcall predicate e)) (push e res)))
18458 (nreverse res)))
18460 (defun org-remove-if-not (predicate seq)
18461 "Remove everything from SEQ that does not fulfill PREDICATE."
18462 (let (res e)
18463 (while seq
18464 (setq e (pop seq))
18465 (if (funcall predicate e) (push e res)))
18466 (nreverse res)))
18468 (defun org-back-over-empty-lines ()
18469 "Move backwards over whitespace, to the beginning of the first empty line.
18470 Returns the number of empty lines passed."
18471 (let ((pos (point)))
18473 (beginning-of-line 2)
18474 (goto-char (min (point) pos))
18475 (count-lines (point) pos)))
18477 (defun org-skip-whitespace ()
18480 (defun org-point-in-group (point group &optional context)
18481 "Check if POINT is in match-group GROUP.
18482 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18483 match. If the match group does not exist or point is not inside it,
18484 return nil."
18485 (and (match-beginning group)
18486 (>= point (match-beginning group))
18487 (<= point (match-end group))
18488 (if context
18489 (list context (match-beginning group) (match-end group))
18490 t)))
18492 (defun org-switch-to-buffer-other-window (&rest args)
18493 "Switch to buffer in a second window on the current frame.
18494 In particular, do not allow pop-up frames.
18495 Returns the newly created buffer."
18496 (let (pop-up-frames special-display-buffer-names special-display-regexps
18497 special-display-function)
18498 (apply 'switch-to-buffer-other-window args)))
18500 (defun org-combine-plists (&rest plists)
18501 "Create a single property list from all plists in PLISTS.
18502 The process starts by copying the first list, and then setting properties
18503 from the other lists. Settings in the last list are the most significant
18504 ones and overrule settings in the other lists."
18505 (let ((rtn (copy-sequence (pop plists)))
18506 p v ls)
18507 (while plists
18508 (setq ls (pop plists))
18509 (while ls
18510 (setq p (pop ls) v (pop ls))
18511 (setq rtn (plist-put rtn p v))))
18512 rtn))
18514 (defun org-move-line-down (arg)
18515 "Move the current line down. With prefix argument, move it past ARG lines."
18516 (interactive "p")
18517 (let ((col (current-column))
18518 beg end pos)
18519 (beginning-of-line 1) (setq beg (point))
18520 (beginning-of-line 2) (setq end (point))
18521 (beginning-of-line (+ 1 arg))
18522 (setq pos (move-marker (make-marker) (point)))
18523 (insert (delete-and-extract-region beg end))
18524 (goto-char pos)
18525 (org-move-to-column col)))
18527 (defun org-move-line-up (arg)
18528 "Move the current line up. With prefix argument, move it past ARG lines."
18529 (interactive "p")
18530 (let ((col (current-column))
18531 beg end pos)
18532 (beginning-of-line 1) (setq beg (point))
18533 (beginning-of-line 2) (setq end (point))
18534 (beginning-of-line (- arg))
18535 (setq pos (move-marker (make-marker) (point)))
18536 (insert (delete-and-extract-region beg end))
18537 (goto-char pos)
18538 (org-move-to-column col)))
18540 (defun org-replace-escapes (string table)
18541 "Replace %-escapes in STRING with values in TABLE.
18543 The sequences in STRING may contain normal field width and padding information,
18545 so values can contain further %-escapes if they are define later in TABLE."
18546 (let ((tbl (copy-alist table))
18547 (case-fold-search nil)
18548 (pchg 0)
18549 e re rpl)
18550 (while (setq e (pop tbl))
18551 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
18552 (when (and (cdr e) (string-match re (cdr e)))
18553 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
18554 (safe "SREF"))
18555 (add-text-properties 0 3 (list 'sref sref) safe)
18556 (setcdr e (replace-match safe t t (cdr e)))))
18557 (while (string-match re string)
18558 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
18559 (cdr e)))
18560 (setq string (replace-match rpl t t string))))
18561 (while (setq pchg (next-property-change pchg string))
18562 (let ((sref (get-text-property pchg 'sref string)))
18563 (when (and sref (string-match "SREF" string pchg))
18564 (setq string (replace-match sref t t string)))))
18565 string))
18567 (defun org-sublist (list start end)
18568 "Return a section of LIST, from START to END.
18569 Counting starts at 1."
18570 (let (rtn (c start))
18571 (setq list (nthcdr (1- start) list))
18572 (while (and list (<= c end))
18573 (push (pop list) rtn)
18574 (setq c (1+ c)))
18575 (nreverse rtn)))
18577 (defun org-find-base-buffer-visiting (file)
18578 "Like `find-buffer-visiting' but always return the base buffer and
18579 not an indirect buffer."
18580 (let ((buf (or (get-file-buffer file)
18581 (find-buffer-visiting file))))
18582 (if buf
18583 (or (buffer-base-buffer buf) buf)
18584 nil)))
18586 (defun org-image-file-name-regexp (&optional extensions)
18587 "Return regexp matching the file names of images.
18588 If EXTENSIONS is given, only match these."
18589 (if (and (not extensions) (fboundp 'image-file-name-regexp))
18590 (image-file-name-regexp)
18591 (let ((image-file-name-extensions
18592 (or extensions
18593 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
18594 "xbm" "xpm" "pbm" "pgm" "ppm"))))
18596 (regexp-opt (nconc (mapcar 'upcase
18597 image-file-name-extensions)
18598 image-file-name-extensions)
18599 t)
18602 (defun org-file-image-p (file &optional extensions)
18603 "Return non-nil if FILE is an image."
18604 (save-match-data
18605 (string-match (org-image-file-name-regexp extensions) file)))
18607 (defun org-get-cursor-date ()
18608 "Return the date at cursor in as a time.
18609 This works in the calendar and in the agenda, anywhere else it just
18610 returns the current time."
18611 (let (date day defd)
18612 (cond
18613 ((eq major-mode 'calendar-mode)
18614 (setq date (calendar-cursor-to-date)
18615 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
18616 ((eq major-mode 'org-agenda-mode)
18617 (setq day (get-text-property (point) 'day))
18618 (if day
18619 (setq date (calendar-gregorian-from-absolute day)
18620 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
18621 (nth 2 date))))))
18622 (or defd (current-time))))
18624 (defvar org-agenda-action-marker (make-marker)
18625 "Marker pointing to the entry for the next agenda action.")
18627 (defun org-mark-entry-for-agenda-action ()
18628 "Mark the current entry as target of an agenda action.
18629 Agenda actions are actions executed from the agenda with the key `k',
18630 which make use of the date at the cursor."
18631 (interactive)
18632 (move-marker org-agenda-action-marker
18633 (save-excursion (org-back-to-heading t) (point))
18634 (current-buffer))
18635 (message
18636 "Entry marked for action; press `k' at desired date in agenda or calendar"))
18638 ;;; Paragraph filling stuff.
18639 ;; We want this to be just right, so use the full arsenal.
18641 (defun org-indent-line-function ()
18642 "Indent line like previous, but further if previous was headline or item."
18643 (interactive)
18644 (let* ((pos (point))
18645 (itemp (org-at-item-p))
18646 (case-fold-search t)
18648 (inline-task-p (and (featurep 'org-inlinetask)
18649 (org-inlinetask-in-task-p)))
18650 column bpos bcol tpos tcol bullet btype bullet-type)
18651 ;; Find the previous relevant line
18652 (beginning-of-line 1)
18653 (cond
18654 ;; Comments
18655 ((looking-at "#") (setq column 0))
18656 ;; Headings
18658 ;; Drawers
18660 (save-excursion (re-search-backward org-drawer-regexp nil t)))
18661 (save-excursion
18662 (goto-char (1- (match-beginning 1)))
18663 (setq column (current-column))))
18664 ;; Special blocks
18666 (save-excursion
18667 (re-search-backward
18669 (setq column (org-get-indentation (match-string 0))))
18672 (save-excursion
18674 (setq column
18675 (if (equal (downcase (match-string 1)) "src")
18676 ;; src blocks: let `org-edit-src-exit' handle them
18677 (org-get-indentation)
18678 (org-get-indentation (match-string 0)))))
18679 ;; Lists
18680 ((org-in-item-p)
18681 (org-beginning-of-item)
18682 (looking-at "[ \t]*\\(\\S-+\\)[ \t]*\\(\\(:?\\[@\\(:?start:\\)?[0-9]+\\][ \t]*\\)?\\[[- X]\\][ \t]*\\|.*? :: \\)?")
18683 (setq bpos (match-beginning 1) tpos (match-end 0)
18684 bcol (progn (goto-char bpos) (current-column))
18685 tcol (progn (goto-char tpos) (current-column))
18686 bullet (match-string 1)
18687 bullet-type (if (string-match "[0-9]" bullet) "n" bullet))
18688 (if (> tcol (+ bcol org-description-max-indent))
18689 (setq tcol (+ bcol 5)))
18690 (if (not itemp)
18691 (setq column tcol)
18692 (beginning-of-line 1)
18693 (goto-char pos)
18695 (progn
18697 (setq bullet (match-string 1)
18698 btype (if (string-match "[0-9]" bullet) "n" bullet))
18699 (setq column (if (equal btype bullet-type) bcol tcol)))
18700 (setq column (org-get-indentation)))))
18701 ;; This line has nothing special, look upside to get a clue about
18702 ;; what to do.
18703 (t
18704 (beginning-of-line 0)
18705 (while (and (not (bobp))
18706 ;; skip comments, verbatim, empty lines, tables,
18707 ;; inline tasks
18709 (and (org-in-item-p) (goto-char (org-list-top-point)))
18710 (and (not inline-task-p)
18711 (featurep 'org-inlinetask)
18712 (org-inlinetask-in-task-p)))
18714 (not (looking-at org-drawer-regexp)))
18715 (beginning-of-line 0))
18716 (cond
18717 ;; There was an heading above.
18719 (if (not org-adapt-indentation)
18720 (setq column 0)
18721 (goto-char (match-end 0))
18722 (setq column (current-column))))
18723 ;; A drawer had started and is unfinished: indent consequently.
18724 ((looking-at org-drawer-regexp)
18725 (goto-char (1- (match-beginning 1)))
18726 (setq column (current-column)))
18727 ;; The drawer had ended: indent like its :END: line.
18729 (goto-char (match-end 1))
18730 (setq column (current-column)))
18731 ;; Else, nothing noticeable found: get indentation and go on.
18732 (t (setq column (org-get-indentation))))))
18733 (goto-char pos)
18734 (if (<= (current-column) (current-indentation))
18735 (org-indent-line-to column)
18736 (save-excursion (org-indent-line-to column)))
18737 (setq column (current-column))
18738 (beginning-of-line 1)
18739 (if (looking-at
18741 (replace-match (concat (match-string 1)
18742 (format org-property-format
18743 (match-string 2) (match-string 3)))
18744 t t))
18745 (org-move-to-column column)))
18747 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
18748 "Variable to store copy of `adaptive-fill-regexp'.
18749 Since `adaptive-fill-regexp' is set to never match, we need to
18750 store a backup of its value before entering `org-mode' so that
18751 the functionality can be provided as a fall-back.")
18753 (defun org-set-autofill-regexps ()
18754 (interactive)
18755 ;; In the paragraph separator we include headlines, because filling
18756 ;; text in a line directly attached to a headline would otherwise
18757 ;; fill the headline as well.
18760 ;; The paragraph starter includes hand-formatted lists.
18761 (org-set-local
18762 'paragraph-start
18763 (concat
18772 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
18773 ;; But only if the user has not turned off tables or fixed-width regions
18774 (org-set-local
18775 'auto-fill-inhibit-regexp
18778 (if (or org-enable-table-editor org-enable-fixed-width-editor)
18779 (concat
18781 (if org-enable-table-editor "|" "")
18782 (if org-enable-fixed-width-editor ":" "")
18783 "]"))))
18784 ;; We use our own fill-paragraph function, to make sure that tables
18785 ;; and fixed-width regions are not wrapped. That function will pass
18786 ;; through to `fill-paragraph' when appropriate.
18787 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
18788 ;; Adaptive filling: To get full control, first make sure that
18789 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
18790 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
18791 (org-set-local 'org-adaptive-fill-regexp-backup
18792 adaptive-fill-regexp))
18794 (org-set-local 'adaptive-fill-function
18795 'org-adaptive-fill-function)
18796 (org-set-local
18797 'align-mode-rules-list
18798 '((org-in-buffer-settings
18800 (modes . '(org-mode))))))
18802 (defun org-fill-paragraph (&optional justify)
18803 "Re-align a table, pass through to fill-paragraph if no table."
18804 (let ((table-p (org-at-table-p))
18805 (table.el-p (org-at-table.el-p)))
18806 (cond ((and (equal (char-after (point-at-bol)) ?*)
18807 (save-excursion (goto-char (point-at-bol))
18808 (looking-at outline-regexp)))
18809 t) ; skip headlines
18810 (table.el-p t) ; skip table.el tables
18811 (table-p (org-table-align) t) ; align org-mode tables
18812 (t nil)))) ; call paragraph-fill
18814 ;; For reference, this is the default value of adaptive-fill-regexp
18817 (defun org-adaptive-fill-function ()
18818 "Return a fill prefix for org-mode files.
18819 In particular, this makes sure hanging paragraphs for hand-formatted lists
18820 work correctly."
18821 (cond
18822 ;; Comment line
18824 (match-string-no-properties 0))
18825 ;; Description list
18827 (save-excursion
18828 (if (> (match-end 1) (+ (match-beginning 1)
18829 org-description-max-indent))
18830 (goto-char (+ (match-beginning 1) 5))
18831 (goto-char (match-end 0)))
18832 (make-string (current-column) ?\ )))
18833 ;; Ordered or unordered list
18835 (save-excursion
18836 (goto-char (match-end 0))
18837 (make-string (current-column) ?\ )))
18838 ;; Other text
18839 ((looking-at org-adaptive-fill-regexp-backup)
18840 (match-string-no-properties 0))))
18842 ;;; Other stuff.
18844 (defun org-toggle-fixed-width-section (arg)
18845 "Toggle the fixed-width export.
18846 If there is no active region, the QUOTE keyword at the current headline is
18847 inserted or removed. When present, it causes the text between this headline
18848 and the next to be exported as fixed-width text, and unmodified.
18849 If there is an active region, this command adds or removes a colon as the
18850 first character of this line. If the first character of a line is a colon,
18851 this line is also exported in fixed-width font."
18852 (interactive "P")
18853 (let* ((cc 0)
18854 (regionp (org-region-active-p))
18855 (beg (if regionp (region-beginning) (point)))
18856 (end (if regionp (region-end)))
18857 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
18858 (case-fold-search nil)
18860 off)
18861 (if regionp
18862 (save-excursion
18863 (goto-char beg)
18864 (setq cc (current-column))
18865 (beginning-of-line 1)
18866 (setq off (looking-at re))
18867 (while (> nlines 0)
18868 (setq nlines (1- nlines))
18869 (beginning-of-line 1)
18870 (cond
18871 (arg
18872 (org-move-to-column cc t)
18874 (forward-line -1))
18875 ((and off (looking-at re))
18876 (replace-match "" t t nil 1))
18877 ((not off) (org-move-to-column cc t) (insert ": ")))
18878 (forward-line 1)))
18879 (save-excursion
18880 (org-back-to-heading)
18881 (if (looking-at (concat outline-regexp
18883 (replace-match "" t t nil 1)
18884 (if (looking-at outline-regexp)
18885 (progn
18886 (goto-char (match-end 0))
18887 (insert org-quote-string " "))))))))
18889 (defun org-reftex-citation ()
18890 "Use reftex-citation to insert a citation into the buffer.
18891 This looks for a line like
18893 #+BIBLIOGRAPHY: foo plain option:-d
18895 and derives from it that foo.bib is the bibliography file relevant
18896 for this document. It then installs the necessary environment for RefTeX
18897 to work in this buffer and calls `reftex-citation' to insert a citation
18898 into the buffer.
18900 Export of such citations to both LaTeX and HTML is handled by the contributed
18901 package org-exp-bibtex by Taru Karttunen."
18902 (interactive)
18903 (let ((reftex-docstruct-symbol 'rds)
18905 rds bib)
18906 (save-excursion
18907 (save-restriction
18908 (widen)
18909 (let ((case-fold-search t)
18911 (if (not (save-excursion
18912 (or (re-search-forward re nil t)
18913 (re-search-backward re nil t))))
18914 (error "No bibliography defined in file")
18915 (setq bib (concat (match-string 1) ".bib")
18916 rds (list (list 'bib bib)))))))
18917 (call-interactively 'reftex-citation)))
18919 ;;;; Functions extending outline functionality
18921 (defun org-beginning-of-line (&optional arg)
18922 "Go to the beginning of the current line. If that is invisible, continue
18923 to a visible line beginning. This makes the function of C-a more intuitive.
18924 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18925 first attempt, and only move to after the tags when the cursor is already
18926 beyond the end of the headline."
18927 (interactive "P")
18928 (let ((pos (point))
18929 (special (if (consp org-special-ctrl-a/e)
18930 (car org-special-ctrl-a/e)
18931 org-special-ctrl-a/e))
18932 refpos)
18933 (if (org-bound-and-true-p line-move-visual)
18934 (beginning-of-visual-line 1)
18935 (beginning-of-line 1))
18936 (if (and arg (fboundp 'move-beginning-of-line))
18937 (call-interactively 'move-beginning-of-line)
18938 (if (bobp)
18939 nil
18940 (backward-char 1)
18941 (if (org-truely-invisible-p)
18942 (while (and (not (bobp)) (org-truely-invisible-p))
18943 (backward-char 1)
18944 (beginning-of-line 1))
18945 (forward-char 1))))
18946 (when special
18947 (cond
18948 ((and (looking-at org-complex-heading-regexp)
18949 (= (char-after (match-end 1)) ?\ ))
18950 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
18951 (point-at-eol)))
18952 (goto-char
18953 (if (eq special t)
18954 (cond ((> pos refpos) refpos)
18955 ((= pos (point)) refpos)
18956 (t (point)))
18957 (cond ((> pos (point)) (point))
18958 ((not (eq last-command this-command)) (point))
18959 (t refpos)))))
18960 ((org-at-item-p)
18961 (goto-char
18962 (if (eq special t)
18963 (cond ((> pos (match-end 4)) (match-end 4))
18964 ((= pos (point)) (match-end 4))
18965 (t (point)))
18966 (cond ((> pos (point)) (point))
18967 ((not (eq last-command this-command)) (point))
18968 (t (match-end 4))))))))
18969 (org-no-warnings
18970 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
18972 (defun org-end-of-line (&optional arg)
18973 "Go to the end of the line.
18974 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
18975 first attempt, and only move to after the tags when the cursor is already
18976 beyond the end of the headline."
18977 (interactive "P")
18978 (let ((special (if (consp org-special-ctrl-a/e)
18979 (cdr org-special-ctrl-a/e)
18980 org-special-ctrl-a/e)))
18981 (if (or (not special)
18982 (not (org-on-heading-p))
18983 arg)
18984 (call-interactively
18985 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
18986 ((fboundp 'move-end-of-line) 'move-end-of-line)
18987 (t 'end-of-line)))
18988 (let ((pos (point)))
18989 (beginning-of-line 1)
18991 (if (eq special t)
18992 (if (or (< pos (match-beginning 1))
18993 (= pos (match-end 0)))
18994 (goto-char (match-beginning 1))
18995 (goto-char (match-end 0)))
18996 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
18997 (goto-char (match-end 0))
18998 (goto-char (match-beginning 1))))
18999 (call-interactively (if (fboundp 'move-end-of-line)
19000 'move-end-of-line
19001 'end-of-line)))))
19002 (org-no-warnings
19003 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19005 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19006 (define-key org-mode-map "\C-e" 'org-end-of-line)
19007 (define-key org-mode-map [home] 'org-beginning-of-line)
19008 (define-key org-mode-map [end] 'org-end-of-line)
19010 (defun org-backward-sentence (&optional arg)
19011 "Go to beginning of sentence, or beginning of table field.
19012 This will call `backward-sentence' or `org-table-beginning-of-field',
19013 depending on context."
19014 (interactive "P")
19015 (cond
19016 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19017 (t (call-interactively 'backward-sentence))))
19019 (defun org-forward-sentence (&optional arg)
19020 "Go to end of sentence, or end of table field.
19021 This will call `forward-sentence' or `org-table-end-of-field',
19022 depending on context."
19023 (interactive "P")
19024 (cond
19025 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19026 (t (call-interactively 'forward-sentence))))
19028 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19029 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19031 (defun org-kill-line (&optional arg)
19032 "Kill line, to tags or end of line."
19033 (interactive "P")
19034 (cond
19035 ((or (not org-special-ctrl-k)
19036 (bolp)
19037 (not (org-on-heading-p)))
19038 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19039 org-ctrl-k-protect-subtree)
19040 (if (or (eq org-ctrl-k-protect-subtree 'error)
19041 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19042 (error "C-k aborted - would kill hidden subtree")))
19043 (call-interactively 'kill-line))
19045 (kill-region (point) (match-beginning 1))
19046 (org-set-tags nil t))
19047 (t (kill-region (point) (point-at-eol)))))
19049 (define-key org-mode-map "\C-k" 'org-kill-line)
19051 (defun org-yank (&optional arg)
19052 "Yank. If the kill is a subtree, treat it specially.
19053 This command will look at the current kill and check if is a single
19054 subtree, or a series of subtrees[1]. If it passes the test, and if the
19055 cursor is at the beginning of a line or after the stars of a currently
19056 empty headline, then the yank is handled specially. How exactly depends
19057 on the value of the following variables, both set by default.
19059 org-yank-folded-subtrees
19060 When set, the subtree(s) will be folded after insertion, but only
19061 if doing so would now swallow text after the yanked text.
19063 org-yank-adjusted-subtrees
19064 When set, the subtree will be promoted or demoted in order to
19065 fit into the local outline tree structure, which means that the level
19066 will be adjusted so that it becomes the smaller one of the two
19067 *visible* surrounding headings.
19069 Any prefix to this command will cause `yank' to be called directly with
19071 will just
19072 plainly yank the text as it is.
19074 \[1] The test checks if the first non-white line is a heading
19075 and if there are no other headings with fewer stars."
19076 (interactive "P")
19077 (org-yank-generic 'yank arg))
19079 (defun org-yank-generic (command arg)
19080 "Perform some yank-like command.
19082 This function implements the behavior described in the `org-yank'
19083 documentation. However, it has been generalized to work for any
19084 interactive command with similar behavior."
19086 ;; pretend to be command COMMAND
19087 (setq this-command command)
19089 (if arg
19090 (call-interactively command)
19092 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19093 (and (org-kill-is-subtree-p)
19094 (or (bolp)
19096 (string-match
19098 (buffer-substring (point-at-bol) (point)))))))
19099 swallowp)
19100 (cond
19101 ((and subtreep org-yank-folded-subtrees)
19102 (let ((beg (point))
19103 end)
19104 (if (and subtreep org-yank-adjusted-subtrees)
19105 (org-paste-subtree nil nil 'for-yank)
19106 (call-interactively command))
19108 (setq end (point))
19109 (goto-char beg)
19110 (when (and (bolp) subtreep
19111 (not (setq swallowp
19112 (org-yank-folding-would-swallow-text beg end))))
19113 (or (looking-at outline-regexp)
19114 (re-search-forward (concat "^" outline-regexp) end t))
19115 (while (and (< (point) end) (looking-at outline-regexp))
19116 (hide-subtree)
19117 (org-cycle-show-empty-lines 'folded)
19118 (condition-case nil
19119 (outline-forward-same-level 1)
19120 (error (goto-char end)))))
19121 (when swallowp
19122 (message
19123 "Inserted text not folded because that would swallow text"))
19125 (goto-char end)
19127 (beginning-of-line 1)
19128 (push-mark beg 'nomsg)))
19129 ((and subtreep org-yank-adjusted-subtrees)
19130 (let ((beg (point-at-bol)))
19131 (org-paste-subtree nil nil 'for-yank)
19132 (push-mark beg 'nomsg)))
19133 (t
19134 (call-interactively command))))))
19136 (defun org-yank-folding-would-swallow-text (beg end)
19137 "Would hide-subtree at BEG swallow any text after END?"
19138 (let (level)
19139 (save-excursion
19140 (goto-char beg)
19141 (when (or (looking-at outline-regexp)
19142 (re-search-forward (concat "^" outline-regexp) end t))
19143 (setq level (org-outline-level)))
19144 (goto-char end)
19146 (if (or (eobp)
19147 (and (bolp) (looking-at org-outline-regexp)
19148 (<= (org-outline-level) level)))
19149 nil ; Nothing would be swallowed
19150 t)))) ; something would swallow
19152 (define-key org-mode-map "\C-y" 'org-yank)
19154 (defun org-invisible-p ()
19155 "Check if point is at a character currently not visible."
19156 ;; Early versions of noutline don't have `outline-invisible-p'.
19157 (if (fboundp 'outline-invisible-p)
19158 (outline-invisible-p)
19159 (get-char-property (point) 'invisible)))
19161 (defun org-truely-invisible-p ()
19162 "Check if point is at a character currently not visible.
19163 This version does not only check the character property, but also
19164 `visible-mode'."
19165 ;; Early versions of noutline don't have `outline-invisible-p'.
19166 (if (org-bound-and-true-p visible-mode)
19167 nil
19168 (if (fboundp 'outline-invisible-p)
19169 (outline-invisible-p)
19170 (get-char-property (point) 'invisible))))
19172 (defun org-invisible-p2 ()
19173 "Check if point is at a character currently not visible."
19174 (save-excursion
19175 (if (and (eolp) (not (bobp))) (backward-char 1))
19176 ;; Early versions of noutline don't have `outline-invisible-p'.
19177 (if (fboundp 'outline-invisible-p)
19178 (outline-invisible-p)
19179 (get-char-property (point) 'invisible))))
19181 (defun org-back-to-heading (&optional invisible-ok)
19182 "Call `outline-back-to-heading', but provide a better error message."
19183 (condition-case nil
19184 (outline-back-to-heading invisible-ok)
19185 (error (error "Before first headline at position %d in buffer %s"
19186 (point) (current-buffer)))))
19188 (defun org-beginning-of-defun ()
19189 "Go to the beginning of the subtree, i.e. back to the heading."
19190 (org-back-to-heading))
19191 (defun org-end-of-defun ()
19192 "Go to the end of the subtree."
19193 (org-end-of-subtree nil t))
19195 (defun org-before-first-heading-p ()
19196 "Before first heading?"
19197 (save-excursion
19200 (defun org-on-heading-p (&optional ignored)
19201 (outline-on-heading-p t))
19202 (defun org-at-heading-p (&optional ignored)
19203 (outline-on-heading-p t))
19205 (defun org-point-at-end-of-empty-headline ()
19206 "If point is at the end of an empty headline, return t, else nil.
19207 If the heading only contains a TODO keyword, it is still still considered
19208 empty."
19210 (save-excursion
19211 (beginning-of-line 1)
19214 (defun org-at-heading-or-item-p ()
19215 (or (org-on-heading-p) (org-at-item-p)))
19217 (defun org-on-target-p ()
19218 (or (org-in-regexp org-radio-target-regexp)
19219 (org-in-regexp org-target-regexp)))
19221 (defun org-up-heading-all (arg)
19222 "Move to the heading line of which the present line is a subheading.
19223 This function considers both visible and invisible heading lines.
19224 With argument, move up ARG levels."
19225 (if (fboundp 'outline-up-heading-all)
19226 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19227 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19229 (defun org-up-heading-safe ()
19230 "Move to the heading line of which the present line is a subheading.
19231 This version will not throw an error. It will return the level of the
19232 headline found, or nil if no higher level is found.
19234 Also, this function will be a lot faster than `outline-up-heading',
19235 because it relies on stars being the outline starters. This can really
19236 make a significant difference in outlines with very many siblings."
19237 (let (start-level re)
19238 (org-back-to-heading t)
19239 (setq start-level (funcall outline-level))
19240 (if (equal start-level 1)
19241 nil
19243 (if (re-search-backward re nil t)
19244 (funcall outline-level)))))
19246 (defun org-first-sibling-p ()
19247 "Is this heading the first child of its parents?"
19248 (interactive)
19249 (let ((re (concat "^" outline-regexp))
19250 level l)
19251 (unless (org-at-heading-p t)
19252 (error "Not at a heading"))
19253 (setq level (funcall outline-level))
19254 (save-excursion
19255 (if (not (re-search-backward re nil t))
19256 t
19257 (setq l (funcall outline-level))
19258 (< l level)))))
19260 (defun org-goto-sibling (&optional previous)
19261 "Goto the next sibling, even if it is invisible.
19262 When PREVIOUS is set, go to the previous sibling instead. Returns t
19263 when a sibling was found. When none is found, return nil and don't
19264 move point."
19265 (let ((fun (if previous 're-search-backward 're-search-forward))
19266 (pos (point))
19267 (re (concat "^" outline-regexp))
19268 level l)
19269 (when (condition-case nil (org-back-to-heading t) (error nil))
19270 (setq level (funcall outline-level))
19271 (catch 'exit
19272 (or previous (forward-char 1))
19273 (while (funcall fun re nil t)
19274 (setq l (funcall outline-level))
19275 (when (< l level) (goto-char pos) (throw 'exit nil))
19276 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
19277 (goto-char pos)
19278 nil))))
19280 (defun org-show-siblings ()
19281 "Show all siblings of the current headline."
19282 (save-excursion
19283 (while (org-goto-sibling) (org-flag-heading nil)))
19284 (save-excursion
19285 (while (org-goto-sibling 'previous)
19286 (org-flag-heading nil))))
19288 (defun org-goto-first-child ()
19289 "Goto the first child, even if it is invisible.
19290 Return t when a child was found. Otherwise don't move point and
19291 return nil."
19292 (let (level (pos (point)) (re (concat "^" outline-regexp)))
19293 (when (condition-case nil (org-back-to-heading t) (error nil))
19294 (setq level (outline-level))
19295 (forward-char 1)
19296 (if (and (re-search-forward re nil t) (> (outline-level) level))
19297 (progn (goto-char (match-beginning 0)) t)
19298 (goto-char pos) nil))))
19300 (defun org-show-hidden-entry ()
19301 "Show an entry where even the heading is hidden."
19302 (save-excursion
19303 (org-show-entry)))
19305 (defun org-flag-heading (flag &optional entry)
19306 "Flag the current heading. FLAG non-nil means make invisible.
19307 When ENTRY is non-nil, show the entire entry."
19308 (save-excursion
19309 (org-back-to-heading t)
19310 ;; Check if we should show the entire entry
19311 (if entry
19312 (progn
19313 (org-show-entry)
19314 (save-excursion
19315 (and (outline-next-heading)
19316 (org-flag-heading nil))))
19317 (outline-flag-region (max (point-min) (1- (point)))
19318 (save-excursion (outline-end-of-heading) (point))
19319 flag))))
19321 (defun org-get-next-sibling ()
19322 "Move to next heading of the same level, and return point.
19323 If there is no such heading, return nil.
19324 This is like outline-next-sibling, but invisible headings are ok."
19325 (let ((level (funcall outline-level)))
19326 (outline-next-heading)
19327 (while (and (not (eobp)) (> (funcall outline-level) level))
19328 (outline-next-heading))
19329 (if (or (eobp) (< (funcall outline-level) level))
19330 nil
19331 (point))))
19333 (defun org-get-last-sibling ()
19334 "Move to previous heading of the same level, and return point.
19335 If there is no such heading, return nil."
19336 (let ((opoint (point))
19337 (level (funcall outline-level)))
19338 (outline-previous-heading)
19339 (when (and (/= (point) opoint) (outline-on-heading-p t))
19340 (while (and (> (funcall outline-level) level)
19341 (not (bobp)))
19342 (outline-previous-heading))
19343 (if (< (funcall outline-level) level)
19344 nil
19345 (point)))))
19347 (defun org-end-of-subtree (&optional invisible-OK to-heading)
19348 ;; This contains an exact copy of the original function, but it uses
19349 ;; `org-back-to-heading', to make it work also in invisible
19350 ;; trees. And is uses an invisible-OK argument.
19351 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
19352 ;; Furthermore, when used inside Org, finding the end of a large subtree
19353 ;; with many children and grandchildren etc, this can be much faster
19354 ;; than the outline version.
19355 (org-back-to-heading invisible-OK)
19356 (let ((first t)
19357 (level (funcall outline-level)))
19358 (if (and (org-mode-p) (< level 1000))
19359 ;; A true heading (not a plain list item), in Org-mode
19360 ;; This means we can easily find the end by looking
19361 ;; only for the right number of stars. Using a regexp to do
19362 ;; this is so much faster than using a Lisp loop.
19364 (forward-char 1)
19365 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
19366 ;; something else, do it the slow way
19367 (while (and (not (eobp))
19368 (or first (> (funcall outline-level) level)))
19369 (setq first nil)
19370 (outline-next-heading)))
19371 (unless to-heading
19373 (progn
19374 ;; Go to end of line before heading
19375 (forward-char -1)
19377 ;; leave blank line before heading
19378 (forward-char -1))))))
19379 (point))
19381 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
19382 "Use Org version in org-mode, for dramatic speed-up."
19383 (if (eq major-mode 'org-mode)
19384 (progn
19385 (org-end-of-subtree nil t)
19386 (unless (eobp) (backward-char 1)))
19387 ad-do-it))
19389 (defun org-forward-same-level (arg &optional invisible-ok)
19390 "Move forward to the arg'th subheading at same level as this one.
19391 Stop at the first and last subheadings of a superior heading.
19392 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
19393 it wil also look at invisible ones."
19394 (interactive "p")
19395 (org-back-to-heading invisible-ok)
19396 (org-on-heading-p)
19397 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19399 l)
19400 (forward-char 1)
19401 (while (> arg 0)
19402 (while (and (re-search-forward re nil 'move)
19403 (setq l (- (match-end 0) (match-beginning 0) 1))
19404 (= l level)
19405 (not invisible-ok)
19406 (progn (backward-char 1) (org-invisible-p)))
19407 (if (< l level) (setq arg 1)))
19408 (setq arg (1- arg)))
19409 (beginning-of-line 1)))
19411 (defun org-backward-same-level (arg &optional invisible-ok)
19412 "Move backward to the arg'th subheading at same level as this one.
19413 Stop at the first and last subheadings of a superior heading."
19414 (interactive "p")
19415 (org-back-to-heading)
19416 (org-on-heading-p)
19417 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19419 l)
19420 (while (> arg 0)
19421 (while (and (re-search-backward re nil 'move)
19422 (setq l (- (match-end 0) (match-beginning 0) 1))
19423 (= l level)
19424 (not invisible-ok)
19425 (org-invisible-p))
19426 (if (< l level) (setq arg 1)))
19427 (setq arg (1- arg)))))
19429 (defun org-show-subtree ()
19430 "Show everything after this heading at deeper levels."
19431 (outline-flag-region
19432 (point)
19433 (save-excursion
19434 (org-end-of-subtree t t))
19435 nil))
19437 (defun org-show-entry ()
19438 "Show the body directly following this heading.
19439 Show the heading too, if it is currently invisible."
19440 (interactive)
19441 (save-excursion
19442 (condition-case nil
19443 (progn
19444 (org-back-to-heading t)
19445 (outline-flag-region
19446 (max (point-min) (1- (point)))
19447 (save-excursion
19448 (if (re-search-forward
19450 (match-beginning 1)
19451 (point-max)))
19452 nil)
19453 (org-cycle-hide-drawers 'children))
19454 (error nil))))
19456 (defun org-make-options-regexp (kwds &optional extra)
19457 "Make a regular expression for keyword lines."
19458 (concat
19459 "^"
19466 ;; Make isearch reveal the necessary context
19467 (defun org-isearch-end ()
19468 "Reveal context after isearch exits."
19469 (when isearch-success ; only if search was successful
19470 (if (featurep 'xemacs)
19471 ;; Under XEmacs, the hook is run in the correct place,
19472 ;; we directly show the context.
19473 (org-show-context 'isearch)
19474 ;; In Emacs the hook runs *before* restoring the overlays.
19475 ;; So we have to use a one-time post-command-hook to do this.
19476 ;; (Emacs 22 has a special variable, see function `org-mode')
19477 (unless (and (boundp 'isearch-mode-end-hook-quit)
19478 isearch-mode-end-hook-quit)
19479 ;; Only when the isearch was not quitted.
19480 (org-add-hook 'post-command-hook 'org-isearch-post-command
19481 'append 'local)))))
19483 (defun org-isearch-post-command ()
19484 "Remove self from hook, and show context."
19485 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
19486 (org-show-context 'isearch))
19489 ;;;; Integration with and fixes for other packages
19491 ;;; Imenu support
19493 (defvar org-imenu-markers nil
19494 "All markers currently used by Imenu.")
19495 (make-variable-buffer-local 'org-imenu-markers)
19497 (defun org-imenu-new-marker (&optional pos)
19498 "Return a new marker for use by Imenu, and remember the marker."
19499 (let ((m (make-marker)))
19500 (move-marker m (or pos (point)))
19501 (push m org-imenu-markers)
19502 m))
19504 (defun org-imenu-get-tree ()
19505 "Produce the index for Imenu."
19506 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
19507 (setq org-imenu-markers nil)
19508 (let* ((n org-imenu-depth)
19509 (re (concat "^" outline-regexp))
19510 (subs (make-vector (1+ n) nil))
19511 (last-level 0)
19512 m level head)
19513 (save-excursion
19514 (save-restriction
19515 (widen)
19516 (goto-char (point-max))
19517 (while (re-search-backward re nil t)
19518 (setq level (org-reduced-level (funcall outline-level)))
19519 (when (<= level n)
19520 (looking-at org-complex-heading-regexp)
19521 (setq head (org-link-display-format
19522 (org-match-string-no-properties 4))
19523 m (org-imenu-new-marker))
19524 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
19525 (if (>= level last-level)
19526 (push (cons head m) (aref subs level))
19527 (push (cons head (aref subs (1+ level))) (aref subs level))
19528 (loop for i from (1+ level) to n do (aset subs i nil)))
19529 (setq last-level level)))))
19530 (aref subs 1)))
19532 (eval-after-load "imenu"
19533 '(progn
19534 (add-hook 'imenu-after-jump-hook
19535 (lambda ()
19536 (if (eq major-mode 'org-mode)
19537 (org-show-context 'org-goto))))))
19539 (defun org-link-display-format (link)
19540 "Replace a link with either the description, or the link target
19541 if no description is present"
19542 (save-match-data
19543 (if (string-match org-bracket-link-analytic-regexp link)
19544 (replace-match (if (match-end 5)
19545 (match-string 5 link)
19546 (concat (match-string 1 link)
19547 (match-string 3 link)))
19548 nil t link)
19549 link)))
19551 ;; Speedbar support
19553 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
19554 "Overlay marking the agenda restriction line in speedbar.")
19555 (overlay-put org-speedbar-restriction-lock-overlay
19556 'face 'org-agenda-restriction-lock)
19557 (overlay-put org-speedbar-restriction-lock-overlay
19558 'help-echo "Agendas are currently limited to this item.")
19559 (org-detach-overlay org-speedbar-restriction-lock-overlay)
19561 (defun org-speedbar-set-agenda-restriction ()
19562 "Restrict future agenda commands to the location at point in speedbar.
19564 (interactive)
19565 (require 'org-agenda)
19566 (let (p m tp np dir txt)
19567 (cond
19568 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19569 'org-imenu t))
19570 (setq m (get-text-property p 'org-imenu-marker))
19571 (with-current-buffer (marker-buffer m)
19572 (goto-char m)
19573 (org-agenda-set-restriction-lock 'subtree)))
19574 ((setq p (text-property-any (point-at-bol) (point-at-eol)
19575 'speedbar-function 'speedbar-find-file))
19576 (setq tp (previous-single-property-change
19577 (1+ p) 'speedbar-function)
19578 np (next-single-property-change
19579 tp 'speedbar-function)
19580 dir (speedbar-line-directory)
19581 txt (buffer-substring-no-properties (or tp (point-min))
19582 (or np (point-max))))
19583 (with-current-buffer (find-file-noselect
19584 (let ((default-directory dir))
19585 (expand-file-name txt)))
19586 (unless (org-mode-p)
19587 (error "Cannot restrict to non-Org-mode file"))
19588 (org-agenda-set-restriction-lock 'file)))
19589 (t (error "Don't know how to restrict Org-mode's agenda")))
19590 (move-overlay org-speedbar-restriction-lock-overlay
19591 (point-at-bol) (point-at-eol))
19592 (setq current-prefix-arg nil)
19593 (org-agenda-maybe-redo)))
19595 (eval-after-load "speedbar"
19596 '(progn
19597 (speedbar-add-supported-extension ".org")
19598 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
19599 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
19600 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
19601 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19602 (add-hook 'speedbar-visiting-tag-hook
19603 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
19605 ;;; Fixes and Hacks for problems with other packages
19607 ;; Make flyspell not check words in links, to not mess up our keymap
19608 (defun org-mode-flyspell-verify ()
19609 "Don't let flyspell put overlays at active buttons."
19610 (and (not (get-text-property (max (1- (point)) (point-min)) 'keymap))
19611 (not (get-text-property (max (1- (point)) (point-min)) 'org-no-flyspell))))
19613 (defun org-remove-flyspell-overlays-in (beg end)
19614 "Remove flyspell overlays in region."
19615 (and (org-bound-and-true-p flyspell-mode)
19616 (fboundp 'flyspell-delete-region-overlays)
19617 (flyspell-delete-region-overlays beg end))
19618 (add-text-properties beg end '(org-no-flyspell t)))
19620 ;; Make `bookmark-jump' shows the jump location if it was hidden.
19621 (eval-after-load "bookmark"
19622 '(if (boundp 'bookmark-after-jump-hook)
19623 ;; We can use the hook
19624 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
19625 ;; Hook not available, use advice
19626 (defadvice bookmark-jump (after org-make-visible activate)
19627 "Make the position visible."
19628 (org-bookmark-jump-unhide))))
19630 ;; Make sure saveplace shows the location if it was hidden
19631 (eval-after-load "saveplace"
19632 '(defadvice save-place-find-file-hook (after org-make-visible activate)
19633 "Make the position visible."
19634 (org-bookmark-jump-unhide)))
19636 ;; Make sure ecb shows the location if it was hidden
19637 (eval-after-load "ecb"
19638 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
19639 "Make hierarchy visible when jumping into location from ECB tree buffer."
19640 (if (eq major-mode 'org-mode)
19641 (org-show-context))))
19643 (defun org-bookmark-jump-unhide ()
19644 "Unhide the current position, to show the bookmark location."
19645 (and (org-mode-p)
19646 (or (org-invisible-p)
19647 (save-excursion (goto-char (max (point-min) (1- (point))))
19648 (org-invisible-p)))
19649 (org-show-context 'bookmark-jump)))
19651 ;; Make session.el ignore our circular variable
19652 (eval-after-load "session"
19653 '(add-to-list 'session-globals-exclude 'org-mark-ring))
19655 ;;;; Experimental code
19657 (defun org-closed-in-range ()
19658 "Sparse tree of items closed in a certain time range.
19659 Still experimental, may disappear in the future."
19660 (interactive)
19661 ;; Get the time interval from the user.
19662 (let* ((time1 (org-float-time
19663 (org-read-date nil 'to-time nil "Starting date: ")))
19664 (time2 (org-float-time
19665 (org-read-date nil 'to-time nil "End date:")))
19666 ;; callback function
19667 (callback (lambda ()
19668 (let ((time
19669 (org-float-time
19670 (apply 'encode-time
19671 (org-parse-time-string
19672 (match-string 1))))))
19673 ;; check if time in interval
19674 (and (>= time time1) (<= time time2))))))
19675 ;; make tree, check each match with the callback
19678 ;;;; Finish up
19680 (provide 'org)
19682 (run-hooks 'org-load-hook)
19684 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
19686 ;;; org.el ends here