| blob | 74329b51700297af56c0bb3c92983a7fce219aa7 |
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004-2011 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Maintainer: Bastien Guerry <bzg at gnu dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.8.03
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.
109 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
114 ;; babel
123 ;; load languages based on value of `org-babel-load-languages'
125 ;;;###autoload
127 "Load the languages defined in `org-babel-load-languages'."
139 org-babel-load-languages))
142 "Languages which can be evaluated in Org-mode buffers.
143 This list can be used to load support for any of the languages
144 below, note that each language will depend on a different set of
145 system executables and/or Emacs modes. When a language is
147 with `org-babel-execute-src-block' bound by default to C-c
148 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
149 be set to remove code block evaluation from the C-c C-c
150 keybinding. By default only Emacs Lisp (which has no
151 requirements) is loaded."
155 :key-type
195 ;;;; Customization variables
197 "Remove ID property of clones of a subtree.
198 When non-nil, clones of a subtree don't inherit the ID property.
199 Otherwise they inherit the ID property with a new unique
200 identifier."
204 ;;; Version
210 "Show the org-mode version in the echo area.
211 With prefix arg HERE, insert it at point."
237 ;;; Compatibility constants
239 ;;; The custom variables
242 "Outline-based notes management and organizer."
248 "Mode hook for Org-mode, run after the mode was turned on."
253 "Hook that is run after org.el has been loaded."
258 "Hook that is run after an Org log buffer is created."
267 "Load all extensions listed in `org-modules'."
272 org-modules)
276 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
285 (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)
286 "Modules that should always be loaded together with org.el.
287 If a description starts with <C>, the file is not part of Emacs
288 and loading it will require that you have downloaded and properly installed
289 the org-mode distribution.
291 You can also use this system to load external packages (i.e. neither Org
292 core modules, nor modules from the CONTRIB directory). Just add symbols
293 to the end of the list. If the package is called org-xyz.el, then you need
294 to add the symbol `xyz', and the package must have a call to
296 (provide 'org-xyz)"
299 :type
330 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
339 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
348 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
364 "Non-nil means make shift-cursor commands select text when possible.
366 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
367 start selecting a region, or enlarge regions started in this way.
368 In Org-mode, in special contexts, these same keys are used for
369 other purposes, important enough to compete with shift selection.
370 Org tries to balance these needs by supporting `shift-select-mode'
371 outside these special contexts, under control of this variable.
373 The default of this variable is nil, to avoid confusing behavior. Shifted
374 cursor keys will then execute Org commands in the following contexts:
375 - on a headline, changing TODO state (left/right) and priority (up/down)
376 - on a time stamp, changing the time
377 - in a plain list item, changing the bullet type
378 - in a property definition line, switching between allowed values
379 - in the BEGIN line of a clock table (changing the time block).
380 Outside these contexts, the commands will throw an error.
382 When this variable is t and the cursor is not in a special
383 context, Org-mode will support shift-selection for making and
384 enlarging regions. To make this more effective, the bullet
385 cycling will no longer happen anywhere in an item line, but only
386 if the cursor is exactly on the bullet.
388 If you set this variable to the symbol `always', then the keys
389 will not be special in headlines, property lines, and item lines,
390 to make shift selection work there as well. If this is what you
391 want, you can use the following alternative commands: `C-c C-t'
392 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
393 can be used to switch TODO sets, `C-c -' to cycle item bullet
394 types, and properties can be edited by hand or in column view.
396 However, when the cursor is on a timestamp, shift-cursor commands
397 will still edit the time stamp - this is just too good to give up.
399 XEmacs user should have this variable set to nil, because
400 `shift-select-mode' is in Emacs 23 or later only."
408 "Shall some commands act upon headlines in the active region?
410 When set to `t', some commands will be performed in all headlines
411 within the active region.
413 When set to `start-level', some commands will be performed in all
414 headlines within the active region, provided that these headlines
415 are of the same level than the first one.
417 When set to a string, those commands will be performed on the
418 matching headlines within the active region. Such string must be
419 a tags/property/todo match as it is used in the agenda tags view.
421 The list of commands is: `org-schedule', `org-deadline',
422 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
423 `org-archive-to-archive-sibling'. The archiving commands skip
424 already archived entries."
433 "Options concerning startup of Org-mode."
438 "Non-nil means entering Org-mode will switch to OVERVIEW.
439 This can also be configured on a per-file basis by adding one of
440 the following lines anywhere in the buffer:
442 #+STARTUP: fold (or `overview', this is equivalent)
443 #+STARTUP: nofold (or `showall', this is equivalent)
444 #+STARTUP: content
445 #+STARTUP: showeverything"
454 "Non-nil means entering Org-mode will set `truncate-lines'.
455 This is useful since some lines containing links can be very long and
456 uninteresting. Also tables look terrible when wrapped."
461 "Non-nil means turn on `org-indent-mode' on startup.
462 This can also be configured on a per-file basis by adding one of
463 the following lines anywhere in the buffer:
465 #+STARTUP: indent
466 #+STARTUP: noindent"
474 When this option is turned on, you can use TeX-like syntax for sub- and
476 considered as a single item - so grouping with {} is normally not
477 needed. For example, the following things will be parsed as single
478 sub- or superscripts.
480 10^24 or 10^tau several digits will be considered 1 item.
481 10^-12 or 10^-tau a leading sign with digits or a word
482 x^2-y^3 will be read as x^2 - y^3, because items are
483 terminated by almost any nonword/nondigit char.
484 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
486 Still, ambiguity is possible - so when in doubt use {} to enclose the
487 sub/superscript. If you set this variable to the symbol `{}',
488 the braces are *required* in order to trigger interpretations as
490 frequently in plain text.
492 Not all export backends support this, but HTML does.
507 "Non-nil means turn on `org-beamer-mode' on startup.
508 This can also be configured on a per-file basis by adding one of
509 the following lines anywhere in the buffer:
511 #+STARTUP: beamer"
516 "Non-nil means align all tables when visiting a file.
517 This is useful when the column width in tables is forced with <N> cookies
518 in table fields. Such tables will look correct only after the first re-align.
519 This can also be configured on a per-file basis by adding one of
520 the following lines anywhere in the buffer:
521 #+STARTUP: align
522 #+STARTUP: noalign"
527 "Non-nil means show inline images when loading a new Org file.
528 This can also be configured on a per-file basis by adding one of
529 the following lines anywhere in the buffer:
530 #+STARTUP: inlineimages
531 #+STARTUP: noinlineimages"
536 "Non-nil means insert the first line setting Org-mode in empty files.
537 When the function `org-mode' is called interactively in an empty file, this
538 normally means that the file name does not automatically trigger Org-mode.
539 To ensure that the file will always be in Org-mode in the future, a
540 line enforcing Org-mode will be inserted into the buffer, if this option
541 has been set."
546 "Non-nil means use alternative key bindings for some keys.
547 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
548 These keys are also used by other packages like shift-selection-mode'
549 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
550 If you want to use Org-mode together with one of these other modes,
551 or more generally if you would like to move some Org-mode commands to
552 other keys, set this variable and configure the keys with the variable
553 `org-disputed-keys'.
555 This option is only relevant at load-time of Org-mode, and must be set
556 *before* org.el is loaded. Changing it requires a restart of Emacs to
557 become effective."
562 "Non-nil means use extra key sequence definitions for certain commands.
563 This happens automatically if you run XEmacs or if `window-system'
564 is nil. This variable lets you do the same manually. You must
565 set it before loading org.
567 Example: on Carbon Emacs 22 running graphically, with an external
568 keyboard on a Powerbook, the default way of setting M-left might
569 not work for either Alt or ESC. Setting this variable will make
570 it work for ESC."
584 "Keys for which Org-mode and other modes compete.
585 This is an alist, cars are the default keys, second element specifies
586 the alternative to use when `org-replace-disputed-keys' is t.
588 Keys can be specified in any syntax supported by `define-key'.
589 The value of this option takes effect only at Org-mode's startup,
590 therefore you'll have to restart Emacs to apply it after changing."
595 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
596 Or return the original if not disputed.
597 Also apply the translations defined in `org-xemacs-key-equivalents'."
602 org-disputed-keys)))
606 key)
616 "Define a key, possibly translated, as returned by `org-key'."
620 "The ellipsis to use in the Org-mode outline.
621 When nil, just use the standard three dots. When a string, use that instead,
622 When a face, use the standard 3 dots, but with the specified face.
623 The change affects only Org-mode (which will then use its own display table).
624 Changing this requires executing `M-x org-mode' in a buffer to become
625 effective."
635 "Keywords in Org-mode."
640 "String to mark deadline entries.
641 A deadline is this string, followed by a time stamp. Should be a word,
642 terminated by a colon. You can insert a schedule keyword and
644 Changes become only effective after restarting Emacs."
649 "String to mark scheduled TODO entries.
650 A schedule is this string, followed by a time stamp. Should be a word,
651 terminated by a colon. You can insert a schedule keyword and
653 Changes become only effective after restarting Emacs."
658 "String used as the prefix for timestamps logging closing a TODO entry."
663 "String used as prefix for timestamps clocking work hours on an item."
668 "Entries starting with this keyword will never be exported.
669 An entry can be toggled between COMMENT and normal with
671 Changes become only effective after restarting Emacs."
676 "Entries starting with this keyword will be exported in fixed-width font.
677 Quoting applies only to the text in the entry following the headline, and does
678 not extend beyond the next headline, even if that is lower level.
679 An entry can be toggled between QUOTE and normal with
686 "Regular expression for specifying repeated events.
690 "Options concerning the general structure of Org-mode files."
695 "Options about how to make context of a location visible."
719 "Non-nil means show full hierarchy when revealing a location.
720 Org-mode often shows locations in an org-mode file which might have
721 been invisible before. When this is set, the hierarchy of headings
722 above the exposed location is shown.
723 Turning this off for example for sparse trees makes them very compact.
724 Instead of t, this can also be an alist specifying this option for different
725 contexts. Valid contexts are
726 agenda when exposing an entry from the agenda
727 org-goto when using the command `org-goto' on key C-c C-j
728 occur-tree when using the command `org-occur' on key C-c /
729 tags-tree when constructing a sparse tree based on tags matches
730 link-search when exposing search matches associated with a link
731 mark-goto when exposing the jump goal of a mark
732 bookmark-jump when exposing a bookmark location
733 isearch when exiting from an incremental search
734 default default for all contexts not set explicitly"
739 "Non-nil means show following heading when revealing a location.
740 Org-mode often shows locations in an org-mode file which might have
741 been invisible before. When this is set, the heading following the
742 match is shown.
743 Turning this off for example for sparse trees makes them very compact,
744 but makes it harder to edit the location of the match. In such a case,
746 Instead of t, this can also be an alist specifying this option for different
747 contexts. See `org-show-hierarchy-above' for valid contexts."
752 "Non-nil means show all sibling heading when revealing a location.
753 Org-mode often shows locations in an org-mode file which might have
754 been invisible before. When this is set, the sibling of the current entry
755 heading are all made visible. If `org-show-hierarchy-above' is t,
756 the same happens on each level of the hierarchy above the current entry.
758 By default this is on for the isearch context, off for all other contexts.
759 Turning this off for example for sparse trees makes them very compact,
760 but makes it harder to edit the location of the match. In such a case,
762 Instead of t, this can also be an alist specifying this option for different
763 contexts. See `org-show-hierarchy-above' for valid contexts."
768 "Non-nil means show the entry below a headline when revealing a location.
769 Org-mode often shows locations in an org-mode file which might have
770 been invisible before. When this is set, the text below the headline that is
771 exposed is also shown.
773 By default this is off for all contexts.
774 Instead of t, this can also be an alist specifying this option for different
775 contexts. See `org-show-hierarchy-above' for valid contexts."
780 "How should indirect tree buffers be displayed?
781 This applies to indirect buffers created with the commands
783 Valid values are:
784 current-window Display in the current window
785 other-window Just display in another window.
786 dedicated-frame Create one new frame, and re-use it each time.
787 new-frame Make a new frame each time. Note that in this case
788 previously-made indirect buffers are kept, and you need to
789 kill these buffers yourself."
799 "Non-nil means activate single letter commands at beginning of a headline.
800 This may also be a function to test for appropriate locations where speed
801 commands should be active."
809 "Alist of additional speed commands.
810 This list will be checked before `org-speed-commands-default'
811 when the variable `org-use-speed-commands' is non-nil
812 and when the cursor is at the beginning of a headline.
813 The car if each entry is a string with a single letter, which must
814 be assigned to `self-insert-command' in the global map.
815 The cdr is either a command to be called interactively, a function
816 to be called, or a form to be evaluated.
817 An entry that is just a list with a single string will be interpreted
818 as a descriptive headline that will be added when listing the speed
819 commands in the Help buffer using the `?' speed command."
831 "Options concerning visibility cycling in Org-mode."
836 "Non-nil means skip CHILDREN state in entries that don't have any."
841 "Maximum level which should still be subject to visibility cycling.
842 Levels higher than this will, for cycling, be treated as text, not a headline.
843 When `org-odd-levels-only' is set, a value of N in this variable actually
844 means 2N-1 stars as the limiting headline.
845 When nil, cycle all levels.
846 Note that the limiting level of cycling is also influenced by
847 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
848 `org-inlinetask-min-level' is, cycling will be limited to levels one less
849 than its value."
856 "Names of drawers. Drawers are not opened by cycling on the headline above.
857 Drawers only open with a TAB on the drawer line itself. A drawer looks like
858 this:
859 :DRAWERNAME:
860 .....
861 :END:
863 the property API.
865 Drawers can be defined on the per-file basis with a line like:
867 #+DRAWERS: HIDDEN STATE PROPERTIES"
873 "Non-nil means entering Org-mode will fold all blocks.
874 This can also be set in on a per-file basis with
876 #+STARTUP: hideblocks
877 #+STARTUP: showblocks"
883 "Cycle globally if cursor is at beginning of buffer and not at a headline.
884 This makes it possible to do global cycling without having to use S-TAB or
886 of the buffer
887 must not be a headline - it may be empty or some other text. When used in
888 this way, `org-cycle-hook' is disables temporarily, to make sure the
889 cursor stays at the beginning of the buffer.
890 When this option is nil, don't do anything special at the beginning
891 of the buffer."
896 "Non-nil means cycle entry level or item indentation in new empty entries.
898 When the cursor is at the end of an empty headline, i.e with only stars
899 and maybe a TODO keyword, TAB will then switch the entry to become a child,
900 and then all possible ancestor states, before returning to the original state.
901 This makes data entry extremely fast: M-RET to create a new headline,
902 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
904 When the cursor is at the end of an empty plain list item, one TAB will
905 make it a subitem, two or more tabs will back up to make this an item
906 higher up in the item hierarchy."
911 "Where should `org-cycle' emulate TAB.
912 nil Never
913 white Only in completely white lines
914 whitestart Only at the beginning of lines, before the first non-white char
915 t Everywhere except in headlines
916 exc-hl-bol Everywhere except at the start of a headline
917 If TAB is used in a place where it does not emulate TAB, the current subtree
918 visibility is cycled."
925 ))
928 "Number of empty lines needed to keep an empty line between collapsed trees.
929 If you leave an empty line between the end of a subtree and the following
930 headline, this empty line is hidden when the subtree is folded.
931 Org-mode will leave (exactly) one empty line visible if the number of
932 empty lines is equal or larger to the number given in this variable.
933 So the default 2 means at least 2 empty lines after the end of a subtree
934 are needed to produce free space between a collapsed subtree and the
935 following headline.
937 If the number is negative, and the number of empty lines is at least -N,
938 all empty lines are shown.
940 Special case: when 0, never leave empty lines in collapsed view."
946 "Hook that is run before visibility cycling is happening.
947 The function(s) in this hook must accept a single argument which indicates
948 the new state that will be set right after running this hook. The
949 argument is a symbol. Before a global state change, it can have the values
950 `overview', `content', or `all'. Before a local state change, it can have
951 the values `folded', `children', or `subtree'."
956 org-cycle-hide-drawers
957 org-cycle-show-empty-lines
958 org-optimize-window-after-visibility-change)
959 "Hook that is run after `org-cycle' has changed the buffer visibility.
960 The function(s) in this hook must accept a single argument which indicates
961 the new state that was set by the most recent `org-cycle' command. The
962 argument is a symbol. After a global state change, it can have the values
963 `overview', `content', or `all'. After a local state change, it can have
964 the values `folded', `children', or `subtree'."
969 "Options concerning structure editing in Org-mode."
974 "Non-nil means skip even levels and only use odd levels for the outline.
975 This has the effect that two stars are being added/taken away in
976 promotion/demotion commands. It also influences how levels are
977 handled by the exporters.
978 Changing it requires restart of `font-lock-mode' to become effective
979 for fontification also in regions already fontified.
980 You may also set this on a per-file basis by adding one of the following
981 lines to the buffer:
983 #+STARTUP: odd
984 #+STARTUP: oddeven"
990 "Non-nil means adapt indentation to outline node level.
992 When this variable is set, Org assumes that you write outlines by
993 indenting text in each node to align with the headline (after the stars).
994 The following issues are influenced by this variable:
996 - When this is set and the *entire* text in an entry is indented, the
997 indentation is increased by one space in a demotion command, and
998 decreased by one in a promotion command. If any line in the entry
999 body starts with text at column 0, indentation is not changed at all.
1001 - Property drawers and planning information is inserted indented when
1002 this variable s set. When nil, they will not be indented.
1004 - TAB indents a line relative to context. The lines below a headline
1005 will be indented when this variable is set.
1007 Note that this is all about true indentation, by adding and removing
1008 space characters. See also `org-indent.el' which does level-dependent
1009 indentation in a virtual way, i.e. at display time in Emacs."
1014 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1016 When t, `C-a' will bring back the cursor to the beginning of the
1017 headline text, i.e. after the stars and after a possible TODO keyword.
1018 In an item, this will be the position after the bullet.
1019 When the cursor is already at that position, another `C-a' will bring
1020 it to the beginning of the line.
1022 `C-e' will jump to the end of the headline, ignoring the presence of tags
1023 in the headline. A second `C-e' will then jump to the true end of the
1024 line, after any tags. This also means that, when this variable is
1025 non-nil, `C-e' also will never jump beyond the end of the heading of a
1026 folded section, i.e. not after the ellipses.
1028 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
1029 going to the true line boundary first. Only a directly following, identical
1030 keypress will bring the cursor to the special positions.
1032 This may also be a cons cell where the behavior for `C-a' and `C-e' is
1033 set separately."
1052 "Non-nil means `C-k' will behave specially in headlines.
1053 When nil, `C-k' will call the default `kill-line' command.
1054 When t, the following will happen while the cursor is in the headline:
1056 - When the cursor is at the beginning of a headline, kill the entire
1057 line and possible the folded subtree below the line.
1058 - When in the middle of the headline text, kill the headline up to the tags.
1059 - When after the headline text, kill the tags."
1064 "Non-nil means, do not delete a hidden subtree with C-k.
1065 When set to the symbol `error', simply throw an error when C-k is
1066 used to kill (part-of) a headline that has hidden text behind it.
1067 Any other non-nil value will result in a query to the user, if it is
1068 OK to kill that hidden subtree. When nil, kill without remorse."
1076 "Check if in invisible region before inserting or deleting a character.
1077 Valid values are:
1079 nil Do not check, so just do invisible edits.
1080 error Throw an error and do nothing.
1081 show Make point visible, and do the requested edit.
1082 show-and-error Make point visible, then throw an error and abort the edit.
1083 smart Make point visible, and do insertion/deletion if it is
1084 adjacent to visible text and the change feels predictable.
1085 Never delete a previously invisible character or add in the
1086 middle or right after an invisible region. Basically, this
1087 allows insertion and backward-delete right before ellipses.
1088 FIXME: maybe in this case we should not even show?"
1098 "Non-nil means when yanking subtrees, fold them.
1099 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1100 it starts with a heading and all other headings in it are either children
1101 or siblings, then fold all the subtrees. However, do this only if no
1102 text after the yank would be swallowed into a folded tree by this action."
1107 "Non-nil means when yanking subtrees, adjust the level.
1108 With this setting, `org-paste-subtree' is used to insert the subtree, see
1109 this function for details."
1114 "Non-nil means M-RET will split the line at the cursor position.
1115 When nil, it will go to the end of the line before making a
1116 new line.
1117 You may also set this option in a different way for different
1118 contexts. Valid contexts are:
1120 headline when creating a new headline
1121 item when creating a new item
1122 table in a table field
1123 default the value to be used for all contexts not explicitly
1124 customized"
1141 "Non-nil means insert new headings after the current subtree.
1142 When nil, the new heading is created directly after the current line.
1145 for the duration of the command."
1151 "Should `org-insert-heading' leave a blank line before new heading/item?
1152 The value is an alist, with `heading' and `plain-list-item' as CAR,
1153 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1154 which case Org will look at the surrounding headings/items and try to
1155 make an intelligent decision whether to insert a blank line or not.
1157 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1158 set, the setting here is ignored and no empty line is inserted, to avoid
1159 breaking the list structure."
1172 "Hook being run after inserting a new heading."
1178 This currently only means they are never auto-wrapped.
1179 When nil, such lines will be treated like ordinary lines.
1180 See also the QUOTE keyword."
1185 "Non-nil means typing characters in `org-goto' starts incremental search."
1190 "Options concerning sparse trees in Org-mode."
1195 "Non-nil means highlight all matches that define a sparse tree.
1196 The highlights will automatically disappear the next time the buffer is
1197 changed by an edit command."
1202 "Non-nil means any change to the buffer will remove temporary highlights.
1203 Such highlights are created by `org-occur' and `org-clock-display'.
1204 When nil, `C-c C-c needs to be used to get rid of the highlights.
1205 The highlights created by `org-preview-latex-fragment' always need
1206 `C-c C-c' to be removed."
1213 "Hook that is run after `org-occur' has constructed a sparse tree.
1214 This can be used to recenter the window to show as much of the structure
1215 as possible."
1220 "Options concerning imenu and speedbar in Org-mode."
1225 "The maximum level for Imenu access to Org-mode headlines.
1226 This also applied for speedbar access."
1231 "Options concerning tables in Org-mode."
1237 When nil, such lines will be treated like ordinary lines.
1239 When equal to the symbol `optimized', the table editor will be optimized to
1240 do the following:
1241 - Automatic overwrite mode in front of whitespace in table fields.
1242 This makes the structure of the table stay in tact as long as the edited
1243 field does not exceed the column width.
1244 - Minimize the number of realigns. Normally, the table is aligned each time
1245 TAB or RET are pressed to move to another field. With optimization this
1246 happens only if changes to a field might have changed the column width.
1247 Optimization requires replacing the functions `self-insert-command',
1248 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1249 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1250 very good at guessing when a re-align will be necessary, but you can always
1253 If you would like to use the optimized version in Org-mode, but the
1254 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1256 This variable can be used to turn on and off the table editor during a session,
1257 but in order to toggle optimization, a restart is required.
1259 See also the variable `org-table-auto-blank-field'."
1267 "Non-nil means cluster self-insert commands for undo when possible.
1268 If this is set, then, like in the Emacs command loop, 20 consecutive
1269 characters will be undone together.
1270 This is configurable, because there is some impact on typing performance."
1275 "Non-nil means TAB will automatically notice a table.el table.
1276 When it sees such a table, it moves point into it and - if necessary -
1277 calls `table-recognize-table'."
1282 "Options concerning links in Org-mode."
1287 "Buffer-local version of `org-link-abbrev-alist', which see.
1292 "Alist of link abbreviations.
1293 The car of each element is a string, to be replaced at the start of a link.
1295 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1297 [[linkkey:tag][description]]
1299 The 'linkkey' must be a word word, starting with a letter, followed
1300 by letters, numbers, '-' or '_'.
1302 If REPLACE is a string, the tag will simply be appended to create the link.
1305 be inserted at that point (see the function `url-hexify-string').
1307 REPLACE may also be a function that will be called with the tag as the
1308 only argument to create the link, which should be returned as a string.
1310 See the manual for examples."
1320 "Non-nil means Org will display descriptive links.
1321 E.g. [[http://orgmode.org][Org website]] will be displayed as
1323 description. When set to `nil', Org will display the full links
1324 literally.
1326 You can interactively set the value of this variable by calling
1327 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1332 "How the path name in file links should be stored.
1333 Valid values are:
1335 relative Relative to the current directory, i.e. the directory of the file
1336 into which the link is being inserted.
1337 absolute Absolute path, if possible with ~ for home directory.
1338 noabbrev Absolute path, no abbreviation of home directory.
1339 adaptive Use relative path for files in the current directory and sub-
1340 directories of it. For other files, use an absolute path."
1349 "Types of links that should be activated in Org-mode files.
1350 This is a list of symbols, each leading to the activation of a certain link
1351 type. In principle, it does not hurt to turn on most link types - there may
1352 be a small gain when turning off unused link types. The types are:
1354 bracket The recommended [[link][description]] or [[link]] links with hiding.
1355 angle Links in angular brackets that may contain whitespace like
1356 <bbdb:Carsten Dominik>.
1357 plain Plain links in normal text, no whitespace, like http://google.com.
1358 radio Text that is matched by a radio target, see manual for details.
1359 tag Tag settings in a headline (link to tag search).
1360 date Time stamps (link to calendar).
1361 footnote Footnote labels.
1363 Changing this variable requires a restart of Emacs to become effective."
1375 "Function to use to generate link descriptions from links.
1376 If nil the link location will be used. This function must take
1377 two parameters; the first is the link and the second the
1378 description `org-insert-link' has generated, and should return the
1379 description to use."
1384 "Options concerning storing links in Org-mode."
1389 "Format of the description part of a link to an email or usenet message.
1390 The following %-escapes will be replaced by corresponding information:
1398 %s subject
1399 %d date
1400 %m message-id.
1402 You may use normal field width specification between the % and the letter.
1403 This is for example useful to limit the length of the subject.
1417 It should match if the message is from the user him/herself."
1422 "Non-nil means storing a link to an Org file will use entry IDs.
1424 Note that before this variable is even considered, org-id must be loaded,
1425 so please customize `org-modules' and turn it on.
1427 The variable can have the following values:
1429 t Create an ID if needed to make a link to the current entry.
1431 create-if-interactive
1432 If `org-store-link' is called directly (interactively, as a user
1433 command), do create an ID to support the link. But when doing the
1434 job for remember, only use the ID if it already exists. The
1435 purpose of this setting is to avoid proliferation of unwanted
1436 IDs, just because you happen to be in an Org file when you
1437 call `org-remember' that automatically and preemptively
1438 creates a link. If you do want to get an ID link in a remember
1439 template to an entry not having an ID, create it first by
1440 explicitly creating a link to it, using `C-c C-l' first.
1442 create-if-interactive-and-no-custom-id
1443 Like create-if-interactive, but do not create an ID if there is
1444 a CUSTOM_ID property defined in the entry. This is the default.
1446 use-existing
1447 Use existing ID, do not create one.
1449 nil Never use an ID to make a link, instead link using a text search for
1450 the headline text."
1455 create-if-interactive)
1457 create-if-interactive-and-no-custom-id)
1462 "Non-nil means file links from `org-store-link' contain context.
1463 A search string will be added to the file name with :: as separator and
1464 used to find the context when the link is activated by the command
1465 `org-open-at-point'. When this option is t, the entire active region
1466 will be placed in the search string of the file link. If set to a
1467 positive integer, only the first n lines of context will be stored.
1470 negates this setting for the duration of the command."
1475 "Non-nil means keep link in list for entire session.
1477 The command `org-store-link' adds a link pointing to the current
1478 location to an internal list. These links accumulate during a session.
1479 The command `org-insert-link' can be used to insert links into any
1480 Org-mode file (offering completion for all stored links). When this
1482 will be removed from the list, to make completing the unused links
1483 more efficient."
1488 "Options concerning following links in Org-mode."
1493 "Function to translate links with different syntax to Org syntax.
1494 This can be used to translate links created for example by the Planner
1495 or emacs-wiki packages to Org syntax.
1496 The function must accept two parameters, a TYPE containing the link
1498 which is everything after the link protocol. It should return a cons
1499 with possibly modified values of type and path.
1500 Org contains a function for this, so if you set this variable to
1501 `org-translate-link-from-planner', you should be able follow many
1502 links created by planner."
1507 "Hook that is run after a link has been followed."
1512 "Non-nil means on links TAB will follow the link.
1513 Needs to be set before org.el is loaded.
1514 This really should not be used, it does not make sense, and the
1515 implementation is bad."
1520 "Non-nil means on links RET will follow the link."
1526 "Non-nil means mouse-1 on a link will follow the link.
1527 A longer mouse click will still set point. Does not work on XEmacs.
1528 Needs to be set before org.el is loaded."
1533 "Number of different positions to be recorded in the ring.
1534 Changing this requires a restart of Emacs to work correctly."
1539 "Non-nil means internal links in Org files must exactly match a headline.
1540 When nil, the link search tries to match a phrase with all words
1541 in the search text."
1547 query-to-create)))
1554 "Setup the frame configuration for following links.
1555 When following a link with Emacs, it may often be useful to display
1556 this link in another window or frame. This variable can be used to
1557 set this up for the different types of links.
1558 For VM, use any of
1559 `vm-visit-folder'
1560 `vm-visit-folder-other-window'
1561 `vm-visit-folder-other-frame'
1562 For Gnus, use any of
1563 `gnus'
1564 `gnus-other-frame'
1565 `org-gnus-no-new-news'
1566 For FILE, use any of
1567 `find-file'
1568 `find-file-other-window'
1569 `find-file-other-frame'
1570 For Wanderlust use any of
1571 `wl'
1572 `wl-other-frame'
1573 For the calendar, use the variable `calendar-setup'.
1574 For BBDB, it is currently only possible to display the matches in
1575 another window."
1599 "Non-nil means use indirect buffer to display infile links.
1600 Activating internal links (from one location in a file to another location
1601 in the same file) normally just jumps to the location. When the link is
1603 is displayed in
1604 another window. When this option is set, the other window actually displays
1605 an indirect buffer clone of the current buffer, to avoid any visibility
1606 changes to the current buffer."
1611 "Non-nil means `org-open-file' will open non-existing files.
1612 When nil, an error will be generated.
1613 This variable applies only to external applications because they
1614 might choke on non-existing files. If the link is to a file that
1615 will be opened in Emacs, the variable is ignored."
1620 "Non-nil means a link to a directory really means to index.org.
1621 When nil, following a directory link will run dired or open a finder/explorer
1622 window on that directory."
1627 "Function and arguments to call for following mailto links.
1628 This is a list with the first element being a Lisp function, and the
1629 remaining elements being arguments to the function. In string arguments,
1630 %a will be replaced by the address, and %s will be replaced by the subject
1631 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1640 "Non-nil means ask for confirmation before executing shell links.
1641 Shell links can be dangerous: just think about a link
1643 [[shell:rm -rf ~/*][Google Search]]
1646 but really it would remove your entire home directory.
1647 Therefore we advise against setting this variable to nil.
1648 Just change it to `y-or-n-p' if you want to confirm with a
1656 'safe-local-variable
1660 "A regexp to skip confirmation for shell links."
1665 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1666 Elisp links can be dangerous: just think about a link
1671 but really it would remove your entire home directory.
1672 Therefore we advise against setting this variable to nil.
1673 Just change it to `y-or-n-p' if you want to confirm with a
1681 'safe-local-variable
1685 "A regexp to skip confirmation for Elisp links."
1693 "Default file applications on a UNIX or GNU/Linux system.
1704 "Default file applications on a MacOS X system.
1706 for some files for which the OS does not have a good default.
1714 'mswindows-shell-execute
1719 'mswindows-shell-execute
1722 "Default file applications on a Windows NT system.
1727 '(
1732 )
1733 "External applications for opening `file:path' items in a document.
1734 Org-mode uses system defaults for different file types, but
1735 you can use this variable to set the application for a given file
1736 extension. The entries in this list are cons cells where the car identifies
1737 files and the cdr the corresponding command. Possible values for the
1738 file identifier are
1740 ways, depending on its contents:
1742 - Alphanumeric characters only:
1743 Match links with this file extension.
1745 to open PDFs with evince.
1747 - Regular expression: Match links where the
1748 filename matches the regexp. If you want to
1749 use groups here, use shy groups.
1753 to open *.html and *.xhtml with firefox.
1755 - Regular expression which contains (non-shy) groups:
1757 anything after that, matches the regexp.
1758 In a custom command string, %1, %2, etc. are replaced with
1759 the parts of the link that were matched by the groups.
1760 For backwards compatibility, if a command string is given
1761 that does not use any of the group matches, this case is
1762 handled identically to the second one (i.e. match against
1763 file name only).
1764 In a custom lisp form, you can access the group matches with
1765 (match-string n link).
1768 to open [[file:document.pdf::5]] with evince at page 5.
1770 `directory' Matches a directory
1771 `remote' Matches a remote file, accessible through tramp or efs.
1772 Remote files most likely should be visited through Emacs
1773 because external applications cannot handle such paths.
1774 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1775 so all files Emacs knows how to handle. Using this with
1776 command `emacs' will open most files in Emacs. Beware that this
1777 will also open html files inside Emacs, unless you add
1779 t Default for files not matched by any of the other options.
1780 `system' The system command to open files, like `open' on Windows
1781 and Mac OS X, and mailcap under GNU/Linux. This is the command
1782 that will be selected if you call `C-c C-o' with a double
1785 Possible values for the command are:
1786 `emacs' The file will be visited by the current Emacs process.
1787 `default' Use the default application for this file type, which is the
1788 association for t in the list, most likely in the system-specific
1789 part.
1790 This can be used to overrule an unwanted setting in the
1791 system-specific variable.
1793 This command is specified by the entry whose car is `system'.
1794 Most likely, the system-specific version of this variable
1795 does define this command, but you can overrule/replace it
1796 here.
1797 string A command to be executed by a shell; %s will be replaced
1798 by the path to the file.
1799 sexp A Lisp form which will be evaluated. The file path will
1800 be available in the Lisp variable `file'.
1801 For more examples, see the system specific constants
1802 `org-file-apps-defaults-macosx'
1803 `org-file-apps-defaults-windowsnt'
1804 `org-file-apps-defaults-gnu'."
1814 auto-mode))
1825 "Options concerning refiling entries in Org-mode."
1830 "Directory with org files.
1831 This is just a default location to look for Org files. There is no need
1832 at all to put your files into this directory. It is only used in the
1833 following situations:
1835 1. When a remember template specifies a target file that is not an
1836 absolute path. The path will then be interpreted relative to
1837 `org-directory'
1838 2. When a remember note is filed away in an interactive way (when exiting the
1839 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
1840 with `org-directory' as the default path."
1846 "Default target for storing notes.
1847 Used as a fall back file for org-remember.el and org-capture.el, for
1848 templates that do not specify a target file."
1853 file))
1856 "The default interface to be used for `org-goto'.
1857 Allowed values are:
1858 outline The interface shows an outline of the relevant file
1859 and the correct heading is found by moving through
1860 the outline or by searching with incremental search.
1861 outline-path-completion Headlines in the current buffer are offered via
1862 completion. This is the interface also used by
1863 the refile command."
1870 "Maximum target level when running `org-goto' with refile interface."
1875 "Non-nil means store new notes at the beginning of a file or entry.
1876 When nil, new notes will be filed to the end of a file or entry.
1877 This can also be a list with cons cells of regular expressions that
1878 are matched against file names, and values."
1888 "Information to record when a task is refiled.
1890 Possible values are:
1892 nil Don't add anything
1893 time Add a time stamp to the task
1894 note Prompt for a note and add it with template `org-log-note-headings'
1896 This option can also be set with on a per-file-basis with
1898 #+STARTUP: nologrefile
1899 #+STARTUP: logrefile
1900 #+STARTUP: lognoterefile
1902 You can have local logging settings for a subtree by setting the LOGGING
1903 property to one or more of these keywords.
1905 When bulk-refiling from the agenda, the value `note' is forbidden and
1906 will temporarily be changed to `time'."
1916 This is a list of cons cells. Each cell contains:
1917 - a specification of the files to be considered, either a list of files,
1918 or a symbol whose function or variable value will be used to retrieve
1919 a file name or a list of file names. If you use `org-agenda-files' for
1920 that, all agenda files will be scanned for targets. Nil means consider
1921 headings in the current buffer.
1922 - A specification of how to find candidate refile targets. This may be
1923 any of:
1925 This tag has to be present in all target headlines, inheritance will
1926 not be considered.
1928 todo keyword.
1930 headlines that are refiling targets.
1931 - a cons cell (:level . N). Any headline of level N is considered a target.
1932 Note that, when `org-odd-levels-only' is set, level corresponds to
1933 order in hierarchy, not to the number of stars.
1934 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
1935 Note that, when `org-odd-levels-only' is set, level corresponds to
1936 order in hierarchy, not to the number of stars.
1938 Each element of this list generates a set of possible targets.
1939 The union of these sets is presented (with completion) to
1940 the user by `org-refile'.
1942 You can set the variable `org-refile-target-verify-function' to a function
1943 to verify each headline found by the simple criteria above.
1945 When this variable is nil, all top-level headlines in the current buffer
1946 are used, equivalent to the value `((nil . (:level . 1))'."
1962 "Function to verify if the headline at point should be a refile target.
1963 The function will be called without arguments, with point at the
1964 beginning of the headline. It should return t and leave point
1965 where it is if the headline is a valid target for refiling.
1967 If the target should not be selected, the function must return nil.
1968 In addition to this, it may move point to a place from where the search
1969 should be continued. For example, the function may decide that the entire
1970 subtree of the current entry should be excluded and move point to the end
1971 of the subtree."
1976 "Non-nil means cache refile targets to speed up the process.
1977 The cache for a particular file will be updated automatically when
1978 the buffer has been killed, or when any of the marker used for flagging
1979 refile targets no longer points at a live buffer.
1980 If you have added new entries to a buffer that might themselves be targets,
1981 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1982 find that easier, `C-u C-u C-u C-c C-w'."
1987 "Non-nil means provide refile targets as paths.
1988 So a level 3 headline will be available as level1/level2/level3.
1990 When the value is `file', also include the file name (without directory)
1991 into the path. In this case, you can also stop the completion after
1992 the file name, to get entries inserted as top level in the file.
1994 When `full-file-path', include the full file path."
2003 "Non-nil means complete the outline path in hierarchical steps.
2004 When Org-mode uses the refile interface to select an outline path
2005 \(see variable `org-refile-use-outline-path'), the completion of
2006 the path can be done is a single go, or if can be done in steps down
2007 the headline hierarchy. Going in steps is probably the best if you
2008 do not use a special completion package like `ido' or `icicles'.
2009 However, when using these packages, going in one step can be very
2010 fast, while still showing the whole path to the entry."
2015 "Non-nil means allow to create new nodes as refile targets.
2017 of an existing node. When the value of this variable is `confirm',
2018 new node creation must be confirmed by the user (recommended)
2019 When nil, the completion must match an existing entry.
2021 Note that, if the new heading is not seen by the criteria
2022 listed in `org-refile-targets', multiple instances of the same
2023 heading would be created by trying again to file under the new
2024 heading."
2032 "Non-nil means also refile active region within a subtree.
2034 By default `org-refile' doesn't allow refiling regions if they
2035 don't contain a set of subtrees, but it might be convenient to
2036 do so sometimes: in that case, the first line of the region is
2037 converted to a headline before refiling."
2042 "Options concerning TODO items in Org-mode."
2047 "Options concerning Progress logging in Org-mode."
2054 "The available interpretation symbols for customizing `org-todo-keywords'.
2058 "List of TODO entry keyword sequences and their interpretation.
2061 Each sequence starts with a symbol, either `sequence' or `type',
2062 indicating if the keywords should be interpreted as a sequence of
2063 action steps, or as different types of TODO items. The first
2064 keywords are states requiring action - these states will select a headline
2065 for inclusion into the global TODO list Org-mode produces. If one of
2068 the last keyword is treated as the only DONE state of the sequence.
2071 additional state where no keyword is present. For details about this
2072 cycling, see the manual.
2074 TODO keywords and interpretation can also be set on a per-file basis with
2075 the special #+SEQ_TODO and #+TYP_TODO lines.
2077 Each keyword can optionally specify a character for fast state selection
2078 \(in combination with the variable `org-use-fast-todo-selection')
2079 and specifiers for state change logging, using the same syntax
2082 indicates to record a time stamp each time this state is selected.
2084 Each keyword may also specify if a timestamp or a note should be
2085 recorded when entering or leaving the state, by adding additional
2086 characters in the parenthesis after the keyword. This looks like this:
2088 record only the time of the state change. With X and Y being either
2090 Y when leaving the state if and only if the *target* state does not
2091 define X. You may omit any of the fast-selection key or X or /Y,
2092 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2094 For backward compatibility, this variable may also be just a list
2095 of keywords - in this case the interpretation (sequence or type) will be
2096 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2106 ;;Quick and dirty way to see
2107 ;;`org-todo-interpretations'. This takes the
2108 ;;place of item arguments
2109 :convert-widget
2116 org-todo-interpretation-widgets))
2117 widget))
2148 "Controls how TODO keywords are interpreted.
2149 This variable is in principle obsolete and is only used for
2150 backward compatibility, if the interpretation of todo keywords is
2151 not given already in `org-todo-keywords'. See that variable for
2152 more information."
2159 "Non-nil means use the fast todo selection scheme with C-c C-t.
2160 This variable describes if and under what circumstances the cycling
2161 mechanism for TODO keywords will be replaced by a single-key, direct
2162 selection scheme.
2164 When nil, fast selection is never used.
2166 When the symbol `prefix', it will be used when `org-todo' is called with
2167 a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2168 in an agenda buffer.
2170 When t, fast selection is used by default. In this case, the prefix
2171 argument forces cycling instead.
2173 In all cases, the special interface is only used if access keys have actually
2174 been assigned by the user, i.e. if keywords in the configuration are followed
2175 by a letter in parenthesis, like TODO(t)."
2183 "Non-nil means update todo statistics after insert and toggle.
2184 ALL-HEADLINES means update todo statistics by including headlines
2185 with no TODO keyword as well, counting them as not done.
2186 A list of TODO keywords means the same, but skip keywords that are
2187 not in this list.
2189 When this is set, todo statistics is updated in the parent of the
2190 current entry each time a todo state is changed."
2200 "Non-nil means TODO statistics covers just direct children.
2201 When nil, all entries in the subtree are considered.
2202 This has only an effect if `org-provide-todo-statistics' is set.
2203 To set this to nil for only a single subtree, use a COOKIE_DATA
2209 "Hook which is run after the state of a TODO item was changed.
2210 The new state (a string with a TODO keyword, or nil) is available in the
2211 Lisp variable `state'."
2216 "Hook for functions that are allowed to block a state change.
2218 Each function gets as its single argument a property list, see
2219 `org-trigger-hook' for more information about this list.
2221 If any of the functions in this hook returns nil, the state change
2225 "Hook for functions that are triggered by a state change.
2227 Each function gets as its single argument a property list with at least
2228 the following elements:
2230 (:type type-of-change :position pos-at-entry-start
2231 :from old-state :to new-state)
2233 Depending on the type, more properties may be present.
2235 This mechanism is currently implemented for:
2237 TODO state changes
2238 ------------------
2239 :type todo-state-change
2240 :from previous state (keyword as a string), or nil, or a symbol
2241 'todo' or 'done', to indicate the general type of state.
2245 "Non-nil means undone TODO entries will block switching the parent to DONE.
2246 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2247 be blocked if any prior sibling is not yet done.
2248 Finally, if the parent is blocked because of ordered siblings of its own,
2249 the child will also be blocked.
2250 This variable needs to be set before org.el is loaded, and you need to
2251 restart Emacs after a change to make the change effective. The only way
2252 to change is while Emacs is running is through the customize interface."
2264 "Non-nil means unchecked boxes will block switching the parent to DONE.
2265 When this is nil, checkboxes have no influence on switching TODO states.
2266 When non-nil, you first need to check off all check boxes before the TODO
2267 entry can be switched to DONE.
2268 This variable needs to be set before org.el is loaded, and you need to
2269 restart Emacs after a change to make the change effective. The only way
2270 to change is while Emacs is running is through the customize interface."
2282 "Non-nil means inserting a TODO heading is treated as state change.
2284 logging will apply if appropriate. When nil, the new TODO item will
2285 be inserted directly, and no logging will take place."
2290 "Non-nil means switching TODO states with S-cursor counts as state change.
2291 This is the default behavior. However, setting this to nil allows a
2292 convenient way to select a TODO state and bypass any logging associated
2293 with that."
2298 "Tag changes that should be triggered by TODO state changes.
2299 This is a list. Each entry is
2301 (state-change (tag . flag) .......)
2303 State-change can be a string with a state, and empty string to indicate the
2304 state that has no TODO keyword, or it can be one of the symbols `todo'
2305 or `done', meaning any not-done or done state, respectively."
2319 "Information to record when a task moves to the DONE state.
2321 Possible values are:
2323 nil Don't add anything, just change the keyword
2324 time Add a time stamp to the task
2325 note Prompt for a note and add it with template `org-log-note-headings'
2327 This option can also be set with on a per-file-basis with
2329 #+STARTUP: nologdone
2330 #+STARTUP: logdone
2331 #+STARTUP: lognotedone
2333 You can have local logging settings for a subtree by setting the LOGGING
2334 property to one or more of these keywords."
2342 ;; Normalize old uses of org-log-done.
2349 "Information to record when the scheduling date of a tasks is modified.
2351 Possible values are:
2353 nil Don't add anything, just change the date
2354 time Add a time stamp to the task
2355 note Prompt for a note and add it with template `org-log-note-headings'
2357 This option can also be set with on a per-file-basis with
2359 #+STARTUP: nologreschedule
2360 #+STARTUP: logreschedule
2361 #+STARTUP: lognotereschedule"
2370 "Information to record when the deadline date of a tasks is modified.
2372 Possible values are:
2374 nil Don't add anything, just change the date
2375 time Add a time stamp to the task
2376 note Prompt for a note and add it with template `org-log-note-headings'
2378 This option can also be set with on a per-file-basis with
2380 #+STARTUP: nologredeadline
2381 #+STARTUP: logredeadline
2382 #+STARTUP: lognoteredeadline
2384 You can have local logging settings for a subtree by setting the LOGGING
2385 property to one or more of these keywords."
2394 "Non-nil means record a note when clocking out of an item.
2395 This can also be configured on a per-file basis by adding one of
2396 the following lines anywhere in the buffer:
2398 #+STARTUP: lognoteclock-out
2399 #+STARTUP: nolognoteclock-out"
2405 "Non-nil means the CLOSED time stamp will contain date and time.
2406 When nil, only the date will be recorded."
2420 "Headings for notes added to entries.
2421 The value is an alist, with the car being a symbol indicating the note
2422 context, and the cdr is the heading to be used. The heading may also be the
2423 empty string.
2424 %t in the heading will be replaced by a time stamp.
2425 %T will be an active time stamp instead the default inactive one
2426 %d will be replaced by a short-format time stamp.
2427 %D will be replaced by an active short-format time stamp.
2428 %s will be replaced by the new TODO state, in double quotes.
2429 %S will be replaced by the old TODO state, in double quotes.
2430 %u will be replaced by the user name.
2431 %U will be replaced by the full user name.
2433 In fact, it is not a good idea to change the `state' entry, because
2434 agenda log mode depends on the format of these entries."
2440 "Heading when changing todo state (todo sequence only)"
2454 "Non-nil means insert state change notes and time stamps into a drawer.
2455 When nil, state changes notes will be inserted after the headline and
2456 any scheduling and clock lines, but not inside a drawer.
2458 The value of this variable should be the name of the drawer to use.
2459 LOGBOOK is proposed as the default drawer for this purpose, you can
2460 also set this to a string to define the drawer of your choice.
2464 If this variable is set, `org-log-state-notes-insert-after-drawers'
2465 will be ignored.
2467 You can set the property LOG_INTO_DRAWER to overrule this setting for
2468 a subtree."
2480 "Return the value of `org-log-into-drawer', but let properties overrule.
2481 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2482 used instead of the default value."
2490 "Non-nil means insert state change notes after any drawers in entry.
2491 Only the drawers that *immediately* follow the headline and the
2492 deadline/scheduled line are skipped.
2493 When nil, insert notes right after the heading and perhaps the line
2494 with deadline/scheduling if present.
2496 This variable will have no effect if `org-log-into-drawer' is
2497 set."
2503 "Non-nil means the latest state note will be directly after heading.
2504 When nil, the state change notes will be ordered according to time."
2510 "The TODO state to which a repeater should return the repeating task.
2511 By default this is the first task in a TODO sequence, or the previous state
2512 in a TODO_TYP set. But you can specify another task here.
2513 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2519 "Non-nil means record moving through the DONE state when triggering repeat.
2520 An auto-repeating task is immediately switched back to TODO when
2523 record a closing note, there will be no record of the task moving
2524 through DONE. This variable forces taking a note anyway.
2526 nil Don't force a record
2527 time Record a time stamp
2528 note Record a note
2530 This option can also be set with on a per-file-basis with
2532 #+STARTUP: logrepeat
2533 #+STARTUP: lognoterepeat
2534 #+STARTUP: nologrepeat
2536 You can have local logging settings for a subtree by setting the LOGGING
2537 property to one or more of these keywords."
2547 "Priorities in Org-mode."
2552 "Non-nil means priority commands are active.
2553 When nil, these commands will be disabled, so that you never accidentally
2554 set a priority."
2559 "The highest priority of TODO items. A character like ?A, ?B etc.
2560 Must have a smaller ASCII number than `org-lowest-priority'."
2565 "The lowest priority of TODO items. A character like ?A, ?B etc.
2566 Must have a larger ASCII number than `org-highest-priority'."
2571 "The default priority of TODO items.
2572 This is the priority an item gets if no explicit priority is given.
2573 When starting to cycle on an empty priority the first step in the cycle
2574 depends on `org-priority-start-cycle-with-default'. The resulting first
2575 step priority must not exceed the range from `org-highest-priority' to
2576 `org-lowest-priority' which means that `org-default-priority' has to be
2577 in this range exclusive or inclusive the range boundaries. Else the
2578 first step refuses to set the default and the second will fall back
2579 to (depending on the command used) the highest or lowest priority."
2584 "Non-nil means start with default priority when starting to cycle.
2585 When this is nil, the first step in the cycle will be (depending on the
2586 command used) one higher or lower than the default priority.
2587 See also `org-default-priority'."
2592 "Function to extract the priority from a string.
2593 The string is normally the headline. If this is nil Org computes the
2594 priority from the priority cookie like [#A] in the headline. It returns
2595 an integer, increasing by 1000 for each priority level.
2596 The user can set a different function here, which should take a string
2597 as an argument and return the numeric priority."
2602 "Options concerning time stamps and deadlines in Org-mode."
2607 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2608 When nil, these labeled time stamps are forces into the second line of an
2609 entry, just after the headline. When scheduling from the global TODO list,
2610 the time stamp will always be forced into the second line."
2615 "Formats for `format-time-string' which are used for time stamps.
2619 "Number of minutes to round time stamps to.
2620 These are two values, the first applies when first creating a time stamp.
2621 The second applies when changing it with the commands `S-up' and `S-down'.
2622 When changing the time stamp, this means that it will change in steps
2623 of N minutes, as given by the second value.
2625 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2626 numbers should be factors of 60, so for example 5, 10, 15.
2628 When this is larger than 1, you can still force an exact time stamp by using
2629 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2630 and by using a prefix arg to `S-up/down' to specify the exact number
2631 of minutes to shift."
2641 ;; Normalize old customizations of this variable.
2645 org-time-stamp-rounding-minutes)))
2648 "Non-nil means overlay custom formats over all time stamps.
2649 The formats are defined through the variable `org-time-stamp-custom-formats'.
2650 To turn this on on a per-file basis, insert anywhere in the file:
2651 #+STARTUP: customtime"
2659 "Custom formats for time stamps. See `format-time-string' for the syntax.
2660 These are overlaid over the default ISO format if the variable
2661 `org-display-custom-times' is set. Time like %H:%M should be at the
2662 end of the second format. The custom formats are also honored by export
2663 commands, if custom time display is turned on at the time of export."
2668 "Get the right format for a time string."
2673 f)))
2676 "The format string used when creating CLOCKSUM lines.
2677 This is also used when org-mode generates a time duration."
2683 org-mode generates a time duration."
2688 "The format string used when creating CLOCKSUM lines, or when
2689 org-mode generates a time duration."
2694 "No. of days before expiration during which a deadline becomes active.
2695 This variable governs the display in sparse trees and in the agenda.
2696 When 0 or negative, it means use this number (the absolute value of it)
2697 even if a deadline has a different individual lead time specified.
2699 Custom commands can set this variable in the options section."
2705 "Non-nil means assume future for incomplete date input from user.
2706 This affects the following situations:
2707 1. The user gives a month but not a year.
2710 2. The user gives a day, but no month.
2713 it will be considered as *this* month.
2715 If you set this variable to the symbol `time', then also the following
2716 will work:
2718 3. If the user gives a time, but no day. If the time is before now,
2719 to will be interpreted as tomorrow.
2721 Currently none of this works for ISO week specifications.
2723 When this option is nil, the current day, month and year will always be
2724 used as defaults.
2726 See also `org-agenda-jump-prefer-future'."
2734 "Should the agenda jump command prefer the future for incomplete dates?
2735 The default is to do the same as configured in `org-read-date-prefer-future'.
2736 But you can also set a deviating value here.
2737 This may t or nil, or the symbol `org-read-date-prefer-future'."
2742 org-read-date-prefer-future)
2747 "Should date/time prompt force dates that are guaranteed to work in Emacs?
2749 Depending on the system Emacs is running on, certain dates cannot
2750 be represented with the type used internally to represent time.
2751 Dates between 1970-1-1 and 2038-1-1 can always be represented
2752 correctly. Some systems allow for earlier dates, some for later,
2753 some for both. One way to find out it to insert any date into an
2754 Org buffer, putting the cursor on the year and hitting S-up and
2755 S-down to test the range.
2757 When this variable is set to t, the date/time prompt will not let
2758 you specify dates outside the 1970-2037 range, so it is certain that
2759 these dates will work in whatever version of Emacs you are
2760 running, and also that you can move a file from one Emacs implementation
2761 to another. WHenever Org is forcing the year for you, it will display
2762 a message and beep.
2764 When this variable is nil, Org will check if the date is
2765 representable in the specific Emacs implementation you are using.
2766 If not, it will force a year, usually the current year, and beep
2767 to remind you. Currently this setting is not recommended because
2768 the likelihood that you will open your Org files in an Emacs that
2769 has limited date range is not negligible.
2771 A workaround for this problem is to use diary sexp dates for time
2772 stamps outside of this range."
2777 "Non-nil means display current interpretation of date prompt live.
2778 This display will be in an overlay, in the minibuffer."
2783 "Non-nil means pop up a calendar when prompting for a date.
2784 In the calendar, the date can be selected with mouse-1. However, the
2785 minibuffer will also be active, and you can simply enter the date as well.
2786 When nil, only the minibuffer will be available."
2794 "Hook to be used to set up keys for the date/time interface.
2795 Add key definitions to `minibuffer-local-map', which will be a temporary
2796 copy."
2801 "The hour when your day really ends. Must be an integer.
2802 This has influence for the following applications:
2804 the time given here, the day recognized as TODAY is actually yesterday.
2805 - When a date is read from the user and it is still before the time given
2806 here, the current date and time will be assumed to be yesterday, 23:59.
2807 Also, timestamps inserted in remember templates follow this rule.
2809 IMPORTANT: This is a feature whose implementation is and likely will
2810 remain incomplete. Really, it is only here because past midnight seems to
2811 be the favorite working time of John Wiegley :-)"
2816 "If non-nil, consider `org-extend-today-until' when creating timestamps.
2817 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2819 23:59 of the previous day."
2824 "Non-nil means S-down will increase the time in a time stamp.
2825 When nil, S-up will increase."
2830 "Non-nil means make the calendar window follow timestamp changes.
2831 When a timestamp is modified and the calendar window is visible, it will be
2832 moved to the new date."
2837 "Options concerning tags in Org-mode."
2842 "List of tags allowed in Org-mode files.
2843 When this list is nil, Org-mode will base TAG input on what is already in the
2844 buffer.
2845 The value of this variable is an alist, the car of each entry must be a
2846 keyword as a string, the cdr may be a character that is used to select
2847 that tag through the fast-tag-selection interface.
2848 See the manual for details."
2863 "List of tags that will always appear in all Org-mode files.
2864 This is in addition to any in buffer settings or customizations
2865 of `org-tag-alist'.
2866 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2867 The value of this variable is an alist, the car of each entry must be a
2868 keyword as a string, the cdr may be a character that is used to select
2869 that tag through the fast-tag-selection interface.
2870 See the manual for details.
2871 To disable these tags on a per-file basis, insert anywhere in the file:
2872 #+STARTUP: noptag"
2883 "If non-nil, always offer completion for all tags of all agenda files.
2884 Instead of customizing this variable directly, you might want to
2885 set it locally for capture buffers, because there no list of
2886 tags in that file can be created dynamically (there are none).
2888 (add-hook 'org-capture-mode-hook
2889 (lambda ()
2890 (set (make-local-variable
2891 'org-complete-tags-always-offer-all-agenda-tags)
2892 t)))"
2897 "List of tags that can be inherited by all entries in the file.
2898 The tags will be inherited if the variable `org-use-tag-inheritance'
2899 says they should be.
2903 "Non-nil means use fast tag selection scheme.
2904 This is a special interface to select and deselect tags with single keys.
2905 When nil, fast selection is never used.
2906 When the symbol `auto', fast selection is used if and only if selection
2907 characters for tags have been configured, either through the variable
2908 `org-tag-alist' or through a #+TAGS line in the buffer.
2909 When t, fast selection is always used and selection keys are assigned
2910 automatically if necessary."
2918 "Non-nil means fast tag selection exits after first change.
2919 When nil, you have to press RET to exit it.
2920 During fast tag selection, you can toggle this flag with `C-c'.
2921 This variable can also have the value `expert'. In this case, the window
2922 displaying the tags menu is not even shown, until you press C-c again."
2930 "Non-nil means fast tags selection interface will also offer TODO states.
2934 "The column to which tags should be indented in a headline.
2935 If this number is positive, it specifies the column. If it is negative,
2936 it means that the tags should be flushright to that column. For example,
2937 -80 works well for a normal 80 character screen.
2938 When 0, place tags directly after headline text, with only one space in
2939 between."
2944 "Non-nil keeps tags aligned when modifying headlines.
2945 Some operations (i.e. demoting) change the length of a headline and
2946 therefore shift the tags around. With this option turned on, after
2947 each such operation the tags are again aligned to `org-tags-column'."
2952 "Non-nil means tags in levels apply also for sublevels.
2953 When nil, only the tags directly given in a specific line apply there.
2954 This may also be a list of tags that should be inherited, or a regexp that
2955 matches tags that should be inherited. Additional control is possible
2956 with the variable `org-tags-exclude-from-inheritance' which gives an
2957 explicit list of tags to be excluded from inheritance., even if the value of
2958 `org-use-tag-inheritance' would select it for inheritance.
2960 If this option is t, a match early-on in a tree can lead to a large
2961 number of matches in the subtree when constructing the agenda or creating
2962 a sparse tree. If you only want to see the first match in a tree during
2963 a search, check out the variable `org-tags-match-list-sublevels'."
2972 "List of tags that should never be inherited.
2973 This is a way to exclude a few tags from inheritance. For way to do
2974 the opposite, to actively allow inheritance for selected tags,
2975 see the variable `org-use-tag-inheritance'."
2980 "Check if TAG is one that should be inherited."
2992 "Non-nil means list also sublevels of headlines matching a search.
2993 This variable applies to tags/property searches, and also to stuck
2994 projects because this search is based on a tags match as well.
2996 When set to the symbol `indented', sublevels are indented with
2997 leading dots.
2999 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3000 the sublevels of a headline matching a tag search often also match
3001 the same search. Listing all of them can create very long lists.
3002 Setting this variable to nil causes subtrees of a match to be skipped.
3004 This variable is semi-obsolete and probably should always be true. It
3005 is better to limit inheritance to certain tags using the variables
3006 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3014 "When set, tags are sorted using this function as a comparator."
3030 "Options concerning properties in Org-mode."
3035 "How property key/value pairs should be formatted by `indent-line'.
3036 When `indent-line' hits a property definition, it will format the line
3037 according to this format, mainly to make sure that the values are
3038 lined-up with respect to each other."
3043 "Alist of properties and functions to adjust inserted values.
3044 Elements of this alist must be of the form
3046 ([string] [function])
3048 where [string] must be a property name and [function] must be a
3049 lambda expression: this lambda expression must take one argument,
3050 the value to adjust, and return the new value as a string.
3054 and the clock summary:
3057 (let ((clocksum (org-clock-sum-current-item))
3058 (effort (org-duration-string-to-minutes
3060 (org-minutes-to-hh:mm-string (- effort clocksum))))))"
3065 "Non-nil means properties apply also for sublevels.
3067 This setting is chiefly used during property searches. Turning it on can
3068 cause significant overhead when doing a search, which is why it is not
3069 on by default.
3071 When nil, only the properties directly given in the current entry count.
3072 When t, every property is inherited. The value may also be a list of
3073 properties that should have inheritance, or a regular expression matching
3074 properties that should be inherited.
3076 However, note that some special properties use inheritance under special
3077 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3079 for valid values of a property.
3081 Note for programmers:
3082 When querying an entry with `org-entry-get', you can control if inheritance
3083 should be used. By default, `org-entry-get' looks only at the local
3084 properties. You can request inheritance by setting the inherit argument
3085 to t (to force inheritance) or to `selective' (to respect the setting
3086 in this variable)."
3095 "Check if PROPERTY is one that should be inherited."
3106 "The default column format, if no other format has been defined.
3107 This variable can be set on the per-file basis by inserting a line
3109 #+COLUMNS: %25ITEM ....."
3114 "The ellipses to be used when a field in column view is truncated.
3115 When this is the empty string, as many characters as possible are shown,
3116 but then there will be no visual indication that the field has been truncated.
3117 When this is a string of length N, the last N characters of a truncated
3118 field are replaced by this string. If the column is narrower than the
3119 ellipses string, only part of the ellipses string will be shown."
3124 "Function that modifies values for display in column view.
3125 For example, it can be used to cut out a certain part from a time stamp.
3126 The function must take 2 arguments:
3128 column-title The title of the column (*not* the property name)
3129 value The value that should be modified.
3131 The function should return the value that should be displayed,
3132 or nil if the normal value should be used."
3137 "The property that is being used to keep track of effort estimates.
3138 Effort estimates given in this property need to have the format H:MM."
3146 "List of property/value pairs that can be inherited by any entry.
3148 These are fixed values, for the preset properties. The user variable
3149 that can be used to add to this list is `org-global-properties'.
3151 The entries in this list are cons cells where the car is a property
3152 name and cdr is a string with the value. If the value represents
3157 "List of property/value pairs that can be inherited by any entry.
3159 This list will be combined with the constant `org-global-properties-fixed'.
3161 The entries in this list are cons cells where the car is a property
3162 name and cdr is a string with the value.
3164 You can set buffer-local values for the same purpose in the variable
3165 `org-file-properties' this by adding lines like
3167 #+PROPERTY: NAME VALUE"
3174 "List of property/value pairs that can be inherited by any entry.
3175 Valid for the current buffer.
3180 "Options concerning agenda views in Org-mode."
3185 "Variable used by org files to set a category for agenda display.
3186 Such files should use a file variable to set it, for example
3190 or contain a special line
3192 #+CATEGORY: ELisp
3194 If the file does not specify a category, then file's base name
3200 "The files to be used for agenda display.
3204 If an entry is a directory, all files in that directory that are matched by
3205 `org-agenda-file-regexp' will be part of the file list.
3207 If the value of the variable is not a list but a single file name, then
3208 the list of agenda files is actually stored and maintained in that file, one
3209 agenda file per line. In this file paths can be given relative to
3210 `org-directory'. Tilde expansion and environment variable substitution
3211 are also made."
3218 "Regular expression to match files for `org-agenda-files'.
3219 If any element in the list in that variable contains a directory instead
3220 of a normal file, all files in that directory that are matched by this
3221 regular expression will be included."
3226 "List of extra files to be searched by text search commands.
3227 These files will be search in addition to the agenda files by the
3228 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3229 Note that these files will only be searched for text search commands,
3230 not for the other agenda views like todo lists, tag searches or the weekly
3231 agenda. This variable is intended to list notes and possibly archive files
3232 that should also be searched by these two commands.
3233 In fact, if the first element in the list is the symbol `agenda-archives',
3234 than all archive files of all agenda files will be added to the search
3235 scope."
3246 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3247 A nil value means to remove them, after a query, from the list."
3252 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3253 The command `org-calendar-goto-agenda' will be bound to this key. The
3254 default is the character `c' because then `c' can be used to switch back and
3255 forth between agenda and calendar."
3260 "The key to be installed in `calendar-mode-map' for agenda-action.
3261 The command `org-agenda-action' will be bound to this key. The
3262 default is the character `k' because we use the same key in the agenda."
3267 "The key to be installed in `calendar-mode-map' for adding diary entries.
3268 This option is irrelevant until `org-agenda-diary-file' has been configured
3269 to point to an Org-mode file. When that is the case, the command
3270 `org-agenda-diary-entry' will be bound to the key given here, by default
3271 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3272 if you want to continue doing this, you need to change this to a different
3273 key."
3278 "File to which to add new entries with the `i' key in agenda and calendar.
3279 When this is the symbol `diary-file', the functionality in the Emacs
3280 calendar will be used to add entries to the `diary-file'. But when this
3281 points to a file, `org-agenda-diary-entry' will be used instead."
3297 org-calendar-insert-diary-entry-key
3301 "Options for embedding LaTeX code into Org-mode."
3309 "Options for creating images from LaTeX fragments.
3310 This is a property list with the following properties:
3312 `default' means use the foreground of the default face.
3314 `default' means use the background of the default face.
3315 :scale a scaling factor for the size of the images, to get more pixels
3316 :html-foreground, :html-background, :html-scale
3317 the same numbers for HTML export.
3318 :matchers a list indicating which matchers should be used to
3319 find LaTeX fragments. Valid members of this list are:
3330 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3331 When nil, just push out a message."
3336 Use this to specify additional executable file say a jar file.
3338 When using MathToWeb as the converter, specify the full-path to
3339 your mathtoweb.jar file."
3346 "Command to convert LaTeX fragments to MathML.
3347 Replace format-specifiers in the command as noted below and use
3348 `shell-command' to convert LaTeX to MathML.
3349 %j: Executable file in fully expanded form as specified by
3350 `org-latex-to-mathml-jar-file'.
3351 %I: Input LaTeX file in fully expanded form
3352 %o: Output MathML file
3353 This command is used by `org-create-math-formula'.
3355 When using MathToWeb as the converter, set this to
3363 "Return t if `org-latex-to-mathml-convert-command' is usable."
3366 org-latex-to-mathml-convert-command)
3368 org-latex-to-mathml-convert-command))))
3373 t))))))
3380 \[PACKAGES]
3381 \[DEFAULT-PACKAGES]
3382 % The settings below are copied from fullpage.sty
3395 "The document header used for processing LaTeX fragments.
3396 It is imperative that this header make sure that no page number
3397 appears on the page. The package defined in the variables
3398 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3400 will be appended."
3407 "Set the packages alist and make sure it has 3 elements per entry."
3411 x))
3412 val)))
3416 "Get the packages alist and make sure it has 3 elements per entry."
3420 x))
3423 ;; The following variables are defined here because is it also used
3424 ;; when formatting latex fragments. Originally it was part of the
3425 ;; LaTeX exporter, which is why the name includes "export".
3442 )
3443 "Alist of default packages to be inserted in the header.
3444 Change this only if one of the packages here causes an incompatibility
3445 with another package you are using.
3446 The packages in this list are needed by one part or another of Org-mode
3447 to function properly.
3449 - inputenc, fontenc: for basic font and character selection
3450 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3451 for interpreting the entities in `org-entities'. You can skip some of these
3452 packages if you don't use any of the symbols in it.
3453 - graphicx: for including images
3454 - float, wrapfig: for figure placement
3455 - longtable: for long tables
3456 - hyperref: for cross references
3458 Therefore you should not modify this variable unless you know what you
3459 are doing. The one reason to change it anyway is that you might be loading
3460 some other package that conflicts with one of the default packages.
3462 If SNIPPET-FLAG is t, the package also needs to be included when
3463 compiling LaTeX snippets into images for inclusion into HTML."
3476 "Alist of packages to be inserted in every LaTeX header.
3477 These will be inserted after `org-export-latex-default-packages-alist'.
3479 SNIPPET-FLAG, when t, indicates that this package is also needed when
3480 turning LaTeX snippets into images for inclusion into HTML.
3481 Make sure that you only list packages here which:
3482 - you want in every file
3483 - do not conflict with the default packages in
3484 `org-export-latex-default-packages-alist'
3485 - do not conflict with the setup in `org-format-latex-header'."
3499 "Settings for Org-mode appearance."
3504 "Non-nil means fontify only the stars in each headline.
3505 When nil, the entire headline is fontified.
3506 Changing it requires restart of `font-lock-mode' to become effective
3507 also in regions already fontified."
3512 "Non-nil means hide the first N-1 stars in a headline.
3513 This works by using the face `org-hide' for these stars. This
3514 face is white for a light background, and black for a dark
3515 background. You may have to customize the face `org-hide' to
3516 make this work.
3517 Changing it requires restart of `font-lock-mode' to become effective
3518 also in regions already fontified.
3519 You may also set this on a per-file basis by adding one of the following
3520 lines to the buffer:
3522 #+STARTUP: hidestars
3523 #+STARTUP: showstars"
3528 "List of symbols corresponding to keywords to be hidden the org buffer.
3529 For example, a value '(title) for this list will make the document's title
3530 appear in the buffer without the initial #+TITLE: keyword."
3538 "Non-nil means change the face of a headline if it is marked DONE.
3539 Normally, only the TODO/DONE keyword indicates the state of a headline.
3540 When this is non-nil, the headline after the keyword is set to the
3541 `org-headline-done' as an additional indication."
3546 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3547 Changing this variable requires a restart of Emacs to take effect."
3552 "Non-nil means fontify the whole line for headings.
3553 This is useful when setting a background color for the
3554 org-level-* faces."
3559 "Non-nil means fontify what is treated specially by the exporters."
3564 "Non-nil mean font-lock should hide the emphasis marker characters."
3569 "Non-nil means show entities as UTF8 characters.
3575 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3580 "Regular expression for matching emphasis.
3581 After a match, the match groups contain these elements:
3582 0 The match of the full regular expression, including the characters
3583 before and after the proper match
3584 1 The character before the proper match, or empty at beginning of line
3585 2 The proper match, including the leading and trailing markers
3586 3 The leading marker like * or /, indicating the type of highlighting
3587 4 The text between the emphasis markers, not including the markers
3594 "Set variable and compute the emphasis regular expression."
3598 org-emphasis-alist org-emphasis-regexp-components)
3610 ;; make sure special characters appear at the right position in the class
3622 ;; Make the regexp
3630 body1
3642 body1
3650 "Components used to build the regular expression for emphasis.
3651 This is a list with five entries. Terminology: In an emphasis string
3655 specify what is allowed/forbidden in each part:
3657 pre Chars allowed as prematch. Beginning of line will be allowed too.
3658 post Chars allowed as postmatch. End of line will be allowed too.
3659 border The chars *forbidden* as border characters.
3661 non-shy groups here, and don't allow newline here.
3662 newline The maximum number of newlines allowed in an emphasis exp.
3664 Use customize to modify this, or restart Emacs after changing it."
3683 )
3684 "Special syntax for emphasized text.
3685 Text starting and ending with a special character will be emphasized, for
3686 example *bold*, _underlined_ and /italic/. This variable sets the marker
3687 characters, the face to be used by font-lock for highlighting in Org-mode
3688 Emacs buffers, and the HTML tags to be used for this.
3689 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3690 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3691 Use customize to modify this, or restart Emacs after changing it."
3706 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3709 ;;; Miscellaneous options
3712 "Completion in Org-mode."
3717 "Non-nil means use ido completion wherever possible.
3718 Note that `ido-mode' must be active for this variable to be relevant.
3719 If you decide to turn this variable on, you might well want to turn off
3720 `org-outline-path-complete-in-steps'.
3721 See also `org-completion-use-iswitchb'."
3726 "Non-nil means use iswitchb completion wherever possible.
3727 Note that `iswitchb-mode' must be active for this variable to be relevant.
3728 If you decide to turn this variable on, you might well want to turn off
3729 `org-outline-path-complete-in-steps'.
3730 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3736 Normal means, no org-mode-specific context."
3740 ;;; Functions and variables from their packages
3741 ;; Declared here to avoid compiler warnings
3743 ;; XEmacs only
3749 ;; Emacs only
3752 ;; Various packages
3771 org-agenda-format-item "org-agenda"
3802 ;;; Autoload and prepare some org modules
3804 ;; Some table stuff that needs to be defined here, because it is used
3805 ;; by the functions setting up org-mode or checking for table context.
3818 "Detect the first line outside a table when searching from within it.
3821 ;; Autoload the functions in org-table.el that are needed by functions here.
3826 org-table-convert org-table-convert-region org-table-copy-down
3827 org-table-copy-region org-table-create
3828 org-table-create-or-convert-from-region
3829 org-table-create-with-table.el org-table-current-dline
3830 org-table-cut-region org-table-delete-column org-table-edit-field
3831 org-table-edit-formulas org-table-end org-table-eval-formula
3832 org-table-export org-table-field-info
3833 org-table-get-stored-formulas org-table-goto-column
3834 org-table-hline-and-move org-table-import org-table-insert-column
3835 org-table-insert-hline org-table-insert-row org-table-iterate
3836 org-table-justify-field-maybe org-table-kill-row
3837 org-table-maybe-eval-formula org-table-maybe-recalculate-line
3838 org-table-move-column org-table-move-column-left
3839 org-table-move-column-right org-table-move-row
3840 org-table-move-row-down org-table-move-row-up
3841 org-table-next-field org-table-next-row org-table-paste-rectangle
3842 org-table-previous-field org-table-recalculate
3843 org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3844 org-table-toggle-coordinate-overlays
3845 org-table-toggle-formula-debugger org-table-wrap-region
3846 orgtbl-mode turn-on-orgtbl org-table-to-lisp
3847 orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3848 orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3851 "Return t if the cursor is inside an org-type table.
3852 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3857 org-table-line-regexp)))
3858 nil))
3862 "Return t if and only if we are at a table.el table."
3868 "If there is a table.el table nearby, recognize it and move into it."
3874 nil
3884 t
3889 t)
3890 nil)
3891 nil))
3894 "Return t if the cursor is inside a hline in a table."
3899 nil))
3904 "Apply FUNCTION to the start of all tables in the buffer."
3920 ;; Declare and autoload functions from org-exp.el & Co
3928 org-insert-export-options-template
3929 org-table-clean-before-export))
3932 org-export-as-ascii-to-buffer org-replace-region-by-ascii
3933 org-export-region-as-ascii))
3936 org-replace-region-by-latex org-export-region-as-latex
3937 org-export-as-latex org-export-as-pdf
3938 org-export-as-pdf-and-open))
3941 org-export-as-html-batch org-export-as-html-to-buffer
3942 org-replace-region-by-html org-export-region-as-html
3943 org-export-as-html))
3946 org-replace-region-by-docbook org-export-region-as-docbook
3947 org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3948 org-export-as-docbook))
3951 org-export-icalendar-all-agenda-files
3952 org-export-icalendar-combine-agenda-files))
3956 ;; Declare and autoload functions from org-agenda.el
3961 org-todo-list org-tags-view org-agenda-list-stuck-projects
3962 org-diary org-agenda-to-appt
3963 org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3965 ;; Autoload org-remember
3970 org-remember-apply-template org-remember org-remember-handler)))
3975 org-capture-import-remember-templates)))
3977 ;; Autoload org-clock.el
3992 "Return non-nil if clock is currently running.
3993 The return value is actually the clock marker."
3998 "org-clock"
4000 org-clock-goto org-clock-sum org-clock-display
4001 org-clock-remove-overlays org-clock-report
4002 org-clocktable-shift org-dblock-write:clocktable
4003 org-get-clocktable org-resolve-clocks)))
4006 "If this is a CLOCK line, update it and return t.
4007 Otherwise, return nil."
4016 ts te h m s neg)
4019 nil)
4024 ;; The clock is running here
4045 t))))))
4048 "Check if the current buffer contains the running clock.
4049 If yes, offer to stop it and to save the buffer with the changes."
4058 "Check if this line starts a clock table, if yes, shift the time block."
4062 ;; Autoload org-timer.el
4066 "org-timer"
4068 org-timer-change-times-in-region
4069 org-timer-set-timer
4070 org-timer-reset-timers
4071 org-timer-show-remaining-time)))
4073 ;; Autoload org-feed.el
4077 "org-feed"
4081 ;; Autoload org-indent.el
4083 ;; Define the variable already here, to make sure we have it.
4085 "Non-nil if Org-Indent mode is enabled.
4090 "org-indent"
4093 ;; Autoload org-mobile.el
4097 "org-mobile"
4100 ;; Autoload archiving code
4101 ;; The stuff that is needed for cycling and tags has to be defined here.
4104 "Options concerning archiving in Org-mode."
4109 "The location where subtrees should be archived.
4111 The value of this variable is a string, consisting of two parts,
4112 separated by a double-colon. The first part is a filename and
4113 the second part is a headline.
4115 When the filename is omitted, archiving happens in the same file.
4116 %s in the filename will be replaced by the current file
4117 name (without the directory part). Archiving to a different file
4118 is useful to keep archived entries from contributing to the
4119 Org-mode Agenda.
4121 The archived entries will be filed as subtrees of the specified
4122 headline. When the headline is omitted, the subtrees are simply
4123 filed away at the end of the file, as top-level entries. Also in
4124 the heading you can use %s to represent the file name, this can be
4125 useful when using the same archive for a number of different files.
4127 Here are a few examples:
4129 If the current file is Projects.org, archive in file
4130 Projects.org_archive, as top-level trees. This is the default.
4133 Archive in the current file, under the top-level headline
4137 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4140 Archive in file ~/org/archive.org (absolute path), under headlines
4144 Archive in file ./basement (relative path), as level 3 trees
4147 You may set this option on a per-file basis by adding to the buffer a
4148 line like
4150 #+ARCHIVE: basement::** Finished Tasks
4152 You may also define it locally for a subtree by setting an ARCHIVE property
4153 in the entry. If such a property is found in an entry, or anywhere up
4154 the hierarchy, it will be used."
4159 "The tag that marks a subtree as archived.
4160 An archived subtree does not open during visibility cycling, and does
4161 not contribute to the agenda listings.
4162 After changing this, font-lock must be restarted in the relevant buffers to
4163 get the proper fontification."
4169 "Non-nil means the agenda will skip any items located in archived trees.
4170 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4171 variable is no longer recommended, you should leave it at the value t.
4172 Instead, use the key `v' to cycle the archives-mode in the agenda."
4178 "Non-nil means ignore archived trees when creating column view."
4184 "Non-nil means `org-cycle' will open archived trees.
4185 An archived tree is a tree marked with the tag ARCHIVE.
4186 When nil, archived trees will stay folded. You can still open them with
4187 normal outline commands like `show-all', but not with the cycling commands."
4193 "Non-nil means sparse tree construction shows matches in archived trees.
4194 When nil, matches in these trees are highlighted, but the trees are kept in
4195 collapsed state."
4201 "Re-hide all archived subtrees after a visibility state change."
4212 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4215 "Cycle subtree even if it is archived."
4222 "Re-hide all archived subtrees after a visibility state change."
4237 flag)))
4244 org-archive-to-archive-sibling org-toggle-archive-tag
4245 org-archive-subtree-default
4246 org-archive-subtree-default-with-confirmation)))
4248 ;; Autoload Column View Code
4256 org-columns-compute org-agenda-columns org-columns-remove-overlays
4259 ;; Autoload ID code
4267 org-id-get-with-outline-path-completion
4268 org-id-get-with-outline-drilling org-id-store-link
4269 org-id-goto org-id-find org-id-store-link))
4271 ;; Autoload Plotting Code
4276 ;;; Variables for pre-computed regular expressions, all buffer local
4294 "Matches a headline and puts everything into groups:
4295 group 1: the stars
4296 group 2: The todo keyword, maybe
4297 group 3: Priority cookie
4298 group 4: True headline
4302 "Printf format to make regexp to match an exact headline.
4303 This regexp will match the headline of any node which has the
4304 exact headline text that is put into the format, but may have any
4308 "Matches a headline and puts TODO state into group 2 if present.
4357 "Regular expression to match a plain time or time range.
4358 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4359 groups carry important information:
4360 0 the full match
4361 1 the first time, range or not
4369 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4370 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4371 groups carry important information:
4372 0 the full match
4373 7 hours of duration
4382 "Regular expression to match a timestamp time or time range.
4383 After a match, the following groups carry important information:
4384 0 the full match
4385 1 date plus weekday, for back referencing to make sure both times are on the same day
4386 2 the first time, range or not
4441 "Variable associated with STARTUP options for org-mode.
4442 Each element is a list of three items: The startup options as written
4443 in the #+STARTUP line, the corresponding variable, and the value to
4444 set this variable to if the option is found. An optional forth element PUSH
4448 "Update PROPS with KEY and VAL."
4462 "Printf format for a regexp matching an headline with some keyword.
4463 This regexp will match the headline of any node which has the
4464 exact keyword that is put into the format. The keyword isn't in
4468 "Printf format for a regexp matching an headline, possibly with some keyword.
4469 This regexp can match any headline with the specified keyword, or
4470 without a keyword. The keyword isn't in any group by default,
4474 "Precompute regular expressions for current buffer."
4494 kwds kws0 kwsa key log value cat arch tags const links hw dws
4495 tail sep kws1 prio props ftags drawers beamer-p
4517 ;; general TODO-like setup
4529 links)))
4536 props))))
4541 ftags
4551 l var val)
4581 ;; search for property blocks
4590 props)))))))
4607 ;; Process the TODO keywords
4609 ;; Use the global values as if they had been given locally.
4621 kws)))
4624 kwsa nil
4627 ;; 1 2
4635 kw)
4637 kws0)
4654 ;; Process the constants
4662 ;; Process the tags.
4673 tgs))
4681 ;; Compute the regular expressions and other local variables.
4682 ;; Using `org-outline-regexp-bol' would complicate them much,
4683 ;; because of the fixed white space at the end of that string.
4691 org-drawer-regexp
4695 org-not-done-keywords
4697 org-todo-regexp
4701 org-not-done-regexp
4705 org-not-done-heading-regexp
4707 org-todo-line-regexp
4709 org-complex-heading-regexp
4716 org-complex-heading-regexp-format
4721 ;; Stats cookies can be stuck to body.
4728 org-todo-line-tags-regexp
4735 org-deadline-time-regexp
4737 org-deadline-line-regexp
4739 org-scheduled-regexp
4741 org-scheduled-time-regexp
4743 org-closed-time-regexp
4745 org-keyword-time-regexp
4751 org-keyword-time-not-clock-regexp
4757 org-maybe-keyword-time-regexp
4763 org-planning-or-clock-line-re
4768 org-all-time-keywords
4771 org-clock-string org-closed-string))
4772 )
4777 "Return the contents of FILE, as a string."
4791 "Extract the log state setting from a TODO keyword string.
4805 "Remove a pair of parenthesis at the end of each string in LIST."
4809 x))
4810 list))
4813 "Assign fast keys to a keyword-key alist.
4814 Respect keys that are already there."
4832 ;;; Some variables used in various places
4839 "Function to be called when `C-c C-c' is used.
4843 ;; FIXME: Occasionally check by commenting these, to make sure
4844 ;; no other functions uses these, forgetting to let-bind them.
4849 ;; Defined somewhere in this file, but used before definition.
4855 ;;;; Define the Org-mode
4858 (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"))
4861 ;; We use a before-change function to check if a table might need
4862 ;; an update.
4864 "Indicates that a table might need an update.
4865 This variable is set by `org-before-change-function'.
4868 "Every change indicates that a table might need an update."
4878 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
4879 ;; some places -- e.g. see the macro org-with-limited-levels.
4880 ;;
4881 ;; In Org buffers, the value of `outline-regexp' is that of
4882 ;; `org-outline-regexp'. The only function still directly relying on
4883 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
4884 ;; job when `orgstruct-mode' is active.
4888 "Regexp to match Org headlines.
4889 This is similar to `org-outline-regexp' but additionally makes
4893 "Matches an headline, putting stars and text into groups.
4896 ;;;###autoload
4898 "Outline-based notes management and organizer, alias
4901 Org-mode develops organizational tasks around a NOTES file which
4902 contains information about projects as plain text. Org-mode is
4903 implemented on top of outline-mode, which is ideal to keep the content
4904 of large files well structured. It supports ToDo items, deadlines and
4905 time stamps, which magically appear in the diary listing of the Emacs
4906 calendar. Tables are easily created with a built-in table editor.
4907 Plain text URL-like links connect to websites, emails (VM), Usenet
4908 messages (Gnus), BBDB entries, and any files related to the project.
4909 For printing and sharing of notes, an Org-mode file (or a part of it)
4910 can be exported as a structured ASCII or HTML file.
4912 The following commands are available:
4916 ;; Get rid of Outline menus, they are not needed
4917 ;; Need to do this here because define-derived-mode sets up
4918 ;; the keymap so late. Still, it is a waste to call this each time
4919 ;; we switch another buffer into org-mode.
4922 ;; Assume this is Greg's port, it uses easymenu
4948 org-display-table 4
4951 org-ellipsis)))
4956 ;; tag faces set outside customize.... force initialization.
4958 ;; Calc embedded
4964 ;; Activate before-change-function
4968 ;; Check for running clock before killing a buffer
4970 ;; Paragraphs and auto-filling
4974 ;; Beginning/end of defun
4977 ;; Next error for sparse trees
4979 ;; Make sure dependence stuff works reliably, even for users who set it
4980 ;; too late :-(
4992 ;; Comment characters
4996 ;; Align options lines
4998 'align-mode-rules-list
5003 ;; Imenu
5007 ;; Make isearch reveal context
5010 ;; Emacs 21 and XEmacs make use of the hook
5012 ;; Emacs 22 deals with this through a special variable
5016 ;; Turn on org-beamer-mode?
5019 ;; Setup the pcomplete hooks
5032 ;; If empty file that did not turn on org-mode automatically, make it to.
5057 "Current time, possibly rounded to `org-time-stamp-rounding-minutes'."
5067 "Return today date, considering `org-extend-today-until'."
5072 ;;;; Font-Lock stuff, including the activators
5103 "Regular expression used to analyze links.
5104 Here is what the match groups contain after a match:
5105 1: http:
5106 2: http
5107 3: path
5108 4: [desc]
5116 "Number of stacked braces for sub/superscript matching.
5117 This has to be set before loading org.el to be effective."
5122 "Create a regular expression which will match a balanced sexp.
5123 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5124 as single character strings.
5125 The regexp returned will match the entire expression including the
5126 delimiters. It will also define a single group which contains the
5127 match except for the outermost delimiters. The maximum depth of
5128 stacked delimiters is N. Escaping delimiters is not possible."
5157 "Update the link regular expressions.
5158 This should be called after the variable `org-link-types' has changed."
5162 org-link-re-with-space
5168 org-link-re-with-space2
5174 org-link-re-with-space3
5179 org-angle-link-re
5185 org-plain-link-re
5189 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5190 org-bracket-link-regexp
5192 org-bracket-link-analytic-regexp
5200 org-bracket-link-analytic-regexp++
5208 org-any-link-re
5217 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5219 (defconst org-ts-regexp0 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5220 "Regular expression matching time strings for analysis.
5221 This one does not require the space after the date, so it can be used
5223 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5239 "Regular expression matching a time stamp or time stamp range.
5245 "Run through the buffer and add overlays to emphasized strings."
5254 'face
5267 rtn))
5270 "Insert or change an emphasis, i.e. a font like bold or italic.
5271 If there is an active region, change that region to a new emphasis.
5272 If there is no region, just insert the marker characters and position
5273 the cursor between them.
5274 CHAR should be either the marker character, or the first character of the
5275 HTML tag associated with that emphasis. If CHAR is a space, the means
5276 to remove the emphasis of the selected region.
5277 If char is not given (for example in an interactive call) it
5278 will be prompted for."
5329 "Run through the buffer and add overlays to links."
5338 nil
5344 t)))))
5352 t)))
5355 "When non-nil, fontify code in code blocks."
5366 "Fontify #+ lines and blocks, in the correct ways."
5369 "^\\([ \t]*#\\+\\(\\([a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5370 limit t)
5378 end end1 quoting block-type ovl)
5381 ;; a single line of backend-specific content
5389 ; for backend-specific code
5390 t)
5392 ;; Truly a block
5404 beg end
5412 ;; remove old background overlays
5417 ;; add a background overlay
5431 t))
5444 ;; just any other in-buffer setting, but not indented
5448 t)
5456 t)
5464 "Strip protective commas between BEG and END in the current buffer."
5480 "Run through the buffer and add overlays to links."
5488 t)))
5491 "Run through the buffer and add overlays to footnotes."
5498 'keymap org-mouse-map
5499 'help-echo
5501 "Footnote definition"
5503 'font-lock-fontified t
5504 'font-lock-multiline t
5508 "Run through the buffer and add overlays to bracketed links."
5512 ;; FIXME: above we should remove the escapes.
5513 ;; but that requires another match, protecting match data,
5514 ;; a lot of overhead for font-lock.
5521 ;; We need to remove the invisible property here. Table narrowing
5522 ;; may have made some of this invisible.
5540 t)))
5543 "Run through the buffer and add overlays to dates."
5555 t)))
5564 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5568 "Run through the buffer and add overlays to target matches."
5576 'keymap org-mouse-map
5580 t)))))
5583 "Find all radio targets in this file and update the regular expression."
5598 t)))
5605 ;; This should be with the exporter code, but we also use if for font-locking
5615 "Compute regular expression for stuff treated specially by exporters."
5622 org-latex-regexps)))
5650 org-entities)))
5654 org-latex-entities)
5655 nil))
5657 ))
5658 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5661 org-export-html-special-string-regexps)))
5666 ))))
5668 'org-latex-and-specials-regexp
5673 "Run through the buffer and add overlays to links."
5677 limit t))
5691 rtn)))
5694 "Restart `font-lock-mode', to force refontification."
5700 "Return a list of all targets in this file.
5701 With optional argument RADIO, only find radio targets."
5703 rtn)
5708 rtn)))
5711 "Make regular expression matching all strings in TARGETS.
5712 The regular expression finds the targets also if there is a line break
5713 between words."
5722 x)
5723 targets
5735 t)))
5738 "Compute the outline level of the heading at point.
5739 This function assumes that the cursor is at the beginning of a line matched
5740 by `outline-regexp'. Otherwise it returns garbage.
5741 If this is called at a normal headline, the level is the number of stars.
5742 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5749 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5756 "Functions that can manipulate `org-font-lock-extra-keywords'.
5757 This is called after `org-font-lock-extra-keywords' is defined, but before
5758 it is installed to be used by font lock. This can be useful if something
5769 ;; Call the hook
5771 ;; Headlines
5778 ;; Table lines
5781 ;; Table internals
5786 ;; Drawers
5789 ;; Properties
5793 ;; Links
5803 ;; TODO keyword
5805 org-todo-regexp)
5807 ;; DONE
5815 nil)
5816 ;; Priorities
5818 ;; Tags
5820 ;; Special keywords
5825 ;; Emphasis
5830 ;; Checkboxes
5831 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5836 ;; Description list items
5839 ;; ARCHIVEd headings
5841 org-outline-regexp-bol
5844 ;; Specials
5848 ;; Code
5850 ;; COMMENT
5857 ;; Blocks and meta lines
5859 )))
5862 ;; Now set the full font-lock-keywords
5869 "Toggle the composition display of entities as UTF8 characters."
5881 "Find an entity to fontify."
5887 limit t)
5899 nil))))
5902 "Fontify string S like in Org-mode."
5914 "Get the right face for match N in font-lock matching of headlines."
5927 "Get the right face for a TODO keyword KWD.
5928 If KWD is a number, get the corresponding match group."
5936 "Create a face list that inherits INHERIT, but sets the foreground color.
5937 When FACE-OR-COLOR is not a string, just return it."
5941 face-or-color)
5942 face-or-color))
5945 "Add the special tag faces."
5954 "Add the special priority faces."
5961 org-priority-faces)))
5966 "Get the right face for a TODO keyword KWD.
5967 If KWD is a number, get the corresponding match group."
5974 "Remove fontification and activation overlays from links."
5979 deactivate-mark buffer-file-name buffer-file-truename)
5983 invisible t intangible t
5984 org-no-flyspell t org-emphasis t))
5994 "Remove specific display properties that have been added by font lock.
5995 The will remove the raise properties that are used to show superscripts
5996 and subscripts."
6006 "Add raise properties to sub/superscripts."
6010 org-match-substring-regexp
6011 org-match-substring-with-braces-regexp)
6012 limit t)
6022 ;; FIXME: Should we go back one character here, for a_b^c
6023 ;; (goto-char (1- pos)) ;????????????????????
6025 t
6027 'display
6043 t)))))
6045 ;;;; Visibility cycling, including org-goto and indirect buffer
6047 ;;; Cycling
6054 ;;;###autoload
6059 "TAB-action and visibility cycling for Org-mode.
6061 This is the command invoked in Org-mode by the TAB key. Its main purpose
6062 is outline visibility cycling, but it also invokes other actions
6063 in special contexts.
6065 - When this function is called with a prefix argument, rotate the entire
6066 buffer through 3 states (global cycling)
6067 1. OVERVIEW: Show only top-level headlines.
6068 2. CONTENTS: Show all headlines of all levels, but no body text.
6069 3. SHOW ALL: Show everything.
6070 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6071 determined by the variable `org-startup-folded', and by any VISIBILITY
6072 properties in the buffer.
6073 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6074 including any drawers.
6076 - When inside a table, re-align the table and move to the next field.
6078 - When point is at the beginning of a headline, rotate the subtree started
6079 by this line through 3 different states (local cycling)
6080 1. FOLDED: Only the main headline is shown.
6081 2. CHILDREN: The main headline and the direct children are shown.
6082 From this state, you can move to one of the children
6083 and zoom in further.
6084 3. SUBTREE: Show the entire subtree, including body text.
6085 If there is no subtree, switch directly from CHILDREN to FOLDED.
6087 - When point is at the beginning of an empty headline and the variable
6088 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6089 of the headline by demoting and promoting it to likely levels. This
6090 speeds up creation document structure by pressing TAB once or several
6091 times right after creating a new headline.
6093 - When there is a numeric prefix, go up to a heading with level ARG, do
6094 a `show-subtree' and return to the previous cursor position. If ARG
6095 is negative, go up that many levels.
6097 - When point is not at the beginning of a headline, execute the global
6098 binding for TAB, which is re-indenting the line. See the option
6099 `org-cycle-emulate-tab' for details.
6101 - Special case: if point is at the beginning of the buffer and there is
6102 no headline in line 1, this function will act as if called with prefix arg
6103 (C-u TAB, same as S-TAB) also when called without prefix arg.
6104 But only if also the variable `org-cycle-global-at-bob' is t."
6114 org-inlinetask-min-level
6119 limit-level)))
6122 outline-regexp
6130 org-cycle-hook))
6134 ;; special case: use global cycling
6148 ;; Table: enter it or move to the next field.
6159 ;; Global cycling: delegate to `org-cycle-internal-global'.
6162 ;; Drawers: delegate to `org-flag-drawer'.
6170 ;; Show-subtree, ARG levels up from here.
6178 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6186 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6193 ;; From there: TAB emulation and template completion.
6215 t
6224 "Do the global cycling action."
6228 ;; We just created the overview - now do table of contents
6229 ;; This can be slow in very large buffers, so indicate action
6239 ;; We just showed the table of contents - now show everything
6247 ;; Default action: go to overview
6255 "Do the local cycling action."
6257 ;; First, determine end of headline (EOH), end of subtree or item
6258 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6282 ;; Determine end invisible part of buffer (EOL)
6284 ;; XEmacs doesn't have `next-single-char-property-change'
6294 ;; Find out what to do next and set `this-command'
6297 ;; Nothing is hidden behind this heading
6309 org-cycle-skip-children-state-if-no-children))))
6310 ;; Entire subtree is hidden in one line: children view
6318 ;; Fold every list in subtree to top-level items.
6340 ;; We just showed the children, or no children are there,
6341 ;; now show everything.
6348 ;; Default action: hide the subtree.
6355 ;;;###autoload
6357 "Cycle the global visibility. For details see `org-cycle'.
6359 With a numeric prefix, show all headlines up to that level."
6375 "Set the visibility required by startup options and properties."
6390 "Switch subtree visibilities according to :VISIBILITY: property."
6397 nil t)
6421 ;; This function uses outline-regexp instead of the more fundamental
6422 ;; org-outline-regexp so that org-cycle-global works outside of Org
6423 ;; buffers, where outline-regexp is needed.
6425 "Switch to overview mode, showing only top-level headlines.
6426 Really, this shows all headlines with level equal or greater than the level
6427 of the first headline in the buffer. This is important, because if the
6428 first headline is not level one, then (hide-sublevels 1) gives confusing
6429 results."
6440 "Show all headlines in the buffer, like a table of contents.
6441 With numerical argument N, show content up to level N."
6444 ;; Visit all headings and show their offspring
6451 t)
6460 "Adjust the window after a change in outline visibility.
6461 This function is the default value of the hook `org-cycle-hook'."
6471 "Remove outline overlays that do not contain non-white stuff."
6481 "Fix visibility issues after moving a subtree."
6482 ;; First, find a reasonable region to look at:
6483 ;; Start two siblings above, end three below
6501 ;; Properly fold already folded siblings
6512 "Show empty lines above all visible headlines.
6513 The region to be covered depends on STATE when called through
6514 `org-cycle-hook'. Lisp program can use t for STATE to get the
6515 entire buffer covered. Note that an empty line is only shown if there
6516 are at least `org-cycle-separator-lines' empty lines before the headline."
6526 beg end b e)
6550 ;; Never hide empty lines at the end of the file.
6560 "Move to the parent and re-show empty lines before visible headlines."
6566 "Return `org-agenda-files' list, plus all open org-mode files.
6567 This is useful for operations that need to scan all of a user's
6568 open and agenda-wise Org files."
6576 files))
6579 "Return the beginning position of the current entry."
6583 "Return the end position of the current entry."
6587 "Re-hide all drawers after a visibility state change."
6613 "Is the end of the current subtree visible?"
6618 "Move cursor to the first headline and recenter the headline.
6619 Optional argument N means put the headline into the Nth line of the window."
6625 ;;; Saving and restoring visibility
6628 "Return a list of the locations of all outline overlays.
6629 These are overlays with the `invisible' property value `outline'.
6630 The return value is a list of cons cells, with start and stop
6631 positions for each overlay.
6632 If USE-MARKERS is set, return the positions as markers."
6650 "Create visibility overlays for all positions in DATA.
6651 DATA should have been made by `org-outline-overlay-data'."
6659 data)))))
6661 ;;; Folding of blocks
6668 "Call FUNCTION at the head of all source blocks in the current buffer.
6669 Optional arguments START and END can be used to limit the range."
6681 "Toggle the visibility of all blocks in the current buffer."
6685 "Fold all blocks in the current buffer."
6691 "Unfold all blocks in the current buffer."
6697 "Toggle visibility of block at point."
6708 "Toggle the visibility of the current block."
6715 ov)
6731 ;; make the block accessible to isearch
6733 ov 'isearch-open-invisible
6744 ;; org-tab-after-check-for-cycling-hook
6746 ;; Remove overlays when changing major mode
6751 ;;; Org-goto
6757 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6773 nil)
6774 (org-defkey map "q" 'org-goto-quit)
6775 (org-defkey map "n" 'outline-next-visible-heading)
6776 (org-defkey map "p" 'outline-previous-visible-heading)
6777 (org-defkey map "f" 'outline-forward-same-level)
6778 (org-defkey map "b" 'outline-backward-same-level)
6779 (org-defkey map "u" 'outline-up-heading))
6780 (org-defkey map "/" 'org-occur)
6781 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6782 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6783 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6784 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6785 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6786 map))
6788 (defconst org-goto-help
6789 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6790 RET=jump to location [Q]uit and return to previous location
6791 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6793 (defvar org-goto-start-pos) ; dynamically scoped parameter
6795 ;; FIXME: Docstring does not mention both interfaces
6796 (defun org-goto (&optional alternative-interface)
6797 "Look up a different location in the current file, keeping current visibility.
6799 When you want look-up or go to a different location in a document, the
6800 fastest way is often to fold the entire buffer and then dive into the tree.
6801 This method has the disadvantage, that the previous location will be folded,
6802 which may not be what you want.
6804 This command works around this by showing a copy of the current buffer
6805 in an indirect buffer, in overview mode. You can dive into the tree in
6806 that copy, use org-occur and incremental search to find a location.
6807 When pressing RET or `Q', the command returns to the original buffer in
6808 which the visibility is still unchanged. After RET is will also jump to
6809 the location selected in the indirect buffer and expose the headline
6810 hierarchy above."
6811 (interactive "P")
6812 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6813 (org-refile-use-outline-path t)
6814 (org-refile-target-verify-function nil)
6815 (interface
6816 (if (not alternative-interface)
6817 org-goto-interface
6818 (if (eq org-goto-interface 'outline)
6819 'outline-path-completion
6820 'outline)))
6821 (org-goto-start-pos (point))
6822 (selected-point
6823 (if (eq interface 'outline)
6824 (car (org-get-location (current-buffer) org-goto-help))
6825 (let ((pa (org-refile-get-location "Goto" nil nil t)))
6826 (org-refile-check-position pa)
6827 (nth 3 pa)))))
6828 (if selected-point
6829 (progn
6830 (org-mark-ring-push org-goto-start-pos)
6831 (goto-char selected-point)
6832 (if (or (outline-invisible-p) (org-invisible-p2))
6833 (org-show-context 'org-goto)))
6834 (message "Quit"))))
6836 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6837 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6838 (defvar org-goto-local-auto-isearch-map) ; defined below
6840 (defun org-get-location (buf help)
6841 "Let the user select a location in the Org-mode buffer BUF.
6842 This function uses a recursive edit. It returns the selected position
6843 or nil."
6844 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6845 (isearch-hide-immediately nil)
6846 (isearch-search-fun-function
6847 (lambda () 'org-goto-local-search-headings))
6848 (org-goto-selected-point org-goto-exit-command)
6849 (pop-up-frames nil)
6850 (special-display-buffer-names nil)
6851 (special-display-regexps nil)
6852 (special-display-function nil))
6853 (save-excursion
6854 (save-window-excursion
6855 (delete-other-windows)
6856 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6857 (org-pop-to-buffer-same-window
6858 (condition-case nil
6859 (make-indirect-buffer (current-buffer) "*org-goto*")
6860 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6861 (with-output-to-temp-buffer "*Help*"
6862 (princ help))
6863 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6864 (setq buffer-read-only nil)
6865 (let ((org-startup-truncated t)
6866 (org-startup-folded nil)
6867 (org-startup-align-all-tables nil))
6868 (org-mode)
6869 (org-overview))
6870 (setq buffer-read-only t)
6871 (if (and (boundp 'org-goto-start-pos)
6872 (integer-or-marker-p org-goto-start-pos))
6873 (let ((org-show-hierarchy-above t)
6874 (org-show-siblings t)
6875 (org-show-following-heading t))
6876 (goto-char org-goto-start-pos)
6877 (and (outline-invisible-p) (org-show-context)))
6878 (goto-char (point-min)))
6879 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6880 (message "Select location and press RET")
6881 (use-local-map org-goto-map)
6882 (recursive-edit)
6883 ))
6884 (kill-buffer "*org-goto*")
6885 (cons org-goto-selected-point org-goto-exit-command)))
6887 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6888 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6889 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6890 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6892 (defun org-goto-local-search-headings (string bound noerror)
6893 "Search and make sure that any matches are in headlines."
6894 (catch 'return
6895 (while (if isearch-forward
6896 (search-forward string bound noerror)
6897 (search-backward string bound noerror))
6898 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6899 (and (member :headline context)
6900 (not (member :tags context))))
6901 (throw 'return (point))))))
6903 (defun org-goto-local-auto-isearch ()
6904 "Start isearch."
6905 (interactive)
6906 (goto-char (point-min))
6907 (let ((keys (this-command-keys)))
6908 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6909 (isearch-mode t)
6910 (isearch-process-search-char (string-to-char keys)))))
6912 (defun org-goto-ret (&optional arg)
6913 "Finish `org-goto' by going to the new location."
6914 (interactive "P")
6915 (setq org-goto-selected-point (point)
6916 org-goto-exit-command 'return)
6917 (throw 'exit nil))
6919 (defun org-goto-left ()
6920 "Finish `org-goto' by going to the new location."
6921 (interactive)
6922 (if (org-at-heading-p)
6923 (progn
6924 (beginning-of-line 1)
6925 (setq org-goto-selected-point (point)
6926 org-goto-exit-command 'left)
6927 (throw 'exit nil))
6928 (error "Not on a heading")))
6930 (defun org-goto-right ()
6931 "Finish `org-goto' by going to the new location."
6932 (interactive)
6933 (if (org-at-heading-p)
6934 (progn
6935 (setq org-goto-selected-point (point)
6936 org-goto-exit-command 'right)
6937 (throw 'exit nil))
6938 (error "Not on a heading")))
6940 (defun org-goto-quit ()
6941 "Finish `org-goto' without cursor motion."
6942 (interactive)
6943 (setq org-goto-selected-point nil)
6944 (setq org-goto-exit-command 'quit)
6945 (throw 'exit nil))
6947 ;;; Indirect buffer display of subtrees
6949 (defvar org-indirect-dedicated-frame nil
6950 "This is the frame being used for indirect tree display.")
6951 (defvar org-last-indirect-buffer nil)
6953 (defun org-tree-to-indirect-buffer (&optional arg)
6954 "Create indirect buffer and narrow it to current subtree.
6955 With numerical prefix ARG, go up to this level and then take that tree.
6956 If ARG is negative, go up that many levels.
6957 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6958 indirect buffer previously made with this command, to avoid proliferation of
6959 indirect buffers. However, when you call the command with a \
6961 when `org-indirect-buffer-display' is `new-frame', the last buffer
6962 is kept so that you can work with several indirect buffers at the same time.
6963 If `org-indirect-buffer-display' is `dedicated-frame', the \
6965 requests that a new frame be made for the new buffer, so that the dedicated
6966 frame is not changed."
6967 (interactive "P")
6968 (let ((cbuf (current-buffer))
6969 (cwin (selected-window))
6970 (pos (point))
6971 beg end level heading ibuf)
6972 (save-excursion
6973 (org-back-to-heading t)
6974 (when (numberp arg)
6975 (setq level (org-outline-level))
6976 (if (< arg 0) (setq arg (+ level arg)))
6977 (while (> (setq level (org-outline-level)) arg)
6978 (outline-up-heading 1 t)))
6979 (setq beg (point)
6980 heading (org-get-heading))
6981 (org-end-of-subtree t t)
6982 (if (org-at-heading-p) (backward-char 1))
6983 (setq end (point)))
6984 (if (and (buffer-live-p org-last-indirect-buffer)
6985 (not (eq org-indirect-buffer-display 'new-frame))
6986 (not arg))
6987 (kill-buffer org-last-indirect-buffer))
6988 (setq ibuf (org-get-indirect-buffer cbuf)
6989 org-last-indirect-buffer ibuf)
6990 (cond
6991 ((or (eq org-indirect-buffer-display 'new-frame)
6992 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6993 (select-frame (make-frame))
6994 (delete-other-windows)
6995 (org-pop-to-buffer-same-window ibuf)
6996 (org-set-frame-title heading))
6997 ((eq org-indirect-buffer-display 'dedicated-frame)
6998 (raise-frame
6999 (select-frame (or (and org-indirect-dedicated-frame
7000 (frame-live-p org-indirect-dedicated-frame)
7001 org-indirect-dedicated-frame)
7002 (setq org-indirect-dedicated-frame (make-frame)))))
7003 (delete-other-windows)
7004 (org-pop-to-buffer-same-window ibuf)
7005 (org-set-frame-title (concat "Indirect: " heading)))
7006 ((eq org-indirect-buffer-display 'current-window)
7007 (org-pop-to-buffer-same-window ibuf))
7008 ((eq org-indirect-buffer-display 'other-window)
7009 (pop-to-buffer ibuf))
7010 (t (error "Invalid value")))
7011 (if (featurep 'xemacs)
7012 (save-excursion (org-mode) (turn-on-font-lock)))
7013 (narrow-to-region beg end)
7014 (show-all)
7015 (goto-char pos)
7016 (run-hook-with-args 'org-cycle-hook 'all)
7017 (and (window-live-p cwin) (select-window cwin))))
7019 (defun org-get-indirect-buffer (&optional buffer)
7020 (setq buffer (or buffer (current-buffer)))
7021 (let ((n 1) (base (buffer-name buffer)) bname)
7022 (while (buffer-live-p
7023 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7024 (setq n (1+ n)))
7025 (condition-case nil
7026 (make-indirect-buffer buffer bname 'clone)
7027 (error (make-indirect-buffer buffer bname)))))
7029 (defun org-set-frame-title (title)
7030 "Set the title of the current frame to the string TITLE."
7031 ;; FIXME: how to name a single frame in XEmacs???
7032 (unless (featurep 'xemacs)
7033 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7035 ;;;; Structure editing
7037 ;;; Inserting headlines
7039 (defun org-previous-line-empty-p ()
7040 (save-excursion
7041 (and (not (bobp))
7042 (or (beginning-of-line 0) t)
7043 (save-match-data
7046 (defun org-insert-heading (&optional force-heading invisible-ok)
7047 "Insert a new heading or item with same depth at point.
7048 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7049 If point is at the beginning of a headline, insert a sibling before the
7050 current headline. If point is not at the beginning, split the line,
7051 create the new headline with the text in the current line after point
7052 \(but see also the variable `org-M-RET-may-split-line').
7054 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7055 This is important for non-interactive uses of the command."
7056 (interactive "P")
7057 (if (or (= (buffer-size) 0)
7058 (and (not (save-excursion
7059 (and (ignore-errors (org-back-to-heading invisible-ok))
7060 (org-at-heading-p))))
7061 (or force-heading (not (org-in-item-p)))))
7062 (progn
7064 (run-hooks 'org-insert-heading-hook))
7065 (when (or force-heading (not (org-insert-item)))
7066 (let* ((empty-line-p nil)
7067 (level nil)
7068 (on-heading (org-at-heading-p))
7069 (head (save-excursion
7070 (condition-case nil
7071 (progn
7072 (org-back-to-heading invisible-ok)
7073 (when (and (not on-heading)
7074 (featurep 'org-inlinetask)
7075 (integerp org-inlinetask-min-level)
7076 (>= (length (match-string 0))
7077 org-inlinetask-min-level))
7078 ;; Find a heading level before the inline task
7079 (while (and (setq level (org-up-heading-safe))
7080 (>= level org-inlinetask-min-level)))
7081 (if (org-at-heading-p)
7082 (org-back-to-heading invisible-ok)
7083 (error "This should not happen")))
7084 (setq empty-line-p (org-previous-line-empty-p))
7085 (match-string 0))
7086 (error "*"))))
7087 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7088 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7089 pos hide-previous previous-pos)
7090 (cond
7091 ((and (org-at-heading-p) (bolp)
7092 (or (bobp)
7093 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7094 ;; insert before the current line
7095 (open-line (if blank 2 1)))
7096 ((and (bolp)
7097 (not org-insert-heading-respect-content)
7098 (or (bobp)
7099 (save-excursion
7100 (backward-char 1) (not (outline-invisible-p)))))
7101 ;; insert right here
7102 nil)
7103 (t
7104 ;; somewhere in the line
7105 (save-excursion
7106 (setq previous-pos (point-at-bol))
7107 (end-of-line)
7108 (setq hide-previous (outline-invisible-p)))
7109 (and org-insert-heading-respect-content (org-show-subtree))
7110 (let ((split
7111 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7112 (save-excursion
7113 (let ((p (point)))
7114 (goto-char (point-at-bol))
7115 (and (looking-at org-complex-heading-regexp)
7116 (match-beginning 4)
7117 (> p (match-beginning 4)))))))
7118 tags pos)
7119 (cond
7120 (org-insert-heading-respect-content
7121 (org-end-of-subtree nil t)
7122 (when (featurep 'org-inlinetask)
7123 (while (and (not (eobp))
7125 (>= (length (match-string 1))
7126 org-inlinetask-min-level))
7127 (org-end-of-subtree nil t)))
7128 (or (bolp) (newline))
7129 (or (org-previous-line-empty-p)
7130 (and blank (newline)))
7131 (open-line 1))
7132 ((org-at-heading-p)
7133 (when hide-previous
7134 (show-children)
7135 (org-show-entry))
7137 (setq tags (and (match-end 2) (match-string 2)))
7138 (and (match-end 1)
7139 (delete-region (match-beginning 1) (match-end 1)))
7140 (setq pos (point-at-bol))
7141 (or split (end-of-line 1))
7142 (delete-horizontal-space)
7144 (buffer-substring (point-at-bol) (point)))
7145 (insert " "))
7146 (newline (if blank 2 1))
7147 (when tags
7148 (save-excursion
7149 (goto-char pos)
7150 (end-of-line 1)
7151 (insert " " tags)
7152 (org-set-tags nil 'align))))
7153 (t
7154 (or split (end-of-line 1))
7155 (newline (if blank 2 1)))))))
7156 (insert head) (just-one-space)
7157 (setq pos (point))
7158 (end-of-line 1)
7159 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7160 (when (and org-insert-heading-respect-content hide-previous)
7161 (save-excursion
7162 (goto-char previous-pos)
7163 (hide-subtree)))
7164 (run-hooks 'org-insert-heading-hook)))))
7166 (defun org-get-heading (&optional no-tags no-todo)
7167 "Return the heading of the current entry, without the stars.
7168 When NO-TAGS is non-nil, don't include tags.
7169 When NO-TODO is non-nil, don't include TODO keywords."
7170 (save-excursion
7171 (org-back-to-heading t)
7172 (cond
7173 ((and no-tags no-todo)
7174 (looking-at org-complex-heading-regexp)
7175 (match-string 4))
7176 (no-tags
7177 (looking-at (concat org-outline-regexp
7180 (match-string 1))
7181 (no-todo
7182 (looking-at org-todo-line-regexp)
7183 (match-string 3))
7184 (t (looking-at org-heading-regexp)
7185 (match-string 2)))))
7187 (defun org-heading-components ()
7188 "Return the components of the current heading.
7189 This is a list with the following elements:
7190 - the level as an integer
7191 - the reduced level, different if `org-odd-levels-only' is set.
7192 - the TODO keyword, or nil
7193 - the priority character, like ?A, or nil if no priority is given
7194 - the headline text itself, or the tags string if no headline text
7195 - the tags string, or nil."
7196 (save-excursion
7197 (org-back-to-heading t)
7198 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7199 (list (length (match-string 1))
7200 (org-reduced-level (length (match-string 1)))
7201 (org-match-string-no-properties 2)
7202 (and (match-end 3) (aref (match-string 3) 2))
7203 (org-match-string-no-properties 4)
7204 (org-match-string-no-properties 5)))))
7206 (defun org-get-entry ()
7207 "Get the entry text, after heading, entire subtree."
7208 (save-excursion
7209 (org-back-to-heading t)
7210 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7212 (defun org-insert-heading-after-current ()
7213 "Insert a new heading with same level as current, after current subtree."
7214 (interactive)
7215 (org-back-to-heading)
7216 (org-insert-heading)
7217 (org-move-subtree-down)
7218 (end-of-line 1))
7220 (defun org-insert-heading-respect-content ()
7221 (interactive)
7222 (let ((org-insert-heading-respect-content t))
7223 (org-insert-heading t)))
7225 (defun org-insert-todo-heading-respect-content (&optional force-state)
7226 (interactive "P")
7227 (let ((org-insert-heading-respect-content t))
7228 (org-insert-todo-heading force-state t)))
7230 (defun org-insert-todo-heading (arg &optional force-heading)
7231 "Insert a new heading with the same level and TODO state as current heading.
7232 If the heading has no TODO state, or if the state is DONE, use the first
7233 state (TODO by default). Also with prefix arg, force first state."
7234 (interactive "P")
7235 (when (or force-heading (not (org-insert-item 'checkbox)))
7236 (org-insert-heading force-heading)
7237 (save-excursion
7238 (org-back-to-heading)
7239 (outline-previous-heading)
7240 (looking-at org-todo-line-regexp))
7241 (let*
7242 ((new-mark-x
7243 (if (or arg
7244 (not (match-beginning 2))
7245 (member (match-string 2) org-done-keywords))
7246 (car org-todo-keywords-1)
7247 (match-string 2)))
7248 (new-mark
7249 (or
7250 (run-hook-with-args-until-success
7251 'org-todo-get-default-hook new-mark-x nil)
7252 new-mark-x)))
7253 (beginning-of-line 1)
7254 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7255 (if org-treat-insert-todo-heading-as-state-change
7256 (org-todo new-mark)
7257 (insert new-mark " "))))
7258 (when org-provide-todo-statistics
7259 (org-update-parent-todo-statistics))))
7261 (defun org-insert-subheading (arg)
7262 "Insert a new subheading and demote it.
7263 Works for outline headings and for plain lists alike."
7264 (interactive "P")
7265 (org-insert-heading arg)
7266 (cond
7267 ((org-at-heading-p) (org-do-demote))
7268 ((org-at-item-p) (org-indent-item))))
7270 (defun org-insert-todo-subheading (arg)
7271 "Insert a new subheading with TODO keyword or checkbox and demote it.
7272 Works for outline headings and for plain lists alike."
7273 (interactive "P")
7274 (org-insert-todo-heading arg)
7275 (cond
7276 ((org-at-heading-p) (org-do-demote))
7277 ((org-at-item-p) (org-indent-item))))
7279 ;;; Promotion and Demotion
7281 (defvar org-after-demote-entry-hook nil
7282 "Hook run after an entry has been demoted.
7283 The cursor will be at the beginning of the entry.
7284 When a subtree is being demoted, the hook will be called for each node.")
7286 (defvar org-after-promote-entry-hook nil
7287 "Hook run after an entry has been promoted.
7288 The cursor will be at the beginning of the entry.
7289 When a subtree is being promoted, the hook will be called for each node.")
7291 (defun org-promote-subtree ()
7292 "Promote the entire subtree.
7293 See also `org-promote'."
7294 (interactive)
7295 (save-excursion
7296 (org-with-limited-levels (org-map-tree 'org-promote)))
7297 (org-fix-position-after-promote))
7299 (defun org-demote-subtree ()
7300 "Demote the entire subtree. See `org-demote'.
7301 See also `org-promote'."
7302 (interactive)
7303 (save-excursion
7304 (org-with-limited-levels (org-map-tree 'org-demote)))
7305 (org-fix-position-after-promote))
7308 (defun org-do-promote ()
7309 "Promote the current heading higher up the tree.
7310 If the region is active in `transient-mark-mode', promote all headings
7311 in the region."
7312 (interactive)
7313 (save-excursion
7314 (if (org-region-active-p)
7315 (org-map-region 'org-promote (region-beginning) (region-end))
7316 (org-promote)))
7317 (org-fix-position-after-promote))
7319 (defun org-do-demote ()
7320 "Demote the current heading lower down the tree.
7321 If the region is active in `transient-mark-mode', demote all headings
7322 in the region."
7323 (interactive)
7324 (save-excursion
7325 (if (org-region-active-p)
7326 (org-map-region 'org-demote (region-beginning) (region-end))
7327 (org-demote)))
7328 (org-fix-position-after-promote))
7330 (defun org-fix-position-after-promote ()
7331 "Make sure that after pro/demotion cursor position is right."
7332 (let ((pos (point)))
7333 (when (save-excursion
7334 (beginning-of-line 1)
7335 (looking-at org-todo-line-regexp)
7336 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7337 (cond ((eobp) (insert " "))
7338 ((eolp) (insert " "))
7339 ((equal (char-after) ?\ ) (forward-char 1))))))
7341 (defun org-current-level ()
7342 "Return the level of the current entry, or nil if before the first headline.
7343 The level is the number of stars at the beginning of the headline."
7344 (save-excursion
7345 (org-with-limited-levels
7346 (if (ignore-errors (org-back-to-heading t))
7347 (funcall outline-level)))))
7349 (defun org-get-previous-line-level ()
7350 "Return the outline depth of the last headline before the current line.
7351 Returns 0 for the first headline in the buffer, and nil if before the
7352 first headline."
7353 (let ((current-level (org-current-level))
7354 (prev-level (when (> (line-number-at-pos) 1)
7355 (save-excursion
7356 (beginning-of-line 0)
7357 (org-current-level)))))
7358 (cond ((null current-level) nil) ; Before first headline
7359 ((null prev-level) 0) ; At first headline
7360 (prev-level))))
7362 (defun org-reduced-level (l)
7363 "Compute the effective level of a heading.
7364 This takes into account the setting of `org-odd-levels-only'."
7365 (cond
7366 ((zerop l) 0)
7367 (org-odd-levels-only (1+ (floor (/ l 2))))
7368 (t l)))
7370 (defun org-level-increment ()
7371 "Return the number of stars that will be added or removed at a
7372 time to headlines when structure editing, based on the value of
7373 `org-odd-levels-only'."
7374 (if org-odd-levels-only 2 1))
7376 (defun org-get-valid-level (level &optional change)
7377 "Rectify a level change under the influence of `org-odd-levels-only'
7378 LEVEL is a current level, CHANGE is by how much the level should be
7379 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7380 even level numbers will become the next higher odd number."
7381 (if org-odd-levels-only
7382 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7383 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7384 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7385 (max 1 (+ level (or change 0)))))
7387 (if (boundp 'define-obsolete-function-alias)
7388 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7389 (define-obsolete-function-alias 'org-get-legal-level
7390 'org-get-valid-level)
7391 (define-obsolete-function-alias 'org-get-legal-level
7392 'org-get-valid-level "23.1")))
7394 (defun org-promote ()
7395 "Promote the current heading higher up the tree.
7396 If the region is active in `transient-mark-mode', promote all headings
7397 in the region."
7398 (org-back-to-heading t)
7399 (let* ((level (save-match-data (funcall outline-level)))
7400 (after-change-functions (remove 'flyspell-after-change-function
7401 after-change-functions))
7402 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7403 (diff (abs (- level (length up-head) -1))))
7404 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7405 (replace-match up-head nil t)
7406 ;; Fixup tag positioning
7407 (and org-auto-align-tags (org-set-tags nil t))
7408 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7409 (run-hooks 'org-after-promote-entry-hook)))
7411 (defun org-demote ()
7412 "Demote the current heading lower down the tree.
7413 If the region is active in `transient-mark-mode', demote all headings
7414 in the region."
7415 (org-back-to-heading t)
7416 (let* ((level (save-match-data (funcall outline-level)))
7417 (after-change-functions (remove 'flyspell-after-change-function
7418 after-change-functions))
7419 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7420 (diff (abs (- level (length down-head) -1))))
7421 (replace-match down-head nil t)
7422 ;; Fixup tag positioning
7423 (and org-auto-align-tags (org-set-tags nil t))
7424 (if org-adapt-indentation (org-fixup-indentation diff))
7425 (run-hooks 'org-after-demote-entry-hook)))
7427 (defun org-cycle-level ()
7428 "Cycle the level of an empty headline through possible states.
7429 This goes first to child, then to parent, level, then up the hierarchy.
7430 After top level, it switches back to sibling level."
7431 (interactive)
7432 (let ((org-adapt-indentation nil))
7433 (when (org-point-at-end-of-empty-headline)
7434 (setq this-command 'org-cycle-level) ; Only needed for caching
7435 (let ((cur-level (org-current-level))
7436 (prev-level (org-get-previous-line-level)))
7437 (cond
7438 ;; If first headline in file, promote to top-level.
7439 ((= prev-level 0)
7440 (loop repeat (/ (- cur-level 1) (org-level-increment))
7441 do (org-do-promote)))
7442 ;; If same level as prev, demote one.
7443 ((= prev-level cur-level)
7444 (org-do-demote))
7445 ;; If parent is top-level, promote to top level if not already.
7446 ((= prev-level 1)
7447 (loop repeat (/ (- cur-level 1) (org-level-increment))
7448 do (org-do-promote)))
7449 ;; If top-level, return to prev-level.
7450 ((= cur-level 1)
7451 (loop repeat (/ (- prev-level 1) (org-level-increment))
7452 do (org-do-demote)))
7453 ;; If less than prev-level, promote one.
7454 ((< cur-level prev-level)
7455 (org-do-promote))
7456 ;; If deeper than prev-level, promote until higher than
7457 ;; prev-level.
7458 ((> cur-level prev-level)
7459 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7460 do (org-do-promote))))
7461 t))))
7463 (defun org-map-tree (fun)
7464 "Call FUN for every heading underneath the current one."
7465 (org-back-to-heading)
7466 (let ((level (funcall outline-level)))
7467 (save-excursion
7468 (funcall fun)
7469 (while (and (progn
7470 (outline-next-heading)
7471 (> (funcall outline-level) level))
7472 (not (eobp)))
7473 (funcall fun)))))
7475 (defun org-map-region (fun beg end)
7476 "Call FUN for every heading between BEG and END."
7477 (let ((org-ignore-region t))
7478 (save-excursion
7479 (setq end (copy-marker end))
7480 (goto-char beg)
7481 (if (and (re-search-forward org-outline-regexp-bol nil t)
7482 (< (point) end))
7483 (funcall fun))
7484 (while (and (progn
7485 (outline-next-heading)
7486 (< (point) end))
7487 (not (eobp)))
7488 (funcall fun)))))
7490 (defvar org-property-end-re) ; silence byte-compiler
7491 (defun org-fixup-indentation (diff)
7492 "Change the indentation in the current entry by DIFF.
7493 However, if any line in the current entry has no indentation, or if it
7494 would end up with no indentation after the change, nothing at all is done."
7495 (save-excursion
7496 (let ((end (save-excursion (outline-next-heading)
7497 (point-marker)))
7498 (prohibit (if (> diff 0)
7501 col)
7502 (unless (save-excursion (end-of-line 1)
7503 (re-search-forward prohibit end t))
7504 (while (and (< (point) end)
7506 (goto-char (match-end 0))
7507 (setq col (current-column))
7508 (if (< diff 0) (replace-match ""))
7509 (org-indent-to-column (+ diff col))))
7510 (move-marker end nil))))
7512 (defun org-convert-to-odd-levels ()
7513 "Convert an org-mode file with all levels allowed to one with odd levels.
7514 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7515 level 5 etc."
7516 (interactive)
7517 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7518 (let ((outline-level 'org-outline-level)
7519 (org-odd-levels-only nil) n)
7520 (save-excursion
7521 (goto-char (point-min))
7523 (setq n (- (length (match-string 0)) 2))
7524 (while (>= (setq n (1- n)) 0)
7525 (org-demote))
7526 (end-of-line 1))))))
7528 (defun org-convert-to-oddeven-levels ()
7529 "Convert an org-mode file with only odd levels to one with odd/even levels.
7530 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7531 file contains a section with an even level, conversion would
7532 destroy the structure of the file. An error is signaled in this
7533 case."
7534 (interactive)
7535 (goto-char (point-min))
7536 ;; First check if there are no even levels
7538 (org-show-context t)
7539 (error "Not all levels are odd in this file. Conversion not possible"))
7540 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7541 (let ((outline-regexp org-outline-regexp)
7542 (outline-level 'org-outline-level)
7543 (org-odd-levels-only nil) n)
7544 (save-excursion
7545 (goto-char (point-min))
7547 (setq n (/ (1- (length (match-string 0))) 2))
7548 (while (>= (setq n (1- n)) 0)
7549 (org-promote))
7550 (end-of-line 1))))))
7552 (defun org-tr-level (n)
7553 "Make N odd if required."
7554 (if org-odd-levels-only (1+ (/ n 2)) n))
7556 ;;; Vertical tree motion, cutting and pasting of subtrees
7558 (defun org-move-subtree-up (&optional arg)
7559 "Move the current subtree up past ARG headlines of the same level."
7560 (interactive "p")
7561 (org-move-subtree-down (- (prefix-numeric-value arg))))
7563 (defun org-move-subtree-down (&optional arg)
7564 "Move the current subtree down past ARG headlines of the same level."
7565 (interactive "p")
7566 (setq arg (prefix-numeric-value arg))
7567 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7568 'org-get-last-sibling))
7569 (ins-point (make-marker))
7570 (cnt (abs arg))
7571 (col (current-column))
7572 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7573 ;; Select the tree
7574 (org-back-to-heading)
7575 (setq beg0 (point))
7576 (save-excursion
7577 (setq ne-beg (org-back-over-empty-lines))
7578 (setq beg (point)))
7579 (save-match-data
7580 (save-excursion (outline-end-of-heading)
7581 (setq folded (outline-invisible-p)))
7582 (outline-end-of-subtree))
7583 (outline-next-heading)
7584 (setq ne-end (org-back-over-empty-lines))
7585 (setq end (point))
7586 (goto-char beg0)
7587 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7588 ;; include less whitespace
7589 (save-excursion
7590 (goto-char beg)
7591 (forward-line (- ne-beg ne-end))
7592 (setq beg (point))))
7593 ;; Find insertion point, with error handling
7594 (while (> cnt 0)
7595 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7596 (progn (goto-char beg0)
7597 (error "Cannot move past superior level or buffer limit")))
7598 (setq cnt (1- cnt)))
7599 (if (> arg 0)
7600 ;; Moving forward - still need to move over subtree
7601 (progn (org-end-of-subtree t t)
7602 (save-excursion
7603 (org-back-over-empty-lines)
7604 (or (bolp) (newline)))))
7605 (setq ne-ins (org-back-over-empty-lines))
7606 (move-marker ins-point (point))
7607 (setq txt (buffer-substring beg end))
7608 (org-save-markers-in-region beg end)
7609 (delete-region beg end)
7610 (org-remove-empty-overlays-at beg)
7611 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7612 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7614 (let ((bbb (point)))
7615 (insert-before-markers txt)
7616 (org-reinstall-markers-in-region bbb)
7617 (move-marker ins-point bbb))
7619 (setq ins-end (point))
7620 (goto-char ins-point)
7621 (org-skip-whitespace)
7622 (when (and (< arg 0)
7623 (org-first-sibling-p)
7624 (> ne-ins ne-beg))
7625 ;; Move whitespace back to beginning
7626 (save-excursion
7627 (goto-char ins-end)
7628 (let ((kill-whole-line t))
7629 (kill-line (- ne-ins ne-beg)) (point)))
7631 (move-marker ins-point nil)
7632 (if folded
7633 (hide-subtree)
7634 (org-show-entry)
7635 (show-children)
7636 (org-cycle-hide-drawers 'children))
7637 (org-clean-visibility-after-subtree-move)
7638 ;; move back to the initial column we were at
7639 (move-to-column col)))
7641 (defvar org-subtree-clip ""
7642 "Clipboard for cut and paste of subtrees.
7643 This is actually only a copy of the kill, because we use the normal kill
7644 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7646 (defvar org-subtree-clip-folded nil
7647 "Was the last copied subtree folded?
7648 This is used to fold the tree back after pasting.")
7650 (defun org-cut-subtree (&optional n)
7651 "Cut the current subtree into the clipboard.
7652 With prefix arg N, cut this many sequential subtrees.
7653 This is a short-hand for marking the subtree and then cutting it."
7654 (interactive "p")
7655 (org-copy-subtree n 'cut))
7657 (defun org-copy-subtree (&optional n cut force-store-markers)
7658 "Cut the current subtree into the clipboard.
7659 With prefix arg N, cut this many sequential subtrees.
7660 This is a short-hand for marking the subtree and then copying it.
7661 If CUT is non-nil, actually cut the subtree.
7662 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7663 of some markers in the region, even if CUT is non-nil. This is
7664 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7665 (interactive "p")
7666 (let (beg end folded (beg0 (point)))
7667 (if (org-called-interactively-p 'any)
7668 (org-back-to-heading nil) ; take what looks like a subtree
7669 (org-back-to-heading t)) ; take what is really there
7670 (org-back-over-empty-lines)
7671 (setq beg (point))
7673 (save-match-data
7674 (save-excursion (outline-end-of-heading)
7675 (setq folded (outline-invisible-p)))
7676 (condition-case nil
7677 (org-forward-same-level (1- n) t)
7678 (error nil))
7679 (org-end-of-subtree t t))
7680 (org-back-over-empty-lines)
7681 (setq end (point))
7682 (goto-char beg0)
7683 (when (> end beg)
7684 (setq org-subtree-clip-folded folded)
7685 (when (or cut force-store-markers)
7686 (org-save-markers-in-region beg end))
7687 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7688 (setq org-subtree-clip (current-kill 0))
7689 (message "%s: Subtree(s) with %d characters"
7690 (if cut "Cut" "Copied")
7691 (length org-subtree-clip)))))
7693 (defun org-paste-subtree (&optional level tree for-yank)
7694 "Paste the clipboard as a subtree, with modification of headline level.
7695 The entire subtree is promoted or demoted in order to match a new headline
7696 level.
7698 If the cursor is at the beginning of a headline, the same level as
7699 that headline is used to paste the tree
7701 If not, the new level is derived from the *visible* headings
7702 before and after the insertion point, and taken to be the inferior headline
7703 level of the two. So if the previous visible heading is level 3 and the
7704 next is level 4 (or vice versa), level 4 will be used for insertion.
7705 This makes sure that the subtree remains an independent subtree and does
7706 not swallow low level entries.
7708 You can also force a different level, either by using a numeric prefix
7709 argument, or by inserting the heading marker by hand. For example, if the
7712 If optional TREE is given, use this text instead of the kill ring.
7714 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7715 move back over whitespace before inserting, and move point to the end of
7716 the inserted text when done."
7717 (interactive "P")
7718 (setq tree (or tree (and kill-ring (current-kill 0))))
7719 (unless (org-kill-is-subtree-p tree)
7720 (error "%s"
7721 (substitute-command-keys
7723 (org-with-limited-levels
7724 (let* ((visp (not (outline-invisible-p)))
7725 (txt tree)
7727 (old-level (if (string-match org-outline-regexp-bol txt)
7728 (- (match-end 0) (match-beginning 0) 1)
7729 -1))
7730 (force-level (cond (level (prefix-numeric-value level))
7732 (string-match
7734 (point-at-bol) (point))))
7735 (- (match-end 1) (match-beginning 1)))
7736 ((and (bolp)
7737 (looking-at org-outline-regexp))
7738 (- (match-end 0) (point) 1))
7739 (t nil)))
7740 (previous-level (save-excursion
7741 (condition-case nil
7742 (progn
7743 (outline-previous-visible-heading 1)
7744 (if (looking-at ^re_)
7745 (- (match-end 0) (match-beginning 0) 1)
7746 1))
7747 (error 1))))
7748 (next-level (save-excursion
7749 (condition-case nil
7750 (progn
7751 (or (looking-at org-outline-regexp)
7752 (outline-next-visible-heading 1))
7753 (if (looking-at ^re_)
7754 (- (match-end 0) (match-beginning 0) 1)
7755 1))
7756 (error 1))))
7757 (new-level (or force-level (max previous-level next-level)))
7758 (shift (if (or (= old-level -1)
7759 (= new-level -1)
7760 (= old-level new-level))
7761 0
7762 (- new-level old-level)))
7763 (delta (if (> shift 0) -1 1))
7764 (func (if (> shift 0) 'org-demote 'org-promote))
7765 (org-odd-levels-only nil)
7766 beg end newend)
7767 ;; Remove the forced level indicator
7768 (if force-level
7769 (delete-region (point-at-bol) (point)))
7770 ;; Paste
7771 (beginning-of-line (if (bolp) 1 2))
7772 (unless for-yank (org-back-over-empty-lines))
7773 (setq beg (point))
7774 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7775 (insert-before-markers txt)
7777 (setq newend (point))
7778 (org-reinstall-markers-in-region beg)
7779 (setq end (point))
7780 (goto-char beg)
7782 (setq beg (point))
7783 (if (and (outline-invisible-p) visp)
7784 (save-excursion (outline-show-heading)))
7785 ;; Shift if necessary
7786 (unless (= shift 0)
7787 (save-restriction
7788 (narrow-to-region beg end)
7789 (while (not (= shift 0))
7790 (org-map-region func (point-min) (point-max))
7791 (setq shift (+ delta shift)))
7792 (goto-char (point-min))
7793 (setq newend (point-max))))
7794 (when (or (org-called-interactively-p 'interactive) for-yank)
7795 (message "Clipboard pasted as level %d subtree" new-level))
7796 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7797 kill-ring
7798 (eq org-subtree-clip (current-kill 0))
7799 org-subtree-clip-folded)
7800 ;; The tree was folded before it was killed/copied
7801 (hide-subtree))
7802 (and for-yank (goto-char newend)))))
7804 (defun org-kill-is-subtree-p (&optional txt)
7805 "Check if the current kill is an outline subtree, or a set of trees.
7806 Returns nil if kill does not start with a headline, or if the first
7807 headline level is not the largest headline level in the tree.
7808 So this will actually accept several entries of equal levels as well,
7809 which is OK for `org-paste-subtree'.
7810 If optional TXT is given, check this string instead of the current kill."
7811 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7812 (re (org-get-limited-outline-regexp))
7813 (^re (concat "^" re))
7814 (start-level (and kill
7815 (string-match
7817 kill)
7818 (- (match-end 2) (match-beginning 2) 1)))
7819 (start (1+ (or (match-beginning 2) -1))))
7820 (if (not start-level)
7821 (progn
7822 nil) ;; does not even start with a heading
7823 (catch 'exit
7824 (while (setq start (string-match ^re kill (1+ start)))
7825 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7826 (throw 'exit nil)))
7827 t))))
7829 (defvar org-markers-to-move nil
7830 "Markers that should be moved with a cut-and-paste operation.
7831 Those markers are stored together with their positions relative to
7832 the start of the region.")
7834 (defun org-save-markers-in-region (beg end)
7835 "Check markers in region.
7836 If these markers are between BEG and END, record their position relative
7837 to BEG, so that after moving the block of text, we can put the markers back
7838 into place.
7839 This function gets called just before an entry or tree gets cut from the
7840 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7841 called immediately, to move the markers with the entries."
7842 (setq org-markers-to-move nil)
7843 (when (featurep 'org-clock)
7844 (org-clock-save-markers-for-cut-and-paste beg end))
7845 (when (featurep 'org-agenda)
7846 (org-agenda-save-markers-for-cut-and-paste beg end)))
7848 (defun org-check-and-save-marker (marker beg end)
7849 "Check if MARKER is between BEG and END.
7850 If yes, remember the marker and the distance to BEG."
7851 (when (and (marker-buffer marker)
7852 (equal (marker-buffer marker) (current-buffer)))
7853 (if (and (>= marker beg) (< marker end))
7854 (push (cons marker (- marker beg)) org-markers-to-move))))
7856 (defun org-reinstall-markers-in-region (beg)
7857 "Move all remembered markers to their position relative to BEG."
7858 (mapc (lambda (x)
7859 (move-marker (car x) (+ beg (cdr x))))
7860 org-markers-to-move)
7861 (setq org-markers-to-move nil))
7863 (defun org-narrow-to-subtree ()
7864 "Narrow buffer to the current subtree."
7865 (interactive)
7866 (save-excursion
7867 (save-match-data
7868 (org-with-limited-levels
7869 (narrow-to-region
7870 (progn (org-back-to-heading t) (point))
7871 (progn (org-end-of-subtree t t)
7872 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
7873 (point)))))))
7875 (defun org-narrow-to-block ()
7876 "Narrow buffer to the current block."
7877 (interactive)
7878 (let* ((case-fold-search t)
7881 (if blockp
7882 (narrow-to-region (car blockp) (cdr blockp))
7883 (error "Not in a block"))))
7885 (eval-when-compile
7886 (defvar org-property-drawer-re))
7888 (defvar org-property-start-re) ;; defined below
7889 (defun org-clone-subtree-with-time-shift (n &optional shift)
7890 "Clone the task (subtree) at point N times.
7891 The clones will be inserted as siblings.
7893 In interactive use, the user will be prompted for the number of
7894 clones to be produced, and for a time SHIFT, which may be a
7895 repeater as used in time stamps, for example `+3d'.
7897 When a valid repeater is given and the entry contains any time
7898 stamps, the clones will become a sequence in time, with time
7899 stamps in the subtree shifted for each clone produced. If SHIFT
7900 is nil or the empty string, time stamps will be left alone. The
7901 ID property of the original subtree is removed.
7903 If the original subtree did contain time stamps with a repeater,
7904 the following will happen:
7905 - the repeater will be removed in each clone
7906 - an additional clone will be produced, with the current, unshifted
7907 date(s) in the entry.
7908 - the original entry will be placed *after* all the clones, with
7909 repeater intact.
7910 - the start days in the repeater in the original entry will be shifted
7911 to past the last clone.
7912 I this way you can spell out a number of instances of a repeating task,
7913 and still retain the repeater to cover future instances of the task."
7914 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7915 (let (beg end template task idprop
7916 shift-n shift-what doshift nmin nmax (n-no-remove -1)
7917 (drawer-re org-drawer-regexp))
7918 (if (not (and (integerp n) (> n 0)))
7919 (error "Invalid number of replications %s" n))
7922 shift)))
7923 (error "Invalid shift specification %s" shift))
7924 (when doshift
7925 (setq shift-n (string-to-number (match-string 1 shift))
7926 shift-what (cdr (assoc (match-string 2 shift)
7927 '(("d" . day) ("w" . week)
7928 ("m" . month) ("y" . year))))))
7929 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7930 (setq nmin 1 nmax n)
7931 (org-back-to-heading t)
7932 (setq beg (point))
7933 (setq idprop (org-entry-get nil "ID"))
7934 (org-end-of-subtree t t)
7936 (setq end (point))
7937 (setq template (buffer-substring beg end))
7938 (when (and doshift
7940 (delete-region beg end)
7941 (setq end beg)
7942 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7943 (goto-char end)
7944 (loop for n from nmin to nmax do
7945 ;; prepare clone
7946 (with-temp-buffer
7947 (insert template)
7948 (org-mode)
7949 (goto-char (point-min))
7950 (org-show-subtree)
7951 (and idprop (if org-clone-delete-id
7952 (org-entry-delete nil "ID")
7953 (org-id-get-create t)))
7954 (unless (= n 0)
7956 (kill-whole-line))
7957 (goto-char (point-min))
7958 (while (re-search-forward drawer-re nil t)
7959 (mapc (lambda (d)
7960 (org-remove-empty-drawer-at d (point))) org-drawers)))
7961 (goto-char (point-min))
7962 (when doshift
7963 (while (re-search-forward org-ts-regexp-both nil t)
7964 (org-timestamp-change (* n shift-n) shift-what))
7965 (unless (= n n-no-remove)
7966 (goto-char (point-min))
7967 (while (re-search-forward org-ts-regexp nil t)
7968 (save-excursion
7969 (goto-char (match-beginning 0))
7971 (delete-region (match-beginning 1) (match-end 1)))))))
7972 (setq task (buffer-string)))
7973 (insert task))
7974 (goto-char beg)))
7976 ;;; Outline Sorting
7978 (defun org-sort (with-case)
7979 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7980 Optional argument WITH-CASE means sort case-sensitively."
7981 (interactive "P")
7982 (cond
7983 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7984 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7985 (t
7986 (org-call-with-arg 'org-sort-entries with-case))))
7988 (defun org-sort-remove-invisible (s)
7989 (remove-text-properties 0 (length s) org-rm-props s)
7990 (while (string-match org-bracket-link-regexp s)
7991 (setq s (replace-match (if (match-end 2)
7992 (match-string 3 s)
7993 (match-string 1 s)) t t s)))
7994 s)
7996 (defvar org-priority-regexp) ; defined later in the file
7998 (defvar org-after-sorting-entries-or-items-hook nil
7999 "Hook that is run after a bunch of entries or items have been sorted.
8000 When children are sorted, the cursor is in the parent line when this
8001 hook gets called. When a region or a plain list is sorted, the cursor
8002 will be in the first entry of the sorted region/list.")
8004 (defun org-sort-entries
8005 (&optional with-case sorting-type getkey-func compare-func property)
8006 "Sort entries on a certain level of an outline tree.
8007 If there is an active region, the entries in the region are sorted.
8008 Else, if the cursor is before the first entry, sort the top-level items.
8009 Else, the children of the entry at point are sorted.
8011 Sorting can be alphabetically, numerically, by date/time as given by
8012 a time stamp, by a property or by priority.
8014 The command prompts for the sorting type unless it has been given to the
8015 function through the SORTING-TYPE argument, which needs to be a character,
8016 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
8017 precise meaning of each character:
8019 n Numerically, by converting the beginning of the entry/item to a number.
8020 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8021 t By date/time, either the first active time stamp in the entry, or, if
8022 none exist, by the first inactive one.
8023 s By the scheduled date/time.
8024 d By deadline date/time.
8025 c By creation time, which is assumed to be the first inactive time stamp
8026 at the beginning of a line.
8027 p By priority according to the cookie.
8028 r By the value of a property.
8030 Capital letters will reverse the sort order.
8032 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8033 called with point at the beginning of the record. It must return either
8034 a string or a number that should serve as the sorting key for that record.
8036 Comparing entries ignores case by default. However, with an optional argument
8037 WITH-CASE, the sorting considers case as well."
8038 (interactive "P")
8039 (let ((case-func (if with-case 'identity 'downcase))
8040 start beg end stars re re2
8041 txt what tmp)
8042 ;; Find beginning and end of region to sort
8043 (cond
8044 ((org-region-active-p)
8045 ;; we will sort the region
8046 (setq end (region-end)
8047 what "region")
8048 (goto-char (region-beginning))
8049 (if (not (org-at-heading-p)) (outline-next-heading))
8050 (setq start (point)))
8051 ((or (org-at-heading-p)
8052 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8053 ;; we will sort the children of the current headline
8054 (org-back-to-heading)
8055 (setq start (point)
8056 end (progn (org-end-of-subtree t t)
8058 (org-back-over-empty-lines)
8059 (point))
8060 what "children")
8061 (goto-char start)
8062 (show-subtree)
8063 (outline-next-heading))
8064 (t
8065 ;; we will sort the top-level entries in this file
8066 (goto-char (point-min))
8067 (or (org-at-heading-p) (outline-next-heading))
8068 (setq start (point))
8069 (goto-char (point-max))
8070 (beginning-of-line 1)
8072 ;; File ends in a non-white line
8073 (end-of-line 1)
8075 (setq end (point-max))
8076 (setq what "top-level")
8077 (goto-char start)
8078 (show-all)))
8080 (setq beg (point))
8081 (if (>= beg end) (error "Nothing to sort"))
8084 (setq stars (match-string 1)
8085 re (concat "^" (regexp-quote stars) " +")
8087 txt (buffer-substring beg end))
8089 (if (and (not (equal stars "*")) (string-match re2 txt))
8090 (error "Region to sort contains a level above the first entry"))
8092 (unless sorting-type
8093 (message
8094 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8096 A/N/T/S/D/C/P/O/F means reversed:"
8097 what)
8098 (setq sorting-type (read-char-exclusive))
8100 (and (= (downcase sorting-type) ?f)
8101 (setq getkey-func
8102 (org-icompleting-read "Sort using function: "
8103 obarray 'fboundp t nil nil))
8104 (setq getkey-func (intern getkey-func)))
8106 (and (= (downcase sorting-type) ?r)
8107 (setq property
8108 (org-icompleting-read "Property: "
8109 (mapcar 'list (org-buffer-property-keys t))
8110 nil t))))
8112 (message "Sorting entries...")
8114 (save-restriction
8115 (narrow-to-region start end)
8116 (let ((dcst (downcase sorting-type))
8117 (case-fold-search nil)
8118 (now (current-time)))
8119 (sort-subr
8120 (/= dcst sorting-type)
8121 ;; This function moves to the beginning character of the "record" to
8122 ;; be sorted.
8123 (lambda nil
8124 (if (re-search-forward re nil t)
8125 (goto-char (match-beginning 0))
8126 (goto-char (point-max))))
8127 ;; This function moves to the last character of the "record" being
8128 ;; sorted.
8129 (lambda nil
8130 (save-match-data
8131 (condition-case nil
8132 (outline-forward-same-level 1)
8133 (error
8134 (goto-char (point-max))))))
8135 ;; This function returns the value that gets sorted against.
8136 (lambda nil
8137 (cond
8138 ((= dcst ?n)
8139 (if (looking-at org-complex-heading-regexp)
8140 (string-to-number (match-string 4))
8141 nil))
8142 ((= dcst ?a)
8143 (if (looking-at org-complex-heading-regexp)
8144 (funcall case-func (match-string 4))
8145 nil))
8146 ((= dcst ?t)
8147 (let ((end (save-excursion (outline-next-heading) (point))))
8148 (if (or (re-search-forward org-ts-regexp end t)
8149 (re-search-forward org-ts-regexp-both end t))
8150 (org-time-string-to-seconds (match-string 0))
8151 (org-float-time now))))
8152 ((= dcst ?c)
8153 (let ((end (save-excursion (outline-next-heading) (point))))
8154 (if (re-search-forward
8156 end t)
8157 (org-time-string-to-seconds (match-string 0))
8158 (org-float-time now))))
8159 ((= dcst ?s)
8160 (let ((end (save-excursion (outline-next-heading) (point))))
8161 (if (re-search-forward org-scheduled-time-regexp end t)
8162 (org-time-string-to-seconds (match-string 1))
8163 (org-float-time now))))
8164 ((= dcst ?d)
8165 (let ((end (save-excursion (outline-next-heading) (point))))
8166 (if (re-search-forward org-deadline-time-regexp end t)
8167 (org-time-string-to-seconds (match-string 1))
8168 (org-float-time now))))
8169 ((= dcst ?p)
8170 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8171 (string-to-char (match-string 2))
8172 org-default-priority))
8173 ((= dcst ?r)
8174 (or (org-entry-get nil property) ""))
8175 ((= dcst ?o)
8176 (if (looking-at org-complex-heading-regexp)
8177 (- 9999 (length (member (match-string 2)
8178 org-todo-keywords-1)))))
8179 ((= dcst ?f)
8180 (if getkey-func
8181 (progn
8182 (setq tmp (funcall getkey-func))
8183 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8184 tmp)
8185 (error "Invalid key function `%s'" getkey-func)))
8186 (t (error "Invalid sorting type `%c'" sorting-type))))
8187 nil
8188 (cond
8189 ((= dcst ?a) 'string<)
8190 ((= dcst ?f) compare-func)
8191 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8192 (t nil)))))
8193 (run-hooks 'org-after-sorting-entries-or-items-hook)
8194 (message "Sorting entries...done")))
8196 (defun org-do-sort (table what &optional with-case sorting-type)
8197 "Sort TABLE of WHAT according to SORTING-TYPE.
8198 The user will be prompted for the SORTING-TYPE if the call to this
8199 function does not specify it. WHAT is only for the prompt, to indicate
8200 what is being sorted. The sorting key will be extracted from
8201 the car of the elements of the table.
8202 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8203 (unless sorting-type
8204 (message
8205 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8206 what)
8207 (setq sorting-type (read-char-exclusive)))
8208 (let ((dcst (downcase sorting-type))
8209 extractfun comparefun)
8210 ;; Define the appropriate functions
8211 (cond
8212 ((= dcst ?n)
8213 (setq extractfun 'string-to-number
8214 comparefun (if (= dcst sorting-type) '< '>)))
8215 ((= dcst ?a)
8216 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8217 (lambda(x) (downcase (org-sort-remove-invisible x))))
8218 comparefun (if (= dcst sorting-type)
8219 'string<
8220 (lambda (a b) (and (not (string< a b))
8221 (not (string= a b)))))))
8222 ((= dcst ?t)
8223 (setq extractfun
8224 (lambda (x)
8225 (if (or (string-match org-ts-regexp x)
8226 (string-match org-ts-regexp-both x))
8227 (org-float-time
8228 (org-time-string-to-time (match-string 0 x)))
8229 0))
8230 comparefun (if (= dcst sorting-type) '< '>)))
8231 (t (error "Invalid sorting type `%c'" sorting-type)))
8233 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8234 table)
8235 (lambda (a b) (funcall comparefun (car a) (car b))))))
8238 ;;; The orgstruct minor mode
8240 ;; Define a minor mode which can be used in other modes in order to
8241 ;; integrate the org-mode structure editing commands.
8243 ;; This is really a hack, because the org-mode structure commands use
8244 ;; keys which normally belong to the major mode. Here is how it
8245 ;; works: The minor mode defines all the keys necessary to operate the
8246 ;; structure commands, but wraps the commands into a function which
8247 ;; tests if the cursor is currently at a headline or a plain list
8248 ;; item. If that is the case, the structure command is used,
8249 ;; temporarily setting many Org-mode variables like regular
8250 ;; expressions for filling etc. However, when any of those keys is
8251 ;; used at a different location, function uses `key-binding' to look
8252 ;; up if the key has an associated command in another currently active
8253 ;; keymap (minor modes, major mode, global), and executes that
8254 ;; command. There might be problems if any of the keys is otherwise
8255 ;; used as a prefix key.
8257 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8258 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8259 ;; addresses this by checking explicitly for both bindings.
8261 (defvar orgstruct-mode-map (make-sparse-keymap)
8262 "Keymap for the minor `orgstruct-mode'.")
8264 (defvar org-local-vars nil
8265 "List of local variables, for use by `orgstruct-mode'.")
8267 ;;;###autoload
8268 (define-minor-mode orgstruct-mode
8269 "Toggle the minor mode `orgstruct-mode'.
8270 This mode is for using Org-mode structure commands in other
8271 modes. The following keys behave as if Org-mode were active, if
8272 the cursor is on a headline, or on a plain list item (both as
8273 defined by Org-mode).
8275 M-up Move entry/item up
8276 M-down Move entry/item down
8277 M-left Promote
8278 M-right Demote
8279 M-S-up Move entry/item up
8280 M-S-down Move entry/item down
8281 M-S-left Promote subtree
8282 M-S-right Demote subtree
8283 M-q Fill paragraph and items like in Org-mode
8284 C-c ^ Sort entries
8285 C-c - Cycle list bullet
8286 TAB Cycle item visibility
8287 M-RET Insert new heading/item
8288 S-M-RET Insert new TODO heading / Checkbox item
8289 C-c C-c Set tags / toggle checkbox"
8290 nil " OrgStruct" nil
8291 (org-load-modules-maybe)
8292 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8294 ;;;###autoload
8295 (defun turn-on-orgstruct ()
8296 "Unconditionally turn on `orgstruct-mode'."
8297 (orgstruct-mode 1))
8299 (defun orgstruct++-mode (&optional arg)
8300 "Toggle `orgstruct-mode', the enhanced version of it.
8301 In addition to setting orgstruct-mode, this also exports all indentation
8302 and autofilling variables from org-mode into the buffer. It will also
8303 recognize item context in multiline items.
8304 Note that turning off orgstruct-mode will *not* remove the
8305 indentation/paragraph settings. This can only be done by refreshing the
8307 (interactive "P")
8308 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8309 (if (< arg 1)
8310 (orgstruct-mode -1)
8311 (orgstruct-mode 1)
8312 (let (var val)
8313 (mapc
8314 (lambda (x)
8315 (when (string-match
8317 (symbol-name (car x)))
8318 (setq var (car x) val (nth 1 x))
8319 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8320 org-local-vars)
8321 (org-set-local 'orgstruct-is-++ t))))
8323 (defvar orgstruct-is-++ nil
8324 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8325 (make-variable-buffer-local 'orgstruct-is-++)
8327 ;;;###autoload
8328 (defun turn-on-orgstruct++ ()
8329 "Unconditionally turn on `orgstruct++-mode'."
8330 (orgstruct++-mode 1))
8332 (defun orgstruct-error ()
8333 "Error when there is no default binding for a structure key."
8334 (interactive)
8335 (error "This key has no function outside structure elements"))
8337 (defun orgstruct-setup ()
8338 "Setup orgstruct keymaps."
8339 (let ((nfunc 0)
8340 (bindings
8341 (list
8342 '([(meta up)] org-metaup)
8343 '([(meta down)] org-metadown)
8344 '([(meta left)] org-metaleft)
8345 '([(meta right)] org-metaright)
8346 '([(meta shift up)] org-shiftmetaup)
8347 '([(meta shift down)] org-shiftmetadown)
8348 '([(meta shift left)] org-shiftmetaleft)
8349 '([(meta shift right)] org-shiftmetaright)
8350 '([?\e (up)] org-metaup)
8351 '([?\e (down)] org-metadown)
8352 '([?\e (left)] org-metaleft)
8353 '([?\e (right)] org-metaright)
8354 '([?\e (shift up)] org-shiftmetaup)
8355 '([?\e (shift down)] org-shiftmetadown)
8356 '([?\e (shift left)] org-shiftmetaleft)
8357 '([?\e (shift right)] org-shiftmetaright)
8358 '([(shift up)] org-shiftup)
8359 '([(shift down)] org-shiftdown)
8360 '([(shift left)] org-shiftleft)
8361 '([(shift right)] org-shiftright)
8362 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8363 '("\M-q" fill-paragraph)
8364 '("\C-c^" org-sort)
8365 '("\C-c-" org-cycle-list-bullet)))
8366 elt key fun cmd)
8367 (while (setq elt (pop bindings))
8368 (setq nfunc (1+ nfunc))
8369 (setq key (org-key (car elt))
8370 fun (nth 1 elt)
8371 cmd (orgstruct-make-binding fun nfunc key))
8372 (org-defkey orgstruct-mode-map key cmd))
8374 ;; Special treatment needed for TAB and RET
8375 (org-defkey orgstruct-mode-map [(tab)]
8376 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8377 (org-defkey orgstruct-mode-map "\C-i"
8378 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8380 (org-defkey orgstruct-mode-map "\M-\C-m"
8381 (orgstruct-make-binding 'org-insert-heading 105
8382 "\M-\C-m" [(meta return)]))
8383 (org-defkey orgstruct-mode-map [(meta return)]
8384 (orgstruct-make-binding 'org-insert-heading 106
8385 [(meta return)] "\M-\C-m"))
8387 (org-defkey orgstruct-mode-map [(shift meta return)]
8388 (orgstruct-make-binding 'org-insert-todo-heading 107
8389 [(meta return)] "\M-\C-m"))
8391 (org-defkey orgstruct-mode-map "\e\C-m"
8392 (orgstruct-make-binding 'org-insert-heading 108
8393 "\e\C-m" [?\e (return)]))
8394 (org-defkey orgstruct-mode-map [?\e (return)]
8395 (orgstruct-make-binding 'org-insert-heading 109
8396 [?\e (return)] "\e\C-m"))
8397 (org-defkey orgstruct-mode-map [?\e (shift return)]
8398 (orgstruct-make-binding 'org-insert-todo-heading 110
8399 [?\e (return)] "\e\C-m"))
8401 (unless org-local-vars
8402 (setq org-local-vars (org-get-local-variables)))
8404 t))
8406 (defun orgstruct-make-binding (fun n &rest keys)
8407 "Create a function for binding in the structure minor mode.
8408 FUN is the command to call inside a table. N is used to create a unique
8409 command name. KEYS are keys that should be checked in for a command
8410 to execute outside of tables."
8411 (eval
8412 (list 'defun
8413 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8414 '(arg)
8416 "Outside of structure, run the binding of `"
8417 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8418 "'.")
8419 '(interactive "p")
8420 (list 'if
8421 `(org-context-p 'headline 'item
8422 (and orgstruct-is-++
8423 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8424 'item-body))
8425 (list 'org-run-like-in-org-mode (list 'quote fun))
8426 (list 'let '(orgstruct-mode)
8427 (list 'call-interactively
8428 (append '(or)
8429 (mapcar (lambda (k)
8430 (list 'key-binding k))
8431 keys)
8432 '('orgstruct-error))))))))
8434 (defun org-context-p (&rest contexts)
8435 "Check if local context is any of CONTEXTS.
8436 Possible values in the list of contexts are `table', `headline', and `item'."
8437 (let ((pos (point)))
8438 (goto-char (point-at-bol))
8439 (prog1 (or (and (memq 'table contexts)
8441 (and (memq 'headline contexts)
8442 (looking-at org-outline-regexp))
8443 (and (memq 'item contexts)
8445 (and (memq 'item-body contexts)
8446 (org-in-item-p)))
8447 (goto-char pos))))
8449 (defun org-get-local-variables ()
8450 "Return a list of all local variables in an org-mode buffer."
8451 (let (varlist)
8452 (with-current-buffer (get-buffer-create "*Org tmp*")
8453 (erase-buffer)
8454 (org-mode)
8455 (setq varlist (buffer-local-variables)))
8456 (kill-buffer "*Org tmp*")
8457 (delq nil
8458 (mapcar
8459 (lambda (x)
8460 (setq x
8461 (if (symbolp x)
8462 (list x)
8463 (list (car x) (list 'quote (cdr x)))))
8464 (if (string-match
8465 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8466 (symbol-name (car x)))
8467 x nil))
8468 varlist))))
8470 (defun org-clone-local-variables (from-buffer &optional regexp)
8471 "Clone local variables from FROM-BUFFER.
8472 Optional argument REGEXP selects variables to clone."
8473 (mapc
8474 (lambda (pair)
8475 (and (symbolp (car pair))
8476 (or (null regexp)
8477 (string-match regexp (symbol-name (car pair))))
8478 (set (make-local-variable (car pair))
8479 (cdr pair))))
8480 (buffer-local-variables from-buffer)))
8482 ;;;###autoload
8483 (defun org-run-like-in-org-mode (cmd)
8484 "Run a command, pretending that the current buffer is in Org-mode.
8485 This will temporarily bind local variables that are typically bound in
8486 Org-mode to the values they have in Org-mode, and then interactively
8487 call CMD."
8488 (org-load-modules-maybe)
8489 (unless org-local-vars
8490 (setq org-local-vars (org-get-local-variables)))
8491 (eval (list 'let org-local-vars
8492 (list 'call-interactively (list 'quote cmd)))))
8494 ;;;; Archiving
8496 (defun org-get-category (&optional pos force-refresh)
8497 "Get the category applying to position POS."
8498 (if force-refresh (org-refresh-category-properties))
8499 (let ((pos (or pos (point))))
8500 (or (get-text-property pos 'org-category)
8501 (progn (org-refresh-category-properties)
8502 (get-text-property pos 'org-category)))))
8504 (defun org-refresh-category-properties ()
8505 "Refresh category text properties in the buffer."
8506 (let ((def-cat (cond
8507 ((null org-category)
8508 (if buffer-file-name
8509 (file-name-sans-extension
8510 (file-name-nondirectory buffer-file-name))
8511 "???"))
8512 ((symbolp org-category) (symbol-name org-category))
8513 (t org-category)))
8514 beg end cat pos optionp)
8515 (org-unmodified
8516 (save-excursion
8517 (save-restriction
8518 (widen)
8519 (goto-char (point-min))
8520 (put-text-property (point) (point-max) 'org-category def-cat)
8521 (while (re-search-forward
8523 (setq pos (match-end 0)
8524 optionp (equal (char-after (match-beginning 0)) ?#)
8525 cat (org-trim (match-string 2)))
8526 (if optionp
8527 (setq beg (point-at-bol) end (point-max))
8528 (org-back-to-heading t)
8529 (setq beg (point) end (org-end-of-subtree t t)))
8530 (put-text-property beg end 'org-category cat)
8531 (put-text-property beg end 'org-category-position beg)
8532 (goto-char pos)))))))
8535 ;;;; Link Stuff
8537 ;;; Link abbreviations
8539 (defun org-link-expand-abbrev (link)
8540 "Apply replacements as defined in `org-link-abbrev-alist."
8542 (let* ((key (match-string 1 link))
8543 (as (or (assoc key org-link-abbrev-alist-local)
8544 (assoc key org-link-abbrev-alist)))
8545 (tag (and (match-end 2) (match-string 3 link)))
8546 rpl)
8547 (if (not as)
8548 link
8549 (setq rpl (cdr as))
8550 (cond
8551 ((symbolp rpl) (funcall rpl tag))
8552 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8553 ((string-match "%h" rpl)
8554 (replace-match (url-hexify-string (or tag "")) t t rpl))
8555 (t (concat rpl tag)))))
8556 link))
8558 ;;; Storing and inserting links
8560 (defvar org-insert-link-history nil
8561 "Minibuffer history for links inserted with `org-insert-link'.")
8563 (defvar org-stored-links nil
8564 "Contains the links stored with `org-store-link'.")
8566 (defvar org-store-link-plist nil
8567 "Plist with info about the most recently link created with `org-store-link'.")
8569 (defvar org-link-protocols nil
8570 "Link protocols added to Org-mode using `org-add-link-type'.")
8572 (defvar org-store-link-functions nil
8573 "List of functions that are called to create and store a link.
8574 Each function will be called in turn until one returns a non-nil
8575 value. Each function should check if it is responsible for creating
8576 this link (for example by looking at the major mode).
8577 If not, it must exit and return nil.
8578 If yes, it should return a non-nil value after a calling
8579 `org-store-link-props' with a list of properties and values.
8580 Special properties are:
8584 This is obligatory as well.
8585 :description Optional default description for the second pair
8586 of brackets in an Org-mode link. The user can still change
8587 this when inserting this link into an Org-mode buffer.
8589 In addition to these, any additional properties can be specified
8590 and then used in remember templates.")
8592 (defun org-add-link-type (type &optional follow export)
8593 "Add TYPE to the list of `org-link-types'.
8594 Re-compute all regular expressions depending on `org-link-types'
8596 FOLLOW and EXPORT are two functions.
8598 FOLLOW should take the link path as the single argument and do whatever
8599 is necessary to follow the link, for example find a file or display
8600 a mail message.
8602 EXPORT should format the link path for export to one of the export formats.
8603 It should be a function accepting three arguments:
8606 desc the description of the link, if any, or a description added by
8607 org-export-normalize-links if there is none
8608 format the export format, a symbol like `html' or `latex' or `ascii'..
8610 The function may use the FORMAT information to return different values
8611 depending on the format. The return value will be put literally into
8612 the exported file. If the return value is nil, this means Org should
8613 do what it normally does with links which do not have EXPORT defined.
8615 Org-mode has a built-in default for exporting links. If you are happy with
8616 this default, there is no need to define an export function for the link
8617 type. For a simple example of an export function, see `org-bbdb.el'."
8618 (add-to-list 'org-link-types type t)
8619 (org-make-link-regexps)
8620 (if (assoc type org-link-protocols)
8621 (setcdr (assoc type org-link-protocols) (list follow export))
8622 (push (list type follow export) org-link-protocols)))
8624 (defvar org-agenda-buffer-name)
8626 ;;;###autoload
8627 (defun org-store-link (arg)
8629 This link is added to `org-stored-links' and can later be inserted
8632 For some link types, a prefix arg is interpreted:
8633 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8634 For file links, arg negates `org-context-in-file-links'."
8635 (interactive "P")
8636 (org-load-modules-maybe)
8637 (setq org-store-link-plist nil) ; reset
8638 (org-with-limited-levels
8639 (let (link cpltxt desc description search txt custom-id agenda-link)
8640 (cond
8642 ((run-hook-with-args-until-success 'org-store-link-functions)
8643 (setq link (plist-get org-store-link-plist :link)
8644 desc (or (plist-get org-store-link-plist :description) link)))
8646 ((equal (buffer-name) "*Org Edit Src Example*")
8647 (let (label gc)
8648 (while (or (not label)
8649 (save-excursion
8650 (save-restriction
8651 (widen)
8652 (goto-char (point-min))
8653 (re-search-forward
8654 (regexp-quote (format org-coderef-label-format label))
8655 nil t))))
8656 (when label (message "Label exists already") (sit-for 2))
8657 (setq label (read-string "Code line label: " label)))
8658 (end-of-line 1)
8659 (setq link (format org-coderef-label-format label))
8660 (setq gc (- 79 (length link)))
8661 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8662 (insert link)
8663 (setq link (concat "(" label ")") desc nil)))
8665 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8666 ;; We are in the agenda, link to referenced location
8667 (let ((m (or (get-text-property (point) 'org-hd-marker)
8668 (get-text-property (point) 'org-marker))))
8669 (when m
8670 (org-with-point-at m
8671 (setq agenda-link
8672 (if (org-called-interactively-p 'any)
8673 (call-interactively 'org-store-link)
8674 (org-store-link nil)))))))
8676 ((eq major-mode 'calendar-mode)
8677 (let ((cd (calendar-cursor-to-date)))
8678 (setq link
8679 (format-time-string
8680 (car org-time-stamp-formats)
8681 (apply 'encode-time
8682 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8683 nil nil nil))))
8684 (org-store-link-props :type "calendar" :date cd)))
8686 ((eq major-mode 'w3-mode)
8687 (setq cpltxt (if (and (buffer-name)
8688 (not (string-match "Untitled" (buffer-name))))
8689 (buffer-name)
8690 (url-view-url t))
8691 link (org-make-link (url-view-url t)))
8692 (org-store-link-props :type "w3" :url (url-view-url t)))
8694 ((eq major-mode 'w3m-mode)
8695 (setq cpltxt (or w3m-current-title w3m-current-url)
8696 link (org-make-link w3m-current-url))
8697 (org-store-link-props :type "w3m" :url (url-view-url t)))
8699 ((setq search (run-hook-with-args-until-success
8700 'org-create-file-search-functions))
8701 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8702 "::" search))
8703 (setq cpltxt (or description link)))
8705 ((eq major-mode 'image-mode)
8706 (setq cpltxt (concat "file:"
8707 (abbreviate-file-name buffer-file-name))
8708 link (org-make-link cpltxt))
8709 (org-store-link-props :type "image" :file buffer-file-name))
8711 ((eq major-mode 'dired-mode)
8712 ;; link to the file in the current line
8713 (let ((file (dired-get-filename nil t)))
8714 (setq file (if file
8715 (abbreviate-file-name
8716 (expand-file-name (dired-get-filename nil t)))
8717 ;; otherwise, no file so use current directory.
8718 default-directory))
8719 (setq cpltxt (concat "file:" file)
8720 link (org-make-link cpltxt))))
8722 ((and (buffer-file-name (buffer-base-buffer)) (eq major-mode 'org-mode))
8723 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8724 (cond
8726 (setq cpltxt
8727 (concat "file:"
8728 (abbreviate-file-name
8729 (buffer-file-name (buffer-base-buffer)))
8730 "::" (match-string 1))
8731 link (org-make-link cpltxt)))
8732 ((and (featurep 'org-id)
8733 (or (eq org-link-to-org-use-id t)
8734 (and (eq org-link-to-org-use-id 'create-if-interactive)
8735 (org-called-interactively-p 'any))
8736 (and (eq org-link-to-org-use-id
8737 'create-if-interactive-and-no-custom-id)
8738 (org-called-interactively-p 'any)
8739 (not custom-id))
8740 (and org-link-to-org-use-id
8741 (org-entry-get nil "ID"))))
8742 ;; We can make a link using the ID.
8743 (setq link (condition-case nil
8744 (prog1 (org-id-store-link)
8745 (setq desc (plist-get org-store-link-plist
8746 :description)))
8747 (error
8748 ;; probably before first headline, link to file only
8749 (concat "file:"
8750 (abbreviate-file-name
8751 (buffer-file-name (buffer-base-buffer))))))))
8752 (t
8753 ;; Just link to current headline
8754 (setq cpltxt (concat "file:"
8755 (abbreviate-file-name
8756 (buffer-file-name (buffer-base-buffer)))))
8757 ;; Add a context search string
8758 (when (org-xor org-context-in-file-links arg)
8759 (setq txt (cond
8760 ((org-at-heading-p) nil)
8761 ((org-region-active-p)
8762 (buffer-substring (region-beginning) (region-end)))
8763 (t nil)))
8765 (setq cpltxt
8766 (concat cpltxt "::"
8767 (condition-case nil
8768 (org-make-org-heading-search-string txt)
8769 (error "")))
8770 desc (or (nth 4 (ignore-errors
8771 (org-heading-components))) "NONE"))))
8773 (setq cpltxt (substring cpltxt 0 -2)))
8774 (setq link (org-make-link cpltxt)))))
8776 ((buffer-file-name (buffer-base-buffer))
8777 ;; Just link to this file here.
8778 (setq cpltxt (concat "file:"
8779 (abbreviate-file-name
8780 (buffer-file-name (buffer-base-buffer)))))
8781 ;; Add a context string
8782 (when (org-xor org-context-in-file-links arg)
8783 (setq txt (if (org-region-active-p)
8784 (buffer-substring (region-beginning) (region-end))
8785 (buffer-substring (point-at-bol) (point-at-eol))))
8786 ;; Only use search option if there is some text.
8788 (setq cpltxt
8789 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8790 desc "NONE")))
8791 (setq link (org-make-link cpltxt)))
8793 ((org-called-interactively-p 'interactive)
8794 (error "Cannot link to a buffer which is not visiting a file"))
8796 (t (setq link nil)))
8798 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8799 (setq link (or link cpltxt)
8800 desc (or desc cpltxt))
8801 (if (equal desc "NONE") (setq desc nil))
8803 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8804 (progn
8805 (setq org-stored-links
8806 (cons (list link desc) org-stored-links))
8807 (message "Stored: %s" (or desc link))
8808 (when custom-id
8809 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8810 "::#" custom-id))
8811 (setq org-stored-links
8812 (cons (list link desc) org-stored-links))))
8813 (or agenda-link (and link (org-make-link-string link desc)))))))
8815 (defun org-store-link-props (&rest plist)
8816 "Store link properties, extract names and addresses."
8817 (let (x adr)
8818 (when (setq x (plist-get plist :from))
8819 (setq adr (mail-extract-address-components x))
8820 (setq plist (plist-put plist :fromname (car adr)))
8821 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8822 (when (setq x (plist-get plist :to))
8823 (setq adr (mail-extract-address-components x))
8824 (setq plist (plist-put plist :toname (car adr)))
8825 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8826 (let ((from (plist-get plist :from))
8827 (to (plist-get plist :to)))
8828 (when (and from to org-from-is-user-regexp)
8829 (setq plist
8830 (plist-put plist :fromto
8831 (if (string-match org-from-is-user-regexp from)
8832 (concat "to %t")
8833 (concat "from %f"))))))
8834 (setq org-store-link-plist plist))
8836 (defun org-add-link-props (&rest plist)
8837 "Add these properties to the link property list."
8838 (let (key value)
8839 (while plist
8840 (setq key (pop plist) value (pop plist))
8841 (setq org-store-link-plist
8842 (plist-put org-store-link-plist key value)))))
8844 (defun org-email-link-description (&optional fmt)
8845 "Return the description part of an email link.
8846 This takes information from `org-store-link-plist' and formats it
8847 according to FMT (default from `org-email-link-description-format')."
8848 (setq fmt (or fmt org-email-link-description-format))
8849 (let* ((p org-store-link-plist)
8850 (to (plist-get p :toaddress))
8851 (from (plist-get p :fromaddress))
8852 (table
8853 (list
8854 (cons "%c" (plist-get p :fromto))
8855 (cons "%F" (plist-get p :from))
8856 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8857 (cons "%T" (plist-get p :to))
8858 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8859 (cons "%s" (plist-get p :subject))
8860 (cons "%d" (plist-get p :date))
8861 (cons "%m" (plist-get p :message-id)))))
8862 (when (string-match "%c" fmt)
8863 ;; Check if the user wrote this message
8864 (if (and org-from-is-user-regexp from to
8865 (save-match-data (string-match org-from-is-user-regexp from)))
8866 (setq fmt (replace-match "to %t" t t fmt))
8867 (setq fmt (replace-match "from %f" t t fmt))))
8868 (org-replace-escapes fmt table)))
8870 (defun org-make-org-heading-search-string (&optional string heading)
8871 "Make search string for STRING or current headline."
8872 (interactive)
8873 (let ((s (or string (org-get-heading)))
8874 (lines org-context-in-file-links))
8875 (unless (and string (not heading))
8876 ;; We are using a headline, clean up garbage in there.
8877 (if (string-match org-todo-regexp s)
8878 (setq s (replace-match "" t t s)))
8880 (setq s (replace-match "" t t s)))
8881 (setq s (org-trim s))
8884 (setq s (replace-match "" t t s)))
8885 (while (string-match org-ts-regexp s)
8886 (setq s (replace-match "" t t s))))
8887 (or string (setq s (concat "*" s))) ; Add * for headlines
8888 (when (and string (integerp lines) (> lines 0))
8890 (when (< lines (length slines))
8891 (setq s (mapconcat
8892 'identity
8893 (reverse (nthcdr (- (length slines) lines)
8897 (defun org-make-link (&rest strings)
8898 "Concatenate STRINGS."
8899 (apply 'concat strings))
8901 (defun org-make-link-string (link &optional description)
8902 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8904 (error "Empty link"))
8905 (when (and description
8906 (stringp description)
8908 (setq description nil))
8909 (when (stringp description)
8910 ;; Remove brackets from the description, they are fatal.
8912 (setq description (replace-match "{" t t description)))
8914 (setq description (replace-match "}" t t description))))
8915 (when (equal link description)
8916 ;; No description needed, it is identical
8917 (setq description nil))
8918 (when (and (not description)
8919 (not (string-match (org-image-file-name-regexp) link))
8920 (not (equal link (org-link-escape link))))
8921 (setq description (org-extract-attributes link)))
8922 (setq link
8923 (cond ((string-match (org-image-file-name-regexp) link) link)
8924 ((string-match org-link-types-re link)
8925 (concat (match-string 1 link)
8926 (org-link-escape (substring link (match-end 1)))))
8927 (t (org-link-escape link))))
8928 (concat "[[" link "]"
8929 (if description (concat "[" description "]") "")
8930 "]"))
8932 (defconst org-link-escape-chars
8933 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8934 "List of characters that should be escaped in link.
8935 This is the list that is used for internal purposes.")
8937 (defvar org-url-encoding-use-url-hexify nil)
8939 (defconst org-link-escape-chars-browser
8940 '(?\ )
8941 "List of escapes for characters that are problematic in links.
8942 This is the list that is used before handing over to the browser.")
8944 (defun org-link-escape (text &optional table merge)
8945 "Return percent escaped representation of TEXT.
8946 TEXT is a string with the text to escape.
8947 Optional argument TABLE is a list with characters that should be
8948 escaped. When nil, `org-link-escape-chars' is used.
8949 If optional argument MERGE is set, merge TABLE into
8950 `org-link-escape-chars'."
8951 (if (and org-url-encoding-use-url-hexify (not table))
8952 (url-hexify-string text)
8953 (cond
8954 ((and table merge)
8955 (mapc (lambda (defchr)
8956 (unless (member defchr table)
8957 (setq table (cons defchr table)))) org-link-escape-chars))
8958 ((null table)
8959 (setq table org-link-escape-chars)))
8960 (mapconcat
8961 (lambda (char)
8962 (if (or (member char table)
8963 (< char 32) (= char 37) (> char 126))
8964 (mapconcat (lambda (sequence-element)
8965 (format "%%%.2X" sequence-element))
8966 (or (encode-coding-char char 'utf-8)
8967 (error "Unable to percent escape character: %s"
8968 (char-to-string char))) "")
8969 (char-to-string char))) text "")))
8971 (defun org-link-unescape (str)
8972 "Unhex hexified Unicode strings as returned from the JavaScript function
8973 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8974 (unless (and (null str) (string= "" str))
8975 (let ((pos 0) (case-fold-search t) unhexed)
8977 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8978 (setq str (replace-match unhexed t t str))
8979 (setq pos (+ pos (length unhexed))))))
8980 str)
8982 (defun org-link-unescape-compound (hex)
8983 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8984 Note: this function also decodes single byte encodings like
8986 (save-match-data
8987 (let* ((bytes (cdr (split-string hex "%")))
8988 (ret "")
8989 (eat 0)
8990 (sum 0))
8991 (while bytes
8992 (let* ((val (string-to-number (pop bytes) 16))
8993 (shift-xor
8994 (if (= 0 eat)
8995 (cond
8996 ((>= val 252) (cons 6 252))
8997 ((>= val 248) (cons 5 248))
8998 ((>= val 240) (cons 4 240))
8999 ((>= val 224) (cons 3 224))
9000 ((>= val 192) (cons 2 192))
9001 (t (cons 0 0)))
9002 (cons 6 128))))
9003 (if (>= val 192) (setq eat (car shift-xor)))
9004 (setq val (logxor val (cdr shift-xor)))
9005 (setq sum (+ (lsh sum (car shift-xor)) val))
9006 (if (> eat 0) (setq eat (- eat 1)))
9007 (cond
9008 ((= 0 eat) ;multi byte
9009 (setq ret (concat ret (org-char-to-string sum)))
9010 (setq sum 0))
9011 ((not bytes) ; single byte(s)
9012 (setq ret (org-link-unescape-single-byte-sequence hex))))
9013 )) ;; end (while bytes
9014 ret )))
9016 (defun org-link-unescape-single-byte-sequence (hex)
9017 "Unhexify hex-encoded single byte character sequences."
9018 (mapconcat (lambda (byte)
9019 (char-to-string (string-to-number byte 16)))
9020 (cdr (split-string hex "%")) ""))
9022 (defun org-xor (a b)
9023 "Exclusive or."
9024 (if a (not b) b))
9026 (defun org-fixup-message-id-for-http (s)
9027 "Replace special characters in a message id, so it can be used in an http query."
9028 (when (string-match "%" s)
9029 (setq s (mapconcat (lambda (c)
9030 (if (eq c ?%)
9031 "%25"
9032 (char-to-string c)))
9033 s "")))
9034 (while (string-match "<" s)
9035 (setq s (replace-match "%3C" t t s)))
9036 (while (string-match ">" s)
9037 (setq s (replace-match "%3E" t t s)))
9038 (while (string-match "@" s)
9039 (setq s (replace-match "%40" t t s)))
9040 s)
9042 ;;;###autoload
9043 (defun org-insert-link-global ()
9044 "Insert a link like Org-mode does.
9045 This command can be called in any mode to insert a link in Org-mode syntax."
9046 (interactive)
9047 (org-load-modules-maybe)
9048 (org-run-like-in-org-mode 'org-insert-link))
9050 (defun org-insert-link (&optional complete-file link-location default-description)
9051 "Insert a link. At the prompt, enter the link.
9053 Completion can be used to insert any of the link protocol prefixes like
9054 http or ftp in use.
9056 The history can be used to select a link previously stored with
9057 `org-store-link'. When the empty string is entered (i.e. if you just
9058 press RET at the prompt), the link defaults to the most recently
9059 stored link. As SPC triggers completion in the minibuffer, you need to
9060 use M-SPC or C-q SPC to force the insertion of a space character.
9062 You will also be prompted for a description, and if one is given, it will
9063 be displayed in the buffer instead of the link.
9065 If there is already a link at point, this command will allow you to edit link
9066 and description parts.
9069 be selected using completion. The path to the file will be relative to the
9070 current directory if the file is in the current directory or a subdirectory.
9071 Otherwise, the link will be the absolute path as completed in the minibuffer
9072 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9073 option `org-link-file-path-type'.
9076 the current directory or below.
9079 `org-keep-stored-link-after-insertion'.
9081 If `org-make-link-description-function' is non-nil, this function will be
9082 called with the link target, and the result will be the default
9083 link description.
9085 If the LINK-LOCATION parameter is non-nil, this value will be
9086 used as the link location instead of reading one interactively.
9088 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9089 be used as the default description."
9090 (interactive "P")
9091 (let* ((wcf (current-window-configuration))
9092 (region (if (org-region-active-p)
9093 (buffer-substring (region-beginning) (region-end))))
9094 (remove (and region (list (region-beginning) (region-end))))
9095 (desc region)
9096 tmphist ; byte-compile incorrectly complains about this
9097 (link link-location)
9098 entry file all-prefixes)
9099 (cond
9100 (link-location) ; specified by arg, just use it.
9101 ((org-in-regexp org-bracket-link-regexp 1)
9102 ;; We do have a link at point, and we are going to edit it.
9103 (setq remove (list (match-beginning 0) (match-end 0)))
9104 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9105 (setq link (read-string "Link: "
9106 (org-link-unescape
9107 (org-match-string-no-properties 1)))))
9108 ((or (org-in-regexp org-angle-link-re)
9109 (org-in-regexp org-plain-link-re))
9110 ;; Convert to bracket link
9111 (setq remove (list (match-beginning 0) (match-end 0))
9112 link (read-string "Link: "
9113 (org-remove-angle-brackets (match-string 0)))))
9114 ((member complete-file '((4) (16)))
9115 ;; Completing read for file names.
9116 (setq link (org-file-complete-link complete-file)))
9117 (t
9118 ;; Read link, with completion for stored links.
9119 (with-output-to-temp-buffer "*Org Links*"
9120 (princ "Insert a link.
9122 (when org-stored-links
9124 (princ (mapconcat
9125 (lambda (x)
9126 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
9128 (let ((cw (selected-window)))
9129 (select-window (get-buffer-window "*Org Links*" 'visible))
9130 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9131 (unless (pos-visible-in-window-p (point-max))
9132 (org-fit-window-to-buffer))
9133 (and (window-live-p cw) (select-window cw)))
9134 ;; Fake a link history, containing the stored links.
9135 (setq tmphist (append (mapcar 'car org-stored-links)
9136 org-insert-link-history))
9137 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9138 (mapcar 'car org-link-abbrev-alist)
9139 org-link-types))
9140 (unwind-protect
9141 (progn
9142 (setq link
9143 (let ((org-completion-use-ido nil)
9144 (org-completion-use-iswitchb nil))
9145 (org-completing-read
9146 "Link: "
9147 (append
9148 (mapcar (lambda (x) (list (concat x ":")))
9149 all-prefixes)
9150 (mapcar 'car org-stored-links))
9151 nil nil nil
9152 'tmphist
9153 (car (car org-stored-links)))))
9155 (error "No link selected"))
9156 (if (or (member link all-prefixes)
9157 (and (equal ":" (substring link -1))
9158 (member (substring link 0 -1) all-prefixes)
9159 (setq link (substring link 0 -1))))
9160 (setq link (org-link-try-special-completion link))))
9161 (set-window-configuration wcf)
9162 (kill-buffer "*Org Links*"))
9163 (setq entry (assoc link org-stored-links))
9164 (or entry (push link org-insert-link-history))
9165 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9166 (not org-keep-stored-link-after-insertion))
9167 (setq org-stored-links (delq (assoc link org-stored-links)
9168 org-stored-links)))
9169 (setq desc (or desc (nth 1 entry)))))
9171 (if (string-match org-plain-link-re link)
9172 ;; URL-like link, normalize the use of angular brackets.
9173 (setq link (org-make-link (org-remove-angle-brackets link))))
9175 ;; Check if we are linking to the current file with a search option
9176 ;; If yes, simplify the link by using only the search option.
9177 (when (and buffer-file-name
9179 (let* ((path (match-string 1 link))
9180 (case-fold-search nil)
9181 (search (match-string 2 link)))
9182 (save-match-data
9183 (if (equal (file-truename buffer-file-name) (file-truename path))
9184 ;; We are linking to this same file, with a search option
9185 (setq link search)))))
9187 ;; Check if we can/should use a relative path. If yes, simplify the link
9189 (let* ((type (match-string 1 link))
9190 (path (match-string 2 link))
9191 (origpath path)
9192 (case-fold-search nil))
9193 (cond
9194 ((or (eq org-link-file-path-type 'absolute)
9195 (equal complete-file '(16)))
9196 (setq path (abbreviate-file-name (expand-file-name path))))
9197 ((eq org-link-file-path-type 'noabbrev)
9198 (setq path (expand-file-name path)))
9199 ((eq org-link-file-path-type 'relative)
9200 (setq path (file-relative-name path)))
9201 (t
9202 (save-match-data
9203 (if (string-match (concat "^" (regexp-quote
9204 (expand-file-name
9205 (file-name-as-directory
9206 default-directory))))
9207 (expand-file-name path))
9208 ;; We are linking a file with relative path name.
9209 (setq path (substring (expand-file-name path)
9210 (match-end 0)))
9211 (setq path (abbreviate-file-name (expand-file-name path)))))))
9212 (setq link (concat type path))
9213 (if (equal desc origpath)
9214 (setq desc path))))
9216 (if org-make-link-description-function
9217 (setq desc (funcall org-make-link-description-function link desc))
9218 (if default-description (setq desc default-description)))
9220 (setq desc (read-string "Description: " desc))
9222 (if remove (apply 'delete-region remove))
9223 (insert (org-make-link-string link desc))))
9225 (defun org-link-try-special-completion (type)
9226 "If there is completion support for link type TYPE, offer it."
9227 (let ((fun (intern (concat "org-" type "-complete-link"))))
9228 (if (functionp fun)
9229 (funcall fun)
9230 (read-string "Link (no completion support): " (concat type ":")))))
9232 (defun org-file-complete-link (&optional arg)
9233 "Create a file link using completion."
9234 (let (file link)
9235 (setq file (read-file-name "File: "))
9236 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9237 (pwd1 (file-name-as-directory (abbreviate-file-name
9238 (expand-file-name ".")))))
9239 (cond
9240 ((equal arg '(16))
9241 (setq link (org-make-link
9242 "file:"
9243 (abbreviate-file-name (expand-file-name file)))))
9245 (setq link (org-make-link "file:" (match-string 1 file))))
9247 (expand-file-name file))
9248 (setq link (org-make-link
9249 "file:" (match-string 1 (expand-file-name file)))))
9250 (t (setq link (org-make-link "file:" file)))))
9251 link))
9253 (defun org-completing-read (&rest args)
9254 "Completing-read with SPACE being a normal character."
9255 (let ((enable-recursive-minibuffers t)
9256 (minibuffer-local-completion-map
9257 (copy-keymap minibuffer-local-completion-map)))
9258 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9259 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9260 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9261 (apply 'org-icompleting-read args)))
9263 (defun org-completing-read-no-i (&rest args)
9264 (let (org-completion-use-ido org-completion-use-iswitchb)
9265 (apply 'org-completing-read args)))
9267 (defun org-iswitchb-completing-read (prompt choices &rest args)
9268 "Use iswitch as a completing-read replacement to choose from choices.
9269 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9270 from."
9271 (let* ((iswitchb-use-virtual-buffers nil)
9272 (iswitchb-make-buflist-hook
9273 (lambda ()
9274 (setq iswitchb-temp-buflist choices))))
9275 (iswitchb-read-buffer prompt)))
9277 (defun org-icompleting-read (&rest args)
9278 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9279 (org-without-partial-completion
9280 (if (and org-completion-use-ido
9281 (fboundp 'ido-completing-read)
9282 (boundp 'ido-mode) ido-mode
9283 (listp (second args)))
9284 (let ((ido-enter-matching-directory nil))
9285 (apply 'ido-completing-read (concat (car args))
9286 (if (consp (car (nth 1 args)))
9287 (mapcar 'car (nth 1 args))
9288 (nth 1 args))
9289 (cddr args)))
9290 (if (and org-completion-use-iswitchb
9291 (boundp 'iswitchb-mode) iswitchb-mode
9292 (listp (second args)))
9293 (apply 'org-iswitchb-completing-read (concat (car args))
9294 (if (consp (car (nth 1 args)))
9295 (mapcar 'car (nth 1 args))
9296 (nth 1 args))
9297 (cddr args))
9298 (apply 'completing-read args)))))
9300 (defun org-extract-attributes (s)
9301 "Extract the attributes cookie from a string and set as text property."
9302 (let (a attr (start 0) key value)
9303 (save-match-data
9305 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9307 (setq key (match-string 1 a) value (match-string 2 a)
9308 start (match-end 0)
9309 attr (plist-put attr (intern key) value))))
9310 (org-add-props s nil 'org-attr attr))
9311 s))
9313 (defun org-extract-attributes-from-string (tag)
9314 (let (key value attr)
9316 (setq key (match-string 1 tag) value (match-string 2 tag)
9317 tag (replace-match "" t t tag)
9318 attr (plist-put attr (intern key) value)))
9319 (cons tag attr)))
9321 (defun org-attributes-to-string (plist)
9322 "Format a property list into an HTML attribute list."
9323 (let ((s "") key value)
9324 (while plist
9325 (setq key (pop plist) value (pop plist))
9326 (and value
9328 s))
9330 ;;; Opening/following a link
9332 (defvar org-link-search-failed nil)
9334 (defvar org-open-link-functions nil
9335 "Hook for functions finding a plain text link.
9336 These functions must take a single argument, the link content.
9337 They will be called for links that look like [[link text][description]]
9341 These functions will be called *before* Org attempts to resolve the
9342 link by doing text searches in the current buffer - so if you want a
9344 handle this as a special case.
9346 When the function does handle the link, it must return a non-nil value.
9347 If it decides that it is not responsible for this link, it must return
9348 nil to indicate that that Org-mode can continue with other options
9349 like exact and fuzzy text search.")
9351 (defun org-next-link ()
9352 "Move forward to the next link.
9353 If the link is in hidden text, expose it."
9354 (interactive)
9355 (when (and org-link-search-failed (eq this-command last-command))
9356 (goto-char (point-min))
9357 (message "Link search wrapped back to beginning of buffer"))
9358 (setq org-link-search-failed nil)
9359 (let* ((pos (point))
9360 (ct (org-context))
9361 (a (assoc :link ct)))
9362 (if a (goto-char (nth 2 a)))
9363 (if (re-search-forward org-any-link-re nil t)
9364 (progn
9365 (goto-char (match-beginning 0))
9366 (if (outline-invisible-p) (org-show-context)))
9367 (goto-char pos)
9368 (setq org-link-search-failed t)
9369 (error "No further link found"))))
9371 (defun org-previous-link ()
9372 "Move backward to the previous link.
9373 If the link is in hidden text, expose it."
9374 (interactive)
9375 (when (and org-link-search-failed (eq this-command last-command))
9376 (goto-char (point-max))
9377 (message "Link search wrapped back to end of buffer"))
9378 (setq org-link-search-failed nil)
9379 (let* ((pos (point))
9380 (ct (org-context))
9381 (a (assoc :link ct)))
9382 (if a (goto-char (nth 1 a)))
9383 (if (re-search-backward org-any-link-re nil t)
9384 (progn
9385 (goto-char (match-beginning 0))
9386 (if (outline-invisible-p) (org-show-context)))
9387 (goto-char pos)
9388 (setq org-link-search-failed t)
9389 (error "No further link found"))))
9391 (defun org-translate-link (s)
9392 "Translate a link string if a translation function has been defined."
9393 (if (and org-link-translation-function
9394 (fboundp org-link-translation-function)
9396 (progn
9397 (setq s (funcall org-link-translation-function
9398 (match-string 1) (match-string 2)))
9399 (concat (car s) ":" (cdr s)))
9400 s))
9402 (defun org-translate-link-from-planner (type path)
9403 "Translate a link from Emacs Planner syntax so that Org can follow it.
9404 This is still an experimental function, your mileage may vary."
9405 (cond
9406 ((member type '("http" "https" "news" "ftp"))
9407 ;; standard Internet links are the same.
9408 nil)
9409 ((and (equal type "irc") (string-match "^//" path))
9410 ;; Planner has two / at the beginning of an irc link, we have 1.
9411 ;; We should have zero, actually....
9412 (setq path (substring path 1)))
9413 ((and (equal type "lisp") (string-match "^/" path))
9414 ;; Planner has a slash, we do not.
9415 (setq type "elisp" path (substring path 1)))
9417 ;; A typical message link. Planner has the id after the final slash,
9418 ;; we separate it with a hash mark
9419 (setq path (concat (match-string 1 path) "#"
9420 (org-remove-angle-brackets (match-string 2 path)))))
9421 )
9422 (cons type path))
9424 (defun org-find-file-at-mouse (ev)
9425 "Open file link or URL at mouse."
9426 (interactive "e")
9427 (mouse-set-point ev)
9428 (org-open-at-point 'in-emacs))
9430 (defun org-open-at-mouse (ev)
9431 "Open file link or URL at mouse.
9432 See the docstring of `org-open-file' for details."
9433 (interactive "e")
9434 (mouse-set-point ev)
9435 (if (eq major-mode 'org-agenda-mode)
9436 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9437 (org-open-at-point))
9439 (defvar org-window-config-before-follow-link nil
9440 "The window configuration before following a link.
9441 This is saved in case the need arises to restore it.")
9443 (defvar org-open-link-marker (make-marker)
9444 "Marker pointing to the location where `org-open-at-point; was called.")
9446 ;;;###autoload
9447 (defun org-open-at-point-global ()
9448 "Follow a link like Org-mode does.
9449 This command can be called in any mode to follow a link that has
9450 Org-mode syntax."
9451 (interactive)
9452 (org-run-like-in-org-mode 'org-open-at-point))
9454 ;;;###autoload
9455 (defun org-open-link-from-string (s &optional arg reference-buffer)
9456 "Open a link in the string S, as if it was in Org-mode."
9458 (let ((reference-buffer (or reference-buffer (current-buffer))))
9459 (with-temp-buffer
9460 (let ((org-inhibit-startup (not reference-buffer)))
9461 (org-mode)
9462 (insert s)
9463 (goto-char (point-min))
9464 (when reference-buffer
9465 (setq org-link-abbrev-alist-local
9466 (with-current-buffer reference-buffer
9467 org-link-abbrev-alist-local)))
9468 (org-open-at-point arg reference-buffer)))))
9470 (defvar org-open-at-point-functions nil
9471 "Hook that is run when following a link at point.
9473 Functions in this hook must return t if they identify and follow
9474 a link at point. If they don't find anything interesting at point,
9475 they must return nil.")
9477 (defun org-open-at-point (&optional arg reference-buffer)
9478 "Open link at or after point.
9479 If there is no link at point, this function will search forward up to
9480 the end of the current line.
9481 Normally, files will be opened by an appropriate application. If the
9482 optional prefix argument ARG is non-nil, Emacs will visit the file.
9483 With a double prefix argument, try to open outside of Emacs, in the
9484 application the system uses for this file type."
9485 (interactive "P")
9486 ;; if in a code block, then open the block's results
9487 (unless (call-interactively #'org-babel-open-src-block-result)
9488 (org-load-modules-maybe)
9489 (move-marker org-open-link-marker (point))
9490 (setq org-window-config-before-follow-link (current-window-configuration))
9491 (org-remove-occur-highlights nil nil t)
9492 (cond
9493 ((and (org-at-heading-p)
9494 (not (org-in-regexp
9499 (not (get-text-property (point) 'org-linked-text)))
9500 (or (org-offer-links-in-entry arg)
9501 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9502 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9503 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9504 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9505 (not (org-in-regexp org-bracket-link-regexp)))
9506 (org-footnote-action))
9507 (t
9508 (let (type path link line search (pos (point)))
9509 (catch 'match
9510 (save-excursion
9512 (when (org-in-regexp org-bracket-link-regexp 1)
9513 (setq link (org-extract-attributes
9514 (org-link-unescape (org-match-string-no-properties 1))))
9516 (setq link (replace-match " " t t link)))
9517 (setq link (org-link-expand-abbrev link))
9518 (cond
9519 ((or (file-name-absolute-p link)
9521 (setq type "file" path link))
9522 ((string-match org-link-re-with-space3 link)
9523 (setq type (match-string 1 link) path (match-string 2 link)))
9524 (t (setq type "thisfile" path link)))
9525 (throw 'match t)))
9527 (when (get-text-property (point) 'org-linked-text)
9528 (setq type "thisfile"
9529 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9530 (1+ (point)) (point))
9531 path (buffer-substring
9532 (or (previous-single-property-change pos 'org-linked-text)
9533 (point-min))
9534 (or (next-single-property-change pos 'org-linked-text)
9535 (point-max))))
9536 (throw 'match t))
9538 (save-excursion
9539 (when (or (org-in-regexp org-angle-link-re)
9540 (org-in-regexp org-plain-link-re))
9541 (setq type (match-string 1)
9542 path (org-link-unescape (match-string 2)))
9543 (throw 'match t)))
9544 (save-excursion
9546 (setq type "tags"
9547 path (match-string 1))
9548 (while (string-match ":" path)
9549 (setq path (replace-match "+" t t path)))
9550 (throw 'match t)))
9552 (setq type "tree-match"
9553 path (match-string 1))
9554 (throw 'match t)))
9555 (unless path
9556 (error "No link found"))
9558 ;; switch back to reference buffer
9559 ;; needed when if called in a temporary buffer through
9560 ;; org-open-link-from-string
9561 (with-current-buffer (or reference-buffer (current-buffer))
9563 ;; Remove any trailing spaces in path
9565 (setq path (replace-match "" t t path)))
9566 (if (and org-link-translation-function
9567 (fboundp org-link-translation-function))
9568 ;; Check if we need to translate the link
9569 (let ((tmp (funcall org-link-translation-function type path)))
9570 (setq type (car tmp) path (cdr tmp))))
9572 (cond
9574 ((assoc type org-link-protocols)
9575 (funcall (nth 1 (assoc type org-link-protocols)) path))
9577 ((equal type "mailto")
9578 (let ((cmd (car org-link-mailto-program))
9579 (args (cdr org-link-mailto-program)) args1
9580 (address path) (subject "") a)
9582 (setq address (match-string 1 path)
9583 subject (org-link-escape (match-string 2 path))))
9584 (while args
9585 (cond
9586 ((not (stringp (car args))) (push (pop args) args1))
9587 (t (setq a (pop args))
9588 (if (string-match "%a" a)
9589 (setq a (replace-match address t t a)))
9590 (if (string-match "%s" a)
9591 (setq a (replace-match subject t t a)))
9592 (push a args1))))
9593 (apply cmd (nreverse args1))))
9595 ((member type '("http" "https" "ftp" "news"))
9596 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9597 (org-link-escape
9598 path org-link-escape-chars-browser)
9599 path))))
9601 ((string= type "doi")
9602 (browse-url (concat "http://dx.doi.org/" (if (org-string-match-p "[[:nonascii:] ]" path)
9603 (org-link-escape
9604 path org-link-escape-chars-browser)
9605 path))))
9607 ((member type '("message"))
9608 (browse-url (concat type ":" path)))
9610 ((string= type "tags")
9611 (org-tags-view arg path))
9613 ((string= type "tree-match")
9616 ((string= type "file")
9618 (setq line (string-to-number (match-string 1 path))
9619 path (substring path 0 (match-beginning 0)))
9621 (setq search (match-string 1 path)
9622 path (substring path 0 (match-beginning 0)))))
9623 (if (string-match "[*?{]" (file-name-nondirectory path))
9624 (dired path)
9625 (org-open-file path arg line search)))
9627 ((string= type "shell")
9628 (let ((cmd path))
9629 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9630 (string-match org-confirm-shell-link-not-regexp cmd))
9631 (not org-confirm-shell-link-function)
9632 (funcall org-confirm-shell-link-function
9634 (org-add-props cmd nil
9635 'face 'org-warning))))
9636 (progn
9637 (message "Executing %s" cmd)
9638 (shell-command cmd))
9639 (error "Abort"))))
9641 ((string= type "elisp")
9642 (let ((cmd path))
9643 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9644 (string-match org-confirm-elisp-link-not-regexp cmd))
9645 (not org-confirm-elisp-link-function)
9646 (funcall org-confirm-elisp-link-function
9648 (org-add-props cmd nil
9649 'face 'org-warning))))
9650 (message "%s => %s" cmd
9651 (if (equal (string-to-char cmd) ?\()
9652 (eval (read cmd))
9653 (call-interactively (read cmd))))
9654 (error "Abort"))))
9656 ((and (string= type "thisfile")
9657 (run-hook-with-args-until-success
9658 'org-open-link-functions path)))
9660 ((string= type "thisfile")
9661 (if arg
9662 (switch-to-buffer-other-window
9663 (org-get-buffer-for-internal-link (current-buffer)))
9664 (org-mark-ring-push))
9665 (let ((cmd `(org-link-search
9666 ,path
9667 ,(cond ((equal arg '(4)) ''occur)
9668 ((equal arg '(16)) ''org-occur)
9669 (t nil))
9670 ,pos)))
9671 (condition-case nil (let ((org-link-search-inhibit-query t))
9672 (eval cmd))
9673 (error (progn (widen) (eval cmd))))))
9675 (t
9676 (browse-url-at-point)))))))
9677 (move-marker org-open-link-marker nil)
9678 (run-hook-with-args 'org-follow-link-hook)))
9680 (defun org-offer-links-in-entry (&optional nth zero)
9681 "Offer links in the current entry and follow the selected link.
9682 If there is only one link, follow it immediately as well.
9683 If NTH is an integer, immediately pick the NTH link found.
9684 If ZERO is a string, check also this string for a link, and if
9685 there is one, offer it as link number zero."
9689 (cnt ?0)
9690 (in-emacs (if (integerp nth) nil nth))
9691 have-zero end links link c)
9692 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9693 (push (match-string 0 zero) links)
9694 (setq cnt (1- cnt) have-zero t))
9695 (save-excursion
9696 (org-back-to-heading t)
9697 (setq end (save-excursion (outline-next-heading) (point)))
9698 (while (re-search-forward re end t)
9699 (push (match-string 0) links))
9700 (setq links (org-uniquify (reverse links))))
9702 (cond
9703 ((null links)
9704 (message "No links"))
9705 ((equal (length links) 1)
9706 (setq link (list (car links))))
9707 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9708 (setq link (list (nth (if have-zero nth (1- nth)) links))))
9709 (t ; we have to select a link
9710 (save-excursion
9711 (save-window-excursion
9712 (delete-other-windows)
9713 (with-output-to-temp-buffer "*Select Link*"
9714 (mapc (lambda (l)
9715 (if (not (string-match org-bracket-link-regexp l))
9717 (org-remove-angle-brackets l)))
9718 (if (match-end 3)
9720 (match-string 3 l) (match-string 1 l)))
9722 (match-string 1 l))))))
9723 links))
9724 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9725 (message "Select link to open, RET to open all:")
9726 (setq c (read-char-exclusive))
9727 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9728 (when (equal c ?q) (error "Abort"))
9729 (if (equal c ?\C-m)
9730 (setq link links)
9731 (setq nth (- c ?0))
9732 (if have-zero (setq nth (1+ nth)))
9733 (unless (and (integerp nth) (>= (length links) nth))
9734 (error "Invalid link selection"))
9735 (setq link (list (nth (1- nth) links))))))
9736 (if link
9737 (let ((buf (current-buffer)))
9738 (dolist (l link)
9739 (org-open-link-from-string l in-emacs buf))
9740 t)
9741 nil)))
9743 ;; Add special file links that specify the way of opening
9745 (org-add-link-type "file+sys" 'org-open-file-with-system)
9746 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9747 (defun org-open-file-with-system (path)
9748 "Open file at PATH using the system way of opening it."
9749 (org-open-file path 'system))
9750 (defun org-open-file-with-emacs (path)
9751 "Open file at PATH in Emacs."
9752 (org-open-file path 'emacs))
9753 (defun org-remove-file-link-modifiers ()
9754 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9755 (goto-char (point-min))
9757 (org-if-unprotected
9758 (replace-match "file:" t t))))
9759 (eval-after-load "org-exp"
9760 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9761 'org-remove-file-link-modifiers))
9763 ;;;; Time estimates
9765 (defun org-get-effort (&optional pom)
9766 "Get the effort estimate for the current entry."
9767 (org-entry-get pom org-effort-property))
9769 ;;; File search
9771 (defvar org-create-file-search-functions nil
9772 "List of functions to construct the right search string for a file link.
9773 These functions are called in turn with point at the location to
9774 which the link should point.
9776 A function in the hook should first test if it would like to
9777 handle this file type, for example by checking the `major-mode'
9778 or the file extension. If it decides not to handle this file, it
9779 should just return nil to give other functions a chance. If it
9780 does handle the file, it must return the search string to be used
9781 when following the link. The search string will be part of the
9782 file link, given after a double colon, and `org-open-at-point'
9783 will automatically search for it. If special measures must be
9784 taken to make the search successful, another function should be
9785 added to the companion hook `org-execute-file-search-functions',
9786 which see.
9788 A function in this hook may also use `setq' to set the variable
9789 `description' to provide a suggestion for the descriptive text to
9790 be used for this link when it gets inserted into an Org-mode
9793 (defvar org-execute-file-search-functions nil
9794 "List of functions to execute a file search triggered by a link.
9796 Functions added to this hook must accept a single argument, the
9797 search string that was part of the file link, the part after the
9798 double colon. The function must first check if it would like to
9799 handle this search, for example by checking the `major-mode' or
9800 the file extension. If it decides not to handle this search, it
9801 should just return nil to give other functions a chance. If it
9802 does handle the search, it must return a non-nil value to keep
9803 other functions from trying.
9805 Each function can access the current prefix argument through the
9806 variable `current-prefix-argument'. Note that a single prefix is
9807 used to force opening a link in Emacs, so it may be good to only
9808 use a numeric or double prefix to guide the search function.
9810 In case this is needed, a function in this hook can also restore
9811 the window configuration before `org-open-at-point' was called using:
9813 (set-window-configuration org-window-config-before-follow-link)")
9815 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9816 (defun org-link-search (s &optional type avoid-pos stealth)
9817 "Search for a link search option.
9818 If S is surrounded by forward slashes, it is interpreted as a
9819 regular expression. In org-mode files, this will create an `org-occur'
9820 sparse tree. In ordinary files, `occur' will be used to list matches.
9821 If the current buffer is in `dired-mode', grep will be used to search
9822 in all files. If AVOID-POS is given, ignore matches near that position.
9824 When optional argument STEALTH is non-nil, do not modify
9825 visibility around point, thus ignoring
9826 `org-show-hierarchy-above', `org-show-following-heading' and
9827 `org-show-siblings' variables."
9828 (let ((case-fold-search t)
9832 org-emphasis-alist)
9834 (pos (point))
9835 (pre nil) (post nil)
9836 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9837 (cond
9838 ;; First check if there are any special search functions
9839 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9840 ;; Now try the builtin stuff
9841 ((and (equal (string-to-char s0) ?#)
9842 (> (length s0) 1)
9843 (save-excursion
9844 (goto-char (point-min))
9845 (and
9846 (re-search-forward
9848 (setq type 'dedicated
9849 pos (match-beginning 0))))
9850 ;; There is an exact target for this
9851 (goto-char pos)
9852 (org-back-to-heading t)))
9853 ((save-excursion
9854 (goto-char (point-min))
9855 (and
9856 (re-search-forward
9857 (concat "<<" (regexp-quote s0) ">>") nil t)
9858 (setq type 'dedicated
9859 pos (match-beginning 0))))
9860 ;; There is an exact target for this
9861 (goto-char pos))
9863 (save-excursion
9864 (goto-char (point-min))
9865 (and
9866 (re-search-forward
9867 (concat "[^[]" (regexp-quote
9868 (format org-coderef-label-format
9869 (match-string 1 s0))))
9870 nil t)
9871 (setq type 'dedicated
9872 pos (1+ (match-beginning 0))))))
9873 ;; There is a coderef target for this
9874 (goto-char pos))
9876 ;; A regular expression
9877 (cond
9878 ((eq major-mode 'org-mode)
9879 (org-occur (match-string 1 s)))
9880 ;;((eq major-mode 'dired-mode)
9881 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9882 (t (org-do-occur (match-string 1 s)))))
9883 ((and (eq major-mode 'org-mode) org-link-search-must-match-exact-headline)
9884 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9885 (goto-char (point-min))
9886 (cond
9887 ((let (case-fold-search)
9888 (re-search-forward (format org-complex-heading-regexp-format
9889 (regexp-quote s))
9890 nil t))
9891 ;; OK, found a match
9892 (setq type 'dedicated)
9893 (goto-char (match-beginning 0)))
9894 ((and (not org-link-search-inhibit-query)
9895 (eq org-link-search-must-match-exact-headline 'query-to-create)
9896 (y-or-n-p "No match - create this as a new heading? "))
9897 (goto-char (point-max))
9898 (or (bolp) (newline))
9900 (beginning-of-line 0))
9901 (t
9902 (goto-char pos)
9903 (error "No match"))))
9904 (t
9905 ;; A normal search string
9906 (when (equal (string-to-char s) ?*)
9907 ;; Anchor on headlines, post may include tags.
9910 s (substring s 1)))
9911 (remove-text-properties
9912 0 (length s)
9913 '(face nil mouse-face nil keymap nil fontified nil) s)
9914 ;; Make a series of regular expressions to find a match
9923 re4 (concat "[^a-zA-Z_]" re4_)
9925 re1 (concat pre re2 post)
9926 re3 (concat pre (if pre re4_ re4) post)
9927 re5 (concat pre ".*" re4)
9928 re2 (concat pre re2)
9929 re2a (concat pre (if pre re2a_ re2a))
9930 re4 (concat pre (if pre re4_ re4))
9934 ))
9935 (cond
9936 ((eq type 'org-occur) (org-occur reall))
9937 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9938 (t (goto-char (point-min))
9939 (setq type 'fuzzy)
9940 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9941 (org-search-not-self 1 re1 nil t)
9942 (org-search-not-self 1 re2 nil t)
9943 (org-search-not-self 1 re2a nil t)
9944 (org-search-not-self 1 re3 nil t)
9945 (org-search-not-self 1 re4 nil t)
9946 (org-search-not-self 1 re5 nil t)
9947 )
9948 (goto-char (match-beginning 1))
9949 (goto-char pos)
9950 (error "No match"))))))
9951 (and (eq major-mode 'org-mode)
9952 (not stealth)
9953 (org-show-context 'link-search))
9954 type))
9956 (defun org-search-not-self (group &rest args)
9957 "Execute `re-search-forward', but only accept matches that do not
9958 enclose the position of `org-open-link-marker'."
9959 (let ((m org-open-link-marker))
9960 (catch 'exit
9961 (while (apply 're-search-forward args)
9962 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9963 (goto-char (match-end group))
9964 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9965 (> (match-beginning 0) (marker-position m))
9966 (< (match-end 0) (marker-position m)))
9967 (save-match-data
9968 (or (not (org-in-regexp
9969 org-bracket-link-analytic-regexp 1))
9970 (not (match-end 4)) ; no description
9971 (and (<= (match-beginning 4) (point))
9972 (>= (match-end 4) (point))))))
9973 (throw 'exit (point))))))))
9975 (defun org-get-buffer-for-internal-link (buffer)
9976 "Return a buffer to be used for displaying the link target of internal links."
9977 (cond
9978 ((not org-display-internal-link-with-indirect-buffer)
9979 buffer)
9980 ((string-match "(Clone)$" (buffer-name buffer))
9981 (message "Buffer is already a clone, not making another one")
9982 ;; we also do not modify visibility in this case
9983 buffer)
9984 (t ; make a new indirect buffer for displaying the link
9985 (let* ((bn (buffer-name buffer))
9986 (ibn (concat bn "(Clone)"))
9987 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9988 (with-current-buffer ib (org-overview))
9989 ib))))
9991 (defun org-do-occur (regexp &optional cleanup)
9992 "Call the Emacs command `occur'.
9993 If CLEANUP is non-nil, remove the printout of the regular expression
9994 in the *Occur* buffer. This is useful if the regex is long and not useful
9995 to read."
9996 (occur regexp)
9997 (when cleanup
9998 (let ((cwin (selected-window)) win beg end)
9999 (when (setq win (get-buffer-window "*Occur*"))
10000 (select-window win))
10001 (goto-char (point-min))
10002 (when (re-search-forward "match[a-z]+" nil t)
10003 (setq beg (match-end 0))
10005 (setq end (1- (match-beginning 0)))))
10006 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10007 (goto-char (point-min))
10008 (select-window cwin))))
10010 ;;; The mark ring for links jumps
10012 (defvar org-mark-ring nil
10013 "Mark ring for positions before jumps in Org-mode.")
10014 (defvar org-mark-ring-last-goto nil
10015 "Last position in the mark ring used to go back.")
10016 ;; Fill and close the ring
10017 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10018 (loop for i from 1 to org-mark-ring-length do
10019 (push (make-marker) org-mark-ring))
10020 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10021 org-mark-ring)
10023 (defun org-mark-ring-push (&optional pos buffer)
10024 "Put the current position or POS into the mark ring and rotate it."
10025 (interactive)
10026 (setq pos (or pos (point)))
10027 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10028 (move-marker (car org-mark-ring)
10029 (or pos (point))
10030 (or buffer (current-buffer)))
10031 (message "%s"
10032 (substitute-command-keys
10035 (defun org-mark-ring-goto (&optional n)
10036 "Jump to the previous position in the mark ring.
10037 With prefix arg N, jump back that many stored positions. When
10038 called several times in succession, walk through the entire ring.
10039 Org-mode commands jumping to a different position in the current file,
10040 or to another Org-mode file, automatically push the old position
10041 onto the ring."
10042 (interactive "p")
10043 (let (p m)
10044 (if (eq last-command this-command)
10045 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10046 (setq p org-mark-ring))
10047 (setq org-mark-ring-last-goto p)
10048 (setq m (car p))
10049 (org-pop-to-buffer-same-window (marker-buffer m))
10050 (goto-char m)
10051 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10053 (defun org-remove-angle-brackets (s)
10054 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10055 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10056 s)
10057 (defun org-add-angle-brackets (s)
10058 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10059 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10060 s)
10061 (defun org-remove-double-quotes (s)
10064 s)
10066 ;;; Following specific links
10068 (defun org-follow-timestamp-link ()
10069 (cond
10070 ((org-at-date-range-p t)
10071 (let ((org-agenda-start-on-weekday)
10072 (t1 (match-string 1))
10073 (t2 (match-string 2)))
10074 (setq t1 (time-to-days (org-time-string-to-time t1))
10075 t2 (time-to-days (org-time-string-to-time t2)))
10076 (org-agenda-list nil t1 (1+ (- t2 t1)))))
10077 ((org-at-timestamp-p t)
10078 (org-agenda-list nil (time-to-days (org-time-string-to-time
10079 (substring (match-string 1) 0 10)))
10080 1))
10081 (t (error "This should not happen"))))
10084 ;;; Following file links
10085 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10086 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10087 (declare-function mailcap-mime-info
10088 "mailcap" (string &optional request no-decode))
10089 (defvar org-wait nil)
10090 (defun org-open-file (path &optional in-emacs line search)
10091 "Open the file at PATH.
10092 First, this expands any special file name abbreviations. Then the
10093 configuration variable `org-file-apps' is checked if it contains an
10094 entry for this file type, and if yes, the corresponding command is launched.
10096 If no application is found, Emacs simply visits the file.
10098 With optional prefix argument IN-EMACS, Emacs will visit the file.
10100 prefix arg, Org tries to avoid opening in Emacs
10101 and to use an external application to visit the file.
10103 Optional LINE specifies a line to go to, optional SEARCH a string
10104 to search for. If LINE or SEARCH is given, the file will be
10105 opened in Emacs, unless an entry from org-file-apps that makes
10106 use of groups in a regexp matches.
10108 If you want to change the way frames are used when following a
10109 link, please customize `org-link-frame-setup'.
10111 If the file does not exist, an error is thrown."
10112 (let* ((file (if (equal path "")
10113 buffer-file-name
10114 (substitute-in-file-name (expand-file-name path))))
10115 (file-apps (append org-file-apps (org-default-apps)))
10116 (apps (org-remove-if
10117 'org-file-apps-entry-match-against-dlink-p file-apps))
10118 (apps-dlink (org-remove-if-not
10119 'org-file-apps-entry-match-against-dlink-p file-apps))
10120 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10121 (dirp (if remp nil (file-directory-p file)))
10122 (file (if (and dirp org-open-directory-means-index-dot-org)
10123 (concat (file-name-as-directory file) "index.org")
10124 file))
10125 (a-m-a-p (assq 'auto-mode apps))
10126 (dfile (downcase file))
10127 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10128 (link (cond ((and (eq line nil)
10129 (eq search nil))
10130 file)
10131 (line
10132 (concat file "::" (number-to-string line)))
10133 (search
10134 (concat file "::" search))))
10135 (dlink (downcase link))
10136 (old-buffer (current-buffer))
10137 (old-pos (point))
10138 (old-mode major-mode)
10139 ext cmd link-match-data)
10141 (setq ext (match-string 1 dfile))
10143 (setq ext (match-string 1 dfile))))
10144 (cond
10145 ((member in-emacs '((16) system))
10146 (setq cmd (cdr (assoc 'system apps))))
10147 (in-emacs (setq cmd 'emacs))
10148 (t
10149 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10150 (and dirp (cdr (assoc 'directory apps)))
10151 ; first, try matching against apps-dlink
10152 ; if we get a match here, store the match data for later
10153 (let ((match (assoc-default dlink apps-dlink
10154 'string-match)))
10155 (if match
10156 (progn (setq link-match-data (match-data))
10157 match)
10158 (progn (setq in-emacs (or in-emacs line search))
10159 nil))) ; if we have no match in apps-dlink,
10160 ; always open the file in emacs if line or search
10161 ; is given (for backwards compatibility)
10162 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10163 'string-match)
10164 (cdr (assoc ext apps))
10165 (cdr (assoc t apps))))))
10166 (when (eq cmd 'system)
10167 (setq cmd (cdr (assoc 'system apps))))
10168 (when (eq cmd 'default)
10169 (setq cmd (cdr (assoc t apps))))
10170 (when (eq cmd 'mailcap)
10171 (require 'mailcap)
10172 (mailcap-parse-mailcaps)
10173 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10174 (command (mailcap-mime-info mime-type)))
10175 (if (stringp command)
10176 (setq cmd command)
10177 (setq cmd 'emacs))))
10178 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10179 (not (file-exists-p file))
10180 (not org-open-non-existing-files))
10181 (error "No such file: %s" file))
10182 (cond
10184 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10186 (setq cmd (replace-match "%s" t t cmd)))
10187 (while (string-match "%s" cmd)
10188 (setq cmd (replace-match
10189 (save-match-data
10190 (shell-quote-argument
10191 (convert-standard-filename file)))
10192 t t cmd)))
10194 ;; Replace "%1", "%2" etc. in command with group matches from regex
10195 (save-match-data
10196 (let ((match-index 1)
10197 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10198 (set-match-data link-match-data)
10199 (while (<= match-index number-of-groups)
10200 (let ((regex (concat "%" (number-to-string match-index)))
10201 (replace-with (match-string match-index dlink)))
10202 (while (string-match regex cmd)
10203 (setq cmd (replace-match replace-with t t cmd))))
10204 (setq match-index (+ match-index 1)))))
10206 (save-window-excursion
10207 (start-process-shell-command cmd nil cmd)
10208 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10209 ))
10210 ((or (stringp cmd)
10211 (eq cmd 'emacs))
10212 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10213 (widen)
10214 (if line (org-goto-line line)
10215 (if search (org-link-search search))))
10216 ((consp cmd)
10217 (let ((file (convert-standard-filename file)))
10218 (save-match-data
10219 (set-match-data link-match-data)
10220 (eval cmd))))
10221 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10222 (and (eq major-mode 'org-mode) (eq old-mode 'org-mode)
10223 (or (not (equal old-buffer (current-buffer)))
10224 (not (equal old-pos (point))))
10225 (org-mark-ring-push old-pos old-buffer))))
10227 (defun org-file-apps-entry-match-against-dlink-p (entry)
10228 "This function returns non-nil if `entry' uses a regular
10229 expression which should be matched against the whole link by
10230 org-open-file.
10232 It assumes that is the case when the entry uses a regular
10233 expression which has at least one grouping construct and the
10234 action is either a lisp form or a command string containing
10235 '%1', i.e. using at least one subexpression match as a
10236 parameter."
10237 (let ((selector (car entry))
10238 (action (cdr entry)))
10239 (if (stringp selector)
10240 (and (> (regexp-opt-depth selector) 0)
10241 (or (and (stringp action)
10242 (string-match "%[0-9]" action))
10243 (consp action)))
10244 nil)))
10246 (defun org-default-apps ()
10247 "Return the default applications for this operating system."
10248 (cond
10249 ((eq system-type 'darwin)
10250 org-file-apps-defaults-macosx)
10251 ((eq system-type 'windows-nt)
10252 org-file-apps-defaults-windowsnt)
10253 (t org-file-apps-defaults-gnu)))
10255 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10256 "Convert extensions to regular expressions in the cars of LIST.
10257 Also, weed out any non-string entries, because the return value is used
10258 only for regexp matching.
10259 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10260 point to the symbol `emacs', indicating that the file should
10261 be opened in Emacs."
10262 (append
10263 (delq nil
10264 (mapcar (lambda (x)
10265 (if (not (stringp (car x)))
10266 nil
10268 x
10270 list))
10271 (if add-auto-mode
10272 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10274 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10275 (defun org-file-remote-p (file)
10276 "Test whether FILE specifies a location on a remote system.
10277 Return non-nil if the location is indeed remote.
10281 (cond ((fboundp 'file-remote-p)
10282 (file-remote-p file))
10283 ((fboundp 'tramp-handle-file-remote-p)
10284 (tramp-handle-file-remote-p file))
10285 ((and (boundp 'ange-ftp-name-format)
10286 (string-match (car ange-ftp-name-format) file))
10287 t)
10288 (t nil)))
10291 ;;;; Refiling
10293 (defun org-get-org-file ()
10294 "Read a filename, with default directory `org-directory'."
10295 (let ((default (or org-default-notes-file remember-data-file)))
10296 (read-file-name (format "File name [%s]: " default)
10297 (file-name-as-directory org-directory)
10298 default)))
10300 (defun org-notes-order-reversed-p ()
10301 "Check if the current file should receive notes in reversed order."
10302 (cond
10303 ((not org-reverse-note-order) nil)
10304 ((eq t org-reverse-note-order) t)
10305 ((not (listp org-reverse-note-order)) nil)
10306 (t (catch 'exit
10307 (let ((all org-reverse-note-order)
10308 entry)
10309 (while (setq entry (pop all))
10310 (if (string-match (car entry) buffer-file-name)
10311 (throw 'exit (cdr entry))))
10312 nil)))))
10314 (defvar org-refile-target-table nil
10315 "The list of refile targets, created by `org-refile'.")
10317 (defvar org-agenda-new-buffers nil
10318 "Buffers created to visit agenda files.")
10320 (defvar org-refile-cache nil
10321 "Cache for refile targets.")
10323 (defvar org-refile-markers nil
10324 "All the markers used for caching refile locations.")
10326 (defun org-refile-marker (pos)
10327 "Get a new refile marker, but only if caching is in use."
10328 (if (not org-refile-use-cache)
10329 pos
10330 (let ((m (make-marker)))
10331 (move-marker m pos)
10332 (push m org-refile-markers)
10333 m)))
10335 (defun org-refile-cache-clear ()
10336 "Clear the refile cache and disable all the markers."
10337 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10338 (setq org-refile-markers nil)
10339 (setq org-refile-cache nil)
10340 (message "Refile cache has been cleared"))
10342 (defun org-refile-cache-check-set (set)
10343 "Check if all the markers in the cache still have live buffers."
10344 (let (marker)
10345 (catch 'exit
10346 (while (and set (setq marker (nth 3 (pop set))))
10347 ;; if org-refile-use-outline-path is 'file, marker may be nil
10348 (when (and marker (null (marker-buffer marker)))
10349 (message "not found") (sit-for 3)
10350 (throw 'exit nil)))
10351 t)))
10353 (defun org-refile-cache-put (set &rest identifiers)
10354 "Push the refile targets SET into the cache, under IDENTIFIERS."
10355 (let* ((key (sha1 (prin1-to-string identifiers)))
10356 (entry (assoc key org-refile-cache)))
10357 (if entry
10358 (setcdr entry set)
10359 (push (cons key set) org-refile-cache))))
10361 (defun org-refile-cache-get (&rest identifiers)
10362 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10363 (cond
10364 ((not org-refile-cache) nil)
10365 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10366 (t
10367 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10368 org-refile-cache))))
10369 (and set (org-refile-cache-check-set set) set)))))
10371 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10372 "Produce a table with refile targets."
10373 (let ((case-fold-search nil)
10374 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10375 (entries (or org-refile-targets '((nil . (:level . 1)))))
10376 targets tgs txt re files f desc descre fast-path-p level pos0)
10377 (message "Getting targets...")
10378 (with-current-buffer (or default-buffer (current-buffer))
10379 (while (setq entry (pop entries))
10380 (setq files (car entry) desc (cdr entry))
10381 (setq fast-path-p nil)
10382 (cond
10383 ((null files) (setq files (list (current-buffer))))
10384 ((eq files 'org-agenda-files)
10385 (setq files (org-agenda-files 'unrestricted)))
10386 ((and (symbolp files) (fboundp files))
10387 (setq files (funcall files)))
10388 ((and (symbolp files) (boundp files))
10389 (setq files (symbol-value files))))
10390 (if (stringp files) (setq files (list files)))
10391 (cond
10392 ((eq (car desc) :tag)
10394 ((eq (car desc) :todo)
10396 ((eq (car desc) :regexp)
10397 (setq descre (cdr desc)))
10398 ((eq (car desc) :level)
10400 (if org-odd-levels-only
10401 (1- (* 2 (cdr desc)))
10402 (cdr desc)))
10404 ((eq (car desc) :maxlevel)
10405 (setq fast-path-p t)
10407 (if org-odd-levels-only
10408 (1- (* 2 (cdr desc)))
10409 (cdr desc)))
10411 (t (error "Bad refiling target description %s" desc)))
10412 (while (setq f (pop files))
10413 (with-current-buffer
10414 (if (bufferp f) f (org-get-agenda-file-buffer f))
10415 (or
10416 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10417 (progn
10418 (if (bufferp f) (setq f (buffer-file-name
10419 (buffer-base-buffer f))))
10420 (setq f (and f (expand-file-name f)))
10421 (if (eq org-refile-use-outline-path 'file)
10422 (push (list (file-name-nondirectory f) f nil nil) tgs))
10423 (save-excursion
10424 (save-restriction
10425 (widen)
10426 (goto-char (point-min))
10427 (while (re-search-forward descre nil t)
10428 (goto-char (setq pos0 (point-at-bol)))
10429 (catch 'next
10430 (when org-refile-target-verify-function
10431 (save-match-data
10432 (or (funcall org-refile-target-verify-function)
10433 (throw 'next t))))
10434 (when (and (looking-at org-complex-heading-regexp)
10435 (not (member (match-string 4) excluded-entries))
10436 (match-string 4))
10437 (setq level (org-reduced-level
10438 (- (match-end 1) (match-beginning 1)))
10439 txt (org-link-display-format (match-string 4))
10441 re (format org-complex-heading-regexp-format
10442 (regexp-quote (match-string 4))))
10443 (when org-refile-use-outline-path
10444 (setq txt (mapconcat
10445 'org-protect-slash
10446 (append
10447 (if (eq org-refile-use-outline-path
10448 'file)
10449 (list (file-name-nondirectory
10450 (buffer-file-name
10451 (buffer-base-buffer))))
10452 (if (eq org-refile-use-outline-path
10453 'full-file-path)
10454 (list (buffer-file-name
10455 (buffer-base-buffer)))))
10456 (org-get-outline-path fast-path-p
10457 level txt)
10458 (list txt))
10459 "/")))
10460 (push (list txt f re (org-refile-marker (point)))
10461 tgs)))
10462 (when (= (point) pos0)
10463 ;; verification function has not moved point
10464 (goto-char (point-at-eol))))))))
10465 (when org-refile-use-cache
10466 (org-refile-cache-put tgs (buffer-file-name) descre))
10467 (setq targets (append tgs targets))
10468 ))))
10469 (message "Getting targets...done")
10470 (nreverse targets)))
10472 (defun org-protect-slash (s)
10473 (while (string-match "/" s)
10475 s)
10477 (defvar org-olpa (make-vector 20 nil))
10479 (defun org-get-outline-path (&optional fastp level heading)
10480 "Return the outline path to the current entry, as a list.
10482 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10483 routine which makes outline path derivations for an entire file,
10484 avoiding backtracing. Refile target collection makes use of that."
10485 (if fastp
10486 (progn
10487 (if (> level 19)
10488 (error "Outline path failure, more than 19 levels"))
10489 (loop for i from level upto 19 do
10490 (aset org-olpa i nil))
10491 (prog1
10492 (delq nil (append org-olpa nil))
10493 (aset org-olpa level heading)))
10494 (let (rtn case-fold-search)
10495 (save-excursion
10496 (save-restriction
10497 (widen)
10498 (while (org-up-heading-safe)
10499 (when (looking-at org-complex-heading-regexp)
10500 (push (org-match-string-no-properties 4) rtn)))
10501 rtn)))))
10503 (defun org-format-outline-path (path &optional width prefix)
10504 "Format the outline path PATH for display.
10505 Width is the maximum number of characters that is available.
10506 Prefix is a prefix to be included in the returned string,
10507 such as the file name."
10508 (setq width (or width 79))
10509 (if prefix (setq width (- width (length prefix))))
10510 (if (not path)
10511 (or prefix "")
10512 (let* ((nsteps (length path))
10513 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10514 (maxwidth (if (<= total-width width)
10515 10000 ;; everything fits
10516 ;; we need to shorten the level headings
10517 (/ (- width nsteps) nsteps)))
10518 (org-odd-levels-only nil)
10519 (n 0)
10520 (total (1+ (length prefix))))
10521 (setq maxwidth (max maxwidth 10))
10522 (concat prefix
10523 (mapconcat
10524 (lambda (h)
10525 (setq n (1+ n))
10526 (if (and (= n nsteps) (< maxwidth 10000))
10527 (setq maxwidth (- total-width total)))
10528 (if (< (length h) maxwidth)
10529 (progn (setq total (+ total (length h) 1)) h)
10530 (setq h (substring h 0 (- maxwidth 2))
10531 total (+ total maxwidth 1))
10533 (setq h (substring h 0 (match-beginning 0))))
10534 (setq h (concat h "..")))
10535 (org-add-props h nil 'face
10536 (nth (% (1- n) org-n-level-faces)
10537 org-level-faces))
10538 h)
10539 path "/")))))
10541 (defun org-display-outline-path (&optional file current)
10542 "Display the current outline path in the echo area."
10543 (interactive "P")
10544 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10545 (case-fold-search nil)
10546 (path (and (eq major-mode 'org-mode) (org-get-outline-path))))
10547 (if current (setq path (append path
10548 (save-excursion
10549 (org-back-to-heading t)
10550 (if (looking-at org-complex-heading-regexp)
10551 (list (match-string 4)))))))
10552 (message "%s"
10553 (org-format-outline-path
10554 path
10555 (1- (frame-width))
10556 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10558 (defvar org-refile-history nil
10559 "History for refiling operations.")
10561 (defvar org-after-refile-insert-hook nil
10562 "Hook run after `org-refile' has inserted its stuff at the new location.
10563 Note that this is still *before* the stuff will be removed from
10564 the *old* location.")
10566 (defvar org-capture-last-stored-marker)
10567 (defun org-refile (&optional goto default-buffer rfloc)
10568 "Move the entry or entries at point to another heading.
10569 The list of target headings is compiled using the information in
10570 `org-refile-targets', which see.
10572 At the target location, the entry is filed as a subitem of the target
10573 heading. Depending on `org-reverse-note-order', the new subitem will
10574 either be the first or the last subitem.
10576 If there is an active region, all entries in that region will be moved.
10577 However, the region must fulfill the requirement that the first heading
10578 is the first one sets the top-level of the moved text - at most siblings
10579 below it are allowed.
10581 With prefix arg GOTO, the command will only visit the target location
10582 and not actually move anything.
10585 go to the location where the last refiling operation has put the subtree.
10586 With a prefix argument of `2', refile to the running clock.
10588 RFLOC can be a refile location obtained in a different way.
10590 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10592 If you are using target caching (see `org-refile-use-cache'),
10593 You have to clear the target cache in order to find new targets.
10594 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10595 prefix argument (`C-u C-u C-u C-c C-w')."
10597 (interactive "P")
10598 (if (member goto '(0 (64)))
10599 (org-refile-cache-clear)
10600 (let* ((cbuf (current-buffer))
10601 (regionp (org-region-active-p))
10602 (region-start (and regionp (region-beginning)))
10603 (region-end (and regionp (region-end)))
10604 (region-length (and regionp (- region-end region-start)))
10605 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10606 pos it nbuf file re level reversed)
10607 (setq last-command nil)
10608 (when regionp
10609 (goto-char region-start)
10610 (or (bolp) (goto-char (point-at-bol)))
10611 (setq region-start (point))
10612 (unless (or (org-kill-is-subtree-p
10613 (buffer-substring region-start region-end))
10614 (prog1 org-refile-active-region-within-subtree
10615 (org-toggle-heading)))
10616 (error "The region is not a (sequence of) subtree(s)")))
10617 (if (equal goto '(16))
10618 (org-refile-goto-last-stored)
10619 (when (or
10620 (and (equal goto 2)
10621 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10622 (prog1
10623 (setq it (list (or org-clock-heading "running clock")
10624 (buffer-file-name
10625 (marker-buffer org-clock-hd-marker))
10626 ""
10627 (marker-position org-clock-hd-marker)))
10628 (setq goto nil)))
10629 (setq it (or rfloc
10630 (let (heading-text)
10631 (save-excursion
10632 (unless goto
10633 (org-back-to-heading t)
10634 (setq heading-text
10635 (nth 4 (org-heading-components))))
10636 (org-refile-get-location
10637 (cond (goto "Goto")
10638 (regionp "Refile region to")
10641 default-buffer
10642 org-refile-allow-creating-parent-nodes
10643 goto))))))
10644 (setq file (nth 1 it)
10645 re (nth 2 it)
10646 pos (nth 3 it))
10647 (if (and (not goto)
10648 pos
10649 (equal (buffer-file-name) file)
10650 (if regionp
10651 (and (>= pos region-start)
10652 (<= pos region-end))
10653 (and (>= pos (point))
10654 (< pos (save-excursion
10655 (org-end-of-subtree t t))))))
10656 (error "Cannot refile to position inside the tree or region"))
10658 (setq nbuf (or (find-buffer-visiting file)
10659 (find-file-noselect file)))
10660 (if goto
10661 (progn
10662 (org-pop-to-buffer-same-window nbuf)
10663 (goto-char pos)
10664 (org-show-context 'org-goto))
10665 (if regionp
10666 (progn
10667 (org-kill-new (buffer-substring region-start region-end))
10668 (org-save-markers-in-region region-start region-end))
10669 (org-copy-subtree 1 nil t))
10670 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10671 (find-file-noselect file)))
10672 (setq reversed (org-notes-order-reversed-p))
10673 (save-excursion
10674 (save-restriction
10675 (widen)
10676 (if pos
10677 (progn
10678 (goto-char pos)
10679 (looking-at org-outline-regexp)
10680 (setq level (org-get-valid-level (funcall outline-level) 1))
10681 (goto-char
10682 (if reversed
10683 (or (outline-next-heading) (point-max))
10684 (or (save-excursion (org-get-next-sibling))
10685 (org-end-of-subtree t t)
10686 (point-max)))))
10687 (setq level 1)
10688 (if (not reversed)
10689 (goto-char (point-max))
10690 (goto-char (point-min))
10691 (or (outline-next-heading) (goto-char (point-max)))))
10692 (if (not (bolp)) (newline))
10693 (org-paste-subtree level)
10694 (when org-log-refile
10695 (org-add-log-setup 'refile nil nil 'findpos
10696 org-log-refile)
10697 (unless (eq org-log-refile 'note)
10698 (save-excursion (org-add-log-note))))
10699 (and org-auto-align-tags (org-set-tags nil t))
10700 (bookmark-set "org-refile-last-stored")
10701 ;; If we are refiling for capture, make sure that the
10702 ;; last-capture pointers point here
10703 (when (org-bound-and-true-p org-refile-for-capture)
10704 (bookmark-set "org-capture-last-stored-marker")
10705 (move-marker org-capture-last-stored-marker (point)))
10706 (if (fboundp 'deactivate-mark) (deactivate-mark))
10707 (run-hooks 'org-after-refile-insert-hook))))
10708 (if regionp
10709 (delete-region (point) (+ (point) region-length))
10710 (org-cut-subtree))
10711 (when (featurep 'org-inlinetask)
10712 (org-inlinetask-remove-END-maybe))
10713 (setq org-markers-to-move nil)
10716 (defun org-refile-goto-last-stored ()
10717 "Go to the location where the last refile was stored."
10718 (interactive)
10719 (bookmark-jump "org-refile-last-stored")
10720 (message "This is the location of the last refile"))
10722 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
10723 no-exclude)
10724 "Prompt the user for a refile location, using PROMPT.
10725 PROMPT should not be suffixed with a colon and a space, because
10726 this function appends the default value from
10727 `org-refile-history' automatically, if that is not empty.
10728 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10729 this is used for the GOTO interface."
10730 (let ((org-refile-targets org-refile-targets)
10731 (org-refile-use-outline-path org-refile-use-outline-path)
10732 excluded-entries)
10733 (when (and (eq major-mode 'org-mode)
10734 (not org-refile-use-cache)
10735 (not no-exclude))
10736 (org-map-tree
10737 (lambda()
10738 (setq excluded-entries
10739 (append excluded-entries (list (org-get-heading t t)))))))
10740 (setq org-refile-target-table
10741 (org-refile-get-targets default-buffer excluded-entries)))
10742 (unless org-refile-target-table
10743 (error "No refile targets"))
10744 (let* ((prompt (concat prompt
10745 (and (car org-refile-history)
10746 (concat " (default " (car org-refile-history) ")"))
10747 ": "))
10748 (cbuf (current-buffer))
10749 (partial-completion-mode nil)
10750 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10751 (cfunc (if (and org-refile-use-outline-path
10752 org-outline-path-complete-in-steps)
10753 'org-olpath-completing-read
10754 'org-icompleting-read))
10755 (extra (if org-refile-use-outline-path "/" ""))
10756 (filename (and cfn (expand-file-name cfn)))
10757 (tbl (mapcar
10758 (lambda (x)
10759 (if (and (not (member org-refile-use-outline-path
10760 '(file full-file-path)))
10761 (not (equal filename (nth 1 x))))
10762 (cons (concat (car x) extra " ("
10763 (file-name-nondirectory (nth 1 x)) ")")
10764 (cdr x))
10765 (cons (concat (car x) extra) (cdr x))))
10766 org-refile-target-table))
10767 (completion-ignore-case t)
10768 pa answ parent-target child parent old-hist)
10769 (setq old-hist org-refile-history)
10770 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10771 nil 'org-refile-history (car org-refile-history)))
10772 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10773 (org-refile-check-position pa)
10774 (if pa
10775 (progn
10776 (when (or (not org-refile-history)
10777 (not (eq old-hist org-refile-history))
10778 (not (equal (car pa) (car org-refile-history))))
10779 (setq org-refile-history
10780 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10781 org-refile-history
10782 (cdr org-refile-history))))
10783 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10784 (pop org-refile-history)))
10785 pa)
10787 (progn
10788 (setq parent (match-string 1 answ)
10789 child (match-string 2 answ))
10790 (setq parent-target (or (assoc parent tbl)
10791 (assoc (concat parent "/") tbl)))
10792 (when (and parent-target
10793 (or (eq new-nodes t)
10794 (and (eq new-nodes 'confirm)
10796 child)))))
10797 (org-refile-new-child parent-target child)))
10798 (error "Invalid target location")))))
10800 (defun org-refile-check-position (refile-pointer)
10801 "Check if the refile pointer matches the readline to which it points."
10802 (let* ((file (nth 1 refile-pointer))
10803 (re (nth 2 refile-pointer))
10804 (pos (nth 3 refile-pointer))
10805 buffer)
10806 (when (org-string-nw-p re)
10807 (setq buffer (if (markerp pos)
10808 (marker-buffer pos)
10809 (or (find-buffer-visiting file)
10810 (find-file-noselect file))))
10811 (with-current-buffer buffer
10812 (save-excursion
10813 (save-restriction
10814 (widen)
10815 (goto-char pos)
10816 (beginning-of-line 1)
10817 (unless (org-looking-at-p re)
10818 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10820 (defun org-refile-new-child (parent-target child)
10821 "Use refile target PARENT-TARGET to add new CHILD below it."
10822 (unless parent-target
10823 (error "Cannot find parent for new node"))
10824 (let ((file (nth 1 parent-target))
10825 (pos (nth 3 parent-target))
10826 level)
10827 (with-current-buffer (or (find-buffer-visiting file)
10828 (find-file-noselect file))
10829 (save-excursion
10830 (save-restriction
10831 (widen)
10832 (if pos
10833 (goto-char pos)
10834 (goto-char (point-max))
10835 (if (not (bolp)) (newline)))
10836 (when (looking-at org-outline-regexp)
10837 (setq level (funcall outline-level))
10838 (org-end-of-subtree t t))
10839 (org-back-over-empty-lines)
10841 (if pos (org-get-valid-level level 1) 1) ?*)
10843 (beginning-of-line 0)
10844 (list (concat (car parent-target) "/" child) file "" (point)))))))
10846 (defun org-olpath-completing-read (prompt collection &rest args)
10847 "Read an outline path like a file name."
10848 (let ((thetable collection)
10849 (org-completion-use-ido nil) ; does not work with ido.
10850 (org-completion-use-iswitchb nil)) ; or iswitchb
10851 (apply
10852 'org-icompleting-read prompt
10853 (lambda (string predicate &optional flag)
10854 (let (rtn r f (l (length string)))
10855 (cond
10856 ((eq flag nil)
10857 ;; try completion
10858 (try-completion string thetable))
10859 ((eq flag t)
10860 ;; all-completions
10861 (setq rtn (all-completions string thetable predicate))
10862 (mapcar
10863 (lambda (x)
10864 (setq r (substring x l))
10865 (if (string-match " ([^)]*)$" x)
10866 (setq f (match-string 0 x))
10867 (setq f ""))
10868 (if (string-match "/" r)
10869 (concat string (substring r 0 (match-end 0)) f)
10870 x))
10871 rtn))
10872 ((eq flag 'lambda)
10873 ;; exact match?
10874 (assoc string thetable)))
10875 ))
10876 args)))
10878 ;;;; Dynamic blocks
10880 (defun org-find-dblock (name)
10881 "Find the first dynamic block with name NAME in the buffer.
10882 If not found, stay at current position and return nil."
10883 (let (pos)
10884 (save-excursion
10885 (goto-char (point-min))
10887 nil t)
10888 (match-beginning 0))))
10889 (if pos (goto-char pos))
10890 pos))
10892 (defconst org-dblock-start-re
10894 "Matches the start line of a dynamic block, with parameters.")
10897 "Matches the end of a dynamic block.")
10899 (defun org-create-dblock (plist)
10900 "Create a dynamic block section, with parameters taken from PLIST.
10901 PLIST must contain a :name entry which is used as name of the block."
10903 (end-of-line 1)
10904 (newline))
10905 (let ((col (current-column))
10906 (name (plist-get plist :name)))
10907 (insert "#+BEGIN: " name)
10908 (while plist
10909 (if (eq (car plist) :name)
10910 (setq plist (cddr plist))
10911 (insert " " (prin1-to-string (pop plist)))))
10913 (beginning-of-line -2)))
10915 (defun org-prepare-dblock ()
10916 "Prepare dynamic block for refresh.
10917 This empties the block, puts the cursor at the insert position and returns
10918 the property list including an extra property :name with the block name."
10919 (unless (looking-at org-dblock-start-re)
10920 (error "Not at a dynamic block"))
10921 (let* ((begdel (1+ (match-end 0)))
10922 (name (org-no-properties (match-string 1)))
10923 (params (append (list :name name)
10924 (read (concat "(" (match-string 3) ")")))))
10925 (save-excursion
10926 (beginning-of-line 1)
10928 (setq params (plist-put params :indentation-column (current-column))))
10929 (unless (re-search-forward org-dblock-end-re nil t)
10930 (error "Dynamic block not terminated"))
10931 (setq params
10932 (append params
10933 (list :content (buffer-substring
10934 begdel (match-beginning 0)))))
10935 (delete-region begdel (match-beginning 0))
10936 (goto-char begdel)
10937 (open-line 1)
10938 params))
10940 (defun org-map-dblocks (&optional command)
10941 "Apply COMMAND to all dynamic blocks in the current buffer.
10942 If COMMAND is not given, use `org-update-dblock'."
10943 (let ((cmd (or command 'org-update-dblock)))
10944 (save-excursion
10945 (goto-char (point-min))
10946 (while (re-search-forward org-dblock-start-re nil t)
10947 (goto-char (match-beginning 0))
10948 (save-excursion
10949 (condition-case nil
10950 (funcall cmd)
10951 (error (message "Error during update of dynamic block"))))
10952 (unless (re-search-forward org-dblock-end-re nil t)
10953 (error "Dynamic block not terminated"))))))
10955 (defun org-dblock-update (&optional arg)
10956 "User command for updating dynamic blocks.
10957 Update the dynamic block at point. With prefix ARG, update all dynamic
10958 blocks in the buffer."
10959 (interactive "P")
10960 (if arg
10961 (org-update-all-dblocks)
10962 (or (looking-at org-dblock-start-re)
10963 (org-beginning-of-dblock))
10964 (org-update-dblock)))
10966 (defun org-update-dblock ()
10967 "Update the dynamic block at point.
10968 This means to empty the block, parse for parameters and then call
10969 the correct writing function."
10970 (interactive)
10971 (save-window-excursion
10972 (let* ((pos (point))
10973 (line (org-current-line))
10974 (params (org-prepare-dblock))
10975 (name (plist-get params :name))
10976 (indent (plist-get params :indentation-column))
10977 (cmd (intern (concat "org-dblock-write:" name))))
10978 (message "Updating dynamic block `%s' at line %d..." name line)
10979 (funcall cmd params)
10980 (message "Updating dynamic block `%s' at line %d...done" name line)
10981 (goto-char pos)
10982 (when (and indent (> indent 0))
10983 (setq indent (make-string indent ?\ ))
10984 (save-excursion
10985 (org-beginning-of-dblock)
10986 (forward-line 1)
10987 (while (not (looking-at org-dblock-end-re))
10988 (insert indent)
10989 (beginning-of-line 2))
10990 (when (looking-at org-dblock-end-re)
10992 (replace-match ""))
10993 (insert indent)))))))
10995 (defun org-beginning-of-dblock ()
10996 "Find the beginning of the dynamic block at point.
10997 Error if there is no such block at point."
10998 (let ((pos (point))
10999 beg)
11000 (end-of-line 1)
11001 (if (and (re-search-backward org-dblock-start-re nil t)
11002 (setq beg (match-beginning 0))
11003 (re-search-forward org-dblock-end-re nil t)
11004 (> (match-end 0) pos))
11005 (goto-char beg)
11006 (goto-char pos)
11007 (error "Not in a dynamic block"))))
11009 (defun org-update-all-dblocks ()
11010 "Update all dynamic blocks in the buffer.
11011 This function can be used in a hook."
11012 (interactive)
11013 (when (eq major-mode 'org-mode)
11014 (org-map-dblocks 'org-update-dblock)))
11017 ;;;; Completion
11019 (defconst org-additional-option-like-keywords
11020 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11021 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11022 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11023 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11024 "BEGIN:" "END:"
11025 "ORGTBL" "TBLFM:" "TBLNAME:"
11026 "BEGIN_EXAMPLE" "END_EXAMPLE"
11027 "BEGIN_QUOTE" "END_QUOTE"
11028 "BEGIN_VERSE" "END_VERSE"
11029 "BEGIN_CENTER" "END_CENTER"
11030 "BEGIN_SRC" "END_SRC"
11031 "BEGIN_RESULT" "END_RESULT"
11032 "NAME:" "RESULTS:"
11033 "HEADER:" "HEADERS:"
11034 "CATEGORY:" "COLUMNS:" "PROPERTY:"
11035 "CAPTION:" "LABEL:"
11036 "SETUPFILE:"
11037 "INCLUDE:"
11038 "BIND:"
11039 "MACRO:"))
11041 (defcustom org-structure-template-alist
11042 '(
11055 ("L" "#+latex: "
11059 ("H" "#+html: "
11062 ("A" "#+ascii: ")
11063 ("i" "#+index: ?"
11064 "#+index: ?")
11065 ("I" "#+include %file ?"
11067 )
11068 "Structure completion elements.
11069 This is a list of abbreviation keys and values. The value gets inserted
11070 if you type `<' followed by the key and then press the completion key,
11071 usually `M-TAB'. %file will be replaced by a file name after prompting
11072 for the file using completion. The cursor will be placed at the position
11073 of the `?` in the template.
11074 There are two templates for each key, the first uses the original Org syntax,
11075 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11076 the default when the /org-mtags.el/ module has been loaded. See also the
11077 variable `org-mtags-prefer-muse-templates'.
11078 This is an experimental feature, it is undecided if it is going to stay in."
11079 :group 'org-completion
11080 :type '(repeat
11081 (string :tag "Key")
11082 (string :tag "Template")
11083 (string :tag "Muse Template")))
11085 (defun org-try-structure-completion ()
11086 "Try to complete a structure template before point.
11088 expands them."
11089 (let ((l (buffer-substring (point-at-bol) (point)))
11090 a)
11093 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11094 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11095 (match-beginning 1)) a)
11096 t)))
11098 (defun org-complete-expand-structure-template (start cell)
11099 "Expand a structure template."
11100 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11101 (rpl (nth (if musep 2 1) cell))
11102 (ind ""))
11103 (delete-region start (point))
11105 (cond
11106 ((bolp))
11108 (setq ind (buffer-substring (point-at-bol) (point))))
11109 (t (newline))))
11110 (setq start (point))
11111 (if (string-match "%file" rpl)
11112 (setq rpl (replace-match
11113 (concat
11115 (save-match-data
11116 (abbreviate-file-name (read-file-name "Include file: ")))
11118 t t rpl)))
11121 (insert rpl)
11124 ;;;; TODO, DEADLINE, Comments
11126 (defun org-toggle-comment ()
11127 "Change the COMMENT state of an entry."
11128 (interactive)
11129 (save-excursion
11130 (org-back-to-heading)
11131 (let (case-fold-search)
11132 (cond
11133 ((looking-at (format org-heading-keyword-regexp-format
11134 org-comment-string))
11135 (goto-char (match-end 1))
11136 (looking-at (concat " +" org-comment-string))
11137 (replace-match "" t t)
11138 (when (eolp) (insert " ")))
11139 ((looking-at org-outline-regexp)
11140 (goto-char (match-end 0))
11141 (insert org-comment-string " "))))))
11143 (defvar org-last-todo-state-is-todo nil
11144 "This is non-nil when the last TODO state change led to a TODO state.
11145 If the last change removed the TODO tag or switched to DONE, then
11146 this is nil.")
11148 (defvar org-setting-tags nil) ; dynamically skipped
11150 (defvar org-todo-setup-filter-hook nil
11151 "Hook for functions that pre-filter todo specs.
11152 Each function takes a todo spec and returns either nil or the spec
11153 transformed into canonical form." )
11155 (defvar org-todo-get-default-hook nil
11156 "Hook for functions that get a default item for todo.
11157 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11158 nil or a string to be used for the todo mark." )
11160 (defvar org-agenda-headline-snapshot-before-repeat)
11162 (defun org-current-effective-time ()
11163 "Return current time adjusted for `org-extend-today-until' variable"
11164 (let* ((ct (org-current-time))
11165 (dct (decode-time ct))
11166 (ct1
11167 (if (and org-use-effective-time
11168 (< (nth 2 dct) org-extend-today-until))
11169 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11170 ct)))
11171 ct1))
11173 (defun org-todo-yesterday (&optional arg)
11174 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11175 (interactive "P")
11176 (if (eq major-mode 'org-agenda-mode)
11177 (apply 'org-agenda-todo-yesterday arg)
11178 (let* ((hour (third (decode-time
11179 (org-current-time))))
11180 (org-extend-today-until (1+ hour)))
11181 (org-todo arg))))
11183 (defun org-todo (&optional arg)
11184 "Change the TODO state of an item.
11185 The state of an item is given by a keyword at the start of the heading,
11186 like
11187 *** TODO Write paper
11188 *** DONE Call mom
11190 The different keywords are specified in the variable `org-todo-keywords'.
11192 So for this example: when the item starts with TODO, it is changed to DONE.
11193 When it starts with DONE, the DONE is removed. And when neither TODO nor
11194 DONE are present, add TODO at the beginning of the heading.
11197 state.
11198 With numeric prefix arg, switch to that state.
11200 keywords (nextset).
11202 With a numeric prefix arg of 0, inhibit note taking for the change.
11204 For calling through lisp, arg is also interpreted in the following way:
11205 'none -> empty state
11207 'done -> switch to DONE
11208 'nextset -> switch to the next set of keywords
11209 'previousset -> switch to the previous set of keywords
11211 really is a member of `org-todo-keywords'."
11212 (interactive "P")
11213 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11214 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11215 'region-start-level 'region))
11216 org-loop-over-headlines-in-active-region)
11217 (org-map-entries
11218 `(org-todo ,arg)
11219 org-loop-over-headlines-in-active-region
11220 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11221 (if (equal arg '(16)) (setq arg 'nextset))
11222 (let ((org-blocker-hook org-blocker-hook)
11223 (case-fold-search nil))
11224 (when (equal arg '(64))
11225 (setq arg nil org-blocker-hook nil))
11226 (when (and org-blocker-hook
11227 (or org-inhibit-blocking
11228 (org-entry-get nil "NOBLOCKING")))
11229 (setq org-blocker-hook nil))
11230 (save-excursion
11231 (catch 'exit
11232 (org-back-to-heading t)
11233 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11236 (let* ((match-data (match-data))
11237 (startpos (point-at-bol))
11238 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11239 (org-log-done org-log-done)
11240 (org-log-repeat org-log-repeat)
11241 (org-todo-log-states org-todo-log-states)
11242 (org-inhibit-logging
11243 (if (equal arg 0)
11244 (progn (setq arg nil) 'note) org-inhibit-logging))
11245 (this (match-string 1))
11246 (hl-pos (match-beginning 0))
11247 (head (org-get-todo-sequence-head this))
11248 (ass (assoc head org-todo-kwd-alist))
11249 (interpret (nth 1 ass))
11250 (done-word (nth 3 ass))
11251 (final-done-word (nth 4 ass))
11252 (last-state (or this ""))
11253 (completion-ignore-case t)
11254 (member (member this org-todo-keywords-1))
11255 (tail (cdr member))
11256 (state (cond
11257 ((and org-todo-key-trigger
11258 (or (and (equal arg '(4))
11259 (eq org-use-fast-todo-selection 'prefix))
11260 (and (not arg) org-use-fast-todo-selection
11261 (not (eq org-use-fast-todo-selection
11262 'prefix)))))
11263 ;; Use fast selection
11264 (org-fast-todo-selection))
11265 ((and (equal arg '(4))
11266 (or (not org-use-fast-todo-selection)
11267 (not org-todo-key-trigger)))
11268 ;; Read a state with completion
11269 (org-icompleting-read
11270 "State: " (mapcar (lambda(x) (list x))
11271 org-todo-keywords-1)
11272 nil t))
11273 ((eq arg 'right)
11274 (if this
11275 (if tail (car tail) nil)
11276 (car org-todo-keywords-1)))
11277 ((eq arg 'left)
11278 (if (equal member org-todo-keywords-1)
11279 nil
11280 (if this
11281 (nth (- (length org-todo-keywords-1)
11282 (length tail) 2)
11283 org-todo-keywords-1)
11284 (org-last org-todo-keywords-1))))
11285 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11286 (setq arg nil))) ; hack to fall back to cycling
11287 (arg
11288 ;; user or caller requests a specific state
11289 (cond
11290 ((equal arg "") nil)
11291 ((eq arg 'none) nil)
11292 ((eq arg 'done) (or done-word (car org-done-keywords)))
11293 ((eq arg 'nextset)
11294 (or (car (cdr (member head org-todo-heads)))
11295 (car org-todo-heads)))
11296 ((eq arg 'previousset)
11297 (let ((org-todo-heads (reverse org-todo-heads)))
11298 (or (car (cdr (member head org-todo-heads)))
11299 (car org-todo-heads))))
11300 ((car (member arg org-todo-keywords-1)))
11301 ((stringp arg)
11302 (error "State `%s' not valid in this file" arg))
11303 ((nth (1- (prefix-numeric-value arg))
11304 org-todo-keywords-1))))
11305 ((null member) (or head (car org-todo-keywords-1)))
11306 ((equal this final-done-word) nil) ;; -> make empty
11307 ((null tail) nil) ;; -> first entry
11308 ((memq interpret '(type priority))
11309 (if (eq this-command last-command)
11310 (car tail)
11311 (if (> (length tail) 0)
11312 (or done-word (car org-done-keywords))
11313 nil)))
11314 (t
11315 (car tail))))
11316 (state (or
11317 (run-hook-with-args-until-success
11318 'org-todo-get-default-hook state last-state)
11319 state))
11320 (next (if state (concat " " state " ") " "))
11321 (change-plist (list :type 'todo-state-change :from this :to state
11322 :position startpos))
11323 dolog now-done-p)
11324 (when org-blocker-hook
11325 (setq org-last-todo-state-is-todo
11326 (not (member this org-done-keywords)))
11327 (unless (save-excursion
11328 (save-match-data
11329 (org-with-wide-buffer
11330 (run-hook-with-args-until-failure
11331 'org-blocker-hook change-plist))))
11332 (if (org-called-interactively-p 'interactive)
11333 (error "TODO state change from %s to %s blocked" this state)
11334 ;; fail silently
11335 (message "TODO state change from %s to %s blocked" this state)
11336 (throw 'exit nil))))
11337 (store-match-data match-data)
11338 (replace-match next t t)
11339 (unless (pos-visible-in-window-p hl-pos)
11340 (message "TODO state changed to %s" (org-trim next)))
11341 (unless head
11342 (setq head (org-get-todo-sequence-head state)
11343 ass (assoc head org-todo-kwd-alist)
11344 interpret (nth 1 ass)
11345 done-word (nth 3 ass)
11346 final-done-word (nth 4 ass)))
11347 (when (memq arg '(nextset previousset))
11348 (message "Keyword-Set %d/%d: %s"
11349 (- (length org-todo-sets) -1
11350 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11351 (length org-todo-sets)
11352 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11353 (setq org-last-todo-state-is-todo
11354 (not (member state org-done-keywords)))
11355 (setq now-done-p (and (member state org-done-keywords)
11356 (not (member this org-done-keywords))))
11357 (and logging (org-local-logging logging))
11358 (when (and (or org-todo-log-states org-log-done)
11359 (not (eq org-inhibit-logging t))
11360 (not (memq arg '(nextset previousset))))
11361 ;; we need to look at recording a time and note
11362 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11363 (nth 2 (assoc this org-todo-log-states))))
11364 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11365 (setq dolog 'time))
11366 (when (and state
11367 (member state org-not-done-keywords)
11368 (not (member this org-not-done-keywords)))
11369 ;; This is now a todo state and was not one before
11370 ;; If there was a CLOSED time stamp, get rid of it.
11371 (org-add-planning-info nil nil 'closed))
11372 (when (and now-done-p org-log-done)
11373 ;; It is now done, and it was not done before
11374 (org-add-planning-info 'closed (org-current-effective-time))
11375 (if (and (not dolog) (eq 'note org-log-done))
11376 (org-add-log-setup 'done state this 'findpos 'note)))
11377 (when (and state dolog)
11378 ;; This is a non-nil state, and we need to log it
11379 (org-add-log-setup 'state state this 'findpos dolog)))
11380 ;; Fixup tag positioning
11381 (org-todo-trigger-tag-changes state)
11382 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11383 (when org-provide-todo-statistics
11384 (org-update-parent-todo-statistics))
11385 (run-hooks 'org-after-todo-state-change-hook)
11386 (if (and arg (not (member state org-done-keywords)))
11387 (setq head (org-get-todo-sequence-head state)))
11388 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11389 ;; Do we need to trigger a repeat?
11390 (when now-done-p
11391 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11392 ;; This is for the agenda, take a snapshot of the headline.
11393 (save-match-data
11394 (setq org-agenda-headline-snapshot-before-repeat
11395 (org-get-heading))))
11396 (org-auto-repeat-maybe state))
11397 ;; Fixup cursor location if close to the keyword
11398 (if (and (outline-on-heading-p)
11399 (not (bolp))
11400 (save-excursion (beginning-of-line 1)
11401 (looking-at org-todo-line-regexp))
11402 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11403 (progn
11404 (goto-char (or (match-end 2) (match-end 1)))
11405 (and (looking-at " ") (just-one-space))))
11406 (when org-trigger-hook
11407 (save-excursion
11408 (run-hook-with-args 'org-trigger-hook change-plist)))))))))
11410 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11411 "Block turning an entry into a TODO, using the hierarchy.
11412 This checks whether the current task should be blocked from state
11413 changes. Such blocking occurs when:
11415 1. The task has children which are not all in a completed state.
11417 2. A task has a parent with the property :ORDERED:, and there
11418 are siblings prior to the current task with incomplete
11419 status.
11421 3. The parent of the task is blocked because it has siblings that should
11422 be done first, or is child of a block grandparent TODO entry."
11424 (if (not org-enforce-todo-dependencies)
11425 t ; if locally turned off don't block
11426 (catch 'dont-block
11427 ;; If this is not a todo state change, or if this entry is already DONE,
11428 ;; do not block
11429 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11430 (member (plist-get change-plist :from)
11431 (cons 'done org-done-keywords))
11432 (member (plist-get change-plist :to)
11433 (cons 'todo org-not-done-keywords))
11434 (not (plist-get change-plist :to)))
11435 (throw 'dont-block t))
11436 ;; If this task has children, and any are undone, it's blocked
11437 (save-excursion
11438 (org-back-to-heading t)
11439 (let ((this-level (funcall outline-level)))
11440 (outline-next-heading)
11441 (let ((child-level (funcall outline-level)))
11442 (while (and (not (eobp))
11443 (> child-level this-level))
11444 ;; this todo has children, check whether they are all
11445 ;; completed
11446 (if (and (not (org-entry-is-done-p))
11447 (org-entry-is-todo-p))
11448 (throw 'dont-block nil))
11449 (outline-next-heading)
11450 (setq child-level (funcall outline-level))))))
11451 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11452 ;; any previous siblings are undone, it's blocked
11453 (save-excursion
11454 (org-back-to-heading t)
11455 (let* ((pos (point))
11456 (parent-pos (and (org-up-heading-safe) (point))))
11457 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11458 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11459 (forward-line 1)
11460 (re-search-forward org-not-done-heading-regexp pos t))
11461 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11462 ;; Search further up the hierarchy, to see if an ancestor is blocked
11463 (while t
11464 (goto-char parent-pos)
11465 (if (not (looking-at org-not-done-heading-regexp))
11466 (throw 'dont-block t)) ; do not block, parent is not a TODO
11467 (setq pos (point))
11468 (setq parent-pos (and (org-up-heading-safe) (point)))
11469 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11470 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11471 (forward-line 1)
11472 (re-search-forward org-not-done-heading-regexp pos t))
11473 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11475 (defcustom org-track-ordered-property-with-tag nil
11476 "Should the ORDERED property also be shown as a tag?
11477 The ORDERED property decides if an entry should require subtasks to be
11478 completed in sequence. Since a property is not very visible, setting
11479 this option means that toggling the ORDERED property with the command
11480 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11481 not relevant for the behavior, but it makes things more visible.
11483 Note that toggling the tag with tags commands will not change the property
11484 and therefore not influence behavior!
11486 This can be t, meaning the tag ORDERED should be used, It can also be a
11487 string to select a different tag for this task."
11488 :group 'org-todo
11489 :type '(choice
11490 (const :tag "No tracking" nil)
11491 (const :tag "Track with ORDERED tag" t)
11492 (string :tag "Use other tag")))
11494 (defun org-toggle-ordered-property ()
11495 "Toggle the ORDERED property of the current entry.
11496 For better visibility, you can track the value of this property with a tag.
11497 See variable `org-track-ordered-property-with-tag'."
11498 (interactive)
11499 (let* ((t1 org-track-ordered-property-with-tag)
11500 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11501 (save-excursion
11502 (org-back-to-heading)
11503 (if (org-entry-get nil "ORDERED")
11504 (progn
11505 (org-delete-property "ORDERED")
11506 (and tag (org-toggle-tag tag 'off))
11507 (message "Subtasks can be completed in arbitrary order"))
11508 (org-entry-put nil "ORDERED" "t")
11509 (and tag (org-toggle-tag tag 'on))
11510 (message "Subtasks must be completed in sequence")))))
11512 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11513 (defun org-block-todo-from-checkboxes (change-plist)
11514 "Block turning an entry into a TODO, using checkboxes.
11515 This checks whether the current task should be blocked from state
11516 changes because there are unchecked boxes in this entry."
11517 (if (not org-enforce-todo-checkbox-dependencies)
11518 t ; if locally turned off don't block
11519 (catch 'dont-block
11520 ;; If this is not a todo state change, or if this entry is already DONE,
11521 ;; do not block
11522 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11523 (member (plist-get change-plist :from)
11524 (cons 'done org-done-keywords))
11525 (member (plist-get change-plist :to)
11526 (cons 'todo org-not-done-keywords))
11527 (not (plist-get change-plist :to)))
11528 (throw 'dont-block t))
11529 ;; If this task has checkboxes that are not checked, it's blocked
11530 (save-excursion
11531 (org-back-to-heading t)
11532 (let ((beg (point)) end)
11533 (outline-next-heading)
11534 (setq end (point))
11535 (goto-char beg)
11536 (if (org-list-search-forward
11537 (concat (org-item-beginning-re)
11540 end t)
11541 (progn
11542 (if (boundp 'org-blocked-by-checkboxes)
11543 (setq org-blocked-by-checkboxes t))
11544 (throw 'dont-block nil)))))
11545 t))) ; do not block
11547 (defun org-entry-blocked-p ()
11548 "Is the current entry blocked?"
11549 (if (org-entry-get nil "NOBLOCKING")
11550 nil ;; Never block this entry
11551 (not
11552 (run-hook-with-args-until-failure
11553 'org-blocker-hook
11554 (list :type 'todo-state-change
11555 :position (point)
11556 :from 'todo
11557 :to 'done)))))
11559 (defun org-update-statistics-cookies (all)
11560 "Update the statistics cookie, either from TODO or from checkboxes.
11561 This should be called with the cursor in a line with a statistics cookie."
11562 (interactive "P")
11563 (if all
11564 (progn
11565 (org-update-checkbox-count 'all)
11566 (org-map-entries 'org-update-parent-todo-statistics))
11567 (if (not (org-at-heading-p))
11568 (org-update-checkbox-count)
11569 (let ((pos (move-marker (make-marker) (point)))
11570 end l1 l2)
11571 (ignore-errors (org-back-to-heading t))
11572 (if (not (org-at-heading-p))
11573 (org-update-checkbox-count)
11574 (setq l1 (org-outline-level))
11575 (setq end (save-excursion
11576 (outline-next-heading)
11577 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11578 (point)))
11579 (if (and (save-excursion
11580 (re-search-forward
11582 (not (save-excursion (re-search-forward
11584 (org-update-checkbox-count)
11585 (if (and l2 (> l2 l1))
11586 (progn
11587 (goto-char end)
11588 (org-update-parent-todo-statistics))
11589 (goto-char pos)
11590 (beginning-of-line 1)
11591 (while (re-search-forward
11593 (point-at-eol) t)
11594 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11595 (goto-char pos)
11596 (move-marker pos nil)))))
11598 (defvar org-entry-property-inherited-from) ;; defined below
11599 (defun org-update-parent-todo-statistics ()
11600 "Update any statistics cookie in the parent of the current headline.
11601 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11602 the entire subtree and this will travel up the hierarchy and update
11603 statistics everywhere."
11604 (let* ((prop (save-excursion (org-up-heading-safe)
11605 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11606 (recursive (or (not org-hierarchical-todo-statistics)
11608 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11609 0))
11610 (first t)
11612 level ltoggle l1 new ndel
11613 (cnt-all 0) (cnt-done 0) is-percent kwd
11614 checkbox-beg ov ovs ove cookie-present)
11615 (catch 'exit
11616 (save-excursion
11617 (beginning-of-line 1)
11618 (setq ltoggle (funcall outline-level))
11619 ;; Three situations are to consider:
11621 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11622 ;; to the top-level ancestor on the headline;
11624 ;; 2. If parent has "recursive" property, repeat up to the
11625 ;; headline setting that property, taking inheritance into
11626 ;; account;
11628 ;; 3. Else, move up to direct parent and proceed only once.
11629 (while (and (setq level (org-up-heading-safe))
11630 (or recursive first)
11631 (>= (point) lim))
11632 (setq first nil cookie-present nil)
11633 (unless (and level
11634 (not (string-match
11636 (downcase (or (org-entry-get nil "COOKIE_DATA")
11637 "")))))
11638 (throw 'exit nil))
11639 (while (re-search-forward box-re (point-at-eol) t)
11640 (setq cnt-all 0 cnt-done 0 cookie-present t)
11641 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11642 (save-match-data
11643 (unless (outline-next-heading) (throw 'exit nil))
11644 (while (and (looking-at org-complex-heading-regexp)
11645 (> (setq l1 (length (match-string 1))) level))
11646 (setq kwd (and (or recursive (= l1 ltoggle))
11647 (match-string 2)))
11648 (if (or (eq org-provide-todo-statistics 'all-headlines)
11649 (and (listp org-provide-todo-statistics)
11650 (or (member kwd org-provide-todo-statistics)
11651 (member kwd org-done-keywords))))
11652 (setq cnt-all (1+ cnt-all))
11653 (if (eq org-provide-todo-statistics t)
11654 (and kwd (setq cnt-all (1+ cnt-all)))))
11655 (and (member kwd org-done-keywords)
11656 (setq cnt-done (1+ cnt-done)))
11657 (outline-next-heading)))
11658 (setq new
11659 (if is-percent
11660 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11661 (format "[%d/%d]" cnt-done cnt-all))
11662 ndel (- (match-end 0) checkbox-beg))
11663 ;; handle overlays when updating cookie from column view
11664 (when (setq ov (car (overlays-at checkbox-beg)))
11665 (setq ovs (overlay-start ov) ove (overlay-end ov))
11666 (delete-overlay ov))
11667 (goto-char checkbox-beg)
11668 (insert new)
11669 (delete-region (point) (+ (point) ndel))
11670 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11671 (when ov (move-overlay ov ovs ove)))
11672 (when cookie-present
11673 (run-hook-with-args 'org-after-todo-statistics-hook
11674 cnt-done (- cnt-all cnt-done))))))
11675 (run-hooks 'org-todo-statistics-hook)))
11677 (defvar org-after-todo-statistics-hook nil
11678 "Hook that is called after a TODO statistics cookie has been updated.
11679 Each function is called with two arguments: the number of not-done entries
11680 and the number of done entries.
11682 For example, the following function, when added to this hook, will switch
11683 an entry to DONE when all children are done, and back to TODO when new
11684 entries are set to a TODO status. Note that this hook is only called
11685 when there is a statistics cookie in the headline!
11687 (defun org-summary-todo (n-done n-not-done)
11689 (let (org-log-done org-log-states) ; turn off logging
11691 ")
11693 (defvar org-todo-statistics-hook nil
11694 "Hook that is run whenever Org thinks TODO statistics should be updated.
11695 This hook runs even if there is no statistics cookie present, in which case
11696 `org-after-todo-statistics-hook' would not run.")
11698 (defun org-todo-trigger-tag-changes (state)
11699 "Apply the changes defined in `org-todo-state-tags-triggers'."
11700 (let ((l org-todo-state-tags-triggers)
11701 changes)
11702 (when (or (not state) (equal state ""))
11703 (setq changes (append changes (cdr (assoc "" l)))))
11704 (when (and (stringp state) (> (length state) 0))
11705 (setq changes (append changes (cdr (assoc state l)))))
11706 (when (member state org-not-done-keywords)
11707 (setq changes (append changes (cdr (assoc 'todo l)))))
11708 (when (member state org-done-keywords)
11709 (setq changes (append changes (cdr (assoc 'done l)))))
11710 (dolist (c changes)
11711 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11713 (defun org-local-logging (value)
11714 "Get logging settings from a property VALUE."
11715 (let* (words w a)
11716 ;; directly set the variables, they are already local.
11717 (setq org-log-done nil
11718 org-log-repeat nil
11719 org-todo-log-states nil)
11720 (setq words (org-split-string value))
11721 (while (setq w (pop words))
11722 (cond
11723 ((setq a (assoc w org-startup-options))
11724 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11725 (set (nth 1 a) (nth 2 a))))
11726 ((setq a (org-extract-log-state-settings w))
11727 (and (member (car a) org-todo-keywords-1)
11728 (push a org-todo-log-states)))))))
11730 (defun org-get-todo-sequence-head (kwd)
11731 "Return the head of the TODO sequence to which KWD belongs.
11732 If KWD is not set, check if there is a text property remembering the
11733 right sequence."
11734 (let (p)
11735 (cond
11736 ((not kwd)
11737 (or (get-text-property (point-at-bol) 'org-todo-head)
11738 (progn
11739 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11740 nil (point-at-eol)))
11741 (get-text-property p 'org-todo-head))))
11742 ((not (member kwd org-todo-keywords-1))
11743 (car org-todo-keywords-1))
11744 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11746 (defun org-fast-todo-selection ()
11747 "Fast TODO keyword selection with single keys.
11748 Returns the new TODO keyword, or nil if no state change should occur."
11749 (let* ((fulltable org-todo-key-alist)
11750 (done-keywords org-done-keywords) ;; needed for the faces.
11751 (maxlen (apply 'max (mapcar
11752 (lambda (x)
11753 (if (stringp (car x)) (string-width (car x)) 0))
11754 fulltable)))
11755 (expert nil)
11756 (fwidth (+ maxlen 3 1 3))
11757 (ncol (/ (- (window-width) 4) fwidth))
11758 tg cnt e c tbl
11759 groups ingroup)
11760 (save-excursion
11761 (save-window-excursion
11762 (if expert
11763 (set-buffer (get-buffer-create " *Org todo*"))
11764 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11765 (erase-buffer)
11766 (org-set-local 'org-done-keywords done-keywords)
11767 (setq tbl fulltable cnt 0)
11768 (while (setq e (pop tbl))
11769 (cond
11770 ((equal e '(:startgroup))
11771 (push '() groups) (setq ingroup t)
11772 (when (not (= cnt 0))
11773 (setq cnt 0)
11775 (insert "{ "))
11776 ((equal e '(:endgroup))
11777 (setq ingroup nil cnt 0)
11779 ((equal e '(:newline))
11780 (when (not (= cnt 0))
11781 (setq cnt 0)
11783 (setq e (car tbl))
11784 (while (equal (car tbl) '(:newline))
11786 (setq tbl (cdr tbl)))))
11787 (t
11788 (setq tg (car e) c (cdr e))
11789 (if ingroup (push tg (car groups)))
11790 (setq tg (org-add-props tg nil 'face
11791 (org-get-todo-face tg)))
11792 (if (and (= cnt 0) (not ingroup)) (insert " "))
11793 (insert "[" c "] " tg (make-string
11794 (- fwidth 4 (length tg)) ?\ ))
11795 (when (= (setq cnt (1+ cnt)) ncol)
11797 (if ingroup (insert " "))
11798 (setq cnt 0)))))
11800 (goto-char (point-min))
11801 (if (not expert) (org-fit-window-to-buffer))
11802 (message "[a-z..]:Set [SPC]:clear")
11803 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11804 (cond
11805 ((or (= c ?\C-g)
11806 (and (= c ?q) (not (rassoc c fulltable))))
11807 (setq quit-flag t))
11808 ((= c ?\ ) nil)
11809 ((setq e (rassoc c fulltable) tg (car e))
11810 tg)
11811 (t (setq quit-flag t)))))))
11813 (defun org-entry-is-todo-p ()
11814 (member (org-get-todo-state) org-not-done-keywords))
11816 (defun org-entry-is-done-p ()
11817 (member (org-get-todo-state) org-done-keywords))
11819 (defun org-get-todo-state ()
11820 (save-excursion
11821 (org-back-to-heading t)
11822 (and (looking-at org-todo-line-regexp)
11823 (match-end 2)
11824 (match-string 2))))
11826 (defun org-at-date-range-p (&optional inactive-ok)
11827 "Is the cursor inside a date range?"
11828 (interactive)
11829 (save-excursion
11830 (catch 'exit
11831 (let ((pos (point)))
11833 (skip-chars-backward "<[")
11834 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11835 (>= (match-end 0) pos)
11836 (throw 'exit t))
11838 (skip-chars-backward "<[")
11839 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11840 (>= (match-end 0) pos)
11841 (throw 'exit t)))
11842 nil)))
11844 (defun org-get-repeat (&optional tagline)
11845 "Check if there is a deadline/schedule with repeater in this entry."
11846 (save-match-data
11847 (save-excursion
11848 (org-back-to-heading t)
11849 (and (re-search-forward (if tagline
11851 org-repeat-re)
11852 (org-entry-end-position) t)
11853 (match-string-no-properties 1)))))
11855 (defvar org-last-changed-timestamp)
11856 (defvar org-last-inserted-timestamp)
11857 (defvar org-log-post-message)
11858 (defvar org-log-note-purpose)
11859 (defvar org-log-note-how)
11860 (defvar org-log-note-extra)
11861 (defun org-auto-repeat-maybe (done-word)
11862 "Check if the current headline contains a repeated deadline/schedule.
11863 If yes, set TODO state back to what it was and change the base date
11864 of repeating deadline/scheduled time stamps to new date.
11865 This function is run automatically after each state change to a DONE state."
11866 ;; last-state is dynamically scoped into this function
11867 (let* ((repeat (org-get-repeat))
11868 (aa (assoc last-state org-todo-kwd-alist))
11869 (interpret (nth 1 aa))
11870 (head (nth 2 aa))
11871 (whata '(("d" . day) ("m" . month) ("y" . year)))
11872 (msg "Entry repeats: ")
11873 (org-log-done nil)
11874 (org-todo-log-states nil)
11875 re type n what ts time to-state)
11876 (when repeat
11877 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11878 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11879 org-todo-repeat-to-state))
11880 (unless (and to-state (member to-state org-todo-keywords-1))
11881 (setq to-state (if (eq interpret 'type) last-state head)))
11882 (org-todo to-state)
11883 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11884 (org-entry-put nil "LAST_REPEAT" (format-time-string
11885 (org-time-stamp-format t t))))
11886 (when org-log-repeat
11887 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11888 (memq 'org-add-log-note post-command-hook))
11889 ;; OK, we are already setup for some record
11890 (if (eq org-log-repeat 'note)
11891 ;; make sure we take a note, not only a time stamp
11892 (setq org-log-note-how 'note))
11893 ;; Set up for taking a record
11894 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11895 last-state
11896 'findpos org-log-repeat)))
11897 (org-back-to-heading t)
11898 (org-add-planning-info nil nil 'closed)
11902 (while (re-search-forward
11903 re (save-excursion (outline-next-heading) (point)) t)
11904 (setq type (if (match-end 1) org-scheduled-string
11905 (if (match-end 3) org-deadline-string "Plain:"))
11906 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11908 (setq n (string-to-number (match-string 2 ts))
11909 what (match-string 3 ts))
11910 (if (equal what "w") (setq n (* n 7) what "d"))
11911 ;; Preparation, see if we need to modify the start date for the change
11912 (when (match-end 1)
11913 (setq time (save-match-data (org-time-string-to-time ts)))
11914 (cond
11915 ((equal (match-string 1 ts) ".")
11916 ;; Shift starting date to today
11917 (org-timestamp-change
11918 (- (org-today) (time-to-days time))
11919 'day))
11920 ((equal (match-string 1 ts) "+")
11921 (let ((nshiftmax 10) (nshift 0))
11922 (while (or (= nshift 0)
11923 (<= (time-to-days time)
11924 (time-to-days (current-time))))
11925 (when (= (incf nshift) nshiftmax)
11926 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11927 (error "Abort")))
11928 (org-timestamp-change n (cdr (assoc what whata)))
11929 (org-at-timestamp-p t)
11930 (setq ts (match-string 1))
11931 (setq time (save-match-data (org-time-string-to-time ts)))))
11932 (org-timestamp-change (- n) (cdr (assoc what whata)))
11933 ;; rematch, so that we have everything in place for the real shift
11934 (org-at-timestamp-p t)
11935 (setq ts (match-string 1))
11937 (org-timestamp-change n (cdr (assoc what whata)))
11938 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11939 (setq org-log-post-message msg)
11940 (message "%s" msg))))
11942 (defun org-show-todo-tree (arg)
11943 "Make a compact tree which shows all headlines marked with TODO.
11944 The tree will show the lines where the regexp matches, and all higher
11945 headlines above the match.
11947 With a numeric prefix N, construct a sparse tree for the Nth element
11948 of `org-todo-keywords-1'."
11949 (interactive "P")
11950 (let ((case-fold-search nil)
11951 (kwd-re
11952 (cond ((null arg) org-not-done-regexp)
11953 ((equal arg '(4))
11954 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11955 (mapcar 'list org-todo-keywords-1))))
11959 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11960 (regexp-quote (nth (1- (prefix-numeric-value arg))
11961 org-todo-keywords-1)))
11962 (t (error "Invalid prefix argument: %s" arg)))))
11963 (message "%d TODO entries found"
11964 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11966 (defun org-deadline (&optional remove time)
11968 With argument REMOVE, remove any deadline from the item.
11969 With argument TIME, set the deadline at the corresponding date. TIME
11971 (interactive "P")
11972 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11973 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11974 'region-start-level 'region))
11975 org-loop-over-headlines-in-active-region)
11976 (org-map-entries
11977 `(org-deadline ',remove ,time)
11978 org-loop-over-headlines-in-active-region
11979 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11980 (let* ((old-date (org-entry-get nil "DEADLINE"))
11981 (repeater (and old-date
11982 (string-match
11984 old-date)
11985 (match-string 1 old-date))))
11986 (if remove
11987 (progn
11988 (when (and old-date org-log-redeadline)
11989 (org-add-log-setup 'deldeadline nil old-date 'findpos
11990 org-log-redeadline))
11991 (org-remove-timestamp-with-keyword org-deadline-string)
11992 (message "Item no longer has a deadline."))
11993 (org-add-planning-info 'deadline time 'closed)
11994 (when (and old-date org-log-redeadline
11995 (not (equal old-date
11996 (substring org-last-inserted-timestamp 1 -1))))
11997 (org-add-log-setup 'redeadline nil old-date 'findpos
11998 org-log-redeadline))
11999 (when repeater
12000 (save-excursion
12001 (org-back-to-heading t)
12002 (when (re-search-forward (concat org-deadline-string " "
12003 org-last-inserted-timestamp)
12004 (save-excursion
12005 (outline-next-heading) (point)) t)
12006 (goto-char (1- (match-end 0)))
12007 (insert " " repeater)
12008 (setq org-last-inserted-timestamp
12009 (concat (substring org-last-inserted-timestamp 0 -1)
12010 " " repeater
12011 (substring org-last-inserted-timestamp -1))))))
12012 (message "Deadline on %s" org-last-inserted-timestamp)))))
12014 (defun org-schedule (&optional remove time)
12015 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12016 With argument REMOVE, remove any scheduling date from the item.
12017 With argument TIME, scheduled at the corresponding date. TIME can
12019 (interactive "P")
12020 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12021 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12022 'region-start-level 'region))
12023 org-loop-over-headlines-in-active-region)
12024 (org-map-entries
12025 `(org-schedule ',remove ,time)
12026 org-loop-over-headlines-in-active-region
12027 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12028 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12029 (repeater (and old-date
12030 (string-match
12032 old-date)
12033 (match-string 1 old-date))))
12034 (if remove
12035 (progn
12036 (when (and old-date org-log-reschedule)
12037 (org-add-log-setup 'delschedule nil old-date 'findpos
12038 org-log-reschedule))
12039 (org-remove-timestamp-with-keyword org-scheduled-string)
12040 (message "Item is no longer scheduled."))
12041 (org-add-planning-info 'scheduled time 'closed)
12042 (when (and old-date org-log-reschedule
12043 (not (equal old-date
12044 (substring org-last-inserted-timestamp 1 -1))))
12045 (org-add-log-setup 'reschedule nil old-date 'findpos
12046 org-log-reschedule))
12047 (when repeater
12048 (save-excursion
12049 (org-back-to-heading t)
12050 (when (re-search-forward (concat org-scheduled-string " "
12051 org-last-inserted-timestamp)
12052 (save-excursion
12053 (outline-next-heading) (point)) t)
12054 (goto-char (1- (match-end 0)))
12055 (insert " " repeater)
12056 (setq org-last-inserted-timestamp
12057 (concat (substring org-last-inserted-timestamp 0 -1)
12058 " " repeater
12059 (substring org-last-inserted-timestamp -1))))))
12060 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12062 (defun org-get-scheduled-time (pom &optional inherit)
12063 "Get the scheduled time as a time tuple, of a format suitable
12064 for calling org-schedule with, or if there is no scheduling,
12065 returns nil."
12066 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12067 (when time
12068 (apply 'encode-time (org-parse-time-string time)))))
12070 (defun org-get-deadline-time (pom &optional inherit)
12071 "Get the deadline as a time tuple, of a format suitable for
12072 calling org-deadline with, or if there is no scheduling, returns
12073 nil."
12074 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12075 (when time
12076 (apply 'encode-time (org-parse-time-string time)))))
12078 (defun org-remove-timestamp-with-keyword (keyword)
12079 "Remove all time stamps with KEYWORD in the current entry."
12081 beg)
12082 (save-excursion
12083 (org-back-to-heading t)
12084 (setq beg (point))
12085 (outline-next-heading)
12086 (while (re-search-backward re beg t)
12087 (replace-match "")
12089 (equal (char-before) ?\ ))
12090 (backward-delete-char 1)
12092 (point-at-bol) (point-at-eol)))
12093 (delete-region (point-at-bol)
12094 (min (point-max) (1+ (point-at-eol))))))))))
12096 (defun org-add-planning-info (what &optional time &rest remove)
12097 "Insert new timestamp with keyword in the line directly after the headline.
12098 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12099 If non is given, the user is prompted for a date.
12100 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12101 be removed."
12102 (interactive)
12103 (let (org-time-was-given org-end-time-was-given ts
12104 end default-time default-input)
12106 (catch 'exit
12107 (when (and (memq what '(scheduled deadline))
12108 (or (not time)
12109 (and (stringp time)
12110 (string-match "^[-+]+[0-9]" time))))
12111 ;; Try to get a default date/time from existing timestamp
12112 (save-excursion
12113 (org-back-to-heading t)
12114 (setq end (save-excursion (outline-next-heading) (point)))
12115 (when (re-search-forward (if (eq what 'scheduled)
12116 org-scheduled-time-regexp
12117 org-deadline-time-regexp)
12118 end t)
12119 (setq ts (match-string 1)
12120 default-time
12121 (apply 'encode-time (org-parse-time-string ts))
12122 default-input (and ts (org-get-compact-tod ts))))))
12123 (when what
12124 (setq time
12125 (if (stringp time)
12126 ;; This is a string (relative or absolute), set proper date
12127 (apply 'encode-time
12128 (org-read-date-analyze
12129 time default-time (decode-time default-time)))
12130 ;; If necessary, get the time from the user
12131 (or time (org-read-date nil 'to-time nil nil
12132 default-time default-input)))))
12134 (when (and org-insert-labeled-timestamps-at-point
12135 (member what '(scheduled deadline)))
12136 (insert
12137 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12138 (org-insert-time-stamp time org-time-was-given
12139 nil nil nil (list org-end-time-was-given))
12140 (setq what nil))
12141 (save-excursion
12142 (save-restriction
12143 (let (col list elt ts buffer-invisibility-spec)
12144 (org-back-to-heading t)
12146 (goto-char (match-end 1))
12147 (setq col (current-column))
12148 (goto-char (match-end 0))
12150 (when (and (not what)
12151 (not (looking-at
12153 org-keyword-time-not-clock-regexp))))
12154 ;; Nothing to add, nothing to remove...... :-)
12155 (throw 'exit nil))
12156 (if (and (not (looking-at org-outline-regexp))
12159 (not (equal (match-string 1) org-clock-string)))
12160 (narrow-to-region (match-beginning 0) (match-end 0))
12162 (backward-char 1)
12163 (narrow-to-region (point) (point))
12164 (and org-adapt-indentation (org-indent-to-column col)))
12165 ;; Check if we have to remove something.
12166 (setq list (cons what remove))
12167 (while list
12168 (setq elt (pop list))
12169 (when (or (and (eq elt 'scheduled)
12170 (re-search-forward org-scheduled-time-regexp nil t))
12171 (and (eq elt 'deadline)
12172 (re-search-forward org-deadline-time-regexp nil t))
12173 (and (eq elt 'closed)
12174 (re-search-forward org-closed-time-regexp nil t)))
12175 (replace-match "")
12176 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12178 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12179 (when what
12180 (insert
12181 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12182 (cond ((eq what 'scheduled) org-scheduled-string)
12183 ((eq what 'deadline) org-deadline-string)
12184 ((eq what 'closed) org-closed-string))
12185 " ")
12186 (setq ts (org-insert-time-stamp
12187 time
12188 (or org-time-was-given
12189 (and (eq what 'closed) org-log-done-with-time))
12190 (eq what 'closed)
12191 nil nil (list org-end-time-was-given)))
12192 (insert
12193 (if (not (or (bolp) (eq (char-before) ?\ )
12194 (memq (char-after) '(32 10))
12195 (eobp))) " " ""))
12196 (end-of-line 1))
12197 (goto-char (point-min))
12198 (widen)
12201 (delete-region (1- (point)) (point-at-eol)))
12202 ts))))))
12204 (defvar org-log-note-marker (make-marker))
12205 (defvar org-log-note-purpose nil)
12206 (defvar org-log-note-state nil)
12207 (defvar org-log-note-previous-state nil)
12208 (defvar org-log-note-how nil)
12209 (defvar org-log-note-extra nil)
12210 (defvar org-log-note-window-configuration nil)
12211 (defvar org-log-note-return-to (make-marker))
12212 (defvar org-log-note-effective-time nil
12213 "Remembered current time so that dynamically scoped
12214 `org-extend-today-until' affects tha timestamps in state change
12215 log")
12217 (defvar org-log-post-message nil
12218 "Message to be displayed after a log note has been stored.
12219 The auto-repeater uses this.")
12221 (defun org-add-note ()
12222 "Add a note to the current entry.
12223 This is done in the same way as adding a state change note."
12224 (interactive)
12225 (org-add-log-setup 'note nil nil 'findpos nil))
12227 (defvar org-property-end-re)
12228 (defun org-add-log-setup (&optional purpose state prev-state
12229 findpos how extra)
12230 "Set up the post command hook to take a note.
12231 If this is about to TODO state change, the new state is expected in STATE.
12232 When FINDPOS is non-nil, find the correct position for the note in
12233 the current entry. If not, assume that it can be inserted at point.
12234 HOW is an indicator what kind of note should be created.
12235 EXTRA is additional text that will be inserted into the notes buffer."
12236 (let* ((org-log-into-drawer (org-log-into-drawer))
12237 (drawer (cond ((stringp org-log-into-drawer)
12238 org-log-into-drawer)
12239 (org-log-into-drawer "LOGBOOK")
12240 (t nil))))
12241 (save-restriction
12242 (save-excursion
12243 (when findpos
12244 (org-back-to-heading t)
12245 (narrow-to-region (point) (save-excursion
12246 (outline-next-heading) (point)))
12250 (goto-char (match-end 0))
12251 (cond
12252 (drawer
12254 nil t)
12255 (progn
12256 (goto-char (match-end 0))
12257 (or org-log-states-order-reversed
12258 (and (re-search-forward org-property-end-re nil t)
12259 (goto-char (1- (match-beginning 0))))))
12261 (beginning-of-line 0)
12262 (org-indent-line-function)
12263 (beginning-of-line 2)
12264 (org-indent-line-function)
12265 (end-of-line 0)))
12266 ((and org-log-state-notes-insert-after-drawers
12267 (save-excursion
12268 (forward-line) (looking-at org-drawer-regexp)))
12269 (forward-line)
12270 (while (looking-at org-drawer-regexp)
12271 (goto-char (match-end 0))
12272 (re-search-forward org-property-end-re (point-max) t)
12273 (forward-line))
12274 (forward-line -1)))
12275 (unless org-log-states-order-reversed
12277 (org-skip-over-state-notes)
12279 (move-marker org-log-note-marker (point))
12280 (setq org-log-note-purpose purpose
12281 org-log-note-state state
12282 org-log-note-previous-state prev-state
12283 org-log-note-how how
12284 org-log-note-extra extra
12285 org-log-note-effective-time (org-current-effective-time))
12286 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12288 (defun org-skip-over-state-notes ()
12289 "Skip past the list of State notes in an entry."
12291 (when (ignore-errors (goto-char (org-in-item-p)))
12292 (let* ((struct (org-list-struct))
12293 (prevs (org-list-prevs-alist struct)))
12295 (goto-char (or (org-list-get-next-item (point) struct prevs)
12296 (org-list-get-item-end (point) struct)))))))
12298 (defun org-add-log-note (&optional purpose)
12299 "Pop up a window for taking a note, and add this note later at point."
12300 (remove-hook 'post-command-hook 'org-add-log-note)
12301 (setq org-log-note-window-configuration (current-window-configuration))
12302 (delete-other-windows)
12303 (move-marker org-log-note-return-to (point))
12304 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12305 (goto-char org-log-note-marker)
12306 (org-switch-to-buffer-other-window "*Org Note*")
12307 (erase-buffer)
12308 (if (memq org-log-note-how '(time state))
12309 (let (current-prefix-arg) (org-store-log-note))
12310 (let ((org-inhibit-startup t)) (org-mode))
12311 (insert (format "# Insert note for %s.
12313 (cond
12314 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12315 ((eq org-log-note-purpose 'done) "closed todo item")
12316 ((eq org-log-note-purpose 'state)
12318 (or org-log-note-previous-state "")
12319 (or org-log-note-state "")))
12320 ((eq org-log-note-purpose 'reschedule)
12321 "rescheduling")
12322 ((eq org-log-note-purpose 'delschedule)
12323 "no longer scheduled")
12324 ((eq org-log-note-purpose 'redeadline)
12325 "changing deadline")
12326 ((eq org-log-note-purpose 'deldeadline)
12327 "removing deadline")
12328 ((eq org-log-note-purpose 'refile)
12329 "refiling")
12330 ((eq org-log-note-purpose 'note)
12331 "this entry")
12332 (t (error "This should not happen")))))
12333 (if org-log-note-extra (insert org-log-note-extra))
12334 (org-set-local 'org-finish-function 'org-store-log-note)
12335 (run-hooks 'org-log-buffer-setup-hook)))
12337 (defvar org-note-abort nil) ; dynamically scoped
12338 (defun org-store-log-note ()
12339 "Finish taking a log note, and insert it to where it belongs."
12340 (let ((txt (buffer-string))
12341 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12342 lines ind bul)
12343 (kill-buffer (current-buffer))
12345 (setq txt (replace-match "" t t txt)))
12347 (setq txt (replace-match "" t t txt)))
12350 (setq note
12351 (org-replace-escapes
12352 note
12353 (list (cons "%u" (user-login-name))
12354 (cons "%U" user-full-name)
12355 (cons "%t" (format-time-string
12356 (org-time-stamp-format 'long 'inactive)
12357 org-log-note-effective-time))
12358 (cons "%T" (format-time-string
12359 (org-time-stamp-format 'long nil)
12360 org-log-note-effective-time))
12361 (cons "%d" (format-time-string
12362 (org-time-stamp-format nil 'inactive)
12363 org-log-note-effective-time))
12364 (cons "%D" (format-time-string
12365 (org-time-stamp-format nil nil)
12366 org-log-note-effective-time))
12367 (cons "%s" (if org-log-note-state
12369 ""))
12370 (cons "%S" (if org-log-note-previous-state
12374 (push note lines))
12375 (when (or current-prefix-arg org-note-abort)
12376 (when org-log-into-drawer
12377 (org-remove-empty-drawer-at
12378 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12379 org-log-note-marker))
12380 (setq lines nil))
12381 (when lines
12382 (with-current-buffer (marker-buffer org-log-note-marker)
12383 (save-excursion
12384 (goto-char org-log-note-marker)
12385 (move-marker org-log-note-marker nil)
12386 (end-of-line 1)
12388 (setq ind (save-excursion
12389 (if (ignore-errors (goto-char (org-in-item-p)))
12390 (let ((struct (org-list-struct)))
12391 (org-list-get-ind
12392 (org-list-get-top-point struct) struct))
12394 (cond
12395 ((and (org-at-heading-p)
12396 org-adapt-indentation)
12397 (1+ (org-current-level)))
12398 ((org-at-heading-p) 0)
12399 (t (org-get-indentation))))))
12400 (setq bul (org-list-bullet-string "-"))
12401 (org-indent-line-to ind)
12402 (insert bul (pop lines))
12403 (let ((ind-body (+ (length bul) ind)))
12404 (while lines
12406 (org-indent-line-to ind-body)
12407 (insert (pop lines))))
12408 (message "Note stored")
12409 (org-back-to-heading t)
12410 (org-cycle-hide-drawers 'children)))))
12411 (set-window-configuration org-log-note-window-configuration)
12412 (with-current-buffer (marker-buffer org-log-note-return-to)
12413 (goto-char org-log-note-return-to))
12414 (move-marker org-log-note-return-to nil)
12415 (and org-log-post-message (message "%s" org-log-post-message)))
12417 (defun org-remove-empty-drawer-at (drawer pos)
12418 "Remove an empty drawer DRAWER at position POS.
12419 POS may also be a marker."
12420 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12421 (save-excursion
12422 (save-restriction
12423 (widen)
12424 (goto-char pos)
12425 (if (org-in-regexp
12427 (replace-match ""))))))
12429 (defun org-sparse-tree (&optional arg)
12430 "Create a sparse tree, prompt for the details.
12431 This command can create sparse trees. You first need to select the type
12432 of match used to create the tree:
12434 t Show all TODO entries.
12435 T Show entries with a specific TODO keyword.
12436 m Show entries selected by a tags/property match.
12437 p Enter a property name and its value (both with completion on existing
12438 names/values) and show entries with that property.
12439 r Show entries matching a regular expression (`/' can be used as well)
12440 d Show deadlines due within `org-deadline-warning-days'.
12441 b Show deadlines and scheduled items before a date.
12442 a Show deadlines and scheduled items after a date."
12443 (interactive "P")
12444 (let (ans kwd value)
12445 (message "Sparse tree: [r]egexp [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date [D]ates range")
12446 (setq ans (read-char-exclusive))
12447 (cond
12448 ((equal ans ?d)
12449 (call-interactively 'org-check-deadlines))
12450 ((equal ans ?b)
12451 (call-interactively 'org-check-before-date))
12452 ((equal ans ?a)
12453 (call-interactively 'org-check-after-date))
12454 ((equal ans ?D)
12455 (call-interactively 'org-check-dates-range))
12456 ((equal ans ?t)
12457 (org-show-todo-tree nil))
12458 ((equal ans ?T)
12459 (org-show-todo-tree '(4)))
12460 ((member ans '(?T ?m))
12461 (call-interactively 'org-match-sparse-tree))
12462 ((member ans '(?p ?P))
12463 (setq kwd (org-icompleting-read "Property: "
12464 (mapcar 'list (org-buffer-property-keys))))
12465 (setq value (org-icompleting-read "Value: "
12466 (mapcar 'list (org-property-values kwd))))
12469 (org-match-sparse-tree arg (concat kwd "=" value)))
12470 ((member ans '(?r ?R ?/))
12471 (call-interactively 'org-occur))
12474 (defvar org-occur-highlights nil
12475 "List of overlays used for occur matches.")
12476 (make-variable-buffer-local 'org-occur-highlights)
12477 (defvar org-occur-parameters nil
12478 "Parameters of the active org-occur calls.
12479 This is a list, each call to org-occur pushes as cons cell,
12480 containing the regular expression and the callback, onto the list.
12481 The list can contain several entries if `org-occur' has been called
12482 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12483 will only contain one set of parameters. When the highlights are
12484 removed (for example with `C-c C-c', or with the next edit (depending
12485 on `org-remove-highlights-with-change'), this variable is emptied
12486 as well.")
12487 (make-variable-buffer-local 'org-occur-parameters)
12489 (defun org-occur (regexp &optional keep-previous callback)
12490 "Make a compact tree which shows all matches of REGEXP.
12491 The tree will show the lines where the regexp matches, and all higher
12492 headlines above the match. It will also show the heading after the match,
12493 to make sure editing the matching entry is easy.
12494 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12495 call to `org-occur' will be kept, to allow stacking of calls to this
12496 command.
12497 If CALLBACK is non-nil, it is a function which is called to confirm
12498 that the match should indeed be shown."
12500 (when (equal regexp "")
12501 (error "Regexp cannot be empty"))
12502 (unless keep-previous
12503 (org-remove-occur-highlights nil nil t))
12504 (push (cons regexp callback) org-occur-parameters)
12505 (let ((cnt 0))
12506 (save-excursion
12507 (goto-char (point-min))
12508 (if (or (not keep-previous) ; do not want to keep
12509 (not org-occur-highlights)) ; no previous matches
12510 ;; hide everything
12511 (org-overview))
12512 (while (re-search-forward regexp nil t)
12513 (when (or (not callback)
12514 (save-match-data (funcall callback)))
12515 (setq cnt (1+ cnt))
12516 (when org-highlight-sparse-tree-matches
12517 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12518 (org-show-context 'occur-tree))))
12519 (when org-remove-highlights-with-change
12520 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12521 nil 'local))
12522 (unless org-sparse-tree-open-archived-trees
12523 (org-hide-archived-subtrees (point-min) (point-max)))
12524 (run-hooks 'org-occur-hook)
12525 (if (org-called-interactively-p 'interactive)
12526 (message "%d match(es) for regexp %s" cnt regexp))
12527 cnt))
12529 (defun org-occur-next-match (&optional n reset)
12530 "Function for `next-error-function' to find sparse tree matches.
12531 N is the number of matches to move, when negative move backwards.
12532 RESET is entirely ignored - this function always goes back to the
12533 starting point when no match is found."
12534 (let* ((limit (if (< n 0) (point-min) (point-max)))
12535 (search-func (if (< n 0)
12536 'previous-single-char-property-change
12537 'next-single-char-property-change))
12538 (n (abs n))
12539 (pos (point))
12540 p1)
12541 (catch 'exit
12542 (while (setq p1 (funcall search-func (point) 'org-type))
12543 (when (equal p1 limit)
12544 (goto-char pos)
12545 (error "No more matches"))
12546 (when (equal (get-char-property p1 'org-type) 'org-occur)
12547 (setq n (1- n))
12548 (when (= n 0)
12549 (goto-char p1)
12550 (throw 'exit (point))))
12551 (goto-char p1))
12552 (goto-char p1)
12553 (error "No more matches"))))
12555 (defun org-show-context (&optional key)
12556 "Make sure point and context are visible.
12557 How much context is shown depends upon the variables
12558 `org-show-hierarchy-above', `org-show-following-heading',
12559 `org-show-entry-below' and `org-show-siblings'."
12560 (let ((heading-p (org-at-heading-p t))
12561 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12562 (following-p (org-get-alist-option org-show-following-heading key))
12563 (entry-p (org-get-alist-option org-show-entry-below key))
12564 (siblings-p (org-get-alist-option org-show-siblings key)))
12565 (catch 'exit
12566 ;; Show heading or entry text
12567 (if (and heading-p (not entry-p))
12568 (org-flag-heading nil) ; only show the heading
12569 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12570 (org-show-hidden-entry))) ; show entire entry
12571 (when following-p
12572 ;; Show next sibling, or heading below text
12573 (save-excursion
12574 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12575 (org-flag-heading nil))))
12576 (when siblings-p (org-show-siblings))
12577 (when hierarchy-p
12578 ;; show all higher headings, possibly with siblings
12579 (save-excursion
12580 (while (and (condition-case nil
12581 (progn (org-up-heading-all 1) t)
12582 (error nil))
12583 (not (bobp)))
12584 (org-flag-heading nil)
12585 (when siblings-p (org-show-siblings))))))))
12587 (defvar org-reveal-start-hook nil
12588 "Hook run before revealing a location.")
12590 (defun org-reveal (&optional siblings)
12591 "Show current entry, hierarchy above it, and the following headline.
12592 This can be used to show a consistent set of context around locations
12593 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12594 not t for the search context.
12596 With optional argument SIBLINGS, on each level of the hierarchy all
12597 siblings are shown. This repairs the tree structure to what it would
12598 look like when opened with hierarchical calls to `org-cycle'.
12600 go to the parent and show the
12601 entire tree."
12602 (interactive "P")
12603 (run-hooks 'org-reveal-start-hook)
12604 (let ((org-show-hierarchy-above t)
12605 (org-show-following-heading t)
12606 (org-show-siblings (if siblings t org-show-siblings)))
12607 (org-show-context nil))
12608 (when (equal siblings '(16))
12609 (save-excursion
12610 (when (org-up-heading-safe)
12611 (org-show-subtree)
12612 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12614 (defun org-highlight-new-match (beg end)
12615 "Highlight from BEG to END and mark the highlight is an occur headline."
12616 (let ((ov (make-overlay beg end)))
12617 (overlay-put ov 'face 'secondary-selection)
12618 (overlay-put ov 'org-type 'org-occur)
12619 (push ov org-occur-highlights)))
12621 (defun org-remove-occur-highlights (&optional beg end noremove)
12622 "Remove the occur highlights from the buffer.
12623 BEG and END are ignored. If NOREMOVE is nil, remove this function
12624 from the `before-change-functions' in the current buffer."
12625 (interactive)
12626 (unless org-inhibit-highlight-removal
12627 (mapc 'delete-overlay org-occur-highlights)
12628 (setq org-occur-highlights nil)
12629 (setq org-occur-parameters nil)
12630 (unless noremove
12631 (remove-hook 'before-change-functions
12632 'org-remove-occur-highlights 'local))))
12634 ;;;; Priorities
12637 "Regular expression matching the priority indicator.")
12639 (defvar org-remove-priority-next-time nil)
12641 (defun org-priority-up ()
12642 "Increase the priority of the current item."
12643 (interactive)
12644 (org-priority 'up))
12646 (defun org-priority-down ()
12647 "Decrease the priority of the current item."
12648 (interactive)
12649 (org-priority 'down))
12651 (defun org-priority (&optional action)
12652 "Change the priority of an item by ARG.
12653 ACTION can be `set', `up', `down', or a character."
12654 (interactive)
12655 (unless org-enable-priority-commands
12656 (error "Priority commands are disabled"))
12657 (setq action (or action 'set))
12658 (let (current new news have remove)
12659 (save-excursion
12660 (org-back-to-heading t)
12661 (if (looking-at org-priority-regexp)
12662 (setq current (string-to-char (match-string 2))
12663 have t))
12664 (cond
12665 ((eq action 'remove)
12666 (setq remove t new ?\ ))
12667 ((or (eq action 'set)
12668 (if (featurep 'xemacs) (characterp action) (integerp action)))
12669 (if (not (eq action 'set))
12670 (setq new action)
12671 (message "Priority %c-%c, SPC to remove: "
12672 org-highest-priority org-lowest-priority)
12673 (save-match-data
12674 (setq new (read-char-exclusive))))
12675 (if (and (= (upcase org-highest-priority) org-highest-priority)
12676 (= (upcase org-lowest-priority) org-lowest-priority))
12677 (setq new (upcase new)))
12678 (cond ((equal new ?\ ) (setq remove t))
12679 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12680 (error "Priority must be between `%c' and `%c'"
12681 org-highest-priority org-lowest-priority))))
12682 ((eq action 'up)
12683 (setq new (if have
12684 (1- current) ; normal cycling
12685 ;; last priority was empty
12686 (if (eq last-command this-command)
12687 org-lowest-priority ; wrap around empty to lowest
12688 ;; default
12689 (if org-priority-start-cycle-with-default
12690 org-default-priority
12691 (1- org-default-priority))))))
12692 ((eq action 'down)
12693 (setq new (if have
12694 (1+ current) ; normal cycling
12695 ;; last priority was empty
12696 (if (eq last-command this-command)
12697 org-highest-priority ; wrap around empty to highest
12698 ;; default
12699 (if org-priority-start-cycle-with-default
12700 org-default-priority
12701 (1+ org-default-priority))))))
12702 (t (error "Invalid action")))
12703 (if (or (< (upcase new) org-highest-priority)
12704 (> (upcase new) org-lowest-priority))
12705 (if (and (memq action '(up down))
12706 (not have) (not (eq last-command this-command)))
12707 ;; `new' is from default priority
12708 (error
12709 "The default can not be set, see `org-default-priority' why")
12710 ;; normal cycling: `new' is beyond highest/lowest priority
12711 ;; and is wrapped around to the empty priority
12712 (setq remove t)))
12713 (setq news (format "%c" new))
12714 (if have
12715 (if remove
12716 (replace-match "" t t nil 1)
12717 (replace-match news t t nil 2))
12718 (if remove
12719 (error "No priority cookie found in line")
12720 (let ((case-fold-search nil))
12721 (looking-at org-todo-line-regexp))
12722 (if (match-end 2)
12723 (progn
12724 (goto-char (match-end 2))
12725 (insert " [#" news "]"))
12726 (goto-char (match-beginning 3))
12727 (insert "[#" news "] "))))
12728 (org-preserve-lc (org-set-tags nil 'align)))
12729 (if remove
12730 (message "Priority removed")
12731 (message "Priority of current item set to %s" news))))
12733 (defun org-get-priority (s)
12734 "Find priority cookie and return priority."
12735 (if (functionp org-get-priority-function)
12736 (funcall org-get-priority-function)
12737 (save-match-data
12738 (if (not (string-match org-priority-regexp s))
12739 (* 1000 (- org-lowest-priority org-default-priority))
12740 (* 1000 (- org-lowest-priority
12741 (string-to-char (match-string 2 s))))))))
12743 ;;;; Tags
12745 (defvar org-agenda-archives-mode)
12746 (defvar org-map-continue-from nil
12747 "Position from where mapping should continue.
12748 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
12750 (defvar org-scanner-tags nil
12751 "The current tag list while the tags scanner is running.")
12752 (defvar org-trust-scanner-tags nil
12753 "Should `org-get-tags-at' use the tags for the scanner.
12754 This is for internal dynamical scoping only.
12755 When this is non-nil, the function `org-get-tags-at' will return the value
12756 of `org-scanner-tags' instead of building the list by itself. This
12757 can lead to large speed-ups when the tags scanner is used in a file with
12758 many entries, and when the list of tags is retrieved, for example to
12759 obtain a list of properties. Building the tags list for each entry in such
12760 a file becomes an N^2 operation - but with this variable set, it scales
12761 as N.")
12763 (defun org-scan-tags (action matcher &optional todo-only start-level)
12764 "Scan headline tags with inheritance and produce output ACTION.
12766 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12767 or `agenda' to produce an entry list for an agenda view. It can also be
12768 a Lisp form or a function that should be called at each matched headline, in
12769 this case the return value is a list of all return values from these calls.
12771 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12772 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12773 only lines with a TODO keyword are included in the output.
12775 START-LEVEL can be a string with asterisks, reducing the scope to
12776 headlines matching this string."
12777 (require 'org-agenda)
12778 (let* ((re (concat "^"
12779 (if start-level
12780 ;; Get the correct level to match
12782 org-outline-regexp)
12785 (org-re
12787 (props (list 'face 'default
12788 'done-face 'org-agenda-done
12789 'undone-face 'default
12790 'mouse-face 'highlight
12791 'org-not-done-regexp org-not-done-regexp
12792 'org-todo-regexp org-todo-regexp
12793 'org-complex-heading-regexp org-complex-heading-regexp
12794 'help-echo
12795 (format "mouse-2 or RET jump to org file %s"
12796 (abbreviate-file-name
12797 (or (buffer-file-name (buffer-base-buffer))
12798 (buffer-name (buffer-base-buffer)))))))
12799 (case-fold-search nil)
12800 (org-map-continue-from nil)
12801 lspos tags tags-list
12802 (tags-alist (list (cons 0 org-file-tags)))
12803 (llast 0) rtn rtn1 level category i txt
12804 todo marker entry priority)
12805 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12806 (setq action (list 'lambda nil action)))
12807 (save-excursion
12808 (goto-char (point-min))
12809 (when (eq action 'sparse-tree)
12810 (org-overview)
12811 (org-remove-occur-highlights))
12812 (while (re-search-forward re nil t)
12813 (setq org-map-continue-from nil)
12814 (catch :skip
12815 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12816 tags (if (match-end 4) (org-match-string-no-properties 4)))
12817 (goto-char (setq lspos (match-beginning 0)))
12818 (setq level (org-reduced-level (funcall outline-level))
12819 category (org-get-category))
12820 (setq i llast llast level)
12821 ;; remove tag lists from same and sublevels
12822 (while (>= i level)
12823 (when (setq entry (assoc i tags-alist))
12824 (setq tags-alist (delete entry tags-alist)))
12825 (setq i (1- i)))
12826 ;; add the next tags
12827 (when tags
12828 (setq tags (org-split-string tags ":")
12829 tags-alist
12830 (cons (cons level tags) tags-alist)))
12831 ;; compile tags for current headline
12832 (setq tags-list
12833 (if org-use-tag-inheritance
12834 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12835 tags)
12836 org-scanner-tags tags-list)
12837 (when org-use-tag-inheritance
12838 (setcdr (car tags-alist)
12839 (mapcar (lambda (x)
12840 (setq x (copy-sequence x))
12841 (org-add-prop-inherited x))
12842 (cdar tags-alist))))
12843 (when (and tags org-use-tag-inheritance
12844 (or (not (eq t org-use-tag-inheritance))
12845 org-tags-exclude-from-inheritance))
12846 ;; selective inheritance, remove uninherited ones
12847 (setcdr (car tags-alist)
12848 (org-remove-uninherited-tags (cdar tags-alist))))
12849 (when (and
12851 ;; eval matcher only when the todo condition is OK
12852 (and (or (not todo-only) (member todo org-not-done-keywords))
12853 (let ((case-fold-search t)) (eval matcher)))
12855 ;; Call the skipper, but return t if it does not skip,
12856 ;; so that the `and' form continues evaluating
12857 (progn
12858 (unless (eq action 'sparse-tree) (org-agenda-skip))
12859 t)
12861 ;; Check if timestamps are deselecting this entry
12862 (or (not todo-only)
12863 (and (member todo org-not-done-keywords)
12864 (or (not org-agenda-tags-todo-honor-ignore-options)
12865 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12867 ;; Extra check for the archive tag
12868 ;; FIXME: Does the skipper already do this????
12869 (or
12870 (not (member org-archive-tag tags-list))
12871 ;; we have an archive tag, should we use this anyway?
12872 (or (not org-agenda-skip-archived-trees)
12873 (and (eq action 'agenda) org-agenda-archives-mode))))
12875 ;; select this headline
12877 (cond
12878 ((eq action 'sparse-tree)
12879 (and org-highlight-sparse-tree-matches
12880 (org-get-heading) (match-end 0)
12881 (org-highlight-new-match
12882 (match-beginning 1) (match-end 1)))
12883 (org-show-context 'tags-tree))
12884 ((eq action 'agenda)
12885 (setq txt (org-agenda-format-item
12886 ""
12887 (concat
12888 (if (eq org-tags-match-list-sublevels 'indented)
12889 (make-string (1- level) ?.) "")
12890 (org-get-heading))
12891 category
12892 tags-list
12893 )
12894 priority (org-get-priority txt))
12895 (goto-char lspos)
12896 (setq marker (org-agenda-new-marker))
12897 (org-add-props txt props
12898 'org-marker marker 'org-hd-marker marker 'org-category category
12899 'todo-state todo
12900 'priority priority 'type "tagsmatch")
12901 (push txt rtn))
12902 ((functionp action)
12903 (setq org-map-continue-from nil)
12904 (save-excursion
12905 (setq rtn1 (funcall action))
12906 (push rtn1 rtn)))
12907 (t (error "Invalid action")))
12909 ;; if we are to skip sublevels, jump to end of subtree
12910 (unless org-tags-match-list-sublevels
12911 (org-end-of-subtree t)
12912 (backward-char 1))))
12913 ;; Get the correct position from where to continue
12914 (if org-map-continue-from
12915 (goto-char org-map-continue-from)
12916 (and (= (point) lspos) (end-of-line 1)))))
12917 (when (and (eq action 'sparse-tree)
12918 (not org-sparse-tree-open-archived-trees))
12919 (org-hide-archived-subtrees (point-min) (point-max)))
12920 (nreverse rtn)))
12922 (defun org-remove-uninherited-tags (tags)
12923 "Remove all tags that are not inherited from the list TAGS."
12924 (cond
12925 ((eq org-use-tag-inheritance t)
12926 (if org-tags-exclude-from-inheritance
12927 (org-delete-all org-tags-exclude-from-inheritance tags)
12928 tags))
12929 ((not org-use-tag-inheritance) nil)
12930 ((stringp org-use-tag-inheritance)
12931 (delq nil (mapcar
12932 (lambda (x)
12933 (if (and (string-match org-use-tag-inheritance x)
12934 (not (member x org-tags-exclude-from-inheritance)))
12935 x nil))
12936 tags)))
12937 ((listp org-use-tag-inheritance)
12938 (delq nil (mapcar
12939 (lambda (x)
12940 (if (member x org-use-tag-inheritance) x nil))
12941 tags)))))
12943 (defvar todo-only) ;; dynamically scoped
12945 (defun org-match-sparse-tree (&optional todo-only match)
12946 "Create a sparse tree according to tags string MATCH.
12947 MATCH can contain positive and negative selection of tags, like
12949 If optional argument TODO-ONLY is non-nil, only select lines that are
12950 also TODO lines."
12951 (interactive "P")
12952 (org-prepare-agenda-buffers (list (current-buffer)))
12953 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12955 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12957 (defvar org-cached-props nil)
12958 (defun org-cached-entry-get (pom property)
12959 (if (or (eq t org-use-property-inheritance)
12960 (and (stringp org-use-property-inheritance)
12961 (string-match org-use-property-inheritance property))
12962 (and (listp org-use-property-inheritance)
12963 (member property org-use-property-inheritance)))
12964 ;; Caching is not possible, check it directly
12965 (org-entry-get pom property 'inherit)
12966 ;; Get all properties, so that we can do complicated checks easily
12967 (cdr (assoc property (or org-cached-props
12968 (setq org-cached-props
12969 (org-entry-properties pom)))))))
12971 (defun org-global-tags-completion-table (&optional files)
12972 "Return the list of all tags in all agenda buffer/files.
12973 Optional FILES argument is a list of files to which can be used
12974 instead of the agenda files."
12975 (save-excursion
12976 (org-uniquify
12977 (delq nil
12978 (apply 'append
12979 (mapcar
12980 (lambda (file)
12981 (set-buffer (find-file-noselect file))
12982 (append (org-get-buffer-tags)
12983 (mapcar (lambda (x) (if (stringp (car-safe x))
12984 (list (car-safe x)) nil))
12985 org-tag-alist)))
12986 (if (and files (car files))
12987 files
12988 (org-agenda-files))))))))
12990 (defun org-make-tags-matcher (match)
12991 "Create the TAGS/TODO matcher form for the selection string MATCH."
12992 ;; todo-only is scoped dynamically into this function, and the function
12993 ;; may change it if the matcher asks for it.
12994 (unless match
12995 ;; Get a new match request, with completion
12996 (let ((org-last-tags-completion-table
12997 (org-global-tags-completion-table)))
12998 (setq match (org-completing-read-no-i
12999 "Match: " 'org-tags-completion-function nil nil nil
13000 'org-tags-history))))
13002 ;; Parse the string and create a lisp form
13003 (let ((match0 match)
13004 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13005 minus tag mm
13006 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13007 orterms term orlist re-p str-p level-p level-op time-p
13008 prop-p pn pv po gv rest)
13009 (if (string-match "/+" match)
13010 ;; match contains also a todo-matching request
13011 (progn
13012 (setq tagsmatch (substring match 0 (match-beginning 0))
13013 todomatch (substring match (match-end 0)))
13014 (if (string-match "^!" todomatch)
13015 (setq todo-only t todomatch (substring todomatch 1)))
13017 (setq todomatch nil)))
13018 ;; only matching tags
13019 (setq tagsmatch match todomatch nil))
13021 ;; Make the tags matcher
13023 (setq tagsmatcher t)
13024 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13025 (while (setq term (pop orterms))
13027 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13028 (while (string-match re term)
13029 (setq rest (substring term (match-end 0))
13030 minus (and (match-end 1)
13031 (equal (match-string 1 term) "-"))
13032 tag (save-match-data (replace-regexp-in-string
13034 (match-string 2 term)))
13035 re-p (equal (string-to-char tag) ?{)
13036 level-p (match-end 4)
13037 prop-p (match-end 5)
13038 mm (cond
13039 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13040 (level-p
13041 (setq level-op (org-op-to-function (match-string 3 term)))
13042 `(,level-op level ,(string-to-number
13043 (match-string 4 term))))
13044 (prop-p
13045 (setq pn (match-string 5 term)
13046 po (match-string 6 term)
13047 pv (match-string 7 term)
13048 re-p (equal (string-to-char pv) ?{)
13050 time-p (save-match-data
13052 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13053 (if time-p (setq pv (org-matcher-time pv)))
13054 (setq po (org-op-to-function po (if time-p 'time str-p)))
13055 (cond
13056 ((equal pn "CATEGORY")
13057 (setq gv '(get-text-property (point) 'org-category)))
13058 ((equal pn "TODO")
13059 (setq gv 'todo))
13060 (t
13061 (setq gv `(org-cached-entry-get nil ,pn))))
13062 (if re-p
13063 (if (eq po 'org<>)
13064 `(not (string-match ,pv (or ,gv "")))
13065 `(string-match ,pv (or ,gv "")))
13066 (if str-p
13067 `(,po (or ,gv "") ,pv)
13068 `(,po (string-to-number (or ,gv ""))
13069 ,(string-to-number pv) ))))
13070 (t `(member ,tag tags-list)))
13071 mm (if minus (list 'not mm) mm)
13072 term rest)
13073 (push mm tagsmatcher))
13074 (push (if (> (length tagsmatcher) 1)
13075 (cons 'and tagsmatcher)
13076 (car tagsmatcher))
13077 orlist)
13078 (setq tagsmatcher nil))
13079 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13080 (setq tagsmatcher
13081 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13082 ;; Make the todo matcher
13084 (setq todomatcher t)
13085 (setq orterms (org-split-string todomatch "|") orlist nil)
13086 (while (setq term (pop orterms))
13087 (while (string-match re term)
13088 (setq minus (and (match-end 1)
13089 (equal (match-string 1 term) "-"))
13090 kwd (match-string 2 term)
13091 re-p (equal (string-to-char kwd) ?{)
13092 term (substring term (match-end 0))
13093 mm (if re-p
13094 `(string-match ,(substring kwd 1 -1) todo)
13095 (list 'equal 'todo kwd))
13096 mm (if minus (list 'not mm) mm))
13097 (push mm todomatcher))
13098 (push (if (> (length todomatcher) 1)
13099 (cons 'and todomatcher)
13100 (car todomatcher))
13101 orlist)
13102 (setq todomatcher nil))
13103 (setq todomatcher (if (> (length orlist) 1)
13104 (cons 'or orlist) (car orlist))))
13106 ;; Return the string and lisp forms of the matcher
13107 (setq matcher (if todomatcher
13108 (list 'and tagsmatcher todomatcher)
13109 tagsmatcher))
13110 (cons match0 matcher)))
13112 (defun org-op-to-function (op &optional stringp)
13113 "Turn an operator into the appropriate function."
13114 (setq op
13115 (cond
13116 ((equal op "<" ) '(< string< org-time<))
13117 ((equal op ">" ) '(> org-string> org-time>))
13118 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13119 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13120 ((member op '("=" "==")) '(= string= org-time=))
13121 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13122 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13124 (defun org<> (a b) (not (= a b)))
13125 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13126 (defun org-string>= (a b) (not (string< a b)))
13127 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13128 (defun org-string<> (a b) (not (string= a b)))
13129 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13130 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13131 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13132 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13133 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13134 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13135 (defun org-2ft (s)
13136 "Convert S to a floating point time.
13137 If S is already a number, just return it. If it is a string, parse
13138 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13139 (cond
13140 ((numberp s) s)
13141 ((stringp s)
13142 (condition-case nil
13143 (float-time (apply 'encode-time (org-parse-time-string s)))
13144 (error 0.)))
13145 (t 0.)))
13147 (defun org-time-today ()
13148 "Time in seconds today at 0:00.
13149 Returns the float number of seconds since the beginning of the
13150 epoch to the beginning of today (00:00)."
13151 (float-time (apply 'encode-time
13152 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13154 (defun org-matcher-time (s)
13155 "Interpret a time comparison value."
13156 (save-match-data
13157 (cond
13158 ((string= s "<now>") (float-time))
13159 ((string= s "<today>") (org-time-today))
13160 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13161 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13163 (+ (org-time-today)
13164 (* (string-to-number (match-string 1 s))
13165 (cdr (assoc (match-string 2 s)
13166 '(("d" . 86400.0) ("w" . 604800.0)
13167 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13168 (t (org-2ft s)))))
13170 (defun org-match-any-p (re list)
13171 "Does re match any element of list?"
13172 (setq list (mapcar (lambda (x) (string-match re x)) list))
13173 (delq nil list))
13175 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13176 (defvar org-tags-overlay (make-overlay 1 1))
13177 (org-detach-overlay org-tags-overlay)
13179 (defun org-get-local-tags-at (&optional pos)
13180 "Get a list of tags defined in the current headline."
13181 (org-get-tags-at pos 'local))
13183 (defun org-get-local-tags ()
13184 "Get a list of tags defined in the current headline."
13185 (org-get-tags-at nil 'local))
13187 (defun org-get-tags-at (&optional pos local)
13188 "Get a list of all headline tags applicable at POS.
13189 POS defaults to point. If tags are inherited, the list contains
13190 the targets in the same sequence as the headlines appear, i.e.
13191 the tags of the current headline come last.
13192 When LOCAL is non-nil, only return tags from the current headline,
13193 ignore inherited ones."
13194 (interactive)
13195 (if (and org-trust-scanner-tags
13196 (or (not pos) (equal pos (point)))
13197 (not local))
13198 org-scanner-tags
13199 (let (tags ltags lastpos parent)
13200 (save-excursion
13201 (save-restriction
13202 (widen)
13203 (goto-char (or pos (point)))
13204 (save-match-data
13205 (catch 'done
13206 (condition-case nil
13207 (progn
13208 (org-back-to-heading t)
13209 (while (not (equal lastpos (point)))
13210 (setq lastpos (point))
13211 (when (looking-at
13213 (setq ltags (org-split-string
13214 (org-match-string-no-properties 1) ":"))
13215 (when parent
13216 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13217 (setq tags (append
13218 (if parent
13219 (org-remove-uninherited-tags ltags)
13220 ltags)
13221 tags)))
13222 (or org-use-tag-inheritance (throw 'done t))
13223 (if local (throw 'done t))
13224 (or (org-up-heading-safe) (error nil))
13225 (setq parent t)))
13226 (error nil)))))
13227 (if local
13228 tags
13229 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13231 (defun org-add-prop-inherited (s)
13232 (add-text-properties 0 (length s) '(inherited t) s)
13233 s)
13235 (defun org-toggle-tag (tag &optional onoff)
13236 "Toggle the tag TAG for the current line.
13237 If ONOFF is `on' or `off', don't toggle but set to this state."
13238 (let (res current)
13239 (save-excursion
13240 (org-back-to-heading t)
13242 (point-at-eol) t)
13243 (progn
13244 (setq current (match-string 1))
13245 (replace-match ""))
13246 (setq current ""))
13247 (setq current (nreverse (org-split-string current ":")))
13248 (cond
13249 ((eq onoff 'on)
13250 (setq res t)
13251 (or (member tag current) (push tag current)))
13252 ((eq onoff 'off)
13253 (or (not (member tag current)) (setq current (delete tag current))))
13254 (t (if (member tag current)
13255 (setq current (delete tag current))
13256 (setq res t)
13257 (push tag current))))
13258 (end-of-line 1)
13259 (if current
13260 (progn
13261 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13262 (org-set-tags nil t))
13263 (delete-horizontal-space))
13264 (run-hooks 'org-after-tags-change-hook))
13265 res))
13267 (defun org-align-tags-here (to-col)
13268 ;; Assumes that this is a headline
13269 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13270 (beginning-of-line 1)
13272 (< pos (match-beginning 2)))
13273 (progn
13274 (setq tags-l (- (match-end 2) (match-beginning 2)))
13275 (goto-char (match-beginning 1))
13276 (insert " ")
13277 (delete-region (point) (1+ (match-beginning 2)))
13278 (setq ncol (max (current-column)
13279 (1+ col)
13280 (if (> to-col 0)
13281 to-col
13282 (- (abs to-col) tags-l))))
13283 (setq p (point))
13284 (insert (make-string (- ncol (current-column)) ?\ ))
13285 (setq ncol (current-column))
13286 (when indent-tabs-mode (tabify p (point-at-eol)))
13287 (org-move-to-column (min ncol col) t))
13288 (goto-char pos))))
13290 (defun org-set-tags-command (&optional arg just-align)
13291 "Call the set-tags command for the current entry."
13292 (interactive "P")
13293 (if (org-at-heading-p)
13294 (org-set-tags arg just-align)
13295 (save-excursion
13296 (org-back-to-heading t)
13297 (org-set-tags arg just-align))))
13299 (defun org-set-tags-to (data)
13300 "Set the tags of the current entry to DATA, replacing the current tags.
13301 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13302 If DATA is nil or the empty string, any tags will be removed."
13303 (interactive "sTags: ")
13304 (setq data
13305 (cond
13306 ((eq data nil) "")
13307 ((equal data "") "")
13308 ((stringp data)
13309 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13310 ":"))
13311 ((listp data)
13312 (concat ":" (mapconcat 'identity data ":") ":"))
13313 (t nil)))
13314 (when data
13315 (save-excursion
13316 (org-back-to-heading t)
13317 (when (looking-at org-complex-heading-regexp)
13318 (if (match-end 5)
13319 (progn
13320 (goto-char (match-beginning 5))
13321 (insert data)
13322 (delete-region (point) (point-at-eol))
13323 (org-set-tags nil 'align))
13324 (goto-char (point-at-eol))
13325 (insert " " data)
13326 (org-set-tags nil 'align)))
13327 (beginning-of-line 1)
13329 (delete-region (match-beginning 1) (match-end 1))))))
13331 (defun org-align-all-tags ()
13332 "Align the tags i all headings."
13333 (interactive)
13334 (save-excursion
13335 (or (ignore-errors (org-back-to-heading t))
13336 (outline-next-heading))
13337 (if (org-at-heading-p)
13338 (org-set-tags t)
13339 (message "No headings"))))
13341 (defvar org-indent-indentation-per-level)
13342 (defun org-set-tags (&optional arg just-align)
13343 "Set the tags for the current headline.
13344 With prefix ARG, realign all tags in headings in the current buffer."
13345 (interactive "P")
13346 (let* ((re org-outline-regexp-bol)
13347 (current (org-get-tags-string))
13348 (col (current-column))
13349 (org-setting-tags t)
13350 table current-tags inherited-tags ; computed below when needed
13351 tags p0 c0 c1 rpl di tc level)
13352 (if arg
13353 (save-excursion
13354 (goto-char (point-min))
13355 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13356 (while (re-search-forward re nil t)
13357 (org-set-tags nil t)
13358 (end-of-line 1)))
13359 (message "All tags realigned to column %d" org-tags-column))
13360 (if just-align
13361 (setq tags current)
13362 ;; Get a new set of tags from the user
13363 (save-excursion
13364 (setq table (append org-tag-persistent-alist
13365 (or org-tag-alist (org-get-buffer-tags))
13366 (and
13367 org-complete-tags-always-offer-all-agenda-tags
13368 (org-global-tags-completion-table
13369 (org-agenda-files))))
13370 org-last-tags-completion-table table
13371 current-tags (org-split-string current ":")
13372 inherited-tags (nreverse
13373 (nthcdr (length current-tags)
13374 (nreverse (org-get-tags-at))))
13375 tags
13376 (if (or (eq t org-use-fast-tag-selection)
13377 (and org-use-fast-tag-selection
13378 (delq nil (mapcar 'cdr table))))
13379 (org-fast-tag-selection
13380 current-tags inherited-tags table
13381 (if org-fast-tag-selection-include-todo
13382 org-todo-key-alist))
13383 (let ((org-add-colon-after-tag-completion t))
13384 (org-trim
13385 (org-icompleting-read "Tags: "
13386 'org-tags-completion-function
13387 nil nil current 'org-tags-history))))))
13388 (while (string-match "[-+&]+" tags)
13389 ;; No boolean logic, just a list
13390 (setq tags (replace-match ":" t t tags))))
13392 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13394 (if org-tags-sort-function
13395 (setq tags (mapconcat 'identity
13396 (sort (org-split-string
13397 tags (org-re "[^[:alnum:]_@#%]+"))
13398 org-tags-sort-function) ":")))
13401 (setq tags "")
13402 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13403 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13405 ;; Insert new tags at the correct column
13406 (beginning-of-line 1)
13407 (setq level (or (and (looking-at org-outline-regexp)
13408 (- (match-end 0) (point) 1))
13409 1))
13410 (cond
13411 ((and (equal current "") (equal tags "")))
13412 ((re-search-forward
13414 (point-at-eol) t)
13415 (if (equal tags "")
13416 (setq rpl "")
13417 (goto-char (match-beginning 0))
13418 (setq c0 (current-column)
13419 ;; compute offset for the case of org-indent-mode active
13420 di (if org-indent-mode
13421 (* (1- org-indent-indentation-per-level) (1- level))
13422 0)
13423 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13424 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13425 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13426 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13427 (replace-match rpl t t)
13428 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13429 tags)
13430 (t (error "Tags alignment failed")))
13431 (org-move-to-column col)
13432 (unless just-align
13433 (run-hooks 'org-after-tags-change-hook)))))
13435 (defun org-change-tag-in-region (beg end tag off)
13436 "Add or remove TAG for each entry in the region.
13437 This works in the agenda, and also in an org-mode buffer."
13438 (interactive
13439 (list (region-beginning) (region-end)
13440 (let ((org-last-tags-completion-table
13441 (if (eq major-mode 'org-mode)
13442 (org-get-buffer-tags)
13443 (org-global-tags-completion-table))))
13444 (org-icompleting-read
13445 "Tag: " 'org-tags-completion-function nil nil nil
13446 'org-tags-history))
13447 (progn
13449 (equal (read-char-exclusive) ?r))))
13450 (if (fboundp 'deactivate-mark) (deactivate-mark))
13451 (let ((agendap (equal major-mode 'org-agenda-mode))
13452 l1 l2 m buf pos newhead (cnt 0))
13453 (goto-char end)
13454 (setq l2 (1- (org-current-line)))
13455 (goto-char beg)
13456 (setq l1 (org-current-line))
13457 (loop for l from l1 to l2 do
13458 (org-goto-line l)
13459 (setq m (get-text-property (point) 'org-hd-marker))
13460 (when (or (and (eq major-mode 'org-mode) (org-at-heading-p))
13461 (and agendap m))
13462 (setq buf (if agendap (marker-buffer m) (current-buffer))
13463 pos (if agendap m (point)))
13464 (with-current-buffer buf
13465 (save-excursion
13466 (save-restriction
13467 (goto-char pos)
13468 (setq cnt (1+ cnt))
13469 (org-toggle-tag tag (if off 'off 'on))
13470 (setq newhead (org-get-heading)))))
13471 (and agendap (org-agenda-change-all-lines newhead m))))
13472 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13474 (defun org-tags-completion-function (string predicate &optional flag)
13475 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13476 (confirm (lambda (x) (stringp (car x)))))
13478 (setq s1 (match-string 1 string)
13479 s2 (match-string 2 string))
13480 (setq s1 "" s2 string))
13481 (cond
13482 ((eq flag nil)
13483 ;; try completion
13484 (setq rtn (try-completion s2 ctable confirm))
13485 (if (stringp rtn)
13486 (setq rtn
13487 (concat s1 s2 (substring rtn (length s2))
13488 (if (and org-add-colon-after-tag-completion
13489 (assoc rtn ctable))
13490 ":" ""))))
13491 rtn)
13492 ((eq flag t)
13493 ;; all-completions
13494 (all-completions s2 ctable confirm)
13495 )
13496 ((eq flag 'lambda)
13497 ;; exact match?
13498 (assoc s2 ctable)))
13499 ))
13501 (defun org-fast-tag-insert (kwd tags face &optional end)
13502 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13503 (insert (format "%-12s" (concat kwd ":"))
13504 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13505 (or end "")))
13507 (defun org-fast-tag-show-exit (flag)
13508 (save-excursion
13509 (org-goto-line 3)
13511 (replace-match ""))
13512 (when flag
13513 (end-of-line 1)
13514 (org-move-to-column (- (window-width) 19) t)
13515 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13517 (defun org-set-current-tags-overlay (current prefix)
13518 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13519 (if (featurep 'xemacs)
13520 (org-overlay-display org-tags-overlay (concat prefix s)
13521 'secondary-selection)
13522 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13523 (org-overlay-display org-tags-overlay (concat prefix s)))))
13525 (defvar org-last-tag-selection-key nil)
13526 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13527 "Fast tag selection with single keys.
13528 CURRENT is the current list of tags in the headline, INHERITED is the
13529 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13530 possibly with grouping information. TODO-TABLE is a similar table with
13531 TODO keywords, should these have keys assigned to them.
13532 If the keys are nil, a-z are automatically assigned.
13533 Returns the new tags string, or nil to not change the current settings."
13534 (let* ((fulltable (append table todo-table))
13535 (maxlen (apply 'max (mapcar
13536 (lambda (x)
13537 (if (stringp (car x)) (string-width (car x)) 0))
13538 fulltable)))
13539 (buf (current-buffer))
13540 (expert (eq org-fast-tag-selection-single-key 'expert))
13541 (buffer-tags nil)
13542 (fwidth (+ maxlen 3 1 3))
13543 (ncol (/ (- (window-width) 4) fwidth))
13544 (i-face 'org-done)
13545 (c-face 'org-todo)
13546 tg cnt e c char c1 c2 ntable tbl rtn
13547 ov-start ov-end ov-prefix
13548 (exit-after-next org-fast-tag-selection-single-key)
13549 (done-keywords org-done-keywords)
13550 groups ingroup)
13551 (save-excursion
13552 (beginning-of-line 1)
13553 (if (looking-at
13555 (setq ov-start (match-beginning 1)
13556 ov-end (match-end 1)
13557 ov-prefix "")
13558 (setq ov-start (1- (point-at-eol))
13559 ov-end (1+ ov-start))
13561 (setq ov-prefix
13562 (concat
13563 (buffer-substring (1- (point)) (point))
13564 (if (> (current-column) org-tags-column)
13565 " "
13566 (make-string (- org-tags-column (current-column)) ?\ ))))))
13567 (move-overlay org-tags-overlay ov-start ov-end)
13568 (save-window-excursion
13569 (if expert
13570 (set-buffer (get-buffer-create " *Org tags*"))
13571 (delete-other-windows)
13572 (split-window-vertically)
13573 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13574 (erase-buffer)
13575 (org-set-local 'org-done-keywords done-keywords)
13578 (org-fast-tag-show-exit exit-after-next)
13579 (org-set-current-tags-overlay current ov-prefix)
13580 (setq tbl fulltable char ?a cnt 0)
13581 (while (setq e (pop tbl))
13582 (cond
13583 ((equal (car e) :startgroup)
13584 (push '() groups) (setq ingroup t)
13585 (when (not (= cnt 0))
13586 (setq cnt 0)
13588 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13589 ((equal (car e) :endgroup)
13590 (setq ingroup nil cnt 0)
13592 ((equal e '(:newline))
13593 (when (not (= cnt 0))
13594 (setq cnt 0)
13596 (setq e (car tbl))
13597 (while (equal (car tbl) '(:newline))
13599 (setq tbl (cdr tbl)))))
13600 (t
13601 (setq tg (copy-sequence (car e)) c2 nil)
13602 (if (cdr e)
13603 (setq c (cdr e))
13604 ;; automatically assign a character.
13605 (setq c1 (string-to-char
13606 (downcase (substring
13607 tg (if (= (string-to-char tg) ?@) 1 0)))))
13608 (if (or (rassoc c1 ntable) (rassoc c1 table))
13609 (while (or (rassoc char ntable) (rassoc char table))
13610 (setq char (1+ char)))
13611 (setq c2 c1))
13612 (setq c (or c2 char)))
13613 (if ingroup (push tg (car groups)))
13614 (setq tg (org-add-props tg nil 'face
13615 (cond
13616 ((not (assoc tg table))
13617 (org-get-todo-face tg))
13618 ((member tg current) c-face)
13619 ((member tg inherited) i-face)
13620 (t nil))))
13621 (if (and (= cnt 0) (not ingroup)) (insert " "))
13622 (insert "[" c "] " tg (make-string
13623 (- fwidth 4 (length tg)) ?\ ))
13624 (push (cons tg c) ntable)
13625 (when (= (setq cnt (1+ cnt)) ncol)
13627 (if ingroup (insert " "))
13628 (setq cnt 0)))))
13629 (setq ntable (nreverse ntable))
13631 (goto-char (point-min))
13632 (if (not expert) (org-fit-window-to-buffer))
13633 (setq rtn
13634 (catch 'exit
13635 (while t
13636 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13637 (if (not groups) "no " "")
13638 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13639 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13640 (setq org-last-tag-selection-key c)
13641 (cond
13643 ((= c ?!)
13644 (setq groups (not groups))
13645 (goto-char (point-min))
13646 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13647 ((= c ?\C-c)
13648 (if (not expert)
13649 (org-fast-tag-show-exit
13650 (setq exit-after-next (not exit-after-next)))
13651 (setq expert nil)
13652 (delete-other-windows)
13653 (set-window-buffer (split-window-vertically) " *Org tags*")
13654 (org-switch-to-buffer-other-window " *Org tags*")
13655 (org-fit-window-to-buffer)))
13656 ((or (= c ?\C-g)
13657 (and (= c ?q) (not (rassoc c ntable))))
13658 (org-detach-overlay org-tags-overlay)
13659 (setq quit-flag t))
13660 ((= c ?\ )
13661 (setq current nil)
13662 (if exit-after-next (setq exit-after-next 'now)))
13664 (condition-case nil
13665 (setq tg (org-icompleting-read
13666 "Tag: "
13667 (or buffer-tags
13668 (with-current-buffer buf
13669 (org-get-buffer-tags)))))
13670 (quit (setq tg "")))
13672 (add-to-list 'buffer-tags (list tg))
13673 (if (member tg current)
13674 (setq current (delete tg current))
13675 (push tg current)))
13676 (if exit-after-next (setq exit-after-next 'now)))
13677 ((setq e (rassoc c todo-table) tg (car e))
13678 (with-current-buffer buf
13679 (save-excursion (org-todo tg)))
13680 (if exit-after-next (setq exit-after-next 'now)))
13681 ((setq e (rassoc c ntable) tg (car e))
13682 (if (member tg current)
13683 (setq current (delete tg current))
13684 (loop for g in groups do
13685 (if (member tg g)
13686 (mapc (lambda (x)
13687 (setq current (delete x current)))
13688 g)))
13689 (push tg current))
13690 (if exit-after-next (setq exit-after-next 'now))))
13692 ;; Create a sorted list
13693 (setq current
13694 (sort current
13695 (lambda (a b)
13696 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13697 (if (eq exit-after-next 'now) (throw 'exit t))
13698 (goto-char (point-min))
13699 (beginning-of-line 2)
13700 (delete-region (point) (point-at-eol))
13701 (org-fast-tag-insert "Current" current c-face)
13702 (org-set-current-tags-overlay current ov-prefix)
13703 (while (re-search-forward
13705 (setq tg (match-string 1))
13706 (add-text-properties
13707 (match-beginning 1) (match-end 1)
13708 (list 'face
13709 (cond
13710 ((member tg current) c-face)
13711 ((member tg inherited) i-face)
13712 (t (get-text-property (match-beginning 1) 'face))))))
13713 (goto-char (point-min)))))
13714 (org-detach-overlay org-tags-overlay)
13715 (if rtn
13716 (mapconcat 'identity current ":")
13717 nil))))
13719 (defun org-get-tags-string ()
13720 "Get the TAGS string in the current headline."
13721 (unless (org-at-heading-p t)
13722 (error "Not on a heading"))
13723 (save-excursion
13724 (beginning-of-line 1)
13726 (org-match-string-no-properties 1)
13727 "")))
13729 (defun org-get-tags ()
13730 "Get the list of tags specified in the current headline."
13731 (org-split-string (org-get-tags-string) ":"))
13733 (defun org-get-buffer-tags ()
13734 "Get a table of all tags used in the buffer, for completion."
13735 (let (tags)
13736 (save-excursion
13737 (goto-char (point-min))
13738 (while (re-search-forward
13740 (when (equal (char-after (point-at-bol 0)) ?*)
13741 (mapc (lambda (x) (add-to-list 'tags x))
13742 (org-split-string (org-match-string-no-properties 1) ":")))))
13743 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13744 (mapcar 'list tags)))
13746 ;;;; The mapping API
13748 ;;;###autoload
13749 (defun org-map-entries (func &optional match scope &rest skip)
13750 "Call FUNC at each headline selected by MATCH in SCOPE.
13752 FUNC is a function or a lisp form. The function will be called without
13753 arguments, with the cursor positioned at the beginning of the headline.
13754 The return values of all calls to the function will be collected and
13755 returned as a list.
13757 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13758 does not need to preserve point. After evaluation, the cursor will be
13759 moved to the end of the line (presumably of the headline of the
13760 processed entry) and search continues from there. Under some
13761 circumstances, this may not produce the wanted results. For example,
13762 if you have removed (e.g. archived) the current (sub)tree it could
13763 mean that the next entry will be skipped entirely. In such cases, you
13764 can specify the position from where search should continue by making
13765 FUNC set the variable `org-map-continue-from' to the desired buffer
13766 position.
13768 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13769 Only headlines that are matched by this query will be considered during
13770 the iteration. When MATCH is nil or t, all headlines will be
13771 visited by the iteration.
13773 SCOPE determines the scope of this command. It can be any of:
13775 nil The current buffer, respecting the restriction if any
13776 tree The subtree started with the entry at point
13777 region The entries within the active region, if any
13778 region-start-level
13779 The entries within the active region, but only those at
13780 the same level than the first one.
13781 file The current buffer, without restriction
13782 file-with-archives
13783 The current buffer, and any archives associated with it
13784 agenda All agenda files
13785 agenda-with-archives
13786 All agenda files with any archive files associated with them
13787 \(file1 file2 ...)
13788 If this is a list, all files in the list will be scanned
13790 The remaining args are treated as settings for the skipping facilities of
13791 the scanner. The following items can be given here:
13793 archive skip trees with the archive tag.
13794 comment skip trees with the COMMENT keyword
13795 function or Emacs Lisp form:
13796 will be used as value for `org-agenda-skip-function', so whenever
13797 the function returns t, FUNC will not be called for that
13798 entry and search will continue from the point where the
13799 function leaves it.
13801 If your function needs to retrieve the tags including inherited tags
13802 at the *current* entry, you can use the value of the variable
13803 `org-scanner-tags' which will be much faster than getting the value
13804 with `org-get-tags-at'. If your function gets properties with
13805 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13806 to t around the call to `org-entry-properties' to get the same speedup.
13807 Note that if your function moves around to retrieve tags and properties at
13808 a *different* entry, you cannot use these techniques."
13809 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
13810 (not (org-region-active-p)))
13811 (let* ((org-agenda-archives-mode nil) ; just to make sure
13812 (org-agenda-skip-archived-trees (memq 'archive skip))
13813 (org-agenda-skip-comment-trees (memq 'comment skip))
13814 (org-agenda-skip-function
13815 (car (org-delete-all '(comment archive) skip)))
13816 (org-tags-match-list-sublevels t)
13817 (start-level (eq scope 'region-start-level))
13818 matcher file res
13819 org-todo-keywords-for-agenda
13820 org-done-keywords-for-agenda
13821 org-todo-keyword-alist-for-agenda
13822 org-drawers-for-agenda
13823 org-tag-alist-for-agenda)
13825 (cond
13826 ((eq match t) (setq matcher t))
13827 ((eq match nil) (setq matcher t))
13828 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13830 (save-excursion
13831 (save-restriction
13832 (cond ((eq scope 'tree)
13833 (org-back-to-heading t)
13834 (org-narrow-to-subtree)
13835 (setq scope nil))
13836 ((and (or (eq scope 'region) (eq scope 'region-start-level))
13837 (org-region-active-p))
13838 ;; If needed, set start-level to a string like "2"
13839 (when start-level
13840 (save-excursion
13841 (goto-char (region-beginning))
13842 (unless (org-at-heading-p) (outline-next-heading))
13843 (setq start-level (org-current-level))))
13844 (narrow-to-region (region-beginning)
13845 (save-excursion
13846 (goto-char (region-end))
13847 (unless (and (bolp) (org-at-heading-p))
13848 (outline-next-heading))
13849 (point)))
13850 (setq scope nil)))
13852 (if (not scope)
13853 (progn
13854 (org-prepare-agenda-buffers
13855 (list (buffer-file-name (current-buffer))))
13856 (setq res (org-scan-tags func matcher nil start-level)))
13857 ;; Get the right scope
13858 (cond
13859 ((and scope (listp scope) (symbolp (car scope)))
13860 (setq scope (eval scope)))
13861 ((eq scope 'agenda)
13862 (setq scope (org-agenda-files t)))
13863 ((eq scope 'agenda-with-archives)
13864 (setq scope (org-agenda-files t))
13865 (setq scope (org-add-archive-files scope)))
13866 ((eq scope 'file)
13867 (setq scope (list (buffer-file-name))))
13868 ((eq scope 'file-with-archives)
13869 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13870 (org-prepare-agenda-buffers scope)
13871 (while (setq file (pop scope))
13872 (with-current-buffer (org-find-base-buffer-visiting file)
13873 (save-excursion
13874 (save-restriction
13875 (widen)
13876 (goto-char (point-min))
13877 (setq res (append res (org-scan-tags func matcher))))))))))
13878 res)))
13880 ;;;; Properties
13882 ;;; Setting and retrieving properties
13884 (defconst org-special-properties
13885 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13886 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13887 "The special properties valid in Org-mode.
13889 These are properties that are not defined in the property drawer,
13890 but in some other way.")
13892 (defconst org-default-properties
13893 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13894 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13895 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13896 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13897 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13898 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13899 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13900 "Some properties that are used by Org-mode for various purposes.
13901 Being in this list makes sure that they are offered for completion.")
13904 "Regular expression matching the first line of a property drawer.")
13907 "Regular expression matching the last line of a property drawer.")
13910 "Regular expression matching the first line of a property drawer.")
13913 "Regular expression matching the first line of a property drawer.")
13915 (defconst org-property-drawer-re
13918 "Matches an entire property drawer.")
13920 (defconst org-clock-drawer-re
13923 "Matches an entire clock drawer.")
13925 (defsubst org-re-property (property)
13926 "Return a regexp matching PROPERTY.
13927 Match group 1 will be set to the value "
13930 (defun org-property-action ()
13931 "Do an action on properties."
13932 (interactive)
13933 (let (c)
13934 (org-at-property-p)
13935 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13936 (setq c (read-char-exclusive))
13937 (cond
13938 ((equal c ?s)
13939 (call-interactively 'org-set-property))
13940 ((equal c ?d)
13941 (call-interactively 'org-delete-property))
13942 ((equal c ?D)
13943 (call-interactively 'org-delete-property-globally))
13944 ((equal c ?c)
13945 (call-interactively 'org-compute-property-at-point))
13946 (t (error "No such property action %c" c)))))
13948 (defun org-set-effort (&optional value)
13949 "Set the effort property of the current entry.
13950 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13951 allowed value."
13952 (interactive "P")
13953 (if (equal value 0) (setq value 10))
13954 (let* ((completion-ignore-case t)
13955 (prop org-effort-property)
13956 (cur (org-entry-get nil prop))
13957 (allowed (org-property-get-allowed-values nil prop 'table))
13958 (existing (mapcar 'list (org-property-values prop)))
13959 rpl
13960 (val (cond
13961 ((stringp value) value)
13962 ((and allowed (integerp value))
13963 (or (car (nth (1- value) allowed))
13964 (car (org-last allowed))))
13965 (allowed
13966 (message "Select 1-9,0, [RET%s]: %s"
13967 (if cur (concat "=" cur) "")
13968 (mapconcat 'car allowed " "))
13969 (setq rpl (read-char-exclusive))
13971 cur
13972 (setq rpl (- rpl ?0))
13973 (if (equal rpl 0) (setq rpl 10))
13974 (if (and (> rpl 0) (<= rpl (length allowed)))
13975 (car (nth (1- rpl) allowed))
13976 (org-completing-read "Effort: " allowed nil))))
13977 (t
13978 (let (org-completion-use-ido org-completion-use-iswitchb)
13979 (org-completing-read
13981 (concat "[" cur "]") "")
13982 ": ")
13983 existing nil nil "" nil cur))))))
13984 (unless (equal (org-entry-get nil prop) val)
13985 (org-entry-put nil prop val))
13986 (message "%s is now %s" prop val)))
13988 (defun org-at-property-p ()
13989 "Is cursor inside a property drawer?"
13990 (save-excursion
13991 (beginning-of-line 1)
13993 (save-match-data ;; Used by calling procedures
13994 (let ((p (point))
13995 (range (unless (org-before-first-heading-p)
13996 (org-get-property-block))))
13997 (and range (<= (car range) p) (< p (cdr range))))))))
13999 (defun org-get-property-block (&optional beg end force)
14000 "Return the (beg . end) range of the body of the property drawer.
14001 BEG and END can be beginning and end of subtree, if not given
14002 they will be found.
14003 If the drawer does not exist and FORCE is non-nil, create the drawer."
14004 (catch 'exit
14005 (save-excursion
14006 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
14007 (end (or end (progn (outline-next-heading) (point)))))
14008 (goto-char beg)
14009 (if (re-search-forward org-property-start-re end t)
14010 (setq beg (1+ (match-end 0)))
14011 (if force
14012 (save-excursion
14013 (org-insert-property-drawer)
14014 (setq end (progn (outline-next-heading) (point))))
14015 (throw 'exit nil))
14016 (goto-char beg)
14017 (if (re-search-forward org-property-start-re end t)
14018 (setq beg (1+ (match-end 0)))))
14019 (if (re-search-forward org-property-end-re end t)
14020 (setq end (match-beginning 0))
14021 (or force (throw 'exit nil))
14022 (goto-char beg)
14023 (setq end beg)
14024 (org-indent-line-function)
14026 (cons beg end)))))
14028 (defun org-entry-properties (&optional pom which specific)
14029 "Get all properties of the entry at point-or-marker POM.
14030 This includes the TODO keyword, the tags, time strings for deadline,
14031 scheduled, and clocking, and any additional properties defined in the
14032 entry. The return value is an alist, keys may occur multiple times
14033 if the property key was used several times.
14034 POM may also be nil, in which case the current entry is used.
14035 If WHICH is nil or `all', get all properties. If WHICH is
14036 `special' or `standard', only get that subclass. If WHICH
14037 is a string only get exactly this property. SPECIFIC can be a string, the
14038 specific property we are interested in. Specifying it can speed
14039 things up because then unnecessary parsing is avoided."
14040 (setq which (or which 'all))
14041 (org-with-point-at pom
14042 (let ((clockstr (substring org-clock-string 0 -1))
14043 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14044 (case-fold-search nil)
14045 beg end range props sum-props key key1 value string clocksum)
14046 (save-excursion
14047 (when (condition-case nil
14048 (and (eq major-mode 'org-mode) (org-back-to-heading t))
14049 (error nil))
14050 (setq beg (point))
14051 (setq sum-props (get-text-property (point) 'org-summaries))
14052 (setq clocksum (get-text-property (point) :org-clock-minutes))
14053 (outline-next-heading)
14054 (setq end (point))
14055 (when (memq which '(all special))
14056 ;; Get the special properties, like TODO and tags
14057 (goto-char beg)
14058 (when (and (or (not specific) (string= specific "TODO"))
14059 (looking-at org-todo-line-regexp) (match-end 2))
14060 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14061 (when (and (or (not specific) (string= specific "PRIORITY"))
14062 (looking-at org-priority-regexp))
14063 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14064 (when (or (not specific) (string= specific "FILE"))
14065 (push (cons "FILE" buffer-file-name) props))
14066 (when (and (or (not specific) (string= specific "TAGS"))
14067 (setq value (org-get-tags-string))
14069 (push (cons "TAGS" value) props))
14070 (when (and (or (not specific) (string= specific "ALLTAGS"))
14071 (setq value (org-get-tags-at)))
14072 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14073 ":"))
14074 props))
14075 (when (or (not specific) (string= specific "BLOCKED"))
14076 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14077 (when (or (not specific)
14078 (member specific
14079 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14080 "TIMESTAMP" "TIMESTAMP_IA")))
14081 (catch 'match
14082 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14083 (setq key (if (match-end 1)
14084 (substring (org-match-string-no-properties 1)
14085 0 -1))
14086 string (if (equal key clockstr)
14087 (org-no-properties
14088 (org-trim
14089 (buffer-substring
14090 (match-beginning 3) (goto-char
14091 (point-at-eol)))))
14092 (substring (org-match-string-no-properties 3)
14093 1 -1)))
14094 ;; Get the correct property name from the key. This is
14095 ;; necessary if the user has configured time keywords.
14096 (setq key1 (concat key ":"))
14097 (cond
14098 ((not key)
14099 (setq key
14100 (if (= (char-after (match-beginning 3)) ?\[)
14101 "TIMESTAMP_IA" "TIMESTAMP")))
14102 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14103 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14104 ((equal key1 org-closed-string) (setq key "CLOSED"))
14105 ((equal key1 org-clock-string) (setq key "CLOCK")))
14106 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14107 (progn
14108 (push (cons key string) props)
14109 ;; no need to search further if match is found
14110 (throw 'match t))
14111 (when (or (equal key "CLOCK") (not (assoc key props)))
14112 (push (cons key string) props))))))
14113 )
14115 (when (memq which '(all standard))
14116 ;; Get the standard properties, like :PROP: ...
14117 (setq range (org-get-property-block beg end))
14118 (when range
14119 (goto-char (car range))
14120 (while (re-search-forward
14122 (cdr range) t)
14123 (setq key (org-match-string-no-properties 1)
14124 value (org-trim (or (org-match-string-no-properties 2) "")))
14125 (unless (member key excluded)
14126 (push (cons key (or value "")) props)))))
14127 (if clocksum
14128 (push (cons "CLOCKSUM"
14129 (org-columns-number-to-string (/ (float clocksum) 60.)
14130 'add_times))
14131 props))
14132 (unless (assoc "CATEGORY" props)
14133 (push (cons "CATEGORY" (org-get-category)) props))
14134 (append sum-props (nreverse props)))))))
14136 (defun org-entry-get (pom property &optional inherit literal-nil)
14137 "Get value of PROPERTY for entry at point-or-marker POM.
14138 If INHERIT is non-nil and the entry does not have the property,
14139 then also check higher levels of the hierarchy.
14140 If INHERIT is the symbol `selective', use inheritance only if the setting
14141 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14142 If the property is present but empty, the return value is the empty string.
14143 If the property is not present at all, nil is returned.
14146 do not interpret it as the list atom nil. This is used for inheritance
14148 (org-with-point-at pom
14149 (if (and inherit (if (eq inherit 'selective)
14150 (org-property-inherit-p property)
14151 t))
14152 (org-entry-get-with-inheritance property literal-nil)
14153 (if (member property org-special-properties)
14154 ;; We need a special property. Use `org-entry-properties' to
14155 ;; retrieve it, but specify the wanted property
14156 (cdr (assoc property (org-entry-properties nil 'special property)))
14157 (let ((range (unless (org-before-first-heading-p)
14158 (org-get-property-block)))
14159 (props (list (or (assoc property org-file-properties)
14160 (assoc property org-global-properties)
14161 (assoc property org-global-properties-fixed))))
14162 val)
14163 (flet ((ap (key)
14164 (when (re-search-forward
14165 (org-re-property key) (cdr range) t)
14166 (setq props
14167 (org-update-property-plist
14168 key
14169 (if (match-end 1)
14170 (org-match-string-no-properties 1) "")
14171 props)))))
14172 (when (and range (goto-char (car range)))
14173 (ap property)
14174 (goto-char (car range))
14175 (while (ap (concat property "+")))
14176 (setq val (cdr (assoc property props)))
14177 (when val (if literal-nil val (org-not-nil val))))))))))
14179 (defun org-property-or-variable-value (var &optional inherit)
14180 "Check if there is a property fixing the value of VAR.
14181 If yes, return this value. If not, return the current value of the variable."
14182 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14184 (read prop)
14185 (symbol-value var))))
14187 (defun org-entry-delete (pom property)
14188 "Delete the property PROPERTY from entry at point-or-marker POM."
14189 (org-with-point-at pom
14190 (if (member property org-special-properties)
14191 nil ; cannot delete these properties.
14192 (let ((range (org-get-property-block)))
14193 (if (and range
14194 (goto-char (car range))
14195 (re-search-forward
14196 (org-re-property property)
14197 (cdr range) t))
14198 (progn
14199 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14200 t)
14201 nil)))))
14203 ;; Multi-values properties are properties that contain multiple values
14204 ;; These values are assumed to be single words, separated by whitespace.
14205 (defun org-entry-add-to-multivalued-property (pom property value)
14206 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14207 (let* ((old (org-entry-get pom property))
14209 (setq value (org-entry-protect-space value))
14210 (unless (member value values)
14211 (setq values (cons value values))
14212 (org-entry-put pom property
14213 (mapconcat 'identity values " ")))))
14215 (defun org-entry-remove-from-multivalued-property (pom property value)
14216 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14217 (let* ((old (org-entry-get pom property))
14219 (setq value (org-entry-protect-space value))
14220 (when (member value values)
14221 (setq values (delete value values))
14222 (org-entry-put pom property
14223 (mapconcat 'identity values " ")))))
14225 (defun org-entry-member-in-multivalued-property (pom property value)
14226 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
14227 (let* ((old (org-entry-get pom property))
14229 (setq value (org-entry-protect-space value))
14230 (member value values)))
14232 (defun org-entry-get-multivalued-property (pom property)
14233 "Return a list of values in a multivalued property."
14234 (let* ((value (org-entry-get pom property))
14236 (mapcar 'org-entry-restore-space values)))
14238 (defun org-entry-put-multivalued-property (pom property &rest values)
14239 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14240 VALUES should be a list of strings. Spaces will be protected."
14241 (org-entry-put pom property
14242 (mapconcat 'org-entry-protect-space values " "))
14243 (let* ((value (org-entry-get pom property))
14245 (mapcar 'org-entry-restore-space values)))
14247 (defun org-entry-protect-space (s)
14248 "Protect spaces and newline in string S."
14249 (while (string-match " " s)
14250 (setq s (replace-match "%20" t t s)))
14252 (setq s (replace-match "%0A" t t s)))
14253 s)
14255 (defun org-entry-restore-space (s)
14256 "Restore spaces and newline in string S."
14257 (while (string-match "%20" s)
14258 (setq s (replace-match " " t t s)))
14259 (while (string-match "%0A" s)
14261 s)
14263 (defvar org-entry-property-inherited-from (make-marker)
14264 "Marker pointing to the entry from where a property was inherited.
14265 Each call to `org-entry-get-with-inheritance' will set this marker to the
14266 location of the entry where the inheritance search matched. If there was
14267 no match, the marker will point nowhere.
14268 Note that also `org-entry-get' calls this function, if the INHERIT flag
14269 is set.")
14271 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14272 "Get entry property, and search higher levels if not present.
14273 The search will stop at the first ancestor which has the property defined.
14275 should be considered as undefined (this is the meaning of nil here).
14277 (move-marker org-entry-property-inherited-from nil)
14278 (let (tmp)
14279 (unless (org-before-first-heading-p)
14280 (save-excursion
14281 (save-restriction
14282 (widen)
14283 (catch 'ex
14284 (while t
14285 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14286 (org-back-to-heading t)
14287 (move-marker org-entry-property-inherited-from (point))
14288 (throw 'ex tmp))
14289 (or (org-up-heading-safe) (throw 'ex nil)))))))
14290 (setq tmp (or tmp
14291 (cdr (assoc property org-file-properties))
14292 (cdr (assoc property org-global-properties))
14293 (cdr (assoc property org-global-properties-fixed))))
14294 (if literal-nil tmp (org-not-nil tmp))))
14296 (defvar org-property-changed-functions nil
14297 "Hook called when the value of a property has changed.
14298 Each hook function should accept two arguments, the name of the property
14299 and the new value.")
14301 (defun org-entry-put (pom property value)
14302 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14303 (org-with-point-at pom
14304 (org-back-to-heading t)
14305 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14306 range)
14307 (cond
14308 ((equal property "TODO")
14310 (not (member value org-todo-keywords-1)))
14312 (if (or (not value)
14314 (setq value 'none))
14315 (org-todo value)
14316 (org-set-tags nil 'align))
14317 ((equal property "PRIORITY")
14319 (string-to-char value) ?\ ))
14320 (org-set-tags nil 'align))
14321 ((equal property "SCHEDULED")
14322 (if (re-search-forward org-scheduled-time-regexp end t)
14323 (cond
14324 ((eq value 'earlier) (org-timestamp-change -1 'day))
14325 ((eq value 'later) (org-timestamp-change 1 'day))
14326 (t (call-interactively 'org-schedule)))
14327 (call-interactively 'org-schedule)))
14328 ((equal property "DEADLINE")
14329 (if (re-search-forward org-deadline-time-regexp end t)
14330 (cond
14331 ((eq value 'earlier) (org-timestamp-change -1 'day))
14332 ((eq value 'later) (org-timestamp-change 1 'day))
14333 (t (call-interactively 'org-deadline)))
14334 (call-interactively 'org-deadline)))
14335 ((member property org-special-properties)
14336 (error "The %s property can not yet be set with `org-entry-put'"
14337 property))
14338 (t ; a non-special property
14339 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14340 (setq range (org-get-property-block beg end 'force))
14341 (goto-char (car range))
14342 (if (re-search-forward
14343 (org-re-property property) (cdr range) t)
14344 (progn
14345 (delete-region (match-beginning 0) (match-end 0))
14346 (goto-char (match-beginning 0)))
14347 (goto-char (cdr range))
14349 (backward-char 1)
14350 (org-indent-line-function))
14351 (insert ":" property ":")
14352 (and value (insert " " value))
14353 (org-indent-line-function)))))
14354 (run-hook-with-args 'org-property-changed-functions property value)))
14356 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14357 "Get all property keys in the current buffer.
14358 With INCLUDE-SPECIALS, also list the special properties that reflect things
14359 like tags and TODO state.
14360 With INCLUDE-DEFAULTS, also include properties that has special meaning
14361 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14362 and others.
14363 With INCLUDE-COLUMNS, also include property names given in COLUMN
14364 formats in the current buffer."
14365 (let (rtn range cfmt s p)
14366 (save-excursion
14367 (save-restriction
14368 (widen)
14369 (goto-char (point-min))
14370 (while (re-search-forward org-property-start-re nil t)
14371 (setq range (org-get-property-block))
14372 (goto-char (car range))
14373 (while (re-search-forward
14375 (cdr range) t)
14376 (add-to-list 'rtn (org-match-string-no-properties 1)))
14377 (outline-next-heading))))
14379 (when include-specials
14380 (setq rtn (append org-special-properties rtn)))
14382 (when include-defaults
14383 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14384 (add-to-list 'rtn org-effort-property))
14386 (when include-columns
14387 (save-excursion
14388 (save-restriction
14389 (widen)
14390 (goto-char (point-min))
14391 (while (re-search-forward
14393 nil t)
14394 (setq cfmt (match-string 2) s 0)
14396 cfmt s)
14397 (setq s (match-end 0)
14398 p (match-string 1 cfmt))
14399 (unless (or (equal p "ITEM")
14400 (member p org-special-properties))
14401 (add-to-list 'rtn (match-string 1 cfmt))))))))
14403 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14405 (defun org-property-values (key)
14406 "Return a list of all values of property KEY in the current buffer."
14407 (save-excursion
14408 (save-restriction
14409 (widen)
14410 (goto-char (point-min))
14411 (let ((re (org-re-property key))
14412 values)
14413 (while (re-search-forward re nil t)
14414 (add-to-list 'values (org-trim (match-string 1))))
14415 (delete "" values)))))
14417 (defun org-insert-property-drawer ()
14418 "Insert a property drawer into the current entry."
14419 (interactive)
14420 (org-back-to-heading t)
14421 (looking-at org-outline-regexp)
14422 (let ((indent (if org-adapt-indentation
14423 (- (match-end 0)(match-beginning 0))
14424 0))
14425 (beg (point))
14427 end hiddenp)
14428 (outline-next-heading)
14429 (setq end (point))
14430 (goto-char beg)
14431 (while (re-search-forward re end t))
14432 (setq hiddenp (outline-invisible-p))
14433 (end-of-line 1)
14436 (if (member (match-string 1) '("CLOCK:" ":END:"))
14437 ;; just skip this line
14438 (beginning-of-line 2)
14439 ;; Drawer start, find the end
14441 (beginning-of-line 1)))
14442 (org-skip-over-state-notes)
14444 (if (eq (char-before) ?*) (forward-char 1))
14446 (beginning-of-line 0)
14447 (org-indent-to-column indent)
14448 (beginning-of-line 2)
14449 (org-indent-to-column indent)
14450 (beginning-of-line 0)
14451 (if hiddenp
14452 (save-excursion
14453 (org-back-to-heading t)
14454 (hide-entry))
14455 (org-flag-drawer t))))
14457 (defvar org-property-set-functions-alist nil
14458 "Property set function alist.
14459 Each entry should have the following format:
14461 (PROPERTY . READ-FUNCTION)
14463 The read function will be called with the same argument as
14464 `org-completing-read'.")
14466 (defun org-set-property-function (property)
14467 "Get the function that should be used to set PROPERTY.
14468 This is computed according to `org-property-set-functions-alist'."
14469 (or (cdr (assoc property org-property-set-functions-alist))
14470 'org-completing-read))
14472 (defun org-read-property-value (property)
14473 "Read PROPERTY value from user."
14474 (let* ((completion-ignore-case t)
14475 (allowed (org-property-get-allowed-values nil property 'table))
14476 (cur (org-entry-get nil property))
14477 (prompt (concat property " value"
14479 (concat " [" cur "]") "") ": "))
14480 (set-function (org-set-property-function property))
14481 (val (if allowed
14482 (funcall set-function prompt allowed nil
14483 (not (get-text-property 0 'org-unrestricted
14484 (caar allowed))))
14485 (let (org-completion-use-ido org-completion-use-iswitchb)
14486 (funcall set-function prompt
14487 (mapcar 'list (org-property-values property))
14488 nil nil "" nil cur)))))
14489 (if (equal val "")
14490 cur
14491 val)))
14493 (defvar org-last-set-property nil)
14494 (defun org-read-property-name ()
14495 "Read a property name."
14496 (let* ((completion-ignore-case t)
14497 (keys (org-buffer-property-keys nil t t))
14498 (default-prop (or (save-excursion
14499 (save-match-data
14500 (beginning-of-line)
14502 (null (string= (match-string 1) "END"))
14503 (match-string 1))))
14504 org-last-set-property))
14505 (property (org-icompleting-read
14506 (concat "Property"
14507 (if default-prop (concat " [" default-prop "]") "")
14508 ": ")
14509 (mapcar 'list keys)
14510 nil nil nil nil
14511 default-prop
14512 )))
14513 (if (member property keys)
14514 property
14515 (or (cdr (assoc (downcase property)
14516 (mapcar (lambda (x) (cons (downcase x) x))
14517 keys)))
14518 property))))
14520 (defun org-set-property (property value)
14521 "In the current entry, set PROPERTY to VALUE.
14522 When called interactively, this will prompt for a property name, offering
14523 completion on existing and default properties. And then it will prompt
14524 for a value, offering completion either on allowed values (via an inherited
14525 xxx_ALL property) or on existing values in other instances of this property
14526 in the current file."
14527 (interactive (list nil nil))
14528 (let* ((property (or property (org-read-property-name)))
14529 (value (or value (org-read-property-value property)))
14530 (fn (assoc property org-properties-postprocess-alist)))
14531 (setq org-last-set-property property)
14532 ;; Possibly postprocess the inserted value:
14533 (when fn (setq value (funcall (cadr fn) value)))
14534 (unless (equal (org-entry-get nil property) value)
14535 (org-entry-put nil property value))))
14537 (defun org-delete-property (property)
14538 "In the current entry, delete PROPERTY."
14539 (interactive
14540 (let* ((completion-ignore-case t)
14541 (prop (org-icompleting-read "Property: "
14542 (org-entry-properties nil 'standard))))
14543 (list prop)))
14544 (message "Property %s %s" property
14545 (if (org-entry-delete nil property)
14546 "deleted"
14547 "was not present in the entry")))
14549 (defun org-delete-property-globally (property)
14550 "Remove PROPERTY globally, from all entries."
14551 (interactive
14552 (let* ((completion-ignore-case t)
14553 (prop (org-icompleting-read
14554 "Globally remove property: "
14555 (mapcar 'list (org-buffer-property-keys)))))
14556 (list prop)))
14557 (save-excursion
14558 (save-restriction
14559 (widen)
14560 (goto-char (point-min))
14561 (let ((cnt 0))
14562 (while (re-search-forward
14563 (org-re-property property)
14564 nil t)
14565 (setq cnt (1+ cnt))
14566 (replace-match ""))
14569 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14571 (defun org-compute-property-at-point ()
14572 "Compute the property at point.
14573 This looks for an enclosing column format, extracts the operator and
14574 then applies it to the property in the column format's scope."
14575 (interactive)
14576 (unless (org-at-property-p)
14577 (error "Not at a property"))
14578 (let ((prop (org-match-string-no-properties 2)))
14579 (org-columns-get-format-and-top-level)
14580 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14581 (error "No operator defined for property %s" prop))
14582 (org-columns-compute prop)))
14584 (defvar org-property-allowed-value-functions nil
14585 "Hook for functions supplying allowed values for a specific property.
14586 The functions must take a single argument, the name of the property, and
14588 the values, this means that these values are intended as defaults for
14589 completion, but that other values should be allowed too.
14590 The functions must return nil if they are not responsible for this
14591 property.")
14593 (defun org-property-get-allowed-values (pom property &optional table)
14594 "Get allowed values for the property PROPERTY.
14595 When TABLE is non-nil, return an alist that can directly be used for
14596 completion."
14597 (let (vals)
14598 (cond
14599 ((equal property "TODO")
14600 (setq vals (org-with-point-at pom
14601 (append org-todo-keywords-1 '("")))))
14602 ((equal property "PRIORITY")
14603 (let ((n org-lowest-priority))
14604 (while (>= n org-highest-priority)
14605 (push (char-to-string n) vals)
14606 (setq n (1- n)))))
14607 ((member property org-special-properties))
14608 ((setq vals (run-hook-with-args-until-success
14609 'org-property-allowed-value-functions property)))
14610 (t
14611 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14613 (setq vals (car (read-from-string (concat "(" vals ")"))))
14614 (setq vals (mapcar (lambda (x)
14615 (cond ((stringp x) x)
14616 ((numberp x) (number-to-string x))
14617 ((symbolp x) (symbol-name x))
14618 (t "???")))
14619 vals)))))
14620 (when (member ":ETC" vals)
14621 (setq vals (remove ":ETC" vals))
14622 (org-add-props (car vals) '(org-unrestricted t)))
14623 (if table (mapcar 'list vals) vals)))
14625 (defun org-property-previous-allowed-value (&optional previous)
14626 "Switch to the next allowed value for this property."
14627 (interactive)
14628 (org-property-next-allowed-value t))
14630 (defun org-property-next-allowed-value (&optional previous)
14631 "Switch to the next allowed value for this property."
14632 (interactive)
14633 (unless (org-at-property-p)
14634 (error "Not at a property"))
14635 (let* ((key (match-string 2))
14636 (value (match-string 3))
14637 (allowed (or (org-property-get-allowed-values (point) key)
14638 (and (member value '("[ ]" "[-]" "[X]"))
14639 '("[ ]" "[X]"))))
14640 nval)
14641 (unless allowed
14642 (error "Allowed values for this property have not been defined"))
14643 (if previous (setq allowed (reverse allowed)))
14644 (if (member value allowed)
14645 (setq nval (car (cdr (member value allowed)))))
14646 (setq nval (or nval (car allowed)))
14647 (if (equal nval value)
14648 (error "Only one allowed value for this property"))
14649 (org-at-property-p)
14650 (replace-match (concat " :" key ": " nval) t t)
14651 (org-indent-line-function)
14652 (beginning-of-line 1)
14654 (run-hook-with-args 'org-property-changed-functions key nval)))
14656 (defun org-find-olp (path &optional this-buffer)
14657 "Return a marker pointing to the entry at outline path OLP.
14658 If anything goes wrong, throw an error.
14659 You can wrap this call to catch the error like this:
14661 (condition-case msg
14662 (org-mobile-locate-entry (match-string 4))
14663 (error (nth 1 msg)))
14665 The return value will then be either a string with the error message,
14666 or a marker if everything is OK.
14668 If THIS-BUFFER is set, the outline path does not contain a file,
14669 only headings."
14670 (let* ((file (if this-buffer buffer-file-name (pop path)))
14671 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14672 (level 1)
14673 (lmin 1)
14674 (lmax 1)
14675 limit re end found pos heading cnt flevel)
14676 (unless buffer (error "File not found :%s" file))
14677 (with-current-buffer buffer
14678 (save-excursion
14679 (save-restriction
14680 (widen)
14681 (setq limit (point-max))
14682 (goto-char (point-min))
14683 (while (setq heading (pop path))
14684 (setq re (format org-complex-heading-regexp-format
14685 (regexp-quote heading)))
14686 (setq cnt 0 pos (point))
14687 (while (re-search-forward re end t)
14688 (setq level (- (match-end 1) (match-beginning 1)))
14689 (if (and (>= level lmin) (<= level lmax))
14690 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14691 (when (= cnt 0) (error "Heading not found on level %d: %s"
14692 lmax heading))
14693 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14694 lmax heading))
14695 (goto-char found)
14696 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14697 (setq end (save-excursion (org-end-of-subtree t t))))
14698 (when (org-at-heading-p)
14699 (move-marker (make-marker) (point))))))))
14701 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14702 "Find node HEADING in BUFFER.
14703 Return a marker to the heading if it was found, or nil if not.
14704 If POS-ONLY is set, return just the position instead of a marker.
14706 The heading text must match exact, but it may have a TODO keyword,
14707 a priority cookie and tags in the standard locations."
14708 (with-current-buffer (or buffer (current-buffer))
14709 (save-excursion
14710 (save-restriction
14711 (widen)
14712 (goto-char (point-min))
14713 (let (case-fold-search)
14714 (if (re-search-forward
14715 (format org-complex-heading-regexp-format
14716 (regexp-quote heading)) nil t)
14717 (if pos-only
14718 (match-beginning 0)
14719 (move-marker (make-marker) (match-beginning 0)))))))))
14721 (defun org-find-exact-heading-in-directory (heading &optional dir)
14722 "Find Org node headline HEADING in all .org files in directory DIR.
14723 When the target headline is found, return a marker to this location."
14724 (let ((files (directory-files (or dir default-directory)
14726 file visiting m buffer)
14727 (catch 'found
14728 (while (setq file (pop files))
14729 (message "trying %s" file)
14730 (setq visiting (org-find-base-buffer-visiting file))
14731 (setq buffer (or visiting (find-file-noselect file)))
14732 (setq m (org-find-exact-headline-in-buffer
14733 heading buffer))
14734 (when (and (not m) (not visiting)) (kill-buffer buffer))
14735 (and m (throw 'found m))))))
14737 (defun org-find-entry-with-id (ident)
14738 "Locate the entry that contains the ID property with exact value IDENT.
14739 IDENT can be a string, a symbol or a number, this function will search for
14740 the string representation of it.
14741 Return the position where this entry starts, or nil if there is no such entry."
14742 (interactive "sID: ")
14743 (let ((id (cond
14744 ((stringp ident) ident)
14745 ((symbol-name ident) (symbol-name ident))
14746 ((numberp ident) (number-to-string ident))
14747 (t (error "IDENT %s must be a string, symbol or number" ident))))
14748 (case-fold-search nil))
14749 (save-excursion
14750 (save-restriction
14751 (widen)
14752 (goto-char (point-min))
14753 (when (re-search-forward
14755 nil t)
14756 (org-back-to-heading t)
14757 (point))))))
14759 ;;;; Timestamps
14761 (defvar org-last-changed-timestamp nil)
14762 (defvar org-last-inserted-timestamp nil
14763 "The last time stamp inserted with `org-insert-time-stamp'.")
14764 (defvar org-time-was-given) ; dynamically scoped parameter
14765 (defvar org-end-time-was-given) ; dynamically scoped parameter
14766 (defvar org-ts-what) ; dynamically scoped parameter
14768 (defun org-time-stamp (arg &optional inactive)
14769 "Prompt for a date/time and insert a time stamp.
14770 If the user specifies a time like HH:MM, or if this command is called
14771 with a prefix argument, the time stamp will contain date and time.
14772 Otherwise, only the date will be included. All parts of a date not
14773 specified by the user will be filled in from the current date/time.
14774 So if you press just return without typing anything, the time stamp
14775 will represent the current date/time. If there is already a timestamp
14776 at the cursor, it will be modified."
14777 (interactive "P")
14778 (let* ((ts nil)
14779 (default-time
14780 ;; Default time is either today, or, when entering a range,
14781 ;; the range start.
14782 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14783 (save-excursion
14784 (re-search-backward
14786 (- (point) 20) t)))
14787 (apply 'encode-time (org-parse-time-string (match-string 1)))
14788 (current-time)))
14789 (default-input (and ts (org-get-compact-tod ts)))
14790 (repeater (save-excursion
14791 (save-match-data
14792 (beginning-of-line)
14793 (when (re-search-forward
14795 (save-excursion (progn (end-of-line) (point))) t)
14796 (match-string 0)))))
14797 org-time-was-given org-end-time-was-given time)
14798 (cond
14799 ((and (org-at-timestamp-p t)
14800 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14801 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14802 (insert "--")
14803 (setq time (let ((this-command this-command))
14804 (org-read-date arg 'totime nil nil
14805 default-time default-input)))
14806 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14807 ((org-at-timestamp-p t)
14808 (setq time (let ((this-command this-command))
14809 (org-read-date arg 'totime nil nil default-time default-input)))
14810 (when (org-at-timestamp-p t) ; just to get the match data
14811 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14812 (replace-match "")
14813 (setq org-last-changed-timestamp
14814 (org-insert-time-stamp
14815 time (or org-time-was-given arg)
14816 inactive nil nil (list org-end-time-was-given)))
14817 (when repeater (goto-char (1- (point))) (insert " " repeater)
14818 (setq org-last-changed-timestamp
14819 (concat (substring org-last-inserted-timestamp 0 -1)
14820 " " repeater ">"))))
14821 (message "Timestamp updated"))
14822 (t
14823 (setq time (let ((this-command this-command))
14824 (org-read-date arg 'totime nil nil default-time default-input)))
14825 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14826 nil nil (list org-end-time-was-given))))))
14828 ;; FIXME: can we use this for something else, like computing time differences?
14829 (defun org-get-compact-tod (s)
14830 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14831 (let* ((t1 (match-string 1 s))
14832 (h1 (string-to-number (match-string 2 s)))
14833 (m1 (string-to-number (match-string 3 s)))
14834 (t2 (and (match-end 4) (match-string 5 s)))
14835 (h2 (and t2 (string-to-number (match-string 6 s))))
14836 (m2 (and t2 (string-to-number (match-string 7 s))))
14837 dh dm)
14838 (if (not t2)
14839 t1
14840 (setq dh (- h2 h1) dm (- m2 m1))
14841 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14842 (concat t1 "+" (number-to-string dh)
14843 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14845 (defun org-time-stamp-inactive (&optional arg)
14846 "Insert an inactive time stamp.
14847 An inactive time stamp is enclosed in square brackets instead of angle
14848 brackets. It is inactive in the sense that it does not trigger agenda entries,
14849 does not link to the calendar and cannot be changed with the S-cursor keys.
14850 So these are more for recording a certain time/date."
14851 (interactive "P")
14852 (org-time-stamp arg 'inactive))
14854 (defvar org-date-ovl (make-overlay 1 1))
14855 (overlay-put org-date-ovl 'face 'org-warning)
14856 (org-detach-overlay org-date-ovl)
14858 (defvar org-ans1) ; dynamically scoped parameter
14859 (defvar org-ans2) ; dynamically scoped parameter
14861 (defvar org-plain-time-of-day-regexp) ; defined below
14863 (defvar org-overriding-default-time nil) ; dynamically scoped
14864 (defvar org-read-date-overlay nil)
14865 (defvar org-dcst nil) ; dynamically scoped
14866 (defvar org-read-date-history nil)
14867 (defvar org-read-date-final-answer nil)
14868 (defvar org-read-date-analyze-futurep nil)
14869 (defvar org-read-date-analyze-forced-year nil)
14871 (defun org-read-date (&optional with-time to-time from-string prompt
14872 default-time default-input)
14873 "Read a date, possibly a time, and make things smooth for the user.
14874 The prompt will suggest to enter an ISO date, but you can also enter anything
14875 which will at least partially be understood by `parse-time-string'.
14876 Unrecognized parts of the date will default to the current day, month, year,
14877 hour and minute. If this command is called to replace a timestamp at point,
14878 or to enter the second timestamp of a range, the default time is taken
14879 from the existing stamp. Furthermore, the command prefers the future,
14880 so if you are giving a date where the year is not given, and the day-month
14881 combination is already past in the current year, it will assume you
14882 mean next year. For details, see the manual. A few examples:
14884 3-2-5 --> 2003-02-05
14885 feb 15 --> currentyear-02-15
14886 2/15 --> currentyear-02-15
14887 sep 12 9 --> 2009-09-12
14888 12:45 --> today 12:45
14889 22 sept 0:34 --> currentyear-09-22 0:34
14890 12 --> currentyear-currentmonth-12
14891 Fri --> nearest Friday (today or later)
14892 etc.
14894 Furthermore you can specify a relative date by giving, as the *first* thing
14895 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14896 change in days weeks, months, years.
14897 With a single plus or minus, the date is relative to today. With a double
14898 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14899 +4d --> four days from today
14900 +4 --> same as above
14901 +2w --> two weeks from today
14902 ++5 --> five days from default date
14904 The function understands only English month and weekday abbreviations,
14905 but this can be configured with the variables `parse-time-months' and
14906 `parse-time-weekdays'.
14908 While prompting, a calendar is popped up - you can also select the
14909 date with the mouse (button 1). The calendar shows a period of three
14910 months. To scroll it to other months, use the keys `>' and `<'.
14911 If you don't like the calendar, turn it off with
14912 \(setq org-read-date-popup-calendar nil)
14914 With optional argument TO-TIME, the date will immediately be converted
14915 to an internal time.
14916 With an optional argument WITH-TIME, the prompt will suggest to also
14917 insert a time. Note that when WITH-TIME is not set, you can still
14918 enter a time, and this function will inform the calling routine about
14919 this change. The calling routine may then choose to change the format
14920 used to insert the time stamp into the buffer to include the time.
14921 With optional argument FROM-STRING, read from this string instead from
14922 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14923 the time/date that is used for everything that is not specified by the
14924 user."
14925 (require 'parse-time)
14926 (let* ((org-time-stamp-rounding-minutes
14927 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14928 (org-dcst org-display-custom-times)
14929 (ct (org-current-time))
14930 (def (or org-overriding-default-time default-time ct))
14931 (defdecode (decode-time def))
14932 (dummy (progn
14933 (when (< (nth 2 defdecode) org-extend-today-until)
14934 (setcar (nthcdr 2 defdecode) -1)
14935 (setcar (nthcdr 1 defdecode) 59)
14936 (setq def (apply 'encode-time defdecode)
14937 defdecode (decode-time def)))))
14938 (calendar-frame-setup nil)
14939 (calendar-setup nil)
14940 (calendar-move-hook nil)
14941 (calendar-view-diary-initially-flag nil)
14942 (calendar-view-holidays-initially-flag nil)
14943 (timestr (format-time-string
14944 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14945 (prompt (concat (if prompt (concat prompt " ") "")
14946 (format "Date+time [%s]: " timestr)))
14947 ans (org-ans0 "") org-ans1 org-ans2 final)
14949 (cond
14950 (from-string (setq ans from-string))
14951 (org-read-date-popup-calendar
14952 (save-excursion
14953 (save-window-excursion
14954 (calendar)
14955 (unwind-protect
14956 (progn
14957 (calendar-forward-day (- (time-to-days def)
14958 (calendar-absolute-from-gregorian
14959 (calendar-current-date))))
14960 (org-eval-in-calendar nil t)
14961 (let* ((old-map (current-local-map))
14962 (map (copy-keymap calendar-mode-map))
14963 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14964 (org-defkey map (kbd "RET") 'org-calendar-select)
14965 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14966 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14967 (org-defkey minibuffer-local-map [(meta shift left)]
14968 (lambda () (interactive)
14969 (org-eval-in-calendar '(calendar-backward-month 1))))
14970 (org-defkey minibuffer-local-map [(meta shift right)]
14971 (lambda () (interactive)
14972 (org-eval-in-calendar '(calendar-forward-month 1))))
14973 (org-defkey minibuffer-local-map [(meta shift up)]
14974 (lambda () (interactive)
14975 (org-eval-in-calendar '(calendar-backward-year 1))))
14976 (org-defkey minibuffer-local-map [(meta shift down)]
14977 (lambda () (interactive)
14978 (org-eval-in-calendar '(calendar-forward-year 1))))
14979 (org-defkey minibuffer-local-map [?\e (shift left)]
14980 (lambda () (interactive)
14981 (org-eval-in-calendar '(calendar-backward-month 1))))
14982 (org-defkey minibuffer-local-map [?\e (shift right)]
14983 (lambda () (interactive)
14984 (org-eval-in-calendar '(calendar-forward-month 1))))
14985 (org-defkey minibuffer-local-map [?\e (shift up)]
14986 (lambda () (interactive)
14987 (org-eval-in-calendar '(calendar-backward-year 1))))
14988 (org-defkey minibuffer-local-map [?\e (shift down)]
14989 (lambda () (interactive)
14990 (org-eval-in-calendar '(calendar-forward-year 1))))
14991 (org-defkey minibuffer-local-map [(shift up)]
14992 (lambda () (interactive)
14993 (org-eval-in-calendar '(calendar-backward-week 1))))
14994 (org-defkey minibuffer-local-map [(shift down)]
14995 (lambda () (interactive)
14996 (org-eval-in-calendar '(calendar-forward-week 1))))
14997 (org-defkey minibuffer-local-map [(shift left)]
14998 (lambda () (interactive)
14999 (org-eval-in-calendar '(calendar-backward-day 1))))
15000 (org-defkey minibuffer-local-map [(shift right)]
15001 (lambda () (interactive)
15002 (org-eval-in-calendar '(calendar-forward-day 1))))
15003 (org-defkey minibuffer-local-map ">"
15004 (lambda () (interactive)
15005 (org-eval-in-calendar '(scroll-calendar-left 1))))
15006 (org-defkey minibuffer-local-map "<"
15007 (lambda () (interactive)
15008 (org-eval-in-calendar '(scroll-calendar-right 1))))
15009 (org-defkey minibuffer-local-map "\C-v"
15010 (lambda () (interactive)
15011 (org-eval-in-calendar
15012 '(calendar-scroll-left-three-months 1))))
15013 (org-defkey minibuffer-local-map "\M-v"
15014 (lambda () (interactive)
15015 (org-eval-in-calendar
15016 '(calendar-scroll-right-three-months 1))))
15017 (run-hooks 'org-read-date-minibuffer-setup-hook)
15018 (unwind-protect
15019 (progn
15020 (use-local-map map)
15021 (add-hook 'post-command-hook 'org-read-date-display)
15022 (setq org-ans0 (read-string prompt default-input
15023 'org-read-date-history nil))
15024 ;; org-ans0: from prompt
15025 ;; org-ans1: from mouse click
15026 ;; org-ans2: from calendar motion
15027 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15028 (remove-hook 'post-command-hook 'org-read-date-display)
15029 (use-local-map old-map)
15030 (when org-read-date-overlay
15031 (delete-overlay org-read-date-overlay)
15032 (setq org-read-date-overlay nil)))))
15033 (bury-buffer "*Calendar*")))))
15035 (t ; Naked prompt only
15036 (unwind-protect
15037 (setq ans (read-string prompt default-input
15038 'org-read-date-history timestr))
15039 (when org-read-date-overlay
15040 (delete-overlay org-read-date-overlay)
15041 (setq org-read-date-overlay nil)))))
15043 (setq final (org-read-date-analyze ans def defdecode))
15045 (when org-read-date-analyze-forced-year
15046 (message "Year was forced into %s"
15047 (if org-read-date-force-compatible-dates
15048 "compatible range (1970-2037)"
15049 "range representable on this machine"))
15050 (ding))
15052 ;; One round trip to get rid of 34th of August and stuff like that....
15053 (setq final (decode-time (apply 'encode-time final)))
15055 (setq org-read-date-final-answer ans)
15057 (if to-time
15058 (apply 'encode-time final)
15059 (if (and (boundp 'org-time-was-given) org-time-was-given)
15060 (format "%04d-%02d-%02d %02d:%02d"
15061 (nth 5 final) (nth 4 final) (nth 3 final)
15062 (nth 2 final) (nth 1 final))
15063 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15065 (defvar def)
15066 (defvar defdecode)
15067 (defvar with-time)
15068 (defun org-read-date-display ()
15069 "Display the current date prompt interpretation in the minibuffer."
15070 (when org-read-date-display-live
15071 (when org-read-date-overlay
15072 (delete-overlay org-read-date-overlay))
15073 (let ((p (point)))
15074 (end-of-line 1)
15075 (while (not (equal (buffer-substring
15076 (max (point-min) (- (point) 4)) (point))
15077 " "))
15078 (insert " "))
15079 (goto-char p))
15080 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15081 " " (or org-ans1 org-ans2)))
15082 (org-end-time-was-given nil)
15083 (f (org-read-date-analyze ans def defdecode))
15084 (fmts (if org-dcst
15085 org-time-stamp-custom-formats
15086 org-time-stamp-formats))
15087 (fmt (if (or with-time
15088 (and (boundp 'org-time-was-given) org-time-was-given))
15089 (cdr fmts)
15090 (car fmts)))
15091 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
15092 (when (and org-end-time-was-given
15093 (string-match org-plain-time-of-day-regexp txt))
15094 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15095 org-end-time-was-given
15096 (substring txt (match-end 0)))))
15097 (when org-read-date-analyze-futurep
15098 (setq txt (concat txt " (=>F)")))
15099 (setq org-read-date-overlay
15100 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15101 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
15103 (defun org-read-date-analyze (ans def defdecode)
15104 "Analyze the combined answer of the date prompt."
15105 ;; FIXME: cleanup and comment
15106 (let ((nowdecode (decode-time (current-time)))
15107 delta deltan deltaw deltadef year month day
15108 hour minute second wday pm h2 m2 tl wday1
15109 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15110 (setq org-read-date-analyze-futurep nil
15111 org-read-date-analyze-forced-year nil)
15113 (setq ans "+0"))
15115 (when (setq delta (org-read-date-get-relative ans (current-time) def))
15116 (setq ans (replace-match "" t t ans)
15117 deltan (car delta)
15118 deltaw (nth 1 delta)
15119 deltadef (nth 2 delta)))
15121 ;; Check if there is an iso week date in there
15122 ;; If yes, store the info and postpone interpreting it until the rest
15123 ;; of the parsing is done
15124 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15125 (setq iso-year (if (match-end 1)
15126 (org-small-year-to-year
15127 (string-to-number (match-string 1 ans))))
15128 iso-weekday (if (match-end 3)
15129 (string-to-number (match-string 3 ans)))
15130 iso-week (string-to-number (match-string 2 ans)))
15131 (setq ans (replace-match "" t t ans)))
15133 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15134 (when (string-match
15136 (setq year (if (match-end 2)
15137 (string-to-number (match-string 2 ans))
15138 (progn (setq kill-year t)
15139 (string-to-number (format-time-string "%Y"))))
15140 month (string-to-number (match-string 3 ans))
15141 day (string-to-number (match-string 4 ans)))
15142 (if (< year 100) (setq year (+ 2000 year)))
15144 t nil ans)))
15146 ;; Help matching dotted european dates
15147 (when (string-match
15148 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
15149 (setq year (if (match-end 3)
15150 (string-to-number (match-string 3 ans))
15151 (progn (setq kill-year t)
15152 (string-to-number (format-time-string "%Y"))))
15153 day (string-to-number (match-string 1 ans))
15154 month (string-to-number (match-string 2 ans))
15156 t nil ans)))
15158 ;; Help matching american dates, like 5/30 or 5/30/7
15159 (when (string-match
15160 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15161 (setq year (if (match-end 4)
15162 (string-to-number (match-string 4 ans))
15163 (progn (setq kill-year t)
15164 (string-to-number (format-time-string "%Y"))))
15165 month (string-to-number (match-string 1 ans))
15166 day (string-to-number (match-string 2 ans)))
15167 (if (< year 100) (setq year (+ 2000 year)))
15169 t nil ans)))
15170 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15171 ;; If there is a time with am/pm, and *no* time without it, we convert
15172 ;; so that matching will be successful.
15173 (loop for i from 1 to 2 do ; twice, for end time as well
15176 (setq hour (string-to-number (match-string 1 ans))
15177 minute (if (match-end 3)
15178 (string-to-number (match-string 3 ans))
15179 0)
15180 pm (equal ?p
15181 (string-to-char (downcase (match-string 4 ans)))))
15182 (if (and (= hour 12) (not pm))
15183 (setq hour 0)
15184 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15185 (setq ans (replace-match (format "%02d:%02d" hour minute)
15186 t t ans))))
15188 ;; Check if a time range is given as a duration
15189 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15190 (setq hour (string-to-number (match-string 1 ans))
15191 h2 (+ hour (string-to-number (match-string 3 ans)))
15192 minute (string-to-number (match-string 2 ans))
15193 m2 (+ minute (if (match-end 5) (string-to-number
15194 (match-string 5 ans))0)))
15195 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15196 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15197 t t ans)))
15199 ;; Check if there is a time range
15200 (when (boundp 'org-end-time-was-given)
15201 (setq org-time-was-given nil)
15202 (when (and (string-match org-plain-time-of-day-regexp ans)
15203 (match-end 8))
15204 (setq org-end-time-was-given (match-string 8 ans))
15205 (setq ans (concat (substring ans 0 (match-beginning 7))
15206 (substring ans (match-end 7))))))
15208 (setq tl (parse-time-string ans)
15209 day (or (nth 3 tl) (nth 3 defdecode))
15210 month (or (nth 4 tl)
15211 (if (and org-read-date-prefer-future
15212 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15213 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15214 (nth 4 defdecode)))
15215 year (or (and (not kill-year) (nth 5 tl))
15216 (if (and org-read-date-prefer-future
15217 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15218 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15219 (nth 5 defdecode)))
15220 hour (or (nth 2 tl) (nth 2 defdecode))
15221 minute (or (nth 1 tl) (nth 1 defdecode))
15222 second (or (nth 0 tl) 0)
15223 wday (nth 6 tl))
15225 (when (and (eq org-read-date-prefer-future 'time)
15226 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15227 (equal day (nth 3 nowdecode))
15228 (equal month (nth 4 nowdecode))
15229 (equal year (nth 5 nowdecode))
15230 (nth 2 tl)
15231 (or (< (nth 2 tl) (nth 2 nowdecode))
15232 (and (= (nth 2 tl) (nth 2 nowdecode))
15233 (nth 1 tl)
15234 (< (nth 1 tl) (nth 1 nowdecode)))))
15235 (setq day (1+ day)
15236 futurep t))
15238 ;; Special date definitions below
15239 (cond
15240 (iso-week
15241 ;; There was an iso week
15242 (require 'cal-iso)
15243 (setq futurep nil)
15244 (setq year (or iso-year year)
15245 day (or iso-weekday wday 1)
15246 wday nil ; to make sure that the trigger below does not match
15247 iso-date (calendar-gregorian-from-absolute
15248 (calendar-absolute-from-iso
15249 (list iso-week day year))))
15250 ; FIXME: Should we also push ISO weeks into the future?
15251 ; (when (and org-read-date-prefer-future
15252 ; (not iso-year)
15253 ; (< (calendar-absolute-from-gregorian iso-date)
15254 ; (time-to-days (current-time))))
15255 ; (setq year (1+ year)
15256 ; iso-date (calendar-gregorian-from-absolute
15257 ; (calendar-absolute-from-iso
15258 ; (list iso-week day year)))))
15259 (setq month (car iso-date)
15260 year (nth 2 iso-date)
15261 day (nth 1 iso-date)))
15262 (deltan
15263 (setq futurep nil)
15264 (unless deltadef
15265 (let ((now (decode-time (current-time))))
15266 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15267 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15268 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15269 ((equal deltaw "m") (setq month (+ month deltan)))
15270 ((equal deltaw "y") (setq year (+ year deltan)))))
15271 ((and wday (not (nth 3 tl)))
15272 (setq futurep nil)
15273 ;; Weekday was given, but no day, so pick that day in the week
15274 ;; on or after the derived date.
15275 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15276 (unless (equal wday wday1)
15277 (setq day (+ day (% (- wday wday1 -7) 7))))))
15278 (if (and (boundp 'org-time-was-given)
15279 (nth 2 tl))
15280 (setq org-time-was-given t))
15281 (if (< year 100) (setq year (+ 2000 year)))
15282 ;; Check of the date is representable
15283 (if org-read-date-force-compatible-dates
15284 (progn
15285 (if (< year 1970)
15286 (setq year 1970 org-read-date-analyze-forced-year t))
15287 (if (> year 2037)
15288 (setq year 2037 org-read-date-analyze-forced-year t)))
15289 (condition-case nil
15290 (ignore (encode-time second minute hour day month year))
15291 (error
15292 (setq year (nth 5 defdecode))
15293 (setq org-read-date-analyze-forced-year t))))
15294 (setq org-read-date-analyze-futurep futurep)
15295 (list second minute hour day month year)))
15297 (defvar parse-time-weekdays)
15299 (defun org-read-date-get-relative (s today default)
15300 "Check string S for special relative date string.
15301 TODAY and DEFAULT are internal times, for today and for a default.
15302 Return shift list (N what def-flag)
15304 N is the number of WHATs to shift.
15305 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15306 the DEFAULT date rather than TODAY."
15307 (require 'parse-time)
15308 (when (and
15309 (string-match
15310 (concat
15315 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15316 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15317 (string-to-char (substring (match-string 1 s) -1))
15318 ?+))
15319 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15320 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15321 (what (if (match-end 3) (match-string 3 s) "d"))
15322 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15323 (date (if rel default today))
15324 (wday (nth 6 (decode-time date)))
15325 delta)
15326 (if wday1
15327 (progn
15328 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15329 (if (= dir ?-) (setq delta (- delta 7)))
15330 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15331 (list delta "d" rel))
15332 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15334 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15335 "Turn a user-specified date into the internal representation.
15336 The internal representation needed by the calendar is (month day year).
15337 This is a wrapper to handle the brain-dead convention in calendar that
15338 user function argument order change dependent on argument order."
15339 (if (boundp 'calendar-date-style)
15340 (cond
15341 ((eq calendar-date-style 'american)
15342 (list arg1 arg2 arg3))
15343 ((eq calendar-date-style 'european)
15344 (list arg2 arg1 arg3))
15345 ((eq calendar-date-style 'iso)
15346 (list arg2 arg3 arg1)))
15347 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15348 (if (org-bound-and-true-p european-calendar-style)
15349 (list arg2 arg1 arg3)
15350 (list arg1 arg2 arg3)))))
15352 (defun org-eval-in-calendar (form &optional keepdate)
15353 "Eval FORM in the calendar window and return to current window.
15354 Also, store the cursor date in variable org-ans2."
15355 (let ((sf (selected-frame))
15356 (sw (selected-window)))
15357 (select-window (get-buffer-window "*Calendar*" t))
15358 (eval form)
15359 (when (and (not keepdate) (calendar-cursor-to-date))
15360 (let* ((date (calendar-cursor-to-date))
15361 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15362 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15363 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15364 (select-window sw)
15365 (org-select-frame-set-input-focus sf)))
15367 (defun org-calendar-select ()
15368 "Return to `org-read-date' with the date currently selected.
15369 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15370 (interactive)
15371 (when (calendar-cursor-to-date)
15372 (let* ((date (calendar-cursor-to-date))
15373 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15374 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15375 (if (active-minibuffer-window) (exit-minibuffer))))
15377 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15378 "Insert a date stamp for the date given by the internal TIME.
15379 WITH-HM means use the stamp format that includes the time of the day.
15380 INACTIVE means use square brackets instead of angular ones, so that the
15381 stamp will not contribute to the agenda.
15382 PRE and POST are optional strings to be inserted before and after the
15383 stamp.
15384 The command returns the inserted time stamp."
15385 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15386 stamp)
15387 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15388 (insert-before-markers (or pre ""))
15389 (when (listp extra)
15390 (setq extra (car extra))
15391 (if (and (stringp extra)
15393 (setq extra (format "-%02d:%02d"
15394 (string-to-number (match-string 1 extra))
15395 (string-to-number (match-string 2 extra))))
15396 (setq extra nil)))
15397 (when extra
15398 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15399 (insert-before-markers (setq stamp (format-time-string fmt time)))
15400 (insert-before-markers (or post ""))
15401 (setq org-last-inserted-timestamp stamp)))
15403 (defun org-toggle-time-stamp-overlays ()
15404 "Toggle the use of custom time stamp formats."
15405 (interactive)
15406 (setq org-display-custom-times (not org-display-custom-times))
15407 (unless org-display-custom-times
15408 (let ((p (point-min)) (bmp (buffer-modified-p)))
15409 (while (setq p (next-single-property-change p 'display))
15410 (if (and (get-text-property p 'display)
15411 (eq (get-text-property p 'face) 'org-date))
15412 (remove-text-properties
15413 p (setq p (next-single-property-change p 'display))
15414 '(display t))))
15415 (set-buffer-modified-p bmp)))
15416 (if (featurep 'xemacs)
15417 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15418 (org-restart-font-lock)
15419 (setq org-table-may-need-update t)
15420 (if org-display-custom-times
15421 (message "Time stamps are overlaid with custom format")
15422 (message "Time stamp overlays removed")))
15424 (defun org-display-custom-time (beg end)
15425 "Overlay modified time stamp format over timestamp between BEG and END."
15426 (let* ((ts (buffer-substring beg end))
15427 t1 w1 with-hm tf time str w2 (off 0))
15428 (save-match-data
15429 (setq t1 (org-parse-time-string ts t))
15430 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15431 (setq off (- (match-end 0) (match-beginning 0)))))
15432 (setq end (- end off))
15433 (setq w1 (- end beg)
15434 with-hm (and (nth 1 t1) (nth 2 t1))
15435 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15436 time (org-fix-decoded-time t1)
15437 str (org-add-props
15438 (format-time-string
15439 (substring tf 1 -1) (apply 'encode-time time))
15440 nil 'mouse-face 'highlight)
15441 w2 (length str))
15442 (if (not (= w2 w1))
15443 (add-text-properties (1+ beg) (+ 2 beg)
15444 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15445 (if (featurep 'xemacs)
15446 (progn
15447 (put-text-property beg end 'invisible t)
15448 (put-text-property beg end 'end-glyph (make-glyph str)))
15449 (put-text-property beg end 'display str))))
15451 (defun org-translate-time (string)
15452 "Translate all timestamps in STRING to custom format.
15453 But do this only if the variable `org-display-custom-times' is set."
15454 (when org-display-custom-times
15455 (save-match-data
15456 (let* ((start 0)
15457 (re org-ts-regexp-both)
15458 t1 with-hm inactive tf time str beg end)
15459 (while (setq start (string-match re string start))
15460 (setq beg (match-beginning 0)
15461 end (match-end 0)
15462 t1 (save-match-data
15463 (org-parse-time-string (substring string beg end) t))
15464 with-hm (and (nth 1 t1) (nth 2 t1))
15465 inactive (equal (substring string beg (1+ beg)) "[")
15466 tf (funcall (if with-hm 'cdr 'car)
15467 org-time-stamp-custom-formats)
15468 time (org-fix-decoded-time t1)
15469 str (format-time-string
15470 (concat
15471 (if inactive "[" "<") (substring tf 1 -1)
15472 (if inactive "]" ">"))
15473 (apply 'encode-time time))
15474 string (replace-match str t t string)
15475 start (+ start (length str)))))))
15476 string)
15478 (defun org-fix-decoded-time (time)
15479 "Set 0 instead of nil for the first 6 elements of time.
15480 Don't touch the rest."
15481 (let ((n 0))
15482 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15484 (defun org-days-to-time (timestamp-string)
15485 "Difference between TIMESTAMP-STRING and now in days."
15486 (- (time-to-days (org-time-string-to-time timestamp-string))
15487 (time-to-days (current-time))))
15489 (defun org-deadline-close (timestamp-string &optional ndays)
15490 "Is the time in TIMESTAMP-STRING close to the current date?"
15491 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15492 (and (< (org-days-to-time timestamp-string) ndays)
15493 (not (org-entry-is-done-p))))
15495 (defun org-get-wdays (ts)
15496 "Get the deadline lead time appropriate for timestring TS."
15497 (cond
15498 ((<= org-deadline-warning-days 0)
15499 ;; 0 or negative, enforce this value no matter what
15500 (- org-deadline-warning-days))
15502 ;; lead time is specified.
15503 (floor (* (string-to-number (match-string 1 ts))
15504 (cdr (assoc (match-string 2 ts)
15505 '(("d" . 1) ("w" . 7)
15506 ("m" . 30.4) ("y" . 365.25)))))))
15507 ;; go for the default.
15508 (t org-deadline-warning-days)))
15510 (defun org-calendar-select-mouse (ev)
15511 "Return to `org-read-date' with the date currently selected.
15512 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15513 (interactive "e")
15514 (mouse-set-point ev)
15515 (when (calendar-cursor-to-date)
15516 (let* ((date (calendar-cursor-to-date))
15517 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15518 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15519 (if (active-minibuffer-window) (exit-minibuffer))))
15521 (defun org-check-deadlines (ndays)
15522 "Check if there are any deadlines due or past due.
15523 A deadline is considered due if it happens within `org-deadline-warning-days'
15524 days from today's date. If the deadline appears in an entry marked DONE,
15525 it is not shown. The prefix arg NDAYS can be used to test that many
15527 (interactive "P")
15528 (let* ((org-warn-days
15529 (cond
15530 ((equal ndays '(4)) 100000)
15531 (ndays (prefix-numeric-value ndays))
15532 (t (abs org-deadline-warning-days))))
15533 (case-fold-search nil)
15535 (callback
15536 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15538 (message "%d deadlines past-due or due within %d days"
15539 (org-occur regexp nil callback)
15540 org-warn-days)))
15542 (defun org-check-before-date (date)
15543 "Check if there are deadlines or scheduled entries before DATE."
15544 (interactive (list (org-read-date)))
15545 (let ((case-fold-search nil)
15549 (callback
15550 (lambda () (time-less-p
15551 (org-time-string-to-time (match-string 2))
15552 (org-time-string-to-time date)))))
15553 (message "%d entries before %s"
15554 (org-occur regexp nil callback) date)))
15556 (defun org-check-after-date (date)
15557 "Check if there are deadlines or scheduled entries after DATE."
15558 (interactive (list (org-read-date)))
15559 (let ((case-fold-search nil)
15563 (callback
15564 (lambda () (not
15565 (time-less-p
15566 (org-time-string-to-time (match-string 2))
15567 (org-time-string-to-time date))))))
15568 (message "%d entries after %s"
15569 (org-occur regexp nil callback) date)))
15571 (defun org-check-dates-range (start-date end-date)
15572 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
15573 (interactive (list (org-read-date nil nil nil "Range starts")
15574 (org-read-date nil nil nil "Range end")))
15575 (let ((case-fold-search nil)
15579 (callback
15580 (lambda ()
15581 (let ((match (match-string 2)))
15582 (and
15583 (not (time-less-p
15584 (org-time-string-to-time match)
15585 (org-time-string-to-time start-date)))
15586 (time-less-p
15587 (org-time-string-to-time match)
15588 (org-time-string-to-time end-date)))))))
15589 (message "%d entries between %s and %s"
15590 (org-occur regexp nil callback) start-date end-date)))
15592 (defun org-evaluate-time-range (&optional to-buffer)
15593 "Evaluate a time range by computing the difference between start and end.
15594 Normally the result is just printed in the echo area, but with prefix arg
15595 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15596 If the time range is actually in a table, the result is inserted into the
15597 next column.
15598 For time difference computation, a year is assumed to be exactly 365
15599 days in order to avoid rounding problems."
15600 (interactive "P")
15601 (or
15602 (org-clock-update-time-maybe)
15603 (save-excursion
15604 (unless (org-at-date-range-p t)
15605 (goto-char (point-at-bol))
15606 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15607 (if (not (org-at-date-range-p t))
15608 (error "Not at a time-stamp range, and none found in current line")))
15609 (let* ((ts1 (match-string 1))
15610 (ts2 (match-string 2))
15611 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15612 (match-end (match-end 0))
15613 (time1 (org-time-string-to-time ts1))
15614 (time2 (org-time-string-to-time ts2))
15615 (t1 (org-float-time time1))
15616 (t2 (org-float-time time2))
15617 (diff (abs (- t2 t1)))
15618 (negative (< (- t2 t1) 0))
15619 ;; (ys (floor (* 365 24 60 60)))
15620 (ds (* 24 60 60))
15621 (hs (* 60 60))
15622 (fy "%dy %dd %02d:%02d")
15623 (fy1 "%dy %dd")
15624 (fd "%dd %02d:%02d")
15625 (fd1 "%dd")
15626 (fh "%02d:%02d")
15627 y d h m align)
15628 (if havetime
15629 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15630 y 0
15631 d (floor (/ diff ds)) diff (mod diff ds)
15632 h (floor (/ diff hs)) diff (mod diff hs)
15633 m (floor (/ diff 60)))
15634 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15635 y 0
15636 d (floor (+ (/ diff ds) 0.5))
15637 h 0 m 0))
15638 (if (not to-buffer)
15639 (message "%s" (org-make-tdiff-string y d h m))
15640 (if (org-at-table-p)
15641 (progn
15642 (goto-char match-end)
15643 (setq align t)
15644 (and (looking-at " *|") (goto-char (match-end 0))))
15645 (goto-char match-end))
15646 (if (looking-at
15648 (replace-match ""))
15649 (if negative (insert " -"))
15650 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15651 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15652 (insert " " (format fh h m))))
15653 (if align (org-table-align))
15654 (message "Time difference inserted")))))
15656 (defun org-make-tdiff-string (y d h m)
15657 (let ((fmt "")
15658 (l nil))
15659 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15660 l (push y l)))
15661 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15662 l (push d l)))
15663 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15664 l (push h l)))
15665 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15666 l (push m l)))
15667 (apply 'format fmt (nreverse l))))
15669 (defun org-time-string-to-time (s &optional buffer pos)
15670 (condition-case errdata
15671 (apply 'encode-time (org-parse-time-string s))
15673 s (if (not (and buffer pos))
15674 ""
15675 (format " at %d in buffer `%s'" pos buffer))
15676 (cdr errdata)))))
15678 (defun org-time-string-to-seconds (s)
15679 (org-float-time (org-time-string-to-time s)))
15681 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
15682 "Convert a time stamp to an absolute day number.
15683 If there is a specifier for a cyclic time stamp, get the closest date to
15684 DAYNR.
15685 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15686 The variable date is bound by the calendar when this is called."
15687 (cond
15689 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15690 daynr
15691 (+ daynr 1000)))
15693 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15694 (time-to-days (current-time))) (match-string 0 s)
15695 prefer show-all))
15696 (t (time-to-days
15697 (condition-case errdata
15698 (apply 'encode-time (org-parse-time-string s))
15700 s (if (not (and buffer pos))
15701 ""
15702 (format " at %d in buffer `%s'" pos buffer))
15703 (cdr errdata))))))))
15705 (defun org-days-to-iso-week (days)
15706 "Return the iso week number."
15707 (require 'cal-iso)
15708 (car (calendar-iso-from-absolute days)))
15710 (defun org-small-year-to-year (year)
15711 "Convert 2-digit years into 4-digit years.
15712 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15713 The year 2000 cannot be abbreviated. Any year larger than 99
15714 is returned unchanged."
15715 (if (< year 38)
15716 (setq year (+ 2000 year))
15717 (if (< year 100)
15718 (setq year (+ 1900 year))))
15719 year)
15721 (defun org-time-from-absolute (d)
15722 "Return the time corresponding to date D.
15723 D may be an absolute day number, or a calendar-type list (month day year)."
15724 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15725 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15727 (defun org-calendar-holiday ()
15728 "List of holidays, for Diary display in Org-mode."
15729 (require 'holidays)
15730 (let ((hl (funcall
15731 (if (fboundp 'calendar-check-holidays)
15732 'calendar-check-holidays 'check-calendar-holidays) date)))
15733 (if hl (mapconcat 'identity hl "; "))))
15735 (defun org-diary-sexp-entry (sexp entry date)
15736 "Process a SEXP diary ENTRY for DATE."
15737 (require 'diary-lib)
15738 (let ((result (if calendar-debug-sexp
15739 (let ((stack-trace-on-error t))
15740 (eval (car (read-from-string sexp))))
15741 (condition-case nil
15742 (eval (car (read-from-string sexp)))
15743 (error
15744 (beep)
15745 (message "Bad sexp at line %d in %s: %s"
15746 (org-current-line)
15747 (buffer-file-name) sexp)
15748 (sleep-for 2))))))
15749 (cond ((stringp result) (split-string result "; "))
15750 ((and (consp result)
15751 (not (consp (cdr result)))
15752 (stringp (cdr result))) (cdr result))
15753 ((and (consp result)
15754 (stringp (car result))) result)
15755 (result entry)
15756 (t nil))))
15758 (defun org-diary-to-ical-string (frombuf)
15759 "Get iCalendar entries from diary entries in buffer FROMBUF.
15760 This uses the icalendar.el library."
15761 (let* ((tmpdir (if (featurep 'xemacs)
15762 (temp-directory)
15763 temporary-file-directory))
15764 (tmpfile (make-temp-name
15765 (expand-file-name "orgics" tmpdir)))
15766 buf rtn b e)
15767 (with-current-buffer frombuf
15768 (icalendar-export-region (point-min) (point-max) tmpfile)
15769 (setq buf (find-buffer-visiting tmpfile))
15770 (set-buffer buf)
15771 (goto-char (point-min))
15772 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15773 (setq b (match-beginning 0)))
15774 (goto-char (point-max))
15775 (if (re-search-backward "^END:VEVENT" nil t)
15776 (setq e (match-end 0)))
15778 (kill-buffer buf)
15779 (delete-file tmpfile)
15780 rtn))
15782 (defun org-closest-date (start current change prefer show-all)
15783 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15784 When PREFER is `past', return a date that is either CURRENT or past.
15785 When PREFER is `future', return a date that is either CURRENT or future.
15786 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15787 ;; Make the proper lists from the dates
15788 (catch 'exit
15789 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15790 dn dw sday cday n1 n2 n0
15791 d m y y1 y2 date1 date2 nmonths nm ny m2)
15793 (setq start (org-date-to-gregorian start)
15794 current (org-date-to-gregorian
15795 (if show-all
15796 current
15797 (time-to-days (current-time))))
15798 sday (calendar-absolute-from-gregorian start)
15799 cday (calendar-absolute-from-gregorian current))
15801 (if (<= cday sday) (throw 'exit sday))
15804 (setq dn (string-to-number (match-string 1 change))
15805 dw (cdr (assoc (match-string 2 change) a1)))
15806 (error "Invalid change specifier: %s" change))
15807 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15808 (cond
15809 ((eq dw 'day)
15810 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15811 n2 (+ n1 dn)))
15812 ((eq dw 'year)
15813 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15814 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15815 (setq date1 (list m d y1)
15816 n1 (calendar-absolute-from-gregorian date1)
15817 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15818 n2 (calendar-absolute-from-gregorian date2)))
15819 ((eq dw 'month)
15820 ;; approx number of month between the two dates
15821 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15822 ;; How often does dn fit in there?
15823 (setq d (nth 1 start) m (car start) y (nth 2 start)
15824 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15825 m (+ m nm)
15826 ny (floor (/ m 12))
15827 y (+ y ny)
15828 m (- m (* ny 12)))
15829 (while (> m 12) (setq m (- m 12) y (1+ y)))
15830 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15831 (setq m2 (+ m dn) y2 y)
15832 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15833 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15834 (while (<= n2 cday)
15835 (setq n1 n2 m m2 y y2)
15836 (setq m2 (+ m dn) y2 y)
15837 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15838 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15839 ;; Make sure n1 is the earlier date
15840 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15841 (if show-all
15842 (cond
15843 ((eq prefer 'past) (if (= cday n2) n2 n1))
15844 ((eq prefer 'future) (if (= cday n1) n1 n2))
15845 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15846 (cond
15847 ((eq prefer 'past) (if (= cday n2) n2 n1))
15848 ((eq prefer 'future) (if (= cday n1) n1 n2))
15849 (t (if (= cday n1) n1 n2)))))))
15851 (defun org-date-to-gregorian (date)
15852 "Turn any specification of DATE into a Gregorian date for the calendar."
15853 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15854 ((and (listp date) (= (length date) 3)) date)
15855 ((stringp date)
15856 (setq date (org-parse-time-string date))
15857 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15858 ((listp date)
15859 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15861 (defun org-parse-time-string (s &optional nodefault)
15862 "Parse the standard Org-mode time string.
15863 This should be a lot faster than the normal `parse-time-string'.
15864 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15865 hour and minute fields will be nil if not given."
15866 (if (string-match org-ts-regexp0 s)
15867 (list 0
15868 (if (or (match-beginning 8) (not nodefault))
15869 (string-to-number (or (match-string 8 s) "0")))
15870 (if (or (match-beginning 7) (not nodefault))
15871 (string-to-number (or (match-string 7 s) "0")))
15872 (string-to-number (match-string 4 s))
15873 (string-to-number (match-string 3 s))
15874 (string-to-number (match-string 2 s))
15875 nil nil nil)
15876 (error "Not a standard Org-mode time string: %s" s)))
15878 (defun org-timestamp-up (&optional arg)
15879 "Increase the date item at the cursor by one.
15880 If the cursor is on the year, change the year. If it is on the month,
15881 the day or the time, change that.
15882 With prefix ARG, change by that many units."
15883 (interactive "p")
15884 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15886 (defun org-timestamp-down (&optional arg)
15887 "Decrease the date item at the cursor by one.
15888 If the cursor is on the year, change the year. If it is on the month,
15889 the day or the time, change that.
15890 With prefix ARG, change by that many units."
15891 (interactive "p")
15892 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15894 (defun org-timestamp-up-day (&optional arg)
15895 "Increase the date in the time stamp by one day.
15896 With prefix ARG, change that many days."
15897 (interactive "p")
15898 (if (and (not (org-at-timestamp-p t))
15899 (org-at-heading-p))
15900 (org-todo 'up)
15901 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15903 (defun org-timestamp-down-day (&optional arg)
15904 "Decrease the date in the time stamp by one day.
15905 With prefix ARG, change that many days."
15906 (interactive "p")
15907 (if (and (not (org-at-timestamp-p t))
15908 (org-at-heading-p))
15909 (org-todo 'down)
15910 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15912 (defun org-at-timestamp-p (&optional inactive-ok)
15913 "Determine if the cursor is in or at a timestamp."
15914 (interactive)
15915 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15916 (pos (point))
15917 (ans (or (looking-at tsr)
15918 (save-excursion
15920 (if (> (point) (point-min)) (backward-char 1))
15921 (and (looking-at tsr)
15922 (> (- (match-end 0) pos) -1))))))
15923 (and ans
15924 (boundp 'org-ts-what)
15925 (setq org-ts-what
15926 (cond
15927 ((= pos (match-beginning 0)) 'bracket)
15928 ;; Point is considered to be "on the bracket" whether
15929 ;; it's really on it or right after it.
15930 ((or (= pos (1- (match-end 0)))
15931 (= pos (match-end 0))) 'bracket)
15932 ((org-pos-in-match-range pos 2) 'year)
15933 ((org-pos-in-match-range pos 3) 'month)
15934 ((org-pos-in-match-range pos 7) 'hour)
15935 ((org-pos-in-match-range pos 8) 'minute)
15936 ((or (org-pos-in-match-range pos 4)
15937 (org-pos-in-match-range pos 5)) 'day)
15938 ((and (> pos (or (match-end 8) (match-end 5)))
15939 (< pos (match-end 0)))
15940 (- pos (or (match-end 8) (match-end 5))))
15941 (t 'day))))
15942 ans))
15944 (defun org-toggle-timestamp-type ()
15945 "Toggle the type (<active> or [inactive]) of a time stamp."
15946 (interactive)
15947 (when (org-at-timestamp-p t)
15948 (let ((beg (match-beginning 0)) (end (match-end 0))
15949 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15950 (save-excursion
15951 (goto-char beg)
15952 (while (re-search-forward "[][<>]" end t)
15953 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15954 t t)))
15955 (message "Timestamp is now %sactive"
15956 (if (equal (char-after beg) ?<) "" "in")))))
15958 (defun org-timestamp-change (n &optional what updown)
15959 "Change the date in the time stamp at point.
15960 The date will be changed by N times WHAT. WHAT can be `day', `month',
15961 `year', `minute', `second'. If WHAT is not given, the cursor position
15962 in the timestamp determines what will be changed."
15963 (let ((origin (point)) origin-cat
15964 with-hm inactive
15965 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15966 org-ts-what
15967 extra rem
15968 ts time time0)
15969 (if (not (org-at-timestamp-p t))
15970 (error "Not at a timestamp"))
15971 (if (and (not what) (eq org-ts-what 'bracket))
15972 (org-toggle-timestamp-type)
15973 ;; Point isn't on brackets. Remember the part of the time-stamp
15974 ;; the point was in. Indeed, size of time-stamps may change,
15975 ;; but point must be kept in the same category nonetheless.
15976 (setq origin-cat org-ts-what)
15977 (if (and (not what) (not (eq org-ts-what 'day))
15978 org-display-custom-times
15979 (get-text-property (point) 'display)
15980 (not (get-text-property (1- (point)) 'display)))
15981 (setq org-ts-what 'day))
15982 (setq org-ts-what (or what org-ts-what)
15983 inactive (= (char-after (match-beginning 0)) ?\[)
15984 ts (match-string 0))
15985 (replace-match "")
15986 (if (string-match
15988 ts)
15989 (setq extra (match-string 1 ts)))
15991 (setq with-hm t))
15992 (setq time0 (org-parse-time-string ts))
15993 (when (and updown
15994 (eq org-ts-what 'minute)
15995 (not current-prefix-arg))
15996 ;; This looks like s-up and s-down. Change by one rounding step.
15997 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15998 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15999 (setcar (cdr time0) (+ (nth 1 time0)
16000 (if (> n 0) (- rem) (- dm rem))))))
16001 (setq time
16002 (encode-time (or (car time0) 0)
16003 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
16004 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
16005 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
16006 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
16007 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
16008 (nthcdr 6 time0)))
16009 (when (and (member org-ts-what '(hour minute))
16010 extra
16012 (setq extra (org-modify-ts-extra
16013 extra
16014 (if (eq org-ts-what 'hour) 2 5)
16015 n dm)))
16016 (when (integerp org-ts-what)
16017 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
16018 (if (eq what 'calendar)
16019 (let ((cal-date (org-get-date-from-calendar)))
16020 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16021 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16022 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16023 (setcar time0 (or (car time0) 0))
16024 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16025 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16026 (setq time (apply 'encode-time time0))))
16027 ;; Insert the new time-stamp, and ensure point stays in the same
16028 ;; category as before (i.e. not after the last position in that
16029 ;; category).
16030 (let ((pos (point)))
16031 ;; Stay before inserted string. `save-excursion' is of no use.
16032 (setq org-last-changed-timestamp
16033 (org-insert-time-stamp time with-hm inactive nil nil extra))
16034 (goto-char pos))
16035 (save-match-data
16036 (looking-at org-ts-regexp3)
16037 (goto-char (cond
16038 ;; `day' category ends before `hour' if any, or at
16039 ;; the end of the day name.
16040 ((eq origin-cat 'day)
16041 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16042 ((eq origin-cat 'hour) (min (match-end 7) origin))
16043 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16044 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16045 ;; `year' and `month' have both fixed size: point
16046 ;; couldn't have moved into another part.
16047 (t origin))))
16048 ;; Update clock if on a CLOCK line.
16049 (org-clock-update-time-maybe)
16050 ;; Try to recenter the calendar window, if any.
16051 (if (and org-calendar-follow-timestamp-change
16052 (get-buffer-window "*Calendar*" t)
16053 (memq org-ts-what '(day month year)))
16054 (org-recenter-calendar (time-to-days time))))))
16056 (defun org-modify-ts-extra (s pos n dm)
16057 "Change the different parts of the lead-time and repeat fields in timestamp."
16058 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16059 ng h m new rem)
16060 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16061 (cond
16062 ((or (org-pos-in-match-range pos 2)
16063 (org-pos-in-match-range pos 3))
16064 (setq m (string-to-number (match-string 3 s))
16065 h (string-to-number (match-string 2 s)))
16066 (if (org-pos-in-match-range pos 2)
16067 (setq h (+ h n))
16068 (setq n (* dm (org-no-warnings (signum n))))
16069 (when (not (= 0 (setq rem (% m dm))))
16070 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16071 (setq m (+ m n)))
16072 (if (< m 0) (setq m (+ m 60) h (1- h)))
16073 (if (> m 59) (setq m (- m 60) h (1+ h)))
16074 (setq h (min 24 (max 0 h)))
16075 (setq ng 1 new (format "-%02d:%02d" h m)))
16076 ((org-pos-in-match-range pos 6)
16077 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16078 ((org-pos-in-match-range pos 5)
16079 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16081 ((org-pos-in-match-range pos 9)
16082 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16083 ((org-pos-in-match-range pos 8)
16084 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16086 (when ng
16087 (setq s (concat
16088 (substring s 0 (match-beginning ng))
16089 new
16090 (substring s (match-end ng))))))
16091 s))
16093 (defun org-recenter-calendar (date)
16094 "If the calendar is visible, recenter it to DATE."
16095 (let ((cwin (get-buffer-window "*Calendar*" t)))
16096 (when cwin
16097 (let ((calendar-move-hook nil))
16098 (with-selected-window cwin
16099 (calendar-goto-date (if (listp date) date
16100 (calendar-gregorian-from-absolute date))))))))
16102 (defun org-goto-calendar (&optional arg)
16103 "Go to the Emacs calendar at the current date.
16104 If there is a time stamp in the current line, go to that date.
16105 A prefix ARG can be used to force the current date."
16106 (interactive "P")
16107 (let ((tsr org-ts-regexp) diff
16108 (calendar-move-hook nil)
16109 (calendar-view-holidays-initially-flag nil)
16110 (calendar-view-diary-initially-flag nil))
16111 (if (or (org-at-timestamp-p)
16112 (save-excursion
16113 (beginning-of-line 1)
16114 (looking-at (concat ".*" tsr))))
16115 (let ((d1 (time-to-days (current-time)))
16116 (d2 (time-to-days
16117 (org-time-string-to-time (match-string 1)))))
16118 (setq diff (- d2 d1))))
16119 (calendar)
16120 (calendar-goto-today)
16121 (if (and diff (not arg)) (calendar-forward-day diff))))
16123 (defun org-get-date-from-calendar ()
16124 "Return a list (month day year) of date at point in calendar."
16125 (with-current-buffer "*Calendar*"
16126 (save-match-data
16127 (calendar-cursor-to-date))))
16129 (defun org-date-from-calendar ()
16130 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16131 If there is already a time stamp at the cursor position, update it."
16132 (interactive)
16133 (if (org-at-timestamp-p t)
16134 (org-timestamp-change 0 'calendar)
16135 (let ((cal-date (org-get-date-from-calendar)))
16136 (org-insert-time-stamp
16137 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16139 (defun org-minutes-to-hh:mm-string (m)
16140 "Compute H:MM from a number of minutes."
16141 (let ((h (/ m 60)))
16142 (setq m (- m (* 60 h)))
16143 (format org-time-clocksum-format h m)))
16145 (defun org-hh:mm-string-to-minutes (s)
16146 "Convert a string H:MM to a number of minutes.
16147 If the string is just a number, interpret it as minutes.
16148 In fact, the first hh:mm or number in the string will be taken,
16149 there can be extra stuff in the string.
16150 If no number is found, the return value is 0."
16151 (cond
16152 ((integerp s) s)
16154 (+ (* (string-to-number (match-string 1 s)) 60)
16155 (string-to-number (match-string 2 s))))
16157 (string-to-number (match-string 1 s)))
16158 (t 0)))
16160 (defcustom org-effort-durations
16161 `(("h" . 60)
16162 ("d" . ,(* 60 8))
16163 ("w" . ,(* 60 8 5))
16164 ("m" . ,(* 60 8 5 4))
16165 ("y" . ,(* 60 8 5 40)))
16166 "Conversion factor to minutes for an effort modifier.
16168 Each entry has the form (MODIFIER . MINUTES).
16170 In an effort string, a number followed by MODIFIER is multiplied
16171 by the specified number of MINUTES to obtain an effort in
16172 minutes.
16176 :group 'org-agenda
16177 :type '(alist :key-type (string :tag "Modifier")
16178 :value-type (number :tag "Minutes")))
16180 (defun org-duration-string-to-minutes (s)
16181 "Convert a duration string S to minutes.
16183 A bare number is interpreted as minutes, modifiers can be set by
16184 customizing `org-effort-durations' (which see).
16186 Entries containing a colon are interpreted as H:MM by
16187 `org-hh:mm-string-to-minutes'."
16188 (let ((result 0)
16190 (regexp-opt (mapcar 'car org-effort-durations))
16192 (while (string-match re s)
16193 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16194 (string-to-number (match-string 1 s))))
16195 (setq s (replace-match "" nil t s)))
16196 (incf result (org-hh:mm-string-to-minutes s))
16197 result))
16199 ;;;; Files
16201 (defun org-save-all-org-buffers ()
16202 "Save all Org-mode buffers without user confirmation."
16203 (interactive)
16204 (message "Saving all Org-mode buffers...")
16205 (save-some-buffers t (lambda () (eq major-mode 'org-mode)))
16206 (when (featurep 'org-id) (org-id-locations-save))
16207 (message "Saving all Org-mode buffers... done"))
16209 (defun org-revert-all-org-buffers ()
16210 "Revert all Org-mode buffers.
16211 Prompt for confirmation when there are unsaved changes.
16212 Be sure you know what you are doing before letting this function
16213 overwrite your changes.
16215 This function is useful in a setup where one tracks org files
16216 with a version control system, to revert on one machine after pulling
16217 changes from another. I believe the procedure must be like this:
16219 1. M-x org-save-all-org-buffers
16220 2. Pull changes from the other machine, resolve conflicts
16221 3. M-x org-revert-all-org-buffers"
16222 (interactive)
16223 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16224 (error "Abort"))
16225 (save-excursion
16226 (save-window-excursion
16227 (mapc
16228 (lambda (b)
16229 (when (and (with-current-buffer b (eq major-mode 'org-mode))
16230 (with-current-buffer b buffer-file-name))
16231 (org-pop-to-buffer-same-window b)
16232 (revert-buffer t 'no-confirm)))
16233 (buffer-list))
16234 (when (and (featurep 'org-id) org-id-track-globally)
16235 (org-id-locations-load)))))
16237 ;;;; Agenda files
16239 ;;;###autoload
16240 (defun org-switchb (&optional arg)
16241 "Switch between Org buffers.
16242 With one prefix argument, restrict available buffers to files.
16243 With two prefix arguments, restrict available buffers to agenda files.
16245 Defaults to `iswitchb' for buffer name completion.
16246 Set `org-completion-use-ido' to make it use ido instead."
16247 (interactive "P")
16248 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16249 ((equal arg '(16)) (org-buffer-list 'agenda))
16250 (t (org-buffer-list))))
16251 (org-completion-use-iswitchb org-completion-use-iswitchb)
16252 (org-completion-use-ido org-completion-use-ido))
16253 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16254 (setq org-completion-use-iswitchb t))
16255 (org-pop-to-buffer-same-window
16256 (org-icompleting-read "Org buffer: "
16257 (mapcar 'list (mapcar 'buffer-name blist))
16258 nil t))))
16260 ;;; Define some older names previously used for this functionality
16261 ;;;###autoload
16262 (defalias 'org-ido-switchb 'org-switchb)
16263 ;;;###autoload
16264 (defalias 'org-iswitchb 'org-switchb)
16266 (defun org-buffer-list (&optional predicate exclude-tmp)
16267 "Return a list of Org buffers.
16268 PREDICATE can be `export', `files' or `agenda'.
16270 export restrict the list to Export buffers.
16271 files restrict the list to buffers visiting Org files.
16272 agenda restrict the list to buffers visiting agenda files.
16274 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16275 (let* ((bfn nil)
16276 (agenda-files (and (eq predicate 'agenda)
16277 (mapcar 'file-truename (org-agenda-files t))))
16278 (filter
16279 (cond
16280 ((eq predicate 'files)
16281 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
16282 ((eq predicate 'export)
16283 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16284 ((eq predicate 'agenda)
16285 (lambda (b)
16286 (with-current-buffer b
16287 (and (eq major-mode 'org-mode)
16288 (setq bfn (buffer-file-name b))
16289 (member (file-truename bfn) agenda-files)))))
16290 (t (lambda (b) (with-current-buffer b
16291 (or (eq major-mode 'org-mode)
16292 (string-match "\*Org .*Export"
16293 (buffer-name b)))))))))
16294 (delq nil
16295 (mapcar
16296 (lambda(b)
16297 (if (and (funcall filter b)
16298 (or (not exclude-tmp)
16299 (not (string-match "tmp" (buffer-name b)))))
16300 b
16301 nil))
16302 (buffer-list)))))
16304 (defun org-agenda-files (&optional unrestricted archives)
16305 "Get the list of agenda files.
16306 Optional UNRESTRICTED means return the full list even if a restriction
16307 is currently in place.
16308 When ARCHIVES is t, include all archive files that are really being
16309 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16310 `org-agenda-archives-mode' is t."
16311 (let ((files
16312 (cond
16313 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16314 ((stringp org-agenda-files) (org-read-agenda-file-list))
16315 ((listp org-agenda-files) org-agenda-files)
16316 (t (error "Invalid value of `org-agenda-files'")))))
16317 (setq files (apply 'append
16318 (mapcar (lambda (f)
16319 (if (file-directory-p f)
16320 (directory-files
16321 f t org-agenda-file-regexp)
16322 (list f)))
16323 files)))
16324 (when org-agenda-skip-unavailable-files
16325 (setq files (delq nil
16326 (mapcar (function
16327 (lambda (file)
16328 (and (file-readable-p file) file)))
16329 files))))
16330 (when (or (eq archives t)
16331 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16332 (setq files (org-add-archive-files files)))
16333 files))
16335 (defun org-agenda-file-p (&optional file)
16336 "Return non-nil, if FILE is an agenda file.
16337 If FILE is omitted, use the file associated with the current
16338 buffer."
16339 (member (or file (buffer-file-name))
16340 (org-agenda-files t)))
16342 (defun org-edit-agenda-file-list ()
16343 "Edit the list of agenda files.
16344 Depending on setup, this either uses customize to edit the variable
16345 `org-agenda-files', or it visits the file that is holding the list. In the
16346 latter case, the buffer is set up in a way that saving it automatically kills
16347 the buffer and restores the previous window configuration."
16348 (interactive)
16349 (if (stringp org-agenda-files)
16350 (let ((cw (current-window-configuration)))
16351 (find-file org-agenda-files)
16352 (org-set-local 'org-window-configuration cw)
16353 (org-add-hook 'after-save-hook
16354 (lambda ()
16355 (set-window-configuration
16356 (prog1 org-window-configuration
16357 (kill-buffer (current-buffer))))
16358 (org-install-agenda-files-menu)
16359 (message "New agenda file list installed"))
16360 nil 'local)
16361 (message "%s" (substitute-command-keys
16363 (customize-variable 'org-agenda-files)))
16365 (defun org-store-new-agenda-file-list (list)
16366 "Set new value for the agenda file list and save it correctly."
16367 (if (stringp org-agenda-files)
16368 (let ((fe (org-read-agenda-file-list t)) b u)
16369 (while (setq b (find-buffer-visiting org-agenda-files))
16370 (kill-buffer b))
16371 (with-temp-file org-agenda-files
16372 (insert
16373 (mapconcat
16374 (lambda (f) ;; Keep un-expanded entries.
16375 (if (setq u (assoc f fe))
16376 (cdr u)
16377 f))
16380 (let ((org-mode-hook nil) (org-inhibit-startup t)
16381 (org-insert-mode-line-in-empty-file nil))
16382 (setq org-agenda-files list)
16383 (customize-save-variable 'org-agenda-files org-agenda-files))))
16385 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16386 "Read the list of agenda files from a file.
16387 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16388 filenames, used by `org-store-new-agenda-file-list' to write back
16389 un-expanded file names."
16390 (when (file-directory-p org-agenda-files)
16391 (error "`org-agenda-files' cannot be a single directory"))
16392 (when (stringp org-agenda-files)
16393 (with-temp-buffer
16394 (insert-file-contents org-agenda-files)
16395 (mapcar
16396 (lambda (f)
16397 (let ((e (expand-file-name (substitute-in-file-name f)
16398 org-directory)))
16399 (if pair-with-expansion
16400 (cons e f)
16401 e)))
16404 ;;;###autoload
16405 (defun org-cycle-agenda-files ()
16406 "Cycle through the files in `org-agenda-files'.
16407 If the current buffer visits an agenda file, find the next one in the list.
16408 If the current buffer does not, find the first agenda file."
16409 (interactive)
16410 (let* ((fs (org-agenda-files t))
16411 (files (append fs (list (car fs))))
16412 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16413 file)
16414 (unless files (error "No agenda files"))
16415 (catch 'exit
16416 (while (setq file (pop files))
16417 (if (equal (file-truename file) tcf)
16418 (when (car files)
16419 (find-file (car files))
16420 (throw 'exit t))))
16421 (find-file (car fs)))
16422 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16424 (defun org-agenda-file-to-front (&optional to-end)
16425 "Move/add the current file to the top of the agenda file list.
16426 If the file is not present in the list, it is added to the front. If it is
16427 present, it is moved there. With optional argument TO-END, add/move to the
16428 end of the list."
16429 (interactive "P")
16430 (let ((org-agenda-skip-unavailable-files nil)
16431 (file-alist (mapcar (lambda (x)
16432 (cons (file-truename x) x))
16433 (org-agenda-files t)))
16434 (ctf (file-truename buffer-file-name))
16435 x had)
16436 (setq x (assoc ctf file-alist) had x)
16438 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16439 (if to-end
16440 (setq file-alist (append (delq x file-alist) (list x)))
16441 (setq file-alist (cons x (delq x file-alist))))
16442 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16443 (org-install-agenda-files-menu)
16444 (message "File %s to %s of agenda file list"
16445 (if had "moved" "added") (if to-end "end" "front"))))
16447 (defun org-remove-file (&optional file)
16448 "Remove current file from the list of files in variable `org-agenda-files'.
16449 These are the files which are being checked for agenda entries.
16450 Optional argument FILE means use this file instead of the current."
16451 (interactive)
16452 (let* ((org-agenda-skip-unavailable-files nil)
16453 (file (or file buffer-file-name))
16454 (true-file (file-truename file))
16455 (afile (abbreviate-file-name file))
16456 (files (delq nil (mapcar
16457 (lambda (x)
16458 (if (equal true-file
16459 (file-truename x))
16460 nil x))
16461 (org-agenda-files t)))))
16462 (if (not (= (length files) (length (org-agenda-files t))))
16463 (progn
16464 (org-store-new-agenda-file-list files)
16465 (org-install-agenda-files-menu)
16466 (message "Removed file: %s" afile))
16467 (message "File was not in list: %s (not removed)" afile))))
16469 (defun org-file-menu-entry (file)
16470 (vector file (list 'find-file file) t))
16472 (defun org-check-agenda-file (file)
16473 "Make sure FILE exists. If not, ask user what to do."
16474 (when (not (file-exists-p file))
16475 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16476 (abbreviate-file-name file))
16477 (let ((r (downcase (read-char-exclusive))))
16478 (cond
16479 ((equal r ?r)
16480 (org-remove-file file)
16481 (throw 'nextfile t))
16482 (t (error "Abort"))))))
16484 (defun org-get-agenda-file-buffer (file)
16485 "Get a buffer visiting FILE. If the buffer needs to be created, add
16486 it to the list of buffers which might be released later."
16487 (let ((buf (org-find-base-buffer-visiting file)))
16488 (if buf
16489 buf ; just return it
16490 ;; Make a new buffer and remember it
16491 (setq buf (find-file-noselect file))
16492 (if buf (push buf org-agenda-new-buffers))
16493 buf)))
16495 (defun org-release-buffers (blist)
16496 "Release all buffers in list, asking the user for confirmation when needed.
16497 When a buffer is unmodified, it is just killed. When modified, it is saved
16498 \(if the user agrees) and then killed."
16499 (let (buf file)
16500 (while (setq buf (pop blist))
16501 (setq file (buffer-file-name buf))
16502 (when (and (buffer-modified-p buf)
16503 file
16504 (y-or-n-p (format "Save file %s? " file)))
16505 (with-current-buffer buf (save-buffer)))
16506 (kill-buffer buf))))
16508 (defun org-prepare-agenda-buffers (files)
16509 "Create buffers for all agenda files, protect archived trees and comments."
16510 (interactive)
16511 (let ((pa '(:org-archived t))
16512 (pc '(:org-comment t))
16513 (pall '(:org-archived t :org-comment t))
16514 (inhibit-read-only t)
16515 (rea (concat ":" org-archive-tag ":"))
16516 bmp file re)
16517 (save-excursion
16518 (save-restriction
16519 (while (setq file (pop files))
16520 (catch 'nextfile
16521 (if (bufferp file)
16522 (set-buffer file)
16523 (org-check-agenda-file file)
16524 (set-buffer (org-get-agenda-file-buffer file)))
16525 (widen)
16526 (setq bmp (buffer-modified-p))
16527 (org-refresh-category-properties)
16528 (setq org-todo-keywords-for-agenda
16529 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16530 (setq org-done-keywords-for-agenda
16531 (append org-done-keywords-for-agenda org-done-keywords))
16532 (setq org-todo-keyword-alist-for-agenda
16533 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16534 (setq org-drawers-for-agenda
16535 (append org-drawers-for-agenda org-drawers))
16536 (setq org-tag-alist-for-agenda
16537 (append org-tag-alist-for-agenda org-tag-alist))
16539 (save-excursion
16540 (remove-text-properties (point-min) (point-max) pall)
16541 (when org-agenda-skip-archived-trees
16542 (goto-char (point-min))
16543 (while (re-search-forward rea nil t)
16544 (if (org-at-heading-p t)
16545 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16546 (goto-char (point-min))
16547 (setq re (format org-heading-keyword-regexp-format
16548 org-comment-string))
16549 (while (re-search-forward re nil t)
16550 (add-text-properties
16551 (match-beginning 0) (org-end-of-subtree t) pc)))
16552 (set-buffer-modified-p bmp)))))
16553 (setq org-todo-keywords-for-agenda
16554 (org-uniquify org-todo-keywords-for-agenda))
16555 (setq org-todo-keyword-alist-for-agenda
16556 (org-uniquify org-todo-keyword-alist-for-agenda)
16557 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16559 ;;;; Embedded LaTeX
16561 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16562 "Keymap for the minor `org-cdlatex-mode'.")
16564 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16565 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16566 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16567 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16568 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16570 (defvar org-cdlatex-texmathp-advice-is-done nil
16571 "Flag remembering if we have applied the advice to texmathp already.")
16573 (define-minor-mode org-cdlatex-mode
16574 "Toggle the minor `org-cdlatex-mode'.
16575 This mode supports entering LaTeX environment and math in LaTeX fragments
16576 in Org-mode.
16578 nil " OCDL" nil
16579 (when org-cdlatex-mode
16580 (require 'cdlatex)
16581 (run-hooks 'cdlatex-mode-hook)
16582 (cdlatex-compute-tables))
16583 (unless org-cdlatex-texmathp-advice-is-done
16584 (setq org-cdlatex-texmathp-advice-is-done t)
16585 (defadvice texmathp (around org-math-always-on activate)
16586 "Always return t in org-mode buffers.
16587 This is because we want to insert math symbols without dollars even outside
16588 the LaTeX math segments. If Orgmode thinks that point is actually inside
16589 an embedded LaTeX fragment, let texmathp do its job.
16591 (interactive)
16592 (let (p)
16593 (cond
16594 ((not (eq major-mode 'org-mode)) ad-do-it)
16595 ((eq this-command 'cdlatex-math-symbol)
16596 (setq ad-return-value t
16597 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16598 (t
16599 (let ((p (org-inside-LaTeX-fragment-p)))
16600 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16601 (setq ad-return-value t
16602 texmathp-why '("Org-mode embedded math" . 0))
16603 (if p ad-do-it)))))))))
16605 (defun turn-on-org-cdlatex ()
16606 "Unconditionally turn on `org-cdlatex-mode'."
16607 (org-cdlatex-mode 1))
16609 (defun org-inside-LaTeX-fragment-p ()
16610 "Test if point is inside a LaTeX fragment.
16612 sequence appearing also before point.
16613 Even though the matchers for math are configurable, this function assumes
16615 delimiters are skipped when they have been removed by customization.
16616 The return value is nil, or a cons cell with the delimiter and the
16617 position of this delimiter.
16619 This function does a reasonably good job, but can locally be fooled by
16620 for example currency specifications. For example it will assume being in
16622 fragments that are properly closed, but during editing, we have to live
16623 with the uncertainty caused by missing closing delimiters. This function
16624 looks only before point, not after."
16625 (catch 'exit
16626 (let ((pos (point))
16627 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16628 (lim (progn
16630 (point)))
16631 dd-on str (start 0) m re)
16632 (goto-char pos)
16633 (when dodollar
16635 re (nth 1 (assoc "$" org-latex-regexps)))
16636 (while (string-match re str start)
16637 (cond
16638 ((= (match-end 0) (length str))
16639 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16640 ((= (match-end 0) (- (length str) 5))
16641 (throw 'exit nil))
16642 (t (setq start (match-end 0))))))
16643 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16644 (goto-char pos)
16645 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16646 (and (match-beginning 2) (throw 'exit nil))
16647 ;; count $$
16649 (setq dd-on (not dd-on)))
16650 (goto-char pos)
16651 (if dd-on (cons "$$" m))))))
16653 (defun org-inside-latex-macro-p ()
16654 "Is point inside a LaTeX macro or its arguments?"
16655 (save-match-data
16656 (org-in-regexp
16659 (defun org-try-cdlatex-tab ()
16660 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16661 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16662 - inside a LaTeX fragment, or
16663 - after the first word in a line, where an abbreviation expansion could
16664 insert a LaTeX environment."
16665 (when org-cdlatex-mode
16666 (cond
16667 ;; Before any word on the line: No expansion possible.
16669 ;; Just after first word on the line: Expand it. Make sure it
16670 ;; cannot happen on headlines, though.
16671 ((save-excursion
16672 (skip-chars-backward "a-zA-Z0-9*")
16674 (and (bolp) (not (org-at-heading-p))))
16675 (cdlatex-tab) t)
16676 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
16678 (defun org-cdlatex-underscore-caret (&optional arg)
16679 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16680 Revert to the normal definition outside of these fragments."
16681 (interactive "P")
16682 (if (org-inside-LaTeX-fragment-p)
16683 (call-interactively 'cdlatex-sub-superscript)
16684 (let (org-cdlatex-mode)
16685 (call-interactively (key-binding (vector last-input-event))))))
16687 (defun org-cdlatex-math-modify (&optional arg)
16688 "Execute `cdlatex-math-modify' in LaTeX fragments.
16689 Revert to the normal definition outside of these fragments."
16690 (interactive "P")
16691 (if (org-inside-LaTeX-fragment-p)
16692 (call-interactively 'cdlatex-math-modify)
16693 (let (org-cdlatex-mode)
16694 (call-interactively (key-binding (vector last-input-event))))))
16696 (defvar org-latex-fragment-image-overlays nil
16697 "List of overlays carrying the images of latex fragments.")
16698 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16700 (defun org-remove-latex-fragment-image-overlays ()
16701 "Remove all overlays with LaTeX fragment images in current buffer."
16702 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16703 (setq org-latex-fragment-image-overlays nil))
16705 (defun org-preview-latex-fragment (&optional subtree)
16706 "Preview the LaTeX fragment at point, or all locally or globally.
16707 If the cursor is in a LaTeX fragment, create the image and overlay
16708 it over the source code. If there is no fragment at point, display
16709 all fragments in the current text, from one headline to the next. With
16710 prefix SUBTREE, display all fragments in the current subtree. With a
16712 the cursor is before the first headline,
16713 display all fragments in the buffer.
16715 (interactive "P")
16716 (unless buffer-file-name
16717 (error "Can't preview LaTeX fragment in a non-file buffer"))
16718 (org-remove-latex-fragment-image-overlays)
16719 (save-excursion
16720 (save-restriction
16721 (let (beg end at msg)
16722 (cond
16723 ((or (equal subtree '(16))
16724 (not (save-excursion
16725 (re-search-backward org-outline-regexp-bol nil t))))
16726 (setq beg (point-min) end (point-max)
16727 msg "Creating images for buffer...%s"))
16728 ((equal subtree '(4))
16729 (org-back-to-heading)
16730 (setq beg (point) end (org-end-of-subtree t)
16731 msg "Creating images for subtree...%s"))
16732 (t
16733 (if (setq at (org-inside-LaTeX-fragment-p))
16734 (goto-char (max (point-min) (- (cdr at) 2)))
16735 (org-back-to-heading))
16736 (setq beg (point) end (progn (outline-next-heading) (point))
16737 msg (if at "Creating image...%s"
16738 "Creating images for entry...%s"))))
16739 (message msg "")
16740 (narrow-to-region beg end)
16741 (goto-char beg)
16742 (org-format-latex
16743 (concat "ltxpng/" (file-name-sans-extension
16744 (file-name-nondirectory
16745 buffer-file-name)))
16746 default-directory 'overlays msg at 'forbuffer 'dvipng)
16747 (message msg "done. Use `C-c C-c' to remove images.")))))
16749 (defvar org-latex-regexps
16751 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16754 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16758 "Regular expressions for matching embedded LaTeX.")
16760 (defvar org-export-have-math nil) ;; dynamic scoping
16761 (defun org-format-latex (prefix &optional dir overlays msg at
16762 forbuffer processing-type)
16763 "Replace LaTeX fragments with links to an image, and produce images.
16764 Some of the options can be changed using the variable
16765 `org-format-latex-options'."
16766 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16767 (let* ((prefixnodir (file-name-nondirectory prefix))
16768 (absprefix (expand-file-name prefix dir))
16769 (todir (file-name-directory absprefix))
16770 (opt org-format-latex-options)
16771 (matchers (plist-get opt :matchers))
16772 (re-list org-latex-regexps)
16773 (org-format-latex-header-extra
16774 (plist-get (org-infile-export-plist) :latex-header-extra))
16775 (cnt 0) txt hash link beg end re e checkdir
16776 executables-checked string
16777 m n block-type block linkfile movefile ov)
16778 ;; Check the different regular expressions
16779 (while (setq e (pop re-list))
16780 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
16782 (when (member m matchers)
16783 (goto-char (point-min))
16784 (while (re-search-forward re nil t)
16785 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16786 (not (get-text-property (match-beginning n)
16787 'org-protected))
16788 (or (not overlays)
16789 (not (eq (get-char-property (match-beginning n)
16790 'org-overlay-type)
16791 'org-latex-overlay))))
16792 (setq org-export-have-math t)
16793 (cond
16794 ((eq processing-type 'verbatim)
16795 ;; Leave the text verbatim, just protect it
16796 (add-text-properties (match-beginning n) (match-end n)
16797 '(org-protected t)))
16798 ((eq processing-type 'mathjax)
16799 ;; Prepare for MathJax processing
16800 (setq string (match-string n))
16801 (if (member m '("$" "$1"))
16802 (save-excursion
16803 (delete-region (match-beginning n) (match-end n))
16804 (goto-char (match-beginning n))
16807 '(org-protected t))))
16808 (add-text-properties (match-beginning n) (match-end n)
16809 '(org-protected t))))
16810 ((eq processing-type 'dvipng)
16811 ;; Process to an image
16812 (setq txt (match-string n)
16813 beg (match-beginning n) end (match-end n)
16814 cnt (1+ cnt))
16815 (let (print-length print-level) ; make sure full list is printed
16816 (setq hash (sha1 (prin1-to-string
16817 (list org-format-latex-header
16818 org-format-latex-header-extra
16819 org-export-latex-default-packages-alist
16820 org-export-latex-packages-alist
16821 org-format-latex-options
16822 forbuffer txt)))
16823 linkfile (format "%s_%s.png" prefix hash)
16824 movefile (format "%s_%s.png" absprefix hash)))
16825 (setq link (concat block "[[file:" linkfile "]]" block))
16826 (if msg (message msg cnt))
16827 (goto-char beg)
16828 (unless checkdir ; make sure the directory exists
16829 (setq checkdir t)
16830 (or (file-directory-p todir) (make-directory todir t)))
16832 (unless executables-checked
16833 (org-check-external-command
16834 "latex" "needed to convert LaTeX fragments to images")
16835 (org-check-external-command
16836 "dvipng" "needed to convert LaTeX fragments to images")
16837 (setq executables-checked t))
16839 (unless (file-exists-p movefile)
16840 (org-create-formula-image
16841 txt movefile opt forbuffer))
16842 (if overlays
16843 (progn
16844 (mapc (lambda (o)
16845 (if (eq (overlay-get o 'org-overlay-type)
16846 'org-latex-overlay)
16847 (delete-overlay o)))
16848 (overlays-in beg end))
16849 (setq ov (make-overlay beg end))
16850 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16851 (if (featurep 'xemacs)
16852 (progn
16853 (overlay-put ov 'invisible t)
16854 (overlay-put
16855 ov 'end-glyph
16856 (make-glyph (vector 'png :file movefile))))
16857 (overlay-put
16858 ov 'display
16859 (list 'image :type 'png :file movefile :ascent 'center)))
16860 (push ov org-latex-fragment-image-overlays)
16861 (goto-char end))
16862 (delete-region beg end)
16863 (insert (org-add-props link
16864 (list 'org-latex-src
16865 (replace-regexp-in-string
16867 'org-latex-src-embed-type
16868 (if block-type 'paragraph 'character))))))
16869 ((eq processing-type 'mathml)
16870 ;; Process to MathML
16871 (unless executables-checked
16872 (unless (save-match-data (org-format-latex-mathml-available-p))
16873 (error "LaTeX to MathML converter not configured"))
16874 (setq executables-checked t))
16875 (setq txt (match-string n)
16876 beg (match-beginning n) end (match-end n)
16877 cnt (1+ cnt))
16878 (if msg (message msg cnt))
16879 (goto-char beg)
16880 (delete-region beg end)
16881 (insert (org-format-latex-as-mathml
16882 txt block-type prefix dir)))
16883 (t
16884 (error "Unknown conversion type %s for latex fragments"
16885 processing-type)))))))))
16887 (defun org-create-math-formula (latex-frag &optional mathml-file)
16888 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
16889 Use `org-latex-to-mathml-convert-command'. If the conversion is
16891 elements otherwise return nil. When MATHML-FILE is specified,
16892 write the results in to that file. When invoked as an
16893 interactive command, prompt for LATEX-FRAG, with initial value
16894 set to the current active region and echo the results for user
16895 inspection."
16896 (interactive (list (let ((frag (when (region-active-p)
16897 (buffer-substring-no-properties
16898 (region-beginning) (region-end)))))
16899 (read-string "LaTeX Fragment: " frag nil frag))))
16900 (unless latex-frag (error "Invalid latex-frag"))
16901 (let* ((tmp-in-file (file-relative-name
16902 (make-temp-name (expand-file-name "ltxmathml-in"))))
16903 (ignore (write-region latex-frag nil tmp-in-file))
16904 (tmp-out-file (file-relative-name
16905 (make-temp-name (expand-file-name "ltxmathml-out"))))
16906 (cmd (format-spec
16907 org-latex-to-mathml-convert-command
16908 `((?j . ,(shell-quote-argument
16909 (expand-file-name org-latex-to-mathml-jar-file)))
16910 (?I . ,(shell-quote-argument tmp-in-file))
16911 (?o . ,(shell-quote-argument tmp-out-file)))))
16912 mathml shell-command-output)
16913 (when (org-called-interactively-p 'any)
16914 (unless (org-format-latex-mathml-available-p)
16915 (error "LaTeX to MathML converter not configured")))
16916 (message "Running %s" cmd)
16917 (setq shell-command-output (shell-command-to-string cmd))
16918 (setq mathml
16919 (when (file-readable-p tmp-out-file)
16920 (with-current-buffer (find-file-noselect tmp-out-file t)
16921 (goto-char (point-min))
16922 (when (re-search-forward
16923 (concat
16924 (regexp-quote
16927 (regexp-quote "</math>")) nil t)
16928 (prog1 (match-string 0) (kill-buffer))))))
16929 (cond
16930 (mathml
16931 (setq mathml
16933 (when mathml-file
16934 (write-region mathml nil mathml-file))
16935 (when (org-called-interactively-p 'any)
16936 (message mathml)))
16937 ((message "LaTeX to MathML conversion failed")
16938 (message shell-command-output)))
16939 (delete-file tmp-in-file)
16940 (when (file-exists-p tmp-out-file)
16941 (delete-file tmp-out-file))
16942 mathml))
16944 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
16945 prefix &optional dir)
16946 "Use `org-create-math-formula' but check local cache first."
16947 (let* ((absprefix (expand-file-name prefix dir))
16948 (print-length nil) (print-level nil)
16949 (formula-id (concat
16950 "formula-"
16951 (sha1
16952 (prin1-to-string
16953 (list latex-frag
16954 org-latex-to-mathml-convert-command)))))
16955 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
16956 (formula-cache-dir (file-name-directory formula-cache)))
16958 (unless (file-directory-p formula-cache-dir)
16959 (make-directory formula-cache-dir t))
16961 (unless (file-exists-p formula-cache)
16962 (org-create-math-formula latex-frag formula-cache))
16964 (if (file-exists-p formula-cache)
16965 ;; Successful conversion. Return the link to MathML file.
16966 (org-add-props
16967 (format "[[file:%s]]" (file-relative-name formula-cache dir))
16969 'org-latex-src-embed-type (if latex-frag-type
16970 'paragraph 'character)))
16971 ;; Failed conversion. Return the LaTeX fragment verbatim
16972 (add-text-properties
16973 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
16974 latex-frag)))
16976 ;; This function borrows from Ganesh Swami's latex2png.el
16977 (defun org-create-formula-image (string tofile options buffer)
16978 "This calls dvipng."
16979 (require 'org-latex)
16980 (let* ((tmpdir (if (featurep 'xemacs)
16981 (temp-directory)
16982 temporary-file-directory))
16983 (texfilebase (make-temp-name
16984 (expand-file-name "orgtex" tmpdir)))
16985 (texfile (concat texfilebase ".tex"))
16986 (dvifile (concat texfilebase ".dvi"))
16987 (pngfile (concat texfilebase ".png"))
16988 (fnh (if (featurep 'xemacs)
16989 (font-height (get-face-font 'default))
16990 (face-attribute 'default :height nil)))
16991 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16992 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16993 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16994 "Black"))
16995 (bg (or (plist-get options (if buffer :background :html-background))
16996 "Transparent")))
16997 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16998 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16999 (with-temp-file texfile
17000 (insert (org-splice-latex-header
17001 org-format-latex-header
17002 org-export-latex-default-packages-alist
17003 org-export-latex-packages-alist t
17004 org-format-latex-header-extra))
17006 (require 'org-latex)
17007 (org-export-latex-fix-inputenc))
17008 (let ((dir default-directory))
17009 (condition-case nil
17010 (progn
17011 (cd tmpdir)
17012 (call-process "latex" nil nil nil texfile))
17013 (error nil))
17014 (cd dir))
17015 (if (not (file-exists-p dvifile))
17016 (progn (message "Failed to create dvi file from %s" texfile) nil)
17017 (condition-case nil
17018 (call-process "dvipng" nil nil nil
17019 "-fg" fg "-bg" bg
17020 "-D" dpi
17021 ;;"-x" scale "-y" scale
17022 "-T" "tight"
17023 "-o" pngfile
17024 dvifile)
17025 (error nil))
17026 (if (not (file-exists-p pngfile))
17027 (if org-format-latex-signal-error
17028 (error "Failed to create png file from %s" texfile)
17029 (message "Failed to create png file from %s" texfile)
17030 nil)
17031 ;; Use the requested file name and clean up
17032 (copy-file pngfile tofile 'replace)
17033 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
17034 (delete-file (concat texfilebase e)))
17035 pngfile))))
17037 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17038 "Fill a LaTeX header template TPL.
17039 In the template, the following place holders will be recognized:
17042 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17044 [NO-PACKAGES] do not include PKG
17045 [EXTRA] the string EXTRA
17046 [NO-EXTRA] do not include EXTRA
17048 For backward compatibility, if both the positive and the negative place
17050 assumed to be present at the end of the template.
17051 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17052 EXTRA is a string.
17053 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17054 (let (rpl (end ""))
17056 (setq rpl (if (or (match-end 1) (not def-pkg))
17057 "" (org-latex-packages-to-string def-pkg snippets-p t))
17058 tpl (replace-match rpl t t tpl))
17059 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17062 (setq rpl (if (or (match-end 1) (not pkg))
17063 "" (org-latex-packages-to-string pkg snippets-p t))
17064 tpl (replace-match rpl t t tpl))
17065 (if pkg (setq end
17067 (org-latex-packages-to-string pkg snippets-p)))))
17070 (setq rpl (if (or (match-end 1) (not extra))
17072 tpl (replace-match rpl t t tpl))
17078 tpl)))
17080 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17082 (setq pkg (mapconcat (lambda(p)
17083 (cond
17084 ((stringp p) p)
17085 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17086 (format "%% Package %s omitted" (cadr p)))
17087 ((equal "" (car p))
17089 (t
17091 (car p) (cadr p)))))
17092 pkg
17096 (defun org-dvipng-color (attr)
17097 "Return an rgb color specification for dvipng."
17098 (apply 'format "rgb %s %s %s"
17099 (mapcar 'org-normalize-color
17100 (color-values (face-attribute 'default attr nil)))))
17102 (defun org-normalize-color (value)
17103 "Return string to be used as color value for an RGB component."
17104 (format "%g" (/ value 65535.0)))
17106 ;; Image display
17109 (defvar org-inline-image-overlays nil)
17110 (make-variable-buffer-local 'org-inline-image-overlays)
17112 (defun org-toggle-inline-images (&optional include-linked)
17113 "Toggle the display of inline images.
17114 INCLUDE-LINKED is passed to `org-display-inline-images'."
17115 (interactive "P")
17116 (if org-inline-image-overlays
17117 (progn
17118 (org-remove-inline-images)
17119 (message "Inline image display turned off"))
17120 (org-display-inline-images include-linked)
17121 (if org-inline-image-overlays
17122 (message "%d images displayed inline"
17123 (length org-inline-image-overlays))
17124 (message "No images to display inline"))))
17126 (defun org-display-inline-images (&optional include-linked refresh beg end)
17127 "Display inline images.
17128 Normally only links without a description part are inlined, because this
17129 is how it will work for export. When INCLUDE-LINKED is set, also links
17130 with a description part will be inlined. This can be nice for a quick
17131 look at those images, but it does not reflect what exported files will look
17132 like.
17133 When REFRESH is set, refresh existing images between BEG and END.
17134 This will create new image displays only if necessary.
17135 BEG and END default to the buffer boundaries."
17136 (interactive "P")
17137 (unless refresh
17138 (org-remove-inline-images)
17139 (if (fboundp 'clear-image-cache) (clear-image-cache)))
17140 (save-excursion
17141 (save-restriction
17142 (widen)
17143 (setq beg (or beg (point-min)) end (or end (point-max)))
17144 (goto-char (point-min))
17146 (substring (org-image-file-name-regexp) 0 -2)
17148 old file ov img)
17149 (while (re-search-forward re end t)
17150 (setq old (get-char-property-and-overlay (match-beginning 1)
17151 'org-image-overlay))
17152 (setq file (expand-file-name
17153 (concat (or (match-string 3) "") (match-string 4))))
17154 (when (file-exists-p file)
17155 (if (and (car-safe old) refresh)
17156 (image-refresh (overlay-get (cdr old) 'display))
17157 (setq img (save-match-data (create-image file)))
17158 (when img
17159 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
17160 (overlay-put ov 'display img)
17161 (overlay-put ov 'face 'default)
17162 (overlay-put ov 'org-image-overlay t)
17163 (overlay-put ov 'modification-hooks
17164 (list 'org-display-inline-modification-hook))
17165 (push ov org-inline-image-overlays)))))))))
17167 (defun org-display-inline-modification-hook (ov after beg end &optional len)
17168 "Remove inline-display overlay if a corresponding region is modified."
17169 (let ((inhibit-modification-hooks t))
17170 (when (and ov after)
17171 (delete ov org-inline-image-overlays)
17172 (delete-overlay ov))))
17174 (defun org-remove-inline-images ()
17175 "Remove inline display of images."
17176 (interactive)
17177 (mapc 'delete-overlay org-inline-image-overlays)
17178 (setq org-inline-image-overlays nil))
17180 ;;;; Key bindings
17182 ;; Outline functions from `outline-mode-prefix-map'
17183 ;; that can be remapped in Org:
17184 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
17185 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
17186 (define-key org-mode-map [remap outline-forward-same-level]
17187 'org-forward-same-level)
17188 (define-key org-mode-map [remap outline-backward-same-level]
17189 'org-backward-same-level)
17190 (define-key org-mode-map [remap show-branches]
17191 'org-kill-note-or-show-branches)
17192 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
17193 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
17194 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
17196 ;; Outline functions from `outline-mode-prefix-map'
17197 ;; that can not be remapped in Org:
17198 ;; - the column "key binding" shows whether the Outline function is still
17199 ;; available in Org mode on the same key that it has been bound to in
17200 ;; Outline mode:
17201 ;; - "overridden": key used for a different functionality in Org mode
17202 ;; - else: key still bound to the same Outline function in Org mode
17203 ;; | Outline function | key binding | Org replacement |
17204 ;; |------------------------------------+-------------+-----------------------|
17205 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
17206 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
17207 ;; | `show-children' | `C-c C-i' | visibility cycling |
17208 ;; | `hide-subtree' | overridden | visibility cycling |
17209 ;; | `outline-up-heading' | `C-c C-u' | still same function |
17210 ;; | `hide-body' | overridden | no replacement |
17211 ;; | `show-all' | overridden | no replacement |
17212 ;; | `hide-entry' | overridden | visibility cycling |
17213 ;; | `show-entry' | overridden | no replacement |
17214 ;; | `hide-leaves' | overridden | no replacement |
17215 ;; | `hide-sublevels' | overridden | no replacement |
17216 ;; | `hide-other' | overridden | no replacement |
17217 ;; | `outline-move-subtree-up' | `C-c C-^' | better: org-shiftup |
17218 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
17220 ;; Make `C-c C-x' a prefix key
17221 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
17223 ;; TAB key with modifiers
17224 (org-defkey org-mode-map "\C-i" 'org-cycle)
17225 (org-defkey org-mode-map [(tab)] 'org-cycle)
17226 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
17227 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
17229 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
17230 ;; The following line is necessary under Suse GNU/Linux
17231 (unless (featurep 'xemacs)
17232 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17233 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17234 (define-key org-mode-map [backtab] 'org-shifttab)
17236 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17237 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17238 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17240 ;; Cursor keys with modifiers
17241 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17242 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17243 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17244 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17246 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17247 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17248 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17249 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17251 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17252 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17253 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17254 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17256 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17257 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17258 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17259 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17261 ;; Babel keys
17262 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17263 (mapc (lambda (pair)
17264 (define-key org-babel-map (car pair) (cdr pair)))
17265 org-babel-key-bindings)
17267 ;;; Extra keys for tty access.
17268 ;; We only set them when really needed because otherwise the
17269 ;; menus don't show the simple keys
17271 (when (or org-use-extra-keys
17272 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17273 (not window-system))
17274 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17275 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17276 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17277 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17278 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17279 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17280 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17281 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17282 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17283 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17284 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17285 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17286 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17287 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17288 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17289 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
17290 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
17291 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
17292 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
17293 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
17294 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
17295 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
17296 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
17297 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
17298 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
17299 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
17300 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
17301 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
17303 ;; All the other keys
17305 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
17306 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
17307 (if (boundp 'narrow-map)
17308 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
17309 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
17310 (if (boundp 'narrow-map)
17311 (org-defkey narrow-map "b" 'org-narrow-to-block)
17312 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
17313 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
17314 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
17315 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
17316 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
17317 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
17318 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
17319 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
17320 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
17321 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
17322 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
17323 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
17324 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
17325 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
17326 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
17327 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
17328 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
17330 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
17331 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
17332 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
17333 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
17334 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
17335 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
17336 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
17337 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
17338 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
17339 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
17340 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
17341 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
17342 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
17343 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
17344 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
17345 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
17346 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
17347 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
17348 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
17349 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
17351 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
17352 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
17353 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
17354 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17355 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
17356 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
17357 (org-defkey org-mode-map "\C-c^" 'org-sort)
17358 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
17359 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
17360 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
17361 (org-defkey org-mode-map "\C-m" 'org-return)
17362 (org-defkey org-mode-map "\C-j" 'org-return-indent)
17363 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
17364 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
17365 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
17366 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
17367 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
17368 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
17369 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
17370 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
17371 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
17372 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
17373 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
17374 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
17375 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
17376 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
17377 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
17378 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
17379 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
17380 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
17381 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
17382 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
17383 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
17385 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
17386 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
17387 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
17388 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
17390 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
17391 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
17392 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
17393 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
17394 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
17395 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
17396 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
17397 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
17398 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
17399 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
17401 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
17402 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
17403 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
17404 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
17405 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
17406 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
17407 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
17409 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
17410 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
17411 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
17412 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
17413 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
17415 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
17417 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
17419 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
17420 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
17422 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
17425 (when (featurep 'xemacs)
17426 (org-defkey org-mode-map 'button3 'popup-mode-menu))
17429 (defconst org-speed-commands-default
17430 '(
17431 ("Outline Navigation")
17432 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
17433 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
17434 ("f" . (org-speed-move-safe 'org-forward-same-level))
17435 ("b" . (org-speed-move-safe 'org-backward-same-level))
17436 ("u" . (org-speed-move-safe 'outline-up-heading))
17437 ("j" . org-goto)
17438 ("g" . (org-refile t))
17439 ("Outline Visibility")
17440 ("c" . org-cycle)
17441 ("C" . org-shifttab)
17442 (" " . org-display-outline-path)
17443 ("Outline Structure Editing")
17444 ("U" . org-shiftmetaup)
17445 ("D" . org-shiftmetadown)
17446 ("r" . org-metaright)
17447 ("l" . org-metaleft)
17448 ("R" . org-shiftmetaright)
17449 ("L" . org-shiftmetaleft)
17450 ("i" . (progn (forward-char 1) (call-interactively
17451 'org-insert-heading-respect-content)))
17452 ("^" . org-sort)
17453 ("w" . org-refile)
17454 ("a" . org-archive-subtree-default-with-confirmation)
17455 ("." . org-mark-subtree)
17456 ("Clock Commands")
17457 ("I" . org-clock-in)
17458 ("O" . org-clock-out)
17459 ("Meta Data Editing")
17460 ("t" . org-todo)
17461 ("0" . (org-priority ?\ ))
17462 ("1" . (org-priority ?A))
17463 ("2" . (org-priority ?B))
17464 ("3" . (org-priority ?C))
17465 (";" . org-set-tags-command)
17466 ("e" . org-set-effort)
17467 ("Agenda Views etc")
17468 ("v" . org-agenda)
17469 ("/" . org-sparse-tree)
17470 ("Misc")
17471 ("o" . org-open-at-point)
17472 ("?" . org-speed-command-help)
17473 ("<" . (org-agenda-set-restriction-lock 'subtree))
17474 (">" . (org-agenda-remove-restriction-lock))
17475 )
17476 "The default speed commands.")
17478 (defun org-print-speed-command (e)
17479 (if (> (length (car e)) 1)
17480 (progn
17482 (princ (car e))
17484 (princ (make-string (length (car e)) ?-))
17486 (princ (car e))
17487 (princ " ")
17488 (if (symbolp (cdr e))
17489 (princ (symbol-name (cdr e)))
17490 (prin1 (cdr e)))
17493 (defun org-speed-command-help ()
17494 "Show the available speed commands."
17495 (interactive)
17496 (if (not org-use-speed-commands)
17497 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17498 (with-output-to-temp-buffer "*Help*"
17500 (mapc 'org-print-speed-command org-speed-commands-user)
17503 (mapc 'org-print-speed-command org-speed-commands-default))
17504 (with-current-buffer "*Help*"
17505 (setq truncate-lines t))))
17507 (defun org-speed-move-safe (cmd)
17508 "Execute CMD, but make sure that the cursor always ends up in a headline.
17509 If not, return to the original position and throw an error."
17510 (interactive)
17511 (let ((pos (point)))
17512 (call-interactively cmd)
17513 (unless (and (bolp) (org-at-heading-p))
17514 (goto-char pos)
17515 (error "Boundary reached while executing %s" cmd))))
17517 (defvar org-self-insert-command-undo-counter 0)
17519 (defvar org-table-auto-blank-field) ; defined in org-table.el
17520 (defvar org-speed-command nil)
17522 (defun org-speed-command-default-hook (keys)
17523 "Hook for activating single-letter speed commands.
17524 `org-speed-commands-default' specifies a minimal command set.
17525 Use `org-speed-commands-user' for further customization."
17526 (when (or (and (bolp) (looking-at org-outline-regexp))
17527 (and (functionp org-use-speed-commands)
17528 (funcall org-use-speed-commands)))
17529 (cdr (assoc keys (append org-speed-commands-user
17530 org-speed-commands-default)))))
17532 (defun org-babel-speed-command-hook (keys)
17533 "Hook for activating single-letter code block commands."
17534 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17535 (cdr (assoc keys org-babel-key-bindings))))
17537 (defcustom org-speed-command-hook
17538 '(org-speed-command-default-hook org-babel-speed-command-hook)
17539 "Hook for activating speed commands at strategic locations.
17540 Hook functions are called in sequence until a valid handler is
17541 found.
17543 Each hook takes a single argument, a user-pressed command key
17544 which is also a `self-insert-command' from the global map.
17546 Within the hook, examine the cursor position and the command key
17547 and return nil or a valid handler as appropriate. Handler could
17548 be one of an interactive command, a function, or a form.
17550 Set `org-use-speed-commands' to non-nil value to enable this
17551 hook. The default setting is `org-speed-command-default-hook'."
17552 :group 'org-structure
17553 :type 'hook)
17555 (defun org-self-insert-command (N)
17556 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17557 If the cursor is in a table looking at whitespace, the whitespace is
17558 overwritten, and the table is not marked as requiring realignment."
17559 (interactive "p")
17560 (org-check-before-invisible-edit 'insert)
17561 (cond
17562 ((and org-use-speed-commands
17563 (setq org-speed-command
17564 (run-hook-with-args-until-success
17565 'org-speed-command-hook (this-command-keys))))
17566 (cond
17567 ((commandp org-speed-command)
17568 (setq this-command org-speed-command)
17569 (call-interactively org-speed-command))
17570 ((functionp org-speed-command)
17571 (funcall org-speed-command))
17572 ((and org-speed-command (listp org-speed-command))
17573 (eval org-speed-command))
17574 (t (let (org-use-speed-commands)
17575 (call-interactively 'org-self-insert-command)))))
17576 ((and
17577 (org-table-p)
17578 (progn
17579 ;; check if we blank the field, and if that triggers align
17580 (and (featurep 'org-table) org-table-auto-blank-field
17581 (member last-command
17582 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17584 ;; got extra space, this field does not determine column width
17585 (let (org-table-may-need-update) (org-table-blank-field))
17586 ;; no extra space, this field may determine column width
17587 (org-table-blank-field)))
17588 t)
17589 (eq N 1)
17591 (let (org-table-may-need-update)
17592 (goto-char (1- (match-end 0)))
17593 (delete-char -1)
17594 (goto-char (match-beginning 0))
17595 (self-insert-command N)))
17596 (t
17597 (setq org-table-may-need-update t)
17598 (self-insert-command N)
17599 (org-fix-tags-on-the-fly)
17600 (if org-self-insert-cluster-for-undo
17601 (if (not (eq last-command 'org-self-insert-command))
17602 (setq org-self-insert-command-undo-counter 1)
17603 (if (>= org-self-insert-command-undo-counter 20)
17604 (setq org-self-insert-command-undo-counter 1)
17605 (and (> org-self-insert-command-undo-counter 0)
17606 buffer-undo-list (listp buffer-undo-list)
17607 (not (cadr buffer-undo-list)) ; remove nil entry
17608 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17609 (setq org-self-insert-command-undo-counter
17610 (1+ org-self-insert-command-undo-counter))))))))
17612 (defun org-check-before-invisible-edit (kind)
17613 "Check is editing if kind KIND would be dangerous with invisible text around.
17614 The detailed reaction depends on the user option `org-catch-invisible-edits'."
17615 ;; First, try to get out of here as quickly as possible, to reduce overhead
17616 (if (and org-catch-invisible-edits
17617 (or (not (boundp 'visible-mode)) (not visible-mode))
17618 (or (get-char-property (point) 'invisible)
17619 (get-char-property (max (point-min) (1- (point))) 'invisible)))
17620 ;; OK, we need to take a closer look
17621 (let* ((invisible-at-point (get-char-property (point) 'invisible))
17622 (invisible-before-point (if (bobp) nil (get-char-property
17623 (1- (point)) 'invisible)))
17624 (border-and-ok-direction
17625 (or
17626 ;; Check if we are acting predictably before invisible text
17627 (and invisible-at-point (not invisible-before-point)
17628 (memq kind '(insert delete-backward)))
17629 ;; Check if we are acting predictably after invisible text
17630 ;; This works not well, and I have turned it off. It seems
17631 ;; better to always show and stop after invisible text.
17632 ;; (and (not invisible-at-point) invisible-before-point
17633 ;; (memq kind '(insert delete)))
17634 )))
17636 (when (or (memq invisible-at-point '(outline org-hide-block))
17637 (memq invisible-before-point '(outline org-hide-block)))
17638 (if (eq org-catch-invisible-edits 'error)
17639 (error "Editing in invisible areas is prohibited - make visible first"))
17640 ;; Make the area visible
17641 (save-excursion
17642 (if invisible-before-point
17643 (goto-char (previous-single-char-property-change
17644 (point) 'invisible)))
17645 (org-cycle))
17646 (cond
17647 ((eq org-catch-invisible-edits 'show)
17648 ;; That's it, we do the edit after showing
17649 (message
17650 "Unfolding invisible region around point before editing")
17651 (sit-for 1))
17652 ((and (eq org-catch-invisible-edits 'smart)
17653 border-and-ok-direction)
17654 (message "Unfolding invisible region around point before editing"))
17655 (t
17656 ;; Don't do the edit, make the user repeat it in full visibility
17657 (error "Edit in invisible region aborted, repeat to confirm with text visible")))))))
17659 (defun org-fix-tags-on-the-fly ()
17660 (when (and (equal (char-after (point-at-bol)) ?*)
17661 (org-at-heading-p))
17662 (org-align-tags-here org-tags-column)))
17664 (defun org-delete-backward-char (N)
17665 "Like `delete-backward-char', insert whitespace at field end in tables.
17666 When deleting backwards, in tables this function will insert whitespace in
17668 still be marked for re-alignment if the field did fill the entire column,
17669 because, in this case the deletion might narrow the column."
17670 (interactive "p")
17671 (org-check-before-invisible-edit 'delete-backward)
17672 (if (and (org-table-p)
17673 (eq N 1)
17674 (string-match "|" (buffer-substring (point-at-bol) (point)))
17675 (looking-at ".*?|"))
17676 (let ((pos (point))
17678 (c org-table-may-need-update))
17679 (backward-delete-char N)
17680 (if (not overwrite-mode)
17681 (progn
17682 (skip-chars-forward "^|")
17683 (insert " ")
17684 (goto-char (1- pos))))
17685 ;; noalign: if there were two spaces at the end, this field
17686 ;; does not determine the width of the column.
17687 (if noalign (setq org-table-may-need-update c)))
17688 (backward-delete-char N)
17689 (org-fix-tags-on-the-fly)))
17691 (defun org-delete-char (N)
17692 "Like `delete-char', but insert whitespace at field end in tables.
17693 When deleting characters, in tables this function will insert whitespace in
17695 still be marked for re-alignment if the field did fill the entire column,
17696 because, in this case the deletion might narrow the column."
17697 (interactive "p")
17698 (org-check-before-invisible-edit 'delete)
17699 (if (and (org-table-p)
17700 (not (bolp))
17701 (not (= (char-after) ?|))
17702 (eq N 1))
17703 (if (looking-at ".*?|")
17704 (let ((pos (point))
17706 (c org-table-may-need-update))
17707 (replace-match (concat
17708 (substring (match-string 0) 1 -1)
17709 " |"))
17710 (goto-char pos)
17711 ;; noalign: if there were two spaces at the end, this field
17712 ;; does not determine the width of the column.
17713 (if noalign (setq org-table-may-need-update c)))
17714 (delete-char N))
17715 (delete-char N)
17716 (org-fix-tags-on-the-fly)))
17718 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17719 (put 'org-self-insert-command 'delete-selection t)
17720 (put 'orgtbl-self-insert-command 'delete-selection t)
17721 (put 'org-delete-char 'delete-selection 'supersede)
17722 (put 'org-delete-backward-char 'delete-selection 'supersede)
17723 (put 'org-yank 'delete-selection 'yank)
17725 ;; Make `flyspell-mode' delay after some commands
17726 (put 'org-self-insert-command 'flyspell-delayed t)
17727 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17728 (put 'org-delete-char 'flyspell-delayed t)
17729 (put 'org-delete-backward-char 'flyspell-delayed t)
17731 ;; Make pabbrev-mode expand after org-mode commands
17732 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17733 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17735 ;; How to do this: Measure non-white length of current string
17736 ;; If equal to column width, we should realign.
17738 (defun org-remap (map &rest commands)
17739 "In MAP, remap the functions given in COMMANDS.
17740 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17741 (let (new old)
17742 (while commands
17743 (setq old (pop commands) new (pop commands))
17744 (if (fboundp 'command-remapping)
17745 (org-defkey map (vector 'remap old) new)
17746 (substitute-key-definition old new map global-map)))))
17748 (when (eq org-enable-table-editor 'optimized)
17749 ;; If the user wants maximum table support, we need to hijack
17750 ;; some standard editing functions
17751 (org-remap org-mode-map
17752 'self-insert-command 'org-self-insert-command
17753 'delete-char 'org-delete-char
17754 'delete-backward-char 'org-delete-backward-char)
17755 (org-defkey org-mode-map "|" 'org-force-self-insert))
17757 (defvar org-ctrl-c-ctrl-c-hook nil
17758 "Hook for functions attaching themselves to `C-c C-c'.
17760 This can be used to add additional functionality to the C-c C-c
17761 key which executes context-dependent commands. This hook is run
17762 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17763 run after the last test.
17765 Each function will be called with no arguments. The function
17766 must check if the context is appropriate for it to act. If yes,
17767 it should do its thing and then return a non-nil value. If the
17768 context is wrong, just do nothing and return nil.")
17770 (defvar org-ctrl-c-ctrl-c-final-hook nil
17771 "Hook for functions attaching themselves to `C-c C-c'.
17773 This can be used to add additional functionality to the C-c C-c
17774 key which executes context-dependent commands. This hook is run
17775 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17776 before the first test.
17778 Each function will be called with no arguments. The function
17779 must check if the context is appropriate for it to act. If yes,
17780 it should do its thing and then return a non-nil value. If the
17781 context is wrong, just do nothing and return nil.")
17783 (defvar org-tab-first-hook nil
17784 "Hook for functions to attach themselves to TAB.
17785 See `org-ctrl-c-ctrl-c-hook' for more information.
17786 This hook runs as the first action when TAB is pressed, even before
17787 `org-cycle' messes around with the `outline-regexp' to cater for
17788 inline tasks and plain list item folding.
17789 If any function in this hook returns t, any other actions that
17790 would have been caused by TAB (such as table field motion or visibility
17791 cycling) will not occur.")
17793 (defvar org-tab-after-check-for-table-hook nil
17794 "Hook for functions to attach themselves to TAB.
17795 See `org-ctrl-c-ctrl-c-hook' for more information.
17796 This hook runs after it has been established that the cursor is not in a
17797 table, but before checking if the cursor is in a headline or if global cycling
17798 should be done.
17799 If any function in this hook returns t, not other actions like visibility
17800 cycling will be done.")
17802 (defvar org-tab-after-check-for-cycling-hook nil
17803 "Hook for functions to attach themselves to TAB.
17804 See `org-ctrl-c-ctrl-c-hook' for more information.
17805 This hook runs after it has been established that not table field motion and
17806 not visibility should be done because of current context. This is probably
17807 the place where a package like yasnippets can hook in.")
17809 (defvar org-tab-before-tab-emulation-hook nil
17810 "Hook for functions to attach themselves to TAB.
17811 See `org-ctrl-c-ctrl-c-hook' for more information.
17812 This hook runs after every other options for TAB have been exhausted, but
17815 (defvar org-metaleft-hook nil
17816 "Hook for functions attaching themselves to `M-left'.
17817 See `org-ctrl-c-ctrl-c-hook' for more information.")
17818 (defvar org-metaright-hook nil
17819 "Hook for functions attaching themselves to `M-right'.
17820 See `org-ctrl-c-ctrl-c-hook' for more information.")
17821 (defvar org-metaup-hook nil
17822 "Hook for functions attaching themselves to `M-up'.
17823 See `org-ctrl-c-ctrl-c-hook' for more information.")
17824 (defvar org-metadown-hook nil
17825 "Hook for functions attaching themselves to `M-down'.
17826 See `org-ctrl-c-ctrl-c-hook' for more information.")
17827 (defvar org-shiftmetaleft-hook nil
17828 "Hook for functions attaching themselves to `M-S-left'.
17829 See `org-ctrl-c-ctrl-c-hook' for more information.")
17830 (defvar org-shiftmetaright-hook nil
17831 "Hook for functions attaching themselves to `M-S-right'.
17832 See `org-ctrl-c-ctrl-c-hook' for more information.")
17833 (defvar org-shiftmetaup-hook nil
17834 "Hook for functions attaching themselves to `M-S-up'.
17835 See `org-ctrl-c-ctrl-c-hook' for more information.")
17836 (defvar org-shiftmetadown-hook nil
17837 "Hook for functions attaching themselves to `M-S-down'.
17838 See `org-ctrl-c-ctrl-c-hook' for more information.")
17839 (defvar org-metareturn-hook nil
17840 "Hook for functions attaching themselves to `M-RET'.
17841 See `org-ctrl-c-ctrl-c-hook' for more information.")
17842 (defvar org-shiftup-hook nil
17843 "Hook for functions attaching themselves to `S-up'.
17844 See `org-ctrl-c-ctrl-c-hook' for more information.")
17845 (defvar org-shiftup-final-hook nil
17846 "Hook for functions attaching themselves to `S-up'.
17847 This one runs after all other options except shift-select have been excluded.
17848 See `org-ctrl-c-ctrl-c-hook' for more information.")
17849 (defvar org-shiftdown-hook nil
17850 "Hook for functions attaching themselves to `S-down'.
17851 See `org-ctrl-c-ctrl-c-hook' for more information.")
17852 (defvar org-shiftdown-final-hook nil
17853 "Hook for functions attaching themselves to `S-down'.
17854 This one runs after all other options except shift-select have been excluded.
17855 See `org-ctrl-c-ctrl-c-hook' for more information.")
17856 (defvar org-shiftleft-hook nil
17857 "Hook for functions attaching themselves to `S-left'.
17858 See `org-ctrl-c-ctrl-c-hook' for more information.")
17859 (defvar org-shiftleft-final-hook nil
17860 "Hook for functions attaching themselves to `S-left'.
17861 This one runs after all other options except shift-select have been excluded.
17862 See `org-ctrl-c-ctrl-c-hook' for more information.")
17863 (defvar org-shiftright-hook nil
17864 "Hook for functions attaching themselves to `S-right'.
17865 See `org-ctrl-c-ctrl-c-hook' for more information.")
17866 (defvar org-shiftright-final-hook nil
17867 "Hook for functions attaching themselves to `S-right'.
17868 This one runs after all other options except shift-select have been excluded.
17869 See `org-ctrl-c-ctrl-c-hook' for more information.")
17871 (defun org-modifier-cursor-error ()
17872 "Throw an error, a modified cursor command was applied in wrong context."
17873 (error "This command is active in special context like tables, headlines or items"))
17875 (defun org-shiftselect-error ()
17876 "Throw an error because Shift-Cursor command was applied in wrong context."
17877 (if (and (boundp 'shift-select-mode) shift-select-mode)
17878 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17879 (error "This command works only in special context like headlines or timestamps")))
17881 (defun org-call-for-shift-select (cmd)
17882 (let ((this-command-keys-shift-translated t))
17883 (call-interactively cmd)))
17885 (defun org-shifttab (&optional arg)
17886 "Global visibility cycling or move to previous table field.
17887 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17888 on context.
17889 See the individual commands for more information."
17890 (interactive "P")
17891 (cond
17892 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17893 ((integerp arg)
17894 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17895 (message "Content view to level: %d" arg)
17896 (org-content (prefix-numeric-value arg2))
17897 (setq org-cycle-global-status 'overview)))
17898 (t (call-interactively 'org-global-cycle))))
17900 (defun org-shiftmetaleft ()
17901 "Promote subtree or delete table column.
17902 Calls `org-promote-subtree', `org-outdent-item',
17903 or `org-table-delete-column', depending on context.
17904 See the individual commands for more information."
17905 (interactive)
17906 (cond
17907 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17908 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17909 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
17910 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17911 (t (org-modifier-cursor-error))))
17913 (defun org-shiftmetaright ()
17914 "Demote subtree or insert table column.
17915 Calls `org-demote-subtree', `org-indent-item',
17916 or `org-table-insert-column', depending on context.
17917 See the individual commands for more information."
17918 (interactive)
17919 (cond
17920 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17921 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17922 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
17923 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17924 (t (org-modifier-cursor-error))))
17926 (defun org-shiftmetaup (&optional arg)
17927 "Move subtree up or kill table row.
17928 Calls `org-move-subtree-up' or `org-table-kill-row' or
17929 `org-move-item-up' depending on context. See the individual commands
17930 for more information."
17931 (interactive "P")
17932 (cond
17933 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17934 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17935 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
17936 ((org-at-item-p) (call-interactively 'org-move-item-up))
17937 (t (org-modifier-cursor-error))))
17939 (defun org-shiftmetadown (&optional arg)
17940 "Move subtree down or insert table row.
17941 Calls `org-move-subtree-down' or `org-table-insert-row' or
17942 `org-move-item-down', depending on context. See the individual
17943 commands for more information."
17944 (interactive "P")
17945 (cond
17946 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17947 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17948 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
17949 ((org-at-item-p) (call-interactively 'org-move-item-down))
17950 (t (org-modifier-cursor-error))))
17952 (defsubst org-hidden-tree-error ()
17953 (error
17954 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17956 (defun org-metaleft (&optional arg)
17957 "Promote heading or move table column to left.
17958 Calls `org-do-promote' or `org-table-move-column', depending on context.
17959 With no specific context, calls the Emacs default `backward-word'.
17960 See the individual commands for more information."
17961 (interactive "P")
17962 (cond
17963 ((run-hook-with-args-until-success 'org-metaleft-hook))
17964 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17965 ((org-with-limited-levels
17966 (or (org-at-heading-p)
17967 (and (org-region-active-p)
17968 (save-excursion
17969 (goto-char (region-beginning))
17970 (org-at-heading-p)))))
17971 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17972 (call-interactively 'org-do-promote))
17973 ;; At an inline task.
17974 ((org-at-heading-p)
17975 (call-interactively 'org-inlinetask-promote))
17976 ((or (org-at-item-p)
17977 (and (org-region-active-p)
17978 (save-excursion
17979 (goto-char (region-beginning))
17980 (org-at-item-p))))
17981 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17982 (call-interactively 'org-outdent-item))
17983 (t (call-interactively 'backward-word))))
17985 (defun org-metaright (&optional arg)
17986 "Demote subtree or move table column to right.
17987 Calls `org-do-demote' or `org-table-move-column', depending on context.
17988 With no specific context, calls the Emacs default `forward-word'.
17989 See the individual commands for more information."
17990 (interactive "P")
17991 (cond
17992 ((run-hook-with-args-until-success 'org-metaright-hook))
17993 ((org-at-table-p) (call-interactively 'org-table-move-column))
17994 ((org-with-limited-levels
17995 (or (org-at-heading-p)
17996 (and (org-region-active-p)
17997 (save-excursion
17998 (goto-char (region-beginning))
17999 (org-at-heading-p)))))
18000 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
18001 (call-interactively 'org-do-demote))
18002 ;; At an inline task.
18003 ((org-at-heading-p)
18004 (call-interactively 'org-inlinetask-demote))
18005 ((or (org-at-item-p)
18006 (and (org-region-active-p)
18007 (save-excursion
18008 (goto-char (region-beginning))
18009 (org-at-item-p))))
18010 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
18011 (call-interactively 'org-indent-item))
18012 (t (call-interactively 'forward-word))))
18014 (defun org-check-for-hidden (what)
18015 "Check if there are hidden headlines/items in the current visual line.
18016 WHAT can be either `headlines' or `items'. If the current line is
18017 an outline or item heading and it has a folded subtree below it,
18018 this function returns t, nil otherwise."
18019 (let ((re (cond
18020 ((eq what 'headlines) org-outline-regexp-bol)
18021 ((eq what 'items) (org-item-beginning-re))
18022 (t (error "This should not happen"))))
18023 beg end)
18024 (save-excursion
18025 (catch 'exit
18026 (unless (org-region-active-p)
18027 (setq beg (point-at-bol))
18028 (beginning-of-line 2)
18029 (while (and (not (eobp)) ;; this is like `next-line'
18030 (get-char-property (1- (point)) 'invisible))
18031 (beginning-of-line 2))
18032 (setq end (point))
18033 (goto-char beg)
18034 (goto-char (point-at-eol))
18035 (setq end (max end (point)))
18036 (while (re-search-forward re end t)
18037 (if (get-char-property (match-beginning 0) 'invisible)
18038 (throw 'exit t))))
18039 nil))))
18041 (defun org-metaup (&optional arg)
18042 "Move subtree up or move table row up.
18043 Calls `org-move-subtree-up' or `org-table-move-row' or
18044 `org-move-item-up', depending on context. See the individual commands
18045 for more information."
18046 (interactive "P")
18047 (cond
18048 ((run-hook-with-args-until-success 'org-metaup-hook))
18049 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
18050 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18051 ((org-at-item-p) (call-interactively 'org-move-item-up))
18052 (t (transpose-lines 1) (beginning-of-line -1))))
18054 (defun org-metadown (&optional arg)
18055 "Move subtree down or move table row down.
18056 Calls `org-move-subtree-down' or `org-table-move-row' or
18057 `org-move-item-down', depending on context. See the individual
18058 commands for more information."
18059 (interactive "P")
18060 (cond
18061 ((run-hook-with-args-until-success 'org-metadown-hook))
18062 ((org-at-table-p) (call-interactively 'org-table-move-row))
18063 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18064 ((org-at-item-p) (call-interactively 'org-move-item-down))
18065 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
18067 (defun org-shiftup (&optional arg)
18068 "Increase item in timestamp or increase priority of current headline.
18069 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
18070 depending on context. See the individual commands for more information."
18071 (interactive "P")
18072 (cond
18073 ((run-hook-with-args-until-success 'org-shiftup-hook))
18074 ((and org-support-shift-select (org-region-active-p))
18075 (org-call-for-shift-select 'previous-line))
18076 ((org-at-timestamp-p t)
18077 (call-interactively (if org-edit-timestamp-down-means-later
18078 'org-timestamp-down 'org-timestamp-up)))
18079 ((and (not (eq org-support-shift-select 'always))
18080 org-enable-priority-commands
18081 (org-at-heading-p))
18082 (call-interactively 'org-priority-up))
18083 ((and (not org-support-shift-select) (org-at-item-p))
18084 (call-interactively 'org-previous-item))
18085 ((org-clocktable-try-shift 'up arg))
18086 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
18087 (org-support-shift-select
18088 (org-call-for-shift-select 'previous-line))
18089 (t (org-shiftselect-error))))
18091 (defun org-shiftdown (&optional arg)
18092 "Decrease item in timestamp or decrease priority of current headline.
18093 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
18094 depending on context. See the individual commands for more information."
18095 (interactive "P")
18096 (cond
18097 ((run-hook-with-args-until-success 'org-shiftdown-hook))
18098 ((and org-support-shift-select (org-region-active-p))
18099 (org-call-for-shift-select 'next-line))
18100 ((org-at-timestamp-p t)
18101 (call-interactively (if org-edit-timestamp-down-means-later
18102 'org-timestamp-up 'org-timestamp-down)))
18103 ((and (not (eq org-support-shift-select 'always))
18104 org-enable-priority-commands
18105 (org-at-heading-p))
18106 (call-interactively 'org-priority-down))
18107 ((and (not org-support-shift-select) (org-at-item-p))
18108 (call-interactively 'org-next-item))
18109 ((org-clocktable-try-shift 'down arg))
18110 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
18111 (org-support-shift-select
18112 (org-call-for-shift-select 'next-line))
18113 (t (org-shiftselect-error))))
18115 (defun org-shiftright (&optional arg)
18116 "Cycle the thing at point or in the current line, depending on context.
18117 Depending on context, this does one of the following:
18119 - switch a timestamp at point one day into the future
18120 - on a headline, switch to the next TODO keyword.
18121 - on an item, switch entire list to the next bullet type
18122 - on a property line, switch to the next allowed value
18123 - on a clocktable definition line, move time block into the future"
18124 (interactive "P")
18125 (cond
18126 ((run-hook-with-args-until-success 'org-shiftright-hook))
18127 ((and org-support-shift-select (org-region-active-p))
18128 (org-call-for-shift-select 'forward-char))
18129 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
18130 ((and (not (eq org-support-shift-select 'always))
18131 (org-at-heading-p))
18132 (let ((org-inhibit-logging
18133 (not org-treat-S-cursor-todo-selection-as-state-change))
18134 (org-inhibit-blocking
18135 (not org-treat-S-cursor-todo-selection-as-state-change)))
18136 (org-call-with-arg 'org-todo 'right)))
18137 ((or (and org-support-shift-select
18138 (not (eq org-support-shift-select 'always))
18139 (org-at-item-bullet-p))
18140 (and (not org-support-shift-select) (org-at-item-p)))
18141 (org-call-with-arg 'org-cycle-list-bullet nil))
18142 ((and (not (eq org-support-shift-select 'always))
18143 (org-at-property-p))
18144 (call-interactively 'org-property-next-allowed-value))
18145 ((org-clocktable-try-shift 'right arg))
18146 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
18147 (org-support-shift-select
18148 (org-call-for-shift-select 'forward-char))
18149 (t (org-shiftselect-error))))
18151 (defun org-shiftleft (&optional arg)
18152 "Cycle the thing at point or in the current line, depending on context.
18153 Depending on context, this does one of the following:
18155 - switch a timestamp at point one day into the past
18156 - on a headline, switch to the previous TODO keyword.
18157 - on an item, switch entire list to the previous bullet type
18158 - on a property line, switch to the previous allowed value
18159 - on a clocktable definition line, move time block into the past"
18160 (interactive "P")
18161 (cond
18162 ((run-hook-with-args-until-success 'org-shiftleft-hook))
18163 ((and org-support-shift-select (org-region-active-p))
18164 (org-call-for-shift-select 'backward-char))
18165 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
18166 ((and (not (eq org-support-shift-select 'always))
18167 (org-at-heading-p))
18168 (let ((org-inhibit-logging
18169 (not org-treat-S-cursor-todo-selection-as-state-change))
18170 (org-inhibit-blocking
18171 (not org-treat-S-cursor-todo-selection-as-state-change)))
18172 (org-call-with-arg 'org-todo 'left)))
18173 ((or (and org-support-shift-select
18174 (not (eq org-support-shift-select 'always))
18175 (org-at-item-bullet-p))
18176 (and (not org-support-shift-select) (org-at-item-p)))
18177 (org-call-with-arg 'org-cycle-list-bullet 'previous))
18178 ((and (not (eq org-support-shift-select 'always))
18179 (org-at-property-p))
18180 (call-interactively 'org-property-previous-allowed-value))
18181 ((org-clocktable-try-shift 'left arg))
18182 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
18183 (org-support-shift-select
18184 (org-call-for-shift-select 'backward-char))
18185 (t (org-shiftselect-error))))
18187 (defun org-shiftcontrolright ()
18188 "Switch to next TODO set."
18189 (interactive)
18190 (cond
18191 ((and org-support-shift-select (org-region-active-p))
18192 (org-call-for-shift-select 'forward-word))
18193 ((and (not (eq org-support-shift-select 'always))
18194 (org-at-heading-p))
18195 (org-call-with-arg 'org-todo 'nextset))
18196 (org-support-shift-select
18197 (org-call-for-shift-select 'forward-word))
18198 (t (org-shiftselect-error))))
18200 (defun org-shiftcontrolleft ()
18201 "Switch to previous TODO set."
18202 (interactive)
18203 (cond
18204 ((and org-support-shift-select (org-region-active-p))
18205 (org-call-for-shift-select 'backward-word))
18206 ((and (not (eq org-support-shift-select 'always))
18207 (org-at-heading-p))
18208 (org-call-with-arg 'org-todo 'previousset))
18209 (org-support-shift-select
18210 (org-call-for-shift-select 'backward-word))
18211 (t (org-shiftselect-error))))
18213 (defun org-shiftcontrolup ()
18214 "Change timestamps synchronously up in CLOCK log lines."
18215 (interactive)
18216 (cond ((and (not org-support-shift-select)
18217 (org-at-clock-log-p)
18218 (org-at-timestamp-p t))
18219 (org-clock-timestamps-up))
18220 (t (org-shiftselect-error))))
18222 (defun org-shiftcontroldown ()
18223 "Change timestamps synchronously down in CLOCK log lines."
18224 (interactive)
18225 (cond ((and (not org-support-shift-select)
18226 (org-at-clock-log-p)
18227 (org-at-timestamp-p t))
18228 (org-clock-timestamps-down))
18229 (t (org-shiftselect-error))))
18231 (defun org-ctrl-c-ret ()
18232 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
18233 (interactive)
18234 (cond
18235 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
18236 (t (call-interactively 'org-insert-heading))))
18238 (defun org-find-visible ()
18239 (let ((s (point)))
18240 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18241 (get-char-property s 'invisible)))
18242 s))
18243 (defun org-find-invisible ()
18244 (let ((s (point)))
18245 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18246 (not (get-char-property s 'invisible))))
18247 s))
18249 (defun org-copy-visible (beg end)
18250 "Copy the visible parts of the region."
18251 (interactive "r")
18252 (let (snippets s)
18253 (save-excursion
18254 (save-restriction
18255 (narrow-to-region beg end)
18256 (setq s (goto-char (point-min)))
18257 (while (not (= (point) (point-max)))
18258 (goto-char (org-find-invisible))
18259 (push (buffer-substring s (point)) snippets)
18260 (setq s (goto-char (org-find-visible))))))
18261 (kill-new (apply 'concat (nreverse snippets)))))
18263 (defun org-copy-special ()
18264 "Copy region in table or copy current subtree.
18265 Calls `org-table-copy' or `org-copy-subtree', depending on context.
18266 See the individual commands for more information."
18267 (interactive)
18268 (call-interactively
18269 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
18271 (defun org-cut-special ()
18272 "Cut region in table or cut current subtree.
18273 Calls `org-table-copy' or `org-cut-subtree', depending on context.
18274 See the individual commands for more information."
18275 (interactive)
18276 (call-interactively
18277 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
18279 (defun org-paste-special (arg)
18280 "Paste rectangular region into table, or past subtree relative to level.
18281 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18282 See the individual commands for more information."
18283 (interactive "P")
18284 (if (org-at-table-p)
18285 (org-table-paste-rectangle)
18286 (org-paste-subtree arg)))
18288 (defun org-edit-special (&optional arg)
18289 "Call a special editor for the stuff at point.
18290 When at a table, call the formula editor with `org-table-edit-formulas'.
18291 When at the first line of an src example, call `org-edit-src-code'.
18292 When in an #+include line, visit the include file. Otherwise call
18293 `ffap' to visit the file at point."
18294 (interactive)
18295 ;; possibly prep session before editing source
18296 (when arg
18297 (let* ((info (org-babel-get-src-block-info))
18298 (lang (nth 0 info))
18299 (params (nth 2 info))
18300 (session (cdr (assoc :session params))))
18301 (when (and info session) ;; we are in a source-code block with a session
18302 (funcall
18303 (intern (concat "org-babel-prep-session:" lang)) session params))))
18304 (cond ;; proceed with `org-edit-special'
18305 ((save-excursion
18306 (beginning-of-line 1)
18307 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
18308 (find-file (org-trim (match-string 1))))
18309 ((org-edit-src-code))
18310 ((org-edit-fixed-width-region))
18311 ((org-at-table.el-p)
18312 (org-edit-src-code))
18313 ((or (org-at-table-p)
18314 (save-excursion
18315 (beginning-of-line 1)
18317 (call-interactively 'org-table-edit-formulas))
18318 (t (call-interactively 'ffap))))
18320 (defvar org-table-coordinate-overlays) ; defined in org-table.el
18321 (defun org-ctrl-c-ctrl-c (&optional arg)
18322 "Set tags in headline, or update according to changed information at point.
18324 This command does many different things, depending on context:
18326 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
18327 this is what we do.
18329 - If the cursor is on a statistics cookie, update it.
18331 - If the cursor is in a headline, prompt for tags and insert them
18332 into the current line, aligned to `org-tags-column'. When called
18333 with prefix arg, realign all tags in the current buffer.
18335 - If the cursor is in one of the special #+KEYWORD lines, this
18336 triggers scanning the buffer for these lines and updating the
18337 information.
18339 - If the cursor is inside a table, realign the table. This command
18340 works even if the automatic table editor has been turned off.
18342 - If the cursor is on a #+TBLFM line, re-apply the formulas to
18343 the entire table.
18345 - If the cursor is at a footnote reference or definition, jump to
18346 the corresponding definition or references, respectively.
18348 - If the cursor is a the beginning of a dynamic block, update it.
18350 - If the current buffer is a capture buffer, close note and file it.
18352 - If the cursor is on a <<<target>>>, update radio targets and
18353 corresponding links in this buffer.
18355 - If the cursor is on a numbered item in a plain list, renumber the
18356 ordered list.
18358 - If the cursor is on a checkbox, toggle it.
18360 - If the cursor is on a code block, evaluate it. The variable
18361 `org-confirm-babel-evaluate' can be used to control prompting
18362 before code block evaluation, by default every code block
18363 evaluation requires confirmation. Code block evaluation can be
18364 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
18365 (interactive "P")
18366 (let ((org-enable-table-editor t))
18367 (cond
18368 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
18369 org-occur-highlights
18370 org-latex-fragment-image-overlays)
18371 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
18372 (org-remove-occur-highlights)
18373 (org-remove-latex-fragment-image-overlays)
18374 (message "Temporary highlights/overlays removed from current buffer"))
18375 ((and (local-variable-p 'org-finish-function (current-buffer))
18376 (fboundp org-finish-function))
18377 (funcall org-finish-function))
18378 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
18379 ((org-in-regexp org-ts-regexp-both)
18380 (org-timestamp-change 0 'day))
18381 ((or (looking-at org-property-start-re)
18382 (org-at-property-p))
18383 (call-interactively 'org-property-action))
18384 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
18386 (or (org-at-heading-p) (org-at-item-p)))
18387 (call-interactively 'org-update-statistics-cookies))
18388 ((org-at-heading-p) (call-interactively 'org-set-tags))
18389 ((org-at-table.el-p)
18390 (message "Use C-c ' to edit table.el tables"))
18391 ((org-at-table-p)
18392 (org-table-maybe-eval-formula)
18393 (if arg
18394 (call-interactively 'org-table-recalculate)
18395 (org-table-maybe-recalculate-line))
18396 (call-interactively 'org-table-align)
18397 (orgtbl-send-table 'maybe))
18398 ((or (org-footnote-at-reference-p)
18399 (org-footnote-at-definition-p))
18400 (call-interactively 'org-footnote-action))
18401 ((org-at-item-checkbox-p)
18402 ;; Cursor at a checkbox: repair list and update checkboxes. Send
18403 ;; list only if at top item.
18404 (let* ((cbox (match-string 1))
18405 (struct (org-list-struct))
18406 (old-struct (copy-tree struct))
18407 (parents (org-list-parents-alist struct))
18408 (orderedp (org-entry-get nil "ORDERED"))
18409 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18410 block-item)
18411 ;; Use a light version of `org-toggle-checkbox' to avoid
18412 ;; computing list structure twice.
18413 (let ((new-box (cond
18414 ((equal arg '(16)) "[-]")
18415 ((equal arg '(4)) nil)
18416 ((equal "[X]" cbox) "[ ]")
18417 (t "[X]"))))
18418 (if (and firstp arg)
18419 ;; If at first item of sub-list, remove check-box from
18420 ;; every item at the same level.
18421 (mapc
18422 (lambda (pos) (org-list-set-checkbox pos struct new-box))
18423 (org-list-get-all-items
18424 (point-at-bol) struct (org-list-prevs-alist struct)))
18425 (org-list-set-checkbox (point-at-bol) struct new-box)))
18426 ;; Replicate `org-list-write-struct', while grabbing a return
18427 ;; value from `org-list-struct-fix-box'.
18428 (org-list-struct-fix-ind struct parents 2)
18429 (org-list-struct-fix-item-end struct)
18430 (let ((prevs (org-list-prevs-alist struct)))
18431 (org-list-struct-fix-bul struct prevs)
18432 (org-list-struct-fix-ind struct parents)
18433 (setq block-item
18434 (org-list-struct-fix-box struct parents prevs orderedp)))
18435 (org-list-struct-apply-struct struct old-struct)
18436 (org-update-checkbox-count-maybe)
18437 (when block-item
18438 (message
18439 "Checkboxes were removed due to unchecked box at line %d"
18440 (org-current-line block-item)))
18441 (when firstp (org-list-send-list 'maybe))))
18442 ((org-at-item-p)
18443 ;; Cursor at an item: repair list. Do checkbox related actions
18444 ;; only if function was called with an argument. Send list only
18445 ;; if at top item.
18446 (let* ((struct (org-list-struct))
18447 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18448 old-struct)
18449 (when arg
18450 (setq old-struct (copy-tree struct))
18451 (if firstp
18452 ;; If at first item of sub-list, add check-box to every
18453 ;; item at the same level.
18454 (mapc
18455 (lambda (pos)
18456 (unless (org-list-get-checkbox pos struct)
18457 (org-list-set-checkbox pos struct "[ ]")))
18458 (org-list-get-all-items
18459 (point-at-bol) struct (org-list-prevs-alist struct)))
18460 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
18461 (org-list-write-struct
18462 struct (org-list-parents-alist struct) old-struct)
18463 (when arg (org-update-checkbox-count-maybe))
18464 (when firstp (org-list-send-list 'maybe))))
18465 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
18466 ;; Dynamic block
18467 (beginning-of-line 1)
18468 (save-excursion (org-update-dblock)))
18469 ((save-excursion
18470 (beginning-of-line 1)
18472 (cond
18473 ((equal (match-string 1) "TBLFM")
18474 ;; Recalculate the table before this line
18475 (save-excursion
18476 (beginning-of-line 1)
18478 (if (org-at-table-p)
18479 (org-call-with-arg 'org-table-recalculate (or arg t)))))
18480 (t
18481 (let ((org-inhibit-startup-visibility-stuff t)
18482 (org-startup-align-all-tables nil))
18483 (when (boundp 'org-table-coordinate-overlays)
18484 (mapc 'delete-overlay org-table-coordinate-overlays)
18485 (setq org-table-coordinate-overlays nil))
18486 (org-save-outline-visibility 'use-markers (org-mode-restart)))
18487 (message "Local setup has been refreshed"))))
18488 ((org-clock-update-time-maybe))
18489 (t
18490 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
18491 (error "C-c C-c can do nothing useful at this location"))))))
18493 (defun org-mode-restart ()
18494 "Restart Org-mode, to scan again for special lines.
18495 Also updates the keyword regular expressions."
18496 (interactive)
18497 (org-mode)
18498 (message "Org-mode restarted"))
18500 (defun org-kill-note-or-show-branches ()
18501 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
18502 (interactive)
18503 (if (not org-finish-function)
18504 (progn
18505 (hide-subtree)
18506 (call-interactively 'show-branches))
18507 (let ((org-note-abort t))
18508 (funcall org-finish-function))))
18510 (defun org-return (&optional indent)
18511 "Goto next table row or insert a newline.
18512 Calls `org-table-next-row' or `newline', depending on context.
18513 See the individual commands for more information."
18514 (interactive)
18515 (cond
18516 ((bobp) (if indent (newline-and-indent) (newline)))
18517 ((org-at-table-p)
18518 (org-table-justify-field-maybe)
18519 (call-interactively 'org-table-next-row))
18520 ;; when `newline-and-indent' is called within a list, make sure
18521 ;; text moved stays inside the item.
18522 ((and (org-in-item-p) indent)
18523 (if (and (org-at-item-p) (>= (point) (match-end 0)))
18524 (progn
18525 (save-match-data (newline))
18526 (org-indent-line-to (length (match-string 0))))
18527 (let ((ind (org-get-indentation)))
18528 (newline)
18529 (if (org-looking-back org-list-end-re)
18530 (org-indent-line-function)
18531 (org-indent-line-to ind)))))
18532 ((and org-return-follows-link
18533 (let ((tprop (get-text-property (point) 'face)))
18534 (or (eq tprop 'org-link)
18535 (and (listp tprop) (memq 'org-link tprop)))))
18536 (call-interactively 'org-open-at-point))
18537 ((and (org-at-heading-p)
18538 (looking-at
18540 (org-show-entry)
18541 (end-of-line 1)
18542 (newline))
18543 (t (if indent (newline-and-indent) (newline)))))
18545 (defun org-return-indent ()
18546 "Goto next table row or insert a newline and indent.
18547 Calls `org-table-next-row' or `newline-and-indent', depending on
18548 context. See the individual commands for more information."
18549 (interactive)
18550 (org-return t))
18552 (defun org-ctrl-c-star ()
18553 "Compute table, or change heading status of lines.
18554 Calls `org-table-recalculate' or `org-toggle-heading',
18555 depending on context."
18556 (interactive)
18557 (cond
18558 ((org-at-table-p)
18559 (call-interactively 'org-table-recalculate))
18560 (t
18561 ;; Convert all lines in region to list items
18562 (call-interactively 'org-toggle-heading))))
18564 (defun org-ctrl-c-minus ()
18565 "Insert separator line in table or modify bullet status of line.
18566 Also turns a plain line or a region of lines into list items.
18567 Calls `org-table-insert-hline', `org-toggle-item', or
18568 `org-cycle-list-bullet', depending on context."
18569 (interactive)
18570 (cond
18571 ((org-at-table-p)
18572 (call-interactively 'org-table-insert-hline))
18573 ((org-region-active-p)
18574 (call-interactively 'org-toggle-item))
18575 ((org-in-item-p)
18576 (call-interactively 'org-cycle-list-bullet))
18577 (t
18578 (call-interactively 'org-toggle-item))))
18580 (defun org-toggle-item (arg)
18581 "Convert headings or normal lines to items, items to normal lines.
18582 If there is no active region, only the current line is considered.
18584 If the first non blank line in the region is an headline, convert
18585 all headlines to items, shifting text accordingly.
18587 If it is an item, convert all items to normal lines.
18589 If it is normal text, change region into an item. With a prefix
18590 argument ARG, change each line in region into an item."
18591 (interactive "P")
18592 (let ((shift-text
18593 (function
18594 ;; Shift text in current section to IND, from point to END.
18595 ;; The function leaves point to END line.
18596 (lambda (ind end)
18597 (let ((min-i 1000) (end (copy-marker end)))
18598 ;; First determine the minimum indentation (MIN-I) of
18599 ;; the text.
18600 (save-excursion
18601 (catch 'exit
18602 (while (< (point) end)
18603 (let ((i (org-get-indentation)))
18604 (cond
18605 ;; Skip blank lines and inline tasks.
18607 ((looking-at org-outline-regexp-bol))
18608 ;; We can't find less than 0 indentation.
18609 ((zerop i) (throw 'exit (setq min-i 0)))
18610 ((< i min-i) (setq min-i i))))
18611 (forward-line))))
18612 ;; Then indent each line so that a line indented to
18613 ;; MIN-I becomes indented to IND. Ignore blank lines
18614 ;; and inline tasks in the process.
18615 (let ((delta (- ind min-i)))
18616 (while (< (point) end)
18618 (looking-at org-outline-regexp-bol))
18619 (org-indent-line-to (+ (org-get-indentation) delta)))
18620 (forward-line)))))))
18621 (skip-blanks
18622 (function
18623 ;; Return beginning of first non-blank line, starting from
18624 ;; line at POS.
18625 (lambda (pos)
18626 (save-excursion
18627 (goto-char pos)
18629 (point-at-bol)))))
18630 beg end)
18631 ;; Determine boundaries of changes.
18632 (if (org-region-active-p)
18633 (setq beg (funcall skip-blanks (region-beginning))
18634 end (copy-marker (region-end)))
18635 (setq beg (funcall skip-blanks (point-at-bol))
18636 end (copy-marker (point-at-eol))))
18637 ;; Depending on the starting line, choose an action on the text
18638 ;; between BEG and END.
18639 (org-with-limited-levels
18640 (save-excursion
18641 (goto-char beg)
18642 (cond
18643 ;; Case 1. Start at an item: de-itemize. Note that it only
18644 ;; happens when a region is active: `org-ctrl-c-minus'
18645 ;; would call `org-cycle-list-bullet' otherwise.
18646 ((org-at-item-p)
18647 (while (< (point) end)
18648 (when (org-at-item-p)
18650 (delete-region (point) (match-end 0)))
18651 (forward-line)))
18652 ;; Case 2. Start at an heading: convert to items.
18653 ((org-at-heading-p)
18654 (let* ((bul (org-list-bullet-string "-"))
18655 (bul-len (length bul))
18656 ;; Indentation of the first heading. It should be
18657 ;; relative to the indentation of its parent, if any.
18658 (start-ind (save-excursion
18659 (cond
18660 ((not org-adapt-indentation) 0)
18661 ((not (outline-previous-heading)) 0)
18662 (t (length (match-string 0))))))
18663 ;; Level of first heading. Further headings will be
18664 ;; compared to it to determine hierarchy in the list.
18665 (ref-level (org-reduced-level (org-outline-level))))
18666 (while (< (point) end)
18667 (let* ((level (org-reduced-level (org-outline-level)))
18668 (delta (max 0 (- level ref-level))))
18669 ;; If current headline is less indented than the first
18670 ;; one, set it as reference, in order to preserve
18671 ;; subtrees.
18672 (when (< level ref-level) (setq ref-level level))
18673 (replace-match bul t t)
18674 (org-indent-line-to (+ start-ind (* delta bul-len)))
18675 ;; Ensure all text down to END (or SECTION-END) belongs
18676 ;; to the newly created item.
18677 (let ((section-end (save-excursion
18678 (or (outline-next-heading) (point)))))
18679 (forward-line)
18680 (funcall shift-text
18681 (+ start-ind (* (1+ delta) bul-len))
18682 (min end section-end)))))))
18683 ;; Case 3. Normal line with ARG: turn each non-item line into
18684 ;; an item.
18685 (arg
18686 (while (< (point) end)
18687 (unless (or (org-at-heading-p) (org-at-item-p))
18689 (replace-match
18691 (forward-line)))
18692 ;; Case 4. Normal line without ARG: make the first line of
18693 ;; region an item, and shift indentation of others
18694 ;; lines to set them as item's body.
18695 (t (let* ((bul (org-list-bullet-string "-"))
18696 (bul-len (length bul))
18697 (ref-ind (org-get-indentation)))
18699 (insert bul)
18700 (forward-line)
18701 (while (< (point) end)
18702 ;; Ensure that lines less indented than first one
18703 ;; still get included in item body.
18704 (funcall shift-text
18705 (+ ref-ind bul-len)
18706 (min end (save-excursion (or (outline-next-heading)
18707 (point)))))
18708 (forward-line)))))))))
18710 (defun org-toggle-heading (&optional nstars)
18711 "Convert headings to normal text, or items or text to headings.
18712 If there is no active region, only the current line is considered.
18714 If the first non blank line is an headline, remove the stars from
18715 all headlines in the region.
18717 If it is a plain list item, turn all plain list items into headings.
18719 If it is a normal line, turn each and every normal line (i.e. not
18720 an heading or an item) in the region into a heading.
18722 When converting a line into a heading, the number of stars is chosen
18723 such that the lines become children of the current entry. However,
18724 when a prefix argument is given, its value determines the number of
18725 stars to add."
18726 (interactive "P")
18727 (let ((skip-blanks
18728 (function
18729 ;; Return beginning of first non-blank line, starting from
18730 ;; line at POS.
18731 (lambda (pos)
18732 (save-excursion
18733 (goto-char pos)
18735 (point-at-bol)))))
18736 beg end)
18737 ;; Determine boundaries of changes. If region ends at a bol, do
18738 ;; not consider the last line to be in the region.
18739 (if (org-region-active-p)
18740 (setq beg (funcall skip-blanks (region-beginning))
18741 end (copy-marker (save-excursion
18742 (goto-char (region-end))
18743 (if (bolp) (point) (point-at-eol)))))
18744 (setq beg (funcall skip-blanks (point-at-bol))
18745 end (copy-marker (point-at-eol))))
18746 ;; Ensure inline tasks don't count as headings.
18747 (org-with-limited-levels
18748 (save-excursion
18749 (goto-char beg)
18750 (cond
18751 ;; Case 1. Started at an heading: de-star headings.
18752 ((org-at-heading-p)
18753 (while (< (point) end)
18754 (when (org-at-heading-p t)
18755 (looking-at org-outline-regexp) (replace-match ""))
18756 (forward-line)))
18757 ;; Case 2. Started at an item: change items into headlines.
18758 ;; One star will be added by `org-list-to-subtree'.
18759 ((org-at-item-p)
18760 (let* ((stars (make-string
18761 (if nstars
18762 ;; subtract the star that will be added again by
18763 ;; `org-list-to-subtree'
18764 (1- (prefix-numeric-value current-prefix-arg))
18765 (or (org-current-level) 0))
18766 ?*))
18767 (add-stars
18768 (cond (nstars "") ; stars from prefix only
18769 ((equal stars "") "") ; before first heading
18770 (org-odd-levels-only "*") ; inside heading, odd
18771 (t "")))) ; inside heading, oddeven
18772 (while (< (point) end)
18773 (when (org-at-item-p)
18774 ;; Pay attention to cases when region ends before list.
18775 (let* ((struct (org-list-struct))
18776 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18777 (save-restriction
18778 (narrow-to-region (point) list-end)
18779 (insert
18780 (org-list-to-subtree
18781 (org-list-parse-list t)
18782 '(:istart (concat stars add-stars (funcall get-stars depth))
18783 :icount (concat stars add-stars (funcall get-stars depth))))))))
18784 (forward-line))))
18785 ;; Case 3. Started at normal text: make every line an heading,
18786 ;; skipping headlines and items.
18787 (t (let* ((stars (make-string
18788 (if nstars
18789 (prefix-numeric-value current-prefix-arg)
18790 (or (org-current-level) 0))
18791 ?*))
18792 (add-stars
18793 (cond (nstars "") ; stars from prefix only
18794 ((equal stars "") "*") ; before first heading
18795 (org-odd-levels-only "**") ; inside heading, odd
18796 (t "*"))) ; inside heading, oddeven
18797 (rpl (concat stars add-stars " ")))
18798 (while (< (point) end)
18799 (when (and (not (org-at-heading-p)) (not (org-at-item-p))
18801 (replace-match (concat rpl (match-string 2))))
18802 (forward-line)))))))))
18804 (defun org-meta-return (&optional arg)
18805 "Insert a new heading or wrap a region in a table.
18806 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18807 See the individual commands for more information."
18808 (interactive "P")
18809 (cond
18810 ((run-hook-with-args-until-success 'org-metareturn-hook))
18811 ((org-at-table-p)
18812 (call-interactively 'org-table-wrap-region))
18813 (t (call-interactively 'org-insert-heading))))
18815 ;;; Menu entries
18817 ;; Define the Org-mode menus
18818 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18819 '("Tbl"
18820 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18821 ["Next Field" org-cycle (org-at-table-p)]
18822 ["Previous Field" org-shifttab (org-at-table-p)]
18823 ["Next Row" org-return (org-at-table-p)]
18824 "--"
18825 ["Blank Field" org-table-blank-field (org-at-table-p)]
18826 ["Edit Field" org-table-edit-field (org-at-table-p)]
18827 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18828 "--"
18829 ("Column"
18830 ["Move Column Left" org-metaleft (org-at-table-p)]
18831 ["Move Column Right" org-metaright (org-at-table-p)]
18832 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18833 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18834 ("Row"
18835 ["Move Row Up" org-metaup (org-at-table-p)]
18836 ["Move Row Down" org-metadown (org-at-table-p)]
18837 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18838 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18839 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18840 "--"
18841 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18842 ("Rectangle"
18843 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18844 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18845 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18846 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18847 "--"
18848 ("Calculate"
18849 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18850 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18851 ["Edit Formulas" org-edit-special (org-at-table-p)]
18852 "--"
18853 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18854 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18855 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18856 "--"
18857 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18858 "--"
18859 ["Sum Column/Rectangle" org-table-sum
18860 (or (org-at-table-p) (org-region-active-p))]
18861 ["Which Column?" org-table-current-column (org-at-table-p)])
18862 ["Debug Formulas"
18863 org-table-toggle-formula-debugger
18864 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18865 ["Show Col/Row Numbers"
18866 org-table-toggle-coordinate-overlays
18867 :style toggle
18868 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18869 "--"
18870 ["Create" org-table-create (and (not (org-at-table-p))
18871 org-enable-table-editor)]
18872 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18873 ["Import from File" org-table-import (not (org-at-table-p))]
18874 ["Export to File" org-table-export (org-at-table-p)]
18875 "--"
18876 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18878 (easy-menu-define org-org-menu org-mode-map "Org menu"
18879 '("Org"
18880 ("Show/Hide"
18881 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18882 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18883 ["Sparse Tree..." org-sparse-tree t]
18884 ["Reveal Context" org-reveal t]
18885 ["Show All" show-all t]
18886 "--"
18887 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18888 "--"
18889 ["New Heading" org-insert-heading t]
18890 ("Navigate Headings"
18891 ["Up" outline-up-heading t]
18892 ["Next" outline-next-visible-heading t]
18893 ["Previous" outline-previous-visible-heading t]
18894 ["Next Same Level" outline-forward-same-level t]
18895 ["Previous Same Level" outline-backward-same-level t]
18896 "--"
18897 ["Jump" org-goto t])
18898 ("Edit Structure"
18899 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18900 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18901 "--"
18902 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18903 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18904 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18905 "--"
18906 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18907 "--"
18908 ["Copy visible text" org-copy-visible t]
18909 "--"
18910 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18911 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18912 ["Demote Heading" org-metaright (not (org-at-table-p))]
18913 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18914 "--"
18915 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18916 "--"
18917 ["Convert to odd levels" org-convert-to-odd-levels t]
18918 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18919 ("Editing"
18920 ["Emphasis..." org-emphasize t]
18921 ["Edit Source Example" org-edit-special t]
18922 "--"
18923 ["Footnote new/jump" org-footnote-action t]
18924 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18925 ("Archive"
18926 ["Archive (default method)" org-archive-subtree-default t]
18927 "--"
18928 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18929 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18930 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18931 )
18932 "--"
18933 ("Hyperlinks"
18934 ["Store Link (Global)" org-store-link t]
18935 ["Find existing link to here" org-occur-link-in-agenda-files t]
18936 ["Insert Link" org-insert-link t]
18937 ["Follow Link" org-open-at-point t]
18938 "--"
18939 ["Next link" org-next-link t]
18940 ["Previous link" org-previous-link t]
18941 "--"
18942 ["Descriptive Links"
18943 org-toggle-link-display
18944 :style radio
18945 :selected org-descriptive-links
18946 ]
18947 ["Literal Links"
18948 org-toggle-link-display
18949 :style radio
18950 :selected (not org-descriptive-links)])
18951 "--"
18952 ("TODO Lists"
18953 ["TODO/DONE/-" org-todo t]
18954 ("Select keyword"
18955 ["Next keyword" org-shiftright (org-at-heading-p)]
18956 ["Previous keyword" org-shiftleft (org-at-heading-p)]
18957 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18958 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
18959 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
18960 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18961 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18962 "--"
18963 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18964 :selected org-enforce-todo-dependencies :style toggle :active t]
18965 "Settings for tree at point"
18966 ["Do Children sequentially" org-toggle-ordered-property :style radio
18967 :selected (org-entry-get nil "ORDERED")
18968 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18969 ["Do Children parallel" org-toggle-ordered-property :style radio
18970 :selected (not (org-entry-get nil "ORDERED"))
18971 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18972 "--"
18973 ["Set Priority" org-priority t]
18974 ["Priority Up" org-shiftup t]
18975 ["Priority Down" org-shiftdown t]
18976 "--"
18977 ["Get news from all feeds" org-feed-update-all t]
18978 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18979 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18980 ("TAGS and Properties"
18981 ["Set Tags" org-set-tags-command t]
18982 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18983 "--"
18984 ["Set property" org-set-property t]
18985 ["Column view of properties" org-columns t]
18986 ["Insert Column View DBlock" org-insert-columns-dblock t])
18987 ("Dates and Scheduling"
18988 ["Timestamp" org-time-stamp t]
18989 ["Timestamp (inactive)" org-time-stamp-inactive t]
18990 ("Change Date"
18991 ["1 Day Later" org-shiftright t]
18992 ["1 Day Earlier" org-shiftleft t]
18993 ["1 ... Later" org-shiftup t]
18994 ["1 ... Earlier" org-shiftdown t])
18995 ["Compute Time Range" org-evaluate-time-range t]
18996 ["Schedule Item" org-schedule t]
18997 ["Deadline" org-deadline t]
18998 "--"
18999 ["Custom time format" org-toggle-time-stamp-overlays
19000 :style radio :selected org-display-custom-times]
19001 "--"
19002 ["Goto Calendar" org-goto-calendar t]
19003 ["Date from Calendar" org-date-from-calendar t]
19004 "--"
19005 ["Start/Restart Timer" org-timer-start t]
19006 ["Pause/Continue Timer" org-timer-pause-or-continue t]
19007 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
19008 ["Insert Timer String" org-timer t]
19009 ["Insert Timer Item" org-timer-item t])
19010 ("Logging work"
19011 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
19012 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
19013 ["Clock out" org-clock-out t]
19014 ["Clock cancel" org-clock-cancel t]
19015 "--"
19016 ["Mark as default task" org-clock-mark-default-task t]
19017 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
19018 ["Goto running clock" org-clock-goto t]
19019 "--"
19020 ["Display times" org-clock-display t]
19021 ["Create clock table" org-clock-report t]
19022 "--"
19023 ["Record DONE time"
19024 (progn (setq org-log-done (not org-log-done))
19025 (message "Switching to %s will %s record a timestamp"
19026 (car org-done-keywords)
19027 (if org-log-done "automatically" "not")))
19028 :style toggle :selected org-log-done])
19029 "--"
19030 ["Agenda Command..." org-agenda t]
19031 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
19032 ("File List for Agenda")
19033 ("Special views current file"
19034 ["TODO Tree" org-show-todo-tree t]
19035 ["Check Deadlines" org-check-deadlines t]
19036 ["Timeline" org-timeline t]
19037 ["Tags/Property tree" org-match-sparse-tree t])
19038 "--"
19039 ["Export/Publish..." org-export t]
19040 ("LaTeX"
19041 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
19042 :selected org-cdlatex-mode]
19043 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
19044 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
19045 ["Modify math symbol" org-cdlatex-math-modify
19046 (org-inside-LaTeX-fragment-p)]
19047 ["Insert citation" org-reftex-citation t]
19048 "--"
19049 ["Template for BEAMER" org-insert-beamer-options-template t])
19050 "--"
19051 ("MobileOrg"
19052 ["Push Files and Views" org-mobile-push t]
19053 ["Get Captured and Flagged" org-mobile-pull t]
19054 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
19055 "--"
19056 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
19057 "--"
19058 ("Documentation"
19059 ["Show Version" org-version t]
19060 ["Info Documentation" org-info t])
19061 ("Customize"
19062 ["Browse Org Group" org-customize t]
19063 "--"
19064 ["Expand This Menu" org-create-customize-menu
19065 (fboundp 'customize-menu-create)])
19066 ["Send bug report" org-submit-bug-report t]
19067 "--"
19068 ("Refresh/Reload"
19069 ["Refresh setup current buffer" org-mode-restart t]
19070 ["Reload Org (after update)" org-reload t]
19071 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
19072 ))
19074 (defun org-info (&optional node)
19075 "Read documentation for Org-mode in the info system.
19076 With optional NODE, go directly to that node."
19077 (interactive)
19078 (info (format "(org)%s" (or node ""))))
19080 ;;;###autoload
19081 (defun org-submit-bug-report ()
19082 "Submit a bug report on Org-mode via mail.
19084 Don't hesitate to report any problems or inaccurate documentation.
19086 If you don't have setup sending mail from (X)Emacs, please copy the
19087 output buffer into your mail program, as it gives us important
19088 information about your Org-mode version and configuration."
19089 (interactive)
19090 (require 'reporter)
19091 (org-load-modules-maybe)
19092 (org-require-autoloaded-modules)
19093 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
19094 (reporter-submit-bug-report
19095 "emacs-orgmode@gnu.org"
19096 (org-version)
19097 (let (list)
19098 (save-window-excursion
19099 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
19100 (delete-other-windows)
19101 (erase-buffer)
19102 (insert "You are about to submit a bug report to the Org-mode mailing list.
19104 We would like to add your full Org-mode and Outline configuration to the
19105 bug report. This greatly simplifies the work of the maintainer and
19106 other experts on the mailing list.
19108 HOWEVER, some variables you have customized may contain private
19109 information. The names of customers, colleagues, or friends, might
19110 appear in the form of file names, tags, todo states, or search strings.
19111 If you answer yes to the prompt, you might want to check and remove
19112 such private information before sending the email.")
19113 (add-text-properties (point-min) (point-max) '(face org-warning))
19114 (when (yes-or-no-p "Include your Org-mode configuration ")
19115 (mapatoms
19116 (lambda (v)
19117 (and (boundp v)
19119 (or (and (symbol-value v)
19121 (and
19122 (get v 'custom-type) (get v 'standard-value)
19123 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
19124 (push v list)))))
19125 (kill-buffer (get-buffer "*Warn about privacy*"))
19126 list))
19127 nil nil
19128 "Remember to cover the basics, that is, what you expected to happen and
19129 what in fact did happen. You don't know how to make a good report? See
19131 http://orgmode.org/manual/Feedback.html#Feedback
19133 Your bug report will be posted to the Org-mode mailing list.
19134 ------------------------------------------------------------------------")
19135 (save-excursion
19140 (defun org-install-agenda-files-menu ()
19141 (let ((bl (buffer-list)))
19142 (save-excursion
19143 (while bl
19144 (set-buffer (pop bl))
19145 (if (eq major-mode 'org-mode) (setq bl nil)))
19146 (when (eq major-mode 'org-mode)
19147 (easy-menu-change
19148 '("Org") "File List for Agenda"
19149 (append
19150 (list
19151 ["Edit File List" (org-edit-agenda-file-list) t]
19152 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
19153 ["Remove Current File from List" org-remove-file t]
19154 ["Cycle through agenda files" org-cycle-agenda-files t]
19155 ["Occur in all agenda files" org-occur-in-agenda-files t]
19156 "--")
19157 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
19159 ;;;; Documentation
19161 ;;;###autoload
19162 (defun org-require-autoloaded-modules ()
19163 (interactive)
19164 (mapc 'require
19165 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
19166 org-docbook org-exp org-html org-icalendar
19167 org-id org-latex
19168 org-publish org-remember org-table
19169 org-timer org-xoxo)))
19171 ;;;###autoload
19172 (defun org-reload (&optional uncompiled)
19173 "Reload all org lisp files.
19174 With prefix arg UNCOMPILED, load the uncompiled versions."
19175 (interactive "P")
19176 (require 'find-func)
19178 (dir-org (file-name-directory (org-find-library-name "org")))
19179 (dir-org-contrib (ignore-errors
19180 (file-name-directory
19181 (org-find-library-name "org-contribdir"))))
19182 (babel-files
19183 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
19184 (append (list nil "comint" "eval" "exp" "keys"
19185 "lob" "ref" "table" "tangle")
19186 (delq nil
19187 (mapcar
19188 (lambda (lang)
19189 (when (cdr lang) (symbol-name (car lang))))
19190 org-babel-load-languages)))))
19191 (files
19192 (append (directory-files dir-org t file-re)
19193 babel-files
19194 (and dir-org-contrib
19195 (directory-files dir-org-contrib t file-re))))
19196 (remove-re (concat (if (featurep 'xemacs)
19197 "org-colview" "org-colview-xemacs")
19199 (setq files (mapcar 'file-name-sans-extension files))
19200 (setq files (mapcar
19201 (lambda (x) (if (string-match remove-re x) nil x))
19202 files))
19203 (setq files (delq nil files))
19204 (mapc
19205 (lambda (f)
19206 (when (featurep (intern (file-name-nondirectory f)))
19207 (if (and (not uncompiled)
19208 (file-exists-p (concat f ".elc")))
19209 (load (concat f ".elc") nil nil t)
19210 (load (concat f ".el") nil nil t))))
19211 files))
19212 (org-version))
19214 ;;;###autoload
19215 (defun org-customize ()
19216 "Call the customize function with org as argument."
19217 (interactive)
19218 (org-load-modules-maybe)
19219 (org-require-autoloaded-modules)
19220 (customize-browse 'org))
19222 (defun org-create-customize-menu ()
19223 "Create a full customization menu for Org-mode, insert it into the menu."
19224 (interactive)
19225 (org-load-modules-maybe)
19226 (org-require-autoloaded-modules)
19227 (if (fboundp 'customize-menu-create)
19228 (progn
19229 (easy-menu-change
19230 '("Org") "Customize"
19231 `(["Browse Org group" org-customize t]
19232 "--"
19233 ,(customize-menu-create 'org)
19234 ["Set" Custom-set t]
19235 ["Save" Custom-save t]
19236 ["Reset to Current" Custom-reset-current t]
19237 ["Reset to Saved" Custom-reset-saved t]
19238 ["Reset to Standard Settings" Custom-reset-standard t]))
19240 (error "Cannot expand menu (outdated version of cus-edit.el)")))
19242 ;;;; Miscellaneous stuff
19244 ;;; Generally useful functions
19246 (defun org-get-at-bol (property)
19247 "Get text property PROPERTY at beginning of line."
19248 (get-text-property (point-at-bol) property))
19250 (defun org-find-text-property-in-string (prop s)
19251 "Return the first non-nil value of property PROP in string S."
19252 (or (get-text-property 0 prop s)
19253 (get-text-property (or (next-single-property-change 0 prop s) 0)
19254 prop s)))
19256 (defun org-display-warning (message) ;; Copied from Emacs-Muse
19257 "Display the given MESSAGE as a warning."
19258 (if (fboundp 'display-warning)
19259 (display-warning 'org message
19260 (if (featurep 'xemacs) 'warning :warning))
19261 (let ((buf (get-buffer-create "*Org warnings*")))
19262 (with-current-buffer buf
19263 (goto-char (point-max))
19264 (insert "Warning (Org): " message)
19265 (unless (bolp)
19266 (newline)))
19267 (display-buffer buf)
19268 (sit-for 0))))
19270 (defun org-eval (form)
19271 "Eval FORM and return result."
19272 (condition-case error
19273 (eval form)
19274 (error (format "%%![Error: %s]" error))))
19276 (defun org-in-clocktable-p ()
19277 "Check if the cursor is in a clocktable."
19278 (let ((pos (point)) start)
19279 (save-excursion
19280 (end-of-line 1)
19282 (setq start (match-beginning 0))
19284 (>= (match-end 0) pos)
19285 start))))
19287 (defun org-in-commented-line ()
19288 "Is point in a line starting with `#'?"
19289 (equal (char-after (point-at-bol)) ?#))
19291 (defun org-in-indented-comment-line ()
19292 "Is point in a line starting with `#' after some white space?"
19293 (save-excursion
19294 (save-match-data
19295 (goto-char (point-at-bol))
19298 (defun org-in-verbatim-emphasis ()
19299 (save-match-data
19300 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
19302 (defun org-goto-marker-or-bmk (marker &optional bookmark)
19303 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
19304 (if (and marker (marker-buffer marker)
19305 (buffer-live-p (marker-buffer marker)))
19306 (progn
19307 (org-pop-to-buffer-same-window (marker-buffer marker))
19308 (if (or (> marker (point-max)) (< marker (point-min)))
19309 (widen))
19310 (goto-char marker)
19311 (org-show-context 'org-goto))
19312 (if bookmark
19313 (bookmark-jump bookmark)
19314 (error "Cannot find location"))))
19316 (defun org-quote-csv-field (s)
19317 "Quote field for inclusion in CSV material."
19320 s))
19322 (defun org-force-self-insert (N)
19323 "Needed to enforce self-insert under remapping."
19324 (interactive "p")
19325 (self-insert-command N))
19327 (defun org-string-width (s)
19328 "Compute width of string, ignoring invisible characters.
19329 This ignores character with invisibility property `org-link', and also
19330 characters with property `org-cwidth', because these will become invisible
19331 upon the next fontification round."
19332 (let (b l)
19333 (when (or (eq t buffer-invisibility-spec)
19334 (assq 'org-link buffer-invisibility-spec))
19335 (while (setq b (text-property-any 0 (length s)
19336 'invisible 'org-link s))
19337 (setq s (concat (substring s 0 b)
19338 (substring s (or (next-single-property-change
19339 b 'invisible s) (length s)))))))
19340 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
19341 (setq s (concat (substring s 0 b)
19342 (substring s (or (next-single-property-change
19343 b 'org-cwidth s) (length s))))))
19344 (setq l (string-width s) b -1)
19345 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
19346 (setq l (- l (get-text-property b 'org-dwidth-n s))))
19347 l))
19349 (defun org-shorten-string (s maxlength)
19350 "Shorten string S so tht it is no longer than MAXLENGTH characters.
19351 If the string is shorter or has length MAXLENGTH, just return the
19352 original string. If it is longer, the functions finds a space in the
19353 string, breaks this string off at that locations and adds three dots
19354 as ellipsis. Including the ellipsis, the string will not be longer
19355 than MAXLENGTH. If finding a good breaking point in the string does
19356 not work, the string is just chopped off in the middle of a word
19357 if necessary."
19358 (if (<= (length s) maxlength)
19359 s
19360 (let* ((n (max (- maxlength 4) 1))
19362 (if (string-match re s)
19363 (concat (match-string 1 s) "...")
19364 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
19366 (defun org-get-indentation (&optional line)
19367 "Get the indentation of the current line, interpreting tabs.
19368 When LINE is given, assume it represents a line and compute its indentation."
19369 (if line
19370 (if (string-match "^ *" (org-remove-tabs line))
19371 (match-end 0))
19372 (save-excursion
19373 (beginning-of-line 1)
19375 (current-column))))
19377 (defun org-get-string-indentation (s)
19378 "What indentation has S due to SPACE and TAB at the beginning of the string?"
19379 (let ((n -1) (i 0) (w tab-width) c)
19380 (catch 'exit
19381 (while (< (setq n (1+ n)) (length s))
19382 (setq c (aref s n))
19383 (cond ((= c ?\ ) (setq i (1+ i)))
19385 (t (throw 'exit t)))))
19386 i))
19388 (defun org-remove-tabs (s &optional width)
19389 "Replace tabulators in S with spaces.
19390 Assumes that s is a single line, starting in column 0."
19391 (setq width (or width tab-width))
19393 (setq s (replace-match
19394 (make-string
19395 (- (* width (/ (+ (match-beginning 0) width) width))
19396 (match-beginning 0)) ?\ )
19397 t t s)))
19398 s)
19400 (defun org-fix-indentation (line ind)
19401 "Fix indentation in LINE.
19402 IND is a cons cell with target and minimum indentation.
19403 If the current indentation in LINE is smaller than the minimum,
19404 leave it alone. If it is larger than ind, set it to the target."
19405 (let* ((l (org-remove-tabs line))
19406 (i (org-get-indentation l))
19407 (i1 (car ind)) (i2 (cdr ind)))
19408 (if (>= i i2) (setq l (substring line i2)))
19409 (if (> i1 0)
19410 (concat (make-string i1 ?\ ) l)
19411 l)))
19413 (defun org-remove-indentation (code &optional n)
19414 "Remove the maximum common indentation from the lines in CODE.
19415 N may optionally be the number of spaces to remove."
19416 (with-temp-buffer
19417 (insert code)
19418 (org-do-remove-indentation n)
19419 (buffer-string)))
19421 (defun org-do-remove-indentation (&optional n)
19422 "Remove the maximum common indentation from the buffer."
19423 (untabify (point-min) (point-max))
19424 (let ((min 10000) re)
19425 (if n
19426 (setq min n)
19427 (goto-char (point-min))
19429 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
19430 (unless (or (= min 0) (= min 10000))
19432 (goto-char (point-min))
19433 (while (re-search-forward re nil t)
19434 (replace-match "")
19435 (end-of-line 1))
19436 min)))
19438 (defun org-fill-template (template alist)
19439 "Find each %key of ALIST in TEMPLATE and replace it."
19440 (let ((case-fold-search nil)
19441 entry key value)
19442 (setq alist (sort (copy-sequence alist)
19443 (lambda (a b) (< (length (car a)) (length (car b))))))
19444 (while (setq entry (pop alist))
19445 (setq template
19446 (replace-regexp-in-string
19447 (concat "%" (regexp-quote (car entry)))
19448 (cdr entry) template t t)))
19449 template))
19451 (defun org-base-buffer (buffer)
19452 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
19453 (if (not buffer)
19454 buffer
19455 (or (buffer-base-buffer buffer)
19456 buffer)))
19458 (defun org-trim (s)
19459 "Remove whitespace at beginning and end of string."
19462 s)
19464 (defun org-wrap (string &optional width lines)
19465 "Wrap string to either a number of lines, or a width in characters.
19466 If WIDTH is non-nil, the string is wrapped to that width, however many lines
19467 that costs. If there is a word longer than WIDTH, the text is actually
19468 wrapped to the length of that word.
19469 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
19470 many lines, whatever width that takes.
19471 The return value is a list of lines, without newlines at the end."
19473 (maxword (apply 'max (mapcar 'org-string-width words)))
19474 w ll)
19475 (cond (width
19476 (org-do-wrap words (max maxword width)))
19477 (lines
19478 (setq w maxword)
19479 (setq ll (org-do-wrap words maxword))
19480 (if (<= (length ll) lines)
19481 ll
19482 (setq ll words)
19483 (while (> (length ll) lines)
19484 (setq w (1+ w))
19485 (setq ll (org-do-wrap words w)))
19486 ll))
19487 (t (error "Cannot wrap this")))))
19489 (defun org-do-wrap (words width)
19490 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
19491 (let (lines line)
19492 (while words
19493 (setq line (pop words))
19494 (while (and words (< (+ (length line) (length (car words))) width))
19495 (setq line (concat line " " (pop words))))
19496 (setq lines (push line lines)))
19497 (nreverse lines)))
19499 (defun org-split-string (string &optional separators)
19500 "Splits STRING into substrings at SEPARATORS.
19501 No empty strings are returned if there are matches at the beginning
19502 and end of string."
19504 (start 0)
19505 notfirst
19506 (list nil))
19507 (while (and (string-match rexp string
19508 (if (and notfirst
19509 (= start (match-beginning 0))
19510 (< start (length string)))
19511 (1+ start) start))
19512 (< (match-beginning 0) (length string)))
19513 (setq notfirst t)
19514 (or (eq (match-beginning 0) 0)
19515 (and (eq (match-beginning 0) (match-end 0))
19516 (eq (match-beginning 0) start))
19517 (setq list
19518 (cons (substring string start (match-beginning 0))
19519 list)))
19520 (setq start (match-end 0)))
19521 (or (eq start (length string))
19522 (setq list
19523 (cons (substring string start)
19524 list)))
19525 (nreverse list)))
19527 (defun org-quote-vert (s)
19529 (while (string-match "|" s)
19531 s)
19533 (defun org-uuidgen-p (s)
19534 "Is S an ID created by UUIDGEN?"
19535 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
19537 (defun org-context ()
19538 "Return a list of contexts of the current cursor position.
19539 If several contexts apply, all are returned.
19540 Each context entry is a list with a symbol naming the context, and
19541 two positions indicating start and end of the context. Possible
19542 contexts are:
19544 :headline anywhere in a headline
19545 :headline-stars on the leading stars in a headline
19546 :todo-keyword on a TODO keyword (including DONE) in a headline
19547 :tags on the TAGS in a headline
19548 :priority on the priority cookie in a headline
19549 :item on the first line of a plain list item
19550 :item-bullet on the bullet/number of a plain list item
19551 :checkbox on the checkbox in a plain list item
19552 :table in an org-mode table
19553 :table-special on a special filed in a table
19554 :table-table in a table.el table
19555 :link on a hyperlink
19556 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
19557 :target on a <<target>>
19558 :radio-target on a <<<radio-target>>>
19559 :latex-fragment on a LaTeX fragment
19560 :latex-preview on a LaTeX fragment with overlaid preview image
19562 This function expects the position to be visible because it uses font-lock
19563 faces as a help to recognize the following contexts: :table-special, :link,
19564 and :keyword."
19565 (let* ((f (get-text-property (point) 'face))
19566 (faces (if (listp f) f (list f)))
19567 (p (point)) clist o)
19568 ;; First the large context
19569 (cond
19570 ((org-at-heading-p t)
19571 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19572 (when (progn
19573 (beginning-of-line 1)
19574 (looking-at org-todo-line-tags-regexp))
19575 (push (org-point-in-group p 1 :headline-stars) clist)
19576 (push (org-point-in-group p 2 :todo-keyword) clist)
19577 (push (org-point-in-group p 4 :tags) clist))
19578 (goto-char p)
19581 (push (org-point-in-group p 0 :priority) clist)))
19583 ((org-at-item-p)
19584 (push (org-point-in-group p 2 :item-bullet) clist)
19585 (push (list :item (point-at-bol)
19586 (save-excursion (org-end-of-item) (point)))
19587 clist)
19588 (and (org-at-item-checkbox-p)
19589 (push (org-point-in-group p 0 :checkbox) clist)))
19591 ((org-at-table-p)
19592 (push (list :table (org-table-begin) (org-table-end)) clist)
19593 (if (memq 'org-formula faces)
19594 (push (list :table-special
19595 (previous-single-property-change p 'face)
19596 (next-single-property-change p 'face)) clist)))
19597 ((org-at-table-p 'any)
19598 (push (list :table-table) clist)))
19599 (goto-char p)
19601 ;; Now the small context
19602 (cond
19603 ((org-at-timestamp-p)
19604 (push (org-point-in-group p 0 :timestamp) clist))
19605 ((memq 'org-link faces)
19606 (push (list :link
19607 (previous-single-property-change p 'face)
19608 (next-single-property-change p 'face)) clist))
19609 ((memq 'org-special-keyword faces)
19610 (push (list :keyword
19611 (previous-single-property-change p 'face)
19612 (next-single-property-change p 'face)) clist))
19613 ((org-at-target-p)
19614 (push (org-point-in-group p 0 :target) clist)
19615 (goto-char (1- (match-beginning 0)))
19616 (if (looking-at org-radio-target-regexp)
19617 (push (org-point-in-group p 0 :radio-target) clist))
19618 (goto-char p))
19619 ((setq o (car (delq nil
19620 (mapcar
19621 (lambda (x)
19622 (if (memq x org-latex-fragment-image-overlays) x))
19623 (overlays-at (point))))))
19624 (push (list :latex-fragment
19625 (overlay-start o) (overlay-end o)) clist)
19626 (push (list :latex-preview
19627 (overlay-start o) (overlay-end o)) clist))
19628 ((org-inside-LaTeX-fragment-p)
19629 ;; FIXME: positions wrong.
19630 (push (list :latex-fragment (point) (point)) clist)))
19632 (setq clist (nreverse (delq nil clist)))
19633 clist))
19635 ;; FIXME: Compare with at-regexp-p Do we need both?
19636 (defun org-in-regexp (re &optional nlines visually)
19637 "Check if point is inside a match of regexp.
19638 Normally only the current line is checked, but you can include NLINES extra
19639 lines both before and after point into the search.
19640 If VISUALLY is set, require that the cursor is not after the match but
19641 really on, so that the block visually is on the match."
19642 (catch 'exit
19643 (let ((pos (point))
19644 (eol (point-at-eol (+ 1 (or nlines 0))))
19645 (inc (if visually 1 0)))
19646 (save-excursion
19647 (beginning-of-line (- 1 (or nlines 0)))
19648 (while (re-search-forward re eol t)
19649 (if (and (<= (match-beginning 0) pos)
19650 (>= (+ inc (match-end 0)) pos))
19651 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19653 (defun org-at-regexp-p (regexp)
19654 "Is point inside a match of REGEXP in the current line?"
19655 (catch 'exit
19656 (save-excursion
19657 (let ((pos (point)) (end (point-at-eol)))
19658 (beginning-of-line 1)
19659 (while (re-search-forward regexp end t)
19660 (if (and (<= (match-beginning 0) pos)
19661 (>= (match-end 0) pos))
19662 (throw 'exit t)))
19663 nil))))
19665 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19666 "Non-nil when point is between matches of START-RE and END-RE.
19668 Also return a non-nil value when point is on one of the matches.
19670 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19671 buffer positions. Default values are the positions of headlines
19672 surrounding the point.
19674 The functions returns a cons cell whose car (resp. cdr) is the
19675 position before START-RE (resp. after END-RE)."
19676 (save-match-data
19677 (let ((pos (point))
19678 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19679 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19680 beg end)
19681 (save-excursion
19682 ;; Point is on a block when on START-RE or if START-RE can be
19683 ;; found before it...
19684 (and (or (org-at-regexp-p start-re)
19685 (re-search-backward start-re limit-up t))
19686 (setq beg (match-beginning 0))
19687 ;; ... and END-RE after it...
19688 (goto-char (match-end 0))
19689 (re-search-forward end-re limit-down t)
19690 (> (setq end (match-end 0)) pos)
19691 ;; ... without another START-RE in-between.
19692 (goto-char (match-beginning 0))
19693 (not (re-search-backward start-re (1+ beg) t))
19694 ;; Return value.
19695 (cons beg end))))))
19697 (defun org-in-block-p (names)
19698 "Non-nil when point belongs to a block whose name belongs to NAMES.
19700 NAMES is a list of strings containing names of blocks.
19702 Return first block name matched, or nil. Beware that in case of
19703 nested blocks, the returned name may not belong to the closest
19704 block from point."
19705 (save-match-data
19706 (catch 'exit
19707 (let ((case-fold-search t)
19708 (lim-up (save-excursion (outline-previous-heading)))
19709 (lim-down (save-excursion (outline-next-heading))))
19710 (mapc (lambda (name)
19711 (let ((n (regexp-quote name)))
19712 (when (org-between-regexps-p
19715 lim-up lim-down)
19716 (throw 'exit n))))
19717 names))
19718 nil)))
19720 (defun org-occur-in-agenda-files (regexp &optional nlines)
19721 "Call `multi-occur' with buffers for all agenda files."
19723 (let* ((files (org-agenda-files))
19724 (tnames (mapcar 'file-truename files))
19725 (extra org-agenda-text-search-extra-files)
19726 f)
19727 (when (eq (car extra) 'agenda-archives)
19728 (setq extra (cdr extra))
19729 (setq files (org-add-archive-files files)))
19730 (while (setq f (pop extra))
19731 (unless (member (file-truename f) tnames)
19732 (add-to-list 'files f 'append)
19733 (add-to-list 'tnames (file-truename f) 'append)))
19734 (multi-occur
19735 (mapcar (lambda (x)
19736 (with-current-buffer
19737 (or (get-file-buffer x) (find-file-noselect x))
19738 (widen)
19739 (current-buffer)))
19740 files)
19741 regexp)))
19743 (if (boundp 'occur-mode-find-occurrence-hook)
19744 ;; Emacs 23
19745 (add-hook 'occur-mode-find-occurrence-hook
19746 (lambda ()
19747 (when (eq major-mode 'org-mode)
19748 (org-reveal))))
19749 ;; Emacs 22
19750 (defadvice occur-mode-goto-occurrence
19751 (after org-occur-reveal activate)
19752 (and (eq major-mode 'org-mode) (org-reveal)))
19753 (defadvice occur-mode-goto-occurrence-other-window
19754 (after org-occur-reveal activate)
19755 (and (eq major-mode 'org-mode) (org-reveal)))
19756 (defadvice occur-mode-display-occurrence
19757 (after org-occur-reveal activate)
19758 (when (eq major-mode 'org-mode)
19759 (let ((pos (occur-mode-find-occurrence)))
19760 (with-current-buffer (marker-buffer pos)
19761 (save-excursion
19762 (goto-char pos)
19763 (org-reveal)))))))
19765 (defun org-occur-link-in-agenda-files ()
19766 "Create a link and search for it in the agendas.
19767 The link is not stored in `org-stored-links', it is just created
19768 for the search purpose."
19769 (interactive)
19770 (let ((link (condition-case nil
19771 (org-store-link nil)
19772 (error "Unable to create a link to here"))))
19773 (org-occur-in-agenda-files (regexp-quote link))))
19775 (defun org-uniquify (list)
19776 "Remove duplicate elements from LIST."
19777 (let (res)
19778 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19779 res))
19781 (defun org-delete-all (elts list)
19782 "Remove all elements in ELTS from LIST."
19783 (while elts
19784 (setq list (delete (pop elts) list)))
19785 list)
19787 (defun org-count (cl-item cl-seq)
19788 "Count the number of occurrences of ITEM in SEQ.
19789 Taken from `count' in cl-seq.el with all keyword arguments removed."
19790 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19791 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19792 (while (< cl-start cl-end)
19793 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19794 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19795 (setq cl-start (1+ cl-start)))
19796 cl-count))
19798 (defun org-remove-if (predicate seq)
19799 "Remove everything from SEQ that fulfills PREDICATE."
19800 (let (res e)
19801 (while seq
19802 (setq e (pop seq))
19803 (if (not (funcall predicate e)) (push e res)))
19804 (nreverse res)))
19806 (defun org-remove-if-not (predicate seq)
19807 "Remove everything from SEQ that does not fulfill PREDICATE."
19808 (let (res e)
19809 (while seq
19810 (setq e (pop seq))
19811 (if (funcall predicate e) (push e res)))
19812 (nreverse res)))
19814 (defun org-reduce (cl-func cl-seq &rest cl-keys)
19815 "Reduce two-argument FUNCTION across SEQ.
19816 Taken from `reduce' in cl-seq.el with all keyword arguments but
19818 (let ((cl-accum (cond ((memq :initial-value cl-keys)
19819 (cadr (memq :initial-value cl-keys)))
19820 (cl-seq (pop cl-seq))
19821 (t (funcall cl-func)))))
19822 (while cl-seq
19823 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
19824 cl-accum))
19826 (defun org-back-over-empty-lines ()
19827 "Move backwards over whitespace, to the beginning of the first empty line.
19828 Returns the number of empty lines passed."
19829 (let ((pos (point)))
19830 (if (cdr (assoc 'heading org-blank-before-new-entry))
19832 (unless (eobp)
19833 (forward-line -1)))
19834 (beginning-of-line 2)
19835 (goto-char (min (point) pos))
19836 (count-lines (point) pos)))
19838 (defun org-skip-whitespace ()
19841 (defun org-point-in-group (point group &optional context)
19842 "Check if POINT is in match-group GROUP.
19843 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19844 match. If the match group does not exist or point is not inside it,
19845 return nil."
19846 (and (match-beginning group)
19847 (>= point (match-beginning group))
19848 (<= point (match-end group))
19849 (if context
19850 (list context (match-beginning group) (match-end group))
19851 t)))
19853 (defun org-switch-to-buffer-other-window (&rest args)
19854 "Switch to buffer in a second window on the current frame.
19855 In particular, do not allow pop-up frames.
19856 Returns the newly created buffer."
19857 (let (pop-up-frames special-display-buffer-names special-display-regexps
19858 special-display-function)
19859 (apply 'switch-to-buffer-other-window args)))
19861 (defun org-combine-plists (&rest plists)
19862 "Create a single property list from all plists in PLISTS.
19863 The process starts by copying the first list, and then setting properties
19864 from the other lists. Settings in the last list are the most significant
19865 ones and overrule settings in the other lists."
19866 (let ((rtn (copy-sequence (pop plists)))
19867 p v ls)
19868 (while plists
19869 (setq ls (pop plists))
19870 (while ls
19871 (setq p (pop ls) v (pop ls))
19872 (setq rtn (plist-put rtn p v))))
19873 rtn))
19875 (defun org-move-line-down (arg)
19876 "Move the current line down. With prefix argument, move it past ARG lines."
19877 (interactive "p")
19878 (let ((col (current-column))
19879 beg end pos)
19880 (beginning-of-line 1) (setq beg (point))
19881 (beginning-of-line 2) (setq end (point))
19882 (beginning-of-line (+ 1 arg))
19883 (setq pos (move-marker (make-marker) (point)))
19884 (insert (delete-and-extract-region beg end))
19885 (goto-char pos)
19886 (org-move-to-column col)))
19888 (defun org-move-line-up (arg)
19889 "Move the current line up. With prefix argument, move it past ARG lines."
19890 (interactive "p")
19891 (let ((col (current-column))
19892 beg end pos)
19893 (beginning-of-line 1) (setq beg (point))
19894 (beginning-of-line 2) (setq end (point))
19895 (beginning-of-line (- arg))
19896 (setq pos (move-marker (make-marker) (point)))
19897 (insert (delete-and-extract-region beg end))
19898 (goto-char pos)
19899 (org-move-to-column col)))
19901 (defun org-replace-escapes (string table)
19902 "Replace %-escapes in STRING with values in TABLE.
19904 The sequences in STRING may contain normal field width and padding information,
19906 so values can contain further %-escapes if they are define later in TABLE."
19907 (let ((tbl (copy-alist table))
19908 (case-fold-search nil)
19909 (pchg 0)
19910 e re rpl)
19911 (while (setq e (pop tbl))
19912 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19913 (when (and (cdr e) (string-match re (cdr e)))
19914 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19915 (safe "SREF"))
19916 (add-text-properties 0 3 (list 'sref sref) safe)
19917 (setcdr e (replace-match safe t t (cdr e)))))
19918 (while (string-match re string)
19919 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19920 (cdr e)))
19921 (setq string (replace-match rpl t t string))))
19922 (while (setq pchg (next-property-change pchg string))
19923 (let ((sref (get-text-property pchg 'sref string)))
19924 (when (and sref (string-match "SREF" string pchg))
19925 (setq string (replace-match sref t t string)))))
19926 string))
19928 (defun org-sublist (list start end)
19929 "Return a section of LIST, from START to END.
19930 Counting starts at 1."
19931 (let (rtn (c start))
19932 (setq list (nthcdr (1- start) list))
19933 (while (and list (<= c end))
19934 (push (pop list) rtn)
19935 (setq c (1+ c)))
19936 (nreverse rtn)))
19938 (defun org-find-base-buffer-visiting (file)
19939 "Like `find-buffer-visiting' but always return the base buffer and
19940 not an indirect buffer."
19941 (let ((buf (or (get-file-buffer file)
19942 (find-buffer-visiting file))))
19943 (if buf
19944 (or (buffer-base-buffer buf) buf)
19945 nil)))
19947 (defun org-image-file-name-regexp (&optional extensions)
19948 "Return regexp matching the file names of images.
19949 If EXTENSIONS is given, only match these."
19950 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19951 (image-file-name-regexp)
19952 (let ((image-file-name-extensions
19953 (or extensions
19954 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19955 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19957 (regexp-opt (nconc (mapcar 'upcase
19958 image-file-name-extensions)
19959 image-file-name-extensions)
19960 t)
19963 (defun org-file-image-p (file &optional extensions)
19964 "Return non-nil if FILE is an image."
19965 (save-match-data
19966 (string-match (org-image-file-name-regexp extensions) file)))
19968 (defun org-get-cursor-date ()
19969 "Return the date at cursor in as a time.
19970 This works in the calendar and in the agenda, anywhere else it just
19971 returns the current time."
19972 (let (date day defd)
19973 (cond
19974 ((eq major-mode 'calendar-mode)
19975 (setq date (calendar-cursor-to-date)
19976 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19977 ((eq major-mode 'org-agenda-mode)
19978 (setq day (get-text-property (point) 'day))
19979 (if day
19980 (setq date (calendar-gregorian-from-absolute day)
19981 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19982 (nth 2 date))))))
19983 (or defd (current-time))))
19985 (defvar org-agenda-action-marker (make-marker)
19986 "Marker pointing to the entry for the next agenda action.")
19988 (defun org-mark-entry-for-agenda-action ()
19989 "Mark the current entry as target of an agenda action.
19990 Agenda actions are actions executed from the agenda with the key `k',
19991 which make use of the date at the cursor."
19992 (interactive)
19993 (move-marker org-agenda-action-marker
19994 (save-excursion (org-back-to-heading t) (point))
19995 (current-buffer))
19996 (message
19997 "Entry marked for action; press `k' at desired date in agenda or calendar"))
19999 (defun org-mark-subtree ()
20000 "Mark the current subtree.
20001 This puts point at the start of the current subtree, and mark at the end.
20003 If point is in an inline task, mark that task instead."
20004 (interactive)
20005 (let ((inline-task-p
20006 (and (featurep 'org-inlinetask)
20007 (org-inlinetask-in-task-p)))
20008 (beg))
20009 ;; Get beginning of subtree
20010 (cond
20011 (inline-task-p (org-inlinetask-goto-beginning))
20012 ((org-at-heading-p) (beginning-of-line))
20013 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
20014 (setq beg (point))
20015 ;; Get end of it
20016 (if inline-task-p
20017 (org-inlinetask-goto-end)
20018 (org-end-of-subtree))
20019 ;; Mark zone
20020 (push-mark (point) nil t)
20021 (goto-char beg)))
20023 ;;; Paragraph filling stuff.
20024 ;; We want this to be just right, so use the full arsenal.
20026 (defun org-indent-line-function ()
20027 "Indent line depending on context."
20028 (interactive)
20029 (let* ((pos (point))
20030 (itemp (org-at-item-p))
20031 (case-fold-search t)
20033 (inline-task-p (and (featurep 'org-inlinetask)
20034 (org-inlinetask-in-task-p)))
20035 (inline-re (and inline-task-p
20036 (org-inlinetask-outline-regexp)))
20037 column)
20038 (beginning-of-line 1)
20039 (cond
20040 ;; Comments
20041 ((looking-at "# ") (setq column 0))
20042 ;; Headings
20043 ((looking-at org-outline-regexp) (setq column 0))
20044 ;; Included files
20046 ;; Footnote definition
20047 ((looking-at org-footnote-definition-re) (setq column 0))
20048 ;; Literal examples
20050 (setq column (org-get-indentation))) ; do nothing
20051 ;; Lists
20052 ((ignore-errors (goto-char (org-in-item-p)))
20053 (setq column (if itemp
20054 (org-get-indentation)
20055 (org-list-item-body-column (point))))
20056 (goto-char pos))
20057 ;; Drawers
20059 (save-excursion (re-search-backward org-drawer-regexp nil t)))
20060 (save-excursion
20061 (goto-char (1- (match-beginning 1)))
20062 (setq column (current-column))))
20063 ;; Special blocks
20065 (save-excursion
20066 (re-search-backward
20068 (setq column (org-get-indentation (match-string 0))))
20071 (save-excursion
20073 (setq column
20074 (cond ((equal (downcase (match-string 1)) "src")
20075 ;; src blocks: let `org-edit-src-exit' handle them
20076 (org-get-indentation))
20077 ((equal (downcase (match-string 1)) "example")
20078 (max (org-get-indentation)
20079 (org-get-indentation (match-string 0))))
20080 (t
20081 (org-get-indentation (match-string 0))))))
20082 ;; This line has nothing special, look at the previous relevant
20083 ;; line to compute indentation
20084 (t
20085 (beginning-of-line 0)
20086 (while (and (not (bobp))
20087 (not (looking-at org-drawer-regexp))
20088 ;; When point started in an inline task, do not move
20089 ;; above task starting line.
20090 (not (and inline-task-p (looking-at inline-re)))
20091 ;; Skip drawers, blocks, empty lines, verbatim,
20092 ;; comments, tables, footnotes definitions, lists,
20093 ;; inline tasks.
20095 (re-search-backward org-drawer-regexp nil t))
20099 (looking-at org-footnote-definition-re)
20100 (and (ignore-errors (goto-char (org-in-item-p)))
20101 (goto-char
20102 (org-list-get-top-point (org-list-struct))))
20103 (and (not inline-task-p)
20104 (featurep 'org-inlinetask)
20105 (org-inlinetask-in-task-p)
20106 (or (org-inlinetask-goto-beginning) t))))
20107 (beginning-of-line 0))
20108 (cond
20109 ;; There was an heading above.
20111 (if (not org-adapt-indentation)
20112 (setq column 0)
20113 (goto-char (match-end 0))
20114 (setq column (current-column))))
20115 ;; A drawer had started and is unfinished
20116 ((looking-at org-drawer-regexp)
20117 (goto-char (1- (match-beginning 1)))
20118 (setq column (current-column)))
20119 ;; Else, nothing noticeable found: get indentation and go on.
20120 (t (setq column (org-get-indentation))))))
20121 ;; Now apply indentation and move cursor accordingly
20122 (goto-char pos)
20123 (if (<= (current-column) (current-indentation))
20124 (org-indent-line-to column)
20125 (save-excursion (org-indent-line-to column)))
20126 ;; Special polishing for properties, see `org-property-format'
20127 (setq column (current-column))
20128 (beginning-of-line 1)
20129 (if (looking-at
20131 (replace-match (concat (match-string 1)
20132 (format org-property-format
20133 (match-string 2) (match-string 3)))
20134 t t))
20135 (org-move-to-column column)))
20137 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
20138 "Variable to store copy of `adaptive-fill-regexp'.
20139 Since `adaptive-fill-regexp' is set to never match, we need to
20140 store a backup of its value before entering `org-mode' so that
20141 the functionality can be provided as a fall-back.")
20143 (defun org-set-autofill-regexps ()
20144 (interactive)
20145 ;; In the paragraph separator we include headlines, because filling
20146 ;; text in a line directly attached to a headline would otherwise
20147 ;; fill the headline as well.
20150 ;; The paragraph starter includes hand-formatted lists.
20151 (org-set-local
20152 'paragraph-start
20153 (concat
20162 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
20163 ;; But only if the user has not turned off tables or fixed-width regions
20164 (org-set-local
20165 'auto-fill-inhibit-regexp
20166 (concat org-outline-regexp
20169 (if (or org-enable-table-editor org-enable-fixed-width-editor)
20170 (concat
20172 (if org-enable-table-editor "|" "")
20173 (if org-enable-fixed-width-editor ":" "")
20174 "]"))))
20175 ;; We use our own fill-paragraph function, to make sure that tables
20176 ;; and fixed-width regions are not wrapped. That function will pass
20177 ;; through to `fill-paragraph' when appropriate.
20178 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
20179 ;; Prevent auto-fill from inserting unwanted new items.
20180 (if (boundp 'fill-nobreak-predicate)
20181 (org-set-local 'fill-nobreak-predicate
20182 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
20183 fill-nobreak-predicate
20184 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate))))
20185 ;; Adaptive filling: To get full control, first make sure that
20186 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
20187 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
20188 (org-set-local 'org-adaptive-fill-regexp-backup
20189 adaptive-fill-regexp))
20191 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
20192 (org-set-local 'adaptive-fill-function
20193 'org-adaptive-fill-function)
20194 (org-set-local
20195 'align-mode-rules-list
20196 '((org-in-buffer-settings
20198 (modes . '(org-mode))))))
20200 (defun org-fill-item-nobreak-p ()
20201 "Non-nil when a line break at point would insert a new item."
20202 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
20204 (defun org-fill-paragraph (&optional justify)
20205 "Re-align a table, pass through to fill-paragraph if no table."
20206 (let ((table-p (org-at-table-p))
20207 (table.el-p (org-at-table.el-p))
20208 (itemp (org-in-item-p)))
20209 (cond ((and (equal (char-after (point-at-bol)) ?*)
20210 (save-excursion (goto-char (point-at-bol))
20211 (looking-at org-outline-regexp)))
20212 t) ; skip headlines
20213 (table.el-p t) ; skip table.el tables
20214 (table-p (org-table-align) t) ; align Org tables
20215 (itemp ; align text in items
20216 (let* ((struct (save-excursion (goto-char itemp)
20217 (org-list-struct)))
20218 (parents (org-list-parents-alist struct))
20219 (children (org-list-get-children itemp struct parents))
20220 beg end prev next prefix)
20221 ;; Determine in which part of item point is: before
20222 ;; first child, after last child, between two
20223 ;; sub-lists, or simply in item if there's no child.
20224 (cond
20225 ((not children)
20226 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20227 beg itemp
20228 end (org-list-get-item-end itemp struct)))
20229 ((< (point) (setq next (car children)))
20230 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20231 beg itemp
20232 end next))
20233 ((> (point) (setq prev (car (last children))))
20234 (setq beg (org-list-get-item-end prev struct)
20235 end (org-list-get-item-end itemp struct)
20236 prefix (save-excursion
20237 (goto-char beg)
20239 (make-string (current-column) ?\ ))))
20240 (t (catch 'exit
20241 (while (setq next (pop children))
20242 (if (> (point) next)
20243 (setq prev next)
20244 (setq beg (org-list-get-item-end prev struct)
20245 end next
20246 prefix (save-excursion
20247 (goto-char beg)
20249 (make-string (current-column) ?\ )))
20250 (throw 'exit nil))))))
20251 ;; Use `fill-paragraph' with buffer narrowed to item
20252 ;; without any child, and with our computed PREFIX.
20253 (flet ((fill-context-prefix (from to &optional flr) prefix))
20254 (save-restriction
20255 (narrow-to-region beg end)
20256 (save-excursion (fill-paragraph justify)))) t))
20257 ;; Special case where point is not in a list but is on
20258 ;; a paragraph adjacent to a list: make sure this paragraph
20259 ;; doesn't get merged with the end of the list by narrowing
20260 ;; buffer first.
20261 ((save-excursion (forward-paragraph -1)
20262 (setq itemp (org-in-item-p)))
20263 (let ((struct (save-excursion (goto-char itemp)
20264 (org-list-struct))))
20265 (save-restriction
20266 (narrow-to-region (org-list-get-bottom-point struct)
20267 (save-excursion (forward-paragraph 1)
20268 (point)))
20269 (fill-paragraph justify) t)))
20270 ;; Else simply call `fill-paragraph'.
20271 (t nil))))
20273 ;; For reference, this is the default value of adaptive-fill-regexp
20276 (defun org-adaptive-fill-function ()
20277 "Return a fill prefix for org-mode files."
20278 (let (itemp)
20279 (save-excursion
20280 (cond
20281 ;; Comment line
20283 (match-string-no-properties 0))
20284 ;; Plain list item
20285 ((org-at-item-p)
20286 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
20287 ;; Point is in a list after `backward-paragraph': original
20288 ;; point wasn't in the list, or filling would have been taken
20289 ;; care of by `org-auto-fill-function', but the list and the
20290 ;; real paragraph are not separated by a blank line. Thus, move
20291 ;; point after the list to go back to real paragraph and
20292 ;; determine fill-prefix.
20293 ((setq itemp (org-in-item-p))
20294 (goto-char itemp)
20295 (let* ((struct (org-list-struct))
20296 (bottom (org-list-get-bottom-point struct)))
20297 (goto-char bottom)
20298 (make-string (org-get-indentation) ?\ )))
20299 ;; Other text
20300 ((looking-at org-adaptive-fill-regexp-backup)
20301 (match-string-no-properties 0))))))
20303 (defun org-auto-fill-function ()
20304 "Auto-fill function."
20305 (let (itemp prefix)
20306 ;; When in a list, compute an appropriate fill-prefix and make
20307 ;; sure it will be used by `do-auto-fill'.
20308 (if (setq itemp (org-in-item-p))
20309 (progn
20310 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
20311 (flet ((fill-context-prefix (from to &optional flr) prefix))
20312 (do-auto-fill)))
20313 ;; Else just use `do-auto-fill'.
20314 (do-auto-fill))))
20316 ;;; Other stuff.
20318 (defun org-toggle-fixed-width-section (arg)
20319 "Toggle the fixed-width export.
20320 If there is no active region, the QUOTE keyword at the current headline is
20321 inserted or removed. When present, it causes the text between this headline
20322 and the next to be exported as fixed-width text, and unmodified.
20323 If there is an active region, this command adds or removes a colon as the
20324 first character of this line. If the first character of a line is a colon,
20325 this line is also exported in fixed-width font."
20326 (interactive "P")
20327 (let* ((cc 0)
20328 (regionp (org-region-active-p))
20329 (beg (if regionp (region-beginning) (point)))
20330 (end (if regionp (region-end)))
20331 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
20332 (case-fold-search nil)
20334 off)
20335 (if regionp
20336 (save-excursion
20337 (goto-char beg)
20338 (setq cc (current-column))
20339 (beginning-of-line 1)
20340 (setq off (looking-at re))
20341 (while (> nlines 0)
20342 (setq nlines (1- nlines))
20343 (beginning-of-line 1)
20344 (cond
20345 (arg
20346 (org-move-to-column cc t)
20348 (forward-line -1))
20349 ((and off (looking-at re))
20350 (replace-match "" t t nil 1))
20351 ((not off) (org-move-to-column cc t) (insert ": ")))
20352 (forward-line 1)))
20353 (save-excursion
20354 (org-back-to-heading)
20355 (cond
20356 ((looking-at (format org-heading-keyword-regexp-format
20357 org-quote-string))
20358 (goto-char (match-end 1))
20359 (looking-at (concat " +" org-quote-string))
20360 (replace-match "" t t)
20361 (when (eolp) (insert " ")))
20362 ((looking-at org-outline-regexp)
20363 (goto-char (match-end 0))
20364 (insert org-quote-string " ")))))))
20366 (defun org-reftex-citation ()
20367 "Use reftex-citation to insert a citation into the buffer.
20368 This looks for a line like
20370 #+BIBLIOGRAPHY: foo plain option:-d
20372 and derives from it that foo.bib is the bibliography file relevant
20373 for this document. It then installs the necessary environment for RefTeX
20374 to work in this buffer and calls `reftex-citation' to insert a citation
20375 into the buffer.
20377 Export of such citations to both LaTeX and HTML is handled by the contributed
20378 package org-exp-bibtex by Taru Karttunen."
20379 (interactive)
20380 (let ((reftex-docstruct-symbol 'rds)
20382 rds bib)
20383 (save-excursion
20384 (save-restriction
20385 (widen)
20386 (let ((case-fold-search t)
20388 (if (not (save-excursion
20389 (or (re-search-forward re nil t)
20390 (re-search-backward re nil t))))
20391 (error "No bibliography defined in file")
20392 (setq bib (concat (match-string 1) ".bib")
20393 rds (list (list 'bib bib)))))))
20394 (call-interactively 'reftex-citation)))
20396 ;;;; Functions extending outline functionality
20398 (defun org-beginning-of-line (&optional arg)
20399 "Go to the beginning of the current line. If that is invisible, continue
20400 to a visible line beginning. This makes the function of C-a more intuitive.
20401 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20402 first attempt, and only move to after the tags when the cursor is already
20403 beyond the end of the headline."
20404 (interactive "P")
20405 (let ((pos (point))
20406 (special (if (consp org-special-ctrl-a/e)
20407 (car org-special-ctrl-a/e)
20408 org-special-ctrl-a/e))
20409 refpos)
20410 (if (org-bound-and-true-p line-move-visual)
20411 (beginning-of-visual-line 1)
20412 (beginning-of-line 1))
20413 (if (and arg (fboundp 'move-beginning-of-line))
20414 (call-interactively 'move-beginning-of-line)
20415 (if (bobp)
20416 nil
20417 (backward-char 1)
20418 (if (org-truely-invisible-p)
20419 (while (and (not (bobp)) (org-truely-invisible-p))
20420 (backward-char 1)
20421 (beginning-of-line 1))
20422 (forward-char 1))))
20423 (when special
20424 (cond
20425 ((and (looking-at org-complex-heading-regexp)
20426 (= (char-after (match-end 1)) ?\ ))
20427 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
20428 (point-at-eol)))
20429 (goto-char
20430 (if (eq special t)
20431 (cond ((> pos refpos) refpos)
20432 ((= pos (point)) refpos)
20433 (t (point)))
20434 (cond ((> pos (point)) (point))
20435 ((not (eq last-command this-command)) (point))
20436 (t refpos)))))
20437 ((org-at-item-p)
20438 ;; Being at an item and not looking at an the item means point
20439 ;; was previously moved to beginning of a visual line, whiche
20440 ;; doesn't contain the item. Therefore, do nothing special,
20441 ;; just stay here.
20442 (when (looking-at org-list-full-item-re)
20443 ;; Set special position at first white space character after
20444 ;; bullet, and check-box, if any.
20445 (let ((after-bullet
20446 (let ((box (match-end 3)))
20447 (if (not box) (match-end 1)
20448 (let ((after (char-after box)))
20449 (if (and after (= after ? )) (1+ box) box))))))
20450 ;; Special case: Move point to special position when
20451 ;; currently after it or at beginning of line.
20452 (if (eq special t)
20453 (when (or (> pos after-bullet) (= (point) pos))
20454 (goto-char after-bullet))
20455 ;; Reversed case: Move point to special position when
20456 ;; point was already at beginning of line and command is
20457 ;; repeated.
20458 (when (and (= (point) pos) (eq last-command this-command))
20459 (goto-char after-bullet))))))))
20460 (org-no-warnings
20461 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20463 (defun org-end-of-line (&optional arg)
20464 "Go to the end of the line.
20465 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20466 first attempt, and only move to after the tags when the cursor is already
20467 beyond the end of the headline."
20468 (interactive "P")
20469 (let ((special (if (consp org-special-ctrl-a/e)
20470 (cdr org-special-ctrl-a/e)
20471 org-special-ctrl-a/e)))
20472 (cond
20473 ((or (not special) arg
20474 (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
20475 (call-interactively
20476 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20477 ((fboundp 'move-end-of-line) 'move-end-of-line)
20478 (t 'end-of-line))))
20479 ((org-at-heading-p)
20480 (let ((pos (point)))
20481 (beginning-of-line 1)
20483 (if (eq special t)
20484 (if (or (< pos (match-beginning 1))
20485 (= pos (match-end 0)))
20486 (goto-char (match-beginning 1))
20487 (goto-char (match-end 0)))
20488 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
20489 (goto-char (match-end 0))
20490 (goto-char (match-beginning 1))))
20491 (call-interactively (if (fboundp 'move-end-of-line)
20492 'move-end-of-line
20493 'end-of-line)))))
20494 ((org-at-drawer-p)
20495 (move-end-of-line 1)
20496 (when (overlays-at (1- (point))) (backward-char 1)))
20497 ;; At an item: Move before any hidden text.
20498 (t (call-interactively
20499 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20500 ((fboundp 'move-end-of-line) 'move-end-of-line)
20501 (t 'end-of-line)))))
20502 (org-no-warnings
20503 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20505 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
20506 (define-key org-mode-map "\C-e" 'org-end-of-line)
20508 (defun org-backward-sentence (&optional arg)
20509 "Go to beginning of sentence, or beginning of table field.
20510 This will call `backward-sentence' or `org-table-beginning-of-field',
20511 depending on context."
20512 (interactive "P")
20513 (cond
20514 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
20515 (t (call-interactively 'backward-sentence))))
20517 (defun org-forward-sentence (&optional arg)
20518 "Go to end of sentence, or end of table field.
20519 This will call `forward-sentence' or `org-table-end-of-field',
20520 depending on context."
20521 (interactive "P")
20522 (cond
20523 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
20524 (t (call-interactively 'forward-sentence))))
20526 (define-key org-mode-map "\M-a" 'org-backward-sentence)
20527 (define-key org-mode-map "\M-e" 'org-forward-sentence)
20529 (defun org-kill-line (&optional arg)
20530 "Kill line, to tags or end of line."
20531 (interactive "P")
20532 (cond
20533 ((or (not org-special-ctrl-k)
20534 (bolp)
20535 (not (org-at-heading-p)))
20536 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
20537 org-ctrl-k-protect-subtree)
20538 (if (or (eq org-ctrl-k-protect-subtree 'error)
20539 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
20540 (error "C-k aborted - would kill hidden subtree")))
20541 (call-interactively 'kill-line))
20543 (kill-region (point) (match-beginning 1))
20544 (org-set-tags nil t))
20545 (t (kill-region (point) (point-at-eol)))))
20547 (define-key org-mode-map "\C-k" 'org-kill-line)
20549 (defun org-yank (&optional arg)
20550 "Yank. If the kill is a subtree, treat it specially.
20551 This command will look at the current kill and check if is a single
20552 subtree, or a series of subtrees[1]. If it passes the test, and if the
20553 cursor is at the beginning of a line or after the stars of a currently
20554 empty headline, then the yank is handled specially. How exactly depends
20555 on the value of the following variables, both set by default.
20557 org-yank-folded-subtrees
20558 When set, the subtree(s) will be folded after insertion, but only
20559 if doing so would now swallow text after the yanked text.
20561 org-yank-adjusted-subtrees
20562 When set, the subtree will be promoted or demoted in order to
20563 fit into the local outline tree structure, which means that the level
20564 will be adjusted so that it becomes the smaller one of the two
20565 *visible* surrounding headings.
20567 Any prefix to this command will cause `yank' to be called directly with
20569 will just
20570 plainly yank the text as it is.
20572 \[1] The test checks if the first non-white line is a heading
20573 and if there are no other headings with fewer stars."
20574 (interactive "P")
20575 (org-yank-generic 'yank arg))
20577 (defun org-yank-generic (command arg)
20578 "Perform some yank-like command.
20580 This function implements the behavior described in the `org-yank'
20581 documentation. However, it has been generalized to work for any
20582 interactive command with similar behavior."
20584 ;; pretend to be command COMMAND
20585 (setq this-command command)
20587 (if arg
20588 (call-interactively command)
20590 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
20591 (and (org-kill-is-subtree-p)
20592 (or (bolp)
20594 (string-match
20596 (buffer-substring (point-at-bol) (point)))))))
20597 swallowp)
20598 (cond
20599 ((and subtreep org-yank-folded-subtrees)
20600 (let ((beg (point))
20601 end)
20602 (if (and subtreep org-yank-adjusted-subtrees)
20603 (org-paste-subtree nil nil 'for-yank)
20604 (call-interactively command))
20606 (setq end (point))
20607 (goto-char beg)
20608 (when (and (bolp) subtreep
20609 (not (setq swallowp
20610 (org-yank-folding-would-swallow-text beg end))))
20611 (org-with-limited-levels
20612 (or (looking-at org-outline-regexp)
20613 (re-search-forward org-outline-regexp-bol end t))
20614 (while (and (< (point) end) (looking-at org-outline-regexp))
20615 (hide-subtree)
20616 (org-cycle-show-empty-lines 'folded)
20617 (condition-case nil
20618 (outline-forward-same-level 1)
20619 (error (goto-char end))))))
20620 (when swallowp
20621 (message
20622 "Inserted text not folded because that would swallow text"))
20624 (goto-char end)
20626 (beginning-of-line 1)
20627 (push-mark beg 'nomsg)))
20628 ((and subtreep org-yank-adjusted-subtrees)
20629 (let ((beg (point-at-bol)))
20630 (org-paste-subtree nil nil 'for-yank)
20631 (push-mark beg 'nomsg)))
20632 (t
20633 (call-interactively command))))))
20635 (defun org-yank-folding-would-swallow-text (beg end)
20636 "Would hide-subtree at BEG swallow any text after END?"
20637 (let (level)
20638 (org-with-limited-levels
20639 (save-excursion
20640 (goto-char beg)
20641 (when (or (looking-at org-outline-regexp)
20642 (re-search-forward org-outline-regexp-bol end t))
20643 (setq level (org-outline-level)))
20644 (goto-char end)
20646 (if (or (eobp)
20647 (and (bolp) (looking-at org-outline-regexp)
20648 (<= (org-outline-level) level)))
20649 nil ; Nothing would be swallowed
20650 t))))) ; something would swallow
20652 (define-key org-mode-map "\C-y" 'org-yank)
20654 (defun org-truely-invisible-p ()
20655 "Check if point is at a character currently not visible.
20656 This version does not only check the character property, but also
20657 `visible-mode'."
20658 ;; Early versions of noutline don't have `outline-invisible-p'.
20659 (if (org-bound-and-true-p visible-mode)
20660 nil
20661 (outline-invisible-p)))
20663 (defun org-invisible-p2 ()
20664 "Check if point is at a character currently not visible."
20665 (save-excursion
20666 (if (and (eolp) (not (bobp))) (backward-char 1))
20667 ;; Early versions of noutline don't have `outline-invisible-p'.
20668 (outline-invisible-p)))
20670 (defun org-back-to-heading (&optional invisible-ok)
20671 "Call `outline-back-to-heading', but provide a better error message."
20672 (condition-case nil
20673 (outline-back-to-heading invisible-ok)
20674 (error (error "Before first headline at position %d in buffer %s"
20675 (point) (current-buffer)))))
20677 (defun org-beginning-of-defun ()
20678 "Go to the beginning of the subtree, i.e. back to the heading."
20679 (org-back-to-heading))
20680 (defun org-end-of-defun ()
20681 "Go to the end of the subtree."
20682 (org-end-of-subtree nil t))
20684 (defun org-before-first-heading-p ()
20685 "Before first heading?"
20686 (save-excursion
20687 (end-of-line)
20688 (null (re-search-backward org-outline-regexp-bol nil t))))
20690 (defun org-at-heading-p (&optional ignored)
20691 (outline-on-heading-p t))
20692 ;; Compatibility alias with Org versions < 7.8.03
20693 (defalias 'org-on-heading-p 'org-at-heading-p)
20695 (defun org-at-drawer-p nil
20696 "Whether point is at a drawer."
20697 (save-excursion
20698 (move-beginning-of-line 1)
20699 (looking-at org-drawer-regexp)))
20701 (defun org-point-at-end-of-empty-headline ()
20702 "If point is at the end of an empty headline, return t, else nil.
20703 If the heading only contains a TODO keyword, it is still still considered
20704 empty."
20706 (save-excursion
20707 (beginning-of-line 1)
20708 (let ((case-fold-search nil))
20709 (looking-at org-todo-line-regexp)))
20710 (string= (match-string 3) "")))
20712 (defun org-at-heading-or-item-p ()
20713 (or (org-at-heading-p) (org-at-item-p)))
20715 (defun org-at-target-p ()
20716 (or (org-in-regexp org-radio-target-regexp)
20717 (org-in-regexp org-target-regexp)))
20718 ;; Compatibility alias with Org versions < 7.8.03
20719 (defalias 'org-on-target-p 'org-at-target-p)
20721 (defun org-up-heading-all (arg)
20722 "Move to the heading line of which the present line is a subheading.
20723 This function considers both visible and invisible heading lines.
20724 With argument, move up ARG levels."
20725 (if (fboundp 'outline-up-heading-all)
20726 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20727 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20729 (defun org-up-heading-safe ()
20730 "Move to the heading line of which the present line is a subheading.
20731 This version will not throw an error. It will return the level of the
20732 headline found, or nil if no higher level is found.
20734 Also, this function will be a lot faster than `outline-up-heading',
20735 because it relies on stars being the outline starters. This can really
20736 make a significant difference in outlines with very many siblings."
20737 (let (start-level re)
20738 (org-back-to-heading t)
20739 (setq start-level (funcall outline-level))
20740 (if (equal start-level 1)
20741 nil
20743 (if (re-search-backward re nil t)
20744 (funcall outline-level)))))
20746 (defun org-first-sibling-p ()
20747 "Is this heading the first child of its parents?"
20748 (interactive)
20749 (let ((re org-outline-regexp-bol)
20750 level l)
20751 (unless (org-at-heading-p t)
20752 (error "Not at a heading"))
20753 (setq level (funcall outline-level))
20754 (save-excursion
20755 (if (not (re-search-backward re nil t))
20756 t
20757 (setq l (funcall outline-level))
20758 (< l level)))))
20760 (defun org-goto-sibling (&optional previous)
20761 "Goto the next sibling, even if it is invisible.
20762 When PREVIOUS is set, go to the previous sibling instead. Returns t
20763 when a sibling was found. When none is found, return nil and don't
20764 move point."
20765 (let ((fun (if previous 're-search-backward 're-search-forward))
20766 (pos (point))
20767 (re org-outline-regexp-bol)
20768 level l)
20769 (when (condition-case nil (org-back-to-heading t) (error nil))
20770 (setq level (funcall outline-level))
20771 (catch 'exit
20772 (or previous (forward-char 1))
20773 (while (funcall fun re nil t)
20774 (setq l (funcall outline-level))
20775 (when (< l level) (goto-char pos) (throw 'exit nil))
20776 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20777 (goto-char pos)
20778 nil))))
20780 (defun org-show-siblings ()
20781 "Show all siblings of the current headline."
20782 (save-excursion
20783 (while (org-goto-sibling) (org-flag-heading nil)))
20784 (save-excursion
20785 (while (org-goto-sibling 'previous)
20786 (org-flag-heading nil))))
20788 (defun org-goto-first-child ()
20789 "Goto the first child, even if it is invisible.
20790 Return t when a child was found. Otherwise don't move point and
20791 return nil."
20792 (let (level (pos (point)) (re org-outline-regexp-bol))
20793 (when (condition-case nil (org-back-to-heading t) (error nil))
20794 (setq level (outline-level))
20795 (forward-char 1)
20796 (if (and (re-search-forward re nil t) (> (outline-level) level))
20797 (progn (goto-char (match-beginning 0)) t)
20798 (goto-char pos) nil))))
20800 (defun org-show-hidden-entry ()
20801 "Show an entry where even the heading is hidden."
20802 (save-excursion
20803 (org-show-entry)))
20805 (defun org-flag-heading (flag &optional entry)
20806 "Flag the current heading. FLAG non-nil means make invisible.
20807 When ENTRY is non-nil, show the entire entry."
20808 (save-excursion
20809 (org-back-to-heading t)
20810 ;; Check if we should show the entire entry
20811 (if entry
20812 (progn
20813 (org-show-entry)
20814 (save-excursion
20815 (and (outline-next-heading)
20816 (org-flag-heading nil))))
20817 (outline-flag-region (max (point-min) (1- (point)))
20818 (save-excursion (outline-end-of-heading) (point))
20819 flag))))
20821 (defun org-get-next-sibling ()
20822 "Move to next heading of the same level, and return point.
20823 If there is no such heading, return nil.
20824 This is like outline-next-sibling, but invisible headings are ok."
20825 (let ((level (funcall outline-level)))
20826 (outline-next-heading)
20827 (while (and (not (eobp)) (> (funcall outline-level) level))
20828 (outline-next-heading))
20829 (if (or (eobp) (< (funcall outline-level) level))
20830 nil
20831 (point))))
20833 (defun org-get-last-sibling ()
20834 "Move to previous heading of the same level, and return point.
20835 If there is no such heading, return nil."
20836 (let ((opoint (point))
20837 (level (funcall outline-level)))
20838 (outline-previous-heading)
20839 (when (and (/= (point) opoint) (outline-on-heading-p t))
20840 (while (and (> (funcall outline-level) level)
20841 (not (bobp)))
20842 (outline-previous-heading))
20843 (if (< (funcall outline-level) level)
20844 nil
20845 (point)))))
20847 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20848 ;; This contains an exact copy of the original function, but it uses
20849 ;; `org-back-to-heading', to make it work also in invisible
20850 ;; trees. And is uses an invisible-OK argument.
20851 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20852 ;; Furthermore, when used inside Org, finding the end of a large subtree
20853 ;; with many children and grandchildren etc, this can be much faster
20854 ;; than the outline version.
20855 (org-back-to-heading invisible-OK)
20856 (let ((first t)
20857 (level (funcall outline-level)))
20858 (if (and (eq major-mode 'org-mode) (< level 1000))
20859 ;; A true heading (not a plain list item), in Org-mode
20860 ;; This means we can easily find the end by looking
20861 ;; only for the right number of stars. Using a regexp to do
20862 ;; this is so much faster than using a Lisp loop.
20864 (forward-char 1)
20865 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20866 ;; something else, do it the slow way
20867 (while (and (not (eobp))
20868 (or first (> (funcall outline-level) level)))
20869 (setq first nil)
20870 (outline-next-heading)))
20871 (unless to-heading
20873 (progn
20874 ;; Go to end of line before heading
20875 (forward-char -1)
20877 ;; leave blank line before heading
20878 (forward-char -1))))))
20879 (point))
20881 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20882 "Use Org version in org-mode, for dramatic speed-up."
20883 (if (eq major-mode 'org-mode)
20884 (progn
20885 (org-end-of-subtree nil t)
20886 (unless (eobp) (backward-char 1)))
20887 ad-do-it))
20889 (defun org-end-of-meta-data-and-drawers ()
20890 "Jump to the first text after meta data and drawers in the current entry.
20891 This will move over empty lines, lines with planning time stamps,
20892 clocking lines, and drawers."
20893 (org-back-to-heading t)
20894 (let ((end (save-excursion (outline-next-heading) (point)))
20897 (forward-line 1)
20898 (while (re-search-forward re end t)
20899 (if (not (match-end 1))
20900 ;; empty or planning line
20901 (forward-line 1)
20902 ;; a drawer, find the end
20904 (forward-line 1)))
20906 (point)))
20908 (defun org-forward-same-level (arg &optional invisible-ok)
20909 "Move forward to the arg'th subheading at same level as this one.
20910 Stop at the first and last subheadings of a superior heading.
20911 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20912 it wil also look at invisible ones."
20913 (interactive "p")
20914 (org-back-to-heading invisible-ok)
20915 (org-at-heading-p)
20916 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20918 l)
20919 (forward-char 1)
20920 (while (> arg 0)
20921 (while (and (re-search-forward re nil 'move)
20922 (setq l (- (match-end 0) (match-beginning 0) 1))
20923 (= l level)
20924 (not invisible-ok)
20925 (progn (backward-char 1) (outline-invisible-p)))
20926 (if (< l level) (setq arg 1)))
20927 (setq arg (1- arg)))
20928 (beginning-of-line 1)))
20930 (defun org-backward-same-level (arg &optional invisible-ok)
20931 "Move backward to the arg'th subheading at same level as this one.
20932 Stop at the first and last subheadings of a superior heading."
20933 (interactive "p")
20934 (org-back-to-heading)
20935 (org-at-heading-p)
20936 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20938 l)
20939 (while (> arg 0)
20940 (while (and (re-search-backward re nil 'move)
20941 (setq l (- (match-end 0) (match-beginning 0) 1))
20942 (= l level)
20943 (not invisible-ok)
20944 (outline-invisible-p))
20945 (if (< l level) (setq arg 1)))
20946 (setq arg (1- arg)))))
20948 (defun org-show-subtree ()
20949 "Show everything after this heading at deeper levels."
20950 (outline-flag-region
20951 (point)
20952 (save-excursion
20953 (org-end-of-subtree t t))
20954 nil))
20956 (defun org-show-entry ()
20957 "Show the body directly following this heading.
20958 Show the heading too, if it is currently invisible."
20959 (interactive)
20960 (save-excursion
20961 (condition-case nil
20962 (progn
20963 (org-back-to-heading t)
20964 (outline-flag-region
20965 (max (point-min) (1- (point)))
20966 (save-excursion
20967 (if (re-search-forward
20969 (match-beginning 1)
20970 (point-max)))
20971 nil)
20972 (org-cycle-hide-drawers 'children))
20973 (error nil))))
20975 (defun org-make-options-regexp (kwds &optional extra)
20976 "Make a regular expression for keyword lines."
20977 (concat
20978 "^"
20985 ;; Make isearch reveal the necessary context
20986 (defun org-isearch-end ()
20987 "Reveal context after isearch exits."
20988 (when isearch-success ; only if search was successful
20989 (if (featurep 'xemacs)
20990 ;; Under XEmacs, the hook is run in the correct place,
20991 ;; we directly show the context.
20992 (org-show-context 'isearch)
20993 ;; In Emacs the hook runs *before* restoring the overlays.
20994 ;; So we have to use a one-time post-command-hook to do this.
20995 ;; (Emacs 22 has a special variable, see function `org-mode')
20996 (unless (and (boundp 'isearch-mode-end-hook-quit)
20997 isearch-mode-end-hook-quit)
20998 ;; Only when the isearch was not quitted.
20999 (org-add-hook 'post-command-hook 'org-isearch-post-command
21000 'append 'local)))))
21002 (defun org-isearch-post-command ()
21003 "Remove self from hook, and show context."
21004 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
21005 (org-show-context 'isearch))
21008 ;;;; Integration with and fixes for other packages
21010 ;;; Imenu support
21012 (defvar org-imenu-markers nil
21013 "All markers currently used by Imenu.")
21014 (make-variable-buffer-local 'org-imenu-markers)
21016 (defun org-imenu-new-marker (&optional pos)
21017 "Return a new marker for use by Imenu, and remember the marker."
21018 (let ((m (make-marker)))
21019 (move-marker m (or pos (point)))
21020 (push m org-imenu-markers)
21021 m))
21023 (defun org-imenu-get-tree ()
21024 "Produce the index for Imenu."
21025 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
21026 (setq org-imenu-markers nil)
21027 (let* ((n org-imenu-depth)
21028 (re (concat "^" (org-get-limited-outline-regexp)))
21029 (subs (make-vector (1+ n) nil))
21030 (last-level 0)
21031 m level head)
21032 (save-excursion
21033 (save-restriction
21034 (widen)
21035 (goto-char (point-max))
21036 (while (re-search-backward re nil t)
21037 (setq level (org-reduced-level (funcall outline-level)))
21038 (when (<= level n)
21039 (looking-at org-complex-heading-regexp)
21040 (setq head (org-link-display-format
21041 (org-match-string-no-properties 4))
21042 m (org-imenu-new-marker))
21043 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
21044 (if (>= level last-level)
21045 (push (cons head m) (aref subs level))
21046 (push (cons head (aref subs (1+ level))) (aref subs level))
21047 (loop for i from (1+ level) to n do (aset subs i nil)))
21048 (setq last-level level)))))
21049 (aref subs 1)))
21051 (eval-after-load "imenu"
21052 '(progn
21053 (add-hook 'imenu-after-jump-hook
21054 (lambda ()
21055 (if (eq major-mode 'org-mode)
21056 (org-show-context 'org-goto))))))
21058 (defun org-link-display-format (link)
21059 "Replace a link with either the description, or the link target
21060 if no description is present"
21061 (save-match-data
21062 (if (string-match org-bracket-link-analytic-regexp link)
21063 (replace-match (if (match-end 5)
21064 (match-string 5 link)
21065 (concat (match-string 1 link)
21066 (match-string 3 link)))
21067 nil t link)
21068 link)))
21070 (defun org-toggle-link-display ()
21071 "Toggle the literal or descriptive display of links."
21072 (interactive)
21073 (if org-descriptive-links
21074 (progn (org-remove-from-invisibility-spec '(org-link))
21075 (org-restart-font-lock)
21076 (setq org-descriptive-links nil))
21077 (progn (add-to-invisibility-spec '(org-link))
21078 (org-restart-font-lock)
21079 (setq org-descriptive-links t))))
21081 ;; Speedbar support
21083 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
21084 "Overlay marking the agenda restriction line in speedbar.")
21085 (overlay-put org-speedbar-restriction-lock-overlay
21086 'face 'org-agenda-restriction-lock)
21087 (overlay-put org-speedbar-restriction-lock-overlay
21088 'help-echo "Agendas are currently limited to this item.")
21089 (org-detach-overlay org-speedbar-restriction-lock-overlay)
21091 (defun org-speedbar-set-agenda-restriction ()
21092 "Restrict future agenda commands to the location at point in speedbar.
21094 (interactive)
21095 (require 'org-agenda)
21096 (let (p m tp np dir txt)
21097 (cond
21098 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21099 'org-imenu t))
21100 (setq m (get-text-property p 'org-imenu-marker))
21101 (with-current-buffer (marker-buffer m)
21102 (goto-char m)
21103 (org-agenda-set-restriction-lock 'subtree)))
21104 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21105 'speedbar-function 'speedbar-find-file))
21106 (setq tp (previous-single-property-change
21107 (1+ p) 'speedbar-function)
21108 np (next-single-property-change
21109 tp 'speedbar-function)
21110 dir (speedbar-line-directory)
21111 txt (buffer-substring-no-properties (or tp (point-min))
21112 (or np (point-max))))
21113 (with-current-buffer (find-file-noselect
21114 (let ((default-directory dir))
21115 (expand-file-name txt)))
21116 (unless (eq major-mode 'org-mode)
21117 (error "Cannot restrict to non-Org-mode file"))
21118 (org-agenda-set-restriction-lock 'file)))
21119 (t (error "Don't know how to restrict Org-mode's agenda")))
21120 (move-overlay org-speedbar-restriction-lock-overlay
21121 (point-at-bol) (point-at-eol))
21122 (setq current-prefix-arg nil)
21123 (org-agenda-maybe-redo)))
21125 (eval-after-load "speedbar"
21126 '(progn
21127 (speedbar-add-supported-extension ".org")
21128 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
21129 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
21130 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
21131 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
21132 (add-hook 'speedbar-visiting-tag-hook
21133 (lambda () (and (eq major-mode 'org-mode) (org-show-context 'org-goto))))))
21135 ;;; Fixes and Hacks for problems with other packages
21137 ;; Make flyspell not check words in links, to not mess up our keymap
21138 (defun org-mode-flyspell-verify ()
21139 "Don't let flyspell put overlays at active buttons, or on
21140 {todo,all-time,additional-option-like}-keywords."
21141 (let ((pos (max (1- (point)) (point-min)))
21142 (word (thing-at-point 'word)))
21143 (and (not (get-text-property pos 'keymap))
21144 (not (get-text-property pos 'org-no-flyspell))
21145 (not (member word org-todo-keywords-1))
21146 (not (member word org-all-time-keywords))
21147 (not (member word org-additional-option-like-keywords)))))
21149 (defun org-remove-flyspell-overlays-in (beg end)
21150 "Remove flyspell overlays in region."
21151 (and (org-bound-and-true-p flyspell-mode)
21152 (fboundp 'flyspell-delete-region-overlays)
21153 (flyspell-delete-region-overlays beg end))
21154 (add-text-properties beg end '(org-no-flyspell t)))
21156 ;; Make `bookmark-jump' shows the jump location if it was hidden.
21157 (eval-after-load "bookmark"
21158 '(if (boundp 'bookmark-after-jump-hook)
21159 ;; We can use the hook
21160 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
21161 ;; Hook not available, use advice
21162 (defadvice bookmark-jump (after org-make-visible activate)
21163 "Make the position visible."
21164 (org-bookmark-jump-unhide))))
21166 ;; Make sure saveplace shows the location if it was hidden
21167 (eval-after-load "saveplace"
21168 '(defadvice save-place-find-file-hook (after org-make-visible activate)
21169 "Make the position visible."
21170 (org-bookmark-jump-unhide)))
21172 ;; Make sure ecb shows the location if it was hidden
21173 (eval-after-load "ecb"
21174 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
21175 "Make hierarchy visible when jumping into location from ECB tree buffer."
21176 (if (eq major-mode 'org-mode)
21177 (org-show-context))))
21179 (defun org-bookmark-jump-unhide ()
21180 "Unhide the current position, to show the bookmark location."
21181 (and (eq major-mode 'org-mode)
21182 (or (outline-invisible-p)
21183 (save-excursion (goto-char (max (point-min) (1- (point))))
21184 (outline-invisible-p)))
21185 (org-show-context 'bookmark-jump)))
21187 ;; Make session.el ignore our circular variable
21188 (eval-after-load "session"
21189 '(add-to-list 'session-globals-exclude 'org-mark-ring))
21191 ;;;; Experimental code
21193 (defun org-closed-in-range ()
21194 "Sparse tree of items closed in a certain time range.
21195 Still experimental, may disappear in the future."
21196 (interactive)
21197 ;; Get the time interval from the user.
21198 (let* ((time1 (org-float-time
21199 (org-read-date nil 'to-time nil "Starting date: ")))
21200 (time2 (org-float-time
21201 (org-read-date nil 'to-time nil "End date:")))
21202 ;; callback function
21203 (callback (lambda ()
21204 (let ((time
21205 (org-float-time
21206 (apply 'encode-time
21207 (org-parse-time-string
21208 (match-string 1))))))
21209 ;; check if time in interval
21210 (and (>= time time1) (<= time time2))))))
21211 ;; make tree, check each match with the callback
21214 ;;;; Finish up
21216 (provide 'org)
21218 (run-hooks 'org-load-hook)
21220 ;;; org.el ends here