| blob | 67ea52b503f0003273d970669066838a2dd56461 |
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 sticked 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 emphasised 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 "Run through the buffer and add overlays to links."
5472 t)))
5475 "Run through the buffer and add overlays to footnotes."
5482 'keymap org-mouse-map
5483 'help-echo
5485 "Footnote definition"
5487 'font-lock-fontified t
5488 'font-lock-multiline t
5492 "Run through the buffer and add overlays to bracketed links."
5496 ;; FIXME: above we should remove the escapes.
5497 ;; but that requires another match, protecting match data,
5498 ;; a lot of overhead for font-lock.
5505 ;; We need to remove the invisible property here. Table narrowing
5506 ;; may have made some of this invisible.
5524 t)))
5527 "Run through the buffer and add overlays to dates."
5539 t)))
5548 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5552 "Run through the buffer and add overlays to target matches."
5560 'keymap org-mouse-map
5564 t)))))
5567 "Find all radio targets in this file and update the regular expression."
5582 t)))
5589 ;; This should be with the exporter code, but we also use if for font-locking
5599 "Compute regular expression for stuff treated specially by exporters."
5606 org-latex-regexps)))
5634 org-entities)))
5638 org-latex-entities)
5639 nil))
5641 ))
5642 ;; (list "\\\\\\(?:[a-zA-Z]+\\)")))
5645 org-export-html-special-string-regexps)))
5650 ))))
5652 'org-latex-and-specials-regexp
5657 "Run through the buffer and add overlays to links."
5661 limit t))
5675 rtn)))
5678 "Restart `font-lock-mode', to force refontification."
5684 "Return a list of all targets in this file.
5685 With optional argument RADIO, only find radio targets."
5687 rtn)
5692 rtn)))
5695 "Make regular expression matching all strings in TARGETS.
5696 The regular expression finds the targets also if there is a line break
5697 between words."
5706 x)
5707 targets
5719 t)))
5722 "Compute the outline level of the heading at point.
5723 This function assumes that the cursor is at the beginning of a line matched
5724 by `outline-regexp'. Otherwise it returns garbage.
5725 If this is called at a normal headline, the level is the number of stars.
5726 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
5733 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
5740 "Functions that can manipulate `org-font-lock-extra-keywords'.
5741 This is calles after `org-font-lock-extra-keywords' is defined, but before
5742 it is installed to be used by font lock. This can be useful if something
5753 ;; Call the hook
5755 ;; Headlines
5762 ;; Table lines
5765 ;; Table internals
5770 ;; Drawers
5773 ;; Properties
5777 ;; Links
5787 ;; TODO keyword
5789 org-todo-regexp)
5791 ;; DONE
5799 nil)
5800 ;; Priorities
5802 ;; Tags
5804 ;; Special keywords
5809 ;; Emphasis
5814 ;; Checkboxes
5815 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
5820 ;; Description list items
5823 ;; ARCHIVEd headings
5825 org-outline-regexp-bol
5828 ;; Specials
5832 ;; Code
5834 ;; COMMENT
5841 ;; Blocks and meta lines
5843 )))
5846 ;; Now set the full font-lock-keywords
5853 "Toggle the composition display of entities as UTF8 characters."
5865 "Find an entity to fontify."
5871 limit t)
5883 nil))))
5886 "Fontify string S like in Org-mode."
5898 "Get the right face for match N in font-lock matching of headlines."
5911 "Get the right face for a TODO keyword KWD.
5912 If KWD is a number, get the corresponding match group."
5920 "Create a face list that inherits INHERIT, but sets the foreground color.
5921 When FACE-OR-COLOR is not a string, just return it."
5925 face-or-color)
5926 face-or-color))
5929 "Add the special tag faces."
5938 "Add the special priority faces."
5945 org-priority-faces)))
5950 "Get the right face for a TODO keyword KWD.
5951 If KWD is a number, get the corresponding match group."
5958 "Remove fontification and activation overlays from links."
5963 deactivate-mark buffer-file-name buffer-file-truename)
5967 invisible t intangible t
5968 org-no-flyspell t org-emphasis t))
5978 "Remove specific display properties that have been added by font lock.
5979 The will remove the raise properties that are used to show superscripts
5980 and subscripts."
5990 "Add raise properties to sub/superscripts."
5994 org-match-substring-regexp
5995 org-match-substring-with-braces-regexp)
5996 limit t)
6006 ;; FIXME: Should we go back one character here, for a_b^c
6007 ;; (goto-char (1- pos)) ;????????????????????
6009 t
6011 'display
6027 t)))))
6029 ;;;; Visibility cycling, including org-goto and indirect buffer
6031 ;;; Cycling
6038 ;;;###autoload
6043 "TAB-action and visibility cycling for Org-mode.
6045 This is the command invoked in Org-mode by the TAB key. Its main purpose
6046 is outline visibility cycling, but it also invokes other actions
6047 in special contexts.
6049 - When this function is called with a prefix argument, rotate the entire
6050 buffer through 3 states (global cycling)
6051 1. OVERVIEW: Show only top-level headlines.
6052 2. CONTENTS: Show all headlines of all levels, but no body text.
6053 3. SHOW ALL: Show everything.
6054 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6055 determined by the variable `org-startup-folded', and by any VISIBILITY
6056 properties in the buffer.
6057 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6058 including any drawers.
6060 - When inside a table, re-align the table and move to the next field.
6062 - When point is at the beginning of a headline, rotate the subtree started
6063 by this line through 3 different states (local cycling)
6064 1. FOLDED: Only the main headline is shown.
6065 2. CHILDREN: The main headline and the direct children are shown.
6066 From this state, you can move to one of the children
6067 and zoom in further.
6068 3. SUBTREE: Show the entire subtree, including body text.
6069 If there is no subtree, switch directly from CHILDREN to FOLDED.
6071 - When point is at the beginning of an empty headline and the variable
6072 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6073 of the headline by demoting and promoting it to likely levels. This
6074 speeds up creation document structure by pressing TAB once or several
6075 times right after creating a new headline.
6077 - When there is a numeric prefix, go up to a heading with level ARG, do
6078 a `show-subtree' and return to the previous cursor position. If ARG
6079 is negative, go up that many levels.
6081 - When point is not at the beginning of a headline, execute the global
6082 binding for TAB, which is re-indenting the line. See the option
6083 `org-cycle-emulate-tab' for details.
6085 - Special case: if point is at the beginning of the buffer and there is
6086 no headline in line 1, this function will act as if called with prefix arg
6087 (C-u TAB, same as S-TAB) also when called without prefix arg.
6088 But only if also the variable `org-cycle-global-at-bob' is t."
6098 org-inlinetask-min-level
6103 limit-level)))
6106 outline-regexp
6114 org-cycle-hook))
6118 ;; special case: use global cycling
6132 ;; Table: enter it or move to the next field.
6143 ;; Global cycling: delegate to `org-cycle-internal-global'.
6146 ;; Drawers: delegate to `org-flag-drawer'.
6154 ;; Show-subtree, ARG levels up from here.
6162 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6170 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6177 ;; From there: TAB emulation and template completion.
6199 t
6208 "Do the global cycling action."
6212 ;; We just created the overview - now do table of contents
6213 ;; This can be slow in very large buffers, so indicate action
6223 ;; We just showed the table of contents - now show everything
6231 ;; Default action: go to overview
6239 "Do the local cycling action."
6241 ;; First, determine end of headline (EOH), end of subtree or item
6242 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6266 ;; Determine end invisible part of buffer (EOL)
6268 ;; XEmacs doesn't have `next-single-char-property-change'
6278 ;; Find out what to do next and set `this-command'
6281 ;; Nothing is hidden behind this heading
6293 org-cycle-skip-children-state-if-no-children))))
6294 ;; Entire subtree is hidden in one line: children view
6300 ;; Fold every list in subtree to top-level items.
6322 ;; We just showed the children, or no children are there,
6323 ;; now show everything.
6330 ;; Default action: hide the subtree.
6337 ;;;###autoload
6339 "Cycle the global visibility. For details see `org-cycle'.
6341 With a numeric prefix, show all headlines up to that level."
6357 "Set the visibility required by startup options and properties."
6372 "Switch subtree visibilities according to :VISIBILITY: property."
6379 nil t)
6403 ;; This function uses outline-regexp instead of the more fundamental
6404 ;; org-outline-regexp so that org-cycle-global works outside of Org
6405 ;; buffers, where outline-regexp is needed.
6407 "Switch to overview mode, showing only top-level headlines.
6408 Really, this shows all headlines with level equal or greater than the level
6409 of the first headline in the buffer. This is important, because if the
6410 first headline is not level one, then (hide-sublevels 1) gives confusing
6411 results."
6422 "Show all headlines in the buffer, like a table of contents.
6423 With numerical argument N, show content up to level N."
6426 ;; Visit all headings and show their offspring
6433 t)
6442 "Adjust the window after a change in outline visibility.
6443 This function is the default value of the hook `org-cycle-hook'."
6453 "Remove outline overlays that do not contain non-white stuff."
6463 "Fix visibility issues after moving a subtree."
6464 ;; First, find a reasonable region to look at:
6465 ;; Start two siblings above, end three below
6483 ;; Properly fold already folded siblings
6494 "Show empty lines above all visible headlines.
6495 The region to be covered depends on STATE when called through
6496 `org-cycle-hook'. Lisp program can use t for STATE to get the
6497 entire buffer covered. Note that an empty line is only shown if there
6498 are at least `org-cycle-separator-lines' empty lines before the headline."
6508 beg end b e)
6532 ;; Never hide empty lines at the end of the file.
6542 "Move to the parent and re-show empty lines before visible headlines."
6548 "Return `org-agenda-files' list, plus all open org-mode files.
6549 This is useful for operations that need to scan all of a user's
6550 open and agenda-wise Org files."
6558 files))
6561 "Return the beginning position of the current entry."
6565 "Return the end position of the current entry."
6569 "Re-hide all drawers after a visibility state change."
6595 "Is the end of the current subtree visible?"
6600 "Move cursor to the first headline and recenter the headline.
6601 Optional argument N means put the headline into the Nth line of the window."
6607 ;;; Saving and restoring visibility
6610 "Return a list of the locations of all outline overlays.
6611 These are overlays with the `invisible' property value `outline'.
6612 The return value is a list of cons cells, with start and stop
6613 positions for each overlay.
6614 If USE-MARKERS is set, return the positions as markers."
6632 "Create visibility overlays for all positions in DATA.
6633 DATA should have been made by `org-outline-overlay-data'."
6641 data)))))
6643 ;;; Folding of blocks
6650 "Call FUNCTION at the head of all source blocks in the current buffer.
6651 Optional arguments START and END can be used to limit the range."
6663 "Toggle the visibility of all blocks in the current buffer."
6667 "Fold all blocks in the current buffer."
6673 "Unfold all blocks in the current buffer."
6679 "Toggle visibility of block at point."
6690 "Toggle the visibility of the current block."
6697 ov)
6713 ;; make the block accessible to isearch
6715 ov 'isearch-open-invisible
6726 ;; org-tab-after-check-for-cycling-hook
6728 ;; Remove overlays when changing major mode
6733 ;;; Org-goto
6739 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command mouse-drag-region universal-argument org-occur)) cmd)
6755 nil)
6756 (org-defkey map "q" 'org-goto-quit)
6757 (org-defkey map "n" 'outline-next-visible-heading)
6758 (org-defkey map "p" 'outline-previous-visible-heading)
6759 (org-defkey map "f" 'outline-forward-same-level)
6760 (org-defkey map "b" 'outline-backward-same-level)
6761 (org-defkey map "u" 'outline-up-heading))
6762 (org-defkey map "/" 'org-occur)
6763 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
6764 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
6765 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
6766 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
6767 (org-defkey map "\C-c\C-u" 'outline-up-heading)
6768 map))
6770 (defconst org-goto-help
6771 "Browse buffer copy, to find location or copy text. Just type for auto-isearch.
6772 RET=jump to location [Q]uit and return to previous location
6773 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
6775 (defvar org-goto-start-pos) ; dynamically scoped parameter
6777 ;; FIXME: Docstring does not mention both interfaces
6778 (defun org-goto (&optional alternative-interface)
6779 "Look up a different location in the current file, keeping current visibility.
6781 When you want look-up or go to a different location in a document, the
6782 fastest way is often to fold the entire buffer and then dive into the tree.
6783 This method has the disadvantage, that the previous location will be folded,
6784 which may not be what you want.
6786 This command works around this by showing a copy of the current buffer
6787 in an indirect buffer, in overview mode. You can dive into the tree in
6788 that copy, use org-occur and incremental search to find a location.
6789 When pressing RET or `Q', the command returns to the original buffer in
6790 which the visibility is still unchanged. After RET is will also jump to
6791 the location selected in the indirect buffer and expose the headline
6792 hierarchy above."
6793 (interactive "P")
6794 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
6795 (org-refile-use-outline-path t)
6796 (org-refile-target-verify-function nil)
6797 (interface
6798 (if (not alternative-interface)
6799 org-goto-interface
6800 (if (eq org-goto-interface 'outline)
6801 'outline-path-completion
6802 'outline)))
6803 (org-goto-start-pos (point))
6804 (selected-point
6805 (if (eq interface 'outline)
6806 (car (org-get-location (current-buffer) org-goto-help))
6807 (let ((pa (org-refile-get-location "Goto")))
6808 (org-refile-check-position pa)
6809 (nth 3 pa)))))
6810 (if selected-point
6811 (progn
6812 (org-mark-ring-push org-goto-start-pos)
6813 (goto-char selected-point)
6814 (if (or (outline-invisible-p) (org-invisible-p2))
6815 (org-show-context 'org-goto)))
6816 (message "Quit"))))
6818 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
6819 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
6820 (defvar org-goto-local-auto-isearch-map) ; defined below
6822 (defun org-get-location (buf help)
6823 "Let the user select a location in the Org-mode buffer BUF.
6824 This function uses a recursive edit. It returns the selected position
6825 or nil."
6826 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
6827 (isearch-hide-immediately nil)
6828 (isearch-search-fun-function
6829 (lambda () 'org-goto-local-search-headings))
6830 (org-goto-selected-point org-goto-exit-command)
6831 (pop-up-frames nil)
6832 (special-display-buffer-names nil)
6833 (special-display-regexps nil)
6834 (special-display-function nil))
6835 (save-excursion
6836 (save-window-excursion
6837 (delete-other-windows)
6838 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
6839 (org-pop-to-buffer-same-window
6840 (condition-case nil
6841 (make-indirect-buffer (current-buffer) "*org-goto*")
6842 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
6843 (with-output-to-temp-buffer "*Help*"
6844 (princ help))
6845 (org-fit-window-to-buffer (get-buffer-window "*Help*"))
6846 (setq buffer-read-only nil)
6847 (let ((org-startup-truncated t)
6848 (org-startup-folded nil)
6849 (org-startup-align-all-tables nil))
6850 (org-mode)
6851 (org-overview))
6852 (setq buffer-read-only t)
6853 (if (and (boundp 'org-goto-start-pos)
6854 (integer-or-marker-p org-goto-start-pos))
6855 (let ((org-show-hierarchy-above t)
6856 (org-show-siblings t)
6857 (org-show-following-heading t))
6858 (goto-char org-goto-start-pos)
6859 (and (outline-invisible-p) (org-show-context)))
6860 (goto-char (point-min)))
6861 (let (org-special-ctrl-a/e) (org-beginning-of-line))
6862 (message "Select location and press RET")
6863 (use-local-map org-goto-map)
6864 (recursive-edit)
6865 ))
6866 (kill-buffer "*org-goto*")
6867 (cons org-goto-selected-point org-goto-exit-command)))
6869 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
6870 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
6871 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
6872 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
6874 (defun org-goto-local-search-headings (string bound noerror)
6875 "Search and make sure that any matches are in headlines."
6876 (catch 'return
6877 (while (if isearch-forward
6878 (search-forward string bound noerror)
6879 (search-backward string bound noerror))
6880 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
6881 (and (member :headline context)
6882 (not (member :tags context))))
6883 (throw 'return (point))))))
6885 (defun org-goto-local-auto-isearch ()
6886 "Start isearch."
6887 (interactive)
6888 (goto-char (point-min))
6889 (let ((keys (this-command-keys)))
6890 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
6891 (isearch-mode t)
6892 (isearch-process-search-char (string-to-char keys)))))
6894 (defun org-goto-ret (&optional arg)
6895 "Finish `org-goto' by going to the new location."
6896 (interactive "P")
6897 (setq org-goto-selected-point (point)
6898 org-goto-exit-command 'return)
6899 (throw 'exit nil))
6901 (defun org-goto-left ()
6902 "Finish `org-goto' by going to the new location."
6903 (interactive)
6904 (if (org-at-heading-p)
6905 (progn
6906 (beginning-of-line 1)
6907 (setq org-goto-selected-point (point)
6908 org-goto-exit-command 'left)
6909 (throw 'exit nil))
6910 (error "Not on a heading")))
6912 (defun org-goto-right ()
6913 "Finish `org-goto' by going to the new location."
6914 (interactive)
6915 (if (org-at-heading-p)
6916 (progn
6917 (setq org-goto-selected-point (point)
6918 org-goto-exit-command 'right)
6919 (throw 'exit nil))
6920 (error "Not on a heading")))
6922 (defun org-goto-quit ()
6923 "Finish `org-goto' without cursor motion."
6924 (interactive)
6925 (setq org-goto-selected-point nil)
6926 (setq org-goto-exit-command 'quit)
6927 (throw 'exit nil))
6929 ;;; Indirect buffer display of subtrees
6931 (defvar org-indirect-dedicated-frame nil
6932 "This is the frame being used for indirect tree display.")
6933 (defvar org-last-indirect-buffer nil)
6935 (defun org-tree-to-indirect-buffer (&optional arg)
6936 "Create indirect buffer and narrow it to current subtree.
6937 With numerical prefix ARG, go up to this level and then take that tree.
6938 If ARG is negative, go up that many levels.
6939 If `org-indirect-buffer-display' is not `new-frame', the command removes the
6940 indirect buffer previously made with this command, to avoid proliferation of
6941 indirect buffers. However, when you call the command with a \
6943 when `org-indirect-buffer-display' is `new-frame', the last buffer
6944 is kept so that you can work with several indirect buffers at the same time.
6945 If `org-indirect-buffer-display' is `dedicated-frame', the \
6947 requests that a new frame be made for the new buffer, so that the dedicated
6948 frame is not changed."
6949 (interactive "P")
6950 (let ((cbuf (current-buffer))
6951 (cwin (selected-window))
6952 (pos (point))
6953 beg end level heading ibuf)
6954 (save-excursion
6955 (org-back-to-heading t)
6956 (when (numberp arg)
6957 (setq level (org-outline-level))
6958 (if (< arg 0) (setq arg (+ level arg)))
6959 (while (> (setq level (org-outline-level)) arg)
6960 (outline-up-heading 1 t)))
6961 (setq beg (point)
6962 heading (org-get-heading))
6963 (org-end-of-subtree t t)
6964 (if (org-at-heading-p) (backward-char 1))
6965 (setq end (point)))
6966 (if (and (buffer-live-p org-last-indirect-buffer)
6967 (not (eq org-indirect-buffer-display 'new-frame))
6968 (not arg))
6969 (kill-buffer org-last-indirect-buffer))
6970 (setq ibuf (org-get-indirect-buffer cbuf)
6971 org-last-indirect-buffer ibuf)
6972 (cond
6973 ((or (eq org-indirect-buffer-display 'new-frame)
6974 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
6975 (select-frame (make-frame))
6976 (delete-other-windows)
6977 (org-pop-to-buffer-same-window ibuf)
6978 (org-set-frame-title heading))
6979 ((eq org-indirect-buffer-display 'dedicated-frame)
6980 (raise-frame
6981 (select-frame (or (and org-indirect-dedicated-frame
6982 (frame-live-p org-indirect-dedicated-frame)
6983 org-indirect-dedicated-frame)
6984 (setq org-indirect-dedicated-frame (make-frame)))))
6985 (delete-other-windows)
6986 (org-pop-to-buffer-same-window ibuf)
6987 (org-set-frame-title (concat "Indirect: " heading)))
6988 ((eq org-indirect-buffer-display 'current-window)
6989 (org-pop-to-buffer-same-window ibuf))
6990 ((eq org-indirect-buffer-display 'other-window)
6991 (pop-to-buffer ibuf))
6992 (t (error "Invalid value")))
6993 (if (featurep 'xemacs)
6994 (save-excursion (org-mode) (turn-on-font-lock)))
6995 (narrow-to-region beg end)
6996 (show-all)
6997 (goto-char pos)
6998 (run-hook-with-args 'org-cycle-hook 'all)
6999 (and (window-live-p cwin) (select-window cwin))))
7001 (defun org-get-indirect-buffer (&optional buffer)
7002 (setq buffer (or buffer (current-buffer)))
7003 (let ((n 1) (base (buffer-name buffer)) bname)
7004 (while (buffer-live-p
7005 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7006 (setq n (1+ n)))
7007 (condition-case nil
7008 (make-indirect-buffer buffer bname 'clone)
7009 (error (make-indirect-buffer buffer bname)))))
7011 (defun org-set-frame-title (title)
7012 "Set the title of the current frame to the string TITLE."
7013 ;; FIXME: how to name a single frame in XEmacs???
7014 (unless (featurep 'xemacs)
7015 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7017 ;;;; Structure editing
7019 ;;; Inserting headlines
7021 (defun org-previous-line-empty-p ()
7022 (save-excursion
7023 (and (not (bobp))
7024 (or (beginning-of-line 0) t)
7025 (save-match-data
7028 (defun org-insert-heading (&optional force-heading invisible-ok)
7029 "Insert a new heading or item with same depth at point.
7030 If point is in a plain list and FORCE-HEADING is nil, create a new list item.
7031 If point is at the beginning of a headline, insert a sibling before the
7032 current headline. If point is not at the beginning, split the line,
7033 create the new headline with the text in the current line after point
7034 \(but see also the variable `org-M-RET-may-split-line').
7036 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7037 This is important for non-interactive uses of the command."
7038 (interactive "P")
7039 (if (or (= (buffer-size) 0)
7040 (and (not (save-excursion
7041 (and (ignore-errors (org-back-to-heading invisible-ok))
7042 (org-at-heading-p))))
7043 (or force-heading (not (org-in-item-p)))))
7044 (progn
7046 (run-hooks 'org-insert-heading-hook))
7047 (when (or force-heading (not (org-insert-item)))
7048 (let* ((empty-line-p nil)
7049 (level nil)
7050 (on-heading (org-at-heading-p))
7051 (head (save-excursion
7052 (condition-case nil
7053 (progn
7054 (org-back-to-heading invisible-ok)
7055 (when (and (not on-heading)
7056 (featurep 'org-inlinetask)
7057 (integerp org-inlinetask-min-level)
7058 (>= (length (match-string 0))
7059 org-inlinetask-min-level))
7060 ;; Find a heading level before the inline task
7061 (while (and (setq level (org-up-heading-safe))
7062 (>= level org-inlinetask-min-level)))
7063 (if (org-at-heading-p)
7064 (org-back-to-heading invisible-ok)
7065 (error "This should not happen")))
7066 (setq empty-line-p (org-previous-line-empty-p))
7067 (match-string 0))
7068 (error "*"))))
7069 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7070 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7071 pos hide-previous previous-pos)
7072 (cond
7073 ((and (org-at-heading-p) (bolp)
7074 (or (bobp)
7075 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7076 ;; insert before the current line
7077 (open-line (if blank 2 1)))
7078 ((and (bolp)
7079 (not org-insert-heading-respect-content)
7080 (or (bobp)
7081 (save-excursion
7082 (backward-char 1) (not (outline-invisible-p)))))
7083 ;; insert right here
7084 nil)
7085 (t
7086 ;; somewhere in the line
7087 (save-excursion
7088 (setq previous-pos (point-at-bol))
7089 (end-of-line)
7090 (setq hide-previous (outline-invisible-p)))
7091 (and org-insert-heading-respect-content (org-show-subtree))
7092 (let ((split
7093 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7094 (save-excursion
7095 (let ((p (point)))
7096 (goto-char (point-at-bol))
7097 (and (looking-at org-complex-heading-regexp)
7098 (match-beginning 4)
7099 (> p (match-beginning 4)))))))
7100 tags pos)
7101 (cond
7102 (org-insert-heading-respect-content
7103 (org-end-of-subtree nil t)
7104 (when (featurep 'org-inlinetask)
7105 (while (and (not (eobp))
7107 (>= (length (match-string 1))
7108 org-inlinetask-min-level))
7109 (org-end-of-subtree nil t)))
7110 (or (bolp) (newline))
7111 (or (org-previous-line-empty-p)
7112 (and blank (newline)))
7113 (open-line 1))
7114 ((org-at-heading-p)
7115 (when hide-previous
7116 (show-children)
7117 (org-show-entry))
7119 (setq tags (and (match-end 2) (match-string 2)))
7120 (and (match-end 1)
7121 (delete-region (match-beginning 1) (match-end 1)))
7122 (setq pos (point-at-bol))
7123 (or split (end-of-line 1))
7124 (delete-horizontal-space)
7126 (buffer-substring (point-at-bol) (point)))
7127 (insert " "))
7128 (newline (if blank 2 1))
7129 (when tags
7130 (save-excursion
7131 (goto-char pos)
7132 (end-of-line 1)
7133 (insert " " tags)
7134 (org-set-tags nil 'align))))
7135 (t
7136 (or split (end-of-line 1))
7137 (newline (if blank 2 1)))))))
7138 (insert head) (just-one-space)
7139 (setq pos (point))
7140 (end-of-line 1)
7141 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7142 (when (and org-insert-heading-respect-content hide-previous)
7143 (save-excursion
7144 (goto-char previous-pos)
7145 (hide-subtree)))
7146 (run-hooks 'org-insert-heading-hook)))))
7148 (defun org-get-heading (&optional no-tags no-todo)
7149 "Return the heading of the current entry, without the stars.
7150 When NO-TAGS is non-nil, don't include tags.
7151 When NO-TODO is non-nil, don't include TODO keywords."
7152 (save-excursion
7153 (org-back-to-heading t)
7154 (cond
7155 ((and no-tags no-todo)
7156 (looking-at org-complex-heading-regexp)
7157 (match-string 4))
7158 (no-tags
7159 (looking-at (concat org-outline-regexp
7162 (match-string 1))
7163 (no-todo
7164 (looking-at org-todo-line-regexp)
7165 (match-string 3))
7166 (t (looking-at org-heading-regexp)
7167 (match-string 2)))))
7169 (defun org-heading-components ()
7170 "Return the components of the current heading.
7171 This is a list with the following elements:
7172 - the level as an integer
7173 - the reduced level, different if `org-odd-levels-only' is set.
7174 - the TODO keyword, or nil
7175 - the priority character, like ?A, or nil if no priority is given
7176 - the headline text itself, or the tags string if no headline text
7177 - the tags string, or nil."
7178 (save-excursion
7179 (org-back-to-heading t)
7180 (if (let (case-fold-search) (looking-at org-complex-heading-regexp))
7181 (list (length (match-string 1))
7182 (org-reduced-level (length (match-string 1)))
7183 (org-match-string-no-properties 2)
7184 (and (match-end 3) (aref (match-string 3) 2))
7185 (org-match-string-no-properties 4)
7186 (org-match-string-no-properties 5)))))
7188 (defun org-get-entry ()
7189 "Get the entry text, after heading, entire subtree."
7190 (save-excursion
7191 (org-back-to-heading t)
7192 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7194 (defun org-insert-heading-after-current ()
7195 "Insert a new heading with same level as current, after current subtree."
7196 (interactive)
7197 (org-back-to-heading)
7198 (org-insert-heading)
7199 (org-move-subtree-down)
7200 (end-of-line 1))
7202 (defun org-insert-heading-respect-content ()
7203 (interactive)
7204 (let ((org-insert-heading-respect-content t))
7205 (org-insert-heading t)))
7207 (defun org-insert-todo-heading-respect-content (&optional force-state)
7208 (interactive "P")
7209 (let ((org-insert-heading-respect-content t))
7210 (org-insert-todo-heading force-state t)))
7212 (defun org-insert-todo-heading (arg &optional force-heading)
7213 "Insert a new heading with the same level and TODO state as current heading.
7214 If the heading has no TODO state, or if the state is DONE, use the first
7215 state (TODO by default). Also with prefix arg, force first state."
7216 (interactive "P")
7217 (when (or force-heading (not (org-insert-item 'checkbox)))
7218 (org-insert-heading force-heading)
7219 (save-excursion
7220 (org-back-to-heading)
7221 (outline-previous-heading)
7222 (looking-at org-todo-line-regexp))
7223 (let*
7224 ((new-mark-x
7225 (if (or arg
7226 (not (match-beginning 2))
7227 (member (match-string 2) org-done-keywords))
7228 (car org-todo-keywords-1)
7229 (match-string 2)))
7230 (new-mark
7231 (or
7232 (run-hook-with-args-until-success
7233 'org-todo-get-default-hook new-mark-x nil)
7234 new-mark-x)))
7235 (beginning-of-line 1)
7236 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7237 (if org-treat-insert-todo-heading-as-state-change
7238 (org-todo new-mark)
7239 (insert new-mark " "))))
7240 (when org-provide-todo-statistics
7241 (org-update-parent-todo-statistics))))
7243 (defun org-insert-subheading (arg)
7244 "Insert a new subheading and demote it.
7245 Works for outline headings and for plain lists alike."
7246 (interactive "P")
7247 (org-insert-heading arg)
7248 (cond
7249 ((org-at-heading-p) (org-do-demote))
7250 ((org-at-item-p) (org-indent-item))))
7252 (defun org-insert-todo-subheading (arg)
7253 "Insert a new subheading with TODO keyword or checkbox and demote it.
7254 Works for outline headings and for plain lists alike."
7255 (interactive "P")
7256 (org-insert-todo-heading arg)
7257 (cond
7258 ((org-at-heading-p) (org-do-demote))
7259 ((org-at-item-p) (org-indent-item))))
7261 ;;; Promotion and Demotion
7263 (defvar org-after-demote-entry-hook nil
7264 "Hook run after an entry has been demoted.
7265 The cursor will be at the beginning of the entry.
7266 When a subtree is being demoted, the hook will be called for each node.")
7268 (defvar org-after-promote-entry-hook nil
7269 "Hook run after an entry has been promoted.
7270 The cursor will be at the beginning of the entry.
7271 When a subtree is being promoted, the hook will be called for each node.")
7273 (defun org-promote-subtree ()
7274 "Promote the entire subtree.
7275 See also `org-promote'."
7276 (interactive)
7277 (save-excursion
7278 (org-with-limited-levels (org-map-tree 'org-promote)))
7279 (org-fix-position-after-promote))
7281 (defun org-demote-subtree ()
7282 "Demote the entire subtree. See `org-demote'.
7283 See also `org-promote'."
7284 (interactive)
7285 (save-excursion
7286 (org-with-limited-levels (org-map-tree 'org-demote)))
7287 (org-fix-position-after-promote))
7290 (defun org-do-promote ()
7291 "Promote the current heading higher up the tree.
7292 If the region is active in `transient-mark-mode', promote all headings
7293 in the region."
7294 (interactive)
7295 (save-excursion
7296 (if (org-region-active-p)
7297 (org-map-region 'org-promote (region-beginning) (region-end))
7298 (org-promote)))
7299 (org-fix-position-after-promote))
7301 (defun org-do-demote ()
7302 "Demote the current heading lower down the tree.
7303 If the region is active in `transient-mark-mode', demote all headings
7304 in the region."
7305 (interactive)
7306 (save-excursion
7307 (if (org-region-active-p)
7308 (org-map-region 'org-demote (region-beginning) (region-end))
7309 (org-demote)))
7310 (org-fix-position-after-promote))
7312 (defun org-fix-position-after-promote ()
7313 "Make sure that after pro/demotion cursor position is right."
7314 (let ((pos (point)))
7315 (when (save-excursion
7316 (beginning-of-line 1)
7317 (looking-at org-todo-line-regexp)
7318 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7319 (cond ((eobp) (insert " "))
7320 ((eolp) (insert " "))
7321 ((equal (char-after) ?\ ) (forward-char 1))))))
7323 (defun org-current-level ()
7324 "Return the level of the current entry, or nil if before the first headline.
7325 The level is the number of stars at the beginning of the headline."
7326 (save-excursion
7327 (org-with-limited-levels
7328 (if (ignore-errors (org-back-to-heading t))
7329 (funcall outline-level)))))
7331 (defun org-get-previous-line-level ()
7332 "Return the outline depth of the last headline before the current line.
7333 Returns 0 for the first headline in the buffer, and nil if before the
7334 first headline."
7335 (let ((current-level (org-current-level))
7336 (prev-level (when (> (line-number-at-pos) 1)
7337 (save-excursion
7338 (beginning-of-line 0)
7339 (org-current-level)))))
7340 (cond ((null current-level) nil) ; Before first headline
7341 ((null prev-level) 0) ; At first headline
7342 (prev-level))))
7344 (defun org-reduced-level (l)
7345 "Compute the effective level of a heading.
7346 This takes into account the setting of `org-odd-levels-only'."
7347 (cond
7348 ((zerop l) 0)
7349 (org-odd-levels-only (1+ (floor (/ l 2))))
7350 (t l)))
7352 (defun org-level-increment ()
7353 "Return the number of stars that will be added or removed at a
7354 time to headlines when structure editing, based on the value of
7355 `org-odd-levels-only'."
7356 (if org-odd-levels-only 2 1))
7358 (defun org-get-valid-level (level &optional change)
7359 "Rectify a level change under the influence of `org-odd-levels-only'
7360 LEVEL is a current level, CHANGE is by how much the level should be
7361 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7362 even level numbers will become the next higher odd number."
7363 (if org-odd-levels-only
7364 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7365 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7366 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7367 (max 1 (+ level (or change 0)))))
7369 (if (boundp 'define-obsolete-function-alias)
7370 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7371 (define-obsolete-function-alias 'org-get-legal-level
7372 'org-get-valid-level)
7373 (define-obsolete-function-alias 'org-get-legal-level
7374 'org-get-valid-level "23.1")))
7376 (defun org-promote ()
7377 "Promote the current heading higher up the tree.
7378 If the region is active in `transient-mark-mode', promote all headings
7379 in the region."
7380 (org-back-to-heading t)
7381 (let* ((level (save-match-data (funcall outline-level)))
7382 (after-change-functions (remove 'flyspell-after-change-function
7383 after-change-functions))
7384 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7385 (diff (abs (- level (length up-head) -1))))
7386 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover if necessary"))
7387 (replace-match up-head nil t)
7388 ;; Fixup tag positioning
7389 (and org-auto-align-tags (org-set-tags nil t))
7390 (if org-adapt-indentation (org-fixup-indentation (- diff)))
7391 (run-hooks 'org-after-promote-entry-hook)))
7393 (defun org-demote ()
7394 "Demote the current heading lower down the tree.
7395 If the region is active in `transient-mark-mode', demote all headings
7396 in the region."
7397 (org-back-to-heading t)
7398 (let* ((level (save-match-data (funcall outline-level)))
7399 (after-change-functions (remove 'flyspell-after-change-function
7400 after-change-functions))
7401 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7402 (diff (abs (- level (length down-head) -1))))
7403 (replace-match down-head nil t)
7404 ;; Fixup tag positioning
7405 (and org-auto-align-tags (org-set-tags nil t))
7406 (if org-adapt-indentation (org-fixup-indentation diff))
7407 (run-hooks 'org-after-demote-entry-hook)))
7409 (defun org-cycle-level ()
7410 "Cycle the level of an empty headline through possible states.
7411 This goes first to child, then to parent, level, then up the hierarchy.
7412 After top level, it switches back to sibling level."
7413 (interactive)
7414 (let ((org-adapt-indentation nil))
7415 (when (org-point-at-end-of-empty-headline)
7416 (setq this-command 'org-cycle-level) ; Only needed for caching
7417 (let ((cur-level (org-current-level))
7418 (prev-level (org-get-previous-line-level)))
7419 (cond
7420 ;; If first headline in file, promote to top-level.
7421 ((= prev-level 0)
7422 (loop repeat (/ (- cur-level 1) (org-level-increment))
7423 do (org-do-promote)))
7424 ;; If same level as prev, demote one.
7425 ((= prev-level cur-level)
7426 (org-do-demote))
7427 ;; If parent is top-level, promote to top level if not already.
7428 ((= prev-level 1)
7429 (loop repeat (/ (- cur-level 1) (org-level-increment))
7430 do (org-do-promote)))
7431 ;; If top-level, return to prev-level.
7432 ((= cur-level 1)
7433 (loop repeat (/ (- prev-level 1) (org-level-increment))
7434 do (org-do-demote)))
7435 ;; If less than prev-level, promote one.
7436 ((< cur-level prev-level)
7437 (org-do-promote))
7438 ;; If deeper than prev-level, promote until higher than
7439 ;; prev-level.
7440 ((> cur-level prev-level)
7441 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7442 do (org-do-promote))))
7443 t))))
7445 (defun org-map-tree (fun)
7446 "Call FUN for every heading underneath the current one."
7447 (org-back-to-heading)
7448 (let ((level (funcall outline-level)))
7449 (save-excursion
7450 (funcall fun)
7451 (while (and (progn
7452 (outline-next-heading)
7453 (> (funcall outline-level) level))
7454 (not (eobp)))
7455 (funcall fun)))))
7457 (defun org-map-region (fun beg end)
7458 "Call FUN for every heading between BEG and END."
7459 (let ((org-ignore-region t))
7460 (save-excursion
7461 (setq end (copy-marker end))
7462 (goto-char beg)
7463 (if (and (re-search-forward org-outline-regexp-bol nil t)
7464 (< (point) end))
7465 (funcall fun))
7466 (while (and (progn
7467 (outline-next-heading)
7468 (< (point) end))
7469 (not (eobp)))
7470 (funcall fun)))))
7472 (defvar org-property-end-re) ; silence byte-compiler
7473 (defun org-fixup-indentation (diff)
7474 "Change the indentation in the current entry by DIFF.
7475 However, if any line in the current entry has no indentation, or if it
7476 would end up with no indentation after the change, nothing at all is done."
7477 (save-excursion
7478 (let ((end (save-excursion (outline-next-heading)
7479 (point-marker)))
7480 (prohibit (if (> diff 0)
7483 col)
7484 (unless (save-excursion (end-of-line 1)
7485 (re-search-forward prohibit end t))
7486 (while (and (< (point) end)
7488 (goto-char (match-end 0))
7489 (setq col (current-column))
7490 (if (< diff 0) (replace-match ""))
7491 (org-indent-to-column (+ diff col))))
7492 (move-marker end nil))))
7494 (defun org-convert-to-odd-levels ()
7495 "Convert an org-mode file with all levels allowed to one with odd levels.
7496 This will leave level 1 alone, convert level 2 to level 3, level 3 to
7497 level 5 etc."
7498 (interactive)
7499 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
7500 (let ((outline-level 'org-outline-level)
7501 (org-odd-levels-only nil) n)
7502 (save-excursion
7503 (goto-char (point-min))
7505 (setq n (- (length (match-string 0)) 2))
7506 (while (>= (setq n (1- n)) 0)
7507 (org-demote))
7508 (end-of-line 1))))))
7510 (defun org-convert-to-oddeven-levels ()
7511 "Convert an org-mode file with only odd levels to one with odd/even levels.
7512 This promotes level 3 to level 2, level 5 to level 3 etc. If the
7513 file contains a section with an even level, conversion would
7514 destroy the structure of the file. An error is signaled in this
7515 case."
7516 (interactive)
7517 (goto-char (point-min))
7518 ;; First check if there are no even levels
7520 (org-show-context t)
7521 (error "Not all levels are odd in this file. Conversion not possible"))
7522 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
7523 (let ((outline-regexp org-outline-regexp)
7524 (outline-level 'org-outline-level)
7525 (org-odd-levels-only nil) n)
7526 (save-excursion
7527 (goto-char (point-min))
7529 (setq n (/ (1- (length (match-string 0))) 2))
7530 (while (>= (setq n (1- n)) 0)
7531 (org-promote))
7532 (end-of-line 1))))))
7534 (defun org-tr-level (n)
7535 "Make N odd if required."
7536 (if org-odd-levels-only (1+ (/ n 2)) n))
7538 ;;; Vertical tree motion, cutting and pasting of subtrees
7540 (defun org-move-subtree-up (&optional arg)
7541 "Move the current subtree up past ARG headlines of the same level."
7542 (interactive "p")
7543 (org-move-subtree-down (- (prefix-numeric-value arg))))
7545 (defun org-move-subtree-down (&optional arg)
7546 "Move the current subtree down past ARG headlines of the same level."
7547 (interactive "p")
7548 (setq arg (prefix-numeric-value arg))
7549 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
7550 'org-get-last-sibling))
7551 (ins-point (make-marker))
7552 (cnt (abs arg))
7553 (col (current-column))
7554 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
7555 ;; Select the tree
7556 (org-back-to-heading)
7557 (setq beg0 (point))
7558 (save-excursion
7559 (setq ne-beg (org-back-over-empty-lines))
7560 (setq beg (point)))
7561 (save-match-data
7562 (save-excursion (outline-end-of-heading)
7563 (setq folded (outline-invisible-p)))
7564 (outline-end-of-subtree))
7565 (outline-next-heading)
7566 (setq ne-end (org-back-over-empty-lines))
7567 (setq end (point))
7568 (goto-char beg0)
7569 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
7570 ;; include less whitespace
7571 (save-excursion
7572 (goto-char beg)
7573 (forward-line (- ne-beg ne-end))
7574 (setq beg (point))))
7575 ;; Find insertion point, with error handling
7576 (while (> cnt 0)
7577 (or (and (funcall movfunc) (looking-at org-outline-regexp))
7578 (progn (goto-char beg0)
7579 (error "Cannot move past superior level or buffer limit")))
7580 (setq cnt (1- cnt)))
7581 (if (> arg 0)
7582 ;; Moving forward - still need to move over subtree
7583 (progn (org-end-of-subtree t t)
7584 (save-excursion
7585 (org-back-over-empty-lines)
7586 (or (bolp) (newline)))))
7587 (setq ne-ins (org-back-over-empty-lines))
7588 (move-marker ins-point (point))
7589 (setq txt (buffer-substring beg end))
7590 (org-save-markers-in-region beg end)
7591 (delete-region beg end)
7592 (org-remove-empty-overlays-at beg)
7593 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
7594 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
7596 (let ((bbb (point)))
7597 (insert-before-markers txt)
7598 (org-reinstall-markers-in-region bbb)
7599 (move-marker ins-point bbb))
7601 (setq ins-end (point))
7602 (goto-char ins-point)
7603 (org-skip-whitespace)
7604 (when (and (< arg 0)
7605 (org-first-sibling-p)
7606 (> ne-ins ne-beg))
7607 ;; Move whitespace back to beginning
7608 (save-excursion
7609 (goto-char ins-end)
7610 (let ((kill-whole-line t))
7611 (kill-line (- ne-ins ne-beg)) (point)))
7613 (move-marker ins-point nil)
7614 (if folded
7615 (hide-subtree)
7616 (org-show-entry)
7617 (show-children)
7618 (org-cycle-hide-drawers 'children))
7619 (org-clean-visibility-after-subtree-move)
7620 ;; move back to the initial column we were at
7621 (move-to-column col)))
7623 (defvar org-subtree-clip ""
7624 "Clipboard for cut and paste of subtrees.
7625 This is actually only a copy of the kill, because we use the normal kill
7626 ring. We need it to check if the kill was created by `org-copy-subtree'.")
7628 (defvar org-subtree-clip-folded nil
7629 "Was the last copied subtree folded?
7630 This is used to fold the tree back after pasting.")
7632 (defun org-cut-subtree (&optional n)
7633 "Cut the current subtree into the clipboard.
7634 With prefix arg N, cut this many sequential subtrees.
7635 This is a short-hand for marking the subtree and then cutting it."
7636 (interactive "p")
7637 (org-copy-subtree n 'cut))
7639 (defun org-copy-subtree (&optional n cut force-store-markers)
7640 "Cut the current subtree into the clipboard.
7641 With prefix arg N, cut this many sequential subtrees.
7642 This is a short-hand for marking the subtree and then copying it.
7643 If CUT is non-nil, actually cut the subtree.
7644 If FORCE-STORE-MARKERS is non-nil, store the relative locations
7645 of some markers in the region, even if CUT is non-nil. This is
7646 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
7647 (interactive "p")
7648 (let (beg end folded (beg0 (point)))
7649 (if (org-called-interactively-p 'any)
7650 (org-back-to-heading nil) ; take what looks like a subtree
7651 (org-back-to-heading t)) ; take what is really there
7652 (org-back-over-empty-lines)
7653 (setq beg (point))
7655 (save-match-data
7656 (save-excursion (outline-end-of-heading)
7657 (setq folded (outline-invisible-p)))
7658 (condition-case nil
7659 (org-forward-same-level (1- n) t)
7660 (error nil))
7661 (org-end-of-subtree t t))
7662 (org-back-over-empty-lines)
7663 (setq end (point))
7664 (goto-char beg0)
7665 (when (> end beg)
7666 (setq org-subtree-clip-folded folded)
7667 (when (or cut force-store-markers)
7668 (org-save-markers-in-region beg end))
7669 (if cut (kill-region beg end) (copy-region-as-kill beg end))
7670 (setq org-subtree-clip (current-kill 0))
7671 (message "%s: Subtree(s) with %d characters"
7672 (if cut "Cut" "Copied")
7673 (length org-subtree-clip)))))
7675 (defun org-paste-subtree (&optional level tree for-yank)
7676 "Paste the clipboard as a subtree, with modification of headline level.
7677 The entire subtree is promoted or demoted in order to match a new headline
7678 level.
7680 If the cursor is at the beginning of a headline, the same level as
7681 that headline is used to paste the tree
7683 If not, the new level is derived from the *visible* headings
7684 before and after the insertion point, and taken to be the inferior headline
7685 level of the two. So if the previous visible heading is level 3 and the
7686 next is level 4 (or vice versa), level 4 will be used for insertion.
7687 This makes sure that the subtree remains an independent subtree and does
7688 not swallow low level entries.
7690 You can also force a different level, either by using a numeric prefix
7691 argument, or by inserting the heading marker by hand. For example, if the
7694 If optional TREE is given, use this text instead of the kill ring.
7696 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
7697 move back over whitespace before inserting, and move point to the end of
7698 the inserted text when done."
7699 (interactive "P")
7700 (setq tree (or tree (and kill-ring (current-kill 0))))
7701 (unless (org-kill-is-subtree-p tree)
7702 (error "%s"
7703 (substitute-command-keys
7705 (org-with-limited-levels
7706 (let* ((visp (not (outline-invisible-p)))
7707 (txt tree)
7709 (old-level (if (string-match org-outline-regexp-bol txt)
7710 (- (match-end 0) (match-beginning 0) 1)
7711 -1))
7712 (force-level (cond (level (prefix-numeric-value level))
7714 (string-match
7716 (point-at-bol) (point))))
7717 (- (match-end 1) (match-beginning 1)))
7718 ((and (bolp)
7719 (looking-at org-outline-regexp))
7720 (- (match-end 0) (point) 1))
7721 (t nil)))
7722 (previous-level (save-excursion
7723 (condition-case nil
7724 (progn
7725 (outline-previous-visible-heading 1)
7726 (if (looking-at ^re_)
7727 (- (match-end 0) (match-beginning 0) 1)
7728 1))
7729 (error 1))))
7730 (next-level (save-excursion
7731 (condition-case nil
7732 (progn
7733 (or (looking-at org-outline-regexp)
7734 (outline-next-visible-heading 1))
7735 (if (looking-at ^re_)
7736 (- (match-end 0) (match-beginning 0) 1)
7737 1))
7738 (error 1))))
7739 (new-level (or force-level (max previous-level next-level)))
7740 (shift (if (or (= old-level -1)
7741 (= new-level -1)
7742 (= old-level new-level))
7743 0
7744 (- new-level old-level)))
7745 (delta (if (> shift 0) -1 1))
7746 (func (if (> shift 0) 'org-demote 'org-promote))
7747 (org-odd-levels-only nil)
7748 beg end newend)
7749 ;; Remove the forced level indicator
7750 (if force-level
7751 (delete-region (point-at-bol) (point)))
7752 ;; Paste
7753 (beginning-of-line (if (bolp) 1 2))
7754 (unless for-yank (org-back-over-empty-lines))
7755 (setq beg (point))
7756 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
7757 (insert-before-markers txt)
7759 (setq newend (point))
7760 (org-reinstall-markers-in-region beg)
7761 (setq end (point))
7762 (goto-char beg)
7764 (setq beg (point))
7765 (if (and (outline-invisible-p) visp)
7766 (save-excursion (outline-show-heading)))
7767 ;; Shift if necessary
7768 (unless (= shift 0)
7769 (save-restriction
7770 (narrow-to-region beg end)
7771 (while (not (= shift 0))
7772 (org-map-region func (point-min) (point-max))
7773 (setq shift (+ delta shift)))
7774 (goto-char (point-min))
7775 (setq newend (point-max))))
7776 (when (or (org-called-interactively-p 'interactive) for-yank)
7777 (message "Clipboard pasted as level %d subtree" new-level))
7778 (if (and (not for-yank) ; in this case, org-yank will decide about folding
7779 kill-ring
7780 (eq org-subtree-clip (current-kill 0))
7781 org-subtree-clip-folded)
7782 ;; The tree was folded before it was killed/copied
7783 (hide-subtree))
7784 (and for-yank (goto-char newend)))))
7786 (defun org-kill-is-subtree-p (&optional txt)
7787 "Check if the current kill is an outline subtree, or a set of trees.
7788 Returns nil if kill does not start with a headline, or if the first
7789 headline level is not the largest headline level in the tree.
7790 So this will actually accept several entries of equal levels as well,
7791 which is OK for `org-paste-subtree'.
7792 If optional TXT is given, check this string instead of the current kill."
7793 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
7794 (re (org-get-limited-outline-regexp))
7795 (^re (concat "^" re))
7796 (start-level (and kill
7797 (string-match
7799 kill)
7800 (- (match-end 2) (match-beginning 2) 1)))
7801 (start (1+ (or (match-beginning 2) -1))))
7802 (if (not start-level)
7803 (progn
7804 nil) ;; does not even start with a heading
7805 (catch 'exit
7806 (while (setq start (string-match ^re kill (1+ start)))
7807 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
7808 (throw 'exit nil)))
7809 t))))
7811 (defvar org-markers-to-move nil
7812 "Markers that should be moved with a cut-and-paste operation.
7813 Those markers are stored together with their positions relative to
7814 the start of the region.")
7816 (defun org-save-markers-in-region (beg end)
7817 "Check markers in region.
7818 If these markers are between BEG and END, record their position relative
7819 to BEG, so that after moving the block of text, we can put the markers back
7820 into place.
7821 This function gets called just before an entry or tree gets cut from the
7822 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
7823 called immediately, to move the markers with the entries."
7824 (setq org-markers-to-move nil)
7825 (when (featurep 'org-clock)
7826 (org-clock-save-markers-for-cut-and-paste beg end))
7827 (when (featurep 'org-agenda)
7828 (org-agenda-save-markers-for-cut-and-paste beg end)))
7830 (defun org-check-and-save-marker (marker beg end)
7831 "Check if MARKER is between BEG and END.
7832 If yes, remember the marker and the distance to BEG."
7833 (when (and (marker-buffer marker)
7834 (equal (marker-buffer marker) (current-buffer)))
7835 (if (and (>= marker beg) (< marker end))
7836 (push (cons marker (- marker beg)) org-markers-to-move))))
7838 (defun org-reinstall-markers-in-region (beg)
7839 "Move all remembered markers to their position relative to BEG."
7840 (mapc (lambda (x)
7841 (move-marker (car x) (+ beg (cdr x))))
7842 org-markers-to-move)
7843 (setq org-markers-to-move nil))
7845 (defun org-narrow-to-subtree ()
7846 "Narrow buffer to the current subtree."
7847 (interactive)
7848 (save-excursion
7849 (save-match-data
7850 (org-with-limited-levels
7851 (narrow-to-region
7852 (progn (org-back-to-heading t) (point))
7853 (progn (org-end-of-subtree t t)
7854 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
7855 (point)))))))
7857 (defun org-narrow-to-block ()
7858 "Narrow buffer to the current block."
7859 (interactive)
7860 (let* ((case-fold-search t)
7863 (if blockp
7864 (narrow-to-region (car blockp) (cdr blockp))
7865 (error "Not in a block"))))
7867 (eval-when-compile
7868 (defvar org-property-drawer-re))
7870 (defvar org-property-start-re) ;; defined below
7871 (defun org-clone-subtree-with-time-shift (n &optional shift)
7872 "Clone the task (subtree) at point N times.
7873 The clones will be inserted as siblings.
7875 In interactive use, the user will be prompted for the number of
7876 clones to be produced, and for a time SHIFT, which may be a
7877 repeater as used in time stamps, for example `+3d'.
7879 When a valid repeater is given and the entry contains any time
7880 stamps, the clones will become a sequence in time, with time
7881 stamps in the subtree shifted for each clone produced. If SHIFT
7882 is nil or the empty string, time stamps will be left alone. The
7883 ID property of the original subtree is removed.
7885 If the original subtree did contain time stamps with a repeater,
7886 the following will happen:
7887 - the repeater will be removed in each clone
7888 - an additional clone will be produced, with the current, unshifted
7889 date(s) in the entry.
7890 - the original entry will be placed *after* all the clones, with
7891 repeater intact.
7892 - the start days in the repeater in the original entry will be shifted
7893 to past the last clone.
7894 I this way you can spell out a number of instances of a repeating task,
7895 and still retain the repeater to cover future instances of the task."
7896 (interactive "nNumber of clones to produce: \nsDate shift per clone (e.g. +1w, empty to copy unchanged): ")
7897 (let (beg end template task idprop
7898 shift-n shift-what doshift nmin nmax (n-no-remove -1)
7899 (drawer-re org-drawer-regexp))
7900 (if (not (and (integerp n) (> n 0)))
7901 (error "Invalid number of replications %s" n))
7904 shift)))
7905 (error "Invalid shift specification %s" shift))
7906 (when doshift
7907 (setq shift-n (string-to-number (match-string 1 shift))
7908 shift-what (cdr (assoc (match-string 2 shift)
7909 '(("d" . day) ("w" . week)
7910 ("m" . month) ("y" . year))))))
7911 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
7912 (setq nmin 1 nmax n)
7913 (org-back-to-heading t)
7914 (setq beg (point))
7915 (setq idprop (org-entry-get nil "ID"))
7916 (org-end-of-subtree t t)
7918 (setq end (point))
7919 (setq template (buffer-substring beg end))
7920 (when (and doshift
7922 (delete-region beg end)
7923 (setq end beg)
7924 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
7925 (goto-char end)
7926 (loop for n from nmin to nmax do
7927 ;; prepare clone
7928 (with-temp-buffer
7929 (insert template)
7930 (org-mode)
7931 (goto-char (point-min))
7932 (org-show-subtree)
7933 (and idprop (if org-clone-delete-id
7934 (org-entry-delete nil "ID")
7935 (org-id-get-create t)))
7936 (unless (= n 0)
7938 (kill-whole-line))
7939 (goto-char (point-min))
7940 (while (re-search-forward drawer-re nil t)
7941 (mapc (lambda (d)
7942 (org-remove-empty-drawer-at d (point))) org-drawers)))
7943 (goto-char (point-min))
7944 (when doshift
7945 (while (re-search-forward org-ts-regexp-both nil t)
7946 (org-timestamp-change (* n shift-n) shift-what))
7947 (unless (= n n-no-remove)
7948 (goto-char (point-min))
7949 (while (re-search-forward org-ts-regexp nil t)
7950 (save-excursion
7951 (goto-char (match-beginning 0))
7953 (delete-region (match-beginning 1) (match-end 1)))))))
7954 (setq task (buffer-string)))
7955 (insert task))
7956 (goto-char beg)))
7958 ;;; Outline Sorting
7960 (defun org-sort (with-case)
7961 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
7962 Optional argument WITH-CASE means sort case-sensitively."
7963 (interactive "P")
7964 (cond
7965 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
7966 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
7967 (t
7968 (org-call-with-arg 'org-sort-entries with-case))))
7970 (defun org-sort-remove-invisible (s)
7971 (remove-text-properties 0 (length s) org-rm-props s)
7972 (while (string-match org-bracket-link-regexp s)
7973 (setq s (replace-match (if (match-end 2)
7974 (match-string 3 s)
7975 (match-string 1 s)) t t s)))
7976 s)
7978 (defvar org-priority-regexp) ; defined later in the file
7980 (defvar org-after-sorting-entries-or-items-hook nil
7981 "Hook that is run after a bunch of entries or items have been sorted.
7982 When children are sorted, the cursor is in the parent line when this
7983 hook gets called. When a region or a plain list is sorted, the cursor
7984 will be in the first entry of the sorted region/list.")
7986 (defun org-sort-entries
7987 (&optional with-case sorting-type getkey-func compare-func property)
7988 "Sort entries on a certain level of an outline tree.
7989 If there is an active region, the entries in the region are sorted.
7990 Else, if the cursor is before the first entry, sort the top-level items.
7991 Else, the children of the entry at point are sorted.
7993 Sorting can be alphabetically, numerically, by date/time as given by
7994 a time stamp, by a property or by priority.
7996 The command prompts for the sorting type unless it has been given to the
7997 function through the SORTING-TYPE argument, which needs to be a character,
7998 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?r ?R ?f ?F). Here is the
7999 precise meaning of each character:
8001 n Numerically, by converting the beginning of the entry/item to a number.
8002 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8003 t By date/time, either the first active time stamp in the entry, or, if
8004 none exist, by the first inactive one.
8005 s By the scheduled date/time.
8006 d By deadline date/time.
8007 c By creation time, which is assumed to be the first inactive time stamp
8008 at the beginning of a line.
8009 p By priority according to the cookie.
8010 r By the value of a property.
8012 Capital letters will reverse the sort order.
8014 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8015 called with point at the beginning of the record. It must return either
8016 a string or a number that should serve as the sorting key for that record.
8018 Comparing entries ignores case by default. However, with an optional argument
8019 WITH-CASE, the sorting considers case as well."
8020 (interactive "P")
8021 (let ((case-func (if with-case 'identity 'downcase))
8022 start beg end stars re re2
8023 txt what tmp)
8024 ;; Find beginning and end of region to sort
8025 (cond
8026 ((org-region-active-p)
8027 ;; we will sort the region
8028 (setq end (region-end)
8029 what "region")
8030 (goto-char (region-beginning))
8031 (if (not (org-at-heading-p)) (outline-next-heading))
8032 (setq start (point)))
8033 ((or (org-at-heading-p)
8034 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8035 ;; we will sort the children of the current headline
8036 (org-back-to-heading)
8037 (setq start (point)
8038 end (progn (org-end-of-subtree t t)
8040 (org-back-over-empty-lines)
8041 (point))
8042 what "children")
8043 (goto-char start)
8044 (show-subtree)
8045 (outline-next-heading))
8046 (t
8047 ;; we will sort the top-level entries in this file
8048 (goto-char (point-min))
8049 (or (org-at-heading-p) (outline-next-heading))
8050 (setq start (point))
8051 (goto-char (point-max))
8052 (beginning-of-line 1)
8054 ;; File ends in a non-white line
8055 (end-of-line 1)
8057 (setq end (point-max))
8058 (setq what "top-level")
8059 (goto-char start)
8060 (show-all)))
8062 (setq beg (point))
8063 (if (>= beg end) (error "Nothing to sort"))
8066 (setq stars (match-string 1)
8067 re (concat "^" (regexp-quote stars) " +")
8069 txt (buffer-substring beg end))
8071 (if (and (not (equal stars "*")) (string-match re2 txt))
8072 (error "Region to sort contains a level above the first entry"))
8074 (unless sorting-type
8075 (message
8076 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8078 A/N/T/S/D/C/P/O/F means reversed:"
8079 what)
8080 (setq sorting-type (read-char-exclusive))
8082 (and (= (downcase sorting-type) ?f)
8083 (setq getkey-func
8084 (org-icompleting-read "Sort using function: "
8085 obarray 'fboundp t nil nil))
8086 (setq getkey-func (intern getkey-func)))
8088 (and (= (downcase sorting-type) ?r)
8089 (setq property
8090 (org-icompleting-read "Property: "
8091 (mapcar 'list (org-buffer-property-keys t))
8092 nil t))))
8094 (message "Sorting entries...")
8096 (save-restriction
8097 (narrow-to-region start end)
8098 (let ((dcst (downcase sorting-type))
8099 (case-fold-search nil)
8100 (now (current-time)))
8101 (sort-subr
8102 (/= dcst sorting-type)
8103 ;; This function moves to the beginning character of the "record" to
8104 ;; be sorted.
8105 (lambda nil
8106 (if (re-search-forward re nil t)
8107 (goto-char (match-beginning 0))
8108 (goto-char (point-max))))
8109 ;; This function moves to the last character of the "record" being
8110 ;; sorted.
8111 (lambda nil
8112 (save-match-data
8113 (condition-case nil
8114 (outline-forward-same-level 1)
8115 (error
8116 (goto-char (point-max))))))
8117 ;; This function returns the value that gets sorted against.
8118 (lambda nil
8119 (cond
8120 ((= dcst ?n)
8121 (if (looking-at org-complex-heading-regexp)
8122 (string-to-number (match-string 4))
8123 nil))
8124 ((= dcst ?a)
8125 (if (looking-at org-complex-heading-regexp)
8126 (funcall case-func (match-string 4))
8127 nil))
8128 ((= dcst ?t)
8129 (let ((end (save-excursion (outline-next-heading) (point))))
8130 (if (or (re-search-forward org-ts-regexp end t)
8131 (re-search-forward org-ts-regexp-both end t))
8132 (org-time-string-to-seconds (match-string 0))
8133 (org-float-time now))))
8134 ((= dcst ?c)
8135 (let ((end (save-excursion (outline-next-heading) (point))))
8136 (if (re-search-forward
8138 end t)
8139 (org-time-string-to-seconds (match-string 0))
8140 (org-float-time now))))
8141 ((= dcst ?s)
8142 (let ((end (save-excursion (outline-next-heading) (point))))
8143 (if (re-search-forward org-scheduled-time-regexp end t)
8144 (org-time-string-to-seconds (match-string 1))
8145 (org-float-time now))))
8146 ((= dcst ?d)
8147 (let ((end (save-excursion (outline-next-heading) (point))))
8148 (if (re-search-forward org-deadline-time-regexp end t)
8149 (org-time-string-to-seconds (match-string 1))
8150 (org-float-time now))))
8151 ((= dcst ?p)
8152 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8153 (string-to-char (match-string 2))
8154 org-default-priority))
8155 ((= dcst ?r)
8156 (or (org-entry-get nil property) ""))
8157 ((= dcst ?o)
8158 (if (looking-at org-complex-heading-regexp)
8159 (- 9999 (length (member (match-string 2)
8160 org-todo-keywords-1)))))
8161 ((= dcst ?f)
8162 (if getkey-func
8163 (progn
8164 (setq tmp (funcall getkey-func))
8165 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8166 tmp)
8167 (error "Invalid key function `%s'" getkey-func)))
8168 (t (error "Invalid sorting type `%c'" sorting-type))))
8169 nil
8170 (cond
8171 ((= dcst ?a) 'string<)
8172 ((= dcst ?f) compare-func)
8173 ((member dcst '(?p ?t ?s ?d ?c)) '<)
8174 (t nil)))))
8175 (run-hooks 'org-after-sorting-entries-or-items-hook)
8176 (message "Sorting entries...done")))
8178 (defun org-do-sort (table what &optional with-case sorting-type)
8179 "Sort TABLE of WHAT according to SORTING-TYPE.
8180 The user will be prompted for the SORTING-TYPE if the call to this
8181 function does not specify it. WHAT is only for the prompt, to indicate
8182 what is being sorted. The sorting key will be extracted from
8183 the car of the elements of the table.
8184 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8185 (unless sorting-type
8186 (message
8187 "Sort %s: [a]lphabetic. [n]umeric. [t]ime. A/N/T means reversed:"
8188 what)
8189 (setq sorting-type (read-char-exclusive)))
8190 (let ((dcst (downcase sorting-type))
8191 extractfun comparefun)
8192 ;; Define the appropriate functions
8193 (cond
8194 ((= dcst ?n)
8195 (setq extractfun 'string-to-number
8196 comparefun (if (= dcst sorting-type) '< '>)))
8197 ((= dcst ?a)
8198 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8199 (lambda(x) (downcase (org-sort-remove-invisible x))))
8200 comparefun (if (= dcst sorting-type)
8201 'string<
8202 (lambda (a b) (and (not (string< a b))
8203 (not (string= a b)))))))
8204 ((= dcst ?t)
8205 (setq extractfun
8206 (lambda (x)
8207 (if (or (string-match org-ts-regexp x)
8208 (string-match org-ts-regexp-both x))
8209 (org-float-time
8210 (org-time-string-to-time (match-string 0 x)))
8211 0))
8212 comparefun (if (= dcst sorting-type) '< '>)))
8213 (t (error "Invalid sorting type `%c'" sorting-type)))
8215 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8216 table)
8217 (lambda (a b) (funcall comparefun (car a) (car b))))))
8220 ;;; The orgstruct minor mode
8222 ;; Define a minor mode which can be used in other modes in order to
8223 ;; integrate the org-mode structure editing commands.
8225 ;; This is really a hack, because the org-mode structure commands use
8226 ;; keys which normally belong to the major mode. Here is how it
8227 ;; works: The minor mode defines all the keys necessary to operate the
8228 ;; structure commands, but wraps the commands into a function which
8229 ;; tests if the cursor is currently at a headline or a plain list
8230 ;; item. If that is the case, the structure command is used,
8231 ;; temporarily setting many Org-mode variables like regular
8232 ;; expressions for filling etc. However, when any of those keys is
8233 ;; used at a different location, function uses `key-binding' to look
8234 ;; up if the key has an associated command in another currently active
8235 ;; keymap (minor modes, major mode, global), and executes that
8236 ;; command. There might be problems if any of the keys is otherwise
8237 ;; used as a prefix key.
8239 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
8240 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
8241 ;; addresses this by checking explicitly for both bindings.
8243 (defvar orgstruct-mode-map (make-sparse-keymap)
8244 "Keymap for the minor `orgstruct-mode'.")
8246 (defvar org-local-vars nil
8247 "List of local variables, for use by `orgstruct-mode'.")
8249 ;;;###autoload
8250 (define-minor-mode orgstruct-mode
8251 "Toggle the minor mode `orgstruct-mode'.
8252 This mode is for using Org-mode structure commands in other
8253 modes. The following keys behave as if Org-mode were active, if
8254 the cursor is on a headline, or on a plain list item (both as
8255 defined by Org-mode).
8257 M-up Move entry/item up
8258 M-down Move entry/item down
8259 M-left Promote
8260 M-right Demote
8261 M-S-up Move entry/item up
8262 M-S-down Move entry/item down
8263 M-S-left Promote subtree
8264 M-S-right Demote subtree
8265 M-q Fill paragraph and items like in Org-mode
8266 C-c ^ Sort entries
8267 C-c - Cycle list bullet
8268 TAB Cycle item visibility
8269 M-RET Insert new heading/item
8270 S-M-RET Insert new TODO heading / Checkbox item
8271 C-c C-c Set tags / toggle checkbox"
8272 nil " OrgStruct" nil
8273 (org-load-modules-maybe)
8274 (and (orgstruct-setup) (defun orgstruct-setup () nil)))
8276 ;;;###autoload
8277 (defun turn-on-orgstruct ()
8278 "Unconditionally turn on `orgstruct-mode'."
8279 (orgstruct-mode 1))
8281 (defun orgstruct++-mode (&optional arg)
8282 "Toggle `orgstruct-mode', the enhanced version of it.
8283 In addition to setting orgstruct-mode, this also exports all indentation
8284 and autofilling variables from org-mode into the buffer. It will also
8285 recognize item context in multiline items.
8286 Note that turning off orgstruct-mode will *not* remove the
8287 indentation/paragraph settings. This can only be done by refreshing the
8289 (interactive "P")
8290 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8291 (if (< arg 1)
8292 (orgstruct-mode -1)
8293 (orgstruct-mode 1)
8294 (let (var val)
8295 (mapc
8296 (lambda (x)
8297 (when (string-match
8299 (symbol-name (car x)))
8300 (setq var (car x) val (nth 1 x))
8301 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8302 org-local-vars)
8303 (org-set-local 'orgstruct-is-++ t))))
8305 (defvar orgstruct-is-++ nil
8306 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8307 (make-variable-buffer-local 'orgstruct-is-++)
8309 ;;;###autoload
8310 (defun turn-on-orgstruct++ ()
8311 "Unconditionally turn on `orgstruct++-mode'."
8312 (orgstruct++-mode 1))
8314 (defun orgstruct-error ()
8315 "Error when there is no default binding for a structure key."
8316 (interactive)
8317 (error "This key has no function outside structure elements"))
8319 (defun orgstruct-setup ()
8320 "Setup orgstruct keymaps."
8321 (let ((nfunc 0)
8322 (bindings
8323 (list
8324 '([(meta up)] org-metaup)
8325 '([(meta down)] org-metadown)
8326 '([(meta left)] org-metaleft)
8327 '([(meta right)] org-metaright)
8328 '([(meta shift up)] org-shiftmetaup)
8329 '([(meta shift down)] org-shiftmetadown)
8330 '([(meta shift left)] org-shiftmetaleft)
8331 '([(meta shift right)] org-shiftmetaright)
8332 '([?\e (up)] org-metaup)
8333 '([?\e (down)] org-metadown)
8334 '([?\e (left)] org-metaleft)
8335 '([?\e (right)] org-metaright)
8336 '([?\e (shift up)] org-shiftmetaup)
8337 '([?\e (shift down)] org-shiftmetadown)
8338 '([?\e (shift left)] org-shiftmetaleft)
8339 '([?\e (shift right)] org-shiftmetaright)
8340 '([(shift up)] org-shiftup)
8341 '([(shift down)] org-shiftdown)
8342 '([(shift left)] org-shiftleft)
8343 '([(shift right)] org-shiftright)
8344 '("\C-c\C-c" org-ctrl-c-ctrl-c)
8345 '("\M-q" fill-paragraph)
8346 '("\C-c^" org-sort)
8347 '("\C-c-" org-cycle-list-bullet)))
8348 elt key fun cmd)
8349 (while (setq elt (pop bindings))
8350 (setq nfunc (1+ nfunc))
8351 (setq key (org-key (car elt))
8352 fun (nth 1 elt)
8353 cmd (orgstruct-make-binding fun nfunc key))
8354 (org-defkey orgstruct-mode-map key cmd))
8356 ;; Special treatment needed for TAB and RET
8357 (org-defkey orgstruct-mode-map [(tab)]
8358 (orgstruct-make-binding 'org-cycle 102 [(tab)] "\C-i"))
8359 (org-defkey orgstruct-mode-map "\C-i"
8360 (orgstruct-make-binding 'org-cycle 103 "\C-i" [(tab)]))
8362 (org-defkey orgstruct-mode-map "\M-\C-m"
8363 (orgstruct-make-binding 'org-insert-heading 105
8364 "\M-\C-m" [(meta return)]))
8365 (org-defkey orgstruct-mode-map [(meta return)]
8366 (orgstruct-make-binding 'org-insert-heading 106
8367 [(meta return)] "\M-\C-m"))
8369 (org-defkey orgstruct-mode-map [(shift meta return)]
8370 (orgstruct-make-binding 'org-insert-todo-heading 107
8371 [(meta return)] "\M-\C-m"))
8373 (org-defkey orgstruct-mode-map "\e\C-m"
8374 (orgstruct-make-binding 'org-insert-heading 108
8375 "\e\C-m" [?\e (return)]))
8376 (org-defkey orgstruct-mode-map [?\e (return)]
8377 (orgstruct-make-binding 'org-insert-heading 109
8378 [?\e (return)] "\e\C-m"))
8379 (org-defkey orgstruct-mode-map [?\e (shift return)]
8380 (orgstruct-make-binding 'org-insert-todo-heading 110
8381 [?\e (return)] "\e\C-m"))
8383 (unless org-local-vars
8384 (setq org-local-vars (org-get-local-variables)))
8386 t))
8388 (defun orgstruct-make-binding (fun n &rest keys)
8389 "Create a function for binding in the structure minor mode.
8390 FUN is the command to call inside a table. N is used to create a unique
8391 command name. KEYS are keys that should be checked in for a command
8392 to execute outside of tables."
8393 (eval
8394 (list 'defun
8395 (intern (concat "orgstruct-hijacker-command-" (int-to-string n)))
8396 '(arg)
8398 "Outside of structure, run the binding of `"
8399 (mapconcat (lambda (x) (format "%s" x)) keys "' or `")
8400 "'.")
8401 '(interactive "p")
8402 (list 'if
8403 `(org-context-p 'headline 'item
8404 (and orgstruct-is-++
8405 ,(and (memq fun '(org-insert-heading org-insert-todo-heading)) t)
8406 'item-body))
8407 (list 'org-run-like-in-org-mode (list 'quote fun))
8408 (list 'let '(orgstruct-mode)
8409 (list 'call-interactively
8410 (append '(or)
8411 (mapcar (lambda (k)
8412 (list 'key-binding k))
8413 keys)
8414 '('orgstruct-error))))))))
8416 (defun org-context-p (&rest contexts)
8417 "Check if local context is any of CONTEXTS.
8418 Possible values in the list of contexts are `table', `headline', and `item'."
8419 (let ((pos (point)))
8420 (goto-char (point-at-bol))
8421 (prog1 (or (and (memq 'table contexts)
8423 (and (memq 'headline contexts)
8424 (looking-at org-outline-regexp))
8425 (and (memq 'item contexts)
8427 (and (memq 'item-body contexts)
8428 (org-in-item-p)))
8429 (goto-char pos))))
8431 (defun org-get-local-variables ()
8432 "Return a list of all local variables in an org-mode buffer."
8433 (let (varlist)
8434 (with-current-buffer (get-buffer-create "*Org tmp*")
8435 (erase-buffer)
8436 (org-mode)
8437 (setq varlist (buffer-local-variables)))
8438 (kill-buffer "*Org tmp*")
8439 (delq nil
8440 (mapcar
8441 (lambda (x)
8442 (setq x
8443 (if (symbolp x)
8444 (list x)
8445 (list (car x) (list 'quote (cdr x)))))
8446 (if (string-match
8447 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|fill-paragraph\\|adaptive-fill\\|indent-\\)"
8448 (symbol-name (car x)))
8449 x nil))
8450 varlist))))
8452 (defun org-clone-local-variables (from-buffer &optional regexp)
8453 "Clone local variables from FROM-BUFFER.
8454 Optional argument REGEXP selects variables to clone."
8455 (mapc
8456 (lambda (pair)
8457 (and (symbolp (car pair))
8458 (or (null regexp)
8459 (string-match regexp (symbol-name (car pair))))
8460 (set (make-local-variable (car pair))
8461 (cdr pair))))
8462 (buffer-local-variables from-buffer)))
8464 ;;;###autoload
8465 (defun org-run-like-in-org-mode (cmd)
8466 "Run a command, pretending that the current buffer is in Org-mode.
8467 This will temporarily bind local variables that are typically bound in
8468 Org-mode to the values they have in Org-mode, and then interactively
8469 call CMD."
8470 (org-load-modules-maybe)
8471 (unless org-local-vars
8472 (setq org-local-vars (org-get-local-variables)))
8473 (eval (list 'let org-local-vars
8474 (list 'call-interactively (list 'quote cmd)))))
8476 ;;;; Archiving
8478 (defun org-get-category (&optional pos force-refresh)
8479 "Get the category applying to position POS."
8480 (if force-refresh (org-refresh-category-properties))
8481 (let ((pos (or pos (point))))
8482 (or (get-text-property pos 'org-category)
8483 (progn (org-refresh-category-properties)
8484 (get-text-property pos 'org-category)))))
8486 (defun org-refresh-category-properties ()
8487 "Refresh category text properties in the buffer."
8488 (let ((def-cat (cond
8489 ((null org-category)
8490 (if buffer-file-name
8491 (file-name-sans-extension
8492 (file-name-nondirectory buffer-file-name))
8493 "???"))
8494 ((symbolp org-category) (symbol-name org-category))
8495 (t org-category)))
8496 beg end cat pos optionp)
8497 (org-unmodified
8498 (save-excursion
8499 (save-restriction
8500 (widen)
8501 (goto-char (point-min))
8502 (put-text-property (point) (point-max) 'org-category def-cat)
8503 (while (re-search-forward
8505 (setq pos (match-end 0)
8506 optionp (equal (char-after (match-beginning 0)) ?#)
8507 cat (org-trim (match-string 2)))
8508 (if optionp
8509 (setq beg (point-at-bol) end (point-max))
8510 (org-back-to-heading t)
8511 (setq beg (point) end (org-end-of-subtree t t)))
8512 (put-text-property beg end 'org-category cat)
8513 (put-text-property beg end 'org-category-position beg)
8514 (goto-char pos)))))))
8517 ;;;; Link Stuff
8519 ;;; Link abbreviations
8521 (defun org-link-expand-abbrev (link)
8522 "Apply replacements as defined in `org-link-abbrev-alist."
8524 (let* ((key (match-string 1 link))
8525 (as (or (assoc key org-link-abbrev-alist-local)
8526 (assoc key org-link-abbrev-alist)))
8527 (tag (and (match-end 2) (match-string 3 link)))
8528 rpl)
8529 (if (not as)
8530 link
8531 (setq rpl (cdr as))
8532 (cond
8533 ((symbolp rpl) (funcall rpl tag))
8534 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
8535 ((string-match "%h" rpl)
8536 (replace-match (url-hexify-string (or tag "")) t t rpl))
8537 (t (concat rpl tag)))))
8538 link))
8540 ;;; Storing and inserting links
8542 (defvar org-insert-link-history nil
8543 "Minibuffer history for links inserted with `org-insert-link'.")
8545 (defvar org-stored-links nil
8546 "Contains the links stored with `org-store-link'.")
8548 (defvar org-store-link-plist nil
8549 "Plist with info about the most recently link created with `org-store-link'.")
8551 (defvar org-link-protocols nil
8552 "Link protocols added to Org-mode using `org-add-link-type'.")
8554 (defvar org-store-link-functions nil
8555 "List of functions that are called to create and store a link.
8556 Each function will be called in turn until one returns a non-nil
8557 value. Each function should check if it is responsible for creating
8558 this link (for example by looking at the major mode).
8559 If not, it must exit and return nil.
8560 If yes, it should return a non-nil value after a calling
8561 `org-store-link-props' with a list of properties and values.
8562 Special properties are:
8566 This is obligatory as well.
8567 :description Optional default description for the second pair
8568 of brackets in an Org-mode link. The user can still change
8569 this when inserting this link into an Org-mode buffer.
8571 In addition to these, any additional properties can be specified
8572 and then used in remember templates.")
8574 (defun org-add-link-type (type &optional follow export)
8575 "Add TYPE to the list of `org-link-types'.
8576 Re-compute all regular expressions depending on `org-link-types'
8578 FOLLOW and EXPORT are two functions.
8580 FOLLOW should take the link path as the single argument and do whatever
8581 is necessary to follow the link, for example find a file or display
8582 a mail message.
8584 EXPORT should format the link path for export to one of the export formats.
8585 It should be a function accepting three arguments:
8588 desc the description of the link, if any, or a description added by
8589 org-export-normalize-links if there is none
8590 format the export format, a symbol like `html' or `latex' or `ascii'..
8592 The function may use the FORMAT information to return different values
8593 depending on the format. The return value will be put literally into
8594 the exported file. If the return value is nil, this means Org should
8595 do what it normally does with links which do not have EXPORT defined.
8597 Org-mode has a built-in default for exporting links. If you are happy with
8598 this default, there is no need to define an export function for the link
8599 type. For a simple example of an export function, see `org-bbdb.el'."
8600 (add-to-list 'org-link-types type t)
8601 (org-make-link-regexps)
8602 (if (assoc type org-link-protocols)
8603 (setcdr (assoc type org-link-protocols) (list follow export))
8604 (push (list type follow export) org-link-protocols)))
8606 (defvar org-agenda-buffer-name)
8608 ;;;###autoload
8609 (defun org-store-link (arg)
8611 This link is added to `org-stored-links' and can later be inserted
8614 For some link types, a prefix arg is interpreted:
8615 For links to usenet articles, arg negates `org-gnus-prefer-web-links'.
8616 For file links, arg negates `org-context-in-file-links'."
8617 (interactive "P")
8618 (org-load-modules-maybe)
8619 (setq org-store-link-plist nil) ; reset
8620 (org-with-limited-levels
8621 (let (link cpltxt desc description search txt custom-id agenda-link)
8622 (cond
8624 ((run-hook-with-args-until-success 'org-store-link-functions)
8625 (setq link (plist-get org-store-link-plist :link)
8626 desc (or (plist-get org-store-link-plist :description) link)))
8628 ((equal (buffer-name) "*Org Edit Src Example*")
8629 (let (label gc)
8630 (while (or (not label)
8631 (save-excursion
8632 (save-restriction
8633 (widen)
8634 (goto-char (point-min))
8635 (re-search-forward
8636 (regexp-quote (format org-coderef-label-format label))
8637 nil t))))
8638 (when label (message "Label exists already") (sit-for 2))
8639 (setq label (read-string "Code line label: " label)))
8640 (end-of-line 1)
8641 (setq link (format org-coderef-label-format label))
8642 (setq gc (- 79 (length link)))
8643 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
8644 (insert link)
8645 (setq link (concat "(" label ")") desc nil)))
8647 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
8648 ;; We are in the agenda, link to referenced location
8649 (let ((m (or (get-text-property (point) 'org-hd-marker)
8650 (get-text-property (point) 'org-marker))))
8651 (when m
8652 (org-with-point-at m
8653 (setq agenda-link
8654 (if (org-called-interactively-p 'any)
8655 (call-interactively 'org-store-link)
8656 (org-store-link nil)))))))
8658 ((eq major-mode 'calendar-mode)
8659 (let ((cd (calendar-cursor-to-date)))
8660 (setq link
8661 (format-time-string
8662 (car org-time-stamp-formats)
8663 (apply 'encode-time
8664 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
8665 nil nil nil))))
8666 (org-store-link-props :type "calendar" :date cd)))
8668 ((eq major-mode 'w3-mode)
8669 (setq cpltxt (if (and (buffer-name)
8670 (not (string-match "Untitled" (buffer-name))))
8671 (buffer-name)
8672 (url-view-url t))
8673 link (org-make-link (url-view-url t)))
8674 (org-store-link-props :type "w3" :url (url-view-url t)))
8676 ((eq major-mode 'w3m-mode)
8677 (setq cpltxt (or w3m-current-title w3m-current-url)
8678 link (org-make-link w3m-current-url))
8679 (org-store-link-props :type "w3m" :url (url-view-url t)))
8681 ((setq search (run-hook-with-args-until-success
8682 'org-create-file-search-functions))
8683 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
8684 "::" search))
8685 (setq cpltxt (or description link)))
8687 ((eq major-mode 'image-mode)
8688 (setq cpltxt (concat "file:"
8689 (abbreviate-file-name buffer-file-name))
8690 link (org-make-link cpltxt))
8691 (org-store-link-props :type "image" :file buffer-file-name))
8693 ((eq major-mode 'dired-mode)
8694 ;; link to the file in the current line
8695 (let ((file (dired-get-filename nil t)))
8696 (setq file (if file
8697 (abbreviate-file-name
8698 (expand-file-name (dired-get-filename nil t)))
8699 ;; otherwise, no file so use current directory.
8700 default-directory))
8701 (setq cpltxt (concat "file:" file)
8702 link (org-make-link cpltxt))))
8704 ((and (buffer-file-name (buffer-base-buffer)) (eq major-mode 'org-mode))
8705 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
8706 (cond
8708 (setq cpltxt
8709 (concat "file:"
8710 (abbreviate-file-name
8711 (buffer-file-name (buffer-base-buffer)))
8712 "::" (match-string 1))
8713 link (org-make-link cpltxt)))
8714 ((and (featurep 'org-id)
8715 (or (eq org-link-to-org-use-id t)
8716 (and (eq org-link-to-org-use-id 'create-if-interactive)
8717 (org-called-interactively-p 'any))
8718 (and (eq org-link-to-org-use-id
8719 'create-if-interactive-and-no-custom-id)
8720 (org-called-interactively-p 'any)
8721 (not custom-id))
8722 (and org-link-to-org-use-id
8723 (org-entry-get nil "ID"))))
8724 ;; We can make a link using the ID.
8725 (setq link (condition-case nil
8726 (prog1 (org-id-store-link)
8727 (setq desc (plist-get org-store-link-plist
8728 :description)))
8729 (error
8730 ;; probably before first headline, link to file only
8731 (concat "file:"
8732 (abbreviate-file-name
8733 (buffer-file-name (buffer-base-buffer))))))))
8734 (t
8735 ;; Just link to current headline
8736 (setq cpltxt (concat "file:"
8737 (abbreviate-file-name
8738 (buffer-file-name (buffer-base-buffer)))))
8739 ;; Add a context search string
8740 (when (org-xor org-context-in-file-links arg)
8741 (setq txt (cond
8742 ((org-at-heading-p) nil)
8743 ((org-region-active-p)
8744 (buffer-substring (region-beginning) (region-end)))
8745 (t nil)))
8747 (setq cpltxt
8748 (concat cpltxt "::"
8749 (condition-case nil
8750 (org-make-org-heading-search-string txt)
8751 (error "")))
8752 desc (or (nth 4 (ignore-errors
8753 (org-heading-components))) "NONE"))))
8755 (setq cpltxt (substring cpltxt 0 -2)))
8756 (setq link (org-make-link cpltxt)))))
8758 ((buffer-file-name (buffer-base-buffer))
8759 ;; Just link to this file here.
8760 (setq cpltxt (concat "file:"
8761 (abbreviate-file-name
8762 (buffer-file-name (buffer-base-buffer)))))
8763 ;; Add a context string
8764 (when (org-xor org-context-in-file-links arg)
8765 (setq txt (if (org-region-active-p)
8766 (buffer-substring (region-beginning) (region-end))
8767 (buffer-substring (point-at-bol) (point-at-eol))))
8768 ;; Only use search option if there is some text.
8770 (setq cpltxt
8771 (concat cpltxt "::" (org-make-org-heading-search-string txt))
8772 desc "NONE")))
8773 (setq link (org-make-link cpltxt)))
8775 ((org-called-interactively-p 'interactive)
8776 (error "Cannot link to a buffer which is not visiting a file"))
8778 (t (setq link nil)))
8780 (if (consp link) (setq cpltxt (car link) link (cdr link)))
8781 (setq link (or link cpltxt)
8782 desc (or desc cpltxt))
8783 (if (equal desc "NONE") (setq desc nil))
8785 (if (and (or (org-called-interactively-p 'any) executing-kbd-macro) link)
8786 (progn
8787 (setq org-stored-links
8788 (cons (list link desc) org-stored-links))
8789 (message "Stored: %s" (or desc link))
8790 (when custom-id
8791 (setq link (concat "file:" (abbreviate-file-name (buffer-file-name))
8792 "::#" custom-id))
8793 (setq org-stored-links
8794 (cons (list link desc) org-stored-links))))
8795 (or agenda-link (and link (org-make-link-string link desc)))))))
8797 (defun org-store-link-props (&rest plist)
8798 "Store link properties, extract names and addresses."
8799 (let (x adr)
8800 (when (setq x (plist-get plist :from))
8801 (setq adr (mail-extract-address-components x))
8802 (setq plist (plist-put plist :fromname (car adr)))
8803 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
8804 (when (setq x (plist-get plist :to))
8805 (setq adr (mail-extract-address-components x))
8806 (setq plist (plist-put plist :toname (car adr)))
8807 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
8808 (let ((from (plist-get plist :from))
8809 (to (plist-get plist :to)))
8810 (when (and from to org-from-is-user-regexp)
8811 (setq plist
8812 (plist-put plist :fromto
8813 (if (string-match org-from-is-user-regexp from)
8814 (concat "to %t")
8815 (concat "from %f"))))))
8816 (setq org-store-link-plist plist))
8818 (defun org-add-link-props (&rest plist)
8819 "Add these properties to the link property list."
8820 (let (key value)
8821 (while plist
8822 (setq key (pop plist) value (pop plist))
8823 (setq org-store-link-plist
8824 (plist-put org-store-link-plist key value)))))
8826 (defun org-email-link-description (&optional fmt)
8827 "Return the description part of an email link.
8828 This takes information from `org-store-link-plist' and formats it
8829 according to FMT (default from `org-email-link-description-format')."
8830 (setq fmt (or fmt org-email-link-description-format))
8831 (let* ((p org-store-link-plist)
8832 (to (plist-get p :toaddress))
8833 (from (plist-get p :fromaddress))
8834 (table
8835 (list
8836 (cons "%c" (plist-get p :fromto))
8837 (cons "%F" (plist-get p :from))
8838 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
8839 (cons "%T" (plist-get p :to))
8840 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
8841 (cons "%s" (plist-get p :subject))
8842 (cons "%d" (plist-get p :date))
8843 (cons "%m" (plist-get p :message-id)))))
8844 (when (string-match "%c" fmt)
8845 ;; Check if the user wrote this message
8846 (if (and org-from-is-user-regexp from to
8847 (save-match-data (string-match org-from-is-user-regexp from)))
8848 (setq fmt (replace-match "to %t" t t fmt))
8849 (setq fmt (replace-match "from %f" t t fmt))))
8850 (org-replace-escapes fmt table)))
8852 (defun org-make-org-heading-search-string (&optional string heading)
8853 "Make search string for STRING or current headline."
8854 (interactive)
8855 (let ((s (or string (org-get-heading)))
8856 (lines org-context-in-file-links))
8857 (unless (and string (not heading))
8858 ;; We are using a headline, clean up garbage in there.
8859 (if (string-match org-todo-regexp s)
8860 (setq s (replace-match "" t t s)))
8862 (setq s (replace-match "" t t s)))
8863 (setq s (org-trim s))
8866 (setq s (replace-match "" t t s)))
8867 (while (string-match org-ts-regexp s)
8868 (setq s (replace-match "" t t s))))
8869 (or string (setq s (concat "*" s))) ; Add * for headlines
8870 (when (and string (integerp lines) (> lines 0))
8872 (when (< lines (length slines))
8873 (setq s (mapconcat
8874 'identity
8875 (reverse (nthcdr (- (length slines) lines)
8879 (defun org-make-link (&rest strings)
8880 "Concatenate STRINGS."
8881 (apply 'concat strings))
8883 (defun org-make-link-string (link &optional description)
8884 "Make a link with brackets, consisting of LINK and DESCRIPTION."
8886 (error "Empty link"))
8887 (when (and description
8888 (stringp description)
8890 (setq description nil))
8891 (when (stringp description)
8892 ;; Remove brackets from the description, they are fatal.
8894 (setq description (replace-match "{" t t description)))
8896 (setq description (replace-match "}" t t description))))
8897 (when (equal link description)
8898 ;; No description needed, it is identical
8899 (setq description nil))
8900 (when (and (not description)
8901 (not (string-match (org-image-file-name-regexp) link))
8902 (not (equal link (org-link-escape link))))
8903 (setq description (org-extract-attributes link)))
8904 (setq link
8905 (cond ((string-match (org-image-file-name-regexp) link) link)
8906 ((string-match org-link-types-re link)
8907 (concat (match-string 1 link)
8908 (org-link-escape (substring link (match-end 1)))))
8909 (t (org-link-escape link))))
8910 (concat "[[" link "]"
8911 (if description (concat "[" description "]") "")
8912 "]"))
8914 (defconst org-link-escape-chars
8915 '(?\ ?\[ ?\] ?\; ?\= ?\+)
8916 "List of characters that should be escaped in link.
8917 This is the list that is used for internal purposes.")
8919 (defvar org-url-encoding-use-url-hexify nil)
8921 (defconst org-link-escape-chars-browser
8922 '(?\ )
8923 "List of escapes for characters that are problematic in links.
8924 This is the list that is used before handing over to the browser.")
8926 (defun org-link-escape (text &optional table merge)
8927 "Return percent escaped representation of TEXT.
8928 TEXT is a string with the text to escape.
8929 Optional argument TABLE is a list with characters that should be
8930 escaped. When nil, `org-link-escape-chars' is used.
8931 If optional argument MERGE is set, merge TABLE into
8932 `org-link-escape-chars'."
8933 (if (and org-url-encoding-use-url-hexify (not table))
8934 (url-hexify-string text)
8935 (cond
8936 ((and table merge)
8937 (mapc (lambda (defchr)
8938 (unless (member defchr table)
8939 (setq table (cons defchr table)))) org-link-escape-chars))
8940 ((null table)
8941 (setq table org-link-escape-chars)))
8942 (mapconcat
8943 (lambda (char)
8944 (if (or (member char table)
8945 (< char 32) (= char 37) (> char 126))
8946 (mapconcat (lambda (sequence-element)
8947 (format "%%%.2X" sequence-element))
8948 (or (encode-coding-char char 'utf-8)
8949 (error "Unable to percent escape character: %s"
8950 (char-to-string char))) "")
8951 (char-to-string char))) text "")))
8953 (defun org-link-unescape (str)
8954 "Unhex hexified Unicode strings as returned from the JavaScript function
8955 encodeURIComponent. E.g. `%C3%B6' is the german Umlaut `ö'."
8956 (unless (and (null str) (string= "" str))
8957 (let ((pos 0) (case-fold-search t) unhexed)
8959 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
8960 (setq str (replace-match unhexed t t str))
8961 (setq pos (+ pos (length unhexed))))))
8962 str)
8964 (defun org-link-unescape-compound (hex)
8965 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German Umlaut `ö'.
8966 Note: this function also decodes single byte encodings like
8968 (save-match-data
8969 (let* ((bytes (cdr (split-string hex "%")))
8970 (ret "")
8971 (eat 0)
8972 (sum 0))
8973 (while bytes
8974 (let* ((val (string-to-number (pop bytes) 16))
8975 (shift-xor
8976 (if (= 0 eat)
8977 (cond
8978 ((>= val 252) (cons 6 252))
8979 ((>= val 248) (cons 5 248))
8980 ((>= val 240) (cons 4 240))
8981 ((>= val 224) (cons 3 224))
8982 ((>= val 192) (cons 2 192))
8983 (t (cons 0 0)))
8984 (cons 6 128))))
8985 (if (>= val 192) (setq eat (car shift-xor)))
8986 (setq val (logxor val (cdr shift-xor)))
8987 (setq sum (+ (lsh sum (car shift-xor)) val))
8988 (if (> eat 0) (setq eat (- eat 1)))
8989 (cond
8990 ((= 0 eat) ;multi byte
8991 (setq ret (concat ret (org-char-to-string sum)))
8992 (setq sum 0))
8993 ((not bytes) ; single byte(s)
8994 (setq ret (org-link-unescape-single-byte-sequence hex))))
8995 )) ;; end (while bytes
8996 ret )))
8998 (defun org-link-unescape-single-byte-sequence (hex)
8999 "Unhexify hex-encoded single byte character sequences."
9000 (mapconcat (lambda (byte)
9001 (char-to-string (string-to-number byte 16)))
9002 (cdr (split-string hex "%")) ""))
9004 (defun org-xor (a b)
9005 "Exclusive or."
9006 (if a (not b) b))
9008 (defun org-fixup-message-id-for-http (s)
9009 "Replace special characters in a message id, so it can be used in an http query."
9010 (when (string-match "%" s)
9011 (setq s (mapconcat (lambda (c)
9012 (if (eq c ?%)
9013 "%25"
9014 (char-to-string c)))
9015 s "")))
9016 (while (string-match "<" s)
9017 (setq s (replace-match "%3C" t t s)))
9018 (while (string-match ">" s)
9019 (setq s (replace-match "%3E" t t s)))
9020 (while (string-match "@" s)
9021 (setq s (replace-match "%40" t t s)))
9022 s)
9024 ;;;###autoload
9025 (defun org-insert-link-global ()
9026 "Insert a link like Org-mode does.
9027 This command can be called in any mode to insert a link in Org-mode syntax."
9028 (interactive)
9029 (org-load-modules-maybe)
9030 (org-run-like-in-org-mode 'org-insert-link))
9032 (defun org-insert-link (&optional complete-file link-location default-description)
9033 "Insert a link. At the prompt, enter the link.
9035 Completion can be used to insert any of the link protocol prefixes like
9036 http or ftp in use.
9038 The history can be used to select a link previously stored with
9039 `org-store-link'. When the empty string is entered (i.e. if you just
9040 press RET at the prompt), the link defaults to the most recently
9041 stored link. As SPC triggers completion in the minibuffer, you need to
9042 use M-SPC or C-q SPC to force the insertion of a space character.
9044 You will also be prompted for a description, and if one is given, it will
9045 be displayed in the buffer instead of the link.
9047 If there is already a link at point, this command will allow you to edit link
9048 and description parts.
9051 be selected using completion. The path to the file will be relative to the
9052 current directory if the file is in the current directory or a subdirectory.
9053 Otherwise, the link will be the absolute path as completed in the minibuffer
9054 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9055 option `org-link-file-path-type'.
9058 the current directory or below.
9061 `org-keep-stored-link-after-insertion'.
9063 If `org-make-link-description-function' is non-nil, this function will be
9064 called with the link target, and the result will be the default
9065 link description.
9067 If the LINK-LOCATION parameter is non-nil, this value will be
9068 used as the link location instead of reading one interactively.
9070 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9071 be used as the default description."
9072 (interactive "P")
9073 (let* ((wcf (current-window-configuration))
9074 (region (if (org-region-active-p)
9075 (buffer-substring (region-beginning) (region-end))))
9076 (remove (and region (list (region-beginning) (region-end))))
9077 (desc region)
9078 tmphist ; byte-compile incorrectly complains about this
9079 (link link-location)
9080 entry file all-prefixes)
9081 (cond
9082 (link-location) ; specified by arg, just use it.
9083 ((org-in-regexp org-bracket-link-regexp 1)
9084 ;; We do have a link at point, and we are going to edit it.
9085 (setq remove (list (match-beginning 0) (match-end 0)))
9086 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9087 (setq link (read-string "Link: "
9088 (org-link-unescape
9089 (org-match-string-no-properties 1)))))
9090 ((or (org-in-regexp org-angle-link-re)
9091 (org-in-regexp org-plain-link-re))
9092 ;; Convert to bracket link
9093 (setq remove (list (match-beginning 0) (match-end 0))
9094 link (read-string "Link: "
9095 (org-remove-angle-brackets (match-string 0)))))
9096 ((member complete-file '((4) (16)))
9097 ;; Completing read for file names.
9098 (setq link (org-file-complete-link complete-file)))
9099 (t
9100 ;; Read link, with completion for stored links.
9101 (with-output-to-temp-buffer "*Org Links*"
9102 (princ "Insert a link.
9104 (when org-stored-links
9106 (princ (mapconcat
9107 (lambda (x)
9108 (if (nth 1 x) (concat (car x) " (" (nth 1 x) ")") (car x)))
9110 (let ((cw (selected-window)))
9111 (select-window (get-buffer-window "*Org Links*" 'visible))
9112 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9113 (unless (pos-visible-in-window-p (point-max))
9114 (org-fit-window-to-buffer))
9115 (and (window-live-p cw) (select-window cw)))
9116 ;; Fake a link history, containing the stored links.
9117 (setq tmphist (append (mapcar 'car org-stored-links)
9118 org-insert-link-history))
9119 (setq all-prefixes (append (mapcar 'car org-link-abbrev-alist-local)
9120 (mapcar 'car org-link-abbrev-alist)
9121 org-link-types))
9122 (unwind-protect
9123 (progn
9124 (setq link
9125 (let ((org-completion-use-ido nil)
9126 (org-completion-use-iswitchb nil))
9127 (org-completing-read
9128 "Link: "
9129 (append
9130 (mapcar (lambda (x) (list (concat x ":")))
9131 all-prefixes)
9132 (mapcar 'car org-stored-links))
9133 nil nil nil
9134 'tmphist
9135 (car (car org-stored-links)))))
9137 (error "No link selected"))
9138 (if (or (member link all-prefixes)
9139 (and (equal ":" (substring link -1))
9140 (member (substring link 0 -1) all-prefixes)
9141 (setq link (substring link 0 -1))))
9142 (setq link (org-link-try-special-completion link))))
9143 (set-window-configuration wcf)
9144 (kill-buffer "*Org Links*"))
9145 (setq entry (assoc link org-stored-links))
9146 (or entry (push link org-insert-link-history))
9147 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9148 (not org-keep-stored-link-after-insertion))
9149 (setq org-stored-links (delq (assoc link org-stored-links)
9150 org-stored-links)))
9151 (setq desc (or desc (nth 1 entry)))))
9153 (if (string-match org-plain-link-re link)
9154 ;; URL-like link, normalize the use of angular brackets.
9155 (setq link (org-make-link (org-remove-angle-brackets link))))
9157 ;; Check if we are linking to the current file with a search option
9158 ;; If yes, simplify the link by using only the search option.
9159 (when (and buffer-file-name
9161 (let* ((path (match-string 1 link))
9162 (case-fold-search nil)
9163 (search (match-string 2 link)))
9164 (save-match-data
9165 (if (equal (file-truename buffer-file-name) (file-truename path))
9166 ;; We are linking to this same file, with a search option
9167 (setq link search)))))
9169 ;; Check if we can/should use a relative path. If yes, simplify the link
9171 (let* ((type (match-string 1 link))
9172 (path (match-string 2 link))
9173 (origpath path)
9174 (case-fold-search nil))
9175 (cond
9176 ((or (eq org-link-file-path-type 'absolute)
9177 (equal complete-file '(16)))
9178 (setq path (abbreviate-file-name (expand-file-name path))))
9179 ((eq org-link-file-path-type 'noabbrev)
9180 (setq path (expand-file-name path)))
9181 ((eq org-link-file-path-type 'relative)
9182 (setq path (file-relative-name path)))
9183 (t
9184 (save-match-data
9185 (if (string-match (concat "^" (regexp-quote
9186 (expand-file-name
9187 (file-name-as-directory
9188 default-directory))))
9189 (expand-file-name path))
9190 ;; We are linking a file with relative path name.
9191 (setq path (substring (expand-file-name path)
9192 (match-end 0)))
9193 (setq path (abbreviate-file-name (expand-file-name path)))))))
9194 (setq link (concat type path))
9195 (if (equal desc origpath)
9196 (setq desc path))))
9198 (if org-make-link-description-function
9199 (setq desc (funcall org-make-link-description-function link desc))
9200 (if default-description (setq desc default-description)))
9202 (setq desc (read-string "Description: " desc))
9204 (if remove (apply 'delete-region remove))
9205 (insert (org-make-link-string link desc))))
9207 (defun org-link-try-special-completion (type)
9208 "If there is completion support for link type TYPE, offer it."
9209 (let ((fun (intern (concat "org-" type "-complete-link"))))
9210 (if (functionp fun)
9211 (funcall fun)
9212 (read-string "Link (no completion support): " (concat type ":")))))
9214 (defun org-file-complete-link (&optional arg)
9215 "Create a file link using completion."
9216 (let (file link)
9217 (setq file (read-file-name "File: "))
9218 (let ((pwd (file-name-as-directory (expand-file-name ".")))
9219 (pwd1 (file-name-as-directory (abbreviate-file-name
9220 (expand-file-name ".")))))
9221 (cond
9222 ((equal arg '(16))
9223 (setq link (org-make-link
9224 "file:"
9225 (abbreviate-file-name (expand-file-name file)))))
9227 (setq link (org-make-link "file:" (match-string 1 file))))
9229 (expand-file-name file))
9230 (setq link (org-make-link
9231 "file:" (match-string 1 (expand-file-name file)))))
9232 (t (setq link (org-make-link "file:" file)))))
9233 link))
9235 (defun org-completing-read (&rest args)
9236 "Completing-read with SPACE being a normal character."
9237 (let ((enable-recursive-minibuffers t)
9238 (minibuffer-local-completion-map
9239 (copy-keymap minibuffer-local-completion-map)))
9240 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
9241 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
9242 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
9243 (apply 'org-icompleting-read args)))
9245 (defun org-completing-read-no-i (&rest args)
9246 (let (org-completion-use-ido org-completion-use-iswitchb)
9247 (apply 'org-completing-read args)))
9249 (defun org-iswitchb-completing-read (prompt choices &rest args)
9250 "Use iswitch as a completing-read replacement to choose from choices.
9251 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
9252 from."
9253 (let* ((iswitchb-use-virtual-buffers nil)
9254 (iswitchb-make-buflist-hook
9255 (lambda ()
9256 (setq iswitchb-temp-buflist choices))))
9257 (iswitchb-read-buffer prompt)))
9259 (defun org-icompleting-read (&rest args)
9260 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
9261 (org-without-partial-completion
9262 (if (and org-completion-use-ido
9263 (fboundp 'ido-completing-read)
9264 (boundp 'ido-mode) ido-mode
9265 (listp (second args)))
9266 (let ((ido-enter-matching-directory nil))
9267 (apply 'ido-completing-read (concat (car args))
9268 (if (consp (car (nth 1 args)))
9269 (mapcar 'car (nth 1 args))
9270 (nth 1 args))
9271 (cddr args)))
9272 (if (and org-completion-use-iswitchb
9273 (boundp 'iswitchb-mode) iswitchb-mode
9274 (listp (second args)))
9275 (apply 'org-iswitchb-completing-read (concat (car args))
9276 (if (consp (car (nth 1 args)))
9277 (mapcar 'car (nth 1 args))
9278 (nth 1 args))
9279 (cddr args))
9280 (apply 'completing-read args)))))
9282 (defun org-extract-attributes (s)
9283 "Extract the attributes cookie from a string and set as text property."
9284 (let (a attr (start 0) key value)
9285 (save-match-data
9287 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
9289 (setq key (match-string 1 a) value (match-string 2 a)
9290 start (match-end 0)
9291 attr (plist-put attr (intern key) value))))
9292 (org-add-props s nil 'org-attr attr))
9293 s))
9295 (defun org-extract-attributes-from-string (tag)
9296 (let (key value attr)
9298 (setq key (match-string 1 tag) value (match-string 2 tag)
9299 tag (replace-match "" t t tag)
9300 attr (plist-put attr (intern key) value)))
9301 (cons tag attr)))
9303 (defun org-attributes-to-string (plist)
9304 "Format a property list into an HTML attribute list."
9305 (let ((s "") key value)
9306 (while plist
9307 (setq key (pop plist) value (pop plist))
9308 (and value
9310 s))
9312 ;;; Opening/following a link
9314 (defvar org-link-search-failed nil)
9316 (defvar org-open-link-functions nil
9317 "Hook for functions finding a plain text link.
9318 These functions must take a single argument, the link content.
9319 They will be called for links that look like [[link text][description]]
9323 These functions will be called *before* Org attempts to resolve the
9324 link by doing text searches in the current buffer - so if you want a
9326 handle this as a special case.
9328 When the function does handle the link, it must return a non-nil value.
9329 If it decides that it is not responsible for this link, it must return
9330 nil to indicate that that Org-mode can continue with other options
9331 like exact and fuzzy text search.")
9333 (defun org-next-link ()
9334 "Move forward to the next link.
9335 If the link is in hidden text, expose it."
9336 (interactive)
9337 (when (and org-link-search-failed (eq this-command last-command))
9338 (goto-char (point-min))
9339 (message "Link search wrapped back to beginning of buffer"))
9340 (setq org-link-search-failed nil)
9341 (let* ((pos (point))
9342 (ct (org-context))
9343 (a (assoc :link ct)))
9344 (if a (goto-char (nth 2 a)))
9345 (if (re-search-forward org-any-link-re nil t)
9346 (progn
9347 (goto-char (match-beginning 0))
9348 (if (outline-invisible-p) (org-show-context)))
9349 (goto-char pos)
9350 (setq org-link-search-failed t)
9351 (error "No further link found"))))
9353 (defun org-previous-link ()
9354 "Move backward to the previous link.
9355 If the link is in hidden text, expose it."
9356 (interactive)
9357 (when (and org-link-search-failed (eq this-command last-command))
9358 (goto-char (point-max))
9359 (message "Link search wrapped back to end of buffer"))
9360 (setq org-link-search-failed nil)
9361 (let* ((pos (point))
9362 (ct (org-context))
9363 (a (assoc :link ct)))
9364 (if a (goto-char (nth 1 a)))
9365 (if (re-search-backward org-any-link-re nil t)
9366 (progn
9367 (goto-char (match-beginning 0))
9368 (if (outline-invisible-p) (org-show-context)))
9369 (goto-char pos)
9370 (setq org-link-search-failed t)
9371 (error "No further link found"))))
9373 (defun org-translate-link (s)
9374 "Translate a link string if a translation function has been defined."
9375 (if (and org-link-translation-function
9376 (fboundp org-link-translation-function)
9378 (progn
9379 (setq s (funcall org-link-translation-function
9380 (match-string 1) (match-string 2)))
9381 (concat (car s) ":" (cdr s)))
9382 s))
9384 (defun org-translate-link-from-planner (type path)
9385 "Translate a link from Emacs Planner syntax so that Org can follow it.
9386 This is still an experimental function, your mileage may vary."
9387 (cond
9388 ((member type '("http" "https" "news" "ftp"))
9389 ;; standard Internet links are the same.
9390 nil)
9391 ((and (equal type "irc") (string-match "^//" path))
9392 ;; Planner has two / at the beginning of an irc link, we have 1.
9393 ;; We should have zero, actually....
9394 (setq path (substring path 1)))
9395 ((and (equal type "lisp") (string-match "^/" path))
9396 ;; Planner has a slash, we do not.
9397 (setq type "elisp" path (substring path 1)))
9399 ;; A typical message link. Planner has the id after the final slash,
9400 ;; we separate it with a hash mark
9401 (setq path (concat (match-string 1 path) "#"
9402 (org-remove-angle-brackets (match-string 2 path)))))
9403 )
9404 (cons type path))
9406 (defun org-find-file-at-mouse (ev)
9407 "Open file link or URL at mouse."
9408 (interactive "e")
9409 (mouse-set-point ev)
9410 (org-open-at-point 'in-emacs))
9412 (defun org-open-at-mouse (ev)
9413 "Open file link or URL at mouse.
9414 See the docstring of `org-open-file' for details."
9415 (interactive "e")
9416 (mouse-set-point ev)
9417 (if (eq major-mode 'org-agenda-mode)
9418 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
9419 (org-open-at-point))
9421 (defvar org-window-config-before-follow-link nil
9422 "The window configuration before following a link.
9423 This is saved in case the need arises to restore it.")
9425 (defvar org-open-link-marker (make-marker)
9426 "Marker pointing to the location where `org-open-at-point; was called.")
9428 ;;;###autoload
9429 (defun org-open-at-point-global ()
9430 "Follow a link like Org-mode does.
9431 This command can be called in any mode to follow a link that has
9432 Org-mode syntax."
9433 (interactive)
9434 (org-run-like-in-org-mode 'org-open-at-point))
9436 ;;;###autoload
9437 (defun org-open-link-from-string (s &optional arg reference-buffer)
9438 "Open a link in the string S, as if it was in Org-mode."
9440 (let ((reference-buffer (or reference-buffer (current-buffer))))
9441 (with-temp-buffer
9442 (let ((org-inhibit-startup t))
9443 (org-mode)
9444 (insert s)
9445 (goto-char (point-min))
9446 (when reference-buffer
9447 (setq org-link-abbrev-alist-local
9448 (with-current-buffer reference-buffer
9449 org-link-abbrev-alist-local)))
9450 (org-open-at-point arg reference-buffer)))))
9452 (defvar org-open-at-point-functions nil
9453 "Hook that is run when following a link at point.
9455 Functions in this hook must return t if they identify and follow
9456 a link at point. If they don't find anything interesting at point,
9457 they must return nil.")
9459 (defun org-open-at-point (&optional arg reference-buffer)
9460 "Open link at or after point.
9461 If there is no link at point, this function will search forward up to
9462 the end of the current line.
9463 Normally, files will be opened by an appropriate application. If the
9464 optional prefix argument ARG is non-nil, Emacs will visit the file.
9465 With a double prefix argument, try to open outside of Emacs, in the
9466 application the system uses for this file type."
9467 (interactive "P")
9468 ;; if in a code block, then open the block's results
9469 (unless (call-interactively #'org-babel-open-src-block-result)
9470 (org-load-modules-maybe)
9471 (move-marker org-open-link-marker (point))
9472 (setq org-window-config-before-follow-link (current-window-configuration))
9473 (org-remove-occur-highlights nil nil t)
9474 (cond
9475 ((and (org-at-heading-p)
9476 (not (org-in-regexp
9481 (not (get-text-property (point) 'org-linked-text)))
9482 (or (org-offer-links-in-entry arg)
9483 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
9484 ((run-hook-with-args-until-success 'org-open-at-point-functions))
9485 ((org-at-timestamp-p t) (org-follow-timestamp-link))
9486 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
9487 (not (org-in-regexp org-bracket-link-regexp)))
9488 (org-footnote-action))
9489 (t
9490 (let (type path link line search (pos (point)))
9491 (catch 'match
9492 (save-excursion
9494 (when (org-in-regexp org-bracket-link-regexp 1)
9495 (setq link (org-extract-attributes
9496 (org-link-unescape (org-match-string-no-properties 1))))
9498 (setq link (replace-match " " t t link)))
9499 (setq link (org-link-expand-abbrev link))
9500 (cond
9501 ((or (file-name-absolute-p link)
9503 (setq type "file" path link))
9504 ((string-match org-link-re-with-space3 link)
9505 (setq type (match-string 1 link) path (match-string 2 link)))
9506 (t (setq type "thisfile" path link)))
9507 (throw 'match t)))
9509 (when (get-text-property (point) 'org-linked-text)
9510 (setq type "thisfile"
9511 pos (if (get-text-property (1+ (point)) 'org-linked-text)
9512 (1+ (point)) (point))
9513 path (buffer-substring
9514 (or (previous-single-property-change pos 'org-linked-text)
9515 (point-min))
9516 (or (next-single-property-change pos 'org-linked-text)
9517 (point-max))))
9518 (throw 'match t))
9520 (save-excursion
9521 (when (or (org-in-regexp org-angle-link-re)
9522 (org-in-regexp org-plain-link-re))
9523 (setq type (match-string 1)
9524 path (org-link-unescape (match-string 2)))
9525 (throw 'match t)))
9526 (save-excursion
9528 (setq type "tags"
9529 path (match-string 1))
9530 (while (string-match ":" path)
9531 (setq path (replace-match "+" t t path)))
9532 (throw 'match t)))
9534 (setq type "tree-match"
9535 path (match-string 1))
9536 (throw 'match t)))
9537 (unless path
9538 (error "No link found"))
9540 ;; switch back to reference buffer
9541 ;; needed when if called in a temporary buffer through
9542 ;; org-open-link-from-string
9543 (with-current-buffer (or reference-buffer (current-buffer))
9545 ;; Remove any trailing spaces in path
9547 (setq path (replace-match "" t t path)))
9548 (if (and org-link-translation-function
9549 (fboundp org-link-translation-function))
9550 ;; Check if we need to translate the link
9551 (let ((tmp (funcall org-link-translation-function type path)))
9552 (setq type (car tmp) path (cdr tmp))))
9554 (cond
9556 ((assoc type org-link-protocols)
9557 (funcall (nth 1 (assoc type org-link-protocols)) path))
9559 ((equal type "mailto")
9560 (let ((cmd (car org-link-mailto-program))
9561 (args (cdr org-link-mailto-program)) args1
9562 (address path) (subject "") a)
9564 (setq address (match-string 1 path)
9565 subject (org-link-escape (match-string 2 path))))
9566 (while args
9567 (cond
9568 ((not (stringp (car args))) (push (pop args) args1))
9569 (t (setq a (pop args))
9570 (if (string-match "%a" a)
9571 (setq a (replace-match address t t a)))
9572 (if (string-match "%s" a)
9573 (setq a (replace-match subject t t a)))
9574 (push a args1))))
9575 (apply cmd (nreverse args1))))
9577 ((member type '("http" "https" "ftp" "news"))
9578 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
9579 (org-link-escape
9580 path org-link-escape-chars-browser)
9581 path))))
9583 ((string= type "doi")
9584 (browse-url (concat "http://dx.doi.org/" (if (org-string-match-p "[[:nonascii:] ]" path)
9585 (org-link-escape
9586 path org-link-escape-chars-browser)
9587 path))))
9589 ((member type '("message"))
9590 (browse-url (concat type ":" path)))
9592 ((string= type "tags")
9593 (org-tags-view arg path))
9595 ((string= type "tree-match")
9598 ((string= type "file")
9600 (setq line (string-to-number (match-string 1 path))
9601 path (substring path 0 (match-beginning 0)))
9603 (setq search (match-string 1 path)
9604 path (substring path 0 (match-beginning 0)))))
9605 (if (string-match "[*?{]" (file-name-nondirectory path))
9606 (dired path)
9607 (org-open-file path arg line search)))
9609 ((string= type "shell")
9610 (let ((cmd path))
9611 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
9612 (string-match org-confirm-shell-link-not-regexp cmd))
9613 (not org-confirm-shell-link-function)
9614 (funcall org-confirm-shell-link-function
9616 (org-add-props cmd nil
9617 'face 'org-warning))))
9618 (progn
9619 (message "Executing %s" cmd)
9620 (shell-command cmd))
9621 (error "Abort"))))
9623 ((string= type "elisp")
9624 (let ((cmd path))
9625 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
9626 (string-match org-confirm-elisp-link-not-regexp cmd))
9627 (not org-confirm-elisp-link-function)
9628 (funcall org-confirm-elisp-link-function
9630 (org-add-props cmd nil
9631 'face 'org-warning))))
9632 (message "%s => %s" cmd
9633 (if (equal (string-to-char cmd) ?\()
9634 (eval (read cmd))
9635 (call-interactively (read cmd))))
9636 (error "Abort"))))
9638 ((and (string= type "thisfile")
9639 (run-hook-with-args-until-success
9640 'org-open-link-functions path)))
9642 ((string= type "thisfile")
9643 (if arg
9644 (switch-to-buffer-other-window
9645 (org-get-buffer-for-internal-link (current-buffer)))
9646 (org-mark-ring-push))
9647 (let ((cmd `(org-link-search
9648 ,path
9649 ,(cond ((equal arg '(4)) ''occur)
9650 ((equal arg '(16)) ''org-occur)
9651 (t nil))
9652 ,pos)))
9653 (condition-case nil (let ((org-link-search-inhibit-query t))
9654 (eval cmd))
9655 (error (progn (widen) (eval cmd))))))
9657 (t
9658 (browse-url-at-point)))))))
9659 (move-marker org-open-link-marker nil)
9660 (run-hook-with-args 'org-follow-link-hook)))
9662 (defun org-offer-links-in-entry (&optional nth zero)
9663 "Offer links in the current entry and follow the selected link.
9664 If there is only one link, follow it immediately as well.
9665 If NTH is an integer, immediately pick the NTH link found.
9666 If ZERO is a string, check also this string for a link, and if
9667 there is one, offer it as link number zero."
9671 (cnt ?0)
9672 (in-emacs (if (integerp nth) nil nth))
9673 have-zero end links link c)
9674 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
9675 (push (match-string 0 zero) links)
9676 (setq cnt (1- cnt) have-zero t))
9677 (save-excursion
9678 (org-back-to-heading t)
9679 (setq end (save-excursion (outline-next-heading) (point)))
9680 (while (re-search-forward re end t)
9681 (push (match-string 0) links))
9682 (setq links (org-uniquify (reverse links))))
9684 (cond
9685 ((null links)
9686 (message "No links"))
9687 ((equal (length links) 1)
9688 (setq link (list (car links))))
9689 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
9690 (setq link (list (nth (if have-zero nth (1- nth)) links))))
9691 (t ; we have to select a link
9692 (save-excursion
9693 (save-window-excursion
9694 (delete-other-windows)
9695 (with-output-to-temp-buffer "*Select Link*"
9696 (mapc (lambda (l)
9697 (if (not (string-match org-bracket-link-regexp l))
9699 (org-remove-angle-brackets l)))
9700 (if (match-end 3)
9702 (match-string 3 l) (match-string 1 l)))
9704 (match-string 1 l))))))
9705 links))
9706 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
9707 (message "Select link to open, RET to open all:")
9708 (setq c (read-char-exclusive))
9709 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
9710 (when (equal c ?q) (error "Abort"))
9711 (if (equal c ?\C-m)
9712 (setq link links)
9713 (setq nth (- c ?0))
9714 (if have-zero (setq nth (1+ nth)))
9715 (unless (and (integerp nth) (>= (length links) nth))
9716 (error "Invalid link selection"))
9717 (setq link (list (nth (1- nth) links))))))
9718 (if link
9719 (let ((buf (current-buffer)))
9720 (dolist (l link)
9721 (org-open-link-from-string l in-emacs buf))
9722 t)
9723 nil)))
9725 ;; Add special file links that specify the way of opening
9727 (org-add-link-type "file+sys" 'org-open-file-with-system)
9728 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
9729 (defun org-open-file-with-system (path)
9730 "Open file at PATH using the system way of opening it."
9731 (org-open-file path 'system))
9732 (defun org-open-file-with-emacs (path)
9733 "Open file at PATH in Emacs."
9734 (org-open-file path 'emacs))
9735 (defun org-remove-file-link-modifiers ()
9736 "Remove the file link modifiers in `file+sys:' and `file+emacs:' links."
9737 (goto-char (point-min))
9739 (org-if-unprotected
9740 (replace-match "file:" t t))))
9741 (eval-after-load "org-exp"
9742 '(add-hook 'org-export-preprocess-before-normalizing-links-hook
9743 'org-remove-file-link-modifiers))
9745 ;;;; Time estimates
9747 (defun org-get-effort (&optional pom)
9748 "Get the effort estimate for the current entry."
9749 (org-entry-get pom org-effort-property))
9751 ;;; File search
9753 (defvar org-create-file-search-functions nil
9754 "List of functions to construct the right search string for a file link.
9755 These functions are called in turn with point at the location to
9756 which the link should point.
9758 A function in the hook should first test if it would like to
9759 handle this file type, for example by checking the `major-mode'
9760 or the file extension. If it decides not to handle this file, it
9761 should just return nil to give other functions a chance. If it
9762 does handle the file, it must return the search string to be used
9763 when following the link. The search string will be part of the
9764 file link, given after a double colon, and `org-open-at-point'
9765 will automatically search for it. If special measures must be
9766 taken to make the search successful, another function should be
9767 added to the companion hook `org-execute-file-search-functions',
9768 which see.
9770 A function in this hook may also use `setq' to set the variable
9771 `description' to provide a suggestion for the descriptive text to
9772 be used for this link when it gets inserted into an Org-mode
9775 (defvar org-execute-file-search-functions nil
9776 "List of functions to execute a file search triggered by a link.
9778 Functions added to this hook must accept a single argument, the
9779 search string that was part of the file link, the part after the
9780 double colon. The function must first check if it would like to
9781 handle this search, for example by checking the `major-mode' or
9782 the file extension. If it decides not to handle this search, it
9783 should just return nil to give other functions a chance. If it
9784 does handle the search, it must return a non-nil value to keep
9785 other functions from trying.
9787 Each function can access the current prefix argument through the
9788 variable `current-prefix-argument'. Note that a single prefix is
9789 used to force opening a link in Emacs, so it may be good to only
9790 use a numeric or double prefix to guide the search function.
9792 In case this is needed, a function in this hook can also restore
9793 the window configuration before `org-open-at-point' was called using:
9795 (set-window-configuration org-window-config-before-follow-link)")
9797 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
9798 (defun org-link-search (s &optional type avoid-pos stealth)
9799 "Search for a link search option.
9800 If S is surrounded by forward slashes, it is interpreted as a
9801 regular expression. In org-mode files, this will create an `org-occur'
9802 sparse tree. In ordinary files, `occur' will be used to list matches.
9803 If the current buffer is in `dired-mode', grep will be used to search
9804 in all files. If AVOID-POS is given, ignore matches near that position.
9806 When optional argument STEALTH is non-nil, do not modify
9807 visibility around point, thus ignoring
9808 `org-show-hierarchy-above', `org-show-following-heading' and
9809 `org-show-siblings' variables."
9810 (let ((case-fold-search t)
9814 org-emphasis-alist)
9816 (pos (point))
9817 (pre nil) (post nil)
9818 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
9819 (cond
9820 ;; First check if there are any special search functions
9821 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
9822 ;; Now try the builtin stuff
9823 ((and (equal (string-to-char s0) ?#)
9824 (> (length s0) 1)
9825 (save-excursion
9826 (goto-char (point-min))
9827 (and
9828 (re-search-forward
9830 (setq type 'dedicated
9831 pos (match-beginning 0))))
9832 ;; There is an exact target for this
9833 (goto-char pos)
9834 (org-back-to-heading t)))
9835 ((save-excursion
9836 (goto-char (point-min))
9837 (and
9838 (re-search-forward
9839 (concat "<<" (regexp-quote s0) ">>") nil t)
9840 (setq type 'dedicated
9841 pos (match-beginning 0))))
9842 ;; There is an exact target for this
9843 (goto-char pos))
9845 (save-excursion
9846 (goto-char (point-min))
9847 (and
9848 (re-search-forward
9849 (concat "[^[]" (regexp-quote
9850 (format org-coderef-label-format
9851 (match-string 1 s0))))
9852 nil t)
9853 (setq type 'dedicated
9854 pos (1+ (match-beginning 0))))))
9855 ;; There is a coderef target for this
9856 (goto-char pos))
9858 ;; A regular expression
9859 (cond
9860 ((eq major-mode 'org-mode)
9861 (org-occur (match-string 1 s)))
9862 ;;((eq major-mode 'dired-mode)
9863 ;; (grep (concat "grep -n -e '" (match-string 1 s) "' *")))
9864 (t (org-do-occur (match-string 1 s)))))
9865 ((and (eq major-mode 'org-mode) org-link-search-must-match-exact-headline)
9866 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
9867 (goto-char (point-min))
9868 (cond
9869 ((let (case-fold-search)
9870 (re-search-forward (format org-complex-heading-regexp-format
9871 (regexp-quote s))
9872 nil t))
9873 ;; OK, found a match
9874 (setq type 'dedicated)
9875 (goto-char (match-beginning 0)))
9876 ((and (not org-link-search-inhibit-query)
9877 (eq org-link-search-must-match-exact-headline 'query-to-create)
9878 (y-or-n-p "No match - create this as a new heading? "))
9879 (goto-char (point-max))
9880 (or (bolp) (newline))
9882 (beginning-of-line 0))
9883 (t
9884 (goto-char pos)
9885 (error "No match"))))
9886 (t
9887 ;; A normal search string
9888 (when (equal (string-to-char s) ?*)
9889 ;; Anchor on headlines, post may include tags.
9892 s (substring s 1)))
9893 (remove-text-properties
9894 0 (length s)
9895 '(face nil mouse-face nil keymap nil fontified nil) s)
9896 ;; Make a series of regular expressions to find a match
9905 re4 (concat "[^a-zA-Z_]" re4_)
9907 re1 (concat pre re2 post)
9908 re3 (concat pre (if pre re4_ re4) post)
9909 re5 (concat pre ".*" re4)
9910 re2 (concat pre re2)
9911 re2a (concat pre (if pre re2a_ re2a))
9912 re4 (concat pre (if pre re4_ re4))
9916 ))
9917 (cond
9918 ((eq type 'org-occur) (org-occur reall))
9919 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
9920 (t (goto-char (point-min))
9921 (setq type 'fuzzy)
9922 (if (or (and (org-search-not-self 1 re0 nil t) (setq type 'dedicated))
9923 (org-search-not-self 1 re1 nil t)
9924 (org-search-not-self 1 re2 nil t)
9925 (org-search-not-self 1 re2a nil t)
9926 (org-search-not-self 1 re3 nil t)
9927 (org-search-not-self 1 re4 nil t)
9928 (org-search-not-self 1 re5 nil t)
9929 )
9930 (goto-char (match-beginning 1))
9931 (goto-char pos)
9932 (error "No match"))))))
9933 (and (eq major-mode 'org-mode)
9934 (not stealth)
9935 (org-show-context 'link-search))
9936 type))
9938 (defun org-search-not-self (group &rest args)
9939 "Execute `re-search-forward', but only accept matches that do not
9940 enclose the position of `org-open-link-marker'."
9941 (let ((m org-open-link-marker))
9942 (catch 'exit
9943 (while (apply 're-search-forward args)
9944 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
9945 (goto-char (match-end group))
9946 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
9947 (> (match-beginning 0) (marker-position m))
9948 (< (match-end 0) (marker-position m)))
9949 (save-match-data
9950 (or (not (org-in-regexp
9951 org-bracket-link-analytic-regexp 1))
9952 (not (match-end 4)) ; no description
9953 (and (<= (match-beginning 4) (point))
9954 (>= (match-end 4) (point))))))
9955 (throw 'exit (point))))))))
9957 (defun org-get-buffer-for-internal-link (buffer)
9958 "Return a buffer to be used for displaying the link target of internal links."
9959 (cond
9960 ((not org-display-internal-link-with-indirect-buffer)
9961 buffer)
9962 ((string-match "(Clone)$" (buffer-name buffer))
9963 (message "Buffer is already a clone, not making another one")
9964 ;; we also do not modify visibility in this case
9965 buffer)
9966 (t ; make a new indirect buffer for displaying the link
9967 (let* ((bn (buffer-name buffer))
9968 (ibn (concat bn "(Clone)"))
9969 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
9970 (with-current-buffer ib (org-overview))
9971 ib))))
9973 (defun org-do-occur (regexp &optional cleanup)
9974 "Call the Emacs command `occur'.
9975 If CLEANUP is non-nil, remove the printout of the regular expression
9976 in the *Occur* buffer. This is useful if the regex is long and not useful
9977 to read."
9978 (occur regexp)
9979 (when cleanup
9980 (let ((cwin (selected-window)) win beg end)
9981 (when (setq win (get-buffer-window "*Occur*"))
9982 (select-window win))
9983 (goto-char (point-min))
9984 (when (re-search-forward "match[a-z]+" nil t)
9985 (setq beg (match-end 0))
9987 (setq end (1- (match-beginning 0)))))
9988 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
9989 (goto-char (point-min))
9990 (select-window cwin))))
9992 ;;; The mark ring for links jumps
9994 (defvar org-mark-ring nil
9995 "Mark ring for positions before jumps in Org-mode.")
9996 (defvar org-mark-ring-last-goto nil
9997 "Last position in the mark ring used to go back.")
9998 ;; Fill and close the ring
9999 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10000 (loop for i from 1 to org-mark-ring-length do
10001 (push (make-marker) org-mark-ring))
10002 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10003 org-mark-ring)
10005 (defun org-mark-ring-push (&optional pos buffer)
10006 "Put the current position or POS into the mark ring and rotate it."
10007 (interactive)
10008 (setq pos (or pos (point)))
10009 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10010 (move-marker (car org-mark-ring)
10011 (or pos (point))
10012 (or buffer (current-buffer)))
10013 (message "%s"
10014 (substitute-command-keys
10017 (defun org-mark-ring-goto (&optional n)
10018 "Jump to the previous position in the mark ring.
10019 With prefix arg N, jump back that many stored positions. When
10020 called several times in succession, walk through the entire ring.
10021 Org-mode commands jumping to a different position in the current file,
10022 or to another Org-mode file, automatically push the old position
10023 onto the ring."
10024 (interactive "p")
10025 (let (p m)
10026 (if (eq last-command this-command)
10027 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10028 (setq p org-mark-ring))
10029 (setq org-mark-ring-last-goto p)
10030 (setq m (car p))
10031 (org-pop-to-buffer-same-window (marker-buffer m))
10032 (goto-char m)
10033 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10035 (defun org-remove-angle-brackets (s)
10036 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10037 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10038 s)
10039 (defun org-add-angle-brackets (s)
10040 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10041 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10042 s)
10043 (defun org-remove-double-quotes (s)
10046 s)
10048 ;;; Following specific links
10050 (defun org-follow-timestamp-link ()
10051 (cond
10052 ((org-at-date-range-p t)
10053 (let ((org-agenda-start-on-weekday)
10054 (t1 (match-string 1))
10055 (t2 (match-string 2)))
10056 (setq t1 (time-to-days (org-time-string-to-time t1))
10057 t2 (time-to-days (org-time-string-to-time t2)))
10058 (org-agenda-list nil t1 (1+ (- t2 t1)))))
10059 ((org-at-timestamp-p t)
10060 (org-agenda-list nil (time-to-days (org-time-string-to-time
10061 (substring (match-string 1) 0 10)))
10062 1))
10063 (t (error "This should not happen"))))
10066 ;;; Following file links
10067 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10068 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10069 (declare-function mailcap-mime-info
10070 "mailcap" (string &optional request no-decode))
10071 (defvar org-wait nil)
10072 (defun org-open-file (path &optional in-emacs line search)
10073 "Open the file at PATH.
10074 First, this expands any special file name abbreviations. Then the
10075 configuration variable `org-file-apps' is checked if it contains an
10076 entry for this file type, and if yes, the corresponding command is launched.
10078 If no application is found, Emacs simply visits the file.
10080 With optional prefix argument IN-EMACS, Emacs will visit the file.
10082 prefix arg, Org tries to avoid opening in Emacs
10083 and to use an external application to visit the file.
10085 Optional LINE specifies a line to go to, optional SEARCH a string
10086 to search for. If LINE or SEARCH is given, the file will be
10087 opened in Emacs, unless an entry from org-file-apps that makes
10088 use of groups in a regexp matches.
10090 If you want to change the way frames are used when following a
10091 link, please customize `org-link-frame-setup'.
10093 If the file does not exist, an error is thrown."
10094 (let* ((file (if (equal path "")
10095 buffer-file-name
10096 (substitute-in-file-name (expand-file-name path))))
10097 (file-apps (append org-file-apps (org-default-apps)))
10098 (apps (org-remove-if
10099 'org-file-apps-entry-match-against-dlink-p file-apps))
10100 (apps-dlink (org-remove-if-not
10101 'org-file-apps-entry-match-against-dlink-p file-apps))
10102 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10103 (dirp (if remp nil (file-directory-p file)))
10104 (file (if (and dirp org-open-directory-means-index-dot-org)
10105 (concat (file-name-as-directory file) "index.org")
10106 file))
10107 (a-m-a-p (assq 'auto-mode apps))
10108 (dfile (downcase file))
10109 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10110 (link (cond ((and (eq line nil)
10111 (eq search nil))
10112 file)
10113 (line
10114 (concat file "::" (number-to-string line)))
10115 (search
10116 (concat file "::" search))))
10117 (dlink (downcase link))
10118 (old-buffer (current-buffer))
10119 (old-pos (point))
10120 (old-mode major-mode)
10121 ext cmd link-match-data)
10123 (setq ext (match-string 1 dfile))
10125 (setq ext (match-string 1 dfile))))
10126 (cond
10127 ((member in-emacs '((16) system))
10128 (setq cmd (cdr (assoc 'system apps))))
10129 (in-emacs (setq cmd 'emacs))
10130 (t
10131 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10132 (and dirp (cdr (assoc 'directory apps)))
10133 ; first, try matching against apps-dlink
10134 ; if we get a match here, store the match data for later
10135 (let ((match (assoc-default dlink apps-dlink
10136 'string-match)))
10137 (if match
10138 (progn (setq link-match-data (match-data))
10139 match)
10140 (progn (setq in-emacs (or in-emacs line search))
10141 nil))) ; if we have no match in apps-dlink,
10142 ; always open the file in emacs if line or search
10143 ; is given (for backwards compatibility)
10144 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10145 'string-match)
10146 (cdr (assoc ext apps))
10147 (cdr (assoc t apps))))))
10148 (when (eq cmd 'system)
10149 (setq cmd (cdr (assoc 'system apps))))
10150 (when (eq cmd 'default)
10151 (setq cmd (cdr (assoc t apps))))
10152 (when (eq cmd 'mailcap)
10153 (require 'mailcap)
10154 (mailcap-parse-mailcaps)
10155 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10156 (command (mailcap-mime-info mime-type)))
10157 (if (stringp command)
10158 (setq cmd command)
10159 (setq cmd 'emacs))))
10160 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10161 (not (file-exists-p file))
10162 (not org-open-non-existing-files))
10163 (error "No such file: %s" file))
10164 (cond
10166 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10168 (setq cmd (replace-match "%s" t t cmd)))
10169 (while (string-match "%s" cmd)
10170 (setq cmd (replace-match
10171 (save-match-data
10172 (shell-quote-argument
10173 (convert-standard-filename file)))
10174 t t cmd)))
10176 ;; Replace "%1", "%2" etc. in command with group matches from regex
10177 (save-match-data
10178 (let ((match-index 1)
10179 (number-of-groups (- (/ (length link-match-data) 2) 1)))
10180 (set-match-data link-match-data)
10181 (while (<= match-index number-of-groups)
10182 (let ((regex (concat "%" (number-to-string match-index)))
10183 (replace-with (match-string match-index dlink)))
10184 (while (string-match regex cmd)
10185 (setq cmd (replace-match replace-with t t cmd))))
10186 (setq match-index (+ match-index 1)))))
10188 (save-window-excursion
10189 (start-process-shell-command cmd nil cmd)
10190 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))
10191 ))
10192 ((or (stringp cmd)
10193 (eq cmd 'emacs))
10194 (funcall (cdr (assq 'file org-link-frame-setup)) file)
10195 (widen)
10196 (if line (org-goto-line line)
10197 (if search (org-link-search search))))
10198 ((consp cmd)
10199 (let ((file (convert-standard-filename file)))
10200 (save-match-data
10201 (set-match-data link-match-data)
10202 (eval cmd))))
10203 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
10204 (and (eq major-mode 'org-mode) (eq old-mode 'org-mode)
10205 (or (not (equal old-buffer (current-buffer)))
10206 (not (equal old-pos (point))))
10207 (org-mark-ring-push old-pos old-buffer))))
10209 (defun org-file-apps-entry-match-against-dlink-p (entry)
10210 "This function returns non-nil if `entry' uses a regular
10211 expression which should be matched against the whole link by
10212 org-open-file.
10214 It assumes that is the case when the entry uses a regular
10215 expression which has at least one grouping construct and the
10216 action is either a lisp form or a command string containing
10217 '%1', i.e. using at least one subexpression match as a
10218 parameter."
10219 (let ((selector (car entry))
10220 (action (cdr entry)))
10221 (if (stringp selector)
10222 (and (> (regexp-opt-depth selector) 0)
10223 (or (and (stringp action)
10224 (string-match "%[0-9]" action))
10225 (consp action)))
10226 nil)))
10228 (defun org-default-apps ()
10229 "Return the default applications for this operating system."
10230 (cond
10231 ((eq system-type 'darwin)
10232 org-file-apps-defaults-macosx)
10233 ((eq system-type 'windows-nt)
10234 org-file-apps-defaults-windowsnt)
10235 (t org-file-apps-defaults-gnu)))
10237 (defun org-apps-regexp-alist (list &optional add-auto-mode)
10238 "Convert extensions to regular expressions in the cars of LIST.
10239 Also, weed out any non-string entries, because the return value is used
10240 only for regexp matching.
10241 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
10242 point to the symbol `emacs', indicating that the file should
10243 be opened in Emacs."
10244 (append
10245 (delq nil
10246 (mapcar (lambda (x)
10247 (if (not (stringp (car x)))
10248 nil
10250 x
10252 list))
10253 (if add-auto-mode
10254 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
10256 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
10257 (defun org-file-remote-p (file)
10258 "Test whether FILE specifies a location on a remote system.
10259 Return non-nil if the location is indeed remote.
10263 (cond ((fboundp 'file-remote-p)
10264 (file-remote-p file))
10265 ((fboundp 'tramp-handle-file-remote-p)
10266 (tramp-handle-file-remote-p file))
10267 ((and (boundp 'ange-ftp-name-format)
10268 (string-match (car ange-ftp-name-format) file))
10269 t)
10270 (t nil)))
10273 ;;;; Refiling
10275 (defun org-get-org-file ()
10276 "Read a filename, with default directory `org-directory'."
10277 (let ((default (or org-default-notes-file remember-data-file)))
10278 (read-file-name (format "File name [%s]: " default)
10279 (file-name-as-directory org-directory)
10280 default)))
10282 (defun org-notes-order-reversed-p ()
10283 "Check if the current file should receive notes in reversed order."
10284 (cond
10285 ((not org-reverse-note-order) nil)
10286 ((eq t org-reverse-note-order) t)
10287 ((not (listp org-reverse-note-order)) nil)
10288 (t (catch 'exit
10289 (let ((all org-reverse-note-order)
10290 entry)
10291 (while (setq entry (pop all))
10292 (if (string-match (car entry) buffer-file-name)
10293 (throw 'exit (cdr entry))))
10294 nil)))))
10296 (defvar org-refile-target-table nil
10297 "The list of refile targets, created by `org-refile'.")
10299 (defvar org-agenda-new-buffers nil
10300 "Buffers created to visit agenda files.")
10302 (defvar org-refile-cache nil
10303 "Cache for refile targets.")
10305 (defvar org-refile-markers nil
10306 "All the markers used for caching refile locations.")
10308 (defun org-refile-marker (pos)
10309 "Get a new refile marker, but only if caching is in use."
10310 (if (not org-refile-use-cache)
10311 pos
10312 (let ((m (make-marker)))
10313 (move-marker m pos)
10314 (push m org-refile-markers)
10315 m)))
10317 (defun org-refile-cache-clear ()
10318 "Clear the refile cache and disable all the markers."
10319 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
10320 (setq org-refile-markers nil)
10321 (setq org-refile-cache nil)
10322 (message "Refile cache has been cleared"))
10324 (defun org-refile-cache-check-set (set)
10325 "Check if all the markers in the cache still have live buffers."
10326 (let (marker)
10327 (catch 'exit
10328 (while (and set (setq marker (nth 3 (pop set))))
10329 ;; if org-refile-use-outline-path is 'file, marker may be nil
10330 (when (and marker (null (marker-buffer marker)))
10331 (message "not found") (sit-for 3)
10332 (throw 'exit nil)))
10333 t)))
10335 (defun org-refile-cache-put (set &rest identifiers)
10336 "Push the refile targets SET into the cache, under IDENTIFIERS."
10337 (let* ((key (sha1 (prin1-to-string identifiers)))
10338 (entry (assoc key org-refile-cache)))
10339 (if entry
10340 (setcdr entry set)
10341 (push (cons key set) org-refile-cache))))
10343 (defun org-refile-cache-get (&rest identifiers)
10344 "Retrieve the cached value for refile targets given by IDENTIFIERS."
10345 (cond
10346 ((not org-refile-cache) nil)
10347 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
10348 (t
10349 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
10350 org-refile-cache))))
10351 (and set (org-refile-cache-check-set set) set)))))
10353 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
10354 "Produce a table with refile targets."
10355 (let ((case-fold-search nil)
10356 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
10357 (entries (or org-refile-targets '((nil . (:level . 1)))))
10358 targets tgs txt re files f desc descre fast-path-p level pos0)
10359 (message "Getting targets...")
10360 (with-current-buffer (or default-buffer (current-buffer))
10361 (while (setq entry (pop entries))
10362 (setq files (car entry) desc (cdr entry))
10363 (setq fast-path-p nil)
10364 (cond
10365 ((null files) (setq files (list (current-buffer))))
10366 ((eq files 'org-agenda-files)
10367 (setq files (org-agenda-files 'unrestricted)))
10368 ((and (symbolp files) (fboundp files))
10369 (setq files (funcall files)))
10370 ((and (symbolp files) (boundp files))
10371 (setq files (symbol-value files))))
10372 (if (stringp files) (setq files (list files)))
10373 (cond
10374 ((eq (car desc) :tag)
10376 ((eq (car desc) :todo)
10378 ((eq (car desc) :regexp)
10379 (setq descre (cdr desc)))
10380 ((eq (car desc) :level)
10382 (if org-odd-levels-only
10383 (1- (* 2 (cdr desc)))
10384 (cdr desc)))
10386 ((eq (car desc) :maxlevel)
10387 (setq fast-path-p t)
10389 (if org-odd-levels-only
10390 (1- (* 2 (cdr desc)))
10391 (cdr desc)))
10393 (t (error "Bad refiling target description %s" desc)))
10394 (while (setq f (pop files))
10395 (with-current-buffer
10396 (if (bufferp f) f (org-get-agenda-file-buffer f))
10397 (or
10398 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
10399 (progn
10400 (if (bufferp f) (setq f (buffer-file-name
10401 (buffer-base-buffer f))))
10402 (setq f (and f (expand-file-name f)))
10403 (if (eq org-refile-use-outline-path 'file)
10404 (push (list (file-name-nondirectory f) f nil nil) tgs))
10405 (save-excursion
10406 (save-restriction
10407 (widen)
10408 (goto-char (point-min))
10409 (while (re-search-forward descre nil t)
10410 (goto-char (setq pos0 (point-at-bol)))
10411 (catch 'next
10412 (when org-refile-target-verify-function
10413 (save-match-data
10414 (or (funcall org-refile-target-verify-function)
10415 (throw 'next t))))
10416 (when (and (looking-at org-complex-heading-regexp)
10417 (not (member (match-string 4) excluded-entries))
10418 (match-string 4))
10419 (setq level (org-reduced-level
10420 (- (match-end 1) (match-beginning 1)))
10421 txt (org-link-display-format (match-string 4))
10423 re (format org-complex-heading-regexp-format
10424 (regexp-quote (match-string 4))))
10425 (when org-refile-use-outline-path
10426 (setq txt (mapconcat
10427 'org-protect-slash
10428 (append
10429 (if (eq org-refile-use-outline-path
10430 'file)
10431 (list (file-name-nondirectory
10432 (buffer-file-name
10433 (buffer-base-buffer))))
10434 (if (eq org-refile-use-outline-path
10435 'full-file-path)
10436 (list (buffer-file-name
10437 (buffer-base-buffer)))))
10438 (org-get-outline-path fast-path-p
10439 level txt)
10440 (list txt))
10441 "/")))
10442 (push (list txt f re (org-refile-marker (point)))
10443 tgs)))
10444 (when (= (point) pos0)
10445 ;; verification function has not moved point
10446 (goto-char (point-at-eol))))))))
10447 (when org-refile-use-cache
10448 (org-refile-cache-put tgs (buffer-file-name) descre))
10449 (setq targets (append tgs targets))
10450 ))))
10451 (message "Getting targets...done")
10452 (nreverse targets)))
10454 (defun org-protect-slash (s)
10455 (while (string-match "/" s)
10457 s)
10459 (defvar org-olpa (make-vector 20 nil))
10461 (defun org-get-outline-path (&optional fastp level heading)
10462 "Return the outline path to the current entry, as a list.
10464 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
10465 routine which makes outline path derivations for an entire file,
10466 avoiding backtracing. Refile target collection makes use of that."
10467 (if fastp
10468 (progn
10469 (if (> level 19)
10470 (error "Outline path failure, more than 19 levels"))
10471 (loop for i from level upto 19 do
10472 (aset org-olpa i nil))
10473 (prog1
10474 (delq nil (append org-olpa nil))
10475 (aset org-olpa level heading)))
10476 (let (rtn case-fold-search)
10477 (save-excursion
10478 (save-restriction
10479 (widen)
10480 (while (org-up-heading-safe)
10481 (when (looking-at org-complex-heading-regexp)
10482 (push (org-match-string-no-properties 4) rtn)))
10483 rtn)))))
10485 (defun org-format-outline-path (path &optional width prefix)
10486 "Format the outline path PATH for display.
10487 Width is the maximum number of characters that is available.
10488 Prefix is a prefix to be included in the returned string,
10489 such as the file name."
10490 (setq width (or width 79))
10491 (if prefix (setq width (- width (length prefix))))
10492 (if (not path)
10493 (or prefix "")
10494 (let* ((nsteps (length path))
10495 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
10496 (maxwidth (if (<= total-width width)
10497 10000 ;; everything fits
10498 ;; we need to shorten the level headings
10499 (/ (- width nsteps) nsteps)))
10500 (org-odd-levels-only nil)
10501 (n 0)
10502 (total (1+ (length prefix))))
10503 (setq maxwidth (max maxwidth 10))
10504 (concat prefix
10505 (mapconcat
10506 (lambda (h)
10507 (setq n (1+ n))
10508 (if (and (= n nsteps) (< maxwidth 10000))
10509 (setq maxwidth (- total-width total)))
10510 (if (< (length h) maxwidth)
10511 (progn (setq total (+ total (length h) 1)) h)
10512 (setq h (substring h 0 (- maxwidth 2))
10513 total (+ total maxwidth 1))
10515 (setq h (substring h 0 (match-beginning 0))))
10516 (setq h (concat h "..")))
10517 (org-add-props h nil 'face
10518 (nth (% (1- n) org-n-level-faces)
10519 org-level-faces))
10520 h)
10521 path "/")))))
10523 (defun org-display-outline-path (&optional file current)
10524 "Display the current outline path in the echo area."
10525 (interactive "P")
10526 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
10527 (case-fold-search nil)
10528 (path (and (eq major-mode 'org-mode) (org-get-outline-path))))
10529 (if current (setq path (append path
10530 (save-excursion
10531 (org-back-to-heading t)
10532 (if (looking-at org-complex-heading-regexp)
10533 (list (match-string 4)))))))
10534 (message "%s"
10535 (org-format-outline-path
10536 path
10537 (1- (frame-width))
10538 (and file bfn (concat (file-name-nondirectory bfn) "/"))))))
10540 (defvar org-refile-history nil
10541 "History for refiling operations.")
10543 (defvar org-after-refile-insert-hook nil
10544 "Hook run after `org-refile' has inserted its stuff at the new location.
10545 Note that this is still *before* the stuff will be removed from
10546 the *old* location.")
10548 (defvar org-capture-last-stored-marker)
10549 (defun org-refile (&optional goto default-buffer rfloc)
10550 "Move the entry or entries at point to another heading.
10551 The list of target headings is compiled using the information in
10552 `org-refile-targets', which see.
10554 At the target location, the entry is filed as a subitem of the target
10555 heading. Depending on `org-reverse-note-order', the new subitem will
10556 either be the first or the last subitem.
10558 If there is an active region, all entries in that region will be moved.
10559 However, the region must fulfill the requirement that the first heading
10560 is the first one sets the top-level of the moved text - at most siblings
10561 below it are allowed.
10563 With prefix arg GOTO, the command will only visit the target location
10564 and not actually move anything.
10567 go to the location where the last refiling operation has put the subtree.
10568 With a prefix argument of `2', refile to the running clock.
10570 RFLOC can be a refile location obtained in a different way.
10572 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
10574 If you are using target caching (see `org-refile-use-cache'),
10575 You have to clear the target cache in order to find new targets.
10576 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
10577 prefix argument (`C-u C-u C-u C-c C-w')."
10579 (interactive "P")
10580 (if (member goto '(0 (64)))
10581 (org-refile-cache-clear)
10582 (let* ((cbuf (current-buffer))
10583 (regionp (org-region-active-p))
10584 (region-start (and regionp (region-beginning)))
10585 (region-end (and regionp (region-end)))
10586 (region-length (and regionp (- region-end region-start)))
10587 (filename (buffer-file-name (buffer-base-buffer cbuf)))
10588 pos it nbuf file re level reversed)
10589 (setq last-command nil)
10590 (when regionp
10591 (goto-char region-start)
10592 (or (bolp) (goto-char (point-at-bol)))
10593 (setq region-start (point))
10594 (unless (or (org-kill-is-subtree-p
10595 (buffer-substring region-start region-end))
10596 (prog1 org-refile-active-region-within-subtree
10597 (org-toggle-heading)))
10598 (error "The region is not a (sequence of) subtree(s)")))
10599 (if (equal goto '(16))
10600 (org-refile-goto-last-stored)
10601 (when (or
10602 (and (equal goto 2)
10603 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
10604 (prog1
10605 (setq it (list (or org-clock-heading "running clock")
10606 (buffer-file-name
10607 (marker-buffer org-clock-hd-marker))
10608 ""
10609 (marker-position org-clock-hd-marker)))
10610 (setq goto nil)))
10611 (setq it (or rfloc
10612 (let (heading-text)
10613 (save-excursion
10614 (unless goto
10615 (org-back-to-heading t)
10616 (setq heading-text
10617 (nth 4 (org-heading-components))))
10618 (org-refile-get-location
10619 (cond (goto "Goto")
10620 (regionp "Refile region to")
10623 default-buffer
10624 org-refile-allow-creating-parent-nodes
10625 goto))))))
10626 (setq file (nth 1 it)
10627 re (nth 2 it)
10628 pos (nth 3 it))
10629 (if (and (not goto)
10630 pos
10631 (equal (buffer-file-name) file)
10632 (if regionp
10633 (and (>= pos region-start)
10634 (<= pos region-end))
10635 (and (>= pos (point))
10636 (< pos (save-excursion
10637 (org-end-of-subtree t t))))))
10638 (error "Cannot refile to position inside the tree or region"))
10640 (setq nbuf (or (find-buffer-visiting file)
10641 (find-file-noselect file)))
10642 (if goto
10643 (progn
10644 (org-pop-to-buffer-same-window nbuf)
10645 (goto-char pos)
10646 (org-show-context 'org-goto))
10647 (if regionp
10648 (progn
10649 (org-kill-new (buffer-substring region-start region-end))
10650 (org-save-markers-in-region region-start region-end))
10651 (org-copy-subtree 1 nil t))
10652 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
10653 (find-file-noselect file)))
10654 (setq reversed (org-notes-order-reversed-p))
10655 (save-excursion
10656 (save-restriction
10657 (widen)
10658 (if pos
10659 (progn
10660 (goto-char pos)
10661 (looking-at org-outline-regexp)
10662 (setq level (org-get-valid-level (funcall outline-level) 1))
10663 (goto-char
10664 (if reversed
10665 (or (outline-next-heading) (point-max))
10666 (or (save-excursion (org-get-next-sibling))
10667 (org-end-of-subtree t t)
10668 (point-max)))))
10669 (setq level 1)
10670 (if (not reversed)
10671 (goto-char (point-max))
10672 (goto-char (point-min))
10673 (or (outline-next-heading) (goto-char (point-max)))))
10674 (if (not (bolp)) (newline))
10675 (org-paste-subtree level)
10676 (when org-log-refile
10677 (org-add-log-setup 'refile nil nil 'findpos
10678 org-log-refile)
10679 (unless (eq org-log-refile 'note)
10680 (save-excursion (org-add-log-note))))
10681 (and org-auto-align-tags (org-set-tags nil t))
10682 (bookmark-set "org-refile-last-stored")
10683 ;; If we are refiling for capture, make sure that the
10684 ;; last-capture pointers point here
10685 (when (org-bound-and-true-p org-refile-for-capture)
10686 (bookmark-set "org-capture-last-stored-marker")
10687 (move-marker org-capture-last-stored-marker (point)))
10688 (if (fboundp 'deactivate-mark) (deactivate-mark))
10689 (run-hooks 'org-after-refile-insert-hook))))
10690 (if regionp
10691 (delete-region (point) (+ (point) region-length))
10692 (org-cut-subtree))
10693 (when (featurep 'org-inlinetask)
10694 (org-inlinetask-remove-END-maybe))
10695 (setq org-markers-to-move nil)
10698 (defun org-refile-goto-last-stored ()
10699 "Go to the location where the last refile was stored."
10700 (interactive)
10701 (bookmark-jump "org-refile-last-stored")
10702 (message "This is the location of the last refile"))
10704 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
10705 no-exclude)
10706 "Prompt the user for a refile location, using PROMPT.
10707 PROMPT should not be suffixed with a colon and a space, because
10708 this function appends the default value from
10709 `org-refile-history' automatically, if that is not empty.
10710 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
10711 this is used for the GOTO interface."
10712 (let ((org-refile-targets org-refile-targets)
10713 (org-refile-use-outline-path org-refile-use-outline-path)
10714 excluded-entries)
10715 (when (and (eq major-mode 'org-mode)
10716 (not org-refile-use-cache)
10717 (not no-exclude))
10718 (org-map-tree
10719 (lambda()
10720 (setq excluded-entries
10721 (append excluded-entries (list (org-get-heading t t)))))))
10722 (setq org-refile-target-table
10723 (org-refile-get-targets default-buffer excluded-entries)))
10724 (unless org-refile-target-table
10725 (error "No refile targets"))
10726 (let* ((prompt (concat prompt
10727 (and (car org-refile-history)
10728 (concat " (default " (car org-refile-history) ")"))
10729 ": "))
10730 (cbuf (current-buffer))
10731 (partial-completion-mode nil)
10732 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
10733 (cfunc (if (and org-refile-use-outline-path
10734 org-outline-path-complete-in-steps)
10735 'org-olpath-completing-read
10736 'org-icompleting-read))
10737 (extra (if org-refile-use-outline-path "/" ""))
10738 (filename (and cfn (expand-file-name cfn)))
10739 (tbl (mapcar
10740 (lambda (x)
10741 (if (and (not (member org-refile-use-outline-path
10742 '(file full-file-path)))
10743 (not (equal filename (nth 1 x))))
10744 (cons (concat (car x) extra " ("
10745 (file-name-nondirectory (nth 1 x)) ")")
10746 (cdr x))
10747 (cons (concat (car x) extra) (cdr x))))
10748 org-refile-target-table))
10749 (completion-ignore-case t)
10750 pa answ parent-target child parent old-hist)
10751 (setq old-hist org-refile-history)
10752 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
10753 nil 'org-refile-history (car org-refile-history)))
10754 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
10755 (org-refile-check-position pa)
10756 (if pa
10757 (progn
10758 (when (or (not org-refile-history)
10759 (not (eq old-hist org-refile-history))
10760 (not (equal (car pa) (car org-refile-history))))
10761 (setq org-refile-history
10762 (cons (car pa) (if (assoc (car org-refile-history) tbl)
10763 org-refile-history
10764 (cdr org-refile-history))))
10765 (if (equal (car org-refile-history) (nth 1 org-refile-history))
10766 (pop org-refile-history)))
10767 pa)
10769 (progn
10770 (setq parent (match-string 1 answ)
10771 child (match-string 2 answ))
10772 (setq parent-target (or (assoc parent tbl)
10773 (assoc (concat parent "/") tbl)))
10774 (when (and parent-target
10775 (or (eq new-nodes t)
10776 (and (eq new-nodes 'confirm)
10778 child)))))
10779 (org-refile-new-child parent-target child)))
10780 (error "Invalid target location")))))
10782 (defun org-refile-check-position (refile-pointer)
10783 "Check if the refile pointer matches the readline to which it points."
10784 (let* ((file (nth 1 refile-pointer))
10785 (re (nth 2 refile-pointer))
10786 (pos (nth 3 refile-pointer))
10787 buffer)
10788 (when (org-string-nw-p re)
10789 (setq buffer (if (markerp pos)
10790 (marker-buffer pos)
10791 (or (find-buffer-visiting file)
10792 (find-file-noselect file))))
10793 (with-current-buffer buffer
10794 (save-excursion
10795 (save-restriction
10796 (widen)
10797 (goto-char pos)
10798 (beginning-of-line 1)
10799 (unless (org-looking-at-p re)
10800 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling"))))))))
10802 (defun org-refile-new-child (parent-target child)
10803 "Use refile target PARENT-TARGET to add new CHILD below it."
10804 (unless parent-target
10805 (error "Cannot find parent for new node"))
10806 (let ((file (nth 1 parent-target))
10807 (pos (nth 3 parent-target))
10808 level)
10809 (with-current-buffer (or (find-buffer-visiting file)
10810 (find-file-noselect file))
10811 (save-excursion
10812 (save-restriction
10813 (widen)
10814 (if pos
10815 (goto-char pos)
10816 (goto-char (point-max))
10817 (if (not (bolp)) (newline)))
10818 (when (looking-at org-outline-regexp)
10819 (setq level (funcall outline-level))
10820 (org-end-of-subtree t t))
10821 (org-back-over-empty-lines)
10823 (if pos (org-get-valid-level level 1) 1) ?*)
10825 (beginning-of-line 0)
10826 (list (concat (car parent-target) "/" child) file "" (point)))))))
10828 (defun org-olpath-completing-read (prompt collection &rest args)
10829 "Read an outline path like a file name."
10830 (let ((thetable collection)
10831 (org-completion-use-ido nil) ; does not work with ido.
10832 (org-completion-use-iswitchb nil)) ; or iswitchb
10833 (apply
10834 'org-icompleting-read prompt
10835 (lambda (string predicate &optional flag)
10836 (let (rtn r f (l (length string)))
10837 (cond
10838 ((eq flag nil)
10839 ;; try completion
10840 (try-completion string thetable))
10841 ((eq flag t)
10842 ;; all-completions
10843 (setq rtn (all-completions string thetable predicate))
10844 (mapcar
10845 (lambda (x)
10846 (setq r (substring x l))
10847 (if (string-match " ([^)]*)$" x)
10848 (setq f (match-string 0 x))
10849 (setq f ""))
10850 (if (string-match "/" r)
10851 (concat string (substring r 0 (match-end 0)) f)
10852 x))
10853 rtn))
10854 ((eq flag 'lambda)
10855 ;; exact match?
10856 (assoc string thetable)))
10857 ))
10858 args)))
10860 ;;;; Dynamic blocks
10862 (defun org-find-dblock (name)
10863 "Find the first dynamic block with name NAME in the buffer.
10864 If not found, stay at current position and return nil."
10865 (let (pos)
10866 (save-excursion
10867 (goto-char (point-min))
10869 nil t)
10870 (match-beginning 0))))
10871 (if pos (goto-char pos))
10872 pos))
10874 (defconst org-dblock-start-re
10876 "Matches the start line of a dynamic block, with parameters.")
10879 "Matches the end of a dynamic block.")
10881 (defun org-create-dblock (plist)
10882 "Create a dynamic block section, with parameters taken from PLIST.
10883 PLIST must contain a :name entry which is used as name of the block."
10885 (end-of-line 1)
10886 (newline))
10887 (let ((col (current-column))
10888 (name (plist-get plist :name)))
10889 (insert "#+BEGIN: " name)
10890 (while plist
10891 (if (eq (car plist) :name)
10892 (setq plist (cddr plist))
10893 (insert " " (prin1-to-string (pop plist)))))
10895 (beginning-of-line -2)))
10897 (defun org-prepare-dblock ()
10898 "Prepare dynamic block for refresh.
10899 This empties the block, puts the cursor at the insert position and returns
10900 the property list including an extra property :name with the block name."
10901 (unless (looking-at org-dblock-start-re)
10902 (error "Not at a dynamic block"))
10903 (let* ((begdel (1+ (match-end 0)))
10904 (name (org-no-properties (match-string 1)))
10905 (params (append (list :name name)
10906 (read (concat "(" (match-string 3) ")")))))
10907 (save-excursion
10908 (beginning-of-line 1)
10910 (setq params (plist-put params :indentation-column (current-column))))
10911 (unless (re-search-forward org-dblock-end-re nil t)
10912 (error "Dynamic block not terminated"))
10913 (setq params
10914 (append params
10915 (list :content (buffer-substring
10916 begdel (match-beginning 0)))))
10917 (delete-region begdel (match-beginning 0))
10918 (goto-char begdel)
10919 (open-line 1)
10920 params))
10922 (defun org-map-dblocks (&optional command)
10923 "Apply COMMAND to all dynamic blocks in the current buffer.
10924 If COMMAND is not given, use `org-update-dblock'."
10925 (let ((cmd (or command 'org-update-dblock)))
10926 (save-excursion
10927 (goto-char (point-min))
10928 (while (re-search-forward org-dblock-start-re nil t)
10929 (goto-char (match-beginning 0))
10930 (save-excursion
10931 (condition-case nil
10932 (funcall cmd)
10933 (error (message "Error during update of dynamic block"))))
10934 (unless (re-search-forward org-dblock-end-re nil t)
10935 (error "Dynamic block not terminated"))))))
10937 (defun org-dblock-update (&optional arg)
10938 "User command for updating dynamic blocks.
10939 Update the dynamic block at point. With prefix ARG, update all dynamic
10940 blocks in the buffer."
10941 (interactive "P")
10942 (if arg
10943 (org-update-all-dblocks)
10944 (or (looking-at org-dblock-start-re)
10945 (org-beginning-of-dblock))
10946 (org-update-dblock)))
10948 (defun org-update-dblock ()
10949 "Update the dynamic block at point.
10950 This means to empty the block, parse for parameters and then call
10951 the correct writing function."
10952 (interactive)
10953 (save-window-excursion
10954 (let* ((pos (point))
10955 (line (org-current-line))
10956 (params (org-prepare-dblock))
10957 (name (plist-get params :name))
10958 (indent (plist-get params :indentation-column))
10959 (cmd (intern (concat "org-dblock-write:" name))))
10960 (message "Updating dynamic block `%s' at line %d..." name line)
10961 (funcall cmd params)
10962 (message "Updating dynamic block `%s' at line %d...done" name line)
10963 (goto-char pos)
10964 (when (and indent (> indent 0))
10965 (setq indent (make-string indent ?\ ))
10966 (save-excursion
10967 (org-beginning-of-dblock)
10968 (forward-line 1)
10969 (while (not (looking-at org-dblock-end-re))
10970 (insert indent)
10971 (beginning-of-line 2))
10972 (when (looking-at org-dblock-end-re)
10974 (replace-match ""))
10975 (insert indent)))))))
10977 (defun org-beginning-of-dblock ()
10978 "Find the beginning of the dynamic block at point.
10979 Error if there is no such block at point."
10980 (let ((pos (point))
10981 beg)
10982 (end-of-line 1)
10983 (if (and (re-search-backward org-dblock-start-re nil t)
10984 (setq beg (match-beginning 0))
10985 (re-search-forward org-dblock-end-re nil t)
10986 (> (match-end 0) pos))
10987 (goto-char beg)
10988 (goto-char pos)
10989 (error "Not in a dynamic block"))))
10991 (defun org-update-all-dblocks ()
10992 "Update all dynamic blocks in the buffer.
10993 This function can be used in a hook."
10994 (interactive)
10995 (when (eq major-mode 'org-mode)
10996 (org-map-dblocks 'org-update-dblock)))
10999 ;;;; Completion
11001 (defconst org-additional-option-like-keywords
11002 '("BEGIN_HTML" "END_HTML" "HTML:" "ATTR_HTML:"
11003 "BEGIN_DocBook" "END_DocBook" "DocBook:" "ATTR_DocBook:"
11004 "BEGIN_LaTeX" "END_LaTeX" "LaTeX:" "LATEX_HEADER:"
11005 "LATEX_CLASS:" "LATEX_CLASS_OPTIONS:" "ATTR_LaTeX:"
11006 "BEGIN:" "END:"
11007 "ORGTBL" "TBLFM:" "TBLNAME:"
11008 "BEGIN_EXAMPLE" "END_EXAMPLE"
11009 "BEGIN_QUOTE" "END_QUOTE"
11010 "BEGIN_VERSE" "END_VERSE"
11011 "BEGIN_CENTER" "END_CENTER"
11012 "BEGIN_SRC" "END_SRC"
11013 "BEGIN_RESULT" "END_RESULT"
11014 "NAME:" "RESULTS:"
11015 "HEADER:" "HEADERS:"
11016 "CATEGORY:" "COLUMNS:" "PROPERTY:"
11017 "CAPTION:" "LABEL:"
11018 "SETUPFILE:"
11019 "INCLUDE:"
11020 "BIND:"
11021 "MACRO:"))
11023 (defcustom org-structure-template-alist
11024 '(
11037 ("L" "#+latex: "
11041 ("H" "#+html: "
11044 ("A" "#+ascii: ")
11045 ("i" "#+index: ?"
11046 "#+index: ?")
11047 ("I" "#+include %file ?"
11049 )
11050 "Structure completion elements.
11051 This is a list of abbreviation keys and values. The value gets inserted
11052 if you type `<' followed by the key and then press the completion key,
11053 usually `M-TAB'. %file will be replaced by a file name after prompting
11054 for the file using completion. The cursor will be placed at the position
11055 of the `?` in the template.
11056 There are two templates for each key, the first uses the original Org syntax,
11057 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11058 the default when the /org-mtags.el/ module has been loaded. See also the
11059 variable `org-mtags-prefer-muse-templates'.
11060 This is an experimental feature, it is undecided if it is going to stay in."
11061 :group 'org-completion
11062 :type '(repeat
11063 (string :tag "Key")
11064 (string :tag "Template")
11065 (string :tag "Muse Template")))
11067 (defun org-try-structure-completion ()
11068 "Try to complete a structure template before point.
11070 expands them."
11071 (let ((l (buffer-substring (point-at-bol) (point)))
11072 a)
11075 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11076 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11077 (match-beginning 1)) a)
11078 t)))
11080 (defun org-complete-expand-structure-template (start cell)
11081 "Expand a structure template."
11082 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11083 (rpl (nth (if musep 2 1) cell))
11084 (ind ""))
11085 (delete-region start (point))
11087 (cond
11088 ((bolp))
11090 (setq ind (buffer-substring (point-at-bol) (point))))
11091 (t (newline))))
11092 (setq start (point))
11093 (if (string-match "%file" rpl)
11094 (setq rpl (replace-match
11095 (concat
11097 (save-match-data
11098 (abbreviate-file-name (read-file-name "Include file: ")))
11100 t t rpl)))
11103 (insert rpl)
11106 ;;;; TODO, DEADLINE, Comments
11108 (defun org-toggle-comment ()
11109 "Change the COMMENT state of an entry."
11110 (interactive)
11111 (save-excursion
11112 (org-back-to-heading)
11113 (let (case-fold-search)
11114 (cond
11115 ((looking-at (format org-heading-keyword-regexp-format
11116 org-comment-string))
11117 (goto-char (match-end 1))
11118 (looking-at (concat " +" org-comment-string))
11119 (replace-match "" t t)
11120 (when (eolp) (insert " ")))
11121 ((looking-at org-outline-regexp)
11122 (goto-char (match-end 0))
11123 (insert org-comment-string " "))))))
11125 (defvar org-last-todo-state-is-todo nil
11126 "This is non-nil when the last TODO state change led to a TODO state.
11127 If the last change removed the TODO tag or switched to DONE, then
11128 this is nil.")
11130 (defvar org-setting-tags nil) ; dynamically skipped
11132 (defvar org-todo-setup-filter-hook nil
11133 "Hook for functions that pre-filter todo specs.
11134 Each function takes a todo spec and returns either nil or the spec
11135 transformed into canonical form." )
11137 (defvar org-todo-get-default-hook nil
11138 "Hook for functions that get a default item for todo.
11139 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
11140 nil or a string to be used for the todo mark." )
11142 (defvar org-agenda-headline-snapshot-before-repeat)
11144 (defun org-current-effective-time ()
11145 "Return current time adjusted for `org-extend-today-until' variable"
11146 (let* ((ct (org-current-time))
11147 (dct (decode-time ct))
11148 (ct1
11149 (if (and org-use-effective-time
11150 (< (nth 2 dct) org-extend-today-until))
11151 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct))
11152 ct)))
11153 ct1))
11155 (defun org-todo-yesterday (&optional arg)
11156 "Like `org-todo' but the time of change will be 23:59 of yesterday."
11157 (interactive "P")
11158 (if (eq major-mode 'org-agenda-mode)
11159 (apply 'org-agenda-todo-yesterday arg)
11160 (let* ((hour (third (decode-time
11161 (org-current-time))))
11162 (org-extend-today-until (1+ hour)))
11163 (org-todo arg))))
11165 (defun org-todo (&optional arg)
11166 "Change the TODO state of an item.
11167 The state of an item is given by a keyword at the start of the heading,
11168 like
11169 *** TODO Write paper
11170 *** DONE Call mom
11172 The different keywords are specified in the variable `org-todo-keywords'.
11174 So for this example: when the item starts with TODO, it is changed to DONE.
11175 When it starts with DONE, the DONE is removed. And when neither TODO nor
11176 DONE are present, add TODO at the beginning of the heading.
11179 state.
11180 With numeric prefix arg, switch to that state.
11182 keywords (nextset).
11184 With a numeric prefix arg of 0, inhibit note taking for the change.
11186 For calling through lisp, arg is also interpreted in the following way:
11187 'none -> empty state
11189 'done -> switch to DONE
11190 'nextset -> switch to the next set of keywords
11191 'previousset -> switch to the previous set of keywords
11193 really is a member of `org-todo-keywords'."
11194 (interactive "P")
11195 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11196 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11197 'region-start-level 'region))
11198 org-loop-over-headlines-in-active-region)
11199 (org-map-entries
11200 `(org-todo ,arg)
11201 org-loop-over-headlines-in-active-region
11202 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11203 (if (equal arg '(16)) (setq arg 'nextset))
11204 (let ((org-blocker-hook org-blocker-hook)
11205 (case-fold-search nil))
11206 (when (equal arg '(64))
11207 (setq arg nil org-blocker-hook nil))
11208 (when (and org-blocker-hook
11209 (or org-inhibit-blocking
11210 (org-entry-get nil "NOBLOCKING")))
11211 (setq org-blocker-hook nil))
11212 (save-excursion
11213 (catch 'exit
11214 (org-back-to-heading t)
11215 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
11218 (let* ((match-data (match-data))
11219 (startpos (point-at-bol))
11220 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
11221 (org-log-done org-log-done)
11222 (org-log-repeat org-log-repeat)
11223 (org-todo-log-states org-todo-log-states)
11224 (org-inhibit-logging
11225 (if (equal arg 0)
11226 (progn (setq arg nil) 'note) org-inhibit-logging))
11227 (this (match-string 1))
11228 (hl-pos (match-beginning 0))
11229 (head (org-get-todo-sequence-head this))
11230 (ass (assoc head org-todo-kwd-alist))
11231 (interpret (nth 1 ass))
11232 (done-word (nth 3 ass))
11233 (final-done-word (nth 4 ass))
11234 (last-state (or this ""))
11235 (completion-ignore-case t)
11236 (member (member this org-todo-keywords-1))
11237 (tail (cdr member))
11238 (state (cond
11239 ((and org-todo-key-trigger
11240 (or (and (equal arg '(4))
11241 (eq org-use-fast-todo-selection 'prefix))
11242 (and (not arg) org-use-fast-todo-selection
11243 (not (eq org-use-fast-todo-selection
11244 'prefix)))))
11245 ;; Use fast selection
11246 (org-fast-todo-selection))
11247 ((and (equal arg '(4))
11248 (or (not org-use-fast-todo-selection)
11249 (not org-todo-key-trigger)))
11250 ;; Read a state with completion
11251 (org-icompleting-read
11252 "State: " (mapcar (lambda(x) (list x))
11253 org-todo-keywords-1)
11254 nil t))
11255 ((eq arg 'right)
11256 (if this
11257 (if tail (car tail) nil)
11258 (car org-todo-keywords-1)))
11259 ((eq arg 'left)
11260 (if (equal member org-todo-keywords-1)
11261 nil
11262 (if this
11263 (nth (- (length org-todo-keywords-1)
11264 (length tail) 2)
11265 org-todo-keywords-1)
11266 (org-last org-todo-keywords-1))))
11267 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
11268 (setq arg nil))) ; hack to fall back to cycling
11269 (arg
11270 ;; user or caller requests a specific state
11271 (cond
11272 ((equal arg "") nil)
11273 ((eq arg 'none) nil)
11274 ((eq arg 'done) (or done-word (car org-done-keywords)))
11275 ((eq arg 'nextset)
11276 (or (car (cdr (member head org-todo-heads)))
11277 (car org-todo-heads)))
11278 ((eq arg 'previousset)
11279 (let ((org-todo-heads (reverse org-todo-heads)))
11280 (or (car (cdr (member head org-todo-heads)))
11281 (car org-todo-heads))))
11282 ((car (member arg org-todo-keywords-1)))
11283 ((stringp arg)
11284 (error "State `%s' not valid in this file" arg))
11285 ((nth (1- (prefix-numeric-value arg))
11286 org-todo-keywords-1))))
11287 ((null member) (or head (car org-todo-keywords-1)))
11288 ((equal this final-done-word) nil) ;; -> make empty
11289 ((null tail) nil) ;; -> first entry
11290 ((memq interpret '(type priority))
11291 (if (eq this-command last-command)
11292 (car tail)
11293 (if (> (length tail) 0)
11294 (or done-word (car org-done-keywords))
11295 nil)))
11296 (t
11297 (car tail))))
11298 (state (or
11299 (run-hook-with-args-until-success
11300 'org-todo-get-default-hook state last-state)
11301 state))
11302 (next (if state (concat " " state " ") " "))
11303 (change-plist (list :type 'todo-state-change :from this :to state
11304 :position startpos))
11305 dolog now-done-p)
11306 (when org-blocker-hook
11307 (setq org-last-todo-state-is-todo
11308 (not (member this org-done-keywords)))
11309 (unless (save-excursion
11310 (save-match-data
11311 (org-with-wide-buffer
11312 (run-hook-with-args-until-failure
11313 'org-blocker-hook change-plist))))
11314 (if (org-called-interactively-p 'interactive)
11315 (error "TODO state change from %s to %s blocked" this state)
11316 ;; fail silently
11317 (message "TODO state change from %s to %s blocked" this state)
11318 (throw 'exit nil))))
11319 (store-match-data match-data)
11320 (replace-match next t t)
11321 (unless (pos-visible-in-window-p hl-pos)
11322 (message "TODO state changed to %s" (org-trim next)))
11323 (unless head
11324 (setq head (org-get-todo-sequence-head state)
11325 ass (assoc head org-todo-kwd-alist)
11326 interpret (nth 1 ass)
11327 done-word (nth 3 ass)
11328 final-done-word (nth 4 ass)))
11329 (when (memq arg '(nextset previousset))
11330 (message "Keyword-Set %d/%d: %s"
11331 (- (length org-todo-sets) -1
11332 (length (memq (assoc state org-todo-sets) org-todo-sets)))
11333 (length org-todo-sets)
11334 (mapconcat 'identity (assoc state org-todo-sets) " ")))
11335 (setq org-last-todo-state-is-todo
11336 (not (member state org-done-keywords)))
11337 (setq now-done-p (and (member state org-done-keywords)
11338 (not (member this org-done-keywords))))
11339 (and logging (org-local-logging logging))
11340 (when (and (or org-todo-log-states org-log-done)
11341 (not (eq org-inhibit-logging t))
11342 (not (memq arg '(nextset previousset))))
11343 ;; we need to look at recording a time and note
11344 (setq dolog (or (nth 1 (assoc state org-todo-log-states))
11345 (nth 2 (assoc this org-todo-log-states))))
11346 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
11347 (setq dolog 'time))
11348 (when (and state
11349 (member state org-not-done-keywords)
11350 (not (member this org-not-done-keywords)))
11351 ;; This is now a todo state and was not one before
11352 ;; If there was a CLOSED time stamp, get rid of it.
11353 (org-add-planning-info nil nil 'closed))
11354 (when (and now-done-p org-log-done)
11355 ;; It is now done, and it was not done before
11356 (org-add-planning-info 'closed (org-current-effective-time))
11357 (if (and (not dolog) (eq 'note org-log-done))
11358 (org-add-log-setup 'done state this 'findpos 'note)))
11359 (when (and state dolog)
11360 ;; This is a non-nil state, and we need to log it
11361 (org-add-log-setup 'state state this 'findpos dolog)))
11362 ;; Fixup tag positioning
11363 (org-todo-trigger-tag-changes state)
11364 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
11365 (when org-provide-todo-statistics
11366 (org-update-parent-todo-statistics))
11367 (run-hooks 'org-after-todo-state-change-hook)
11368 (if (and arg (not (member state org-done-keywords)))
11369 (setq head (org-get-todo-sequence-head state)))
11370 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
11371 ;; Do we need to trigger a repeat?
11372 (when now-done-p
11373 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
11374 ;; This is for the agenda, take a snapshot of the headline.
11375 (save-match-data
11376 (setq org-agenda-headline-snapshot-before-repeat
11377 (org-get-heading))))
11378 (org-auto-repeat-maybe state))
11379 ;; Fixup cursor location if close to the keyword
11380 (if (and (outline-on-heading-p)
11381 (not (bolp))
11382 (save-excursion (beginning-of-line 1)
11383 (looking-at org-todo-line-regexp))
11384 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
11385 (progn
11386 (goto-char (or (match-end 2) (match-end 1)))
11387 (and (looking-at " ") (just-one-space))))
11388 (when org-trigger-hook
11389 (save-excursion
11390 (run-hook-with-args 'org-trigger-hook change-plist)))))))))
11392 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
11393 "Block turning an entry into a TODO, using the hierarchy.
11394 This checks whether the current task should be blocked from state
11395 changes. Such blocking occurs when:
11397 1. The task has children which are not all in a completed state.
11399 2. A task has a parent with the property :ORDERED:, and there
11400 are siblings prior to the current task with incomplete
11401 status.
11403 3. The parent of the task is blocked because it has siblings that should
11404 be done first, or is child of a block grandparent TODO entry."
11406 (if (not org-enforce-todo-dependencies)
11407 t ; if locally turned off don't block
11408 (catch 'dont-block
11409 ;; If this is not a todo state change, or if this entry is already DONE,
11410 ;; do not block
11411 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11412 (member (plist-get change-plist :from)
11413 (cons 'done org-done-keywords))
11414 (member (plist-get change-plist :to)
11415 (cons 'todo org-not-done-keywords))
11416 (not (plist-get change-plist :to)))
11417 (throw 'dont-block t))
11418 ;; If this task has children, and any are undone, it's blocked
11419 (save-excursion
11420 (org-back-to-heading t)
11421 (let ((this-level (funcall outline-level)))
11422 (outline-next-heading)
11423 (let ((child-level (funcall outline-level)))
11424 (while (and (not (eobp))
11425 (> child-level this-level))
11426 ;; this todo has children, check whether they are all
11427 ;; completed
11428 (if (and (not (org-entry-is-done-p))
11429 (org-entry-is-todo-p))
11430 (throw 'dont-block nil))
11431 (outline-next-heading)
11432 (setq child-level (funcall outline-level))))))
11433 ;; Otherwise, if the task's parent has the :ORDERED: property, and
11434 ;; any previous siblings are undone, it's blocked
11435 (save-excursion
11436 (org-back-to-heading t)
11437 (let* ((pos (point))
11438 (parent-pos (and (org-up-heading-safe) (point))))
11439 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11440 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11441 (forward-line 1)
11442 (re-search-forward org-not-done-heading-regexp pos t))
11443 (throw 'dont-block nil)) ; block, there is an older sibling not done.
11444 ;; Search further up the hierarchy, to see if an anchestor is blocked
11445 (while t
11446 (goto-char parent-pos)
11447 (if (not (looking-at org-not-done-heading-regexp))
11448 (throw 'dont-block t)) ; do not block, parent is not a TODO
11449 (setq pos (point))
11450 (setq parent-pos (and (org-up-heading-safe) (point)))
11451 (if (not parent-pos) (throw 'dont-block t)) ; no parent
11452 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
11453 (forward-line 1)
11454 (re-search-forward org-not-done-heading-regexp pos t))
11455 (throw 'dont-block nil)))))))) ; block, older sibling not done.
11457 (defcustom org-track-ordered-property-with-tag nil
11458 "Should the ORDERED property also be shown as a tag?
11459 The ORDERED property decides if an entry should require subtasks to be
11460 completed in sequence. Since a property is not very visible, setting
11461 this option means that toggling the ORDERED property with the command
11462 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
11463 not relevant for the behavior, but it makes things more visible.
11465 Note that toggling the tag with tags commands will not change the property
11466 and therefore not influence behavior!
11468 This can be t, meaning the tag ORDERED should be used, It can also be a
11469 string to select a different tag for this task."
11470 :group 'org-todo
11471 :type '(choice
11472 (const :tag "No tracking" nil)
11473 (const :tag "Track with ORDERED tag" t)
11474 (string :tag "Use other tag")))
11476 (defun org-toggle-ordered-property ()
11477 "Toggle the ORDERED property of the current entry.
11478 For better visibility, you can track the value of this property with a tag.
11479 See variable `org-track-ordered-property-with-tag'."
11480 (interactive)
11481 (let* ((t1 org-track-ordered-property-with-tag)
11482 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
11483 (save-excursion
11484 (org-back-to-heading)
11485 (if (org-entry-get nil "ORDERED")
11486 (progn
11487 (org-delete-property "ORDERED")
11488 (and tag (org-toggle-tag tag 'off))
11489 (message "Subtasks can be completed in arbitrary order"))
11490 (org-entry-put nil "ORDERED" "t")
11491 (and tag (org-toggle-tag tag 'on))
11492 (message "Subtasks must be completed in sequence")))))
11494 (defvar org-blocked-by-checkboxes) ; dynamically scoped
11495 (defun org-block-todo-from-checkboxes (change-plist)
11496 "Block turning an entry into a TODO, using checkboxes.
11497 This checks whether the current task should be blocked from state
11498 changes because there are unchecked boxes in this entry."
11499 (if (not org-enforce-todo-checkbox-dependencies)
11500 t ; if locally turned off don't block
11501 (catch 'dont-block
11502 ;; If this is not a todo state change, or if this entry is already DONE,
11503 ;; do not block
11504 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
11505 (member (plist-get change-plist :from)
11506 (cons 'done org-done-keywords))
11507 (member (plist-get change-plist :to)
11508 (cons 'todo org-not-done-keywords))
11509 (not (plist-get change-plist :to)))
11510 (throw 'dont-block t))
11511 ;; If this task has checkboxes that are not checked, it's blocked
11512 (save-excursion
11513 (org-back-to-heading t)
11514 (let ((beg (point)) end)
11515 (outline-next-heading)
11516 (setq end (point))
11517 (goto-char beg)
11518 (if (org-list-search-forward
11519 (concat (org-item-beginning-re)
11522 end t)
11523 (progn
11524 (if (boundp 'org-blocked-by-checkboxes)
11525 (setq org-blocked-by-checkboxes t))
11526 (throw 'dont-block nil)))))
11527 t))) ; do not block
11529 (defun org-entry-blocked-p ()
11530 "Is the current entry blocked?"
11531 (if (org-entry-get nil "NOBLOCKING")
11532 nil ;; Never block this entry
11533 (not
11534 (run-hook-with-args-until-failure
11535 'org-blocker-hook
11536 (list :type 'todo-state-change
11537 :position (point)
11538 :from 'todo
11539 :to 'done)))))
11541 (defun org-update-statistics-cookies (all)
11542 "Update the statistics cookie, either from TODO or from checkboxes.
11543 This should be called with the cursor in a line with a statistics cookie."
11544 (interactive "P")
11545 (if all
11546 (progn
11547 (org-update-checkbox-count 'all)
11548 (org-map-entries 'org-update-parent-todo-statistics))
11549 (if (not (org-at-heading-p))
11550 (org-update-checkbox-count)
11551 (let ((pos (move-marker (make-marker) (point)))
11552 end l1 l2)
11553 (ignore-errors (org-back-to-heading t))
11554 (if (not (org-at-heading-p))
11555 (org-update-checkbox-count)
11556 (setq l1 (org-outline-level))
11557 (setq end (save-excursion
11558 (outline-next-heading)
11559 (if (org-at-heading-p) (setq l2 (org-outline-level)))
11560 (point)))
11561 (if (and (save-excursion
11562 (re-search-forward
11564 (not (save-excursion (re-search-forward
11566 (org-update-checkbox-count)
11567 (if (and l2 (> l2 l1))
11568 (progn
11569 (goto-char end)
11570 (org-update-parent-todo-statistics))
11571 (goto-char pos)
11572 (beginning-of-line 1)
11573 (while (re-search-forward
11575 (point-at-eol) t)
11576 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
11577 (goto-char pos)
11578 (move-marker pos nil)))))
11580 (defvar org-entry-property-inherited-from) ;; defined below
11581 (defun org-update-parent-todo-statistics ()
11582 "Update any statistics cookie in the parent of the current headline.
11583 When `org-hierarchical-todo-statistics' is nil, statistics will cover
11584 the entire subtree and this will travel up the hierarchy and update
11585 statistics everywhere."
11586 (let* ((prop (save-excursion (org-up-heading-safe)
11587 (org-entry-get nil "COOKIE_DATA" 'inherit)))
11588 (recursive (or (not org-hierarchical-todo-statistics)
11590 (lim (or (and prop (marker-position org-entry-property-inherited-from))
11591 0))
11592 (first t)
11594 level ltoggle l1 new ndel
11595 (cnt-all 0) (cnt-done 0) is-percent kwd
11596 checkbox-beg ov ovs ove cookie-present)
11597 (catch 'exit
11598 (save-excursion
11599 (beginning-of-line 1)
11600 (setq ltoggle (funcall outline-level))
11601 ;; Three situations are to consider:
11603 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
11604 ;; to the top-level ancestor on the headline;
11606 ;; 2. If parent has "recursive" property, repeat up to the
11607 ;; headline setting that property, taking inheritance into
11608 ;; account;
11610 ;; 3. Else, move up to direct parent and proceed only once.
11611 (while (and (setq level (org-up-heading-safe))
11612 (or recursive first)
11613 (>= (point) lim))
11614 (setq first nil cookie-present nil)
11615 (unless (and level
11616 (not (string-match
11618 (downcase (or (org-entry-get nil "COOKIE_DATA")
11619 "")))))
11620 (throw 'exit nil))
11621 (while (re-search-forward box-re (point-at-eol) t)
11622 (setq cnt-all 0 cnt-done 0 cookie-present t)
11623 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
11624 (save-match-data
11625 (unless (outline-next-heading) (throw 'exit nil))
11626 (while (and (looking-at org-complex-heading-regexp)
11627 (> (setq l1 (length (match-string 1))) level))
11628 (setq kwd (and (or recursive (= l1 ltoggle))
11629 (match-string 2)))
11630 (if (or (eq org-provide-todo-statistics 'all-headlines)
11631 (and (listp org-provide-todo-statistics)
11632 (or (member kwd org-provide-todo-statistics)
11633 (member kwd org-done-keywords))))
11634 (setq cnt-all (1+ cnt-all))
11635 (if (eq org-provide-todo-statistics t)
11636 (and kwd (setq cnt-all (1+ cnt-all)))))
11637 (and (member kwd org-done-keywords)
11638 (setq cnt-done (1+ cnt-done)))
11639 (outline-next-heading)))
11640 (setq new
11641 (if is-percent
11642 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
11643 (format "[%d/%d]" cnt-done cnt-all))
11644 ndel (- (match-end 0) checkbox-beg))
11645 ;; handle overlays when updating cookie from column view
11646 (when (setq ov (car (overlays-at checkbox-beg)))
11647 (setq ovs (overlay-start ov) ove (overlay-end ov))
11648 (delete-overlay ov))
11649 (goto-char checkbox-beg)
11650 (insert new)
11651 (delete-region (point) (+ (point) ndel))
11652 (when org-auto-align-tags (org-fix-tags-on-the-fly))
11653 (when ov (move-overlay ov ovs ove)))
11654 (when cookie-present
11655 (run-hook-with-args 'org-after-todo-statistics-hook
11656 cnt-done (- cnt-all cnt-done))))))
11657 (run-hooks 'org-todo-statistics-hook)))
11659 (defvar org-after-todo-statistics-hook nil
11660 "Hook that is called after a TODO statistics cookie has been updated.
11661 Each function is called with two arguments: the number of not-done entries
11662 and the number of done entries.
11664 For example, the following function, when added to this hook, will switch
11665 an entry to DONE when all children are done, and back to TODO when new
11666 entries are set to a TODO status. Note that this hook is only called
11667 when there is a statistics cookie in the headline!
11669 (defun org-summary-todo (n-done n-not-done)
11671 (let (org-log-done org-log-states) ; turn off logging
11673 ")
11675 (defvar org-todo-statistics-hook nil
11676 "Hook that is run whenever Org thinks TODO statistics should be updated.
11677 This hook runs even if there is no statistics cookie present, in which case
11678 `org-after-todo-statistics-hook' would not run.")
11680 (defun org-todo-trigger-tag-changes (state)
11681 "Apply the changes defined in `org-todo-state-tags-triggers'."
11682 (let ((l org-todo-state-tags-triggers)
11683 changes)
11684 (when (or (not state) (equal state ""))
11685 (setq changes (append changes (cdr (assoc "" l)))))
11686 (when (and (stringp state) (> (length state) 0))
11687 (setq changes (append changes (cdr (assoc state l)))))
11688 (when (member state org-not-done-keywords)
11689 (setq changes (append changes (cdr (assoc 'todo l)))))
11690 (when (member state org-done-keywords)
11691 (setq changes (append changes (cdr (assoc 'done l)))))
11692 (dolist (c changes)
11693 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
11695 (defun org-local-logging (value)
11696 "Get logging settings from a property VALUE."
11697 (let* (words w a)
11698 ;; directly set the variables, they are already local.
11699 (setq org-log-done nil
11700 org-log-repeat nil
11701 org-todo-log-states nil)
11702 (setq words (org-split-string value))
11703 (while (setq w (pop words))
11704 (cond
11705 ((setq a (assoc w org-startup-options))
11706 (and (member (nth 1 a) '(org-log-done org-log-repeat))
11707 (set (nth 1 a) (nth 2 a))))
11708 ((setq a (org-extract-log-state-settings w))
11709 (and (member (car a) org-todo-keywords-1)
11710 (push a org-todo-log-states)))))))
11712 (defun org-get-todo-sequence-head (kwd)
11713 "Return the head of the TODO sequence to which KWD belongs.
11714 If KWD is not set, check if there is a text property remembering the
11715 right sequence."
11716 (let (p)
11717 (cond
11718 ((not kwd)
11719 (or (get-text-property (point-at-bol) 'org-todo-head)
11720 (progn
11721 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
11722 nil (point-at-eol)))
11723 (get-text-property p 'org-todo-head))))
11724 ((not (member kwd org-todo-keywords-1))
11725 (car org-todo-keywords-1))
11726 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
11728 (defun org-fast-todo-selection ()
11729 "Fast TODO keyword selection with single keys.
11730 Returns the new TODO keyword, or nil if no state change should occur."
11731 (let* ((fulltable org-todo-key-alist)
11732 (done-keywords org-done-keywords) ;; needed for the faces.
11733 (maxlen (apply 'max (mapcar
11734 (lambda (x)
11735 (if (stringp (car x)) (string-width (car x)) 0))
11736 fulltable)))
11737 (expert nil)
11738 (fwidth (+ maxlen 3 1 3))
11739 (ncol (/ (- (window-width) 4) fwidth))
11740 tg cnt e c tbl
11741 groups ingroup)
11742 (save-excursion
11743 (save-window-excursion
11744 (if expert
11745 (set-buffer (get-buffer-create " *Org todo*"))
11746 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
11747 (erase-buffer)
11748 (org-set-local 'org-done-keywords done-keywords)
11749 (setq tbl fulltable cnt 0)
11750 (while (setq e (pop tbl))
11751 (cond
11752 ((equal e '(:startgroup))
11753 (push '() groups) (setq ingroup t)
11754 (when (not (= cnt 0))
11755 (setq cnt 0)
11757 (insert "{ "))
11758 ((equal e '(:endgroup))
11759 (setq ingroup nil cnt 0)
11761 ((equal e '(:newline))
11762 (when (not (= cnt 0))
11763 (setq cnt 0)
11765 (setq e (car tbl))
11766 (while (equal (car tbl) '(:newline))
11768 (setq tbl (cdr tbl)))))
11769 (t
11770 (setq tg (car e) c (cdr e))
11771 (if ingroup (push tg (car groups)))
11772 (setq tg (org-add-props tg nil 'face
11773 (org-get-todo-face tg)))
11774 (if (and (= cnt 0) (not ingroup)) (insert " "))
11775 (insert "[" c "] " tg (make-string
11776 (- fwidth 4 (length tg)) ?\ ))
11777 (when (= (setq cnt (1+ cnt)) ncol)
11779 (if ingroup (insert " "))
11780 (setq cnt 0)))))
11782 (goto-char (point-min))
11783 (if (not expert) (org-fit-window-to-buffer))
11784 (message "[a-z..]:Set [SPC]:clear")
11785 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
11786 (cond
11787 ((or (= c ?\C-g)
11788 (and (= c ?q) (not (rassoc c fulltable))))
11789 (setq quit-flag t))
11790 ((= c ?\ ) nil)
11791 ((setq e (rassoc c fulltable) tg (car e))
11792 tg)
11793 (t (setq quit-flag t)))))))
11795 (defun org-entry-is-todo-p ()
11796 (member (org-get-todo-state) org-not-done-keywords))
11798 (defun org-entry-is-done-p ()
11799 (member (org-get-todo-state) org-done-keywords))
11801 (defun org-get-todo-state ()
11802 (save-excursion
11803 (org-back-to-heading t)
11804 (and (looking-at org-todo-line-regexp)
11805 (match-end 2)
11806 (match-string 2))))
11808 (defun org-at-date-range-p (&optional inactive-ok)
11809 "Is the cursor inside a date range?"
11810 (interactive)
11811 (save-excursion
11812 (catch 'exit
11813 (let ((pos (point)))
11815 (skip-chars-backward "<[")
11816 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11817 (>= (match-end 0) pos)
11818 (throw 'exit t))
11820 (skip-chars-backward "<[")
11821 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
11822 (>= (match-end 0) pos)
11823 (throw 'exit t)))
11824 nil)))
11826 (defun org-get-repeat (&optional tagline)
11827 "Check if there is a deadline/schedule with repeater in this entry."
11828 (save-match-data
11829 (save-excursion
11830 (org-back-to-heading t)
11831 (and (re-search-forward (if tagline
11833 org-repeat-re)
11834 (org-entry-end-position) t)
11835 (match-string-no-properties 1)))))
11837 (defvar org-last-changed-timestamp)
11838 (defvar org-last-inserted-timestamp)
11839 (defvar org-log-post-message)
11840 (defvar org-log-note-purpose)
11841 (defvar org-log-note-how)
11842 (defvar org-log-note-extra)
11843 (defun org-auto-repeat-maybe (done-word)
11844 "Check if the current headline contains a repeated deadline/schedule.
11845 If yes, set TODO state back to what it was and change the base date
11846 of repeating deadline/scheduled time stamps to new date.
11847 This function is run automatically after each state change to a DONE state."
11848 ;; last-state is dynamically scoped into this function
11849 (let* ((repeat (org-get-repeat))
11850 (aa (assoc last-state org-todo-kwd-alist))
11851 (interpret (nth 1 aa))
11852 (head (nth 2 aa))
11853 (whata '(("d" . day) ("m" . month) ("y" . year)))
11854 (msg "Entry repeats: ")
11855 (org-log-done nil)
11856 (org-todo-log-states nil)
11857 re type n what ts time to-state)
11858 (when repeat
11859 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
11860 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
11861 org-todo-repeat-to-state))
11862 (unless (and to-state (member to-state org-todo-keywords-1))
11863 (setq to-state (if (eq interpret 'type) last-state head)))
11864 (org-todo to-state)
11865 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
11866 (org-entry-put nil "LAST_REPEAT" (format-time-string
11867 (org-time-stamp-format t t))))
11868 (when org-log-repeat
11869 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
11870 (memq 'org-add-log-note post-command-hook))
11871 ;; OK, we are already setup for some record
11872 (if (eq org-log-repeat 'note)
11873 ;; make sure we take a note, not only a time stamp
11874 (setq org-log-note-how 'note))
11875 ;; Set up for taking a record
11876 (org-add-log-setup 'state (or done-word (car org-done-keywords))
11877 last-state
11878 'findpos org-log-repeat)))
11879 (org-back-to-heading t)
11880 (org-add-planning-info nil nil 'closed)
11884 (while (re-search-forward
11885 re (save-excursion (outline-next-heading) (point)) t)
11886 (setq type (if (match-end 1) org-scheduled-string
11887 (if (match-end 3) org-deadline-string "Plain:"))
11888 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
11890 (setq n (string-to-number (match-string 2 ts))
11891 what (match-string 3 ts))
11892 (if (equal what "w") (setq n (* n 7) what "d"))
11893 ;; Preparation, see if we need to modify the start date for the change
11894 (when (match-end 1)
11895 (setq time (save-match-data (org-time-string-to-time ts)))
11896 (cond
11897 ((equal (match-string 1 ts) ".")
11898 ;; Shift starting date to today
11899 (org-timestamp-change
11900 (- (org-today) (time-to-days time))
11901 'day))
11902 ((equal (match-string 1 ts) "+")
11903 (let ((nshiftmax 10) (nshift 0))
11904 (while (or (= nshift 0)
11905 (<= (time-to-days time)
11906 (time-to-days (current-time))))
11907 (when (= (incf nshift) nshiftmax)
11908 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
11909 (error "Abort")))
11910 (org-timestamp-change n (cdr (assoc what whata)))
11911 (org-at-timestamp-p t)
11912 (setq ts (match-string 1))
11913 (setq time (save-match-data (org-time-string-to-time ts)))))
11914 (org-timestamp-change (- n) (cdr (assoc what whata)))
11915 ;; rematch, so that we have everything in place for the real shift
11916 (org-at-timestamp-p t)
11917 (setq ts (match-string 1))
11919 (org-timestamp-change n (cdr (assoc what whata)))
11920 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
11921 (setq org-log-post-message msg)
11922 (message "%s" msg))))
11924 (defun org-show-todo-tree (arg)
11925 "Make a compact tree which shows all headlines marked with TODO.
11926 The tree will show the lines where the regexp matches, and all higher
11927 headlines above the match.
11929 With a numeric prefix N, construct a sparse tree for the Nth element
11930 of `org-todo-keywords-1'."
11931 (interactive "P")
11932 (let ((case-fold-search nil)
11933 (kwd-re
11934 (cond ((null arg) org-not-done-regexp)
11935 ((equal arg '(4))
11936 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
11937 (mapcar 'list org-todo-keywords-1))))
11941 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
11942 (regexp-quote (nth (1- (prefix-numeric-value arg))
11943 org-todo-keywords-1)))
11944 (t (error "Invalid prefix argument: %s" arg)))))
11945 (message "%d TODO entries found"
11946 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
11948 (defun org-deadline (&optional remove time)
11950 With argument REMOVE, remove any deadline from the item.
11951 With argument TIME, set the deadline at the corresponding date. TIME
11953 (interactive "P")
11954 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
11955 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
11956 'region-start-level 'region))
11957 org-loop-over-headlines-in-active-region)
11958 (org-map-entries
11959 `(org-deadline ',remove ,time)
11960 org-loop-over-headlines-in-active-region
11961 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
11962 (let* ((old-date (org-entry-get nil "DEADLINE"))
11963 (repeater (and old-date
11964 (string-match
11966 old-date)
11967 (match-string 1 old-date))))
11968 (if remove
11969 (progn
11970 (when (and old-date org-log-redeadline)
11971 (org-add-log-setup 'deldeadline nil old-date 'findpos
11972 org-log-redeadline))
11973 (org-remove-timestamp-with-keyword org-deadline-string)
11974 (message "Item no longer has a deadline."))
11975 (org-add-planning-info 'deadline time 'closed)
11976 (when (and old-date org-log-redeadline
11977 (not (equal old-date
11978 (substring org-last-inserted-timestamp 1 -1))))
11979 (org-add-log-setup 'redeadline nil old-date 'findpos
11980 org-log-redeadline))
11981 (when repeater
11982 (save-excursion
11983 (org-back-to-heading t)
11984 (when (re-search-forward (concat org-deadline-string " "
11985 org-last-inserted-timestamp)
11986 (save-excursion
11987 (outline-next-heading) (point)) t)
11988 (goto-char (1- (match-end 0)))
11989 (insert " " repeater)
11990 (setq org-last-inserted-timestamp
11991 (concat (substring org-last-inserted-timestamp 0 -1)
11992 " " repeater
11993 (substring org-last-inserted-timestamp -1))))))
11994 (message "Deadline on %s" org-last-inserted-timestamp)))))
11996 (defun org-schedule (&optional remove time)
11997 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
11998 With argument REMOVE, remove any scheduling date from the item.
11999 With argument TIME, scheduled at the corresponding date. TIME can
12001 (interactive "P")
12002 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12003 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12004 'region-start-level 'region))
12005 org-loop-over-headlines-in-active-region)
12006 (org-map-entries
12007 `(org-schedule ',remove ,time)
12008 org-loop-over-headlines-in-active-region
12009 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12010 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12011 (repeater (and old-date
12012 (string-match
12014 old-date)
12015 (match-string 1 old-date))))
12016 (if remove
12017 (progn
12018 (when (and old-date org-log-reschedule)
12019 (org-add-log-setup 'delschedule nil old-date 'findpos
12020 org-log-reschedule))
12021 (org-remove-timestamp-with-keyword org-scheduled-string)
12022 (message "Item is no longer scheduled."))
12023 (org-add-planning-info 'scheduled time 'closed)
12024 (when (and old-date org-log-reschedule
12025 (not (equal old-date
12026 (substring org-last-inserted-timestamp 1 -1))))
12027 (org-add-log-setup 'reschedule nil old-date 'findpos
12028 org-log-reschedule))
12029 (when repeater
12030 (save-excursion
12031 (org-back-to-heading t)
12032 (when (re-search-forward (concat org-scheduled-string " "
12033 org-last-inserted-timestamp)
12034 (save-excursion
12035 (outline-next-heading) (point)) t)
12036 (goto-char (1- (match-end 0)))
12037 (insert " " repeater)
12038 (setq org-last-inserted-timestamp
12039 (concat (substring org-last-inserted-timestamp 0 -1)
12040 " " repeater
12041 (substring org-last-inserted-timestamp -1))))))
12042 (message "Scheduled to %s" org-last-inserted-timestamp)))))
12044 (defun org-get-scheduled-time (pom &optional inherit)
12045 "Get the scheduled time as a time tuple, of a format suitable
12046 for calling org-schedule with, or if there is no scheduling,
12047 returns nil."
12048 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12049 (when time
12050 (apply 'encode-time (org-parse-time-string time)))))
12052 (defun org-get-deadline-time (pom &optional inherit)
12053 "Get the deadline as a time tuple, of a format suitable for
12054 calling org-deadline with, or if there is no scheduling, returns
12055 nil."
12056 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12057 (when time
12058 (apply 'encode-time (org-parse-time-string time)))))
12060 (defun org-remove-timestamp-with-keyword (keyword)
12061 "Remove all time stamps with KEYWORD in the current entry."
12063 beg)
12064 (save-excursion
12065 (org-back-to-heading t)
12066 (setq beg (point))
12067 (outline-next-heading)
12068 (while (re-search-backward re beg t)
12069 (replace-match "")
12071 (equal (char-before) ?\ ))
12072 (backward-delete-char 1)
12074 (point-at-bol) (point-at-eol)))
12075 (delete-region (point-at-bol)
12076 (min (point-max) (1+ (point-at-eol))))))))))
12078 (defun org-add-planning-info (what &optional time &rest remove)
12079 "Insert new timestamp with keyword in the line directly after the headline.
12080 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
12081 If non is given, the user is prompted for a date.
12082 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
12083 be removed."
12084 (interactive)
12085 (let (org-time-was-given org-end-time-was-given ts
12086 end default-time default-input)
12088 (catch 'exit
12089 (when (and (memq what '(scheduled deadline))
12090 (or (not time)
12091 (and (stringp time)
12092 (string-match "^[-+]+[0-9]" time))))
12093 ;; Try to get a default date/time from existing timestamp
12094 (save-excursion
12095 (org-back-to-heading t)
12096 (setq end (save-excursion (outline-next-heading) (point)))
12097 (when (re-search-forward (if (eq what 'scheduled)
12098 org-scheduled-time-regexp
12099 org-deadline-time-regexp)
12100 end t)
12101 (setq ts (match-string 1)
12102 default-time
12103 (apply 'encode-time (org-parse-time-string ts))
12104 default-input (and ts (org-get-compact-tod ts))))))
12105 (when what
12106 (setq time
12107 (if (stringp time)
12108 ;; This is a string (relative or absolute), set proper date
12109 (apply 'encode-time
12110 (org-read-date-analyze
12111 time default-time (decode-time default-time)))
12112 ;; If necessary, get the time from the user
12113 (or time (org-read-date nil 'to-time nil nil
12114 default-time default-input)))))
12116 (when (and org-insert-labeled-timestamps-at-point
12117 (member what '(scheduled deadline)))
12118 (insert
12119 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
12120 (org-insert-time-stamp time org-time-was-given
12121 nil nil nil (list org-end-time-was-given))
12122 (setq what nil))
12123 (save-excursion
12124 (save-restriction
12125 (let (col list elt ts buffer-invisibility-spec)
12126 (org-back-to-heading t)
12128 (goto-char (match-end 1))
12129 (setq col (current-column))
12130 (goto-char (match-end 0))
12132 (when (and (not what)
12133 (not (looking-at
12135 org-keyword-time-not-clock-regexp))))
12136 ;; Nothing to add, nothing to remove...... :-)
12137 (throw 'exit nil))
12138 (if (and (not (looking-at org-outline-regexp))
12141 (not (equal (match-string 1) org-clock-string)))
12142 (narrow-to-region (match-beginning 0) (match-end 0))
12144 (backward-char 1)
12145 (narrow-to-region (point) (point))
12146 (and org-adapt-indentation (org-indent-to-column col)))
12147 ;; Check if we have to remove something.
12148 (setq list (cons what remove))
12149 (while list
12150 (setq elt (pop list))
12151 (when (or (and (eq elt 'scheduled)
12152 (re-search-forward org-scheduled-time-regexp nil t))
12153 (and (eq elt 'deadline)
12154 (re-search-forward org-deadline-time-regexp nil t))
12155 (and (eq elt 'closed)
12156 (re-search-forward org-closed-time-regexp nil t)))
12157 (replace-match "")
12158 (if (looking-at "--+<[^>]+>") (replace-match ""))))
12160 (and org-adapt-indentation (bolp) (org-indent-to-column col))
12161 (when what
12162 (insert
12163 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
12164 (cond ((eq what 'scheduled) org-scheduled-string)
12165 ((eq what 'deadline) org-deadline-string)
12166 ((eq what 'closed) org-closed-string))
12167 " ")
12168 (setq ts (org-insert-time-stamp
12169 time
12170 (or org-time-was-given
12171 (and (eq what 'closed) org-log-done-with-time))
12172 (eq what 'closed)
12173 nil nil (list org-end-time-was-given)))
12174 (insert
12175 (if (not (or (bolp) (eq (char-before) ?\ )
12176 (memq (char-after) '(32 10))
12177 (eobp))) " " ""))
12178 (end-of-line 1))
12179 (goto-char (point-min))
12180 (widen)
12183 (delete-region (1- (point)) (point-at-eol)))
12184 ts))))))
12186 (defvar org-log-note-marker (make-marker))
12187 (defvar org-log-note-purpose nil)
12188 (defvar org-log-note-state nil)
12189 (defvar org-log-note-previous-state nil)
12190 (defvar org-log-note-how nil)
12191 (defvar org-log-note-extra nil)
12192 (defvar org-log-note-window-configuration nil)
12193 (defvar org-log-note-return-to (make-marker))
12194 (defvar org-log-note-effective-time nil
12195 "Remembered current time so that dynamically scoped
12196 `org-extend-today-until' affects tha timestamps in state change
12197 log")
12199 (defvar org-log-post-message nil
12200 "Message to be displayed after a log note has been stored.
12201 The auto-repeater uses this.")
12203 (defun org-add-note ()
12204 "Add a note to the current entry.
12205 This is done in the same way as adding a state change note."
12206 (interactive)
12207 (org-add-log-setup 'note nil nil 'findpos nil))
12209 (defvar org-property-end-re)
12210 (defun org-add-log-setup (&optional purpose state prev-state
12211 findpos how extra)
12212 "Set up the post command hook to take a note.
12213 If this is about to TODO state change, the new state is expected in STATE.
12214 When FINDPOS is non-nil, find the correct position for the note in
12215 the current entry. If not, assume that it can be inserted at point.
12216 HOW is an indicator what kind of note should be created.
12217 EXTRA is additional text that will be inserted into the notes buffer."
12218 (let* ((org-log-into-drawer (org-log-into-drawer))
12219 (drawer (cond ((stringp org-log-into-drawer)
12220 org-log-into-drawer)
12221 (org-log-into-drawer "LOGBOOK")
12222 (t nil))))
12223 (save-restriction
12224 (save-excursion
12225 (when findpos
12226 (org-back-to-heading t)
12227 (narrow-to-region (point) (save-excursion
12228 (outline-next-heading) (point)))
12232 (goto-char (match-end 0))
12233 (cond
12234 (drawer
12236 nil t)
12237 (progn
12238 (goto-char (match-end 0))
12239 (or org-log-states-order-reversed
12240 (and (re-search-forward org-property-end-re nil t)
12241 (goto-char (1- (match-beginning 0))))))
12243 (beginning-of-line 0)
12244 (org-indent-line-function)
12245 (beginning-of-line 2)
12246 (org-indent-line-function)
12247 (end-of-line 0)))
12248 ((and org-log-state-notes-insert-after-drawers
12249 (save-excursion
12250 (forward-line) (looking-at org-drawer-regexp)))
12251 (forward-line)
12252 (while (looking-at org-drawer-regexp)
12253 (goto-char (match-end 0))
12254 (re-search-forward org-property-end-re (point-max) t)
12255 (forward-line))
12256 (forward-line -1)))
12257 (unless org-log-states-order-reversed
12259 (org-skip-over-state-notes)
12261 (move-marker org-log-note-marker (point))
12262 (setq org-log-note-purpose purpose
12263 org-log-note-state state
12264 org-log-note-previous-state prev-state
12265 org-log-note-how how
12266 org-log-note-extra extra
12267 org-log-note-effective-time (org-current-effective-time))
12268 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
12270 (defun org-skip-over-state-notes ()
12271 "Skip past the list of State notes in an entry."
12273 (when (ignore-errors (goto-char (org-in-item-p)))
12274 (let* ((struct (org-list-struct))
12275 (prevs (org-list-prevs-alist struct)))
12277 (goto-char (or (org-list-get-next-item (point) struct prevs)
12278 (org-list-get-item-end (point) struct)))))))
12280 (defun org-add-log-note (&optional purpose)
12281 "Pop up a window for taking a note, and add this note later at point."
12282 (remove-hook 'post-command-hook 'org-add-log-note)
12283 (setq org-log-note-window-configuration (current-window-configuration))
12284 (delete-other-windows)
12285 (move-marker org-log-note-return-to (point))
12286 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
12287 (goto-char org-log-note-marker)
12288 (org-switch-to-buffer-other-window "*Org Note*")
12289 (erase-buffer)
12290 (if (memq org-log-note-how '(time state))
12291 (let (current-prefix-arg) (org-store-log-note))
12292 (let ((org-inhibit-startup t)) (org-mode))
12293 (insert (format "# Insert note for %s.
12295 (cond
12296 ((eq org-log-note-purpose 'clock-out) "stopped clock")
12297 ((eq org-log-note-purpose 'done) "closed todo item")
12298 ((eq org-log-note-purpose 'state)
12300 (or org-log-note-previous-state "")
12301 (or org-log-note-state "")))
12302 ((eq org-log-note-purpose 'reschedule)
12303 "rescheduling")
12304 ((eq org-log-note-purpose 'delschedule)
12305 "no longer scheduled")
12306 ((eq org-log-note-purpose 'redeadline)
12307 "changing deadline")
12308 ((eq org-log-note-purpose 'deldeadline)
12309 "removing deadline")
12310 ((eq org-log-note-purpose 'refile)
12311 "refiling")
12312 ((eq org-log-note-purpose 'note)
12313 "this entry")
12314 (t (error "This should not happen")))))
12315 (if org-log-note-extra (insert org-log-note-extra))
12316 (org-set-local 'org-finish-function 'org-store-log-note)
12317 (run-hooks 'org-log-buffer-setup-hook)))
12319 (defvar org-note-abort nil) ; dynamically scoped
12320 (defun org-store-log-note ()
12321 "Finish taking a log note, and insert it to where it belongs."
12322 (let ((txt (buffer-string))
12323 (note (cdr (assq org-log-note-purpose org-log-note-headings)))
12324 lines ind bul)
12325 (kill-buffer (current-buffer))
12327 (setq txt (replace-match "" t t txt)))
12329 (setq txt (replace-match "" t t txt)))
12332 (setq note
12333 (org-replace-escapes
12334 note
12335 (list (cons "%u" (user-login-name))
12336 (cons "%U" user-full-name)
12337 (cons "%t" (format-time-string
12338 (org-time-stamp-format 'long 'inactive)
12339 org-log-note-effective-time))
12340 (cons "%T" (format-time-string
12341 (org-time-stamp-format 'long nil)
12342 org-log-note-effective-time))
12343 (cons "%d" (format-time-string
12344 (org-time-stamp-format nil 'inactive)
12345 org-log-note-effective-time))
12346 (cons "%D" (format-time-string
12347 (org-time-stamp-format nil nil)
12348 org-log-note-effective-time))
12349 (cons "%s" (if org-log-note-state
12351 ""))
12352 (cons "%S" (if org-log-note-previous-state
12356 (push note lines))
12357 (when (or current-prefix-arg org-note-abort)
12358 (when org-log-into-drawer
12359 (org-remove-empty-drawer-at
12360 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
12361 org-log-note-marker))
12362 (setq lines nil))
12363 (when lines
12364 (with-current-buffer (marker-buffer org-log-note-marker)
12365 (save-excursion
12366 (goto-char org-log-note-marker)
12367 (move-marker org-log-note-marker nil)
12368 (end-of-line 1)
12370 (setq ind (save-excursion
12371 (if (ignore-errors (goto-char (org-in-item-p)))
12372 (let ((struct (org-list-struct)))
12373 (org-list-get-ind
12374 (org-list-get-top-point struct) struct))
12376 (cond
12377 ((and (org-at-heading-p)
12378 org-adapt-indentation)
12379 (1+ (org-current-level)))
12380 ((org-at-heading-p) 0)
12381 (t (org-get-indentation))))))
12382 (setq bul (org-list-bullet-string "-"))
12383 (org-indent-line-to ind)
12384 (insert bul (pop lines))
12385 (let ((ind-body (+ (length bul) ind)))
12386 (while lines
12388 (org-indent-line-to ind-body)
12389 (insert (pop lines))))
12390 (message "Note stored")
12391 (org-back-to-heading t)
12392 (org-cycle-hide-drawers 'children)))))
12393 (set-window-configuration org-log-note-window-configuration)
12394 (with-current-buffer (marker-buffer org-log-note-return-to)
12395 (goto-char org-log-note-return-to))
12396 (move-marker org-log-note-return-to nil)
12397 (and org-log-post-message (message "%s" org-log-post-message)))
12399 (defun org-remove-empty-drawer-at (drawer pos)
12400 "Remove an empty drawer DRAWER at position POS.
12401 POS may also be a marker."
12402 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
12403 (save-excursion
12404 (save-restriction
12405 (widen)
12406 (goto-char pos)
12407 (if (org-in-regexp
12409 (replace-match ""))))))
12411 (defun org-sparse-tree (&optional arg)
12412 "Create a sparse tree, prompt for the details.
12413 This command can create sparse trees. You first need to select the type
12414 of match used to create the tree:
12416 t Show all TODO entries.
12417 T Show entries with a specific TODO keyword.
12418 m Show entries selected by a tags/property match.
12419 p Enter a property name and its value (both with completion on existing
12420 names/values) and show entries with that property.
12421 r Show entries matching a regular expression (`/' can be used as well)
12422 d Show deadlines due within `org-deadline-warning-days'.
12423 b Show deadlines and scheduled items before a date.
12424 a Show deadlines and scheduled items after a date."
12425 (interactive "P")
12426 (let (ans kwd value)
12427 (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")
12428 (setq ans (read-char-exclusive))
12429 (cond
12430 ((equal ans ?d)
12431 (call-interactively 'org-check-deadlines))
12432 ((equal ans ?b)
12433 (call-interactively 'org-check-before-date))
12434 ((equal ans ?a)
12435 (call-interactively 'org-check-after-date))
12436 ((equal ans ?D)
12437 (call-interactively 'org-check-dates-range))
12438 ((equal ans ?t)
12439 (org-show-todo-tree nil))
12440 ((equal ans ?T)
12441 (org-show-todo-tree '(4)))
12442 ((member ans '(?T ?m))
12443 (call-interactively 'org-match-sparse-tree))
12444 ((member ans '(?p ?P))
12445 (setq kwd (org-icompleting-read "Property: "
12446 (mapcar 'list (org-buffer-property-keys))))
12447 (setq value (org-icompleting-read "Value: "
12448 (mapcar 'list (org-property-values kwd))))
12451 (org-match-sparse-tree arg (concat kwd "=" value)))
12452 ((member ans '(?r ?R ?/))
12453 (call-interactively 'org-occur))
12456 (defvar org-occur-highlights nil
12457 "List of overlays used for occur matches.")
12458 (make-variable-buffer-local 'org-occur-highlights)
12459 (defvar org-occur-parameters nil
12460 "Parameters of the active org-occur calls.
12461 This is a list, each call to org-occur pushes as cons cell,
12462 containing the regular expression and the callback, onto the list.
12463 The list can contain several entries if `org-occur' has been called
12464 several time with the KEEP-PREVIOUS argument. Otherwise, this list
12465 will only contain one set of parameters. When the highlights are
12466 removed (for example with `C-c C-c', or with the next edit (depending
12467 on `org-remove-highlights-with-change'), this variable is emptied
12468 as well.")
12469 (make-variable-buffer-local 'org-occur-parameters)
12471 (defun org-occur (regexp &optional keep-previous callback)
12472 "Make a compact tree which shows all matches of REGEXP.
12473 The tree will show the lines where the regexp matches, and all higher
12474 headlines above the match. It will also show the heading after the match,
12475 to make sure editing the matching entry is easy.
12476 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
12477 call to `org-occur' will be kept, to allow stacking of calls to this
12478 command.
12479 If CALLBACK is non-nil, it is a function which is called to confirm
12480 that the match should indeed be shown."
12482 (when (equal regexp "")
12483 (error "Regexp cannot be empty"))
12484 (unless keep-previous
12485 (org-remove-occur-highlights nil nil t))
12486 (push (cons regexp callback) org-occur-parameters)
12487 (let ((cnt 0))
12488 (save-excursion
12489 (goto-char (point-min))
12490 (if (or (not keep-previous) ; do not want to keep
12491 (not org-occur-highlights)) ; no previous matches
12492 ;; hide everything
12493 (org-overview))
12494 (while (re-search-forward regexp nil t)
12495 (when (or (not callback)
12496 (save-match-data (funcall callback)))
12497 (setq cnt (1+ cnt))
12498 (when org-highlight-sparse-tree-matches
12499 (org-highlight-new-match (match-beginning 0) (match-end 0)))
12500 (org-show-context 'occur-tree))))
12501 (when org-remove-highlights-with-change
12502 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
12503 nil 'local))
12504 (unless org-sparse-tree-open-archived-trees
12505 (org-hide-archived-subtrees (point-min) (point-max)))
12506 (run-hooks 'org-occur-hook)
12507 (if (org-called-interactively-p 'interactive)
12508 (message "%d match(es) for regexp %s" cnt regexp))
12509 cnt))
12511 (defun org-occur-next-match (&optional n reset)
12512 "Function for `next-error-function' to find sparse tree matches.
12513 N is the number of matches to move, when negative move backwards.
12514 RESET is entirely ignored - this function always goes back to the
12515 starting point when no match is found."
12516 (let* ((limit (if (< n 0) (point-min) (point-max)))
12517 (search-func (if (< n 0)
12518 'previous-single-char-property-change
12519 'next-single-char-property-change))
12520 (n (abs n))
12521 (pos (point))
12522 p1)
12523 (catch 'exit
12524 (while (setq p1 (funcall search-func (point) 'org-type))
12525 (when (equal p1 limit)
12526 (goto-char pos)
12527 (error "No more matches"))
12528 (when (equal (get-char-property p1 'org-type) 'org-occur)
12529 (setq n (1- n))
12530 (when (= n 0)
12531 (goto-char p1)
12532 (throw 'exit (point))))
12533 (goto-char p1))
12534 (goto-char p1)
12535 (error "No more matches"))))
12537 (defun org-show-context (&optional key)
12538 "Make sure point and context are visible.
12539 How much context is shown depends upon the variables
12540 `org-show-hierarchy-above', `org-show-following-heading',
12541 `org-show-entry-below' and `org-show-siblings'."
12542 (let ((heading-p (org-at-heading-p t))
12543 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
12544 (following-p (org-get-alist-option org-show-following-heading key))
12545 (entry-p (org-get-alist-option org-show-entry-below key))
12546 (siblings-p (org-get-alist-option org-show-siblings key)))
12547 (catch 'exit
12548 ;; Show heading or entry text
12549 (if (and heading-p (not entry-p))
12550 (org-flag-heading nil) ; only show the heading
12551 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
12552 (org-show-hidden-entry))) ; show entire entry
12553 (when following-p
12554 ;; Show next sibling, or heading below text
12555 (save-excursion
12556 (and (if heading-p (org-goto-sibling) (outline-next-heading))
12557 (org-flag-heading nil))))
12558 (when siblings-p (org-show-siblings))
12559 (when hierarchy-p
12560 ;; show all higher headings, possibly with siblings
12561 (save-excursion
12562 (while (and (condition-case nil
12563 (progn (org-up-heading-all 1) t)
12564 (error nil))
12565 (not (bobp)))
12566 (org-flag-heading nil)
12567 (when siblings-p (org-show-siblings))))))))
12569 (defvar org-reveal-start-hook nil
12570 "Hook run before revealing a location.")
12572 (defun org-reveal (&optional siblings)
12573 "Show current entry, hierarchy above it, and the following headline.
12574 This can be used to show a consistent set of context around locations
12575 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
12576 not t for the search context.
12578 With optional argument SIBLINGS, on each level of the hierarchy all
12579 siblings are shown. This repairs the tree structure to what it would
12580 look like when opened with hierarchical calls to `org-cycle'.
12582 go to the parent and show the
12583 entire tree."
12584 (interactive "P")
12585 (run-hooks 'org-reveal-start-hook)
12586 (let ((org-show-hierarchy-above t)
12587 (org-show-following-heading t)
12588 (org-show-siblings (if siblings t org-show-siblings)))
12589 (org-show-context nil))
12590 (when (equal siblings '(16))
12591 (save-excursion
12592 (when (org-up-heading-safe)
12593 (org-show-subtree)
12594 (run-hook-with-args 'org-cycle-hook 'subtree)))))
12596 (defun org-highlight-new-match (beg end)
12597 "Highlight from BEG to END and mark the highlight is an occur headline."
12598 (let ((ov (make-overlay beg end)))
12599 (overlay-put ov 'face 'secondary-selection)
12600 (overlay-put ov 'org-type 'org-occur)
12601 (push ov org-occur-highlights)))
12603 (defun org-remove-occur-highlights (&optional beg end noremove)
12604 "Remove the occur highlights from the buffer.
12605 BEG and END are ignored. If NOREMOVE is nil, remove this function
12606 from the `before-change-functions' in the current buffer."
12607 (interactive)
12608 (unless org-inhibit-highlight-removal
12609 (mapc 'delete-overlay org-occur-highlights)
12610 (setq org-occur-highlights nil)
12611 (setq org-occur-parameters nil)
12612 (unless noremove
12613 (remove-hook 'before-change-functions
12614 'org-remove-occur-highlights 'local))))
12616 ;;;; Priorities
12619 "Regular expression matching the priority indicator.")
12621 (defvar org-remove-priority-next-time nil)
12623 (defun org-priority-up ()
12624 "Increase the priority of the current item."
12625 (interactive)
12626 (org-priority 'up))
12628 (defun org-priority-down ()
12629 "Decrease the priority of the current item."
12630 (interactive)
12631 (org-priority 'down))
12633 (defun org-priority (&optional action)
12634 "Change the priority of an item by ARG.
12635 ACTION can be `set', `up', `down', or a character."
12636 (interactive)
12637 (unless org-enable-priority-commands
12638 (error "Priority commands are disabled"))
12639 (setq action (or action 'set))
12640 (let (current new news have remove)
12641 (save-excursion
12642 (org-back-to-heading t)
12643 (if (looking-at org-priority-regexp)
12644 (setq current (string-to-char (match-string 2))
12645 have t))
12646 (cond
12647 ((eq action 'remove)
12648 (setq remove t new ?\ ))
12649 ((or (eq action 'set)
12650 (if (featurep 'xemacs) (characterp action) (integerp action)))
12651 (if (not (eq action 'set))
12652 (setq new action)
12653 (message "Priority %c-%c, SPC to remove: "
12654 org-highest-priority org-lowest-priority)
12655 (save-match-data
12656 (setq new (read-char-exclusive))))
12657 (if (and (= (upcase org-highest-priority) org-highest-priority)
12658 (= (upcase org-lowest-priority) org-lowest-priority))
12659 (setq new (upcase new)))
12660 (cond ((equal new ?\ ) (setq remove t))
12661 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
12662 (error "Priority must be between `%c' and `%c'"
12663 org-highest-priority org-lowest-priority))))
12664 ((eq action 'up)
12665 (setq new (if have
12666 (1- current) ; normal cycling
12667 ;; last priority was empty
12668 (if (eq last-command this-command)
12669 org-lowest-priority ; wrap around empty to lowest
12670 ;; default
12671 (if org-priority-start-cycle-with-default
12672 org-default-priority
12673 (1- org-default-priority))))))
12674 ((eq action 'down)
12675 (setq new (if have
12676 (1+ current) ; normal cycling
12677 ;; last priority was empty
12678 (if (eq last-command this-command)
12679 org-highest-priority ; wrap around empty to highest
12680 ;; default
12681 (if org-priority-start-cycle-with-default
12682 org-default-priority
12683 (1+ org-default-priority))))))
12684 (t (error "Invalid action")))
12685 (if (or (< (upcase new) org-highest-priority)
12686 (> (upcase new) org-lowest-priority))
12687 (if (and (memq action '(up down))
12688 (not have) (not (eq last-command this-command)))
12689 ;; `new' is from default priority
12690 (error
12691 "The default can not be set, see `org-default-priority' why")
12692 ;; normal cycling: `new' is beyond highest/lowest priority
12693 ;; and is wrapped around to the empty priority
12694 (setq remove t)))
12695 (setq news (format "%c" new))
12696 (if have
12697 (if remove
12698 (replace-match "" t t nil 1)
12699 (replace-match news t t nil 2))
12700 (if remove
12701 (error "No priority cookie found in line")
12702 (let ((case-fold-search nil))
12703 (looking-at org-todo-line-regexp))
12704 (if (match-end 2)
12705 (progn
12706 (goto-char (match-end 2))
12707 (insert " [#" news "]"))
12708 (goto-char (match-beginning 3))
12709 (insert "[#" news "] "))))
12710 (org-preserve-lc (org-set-tags nil 'align)))
12711 (if remove
12712 (message "Priority removed")
12713 (message "Priority of current item set to %s" news))))
12715 (defun org-get-priority (s)
12716 "Find priority cookie and return priority."
12717 (if (functionp org-get-priority-function)
12718 (funcall org-get-priority-function)
12719 (save-match-data
12720 (if (not (string-match org-priority-regexp s))
12721 (* 1000 (- org-lowest-priority org-default-priority))
12722 (* 1000 (- org-lowest-priority
12723 (string-to-char (match-string 2 s))))))))
12725 ;;;; Tags
12727 (defvar org-agenda-archives-mode)
12728 (defvar org-map-continue-from nil
12729 "Position from where mapping should continue.
12730 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
12732 (defvar org-scanner-tags nil
12733 "The current tag list while the tags scanner is running.")
12734 (defvar org-trust-scanner-tags nil
12735 "Should `org-get-tags-at' use the tags for the scanner.
12736 This is for internal dynamical scoping only.
12737 When this is non-nil, the function `org-get-tags-at' will return the value
12738 of `org-scanner-tags' instead of building the list by itself. This
12739 can lead to large speed-ups when the tags scanner is used in a file with
12740 many entries, and when the list of tags is retrieved, for example to
12741 obtain a list of properties. Building the tags list for each entry in such
12742 a file becomes an N^2 operation - but with this variable set, it scales
12743 as N.")
12745 (defun org-scan-tags (action matcher &optional todo-only start-level)
12746 "Scan headline tags with inheritance and produce output ACTION.
12748 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
12749 or `agenda' to produce an entry list for an agenda view. It can also be
12750 a Lisp form or a function that should be called at each matched headline, in
12751 this case the return value is a list of all return values from these calls.
12753 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
12754 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
12755 only lines with a TODO keyword are included in the output.
12757 START-LEVEL can be a string with asterisks, reducing the scope to
12758 headlines matching this string."
12759 (require 'org-agenda)
12760 (let* ((re (concat "^"
12761 (if start-level
12762 ;; Get the correct level to match
12764 org-outline-regexp)
12767 (org-re
12769 (props (list 'face 'default
12770 'done-face 'org-agenda-done
12771 'undone-face 'default
12772 'mouse-face 'highlight
12773 'org-not-done-regexp org-not-done-regexp
12774 'org-todo-regexp org-todo-regexp
12775 'org-complex-heading-regexp org-complex-heading-regexp
12776 'help-echo
12777 (format "mouse-2 or RET jump to org file %s"
12778 (abbreviate-file-name
12779 (or (buffer-file-name (buffer-base-buffer))
12780 (buffer-name (buffer-base-buffer)))))))
12781 (case-fold-search nil)
12782 (org-map-continue-from nil)
12783 lspos tags tags-list
12784 (tags-alist (list (cons 0 org-file-tags)))
12785 (llast 0) rtn rtn1 level category i txt
12786 todo marker entry priority)
12787 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
12788 (setq action (list 'lambda nil action)))
12789 (save-excursion
12790 (goto-char (point-min))
12791 (when (eq action 'sparse-tree)
12792 (org-overview)
12793 (org-remove-occur-highlights))
12794 (while (re-search-forward re nil t)
12795 (setq org-map-continue-from nil)
12796 (catch :skip
12797 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
12798 tags (if (match-end 4) (org-match-string-no-properties 4)))
12799 (goto-char (setq lspos (match-beginning 0)))
12800 (setq level (org-reduced-level (funcall outline-level))
12801 category (org-get-category))
12802 (setq i llast llast level)
12803 ;; remove tag lists from same and sublevels
12804 (while (>= i level)
12805 (when (setq entry (assoc i tags-alist))
12806 (setq tags-alist (delete entry tags-alist)))
12807 (setq i (1- i)))
12808 ;; add the next tags
12809 (when tags
12810 (setq tags (org-split-string tags ":")
12811 tags-alist
12812 (cons (cons level tags) tags-alist)))
12813 ;; compile tags for current headline
12814 (setq tags-list
12815 (if org-use-tag-inheritance
12816 (apply 'append (mapcar 'cdr (reverse tags-alist)))
12817 tags)
12818 org-scanner-tags tags-list)
12819 (when org-use-tag-inheritance
12820 (setcdr (car tags-alist)
12821 (mapcar (lambda (x)
12822 (setq x (copy-sequence x))
12823 (org-add-prop-inherited x))
12824 (cdar tags-alist))))
12825 (when (and tags org-use-tag-inheritance
12826 (or (not (eq t org-use-tag-inheritance))
12827 org-tags-exclude-from-inheritance))
12828 ;; selective inheritance, remove uninherited ones
12829 (setcdr (car tags-alist)
12830 (org-remove-uninherited-tags (cdar tags-alist))))
12831 (when (and
12833 ;; eval matcher only when the todo condition is OK
12834 (and (or (not todo-only) (member todo org-not-done-keywords))
12835 (let ((case-fold-search t)) (eval matcher)))
12837 ;; Call the skipper, but return t if it does not skip,
12838 ;; so that the `and' form continues evaluating
12839 (progn
12840 (unless (eq action 'sparse-tree) (org-agenda-skip))
12841 t)
12843 ;; Check if timestamps are deselecting this entry
12844 (or (not todo-only)
12845 (and (member todo org-not-done-keywords)
12846 (or (not org-agenda-tags-todo-honor-ignore-options)
12847 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))
12849 ;; Extra check for the archive tag
12850 ;; FIXME: Does the skipper already do this????
12851 (or
12852 (not (member org-archive-tag tags-list))
12853 ;; we have an archive tag, should we use this anyway?
12854 (or (not org-agenda-skip-archived-trees)
12855 (and (eq action 'agenda) org-agenda-archives-mode))))
12857 ;; select this headline
12859 (cond
12860 ((eq action 'sparse-tree)
12861 (and org-highlight-sparse-tree-matches
12862 (org-get-heading) (match-end 0)
12863 (org-highlight-new-match
12864 (match-beginning 0) (match-beginning 1)))
12865 (org-show-context 'tags-tree))
12866 ((eq action 'agenda)
12867 (setq txt (org-agenda-format-item
12868 ""
12869 (concat
12870 (if (eq org-tags-match-list-sublevels 'indented)
12871 (make-string (1- level) ?.) "")
12872 (org-get-heading))
12873 category
12874 tags-list
12875 )
12876 priority (org-get-priority txt))
12877 (goto-char lspos)
12878 (setq marker (org-agenda-new-marker))
12879 (org-add-props txt props
12880 'org-marker marker 'org-hd-marker marker 'org-category category
12881 'todo-state todo
12882 'priority priority 'type "tagsmatch")
12883 (push txt rtn))
12884 ((functionp action)
12885 (setq org-map-continue-from nil)
12886 (save-excursion
12887 (setq rtn1 (funcall action))
12888 (push rtn1 rtn)))
12889 (t (error "Invalid action")))
12891 ;; if we are to skip sublevels, jump to end of subtree
12892 (unless org-tags-match-list-sublevels
12893 (org-end-of-subtree t)
12894 (backward-char 1))))
12895 ;; Get the correct position from where to continue
12896 (if org-map-continue-from
12897 (goto-char org-map-continue-from)
12898 (and (= (point) lspos) (end-of-line 1)))))
12899 (when (and (eq action 'sparse-tree)
12900 (not org-sparse-tree-open-archived-trees))
12901 (org-hide-archived-subtrees (point-min) (point-max)))
12902 (nreverse rtn)))
12904 (defun org-remove-uninherited-tags (tags)
12905 "Remove all tags that are not inherited from the list TAGS."
12906 (cond
12907 ((eq org-use-tag-inheritance t)
12908 (if org-tags-exclude-from-inheritance
12909 (org-delete-all org-tags-exclude-from-inheritance tags)
12910 tags))
12911 ((not org-use-tag-inheritance) nil)
12912 ((stringp org-use-tag-inheritance)
12913 (delq nil (mapcar
12914 (lambda (x)
12915 (if (and (string-match org-use-tag-inheritance x)
12916 (not (member x org-tags-exclude-from-inheritance)))
12917 x nil))
12918 tags)))
12919 ((listp org-use-tag-inheritance)
12920 (delq nil (mapcar
12921 (lambda (x)
12922 (if (member x org-use-tag-inheritance) x nil))
12923 tags)))))
12925 (defvar todo-only) ;; dynamically scoped
12927 (defun org-match-sparse-tree (&optional todo-only match)
12928 "Create a sparse tree according to tags string MATCH.
12929 MATCH can contain positive and negative selection of tags, like
12931 If optional argument TODO-ONLY is non-nil, only select lines that are
12932 also TODO lines."
12933 (interactive "P")
12934 (org-prepare-agenda-buffers (list (current-buffer)))
12935 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
12937 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
12939 (defvar org-cached-props nil)
12940 (defun org-cached-entry-get (pom property)
12941 (if (or (eq t org-use-property-inheritance)
12942 (and (stringp org-use-property-inheritance)
12943 (string-match org-use-property-inheritance property))
12944 (and (listp org-use-property-inheritance)
12945 (member property org-use-property-inheritance)))
12946 ;; Caching is not possible, check it directly
12947 (org-entry-get pom property 'inherit)
12948 ;; Get all properties, so that we can do complicated checks easily
12949 (cdr (assoc property (or org-cached-props
12950 (setq org-cached-props
12951 (org-entry-properties pom)))))))
12953 (defun org-global-tags-completion-table (&optional files)
12954 "Return the list of all tags in all agenda buffer/files.
12955 Optional FILES argument is a list of files to which can be used
12956 instead of the agenda files."
12957 (save-excursion
12958 (org-uniquify
12959 (delq nil
12960 (apply 'append
12961 (mapcar
12962 (lambda (file)
12963 (set-buffer (find-file-noselect file))
12964 (append (org-get-buffer-tags)
12965 (mapcar (lambda (x) (if (stringp (car-safe x))
12966 (list (car-safe x)) nil))
12967 org-tag-alist)))
12968 (if (and files (car files))
12969 files
12970 (org-agenda-files))))))))
12972 (defun org-make-tags-matcher (match)
12973 "Create the TAGS/TODO matcher form for the selection string MATCH."
12974 ;; todo-only is scoped dynamically into this function, and the function
12975 ;; may change it if the matcher asks for it.
12976 (unless match
12977 ;; Get a new match request, with completion
12978 (let ((org-last-tags-completion-table
12979 (org-global-tags-completion-table)))
12980 (setq match (org-completing-read-no-i
12981 "Match: " 'org-tags-completion-function nil nil nil
12982 'org-tags-history))))
12984 ;; Parse the string and create a lisp form
12985 (let ((match0 match)
12986 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
12987 minus tag mm
12988 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
12989 orterms term orlist re-p str-p level-p level-op time-p
12990 prop-p pn pv po gv rest)
12991 (if (string-match "/+" match)
12992 ;; match contains also a todo-matching request
12993 (progn
12994 (setq tagsmatch (substring match 0 (match-beginning 0))
12995 todomatch (substring match (match-end 0)))
12996 (if (string-match "^!" todomatch)
12997 (setq todo-only t todomatch (substring todomatch 1)))
12999 (setq todomatch nil)))
13000 ;; only matching tags
13001 (setq tagsmatch match todomatch nil))
13003 ;; Make the tags matcher
13005 (setq tagsmatcher t)
13006 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13007 (while (setq term (pop orterms))
13009 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13010 (while (string-match re term)
13011 (setq rest (substring term (match-end 0))
13012 minus (and (match-end 1)
13013 (equal (match-string 1 term) "-"))
13014 tag (save-match-data (replace-regexp-in-string
13016 (match-string 2 term)))
13017 re-p (equal (string-to-char tag) ?{)
13018 level-p (match-end 4)
13019 prop-p (match-end 5)
13020 mm (cond
13021 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
13022 (level-p
13023 (setq level-op (org-op-to-function (match-string 3 term)))
13024 `(,level-op level ,(string-to-number
13025 (match-string 4 term))))
13026 (prop-p
13027 (setq pn (match-string 5 term)
13028 po (match-string 6 term)
13029 pv (match-string 7 term)
13030 re-p (equal (string-to-char pv) ?{)
13032 time-p (save-match-data
13034 pv (if (or re-p str-p) (substring pv 1 -1) pv))
13035 (if time-p (setq pv (org-matcher-time pv)))
13036 (setq po (org-op-to-function po (if time-p 'time str-p)))
13037 (cond
13038 ((equal pn "CATEGORY")
13039 (setq gv '(get-text-property (point) 'org-category)))
13040 ((equal pn "TODO")
13041 (setq gv 'todo))
13042 (t
13043 (setq gv `(org-cached-entry-get nil ,pn))))
13044 (if re-p
13045 (if (eq po 'org<>)
13046 `(not (string-match ,pv (or ,gv "")))
13047 `(string-match ,pv (or ,gv "")))
13048 (if str-p
13049 `(,po (or ,gv "") ,pv)
13050 `(,po (string-to-number (or ,gv ""))
13051 ,(string-to-number pv) ))))
13052 (t `(member ,tag tags-list)))
13053 mm (if minus (list 'not mm) mm)
13054 term rest)
13055 (push mm tagsmatcher))
13056 (push (if (> (length tagsmatcher) 1)
13057 (cons 'and tagsmatcher)
13058 (car tagsmatcher))
13059 orlist)
13060 (setq tagsmatcher nil))
13061 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
13062 (setq tagsmatcher
13063 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
13064 ;; Make the todo matcher
13066 (setq todomatcher t)
13067 (setq orterms (org-split-string todomatch "|") orlist nil)
13068 (while (setq term (pop orterms))
13069 (while (string-match re term)
13070 (setq minus (and (match-end 1)
13071 (equal (match-string 1 term) "-"))
13072 kwd (match-string 2 term)
13073 re-p (equal (string-to-char kwd) ?{)
13074 term (substring term (match-end 0))
13075 mm (if re-p
13076 `(string-match ,(substring kwd 1 -1) todo)
13077 (list 'equal 'todo kwd))
13078 mm (if minus (list 'not mm) mm))
13079 (push mm todomatcher))
13080 (push (if (> (length todomatcher) 1)
13081 (cons 'and todomatcher)
13082 (car todomatcher))
13083 orlist)
13084 (setq todomatcher nil))
13085 (setq todomatcher (if (> (length orlist) 1)
13086 (cons 'or orlist) (car orlist))))
13088 ;; Return the string and lisp forms of the matcher
13089 (setq matcher (if todomatcher
13090 (list 'and tagsmatcher todomatcher)
13091 tagsmatcher))
13092 (cons match0 matcher)))
13094 (defun org-op-to-function (op &optional stringp)
13095 "Turn an operator into the appropriate function."
13096 (setq op
13097 (cond
13098 ((equal op "<" ) '(< string< org-time<))
13099 ((equal op ">" ) '(> org-string> org-time>))
13100 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
13101 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
13102 ((member op '("=" "==")) '(= string= org-time=))
13103 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
13104 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
13106 (defun org<> (a b) (not (= a b)))
13107 (defun org-string<= (a b) (or (string= a b) (string< a b)))
13108 (defun org-string>= (a b) (not (string< a b)))
13109 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
13110 (defun org-string<> (a b) (not (string= a b)))
13111 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
13112 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
13113 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
13114 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
13115 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
13116 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
13117 (defun org-2ft (s)
13118 "Convert S to a floating point time.
13119 If S is already a number, just return it. If it is a string, parse
13120 it as a time string and apply `float-time' to it. If S is nil, just return 0."
13121 (cond
13122 ((numberp s) s)
13123 ((stringp s)
13124 (condition-case nil
13125 (float-time (apply 'encode-time (org-parse-time-string s)))
13126 (error 0.)))
13127 (t 0.)))
13129 (defun org-time-today ()
13130 "Time in seconds today at 0:00.
13131 Returns the float number of seconds since the beginning of the
13132 epoch to the beginning of today (00:00)."
13133 (float-time (apply 'encode-time
13134 (append '(0 0 0) (nthcdr 3 (decode-time))))))
13136 (defun org-matcher-time (s)
13137 "Interpret a time comparison value."
13138 (save-match-data
13139 (cond
13140 ((string= s "<now>") (float-time))
13141 ((string= s "<today>") (org-time-today))
13142 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
13143 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
13145 (+ (org-time-today)
13146 (* (string-to-number (match-string 1 s))
13147 (cdr (assoc (match-string 2 s)
13148 '(("d" . 86400.0) ("w" . 604800.0)
13149 ("m" . 2678400.0) ("y" . 31557600.0)))))))
13150 (t (org-2ft s)))))
13152 (defun org-match-any-p (re list)
13153 "Does re match any element of list?"
13154 (setq list (mapcar (lambda (x) (string-match re x)) list))
13155 (delq nil list))
13157 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
13158 (defvar org-tags-overlay (make-overlay 1 1))
13159 (org-detach-overlay org-tags-overlay)
13161 (defun org-get-local-tags-at (&optional pos)
13162 "Get a list of tags defined in the current headline."
13163 (org-get-tags-at pos 'local))
13165 (defun org-get-local-tags ()
13166 "Get a list of tags defined in the current headline."
13167 (org-get-tags-at nil 'local))
13169 (defun org-get-tags-at (&optional pos local)
13170 "Get a list of all headline tags applicable at POS.
13171 POS defaults to point. If tags are inherited, the list contains
13172 the targets in the same sequence as the headlines appear, i.e.
13173 the tags of the current headline come last.
13174 When LOCAL is non-nil, only return tags from the current headline,
13175 ignore inherited ones."
13176 (interactive)
13177 (if (and org-trust-scanner-tags
13178 (or (not pos) (equal pos (point)))
13179 (not local))
13180 org-scanner-tags
13181 (let (tags ltags lastpos parent)
13182 (save-excursion
13183 (save-restriction
13184 (widen)
13185 (goto-char (or pos (point)))
13186 (save-match-data
13187 (catch 'done
13188 (condition-case nil
13189 (progn
13190 (org-back-to-heading t)
13191 (while (not (equal lastpos (point)))
13192 (setq lastpos (point))
13193 (when (looking-at
13195 (setq ltags (org-split-string
13196 (org-match-string-no-properties 1) ":"))
13197 (when parent
13198 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
13199 (setq tags (append
13200 (if parent
13201 (org-remove-uninherited-tags ltags)
13202 ltags)
13203 tags)))
13204 (or org-use-tag-inheritance (throw 'done t))
13205 (if local (throw 'done t))
13206 (or (org-up-heading-safe) (error nil))
13207 (setq parent t)))
13208 (error nil)))))
13209 (if local
13210 tags
13211 (append (org-remove-uninherited-tags org-file-tags) tags))))))
13213 (defun org-add-prop-inherited (s)
13214 (add-text-properties 0 (length s) '(inherited t) s)
13215 s)
13217 (defun org-toggle-tag (tag &optional onoff)
13218 "Toggle the tag TAG for the current line.
13219 If ONOFF is `on' or `off', don't toggle but set to this state."
13220 (let (res current)
13221 (save-excursion
13222 (org-back-to-heading t)
13224 (point-at-eol) t)
13225 (progn
13226 (setq current (match-string 1))
13227 (replace-match ""))
13228 (setq current ""))
13229 (setq current (nreverse (org-split-string current ":")))
13230 (cond
13231 ((eq onoff 'on)
13232 (setq res t)
13233 (or (member tag current) (push tag current)))
13234 ((eq onoff 'off)
13235 (or (not (member tag current)) (setq current (delete tag current))))
13236 (t (if (member tag current)
13237 (setq current (delete tag current))
13238 (setq res t)
13239 (push tag current))))
13240 (end-of-line 1)
13241 (if current
13242 (progn
13243 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
13244 (org-set-tags nil t))
13245 (delete-horizontal-space))
13246 (run-hooks 'org-after-tags-change-hook))
13247 res))
13249 (defun org-align-tags-here (to-col)
13250 ;; Assumes that this is a headline
13251 (let ((pos (point)) (col (current-column)) ncol tags-l p)
13252 (beginning-of-line 1)
13254 (< pos (match-beginning 2)))
13255 (progn
13256 (setq tags-l (- (match-end 2) (match-beginning 2)))
13257 (goto-char (match-beginning 1))
13258 (insert " ")
13259 (delete-region (point) (1+ (match-beginning 2)))
13260 (setq ncol (max (current-column)
13261 (1+ col)
13262 (if (> to-col 0)
13263 to-col
13264 (- (abs to-col) tags-l))))
13265 (setq p (point))
13266 (insert (make-string (- ncol (current-column)) ?\ ))
13267 (setq ncol (current-column))
13268 (when indent-tabs-mode (tabify p (point-at-eol)))
13269 (org-move-to-column (min ncol col) t))
13270 (goto-char pos))))
13272 (defun org-set-tags-command (&optional arg just-align)
13273 "Call the set-tags command for the current entry."
13274 (interactive "P")
13275 (if (org-at-heading-p)
13276 (org-set-tags arg just-align)
13277 (save-excursion
13278 (org-back-to-heading t)
13279 (org-set-tags arg just-align))))
13281 (defun org-set-tags-to (data)
13282 "Set the tags of the current entry to DATA, replacing the current tags.
13283 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
13284 If DATA is nil or the empty string, any tags will be removed."
13285 (interactive "sTags: ")
13286 (setq data
13287 (cond
13288 ((eq data nil) "")
13289 ((equal data "") "")
13290 ((stringp data)
13291 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
13292 ":"))
13293 ((listp data)
13294 (concat ":" (mapconcat 'identity data ":") ":"))
13295 (t nil)))
13296 (when data
13297 (save-excursion
13298 (org-back-to-heading t)
13299 (when (looking-at org-complex-heading-regexp)
13300 (if (match-end 5)
13301 (progn
13302 (goto-char (match-beginning 5))
13303 (insert data)
13304 (delete-region (point) (point-at-eol))
13305 (org-set-tags nil 'align))
13306 (goto-char (point-at-eol))
13307 (insert " " data)
13308 (org-set-tags nil 'align)))
13309 (beginning-of-line 1)
13311 (delete-region (match-beginning 1) (match-end 1))))))
13313 (defun org-align-all-tags ()
13314 "Align the tags i all headings."
13315 (interactive)
13316 (save-excursion
13317 (or (ignore-errors (org-back-to-heading t))
13318 (outline-next-heading))
13319 (if (org-at-heading-p)
13320 (org-set-tags t)
13321 (message "No headings"))))
13323 (defvar org-indent-indentation-per-level)
13324 (defun org-set-tags (&optional arg just-align)
13325 "Set the tags for the current headline.
13326 With prefix ARG, realign all tags in headings in the current buffer."
13327 (interactive "P")
13328 (let* ((re org-outline-regexp-bol)
13329 (current (org-get-tags-string))
13330 (col (current-column))
13331 (org-setting-tags t)
13332 table current-tags inherited-tags ; computed below when needed
13333 tags p0 c0 c1 rpl di tc level)
13334 (if arg
13335 (save-excursion
13336 (goto-char (point-min))
13337 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
13338 (while (re-search-forward re nil t)
13339 (org-set-tags nil t)
13340 (end-of-line 1)))
13341 (message "All tags realigned to column %d" org-tags-column))
13342 (if just-align
13343 (setq tags current)
13344 ;; Get a new set of tags from the user
13345 (save-excursion
13346 (setq table (append org-tag-persistent-alist
13347 (or org-tag-alist (org-get-buffer-tags))
13348 (and
13349 org-complete-tags-always-offer-all-agenda-tags
13350 (org-global-tags-completion-table
13351 (org-agenda-files))))
13352 org-last-tags-completion-table table
13353 current-tags (org-split-string current ":")
13354 inherited-tags (nreverse
13355 (nthcdr (length current-tags)
13356 (nreverse (org-get-tags-at))))
13357 tags
13358 (if (or (eq t org-use-fast-tag-selection)
13359 (and org-use-fast-tag-selection
13360 (delq nil (mapcar 'cdr table))))
13361 (org-fast-tag-selection
13362 current-tags inherited-tags table
13363 (if org-fast-tag-selection-include-todo
13364 org-todo-key-alist))
13365 (let ((org-add-colon-after-tag-completion t))
13366 (org-trim
13367 (org-icompleting-read "Tags: "
13368 'org-tags-completion-function
13369 nil nil current 'org-tags-history))))))
13370 (while (string-match "[-+&]+" tags)
13371 ;; No boolean logic, just a list
13372 (setq tags (replace-match ":" t t tags))))
13374 (setq tags (replace-regexp-in-string "[,]" ":" tags))
13376 (if org-tags-sort-function
13377 (setq tags (mapconcat 'identity
13378 (sort (org-split-string
13379 tags (org-re "[^[:alnum:]_@#%]+"))
13380 org-tags-sort-function) ":")))
13383 (setq tags "")
13384 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
13385 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
13387 ;; Insert new tags at the correct column
13388 (beginning-of-line 1)
13389 (setq level (or (and (looking-at org-outline-regexp)
13390 (- (match-end 0) (point) 1))
13391 1))
13392 (cond
13393 ((and (equal current "") (equal tags "")))
13394 ((re-search-forward
13396 (point-at-eol) t)
13397 (if (equal tags "")
13398 (setq rpl "")
13399 (goto-char (match-beginning 0))
13400 (setq c0 (current-column)
13401 ;; compute offset for the case of org-indent-mode active
13402 di (if org-indent-mode
13403 (* (1- org-indent-indentation-per-level) (1- level))
13404 0)
13405 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
13406 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
13407 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
13408 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
13409 (replace-match rpl t t)
13410 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
13411 tags)
13412 (t (error "Tags alignment failed")))
13413 (org-move-to-column col)
13414 (unless just-align
13415 (run-hooks 'org-after-tags-change-hook)))))
13417 (defun org-change-tag-in-region (beg end tag off)
13418 "Add or remove TAG for each entry in the region.
13419 This works in the agenda, and also in an org-mode buffer."
13420 (interactive
13421 (list (region-beginning) (region-end)
13422 (let ((org-last-tags-completion-table
13423 (if (eq major-mode 'org-mode)
13424 (org-get-buffer-tags)
13425 (org-global-tags-completion-table))))
13426 (org-icompleting-read
13427 "Tag: " 'org-tags-completion-function nil nil nil
13428 'org-tags-history))
13429 (progn
13431 (equal (read-char-exclusive) ?r))))
13432 (if (fboundp 'deactivate-mark) (deactivate-mark))
13433 (let ((agendap (equal major-mode 'org-agenda-mode))
13434 l1 l2 m buf pos newhead (cnt 0))
13435 (goto-char end)
13436 (setq l2 (1- (org-current-line)))
13437 (goto-char beg)
13438 (setq l1 (org-current-line))
13439 (loop for l from l1 to l2 do
13440 (org-goto-line l)
13441 (setq m (get-text-property (point) 'org-hd-marker))
13442 (when (or (and (eq major-mode 'org-mode) (org-at-heading-p))
13443 (and agendap m))
13444 (setq buf (if agendap (marker-buffer m) (current-buffer))
13445 pos (if agendap m (point)))
13446 (with-current-buffer buf
13447 (save-excursion
13448 (save-restriction
13449 (goto-char pos)
13450 (setq cnt (1+ cnt))
13451 (org-toggle-tag tag (if off 'off 'on))
13452 (setq newhead (org-get-heading)))))
13453 (and agendap (org-agenda-change-all-lines newhead m))))
13454 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
13456 (defun org-tags-completion-function (string predicate &optional flag)
13457 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
13458 (confirm (lambda (x) (stringp (car x)))))
13460 (setq s1 (match-string 1 string)
13461 s2 (match-string 2 string))
13462 (setq s1 "" s2 string))
13463 (cond
13464 ((eq flag nil)
13465 ;; try completion
13466 (setq rtn (try-completion s2 ctable confirm))
13467 (if (stringp rtn)
13468 (setq rtn
13469 (concat s1 s2 (substring rtn (length s2))
13470 (if (and org-add-colon-after-tag-completion
13471 (assoc rtn ctable))
13472 ":" ""))))
13473 rtn)
13474 ((eq flag t)
13475 ;; all-completions
13476 (all-completions s2 ctable confirm)
13477 )
13478 ((eq flag 'lambda)
13479 ;; exact match?
13480 (assoc s2 ctable)))
13481 ))
13483 (defun org-fast-tag-insert (kwd tags face &optional end)
13484 "Insert KDW, and the TAGS, the latter with face FACE. Also insert END."
13485 (insert (format "%-12s" (concat kwd ":"))
13486 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
13487 (or end "")))
13489 (defun org-fast-tag-show-exit (flag)
13490 (save-excursion
13491 (org-goto-line 3)
13493 (replace-match ""))
13494 (when flag
13495 (end-of-line 1)
13496 (org-move-to-column (- (window-width) 19) t)
13497 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
13499 (defun org-set-current-tags-overlay (current prefix)
13500 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
13501 (if (featurep 'xemacs)
13502 (org-overlay-display org-tags-overlay (concat prefix s)
13503 'secondary-selection)
13504 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
13505 (org-overlay-display org-tags-overlay (concat prefix s)))))
13507 (defvar org-last-tag-selection-key nil)
13508 (defun org-fast-tag-selection (current inherited table &optional todo-table)
13509 "Fast tag selection with single keys.
13510 CURRENT is the current list of tags in the headline, INHERITED is the
13511 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
13512 possibly with grouping information. TODO-TABLE is a similar table with
13513 TODO keywords, should these have keys assigned to them.
13514 If the keys are nil, a-z are automatically assigned.
13515 Returns the new tags string, or nil to not change the current settings."
13516 (let* ((fulltable (append table todo-table))
13517 (maxlen (apply 'max (mapcar
13518 (lambda (x)
13519 (if (stringp (car x)) (string-width (car x)) 0))
13520 fulltable)))
13521 (buf (current-buffer))
13522 (expert (eq org-fast-tag-selection-single-key 'expert))
13523 (buffer-tags nil)
13524 (fwidth (+ maxlen 3 1 3))
13525 (ncol (/ (- (window-width) 4) fwidth))
13526 (i-face 'org-done)
13527 (c-face 'org-todo)
13528 tg cnt e c char c1 c2 ntable tbl rtn
13529 ov-start ov-end ov-prefix
13530 (exit-after-next org-fast-tag-selection-single-key)
13531 (done-keywords org-done-keywords)
13532 groups ingroup)
13533 (save-excursion
13534 (beginning-of-line 1)
13535 (if (looking-at
13537 (setq ov-start (match-beginning 1)
13538 ov-end (match-end 1)
13539 ov-prefix "")
13540 (setq ov-start (1- (point-at-eol))
13541 ov-end (1+ ov-start))
13543 (setq ov-prefix
13544 (concat
13545 (buffer-substring (1- (point)) (point))
13546 (if (> (current-column) org-tags-column)
13547 " "
13548 (make-string (- org-tags-column (current-column)) ?\ ))))))
13549 (move-overlay org-tags-overlay ov-start ov-end)
13550 (save-window-excursion
13551 (if expert
13552 (set-buffer (get-buffer-create " *Org tags*"))
13553 (delete-other-windows)
13554 (split-window-vertically)
13555 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
13556 (erase-buffer)
13557 (org-set-local 'org-done-keywords done-keywords)
13560 (org-fast-tag-show-exit exit-after-next)
13561 (org-set-current-tags-overlay current ov-prefix)
13562 (setq tbl fulltable char ?a cnt 0)
13563 (while (setq e (pop tbl))
13564 (cond
13565 ((equal (car e) :startgroup)
13566 (push '() groups) (setq ingroup t)
13567 (when (not (= cnt 0))
13568 (setq cnt 0)
13570 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
13571 ((equal (car e) :endgroup)
13572 (setq ingroup nil cnt 0)
13574 ((equal e '(:newline))
13575 (when (not (= cnt 0))
13576 (setq cnt 0)
13578 (setq e (car tbl))
13579 (while (equal (car tbl) '(:newline))
13581 (setq tbl (cdr tbl)))))
13582 (t
13583 (setq tg (copy-sequence (car e)) c2 nil)
13584 (if (cdr e)
13585 (setq c (cdr e))
13586 ;; automatically assign a character.
13587 (setq c1 (string-to-char
13588 (downcase (substring
13589 tg (if (= (string-to-char tg) ?@) 1 0)))))
13590 (if (or (rassoc c1 ntable) (rassoc c1 table))
13591 (while (or (rassoc char ntable) (rassoc char table))
13592 (setq char (1+ char)))
13593 (setq c2 c1))
13594 (setq c (or c2 char)))
13595 (if ingroup (push tg (car groups)))
13596 (setq tg (org-add-props tg nil 'face
13597 (cond
13598 ((not (assoc tg table))
13599 (org-get-todo-face tg))
13600 ((member tg current) c-face)
13601 ((member tg inherited) i-face)
13602 (t nil))))
13603 (if (and (= cnt 0) (not ingroup)) (insert " "))
13604 (insert "[" c "] " tg (make-string
13605 (- fwidth 4 (length tg)) ?\ ))
13606 (push (cons tg c) ntable)
13607 (when (= (setq cnt (1+ cnt)) ncol)
13609 (if ingroup (insert " "))
13610 (setq cnt 0)))))
13611 (setq ntable (nreverse ntable))
13613 (goto-char (point-min))
13614 (if (not expert) (org-fit-window-to-buffer))
13615 (setq rtn
13616 (catch 'exit
13617 (while t
13618 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
13619 (if (not groups) "no " "")
13620 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
13621 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13622 (setq org-last-tag-selection-key c)
13623 (cond
13625 ((= c ?!)
13626 (setq groups (not groups))
13627 (goto-char (point-min))
13628 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
13629 ((= c ?\C-c)
13630 (if (not expert)
13631 (org-fast-tag-show-exit
13632 (setq exit-after-next (not exit-after-next)))
13633 (setq expert nil)
13634 (delete-other-windows)
13635 (set-window-buffer (split-window-vertically) " *Org tags*")
13636 (org-switch-to-buffer-other-window " *Org tags*")
13637 (org-fit-window-to-buffer)))
13638 ((or (= c ?\C-g)
13639 (and (= c ?q) (not (rassoc c ntable))))
13640 (org-detach-overlay org-tags-overlay)
13641 (setq quit-flag t))
13642 ((= c ?\ )
13643 (setq current nil)
13644 (if exit-after-next (setq exit-after-next 'now)))
13646 (condition-case nil
13647 (setq tg (org-icompleting-read
13648 "Tag: "
13649 (or buffer-tags
13650 (with-current-buffer buf
13651 (org-get-buffer-tags)))))
13652 (quit (setq tg "")))
13654 (add-to-list 'buffer-tags (list tg))
13655 (if (member tg current)
13656 (setq current (delete tg current))
13657 (push tg current)))
13658 (if exit-after-next (setq exit-after-next 'now)))
13659 ((setq e (rassoc c todo-table) tg (car e))
13660 (with-current-buffer buf
13661 (save-excursion (org-todo tg)))
13662 (if exit-after-next (setq exit-after-next 'now)))
13663 ((setq e (rassoc c ntable) tg (car e))
13664 (if (member tg current)
13665 (setq current (delete tg current))
13666 (loop for g in groups do
13667 (if (member tg g)
13668 (mapc (lambda (x)
13669 (setq current (delete x current)))
13670 g)))
13671 (push tg current))
13672 (if exit-after-next (setq exit-after-next 'now))))
13674 ;; Create a sorted list
13675 (setq current
13676 (sort current
13677 (lambda (a b)
13678 (assoc b (cdr (memq (assoc a ntable) ntable))))))
13679 (if (eq exit-after-next 'now) (throw 'exit t))
13680 (goto-char (point-min))
13681 (beginning-of-line 2)
13682 (delete-region (point) (point-at-eol))
13683 (org-fast-tag-insert "Current" current c-face)
13684 (org-set-current-tags-overlay current ov-prefix)
13685 (while (re-search-forward
13687 (setq tg (match-string 1))
13688 (add-text-properties
13689 (match-beginning 1) (match-end 1)
13690 (list 'face
13691 (cond
13692 ((member tg current) c-face)
13693 ((member tg inherited) i-face)
13694 (t (get-text-property (match-beginning 1) 'face))))))
13695 (goto-char (point-min)))))
13696 (org-detach-overlay org-tags-overlay)
13697 (if rtn
13698 (mapconcat 'identity current ":")
13699 nil))))
13701 (defun org-get-tags-string ()
13702 "Get the TAGS string in the current headline."
13703 (unless (org-at-heading-p t)
13704 (error "Not on a heading"))
13705 (save-excursion
13706 (beginning-of-line 1)
13708 (org-match-string-no-properties 1)
13709 "")))
13711 (defun org-get-tags ()
13712 "Get the list of tags specified in the current headline."
13713 (org-split-string (org-get-tags-string) ":"))
13715 (defun org-get-buffer-tags ()
13716 "Get a table of all tags used in the buffer, for completion."
13717 (let (tags)
13718 (save-excursion
13719 (goto-char (point-min))
13720 (while (re-search-forward
13722 (when (equal (char-after (point-at-bol 0)) ?*)
13723 (mapc (lambda (x) (add-to-list 'tags x))
13724 (org-split-string (org-match-string-no-properties 1) ":")))))
13725 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
13726 (mapcar 'list tags)))
13728 ;;;; The mapping API
13730 ;;;###autoload
13731 (defun org-map-entries (func &optional match scope &rest skip)
13732 "Call FUNC at each headline selected by MATCH in SCOPE.
13734 FUNC is a function or a lisp form. The function will be called without
13735 arguments, with the cursor positioned at the beginning of the headline.
13736 The return values of all calls to the function will be collected and
13737 returned as a list.
13739 The call to FUNC will be wrapped into a save-excursion form, so FUNC
13740 does not need to preserve point. After evaluation, the cursor will be
13741 moved to the end of the line (presumably of the headline of the
13742 processed entry) and search continues from there. Under some
13743 circumstances, this may not produce the wanted results. For example,
13744 if you have removed (e.g. archived) the current (sub)tree it could
13745 mean that the next entry will be skipped entirely. In such cases, you
13746 can specify the position from where search should continue by making
13747 FUNC set the variable `org-map-continue-from' to the desired buffer
13748 position.
13750 MATCH is a tags/property/todo match as it is used in the agenda tags view.
13751 Only headlines that are matched by this query will be considered during
13752 the iteration. When MATCH is nil or t, all headlines will be
13753 visited by the iteration.
13755 SCOPE determines the scope of this command. It can be any of:
13757 nil The current buffer, respecting the restriction if any
13758 tree The subtree started with the entry at point
13759 region The entries within the active region, if any
13760 region-start-level
13761 The entries within the active region, but only those at
13762 the same level than the first one.
13763 file The current buffer, without restriction
13764 file-with-archives
13765 The current buffer, and any archives associated with it
13766 agenda All agenda files
13767 agenda-with-archives
13768 All agenda files with any archive files associated with them
13769 \(file1 file2 ...)
13770 If this is a list, all files in the list will be scanned
13772 The remaining args are treated as settings for the skipping facilities of
13773 the scanner. The following items can be given here:
13775 archive skip trees with the archive tag.
13776 comment skip trees with the COMMENT keyword
13777 function or Emacs Lisp form:
13778 will be used as value for `org-agenda-skip-function', so whenever
13779 the function returns t, FUNC will not be called for that
13780 entry and search will continue from the point where the
13781 function leaves it.
13783 If your function needs to retrieve the tags including inherited tags
13784 at the *current* entry, you can use the value of the variable
13785 `org-scanner-tags' which will be much faster than getting the value
13786 with `org-get-tags-at'. If your function gets properties with
13787 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
13788 to t around the call to `org-entry-properties' to get the same speedup.
13789 Note that if your function moves around to retrieve tags and properties at
13790 a *different* entry, you cannot use these techniques."
13791 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
13792 (not (org-region-active-p)))
13793 (let* ((org-agenda-archives-mode nil) ; just to make sure
13794 (org-agenda-skip-archived-trees (memq 'archive skip))
13795 (org-agenda-skip-comment-trees (memq 'comment skip))
13796 (org-agenda-skip-function
13797 (car (org-delete-all '(comment archive) skip)))
13798 (org-tags-match-list-sublevels t)
13799 (start-level (eq scope 'region-start-level))
13800 matcher file res
13801 org-todo-keywords-for-agenda
13802 org-done-keywords-for-agenda
13803 org-todo-keyword-alist-for-agenda
13804 org-drawers-for-agenda
13805 org-tag-alist-for-agenda)
13807 (cond
13808 ((eq match t) (setq matcher t))
13809 ((eq match nil) (setq matcher t))
13810 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
13812 (save-excursion
13813 (save-restriction
13814 (cond ((eq scope 'tree)
13815 (org-back-to-heading t)
13816 (org-narrow-to-subtree)
13817 (setq scope nil))
13818 ((and (or (eq scope 'region) (eq scope 'region-start-level))
13819 (org-region-active-p))
13820 ;; If needed, set start-level to a string like "2"
13821 (when start-level
13822 (save-excursion
13823 (goto-char (region-beginning))
13824 (unless (org-at-heading-p) (outline-next-heading))
13825 (setq start-level (org-current-level))))
13826 (narrow-to-region (region-beginning)
13827 (save-excursion
13828 (goto-char (region-end))
13829 (unless (and (bolp) (org-at-heading-p))
13830 (outline-next-heading))
13831 (point)))
13832 (setq scope nil)))
13834 (if (not scope)
13835 (progn
13836 (org-prepare-agenda-buffers
13837 (list (buffer-file-name (current-buffer))))
13838 (setq res (org-scan-tags func matcher nil start-level)))
13839 ;; Get the right scope
13840 (cond
13841 ((and scope (listp scope) (symbolp (car scope)))
13842 (setq scope (eval scope)))
13843 ((eq scope 'agenda)
13844 (setq scope (org-agenda-files t)))
13845 ((eq scope 'agenda-with-archives)
13846 (setq scope (org-agenda-files t))
13847 (setq scope (org-add-archive-files scope)))
13848 ((eq scope 'file)
13849 (setq scope (list (buffer-file-name))))
13850 ((eq scope 'file-with-archives)
13851 (setq scope (org-add-archive-files (list (buffer-file-name))))))
13852 (org-prepare-agenda-buffers scope)
13853 (while (setq file (pop scope))
13854 (with-current-buffer (org-find-base-buffer-visiting file)
13855 (save-excursion
13856 (save-restriction
13857 (widen)
13858 (goto-char (point-min))
13859 (setq res (append res (org-scan-tags func matcher))))))))))
13860 res)))
13862 ;;;; Properties
13864 ;;; Setting and retrieving properties
13866 (defconst org-special-properties
13867 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
13868 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM")
13869 "The special properties valid in Org-mode.
13871 These are properties that are not defined in the property drawer,
13872 but in some other way.")
13874 (defconst org-default-properties
13875 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
13876 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
13877 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
13878 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
13879 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
13880 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
13881 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
13882 "Some properties that are used by Org-mode for various purposes.
13883 Being in this list makes sure that they are offered for completion.")
13886 "Regular expression matching the first line of a property drawer.")
13889 "Regular expression matching the last line of a property drawer.")
13892 "Regular expression matching the first line of a property drawer.")
13895 "Regular expression matching the first line of a property drawer.")
13897 (defconst org-property-drawer-re
13900 "Matches an entire property drawer.")
13902 (defconst org-clock-drawer-re
13905 "Matches an entire clock drawer.")
13907 (defsubst org-re-property (property)
13908 "Return a regexp matching PROPERTY.
13909 Match group 1 will be set to the value "
13912 (defun org-property-action ()
13913 "Do an action on properties."
13914 (interactive)
13915 (let (c)
13916 (org-at-property-p)
13917 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
13918 (setq c (read-char-exclusive))
13919 (cond
13920 ((equal c ?s)
13921 (call-interactively 'org-set-property))
13922 ((equal c ?d)
13923 (call-interactively 'org-delete-property))
13924 ((equal c ?D)
13925 (call-interactively 'org-delete-property-globally))
13926 ((equal c ?c)
13927 (call-interactively 'org-compute-property-at-point))
13928 (t (error "No such property action %c" c)))))
13930 (defun org-set-effort (&optional value)
13931 "Set the effort property of the current entry.
13932 With numerical prefix arg, use the nth allowed value, 0 stands for the 10th
13933 allowed value."
13934 (interactive "P")
13935 (if (equal value 0) (setq value 10))
13936 (let* ((completion-ignore-case t)
13937 (prop org-effort-property)
13938 (cur (org-entry-get nil prop))
13939 (allowed (org-property-get-allowed-values nil prop 'table))
13940 (existing (mapcar 'list (org-property-values prop)))
13941 rpl
13942 (val (cond
13943 ((stringp value) value)
13944 ((and allowed (integerp value))
13945 (or (car (nth (1- value) allowed))
13946 (car (org-last allowed))))
13947 (allowed
13948 (message "Select 1-9,0, [RET%s]: %s"
13949 (if cur (concat "=" cur) "")
13950 (mapconcat 'car allowed " "))
13951 (setq rpl (read-char-exclusive))
13953 cur
13954 (setq rpl (- rpl ?0))
13955 (if (equal rpl 0) (setq rpl 10))
13956 (if (and (> rpl 0) (<= rpl (length allowed)))
13957 (car (nth (1- rpl) allowed))
13958 (org-completing-read "Effort: " allowed nil))))
13959 (t
13960 (let (org-completion-use-ido org-completion-use-iswitchb)
13961 (org-completing-read
13963 (concat "[" cur "]") "")
13964 ": ")
13965 existing nil nil "" nil cur))))))
13966 (unless (equal (org-entry-get nil prop) val)
13967 (org-entry-put nil prop val))
13968 (message "%s is now %s" prop val)))
13970 (defun org-at-property-p ()
13971 "Is cursor inside a property drawer?"
13972 (save-excursion
13973 (beginning-of-line 1)
13975 (save-match-data ;; Used by calling procedures
13976 (let ((p (point))
13977 (range (unless (org-before-first-heading-p)
13978 (org-get-property-block))))
13979 (and range (<= (car range) p) (< p (cdr range))))))))
13981 (defun org-get-property-block (&optional beg end force)
13982 "Return the (beg . end) range of the body of the property drawer.
13983 BEG and END can be beginning and end of subtree, if not given
13984 they will be found.
13985 If the drawer does not exist and FORCE is non-nil, create the drawer."
13986 (catch 'exit
13987 (save-excursion
13988 (let* ((beg (or beg (progn (org-back-to-heading t) (point))))
13989 (end (or end (progn (outline-next-heading) (point)))))
13990 (goto-char beg)
13991 (if (re-search-forward org-property-start-re end t)
13992 (setq beg (1+ (match-end 0)))
13993 (if force
13994 (save-excursion
13995 (org-insert-property-drawer)
13996 (setq end (progn (outline-next-heading) (point))))
13997 (throw 'exit nil))
13998 (goto-char beg)
13999 (if (re-search-forward org-property-start-re end t)
14000 (setq beg (1+ (match-end 0)))))
14001 (if (re-search-forward org-property-end-re end t)
14002 (setq end (match-beginning 0))
14003 (or force (throw 'exit nil))
14004 (goto-char beg)
14005 (setq end beg)
14006 (org-indent-line-function)
14008 (cons beg end)))))
14010 (defun org-entry-properties (&optional pom which specific)
14011 "Get all properties of the entry at point-or-marker POM.
14012 This includes the TODO keyword, the tags, time strings for deadline,
14013 scheduled, and clocking, and any additional properties defined in the
14014 entry. The return value is an alist, keys may occur multiple times
14015 if the property key was used several times.
14016 POM may also be nil, in which case the current entry is used.
14017 If WHICH is nil or `all', get all properties. If WHICH is
14018 `special' or `standard', only get that subclass. If WHICH
14019 is a string only get exactly this property. SPECIFIC can be a string, the
14020 specific property we are interested in. Specifying it can speed
14021 things up because then unnecessary parsing is avoided."
14022 (setq which (or which 'all))
14023 (org-with-point-at pom
14024 (let ((clockstr (substring org-clock-string 0 -1))
14025 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
14026 (case-fold-search nil)
14027 beg end range props sum-props key key1 value string clocksum)
14028 (save-excursion
14029 (when (condition-case nil
14030 (and (eq major-mode 'org-mode) (org-back-to-heading t))
14031 (error nil))
14032 (setq beg (point))
14033 (setq sum-props (get-text-property (point) 'org-summaries))
14034 (setq clocksum (get-text-property (point) :org-clock-minutes))
14035 (outline-next-heading)
14036 (setq end (point))
14037 (when (memq which '(all special))
14038 ;; Get the special properties, like TODO and tags
14039 (goto-char beg)
14040 (when (and (or (not specific) (string= specific "TODO"))
14041 (looking-at org-todo-line-regexp) (match-end 2))
14042 (push (cons "TODO" (org-match-string-no-properties 2)) props))
14043 (when (and (or (not specific) (string= specific "PRIORITY"))
14044 (looking-at org-priority-regexp))
14045 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
14046 (when (or (not specific) (string= specific "FILE"))
14047 (push (cons "FILE" buffer-file-name) props))
14048 (when (and (or (not specific) (string= specific "TAGS"))
14049 (setq value (org-get-tags-string))
14051 (push (cons "TAGS" value) props))
14052 (when (and (or (not specific) (string= specific "ALLTAGS"))
14053 (setq value (org-get-tags-at)))
14054 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
14055 ":"))
14056 props))
14057 (when (or (not specific) (string= specific "BLOCKED"))
14058 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
14059 (when (or (not specific)
14060 (member specific
14061 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
14062 "TIMESTAMP" "TIMESTAMP_IA")))
14063 (catch 'match
14064 (while (re-search-forward org-maybe-keyword-time-regexp end t)
14065 (setq key (if (match-end 1)
14066 (substring (org-match-string-no-properties 1)
14067 0 -1))
14068 string (if (equal key clockstr)
14069 (org-no-properties
14070 (org-trim
14071 (buffer-substring
14072 (match-beginning 3) (goto-char
14073 (point-at-eol)))))
14074 (substring (org-match-string-no-properties 3)
14075 1 -1)))
14076 ;; Get the correct property name from the key. This is
14077 ;; necessary if the user has configured time keywords.
14078 (setq key1 (concat key ":"))
14079 (cond
14080 ((not key)
14081 (setq key
14082 (if (= (char-after (match-beginning 3)) ?\[)
14083 "TIMESTAMP_IA" "TIMESTAMP")))
14084 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
14085 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
14086 ((equal key1 org-closed-string) (setq key "CLOSED"))
14087 ((equal key1 org-clock-string) (setq key "CLOCK")))
14088 (if (and specific (equal key specific) (not (equal key "CLOCK")))
14089 (progn
14090 (push (cons key string) props)
14091 ;; no need to search further if match is found
14092 (throw 'match t))
14093 (when (or (equal key "CLOCK") (not (assoc key props)))
14094 (push (cons key string) props))))))
14095 )
14097 (when (memq which '(all standard))
14098 ;; Get the standard properties, like :PROP: ...
14099 (setq range (org-get-property-block beg end))
14100 (when range
14101 (goto-char (car range))
14102 (while (re-search-forward
14104 (cdr range) t)
14105 (setq key (org-match-string-no-properties 1)
14106 value (org-trim (or (org-match-string-no-properties 2) "")))
14107 (unless (member key excluded)
14108 (push (cons key (or value "")) props)))))
14109 (if clocksum
14110 (push (cons "CLOCKSUM"
14111 (org-columns-number-to-string (/ (float clocksum) 60.)
14112 'add_times))
14113 props))
14114 (unless (assoc "CATEGORY" props)
14115 (push (cons "CATEGORY" (org-get-category)) props))
14116 (append sum-props (nreverse props)))))))
14118 (defun org-entry-get (pom property &optional inherit literal-nil)
14119 "Get value of PROPERTY for entry at point-or-marker POM.
14120 If INHERIT is non-nil and the entry does not have the property,
14121 then also check higher levels of the hierarchy.
14122 If INHERIT is the symbol `selective', use inheritance only if the setting
14123 in `org-use-property-inheritance' selects PROPERTY for inheritance.
14124 If the property is present but empty, the return value is the empty string.
14125 If the property is not present at all, nil is returned.
14128 do not interpret it as the list atom nil. This is used for inheritance
14130 (org-with-point-at pom
14131 (if (and inherit (if (eq inherit 'selective)
14132 (org-property-inherit-p property)
14133 t))
14134 (org-entry-get-with-inheritance property literal-nil)
14135 (if (member property org-special-properties)
14136 ;; We need a special property. Use `org-entry-properties' to
14137 ;; retrieve it, but specify the wanted property
14138 (cdr (assoc property (org-entry-properties nil 'special property)))
14139 (let ((range (unless (org-before-first-heading-p)
14140 (org-get-property-block))))
14141 (when (and range (goto-char (car range)))
14142 ((lambda (val) (when val (if literal-nil val (org-not-nil val))))
14143 (cond
14144 ((re-search-forward
14145 (org-re-property property) (cdr range) t)
14146 (if (match-end 1) (org-match-string-no-properties 1) ""))
14147 ((re-search-forward
14148 (org-re-property (concat property "+")) (cdr range) t)
14149 (cdr (assoc
14150 property
14151 (org-update-property-plist
14152 (concat property "+")
14153 (if (match-end 1) (org-match-string-no-properties 1) "")
14154 (list (or (assoc property org-file-properties)
14155 (assoc property org-global-properties)
14156 (assoc property org-global-properties-fixed)
14157 ))))))))))))))
14159 (defun org-property-or-variable-value (var &optional inherit)
14160 "Check if there is a property fixing the value of VAR.
14161 If yes, return this value. If not, return the current value of the variable."
14162 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
14164 (read prop)
14165 (symbol-value var))))
14167 (defun org-entry-delete (pom property)
14168 "Delete the property PROPERTY from entry at point-or-marker POM."
14169 (org-with-point-at pom
14170 (if (member property org-special-properties)
14171 nil ; cannot delete these properties.
14172 (let ((range (org-get-property-block)))
14173 (if (and range
14174 (goto-char (car range))
14175 (re-search-forward
14176 (org-re-property property)
14177 (cdr range) t))
14178 (progn
14179 (delete-region (match-beginning 0) (1+ (point-at-eol)))
14180 t)
14181 nil)))))
14183 ;; Multi-values properties are properties that contain multiple values
14184 ;; These values are assumed to be single words, separated by whitespace.
14185 (defun org-entry-add-to-multivalued-property (pom property value)
14186 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
14187 (let* ((old (org-entry-get pom property))
14189 (setq value (org-entry-protect-space value))
14190 (unless (member value values)
14191 (setq values (cons value values))
14192 (org-entry-put pom property
14193 (mapconcat 'identity values " ")))))
14195 (defun org-entry-remove-from-multivalued-property (pom property value)
14196 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
14197 (let* ((old (org-entry-get pom property))
14199 (setq value (org-entry-protect-space value))
14200 (when (member value values)
14201 (setq values (delete value values))
14202 (org-entry-put pom property
14203 (mapconcat 'identity values " ")))))
14205 (defun org-entry-member-in-multivalued-property (pom property value)
14206 "Is VALUE one of 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 (member value values)))
14212 (defun org-entry-get-multivalued-property (pom property)
14213 "Return a list of values in a multivalued property."
14214 (let* ((value (org-entry-get pom property))
14216 (mapcar 'org-entry-restore-space values)))
14218 (defun org-entry-put-multivalued-property (pom property &rest values)
14219 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
14220 VALUES should be a list of strings. Spaces will be protected."
14221 (org-entry-put pom property
14222 (mapconcat 'org-entry-protect-space values " "))
14223 (let* ((value (org-entry-get pom property))
14225 (mapcar 'org-entry-restore-space values)))
14227 (defun org-entry-protect-space (s)
14228 "Protect spaces and newline in string S."
14229 (while (string-match " " s)
14230 (setq s (replace-match "%20" t t s)))
14232 (setq s (replace-match "%0A" t t s)))
14233 s)
14235 (defun org-entry-restore-space (s)
14236 "Restore spaces and newline in string S."
14237 (while (string-match "%20" s)
14238 (setq s (replace-match " " t t s)))
14239 (while (string-match "%0A" s)
14241 s)
14243 (defvar org-entry-property-inherited-from (make-marker)
14244 "Marker pointing to the entry from where a property was inherited.
14245 Each call to `org-entry-get-with-inheritance' will set this marker to the
14246 location of the entry where the inheritance search matched. If there was
14247 no match, the marker will point nowhere.
14248 Note that also `org-entry-get' calls this function, if the INHERIT flag
14249 is set.")
14251 (defun org-entry-get-with-inheritance (property &optional literal-nil)
14252 "Get entry property, and search higher levels if not present.
14253 The search will stop at the first ancestor which has the property defined.
14255 should be considered as undefined (this is the meaning of nil here).
14257 (move-marker org-entry-property-inherited-from nil)
14258 (let (tmp)
14259 (unless (org-before-first-heading-p)
14260 (save-excursion
14261 (save-restriction
14262 (widen)
14263 (catch 'ex
14264 (while t
14265 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
14266 (org-back-to-heading t)
14267 (move-marker org-entry-property-inherited-from (point))
14268 (throw 'ex tmp))
14269 (or (org-up-heading-safe) (throw 'ex nil)))))))
14270 (setq tmp (or tmp
14271 (cdr (assoc property org-file-properties))
14272 (cdr (assoc property org-global-properties))
14273 (cdr (assoc property org-global-properties-fixed))))
14274 (if literal-nil tmp (org-not-nil tmp))))
14276 (defvar org-property-changed-functions nil
14277 "Hook called when the value of a property has changed.
14278 Each hook function should accept two arguments, the name of the property
14279 and the new value.")
14281 (defun org-entry-put (pom property value)
14282 "Set PROPERTY to VALUE for entry at point-or-marker POM."
14283 (org-with-point-at pom
14284 (org-back-to-heading t)
14285 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
14286 range)
14287 (cond
14288 ((equal property "TODO")
14290 (not (member value org-todo-keywords-1)))
14292 (if (or (not value)
14294 (setq value 'none))
14295 (org-todo value)
14296 (org-set-tags nil 'align))
14297 ((equal property "PRIORITY")
14299 (string-to-char value) ?\ ))
14300 (org-set-tags nil 'align))
14301 ((equal property "SCHEDULED")
14302 (if (re-search-forward org-scheduled-time-regexp end t)
14303 (cond
14304 ((eq value 'earlier) (org-timestamp-change -1 'day))
14305 ((eq value 'later) (org-timestamp-change 1 'day))
14306 (t (call-interactively 'org-schedule)))
14307 (call-interactively 'org-schedule)))
14308 ((equal property "DEADLINE")
14309 (if (re-search-forward org-deadline-time-regexp end t)
14310 (cond
14311 ((eq value 'earlier) (org-timestamp-change -1 'day))
14312 ((eq value 'later) (org-timestamp-change 1 'day))
14313 (t (call-interactively 'org-deadline)))
14314 (call-interactively 'org-deadline)))
14315 ((member property org-special-properties)
14316 (error "The %s property can not yet be set with `org-entry-put'"
14317 property))
14318 (t ; a non-special property
14319 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
14320 (setq range (org-get-property-block beg end 'force))
14321 (goto-char (car range))
14322 (if (re-search-forward
14323 (org-re-property property) (cdr range) t)
14324 (progn
14325 (delete-region (match-beginning 0) (match-end 0))
14326 (goto-char (match-beginning 0)))
14327 (goto-char (cdr range))
14329 (backward-char 1)
14330 (org-indent-line-function))
14331 (insert ":" property ":")
14332 (and value (insert " " value))
14333 (org-indent-line-function)))))
14334 (run-hook-with-args 'org-property-changed-functions property value)))
14336 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
14337 "Get all property keys in the current buffer.
14338 With INCLUDE-SPECIALS, also list the special properties that reflect things
14339 like tags and TODO state.
14340 With INCLUDE-DEFAULTS, also include properties that has special meaning
14341 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
14342 and others.
14343 With INCLUDE-COLUMNS, also include property names given in COLUMN
14344 formats in the current buffer."
14345 (let (rtn range cfmt s p)
14346 (save-excursion
14347 (save-restriction
14348 (widen)
14349 (goto-char (point-min))
14350 (while (re-search-forward org-property-start-re nil t)
14351 (setq range (org-get-property-block))
14352 (goto-char (car range))
14353 (while (re-search-forward
14355 (cdr range) t)
14356 (add-to-list 'rtn (org-match-string-no-properties 1)))
14357 (outline-next-heading))))
14359 (when include-specials
14360 (setq rtn (append org-special-properties rtn)))
14362 (when include-defaults
14363 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
14364 (add-to-list 'rtn org-effort-property))
14366 (when include-columns
14367 (save-excursion
14368 (save-restriction
14369 (widen)
14370 (goto-char (point-min))
14371 (while (re-search-forward
14373 nil t)
14374 (setq cfmt (match-string 2) s 0)
14376 cfmt s)
14377 (setq s (match-end 0)
14378 p (match-string 1 cfmt))
14379 (unless (or (equal p "ITEM")
14380 (member p org-special-properties))
14381 (add-to-list 'rtn (match-string 1 cfmt))))))))
14383 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
14385 (defun org-property-values (key)
14386 "Return a list of all values of property KEY in the current buffer."
14387 (save-excursion
14388 (save-restriction
14389 (widen)
14390 (goto-char (point-min))
14391 (let ((re (org-re-property key))
14392 values)
14393 (while (re-search-forward re nil t)
14394 (add-to-list 'values (org-trim (match-string 1))))
14395 (delete "" values)))))
14397 (defun org-insert-property-drawer ()
14398 "Insert a property drawer into the current entry."
14399 (interactive)
14400 (org-back-to-heading t)
14401 (looking-at org-outline-regexp)
14402 (let ((indent (if org-adapt-indentation
14403 (- (match-end 0)(match-beginning 0))
14404 0))
14405 (beg (point))
14407 end hiddenp)
14408 (outline-next-heading)
14409 (setq end (point))
14410 (goto-char beg)
14411 (while (re-search-forward re end t))
14412 (setq hiddenp (outline-invisible-p))
14413 (end-of-line 1)
14416 (if (member (match-string 1) '("CLOCK:" ":END:"))
14417 ;; just skip this line
14418 (beginning-of-line 2)
14419 ;; Drawer start, find the end
14421 (beginning-of-line 1)))
14422 (org-skip-over-state-notes)
14424 (if (eq (char-before) ?*) (forward-char 1))
14426 (beginning-of-line 0)
14427 (org-indent-to-column indent)
14428 (beginning-of-line 2)
14429 (org-indent-to-column indent)
14430 (beginning-of-line 0)
14431 (if hiddenp
14432 (save-excursion
14433 (org-back-to-heading t)
14434 (hide-entry))
14435 (org-flag-drawer t))))
14437 (defvar org-property-set-functions-alist nil
14438 "Property set function alist.
14439 Each entry should have the following format:
14441 (PROPERTY . READ-FUNCTION)
14443 The read function will be called with the same argument as
14444 `org-completing-read'.")
14446 (defun org-set-property-function (property)
14447 "Get the function that should be used to set PROPERTY.
14448 This is computed according to `org-property-set-functions-alist'."
14449 (or (cdr (assoc property org-property-set-functions-alist))
14450 'org-completing-read))
14452 (defun org-read-property-value (property)
14453 "Read PROPERTY value from user."
14454 (let* ((completion-ignore-case t)
14455 (allowed (org-property-get-allowed-values nil property 'table))
14456 (cur (org-entry-get nil property))
14457 (prompt (concat property " value"
14459 (concat " [" cur "]") "") ": "))
14460 (set-function (org-set-property-function property))
14461 (val (if allowed
14462 (funcall set-function prompt allowed nil
14463 (not (get-text-property 0 'org-unrestricted
14464 (caar allowed))))
14465 (let (org-completion-use-ido org-completion-use-iswitchb)
14466 (funcall set-function prompt
14467 (mapcar 'list (org-property-values property))
14468 nil nil "" nil cur)))))
14469 (if (equal val "")
14470 cur
14471 val)))
14473 (defvar org-last-set-property nil)
14474 (defun org-read-property-name ()
14475 "Read a property name."
14476 (let* ((completion-ignore-case t)
14477 (keys (org-buffer-property-keys nil t t))
14478 (default-prop (or (save-excursion
14479 (save-match-data
14480 (beginning-of-line)
14482 (null (string= (match-string 1) "END"))
14483 (match-string 1))))
14484 org-last-set-property))
14485 (property (org-icompleting-read
14486 (concat "Property"
14487 (if default-prop (concat " [" default-prop "]") "")
14488 ": ")
14489 (mapcar 'list keys)
14490 nil nil nil nil
14491 default-prop
14492 )))
14493 (if (member property keys)
14494 property
14495 (or (cdr (assoc (downcase property)
14496 (mapcar (lambda (x) (cons (downcase x) x))
14497 keys)))
14498 property))))
14500 (defun org-set-property (property value)
14501 "In the current entry, set PROPERTY to VALUE.
14502 When called interactively, this will prompt for a property name, offering
14503 completion on existing and default properties. And then it will prompt
14504 for a value, offering completion either on allowed values (via an inherited
14505 xxx_ALL property) or on existing values in other instances of this property
14506 in the current file."
14507 (interactive (list nil nil))
14508 (let* ((property (or property (org-read-property-name)))
14509 (value (or value (org-read-property-value property)))
14510 (fn (assoc property org-properties-postprocess-alist)))
14511 (setq org-last-set-property property)
14512 ;; Possibly postprocess the inserted value:
14513 (when fn (setq value (funcall (cadr fn) value)))
14514 (unless (equal (org-entry-get nil property) value)
14515 (org-entry-put nil property value))))
14517 (defun org-delete-property (property)
14518 "In the current entry, delete PROPERTY."
14519 (interactive
14520 (let* ((completion-ignore-case t)
14521 (prop (org-icompleting-read "Property: "
14522 (org-entry-properties nil 'standard))))
14523 (list prop)))
14524 (message "Property %s %s" property
14525 (if (org-entry-delete nil property)
14526 "deleted"
14527 "was not present in the entry")))
14529 (defun org-delete-property-globally (property)
14530 "Remove PROPERTY globally, from all entries."
14531 (interactive
14532 (let* ((completion-ignore-case t)
14533 (prop (org-icompleting-read
14534 "Globally remove property: "
14535 (mapcar 'list (org-buffer-property-keys)))))
14536 (list prop)))
14537 (save-excursion
14538 (save-restriction
14539 (widen)
14540 (goto-char (point-min))
14541 (let ((cnt 0))
14542 (while (re-search-forward
14543 (org-re-property property)
14544 nil t)
14545 (setq cnt (1+ cnt))
14546 (replace-match ""))
14549 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
14551 (defun org-compute-property-at-point ()
14552 "Compute the property at point.
14553 This looks for an enclosing column format, extracts the operator and
14554 then applies it to the property in the column format's scope."
14555 (interactive)
14556 (unless (org-at-property-p)
14557 (error "Not at a property"))
14558 (let ((prop (org-match-string-no-properties 2)))
14559 (org-columns-get-format-and-top-level)
14560 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
14561 (error "No operator defined for property %s" prop))
14562 (org-columns-compute prop)))
14564 (defvar org-property-allowed-value-functions nil
14565 "Hook for functions supplying allowed values for a specific property.
14566 The functions must take a single argument, the name of the property, and
14568 the values, this means that these values are intended as defaults for
14569 completion, but that other values should be allowed too.
14570 The functions must return nil if they are not responsible for this
14571 property.")
14573 (defun org-property-get-allowed-values (pom property &optional table)
14574 "Get allowed values for the property PROPERTY.
14575 When TABLE is non-nil, return an alist that can directly be used for
14576 completion."
14577 (let (vals)
14578 (cond
14579 ((equal property "TODO")
14580 (setq vals (org-with-point-at pom
14581 (append org-todo-keywords-1 '("")))))
14582 ((equal property "PRIORITY")
14583 (let ((n org-lowest-priority))
14584 (while (>= n org-highest-priority)
14585 (push (char-to-string n) vals)
14586 (setq n (1- n)))))
14587 ((member property org-special-properties))
14588 ((setq vals (run-hook-with-args-until-success
14589 'org-property-allowed-value-functions property)))
14590 (t
14591 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
14593 (setq vals (car (read-from-string (concat "(" vals ")"))))
14594 (setq vals (mapcar (lambda (x)
14595 (cond ((stringp x) x)
14596 ((numberp x) (number-to-string x))
14597 ((symbolp x) (symbol-name x))
14598 (t "???")))
14599 vals)))))
14600 (when (member ":ETC" vals)
14601 (setq vals (remove ":ETC" vals))
14602 (org-add-props (car vals) '(org-unrestricted t)))
14603 (if table (mapcar 'list vals) vals)))
14605 (defun org-property-previous-allowed-value (&optional previous)
14606 "Switch to the next allowed value for this property."
14607 (interactive)
14608 (org-property-next-allowed-value t))
14610 (defun org-property-next-allowed-value (&optional previous)
14611 "Switch to the next allowed value for this property."
14612 (interactive)
14613 (unless (org-at-property-p)
14614 (error "Not at a property"))
14615 (let* ((key (match-string 2))
14616 (value (match-string 3))
14617 (allowed (or (org-property-get-allowed-values (point) key)
14618 (and (member value '("[ ]" "[-]" "[X]"))
14619 '("[ ]" "[X]"))))
14620 nval)
14621 (unless allowed
14622 (error "Allowed values for this property have not been defined"))
14623 (if previous (setq allowed (reverse allowed)))
14624 (if (member value allowed)
14625 (setq nval (car (cdr (member value allowed)))))
14626 (setq nval (or nval (car allowed)))
14627 (if (equal nval value)
14628 (error "Only one allowed value for this property"))
14629 (org-at-property-p)
14630 (replace-match (concat " :" key ": " nval) t t)
14631 (org-indent-line-function)
14632 (beginning-of-line 1)
14634 (run-hook-with-args 'org-property-changed-functions key nval)))
14636 (defun org-find-olp (path &optional this-buffer)
14637 "Return a marker pointing to the entry at outline path OLP.
14638 If anything goes wrong, throw an error.
14639 You can wrap this call to catch the error like this:
14641 (condition-case msg
14642 (org-mobile-locate-entry (match-string 4))
14643 (error (nth 1 msg)))
14645 The return value will then be either a string with the error message,
14646 or a marker if everything is OK.
14648 If THIS-BUFFER is set, the outline path does not contain a file,
14649 only headings."
14650 (let* ((file (if this-buffer buffer-file-name (pop path)))
14651 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
14652 (level 1)
14653 (lmin 1)
14654 (lmax 1)
14655 limit re end found pos heading cnt flevel)
14656 (unless buffer (error "File not found :%s" file))
14657 (with-current-buffer buffer
14658 (save-excursion
14659 (save-restriction
14660 (widen)
14661 (setq limit (point-max))
14662 (goto-char (point-min))
14663 (while (setq heading (pop path))
14664 (setq re (format org-complex-heading-regexp-format
14665 (regexp-quote heading)))
14666 (setq cnt 0 pos (point))
14667 (while (re-search-forward re end t)
14668 (setq level (- (match-end 1) (match-beginning 1)))
14669 (if (and (>= level lmin) (<= level lmax))
14670 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
14671 (when (= cnt 0) (error "Heading not found on level %d: %s"
14672 lmax heading))
14673 (when (> cnt 1) (error "Heading not unique on level %d: %s"
14674 lmax heading))
14675 (goto-char found)
14676 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
14677 (setq end (save-excursion (org-end-of-subtree t t))))
14678 (when (org-at-heading-p)
14679 (move-marker (make-marker) (point))))))))
14681 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
14682 "Find node HEADING in BUFFER.
14683 Return a marker to the heading if it was found, or nil if not.
14684 If POS-ONLY is set, return just the position instead of a marker.
14686 The heading text must match exact, but it may have a TODO keyword,
14687 a priority cookie and tags in the standard locations."
14688 (with-current-buffer (or buffer (current-buffer))
14689 (save-excursion
14690 (save-restriction
14691 (widen)
14692 (goto-char (point-min))
14693 (let (case-fold-search)
14694 (if (re-search-forward
14695 (format org-complex-heading-regexp-format
14696 (regexp-quote heading)) nil t)
14697 (if pos-only
14698 (match-beginning 0)
14699 (move-marker (make-marker) (match-beginning 0)))))))))
14701 (defun org-find-exact-heading-in-directory (heading &optional dir)
14702 "Find Org node headline HEADING in all .org files in directory DIR.
14703 When the target headline is found, return a marker to this location."
14704 (let ((files (directory-files (or dir default-directory)
14706 file visiting m buffer)
14707 (catch 'found
14708 (while (setq file (pop files))
14709 (message "trying %s" file)
14710 (setq visiting (org-find-base-buffer-visiting file))
14711 (setq buffer (or visiting (find-file-noselect file)))
14712 (setq m (org-find-exact-headline-in-buffer
14713 heading buffer))
14714 (when (and (not m) (not visiting)) (kill-buffer buffer))
14715 (and m (throw 'found m))))))
14717 (defun org-find-entry-with-id (ident)
14718 "Locate the entry that contains the ID property with exact value IDENT.
14719 IDENT can be a string, a symbol or a number, this function will search for
14720 the string representation of it.
14721 Return the position where this entry starts, or nil if there is no such entry."
14722 (interactive "sID: ")
14723 (let ((id (cond
14724 ((stringp ident) ident)
14725 ((symbol-name ident) (symbol-name ident))
14726 ((numberp ident) (number-to-string ident))
14727 (t (error "IDENT %s must be a string, symbol or number" ident))))
14728 (case-fold-search nil))
14729 (save-excursion
14730 (save-restriction
14731 (widen)
14732 (goto-char (point-min))
14733 (when (re-search-forward
14735 nil t)
14736 (org-back-to-heading t)
14737 (point))))))
14739 ;;;; Timestamps
14741 (defvar org-last-changed-timestamp nil)
14742 (defvar org-last-inserted-timestamp nil
14743 "The last time stamp inserted with `org-insert-time-stamp'.")
14744 (defvar org-time-was-given) ; dynamically scoped parameter
14745 (defvar org-end-time-was-given) ; dynamically scoped parameter
14746 (defvar org-ts-what) ; dynamically scoped parameter
14748 (defun org-time-stamp (arg &optional inactive)
14749 "Prompt for a date/time and insert a time stamp.
14750 If the user specifies a time like HH:MM, or if this command is called
14751 with a prefix argument, the time stamp will contain date and time.
14752 Otherwise, only the date will be included. All parts of a date not
14753 specified by the user will be filled in from the current date/time.
14754 So if you press just return without typing anything, the time stamp
14755 will represent the current date/time. If there is already a timestamp
14756 at the cursor, it will be modified."
14757 (interactive "P")
14758 (let* ((ts nil)
14759 (default-time
14760 ;; Default time is either today, or, when entering a range,
14761 ;; the range start.
14762 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
14763 (save-excursion
14764 (re-search-backward
14766 (- (point) 20) t)))
14767 (apply 'encode-time (org-parse-time-string (match-string 1)))
14768 (current-time)))
14769 (default-input (and ts (org-get-compact-tod ts)))
14770 (repeater (save-excursion
14771 (save-match-data
14772 (beginning-of-line)
14773 (when (re-search-forward
14775 (save-excursion (progn (end-of-line) (point))) t)
14776 (match-string 0)))))
14777 org-time-was-given org-end-time-was-given time)
14778 (cond
14779 ((and (org-at-timestamp-p t)
14780 (memq last-command '(org-time-stamp org-time-stamp-inactive))
14781 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
14782 (insert "--")
14783 (setq time (let ((this-command this-command))
14784 (org-read-date arg 'totime nil nil
14785 default-time default-input)))
14786 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
14787 ((org-at-timestamp-p t)
14788 (setq time (let ((this-command this-command))
14789 (org-read-date arg 'totime nil nil default-time default-input)))
14790 (when (org-at-timestamp-p t) ; just to get the match data
14791 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
14792 (replace-match "")
14793 (setq org-last-changed-timestamp
14794 (org-insert-time-stamp
14795 time (or org-time-was-given arg)
14796 inactive nil nil (list org-end-time-was-given)))
14797 (when repeater (goto-char (1- (point))) (insert " " repeater)
14798 (setq org-last-changed-timestamp
14799 (concat (substring org-last-inserted-timestamp 0 -1)
14800 " " repeater ">"))))
14801 (message "Timestamp updated"))
14802 (t
14803 (setq time (let ((this-command this-command))
14804 (org-read-date arg 'totime nil nil default-time default-input)))
14805 (org-insert-time-stamp time (or org-time-was-given arg) inactive
14806 nil nil (list org-end-time-was-given))))))
14808 ;; FIXME: can we use this for something else, like computing time differences?
14809 (defun org-get-compact-tod (s)
14810 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
14811 (let* ((t1 (match-string 1 s))
14812 (h1 (string-to-number (match-string 2 s)))
14813 (m1 (string-to-number (match-string 3 s)))
14814 (t2 (and (match-end 4) (match-string 5 s)))
14815 (h2 (and t2 (string-to-number (match-string 6 s))))
14816 (m2 (and t2 (string-to-number (match-string 7 s))))
14817 dh dm)
14818 (if (not t2)
14819 t1
14820 (setq dh (- h2 h1) dm (- m2 m1))
14821 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
14822 (concat t1 "+" (number-to-string dh)
14823 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
14825 (defun org-time-stamp-inactive (&optional arg)
14826 "Insert an inactive time stamp.
14827 An inactive time stamp is enclosed in square brackets instead of angle
14828 brackets. It is inactive in the sense that it does not trigger agenda entries,
14829 does not link to the calendar and cannot be changed with the S-cursor keys.
14830 So these are more for recording a certain time/date."
14831 (interactive "P")
14832 (org-time-stamp arg 'inactive))
14834 (defvar org-date-ovl (make-overlay 1 1))
14835 (overlay-put org-date-ovl 'face 'org-warning)
14836 (org-detach-overlay org-date-ovl)
14838 (defvar org-ans1) ; dynamically scoped parameter
14839 (defvar org-ans2) ; dynamically scoped parameter
14841 (defvar org-plain-time-of-day-regexp) ; defined below
14843 (defvar org-overriding-default-time nil) ; dynamically scoped
14844 (defvar org-read-date-overlay nil)
14845 (defvar org-dcst nil) ; dynamically scoped
14846 (defvar org-read-date-history nil)
14847 (defvar org-read-date-final-answer nil)
14848 (defvar org-read-date-analyze-futurep nil)
14849 (defvar org-read-date-analyze-forced-year nil)
14851 (defun org-read-date (&optional with-time to-time from-string prompt
14852 default-time default-input)
14853 "Read a date, possibly a time, and make things smooth for the user.
14854 The prompt will suggest to enter an ISO date, but you can also enter anything
14855 which will at least partially be understood by `parse-time-string'.
14856 Unrecognized parts of the date will default to the current day, month, year,
14857 hour and minute. If this command is called to replace a timestamp at point,
14858 or to enter the second timestamp of a range, the default time is taken
14859 from the existing stamp. Furthermore, the command prefers the future,
14860 so if you are giving a date where the year is not given, and the day-month
14861 combination is already past in the current year, it will assume you
14862 mean next year. For details, see the manual. A few examples:
14864 3-2-5 --> 2003-02-05
14865 feb 15 --> currentyear-02-15
14866 2/15 --> currentyear-02-15
14867 sep 12 9 --> 2009-09-12
14868 12:45 --> today 12:45
14869 22 sept 0:34 --> currentyear-09-22 0:34
14870 12 --> currentyear-currentmonth-12
14871 Fri --> nearest Friday (today or later)
14872 etc.
14874 Furthermore you can specify a relative date by giving, as the *first* thing
14875 in the input: a plus/minus sign, a number and a letter [dwmy] to indicate
14876 change in days weeks, months, years.
14877 With a single plus or minus, the date is relative to today. With a double
14878 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
14879 +4d --> four days from today
14880 +4 --> same as above
14881 +2w --> two weeks from today
14882 ++5 --> five days from default date
14884 The function understands only English month and weekday abbreviations,
14885 but this can be configured with the variables `parse-time-months' and
14886 `parse-time-weekdays'.
14888 While prompting, a calendar is popped up - you can also select the
14889 date with the mouse (button 1). The calendar shows a period of three
14890 months. To scroll it to other months, use the keys `>' and `<'.
14891 If you don't like the calendar, turn it off with
14892 \(setq org-read-date-popup-calendar nil)
14894 With optional argument TO-TIME, the date will immediately be converted
14895 to an internal time.
14896 With an optional argument WITH-TIME, the prompt will suggest to also
14897 insert a time. Note that when WITH-TIME is not set, you can still
14898 enter a time, and this function will inform the calling routine about
14899 this change. The calling routine may then choose to change the format
14900 used to insert the time stamp into the buffer to include the time.
14901 With optional argument FROM-STRING, read from this string instead from
14902 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
14903 the time/date that is used for everything that is not specified by the
14904 user."
14905 (require 'parse-time)
14906 (let* ((org-time-stamp-rounding-minutes
14907 (if (equal with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
14908 (org-dcst org-display-custom-times)
14909 (ct (org-current-time))
14910 (def (or org-overriding-default-time default-time ct))
14911 (defdecode (decode-time def))
14912 (dummy (progn
14913 (when (< (nth 2 defdecode) org-extend-today-until)
14914 (setcar (nthcdr 2 defdecode) -1)
14915 (setcar (nthcdr 1 defdecode) 59)
14916 (setq def (apply 'encode-time defdecode)
14917 defdecode (decode-time def)))))
14918 (calendar-frame-setup nil)
14919 (calendar-setup nil)
14920 (calendar-move-hook nil)
14921 (calendar-view-diary-initially-flag nil)
14922 (calendar-view-holidays-initially-flag nil)
14923 (timestr (format-time-string
14924 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") def))
14925 (prompt (concat (if prompt (concat prompt " ") "")
14926 (format "Date+time [%s]: " timestr)))
14927 ans (org-ans0 "") org-ans1 org-ans2 final)
14929 (cond
14930 (from-string (setq ans from-string))
14931 (org-read-date-popup-calendar
14932 (save-excursion
14933 (save-window-excursion
14934 (calendar)
14935 (unwind-protect
14936 (progn
14937 (calendar-forward-day (- (time-to-days def)
14938 (calendar-absolute-from-gregorian
14939 (calendar-current-date))))
14940 (org-eval-in-calendar nil t)
14941 (let* ((old-map (current-local-map))
14942 (map (copy-keymap calendar-mode-map))
14943 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
14944 (org-defkey map (kbd "RET") 'org-calendar-select)
14945 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
14946 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
14947 (org-defkey minibuffer-local-map [(meta shift left)]
14948 (lambda () (interactive)
14949 (org-eval-in-calendar '(calendar-backward-month 1))))
14950 (org-defkey minibuffer-local-map [(meta shift right)]
14951 (lambda () (interactive)
14952 (org-eval-in-calendar '(calendar-forward-month 1))))
14953 (org-defkey minibuffer-local-map [(meta shift up)]
14954 (lambda () (interactive)
14955 (org-eval-in-calendar '(calendar-backward-year 1))))
14956 (org-defkey minibuffer-local-map [(meta shift down)]
14957 (lambda () (interactive)
14958 (org-eval-in-calendar '(calendar-forward-year 1))))
14959 (org-defkey minibuffer-local-map [?\e (shift left)]
14960 (lambda () (interactive)
14961 (org-eval-in-calendar '(calendar-backward-month 1))))
14962 (org-defkey minibuffer-local-map [?\e (shift right)]
14963 (lambda () (interactive)
14964 (org-eval-in-calendar '(calendar-forward-month 1))))
14965 (org-defkey minibuffer-local-map [?\e (shift up)]
14966 (lambda () (interactive)
14967 (org-eval-in-calendar '(calendar-backward-year 1))))
14968 (org-defkey minibuffer-local-map [?\e (shift down)]
14969 (lambda () (interactive)
14970 (org-eval-in-calendar '(calendar-forward-year 1))))
14971 (org-defkey minibuffer-local-map [(shift up)]
14972 (lambda () (interactive)
14973 (org-eval-in-calendar '(calendar-backward-week 1))))
14974 (org-defkey minibuffer-local-map [(shift down)]
14975 (lambda () (interactive)
14976 (org-eval-in-calendar '(calendar-forward-week 1))))
14977 (org-defkey minibuffer-local-map [(shift left)]
14978 (lambda () (interactive)
14979 (org-eval-in-calendar '(calendar-backward-day 1))))
14980 (org-defkey minibuffer-local-map [(shift right)]
14981 (lambda () (interactive)
14982 (org-eval-in-calendar '(calendar-forward-day 1))))
14983 (org-defkey minibuffer-local-map ">"
14984 (lambda () (interactive)
14985 (org-eval-in-calendar '(scroll-calendar-left 1))))
14986 (org-defkey minibuffer-local-map "<"
14987 (lambda () (interactive)
14988 (org-eval-in-calendar '(scroll-calendar-right 1))))
14989 (org-defkey minibuffer-local-map "\C-v"
14990 (lambda () (interactive)
14991 (org-eval-in-calendar
14992 '(calendar-scroll-left-three-months 1))))
14993 (org-defkey minibuffer-local-map "\M-v"
14994 (lambda () (interactive)
14995 (org-eval-in-calendar
14996 '(calendar-scroll-right-three-months 1))))
14997 (run-hooks 'org-read-date-minibuffer-setup-hook)
14998 (unwind-protect
14999 (progn
15000 (use-local-map map)
15001 (add-hook 'post-command-hook 'org-read-date-display)
15002 (setq org-ans0 (read-string prompt default-input
15003 'org-read-date-history nil))
15004 ;; org-ans0: from prompt
15005 ;; org-ans1: from mouse click
15006 ;; org-ans2: from calendar motion
15007 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
15008 (remove-hook 'post-command-hook 'org-read-date-display)
15009 (use-local-map old-map)
15010 (when org-read-date-overlay
15011 (delete-overlay org-read-date-overlay)
15012 (setq org-read-date-overlay nil)))))
15013 (bury-buffer "*Calendar*")))))
15015 (t ; Naked prompt only
15016 (unwind-protect
15017 (setq ans (read-string prompt default-input
15018 'org-read-date-history timestr))
15019 (when org-read-date-overlay
15020 (delete-overlay org-read-date-overlay)
15021 (setq org-read-date-overlay nil)))))
15023 (setq final (org-read-date-analyze ans def defdecode))
15025 (when org-read-date-analyze-forced-year
15026 (message "Year was forced into %s"
15027 (if org-read-date-force-compatible-dates
15028 "compatible range (1970-2037)"
15029 "range representable on this machine"))
15030 (ding))
15032 ;; One round trip to get rid of 34th of August and stuff like that....
15033 (setq final (decode-time (apply 'encode-time final)))
15035 (setq org-read-date-final-answer ans)
15037 (if to-time
15038 (apply 'encode-time final)
15039 (if (and (boundp 'org-time-was-given) org-time-was-given)
15040 (format "%04d-%02d-%02d %02d:%02d"
15041 (nth 5 final) (nth 4 final) (nth 3 final)
15042 (nth 2 final) (nth 1 final))
15043 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
15045 (defvar def)
15046 (defvar defdecode)
15047 (defvar with-time)
15048 (defun org-read-date-display ()
15049 "Display the current date prompt interpretation in the minibuffer."
15050 (when org-read-date-display-live
15051 (when org-read-date-overlay
15052 (delete-overlay org-read-date-overlay))
15053 (let ((p (point)))
15054 (end-of-line 1)
15055 (while (not (equal (buffer-substring
15056 (max (point-min) (- (point) 4)) (point))
15057 " "))
15058 (insert " "))
15059 (goto-char p))
15060 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
15061 " " (or org-ans1 org-ans2)))
15062 (org-end-time-was-given nil)
15063 (f (org-read-date-analyze ans def defdecode))
15064 (fmts (if org-dcst
15065 org-time-stamp-custom-formats
15066 org-time-stamp-formats))
15067 (fmt (if (or with-time
15068 (and (boundp 'org-time-was-given) org-time-was-given))
15069 (cdr fmts)
15070 (car fmts)))
15071 (txt (concat "=> " (format-time-string fmt (apply 'encode-time f)))))
15072 (when (and org-end-time-was-given
15073 (string-match org-plain-time-of-day-regexp txt))
15074 (setq txt (concat (substring txt 0 (match-end 0)) "-"
15075 org-end-time-was-given
15076 (substring txt (match-end 0)))))
15077 (when org-read-date-analyze-futurep
15078 (setq txt (concat txt " (=>F)")))
15079 (setq org-read-date-overlay
15080 (make-overlay (1- (point-at-eol)) (point-at-eol)))
15081 (org-overlay-display org-read-date-overlay txt 'secondary-selection))))
15083 (defun org-read-date-analyze (ans def defdecode)
15084 "Analyze the combined answer of the date prompt."
15085 ;; FIXME: cleanup and comment
15086 (let ((nowdecode (decode-time (current-time)))
15087 delta deltan deltaw deltadef year month day
15088 hour minute second wday pm h2 m2 tl wday1
15089 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
15090 (setq org-read-date-analyze-futurep nil
15091 org-read-date-analyze-forced-year nil)
15093 (setq ans "+0"))
15095 (when (setq delta (org-read-date-get-relative ans (current-time) def))
15096 (setq ans (replace-match "" t t ans)
15097 deltan (car delta)
15098 deltaw (nth 1 delta)
15099 deltadef (nth 2 delta)))
15101 ;; Check if there is an iso week date in there
15102 ;; If yes, store the info and postpone interpreting it until the rest
15103 ;; of the parsing is done
15104 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
15105 (setq iso-year (if (match-end 1)
15106 (org-small-year-to-year
15107 (string-to-number (match-string 1 ans))))
15108 iso-weekday (if (match-end 3)
15109 (string-to-number (match-string 3 ans)))
15110 iso-week (string-to-number (match-string 2 ans)))
15111 (setq ans (replace-match "" t t ans)))
15113 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
15114 (when (string-match
15116 (setq year (if (match-end 2)
15117 (string-to-number (match-string 2 ans))
15118 (progn (setq kill-year t)
15119 (string-to-number (format-time-string "%Y"))))
15120 month (string-to-number (match-string 3 ans))
15121 day (string-to-number (match-string 4 ans)))
15122 (if (< year 100) (setq year (+ 2000 year)))
15124 t nil ans)))
15126 ;; Help matching dottet european dates
15127 (when (string-match
15128 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\. ?\\([1-9][0-9][0-9][0-9]\\)?" ans)
15129 (setq year (if (match-end 3)
15130 (string-to-number (match-string 3 ans))
15131 (progn (setq kill-year t)
15132 (string-to-number (format-time-string "%Y"))))
15133 day (string-to-number (match-string 1 ans))
15134 month (string-to-number (match-string 2 ans))
15136 t nil ans)))
15138 ;; Help matching american dates, like 5/30 or 5/30/7
15139 (when (string-match
15140 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
15141 (setq year (if (match-end 4)
15142 (string-to-number (match-string 4 ans))
15143 (progn (setq kill-year t)
15144 (string-to-number (format-time-string "%Y"))))
15145 month (string-to-number (match-string 1 ans))
15146 day (string-to-number (match-string 2 ans)))
15147 (if (< year 100) (setq year (+ 2000 year)))
15149 t nil ans)))
15150 ;; Help matching am/pm times, because `parse-time-string' does not do that.
15151 ;; If there is a time with am/pm, and *no* time without it, we convert
15152 ;; so that matching will be successful.
15153 (loop for i from 1 to 2 do ; twice, for end time as well
15156 (setq hour (string-to-number (match-string 1 ans))
15157 minute (if (match-end 3)
15158 (string-to-number (match-string 3 ans))
15159 0)
15160 pm (equal ?p
15161 (string-to-char (downcase (match-string 4 ans)))))
15162 (if (and (= hour 12) (not pm))
15163 (setq hour 0)
15164 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
15165 (setq ans (replace-match (format "%02d:%02d" hour minute)
15166 t t ans))))
15168 ;; Check if a time range is given as a duration
15169 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
15170 (setq hour (string-to-number (match-string 1 ans))
15171 h2 (+ hour (string-to-number (match-string 3 ans)))
15172 minute (string-to-number (match-string 2 ans))
15173 m2 (+ minute (if (match-end 5) (string-to-number
15174 (match-string 5 ans))0)))
15175 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
15176 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
15177 t t ans)))
15179 ;; Check if there is a time range
15180 (when (boundp 'org-end-time-was-given)
15181 (setq org-time-was-given nil)
15182 (when (and (string-match org-plain-time-of-day-regexp ans)
15183 (match-end 8))
15184 (setq org-end-time-was-given (match-string 8 ans))
15185 (setq ans (concat (substring ans 0 (match-beginning 7))
15186 (substring ans (match-end 7))))))
15188 (setq tl (parse-time-string ans)
15189 day (or (nth 3 tl) (nth 3 defdecode))
15190 month (or (nth 4 tl)
15191 (if (and org-read-date-prefer-future
15192 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
15193 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
15194 (nth 4 defdecode)))
15195 year (or (and (not kill-year) (nth 5 tl))
15196 (if (and org-read-date-prefer-future
15197 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
15198 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
15199 (nth 5 defdecode)))
15200 hour (or (nth 2 tl) (nth 2 defdecode))
15201 minute (or (nth 1 tl) (nth 1 defdecode))
15202 second (or (nth 0 tl) 0)
15203 wday (nth 6 tl))
15205 (when (and (eq org-read-date-prefer-future 'time)
15206 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
15207 (equal day (nth 3 nowdecode))
15208 (equal month (nth 4 nowdecode))
15209 (equal year (nth 5 nowdecode))
15210 (nth 2 tl)
15211 (or (< (nth 2 tl) (nth 2 nowdecode))
15212 (and (= (nth 2 tl) (nth 2 nowdecode))
15213 (nth 1 tl)
15214 (< (nth 1 tl) (nth 1 nowdecode)))))
15215 (setq day (1+ day)
15216 futurep t))
15218 ;; Special date definitions below
15219 (cond
15220 (iso-week
15221 ;; There was an iso week
15222 (require 'cal-iso)
15223 (setq futurep nil)
15224 (setq year (or iso-year year)
15225 day (or iso-weekday wday 1)
15226 wday nil ; to make sure that the trigger below does not match
15227 iso-date (calendar-gregorian-from-absolute
15228 (calendar-absolute-from-iso
15229 (list iso-week day year))))
15230 ; FIXME: Should we also push ISO weeks into the future?
15231 ; (when (and org-read-date-prefer-future
15232 ; (not iso-year)
15233 ; (< (calendar-absolute-from-gregorian iso-date)
15234 ; (time-to-days (current-time))))
15235 ; (setq year (1+ year)
15236 ; iso-date (calendar-gregorian-from-absolute
15237 ; (calendar-absolute-from-iso
15238 ; (list iso-week day year)))))
15239 (setq month (car iso-date)
15240 year (nth 2 iso-date)
15241 day (nth 1 iso-date)))
15242 (deltan
15243 (setq futurep nil)
15244 (unless deltadef
15245 (let ((now (decode-time (current-time))))
15246 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
15247 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
15248 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
15249 ((equal deltaw "m") (setq month (+ month deltan)))
15250 ((equal deltaw "y") (setq year (+ year deltan)))))
15251 ((and wday (not (nth 3 tl)))
15252 (setq futurep nil)
15253 ;; Weekday was given, but no day, so pick that day in the week
15254 ;; on or after the derived date.
15255 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
15256 (unless (equal wday wday1)
15257 (setq day (+ day (% (- wday wday1 -7) 7))))))
15258 (if (and (boundp 'org-time-was-given)
15259 (nth 2 tl))
15260 (setq org-time-was-given t))
15261 (if (< year 100) (setq year (+ 2000 year)))
15262 ;; Check of the date is representable
15263 (if org-read-date-force-compatible-dates
15264 (progn
15265 (if (< year 1970)
15266 (setq year 1970 org-read-date-analyze-forced-year t))
15267 (if (> year 2037)
15268 (setq year 2037 org-read-date-analyze-forced-year t)))
15269 (condition-case nil
15270 (ignore (encode-time second minute hour day month year))
15271 (error
15272 (setq year (nth 5 defdecode))
15273 (setq org-read-date-analyze-forced-year t))))
15274 (setq org-read-date-analyze-futurep futurep)
15275 (list second minute hour day month year)))
15277 (defvar parse-time-weekdays)
15279 (defun org-read-date-get-relative (s today default)
15280 "Check string S for special relative date string.
15281 TODAY and DEFAULT are internal times, for today and for a default.
15282 Return shift list (N what def-flag)
15284 N is the number of WHATs to shift.
15285 DEF-FLAG is t when a double ++ or -- indicates shift relative to
15286 the DEFAULT date rather than TODAY."
15287 (require 'parse-time)
15288 (when (and
15289 (string-match
15290 (concat
15295 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
15296 (let* ((dir (if (> (match-end 1) (match-beginning 1))
15297 (string-to-char (substring (match-string 1 s) -1))
15298 ?+))
15299 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
15300 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
15301 (what (if (match-end 3) (match-string 3 s) "d"))
15302 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
15303 (date (if rel default today))
15304 (wday (nth 6 (decode-time date)))
15305 delta)
15306 (if wday1
15307 (progn
15308 (setq delta (mod (+ 7 (- wday1 wday)) 7))
15309 (if (= dir ?-) (setq delta (- delta 7)))
15310 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
15311 (list delta "d" rel))
15312 (list (* n (if (= dir ?-) -1 1)) what rel)))))
15314 (defun org-order-calendar-date-args (arg1 arg2 arg3)
15315 "Turn a user-specified date into the internal representation.
15316 The internal representation needed by the calendar is (month day year).
15317 This is a wrapper to handle the brain-dead convention in calendar that
15318 user function argument order change dependent on argument order."
15319 (if (boundp 'calendar-date-style)
15320 (cond
15321 ((eq calendar-date-style 'american)
15322 (list arg1 arg2 arg3))
15323 ((eq calendar-date-style 'european)
15324 (list arg2 arg1 arg3))
15325 ((eq calendar-date-style 'iso)
15326 (list arg2 arg3 arg1)))
15327 (with-no-warnings ;; european-calendar-style is obsolete as of version 23.1
15328 (if (org-bound-and-true-p european-calendar-style)
15329 (list arg2 arg1 arg3)
15330 (list arg1 arg2 arg3)))))
15332 (defun org-eval-in-calendar (form &optional keepdate)
15333 "Eval FORM in the calendar window and return to current window.
15334 Also, store the cursor date in variable org-ans2."
15335 (let ((sf (selected-frame))
15336 (sw (selected-window)))
15337 (select-window (get-buffer-window "*Calendar*" t))
15338 (eval form)
15339 (when (and (not keepdate) (calendar-cursor-to-date))
15340 (let* ((date (calendar-cursor-to-date))
15341 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15342 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
15343 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
15344 (select-window sw)
15345 (org-select-frame-set-input-focus sf)))
15347 (defun org-calendar-select ()
15348 "Return to `org-read-date' with the date currently selected.
15349 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15350 (interactive)
15351 (when (calendar-cursor-to-date)
15352 (let* ((date (calendar-cursor-to-date))
15353 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15354 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15355 (if (active-minibuffer-window) (exit-minibuffer))))
15357 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
15358 "Insert a date stamp for the date given by the internal TIME.
15359 WITH-HM means use the stamp format that includes the time of the day.
15360 INACTIVE means use square brackets instead of angular ones, so that the
15361 stamp will not contribute to the agenda.
15362 PRE and POST are optional strings to be inserted before and after the
15363 stamp.
15364 The command returns the inserted time stamp."
15365 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
15366 stamp)
15367 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
15368 (insert-before-markers (or pre ""))
15369 (when (listp extra)
15370 (setq extra (car extra))
15371 (if (and (stringp extra)
15373 (setq extra (format "-%02d:%02d"
15374 (string-to-number (match-string 1 extra))
15375 (string-to-number (match-string 2 extra))))
15376 (setq extra nil)))
15377 (when extra
15378 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
15379 (insert-before-markers (setq stamp (format-time-string fmt time)))
15380 (insert-before-markers (or post ""))
15381 (setq org-last-inserted-timestamp stamp)))
15383 (defun org-toggle-time-stamp-overlays ()
15384 "Toggle the use of custom time stamp formats."
15385 (interactive)
15386 (setq org-display-custom-times (not org-display-custom-times))
15387 (unless org-display-custom-times
15388 (let ((p (point-min)) (bmp (buffer-modified-p)))
15389 (while (setq p (next-single-property-change p 'display))
15390 (if (and (get-text-property p 'display)
15391 (eq (get-text-property p 'face) 'org-date))
15392 (remove-text-properties
15393 p (setq p (next-single-property-change p 'display))
15394 '(display t))))
15395 (set-buffer-modified-p bmp)))
15396 (if (featurep 'xemacs)
15397 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
15398 (org-restart-font-lock)
15399 (setq org-table-may-need-update t)
15400 (if org-display-custom-times
15401 (message "Time stamps are overlaid with custom format")
15402 (message "Time stamp overlays removed")))
15404 (defun org-display-custom-time (beg end)
15405 "Overlay modified time stamp format over timestamp between BEG and END."
15406 (let* ((ts (buffer-substring beg end))
15407 t1 w1 with-hm tf time str w2 (off 0))
15408 (save-match-data
15409 (setq t1 (org-parse-time-string ts t))
15410 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)?\\'" ts)
15411 (setq off (- (match-end 0) (match-beginning 0)))))
15412 (setq end (- end off))
15413 (setq w1 (- end beg)
15414 with-hm (and (nth 1 t1) (nth 2 t1))
15415 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
15416 time (org-fix-decoded-time t1)
15417 str (org-add-props
15418 (format-time-string
15419 (substring tf 1 -1) (apply 'encode-time time))
15420 nil 'mouse-face 'highlight)
15421 w2 (length str))
15422 (if (not (= w2 w1))
15423 (add-text-properties (1+ beg) (+ 2 beg)
15424 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
15425 (if (featurep 'xemacs)
15426 (progn
15427 (put-text-property beg end 'invisible t)
15428 (put-text-property beg end 'end-glyph (make-glyph str)))
15429 (put-text-property beg end 'display str))))
15431 (defun org-translate-time (string)
15432 "Translate all timestamps in STRING to custom format.
15433 But do this only if the variable `org-display-custom-times' is set."
15434 (when org-display-custom-times
15435 (save-match-data
15436 (let* ((start 0)
15437 (re org-ts-regexp-both)
15438 t1 with-hm inactive tf time str beg end)
15439 (while (setq start (string-match re string start))
15440 (setq beg (match-beginning 0)
15441 end (match-end 0)
15442 t1 (save-match-data
15443 (org-parse-time-string (substring string beg end) t))
15444 with-hm (and (nth 1 t1) (nth 2 t1))
15445 inactive (equal (substring string beg (1+ beg)) "[")
15446 tf (funcall (if with-hm 'cdr 'car)
15447 org-time-stamp-custom-formats)
15448 time (org-fix-decoded-time t1)
15449 str (format-time-string
15450 (concat
15451 (if inactive "[" "<") (substring tf 1 -1)
15452 (if inactive "]" ">"))
15453 (apply 'encode-time time))
15454 string (replace-match str t t string)
15455 start (+ start (length str)))))))
15456 string)
15458 (defun org-fix-decoded-time (time)
15459 "Set 0 instead of nil for the first 6 elements of time.
15460 Don't touch the rest."
15461 (let ((n 0))
15462 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
15464 (defun org-days-to-time (timestamp-string)
15465 "Difference between TIMESTAMP-STRING and now in days."
15466 (- (time-to-days (org-time-string-to-time timestamp-string))
15467 (time-to-days (current-time))))
15469 (defun org-deadline-close (timestamp-string &optional ndays)
15470 "Is the time in TIMESTAMP-STRING close to the current date?"
15471 (setq ndays (or ndays (org-get-wdays timestamp-string)))
15472 (and (< (org-days-to-time timestamp-string) ndays)
15473 (not (org-entry-is-done-p))))
15475 (defun org-get-wdays (ts)
15476 "Get the deadline lead time appropriate for timestring TS."
15477 (cond
15478 ((<= org-deadline-warning-days 0)
15479 ;; 0 or negative, enforce this value no matter what
15480 (- org-deadline-warning-days))
15482 ;; lead time is specified.
15483 (floor (* (string-to-number (match-string 1 ts))
15484 (cdr (assoc (match-string 2 ts)
15485 '(("d" . 1) ("w" . 7)
15486 ("m" . 30.4) ("y" . 365.25)))))))
15487 ;; go for the default.
15488 (t org-deadline-warning-days)))
15490 (defun org-calendar-select-mouse (ev)
15491 "Return to `org-read-date' with the date currently selected.
15492 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
15493 (interactive "e")
15494 (mouse-set-point ev)
15495 (when (calendar-cursor-to-date)
15496 (let* ((date (calendar-cursor-to-date))
15497 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
15498 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
15499 (if (active-minibuffer-window) (exit-minibuffer))))
15501 (defun org-check-deadlines (ndays)
15502 "Check if there are any deadlines due or past due.
15503 A deadline is considered due if it happens within `org-deadline-warning-days'
15504 days from today's date. If the deadline appears in an entry marked DONE,
15505 it is not shown. The prefix arg NDAYS can be used to test that many
15507 (interactive "P")
15508 (let* ((org-warn-days
15509 (cond
15510 ((equal ndays '(4)) 100000)
15511 (ndays (prefix-numeric-value ndays))
15512 (t (abs org-deadline-warning-days))))
15513 (case-fold-search nil)
15515 (callback
15516 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
15518 (message "%d deadlines past-due or due within %d days"
15519 (org-occur regexp nil callback)
15520 org-warn-days)))
15522 (defun org-check-before-date (date)
15523 "Check if there are deadlines or scheduled entries before DATE."
15524 (interactive (list (org-read-date)))
15525 (let ((case-fold-search nil)
15529 (callback
15530 (lambda () (time-less-p
15531 (org-time-string-to-time (match-string 2))
15532 (org-time-string-to-time date)))))
15533 (message "%d entries before %s"
15534 (org-occur regexp nil callback) date)))
15536 (defun org-check-after-date (date)
15537 "Check if there are deadlines or scheduled entries after DATE."
15538 (interactive (list (org-read-date)))
15539 (let ((case-fold-search nil)
15543 (callback
15544 (lambda () (not
15545 (time-less-p
15546 (org-time-string-to-time (match-string 2))
15547 (org-time-string-to-time date))))))
15548 (message "%d entries after %s"
15549 (org-occur regexp nil callback) date)))
15551 (defun org-check-dates-range (start-date end-date)
15552 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
15553 (interactive (list (org-read-date nil nil nil "Range starts")
15554 (org-read-date nil nil nil "Range end")))
15555 (let ((case-fold-search nil)
15559 (callback
15560 (lambda ()
15561 (let ((match (match-string 2)))
15562 (and
15563 (not (time-less-p
15564 (org-time-string-to-time match)
15565 (org-time-string-to-time start-date)))
15566 (time-less-p
15567 (org-time-string-to-time match)
15568 (org-time-string-to-time end-date)))))))
15569 (message "%d entries between %s and %s"
15570 (org-occur regexp nil callback) start-date end-date)))
15572 (defun org-evaluate-time-range (&optional to-buffer)
15573 "Evaluate a time range by computing the difference between start and end.
15574 Normally the result is just printed in the echo area, but with prefix arg
15575 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
15576 If the time range is actually in a table, the result is inserted into the
15577 next column.
15578 For time difference computation, a year is assumed to be exactly 365
15579 days in order to avoid rounding problems."
15580 (interactive "P")
15581 (or
15582 (org-clock-update-time-maybe)
15583 (save-excursion
15584 (unless (org-at-date-range-p t)
15585 (goto-char (point-at-bol))
15586 (re-search-forward org-tr-regexp-both (point-at-eol) t))
15587 (if (not (org-at-date-range-p t))
15588 (error "Not at a time-stamp range, and none found in current line")))
15589 (let* ((ts1 (match-string 1))
15590 (ts2 (match-string 2))
15591 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
15592 (match-end (match-end 0))
15593 (time1 (org-time-string-to-time ts1))
15594 (time2 (org-time-string-to-time ts2))
15595 (t1 (org-float-time time1))
15596 (t2 (org-float-time time2))
15597 (diff (abs (- t2 t1)))
15598 (negative (< (- t2 t1) 0))
15599 ;; (ys (floor (* 365 24 60 60)))
15600 (ds (* 24 60 60))
15601 (hs (* 60 60))
15602 (fy "%dy %dd %02d:%02d")
15603 (fy1 "%dy %dd")
15604 (fd "%dd %02d:%02d")
15605 (fd1 "%dd")
15606 (fh "%02d:%02d")
15607 y d h m align)
15608 (if havetime
15609 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15610 y 0
15611 d (floor (/ diff ds)) diff (mod diff ds)
15612 h (floor (/ diff hs)) diff (mod diff hs)
15613 m (floor (/ diff 60)))
15614 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
15615 y 0
15616 d (floor (+ (/ diff ds) 0.5))
15617 h 0 m 0))
15618 (if (not to-buffer)
15619 (message "%s" (org-make-tdiff-string y d h m))
15620 (if (org-at-table-p)
15621 (progn
15622 (goto-char match-end)
15623 (setq align t)
15624 (and (looking-at " *|") (goto-char (match-end 0))))
15625 (goto-char match-end))
15626 (if (looking-at
15628 (replace-match ""))
15629 (if negative (insert " -"))
15630 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
15631 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
15632 (insert " " (format fh h m))))
15633 (if align (org-table-align))
15634 (message "Time difference inserted")))))
15636 (defun org-make-tdiff-string (y d h m)
15637 (let ((fmt "")
15638 (l nil))
15639 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
15640 l (push y l)))
15641 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
15642 l (push d l)))
15643 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
15644 l (push h l)))
15645 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
15646 l (push m l)))
15647 (apply 'format fmt (nreverse l))))
15649 (defun org-time-string-to-time (s &optional buffer pos)
15650 (condition-case errdata
15651 (apply 'encode-time (org-parse-time-string s))
15653 s (if (not (and buffer pos))
15654 ""
15655 (format " at %d in buffer `%s'" pos buffer))
15656 (cdr errdata)))))
15658 (defun org-time-string-to-seconds (s)
15659 (org-float-time (org-time-string-to-time s)))
15661 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
15662 "Convert a time stamp to an absolute day number.
15663 If there is a specifier for a cyclic time stamp, get the closest date to
15664 DAYNR.
15665 PREFER and SHOW-ALL are passed through to `org-closest-date'.
15666 The variable date is bound by the calendar when this is called."
15667 (cond
15669 (if (org-diary-sexp-entry (match-string 1 s) "" date)
15670 daynr
15671 (+ daynr 1000)))
15673 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
15674 (time-to-days (current-time))) (match-string 0 s)
15675 prefer show-all))
15676 (t (time-to-days
15677 (condition-case errdata
15678 (apply 'encode-time (org-parse-time-string s))
15680 s (if (not (and buffer pos))
15681 ""
15682 (format " at %d in buffer `%s'" pos buffer))
15683 (cdr errdata))))))))
15685 (defun org-days-to-iso-week (days)
15686 "Return the iso week number."
15687 (require 'cal-iso)
15688 (car (calendar-iso-from-absolute days)))
15690 (defun org-small-year-to-year (year)
15691 "Convert 2-digit years into 4-digit years.
15692 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
15693 The year 2000 cannot be abbreviated. Any year larger than 99
15694 is returned unchanged."
15695 (if (< year 38)
15696 (setq year (+ 2000 year))
15697 (if (< year 100)
15698 (setq year (+ 1900 year))))
15699 year)
15701 (defun org-time-from-absolute (d)
15702 "Return the time corresponding to date D.
15703 D may be an absolute day number, or a calendar-type list (month day year)."
15704 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
15705 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
15707 (defun org-calendar-holiday ()
15708 "List of holidays, for Diary display in Org-mode."
15709 (require 'holidays)
15710 (let ((hl (funcall
15711 (if (fboundp 'calendar-check-holidays)
15712 'calendar-check-holidays 'check-calendar-holidays) date)))
15713 (if hl (mapconcat 'identity hl "; "))))
15715 (defun org-diary-sexp-entry (sexp entry date)
15716 "Process a SEXP diary ENTRY for DATE."
15717 (require 'diary-lib)
15718 (let ((result (if calendar-debug-sexp
15719 (let ((stack-trace-on-error t))
15720 (eval (car (read-from-string sexp))))
15721 (condition-case nil
15722 (eval (car (read-from-string sexp)))
15723 (error
15724 (beep)
15725 (message "Bad sexp at line %d in %s: %s"
15726 (org-current-line)
15727 (buffer-file-name) sexp)
15728 (sleep-for 2))))))
15729 (cond ((stringp result) (split-string result "; "))
15730 ((and (consp result)
15731 (not (consp (cdr result)))
15732 (stringp (cdr result))) (cdr result))
15733 ((and (consp result)
15734 (stringp (car result))) result)
15735 (result entry)
15736 (t nil))))
15738 (defun org-diary-to-ical-string (frombuf)
15739 "Get iCalendar entries from diary entries in buffer FROMBUF.
15740 This uses the icalendar.el library."
15741 (let* ((tmpdir (if (featurep 'xemacs)
15742 (temp-directory)
15743 temporary-file-directory))
15744 (tmpfile (make-temp-name
15745 (expand-file-name "orgics" tmpdir)))
15746 buf rtn b e)
15747 (with-current-buffer frombuf
15748 (icalendar-export-region (point-min) (point-max) tmpfile)
15749 (setq buf (find-buffer-visiting tmpfile))
15750 (set-buffer buf)
15751 (goto-char (point-min))
15752 (if (re-search-forward "^BEGIN:VEVENT" nil t)
15753 (setq b (match-beginning 0)))
15754 (goto-char (point-max))
15755 (if (re-search-backward "^END:VEVENT" nil t)
15756 (setq e (match-end 0)))
15758 (kill-buffer buf)
15759 (delete-file tmpfile)
15760 rtn))
15762 (defun org-closest-date (start current change prefer show-all)
15763 "Find the date closest to CURRENT that is consistent with START and CHANGE.
15764 When PREFER is `past', return a date that is either CURRENT or past.
15765 When PREFER is `future', return a date that is either CURRENT or future.
15766 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
15767 ;; Make the proper lists from the dates
15768 (catch 'exit
15769 (let ((a1 '(("d" . day) ("w" . week) ("m" . month) ("y" . year)))
15770 dn dw sday cday n1 n2 n0
15771 d m y y1 y2 date1 date2 nmonths nm ny m2)
15773 (setq start (org-date-to-gregorian start)
15774 current (org-date-to-gregorian
15775 (if show-all
15776 current
15777 (time-to-days (current-time))))
15778 sday (calendar-absolute-from-gregorian start)
15779 cday (calendar-absolute-from-gregorian current))
15781 (if (<= cday sday) (throw 'exit sday))
15784 (setq dn (string-to-number (match-string 1 change))
15785 dw (cdr (assoc (match-string 2 change) a1)))
15786 (error "Invalid change specifier: %s" change))
15787 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
15788 (cond
15789 ((eq dw 'day)
15790 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
15791 n2 (+ n1 dn)))
15792 ((eq dw 'year)
15793 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
15794 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
15795 (setq date1 (list m d y1)
15796 n1 (calendar-absolute-from-gregorian date1)
15797 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
15798 n2 (calendar-absolute-from-gregorian date2)))
15799 ((eq dw 'month)
15800 ;; approx number of month between the two dates
15801 (setq nmonths (floor (/ (- cday sday) 30.436875)))
15802 ;; How often does dn fit in there?
15803 (setq d (nth 1 start) m (car start) y (nth 2 start)
15804 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
15805 m (+ m nm)
15806 ny (floor (/ m 12))
15807 y (+ y ny)
15808 m (- m (* ny 12)))
15809 (while (> m 12) (setq m (- m 12) y (1+ y)))
15810 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
15811 (setq m2 (+ m dn) y2 y)
15812 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15813 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
15814 (while (<= n2 cday)
15815 (setq n1 n2 m m2 y y2)
15816 (setq m2 (+ m dn) y2 y)
15817 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
15818 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
15819 ;; Make sure n1 is the earlier date
15820 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
15821 (if show-all
15822 (cond
15823 ((eq prefer 'past) (if (= cday n2) n2 n1))
15824 ((eq prefer 'future) (if (= cday n1) n1 n2))
15825 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
15826 (cond
15827 ((eq prefer 'past) (if (= cday n2) n2 n1))
15828 ((eq prefer 'future) (if (= cday n1) n1 n2))
15829 (t (if (= cday n1) n1 n2)))))))
15831 (defun org-date-to-gregorian (date)
15832 "Turn any specification of DATE into a Gregorian date for the calendar."
15833 (cond ((integerp date) (calendar-gregorian-from-absolute date))
15834 ((and (listp date) (= (length date) 3)) date)
15835 ((stringp date)
15836 (setq date (org-parse-time-string date))
15837 (list (nth 4 date) (nth 3 date) (nth 5 date)))
15838 ((listp date)
15839 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
15841 (defun org-parse-time-string (s &optional nodefault)
15842 "Parse the standard Org-mode time string.
15843 This should be a lot faster than the normal `parse-time-string'.
15844 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
15845 hour and minute fields will be nil if not given."
15846 (if (string-match org-ts-regexp0 s)
15847 (list 0
15848 (if (or (match-beginning 8) (not nodefault))
15849 (string-to-number (or (match-string 8 s) "0")))
15850 (if (or (match-beginning 7) (not nodefault))
15851 (string-to-number (or (match-string 7 s) "0")))
15852 (string-to-number (match-string 4 s))
15853 (string-to-number (match-string 3 s))
15854 (string-to-number (match-string 2 s))
15855 nil nil nil)
15856 (error "Not a standard Org-mode time string: %s" s)))
15858 (defun org-timestamp-up (&optional arg)
15859 "Increase the date item at the cursor by one.
15860 If the cursor is on the year, change the year. If it is on the month,
15861 the day or the time, change that.
15862 With prefix ARG, change by that many units."
15863 (interactive "p")
15864 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
15866 (defun org-timestamp-down (&optional arg)
15867 "Decrease the date item at the cursor by one.
15868 If the cursor is on the year, change the year. If it is on the month,
15869 the day or the time, change that.
15870 With prefix ARG, change by that many units."
15871 (interactive "p")
15872 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
15874 (defun org-timestamp-up-day (&optional arg)
15875 "Increase the date in the time stamp by one day.
15876 With prefix ARG, change that many days."
15877 (interactive "p")
15878 (if (and (not (org-at-timestamp-p t))
15879 (org-at-heading-p))
15880 (org-todo 'up)
15881 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
15883 (defun org-timestamp-down-day (&optional arg)
15884 "Decrease the date in the time stamp by one day.
15885 With prefix ARG, change that many days."
15886 (interactive "p")
15887 (if (and (not (org-at-timestamp-p t))
15888 (org-at-heading-p))
15889 (org-todo 'down)
15890 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
15892 (defun org-at-timestamp-p (&optional inactive-ok)
15893 "Determine if the cursor is in or at a timestamp."
15894 (interactive)
15895 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
15896 (pos (point))
15897 (ans (or (looking-at tsr)
15898 (save-excursion
15900 (if (> (point) (point-min)) (backward-char 1))
15901 (and (looking-at tsr)
15902 (> (- (match-end 0) pos) -1))))))
15903 (and ans
15904 (boundp 'org-ts-what)
15905 (setq org-ts-what
15906 (cond
15907 ((= pos (match-beginning 0)) 'bracket)
15908 ;; Point is considered to be "on the bracket" whether
15909 ;; it's really on it or right after it.
15910 ((or (= pos (1- (match-end 0)))
15911 (= pos (match-end 0))) 'bracket)
15912 ((org-pos-in-match-range pos 2) 'year)
15913 ((org-pos-in-match-range pos 3) 'month)
15914 ((org-pos-in-match-range pos 7) 'hour)
15915 ((org-pos-in-match-range pos 8) 'minute)
15916 ((or (org-pos-in-match-range pos 4)
15917 (org-pos-in-match-range pos 5)) 'day)
15918 ((and (> pos (or (match-end 8) (match-end 5)))
15919 (< pos (match-end 0)))
15920 (- pos (or (match-end 8) (match-end 5))))
15921 (t 'day))))
15922 ans))
15924 (defun org-toggle-timestamp-type ()
15925 "Toggle the type (<active> or [inactive]) of a time stamp."
15926 (interactive)
15927 (when (org-at-timestamp-p t)
15928 (let ((beg (match-beginning 0)) (end (match-end 0))
15929 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
15930 (save-excursion
15931 (goto-char beg)
15932 (while (re-search-forward "[][<>]" end t)
15933 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
15934 t t)))
15935 (message "Timestamp is now %sactive"
15936 (if (equal (char-after beg) ?<) "" "in")))))
15938 (defun org-timestamp-change (n &optional what updown)
15939 "Change the date in the time stamp at point.
15940 The date will be changed by N times WHAT. WHAT can be `day', `month',
15941 `year', `minute', `second'. If WHAT is not given, the cursor position
15942 in the timestamp determines what will be changed."
15943 (let ((origin (point)) origin-cat
15944 with-hm inactive
15945 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
15946 org-ts-what
15947 extra rem
15948 ts time time0)
15949 (if (not (org-at-timestamp-p t))
15950 (error "Not at a timestamp"))
15951 (if (and (not what) (eq org-ts-what 'bracket))
15952 (org-toggle-timestamp-type)
15953 ;; Point isn't on brackets. Remember the part of the time-stamp
15954 ;; the point was in. Indeed, size of time-stamps may change,
15955 ;; but point must be kept in the same category nonetheless.
15956 (setq origin-cat org-ts-what)
15957 (if (and (not what) (not (eq org-ts-what 'day))
15958 org-display-custom-times
15959 (get-text-property (point) 'display)
15960 (not (get-text-property (1- (point)) 'display)))
15961 (setq org-ts-what 'day))
15962 (setq org-ts-what (or what org-ts-what)
15963 inactive (= (char-after (match-beginning 0)) ?\[)
15964 ts (match-string 0))
15965 (replace-match "")
15966 (if (string-match
15968 ts)
15969 (setq extra (match-string 1 ts)))
15971 (setq with-hm t))
15972 (setq time0 (org-parse-time-string ts))
15973 (when (and updown
15974 (eq org-ts-what 'minute)
15975 (not current-prefix-arg))
15976 ;; This looks like s-up and s-down. Change by one rounding step.
15977 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
15978 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
15979 (setcar (cdr time0) (+ (nth 1 time0)
15980 (if (> n 0) (- rem) (- dm rem))))))
15981 (setq time
15982 (encode-time (or (car time0) 0)
15983 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
15984 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
15985 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
15986 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
15987 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
15988 (nthcdr 6 time0)))
15989 (when (and (member org-ts-what '(hour minute))
15990 extra
15992 (setq extra (org-modify-ts-extra
15993 extra
15994 (if (eq org-ts-what 'hour) 2 5)
15995 n dm)))
15996 (when (integerp org-ts-what)
15997 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
15998 (if (eq what 'calendar)
15999 (let ((cal-date (org-get-date-from-calendar)))
16000 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
16001 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
16002 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
16003 (setcar time0 (or (car time0) 0))
16004 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
16005 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
16006 (setq time (apply 'encode-time time0))))
16007 ;; Insert the new time-stamp, and ensure point stays in the same
16008 ;; category as before (i.e. not after the last position in that
16009 ;; category).
16010 (let ((pos (point)))
16011 ;; Stay before inserted string. `save-excursion' is of no use.
16012 (setq org-last-changed-timestamp
16013 (org-insert-time-stamp time with-hm inactive nil nil extra))
16014 (goto-char pos))
16015 (save-match-data
16016 (looking-at org-ts-regexp3)
16017 (goto-char (cond
16018 ;; `day' category ends before `hour' if any, or at
16019 ;; the end of the day name.
16020 ((eq origin-cat 'day)
16021 (min (or (match-beginning 7) (1- (match-end 5))) origin))
16022 ((eq origin-cat 'hour) (min (match-end 7) origin))
16023 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
16024 ((integerp origin-cat) (min (1- (match-end 0)) origin))
16025 ;; `year' and `month' have both fixed size: point
16026 ;; couldn't have moved into another part.
16027 (t origin))))
16028 ;; Update clock if on a CLOCK line.
16029 (org-clock-update-time-maybe)
16030 ;; Try to recenter the calendar window, if any.
16031 (if (and org-calendar-follow-timestamp-change
16032 (get-buffer-window "*Calendar*" t)
16033 (memq org-ts-what '(day month year)))
16034 (org-recenter-calendar (time-to-days time))))))
16036 (defun org-modify-ts-extra (s pos n dm)
16037 "Change the different parts of the lead-time and repeat fields in timestamp."
16038 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
16039 ng h m new rem)
16040 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
16041 (cond
16042 ((or (org-pos-in-match-range pos 2)
16043 (org-pos-in-match-range pos 3))
16044 (setq m (string-to-number (match-string 3 s))
16045 h (string-to-number (match-string 2 s)))
16046 (if (org-pos-in-match-range pos 2)
16047 (setq h (+ h n))
16048 (setq n (* dm (org-no-warnings (signum n))))
16049 (when (not (= 0 (setq rem (% m dm))))
16050 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
16051 (setq m (+ m n)))
16052 (if (< m 0) (setq m (+ m 60) h (1- h)))
16053 (if (> m 59) (setq m (- m 60) h (1+ h)))
16054 (setq h (min 24 (max 0 h)))
16055 (setq ng 1 new (format "-%02d:%02d" h m)))
16056 ((org-pos-in-match-range pos 6)
16057 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
16058 ((org-pos-in-match-range pos 5)
16059 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
16061 ((org-pos-in-match-range pos 9)
16062 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
16063 ((org-pos-in-match-range pos 8)
16064 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
16066 (when ng
16067 (setq s (concat
16068 (substring s 0 (match-beginning ng))
16069 new
16070 (substring s (match-end ng))))))
16071 s))
16073 (defun org-recenter-calendar (date)
16074 "If the calendar is visible, recenter it to DATE."
16075 (let* ((win (selected-window))
16076 (cwin (get-buffer-window "*Calendar*" t))
16077 (calendar-move-hook nil))
16078 (when cwin
16079 (select-window cwin)
16080 (calendar-goto-date (if (listp date) date
16081 (calendar-gregorian-from-absolute date)))
16082 (select-window win))))
16084 (defun org-goto-calendar (&optional arg)
16085 "Go to the Emacs calendar at the current date.
16086 If there is a time stamp in the current line, go to that date.
16087 A prefix ARG can be used to force the current date."
16088 (interactive "P")
16089 (let ((tsr org-ts-regexp) diff
16090 (calendar-move-hook nil)
16091 (calendar-view-holidays-initially-flag nil)
16092 (calendar-view-diary-initially-flag nil))
16093 (if (or (org-at-timestamp-p)
16094 (save-excursion
16095 (beginning-of-line 1)
16096 (looking-at (concat ".*" tsr))))
16097 (let ((d1 (time-to-days (current-time)))
16098 (d2 (time-to-days
16099 (org-time-string-to-time (match-string 1)))))
16100 (setq diff (- d2 d1))))
16101 (calendar)
16102 (calendar-goto-today)
16103 (if (and diff (not arg)) (calendar-forward-day diff))))
16105 (defun org-get-date-from-calendar ()
16106 "Return a list (month day year) of date at point in calendar."
16107 (with-current-buffer "*Calendar*"
16108 (save-match-data
16109 (calendar-cursor-to-date))))
16111 (defun org-date-from-calendar ()
16112 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
16113 If there is already a time stamp at the cursor position, update it."
16114 (interactive)
16115 (if (org-at-timestamp-p t)
16116 (org-timestamp-change 0 'calendar)
16117 (let ((cal-date (org-get-date-from-calendar)))
16118 (org-insert-time-stamp
16119 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
16121 (defun org-minutes-to-hh:mm-string (m)
16122 "Compute H:MM from a number of minutes."
16123 (let ((h (/ m 60)))
16124 (setq m (- m (* 60 h)))
16125 (format org-time-clocksum-format h m)))
16127 (defun org-hh:mm-string-to-minutes (s)
16128 "Convert a string H:MM to a number of minutes.
16129 If the string is just a number, interpret it as minutes.
16130 In fact, the first hh:mm or number in the string will be taken,
16131 there can be extra stuff in the string.
16132 If no number is found, the return value is 0."
16133 (cond
16134 ((integerp s) s)
16136 (+ (* (string-to-number (match-string 1 s)) 60)
16137 (string-to-number (match-string 2 s))))
16139 (string-to-number (match-string 1 s)))
16140 (t 0)))
16142 (defcustom org-effort-durations
16143 `(("h" . 60)
16144 ("d" . ,(* 60 8))
16145 ("w" . ,(* 60 8 5))
16146 ("m" . ,(* 60 8 5 4))
16147 ("y" . ,(* 60 8 5 40)))
16148 "Conversion factor to minutes for an effort modifier.
16150 Each entry has the form (MODIFIER . MINUTES).
16152 In an effort string, a number followed by MODIFIER is multiplied
16153 by the specified number of MINUTES to obtain an effort in
16154 minutes.
16158 :group 'org-agenda
16159 :type '(alist :key-type (string :tag "Modifier")
16160 :value-type (number :tag "Minutes")))
16162 (defun org-duration-string-to-minutes (s)
16163 "Convert a duration string S to minutes.
16165 A bare number is interpreted as minutes, modifiers can be set by
16166 customizing `org-effort-durations' (which see).
16168 Entries containing a colon are interpreted as H:MM by
16169 `org-hh:mm-string-to-minutes'."
16170 (let ((result 0)
16172 (regexp-opt (mapcar 'car org-effort-durations))
16174 (while (string-match re s)
16175 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
16176 (string-to-number (match-string 1 s))))
16177 (setq s (replace-match "" nil t s)))
16178 (incf result (org-hh:mm-string-to-minutes s))
16179 result))
16181 ;;;; Files
16183 (defun org-save-all-org-buffers ()
16184 "Save all Org-mode buffers without user confirmation."
16185 (interactive)
16186 (message "Saving all Org-mode buffers...")
16187 (save-some-buffers t (lambda () (eq major-mode 'org-mode)))
16188 (when (featurep 'org-id) (org-id-locations-save))
16189 (message "Saving all Org-mode buffers... done"))
16191 (defun org-revert-all-org-buffers ()
16192 "Revert all Org-mode buffers.
16193 Prompt for confirmation when there are unsaved changes.
16194 Be sure you know what you are doing before letting this function
16195 overwrite your changes.
16197 This function is useful in a setup where one tracks org files
16198 with a version control system, to revert on one machine after pulling
16199 changes from another. I believe the procedure must be like this:
16201 1. M-x org-save-all-org-buffers
16202 2. Pull changes from the other machine, resolve conflicts
16203 3. M-x org-revert-all-org-buffers"
16204 (interactive)
16205 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
16206 (error "Abort"))
16207 (save-excursion
16208 (save-window-excursion
16209 (mapc
16210 (lambda (b)
16211 (when (and (with-current-buffer b (eq major-mode 'org-mode))
16212 (with-current-buffer b buffer-file-name))
16213 (org-pop-to-buffer-same-window b)
16214 (revert-buffer t 'no-confirm)))
16215 (buffer-list))
16216 (when (and (featurep 'org-id) org-id-track-globally)
16217 (org-id-locations-load)))))
16219 ;;;; Agenda files
16221 ;;;###autoload
16222 (defun org-switchb (&optional arg)
16223 "Switch between Org buffers.
16224 With one prefix argument, restrict available buffers to files.
16225 With two prefix arguments, restrict available buffers to agenda files.
16227 Defaults to `iswitchb' for buffer name completion.
16228 Set `org-completion-use-ido' to make it use ido instead."
16229 (interactive "P")
16230 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
16231 ((equal arg '(16)) (org-buffer-list 'agenda))
16232 (t (org-buffer-list))))
16233 (org-completion-use-iswitchb org-completion-use-iswitchb)
16234 (org-completion-use-ido org-completion-use-ido))
16235 (unless (or org-completion-use-ido org-completion-use-iswitchb)
16236 (setq org-completion-use-iswitchb t))
16237 (org-pop-to-buffer-same-window
16238 (org-icompleting-read "Org buffer: "
16239 (mapcar 'list (mapcar 'buffer-name blist))
16240 nil t))))
16242 ;;; Define some older names previously used for this functionality
16243 ;;;###autoload
16244 (defalias 'org-ido-switchb 'org-switchb)
16245 ;;;###autoload
16246 (defalias 'org-iswitchb 'org-switchb)
16248 (defun org-buffer-list (&optional predicate exclude-tmp)
16249 "Return a list of Org buffers.
16250 PREDICATE can be `export', `files' or `agenda'.
16252 export restrict the list to Export buffers.
16253 files restrict the list to buffers visiting Org files.
16254 agenda restrict the list to buffers visiting agenda files.
16256 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
16257 (let* ((bfn nil)
16258 (agenda-files (and (eq predicate 'agenda)
16259 (mapcar 'file-truename (org-agenda-files t))))
16260 (filter
16261 (cond
16262 ((eq predicate 'files)
16263 (lambda (b) (with-current-buffer b (eq major-mode 'org-mode))))
16264 ((eq predicate 'export)
16265 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
16266 ((eq predicate 'agenda)
16267 (lambda (b)
16268 (with-current-buffer b
16269 (and (eq major-mode 'org-mode)
16270 (setq bfn (buffer-file-name b))
16271 (member (file-truename bfn) agenda-files)))))
16272 (t (lambda (b) (with-current-buffer b
16273 (or (eq major-mode 'org-mode)
16274 (string-match "\*Org .*Export"
16275 (buffer-name b)))))))))
16276 (delq nil
16277 (mapcar
16278 (lambda(b)
16279 (if (and (funcall filter b)
16280 (or (not exclude-tmp)
16281 (not (string-match "tmp" (buffer-name b)))))
16282 b
16283 nil))
16284 (buffer-list)))))
16286 (defun org-agenda-files (&optional unrestricted archives)
16287 "Get the list of agenda files.
16288 Optional UNRESTRICTED means return the full list even if a restriction
16289 is currently in place.
16290 When ARCHIVES is t, include all archive files that are really being
16291 used by the agenda files. If ARCHIVE is `ifmode', do this only if
16292 `org-agenda-archives-mode' is t."
16293 (let ((files
16294 (cond
16295 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
16296 ((stringp org-agenda-files) (org-read-agenda-file-list))
16297 ((listp org-agenda-files) org-agenda-files)
16298 (t (error "Invalid value of `org-agenda-files'")))))
16299 (setq files (apply 'append
16300 (mapcar (lambda (f)
16301 (if (file-directory-p f)
16302 (directory-files
16303 f t org-agenda-file-regexp)
16304 (list f)))
16305 files)))
16306 (when org-agenda-skip-unavailable-files
16307 (setq files (delq nil
16308 (mapcar (function
16309 (lambda (file)
16310 (and (file-readable-p file) file)))
16311 files))))
16312 (when (or (eq archives t)
16313 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
16314 (setq files (org-add-archive-files files)))
16315 files))
16317 (defun org-agenda-file-p (&optional file)
16318 "Return non-nil, if FILE is an agenda file.
16319 If FILE is omitted, use the file associated with the current
16320 buffer."
16321 (member (or file (buffer-file-name))
16322 (org-agenda-files t)))
16324 (defun org-edit-agenda-file-list ()
16325 "Edit the list of agenda files.
16326 Depending on setup, this either uses customize to edit the variable
16327 `org-agenda-files', or it visits the file that is holding the list. In the
16328 latter case, the buffer is set up in a way that saving it automatically kills
16329 the buffer and restores the previous window configuration."
16330 (interactive)
16331 (if (stringp org-agenda-files)
16332 (let ((cw (current-window-configuration)))
16333 (find-file org-agenda-files)
16334 (org-set-local 'org-window-configuration cw)
16335 (org-add-hook 'after-save-hook
16336 (lambda ()
16337 (set-window-configuration
16338 (prog1 org-window-configuration
16339 (kill-buffer (current-buffer))))
16340 (org-install-agenda-files-menu)
16341 (message "New agenda file list installed"))
16342 nil 'local)
16343 (message "%s" (substitute-command-keys
16345 (customize-variable 'org-agenda-files)))
16347 (defun org-store-new-agenda-file-list (list)
16348 "Set new value for the agenda file list and save it correctly."
16349 (if (stringp org-agenda-files)
16350 (let ((fe (org-read-agenda-file-list t)) b u)
16351 (while (setq b (find-buffer-visiting org-agenda-files))
16352 (kill-buffer b))
16353 (with-temp-file org-agenda-files
16354 (insert
16355 (mapconcat
16356 (lambda (f) ;; Keep un-expanded entries.
16357 (if (setq u (assoc f fe))
16358 (cdr u)
16359 f))
16362 (let ((org-mode-hook nil) (org-inhibit-startup t)
16363 (org-insert-mode-line-in-empty-file nil))
16364 (setq org-agenda-files list)
16365 (customize-save-variable 'org-agenda-files org-agenda-files))))
16367 (defun org-read-agenda-file-list (&optional pair-with-expansion)
16368 "Read the list of agenda files from a file.
16369 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
16370 filenames, used by `org-store-new-agenda-file-list' to write back
16371 un-expanded file names."
16372 (when (file-directory-p org-agenda-files)
16373 (error "`org-agenda-files' cannot be a single directory"))
16374 (when (stringp org-agenda-files)
16375 (with-temp-buffer
16376 (insert-file-contents org-agenda-files)
16377 (mapcar
16378 (lambda (f)
16379 (let ((e (expand-file-name (substitute-in-file-name f)
16380 org-directory)))
16381 (if pair-with-expansion
16382 (cons e f)
16383 e)))
16386 ;;;###autoload
16387 (defun org-cycle-agenda-files ()
16388 "Cycle through the files in `org-agenda-files'.
16389 If the current buffer visits an agenda file, find the next one in the list.
16390 If the current buffer does not, find the first agenda file."
16391 (interactive)
16392 (let* ((fs (org-agenda-files t))
16393 (files (append fs (list (car fs))))
16394 (tcf (if buffer-file-name (file-truename buffer-file-name)))
16395 file)
16396 (unless files (error "No agenda files"))
16397 (catch 'exit
16398 (while (setq file (pop files))
16399 (if (equal (file-truename file) tcf)
16400 (when (car files)
16401 (find-file (car files))
16402 (throw 'exit t))))
16403 (find-file (car fs)))
16404 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
16406 (defun org-agenda-file-to-front (&optional to-end)
16407 "Move/add the current file to the top of the agenda file list.
16408 If the file is not present in the list, it is added to the front. If it is
16409 present, it is moved there. With optional argument TO-END, add/move to the
16410 end of the list."
16411 (interactive "P")
16412 (let ((org-agenda-skip-unavailable-files nil)
16413 (file-alist (mapcar (lambda (x)
16414 (cons (file-truename x) x))
16415 (org-agenda-files t)))
16416 (ctf (file-truename buffer-file-name))
16417 x had)
16418 (setq x (assoc ctf file-alist) had x)
16420 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
16421 (if to-end
16422 (setq file-alist (append (delq x file-alist) (list x)))
16423 (setq file-alist (cons x (delq x file-alist))))
16424 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
16425 (org-install-agenda-files-menu)
16426 (message "File %s to %s of agenda file list"
16427 (if had "moved" "added") (if to-end "end" "front"))))
16429 (defun org-remove-file (&optional file)
16430 "Remove current file from the list of files in variable `org-agenda-files'.
16431 These are the files which are being checked for agenda entries.
16432 Optional argument FILE means use this file instead of the current."
16433 (interactive)
16434 (let* ((org-agenda-skip-unavailable-files nil)
16435 (file (or file buffer-file-name))
16436 (true-file (file-truename file))
16437 (afile (abbreviate-file-name file))
16438 (files (delq nil (mapcar
16439 (lambda (x)
16440 (if (equal true-file
16441 (file-truename x))
16442 nil x))
16443 (org-agenda-files t)))))
16444 (if (not (= (length files) (length (org-agenda-files t))))
16445 (progn
16446 (org-store-new-agenda-file-list files)
16447 (org-install-agenda-files-menu)
16448 (message "Removed file: %s" afile))
16449 (message "File was not in list: %s (not removed)" afile))))
16451 (defun org-file-menu-entry (file)
16452 (vector file (list 'find-file file) t))
16454 (defun org-check-agenda-file (file)
16455 "Make sure FILE exists. If not, ask user what to do."
16456 (when (not (file-exists-p file))
16457 (message "non-existent agenda file %s. [R]emove from list or [A]bort?"
16458 (abbreviate-file-name file))
16459 (let ((r (downcase (read-char-exclusive))))
16460 (cond
16461 ((equal r ?r)
16462 (org-remove-file file)
16463 (throw 'nextfile t))
16464 (t (error "Abort"))))))
16466 (defun org-get-agenda-file-buffer (file)
16467 "Get a buffer visiting FILE. If the buffer needs to be created, add
16468 it to the list of buffers which might be released later."
16469 (let ((buf (org-find-base-buffer-visiting file)))
16470 (if buf
16471 buf ; just return it
16472 ;; Make a new buffer and remember it
16473 (setq buf (find-file-noselect file))
16474 (if buf (push buf org-agenda-new-buffers))
16475 buf)))
16477 (defun org-release-buffers (blist)
16478 "Release all buffers in list, asking the user for confirmation when needed.
16479 When a buffer is unmodified, it is just killed. When modified, it is saved
16480 \(if the user agrees) and then killed."
16481 (let (buf file)
16482 (while (setq buf (pop blist))
16483 (setq file (buffer-file-name buf))
16484 (when (and (buffer-modified-p buf)
16485 file
16486 (y-or-n-p (format "Save file %s? " file)))
16487 (with-current-buffer buf (save-buffer)))
16488 (kill-buffer buf))))
16490 (defun org-prepare-agenda-buffers (files)
16491 "Create buffers for all agenda files, protect archived trees and comments."
16492 (interactive)
16493 (let ((pa '(:org-archived t))
16494 (pc '(:org-comment t))
16495 (pall '(:org-archived t :org-comment t))
16496 (inhibit-read-only t)
16497 (rea (concat ":" org-archive-tag ":"))
16498 bmp file re)
16499 (save-excursion
16500 (save-restriction
16501 (while (setq file (pop files))
16502 (catch 'nextfile
16503 (if (bufferp file)
16504 (set-buffer file)
16505 (org-check-agenda-file file)
16506 (set-buffer (org-get-agenda-file-buffer file)))
16507 (widen)
16508 (setq bmp (buffer-modified-p))
16509 (org-refresh-category-properties)
16510 (setq org-todo-keywords-for-agenda
16511 (append org-todo-keywords-for-agenda org-todo-keywords-1))
16512 (setq org-done-keywords-for-agenda
16513 (append org-done-keywords-for-agenda org-done-keywords))
16514 (setq org-todo-keyword-alist-for-agenda
16515 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
16516 (setq org-drawers-for-agenda
16517 (append org-drawers-for-agenda org-drawers))
16518 (setq org-tag-alist-for-agenda
16519 (append org-tag-alist-for-agenda org-tag-alist))
16521 (save-excursion
16522 (remove-text-properties (point-min) (point-max) pall)
16523 (when org-agenda-skip-archived-trees
16524 (goto-char (point-min))
16525 (while (re-search-forward rea nil t)
16526 (if (org-at-heading-p t)
16527 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
16528 (goto-char (point-min))
16529 (setq re (format org-heading-keyword-regexp-format
16530 org-comment-string))
16531 (while (re-search-forward re nil t)
16532 (add-text-properties
16533 (match-beginning 0) (org-end-of-subtree t) pc)))
16534 (set-buffer-modified-p bmp)))))
16535 (setq org-todo-keywords-for-agenda
16536 (org-uniquify org-todo-keywords-for-agenda))
16537 (setq org-todo-keyword-alist-for-agenda
16538 (org-uniquify org-todo-keyword-alist-for-agenda)
16539 org-tag-alist-for-agenda (org-uniquify org-tag-alist-for-agenda))))
16541 ;;;; Embedded LaTeX
16543 (defvar org-cdlatex-mode-map (make-sparse-keymap)
16544 "Keymap for the minor `org-cdlatex-mode'.")
16546 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
16547 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
16548 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
16549 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
16550 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
16552 (defvar org-cdlatex-texmathp-advice-is-done nil
16553 "Flag remembering if we have applied the advice to texmathp already.")
16555 (define-minor-mode org-cdlatex-mode
16556 "Toggle the minor `org-cdlatex-mode'.
16557 This mode supports entering LaTeX environment and math in LaTeX fragments
16558 in Org-mode.
16560 nil " OCDL" nil
16561 (when org-cdlatex-mode
16562 (require 'cdlatex)
16563 (run-hooks 'cdlatex-mode-hook)
16564 (cdlatex-compute-tables))
16565 (unless org-cdlatex-texmathp-advice-is-done
16566 (setq org-cdlatex-texmathp-advice-is-done t)
16567 (defadvice texmathp (around org-math-always-on activate)
16568 "Always return t in org-mode buffers.
16569 This is because we want to insert math symbols without dollars even outside
16570 the LaTeX math segments. If Orgmode thinks that point is actually inside
16571 an embedded LaTeX fragment, let texmathp do its job.
16573 (interactive)
16574 (let (p)
16575 (cond
16576 ((not (eq major-mode 'org-mode)) ad-do-it)
16577 ((eq this-command 'cdlatex-math-symbol)
16578 (setq ad-return-value t
16579 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
16580 (t
16581 (let ((p (org-inside-LaTeX-fragment-p)))
16582 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
16583 (setq ad-return-value t
16584 texmathp-why '("Org-mode embedded math" . 0))
16585 (if p ad-do-it)))))))))
16587 (defun turn-on-org-cdlatex ()
16588 "Unconditionally turn on `org-cdlatex-mode'."
16589 (org-cdlatex-mode 1))
16591 (defun org-inside-LaTeX-fragment-p ()
16592 "Test if point is inside a LaTeX fragment.
16594 sequence appearing also before point.
16595 Even though the matchers for math are configurable, this function assumes
16597 delimiters are skipped when they have been removed by customization.
16598 The return value is nil, or a cons cell with the delimiter and the
16599 position of this delimiter.
16601 This function does a reasonably good job, but can locally be fooled by
16602 for example currency specifications. For example it will assume being in
16604 fragments that are properly closed, but during editing, we have to live
16605 with the uncertainty caused by missing closing delimiters. This function
16606 looks only before point, not after."
16607 (catch 'exit
16608 (let ((pos (point))
16609 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
16610 (lim (progn
16612 (point)))
16613 dd-on str (start 0) m re)
16614 (goto-char pos)
16615 (when dodollar
16617 re (nth 1 (assoc "$" org-latex-regexps)))
16618 (while (string-match re str start)
16619 (cond
16620 ((= (match-end 0) (length str))
16621 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
16622 ((= (match-end 0) (- (length str) 5))
16623 (throw 'exit nil))
16624 (t (setq start (match-end 0))))))
16625 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
16626 (goto-char pos)
16627 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
16628 (and (match-beginning 2) (throw 'exit nil))
16629 ;; count $$
16631 (setq dd-on (not dd-on)))
16632 (goto-char pos)
16633 (if dd-on (cons "$$" m))))))
16635 (defun org-inside-latex-macro-p ()
16636 "Is point inside a LaTeX macro or its arguments?"
16637 (save-match-data
16638 (org-in-regexp
16641 (defun org-try-cdlatex-tab ()
16642 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
16643 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
16644 - inside a LaTeX fragment, or
16645 - after the first word in a line, where an abbreviation expansion could
16646 insert a LaTeX environment."
16647 (when org-cdlatex-mode
16648 (cond
16649 ;; Before any word on the line: No expansion possible.
16651 ;; Just after first word on the line: Expand it. Make sure it
16652 ;; cannot happen on headlines, though.
16653 ((save-excursion
16654 (skip-chars-backward "a-zA-Z0-9*")
16656 (and (bolp) (not (org-at-heading-p))))
16657 (cdlatex-tab) t)
16658 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
16660 (defun org-cdlatex-underscore-caret (&optional arg)
16661 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
16662 Revert to the normal definition outside of these fragments."
16663 (interactive "P")
16664 (if (org-inside-LaTeX-fragment-p)
16665 (call-interactively 'cdlatex-sub-superscript)
16666 (let (org-cdlatex-mode)
16667 (call-interactively (key-binding (vector last-input-event))))))
16669 (defun org-cdlatex-math-modify (&optional arg)
16670 "Execute `cdlatex-math-modify' in LaTeX fragments.
16671 Revert to the normal definition outside of these fragments."
16672 (interactive "P")
16673 (if (org-inside-LaTeX-fragment-p)
16674 (call-interactively 'cdlatex-math-modify)
16675 (let (org-cdlatex-mode)
16676 (call-interactively (key-binding (vector last-input-event))))))
16678 (defvar org-latex-fragment-image-overlays nil
16679 "List of overlays carrying the images of latex fragments.")
16680 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
16682 (defun org-remove-latex-fragment-image-overlays ()
16683 "Remove all overlays with LaTeX fragment images in current buffer."
16684 (mapc 'delete-overlay org-latex-fragment-image-overlays)
16685 (setq org-latex-fragment-image-overlays nil))
16687 (defun org-preview-latex-fragment (&optional subtree)
16688 "Preview the LaTeX fragment at point, or all locally or globally.
16689 If the cursor is in a LaTeX fragment, create the image and overlay
16690 it over the source code. If there is no fragment at point, display
16691 all fragments in the current text, from one headline to the next. With
16692 prefix SUBTREE, display all fragments in the current subtree. With a
16694 the cursor is before the first headline,
16695 display all fragments in the buffer.
16697 (interactive "P")
16698 (org-remove-latex-fragment-image-overlays)
16699 (save-excursion
16700 (save-restriction
16701 (let (beg end at msg)
16702 (cond
16703 ((or (equal subtree '(16))
16704 (not (save-excursion
16705 (re-search-backward org-outline-regexp-bol nil t))))
16706 (setq beg (point-min) end (point-max)
16707 msg "Creating images for buffer...%s"))
16708 ((equal subtree '(4))
16709 (org-back-to-heading)
16710 (setq beg (point) end (org-end-of-subtree t)
16711 msg "Creating images for subtree...%s"))
16712 (t
16713 (if (setq at (org-inside-LaTeX-fragment-p))
16714 (goto-char (max (point-min) (- (cdr at) 2)))
16715 (org-back-to-heading))
16716 (setq beg (point) end (progn (outline-next-heading) (point))
16717 msg (if at "Creating image...%s"
16718 "Creating images for entry...%s"))))
16719 (message msg "")
16720 (narrow-to-region beg end)
16721 (goto-char beg)
16722 (org-format-latex
16723 (concat "ltxpng/" (file-name-sans-extension
16724 (file-name-nondirectory
16725 buffer-file-name)))
16726 default-directory 'overlays msg at 'forbuffer 'dvipng)
16727 (message msg "done. Use `C-c C-c' to remove images.")))))
16729 (defvar org-latex-regexps
16731 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
16734 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
16738 "Regular expressions for matching embedded LaTeX.")
16740 (defvar org-export-have-math nil) ;; dynamic scoping
16741 (defun org-format-latex (prefix &optional dir overlays msg at
16742 forbuffer processing-type)
16743 "Replace LaTeX fragments with links to an image, and produce images.
16744 Some of the options can be changed using the variable
16745 `org-format-latex-options'."
16746 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
16747 (let* ((prefixnodir (file-name-nondirectory prefix))
16748 (absprefix (expand-file-name prefix dir))
16749 (todir (file-name-directory absprefix))
16750 (opt org-format-latex-options)
16751 (matchers (plist-get opt :matchers))
16752 (re-list org-latex-regexps)
16753 (org-format-latex-header-extra
16754 (plist-get (org-infile-export-plist) :latex-header-extra))
16755 (cnt 0) txt hash link beg end re e checkdir
16756 executables-checked string
16757 m n block-type block linkfile movefile ov)
16758 ;; Check the different regular expressions
16759 (while (setq e (pop re-list))
16760 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
16762 (when (member m matchers)
16763 (goto-char (point-min))
16764 (while (re-search-forward re nil t)
16765 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
16766 (not (get-text-property (match-beginning n)
16767 'org-protected))
16768 (or (not overlays)
16769 (not (eq (get-char-property (match-beginning n)
16770 'org-overlay-type)
16771 'org-latex-overlay))))
16772 (setq org-export-have-math t)
16773 (cond
16774 ((eq processing-type 'verbatim)
16775 ;; Leave the text verbatim, just protect it
16776 (add-text-properties (match-beginning n) (match-end n)
16777 '(org-protected t)))
16778 ((eq processing-type 'mathjax)
16779 ;; Prepare for MathJax processing
16780 (setq string (match-string n))
16781 (if (member m '("$" "$1"))
16782 (save-excursion
16783 (delete-region (match-beginning n) (match-end n))
16784 (goto-char (match-beginning n))
16787 '(org-protected t))))
16788 (add-text-properties (match-beginning n) (match-end n)
16789 '(org-protected t))))
16790 ((eq processing-type 'dvipng)
16791 ;; Process to an image
16792 (setq txt (match-string n)
16793 beg (match-beginning n) end (match-end n)
16794 cnt (1+ cnt))
16795 (let (print-length print-level) ; make sure full list is printed
16796 (setq hash (sha1 (prin1-to-string
16797 (list org-format-latex-header
16798 org-format-latex-header-extra
16799 org-export-latex-default-packages-alist
16800 org-export-latex-packages-alist
16801 org-format-latex-options
16802 forbuffer txt)))
16803 linkfile (format "%s_%s.png" prefix hash)
16804 movefile (format "%s_%s.png" absprefix hash)))
16805 (setq link (concat block "[[file:" linkfile "]]" block))
16806 (if msg (message msg cnt))
16807 (goto-char beg)
16808 (unless checkdir ; make sure the directory exists
16809 (setq checkdir t)
16810 (or (file-directory-p todir) (make-directory todir t)))
16812 (unless executables-checked
16813 (org-check-external-command
16814 "latex" "needed to convert LaTeX fragments to images")
16815 (org-check-external-command
16816 "dvipng" "needed to convert LaTeX fragments to images")
16817 (setq executables-checked t))
16819 (unless (file-exists-p movefile)
16820 (org-create-formula-image
16821 txt movefile opt forbuffer))
16822 (if overlays
16823 (progn
16824 (mapc (lambda (o)
16825 (if (eq (overlay-get o 'org-overlay-type)
16826 'org-latex-overlay)
16827 (delete-overlay o)))
16828 (overlays-in beg end))
16829 (setq ov (make-overlay beg end))
16830 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
16831 (if (featurep 'xemacs)
16832 (progn
16833 (overlay-put ov 'invisible t)
16834 (overlay-put
16835 ov 'end-glyph
16836 (make-glyph (vector 'png :file movefile))))
16837 (overlay-put
16838 ov 'display
16839 (list 'image :type 'png :file movefile :ascent 'center)))
16840 (push ov org-latex-fragment-image-overlays)
16841 (goto-char end))
16842 (delete-region beg end)
16843 (insert (org-add-props link
16844 (list 'org-latex-src
16845 (replace-regexp-in-string
16847 'org-latex-src-embed-type
16848 (if block-type 'paragraph 'character))))))
16849 ((eq processing-type 'mathml)
16850 ;; Process to MathML
16851 (unless executables-checked
16852 (unless (save-match-data (org-format-latex-mathml-available-p))
16853 (error "LaTeX to MathML converter not configured"))
16854 (setq executables-checked t))
16855 (setq txt (match-string n)
16856 beg (match-beginning n) end (match-end n)
16857 cnt (1+ cnt))
16858 (if msg (message msg cnt))
16859 (goto-char beg)
16860 (delete-region beg end)
16861 (insert (org-format-latex-as-mathml
16862 txt block-type prefix dir)))
16863 (t
16864 (error "Unknown conversion type %s for latex fragments"
16865 processing-type)))))))))
16867 (defun org-create-math-formula (latex-frag &optional mathml-file)
16868 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
16869 Use `org-latex-to-mathml-convert-command'. If the conversion is
16871 elements otherwise return nil. When MATHML-FILE is specified,
16872 write the results in to that file. When invoked as an
16873 interactive command, prompt for LATEX-FRAG, with initial value
16874 set to the current active region and echo the results for user
16875 inspection."
16876 (interactive (list (let ((frag (when (region-active-p)
16877 (buffer-substring-no-properties
16878 (region-beginning) (region-end)))))
16879 (read-string "LaTeX Fragment: " frag nil frag))))
16880 (unless latex-frag (error "Invalid latex-frag"))
16881 (let* ((tmp-in-file (file-relative-name
16882 (make-temp-name (expand-file-name "ltxmathml-in"))))
16883 (ignore (write-region latex-frag nil tmp-in-file))
16884 (tmp-out-file (file-relative-name
16885 (make-temp-name (expand-file-name "ltxmathml-out"))))
16886 (cmd (format-spec
16887 org-latex-to-mathml-convert-command
16888 `((?j . ,(shell-quote-argument
16889 (expand-file-name org-latex-to-mathml-jar-file)))
16890 (?I . ,(shell-quote-argument tmp-in-file))
16891 (?o . ,(shell-quote-argument tmp-out-file)))))
16892 mathml shell-command-output)
16893 (when (org-called-interactively-p 'any)
16894 (unless (org-format-latex-mathml-available-p)
16895 (error "LaTeX to MathML converter not configured")))
16896 (message "Running %s" cmd)
16897 (setq shell-command-output (shell-command-to-string cmd))
16898 (setq mathml
16899 (when (file-readable-p tmp-out-file)
16900 (with-current-buffer (find-file-noselect tmp-out-file t)
16901 (goto-char (point-min))
16902 (when (re-search-forward
16903 (concat
16904 (regexp-quote
16907 (regexp-quote "</math>")) nil t)
16908 (prog1 (match-string 0) (kill-buffer))))))
16909 (cond
16910 (mathml
16911 (setq mathml
16913 (when mathml-file
16914 (write-region mathml nil mathml-file))
16915 (when (org-called-interactively-p 'any)
16916 (message mathml)))
16917 ((message "LaTeX to MathML conversion failed")
16918 (message shell-command-output)))
16919 (delete-file tmp-in-file)
16920 (when (file-exists-p tmp-out-file)
16921 (delete-file tmp-out-file))
16922 mathml))
16924 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
16925 prefix &optional dir)
16926 "Use `org-create-math-formula' but check local cache first."
16927 (let* ((absprefix (expand-file-name prefix dir))
16928 (print-length nil) (print-level nil)
16929 (formula-id (concat
16930 "formula-"
16931 (sha1
16932 (prin1-to-string
16933 (list latex-frag
16934 org-latex-to-mathml-convert-command)))))
16935 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
16936 (formula-cache-dir (file-name-directory formula-cache)))
16938 (unless (file-directory-p formula-cache-dir)
16939 (make-directory formula-cache-dir t))
16941 (unless (file-exists-p formula-cache)
16942 (org-create-math-formula latex-frag formula-cache))
16944 (if (file-exists-p formula-cache)
16945 ;; Successful conversion. Return the link to MathML file.
16946 (org-add-props
16947 (format "[[file:%s]]" (file-relative-name formula-cache dir))
16949 'org-latex-src-embed-type (if latex-frag-type
16950 'paragraph 'character)))
16951 ;; Failed conversion. Return the LaTeX fragment verbatim
16952 (add-text-properties
16953 0 (1- (length latex-frag)) '(org-protected t) latex-frag)
16954 latex-frag)))
16956 ;; This function borrows from Ganesh Swami's latex2png.el
16957 (defun org-create-formula-image (string tofile options buffer)
16958 "This calls dvipng."
16959 (require 'org-latex)
16960 (let* ((tmpdir (if (featurep 'xemacs)
16961 (temp-directory)
16962 temporary-file-directory))
16963 (texfilebase (make-temp-name
16964 (expand-file-name "orgtex" tmpdir)))
16965 (texfile (concat texfilebase ".tex"))
16966 (dvifile (concat texfilebase ".dvi"))
16967 (pngfile (concat texfilebase ".png"))
16968 (fnh (if (featurep 'xemacs)
16969 (font-height (get-face-font 'default))
16970 (face-attribute 'default :height nil)))
16971 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
16972 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
16973 (fg (or (plist-get options (if buffer :foreground :html-foreground))
16974 "Black"))
16975 (bg (or (plist-get options (if buffer :background :html-background))
16976 "Transparent")))
16977 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground)))
16978 (if (eq bg 'default) (setq bg (org-dvipng-color :background)))
16979 (with-temp-file texfile
16980 (insert (org-splice-latex-header
16981 org-format-latex-header
16982 org-export-latex-default-packages-alist
16983 org-export-latex-packages-alist t
16984 org-format-latex-header-extra))
16986 (require 'org-latex)
16987 (org-export-latex-fix-inputenc))
16988 (let ((dir default-directory))
16989 (condition-case nil
16990 (progn
16991 (cd tmpdir)
16992 (call-process "latex" nil nil nil texfile))
16993 (error nil))
16994 (cd dir))
16995 (if (not (file-exists-p dvifile))
16996 (progn (message "Failed to create dvi file from %s" texfile) nil)
16997 (condition-case nil
16998 (call-process "dvipng" nil nil nil
16999 "-fg" fg "-bg" bg
17000 "-D" dpi
17001 ;;"-x" scale "-y" scale
17002 "-T" "tight"
17003 "-o" pngfile
17004 dvifile)
17005 (error nil))
17006 (if (not (file-exists-p pngfile))
17007 (if org-format-latex-signal-error
17008 (error "Failed to create png file from %s" texfile)
17009 (message "Failed to create png file from %s" texfile)
17010 nil)
17011 ;; Use the requested file name and clean up
17012 (copy-file pngfile tofile 'replace)
17013 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png") do
17014 (delete-file (concat texfilebase e)))
17015 pngfile))))
17017 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
17018 "Fill a LaTeX header template TPL.
17019 In the template, the following place holders will be recognized:
17022 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
17024 [NO-PACKAGES] do not include PKG
17025 [EXTRA] the string EXTRA
17026 [NO-EXTRA] do not include EXTRA
17028 For backward compatibility, if both the positive and the negative place
17030 assumed to be present at the end of the template.
17031 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
17032 EXTRA is a string.
17033 SNIPPETS-P indicates if this is run to create snippet images for HTML."
17034 (let (rpl (end ""))
17036 (setq rpl (if (or (match-end 1) (not def-pkg))
17037 "" (org-latex-packages-to-string def-pkg snippets-p t))
17038 tpl (replace-match rpl t t tpl))
17039 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
17042 (setq rpl (if (or (match-end 1) (not pkg))
17043 "" (org-latex-packages-to-string pkg snippets-p t))
17044 tpl (replace-match rpl t t tpl))
17045 (if pkg (setq end
17047 (org-latex-packages-to-string pkg snippets-p)))))
17050 (setq rpl (if (or (match-end 1) (not extra))
17052 tpl (replace-match rpl t t tpl))
17058 tpl)))
17060 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
17062 (setq pkg (mapconcat (lambda(p)
17063 (cond
17064 ((stringp p) p)
17065 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
17066 (format "%% Package %s omitted" (cadr p)))
17067 ((equal "" (car p))
17069 (t
17071 (car p) (cadr p)))))
17072 pkg
17076 (defun org-dvipng-color (attr)
17077 "Return an rgb color specification for dvipng."
17078 (apply 'format "rgb %s %s %s"
17079 (mapcar 'org-normalize-color
17080 (color-values (face-attribute 'default attr nil)))))
17082 (defun org-normalize-color (value)
17083 "Return string to be used as color value for an RGB component."
17084 (format "%g" (/ value 65535.0)))
17086 ;; Image display
17089 (defvar org-inline-image-overlays nil)
17090 (make-variable-buffer-local 'org-inline-image-overlays)
17092 (defun org-toggle-inline-images (&optional include-linked)
17093 "Toggle the display of inline images.
17094 INCLUDE-LINKED is passed to `org-display-inline-images'."
17095 (interactive "P")
17096 (if org-inline-image-overlays
17097 (progn
17098 (org-remove-inline-images)
17099 (message "Inline image display turned off"))
17100 (org-display-inline-images include-linked)
17101 (if org-inline-image-overlays
17102 (message "%d images displayed inline"
17103 (length org-inline-image-overlays))
17104 (message "No images to display inline"))))
17106 (defun org-display-inline-images (&optional include-linked refresh beg end)
17107 "Display inline images.
17108 Normally only links without a description part are inlined, because this
17109 is how it will work for export. When INCLUDE-LINKED is set, also links
17110 with a description part will be inlined. This can be nice for a quick
17111 look at those images, but it does not reflect what exported files will look
17112 like.
17113 When REFRESH is set, refresh existing images between BEG and END.
17114 This will create new image displays only if necessary.
17115 BEG and END default to the buffer boundaries."
17116 (interactive "P")
17117 (unless refresh
17118 (org-remove-inline-images)
17119 (if (fboundp 'clear-image-cache) (clear-image-cache)))
17120 (save-excursion
17121 (save-restriction
17122 (widen)
17123 (setq beg (or beg (point-min)) end (or end (point-max)))
17124 (goto-char (point-min))
17126 (substring (org-image-file-name-regexp) 0 -2)
17128 old file ov img)
17129 (while (re-search-forward re end t)
17130 (setq old (get-char-property-and-overlay (match-beginning 1)
17131 'org-image-overlay))
17132 (setq file (expand-file-name
17133 (concat (or (match-string 3) "") (match-string 4))))
17134 (when (file-exists-p file)
17135 (if (and (car-safe old) refresh)
17136 (image-refresh (overlay-get (cdr old) 'display))
17137 (setq img (save-match-data (create-image file)))
17138 (when img
17139 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
17140 (overlay-put ov 'display img)
17141 (overlay-put ov 'face 'default)
17142 (overlay-put ov 'org-image-overlay t)
17143 (overlay-put ov 'modification-hooks
17144 (list 'org-display-inline-modification-hook))
17145 (push ov org-inline-image-overlays)))))))))
17147 (defun org-display-inline-modification-hook (ov after beg end &optional len)
17148 "Remove inline-display overlay if a corresponding region is modified."
17149 (let ((inhibit-modification-hooks t))
17150 (when (and ov after)
17151 (delete ov org-inline-image-overlays)
17152 (delete-overlay ov))))
17154 (defun org-remove-inline-images ()
17155 "Remove inline display of images."
17156 (interactive)
17157 (mapc 'delete-overlay org-inline-image-overlays)
17158 (setq org-inline-image-overlays nil))
17160 ;;;; Key bindings
17162 ;; Outline functions from `outline-mode-prefix-map'
17163 ;; that can be remapped in Org:
17164 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
17165 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
17166 (define-key org-mode-map [remap outline-forward-same-level]
17167 'org-forward-same-level)
17168 (define-key org-mode-map [remap outline-backward-same-level]
17169 'org-backward-same-level)
17170 (define-key org-mode-map [remap show-branches]
17171 'org-kill-note-or-show-branches)
17172 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
17173 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
17174 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
17176 ;; Outline functions from `outline-mode-prefix-map'
17177 ;; that can not be remapped in Org:
17178 ;; - the column "key binding" shows whether the Outline function is still
17179 ;; available in Org mode on the same key that it has been bound to in
17180 ;; Outline mode:
17181 ;; - "overridden": key used for a different functionality in Org mode
17182 ;; - else: key still bound to the same Outline function in Org mode
17183 ;; | Outline function | key binding | Org replacement |
17184 ;; |------------------------------------+-------------+-----------------------|
17185 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
17186 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
17187 ;; | `show-children' | `C-c C-i' | visibility cycling |
17188 ;; | `hide-subtree' | overridden | visibility cycling |
17189 ;; | `outline-up-heading' | `C-c C-u' | still same function |
17190 ;; | `hide-body' | overridden | no replacement |
17191 ;; | `show-all' | overridden | no replacement |
17192 ;; | `hide-entry' | overridden | visibility cycling |
17193 ;; | `show-entry' | overridden | no replacement |
17194 ;; | `hide-leaves' | overridden | no replacement |
17195 ;; | `hide-sublevels' | overridden | no replacement |
17196 ;; | `hide-other' | overridden | no replacement |
17197 ;; | `outline-move-subtree-up' | `C-c C-^' | better: org-shiftup |
17198 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
17200 ;; Make `C-c C-x' a prefix key
17201 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
17203 ;; TAB key with modifiers
17204 (org-defkey org-mode-map "\C-i" 'org-cycle)
17205 (org-defkey org-mode-map [(tab)] 'org-cycle)
17206 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
17207 (org-defkey org-mode-map [(meta tab)] 'pcomplete)
17209 (org-defkey org-mode-map "\M-\C-i" 'pcomplete)
17210 ;; The following line is necessary under Suse GNU/Linux
17211 (unless (featurep 'xemacs)
17212 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
17213 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
17214 (define-key org-mode-map [backtab] 'org-shifttab)
17216 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
17217 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
17218 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
17220 ;; Cursor keys with modifiers
17221 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
17222 (org-defkey org-mode-map [(meta right)] 'org-metaright)
17223 (org-defkey org-mode-map [(meta up)] 'org-metaup)
17224 (org-defkey org-mode-map [(meta down)] 'org-metadown)
17226 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
17227 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
17228 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
17229 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
17231 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
17232 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
17233 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
17234 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
17236 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
17237 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
17238 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
17239 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
17241 ;; Babel keys
17242 (define-key org-mode-map org-babel-key-prefix org-babel-map)
17243 (mapc (lambda (pair)
17244 (define-key org-babel-map (car pair) (cdr pair)))
17245 org-babel-key-bindings)
17247 ;;; Extra keys for tty access.
17248 ;; We only set them when really needed because otherwise the
17249 ;; menus don't show the simple keys
17251 (when (or org-use-extra-keys
17252 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
17253 (not window-system))
17254 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
17255 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
17256 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
17257 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
17258 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
17259 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
17260 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
17261 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
17262 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
17263 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
17264 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
17265 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
17266 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
17267 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
17268 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
17269 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
17270 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
17271 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
17272 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
17273 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
17274 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
17275 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
17276 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
17277 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
17278 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
17279 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
17280 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
17281 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
17283 ;; All the other keys
17285 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
17286 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
17287 (if (boundp 'narrow-map)
17288 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
17289 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
17290 (if (boundp 'narrow-map)
17291 (org-defkey narrow-map "b" 'org-narrow-to-block)
17292 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
17293 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-same-level)
17294 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-same-level)
17295 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
17296 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
17297 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
17298 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
17299 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
17300 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
17301 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
17302 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
17303 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
17304 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
17305 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
17306 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
17307 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
17308 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
17310 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
17311 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
17312 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
17313 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
17314 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
17315 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
17316 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
17317 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
17318 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
17319 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
17320 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
17321 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
17322 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
17323 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
17324 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
17325 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
17326 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
17327 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
17328 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
17329 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
17331 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
17332 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
17333 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
17334 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
17335 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
17336 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
17337 (org-defkey org-mode-map "\C-c^" 'org-sort)
17338 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
17339 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
17340 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
17341 (org-defkey org-mode-map "\C-m" 'org-return)
17342 (org-defkey org-mode-map "\C-j" 'org-return-indent)
17343 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
17344 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
17345 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
17346 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
17347 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
17348 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
17349 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
17350 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
17351 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
17352 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
17353 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
17354 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
17355 (org-defkey org-mode-map "\C-c\C-e" 'org-export)
17356 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
17357 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
17358 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
17359 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
17360 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
17361 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
17362 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
17363 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
17365 (org-defkey org-mode-map "\C-c\C-x\C-k" 'org-mark-entry-for-agenda-action)
17366 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
17367 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
17368 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
17370 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
17371 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
17372 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
17373 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
17374 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-cancel)
17375 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
17376 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
17377 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
17378 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
17379 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
17381 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
17382 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
17383 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
17384 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
17385 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
17386 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
17387 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
17389 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
17390 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
17391 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
17392 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
17393 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
17395 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
17397 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
17399 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
17400 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
17402 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
17405 (when (featurep 'xemacs)
17406 (org-defkey org-mode-map 'button3 'popup-mode-menu))
17409 (defconst org-speed-commands-default
17410 '(
17411 ("Outline Navigation")
17412 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
17413 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
17414 ("f" . (org-speed-move-safe 'org-forward-same-level))
17415 ("b" . (org-speed-move-safe 'org-backward-same-level))
17416 ("u" . (org-speed-move-safe 'outline-up-heading))
17417 ("j" . org-goto)
17418 ("g" . (org-refile t))
17419 ("Outline Visibility")
17420 ("c" . org-cycle)
17421 ("C" . org-shifttab)
17422 (" " . org-display-outline-path)
17423 ("Outline Structure Editing")
17424 ("U" . org-shiftmetaup)
17425 ("D" . org-shiftmetadown)
17426 ("r" . org-metaright)
17427 ("l" . org-metaleft)
17428 ("R" . org-shiftmetaright)
17429 ("L" . org-shiftmetaleft)
17430 ("i" . (progn (forward-char 1) (call-interactively
17431 'org-insert-heading-respect-content)))
17432 ("^" . org-sort)
17433 ("w" . org-refile)
17434 ("a" . org-archive-subtree-default-with-confirmation)
17435 ("." . org-mark-subtree)
17436 ("Clock Commands")
17437 ("I" . org-clock-in)
17438 ("O" . org-clock-out)
17439 ("Meta Data Editing")
17440 ("t" . org-todo)
17441 ("0" . (org-priority ?\ ))
17442 ("1" . (org-priority ?A))
17443 ("2" . (org-priority ?B))
17444 ("3" . (org-priority ?C))
17445 (";" . org-set-tags-command)
17446 ("e" . org-set-effort)
17447 ("Agenda Views etc")
17448 ("v" . org-agenda)
17449 ("/" . org-sparse-tree)
17450 ("Misc")
17451 ("o" . org-open-at-point)
17452 ("?" . org-speed-command-help)
17453 ("<" . (org-agenda-set-restriction-lock 'subtree))
17454 (">" . (org-agenda-remove-restriction-lock))
17455 )
17456 "The default speed commands.")
17458 (defun org-print-speed-command (e)
17459 (if (> (length (car e)) 1)
17460 (progn
17462 (princ (car e))
17464 (princ (make-string (length (car e)) ?-))
17466 (princ (car e))
17467 (princ " ")
17468 (if (symbolp (cdr e))
17469 (princ (symbol-name (cdr e)))
17470 (prin1 (cdr e)))
17473 (defun org-speed-command-help ()
17474 "Show the available speed commands."
17475 (interactive)
17476 (if (not org-use-speed-commands)
17477 (error "Speed commands are not activated, customize `org-use-speed-commands'")
17478 (with-output-to-temp-buffer "*Help*"
17480 (mapc 'org-print-speed-command org-speed-commands-user)
17483 (mapc 'org-print-speed-command org-speed-commands-default))
17484 (with-current-buffer "*Help*"
17485 (setq truncate-lines t))))
17487 (defun org-speed-move-safe (cmd)
17488 "Execute CMD, but make sure that the cursor always ends up in a headline.
17489 If not, return to the original position and throw an error."
17490 (interactive)
17491 (let ((pos (point)))
17492 (call-interactively cmd)
17493 (unless (and (bolp) (org-at-heading-p))
17494 (goto-char pos)
17495 (error "Boundary reached while executing %s" cmd))))
17497 (defvar org-self-insert-command-undo-counter 0)
17499 (defvar org-table-auto-blank-field) ; defined in org-table.el
17500 (defvar org-speed-command nil)
17502 (defun org-speed-command-default-hook (keys)
17503 "Hook for activating single-letter speed commands.
17504 `org-speed-commands-default' specifies a minimal command set.
17505 Use `org-speed-commands-user' for further customization."
17506 (when (or (and (bolp) (looking-at org-outline-regexp))
17507 (and (functionp org-use-speed-commands)
17508 (funcall org-use-speed-commands)))
17509 (cdr (assoc keys (append org-speed-commands-user
17510 org-speed-commands-default)))))
17512 (defun org-babel-speed-command-hook (keys)
17513 "Hook for activating single-letter code block commands."
17514 (when (and (bolp) (looking-at org-babel-src-block-regexp))
17515 (cdr (assoc keys org-babel-key-bindings))))
17517 (defcustom org-speed-command-hook
17518 '(org-speed-command-default-hook org-babel-speed-command-hook)
17519 "Hook for activating speed commands at strategic locations.
17520 Hook functions are called in sequence until a valid handler is
17521 found.
17523 Each hook takes a single argument, a user-pressed command key
17524 which is also a `self-insert-command' from the global map.
17526 Within the hook, examine the cursor position and the command key
17527 and return nil or a valid handler as appropriate. Handler could
17528 be one of an interactive command, a function, or a form.
17530 Set `org-use-speed-commands' to non-nil value to enable this
17531 hook. The default setting is `org-speed-command-default-hook'."
17532 :group 'org-structure
17533 :type 'hook)
17535 (defun org-self-insert-command (N)
17536 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
17537 If the cursor is in a table looking at whitespace, the whitespace is
17538 overwritten, and the table is not marked as requiring realignment."
17539 (interactive "p")
17540 (org-check-before-invisible-edit 'insert)
17541 (cond
17542 ((and org-use-speed-commands
17543 (setq org-speed-command
17544 (run-hook-with-args-until-success
17545 'org-speed-command-hook (this-command-keys))))
17546 (cond
17547 ((commandp org-speed-command)
17548 (setq this-command org-speed-command)
17549 (call-interactively org-speed-command))
17550 ((functionp org-speed-command)
17551 (funcall org-speed-command))
17552 ((and org-speed-command (listp org-speed-command))
17553 (eval org-speed-command))
17554 (t (let (org-use-speed-commands)
17555 (call-interactively 'org-self-insert-command)))))
17556 ((and
17557 (org-table-p)
17558 (progn
17559 ;; check if we blank the field, and if that triggers align
17560 (and (featurep 'org-table) org-table-auto-blank-field
17561 (member last-command
17562 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
17564 ;; got extra space, this field does not determine column width
17565 (let (org-table-may-need-update) (org-table-blank-field))
17566 ;; no extra space, this field may determine column width
17567 (org-table-blank-field)))
17568 t)
17569 (eq N 1)
17571 (let (org-table-may-need-update)
17572 (goto-char (1- (match-end 0)))
17573 (delete-char -1)
17574 (goto-char (match-beginning 0))
17575 (self-insert-command N)))
17576 (t
17577 (setq org-table-may-need-update t)
17578 (self-insert-command N)
17579 (org-fix-tags-on-the-fly)
17580 (if org-self-insert-cluster-for-undo
17581 (if (not (eq last-command 'org-self-insert-command))
17582 (setq org-self-insert-command-undo-counter 1)
17583 (if (>= org-self-insert-command-undo-counter 20)
17584 (setq org-self-insert-command-undo-counter 1)
17585 (and (> org-self-insert-command-undo-counter 0)
17586 buffer-undo-list (listp buffer-undo-list)
17587 (not (cadr buffer-undo-list)) ; remove nil entry
17588 (setcdr buffer-undo-list (cddr buffer-undo-list)))
17589 (setq org-self-insert-command-undo-counter
17590 (1+ org-self-insert-command-undo-counter))))))))
17592 (defun org-check-before-invisible-edit (kind)
17593 "Check is editing if kind KIND would be dangerous with invisible text around.
17594 The detailed reaction depends on the user option `org-catch-invisible-edits'."
17595 ;; First, try to get out of here as quickly as possible, to reduce overhead
17596 (if (and org-catch-invisible-edits
17597 (or (not (boundp 'visible-mode)) (not visible-mode))
17598 (or (get-char-property (point) 'invisible)
17599 (get-char-property (max (point-min) (1- (point))) 'invisible)))
17600 ;; OK, we need to take a closer look
17601 (let* ((invisible-at-point (get-char-property (point) 'invisible))
17602 (invisible-before-point (if (bobp) nil (get-char-property
17603 (1- (point)) 'invisible)))
17604 (border-and-ok-direction
17605 (or
17606 ;; Check if we are acting predictably before invisible text
17607 (and invisible-at-point (not invisible-before-point)
17608 (memq kind '(insert delete-backward)))
17609 ;; Check if we are acting predictably after invisible text
17610 ;; This works not well, and I have turned it off. It seems
17611 ;; better to always show and stop after invisible text.
17612 ;; (and (not invisible-at-point) invisible-before-point
17613 ;; (memq kind '(insert delete)))
17614 )))
17616 (when (or (memq invisible-at-point '(outline org-hide-block))
17617 (memq invisible-before-point '(outline org-hide-block)))
17618 (if (eq org-catch-invisible-edits 'error)
17619 (error "Editing in invisible areas is prohibited - make visible first"))
17620 ;; Make the area visible
17621 (save-excursion
17622 (if invisible-before-point
17623 (goto-char (previous-single-char-property-change
17624 (point) 'invisible)))
17625 (org-cycle))
17626 (cond
17627 ((eq org-catch-invisible-edits 'show)
17628 ;; That's it, we do the edit after showing
17629 (message
17630 "Unfolding invisible region around point before editing")
17631 (sit-for 1))
17632 ((and (eq org-catch-invisible-edits 'smart)
17633 border-and-ok-direction)
17634 (message "Unfolding invisible region around point before editing"))
17635 (t
17636 ;; Don't do the edit, make the user repeat it in full visibility
17637 (error "Edit in invisible region aborted, repeat to confirm with text visible")))))))
17639 (defun org-fix-tags-on-the-fly ()
17640 (when (and (equal (char-after (point-at-bol)) ?*)
17641 (org-at-heading-p))
17642 (org-align-tags-here org-tags-column)))
17644 (defun org-delete-backward-char (N)
17645 "Like `delete-backward-char', insert whitespace at field end in tables.
17646 When deleting backwards, in tables this function will insert whitespace in
17648 still be marked for re-alignment if the field did fill the entire column,
17649 because, in this case the deletion might narrow the column."
17650 (interactive "p")
17651 (org-check-before-invisible-edit 'delete-backward)
17652 (if (and (org-table-p)
17653 (eq N 1)
17654 (string-match "|" (buffer-substring (point-at-bol) (point)))
17655 (looking-at ".*?|"))
17656 (let ((pos (point))
17658 (c org-table-may-need-update))
17659 (backward-delete-char N)
17660 (if (not overwrite-mode)
17661 (progn
17662 (skip-chars-forward "^|")
17663 (insert " ")
17664 (goto-char (1- pos))))
17665 ;; noalign: if there were two spaces at the end, this field
17666 ;; does not determine the width of the column.
17667 (if noalign (setq org-table-may-need-update c)))
17668 (backward-delete-char N)
17669 (org-fix-tags-on-the-fly)))
17671 (defun org-delete-char (N)
17672 "Like `delete-char', but insert whitespace at field end in tables.
17673 When deleting characters, in tables this function will insert whitespace in
17675 still be marked for re-alignment if the field did fill the entire column,
17676 because, in this case the deletion might narrow the column."
17677 (interactive "p")
17678 (org-check-before-invisible-edit 'delete)
17679 (if (and (org-table-p)
17680 (not (bolp))
17681 (not (= (char-after) ?|))
17682 (eq N 1))
17683 (if (looking-at ".*?|")
17684 (let ((pos (point))
17686 (c org-table-may-need-update))
17687 (replace-match (concat
17688 (substring (match-string 0) 1 -1)
17689 " |"))
17690 (goto-char pos)
17691 ;; noalign: if there were two spaces at the end, this field
17692 ;; does not determine the width of the column.
17693 (if noalign (setq org-table-may-need-update c)))
17694 (delete-char N))
17695 (delete-char N)
17696 (org-fix-tags-on-the-fly)))
17698 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
17699 (put 'org-self-insert-command 'delete-selection t)
17700 (put 'orgtbl-self-insert-command 'delete-selection t)
17701 (put 'org-delete-char 'delete-selection 'supersede)
17702 (put 'org-delete-backward-char 'delete-selection 'supersede)
17703 (put 'org-yank 'delete-selection 'yank)
17705 ;; Make `flyspell-mode' delay after some commands
17706 (put 'org-self-insert-command 'flyspell-delayed t)
17707 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
17708 (put 'org-delete-char 'flyspell-delayed t)
17709 (put 'org-delete-backward-char 'flyspell-delayed t)
17711 ;; Make pabbrev-mode expand after org-mode commands
17712 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
17713 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
17715 ;; How to do this: Measure non-white length of current string
17716 ;; If equal to column width, we should realign.
17718 (defun org-remap (map &rest commands)
17719 "In MAP, remap the functions given in COMMANDS.
17720 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
17721 (let (new old)
17722 (while commands
17723 (setq old (pop commands) new (pop commands))
17724 (if (fboundp 'command-remapping)
17725 (org-defkey map (vector 'remap old) new)
17726 (substitute-key-definition old new map global-map)))))
17728 (when (eq org-enable-table-editor 'optimized)
17729 ;; If the user wants maximum table support, we need to hijack
17730 ;; some standard editing functions
17731 (org-remap org-mode-map
17732 'self-insert-command 'org-self-insert-command
17733 'delete-char 'org-delete-char
17734 'delete-backward-char 'org-delete-backward-char)
17735 (org-defkey org-mode-map "|" 'org-force-self-insert))
17737 (defvar org-ctrl-c-ctrl-c-hook nil
17738 "Hook for functions attaching themselves to `C-c C-c'.
17740 This can be used to add additional functionality to the C-c C-c
17741 key which executes context-dependent commands. This hook is run
17742 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
17743 run after the last test.
17745 Each function will be called with no arguments. The function
17746 must check if the context is appropriate for it to act. If yes,
17747 it should do its thing and then return a non-nil value. If the
17748 context is wrong, just do nothing and return nil.")
17750 (defvar org-ctrl-c-ctrl-c-final-hook nil
17751 "Hook for functions attaching themselves to `C-c C-c'.
17753 This can be used to add additional functionality to the C-c C-c
17754 key which executes context-dependent commands. This hook is run
17755 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
17756 before the first test.
17758 Each function will be called with no arguments. The function
17759 must check if the context is appropriate for it to act. If yes,
17760 it should do its thing and then return a non-nil value. If the
17761 context is wrong, just do nothing and return nil.")
17763 (defvar org-tab-first-hook nil
17764 "Hook for functions to attach themselves to TAB.
17765 See `org-ctrl-c-ctrl-c-hook' for more information.
17766 This hook runs as the first action when TAB is pressed, even before
17767 `org-cycle' messes around with the `outline-regexp' to cater for
17768 inline tasks and plain list item folding.
17769 If any function in this hook returns t, any other actions that
17770 would have been caused by TAB (such as table field motion or visibility
17771 cycling) will not occur.")
17773 (defvar org-tab-after-check-for-table-hook nil
17774 "Hook for functions to attach themselves to TAB.
17775 See `org-ctrl-c-ctrl-c-hook' for more information.
17776 This hook runs after it has been established that the cursor is not in a
17777 table, but before checking if the cursor is in a headline or if global cycling
17778 should be done.
17779 If any function in this hook returns t, not other actions like visibility
17780 cycling will be done.")
17782 (defvar org-tab-after-check-for-cycling-hook nil
17783 "Hook for functions to attach themselves to TAB.
17784 See `org-ctrl-c-ctrl-c-hook' for more information.
17785 This hook runs after it has been established that not table field motion and
17786 not visibility should be done because of current context. This is probably
17787 the place where a package like yasnippets can hook in.")
17789 (defvar org-tab-before-tab-emulation-hook nil
17790 "Hook for functions to attach themselves to TAB.
17791 See `org-ctrl-c-ctrl-c-hook' for more information.
17792 This hook runs after every other options for TAB have been exhausted, but
17795 (defvar org-metaleft-hook nil
17796 "Hook for functions attaching themselves to `M-left'.
17797 See `org-ctrl-c-ctrl-c-hook' for more information.")
17798 (defvar org-metaright-hook nil
17799 "Hook for functions attaching themselves to `M-right'.
17800 See `org-ctrl-c-ctrl-c-hook' for more information.")
17801 (defvar org-metaup-hook nil
17802 "Hook for functions attaching themselves to `M-up'.
17803 See `org-ctrl-c-ctrl-c-hook' for more information.")
17804 (defvar org-metadown-hook nil
17805 "Hook for functions attaching themselves to `M-down'.
17806 See `org-ctrl-c-ctrl-c-hook' for more information.")
17807 (defvar org-shiftmetaleft-hook nil
17808 "Hook for functions attaching themselves to `M-S-left'.
17809 See `org-ctrl-c-ctrl-c-hook' for more information.")
17810 (defvar org-shiftmetaright-hook nil
17811 "Hook for functions attaching themselves to `M-S-right'.
17812 See `org-ctrl-c-ctrl-c-hook' for more information.")
17813 (defvar org-shiftmetaup-hook nil
17814 "Hook for functions attaching themselves to `M-S-up'.
17815 See `org-ctrl-c-ctrl-c-hook' for more information.")
17816 (defvar org-shiftmetadown-hook nil
17817 "Hook for functions attaching themselves to `M-S-down'.
17818 See `org-ctrl-c-ctrl-c-hook' for more information.")
17819 (defvar org-metareturn-hook nil
17820 "Hook for functions attaching themselves to `M-RET'.
17821 See `org-ctrl-c-ctrl-c-hook' for more information.")
17822 (defvar org-shiftup-hook nil
17823 "Hook for functions attaching themselves to `S-up'.
17824 See `org-ctrl-c-ctrl-c-hook' for more information.")
17825 (defvar org-shiftup-final-hook nil
17826 "Hook for functions attaching themselves to `S-up'.
17827 This one runs after all other options except shift-select have been excluded.
17828 See `org-ctrl-c-ctrl-c-hook' for more information.")
17829 (defvar org-shiftdown-hook nil
17830 "Hook for functions attaching themselves to `S-down'.
17831 See `org-ctrl-c-ctrl-c-hook' for more information.")
17832 (defvar org-shiftdown-final-hook nil
17833 "Hook for functions attaching themselves to `S-down'.
17834 This one runs after all other options except shift-select have been excluded.
17835 See `org-ctrl-c-ctrl-c-hook' for more information.")
17836 (defvar org-shiftleft-hook nil
17837 "Hook for functions attaching themselves to `S-left'.
17838 See `org-ctrl-c-ctrl-c-hook' for more information.")
17839 (defvar org-shiftleft-final-hook nil
17840 "Hook for functions attaching themselves to `S-left'.
17841 This one runs after all other options except shift-select have been excluded.
17842 See `org-ctrl-c-ctrl-c-hook' for more information.")
17843 (defvar org-shiftright-hook nil
17844 "Hook for functions attaching themselves to `S-right'.
17845 See `org-ctrl-c-ctrl-c-hook' for more information.")
17846 (defvar org-shiftright-final-hook nil
17847 "Hook for functions attaching themselves to `S-right'.
17848 This one runs after all other options except shift-select have been excluded.
17849 See `org-ctrl-c-ctrl-c-hook' for more information.")
17851 (defun org-modifier-cursor-error ()
17852 "Throw an error, a modified cursor command was applied in wrong context."
17853 (error "This command is active in special context like tables, headlines or items"))
17855 (defun org-shiftselect-error ()
17856 "Throw an error because Shift-Cursor command was applied in wrong context."
17857 (if (and (boundp 'shift-select-mode) shift-select-mode)
17858 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
17859 (error "This command works only in special context like headlines or timestamps")))
17861 (defun org-call-for-shift-select (cmd)
17862 (let ((this-command-keys-shift-translated t))
17863 (call-interactively cmd)))
17865 (defun org-shifttab (&optional arg)
17866 "Global visibility cycling or move to previous table field.
17867 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
17868 on context.
17869 See the individual commands for more information."
17870 (interactive "P")
17871 (cond
17872 ((org-at-table-p) (call-interactively 'org-table-previous-field))
17873 ((integerp arg)
17874 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
17875 (message "Content view to level: %d" arg)
17876 (org-content (prefix-numeric-value arg2))
17877 (setq org-cycle-global-status 'overview)))
17878 (t (call-interactively 'org-global-cycle))))
17880 (defun org-shiftmetaleft ()
17881 "Promote subtree or delete table column.
17882 Calls `org-promote-subtree', `org-outdent-item',
17883 or `org-table-delete-column', depending on context.
17884 See the individual commands for more information."
17885 (interactive)
17886 (cond
17887 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
17888 ((org-at-table-p) (call-interactively 'org-table-delete-column))
17889 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
17890 ((org-at-item-p) (call-interactively 'org-outdent-item-tree))
17891 (t (org-modifier-cursor-error))))
17893 (defun org-shiftmetaright ()
17894 "Demote subtree or insert table column.
17895 Calls `org-demote-subtree', `org-indent-item',
17896 or `org-table-insert-column', depending on context.
17897 See the individual commands for more information."
17898 (interactive)
17899 (cond
17900 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
17901 ((org-at-table-p) (call-interactively 'org-table-insert-column))
17902 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
17903 ((org-at-item-p) (call-interactively 'org-indent-item-tree))
17904 (t (org-modifier-cursor-error))))
17906 (defun org-shiftmetaup (&optional arg)
17907 "Move subtree up or kill table row.
17908 Calls `org-move-subtree-up' or `org-table-kill-row' or
17909 `org-move-item-up' depending on context. See the individual commands
17910 for more information."
17911 (interactive "P")
17912 (cond
17913 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
17914 ((org-at-table-p) (call-interactively 'org-table-kill-row))
17915 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
17916 ((org-at-item-p) (call-interactively 'org-move-item-up))
17917 (t (org-modifier-cursor-error))))
17919 (defun org-shiftmetadown (&optional arg)
17920 "Move subtree down or insert table row.
17921 Calls `org-move-subtree-down' or `org-table-insert-row' or
17922 `org-move-item-down', depending on context. See the individual
17923 commands for more information."
17924 (interactive "P")
17925 (cond
17926 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
17927 ((org-at-table-p) (call-interactively 'org-table-insert-row))
17928 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
17929 ((org-at-item-p) (call-interactively 'org-move-item-down))
17930 (t (org-modifier-cursor-error))))
17932 (defsubst org-hidden-tree-error ()
17933 (error
17934 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
17936 (defun org-metaleft (&optional arg)
17937 "Promote heading or move table column to left.
17938 Calls `org-do-promote' or `org-table-move-column', depending on context.
17939 With no specific context, calls the Emacs default `backward-word'.
17940 See the individual commands for more information."
17941 (interactive "P")
17942 (cond
17943 ((run-hook-with-args-until-success 'org-metaleft-hook))
17944 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
17945 ((org-with-limited-levels
17946 (or (org-at-heading-p)
17947 (and (org-region-active-p)
17948 (save-excursion
17949 (goto-char (region-beginning))
17950 (org-at-heading-p)))))
17951 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17952 (call-interactively 'org-do-promote))
17953 ;; At an inline task.
17954 ((org-at-heading-p)
17955 (call-interactively 'org-inlinetask-promote))
17956 ((or (org-at-item-p)
17957 (and (org-region-active-p)
17958 (save-excursion
17959 (goto-char (region-beginning))
17960 (org-at-item-p))))
17961 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17962 (call-interactively 'org-outdent-item))
17963 (t (call-interactively 'backward-word))))
17965 (defun org-metaright (&optional arg)
17966 "Demote subtree or move table column to right.
17967 Calls `org-do-demote' or `org-table-move-column', depending on context.
17968 With no specific context, calls the Emacs default `forward-word'.
17969 See the individual commands for more information."
17970 (interactive "P")
17971 (cond
17972 ((run-hook-with-args-until-success 'org-metaright-hook))
17973 ((org-at-table-p) (call-interactively 'org-table-move-column))
17974 ((org-with-limited-levels
17975 (or (org-at-heading-p)
17976 (and (org-region-active-p)
17977 (save-excursion
17978 (goto-char (region-beginning))
17979 (org-at-heading-p)))))
17980 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
17981 (call-interactively 'org-do-demote))
17982 ;; At an inline task.
17983 ((org-at-heading-p)
17984 (call-interactively 'org-inlinetask-demote))
17985 ((or (org-at-item-p)
17986 (and (org-region-active-p)
17987 (save-excursion
17988 (goto-char (region-beginning))
17989 (org-at-item-p))))
17990 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
17991 (call-interactively 'org-indent-item))
17992 (t (call-interactively 'forward-word))))
17994 (defun org-check-for-hidden (what)
17995 "Check if there are hidden headlines/items in the current visual line.
17996 WHAT can be either `headlines' or `items'. If the current line is
17997 an outline or item heading and it has a folded subtree below it,
17998 this function returns t, nil otherwise."
17999 (let ((re (cond
18000 ((eq what 'headlines) org-outline-regexp-bol)
18001 ((eq what 'items) (org-item-beginning-re))
18002 (t (error "This should not happen"))))
18003 beg end)
18004 (save-excursion
18005 (catch 'exit
18006 (unless (org-region-active-p)
18007 (setq beg (point-at-bol))
18008 (beginning-of-line 2)
18009 (while (and (not (eobp)) ;; this is like `next-line'
18010 (get-char-property (1- (point)) 'invisible))
18011 (beginning-of-line 2))
18012 (setq end (point))
18013 (goto-char beg)
18014 (goto-char (point-at-eol))
18015 (setq end (max end (point)))
18016 (while (re-search-forward re end t)
18017 (if (get-char-property (match-beginning 0) 'invisible)
18018 (throw 'exit t))))
18019 nil))))
18021 (defun org-metaup (&optional arg)
18022 "Move subtree up or move table row up.
18023 Calls `org-move-subtree-up' or `org-table-move-row' or
18024 `org-move-item-up', depending on context. See the individual commands
18025 for more information."
18026 (interactive "P")
18027 (cond
18028 ((run-hook-with-args-until-success 'org-metaup-hook))
18029 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
18030 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
18031 ((org-at-item-p) (call-interactively 'org-move-item-up))
18032 (t (transpose-lines 1) (beginning-of-line -1))))
18034 (defun org-metadown (&optional arg)
18035 "Move subtree down or move table row down.
18036 Calls `org-move-subtree-down' or `org-table-move-row' or
18037 `org-move-item-down', depending on context. See the individual
18038 commands for more information."
18039 (interactive "P")
18040 (cond
18041 ((run-hook-with-args-until-success 'org-metadown-hook))
18042 ((org-at-table-p) (call-interactively 'org-table-move-row))
18043 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
18044 ((org-at-item-p) (call-interactively 'org-move-item-down))
18045 (t (beginning-of-line 2) (transpose-lines 1) (beginning-of-line 0))))
18047 (defun org-shiftup (&optional arg)
18048 "Increase item in timestamp or increase priority of current headline.
18049 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
18050 depending on context. See the individual commands for more information."
18051 (interactive "P")
18052 (cond
18053 ((run-hook-with-args-until-success 'org-shiftup-hook))
18054 ((and org-support-shift-select (org-region-active-p))
18055 (org-call-for-shift-select 'previous-line))
18056 ((org-at-timestamp-p t)
18057 (call-interactively (if org-edit-timestamp-down-means-later
18058 'org-timestamp-down 'org-timestamp-up)))
18059 ((and (not (eq org-support-shift-select 'always))
18060 org-enable-priority-commands
18061 (org-at-heading-p))
18062 (call-interactively 'org-priority-up))
18063 ((and (not org-support-shift-select) (org-at-item-p))
18064 (call-interactively 'org-previous-item))
18065 ((org-clocktable-try-shift 'up arg))
18066 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
18067 (org-support-shift-select
18068 (org-call-for-shift-select 'previous-line))
18069 (t (org-shiftselect-error))))
18071 (defun org-shiftdown (&optional arg)
18072 "Decrease item in timestamp or decrease priority of current headline.
18073 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
18074 depending on context. See the individual commands for more information."
18075 (interactive "P")
18076 (cond
18077 ((run-hook-with-args-until-success 'org-shiftdown-hook))
18078 ((and org-support-shift-select (org-region-active-p))
18079 (org-call-for-shift-select 'next-line))
18080 ((org-at-timestamp-p t)
18081 (call-interactively (if org-edit-timestamp-down-means-later
18082 'org-timestamp-up 'org-timestamp-down)))
18083 ((and (not (eq org-support-shift-select 'always))
18084 org-enable-priority-commands
18085 (org-at-heading-p))
18086 (call-interactively 'org-priority-down))
18087 ((and (not org-support-shift-select) (org-at-item-p))
18088 (call-interactively 'org-next-item))
18089 ((org-clocktable-try-shift 'down arg))
18090 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
18091 (org-support-shift-select
18092 (org-call-for-shift-select 'next-line))
18093 (t (org-shiftselect-error))))
18095 (defun org-shiftright (&optional arg)
18096 "Cycle the thing at point or in the current line, depending on context.
18097 Depending on context, this does one of the following:
18099 - switch a timestamp at point one day into the future
18100 - on a headline, switch to the next TODO keyword.
18101 - on an item, switch entire list to the next bullet type
18102 - on a property line, switch to the next allowed value
18103 - on a clocktable definition line, move time block into the future"
18104 (interactive "P")
18105 (cond
18106 ((run-hook-with-args-until-success 'org-shiftright-hook))
18107 ((and org-support-shift-select (org-region-active-p))
18108 (org-call-for-shift-select 'forward-char))
18109 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
18110 ((and (not (eq org-support-shift-select 'always))
18111 (org-at-heading-p))
18112 (let ((org-inhibit-logging
18113 (not org-treat-S-cursor-todo-selection-as-state-change))
18114 (org-inhibit-blocking
18115 (not org-treat-S-cursor-todo-selection-as-state-change)))
18116 (org-call-with-arg 'org-todo 'right)))
18117 ((or (and org-support-shift-select
18118 (not (eq org-support-shift-select 'always))
18119 (org-at-item-bullet-p))
18120 (and (not org-support-shift-select) (org-at-item-p)))
18121 (org-call-with-arg 'org-cycle-list-bullet nil))
18122 ((and (not (eq org-support-shift-select 'always))
18123 (org-at-property-p))
18124 (call-interactively 'org-property-next-allowed-value))
18125 ((org-clocktable-try-shift 'right arg))
18126 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
18127 (org-support-shift-select
18128 (org-call-for-shift-select 'forward-char))
18129 (t (org-shiftselect-error))))
18131 (defun org-shiftleft (&optional arg)
18132 "Cycle the thing at point or in the current line, depending on context.
18133 Depending on context, this does one of the following:
18135 - switch a timestamp at point one day into the past
18136 - on a headline, switch to the previous TODO keyword.
18137 - on an item, switch entire list to the previous bullet type
18138 - on a property line, switch to the previous allowed value
18139 - on a clocktable definition line, move time block into the past"
18140 (interactive "P")
18141 (cond
18142 ((run-hook-with-args-until-success 'org-shiftleft-hook))
18143 ((and org-support-shift-select (org-region-active-p))
18144 (org-call-for-shift-select 'backward-char))
18145 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
18146 ((and (not (eq org-support-shift-select 'always))
18147 (org-at-heading-p))
18148 (let ((org-inhibit-logging
18149 (not org-treat-S-cursor-todo-selection-as-state-change))
18150 (org-inhibit-blocking
18151 (not org-treat-S-cursor-todo-selection-as-state-change)))
18152 (org-call-with-arg 'org-todo 'left)))
18153 ((or (and org-support-shift-select
18154 (not (eq org-support-shift-select 'always))
18155 (org-at-item-bullet-p))
18156 (and (not org-support-shift-select) (org-at-item-p)))
18157 (org-call-with-arg 'org-cycle-list-bullet 'previous))
18158 ((and (not (eq org-support-shift-select 'always))
18159 (org-at-property-p))
18160 (call-interactively 'org-property-previous-allowed-value))
18161 ((org-clocktable-try-shift 'left arg))
18162 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
18163 (org-support-shift-select
18164 (org-call-for-shift-select 'backward-char))
18165 (t (org-shiftselect-error))))
18167 (defun org-shiftcontrolright ()
18168 "Switch to next TODO set."
18169 (interactive)
18170 (cond
18171 ((and org-support-shift-select (org-region-active-p))
18172 (org-call-for-shift-select 'forward-word))
18173 ((and (not (eq org-support-shift-select 'always))
18174 (org-at-heading-p))
18175 (org-call-with-arg 'org-todo 'nextset))
18176 (org-support-shift-select
18177 (org-call-for-shift-select 'forward-word))
18178 (t (org-shiftselect-error))))
18180 (defun org-shiftcontrolleft ()
18181 "Switch to previous TODO set."
18182 (interactive)
18183 (cond
18184 ((and org-support-shift-select (org-region-active-p))
18185 (org-call-for-shift-select 'backward-word))
18186 ((and (not (eq org-support-shift-select 'always))
18187 (org-at-heading-p))
18188 (org-call-with-arg 'org-todo 'previousset))
18189 (org-support-shift-select
18190 (org-call-for-shift-select 'backward-word))
18191 (t (org-shiftselect-error))))
18193 (defun org-shiftcontrolup ()
18194 "Change timestamps synchronously up in CLOCK log lines."
18195 (interactive)
18196 (cond ((and (not org-support-shift-select)
18197 (org-at-clock-log-p)
18198 (org-at-timestamp-p t))
18199 (org-clock-timestamps-up))
18200 (t (org-shiftselect-error))))
18202 (defun org-shiftcontroldown ()
18203 "Change timestamps synchronously down in CLOCK log lines."
18204 (interactive)
18205 (cond ((and (not org-support-shift-select)
18206 (org-at-clock-log-p)
18207 (org-at-timestamp-p t))
18208 (org-clock-timestamps-down))
18209 (t (org-shiftselect-error))))
18211 (defun org-ctrl-c-ret ()
18212 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
18213 (interactive)
18214 (cond
18215 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
18216 (t (call-interactively 'org-insert-heading))))
18218 (defun org-find-visible ()
18219 (let ((s (point)))
18220 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18221 (get-char-property s 'invisible)))
18222 s))
18223 (defun org-find-invisible ()
18224 (let ((s (point)))
18225 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
18226 (not (get-char-property s 'invisible))))
18227 s))
18229 (defun org-copy-visible (beg end)
18230 "Copy the visible parts of the region."
18231 (interactive "r")
18232 (let (snippets s)
18233 (save-excursion
18234 (save-restriction
18235 (narrow-to-region beg end)
18236 (setq s (goto-char (point-min)))
18237 (while (not (= (point) (point-max)))
18238 (goto-char (org-find-invisible))
18239 (push (buffer-substring s (point)) snippets)
18240 (setq s (goto-char (org-find-visible))))))
18241 (kill-new (apply 'concat (nreverse snippets)))))
18243 (defun org-copy-special ()
18244 "Copy region in table or copy current subtree.
18245 Calls `org-table-copy' or `org-copy-subtree', depending on context.
18246 See the individual commands for more information."
18247 (interactive)
18248 (call-interactively
18249 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
18251 (defun org-cut-special ()
18252 "Cut region in table or cut current subtree.
18253 Calls `org-table-copy' or `org-cut-subtree', depending on context.
18254 See the individual commands for more information."
18255 (interactive)
18256 (call-interactively
18257 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
18259 (defun org-paste-special (arg)
18260 "Paste rectangular region into table, or past subtree relative to level.
18261 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
18262 See the individual commands for more information."
18263 (interactive "P")
18264 (if (org-at-table-p)
18265 (org-table-paste-rectangle)
18266 (org-paste-subtree arg)))
18268 (defun org-edit-special (&optional arg)
18269 "Call a special editor for the stuff at point.
18270 When at a table, call the formula editor with `org-table-edit-formulas'.
18271 When at the first line of an src example, call `org-edit-src-code'.
18272 When in an #+include line, visit the include file. Otherwise call
18273 `ffap' to visit the file at point."
18274 (interactive)
18275 ;; possibly prep session before editing source
18276 (when arg
18277 (let* ((info (org-babel-get-src-block-info))
18278 (lang (nth 0 info))
18279 (params (nth 2 info))
18280 (session (cdr (assoc :session params))))
18281 (when (and info session) ;; we are in a source-code block with a session
18282 (funcall
18283 (intern (concat "org-babel-prep-session:" lang)) session params))))
18284 (cond ;; proceed with `org-edit-special'
18285 ((save-excursion
18286 (beginning-of-line 1)
18287 (looking-at "\\(?:#\\+\\(?:setupfile\\|include\\):?[ \t]+\"?\\|[ \t]*<include\\>.*?file=\"\\)\\([^\"\n>]+\\)"))
18288 (find-file (org-trim (match-string 1))))
18289 ((org-edit-src-code))
18290 ((org-edit-fixed-width-region))
18291 ((org-at-table.el-p)
18292 (org-edit-src-code))
18293 ((or (org-at-table-p)
18294 (save-excursion
18295 (beginning-of-line 1)
18297 (call-interactively 'org-table-edit-formulas))
18298 (t (call-interactively 'ffap))))
18300 (defvar org-table-coordinate-overlays) ; defined in org-table.el
18301 (defun org-ctrl-c-ctrl-c (&optional arg)
18302 "Set tags in headline, or update according to changed information at point.
18304 This command does many different things, depending on context:
18306 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
18307 this is what we do.
18309 - If the cursor is on a statistics cookie, update it.
18311 - If the cursor is in a headline, prompt for tags and insert them
18312 into the current line, aligned to `org-tags-column'. When called
18313 with prefix arg, realign all tags in the current buffer.
18315 - If the cursor is in one of the special #+KEYWORD lines, this
18316 triggers scanning the buffer for these lines and updating the
18317 information.
18319 - If the cursor is inside a table, realign the table. This command
18320 works even if the automatic table editor has been turned off.
18322 - If the cursor is on a #+TBLFM line, re-apply the formulas to
18323 the entire table.
18325 - If the cursor is at a footnote reference or definition, jump to
18326 the corresponding definition or references, respectively.
18328 - If the cursor is a the beginning of a dynamic block, update it.
18330 - If the current buffer is a capture buffer, close note and file it.
18332 - If the cursor is on a <<<target>>>, update radio targets and
18333 corresponding links in this buffer.
18335 - If the cursor is on a numbered item in a plain list, renumber the
18336 ordered list.
18338 - If the cursor is on a checkbox, toggle it.
18340 - If the cursor is on a code block, evaluate it. The variable
18341 `org-confirm-babel-evaluate' can be used to control prompting
18342 before code block evaluation, by default every code block
18343 evaluation requires confirmation. Code block evaluation can be
18344 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
18345 (interactive "P")
18346 (let ((org-enable-table-editor t))
18347 (cond
18348 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
18349 org-occur-highlights
18350 org-latex-fragment-image-overlays)
18351 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
18352 (org-remove-occur-highlights)
18353 (org-remove-latex-fragment-image-overlays)
18354 (message "Temporary highlights/overlays removed from current buffer"))
18355 ((and (local-variable-p 'org-finish-function (current-buffer))
18356 (fboundp org-finish-function))
18357 (funcall org-finish-function))
18358 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
18359 ((org-in-regexp org-ts-regexp-both)
18360 (org-timestamp-change 0 'day))
18361 ((or (looking-at org-property-start-re)
18362 (org-at-property-p))
18363 (call-interactively 'org-property-action))
18364 ((org-at-target-p) (call-interactively 'org-update-radio-target-regexp))
18366 (or (org-at-heading-p) (org-at-item-p)))
18367 (call-interactively 'org-update-statistics-cookies))
18368 ((org-at-heading-p) (call-interactively 'org-set-tags))
18369 ((org-at-table.el-p)
18370 (message "Use C-c ' to edit table.el tables"))
18371 ((org-at-table-p)
18372 (org-table-maybe-eval-formula)
18373 (if arg
18374 (call-interactively 'org-table-recalculate)
18375 (org-table-maybe-recalculate-line))
18376 (call-interactively 'org-table-align)
18377 (orgtbl-send-table 'maybe))
18378 ((or (org-footnote-at-reference-p)
18379 (org-footnote-at-definition-p))
18380 (call-interactively 'org-footnote-action))
18381 ((org-at-item-checkbox-p)
18382 ;; Cursor at a checkbox: repair list and update checkboxes. Send
18383 ;; list only if at top item.
18384 (let* ((cbox (match-string 1))
18385 (struct (org-list-struct))
18386 (old-struct (copy-tree struct))
18387 (parents (org-list-parents-alist struct))
18388 (orderedp (org-entry-get nil "ORDERED"))
18389 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18390 block-item)
18391 ;; Use a light version of `org-toggle-checkbox' to avoid
18392 ;; computing list structure twice.
18393 (let ((new-box (cond
18394 ((equal arg '(16)) "[-]")
18395 ((equal arg '(4)) nil)
18396 ((equal "[X]" cbox) "[ ]")
18397 (t "[X]"))))
18398 (if (and firstp arg)
18399 ;; If at first item of sub-list, remove check-box from
18400 ;; every item at the same level.
18401 (mapc
18402 (lambda (pos) (org-list-set-checkbox pos struct new-box))
18403 (org-list-get-all-items
18404 (point-at-bol) struct (org-list-prevs-alist struct)))
18405 (org-list-set-checkbox (point-at-bol) struct new-box)))
18406 ;; Replicate `org-list-write-struct', while grabbing a return
18407 ;; value from `org-list-struct-fix-box'.
18408 (org-list-struct-fix-ind struct parents 2)
18409 (org-list-struct-fix-item-end struct)
18410 (let ((prevs (org-list-prevs-alist struct)))
18411 (org-list-struct-fix-bul struct prevs)
18412 (org-list-struct-fix-ind struct parents)
18413 (setq block-item
18414 (org-list-struct-fix-box struct parents prevs orderedp)))
18415 (org-list-struct-apply-struct struct old-struct)
18416 (org-update-checkbox-count-maybe)
18417 (when block-item
18418 (message
18419 "Checkboxes were removed due to unchecked box at line %d"
18420 (org-current-line block-item)))
18421 (when firstp (org-list-send-list 'maybe))))
18422 ((org-at-item-p)
18423 ;; Cursor at an item: repair list. Do checkbox related actions
18424 ;; only if function was called with an argument. Send list only
18425 ;; if at top item.
18426 (let* ((struct (org-list-struct))
18427 (firstp (= (org-list-get-top-point struct) (point-at-bol)))
18428 old-struct)
18429 (when arg
18430 (setq old-struct (copy-tree struct))
18431 (if firstp
18432 ;; If at first item of sub-list, add check-box to every
18433 ;; item at the same level.
18434 (mapc
18435 (lambda (pos)
18436 (unless (org-list-get-checkbox pos struct)
18437 (org-list-set-checkbox pos struct "[ ]")))
18438 (org-list-get-all-items
18439 (point-at-bol) struct (org-list-prevs-alist struct)))
18440 (org-list-set-checkbox (point-at-bol) struct "[ ]")))
18441 (org-list-write-struct
18442 struct (org-list-parents-alist struct) old-struct)
18443 (when arg (org-update-checkbox-count-maybe))
18444 (when firstp (org-list-send-list 'maybe))))
18445 ((save-excursion (beginning-of-line 1) (looking-at org-dblock-start-re))
18446 ;; Dynamic block
18447 (beginning-of-line 1)
18448 (save-excursion (org-update-dblock)))
18449 ((save-excursion
18450 (beginning-of-line 1)
18452 (cond
18453 ((equal (match-string 1) "TBLFM")
18454 ;; Recalculate the table before this line
18455 (save-excursion
18456 (beginning-of-line 1)
18458 (if (org-at-table-p)
18459 (org-call-with-arg 'org-table-recalculate (or arg t)))))
18460 (t
18461 (let ((org-inhibit-startup-visibility-stuff t)
18462 (org-startup-align-all-tables nil))
18463 (when (boundp 'org-table-coordinate-overlays)
18464 (mapc 'delete-overlay org-table-coordinate-overlays)
18465 (setq org-table-coordinate-overlays nil))
18466 (org-save-outline-visibility 'use-markers (org-mode-restart)))
18467 (message "Local setup has been refreshed"))))
18468 ((org-clock-update-time-maybe))
18469 (t
18470 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
18471 (error "C-c C-c can do nothing useful at this location"))))))
18473 (defun org-mode-restart ()
18474 "Restart Org-mode, to scan again for special lines.
18475 Also updates the keyword regular expressions."
18476 (interactive)
18477 (org-mode)
18478 (message "Org-mode restarted"))
18480 (defun org-kill-note-or-show-branches ()
18481 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
18482 (interactive)
18483 (if (not org-finish-function)
18484 (progn
18485 (hide-subtree)
18486 (call-interactively 'show-branches))
18487 (let ((org-note-abort t))
18488 (funcall org-finish-function))))
18490 (defun org-return (&optional indent)
18491 "Goto next table row or insert a newline.
18492 Calls `org-table-next-row' or `newline', depending on context.
18493 See the individual commands for more information."
18494 (interactive)
18495 (cond
18496 ((bobp) (if indent (newline-and-indent) (newline)))
18497 ((org-at-table-p)
18498 (org-table-justify-field-maybe)
18499 (call-interactively 'org-table-next-row))
18500 ;; when `newline-and-indent' is called within a list, make sure
18501 ;; text moved stays inside the item.
18502 ((and (org-in-item-p) indent)
18503 (if (and (org-at-item-p) (>= (point) (match-end 0)))
18504 (progn
18505 (save-match-data (newline))
18506 (org-indent-line-to (length (match-string 0))))
18507 (let ((ind (org-get-indentation)))
18508 (newline)
18509 (if (org-looking-back org-list-end-re)
18510 (org-indent-line-function)
18511 (org-indent-line-to ind)))))
18512 ((and org-return-follows-link
18513 (let ((tprop (get-text-property (point) 'face)))
18514 (or (eq tprop 'org-link)
18515 (and (listp tprop) (memq 'org-link tprop)))))
18516 (call-interactively 'org-open-at-point))
18517 ((and (org-at-heading-p)
18518 (looking-at
18520 (org-show-entry)
18521 (end-of-line 1)
18522 (newline))
18523 (t (if indent (newline-and-indent) (newline)))))
18525 (defun org-return-indent ()
18526 "Goto next table row or insert a newline and indent.
18527 Calls `org-table-next-row' or `newline-and-indent', depending on
18528 context. See the individual commands for more information."
18529 (interactive)
18530 (org-return t))
18532 (defun org-ctrl-c-star ()
18533 "Compute table, or change heading status of lines.
18534 Calls `org-table-recalculate' or `org-toggle-heading',
18535 depending on context."
18536 (interactive)
18537 (cond
18538 ((org-at-table-p)
18539 (call-interactively 'org-table-recalculate))
18540 (t
18541 ;; Convert all lines in region to list items
18542 (call-interactively 'org-toggle-heading))))
18544 (defun org-ctrl-c-minus ()
18545 "Insert separator line in table or modify bullet status of line.
18546 Also turns a plain line or a region of lines into list items.
18547 Calls `org-table-insert-hline', `org-toggle-item', or
18548 `org-cycle-list-bullet', depending on context."
18549 (interactive)
18550 (cond
18551 ((org-at-table-p)
18552 (call-interactively 'org-table-insert-hline))
18553 ((org-region-active-p)
18554 (call-interactively 'org-toggle-item))
18555 ((org-in-item-p)
18556 (call-interactively 'org-cycle-list-bullet))
18557 (t
18558 (call-interactively 'org-toggle-item))))
18560 (defun org-toggle-item (arg)
18561 "Convert headings or normal lines to items, items to normal lines.
18562 If there is no active region, only the current line is considered.
18564 If the first non blank line in the region is an headline, convert
18565 all headlines to items, shifting text accordingly.
18567 If it is an item, convert all items to normal lines.
18569 If it is normal text, change region into an item. With a prefix
18570 argument ARG, change each line in region into an item."
18571 (interactive "P")
18572 (let ((shift-text
18573 (function
18574 ;; Shift text in current section to IND, from point to END.
18575 ;; The function leaves point to END line.
18576 (lambda (ind end)
18577 (let ((min-i 1000) (end (copy-marker end)))
18578 ;; First determine the minimum indentation (MIN-I) of
18579 ;; the text.
18580 (save-excursion
18581 (catch 'exit
18582 (while (< (point) end)
18583 (let ((i (org-get-indentation)))
18584 (cond
18585 ;; Skip blank lines and inline tasks.
18587 ((looking-at org-outline-regexp-bol))
18588 ;; We can't find less than 0 indentation.
18589 ((zerop i) (throw 'exit (setq min-i 0)))
18590 ((< i min-i) (setq min-i i))))
18591 (forward-line))))
18592 ;; Then indent each line so that a line indented to
18593 ;; MIN-I becomes indented to IND. Ignore blank lines
18594 ;; and inline tasks in the process.
18595 (let ((delta (- ind min-i)))
18596 (while (< (point) end)
18598 (looking-at org-outline-regexp-bol))
18599 (org-indent-line-to (+ (org-get-indentation) delta)))
18600 (forward-line)))))))
18601 (skip-blanks
18602 (function
18603 ;; Return beginning of first non-blank line, starting from
18604 ;; line at POS.
18605 (lambda (pos)
18606 (save-excursion
18607 (goto-char pos)
18609 (point-at-bol)))))
18610 beg end)
18611 ;; Determine boundaries of changes.
18612 (if (org-region-active-p)
18613 (setq beg (funcall skip-blanks (region-beginning))
18614 end (copy-marker (region-end)))
18615 (setq beg (funcall skip-blanks (point-at-bol))
18616 end (copy-marker (point-at-eol))))
18617 ;; Depending on the starting line, choose an action on the text
18618 ;; between BEG and END.
18619 (org-with-limited-levels
18620 (save-excursion
18621 (goto-char beg)
18622 (cond
18623 ;; Case 1. Start at an item: de-itemize. Note that it only
18624 ;; happens when a region is active: `org-ctrl-c-minus'
18625 ;; would call `org-cycle-list-bullet' otherwise.
18626 ((org-at-item-p)
18627 (while (< (point) end)
18628 (when (org-at-item-p)
18630 (delete-region (point) (match-end 0)))
18631 (forward-line)))
18632 ;; Case 2. Start at an heading: convert to items.
18633 ((org-at-heading-p)
18634 (let* ((bul (org-list-bullet-string "-"))
18635 (bul-len (length bul))
18636 ;; Indentation of the first heading. It should be
18637 ;; relative to the indentation of its parent, if any.
18638 (start-ind (save-excursion
18639 (cond
18640 ((not org-adapt-indentation) 0)
18641 ((not (outline-previous-heading)) 0)
18642 (t (length (match-string 0))))))
18643 ;; Level of first heading. Further headings will be
18644 ;; compared to it to determine hierarchy in the list.
18645 (ref-level (org-reduced-level (org-outline-level))))
18646 (while (< (point) end)
18647 (let* ((level (org-reduced-level (org-outline-level)))
18648 (delta (max 0 (- level ref-level))))
18649 ;; If current headline is less indented than the first
18650 ;; one, set it as reference, in order to preserve
18651 ;; subtrees.
18652 (when (< level ref-level) (setq ref-level level))
18653 (replace-match bul t t)
18654 (org-indent-line-to (+ start-ind (* delta bul-len)))
18655 ;; Ensure all text down to END (or SECTION-END) belongs
18656 ;; to the newly created item.
18657 (let ((section-end (save-excursion
18658 (or (outline-next-heading) (point)))))
18659 (forward-line)
18660 (funcall shift-text
18661 (+ start-ind (* (1+ delta) bul-len))
18662 (min end section-end)))))))
18663 ;; Case 3. Normal line with ARG: turn each non-item line into
18664 ;; an item.
18665 (arg
18666 (while (< (point) end)
18667 (unless (or (org-at-heading-p) (org-at-item-p))
18669 (replace-match
18671 (forward-line)))
18672 ;; Case 4. Normal line without ARG: make the first line of
18673 ;; region an item, and shift indentation of others
18674 ;; lines to set them as item's body.
18675 (t (let* ((bul (org-list-bullet-string "-"))
18676 (bul-len (length bul))
18677 (ref-ind (org-get-indentation)))
18679 (insert bul)
18680 (forward-line)
18681 (while (< (point) end)
18682 ;; Ensure that lines less indented than first one
18683 ;; still get included in item body.
18684 (funcall shift-text
18685 (+ ref-ind bul-len)
18686 (min end (save-excursion (or (outline-next-heading)
18687 (point)))))
18688 (forward-line)))))))))
18690 (defun org-toggle-heading (&optional nstars)
18691 "Convert headings to normal text, or items or text to headings.
18692 If there is no active region, only the current line is considered.
18694 If the first non blank line is an headline, remove the stars from
18695 all headlines in the region.
18697 If it is a plain list item, turn all plain list items into headings.
18699 If it is a normal line, turn each and every normal line (i.e. not
18700 an heading or an item) in the region into a heading.
18702 When converting a line into a heading, the number of stars is chosen
18703 such that the lines become children of the current entry. However,
18704 when a prefix argument is given, its value determines the number of
18705 stars to add."
18706 (interactive "P")
18707 (let ((skip-blanks
18708 (function
18709 ;; Return beginning of first non-blank line, starting from
18710 ;; line at POS.
18711 (lambda (pos)
18712 (save-excursion
18713 (goto-char pos)
18715 (point-at-bol)))))
18716 beg end)
18717 ;; Determine boundaries of changes. If region ends at a bol, do
18718 ;; not consider the last line to be in the region.
18719 (if (org-region-active-p)
18720 (setq beg (funcall skip-blanks (region-beginning))
18721 end (copy-marker (save-excursion
18722 (goto-char (region-end))
18723 (if (bolp) (point) (point-at-eol)))))
18724 (setq beg (funcall skip-blanks (point-at-bol))
18725 end (copy-marker (point-at-eol))))
18726 ;; Ensure inline tasks don't count as headings.
18727 (org-with-limited-levels
18728 (save-excursion
18729 (goto-char beg)
18730 (cond
18731 ;; Case 1. Started at an heading: de-star headings.
18732 ((org-at-heading-p)
18733 (while (< (point) end)
18734 (when (org-at-heading-p t)
18735 (looking-at org-outline-regexp) (replace-match ""))
18736 (forward-line)))
18737 ;; Case 2. Started at an item: change items into headlines.
18738 ;; One star will be added by `org-list-to-subtree'.
18739 ((org-at-item-p)
18740 (let* ((stars (make-string
18741 (if nstars
18742 ;; subtract the star that will be added again by
18743 ;; `org-list-to-subtree'
18744 (1- (prefix-numeric-value current-prefix-arg))
18745 (or (org-current-level) 0))
18746 ?*))
18747 (add-stars
18748 (cond (nstars "") ; stars from prefix only
18749 ((equal stars "") "") ; before first heading
18750 (org-odd-levels-only "*") ; inside heading, odd
18751 (t "")))) ; inside heading, oddeven
18752 (while (< (point) end)
18753 (when (org-at-item-p)
18754 ;; Pay attention to cases when region ends before list.
18755 (let* ((struct (org-list-struct))
18756 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
18757 (save-restriction
18758 (narrow-to-region (point) list-end)
18759 (insert
18760 (org-list-to-subtree
18761 (org-list-parse-list t)
18762 '(:istart (concat stars add-stars (funcall get-stars depth))
18763 :icount (concat stars add-stars (funcall get-stars depth))))))))
18764 (forward-line))))
18765 ;; Case 3. Started at normal text: make every line an heading,
18766 ;; skipping headlines and items.
18767 (t (let* ((stars (make-string
18768 (if nstars
18769 (prefix-numeric-value current-prefix-arg)
18770 (or (org-current-level) 0))
18771 ?*))
18772 (add-stars
18773 (cond (nstars "") ; stars from prefix only
18774 ((equal stars "") "*") ; before first heading
18775 (org-odd-levels-only "**") ; inside heading, odd
18776 (t "*"))) ; inside heading, oddeven
18777 (rpl (concat stars add-stars " ")))
18778 (while (< (point) end)
18779 (when (and (not (org-at-heading-p)) (not (org-at-item-p))
18781 (replace-match (concat rpl (match-string 2))))
18782 (forward-line)))))))))
18784 (defun org-meta-return (&optional arg)
18785 "Insert a new heading or wrap a region in a table.
18786 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
18787 See the individual commands for more information."
18788 (interactive "P")
18789 (cond
18790 ((run-hook-with-args-until-success 'org-metareturn-hook))
18791 ((org-at-table-p)
18792 (call-interactively 'org-table-wrap-region))
18793 (t (call-interactively 'org-insert-heading))))
18795 ;;; Menu entries
18797 ;; Define the Org-mode menus
18798 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
18799 '("Tbl"
18800 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
18801 ["Next Field" org-cycle (org-at-table-p)]
18802 ["Previous Field" org-shifttab (org-at-table-p)]
18803 ["Next Row" org-return (org-at-table-p)]
18804 "--"
18805 ["Blank Field" org-table-blank-field (org-at-table-p)]
18806 ["Edit Field" org-table-edit-field (org-at-table-p)]
18807 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
18808 "--"
18809 ("Column"
18810 ["Move Column Left" org-metaleft (org-at-table-p)]
18811 ["Move Column Right" org-metaright (org-at-table-p)]
18812 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
18813 ["Insert Column" org-shiftmetaright (org-at-table-p)])
18814 ("Row"
18815 ["Move Row Up" org-metaup (org-at-table-p)]
18816 ["Move Row Down" org-metadown (org-at-table-p)]
18817 ["Delete Row" org-shiftmetaup (org-at-table-p)]
18818 ["Insert Row" org-shiftmetadown (org-at-table-p)]
18819 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
18820 "--"
18821 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
18822 ("Rectangle"
18823 ["Copy Rectangle" org-copy-special (org-at-table-p)]
18824 ["Cut Rectangle" org-cut-special (org-at-table-p)]
18825 ["Paste Rectangle" org-paste-special (org-at-table-p)]
18826 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
18827 "--"
18828 ("Calculate"
18829 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
18830 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
18831 ["Edit Formulas" org-edit-special (org-at-table-p)]
18832 "--"
18833 ["Recalculate line" org-table-recalculate (org-at-table-p)]
18834 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
18835 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
18836 "--"
18837 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
18838 "--"
18839 ["Sum Column/Rectangle" org-table-sum
18840 (or (org-at-table-p) (org-region-active-p))]
18841 ["Which Column?" org-table-current-column (org-at-table-p)])
18842 ["Debug Formulas"
18843 org-table-toggle-formula-debugger
18844 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
18845 ["Show Col/Row Numbers"
18846 org-table-toggle-coordinate-overlays
18847 :style toggle
18848 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
18849 "--"
18850 ["Create" org-table-create (and (not (org-at-table-p))
18851 org-enable-table-editor)]
18852 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
18853 ["Import from File" org-table-import (not (org-at-table-p))]
18854 ["Export to File" org-table-export (org-at-table-p)]
18855 "--"
18856 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
18858 (easy-menu-define org-org-menu org-mode-map "Org menu"
18859 '("Org"
18860 ("Show/Hide"
18861 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
18862 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
18863 ["Sparse Tree..." org-sparse-tree t]
18864 ["Reveal Context" org-reveal t]
18865 ["Show All" show-all t]
18866 "--"
18867 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
18868 "--"
18869 ["New Heading" org-insert-heading t]
18870 ("Navigate Headings"
18871 ["Up" outline-up-heading t]
18872 ["Next" outline-next-visible-heading t]
18873 ["Previous" outline-previous-visible-heading t]
18874 ["Next Same Level" outline-forward-same-level t]
18875 ["Previous Same Level" outline-backward-same-level t]
18876 "--"
18877 ["Jump" org-goto t])
18878 ("Edit Structure"
18879 ["Move Subtree Up" org-shiftmetaup (not (org-at-table-p))]
18880 ["Move Subtree Down" org-shiftmetadown (not (org-at-table-p))]
18881 "--"
18882 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
18883 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
18884 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
18885 "--"
18886 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
18887 "--"
18888 ["Copy visible text" org-copy-visible t]
18889 "--"
18890 ["Promote Heading" org-metaleft (not (org-at-table-p))]
18891 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
18892 ["Demote Heading" org-metaright (not (org-at-table-p))]
18893 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))]
18894 "--"
18895 ["Sort Region/Children" org-sort (not (org-at-table-p))]
18896 "--"
18897 ["Convert to odd levels" org-convert-to-odd-levels t]
18898 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
18899 ("Editing"
18900 ["Emphasis..." org-emphasize t]
18901 ["Edit Source Example" org-edit-special t]
18902 "--"
18903 ["Footnote new/jump" org-footnote-action t]
18904 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
18905 ("Archive"
18906 ["Archive (default method)" org-archive-subtree-default t]
18907 "--"
18908 ["Move Subtree to Archive file" org-advertized-archive-subtree t]
18909 ["Toggle ARCHIVE tag" org-toggle-archive-tag t]
18910 ["Move subtree to Archive sibling" org-archive-to-archive-sibling t]
18911 )
18912 "--"
18913 ("Hyperlinks"
18914 ["Store Link (Global)" org-store-link t]
18915 ["Find existing link to here" org-occur-link-in-agenda-files t]
18916 ["Insert Link" org-insert-link t]
18917 ["Follow Link" org-open-at-point t]
18918 "--"
18919 ["Next link" org-next-link t]
18920 ["Previous link" org-previous-link t]
18921 "--"
18922 ["Descriptive Links"
18923 org-toggle-link-display
18924 :style radio
18925 :selected org-descriptive-links
18926 ]
18927 ["Literal Links"
18928 org-toggle-link-display
18929 :style radio
18930 :selected (not org-descriptive-links)])
18931 "--"
18932 ("TODO Lists"
18933 ["TODO/DONE/-" org-todo t]
18934 ("Select keyword"
18935 ["Next keyword" org-shiftright (org-at-heading-p)]
18936 ["Previous keyword" org-shiftleft (org-at-heading-p)]
18937 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
18938 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
18939 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
18940 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
18941 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
18942 "--"
18943 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
18944 :selected org-enforce-todo-dependencies :style toggle :active t]
18945 "Settings for tree at point"
18946 ["Do Children sequentially" org-toggle-ordered-property :style radio
18947 :selected (org-entry-get nil "ORDERED")
18948 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18949 ["Do Children parallel" org-toggle-ordered-property :style radio
18950 :selected (not (org-entry-get nil "ORDERED"))
18951 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
18952 "--"
18953 ["Set Priority" org-priority t]
18954 ["Priority Up" org-shiftup t]
18955 ["Priority Down" org-shiftdown t]
18956 "--"
18957 ["Get news from all feeds" org-feed-update-all t]
18958 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
18959 ["Customize feeds" (customize-variable 'org-feed-alist) t])
18960 ("TAGS and Properties"
18961 ["Set Tags" org-set-tags-command t]
18962 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
18963 "--"
18964 ["Set property" org-set-property t]
18965 ["Column view of properties" org-columns t]
18966 ["Insert Column View DBlock" org-insert-columns-dblock t])
18967 ("Dates and Scheduling"
18968 ["Timestamp" org-time-stamp t]
18969 ["Timestamp (inactive)" org-time-stamp-inactive t]
18970 ("Change Date"
18971 ["1 Day Later" org-shiftright t]
18972 ["1 Day Earlier" org-shiftleft t]
18973 ["1 ... Later" org-shiftup t]
18974 ["1 ... Earlier" org-shiftdown t])
18975 ["Compute Time Range" org-evaluate-time-range t]
18976 ["Schedule Item" org-schedule t]
18977 ["Deadline" org-deadline t]
18978 "--"
18979 ["Custom time format" org-toggle-time-stamp-overlays
18980 :style radio :selected org-display-custom-times]
18981 "--"
18982 ["Goto Calendar" org-goto-calendar t]
18983 ["Date from Calendar" org-date-from-calendar t]
18984 "--"
18985 ["Start/Restart Timer" org-timer-start t]
18986 ["Pause/Continue Timer" org-timer-pause-or-continue t]
18987 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
18988 ["Insert Timer String" org-timer t]
18989 ["Insert Timer Item" org-timer-item t])
18990 ("Logging work"
18991 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
18992 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
18993 ["Clock out" org-clock-out t]
18994 ["Clock cancel" org-clock-cancel t]
18995 "--"
18996 ["Mark as default task" org-clock-mark-default-task t]
18997 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
18998 ["Goto running clock" org-clock-goto t]
18999 "--"
19000 ["Display times" org-clock-display t]
19001 ["Create clock table" org-clock-report t]
19002 "--"
19003 ["Record DONE time"
19004 (progn (setq org-log-done (not org-log-done))
19005 (message "Switching to %s will %s record a timestamp"
19006 (car org-done-keywords)
19007 (if org-log-done "automatically" "not")))
19008 :style toggle :selected org-log-done])
19009 "--"
19010 ["Agenda Command..." org-agenda t]
19011 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
19012 ("File List for Agenda")
19013 ("Special views current file"
19014 ["TODO Tree" org-show-todo-tree t]
19015 ["Check Deadlines" org-check-deadlines t]
19016 ["Timeline" org-timeline t]
19017 ["Tags/Property tree" org-match-sparse-tree t])
19018 "--"
19019 ["Export/Publish..." org-export t]
19020 ("LaTeX"
19021 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
19022 :selected org-cdlatex-mode]
19023 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
19024 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
19025 ["Modify math symbol" org-cdlatex-math-modify
19026 (org-inside-LaTeX-fragment-p)]
19027 ["Insert citation" org-reftex-citation t]
19028 "--"
19029 ["Template for BEAMER" org-insert-beamer-options-template t])
19030 "--"
19031 ("MobileOrg"
19032 ["Push Files and Views" org-mobile-push t]
19033 ["Get Captured and Flagged" org-mobile-pull t]
19034 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
19035 "--"
19036 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
19037 "--"
19038 ("Documentation"
19039 ["Show Version" org-version t]
19040 ["Info Documentation" org-info t])
19041 ("Customize"
19042 ["Browse Org Group" org-customize t]
19043 "--"
19044 ["Expand This Menu" org-create-customize-menu
19045 (fboundp 'customize-menu-create)])
19046 ["Send bug report" org-submit-bug-report t]
19047 "--"
19048 ("Refresh/Reload"
19049 ["Refresh setup current buffer" org-mode-restart t]
19050 ["Reload Org (after update)" org-reload t]
19051 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x r"])
19052 ))
19054 (defun org-info (&optional node)
19055 "Read documentation for Org-mode in the info system.
19056 With optional NODE, go directly to that node."
19057 (interactive)
19058 (info (format "(org)%s" (or node ""))))
19060 ;;;###autoload
19061 (defun org-submit-bug-report ()
19062 "Submit a bug report on Org-mode via mail.
19064 Don't hesitate to report any problems or inaccurate documentation.
19066 If you don't have setup sending mail from (X)Emacs, please copy the
19067 output buffer into your mail program, as it gives us important
19068 information about your Org-mode version and configuration."
19069 (interactive)
19070 (require 'reporter)
19071 (org-load-modules-maybe)
19072 (org-require-autoloaded-modules)
19073 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
19074 (reporter-submit-bug-report
19075 "emacs-orgmode@gnu.org"
19076 (org-version)
19077 (let (list)
19078 (save-window-excursion
19079 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
19080 (delete-other-windows)
19081 (erase-buffer)
19082 (insert "You are about to submit a bug report to the Org-mode mailing list.
19084 We would like to add your full Org-mode and Outline configuration to the
19085 bug report. This greatly simplifies the work of the maintainer and
19086 other experts on the mailing list.
19088 HOWEVER, some variables you have customized may contain private
19089 information. The names of customers, colleagues, or friends, might
19090 appear in the form of file names, tags, todo states, or search strings.
19091 If you answer yes to the prompt, you might want to check and remove
19092 such private information before sending the email.")
19093 (add-text-properties (point-min) (point-max) '(face org-warning))
19094 (when (yes-or-no-p "Include your Org-mode configuration ")
19095 (mapatoms
19096 (lambda (v)
19097 (and (boundp v)
19099 (or (and (symbol-value v)
19101 (and
19102 (get v 'custom-type) (get v 'standard-value)
19103 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
19104 (push v list)))))
19105 (kill-buffer (get-buffer "*Warn about privacy*"))
19106 list))
19107 nil nil
19108 "Remember to cover the basics, that is, what you expected to happen and
19109 what in fact did happen. You don't know how to make a good report? See
19111 http://orgmode.org/manual/Feedback.html#Feedback
19113 Your bug report will be posted to the Org-mode mailing list.
19114 ------------------------------------------------------------------------")
19115 (save-excursion
19120 (defun org-install-agenda-files-menu ()
19121 (let ((bl (buffer-list)))
19122 (save-excursion
19123 (while bl
19124 (set-buffer (pop bl))
19125 (if (eq major-mode 'org-mode) (setq bl nil)))
19126 (when (eq major-mode 'org-mode)
19127 (easy-menu-change
19128 '("Org") "File List for Agenda"
19129 (append
19130 (list
19131 ["Edit File List" (org-edit-agenda-file-list) t]
19132 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
19133 ["Remove Current File from List" org-remove-file t]
19134 ["Cycle through agenda files" org-cycle-agenda-files t]
19135 ["Occur in all agenda files" org-occur-in-agenda-files t]
19136 "--")
19137 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
19139 ;;;; Documentation
19141 ;;;###autoload
19142 (defun org-require-autoloaded-modules ()
19143 (interactive)
19144 (mapc 'require
19145 '(org-agenda org-archive org-ascii org-attach org-clock org-colview
19146 org-docbook org-exp org-html org-icalendar
19147 org-id org-latex
19148 org-publish org-remember org-table
19149 org-timer org-xoxo)))
19151 ;;;###autoload
19152 (defun org-reload (&optional uncompiled)
19153 "Reload all org lisp files.
19154 With prefix arg UNCOMPILED, load the uncompiled versions."
19155 (interactive "P")
19156 (require 'find-func)
19158 (dir-org (file-name-directory (org-find-library-name "org")))
19159 (dir-org-contrib (ignore-errors
19160 (file-name-directory
19161 (org-find-library-name "org-contribdir"))))
19162 (babel-files
19163 (mapcar (lambda (el) (concat "ob" (when el (format "-%s" el)) ".el"))
19164 (append (list nil "comint" "eval" "exp" "keys"
19165 "lob" "ref" "table" "tangle")
19166 (delq nil
19167 (mapcar
19168 (lambda (lang)
19169 (when (cdr lang) (symbol-name (car lang))))
19170 org-babel-load-languages)))))
19171 (files
19172 (append (directory-files dir-org t file-re)
19173 babel-files
19174 (and dir-org-contrib
19175 (directory-files dir-org-contrib t file-re))))
19176 (remove-re (concat (if (featurep 'xemacs)
19177 "org-colview" "org-colview-xemacs")
19179 (setq files (mapcar 'file-name-sans-extension files))
19180 (setq files (mapcar
19181 (lambda (x) (if (string-match remove-re x) nil x))
19182 files))
19183 (setq files (delq nil files))
19184 (mapc
19185 (lambda (f)
19186 (when (featurep (intern (file-name-nondirectory f)))
19187 (if (and (not uncompiled)
19188 (file-exists-p (concat f ".elc")))
19189 (load (concat f ".elc") nil nil t)
19190 (load (concat f ".el") nil nil t))))
19191 files))
19192 (org-version))
19194 ;;;###autoload
19195 (defun org-customize ()
19196 "Call the customize function with org as argument."
19197 (interactive)
19198 (org-load-modules-maybe)
19199 (org-require-autoloaded-modules)
19200 (customize-browse 'org))
19202 (defun org-create-customize-menu ()
19203 "Create a full customization menu for Org-mode, insert it into the menu."
19204 (interactive)
19205 (org-load-modules-maybe)
19206 (org-require-autoloaded-modules)
19207 (if (fboundp 'customize-menu-create)
19208 (progn
19209 (easy-menu-change
19210 '("Org") "Customize"
19211 `(["Browse Org group" org-customize t]
19212 "--"
19213 ,(customize-menu-create 'org)
19214 ["Set" Custom-set t]
19215 ["Save" Custom-save t]
19216 ["Reset to Current" Custom-reset-current t]
19217 ["Reset to Saved" Custom-reset-saved t]
19218 ["Reset to Standard Settings" Custom-reset-standard t]))
19220 (error "Cannot expand menu (outdated version of cus-edit.el)")))
19222 ;;;; Miscellaneous stuff
19224 ;;; Generally useful functions
19226 (defun org-get-at-bol (property)
19227 "Get text property PROPERTY at beginning of line."
19228 (get-text-property (point-at-bol) property))
19230 (defun org-find-text-property-in-string (prop s)
19231 "Return the first non-nil value of property PROP in string S."
19232 (or (get-text-property 0 prop s)
19233 (get-text-property (or (next-single-property-change 0 prop s) 0)
19234 prop s)))
19236 (defun org-display-warning (message) ;; Copied from Emacs-Muse
19237 "Display the given MESSAGE as a warning."
19238 (if (fboundp 'display-warning)
19239 (display-warning 'org message
19240 (if (featurep 'xemacs) 'warning :warning))
19241 (let ((buf (get-buffer-create "*Org warnings*")))
19242 (with-current-buffer buf
19243 (goto-char (point-max))
19244 (insert "Warning (Org): " message)
19245 (unless (bolp)
19246 (newline)))
19247 (display-buffer buf)
19248 (sit-for 0))))
19250 (defun org-eval (form)
19251 "Eval FORM and return result."
19252 (condition-case error
19253 (eval form)
19254 (error (format "%%![Error: %s]" error))))
19256 (defun org-in-commented-line ()
19257 "Is point in a line starting with `#'?"
19258 (equal (char-after (point-at-bol)) ?#))
19260 (defun org-in-indented-comment-line ()
19261 "Is point in a line starting with `#' after some white space?"
19262 (save-excursion
19263 (save-match-data
19264 (goto-char (point-at-bol))
19267 (defun org-in-verbatim-emphasis ()
19268 (save-match-data
19269 (and (org-in-regexp org-emph-re 2) (member (match-string 3) '("=" "~")))))
19271 (defun org-goto-marker-or-bmk (marker &optional bookmark)
19272 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
19273 (if (and marker (marker-buffer marker)
19274 (buffer-live-p (marker-buffer marker)))
19275 (progn
19276 (org-pop-to-buffer-same-window (marker-buffer marker))
19277 (if (or (> marker (point-max)) (< marker (point-min)))
19278 (widen))
19279 (goto-char marker)
19280 (org-show-context 'org-goto))
19281 (if bookmark
19282 (bookmark-jump bookmark)
19283 (error "Cannot find location"))))
19285 (defun org-quote-csv-field (s)
19286 "Quote field for inclusion in CSV material."
19289 s))
19291 (defun org-force-self-insert (N)
19292 "Needed to enforce self-insert under remapping."
19293 (interactive "p")
19294 (self-insert-command N))
19296 (defun org-string-width (s)
19297 "Compute width of string, ignoring invisible characters.
19298 This ignores character with invisibility property `org-link', and also
19299 characters with property `org-cwidth', because these will become invisible
19300 upon the next fontification round."
19301 (let (b l)
19302 (when (or (eq t buffer-invisibility-spec)
19303 (assq 'org-link buffer-invisibility-spec))
19304 (while (setq b (text-property-any 0 (length s)
19305 'invisible 'org-link s))
19306 (setq s (concat (substring s 0 b)
19307 (substring s (or (next-single-property-change
19308 b 'invisible s) (length s)))))))
19309 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
19310 (setq s (concat (substring s 0 b)
19311 (substring s (or (next-single-property-change
19312 b 'org-cwidth s) (length s))))))
19313 (setq l (string-width s) b -1)
19314 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
19315 (setq l (- l (get-text-property b 'org-dwidth-n s))))
19316 l))
19318 (defun org-shorten-string (s maxlength)
19319 "Shorten string S so tht it is no longer than MAXLENGTH characters.
19320 If the string is shorter or has length MAXLENGTH, just return the
19321 original string. If it is longer, the functions finds a space in the
19322 string, breaks this string off at that locations and adds three dots
19323 as ellipsis. Including the ellipsis, the string will not be longer
19324 than MAXLENGTH. If finding a good breaking point in the string does
19325 not work, the string is just chopped off in the middle of a word
19326 if necessary."
19327 (if (<= (length s) maxlength)
19328 s
19329 (let* ((n (max (- maxlength 4) 1))
19331 (if (string-match re s)
19332 (concat (match-string 1 s) "...")
19333 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
19335 (defun org-get-indentation (&optional line)
19336 "Get the indentation of the current line, interpreting tabs.
19337 When LINE is given, assume it represents a line and compute its indentation."
19338 (if line
19339 (if (string-match "^ *" (org-remove-tabs line))
19340 (match-end 0))
19341 (save-excursion
19342 (beginning-of-line 1)
19344 (current-column))))
19346 (defun org-get-string-indentation (s)
19347 "What indentation has S due to SPACE and TAB at the beginning of the string?"
19348 (let ((n -1) (i 0) (w tab-width) c)
19349 (catch 'exit
19350 (while (< (setq n (1+ n)) (length s))
19351 (setq c (aref s n))
19352 (cond ((= c ?\ ) (setq i (1+ i)))
19354 (t (throw 'exit t)))))
19355 i))
19357 (defun org-remove-tabs (s &optional width)
19358 "Replace tabulators in S with spaces.
19359 Assumes that s is a single line, starting in column 0."
19360 (setq width (or width tab-width))
19362 (setq s (replace-match
19363 (make-string
19364 (- (* width (/ (+ (match-beginning 0) width) width))
19365 (match-beginning 0)) ?\ )
19366 t t s)))
19367 s)
19369 (defun org-fix-indentation (line ind)
19370 "Fix indentation in LINE.
19371 IND is a cons cell with target and minimum indentation.
19372 If the current indentation in LINE is smaller than the minimum,
19373 leave it alone. If it is larger than ind, set it to the target."
19374 (let* ((l (org-remove-tabs line))
19375 (i (org-get-indentation l))
19376 (i1 (car ind)) (i2 (cdr ind)))
19377 (if (>= i i2) (setq l (substring line i2)))
19378 (if (> i1 0)
19379 (concat (make-string i1 ?\ ) l)
19380 l)))
19382 (defun org-remove-indentation (code &optional n)
19383 "Remove the maximum common indentation from the lines in CODE.
19384 N may optionally be the number of spaces to remove."
19385 (with-temp-buffer
19386 (insert code)
19387 (org-do-remove-indentation n)
19388 (buffer-string)))
19390 (defun org-do-remove-indentation (&optional n)
19391 "Remove the maximum common indentation from the buffer."
19392 (untabify (point-min) (point-max))
19393 (let ((min 10000) re)
19394 (if n
19395 (setq min n)
19396 (goto-char (point-min))
19398 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
19399 (unless (or (= min 0) (= min 10000))
19401 (goto-char (point-min))
19402 (while (re-search-forward re nil t)
19403 (replace-match "")
19404 (end-of-line 1))
19405 min)))
19407 (defun org-fill-template (template alist)
19408 "Find each %key of ALIST in TEMPLATE and replace it."
19409 (let ((case-fold-search nil)
19410 entry key value)
19411 (setq alist (sort (copy-sequence alist)
19412 (lambda (a b) (< (length (car a)) (length (car b))))))
19413 (while (setq entry (pop alist))
19414 (setq template
19415 (replace-regexp-in-string
19416 (concat "%" (regexp-quote (car entry)))
19417 (cdr entry) template t t)))
19418 template))
19420 (defun org-base-buffer (buffer)
19421 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
19422 (if (not buffer)
19423 buffer
19424 (or (buffer-base-buffer buffer)
19425 buffer)))
19427 (defun org-trim (s)
19428 "Remove whitespace at beginning and end of string."
19431 s)
19433 (defun org-wrap (string &optional width lines)
19434 "Wrap string to either a number of lines, or a width in characters.
19435 If WIDTH is non-nil, the string is wrapped to that width, however many lines
19436 that costs. If there is a word longer than WIDTH, the text is actually
19437 wrapped to the length of that word.
19438 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
19439 many lines, whatever width that takes.
19440 The return value is a list of lines, without newlines at the end."
19442 (maxword (apply 'max (mapcar 'org-string-width words)))
19443 w ll)
19444 (cond (width
19445 (org-do-wrap words (max maxword width)))
19446 (lines
19447 (setq w maxword)
19448 (setq ll (org-do-wrap words maxword))
19449 (if (<= (length ll) lines)
19450 ll
19451 (setq ll words)
19452 (while (> (length ll) lines)
19453 (setq w (1+ w))
19454 (setq ll (org-do-wrap words w)))
19455 ll))
19456 (t (error "Cannot wrap this")))))
19458 (defun org-do-wrap (words width)
19459 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
19460 (let (lines line)
19461 (while words
19462 (setq line (pop words))
19463 (while (and words (< (+ (length line) (length (car words))) width))
19464 (setq line (concat line " " (pop words))))
19465 (setq lines (push line lines)))
19466 (nreverse lines)))
19468 (defun org-split-string (string &optional separators)
19469 "Splits STRING into substrings at SEPARATORS.
19470 No empty strings are returned if there are matches at the beginning
19471 and end of string."
19473 (start 0)
19474 notfirst
19475 (list nil))
19476 (while (and (string-match rexp string
19477 (if (and notfirst
19478 (= start (match-beginning 0))
19479 (< start (length string)))
19480 (1+ start) start))
19481 (< (match-beginning 0) (length string)))
19482 (setq notfirst t)
19483 (or (eq (match-beginning 0) 0)
19484 (and (eq (match-beginning 0) (match-end 0))
19485 (eq (match-beginning 0) start))
19486 (setq list
19487 (cons (substring string start (match-beginning 0))
19488 list)))
19489 (setq start (match-end 0)))
19490 (or (eq start (length string))
19491 (setq list
19492 (cons (substring string start)
19493 list)))
19494 (nreverse list)))
19496 (defun org-quote-vert (s)
19498 (while (string-match "|" s)
19500 s)
19502 (defun org-uuidgen-p (s)
19503 "Is S an ID created by UUIDGEN?"
19504 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
19506 (defun org-context ()
19507 "Return a list of contexts of the current cursor position.
19508 If several contexts apply, all are returned.
19509 Each context entry is a list with a symbol naming the context, and
19510 two positions indicating start and end of the context. Possible
19511 contexts are:
19513 :headline anywhere in a headline
19514 :headline-stars on the leading stars in a headline
19515 :todo-keyword on a TODO keyword (including DONE) in a headline
19516 :tags on the TAGS in a headline
19517 :priority on the priority cookie in a headline
19518 :item on the first line of a plain list item
19519 :item-bullet on the bullet/number of a plain list item
19520 :checkbox on the checkbox in a plain list item
19521 :table in an org-mode table
19522 :table-special on a special filed in a table
19523 :table-table in a table.el table
19524 :link on a hyperlink
19525 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE,COMMENT, QUOTE.
19526 :target on a <<target>>
19527 :radio-target on a <<<radio-target>>>
19528 :latex-fragment on a LaTeX fragment
19529 :latex-preview on a LaTeX fragment with overlaid preview image
19531 This function expects the position to be visible because it uses font-lock
19532 faces as a help to recognize the following contexts: :table-special, :link,
19533 and :keyword."
19534 (let* ((f (get-text-property (point) 'face))
19535 (faces (if (listp f) f (list f)))
19536 (p (point)) clist o)
19537 ;; First the large context
19538 (cond
19539 ((org-at-heading-p t)
19540 (push (list :headline (point-at-bol) (point-at-eol)) clist)
19541 (when (progn
19542 (beginning-of-line 1)
19543 (looking-at org-todo-line-tags-regexp))
19544 (push (org-point-in-group p 1 :headline-stars) clist)
19545 (push (org-point-in-group p 2 :todo-keyword) clist)
19546 (push (org-point-in-group p 4 :tags) clist))
19547 (goto-char p)
19550 (push (org-point-in-group p 0 :priority) clist)))
19552 ((org-at-item-p)
19553 (push (org-point-in-group p 2 :item-bullet) clist)
19554 (push (list :item (point-at-bol)
19555 (save-excursion (org-end-of-item) (point)))
19556 clist)
19557 (and (org-at-item-checkbox-p)
19558 (push (org-point-in-group p 0 :checkbox) clist)))
19560 ((org-at-table-p)
19561 (push (list :table (org-table-begin) (org-table-end)) clist)
19562 (if (memq 'org-formula faces)
19563 (push (list :table-special
19564 (previous-single-property-change p 'face)
19565 (next-single-property-change p 'face)) clist)))
19566 ((org-at-table-p 'any)
19567 (push (list :table-table) clist)))
19568 (goto-char p)
19570 ;; Now the small context
19571 (cond
19572 ((org-at-timestamp-p)
19573 (push (org-point-in-group p 0 :timestamp) clist))
19574 ((memq 'org-link faces)
19575 (push (list :link
19576 (previous-single-property-change p 'face)
19577 (next-single-property-change p 'face)) clist))
19578 ((memq 'org-special-keyword faces)
19579 (push (list :keyword
19580 (previous-single-property-change p 'face)
19581 (next-single-property-change p 'face)) clist))
19582 ((org-at-target-p)
19583 (push (org-point-in-group p 0 :target) clist)
19584 (goto-char (1- (match-beginning 0)))
19585 (if (looking-at org-radio-target-regexp)
19586 (push (org-point-in-group p 0 :radio-target) clist))
19587 (goto-char p))
19588 ((setq o (car (delq nil
19589 (mapcar
19590 (lambda (x)
19591 (if (memq x org-latex-fragment-image-overlays) x))
19592 (overlays-at (point))))))
19593 (push (list :latex-fragment
19594 (overlay-start o) (overlay-end o)) clist)
19595 (push (list :latex-preview
19596 (overlay-start o) (overlay-end o)) clist))
19597 ((org-inside-LaTeX-fragment-p)
19598 ;; FIXME: positions wrong.
19599 (push (list :latex-fragment (point) (point)) clist)))
19601 (setq clist (nreverse (delq nil clist)))
19602 clist))
19604 ;; FIXME: Compare with at-regexp-p Do we need both?
19605 (defun org-in-regexp (re &optional nlines visually)
19606 "Check if point is inside a match of regexp.
19607 Normally only the current line is checked, but you can include NLINES extra
19608 lines both before and after point into the search.
19609 If VISUALLY is set, require that the cursor is not after the match but
19610 really on, so that the block visually is on the match."
19611 (catch 'exit
19612 (let ((pos (point))
19613 (eol (point-at-eol (+ 1 (or nlines 0))))
19614 (inc (if visually 1 0)))
19615 (save-excursion
19616 (beginning-of-line (- 1 (or nlines 0)))
19617 (while (re-search-forward re eol t)
19618 (if (and (<= (match-beginning 0) pos)
19619 (>= (+ inc (match-end 0)) pos))
19620 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
19622 (defun org-at-regexp-p (regexp)
19623 "Is point inside a match of REGEXP in the current line?"
19624 (catch 'exit
19625 (save-excursion
19626 (let ((pos (point)) (end (point-at-eol)))
19627 (beginning-of-line 1)
19628 (while (re-search-forward regexp end t)
19629 (if (and (<= (match-beginning 0) pos)
19630 (>= (match-end 0) pos))
19631 (throw 'exit t)))
19632 nil))))
19634 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
19635 "Non-nil when point is between matches of START-RE and END-RE.
19637 Also return a non-nil value when point is on one of the matches.
19639 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
19640 buffer positions. Default values are the positions of headlines
19641 surrounding the point.
19643 The functions returns a cons cell whose car (resp. cdr) is the
19644 position before START-RE (resp. after END-RE)."
19645 (save-match-data
19646 (let ((pos (point))
19647 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
19648 (limit-down (or lim-down (save-excursion (outline-next-heading))))
19649 beg end)
19650 (save-excursion
19651 ;; Point is on a block when on START-RE or if START-RE can be
19652 ;; found before it...
19653 (and (or (org-at-regexp-p start-re)
19654 (re-search-backward start-re limit-up t))
19655 (setq beg (match-beginning 0))
19656 ;; ... and END-RE after it...
19657 (goto-char (match-end 0))
19658 (re-search-forward end-re limit-down t)
19659 (> (setq end (match-end 0)) pos)
19660 ;; ... without another START-RE in-between.
19661 (goto-char (match-beginning 0))
19662 (not (re-search-backward start-re (1+ beg) t))
19663 ;; Return value.
19664 (cons beg end))))))
19666 (defun org-in-block-p (names)
19667 "Non-nil when point belongs to a block whose name belongs to NAMES.
19669 NAMES is a list of strings containing names of blocks.
19671 Return first block name matched, or nil. Beware that in case of
19672 nested blocks, the returned name may not belong to the closest
19673 block from point."
19674 (save-match-data
19675 (catch 'exit
19676 (let ((case-fold-search t)
19677 (lim-up (save-excursion (outline-previous-heading)))
19678 (lim-down (save-excursion (outline-next-heading))))
19679 (mapc (lambda (name)
19680 (let ((n (regexp-quote name)))
19681 (when (org-between-regexps-p
19684 lim-up lim-down)
19685 (throw 'exit n))))
19686 names))
19687 nil)))
19689 (defun org-occur-in-agenda-files (regexp &optional nlines)
19690 "Call `multi-occur' with buffers for all agenda files."
19692 (let* ((files (org-agenda-files))
19693 (tnames (mapcar 'file-truename files))
19694 (extra org-agenda-text-search-extra-files)
19695 f)
19696 (when (eq (car extra) 'agenda-archives)
19697 (setq extra (cdr extra))
19698 (setq files (org-add-archive-files files)))
19699 (while (setq f (pop extra))
19700 (unless (member (file-truename f) tnames)
19701 (add-to-list 'files f 'append)
19702 (add-to-list 'tnames (file-truename f) 'append)))
19703 (multi-occur
19704 (mapcar (lambda (x)
19705 (with-current-buffer
19706 (or (get-file-buffer x) (find-file-noselect x))
19707 (widen)
19708 (current-buffer)))
19709 files)
19710 regexp)))
19712 (if (boundp 'occur-mode-find-occurrence-hook)
19713 ;; Emacs 23
19714 (add-hook 'occur-mode-find-occurrence-hook
19715 (lambda ()
19716 (when (eq major-mode 'org-mode)
19717 (org-reveal))))
19718 ;; Emacs 22
19719 (defadvice occur-mode-goto-occurrence
19720 (after org-occur-reveal activate)
19721 (and (eq major-mode 'org-mode) (org-reveal)))
19722 (defadvice occur-mode-goto-occurrence-other-window
19723 (after org-occur-reveal activate)
19724 (and (eq major-mode 'org-mode) (org-reveal)))
19725 (defadvice occur-mode-display-occurrence
19726 (after org-occur-reveal activate)
19727 (when (eq major-mode 'org-mode)
19728 (let ((pos (occur-mode-find-occurrence)))
19729 (with-current-buffer (marker-buffer pos)
19730 (save-excursion
19731 (goto-char pos)
19732 (org-reveal)))))))
19734 (defun org-occur-link-in-agenda-files ()
19735 "Create a link and search for it in the agendas.
19736 The link is not stored in `org-stored-links', it is just created
19737 for the search purpose."
19738 (interactive)
19739 (let ((link (condition-case nil
19740 (org-store-link nil)
19741 (error "Unable to create a link to here"))))
19742 (org-occur-in-agenda-files (regexp-quote link))))
19744 (defun org-uniquify (list)
19745 "Remove duplicate elements from LIST."
19746 (let (res)
19747 (mapc (lambda (x) (add-to-list 'res x 'append)) list)
19748 res))
19750 (defun org-delete-all (elts list)
19751 "Remove all elements in ELTS from LIST."
19752 (while elts
19753 (setq list (delete (pop elts) list)))
19754 list)
19756 (defun org-count (cl-item cl-seq)
19757 "Count the number of occurrences of ITEM in SEQ.
19758 Taken from `count' in cl-seq.el with all keyword arguments removed."
19759 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
19760 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
19761 (while (< cl-start cl-end)
19762 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
19763 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
19764 (setq cl-start (1+ cl-start)))
19765 cl-count))
19767 (defun org-remove-if (predicate seq)
19768 "Remove everything from SEQ that fulfills PREDICATE."
19769 (let (res e)
19770 (while seq
19771 (setq e (pop seq))
19772 (if (not (funcall predicate e)) (push e res)))
19773 (nreverse res)))
19775 (defun org-remove-if-not (predicate seq)
19776 "Remove everything from SEQ that does not fulfill PREDICATE."
19777 (let (res e)
19778 (while seq
19779 (setq e (pop seq))
19780 (if (funcall predicate e) (push e res)))
19781 (nreverse res)))
19783 (defun org-reduce (cl-func cl-seq &rest cl-keys)
19784 "Reduce two-argument FUNCTION across SEQ.
19785 Taken from `reduce' in cl-seq.el with all keyword arguments but
19787 (let ((cl-accum (cond ((memq :initial-value cl-keys)
19788 (cadr (memq :initial-value cl-keys)))
19789 (cl-seq (pop cl-seq))
19790 (t (funcall cl-func)))))
19791 (while cl-seq
19792 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
19793 cl-accum))
19795 (defun org-back-over-empty-lines ()
19796 "Move backwards over whitespace, to the beginning of the first empty line.
19797 Returns the number of empty lines passed."
19798 (let ((pos (point)))
19799 (if (cdr (assoc 'heading org-blank-before-new-entry))
19801 (unless (eobp)
19802 (forward-line -1)))
19803 (beginning-of-line 2)
19804 (goto-char (min (point) pos))
19805 (count-lines (point) pos)))
19807 (defun org-skip-whitespace ()
19810 (defun org-point-in-group (point group &optional context)
19811 "Check if POINT is in match-group GROUP.
19812 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
19813 match. If the match group does not exist or point is not inside it,
19814 return nil."
19815 (and (match-beginning group)
19816 (>= point (match-beginning group))
19817 (<= point (match-end group))
19818 (if context
19819 (list context (match-beginning group) (match-end group))
19820 t)))
19822 (defun org-switch-to-buffer-other-window (&rest args)
19823 "Switch to buffer in a second window on the current frame.
19824 In particular, do not allow pop-up frames.
19825 Returns the newly created buffer."
19826 (let (pop-up-frames special-display-buffer-names special-display-regexps
19827 special-display-function)
19828 (apply 'switch-to-buffer-other-window args)))
19830 (defun org-combine-plists (&rest plists)
19831 "Create a single property list from all plists in PLISTS.
19832 The process starts by copying the first list, and then setting properties
19833 from the other lists. Settings in the last list are the most significant
19834 ones and overrule settings in the other lists."
19835 (let ((rtn (copy-sequence (pop plists)))
19836 p v ls)
19837 (while plists
19838 (setq ls (pop plists))
19839 (while ls
19840 (setq p (pop ls) v (pop ls))
19841 (setq rtn (plist-put rtn p v))))
19842 rtn))
19844 (defun org-move-line-down (arg)
19845 "Move the current line down. With prefix argument, move it past ARG lines."
19846 (interactive "p")
19847 (let ((col (current-column))
19848 beg end pos)
19849 (beginning-of-line 1) (setq beg (point))
19850 (beginning-of-line 2) (setq end (point))
19851 (beginning-of-line (+ 1 arg))
19852 (setq pos (move-marker (make-marker) (point)))
19853 (insert (delete-and-extract-region beg end))
19854 (goto-char pos)
19855 (org-move-to-column col)))
19857 (defun org-move-line-up (arg)
19858 "Move the current line up. With prefix argument, move it past ARG lines."
19859 (interactive "p")
19860 (let ((col (current-column))
19861 beg end pos)
19862 (beginning-of-line 1) (setq beg (point))
19863 (beginning-of-line 2) (setq end (point))
19864 (beginning-of-line (- arg))
19865 (setq pos (move-marker (make-marker) (point)))
19866 (insert (delete-and-extract-region beg end))
19867 (goto-char pos)
19868 (org-move-to-column col)))
19870 (defun org-replace-escapes (string table)
19871 "Replace %-escapes in STRING with values in TABLE.
19873 The sequences in STRING may contain normal field width and padding information,
19875 so values can contain further %-escapes if they are define later in TABLE."
19876 (let ((tbl (copy-alist table))
19877 (case-fold-search nil)
19878 (pchg 0)
19879 e re rpl)
19880 (while (setq e (pop tbl))
19881 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
19882 (when (and (cdr e) (string-match re (cdr e)))
19883 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
19884 (safe "SREF"))
19885 (add-text-properties 0 3 (list 'sref sref) safe)
19886 (setcdr e (replace-match safe t t (cdr e)))))
19887 (while (string-match re string)
19888 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
19889 (cdr e)))
19890 (setq string (replace-match rpl t t string))))
19891 (while (setq pchg (next-property-change pchg string))
19892 (let ((sref (get-text-property pchg 'sref string)))
19893 (when (and sref (string-match "SREF" string pchg))
19894 (setq string (replace-match sref t t string)))))
19895 string))
19897 (defun org-sublist (list start end)
19898 "Return a section of LIST, from START to END.
19899 Counting starts at 1."
19900 (let (rtn (c start))
19901 (setq list (nthcdr (1- start) list))
19902 (while (and list (<= c end))
19903 (push (pop list) rtn)
19904 (setq c (1+ c)))
19905 (nreverse rtn)))
19907 (defun org-find-base-buffer-visiting (file)
19908 "Like `find-buffer-visiting' but always return the base buffer and
19909 not an indirect buffer."
19910 (let ((buf (or (get-file-buffer file)
19911 (find-buffer-visiting file))))
19912 (if buf
19913 (or (buffer-base-buffer buf) buf)
19914 nil)))
19916 (defun org-image-file-name-regexp (&optional extensions)
19917 "Return regexp matching the file names of images.
19918 If EXTENSIONS is given, only match these."
19919 (if (and (not extensions) (fboundp 'image-file-name-regexp))
19920 (image-file-name-regexp)
19921 (let ((image-file-name-extensions
19922 (or extensions
19923 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
19924 "xbm" "xpm" "pbm" "pgm" "ppm"))))
19926 (regexp-opt (nconc (mapcar 'upcase
19927 image-file-name-extensions)
19928 image-file-name-extensions)
19929 t)
19932 (defun org-file-image-p (file &optional extensions)
19933 "Return non-nil if FILE is an image."
19934 (save-match-data
19935 (string-match (org-image-file-name-regexp extensions) file)))
19937 (defun org-get-cursor-date ()
19938 "Return the date at cursor in as a time.
19939 This works in the calendar and in the agenda, anywhere else it just
19940 returns the current time."
19941 (let (date day defd)
19942 (cond
19943 ((eq major-mode 'calendar-mode)
19944 (setq date (calendar-cursor-to-date)
19945 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
19946 ((eq major-mode 'org-agenda-mode)
19947 (setq day (get-text-property (point) 'day))
19948 (if day
19949 (setq date (calendar-gregorian-from-absolute day)
19950 defd (encode-time 0 0 0 (nth 1 date) (nth 0 date)
19951 (nth 2 date))))))
19952 (or defd (current-time))))
19954 (defvar org-agenda-action-marker (make-marker)
19955 "Marker pointing to the entry for the next agenda action.")
19957 (defun org-mark-entry-for-agenda-action ()
19958 "Mark the current entry as target of an agenda action.
19959 Agenda actions are actions executed from the agenda with the key `k',
19960 which make use of the date at the cursor."
19961 (interactive)
19962 (move-marker org-agenda-action-marker
19963 (save-excursion (org-back-to-heading t) (point))
19964 (current-buffer))
19965 (message
19966 "Entry marked for action; press `k' at desired date in agenda or calendar"))
19968 (defun org-mark-subtree ()
19969 "Mark the current subtree.
19970 This puts point at the start of the current subtree, and mark at the end.
19972 If point is in an inline task, mark that task instead."
19973 (interactive)
19974 (let ((inline-task-p
19975 (and (featurep 'org-inlinetask)
19976 (org-inlinetask-in-task-p)))
19977 (beg))
19978 ;; Get beginning of subtree
19979 (cond
19980 (inline-task-p (org-inlinetask-goto-beginning))
19981 ((org-at-heading-p) (beginning-of-line))
19982 (t (org-with-limited-levels (outline-previous-visible-heading 1))))
19983 (setq beg (point))
19984 ;; Get end of it
19985 (if inline-task-p
19986 (org-inlinetask-goto-end)
19987 (org-end-of-subtree))
19988 ;; Mark zone
19989 (push-mark (point) nil t)
19990 (goto-char beg)))
19992 ;;; Paragraph filling stuff.
19993 ;; We want this to be just right, so use the full arsenal.
19995 (defun org-indent-line-function ()
19996 "Indent line depending on context."
19997 (interactive)
19998 (let* ((pos (point))
19999 (itemp (org-at-item-p))
20000 (case-fold-search t)
20002 (inline-task-p (and (featurep 'org-inlinetask)
20003 (org-inlinetask-in-task-p)))
20004 (inline-re (and inline-task-p
20005 (org-inlinetask-outline-regexp)))
20006 column)
20007 (beginning-of-line 1)
20008 (cond
20009 ;; Comments
20010 ((looking-at "# ") (setq column 0))
20011 ;; Headings
20012 ((looking-at org-outline-regexp) (setq column 0))
20013 ;; Included files
20015 ;; Footnote definition
20016 ((looking-at org-footnote-definition-re) (setq column 0))
20017 ;; Literal examples
20019 (setq column (org-get-indentation))) ; do nothing
20020 ;; Lists
20021 ((ignore-errors (goto-char (org-in-item-p)))
20022 (setq column (if itemp
20023 (org-get-indentation)
20024 (org-list-item-body-column (point))))
20025 (goto-char pos))
20026 ;; Drawers
20028 (save-excursion (re-search-backward org-drawer-regexp nil t)))
20029 (save-excursion
20030 (goto-char (1- (match-beginning 1)))
20031 (setq column (current-column))))
20032 ;; Special blocks
20034 (save-excursion
20035 (re-search-backward
20037 (setq column (org-get-indentation (match-string 0))))
20040 (save-excursion
20042 (setq column
20043 (cond ((equal (downcase (match-string 1)) "src")
20044 ;; src blocks: let `org-edit-src-exit' handle them
20045 (org-get-indentation))
20046 ((equal (downcase (match-string 1)) "example")
20047 (max (org-get-indentation)
20048 (org-get-indentation (match-string 0))))
20049 (t
20050 (org-get-indentation (match-string 0))))))
20051 ;; This line has nothing special, look at the previous relevant
20052 ;; line to compute indentation
20053 (t
20054 (beginning-of-line 0)
20055 (while (and (not (bobp))
20056 (not (looking-at org-drawer-regexp))
20057 ;; When point started in an inline task, do not move
20058 ;; above task starting line.
20059 (not (and inline-task-p (looking-at inline-re)))
20060 ;; Skip drawers, blocks, empty lines, verbatim,
20061 ;; comments, tables, footnotes definitions, lists,
20062 ;; inline tasks.
20064 (re-search-backward org-drawer-regexp nil t))
20068 (looking-at org-footnote-definition-re)
20069 (and (ignore-errors (goto-char (org-in-item-p)))
20070 (goto-char
20071 (org-list-get-top-point (org-list-struct))))
20072 (and (not inline-task-p)
20073 (featurep 'org-inlinetask)
20074 (org-inlinetask-in-task-p)
20075 (or (org-inlinetask-goto-beginning) t))))
20076 (beginning-of-line 0))
20077 (cond
20078 ;; There was an heading above.
20080 (if (not org-adapt-indentation)
20081 (setq column 0)
20082 (goto-char (match-end 0))
20083 (setq column (current-column))))
20084 ;; A drawer had started and is unfinished
20085 ((looking-at org-drawer-regexp)
20086 (goto-char (1- (match-beginning 1)))
20087 (setq column (current-column)))
20088 ;; Else, nothing noticeable found: get indentation and go on.
20089 (t (setq column (org-get-indentation))))))
20090 ;; Now apply indentation and move cursor accordingly
20091 (goto-char pos)
20092 (if (<= (current-column) (current-indentation))
20093 (org-indent-line-to column)
20094 (save-excursion (org-indent-line-to column)))
20095 ;; Special polishing for properties, see `org-property-format'
20096 (setq column (current-column))
20097 (beginning-of-line 1)
20098 (if (looking-at
20100 (replace-match (concat (match-string 1)
20101 (format org-property-format
20102 (match-string 2) (match-string 3)))
20103 t t))
20104 (org-move-to-column column)))
20106 (defvar org-adaptive-fill-regexp-backup adaptive-fill-regexp
20107 "Variable to store copy of `adaptive-fill-regexp'.
20108 Since `adaptive-fill-regexp' is set to never match, we need to
20109 store a backup of its value before entering `org-mode' so that
20110 the functionality can be provided as a fall-back.")
20112 (defun org-set-autofill-regexps ()
20113 (interactive)
20114 ;; In the paragraph separator we include headlines, because filling
20115 ;; text in a line directly attached to a headline would otherwise
20116 ;; fill the headline as well.
20119 ;; The paragraph starter includes hand-formatted lists.
20120 (org-set-local
20121 'paragraph-start
20122 (concat
20131 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
20132 ;; But only if the user has not turned off tables or fixed-width regions
20133 (org-set-local
20134 'auto-fill-inhibit-regexp
20135 (concat org-outline-regexp
20138 (if (or org-enable-table-editor org-enable-fixed-width-editor)
20139 (concat
20141 (if org-enable-table-editor "|" "")
20142 (if org-enable-fixed-width-editor ":" "")
20143 "]"))))
20144 ;; We use our own fill-paragraph function, to make sure that tables
20145 ;; and fixed-width regions are not wrapped. That function will pass
20146 ;; through to `fill-paragraph' when appropriate.
20147 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
20148 ;; Prevent auto-fill from inserting unwanted new items.
20149 (if (boundp 'fill-nobreak-predicate)
20150 (org-set-local 'fill-nobreak-predicate
20151 (if (memq 'org-fill-item-nobreak-p fill-nobreak-predicate)
20152 fill-nobreak-predicate
20153 (cons 'org-fill-item-nobreak-p fill-nobreak-predicate))))
20154 ;; Adaptive filling: To get full control, first make sure that
20155 ;; `adaptive-fill-regexp' never matches. Then install our own matcher.
20156 (unless (local-variable-p 'adaptive-fill-regexp (current-buffer))
20157 (org-set-local 'org-adaptive-fill-regexp-backup
20158 adaptive-fill-regexp))
20160 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
20161 (org-set-local 'adaptive-fill-function
20162 'org-adaptive-fill-function)
20163 (org-set-local
20164 'align-mode-rules-list
20165 '((org-in-buffer-settings
20167 (modes . '(org-mode))))))
20169 (defun org-fill-item-nobreak-p ()
20170 "Non-nil when a line break at point would insert a new item."
20171 (and (looking-at (org-item-re)) (org-list-in-valid-context-p)))
20173 (defun org-fill-paragraph (&optional justify)
20174 "Re-align a table, pass through to fill-paragraph if no table."
20175 (let ((table-p (org-at-table-p))
20176 (table.el-p (org-at-table.el-p))
20177 (itemp (org-in-item-p)))
20178 (cond ((and (equal (char-after (point-at-bol)) ?*)
20179 (save-excursion (goto-char (point-at-bol))
20180 (looking-at org-outline-regexp)))
20181 t) ; skip headlines
20182 (table.el-p t) ; skip table.el tables
20183 (table-p (org-table-align) t) ; align Org tables
20184 (itemp ; align text in items
20185 (let* ((struct (save-excursion (goto-char itemp)
20186 (org-list-struct)))
20187 (parents (org-list-parents-alist struct))
20188 (children (org-list-get-children itemp struct parents))
20189 beg end prev next prefix)
20190 ;; Determine in which part of item point is: before
20191 ;; first child, after last child, between two
20192 ;; sub-lists, or simply in item if there's no child.
20193 (cond
20194 ((not children)
20195 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20196 beg itemp
20197 end (org-list-get-item-end itemp struct)))
20198 ((< (point) (setq next (car children)))
20199 (setq prefix (make-string (org-list-item-body-column itemp) ?\ )
20200 beg itemp
20201 end next))
20202 ((> (point) (setq prev (car (last children))))
20203 (setq beg (org-list-get-item-end prev struct)
20204 end (org-list-get-item-end itemp struct)
20205 prefix (save-excursion
20206 (goto-char beg)
20208 (make-string (current-column) ?\ ))))
20209 (t (catch 'exit
20210 (while (setq next (pop children))
20211 (if (> (point) next)
20212 (setq prev next)
20213 (setq beg (org-list-get-item-end prev struct)
20214 end next
20215 prefix (save-excursion
20216 (goto-char beg)
20218 (make-string (current-column) ?\ )))
20219 (throw 'exit nil))))))
20220 ;; Use `fill-paragraph' with buffer narrowed to item
20221 ;; without any child, and with our computed PREFIX.
20222 (flet ((fill-context-prefix (from to &optional flr) prefix))
20223 (save-restriction
20224 (narrow-to-region beg end)
20225 (save-excursion (fill-paragraph justify)))) t))
20226 ;; Special case where point is not in a list but is on
20227 ;; a paragraph adjacent to a list: make sure this paragraph
20228 ;; doesn't get merged with the end of the list by narrowing
20229 ;; buffer first.
20230 ((save-excursion (forward-paragraph -1)
20231 (setq itemp (org-in-item-p)))
20232 (let ((struct (save-excursion (goto-char itemp)
20233 (org-list-struct))))
20234 (save-restriction
20235 (narrow-to-region (org-list-get-bottom-point struct)
20236 (save-excursion (forward-paragraph 1)
20237 (point)))
20238 (fill-paragraph justify) t)))
20239 ;; Else simply call `fill-paragraph'.
20240 (t nil))))
20242 ;; For reference, this is the default value of adaptive-fill-regexp
20245 (defun org-adaptive-fill-function ()
20246 "Return a fill prefix for org-mode files."
20247 (let (itemp)
20248 (save-excursion
20249 (cond
20250 ;; Comment line
20252 (match-string-no-properties 0))
20253 ;; Plain list item
20254 ((org-at-item-p)
20255 (make-string (org-list-item-body-column (point-at-bol)) ?\ ))
20256 ;; Point is in a list after `backward-paragraph': original
20257 ;; point wasn't in the list, or filling would have been taken
20258 ;; care of by `org-auto-fill-function', but the list and the
20259 ;; real paragraph are not separated by a blank line. Thus, move
20260 ;; point after the list to go back to real paragraph and
20261 ;; determine fill-prefix.
20262 ((setq itemp (org-in-item-p))
20263 (goto-char itemp)
20264 (let* ((struct (org-list-struct))
20265 (bottom (org-list-get-bottom-point struct)))
20266 (goto-char bottom)
20267 (make-string (org-get-indentation) ?\ )))
20268 ;; Other text
20269 ((looking-at org-adaptive-fill-regexp-backup)
20270 (match-string-no-properties 0))))))
20272 (defun org-auto-fill-function ()
20273 "Auto-fill function."
20274 (let (itemp prefix)
20275 ;; When in a list, compute an appropriate fill-prefix and make
20276 ;; sure it will be used by `do-auto-fill'.
20277 (if (setq itemp (org-in-item-p))
20278 (progn
20279 (setq prefix (make-string (org-list-item-body-column itemp) ?\ ))
20280 (flet ((fill-context-prefix (from to &optional flr) prefix))
20281 (do-auto-fill)))
20282 ;; Else just use `do-auto-fill'.
20283 (do-auto-fill))))
20285 ;;; Other stuff.
20287 (defun org-toggle-fixed-width-section (arg)
20288 "Toggle the fixed-width export.
20289 If there is no active region, the QUOTE keyword at the current headline is
20290 inserted or removed. When present, it causes the text between this headline
20291 and the next to be exported as fixed-width text, and unmodified.
20292 If there is an active region, this command adds or removes a colon as the
20293 first character of this line. If the first character of a line is a colon,
20294 this line is also exported in fixed-width font."
20295 (interactive "P")
20296 (let* ((cc 0)
20297 (regionp (org-region-active-p))
20298 (beg (if regionp (region-beginning) (point)))
20299 (end (if regionp (region-end)))
20300 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
20301 (case-fold-search nil)
20303 off)
20304 (if regionp
20305 (save-excursion
20306 (goto-char beg)
20307 (setq cc (current-column))
20308 (beginning-of-line 1)
20309 (setq off (looking-at re))
20310 (while (> nlines 0)
20311 (setq nlines (1- nlines))
20312 (beginning-of-line 1)
20313 (cond
20314 (arg
20315 (org-move-to-column cc t)
20317 (forward-line -1))
20318 ((and off (looking-at re))
20319 (replace-match "" t t nil 1))
20320 ((not off) (org-move-to-column cc t) (insert ": ")))
20321 (forward-line 1)))
20322 (save-excursion
20323 (org-back-to-heading)
20324 (cond
20325 ((looking-at (format org-heading-keyword-regexp-format
20326 org-quote-string))
20327 (goto-char (match-end 1))
20328 (looking-at (concat " +" org-quote-string))
20329 (replace-match "" t t)
20330 (when (eolp) (insert " ")))
20331 ((looking-at org-outline-regexp)
20332 (goto-char (match-end 0))
20333 (insert org-quote-string " ")))))))
20335 (defun org-reftex-citation ()
20336 "Use reftex-citation to insert a citation into the buffer.
20337 This looks for a line like
20339 #+BIBLIOGRAPHY: foo plain option:-d
20341 and derives from it that foo.bib is the bibliography file relevant
20342 for this document. It then installs the necessary environment for RefTeX
20343 to work in this buffer and calls `reftex-citation' to insert a citation
20344 into the buffer.
20346 Export of such citations to both LaTeX and HTML is handled by the contributed
20347 package org-exp-bibtex by Taru Karttunen."
20348 (interactive)
20349 (let ((reftex-docstruct-symbol 'rds)
20351 rds bib)
20352 (save-excursion
20353 (save-restriction
20354 (widen)
20355 (let ((case-fold-search t)
20357 (if (not (save-excursion
20358 (or (re-search-forward re nil t)
20359 (re-search-backward re nil t))))
20360 (error "No bibliography defined in file")
20361 (setq bib (concat (match-string 1) ".bib")
20362 rds (list (list 'bib bib)))))))
20363 (call-interactively 'reftex-citation)))
20365 ;;;; Functions extending outline functionality
20367 (defun org-beginning-of-line (&optional arg)
20368 "Go to the beginning of the current line. If that is invisible, continue
20369 to a visible line beginning. This makes the function of C-a more intuitive.
20370 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20371 first attempt, and only move to after the tags when the cursor is already
20372 beyond the end of the headline."
20373 (interactive "P")
20374 (let ((pos (point))
20375 (special (if (consp org-special-ctrl-a/e)
20376 (car org-special-ctrl-a/e)
20377 org-special-ctrl-a/e))
20378 refpos)
20379 (if (org-bound-and-true-p line-move-visual)
20380 (beginning-of-visual-line 1)
20381 (beginning-of-line 1))
20382 (if (and arg (fboundp 'move-beginning-of-line))
20383 (call-interactively 'move-beginning-of-line)
20384 (if (bobp)
20385 nil
20386 (backward-char 1)
20387 (if (org-truely-invisible-p)
20388 (while (and (not (bobp)) (org-truely-invisible-p))
20389 (backward-char 1)
20390 (beginning-of-line 1))
20391 (forward-char 1))))
20392 (when special
20393 (cond
20394 ((and (looking-at org-complex-heading-regexp)
20395 (= (char-after (match-end 1)) ?\ ))
20396 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
20397 (point-at-eol)))
20398 (goto-char
20399 (if (eq special t)
20400 (cond ((> pos refpos) refpos)
20401 ((= pos (point)) refpos)
20402 (t (point)))
20403 (cond ((> pos (point)) (point))
20404 ((not (eq last-command this-command)) (point))
20405 (t refpos)))))
20406 ((org-at-item-p)
20407 (goto-char
20408 (if (eq special t)
20409 (cond ((> pos (match-end 0)) (match-end 0))
20410 ((= pos (point)) (match-end 0))
20411 (t (point)))
20412 (cond ((> pos (point)) (point))
20413 ((not (eq last-command this-command)) (point))
20414 (t (match-end 0))))))))
20415 (org-no-warnings
20416 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20418 (defun org-end-of-line (&optional arg)
20419 "Go to the end of the line.
20420 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
20421 first attempt, and only move to after the tags when the cursor is already
20422 beyond the end of the headline."
20423 (interactive "P")
20424 (let ((special (if (consp org-special-ctrl-a/e)
20425 (cdr org-special-ctrl-a/e)
20426 org-special-ctrl-a/e)))
20427 (cond
20428 ((or (not special) arg
20429 (not (or (org-at-heading-p) (org-at-item-p) (org-at-drawer-p))))
20430 (call-interactively
20431 (cond ((org-bound-and-true-p line-move-visual) 'end-of-visual-line)
20432 ((fboundp 'move-end-of-line) 'move-end-of-line)
20433 (t 'end-of-line))))
20434 ((org-at-heading-p)
20435 (let ((pos (point)))
20436 (beginning-of-line 1)
20438 (if (eq special t)
20439 (if (or (< pos (match-beginning 1))
20440 (= pos (match-end 0)))
20441 (goto-char (match-beginning 1))
20442 (goto-char (match-end 0)))
20443 (if (or (< pos (match-end 0)) (not (eq this-command last-command)))
20444 (goto-char (match-end 0))
20445 (goto-char (match-beginning 1))))
20446 (call-interactively (if (fboundp 'move-end-of-line)
20447 'move-end-of-line
20448 'end-of-line)))))
20449 ((org-at-drawer-p)
20450 (move-end-of-line 1)
20451 (when (overlays-at (1- (point))) (backward-char 1)))
20452 ;; At an item: Move before any hidden text.
20453 (t (call-interactively 'end-of-line)))
20454 (org-no-warnings
20455 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
20457 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
20458 (define-key org-mode-map "\C-e" 'org-end-of-line)
20460 (defun org-backward-sentence (&optional arg)
20461 "Go to beginning of sentence, or beginning of table field.
20462 This will call `backward-sentence' or `org-table-beginning-of-field',
20463 depending on context."
20464 (interactive "P")
20465 (cond
20466 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
20467 (t (call-interactively 'backward-sentence))))
20469 (defun org-forward-sentence (&optional arg)
20470 "Go to end of sentence, or end of table field.
20471 This will call `forward-sentence' or `org-table-end-of-field',
20472 depending on context."
20473 (interactive "P")
20474 (cond
20475 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
20476 (t (call-interactively 'forward-sentence))))
20478 (define-key org-mode-map "\M-a" 'org-backward-sentence)
20479 (define-key org-mode-map "\M-e" 'org-forward-sentence)
20481 (defun org-kill-line (&optional arg)
20482 "Kill line, to tags or end of line."
20483 (interactive "P")
20484 (cond
20485 ((or (not org-special-ctrl-k)
20486 (bolp)
20487 (not (org-at-heading-p)))
20488 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
20489 org-ctrl-k-protect-subtree)
20490 (if (or (eq org-ctrl-k-protect-subtree 'error)
20491 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
20492 (error "C-k aborted - would kill hidden subtree")))
20493 (call-interactively 'kill-line))
20495 (kill-region (point) (match-beginning 1))
20496 (org-set-tags nil t))
20497 (t (kill-region (point) (point-at-eol)))))
20499 (define-key org-mode-map "\C-k" 'org-kill-line)
20501 (defun org-yank (&optional arg)
20502 "Yank. If the kill is a subtree, treat it specially.
20503 This command will look at the current kill and check if is a single
20504 subtree, or a series of subtrees[1]. If it passes the test, and if the
20505 cursor is at the beginning of a line or after the stars of a currently
20506 empty headline, then the yank is handled specially. How exactly depends
20507 on the value of the following variables, both set by default.
20509 org-yank-folded-subtrees
20510 When set, the subtree(s) will be folded after insertion, but only
20511 if doing so would now swallow text after the yanked text.
20513 org-yank-adjusted-subtrees
20514 When set, the subtree will be promoted or demoted in order to
20515 fit into the local outline tree structure, which means that the level
20516 will be adjusted so that it becomes the smaller one of the two
20517 *visible* surrounding headings.
20519 Any prefix to this command will cause `yank' to be called directly with
20521 will just
20522 plainly yank the text as it is.
20524 \[1] The test checks if the first non-white line is a heading
20525 and if there are no other headings with fewer stars."
20526 (interactive "P")
20527 (org-yank-generic 'yank arg))
20529 (defun org-yank-generic (command arg)
20530 "Perform some yank-like command.
20532 This function implements the behavior described in the `org-yank'
20533 documentation. However, it has been generalized to work for any
20534 interactive command with similar behavior."
20536 ;; pretend to be command COMMAND
20537 (setq this-command command)
20539 (if arg
20540 (call-interactively command)
20542 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
20543 (and (org-kill-is-subtree-p)
20544 (or (bolp)
20546 (string-match
20548 (buffer-substring (point-at-bol) (point)))))))
20549 swallowp)
20550 (cond
20551 ((and subtreep org-yank-folded-subtrees)
20552 (let ((beg (point))
20553 end)
20554 (if (and subtreep org-yank-adjusted-subtrees)
20555 (org-paste-subtree nil nil 'for-yank)
20556 (call-interactively command))
20558 (setq end (point))
20559 (goto-char beg)
20560 (when (and (bolp) subtreep
20561 (not (setq swallowp
20562 (org-yank-folding-would-swallow-text beg end))))
20563 (org-with-limited-levels
20564 (or (looking-at org-outline-regexp)
20565 (re-search-forward org-outline-regexp-bol end t))
20566 (while (and (< (point) end) (looking-at org-outline-regexp))
20567 (hide-subtree)
20568 (org-cycle-show-empty-lines 'folded)
20569 (condition-case nil
20570 (outline-forward-same-level 1)
20571 (error (goto-char end))))))
20572 (when swallowp
20573 (message
20574 "Inserted text not folded because that would swallow text"))
20576 (goto-char end)
20578 (beginning-of-line 1)
20579 (push-mark beg 'nomsg)))
20580 ((and subtreep org-yank-adjusted-subtrees)
20581 (let ((beg (point-at-bol)))
20582 (org-paste-subtree nil nil 'for-yank)
20583 (push-mark beg 'nomsg)))
20584 (t
20585 (call-interactively command))))))
20587 (defun org-yank-folding-would-swallow-text (beg end)
20588 "Would hide-subtree at BEG swallow any text after END?"
20589 (let (level)
20590 (org-with-limited-levels
20591 (save-excursion
20592 (goto-char beg)
20593 (when (or (looking-at org-outline-regexp)
20594 (re-search-forward org-outline-regexp-bol end t))
20595 (setq level (org-outline-level)))
20596 (goto-char end)
20598 (if (or (eobp)
20599 (and (bolp) (looking-at org-outline-regexp)
20600 (<= (org-outline-level) level)))
20601 nil ; Nothing would be swallowed
20602 t))))) ; something would swallow
20604 (define-key org-mode-map "\C-y" 'org-yank)
20606 (defun org-truely-invisible-p ()
20607 "Check if point is at a character currently not visible.
20608 This version does not only check the character property, but also
20609 `visible-mode'."
20610 ;; Early versions of noutline don't have `outline-invisible-p'.
20611 (if (org-bound-and-true-p visible-mode)
20612 nil
20613 (outline-invisible-p)))
20615 (defun org-invisible-p2 ()
20616 "Check if point is at a character currently not visible."
20617 (save-excursion
20618 (if (and (eolp) (not (bobp))) (backward-char 1))
20619 ;; Early versions of noutline don't have `outline-invisible-p'.
20620 (outline-invisible-p)))
20622 (defun org-back-to-heading (&optional invisible-ok)
20623 "Call `outline-back-to-heading', but provide a better error message."
20624 (condition-case nil
20625 (outline-back-to-heading invisible-ok)
20626 (error (error "Before first headline at position %d in buffer %s"
20627 (point) (current-buffer)))))
20629 (defun org-beginning-of-defun ()
20630 "Go to the beginning of the subtree, i.e. back to the heading."
20631 (org-back-to-heading))
20632 (defun org-end-of-defun ()
20633 "Go to the end of the subtree."
20634 (org-end-of-subtree nil t))
20636 (defun org-before-first-heading-p ()
20637 "Before first heading?"
20638 (save-excursion
20639 (end-of-line)
20640 (null (re-search-backward org-outline-regexp-bol nil t))))
20642 (defun org-at-heading-p (&optional ignored)
20643 (outline-on-heading-p t))
20644 ;; Compatibility alias with Org versions < 7.8.03
20645 (defalias 'org-on-heading-p 'org-at-heading-p)
20647 (defun org-at-drawer-p nil
20648 "Whether point is at a drawer."
20649 (save-excursion
20650 (move-beginning-of-line 1)
20651 (looking-at org-drawer-regexp)))
20653 (defun org-point-at-end-of-empty-headline ()
20654 "If point is at the end of an empty headline, return t, else nil.
20655 If the heading only contains a TODO keyword, it is still still considered
20656 empty."
20658 (save-excursion
20659 (beginning-of-line 1)
20660 (let ((case-fold-search nil))
20661 (looking-at org-todo-line-regexp)))
20662 (string= (match-string 3) "")))
20664 (defun org-at-heading-or-item-p ()
20665 (or (org-at-heading-p) (org-at-item-p)))
20667 (defun org-at-target-p ()
20668 (or (org-in-regexp org-radio-target-regexp)
20669 (org-in-regexp org-target-regexp)))
20670 ;; Compatibility alias with Org versions < 7.8.03
20671 (defalias 'org-on-target-p 'org-at-target-p)
20673 (defun org-up-heading-all (arg)
20674 "Move to the heading line of which the present line is a subheading.
20675 This function considers both visible and invisible heading lines.
20676 With argument, move up ARG levels."
20677 (if (fboundp 'outline-up-heading-all)
20678 (outline-up-heading-all arg) ; emacs 21 version of outline.el
20679 (outline-up-heading arg t))) ; emacs 22 version of outline.el
20681 (defun org-up-heading-safe ()
20682 "Move to the heading line of which the present line is a subheading.
20683 This version will not throw an error. It will return the level of the
20684 headline found, or nil if no higher level is found.
20686 Also, this function will be a lot faster than `outline-up-heading',
20687 because it relies on stars being the outline starters. This can really
20688 make a significant difference in outlines with very many siblings."
20689 (let (start-level re)
20690 (org-back-to-heading t)
20691 (setq start-level (funcall outline-level))
20692 (if (equal start-level 1)
20693 nil
20695 (if (re-search-backward re nil t)
20696 (funcall outline-level)))))
20698 (defun org-first-sibling-p ()
20699 "Is this heading the first child of its parents?"
20700 (interactive)
20701 (let ((re org-outline-regexp-bol)
20702 level l)
20703 (unless (org-at-heading-p t)
20704 (error "Not at a heading"))
20705 (setq level (funcall outline-level))
20706 (save-excursion
20707 (if (not (re-search-backward re nil t))
20708 t
20709 (setq l (funcall outline-level))
20710 (< l level)))))
20712 (defun org-goto-sibling (&optional previous)
20713 "Goto the next sibling, even if it is invisible.
20714 When PREVIOUS is set, go to the previous sibling instead. Returns t
20715 when a sibling was found. When none is found, return nil and don't
20716 move point."
20717 (let ((fun (if previous 're-search-backward 're-search-forward))
20718 (pos (point))
20719 (re org-outline-regexp-bol)
20720 level l)
20721 (when (condition-case nil (org-back-to-heading t) (error nil))
20722 (setq level (funcall outline-level))
20723 (catch 'exit
20724 (or previous (forward-char 1))
20725 (while (funcall fun re nil t)
20726 (setq l (funcall outline-level))
20727 (when (< l level) (goto-char pos) (throw 'exit nil))
20728 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
20729 (goto-char pos)
20730 nil))))
20732 (defun org-show-siblings ()
20733 "Show all siblings of the current headline."
20734 (save-excursion
20735 (while (org-goto-sibling) (org-flag-heading nil)))
20736 (save-excursion
20737 (while (org-goto-sibling 'previous)
20738 (org-flag-heading nil))))
20740 (defun org-goto-first-child ()
20741 "Goto the first child, even if it is invisible.
20742 Return t when a child was found. Otherwise don't move point and
20743 return nil."
20744 (let (level (pos (point)) (re org-outline-regexp-bol))
20745 (when (condition-case nil (org-back-to-heading t) (error nil))
20746 (setq level (outline-level))
20747 (forward-char 1)
20748 (if (and (re-search-forward re nil t) (> (outline-level) level))
20749 (progn (goto-char (match-beginning 0)) t)
20750 (goto-char pos) nil))))
20752 (defun org-show-hidden-entry ()
20753 "Show an entry where even the heading is hidden."
20754 (save-excursion
20755 (org-show-entry)))
20757 (defun org-flag-heading (flag &optional entry)
20758 "Flag the current heading. FLAG non-nil means make invisible.
20759 When ENTRY is non-nil, show the entire entry."
20760 (save-excursion
20761 (org-back-to-heading t)
20762 ;; Check if we should show the entire entry
20763 (if entry
20764 (progn
20765 (org-show-entry)
20766 (save-excursion
20767 (and (outline-next-heading)
20768 (org-flag-heading nil))))
20769 (outline-flag-region (max (point-min) (1- (point)))
20770 (save-excursion (outline-end-of-heading) (point))
20771 flag))))
20773 (defun org-get-next-sibling ()
20774 "Move to next heading of the same level, and return point.
20775 If there is no such heading, return nil.
20776 This is like outline-next-sibling, but invisible headings are ok."
20777 (let ((level (funcall outline-level)))
20778 (outline-next-heading)
20779 (while (and (not (eobp)) (> (funcall outline-level) level))
20780 (outline-next-heading))
20781 (if (or (eobp) (< (funcall outline-level) level))
20782 nil
20783 (point))))
20785 (defun org-get-last-sibling ()
20786 "Move to previous heading of the same level, and return point.
20787 If there is no such heading, return nil."
20788 (let ((opoint (point))
20789 (level (funcall outline-level)))
20790 (outline-previous-heading)
20791 (when (and (/= (point) opoint) (outline-on-heading-p t))
20792 (while (and (> (funcall outline-level) level)
20793 (not (bobp)))
20794 (outline-previous-heading))
20795 (if (< (funcall outline-level) level)
20796 nil
20797 (point)))))
20799 (defun org-end-of-subtree (&optional invisible-OK to-heading)
20800 ;; This contains an exact copy of the original function, but it uses
20801 ;; `org-back-to-heading', to make it work also in invisible
20802 ;; trees. And is uses an invisible-OK argument.
20803 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
20804 ;; Furthermore, when used inside Org, finding the end of a large subtree
20805 ;; with many children and grandchildren etc, this can be much faster
20806 ;; than the outline version.
20807 (org-back-to-heading invisible-OK)
20808 (let ((first t)
20809 (level (funcall outline-level)))
20810 (if (and (eq major-mode 'org-mode) (< level 1000))
20811 ;; A true heading (not a plain list item), in Org-mode
20812 ;; This means we can easily find the end by looking
20813 ;; only for the right number of stars. Using a regexp to do
20814 ;; this is so much faster than using a Lisp loop.
20816 (forward-char 1)
20817 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
20818 ;; something else, do it the slow way
20819 (while (and (not (eobp))
20820 (or first (> (funcall outline-level) level)))
20821 (setq first nil)
20822 (outline-next-heading)))
20823 (unless to-heading
20825 (progn
20826 ;; Go to end of line before heading
20827 (forward-char -1)
20829 ;; leave blank line before heading
20830 (forward-char -1))))))
20831 (point))
20833 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
20834 "Use Org version in org-mode, for dramatic speed-up."
20835 (if (eq major-mode 'org-mode)
20836 (progn
20837 (org-end-of-subtree nil t)
20838 (unless (eobp) (backward-char 1)))
20839 ad-do-it))
20841 (defun org-end-of-meta-data-and-drawers ()
20842 "Jump to the first text after meta data and drawers in the current entry.
20843 This will move over empty lines, lines with planning time stamps,
20844 clocking lines, and drawers."
20845 (org-back-to-heading t)
20846 (let ((end (save-excursion (outline-next-heading) (point)))
20849 (forward-line 1)
20850 (while (re-search-forward re end t)
20851 (if (not (match-end 1))
20852 ;; empty or planning line
20853 (forward-line 1)
20854 ;; a drawer, find the end
20856 (forward-line 1)))
20858 (point)))
20860 (defun org-forward-same-level (arg &optional invisible-ok)
20861 "Move forward to the arg'th subheading at same level as this one.
20862 Stop at the first and last subheadings of a superior heading.
20863 Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil
20864 it wil also look at invisible ones."
20865 (interactive "p")
20866 (org-back-to-heading invisible-ok)
20867 (org-at-heading-p)
20868 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20870 l)
20871 (forward-char 1)
20872 (while (> arg 0)
20873 (while (and (re-search-forward re nil 'move)
20874 (setq l (- (match-end 0) (match-beginning 0) 1))
20875 (= l level)
20876 (not invisible-ok)
20877 (progn (backward-char 1) (outline-invisible-p)))
20878 (if (< l level) (setq arg 1)))
20879 (setq arg (1- arg)))
20880 (beginning-of-line 1)))
20882 (defun org-backward-same-level (arg &optional invisible-ok)
20883 "Move backward to the arg'th subheading at same level as this one.
20884 Stop at the first and last subheadings of a superior heading."
20885 (interactive "p")
20886 (org-back-to-heading)
20887 (org-at-heading-p)
20888 (let* ((level (- (match-end 0) (match-beginning 0) 1))
20890 l)
20891 (while (> arg 0)
20892 (while (and (re-search-backward re nil 'move)
20893 (setq l (- (match-end 0) (match-beginning 0) 1))
20894 (= l level)
20895 (not invisible-ok)
20896 (outline-invisible-p))
20897 (if (< l level) (setq arg 1)))
20898 (setq arg (1- arg)))))
20900 (defun org-show-subtree ()
20901 "Show everything after this heading at deeper levels."
20902 (outline-flag-region
20903 (point)
20904 (save-excursion
20905 (org-end-of-subtree t t))
20906 nil))
20908 (defun org-show-entry ()
20909 "Show the body directly following this heading.
20910 Show the heading too, if it is currently invisible."
20911 (interactive)
20912 (save-excursion
20913 (condition-case nil
20914 (progn
20915 (org-back-to-heading t)
20916 (outline-flag-region
20917 (max (point-min) (1- (point)))
20918 (save-excursion
20919 (if (re-search-forward
20921 (match-beginning 1)
20922 (point-max)))
20923 nil)
20924 (org-cycle-hide-drawers 'children))
20925 (error nil))))
20927 (defun org-make-options-regexp (kwds &optional extra)
20928 "Make a regular expression for keyword lines."
20929 (concat
20930 "^"
20937 ;; Make isearch reveal the necessary context
20938 (defun org-isearch-end ()
20939 "Reveal context after isearch exits."
20940 (when isearch-success ; only if search was successful
20941 (if (featurep 'xemacs)
20942 ;; Under XEmacs, the hook is run in the correct place,
20943 ;; we directly show the context.
20944 (org-show-context 'isearch)
20945 ;; In Emacs the hook runs *before* restoring the overlays.
20946 ;; So we have to use a one-time post-command-hook to do this.
20947 ;; (Emacs 22 has a special variable, see function `org-mode')
20948 (unless (and (boundp 'isearch-mode-end-hook-quit)
20949 isearch-mode-end-hook-quit)
20950 ;; Only when the isearch was not quitted.
20951 (org-add-hook 'post-command-hook 'org-isearch-post-command
20952 'append 'local)))))
20954 (defun org-isearch-post-command ()
20955 "Remove self from hook, and show context."
20956 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
20957 (org-show-context 'isearch))
20960 ;;;; Integration with and fixes for other packages
20962 ;;; Imenu support
20964 (defvar org-imenu-markers nil
20965 "All markers currently used by Imenu.")
20966 (make-variable-buffer-local 'org-imenu-markers)
20968 (defun org-imenu-new-marker (&optional pos)
20969 "Return a new marker for use by Imenu, and remember the marker."
20970 (let ((m (make-marker)))
20971 (move-marker m (or pos (point)))
20972 (push m org-imenu-markers)
20973 m))
20975 (defun org-imenu-get-tree ()
20976 "Produce the index for Imenu."
20977 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
20978 (setq org-imenu-markers nil)
20979 (let* ((n org-imenu-depth)
20980 (re (concat "^" (org-get-limited-outline-regexp)))
20981 (subs (make-vector (1+ n) nil))
20982 (last-level 0)
20983 m level head)
20984 (save-excursion
20985 (save-restriction
20986 (widen)
20987 (goto-char (point-max))
20988 (while (re-search-backward re nil t)
20989 (setq level (org-reduced-level (funcall outline-level)))
20990 (when (<= level n)
20991 (looking-at org-complex-heading-regexp)
20992 (setq head (org-link-display-format
20993 (org-match-string-no-properties 4))
20994 m (org-imenu-new-marker))
20995 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
20996 (if (>= level last-level)
20997 (push (cons head m) (aref subs level))
20998 (push (cons head (aref subs (1+ level))) (aref subs level))
20999 (loop for i from (1+ level) to n do (aset subs i nil)))
21000 (setq last-level level)))))
21001 (aref subs 1)))
21003 (eval-after-load "imenu"
21004 '(progn
21005 (add-hook 'imenu-after-jump-hook
21006 (lambda ()
21007 (if (eq major-mode 'org-mode)
21008 (org-show-context 'org-goto))))))
21010 (defun org-link-display-format (link)
21011 "Replace a link with either the description, or the link target
21012 if no description is present"
21013 (save-match-data
21014 (if (string-match org-bracket-link-analytic-regexp link)
21015 (replace-match (if (match-end 5)
21016 (match-string 5 link)
21017 (concat (match-string 1 link)
21018 (match-string 3 link)))
21019 nil t link)
21020 link)))
21022 (defun org-toggle-link-display ()
21023 "Toggle the literal or descriptive display of links."
21024 (interactive)
21025 (if org-descriptive-links
21026 (progn (org-remove-from-invisibility-spec '(org-link))
21027 (org-restart-font-lock)
21028 (setq org-descriptive-links nil))
21029 (progn (add-to-invisibility-spec '(org-link))
21030 (org-restart-font-lock)
21031 (setq org-descriptive-links t))))
21033 ;; Speedbar support
21035 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
21036 "Overlay marking the agenda restriction line in speedbar.")
21037 (overlay-put org-speedbar-restriction-lock-overlay
21038 'face 'org-agenda-restriction-lock)
21039 (overlay-put org-speedbar-restriction-lock-overlay
21040 'help-echo "Agendas are currently limited to this item.")
21041 (org-detach-overlay org-speedbar-restriction-lock-overlay)
21043 (defun org-speedbar-set-agenda-restriction ()
21044 "Restrict future agenda commands to the location at point in speedbar.
21046 (interactive)
21047 (require 'org-agenda)
21048 (let (p m tp np dir txt)
21049 (cond
21050 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21051 'org-imenu t))
21052 (setq m (get-text-property p 'org-imenu-marker))
21053 (with-current-buffer (marker-buffer m)
21054 (goto-char m)
21055 (org-agenda-set-restriction-lock 'subtree)))
21056 ((setq p (text-property-any (point-at-bol) (point-at-eol)
21057 'speedbar-function 'speedbar-find-file))
21058 (setq tp (previous-single-property-change
21059 (1+ p) 'speedbar-function)
21060 np (next-single-property-change
21061 tp 'speedbar-function)
21062 dir (speedbar-line-directory)
21063 txt (buffer-substring-no-properties (or tp (point-min))
21064 (or np (point-max))))
21065 (with-current-buffer (find-file-noselect
21066 (let ((default-directory dir))
21067 (expand-file-name txt)))
21068 (unless (eq major-mode 'org-mode)
21069 (error "Cannot restrict to non-Org-mode file"))
21070 (org-agenda-set-restriction-lock 'file)))
21071 (t (error "Don't know how to restrict Org-mode's agenda")))
21072 (move-overlay org-speedbar-restriction-lock-overlay
21073 (point-at-bol) (point-at-eol))
21074 (setq current-prefix-arg nil)
21075 (org-agenda-maybe-redo)))
21077 (eval-after-load "speedbar"
21078 '(progn
21079 (speedbar-add-supported-extension ".org")
21080 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
21081 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
21082 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
21083 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
21084 (add-hook 'speedbar-visiting-tag-hook
21085 (lambda () (and (eq major-mode 'org-mode) (org-show-context 'org-goto))))))
21087 ;;; Fixes and Hacks for problems with other packages
21089 ;; Make flyspell not check words in links, to not mess up our keymap
21090 (defun org-mode-flyspell-verify ()
21091 "Don't let flyspell put overlays at active buttons, or on
21092 {todo,all-time,additional-option-like}-keywords."
21093 (let ((pos (max (1- (point)) (point-min)))
21094 (word (thing-at-point 'word)))
21095 (and (not (get-text-property pos 'keymap))
21096 (not (get-text-property pos 'org-no-flyspell))
21097 (not (member word org-todo-keywords-1))
21098 (not (member word org-all-time-keywords))
21099 (not (member word org-additional-option-like-keywords)))))
21101 (defun org-remove-flyspell-overlays-in (beg end)
21102 "Remove flyspell overlays in region."
21103 (and (org-bound-and-true-p flyspell-mode)
21104 (fboundp 'flyspell-delete-region-overlays)
21105 (flyspell-delete-region-overlays beg end))
21106 (add-text-properties beg end '(org-no-flyspell t)))
21108 ;; Make `bookmark-jump' shows the jump location if it was hidden.
21109 (eval-after-load "bookmark"
21110 '(if (boundp 'bookmark-after-jump-hook)
21111 ;; We can use the hook
21112 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
21113 ;; Hook not available, use advice
21114 (defadvice bookmark-jump (after org-make-visible activate)
21115 "Make the position visible."
21116 (org-bookmark-jump-unhide))))
21118 ;; Make sure saveplace shows the location if it was hidden
21119 (eval-after-load "saveplace"
21120 '(defadvice save-place-find-file-hook (after org-make-visible activate)
21121 "Make the position visible."
21122 (org-bookmark-jump-unhide)))
21124 ;; Make sure ecb shows the location if it was hidden
21125 (eval-after-load "ecb"
21126 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
21127 "Make hierarchy visible when jumping into location from ECB tree buffer."
21128 (if (eq major-mode 'org-mode)
21129 (org-show-context))))
21131 (defun org-bookmark-jump-unhide ()
21132 "Unhide the current position, to show the bookmark location."
21133 (and (eq major-mode 'org-mode)
21134 (or (outline-invisible-p)
21135 (save-excursion (goto-char (max (point-min) (1- (point))))
21136 (outline-invisible-p)))
21137 (org-show-context 'bookmark-jump)))
21139 ;; Make session.el ignore our circular variable
21140 (eval-after-load "session"
21141 '(add-to-list 'session-globals-exclude 'org-mark-ring))
21143 ;;;; Experimental code
21145 (defun org-closed-in-range ()
21146 "Sparse tree of items closed in a certain time range.
21147 Still experimental, may disappear in the future."
21148 (interactive)
21149 ;; Get the time interval from the user.
21150 (let* ((time1 (org-float-time
21151 (org-read-date nil 'to-time nil "Starting date: ")))
21152 (time2 (org-float-time
21153 (org-read-date nil 'to-time nil "End date:")))
21154 ;; callback function
21155 (callback (lambda ()
21156 (let ((time
21157 (org-float-time
21158 (apply 'encode-time
21159 (org-parse-time-string
21160 (match-string 1))))))
21161 ;; check if time in interval
21162 (and (>= time time1) (<= time time2))))))
21163 ;; make tree, check each match with the callback
21166 ;;;; Finish up
21168 (provide 'org)
21170 (run-hooks 'org-load-hook)
21172 ;;; org.el ends here