| blob | 9f8fa92253cc000d27e0532ef3d438efc92a387b |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
4 ;; Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.5
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
26 ;;
27 ;;; Commentary:
28 ;;
29 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
30 ;; project planning with a fast and effective plain-text system.
31 ;;
32 ;; Org-mode develops organizational tasks around NOTES files that contain
33 ;; information about projects as plain text. Org-mode is implemented on
34 ;; top of outline-mode, which makes it possible to keep the content of
35 ;; large files well structured. Visibility cycling and structure editing
36 ;; help to work with the tree. Tables are easily created with a built-in
37 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
38 ;; and scheduling. It dynamically compiles entries into an agenda that
39 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
40 ;; Plain text URL-like links connect to websites, emails, Usenet
41 ;; messages, BBDB entries, and any files related to the projects. For
42 ;; printing and sharing of notes, an Org-mode file can be exported as a
43 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
44 ;; iCalendar file. It can also serve as a publishing tool for a set of
45 ;; linked webpages.
46 ;;
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
50 ;;
51 ;; http://orgmode.org/org.html#Installation
52 ;;
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org-mode can be found in the TeXInfo file. The
56 ;; distribution also contains a PDF version of it. At the homepage of
57 ;; Org-mode, you can read the same text online as HTML. There is also an
58 ;; excellent reference card made by Philip Rooke. This card can be found
59 ;; in the etc/ directory of Emacs 22.
60 ;;
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
63 ;;
64 ;;; Code:
71 ;;;; Require other packages
79 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
91 ;; Other stuff we need.
110 ;; babel
119 ;; load languages based on value of `org-babel-load-languages'
121 ;;;###autoload
123 "Load the languages defined in `org-babel-load-languages'."
135 org-babel-load-languages))
138 "Languages which can be evaluated in Org-mode buffers.
139 This list can be used to load support for any of the languages
140 below, note that each language will depend on a different set of
141 system executables and/or Emacs modes. When a language is
143 with `org-babel-execute-src-block' bound by default to C-c
144 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
145 be set to remove code block evaluation from the C-c C-c
146 keybinding. By default only Emacs Lisp (which has no
147 requirements) is loaded."
151 :key-type
185 ;;;; Customization variables
187 "Remove ID property of clones of a subtree.
188 When non-nil, clones of a subtree don't inherit the ID property.
189 Otherwise they inherit the ID property with a new unique
190 identifier."
194 ;;; Version
200 "Show the org-mode version in the echo area.
201 With prefix arg HERE, insert it at point."
227 ;;; Compatibility constants
229 ;;; The custom variables
232 "Outline-based notes management and organizer."
238 "Mode hook for Org-mode, run after the mode was turned on."
243 "Hook that is run after org.el has been loaded."
252 "Load all extensions listed in `org-modules'."
257 org-modules)
261 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
270 (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)
271 "Modules that should always be loaded together with org.el.
272 If a description starts with <C>, the file is not part of Emacs
273 and loading it will require that you have downloaded and properly installed
274 the org-mode distribution.
276 You can also use this system to load external packages (i.e. neither Org
277 core modules, nor modules from the CONTRIB directory). Just add symbols
278 to the end of the list. If the package is called org-xyz.el, then you need
279 to add the symbol `xyz', and the package must have a call to
281 (provide 'org-xyz)"
284 :type
315 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
324 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
333 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
349 "Non-nil means make shift-cursor commands select text when possible.
351 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start
352 selecting a region, or enlarge regions started in this way.
353 In Org-mode, in special contexts, these same keys are used for other
354 purposes, important enough to compete with shift selection. Org tries
355 to balance these needs by supporting `shift-select-mode' outside these
356 special contexts, under control of this variable.
358 The default of this variable is nil, to avoid confusing behavior. Shifted
359 cursor keys will then execute Org commands in the following contexts:
360 - on a headline, changing TODO state (left/right) and priority (up/down)
361 - on a time stamp, changing the time
362 - in a plain list item, changing the bullet type
363 - in a property definition line, switching between allowed values
364 - in the BEGIN line of a clock table (changing the time block).
365 Outside these contexts, the commands will throw an error.
367 When this variable is t and the cursor is not in a special context,
368 Org-mode will support shift-selection for making and enlarging regions.
369 To make this more effective, the bullet cycling will no longer happen
370 anywhere in an item line, but only if the cursor is exactly on the bullet.
372 If you set this variable to the symbol `always', then the keys
373 will not be special in headlines, property lines, and item lines, to make
374 shift selection work there as well. If this is what you want, you can
375 use the following alternative commands: `C-c C-t' and `C-c ,' to
376 change TODO state and priority, `C-u C-u C-c C-t' can be used to switch
377 TODO sets, `C-c -' to cycle item bullet types, and properties can be
378 edited by hand or in column view.
380 However, when the cursor is on a timestamp, shift-cursor commands
381 will still edit the time stamp - this is just too good to give up.
383 XEmacs user should have this variable set to nil, because shift-select-mode
384 is Emacs 23 only."
392 "Options concerning startup of Org-mode."
397 "Non-nil means entering Org-mode will switch to OVERVIEW.
398 This can also be configured on a per-file basis by adding one of
399 the following lines anywhere in the buffer:
401 #+STARTUP: fold (or `overview', this is equivalent)
402 #+STARTUP: nofold (or `showall', this is equivalent)
403 #+STARTUP: content
404 #+STARTUP: showeverything"
413 "Non-nil means entering Org-mode will set `truncate-lines'.
414 This is useful since some lines containing links can be very long and
415 uninteresting. Also tables look terrible when wrapped."
420 "Non-nil means turn on `org-indent-mode' on startup.
421 This can also be configured on a per-file basis by adding one of
422 the following lines anywhere in the buffer:
424 #+STARTUP: indent
425 #+STARTUP: noindent"
433 When this option is turned on, you can use TeX-like syntax for sub- and
435 considered as a single item - so grouping with {} is normally not
436 needed. For example, the following things will be parsed as single
437 sub- or superscripts.
439 10^24 or 10^tau several digits will be considered 1 item.
440 10^-12 or 10^-tau a leading sign with digits or a word
441 x^2-y^3 will be read as x^2 - y^3, because items are
442 terminated by almost any nonword/nondigit char.
443 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
445 Still, ambiguity is possible - so when in doubt use {} to enclose the
446 sub/superscript. If you set this variable to the symbol `{}',
447 the braces are *required* in order to trigger interpretations as
449 frequently in plain text.
451 Not all export backends support this, but HTML does.
466 "Non-nil means turn on `org-beamer-mode' on startup.
467 This can also be configured on a per-file basis by adding one of
468 the following lines anywhere in the buffer:
470 #+STARTUP: beamer"
475 "Non-nil means align all tables when visiting a file.
476 This is useful when the column width in tables is forced with <N> cookies
477 in table fields. Such tables will look correct only after the first re-align.
478 This can also be configured on a per-file basis by adding one of
479 the following lines anywhere in the buffer:
480 #+STARTUP: align
481 #+STARTUP: noalign"
486 "Non-nil means show inline images when loading a new Org file.
487 This can also be configured on a per-file basis by adding one of
488 the following lines anywhere in the buffer:
489 #+STARTUP: inlineimages
490 #+STARTUP: noinlineimages"
495 "Non-nil means insert the first line setting Org-mode in empty files.
496 When the function `org-mode' is called interactively in an empty file, this
497 normally means that the file name does not automatically trigger Org-mode.
498 To ensure that the file will always be in Org-mode in the future, a
499 line enforcing Org-mode will be inserted into the buffer, if this option
500 has been set."
505 "Non-nil means use alternative key bindings for some keys.
506 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
507 These keys are also used by other packages like shift-selection-mode'
508 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
509 If you want to use Org-mode together with one of these other modes,
510 or more generally if you would like to move some Org-mode commands to
511 other keys, set this variable and configure the keys with the variable
512 `org-disputed-keys'.
514 This option is only relevant at load-time of Org-mode, and must be set
515 *before* org.el is loaded. Changing it requires a restart of Emacs to
516 become effective."
521 "Non-nil means use extra key sequence definitions for certain commands.
522 This happens automatically if you run XEmacs or if `window-system'
523 is nil. This variable lets you do the same manually. You must
524 set it before loading org.
526 Example: on Carbon Emacs 22 running graphically, with an external
527 keyboard on a Powerbook, the default way of setting M-left might
528 not work for either Alt or ESC. Setting this variable will make
529 it work for ESC."
543 "Keys for which Org-mode and other modes compete.
544 This is an alist, cars are the default keys, second element specifies
545 the alternative to use when `org-replace-disputed-keys' is t.
547 Keys can be specified in any syntax supported by `define-key'.
548 The value of this option takes effect only at Org-mode's startup,
549 therefore you'll have to restart Emacs to apply it after changing."
554 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
555 Or return the original if not disputed.
556 Also apply the translations defined in `org-xemacs-key-equivalents'."
561 org-disputed-keys)))
565 key)
575 "Define a key, possibly translated, as returned by `org-key'."
579 "The ellipsis to use in the Org-mode outline.
580 When nil, just use the standard three dots. When a string, use that instead,
581 When a face, use the standard 3 dots, but with the specified face.
582 The change affects only Org-mode (which will then use its own display table).
583 Changing this requires executing `M-x org-mode' in a buffer to become
584 effective."
594 "Keywords in Org-mode."
599 "String to mark deadline entries.
600 A deadline is this string, followed by a time stamp. Should be a word,
601 terminated by a colon. You can insert a schedule keyword and
603 Changes become only effective after restarting Emacs."
608 "String to mark scheduled TODO entries.
609 A schedule is this string, followed by a time stamp. Should be a word,
610 terminated by a colon. You can insert a schedule keyword and
612 Changes become only effective after restarting Emacs."
617 "String used as the prefix for timestamps logging closing a TODO entry."
622 "String used as prefix for timestamps clocking work hours on an item."
627 "Entries starting with this keyword will never be exported.
628 An entry can be toggled between COMMENT and normal with
630 Changes become only effective after restarting Emacs."
635 "Entries starting with this keyword will be exported in fixed-width font.
636 Quoting applies only to the text in the entry following the headline, and does
637 not extend beyond the next headline, even if that is lower level.
638 An entry can be toggled between QUOTE and normal with
645 "Regular expression for specifying repeated events.
649 "Options concerning the general structure of Org-mode files."
654 "Options about how to make context of a location visible."
678 "Non-nil means show full hierarchy when revealing a location.
679 Org-mode often shows locations in an org-mode file which might have
680 been invisible before. When this is set, the hierarchy of headings
681 above the exposed location is shown.
682 Turning this off for example for sparse trees makes them very compact.
683 Instead of t, this can also be an alist specifying this option for different
684 contexts. Valid contexts are
685 agenda when exposing an entry from the agenda
686 org-goto when using the command `org-goto' on key C-c C-j
687 occur-tree when using the command `org-occur' on key C-c /
688 tags-tree when constructing a sparse tree based on tags matches
689 link-search when exposing search matches associated with a link
690 mark-goto when exposing the jump goal of a mark
691 bookmark-jump when exposing a bookmark location
692 isearch when exiting from an incremental search
693 default default for all contexts not set explicitly"
698 "Non-nil means show following heading when revealing a location.
699 Org-mode often shows locations in an org-mode file which might have
700 been invisible before. When this is set, the heading following the
701 match is shown.
702 Turning this off for example for sparse trees makes them very compact,
703 but makes it harder to edit the location of the match. In such a case,
705 Instead of t, this can also be an alist specifying this option for different
706 contexts. See `org-show-hierarchy-above' for valid contexts."
711 "Non-nil means show all sibling heading when revealing a location.
712 Org-mode often shows locations in an org-mode file which might have
713 been invisible before. When this is set, the sibling of the current entry
714 heading are all made visible. If `org-show-hierarchy-above' is t,
715 the same happens on each level of the hierarchy above the current entry.
717 By default this is on for the isearch context, off for all other contexts.
718 Turning this off for example for sparse trees makes them very compact,
719 but makes it harder to edit the location of the match. In such a case,
721 Instead of t, this can also be an alist specifying this option for different
722 contexts. See `org-show-hierarchy-above' for valid contexts."
727 "Non-nil means show the entry below a headline when revealing a location.
728 Org-mode often shows locations in an org-mode file which might have
729 been invisible before. When this is set, the text below the headline that is
730 exposed is also shown.
732 By default this is off for all contexts.
733 Instead of t, this can also be an alist specifying this option for different
734 contexts. See `org-show-hierarchy-above' for valid contexts."
739 "How should indirect tree buffers be displayed?
740 This applies to indirect buffers created with the commands
742 Valid values are:
743 current-window Display in the current window
744 other-window Just display in another window.
745 dedicated-frame Create one new frame, and re-use it each time.
746 new-frame Make a new frame each time. Note that in this case
747 previously-made indirect buffers are kept, and you need to
748 kill these buffers yourself."
758 "Non-nil means activate single letter commands at beginning of a headline.
759 This may also be a function to test for appropriate locations where speed
760 commands should be active."
768 "Alist of additional speed commands.
769 This list will be checked before `org-speed-commands-default'
770 when the variable `org-use-speed-commands' is non-nil
771 and when the cursor is at the beginning of a headline.
772 The car if each entry is a string with a single letter, which must
773 be assigned to `self-insert-command' in the global map.
774 The cdr is either a command to be called interactively, a function
775 to be called, or a form to be evaluated.
776 An entry that is just a list with a single string will be interpreted
777 as a descriptive headline that will be added when listing the speed
778 commands in the Help buffer using the `?' speed command."
790 "Options concerning visibility cycling in Org-mode."
795 "Non-nil means skip CHILDREN state in entries that don't have any."
800 "Maximum level which should still be subject to visibility cycling.
801 Levels higher than this will, for cycling, be treated as text, not a headline.
802 When `org-odd-levels-only' is set, a value of N in this variable actually
803 means 2N-1 stars as the limiting headline.
804 When nil, cycle all levels.
805 Note that the limiting level of cycling is also influenced by
806 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
807 `org-inlinetask-min-level' is, cycling will be limited to levels one less
808 than its value."
815 "Names of drawers. Drawers are not opened by cycling on the headline above.
816 Drawers only open with a TAB on the drawer line itself. A drawer looks like
817 this:
818 :DRAWERNAME:
819 .....
820 :END:
822 the property API.
824 Drawers can be defined on the per-file basis with a line like:
826 #+DRAWERS: HIDDEN STATE PROPERTIES"
832 "Non-nil means entering Org-mode will fold all blocks.
833 This can also be set in on a per-file basis with
835 #+STARTUP: hideblocks
836 #+STARTUP: showblocks"
842 "Cycle globally if cursor is at beginning of buffer and not at a headline.
843 This makes it possible to do global cycling without having to use S-TAB or
845 of the buffer
846 must not be a headline - it may be empty or some other text. When used in
847 this way, `org-cycle-hook' is disables temporarily, to make sure the
848 cursor stays at the beginning of the buffer.
849 When this option is nil, don't do anything special at the beginning
850 of the buffer."
855 "Non-nil means cycle entry level or item indentation in new empty entries.
857 When the cursor is at the end of an empty headline, i.e with only stars
858 and maybe a TODO keyword, TAB will then switch the entry to become a child,
859 and then all possible ancestor states, before returning to the original state.
860 This makes data entry extremely fast: M-RET to create a new headline,
861 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
863 When the cursor is at the end of an empty plain list item, one TAB will
864 make it a subitem, two or more tabs will back up to make this an item
865 higher up in the item hierarchy."
870 "Where should `org-cycle' emulate TAB.
871 nil Never
872 white Only in completely white lines
873 whitestart Only at the beginning of lines, before the first non-white char
874 t Everywhere except in headlines
875 exc-hl-bol Everywhere except at the start of a headline
876 If TAB is used in a place where it does not emulate TAB, the current subtree
877 visibility is cycled."
884 ))
887 "Number of empty lines needed to keep an empty line between collapsed trees.
888 If you leave an empty line between the end of a subtree and the following
889 headline, this empty line is hidden when the subtree is folded.
890 Org-mode will leave (exactly) one empty line visible if the number of
891 empty lines is equal or larger to the number given in this variable.
892 So the default 2 means at least 2 empty lines after the end of a subtree
893 are needed to produce free space between a collapsed subtree and the
894 following headline.
896 If the number is negative, and the number of empty lines is at least -N,
897 all empty lines are shown.
899 Special case: when 0, never leave empty lines in collapsed view."
905 "Hook that is run before visibility cycling is happening.
906 The function(s) in this hook must accept a single argument which indicates
907 the new state that will be set right after running this hook. The
908 argument is a symbol. Before a global state change, it can have the values
909 `overview', `content', or `all'. Before a local state change, it can have
910 the values `folded', `children', or `subtree'."
915 org-cycle-hide-drawers
916 org-cycle-show-empty-lines
917 org-optimize-window-after-visibility-change)
918 "Hook that is run after `org-cycle' has changed the buffer visibility.
919 The function(s) in this hook must accept a single argument which indicates
920 the new state that was set by the most recent `org-cycle' command. The
921 argument is a symbol. After a global state change, it can have the values
922 `overview', `content', or `all'. After a local state change, it can have
923 the values `folded', `children', or `subtree'."
928 "Options concerning structure editing in Org-mode."
933 "Non-nil means skip even levels and only use odd levels for the outline.
934 This has the effect that two stars are being added/taken away in
935 promotion/demotion commands. It also influences how levels are
936 handled by the exporters.
937 Changing it requires restart of `font-lock-mode' to become effective
938 for fontification also in regions already fontified.
939 You may also set this on a per-file basis by adding one of the following
940 lines to the buffer:
942 #+STARTUP: odd
943 #+STARTUP: oddeven"
949 "Non-nil means adapt indentation to outline node level.
951 When this variable is set, Org assumes that you write outlines by
952 indenting text in each node to align with the headline (after the stars).
953 The following issues are influenced by this variable:
955 - When this is set and the *entire* text in an entry is indented, the
956 indentation is increased by one space in a demotion command, and
957 decreased by one in a promotion command. If any line in the entry
958 body starts with text at column 0, indentation is not changed at all.
960 - Property drawers and planning information is inserted indented when
961 this variable s set. When nil, they will not be indented.
963 - TAB indents a line relative to context. The lines below a headline
964 will be indented when this variable is set.
966 Note that this is all about true indentation, by adding and removing
967 space characters. See also `org-indent.el' which does level-dependent
968 indentation in a virtual way, i.e. at display time in Emacs."
973 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
975 When t, `C-a' will bring back the cursor to the beginning of the
976 headline text, i.e. after the stars and after a possible TODO keyword.
977 In an item, this will be the position after the bullet.
978 When the cursor is already at that position, another `C-a' will bring
979 it to the beginning of the line.
981 `C-e' will jump to the end of the headline, ignoring the presence of tags
982 in the headline. A second `C-e' will then jump to the true end of the
983 line, after any tags. This also means that, when this variable is
984 non-nil, `C-e' also will never jump beyond the end of the heading of a
985 folded section, i.e. not after the ellipses.
987 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
988 going to the true line boundary first. Only a directly following, identical
989 keypress will bring the cursor to the special positions.
991 This may also be a cons cell where the behavior for `C-a' and `C-e' is
992 set separately."
1011 "Non-nil means `C-k' will behave specially in headlines.
1012 When nil, `C-k' will call the default `kill-line' command.
1013 When t, the following will happen while the cursor is in the headline:
1015 - When the cursor is at the beginning of a headline, kill the entire
1016 line and possible the folded subtree below the line.
1017 - When in the middle of the headline text, kill the headline up to the tags.
1018 - When after the headline text, kill the tags."
1023 "Non-nil means, do not delete a hidden subtree with C-k.
1024 When set to the symbol `error', simply throw an error when C-k is
1025 used to kill (part-of) a headline that has hidden text behind it.
1026 Any other non-nil value will result in a query to the user, if it is
1027 OK to kill that hidden subtree. When nil, kill without remorse."
1035 "Non-nil means when yanking subtrees, fold them.
1036 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1037 it starts with a heading and all other headings in it are either children
1038 or siblings, then fold all the subtrees. However, do this only if no
1039 text after the yank would be swallowed into a folded tree by this action."
1044 "Non-nil means when yanking subtrees, adjust the level.
1045 With this setting, `org-paste-subtree' is used to insert the subtree, see
1046 this function for details."
1051 "Non-nil means M-RET will split the line at the cursor position.
1052 When nil, it will go to the end of the line before making a
1053 new line.
1054 You may also set this option in a different way for different
1055 contexts. Valid contexts are:
1057 headline when creating a new headline
1058 item when creating a new item
1059 table in a table field
1060 default the value to be used for all contexts not explicitly
1061 customized"
1078 "Non-nil means insert new headings after the current subtree.
1079 When nil, the new heading is created directly after the current line.
1082 for the duration of the command."
1088 "Should `org-insert-heading' leave a blank line before new heading/item?
1089 The value is an alist, with `heading' and `plain-list-item' as car,
1090 and a boolean flag as cdr. The cdr may also be the symbol `auto', and then
1091 Org will look at the surrounding headings/items and try to make an
1092 intelligent decision whether to insert a blank line or not.
1094 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1095 set, the setting here is ignored and no empty line is inserted, to avoid
1096 breaking the list structure."
1109 "Hook being run after inserting a new heading."
1115 This currently only means they are never auto-wrapped.
1116 When nil, such lines will be treated like ordinary lines.
1117 See also the QUOTE keyword."
1122 "Non-nil means typing characters in `org-goto' starts incremental search."
1127 "Options concerning sparse trees in Org-mode."
1132 "Non-nil means highlight all matches that define a sparse tree.
1133 The highlights will automatically disappear the next time the buffer is
1134 changed by an edit command."
1139 "Non-nil means any change to the buffer will remove temporary highlights.
1140 Such highlights are created by `org-occur' and `org-clock-display'.
1141 When nil, `C-c C-c needs to be used to get rid of the highlights.
1142 The highlights created by `org-preview-latex-fragment' always need
1143 `C-c C-c' to be removed."
1150 "Hook that is run after `org-occur' has constructed a sparse tree.
1151 This can be used to recenter the window to show as much of the structure
1152 as possible."
1157 "Options concerning imenu and speedbar in Org-mode."
1162 "The maximum level for Imenu access to Org-mode headlines.
1163 This also applied for speedbar access."
1168 "Options concerning tables in Org-mode."
1174 When nil, such lines will be treated like ordinary lines.
1176 When equal to the symbol `optimized', the table editor will be optimized to
1177 do the following:
1178 - Automatic overwrite mode in front of whitespace in table fields.
1179 This makes the structure of the table stay in tact as long as the edited
1180 field does not exceed the column width.
1181 - Minimize the number of realigns. Normally, the table is aligned each time
1182 TAB or RET are pressed to move to another field. With optimization this
1183 happens only if changes to a field might have changed the column width.
1184 Optimization requires replacing the functions `self-insert-command',
1185 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1186 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1187 very good at guessing when a re-align will be necessary, but you can always
1190 If you would like to use the optimized version in Org-mode, but the
1191 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1193 This variable can be used to turn on and off the table editor during a session,
1194 but in order to toggle optimization, a restart is required.
1196 See also the variable `org-table-auto-blank-field'."
1204 "Non-nil means cluster self-insert commands for undo when possible.
1205 If this is set, then, like in the Emacs command loop, 20 consecutive
1206 characters will be undone together.
1207 This is configurable, because there is some impact on typing performance."
1212 "Non-nil means TAB will automatically notice a table.el table.
1213 When it sees such a table, it moves point into it and - if necessary -
1214 calls `table-recognize-table'."
1219 "Options concerning links in Org-mode."
1224 "Buffer-local version of `org-link-abbrev-alist', which see.
1229 "Alist of link abbreviations.
1230 The car of each element is a string, to be replaced at the start of a link.
1232 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1234 [[linkkey:tag][description]]
1236 The 'linkkey' must be a word word, starting with a letter, followed
1237 by letters, numbers, '-' or '_'.
1239 If REPLACE is a string, the tag will simply be appended to create the link.
1242 be inserted at that point (see the function `url-hexify-string').
1244 REPLACE may also be a function that will be called with the tag as the
1245 only argument to create the link, which should be returned as a string.
1247 See the manual for examples."
1257 "Non-nil means hide link part and only show description of bracket links.
1258 Bracket links are like [[link][description]]. This variable sets the initial
1259 state in new org-mode buffers. The setting can then be toggled on a
1260 per-buffer basis from the Org->Hyperlinks menu."
1265 "How the path name in file links should be stored.
1266 Valid values are:
1268 relative Relative to the current directory, i.e. the directory of the file
1269 into which the link is being inserted.
1270 absolute Absolute path, if possible with ~ for home directory.
1271 noabbrev Absolute path, no abbreviation of home directory.
1272 adaptive Use relative path for files in the current directory and sub-
1273 directories of it. For other files, use an absolute path."
1282 "Types of links that should be activated in Org-mode files.
1283 This is a list of symbols, each leading to the activation of a certain link
1284 type. In principle, it does not hurt to turn on most link types - there may
1285 be a small gain when turning off unused link types. The types are:
1287 bracket The recommended [[link][description]] or [[link]] links with hiding.
1288 angle Links in angular brackets that may contain whitespace like
1289 <bbdb:Carsten Dominik>.
1290 plain Plain links in normal text, no whitespace, like http://google.com.
1291 radio Text that is matched by a radio target, see manual for details.
1292 tag Tag settings in a headline (link to tag search).
1293 date Time stamps (link to calendar).
1294 footnote Footnote labels.
1296 Changing this variable requires a restart of Emacs to become effective."
1308 "Function to use to generate link descriptions from links.
1309 If nil the link location will be used. This function must take
1310 two parameters; the first is the link and the second the
1311 description `org-insert-link' has generated, and should return the
1312 description to use."
1317 "Options concerning storing links in Org-mode."
1322 "Format of the description part of a link to an email or usenet message.
1323 The following %-escapes will be replaced by corresponding information:
1331 %s subject
1332 %d date
1333 %m message-id.
1335 You may use normal field width specification between the % and the letter.
1336 This is for example useful to limit the length of the subject.
1350 It should match if the message is from the user him/herself."
1355 "Non-nil means storing a link to an Org file will use entry IDs.
1357 Note that before this variable is even considered, org-id must be loaded,
1358 so please customize `org-modules' and turn it on.
1360 The variable can have the following values:
1362 t Create an ID if needed to make a link to the current entry.
1364 create-if-interactive
1365 If `org-store-link' is called directly (interactively, as a user
1366 command), do create an ID to support the link. But when doing the
1367 job for remember, only use the ID if it already exists. The
1368 purpose of this setting is to avoid proliferation of unwanted
1369 IDs, just because you happen to be in an Org file when you
1370 call `org-remember' that automatically and preemptively
1371 creates a link. If you do want to get an ID link in a remember
1372 template to an entry not having an ID, create it first by
1373 explicitly creating a link to it, using `C-c C-l' first.
1375 create-if-interactive-and-no-custom-id
1376 Like create-if-interactive, but do not create an ID if there is
1377 a CUSTOM_ID property defined in the entry. This is the default.
1379 use-existing
1380 Use existing ID, do not create one.
1382 nil Never use an ID to make a link, instead link using a text search for
1383 the headline text."
1388 create-if-interactive)
1390 create-if-interactive-and-no-custom-id)
1395 "Non-nil means file links from `org-store-link' contain context.
1396 A search string will be added to the file name with :: as separator and
1397 used to find the context when the link is activated by the command
1398 `org-open-at-point'. When this option is t, the entire active region
1399 will be placed in the search string of the file link. If set to a
1400 positive integer, only the first n lines of context will be stored.
1403 negates this setting for the duration of the command."
1408 "Non-nil means keep link in list for entire session.
1410 The command `org-store-link' adds a link pointing to the current
1411 location to an internal list. These links accumulate during a session.
1412 The command `org-insert-link' can be used to insert links into any
1413 Org-mode file (offering completion for all stored links). When this
1415 will be removed from the list, to make completing the unused links
1416 more efficient."
1421 "Options concerning following links in Org-mode."
1426 "Function to translate links with different syntax to Org syntax.
1427 This can be used to translate links created for example by the Planner
1428 or emacs-wiki packages to Org syntax.
1429 The function must accept two parameters, a TYPE containing the link
1431 which is everything after the link protocol. It should return a cons
1432 with possibly modified values of type and path.
1433 Org contains a function for this, so if you set this variable to
1434 `org-translate-link-from-planner', you should be able follow many
1435 links created by planner."
1440 "Hook that is run after a link has been followed."
1445 "Non-nil means on links TAB will follow the link.
1446 Needs to be set before org.el is loaded.
1447 This really should not be used, it does not make sense, and the
1448 implementation is bad."
1453 "Non-nil means on links RET will follow the link."
1459 "Non-nil means mouse-1 on a link will follow the link.
1460 A longer mouse click will still set point. Does not work on XEmacs.
1461 Needs to be set before org.el is loaded."
1466 "Number of different positions to be recorded in the ring.
1467 Changing this requires a restart of Emacs to work correctly."
1472 "Non-nil means internal links in Org files must exactly match a headline.
1473 When nil, the link search tries to match a phrase with all words
1474 in the search text."
1480 query-to-create)))
1487 "Setup the frame configuration for following links.
1488 When following a link with Emacs, it may often be useful to display
1489 this link in another window or frame. This variable can be used to
1490 set this up for the different types of links.
1491 For VM, use any of
1492 `vm-visit-folder'
1493 `vm-visit-folder-other-window'
1494 `vm-visit-folder-other-frame'
1495 For Gnus, use any of
1496 `gnus'
1497 `gnus-other-frame'
1498 `org-gnus-no-new-news'
1499 For FILE, use any of
1500 `find-file'
1501 `find-file-other-window'
1502 `find-file-other-frame'
1503 For Wanderlust use any of
1504 `wl'
1505 `wl-other-frame'
1506 For the calendar, use the variable `calendar-setup'.
1507 For BBDB, it is currently only possible to display the matches in
1508 another window."
1532 "Non-nil means use indirect buffer to display infile links.
1533 Activating internal links (from one location in a file to another location
1534 in the same file) normally just jumps to the location. When the link is
1536 is displayed in
1537 another window. When this option is set, the other window actually displays
1538 an indirect buffer clone of the current buffer, to avoid any visibility
1539 changes to the current buffer."
1544 "Non-nil means `org-open-file' will open non-existing files.
1545 When nil, an error will be generated.
1546 This variable applies only to external applications because they
1547 might choke on non-existing files. If the link is to a file that
1548 will be opened in Emacs, the variable is ignored."
1553 "Non-nil means a link to a directory really means to index.org.
1554 When nil, following a directory link will run dired or open a finder/explorer
1555 window on that directory."
1560 "Function and arguments to call for following mailto links.
1561 This is a list with the first element being a Lisp function, and the
1562 remaining elements being arguments to the function. In string arguments,
1563 %a will be replaced by the address, and %s will be replaced by the subject
1564 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1573 "Non-nil means ask for confirmation before executing shell links.
1574 Shell links can be dangerous: just think about a link
1576 [[shell:rm -rf ~/*][Google Search]]
1579 but really it would remove your entire home directory.
1580 Therefore we advise against setting this variable to nil.
1581 Just change it to `y-or-n-p' if you want to confirm with a
1589 'safe-local-variable
1593 "A regexp to skip confirmation for shell links."
1598 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1599 Elisp links can be dangerous: just think about a link
1604 but really it would remove your entire home directory.
1605 Therefore we advise against setting this variable to nil.
1606 Just change it to `y-or-n-p' if you want to confirm with a
1614 'safe-local-variable
1618 "A regexp to skip confirmation for Elisp links."
1626 "Default file applications on a UNIX or GNU/Linux system.
1637 "Default file applications on a MacOS X system.
1639 for some files for which the OS does not have a good default.
1647 'mswindows-shell-execute
1652 'mswindows-shell-execute
1655 "Default file applications on a Windows NT system.
1660 '(
1665 )
1666 "External applications for opening `file:path' items in a document.
1667 Org-mode uses system defaults for different file types, but
1668 you can use this variable to set the application for a given file
1669 extension. The entries in this list are cons cells where the car identifies
1670 files and the cdr the corresponding command. Possible values for the
1671 file identifier are
1673 ways, depending on its contents:
1675 - Alphanumeric characters only:
1676 Match links with this file extension.
1678 to open PDFs with evince.
1680 - Regular expression: Match links where the
1681 filename matches the regexp. If you want to
1682 use groups here, use shy groups.
1686 to open *.html and *.xhtml with firefox.
1688 - Regular expression which contains (non-shy) groups:
1690 anything after that, matches the regexp.
1691 In a custom command string, %1, %2, etc. are replaced with
1692 the parts of the link that were matched by the groups.
1693 For backwards compatibility, if a command string is given
1694 that does not use any of the group matches, this case is
1695 handled identically to the second one (i.e. match against
1696 file name only).
1697 In a custom lisp form, you can access the group matches with
1698 (match-string n link).
1701 to open [[file:document.pdf::5]] with evince at page 5.
1703 `directory' Matches a directory
1704 `remote' Matches a remote file, accessible through tramp or efs.
1705 Remote files most likely should be visited through Emacs
1706 because external applications cannot handle such paths.
1707 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1708 so all files Emacs knows how to handle. Using this with
1709 command `emacs' will open most files in Emacs. Beware that this
1710 will also open html files inside Emacs, unless you add
1712 t Default for files not matched by any of the other options.
1713 `system' The system command to open files, like `open' on Windows
1714 and Mac OS X, and mailcap under GNU/Linux. This is the command
1715 that will be selected if you call `C-c C-o' with a double
1718 Possible values for the command are:
1719 `emacs' The file will be visited by the current Emacs process.
1720 `default' Use the default application for this file type, which is the
1721 association for t in the list, most likely in the system-specific
1722 part.
1723 This can be used to overrule an unwanted setting in the
1724 system-specific variable.
1726 This command is specified by the entry whose car is `system'.
1727 Most likely, the system-specific version of this variable
1728 does define this command, but you can overrule/replace it
1729 here.
1730 string A command to be executed by a shell; %s will be replaced
1731 by the path to the file.
1732 sexp A Lisp form which will be evaluated. The file path will
1733 be available in the Lisp variable `file'.
1734 For more examples, see the system specific constants
1735 `org-file-apps-defaults-macosx'
1736 `org-file-apps-defaults-windowsnt'
1737 `org-file-apps-defaults-gnu'."
1747 auto-mode))
1758 "Options concerning refiling entries in Org-mode."
1763 "Directory with org files.
1764 This is just a default location to look for Org files. There is no need
1765 at all to put your files into this directory. It is only used in the
1766 following situations:
1768 1. When a remember template specifies a target file that is not an
1769 absolute path. The path will then be interpreted relative to
1770 `org-directory'
1771 2. When a remember note is filed away in an interactive way (when exiting the
1772 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1773 with `org-directory' as the default path."
1779 "Default target for storing notes.
1780 Used as a fall back file for org-remember.el and org-capture.el, for
1781 templates that do not specify a target file."
1786 file))
1789 "The default interface to be used for `org-goto'.
1790 Allowed values are:
1791 outline The interface shows an outline of the relevant file
1792 and the correct heading is found by moving through
1793 the outline or by searching with incremental search.
1794 outline-path-completion Headlines in the current buffer are offered via
1795 completion. This is the interface also used by
1796 the refile command."
1803 "Maximum target level when running `org-goto' with refile interface."
1808 "Non-nil means store new notes at the beginning of a file or entry.
1809 When nil, new notes will be filed to the end of a file or entry.
1810 This can also be a list with cons cells of regular expressions that
1811 are matched against file names, and values."
1821 "Information to record when a task is refiled.
1823 Possible values are:
1825 nil Don't add anything
1826 time Add a time stamp to the task
1827 note Prompt for a note and add it with template `org-log-note-headings'
1829 This option can also be set with on a per-file-basis with
1831 #+STARTUP: nologrefile
1832 #+STARTUP: logrefile
1833 #+STARTUP: lognoterefile
1835 You can have local logging settings for a subtree by setting the LOGGING
1836 property to one or more of these keywords.
1838 When bulk-refiling from the agenda, the value `note' is forbidden and
1839 will temporarily be changed to `time'."
1849 This is list of cons cells. Each cell contains:
1850 - a specification of the files to be considered, either a list of files,
1851 or a symbol whose function or variable value will be used to retrieve
1852 a file name or a list of file names. If you use `org-agenda-files' for
1853 that, all agenda files will be scanned for targets. Nil means consider
1854 headings in the current buffer.
1855 - A specification of how to find candidate refile targets. This may be
1856 any of:
1858 This tag has to be present in all target headlines, inheritance will
1859 not be considered.
1861 todo keyword.
1863 headlines that are refiling targets.
1864 - a cons cell (:level . N). Any headline of level N is considered a target.
1865 Note that, when `org-odd-levels-only' is set, level corresponds to
1866 order in hierarchy, not to the number of stars.
1867 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1868 Note that, when `org-odd-levels-only' is set, level corresponds to
1869 order in hierarchy, not to the number of stars.
1871 You can set the variable `org-refile-target-verify-function' to a function
1872 to verify each headline found by the simple criteria above.
1874 When this variable is nil, all top-level headlines in the current buffer
1875 are used, equivalent to the value `((nil . (:level . 1))'."
1891 "Function to verify if the headline at point should be a refile target.
1892 The function will be called without arguments, with point at the
1893 beginning of the headline. It should return t and leave point
1894 where it is if the headline is a valid target for refiling.
1896 If the target should not be selected, the function must return nil.
1897 In addition to this, it may move point to a place from where the search
1898 should be continued. For example, the function may decide that the entire
1899 subtree of the current entry should be excluded and move point to the end
1900 of the subtree."
1905 "Non-nil means cache refile targets to speed up the process.
1906 The cache for a particular file will be updated automatically when
1907 the buffer has been killed, or when any of the marker used for flagging
1908 refile targets no longer points at a live buffer.
1909 If you have added new entries to a buffer that might themselves be targets,
1910 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1911 find that easier, `C-u C-u C-u C-c C-w'."
1916 "Non-nil means provide refile targets as paths.
1917 So a level 3 headline will be available as level1/level2/level3.
1919 When the value is `file', also include the file name (without directory)
1920 into the path. In this case, you can also stop the completion after
1921 the file name, to get entries inserted as top level in the file.
1923 When `full-file-path', include the full file path."
1932 "Non-nil means complete the outline path in hierarchical steps.
1933 When Org-mode uses the refile interface to select an outline path
1934 \(see variable `org-refile-use-outline-path'), the completion of
1935 the path can be done is a single go, or if can be done in steps down
1936 the headline hierarchy. Going in steps is probably the best if you
1937 do not use a special completion package like `ido' or `icicles'.
1938 However, when using these packages, going in one step can be very
1939 fast, while still showing the whole path to the entry."
1944 "Non-nil means allow to create new nodes as refile targets.
1946 of an existing node. When the value of this variable is `confirm',
1947 new node creation must be confirmed by the user (recommended)
1948 When nil, the completion must match an existing entry.
1950 Note that, if the new heading is not seen by the criteria
1951 listed in `org-refile-targets', multiple instances of the same
1952 heading would be created by trying again to file under the new
1953 heading."
1961 "Options concerning TODO items in Org-mode."
1966 "Options concerning Progress logging in Org-mode."
1971 '(
1974 "The available interpretation symbols for customizing `org-todo-keywords'.
1978 "List of TODO entry keyword sequences and their interpretation.
1981 Each sequence starts with a symbol, either `sequence' or `type',
1982 indicating if the keywords should be interpreted as a sequence of
1983 action steps, or as different types of TODO items. The first
1984 keywords are states requiring action - these states will select a headline
1985 for inclusion into the global TODO list Org-mode produces. If one of
1988 the last keyword is treated as the only DONE state of the sequence.
1991 additional state where no keyword is present. For details about this
1992 cycling, see the manual.
1994 TODO keywords and interpretation can also be set on a per-file basis with
1995 the special #+SEQ_TODO and #+TYP_TODO lines.
1997 Each keyword can optionally specify a character for fast state selection
1998 \(in combination with the variable `org-use-fast-todo-selection')
1999 and specifiers for state change logging, using the same syntax
2002 indicates to record a time stamp each time this state is selected.
2004 Each keyword may also specify if a timestamp or a note should be
2005 recorded when entering or leaving the state, by adding additional
2006 characters in the parenthesis after the keyword. This looks like this:
2008 record only the time of the state change. With X and Y being either
2010 Y when leaving the state if and only if the *target* state does not
2011 define X. You may omit any of the fast-selection key or X or /Y,
2012 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2014 For backward compatibility, this variable may also be just a list
2015 of keywords - in this case the interpretation (sequence or type) will be
2016 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2026 ;;Quick and dirty way to see
2027 ;;`org-todo-interpretations'. This takes the
2028 ;;place of item arguments
2029 :convert-widget
2036 org-todo-interpretation-widgets))
2037 widget))
2068 "Controls how TODO keywords are interpreted.
2069 This variable is in principle obsolete and is only used for
2070 backward compatibility, if the interpretation of todo keywords is
2071 not given already in `org-todo-keywords'. See that variable for
2072 more information."
2079 "Non-nil means use the fast todo selection scheme with C-c C-t.
2080 This variable describes if and under what circumstances the cycling
2081 mechanism for TODO keywords will be replaced by a single-key, direct
2082 selection scheme.
2084 When nil, fast selection is never used.
2086 When the symbol `prefix', it will be used when `org-todo' is called with
2087 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2088 in an agenda buffer.
2090 When t, fast selection is used by default. In this case, the prefix
2091 argument forces cycling instead.
2093 In all cases, the special interface is only used if access keys have actually
2094 been assigned by the user, i.e. if keywords in the configuration are followed
2095 by a letter in parenthesis, like TODO(t)."
2103 "Non-nil means update todo statistics after insert and toggle.
2104 ALL-HEADLINES means update todo statistics by including headlines
2105 with no TODO keyword as well, counting them as not done.
2106 A list of TODO keywords means the same, but skip keywords that are
2107 not in this list.
2109 When this is set, todo statistics is updated in the parent of the
2110 current entry each time a todo state is changed."
2120 "Non-nil means TODO statistics covers just direct children.
2121 When nil, all entries in the subtree are considered.
2122 This has only an effect if `org-provide-todo-statistics' is set.
2123 To set this to nil for only a single subtree, use a COOKIE_DATA
2129 "Hook which is run after the state of a TODO item was changed.
2130 The new state (a string with a TODO keyword, or nil) is available in the
2131 Lisp variable `state'."
2136 "Hook for functions that are allowed to block a state change.
2138 Each function gets as its single argument a property list, see
2139 `org-trigger-hook' for more information about this list.
2141 If any of the functions in this hook returns nil, the state change
2145 "Hook for functions that are triggered by a state change.
2147 Each function gets as its single argument a property list with at least
2148 the following elements:
2150 (:type type-of-change :position pos-at-entry-start
2151 :from old-state :to new-state)
2153 Depending on the type, more properties may be present.
2155 This mechanism is currently implemented for:
2157 TODO state changes
2158 ------------------
2159 :type todo-state-change
2160 :from previous state (keyword as a string), or nil, or a symbol
2161 'todo' or 'done', to indicate the general type of state.
2165 "Non-nil means undone TODO entries will block switching the parent to DONE.
2166 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2167 be blocked if any prior sibling is not yet done.
2168 Finally, if the parent is blocked because of ordered siblings of its own,
2169 the child will also be blocked.
2170 This variable needs to be set before org.el is loaded, and you need to
2171 restart Emacs after a change to make the change effective. The only way
2172 to change is while Emacs is running is through the customize interface."
2184 "Non-nil means unchecked boxes will block switching the parent to DONE.
2185 When this is nil, checkboxes have no influence on switching TODO states.
2186 When non-nil, you first need to check off all check boxes before the TODO
2187 entry can be switched to DONE.
2188 This variable needs to be set before org.el is loaded, and you need to
2189 restart Emacs after a change to make the change effective. The only way
2190 to change is while Emacs is running is through the customize interface."
2202 "Non-nil means inserting a TODO heading is treated as state change.
2204 logging will apply if appropriate. When nil, the new TODO item will
2205 be inserted directly, and no logging will take place."
2210 "Non-nil means switching TODO states with S-cursor counts as state change.
2211 This is the default behavior. However, setting this to nil allows a
2212 convenient way to select a TODO state and bypass any logging associated
2213 with that."
2218 "Tag changes that should be triggered by TODO state changes.
2219 This is a list. Each entry is
2221 (state-change (tag . flag) .......)
2223 State-change can be a string with a state, and empty string to indicate the
2224 state that has no TODO keyword, or it can be one of the symbols `todo'
2225 or `done', meaning any not-done or done state, respectively."
2239 "Information to record when a task moves to the DONE state.
2241 Possible values are:
2243 nil Don't add anything, just change the keyword
2244 time Add a time stamp to the task
2245 note Prompt for a note and add it with template `org-log-note-headings'
2247 This option can also be set with on a per-file-basis with
2249 #+STARTUP: nologdone
2250 #+STARTUP: logdone
2251 #+STARTUP: lognotedone
2253 You can have local logging settings for a subtree by setting the LOGGING
2254 property to one or more of these keywords."
2262 ;; Normalize old uses of org-log-done.
2269 "Information to record when the scheduling date of a tasks is modified.
2271 Possible values are:
2273 nil Don't add anything, just change the date
2274 time Add a time stamp to the task
2275 note Prompt for a note and add it with template `org-log-note-headings'
2277 This option can also be set with on a per-file-basis with
2279 #+STARTUP: nologreschedule
2280 #+STARTUP: logreschedule
2281 #+STARTUP: lognotereschedule"
2290 "Information to record when the deadline date of a tasks is modified.
2292 Possible values are:
2294 nil Don't add anything, just change the date
2295 time Add a time stamp to the task
2296 note Prompt for a note and add it with template `org-log-note-headings'
2298 This option can also be set with on a per-file-basis with
2300 #+STARTUP: nologredeadline
2301 #+STARTUP: logredeadline
2302 #+STARTUP: lognoteredeadline
2304 You can have local logging settings for a subtree by setting the LOGGING
2305 property to one or more of these keywords."
2314 "Non-nil means record a note when clocking out of an item.
2315 This can also be configured on a per-file basis by adding one of
2316 the following lines anywhere in the buffer:
2318 #+STARTUP: lognoteclock-out
2319 #+STARTUP: nolognoteclock-out"
2325 "Non-nil means the CLOSED time stamp will contain date and time.
2326 When nil, only the date will be recorded."
2340 "Headings for notes added to entries.
2341 The value is an alist, with the car being a symbol indicating the note
2342 context, and the cdr is the heading to be used. The heading may also be the
2343 empty string.
2344 %t in the heading will be replaced by a time stamp.
2345 %T will be an active time stamp instead the default inactive one
2346 %s will be replaced by the new TODO state, in double quotes.
2347 %S will be replaced by the old TODO state, in double quotes.
2348 %u will be replaced by the user name.
2349 %U will be replaced by the full user name.
2351 In fact, it is not a good idea to change the `state' entry, because
2352 agenda log mode depends on the format of these entries."
2358 "Heading when changing todo state (todo sequence only)"
2372 "Non-nil means insert state change notes and time stamps into a drawer.
2373 When nil, state changes notes will be inserted after the headline and
2374 any scheduling and clock lines, but not inside a drawer.
2376 The value of this variable should be the name of the drawer to use.
2377 LOGBOOK is proposed at the default drawer for this purpose, you can
2378 also set this to a string to define the drawer of your choice.
2382 If this variable is set, `org-log-state-notes-insert-after-drawers'
2383 will be ignored.
2385 You can set the property LOG_INTO_DRAWER to overrule this setting for
2386 a subtree."
2398 "Return the value of `org-log-into-drawer', but let properties overrule.
2399 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2400 used instead of the default value."
2408 "Non-nil means insert state change notes after any drawers in entry.
2409 Only the drawers that *immediately* follow the headline and the
2410 deadline/scheduled line are skipped.
2411 When nil, insert notes right after the heading and perhaps the line
2412 with deadline/scheduling if present.
2414 This variable will have no effect if `org-log-into-drawer' is
2415 set."
2421 "Non-nil means the latest state note will be directly after heading.
2422 When nil, the state change notes will be ordered according to time."
2428 "The TODO state to which a repeater should return the repeating task.
2429 By default this is the first task in a TODO sequence, or the previous state
2430 in a TODO_TYP set. But you can specify another task here.
2431 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2437 "Non-nil means record moving through the DONE state when triggering repeat.
2438 An auto-repeating task is immediately switched back to TODO when
2441 record a closing note, there will be no record of the task moving
2442 through DONE. This variable forces taking a note anyway.
2444 nil Don't force a record
2445 time Record a time stamp
2446 note Record a note
2448 This option can also be set with on a per-file-basis with
2450 #+STARTUP: logrepeat
2451 #+STARTUP: lognoterepeat
2452 #+STARTUP: nologrepeat
2454 You can have local logging settings for a subtree by setting the LOGGING
2455 property to one or more of these keywords."
2465 "Priorities in Org-mode."
2470 "Non-nil means priority commands are active.
2471 When nil, these commands will be disabled, so that you never accidentally
2472 set a priority."
2477 "The highest priority of TODO items. A character like ?A, ?B etc.
2478 Must have a smaller ASCII number than `org-lowest-priority'."
2483 "The lowest priority of TODO items. A character like ?A, ?B etc.
2484 Must have a larger ASCII number than `org-highest-priority'."
2489 "The default priority of TODO items.
2490 This is the priority an item get if no explicit priority is given."
2495 "Non-nil means start with default priority when starting to cycle.
2496 When this is nil, the first step in the cycle will be (depending on the
2497 command used) one higher or lower that the default priority."
2502 "Function to extract the priority from a string.
2503 The string is normally the headline. If this is nil Org computes the
2504 priority from the priority cookie like [#A] in the headline. It returns
2505 an integer, increasing by 1000 for each priority level.
2506 The user can set a different function here, which should take a string
2507 as an argument and return the numeric priority."
2512 "Options concerning time stamps and deadlines in Org-mode."
2517 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2518 When nil, these labeled time stamps are forces into the second line of an
2519 entry, just after the headline. When scheduling from the global TODO list,
2520 the time stamp will always be forced into the second line."
2525 "Formats for `format-time-string' which are used for time stamps.
2529 "Number of minutes to round time stamps to.
2530 These are two values, the first applies when first creating a time stamp.
2531 The second applies when changing it with the commands `S-up' and `S-down'.
2532 When changing the time stamp, this means that it will change in steps
2533 of N minutes, as given by the second value.
2535 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2536 numbers should be factors of 60, so for example 5, 10, 15.
2538 When this is larger than 1, you can still force an exact time stamp by using
2539 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2540 and by using a prefix arg to `S-up/down' to specify the exact number
2541 of minutes to shift."
2551 ;; Normalize old customizations of this variable.
2555 org-time-stamp-rounding-minutes)))
2558 "Non-nil means overlay custom formats over all time stamps.
2559 The formats are defined through the variable `org-time-stamp-custom-formats'.
2560 To turn this on on a per-file basis, insert anywhere in the file:
2561 #+STARTUP: customtime"
2569 "Custom formats for time stamps. See `format-time-string' for the syntax.
2570 These are overlayed over the default ISO format if the variable
2571 `org-display-custom-times' is set. Time like %H:%M should be at the
2572 end of the second format. The custom formats are also honored by export
2573 commands, if custom time display is turned on at the time of export."
2578 "Get the right format for a time string."
2583 f)))
2586 "The format string used when creating CLOCKSUM lines.
2587 This is also used when org-mode generates a time duration."
2593 org-mode generates a time duration."
2598 "The format string used when creating CLOCKSUM lines, or when
2599 org-mode generates a time duration."
2604 "No. of days before expiration during which a deadline becomes active.
2605 This variable governs the display in sparse trees and in the agenda.
2606 When 0 or negative, it means use this number (the absolute value of it)
2607 even if a deadline has a different individual lead time specified.
2609 Custom commands can set this variable in the options section."
2615 "Non-nil means assume future for incomplete date input from user.
2616 This affects the following situations:
2617 1. The user gives a month but not a year.
2620 2. The user gives a day, but no month.
2623 it will be considered as *this* month.
2625 If you set this variable to the symbol `time', then also the following
2626 will work:
2628 3. If the user gives a time, but no day. If the time is before now,
2629 to will be interpreted as tomorrow.
2631 Currently none of this works for ISO week specifications.
2633 When this option is nil, the current day, month and year will always be
2634 used as defaults.
2636 See also `org-agenda-jump-prefer-future'."
2644 "Should the agenda jump command prefer the future for incomplete dates?
2645 The default is to do the same as configured in `org-read-date-prefer-future'.
2646 But you can also set a deviating value here.
2647 This may t or nil, or the symbol `org-read-date-prefer-future'."
2652 org-read-date-prefer-future)
2657 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2659 Depending on the system Emacs is running on, certain dates cannot
2660 be represented with the type used internally to represent time.
2661 Dates between 1970-1-1 and 2038-1-1 can always be represented
2662 correctly. Some systems allow for earlier dates, some for later,
2663 some for both. One way to find out it to insert any date into an
2664 Org buffer, putting the cursor on the year and hitting S-up and
2665 S-down to test the range.
2667 When this variable is set to t, the date/time prompt will not let
2668 you specify dates outside the 1970-2037 range, so it is certain that
2669 these dates will work in whatever version of Emacs you are
2670 running, and also that you can move a file from one Emacs implementation
2671 to another. WHenever Org is forcing the year for you, it will display
2672 a message and beep.
2674 When this variable is nil, Org will check if the date is
2675 representable in the specific Emacs implementation you are using.
2676 If not, it will force a year, usually the current year, and beep
2677 to remind you. Currently this setting is not recommended because
2678 the likelihood that you will open your Org files in an Emacs that
2679 has limited date range is not negligible.
2681 A workaround for this problem is to use diary sexp dates for time
2682 stamps outside of this range."
2687 "Non-nil means display current interpretation of date prompt live.
2688 This display will be in an overlay, in the minibuffer."
2693 "Non-nil means pop up a calendar when prompting for a date.
2694 In the calendar, the date can be selected with mouse-1. However, the
2695 minibuffer will also be active, and you can simply enter the date as well.
2696 When nil, only the minibuffer will be available."
2704 "Hook to be used to set up keys for the date/time interface.
2705 Add key definitions to `minibuffer-local-map', which will be a temporary
2706 copy."
2711 "The hour when your day really ends. Must be an integer.
2712 This has influence for the following applications:
2714 the time given here, the day recognized as TODAY is actually yesterday.
2715 - When a date is read from the user and it is still before the time given
2716 here, the current date and time will be assumed to be yesterday, 23:59.
2717 Also, timestamps inserted in remember templates follow this rule.
2719 IMPORTANT: This is a feature whose implementation is and likely will
2720 remain incomplete. Really, it is only here because past midnight seems to
2721 be the favorite working time of John Wiegley :-)"
2726 "Non-nil means S-down will increase the time in a time stamp.
2727 When nil, S-up will increase."
2732 "Non-nil means make the calendar window follow timestamp changes.
2733 When a timestamp is modified and the calendar window is visible, it will be
2734 moved to the new date."
2739 "Options concerning tags in Org-mode."
2744 "List of tags allowed in Org-mode files.
2745 When this list is nil, Org-mode will base TAG input on what is already in the
2746 buffer.
2747 The value of this variable is an alist, the car of each entry must be a
2748 keyword as a string, the cdr may be a character that is used to select
2749 that tag through the fast-tag-selection interface.
2750 See the manual for details."
2765 "List of tags that will always appear in all Org-mode files.
2766 This is in addition to any in buffer settings or customizations
2767 of `org-tag-alist'.
2768 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2769 The value of this variable is an alist, the car of each entry must be a
2770 keyword as a string, the cdr may be a character that is used to select
2771 that tag through the fast-tag-selection interface.
2772 See the manual for details.
2773 To disable these tags on a per-file basis, insert anywhere in the file:
2774 #+STARTUP: noptag"
2785 "If non-nil, always offer completion for all tags of all agenda files.
2786 Instead of customizing this variable directly, you might want to
2787 set it locally for capture buffers, because there no list of
2788 tags in that file can be created dynamically (there are none).
2790 (add-hook 'org-capture-mode-hook
2791 (lambda ()
2792 (set (make-local-variable
2793 'org-complete-tags-always-offer-all-agenda-tags)
2794 t)))"
2799 "List of tags that can be inherited by all entries in the file.
2800 The tags will be inherited if the variable `org-use-tag-inheritance'
2801 says they should be.
2805 "Non-nil means use fast tag selection scheme.
2806 This is a special interface to select and deselect tags with single keys.
2807 When nil, fast selection is never used.
2808 When the symbol `auto', fast selection is used if and only if selection
2809 characters for tags have been configured, either through the variable
2810 `org-tag-alist' or through a #+TAGS line in the buffer.
2811 When t, fast selection is always used and selection keys are assigned
2812 automatically if necessary."
2820 "Non-nil means fast tag selection exits after first change.
2821 When nil, you have to press RET to exit it.
2822 During fast tag selection, you can toggle this flag with `C-c'.
2823 This variable can also have the value `expert'. In this case, the window
2824 displaying the tags menu is not even shown, until you press C-c again."
2832 "Non-nil means fast tags selection interface will also offer TODO states.
2836 "The column to which tags should be indented in a headline.
2837 If this number is positive, it specifies the column. If it is negative,
2838 it means that the tags should be flushright to that column. For example,
2839 -80 works well for a normal 80 character screen."
2844 "Non-nil means realign tags after pro/demotion of TODO state change.
2845 These operations change the length of a headline and therefore shift
2846 the tags around. With this options turned on, after each such operation
2847 the tags are again aligned to `org-tags-column'."
2852 "Non-nil means tags in levels apply also for sublevels.
2853 When nil, only the tags directly given in a specific line apply there.
2854 This may also be a list of tags that should be inherited, or a regexp that
2855 matches tags that should be inherited. Additional control is possible
2856 with the variable `org-tags-exclude-from-inheritance' which gives an
2857 explicit list of tags to be excluded from inheritance., even if the value of
2858 `org-use-tag-inheritance' would select it for inheritance.
2860 If this option is t, a match early-on in a tree can lead to a large
2861 number of matches in the subtree when constructing the agenda or creating
2862 a sparse tree. If you only want to see the first match in a tree during
2863 a search, check out the variable `org-tags-match-list-sublevels'."
2872 "List of tags that should never be inherited.
2873 This is a way to exclude a few tags from inheritance. For way to do
2874 the opposite, to actively allow inheritance for selected tags,
2875 see the variable `org-use-tag-inheritance'."
2880 "Check if TAG is one that should be inherited."
2892 "Non-nil means list also sublevels of headlines matching a search.
2893 This variable applies to tags/property searches, and also to stuck
2894 projects because this search is based on a tags match as well.
2896 When set to the symbol `indented', sublevels are indented with
2897 leading dots.
2899 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2900 the sublevels of a headline matching a tag search often also match
2901 the same search. Listing all of them can create very long lists.
2902 Setting this variable to nil causes subtrees of a match to be skipped.
2904 This variable is semi-obsolete and probably should always be true. It
2905 is better to limit inheritance to certain tags using the variables
2906 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2914 "When set, tags are sorted using this function as a comparator."
2930 "Options concerning properties in Org-mode."
2935 "How property key/value pairs should be formatted by `indent-line'.
2936 When `indent-line' hits a property definition, it will format the line
2937 according to this format, mainly to make sure that the values are
2938 lined-up with respect to each other."
2943 "Non-nil means properties apply also for sublevels.
2945 This setting is chiefly used during property searches. Turning it on can
2946 cause significant overhead when doing a search, which is why it is not
2947 on by default.
2949 When nil, only the properties directly given in the current entry count.
2950 When t, every property is inherited. The value may also be a list of
2951 properties that should have inheritance, or a regular expression matching
2952 properties that should be inherited.
2954 However, note that some special properties use inheritance under special
2955 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
2957 for valid values of a property.
2959 Note for programmers:
2960 When querying an entry with `org-entry-get', you can control if inheritance
2961 should be used. By default, `org-entry-get' looks only at the local
2962 properties. You can request inheritance by setting the inherit argument
2963 to t (to force inheritance) or to `selective' (to respect the setting
2964 in this variable)."
2973 "Check if PROPERTY is one that should be inherited."
2984 "The default column format, if no other format has been defined.
2985 This variable can be set on the per-file basis by inserting a line
2987 #+COLUMNS: %25ITEM ....."
2992 "The ellipses to be used when a field in column view is truncated.
2993 When this is the empty string, as many characters as possible are shown,
2994 but then there will be no visual indication that the field has been truncated.
2995 When this is a string of length N, the last N characters of a truncated
2996 field are replaced by this string. If the column is narrower than the
2997 ellipses string, only part of the ellipses string will be shown."
3002 "Function that modifies values for display in column view.
3003 For example, it can be used to cut out a certain part from a time stamp.
3004 The function must take 2 arguments:
3006 column-title The title of the column (*not* the property name)
3007 value The value that should be modified.
3009 The function should return the value that should be displayed,
3010 or nil if the normal value should be used."
3015 "The property that is being used to keep track of effort estimates.
3016 Effort estimates given in this property need to have the format H:MM."
3024 "List of property/value pairs that can be inherited by any entry.
3026 These are fixed values, for the preset properties. The user variable
3027 that can be used to add to this list is `org-global-properties'.
3029 The entries in this list are cons cells where the car is a property
3030 name and cdr is a string with the value. If the value represents
3035 "List of property/value pairs that can be inherited by any entry.
3037 This list will be combined with the constant `org-global-properties-fixed'.
3039 The entries in this list are cons cells where the car is a property
3040 name and cdr is a string with the value.
3042 You can set buffer-local values for the same purpose in the variable
3043 `org-file-properties' this by adding lines like
3045 #+PROPERTY: NAME VALUE"
3052 "List of property/value pairs that can be inherited by any entry.
3053 Valid for the current buffer.
3058 "Options concerning agenda views in Org-mode."
3063 "Variable used by org files to set a category for agenda display.
3064 Such files should use a file variable to set it, for example
3068 or contain a special line
3070 #+CATEGORY: ELisp
3072 If the file does not specify a category, then file's base name
3078 "The files to be used for agenda display.
3082 If an entry is a directory, all files in that directory that are matched by
3083 `org-agenda-file-regexp' will be part of the file list.
3085 If the value of the variable is not a list but a single file name, then
3086 the list of agenda files is actually stored and maintained in that file, one
3087 agenda file per line. In this file paths can be given relative to
3088 `org-directory'. Tilde expansion and environment variable substitution
3089 are also made."
3096 "Regular expression to match files for `org-agenda-files'.
3097 If any element in the list in that variable contains a directory instead
3098 of a normal file, all files in that directory that are matched by this
3099 regular expression will be included."
3104 "List of extra files to be searched by text search commands.
3105 These files will be search in addition to the agenda files by the
3106 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3107 Note that these files will only be searched for text search commands,
3108 not for the other agenda views like todo lists, tag searches or the weekly
3109 agenda. This variable is intended to list notes and possibly archive files
3110 that should also be searched by these two commands.
3111 In fact, if the first element in the list is the symbol `agenda-archives',
3112 than all archive files of all agenda files will be added to the search
3113 scope."
3124 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3125 A nil value means to remove them, after a query, from the list."
3130 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3131 The command `org-calendar-goto-agenda' will be bound to this key. The
3132 default is the character `c' because then `c' can be used to switch back and
3133 forth between agenda and calendar."
3138 "The key to be installed in `calendar-mode-map' for agenda-action.
3139 The command `org-agenda-action' will be bound to this key. The
3140 default is the character `k' because we use the same key in the agenda."
3145 "The key to be installed in `calendar-mode-map' for adding diary entries.
3146 This option is irrelevant until `org-agenda-diary-file' has been configured
3147 to point to an Org-mode file. When that is the case, the command
3148 `org-agenda-diary-entry' will be bound to the key given here, by default
3149 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3150 if you want to continue doing this, you need to change this to a different
3151 key."
3156 "File to which to add new entries with the `i' key in agenda and calendar.
3157 When this is the symbol `diary-file', the functionality in the Emacs
3158 calendar will be used to add entries to the `diary-file'. But when this
3159 points to a file, `org-agenda-diary-entry' will be used instead."
3175 org-calendar-insert-diary-entry-key
3179 "Options for embedding LaTeX code into Org-mode."
3187 "Options for creating images from LaTeX fragments.
3188 This is a property list with the following properties:
3190 `default' means use the foreground of the default face.
3192 `default' means use the background of the default face.
3193 :scale a scaling factor for the size of the images, to get more pixels
3194 :html-foreground, :html-background, :html-scale
3195 the same numbers for HTML export.
3196 :matchers a list indicating which matchers should be used to
3197 find LaTeX fragments. Valid members of this list are:
3208 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3209 When nil, just push out a message."
3218 \[PACKAGES]
3219 \[DEFAULT-PACKAGES]
3220 % The settings below are copied from fullpage.sty
3233 "The document header used for processing LaTeX fragments.
3234 It is imperative that this header make sure that no page number
3235 appears on the page. The package defined in the variables
3236 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3238 will be appended."
3245 "Set the packages alist and make sure it has 3 elements per entry."
3249 x))
3250 val)))
3254 "Get the packages alist and make sure it has 3 elements per entry."
3258 x))
3261 ;; The following variables are defined here because is it also used
3262 ;; when formatting latex fragments. Originally it was part of the
3263 ;; LaTeX exporter, which is why the name includes "export".
3280 )
3281 "Alist of default packages to be inserted in the header.
3282 Change this only if one of the packages here causes an incompatibility
3283 with another package you are using.
3284 The packages in this list are needed by one part or another of Org-mode
3285 to function properly.
3287 - inputenc, fontenc: for basic font and character selection
3288 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3289 for interpreting the entities in `org-entities'. You can skip some of these
3290 packages if you don't use any of the symbols in it.
3291 - graphicx: for including images
3292 - float, wrapfig: for figure placement
3293 - longtable: for long tables
3294 - hyperref: for cross references
3296 Therefore you should not modify this variable unless you know what you
3297 are doing. The one reason to change it anyway is that you might be loading
3298 some other package that conflicts with one of the default packages.
3300 If SNIPPET-FLAG is t, the package also needs to be included when
3301 compiling LaTeX snippets into images for inclusion into HTML."
3314 "Alist of packages to be inserted in every LaTeX header.
3315 These will be inserted after `org-export-latex-default-packages-alist'.
3317 SNIPPET-FLAG, when t, indicates that this package is also needed when
3318 turning LaTeX snippets into images for inclusion into HTML.
3319 Make sure that you only list packages here which:
3320 - you want in every file
3321 - do not conflict with the default packages in
3322 `org-export-latex-default-packages-alist'
3323 - do not conflict with the setup in `org-format-latex-header'."
3337 "Settings for Org-mode appearance."
3342 "Non-nil means fontify only the stars in each headline.
3343 When nil, the entire headline is fontified.
3344 Changing it requires restart of `font-lock-mode' to become effective
3345 also in regions already fontified."
3350 "Non-nil means hide the first N-1 stars in a headline.
3351 This works by using the face `org-hide' for these stars. This
3352 face is white for a light background, and black for a dark
3353 background. You may have to customize the face `org-hide' to
3354 make this work.
3355 Changing it requires restart of `font-lock-mode' to become effective
3356 also in regions already fontified.
3357 You may also set this on a per-file basis by adding one of the following
3358 lines to the buffer:
3360 #+STARTUP: hidestars
3361 #+STARTUP: showstars"
3366 "List of symbols corresponding to keywords to be hidden the org buffer.
3367 For example, a value '(title) for this list will make the document's title
3368 appear in the buffer without the initial #+TITLE: keyword."
3376 "Non-nil means change the face of a headline if it is marked DONE.
3377 Normally, only the TODO/DONE keyword indicates the state of a headline.
3378 When this is non-nil, the headline after the keyword is set to the
3379 `org-headline-done' as an additional indication."
3384 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3385 Changing this variable requires a restart of Emacs to take effect."
3390 "Non-nil means fontify the whole line for headings.
3391 This is useful when setting a background color for the
3392 org-level-* faces."
3397 "Non-nil means fontify what is treated specially by the exporters."
3402 "Non-nil mean font-lock should hide the emphasis marker characters."
3407 "Non-nil means show entities as UTF8 characters.
3413 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3418 "Regular expression for matching emphasis.
3419 After a match, the match groups contain these elements:
3420 0 The match of the full regular expression, including the characters
3421 before and after the proper match
3422 1 The character before the proper match, or empty at beginning of line
3423 2 The proper match, including the leading and trailing markers
3424 3 The leading marker like * or /, indicating the type of highlighting
3425 4 The text between the emphasis markers, not including the markers
3432 "Set variable and compute the emphasis regular expression."
3436 org-emphasis-alist org-emphasis-regexp-components)
3448 ;; make sure special characters appear at the right position in the class
3460 ;; Make the regexp
3468 body1
3480 body1
3488 "Components used to build the regular expression for emphasis.
3489 This is a list with five entries. Terminology: In an emphasis string
3493 specify what is allowed/forbidden in each part:
3495 pre Chars allowed as prematch. Beginning of line will be allowed too.
3496 post Chars allowed as postmatch. End of line will be allowed too.
3497 border The chars *forbidden* as border characters.
3499 non-shy groups here, and don't allow newline here.
3500 newline The maximum number of newlines allowed in an emphasis exp.
3502 Use customize to modify this, or restart Emacs after changing it."
3521 )
3522 "Special syntax for emphasized text.
3523 Text starting and ending with a special character will be emphasized, for
3524 example *bold*, _underlined_ and /italic/. This variable sets the marker
3525 characters, the face to be used by font-lock for highlighting in Org-mode
3526 Emacs buffers, and the HTML tags to be used for this.
3527 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3528 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3529 Use customize to modify this, or restart Emacs after changing it."
3544 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3547 ;;; Miscellaneous options
3550 "Completion in Org-mode."
3555 "Non-nil means use ido completion wherever possible.
3556 Note that `ido-mode' must be active for this variable to be relevant.
3557 If you decide to turn this variable on, you might well want to turn off
3558 `org-outline-path-complete-in-steps'.
3559 See also `org-completion-use-iswitchb'."
3564 "Non-nil means use iswitchb completion wherever possible.
3565 Note that `iswitchb-mode' must be active for this variable to be relevant.
3566 If you decide to turn this variable on, you might well want to turn off
3567 `org-outline-path-complete-in-steps'.
3568 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3574 Normal means, no org-mode-specific context."
3578 ;;; Functions and variables from their packages
3579 ;; Declared here to avoid compiler warnings
3581 ;; XEmacs only
3587 ;; Emacs only
3590 ;; Various packages
3608 org-format-agenda-item "org-agenda"
3639 ;;; Autoload and prepare some org modules
3641 ;; Some table stuff that needs to be defined here, because it is used
3642 ;; by the functions setting up org-mode or checking for table context.
3655 "Detect the first line outside a table when searching from within it.
3658 ;; Autoload the functions in org-table.el that are needed by functions here.
3663 org-table-convert org-table-convert-region org-table-copy-down
3664 org-table-copy-region org-table-create
3665 org-table-create-or-convert-from-region
3666 org-table-create-with-table.el org-table-current-dline
3667 org-table-cut-region org-table-delete-column org-table-edit-field
3668 org-table-edit-formulas org-table-end org-table-eval-formula
3669 org-table-export org-table-field-info
3670 org-table-get-stored-formulas org-table-goto-column
3671 org-table-hline-and-move org-table-import org-table-insert-column
3672 org-table-insert-hline org-table-insert-row org-table-iterate
3673 org-table-justify-field-maybe org-table-kill-row
3674 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3675 org-table-move-column org-table-move-column-left
3676 org-table-move-column-right org-table-move-row
3677 org-table-move-row-down org-table-move-row-up
3678 org-table-next-field org-table-next-row org-table-paste-rectangle
3679 org-table-previous-field org-table-recalculate
3680 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3681 org-table-toggle-coordinate-overlays
3682 org-table-toggle-formula-debugger org-table-wrap-region
3683 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3684 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3685 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3688 "Return t if the cursor is inside an org-type table.
3689 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3694 org-table-line-regexp)))
3695 nil))
3699 "Return t if and only if we are at a table.el table."
3705 "If there is a table.el table nearby, recognize it and move into it."
3711 nil
3721 t
3726 t)
3727 nil)
3728 nil))
3731 "Return t if the cursor is inside a hline in a table."
3736 nil))
3741 "Apply FUNCTION to the start of all tables in the buffer."
3757 ;; Declare and autoload functions from org-exp.el & Co
3765 org-insert-export-options-template
3766 org-table-clean-before-export))
3769 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3770 org-export-region-as-ascii))
3773 org-replace-region-by-latex org-export-region-as-latex
3774 org-export-as-latex org-export-as-pdf
3775 org-export-as-pdf-and-open))
3778 org-export-as-html-batch org-export-as-html-to-buffer
3779 org-replace-region-by-html org-export-region-as-html
3780 org-export-as-html))
3783 org-replace-region-by-docbook org-export-region-as-docbook
3784 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3785 org-export-as-docbook))
3788 org-export-icalendar-all-agenda-files
3789 org-export-icalendar-combine-agenda-files))
3793 ;; Declare and autoload functions from org-agenda.el
3798 org-todo-list org-tags-view org-agenda-list-stuck-projects
3799 org-diary org-agenda-to-appt
3800 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3802 ;; Autoload org-remember
3807 org-remember-apply-template org-remember org-remember-handler)))
3812 org-capture-import-remember-templates)))
3814 ;; Autoload org-clock.el
3829 "Return non-nil if clock is currently running.
3830 The return value is actually the clock marker."
3835 "org-clock"
3837 org-clock-goto org-clock-sum org-clock-display
3838 org-clock-remove-overlays org-clock-report
3839 org-clocktable-shift org-dblock-write:clocktable
3840 org-get-clocktable org-resolve-clocks)))
3843 "If this is a CLOCK line, update it and return t.
3844 Otherwise, return nil."
3853 ts te h m s neg)
3856 nil)
3861 ;; The clock is running here
3882 t))))))
3885 "Check if the current buffer contains the running clock.
3886 If yes, offer to stop it and to save the buffer with the changes."
3895 "Check if this line starts a clock table, if yes, shift the time block."
3899 ;; Autoload org-timer.el
3903 "org-timer"
3905 org-timer-change-times-in-region
3906 org-timer-set-timer
3907 org-timer-reset-timers
3908 org-timer-show-remaining-time)))
3910 ;; Autoload org-feed.el
3914 "org-feed"
3918 ;; Autoload org-indent.el
3920 ;; Define the variable already here, to make sure we have it.
3922 "Non-nil if Org-Indent mode is enabled.
3927 "org-indent"
3930 ;; Autoload org-mobile.el
3934 "org-mobile"
3937 ;; Autoload archiving code
3938 ;; The stuff that is needed for cycling and tags has to be defined here.
3941 "Options concerning archiving in Org-mode."
3946 "The location where subtrees should be archived.
3948 The value of this variable is a string, consisting of two parts,
3949 separated by a double-colon. The first part is a filename and
3950 the second part is a headline.
3952 When the filename is omitted, archiving happens in the same file.
3953 %s in the filename will be replaced by the current file
3954 name (without the directory part). Archiving to a different file
3955 is useful to keep archived entries from contributing to the
3956 Org-mode Agenda.
3958 The archived entries will be filed as subtrees of the specified
3959 headline. When the headline is omitted, the subtrees are simply
3960 filed away at the end of the file, as top-level entries. Also in
3961 the heading you can use %s to represent the file name, this can be
3962 useful when using the same archive for a number of different files.
3964 Here are a few examples:
3966 If the current file is Projects.org, archive in file
3967 Projects.org_archive, as top-level trees. This is the default.
3970 Archive in the current file, under the top-level headline
3974 Archive in file ~/org/archive.org (absolute path), as top-level trees.
3977 Archive in file ~/org/archive.org (absolute path), under headlines
3981 Archive in file ./basement (relative path), as level 3 trees
3984 You may set this option on a per-file basis by adding to the buffer a
3985 line like
3987 #+ARCHIVE: basement::** Finished Tasks
3989 You may also define it locally for a subtree by setting an ARCHIVE property
3990 in the entry. If such a property is found in an entry, or anywhere up
3991 the hierarchy, it will be used."
3996 "The tag that marks a subtree as archived.
3997 An archived subtree does not open during visibility cycling, and does
3998 not contribute to the agenda listings.
3999 After changing this, font-lock must be restarted in the relevant buffers to
4000 get the proper fontification."
4006 "Non-nil means the agenda will skip any items located in archived trees.
4007 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4008 variable is no longer recommended, you should leave it at the value t.
4009 Instead, use the key `v' to cycle the archives-mode in the agenda."
4015 "Non-nil means ignore archived trees when creating column view."
4021 "Non-nil means `org-cycle' will open archived trees.
4022 An archived tree is a tree marked with the tag ARCHIVE.
4023 When nil, archived trees will stay folded. You can still open them with
4024 normal outline commands like `show-all', but not with the cycling commands."
4030 "Non-nil means sparse tree construction shows matches in archived trees.
4031 When nil, matches in these trees are highlighted, but the trees are kept in
4032 collapsed state."
4038 "Re-hide all archived subtrees after a visibility state change."
4049 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4052 "Cycle subtree even if it is archived."
4059 "Re-hide all archived subtrees after a visibility state change."
4074 flag)))
4081 org-archive-to-archive-sibling org-toggle-archive-tag
4082 org-archive-subtree-default
4083 org-archive-subtree-default-with-confirmation)))
4085 ;; Autoload Column View Code
4093 org-columns-compute org-agenda-columns org-columns-remove-overlays
4096 ;; Autoload ID code
4104 org-id-get-with-outline-path-completion
4105 org-id-get-with-outline-drilling org-id-store-link
4106 org-id-goto org-id-find org-id-store-link))
4108 ;; Autoload Plotting Code
4113 ;;; Variables for pre-computed regular expressions, all buffer local
4131 "Matches a headline and puts everything into groups:
4132 group 1: the stars
4133 group 2: The todo keyword, maybe
4134 group 3: Priority cookie
4135 group 4: True headline
4139 "Printf format to make regexp to match an exact headline.
4140 This regexp will match the headline of any node which hase the exact
4141 headline text that is put into the format, but may have any TODO state,
4145 "Matches a headline and puts TODO state into group 2 if present.
4200 "Regular expression to match a plain time or time range.
4201 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4202 groups carry important information:
4203 0 the full match
4204 1 the first time, range or not
4212 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4213 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4214 groups carry important information:
4215 0 the full match
4216 7 hours of duration
4225 "Regular expression to match a timestamp time or time range.
4226 After a match, the following groups carry important information:
4227 0 the full match
4228 1 date plus weekday, for back referencing to make sure both times are on the same day
4229 2 the first time, range or not
4284 "Variable associated with STARTUP options for org-mode.
4285 Each element is a list of three items: The startup options as written
4286 in the #+STARTUP line, the corresponding variable, and the value to
4287 set this variable to if the option is found. An optional forth element PUSH
4291 "Precompute regular expressions for current buffer."
4311 kwds kws0 kwsa key log value cat arch tags const links hw dws
4312 tail sep kws1 prio props ftags drawers beamer-p
4334 ;; general TODO-like setup
4346 links)))
4352 props)))
4357 ftags
4367 l var val)
4397 ))))
4414 ;; Process the TODO keywords
4416 ;; Use the global values as if they had been given locally.
4428 kws)))
4431 kwsa nil
4434 ;; 1 2
4442 kw)
4444 kws0)
4461 ;; Process the constants
4469 ;; Process the tags.
4480 tgs))
4488 ;; Compute the regular expressions and other local variables
4496 org-drawer-regexp
4500 org-not-done-keywords
4502 org-todo-regexp
4505 org-not-done-regexp
4509 org-not-done-heading-regexp
4513 org-todo-line-regexp
4517 org-complex-heading-regexp
4522 org-complex-heading-regexp-format
4531 org-nl-done-regexp
4535 org-todo-line-tags-regexp
4540 org-looking-at-done-regexp
4545 org-deadline-time-regexp
4547 org-deadline-line-regexp
4549 org-scheduled-regexp
4551 org-scheduled-time-regexp
4553 org-closed-time-regexp
4555 org-keyword-time-regexp
4561 org-keyword-time-not-clock-regexp
4567 org-maybe-keyword-time-regexp
4573 org-planning-or-clock-line-re
4578 org-all-time-keywords
4581 org-clock-string org-closed-string))
4582 )
4587 "Return the contents of FILE, as a string."
4601 "Extract the log state setting from a TODO keyword string.
4615 "Remove a pair of parenthesis at the end of each string in LIST."
4619 x))
4620 list))
4623 "Assign fast keys to a keyword-key alist.
4624 Respect keys that are already there."
4642 ;;; Some variables used in various places
4649 "Function to be called when `C-c C-c' is used.
4653 ;; FIXME: Occasionally check by commenting these, to make sure
4654 ;; no other functions uses these, forgetting to let-bind them.
4659 ;; Defined somewhere in this file, but used before definition.
4665 ;;;; Define the Org-mode
4668 (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"))
4671 ;; We use a before-change function to check if a table might need
4672 ;; an update.
4674 "Indicates that a table might need an update.
4675 This variable is set by `org-before-change-function'.
4678 "Every change indicates that a table might need an update."
4689 ;;;###autoload
4691 "Outline-based notes management and organizer, alias
4694 Org-mode develops organizational tasks around a NOTES file which
4695 contains information about projects as plain text. Org-mode is
4696 implemented on top of outline-mode, which is ideal to keep the content
4697 of large files well structured. It supports ToDo items, deadlines and
4698 time stamps, which magically appear in the diary listing of the Emacs
4699 calendar. Tables are easily created with a built-in table editor.
4700 Plain text URL-like links connect to websites, emails (VM), Usenet
4701 messages (Gnus), BBDB entries, and any files related to the project.
4702 For printing and sharing of notes, an Org-mode file (or a part of it)
4703 can be exported as a structured ASCII or HTML file.
4705 The following commands are available:
4709 ;; Get rid of Outline menus, they are not needed
4710 ;; Need to do this here because define-derived-mode sets up
4711 ;; the keymap so late. Still, it is a waste to call this each time
4712 ;; we switch another buffer into org-mode.
4715 ;; Assume this is Greg's port, it uses easymenu
4740 org-display-table 4
4743 org-ellipsis)))
4748 ;; tag faces set outside customize.... force initialization.
4750 ;; Calc embedded
4756 ;; Activate before-change-function
4760 ;; Check for running clock before killing a buffer
4762 ;; Paragraphs and auto-filling
4766 ;; Beginning/end of defun
4769 ;; Next error for sparse trees
4771 ;; Make sure dependence stuff works reliably, even for users who set it
4772 ;; too late :-(
4784 ;; Comment characters
4788 ;; Align options lines
4790 'align-mode-rules-list
4795 ;; Imenu
4799 ;; Make isearch reveal context
4802 ;; Emacs 21 and XEmacs make use of the hook
4804 ;; Emacs 22 deals with this through a special variable
4808 ;; Turn on org-beamer-mode?
4811 ;; Setup the pcomplete hooks
4822 ;; If empty file that did not turn on org-mode automatically, make it to.
4847 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
4857 "Return today date, considering `org-extend-today-until'."
4862 ;;;; Font-Lock stuff, including the activators
4893 "Regular expression used to analyze links.
4894 Here is what the match groups contain after a match:
4895 1: http:
4896 2: http
4897 3: path
4898 4: [desc]
4906 "Number of stacked braces for sub/superscript matching.
4907 This has to be set before loading org.el to be effective."
4912 "Create a regular expression which will match a balanced sexp.
4913 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
4914 as single character strings.
4915 The regexp returned will match the entire expression including the
4916 delimiters. It will also define a single group which contains the
4917 match except for the outermost delimiters. The maximum depth of
4918 stacked delimiters is N. Escaping delimiters is not possible."
4947 "Update the link regular expressions.
4948 This should be called after the variable `org-link-types' has changed."
4952 org-link-re-with-space
4958 org-link-re-with-space2
4964 org-link-re-with-space3
4969 org-angle-link-re
4975 org-plain-link-re
4979 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
4980 org-bracket-link-regexp
4982 org-bracket-link-analytic-regexp
4990 org-bracket-link-analytic-regexp++
4998 org-any-link-re
5007 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} [^]\r\n>]*?\\)[]>]"
5009 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5010 "Regular expression matching time strings for analysis.
5011 This one does not require the space after the date, so it can be used
5013 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) +\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5029 "Regular expression matching a time stamp or time stamp range.
5035 "Run through the buffer and add overlays to links."
5044 'face
5057 rtn))
5060 "Insert or change an emphasis, i.e. a font like bold or italic.
5061 If there is an active region, change that region to a new emphasis.
5062 If there is no region, just insert the marker characters and position
5063 the cursor between them.
5064 CHAR should be either the marker character, or the first character of the
5065 HTML tag associated with that emphasis. If CHAR is a space, the means
5066 to remove the emphasis of the selected region.
5067 If char is not given (for example in an interactive call) it
5068 will be prompted for."
5119 "Run through the buffer and add overlays to links."
5128 nil
5134 t)))))
5142 t)))
5145 "When non-nil, fontify code in code blocks."
5151 "Fontify #+ lines and blocks, in the correct ways."
5154 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5155 limit t)
5163 end end1 quoting block-type ovl)
5166 ;; a single line of backend-specific content
5174 ; for backend-specific code
5175 t)
5177 ;; Truly a block
5189 beg end
5193 ; for end_src
5197 ;; remove old background overlays
5202 ;; add a background overlay
5208 ; end of source block
5216 t))
5229 ;; just any other in-buffer setting, but not indented
5233 t)
5241 t)
5249 "Run through the buffer and add overlays to links."
5257 t)))
5260 "Run through the buffer and add overlays to links."
5262 limit t)
5267 'keymap org-mouse-map
5268 'help-echo
5270 "Footnote definition"
5272 ))
5274 t)))
5277 "Run through the buffer and add overlays to bracketed links."
5281 ;; FIXME: above we should remove the escapes.
5282 ;; but that requires another match, protecting match data,
5283 ;; a lot of overhead for font-lock.
5290 ;; We need to remove the invisible property here. Table narrowing
5291 ;; may have made some of this invisible.
5309 t)))
5312 "Run through the buffer and add overlays to dates."
5324 t)))
5333 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5337 "Run through the buffer and add overlays to target matches."
5345 'keymap org-mouse-map
5349 t)))))
5352 "Find all radio targets in this file and update the regular expression."
5367 t)))
5374 ;; This should be with the exporter code, but we also use if for font-locking
5384 "Compute regular expression for stuff treated specially by exporters."
5391 org-latex-regexps)))
5419 org-entities)))
5423 org-latex-entities)
5424 nil))
5426 ))
5427 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5430 org-export-html-special-string-regexps)))
5435 ))))
5437 'org-latex-and-specials-regexp
5442 "Run through the buffer and add overlays to links."
5446 limit t))
5460 rtn)))
5463 "Restart `font-lock-mode', to force refontification."
5469 "Return a list of all targets in this file.
5470 With optional argument RADIO, only find radio targets."
5472 rtn)
5477 rtn)))
5480 "Make regular expression matching all strings in TARGETS.
5481 The regular expression finds the targets also if there is a line break
5482 between words."
5491 x)
5492 targets
5504 t)))
5507 "Compute the outline level of the heading at point.
5508 This function assumes that the cursor is at the beginning of a line matched
5509 by `outline-regexp'. Otherwise it returns garbage.
5510 If this is called at a normal headline, the level is the number of stars.
5511 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5518 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5525 "Functions that can manipulate `org-font-lock-extra-keywords'.
5526 This is calles after `org-font-lock-extra-keywords' is defined, but before
5527 it is installed to be used by font lock. This can be useful if something
5538 ;; Call the hook
5540 ;; Headlines
5547 ;; Table lines
5550 ;; Table internals
5555 ;; Drawers
5558 ;; Properties
5562 ;; Links
5573 ;; TODO lines
5576 ;; DONE
5582 nil)
5583 ;; Priorities
5585 ;; Tags
5587 ;; Special keywords
5592 ;; Emphasis
5597 ;; Checkboxes
5598 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5603 ;; Description list items
5606 ;; ARCHIVEd headings
5609 ;; Specials
5613 ;; Code
5615 ;; COMMENT
5620 ;; Blocks and meta lines
5622 )))
5625 ;; Now set the full font-lock-keywords
5632 "Toggle the composition display of entities as UTF8 characters."
5644 "Find an entity to fontify."
5650 limit t)
5662 nil))))
5665 "Fontify string S like in Org-mode."
5677 "Get the right face for match N in font-lock matching of headlines."
5690 "Get the right face for a TODO keyword KWD.
5691 If KWD is a number, get the corresponding match group."
5699 "Create a face list that inherits INHERIT, but sets the foreground color.
5700 When FACE-OR-COLOR is not a string, just return it."
5704 face-or-color)
5705 face-or-color))
5708 "Add the special tag faces."
5717 "Add the special priority faces."
5724 org-priority-faces)))
5729 "Get the right face for a TODO keyword KWD.
5730 If KWD is a number, get the corresponding match group."
5737 "Remove fontification and activation overlays from links."
5742 deactivate-mark buffer-file-name buffer-file-truename)
5745 beg end
5747 ;; also remove line-prefix and wrap-prefix properties
5749 invisible t intangible t
5750 line-prefix t wrap-prefix t
5751 org-no-flyspell t org-emphasis t)
5753 invisible t intangible t
5754 org-no-flyspell t org-emphasis t)))
5764 "Remove specific display properties that have been added by font lock.
5765 The will remove the raise properties that are used to show superscripts
5766 and subscripts."
5776 "Add raise properties to sub/superscripts."
5780 org-match-substring-regexp
5781 org-match-substring-with-braces-regexp)
5782 limit t)
5792 ;; FIXME: Should we go back one character here, for a_b^c
5793 ;; (goto-char (1- pos)) ;????????????????????
5795 t
5797 'display
5813 t)))))
5815 ;;;; Visibility cycling, including org-goto and indirect buffer
5817 ;;; Cycling
5824 ;;;###autoload
5829 "TAB-action and visibility cycling for Org-mode.
5831 This is the command invoked in Org-mode by the TAB key. Its main purpose
5832 is outline visibility cycling, but it also invokes other actions
5833 in special contexts.
5835 - When this function is called with a prefix argument, rotate the entire
5836 buffer through 3 states (global cycling)
5837 1. OVERVIEW: Show only top-level headlines.
5838 2. CONTENTS: Show all headlines of all levels, but no body text.
5839 3. SHOW ALL: Show everything.
5840 When called with two `C-u C-u' prefixes, switch to the startup visibility,
5841 determined by the variable `org-startup-folded', and by any VISIBILITY
5842 properties in the buffer.
5843 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
5844 including any drawers.
5846 - When inside a table, re-align the table and move to the next field.
5848 - When point is at the beginning of a headline, rotate the subtree started
5849 by this line through 3 different states (local cycling)
5850 1. FOLDED: Only the main headline is shown.
5851 2. CHILDREN: The main headline and the direct children are shown.
5852 From this state, you can move to one of the children
5853 and zoom in further.
5854 3. SUBTREE: Show the entire subtree, including body text.
5855 If there is no subtree, switch directly from CHILDREN to FOLDED.
5857 - When point is at the beginning of an empty headline and the variable
5858 `org-cycle-level-after-item/entry-creation' is set, cycle the level
5859 of the headline by demoting and promoting it to likely levels. This
5860 speeds up creation document structure by pressing TAB once or several
5861 times right after creating a new headline.
5863 - When there is a numeric prefix, go up to a heading with level ARG, do
5864 a `show-subtree' and return to the previous cursor position. If ARG
5865 is negative, go up that many levels.
5867 - When point is not at the beginning of a headline, execute the global
5868 binding for TAB, which is re-indenting the line. See the option
5869 `org-cycle-emulate-tab' for details.
5871 - Special case: if point is at the beginning of the buffer and there is
5872 no headline in line 1, this function will act as if called with prefix arg
5873 (C-u TAB, same as S-TAB) also when called without prefix arg.
5874 But only if also the variable `org-cycle-global-at-bob' is t."
5884 org-inlinetask-min-level
5889 limit-level)))
5892 outline-regexp
5900 org-cycle-hook))
5904 ;; special case: use global cycling
5918 ;; Table: enter it or move to the next field.
5929 ;; Global cycling: delegate to `org-cycle-internal-global'.
5932 ;; Drawers: delegate to `org-flag-drawer'.
5940 ;; Show-subtree, ARG levels up from here.
5948 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
5954 ;; At an item/headline: delegate to `org-cycle-internal-local'.
5961 ;; From there: TAB emulation and template completion.
5985 t
5994 "Do the global cycling action."
5998 ;; We just created the overview - now do table of contents
5999 ;; This can be slow in very large buffers, so indicate action
6009 ;; We just showed the table of contents - now show everything
6017 ;; Default action: go to overview
6025 "Do the local cycling action."
6027 ;; First, determine end of headline (EOH), end of subtree or item
6028 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6052 ;; Determine end invisible part of buffer (EOL)
6054 ;; XEmacs doesn't have `next-single-char-property-change'
6064 ;; Find out what to do next and set `this-command'
6067 ;; Nothing is hidden behind this heading
6079 org-cycle-skip-children-state-if-no-children))))
6080 ;; Entire subtree is hidden in one line: children view
6086 ;; Fold every list in subtree to top-level items.
6108 ;; We just showed the children, or no children are there,
6109 ;; now show everything.
6116 ;; Default action: hide the subtree.
6123 ;;;###autoload
6125 "Cycle the global visibility. For details see `org-cycle'.
6127 With a numeric prefix, show all headlines up to that level."
6143 "Set the visibility required by startup options and properties."
6158 "Switch subtree visibilities according to :VISIBILITY: property."
6165 nil t)
6190 "Switch to overview mode, showing only top-level headlines.
6191 Really, this shows all headlines with level equal or greater than the level
6192 of the first headline in the buffer. This is important, because if the
6193 first headline is not level one, then (hide-sublevels 1) gives confusing
6194 results."
6205 "Show all headlines in the buffer, like a table of contents.
6206 With numerical argument N, show content up to level N."
6209 ;; Visit all headings and show their offspring
6216 t)
6225 "Adjust the window after a change in outline visibility.
6226 This function is the default value of the hook `org-cycle-hook'."
6236 "Remove outline overlays that do not contain non-white stuff."
6246 "Fix visibility issues after moving a subtree."
6247 ;; First, find a reasonable region to look at:
6248 ;; Start two siblings above, end three below
6266 ;; Properly fold already folded siblings
6277 "Show empty lines above all visible headlines.
6278 The region to be covered depends on STATE when called through
6279 `org-cycle-hook'. Lisp program can use t for STATE to get the
6280 entire buffer covered. Note that an empty line is only shown if there
6281 are at least `org-cycle-separator-lines' empty lines before the headline."
6291 beg end b e)
6315 ;; Never hide empty lines at the end of the file.
6325 "Move to the parent and re-show empty lines before visible headlines."
6331 "Return `org-agenda-files' list, plus all open org-mode files.
6332 This is useful for operations that need to scan all of a user's
6333 open and agenda-wise Org files."
6341 files))
6344 "Return the beginning position of the current entry."
6348 "Return the end position of the current entry."
6352 "Re-hide all drawers after a visibility state change."
6379 "Is the end of the current subtree visible?"
6384 "Move cursor to the first headline and recenter the headline.
6385 Optional argument N means put the headline into the Nth line of the window."
6391 ;;; Saving and restoring visibility
6394 "Return a list of the locations of all outline overlays.
6395 These are overlays with the `invisible' property value `outline'.
6396 The return value is a list of cons cells, with start and stop
6397 positions for each overlay.
6398 If USE-MARKERS is set, return the positions as markers."
6416 "Create visibility overlays for all positions in DATA.
6417 DATA should have been made by `org-outline-overlay-data'."
6426 data)))))
6428 ;;; Folding of blocks
6439 "Call FUNCTION at the head of all source blocks in the current buffer.
6440 Optional arguments START and END can be used to limit the range."
6452 "Toggle the visibility of all blocks in the current buffer."
6456 "Fold all blocks in the current buffer."
6462 "Unfold all blocks in the current buffer."
6468 "Toggle visibility of block at point."
6479 "Toggle the visibility of the current block."
6486 ov)
6502 ;; make the block accessible to isearch
6504 ov 'isearch-open-invisible
6515 ;; org-tab-after-check-for-cycling-hook
6517 ;; Remove overlays when changing major mode
6522 ;;; Org-goto
6528 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6544 nil)
6545 (org-defkey map "q" 'org-goto-quit)
6546 (org-defkey map "n" 'outline-next-visible-heading)
6547 (org-defkey map "p" 'outline-previous-visible-heading)
6548 (org-defkey map "f" 'outline-forward-same-level)
6549 (org-defkey map "b" 'outline-backward-same-level)
6550 (org-defkey map "u" 'outline-up-heading))
6551 (org-defkey map "/" 'org-occur)
6552 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6553 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6554 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6555 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6556 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6557 map))
6559 (defconst org-goto-help
6560 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6561 RET=jump to location [Q]uit and return to previous location
6562 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6564 (defvar org-goto-start-pos) ; dynamically scoped parameter
6566 ;; FIXME: Docstring does not mention both interfaces
6567 (defun org-goto (&optional alternative-interface)
6568 "Look up a different location in the current file, keeping current visibility.
6570 When you want look-up or go to a different location in a document, the
6571 fastest way is often to fold the entire buffer and then dive into the tree.
6572 This method has the disadvantage, that the previous location will be folded,
6573 which may not be what you want.
6575 This command works around this by showing a copy of the current buffer
6576 in an indirect buffer, in overview mode. You can dive into the tree in
6577 that copy, use org-occur and incremental search to find a location.
6578 When pressing RET or `Q', the command returns to the original buffer in
6579 which the visibility is still unchanged. After RET is will also jump to
6580 the location selected in the indirect buffer and expose the
6581 the headline hierarchy above."
6582 (interactive "P")
6583 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6584 (org-refile-use-outline-path t)
6585 (org-refile-target-verify-function nil)
6586 (interface
6587 (if (not alternative-interface)
6588 org-goto-interface
6589 (if (eq org-goto-interface 'outline)
6590 'outline-path-completion
6591 'outline)))
6592 (org-goto-start-pos (point))
6593 (selected-point
6594 (if (eq interface 'outline)
6595 (car (org-get-location (current-buffer) org-goto-help))
6596 (let ((pa (org-refile-get-location "Goto")))
6597 (org-refile-check-position pa)
6598 (nth 3 pa)))))
6599 (if selected-point
6600 (progn
6601 (org-mark-ring-push org-goto-start-pos)
6602 (goto-char selected-point)
6603 (if (or (outline-invisible-p) (org-invisible-p2))
6604 (org-show-context 'org-goto)))
6605 (message "Quit"))))
6607 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6608 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6609 (defvar org-goto-local-auto-isearch-map) ; defined below
6611 (defun org-get-location (buf help)
6612 "Let the user select a location in the Org-mode buffer BUF.
6613 This function uses a recursive edit. It returns the selected position
6614 or nil."
6615 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6616 (isearch-hide-immediately nil)
6617 (isearch-search-fun-function
6618 (lambda () 'org-goto-local-search-headings))
6619 (org-goto-selected-point org-goto-exit-command)
6620 (pop-up-frames nil)
6621 (special-display-buffer-names nil)
6622 (special-display-regexps nil)
6623 (special-display-function nil))
6624 (save-excursion
6625 (save-window-excursion
6626 (delete-other-windows)
6627 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6628 (switch-to-buffer
6629 (condition-case nil
6630 (make-indirect-buffer (current-buffer) "*org-goto*")
6631 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6632 (with-output-to-temp-buffer "*Help*"
6633 (princ help))
6634 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6635 (setq buffer-read-only nil)
6636 (let ((org-startup-truncated t)
6637 (org-startup-folded nil)
6638 (org-startup-align-all-tables nil))
6639 (org-mode)
6640 (org-overview))
6641 (setq buffer-read-only t)
6642 (if (and (boundp 'org-goto-start-pos)
6643 (integer-or-marker-p org-goto-start-pos))
6644 (let ((org-show-hierarchy-above t)
6645 (org-show-siblings t)
6646 (org-show-following-heading t))
6647 (goto-char org-goto-start-pos)
6648 (and (outline-invisible-p) (org-show-context)))
6649 (goto-char (point-min)))
6650 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6651 (message "Select location and press RET")
6652 (use-local-map org-goto-map)
6653 (recursive-edit)
6654 ))
6655 (kill-buffer "*org-goto*")
6656 (cons org-goto-selected-point org-goto-exit-command)))
6658 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6659 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6660 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6661 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6663 (defun org-goto-local-search-headings (string bound noerror)
6664 "Search and make sure that any matches are in headlines."
6665 (catch 'return
6666 (while (if isearch-forward
6667 (search-forward string bound noerror)
6668 (search-backward string bound noerror))
6669 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6670 (and (member :headline context)
6671 (not (member :tags context))))
6672 (throw 'return (point))))))
6674 (defun org-goto-local-auto-isearch ()
6675 "Start isearch."
6676 (interactive)
6677 (goto-char (point-min))
6678 (let ((keys (this-command-keys)))
6679 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6680 (isearch-mode t)
6681 (isearch-process-search-char (string-to-char keys)))))
6683 (defun org-goto-ret (&optional arg)
6684 "Finish `org-goto' by going to the new location."
6685 (interactive "P")
6686 (setq org-goto-selected-point (point)
6687 org-goto-exit-command 'return)
6688 (throw 'exit nil))
6690 (defun org-goto-left ()
6691 "Finish `org-goto' by going to the new location."
6692 (interactive)
6693 (if (org-on-heading-p)
6694 (progn
6695 (beginning-of-line 1)
6696 (setq org-goto-selected-point (point)
6697 org-goto-exit-command 'left)
6698 (throw 'exit nil))
6699 (error "Not on a heading")))
6701 (defun org-goto-right ()
6702 "Finish `org-goto' by going to the new location."
6703 (interactive)
6704 (if (org-on-heading-p)
6705 (progn
6706 (setq org-goto-selected-point (point)
6707 org-goto-exit-command 'right)
6708 (throw 'exit nil))
6709 (error "Not on a heading")))
6711 (defun org-goto-quit ()
6712 "Finish `org-goto' without cursor motion."
6713 (interactive)
6714 (setq org-goto-selected-point nil)
6715 (setq org-goto-exit-command 'quit)
6716 (throw 'exit nil))
6718 ;;; Indirect buffer display of subtrees
6720 (defvar org-indirect-dedicated-frame nil
6721 "This is the frame being used for indirect tree display.")
6722 (defvar org-last-indirect-buffer nil)
6724 (defun org-tree-to-indirect-buffer (&optional arg)
6725 "Create indirect buffer and narrow it to current subtree.
6726 With numerical prefix ARG, go up to this level and then take that tree.
6727 If ARG is negative, go up that many levels.
6728 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6729 indirect buffer previously made with this command, to avoid proliferation of
6730 indirect buffers. However, when you call the command with a \
6732 when `org-indirect-buffer-display' is `new-frame', the last buffer
6733 is kept so that you can work with several indirect buffers at the same time.
6734 If `org-indirect-buffer-display' is `dedicated-frame', the \
6736 requests that a new frame be made for the new buffer, so that the dedicated
6737 frame is not changed."
6738 (interactive "P")
6739 (let ((cbuf (current-buffer))
6740 (cwin (selected-window))
6741 (pos (point))
6742 beg end level heading ibuf)
6743 (save-excursion
6744 (org-back-to-heading t)
6745 (when (numberp arg)
6746 (setq level (org-outline-level))
6747 (if (< arg 0) (setq arg (+ level arg)))
6748 (while (> (setq level (org-outline-level)) arg)
6749 (outline-up-heading 1 t)))
6750 (setq beg (point)
6751 heading (org-get-heading))
6752 (org-end-of-subtree t t)
6753 (if (org-on-heading-p) (backward-char 1))
6754 (setq end (point)))
6755 (if (and (buffer-live-p org-last-indirect-buffer)
6756 (not (eq org-indirect-buffer-display 'new-frame))
6757 (not arg))
6758 (kill-buffer org-last-indirect-buffer))
6759 (setq ibuf (org-get-indirect-buffer cbuf)
6760 org-last-indirect-buffer ibuf)
6761 (cond
6762 ((or (eq org-indirect-buffer-display 'new-frame)
6763 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6764 (select-frame (make-frame))
6765 (delete-other-windows)
6766 (switch-to-buffer ibuf)
6767 (org-set-frame-title heading))
6768 ((eq org-indirect-buffer-display 'dedicated-frame)
6769 (raise-frame
6770 (select-frame (or (and org-indirect-dedicated-frame
6771 (frame-live-p org-indirect-dedicated-frame)
6772 org-indirect-dedicated-frame)
6773 (setq org-indirect-dedicated-frame (make-frame)))))
6774 (delete-other-windows)
6775 (switch-to-buffer ibuf)
6776 (org-set-frame-title (concat "Indirect: " heading)))
6777 ((eq org-indirect-buffer-display 'current-window)
6778 (switch-to-buffer ibuf))
6779 ((eq org-indirect-buffer-display 'other-window)
6780 (pop-to-buffer ibuf))
6781 (t (error "Invalid value")))
6782 (if (featurep 'xemacs)
6783 (save-excursion (org-mode) (turn-on-font-lock)))
6784 (narrow-to-region beg end)
6785 (show-all)
6786 (goto-char pos)
6787 (and (window-live-p cwin) (select-window cwin))))
6789 (defun org-get-indirect-buffer (&optional buffer)
6790 (setq buffer (or buffer (current-buffer)))
6791 (let ((n 1) (base (buffer-name buffer)) bname)
6792 (while (buffer-live-p
6793 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
6794 (setq n (1+ n)))
6795 (condition-case nil
6796 (make-indirect-buffer buffer bname 'clone)
6797 (error (make-indirect-buffer buffer bname)))))
6799 (defun org-set-frame-title (title)
6800 "Set the title of the current frame to the string TITLE."
6801 ;; FIXME: how to name a single frame in XEmacs???
6802 (unless (featurep 'xemacs)
6803 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
6805 ;;;; Structure editing
6807 ;;; Inserting headlines
6809 (defun org-previous-line-empty-p ()
6810 (save-excursion
6811 (and (not (bobp))
6812 (or (beginning-of-line 0) t)
6813 (save-match-data
6816 (defun org-insert-heading (&optional force-heading invisible-ok)
6817 "Insert a new heading or item with same depth at point.
6818 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
6819 If point is at the beginning of a headline, insert a sibling before the
6820 current headline. If point is not at the beginning, split the line,
6821 create the new headline with the text in the current line after point
6822 \(but see also the variable `org-M-RET-may-split-line').
6824 When INVISIBLE-OK is set, stop at invisible headlines when going back.
6825 This is important for non-interactive uses of the command."
6826 (interactive "P")
6827 (if (or (= (buffer-size) 0)
6828 (and (not (save-excursion
6829 (and (ignore-errors (org-back-to-heading invisible-ok))
6830 (org-on-heading-p))))
6831 (not (org-in-item-p))))
6832 (progn
6834 (run-hooks 'org-insert-heading-hook))
6835 (when (or force-heading (not (org-insert-item)))
6836 (let* ((empty-line-p nil)
6837 (level nil)
6838 (on-heading (org-on-heading-p))
6839 (head (save-excursion
6840 (condition-case nil
6841 (progn
6842 (org-back-to-heading invisible-ok)
6843 (when (and (not on-heading)
6844 (featurep 'org-inlinetask)
6845 (integerp org-inlinetask-min-level)
6846 (>= (length (match-string 0))
6847 org-inlinetask-min-level))
6848 ;; Find a heading level before the inline task
6849 (while (and (setq level (org-up-heading-safe))
6850 (>= level org-inlinetask-min-level)))
6851 (if (org-on-heading-p)
6852 (org-back-to-heading invisible-ok)
6853 (error "This should not happen")))
6854 (setq empty-line-p (org-previous-line-empty-p))
6855 (match-string 0))
6856 (error "*"))))
6857 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
6858 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
6859 pos hide-previous previous-pos)
6860 (cond
6861 ((and (org-on-heading-p) (bolp)
6862 (or (bobp)
6863 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
6864 ;; insert before the current line
6865 (open-line (if blank 2 1)))
6866 ((and (bolp)
6867 (not org-insert-heading-respect-content)
6868 (or (bobp)
6869 (save-excursion
6870 (backward-char 1) (not (outline-invisible-p)))))
6871 ;; insert right here
6872 nil)
6873 (t
6874 ;; somewhere in the line
6875 (save-excursion
6876 (setq previous-pos (point-at-bol))
6877 (end-of-line)
6878 (setq hide-previous (outline-invisible-p)))
6879 (and org-insert-heading-respect-content (org-show-subtree))
6880 (let ((split
6881 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
6882 (save-excursion
6883 (let ((p (point)))
6884 (goto-char (point-at-bol))
6885 (and (looking-at org-complex-heading-regexp)
6886 (> p (match-beginning 4)))))))
6887 tags pos)
6888 (cond
6889 (org-insert-heading-respect-content
6890 (org-end-of-subtree nil t)
6891 (when (featurep 'org-inlinetask)
6892 (while (and (not (eobp))
6894 (>= (length (match-string 1))
6895 org-inlinetask-min-level))
6896 (org-end-of-subtree nil t)))
6897 (or (bolp) (newline))
6898 (or (org-previous-line-empty-p)
6899 (and blank (newline)))
6900 (open-line 1))
6901 ((org-on-heading-p)
6902 (when hide-previous
6903 (show-children)
6904 (org-show-entry))
6906 (setq tags (and (match-end 2) (match-string 2)))
6907 (and (match-end 1)
6908 (delete-region (match-beginning 1) (match-end 1)))
6909 (setq pos (point-at-bol))
6910 (or split (end-of-line 1))
6911 (delete-horizontal-space)
6913 (buffer-substring (point-at-bol) (point)))
6914 (insert " "))
6915 (newline (if blank 2 1))
6916 (when tags
6917 (save-excursion
6918 (goto-char pos)
6919 (end-of-line 1)
6920 (insert " " tags)
6921 (org-set-tags nil 'align))))
6922 (t
6923 (or split (end-of-line 1))
6924 (newline (if blank 2 1)))))))
6925 (insert head) (just-one-space)
6926 (setq pos (point))
6927 (end-of-line 1)
6928 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
6929 (when (and org-insert-heading-respect-content hide-previous)
6930 (save-excursion
6931 (goto-char previous-pos)
6932 (hide-subtree)))
6933 (run-hooks 'org-insert-heading-hook)))))
6935 (defun org-get-heading (&optional no-tags)
6936 "Return the heading of the current entry, without the stars."
6937 (save-excursion
6938 (org-back-to-heading t)
6939 (if (looking-at
6940 (if no-tags
6943 (match-string 1) "")))
6945 (defun org-heading-components ()
6946 "Return the components of the current heading.
6947 This is a list with the following elements:
6948 - the level as an integer
6949 - the reduced level, different if `org-odd-levels-only' is set.
6950 - the TODO keyword, or nil
6951 - the priority character, like ?A, or nil if no priority is given
6952 - the headline text itself, or the tags string if no headline text
6953 - the tags string, or nil."
6954 (save-excursion
6955 (org-back-to-heading t)
6956 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
6957 (list (length (match-string 1))
6958 (org-reduced-level (length (match-string 1)))
6959 (org-match-string-no-properties 2)
6960 (and (match-end 3) (aref (match-string 3) 2))
6961 (org-match-string-no-properties 4)
6962 (org-match-string-no-properties 5)))))
6964 (defun org-get-entry ()
6965 "Get the entry text, after heading, entire subtree."
6966 (save-excursion
6967 (org-back-to-heading t)
6968 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
6970 (defun org-insert-heading-after-current ()
6971 "Insert a new heading with same level as current, after current subtree."
6972 (interactive)
6973 (org-back-to-heading)
6974 (org-insert-heading)
6975 (org-move-subtree-down)
6976 (end-of-line 1))
6978 (defun org-insert-heading-respect-content ()
6979 (interactive)
6980 (let ((org-insert-heading-respect-content t))
6981 (org-insert-heading t)))
6983 (defun org-insert-todo-heading-respect-content (&optional force-state)
6984 (interactive "P")
6985 (let ((org-insert-heading-respect-content t))
6986 (org-insert-todo-heading force-state t)))
6988 (defun org-insert-todo-heading (arg &optional force-heading)
6989 "Insert a new heading with the same level and TODO state as current heading.
6990 If the heading has no TODO state, or if the state is DONE, use the first
6991 state (TODO by default). Also with prefix arg, force first state."
6992 (interactive "P")
6993 (when (or force-heading (not (org-insert-item 'checkbox)))
6994 (org-insert-heading force-heading)
6995 (save-excursion
6996 (org-back-to-heading)
6997 (outline-previous-heading)
6998 (looking-at org-todo-line-regexp))
6999 (let*
7000 ((new-mark-x
7001 (if (or arg
7002 (not (match-beginning 2))
7003 (member (match-string 2) org-done-keywords))
7004 (car org-todo-keywords-1)
7005 (match-string 2)))
7006 (new-mark
7007 (or
7008 (run-hook-with-args-until-success
7009 'org-todo-get-default-hook new-mark-x nil)
7010 new-mark-x)))
7011 (beginning-of-line 1)
7013 (if org-treat-insert-todo-heading-as-state-change
7014 (org-todo new-mark)
7015 (insert new-mark " "))))
7016 (when org-provide-todo-statistics
7017 (org-update-parent-todo-statistics))))
7019 (defun org-insert-subheading (arg)
7020 "Insert a new subheading and demote it.
7021 Works for outline headings and for plain lists alike."
7022 (interactive "P")
7023 (org-insert-heading arg)
7024 (cond
7025 ((org-on-heading-p) (org-do-demote))
7026 ((org-at-item-p) (org-indent-item))))
7028 (defun org-insert-todo-subheading (arg)
7029 "Insert a new subheading with TODO keyword or checkbox and demote it.
7030 Works for outline headings and for plain lists alike."
7031 (interactive "P")
7032 (org-insert-todo-heading arg)
7033 (cond
7034 ((org-on-heading-p) (org-do-demote))
7035 ((org-at-item-p) (org-indent-item))))
7037 ;;; Promotion and Demotion
7039 (defvar org-after-demote-entry-hook nil
7040 "Hook run after an entry has been demoted.
7041 The cursor will be at the beginning of the entry.
7042 When a subtree is being demoted, the hook will be called for each node.")
7044 (defvar org-after-promote-entry-hook nil
7045 "Hook run after an entry has been promoted.
7046 The cursor will be at the beginning of the entry.
7047 When a subtree is being promoted, the hook will be called for each node.")
7049 (defun org-promote-subtree ()
7050 "Promote the entire subtree.
7051 See also `org-promote'."
7052 (interactive)
7053 (save-excursion
7054 (org-with-limited-levels (org-map-tree 'org-promote)))
7055 (org-fix-position-after-promote))
7057 (defun org-demote-subtree ()
7058 "Demote the entire subtree. See `org-demote'.
7059 See also `org-promote'."
7060 (interactive)
7061 (save-excursion
7062 (org-with-limited-levels (org-map-tree 'org-demote)))
7063 (org-fix-position-after-promote))
7066 (defun org-do-promote ()
7067 "Promote the current heading higher up the tree.
7068 If the region is active in `transient-mark-mode', promote all headings
7069 in the region."
7070 (interactive)
7071 (save-excursion
7072 (if (org-region-active-p)
7073 (org-map-region 'org-promote (region-beginning) (region-end))
7074 (org-promote)))
7075 (org-fix-position-after-promote))
7077 (defun org-do-demote ()
7078 "Demote the current heading lower down the tree.
7079 If the region is active in `transient-mark-mode', demote all headings
7080 in the region."
7081 (interactive)
7082 (save-excursion
7083 (if (org-region-active-p)
7084 (org-map-region 'org-demote (region-beginning) (region-end))
7085 (org-demote)))
7086 (org-fix-position-after-promote))
7088 (defun org-fix-position-after-promote ()
7089 "Make sure that after pro/demotion cursor position is right."
7090 (let ((pos (point)))
7091 (when (save-excursion
7092 (beginning-of-line 1)
7093 (looking-at org-todo-line-regexp)
7094 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7095 (cond ((eobp) (insert " "))
7096 ((eolp) (insert " "))
7097 ((equal (char-after) ?\ ) (forward-char 1))))))
7099 (defun org-current-level ()
7100 "Return the level of the current entry, or nil if before the first headline.
7101 The level is the number of stars at the beginning of the headline."
7102 (save-excursion
7103 (org-with-limited-levels
7104 (ignore-errors
7105 (org-back-to-heading t)
7106 (funcall outline-level)))))
7108 (defun org-get-previous-line-level ()
7109 "Return the outline depth of the last headline before the current line.
7110 Returns 0 for the first headline in the buffer, and nil if before the
7111 first headline."
7112 (let ((current-level (org-current-level))
7113 (prev-level (when (> (line-number-at-pos) 1)
7114 (save-excursion
7115 (beginning-of-line 0)
7116 (org-current-level)))))
7117 (cond ((null current-level) nil) ; Before first headline
7118 ((null prev-level) 0) ; At first headline
7119 (prev-level))))
7121 (defun org-reduced-level (l)
7122 "Compute the effective level of a heading.
7123 This takes into account the setting of `org-odd-levels-only'."
7124 (if org-odd-levels-only (1+ (floor (/ l 2))) l))
7126 (defun org-level-increment ()
7127 "Return the number of stars that will be added or removed at a
7128 time to headlines when structure editing, based on the value of
7129 `org-odd-levels-only'."
7130 (if org-odd-levels-only 2 1))
7132 (defun org-get-valid-level (level &optional change)
7133 "Rectify a level change under the influence of `org-odd-levels-only'
7134 LEVEL is a current level, CHANGE is by how much the level should be
7135 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7136 even level numbers will become the next higher odd number."
7137 (if org-odd-levels-only
7138 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7139 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7140 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7141 (max 1 (+ level (or change 0)))))
7143 (if (boundp 'define-obsolete-function-alias)
7144 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7145 (define-obsolete-function-alias 'org-get-legal-level
7146 'org-get-valid-level)
7147 (define-obsolete-function-alias 'org-get-legal-level
7148 'org-get-valid-level "23.1")))
7150 (defun org-promote ()
7151 "Promote the current heading higher up the tree.
7152 If the region is active in `transient-mark-mode', promote all headings
7153 in the region."
7154 (org-back-to-heading t)
7155 (let* ((level (save-match-data (funcall outline-level)))
7156 (after-change-functions (remove 'flyspell-after-change-function
7157 after-change-functions))
7158 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7159 (diff (abs (- level (length up-head) -1))))
7160 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7161 (replace-match up-head nil t)
7162 ;; Fixup tag positioning
7163 (and org-auto-align-tags (org-set-tags nil t))
7164 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7165 (run-hooks 'org-after-promote-entry-hook)))
7167 (defun org-demote ()
7168 "Demote the current heading lower down the tree.
7169 If the region is active in `transient-mark-mode', demote all headings
7170 in the region."
7171 (org-back-to-heading t)
7172 (let* ((level (save-match-data (funcall outline-level)))
7173 (after-change-functions (remove 'flyspell-after-change-function
7174 after-change-functions))
7175 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7176 (diff (abs (- level (length down-head) -1))))
7177 (replace-match down-head nil t)
7178 ;; Fixup tag positioning
7179 (and org-auto-align-tags (org-set-tags nil t))
7180 (if org-adapt-indentation (org-fixup-indentation diff))
7181 (run-hooks 'org-after-demote-entry-hook)))
7183 (defun org-cycle-level ()
7184 "Cycle the level of an empty headline through possible states.
7185 This goes first to child, then to parent, level, then up the hierarchy.
7186 After top level, it switches back to sibling level."
7187 (interactive)
7188 (let ((org-adapt-indentation nil))
7189 (when (org-point-at-end-of-empty-headline)
7190 (setq this-command 'org-cycle-level) ; Only needed for caching
7191 (let ((cur-level (org-current-level))
7192 (prev-level (org-get-previous-line-level)))
7193 (cond
7194 ;; If first headline in file, promote to top-level.
7195 ((= prev-level 0)
7196 (loop repeat (/ (- cur-level 1) (org-level-increment))
7197 do (org-do-promote)))
7198 ;; If same level as prev, demote one.
7199 ((= prev-level cur-level)
7200 (org-do-demote))
7201 ;; If parent is top-level, promote to top level if not already.
7202 ((= prev-level 1)
7203 (loop repeat (/ (- cur-level 1) (org-level-increment))
7204 do (org-do-promote)))
7205 ;; If top-level, return to prev-level.
7206 ((= cur-level 1)
7207 (loop repeat (/ (- prev-level 1) (org-level-increment))
7208 do (org-do-demote)))
7209 ;; If less than prev-level, promote one.
7210 ((< cur-level prev-level)
7211 (org-do-promote))
7212 ;; If deeper than prev-level, promote until higher than
7213 ;; prev-level.
7214 ((> cur-level prev-level)
7215 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7216 do (org-do-promote))))
7217 t))))
7219 (defun org-map-tree (fun)
7220 "Call FUN for every heading underneath the current one."
7221 (org-back-to-heading)
7222 (let ((level (funcall outline-level)))
7223 (save-excursion
7224 (funcall fun)
7225 (while (and (progn
7226 (outline-next-heading)
7227 (> (funcall outline-level) level))
7228 (not (eobp)))
7229 (funcall fun)))))
7231 (defun org-map-region (fun beg end)
7232 "Call FUN for every heading between BEG and END."
7233 (let ((org-ignore-region t))
7234 (save-excursion
7235 (setq end (copy-marker end))
7236 (goto-char beg)
7237 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
7238 (< (point) end))
7239 (funcall fun))
7240 (while (and (progn
7241 (outline-next-heading)
7242 (< (point) end))
7243 (not (eobp)))
7244 (funcall fun)))))
7246 (defun org-fixup-indentation (diff)
7247 "Change the indentation in the current entry by DIFF.
7248 However, if any line in the current entry has no indentation, or if it
7249 would end up with no indentation after the change, nothing at all is done."
7250 (save-excursion
7251 (let ((end (save-excursion (outline-next-heading)
7252 (point-marker)))
7253 (prohibit (if (> diff 0)
7256 col)
7257 (unless (save-excursion (end-of-line 1)
7258 (re-search-forward prohibit end t))
7259 (while (and (< (point) end)
7261 (goto-char (match-end 0))
7262 (setq col (current-column))
7263 (if (< diff 0) (replace-match ""))
7264 (org-indent-to-column (+ diff col))))
7265 (move-marker end nil))))
7267 (defun org-convert-to-odd-levels ()
7268 "Convert an org-mode file with all levels allowed to one with odd levels.
7269 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7270 level 5 etc."
7271 (interactive)
7272 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7273 (let ((outline-regexp org-outline-regexp)
7274 (outline-level 'org-outline-level)
7275 (org-odd-levels-only nil) n)
7276 (save-excursion
7277 (goto-char (point-min))
7279 (setq n (- (length (match-string 0)) 2))
7280 (while (>= (setq n (1- n)) 0)
7281 (org-demote))
7282 (end-of-line 1))))))
7284 (defun org-convert-to-oddeven-levels ()
7285 "Convert an org-mode file with only odd levels to one with odd/even levels.
7286 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7287 file contains a section with an even level, conversion would
7288 destroy the structure of the file. An error is signaled in this
7289 case."
7290 (interactive)
7291 (goto-char (point-min))
7292 ;; First check if there are no even levels
7294 (org-show-context t)
7295 (error "Not all levels are odd in this file. Conversion not possible"))
7296 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7297 (let ((outline-regexp org-outline-regexp)
7298 (outline-level 'org-outline-level)
7299 (org-odd-levels-only nil) n)
7300 (save-excursion
7301 (goto-char (point-min))
7303 (setq n (/ (1- (length (match-string 0))) 2))
7304 (while (>= (setq n (1- n)) 0)
7305 (org-promote))
7306 (end-of-line 1))))))
7308 (defun org-tr-level (n)
7309 "Make N odd if required."
7310 (if org-odd-levels-only (1+ (/ n 2)) n))
7312 ;;; Vertical tree motion, cutting and pasting of subtrees
7314 (defun org-move-subtree-up (&optional arg)
7315 "Move the current subtree up past ARG headlines of the same level."
7316 (interactive "p")
7317 (org-move-subtree-down (- (prefix-numeric-value arg))))
7319 (defun org-move-subtree-down (&optional arg)
7320 "Move the current subtree down past ARG headlines of the same level."
7321 (interactive "p")
7322 (setq arg (prefix-numeric-value arg))
7323 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7324 'org-get-last-sibling))
7325 (ins-point (make-marker))
7326 (cnt (abs arg))
7327 (col (current-column))
7328 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7329 ;; Select the tree
7330 (org-back-to-heading)
7331 (setq beg0 (point))
7332 (save-excursion
7333 (setq ne-beg (org-back-over-empty-lines))
7334 (setq beg (point)))
7335 (save-match-data
7336 (save-excursion (outline-end-of-heading)
7337 (setq folded (outline-invisible-p)))
7338 (outline-end-of-subtree))
7339 (outline-next-heading)
7340 (setq ne-end (org-back-over-empty-lines))
7341 (setq end (point))
7342 (goto-char beg0)
7343 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7344 ;; include less whitespace
7345 (save-excursion
7346 (goto-char beg)
7347 (forward-line (- ne-beg ne-end))
7348 (setq beg (point))))
7349 ;; Find insertion point, with error handling
7350 (while (> cnt 0)
7351 (or (and (funcall movfunc) (looking-at outline-regexp))
7352 (progn (goto-char beg0)
7353 (error "Cannot move past superior level or buffer limit")))
7354 (setq cnt (1- cnt)))
7355 (if (> arg 0)
7356 ;; Moving forward - still need to move over subtree
7357 (progn (org-end-of-subtree t t)
7358 (save-excursion
7359 (org-back-over-empty-lines)
7360 (or (bolp) (newline)))))
7361 (setq ne-ins (org-back-over-empty-lines))
7362 (move-marker ins-point (point))
7363 (setq txt (buffer-substring beg end))
7364 (org-save-markers-in-region beg end)
7365 (delete-region beg end)
7366 (org-remove-empty-overlays-at beg)
7367 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7368 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7370 (let ((bbb (point)))
7371 (insert-before-markers txt)
7372 (org-reinstall-markers-in-region bbb)
7373 (move-marker ins-point bbb))
7375 (setq ins-end (point))
7376 (goto-char ins-point)
7377 (org-skip-whitespace)
7378 (when (and (< arg 0)
7379 (org-first-sibling-p)
7380 (> ne-ins ne-beg))
7381 ;; Move whitespace back to beginning
7382 (save-excursion
7383 (goto-char ins-end)
7384 (let ((kill-whole-line t))
7385 (kill-line (- ne-ins ne-beg)) (point)))
7387 (move-marker ins-point nil)
7388 (if folded
7389 (hide-subtree)
7390 (org-show-entry)
7391 (show-children)
7392 (org-cycle-hide-drawers 'children))
7393 (org-clean-visibility-after-subtree-move)
7394 ;; move back to the initial column we were at
7395 (move-to-column col)))
7397 (defvar org-subtree-clip ""
7398 "Clipboard for cut and paste of subtrees.
7399 This is actually only a copy of the kill, because we use the normal kill
7400 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7402 (defvar org-subtree-clip-folded nil
7403 "Was the last copied subtree folded?
7404 This is used to fold the tree back after pasting.")
7406 (defun org-cut-subtree (&optional n)
7407 "Cut the current subtree into the clipboard.
7408 With prefix arg N, cut this many sequential subtrees.
7409 This is a short-hand for marking the subtree and then cutting it."
7410 (interactive "p")
7411 (org-copy-subtree n 'cut))
7413 (defun org-copy-subtree (&optional n cut force-store-markers)
7414 "Cut the current subtree into the clipboard.
7415 With prefix arg N, cut this many sequential subtrees.
7416 This is a short-hand for marking the subtree and then copying it.
7417 If CUT is non-nil, actually cut the subtree.
7418 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7419 of some markers in the region, even if CUT is non-nil. This is
7420 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7421 (interactive "p")
7422 (let (beg end folded (beg0 (point)))
7423 (if (interactive-p)
7424 (org-back-to-heading nil) ; take what looks like a subtree
7425 (org-back-to-heading t)) ; take what is really there
7426 (org-back-over-empty-lines)
7427 (setq beg (point))
7429 (save-match-data
7430 (save-excursion (outline-end-of-heading)
7431 (setq folded (outline-invisible-p)))
7432 (condition-case nil
7433 (org-forward-same-level (1- n) t)
7434 (error nil))
7435 (org-end-of-subtree t t))
7436 (org-back-over-empty-lines)
7437 (setq end (point))
7438 (goto-char beg0)
7439 (when (> end beg)
7440 (setq org-subtree-clip-folded folded)
7441 (when (or cut force-store-markers)
7442 (org-save-markers-in-region beg end))
7443 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7444 (setq org-subtree-clip (current-kill 0))
7445 (message "%s: Subtree(s) with %d characters"
7446 (if cut "Cut" "Copied")
7447 (length org-subtree-clip)))))
7449 (defun org-paste-subtree (&optional level tree for-yank)
7450 "Paste the clipboard as a subtree, with modification of headline level.
7451 The entire subtree is promoted or demoted in order to match a new headline
7452 level.
7454 If the cursor is at the beginning of a headline, the same level as
7455 that headline is used to paste the tree
7457 If not, the new level is derived from the *visible* headings
7458 before and after the insertion point, and taken to be the inferior headline
7459 level of the two. So if the previous visible heading is level 3 and the
7460 next is level 4 (or vice versa), level 4 will be used for insertion.
7461 This makes sure that the subtree remains an independent subtree and does
7462 not swallow low level entries.
7464 You can also force a different level, either by using a numeric prefix
7465 argument, or by inserting the heading marker by hand. For example, if the
7468 If optional TREE is given, use this text instead of the kill ring.
7470 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7471 move back over whitespace before inserting, and move point to the end of
7472 the inserted text when done."
7473 (interactive "P")
7474 (setq tree (or tree (and kill-ring (current-kill 0))))
7475 (unless (org-kill-is-subtree-p tree)
7476 (error "%s"
7477 (substitute-command-keys
7479 (let* ((visp (not (outline-invisible-p)))
7480 (txt tree)
7485 (old-level (if (string-match ^re txt)
7486 (- (match-end 0) (match-beginning 0) 1)
7487 -1))
7488 (force-level (cond (level (prefix-numeric-value level))
7490 (string-match
7491 ^re_ (buffer-substring
7492 (point-at-bol) (point))))
7493 (- (match-end 1) (match-beginning 1)))
7494 ((and (bolp)
7495 (looking-at org-outline-regexp))
7496 (- (match-end 0) (point) 1))
7497 (t nil)))
7498 (previous-level (save-excursion
7499 (condition-case nil
7500 (progn
7501 (outline-previous-visible-heading 1)
7502 (if (looking-at re)
7503 (- (match-end 0) (match-beginning 0) 1)
7504 1))
7505 (error 1))))
7506 (next-level (save-excursion
7507 (condition-case nil
7508 (progn
7509 (or (looking-at outline-regexp)
7510 (outline-next-visible-heading 1))
7511 (if (looking-at re)
7512 (- (match-end 0) (match-beginning 0) 1)
7513 1))
7514 (error 1))))
7515 (new-level (or force-level (max previous-level next-level)))
7516 (shift (if (or (= old-level -1)
7517 (= new-level -1)
7518 (= old-level new-level))
7519 0
7520 (- new-level old-level)))
7521 (delta (if (> shift 0) -1 1))
7522 (func (if (> shift 0) 'org-demote 'org-promote))
7523 (org-odd-levels-only nil)
7524 beg end newend)
7525 ;; Remove the forced level indicator
7526 (if force-level
7527 (delete-region (point-at-bol) (point)))
7528 ;; Paste
7529 (beginning-of-line 1)
7530 (unless for-yank (org-back-over-empty-lines))
7531 (setq beg (point))
7532 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7533 (insert-before-markers txt)
7535 (setq newend (point))
7536 (org-reinstall-markers-in-region beg)
7537 (setq end (point))
7538 (goto-char beg)
7540 (setq beg (point))
7541 (if (and (outline-invisible-p) visp)
7542 (save-excursion (outline-show-heading)))
7543 ;; Shift if necessary
7544 (unless (= shift 0)
7545 (save-restriction
7546 (narrow-to-region beg end)
7547 (while (not (= shift 0))
7548 (org-map-region func (point-min) (point-max))
7549 (setq shift (+ delta shift)))
7550 (goto-char (point-min))
7551 (setq newend (point-max))))
7552 (when (or (interactive-p) for-yank)
7553 (message "Clipboard pasted as level %d subtree" new-level))
7554 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7555 kill-ring
7556 (eq org-subtree-clip (current-kill 0))
7557 org-subtree-clip-folded)
7558 ;; The tree was folded before it was killed/copied
7559 (hide-subtree))
7560 (and for-yank (goto-char newend))))
7562 (defun org-kill-is-subtree-p (&optional txt)
7563 "Check if the current kill is an outline subtree, or a set of trees.
7564 Returns nil if kill does not start with a headline, or if the first
7565 headline level is not the largest headline level in the tree.
7566 So this will actually accept several entries of equal levels as well,
7567 which is OK for `org-paste-subtree'.
7568 If optional TXT is given, check this string instead of the current kill."
7569 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7570 (start-level (and kill
7573 kill)
7574 (- (match-end 2) (match-beginning 2) 1)))
7575 (re (concat "^" org-outline-regexp))
7576 (start (1+ (or (match-beginning 2) -1))))
7577 (if (not start-level)
7578 (progn
7579 nil) ;; does not even start with a heading
7580 (catch 'exit
7581 (while (setq start (string-match re kill (1+ start)))
7582 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7583 (throw 'exit nil)))
7584 t))))
7586 (defvar org-markers-to-move nil
7587 "Markers that should be moved with a cut-and-paste operation.
7588 Those markers are stored together with their positions relative to
7589 the start of the region.")
7591 (defun org-save-markers-in-region (beg end)
7592 "Check markers in region.
7593 If these markers are between BEG and END, record their position relative
7594 to BEG, so that after moving the block of text, we can put the markers back
7595 into place.
7596 This function gets called just before an entry or tree gets cut from the
7597 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7598 called immediately, to move the markers with the entries."
7599 (setq org-markers-to-move nil)
7600 (when (featurep 'org-clock)
7601 (org-clock-save-markers-for-cut-and-paste beg end))
7602 (when (featurep 'org-agenda)
7603 (org-agenda-save-markers-for-cut-and-paste beg end)))
7605 (defun org-check-and-save-marker (marker beg end)
7606 "Check if MARKER is between BEG and END.
7607 If yes, remember the marker and the distance to BEG."
7608 (when (and (marker-buffer marker)
7609 (equal (marker-buffer marker) (current-buffer)))
7610 (if (and (>= marker beg) (< marker end))
7611 (push (cons marker (- marker beg)) org-markers-to-move))))
7613 (defun org-reinstall-markers-in-region (beg)
7614 "Move all remembered markers to their position relative to BEG."
7615 (mapc (lambda (x)
7616 (move-marker (car x) (+ beg (cdr x))))
7617 org-markers-to-move)
7618 (setq org-markers-to-move nil))
7620 (defun org-narrow-to-subtree ()
7621 "Narrow buffer to the current subtree."
7622 (interactive)
7623 (save-excursion
7624 (save-match-data
7625 (org-with-limited-levels
7626 (narrow-to-region
7627 (progn (org-back-to-heading t) (point))
7628 (progn (org-end-of-subtree t t)
7629 (if (and (org-on-heading-p) (not (eobp))) (backward-char 1))
7630 (point)))))))
7632 (defun org-narrow-to-block ()
7633 "Narrow buffer to the current block."
7634 (interactive)
7637 (case-fold-search t) ;; allow #+BEGIN
7638 b_start b_end)
7639 (if (org-in-regexps-block-p bstart bend)
7640 (progn
7641 (save-excursion (re-search-backward bstart nil t)
7642 (setq b_start (match-beginning 0)))
7643 (save-excursion (re-search-forward bend nil t)
7644 (setq b_end (match-end 0)))
7645 (narrow-to-region b_start b_end))
7646 (error "Not in a block"))))
7648 (eval-when-compile
7649 (defvar org-property-drawer-re))
7651 (defvar org-property-start-re) ;; defined below
7652 (defun org-clone-subtree-with-time-shift (n &optional shift)
7653 "Clone the task (subtree) at point N times.
7654 The clones will be inserted as siblings.
7656 In interactive use, the user will be prompted for the number of
7657 clones to be produced, and for a time SHIFT, which may be a
7658 repeater as used in time stamps, for example `+3d'.
7660 When a valid repeater is given and the entry contains any time
7661 stamps, the clones will become a sequence in time, with time
7662 stamps in the subtree shifted for each clone produced. If SHIFT
7663 is nil or the empty string, time stamps will be left alone. The
7664 ID property of the original subtree is removed.
7666 If the original subtree did contain time stamps with a repeater,
7667 the following will happen:
7668 - the repeater will be removed in each clone
7669 - an additional clone will be produced, with the current, unshifted
7670 date(s) in the entry.
7671 - the original entry will be placed *after* all the clones, with
7672 repeater intact.
7673 - the start days in the repeater in the original entry will be shifted
7674 to past the last clone.
7675 I this way you can spell out a number of instances of a repeating task,
7676 and still retain the repeater to cover future instances of the task."
7677 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7678 (let (beg end template task idprop
7679 shift-n shift-what doshift nmin nmax (n-no-remove -1))
7680 (if (not (and (integerp n) (> n 0)))
7681 (error "Invalid number of replications %s" n))
7684 shift)))
7685 (error "Invalid shift specification %s" shift))
7686 (when doshift
7687 (setq shift-n (string-to-number (match-string 1 shift))
7688 shift-what (cdr (assoc (match-string 2 shift)
7689 '(("d" . day) ("w" . week)
7690 ("m" . month) ("y" . year))))))
7691 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7692 (setq nmin 1 nmax n)
7693 (org-back-to-heading t)
7694 (setq beg (point))
7695 (setq idprop (org-entry-get nil "ID"))
7696 (org-end-of-subtree t t)
7698 (setq end (point))
7699 (setq template (buffer-substring beg end))
7700 (when (and doshift
7702 (delete-region beg end)
7703 (setq end beg)
7704 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7705 (goto-char end)
7706 (loop for n from nmin to nmax do
7707 ;; prepare clone
7708 (with-temp-buffer
7709 (insert template)
7710 (org-mode)
7711 (goto-char (point-min))
7712 (and idprop (if org-clone-delete-id
7713 (org-entry-delete nil "ID")
7714 (org-id-get-create t)))
7715 (while (re-search-forward org-property-start-re nil t)
7716 (org-remove-empty-drawer-at "PROPERTIES" (point)))
7717 (goto-char (point-min))
7718 (when doshift
7719 (while (re-search-forward org-ts-regexp-both nil t)
7720 (org-timestamp-change (* n shift-n) shift-what))
7721 (unless (= n n-no-remove)
7722 (goto-char (point-min))
7723 (while (re-search-forward org-ts-regexp nil t)
7724 (save-excursion
7725 (goto-char (match-beginning 0))
7727 (delete-region (match-beginning 1) (match-end 1)))))))
7728 (setq task (buffer-string)))
7729 (insert task))
7730 (goto-char beg)))
7732 ;;; Outline Sorting
7734 (defun org-sort (with-case)
7735 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7736 Optional argument WITH-CASE means sort case-sensitively.
7737 With a double prefix argument, also remove duplicate entries."
7738 (interactive "P")
7739 (cond
7740 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7741 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7742 (t
7743 (org-call-with-arg 'org-sort-entries with-case))))
7745 (defun org-sort-remove-invisible (s)
7746 (remove-text-properties 0 (length s) org-rm-props s)
7747 (while (string-match org-bracket-link-regexp s)
7748 (setq s (replace-match (if (match-end 2)
7749 (match-string 3 s)
7750 (match-string 1 s)) t t s)))
7751 s)
7753 (defvar org-priority-regexp) ; defined later in the file
7755 (defvar org-after-sorting-entries-or-items-hook nil
7756 "Hook that is run after a bunch of entries or items have been sorted.
7757 When children are sorted, the cursor is in the parent line when this
7758 hook gets called. When a region or a plain list is sorted, the cursor
7759 will be in the first entry of the sorted region/list.")
7761 (defun org-sort-entries
7762 (&optional with-case sorting-type getkey-func compare-func property)
7763 "Sort entries on a certain level of an outline tree.
7764 If there is an active region, the entries in the region are sorted.
7765 Else, if the cursor is before the first entry, sort the top-level items.
7766 Else, the children of the entry at point are sorted.
7768 Sorting can be alphabetically, numerically, by date/time as given by
7769 a time stamp, by a property or by priority.
7771 The command prompts for the sorting type unless it has been given to the
7772 function through the SORTING-TYPE argument, which needs to be a character,
7773 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7774 precise meaning of each character:
7776 n Numerically, by converting the beginning of the entry/item to a number.
7777 a Alphabetically, ignoring the TODO keyword and the priority, if any.
7778 t By date/time, either the first active time stamp in the entry, or, if
7779 none exist, by the first inactive one.
7780 s By the scheduled date/time.
7781 d By deadline date/time.
7782 c By creation time, which is assumed to be the first inactive time stamp
7783 at the beginning of a line.
7784 p By priority according to the cookie.
7785 r By the value of a property.
7787 Capital letters will reverse the sort order.
7789 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
7790 called with point at the beginning of the record. It must return either
7791 a string or a number that should serve as the sorting key for that record.
7793 Comparing entries ignores case by default. However, with an optional argument
7794 WITH-CASE, the sorting considers case as well."
7795 (interactive "P")
7796 (let ((case-func (if with-case 'identity 'downcase))
7797 start beg end stars re re2
7798 txt what tmp)
7799 ;; Find beginning and end of region to sort
7800 (cond
7801 ((org-region-active-p)
7802 ;; we will sort the region
7803 (setq end (region-end)
7804 what "region")
7805 (goto-char (region-beginning))
7806 (if (not (org-on-heading-p)) (outline-next-heading))
7807 (setq start (point)))
7808 ((or (org-on-heading-p)
7809 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
7810 ;; we will sort the children of the current headline
7811 (org-back-to-heading)
7812 (setq start (point)
7813 end (progn (org-end-of-subtree t t)
7815 (org-back-over-empty-lines)
7816 (point))
7817 what "children")
7818 (goto-char start)
7819 (show-subtree)
7820 (outline-next-heading))
7821 (t
7822 ;; we will sort the top-level entries in this file
7823 (goto-char (point-min))
7824 (or (org-on-heading-p) (outline-next-heading))
7825 (setq start (point))
7826 (goto-char (point-max))
7827 (beginning-of-line 1)
7829 ;; File ends in a non-white line
7830 (end-of-line 1)
7832 (setq end (point-max))
7833 (setq what "top-level")
7834 (goto-char start)
7835 (show-all)))
7837 (setq beg (point))
7838 (if (>= beg end) (error "Nothing to sort"))
7841 (setq stars (match-string 1)
7842 re (concat "^" (regexp-quote stars) " +")
7844 txt (buffer-substring beg end))
7846 (if (and (not (equal stars "*")) (string-match re2 txt))
7847 (error "Region to sort contains a level above the first entry"))
7849 (unless sorting-type
7850 (message
7851 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
7853 A/N/T/S/D/C/P/O/F means reversed:"
7854 what)
7855 (setq sorting-type (read-char-exclusive))
7857 (and (= (downcase sorting-type) ?f)
7858 (setq getkey-func
7859 (org-icompleting-read "Sort using function: "
7860 obarray 'fboundp t nil nil))
7861 (setq getkey-func (intern getkey-func)))
7863 (and (= (downcase sorting-type) ?r)
7864 (setq property
7865 (org-icompleting-read "Property: "
7866 (mapcar 'list (org-buffer-property-keys t))
7867 nil t))))
7869 (message "Sorting entries...")
7871 (save-restriction
7872 (narrow-to-region start end)
7873 (let ((dcst (downcase sorting-type))
7874 (case-fold-search nil)
7875 (now (current-time)))
7876 (sort-subr
7877 (/= dcst sorting-type)
7878 ;; This function moves to the beginning character of the "record" to
7879 ;; be sorted.
7880 (lambda nil
7881 (if (re-search-forward re nil t)
7882 (goto-char (match-beginning 0))
7883 (goto-char (point-max))))
7884 ;; This function moves to the last character of the "record" being
7885 ;; sorted.
7886 (lambda nil
7887 (save-match-data
7888 (condition-case nil
7889 (outline-forward-same-level 1)
7890 (error
7891 (goto-char (point-max))))))
7892 ;; This function returns the value that gets sorted against.
7893 (lambda nil
7894 (cond
7895 ((= dcst ?n)
7896 (if (looking-at org-complex-heading-regexp)
7897 (string-to-number (match-string 4))
7898 nil))
7899 ((= dcst ?a)
7900 (if (looking-at org-complex-heading-regexp)
7901 (funcall case-func (match-string 4))
7902 nil))
7903 ((= dcst ?t)
7904 (let ((end (save-excursion (outline-next-heading) (point))))
7905 (if (or (re-search-forward org-ts-regexp end t)
7906 (re-search-forward org-ts-regexp-both end t))
7907 (org-time-string-to-seconds (match-string 0))
7908 (org-float-time now))))
7909 ((= dcst ?c)
7910 (let ((end (save-excursion (outline-next-heading) (point))))
7911 (if (re-search-forward
7913 end t)
7914 (org-time-string-to-seconds (match-string 0))
7915 (org-float-time now))))
7916 ((= dcst ?s)
7917 (let ((end (save-excursion (outline-next-heading) (point))))
7918 (if (re-search-forward org-scheduled-time-regexp end t)
7919 (org-time-string-to-seconds (match-string 1))
7920 (org-float-time now))))
7921 ((= dcst ?d)
7922 (let ((end (save-excursion (outline-next-heading) (point))))
7923 (if (re-search-forward org-deadline-time-regexp end t)
7924 (org-time-string-to-seconds (match-string 1))
7925 (org-float-time now))))
7926 ((= dcst ?p)
7927 (if (re-search-forward org-priority-regexp (point-at-eol) t)
7928 (string-to-char (match-string 2))
7929 org-default-priority))
7930 ((= dcst ?r)
7931 (or (org-entry-get nil property) ""))
7932 ((= dcst ?o)
7933 (if (looking-at org-complex-heading-regexp)
7934 (- 9999 (length (member (match-string 2)
7935 org-todo-keywords-1)))))
7936 ((= dcst ?f)
7937 (if getkey-func
7938 (progn
7939 (setq tmp (funcall getkey-func))
7940 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
7941 tmp)
7942 (error "Invalid key function `%s'" getkey-func)))
7943 (t (error "Invalid sorting type `%c'" sorting-type))))
7944 nil
7945 (cond
7946 ((= dcst ?a) 'string<)
7947 ((= dcst ?f) compare-func)
7948 ((member dcst '(?p ?t ?s ?d ?c)) '<)
7949 (t nil)))))
7950 (run-hooks 'org-after-sorting-entries-or-items-hook)
7951 (message "Sorting entries...done")))
7953 (defun org-do-sort (table what &optional with-case sorting-type)
7954 "Sort TABLE of WHAT according to SORTING-TYPE.
7955 The user will be prompted for the SORTING-TYPE if the call to this
7956 function does not specify it. WHAT is only for the prompt, to indicate
7957 what is being sorted. The sorting key will be extracted from
7958 the car of the elements of the table.
7959 If WITH-CASE is non-nil, the sorting will be case-sensitive."
7960 (unless sorting-type
7961 (message
7962 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
7963 what)
7964 (setq sorting-type (read-char-exclusive)))
7965 (let ((dcst (downcase sorting-type))
7966 extractfun comparefun)
7967 ;; Define the appropriate functions
7968 (cond
7969 ((= dcst ?n)
7970 (setq extractfun 'string-to-number
7971 comparefun (if (= dcst sorting-type) '< '>)))
7972 ((= dcst ?a)
7973 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
7974 (lambda(x) (downcase (org-sort-remove-invisible x))))
7975 comparefun (if (= dcst sorting-type)
7976 'string<
7977 (lambda (a b) (and (not (string< a b))
7978 (not (string= a b)))))))
7979 ((= dcst ?t)
7980 (setq extractfun
7981 (lambda (x)
7982 (if (or (string-match org-ts-regexp x)
7983 (string-match org-ts-regexp-both x))
7984 (org-float-time
7985 (org-time-string-to-time (match-string 0 x)))
7986 0))
7987 comparefun (if (= dcst sorting-type) '< '>)))
7988 (t (error "Invalid sorting type `%c'" sorting-type)))
7990 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
7991 table)
7992 (lambda (a b) (funcall comparefun (car a) (car b))))))
7995 ;;; The orgstruct minor mode
7997 ;; Define a minor mode which can be used in other modes in order to
7998 ;; integrate the org-mode structure editing commands.
8000 ;; This is really a hack, because the org-mode structure commands use
8001 ;; keys which normally belong to the major mode. Here is how it
8002 ;; works: The minor mode defines all the keys necessary to operate the
8003 ;; structure commands, but wraps the commands into a function which
8004 ;; tests if the cursor is currently at a headline or a plain list
8005 ;; item. If that is the case, the structure command is used,
8006 ;; temporarily setting many Org-mode variables like regular
8007 ;; expressions for filling etc. However, when any of those keys is
8008 ;; used at a different location, function uses `key-binding' to look
8009 ;; up if the key has an associated command in another currently active
8010 ;; keymap (minor modes, major mode, global), and executes that
8011 ;; command. There might be problems if any of the keys is otherwise
8012 ;; used as a prefix key.
8014 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8015 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8016 ;; addresses this by checking explicitly for both bindings.
8018 (defvar orgstruct-mode-map (make-sparse-keymap)
8019 "Keymap for the minor `orgstruct-mode'.")
8021 (defvar org-local-vars nil
8022 "List of local variables, for use by `orgstruct-mode'.")
8024 ;;;###autoload
8025 (define-minor-mode orgstruct-mode
8026 "Toggle the minor mode `orgstruct-mode'.
8027 This mode is for using Org-mode structure commands in other
8028 modes. The following keys behave as if Org-mode were active, if
8029 the cursor is on a headline, or on a plain list item (both as
8030 defined by Org-mode).
8032 M-up Move entry/item up
8033 M-down Move entry/item down
8034 M-left Promote
8035 M-right Demote
8036 M-S-up Move entry/item up
8037 M-S-down Move entry/item down
8038 M-S-left Promote subtree
8039 M-S-right Demote subtree
8040 M-q Fill paragraph and items like in Org-mode
8041 C-c ^ Sort entries
8042 C-c - Cycle list bullet
8043 TAB Cycle item visibility
8044 M-RET Insert new heading/item
8045 S-M-RET Insert new TODO heading / Checkbox item
8046 C-c C-c Set tags / toggle checkbox"
8047 nil " OrgStruct" nil
8048 (org-load-modules-maybe)
8049 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8051 ;;;###autoload
8052 (defun turn-on-orgstruct ()
8053 "Unconditionally turn on `orgstruct-mode'."
8054 (orgstruct-mode 1))
8056 (defun orgstruct++-mode (&optional arg)
8057 "Toggle `orgstruct-mode', the enhanced version of it.
8058 In addition to setting orgstruct-mode, this also exports all indentation
8059 and autofilling variables from org-mode into the buffer. It will also
8060 recognize item context in multiline items.
8061 Note that turning off orgstruct-mode will *not* remove the
8062 indentation/paragraph settings. This can only be done by refreshing the
8064 (interactive "P")
8065 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8066 (if (< arg 1)
8067 (orgstruct-mode -1)
8068 (orgstruct-mode 1)
8069 (let (var val)
8070 (mapc
8071 (lambda (x)
8072 (when (string-match
8074 (symbol-name (car x)))
8075 (setq var (car x) val (nth 1 x))
8076 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8077 org-local-vars)
8078 (org-set-local 'orgstruct-is-++ t))))
8080 (defvar orgstruct-is-++ nil
8081 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8082 (make-variable-buffer-local 'orgstruct-is-++)
8084 ;;;###autoload
8085 (defun turn-on-orgstruct++ ()
8086 "Unconditionally turn on `orgstruct++-mode'."
8087 (orgstruct++-mode 1))
8089 (defun orgstruct-error ()
8090 "Error when there is no default binding for a structure key."
8091 (interactive)
8092 (error "This key has no function outside structure elements"))
8094 (defun orgstruct-setup ()
8095 "Setup orgstruct keymaps."
8096 (let ((nfunc 0)
8097 (bindings
8098 (list
8099 '([(meta up)] org-metaup)
8100 '([(meta down)] org-metadown)
8101 '([(meta left)] org-metaleft)
8102 '([(meta right)] org-metaright)
8103 '([(meta shift up)] org-shiftmetaup)
8104 '([(meta shift down)] org-shiftmetadown)
8105 '([(meta shift left)] org-shiftmetaleft)
8106 '([(meta shift right)] org-shiftmetaright)
8107 '([?\e (up)] org-metaup)
8108 '([?\e (down)] org-metadown)
8109 '([?\e (left)] org-metaleft)
8110 '([?\e (right)] org-metaright)
8111 '([?\e (shift up)] org-shiftmetaup)
8112 '([?\e (shift down)] org-shiftmetadown)
8113 '([?\e (shift left)] org-shiftmetaleft)
8114 '([?\e (shift right)] org-shiftmetaright)
8115 '([(shift up)] org-shiftup)
8116 '([(shift down)] org-shiftdown)
8117 '([(shift left)] org-shiftleft)
8118 '([(shift right)] org-shiftright)
8119 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8120 '("\M-q" fill-paragraph)
8121 '("\C-c^" org-sort)
8122 '("\C-c-" org-cycle-list-bullet)))
8123 elt key fun cmd)
8124 (while (setq elt (pop bindings))
8125 (setq nfunc (1+ nfunc))
8126 (setq key (org-key (car elt))
8127 fun (nth 1 elt)
8128 cmd (orgstruct-make-binding fun nfunc key))
8129 (org-defkey orgstruct-mode-map key cmd))
8131 ;; Special treatment needed for TAB and RET
8132 (org-defkey orgstruct-mode-map [(tab)]
8133 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8134 (org-defkey orgstruct-mode-map "\C-i"
8135 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8137 (org-defkey orgstruct-mode-map "\M-\C-m"
8138 (orgstruct-make-binding 'org-insert-heading 105
8139 "\M-\C-m" [(meta return)]))
8140 (org-defkey orgstruct-mode-map [(meta return)]
8141 (orgstruct-make-binding 'org-insert-heading 106
8142 [(meta return)] "\M-\C-m"))
8144 (org-defkey orgstruct-mode-map [(shift meta return)]
8145 (orgstruct-make-binding 'org-insert-todo-heading 107
8146 [(meta return)] "\M-\C-m"))
8148 (org-defkey orgstruct-mode-map "\e\C-m"
8149 (orgstruct-make-binding 'org-insert-heading 108
8150 "\e\C-m" [?\e (return)]))
8151 (org-defkey orgstruct-mode-map [?\e (return)]
8152 (orgstruct-make-binding 'org-insert-heading 109
8153 [?\e (return)] "\e\C-m"))
8154 (org-defkey orgstruct-mode-map [?\e (shift return)]
8155 (orgstruct-make-binding 'org-insert-todo-heading 110
8156 [?\e (return)] "\e\C-m"))
8158 (unless org-local-vars
8159 (setq org-local-vars (org-get-local-variables)))
8161 t))
8163 (defun orgstruct-make-binding (fun n &rest keys)
8164 "Create a function for binding in the structure minor mode.
8165 FUN is the command to call inside a table. N is used to create a unique
8166 command name. KEYS are keys that should be checked in for a command
8167 to execute outside of tables."
8168 (eval
8169 (list 'defun
8170 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8171 '(arg)
8173 "Outside of structure, run the binding of `"
8174 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8175 "'.")
8176 '(interactive "p")
8177 (list 'if
8178 `(org-context-p 'headline 'item
8179 (and orgstruct-is-++
8180 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8181 'item-body))
8182 (list 'org-run-like-in-org-mode (list 'quote fun))
8183 (list 'let '(orgstruct-mode)
8184 (list 'call-interactively
8185 (append '(or)
8186 (mapcar (lambda (k)
8187 (list 'key-binding k))
8188 keys)
8189 '('orgstruct-error))))))))
8191 (defun org-context-p (&rest contexts)
8192 "Check if local context is any of CONTEXTS.
8193 Possible values in the list of contexts are `table', `headline', and `item'."
8194 (let ((pos (point)))
8195 (goto-char (point-at-bol))
8196 (prog1 (or (and (memq 'table contexts)
8198 (and (memq 'headline contexts)
8200 (looking-at outline-regexp))
8201 (and (memq 'item contexts)
8203 (and (memq 'item-body contexts)
8204 (org-in-item-p)))
8205 (goto-char pos))))
8207 (defun org-get-local-variables ()
8208 "Return a list of all local variables in an org-mode buffer."
8209 (let (varlist)
8210 (with-current-buffer (get-buffer-create "*Org tmp*")
8211 (erase-buffer)
8212 (org-mode)
8213 (setq varlist (buffer-local-variables)))
8214 (kill-buffer "*Org tmp*")
8215 (delq nil
8216 (mapcar
8217 (lambda (x)
8218 (setq x
8219 (if (symbolp x)
8220 (list x)
8221 (list (car x) (list 'quote (cdr x)))))
8222 (if (string-match
8223 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8224 (symbol-name (car x)))
8225 x nil))
8226 varlist))))
8228 (defun org-clone-local-variables (from-buffer &optional regexp)
8229 "Clone local variables from FROM-BUFFER.
8230 Optional argument REGEXP selects variables to clone."
8231 (mapc
8232 (lambda (pair)
8233 (and (symbolp (car pair))
8234 (or (null regexp)
8235 (string-match regexp (symbol-name (car pair))))
8236 (set (make-local-variable (car pair))
8237 (cdr pair))))
8238 (buffer-local-variables from-buffer)))
8240 ;;;###autoload
8241 (defun org-run-like-in-org-mode (cmd)
8242 "Run a command, pretending that the current buffer is in Org-mode.
8243 This will temporarily bind local variables that are typically bound in
8244 Org-mode to the values they have in Org-mode, and then interactively
8245 call CMD."
8246 (org-load-modules-maybe)
8247 (unless org-local-vars
8248 (setq org-local-vars (org-get-local-variables)))
8249 (eval (list 'let org-local-vars
8250 (list 'call-interactively (list 'quote cmd)))))
8252 ;;;; Archiving
8254 (defun org-get-category (&optional pos force-refresh)
8255 "Get the category applying to position POS."
8256 (if force-refresh (org-refresh-category-properties))
8257 (let ((pos (or pos (point))))
8258 (or (get-text-property pos 'org-category)
8259 (progn (org-refresh-category-properties)
8260 (get-text-property pos 'org-category)))))
8262 (defun org-refresh-category-properties ()
8263 "Refresh category text properties in the buffer."
8264 (let ((def-cat (cond
8265 ((null org-category)
8266 (if buffer-file-name
8267 (file-name-sans-extension
8268 (file-name-nondirectory buffer-file-name))
8269 "???"))
8270 ((symbolp org-category) (symbol-name org-category))
8271 (t org-category)))
8272 beg end cat pos optionp)
8273 (org-unmodified
8274 (save-excursion
8275 (save-restriction
8276 (widen)
8277 (goto-char (point-min))
8278 (put-text-property (point) (point-max) 'org-category def-cat)
8279 (while (re-search-forward
8281 (setq pos (match-end 0)
8282 optionp (equal (char-after (match-beginning 0)) ?#)
8283 cat (org-trim (match-string 2)))
8284 (if optionp
8285 (setq beg (point-at-bol) end (point-max))
8286 (org-back-to-heading t)
8287 (setq beg (point) end (org-end-of-subtree t t)))
8288 (put-text-property beg end 'org-category cat)
8289 (goto-char pos)))))))
8292 ;;;; Link Stuff
8294 ;;; Link abbreviations
8296 (defun org-link-expand-abbrev (link)
8297 "Apply replacements as defined in `org-link-abbrev-alist."
8299 (let* ((key (match-string 1 link))
8300 (as (or (assoc key org-link-abbrev-alist-local)
8301 (assoc key org-link-abbrev-alist)))
8302 (tag (and (match-end 2) (match-string 3 link)))
8303 rpl)
8304 (if (not as)
8305 link
8306 (setq rpl (cdr as))
8307 (cond
8308 ((symbolp rpl) (funcall rpl tag))
8309 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8310 ((string-match "%h" rpl)
8311 (replace-match (url-hexify-string (or tag "")) t t rpl))
8312 (t (concat rpl tag)))))
8313 link))
8315 ;;; Storing and inserting links
8317 (defvar org-insert-link-history nil
8318 "Minibuffer history for links inserted with `org-insert-link'.")
8320 (defvar org-stored-links nil
8321 "Contains the links stored with `org-store-link'.")
8323 (defvar org-store-link-plist nil
8324 "Plist with info about the most recently link created with `org-store-link'.")
8326 (defvar org-link-protocols nil
8327 "Link protocols added to Org-mode using `org-add-link-type'.")
8329 (defvar org-store-link-functions nil
8330 "List of functions that are called to create and store a link.
8331 Each function will be called in turn until one returns a non-nil
8332 value. Each function should check if it is responsible for creating
8333 this link (for example by looking at the major mode).
8334 If not, it must exit and return nil.
8335 If yes, it should return a non-nil value after a calling
8336 `org-store-link-props' with a list of properties and values.
8337 Special properties are:
8341 This is obligatory as well.
8342 :description Optional default description for the second pair
8343 of brackets in an Org-mode link. The user can still change
8344 this when inserting this link into an Org-mode buffer.
8346 In addition to these, any additional properties can be specified
8347 and then used in remember templates.")
8349 (defun org-add-link-type (type &optional follow export)
8350 "Add TYPE to the list of `org-link-types'.
8351 Re-compute all regular expressions depending on `org-link-types'
8353 FOLLOW and EXPORT are two functions.
8355 FOLLOW should take the link path as the single argument and do whatever
8356 is necessary to follow the link, for example find a file or display
8357 a mail message.
8359 EXPORT should format the link path for export to one of the export formats.
8360 It should be a function accepting three arguments:
8363 desc the description of the link, if any, or a description added by
8364 org-export-normalize-links if there is none
8365 format the export format, a symbol like `html' or `latex' or `ascii'..
8367 The function may use the FORMAT information to return different values
8368 depending on the format. The return value will be put literally into
8369 the exported file. If the return value is nil, this means Org should
8370 do what it normally does with links which do not have EXPORT defined.
8372 Org-mode has a built-in default for exporting links. If you are happy with
8373 this default, there is no need to define an export function for the link
8374 type. For a simple example of an export function, see `org-bbdb.el'."
8375 (add-to-list 'org-link-types type t)
8376 (org-make-link-regexps)
8377 (if (assoc type org-link-protocols)
8378 (setcdr (assoc type org-link-protocols) (list follow export))
8379 (push (list type follow export) org-link-protocols)))
8381 (defvar org-agenda-buffer-name)
8383 ;;;###autoload
8384 (defun org-store-link (arg)
8386 This link is added to `org-stored-links' and can later be inserted
8389 For some link types, a prefix arg is interpreted:
8390 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8391 For file links, arg negates `org-context-in-file-links'."
8392 (interactive "P")
8393 (org-load-modules-maybe)
8394 (setq org-store-link-plist nil) ; reset
8395 (org-with-limited-levels
8396 (let (link cpltxt desc description search txt custom-id agenda-link)
8397 (cond
8399 ((run-hook-with-args-until-success 'org-store-link-functions)
8400 (setq link (plist-get org-store-link-plist :link)
8401 desc (or (plist-get org-store-link-plist :description) link)))
8403 ((equal (buffer-name) "*Org Edit Src Example*")
8404 (let (label gc)
8405 (while (or (not label)
8406 (save-excursion
8407 (save-restriction
8408 (widen)
8409 (goto-char (point-min))
8410 (re-search-forward
8411 (regexp-quote (format org-coderef-label-format label))
8412 nil t))))
8413 (when label (message "Label exists already") (sit-for 2))
8414 (setq label (read-string "Code line label: " label)))
8415 (end-of-line 1)
8416 (setq link (format org-coderef-label-format label))
8417 (setq gc (- 79 (length link)))
8418 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8419 (insert link)
8420 (setq link (concat "(" label ")") desc nil)))
8422 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8423 ;; We are in the agenda, link to referenced location
8424 (let ((m (or (get-text-property (point) 'org-hd-marker)
8425 (get-text-property (point) 'org-marker))))
8426 (when m
8427 (org-with-point-at m
8428 (setq agenda-link
8429 (if (interactive-p)
8430 (call-interactively 'org-store-link)
8431 (org-store-link nil)))))))
8433 ((eq major-mode 'calendar-mode)
8434 (let ((cd (calendar-cursor-to-date)))
8435 (setq link
8436 (format-time-string
8437 (car org-time-stamp-formats)
8438 (apply 'encode-time
8439 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8440 nil nil nil))))
8441 (org-store-link-props :type "calendar" :date cd)))
8443 ((eq major-mode 'w3-mode)
8444 (setq cpltxt (if (and (buffer-name)
8445 (not (string-match "Untitled" (buffer-name))))
8446 (buffer-name)
8447 (url-view-url t))
8448 link (org-make-link (url-view-url t)))
8449 (org-store-link-props :type "w3" :url (url-view-url t)))
8451 ((eq major-mode 'w3m-mode)
8452 (setq cpltxt (or w3m-current-title w3m-current-url)
8453 link (org-make-link w3m-current-url))
8454 (org-store-link-props :type "w3m" :url (url-view-url t)))
8456 ((setq search (run-hook-with-args-until-success
8457 'org-create-file-search-functions))
8458 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8459 "::" search))
8460 (setq cpltxt (or description link)))
8462 ((eq major-mode 'image-mode)
8463 (setq cpltxt (concat "file:"
8464 (abbreviate-file-name buffer-file-name))
8465 link (org-make-link cpltxt))
8466 (org-store-link-props :type "image" :file buffer-file-name))
8468 ((eq major-mode 'dired-mode)
8469 ;; link to the file in the current line
8470 (let ((file (dired-get-filename nil t)))
8471 (setq file (if file
8472 (abbreviate-file-name
8473 (expand-file-name (dired-get-filename nil t)))
8474 ;; otherwise, no file so use current directory.
8475 default-directory))
8476 (setq cpltxt (concat "file:" file)
8477 link (org-make-link cpltxt))))
8479 ((and (buffer-file-name (buffer-base-buffer)) (org-mode-p))
8480 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8481 (cond
8483 (setq cpltxt
8484 (concat "file:"
8485 (abbreviate-file-name
8486 (buffer-file-name (buffer-base-buffer)))
8487 "::" (match-string 1))
8488 link (org-make-link cpltxt)))
8489 ((and (featurep 'org-id)
8490 (or (eq org-link-to-org-use-id t)
8491 (and (eq org-link-to-org-use-id 'create-if-interactive)
8492 (interactive-p))
8493 (and (eq org-link-to-org-use-id 'create-if-interactive-and-no-custom-id)
8494 (interactive-p)
8495 (not custom-id))
8496 (and org-link-to-org-use-id
8497 (org-entry-get nil "ID"))))
8498 ;; We can make a link using the ID.
8499 (setq link (condition-case nil
8500 (prog1 (org-id-store-link)
8501 (setq desc (plist-get org-store-link-plist
8502 :description)))
8503 (error
8504 ;; probably before first headline, link to file only
8505 (concat "file:"
8506 (abbreviate-file-name
8507 (buffer-file-name (buffer-base-buffer))))))))
8508 (t
8509 ;; Just link to current headline
8510 (setq cpltxt (concat "file:"
8511 (abbreviate-file-name
8512 (buffer-file-name (buffer-base-buffer)))))
8513 ;; Add a context search string
8514 (when (org-xor org-context-in-file-links arg)
8515 (setq txt (cond
8516 ((org-on-heading-p) nil)
8517 ((org-region-active-p)
8518 (buffer-substring (region-beginning) (region-end)))
8519 (t nil)))
8521 (setq cpltxt
8522 (concat cpltxt "::"
8523 (condition-case nil
8524 (org-make-org-heading-search-string txt)
8525 (error "")))
8526 desc (or (nth 4 (ignore-errors
8527 (org-heading-components))) "NONE"))))
8529 (setq cpltxt (substring cpltxt 0 -2)))
8530 (setq link (org-make-link cpltxt)))))
8532 ((buffer-file-name (buffer-base-buffer))
8533 ;; Just link to this file here.
8534 (setq cpltxt (concat "file:"
8535 (abbreviate-file-name
8536 (buffer-file-name (buffer-base-buffer)))))
8537 ;; Add a context string
8538 (when (org-xor org-context-in-file-links arg)
8539 (setq txt (if (org-region-active-p)
8540 (buffer-substring (region-beginning) (region-end))
8541 (buffer-substring (point-at-bol) (point-at-eol))))
8542 ;; Only use search option if there is some text.
8544 (setq cpltxt
8545 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8546 desc "NONE")))
8547 (setq link (org-make-link cpltxt)))
8549 ((interactive-p)
8550 (error "Cannot link to a buffer which is not visiting a file"))
8552 (t (setq link nil)))
8554 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8555 (setq link (or link cpltxt)
8556 desc (or desc cpltxt))
8557 (if (equal desc "NONE") (setq desc nil))
8559 (if (and (or (interactive-p) executing-kbd-macro) link)
8560 (progn
8561 (setq org-stored-links
8562 (cons (list link desc) org-stored-links))
8563 (message "Stored: %s" (or desc link))
8564 (when custom-id
8565 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8566 "::#" custom-id))
8567 (setq org-stored-links
8568 (cons (list link desc) org-stored-links))))
8569 (or agenda-link (and link (org-make-link-string link desc)))))))
8571 (defun org-store-link-props (&rest plist)
8572 "Store link properties, extract names and addresses."
8573 (let (x adr)
8574 (when (setq x (plist-get plist :from))
8575 (setq adr (mail-extract-address-components x))
8576 (setq plist (plist-put plist :fromname (car adr)))
8577 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8578 (when (setq x (plist-get plist :to))
8579 (setq adr (mail-extract-address-components x))
8580 (setq plist (plist-put plist :toname (car adr)))
8581 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8582 (let ((from (plist-get plist :from))
8583 (to (plist-get plist :to)))
8584 (when (and from to org-from-is-user-regexp)
8585 (setq plist
8586 (plist-put plist :fromto
8587 (if (string-match org-from-is-user-regexp from)
8588 (concat "to %t")
8589 (concat "from %f"))))))
8590 (setq org-store-link-plist plist))
8592 (defun org-add-link-props (&rest plist)
8593 "Add these properties to the link property list."
8594 (let (key value)
8595 (while plist
8596 (setq key (pop plist) value (pop plist))
8597 (setq org-store-link-plist
8598 (plist-put org-store-link-plist key value)))))
8600 (defun org-email-link-description (&optional fmt)
8601 "Return the description part of an email link.
8602 This takes information from `org-store-link-plist' and formats it
8603 according to FMT (default from `org-email-link-description-format')."
8604 (setq fmt (or fmt org-email-link-description-format))
8605 (let* ((p org-store-link-plist)
8606 (to (plist-get p :toaddress))
8607 (from (plist-get p :fromaddress))
8608 (table
8609 (list
8610 (cons "%c" (plist-get p :fromto))
8611 (cons "%F" (plist-get p :from))
8612 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8613 (cons "%T" (plist-get p :to))
8614 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8615 (cons "%s" (plist-get p :subject))
8616 (cons "%d" (plist-get p :date))
8617 (cons "%m" (plist-get p :message-id)))))
8618 (when (string-match "%c" fmt)
8619 ;; Check if the user wrote this message
8620 (if (and org-from-is-user-regexp from to
8621 (save-match-data (string-match org-from-is-user-regexp from)))
8622 (setq fmt (replace-match "to %t" t t fmt))
8623 (setq fmt (replace-match "from %f" t t fmt))))
8624 (org-replace-escapes fmt table)))
8626 (defun org-make-org-heading-search-string (&optional string heading)
8627 "Make search string for STRING or current headline."
8628 (interactive)
8629 (let ((s (or string (org-get-heading)))
8630 (lines org-context-in-file-links))
8631 (unless (and string (not heading))
8632 ;; We are using a headline, clean up garbage in there.
8633 (if (string-match org-todo-regexp s)
8634 (setq s (replace-match "" t t s)))
8636 (setq s (replace-match "" t t s)))
8637 (setq s (org-trim s))
8640 (setq s (replace-match "" t t s)))
8641 (while (string-match org-ts-regexp s)
8642 (setq s (replace-match "" t t s))))
8643 (or string (setq s (concat "*" s))) ; Add * for headlines
8644 (when (and string (integerp lines) (> lines 0))
8646 (when (< lines (length slines))
8647 (setq s (mapconcat
8648 'identity
8649 (reverse (nthcdr (- (length slines) lines)
8653 (defun org-make-link (&rest strings)
8654 "Concatenate STRINGS."
8655 (apply 'concat strings))
8657 (defun org-make-link-string (link &optional description)
8658 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8660 (error "Empty link"))
8661 (when (and description
8662 (stringp description)
8664 (setq description nil))
8665 (when (stringp description)
8666 ;; Remove brackets from the description, they are fatal.
8668 (setq description (replace-match "{" t t description)))
8670 (setq description (replace-match "}" t t description))))
8671 (when (equal (org-link-escape link) description)
8672 ;; No description needed, it is identical
8673 (setq description nil))
8674 (when (and (not description)
8675 (not (equal link (org-link-escape link))))
8676 (setq description (org-extract-attributes link)))
8677 (setq link (if (string-match org-link-types-re link)
8678 (concat (match-string 1 link)
8679 (org-link-escape (substring link (match-end 1))))
8680 (org-link-escape link)))
8681 (concat "[[" link "]"
8682 (if description (concat "[" description "]") "")
8683 "]"))
8685 (defconst org-link-escape-chars
8686 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8687 "List of characters that should be escaped in link.
8688 This is the list that is used for internal purposes.")
8690 (defvar org-url-encoding-use-url-hexify nil)
8692 (defconst org-link-escape-chars-browser
8693 '(?\ )
8694 "List of escapes for characters that are problematic in links.
8695 This is the list that is used before handing over to the browser.")
8697 (defun org-link-escape (text &optional table merge)
8698 "Return percent escaped representation of TEXT.
8699 TEXT is a string with the text to escape.
8700 Optional argument TABLE is a list with characters that should be
8701 escaped. When nil, `org-link-escape-chars' is used.
8702 If optional argument MERGE is set, merge TABLE into
8703 `org-link-escape-chars'."
8704 (if (and org-url-encoding-use-url-hexify (not table))
8705 (url-hexify-string text)
8706 (cond
8707 ((and table merge)
8708 (mapc (lambda (defchr)
8709 (unless (member defchr table)
8710 (setq table (cons defchr table)))) org-link-escape-chars))
8711 ((null table)
8712 (setq table org-link-escape-chars)))
8713 (mapconcat
8714 (lambda (char)
8715 (if (or (member char table)
8716 (< char 32) (= char 37) (> char 126))
8717 (mapconcat (lambda (sequence-element)
8718 (format "%%%.2X" sequence-element))
8719 (or (encode-coding-char char 'utf-8)
8720 (error "Unable to percent escape character: %s"
8721 (char-to-string char))) "")
8722 (char-to-string char))) text "")))
8724 (defun org-link-unescape (str)
8725 "Unhex hexified unicode strings as returned from the JavaScript function
8726 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8727 (unless (and (null str) (string= "" str))
8728 (let ((pos 0) (case-fold-search t) unhexed)
8730 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8731 (setq str (replace-match unhexed t t str))
8732 (setq pos (+ pos (length unhexed))))))
8733 str)
8735 (defun org-link-unescape-compound (hex)
8736 "Unhexify unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8737 Note: this function also decodes single byte encodings like
8739 (save-match-data
8740 (let* ((bytes (cdr (split-string hex "%")))
8741 (ret "")
8742 (eat 0)
8743 (sum 0))
8744 (while bytes
8745 (let* ((val (string-to-number (pop bytes) 16))
8746 (shift-xor
8747 (if (= 0 eat)
8748 (cond
8749 ((>= val 252) (cons 6 252))
8750 ((>= val 248) (cons 5 248))
8751 ((>= val 240) (cons 4 240))
8752 ((>= val 224) (cons 3 224))
8753 ((>= val 192) (cons 2 192))
8754 (t (cons 0 0)))
8755 (cons 6 128))))
8756 (if (>= val 192) (setq eat (car shift-xor)))
8757 (setq val (logxor val (cdr shift-xor)))
8758 (setq sum (+ (lsh sum (car shift-xor)) val))
8759 (if (> eat 0) (setq eat (- eat 1)))
8760 (cond
8761 ((= 0 eat) ;multi byte
8762 (setq ret (concat ret (org-char-to-string sum)))
8763 (setq sum 0))
8764 ((not bytes) ; single byte(s)
8765 (setq ret (org-link-unescape-single-byte-sequence hex))))
8766 )) ;; end (while bytes
8767 ret )))
8769 (defun org-link-unescape-single-byte-sequence (hex)
8770 "Unhexify hex-encoded single byte character sequences."
8771 (mapconcat (lambda (byte)
8772 (char-to-string (string-to-number byte 16)))
8773 (cdr (split-string hex "%")) ""))
8775 (defun org-xor (a b)
8776 "Exclusive or."
8777 (if a (not b) b))
8779 (defun org-fixup-message-id-for-http (s)
8780 "Replace special characters in a message id, so it can be used in an http query."
8781 (when (string-match "%" s)
8782 (setq s (mapconcat (lambda (c)
8783 (if (eq c ?%)
8784 "%25"
8785 (char-to-string c)))
8786 s "")))
8787 (while (string-match "<" s)
8788 (setq s (replace-match "%3C" t t s)))
8789 (while (string-match ">" s)
8790 (setq s (replace-match "%3E" t t s)))
8791 (while (string-match "@" s)
8792 (setq s (replace-match "%40" t t s)))
8793 s)
8795 ;;;###autoload
8796 (defun org-insert-link-global ()
8797 "Insert a link like Org-mode does.
8798 This command can be called in any mode to insert a link in Org-mode syntax."
8799 (interactive)
8800 (org-load-modules-maybe)
8801 (org-run-like-in-org-mode 'org-insert-link))
8803 (defun org-insert-link (&optional complete-file link-location)
8804 "Insert a link. At the prompt, enter the link.
8806 Completion can be used to insert any of the link protocol prefixes like
8807 http or ftp in use.
8809 The history can be used to select a link previously stored with
8810 `org-store-link'. When the empty string is entered (i.e. if you just
8811 press RET at the prompt), the link defaults to the most recently
8812 stored link. As SPC triggers completion in the minibuffer, you need to
8813 use M-SPC or C-q SPC to force the insertion of a space character.
8815 You will also be prompted for a description, and if one is given, it will
8816 be displayed in the buffer instead of the link.
8818 If there is already a link at point, this command will allow you to edit link
8819 and description parts.
8822 be selected using completion. The path to the file will be relative to the
8823 current directory if the file is in the current directory or a subdirectory.
8824 Otherwise, the link will be the absolute path as completed in the minibuffer
8825 \(i.e. normally ~/path/to/file). You can configure this behavior using the
8826 option `org-link-file-path-type'.
8829 the current directory or below.
8832 `org-keep-stored-link-after-insertion'.
8834 If `org-make-link-description-function' is non-nil, this function will be
8835 called with the link target, and the result will be the default
8836 link description.
8838 If the LINK-LOCATION parameter is non-nil, this value will be
8839 used as the link location instead of reading one interactively."
8840 (interactive "P")
8841 (let* ((wcf (current-window-configuration))
8842 (region (if (org-region-active-p)
8843 (buffer-substring (region-beginning) (region-end))))
8844 (remove (and region (list (region-beginning) (region-end))))
8845 (desc region)
8846 tmphist ; byte-compile incorrectly complains about this
8847 (link link-location)
8848 entry file all-prefixes)
8849 (cond
8850 (link-location) ; specified by arg, just use it.
8851 ((org-in-regexp org-bracket-link-regexp 1)
8852 ;; We do have a link at point, and we are going to edit it.
8853 (setq remove (list (match-beginning 0) (match-end 0)))
8854 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
8855 (setq link (read-string "Link: "
8856 (org-link-unescape
8857 (org-match-string-no-properties 1)))))
8858 ((or (org-in-regexp org-angle-link-re)
8859 (org-in-regexp org-plain-link-re))
8860 ;; Convert to bracket link
8861 (setq remove (list (match-beginning 0) (match-end 0))
8862 link (read-string "Link: "
8863 (org-remove-angle-brackets (match-string 0)))))
8864 ((member complete-file '((4) (16)))
8865 ;; Completing read for file names.
8866 (setq link (org-file-complete-link complete-file)))
8867 (t
8868 ;; Read link, with completion for stored links.
8869 (with-output-to-temp-buffer "*Org Links*"
8870 (princ "Insert a link.
8872 (when org-stored-links
8874 (princ (mapconcat
8875 (lambda (x)
8876 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
8878 (let ((cw (selected-window)))
8879 (select-window (get-buffer-window "*Org Links*" 'visible))
8880 (setq truncate-lines t)
8881 (unless (pos-visible-in-window-p (point-max))
8882 (org-fit-window-to-buffer))
8883 (and (window-live-p cw) (select-window cw)))
8884 ;; Fake a link history, containing the stored links.
8885 (setq tmphist (append (mapcar 'car org-stored-links)
8886 org-insert-link-history))
8887 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
8888 (mapcar 'car org-link-abbrev-alist)
8889 org-link-types))
8890 (unwind-protect
8891 (progn
8892 (setq link
8893 (let ((org-completion-use-ido nil)
8894 (org-completion-use-iswitchb nil))
8895 (org-completing-read
8896 "Link: "
8897 (append
8898 (mapcar (lambda (x) (list (concat x ":")))
8899 all-prefixes)
8900 (mapcar 'car org-stored-links))
8901 nil nil nil
8902 'tmphist
8903 (car (car org-stored-links)))))
8905 (error "No link selected"))
8906 (if (or (member link all-prefixes)
8907 (and (equal ":" (substring link -1))
8908 (member (substring link 0 -1) all-prefixes)
8909 (setq link (substring link 0 -1))))
8910 (setq link (org-link-try-special-completion link))))
8911 (set-window-configuration wcf)
8912 (kill-buffer "*Org Links*"))
8913 (setq entry (assoc link org-stored-links))
8914 (or entry (push link org-insert-link-history))
8915 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
8916 (not org-keep-stored-link-after-insertion))
8917 (setq org-stored-links (delq (assoc link org-stored-links)
8918 org-stored-links)))
8919 (setq desc (or desc (nth 1 entry)))))
8921 (if (string-match org-plain-link-re link)
8922 ;; URL-like link, normalize the use of angular brackets.
8923 (setq link (org-make-link (org-remove-angle-brackets link))))
8925 ;; Check if we are linking to the current file with a search option
8926 ;; If yes, simplify the link by using only the search option.
8927 (when (and buffer-file-name
8929 (let* ((path (match-string 1 link))
8930 (case-fold-search nil)
8931 (search (match-string 2 link)))
8932 (save-match-data
8933 (if (equal (file-truename buffer-file-name) (file-truename path))
8934 ;; We are linking to this same file, with a search option
8935 (setq link search)))))
8937 ;; Check if we can/should use a relative path. If yes, simplify the link
8939 (let* ((type (match-string 1 link))
8940 (path (match-string 2 link))
8941 (origpath path)
8942 (case-fold-search nil))
8943 (cond
8944 ((or (eq org-link-file-path-type 'absolute)
8945 (equal complete-file '(16)))
8946 (setq path (abbreviate-file-name (expand-file-name path))))
8947 ((eq org-link-file-path-type 'noabbrev)
8948 (setq path (expand-file-name path)))
8949 ((eq org-link-file-path-type 'relative)
8950 (setq path (file-relative-name path)))
8951 (t
8952 (save-match-data
8953 (if (string-match (concat "^" (regexp-quote
8954 (expand-file-name
8955 (file-name-as-directory
8956 default-directory))))
8957 (expand-file-name path))
8958 ;; We are linking a file with relative path name.
8959 (setq path (substring (expand-file-name path)
8960 (match-end 0)))
8961 (setq path (abbreviate-file-name (expand-file-name path)))))))
8962 (setq link (concat type path))
8963 (if (equal desc origpath)
8964 (setq desc path))))
8966 (if org-make-link-description-function
8967 (setq desc (funcall org-make-link-description-function link desc)))
8969 (setq desc (read-string "Description: " desc))
8971 (if remove (apply 'delete-region remove))
8972 (insert (org-make-link-string link desc))))
8974 (defun org-link-try-special-completion (type)
8975 "If there is completion support for link type TYPE, offer it."
8976 (let ((fun (intern (concat "org-" type "-complete-link"))))
8977 (if (functionp fun)
8978 (funcall fun)
8979 (read-string "Link (no completion support): " (concat type ":")))))
8981 (defun org-file-complete-link (&optional arg)
8982 "Create a file link using completion."
8983 (let (file link)
8984 (setq file (read-file-name "File: "))
8985 (let ((pwd (file-name-as-directory (expand-file-name ".")))
8986 (pwd1 (file-name-as-directory (abbreviate-file-name
8987 (expand-file-name ".")))))
8988 (cond
8989 ((equal arg '(16))
8990 (setq link (org-make-link
8991 "file:"
8992 (abbreviate-file-name (expand-file-name file)))))
8994 (setq link (org-make-link "file:" (match-string 1 file))))
8996 (expand-file-name file))
8997 (setq link (org-make-link
8998 "file:" (match-string 1 (expand-file-name file)))))
8999 (t (setq link (org-make-link "file:" file)))))
9000 link))
9002 (defun org-completing-read (&rest args)
9003 "Completing-read with SPACE being a normal character."
9004 (let ((minibuffer-local-completion-map
9005 (copy-keymap minibuffer-local-completion-map)))
9006 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9007 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9008 (apply 'org-icompleting-read args)))
9010 (defun org-completing-read-no-i (&rest args)
9011 (let (org-completion-use-ido org-completion-use-iswitchb)
9012 (apply 'org-completing-read args)))
9014 (defun org-iswitchb-completing-read (prompt choices &rest args)
9015 "Use iswitch as a completing-read replacement to choose from choices.
9016 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9017 from."
9018 (let* ((iswitchb-use-virtual-buffers nil)
9019 (iswitchb-make-buflist-hook
9020 (lambda ()
9021 (setq iswitchb-temp-buflist choices))))
9022 (iswitchb-read-buffer prompt)))
9024 (defun org-icompleting-read (&rest args)
9025 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9026 (org-without-partial-completion
9027 (if (and org-completion-use-ido
9028 (fboundp 'ido-completing-read)
9029 (boundp 'ido-mode) ido-mode
9030 (listp (second args)))
9031 (let ((ido-enter-matching-directory nil))
9032 (apply 'ido-completing-read (concat (car args))
9033 (if (consp (car (nth 1 args)))
9034 (mapcar 'car (nth 1 args))
9035 (nth 1 args))
9036 (cddr args)))
9037 (if (and org-completion-use-iswitchb
9038 (boundp 'iswitchb-mode) iswitchb-mode
9039 (listp (second args)))
9040 (apply 'org-iswitchb-completing-read (concat (car args))
9041 (if (consp (car (nth 1 args)))
9042 (mapcar 'car (nth 1 args))
9043 (nth 1 args))
9044 (cddr args))
9045 (apply 'completing-read args)))))
9047 (defun org-extract-attributes (s)
9048 "Extract the attributes cookie from a string and set as text property."
9049 (let (a attr (start 0) key value)
9050 (save-match-data
9052 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9054 (setq key (match-string 1 a) value (match-string 2 a)
9055 start (match-end 0)
9056 attr (plist-put attr (intern key) value))))
9057 (org-add-props s nil 'org-attr attr))
9058 s))
9060 (defun org-extract-attributes-from-string (tag)
9061 (let (key value attr)
9063 (setq key (match-string 1 tag) value (match-string 2 tag)
9064 tag (replace-match "" t t tag)
9065 attr (plist-put attr (intern key) value)))
9066 (cons tag attr)))
9068 (defun org-attributes-to-string (plist)
9069 "Format a property list into an HTML attribute list."
9070 (let ((s "") key value)
9071 (while plist
9072 (setq key (pop plist) value (pop plist))
9073 (and value
9075 s))
9077 ;;; Opening/following a link
9079 (defvar org-link-search-failed nil)
9081 (defvar org-open-link-functions nil
9082 "Hook for functions finding a plain text link.
9083 These functions must take a single argument, the link content.
9084 They will be called for links that look like [[link text][description]]
9088 These functions will be called *before* Org attempts to resolve the
9089 link by doing text searches in the current buffer - so if you want a
9091 handle this as a special case.
9093 When the function does handle the link, it must return a non-nil value.
9094 If it decides that it is not responsible for this link, it must return
9095 nil to indicate that that Org-mode can continue with other options
9096 like exact and fuzzy text search.")
9098 (defun org-next-link ()
9099 "Move forward to the next link.
9100 If the link is in hidden text, expose it."
9101 (interactive)
9102 (when (and org-link-search-failed (eq this-command last-command))
9103 (goto-char (point-min))
9104 (message "Link search wrapped back to beginning of buffer"))
9105 (setq org-link-search-failed nil)
9106 (let* ((pos (point))
9107 (ct (org-context))
9108 (a (assoc :link ct)))
9109 (if a (goto-char (nth 2 a)))
9110 (if (re-search-forward org-any-link-re nil t)
9111 (progn
9112 (goto-char (match-beginning 0))
9113 (if (outline-invisible-p) (org-show-context)))
9114 (goto-char pos)
9115 (setq org-link-search-failed t)
9116 (error "No further link found"))))
9118 (defun org-previous-link ()
9119 "Move backward to the previous link.
9120 If the link is in hidden text, expose it."
9121 (interactive)
9122 (when (and org-link-search-failed (eq this-command last-command))
9123 (goto-char (point-max))
9124 (message "Link search wrapped back to end of buffer"))
9125 (setq org-link-search-failed nil)
9126 (let* ((pos (point))
9127 (ct (org-context))
9128 (a (assoc :link ct)))
9129 (if a (goto-char (nth 1 a)))
9130 (if (re-search-backward org-any-link-re nil t)
9131 (progn
9132 (goto-char (match-beginning 0))
9133 (if (outline-invisible-p) (org-show-context)))
9134 (goto-char pos)
9135 (setq org-link-search-failed t)
9136 (error "No further link found"))))
9138 (defun org-translate-link (s)
9139 "Translate a link string if a translation function has been defined."
9140 (if (and org-link-translation-function
9141 (fboundp org-link-translation-function)
9143 (progn
9144 (setq s (funcall org-link-translation-function
9145 (match-string 1) (match-string 2)))
9146 (concat (car s) ":" (cdr s)))
9147 s))
9149 (defun org-translate-link-from-planner (type path)
9150 "Translate a link from Emacs Planner syntax so that Org can follow it.
9151 This is still an experimental function, your mileage may vary."
9152 (cond
9153 ((member type '("http" "https" "news" "ftp"))
9154 ;; standard Internet links are the same.
9155 nil)
9156 ((and (equal type "irc") (string-match "^//" path))
9157 ;; Planner has two / at the beginning of an irc link, we have 1.
9158 ;; We should have zero, actually....
9159 (setq path (substring path 1)))
9160 ((and (equal type "lisp") (string-match "^/" path))
9161 ;; Planner has a slash, we do not.
9162 (setq type "elisp" path (substring path 1)))
9164 ;; A typical message link. Planner has the id after the final slash,
9165 ;; we separate it with a hash mark
9166 (setq path (concat (match-string 1 path) "#"
9167 (org-remove-angle-brackets (match-string 2 path)))))
9168 )
9169 (cons type path))
9171 (defun org-find-file-at-mouse (ev)
9172 "Open file link or URL at mouse."
9173 (interactive "e")
9174 (mouse-set-point ev)
9175 (org-open-at-point 'in-emacs))
9177 (defun org-open-at-mouse (ev)
9178 "Open file link or URL at mouse."
9179 (interactive "e")
9180 (mouse-set-point ev)
9181 (if (eq major-mode 'org-agenda-mode)
9182 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9183 (org-open-at-point))
9185 (defvar org-window-config-before-follow-link nil
9186 "The window configuration before following a link.
9187 This is saved in case the need arises to restore it.")
9189 (defvar org-open-link-marker (make-marker)
9190 "Marker pointing to the location where `org-open-at-point; was called.")
9192 ;;;###autoload
9193 (defun org-open-at-point-global ()
9194 "Follow a link like Org-mode does.
9195 This command can be called in any mode to follow a link that has
9196 Org-mode syntax."
9197 (interactive)
9198 (org-run-like-in-org-mode 'org-open-at-point))
9200 ;;;###autoload
9201 (defun org-open-link-from-string (s &optional arg reference-buffer)
9202 "Open a link in the string S, as if it was in Org-mode."
9204 (let ((reference-buffer (or reference-buffer (current-buffer))))
9205 (with-temp-buffer
9206 (let ((org-inhibit-startup t))
9207 (org-mode)
9208 (insert s)
9209 (goto-char (point-min))
9210 (when reference-buffer
9211 (setq org-link-abbrev-alist-local
9212 (with-current-buffer reference-buffer
9213 org-link-abbrev-alist-local)))
9214 (org-open-at-point arg reference-buffer)))))
9216 (defvar org-open-at-point-functions nil
9217 "Hook that is run when following a link at point.
9219 Functions in this hook must return t if they identify and follow
9220 a link at point. If they don't find anything interesting at point,
9221 they must return nil.")
9223 (defun org-open-at-point (&optional arg reference-buffer)
9224 "Open link at or after point.
9225 If there is no link at point, this function will search forward up to
9226 the end of the current line.
9227 Normally, files will be opened by an appropriate application. If the
9228 optional prefix argument ARG is non-nil, Emacs will visit the file.
9229 With a double prefix argument, try to open outside of Emacs, in the
9230 application the system uses for this file type."
9231 (interactive "P")
9232 ;; if in a code block, then open the block's results
9233 (unless (call-interactively #'org-babel-open-src-block-result)
9234 (org-load-modules-maybe)
9235 (move-marker org-open-link-marker (point))
9236 (setq org-window-config-before-follow-link (current-window-configuration))
9237 (org-remove-occur-highlights nil nil t)
9238 (cond
9239 ((and (org-on-heading-p)
9240 (not (org-in-regexp
9245 (not (get-text-property (point) 'org-linked-text)))
9246 (or (org-offer-links-in-entry arg)
9247 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9248 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9249 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9250 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9251 (not (org-in-regexp org-bracket-link-regexp)))
9252 (org-footnote-action))
9253 (t
9254 (let (type path link line search (pos (point)))
9255 (catch 'match
9256 (save-excursion
9258 (when (org-in-regexp org-bracket-link-regexp 1)
9259 (setq link (org-extract-attributes
9260 (org-link-unescape (org-match-string-no-properties 1))))
9262 (setq link (replace-match " " t t link)))
9263 (setq link (org-link-expand-abbrev link))
9264 (cond
9265 ((or (file-name-absolute-p link)
9267 (setq type "file" path link))
9268 ((string-match org-link-re-with-space3 link)
9269 (setq type (match-string 1 link) path (match-string 2 link)))
9270 (t (setq type "thisfile" path link)))
9271 (throw 'match t)))
9273 (when (get-text-property (point) 'org-linked-text)
9274 (setq type "thisfile"
9275 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9276 (1+ (point)) (point))
9277 path (buffer-substring
9278 (or (previous-single-property-change pos 'org-linked-text)
9279 (point-min))
9280 (or (next-single-property-change pos 'org-linked-text)
9281 (point-max))))
9282 (throw 'match t))
9284 (save-excursion
9285 (when (or (org-in-regexp org-angle-link-re)
9286 (org-in-regexp org-plain-link-re))
9287 (setq type (match-string 1) path (match-string 2))
9288 (throw 'match t)))
9289 (save-excursion
9291 (setq type "tags"
9292 path (match-string 1))
9293 (while (string-match ":" path)
9294 (setq path (replace-match "+" t t path)))
9295 (throw 'match t)))
9297 (setq type "tree-match"
9298 path (match-string 1))
9299 (throw 'match t)))
9300 (unless path
9301 (error "No link found"))
9303 ;; switch back to reference buffer
9304 ;; needed when if called in a temporary buffer through
9305 ;; org-open-link-from-string
9306 (with-current-buffer (or reference-buffer (current-buffer))
9308 ;; Remove any trailing spaces in path
9310 (setq path (replace-match "" t t path)))
9311 (if (and org-link-translation-function
9312 (fboundp org-link-translation-function))
9313 ;; Check if we need to translate the link
9314 (let ((tmp (funcall org-link-translation-function type path)))
9315 (setq type (car tmp) path (cdr tmp))))
9317 (cond
9319 ((assoc type org-link-protocols)
9320 (funcall (nth 1 (assoc type org-link-protocols)) path))
9322 ((equal type "mailto")
9323 (let ((cmd (car org-link-mailto-program))
9324 (args (cdr org-link-mailto-program)) args1
9325 (address path) (subject "") a)
9327 (setq address (match-string 1 path)
9328 subject (org-link-escape (match-string 2 path))))
9329 (while args
9330 (cond
9331 ((not (stringp (car args))) (push (pop args) args1))
9332 (t (setq a (pop args))
9333 (if (string-match "%a" a)
9334 (setq a (replace-match address t t a)))
9335 (if (string-match "%s" a)
9336 (setq a (replace-match subject t t a)))
9337 (push a args1))))
9338 (apply cmd (nreverse args1))))
9340 ((member type '("http" "https" "ftp" "news"))
9341 (browse-url (concat type ":" (org-link-escape
9342 path org-link-escape-chars-browser))))
9344 ((string= type "doi")
9345 (browse-url (concat "http://dx.doi.org/"
9346 (org-link-escape
9347 path org-link-escape-chars-browser))))
9349 ((member type '("message"))
9350 (browse-url (concat type ":" path)))
9352 ((string= type "tags")
9353 (org-tags-view arg path))
9355 ((string= type "tree-match")
9358 ((string= type "file")
9360 (setq line (string-to-number (match-string 1 path))
9361 path (substring path 0 (match-beginning 0)))
9363 (setq search (match-string 1 path)
9364 path (substring path 0 (match-beginning 0)))))
9365 (if (string-match "[*?{]" (file-name-nondirectory path))
9366 (dired path)
9367 (org-open-file path arg line search)))
9369 ((string= type "shell")
9370 (let ((cmd path))
9371 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9372 (string-match org-confirm-shell-link-not-regexp cmd))
9373 (not org-confirm-shell-link-function)
9374 (funcall org-confirm-shell-link-function
9376 (org-add-props cmd nil
9377 'face 'org-warning))))
9378 (progn
9379 (message "Executing %s" cmd)
9380 (shell-command cmd))
9381 (error "Abort"))))
9383 ((string= type "elisp")
9384 (let ((cmd path))
9385 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9386 (string-match org-confirm-elisp-link-not-regexp cmd))
9387 (not org-confirm-elisp-link-function)
9388 (funcall org-confirm-elisp-link-function
9390 (org-add-props cmd nil
9391 'face 'org-warning))))
9392 (message "%s => %s" cmd
9393 (if (equal (string-to-char cmd) ?\()
9394 (eval (read cmd))
9395 (call-interactively (read cmd))))
9396 (error "Abort"))))
9398 ((and (string= type "thisfile")
9399 (run-hook-with-args-until-success
9400 'org-open-link-functions path)))
9402 ((string= type "thisfile")
9403 (if arg
9404 (switch-to-buffer-other-window
9405 (org-get-buffer-for-internal-link (current-buffer)))
9406 (org-mark-ring-push))
9407 (let ((cmd `(org-link-search
9408 ,path
9409 ,(cond ((equal arg '(4)) ''occur)
9410 ((equal arg '(16)) ''org-occur)
9411 (t nil))
9412 ,pos)))
9413 (condition-case nil (eval cmd)
9414 (error (progn (widen) (eval cmd))))))
9416 (t
9417 (browse-url-at-point)))))))
9418 (move-marker org-open-link-marker nil)
9419 (run-hook-with-args 'org-follow-link-hook)))
9421 (defun org-offer-links-in-entry (&optional nth zero)
9422 "Offer links in the current entry and follow the selected link.
9423 If there is only one link, follow it immediately as well.
9424 If NTH is an integer, immediately pick the NTH link found.
9425 If ZERO is a string, check also this string for a link, and if
9426 there is one, offer it as link number zero."
9430 (cnt ?0)
9431 (in-emacs (if (integerp nth) nil nth))
9432 have-zero end links link c)
9433 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9434 (push (match-string 0 zero) links)
9435 (setq cnt (1- cnt) have-zero t))
9436 (save-excursion
9437 (org-back-to-heading t)
9438 (setq end (save-excursion (outline-next-heading) (point)))
9439 (while (re-search-forward re end t)
9440 (push (match-string 0) links))
9441 (setq links (org-uniquify (reverse links))))
9443 (cond
9444 ((null links)
9445 (message "No links"))
9446 ((equal (length links) 1)
9447 (setq link (list (car links))))
9448 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9449 (setq link (nth (if have-zero nth (1- nth)) links)))
9450 (t ; we have to select a link
9451 (save-excursion
9452 (save-window-excursion
9453 (delete-other-windows)
9454 (with-output-to-temp-buffer "*Select Link*"
9455 (mapc (lambda (l)
9456 (if (not (string-match org-bracket-link-regexp l))
9458 (org-remove-angle-brackets l)))
9459 (if (match-end 3)
9461 (match-string 3 l) (match-string 1 l)))
9463 (match-string 1 l))))))
9464 links))
9465 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9466 (message "Select link to open, RET to open all:")
9467 (setq c (read-char-exclusive))
9468 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9469 (when (equal c ?q) (error "Abort"))
9470 (if (equal c ?\C-m)
9471 (setq link links)
9472 (setq nth (- c ?0))
9473 (if have-zero (setq nth (1+ nth)))
9474 (unless (and (integerp nth) (>= (length links) nth))
9475 (error "Invalid link selection"))
9476 (setq link (list (nth (1- nth) links))))))
9477 (if link
9478 (let ((buf (current-buffer)))
9479 (dolist (l link)
9480 (org-open-link-from-string l in-emacs buf))
9481 t)
9482 nil)))
9484 ;; Add special file links that specify the way of opening
9486 (org-add-link-type "file+sys" 'org-open-file-with-system)
9487 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9488 (defun org-open-file-with-system (path)
9489 "Open file at PATH using the system way of opening it."
9490 (org-open-file path 'system))
9491 (defun org-open-file-with-emacs (path)
9492 "Open file at PATH in Emacs."
9493 (org-open-file path 'emacs))
9494 (defun org-remove-file-link-modifiers ()
9495 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9496 (goto-char (point-min))
9498 (org-if-unprotected
9499 (replace-match "file:" t t))))
9500 (eval-after-load "org-exp"
9501 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9502 'org-remove-file-link-modifiers))
9504 ;;;; Time estimates
9506 (defun org-get-effort (&optional pom)
9507 "Get the effort estimate for the current entry."
9508 (org-entry-get pom org-effort-property))
9510 ;;; File search
9512 (defvar org-create-file-search-functions nil
9513 "List of functions to construct the right search string for a file link.
9514 These functions are called in turn with point at the location to
9515 which the link should point.
9517 A function in the hook should first test if it would like to
9518 handle this file type, for example by checking the `major-mode'
9519 or the file extension. If it decides not to handle this file, it
9520 should just return nil to give other functions a chance. If it
9521 does handle the file, it must return the search string to be used
9522 when following the link. The search string will be part of the
9523 file link, given after a double colon, and `org-open-at-point'
9524 will automatically search for it. If special measures must be
9525 taken to make the search successful, another function should be
9526 added to the companion hook `org-execute-file-search-functions',
9527 which see.
9529 A function in this hook may also use `setq' to set the variable
9530 `description' to provide a suggestion for the descriptive text to
9531 be used for this link when it gets inserted into an Org-mode
9534 (defvar org-execute-file-search-functions nil
9535 "List of functions to execute a file search triggered by a link.
9537 Functions added to this hook must accept a single argument, the
9538 search string that was part of the file link, the part after the
9539 double colon. The function must first check if it would like to
9540 handle this search, for example by checking the `major-mode' or
9541 the file extension. If it decides not to handle this search, it
9542 should just return nil to give other functions a chance. If it
9543 does handle the search, it must return a non-nil value to keep
9544 other functions from trying.
9546 Each function can access the current prefix argument through the
9547 variable `current-prefix-argument'. Note that a single prefix is
9548 used to force opening a link in Emacs, so it may be good to only
9549 use a numeric or double prefix to guide the search function.
9551 In case this is needed, a function in this hook can also restore
9552 the window configuration before `org-open-at-point' was called using:
9554 (set-window-configuration org-window-config-before-follow-link)")
9556 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9557 (defun org-link-search (s &optional type avoid-pos)
9558 "Search for a link search option.
9559 If S is surrounded by forward slashes, it is interpreted as a
9560 regular expression. In org-mode files, this will create an `org-occur'
9561 sparse tree. In ordinary files, `occur' will be used to list matches.
9562 If the current buffer is in `dired-mode', grep will be used to search
9563 in all files. If AVOID-POS is given, ignore matches near that position."
9564 (let ((case-fold-search t)
9568 org-emphasis-alist)
9570 (pos (point))
9571 (pre nil) (post nil)
9572 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9573 (cond
9574 ;; First check if there are any special search functions
9575 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9576 ;; Now try the builtin stuff
9577 ((and (equal (string-to-char s0) ?#)
9578 (> (length s0) 1)
9579 (save-excursion
9580 (goto-char (point-min))
9581 (and
9582 (re-search-forward
9584 (setq type 'dedicated
9585 pos (match-beginning 0))))
9586 ;; There is an exact target for this
9587 (goto-char pos)
9588 (org-back-to-heading t)))
9589 ((save-excursion
9590 (goto-char (point-min))
9591 (and
9592 (re-search-forward
9593 (concat "<<" (regexp-quote s0) ">>") nil t)
9594 (setq type 'dedicated
9595 pos (match-beginning 0))))
9596 ;; There is an exact target for this
9597 (goto-char pos))
9599 (save-excursion
9600 (goto-char (point-min))
9601 (and
9602 (re-search-forward
9603 (concat "[^[]" (regexp-quote
9604 (format org-coderef-label-format
9605 (match-string 1 s0))))
9606 nil t)
9607 (setq type 'dedicated
9608 pos (1+ (match-beginning 0))))))
9609 ;; There is a coderef target for this
9610 (goto-char pos))
9612 ;; A regular expression
9613 (cond
9614 ((org-mode-p)
9615 (org-occur (match-string 1 s)))
9616 ;;((eq major-mode 'dired-mode)
9617 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9618 (t (org-do-occur (match-string 1 s)))))
9619 ((and (org-mode-p) org-link-search-must-match-exact-headline)
9620 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9621 (goto-char (point-min))
9622 (cond
9623 ((let (case-fold-search)
9624 (re-search-forward (format org-complex-heading-regexp-format
9625 (regexp-quote s))
9626 nil t))
9627 ;; OK, found a match
9628 (setq type 'dedicated)
9629 (goto-char (match-beginning 0)))
9630 ((and (not org-link-search-inhibit-query)
9631 (eq org-link-search-must-match-exact-headline 'query-to-create)
9632 (y-or-n-p "No match - create this as a new heading? "))
9633 (goto-char (point-max))
9634 (or (bolp) (newline))
9636 (beginning-of-line 0))
9637 (t
9638 (goto-char pos)
9639 (error "No match"))))
9640 (t
9641 ;; A normal search string
9642 (when (equal (string-to-char s) ?*)
9643 ;; Anchor on headlines, post may include tags.
9646 s (substring s 1)))
9647 (remove-text-properties
9648 0 (length s)
9649 '(face nil mouse-face nil keymap nil fontified nil) s)
9650 ;; Make a series of regular expressions to find a match
9659 re4 (concat "[^a-zA-Z_]" re4_)
9661 re1 (concat pre re2 post)
9662 re3 (concat pre (if pre re4_ re4) post)
9663 re5 (concat pre ".*" re4)
9664 re2 (concat pre re2)
9665 re2a (concat pre (if pre re2a_ re2a))
9666 re4 (concat pre (if pre re4_ re4))
9670 ))
9671 (cond
9672 ((eq type 'org-occur) (org-occur reall))
9673 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9674 (t (goto-char (point-min))
9675 (setq type 'fuzzy)
9676 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9677 (org-search-not-self 1 re1 nil t)
9678 (org-search-not-self 1 re2 nil t)
9679 (org-search-not-self 1 re2a nil t)
9680 (org-search-not-self 1 re3 nil t)
9681 (org-search-not-self 1 re4 nil t)
9682 (org-search-not-self 1 re5 nil t)
9683 )
9684 (goto-char (match-beginning 1))
9685 (goto-char pos)
9686 (error "No match"))))))
9687 (and (org-mode-p) (org-show-context 'link-search))
9688 type))
9690 (defun org-search-not-self (group &rest args)
9691 "Execute `re-search-forward', but only accept matches that do not
9692 enclose the position of `org-open-link-marker'."
9693 (let ((m org-open-link-marker))
9694 (catch 'exit
9695 (while (apply 're-search-forward args)
9696 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9697 (goto-char (match-end group))
9698 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9699 (> (match-beginning 0) (marker-position m))
9700 (< (match-end 0) (marker-position m)))
9701 (save-match-data
9702 (or (not (org-in-regexp
9703 org-bracket-link-analytic-regexp 1))
9704 (not (match-end 4)) ; no description
9705 (and (<= (match-beginning 4) (point))
9706 (>= (match-end 4) (point))))))
9707 (throw 'exit (point))))))))
9709 (defun org-get-buffer-for-internal-link (buffer)
9710 "Return a buffer to be used for displaying the link target of internal links."
9711 (cond
9712 ((not org-display-internal-link-with-indirect-buffer)
9713 buffer)
9714 ((string-match "(Clone)$" (buffer-name buffer))
9715 (message "Buffer is already a clone, not making another one")
9716 ;; we also do not modify visibility in this case
9717 buffer)
9718 (t ; make a new indirect buffer for displaying the link
9719 (let* ((bn (buffer-name buffer))
9720 (ibn (concat bn "(Clone)"))
9721 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9722 (with-current-buffer ib (org-overview))
9723 ib))))
9725 (defun org-do-occur (regexp &optional cleanup)
9726 "Call the Emacs command `occur'.
9727 If CLEANUP is non-nil, remove the printout of the regular expression
9728 in the *Occur* buffer. This is useful if the regex is long and not useful
9729 to read."
9730 (occur regexp)
9731 (when cleanup
9732 (let ((cwin (selected-window)) win beg end)
9733 (when (setq win (get-buffer-window "*Occur*"))
9734 (select-window win))
9735 (goto-char (point-min))
9736 (when (re-search-forward "match[a-z]+" nil t)
9737 (setq beg (match-end 0))
9739 (setq end (1- (match-beginning 0)))))
9740 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9741 (goto-char (point-min))
9742 (select-window cwin))))
9744 ;;; The mark ring for links jumps
9746 (defvar org-mark-ring nil
9747 "Mark ring for positions before jumps in Org-mode.")
9748 (defvar org-mark-ring-last-goto nil
9749 "Last position in the mark ring used to go back.")
9750 ;; Fill and close the ring
9751 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
9752 (loop for i from 1 to org-mark-ring-length do
9753 (push (make-marker) org-mark-ring))
9754 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
9755 org-mark-ring)
9757 (defun org-mark-ring-push (&optional pos buffer)
9758 "Put the current position or POS into the mark ring and rotate it."
9759 (interactive)
9760 (setq pos (or pos (point)))
9761 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
9762 (move-marker (car org-mark-ring)
9763 (or pos (point))
9764 (or buffer (current-buffer)))
9765 (message "%s"
9766 (substitute-command-keys
9769 (defun org-mark-ring-goto (&optional n)
9770 "Jump to the previous position in the mark ring.
9771 With prefix arg N, jump back that many stored positions. When
9772 called several times in succession, walk through the entire ring.
9773 Org-mode commands jumping to a different position in the current file,
9774 or to another Org-mode file, automatically push the old position
9775 onto the ring."
9776 (interactive "p")
9777 (let (p m)
9778 (if (eq last-command this-command)
9779 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
9780 (setq p org-mark-ring))
9781 (setq org-mark-ring-last-goto p)
9782 (setq m (car p))
9783 (switch-to-buffer (marker-buffer m))
9784 (goto-char m)
9785 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
9787 (defun org-remove-angle-brackets (s)
9788 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
9789 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
9790 s)
9791 (defun org-add-angle-brackets (s)
9792 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
9793 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
9794 s)
9795 (defun org-remove-double-quotes (s)
9798 s)
9800 ;;; Following specific links
9802 (defun org-follow-timestamp-link ()
9803 (cond
9804 ((org-at-date-range-p t)
9805 (let ((org-agenda-start-on-weekday)
9806 (t1 (match-string 1))
9807 (t2 (match-string 2)))
9808 (setq t1 (time-to-days (org-time-string-to-time t1))
9809 t2 (time-to-days (org-time-string-to-time t2)))
9810 (org-agenda-list nil t1 (1+ (- t2 t1)))))
9811 ((org-at-timestamp-p t)
9812 (org-agenda-list nil (time-to-days (org-time-string-to-time
9813 (substring (match-string 1) 0 10)))
9814 1))
9815 (t (error "This should not happen"))))
9818 ;;; Following file links
9819 (defvar org-wait nil)
9820 (defun org-open-file (path &optional in-emacs line search)
9821 "Open the file at PATH.
9822 First, this expands any special file name abbreviations. Then the
9823 configuration variable `org-file-apps' is checked if it contains an
9824 entry for this file type, and if yes, the corresponding command is launched.
9826 If no application is found, Emacs simply visits the file.
9828 With optional prefix argument IN-EMACS, Emacs will visit the file.
9830 prefix arg, Org tries to avoid opening in Emacs
9831 and to use an external application to visit the file.
9833 Optional LINE specifies a line to go to, optional SEARCH a string
9834 to search for. If LINE or SEARCH is given, the file will be
9835 opened in Emacs, unless an entry from org-file-apps that makes
9836 use of groups in a regexp matches.
9837 If the file does not exist, an error is thrown."
9838 (let* ((file (if (equal path "")
9839 buffer-file-name
9840 (substitute-in-file-name (expand-file-name path))))
9841 (file-apps (append org-file-apps (org-default-apps)))
9842 (apps (org-remove-if
9843 'org-file-apps-entry-match-against-dlink-p file-apps))
9844 (apps-dlink (org-remove-if-not
9845 'org-file-apps-entry-match-against-dlink-p file-apps))
9846 (remp (and (assq 'remote apps) (org-file-remote-p file)))
9847 (dirp (if remp nil (file-directory-p file)))
9848 (file (if (and dirp org-open-directory-means-index-dot-org)
9849 (concat (file-name-as-directory file) "index.org")
9850 file))
9851 (a-m-a-p (assq 'auto-mode apps))
9852 (dfile (downcase file))
9853 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
9854 (link (cond ((and (eq line nil)
9855 (eq search nil))
9856 file)
9857 (line
9858 (concat file "::" (number-to-string line)))
9859 (search
9860 (concat file "::" search))))
9861 (dlink (downcase link))
9862 (old-buffer (current-buffer))
9863 (old-pos (point))
9864 (old-mode major-mode)
9865 ext cmd link-match-data)
9867 (setq ext (match-string 1 dfile))
9869 (setq ext (match-string 1 dfile))))
9870 (cond
9871 ((member in-emacs '((16) system))
9872 (setq cmd (cdr (assoc 'system apps))))
9873 (in-emacs (setq cmd 'emacs))
9874 (t
9875 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
9876 (and dirp (cdr (assoc 'directory apps)))
9877 ; first, try matching against apps-dlink
9878 ; if we get a match here, store the match data for later
9879 (let ((match (assoc-default dlink apps-dlink
9880 'string-match)))
9881 (if match
9882 (progn (setq link-match-data (match-data))
9883 match)
9884 (progn (setq in-emacs (or in-emacs line search))
9885 nil))) ; if we have no match in apps-dlink,
9886 ; always open the file in emacs if line or search
9887 ; is given (for backwards compatibility)
9888 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
9889 'string-match)
9890 (cdr (assoc ext apps))
9891 (cdr (assoc t apps))))))
9892 (when (eq cmd 'system)
9893 (setq cmd (cdr (assoc 'system apps))))
9894 (when (eq cmd 'default)
9895 (setq cmd (cdr (assoc t apps))))
9896 (when (eq cmd 'mailcap)
9897 (require 'mailcap)
9898 (mailcap-parse-mailcaps)
9899 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
9900 (command (mailcap-mime-info mime-type)))
9901 (if (stringp command)
9902 (setq cmd command)
9903 (setq cmd 'emacs))))
9904 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
9905 (not (file-exists-p file))
9906 (not org-open-non-existing-files))
9907 (error "No such file: %s" file))
9908 (cond
9910 ;; Remove quotes around the file name - we'll use shell-quote-argument.
9912 (setq cmd (replace-match "%s" t t cmd)))
9913 (while (string-match "%s" cmd)
9914 (setq cmd (replace-match
9915 (save-match-data
9916 (shell-quote-argument
9917 (convert-standard-filename file)))
9918 t t cmd)))
9920 ;; Replace "%1", "%2" etc. in command with group matches from regex
9921 (save-match-data
9922 (let ((match-index 1)
9923 (number-of-groups (- (/ (length link-match-data) 2) 1)))
9924 (set-match-data link-match-data)
9925 (while (<= match-index number-of-groups)
9926 (let ((regex (concat "%" (number-to-string match-index)))
9927 (replace-with (match-string match-index dlink)))
9928 (while (string-match regex cmd)
9929 (setq cmd (replace-match replace-with t t cmd))))
9930 (setq match-index (+ match-index 1)))))
9932 (save-window-excursion
9933 (start-process-shell-command cmd nil cmd)
9934 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
9935 ))
9936 ((or (stringp cmd)
9937 (eq cmd 'emacs))
9938 (funcall (cdr (assq 'file org-link-frame-setup)) file)
9939 (widen)
9940 (if line (org-goto-line line)
9941 (if search (org-link-search search))))
9942 ((consp cmd)
9943 (let ((file (convert-standard-filename file)))
9944 (save-match-data
9945 (set-match-data link-match-data)
9946 (eval cmd))))
9947 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
9948 (and (org-mode-p) (eq old-mode 'org-mode)
9949 (or (not (equal old-buffer (current-buffer)))
9950 (not (equal old-pos (point))))
9951 (org-mark-ring-push old-pos old-buffer))))
9953 (defun org-file-apps-entry-match-against-dlink-p (entry)
9954 "This function returns non-nil if `entry' uses a regular
9955 expression which should be matched against the whole link by
9956 org-open-file.
9958 It assumes that is the case when the entry uses a regular
9959 expression which has at least one grouping construct and the
9960 action is either a lisp form or a command string containing
9961 '%1', i.e. using at least one subexpression match as a
9962 parameter."
9963 (let ((selector (car entry))
9964 (action (cdr entry)))
9965 (if (stringp selector)
9966 (and (> (regexp-opt-depth selector) 0)
9967 (or (and (stringp action)
9968 (string-match "%[0-9]" action))
9969 (consp action)))
9970 nil)))
9972 (defun org-default-apps ()
9973 "Return the default applications for this operating system."
9974 (cond
9975 ((eq system-type 'darwin)
9976 org-file-apps-defaults-macosx)
9977 ((eq system-type 'windows-nt)
9978 org-file-apps-defaults-windowsnt)
9979 (t org-file-apps-defaults-gnu)))
9981 (defun org-apps-regexp-alist (list &optional add-auto-mode)
9982 "Convert extensions to regular expressions in the cars of LIST.
9983 Also, weed out any non-string entries, because the return value is used
9984 only for regexp matching.
9985 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
9986 point to the symbol `emacs', indicating that the file should
9987 be opened in Emacs."
9988 (append
9989 (delq nil
9990 (mapcar (lambda (x)
9991 (if (not (stringp (car x)))
9992 nil
9994 x
9996 list))
9997 (if add-auto-mode
9998 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10000 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10001 (defun org-file-remote-p (file)
10002 "Test whether FILE specifies a location on a remote system.
10003 Return non-nil if the location is indeed remote.
10007 (cond ((fboundp 'file-remote-p)
10008 (file-remote-p file))
10009 ((fboundp 'tramp-handle-file-remote-p)
10010 (tramp-handle-file-remote-p file))
10011 ((and (boundp 'ange-ftp-name-format)
10012 (string-match (car ange-ftp-name-format) file))
10013 t)
10014 (t nil)))
10017 ;;;; Refiling
10019 (defun org-get-org-file ()
10020 "Read a filename, with default directory `org-directory'."
10021 (let ((default (or org-default-notes-file remember-data-file)))
10022 (read-file-name (format "File name [%s]: " default)
10023 (file-name-as-directory org-directory)
10024 default)))
10026 (defun org-notes-order-reversed-p ()
10027 "Check if the current file should receive notes in reversed order."
10028 (cond
10029 ((not org-reverse-note-order) nil)
10030 ((eq t org-reverse-note-order) t)
10031 ((not (listp org-reverse-note-order)) nil)
10032 (t (catch 'exit
10033 (let ((all org-reverse-note-order)
10034 entry)
10035 (while (setq entry (pop all))
10036 (if (string-match (car entry) buffer-file-name)
10037 (throw 'exit (cdr entry))))
10038 nil)))))
10040 (defvar org-refile-target-table nil
10041 "The list of refile targets, created by `org-refile'.")
10043 (defvar org-agenda-new-buffers nil
10044 "Buffers created to visit agenda files.")
10046 (defvar org-refile-cache nil
10047 "Cache for refile targets.")
10049 (defvar org-refile-markers nil
10050 "All the markers used for caching refile locations.")
10052 (defun org-refile-marker (pos)
10053 "Get a new refile marker, but only if caching is in use."
10054 (if (not org-refile-use-cache)
10055 pos
10056 (let ((m (make-marker)))
10057 (move-marker m pos)
10058 (push m org-refile-markers)
10059 m)))
10061 (defun org-refile-cache-clear ()
10062 "Clear the refile cache and disable all the markers."
10063 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10064 (setq org-refile-markers nil)
10065 (setq org-refile-cache nil)
10066 (message "Refile cache has been cleared"))
10068 (defun org-refile-cache-check-set (set)
10069 "Check if all the markers in the cache still have live buffers."
10070 (let (marker)
10071 (catch 'exit
10072 (while (and set (setq marker (nth 3 (pop set))))
10073 ;; if org-refile-use-outline-path is 'file, marker may be nil
10074 (when (and marker (null (marker-buffer marker)))
10075 (message "not found") (sit-for 3)
10076 (throw 'exit nil)))
10077 t)))
10079 (defun org-refile-cache-put (set &rest identifiers)
10080 "Push the refile targets SET into the cache, under IDENTIFIERS."
10081 (let* ((key (sha1 (prin1-to-string identifiers)))
10082 (entry (assoc key org-refile-cache)))
10083 (if entry
10084 (setcdr entry set)
10085 (push (cons key set) org-refile-cache))))
10087 (defun org-refile-cache-get (&rest identifiers)
10088 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10089 (cond
10090 ((not org-refile-cache) nil)
10091 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10092 (t
10093 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10094 org-refile-cache))))
10095 (and set (org-refile-cache-check-set set) set)))))
10097 (defun org-refile-get-targets (&optional default-buffer)
10098 "Produce a table with refile targets."
10099 (let ((case-fold-search nil)
10100 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10101 (entries (or org-refile-targets '((nil . (:level . 1)))))
10102 targets tgs txt re files f desc descre fast-path-p level pos0)
10103 (message "Getting targets...")
10104 (with-current-buffer (or default-buffer (current-buffer))
10105 (while (setq entry (pop entries))
10106 (setq files (car entry) desc (cdr entry))
10107 (setq fast-path-p nil)
10108 (cond
10109 ((null files) (setq files (list (current-buffer))))
10110 ((eq files 'org-agenda-files)
10111 (setq files (org-agenda-files 'unrestricted)))
10112 ((and (symbolp files) (fboundp files))
10113 (setq files (funcall files)))
10114 ((and (symbolp files) (boundp files))
10115 (setq files (symbol-value files))))
10116 (if (stringp files) (setq files (list files)))
10117 (cond
10118 ((eq (car desc) :tag)
10120 ((eq (car desc) :todo)
10122 ((eq (car desc) :regexp)
10123 (setq descre (cdr desc)))
10124 ((eq (car desc) :level)
10126 (if org-odd-levels-only
10127 (1- (* 2 (cdr desc)))
10128 (cdr desc)))
10130 ((eq (car desc) :maxlevel)
10131 (setq fast-path-p t)
10133 (if org-odd-levels-only
10134 (1- (* 2 (cdr desc)))
10135 (cdr desc)))
10137 (t (error "Bad refiling target description %s" desc)))
10138 (while (setq f (pop files))
10139 (with-current-buffer
10140 (if (bufferp f) f (org-get-agenda-file-buffer f))
10141 (or
10142 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10143 (progn
10144 (if (bufferp f) (setq f (buffer-file-name
10145 (buffer-base-buffer f))))
10146 (setq f (and f (expand-file-name f)))
10147 (if (eq org-refile-use-outline-path 'file)
10148 (push (list (file-name-nondirectory f) f nil nil) tgs))
10149 (save-excursion
10150 (save-restriction
10151 (widen)
10152 (goto-char (point-min))
10153 (while (re-search-forward descre nil t)
10154 (goto-char (setq pos0 (point-at-bol)))
10155 (catch 'next
10156 (when org-refile-target-verify-function
10157 (save-match-data
10158 (or (funcall org-refile-target-verify-function)
10159 (throw 'next t))))
10160 (when (looking-at org-complex-heading-regexp)
10161 (setq level (org-reduced-level
10162 (- (match-end 1) (match-beginning 1)))
10163 txt (org-link-display-format (match-string 4))
10165 re (format org-complex-heading-regexp-format
10166 (regexp-quote (match-string 4))))
10167 (when org-refile-use-outline-path
10168 (setq txt (mapconcat
10169 'org-protect-slash
10170 (append
10171 (if (eq org-refile-use-outline-path
10172 'file)
10173 (list (file-name-nondirectory
10174 (buffer-file-name
10175 (buffer-base-buffer))))
10176 (if (eq org-refile-use-outline-path
10177 'full-file-path)
10178 (list (buffer-file-name
10179 (buffer-base-buffer)))))
10180 (org-get-outline-path fast-path-p
10181 level txt)
10182 (list txt))
10183 "/")))
10184 (push (list txt f re (org-refile-marker (point)))
10185 tgs)))
10186 (when (= (point) pos0)
10187 ;; verification function has not moved point
10188 (goto-char (point-at-eol))))))))
10189 (when org-refile-use-cache
10190 (org-refile-cache-put tgs (buffer-file-name) descre))
10191 (setq targets (append tgs targets))
10192 ))))
10193 (message "Getting targets...done")
10194 (nreverse targets)))
10196 (defun org-protect-slash (s)
10197 (while (string-match "/" s)
10199 s)
10201 (defvar org-olpa (make-vector 20 nil))
10203 (defun org-get-outline-path (&optional fastp level heading)
10204 "Return the outline path to the current entry, as a list.
10206 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10207 routine which makes outline path derivations for an entire file,
10208 avoiding backtracing. Refile target collection makes use of that."
10209 (if fastp
10210 (progn
10211 (if (> level 19)
10212 (error "Outline path failure, more than 19 levels"))
10213 (loop for i from level upto 19 do
10214 (aset org-olpa i nil))
10215 (prog1
10216 (delq nil (append org-olpa nil))
10217 (aset org-olpa level heading)))
10218 (let (rtn case-fold-search)
10219 (save-excursion
10220 (save-restriction
10221 (widen)
10222 (while (org-up-heading-safe)
10223 (when (looking-at org-complex-heading-regexp)
10224 (push (org-match-string-no-properties 4) rtn)))
10225 rtn)))))
10227 (defun org-format-outline-path (path &optional width prefix)
10228 "Format the outline path PATH for display.
10229 Width is the maximum number of characters that is available.
10230 Prefix is a prefix to be included in the returned string,
10231 such as the file name."
10232 (setq width (or width 79))
10233 (if prefix (setq width (- width (length prefix))))
10234 (if (not path)
10235 (or prefix "")
10236 (let* ((nsteps (length path))
10237 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10238 (maxwidth (if (<= total-width width)
10239 10000 ;; everything fits
10240 ;; we need to shorten the level headings
10241 (/ (- width nsteps) nsteps)))
10242 (org-odd-levels-only nil)
10243 (n 0)
10244 (total (1+ (length prefix))))
10245 (setq maxwidth (max maxwidth 10))
10246 (concat prefix
10247 (mapconcat
10248 (lambda (h)
10249 (setq n (1+ n))
10250 (if (and (= n nsteps) (< maxwidth 10000))
10251 (setq maxwidth (- total-width total)))
10252 (if (< (length h) maxwidth)
10253 (progn (setq total (+ total (length h) 1)) h)
10254 (setq h (substring h 0 (- maxwidth 2))
10255 total (+ total maxwidth 1))
10257 (setq h (substring h 0 (match-beginning 0))))
10258 (setq h (concat h "..")))
10259 (org-add-props h nil 'face
10260 (nth (% (1- n) org-n-level-faces)
10261 org-level-faces))
10262 h)
10263 path "/")))))
10265 (defun org-display-outline-path (&optional file current)
10266 "Display the current outline path in the echo area."
10267 (interactive "P")
10268 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10269 (case-fold-search nil)
10270 (path (and (org-mode-p) (org-get-outline-path))))
10271 (if current (setq path (append path
10272 (save-excursion
10273 (org-back-to-heading t)
10274 (if (looking-at org-complex-heading-regexp)
10275 (list (match-string 4)))))))
10276 (message "%s"
10277 (org-format-outline-path
10278 path
10279 (1- (frame-width))
10280 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10282 (defvar org-refile-history nil
10283 "History for refiling operations.")
10285 (defvar org-after-refile-insert-hook nil
10286 "Hook run after `org-refile' has inserted its stuff at the new location.
10287 Note that this is still *before* the stuff will be removed from
10288 the *old* location.")
10290 (defvar org-capture-last-stored-marker)
10291 (defun org-refile (&optional goto default-buffer rfloc)
10292 "Move the entry at point to another heading.
10293 The list of target headings is compiled using the information in
10294 `org-refile-targets', which see. This list is created before each use
10295 and will therefore always be up-to-date.
10297 At the target location, the entry is filed as a subitem of the target heading.
10298 Depending on `org-reverse-note-order', the new subitem will either be the
10299 first or the last subitem.
10301 If there is an active region, all entries in that region will be moved.
10302 However, the region must fulfill the requirement that the first heading
10303 is the first one sets the top-level of the moved text - at most siblings
10304 below it are allowed.
10306 With prefix arg GOTO, the command will only visit the target location,
10307 not actually move anything.
10309 go to the location where the last refiling
10310 operation has put the subtree.
10311 With a prefix argument of `2', refile to the running clock.
10313 RFLOC can be a refile location obtained in a different way.
10315 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10317 If you are using target caching (see `org-refile-use-cache'),
10318 You have to clear the target cache in order to find new targets.
10319 This can be done with a 0 prefix: `C-0 C-c C-w'"
10320 (interactive "P")
10321 (if (member goto '(0 (64)))
10322 (org-refile-cache-clear)
10323 (let* ((cbuf (current-buffer))
10324 (regionp (org-region-active-p))
10325 (region-start (and regionp (region-beginning)))
10326 (region-end (and regionp (region-end)))
10327 (region-length (and regionp (- region-end region-start)))
10328 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10329 pos it nbuf file re level reversed)
10330 (setq last-command nil)
10331 (when regionp
10332 (goto-char region-start)
10333 (or (bolp) (goto-char (point-at-bol)))
10334 (setq region-start (point))
10335 (unless (org-kill-is-subtree-p
10336 (buffer-substring region-start region-end))
10337 (error "The region is not a (sequence of) subtree(s)")))
10338 (if (equal goto '(16))
10339 (org-refile-goto-last-stored)
10340 (when (or
10341 (and (equal goto 2)
10342 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10343 (prog1
10344 (setq it (list (or org-clock-heading "running clock")
10345 (buffer-file-name
10346 (marker-buffer org-clock-hd-marker))
10347 ""
10348 (marker-position org-clock-hd-marker)))
10349 (setq goto nil)))
10350 (setq it (or rfloc
10351 (save-excursion
10352 (org-refile-get-location
10353 (if goto "Goto" "Refile to") default-buffer
10354 org-refile-allow-creating-parent-nodes)))))
10355 (setq file (nth 1 it)
10356 re (nth 2 it)
10357 pos (nth 3 it))
10358 (if (and (not goto)
10359 pos
10360 (equal (buffer-file-name) file)
10361 (if regionp
10362 (and (>= pos region-start)
10363 (<= pos region-end))
10364 (and (>= pos (point))
10365 (< pos (save-excursion
10366 (org-end-of-subtree t t))))))
10367 (error "Cannot refile to position inside the tree or region"))
10369 (setq nbuf (or (find-buffer-visiting file)
10370 (find-file-noselect file)))
10371 (if goto
10372 (progn
10373 (switch-to-buffer nbuf)
10374 (goto-char pos)
10375 (org-show-context 'org-goto))
10376 (if regionp
10377 (progn
10378 (org-kill-new (buffer-substring region-start region-end))
10379 (org-save-markers-in-region region-start region-end))
10380 (org-copy-subtree 1 nil t))
10381 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10382 (find-file-noselect file)))
10383 (setq reversed (org-notes-order-reversed-p))
10384 (save-excursion
10385 (save-restriction
10386 (widen)
10387 (if pos
10388 (progn
10389 (goto-char pos)
10390 (looking-at outline-regexp)
10391 (setq level (org-get-valid-level (funcall outline-level) 1))
10392 (goto-char
10393 (if reversed
10394 (or (outline-next-heading) (point-max))
10395 (or (save-excursion (org-get-next-sibling))
10396 (org-end-of-subtree t t)
10397 (point-max)))))
10398 (setq level 1)
10399 (if (not reversed)
10400 (goto-char (point-max))
10401 (goto-char (point-min))
10402 (or (outline-next-heading) (goto-char (point-max)))))
10403 (if (not (bolp)) (newline))
10404 (org-paste-subtree level)
10405 (when org-log-refile
10406 (org-add-log-setup 'refile nil nil 'findpos
10407 org-log-refile)
10408 (unless (eq org-log-refile 'note)
10409 (save-excursion (org-add-log-note))))
10410 (and org-auto-align-tags (org-set-tags nil t))
10411 (bookmark-set "org-refile-last-stored")
10412 ;; If we are refiling for capture, make sure that the
10413 ;; last-capture pointers point here
10414 (when (org-bound-and-true-p org-refile-for-capture)
10415 (bookmark-set "org-capture-last-stored-marker")
10416 (move-marker org-capture-last-stored-marker (point)))
10417 (if (fboundp 'deactivate-mark) (deactivate-mark))
10418 (run-hooks 'org-after-refile-insert-hook))))
10419 (if regionp
10420 (delete-region (point) (+ (point) region-length))
10421 (org-cut-subtree))
10422 (when (featurep 'org-inlinetask)
10423 (org-inlinetask-remove-END-maybe))
10424 (setq org-markers-to-move nil)
10427 (defun org-refile-goto-last-stored ()
10428 "Go to the location where the last refile was stored."
10429 (interactive)
10430 (bookmark-jump "org-refile-last-stored")
10431 (message "This is the location of the last refile"))
10433 (defun org-refile-get-location (&optional prompt default-buffer new-nodes)
10434 "Prompt the user for a refile location, using PROMPT.
10435 PROMPT should not be suffixed with a colon and a space, because
10436 this function appends the default value from
10437 `org-refile-history' automatically, if that is not empty."
10438 (let ((org-refile-targets org-refile-targets)
10439 (org-refile-use-outline-path org-refile-use-outline-path))
10440 (setq org-refile-target-table (org-refile-get-targets default-buffer)))
10441 (unless org-refile-target-table
10442 (error "No refile targets"))
10443 (let* ((prompt (concat prompt
10444 (and (car org-refile-history)
10445 (concat " (default " (car org-refile-history) ")"))
10446 ": "))
10447 (cbuf (current-buffer))
10448 (partial-completion-mode nil)
10449 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10450 (cfunc (if (and org-refile-use-outline-path
10451 org-outline-path-complete-in-steps)
10452 'org-olpath-completing-read
10453 'org-icompleting-read))
10454 (extra (if org-refile-use-outline-path "/" ""))
10455 (filename (and cfn (expand-file-name cfn)))
10456 (tbl (mapcar
10457 (lambda (x)
10458 (if (and (not (member org-refile-use-outline-path
10459 '(file full-file-path)))
10460 (not (equal filename (nth 1 x))))
10461 (cons (concat (car x) extra " ("
10462 (file-name-nondirectory (nth 1 x)) ")")
10463 (cdr x))
10464 (cons (concat (car x) extra) (cdr x))))
10465 org-refile-target-table))
10466 (completion-ignore-case t)
10467 pa answ parent-target child parent old-hist)
10468 (setq old-hist org-refile-history)
10469 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10470 nil 'org-refile-history (car org-refile-history)))
10471 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10472 (org-refile-check-position pa)
10473 (if pa
10474 (progn
10475 (when (or (not org-refile-history)
10476 (not (eq old-hist org-refile-history))
10477 (not (equal (car pa) (car org-refile-history))))
10478 (setq org-refile-history
10479 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10480 org-refile-history
10481 (cdr org-refile-history))))
10482 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10483 (pop org-refile-history)))
10484 pa)
10486 (progn
10487 (setq parent (match-string 1 answ)
10488 child (match-string 2 answ))
10489 (setq parent-target (or (assoc parent tbl)
10490 (assoc (concat parent "/") tbl)))
10491 (when (and parent-target
10492 (or (eq new-nodes t)
10493 (and (eq new-nodes 'confirm)
10495 child)))))
10496 (org-refile-new-child parent-target child)))
10497 (error "Invalid target location")))))
10499 (defun org-refile-check-position (refile-pointer)
10500 "Check if the refile pointer matches the readline to which it points."
10501 (let* ((file (nth 1 refile-pointer))
10502 (re (nth 2 refile-pointer))
10503 (pos (nth 3 refile-pointer))
10504 buffer)
10505 (when (org-string-nw-p re)
10506 (setq buffer (if (markerp pos)
10507 (marker-buffer pos)
10508 (or (find-buffer-visiting file)
10509 (find-file-noselect file))))
10510 (with-current-buffer buffer
10511 (save-excursion
10512 (save-restriction
10513 (widen)
10514 (goto-char pos)
10515 (beginning-of-line 1)
10516 (unless (org-looking-at-p re)
10517 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10519 (defun org-refile-new-child (parent-target child)
10520 "Use refile target PARENT-TARGET to add new CHILD below it."
10521 (unless parent-target
10522 (error "Cannot find parent for new node"))
10523 (let ((file (nth 1 parent-target))
10524 (pos (nth 3 parent-target))
10525 level)
10526 (with-current-buffer (or (find-buffer-visiting file)
10527 (find-file-noselect file))
10528 (save-excursion
10529 (save-restriction
10530 (widen)
10531 (if pos
10532 (goto-char pos)
10533 (goto-char (point-max))
10534 (if (not (bolp)) (newline)))
10535 (when (looking-at outline-regexp)
10536 (setq level (funcall outline-level))
10537 (org-end-of-subtree t t))
10538 (org-back-over-empty-lines)
10540 (if pos (org-get-valid-level level 1) 1) ?*)
10542 (beginning-of-line 0)
10543 (list (concat (car parent-target) "/" child) file "" (point)))))))
10545 (defun org-olpath-completing-read (prompt collection &rest args)
10546 "Read an outline path like a file name."
10547 (let ((thetable collection)
10548 (org-completion-use-ido nil) ; does not work with ido.
10549 (org-completion-use-iswitchb nil)) ; or iswitchb
10550 (apply
10551 'org-icompleting-read prompt
10552 (lambda (string predicate &optional flag)
10553 (let (rtn r f (l (length string)))
10554 (cond
10555 ((eq flag nil)
10556 ;; try completion
10557 (try-completion string thetable))
10558 ((eq flag t)
10559 ;; all-completions
10560 (setq rtn (all-completions string thetable predicate))
10561 (mapcar
10562 (lambda (x)
10563 (setq r (substring x l))
10564 (if (string-match " ([^)]*)$" x)
10565 (setq f (match-string 0 x))
10566 (setq f ""))
10567 (if (string-match "/" r)
10568 (concat string (substring r 0 (match-end 0)) f)
10569 x))
10570 rtn))
10571 ((eq flag 'lambda)
10572 ;; exact match?
10573 (assoc string thetable)))
10574 ))
10575 args)))
10577 ;;;; Dynamic blocks
10579 (defun org-find-dblock (name)
10580 "Find the first dynamic block with name NAME in the buffer.
10581 If not found, stay at current position and return nil."
10582 (let (pos)
10583 (save-excursion
10584 (goto-char (point-min))
10586 nil t)
10587 (match-beginning 0))))
10588 (if pos (goto-char pos))
10589 pos))
10591 (defconst org-dblock-start-re
10593 "Matches the start line of a dynamic block, with parameters.")
10596 "Matches the end of a dynamic block.")
10598 (defun org-create-dblock (plist)
10599 "Create a dynamic block section, with parameters taken from PLIST.
10600 PLIST must contain a :name entry which is used as name of the block."
10602 (end-of-line 1)
10603 (newline))
10604 (let ((col (current-column))
10605 (name (plist-get plist :name)))
10606 (insert "#+BEGIN: " name)
10607 (while plist
10608 (if (eq (car plist) :name)
10609 (setq plist (cddr plist))
10610 (insert " " (prin1-to-string (pop plist)))))
10612 (beginning-of-line -2)))
10614 (defun org-prepare-dblock ()
10615 "Prepare dynamic block for refresh.
10616 This empties the block, puts the cursor at the insert position and returns
10617 the property list including an extra property :name with the block name."
10618 (unless (looking-at org-dblock-start-re)
10619 (error "Not at a dynamic block"))
10620 (let* ((begdel (1+ (match-end 0)))
10621 (name (org-no-properties (match-string 1)))
10622 (params (append (list :name name)
10623 (read (concat "(" (match-string 3) ")")))))
10624 (save-excursion
10625 (beginning-of-line 1)
10627 (setq params (plist-put params :indentation-column (current-column))))
10628 (unless (re-search-forward org-dblock-end-re nil t)
10629 (error "Dynamic block not terminated"))
10630 (setq params
10631 (append params
10632 (list :content (buffer-substring
10633 begdel (match-beginning 0)))))
10634 (delete-region begdel (match-beginning 0))
10635 (goto-char begdel)
10636 (open-line 1)
10637 params))
10639 (defun org-map-dblocks (&optional command)
10640 "Apply COMMAND to all dynamic blocks in the current buffer.
10641 If COMMAND is not given, use `org-update-dblock'."
10642 (let ((cmd (or command 'org-update-dblock)))
10643 (save-excursion
10644 (goto-char (point-min))
10645 (while (re-search-forward org-dblock-start-re nil t)
10646 (goto-char (match-beginning 0))
10647 (save-excursion
10648 (condition-case nil
10649 (funcall cmd)
10650 (error (message "Error during update of dynamic block"))))
10651 (unless (re-search-forward org-dblock-end-re nil t)
10652 (error "Dynamic block not terminated"))))))
10654 (defun org-dblock-update (&optional arg)
10655 "User command for updating dynamic blocks.
10656 Update the dynamic block at point. With prefix ARG, update all dynamic
10657 blocks in the buffer."
10658 (interactive "P")
10659 (if arg
10660 (org-update-all-dblocks)
10661 (or (looking-at org-dblock-start-re)
10662 (org-beginning-of-dblock))
10663 (org-update-dblock)))
10665 (defun org-update-dblock ()
10666 "Update the dynamic block at point.
10667 This means to empty the block, parse for parameters and then call
10668 the correct writing function."
10669 (interactive)
10670 (save-window-excursion
10671 (let* ((pos (point))
10672 (line (org-current-line))
10673 (params (org-prepare-dblock))
10674 (name (plist-get params :name))
10675 (indent (plist-get params :indentation-column))
10676 (cmd (intern (concat "org-dblock-write:" name))))
10677 (message "Updating dynamic block `%s' at line %d..." name line)
10678 (funcall cmd params)
10679 (message "Updating dynamic block `%s' at line %d...done" name line)
10680 (goto-char pos)
10681 (when (and indent (> indent 0))
10682 (setq indent (make-string indent ?\ ))
10683 (save-excursion
10684 (org-beginning-of-dblock)
10685 (forward-line 1)
10686 (while (not (looking-at org-dblock-end-re))
10687 (insert indent)
10688 (beginning-of-line 2))
10689 (when (looking-at org-dblock-end-re)
10691 (replace-match ""))
10692 (insert indent)))))))
10694 (defun org-beginning-of-dblock ()
10695 "Find the beginning of the dynamic block at point.
10696 Error if there is no such block at point."
10697 (let ((pos (point))
10698 beg)
10699 (end-of-line 1)
10700 (if (and (re-search-backward org-dblock-start-re nil t)
10701 (setq beg (match-beginning 0))
10702 (re-search-forward org-dblock-end-re nil t)
10703 (> (match-end 0) pos))
10704 (goto-char beg)
10705 (goto-char pos)
10706 (error "Not in a dynamic block"))))
10708 (defun org-update-all-dblocks ()
10709 "Update all dynamic blocks in the buffer.
10710 This function can be used in a hook."
10711 (interactive)
10712 (when (org-mode-p)
10713 (org-map-dblocks 'org-update-dblock)))
10716 ;;;; Completion
10718 (defconst org-additional-option-like-keywords
10719 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
10720 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
10721 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
10722 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
10723 "BEGIN:" "END:"
10724 "ORGTBL" "TBLFM:" "TBLNAME:"
10725 "BEGIN_EXAMPLE" "END_EXAMPLE"
10726 "BEGIN_QUOTE" "END_QUOTE"
10727 "BEGIN_VERSE" "END_VERSE"
10728 "BEGIN_CENTER" "END_CENTER"
10729 "BEGIN_SRC" "END_SRC"
10730 "BEGIN_RESULT" "END_RESULT"
10731 "SOURCE:" "SRCNAME:" "FUNCTION:"
10732 "RESULTS:"
10733 "HEADER:" "HEADERS:"
10734 "BABEL:"
10735 "CATEGORY:" "COLUMNS:" "PROPERTY:"
10736 "CAPTION:" "LABEL:"
10737 "SETUPFILE:"
10738 "INCLUDE:"
10739 "BIND:"
10740 "MACRO:"))
10742 (defcustom org-structure-template-alist
10743 '(
10756 ("L" "#+latex: "
10760 ("H" "#+html: "
10763 ("A" "#+ascii: ")
10764 ("i" "#+index: ?"
10765 "#+index: ?")
10766 ("I" "#+include %file ?"
10768 )
10769 "Structure completion elements.
10770 This is a list of abbreviation keys and values. The value gets inserted
10771 if you type `<' followed by the key and then press the completion key,
10772 usually `M-TAB'. %file will be replaced by a file name after prompting
10773 for the file using completion. The cursor will be placed at the position
10774 of the `?` in the template.
10775 There are two templates for each key, the first uses the original Org syntax,
10776 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
10777 the default when the /org-mtags.el/ module has been loaded. See also the
10778 variable `org-mtags-prefer-muse-templates'.
10779 This is an experimental feature, it is undecided if it is going to stay in."
10780 :group 'org-completion
10781 :type '(repeat
10782 (string :tag "Key")
10783 (string :tag "Template")
10784 (string :tag "Muse Template")))
10786 (defun org-try-structure-completion ()
10787 "Try to complete a structure template before point.
10789 expands them."
10790 (let ((l (buffer-substring (point-at-bol) (point)))
10791 a)
10794 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
10795 (org-complete-expand-structure-template (+ -1 (point-at-bol)
10796 (match-beginning 1)) a)
10797 t)))
10799 (defun org-complete-expand-structure-template (start cell)
10800 "Expand a structure template."
10801 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
10802 (rpl (nth (if musep 2 1) cell))
10803 (ind ""))
10804 (delete-region start (point))
10806 (cond
10807 ((bolp))
10809 (setq ind (buffer-substring (point-at-bol) (point))))
10810 (t (newline))))
10811 (setq start (point))
10812 (if (string-match "%file" rpl)
10813 (setq rpl (replace-match
10814 (concat
10816 (save-match-data
10817 (abbreviate-file-name (read-file-name "Include file: ")))
10819 t t rpl)))
10822 (insert rpl)
10825 ;;;; TODO, DEADLINE, Comments
10827 (defun org-toggle-comment ()
10828 "Change the COMMENT state of an entry."
10829 (interactive)
10830 (save-excursion
10831 (org-back-to-heading)
10832 (let (case-fold-search)
10833 (if (looking-at (concat outline-regexp
10835 (replace-match "" t t nil 1)
10836 (if (looking-at outline-regexp)
10837 (progn
10838 (goto-char (match-end 0))
10839 (insert org-comment-string " ")))))))
10841 (defvar org-last-todo-state-is-todo nil
10842 "This is non-nil when the last TODO state change led to a TODO state.
10843 If the last change removed the TODO tag or switched to DONE, then
10844 this is nil.")
10846 (defvar org-setting-tags nil) ; dynamically skipped
10848 (defvar org-todo-setup-filter-hook nil
10849 "Hook for functions that pre-filter todo specs.
10850 Each function takes a todo spec and returns either nil or the spec
10851 transformed into canonical form." )
10853 (defvar org-todo-get-default-hook nil
10854 "Hook for functions that get a default item for todo.
10855 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
10856 nil or a string to be used for the todo mark." )
10858 (defvar org-agenda-headline-snapshot-before-repeat)
10860 (defun org-todo (&optional arg)
10861 "Change the TODO state of an item.
10862 The state of an item is given by a keyword at the start of the heading,
10863 like
10864 *** TODO Write paper
10865 *** DONE Call mom
10867 The different keywords are specified in the variable `org-todo-keywords'.
10869 So for this example: when the item starts with TODO, it is changed to DONE.
10870 When it starts with DONE, the DONE is removed. And when neither TODO nor
10871 DONE are present, add TODO at the beginning of the heading.
10874 state.
10875 With numeric prefix arg, switch to that state.
10877 keywords (nextset).
10880 For calling through lisp, arg is also interpreted in the following way:
10881 'none -> empty state
10883 'done -> switch to DONE
10884 'nextset -> switch to the next set of keywords
10885 'previousset -> switch to the previous set of keywords
10887 really is a member of `org-todo-keywords'."
10888 (interactive "P")
10889 (if (equal arg '(16)) (setq arg 'nextset))
10890 (let ((org-blocker-hook org-blocker-hook)
10891 (case-fold-search nil))
10892 (when (equal arg '(64))
10893 (setq arg nil org-blocker-hook nil))
10894 (when (and org-blocker-hook
10895 (or org-inhibit-blocking
10896 (org-entry-get nil "NOBLOCKING")))
10897 (setq org-blocker-hook nil))
10898 (save-excursion
10899 (catch 'exit
10900 (org-back-to-heading t)
10901 (if (looking-at outline-regexp) (goto-char (1- (match-end 0))))
10903 (looking-at " *"))
10904 (let* ((match-data (match-data))
10905 (startpos (point-at-bol))
10906 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
10907 (org-log-done org-log-done)
10908 (org-log-repeat org-log-repeat)
10909 (org-todo-log-states org-todo-log-states)
10910 (this (match-string 1))
10911 (hl-pos (match-beginning 0))
10912 (head (org-get-todo-sequence-head this))
10913 (ass (assoc head org-todo-kwd-alist))
10914 (interpret (nth 1 ass))
10915 (done-word (nth 3 ass))
10916 (final-done-word (nth 4 ass))
10917 (last-state (or this ""))
10918 (completion-ignore-case t)
10919 (member (member this org-todo-keywords-1))
10920 (tail (cdr member))
10921 (state (cond
10922 ((and org-todo-key-trigger
10923 (or (and (equal arg '(4))
10924 (eq org-use-fast-todo-selection 'prefix))
10925 (and (not arg) org-use-fast-todo-selection
10926 (not (eq org-use-fast-todo-selection
10927 'prefix)))))
10928 ;; Use fast selection
10929 (org-fast-todo-selection))
10930 ((and (equal arg '(4))
10931 (or (not org-use-fast-todo-selection)
10932 (not org-todo-key-trigger)))
10933 ;; Read a state with completion
10934 (org-icompleting-read
10935 "State: " (mapcar (lambda(x) (list x))
10936 org-todo-keywords-1)
10937 nil t))
10938 ((eq arg 'right)
10939 (if this
10940 (if tail (car tail) nil)
10941 (car org-todo-keywords-1)))
10942 ((eq arg 'left)
10943 (if (equal member org-todo-keywords-1)
10944 nil
10945 (if this
10946 (nth (- (length org-todo-keywords-1)
10947 (length tail) 2)
10948 org-todo-keywords-1)
10949 (org-last org-todo-keywords-1))))
10950 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
10951 (setq arg nil))) ; hack to fall back to cycling
10952 (arg
10953 ;; user or caller requests a specific state
10954 (cond
10955 ((equal arg "") nil)
10956 ((eq arg 'none) nil)
10957 ((eq arg 'done) (or done-word (car org-done-keywords)))
10958 ((eq arg 'nextset)
10959 (or (car (cdr (member head org-todo-heads)))
10960 (car org-todo-heads)))
10961 ((eq arg 'previousset)
10962 (let ((org-todo-heads (reverse org-todo-heads)))
10963 (or (car (cdr (member head org-todo-heads)))
10964 (car org-todo-heads))))
10965 ((car (member arg org-todo-keywords-1)))
10966 ((stringp arg)
10967 (error "State `%s' not valid in this file" arg))
10968 ((nth (1- (prefix-numeric-value arg))
10969 org-todo-keywords-1))))
10970 ((null member) (or head (car org-todo-keywords-1)))
10971 ((equal this final-done-word) nil) ;; -> make empty
10972 ((null tail) nil) ;; -> first entry
10973 ((memq interpret '(type priority))
10974 (if (eq this-command last-command)
10975 (car tail)
10976 (if (> (length tail) 0)
10977 (or done-word (car org-done-keywords))
10978 nil)))
10979 (t
10980 (car tail))))
10981 (state (or
10982 (run-hook-with-args-until-success
10983 'org-todo-get-default-hook state last-state)
10984 state))
10985 (next (if state (concat " " state " ") " "))
10986 (change-plist (list :type 'todo-state-change :from this :to state
10987 :position startpos))
10988 dolog now-done-p)
10989 (when org-blocker-hook
10990 (setq org-last-todo-state-is-todo
10991 (not (member this org-done-keywords)))
10992 (unless (save-excursion
10993 (save-match-data
10994 (org-with-wide-buffer
10995 (run-hook-with-args-until-failure
10996 'org-blocker-hook change-plist))))
10997 (if (interactive-p)
10998 (error "TODO state change from %s to %s blocked" this state)
10999 ;; fail silently
11000 (message "TODO state change from %s to %s blocked" this state)
11001 (throw 'exit nil))))
11002 (store-match-data match-data)
11003 (replace-match next t t)
11004 (unless (pos-visible-in-window-p hl-pos)
11005 (message "TODO state changed to %s" (org-trim next)))
11006 (unless head
11007 (setq head (org-get-todo-sequence-head state)
11008 ass (assoc head org-todo-kwd-alist)
11009 interpret (nth 1 ass)
11010 done-word (nth 3 ass)
11011 final-done-word (nth 4 ass)))
11012 (when (memq arg '(nextset previousset))
11013 (message "Keyword-Set %d/%d: %s"
11014 (- (length org-todo-sets) -1
11015 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11016 (length org-todo-sets)
11017 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11018 (setq org-last-todo-state-is-todo
11019 (not (member state org-done-keywords)))
11020 (setq now-done-p (and (member state org-done-keywords)
11021 (not (member this org-done-keywords))))
11022 (and logging (org-local-logging logging))
11023 (when (and (or org-todo-log-states org-log-done)
11024 (not (eq org-inhibit-logging t))
11025 (not (memq arg '(nextset previousset))))
11026 ;; we need to look at recording a time and note
11027 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11028 (nth 2 (assoc this org-todo-log-states))))
11029 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11030 (setq dolog 'time))
11031 (when (and state
11032 (member state org-not-done-keywords)
11033 (not (member this org-not-done-keywords)))
11034 ;; This is now a todo state and was not one before
11035 ;; If there was a CLOSED time stamp, get rid of it.
11036 (org-add-planning-info nil nil 'closed))
11037 (when (and now-done-p org-log-done)
11038 ;; It is now done, and it was not done before
11039 (org-add-planning-info 'closed (org-current-time))
11040 (if (and (not dolog) (eq 'note org-log-done))
11041 (org-add-log-setup 'done state this 'findpos 'note)))
11042 (when (and state dolog)
11043 ;; This is a non-nil state, and we need to log it
11044 (org-add-log-setup 'state state this 'findpos dolog)))
11045 ;; Fixup tag positioning
11046 (org-todo-trigger-tag-changes state)
11047 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11048 (when org-provide-todo-statistics
11049 (org-update-parent-todo-statistics))
11050 (run-hooks 'org-after-todo-state-change-hook)
11051 (if (and arg (not (member state org-done-keywords)))
11052 (setq head (org-get-todo-sequence-head state)))
11053 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11054 ;; Do we need to trigger a repeat?
11055 (when now-done-p
11056 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11057 ;; This is for the agenda, take a snapshot of the headline.
11058 (save-match-data
11059 (setq org-agenda-headline-snapshot-before-repeat
11060 (org-get-heading))))
11061 (org-auto-repeat-maybe state))
11062 ;; Fixup cursor location if close to the keyword
11063 (if (and (outline-on-heading-p)
11064 (not (bolp))
11065 (save-excursion (beginning-of-line 1)
11066 (looking-at org-todo-line-regexp))
11067 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11068 (progn
11069 (goto-char (or (match-end 2) (match-end 1)))
11070 (and (looking-at " ") (just-one-space))))
11071 (when org-trigger-hook
11072 (save-excursion
11073 (run-hook-with-args 'org-trigger-hook change-plist))))))))
11075 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11076 "Block turning an entry into a TODO, using the hierarchy.
11077 This checks whether the current task should be blocked from state
11078 changes. Such blocking occurs when:
11080 1. The task has children which are not all in a completed state.
11082 2. A task has a parent with the property :ORDERED:, and there
11083 are siblings prior to the current task with incomplete
11084 status.
11086 3. The parent of the task is blocked because it has siblings that should
11087 be done first, or is child of a block grandparent TODO entry."
11089 (if (not org-enforce-todo-dependencies)
11090 t ; if locally turned off don't block
11091 (catch 'dont-block
11092 ;; If this is not a todo state change, or if this entry is already DONE,
11093 ;; do not block
11094 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11095 (member (plist-get change-plist :from)
11096 (cons 'done org-done-keywords))
11097 (member (plist-get change-plist :to)
11098 (cons 'todo org-not-done-keywords))
11099 (not (plist-get change-plist :to)))
11100 (throw 'dont-block t))
11101 ;; If this task has children, and any are undone, it's blocked
11102 (save-excursion
11103 (org-back-to-heading t)
11104 (let ((this-level (funcall outline-level)))
11105 (outline-next-heading)
11106 (let ((child-level (funcall outline-level)))
11107 (while (and (not (eobp))
11108 (> child-level this-level))
11109 ;; this todo has children, check whether they are all
11110 ;; completed
11111 (if (and (not (org-entry-is-done-p))
11112 (org-entry-is-todo-p))
11113 (throw 'dont-block nil))
11114 (outline-next-heading)
11115 (setq child-level (funcall outline-level))))))
11116 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11117 ;; any previous siblings are undone, it's blocked
11118 (save-excursion
11119 (org-back-to-heading t)
11120 (let* ((pos (point))
11121 (parent-pos (and (org-up-heading-safe) (point))))
11122 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11123 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11124 (forward-line 1)
11125 (re-search-forward org-not-done-heading-regexp pos t))
11126 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11127 ;; Search further up the hierarchy, to see if an anchestor is blocked
11128 (while t
11129 (goto-char parent-pos)
11130 (if (not (looking-at org-not-done-heading-regexp))
11131 (throw 'dont-block t)) ; do not block, parent is not a TODO
11132 (setq pos (point))
11133 (setq parent-pos (and (org-up-heading-safe) (point)))
11134 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11135 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11136 (forward-line 1)
11137 (re-search-forward org-not-done-heading-regexp pos t))
11138 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11140 (defcustom org-track-ordered-property-with-tag nil
11141 "Should the ORDERED property also be shown as a tag?
11142 The ORDERED property decides if an entry should require subtasks to be
11143 completed in sequence. Since a property is not very visible, setting
11144 this option means that toggling the ORDERED property with the command
11145 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11146 not relevant for the behavior, but it makes things more visible.
11148 Note that toggling the tag with tags commands will not change the property
11149 and therefore not influence behavior!
11151 This can be t, meaning the tag ORDERED should be used, It can also be a
11152 string to select a different tag for this task."
11153 :group 'org-todo
11154 :type '(choice
11155 (const :tag "No tracking" nil)
11156 (const :tag "Track with ORDERED tag" t)
11157 (string :tag "Use other tag")))
11159 (defun org-toggle-ordered-property ()
11160 "Toggle the ORDERED property of the current entry.
11161 For better visibility, you can track the value of this property with a tag.
11162 See variable `org-track-ordered-property-with-tag'."
11163 (interactive)
11164 (let* ((t1 org-track-ordered-property-with-tag)
11165 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11166 (save-excursion
11167 (org-back-to-heading)
11168 (if (org-entry-get nil "ORDERED")
11169 (progn
11170 (org-delete-property "ORDERED")
11171 (and tag (org-toggle-tag tag 'off))
11172 (message "Subtasks can be completed in arbitrary order"))
11173 (org-entry-put nil "ORDERED" "t")
11174 (and tag (org-toggle-tag tag 'on))
11175 (message "Subtasks must be completed in sequence")))))
11177 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11178 (defun org-block-todo-from-checkboxes (change-plist)
11179 "Block turning an entry into a TODO, using checkboxes.
11180 This checks whether the current task should be blocked from state
11181 changes because there are unchecked boxes in this entry."
11182 (if (not org-enforce-todo-checkbox-dependencies)
11183 t ; if locally turned off don't block
11184 (catch 'dont-block
11185 ;; If this is not a todo state change, or if this entry is already DONE,
11186 ;; do not block
11187 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11188 (member (plist-get change-plist :from)
11189 (cons 'done org-done-keywords))
11190 (member (plist-get change-plist :to)
11191 (cons 'todo org-not-done-keywords))
11192 (not (plist-get change-plist :to)))
11193 (throw 'dont-block t))
11194 ;; If this task has checkboxes that are not checked, it's blocked
11195 (save-excursion
11196 (org-back-to-heading t)
11197 (let ((beg (point)) end)
11198 (outline-next-heading)
11199 (setq end (point))
11200 (goto-char beg)
11202 end t)
11203 (progn
11204 (if (boundp 'org-blocked-by-checkboxes)
11205 (setq org-blocked-by-checkboxes t))
11206 (throw 'dont-block nil)))))
11207 t))) ; do not block
11209 (defun org-entry-blocked-p ()
11210 "Is the current entry blocked?"
11211 (if (org-entry-get nil "NOBLOCKING")
11212 nil ;; Never block this entry
11213 (not
11214 (run-hook-with-args-until-failure
11215 'org-blocker-hook
11216 (list :type 'todo-state-change
11217 :position (point)
11218 :from 'todo
11219 :to 'done)))))
11221 (defun org-update-statistics-cookies (all)
11222 "Update the statistics cookie, either from TODO or from checkboxes.
11223 This should be called with the cursor in a line with a statistics cookie."
11224 (interactive "P")
11225 (if all
11226 (progn
11227 (org-update-checkbox-count 'all)
11228 (org-map-entries 'org-update-parent-todo-statistics))
11229 (if (not (org-on-heading-p))
11230 (org-update-checkbox-count)
11231 (let ((pos (move-marker (make-marker) (point)))
11232 end l1 l2)
11233 (ignore-errors (org-back-to-heading t))
11234 (if (not (org-on-heading-p))
11235 (org-update-checkbox-count)
11236 (setq l1 (org-outline-level))
11237 (setq end (save-excursion
11238 (outline-next-heading)
11239 (if (org-on-heading-p) (setq l2 (org-outline-level)))
11240 (point)))
11241 (if (and (save-excursion
11242 (re-search-forward
11244 (not (save-excursion (re-search-forward
11246 (org-update-checkbox-count)
11247 (if (and l2 (> l2 l1))
11248 (progn
11249 (goto-char end)
11250 (org-update-parent-todo-statistics))
11251 (goto-char pos)
11252 (beginning-of-line 1)
11253 (while (re-search-forward
11255 (point-at-eol) t)
11256 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11257 (goto-char pos)
11258 (move-marker pos nil)))))
11260 (defvar org-entry-property-inherited-from) ;; defined below
11261 (defun org-update-parent-todo-statistics ()
11262 "Update any statistics cookie in the parent of the current headline.
11263 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11264 the entire subtree and this will travel up the hierarchy and update
11265 statistics everywhere."
11266 (interactive)
11267 (let* ((lim 0) prop
11268 (recursive (or (not org-hierarchical-todo-statistics)
11269 (string-match
11271 (or (setq prop (org-entry-get
11272 nil "COOKIE_DATA" 'inherit)) ""))))
11273 (lim (or (and prop (marker-position
11274 org-entry-property-inherited-from))
11275 lim))
11276 (first t)
11278 level ltoggle l1 new ndel
11279 (cnt-all 0) (cnt-done 0) is-percent kwd
11280 checkbox-beg ov ovs ove cookie-present)
11281 (catch 'exit
11282 (save-excursion
11283 (beginning-of-line 1)
11284 (if (org-at-heading-p)
11285 (setq ltoggle (funcall outline-level))
11286 (error "This should not happen"))
11287 (while (and (setq level (org-up-heading-safe))
11288 (or recursive first)
11289 (>= (point) lim))
11290 (setq first nil cookie-present nil)
11291 (unless (and level
11292 (not (string-match
11294 (downcase
11295 (or (org-entry-get
11296 nil "COOKIE_DATA")
11297 "")))))
11298 (throw 'exit nil))
11299 (while (re-search-forward box-re (point-at-eol) t)
11300 (setq cnt-all 0 cnt-done 0 cookie-present t)
11301 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11302 (save-match-data
11303 (unless (outline-next-heading) (throw 'exit nil))
11304 (while (and (looking-at org-complex-heading-regexp)
11305 (> (setq l1 (length (match-string 1))) level))
11306 (setq kwd (and (or recursive (= l1 ltoggle))
11307 (match-string 2)))
11308 (if (or (eq org-provide-todo-statistics 'all-headlines)
11309 (and (listp org-provide-todo-statistics)
11310 (or (member kwd org-provide-todo-statistics)
11311 (member kwd org-done-keywords))))
11312 (setq cnt-all (1+ cnt-all))
11313 (if (eq org-provide-todo-statistics t)
11314 (and kwd (setq cnt-all (1+ cnt-all)))))
11315 (and (member kwd org-done-keywords)
11316 (setq cnt-done (1+ cnt-done)))
11317 (outline-next-heading)))
11318 (setq new
11319 (if is-percent
11320 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11321 (format "[%d/%d]" cnt-done cnt-all))
11322 ndel (- (match-end 0) checkbox-beg))
11323 ;; handle overlays when updating cookie from column view
11324 (when (setq ov (car (overlays-at checkbox-beg)))
11325 (setq ovs (overlay-start ov) ove (overlay-end ov))
11326 (delete-overlay ov))
11327 (goto-char checkbox-beg)
11328 (insert new)
11329 (delete-region (point) (+ (point) ndel))
11330 (when ov (move-overlay ov ovs ove)))
11331 (when cookie-present
11332 (run-hook-with-args 'org-after-todo-statistics-hook
11333 cnt-done (- cnt-all cnt-done))))))
11334 (run-hooks 'org-todo-statistics-hook)))
11336 (defvar org-after-todo-statistics-hook nil
11337 "Hook that is called after a TODO statistics cookie has been updated.
11338 Each function is called with two arguments: the number of not-done entries
11339 and the number of done entries.
11341 For example, the following function, when added to this hook, will switch
11342 an entry to DONE when all children are done, and back to TODO when new
11343 entries are set to a TODO status. Note that this hook is only called
11344 when there is a statistics cookie in the headline!
11346 (defun org-summary-todo (n-done n-not-done)
11348 (let (org-log-done org-log-states) ; turn off logging
11350 ")
11352 (defvar org-todo-statistics-hook nil
11353 "Hook that is run whenever Org thinks TODO statistics should be updated.
11354 This hook runs even if there is no statistics cookie present, in which case
11355 `org-after-todo-statistics-hook' would not run.")
11357 (defun org-todo-trigger-tag-changes (state)
11358 "Apply the changes defined in `org-todo-state-tags-triggers'."
11359 (let ((l org-todo-state-tags-triggers)
11360 changes)
11361 (when (or (not state) (equal state ""))
11362 (setq changes (append changes (cdr (assoc "" l)))))
11363 (when (and (stringp state) (> (length state) 0))
11364 (setq changes (append changes (cdr (assoc state l)))))
11365 (when (member state org-not-done-keywords)
11366 (setq changes (append changes (cdr (assoc 'todo l)))))
11367 (when (member state org-done-keywords)
11368 (setq changes (append changes (cdr (assoc 'done l)))))
11369 (dolist (c changes)
11370 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11372 (defun org-local-logging (value)
11373 "Get logging settings from a property VALUE."
11374 (let* (words w a)
11375 ;; directly set the variables, they are already local.
11376 (setq org-log-done nil
11377 org-log-repeat nil
11378 org-todo-log-states nil)
11379 (setq words (org-split-string value))
11380 (while (setq w (pop words))
11381 (cond
11382 ((setq a (assoc w org-startup-options))
11383 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11384 (set (nth 1 a) (nth 2 a))))
11385 ((setq a (org-extract-log-state-settings w))
11386 (and (member (car a) org-todo-keywords-1)
11387 (push a org-todo-log-states)))))))
11389 (defun org-get-todo-sequence-head (kwd)
11390 "Return the head of the TODO sequence to which KWD belongs.
11391 If KWD is not set, check if there is a text property remembering the
11392 right sequence."
11393 (let (p)
11394 (cond
11395 ((not kwd)
11396 (or (get-text-property (point-at-bol) 'org-todo-head)
11397 (progn
11398 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11399 nil (point-at-eol)))
11400 (get-text-property p 'org-todo-head))))
11401 ((not (member kwd org-todo-keywords-1))
11402 (car org-todo-keywords-1))
11403 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11405 (defun org-fast-todo-selection ()
11406 "Fast TODO keyword selection with single keys.
11407 Returns the new TODO keyword, or nil if no state change should occur."
11408 (let* ((fulltable org-todo-key-alist)
11409 (done-keywords org-done-keywords) ;; needed for the faces.
11410 (maxlen (apply 'max (mapcar
11411 (lambda (x)
11412 (if (stringp (car x)) (string-width (car x)) 0))
11413 fulltable)))
11414 (expert nil)
11415 (fwidth (+ maxlen 3 1 3))
11416 (ncol (/ (- (window-width) 4) fwidth))
11417 tg cnt e c tbl
11418 groups ingroup)
11419 (save-excursion
11420 (save-window-excursion
11421 (if expert
11422 (set-buffer (get-buffer-create " *Org todo*"))
11423 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11424 (erase-buffer)
11425 (org-set-local 'org-done-keywords done-keywords)
11426 (setq tbl fulltable cnt 0)
11427 (while (setq e (pop tbl))
11428 (cond
11429 ((equal e '(:startgroup))
11430 (push '() groups) (setq ingroup t)
11431 (when (not (= cnt 0))
11432 (setq cnt 0)
11434 (insert "{ "))
11435 ((equal e '(:endgroup))
11436 (setq ingroup nil cnt 0)
11438 ((equal e '(:newline))
11439 (when (not (= cnt 0))
11440 (setq cnt 0)
11442 (setq e (car tbl))
11443 (while (equal (car tbl) '(:newline))
11445 (setq tbl (cdr tbl)))))
11446 (t
11447 (setq tg (car e) c (cdr e))
11448 (if ingroup (push tg (car groups)))
11449 (setq tg (org-add-props tg nil 'face
11450 (org-get-todo-face tg)))
11451 (if (and (= cnt 0) (not ingroup)) (insert " "))
11452 (insert "[" c "] " tg (make-string
11453 (- fwidth 4 (length tg)) ?\ ))
11454 (when (= (setq cnt (1+ cnt)) ncol)
11456 (if ingroup (insert " "))
11457 (setq cnt 0)))))
11459 (goto-char (point-min))
11460 (if (not expert) (org-fit-window-to-buffer))
11461 (message "[a-z..]:Set [SPC]:clear")
11462 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11463 (cond
11464 ((or (= c ?\C-g)
11465 (and (= c ?q) (not (rassoc c fulltable))))
11466 (setq quit-flag t))
11467 ((= c ?\ ) nil)
11468 ((setq e (rassoc c fulltable) tg (car e))
11469 tg)
11470 (t (setq quit-flag t)))))))
11472 (defun org-entry-is-todo-p ()
11473 (member (org-get-todo-state) org-not-done-keywords))
11475 (defun org-entry-is-done-p ()
11476 (member (org-get-todo-state) org-done-keywords))
11478 (defun org-get-todo-state ()
11479 (save-excursion
11480 (org-back-to-heading t)
11481 (and (looking-at org-todo-line-regexp)
11482 (match-end 2)
11483 (match-string 2))))
11485 (defun org-at-date-range-p (&optional inactive-ok)
11486 "Is the cursor inside a date range?"
11487 (interactive)
11488 (save-excursion
11489 (catch 'exit
11490 (let ((pos (point)))
11492 (skip-chars-backward "<[")
11493 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11494 (>= (match-end 0) pos)
11495 (throw 'exit t))
11497 (skip-chars-backward "<[")
11498 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11499 (>= (match-end 0) pos)
11500 (throw 'exit t)))
11501 nil)))
11503 (defun org-get-repeat (&optional tagline)
11504 "Check if there is a deadline/schedule with repeater in this entry."
11505 (save-match-data
11506 (save-excursion
11507 (org-back-to-heading t)
11508 (and (re-search-forward (if tagline
11510 org-repeat-re)
11511 (org-entry-end-position) t)
11512 (match-string-no-properties 1)))))
11514 (defvar org-last-changed-timestamp)
11515 (defvar org-last-inserted-timestamp)
11516 (defvar org-log-post-message)
11517 (defvar org-log-note-purpose)
11518 (defvar org-log-note-how)
11519 (defvar org-log-note-extra)
11520 (defun org-auto-repeat-maybe (done-word)
11521 "Check if the current headline contains a repeated deadline/schedule.
11522 If yes, set TODO state back to what it was and change the base date
11523 of repeating deadline/scheduled time stamps to new date.
11524 This function is run automatically after each state change to a DONE state."
11525 ;; last-state is dynamically scoped into this function
11526 (let* ((repeat (org-get-repeat))
11527 (aa (assoc last-state org-todo-kwd-alist))
11528 (interpret (nth 1 aa))
11529 (head (nth 2 aa))
11530 (whata '(("d" . day) ("m" . month) ("y" . year)))
11531 (msg "Entry repeats: ")
11532 (org-log-done nil)
11533 (org-todo-log-states nil)
11534 re type n what ts time to-state)
11535 (when repeat
11536 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11537 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11538 org-todo-repeat-to-state))
11539 (unless (and to-state (member to-state org-todo-keywords-1))
11540 (setq to-state (if (eq interpret 'type) last-state head)))
11541 (org-todo to-state)
11542 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11543 (org-entry-put nil "LAST_REPEAT" (format-time-string
11544 (org-time-stamp-format t t))))
11545 (when org-log-repeat
11546 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11547 (memq 'org-add-log-note post-command-hook))
11548 ;; OK, we are already setup for some record
11549 (if (eq org-log-repeat 'note)
11550 ;; make sure we take a note, not only a time stamp
11551 (setq org-log-note-how 'note))
11552 ;; Set up for taking a record
11553 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11554 last-state
11555 'findpos org-log-repeat)))
11556 (org-back-to-heading t)
11557 (org-add-planning-info nil nil 'closed)
11561 (while (re-search-forward
11562 re (save-excursion (outline-next-heading) (point)) t)
11563 (setq type (if (match-end 1) org-scheduled-string
11564 (if (match-end 3) org-deadline-string "Plain:"))
11565 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11567 (setq n (string-to-number (match-string 2 ts))
11568 what (match-string 3 ts))
11569 (if (equal what "w") (setq n (* n 7) what "d"))
11570 ;; Preparation, see if we need to modify the start date for the change
11571 (when (match-end 1)
11572 (setq time (save-match-data (org-time-string-to-time ts)))
11573 (cond
11574 ((equal (match-string 1 ts) ".")
11575 ;; Shift starting date to today
11576 (org-timestamp-change
11577 (- (time-to-days (current-time)) (time-to-days time))
11578 'day))
11579 ((equal (match-string 1 ts) "+")
11580 (let ((nshiftmax 10) (nshift 0))
11581 (while (or (= nshift 0)
11582 (<= (time-to-days time)
11583 (time-to-days (current-time))))
11584 (when (= (incf nshift) nshiftmax)
11585 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11586 (error "Abort")))
11587 (org-timestamp-change n (cdr (assoc what whata)))
11588 (org-at-timestamp-p t)
11589 (setq ts (match-string 1))
11590 (setq time (save-match-data (org-time-string-to-time ts)))))
11591 (org-timestamp-change (- n) (cdr (assoc what whata)))
11592 ;; rematch, so that we have everything in place for the real shift
11593 (org-at-timestamp-p t)
11594 (setq ts (match-string 1))
11596 (org-timestamp-change n (cdr (assoc what whata)))
11597 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11598 (setq org-log-post-message msg)
11599 (message "%s" msg))))
11601 (defun org-show-todo-tree (arg)
11602 "Make a compact tree which shows all headlines marked with TODO.
11603 The tree will show the lines where the regexp matches, and all higher
11604 headlines above the match.
11606 With a numeric prefix N, construct a sparse tree for the Nth element
11607 of `org-todo-keywords-1'."
11608 (interactive "P")
11609 (let ((case-fold-search nil)
11610 (kwd-re
11611 (cond ((null arg) org-not-done-regexp)
11612 ((equal arg '(4))
11613 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11614 (mapcar 'list org-todo-keywords-1))))
11618 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11619 (regexp-quote (nth (1- (prefix-numeric-value arg))
11620 org-todo-keywords-1)))
11621 (t (error "Invalid prefix argument: %s" arg)))))
11622 (message "%d TODO entries found"
11623 (org-occur (concat "^" outline-regexp " *" kwd-re )))))
11625 (defun org-deadline (&optional remove time)
11627 With argument REMOVE, remove any deadline from the item.
11628 When TIME is set, it should be an internal time specification, and the
11629 scheduling will use the corresponding date."
11630 (interactive "P")
11631 (let* ((old-date (org-entry-get nil "DEADLINE"))
11632 (repeater (and old-date
11633 (string-match
11635 old-date)
11636 (match-string 1 old-date))))
11637 (if remove
11638 (progn
11639 (when (and old-date org-log-redeadline)
11640 (org-add-log-setup 'deldeadline nil old-date 'findpos
11641 org-log-redeadline))
11642 (org-remove-timestamp-with-keyword org-deadline-string)
11643 (message "Item no longer has a deadline."))
11644 (org-add-planning-info 'deadline time 'closed)
11645 (when (and old-date org-log-redeadline
11646 (not (equal old-date
11647 (substring org-last-inserted-timestamp 1 -1))))
11648 (org-add-log-setup 'redeadline nil old-date 'findpos
11649 org-log-redeadline))
11650 (when repeater
11651 (save-excursion
11652 (org-back-to-heading t)
11653 (when (re-search-forward (concat org-deadline-string " "
11654 org-last-inserted-timestamp)
11655 (save-excursion
11656 (outline-next-heading) (point)) t)
11657 (goto-char (1- (match-end 0)))
11658 (insert " " repeater)
11659 (setq org-last-inserted-timestamp
11660 (concat (substring org-last-inserted-timestamp 0 -1)
11661 " " repeater
11662 (substring org-last-inserted-timestamp -1))))))
11663 (message "Deadline on %s" org-last-inserted-timestamp))))
11665 (defun org-schedule (&optional remove time)
11666 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11667 With argument REMOVE, remove any scheduling date from the item.
11668 When TIME is set, it should be an internal time specification, and the
11669 scheduling will use the corresponding date."
11670 (interactive "P")
11671 (let* ((old-date (org-entry-get nil "SCHEDULED"))
11672 (repeater (and old-date
11673 (string-match
11675 old-date)
11676 (match-string 1 old-date))))
11677 (if remove
11678 (progn
11679 (when (and old-date org-log-reschedule)
11680 (org-add-log-setup 'delschedule nil old-date 'findpos
11681 org-log-reschedule))
11682 (org-remove-timestamp-with-keyword org-scheduled-string)
11683 (message "Item is no longer scheduled."))
11684 (org-add-planning-info 'scheduled time 'closed)
11685 (when (and old-date org-log-reschedule
11686 (not (equal old-date
11687 (substring org-last-inserted-timestamp 1 -1))))
11688 (org-add-log-setup 'reschedule nil old-date 'findpos
11689 org-log-reschedule))
11690 (when repeater
11691 (save-excursion
11692 (org-back-to-heading t)
11693 (when (re-search-forward (concat org-scheduled-string " "
11694 org-last-inserted-timestamp)
11695 (save-excursion
11696 (outline-next-heading) (point)) t)
11697 (goto-char (1- (match-end 0)))
11698 (insert " " repeater)
11699 (setq org-last-inserted-timestamp
11700 (concat (substring org-last-inserted-timestamp 0 -1)
11701 " " repeater
11702 (substring org-last-inserted-timestamp -1))))))
11703 (message "Scheduled to %s" org-last-inserted-timestamp))))
11705 (defun org-get-scheduled-time (pom &optional inherit)
11706 "Get the scheduled time as a time tuple, of a format suitable
11707 for calling org-schedule with, or if there is no scheduling,
11708 returns nil."
11709 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
11710 (when time
11711 (apply 'encode-time (org-parse-time-string time)))))
11713 (defun org-get-deadline-time (pom &optional inherit)
11714 "Get the deadline as a time tuple, of a format suitable for
11715 calling org-deadline with, or if there is no scheduling, returns
11716 nil."
11717 (let ((time (org-entry-get pom "DEADLINE" inherit)))
11718 (when time
11719 (apply 'encode-time (org-parse-time-string time)))))
11721 (defun org-remove-timestamp-with-keyword (keyword)
11722 "Remove all time stamps with KEYWORD in the current entry."
11724 beg)
11725 (save-excursion
11726 (org-back-to-heading t)
11727 (setq beg (point))
11728 (outline-next-heading)
11729 (while (re-search-backward re beg t)
11730 (replace-match "")
11732 (equal (char-before) ?\ ))
11733 (backward-delete-char 1)
11735 (point-at-bol) (point-at-eol)))
11736 (delete-region (point-at-bol)
11737 (min (point-max) (1+ (point-at-eol))))))))))
11739 (defun org-add-planning-info (what &optional time &rest remove)
11740 "Insert new timestamp with keyword in the line directly after the headline.
11741 WHAT indicates what kind of time stamp to add. TIME indicated the time to use.
11742 If non is given, the user is prompted for a date.
11743 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
11744 be removed."
11745 (interactive)
11746 (let (org-time-was-given org-end-time-was-given ts
11747 end default-time default-input)
11749 (catch 'exit
11750 (when (and (not time) (memq what '(scheduled deadline)))
11751 ;; Try to get a default date/time from existing timestamp
11752 (save-excursion
11753 (org-back-to-heading t)
11754 (setq end (save-excursion (outline-next-heading) (point)))
11755 (when (re-search-forward (if (eq what 'scheduled)
11756 org-scheduled-time-regexp
11757 org-deadline-time-regexp)
11758 end t)
11759 (setq ts (match-string 1)
11760 default-time
11761 (apply 'encode-time (org-parse-time-string ts))
11762 default-input (and ts (org-get-compact-tod ts))))))
11763 (when what
11764 ;; If necessary, get the time from the user
11765 (setq time (or time (org-read-date nil 'to-time nil nil
11766 default-time default-input))))
11768 (when (and org-insert-labeled-timestamps-at-point
11769 (member what '(scheduled deadline)))
11770 (insert
11771 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
11772 (org-insert-time-stamp time org-time-was-given
11773 nil nil nil (list org-end-time-was-given))
11774 (setq what nil))
11775 (save-excursion
11776 (save-restriction
11777 (let (col list elt ts buffer-invisibility-spec)
11778 (org-back-to-heading t)
11780 (goto-char (match-end 1))
11781 (setq col (current-column))
11782 (goto-char (match-end 0))
11784 (when (and (not what)
11785 (not (looking-at
11787 org-keyword-time-not-clock-regexp))))
11788 ;; Nothing to add, nothing to remove...... :-)
11789 (throw 'exit nil))
11790 (if (and (not (looking-at outline-regexp))
11793 (not (equal (match-string 1) org-clock-string)))
11794 (narrow-to-region (match-beginning 0) (match-end 0))
11796 (backward-char 1)
11797 (narrow-to-region (point) (point))
11798 (and org-adapt-indentation (org-indent-to-column col)))
11799 ;; Check if we have to remove something.
11800 (setq list (cons what remove))
11801 (while list
11802 (setq elt (pop list))
11803 (goto-char (point-min))
11804 (when (or (and (eq elt 'scheduled)
11805 (re-search-forward org-scheduled-time-regexp nil t))
11806 (and (eq elt 'deadline)
11807 (re-search-forward org-deadline-time-regexp nil t))
11808 (and (eq elt 'closed)
11809 (re-search-forward org-closed-time-regexp nil t)))
11810 (replace-match "")
11811 (if (looking-at "--+<[^>]+>") (replace-match ""))
11812 (skip-chars-backward " ")
11813 (if (looking-at " +") (replace-match ""))))
11814 (goto-char (point-max))
11815 (and org-adapt-indentation (bolp) (org-indent-to-column col))
11816 (when what
11817 (insert
11818 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
11819 (cond ((eq what 'scheduled) org-scheduled-string)
11820 ((eq what 'deadline) org-deadline-string)
11821 ((eq what 'closed) org-closed-string))
11822 " ")
11823 (setq ts (org-insert-time-stamp
11824 time
11825 (or org-time-was-given
11826 (and (eq what 'closed) org-log-done-with-time))
11827 (eq what 'closed)
11828 nil nil (list org-end-time-was-given)))
11829 (end-of-line 1))
11830 (goto-char (point-min))
11831 (widen)
11834 (delete-region (1- (point)) (point-at-eol)))
11835 ts))))))
11837 (defvar org-log-note-marker (make-marker))
11838 (defvar org-log-note-purpose nil)
11839 (defvar org-log-note-state nil)
11840 (defvar org-log-note-previous-state nil)
11841 (defvar org-log-note-how nil)
11842 (defvar org-log-note-extra nil)
11843 (defvar org-log-note-window-configuration nil)
11844 (defvar org-log-note-return-to (make-marker))
11845 (defvar org-log-post-message nil
11846 "Message to be displayed after a log note has been stored.
11847 The auto-repeater uses this.")
11849 (defun org-add-note ()
11850 "Add a note to the current entry.
11851 This is done in the same way as adding a state change note."
11852 (interactive)
11853 (org-add-log-setup 'note nil nil 'findpos nil))
11855 (defvar org-property-end-re)
11856 (defun org-add-log-setup (&optional purpose state prev-state
11857 findpos how extra)
11858 "Set up the post command hook to take a note.
11859 If this is about to TODO state change, the new state is expected in STATE.
11860 When FINDPOS is non-nil, find the correct position for the note in
11861 the current entry. If not, assume that it can be inserted at point.
11862 HOW is an indicator what kind of note should be created.
11863 EXTRA is additional text that will be inserted into the notes buffer."
11864 (let* ((org-log-into-drawer (org-log-into-drawer))
11865 (drawer (cond ((stringp org-log-into-drawer)
11866 org-log-into-drawer)
11867 (org-log-into-drawer "LOGBOOK")
11868 (t nil))))
11869 (save-restriction
11870 (save-excursion
11871 (when findpos
11872 (org-back-to-heading t)
11873 (narrow-to-region (point) (save-excursion
11874 (outline-next-heading) (point)))
11878 (goto-char (match-end 0))
11879 (cond
11880 (drawer
11882 nil t)
11883 (progn
11884 (goto-char (match-end 0))
11885 (or org-log-states-order-reversed
11886 (and (re-search-forward org-property-end-re nil t)
11887 (goto-char (1- (match-beginning 0))))))
11889 (beginning-of-line 0)
11890 (org-indent-line-function)
11891 (beginning-of-line 2)
11892 (org-indent-line-function)
11893 (end-of-line 0)))
11894 ((and org-log-state-notes-insert-after-drawers
11895 (save-excursion
11896 (forward-line) (looking-at org-drawer-regexp)))
11897 (forward-line)
11898 (while (looking-at org-drawer-regexp)
11899 (goto-char (match-end 0))
11900 (re-search-forward org-property-end-re (point-max) t)
11901 (forward-line))
11902 (forward-line -1)))
11903 (unless org-log-states-order-reversed
11905 (org-skip-over-state-notes)
11907 (move-marker org-log-note-marker (point))
11908 (setq org-log-note-purpose purpose
11909 org-log-note-state state
11910 org-log-note-previous-state prev-state
11911 org-log-note-how how
11912 org-log-note-extra extra)
11913 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
11915 (defun org-skip-over-state-notes ()
11916 "Skip past the list of State notes in an entry."
11918 (when (ignore-errors (goto-char (org-in-item-p)))
11919 (let* ((struct (org-list-struct))
11920 (prevs (org-list-prevs-alist struct)))
11922 (goto-char (or (org-list-get-next-item (point) struct prevs)
11923 (org-list-get-item-end (point) struct)))))))
11925 (defun org-add-log-note (&optional purpose)
11926 "Pop up a window for taking a note, and add this note later at point."
11927 (remove-hook 'post-command-hook 'org-add-log-note)
11928 (setq org-log-note-window-configuration (current-window-configuration))
11929 (delete-other-windows)
11930 (move-marker org-log-note-return-to (point))
11931 (switch-to-buffer (marker-buffer org-log-note-marker))
11932 (goto-char org-log-note-marker)
11933 (org-switch-to-buffer-other-window "*Org Note*")
11934 (erase-buffer)
11935 (if (memq org-log-note-how '(time state))
11936 (let (current-prefix-arg) (org-store-log-note))
11937 (let ((org-inhibit-startup t)) (org-mode))
11938 (insert (format "# Insert note for %s.
11940 (cond
11941 ((eq org-log-note-purpose 'clock-out) "stopped clock")
11942 ((eq org-log-note-purpose 'done) "closed todo item")
11943 ((eq org-log-note-purpose 'state)
11945 (or org-log-note-previous-state "")
11946 (or org-log-note-state "")))
11947 ((eq org-log-note-purpose 'reschedule)
11948 "rescheduling")
11949 ((eq org-log-note-purpose 'delschedule)
11950 "no longer scheduled")
11951 ((eq org-log-note-purpose 'redeadline)
11952 "changing deadline")
11953 ((eq org-log-note-purpose 'deldeadline)
11954 "removing deadline")
11955 ((eq org-log-note-purpose 'refile)
11956 "refiling")
11957 ((eq org-log-note-purpose 'note)
11958 "this entry")
11959 (t (error "This should not happen")))))
11960 (if org-log-note-extra (insert org-log-note-extra))
11961 (org-set-local 'org-finish-function 'org-store-log-note)))
11963 (defvar org-note-abort nil) ; dynamically scoped
11964 (defun org-store-log-note ()
11965 "Finish taking a log note, and insert it to where it belongs."
11966 (let ((txt (buffer-string))
11967 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
11968 lines ind bul)
11969 (kill-buffer (current-buffer))
11971 (setq txt (replace-match "" t t txt)))
11973 (setq txt (replace-match "" t t txt)))
11976 (setq note
11977 (org-replace-escapes
11978 note
11979 (list (cons "%u" (user-login-name))
11980 (cons "%U" user-full-name)
11981 (cons "%t" (format-time-string
11982 (org-time-stamp-format 'long 'inactive)
11983 (current-time)))
11984 (cons "%T" (format-time-string
11985 (org-time-stamp-format 'long nil)
11986 (current-time)))
11987 (cons "%s" (if org-log-note-state
11989 ""))
11990 (cons "%S" (if org-log-note-previous-state
11994 (push note lines))
11995 (when (or current-prefix-arg org-note-abort)
11996 (when org-log-into-drawer
11997 (org-remove-empty-drawer-at
11998 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
11999 org-log-note-marker))
12000 (setq lines nil))
12001 (when lines
12002 (with-current-buffer (marker-buffer org-log-note-marker)
12003 (save-excursion
12004 (goto-char org-log-note-marker)
12005 (move-marker org-log-note-marker nil)
12006 (end-of-line 1)
12008 (setq ind (save-excursion
12009 (if (ignore-errors (goto-char (org-in-item-p)))
12010 (let ((struct (org-list-struct)))
12011 (org-list-get-ind
12012 (org-list-get-top-point struct) struct))
12014 (cond
12015 ((and (org-at-heading-p)
12016 org-adapt-indentation)
12017 (1+ (org-current-level)))
12018 ((org-at-heading-p) 0)
12019 (t (org-get-indentation))))))
12020 (setq bul (org-list-bullet-string "-"))
12021 (org-indent-line-to ind)
12022 (insert bul (pop lines))
12023 (let ((ind-body (+ (length bul) ind)))
12024 (while lines
12026 (org-indent-line-to ind-body)
12027 (insert (pop lines))))
12028 (message "Note stored")
12029 (org-back-to-heading t)
12030 (org-cycle-hide-drawers 'children)))))
12031 (set-window-configuration org-log-note-window-configuration)
12032 (with-current-buffer (marker-buffer org-log-note-return-to)
12033 (goto-char org-log-note-return-to))
12034 (move-marker org-log-note-return-to nil)
12035 (and org-log-post-message (message "%s" org-log-post-message)))
12037 (defun org-remove-empty-drawer-at (drawer pos)
12038 "Remove an empty drawer DRAWER at position POS.
12039 POS may also be a marker."
12040 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12041 (save-excursion
12042 (save-restriction
12043 (widen)
12044 (goto-char pos)
12045 (if (org-in-regexp
12047 (replace-match ""))))))
12049 (defun org-sparse-tree (&optional arg)
12050 "Create a sparse tree, prompt for the details.
12051 This command can create sparse trees. You first need to select the type
12052 of match used to create the tree:
12054 t Show all TODO entries.
12055 T Show entries with a specific TODO keyword.
12056 m Show entries selected by a tags/property match.
12057 p Enter a property name and its value (both with completion on existing
12058 names/values) and show entries with that property.
12059 r Show entries matching a regular expression (`/' can be used as well)
12060 d Show deadlines due within `org-deadline-warning-days'.
12061 b Show deadlines and scheduled items before a date.
12062 a Show deadlines and scheduled items after a date."
12063 (interactive "P")
12064 (let (ans kwd value)
12065 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date")
12066 (setq ans (read-char-exclusive))
12067 (cond
12068 ((equal ans ?d)
12069 (call-interactively 'org-check-deadlines))
12070 ((equal ans ?b)
12071 (call-interactively 'org-check-before-date))
12072 ((equal ans ?a)
12073 (call-interactively 'org-check-after-date))
12074 ((equal ans ?t)
12075 (org-show-todo-tree nil))
12076 ((equal ans ?T)
12077 (org-show-todo-tree '(4)))
12078 ((member ans '(?T ?m))
12079 (call-interactively 'org-match-sparse-tree))
12080 ((member ans '(?p ?P))
12081 (setq kwd (org-icompleting-read "Property: "
12082 (mapcar 'list (org-buffer-property-keys))))
12083 (setq value (org-icompleting-read "Value: "
12084 (mapcar 'list (org-property-values kwd))))
12087 (org-match-sparse-tree arg (concat kwd "=" value)))
12088 ((member ans '(?r ?R ?/))
12089 (call-interactively 'org-occur))
12092 (defvar org-occur-highlights nil
12093 "List of overlays used for occur matches.")
12094 (make-variable-buffer-local 'org-occur-highlights)
12095 (defvar org-occur-parameters nil
12096 "Parameters of the active org-occur calls.
12097 This is a list, each call to org-occur pushes as cons cell,
12098 containing the regular expression and the callback, onto the list.
12099 The list can contain several entries if `org-occur' has been called
12100 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12101 will only contain one set of parameters. When the highlights are
12102 removed (for example with `C-c C-c', or with the next edit (depending
12103 on `org-remove-highlights-with-change'), this variable is emptied
12104 as well.")
12105 (make-variable-buffer-local 'org-occur-parameters)
12107 (defun org-occur (regexp &optional keep-previous callback)
12108 "Make a compact tree which shows all matches of REGEXP.
12109 The tree will show the lines where the regexp matches, and all higher
12110 headlines above the match. It will also show the heading after the match,
12111 to make sure editing the matching entry is easy.
12112 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12113 call to `org-occur' will be kept, to allow stacking of calls to this
12114 command.
12115 If CALLBACK is non-nil, it is a function which is called to confirm
12116 that the match should indeed be shown."
12118 (when (equal regexp "")
12119 (error "Regexp cannot be empty"))
12120 (unless keep-previous
12121 (org-remove-occur-highlights nil nil t))
12122 (push (cons regexp callback) org-occur-parameters)
12123 (let ((cnt 0))
12124 (save-excursion
12125 (goto-char (point-min))
12126 (if (or (not keep-previous) ; do not want to keep
12127 (not org-occur-highlights)) ; no previous matches
12128 ;; hide everything
12129 (org-overview))
12130 (while (re-search-forward regexp nil t)
12131 (when (or (not callback)
12132 (save-match-data (funcall callback)))
12133 (setq cnt (1+ cnt))
12134 (when org-highlight-sparse-tree-matches
12135 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12136 (org-show-context 'occur-tree))))
12137 (when org-remove-highlights-with-change
12138 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12139 nil 'local))
12140 (unless org-sparse-tree-open-archived-trees
12141 (org-hide-archived-subtrees (point-min) (point-max)))
12142 (run-hooks 'org-occur-hook)
12143 (if (interactive-p)
12144 (message "%d match(es) for regexp %s" cnt regexp))
12145 cnt))
12147 (defun org-occur-next-match (&optional n reset)
12148 "Function for `next-error-function' to find sparse tree matches.
12149 N is the number of matches to move, when negative move backwards.
12150 RESET is entirely ignored - this function always goes back to the
12151 starting point when no match is found."
12152 (let* ((limit (if (< n 0) (point-min) (point-max)))
12153 (search-func (if (< n 0)
12154 'previous-single-char-property-change
12155 'next-single-char-property-change))
12156 (n (abs n))
12157 (pos (point))
12158 p1)
12159 (catch 'exit
12160 (while (setq p1 (funcall search-func (point) 'org-type))
12161 (when (equal p1 limit)
12162 (goto-char pos)
12163 (error "No more matches"))
12164 (when (equal (get-char-property p1 'org-type) 'org-occur)
12165 (setq n (1- n))
12166 (when (= n 0)
12167 (goto-char p1)
12168 (throw 'exit (point))))
12169 (goto-char p1))
12170 (goto-char p1)
12171 (error "No more matches"))))
12173 (defun org-show-context (&optional key)
12174 "Make sure point and context are visible.
12175 How much context is shown depends upon the variables
12176 `org-show-hierarchy-above', `org-show-following-heading'. and
12177 `org-show-siblings'."
12178 (let ((heading-p (org-on-heading-p t))
12179 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12180 (following-p (org-get-alist-option org-show-following-heading key))
12181 (entry-p (org-get-alist-option org-show-entry-below key))
12182 (siblings-p (org-get-alist-option org-show-siblings key)))
12183 (catch 'exit
12184 ;; Show heading or entry text
12185 (if (and heading-p (not entry-p))
12186 (org-flag-heading nil) ; only show the heading
12187 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12188 (org-show-hidden-entry))) ; show entire entry
12189 (when following-p
12190 ;; Show next sibling, or heading below text
12191 (save-excursion
12192 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12193 (org-flag-heading nil))))
12194 (when siblings-p (org-show-siblings))
12195 (when hierarchy-p
12196 ;; show all higher headings, possibly with siblings
12197 (save-excursion
12198 (while (and (condition-case nil
12199 (progn (org-up-heading-all 1) t)
12200 (error nil))
12201 (not (bobp)))
12202 (org-flag-heading nil)
12203 (when siblings-p (org-show-siblings))))))))
12205 (defvar org-reveal-start-hook nil
12206 "Hook run before revealing a location.")
12208 (defun org-reveal (&optional siblings)
12209 "Show current entry, hierarchy above it, and the following headline.
12210 This can be used to show a consistent set of context around locations
12211 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12212 not t for the search context.
12214 With optional argument SIBLINGS, on each level of the hierarchy all
12215 siblings are shown. This repairs the tree structure to what it would
12216 look like when opened with hierarchical calls to `org-cycle'.
12218 go to the parent and show the
12219 entire tree."
12220 (interactive "P")
12221 (run-hooks 'org-reveal-start-hook)
12222 (let ((org-show-hierarchy-above t)
12223 (org-show-following-heading t)
12224 (org-show-siblings (if siblings t org-show-siblings)))
12225 (org-show-context nil))
12226 (when (equal siblings '(16))
12227 (save-excursion
12228 (when (org-up-heading-safe)
12229 (org-show-subtree)
12230 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12232 (defun org-highlight-new-match (beg end)
12233 "Highlight from BEG to END and mark the highlight is an occur headline."
12234 (let ((ov (make-overlay beg end)))
12235 (overlay-put ov 'face 'secondary-selection)
12236 (overlay-put ov 'org-type 'org-occur)
12237 (push ov org-occur-highlights)))
12239 (defun org-remove-occur-highlights (&optional beg end noremove)
12240 "Remove the occur highlights from the buffer.
12241 BEG and END are ignored. If NOREMOVE is nil, remove this function
12242 from the `before-change-functions' in the current buffer."
12243 (interactive)
12244 (unless org-inhibit-highlight-removal
12245 (mapc 'delete-overlay org-occur-highlights)
12246 (setq org-occur-highlights nil)
12247 (setq org-occur-parameters nil)
12248 (unless noremove
12249 (remove-hook 'before-change-functions
12250 'org-remove-occur-highlights 'local))))
12252 ;;;; Priorities
12255 "Regular expression matching the priority indicator.")
12257 (defvar org-remove-priority-next-time nil)
12259 (defun org-priority-up ()
12260 "Increase the priority of the current item."
12261 (interactive)
12262 (org-priority 'up))
12264 (defun org-priority-down ()
12265 "Decrease the priority of the current item."
12266 (interactive)
12267 (org-priority 'down))
12269 (defun org-priority (&optional action)
12270 "Change the priority of an item by ARG.
12271 ACTION can be `set', `up', `down', or a character."
12272 (interactive)
12273 (unless org-enable-priority-commands
12274 (error "Priority commands are disabled"))
12275 (setq action (or action 'set))
12276 (let (current new news have remove)
12277 (save-excursion
12278 (org-back-to-heading t)
12279 (if (looking-at org-priority-regexp)
12280 (setq current (string-to-char (match-string 2))
12281 have t)
12282 (setq current org-default-priority))
12283 (cond
12284 ((eq action 'remove)
12285 (setq remove t new ?\ ))
12286 ((or (eq action 'set)
12287 (if (featurep 'xemacs) (characterp action) (integerp action)))
12288 (if (not (eq action 'set))
12289 (setq new action)
12290 (message "Priority %c-%c, SPC to remove: "
12291 org-highest-priority org-lowest-priority)
12292 (save-match-data
12293 (setq new (read-char-exclusive))))
12294 (if (and (= (upcase org-highest-priority) org-highest-priority)
12295 (= (upcase org-lowest-priority) org-lowest-priority))
12296 (setq new (upcase new)))
12297 (cond ((equal new ?\ ) (setq remove t))
12298 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12299 (error "Priority must be between `%c' and `%c'"
12300 org-highest-priority org-lowest-priority))))
12301 ((eq action 'up)
12302 (if (and (not have) (eq last-command this-command))
12303 (setq new org-lowest-priority)
12304 (setq new (if (and org-priority-start-cycle-with-default (not have))
12305 org-default-priority (1- current)))))
12306 ((eq action 'down)
12307 (if (and (not have) (eq last-command this-command))
12308 (setq new org-highest-priority)
12309 (setq new (if (and org-priority-start-cycle-with-default (not have))
12310 org-default-priority (1+ current)))))
12311 (t (error "Invalid action")))
12312 (if (or (< (upcase new) org-highest-priority)
12313 (> (upcase new) org-lowest-priority))
12314 (setq remove t))
12315 (setq news (format "%c" new))
12316 (if have
12317 (if remove
12318 (replace-match "" t t nil 1)
12319 (replace-match news t t nil 2))
12320 (if remove
12321 (error "No priority cookie found in line")
12322 (let ((case-fold-search nil))
12323 (looking-at org-todo-line-regexp))
12324 (if (match-end 2)
12325 (progn
12326 (goto-char (match-end 2))
12327 (insert " [#" news "]"))
12328 (goto-char (match-beginning 3))
12329 (insert "[#" news "] "))))
12330 (org-preserve-lc (org-set-tags nil 'align)))
12331 (if remove
12332 (message "Priority removed")
12333 (message "Priority of current item set to %s" news))))
12335 (defun org-get-priority (s)
12336 "Find priority cookie and return priority."
12337 (if (functionp org-get-priority-function)
12338 (funcall org-get-priority-function)
12339 (save-match-data
12340 (if (not (string-match org-priority-regexp s))
12341 (* 1000 (- org-lowest-priority org-default-priority))
12342 (* 1000 (- org-lowest-priority
12343 (string-to-char (match-string 2 s))))))))
12345 ;;;; Tags
12347 (defvar org-agenda-archives-mode)
12348 (defvar org-map-continue-from nil
12349 "Position from where mapping should continue.
12350 Can be set by the action argument to `org-scan-tag's and `org-map-entries'.")
12352 (defvar org-scanner-tags nil
12353 "The current tag list while the tags scanner is running.")
12354 (defvar org-trust-scanner-tags nil
12355 "Should `org-get-tags-at' use the tags for the scanner.
12356 This is for internal dynamical scoping only.
12357 When this is non-nil, the function `org-get-tags-at' will return the value
12358 of `org-scanner-tags' instead of building the list by itself. This
12359 can lead to large speed-ups when the tags scanner is used in a file with
12360 many entries, and when the list of tags is retrieved, for example to
12361 obtain a list of properties. Building the tags list for each entry in such
12362 a file becomes an N^2 operation - but with this variable set, it scales
12363 as N.")
12365 (defun org-scan-tags (action matcher &optional todo-only)
12366 "Scan headline tags with inheritance and produce output ACTION.
12368 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12369 or `agenda' to produce an entry list for an agenda view. It can also be
12370 a Lisp form or a function that should be called at each matched headline, in
12371 this case the return value is a list of all return values from these calls.
12373 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12374 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12375 only lines with a TODO keyword are included in the output."
12376 (require 'org-agenda)
12379 (org-re
12381 (props (list 'face 'default
12382 'done-face 'org-agenda-done
12383 'undone-face 'default
12384 'mouse-face 'highlight
12385 'org-not-done-regexp org-not-done-regexp
12386 'org-todo-regexp org-todo-regexp
12387 'help-echo
12388 (format "mouse-2 or RET jump to org file %s"
12389 (abbreviate-file-name
12390 (or (buffer-file-name (buffer-base-buffer))
12391 (buffer-name (buffer-base-buffer)))))))
12392 (case-fold-search nil)
12393 (org-map-continue-from nil)
12394 lspos tags tags-list
12395 (tags-alist (list (cons 0 org-file-tags)))
12396 (llast 0) rtn rtn1 level category i txt
12397 todo marker entry priority)
12398 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12399 (setq action (list 'lambda nil action)))
12400 (save-excursion
12401 (goto-char (point-min))
12402 (when (eq action 'sparse-tree)
12403 (org-overview)
12404 (org-remove-occur-highlights))
12405 (while (re-search-forward re nil t)
12406 (catch :skip
12407 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12408 tags (if (match-end 4) (org-match-string-no-properties 4)))
12409 (goto-char (setq lspos (match-beginning 0)))
12410 (setq level (org-reduced-level (funcall outline-level))
12411 category (org-get-category))
12412 (setq i llast llast level)
12413 ;; remove tag lists from same and sublevels
12414 (while (>= i level)
12415 (when (setq entry (assoc i tags-alist))
12416 (setq tags-alist (delete entry tags-alist)))
12417 (setq i (1- i)))
12418 ;; add the next tags
12419 (when tags
12420 (setq tags (org-split-string tags ":")
12421 tags-alist
12422 (cons (cons level tags) tags-alist)))
12423 ;; compile tags for current headline
12424 (setq tags-list
12425 (if org-use-tag-inheritance
12426 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12427 tags)
12428 org-scanner-tags tags-list)
12429 (when org-use-tag-inheritance
12430 (setcdr (car tags-alist)
12431 (mapcar (lambda (x)
12432 (setq x (copy-sequence x))
12433 (org-add-prop-inherited x))
12434 (cdar tags-alist))))
12435 (when (and tags org-use-tag-inheritance
12436 (or (not (eq t org-use-tag-inheritance))
12437 org-tags-exclude-from-inheritance))
12438 ;; selective inheritance, remove uninherited ones
12439 (setcdr (car tags-alist)
12440 (org-remove-uninherited-tags (cdar tags-alist))))
12441 (when (and
12443 ;; eval matcher only when the todo condition is OK
12444 (and (or (not todo-only) (member todo org-not-done-keywords))
12445 (let ((case-fold-search t)) (eval matcher)))
12447 ;; Call the skipper, but return t if it does not skip,
12448 ;; so that the `and' form continues evaluating
12449 (progn
12450 (unless (eq action 'sparse-tree) (org-agenda-skip))
12451 t)
12453 ;; Check if timestamps are deselecting this entry
12454 (or (not todo-only)
12455 (and (member todo org-not-done-keywords)
12456 (or (not org-agenda-tags-todo-honor-ignore-options)
12457 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12459 ;; Extra check for the archive tag
12460 ;; FIXME: Does the skipper already do this????
12461 (or
12462 (not (member org-archive-tag tags-list))
12463 ;; we have an archive tag, should we use this anyway?
12464 (or (not org-agenda-skip-archived-trees)
12465 (and (eq action 'agenda) org-agenda-archives-mode))))
12467 ;; select this headline
12469 (cond
12470 ((eq action 'sparse-tree)
12471 (and org-highlight-sparse-tree-matches
12472 (org-get-heading) (match-end 0)
12473 (org-highlight-new-match
12474 (match-beginning 0) (match-beginning 1)))
12475 (org-show-context 'tags-tree))
12476 ((eq action 'agenda)
12477 (setq txt (org-format-agenda-item
12478 ""
12479 (concat
12480 (if (eq org-tags-match-list-sublevels 'indented)
12481 (make-string (1- level) ?.) "")
12482 (org-get-heading))
12483 category
12484 tags-list
12485 )
12486 priority (org-get-priority txt))
12487 (goto-char lspos)
12488 (setq marker (org-agenda-new-marker))
12489 (org-add-props txt props
12490 'org-marker marker 'org-hd-marker marker 'org-category category
12491 'todo-state todo
12492 'priority priority 'type "tagsmatch")
12493 (push txt rtn))
12494 ((functionp action)
12495 (setq org-map-continue-from nil)
12496 (save-excursion
12497 (setq rtn1 (funcall action))
12498 (push rtn1 rtn)))
12499 (t (error "Invalid action")))
12501 ;; if we are to skip sublevels, jump to end of subtree
12502 (unless org-tags-match-list-sublevels
12503 (org-end-of-subtree t)
12504 (backward-char 1))))
12505 ;; Get the correct position from where to continue
12506 (if org-map-continue-from
12507 (goto-char org-map-continue-from)
12508 (and (= (point) lspos) (end-of-line 1)))))
12509 (when (and (eq action 'sparse-tree)
12510 (not org-sparse-tree-open-archived-trees))
12511 (org-hide-archived-subtrees (point-min) (point-max)))
12512 (nreverse rtn)))
12514 (defun org-remove-uninherited-tags (tags)
12515 "Remove all tags that are not inherited from the list TAGS."
12516 (cond
12517 ((eq org-use-tag-inheritance t)
12518 (if org-tags-exclude-from-inheritance
12519 (org-delete-all org-tags-exclude-from-inheritance tags)
12520 tags))
12521 ((not org-use-tag-inheritance) nil)
12522 ((stringp org-use-tag-inheritance)
12523 (delq nil (mapcar
12524 (lambda (x)
12525 (if (and (string-match org-use-tag-inheritance x)
12526 (not (member x org-tags-exclude-from-inheritance)))
12527 x nil))
12528 tags)))
12529 ((listp org-use-tag-inheritance)
12530 (delq nil (mapcar
12531 (lambda (x)
12532 (if (member x org-use-tag-inheritance) x nil))
12533 tags)))))
12535 (defvar todo-only) ;; dynamically scoped
12537 (defun org-match-sparse-tree (&optional todo-only match)
12538 "Create a sparse tree according to tags string MATCH.
12539 MATCH can contain positive and negative selection of tags, like
12541 If optional argument TODO-ONLY is non-nil, only select lines that are
12542 also TODO lines."
12543 (interactive "P")
12544 (org-prepare-agenda-buffers (list (current-buffer)))
12545 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12547 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12549 (defvar org-cached-props nil)
12550 (defun org-cached-entry-get (pom property)
12551 (if (or (eq t org-use-property-inheritance)
12552 (and (stringp org-use-property-inheritance)
12553 (string-match org-use-property-inheritance property))
12554 (and (listp org-use-property-inheritance)
12555 (member property org-use-property-inheritance)))
12556 ;; Caching is not possible, check it directly
12557 (org-entry-get pom property 'inherit)
12558 ;; Get all properties, so that we can do complicated checks easily
12559 (cdr (assoc property (or org-cached-props
12560 (setq org-cached-props
12561 (org-entry-properties pom)))))))
12563 (defun org-global-tags-completion-table (&optional files)
12564 "Return the list of all tags in all agenda buffer/files.
12565 Optional FILES argument is a list of files to which can be used
12566 instead of the agenda files."
12567 (save-excursion
12568 (org-uniquify
12569 (delq nil
12570 (apply 'append
12571 (mapcar
12572 (lambda (file)
12573 (set-buffer (find-file-noselect file))
12574 (append (org-get-buffer-tags)
12575 (mapcar (lambda (x) (if (stringp (car-safe x))
12576 (list (car-safe x)) nil))
12577 org-tag-alist)))
12578 (if (and files (car files))
12579 files
12580 (org-agenda-files))))))))
12582 (defun org-make-tags-matcher (match)
12583 "Create the TAGS/TODO matcher form for the selection string MATCH."
12584 ;; todo-only is scoped dynamically into this function, and the function
12585 ;; may change it if the matcher asks for it.
12586 (unless match
12587 ;; Get a new match request, with completion
12588 (let ((org-last-tags-completion-table
12589 (org-global-tags-completion-table)))
12590 (setq match (org-completing-read-no-i
12591 "Match: " 'org-tags-completion-function nil nil nil
12592 'org-tags-history))))
12594 ;; Parse the string and create a lisp form
12595 (let ((match0 match)
12596 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12597 minus tag mm
12598 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12599 orterms term orlist re-p str-p level-p level-op time-p
12600 prop-p pn pv po gv rest)
12601 (if (string-match "/+" match)
12602 ;; match contains also a todo-matching request
12603 (progn
12604 (setq tagsmatch (substring match 0 (match-beginning 0))
12605 todomatch (substring match (match-end 0)))
12606 (if (string-match "^!" todomatch)
12607 (setq todo-only t todomatch (substring todomatch 1)))
12609 (setq todomatch nil)))
12610 ;; only matching tags
12611 (setq tagsmatch match todomatch nil))
12613 ;; Make the tags matcher
12615 (setq tagsmatcher t)
12616 (setq orterms (org-split-string tagsmatch "|") orlist nil)
12617 (while (setq term (pop orterms))
12619 (setq term (concat term "|" (pop orterms)))) ; repair bad split
12620 (while (string-match re term)
12621 (setq rest (substring term (match-end 0))
12622 minus (and (match-end 1)
12623 (equal (match-string 1 term) "-"))
12624 tag (save-match-data (replace-regexp-in-string
12626 (match-string 2 term)))
12627 re-p (equal (string-to-char tag) ?{)
12628 level-p (match-end 4)
12629 prop-p (match-end 5)
12630 mm (cond
12631 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
12632 (level-p
12633 (setq level-op (org-op-to-function (match-string 3 term)))
12634 `(,level-op level ,(string-to-number
12635 (match-string 4 term))))
12636 (prop-p
12637 (setq pn (match-string 5 term)
12638 po (match-string 6 term)
12639 pv (match-string 7 term)
12640 re-p (equal (string-to-char pv) ?{)
12642 time-p (save-match-data
12644 pv (if (or re-p str-p) (substring pv 1 -1) pv))
12645 (if time-p (setq pv (org-matcher-time pv)))
12646 (setq po (org-op-to-function po (if time-p 'time str-p)))
12647 (cond
12648 ((equal pn "CATEGORY")
12649 (setq gv '(get-text-property (point) 'org-category)))
12650 ((equal pn "TODO")
12651 (setq gv 'todo))
12652 (t
12653 (setq gv `(org-cached-entry-get nil ,pn))))
12654 (if re-p
12655 (if (eq po 'org<>)
12656 `(not (string-match ,pv (or ,gv "")))
12657 `(string-match ,pv (or ,gv "")))
12658 (if str-p
12659 `(,po (or ,gv "") ,pv)
12660 `(,po (string-to-number (or ,gv ""))
12661 ,(string-to-number pv) ))))
12662 (t `(member ,tag tags-list)))
12663 mm (if minus (list 'not mm) mm)
12664 term rest)
12665 (push mm tagsmatcher))
12666 (push (if (> (length tagsmatcher) 1)
12667 (cons 'and tagsmatcher)
12668 (car tagsmatcher))
12669 orlist)
12670 (setq tagsmatcher nil))
12671 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
12672 (setq tagsmatcher
12673 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
12674 ;; Make the todo matcher
12676 (setq todomatcher t)
12677 (setq orterms (org-split-string todomatch "|") orlist nil)
12678 (while (setq term (pop orterms))
12679 (while (string-match re term)
12680 (setq minus (and (match-end 1)
12681 (equal (match-string 1 term) "-"))
12682 kwd (match-string 2 term)
12683 re-p (equal (string-to-char kwd) ?{)
12684 term (substring term (match-end 0))
12685 mm (if re-p
12686 `(string-match ,(substring kwd 1 -1) todo)
12687 (list 'equal 'todo kwd))
12688 mm (if minus (list 'not mm) mm))
12689 (push mm todomatcher))
12690 (push (if (> (length todomatcher) 1)
12691 (cons 'and todomatcher)
12692 (car todomatcher))
12693 orlist)
12694 (setq todomatcher nil))
12695 (setq todomatcher (if (> (length orlist) 1)
12696 (cons 'or orlist) (car orlist))))
12698 ;; Return the string and lisp forms of the matcher
12699 (setq matcher (if todomatcher
12700 (list 'and tagsmatcher todomatcher)
12701 tagsmatcher))
12702 (cons match0 matcher)))
12704 (defun org-op-to-function (op &optional stringp)
12705 "Turn an operator into the appropriate function."
12706 (setq op
12707 (cond
12708 ((equal op "<" ) '(< string< org-time<))
12709 ((equal op ">" ) '(> org-string> org-time>))
12710 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
12711 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
12712 ((member op '("=" "==")) '(= string= org-time=))
12713 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
12714 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
12716 (defun org<> (a b) (not (= a b)))
12717 (defun org-string<= (a b) (or (string= a b) (string< a b)))
12718 (defun org-string>= (a b) (not (string< a b)))
12719 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
12720 (defun org-string<> (a b) (not (string= a b)))
12721 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
12722 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
12723 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
12724 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
12725 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
12726 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
12727 (defun org-2ft (s)
12728 "Convert S to a floating point time.
12729 If S is already a number, just return it. If it is a string, parse
12730 it as a time string and apply `float-time' to it. If S is nil, just return 0."
12731 (cond
12732 ((numberp s) s)
12733 ((stringp s)
12734 (condition-case nil
12735 (float-time (apply 'encode-time (org-parse-time-string s)))
12736 (error 0.)))
12737 (t 0.)))
12739 (defun org-time-today ()
12740 "Time in seconds today at 0:00.
12741 Returns the float number of seconds since the beginning of the
12742 epoch to the beginning of today (00:00)."
12743 (float-time (apply 'encode-time
12744 (append '(0 0 0) (nthcdr 3 (decode-time))))))
12746 (defun org-matcher-time (s)
12747 "Interpret a time comparison value."
12748 (save-match-data
12749 (cond
12750 ((string= s "<now>") (float-time))
12751 ((string= s "<today>") (org-time-today))
12752 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
12753 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
12755 (+ (org-time-today)
12756 (* (string-to-number (match-string 1 s))
12757 (cdr (assoc (match-string 2 s)
12758 '(("d" . 86400.0) ("w" . 604800.0)
12759 ("m" . 2678400.0) ("y" . 31557600.0)))))))
12760 (t (org-2ft s)))))
12762 (defun org-match-any-p (re list)
12763 "Does re match any element of list?"
12764 (setq list (mapcar (lambda (x) (string-match re x)) list))
12765 (delq nil list))
12767 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
12768 (defvar org-tags-overlay (make-overlay 1 1))
12769 (org-detach-overlay org-tags-overlay)
12771 (defun org-get-local-tags-at (&optional pos)
12772 "Get a list of tags defined in the current headline."
12773 (org-get-tags-at pos 'local))
12775 (defun org-get-local-tags ()
12776 "Get a list of tags defined in the current headline."
12777 (org-get-tags-at nil 'local))
12779 (defun org-get-tags-at (&optional pos local)
12780 "Get a list of all headline tags applicable at POS.
12781 POS defaults to point. If tags are inherited, the list contains
12782 the targets in the same sequence as the headlines appear, i.e.
12783 the tags of the current headline come last.
12784 When LOCAL is non-nil, only return tags from the current headline,
12785 ignore inherited ones."
12786 (interactive)
12787 (if (and org-trust-scanner-tags
12788 (or (not pos) (equal pos (point)))
12789 (not local))
12790 org-scanner-tags
12791 (let (tags ltags lastpos parent)
12792 (save-excursion
12793 (save-restriction
12794 (widen)
12795 (goto-char (or pos (point)))
12796 (save-match-data
12797 (catch 'done
12798 (condition-case nil
12799 (progn
12800 (org-back-to-heading t)
12801 (while (not (equal lastpos (point)))
12802 (setq lastpos (point))
12803 (when (looking-at
12805 (setq ltags (org-split-string
12806 (org-match-string-no-properties 1) ":"))
12807 (when parent
12808 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
12809 (setq tags (append
12810 (if parent
12811 (org-remove-uninherited-tags ltags)
12812 ltags)
12813 tags)))
12814 (or org-use-tag-inheritance (throw 'done t))
12815 (if local (throw 'done t))
12816 (or (org-up-heading-safe) (error nil))
12817 (setq parent t)))
12818 (error nil)))))
12819 (if local
12820 tags
12821 (append (org-remove-uninherited-tags org-file-tags) tags))))))
12823 (defun org-add-prop-inherited (s)
12824 (add-text-properties 0 (length s) '(inherited t) s)
12825 s)
12827 (defun org-toggle-tag (tag &optional onoff)
12828 "Toggle the tag TAG for the current line.
12829 If ONOFF is `on' or `off', don't toggle but set to this state."
12830 (let (res current)
12831 (save-excursion
12832 (org-back-to-heading t)
12834 (point-at-eol) t)
12835 (progn
12836 (setq current (match-string 1))
12837 (replace-match ""))
12838 (setq current ""))
12839 (setq current (nreverse (org-split-string current ":")))
12840 (cond
12841 ((eq onoff 'on)
12842 (setq res t)
12843 (or (member tag current) (push tag current)))
12844 ((eq onoff 'off)
12845 (or (not (member tag current)) (setq current (delete tag current))))
12846 (t (if (member tag current)
12847 (setq current (delete tag current))
12848 (setq res t)
12849 (push tag current))))
12850 (end-of-line 1)
12851 (if current
12852 (progn
12853 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
12854 (org-set-tags nil t))
12855 (delete-horizontal-space))
12856 (run-hooks 'org-after-tags-change-hook))
12857 res))
12859 (defun org-align-tags-here (to-col)
12860 ;; Assumes that this is a headline
12861 (let ((pos (point)) (col (current-column)) ncol tags-l p)
12862 (beginning-of-line 1)
12864 (< pos (match-beginning 2)))
12865 (progn
12866 (setq tags-l (- (match-end 2) (match-beginning 2)))
12867 (goto-char (match-beginning 1))
12868 (insert " ")
12869 (delete-region (point) (1+ (match-beginning 2)))
12870 (setq ncol (max (1+ (current-column))
12871 (1+ col)
12872 (if (> to-col 0)
12873 to-col
12874 (- (abs to-col) tags-l))))
12875 (setq p (point))
12876 (insert (make-string (- ncol (current-column)) ?\ ))
12877 (setq ncol (current-column))
12878 (when indent-tabs-mode (tabify p (point-at-eol)))
12879 (org-move-to-column (min ncol col) t))
12880 (goto-char pos))))
12882 (defun org-set-tags-command (&optional arg just-align)
12883 "Call the set-tags command for the current entry."
12884 (interactive "P")
12885 (if (org-on-heading-p)
12886 (org-set-tags arg just-align)
12887 (save-excursion
12888 (org-back-to-heading t)
12889 (org-set-tags arg just-align))))
12891 (defun org-set-tags-to (data)
12892 "Set the tags of the current entry to DATA, replacing the current tags.
12893 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
12894 If DATA is nil or the empty string, any tags will be removed."
12895 (interactive "sTags: ")
12896 (setq data
12897 (cond
12898 ((eq data nil) "")
12899 ((equal data "") "")
12900 ((stringp data)
12901 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
12902 ":"))
12903 ((listp data)
12904 (concat ":" (mapconcat 'identity data ":") ":"))
12905 (t nil)))
12906 (when data
12907 (save-excursion
12908 (org-back-to-heading t)
12909 (when (looking-at org-complex-heading-regexp)
12910 (if (match-end 5)
12911 (progn
12912 (goto-char (match-beginning 5))
12913 (insert data)
12914 (delete-region (point) (point-at-eol))
12915 (org-set-tags nil 'align))
12916 (goto-char (point-at-eol))
12917 (insert " " data)
12918 (org-set-tags nil 'align)))
12919 (beginning-of-line 1)
12921 (delete-region (match-beginning 1) (match-end 1))))))
12923 (defun org-align-all-tags ()
12924 "Align the tags i all headings."
12925 (interactive)
12926 (save-excursion
12927 (or (ignore-errors (org-back-to-heading t))
12928 (outline-next-heading))
12929 (if (org-on-heading-p)
12930 (org-set-tags t)
12931 (message "No headings"))))
12933 (defvar org-indent-indentation-per-level)
12934 (defun org-set-tags (&optional arg just-align)
12935 "Set the tags for the current headline.
12936 With prefix ARG, realign all tags in headings in the current buffer."
12937 (interactive "P")
12938 (let* ((re (concat "^" outline-regexp))
12939 (current (org-get-tags-string))
12940 (col (current-column))
12941 (org-setting-tags t)
12942 table current-tags inherited-tags ; computed below when needed
12943 tags p0 c0 c1 rpl di tc level)
12944 (if arg
12945 (save-excursion
12946 (goto-char (point-min))
12947 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
12948 (while (re-search-forward re nil t)
12949 (org-set-tags nil t)
12950 (end-of-line 1)))
12951 (message "All tags realigned to column %d" org-tags-column))
12952 (if just-align
12953 (setq tags current)
12954 ;; Get a new set of tags from the user
12955 (save-excursion
12956 (setq table (append org-tag-persistent-alist
12957 (or org-tag-alist (org-get-buffer-tags))
12958 (and
12959 org-complete-tags-always-offer-all-agenda-tags
12960 (org-global-tags-completion-table
12961 (org-agenda-files))))
12962 org-last-tags-completion-table table
12963 current-tags (org-split-string current ":")
12964 inherited-tags (nreverse
12965 (nthcdr (length current-tags)
12966 (nreverse (org-get-tags-at))))
12967 tags
12968 (if (or (eq t org-use-fast-tag-selection)
12969 (and org-use-fast-tag-selection
12970 (delq nil (mapcar 'cdr table))))
12971 (org-fast-tag-selection
12972 current-tags inherited-tags table
12973 (if org-fast-tag-selection-include-todo
12974 org-todo-key-alist))
12975 (let ((org-add-colon-after-tag-completion t))
12976 (org-trim
12977 (org-without-partial-completion
12978 (org-icompleting-read "Tags: "
12979 'org-tags-completion-function
12980 nil nil current 'org-tags-history)))))))
12981 (while (string-match "[-+&]+" tags)
12982 ;; No boolean logic, just a list
12983 (setq tags (replace-match ":" t t tags))))
12985 (setq tags (replace-regexp-in-string "[,]" ":" tags))
12987 (if org-tags-sort-function
12988 (setq tags (mapconcat 'identity
12989 (sort (org-split-string
12990 tags (org-re "[^[:alnum:]_@#%]+"))
12991 org-tags-sort-function) ":")))
12994 (setq tags "")
12995 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
12996 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
12998 ;; Insert new tags at the correct column
12999 (beginning-of-line 1)
13000 (setq level (or (and (looking-at org-outline-regexp)
13001 (- (match-end 0) (point) 1))
13002 1))
13003 (cond
13004 ((and (equal current "") (equal tags "")))
13005 ((re-search-forward
13007 (point-at-eol) t)
13008 (if (equal tags "")
13009 (setq rpl "")
13010 (goto-char (match-beginning 0))
13011 (setq c0 (current-column)
13012 ;; compute offset for the case of org-indent-mode active
13013 di (if org-indent-mode
13014 (* (1- org-indent-indentation-per-level) (1- level))
13015 0)
13016 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13017 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13018 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13019 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13020 (replace-match rpl t t)
13021 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13022 tags)
13023 (t (error "Tags alignment failed")))
13024 (org-move-to-column col)
13025 (unless just-align
13026 (run-hooks 'org-after-tags-change-hook)))))
13028 (defun org-change-tag-in-region (beg end tag off)
13029 "Add or remove TAG for each entry in the region.
13030 This works in the agenda, and also in an org-mode buffer."
13031 (interactive
13032 (list (region-beginning) (region-end)
13033 (let ((org-last-tags-completion-table
13034 (if (org-mode-p)
13035 (org-get-buffer-tags)
13036 (org-global-tags-completion-table))))
13037 (org-icompleting-read
13038 "Tag: " 'org-tags-completion-function nil nil nil
13039 'org-tags-history))
13040 (progn
13042 (equal (read-char-exclusive) ?r))))
13043 (if (fboundp 'deactivate-mark) (deactivate-mark))
13044 (let ((agendap (equal major-mode 'org-agenda-mode))
13045 l1 l2 m buf pos newhead (cnt 0))
13046 (goto-char end)
13047 (setq l2 (1- (org-current-line)))
13048 (goto-char beg)
13049 (setq l1 (org-current-line))
13050 (loop for l from l1 to l2 do
13051 (org-goto-line l)
13052 (setq m (get-text-property (point) 'org-hd-marker))
13053 (when (or (and (org-mode-p) (org-on-heading-p))
13054 (and agendap m))
13055 (setq buf (if agendap (marker-buffer m) (current-buffer))
13056 pos (if agendap m (point)))
13057 (with-current-buffer buf
13058 (save-excursion
13059 (save-restriction
13060 (goto-char pos)
13061 (setq cnt (1+ cnt))
13062 (org-toggle-tag tag (if off 'off 'on))
13063 (setq newhead (org-get-heading)))))
13064 (and agendap (org-agenda-change-all-lines newhead m))))
13065 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13067 (defun org-tags-completion-function (string predicate &optional flag)
13068 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13069 (confirm (lambda (x) (stringp (car x)))))
13071 (setq s1 (match-string 1 string)
13072 s2 (match-string 2 string))
13073 (setq s1 "" s2 string))
13074 (cond
13075 ((eq flag nil)
13076 ;; try completion
13077 (setq rtn (try-completion s2 ctable confirm))
13078 (if (stringp rtn)
13079 (setq rtn
13080 (concat s1 s2 (substring rtn (length s2))
13081 (if (and org-add-colon-after-tag-completion
13082 (assoc rtn ctable))
13083 ":" ""))))
13084 rtn)
13085 ((eq flag t)
13086 ;; all-completions
13087 (all-completions s2 ctable confirm)
13088 )
13089 ((eq flag 'lambda)
13090 ;; exact match?
13091 (assoc s2 ctable)))
13092 ))
13094 (defun org-fast-tag-insert (kwd tags face &optional end)
13095 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13096 (insert (format "%-12s" (concat kwd ":"))
13097 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13098 (or end "")))
13100 (defun org-fast-tag-show-exit (flag)
13101 (save-excursion
13102 (org-goto-line 3)
13104 (replace-match ""))
13105 (when flag
13106 (end-of-line 1)
13107 (org-move-to-column (- (window-width) 19) t)
13108 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13110 (defun org-set-current-tags-overlay (current prefix)
13111 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13112 (if (featurep 'xemacs)
13113 (org-overlay-display org-tags-overlay (concat prefix s)
13114 'secondary-selection)
13115 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13116 (org-overlay-display org-tags-overlay (concat prefix s)))))
13118 (defvar org-last-tag-selection-key nil)
13119 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13120 "Fast tag selection with single keys.
13121 CURRENT is the current list of tags in the headline, INHERITED is the
13122 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13123 possibly with grouping information. TODO-TABLE is a similar table with
13124 TODO keywords, should these have keys assigned to them.
13125 If the keys are nil, a-z are automatically assigned.
13126 Returns the new tags string, or nil to not change the current settings."
13127 (let* ((fulltable (append table todo-table))
13128 (maxlen (apply 'max (mapcar
13129 (lambda (x)
13130 (if (stringp (car x)) (string-width (car x)) 0))
13131 fulltable)))
13132 (buf (current-buffer))
13133 (expert (eq org-fast-tag-selection-single-key 'expert))
13134 (buffer-tags nil)
13135 (fwidth (+ maxlen 3 1 3))
13136 (ncol (/ (- (window-width) 4) fwidth))
13137 (i-face 'org-done)
13138 (c-face 'org-todo)
13139 tg cnt e c char c1 c2 ntable tbl rtn
13140 ov-start ov-end ov-prefix
13141 (exit-after-next org-fast-tag-selection-single-key)
13142 (done-keywords org-done-keywords)
13143 groups ingroup)
13144 (save-excursion
13145 (beginning-of-line 1)
13146 (if (looking-at
13148 (setq ov-start (match-beginning 1)
13149 ov-end (match-end 1)
13150 ov-prefix "")
13151 (setq ov-start (1- (point-at-eol))
13152 ov-end (1+ ov-start))
13154 (setq ov-prefix
13155 (concat
13156 (buffer-substring (1- (point)) (point))
13157 (if (> (current-column) org-tags-column)
13158 " "
13159 (make-string (- org-tags-column (current-column)) ?\ ))))))
13160 (move-overlay org-tags-overlay ov-start ov-end)
13161 (save-window-excursion
13162 (if expert
13163 (set-buffer (get-buffer-create " *Org tags*"))
13164 (delete-other-windows)
13165 (split-window-vertically)
13166 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13167 (erase-buffer)
13168 (org-set-local 'org-done-keywords done-keywords)
13171 (org-fast-tag-show-exit exit-after-next)
13172 (org-set-current-tags-overlay current ov-prefix)
13173 (setq tbl fulltable char ?a cnt 0)
13174 (while (setq e (pop tbl))
13175 (cond
13176 ((equal (car e) :startgroup)
13177 (push '() groups) (setq ingroup t)
13178 (when (not (= cnt 0))
13179 (setq cnt 0)
13181 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13182 ((equal (car e) :endgroup)
13183 (setq ingroup nil cnt 0)
13185 ((equal e '(:newline))
13186 (when (not (= cnt 0))
13187 (setq cnt 0)
13189 (setq e (car tbl))
13190 (while (equal (car tbl) '(:newline))
13192 (setq tbl (cdr tbl)))))
13193 (t
13194 (setq tg (copy-sequence (car e)) c2 nil)
13195 (if (cdr e)
13196 (setq c (cdr e))
13197 ;; automatically assign a character.
13198 (setq c1 (string-to-char
13199 (downcase (substring
13200 tg (if (= (string-to-char tg) ?@) 1 0)))))
13201 (if (or (rassoc c1 ntable) (rassoc c1 table))
13202 (while (or (rassoc char ntable) (rassoc char table))
13203 (setq char (1+ char)))
13204 (setq c2 c1))
13205 (setq c (or c2 char)))
13206 (if ingroup (push tg (car groups)))
13207 (setq tg (org-add-props tg nil 'face
13208 (cond
13209 ((not (assoc tg table))
13210 (org-get-todo-face tg))
13211 ((member tg current) c-face)
13212 ((member tg inherited) i-face)
13213 (t nil))))
13214 (if (and (= cnt 0) (not ingroup)) (insert " "))
13215 (insert "[" c "] " tg (make-string
13216 (- fwidth 4 (length tg)) ?\ ))
13217 (push (cons tg c) ntable)
13218 (when (= (setq cnt (1+ cnt)) ncol)
13220 (if ingroup (insert " "))
13221 (setq cnt 0)))))
13222 (setq ntable (nreverse ntable))
13224 (goto-char (point-min))
13225 (if (not expert) (org-fit-window-to-buffer))
13226 (setq rtn
13227 (catch 'exit
13228 (while t
13229 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13230 (if (not groups) "no " "")
13231 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13232 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13233 (setq org-last-tag-selection-key c)
13234 (cond
13236 ((= c ?!)
13237 (setq groups (not groups))
13238 (goto-char (point-min))
13239 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13240 ((= c ?\C-c)
13241 (if (not expert)
13242 (org-fast-tag-show-exit
13243 (setq exit-after-next (not exit-after-next)))
13244 (setq expert nil)
13245 (delete-other-windows)
13246 (set-window-buffer (split-window-vertically) " *Org tags*")
13247 (org-switch-to-buffer-other-window " *Org tags*")
13248 (org-fit-window-to-buffer)))
13249 ((or (= c ?\C-g)
13250 (and (= c ?q) (not (rassoc c ntable))))
13251 (org-detach-overlay org-tags-overlay)
13252 (setq quit-flag t))
13253 ((= c ?\ )
13254 (setq current nil)
13255 (if exit-after-next (setq exit-after-next 'now)))
13257 (condition-case nil
13258 (setq tg (org-icompleting-read
13259 "Tag: "
13260 (or buffer-tags
13261 (with-current-buffer buf
13262 (org-get-buffer-tags)))))
13263 (quit (setq tg "")))
13265 (add-to-list 'buffer-tags (list tg))
13266 (if (member tg current)
13267 (setq current (delete tg current))
13268 (push tg current)))
13269 (if exit-after-next (setq exit-after-next 'now)))
13270 ((setq e (rassoc c todo-table) tg (car e))
13271 (with-current-buffer buf
13272 (save-excursion (org-todo tg)))
13273 (if exit-after-next (setq exit-after-next 'now)))
13274 ((setq e (rassoc c ntable) tg (car e))
13275 (if (member tg current)
13276 (setq current (delete tg current))
13277 (loop for g in groups do
13278 (if (member tg g)
13279 (mapc (lambda (x)
13280 (setq current (delete x current)))
13281 g)))
13282 (push tg current))
13283 (if exit-after-next (setq exit-after-next 'now))))
13285 ;; Create a sorted list
13286 (setq current
13287 (sort current
13288 (lambda (a b)
13289 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13290 (if (eq exit-after-next 'now) (throw 'exit t))
13291 (goto-char (point-min))
13292 (beginning-of-line 2)
13293 (delete-region (point) (point-at-eol))
13294 (org-fast-tag-insert "Current" current c-face)
13295 (org-set-current-tags-overlay current ov-prefix)
13296 (while (re-search-forward
13298 (setq tg (match-string 1))
13299 (add-text-properties
13300 (match-beginning 1) (match-end 1)
13301 (list 'face
13302 (cond
13303 ((member tg current) c-face)
13304 ((member tg inherited) i-face)
13305 (t (get-text-property (match-beginning 1) 'face))))))
13306 (goto-char (point-min)))))
13307 (org-detach-overlay org-tags-overlay)
13308 (if rtn
13309 (mapconcat 'identity current ":")
13310 nil))))
13312 (defun org-get-tags-string ()
13313 "Get the TAGS string in the current headline."
13314 (unless (org-on-heading-p t)
13315 (error "Not on a heading"))
13316 (save-excursion
13317 (beginning-of-line 1)
13319 (org-match-string-no-properties 1)
13320 "")))
13322 (defun org-get-tags ()
13323 "Get the list of tags specified in the current headline."
13324 (org-split-string (org-get-tags-string) ":"))
13326 (defun org-get-buffer-tags ()
13327 "Get a table of all tags used in the buffer, for completion."
13328 (let (tags)
13329 (save-excursion
13330 (goto-char (point-min))
13331 (while (re-search-forward
13333 (when (equal (char-after (point-at-bol 0)) ?*)
13334 (mapc (lambda (x) (add-to-list 'tags x))
13335 (org-split-string (org-match-string-no-properties 1) ":")))))
13336 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13337 (mapcar 'list tags)))
13339 ;;;; The mapping API
13341 ;;;###autoload
13342 (defun org-map-entries (func &optional match scope &rest skip)
13343 "Call FUNC at each headline selected by MATCH in SCOPE.
13345 FUNC is a function or a lisp form. The function will be called without
13346 arguments, with the cursor positioned at the beginning of the headline.
13347 The return values of all calls to the function will be collected and
13348 returned as a list.
13350 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13351 does not need to preserve point. After evaluation, the cursor will be
13352 moved to the end of the line (presumably of the headline of the
13353 processed entry) and search continues from there. Under some
13354 circumstances, this may not produce the wanted results. For example,
13355 if you have removed (e.g. archived) the current (sub)tree it could
13356 mean that the next entry will be skipped entirely. In such cases, you
13357 can specify the position from where search should continue by making
13358 FUNC set the variable `org-map-continue-from' to the desired buffer
13359 position.
13361 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13362 Only headlines that are matched by this query will be considered during
13363 the iteration. When MATCH is nil or t, all headlines will be
13364 visited by the iteration.
13366 SCOPE determines the scope of this command. It can be any of:
13368 nil The current buffer, respecting the restriction if any
13369 tree The subtree started with the entry at point
13370 file The current buffer, without restriction
13371 file-with-archives
13372 The current buffer, and any archives associated with it
13373 agenda All agenda files
13374 agenda-with-archives
13375 All agenda files with any archive files associated with them
13376 \(file1 file2 ...)
13377 If this is a list, all files in the list will be scanned
13379 The remaining args are treated as settings for the skipping facilities of
13380 the scanner. The following items can be given here:
13382 archive skip trees with the archive tag.
13383 comment skip trees with the COMMENT keyword
13384 function or Emacs Lisp form:
13385 will be used as value for `org-agenda-skip-function', so whenever
13386 the function returns t, FUNC will not be called for that
13387 entry and search will continue from the point where the
13388 function leaves it.
13390 If your function needs to retrieve the tags including inherited tags
13391 at the *current* entry, you can use the value of the variable
13392 `org-scanner-tags' which will be much faster than getting the value
13393 with `org-get-tags-at'. If your function gets properties with
13394 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13395 to t around the call to `org-entry-properties' to get the same speedup.
13396 Note that if your function moves around to retrieve tags and properties at
13397 a *different* entry, you cannot use these techniques."
13398 (let* ((org-agenda-archives-mode nil) ; just to make sure
13399 (org-agenda-skip-archived-trees (memq 'archive skip))
13400 (org-agenda-skip-comment-trees (memq 'comment skip))
13401 (org-agenda-skip-function
13402 (car (org-delete-all '(comment archive) skip)))
13403 (org-tags-match-list-sublevels t)
13404 matcher file res
13405 org-todo-keywords-for-agenda
13406 org-done-keywords-for-agenda
13407 org-todo-keyword-alist-for-agenda
13408 org-drawers-for-agenda
13409 org-tag-alist-for-agenda)
13411 (cond
13412 ((eq match t) (setq matcher t))
13413 ((eq match nil) (setq matcher t))
13414 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13416 (save-excursion
13417 (save-restriction
13418 (when (eq scope 'tree)
13419 (org-back-to-heading t)
13420 (org-narrow-to-subtree)
13421 (setq scope nil))
13423 (if (not scope)
13424 (progn
13425 (org-prepare-agenda-buffers
13426 (list (buffer-file-name (current-buffer))))
13427 (setq res (org-scan-tags func matcher)))
13428 ;; Get the right scope
13429 (cond
13430 ((and scope (listp scope) (symbolp (car scope)))
13431 (setq scope (eval scope)))
13432 ((eq scope 'agenda)
13433 (setq scope (org-agenda-files t)))
13434 ((eq scope 'agenda-with-archives)
13435 (setq scope (org-agenda-files t))
13436 (setq scope (org-add-archive-files scope)))
13437 ((eq scope 'file)
13438 (setq scope (list (buffer-file-name))))
13439 ((eq scope 'file-with-archives)
13440 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13441 (org-prepare-agenda-buffers scope)
13442 (while (setq file (pop scope))
13443 (with-current-buffer (org-find-base-buffer-visiting file)
13444 (save-excursion
13445 (save-restriction
13446 (widen)
13447 (goto-char (point-min))
13448 (setq res (append res (org-scan-tags func matcher))))))))))
13449 res))
13451 ;;;; Properties
13453 ;;; Setting and retrieving properties
13455 (defconst org-special-properties
13456 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13457 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13458 "The special properties valid in Org-mode.
13460 These are properties that are not defined in the property drawer,
13461 but in some other way.")
13463 (defconst org-default-properties
13464 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13465 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13466 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13467 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13468 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13469 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13470 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13471 "Some properties that are used by Org-mode for various purposes.
13472 Being in this list makes sure that they are offered for completion.")
13475 "Regular expression matching the first line of a property drawer.")
13478 "Regular expression matching the last line of a property drawer.")
13481 "Regular expression matching the first line of a property drawer.")
13484 "Regular expression matching the first line of a property drawer.")
13486 (defconst org-property-drawer-re
13489 "Matches an entire property drawer.")
13491 (defconst org-clock-drawer-re
13494 "Matches an entire clock drawer.")
13496 (defun org-property-action ()
13497 "Do an action on properties."
13498 (interactive)
13499 (let (c)
13500 (org-at-property-p)
13501 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13502 (setq c (read-char-exclusive))
13503 (cond
13504 ((equal c ?s)
13505 (call-interactively 'org-set-property))
13506 ((equal c ?d)
13507 (call-interactively 'org-delete-property))
13508 ((equal c ?D)
13509 (call-interactively 'org-delete-property-globally))
13510 ((equal c ?c)
13511 (call-interactively 'org-compute-property-at-point))
13512 (t (error "No such property action %c" c)))))
13514 (defun org-set-effort (&optional value)
13515 "Set the effort property of the current entry.
13516 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13517 allowed value."
13518 (interactive "P")
13519 (if (equal value 0) (setq value 10))
13520 (let* ((completion-ignore-case t)
13521 (prop org-effort-property)
13522 (cur (org-entry-get nil prop))
13523 (allowed (org-property-get-allowed-values nil prop 'table))
13524 (existing (mapcar 'list (org-property-values prop)))
13525 rpl
13526 (val (cond
13527 ((stringp value) value)
13528 ((and allowed (integerp value))
13529 (or (car (nth (1- value) allowed))
13530 (car (org-last allowed))))
13531 (allowed
13532 (message "Select 1-9,0, [RET%s]: %s"
13533 (if cur (concat "=" cur) "")
13534 (mapconcat 'car allowed " "))
13535 (setq rpl (read-char-exclusive))
13537 cur
13538 (setq rpl (- rpl ?0))
13539 (if (equal rpl 0) (setq rpl 10))
13540 (if (and (> rpl 0) (<= rpl (length allowed)))
13541 (car (nth (1- rpl) allowed))
13542 (org-completing-read "Effort: " allowed nil))))
13543 (t
13544 (let (org-completion-use-ido org-completion-use-iswitchb)
13545 (org-completing-read
13547 (concat "[" cur "]") "")
13548 ": ")
13549 existing nil nil "" nil cur))))))
13550 (unless (equal (org-entry-get nil prop) val)
13551 (org-entry-put nil prop val))
13552 (message "%s is now %s" prop val)))
13554 (defun org-at-property-p ()
13555 "Is cursor inside a property drawer?"
13556 (save-excursion
13557 (beginning-of-line 1)
13559 (save-match-data ;; Used by calling procedures
13560 (let ((p (point))
13561 (range (unless (org-before-first-heading-p)
13562 (org-get-property-block))))
13563 (and range (<= (car range) p) (< p (cdr range))))))))
13565 (defun org-get-property-block (&optional beg end force)
13566 "Return the (beg . end) range of the body of the property drawer.
13567 BEG and END can be beginning and end of subtree, if not given
13568 they will be found.
13569 If the drawer does not exist and FORCE is non-nil, create the drawer."
13570 (catch 'exit
13571 (save-excursion
13572 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13573 (end (or end (progn (outline-next-heading) (point)))))
13574 (goto-char beg)
13575 (if (re-search-forward org-property-start-re end t)
13576 (setq beg (1+ (match-end 0)))
13577 (if force
13578 (save-excursion
13579 (org-insert-property-drawer)
13580 (setq end (progn (outline-next-heading) (point))))
13581 (throw 'exit nil))
13582 (goto-char beg)
13583 (if (re-search-forward org-property-start-re end t)
13584 (setq beg (1+ (match-end 0)))))
13585 (if (re-search-forward org-property-end-re end t)
13586 (setq end (match-beginning 0))
13587 (or force (throw 'exit nil))
13588 (goto-char beg)
13589 (setq end beg)
13590 (org-indent-line-function)
13592 (cons beg end)))))
13594 (defun org-entry-properties (&optional pom which specific)
13595 "Get all properties of the entry at point-or-marker POM.
13596 This includes the TODO keyword, the tags, time strings for deadline,
13597 scheduled, and clocking, and any additional properties defined in the
13598 entry. The return value is an alist, keys may occur multiple times
13599 if the property key was used several times.
13600 POM may also be nil, in which case the current entry is used.
13601 If WHICH is nil or `all', get all properties. If WHICH is
13602 `special' or `standard', only get that subclass. If WHICH
13603 is a string only get exactly this property. SPECIFIC can be a string, the
13604 specific property we are interested in. Specifying it can speed
13605 things up because then unnecessary parsing is avoided."
13606 (setq which (or which 'all))
13607 (org-with-point-at pom
13608 (let ((clockstr (substring org-clock-string 0 -1))
13609 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
13610 (case-fold-search nil)
13611 beg end range props sum-props key key1 value string clocksum)
13612 (save-excursion
13613 (when (condition-case nil
13614 (and (org-mode-p) (org-back-to-heading t))
13615 (error nil))
13616 (setq beg (point))
13617 (setq sum-props (get-text-property (point) 'org-summaries))
13618 (setq clocksum (get-text-property (point) :org-clock-minutes))
13619 (outline-next-heading)
13620 (setq end (point))
13621 (when (memq which '(all special))
13622 ;; Get the special properties, like TODO and tags
13623 (goto-char beg)
13624 (when (and (or (not specific) (string= specific "TODO"))
13625 (looking-at org-todo-line-regexp) (match-end 2))
13626 (push (cons "TODO" (org-match-string-no-properties 2)) props))
13627 (when (and (or (not specific) (string= specific "PRIORITY"))
13628 (looking-at org-priority-regexp))
13629 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
13630 (when (or (not specific) (string= specific "FILE"))
13631 (push (cons "FILE" buffer-file-name) props))
13632 (when (and (or (not specific) (string= specific "TAGS"))
13633 (setq value (org-get-tags-string))
13635 (push (cons "TAGS" value) props))
13636 (when (and (or (not specific) (string= specific "ALLTAGS"))
13637 (setq value (org-get-tags-at)))
13638 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
13639 ":"))
13640 props))
13641 (when (or (not specific) (string= specific "BLOCKED"))
13642 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
13643 (when (or (not specific)
13644 (member specific
13645 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
13646 "TIMESTAMP" "TIMESTAMP_IA")))
13647 (catch 'match
13648 (while (re-search-forward org-maybe-keyword-time-regexp end t)
13649 (setq key (if (match-end 1)
13650 (substring (org-match-string-no-properties 1)
13651 0 -1))
13652 string (if (equal key clockstr)
13653 (org-no-properties
13654 (org-trim
13655 (buffer-substring
13656 (match-beginning 3) (goto-char
13657 (point-at-eol)))))
13658 (substring (org-match-string-no-properties 3)
13659 1 -1)))
13660 ;; Get the correct property name from the key. This is
13661 ;; necessary if the user has configured time keywords.
13662 (setq key1 (concat key ":"))
13663 (cond
13664 ((not key)
13665 (setq key
13666 (if (= (char-after (match-beginning 3)) ?\[)
13667 "TIMESTAMP_IA" "TIMESTAMP")))
13668 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
13669 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
13670 ((equal key1 org-closed-string) (setq key "CLOSED"))
13671 ((equal key1 org-clock-string) (setq key "CLOCK")))
13672 (if (and specific (equal key specific) (not (equal key "CLOCK")))
13673 (progn
13674 (push (cons key string) props)
13675 ;; no need to search further if match is found
13676 (throw 'match t))
13677 (when (or (equal key "CLOCK") (not (assoc key props)))
13678 (push (cons key string) props))))))
13679 )
13681 (when (memq which '(all standard))
13682 ;; Get the standard properties, like :PROP: ...
13683 (setq range (org-get-property-block beg end))
13684 (when range
13685 (goto-char (car range))
13686 (while (re-search-forward
13688 (cdr range) t)
13689 (setq key (org-match-string-no-properties 1)
13690 value (org-trim (or (org-match-string-no-properties 2) "")))
13691 (unless (member key excluded)
13692 (push (cons key (or value "")) props)))))
13693 (if clocksum
13694 (push (cons "CLOCKSUM"
13695 (org-columns-number-to-string (/ (float clocksum) 60.)
13696 'add_times))
13697 props))
13698 (unless (assoc "CATEGORY" props)
13699 (push (cons "CATEGORY" (org-get-category)) props))
13700 (append sum-props (nreverse props)))))))
13702 (defun org-entry-get (pom property &optional inherit literal-nil)
13703 "Get value of PROPERTY for entry at point-or-marker POM.
13704 If INHERIT is non-nil and the entry does not have the property,
13705 then also check higher levels of the hierarchy.
13706 If INHERIT is the symbol `selective', use inheritance only if the setting
13707 in `org-use-property-inheritance' selects PROPERTY for inheritance.
13708 If the property is present but empty, the return value is the empty string.
13709 If the property is not present at all, nil is returned.
13712 do not interpret it as the list atom nil. This is used for inheritance
13714 (org-with-point-at pom
13715 (if (and inherit (if (eq inherit 'selective)
13716 (org-property-inherit-p property)
13717 t))
13718 (org-entry-get-with-inheritance property literal-nil)
13719 (if (member property org-special-properties)
13720 ;; We need a special property. Use `org-entry-properties' to
13721 ;; retrieve it, but specify the wanted property
13722 (cdr (assoc property (org-entry-properties nil 'special property)))
13723 (let ((range (unless (org-before-first-heading-p)
13724 (org-get-property-block))))
13725 (if (and range
13726 (goto-char (car range))
13727 (re-search-forward
13728 (org-re-property property)
13729 (cdr range) t))
13730 ;; Found the property, return it.
13731 (if (match-end 1)
13732 (if literal-nil
13733 (org-match-string-no-properties 1)
13734 (org-not-nil (org-match-string-no-properties 1)))
13735 "")))))))
13737 (defun org-property-or-variable-value (var &optional inherit)
13738 "Check if there is a property fixing the value of VAR.
13739 If yes, return this value. If not, return the current value of the variable."
13740 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
13742 (read prop)
13743 (symbol-value var))))
13745 (defun org-entry-delete (pom property)
13746 "Delete the property PROPERTY from entry at point-or-marker POM."
13747 (org-with-point-at pom
13748 (if (member property org-special-properties)
13749 nil ; cannot delete these properties.
13750 (let ((range (org-get-property-block)))
13751 (if (and range
13752 (goto-char (car range))
13753 (re-search-forward
13754 (org-re-property property)
13755 (cdr range) t))
13756 (progn
13757 (delete-region (match-beginning 0) (1+ (point-at-eol)))
13758 t)
13759 nil)))))
13761 ;; Multi-values properties are properties that contain multiple values
13762 ;; These values are assumed to be single words, separated by whitespace.
13763 (defun org-entry-add-to-multivalued-property (pom property value)
13764 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
13765 (let* ((old (org-entry-get pom property))
13767 (setq value (org-entry-protect-space value))
13768 (unless (member value values)
13769 (setq values (cons value values))
13770 (org-entry-put pom property
13771 (mapconcat 'identity values " ")))))
13773 (defun org-entry-remove-from-multivalued-property (pom property value)
13774 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
13775 (let* ((old (org-entry-get pom property))
13777 (setq value (org-entry-protect-space value))
13778 (when (member value values)
13779 (setq values (delete value values))
13780 (org-entry-put pom property
13781 (mapconcat 'identity values " ")))))
13783 (defun org-entry-member-in-multivalued-property (pom property value)
13784 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
13785 (let* ((old (org-entry-get pom property))
13787 (setq value (org-entry-protect-space value))
13788 (member value values)))
13790 (defun org-entry-get-multivalued-property (pom property)
13791 "Return a list of values in a multivalued property."
13792 (let* ((value (org-entry-get pom property))
13794 (mapcar 'org-entry-restore-space values)))
13796 (defun org-entry-put-multivalued-property (pom property &rest values)
13797 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
13798 VALUES should be a list of strings. Spaces will be protected."
13799 (org-entry-put pom property
13800 (mapconcat 'org-entry-protect-space values " "))
13801 (let* ((value (org-entry-get pom property))
13803 (mapcar 'org-entry-restore-space values)))
13805 (defun org-entry-protect-space (s)
13806 "Protect spaces and newline in string S."
13807 (while (string-match " " s)
13808 (setq s (replace-match "%20" t t s)))
13810 (setq s (replace-match "%0A" t t s)))
13811 s)
13813 (defun org-entry-restore-space (s)
13814 "Restore spaces and newline in string S."
13815 (while (string-match "%20" s)
13816 (setq s (replace-match " " t t s)))
13817 (while (string-match "%0A" s)
13819 s)
13821 (defvar org-entry-property-inherited-from (make-marker)
13822 "Marker pointing to the entry from where a property was inherited.
13823 Each call to `org-entry-get-with-inheritance' will set this marker to the
13824 location of the entry where the inheritance search matched. If there was
13825 no match, the marker will point nowhere.
13826 Note that also `org-entry-get' calls this function, if the INHERIT flag
13827 is set.")
13829 (defun org-entry-get-with-inheritance (property &optional literal-nil)
13830 "Get entry property, and search higher levels if not present.
13831 The search will stop at the first ancestor which has the property defined.
13833 should be considered as undefined (this is the meaning of nil here).
13835 (move-marker org-entry-property-inherited-from nil)
13836 (let (tmp)
13837 (unless (org-before-first-heading-p)
13838 (save-excursion
13839 (save-restriction
13840 (widen)
13841 (catch 'ex
13842 (while t
13843 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
13844 (org-back-to-heading t)
13845 (move-marker org-entry-property-inherited-from (point))
13846 (throw 'ex tmp))
13847 (or (org-up-heading-safe) (throw 'ex nil)))))))
13848 (setq tmp (or tmp
13849 (cdr (assoc property org-file-properties))
13850 (cdr (assoc property org-global-properties))
13851 (cdr (assoc property org-global-properties-fixed))))
13852 (if literal-nil tmp (org-not-nil tmp))))
13854 (defvar org-property-changed-functions nil
13855 "Hook called when the value of a property has changed.
13856 Each hook function should accept two arguments, the name of the property
13857 and the new value.")
13859 (defun org-entry-put (pom property value)
13860 "Set PROPERTY to VALUE for entry at point-or-marker POM."
13861 (org-with-point-at pom
13862 (org-back-to-heading t)
13863 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
13864 range)
13865 (cond
13866 ((equal property "TODO")
13868 (not (member value org-todo-keywords-1)))
13870 (if (or (not value)
13872 (setq value 'none))
13873 (org-todo value)
13874 (org-set-tags nil 'align))
13875 ((equal property "PRIORITY")
13877 (string-to-char value) ?\ ))
13878 (org-set-tags nil 'align))
13879 ((equal property "SCHEDULED")
13880 (if (re-search-forward org-scheduled-time-regexp end t)
13881 (cond
13882 ((eq value 'earlier) (org-timestamp-change -1 'day))
13883 ((eq value 'later) (org-timestamp-change 1 'day))
13884 (t (call-interactively 'org-schedule)))
13885 (call-interactively 'org-schedule)))
13886 ((equal property "DEADLINE")
13887 (if (re-search-forward org-deadline-time-regexp end t)
13888 (cond
13889 ((eq value 'earlier) (org-timestamp-change -1 'day))
13890 ((eq value 'later) (org-timestamp-change 1 'day))
13891 (t (call-interactively 'org-deadline)))
13892 (call-interactively 'org-deadline)))
13893 ((member property org-special-properties)
13894 (error "The %s property can not yet be set with `org-entry-put'"
13895 property))
13896 (t ; a non-special property
13897 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
13898 (setq range (org-get-property-block beg end 'force))
13899 (goto-char (car range))
13900 (if (re-search-forward
13901 (org-re-property property) (cdr range) t)
13902 (progn
13903 (delete-region (match-beginning 1) (match-end 1))
13904 (goto-char (match-beginning 1)))
13905 (goto-char (cdr range))
13907 (backward-char 1)
13908 (org-indent-line-function)
13909 (insert ":" property ":"))
13910 (and value (insert " " value))
13911 (org-indent-line-function)))))
13912 (run-hook-with-args 'org-property-changed-functions property value)))
13914 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
13915 "Get all property keys in the current buffer.
13916 With INCLUDE-SPECIALS, also list the special properties that reflect things
13917 like tags and TODO state.
13918 With INCLUDE-DEFAULTS, also include properties that has special meaning
13919 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
13920 and others.
13921 With INCLUDE-COLUMNS, also include property names given in COLUMN
13922 formats in the current buffer."
13923 (let (rtn range cfmt s p)
13924 (save-excursion
13925 (save-restriction
13926 (widen)
13927 (goto-char (point-min))
13928 (while (re-search-forward org-property-start-re nil t)
13929 (setq range (org-get-property-block))
13930 (goto-char (car range))
13931 (while (re-search-forward
13933 (cdr range) t)
13934 (add-to-list 'rtn (org-match-string-no-properties 1)))
13935 (outline-next-heading))))
13937 (when include-specials
13938 (setq rtn (append org-special-properties rtn)))
13940 (when include-defaults
13941 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
13942 (add-to-list 'rtn org-effort-property))
13944 (when include-columns
13945 (save-excursion
13946 (save-restriction
13947 (widen)
13948 (goto-char (point-min))
13949 (while (re-search-forward
13951 nil t)
13952 (setq cfmt (match-string 2) s 0)
13954 cfmt s)
13955 (setq s (match-end 0)
13956 p (match-string 1 cfmt))
13957 (unless (or (equal p "ITEM")
13958 (member p org-special-properties))
13959 (add-to-list 'rtn (match-string 1 cfmt))))))))
13961 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
13963 (defsubst org-re-property (property)
13964 "Return a regexp matching PROPERTY.
13965 Match group 1 will be set to the value "
13968 (defun org-property-values (key)
13969 "Return a list of all values of property KEY in the current buffer."
13970 (save-excursion
13971 (save-restriction
13972 (widen)
13973 (goto-char (point-min))
13974 (let ((re (org-re-property key))
13975 values)
13976 (while (re-search-forward re nil t)
13977 (add-to-list 'values (org-trim (match-string 1))))
13978 (delete "" values)))))
13980 (defun org-insert-property-drawer ()
13981 "Insert a property drawer into the current entry."
13982 (interactive)
13983 (org-back-to-heading t)
13984 (looking-at outline-regexp)
13985 (let ((indent (if org-adapt-indentation
13986 (- (match-end 0)(match-beginning 0))
13987 0))
13988 (beg (point))
13990 end hiddenp)
13991 (outline-next-heading)
13992 (setq end (point))
13993 (goto-char beg)
13994 (while (re-search-forward re end t))
13995 (setq hiddenp (outline-invisible-p))
13996 (end-of-line 1)
13999 (if (member (match-string 1) '("CLOCK:" ":END:"))
14000 ;; just skip this line
14001 (beginning-of-line 2)
14002 ;; Drawer start, find the end
14004 (beginning-of-line 1)))
14005 (org-skip-over-state-notes)
14007 (if (eq (char-before) ?*) (forward-char 1))
14009 (beginning-of-line 0)
14010 (org-indent-to-column indent)
14011 (beginning-of-line 2)
14012 (org-indent-to-column indent)
14013 (beginning-of-line 0)
14014 (if hiddenp
14015 (save-excursion
14016 (org-back-to-heading t)
14017 (hide-entry))
14018 (org-flag-drawer t))))
14020 (defvar org-property-set-functions-alist nil
14021 "Property set function alist.
14022 Each entry should have the following format:
14024 (PROPERTY . READ-FUNCTION)
14026 The read function will be called with the same argument as
14027 `org-completing-read'.")
14029 (defun org-set-property-function (property)
14030 "Get the function that should be used to set PROPERTY.
14031 This is computed according to `org-property-set-functions-alist'."
14032 (or (cdr (assoc property org-property-set-functions-alist))
14033 'org-completing-read))
14035 (defun org-read-property-value (property)
14036 "Read PROPERTY value from user."
14037 (let* ((completion-ignore-case t)
14038 (allowed (org-property-get-allowed-values nil property 'table))
14039 (cur (org-entry-get nil property))
14040 (prompt (concat property " value"
14042 (concat " [" cur "]") "") ": "))
14043 (set-function (org-set-property-function property))
14044 (val (if allowed
14045 (funcall set-function prompt allowed nil
14046 (not (get-text-property 0 'org-unrestricted
14047 (caar allowed))))
14048 (let (org-completion-use-ido org-completion-use-iswitchb)
14049 (funcall set-function prompt
14050 (mapcar 'list (org-property-values property))
14051 nil nil "" nil cur)))))
14052 (if (equal val "")
14053 cur
14054 val)))
14056 (defun org-read-property-name ()
14057 "Read a property name."
14058 (let* ((completion-ignore-case t)
14059 (keys (org-buffer-property-keys nil t t))
14060 (property (org-icompleting-read "Property: " (mapcar 'list keys))))
14061 (if (member property keys)
14062 property
14063 (or (cdr (assoc (downcase property)
14064 (mapcar (lambda (x) (cons (downcase x) x))
14065 keys)))
14066 property))))
14068 (defun org-set-property (property value)
14069 "In the current entry, set PROPERTY to VALUE.
14070 When called interactively, this will prompt for a property name, offering
14071 completion on existing and default properties. And then it will prompt
14072 for a value, offering completion either on allowed values (via an inherited
14073 xxx_ALL property) or on existing values in other instances of this property
14074 in the current file."
14075 (interactive (list nil nil))
14076 (let* ((property (or property (org-read-property-name)))
14077 (value (or value (org-read-property-value property))))
14078 (unless (equal (org-entry-get nil property) value)
14079 (org-entry-put nil property value))))
14081 (defun org-delete-property (property)
14082 "In the current entry, delete PROPERTY."
14083 (interactive
14084 (let* ((completion-ignore-case t)
14085 (prop (org-icompleting-read "Property: "
14086 (org-entry-properties nil 'standard))))
14087 (list prop)))
14088 (message "Property %s %s" property
14089 (if (org-entry-delete nil property)
14090 "deleted"
14091 "was not present in the entry")))
14093 (defun org-delete-property-globally (property)
14094 "Remove PROPERTY globally, from all entries."
14095 (interactive
14096 (let* ((completion-ignore-case t)
14097 (prop (org-icompleting-read
14098 "Globally remove property: "
14099 (mapcar 'list (org-buffer-property-keys)))))
14100 (list prop)))
14101 (save-excursion
14102 (save-restriction
14103 (widen)
14104 (goto-char (point-min))
14105 (let ((cnt 0))
14106 (while (re-search-forward
14107 (org-re-property property)
14108 nil t)
14109 (setq cnt (1+ cnt))
14110 (replace-match ""))
14113 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14115 (defun org-compute-property-at-point ()
14116 "Compute the property at point.
14117 This looks for an enclosing column format, extracts the operator and
14118 then applies it to the property in the column format's scope."
14119 (interactive)
14120 (unless (org-at-property-p)
14121 (error "Not at a property"))
14122 (let ((prop (org-match-string-no-properties 2)))
14123 (org-columns-get-format-and-top-level)
14124 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14125 (error "No operator defined for property %s" prop))
14126 (org-columns-compute prop)))
14128 (defvar org-property-allowed-value-functions nil
14129 "Hook for functions supplying allowed values for a specific property.
14130 The functions must take a single argument, the name of the property, and
14132 the values, this means that these values are intended as defaults for
14133 completion, but that other values should be allowed too.
14134 The functions must return nil if they are not responsible for this
14135 property.")
14137 (defun org-property-get-allowed-values (pom property &optional table)
14138 "Get allowed values for the property PROPERTY.
14139 When TABLE is non-nil, return an alist that can directly be used for
14140 completion."
14141 (let (vals)
14142 (cond
14143 ((equal property "TODO")
14144 (setq vals (org-with-point-at pom
14145 (append org-todo-keywords-1 '("")))))
14146 ((equal property "PRIORITY")
14147 (let ((n org-lowest-priority))
14148 (while (>= n org-highest-priority)
14149 (push (char-to-string n) vals)
14150 (setq n (1- n)))))
14151 ((member property org-special-properties))
14152 ((setq vals (run-hook-with-args-until-success
14153 'org-property-allowed-value-functions property)))
14154 (t
14155 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14157 (setq vals (car (read-from-string (concat "(" vals ")"))))
14158 (setq vals (mapcar (lambda (x)
14159 (cond ((stringp x) x)
14160 ((numberp x) (number-to-string x))
14161 ((symbolp x) (symbol-name x))
14162 (t "???")))
14163 vals)))))
14164 (when (member ":ETC" vals)
14165 (setq vals (remove ":ETC" vals))
14166 (org-add-props (car vals) '(org-unrestricted t)))
14167 (if table (mapcar 'list vals) vals)))
14169 (defun org-property-previous-allowed-value (&optional previous)
14170 "Switch to the next allowed value for this property."
14171 (interactive)
14172 (org-property-next-allowed-value t))
14174 (defun org-property-next-allowed-value (&optional previous)
14175 "Switch to the next allowed value for this property."
14176 (interactive)
14177 (unless (org-at-property-p)
14178 (error "Not at a property"))
14179 (let* ((key (match-string 2))
14180 (value (match-string 3))
14181 (allowed (or (org-property-get-allowed-values (point) key)
14182 (and (member value '("[ ]" "[-]" "[X]"))
14183 '("[ ]" "[X]"))))
14184 nval)
14185 (unless allowed
14186 (error "Allowed values for this property have not been defined"))
14187 (if previous (setq allowed (reverse allowed)))
14188 (if (member value allowed)
14189 (setq nval (car (cdr (member value allowed)))))
14190 (setq nval (or nval (car allowed)))
14191 (if (equal nval value)
14192 (error "Only one allowed value for this property"))
14193 (org-at-property-p)
14194 (replace-match (concat " :" key ": " nval) t t)
14195 (org-indent-line-function)
14196 (beginning-of-line 1)
14198 (run-hook-with-args 'org-property-changed-functions key nval)))
14200 (defun org-find-olp (path &optional this-buffer)
14201 "Return a marker pointing to the entry at outline path OLP.
14202 If anything goes wrong, throw an error.
14203 You can wrap this call to catch the error like this:
14205 (condition-case msg
14206 (org-mobile-locate-entry (match-string 4))
14207 (error (nth 1 msg)))
14209 The return value will then be either a string with the error message,
14210 or a marker if everything is OK.
14212 If THIS-BUFFER is set, the outline path does not contain a file,
14213 only headings."
14214 (let* ((file (if this-buffer buffer-file-name (pop path)))
14215 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14216 (level 1)
14217 (lmin 1)
14218 (lmax 1)
14219 limit re end found pos heading cnt flevel)
14220 (unless buffer (error "File not found :%s" file))
14221 (with-current-buffer buffer
14222 (save-excursion
14223 (save-restriction
14224 (widen)
14225 (setq limit (point-max))
14226 (goto-char (point-min))
14227 (while (setq heading (pop path))
14228 (setq re (format org-complex-heading-regexp-format
14229 (regexp-quote heading)))
14230 (setq cnt 0 pos (point))
14231 (while (re-search-forward re end t)
14232 (setq level (- (match-end 1) (match-beginning 1)))
14233 (if (and (>= level lmin) (<= level lmax))
14234 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14235 (when (= cnt 0) (error "Heading not found on level %d: %s"
14236 lmax heading))
14237 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14238 lmax heading))
14239 (goto-char found)
14240 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14241 (setq end (save-excursion (org-end-of-subtree t t))))
14242 (when (org-on-heading-p)
14243 (move-marker (make-marker) (point))))))))
14245 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14246 "Find node HEADING in BUFFER.
14247 Return a marker to the heading if it was found, or nil if not.
14248 If POS-ONLY is set, return just the position instead of a marker.
14250 The heading text must match exact, but it may have a TODO keyword,
14251 a priority cookie and tags in the standard locations."
14252 (with-current-buffer (or buffer (current-buffer))
14253 (save-excursion
14254 (save-restriction
14255 (widen)
14256 (goto-char (point-min))
14257 (let (case-fold-search)
14258 (if (re-search-forward
14259 (format org-complex-heading-regexp-format
14260 (regexp-quote heading)) nil t)
14261 (if pos-only
14262 (match-beginning 0)
14263 (move-marker (make-marker) (match-beginning 0)))))))))
14265 (defun org-find-exact-heading-in-directory (heading &optional dir)
14266 "Find Org node headline HEADING in all .org files in directory DIR.
14267 When the target headline is found, return a marker to this location."
14268 (let ((files (directory-files (or dir default-directory)
14270 file visiting m buffer)
14271 (catch 'found
14272 (while (setq file (pop files))
14273 (message "trying %s" file)
14274 (setq visiting (org-find-base-buffer-visiting file))
14275 (setq buffer (or visiting (find-file-noselect file)))
14276 (setq m (org-find-exact-headline-in-buffer
14277 heading buffer))
14278 (when (and (not m) (not visiting)) (kill-buffer buffer))
14279 (and m (throw 'found m))))))
14281 (defun org-find-entry-with-id (ident)
14282 "Locate the entry that contains the ID property with exact value IDENT.
14283 IDENT can be a string, a symbol or a number, this function will search for
14284 the string representation of it.
14285 Return the position where this entry starts, or nil if there is no such entry."
14286 (interactive "sID: ")
14287 (let ((id (cond
14288 ((stringp ident) ident)
14289 ((symbol-name ident) (symbol-name ident))
14290 ((numberp ident) (number-to-string ident))
14291 (t (error "IDENT %s must be a string, symbol or number" ident))))
14292 (case-fold-search nil))
14293 (save-excursion
14294 (save-restriction
14295 (widen)
14296 (goto-char (point-min))
14297 (when (re-search-forward
14299 nil t)
14300 (org-back-to-heading t)
14301 (point))))))
14303 ;;;; Timestamps
14305 (defvar org-last-changed-timestamp nil)
14306 (defvar org-last-inserted-timestamp nil
14307 "The last time stamp inserted with `org-insert-time-stamp'.")
14308 (defvar org-time-was-given) ; dynamically scoped parameter
14309 (defvar org-end-time-was-given) ; dynamically scoped parameter
14310 (defvar org-ts-what) ; dynamically scoped parameter
14312 (defun org-time-stamp (arg &optional inactive)
14313 "Prompt for a date/time and insert a time stamp.
14314 If the user specifies a time like HH:MM, or if this command is called
14315 with a prefix argument, the time stamp will contain date and time.
14316 Otherwise, only the date will be included. All parts of a date not
14317 specified by the user will be filled in from the current date/time.
14318 So if you press just return without typing anything, the time stamp
14319 will represent the current date/time. If there is already a timestamp
14320 at the cursor, it will be modified."
14321 (interactive "P")
14322 (let* ((ts nil)
14323 (default-time
14324 ;; Default time is either today, or, when entering a range,
14325 ;; the range start.
14326 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14327 (save-excursion
14328 (re-search-backward
14330 (- (point) 20) t)))
14331 (apply 'encode-time (org-parse-time-string (match-string 1)))
14332 (current-time)))
14333 (default-input (and ts (org-get-compact-tod ts)))
14334 org-time-was-given org-end-time-was-given time)
14335 (cond
14336 ((and (org-at-timestamp-p t)
14337 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14338 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14339 (insert "--")
14340 (setq time (let ((this-command this-command))
14341 (org-read-date arg 'totime nil nil
14342 default-time default-input)))
14343 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14344 ((org-at-timestamp-p t)
14345 (setq time (let ((this-command this-command))
14346 (org-read-date arg 'totime nil nil default-time default-input)))
14347 (when (org-at-timestamp-p t) ; just to get the match data
14348 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14349 (replace-match "")
14350 (setq org-last-changed-timestamp
14351 (org-insert-time-stamp
14352 time (or org-time-was-given arg)
14353 inactive nil nil (list org-end-time-was-given))))
14354 (message "Timestamp updated"))
14355 (t
14356 (setq time (let ((this-command this-command))
14357 (org-read-date arg 'totime nil nil default-time default-input)))
14358 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14359 nil nil (list org-end-time-was-given))))))
14361 ;; FIXME: can we use this for something else, like computing time differences?
14362 (defun org-get-compact-tod (s)
14363 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14364 (let* ((t1 (match-string 1 s))
14365 (h1 (string-to-number (match-string 2 s)))
14366 (m1 (string-to-number (match-string 3 s)))
14367 (t2 (and (match-end 4) (match-string 5 s)))
14368 (h2 (and t2 (string-to-number (match-string 6 s))))
14369 (m2 (and t2 (string-to-number (match-string 7 s))))
14370 dh dm)
14371 (if (not t2)
14372 t1
14373 (setq dh (- h2 h1) dm (- m2 m1))
14374 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14375 (concat t1 "+" (number-to-string dh)
14376 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14378 (defun org-time-stamp-inactive (&optional arg)
14379 "Insert an inactive time stamp.
14380 An inactive time stamp is enclosed in square brackets instead of angle
14381 brackets. It is inactive in the sense that it does not trigger agenda entries,
14382 does not link to the calendar and cannot be changed with the S-cursor keys.
14383 So these are more for recording a certain time/date."
14384 (interactive "P")
14385 (org-time-stamp arg 'inactive))
14387 (defvar org-date-ovl (make-overlay 1 1))
14388 (overlay-put org-date-ovl 'face 'org-warning)
14389 (org-detach-overlay org-date-ovl)
14391 (defvar org-ans1) ; dynamically scoped parameter
14392 (defvar org-ans2) ; dynamically scoped parameter
14394 (defvar org-plain-time-of-day-regexp) ; defined below
14396 (defvar org-overriding-default-time nil) ; dynamically scoped
14397 (defvar org-read-date-overlay nil)
14398 (defvar org-dcst nil) ; dynamically scoped
14399 (defvar org-read-date-history nil)
14400 (defvar org-read-date-final-answer nil)
14401 (defvar org-read-date-analyze-futurep nil)
14402 (defvar org-read-date-analyze-forced-year nil)
14404 (defun org-read-date (&optional with-time to-time from-string prompt
14405 default-time default-input)
14406 "Read a date, possibly a time, and make things smooth for the user.
14407 The prompt will suggest to enter an ISO date, but you can also enter anything
14408 which will at least partially be understood by `parse-time-string'.
14409 Unrecognized parts of the date will default to the current day, month, year,
14410 hour and minute. If this command is called to replace a timestamp at point,
14411 of to enter the second timestamp of a range, the default time is taken
14412 from the existing stamp. Furthermore, the command prefers the future,
14413 so if you are giving a date where the year is not given, and the day-month
14414 combination is already past in the current year, it will assume you
14415 mean next year. For details, see the manual. A few examples:
14417 3-2-5 --> 2003-02-05
14418 feb 15 --> currentyear-02-15
14419 2/15 --> currentyear-02-15
14420 sep 12 9 --> 2009-09-12
14421 12:45 --> today 12:45
14422 22 sept 0:34 --> currentyear-09-22 0:34
14423 12 --> currentyear-currentmonth-12
14424 Fri --> nearest Friday (today or later)
14425 etc.
14427 Furthermore you can specify a relative date by giving, as the *first* thing
14428 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14429 change in days weeks, months, years.
14430 With a single plus or minus, the date is relative to today. With a double
14431 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14432 +4d --> four days from today
14433 +4 --> same as above
14434 +2w --> two weeks from today
14435 ++5 --> five days from default date
14437 The function understands only English month and weekday abbreviations,
14438 but this can be configured with the variables `parse-time-months' and
14439 `parse-time-weekdays'.
14441 While prompting, a calendar is popped up - you can also select the
14442 date with the mouse (button 1). The calendar shows a period of three
14443 months. To scroll it to other months, use the keys `>' and `<'.
14444 If you don't like the calendar, turn it off with
14445 \(setq org-read-date-popup-calendar nil)
14447 With optional argument TO-TIME, the date will immediately be converted
14448 to an internal time.
14449 With an optional argument WITH-TIME, the prompt will suggest to also
14450 insert a time. Note that when WITH-TIME is not set, you can still
14451 enter a time, and this function will inform the calling routine about
14452 this change. The calling routine may then choose to change the format
14453 used to insert the time stamp into the buffer to include the time.
14454 With optional argument FROM-STRING, read from this string instead from
14455 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14456 the time/date that is used for everything that is not specified by the
14457 user."
14458 (require 'parse-time)
14459 (let* ((org-time-stamp-rounding-minutes
14460 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14461 (org-dcst org-display-custom-times)
14462 (ct (org-current-time))
14463 (def (or org-overriding-default-time default-time ct))
14464 (defdecode (decode-time def))
14465 (dummy (progn
14466 (when (< (nth 2 defdecode) org-extend-today-until)
14467 (setcar (nthcdr 2 defdecode) -1)
14468 (setcar (nthcdr 1 defdecode) 59)
14469 (setq def (apply 'encode-time defdecode)
14470 defdecode (decode-time def)))))
14471 (calendar-frame-setup nil)
14472 (calendar-setup nil)
14473 (calendar-move-hook nil)
14474 (calendar-view-diary-initially-flag nil)
14475 (calendar-view-holidays-initially-flag nil)
14476 (timestr (format-time-string
14477 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14478 (prompt (concat (if prompt (concat prompt " ") "")
14479 (format "Date+time [%s]: " timestr)))
14480 ans (org-ans0 "") org-ans1 org-ans2 final)
14482 (cond
14483 (from-string (setq ans from-string))
14484 (org-read-date-popup-calendar
14485 (save-excursion
14486 (save-window-excursion
14487 (calendar)
14488 (unwind-protect
14489 (progn
14490 (calendar-forward-day (- (time-to-days def)
14491 (calendar-absolute-from-gregorian
14492 (calendar-current-date))))
14493 (org-eval-in-calendar nil t)
14494 (let* ((old-map (current-local-map))
14495 (map (copy-keymap calendar-mode-map))
14496 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14497 (org-defkey map (kbd "RET") 'org-calendar-select)
14498 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14499 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14500 (org-defkey minibuffer-local-map [(meta shift left)]
14501 (lambda () (interactive)
14502 (org-eval-in-calendar '(calendar-backward-month 1))))
14503 (org-defkey minibuffer-local-map [(meta shift right)]
14504 (lambda () (interactive)
14505 (org-eval-in-calendar '(calendar-forward-month 1))))
14506 (org-defkey minibuffer-local-map [(meta shift up)]
14507 (lambda () (interactive)
14508 (org-eval-in-calendar '(calendar-backward-year 1))))
14509 (org-defkey minibuffer-local-map [(meta shift down)]
14510 (lambda () (interactive)
14511 (org-eval-in-calendar '(calendar-forward-year 1))))
14512 (org-defkey minibuffer-local-map [?\e (shift left)]
14513 (lambda () (interactive)
14514 (org-eval-in-calendar '(calendar-backward-month 1))))
14515 (org-defkey minibuffer-local-map [?\e (shift right)]
14516 (lambda () (interactive)
14517 (org-eval-in-calendar '(calendar-forward-month 1))))
14518 (org-defkey minibuffer-local-map [?\e (shift up)]
14519 (lambda () (interactive)
14520 (org-eval-in-calendar '(calendar-backward-year 1))))
14521 (org-defkey minibuffer-local-map [?\e (shift down)]
14522 (lambda () (interactive)
14523 (org-eval-in-calendar '(calendar-forward-year 1))))
14524 (org-defkey minibuffer-local-map [(shift up)]
14525 (lambda () (interactive)
14526 (org-eval-in-calendar '(calendar-backward-week 1))))
14527 (org-defkey minibuffer-local-map [(shift down)]
14528 (lambda () (interactive)
14529 (org-eval-in-calendar '(calendar-forward-week 1))))
14530 (org-defkey minibuffer-local-map [(shift left)]
14531 (lambda () (interactive)
14532 (org-eval-in-calendar '(calendar-backward-day 1))))
14533 (org-defkey minibuffer-local-map [(shift right)]
14534 (lambda () (interactive)
14535 (org-eval-in-calendar '(calendar-forward-day 1))))
14536 (org-defkey minibuffer-local-map ">"
14537 (lambda () (interactive)
14538 (org-eval-in-calendar '(scroll-calendar-left 1))))
14539 (org-defkey minibuffer-local-map "<"
14540 (lambda () (interactive)
14541 (org-eval-in-calendar '(scroll-calendar-right 1))))
14542 (org-defkey minibuffer-local-map "\C-v"
14543 (lambda () (interactive)
14544 (org-eval-in-calendar
14545 '(calendar-scroll-left-three-months 1))))
14546 (org-defkey minibuffer-local-map "\M-v"
14547 (lambda () (interactive)
14548 (org-eval-in-calendar
14549 '(calendar-scroll-right-three-months 1))))
14550 (run-hooks 'org-read-date-minibuffer-setup-hook)
14551 (unwind-protect
14552 (progn
14553 (use-local-map map)
14554 (add-hook 'post-command-hook 'org-read-date-display)
14555 (setq org-ans0 (read-string prompt default-input
14556 'org-read-date-history nil))
14557 ;; org-ans0: from prompt
14558 ;; org-ans1: from mouse click
14559 ;; org-ans2: from calendar motion
14560 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
14561 (remove-hook 'post-command-hook 'org-read-date-display)
14562 (use-local-map old-map)
14563 (when org-read-date-overlay
14564 (delete-overlay org-read-date-overlay)
14565 (setq org-read-date-overlay nil)))))
14566 (bury-buffer "*Calendar*")))))
14568 (t ; Naked prompt only
14569 (unwind-protect
14570 (setq ans (read-string prompt default-input
14571 'org-read-date-history timestr))
14572 (when org-read-date-overlay
14573 (delete-overlay org-read-date-overlay)
14574 (setq org-read-date-overlay nil)))))
14576 (setq final (org-read-date-analyze ans def defdecode))
14578 (when org-read-date-analyze-forced-year
14579 (message "Year was forced into %s"
14580 (if org-read-date-force-compatible-dates
14581 "compatible range (1970-2037)"
14582 "range representable on this machine"))
14583 (ding))
14585 ;; One round trip to get rid of 34th of August and stuff like that....
14586 (setq final (decode-time (apply 'encode-time final)))
14588 (setq org-read-date-final-answer ans)
14590 (if to-time
14591 (apply 'encode-time final)
14592 (if (and (boundp 'org-time-was-given) org-time-was-given)
14593 (format "%04d-%02d-%02d %02d:%02d"
14594 (nth 5 final) (nth 4 final) (nth 3 final)
14595 (nth 2 final) (nth 1 final))
14596 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
14598 (defvar def)
14599 (defvar defdecode)
14600 (defvar with-time)
14601 (defun org-read-date-display ()
14602 "Display the current date prompt interpretation in the minibuffer."
14603 (when org-read-date-display-live
14604 (when org-read-date-overlay
14605 (delete-overlay org-read-date-overlay))
14606 (let ((p (point)))
14607 (end-of-line 1)
14608 (while (not (equal (buffer-substring
14609 (max (point-min) (- (point) 4)) (point))
14610 " "))
14611 (insert " "))
14612 (goto-char p))
14613 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
14614 " " (or org-ans1 org-ans2)))
14615 (org-end-time-was-given nil)
14616 (f (org-read-date-analyze ans def defdecode))
14617 (fmts (if org-dcst
14618 org-time-stamp-custom-formats
14619 org-time-stamp-formats))
14620 (fmt (if (or with-time
14621 (and (boundp 'org-time-was-given) org-time-was-given))
14622 (cdr fmts)
14623 (car fmts)))
14624 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
14625 (when (and org-end-time-was-given
14626 (string-match org-plain-time-of-day-regexp txt))
14627 (setq txt (concat (substring txt 0 (match-end 0)) "-"
14628 org-end-time-was-given
14629 (substring txt (match-end 0)))))
14630 (when org-read-date-analyze-futurep
14631 (setq txt (concat txt " (=>F)")))
14632 (setq org-read-date-overlay
14633 (make-overlay (1- (point-at-eol)) (point-at-eol)))
14634 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
14636 (defun org-read-date-analyze (ans def defdecode)
14637 "Analyze the combined answer of the date prompt."
14638 ;; FIXME: cleanup and comment
14639 (let ((nowdecode (decode-time (current-time)))
14640 delta deltan deltaw deltadef year month day
14641 hour minute second wday pm h2 m2 tl wday1
14642 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
14643 (setq org-read-date-analyze-futurep nil
14644 org-read-date-analyze-forced-year nil)
14646 (setq ans "+0"))
14648 (when (setq delta (org-read-date-get-relative ans (current-time) def))
14649 (setq ans (replace-match "" t t ans)
14650 deltan (car delta)
14651 deltaw (nth 1 delta)
14652 deltadef (nth 2 delta)))
14654 ;; Check if there is an iso week date in there
14655 ;; If yes, store the info and postpone interpreting it until the rest
14656 ;; of the parsing is done
14657 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
14658 (setq iso-year (if (match-end 1)
14659 (org-small-year-to-year
14660 (string-to-number (match-string 1 ans))))
14661 iso-weekday (if (match-end 3)
14662 (string-to-number (match-string 3 ans)))
14663 iso-week (string-to-number (match-string 2 ans)))
14664 (setq ans (replace-match "" t t ans)))
14666 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
14667 (when (string-match
14669 (setq year (if (match-end 2)
14670 (string-to-number (match-string 2 ans))
14671 (progn (setq kill-year t)
14672 (string-to-number (format-time-string "%Y"))))
14673 month (string-to-number (match-string 3 ans))
14674 day (string-to-number (match-string 4 ans)))
14675 (if (< year 100) (setq year (+ 2000 year)))
14677 t nil ans)))
14679 ;; Help matching dottet european dates
14680 (when (string-match
14681 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
14682 (setq year (if (match-end 3)
14683 (string-to-number (match-string 3 ans))
14684 (progn (setq kill-year t)
14685 (string-to-number (format-time-string "%Y"))))
14686 day (string-to-number (match-string 1 ans))
14687 month (string-to-number (match-string 2 ans))
14689 t nil ans)))
14691 ;; Help matching american dates, like 5/30 or 5/30/7
14692 (when (string-match
14693 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
14694 (setq year (if (match-end 4)
14695 (string-to-number (match-string 4 ans))
14696 (progn (setq kill-year t)
14697 (string-to-number (format-time-string "%Y"))))
14698 month (string-to-number (match-string 1 ans))
14699 day (string-to-number (match-string 2 ans)))
14700 (if (< year 100) (setq year (+ 2000 year)))
14702 t nil ans)))
14703 ;; Help matching am/pm times, because `parse-time-string' does not do that.
14704 ;; If there is a time with am/pm, and *no* time without it, we convert
14705 ;; so that matching will be successful.
14706 (loop for i from 1 to 2 do ; twice, for end time as well
14709 (setq hour (string-to-number (match-string 1 ans))
14710 minute (if (match-end 3)
14711 (string-to-number (match-string 3 ans))
14712 0)
14713 pm (equal ?p
14714 (string-to-char (downcase (match-string 4 ans)))))
14715 (if (and (= hour 12) (not pm))
14716 (setq hour 0)
14717 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
14718 (setq ans (replace-match (format "%02d:%02d" hour minute)
14719 t t ans))))
14721 ;; Check if a time range is given as a duration
14722 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
14723 (setq hour (string-to-number (match-string 1 ans))
14724 h2 (+ hour (string-to-number (match-string 3 ans)))
14725 minute (string-to-number (match-string 2 ans))
14726 m2 (+ minute (if (match-end 5) (string-to-number
14727 (match-string 5 ans))0)))
14728 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
14729 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
14730 t t ans)))
14732 ;; Check if there is a time range
14733 (when (boundp 'org-end-time-was-given)
14734 (setq org-time-was-given nil)
14735 (when (and (string-match org-plain-time-of-day-regexp ans)
14736 (match-end 8))
14737 (setq org-end-time-was-given (match-string 8 ans))
14738 (setq ans (concat (substring ans 0 (match-beginning 7))
14739 (substring ans (match-end 7))))))
14741 (setq tl (parse-time-string ans)
14742 day (or (nth 3 tl) (nth 3 defdecode))
14743 month (or (nth 4 tl)
14744 (if (and org-read-date-prefer-future
14745 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
14746 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
14747 (nth 4 defdecode)))
14748 year (or (and (not kill-year) (nth 5 tl))
14749 (if (and org-read-date-prefer-future
14750 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
14751 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
14752 (nth 5 defdecode)))
14753 hour (or (nth 2 tl) (nth 2 defdecode))
14754 minute (or (nth 1 tl) (nth 1 defdecode))
14755 second (or (nth 0 tl) 0)
14756 wday (nth 6 tl))
14758 (when (and (eq org-read-date-prefer-future 'time)
14759 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
14760 (equal day (nth 3 nowdecode))
14761 (equal month (nth 4 nowdecode))
14762 (equal year (nth 5 nowdecode))
14763 (nth 2 tl)
14764 (or (< (nth 2 tl) (nth 2 nowdecode))
14765 (and (= (nth 2 tl) (nth 2 nowdecode))
14766 (nth 1 tl)
14767 (< (nth 1 tl) (nth 1 nowdecode)))))
14768 (setq day (1+ day)
14769 futurep t))
14771 ;; Special date definitions below
14772 (cond
14773 (iso-week
14774 ;; There was an iso week
14775 (require 'cal-iso)
14776 (setq futurep nil)
14777 (setq year (or iso-year year)
14778 day (or iso-weekday wday 1)
14779 wday nil ; to make sure that the trigger below does not match
14780 iso-date (calendar-gregorian-from-absolute
14781 (calendar-absolute-from-iso
14782 (list iso-week day year))))
14783 ; FIXME: Should we also push ISO weeks into the future?
14784 ; (when (and org-read-date-prefer-future
14785 ; (not iso-year)
14786 ; (< (calendar-absolute-from-gregorian iso-date)
14787 ; (time-to-days (current-time))))
14788 ; (setq year (1+ year)
14789 ; iso-date (calendar-gregorian-from-absolute
14790 ; (calendar-absolute-from-iso
14791 ; (list iso-week day year)))))
14792 (setq month (car iso-date)
14793 year (nth 2 iso-date)
14794 day (nth 1 iso-date)))
14795 (deltan
14796 (setq futurep nil)
14797 (unless deltadef
14798 (let ((now (decode-time (current-time))))
14799 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
14800 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
14801 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
14802 ((equal deltaw "m") (setq month (+ month deltan)))
14803 ((equal deltaw "y") (setq year (+ year deltan)))))
14804 ((and wday (not (nth 3 tl)))
14805 (setq futurep nil)
14806 ;; Weekday was given, but no day, so pick that day in the week
14807 ;; on or after the derived date.
14808 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
14809 (unless (equal wday wday1)
14810 (setq day (+ day (% (- wday wday1 -7) 7))))))
14811 (if (and (boundp 'org-time-was-given)
14812 (nth 2 tl))
14813 (setq org-time-was-given t))
14814 (if (< year 100) (setq year (+ 2000 year)))
14815 ;; Check of the date is representable
14816 (if org-read-date-force-compatible-dates
14817 (progn
14818 (if (< year 1970)
14819 (setq year 1970 org-read-date-analyze-forced-year t))
14820 (if (> year 2037)
14821 (setq year 2037 org-read-date-analyze-forced-year t)))
14822 (condition-case nil
14823 (encode-time second minute hour day month year)
14824 (error
14825 (setq year (nth 5 defdecode))
14826 (setq org-read-date-analyze-forced-year t))))
14827 (setq org-read-date-analyze-futurep futurep)
14828 (list second minute hour day month year)))
14830 (defvar parse-time-weekdays)
14832 (defun org-read-date-get-relative (s today default)
14833 "Check string S for special relative date string.
14834 TODAY and DEFAULT are internal times, for today and for a default.
14835 Return shift list (N what def-flag)
14837 N is the number of WHATs to shift.
14838 DEF-FLAG is t when a double ++ or -- indicates shift relative to
14839 the DEFAULT date rather than TODAY."
14840 (when (and
14841 (string-match
14842 (concat
14847 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
14848 (let* ((dir (if (> (match-end 1) (match-beginning 1))
14849 (string-to-char (substring (match-string 1 s) -1))
14850 ?+))
14851 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
14852 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
14853 (what (if (match-end 3) (match-string 3 s) "d"))
14854 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
14855 (date (if rel default today))
14856 (wday (nth 6 (decode-time date)))
14857 delta)
14858 (if wday1
14859 (progn
14860 (setq delta (mod (+ 7 (- wday1 wday)) 7))
14861 (if (= dir ?-) (setq delta (- delta 7)))
14862 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
14863 (list delta "d" rel))
14864 (list (* n (if (= dir ?-) -1 1)) what rel)))))
14866 (defun org-order-calendar-date-args (arg1 arg2 arg3)
14867 "Turn a user-specified date into the internal representation.
14868 The internal representation needed by the calendar is (month day year).
14869 This is a wrapper to handle the brain-dead convention in calendar that
14870 user function argument order change dependent on argument order."
14871 (if (boundp 'calendar-date-style)
14872 (cond
14873 ((eq calendar-date-style 'american)
14874 (list arg1 arg2 arg3))
14875 ((eq calendar-date-style 'european)
14876 (list arg2 arg1 arg3))
14877 ((eq calendar-date-style 'iso)
14878 (list arg2 arg3 arg1)))
14879 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
14880 (if (org-bound-and-true-p european-calendar-style)
14881 (list arg2 arg1 arg3)
14882 (list arg1 arg2 arg3)))))
14884 (defun org-eval-in-calendar (form &optional keepdate)
14885 "Eval FORM in the calendar window and return to current window.
14886 Also, store the cursor date in variable org-ans2."
14887 (let ((sf (selected-frame))
14888 (sw (selected-window)))
14889 (select-window (get-buffer-window "*Calendar*" t))
14890 (eval form)
14891 (when (and (not keepdate) (calendar-cursor-to-date))
14892 (let* ((date (calendar-cursor-to-date))
14893 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14894 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
14895 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
14896 (select-window sw)
14897 (org-select-frame-set-input-focus sf)))
14899 (defun org-calendar-select ()
14900 "Return to `org-read-date' with the date currently selected.
14901 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
14902 (interactive)
14903 (when (calendar-cursor-to-date)
14904 (let* ((date (calendar-cursor-to-date))
14905 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
14906 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
14907 (if (active-minibuffer-window) (exit-minibuffer))))
14909 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
14910 "Insert a date stamp for the date given by the internal TIME.
14911 WITH-HM means use the stamp format that includes the time of the day.
14912 INACTIVE means use square brackets instead of angular ones, so that the
14913 stamp will not contribute to the agenda.
14914 PRE and POST are optional strings to be inserted before and after the
14915 stamp.
14916 The command returns the inserted time stamp."
14917 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
14918 stamp)
14919 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
14920 (insert-before-markers (or pre ""))
14921 (when (listp extra)
14922 (setq extra (car extra))
14923 (if (and (stringp extra)
14925 (setq extra (format "-%02d:%02d"
14926 (string-to-number (match-string 1 extra))
14927 (string-to-number (match-string 2 extra))))
14928 (setq extra nil)))
14929 (when extra
14930 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
14931 (insert-before-markers (setq stamp (format-time-string fmt time)))
14932 (insert-before-markers (or post ""))
14933 (setq org-last-inserted-timestamp stamp)))
14935 (defun org-toggle-time-stamp-overlays ()
14936 "Toggle the use of custom time stamp formats."
14937 (interactive)
14938 (setq org-display-custom-times (not org-display-custom-times))
14939 (unless org-display-custom-times
14940 (let ((p (point-min)) (bmp (buffer-modified-p)))
14941 (while (setq p (next-single-property-change p 'display))
14942 (if (and (get-text-property p 'display)
14943 (eq (get-text-property p 'face) 'org-date))
14944 (remove-text-properties
14945 p (setq p (next-single-property-change p 'display))
14946 '(display t))))
14947 (set-buffer-modified-p bmp)))
14948 (if (featurep 'xemacs)
14949 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
14950 (org-restart-font-lock)
14951 (setq org-table-may-need-update t)
14952 (if org-display-custom-times
14953 (message "Time stamps are overlayed with custom format")
14954 (message "Time stamp overlays removed")))
14956 (defun org-display-custom-time (beg end)
14957 "Overlay modified time stamp format over timestamp between BEG and END."
14958 (let* ((ts (buffer-substring beg end))
14959 t1 w1 with-hm tf time str w2 (off 0))
14960 (save-match-data
14961 (setq t1 (org-parse-time-string ts t))
14962 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
14963 (setq off (- (match-end 0) (match-beginning 0)))))
14964 (setq end (- end off))
14965 (setq w1 (- end beg)
14966 with-hm (and (nth 1 t1) (nth 2 t1))
14967 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
14968 time (org-fix-decoded-time t1)
14969 str (org-add-props
14970 (format-time-string
14971 (substring tf 1 -1) (apply 'encode-time time))
14972 nil 'mouse-face 'highlight)
14973 w2 (length str))
14974 (if (not (= w2 w1))
14975 (add-text-properties (1+ beg) (+ 2 beg)
14976 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
14977 (if (featurep 'xemacs)
14978 (progn
14979 (put-text-property beg end 'invisible t)
14980 (put-text-property beg end 'end-glyph (make-glyph str)))
14981 (put-text-property beg end 'display str))))
14983 (defun org-translate-time (string)
14984 "Translate all timestamps in STRING to custom format.
14985 But do this only if the variable `org-display-custom-times' is set."
14986 (when org-display-custom-times
14987 (save-match-data
14988 (let* ((start 0)
14989 (re org-ts-regexp-both)
14990 t1 with-hm inactive tf time str beg end)
14991 (while (setq start (string-match re string start))
14992 (setq beg (match-beginning 0)
14993 end (match-end 0)
14994 t1 (save-match-data
14995 (org-parse-time-string (substring string beg end) t))
14996 with-hm (and (nth 1 t1) (nth 2 t1))
14997 inactive (equal (substring string beg (1+ beg)) "[")
14998 tf (funcall (if with-hm 'cdr 'car)
14999 org-time-stamp-custom-formats)
15000 time (org-fix-decoded-time t1)
15001 str (format-time-string
15002 (concat
15003 (if inactive "[" "<") (substring tf 1 -1)
15004 (if inactive "]" ">"))
15005 (apply 'encode-time time))
15006 string (replace-match str t t string)
15007 start (+ start (length str)))))))
15008 string)
15010 (defun org-fix-decoded-time (time)
15011 "Set 0 instead of nil for the first 6 elements of time.
15012 Don't touch the rest."
15013 (let ((n 0))
15014 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15016 (defun org-days-to-time (timestamp-string)
15017 "Difference between TIMESTAMP-STRING and now in days."
15018 (- (time-to-days (org-time-string-to-time timestamp-string))
15019 (time-to-days (current-time))))
15021 (defun org-deadline-close (timestamp-string &optional ndays)
15022 "Is the time in TIMESTAMP-STRING close to the current date?"
15023 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15024 (and (< (org-days-to-time timestamp-string) ndays)
15025 (not (org-entry-is-done-p))))
15027 (defun org-get-wdays (ts)
15028 "Get the deadline lead time appropriate for timestring TS."
15029 (cond
15030 ((<= org-deadline-warning-days 0)
15031 ;; 0 or negative, enforce this value no matter what
15032 (- org-deadline-warning-days))
15034 ;; lead time is specified.
15035 (floor (* (string-to-number (match-string 1 ts))
15036 (cdr (assoc (match-string 2 ts)
15037 '(("d" . 1) ("w" . 7)
15038 ("m" . 30.4) ("y" . 365.25)))))))
15039 ;; go for the default.
15040 (t org-deadline-warning-days)))
15042 (defun org-calendar-select-mouse (ev)
15043 "Return to `org-read-date' with the date currently selected.
15044 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15045 (interactive "e")
15046 (mouse-set-point ev)
15047 (when (calendar-cursor-to-date)
15048 (let* ((date (calendar-cursor-to-date))
15049 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15050 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15051 (if (active-minibuffer-window) (exit-minibuffer))))
15053 (defun org-check-deadlines (ndays)
15054 "Check if there are any deadlines due or past due.
15055 A deadline is considered due if it happens within `org-deadline-warning-days'
15056 days from today's date. If the deadline appears in an entry marked DONE,
15057 it is not shown. The prefix arg NDAYS can be used to test that many
15059 (interactive "P")
15060 (let* ((org-warn-days
15061 (cond
15062 ((equal ndays '(4)) 100000)
15063 (ndays (prefix-numeric-value ndays))
15064 (t (abs org-deadline-warning-days))))
15065 (case-fold-search nil)
15067 (callback
15068 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15070 (message "%d deadlines past-due or due within %d days"
15071 (org-occur regexp nil callback)
15072 org-warn-days)))
15074 (defun org-check-before-date (date)
15075 "Check if there are deadlines or scheduled entries before DATE."
15076 (interactive (list (org-read-date)))
15077 (let ((case-fold-search nil)
15081 (callback
15082 (lambda () (time-less-p
15083 (org-time-string-to-time (match-string 2))
15084 (org-time-string-to-time date)))))
15085 (message "%d entries before %s"
15086 (org-occur regexp nil callback) date)))
15088 (defun org-check-after-date (date)
15089 "Check if there are deadlines or scheduled entries after DATE."
15090 (interactive (list (org-read-date)))
15091 (let ((case-fold-search nil)
15095 (callback
15096 (lambda () (not
15097 (time-less-p
15098 (org-time-string-to-time (match-string 2))
15099 (org-time-string-to-time date))))))
15100 (message "%d entries after %s"
15101 (org-occur regexp nil callback) date)))
15103 (defun org-evaluate-time-range (&optional to-buffer)
15104 "Evaluate a time range by computing the difference between start and end.
15105 Normally the result is just printed in the echo area, but with prefix arg
15106 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15107 If the time range is actually in a table, the result is inserted into the
15108 next column.
15109 For time difference computation, a year is assumed to be exactly 365
15110 days in order to avoid rounding problems."
15111 (interactive "P")
15112 (or
15113 (org-clock-update-time-maybe)
15114 (save-excursion
15115 (unless (org-at-date-range-p t)
15116 (goto-char (point-at-bol))
15117 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15118 (if (not (org-at-date-range-p t))
15119 (error "Not at a time-stamp range, and none found in current line")))
15120 (let* ((ts1 (match-string 1))
15121 (ts2 (match-string 2))
15122 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15123 (match-end (match-end 0))
15124 (time1 (org-time-string-to-time ts1))
15125 (time2 (org-time-string-to-time ts2))
15126 (t1 (org-float-time time1))
15127 (t2 (org-float-time time2))
15128 (diff (abs (- t2 t1)))
15129 (negative (< (- t2 t1) 0))
15130 ;; (ys (floor (* 365 24 60 60)))
15131 (ds (* 24 60 60))
15132 (hs (* 60 60))
15133 (fy "%dy %dd %02d:%02d")
15134 (fy1 "%dy %dd")
15135 (fd "%dd %02d:%02d")
15136 (fd1 "%dd")
15137 (fh "%02d:%02d")
15138 y d h m align)
15139 (if havetime
15140 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15141 y 0
15142 d (floor (/ diff ds)) diff (mod diff ds)
15143 h (floor (/ diff hs)) diff (mod diff hs)
15144 m (floor (/ diff 60)))
15145 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15146 y 0
15147 d (floor (+ (/ diff ds) 0.5))
15148 h 0 m 0))
15149 (if (not to-buffer)
15150 (message "%s" (org-make-tdiff-string y d h m))
15151 (if (org-at-table-p)
15152 (progn
15153 (goto-char match-end)
15154 (setq align t)
15155 (and (looking-at " *|") (goto-char (match-end 0))))
15156 (goto-char match-end))
15157 (if (looking-at
15159 (replace-match ""))
15160 (if negative (insert " -"))
15161 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15162 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15163 (insert " " (format fh h m))))
15164 (if align (org-table-align))
15165 (message "Time difference inserted")))))
15167 (defun org-make-tdiff-string (y d h m)
15168 (let ((fmt "")
15169 (l nil))
15170 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15171 l (push y l)))
15172 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15173 l (push d l)))
15174 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15175 l (push h l)))
15176 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15177 l (push m l)))
15178 (apply 'format fmt (nreverse l))))
15180 (defun org-time-string-to-time (s)
15181 (apply 'encode-time (org-parse-time-string s)))
15182 (defun org-time-string-to-seconds (s)
15183 (org-float-time (org-time-string-to-time s)))
15185 (defun org-time-string-to-absolute (s &optional daynr prefer show-all)
15186 "Convert a time stamp to an absolute day number.
15187 If there is a specifier for a cyclic time stamp, get the closest date to
15188 DAYNR.
15189 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15190 The variable date is bound by the calendar when this is called."
15191 (cond
15193 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15194 daynr
15195 (+ daynr 1000)))
15197 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15198 (time-to-days (current-time))) (match-string 0 s)
15199 prefer show-all))
15200 (t (time-to-days (apply 'encode-time (org-parse-time-string s))))))
15202 (defun org-days-to-iso-week (days)
15203 "Return the iso week number."
15204 (require 'cal-iso)
15205 (car (calendar-iso-from-absolute days)))
15207 (defun org-small-year-to-year (year)
15208 "Convert 2-digit years into 4-digit years.
15209 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15210 The year 2000 cannot be abbreviated. Any year larger than 99
15211 is returned unchanged."
15212 (if (< year 38)
15213 (setq year (+ 2000 year))
15214 (if (< year 100)
15215 (setq year (+ 1900 year))))
15216 year)
15218 (defun org-time-from-absolute (d)
15219 "Return the time corresponding to date D.
15220 D may be an absolute day number, or a calendar-type list (month day year)."
15221 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15222 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15224 (defun org-calendar-holiday ()
15225 "List of holidays, for Diary display in Org-mode."
15226 (require 'holidays)
15227 (let ((hl (funcall
15228 (if (fboundp 'calendar-check-holidays)
15229 'calendar-check-holidays 'check-calendar-holidays) date)))
15230 (if hl (mapconcat 'identity hl "; "))))
15232 (defun org-diary-sexp-entry (sexp entry date)
15233 "Process a SEXP diary ENTRY for DATE."
15234 (require 'diary-lib)
15235 (let ((result (if calendar-debug-sexp
15236 (let ((stack-trace-on-error t))
15237 (eval (car (read-from-string sexp))))
15238 (condition-case nil
15239 (eval (car (read-from-string sexp)))
15240 (error
15241 (beep)
15242 (message "Bad sexp at line %d in %s: %s"
15243 (org-current-line)
15244 (buffer-file-name) sexp)
15245 (sleep-for 2))))))
15246 (cond ((stringp result) (split-string result "; "))
15247 ((and (consp result)
15248 (not (consp (cdr result)))
15249 (stringp (cdr result))) (cdr result))
15250 ((and (consp result)
15251 (stringp (car result))) result)
15252 (result entry)
15253 (t nil))))
15255 (defun org-diary-to-ical-string (frombuf)
15256 "Get iCalendar entries from diary entries in buffer FROMBUF.
15257 This uses the icalendar.el library."
15258 (let* ((tmpdir (if (featurep 'xemacs)
15259 (temp-directory)
15260 temporary-file-directory))
15261 (tmpfile (make-temp-name
15262 (expand-file-name "orgics" tmpdir)))
15263 buf rtn b e)
15264 (with-current-buffer frombuf
15265 (icalendar-export-region (point-min) (point-max) tmpfile)
15266 (setq buf (find-buffer-visiting tmpfile))
15267 (set-buffer buf)
15268 (goto-char (point-min))
15269 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15270 (setq b (match-beginning 0)))
15271 (goto-char (point-max))
15272 (if (re-search-backward "^END:VEVENT" nil t)
15273 (setq e (match-end 0)))
15275 (kill-buffer buf)
15276 (delete-file tmpfile)
15277 rtn))
15279 (defun org-closest-date (start current change prefer show-all)
15280 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15281 When PREFER is `past', return a date that is either CURRENT or past.
15282 When PREFER is `future', return a date that is either CURRENT or future.
15283 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15284 ;; Make the proper lists from the dates
15285 (catch 'exit
15286 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15287 dn dw sday cday n1 n2 n0
15288 d m y y1 y2 date1 date2 nmonths nm ny m2)
15290 (setq start (org-date-to-gregorian start)
15291 current (org-date-to-gregorian
15292 (if show-all
15293 current
15294 (time-to-days (current-time))))
15295 sday (calendar-absolute-from-gregorian start)
15296 cday (calendar-absolute-from-gregorian current))
15298 (if (<= cday sday) (throw 'exit sday))
15301 (setq dn (string-to-number (match-string 1 change))
15302 dw (cdr (assoc (match-string 2 change) a1)))
15303 (error "Invalid change specifier: %s" change))
15304 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15305 (cond
15306 ((eq dw 'day)
15307 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15308 n2 (+ n1 dn)))
15309 ((eq dw 'year)
15310 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15311 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15312 (setq date1 (list m d y1)
15313 n1 (calendar-absolute-from-gregorian date1)
15314 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15315 n2 (calendar-absolute-from-gregorian date2)))
15316 ((eq dw 'month)
15317 ;; approx number of month between the two dates
15318 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15319 ;; How often does dn fit in there?
15320 (setq d (nth 1 start) m (car start) y (nth 2 start)
15321 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15322 m (+ m nm)
15323 ny (floor (/ m 12))
15324 y (+ y ny)
15325 m (- m (* ny 12)))
15326 (while (> m 12) (setq m (- m 12) y (1+ y)))
15327 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15328 (setq m2 (+ m dn) y2 y)
15329 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15330 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15331 (while (<= n2 cday)
15332 (setq n1 n2 m m2 y y2)
15333 (setq m2 (+ m dn) y2 y)
15334 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15335 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15336 ;; Make sure n1 is the earlier date
15337 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15338 (if show-all
15339 (cond
15340 ((eq prefer 'past) (if (= cday n2) n2 n1))
15341 ((eq prefer 'future) (if (= cday n1) n1 n2))
15342 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15343 (cond
15344 ((eq prefer 'past) (if (= cday n2) n2 n1))
15345 ((eq prefer 'future) (if (= cday n1) n1 n2))
15346 (t (if (= cday n1) n1 n2)))))))
15348 (defun org-date-to-gregorian (date)
15349 "Turn any specification of DATE into a Gregorian date for the calendar."
15350 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15351 ((and (listp date) (= (length date) 3)) date)
15352 ((stringp date)
15353 (setq date (org-parse-time-string date))
15354 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15355 ((listp date)
15356 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15358 (defun org-parse-time-string (s &optional nodefault)
15359 "Parse the standard Org-mode time string.
15360 This should be a lot faster than the normal `parse-time-string'.
15361 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15362 hour and minute fields will be nil if not given."
15363 (if (string-match org-ts-regexp0 s)
15364 (list 0
15365 (if (or (match-beginning 8) (not nodefault))
15366 (string-to-number (or (match-string 8 s) "0")))
15367 (if (or (match-beginning 7) (not nodefault))
15368 (string-to-number (or (match-string 7 s) "0")))
15369 (string-to-number (match-string 4 s))
15370 (string-to-number (match-string 3 s))
15371 (string-to-number (match-string 2 s))
15372 nil nil nil)
15373 (error "Not a standard Org-mode time string: %s" s)))
15375 (defun org-timestamp-up (&optional arg)
15376 "Increase the date item at the cursor by one.
15377 If the cursor is on the year, change the year. If it is on the month or
15378 the day, change that.
15379 With prefix ARG, change by that many units."
15380 (interactive "p")
15381 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15383 (defun org-timestamp-down (&optional arg)
15384 "Decrease the date item at the cursor by one.
15385 If the cursor is on the year, change the year. If it is on the month or
15386 the day, change that.
15387 With prefix ARG, change by that many units."
15388 (interactive "p")
15389 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15391 (defun org-timestamp-up-day (&optional arg)
15392 "Increase the date in the time stamp by one day.
15393 With prefix ARG, change that many days."
15394 (interactive "p")
15395 (if (and (not (org-at-timestamp-p t))
15396 (org-on-heading-p))
15397 (org-todo 'up)
15398 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15400 (defun org-timestamp-down-day (&optional arg)
15401 "Decrease the date in the time stamp by one day.
15402 With prefix ARG, change that many days."
15403 (interactive "p")
15404 (if (and (not (org-at-timestamp-p t))
15405 (org-on-heading-p))
15406 (org-todo 'down)
15407 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15409 (defun org-at-timestamp-p (&optional inactive-ok)
15410 "Determine if the cursor is in or at a timestamp."
15411 (interactive)
15412 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15413 (pos (point))
15414 (ans (or (looking-at tsr)
15415 (save-excursion
15417 (if (> (point) (point-min)) (backward-char 1))
15418 (and (looking-at tsr)
15419 (> (- (match-end 0) pos) -1))))))
15420 (and ans
15421 (boundp 'org-ts-what)
15422 (setq org-ts-what
15423 (cond
15424 ((= pos (match-beginning 0)) 'bracket)
15425 ((= pos (1- (match-end 0))) 'bracket)
15426 ((org-pos-in-match-range pos 2) 'year)
15427 ((org-pos-in-match-range pos 3) 'month)
15428 ((org-pos-in-match-range pos 7) 'hour)
15429 ((org-pos-in-match-range pos 8) 'minute)
15430 ((or (org-pos-in-match-range pos 4)
15431 (org-pos-in-match-range pos 5)) 'day)
15432 ((and (> pos (or (match-end 8) (match-end 5)))
15433 (< pos (match-end 0)))
15434 (- pos (or (match-end 8) (match-end 5))))
15435 (t 'day))))
15436 ans))
15438 (defun org-toggle-timestamp-type ()
15439 "Toggle the type (<active> or [inactive]) of a time stamp."
15440 (interactive)
15441 (when (org-at-timestamp-p t)
15442 (let ((beg (match-beginning 0)) (end (match-end 0))
15443 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15444 (save-excursion
15445 (goto-char beg)
15446 (while (re-search-forward "[][<>]" end t)
15447 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15448 t t)))
15449 (message "Timestamp is now %sactive"
15450 (if (equal (char-after beg) ?<) "" "in")))))
15452 (defun org-timestamp-change (n &optional what updown)
15453 "Change the date in the time stamp at point.
15454 The date will be changed by N times WHAT. WHAT can be `day', `month',
15455 `year', `minute', `second'. If WHAT is not given, the cursor position
15456 in the timestamp determines what will be changed."
15457 (let ((pos (point))
15458 with-hm inactive
15459 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15460 org-ts-what
15461 extra rem
15462 ts time time0)
15463 (if (not (org-at-timestamp-p t))
15464 (error "Not at a timestamp"))
15465 (if (and (not what) (eq org-ts-what 'bracket))
15466 (org-toggle-timestamp-type)
15467 (if (and (not what) (not (eq org-ts-what 'day))
15468 org-display-custom-times
15469 (get-text-property (point) 'display)
15470 (not (get-text-property (1- (point)) 'display)))
15471 (setq org-ts-what 'day))
15472 (setq org-ts-what (or what org-ts-what)
15473 inactive (= (char-after (match-beginning 0)) ?\[)
15474 ts (match-string 0))
15475 (replace-match "")
15476 (if (string-match
15478 ts)
15479 (setq extra (match-string 1 ts)))
15481 (setq with-hm t))
15482 (setq time0 (org-parse-time-string ts))
15483 (when (and updown
15484 (eq org-ts-what 'minute)
15485 (not current-prefix-arg))
15486 ;; This looks like s-up and s-down. Change by one rounding step.
15487 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15488 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15489 (setcar (cdr time0) (+ (nth 1 time0)
15490 (if (> n 0) (- rem) (- dm rem))))))
15491 (setq time
15492 (encode-time (or (car time0) 0)
15493 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15494 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15495 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15496 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15497 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15498 (nthcdr 6 time0)))
15499 (when (and (member org-ts-what '(hour minute))
15500 extra
15502 (setq extra (org-modify-ts-extra
15503 extra
15504 (if (eq org-ts-what 'hour) 2 5)
15505 n dm)))
15506 (when (integerp org-ts-what)
15507 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15508 (if (eq what 'calendar)
15509 (let ((cal-date (org-get-date-from-calendar)))
15510 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
15511 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
15512 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
15513 (setcar time0 (or (car time0) 0))
15514 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
15515 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
15516 (setq time (apply 'encode-time time0))))
15517 (setq org-last-changed-timestamp
15518 (org-insert-time-stamp time with-hm inactive nil nil extra))
15519 (org-clock-update-time-maybe)
15520 (goto-char pos)
15521 ;; Try to recenter the calendar window, if any
15522 (if (and org-calendar-follow-timestamp-change
15523 (get-buffer-window "*Calendar*" t)
15524 (memq org-ts-what '(day month year)))
15525 (org-recenter-calendar (time-to-days time))))))
15527 (defun org-modify-ts-extra (s pos n dm)
15528 "Change the different parts of the lead-time and repeat fields in timestamp."
15529 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
15530 ng h m new rem)
15531 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
15532 (cond
15533 ((or (org-pos-in-match-range pos 2)
15534 (org-pos-in-match-range pos 3))
15535 (setq m (string-to-number (match-string 3 s))
15536 h (string-to-number (match-string 2 s)))
15537 (if (org-pos-in-match-range pos 2)
15538 (setq h (+ h n))
15539 (setq n (* dm (org-no-warnings (signum n))))
15540 (when (not (= 0 (setq rem (% m dm))))
15541 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
15542 (setq m (+ m n)))
15543 (if (< m 0) (setq m (+ m 60) h (1- h)))
15544 (if (> m 59) (setq m (- m 60) h (1+ h)))
15545 (setq h (min 24 (max 0 h)))
15546 (setq ng 1 new (format "-%02d:%02d" h m)))
15547 ((org-pos-in-match-range pos 6)
15548 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
15549 ((org-pos-in-match-range pos 5)
15550 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
15552 ((org-pos-in-match-range pos 9)
15553 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
15554 ((org-pos-in-match-range pos 8)
15555 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
15557 (when ng
15558 (setq s (concat
15559 (substring s 0 (match-beginning ng))
15560 new
15561 (substring s (match-end ng))))))
15562 s))
15564 (defun org-recenter-calendar (date)
15565 "If the calendar is visible, recenter it to DATE."
15566 (let* ((win (selected-window))
15567 (cwin (get-buffer-window "*Calendar*" t))
15568 (calendar-move-hook nil))
15569 (when cwin
15570 (select-window cwin)
15571 (calendar-goto-date (if (listp date) date
15572 (calendar-gregorian-from-absolute date)))
15573 (select-window win))))
15575 (defun org-goto-calendar (&optional arg)
15576 "Go to the Emacs calendar at the current date.
15577 If there is a time stamp in the current line, go to that date.
15578 A prefix ARG can be used to force the current date."
15579 (interactive "P")
15580 (let ((tsr org-ts-regexp) diff
15581 (calendar-move-hook nil)
15582 (calendar-view-holidays-initially-flag nil)
15583 (calendar-view-diary-initially-flag nil))
15584 (if (or (org-at-timestamp-p)
15585 (save-excursion
15586 (beginning-of-line 1)
15587 (looking-at (concat ".*" tsr))))
15588 (let ((d1 (time-to-days (current-time)))
15589 (d2 (time-to-days
15590 (org-time-string-to-time (match-string 1)))))
15591 (setq diff (- d2 d1))))
15592 (calendar)
15593 (calendar-goto-today)
15594 (if (and diff (not arg)) (calendar-forward-day diff))))
15596 (defun org-get-date-from-calendar ()
15597 "Return a list (month day year) of date at point in calendar."
15598 (with-current-buffer "*Calendar*"
15599 (save-match-data
15600 (calendar-cursor-to-date))))
15602 (defun org-date-from-calendar ()
15603 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
15604 If there is already a time stamp at the cursor position, update it."
15605 (interactive)
15606 (if (org-at-timestamp-p t)
15607 (org-timestamp-change 0 'calendar)
15608 (let ((cal-date (org-get-date-from-calendar)))
15609 (org-insert-time-stamp
15610 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
15612 (defun org-minutes-to-hh:mm-string (m)
15613 "Compute H:MM from a number of minutes."
15614 (let ((h (/ m 60)))
15615 (setq m (- m (* 60 h)))
15616 (format org-time-clocksum-format h m)))
15618 (defun org-hh:mm-string-to-minutes (s)
15619 "Convert a string H:MM to a number of minutes.
15620 If the string is just a number, interpret it as minutes.
15621 In fact, the first hh:mm or number in the string will be taken,
15622 there can be extra stuff in the string.
15623 If no number is found, the return value is 0."
15624 (cond
15625 ((integerp s) s)
15627 (+ (* (string-to-number (match-string 1 s)) 60)
15628 (string-to-number (match-string 2 s))))
15630 (string-to-number (match-string 1 s)))
15631 (t 0)))
15633 (defcustom org-effort-durations
15634 `(("h" . 60)
15635 ("d" . ,(* 60 8))
15636 ("w" . ,(* 60 8 5))
15637 ("m" . ,(* 60 8 5 4))
15638 ("y" . ,(* 60 8 5 40)))
15639 "Conversion factor to minutes for an effort modifier.
15641 Each entry has the form (MODIFIER . MINUTES).
15643 In an effort string, a number followed by MODIFIER is multiplied
15644 by the specified number of MINUTES to obtain an effort in
15645 minutes.
15649 :group 'org-agenda
15650 :type '(alist :key-type (string :tag "Modifier")
15651 :value-type (number :tag "Minutes")))
15653 (defun org-duration-string-to-minutes (s)
15654 "Convert a duration string S to minutes.
15656 A bare number is interpreted as minutes, modifiers can be set by
15657 customizing `org-effort-durations' (which see).
15659 Entries containing a colon are interpreted as H:MM by
15660 `org-hh:mm-string-to-minutes'."
15661 (let ((result 0)
15663 (regexp-opt (mapcar 'car org-effort-durations))
15665 (while (string-match re s)
15666 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
15667 (string-to-number (match-string 1 s))))
15668 (setq s (replace-match "" nil t s)))
15669 (incf result (org-hh:mm-string-to-minutes s))
15670 result))
15672 ;;;; Files
15674 (defun org-save-all-org-buffers ()
15675 "Save all Org-mode buffers without user confirmation."
15676 (interactive)
15677 (message "Saving all Org-mode buffers...")
15678 (save-some-buffers t 'org-mode-p)
15679 (when (featurep 'org-id) (org-id-locations-save))
15680 (message "Saving all Org-mode buffers... done"))
15682 (defun org-revert-all-org-buffers ()
15683 "Revert all Org-mode buffers.
15684 Prompt for confirmation when there are unsaved changes.
15685 Be sure you know what you are doing before letting this function
15686 overwrite your changes.
15688 This function is useful in a setup where one tracks org files
15689 with a version control system, to revert on one machine after pulling
15690 changes from another. I believe the procedure must be like this:
15692 1. M-x org-save-all-org-buffers
15693 2. Pull changes from the other machine, resolve conflicts
15694 3. M-x org-revert-all-org-buffers"
15695 (interactive)
15696 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
15697 (error "Abort"))
15698 (save-excursion
15699 (save-window-excursion
15700 (mapc
15701 (lambda (b)
15702 (when (and (with-current-buffer b (org-mode-p))
15703 (with-current-buffer b buffer-file-name))
15704 (switch-to-buffer b)
15705 (revert-buffer t 'no-confirm)))
15706 (buffer-list))
15707 (when (and (featurep 'org-id) org-id-track-globally)
15708 (org-id-locations-load)))))
15710 ;;;; Agenda files
15712 ;;;###autoload
15713 (defun org-switchb (&optional arg)
15714 "Switch between Org buffers.
15715 With a prefix argument, restrict available to files.
15716 With two prefix arguments, restrict available buffers to agenda files.
15718 Defaults to `iswitchb' for buffer name completion.
15719 Set `org-completion-use-ido' to make it use ido instead."
15720 (interactive "P")
15721 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
15722 ((equal arg '(16)) (org-buffer-list 'agenda))
15723 (t (org-buffer-list))))
15724 (org-completion-use-iswitchb org-completion-use-iswitchb)
15725 (org-completion-use-ido org-completion-use-ido))
15726 (unless (or org-completion-use-ido org-completion-use-iswitchb)
15727 (setq org-completion-use-iswitchb t))
15728 (switch-to-buffer
15729 (org-icompleting-read "Org buffer: "
15730 (mapcar 'list (mapcar 'buffer-name blist))
15731 nil t))))
15733 ;;; Define some older names previously used for this functionality
15734 ;;;###autoload
15735 (defalias 'org-ido-switchb 'org-switchb)
15736 ;;;###autoload
15737 (defalias 'org-iswitchb 'org-switchb)
15739 (defun org-buffer-list (&optional predicate exclude-tmp)
15740 "Return a list of Org buffers.
15741 PREDICATE can be `export', `files' or `agenda'.
15743 export restrict the list to Export buffers.
15744 files restrict the list to buffers visiting Org files.
15745 agenda restrict the list to buffers visiting agenda files.
15747 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
15748 (let* ((bfn nil)
15749 (agenda-files (and (eq predicate 'agenda)
15750 (mapcar 'file-truename (org-agenda-files t))))
15751 (filter
15752 (cond
15753 ((eq predicate 'files)
15754 (lambda (b) (with-current-buffer b (org-mode-p))))
15755 ((eq predicate 'export)
15756 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
15757 ((eq predicate 'agenda)
15758 (lambda (b)
15759 (with-current-buffer b
15760 (and (org-mode-p)
15761 (setq bfn (buffer-file-name b))
15762 (member (file-truename bfn) agenda-files)))))
15763 (t (lambda (b) (with-current-buffer b
15764 (or (org-mode-p)
15765 (string-match "\*Org .*Export"
15766 (buffer-name b)))))))))
15767 (delq nil
15768 (mapcar
15769 (lambda(b)
15770 (if (and (funcall filter b)
15771 (or (not exclude-tmp)
15772 (not (string-match "tmp" (buffer-name b)))))
15773 b
15774 nil))
15775 (buffer-list)))))
15777 (defun org-agenda-files (&optional unrestricted archives)
15778 "Get the list of agenda files.
15779 Optional UNRESTRICTED means return the full list even if a restriction
15780 is currently in place.
15781 When ARCHIVES is t, include all archive files that are really being
15782 used by the agenda files. If ARCHIVE is `ifmode', do this only if
15783 `org-agenda-archives-mode' is t."
15784 (let ((files
15785 (cond
15786 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
15787 ((stringp org-agenda-files) (org-read-agenda-file-list))
15788 ((listp org-agenda-files) org-agenda-files)
15789 (t (error "Invalid value of `org-agenda-files'")))))
15790 (setq files (apply 'append
15791 (mapcar (lambda (f)
15792 (if (file-directory-p f)
15793 (directory-files
15794 f t org-agenda-file-regexp)
15795 (list f)))
15796 files)))
15797 (when org-agenda-skip-unavailable-files
15798 (setq files (delq nil
15799 (mapcar (function
15800 (lambda (file)
15801 (and (file-readable-p file) file)))
15802 files))))
15803 (when (or (eq archives t)
15804 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
15805 (setq files (org-add-archive-files files)))
15806 files))
15808 (defun org-agenda-file-p (&optional file)
15809 "Return non-nil, if FILE is an agenda file.
15810 If FILE is omitted, use the file associated with the current
15811 buffer."
15812 (member (or file (buffer-file-name))
15813 (org-agenda-files t)))
15815 (defun org-edit-agenda-file-list ()
15816 "Edit the list of agenda files.
15817 Depending on setup, this either uses customize to edit the variable
15818 `org-agenda-files', or it visits the file that is holding the list. In the
15819 latter case, the buffer is set up in a way that saving it automatically kills
15820 the buffer and restores the previous window configuration."
15821 (interactive)
15822 (if (stringp org-agenda-files)
15823 (let ((cw (current-window-configuration)))
15824 (find-file org-agenda-files)
15825 (org-set-local 'org-window-configuration cw)
15826 (org-add-hook 'after-save-hook
15827 (lambda ()
15828 (set-window-configuration
15829 (prog1 org-window-configuration
15830 (kill-buffer (current-buffer))))
15831 (org-install-agenda-files-menu)
15832 (message "New agenda file list installed"))
15833 nil 'local)
15834 (message "%s" (substitute-command-keys
15836 (customize-variable 'org-agenda-files)))
15838 (defun org-store-new-agenda-file-list (list)
15839 "Set new value for the agenda file list and save it correctly."
15840 (if (stringp org-agenda-files)
15841 (let ((fe (org-read-agenda-file-list t)) b u)
15842 (while (setq b (find-buffer-visiting org-agenda-files))
15843 (kill-buffer b))
15844 (with-temp-file org-agenda-files
15845 (insert
15846 (mapconcat
15847 (lambda (f) ;; Keep un-expanded entries.
15848 (if (setq u (assoc f fe))
15849 (cdr u)
15850 f))
15853 (let ((org-mode-hook nil) (org-inhibit-startup t)
15854 (org-insert-mode-line-in-empty-file nil))
15855 (setq org-agenda-files list)
15856 (customize-save-variable 'org-agenda-files org-agenda-files))))
15858 (defun org-read-agenda-file-list (&optional pair-with-expansion)
15859 "Read the list of agenda files from a file.
15860 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
15861 filenames, used by `org-store-new-agenda-file-list' to write back
15862 un-expanded file names."
15863 (when (file-directory-p org-agenda-files)
15864 (error "`org-agenda-files' cannot be a single directory"))
15865 (when (stringp org-agenda-files)
15866 (with-temp-buffer
15867 (insert-file-contents org-agenda-files)
15868 (mapcar
15869 (lambda (f)
15870 (let ((e (expand-file-name (substitute-in-file-name f)
15871 org-directory)))
15872 (if pair-with-expansion
15873 (cons e f)
15874 e)))
15877 ;;;###autoload
15878 (defun org-cycle-agenda-files ()
15879 "Cycle through the files in `org-agenda-files'.
15880 If the current buffer visits an agenda file, find the next one in the list.
15881 If the current buffer does not, find the first agenda file."
15882 (interactive)
15883 (let* ((fs (org-agenda-files t))
15884 (files (append fs (list (car fs))))
15885 (tcf (if buffer-file-name (file-truename buffer-file-name)))
15886 file)
15887 (unless files (error "No agenda files"))
15888 (catch 'exit
15889 (while (setq file (pop files))
15890 (if (equal (file-truename file) tcf)
15891 (when (car files)
15892 (find-file (car files))
15893 (throw 'exit t))))
15894 (find-file (car fs)))
15895 (if (buffer-base-buffer) (switch-to-buffer (buffer-base-buffer)))))
15897 (defun org-agenda-file-to-front (&optional to-end)
15898 "Move/add the current file to the top of the agenda file list.
15899 If the file is not present in the list, it is added to the front. If it is
15900 present, it is moved there. With optional argument TO-END, add/move to the
15901 end of the list."
15902 (interactive "P")
15903 (let ((org-agenda-skip-unavailable-files nil)
15904 (file-alist (mapcar (lambda (x)
15905 (cons (file-truename x) x))
15906 (org-agenda-files t)))
15907 (ctf (file-truename buffer-file-name))
15908 x had)
15909 (setq x (assoc ctf file-alist) had x)
15911 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
15912 (if to-end
15913 (setq file-alist (append (delq x file-alist) (list x)))
15914 (setq file-alist (cons x (delq x file-alist))))
15915 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
15916 (org-install-agenda-files-menu)
15917 (message "File %s to %s of agenda file list"
15918 (if had "moved" "added") (if to-end "end" "front"))))
15920 (defun org-remove-file (&optional file)
15921 "Remove current file from the list of files in variable `org-agenda-files'.
15922 These are the files which are being checked for agenda entries.
15923 Optional argument FILE means use this file instead of the current."
15924 (interactive)
15925 (let* ((org-agenda-skip-unavailable-files nil)
15926 (file (or file buffer-file-name))
15927 (true-file (file-truename file))
15928 (afile (abbreviate-file-name file))
15929 (files (delq nil (mapcar
15930 (lambda (x)
15931 (if (equal true-file
15932 (file-truename x))
15933 nil x))
15934 (org-agenda-files t)))))
15935 (if (not (= (length files) (length (org-agenda-files t))))
15936 (progn
15937 (org-store-new-agenda-file-list files)
15938 (org-install-agenda-files-menu)
15939 (message "Removed file: %s" afile))
15940 (message "File was not in list: %s (not removed)" afile))))
15942 (defun org-file-menu-entry (file)
15943 (vector file (list 'find-file file) t))
15945 (defun org-check-agenda-file (file)
15946 "Make sure FILE exists. If not, ask user what to do."
15947 (when (not (file-exists-p file))
15948 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
15949 (abbreviate-file-name file))
15950 (let ((r (downcase (read-char-exclusive))))
15951 (cond
15952 ((equal r ?r)
15953 (org-remove-file file)
15954 (throw 'nextfile t))
15955 (t (error "Abort"))))))
15957 (defun org-get-agenda-file-buffer (file)
15958 "Get a buffer visiting FILE. If the buffer needs to be created, add
15959 it to the list of buffers which might be released later."
15960 (let ((buf (org-find-base-buffer-visiting file)))
15961 (if buf
15962 buf ; just return it
15963 ;; Make a new buffer and remember it
15964 (setq buf (find-file-noselect file))
15965 (if buf (push buf org-agenda-new-buffers))
15966 buf)))
15968 (defun org-release-buffers (blist)
15969 "Release all buffers in list, asking the user for confirmation when needed.
15970 When a buffer is unmodified, it is just killed. When modified, it is saved
15971 \(if the user agrees) and then killed."
15972 (let (buf file)
15973 (while (setq buf (pop blist))
15974 (setq file (buffer-file-name buf))
15975 (when (and (buffer-modified-p buf)
15976 file
15977 (y-or-n-p (format "Save file %s? " file)))
15978 (with-current-buffer buf (save-buffer)))
15979 (kill-buffer buf))))
15981 (defun org-prepare-agenda-buffers (files)
15982 "Create buffers for all agenda files, protect archived trees and comments."
15983 (interactive)
15984 (let ((pa '(:org-archived t))
15985 (pc '(:org-comment t))
15986 (pall '(:org-archived t :org-comment t))
15987 (inhibit-read-only t)
15988 (rea (concat ":" org-archive-tag ":"))
15989 bmp file re)
15990 (save-excursion
15991 (save-restriction
15992 (while (setq file (pop files))
15993 (catch 'nextfile
15994 (if (bufferp file)
15995 (set-buffer file)
15996 (org-check-agenda-file file)
15997 (set-buffer (org-get-agenda-file-buffer file)))
15998 (widen)
15999 (setq bmp (buffer-modified-p))
16000 (org-refresh-category-properties)
16001 (setq org-todo-keywords-for-agenda
16002 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16003 (setq org-done-keywords-for-agenda
16004 (append org-done-keywords-for-agenda org-done-keywords))
16005 (setq org-todo-keyword-alist-for-agenda
16006 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16007 (setq org-drawers-for-agenda
16008 (append org-drawers-for-agenda org-drawers))
16009 (setq org-tag-alist-for-agenda
16010 (append org-tag-alist-for-agenda org-tag-alist))
16012 (save-excursion
16013 (remove-text-properties (point-min) (point-max) pall)
16014 (when org-agenda-skip-archived-trees
16015 (goto-char (point-min))
16016 (while (re-search-forward rea nil t)
16017 (if (org-on-heading-p t)
16018 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16019 (goto-char (point-min))
16021 (while (re-search-forward re nil t)
16022 (add-text-properties
16023 (match-beginning 0) (org-end-of-subtree t) pc)))
16024 (set-buffer-modified-p bmp)))))
16025 (setq org-todo-keywords-for-agenda
16026 (org-uniquify org-todo-keywords-for-agenda))
16027 (setq org-todo-keyword-alist-for-agenda
16028 (org-uniquify org-todo-keyword-alist-for-agenda)
16029 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16031 ;;;; Embedded LaTeX
16033 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16034 "Keymap for the minor `org-cdlatex-mode'.")
16036 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16037 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16038 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16039 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16040 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16042 (defvar org-cdlatex-texmathp-advice-is-done nil
16043 "Flag remembering if we have applied the advice to texmathp already.")
16045 (define-minor-mode org-cdlatex-mode
16046 "Toggle the minor `org-cdlatex-mode'.
16047 This mode supports entering LaTeX environment and math in LaTeX fragments
16048 in Org-mode.
16050 nil " OCDL" nil
16051 (when org-cdlatex-mode (require 'cdlatex))
16052 (unless org-cdlatex-texmathp-advice-is-done
16053 (setq org-cdlatex-texmathp-advice-is-done t)
16054 (defadvice texmathp (around org-math-always-on activate)
16055 "Always return t in org-mode buffers.
16056 This is because we want to insert math symbols without dollars even outside
16057 the LaTeX math segments. If Orgmode thinks that point is actually inside
16058 an embedded LaTeX fragment, let texmathp do its job.
16060 (interactive)
16061 (let (p)
16062 (cond
16063 ((not (org-mode-p)) ad-do-it)
16064 ((eq this-command 'cdlatex-math-symbol)
16065 (setq ad-return-value t
16066 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16067 (t
16068 (let ((p (org-inside-LaTeX-fragment-p)))
16069 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16070 (setq ad-return-value t
16071 texmathp-why '("Org-mode embedded math" . 0))
16072 (if p ad-do-it)))))))))
16074 (defun turn-on-org-cdlatex ()
16075 "Unconditionally turn on `org-cdlatex-mode'."
16076 (org-cdlatex-mode 1))
16078 (defun org-inside-LaTeX-fragment-p ()
16079 "Test if point is inside a LaTeX fragment.
16081 sequence appearing also before point.
16082 Even though the matchers for math are configurable, this function assumes
16084 delimiters are skipped when they have been removed by customization.
16085 The return value is nil, or a cons cell with the delimiter and
16086 and the position of this delimiter.
16088 This function does a reasonably good job, but can locally be fooled by
16089 for example currency specifications. For example it will assume being in
16091 fragments that are properly closed, but during editing, we have to live
16092 with the uncertainty caused by missing closing delimiters. This function
16093 looks only before point, not after."
16094 (catch 'exit
16095 (let ((pos (point))
16096 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16097 (lim (progn
16099 (point)))
16100 dd-on str (start 0) m re)
16101 (goto-char pos)
16102 (when dodollar
16104 re (nth 1 (assoc "$" org-latex-regexps)))
16105 (while (string-match re str start)
16106 (cond
16107 ((= (match-end 0) (length str))
16108 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16109 ((= (match-end 0) (- (length str) 5))
16110 (throw 'exit nil))
16111 (t (setq start (match-end 0))))))
16112 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16113 (goto-char pos)
16114 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16115 (and (match-beginning 2) (throw 'exit nil))
16116 ;; count $$
16118 (setq dd-on (not dd-on)))
16119 (goto-char pos)
16120 (if dd-on (cons "$$" m))))))
16122 (defun org-inside-latex-macro-p ()
16123 "Is point inside a LaTeX macro or its arguments?"
16124 (save-match-data
16125 (org-in-regexp
16128 (defun org-try-cdlatex-tab ()
16129 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16130 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16131 - inside a LaTeX fragment, or
16132 - after the first word in a line, where an abbreviation expansion could
16133 insert a LaTeX environment."
16134 (when org-cdlatex-mode
16135 (cond
16136 ((save-excursion
16137 (skip-chars-backward "a-zA-Z0-9*")
16139 (bolp))
16140 (cdlatex-tab) t)
16141 ((org-inside-LaTeX-fragment-p)
16142 (cdlatex-tab) t)
16143 (t nil))))
16145 (defun org-cdlatex-underscore-caret (&optional arg)
16146 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16147 Revert to the normal definition outside of these fragments."
16148 (interactive "P")
16149 (if (org-inside-LaTeX-fragment-p)
16150 (call-interactively 'cdlatex-sub-superscript)
16151 (let (org-cdlatex-mode)
16152 (call-interactively (key-binding (vector last-input-event))))))
16154 (defun org-cdlatex-math-modify (&optional arg)
16155 "Execute `cdlatex-math-modify' in LaTeX fragments.
16156 Revert to the normal definition outside of these fragments."
16157 (interactive "P")
16158 (if (org-inside-LaTeX-fragment-p)
16159 (call-interactively 'cdlatex-math-modify)
16160 (let (org-cdlatex-mode)
16161 (call-interactively (key-binding (vector last-input-event))))))
16163 (defvar org-latex-fragment-image-overlays nil
16164 "List of overlays carrying the images of latex fragments.")
16165 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16167 (defun org-remove-latex-fragment-image-overlays ()
16168 "Remove all overlays with LaTeX fragment images in current buffer."
16169 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16170 (setq org-latex-fragment-image-overlays nil))
16172 (defun org-preview-latex-fragment (&optional subtree)
16173 "Preview the LaTeX fragment at point, or all locally or globally.
16174 If the cursor is in a LaTeX fragment, create the image and overlay
16175 it over the source code. If there is no fragment at point, display
16176 all fragments in the current text, from one headline to the next. With
16177 prefix SUBTREE, display all fragments in the current subtree. With a
16179 the cursor is before the first headline,
16180 display all fragments in the buffer.
16182 (interactive "P")
16183 (org-remove-latex-fragment-image-overlays)
16184 (save-excursion
16185 (save-restriction
16186 (let (beg end at msg)
16187 (cond
16188 ((or (equal subtree '(16))
16189 (not (save-excursion
16190 (re-search-backward (concat "^" outline-regexp) nil t))))
16191 (setq beg (point-min) end (point-max)
16192 msg "Creating images for buffer...%s"))
16193 ((equal subtree '(4))
16194 (org-back-to-heading)
16195 (setq beg (point) end (org-end-of-subtree t)
16196 msg "Creating images for subtree...%s"))
16197 (t
16198 (if (setq at (org-inside-LaTeX-fragment-p))
16199 (goto-char (max (point-min) (- (cdr at) 2)))
16200 (org-back-to-heading))
16201 (setq beg (point) end (progn (outline-next-heading) (point))
16202 msg (if at "Creating image...%s"
16203 "Creating images for entry...%s"))))
16204 (message msg "")
16205 (narrow-to-region beg end)
16206 (goto-char beg)
16207 (org-format-latex
16208 (concat "ltxpng/" (file-name-sans-extension
16209 (file-name-nondirectory
16210 buffer-file-name)))
16211 default-directory 'overlays msg at 'forbuffer 'dvipng)
16212 (message msg "done. Use `C-c C-c' to remove images.")))))
16214 (defvar org-latex-regexps
16216 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16219 ("$" "\\([^$]\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16223 "Regular expressions for matching embedded LaTeX.")
16225 (defvar org-export-have-math nil) ;; dynamic scoping
16226 (defun org-format-latex (prefix &optional dir overlays msg at
16227 forbuffer processing-type)
16228 "Replace LaTeX fragments with links to an image, and produce images.
16229 Some of the options can be changed using the variable
16230 `org-format-latex-options'."
16231 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16232 (let* ((prefixnodir (file-name-nondirectory prefix))
16233 (absprefix (expand-file-name prefix dir))
16234 (todir (file-name-directory absprefix))
16235 (opt org-format-latex-options)
16236 (matchers (plist-get opt :matchers))
16237 (re-list org-latex-regexps)
16238 (org-format-latex-header-extra
16239 (plist-get (org-infile-export-plist) :latex-header-extra))
16240 (cnt 0) txt hash link beg end re e checkdir
16241 executables-checked string
16242 m n block linkfile movefile ov)
16243 ;; Check the different regular expressions
16244 (while (setq e (pop re-list))
16245 (setq m (car e) re (nth 1 e) n (nth 2 e)
16247 (when (member m matchers)
16248 (goto-char (point-min))
16249 (while (re-search-forward re nil t)
16250 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16251 (not (get-text-property (match-beginning n)
16252 'org-protected))
16253 (or (not overlays)
16254 (not (eq (get-char-property (match-beginning n)
16255 'org-overlay-type)
16256 'org-latex-overlay))))
16257 (setq org-export-have-math t)
16258 (cond
16259 ((eq processing-type 'verbatim)
16260 ;; Leave the text verbatim, just protect it
16261 (add-text-properties (match-beginning n) (match-end n)
16262 '(org-protected t)))
16263 ((eq processing-type 'mathjax)
16264 ;; Prepare for MathJax processing
16265 (setq string (match-string n))
16266 (if (member m '("$" "$1"))
16267 (save-excursion
16268 (delete-region (match-beginning n) (match-end n))
16269 (goto-char (match-beginning n))
16272 '(org-protected t))))
16273 (add-text-properties (match-beginning n) (match-end n)
16274 '(org-protected t))))
16275 ((or (eq processing-type 'dvipng) t)
16276 ;; Process to an image
16277 (setq txt (match-string n)
16278 beg (match-beginning n) end (match-end n)
16279 cnt (1+ cnt))
16280 (let (print-length print-level) ; make sure full list is printed
16281 (setq hash (sha1 (prin1-to-string
16282 (list org-format-latex-header
16283 org-format-latex-header-extra
16284 org-export-latex-default-packages-alist
16285 org-export-latex-packages-alist
16286 org-format-latex-options
16287 forbuffer txt)))
16288 linkfile (format "%s_%s.png" prefix hash)
16289 movefile (format "%s_%s.png" absprefix hash)))
16290 (setq link (concat block "[[file:" linkfile "]]" block))
16291 (if msg (message msg cnt))
16292 (goto-char beg)
16293 (unless checkdir ; make sure the directory exists
16294 (setq checkdir t)
16295 (or (file-directory-p todir) (make-directory todir t)))
16297 (unless executables-checked
16298 (org-check-external-command
16299 "latex" "needed to convert LaTeX fragments to images")
16300 (org-check-external-command
16301 "dvipng" "needed to convert LaTeX fragments to images")
16302 (setq executables-checked t))
16304 (unless (file-exists-p movefile)
16305 (org-create-formula-image
16306 txt movefile opt forbuffer))
16307 (if overlays
16308 (progn
16309 (mapc (lambda (o)
16310 (if (eq (overlay-get o 'org-overlay-type)
16311 'org-latex-overlay)
16312 (delete-overlay o)))
16313 (overlays-in beg end))
16314 (setq ov (make-overlay beg end))
16315 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16316 (if (featurep 'xemacs)
16317 (progn
16318 (overlay-put ov 'invisible t)
16319 (overlay-put
16320 ov 'end-glyph
16321 (make-glyph (vector 'png :file movefile))))
16322 (overlay-put
16323 ov 'display
16324 (list 'image :type 'png :file movefile :ascent 'center)))
16325 (push ov org-latex-fragment-image-overlays)
16326 (goto-char end))
16327 (delete-region beg end)
16328 (insert (org-add-props link
16329 (list 'org-latex-src
16330 (replace-regexp-in-string
16333 ;; This function borrows from Ganesh Swami's latex2png.el
16334 (defun org-create-formula-image (string tofile options buffer)
16335 "This calls dvipng."
16336 (require 'org-latex)
16337 (let* ((tmpdir (if (featurep 'xemacs)
16338 (temp-directory)
16339 temporary-file-directory))
16340 (texfilebase (make-temp-name
16341 (expand-file-name "orgtex" tmpdir)))
16342 (texfile (concat texfilebase ".tex"))
16343 (dvifile (concat texfilebase ".dvi"))
16344 (pngfile (concat texfilebase ".png"))
16345 (fnh (if (featurep 'xemacs)
16346 (font-height (get-face-font 'default))
16347 (face-attribute 'default :height nil)))
16348 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16349 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16350 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16351 "Black"))
16352 (bg (or (plist-get options (if buffer :background :html-background))
16353 "Transparent")))
16354 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16355 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16356 (with-temp-file texfile
16357 (insert (org-splice-latex-header
16358 org-format-latex-header
16359 org-export-latex-default-packages-alist
16360 org-export-latex-packages-alist t
16361 org-format-latex-header-extra))
16363 (require 'org-latex)
16364 (org-export-latex-fix-inputenc))
16365 (let ((dir default-directory))
16366 (condition-case nil
16367 (progn
16368 (cd tmpdir)
16369 (call-process "latex" nil nil nil texfile))
16370 (error nil))
16371 (cd dir))
16372 (if (not (file-exists-p dvifile))
16373 (progn (message "Failed to create dvi file from %s" texfile) nil)
16374 (condition-case nil
16375 (call-process "dvipng" nil nil nil
16376 "-fg" fg "-bg" bg
16377 "-D" dpi
16378 ;;"-x" scale "-y" scale
16379 "-T" "tight"
16380 "-o" pngfile
16381 dvifile)
16382 (error nil))
16383 (if (not (file-exists-p pngfile))
16384 (if org-format-latex-signal-error
16385 (error "Failed to create png file from %s" texfile)
16386 (message "Failed to create png file from %s" texfile)
16387 nil)
16388 ;; Use the requested file name and clean up
16389 (copy-file pngfile tofile 'replace)
16390 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
16391 (delete-file (concat texfilebase e)))
16392 pngfile))))
16394 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
16395 "Fill a LaTeX header template TPL.
16396 In the template, the following place holders will be recognized:
16399 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
16401 [NO-PACKAGES] do not include PKG
16402 [EXTRA] the string EXTRA
16403 [NO-EXTRA] do not include EXTRA
16405 For backward compatibility, if both the positive and the negative place
16407 assumed to be present at the end of the template.
16408 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
16409 EXTRA is a string.
16410 SNIPPETS-P indicates if this is run to create snippet images for HTML."
16411 (let (rpl (end ""))
16413 (setq rpl (if (or (match-end 1) (not def-pkg))
16414 "" (org-latex-packages-to-string def-pkg snippets-p t))
16415 tpl (replace-match rpl t t tpl))
16416 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
16419 (setq rpl (if (or (match-end 1) (not pkg))
16420 "" (org-latex-packages-to-string pkg snippets-p t))
16421 tpl (replace-match rpl t t tpl))
16422 (if pkg (setq end
16424 (org-latex-packages-to-string pkg snippets-p)))))
16427 (setq rpl (if (or (match-end 1) (not extra))
16429 tpl (replace-match rpl t t tpl))
16435 tpl)))
16437 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
16439 (setq pkg (mapconcat (lambda(p)
16440 (cond
16441 ((stringp p) p)
16442 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
16443 (format "%% Package %s omitted" (cadr p)))
16444 ((equal "" (car p))
16446 (t
16448 (car p) (cadr p)))))
16449 pkg
16453 (defun org-dvipng-color (attr)
16454 "Return an rgb color specification for dvipng."
16455 (apply 'format "rgb %s %s %s"
16456 (mapcar 'org-normalize-color
16457 (color-values (face-attribute 'default attr nil)))))
16459 (defun org-normalize-color (value)
16460 "Return string to be used as color value for an RGB component."
16461 (format "%g" (/ value 65535.0)))
16463 ;; Image display
16466 (defvar org-inline-image-overlays nil)
16467 (make-variable-buffer-local 'org-inline-image-overlays)
16469 (defun org-toggle-inline-images (&optional include-linked)
16470 "Toggle the display of inline images.
16471 INCLUDE-LINKED is passed to `org-display-inline-images'."
16472 (interactive "P")
16473 (if org-inline-image-overlays
16474 (progn
16475 (org-remove-inline-images)
16476 (message "Inline image display turned off"))
16477 (org-display-inline-images include-linked)
16478 (if org-inline-image-overlays
16479 (message "%d images displayed inline"
16480 (length org-inline-image-overlays))
16481 (message "No images to display inline"))))
16483 (defun org-display-inline-images (&optional include-linked refresh beg end)
16484 "Display inline images.
16485 Normally only links without a description part are inlined, because this
16486 is how it will work for export. When INCLUDE-LINKED is set, also links
16487 with a description part will be inlined. This can be nice for a quick
16488 look at those images, but it does not reflect what exported files will look
16489 like.
16490 When REFRESH is set, refresh existing images between BEG and END.
16491 This will create new image displays only if necessary.
16492 BEG and END default to the buffer boundaries."
16493 (interactive "P")
16494 (unless refresh
16495 (org-remove-inline-images)
16496 (if (fboundp 'clear-image-cache) (clear-image-cache)))
16497 (save-excursion
16498 (save-restriction
16499 (widen)
16500 (setq beg (or beg (point-min)) end (or end (point-max)))
16501 (goto-char (point-min))
16503 (substring (org-image-file-name-regexp) 0 -2)
16505 old file ov img)
16506 (while (re-search-forward re end t)
16507 (setq old (get-char-property-and-overlay (match-beginning 1)
16508 'org-image-overlay))
16509 (setq file (expand-file-name
16510 (concat (or (match-string 3) "") (match-string 4))))
16511 (when (file-exists-p file)
16512 (if (and (car-safe old) refresh)
16513 (image-refresh (overlay-get (cdr old) 'display))
16514 (setq img (save-match-data (create-image file)))
16515 (when img
16516 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
16517 (overlay-put ov 'display img)
16518 (overlay-put ov 'face 'default)
16519 (overlay-put ov 'org-image-overlay t)
16520 (overlay-put ov 'modification-hooks
16521 (list 'org-display-inline-modification-hook))
16522 (push ov org-inline-image-overlays)))))))))
16524 (defun org-display-inline-modification-hook (ov after beg end &optional len)
16525 "Remove inline-display overlay if a corresponding region is modified."
16526 (let ((inhibit-modification-hooks t))
16527 (when (and ov after)
16528 (delete ov org-inline-image-overlays)
16529 (delete-overlay ov))))
16531 (defun org-remove-inline-images ()
16532 "Remove inline display of images."
16533 (interactive)
16534 (mapc 'delete-overlay org-inline-image-overlays)
16535 (setq org-inline-image-overlays nil))
16537 ;;;; Key bindings
16539 ;; Make `C-c C-x' a prefix key
16540 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
16542 ;; TAB key with modifiers
16543 (org-defkey org-mode-map "\C-i" 'org-cycle)
16544 (org-defkey org-mode-map [(tab)] 'org-cycle)
16545 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
16546 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
16548 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
16549 ;; The following line is necessary under Suse GNU/Linux
16550 (unless (featurep 'xemacs)
16551 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
16552 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
16553 (define-key org-mode-map [backtab] 'org-shifttab)
16555 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
16556 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
16557 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
16559 ;; Cursor keys with modifiers
16560 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
16561 (org-defkey org-mode-map [(meta right)] 'org-metaright)
16562 (org-defkey org-mode-map [(meta up)] 'org-metaup)
16563 (org-defkey org-mode-map [(meta down)] 'org-metadown)
16565 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
16566 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
16567 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
16568 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
16570 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
16571 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
16572 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
16573 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
16575 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
16576 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
16578 ;; Babel keys
16579 (define-key org-mode-map org-babel-key-prefix org-babel-map)
16580 (mapc (lambda (pair)
16581 (define-key org-babel-map (car pair) (cdr pair)))
16582 org-babel-key-bindings)
16584 ;;; Extra keys for tty access.
16585 ;; We only set them when really needed because otherwise the
16586 ;; menus don't show the simple keys
16588 (when (or org-use-extra-keys
16589 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
16590 (not window-system))
16591 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
16592 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
16593 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
16594 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
16595 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
16596 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
16597 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
16598 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
16599 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
16600 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
16601 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
16602 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
16603 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
16604 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
16605 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
16606 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
16607 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
16608 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
16609 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
16610 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
16611 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
16612 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
16613 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
16614 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
16615 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
16616 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
16617 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
16618 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
16620 ;; All the other keys
16622 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
16623 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
16624 (if (boundp 'narrow-map)
16625 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
16626 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
16627 (if (boundp 'narrow-map)
16628 (org-defkey narrow-map "b" 'org-narrow-to-block)
16629 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
16630 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
16631 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
16632 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
16633 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
16634 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
16635 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
16636 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
16637 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
16638 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
16639 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
16640 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
16641 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
16642 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
16643 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
16644 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
16645 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
16647 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
16648 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
16649 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
16650 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
16651 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
16652 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
16653 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
16654 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
16655 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
16656 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
16657 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
16658 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
16659 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
16660 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
16661 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
16662 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
16663 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
16664 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
16665 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
16667 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
16668 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
16669 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
16670 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
16671 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
16672 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
16673 (org-defkey org-mode-map "\C-c^" 'org-sort)
16674 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
16675 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
16676 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
16677 (org-defkey org-mode-map "\C-m" 'org-return)
16678 (org-defkey org-mode-map "\C-j" 'org-return-indent)
16679 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
16680 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
16681 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
16682 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
16683 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
16684 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
16685 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
16686 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
16687 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
16688 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
16689 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
16690 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
16691 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
16692 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
16693 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
16694 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
16695 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
16696 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
16697 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
16698 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
16699 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
16701 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
16702 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
16703 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
16704 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
16706 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
16707 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
16708 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
16709 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
16710 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
16711 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
16712 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
16713 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
16714 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
16715 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
16717 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
16718 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
16719 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
16720 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
16721 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
16722 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
16723 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
16725 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
16726 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
16727 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
16728 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
16729 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
16731 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
16733 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
16735 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
16736 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
16738 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
16741 (when (featurep 'xemacs)
16742 (org-defkey org-mode-map 'button3 'popup-mode-menu))
16745 (defconst org-speed-commands-default
16746 '(
16747 ("Outline Navigation")
16748 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
16749 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
16750 ("f" . (org-speed-move-safe 'org-forward-same-level))
16751 ("b" . (org-speed-move-safe 'org-backward-same-level))
16752 ("u" . (org-speed-move-safe 'outline-up-heading))
16753 ("j" . org-goto)
16754 ("g" . (org-refile t))
16755 ("Outline Visibility")
16756 ("c" . org-cycle)
16757 ("C" . org-shifttab)
16758 (" " . org-display-outline-path)
16759 ("Outline Structure Editing")
16760 ("U" . org-shiftmetaup)
16761 ("D" . org-shiftmetadown)
16762 ("r" . org-metaright)
16763 ("l" . org-metaleft)
16764 ("R" . org-shiftmetaright)
16765 ("L" . org-shiftmetaleft)
16766 ("i" . (progn (forward-char 1) (call-interactively
16767 'org-insert-heading-respect-content)))
16768 ("^" . org-sort)
16769 ("w" . org-refile)
16770 ("a" . org-archive-subtree-default-with-confirmation)
16771 ("." . org-mark-subtree)
16772 ("Clock Commands")
16773 ("I" . org-clock-in)
16774 ("O" . org-clock-out)
16775 ("Meta Data Editing")
16776 ("t" . org-todo)
16777 ("0" . (org-priority ?\ ))
16778 ("1" . (org-priority ?A))
16779 ("2" . (org-priority ?B))
16780 ("3" . (org-priority ?C))
16781 (";" . org-set-tags-command)
16782 ("e" . org-set-effort)
16783 ("Agenda Views etc")
16784 ("v" . org-agenda)
16785 ("/" . org-sparse-tree)
16786 ("Misc")
16787 ("o" . org-open-at-point)
16788 ("?" . org-speed-command-help)
16789 ("<" . (org-agenda-set-restriction-lock 'subtree))
16790 (">" . (org-agenda-remove-restriction-lock))
16791 )
16792 "The default speed commands.")
16794 (defun org-print-speed-command (e)
16795 (if (> (length (car e)) 1)
16796 (progn
16798 (princ (car e))
16800 (princ (make-string (length (car e)) ?-))
16802 (princ (car e))
16803 (princ " ")
16804 (if (symbolp (cdr e))
16805 (princ (symbol-name (cdr e)))
16806 (prin1 (cdr e)))
16809 (defun org-speed-command-help ()
16810 "Show the available speed commands."
16811 (interactive)
16812 (if (not org-use-speed-commands)
16813 (error "Speed commands are not activated, customize `org-use-speed-commands'")
16814 (with-output-to-temp-buffer "*Help*"
16816 (mapc 'org-print-speed-command org-speed-commands-user)
16819 (mapc 'org-print-speed-command org-speed-commands-default))
16820 (with-current-buffer "*Help*"
16821 (setq truncate-lines t))))
16823 (defun org-speed-move-safe (cmd)
16824 "Execute CMD, but make sure that the cursor always ends up in a headline.
16825 If not, return to the original position and throw an error."
16826 (interactive)
16827 (let ((pos (point)))
16828 (call-interactively cmd)
16829 (unless (and (bolp) (org-on-heading-p))
16830 (goto-char pos)
16831 (error "Boundary reached while executing %s" cmd))))
16833 (defvar org-self-insert-command-undo-counter 0)
16835 (defvar org-table-auto-blank-field) ; defined in org-table.el
16836 (defvar org-speed-command nil)
16838 (defun org-speed-command-default-hook (keys)
16839 "Hook for activating single-letter speed commands.
16840 `org-speed-commands-default' specifies a minimal command set. Use
16841 `org-speed-commands-user' for further customization."
16842 (when (or (and (bolp) (looking-at outline-regexp))
16843 (and (functionp org-use-speed-commands)
16844 (funcall org-use-speed-commands)))
16845 (cdr (assoc keys (append org-speed-commands-user
16846 org-speed-commands-default)))))
16848 (defun org-babel-speed-command-hook (keys)
16849 "Hook for activating single-letter code block commands."
16850 (when (and (bolp) (looking-at org-babel-src-block-regexp))
16851 (cdr (assoc keys org-babel-key-bindings))))
16853 (defcustom org-speed-command-hook
16854 '(org-speed-command-default-hook org-babel-speed-command-hook)
16855 "Hook for activating speed commands at strategic locations.
16856 Hook functions are called in sequence until a valid handler is
16857 found.
16859 Each hook takes a single argument, a user-pressed command key
16860 which is also a `self-insert-command' from the global map.
16862 Within the hook, examine the cursor position and the command key
16863 and return nil or a valid handler as appropriate. Handler could
16864 be one of an interactive command, a function, or a form.
16866 Set `org-use-speed-commands' to non-nil value to enable this
16867 hook. The default setting is `org-speed-command-default-hook'."
16868 :group 'org-structure
16869 :type 'hook)
16871 (defun org-self-insert-command (N)
16872 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
16873 If the cursor is in a table looking at whitespace, the whitespace is
16874 overwritten, and the table is not marked as requiring realignment."
16875 (interactive "p")
16876 (cond
16877 ((and org-use-speed-commands
16878 (setq org-speed-command
16879 (run-hook-with-args-until-success
16880 'org-speed-command-hook (this-command-keys))))
16881 (cond
16882 ((commandp org-speed-command)
16883 (setq this-command org-speed-command)
16884 (call-interactively org-speed-command))
16885 ((functionp org-speed-command)
16886 (funcall org-speed-command))
16887 ((and org-speed-command (listp org-speed-command))
16888 (eval org-speed-command))
16889 (t (let (org-use-speed-commands)
16890 (call-interactively 'org-self-insert-command)))))
16891 ((and
16892 (org-table-p)
16893 (progn
16894 ;; check if we blank the field, and if that triggers align
16895 (and (featurep 'org-table) org-table-auto-blank-field
16896 (member last-command
16897 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
16899 ;; got extra space, this field does not determine column width
16900 (let (org-table-may-need-update) (org-table-blank-field))
16901 ;; no extra space, this field may determine column width
16902 (org-table-blank-field)))
16903 t)
16904 (eq N 1)
16906 (let (org-table-may-need-update)
16907 (goto-char (1- (match-end 0)))
16908 (delete-backward-char 1)
16909 (goto-char (match-beginning 0))
16910 (self-insert-command N)))
16911 (t
16912 (setq org-table-may-need-update t)
16913 (self-insert-command N)
16914 (org-fix-tags-on-the-fly)
16915 (if org-self-insert-cluster-for-undo
16916 (if (not (eq last-command 'org-self-insert-command))
16917 (setq org-self-insert-command-undo-counter 1)
16918 (if (>= org-self-insert-command-undo-counter 20)
16919 (setq org-self-insert-command-undo-counter 1)
16920 (and (> org-self-insert-command-undo-counter 0)
16921 buffer-undo-list
16922 (not (cadr buffer-undo-list)) ; remove nil entry
16923 (setcdr buffer-undo-list (cddr buffer-undo-list)))
16924 (setq org-self-insert-command-undo-counter
16925 (1+ org-self-insert-command-undo-counter))))))))
16927 (defun org-fix-tags-on-the-fly ()
16928 (when (and (equal (char-after (point-at-bol)) ?*)
16929 (org-on-heading-p))
16930 (org-align-tags-here org-tags-column)))
16932 (defun org-delete-backward-char (N)
16933 "Like `delete-backward-char', insert whitespace at field end in tables.
16934 When deleting backwards, in tables this function will insert whitespace in
16936 still be marked for re-alignment if the field did fill the entire column,
16937 because, in this case the deletion might narrow the column."
16938 (interactive "p")
16939 (if (and (org-table-p)
16940 (eq N 1)
16941 (string-match "|" (buffer-substring (point-at-bol) (point)))
16942 (looking-at ".*?|"))
16943 (let ((pos (point))
16945 (c org-table-may-need-update))
16946 (backward-delete-char N)
16947 (if (not overwrite-mode)
16948 (progn
16949 (skip-chars-forward "^|")
16950 (insert " ")
16951 (goto-char (1- pos))))
16952 ;; noalign: if there were two spaces at the end, this field
16953 ;; does not determine the width of the column.
16954 (if noalign (setq org-table-may-need-update c)))
16955 (backward-delete-char N)
16956 (org-fix-tags-on-the-fly)))
16958 (defun org-delete-char (N)
16959 "Like `delete-char', but insert whitespace at field end in tables.
16960 When deleting characters, in tables this function will insert whitespace in
16962 still be marked for re-alignment if the field did fill the entire column,
16963 because, in this case the deletion might narrow the column."
16964 (interactive "p")
16965 (if (and (org-table-p)
16966 (not (bolp))
16967 (not (= (char-after) ?|))
16968 (eq N 1))
16969 (if (looking-at ".*?|")
16970 (let ((pos (point))
16972 (c org-table-may-need-update))
16973 (replace-match (concat
16974 (substring (match-string 0) 1 -1)
16975 " |"))
16976 (goto-char pos)
16977 ;; noalign: if there were two spaces at the end, this field
16978 ;; does not determine the width of the column.
16979 (if noalign (setq org-table-may-need-update c)))
16980 (delete-char N))
16981 (delete-char N)
16982 (org-fix-tags-on-the-fly)))
16984 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
16985 (put 'org-self-insert-command 'delete-selection t)
16986 (put 'orgtbl-self-insert-command 'delete-selection t)
16987 (put 'org-delete-char 'delete-selection 'supersede)
16988 (put 'org-delete-backward-char 'delete-selection 'supersede)
16989 (put 'org-yank 'delete-selection 'yank)
16991 ;; Make `flyspell-mode' delay after some commands
16992 (put 'org-self-insert-command 'flyspell-delayed t)
16993 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
16994 (put 'org-delete-char 'flyspell-delayed t)
16995 (put 'org-delete-backward-char 'flyspell-delayed t)
16997 ;; Make pabbrev-mode expand after org-mode commands
16998 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
16999 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17001 ;; How to do this: Measure non-white length of current string
17002 ;; If equal to column width, we should realign.
17004 (defun org-remap (map &rest commands)
17005 "In MAP, remap the functions given in COMMANDS.
17006 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17007 (let (new old)
17008 (while commands
17009 (setq old (pop commands) new (pop commands))
17010 (if (fboundp 'command-remapping)
17011 (org-defkey map (vector 'remap old) new)
17012 (substitute-key-definition old new map global-map)))))
17014 (when (eq org-enable-table-editor 'optimized)
17015 ;; If the user wants maximum table support, we need to hijack
17016 ;; some standard editing functions
17017 (org-remap org-mode-map
17018 'self-insert-command 'org-self-insert-command
17019 'delete-char 'org-delete-char
17020 'delete-backward-char 'org-delete-backward-char)
17021 (org-defkey org-mode-map "|" 'org-force-self-insert))
17023 (defvar org-ctrl-c-ctrl-c-hook nil
17024 "Hook for functions attaching themselves to `C-c C-c'.
17025 This can be used to add additional functionality to the C-c C-c key which
17026 executes context-dependent commands.
17027 Each function will be called with no arguments. The function must check
17028 if the context is appropriate for it to act. If yes, it should do its
17029 thing and then return a non-nil value. If the context is wrong,
17030 just do nothing and return nil.")
17032 (defvar org-tab-first-hook nil
17033 "Hook for functions to attach themselves to TAB.
17034 See `org-ctrl-c-ctrl-c-hook' for more information.
17035 This hook runs as the first action when TAB is pressed, even before
17036 `org-cycle' messes around with the `outline-regexp' to cater for
17037 inline tasks and plain list item folding.
17038 If any function in this hook returns t, any other actions that
17039 would have been caused by TAB (such as table field motion or visibility
17040 cycling) will not occur.")
17042 (defvar org-tab-after-check-for-table-hook nil
17043 "Hook for functions to attach themselves to TAB.
17044 See `org-ctrl-c-ctrl-c-hook' for more information.
17045 This hook runs after it has been established that the cursor is not in a
17046 table, but before checking if the cursor is in a headline or if global cycling
17047 should be done.
17048 If any function in this hook returns t, not other actions like visibility
17049 cycling will be done.")
17051 (defvar org-tab-after-check-for-cycling-hook nil
17052 "Hook for functions to attach themselves to TAB.
17053 See `org-ctrl-c-ctrl-c-hook' for more information.
17054 This hook runs after it has been established that not table field motion and
17055 not visibility should be done because of current context. This is probably
17056 the place where a package like yasnippets can hook in.")
17058 (defvar org-tab-before-tab-emulation-hook nil
17059 "Hook for functions to attach themselves to TAB.
17060 See `org-ctrl-c-ctrl-c-hook' for more information.
17061 This hook runs after every other options for TAB have been exhausted, but
17064 (defvar org-metaleft-hook nil
17065 "Hook for functions attaching themselves to `M-left'.
17066 See `org-ctrl-c-ctrl-c-hook' for more information.")
17067 (defvar org-metaright-hook nil
17068 "Hook for functions attaching themselves to `M-right'.
17069 See `org-ctrl-c-ctrl-c-hook' for more information.")
17070 (defvar org-metaup-hook nil
17071 "Hook for functions attaching themselves to `M-up'.
17072 See `org-ctrl-c-ctrl-c-hook' for more information.")
17073 (defvar org-metadown-hook nil
17074 "Hook for functions attaching themselves to `M-down'.
17075 See `org-ctrl-c-ctrl-c-hook' for more information.")
17076 (defvar org-shiftmetaleft-hook nil
17077 "Hook for functions attaching themselves to `M-S-left'.
17078 See `org-ctrl-c-ctrl-c-hook' for more information.")
17079 (defvar org-shiftmetaright-hook nil
17080 "Hook for functions attaching themselves to `M-S-right'.
17081 See `org-ctrl-c-ctrl-c-hook' for more information.")
17082 (defvar org-shiftmetaup-hook nil
17083 "Hook for functions attaching themselves to `M-S-up'.
17084 See `org-ctrl-c-ctrl-c-hook' for more information.")
17085 (defvar org-shiftmetadown-hook nil
17086 "Hook for functions attaching themselves to `M-S-down'.
17087 See `org-ctrl-c-ctrl-c-hook' for more information.")
17088 (defvar org-metareturn-hook nil
17089 "Hook for functions attaching themselves to `M-RET'.
17090 See `org-ctrl-c-ctrl-c-hook' for more information.")
17091 (defvar org-shiftup-hook nil
17092 "Hook for functions attaching themselves to `S-up'.
17093 See `org-ctrl-c-ctrl-c-hook' for more information.")
17094 (defvar org-shiftup-final-hook nil
17095 "Hook for functions attaching themselves to `S-up'.
17096 This one runs after all other options except shift-select have been excluded.
17097 See `org-ctrl-c-ctrl-c-hook' for more information.")
17098 (defvar org-shiftdown-hook nil
17099 "Hook for functions attaching themselves to `S-down'.
17100 See `org-ctrl-c-ctrl-c-hook' for more information.")
17101 (defvar org-shiftdown-final-hook nil
17102 "Hook for functions attaching themselves to `S-down'.
17103 This one runs after all other options except shift-select have been excluded.
17104 See `org-ctrl-c-ctrl-c-hook' for more information.")
17105 (defvar org-shiftleft-hook nil
17106 "Hook for functions attaching themselves to `S-left'.
17107 See `org-ctrl-c-ctrl-c-hook' for more information.")
17108 (defvar org-shiftleft-final-hook nil
17109 "Hook for functions attaching themselves to `S-left'.
17110 This one runs after all other options except shift-select have been excluded.
17111 See `org-ctrl-c-ctrl-c-hook' for more information.")
17112 (defvar org-shiftright-hook nil
17113 "Hook for functions attaching themselves to `S-right'.
17114 See `org-ctrl-c-ctrl-c-hook' for more information.")
17115 (defvar org-shiftright-final-hook nil
17116 "Hook for functions attaching themselves to `S-right'.
17117 This one runs after all other options except shift-select have been excluded.
17118 See `org-ctrl-c-ctrl-c-hook' for more information.")
17120 (defun org-modifier-cursor-error ()
17121 "Throw an error, a modified cursor command was applied in wrong context."
17122 (error "This command is active in special context like tables, headlines or items"))
17124 (defun org-shiftselect-error ()
17125 "Throw an error because Shift-Cursor command was applied in wrong context."
17126 (if (and (boundp 'shift-select-mode) shift-select-mode)
17127 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17128 (error "This command works only in special context like headlines or timestamps")))
17130 (defun org-call-for-shift-select (cmd)
17131 (let ((this-command-keys-shift-translated t))
17132 (call-interactively cmd)))
17134 (defun org-shifttab (&optional arg)
17135 "Global visibility cycling or move to previous table field.
17136 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17137 on context.
17138 See the individual commands for more information."
17139 (interactive "P")
17140 (cond
17141 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17142 ((integerp arg)
17143 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17144 (message "Content view to level: %d" arg)
17145 (org-content (prefix-numeric-value arg2))
17146 (setq org-cycle-global-status 'overview)))
17147 (t (call-interactively 'org-global-cycle))))
17149 (defun org-shiftmetaleft ()
17150 "Promote subtree or delete table column.
17151 Calls `org-promote-subtree', `org-outdent-item',
17152 or `org-table-delete-column', depending on context.
17153 See the individual commands for more information."
17154 (interactive)
17155 (cond
17156 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17157 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17158 ((org-on-heading-p) (call-interactively 'org-promote-subtree))
17159 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17160 (t (org-modifier-cursor-error))))
17162 (defun org-shiftmetaright ()
17163 "Demote subtree or insert table column.
17164 Calls `org-demote-subtree', `org-indent-item',
17165 or `org-table-insert-column', depending on context.
17166 See the individual commands for more information."
17167 (interactive)
17168 (cond
17169 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17170 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17171 ((org-on-heading-p) (call-interactively 'org-demote-subtree))
17172 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17173 (t (org-modifier-cursor-error))))
17175 (defun org-shiftmetaup (&optional arg)
17176 "Move subtree up or kill table row.
17177 Calls `org-move-subtree-up' or `org-table-kill-row' or
17178 `org-move-item-up' depending on context. See the individual commands
17179 for more information."
17180 (interactive "P")
17181 (cond
17182 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17183 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17184 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17185 ((org-at-item-p) (call-interactively 'org-move-item-up))
17186 (t (org-modifier-cursor-error))))
17188 (defun org-shiftmetadown (&optional arg)
17189 "Move subtree down or insert table row.
17190 Calls `org-move-subtree-down' or `org-table-insert-row' or
17191 `org-move-item-down', depending on context. See the individual
17192 commands for more information."
17193 (interactive "P")
17194 (cond
17195 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17196 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17197 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17198 ((org-at-item-p) (call-interactively 'org-move-item-down))
17199 (t (org-modifier-cursor-error))))
17201 (defsubst org-hidden-tree-error ()
17202 (error
17203 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17205 (defun org-metaleft (&optional arg)
17206 "Promote heading or move table column to left.
17207 Calls `org-do-promote' or `org-table-move-column', depending on context.
17208 With no specific context, calls the Emacs default `backward-word'.
17209 See the individual commands for more information."
17210 (interactive "P")
17211 (cond
17212 ((run-hook-with-args-until-success 'org-metaleft-hook))
17213 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17214 ((org-with-limited-levels
17215 (or (org-on-heading-p)
17216 (and (org-region-active-p)
17217 (save-excursion
17218 (goto-char (region-beginning))
17219 (org-on-heading-p)))))
17220 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17221 (call-interactively 'org-do-promote))
17222 ;; At an inline task.
17223 ((org-on-heading-p)
17224 (call-interactively 'org-inlinetask-promote))
17225 ((or (org-at-item-p)
17226 (and (org-region-active-p)
17227 (save-excursion
17228 (goto-char (region-beginning))
17229 (org-at-item-p))))
17230 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17231 (call-interactively 'org-outdent-item))
17232 (t (call-interactively 'backward-word))))
17234 (defun org-metaright (&optional arg)
17235 "Demote subtree or move table column to right.
17236 Calls `org-do-demote' or `org-table-move-column', depending on context.
17237 With no specific context, calls the Emacs default `forward-word'.
17238 See the individual commands for more information."
17239 (interactive "P")
17240 (cond
17241 ((run-hook-with-args-until-success 'org-metaright-hook))
17242 ((org-at-table-p) (call-interactively 'org-table-move-column))
17243 ((org-with-limited-levels
17244 (or (org-on-heading-p)
17245 (and (org-region-active-p)
17246 (save-excursion
17247 (goto-char (region-beginning))
17248 (org-on-heading-p)))))
17249 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17250 (call-interactively 'org-do-demote))
17251 ;; At an inline task.
17252 ((org-on-heading-p)
17253 (call-interactively 'org-inlinetask-demote))
17254 ((or (org-at-item-p)
17255 (and (org-region-active-p)
17256 (save-excursion
17257 (goto-char (region-beginning))
17258 (org-at-item-p))))
17259 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17260 (call-interactively 'org-indent-item))
17261 (t (call-interactively 'forward-word))))
17263 (defun org-check-for-hidden (what)
17264 "Check if there are hidden headlines/items in the current visual line.
17265 WHAT can be either `headlines' or `items'. If the current line is
17266 an outline or item heading and it has a folded subtree below it,
17267 this function returns t, nil otherwise."
17268 (let ((re (cond
17269 ((eq what 'headlines) (concat "^" org-outline-regexp))
17270 ((eq what 'items) (org-item-beginning-re))
17271 (t (error "This should not happen"))))
17272 beg end)
17273 (save-excursion
17274 (catch 'exit
17275 (unless (org-region-active-p)
17276 (setq beg (point-at-bol))
17277 (beginning-of-line 2)
17278 (while (and (not (eobp)) ;; this is like `next-line'
17279 (get-char-property (1- (point)) 'invisible))
17280 (beginning-of-line 2))
17281 (setq end (point))
17282 (goto-char beg)
17283 (goto-char (point-at-eol))
17284 (setq end (max end (point)))
17285 (while (re-search-forward re end t)
17286 (if (get-char-property (match-beginning 0) 'invisible)
17287 (throw 'exit t))))
17288 nil))))
17290 (defun org-metaup (&optional arg)
17291 "Move subtree up or move table row up.
17292 Calls `org-move-subtree-up' or `org-table-move-row' or
17293 `org-move-item-up', depending on context. See the individual commands
17294 for more information."
17295 (interactive "P")
17296 (cond
17297 ((run-hook-with-args-until-success 'org-metaup-hook))
17298 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
17299 ((org-on-heading-p) (call-interactively 'org-move-subtree-up))
17300 ((org-at-item-p) (call-interactively 'org-move-item-up))
17301 (t (transpose-lines 1) (beginning-of-line -1))))
17303 (defun org-metadown (&optional arg)
17304 "Move subtree down or move table row down.
17305 Calls `org-move-subtree-down' or `org-table-move-row' or
17306 `org-move-item-down', depending on context. See the individual
17307 commands for more information."
17308 (interactive "P")
17309 (cond
17310 ((run-hook-with-args-until-success 'org-metadown-hook))
17311 ((org-at-table-p) (call-interactively 'org-table-move-row))
17312 ((org-on-heading-p) (call-interactively 'org-move-subtree-down))
17313 ((org-at-item-p) (call-interactively 'org-move-item-down))
17314 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
17316 (defun org-shiftup (&optional arg)
17317 "Increase item in timestamp or increase priority of current headline.
17318 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
17319 depending on context. See the individual commands for more information."
17320 (interactive "P")
17321 (cond
17322 ((run-hook-with-args-until-success 'org-shiftup-hook))
17323 ((and org-support-shift-select (org-region-active-p))
17324 (org-call-for-shift-select 'previous-line))
17325 ((org-at-timestamp-p t)
17326 (call-interactively (if org-edit-timestamp-down-means-later
17327 'org-timestamp-down 'org-timestamp-up)))
17328 ((and (not (eq org-support-shift-select 'always))
17329 org-enable-priority-commands
17330 (org-on-heading-p))
17331 (call-interactively 'org-priority-up))
17332 ((and (not org-support-shift-select) (org-at-item-p))
17333 (call-interactively 'org-previous-item))
17334 ((org-clocktable-try-shift 'up arg))
17335 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
17336 (org-support-shift-select
17337 (org-call-for-shift-select 'previous-line))
17338 (t (org-shiftselect-error))))
17340 (defun org-shiftdown (&optional arg)
17341 "Decrease item in timestamp or decrease priority of current headline.
17342 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
17343 depending on context. See the individual commands for more information."
17344 (interactive "P")
17345 (cond
17346 ((run-hook-with-args-until-success 'org-shiftdown-hook))
17347 ((and org-support-shift-select (org-region-active-p))
17348 (org-call-for-shift-select 'next-line))
17349 ((org-at-timestamp-p t)
17350 (call-interactively (if org-edit-timestamp-down-means-later
17351 'org-timestamp-up 'org-timestamp-down)))
17352 ((and (not (eq org-support-shift-select 'always))
17353 org-enable-priority-commands
17354 (org-on-heading-p))
17355 (call-interactively 'org-priority-down))
17356 ((and (not org-support-shift-select) (org-at-item-p))
17357 (call-interactively 'org-next-item))
17358 ((org-clocktable-try-shift 'down arg))
17359 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
17360 (org-support-shift-select
17361 (org-call-for-shift-select 'next-line))
17362 (t (org-shiftselect-error))))
17364 (defun org-shiftright (&optional arg)
17365 "Cycle the thing at point or in the current line, depending on context.
17366 Depending on context, this does one of the following:
17368 - switch a timestamp at point one day into the future
17369 - on a headline, switch to the next TODO keyword.
17370 - on an item, switch entire list to the next bullet type
17371 - on a property line, switch to the next allowed value
17372 - on a clocktable definition line, move time block into the future"
17373 (interactive "P")
17374 (cond
17375 ((run-hook-with-args-until-success 'org-shiftright-hook))
17376 ((and org-support-shift-select (org-region-active-p))
17377 (org-call-for-shift-select 'forward-char))
17378 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
17379 ((and (not (eq org-support-shift-select 'always))
17380 (org-on-heading-p))
17381 (let ((org-inhibit-logging
17382 (not org-treat-S-cursor-todo-selection-as-state-change))
17383 (org-inhibit-blocking
17384 (not org-treat-S-cursor-todo-selection-as-state-change)))
17385 (org-call-with-arg 'org-todo 'right)))
17386 ((or (and org-support-shift-select
17387 (not (eq org-support-shift-select 'always))
17388 (org-at-item-bullet-p))
17389 (and (not org-support-shift-select) (org-at-item-p)))
17390 (org-call-with-arg 'org-cycle-list-bullet nil))
17391 ((and (not (eq org-support-shift-select 'always))
17392 (org-at-property-p))
17393 (call-interactively 'org-property-next-allowed-value))
17394 ((org-clocktable-try-shift 'right arg))
17395 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
17396 (org-support-shift-select
17397 (org-call-for-shift-select 'forward-char))
17398 (t (org-shiftselect-error))))
17400 (defun org-shiftleft (&optional arg)
17401 "Cycle the thing at point or in the current line, depending on context.
17402 Depending on context, this does one of the following:
17404 - switch a timestamp at point one day into the past
17405 - on a headline, switch to the previous TODO keyword.
17406 - on an item, switch entire list to the previous bullet type
17407 - on a property line, switch to the previous allowed value
17408 - on a clocktable definition line, move time block into the past"
17409 (interactive "P")
17410 (cond
17411 ((run-hook-with-args-until-success 'org-shiftleft-hook))
17412 ((and org-support-shift-select (org-region-active-p))
17413 (org-call-for-shift-select 'backward-char))
17414 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
17415 ((and (not (eq org-support-shift-select 'always))
17416 (org-on-heading-p))
17417 (let ((org-inhibit-logging
17418 (not org-treat-S-cursor-todo-selection-as-state-change))
17419 (org-inhibit-blocking
17420 (not org-treat-S-cursor-todo-selection-as-state-change)))
17421 (org-call-with-arg 'org-todo 'left)))
17422 ((or (and org-support-shift-select
17423 (not (eq org-support-shift-select 'always))
17424 (org-at-item-bullet-p))
17425 (and (not org-support-shift-select) (org-at-item-p)))
17426 (org-call-with-arg 'org-cycle-list-bullet 'previous))
17427 ((and (not (eq org-support-shift-select 'always))
17428 (org-at-property-p))
17429 (call-interactively 'org-property-previous-allowed-value))
17430 ((org-clocktable-try-shift 'left arg))
17431 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
17432 (org-support-shift-select
17433 (org-call-for-shift-select 'backward-char))
17434 (t (org-shiftselect-error))))
17436 (defun org-shiftcontrolright ()
17437 "Switch to next TODO set."
17438 (interactive)
17439 (cond
17440 ((and org-support-shift-select (org-region-active-p))
17441 (org-call-for-shift-select 'forward-word))
17442 ((and (not (eq org-support-shift-select 'always))
17443 (org-on-heading-p))
17444 (org-call-with-arg 'org-todo 'nextset))
17445 (org-support-shift-select
17446 (org-call-for-shift-select 'forward-word))
17447 (t (org-shiftselect-error))))
17449 (defun org-shiftcontrolleft ()
17450 "Switch to previous TODO set."
17451 (interactive)
17452 (cond
17453 ((and org-support-shift-select (org-region-active-p))
17454 (org-call-for-shift-select 'backward-word))
17455 ((and (not (eq org-support-shift-select 'always))
17456 (org-on-heading-p))
17457 (org-call-with-arg 'org-todo 'previousset))
17458 (org-support-shift-select
17459 (org-call-for-shift-select 'backward-word))
17460 (t (org-shiftselect-error))))
17462 (defun org-ctrl-c-ret ()
17463 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
17464 (interactive)
17465 (cond
17466 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
17467 (t (call-interactively 'org-insert-heading))))
17469 (defun org-copy-special ()
17470 "Copy region in table or copy current subtree.
17471 Calls `org-table-copy' or `org-copy-subtree', depending on context.
17472 See the individual commands for more information."
17473 (interactive)
17474 (call-interactively
17475 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
17477 (defun org-cut-special ()
17478 "Cut region in table or cut current subtree.
17479 Calls `org-table-copy' or `org-cut-subtree', depending on context.
17480 See the individual commands for more information."
17481 (interactive)
17482 (call-interactively
17483 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
17485 (defun org-paste-special (arg)
17486 "Paste rectangular region into table, or past subtree relative to level.
17487 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
17488 See the individual commands for more information."
17489 (interactive "P")
17490 (if (org-at-table-p)
17491 (org-table-paste-rectangle)
17492 (org-paste-subtree arg)))
17494 (defun org-edit-special (&optional arg)
17495 "Call a special editor for the stuff at point.
17496 When at a table, call the formula editor with `org-table-edit-formulas'.
17497 When at the first line of an src example, call `org-edit-src-code'.
17498 When in an #+include line, visit the include file. Otherwise call
17499 `ffap' to visit the file at point."
17500 (interactive)
17501 ;; possibly prep session before editing source
17502 (when arg
17503 (let* ((info (org-babel-get-src-block-info))
17504 (lang (nth 0 info))
17505 (params (nth 2 info))
17506 (session (cdr (assoc :session params))))
17507 (when (and info session) ;; we are in a source-code block with a session
17508 (funcall
17509 (intern (concat "org-babel-prep-session:" lang)) session params))))
17510 (cond ;; proceed with `org-edit-special'
17511 ((save-excursion
17512 (beginning-of-line 1)
17513 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
17514 (find-file (org-trim (match-string 1))))
17515 ((org-edit-src-code))
17516 ((org-edit-fixed-width-region))
17517 ((org-at-table.el-p)
17518 (org-edit-src-code))
17519 ((or (org-at-table-p)
17520 (save-excursion
17521 (beginning-of-line 1)
17523 (call-interactively 'org-table-edit-formulas))
17524 (t (call-interactively 'ffap))))
17526 (defun org-ctrl-c-ctrl-c (&optional arg)
17527 "Set tags in headline, or update according to changed information at point.
17529 This command does many different things, depending on context:
17531 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
17532 this is what we do.
17534 - If the cursor is on a statistics cookie, update it.
17536 - If the cursor is in a headline, prompt for tags and insert them
17537 into the current line, aligned to `org-tags-column'. When called
17538 with prefix arg, realign all tags in the current buffer.
17540 - If the cursor is in one of the special #+KEYWORD lines, this
17541 triggers scanning the buffer for these lines and updating the
17542 information.
17544 - If the cursor is inside a table, realign the table. This command
17545 works even if the automatic table editor has been turned off.
17547 - If the cursor is on a #+TBLFM line, re-apply the formulas to
17548 the entire table.
17550 - If the cursor is at a footnote reference or definition, jump to
17551 the corresponding definition or references, respectively.
17553 - If the cursor is a the beginning of a dynamic block, update it.
17555 - If the current buffer is a capture buffer, close note and file it.
17557 - If the cursor is on a <<<target>>>, update radio targets and
17558 corresponding links in this buffer.
17560 - If the cursor is on a numbered item in a plain list, renumber the
17561 ordered list.
17563 - If the cursor is on a checkbox, toggle it.
17565 - If the cursor is on a code block, evaluate it. The variable
17566 `org-confirm-babel-evaluate' can be used to control prompting
17567 before code block evaluation, by default every code block
17568 evaluation requires confirmation. Code block evaluation can be
17569 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
17570 (interactive "P")
17571 (let ((org-enable-table-editor t))
17572 (cond
17573 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
17574 org-occur-highlights
17575 org-latex-fragment-image-overlays)
17576 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
17577 (org-remove-occur-highlights)
17578 (org-remove-latex-fragment-image-overlays)
17579 (message "Temporary highlights/overlays removed from current buffer"))
17580 ((and (local-variable-p 'org-finish-function (current-buffer))
17581 (fboundp org-finish-function))
17582 (funcall org-finish-function))
17583 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
17584 ((or (looking-at org-property-start-re)
17585 (org-at-property-p))
17586 (call-interactively 'org-property-action))
17587 ((org-on-target-p) (call-interactively 'org-update-radio-target-regexp))
17589 (or (org-on-heading-p) (org-at-item-p)))
17590 (call-interactively 'org-update-statistics-cookies))
17591 ((org-on-heading-p) (call-interactively 'org-set-tags))
17592 ((org-at-table.el-p)
17593 (message "Use C-c ' to edit table.el tables"))
17594 ((org-at-table-p)
17595 (org-table-maybe-eval-formula)
17596 (if arg
17597 (call-interactively 'org-table-recalculate)
17598 (org-table-maybe-recalculate-line))
17599 (call-interactively 'org-table-align)
17600 (orgtbl-send-table 'maybe))
17601 ((or (org-footnote-at-reference-p)
17602 (org-footnote-at-definition-p))
17603 (call-interactively 'org-footnote-action))
17604 ((org-at-item-checkbox-p)
17605 ;; Cursor at a checkbox: repair list and update checkboxes. Send
17606 ;; list only if at top item.
17607 (let* ((cbox (match-string 1))
17608 (struct (org-list-struct))
17609 (old-struct (copy-tree struct))
17610 (parents (org-list-parents-alist struct))
17611 (prevs (org-list-prevs-alist struct))
17612 (orderedp (org-entry-get nil "ORDERED"))
17613 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
17614 block-item)
17615 ;; Use a light version of `org-toggle-checkbox' to avoid
17616 ;; computing list structure twice.
17617 (org-list-set-checkbox (point-at-bol) struct
17618 (cond
17619 ((equal arg '(16)) "[-]")
17620 ((equal arg '(4)) nil)
17621 ((equal "[X]" cbox) "[ ]")
17622 (t "[X]")))
17623 (org-list-struct-fix-ind struct parents)
17624 (org-list-struct-fix-bul struct prevs)
17625 (setq block-item
17626 (org-list-struct-fix-box struct parents prevs orderedp))
17627 (when block-item
17628 (message
17629 "Checkboxes were removed due to unchecked box at line %d"
17630 (org-current-line block-item)))
17631 (org-list-struct-apply-struct struct old-struct)
17632 (org-update-checkbox-count-maybe)
17633 (when firstp (org-list-send-list 'maybe))))
17634 ((org-at-item-p)
17635 ;; Cursor at an item: repair list. Do checkbox related actions
17636 ;; only if function was called with an argument. Send list only
17637 ;; if at top item.
17638 (let* ((struct (org-list-struct))
17639 (old-struct (copy-tree struct))
17640 (parents (org-list-parents-alist struct))
17641 (prevs (org-list-prevs-alist struct))
17642 (firstp (= (org-list-get-top-point struct) (point-at-bol))))
17643 (org-list-struct-fix-ind struct parents)
17644 (org-list-struct-fix-bul struct prevs)
17645 (when arg
17646 (org-list-set-checkbox (point-at-bol) struct "[ ]")
17647 (org-list-struct-fix-box struct parents prevs))
17648 (org-list-struct-apply-struct struct old-struct)
17649 (when arg (org-update-checkbox-count-maybe))
17650 (when firstp (org-list-send-list 'maybe))))
17651 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
17652 ;; Dynamic block
17653 (beginning-of-line 1)
17654 (save-excursion (org-update-dblock)))
17655 ((save-excursion
17656 (beginning-of-line 1)
17658 (cond
17659 ((equal (match-string 1) "TBLFM")
17660 ;; Recalculate the table before this line
17661 (save-excursion
17662 (beginning-of-line 1)
17664 (if (org-at-table-p)
17665 (org-call-with-arg 'org-table-recalculate (or arg t)))))
17666 (t
17667 (let ((org-inhibit-startup-visibility-stuff t)
17668 (org-startup-align-all-tables nil))
17669 (org-save-outline-visibility 'use-markers (org-mode-restart)))
17670 (message "Local setup has been refreshed"))))
17671 ((org-clock-update-time-maybe))
17672 (t (error "C-c C-c can do nothing useful at this location")))))
17674 (defun org-mode-restart ()
17675 "Restart Org-mode, to scan again for special lines.
17676 Also updates the keyword regular expressions."
17677 (interactive)
17678 (org-mode)
17679 (message "Org-mode restarted"))
17681 (defun org-kill-note-or-show-branches ()
17682 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
17683 (interactive)
17684 (if (not org-finish-function)
17685 (progn
17686 (hide-subtree)
17687 (call-interactively 'show-branches))
17688 (let ((org-note-abort t))
17689 (funcall org-finish-function))))
17691 (defun org-return (&optional indent)
17692 "Goto next table row or insert a newline.
17693 Calls `org-table-next-row' or `newline', depending on context.
17694 See the individual commands for more information."
17695 (interactive)
17696 (cond
17697 ((bobp) (if indent (newline-and-indent) (newline)))
17698 ((org-at-table-p)
17699 (org-table-justify-field-maybe)
17700 (call-interactively 'org-table-next-row))
17701 ;; when `newline-and-indent' is called within a list, make sure
17702 ;; text moved stays inside the item.
17703 ((and (org-in-item-p) indent)
17704 (if (and (org-at-item-p) (>= (point) (match-end 0)))
17705 (progn
17706 (newline)
17707 (org-indent-line-to (length (match-string 0))))
17708 (let ((ind (org-get-indentation)))
17709 (newline)
17710 (if (org-looking-back org-list-end-re)
17711 (org-indent-line-function)
17712 (org-indent-line-to ind)))))
17713 ((and org-return-follows-link
17714 (eq (get-text-property (point) 'face) 'org-link))
17715 (call-interactively 'org-open-at-point))
17716 ((and (org-at-heading-p)
17717 (looking-at
17719 (org-show-entry)
17720 (end-of-line 1)
17721 (newline))
17722 (t (if indent (newline-and-indent) (newline)))))
17724 (defun org-return-indent ()
17725 "Goto next table row or insert a newline and indent.
17726 Calls `org-table-next-row' or `newline-and-indent', depending on
17727 context. See the individual commands for more information."
17728 (interactive)
17729 (org-return t))
17731 (defun org-ctrl-c-star ()
17732 "Compute table, or change heading status of lines.
17733 Calls `org-table-recalculate' or `org-toggle-heading',
17734 depending on context."
17735 (interactive)
17736 (cond
17737 ((org-at-table-p)
17738 (call-interactively 'org-table-recalculate))
17739 (t
17740 ;; Convert all lines in region to list items
17741 (call-interactively 'org-toggle-heading))))
17743 (defun org-ctrl-c-minus ()
17744 "Insert separator line in table or modify bullet status of line.
17745 Also turns a plain line or a region of lines into list items.
17746 Calls `org-table-insert-hline', `org-toggle-item', or
17747 `org-cycle-list-bullet', depending on context."
17748 (interactive)
17749 (cond
17750 ((org-at-table-p)
17751 (call-interactively 'org-table-insert-hline))
17752 ((org-region-active-p)
17753 (call-interactively 'org-toggle-item))
17754 ((org-in-item-p)
17755 (call-interactively 'org-cycle-list-bullet))
17756 (t
17757 (call-interactively 'org-toggle-item))))
17759 (defun org-toggle-item (arg)
17760 "Convert headings or normal lines to items, items to normal lines.
17761 If there is no active region, only the current line is considered.
17763 If the first non blank line in the region is an headline, convert
17764 all headlines to items.
17766 If it is an item, convert all items to normal lines.
17768 If it is normal text, change region into an item. With a prefix
17769 argument ARG, change each line in region into an item."
17770 (interactive "P")
17771 (let (l2 l beg end)
17772 (if (org-region-active-p)
17773 (setq beg (region-beginning) end (region-end))
17774 (setq beg (point-at-bol)
17775 end (min (1+ (point-at-eol)) (point-max))))
17776 (org-with-limited-levels
17777 (save-excursion
17778 (goto-char end)
17779 (setq l2 (org-current-line))
17780 (goto-char beg)
17781 (beginning-of-line 1)
17782 ;; Ignore blank lines at beginning of region
17784 (beginning-of-line 1)
17785 (setq l (1- (org-current-line)))
17786 (cond
17787 ;; Case 1. Start at an item: de-itemize.
17788 ((org-at-item-p)
17789 (while (< (setq l (1+ l)) l2)
17790 (when (org-at-item-p)
17792 (delete-region (point) (match-end 0)))
17793 (beginning-of-line 2)))
17794 ;; Case 2. Start an an heading: convert to items.
17795 ((org-on-heading-p)
17796 (let* ((bul (org-list-bullet-string "-"))
17797 (len (length bul))
17798 (ind 0) (level 0))
17799 (while (< (setq l (1+ l)) l2)
17800 (cond
17801 ((looking-at outline-regexp)
17802 (let* ((lvl (org-reduced-level
17803 (- (length (match-string 0)) 2)))
17804 (s (concat (make-string (* len lvl) ? ) bul)))
17805 (replace-match s t t)
17806 (setq ind (length s) level lvl)))
17807 ;; Ignore blank lines and inline tasks.
17810 ;; Ensure normal text belongs to the new item.
17811 (t (org-indent-line-to (+ (max (- (org-get-indentation) level 2) 0)
17812 ind))))
17813 (beginning-of-line 2))))
17814 ;; Case 3. Normal line with ARG: turn each of them into items
17815 ;; unless they are already one.
17816 (arg
17817 (while (< (setq l (1+ l)) l2)
17818 (unless (or (org-on-heading-p) (org-at-item-p))
17820 (replace-match
17822 (beginning-of-line 2)))
17823 ;; Case 4. Normal line without ARG: make the first line of
17824 ;; region an item, and shift indentation of others
17825 ;; lines to set them as item's body.
17826 (t (let* ((bul (org-list-bullet-string "-"))
17827 (bul-len (length bul))
17828 (ref-ind (org-get-indentation)))
17830 (insert bul)
17831 (beginning-of-line 2)
17832 (while (and (< (setq l (1+ l)) l2) (< (point) end))
17833 ;; Ensure that lines less indented than first one
17834 ;; still get included in item body.
17835 (org-indent-line-to (+ (max ref-ind (org-get-indentation))
17836 bul-len))
17837 (beginning-of-line 2)))))))))
17839 (defun org-toggle-heading (&optional nstars)
17840 "Convert headings to normal text, or items or text to headings.
17841 If there is no active region, only the current line is considered.
17843 If the first non blank line is an headline, remove the stars from
17844 all headlines in the region.
17846 If it is a plain list item, turn all plain list items into headings.
17848 If it is a normal line, turn each and every normal line (i.e. not
17849 an heading or an item) in the region into a heading.
17851 When converting a line into a heading, the number of stars is chosen
17852 such that the lines become children of the current entry. However,
17853 when a prefix argument is given, its value determines the number of
17854 stars to add."
17855 (interactive "P")
17856 (let (l2 l itemp beg end)
17857 (if (org-region-active-p)
17858 (setq beg (region-beginning) end (copy-marker (region-end)))
17859 (setq beg (point-at-bol)
17860 end (min (1+ (point-at-eol)) (point-max))))
17861 ;; Ensure inline tasks don't count as headings.
17862 (org-with-limited-levels
17863 (save-excursion
17864 (goto-char end)
17865 (setq l2 (org-current-line))
17866 (goto-char beg)
17867 (beginning-of-line 1)
17868 ;; Ignore blank lines at beginning of region
17870 (beginning-of-line 1)
17871 (setq l (1- (org-current-line)))
17872 (cond
17873 ;; Case 1. Started at an heading: de-star headings.
17874 ((org-on-heading-p)
17875 (while (< (setq l (1+ l)) l2)
17876 (when (org-on-heading-p t)
17877 (looking-at outline-regexp) (replace-match ""))
17878 (beginning-of-line 2)))
17879 ;; Case 2. Started at an item: change items into headlines.
17880 ((org-at-item-p)
17881 (let ((stars (make-string
17882 (if nstars
17883 (prefix-numeric-value current-prefix-arg)
17884 (or (org-current-level) 0))
17885 ?*)))
17886 (while (< (point) end)
17887 (when (org-at-item-p)
17888 ;; Pay attention to cases when region ends before list.
17889 (let* ((struct (org-list-struct))
17890 (list-end (min (org-list-get-bottom-point struct) end)))
17891 (save-restriction
17892 (narrow-to-region (point) list-end)
17893 (insert
17894 (org-list-to-subtree
17895 (org-list-parse-list t)
17896 '(:istart (concat stars (funcall get-stars depth))
17897 :icount (concat stars
17898 (funcall get-stars depth))))))))
17899 (beginning-of-line 2))))
17900 ;; Case 3. Started at normal text: make every line an heading,
17901 ;; skipping headlines and items.
17902 (t (let* ((stars (make-string
17903 (if nstars
17904 (prefix-numeric-value current-prefix-arg)
17905 (or (org-current-level) 0))
17906 ?*))
17907 (add-stars (cond (nstars "")
17908 ((equal stars "") "*")
17909 (org-odd-levels-only "**")
17910 (t "*")))
17911 (rpl (concat stars add-stars " ")))
17912 (while (< (setq l (1+ l)) l2)
17913 (unless (or (org-on-heading-p) (org-at-item-p))
17915 (replace-match (concat rpl (match-string 2)))))
17916 (beginning-of-line 2)))))))))
17918 (defun org-meta-return (&optional arg)
17919 "Insert a new heading or wrap a region in a table.
17920 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
17921 See the individual commands for more information."
17922 (interactive "P")
17923 (cond
17924 ((run-hook-with-args-until-success 'org-metareturn-hook))
17925 ((org-at-table-p)
17926 (call-interactively 'org-table-wrap-region))
17927 (t (call-interactively 'org-insert-heading))))
17929 ;;; Menu entries
17931 ;; Define the Org-mode menus
17932 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
17933 '("Tbl"
17934 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
17935 ["Next Field" org-cycle (org-at-table-p)]
17936 ["Previous Field" org-shifttab (org-at-table-p)]
17937 ["Next Row" org-return (org-at-table-p)]
17938 "--"
17939 ["Blank Field" org-table-blank-field (org-at-table-p)]
17940 ["Edit Field" org-table-edit-field (org-at-table-p)]
17941 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
17942 "--"
17943 ("Column"
17944 ["Move Column Left" org-metaleft (org-at-table-p)]
17945 ["Move Column Right" org-metaright (org-at-table-p)]
17946 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
17947 ["Insert Column" org-shiftmetaright (org-at-table-p)])
17948 ("Row"
17949 ["Move Row Up" org-metaup (org-at-table-p)]
17950 ["Move Row Down" org-metadown (org-at-table-p)]
17951 ["Delete Row" org-shiftmetaup (org-at-table-p)]
17952 ["Insert Row" org-shiftmetadown (org-at-table-p)]
17953 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
17954 "--"
17955 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
17956 ("Rectangle"
17957 ["Copy Rectangle" org-copy-special (org-at-table-p)]
17958 ["Cut Rectangle" org-cut-special (org-at-table-p)]
17959 ["Paste Rectangle" org-paste-special (org-at-table-p)]
17960 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
17961 "--"
17962 ("Calculate"
17963 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
17964 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
17965 ["Edit Formulas" org-edit-special (org-at-table-p)]
17966 "--"
17967 ["Recalculate line" org-table-recalculate (org-at-table-p)]
17968 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
17969 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
17970 "--"
17971 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
17972 "--"
17973 ["Sum Column/Rectangle" org-table-sum
17974 (or (org-at-table-p) (org-region-active-p))]
17975 ["Which Column?" org-table-current-column (org-at-table-p)])
17976 ["Debug Formulas"
17977 org-table-toggle-formula-debugger
17978 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
17979 ["Show Col/Row Numbers"
17980 org-table-toggle-coordinate-overlays
17981 :style toggle
17982 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
17983 "--"
17984 ["Create" org-table-create (and (not (org-at-table-p))
17985 org-enable-table-editor)]
17986 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
17987 ["Import from File" org-table-import (not (org-at-table-p))]
17988 ["Export to File" org-table-export (org-at-table-p)]
17989 "--"
17990 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
17992 (easy-menu-define org-org-menu org-mode-map "Org menu"
17993 '("Org"
17994 ("Show/Hide"
17995 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
17996 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
17997 ["Sparse Tree..." org-sparse-tree t]
17998 ["Reveal Context" org-reveal t]
17999 ["Show All" show-all t]
18000 "--"
18001 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18002 "--"
18003 ["New Heading" org-insert-heading t]
18004 ("Navigate Headings"
18005 ["Up" outline-up-heading t]
18006 ["Next" outline-next-visible-heading t]
18007 ["Previous" outline-previous-visible-heading t]
18008 ["Next Same Level" outline-forward-same-level t]
18009 ["Previous Same Level" outline-backward-same-level t]
18010 "--"
18011 ["Jump" org-goto t])
18012 ("Edit Structure"
18013 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18014 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18015 "--"
18016 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18017 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18018 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18019 "--"
18020 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18021 "--"
18022 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18023 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18024 ["Demote Heading" org-metaright (not (org-at-table-p))]
18025 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18026 "--"
18027 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18028 "--"
18029 ["Convert to odd levels" org-convert-to-odd-levels t]
18030 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18031 ("Editing"
18032 ["Emphasis..." org-emphasize t]
18033 ["Edit Source Example" org-edit-special t]
18034 "--"
18035 ["Footnote new/jump" org-footnote-action t]
18036 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18037 ("Archive"
18038 ["Archive (default method)" org-archive-subtree-default t]
18039 "--"
18040 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18041 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18042 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18043 )
18044 "--"
18045 ("Hyperlinks"
18046 ["Store Link (Global)" org-store-link t]
18047 ["Find existing link to here" org-occur-link-in-agenda-files t]
18048 ["Insert Link" org-insert-link t]
18049 ["Follow Link" org-open-at-point t]
18050 "--"
18051 ["Next link" org-next-link t]
18052 ["Previous link" org-previous-link t]
18053 "--"
18054 ["Descriptive Links"
18055 (progn (add-to-invisibility-spec '(org-link)) (org-restart-font-lock))
18056 :style radio
18057 :selected (member '(org-link) buffer-invisibility-spec)]
18058 ["Literal Links"
18059 (progn
18060 (org-remove-from-invisibility-spec '(org-link)) (org-restart-font-lock))
18061 :style radio
18062 :selected (not (member '(org-link) buffer-invisibility-spec))])
18063 "--"
18064 ("TODO Lists"
18065 ["TODO/DONE/-" org-todo t]
18066 ("Select keyword"
18067 ["Next keyword" org-shiftright (org-on-heading-p)]
18068 ["Previous keyword" org-shiftleft (org-on-heading-p)]
18069 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18070 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))]
18071 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-on-heading-p))])
18072 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18073 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18074 "--"
18075 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18076 :selected org-enforce-todo-dependencies :style toggle :active t]
18077 "Settings for tree at point"
18078 ["Do Children sequentially" org-toggle-ordered-property :style radio
18079 :selected (org-entry-get nil "ORDERED")
18080 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18081 ["Do Children parallel" org-toggle-ordered-property :style radio
18082 :selected (not (org-entry-get nil "ORDERED"))
18083 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18084 "--"
18085 ["Set Priority" org-priority t]
18086 ["Priority Up" org-shiftup t]
18087 ["Priority Down" org-shiftdown t]
18088 "--"
18089 ["Get news from all feeds" org-feed-update-all t]
18090 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18091 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18092 ("TAGS and Properties"
18093 ["Set Tags" org-set-tags-command t]
18094 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18095 "--"
18096 ["Set property" org-set-property t]
18097 ["Column view of properties" org-columns t]
18098 ["Insert Column View DBlock" org-insert-columns-dblock t])
18099 ("Dates and Scheduling"
18100 ["Timestamp" org-time-stamp t]
18101 ["Timestamp (inactive)" org-time-stamp-inactive t]
18102 ("Change Date"
18103 ["1 Day Later" org-shiftright t]
18104 ["1 Day Earlier" org-shiftleft t]
18105 ["1 ... Later" org-shiftup t]
18106 ["1 ... Earlier" org-shiftdown t])
18107 ["Compute Time Range" org-evaluate-time-range t]
18108 ["Schedule Item" org-schedule t]
18109 ["Deadline" org-deadline t]
18110 "--"
18111 ["Custom time format" org-toggle-time-stamp-overlays
18112 :style radio :selected org-display-custom-times]
18113 "--"
18114 ["Goto Calendar" org-goto-calendar t]
18115 ["Date from Calendar" org-date-from-calendar t]
18116 "--"
18117 ["Start/Restart Timer" org-timer-start t]
18118 ["Pause/Continue Timer" org-timer-pause-or-continue t]
18119 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
18120 ["Insert Timer String" org-timer t]
18121 ["Insert Timer Item" org-timer-item t])
18122 ("Logging work"
18123 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
18124 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
18125 ["Clock out" org-clock-out t]
18126 ["Clock cancel" org-clock-cancel t]
18127 "--"
18128 ["Mark as default task" org-clock-mark-default-task t]
18129 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
18130 ["Goto running clock" org-clock-goto t]
18131 "--"
18132 ["Display times" org-clock-display t]
18133 ["Create clock table" org-clock-report t]
18134 "--"
18135 ["Record DONE time"
18136 (progn (setq org-log-done (not org-log-done))
18137 (message "Switching to %s will %s record a timestamp"
18138 (car org-done-keywords)
18139 (if org-log-done "automatically" "not")))
18140 :style toggle :selected org-log-done])
18141 "--"
18142 ["Agenda Command..." org-agenda t]
18143 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
18144 ("File List for Agenda")
18145 ("Special views current file"
18146 ["TODO Tree" org-show-todo-tree t]
18147 ["Check Deadlines" org-check-deadlines t]
18148 ["Timeline" org-timeline t]
18149 ["Tags/Property tree" org-match-sparse-tree t])
18150 "--"
18151 ["Export/Publish..." org-export t]
18152 ("LaTeX"
18153 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
18154 :selected org-cdlatex-mode]
18155 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
18156 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
18157 ["Modify math symbol" org-cdlatex-math-modify
18158 (org-inside-LaTeX-fragment-p)]
18159 ["Insert citation" org-reftex-citation t]
18160 "--"
18161 ["Template for BEAMER" org-insert-beamer-options-template t])
18162 "--"
18163 ("MobileOrg"
18164 ["Push Files and Views" org-mobile-push t]
18165 ["Get Captured and Flagged" org-mobile-pull t]
18166 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
18167 "--"
18168 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
18169 "--"
18170 ("Documentation"
18171 ["Show Version" org-version t]
18172 ["Info Documentation" org-info t])
18173 ("Customize"
18174 ["Browse Org Group" org-customize t]
18175 "--"
18176 ["Expand This Menu" org-create-customize-menu
18177 (fboundp 'customize-menu-create)])
18178 ["Send bug report" org-submit-bug-report t]
18179 "--"
18180 ("Refresh/Reload"
18181 ["Refresh setup current buffer" org-mode-restart t]
18182 ["Reload Org (after update)" org-reload t]
18183 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
18184 ))
18186 (defun org-info (&optional node)
18187 "Read documentation for Org-mode in the info system.
18188 With optional NODE, go directly to that node."
18189 (interactive)
18190 (info (format "(org)%s" (or node ""))))
18192 ;;;###autoload
18193 (defun org-submit-bug-report ()
18194 "Submit a bug report on Org-mode via mail.
18196 Don't hesitate to report any problems or inaccurate documentation.
18198 If you don't have setup sending mail from (X)Emacs, please copy the
18199 output buffer into your mail program, as it gives us important
18200 information about your Org-mode version and configuration."
18201 (interactive)
18202 (require 'reporter)
18203 (org-load-modules-maybe)
18204 (org-require-autoloaded-modules)
18205 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
18206 (reporter-submit-bug-report
18207 "emacs-orgmode@gnu.org"
18208 (org-version)
18209 (let (list)
18210 (save-window-excursion
18211 (switch-to-buffer (get-buffer-create "*Warn about privacy*"))
18212 (delete-other-windows)
18213 (erase-buffer)
18214 (insert "You are about to submit a bug report to the Org-mode mailing list.
18216 We would like to add your full Org-mode and Outline configuration to the
18217 bug report. This greatly simplifies the work of the maintainer and
18218 other experts on the mailing list.
18220 HOWEVER, some variables you have customized may contain private
18221 information. The names of customers, colleagues, or friends, might
18222 appear in the form of file names, tags, todo states, or search strings.
18223 If you answer yes to the prompt, you might want to check and remove
18224 such private information before sending the email.")
18225 (add-text-properties (point-min) (point-max) '(face org-warning))
18226 (when (yes-or-no-p "Include your Org-mode configuration ")
18227 (mapatoms
18228 (lambda (v)
18229 (and (boundp v)
18231 (or (and (symbol-value v)
18233 (and
18234 (get v 'custom-type) (get v 'standard-value)
18235 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
18236 (push v list)))))
18237 (kill-buffer (get-buffer "*Warn about privacy*"))
18238 list))
18239 nil nil
18240 "Remember to cover the basics, that is, what you expected to happen and
18241 what in fact did happen. You don't know how to make a good report? See
18243 http://orgmode.org/manual/Feedback.html#Feedback
18245 Your bug report will be posted to the Org-mode mailing list.
18246 ------------------------------------------------------------------------")
18247 (save-excursion
18252 (defun org-install-agenda-files-menu ()
18253 (let ((bl (buffer-list)))
18254 (save-excursion
18255 (while bl
18256 (set-buffer (pop bl))
18257 (if (org-mode-p) (setq bl nil)))
18258 (when (org-mode-p)
18259 (easy-menu-change
18260 '("Org") "File List for Agenda"
18261 (append
18262 (list
18263 ["Edit File List" (org-edit-agenda-file-list) t]
18264 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
18265 ["Remove Current File from List" org-remove-file t]
18266 ["Cycle through agenda files" org-cycle-agenda-files t]
18267 ["Occur in all agenda files" org-occur-in-agenda-files t]
18268 "--")
18269 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
18271 ;;;; Documentation
18273 ;;;###autoload
18274 (defun org-require-autoloaded-modules ()
18275 (interactive)
18276 (mapc 'require
18277 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
18278 org-docbook org-exp org-html org-icalendar
18279 org-id org-latex
18280 org-publish org-remember org-table
18281 org-timer org-xoxo)))
18283 ;;;###autoload
18284 (defun org-reload (&optional uncompiled)
18285 "Reload all org lisp files.
18286 With prefix arg UNCOMPILED, load the uncompiled versions."
18287 (interactive "P")
18288 (require 'find-func)
18290 (dir-org (file-name-directory (org-find-library-name "org")))
18291 (dir-org-contrib (ignore-errors
18292 (file-name-directory
18293 (org-find-library-name "org-contribdir"))))
18294 (babel-files
18295 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
18296 (append (list nil "comint" "eval" "exp" "keys"
18297 "lob" "ref" "table" "tangle")
18298 (delq nil
18299 (mapcar
18300 (lambda (lang)
18301 (when (cdr lang) (symbol-name (car lang))))
18302 org-babel-load-languages)))))
18303 (files
18304 (append (directory-files dir-org t file-re)
18305 babel-files
18306 (and dir-org-contrib
18307 (directory-files dir-org-contrib t file-re))))
18308 (remove-re (concat (if (featurep 'xemacs)
18309 "org-colview" "org-colview-xemacs")
18311 (setq files (mapcar 'file-name-sans-extension files))
18312 (setq files (mapcar
18313 (lambda (x) (if (string-match remove-re x) nil x))
18314 files))
18315 (setq files (delq nil files))
18316 (mapc
18317 (lambda (f)
18318 (when (featurep (intern (file-name-nondirectory f)))
18319 (if (and (not uncompiled)
18320 (file-exists-p (concat f ".elc")))
18321 (load (concat f ".elc") nil nil t)
18322 (load (concat f ".el") nil nil t))))
18323 files))
18324 (org-version))
18326 ;;;###autoload
18327 (defun org-customize ()
18328 "Call the customize function with org as argument."
18329 (interactive)
18330 (org-load-modules-maybe)
18331 (org-require-autoloaded-modules)
18332 (customize-browse 'org))
18334 (defun org-create-customize-menu ()
18335 "Create a full customization menu for Org-mode, insert it into the menu."
18336 (interactive)
18337 (org-load-modules-maybe)
18338 (org-require-autoloaded-modules)
18339 (if (fboundp 'customize-menu-create)
18340 (progn
18341 (easy-menu-change
18342 '("Org") "Customize"
18343 `(["Browse Org group" org-customize t]
18344 "--"
18345 ,(customize-menu-create 'org)
18346 ["Set" Custom-set t]
18347 ["Save" Custom-save t]
18348 ["Reset to Current" Custom-reset-current t]
18349 ["Reset to Saved" Custom-reset-saved t]
18350 ["Reset to Standard Settings" Custom-reset-standard t]))
18352 (error "Cannot expand menu (outdated version of cus-edit.el)")))
18354 ;;;; Miscellaneous stuff
18356 ;;; Generally useful functions
18358 (defun org-get-at-bol (property)
18359 "Get text property PROPERTY at beginning of line."
18360 (get-text-property (point-at-bol) property))
18362 (defun org-find-text-property-in-string (prop s)
18363 "Return the first non-nil value of property PROP in string S."
18364 (or (get-text-property 0 prop s)
18365 (get-text-property (or (next-single-property-change 0 prop s) 0)
18366 prop s)))
18368 (defun org-display-warning (message) ;; Copied from Emacs-Muse
18369 "Display the given MESSAGE as a warning."
18370 (if (fboundp 'display-warning)
18371 (display-warning 'org message
18372 (if (featurep 'xemacs) 'warning :warning))
18373 (let ((buf (get-buffer-create "*Org warnings*")))
18374 (with-current-buffer buf
18375 (goto-char (point-max))
18376 (insert "Warning (Org): " message)
18377 (unless (bolp)
18378 (newline)))
18379 (display-buffer buf)
18380 (sit-for 0))))
18382 (defun org-eval (form)
18383 "Eval FORM and return result."
18384 (condition-case error
18385 (eval form)
18386 (error (format "%%![Error: %s]" error))))
18388 (defun org-in-commented-line ()
18389 "Is point in a line starting with `#'?"
18390 (equal (char-after (point-at-bol)) ?#))
18392 (defun org-in-indented-comment-line ()
18393 "Is point in a line starting with `#' after some white space?"
18394 (save-excursion
18395 (save-match-data
18396 (goto-char (point-at-bol))
18399 (defun org-in-verbatim-emphasis ()
18400 (save-match-data
18401 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
18403 (defun org-goto-marker-or-bmk (marker &optional bookmark)
18404 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
18405 (if (and marker (marker-buffer marker)
18406 (buffer-live-p (marker-buffer marker)))
18407 (progn
18408 (switch-to-buffer (marker-buffer marker))
18409 (if (or (> marker (point-max)) (< marker (point-min)))
18410 (widen))
18411 (goto-char marker)
18412 (org-show-context 'org-goto))
18413 (if bookmark
18414 (bookmark-jump bookmark)
18415 (error "Cannot find location"))))
18417 (defun org-quote-csv-field (s)
18418 "Quote field for inclusion in CSV material."
18421 s))
18423 (defun org-force-self-insert (N)
18424 "Needed to enforce self-insert under remapping."
18425 (interactive "p")
18426 (self-insert-command N))
18428 (defun org-string-width (s)
18429 "Compute width of string, ignoring invisible characters.
18430 This ignores character with invisibility property `org-link', and also
18431 characters with property `org-cwidth', because these will become invisible
18432 upon the next fontification round."
18433 (let (b l)
18434 (when (or (eq t buffer-invisibility-spec)
18435 (assq 'org-link buffer-invisibility-spec))
18436 (while (setq b (text-property-any 0 (length s)
18437 'invisible 'org-link s))
18438 (setq s (concat (substring s 0 b)
18439 (substring s (or (next-single-property-change
18440 b 'invisible s) (length s)))))))
18441 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
18442 (setq s (concat (substring s 0 b)
18443 (substring s (or (next-single-property-change
18444 b 'org-cwidth s) (length s))))))
18445 (setq l (string-width s) b -1)
18446 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
18447 (setq l (- l (get-text-property b 'org-dwidth-n s))))
18448 l))
18450 (defun org-shorten-string (s maxlength)
18451 "Shorten string S so tht it is no longer than MAXLENGTH characters.
18452 If the string is shorter or has length MAXLENGTH, just return the
18453 original string. If it is longer, the functions finds a space in the
18454 string, breaks this string off at that locations and adds three dots
18455 as ellipsis. Including the ellipsis, the string will not be longer
18456 than MAXLENGTH. If finding a good breaking point in the string does
18457 not work, the string is just chopped off in the middle of a word
18458 if necessary."
18459 (if (<= (length s) maxlength)
18460 s
18461 (let* ((n (max (- maxlength 4) 1))
18463 (if (string-match re s)
18464 (concat (match-string 1 s) "...")
18465 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
18467 (defun org-get-indentation (&optional line)
18468 "Get the indentation of the current line, interpreting tabs.
18469 When LINE is given, assume it represents a line and compute its indentation."
18470 (if line
18471 (if (string-match "^ *" (org-remove-tabs line))
18472 (match-end 0))
18473 (save-excursion
18474 (beginning-of-line 1)
18476 (current-column))))
18478 (defun org-get-string-indentation (s)
18479 "What indentation has S due to SPACE and TAB at the beginning of the string?"
18480 (let ((n -1) (i 0) (w tab-width) c)
18481 (catch 'exit
18482 (while (< (setq n (1+ n)) (length s))
18483 (setq c (aref s n))
18484 (cond ((= c ?\ ) (setq i (1+ i)))
18486 (t (throw 'exit t)))))
18487 i))
18489 (defun org-remove-tabs (s &optional width)
18490 "Replace tabulators in S with spaces.
18491 Assumes that s is a single line, starting in column 0."
18492 (setq width (or width tab-width))
18494 (setq s (replace-match
18495 (make-string
18496 (- (* width (/ (+ (match-beginning 0) width) width))
18497 (match-beginning 0)) ?\ )
18498 t t s)))
18499 s)
18501 (defun org-fix-indentation (line ind)
18502 "Fix indentation in LINE.
18503 IND is a cons cell with target and minimum indentation.
18504 If the current indentation in LINE is smaller than the minimum,
18505 leave it alone. If it is larger than ind, set it to the target."
18506 (let* ((l (org-remove-tabs line))
18507 (i (org-get-indentation l))
18508 (i1 (car ind)) (i2 (cdr ind)))
18509 (if (>= i i2) (setq l (substring line i2)))
18510 (if (> i1 0)
18511 (concat (make-string i1 ?\ ) l)
18512 l)))
18514 (defun org-remove-indentation (code &optional n)
18515 "Remove the maximum common indentation from the lines in CODE.
18516 N may optionally be the number of spaces to remove."
18517 (with-temp-buffer
18518 (insert code)
18519 (org-do-remove-indentation n)
18520 (buffer-string)))
18522 (defun org-do-remove-indentation (&optional n)
18523 "Remove the maximum common indentation from the buffer."
18524 (untabify (point-min) (point-max))
18525 (let ((min 10000) re)
18526 (if n
18527 (setq min n)
18528 (goto-char (point-min))
18530 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
18531 (unless (or (= min 0) (= min 10000))
18533 (goto-char (point-min))
18534 (while (re-search-forward re nil t)
18535 (replace-match "")
18536 (end-of-line 1))
18537 min)))
18539 (defun org-fill-template (template alist)
18540 "Find each %key of ALIST in TEMPLATE and replace it."
18541 (let ((case-fold-search nil)
18542 entry key value)
18543 (setq alist (sort (copy-sequence alist)
18544 (lambda (a b) (< (length (car a)) (length (car b))))))
18545 (while (setq entry (pop alist))
18546 (setq template
18547 (replace-regexp-in-string
18548 (concat "%" (regexp-quote (car entry)))
18549 (cdr entry) template t t)))
18550 template))
18552 (defun org-base-buffer (buffer)
18553 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
18554 (if (not buffer)
18555 buffer
18556 (or (buffer-base-buffer buffer)
18557 buffer)))
18559 (defun org-trim (s)
18560 "Remove whitespace at beginning and end of string."
18563 s)
18565 (defun org-wrap (string &optional width lines)
18566 "Wrap string to either a number of lines, or a width in characters.
18567 If WIDTH is non-nil, the string is wrapped to that width, however many lines
18568 that costs. If there is a word longer than WIDTH, the text is actually
18569 wrapped to the length of that word.
18570 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
18571 many lines, whatever width that takes.
18572 The return value is a list of lines, without newlines at the end."
18574 (maxword (apply 'max (mapcar 'org-string-width words)))
18575 w ll)
18576 (cond (width
18577 (org-do-wrap words (max maxword width)))
18578 (lines
18579 (setq w maxword)
18580 (setq ll (org-do-wrap words maxword))
18581 (if (<= (length ll) lines)
18582 ll
18583 (setq ll words)
18584 (while (> (length ll) lines)
18585 (setq w (1+ w))
18586 (setq ll (org-do-wrap words w)))
18587 ll))
18588 (t (error "Cannot wrap this")))))
18590 (defun org-do-wrap (words width)
18591 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
18592 (let (lines line)
18593 (while words
18594 (setq line (pop words))
18595 (while (and words (< (+ (length line) (length (car words))) width))
18596 (setq line (concat line " " (pop words))))
18597 (setq lines (push line lines)))
18598 (nreverse lines)))
18600 (defun org-split-string (string &optional separators)
18601 "Splits STRING into substrings at SEPARATORS.
18602 No empty strings are returned if there are matches at the beginning
18603 and end of string."
18605 (start 0)
18606 notfirst
18607 (list nil))
18608 (while (and (string-match rexp string
18609 (if (and notfirst
18610 (= start (match-beginning 0))
18611 (< start (length string)))
18612 (1+ start) start))
18613 (< (match-beginning 0) (length string)))
18614 (setq notfirst t)
18615 (or (eq (match-beginning 0) 0)
18616 (and (eq (match-beginning 0) (match-end 0))
18617 (eq (match-beginning 0) start))
18618 (setq list
18619 (cons (substring string start (match-beginning 0))
18620 list)))
18621 (setq start (match-end 0)))
18622 (or (eq start (length string))
18623 (setq list
18624 (cons (substring string start)
18625 list)))
18626 (nreverse list)))
18628 (defun org-quote-vert (s)
18630 (while (string-match "|" s)
18632 s)
18634 (defun org-uuidgen-p (s)
18635 "Is S an ID created by UUIDGEN?"
18636 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
18638 (defun org-context ()
18639 "Return a list of contexts of the current cursor position.
18640 If several contexts apply, all are returned.
18641 Each context entry is a list with a symbol naming the context, and
18642 two positions indicating start and end of the context. Possible
18643 contexts are:
18645 :headline anywhere in a headline
18646 :headline-stars on the leading stars in a headline
18647 :todo-keyword on a TODO keyword (including DONE) in a headline
18648 :tags on the TAGS in a headline
18649 :priority on the priority cookie in a headline
18650 :item on the first line of a plain list item
18651 :item-bullet on the bullet/number of a plain list item
18652 :checkbox on the checkbox in a plain list item
18653 :table in an org-mode table
18654 :table-special on a special filed in a table
18655 :table-table in a table.el table
18656 :link on a hyperlink
18657 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
18658 :target on a <<target>>
18659 :radio-target on a <<<radio-target>>>
18660 :latex-fragment on a LaTeX fragment
18661 :latex-preview on a LaTeX fragment with overlayed preview image
18663 This function expects the position to be visible because it uses font-lock
18664 faces as a help to recognize the following contexts: :table-special, :link,
18665 and :keyword."
18666 (let* ((f (get-text-property (point) 'face))
18667 (faces (if (listp f) f (list f)))
18668 (p (point)) clist o)
18669 ;; First the large context
18670 (cond
18671 ((org-on-heading-p t)
18672 (push (list :headline (point-at-bol) (point-at-eol)) clist)
18673 (when (progn
18674 (beginning-of-line 1)
18675 (looking-at org-todo-line-tags-regexp))
18676 (push (org-point-in-group p 1 :headline-stars) clist)
18677 (push (org-point-in-group p 2 :todo-keyword) clist)
18678 (push (org-point-in-group p 4 :tags) clist))
18679 (goto-char p)
18682 (push (org-point-in-group p 0 :priority) clist)))
18684 ((org-at-item-p)
18685 (push (org-point-in-group p 2 :item-bullet) clist)
18686 (push (list :item (point-at-bol)
18687 (save-excursion (org-end-of-item) (point)))
18688 clist)
18689 (and (org-at-item-checkbox-p)
18690 (push (org-point-in-group p 0 :checkbox) clist)))
18692 ((org-at-table-p)
18693 (push (list :table (org-table-begin) (org-table-end)) clist)
18694 (if (memq 'org-formula faces)
18695 (push (list :table-special
18696 (previous-single-property-change p 'face)
18697 (next-single-property-change p 'face)) clist)))
18698 ((org-at-table-p 'any)
18699 (push (list :table-table) clist)))
18700 (goto-char p)
18702 ;; Now the small context
18703 (cond
18704 ((org-at-timestamp-p)
18705 (push (org-point-in-group p 0 :timestamp) clist))
18706 ((memq 'org-link faces)
18707 (push (list :link
18708 (previous-single-property-change p 'face)
18709 (next-single-property-change p 'face)) clist))
18710 ((memq 'org-special-keyword faces)
18711 (push (list :keyword
18712 (previous-single-property-change p 'face)
18713 (next-single-property-change p 'face)) clist))
18714 ((org-on-target-p)
18715 (push (org-point-in-group p 0 :target) clist)
18716 (goto-char (1- (match-beginning 0)))
18717 (if (looking-at org-radio-target-regexp)
18718 (push (org-point-in-group p 0 :radio-target) clist))
18719 (goto-char p))
18720 ((setq o (car (delq nil
18721 (mapcar
18722 (lambda (x)
18723 (if (memq x org-latex-fragment-image-overlays) x))
18724 (overlays-at (point))))))
18725 (push (list :latex-fragment
18726 (overlay-start o) (overlay-end o)) clist)
18727 (push (list :latex-preview
18728 (overlay-start o) (overlay-end o)) clist))
18729 ((org-inside-LaTeX-fragment-p)
18730 ;; FIXME: positions wrong.
18731 (push (list :latex-fragment (point) (point)) clist)))
18733 (setq clist (nreverse (delq nil clist)))
18734 clist))
18736 ;; FIXME: Compare with at-regexp-p Do we need both?
18737 (defun org-in-regexp (re &optional nlines visually)
18738 "Check if point is inside a match of regexp.
18739 Normally only the current line is checked, but you can include NLINES extra
18740 lines both before and after point into the search.
18741 If VISUALLY is set, require that the cursor is not after the match but
18742 really on, so that the block visually is on the match."
18743 (catch 'exit
18744 (let ((pos (point))
18745 (eol (point-at-eol (+ 1 (or nlines 0))))
18746 (inc (if visually 1 0)))
18747 (save-excursion
18748 (beginning-of-line (- 1 (or nlines 0)))
18749 (while (re-search-forward re eol t)
18750 (if (and (<= (match-beginning 0) pos)
18751 (>= (+ inc (match-end 0)) pos))
18752 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
18754 (defun org-at-regexp-p (regexp)
18755 "Is point inside a match of REGEXP in the current line?"
18756 (catch 'exit
18757 (save-excursion
18758 (let ((pos (point)) (end (point-at-eol)))
18759 (beginning-of-line 1)
18760 (while (re-search-forward regexp end t)
18761 (if (and (<= (match-beginning 0) pos)
18762 (>= (match-end 0) pos))
18763 (throw 'exit t)))
18764 nil))))
18766 (defun org-in-regexps-block-p (start-re end-re &optional bound)
18767 "Return t if the current point is between matches of START-RE and END-RE.
18768 This will also return t if point is on one of the two matches or
18769 in an unfinished block. END-RE can be a string or a form
18770 returning a string.
18772 An optional third argument bounds the search for START-RE. It
18773 defaults to previous heading or `point-min'."
18774 (let ((pos (point))
18775 (limit (or bound (save-excursion (outline-previous-heading)))))
18776 (save-excursion
18777 ;; we're on a block when point is on start-re...
18778 (or (org-at-regexp-p start-re)
18779 ;; ... or start-re can be found above...
18780 (and (re-search-backward start-re limit t)
18781 ;; ... but no end-re between start-re and point.
18782 (not (re-search-forward (eval end-re) pos t)))))))
18784 (defun org-occur-in-agenda-files (regexp &optional nlines)
18785 "Call `multi-occur' with buffers for all agenda files."
18787 (let* ((files (org-agenda-files))
18788 (tnames (mapcar 'file-truename files))
18789 (extra org-agenda-text-search-extra-files)
18790 f)
18791 (when (eq (car extra) 'agenda-archives)
18792 (setq extra (cdr extra))
18793 (setq files (org-add-archive-files files)))
18794 (while (setq f (pop extra))
18795 (unless (member (file-truename f) tnames)
18796 (add-to-list 'files f 'append)
18797 (add-to-list 'tnames (file-truename f) 'append)))
18798 (multi-occur
18799 (mapcar (lambda (x)
18800 (with-current-buffer
18801 (or (get-file-buffer x) (find-file-noselect x))
18802 (widen)
18803 (current-buffer)))
18804 files)
18805 regexp)))
18807 (if (boundp 'occur-mode-find-occurrence-hook)
18808 ;; Emacs 23
18809 (add-hook 'occur-mode-find-occurrence-hook
18810 (lambda ()
18811 (when (org-mode-p)
18812 (org-reveal))))
18813 ;; Emacs 22
18814 (defadvice occur-mode-goto-occurrence
18815 (after org-occur-reveal activate)
18816 (and (org-mode-p) (org-reveal)))
18817 (defadvice occur-mode-goto-occurrence-other-window
18818 (after org-occur-reveal activate)
18819 (and (org-mode-p) (org-reveal)))
18820 (defadvice occur-mode-display-occurrence
18821 (after org-occur-reveal activate)
18822 (when (org-mode-p)
18823 (let ((pos (occur-mode-find-occurrence)))
18824 (with-current-buffer (marker-buffer pos)
18825 (save-excursion
18826 (goto-char pos)
18827 (org-reveal)))))))
18829 (defun org-occur-link-in-agenda-files ()
18830 "Create a link and search for it in the agendas.
18831 The link is not stored in `org-stored-links', it is just created
18832 for the search purpose."
18833 (interactive)
18834 (let ((link (condition-case nil
18835 (org-store-link nil)
18836 (error "Unable to create a link to here"))))
18837 (org-occur-in-agenda-files (regexp-quote link))))
18839 (defun org-uniquify (list)
18840 "Remove duplicate elements from LIST."
18841 (let (res)
18842 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
18843 res))
18845 (defun org-delete-all (elts list)
18846 "Remove all elements in ELTS from LIST."
18847 (while elts
18848 (setq list (delete (pop elts) list)))
18849 list)
18851 (defun org-count (cl-item cl-seq)
18852 "Count the number of occurrences of ITEM in SEQ.
18853 Taken from `count' in cl-seq.el with all keyword arguments removed."
18854 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
18855 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
18856 (while (< cl-start cl-end)
18857 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
18858 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
18859 (setq cl-start (1+ cl-start)))
18860 cl-count))
18862 (defun org-remove-if (predicate seq)
18863 "Remove everything from SEQ that fulfills PREDICATE."
18864 (let (res e)
18865 (while seq
18866 (setq e (pop seq))
18867 (if (not (funcall predicate e)) (push e res)))
18868 (nreverse res)))
18870 (defun org-remove-if-not (predicate seq)
18871 "Remove everything from SEQ that does not fulfill PREDICATE."
18872 (let (res e)
18873 (while seq
18874 (setq e (pop seq))
18875 (if (funcall predicate e) (push e res)))
18876 (nreverse res)))
18878 (defun org-back-over-empty-lines ()
18879 "Move backwards over whitespace, to the beginning of the first empty line.
18880 Returns the number of empty lines passed."
18881 (let ((pos (point)))
18882 (if (cdr (assoc 'heading org-blank-before-new-entry))
18884 (forward-line -1))
18885 (beginning-of-line 2)
18886 (goto-char (min (point) pos))
18887 (count-lines (point) pos)))
18889 (defun org-skip-whitespace ()
18892 (defun org-point-in-group (point group &optional context)
18893 "Check if POINT is in match-group GROUP.
18894 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
18895 match. If the match group does not exist or point is not inside it,
18896 return nil."
18897 (and (match-beginning group)
18898 (>= point (match-beginning group))
18899 (<= point (match-end group))
18900 (if context
18901 (list context (match-beginning group) (match-end group))
18902 t)))
18904 (defun org-switch-to-buffer-other-window (&rest args)
18905 "Switch to buffer in a second window on the current frame.
18906 In particular, do not allow pop-up frames.
18907 Returns the newly created buffer."
18908 (let (pop-up-frames special-display-buffer-names special-display-regexps
18909 special-display-function)
18910 (apply 'switch-to-buffer-other-window args)))
18912 (defun org-combine-plists (&rest plists)
18913 "Create a single property list from all plists in PLISTS.
18914 The process starts by copying the first list, and then setting properties
18915 from the other lists. Settings in the last list are the most significant
18916 ones and overrule settings in the other lists."
18917 (let ((rtn (copy-sequence (pop plists)))
18918 p v ls)
18919 (while plists
18920 (setq ls (pop plists))
18921 (while ls
18922 (setq p (pop ls) v (pop ls))
18923 (setq rtn (plist-put rtn p v))))
18924 rtn))
18926 (defun org-move-line-down (arg)
18927 "Move the current line down. With prefix argument, move it past ARG lines."
18928 (interactive "p")
18929 (let ((col (current-column))
18930 beg end pos)
18931 (beginning-of-line 1) (setq beg (point))
18932 (beginning-of-line 2) (setq end (point))
18933 (beginning-of-line (+ 1 arg))
18934 (setq pos (move-marker (make-marker) (point)))
18935 (insert (delete-and-extract-region beg end))
18936 (goto-char pos)
18937 (org-move-to-column col)))
18939 (defun org-move-line-up (arg)
18940 "Move the current line up. With prefix argument, move it past ARG lines."
18941 (interactive "p")
18942 (let ((col (current-column))
18943 beg end pos)
18944 (beginning-of-line 1) (setq beg (point))
18945 (beginning-of-line 2) (setq end (point))
18946 (beginning-of-line (- arg))
18947 (setq pos (move-marker (make-marker) (point)))
18948 (insert (delete-and-extract-region beg end))
18949 (goto-char pos)
18950 (org-move-to-column col)))
18952 (defun org-replace-escapes (string table)
18953 "Replace %-escapes in STRING with values in TABLE.
18955 The sequences in STRING may contain normal field width and padding information,
18957 so values can contain further %-escapes if they are define later in TABLE."
18958 (let ((tbl (copy-alist table))
18959 (case-fold-search nil)
18960 (pchg 0)
18961 e re rpl)
18962 (while (setq e (pop tbl))
18963 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
18964 (when (and (cdr e) (string-match re (cdr e)))
18965 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
18966 (safe "SREF"))
18967 (add-text-properties 0 3 (list 'sref sref) safe)
18968 (setcdr e (replace-match safe t t (cdr e)))))
18969 (while (string-match re string)
18970 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
18971 (cdr e)))
18972 (setq string (replace-match rpl t t string))))
18973 (while (setq pchg (next-property-change pchg string))
18974 (let ((sref (get-text-property pchg 'sref string)))
18975 (when (and sref (string-match "SREF" string pchg))
18976 (setq string (replace-match sref t t string)))))
18977 string))
18979 (defun org-sublist (list start end)
18980 "Return a section of LIST, from START to END.
18981 Counting starts at 1."
18982 (let (rtn (c start))
18983 (setq list (nthcdr (1- start) list))
18984 (while (and list (<= c end))
18985 (push (pop list) rtn)
18986 (setq c (1+ c)))
18987 (nreverse rtn)))
18989 (defun org-find-base-buffer-visiting (file)
18990 "Like `find-buffer-visiting' but always return the base buffer and
18991 not an indirect buffer."
18992 (let ((buf (or (get-file-buffer file)
18993 (find-buffer-visiting file))))
18994 (if buf
18995 (or (buffer-base-buffer buf) buf)
18996 nil)))
18998 (defun org-image-file-name-regexp (&optional extensions)
18999 "Return regexp matching the file names of images.
19000 If EXTENSIONS is given, only match these."
19001 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19002 (image-file-name-regexp)
19003 (let ((image-file-name-extensions
19004 (or extensions
19005 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19006 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19008 (regexp-opt (nconc (mapcar 'upcase
19009 image-file-name-extensions)
19010 image-file-name-extensions)
19011 t)
19014 (defun org-file-image-p (file &optional extensions)
19015 "Return non-nil if FILE is an image."
19016 (save-match-data
19017 (string-match (org-image-file-name-regexp extensions) file)))
19019 (defun org-get-cursor-date ()
19020 "Return the date at cursor in as a time.
19021 This works in the calendar and in the agenda, anywhere else it just
19022 returns the current time."
19023 (let (date day defd)
19024 (cond
19025 ((eq major-mode 'calendar-mode)
19026 (setq date (calendar-cursor-to-date)
19027 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19028 ((eq major-mode 'org-agenda-mode)
19029 (setq day (get-text-property (point) 'day))
19030 (if day
19031 (setq date (calendar-gregorian-from-absolute day)
19032 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19033 (nth 2 date))))))
19034 (or defd (current-time))))
19036 (defvar org-agenda-action-marker (make-marker)
19037 "Marker pointing to the entry for the next agenda action.")
19039 (defun org-mark-entry-for-agenda-action ()
19040 "Mark the current entry as target of an agenda action.
19041 Agenda actions are actions executed from the agenda with the key `k',
19042 which make use of the date at the cursor."
19043 (interactive)
19044 (move-marker org-agenda-action-marker
19045 (save-excursion (org-back-to-heading t) (point))
19046 (current-buffer))
19047 (message
19048 "Entry marked for action; press `k' at desired date in agenda or calendar"))
19050 (defun org-mark-subtree ()
19051 "Mark the current subtree.
19052 This puts point at the start of the current subtree, and mark at the end.
19054 If point is in an inline task, mark that task instead."
19055 (interactive)
19056 (let ((inline-task-p
19057 (and (featurep 'org-inlinetask)
19058 (org-inlinetask-in-task-p)))
19059 (beg))
19060 ;; Get beginning of subtree
19061 (cond
19062 (inline-task-p (org-inlinetask-goto-beginning))
19063 ((org-at-heading-p) (beginning-of-line))
19064 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
19065 (setq beg (point))
19066 ;; Get end of it
19067 (if inline-task-p
19068 (org-inlinetask-goto-end)
19069 (org-end-of-subtree))
19070 ;; Mark zone
19071 (push-mark (point) nil t)
19072 (goto-char beg)))
19074 ;;; Paragraph filling stuff.
19075 ;; We want this to be just right, so use the full arsenal.
19077 (defun org-indent-line-function ()
19078 "Indent line depending on context."
19079 (interactive)
19080 (let* ((pos (point))
19081 (itemp (org-at-item-p))
19082 (case-fold-search t)
19084 (inline-task-p (and (featurep 'org-inlinetask)
19085 (org-inlinetask-in-task-p)))
19086 (inline-re (and inline-task-p
19087 (org-inlinetask-outline-regexp)))
19088 column)
19089 (beginning-of-line 1)
19090 (cond
19091 ;; Comments
19092 ((looking-at "# ") (setq column 0))
19093 ;; Headings
19095 ;; Included files
19097 ;; Footnote definition
19098 ((looking-at org-footnote-definition-re) (setq column 0))
19099 ;; Literal examples
19101 (setq column (org-get-indentation))) ; do nothing
19102 ;; Lists
19103 ((ignore-errors (goto-char (org-in-item-p)))
19104 (setq column (if itemp
19105 (org-get-indentation)
19106 (org-list-item-body-column (point))))
19107 (goto-char pos))
19108 ;; Drawers
19110 (save-excursion (re-search-backward org-drawer-regexp nil t)))
19111 (save-excursion
19112 (goto-char (1- (match-beginning 1)))
19113 (setq column (current-column))))
19114 ;; Special blocks
19116 (save-excursion
19117 (re-search-backward
19119 (setq column (org-get-indentation (match-string 0))))
19122 (save-excursion
19124 (setq column
19125 (if (equal (downcase (match-string 1)) "src")
19126 ;; src blocks: let `org-edit-src-exit' handle them
19127 (org-get-indentation)
19128 (org-get-indentation (match-string 0)))))
19129 ;; This line has nothing special, look at the previous relevant
19130 ;; line to compute indentation
19131 (t
19132 (beginning-of-line 0)
19133 (while (and (not (bobp))
19134 (not (looking-at org-drawer-regexp))
19135 ;; When point started in an inline task, do not move
19136 ;; above task starting line.
19137 (not (and inline-task-p (looking-at inline-re)))
19138 ;; Skip drawers, blocks, empty lines, verbatim,
19139 ;; comments, tables, footnotes definitions, lists,
19140 ;; inline tasks.
19142 (re-search-backward org-drawer-regexp nil t))
19146 (looking-at org-footnote-definition-re)
19147 (and (ignore-errors (goto-char (org-in-item-p)))
19148 (goto-char
19149 (org-list-get-top-point (org-list-struct))))
19150 (and (not inline-task-p)
19151 (featurep 'org-inlinetask)
19152 (org-inlinetask-in-task-p)
19153 (or (org-inlinetask-goto-beginning) t))))
19154 (beginning-of-line 0))
19155 (cond
19156 ;; There was an heading above.
19158 (if (not org-adapt-indentation)
19159 (setq column 0)
19160 (goto-char (match-end 0))
19161 (setq column (current-column))))
19162 ;; A drawer had started and is unfinished
19163 ((looking-at org-drawer-regexp)
19164 (goto-char (1- (match-beginning 1)))
19165 (setq column (current-column)))
19166 ;; Else, nothing noticeable found: get indentation and go on.
19167 (t (setq column (org-get-indentation))))))
19168 ;; Now apply indentation and move cursor accordingly
19169 (goto-char pos)
19170 (if (<= (current-column) (current-indentation))
19171 (org-indent-line-to column)
19172 (save-excursion (org-indent-line-to column)))
19173 ;; Special polishing for properties, see `org-property-format'
19174 (setq column (current-column))
19175 (beginning-of-line 1)
19176 (if (looking-at
19178 (replace-match (concat (match-string 1)
19179 (format org-property-format
19180 (match-string 2) (match-string 3)))
19181 t t))
19182 (org-move-to-column column)))
19184 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
19185 "Variable to store copy of `adaptive-fill-regexp'.
19186 Since `adaptive-fill-regexp' is set to never match, we need to
19187 store a backup of its value before entering `org-mode' so that
19188 the functionality can be provided as a fall-back.")
19190 (defun org-set-autofill-regexps ()
19191 (interactive)
19192 ;; In the paragraph separator we include headlines, because filling
19193 ;; text in a line directly attached to a headline would otherwise
19194 ;; fill the headline as well.
19197 ;; The paragraph starter includes hand-formatted lists.
19198 (org-set-local
19199 'paragraph-start
19200 (concat
19209 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
19210 ;; But only if the user has not turned off tables or fixed-width regions
19211 (org-set-local
19212 'auto-fill-inhibit-regexp
19215 (if (or org-enable-table-editor org-enable-fixed-width-editor)
19216 (concat
19218 (if org-enable-table-editor "|" "")
19219 (if org-enable-fixed-width-editor ":" "")
19220 "]"))))
19221 ;; We use our own fill-paragraph function, to make sure that tables
19222 ;; and fixed-width regions are not wrapped. That function will pass
19223 ;; through to `fill-paragraph' when appropriate.
19224 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
19225 ;; Prevent auto-fill from inserting unwanted new items.
19226 (org-set-local 'fill-nobreak-predicate
19227 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
19228 fill-nobreak-predicate
19229 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate)))
19230 ;; Adaptive filling: To get full control, first make sure that
19231 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
19232 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
19233 (org-set-local 'org-adaptive-fill-regexp-backup
19234 adaptive-fill-regexp))
19236 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
19237 (org-set-local 'adaptive-fill-function
19238 'org-adaptive-fill-function)
19239 (org-set-local
19240 'align-mode-rules-list
19241 '((org-in-buffer-settings
19243 (modes . '(org-mode))))))
19245 (defun org-fill-item-nobreak-p ()
19246 "Non-nil when a line break at point would insert a new item."
19247 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
19249 (defun org-fill-paragraph (&optional justify)
19250 "Re-align a table, pass through to fill-paragraph if no table."
19251 (let ((table-p (org-at-table-p))
19252 (table.el-p (org-at-table.el-p))
19253 (itemp (org-in-item-p)))
19254 (cond ((and (equal (char-after (point-at-bol)) ?*)
19255 (save-excursion (goto-char (point-at-bol))
19256 (looking-at outline-regexp)))
19257 t) ; skip headlines
19258 (table.el-p t) ; skip table.el tables
19259 (table-p (org-table-align) t) ; align Org tables
19260 (itemp ; align text in items
19261 (let* ((struct (save-excursion (goto-char itemp)
19262 (org-list-struct)))
19263 (parents (org-list-parents-alist struct))
19264 (children (org-list-get-children itemp struct parents))
19265 beg end prev next prefix)
19266 ;; Determine in which part of item point is: before
19267 ;; first child, after last child, between two
19268 ;; sub-lists, or simply in item if there's no child.
19269 (cond
19270 ((not children)
19271 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19272 beg itemp
19273 end (org-list-get-item-end itemp struct)))
19274 ((< (point) (setq next (car children)))
19275 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
19276 beg itemp
19277 end next))
19278 ((> (point) (setq prev (car (last children))))
19279 (setq beg (org-list-get-item-end prev struct)
19280 end (org-list-get-item-end itemp struct)
19281 prefix (save-excursion
19282 (goto-char beg)
19284 (make-string (current-column) ?\ ))))
19285 (t (catch 'exit
19286 (while (setq next (pop children))
19287 (if (> (point) next)
19288 (setq prev next)
19289 (setq beg (org-list-get-item-end prev struct)
19290 end next
19291 prefix (save-excursion
19292 (goto-char beg)
19294 (make-string (current-column) ?\ )))
19295 (throw 'exit nil))))))
19296 ;; Use `fill-paragraph' with buffer narrowed to item
19297 ;; without any child, and with our computed PREFIX.
19298 (flet ((fill-context-prefix (from to &optional flr) prefix))
19299 (save-restriction
19300 (narrow-to-region beg end)
19301 (save-excursion (fill-paragraph justify)))) t))
19302 ;; Special case where point is not in a list but is on
19303 ;; a paragraph adjacent to a list: make sure this paragraph
19304 ;; doesn't get merged with the end of the list by narrowing
19305 ;; buffer first.
19306 ((save-excursion (forward-paragraph -1)
19307 (setq itemp (org-in-item-p)))
19308 (let ((struct (save-excursion (goto-char itemp)
19309 (org-list-struct))))
19310 (save-restriction
19311 (narrow-to-region (org-list-get-bottom-point struct)
19312 (save-excursion (forward-paragraph 1)
19313 (point)))
19314 (fill-paragraph justify) t)))
19315 ;; Else simply call `fill-paragraph'.
19316 (t nil))))
19318 ;; For reference, this is the default value of adaptive-fill-regexp
19321 (defun org-adaptive-fill-function ()
19322 "Return a fill prefix for org-mode files."
19323 (let (itemp)
19324 (save-excursion
19325 (cond
19326 ;; Comment line
19328 (match-string-no-properties 0))
19329 ;; Plain list item
19330 ((org-at-item-p)
19331 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
19332 ;; Point is in a list after `backward-paragraph': original
19333 ;; point wasn't in the list, or filling would have been taken
19334 ;; care of by `org-auto-fill-function', but the list and the
19335 ;; real paragraph are not separated by a blank line. Thus, move
19336 ;; point after the list to go back to real paragraph and
19337 ;; determine fill-prefix.
19338 ((setq itemp (org-in-item-p))
19339 (goto-char itemp)
19340 (let* ((struct (org-list-struct))
19341 (bottom (org-list-get-bottom-point struct)))
19342 (goto-char bottom)
19343 (make-string (org-get-indentation) ?\ )))
19344 ;; Other text
19345 ((looking-at org-adaptive-fill-regexp-backup)
19346 (match-string-no-properties 0))))))
19348 (defun org-auto-fill-function ()
19349 "Auto-fill function."
19350 (let (itemp prefix)
19351 ;; When in a list, compute an appropriate fill-prefix and make
19352 ;; sure it will be used by `do-auto-fill'.
19353 (if (setq itemp (org-in-item-p))
19354 (progn
19355 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
19356 (flet ((fill-context-prefix (from to &optional flr) prefix))
19357 (do-auto-fill)))
19358 ;; Else just use `do-auto-fill'.
19359 (do-auto-fill))))
19361 ;;; Other stuff.
19363 (defun org-toggle-fixed-width-section (arg)
19364 "Toggle the fixed-width export.
19365 If there is no active region, the QUOTE keyword at the current headline is
19366 inserted or removed. When present, it causes the text between this headline
19367 and the next to be exported as fixed-width text, and unmodified.
19368 If there is an active region, this command adds or removes a colon as the
19369 first character of this line. If the first character of a line is a colon,
19370 this line is also exported in fixed-width font."
19371 (interactive "P")
19372 (let* ((cc 0)
19373 (regionp (org-region-active-p))
19374 (beg (if regionp (region-beginning) (point)))
19375 (end (if regionp (region-end)))
19376 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
19377 (case-fold-search nil)
19379 off)
19380 (if regionp
19381 (save-excursion
19382 (goto-char beg)
19383 (setq cc (current-column))
19384 (beginning-of-line 1)
19385 (setq off (looking-at re))
19386 (while (> nlines 0)
19387 (setq nlines (1- nlines))
19388 (beginning-of-line 1)
19389 (cond
19390 (arg
19391 (org-move-to-column cc t)
19393 (forward-line -1))
19394 ((and off (looking-at re))
19395 (replace-match "" t t nil 1))
19396 ((not off) (org-move-to-column cc t) (insert ": ")))
19397 (forward-line 1)))
19398 (save-excursion
19399 (org-back-to-heading)
19400 (if (looking-at (concat outline-regexp
19402 (replace-match "" t t nil 1)
19403 (if (looking-at outline-regexp)
19404 (progn
19405 (goto-char (match-end 0))
19406 (insert org-quote-string " "))))))))
19408 (defun org-reftex-citation ()
19409 "Use reftex-citation to insert a citation into the buffer.
19410 This looks for a line like
19412 #+BIBLIOGRAPHY: foo plain option:-d
19414 and derives from it that foo.bib is the bibliography file relevant
19415 for this document. It then installs the necessary environment for RefTeX
19416 to work in this buffer and calls `reftex-citation' to insert a citation
19417 into the buffer.
19419 Export of such citations to both LaTeX and HTML is handled by the contributed
19420 package org-exp-bibtex by Taru Karttunen."
19421 (interactive)
19422 (let ((reftex-docstruct-symbol 'rds)
19424 rds bib)
19425 (save-excursion
19426 (save-restriction
19427 (widen)
19428 (let ((case-fold-search t)
19430 (if (not (save-excursion
19431 (or (re-search-forward re nil t)
19432 (re-search-backward re nil t))))
19433 (error "No bibliography defined in file")
19434 (setq bib (concat (match-string 1) ".bib")
19435 rds (list (list 'bib bib)))))))
19436 (call-interactively 'reftex-citation)))
19438 ;;;; Functions extending outline functionality
19440 (defun org-beginning-of-line (&optional arg)
19441 "Go to the beginning of the current line. If that is invisible, continue
19442 to a visible line beginning. This makes the function of C-a more intuitive.
19443 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19444 first attempt, and only move to after the tags when the cursor is already
19445 beyond the end of the headline."
19446 (interactive "P")
19447 (let ((pos (point))
19448 (special (if (consp org-special-ctrl-a/e)
19449 (car org-special-ctrl-a/e)
19450 org-special-ctrl-a/e))
19451 refpos)
19452 (if (org-bound-and-true-p line-move-visual)
19453 (beginning-of-visual-line 1)
19454 (beginning-of-line 1))
19455 (if (and arg (fboundp 'move-beginning-of-line))
19456 (call-interactively 'move-beginning-of-line)
19457 (if (bobp)
19458 nil
19459 (backward-char 1)
19460 (if (org-truely-invisible-p)
19461 (while (and (not (bobp)) (org-truely-invisible-p))
19462 (backward-char 1)
19463 (beginning-of-line 1))
19464 (forward-char 1))))
19465 (when special
19466 (cond
19467 ((and (looking-at org-complex-heading-regexp)
19468 (= (char-after (match-end 1)) ?\ ))
19469 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
19470 (point-at-eol)))
19471 (goto-char
19472 (if (eq special t)
19473 (cond ((> pos refpos) refpos)
19474 ((= pos (point)) refpos)
19475 (t (point)))
19476 (cond ((> pos (point)) (point))
19477 ((not (eq last-command this-command)) (point))
19478 (t refpos)))))
19479 ((org-at-item-p)
19480 (goto-char
19481 (if (eq special t)
19482 (cond ((> pos (match-end 0)) (match-end 0))
19483 ((= pos (point)) (match-end 0))
19484 (t (point)))
19485 (cond ((> pos (point)) (point))
19486 ((not (eq last-command this-command)) (point))
19487 (t (match-end 0))))))))
19488 (org-no-warnings
19489 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19491 (defun org-end-of-line (&optional arg)
19492 "Go to the end of the line.
19493 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
19494 first attempt, and only move to after the tags when the cursor is already
19495 beyond the end of the headline."
19496 (interactive "P")
19497 (let ((special (if (consp org-special-ctrl-a/e)
19498 (cdr org-special-ctrl-a/e)
19499 org-special-ctrl-a/e)))
19500 (if (or (not special)
19501 (not (org-on-heading-p))
19502 arg)
19503 (call-interactively
19504 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
19505 ((fboundp 'move-end-of-line) 'move-end-of-line)
19506 (t 'end-of-line)))
19507 (let ((pos (point)))
19508 (beginning-of-line 1)
19510 (if (eq special t)
19511 (if (or (< pos (match-beginning 1))
19512 (= pos (match-end 0)))
19513 (goto-char (match-beginning 1))
19514 (goto-char (match-end 0)))
19515 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
19516 (goto-char (match-end 0))
19517 (goto-char (match-beginning 1))))
19518 (call-interactively (if (fboundp 'move-end-of-line)
19519 'move-end-of-line
19520 'end-of-line)))))
19521 (org-no-warnings
19522 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
19524 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
19525 (define-key org-mode-map "\C-e" 'org-end-of-line)
19527 (defun org-backward-sentence (&optional arg)
19528 "Go to beginning of sentence, or beginning of table field.
19529 This will call `backward-sentence' or `org-table-beginning-of-field',
19530 depending on context."
19531 (interactive "P")
19532 (cond
19533 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
19534 (t (call-interactively 'backward-sentence))))
19536 (defun org-forward-sentence (&optional arg)
19537 "Go to end of sentence, or end of table field.
19538 This will call `forward-sentence' or `org-table-end-of-field',
19539 depending on context."
19540 (interactive "P")
19541 (cond
19542 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
19543 (t (call-interactively 'forward-sentence))))
19545 (define-key org-mode-map "\M-a" 'org-backward-sentence)
19546 (define-key org-mode-map "\M-e" 'org-forward-sentence)
19548 (defun org-kill-line (&optional arg)
19549 "Kill line, to tags or end of line."
19550 (interactive "P")
19551 (cond
19552 ((or (not org-special-ctrl-k)
19553 (bolp)
19554 (not (org-on-heading-p)))
19555 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
19556 org-ctrl-k-protect-subtree)
19557 (if (or (eq org-ctrl-k-protect-subtree 'error)
19558 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
19559 (error "C-k aborted - would kill hidden subtree")))
19560 (call-interactively 'kill-line))
19562 (kill-region (point) (match-beginning 1))
19563 (org-set-tags nil t))
19564 (t (kill-region (point) (point-at-eol)))))
19566 (define-key org-mode-map "\C-k" 'org-kill-line)
19568 (defun org-yank (&optional arg)
19569 "Yank. If the kill is a subtree, treat it specially.
19570 This command will look at the current kill and check if is a single
19571 subtree, or a series of subtrees[1]. If it passes the test, and if the
19572 cursor is at the beginning of a line or after the stars of a currently
19573 empty headline, then the yank is handled specially. How exactly depends
19574 on the value of the following variables, both set by default.
19576 org-yank-folded-subtrees
19577 When set, the subtree(s) will be folded after insertion, but only
19578 if doing so would now swallow text after the yanked text.
19580 org-yank-adjusted-subtrees
19581 When set, the subtree will be promoted or demoted in order to
19582 fit into the local outline tree structure, which means that the level
19583 will be adjusted so that it becomes the smaller one of the two
19584 *visible* surrounding headings.
19586 Any prefix to this command will cause `yank' to be called directly with
19588 will just
19589 plainly yank the text as it is.
19591 \[1] The test checks if the first non-white line is a heading
19592 and if there are no other headings with fewer stars."
19593 (interactive "P")
19594 (org-yank-generic 'yank arg))
19596 (defun org-yank-generic (command arg)
19597 "Perform some yank-like command.
19599 This function implements the behavior described in the `org-yank'
19600 documentation. However, it has been generalized to work for any
19601 interactive command with similar behavior."
19603 ;; pretend to be command COMMAND
19604 (setq this-command command)
19606 (if arg
19607 (call-interactively command)
19609 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
19610 (and (org-kill-is-subtree-p)
19611 (or (bolp)
19613 (string-match
19615 (buffer-substring (point-at-bol) (point)))))))
19616 swallowp)
19617 (cond
19618 ((and subtreep org-yank-folded-subtrees)
19619 (let ((beg (point))
19620 end)
19621 (if (and subtreep org-yank-adjusted-subtrees)
19622 (org-paste-subtree nil nil 'for-yank)
19623 (call-interactively command))
19625 (setq end (point))
19626 (goto-char beg)
19627 (when (and (bolp) subtreep
19628 (not (setq swallowp
19629 (org-yank-folding-would-swallow-text beg end))))
19630 (or (looking-at outline-regexp)
19631 (re-search-forward (concat "^" outline-regexp) end t))
19632 (while (and (< (point) end) (looking-at outline-regexp))
19633 (hide-subtree)
19634 (org-cycle-show-empty-lines 'folded)
19635 (condition-case nil
19636 (outline-forward-same-level 1)
19637 (error (goto-char end)))))
19638 (when swallowp
19639 (message
19640 "Inserted text not folded because that would swallow text"))
19642 (goto-char end)
19644 (beginning-of-line 1)
19645 (push-mark beg 'nomsg)))
19646 ((and subtreep org-yank-adjusted-subtrees)
19647 (let ((beg (point-at-bol)))
19648 (org-paste-subtree nil nil 'for-yank)
19649 (push-mark beg 'nomsg)))
19650 (t
19651 (call-interactively command))))))
19653 (defun org-yank-folding-would-swallow-text (beg end)
19654 "Would hide-subtree at BEG swallow any text after END?"
19655 (let (level)
19656 (save-excursion
19657 (goto-char beg)
19658 (when (or (looking-at outline-regexp)
19659 (re-search-forward (concat "^" outline-regexp) end t))
19660 (setq level (org-outline-level)))
19661 (goto-char end)
19663 (if (or (eobp)
19664 (and (bolp) (looking-at org-outline-regexp)
19665 (<= (org-outline-level) level)))
19666 nil ; Nothing would be swallowed
19667 t)))) ; something would swallow
19669 (define-key org-mode-map "\C-y" 'org-yank)
19671 (defun org-truely-invisible-p ()
19672 "Check if point is at a character currently not visible.
19673 This version does not only check the character property, but also
19674 `visible-mode'."
19675 ;; Early versions of noutline don't have `outline-invisible-p'.
19676 (if (org-bound-and-true-p visible-mode)
19677 nil
19678 (outline-invisible-p)))
19680 (defun org-invisible-p2 ()
19681 "Check if point is at a character currently not visible."
19682 (save-excursion
19683 (if (and (eolp) (not (bobp))) (backward-char 1))
19684 ;; Early versions of noutline don't have `outline-invisible-p'.
19685 (outline-invisible-p)))
19687 (defun org-back-to-heading (&optional invisible-ok)
19688 "Call `outline-back-to-heading', but provide a better error message."
19689 (condition-case nil
19690 (outline-back-to-heading invisible-ok)
19691 (error (error "Before first headline at position %d in buffer %s"
19692 (point) (current-buffer)))))
19694 (defun org-beginning-of-defun ()
19695 "Go to the beginning of the subtree, i.e. back to the heading."
19696 (org-back-to-heading))
19697 (defun org-end-of-defun ()
19698 "Go to the end of the subtree."
19699 (org-end-of-subtree nil t))
19701 (defun org-before-first-heading-p ()
19702 "Before first heading?"
19703 (save-excursion
19704 (end-of-line)
19707 (defun org-on-heading-p (&optional ignored)
19708 (outline-on-heading-p t))
19709 (defun org-at-heading-p (&optional ignored)
19710 (outline-on-heading-p t))
19712 (defun org-point-at-end-of-empty-headline ()
19713 "If point is at the end of an empty headline, return t, else nil.
19714 If the heading only contains a TODO keyword, it is still still considered
19715 empty."
19717 (save-excursion
19718 (beginning-of-line 1)
19719 (let ((case-fold-search nil))
19722 (defun org-at-heading-or-item-p ()
19723 (or (org-on-heading-p) (org-at-item-p)))
19725 (defun org-on-target-p ()
19726 (or (org-in-regexp org-radio-target-regexp)
19727 (org-in-regexp org-target-regexp)))
19729 (defun org-up-heading-all (arg)
19730 "Move to the heading line of which the present line is a subheading.
19731 This function considers both visible and invisible heading lines.
19732 With argument, move up ARG levels."
19733 (if (fboundp 'outline-up-heading-all)
19734 (outline-up-heading-all arg) ; emacs 21 version of outline.el
19735 (outline-up-heading arg t))) ; emacs 22 version of outline.el
19737 (defun org-up-heading-safe ()
19738 "Move to the heading line of which the present line is a subheading.
19739 This version will not throw an error. It will return the level of the
19740 headline found, or nil if no higher level is found.
19742 Also, this function will be a lot faster than `outline-up-heading',
19743 because it relies on stars being the outline starters. This can really
19744 make a significant difference in outlines with very many siblings."
19745 (let (start-level re)
19746 (org-back-to-heading t)
19747 (setq start-level (funcall outline-level))
19748 (if (equal start-level 1)
19749 nil
19751 (if (re-search-backward re nil t)
19752 (funcall outline-level)))))
19754 (defun org-first-sibling-p ()
19755 "Is this heading the first child of its parents?"
19756 (interactive)
19757 (let ((re (concat "^" outline-regexp))
19758 level l)
19759 (unless (org-at-heading-p t)
19760 (error "Not at a heading"))
19761 (setq level (funcall outline-level))
19762 (save-excursion
19763 (if (not (re-search-backward re nil t))
19764 t
19765 (setq l (funcall outline-level))
19766 (< l level)))))
19768 (defun org-goto-sibling (&optional previous)
19769 "Goto the next sibling, even if it is invisible.
19770 When PREVIOUS is set, go to the previous sibling instead. Returns t
19771 when a sibling was found. When none is found, return nil and don't
19772 move point."
19773 (let ((fun (if previous 're-search-backward 're-search-forward))
19774 (pos (point))
19775 (re (concat "^" outline-regexp))
19776 level l)
19777 (when (condition-case nil (org-back-to-heading t) (error nil))
19778 (setq level (funcall outline-level))
19779 (catch 'exit
19780 (or previous (forward-char 1))
19781 (while (funcall fun re nil t)
19782 (setq l (funcall outline-level))
19783 (when (< l level) (goto-char pos) (throw 'exit nil))
19784 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
19785 (goto-char pos)
19786 nil))))
19788 (defun org-show-siblings ()
19789 "Show all siblings of the current headline."
19790 (save-excursion
19791 (while (org-goto-sibling) (org-flag-heading nil)))
19792 (save-excursion
19793 (while (org-goto-sibling 'previous)
19794 (org-flag-heading nil))))
19796 (defun org-goto-first-child ()
19797 "Goto the first child, even if it is invisible.
19798 Return t when a child was found. Otherwise don't move point and
19799 return nil."
19800 (let (level (pos (point)) (re (concat "^" outline-regexp)))
19801 (when (condition-case nil (org-back-to-heading t) (error nil))
19802 (setq level (outline-level))
19803 (forward-char 1)
19804 (if (and (re-search-forward re nil t) (> (outline-level) level))
19805 (progn (goto-char (match-beginning 0)) t)
19806 (goto-char pos) nil))))
19808 (defun org-show-hidden-entry ()
19809 "Show an entry where even the heading is hidden."
19810 (save-excursion
19811 (org-show-entry)))
19813 (defun org-flag-heading (flag &optional entry)
19814 "Flag the current heading. FLAG non-nil means make invisible.
19815 When ENTRY is non-nil, show the entire entry."
19816 (save-excursion
19817 (org-back-to-heading t)
19818 ;; Check if we should show the entire entry
19819 (if entry
19820 (progn
19821 (org-show-entry)
19822 (save-excursion
19823 (and (outline-next-heading)
19824 (org-flag-heading nil))))
19825 (outline-flag-region (max (point-min) (1- (point)))
19826 (save-excursion (outline-end-of-heading) (point))
19827 flag))))
19829 (defun org-get-next-sibling ()
19830 "Move to next heading of the same level, and return point.
19831 If there is no such heading, return nil.
19832 This is like outline-next-sibling, but invisible headings are ok."
19833 (let ((level (funcall outline-level)))
19834 (outline-next-heading)
19835 (while (and (not (eobp)) (> (funcall outline-level) level))
19836 (outline-next-heading))
19837 (if (or (eobp) (< (funcall outline-level) level))
19838 nil
19839 (point))))
19841 (defun org-get-last-sibling ()
19842 "Move to previous heading of the same level, and return point.
19843 If there is no such heading, return nil."
19844 (let ((opoint (point))
19845 (level (funcall outline-level)))
19846 (outline-previous-heading)
19847 (when (and (/= (point) opoint) (outline-on-heading-p t))
19848 (while (and (> (funcall outline-level) level)
19849 (not (bobp)))
19850 (outline-previous-heading))
19851 (if (< (funcall outline-level) level)
19852 nil
19853 (point)))))
19855 (defun org-end-of-subtree (&optional invisible-OK to-heading)
19856 ;; This contains an exact copy of the original function, but it uses
19857 ;; `org-back-to-heading', to make it work also in invisible
19858 ;; trees. And is uses an invisible-OK argument.
19859 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
19860 ;; Furthermore, when used inside Org, finding the end of a large subtree
19861 ;; with many children and grandchildren etc, this can be much faster
19862 ;; than the outline version.
19863 (org-back-to-heading invisible-OK)
19864 (let ((first t)
19865 (level (funcall outline-level)))
19866 (if (and (org-mode-p) (< level 1000))
19867 ;; A true heading (not a plain list item), in Org-mode
19868 ;; This means we can easily find the end by looking
19869 ;; only for the right number of stars. Using a regexp to do
19870 ;; this is so much faster than using a Lisp loop.
19872 (forward-char 1)
19873 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
19874 ;; something else, do it the slow way
19875 (while (and (not (eobp))
19876 (or first (> (funcall outline-level) level)))
19877 (setq first nil)
19878 (outline-next-heading)))
19879 (unless to-heading
19881 (progn
19882 ;; Go to end of line before heading
19883 (forward-char -1)
19885 ;; leave blank line before heading
19886 (forward-char -1))))))
19887 (point))
19889 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
19890 "Use Org version in org-mode, for dramatic speed-up."
19891 (if (org-mode-p)
19892 (progn
19893 (org-end-of-subtree nil t)
19894 (unless (eobp) (backward-char 1)))
19895 ad-do-it))
19897 (defun org-end-of-meta-data-and-drawers ()
19898 "Jump to the first text after meta data and drawers in the current entry.
19899 This will move over empty lines, lines with planning time stamps,
19900 clocking lines, and drawers."
19901 (org-back-to-heading t)
19902 (let ((end (save-excursion (outline-next-heading) (point)))
19908 (forward-line 1)
19910 (if (not (match-end 1))
19911 ;; empty or planning line
19912 (forward-line 1)
19913 ;; a drawer, find the end
19915 (forward-line 1)))
19916 (point)))
19918 (defun org-forward-same-level (arg &optional invisible-ok)
19919 "Move forward to the arg'th subheading at same level as this one.
19920 Stop at the first and last subheadings of a superior heading.
19921 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
19922 it wil also look at invisible ones."
19923 (interactive "p")
19924 (org-back-to-heading invisible-ok)
19925 (org-on-heading-p)
19926 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19928 l)
19929 (forward-char 1)
19930 (while (> arg 0)
19931 (while (and (re-search-forward re nil 'move)
19932 (setq l (- (match-end 0) (match-beginning 0) 1))
19933 (= l level)
19934 (not invisible-ok)
19935 (progn (backward-char 1) (outline-invisible-p)))
19936 (if (< l level) (setq arg 1)))
19937 (setq arg (1- arg)))
19938 (beginning-of-line 1)))
19940 (defun org-backward-same-level (arg &optional invisible-ok)
19941 "Move backward to the arg'th subheading at same level as this one.
19942 Stop at the first and last subheadings of a superior heading."
19943 (interactive "p")
19944 (org-back-to-heading)
19945 (org-on-heading-p)
19946 (let* ((level (- (match-end 0) (match-beginning 0) 1))
19948 l)
19949 (while (> arg 0)
19950 (while (and (re-search-backward re nil 'move)
19951 (setq l (- (match-end 0) (match-beginning 0) 1))
19952 (= l level)
19953 (not invisible-ok)
19954 (outline-invisible-p))
19955 (if (< l level) (setq arg 1)))
19956 (setq arg (1- arg)))))
19958 (defun org-show-subtree ()
19959 "Show everything after this heading at deeper levels."
19960 (outline-flag-region
19961 (point)
19962 (save-excursion
19963 (org-end-of-subtree t t))
19964 nil))
19966 (defun org-show-entry ()
19967 "Show the body directly following this heading.
19968 Show the heading too, if it is currently invisible."
19969 (interactive)
19970 (save-excursion
19971 (condition-case nil
19972 (progn
19973 (org-back-to-heading t)
19974 (outline-flag-region
19975 (max (point-min) (1- (point)))
19976 (save-excursion
19977 (if (re-search-forward
19979 (match-beginning 1)
19980 (point-max)))
19981 nil)
19982 (org-cycle-hide-drawers 'children))
19983 (error nil))))
19985 (defun org-make-options-regexp (kwds &optional extra)
19986 "Make a regular expression for keyword lines."
19987 (concat
19988 "^"
19995 ;; Make isearch reveal the necessary context
19996 (defun org-isearch-end ()
19997 "Reveal context after isearch exits."
19998 (when isearch-success ; only if search was successful
19999 (if (featurep 'xemacs)
20000 ;; Under XEmacs, the hook is run in the correct place,
20001 ;; we directly show the context.
20002 (org-show-context 'isearch)
20003 ;; In Emacs the hook runs *before* restoring the overlays.
20004 ;; So we have to use a one-time post-command-hook to do this.
20005 ;; (Emacs 22 has a special variable, see function `org-mode')
20006 (unless (and (boundp 'isearch-mode-end-hook-quit)
20007 isearch-mode-end-hook-quit)
20008 ;; Only when the isearch was not quitted.
20009 (org-add-hook 'post-command-hook 'org-isearch-post-command
20010 'append 'local)))))
20012 (defun org-isearch-post-command ()
20013 "Remove self from hook, and show context."
20014 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
20015 (org-show-context 'isearch))
20018 ;;;; Integration with and fixes for other packages
20020 ;;; Imenu support
20022 (defvar org-imenu-markers nil
20023 "All markers currently used by Imenu.")
20024 (make-variable-buffer-local 'org-imenu-markers)
20026 (defun org-imenu-new-marker (&optional pos)
20027 "Return a new marker for use by Imenu, and remember the marker."
20028 (let ((m (make-marker)))
20029 (move-marker m (or pos (point)))
20030 (push m org-imenu-markers)
20031 m))
20033 (defun org-imenu-get-tree ()
20034 "Produce the index for Imenu."
20035 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
20036 (setq org-imenu-markers nil)
20037 (let* ((n org-imenu-depth)
20038 (re (concat "^" outline-regexp))
20039 (subs (make-vector (1+ n) nil))
20040 (last-level 0)
20041 m level head)
20042 (save-excursion
20043 (save-restriction
20044 (widen)
20045 (goto-char (point-max))
20046 (while (re-search-backward re nil t)
20047 (setq level (org-reduced-level (funcall outline-level)))
20048 (when (<= level n)
20049 (looking-at org-complex-heading-regexp)
20050 (setq head (org-link-display-format
20051 (org-match-string-no-properties 4))
20052 m (org-imenu-new-marker))
20053 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
20054 (if (>= level last-level)
20055 (push (cons head m) (aref subs level))
20056 (push (cons head (aref subs (1+ level))) (aref subs level))
20057 (loop for i from (1+ level) to n do (aset subs i nil)))
20058 (setq last-level level)))))
20059 (aref subs 1)))
20061 (eval-after-load "imenu"
20062 '(progn
20063 (add-hook 'imenu-after-jump-hook
20064 (lambda ()
20065 (if (org-mode-p)
20066 (org-show-context 'org-goto))))))
20068 (defun org-link-display-format (link)
20069 "Replace a link with either the description, or the link target
20070 if no description is present"
20071 (save-match-data
20072 (if (string-match org-bracket-link-analytic-regexp link)
20073 (replace-match (if (match-end 5)
20074 (match-string 5 link)
20075 (concat (match-string 1 link)
20076 (match-string 3 link)))
20077 nil t link)
20078 link)))
20080 ;; Speedbar support
20082 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
20083 "Overlay marking the agenda restriction line in speedbar.")
20084 (overlay-put org-speedbar-restriction-lock-overlay
20085 'face 'org-agenda-restriction-lock)
20086 (overlay-put org-speedbar-restriction-lock-overlay
20087 'help-echo "Agendas are currently limited to this item.")
20088 (org-detach-overlay org-speedbar-restriction-lock-overlay)
20090 (defun org-speedbar-set-agenda-restriction ()
20091 "Restrict future agenda commands to the location at point in speedbar.
20093 (interactive)
20094 (require 'org-agenda)
20095 (let (p m tp np dir txt)
20096 (cond
20097 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20098 'org-imenu t))
20099 (setq m (get-text-property p 'org-imenu-marker))
20100 (with-current-buffer (marker-buffer m)
20101 (goto-char m)
20102 (org-agenda-set-restriction-lock 'subtree)))
20103 ((setq p (text-property-any (point-at-bol) (point-at-eol)
20104 'speedbar-function 'speedbar-find-file))
20105 (setq tp (previous-single-property-change
20106 (1+ p) 'speedbar-function)
20107 np (next-single-property-change
20108 tp 'speedbar-function)
20109 dir (speedbar-line-directory)
20110 txt (buffer-substring-no-properties (or tp (point-min))
20111 (or np (point-max))))
20112 (with-current-buffer (find-file-noselect
20113 (let ((default-directory dir))
20114 (expand-file-name txt)))
20115 (unless (org-mode-p)
20116 (error "Cannot restrict to non-Org-mode file"))
20117 (org-agenda-set-restriction-lock 'file)))
20118 (t (error "Don't know how to restrict Org-mode's agenda")))
20119 (move-overlay org-speedbar-restriction-lock-overlay
20120 (point-at-bol) (point-at-eol))
20121 (setq current-prefix-arg nil)
20122 (org-agenda-maybe-redo)))
20124 (eval-after-load "speedbar"
20125 '(progn
20126 (speedbar-add-supported-extension ".org")
20127 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
20128 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
20129 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
20130 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
20131 (add-hook 'speedbar-visiting-tag-hook
20132 (lambda () (and (org-mode-p) (org-show-context 'org-goto))))))
20134 ;;; Fixes and Hacks for problems with other packages
20136 ;; Make flyspell not check words in links, to not mess up our keymap
20137 (defun org-mode-flyspell-verify ()
20138 "Don't let flyspell put overlays at active buttons."
20139 (and (not (get-text-property (max (1- (point)) (point-min)) 'keymap))
20140 (not (get-text-property (max (1- (point)) (point-min)) 'org-no-flyspell))))
20142 (defun org-remove-flyspell-overlays-in (beg end)
20143 "Remove flyspell overlays in region."
20144 (and (org-bound-and-true-p flyspell-mode)
20145 (fboundp 'flyspell-delete-region-overlays)
20146 (flyspell-delete-region-overlays beg end))
20147 (add-text-properties beg end '(org-no-flyspell t)))
20149 ;; Make `bookmark-jump' shows the jump location if it was hidden.
20150 (eval-after-load "bookmark"
20151 '(if (boundp 'bookmark-after-jump-hook)
20152 ;; We can use the hook
20153 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
20154 ;; Hook not available, use advice
20155 (defadvice bookmark-jump (after org-make-visible activate)
20156 "Make the position visible."
20157 (org-bookmark-jump-unhide))))
20159 ;; Make sure saveplace shows the location if it was hidden
20160 (eval-after-load "saveplace"
20161 '(defadvice save-place-find-file-hook (after org-make-visible activate)
20162 "Make the position visible."
20163 (org-bookmark-jump-unhide)))
20165 ;; Make sure ecb shows the location if it was hidden
20166 (eval-after-load "ecb"
20167 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
20168 "Make hierarchy visible when jumping into location from ECB tree buffer."
20169 (if (org-mode-p)
20170 (org-show-context))))
20172 (defun org-bookmark-jump-unhide ()
20173 "Unhide the current position, to show the bookmark location."
20174 (and (org-mode-p)
20175 (or (outline-invisible-p)
20176 (save-excursion (goto-char (max (point-min) (1- (point))))
20177 (outline-invisible-p)))
20178 (org-show-context 'bookmark-jump)))
20180 ;; Make session.el ignore our circular variable
20181 (eval-after-load "session"
20182 '(add-to-list 'session-globals-exclude 'org-mark-ring))
20184 ;;;; Experimental code
20186 (defun org-closed-in-range ()
20187 "Sparse tree of items closed in a certain time range.
20188 Still experimental, may disappear in the future."
20189 (interactive)
20190 ;; Get the time interval from the user.
20191 (let* ((time1 (org-float-time
20192 (org-read-date nil 'to-time nil "Starting date: ")))
20193 (time2 (org-float-time
20194 (org-read-date nil 'to-time nil "End date:")))
20195 ;; callback function
20196 (callback (lambda ()
20197 (let ((time
20198 (org-float-time
20199 (apply 'encode-time
20200 (org-parse-time-string
20201 (match-string 1))))))
20202 ;; check if time in interval
20203 (and (>= time time1) (<= time time2))))))
20204 ;; make tree, check each match with the callback
20207 ;;;; Finish up
20209 (provide 'org)
20211 (run-hooks 'org-load-hook)
20213 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
20215 ;;; org.el ends here