| blob | 5bb008c9f95c9ee6e8880dc5610095cb91045dc0 |
1 ;;; org.el --- Outline-based notes management and organizer
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2013 Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Maintainer: Bastien Guerry <bzg at gnu dot org>
8 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; Homepage: http://orgmode.org
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
86 ;; `org-outline-regexp' ought to be a defconst but is let-binding in
87 ;; some places -- e.g. see the macro `org-with-limited-levels'.
88 ;;
89 ;; In Org buffers, the value of `outline-regexp' is that of
90 ;; `org-outline-regexp'. The only function still directly relying on
91 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
92 ;; job when `orgstruct-mode' is active.
97 "Regexp to match Org headlines.
98 This is similar to `org-outline-regexp' but additionally makes
102 "Matches a headline, putting stars and text into groups.
105 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
118 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
163 ;; load languages based on value of `org-babel-load-languages'
166 ;;;###autoload
168 "Load the languages defined in `org-babel-load-languages'."
180 org-babel-load-languages))
182 ;;;###autoload
184 "Load Emacs Lisp source code blocks in the Org-mode FILE.
185 This function exports the source code using `org-babel-tangle'
186 and then loads the resulting file using `load-file'. With prefix
187 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
188 file to byte-code before it is loaded."
198 ;; tangle if the org-mode file is newer than the elisp file
207 exported-file)))
210 "Languages which can be evaluated in Org-mode buffers.
211 This list can be used to load support for any of the languages
212 below, note that each language will depend on a different set of
213 system executables and/or Emacs modes. When a language is
215 with `org-babel-execute-src-block' bound by default to C-c
216 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
217 be set to remove code block evaluation from the C-c C-c
218 keybinding. By default only Emacs Lisp (which has no
219 requirements) is loaded."
224 :key-type
268 ;;;; Customization variables
270 "Remove ID property of clones of a subtree.
271 When non-nil, clones of a subtree don't inherit the ID property.
272 Otherwise they inherit the ID property with a new unique
273 identifier."
278 ;;; Version
281 ;;;###autoload
283 "Show the org-mode version in the echo area.
284 With prefix argument HERE, insert it at point.
285 When FULL is non-nil, use a verbose version string.
286 When MESSAGE is non-nil, display a message with the version."
299 org-version
300 git-version
303 org-install-dir
312 _version)))
316 ;;; Compatibility constants
318 ;;; The custom variables
321 "Outline-based notes management and organizer."
327 "Mode hook for Org-mode, run after the mode was turned on."
332 "Hook that is run after org.el has been loaded."
337 "Hook that is run after an Org log buffer is created."
347 "Load all extensions listed in `org-modules'."
352 org-modules)
356 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
361 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
362 "Modules that should always be loaded together with org.el.
364 If a description starts with <C>, the file is not part of Emacs
365 and loading it will require that you have downloaded and properly
366 installed the Org mode distribution.
368 You can also use this system to load external packages (i.e. neither Org
369 core modules, nor modules from the CONTRIB directory). Just add symbols
370 to the end of the list. If the package is called org-xyz.el, then you need
371 to add the symbol `xyz', and the package must have a call to:
373 \(provide 'org-xyz)
375 For export specific modules, see also `org-export-backends'."
380 :type
405 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
414 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
419 (const :tag "C mac-link-grabber Grab links and URLs from various Mac applications" org-mac-link-grabber)
442 "List of export back-ends that should be always available.
444 If a description starts with <C>, the file is not part of Emacs
445 and loading it will require that you have downloaded and properly
446 installed the Org mode distribution.
448 Unlike to `org-modules', libraries in this list will not be
449 loaded along with Org, but only once the export framework is
450 needed.
452 This variable needs to be set before org.el is loaded. If you
453 need to make a change while Emacs is running, use the customize
454 interface or run the following code, where VALUE stands for the
455 new value of the variable, after updating it:
457 \(progn
458 \(setq org-export-registered-backends
459 \(org-remove-if-not
460 \(lambda (backend)
461 \(or (memq backend val)
462 \(catch 'parentp
463 \(mapc
464 \(lambda (b)
465 \(and (org-export-derived-backend-p b (car backend))
466 \(throw 'parentp t)))
467 val)
468 nil)))
469 org-export-registered-backends))
470 \(let ((new-list (mapcar 'car org-export-registered-backends)))
471 \(dolist (backend val)
472 \(cond
475 backend))
476 \((not (memq backend new-list)) (push backend new-list))))
477 \(set-default var new-list)))
479 Adding a back-end to this list will also pull the back-end it
480 depends on, if any."
488 ;; Any back-end not required anymore (not present in VAL and not
489 ;; a parent of any back-end in the new value) is removed from the
490 ;; list of registered back-ends.
500 val)
501 nil)))
502 org-export-registered-backends))
503 ;; Now build NEW-LIST of both new back-ends and required
504 ;; parents.
510 backend))
512 ;; Set VAR to that list with fixed dependencies.
539 backend))))
540 org-export-backends))
543 "Non-nil means make shift-cursor commands select text when possible.
545 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
546 start selecting a region, or enlarge regions started in this way.
547 In Org-mode, in special contexts, these same keys are used for
548 other purposes, important enough to compete with shift selection.
549 Org tries to balance these needs by supporting `shift-select-mode'
550 outside these special contexts, under control of this variable.
552 The default of this variable is nil, to avoid confusing behavior. Shifted
553 cursor keys will then execute Org commands in the following contexts:
554 - on a headline, changing TODO state (left/right) and priority (up/down)
555 - on a time stamp, changing the time
556 - in a plain list item, changing the bullet type
557 - in a property definition line, switching between allowed values
558 - in the BEGIN line of a clock table (changing the time block).
559 Outside these contexts, the commands will throw an error.
561 When this variable is t and the cursor is not in a special
562 context, Org-mode will support shift-selection for making and
563 enlarging regions. To make this more effective, the bullet
564 cycling will no longer happen anywhere in an item line, but only
565 if the cursor is exactly on the bullet.
567 If you set this variable to the symbol `always', then the keys
568 will not be special in headlines, property lines, and item lines,
569 to make shift selection work there as well. If this is what you
570 want, you can use the following alternative commands: `C-c C-t'
571 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
572 can be used to switch TODO sets, `C-c -' to cycle item bullet
573 types, and properties can be edited by hand or in column view.
575 However, when the cursor is on a timestamp, shift-cursor commands
576 will still edit the time stamp - this is just too good to give up.
578 XEmacs user should have this variable set to nil, because
579 `shift-select-mode' is in Emacs 23 or later only."
587 "Shall some commands act upon headlines in the active region?
589 When set to `t', some commands will be performed in all headlines
590 within the active region.
592 When set to `start-level', some commands will be performed in all
593 headlines within the active region, provided that these headlines
594 are of the same level than the first one.
596 When set to a string, those commands will be performed on the
597 matching headlines within the active region. Such string must be
598 a tags/property/todo match as it is used in the agenda tags view.
600 The list of commands is: `org-schedule', `org-deadline',
601 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
602 `org-archive-to-archive-sibling'. The archiving commands skip
603 already archived entries."
613 "Options concerning startup of Org-mode."
618 "Non-nil means entering Org-mode will switch to OVERVIEW.
619 This can also be configured on a per-file basis by adding one of
620 the following lines anywhere in the buffer:
622 #+STARTUP: fold (or `overview', this is equivalent)
623 #+STARTUP: nofold (or `showall', this is equivalent)
624 #+STARTUP: content
625 #+STARTUP: showeverything
627 By default, this option is ignored when Org opens agenda files
628 for the first time. If you want the agenda to honor the startup
629 option, set `org-agenda-inhibit-startup' to nil."
638 "Non-nil means entering Org-mode will set `truncate-lines'.
639 This is useful since some lines containing links can be very long and
640 uninteresting. Also tables look terrible when wrapped."
645 "Non-nil means turn on `org-indent-mode' on startup.
646 This can also be configured on a per-file basis by adding one of
647 the following lines anywhere in the buffer:
649 #+STARTUP: indent
650 #+STARTUP: noindent"
658 When this option is turned on, you can use TeX-like syntax for sub- and
660 considered as a single item - so grouping with {} is normally not
661 needed. For example, the following things will be parsed as single
662 sub- or superscripts.
664 10^24 or 10^tau several digits will be considered 1 item.
665 10^-12 or 10^-tau a leading sign with digits or a word
666 x^2-y^3 will be read as x^2 - y^3, because items are
667 terminated by almost any nonword/nondigit char.
668 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
670 Still, ambiguity is possible - so when in doubt use {} to enclose
671 the sub/superscript. If you set this variable to the symbol
672 `{}', the braces are *required* in order to trigger
673 interpretations as sub/superscript. This can be helpful in
683 "Non-nil means turn on `org-beamer-mode' on startup.
684 This can also be configured on a per-file basis by adding one of
685 the following lines anywhere in the buffer:
687 #+STARTUP: beamer"
693 "Non-nil means align all tables when visiting a file.
694 This is useful when the column width in tables is forced with <N> cookies
695 in table fields. Such tables will look correct only after the first re-align.
696 This can also be configured on a per-file basis by adding one of
697 the following lines anywhere in the buffer:
698 #+STARTUP: align
699 #+STARTUP: noalign"
704 "Non-nil means show inline images when loading a new Org file.
705 This can also be configured on a per-file basis by adding one of
706 the following lines anywhere in the buffer:
707 #+STARTUP: inlineimages
708 #+STARTUP: noinlineimages"
714 "Non-nil means preview LaTeX fragments when loading a new Org file.
716 This can also be configured on a per-file basis by adding one of
717 the followinglines anywhere in the buffer:
718 #+STARTUP: latexpreview
719 #+STARTUP: nolatexpreview"
726 "Non-nil means insert the first line setting Org-mode in empty files.
727 When the function `org-mode' is called interactively in an empty file, this
728 normally means that the file name does not automatically trigger Org-mode.
729 To ensure that the file will always be in Org-mode in the future, a
730 line enforcing Org-mode will be inserted into the buffer, if this option
731 has been set."
736 "Non-nil means use alternative key bindings for some keys.
737 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
738 These keys are also used by other packages like shift-selection-mode'
739 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
740 If you want to use Org-mode together with one of these other modes,
741 or more generally if you would like to move some Org-mode commands to
742 other keys, set this variable and configure the keys with the variable
743 `org-disputed-keys'.
745 This option is only relevant at load-time of Org-mode, and must be set
746 *before* org.el is loaded. Changing it requires a restart of Emacs to
747 become effective."
752 "Non-nil means use extra key sequence definitions for certain commands.
753 This happens automatically if you run XEmacs or if `window-system'
754 is nil. This variable lets you do the same manually. You must
755 set it before loading org.
757 Example: on Carbon Emacs 22 running graphically, with an external
758 keyboard on a Powerbook, the default way of setting M-left might
759 not work for either Alt or ESC. Setting this variable will make
760 it work for ESC."
773 "Keys for which Org-mode and other modes compete.
774 This is an alist, cars are the default keys, second element specifies
775 the alternative to use when `org-replace-disputed-keys' is t.
777 Keys can be specified in any syntax supported by `define-key'.
778 The value of this option takes effect only at Org-mode's startup,
779 therefore you'll have to restart Emacs to apply it after changing."
784 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
785 Or return the original if not disputed.
786 Also apply the translations defined in `org-xemacs-key-equivalents'."
791 org-disputed-keys)))
795 key)
805 "Define a key, possibly translated, as returned by `org-key'."
809 "The ellipsis to use in the Org-mode outline.
810 When nil, just use the standard three dots. When a string, use that instead,
811 When a face, use the standard 3 dots, but with the specified face.
812 The change affects only Org-mode (which will then use its own display table).
813 Changing this requires executing `M-x org-mode' in a buffer to become
814 effective."
824 "Keywords in Org-mode."
829 "String to mark deadline entries.
830 A deadline is this string, followed by a time stamp. Should be a word,
831 terminated by a colon. You can insert a schedule keyword and
833 Changes become only effective after restarting Emacs."
838 "String to mark scheduled TODO entries.
839 A schedule is this string, followed by a time stamp. Should be a word,
840 terminated by a colon. You can insert a schedule keyword and
842 Changes become only effective after restarting Emacs."
847 "String used as the prefix for timestamps logging closing a TODO entry."
852 "String used as prefix for timestamps clocking work hours on an item."
864 "Entries starting with this keyword will never be exported.
865 An entry can be toggled between COMMENT and normal with
867 Changes become only effective after restarting Emacs."
872 "Entries starting with this keyword will be exported in fixed-width font.
873 Quoting applies only to the text in the entry following the headline, and does
874 not extend beyond the next headline, even if that is lower level.
875 An entry can be toggled between QUOTE and normal with
882 "Regular expression for specifying repeated events.
886 "Options concerning the general structure of Org-mode files."
891 "Options about how to make context of a location visible."
915 "Non-nil means show full hierarchy when revealing a location.
916 Org-mode often shows locations in an org-mode file which might have
917 been invisible before. When this is set, the hierarchy of headings
918 above the exposed location is shown.
919 Turning this off for example for sparse trees makes them very compact.
920 Instead of t, this can also be an alist specifying this option for different
921 contexts. Valid contexts are
922 agenda when exposing an entry from the agenda
923 org-goto when using the command `org-goto' on key C-c C-j
924 occur-tree when using the command `org-occur' on key C-c /
925 tags-tree when constructing a sparse tree based on tags matches
926 link-search when exposing search matches associated with a link
927 mark-goto when exposing the jump goal of a mark
928 bookmark-jump when exposing a bookmark location
929 isearch when exiting from an incremental search
930 default default for all contexts not set explicitly"
935 "Non-nil means show following heading when revealing a location.
936 Org-mode often shows locations in an org-mode file which might have
937 been invisible before. When this is set, the heading following the
938 match is shown.
939 Turning this off for example for sparse trees makes them very compact,
940 but makes it harder to edit the location of the match. In such a case,
942 Instead of t, this can also be an alist specifying this option for different
943 contexts. See `org-show-hierarchy-above' for valid contexts."
948 "Non-nil means show all sibling heading when revealing a location.
949 Org-mode often shows locations in an org-mode file which might have
950 been invisible before. When this is set, the sibling of the current entry
951 heading are all made visible. If `org-show-hierarchy-above' is t,
952 the same happens on each level of the hierarchy above the current entry.
954 By default this is on for the isearch context, off for all other contexts.
955 Turning this off for example for sparse trees makes them very compact,
956 but makes it harder to edit the location of the match. In such a case,
958 Instead of t, this can also be an alist specifying this option for different
959 contexts. See `org-show-hierarchy-above' for valid contexts."
961 :type org-context-choice
966 "Non-nil means show the entry below a headline when revealing a location.
967 Org-mode often shows locations in an org-mode file which might have
968 been invisible before. When this is set, the text below the headline that is
969 exposed is also shown.
971 By default this is off for all contexts.
972 Instead of t, this can also be an alist specifying this option for different
973 contexts. See `org-show-hierarchy-above' for valid contexts."
978 "How should indirect tree buffers be displayed?
979 This applies to indirect buffers created with the commands
981 Valid values are:
982 current-window Display in the current window
983 other-window Just display in another window.
984 dedicated-frame Create one new frame, and re-use it each time.
985 new-frame Make a new frame each time. Note that in this case
986 previously-made indirect buffers are kept, and you need to
987 kill these buffers yourself."
997 "Non-nil means activate single letter commands at beginning of a headline.
998 This may also be a function to test for appropriate locations where speed
999 commands should be active."
1007 "Alist of additional speed commands.
1008 This list will be checked before `org-speed-commands-default'
1009 when the variable `org-use-speed-commands' is non-nil
1010 and when the cursor is at the beginning of a headline.
1011 The car if each entry is a string with a single letter, which must
1012 be assigned to `self-insert-command' in the global map.
1013 The cdr is either a command to be called interactively, a function
1014 to be called, or a form to be evaluated.
1015 An entry that is just a list with a single string will be interpreted
1016 as a descriptive headline that will be added when listing the speed
1017 commands in the Help buffer using the `?' speed command."
1029 "Options concerning visibility cycling in Org-mode."
1034 "Non-nil means skip CHILDREN state in entries that don't have any."
1039 "Maximum level which should still be subject to visibility cycling.
1040 Levels higher than this will, for cycling, be treated as text, not a headline.
1041 When `org-odd-levels-only' is set, a value of N in this variable actually
1042 means 2N-1 stars as the limiting headline.
1043 When nil, cycle all levels.
1044 Note that the limiting level of cycling is also influenced by
1045 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1046 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1047 than its value."
1054 "Names of drawers. Drawers are not opened by cycling on the headline above.
1055 Drawers only open with a TAB on the drawer line itself. A drawer looks like
1056 this:
1057 :DRAWERNAME:
1058 .....
1059 :END:
1061 the property API.
1063 Drawers can be defined on the per-file basis with a line like:
1065 #+DRAWERS: HIDDEN STATE PROPERTIES"
1071 "Non-nil means entering Org-mode will fold all blocks.
1072 This can also be set in on a per-file basis with
1074 #+STARTUP: hideblocks
1075 #+STARTUP: showblocks"
1081 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1082 This makes it possible to do global cycling without having to use S-TAB or
1084 of the buffer must not be a headline -- it may be empty or some other text.
1085 When used in this way, `org-cycle-hook' is disabled temporarily to make
1086 sure the cursor stays at the beginning of the buffer. When this option is
1087 nil, don't do anything special at the beginning of the buffer."
1092 "Non-nil means cycle entry level or item indentation in new empty entries.
1094 When the cursor is at the end of an empty headline, i.e., with only stars
1095 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1096 and then all possible ancestor states, before returning to the original state.
1097 This makes data entry extremely fast: M-RET to create a new headline,
1098 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1100 When the cursor is at the end of an empty plain list item, one TAB will
1101 make it a subitem, two or more tabs will back up to make this an item
1102 higher up in the item hierarchy."
1107 "Where should `org-cycle' emulate TAB.
1108 nil Never
1109 white Only in completely white lines
1110 whitestart Only at the beginning of lines, before the first non-white char
1111 t Everywhere except in headlines
1112 exc-hl-bol Everywhere except at the start of a headline
1113 If TAB is used in a place where it does not emulate TAB, the current subtree
1114 visibility is cycled."
1121 ))
1124 "Number of empty lines needed to keep an empty line between collapsed trees.
1125 If you leave an empty line between the end of a subtree and the following
1126 headline, this empty line is hidden when the subtree is folded.
1127 Org-mode will leave (exactly) one empty line visible if the number of
1128 empty lines is equal or larger to the number given in this variable.
1129 So the default 2 means at least 2 empty lines after the end of a subtree
1130 are needed to produce free space between a collapsed subtree and the
1131 following headline.
1133 If the number is negative, and the number of empty lines is at least -N,
1134 all empty lines are shown.
1136 Special case: when 0, never leave empty lines in collapsed view."
1142 "Hook that is run before visibility cycling is happening.
1143 The function(s) in this hook must accept a single argument which indicates
1144 the new state that will be set right after running this hook. The
1145 argument is a symbol. Before a global state change, it can have the values
1146 `overview', `content', or `all'. Before a local state change, it can have
1147 the values `folded', `children', or `subtree'."
1152 org-cycle-hide-drawers
1153 org-cycle-hide-inline-tasks
1154 org-cycle-show-empty-lines
1155 org-optimize-window-after-visibility-change)
1156 "Hook that is run after `org-cycle' has changed the buffer visibility.
1157 The function(s) in this hook must accept a single argument which indicates
1158 the new state that was set by the most recent `org-cycle' command. The
1159 argument is a symbol. After a global state change, it can have the values
1160 `overview', `contents', or `all'. After a local state change, it can have
1161 the values `folded', `children', or `subtree'."
1166 "Options concerning structure editing in Org-mode."
1171 "Non-nil means skip even levels and only use odd levels for the outline.
1172 This has the effect that two stars are being added/taken away in
1173 promotion/demotion commands. It also influences how levels are
1174 handled by the exporters.
1175 Changing it requires restart of `font-lock-mode' to become effective
1176 for fontification also in regions already fontified.
1177 You may also set this on a per-file basis by adding one of the following
1178 lines to the buffer:
1180 #+STARTUP: odd
1181 #+STARTUP: oddeven"
1187 "Non-nil means adapt indentation to outline node level.
1189 When this variable is set, Org assumes that you write outlines by
1190 indenting text in each node to align with the headline (after the stars).
1191 The following issues are influenced by this variable:
1193 - When this is set and the *entire* text in an entry is indented, the
1194 indentation is increased by one space in a demotion command, and
1195 decreased by one in a promotion command. If any line in the entry
1196 body starts with text at column 0, indentation is not changed at all.
1198 - Property drawers and planning information is inserted indented when
1199 this variable s set. When nil, they will not be indented.
1201 - TAB indents a line relative to context. The lines below a headline
1202 will be indented when this variable is set.
1204 Note that this is all about true indentation, by adding and removing
1205 space characters. See also `org-indent.el' which does level-dependent
1206 indentation in a virtual way, i.e. at display time in Emacs."
1211 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1213 When t, `C-a' will bring back the cursor to the beginning of the
1214 headline text, i.e. after the stars and after a possible TODO
1215 keyword. In an item, this will be the position after bullet and
1216 check-box, if any. When the cursor is already at that position,
1217 another `C-a' will bring it to the beginning of the line.
1219 `C-e' will jump to the end of the headline, ignoring the presence
1220 of tags in the headline. A second `C-e' will then jump to the
1221 true end of the line, after any tags. This also means that, when
1222 this variable is non-nil, `C-e' also will never jump beyond the
1223 end of the heading of a folded section, i.e. not after the
1224 ellipses.
1226 When set to the symbol `reversed', the first `C-a' or `C-e' works
1227 normally, going to the true line boundary first. Only a directly
1228 following, identical keypress will bring the cursor to the
1229 special positions.
1231 This may also be a cons cell where the behavior for `C-a' and
1232 `C-e' is set separately."
1250 "Non-nil means `C-k' will behave specially in headlines.
1251 When nil, `C-k' will call the default `kill-line' command.
1252 When t, the following will happen while the cursor is in the headline:
1254 - When the cursor is at the beginning of a headline, kill the entire
1255 line and possible the folded subtree below the line.
1256 - When in the middle of the headline text, kill the headline up to the tags.
1257 - When after the headline text, kill the tags."
1262 "Non-nil means, do not delete a hidden subtree with C-k.
1263 When set to the symbol `error', simply throw an error when C-k is
1264 used to kill (part-of) a headline that has hidden text behind it.
1265 Any other non-nil value will result in a query to the user, if it is
1266 OK to kill that hidden subtree. When nil, kill without remorse."
1275 "Check if in invisible region before inserting or deleting a character.
1276 Valid values are:
1278 nil Do not check, so just do invisible edits.
1279 error Throw an error and do nothing.
1280 show Make point visible, and do the requested edit.
1281 show-and-error Make point visible, then throw an error and abort the edit.
1282 smart Make point visible, and do insertion/deletion if it is
1283 adjacent to visible text and the change feels predictable.
1284 Never delete a previously invisible character or add in the
1285 middle or right after an invisible region. Basically, this
1286 allows insertion and backward-delete right before ellipses.
1287 FIXME: maybe in this case we should not even show?"
1298 "Non-nil means when yanking subtrees, fold them.
1299 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1300 it starts with a heading and all other headings in it are either children
1301 or siblings, then fold all the subtrees. However, do this only if no
1302 text after the yank would be swallowed into a folded tree by this action."
1307 "Non-nil means when yanking subtrees, adjust the level.
1308 With this setting, `org-paste-subtree' is used to insert the subtree, see
1309 this function for details."
1314 "Non-nil means M-RET will split the line at the cursor position.
1315 When nil, it will go to the end of the line before making a
1316 new line.
1317 You may also set this option in a different way for different
1318 contexts. Valid contexts are:
1320 headline when creating a new headline
1321 item when creating a new item
1322 table in a table field
1323 default the value to be used for all contexts not explicitly
1324 customized"
1341 "Non-nil means insert new headings after the current subtree.
1342 When nil, the new heading is created directly after the current line.
1343 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1344 this variable on for the duration of the command."
1350 "Should `org-insert-heading' leave a blank line before new heading/item?
1351 The value is an alist, with `heading' and `plain-list-item' as CAR,
1352 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1353 which case Org will look at the surrounding headings/items and try to
1354 make an intelligent decision whether to insert a blank line or not.
1356 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1357 the setting here is ignored and no empty line is inserted to avoid breaking
1358 the list structure."
1371 "Hook being run after inserting a new heading."
1377 This currently only means they are never auto-wrapped.
1378 When nil, such lines will be treated like ordinary lines.
1379 See also the QUOTE keyword."
1384 "Non-nil means typing characters in `org-goto' starts incremental search.
1385 When nil, you can use these keybindings to navigate the buffer:
1387 q Quit the org-goto interface
1388 n Go to the next visible heading
1389 p Go to the previous visible heading
1390 f Go one heading forward on same level
1391 b Go one heading backward on same level
1392 u Go one heading up"
1397 "Options concerning sparse trees in Org-mode."
1402 "Non-nil means highlight all matches that define a sparse tree.
1403 The highlights will automatically disappear the next time the buffer is
1404 changed by an edit command."
1409 "Non-nil means any change to the buffer will remove temporary highlights.
1410 Such highlights are created by `org-occur' and `org-clock-display'.
1411 When nil, `C-c C-c needs to be used to get rid of the highlights.
1412 The highlights created by `org-preview-latex-fragment' always need
1413 `C-c C-c' to be removed."
1420 "Hook that is run after `org-occur' has constructed a sparse tree.
1421 This can be used to recenter the window to show as much of the structure
1422 as possible."
1427 "Options concerning imenu and speedbar in Org-mode."
1432 "The maximum level for Imenu access to Org-mode headlines.
1433 This also applied for speedbar access."
1438 "Options concerning tables in Org-mode."
1444 When nil, such lines will be treated like ordinary lines.
1446 When equal to the symbol `optimized', the table editor will be optimized to
1447 do the following:
1448 - Automatic overwrite mode in front of whitespace in table fields.
1449 This makes the structure of the table stay in tact as long as the edited
1450 field does not exceed the column width.
1451 - Minimize the number of realigns. Normally, the table is aligned each time
1452 TAB or RET are pressed to move to another field. With optimization this
1453 happens only if changes to a field might have changed the column width.
1454 Optimization requires replacing the functions `self-insert-command',
1455 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1456 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1457 very good at guessing when a re-align will be necessary, but you can always
1460 If you would like to use the optimized version in Org-mode, but the
1461 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1463 This variable can be used to turn on and off the table editor during a session,
1464 but in order to toggle optimization, a restart is required.
1466 See also the variable `org-table-auto-blank-field'."
1475 "Non-nil means cluster self-insert commands for undo when possible.
1476 If this is set, then, like in the Emacs command loop, 20 consecutive
1477 characters will be undone together.
1478 This is configurable, because there is some impact on typing performance."
1483 "Non-nil means TAB will automatically notice a table.el table.
1484 When it sees such a table, it moves point into it and - if necessary -
1485 calls `table-recognize-table'."
1490 "Options concerning links in Org-mode."
1495 "Buffer-local version of `org-link-abbrev-alist', which see.
1500 "Alist of link abbreviations.
1501 The car of each element is a string, to be replaced at the start of a link.
1503 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1505 [[linkkey:tag][description]]
1507 The 'linkkey' must be a word word, starting with a letter, followed
1508 by letters, numbers, '-' or '_'.
1510 If REPLACE is a string, the tag will simply be appended to create the link.
1513 at that point (see the function `url-hexify-string'). If the string contains
1515 be invoked: this function takes the tag as its only argument and must return
1516 a string.
1518 REPLACE may also be a function that will be called with the tag as the
1519 only argument to create the link, which should be returned as a string.
1521 See the manual for examples."
1531 "Non-nil means Org will display descriptive links.
1532 E.g. [[http://orgmode.org][Org website]] will be displayed as
1534 description. When set to `nil', Org will display the full links
1535 literally.
1537 You can interactively set the value of this variable by calling
1538 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1543 "How the path name in file links should be stored.
1544 Valid values are:
1546 relative Relative to the current directory, i.e. the directory of the file
1547 into which the link is being inserted.
1548 absolute Absolute path, if possible with ~ for home directory.
1549 noabbrev Absolute path, no abbreviation of home directory.
1550 adaptive Use relative path for files in the current directory and sub-
1551 directories of it. For other files, use an absolute path."
1560 "Types of links that should be activated in Org-mode files.
1561 This is a list of symbols, each leading to the activation of a certain link
1562 type. In principle, it does not hurt to turn on most link types - there may
1563 be a small gain when turning off unused link types. The types are:
1565 bracket The recommended [[link][description]] or [[link]] links with hiding.
1566 angle Links in angular brackets that may contain whitespace like
1567 <bbdb:Carsten Dominik>.
1568 plain Plain links in normal text, no whitespace, like http://google.com.
1569 radio Text that is matched by a radio target, see manual for details.
1570 tag Tag settings in a headline (link to tag search).
1571 date Time stamps (link to calendar).
1572 footnote Footnote labels.
1574 Changing this variable requires a restart of Emacs to become effective."
1586 "Function to use for generating link descriptions from links.
1587 When nil, the link location will be used. This function must take
1588 two parameters: the first one is the link, the second one is the
1589 description generated by `org-insert-link'. The function should
1590 return the description to use."
1595 "Options concerning storing links in Org-mode."
1600 "When non-nil, hexify URL when creating a link."
1606 "Format of the description part of a link to an email or usenet message.
1607 The following %-escapes will be replaced by corresponding information:
1615 %s subject
1616 %d date
1617 %m message-id.
1619 You may use normal field width specification between the % and the letter.
1620 This is for example useful to limit the length of the subject.
1634 It should match if the message is from the user him/herself."
1639 "Non-nil means file links from `org-store-link' contain context.
1640 A search string will be added to the file name with :: as separator and
1641 used to find the context when the link is activated by the command
1642 `org-open-at-point'. When this option is t, the entire active region
1643 will be placed in the search string of the file link. If set to a
1644 positive integer, only the first n lines of context will be stored.
1647 negates this setting for the duration of the command."
1652 "Non-nil means keep link in list for entire session.
1654 The command `org-store-link' adds a link pointing to the current
1655 location to an internal list. These links accumulate during a session.
1656 The command `org-insert-link' can be used to insert links into any
1657 Org-mode file (offering completion for all stored links). When this
1659 will be removed from the list, to make completing the unused links
1660 more efficient."
1665 "Options concerning following links in Org-mode."
1670 "Function to translate links with different syntax to Org syntax.
1671 This can be used to translate links created for example by the Planner
1672 or emacs-wiki packages to Org syntax.
1673 The function must accept two parameters, a TYPE containing the link
1675 which is everything after the link protocol. It should return a cons
1676 with possibly modified values of type and path.
1677 Org contains a function for this, so if you set this variable to
1678 `org-translate-link-from-planner', you should be able follow many
1679 links created by planner."
1684 "Hook that is run after a link has been followed."
1689 "Non-nil means on links TAB will follow the link.
1690 Needs to be set before org.el is loaded.
1691 This really should not be used, it does not make sense, and the
1692 implementation is bad."
1697 "Non-nil means on links RET will follow the link.
1698 In tables, the special behavior of RET has precedence."
1704 "Non-nil means mouse-1 on a link will follow the link.
1705 A longer mouse click will still set point. Does not work on XEmacs.
1706 Needs to be set before org.el is loaded."
1711 "Number of different positions to be recorded in the ring.
1712 Changing this requires a restart of Emacs to work correctly."
1717 "Non-nil means internal links in Org files must exactly match a headline.
1718 When nil, the link search tries to match a phrase with all words
1719 in the search text."
1726 query-to-create)))
1734 "Setup the frame configuration for following links.
1735 When following a link with Emacs, it may often be useful to display
1736 this link in another window or frame. This variable can be used to
1737 set this up for the different types of links.
1738 For VM, use any of
1739 `vm-visit-folder'
1740 `vm-visit-folder-other-window'
1741 `vm-visit-folder-other-frame'
1742 For Gnus, use any of
1743 `gnus'
1744 `gnus-other-frame'
1745 `org-gnus-no-new-news'
1746 For FILE, use any of
1747 `find-file'
1748 `find-file-other-window'
1749 `find-file-other-frame'
1750 For Wanderlust use any of
1751 `wl'
1752 `wl-other-frame'
1753 For the calendar, use the variable `calendar-setup'.
1754 For BBDB, it is currently only possible to display the matches in
1755 another window."
1779 "Non-nil means use indirect buffer to display infile links.
1780 Activating internal links (from one location in a file to another location
1781 in the same file) normally just jumps to the location. When the link is
1783 is displayed in
1784 another window. When this option is set, the other window actually displays
1785 an indirect buffer clone of the current buffer, to avoid any visibility
1786 changes to the current buffer."
1791 "Non-nil means `org-open-file' will open non-existing files.
1792 When nil, an error will be generated.
1793 This variable applies only to external applications because they
1794 might choke on non-existing files. If the link is to a file that
1795 will be opened in Emacs, the variable is ignored."
1800 "Non-nil means a link to a directory really means to index.org.
1801 When nil, following a directory link will run dired or open a finder/explorer
1802 window on that directory."
1807 "Function and arguments to call for following mailto links.
1808 This is a list with the first element being a Lisp function, and the
1809 remaining elements being arguments to the function. In string arguments,
1810 %a will be replaced by the address, and %s will be replaced by the subject
1811 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1820 "Non-nil means ask for confirmation before executing shell links.
1821 Shell links can be dangerous: just think about a link
1823 [[shell:rm -rf ~/*][Google Search]]
1826 but really it would remove your entire home directory.
1827 Therefore we advise against setting this variable to nil.
1828 Just change it to `y-or-n-p' if you want to confirm with a
1836 'safe-local-variable
1840 "A regexp to skip confirmation for shell links."
1846 "Non-nil means ask for confirmation before executing Emacs Lisp links.
1847 Elisp links can be dangerous: just think about a link
1852 but really it would remove your entire home directory.
1853 Therefore we advise against setting this variable to nil.
1854 Just change it to `y-or-n-p' if you want to confirm with a
1862 'safe-local-variable
1866 "A regexp to skip confirmation for Elisp links."
1875 "Default file applications on a UNIX or GNU/Linux system.
1886 "Default file applications on a MacOS X system.
1888 for some files for which the OS does not have a good default.
1896 'mswindows-shell-execute
1901 'mswindows-shell-execute
1904 "Default file applications on a Windows NT system.
1909 '(
1914 )
1915 "External applications for opening `file:path' items in a document.
1916 Org-mode uses system defaults for different file types, but
1917 you can use this variable to set the application for a given file
1918 extension. The entries in this list are cons cells where the car identifies
1919 files and the cdr the corresponding command. Possible values for the
1920 file identifier are
1922 ways, depending on its contents:
1924 - Alphanumeric characters only:
1925 Match links with this file extension.
1927 to open PDFs with evince.
1929 - Regular expression: Match links where the
1930 filename matches the regexp. If you want to
1931 use groups here, use shy groups.
1935 to open *.html and *.xhtml with firefox.
1937 - Regular expression which contains (non-shy) groups:
1939 anything after that, matches the regexp.
1940 In a custom command string, %1, %2, etc. are replaced with
1941 the parts of the link that were matched by the groups.
1942 For backwards compatibility, if a command string is given
1943 that does not use any of the group matches, this case is
1944 handled identically to the second one (i.e. match against
1945 file name only).
1946 In a custom lisp form, you can access the group matches with
1947 (match-string n link).
1950 to open [[file:document.pdf::5]] with evince at page 5.
1952 `directory' Matches a directory
1953 `remote' Matches a remote file, accessible through tramp or efs.
1954 Remote files most likely should be visited through Emacs
1955 because external applications cannot handle such paths.
1956 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
1957 so all files Emacs knows how to handle. Using this with
1958 command `emacs' will open most files in Emacs. Beware that this
1959 will also open html files inside Emacs, unless you add
1961 t Default for files not matched by any of the other options.
1962 `system' The system command to open files, like `open' on Windows
1963 and Mac OS X, and mailcap under GNU/Linux. This is the command
1964 that will be selected if you call `C-c C-o' with a double
1967 Possible values for the command are:
1968 `emacs' The file will be visited by the current Emacs process.
1969 `default' Use the default application for this file type, which is the
1970 association for t in the list, most likely in the system-specific
1971 part.
1972 This can be used to overrule an unwanted setting in the
1973 system-specific variable.
1975 This command is specified by the entry whose car is `system'.
1976 Most likely, the system-specific version of this variable
1977 does define this command, but you can overrule/replace it
1978 here.
1979 string A command to be executed by a shell; %s will be replaced
1980 by the path to the file.
1981 sexp A Lisp form which will be evaluated. The file path will
1982 be available in the Lisp variable `file'.
1983 For more examples, see the system specific constants
1984 `org-file-apps-defaults-macosx'
1985 `org-file-apps-defaults-windowsnt'
1986 `org-file-apps-defaults-gnu'."
1996 auto-mode))
2005 "The URL of the DOI server."
2011 "Options concerning refiling entries in Org-mode."
2016 "Directory with org files.
2017 This is just a default location to look for Org files. There is no need
2018 at all to put your files into this directory. It is only used in the
2019 following situations:
2021 1. When a capture template specifies a target file that is not an
2022 absolute path. The path will then be interpreted relative to
2023 `org-directory'
2024 2. When a capture note is filed away in an interactive way (when exiting the
2025 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2026 with `org-directory' as the default path."
2033 "Default target for storing notes.
2034 Used as a fall back file for org-remember.el and org-capture.el, for
2035 templates that do not specify a target file."
2041 file))
2044 "The default interface to be used for `org-goto'.
2045 Allowed values are:
2046 outline The interface shows an outline of the relevant file
2047 and the correct heading is found by moving through
2048 the outline or by searching with incremental search.
2049 outline-path-completion Headlines in the current buffer are offered via
2050 completion. This is the interface also used by
2051 the refile command."
2058 "Maximum target level when running `org-goto' with refile interface."
2063 "Non-nil means store new notes at the beginning of a file or entry.
2064 When nil, new notes will be filed to the end of a file or entry.
2065 This can also be a list with cons cells of regular expressions that
2066 are matched against file names, and values."
2077 "Information to record when a task is refiled.
2079 Possible values are:
2081 nil Don't add anything
2082 time Add a time stamp to the task
2083 note Prompt for a note and add it with template `org-log-note-headings'
2085 This option can also be set with on a per-file-basis with
2087 #+STARTUP: nologrefile
2088 #+STARTUP: logrefile
2089 #+STARTUP: lognoterefile
2091 You can have local logging settings for a subtree by setting the LOGGING
2092 property to one or more of these keywords.
2094 When bulk-refiling from the agenda, the value `note' is forbidden and
2095 will temporarily be changed to `time'."
2106 This is a list of cons cells. Each cell contains:
2107 - a specification of the files to be considered, either a list of files,
2108 or a symbol whose function or variable value will be used to retrieve
2109 a file name or a list of file names. If you use `org-agenda-files' for
2110 that, all agenda files will be scanned for targets. Nil means consider
2111 headings in the current buffer.
2112 - A specification of how to find candidate refile targets. This may be
2113 any of:
2115 This tag has to be present in all target headlines, inheritance will
2116 not be considered.
2118 todo keyword.
2120 headlines that are refiling targets.
2121 - a cons cell (:level . N). Any headline of level N is considered a target.
2122 Note that, when `org-odd-levels-only' is set, level corresponds to
2123 order in hierarchy, not to the number of stars.
2124 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2125 Note that, when `org-odd-levels-only' is set, level corresponds to
2126 order in hierarchy, not to the number of stars.
2128 Each element of this list generates a set of possible targets.
2129 The union of these sets is presented (with completion) to
2130 the user by `org-refile'.
2132 You can set the variable `org-refile-target-verify-function' to a function
2133 to verify each headline found by the simple criteria above.
2135 When this variable is nil, all top-level headlines in the current buffer
2136 are used, equivalent to the value `((nil . (:level . 1))'."
2152 "Function to verify if the headline at point should be a refile target.
2153 The function will be called without arguments, with point at the
2154 beginning of the headline. It should return t and leave point
2155 where it is if the headline is a valid target for refiling.
2157 If the target should not be selected, the function must return nil.
2158 In addition to this, it may move point to a place from where the search
2159 should be continued. For example, the function may decide that the entire
2160 subtree of the current entry should be excluded and move point to the end
2161 of the subtree."
2166 "Non-nil means cache refile targets to speed up the process.
2167 The cache for a particular file will be updated automatically when
2168 the buffer has been killed, or when any of the marker used for flagging
2169 refile targets no longer points at a live buffer.
2170 If you have added new entries to a buffer that might themselves be targets,
2171 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2172 find that easier, `C-u C-u C-u C-c C-w'."
2178 "Non-nil means provide refile targets as paths.
2179 So a level 3 headline will be available as level1/level2/level3.
2181 When the value is `file', also include the file name (without directory)
2182 into the path. In this case, you can also stop the completion after
2183 the file name, to get entries inserted as top level in the file.
2185 When `full-file-path', include the full file path."
2194 "Non-nil means complete the outline path in hierarchical steps.
2195 When Org-mode uses the refile interface to select an outline path
2196 \(see variable `org-refile-use-outline-path'), the completion of
2197 the path can be done is a single go, or if can be done in steps down
2198 the headline hierarchy. Going in steps is probably the best if you
2199 do not use a special completion package like `ido' or `icicles'.
2200 However, when using these packages, going in one step can be very
2201 fast, while still showing the whole path to the entry."
2206 "Non-nil means allow to create new nodes as refile targets.
2208 of an existing node. When the value of this variable is `confirm',
2209 new node creation must be confirmed by the user (recommended)
2210 When nil, the completion must match an existing entry.
2212 Note that, if the new heading is not seen by the criteria
2213 listed in `org-refile-targets', multiple instances of the same
2214 heading would be created by trying again to file under the new
2215 heading."
2223 "Non-nil means also refile active region within a subtree.
2225 By default `org-refile' doesn't allow refiling regions if they
2226 don't contain a set of subtrees, but it might be convenient to
2227 do so sometimes: in that case, the first line of the region is
2228 converted to a headline before refiling."
2234 "Options concerning TODO items in Org-mode."
2239 "Options concerning Progress logging in Org-mode."
2246 "The available interpretation symbols for customizing `org-todo-keywords'.
2250 "List of TODO entry keyword sequences and their interpretation.
2253 Each sequence starts with a symbol, either `sequence' or `type',
2254 indicating if the keywords should be interpreted as a sequence of
2255 action steps, or as different types of TODO items. The first
2256 keywords are states requiring action - these states will select a headline
2257 for inclusion into the global TODO list Org-mode produces. If one of
2260 the last keyword is treated as the only DONE state of the sequence.
2263 additional state where no keyword is present. For details about this
2264 cycling, see the manual.
2266 TODO keywords and interpretation can also be set on a per-file basis with
2267 the special #+SEQ_TODO and #+TYP_TODO lines.
2269 Each keyword can optionally specify a character for fast state selection
2270 \(in combination with the variable `org-use-fast-todo-selection')
2271 and specifiers for state change logging, using the same syntax that
2274 indicates to record a time stamp each time this state is selected.
2276 Each keyword may also specify if a timestamp or a note should be
2277 recorded when entering or leaving the state, by adding additional
2278 characters in the parenthesis after the keyword. This looks like this:
2280 record only the time of the state change. With X and Y being either
2282 Y when leaving the state if and only if the *target* state does not
2283 define X. You may omit any of the fast-selection key or X or /Y,
2284 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2286 For backward compatibility, this variable may also be just a list
2287 of keywords. In this case the interpretation (sequence or type) will be
2288 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2298 ;;Quick and dirty way to see
2299 ;;`org-todo-interpretations'. This takes the
2300 ;;place of item arguments
2301 :convert-widget
2308 org-todo-interpretation-widgets))
2309 widget))
2345 "Controls how TODO keywords are interpreted.
2346 This variable is in principle obsolete and is only used for
2347 backward compatibility, if the interpretation of todo keywords is
2348 not given already in `org-todo-keywords'. See that variable for
2349 more information."
2356 "Non-nil means use the fast todo selection scheme with C-c C-t.
2357 This variable describes if and under what circumstances the cycling
2358 mechanism for TODO keywords will be replaced by a single-key, direct
2359 selection scheme.
2361 When nil, fast selection is never used.
2363 When the symbol `prefix', it will be used when `org-todo' is called
2364 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2365 `C-u t' in an agenda buffer.
2367 When t, fast selection is used by default. In this case, the prefix
2368 argument forces cycling instead.
2370 In all cases, the special interface is only used if access keys have
2371 actually been assigned by the user, i.e. if keywords in the configuration
2372 are followed by a letter in parenthesis, like TODO(t)."
2380 "Non-nil means update todo statistics after insert and toggle.
2381 ALL-HEADLINES means update todo statistics by including headlines
2382 with no TODO keyword as well, counting them as not done.
2383 A list of TODO keywords means the same, but skip keywords that are
2384 not in this list.
2386 When this is set, todo statistics is updated in the parent of the
2387 current entry each time a todo state is changed."
2397 "Non-nil means TODO statistics covers just direct children.
2398 When nil, all entries in the subtree are considered.
2399 This has only an effect if `org-provide-todo-statistics' is set.
2400 To set this to nil for only a single subtree, use a COOKIE_DATA
2406 "Hook which is run after the state of a TODO item was changed.
2407 The new state (a string with a TODO keyword, or nil) is available in the
2408 Lisp variable `org-state'."
2413 "Hook for functions that are allowed to block a state change.
2415 Functions in this hook should not modify the buffer.
2416 Each function gets as its single argument a property list,
2417 see `org-trigger-hook' for more information about this list.
2419 If any of the functions in this hook returns nil, the state change
2423 "Hook for functions that are triggered by a state change.
2425 Each function gets as its single argument a property list with at
2426 least the following elements:
2428 (:type type-of-change :position pos-at-entry-start
2429 :from old-state :to new-state)
2431 Depending on the type, more properties may be present.
2433 This mechanism is currently implemented for:
2435 TODO state changes
2436 ------------------
2437 :type todo-state-change
2438 :from previous state (keyword as a string), or nil, or a symbol
2439 'todo' or 'done', to indicate the general type of state.
2443 "Non-nil means undone TODO entries will block switching the parent to DONE.
2444 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2445 be blocked if any prior sibling is not yet done.
2446 Finally, if the parent is blocked because of ordered siblings of its own,
2447 the child will also be blocked."
2459 "Non-nil means unchecked boxes will block switching the parent to DONE.
2460 When this is nil, checkboxes have no influence on switching TODO states.
2461 When non-nil, you first need to check off all check boxes before the TODO
2462 entry can be switched to DONE.
2463 This variable needs to be set before org.el is loaded, and you need to
2464 restart Emacs after a change to make the change effective. The only way
2465 to change is while Emacs is running is through the customize interface."
2477 "Non-nil means inserting a TODO heading is treated as state change.
2479 logging will apply if appropriate. When nil, the new TODO item will
2480 be inserted directly, and no logging will take place."
2485 "Non-nil means switching TODO states with S-cursor counts as state change.
2486 This is the default behavior. However, setting this to nil allows a
2487 convenient way to select a TODO state and bypass any logging associated
2488 with that."
2493 "Tag changes that should be triggered by TODO state changes.
2494 This is a list. Each entry is
2496 (state-change (tag . flag) .......)
2498 State-change can be a string with a state, and empty string to indicate the
2499 state that has no TODO keyword, or it can be one of the symbols `todo'
2500 or `done', meaning any not-done or done state, respectively."
2514 "Information to record when a task moves to the DONE state.
2516 Possible values are:
2518 nil Don't add anything, just change the keyword
2519 time Add a time stamp to the task
2520 note Prompt for a note and add it with template `org-log-note-headings'
2522 This option can also be set with on a per-file-basis with
2524 #+STARTUP: nologdone
2525 #+STARTUP: logdone
2526 #+STARTUP: lognotedone
2528 You can have local logging settings for a subtree by setting the LOGGING
2529 property to one or more of these keywords."
2537 ;; Normalize old uses of org-log-done.
2544 "Information to record when the scheduling date of a tasks is modified.
2546 Possible values are:
2548 nil Don't add anything, just change the date
2549 time Add a time stamp to the task
2550 note Prompt for a note and add it with template `org-log-note-headings'
2552 This option can also be set with on a per-file-basis with
2554 #+STARTUP: nologreschedule
2555 #+STARTUP: logreschedule
2556 #+STARTUP: lognotereschedule"
2565 "Information to record when the deadline date of a tasks is modified.
2567 Possible values are:
2569 nil Don't add anything, just change the date
2570 time Add a time stamp to the task
2571 note Prompt for a note and add it with template `org-log-note-headings'
2573 This option can also be set with on a per-file-basis with
2575 #+STARTUP: nologredeadline
2576 #+STARTUP: logredeadline
2577 #+STARTUP: lognoteredeadline
2579 You can have local logging settings for a subtree by setting the LOGGING
2580 property to one or more of these keywords."
2589 "Non-nil means record a note when clocking out of an item.
2590 This can also be configured on a per-file basis by adding one of
2591 the following lines anywhere in the buffer:
2593 #+STARTUP: lognoteclock-out
2594 #+STARTUP: nolognoteclock-out"
2600 "Non-nil means the CLOSED time stamp will contain date and time.
2601 When nil, only the date will be recorded."
2615 "Headings for notes added to entries.
2616 The value is an alist, with the car being a symbol indicating the note
2617 context, and the cdr is the heading to be used. The heading may also be the
2618 empty string.
2619 %t in the heading will be replaced by a time stamp.
2620 %T will be an active time stamp instead the default inactive one
2621 %d will be replaced by a short-format time stamp.
2622 %D will be replaced by an active short-format time stamp.
2623 %s will be replaced by the new TODO state, in double quotes.
2624 %S will be replaced by the old TODO state, in double quotes.
2625 %u will be replaced by the user name.
2626 %U will be replaced by the full user name.
2628 In fact, it is not a good idea to change the `state' entry, because
2629 agenda log mode depends on the format of these entries."
2635 "Heading when changing todo state (todo sequence only)"
2649 "Non-nil means insert state change notes and time stamps into a drawer.
2650 When nil, state changes notes will be inserted after the headline and
2651 any scheduling and clock lines, but not inside a drawer.
2653 The value of this variable should be the name of the drawer to use.
2654 LOGBOOK is proposed as the default drawer for this purpose, you can
2655 also set this to a string to define the drawer of your choice.
2659 A value of t or nil can also be set with on a per-file-basis with
2661 #+STARTUP: logdrawer
2662 #+STARTUP: nologdrawer
2664 If this variable is set, `org-log-state-notes-insert-after-drawers'
2665 will be ignored.
2667 You can set the property LOG_INTO_DRAWER to overrule this setting for
2668 a subtree."
2679 "Return the value of `org-log-into-drawer', but let properties overrule.
2680 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2681 used instead of the default value."
2690 "Non-nil means insert state change notes after any drawers in entry.
2691 Only the drawers that *immediately* follow the headline and the
2692 deadline/scheduled line are skipped.
2693 When nil, insert notes right after the heading and perhaps the line
2694 with deadline/scheduling if present.
2696 This variable will have no effect if `org-log-into-drawer' is
2697 set."
2703 "Non-nil means the latest state note will be directly after heading.
2704 When nil, the state change notes will be ordered according to time.
2706 This option can also be set with on a per-file-basis with
2708 #+STARTUP: logstatesreversed
2709 #+STARTUP: nologstatesreversed"
2715 "The TODO state to which a repeater should return the repeating task.
2716 By default this is the first task in a TODO sequence, or the previous state
2717 in a TODO_TYP set. But you can specify another task here.
2718 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2725 "Non-nil means record moving through the DONE state when triggering repeat.
2726 An auto-repeating task is immediately switched back to TODO when
2729 record a closing note, there will be no record of the task moving
2730 through DONE. This variable forces taking a note anyway.
2732 nil Don't force a record
2733 time Record a time stamp
2734 note Prompt for a note and add it with template `org-log-note-headings'
2736 This option can also be set with on a per-file-basis with
2738 #+STARTUP: nologrepeat
2739 #+STARTUP: logrepeat
2740 #+STARTUP: lognoterepeat
2742 You can have local logging settings for a subtree by setting the LOGGING
2743 property to one or more of these keywords."
2753 "Priorities in Org-mode."
2758 "Non-nil means priority commands are active.
2759 When nil, these commands will be disabled, so that you never accidentally
2760 set a priority."
2765 "The highest priority of TODO items. A character like ?A, ?B etc.
2766 Must have a smaller ASCII number than `org-lowest-priority'."
2771 "The lowest priority of TODO items. A character like ?A, ?B etc.
2772 Must have a larger ASCII number than `org-highest-priority'."
2777 "The default priority of TODO items.
2778 This is the priority an item gets if no explicit priority is given.
2779 When starting to cycle on an empty priority the first step in the cycle
2780 depends on `org-priority-start-cycle-with-default'. The resulting first
2781 step priority must not exceed the range from `org-highest-priority' to
2782 `org-lowest-priority' which means that `org-default-priority' has to be
2783 in this range exclusive or inclusive the range boundaries. Else the
2784 first step refuses to set the default and the second will fall back
2785 to (depending on the command used) the highest or lowest priority."
2790 "Non-nil means start with default priority when starting to cycle.
2791 When this is nil, the first step in the cycle will be (depending on the
2792 command used) one higher or lower than the default priority.
2793 See also `org-default-priority'."
2798 "Function to extract the priority from a string.
2799 The string is normally the headline. If this is nil Org computes the
2800 priority from the priority cookie like [#A] in the headline. It returns
2801 an integer, increasing by 1000 for each priority level.
2802 The user can set a different function here, which should take a string
2803 as an argument and return the numeric priority."
2809 "Options concerning time stamps and deadlines in Org-mode."
2814 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2815 When nil, these labeled time stamps are forces into the second line of an
2816 entry, just after the headline. When scheduling from the global TODO list,
2817 the time stamp will always be forced into the second line."
2822 "Formats for `format-time-string' which are used for time stamps.
2826 "Number of minutes to round time stamps to.
2827 These are two values, the first applies when first creating a time stamp.
2828 The second applies when changing it with the commands `S-up' and `S-down'.
2829 When changing the time stamp, this means that it will change in steps
2830 of N minutes, as given by the second value.
2832 When a setting is 0 or 1, insert the time unmodified. Useful rounding
2833 numbers should be factors of 60, so for example 5, 10, 15.
2835 When this is larger than 1, you can still force an exact time stamp by using
2836 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2837 and by using a prefix arg to `S-up/down' to specify the exact number
2838 of minutes to shift."
2848 ;; Normalize old customizations of this variable.
2852 org-time-stamp-rounding-minutes)))
2855 "Non-nil means overlay custom formats over all time stamps.
2856 The formats are defined through the variable `org-time-stamp-custom-formats'.
2857 To turn this on on a per-file basis, insert anywhere in the file:
2858 #+STARTUP: customtime"
2866 "Custom formats for time stamps. See `format-time-string' for the syntax.
2867 These are overlaid over the default ISO format if the variable
2868 `org-display-custom-times' is set. Time like %H:%M should be at the
2869 end of the second format. The custom formats are also honored by export
2870 commands, if custom time display is turned on at the time of export."
2875 "Get the right format for a time string."
2880 f)))
2884 "The format string used when creating CLOCKSUM lines.
2885 This is also used when Org mode generates a time duration.
2887 The value can be a single format string containing two
2888 %-sequences, which will be filled with the number of hours and
2889 minutes in that order.
2891 Alternatively, the value can be a plist associating any of the
2892 keys :years, :months, :weeks, :days, :hours or :minutes with
2893 format strings. The time duration is formatted using only the
2894 time components that are needed and concatenating the results.
2895 If a time unit in absent, it falls back to the next smallest
2896 unit.
2898 The keys :require-years, :require-months, :require-days,
2899 :require-weeks, :require-hours, :require-minutes are also
2900 meaningful. A non-nil value for these keys indicates that the
2901 corresponding time component should always be included, even if
2902 its value is 0.
2905 For example,
2908 :require-minutes t)
2910 means durations longer than a day will be expressed in days,
2911 hours and minutes, and durations less than a day will always be
2912 expressed in hours and minutes (even for durations less than an
2913 hour).
2915 The value
2919 means durations longer than a day will be expressed in days and
2920 minutes, and durations less than a day will be expressed entirely
2921 in minutes (even for durations longer than an hour)."
2961 See `org-time-clocksum-format' for more on time clock formats."
2969 E.g. by default, one day is considered to be a 8 hours effort,
2970 so a task that has been clocked for 16 hours will be displayed
2971 as during 2 days in the clock display or in the clocktable.
2973 See `org-effort-durations' on how to set effort durations
2974 and `org-time-clocksum-format' for more on time clock formats."
2982 "The format string used when creating CLOCKSUM lines,
2983 or when Org mode generates a time duration, if
2984 `org-time-clocksum-use-fractional' is enabled.
2986 The value can be a single format string containing one
2987 %-sequence, which will be filled with the number of hours as
2988 a float.
2990 Alternatively, the value can be a plist associating any of the
2991 keys :years, :months, :weeks, :days, :hours or :minutes with
2992 a format string. The time duration is formatted using the
2993 largest time unit which gives a non-zero integer part. If all
2994 specified formats have zero integer part, the smallest time unit
2995 is used."
3012 "Number of days before expiration during which a deadline becomes active.
3013 This variable governs the display in sparse trees and in the agenda.
3014 When 0 or negative, it means use this number (the absolute value of it)
3015 even if a deadline has a different individual lead time specified.
3017 Custom commands can set this variable in the options section."
3023 "Number of days before a scheduled item becomes active.
3024 This variable governs the display in sparse trees and in the agenda.
3025 The default value (i.e. 0) means: don't delay scheduled item.
3026 When negative, it means use this number (the absolute value of it)
3027 even if a scheduled item has a different individual delay time
3028 specified.
3030 Custom commands can set this variable in the options section."
3038 "Non-nil means assume future for incomplete date input from user.
3039 This affects the following situations:
3040 1. The user gives a month but not a year.
3043 2. The user gives a day, but no month.
3046 it will be considered as *this* month.
3048 If you set this variable to the symbol `time', then also the following
3049 will work:
3051 3. If the user gives a time.
3052 If the time is before now, it will be interpreted as tomorrow.
3054 Currently none of this works for ISO week specifications.
3056 When this option is nil, the current day, month and year will always be
3057 used as defaults.
3059 See also `org-agenda-jump-prefer-future'."
3067 "Should the agenda jump command prefer the future for incomplete dates?
3068 The default is to do the same as configured in `org-read-date-prefer-future'.
3069 But you can also set a deviating value here.
3070 This may t or nil, or the symbol `org-read-date-prefer-future'."
3076 org-read-date-prefer-future)
3081 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3083 Depending on the system Emacs is running on, certain dates cannot
3084 be represented with the type used internally to represent time.
3085 Dates between 1970-1-1 and 2038-1-1 can always be represented
3086 correctly. Some systems allow for earlier dates, some for later,
3087 some for both. One way to find out it to insert any date into an
3088 Org buffer, putting the cursor on the year and hitting S-up and
3089 S-down to test the range.
3091 When this variable is set to t, the date/time prompt will not let
3092 you specify dates outside the 1970-2037 range, so it is certain that
3093 these dates will work in whatever version of Emacs you are
3094 running, and also that you can move a file from one Emacs implementation
3095 to another. WHenever Org is forcing the year for you, it will display
3096 a message and beep.
3098 When this variable is nil, Org will check if the date is
3099 representable in the specific Emacs implementation you are using.
3100 If not, it will force a year, usually the current year, and beep
3101 to remind you. Currently this setting is not recommended because
3102 the likelihood that you will open your Org files in an Emacs that
3103 has limited date range is not negligible.
3105 A workaround for this problem is to use diary sexp dates for time
3106 stamps outside of this range."
3112 "Non-nil means display current interpretation of date prompt live.
3113 This display will be in an overlay, in the minibuffer."
3118 "Non-nil means pop up a calendar when prompting for a date.
3119 In the calendar, the date can be selected with mouse-1. However, the
3120 minibuffer will also be active, and you can simply enter the date as well.
3121 When nil, only the minibuffer will be available."
3128 'org-read-date-minibuffer-setup-hook
3131 "Hook to be used to set up keys for the date/time interface.
3132 Add key definitions to `minibuffer-local-map', which will be a
3133 temporary copy.
3135 WARNING: This option is obsolete, you should use
3136 `org-read-date-minibuffer-local-map' to set up keys."
3141 "The hour when your day really ends. Must be an integer.
3142 This has influence for the following applications:
3144 the time given here, the day recognized as TODAY is actually yesterday.
3145 - When a date is read from the user and it is still before the time given
3146 here, the current date and time will be assumed to be yesterday, 23:59.
3147 Also, timestamps inserted in capture templates follow this rule.
3149 IMPORTANT: This is a feature whose implementation is and likely will
3150 remain incomplete. Really, it is only here because past midnight seems to
3151 be the favorite working time of John Wiegley :-)"
3156 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3157 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3159 23:59 of the previous day."
3165 "When non-nil, use the last clock out time for `org-todo'.
3166 Note that this option has precedence over the combined use of
3167 `org-use-effective-time' and `org-extend-today-until'."
3174 "Non-nil means S-down will increase the time in a time stamp.
3175 When nil, S-up will increase."
3180 "Non-nil means make the calendar window follow timestamp changes.
3181 When a timestamp is modified and the calendar window is visible, it will be
3182 moved to the new date."
3187 "Options concerning tags in Org-mode."
3192 "List of tags allowed in Org-mode files.
3193 When this list is nil, Org-mode will base TAG input on what is already in the
3194 buffer.
3195 The value of this variable is an alist, the car of each entry must be a
3196 keyword as a string, the cdr may be a character that is used to select
3197 that tag through the fast-tag-selection interface.
3198 See the manual for details."
3215 "List of tags that will always appear in all Org-mode files.
3216 This is in addition to any in buffer settings or customizations
3217 of `org-tag-alist'.
3218 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3219 The value of this variable is an alist, the car of each entry must be a
3220 keyword as a string, the cdr may be a character that is used to select
3221 that tag through the fast-tag-selection interface.
3222 See the manual for details.
3223 To disable these tags on a per-file basis, insert anywhere in the file:
3224 #+STARTUP: noptag"
3236 "If non-nil, always offer completion for all tags of all agenda files.
3237 Instead of customizing this variable directly, you might want to
3238 set it locally for capture buffers, because there no list of
3239 tags in that file can be created dynamically (there are none).
3241 (add-hook 'org-capture-mode-hook
3242 (lambda ()
3243 (set (make-local-variable
3244 'org-complete-tags-always-offer-all-agenda-tags)
3245 t)))"
3251 "List of tags that can be inherited by all entries in the file.
3252 The tags will be inherited if the variable `org-use-tag-inheritance'
3253 says they should be.
3257 "Non-nil means use fast tag selection scheme.
3258 This is a special interface to select and deselect tags with single keys.
3259 When nil, fast selection is never used.
3260 When the symbol `auto', fast selection is used if and only if selection
3261 characters for tags have been configured, either through the variable
3262 `org-tag-alist' or through a #+TAGS line in the buffer.
3263 When t, fast selection is always used and selection keys are assigned
3264 automatically if necessary."
3272 "Non-nil means fast tag selection exits after first change.
3273 When nil, you have to press RET to exit it.
3274 During fast tag selection, you can toggle this flag with `C-c'.
3275 This variable can also have the value `expert'. In this case, the window
3276 displaying the tags menu is not even shown, until you press C-c again."
3284 "Non-nil means fast tags selection interface will also offer TODO states.
3288 "The column to which tags should be indented in a headline.
3289 If this number is positive, it specifies the column. If it is negative,
3290 it means that the tags should be flushright to that column. For example,
3291 -80 works well for a normal 80 character screen.
3292 When 0, place tags directly after headline text, with only one space in
3293 between."
3298 "Non-nil keeps tags aligned when modifying headlines.
3299 Some operations (i.e. demoting) change the length of a headline and
3300 therefore shift the tags around. With this option turned on, after
3301 each such operation the tags are again aligned to `org-tags-column'."
3306 "Non-nil means tags in levels apply also for sublevels.
3307 When nil, only the tags directly given in a specific line apply there.
3308 This may also be a list of tags that should be inherited, or a regexp that
3309 matches tags that should be inherited. Additional control is possible
3310 with the variable `org-tags-exclude-from-inheritance' which gives an
3311 explicit list of tags to be excluded from inheritance, even if the value of
3312 `org-use-tag-inheritance' would select it for inheritance.
3314 If this option is t, a match early-on in a tree can lead to a large
3315 number of matches in the subtree when constructing the agenda or creating
3316 a sparse tree. If you only want to see the first match in a tree during
3317 a search, check out the variable `org-tags-match-list-sublevels'."
3326 "List of tags that should never be inherited.
3327 This is a way to exclude a few tags from inheritance. For way to do
3328 the opposite, to actively allow inheritance for selected tags,
3329 see the variable `org-use-tag-inheritance'."
3334 "Check if TAG is one that should be inherited."
3346 "Non-nil means list also sublevels of headlines matching a search.
3347 This variable applies to tags/property searches, and also to stuck
3348 projects because this search is based on a tags match as well.
3350 When set to the symbol `indented', sublevels are indented with
3351 leading dots.
3353 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3354 the sublevels of a headline matching a tag search often also match
3355 the same search. Listing all of them can create very long lists.
3356 Setting this variable to nil causes subtrees of a match to be skipped.
3358 This variable is semi-obsolete and probably should always be true. It
3359 is better to limit inheritance to certain tags using the variables
3360 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3368 "When set, tags are sorted using this function as a comparator."
3384 "Options concerning properties in Org-mode."
3389 "How property key/value pairs should be formatted by `indent-line'.
3390 When `indent-line' hits a property definition, it will format the line
3391 according to this format, mainly to make sure that the values are
3392 lined-up with respect to each other."
3397 "Alist of properties and functions to adjust inserted values.
3398 Elements of this alist must be of the form
3400 ([string] [function])
3402 where [string] must be a property name and [function] must be a
3403 lambda expression: this lambda expression must take one argument,
3404 the value to adjust, and return the new value as a string.
3408 and the clock summary:
3411 (let ((clocksum (org-clock-sum-current-item))
3412 (effort (org-duration-string-to-minutes
3414 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3421 "Non-nil means properties apply also for sublevels.
3423 This setting is chiefly used during property searches. Turning it on can
3424 cause significant overhead when doing a search, which is why it is not
3425 on by default.
3427 When nil, only the properties directly given in the current entry count.
3428 When t, every property is inherited. The value may also be a list of
3429 properties that should have inheritance, or a regular expression matching
3430 properties that should be inherited.
3432 However, note that some special properties use inheritance under special
3433 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3435 for valid values of a property.
3437 Note for programmers:
3438 When querying an entry with `org-entry-get', you can control if inheritance
3439 should be used. By default, `org-entry-get' looks only at the local
3440 properties. You can request inheritance by setting the inherit argument
3441 to t (to force inheritance) or to `selective' (to respect the setting
3442 in this variable)."
3451 "Check if PROPERTY is one that should be inherited."
3462 "The default column format, if no other format has been defined.
3463 This variable can be set on the per-file basis by inserting a line
3465 #+COLUMNS: %25ITEM ....."
3470 "The ellipses to be used when a field in column view is truncated.
3471 When this is the empty string, as many characters as possible are shown,
3472 but then there will be no visual indication that the field has been truncated.
3473 When this is a string of length N, the last N characters of a truncated
3474 field are replaced by this string. If the column is narrower than the
3475 ellipses string, only part of the ellipses string will be shown."
3480 "Function that modifies values for display in column view.
3481 For example, it can be used to cut out a certain part from a time stamp.
3482 The function must take 2 arguments:
3484 column-title The title of the column (*not* the property name)
3485 value The value that should be modified.
3487 The function should return the value that should be displayed,
3488 or nil if the normal value should be used."
3493 "The property that is being used to keep track of effort estimates.
3494 Effort estimates given in this property need to have the format H:MM."
3502 "List of property/value pairs that can be inherited by any entry.
3504 These are fixed values, for the preset properties. The user variable
3505 that can be used to add to this list is `org-global-properties'.
3507 The entries in this list are cons cells where the car is a property
3508 name and cdr is a string with the value. If the value represents
3513 "List of property/value pairs that can be inherited by any entry.
3515 This list will be combined with the constant `org-global-properties-fixed'.
3517 The entries in this list are cons cells where the car is a property
3518 name and cdr is a string with the value.
3520 You can set buffer-local values for the same purpose in the variable
3521 `org-file-properties' this by adding lines like
3523 #+PROPERTY: NAME VALUE"
3530 "List of property/value pairs that can be inherited by any entry.
3531 Valid for the current buffer.
3536 "Options concerning agenda views in Org-mode."
3541 "Variable used by org files to set a category for agenda display.
3542 Such files should use a file variable to set it, for example
3546 or contain a special line
3548 #+CATEGORY: ELisp
3550 If the file does not specify a category, then file's base name
3556 "The files to be used for agenda display.
3560 If an entry is a directory, all files in that directory that are matched by
3561 `org-agenda-file-regexp' will be part of the file list.
3563 If the value of the variable is not a list but a single file name, then
3564 the list of agenda files is actually stored and maintained in that file, one
3565 agenda file per line. In this file paths can be given relative to
3566 `org-directory'. Tilde expansion and environment variable substitution
3567 are also made."
3574 "Regular expression to match files for `org-agenda-files'.
3575 If any element in the list in that variable contains a directory instead
3576 of a normal file, all files in that directory that are matched by this
3577 regular expression will be included."
3582 "List of extra files to be searched by text search commands.
3583 These files will be search in addition to the agenda files by the
3584 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3585 Note that these files will only be searched for text search commands,
3586 not for the other agenda views like todo lists, tag searches or the weekly
3587 agenda. This variable is intended to list notes and possibly archive files
3588 that should also be searched by these two commands.
3589 In fact, if the first element in the list is the symbol `agenda-archives',
3590 than all archive files of all agenda files will be added to the search
3591 scope."
3601 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3602 A nil value means to remove them, after a query, from the list."
3607 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3608 The command `org-calendar-goto-agenda' will be bound to this key. The
3609 default is the character `c' because then `c' can be used to switch back and
3610 forth between agenda and calendar."
3615 "The key to be installed in `calendar-mode-map' for adding diary entries.
3616 This option is irrelevant until `org-agenda-diary-file' has been configured
3617 to point to an Org-mode file. When that is the case, the command
3618 `org-agenda-diary-entry' will be bound to the key given here, by default
3619 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3620 if you want to continue doing this, you need to change this to a different
3621 key."
3626 "File to which to add new entries with the `i' key in agenda and calendar.
3627 When this is the symbol `diary-file', the functionality in the Emacs
3628 calendar will be used to add entries to the `diary-file'. But when this
3629 points to a file, `org-agenda-diary-entry' will be used instead."
3643 org-calendar-insert-diary-entry-key
3647 "Options for embedding LaTeX code into Org-mode."
3655 "Options for creating images from LaTeX fragments.
3656 This is a property list with the following properties:
3658 `default' means use the foreground of the default face.
3659 `auto' means use the foreground from the text face.
3661 `default' means use the background of the default face.
3662 `auto' means use the background from the text face.
3663 :scale a scaling factor for the size of the images, to get more pixels
3664 :html-foreground, :html-background, :html-scale
3665 the same numbers for HTML export.
3666 :matchers a list indicating which matchers should be used to
3667 find LaTeX fragments. Valid members of this list are:
3678 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3679 When nil, just push out a message."
3686 Use this to specify additional executable file say a jar file.
3688 When using MathToWeb as the converter, specify the full-path to
3689 your mathtoweb.jar file."
3697 "Command to convert LaTeX fragments to MathML.
3698 Replace format-specifiers in the command as noted below and use
3699 `shell-command' to convert LaTeX to MathML.
3700 %j: Executable file in fully expanded form as specified by
3701 `org-latex-to-mathml-jar-file'.
3702 %I: Input LaTeX file in fully expanded form
3703 %o: Output MathML file
3704 This command is used by `org-create-math-formula'.
3706 When using MathToWeb as the converter, set this to
3715 "Program to convert LaTeX fragments with.
3717 dvipng Process the LaTeX fragments to dvi file, then convert
3718 dvi files to png files using dvipng.
3719 This will also include processing of non-math environments.
3720 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3721 to convert pdf files to png files"
3729 "Path to store latex preview images.
3730 A relative path here creates many directories relative to the
3731 processed org files paths. An absolute path puts all preview
3732 images at the same place."
3738 "Return t if `org-latex-to-mathml-convert-command' is usable."
3741 org-latex-to-mathml-convert-command)
3743 org-latex-to-mathml-convert-command))))
3748 t))))))
3755 \[PACKAGES]
3756 \[DEFAULT-PACKAGES]
3757 % The settings below are copied from fullpage.sty
3770 "The document header used for processing LaTeX fragments.
3771 It is imperative that this header make sure that no page number
3772 appears on the page. The package defined in the variables
3773 `org-latex-default-packages-alist' and `org-latex-packages-alist'
3775 header, or they will be appended."
3780 "Set the packages alist and make sure it has 3 elements per entry."
3784 x))
3785 val)))
3788 "Get the packages alist and make sure it has 3 elements per entry."
3792 x))
3811 "Alist of default packages to be inserted in the header.
3813 Change this only if one of the packages here causes an
3814 incompatibility with another package you are using.
3816 The packages in this list are needed by one part or another of
3817 Org mode to function properly:
3819 - inputenc, fontenc: for basic font and character selection
3820 - textcomp, marvosymb, wasysym, latexsym, amssym: for various
3821 symbols used for interpreting the entities in `org-entities'.
3822 You can skip some of these packages if you don't use any of the
3823 symbols in it.
3824 - graphicx: for including images
3825 - float, wrapfig: for figure placement
3826 - longtable: for long tables
3827 - hyperref: for cross references
3829 Therefore you should not modify this variable unless you know
3830 what you are doing. The one reason to change it anyway is that
3831 you might be loading some other package that conflicts with one
3832 of the default packages. Each cell is of the format
3834 the package also needs to be included when compiling LaTeX
3835 snippets into images for inclusion into non-LaTeX output."
3850 "Alist of packages to be inserted in every LaTeX header.
3852 These will be inserted after `org-latex-default-packages-alist'.
3853 Each cell is of the format:
3857 SNIPPET-FLAG, when t, indicates that this package is also needed
3858 when turning LaTeX snippets into images for inclusion into
3859 non-LaTeX output.
3861 Make sure that you only list packages here which:
3863 - you want in every file
3864 - do not conflict with the setup in `org-format-latex-header'.
3865 - do not conflict with the default packages in
3866 `org-latex-default-packages-alist'."
3880 "Settings for Org-mode appearance."
3885 "Non-nil means fontify only the stars in each headline.
3886 When nil, the entire headline is fontified.
3887 Changing it requires restart of `font-lock-mode' to become effective
3888 also in regions already fontified."
3893 "Non-nil means hide the first N-1 stars in a headline.
3894 This works by using the face `org-hide' for these stars. This
3895 face is white for a light background, and black for a dark
3896 background. You may have to customize the face `org-hide' to
3897 make this work.
3898 Changing it requires restart of `font-lock-mode' to become effective
3899 also in regions already fontified.
3900 You may also set this on a per-file basis by adding one of the following
3901 lines to the buffer:
3903 #+STARTUP: hidestars
3904 #+STARTUP: showstars"
3909 "List of symbols corresponding to keywords to be hidden the org buffer.
3910 For example, a value '(title) for this list will make the document's title
3911 appear in the buffer without the initial #+TITLE: keyword."
3920 "List of properties (as strings) with a special meaning.
3921 The default use of these custom properties is to let the user
3922 hide them with `org-toggle-custom-properties-visibility'."
3929 "Non-nil means change the face of a headline if it is marked DONE.
3930 Normally, only the TODO/DONE keyword indicates the state of a headline.
3931 When this is non-nil, the headline after the keyword is set to the
3932 `org-headline-done' as an additional indication."
3937 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3938 Changing this variable requires a restart of Emacs to take effect."
3943 "Non-nil means fontify the whole line for headings.
3944 This is useful when setting a background color for the
3945 org-level-* faces."
3950 "Non-nil means highlight LaTeX related syntax in the buffer.
3951 When non nil, the value should be a list containing any of the
3952 following symbols:
3953 `latex' Highlight LaTeX snippets and environments.
3954 `script' Highlight subscript and superscript.
3955 `entities' Highlight entities."
3967 "Non-nil mean font-lock should hide the emphasis marker characters."
3972 "Non-nil means show entities as UTF8 characters.
3979 "Non-nil means, pretty entity display includes formatting sub/superscripts."
3985 "Regular expression for matching emphasis.
3986 After a match, the match groups contain these elements:
3987 0 The match of the full regular expression, including the characters
3988 before and after the proper match
3989 1 The character before the proper match, or empty at beginning of line
3990 2 The proper match, including the leading and trailing markers
3991 3 The leading marker like * or /, indicating the type of highlighting
3992 4 The text between the emphasis markers, not including the markers
3999 "Set variable and compute the emphasis regular expression."
4003 org-emphasis-alist org-emphasis-regexp-components)
4015 ;; make sure special characters appear at the right position in the class
4027 ;; Make the regexp
4035 body1
4047 body1
4053 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4054 ;; set this option proved cumbersome. See this message/thread:
4055 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4058 "Components used to build the regular expression for emphasis.
4059 This is a list with five entries. Terminology: In an emphasis string
4063 specify what is allowed/forbidden in each part:
4065 pre Chars allowed as prematch. Beginning of line will be allowed too.
4066 post Chars allowed as postmatch. End of line will be allowed too.
4067 border The chars *forbidden* as border characters.
4069 non-shy groups here, and don't allow newline here.
4070 newline The maximum number of newlines allowed in an emphasis exp.
4081 "Alist of characters and faces to emphasize text.
4082 Text starting and ending with a special character will be emphasized,
4083 for example *bold*, _underlined_ and /italic/. This variable sets the
4084 marker characters and the face to be used by font-lock for highlighting
4085 in Org-mode Emacs buffers.
4087 You need to reload Org or to restart Emacs after customizing this."
4102 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4105 ;;; Miscellaneous options
4108 "Completion in Org-mode."
4113 "Non-nil means use ido completion wherever possible.
4114 Note that `ido-mode' must be active for this variable to be relevant.
4115 If you decide to turn this variable on, you might well want to turn off
4116 `org-outline-path-complete-in-steps'.
4117 See also `org-completion-use-iswitchb'."
4122 "Non-nil means use iswitchb completion wherever possible.
4123 Note that `iswitchb-mode' must be active for this variable to be relevant.
4124 If you decide to turn this variable on, you might well want to turn off
4125 `org-outline-path-complete-in-steps'.
4126 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4132 Normal means, no org-mode-specific context."
4136 ;;; Functions and variables from their packages
4137 ;; Declared here to avoid compiler warnings
4139 ;; XEmacs only
4145 ;; Emacs only
4148 ;; Various packages
4167 org-agenda-format-item "org-agenda"
4194 ;;; Autoload and prepare some org modules
4196 ;; Some table stuff that needs to be defined here, because it is used
4197 ;; by the functions setting up org-mode or checking for table context.
4210 "Detect the first line outside a table when searching from within it.
4213 ;; Autoload the functions in org-table.el that are needed by functions here.
4222 ;;;###autoload
4224 "Unconditionally turn on `orgtbl-mode'."
4229 "Return t if the cursor is inside an org-type table.
4230 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4235 org-table-line-regexp)))
4236 nil))
4240 "Return t if and only if we are at a table.el table."
4247 "If there is a table.el table nearby, recognize it and move into it."
4253 nil
4263 t
4268 t)
4269 nil)
4270 nil))
4273 "Return t if the cursor is inside a hline in a table."
4278 nil))
4282 "Apply FUNCTION to the start of all tables in the buffer."
4292 ;; Exclude tables in src/example/verbatim/clocktable blocks
4300 ;; Declare and autoload functions from ox.el and al.
4306 ;; Declare and autoload functions from org-agenda.el
4318 "Return t when point (or POS) is in #+TBLFM line."
4333 "Return non-nil if clock is currently running.
4334 The return value is actually the clock marker."
4339 org-clock-update-time-maybe
4340 org-clocktable-shift)))
4343 "Check if the current buffer contains the running clock.
4344 If yes, offer to stop it and to save the buffer with the changes."
4353 "Check if this line starts a clock table, if yes, shift the time block."
4357 ;;;###autoload
4359 "Set up hooks for clock persistence."
4364 ;; Define the variable already here, to make sure we have it.
4366 "Non-nil if Org-Indent mode is enabled.
4369 ;; Autoload archiving code
4370 ;; The stuff that is needed for cycling and tags has to be defined here.
4373 "Options concerning archiving in Org-mode."
4378 "The location where subtrees should be archived.
4380 The value of this variable is a string, consisting of two parts,
4381 separated by a double-colon. The first part is a filename and
4382 the second part is a headline.
4384 When the filename is omitted, archiving happens in the same file.
4385 %s in the filename will be replaced by the current file
4386 name (without the directory part). Archiving to a different file
4387 is useful to keep archived entries from contributing to the
4388 Org-mode Agenda.
4390 The archived entries will be filed as subtrees of the specified
4391 headline. When the headline is omitted, the subtrees are simply
4392 filed away at the end of the file, as top-level entries. Also in
4393 the heading you can use %s to represent the file name, this can be
4394 useful when using the same archive for a number of different files.
4396 Here are a few examples:
4398 If the current file is Projects.org, archive in file
4399 Projects.org_archive, as top-level trees. This is the default.
4402 Archive in the current file, under the top-level headline
4406 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4409 Archive in file ~/org/archive.org (absolute path), under headlines
4414 items to the datetree. Items are placed in either the CLOSED
4415 date of the item, or the current date if there is no CLOSED date.
4416 The heading will be a subentry to the current date. There doesn't
4417 need to be a heading, but there always needs to be a slash after
4418 datetree. For example, to store archived items directly in the
4422 Archive in file ./basement (relative path), as level 3 trees
4425 You may set this option on a per-file basis by adding to the buffer a
4426 line like
4428 #+ARCHIVE: basement::** Finished Tasks
4430 You may also define it locally for a subtree by setting an ARCHIVE property
4431 in the entry. If such a property is found in an entry, or anywhere up
4432 the hierarchy, it will be used."
4437 "The tag that marks a subtree as archived.
4438 An archived subtree does not open during visibility cycling, and does
4439 not contribute to the agenda listings.
4440 After changing this, font-lock must be restarted in the relevant buffers to
4441 get the proper fontification."
4447 "Non-nil means the agenda will skip any items located in archived trees.
4448 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4449 variable is no longer recommended, you should leave it at the value t.
4450 Instead, use the key `v' to cycle the archives-mode in the agenda."
4456 "Non-nil means ignore archived trees when creating column view."
4462 "Non-nil means `org-cycle' will open archived trees.
4463 An archived tree is a tree marked with the tag ARCHIVE.
4464 When nil, archived trees will stay folded. You can still open them with
4465 normal outline commands like `show-all', but not with the cycling commands."
4471 "Non-nil means sparse tree construction shows matches in archived trees.
4472 When nil, matches in these trees are highlighted, but the trees are kept in
4473 collapsed state."
4479 "The default date type when building a sparse tree.
4480 When this is nil, a date is a scheduled or a deadline timestamp.
4481 Otherwise, these types are allowed:
4483 all: all timestamps
4484 active: only active timestamps (<...>)
4485 inactive: only inactive timestamps (<...)
4486 scheduled: only scheduled timestamps
4487 deadline: only deadline timestamps"
4499 "Re-hide all archived subtrees after a visibility state change."
4510 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4513 "Cycle subtree even if it is archived."
4520 "Re-hide all archived subtrees after a visibility state change."
4537 flag)))
4545 ;; Autoload Column View Code
4553 org-columns-get-format-and-top-level
4554 org-columns-compute
4555 org-columns-remove-overlays))
4557 ;; Autoload ID code
4565 org-id-copy
4566 org-id-get-with-outline-path-completion
4567 org-id-get-with-outline-drilling))
4569 ;;; Variables for pre-computed regular expressions, all buffer local
4587 "Matches a headline and puts everything into groups:
4588 group 1: the stars
4589 group 2: The todo keyword, maybe
4590 group 3: Priority cookie
4591 group 4: True headline
4595 "Printf format to make regexp to match an exact headline.
4596 This regexp will match the headline of any node which has the
4597 exact headline text that is put into the format, but may have any
4601 "Matches a headline and puts TODO state into group 2 if present.
4653 "Regular expression to match a plain time or time range.
4654 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4655 groups carry important information:
4656 0 the full match
4657 1 the first time, range or not
4665 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4666 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4667 groups carry important information:
4668 0 the full match
4669 7 hours of duration
4678 "Regular expression to match a timestamp time or time range.
4679 After a match, the following groups carry important information:
4680 0 the full match
4681 1 date plus weekday, for back referencing to make sure both times are on the same day
4682 2 the first time, range or not
4743 "Variable associated with STARTUP options for org-mode.
4744 Each element is a list of three items: the startup options (as written
4745 in the #+STARTUP line), the corresponding variable, and the value to set
4746 this variable to if the option is found. An optional forth element PUSH
4750 "Update PROPS with KEY and VAL."
4764 "Printf format for a regexp matching a headline with some keyword.
4765 This regexp will match the headline of any node which has the
4766 exact keyword that is put into the format. The keyword isn't in
4770 "Printf format for a regexp matching a headline, possibly with some keyword.
4771 This regexp can match any headline with the specified keyword, or
4772 without a keyword. The keyword isn't in any group by default,
4776 "When non-nil (the default), use group tags.
4777 This can be turned on/off through `org-toggle-tags-groups'."
4783 "Toggle support for group tags.
4784 Support for group tags is controlled by the option
4785 `org-group-tags', which is non-nil by default."
4789 org-group-tags)
4797 "Precompute regular expressions used for tags in the current buffer."
4803 tags ftags key value)
4820 ftags
4824 ;; Process the file tags.
4828 ;; Process the tags.
4829 ;; FIXME
4839 org-tag-groups-alist)
4864 "Precompute regular expressions used in the current buffer."
4882 kwds kws0 kwsa key log value cat arch const links hw dws
4883 tail sep kws1 prio props drawers ext-setup-or-nil setup-contents
4896 org-tag-groups-alist))))
4916 ;; general TODO-like setup
4925 links)))
4932 props))))
4939 l var val)
4957 ;; Prevent checking in Gnus messages
4969 ;; search for property blocks
4978 props)))))))
4993 ;; Process the TODO keywords
4995 ;; Use the global values as if they had been given locally.
5007 kws)))
5010 kwsa nil
5013 ;; 1 2
5021 kw)
5023 kws0)
5040 ;; Compute the regular expressions and other local variables.
5041 ;; Using `org-outline-regexp-bol' would complicate them much,
5042 ;; because of the fixed white space at the end of that string.
5050 org-drawer-regexp
5054 org-not-done-keywords
5056 org-todo-regexp
5060 org-not-done-regexp
5064 org-not-done-heading-regexp
5066 org-todo-line-regexp
5068 org-complex-heading-regexp
5075 org-complex-heading-regexp-format
5080 ;; Stats cookies can be stuck to body.
5087 org-todo-line-tags-regexp
5094 org-deadline-time-regexp
5096 org-deadline-time-hour-regexp
5099 org-deadline-line-regexp
5101 org-scheduled-regexp
5103 org-scheduled-time-regexp
5105 org-scheduled-time-hour-regexp
5108 org-closed-time-regexp
5110 org-keyword-time-regexp
5116 org-keyword-time-not-clock-regexp
5122 org-maybe-keyword-time-regexp
5128 org-all-time-keywords
5131 org-clock-string org-closed-string)))
5136 "Return the contents of FILE, as a string."
5147 "Extract the log state setting from a TODO keyword string.
5161 "Remove a pair of parenthesis at the end of each string in LIST."
5165 x))
5166 list))
5169 "Assign fast keys to a keyword-key alist.
5170 Respect keys that are already there."
5188 ;;; Some variables used in various places
5195 "Function to be called when `C-c C-c' is used.
5199 ;; FIXME: Occasionally check by commenting these, to make sure
5200 ;; no other functions uses these, forgetting to let-bind them.
5205 ;; Defined somewhere in this file, but used before definition.
5211 ;;;; Define the Org-mode
5213 ;; We use a before-change function to check if a table might need
5214 ;; an update.
5216 "Indicates that a table might need an update.
5217 This variable is set by `org-before-change-function'.
5220 "Every change indicates that a table might need an update."
5235 (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"))
5238 ;; Other stuff we need.
5244 ;; (require 'org-macs) moved higher up in the file before it is first used
5246 ;; (require 'org-compat) moved higher up in the file before it is first used
5254 ;; babel
5257 ;;;###autoload
5259 "Outline-based notes management and organizer, alias
5262 Org-mode develops organizational tasks around a NOTES file which
5263 contains information about projects as plain text. Org-mode is
5264 implemented on top of outline-mode, which is ideal to keep the content
5265 of large files well structured. It supports ToDo items, deadlines and
5266 time stamps, which magically appear in the diary listing of the Emacs
5267 calendar. Tables are easily created with a built-in table editor.
5268 Plain text URL-like links connect to websites, emails (VM), Usenet
5269 messages (Gnus), BBDB entries, and any files related to the project.
5270 For printing and sharing of notes, an Org-mode file (or a part of it)
5271 can be exported as a structured ASCII or HTML file.
5273 The following commands are available:
5277 ;; Get rid of Outline menus, they are not needed
5278 ;; Need to do this here because define-derived-mode sets up
5279 ;; the keymap so late. Still, it is a waste to call this each time
5280 ;; we switch another buffer into org-mode.
5283 ;; Assume this is Greg's port, it uses easymenu
5303 ;; FIXME Circumvent a bug in outline.el (Emacs <24.4)
5311 org-display-table 4
5314 org-ellipsis)))
5320 ;; tag faces set outside customize.... force initialization.
5322 ;; Calc embedded
5324 ;; Modify a few syntax entries
5331 ;; Activate before-change-function
5335 ;; Check for running clock before killing a buffer
5337 ;; Initialize macros templates.
5339 ;; Initialize radio targets.
5341 ;; Indentation.
5344 ;; Filling and auto-filling.
5346 ;; Comments.
5348 ;; Beginning/end of defun
5351 ;; Next error for sparse trees
5353 ;; Make sure dependence stuff works reliably, even for users who set it
5354 ;; too late :-(
5366 ;; Align options lines
5368 'align-mode-rules-list
5373 ;; Imenu
5377 ;; Make isearch reveal context
5380 ;; Emacs 21 and XEmacs make use of the hook
5382 ;; Emacs 22 deals with this through a special variable
5387 ;; Setup the pcomplete hooks
5400 ;; If empty file that did not turn on org-mode automatically, make it to.
5416 ;; Try to set org-hide correctly
5419 ;; Update `customize-package-emacs-version-alist'
5429 org-emphasis-alist)
5430 st))
5443 "unspecified-bg"
5456 "Current time, possibly rounded to ROUNDING-MINUTES.
5457 When ROUNDING-MINUTES is not an integer, fall back on the car of
5458 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5459 the rounding returns a past time."
5471 res))))
5474 "Return today date, considering `org-extend-today-until'."
5479 ;;;; Font-Lock stuff, including the activators
5510 "Regular expression used to analyze links.
5511 Here is what the match groups contain after a match:
5512 1: http:
5513 2: http
5514 3: path
5515 4: [desc]
5526 "Create a regular expression which will match a balanced sexp.
5527 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5528 as single character strings.
5529 The regexp returned will match the entire expression including the
5530 delimiters. It will also define a single group which contains the
5531 match except for the outermost delimiters. The maximum depth of
5532 stacked delimiters is N. Escaping delimiters is not possible."
5561 "Update the link regular expressions.
5562 This should be called after the variable `org-link-types' has changed."
5566 org-link-re-with-space
5572 org-link-re-with-space2
5578 org-link-re-with-space3
5583 org-angle-link-re
5589 org-plain-link-re
5593 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5594 org-bracket-link-regexp
5596 org-bracket-link-analytic-regexp
5604 org-bracket-link-analytic-regexp++
5612 org-any-link-re
5621 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
5624 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5625 "Regular expression matching time strings for analysis.
5626 This one does not require the space after the date, so it can be used
5628 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
5645 "Regular expression matching a time stamp or time stamp range.
5651 "Run through the buffer and add overlays to emphasized strings."
5660 'face
5673 rtn))
5676 "Insert or change an emphasis, i.e. a font like bold or italic.
5677 If there is an active region, change that region to a new emphasis.
5678 If there is no region, just insert the marker characters and position
5679 the cursor between them.
5680 CHAR should be the marker character. If it is a space, it means to
5681 remove the emphasis of the selected region.
5682 If CHAR is not given (for example in an interactive call) it will be
5683 prompted for."
5726 "Run through the buffer and add overlays to links."
5735 nil
5742 t)))
5750 t)))
5753 "When non-nil, fontify code in code blocks."
5760 "When non-nil, allow promoting a top level subtree.
5761 The leading star of the top level headline will be replaced
5762 by a #."
5773 "Fontify #+ lines and blocks."
5776 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5777 limit t)
5785 end end1 quoting block-type ovl)
5788 ;; a single line of backend-specific content
5796 ; for backend-specific code
5797 t)
5799 ;; Truly a block
5812 beg end
5820 ;; remove old background overlays
5825 ;; add a background overlay
5840 t))
5860 t)
5866 ;; just any other in-buffer setting, but not indented
5870 t)
5874 "Run through the buffer and add overlays to links."
5883 t)))
5886 "Run through the buffer and add overlays to footnotes."
5893 'keymap org-mouse-map
5894 'help-echo
5896 "Footnote definition"
5898 'font-lock-fontified t
5899 'font-lock-multiline t
5903 "Run through the buffer and add overlays to bracketed links."
5908 ;; FIXME: Above we should remove the escapes. But that
5909 ;; requires another match, protecting match data, a lot
5910 ;; of overhead for font-lock.
5919 ;; We need to remove the invisible property here. Table narrowing
5920 ;; may have made some of this invisible.
5938 t)))
5941 "Run through the buffer and add overlays to dates."
5954 t)))
5963 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
5967 "Run through the buffer and add overlays to target matches."
5975 'keymap org-mouse-map
5979 t)))))
5982 "Find all radio targets in this file and update the regular expression."
5997 t)))
6005 "Compute regular expression for LaTeX, entities and sub/superscript.
6006 Result depends on variable `org-highlight-latex-and-related'."
6008 'org-latex-and-related-regexp
6020 org-latex-regexps)))))
6027 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6028 LIMIT bounds the search for syntax to highlight. Stop at first
6029 highlighted object, if any. Return t if some highlighting was
6030 done, nil otherwise."
6039 1
6047 nil)))
6050 "Restart `font-lock-mode', to force refontification."
6056 "Return a list of all targets in this file.
6057 When optional argument RADIO is non-nil, only find radio
6058 targets."
6063 ;; Make sure point is really within the object.
6068 rtn)))
6071 "Make regular expression matching all strings in TARGETS.
6072 The regular expression finds the targets also if there is a line break
6073 between words."
6082 x)
6083 targets
6095 t)))
6098 "Compute the outline level of the heading at point.
6099 If this is called at a normal headline, the level is the number of stars.
6100 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
6105 0
6111 (defconst org-property-re (org-re "^[ \t]*\\(:\\([-[:alnum:]_]+\\+?\\):\\)[ \t]*\\([^ \t\r\n].*\\)")
6118 "Functions that can manipulate `org-font-lock-extra-keywords'.
6119 This is called after `org-font-lock-extra-keywords' is defined, but before
6120 it is installed to be used by font lock. This can be useful if something
6124 "Run `org-font-lock-hook' within LIMIT."
6128 "Set font lock defaults for the current buffer."
6133 ;; Call the hook
6135 ;; Headlines
6142 ;; Table lines
6145 ;; Table internals
6150 ;; Drawers
6153 ;; Properties
6157 ;; Links
6165 ;; Targets.
6167 ;; Diary sexps.
6169 ;; Macro
6172 ;; TODO keyword
6174 org-todo-regexp)
6176 ;; DONE
6184 nil)
6185 ;; Priorities
6187 ;; Tags
6189 ;; Tags groups
6195 ;; Special keywords
6200 ;; Emphasis
6205 ;; Checkboxes
6206 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6211 ;; Description list items
6214 ;; ARCHIVEd headings
6216 org-outline-regexp-bol
6219 ;; Specials
6223 ;; Code
6225 ;; COMMENT
6231 ;; Blocks and meta lines
6233 )))
6236 ;; Now set the full font-lock-keywords
6243 "Toggle the composition display of entities as UTF8 characters."
6259 "Display or hide properties in `org-custom-properties'."
6276 org-custom-properties)))))))
6279 "Find an entity to fontify."
6285 limit t)
6300 nil))))
6303 "Fontify string S like in Org-mode."
6315 "Get the right face for match N in font-lock matching of headlines."
6328 "Get the right face for a TODO keyword KWD.
6329 If KWD is a number, get the corresponding match group."
6337 "Create a face list that inherits INHERIT, but sets the foreground color.
6338 When FACE-OR-COLOR is not a string, just return it."
6342 face-or-color)
6343 face-or-color))
6346 "Add the special tag faces."
6355 "Add the special priority faces."
6363 org-priority-faces)))
6368 "Get the right face for a TODO keyword KWD.
6369 If KWD is a number, get the corresponding match group."
6376 "Remove fontification and activation overlays from links."
6381 deactivate-mark buffer-file-name buffer-file-truename)
6385 invisible t intangible t
6386 org-no-flyspell t org-emphasis t))
6396 "Remove specific display properties that have been added by font lock.
6397 The will remove the raise properties that are used to show superscripts
6398 and subscripts."
6408 "Add raise properties to sub/superscripts."
6412 org-match-substring-regexp
6413 org-match-substring-with-braces-regexp)
6414 limit t)
6424 ;; Handle a_b^c
6427 t
6429 'display
6445 t)))))
6447 ;;;; Visibility cycling, including org-goto and indirect buffer
6449 ;;; Cycling
6460 ;;;###autoload
6462 "TAB-action and visibility cycling for Org-mode.
6464 This is the command invoked in Org-mode by the TAB key. Its main purpose
6465 is outline visibility cycling, but it also invokes other actions
6466 in special contexts.
6468 - When this function is called with a prefix argument, rotate the entire
6469 buffer through 3 states (global cycling)
6470 1. OVERVIEW: Show only top-level headlines.
6471 2. CONTENTS: Show all headlines of all levels, but no body text.
6472 3. SHOW ALL: Show everything.
6473 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6474 determined by the variable `org-startup-folded', and by any VISIBILITY
6475 properties in the buffer.
6476 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6477 including any drawers.
6479 - When inside a table, re-align the table and move to the next field.
6481 - When point is at the beginning of a headline, rotate the subtree started
6482 by this line through 3 different states (local cycling)
6483 1. FOLDED: Only the main headline is shown.
6484 2. CHILDREN: The main headline and the direct children are shown.
6485 From this state, you can move to one of the children
6486 and zoom in further.
6487 3. SUBTREE: Show the entire subtree, including body text.
6488 If there is no subtree, switch directly from CHILDREN to FOLDED.
6490 - When point is at the beginning of an empty headline and the variable
6491 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6492 of the headline by demoting and promoting it to likely levels. This
6493 speeds up creation document structure by pressing TAB once or several
6494 times right after creating a new headline.
6496 - When there is a numeric prefix, go up to a heading with level ARG, do
6497 a `show-subtree' and return to the previous cursor position. If ARG
6498 is negative, go up that many levels.
6500 - When point is not at the beginning of a headline, execute the global
6501 binding for TAB, which is re-indenting the line. See the option
6502 `org-cycle-emulate-tab' for details.
6504 - Special case: if point is at the beginning of the buffer and there is
6505 no headline in line 1, this function will act as if called with prefix arg
6506 (C-u TAB, same as S-TAB) also when called without prefix arg.
6507 But only if also the variable `org-cycle-global-at-bob' is t."
6518 org-inlinetask-min-level
6523 limit-level)))
6526 outline-regexp
6534 org-cycle-hook))
6538 ;; special case: use global cycling
6552 ;; Table: enter it or move to the next field.
6563 ;; Global cycling: delegate to `org-cycle-internal-global'.
6566 ;; Drawers: delegate to `org-flag-drawer'.
6574 ;; Show-subtree, ARG levels up from here.
6582 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6590 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6597 ;; From there: TAB emulation and template completion.
6619 t
6628 "Do the global cycling action."
6629 ;; Hack to avoid display of messages for .org attachments in Gnus
6635 ;; We just created the overview - now do table of contents
6636 ;; This can be slow in very large buffers, so indicate action
6646 ;; We just showed the table of contents - now show everything
6654 ;; Default action: go to overview
6662 "Do the local cycling action."
6665 ;; First, determine end of headline (EOH), end of subtree or item
6666 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6686 ;; Determine end invisible part of buffer (EOL)
6688 ;; XEmacs doesn't have `next-single-char-property-change'
6698 ;; Find out what to do next and set `this-command'
6701 ;; Nothing is hidden behind this heading
6714 org-cycle-skip-children-state-if-no-children))))
6715 ;; Entire subtree is hidden in one line: children view
6722 ;; FIXME: This slows down the func way too much.
6723 ;; How keep drawers hidden in subtree anyway?
6724 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6725 ;; (org-cycle-hide-drawers 'subtree))
6727 ;; Fold every list in subtree to top-level items.
6750 ;; We just showed the children, or no children are there,
6751 ;; now show everything.
6760 ;; Default action: hide the subtree.
6768 ;;;###autoload
6770 "Cycle the global visibility. For details see `org-cycle'.
6772 With a numeric prefix, show all headlines up to that level."
6788 "Set the visibility required by startup options and properties."
6803 "Switch subtree visibilities according to :VISIBILITY: property."
6810 nil t)
6834 ;; This function uses outline-regexp instead of the more fundamental
6835 ;; org-outline-regexp so that org-cycle-global works outside of Org
6836 ;; buffers, where outline-regexp is needed.
6838 "Switch to overview mode, showing only top-level headlines.
6839 Really, this shows all headlines with level equal or greater than the level
6840 of the first headline in the buffer. This is important, because if the
6841 first headline is not level one, then (hide-sublevels 1) gives confusing
6842 results."
6856 "Show all headlines in the buffer, like a table of contents.
6857 With numerical argument N, show content up to level N."
6860 ;; Visit all headings and show their offspring
6867 t)
6876 "Adjust the window after a change in outline visibility.
6877 This function is the default value of the hook `org-cycle-hook'."
6887 "Remove outline overlays that do not contain non-white stuff."
6897 "Fix visibility issues after moving a subtree."
6898 ;; First, find a reasonable region to look at:
6899 ;; Start two siblings above, end three below
6917 ;; Properly fold already folded siblings
6928 "Show empty lines above all visible headlines.
6929 The region to be covered depends on STATE when called through
6930 `org-cycle-hook'. Lisp program can use t for STATE to get the
6931 entire buffer covered. Note that an empty line is only shown if there
6932 are at least `org-cycle-separator-lines' empty lines before the headline."
6942 beg end b e)
6966 ;; Never hide empty lines at the end of the file.
6976 "Move to the parent and re-show empty lines before visible headlines."
6982 "Return `org-agenda-files' list, plus all open org-mode files.
6983 This is useful for operations that need to scan all of a user's
6984 open and agenda-wise Org files."
6992 files))
6995 "Return the beginning position of the current entry."
6999 "Return the end position of the current entry."
7003 "Re-hide all drawers after a visibility state change."
7018 "Re-hide inline task when switching to 'contents visibility state."
7021 org-inlinetask-min-level)
7025 "When FLAG is non-nil, hide the drawer we are within.
7026 Otherwise make it visible."
7038 "Is the end of the current subtree visible?"
7043 "Move cursor to the first headline and recenter the headline.
7044 Optional argument N means put the headline into the Nth line of the window."
7050 ;;; Saving and restoring visibility
7053 "Return a list of the locations of all outline overlays.
7054 These are overlays with the `invisible' property value `outline'.
7055 The return value is a list of cons cells, with start and stop
7056 positions for each overlay.
7057 If USE-MARKERS is set, return the positions as markers."
7075 "Create visibility overlays for all positions in DATA.
7076 DATA should have been made by `org-outline-overlay-data'."
7084 data)))))
7086 ;;; Folding of blocks
7093 "Call FUNCTION at the head of all source blocks in the current buffer.
7094 Optional arguments START and END can be used to limit the range."
7106 "Toggle the visibility of all blocks in the current buffer."
7110 "Fold all blocks in the current buffer."
7116 "Unfold all blocks in the current buffer."
7122 "Toggle visibility of block at point."
7133 "Toggle the visibility of the current block."
7140 ov)
7156 ;; make the block accessible to isearch
7158 ov 'isearch-open-invisible
7169 ;; org-tab-after-check-for-cycling-hook
7171 ;; Remove overlays when changing major mode
7176 ;;; Org-goto
7182 "Set the keymap `org-goto'."
7186 mouse-drag-region universal-argument org-occur))
7187 cmd)
7203 nil)
7204 (org-defkey map "q" 'org-goto-quit)
7205 (org-defkey map "n" 'outline-next-visible-heading)
7206 (org-defkey map "p" 'outline-previous-visible-heading)
7207 (org-defkey map "f" 'outline-forward-same-level)
7208 (org-defkey map "b" 'outline-backward-same-level)
7209 (org-defkey map "u" 'outline-up-heading))
7210 (org-defkey map "/" 'org-occur)
7211 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7212 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7213 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7214 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7215 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7216 map)))
7218 (defconst org-goto-help
7219 "Browse buffer copy, to find location or copy text.%s
7220 RET=jump to location C-g=quit and return to previous location
7221 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7223 (defvar org-goto-start-pos) ; dynamically scoped parameter
7225 (defun org-goto (&optional alternative-interface)
7226 "Look up a different location in the current file, keeping current visibility.
7228 When you want look-up or go to a different location in a
7229 document, the fastest way is often to fold the entire buffer and
7230 then dive into the tree. This method has the disadvantage, that
7231 the previous location will be folded, which may not be what you
7232 want.
7234 This command works around this by showing a copy of the current
7235 buffer in an indirect buffer, in overview mode. You can dive
7236 into the tree in that copy, use org-occur and incremental search
7237 to find a location. When pressing RET or `Q', the command
7238 returns to the original buffer in which the visibility is still
7239 unchanged. After RET it will also jump to the location selected
7240 in the indirect buffer and expose the headline hierarchy above.
7242 With a prefix argument, use the alternative interface: e.g. if
7243 `org-goto-interface' is 'outline use 'outline-path-completion."
7244 (interactive "P")
7245 (org-goto-map)
7246 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7247 (org-refile-use-outline-path t)
7248 (org-refile-target-verify-function nil)
7249 (interface
7250 (if (not alternative-interface)
7251 org-goto-interface
7252 (if (eq org-goto-interface 'outline)
7253 'outline-path-completion
7254 'outline)))
7255 (org-goto-start-pos (point))
7256 (selected-point
7257 (if (eq interface 'outline)
7258 (car (org-get-location (current-buffer) org-goto-help))
7259 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7260 (org-refile-check-position pa)
7261 (nth 3 pa)))))
7262 (if selected-point
7263 (progn
7264 (org-mark-ring-push org-goto-start-pos)
7265 (goto-char selected-point)
7266 (if (or (outline-invisible-p) (org-invisible-p2))
7267 (org-show-context 'org-goto)))
7268 (message "Quit"))))
7270 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7271 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7272 (defvar org-goto-local-auto-isearch-map) ; defined below
7274 (defun org-get-location (buf help)
7275 "Let the user select a location in the Org-mode buffer BUF.
7276 This function uses a recursive edit. It returns the selected position
7277 or nil."
7278 (org-no-popups
7279 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7280 (isearch-hide-immediately nil)
7281 (isearch-search-fun-function
7282 (lambda () 'org-goto-local-search-headings))
7283 (org-goto-selected-point org-goto-exit-command))
7284 (save-excursion
7285 (save-window-excursion
7286 (delete-other-windows)
7287 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7288 (org-pop-to-buffer-same-window
7289 (condition-case nil
7290 (make-indirect-buffer (current-buffer) "*org-goto*")
7291 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7292 (with-output-to-temp-buffer "*Org Help*"
7293 (princ (format help (if org-goto-auto-isearch
7294 " Just type for auto-isearch."
7295 " n/p/f/b/u to navigate, q to quit."))))
7296 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7297 (setq buffer-read-only nil)
7298 (let ((org-startup-truncated t)
7299 (org-startup-folded nil)
7300 (org-startup-align-all-tables nil))
7301 (org-mode)
7302 (org-overview))
7303 (setq buffer-read-only t)
7304 (if (and (boundp 'org-goto-start-pos)
7305 (integer-or-marker-p org-goto-start-pos))
7306 (let ((org-show-hierarchy-above t)
7307 (org-show-siblings t)
7308 (org-show-following-heading t))
7309 (goto-char org-goto-start-pos)
7310 (and (outline-invisible-p) (org-show-context)))
7311 (goto-char (point-min)))
7312 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7313 (message "Select location and press RET")
7314 (use-local-map org-goto-map)
7315 (recursive-edit)))
7316 (kill-buffer "*org-goto*")
7317 (cons org-goto-selected-point org-goto-exit-command))))
7319 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7320 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7321 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7322 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
7324 (defun org-goto-local-search-headings (string bound noerror)
7325 "Search and make sure that any matches are in headlines."
7326 (catch 'return
7327 (while (if isearch-forward
7328 (search-forward string bound noerror)
7329 (search-backward string bound noerror))
7330 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7331 (and (member :headline context)
7332 (not (member :tags context))))
7333 (throw 'return (point))))))
7335 (defun org-goto-local-auto-isearch ()
7336 "Start isearch."
7337 (interactive)
7338 (goto-char (point-min))
7339 (let ((keys (this-command-keys)))
7340 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7341 (isearch-mode t)
7342 (isearch-process-search-char (string-to-char keys)))))
7344 (defun org-goto-ret (&optional arg)
7345 "Finish `org-goto' by going to the new location."
7346 (interactive "P")
7347 (setq org-goto-selected-point (point)
7348 org-goto-exit-command 'return)
7349 (throw 'exit nil))
7351 (defun org-goto-left ()
7352 "Finish `org-goto' by going to the new location."
7353 (interactive)
7354 (if (org-at-heading-p)
7355 (progn
7356 (beginning-of-line 1)
7357 (setq org-goto-selected-point (point)
7358 org-goto-exit-command 'left)
7359 (throw 'exit nil))
7360 (error "Not on a heading")))
7362 (defun org-goto-right ()
7363 "Finish `org-goto' by going to the new location."
7364 (interactive)
7365 (if (org-at-heading-p)
7366 (progn
7367 (setq org-goto-selected-point (point)
7368 org-goto-exit-command 'right)
7369 (throw 'exit nil))
7370 (error "Not on a heading")))
7372 (defun org-goto-quit ()
7373 "Finish `org-goto' without cursor motion."
7374 (interactive)
7375 (setq org-goto-selected-point nil)
7376 (setq org-goto-exit-command 'quit)
7377 (throw 'exit nil))
7379 ;;; Indirect buffer display of subtrees
7381 (defvar org-indirect-dedicated-frame nil
7382 "This is the frame being used for indirect tree display.")
7383 (defvar org-last-indirect-buffer nil)
7385 (defun org-tree-to-indirect-buffer (&optional arg)
7386 "Create indirect buffer and narrow it to current subtree.
7387 With a numerical prefix ARG, go up to this level and then take that tree.
7388 If ARG is negative, go up that many levels.
7390 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7391 indirect buffer previously made with this command, to avoid proliferation of
7392 indirect buffers. However, when you call the command with a \
7394 when `org-indirect-buffer-display' is `new-frame', the last buffer
7395 is kept so that you can work with several indirect buffers at the same time.
7396 If `org-indirect-buffer-display' is `dedicated-frame', the \
7398 requests that a new frame be made for the new buffer, so that the dedicated
7399 frame is not changed."
7400 (interactive "P")
7401 (let ((cbuf (current-buffer))
7402 (cwin (selected-window))
7403 (pos (point))
7404 beg end level heading ibuf)
7405 (save-excursion
7406 (org-back-to-heading t)
7407 (when (numberp arg)
7408 (setq level (org-outline-level))
7409 (if (< arg 0) (setq arg (+ level arg)))
7410 (while (> (setq level (org-outline-level)) arg)
7411 (org-up-heading-safe)))
7412 (setq beg (point)
7413 heading (org-get-heading))
7414 (org-end-of-subtree t t)
7415 (if (org-at-heading-p) (backward-char 1))
7416 (setq end (point)))
7417 (if (and (buffer-live-p org-last-indirect-buffer)
7418 (not (eq org-indirect-buffer-display 'new-frame))
7419 (not arg))
7420 (kill-buffer org-last-indirect-buffer))
7421 (setq ibuf (org-get-indirect-buffer cbuf)
7422 org-last-indirect-buffer ibuf)
7423 (cond
7424 ((or (eq org-indirect-buffer-display 'new-frame)
7425 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7426 (select-frame (make-frame))
7427 (delete-other-windows)
7428 (org-pop-to-buffer-same-window ibuf)
7429 (org-set-frame-title heading))
7430 ((eq org-indirect-buffer-display 'dedicated-frame)
7431 (raise-frame
7432 (select-frame (or (and org-indirect-dedicated-frame
7433 (frame-live-p org-indirect-dedicated-frame)
7434 org-indirect-dedicated-frame)
7435 (setq org-indirect-dedicated-frame (make-frame)))))
7436 (delete-other-windows)
7437 (org-pop-to-buffer-same-window ibuf)
7438 (org-set-frame-title (concat "Indirect: " heading)))
7439 ((eq org-indirect-buffer-display 'current-window)
7440 (org-pop-to-buffer-same-window ibuf))
7441 ((eq org-indirect-buffer-display 'other-window)
7442 (pop-to-buffer ibuf))
7443 (t (error "Invalid value")))
7444 (if (featurep 'xemacs)
7445 (save-excursion (org-mode) (turn-on-font-lock)))
7446 (narrow-to-region beg end)
7447 (show-all)
7448 (goto-char pos)
7449 (run-hook-with-args 'org-cycle-hook 'all)
7450 (and (window-live-p cwin) (select-window cwin))))
7452 (defun org-get-indirect-buffer (&optional buffer)
7453 (setq buffer (or buffer (current-buffer)))
7454 (let ((n 1) (base (buffer-name buffer)) bname)
7455 (while (buffer-live-p
7456 (get-buffer (setq bname (concat base "-" (number-to-string n)))))
7457 (setq n (1+ n)))
7458 (condition-case nil
7459 (make-indirect-buffer buffer bname 'clone)
7460 (error (make-indirect-buffer buffer bname)))))
7462 (defun org-set-frame-title (title)
7463 "Set the title of the current frame to the string TITLE."
7464 ;; FIXME: how to name a single frame in XEmacs???
7465 (unless (featurep 'xemacs)
7466 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7468 ;;;; Structure editing
7470 ;;; Inserting headlines
7472 (defun org-previous-line-empty-p (&optional next)
7473 "Is the previous line a blank line?
7474 When NEXT is non-nil, check the next line instead."
7475 (save-excursion
7476 (and (not (bobp))
7477 (or (beginning-of-line (if next 2 0)) t)
7478 (save-match-data
7481 (defun org-insert-heading (&optional arg invisible-ok)
7482 "Insert a new heading or item with same depth at point.
7483 If point is in a plain list and ARG is nil, create a new list item.
7484 With one universal prefix argument, insert a heading even in lists.
7485 With two universal prefix arguments, insert the heading at the end
7486 of the parent subtree.
7488 If point is at the beginning of a headline, insert a sibling before
7489 the current headline. If point is not at the beginning, split the line
7490 and create a new headline with the text in the current line after point
7491 \(see `org-M-RET-may-split-line' on how to modify this behavior).
7493 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7494 This is important for non-interactive uses of the command."
7495 (interactive "P")
7496 (cond
7497 ((or (= (buffer-size) 0)
7498 (and (not (save-excursion
7499 (and (ignore-errors (org-back-to-heading invisible-ok))
7500 (org-at-heading-p))))
7501 (or arg (not (org-in-item-p)))))
7502 (insert
7504 (if (org-in-src-block-p) ",* " "* "))
7505 (run-hooks 'org-insert-heading-hook))
7506 ((or arg
7507 org-insert-heading-respect-content
7508 (not (org-insert-item
7509 (save-excursion
7510 (beginning-of-line)
7511 (looking-at org-list-full-item-re)
7512 (match-string 3)))))
7513 (let (begn endn)
7514 (when (org-buffer-narrowed-p)
7515 (setq begn (point-min) endn (point-max))
7516 (widen))
7517 (let* ((empty-line-p nil)
7518 (eops (equal arg '(16))) ; insert at end of parent subtree
7519 (org-insert-heading-respect-content
7520 (or (not (null arg)) org-insert-heading-respect-content))
7521 (level nil)
7522 (on-heading (org-at-heading-p))
7523 (on-empty-line
7525 (head (save-excursion
7526 (condition-case nil
7527 (progn
7528 (org-back-to-heading invisible-ok)
7529 (when (and (not on-heading)
7530 (featurep 'org-inlinetask)
7531 (integerp org-inlinetask-min-level)
7532 (>= (length (match-string 0))
7533 org-inlinetask-min-level))
7534 ;; Find a heading level before the inline task
7535 (while (and (setq level (org-up-heading-safe))
7536 (>= level org-inlinetask-min-level)))
7537 (if (org-at-heading-p)
7538 (org-back-to-heading invisible-ok)
7539 (error "This should not happen")))
7540 (unless (and (save-excursion
7541 (save-match-data
7542 (org-backward-heading-same-level 1 invisible-ok))
7543 (= (point) (match-beginning 0)))
7544 (not (org-previous-line-empty-p t)))
7545 (setq empty-line-p (org-previous-line-empty-p)))
7546 (match-string 0))
7547 (error "* "))))
7548 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7549 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7550 pos hide-previous previous-pos)
7551 (if ;; At the beginning of a heading, open a new line for insertiong
7552 (and (bolp) (org-at-heading-p)
7553 (not eops)
7554 (or (bobp)
7555 (save-excursion (backward-char 1) (not (outline-invisible-p)))))
7556 (open-line (if blank 2 1))
7557 (save-excursion
7558 (setq previous-pos (point-at-bol))
7559 (end-of-line)
7560 (setq hide-previous (outline-invisible-p)))
7561 (and org-insert-heading-respect-content
7562 (save-excursion
7563 (while (outline-invisible-p)
7564 (org-show-subtree)
7565 (org-up-heading-safe))))
7566 (let ((split
7567 (and (org-get-alist-option org-M-RET-may-split-line 'headline)
7568 (save-excursion
7569 (let ((p (point)))
7570 (goto-char (point-at-bol))
7571 (and (looking-at org-complex-heading-regexp)
7572 (match-beginning 4)
7573 (> p (match-beginning 4)))))))
7574 tags pos)
7575 (cond
7576 ;; Insert a new line, possibly at end of parent subtree
7577 ((and (not arg) (not on-heading) (not on-empty-line)
7578 (not (save-excursion
7579 (beginning-of-line 1)
7580 (looking-at org-list-full-item-re))))
7581 (beginning-of-line 1))
7582 (org-insert-heading-respect-content
7583 (if (not eops)
7584 (progn
7585 (org-end-of-subtree nil t)
7587 (while (and (not (bobp))
7588 ;; Don't delete spaces in empty headlines
7589 (not (looking-back org-outline-regexp))
7591 (backward-delete-char 1)))
7592 (let ((p (point)))
7593 (org-up-heading-safe)
7594 (if (= p (point))
7595 (goto-char (point-max))
7596 (org-end-of-subtree nil t))))
7597 (when (featurep 'org-inlinetask)
7598 (while (and (not (eobp))
7600 (>= (length (match-string 1))
7601 org-inlinetask-min-level))
7602 (org-end-of-subtree nil t)))
7603 (or (bolp) (newline))
7604 (or (org-previous-line-empty-p)
7605 (and blank (newline)))
7606 (if (or empty-line-p eops) (open-line 1)))
7607 ;; Insert a headling containing text after point
7608 ((org-at-heading-p)
7609 (when hide-previous
7610 (show-children)
7611 (org-show-entry))
7613 (setq tags (and (match-end 2) (match-string 2)))
7614 (and (match-end 1)
7615 (delete-region (match-beginning 1) (match-end 1)))
7616 (setq pos (point-at-bol))
7617 (or split (end-of-line 1))
7618 (delete-horizontal-space)
7620 (buffer-substring (point-at-bol) (point)))
7621 (insert " "))
7622 (newline (if blank 2 1))
7623 (when tags
7624 (save-excursion
7625 (goto-char pos)
7626 (end-of-line 1)
7627 (insert " " tags)
7628 (org-set-tags nil 'align))))
7629 (t
7630 (or split (end-of-line 1))
7631 (newline (cond ((and blank (not on-empty-line)) 2)
7632 (blank 1)
7633 (on-empty-line 0) (t 1)))))))
7634 (insert head) (just-one-space)
7635 (setq pos (point))
7636 (end-of-line 1)
7637 (unless (= (point) pos) (just-one-space) (backward-delete-char 1))
7638 (when (and org-insert-heading-respect-content hide-previous)
7639 (save-excursion
7640 (goto-char previous-pos)
7641 (hide-subtree)))
7642 (when (and begn endn)
7643 (narrow-to-region (min (point) begn) (max (point) endn)))
7644 (run-hooks 'org-insert-heading-hook))))))
7646 (defun org-get-heading (&optional no-tags no-todo)
7647 "Return the heading of the current entry, without the stars.
7648 When NO-TAGS is non-nil, don't include tags.
7649 When NO-TODO is non-nil, don't include TODO keywords."
7650 (save-excursion
7651 (org-back-to-heading t)
7652 (cond
7653 ((and no-tags no-todo)
7654 (looking-at org-complex-heading-regexp)
7655 (match-string 4))
7656 (no-tags
7657 (looking-at (concat org-outline-regexp
7660 (match-string 1))
7661 (no-todo
7662 (looking-at org-todo-line-regexp)
7663 (match-string 3))
7664 (t (looking-at org-heading-regexp)
7665 (match-string 2)))))
7667 (defvar orgstruct-mode) ; defined below
7669 (defun org-heading-components ()
7670 "Return the components of the current heading.
7671 This is a list with the following elements:
7672 - the level as an integer
7673 - the reduced level, different if `org-odd-levels-only' is set.
7674 - the TODO keyword, or nil
7675 - the priority character, like ?A, or nil if no priority is given
7676 - the headline text itself, or the tags string if no headline text
7677 - the tags string, or nil."
7678 (save-excursion
7679 (org-back-to-heading t)
7680 (if (let (case-fold-search)
7681 (looking-at
7682 (if orgstruct-mode
7683 org-heading-regexp
7684 org-complex-heading-regexp)))
7685 (if orgstruct-mode
7686 (list (length (match-string 1))
7687 (org-reduced-level (length (match-string 1)))
7688 nil
7689 nil
7690 (match-string 2)
7691 nil)
7692 (list (length (match-string 1))
7693 (org-reduced-level (length (match-string 1)))
7694 (org-match-string-no-properties 2)
7695 (and (match-end 3) (aref (match-string 3) 2))
7696 (org-match-string-no-properties 4)
7697 (org-match-string-no-properties 5))))))
7699 (defun org-get-entry ()
7700 "Get the entry text, after heading, entire subtree."
7701 (save-excursion
7702 (org-back-to-heading t)
7703 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7705 (defun org-insert-heading-after-current ()
7706 "Insert a new heading with same level as current, after current subtree."
7707 (interactive)
7708 (org-back-to-heading)
7709 (org-insert-heading)
7710 (org-move-subtree-down)
7711 (end-of-line 1))
7713 (defun org-insert-heading-respect-content (&optional arg invisible-ok)
7714 "Insert heading with `org-insert-heading-respect-content' set to t."
7715 (interactive "P")
7716 (let ((org-insert-heading-respect-content t))
7717 (org-insert-heading arg invisible-ok)))
7719 (defun org-insert-todo-heading-respect-content (&optional force-state)
7720 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7721 (interactive "P")
7722 (let ((org-insert-heading-respect-content t))
7723 (org-insert-todo-heading force-state t)))
7725 (defun org-insert-todo-heading (arg &optional force-heading)
7726 "Insert a new heading with the same level and TODO state as current heading.
7727 If the heading has no TODO state, or if the state is DONE, use the first
7728 state (TODO by default). Also one prefix arg, force first state. With two
7729 prefix args, force inserting at the end of the parent subtree."
7730 (interactive "P")
7731 (when (or force-heading (not (org-insert-item 'checkbox)))
7732 (org-insert-heading (or (and (equal arg '(16)) '(16))
7733 force-heading))
7734 (save-excursion
7735 (org-back-to-heading)
7736 (outline-previous-heading)
7737 (looking-at org-todo-line-regexp))
7738 (let*
7739 ((new-mark-x
7740 (if (or arg
7741 (not (match-beginning 2))
7742 (member (match-string 2) org-done-keywords))
7743 (car org-todo-keywords-1)
7744 (match-string 2)))
7745 (new-mark
7746 (or
7747 (run-hook-with-args-until-success
7748 'org-todo-get-default-hook new-mark-x nil)
7749 new-mark-x)))
7750 (beginning-of-line 1)
7751 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7752 (if org-treat-insert-todo-heading-as-state-change
7753 (org-todo new-mark)
7754 (insert new-mark " "))))
7755 (when org-provide-todo-statistics
7756 (org-update-parent-todo-statistics))))
7758 (defun org-insert-subheading (arg)
7759 "Insert a new subheading and demote it.
7760 Works for outline headings and for plain lists alike."
7761 (interactive "P")
7762 (org-insert-heading arg)
7763 (cond
7764 ((org-at-heading-p) (org-do-demote))
7765 ((org-at-item-p) (org-indent-item))))
7767 (defun org-insert-todo-subheading (arg)
7768 "Insert a new subheading with TODO keyword or checkbox and demote it.
7769 Works for outline headings and for plain lists alike."
7770 (interactive "P")
7771 (org-insert-todo-heading arg)
7772 (cond
7773 ((org-at-heading-p) (org-do-demote))
7774 ((org-at-item-p) (org-indent-item))))
7776 ;;; Promotion and Demotion
7778 (defvar org-after-demote-entry-hook nil
7779 "Hook run after an entry has been demoted.
7780 The cursor will be at the beginning of the entry.
7781 When a subtree is being demoted, the hook will be called for each node.")
7783 (defvar org-after-promote-entry-hook nil
7784 "Hook run after an entry has been promoted.
7785 The cursor will be at the beginning of the entry.
7786 When a subtree is being promoted, the hook will be called for each node.")
7788 (defun org-promote-subtree ()
7789 "Promote the entire subtree.
7790 See also `org-promote'."
7791 (interactive)
7792 (save-excursion
7793 (org-with-limited-levels (org-map-tree 'org-promote)))
7794 (org-fix-position-after-promote))
7796 (defun org-demote-subtree ()
7797 "Demote the entire subtree. See `org-demote'.
7798 See also `org-promote'."
7799 (interactive)
7800 (save-excursion
7801 (org-with-limited-levels (org-map-tree 'org-demote)))
7802 (org-fix-position-after-promote))
7805 (defun org-do-promote ()
7806 "Promote the current heading higher up the tree.
7807 If the region is active in `transient-mark-mode', promote all headings
7808 in the region."
7809 (interactive)
7810 (save-excursion
7811 (if (org-region-active-p)
7812 (org-map-region 'org-promote (region-beginning) (region-end))
7813 (org-promote)))
7814 (org-fix-position-after-promote))
7816 (defun org-do-demote ()
7817 "Demote the current heading lower down the tree.
7818 If the region is active in `transient-mark-mode', demote all headings
7819 in the region."
7820 (interactive)
7821 (save-excursion
7822 (if (org-region-active-p)
7823 (org-map-region 'org-demote (region-beginning) (region-end))
7824 (org-demote)))
7825 (org-fix-position-after-promote))
7827 (defun org-fix-position-after-promote ()
7828 "Make sure that after pro/demotion cursor position is right."
7829 (let ((pos (point)))
7830 (when (save-excursion
7831 (beginning-of-line 1)
7832 (looking-at org-todo-line-regexp)
7833 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7834 (cond ((eobp) (insert " "))
7835 ((eolp) (insert " "))
7836 ((equal (char-after) ?\ ) (forward-char 1))))))
7838 (defun org-current-level ()
7839 "Return the level of the current entry, or nil if before the first headline.
7840 The level is the number of stars at the beginning of the headline."
7841 (save-excursion
7842 (org-with-limited-levels
7843 (if (ignore-errors (org-back-to-heading t))
7844 (funcall outline-level)))))
7846 (defun org-get-previous-line-level ()
7847 "Return the outline depth of the last headline before the current line.
7848 Returns 0 for the first headline in the buffer, and nil if before the
7849 first headline."
7850 (let ((current-level (org-current-level))
7851 (prev-level (when (> (line-number-at-pos) 1)
7852 (save-excursion
7853 (beginning-of-line 0)
7854 (org-current-level)))))
7855 (cond ((null current-level) nil) ; Before first headline
7856 ((null prev-level) 0) ; At first headline
7857 (prev-level))))
7859 (defun org-reduced-level (l)
7860 "Compute the effective level of a heading.
7861 This takes into account the setting of `org-odd-levels-only'."
7862 (cond
7863 ((zerop l) 0)
7864 (org-odd-levels-only (1+ (floor (/ l 2))))
7865 (t l)))
7867 (defun org-level-increment ()
7868 "Return the number of stars that will be added or removed at a
7869 time to headlines when structure editing, based on the value of
7870 `org-odd-levels-only'."
7871 (if org-odd-levels-only 2 1))
7873 (defun org-get-valid-level (level &optional change)
7874 "Rectify a level change under the influence of `org-odd-levels-only'
7875 LEVEL is a current level, CHANGE is by how much the level should be
7876 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7877 even level numbers will become the next higher odd number."
7878 (if org-odd-levels-only
7879 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7880 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7881 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7882 (max 1 (+ level (or change 0)))))
7884 (if (boundp 'define-obsolete-function-alias)
7885 (if (or (featurep 'xemacs) (< emacs-major-version 23))
7886 (define-obsolete-function-alias 'org-get-legal-level
7887 'org-get-valid-level)
7888 (define-obsolete-function-alias 'org-get-legal-level
7889 'org-get-valid-level "23.1")))
7891 (defvar org-called-with-limited-levels nil) ;; Dynamically bound in
7892 ;; ̀org-with-limited-levels'
7893 (defun org-promote ()
7894 "Promote the current heading higher up the tree.
7895 If the region is active in `transient-mark-mode', promote all headings
7896 in the region."
7897 (org-back-to-heading t)
7898 (let* ((level (save-match-data (funcall outline-level)))
7899 (after-change-functions (remove 'flyspell-after-change-function
7900 after-change-functions))
7901 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
7902 (diff (abs (- level (length up-head) -1))))
7903 (cond ((and (= level 1) org-called-with-limited-levels
7904 org-allow-promoting-top-level-subtree)
7905 (replace-match "# " nil t))
7906 ((= level 1)
7907 (error "Cannot promote to level 0. UNDO to recover if necessary"))
7908 (t (replace-match up-head nil t)))
7909 ;; Fixup tag positioning
7910 (unless (= level 1)
7911 (and org-auto-align-tags (org-set-tags nil t))
7912 (if org-adapt-indentation (org-fixup-indentation (- diff))))
7913 (run-hooks 'org-after-promote-entry-hook)))
7915 (defun org-demote ()
7916 "Demote the current heading lower down the tree.
7917 If the region is active in `transient-mark-mode', demote all headings
7918 in the region."
7919 (org-back-to-heading t)
7920 (let* ((level (save-match-data (funcall outline-level)))
7921 (after-change-functions (remove 'flyspell-after-change-function
7922 after-change-functions))
7923 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
7924 (diff (abs (- level (length down-head) -1))))
7925 (replace-match down-head nil t)
7926 ;; Fixup tag positioning
7927 (and org-auto-align-tags (org-set-tags nil t))
7928 (if org-adapt-indentation (org-fixup-indentation diff))
7929 (run-hooks 'org-after-demote-entry-hook)))
7931 (defun org-cycle-level ()
7932 "Cycle the level of an empty headline through possible states.
7933 This goes first to child, then to parent, level, then up the hierarchy.
7934 After top level, it switches back to sibling level."
7935 (interactive)
7936 (let ((org-adapt-indentation nil))
7937 (when (org-point-at-end-of-empty-headline)
7938 (setq this-command 'org-cycle-level) ; Only needed for caching
7939 (let ((cur-level (org-current-level))
7940 (prev-level (org-get-previous-line-level)))
7941 (cond
7942 ;; If first headline in file, promote to top-level.
7943 ((= prev-level 0)
7944 (loop repeat (/ (- cur-level 1) (org-level-increment))
7945 do (org-do-promote)))
7946 ;; If same level as prev, demote one.
7947 ((= prev-level cur-level)
7948 (org-do-demote))
7949 ;; If parent is top-level, promote to top level if not already.
7950 ((= prev-level 1)
7951 (loop repeat (/ (- cur-level 1) (org-level-increment))
7952 do (org-do-promote)))
7953 ;; If top-level, return to prev-level.
7954 ((= cur-level 1)
7955 (loop repeat (/ (- prev-level 1) (org-level-increment))
7956 do (org-do-demote)))
7957 ;; If less than prev-level, promote one.
7958 ((< cur-level prev-level)
7959 (org-do-promote))
7960 ;; If deeper than prev-level, promote until higher than
7961 ;; prev-level.
7962 ((> cur-level prev-level)
7963 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
7964 do (org-do-promote))))
7965 t))))
7967 (defun org-map-tree (fun)
7968 "Call FUN for every heading underneath the current one."
7969 (org-back-to-heading)
7970 (let ((level (funcall outline-level)))
7971 (save-excursion
7972 (funcall fun)
7973 (while (and (progn
7974 (outline-next-heading)
7975 (> (funcall outline-level) level))
7976 (not (eobp)))
7977 (funcall fun)))))
7979 (defun org-map-region (fun beg end)
7980 "Call FUN for every heading between BEG and END."
7981 (let ((org-ignore-region t))
7982 (save-excursion
7983 (setq end (copy-marker end))
7984 (goto-char beg)
7985 (if (and (re-search-forward org-outline-regexp-bol nil t)
7986 (< (point) end))
7987 (funcall fun))
7988 (while (and (progn
7989 (outline-next-heading)
7990 (< (point) end))
7991 (not (eobp)))
7992 (funcall fun)))))
7994 (defvar org-property-end-re) ; silence byte-compiler
7995 (defun org-fixup-indentation (diff)
7996 "Change the indentation in the current entry by DIFF.
7997 However, if any line in the current entry has no indentation, or if it
7998 would end up with no indentation after the change, nothing at all is done."
7999 (save-excursion
8000 (let ((end (save-excursion (outline-next-heading)
8001 (point-marker)))
8002 (prohibit (if (> diff 0)
8005 col)
8006 (unless (save-excursion (end-of-line 1)
8007 (re-search-forward prohibit end t))
8008 (while (and (< (point) end)
8010 (goto-char (match-end 0))
8011 (setq col (current-column))
8012 (if (< diff 0) (replace-match ""))
8013 (org-indent-to-column (+ diff col))))
8014 (move-marker end nil))))
8016 (defun org-convert-to-odd-levels ()
8017 "Convert an org-mode file with all levels allowed to one with odd levels.
8018 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8019 level 5 etc."
8020 (interactive)
8021 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8022 (let ((outline-level 'org-outline-level)
8023 (org-odd-levels-only nil) n)
8024 (save-excursion
8025 (goto-char (point-min))
8027 (setq n (- (length (match-string 0)) 2))
8028 (while (>= (setq n (1- n)) 0)
8029 (org-demote))
8030 (end-of-line 1))))))
8032 (defun org-convert-to-oddeven-levels ()
8033 "Convert an org-mode file with only odd levels to one with odd/even levels.
8034 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8035 file contains a section with an even level, conversion would
8036 destroy the structure of the file. An error is signaled in this
8037 case."
8038 (interactive)
8039 (goto-char (point-min))
8040 ;; First check if there are no even levels
8042 (org-show-context t)
8043 (error "Not all levels are odd in this file. Conversion not possible"))
8044 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8045 (let ((outline-regexp org-outline-regexp)
8046 (outline-level 'org-outline-level)
8047 (org-odd-levels-only nil) n)
8048 (save-excursion
8049 (goto-char (point-min))
8051 (setq n (/ (1- (length (match-string 0))) 2))
8052 (while (>= (setq n (1- n)) 0)
8053 (org-promote))
8054 (end-of-line 1))))))
8056 (defun org-tr-level (n)
8057 "Make N odd if required."
8058 (if org-odd-levels-only (1+ (/ n 2)) n))
8060 ;;; Vertical tree motion, cutting and pasting of subtrees
8062 (defun org-move-subtree-up (&optional arg)
8063 "Move the current subtree up past ARG headlines of the same level."
8064 (interactive "p")
8065 (org-move-subtree-down (- (prefix-numeric-value arg))))
8067 (defun org-move-subtree-down (&optional arg)
8068 "Move the current subtree down past ARG headlines of the same level."
8069 (interactive "p")
8070 (setq arg (prefix-numeric-value arg))
8071 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8072 'org-get-last-sibling))
8073 (ins-point (make-marker))
8074 (cnt (abs arg))
8075 (col (current-column))
8076 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8077 ;; Select the tree
8078 (org-back-to-heading)
8079 (setq beg0 (point))
8080 (save-excursion
8081 (setq ne-beg (org-back-over-empty-lines))
8082 (setq beg (point)))
8083 (save-match-data
8084 (save-excursion (outline-end-of-heading)
8085 (setq folded (outline-invisible-p)))
8086 (outline-end-of-subtree))
8087 (outline-next-heading)
8088 (setq ne-end (org-back-over-empty-lines))
8089 (setq end (point))
8090 (goto-char beg0)
8091 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8092 ;; include less whitespace
8093 (save-excursion
8094 (goto-char beg)
8095 (forward-line (- ne-beg ne-end))
8096 (setq beg (point))))
8097 ;; Find insertion point, with error handling
8098 (while (> cnt 0)
8099 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8100 (progn (goto-char beg0)
8101 (user-error "Cannot move past superior level or buffer limit")))
8102 (setq cnt (1- cnt)))
8103 (if (> arg 0)
8104 ;; Moving forward - still need to move over subtree
8105 (progn (org-end-of-subtree t t)
8106 (save-excursion
8107 (org-back-over-empty-lines)
8108 (or (bolp) (newline)))))
8109 (setq ne-ins (org-back-over-empty-lines))
8110 (move-marker ins-point (point))
8111 (setq txt (buffer-substring beg end))
8112 (org-save-markers-in-region beg end)
8113 (delete-region beg end)
8114 (org-remove-empty-overlays-at beg)
8115 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8116 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8118 (let ((bbb (point)))
8119 (insert-before-markers txt)
8120 (org-reinstall-markers-in-region bbb)
8121 (move-marker ins-point bbb))
8123 (setq ins-end (point))
8124 (goto-char ins-point)
8125 (org-skip-whitespace)
8126 (when (and (< arg 0)
8127 (org-first-sibling-p)
8128 (> ne-ins ne-beg))
8129 ;; Move whitespace back to beginning
8130 (save-excursion
8131 (goto-char ins-end)
8132 (let ((kill-whole-line t))
8133 (kill-line (- ne-ins ne-beg)) (point)))
8135 (move-marker ins-point nil)
8136 (if folded
8137 (hide-subtree)
8138 (org-show-entry)
8139 (show-children)
8140 (org-cycle-hide-drawers 'children))
8141 (org-clean-visibility-after-subtree-move)
8142 ;; move back to the initial column we were at
8143 (move-to-column col)))
8145 (defvar org-subtree-clip ""
8146 "Clipboard for cut and paste of subtrees.
8147 This is actually only a copy of the kill, because we use the normal kill
8148 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8150 (defvar org-subtree-clip-folded nil
8151 "Was the last copied subtree folded?
8152 This is used to fold the tree back after pasting.")
8154 (defun org-cut-subtree (&optional n)
8155 "Cut the current subtree into the clipboard.
8156 With prefix arg N, cut this many sequential subtrees.
8157 This is a short-hand for marking the subtree and then cutting it."
8158 (interactive "p")
8159 (org-copy-subtree n 'cut))
8161 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8162 "Cut the current subtree into the clipboard.
8163 With prefix arg N, cut this many sequential subtrees.
8164 This is a short-hand for marking the subtree and then copying it.
8165 If CUT is non-nil, actually cut the subtree.
8166 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8167 of some markers in the region, even if CUT is non-nil. This is
8168 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8169 (interactive "p")
8170 (let (beg end folded (beg0 (point)))
8171 (if (org-called-interactively-p 'any)
8172 (org-back-to-heading nil) ; take what looks like a subtree
8173 (org-back-to-heading t)) ; take what is really there
8174 (setq beg (point))
8176 (save-match-data
8177 (if nosubtrees
8178 (outline-next-heading)
8179 (save-excursion (outline-end-of-heading)
8180 (setq folded (outline-invisible-p)))
8181 (condition-case nil
8182 (org-forward-heading-same-level (1- n) t)
8183 (error nil))
8184 (org-end-of-subtree t t)))
8185 (setq end (point))
8186 (goto-char beg0)
8187 (when (> end beg)
8188 (setq org-subtree-clip-folded folded)
8189 (when (or cut force-store-markers)
8190 (org-save-markers-in-region beg end))
8191 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8192 (setq org-subtree-clip (current-kill 0))
8193 (message "%s: Subtree(s) with %d characters"
8194 (if cut "Cut" "Copied")
8195 (length org-subtree-clip)))))
8197 (defun org-paste-subtree (&optional level tree for-yank)
8198 "Paste the clipboard as a subtree, with modification of headline level.
8199 The entire subtree is promoted or demoted in order to match a new headline
8200 level.
8202 If the cursor is at the beginning of a headline, the same level as
8203 that headline is used to paste the tree.
8205 If not, the new level is derived from the *visible* headings
8206 before and after the insertion point, and taken to be the inferior headline
8207 level of the two. So if the previous visible heading is level 3 and the
8208 next is level 4 (or vice versa), level 4 will be used for insertion.
8209 This makes sure that the subtree remains an independent subtree and does
8210 not swallow low level entries.
8212 You can also force a different level, either by using a numeric prefix
8213 argument, or by inserting the heading marker by hand. For example, if the
8216 If optional TREE is given, use this text instead of the kill ring.
8218 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8219 move back over whitespace before inserting, and move point to the end of
8220 the inserted text when done."
8221 (interactive "P")
8222 (setq tree (or tree (and kill-ring (current-kill 0))))
8223 (unless (org-kill-is-subtree-p tree)
8224 (error "%s"
8225 (substitute-command-keys
8227 (org-with-limited-levels
8228 (let* ((visp (not (outline-invisible-p)))
8229 (txt tree)
8231 (old-level (if (string-match org-outline-regexp-bol txt)
8232 (- (match-end 0) (match-beginning 0) 1)
8233 -1))
8234 (force-level (cond (level (prefix-numeric-value level))
8236 (string-match
8238 (point-at-bol) (point))))
8239 (- (match-end 1) (match-beginning 1)))
8240 ((and (bolp)
8241 (looking-at org-outline-regexp))
8242 (- (match-end 0) (point) 1))))
8243 (previous-level (save-excursion
8244 (condition-case nil
8245 (progn
8246 (outline-previous-visible-heading 1)
8247 (if (looking-at ^re_)
8248 (- (match-end 0) (match-beginning 0) 1)
8249 1))
8250 (error 1))))
8251 (next-level (save-excursion
8252 (condition-case nil
8253 (progn
8254 (or (looking-at org-outline-regexp)
8255 (outline-next-visible-heading 1))
8256 (if (looking-at ^re_)
8257 (- (match-end 0) (match-beginning 0) 1)
8258 1))
8259 (error 1))))
8260 (new-level (or force-level (max previous-level next-level)))
8261 (shift (if (or (= old-level -1)
8262 (= new-level -1)
8263 (= old-level new-level))
8264 0
8265 (- new-level old-level)))
8266 (delta (if (> shift 0) -1 1))
8267 (func (if (> shift 0) 'org-demote 'org-promote))
8268 (org-odd-levels-only nil)
8269 beg end newend)
8270 ;; Remove the forced level indicator
8271 (if force-level
8272 (delete-region (point-at-bol) (point)))
8273 ;; Paste
8274 (beginning-of-line (if (bolp) 1 2))
8275 (setq beg (point))
8276 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8277 (insert-before-markers txt)
8279 (setq newend (point))
8280 (org-reinstall-markers-in-region beg)
8281 (setq end (point))
8282 (goto-char beg)
8284 (setq beg (point))
8285 (if (and (outline-invisible-p) visp)
8286 (save-excursion (outline-show-heading)))
8287 ;; Shift if necessary
8288 (unless (= shift 0)
8289 (save-restriction
8290 (narrow-to-region beg end)
8291 (while (not (= shift 0))
8292 (org-map-region func (point-min) (point-max))
8293 (setq shift (+ delta shift)))
8294 (goto-char (point-min))
8295 (setq newend (point-max))))
8296 (when (or (org-called-interactively-p 'interactive) for-yank)
8297 (message "Clipboard pasted as level %d subtree" new-level))
8298 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8299 kill-ring
8300 (eq org-subtree-clip (current-kill 0))
8301 org-subtree-clip-folded)
8302 ;; The tree was folded before it was killed/copied
8303 (hide-subtree))
8304 (and for-yank (goto-char newend)))))
8306 (defun org-kill-is-subtree-p (&optional txt)
8307 "Check if the current kill is an outline subtree, or a set of trees.
8308 Returns nil if kill does not start with a headline, or if the first
8309 headline level is not the largest headline level in the tree.
8310 So this will actually accept several entries of equal levels as well,
8311 which is OK for `org-paste-subtree'.
8312 If optional TXT is given, check this string instead of the current kill."
8313 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8314 (re (org-get-limited-outline-regexp))
8315 (^re (concat "^" re))
8316 (start-level (and kill
8317 (string-match
8319 kill)
8320 (- (match-end 2) (match-beginning 2) 1)))
8321 (start (1+ (or (match-beginning 2) -1))))
8322 (if (not start-level)
8323 (progn
8324 nil) ;; does not even start with a heading
8325 (catch 'exit
8326 (while (setq start (string-match ^re kill (1+ start)))
8327 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8328 (throw 'exit nil)))
8329 t))))
8331 (defvar org-markers-to-move nil
8332 "Markers that should be moved with a cut-and-paste operation.
8333 Those markers are stored together with their positions relative to
8334 the start of the region.")
8336 (defun org-save-markers-in-region (beg end)
8337 "Check markers in region.
8338 If these markers are between BEG and END, record their position relative
8339 to BEG, so that after moving the block of text, we can put the markers back
8340 into place.
8341 This function gets called just before an entry or tree gets cut from the
8342 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8343 called immediately, to move the markers with the entries."
8344 (setq org-markers-to-move nil)
8345 (when (featurep 'org-clock)
8346 (org-clock-save-markers-for-cut-and-paste beg end))
8347 (when (featurep 'org-agenda)
8348 (org-agenda-save-markers-for-cut-and-paste beg end)))
8350 (defun org-check-and-save-marker (marker beg end)
8351 "Check if MARKER is between BEG and END.
8352 If yes, remember the marker and the distance to BEG."
8353 (when (and (marker-buffer marker)
8354 (equal (marker-buffer marker) (current-buffer)))
8355 (if (and (>= marker beg) (< marker end))
8356 (push (cons marker (- marker beg)) org-markers-to-move))))
8358 (defun org-reinstall-markers-in-region (beg)
8359 "Move all remembered markers to their position relative to BEG."
8360 (mapc (lambda (x)
8361 (move-marker (car x) (+ beg (cdr x))))
8362 org-markers-to-move)
8363 (setq org-markers-to-move nil))
8365 (defun org-narrow-to-subtree ()
8366 "Narrow buffer to the current subtree."
8367 (interactive)
8368 (save-excursion
8369 (save-match-data
8370 (org-with-limited-levels
8371 (narrow-to-region
8372 (progn (org-back-to-heading t) (point))
8373 (progn (org-end-of-subtree t t)
8374 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8375 (point)))))))
8377 (defun org-narrow-to-block ()
8378 "Narrow buffer to the current block."
8379 (interactive)
8380 (let* ((case-fold-search t)
8383 (if blockp
8384 (narrow-to-region (car blockp) (cdr blockp))
8385 (error "Not in a block"))))
8387 (eval-when-compile
8388 (defvar org-property-drawer-re))
8390 (defvar org-property-start-re) ;; defined below
8391 (defun org-clone-subtree-with-time-shift (n &optional shift)
8392 "Clone the task (subtree) at point N times.
8393 The clones will be inserted as siblings.
8395 In interactive use, the user will be prompted for the number of
8396 clones to be produced. When called with a universal prefix argument
8397 and if the entry has a timestamp, the user will also be prompted for
8398 a time shift, which may be a repeater as used in time stamps, for
8399 example `+3d'.
8401 When a valid repeater is given and the entry contains any time
8402 stamps, the clones will become a sequence in time, with time
8403 stamps in the subtree shifted for each clone produced. If SHIFT
8404 is nil or the empty string, time stamps will be left alone. The
8405 ID property of the original subtree is removed.
8407 If the original subtree did contain time stamps with a repeater,
8408 the following will happen:
8409 - the repeater will be removed in each clone
8410 - an additional clone will be produced, with the current, unshifted
8411 date(s) in the entry.
8412 - the original entry will be placed *after* all the clones, with
8413 repeater intact.
8414 - the start days in the repeater in the original entry will be shifted
8415 to past the last clone.
8416 In this way you can spell out a number of instances of a repeating task,
8417 and still retain the repeater to cover future instances of the task."
8418 (interactive "nNumber of clones to produce: ")
8419 (let ((shift
8420 (or shift
8421 (if (and (equal current-prefix-arg '(4))
8422 (save-excursion
8423 (re-search-forward org-ts-regexp-both
8424 (save-excursion
8425 (org-end-of-subtree t)
8426 (point)) t)))
8427 (read-from-minibuffer
8428 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8429 ""))) ;; No time shift
8430 (n-no-remove -1)
8431 (drawer-re org-drawer-regexp)
8432 beg end template task idprop
8433 shift-n shift-what doshift nmin nmax)
8434 (if (not (and (integerp n) (> n 0)))
8435 (error "Invalid number of replications %s" n))
8438 shift)))
8439 (error "Invalid shift specification %s" shift))
8440 (when doshift
8441 (setq shift-n (string-to-number (match-string 1 shift))
8442 shift-what (cdr (assoc (match-string 2 shift)
8443 '(("d" . day) ("w" . week)
8444 ("m" . month) ("y" . year))))))
8445 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8446 (setq nmin 1 nmax n)
8447 (org-back-to-heading t)
8448 (setq beg (point))
8449 (setq idprop (org-entry-get nil "ID"))
8450 (org-end-of-subtree t t)
8452 (setq end (point))
8453 (setq template (buffer-substring beg end))
8454 (when (and doshift
8456 (delete-region beg end)
8457 (setq end beg)
8458 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8459 (goto-char end)
8460 (loop for n from nmin to nmax do
8461 ;; prepare clone
8462 (with-temp-buffer
8463 (insert template)
8464 (org-mode)
8465 (goto-char (point-min))
8466 (org-show-subtree)
8467 (and idprop (if org-clone-delete-id
8468 (org-entry-delete nil "ID")
8469 (org-id-get-create t)))
8470 (unless (= n 0)
8472 (kill-whole-line))
8473 (goto-char (point-min))
8474 (while (re-search-forward drawer-re nil t)
8475 (mapc (lambda (d)
8476 (org-remove-empty-drawer-at d (point))) org-drawers)))
8477 (goto-char (point-min))
8478 (when doshift
8479 (while (re-search-forward org-ts-regexp-both nil t)
8480 (org-timestamp-change (* n shift-n) shift-what))
8481 (unless (= n n-no-remove)
8482 (goto-char (point-min))
8483 (while (re-search-forward org-ts-regexp nil t)
8484 (save-excursion
8485 (goto-char (match-beginning 0))
8487 (delete-region (match-beginning 1) (match-end 1)))))))
8488 (setq task (buffer-string)))
8489 (insert task))
8490 (goto-char beg)))
8492 ;;; Outline Sorting
8494 (defun org-sort (with-case)
8495 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8496 Optional argument WITH-CASE means sort case-sensitively."
8497 (interactive "P")
8498 (cond
8499 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8500 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8501 (t
8502 (org-call-with-arg 'org-sort-entries with-case))))
8504 (defun org-sort-remove-invisible (s)
8505 "Remove invisible links from string S."
8506 (remove-text-properties 0 (length s) org-rm-props s)
8507 (while (string-match org-bracket-link-regexp s)
8508 (setq s (replace-match (if (match-end 2)
8509 (match-string 3 s)
8510 (match-string 1 s)) t t s)))
8511 (let ((st (format " %s " s)))
8512 (while (string-match org-emph-re st)
8513 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8514 (setq s (substring st 1 -1)))
8515 s)
8517 (defvar org-priority-regexp) ; defined later in the file
8519 (defvar org-after-sorting-entries-or-items-hook nil
8520 "Hook that is run after a bunch of entries or items have been sorted.
8521 When children are sorted, the cursor is in the parent line when this
8522 hook gets called. When a region or a plain list is sorted, the cursor
8523 will be in the first entry of the sorted region/list.")
8525 (defun org-sort-entries
8526 (&optional with-case sorting-type getkey-func compare-func property)
8527 "Sort entries on a certain level of an outline tree.
8528 If there is an active region, the entries in the region are sorted.
8529 Else, if the cursor is before the first entry, sort the top-level items.
8530 Else, the children of the entry at point are sorted.
8532 Sorting can be alphabetically, numerically, by date/time as given by
8533 a time stamp, by a property, by priority order, or by a custom function.
8535 The command prompts for the sorting type unless it has been given to the
8536 function through the SORTING-TYPE argument, which needs to be a character,
8537 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
8538 precise meaning of each character:
8540 n Numerically, by converting the beginning of the entry/item to a number.
8541 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8542 o By order of TODO keywords.
8543 t By date/time, either the first active time stamp in the entry, or, if
8544 none exist, by the first inactive one.
8545 s By the scheduled date/time.
8546 d By deadline date/time.
8547 c By creation time, which is assumed to be the first inactive time stamp
8548 at the beginning of a line.
8549 p By priority according to the cookie.
8550 r By the value of a property.
8552 Capital letters will reverse the sort order.
8554 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8555 called with point at the beginning of the record. It must return either
8556 a string or a number that should serve as the sorting key for that record.
8558 Comparing entries ignores case by default. However, with an optional argument
8559 WITH-CASE, the sorting considers case as well.
8561 Sorting is done against the visible part of the headlines, it ignores hidden
8562 links."
8563 (interactive "P")
8564 (let ((case-func (if with-case 'identity 'downcase))
8565 (cmstr
8566 ;; The clock marker is lost when using `sort-subr', let's
8567 ;; store the clocking string.
8568 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8569 (save-excursion
8570 (goto-char org-clock-marker)
8571 (looking-back "^.*") (match-string-no-properties 0))))
8572 start beg end stars re re2
8573 txt what tmp)
8574 ;; Find beginning and end of region to sort
8575 (cond
8576 ((org-region-active-p)
8577 ;; we will sort the region
8578 (setq end (region-end)
8579 what "region")
8580 (goto-char (region-beginning))
8581 (if (not (org-at-heading-p)) (outline-next-heading))
8582 (setq start (point)))
8583 ((or (org-at-heading-p)
8584 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8585 ;; we will sort the children of the current headline
8586 (org-back-to-heading)
8587 (setq start (point)
8588 end (progn (org-end-of-subtree t t)
8590 (org-back-over-empty-lines)
8591 (point))
8592 what "children")
8593 (goto-char start)
8594 (show-subtree)
8595 (outline-next-heading))
8596 (t
8597 ;; we will sort the top-level entries in this file
8598 (goto-char (point-min))
8599 (or (org-at-heading-p) (outline-next-heading))
8600 (setq start (point))
8601 (goto-char (point-max))
8602 (beginning-of-line 1)
8604 ;; File ends in a non-white line
8605 (end-of-line 1)
8607 (setq end (point-max))
8608 (setq what "top-level")
8609 (goto-char start)
8610 (show-all)))
8612 (setq beg (point))
8613 (if (>= beg end) (error "Nothing to sort"))
8616 (setq stars (match-string 1)
8617 re (concat "^" (regexp-quote stars) " +")
8619 txt (buffer-substring beg end))
8621 (if (and (not (equal stars "*")) (string-match re2 txt))
8622 (error "Region to sort contains a level above the first entry"))
8624 (unless sorting-type
8625 (message
8626 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8628 A/N/P/R/O/F/T/S/D/C means reversed:"
8629 what)
8630 (setq sorting-type (read-char-exclusive))
8632 (unless getkey-func
8633 (and (= (downcase sorting-type) ?f)
8634 (setq getkey-func
8635 (org-icompleting-read "Sort using function: "
8636 obarray 'fboundp t nil nil))
8637 (setq getkey-func (intern getkey-func))))
8639 (and (= (downcase sorting-type) ?r)
8640 (not property)
8641 (setq property
8642 (org-icompleting-read "Property: "
8643 (mapcar 'list (org-buffer-property-keys t))
8644 nil t))))
8646 (message "Sorting entries...")
8648 (save-restriction
8649 (narrow-to-region start end)
8650 (let ((dcst (downcase sorting-type))
8651 (case-fold-search nil)
8652 (now (current-time)))
8653 (sort-subr
8654 (/= dcst sorting-type)
8655 ;; This function moves to the beginning character of the "record" to
8656 ;; be sorted.
8657 (lambda nil
8658 (if (re-search-forward re nil t)
8659 (goto-char (match-beginning 0))
8660 (goto-char (point-max))))
8661 ;; This function moves to the last character of the "record" being
8662 ;; sorted.
8663 (lambda nil
8664 (save-match-data
8665 (condition-case nil
8666 (outline-forward-same-level 1)
8667 (error
8668 (goto-char (point-max))))))
8669 ;; This function returns the value that gets sorted against.
8670 (lambda nil
8671 (cond
8672 ((= dcst ?n)
8673 (if (looking-at org-complex-heading-regexp)
8674 (string-to-number (org-sort-remove-invisible (match-string 4)))
8675 nil))
8676 ((= dcst ?a)
8677 (if (looking-at org-complex-heading-regexp)
8678 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8679 nil))
8680 ((= dcst ?t)
8681 (let ((end (save-excursion (outline-next-heading) (point))))
8682 (if (or (re-search-forward org-ts-regexp end t)
8683 (re-search-forward org-ts-regexp-both end t))
8684 (org-time-string-to-seconds (match-string 0))
8685 (org-float-time now))))
8686 ((= dcst ?c)
8687 (let ((end (save-excursion (outline-next-heading) (point))))
8688 (if (re-search-forward
8690 end t)
8691 (org-time-string-to-seconds (match-string 0))
8692 (org-float-time now))))
8693 ((= dcst ?s)
8694 (let ((end (save-excursion (outline-next-heading) (point))))
8695 (if (re-search-forward org-scheduled-time-regexp end t)
8696 (org-time-string-to-seconds (match-string 1))
8697 (org-float-time now))))
8698 ((= dcst ?d)
8699 (let ((end (save-excursion (outline-next-heading) (point))))
8700 (if (re-search-forward org-deadline-time-regexp end t)
8701 (org-time-string-to-seconds (match-string 1))
8702 (org-float-time now))))
8703 ((= dcst ?p)
8704 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8705 (string-to-char (match-string 2))
8706 org-default-priority))
8707 ((= dcst ?r)
8708 (or (org-entry-get nil property) ""))
8709 ((= dcst ?o)
8710 (if (looking-at org-complex-heading-regexp)
8711 (- 9999 (length (member (match-string 2)
8712 org-todo-keywords-1)))))
8713 ((= dcst ?f)
8714 (if getkey-func
8715 (progn
8716 (setq tmp (funcall getkey-func))
8717 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8718 tmp)
8719 (error "Invalid key function `%s'" getkey-func)))
8720 (t (error "Invalid sorting type `%c'" sorting-type))))
8721 nil
8722 (cond
8723 ((= dcst ?a) 'string<)
8724 ((= dcst ?f) compare-func)
8725 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8726 (run-hooks 'org-after-sorting-entries-or-items-hook)
8727 ;; Reset the clock marker if needed
8728 (when cmstr
8729 (save-excursion
8730 (goto-char start)
8731 (search-forward cmstr nil t)
8732 (move-marker org-clock-marker (point))))
8733 (message "Sorting entries...done")))
8735 (defun org-do-sort (table what &optional with-case sorting-type)
8736 "Sort TABLE of WHAT according to SORTING-TYPE.
8737 The user will be prompted for the SORTING-TYPE if the call to this
8738 function does not specify it. WHAT is only for the prompt, to indicate
8739 what is being sorted. The sorting key will be extracted from
8740 the car of the elements of the table.
8741 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8742 (unless sorting-type
8743 (message
8744 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8745 what)
8746 (setq sorting-type (read-char-exclusive)))
8747 (let ((dcst (downcase sorting-type))
8748 extractfun comparefun)
8749 ;; Define the appropriate functions
8750 (cond
8751 ((= dcst ?n)
8752 (setq extractfun 'string-to-number
8753 comparefun (if (= dcst sorting-type) '< '>)))
8754 ((= dcst ?a)
8755 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8756 (lambda(x) (downcase (org-sort-remove-invisible x))))
8757 comparefun (if (= dcst sorting-type)
8758 'string<
8759 (lambda (a b) (and (not (string< a b))
8760 (not (string= a b)))))))
8761 ((= dcst ?t)
8762 (setq extractfun
8763 (lambda (x)
8764 (if (or (string-match org-ts-regexp x)
8765 (string-match org-ts-regexp-both x))
8766 (org-float-time
8767 (org-time-string-to-time (match-string 0 x)))
8768 0))
8769 comparefun (if (= dcst sorting-type) '< '>)))
8770 (t (error "Invalid sorting type `%c'" sorting-type)))
8772 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8773 table)
8774 (lambda (a b) (funcall comparefun (car a) (car b))))))
8777 ;;; The orgstruct minor mode
8779 ;; Define a minor mode which can be used in other modes in order to
8780 ;; integrate the org-mode structure editing commands.
8782 ;; This is really a hack, because the org-mode structure commands use
8783 ;; keys which normally belong to the major mode. Here is how it
8784 ;; works: The minor mode defines all the keys necessary to operate the
8785 ;; structure commands, but wraps the commands into a function which
8786 ;; tests if the cursor is currently at a headline or a plain list
8787 ;; item. If that is the case, the structure command is used,
8788 ;; temporarily setting many Org-mode variables like regular
8789 ;; expressions for filling etc. However, when any of those keys is
8790 ;; used at a different location, function uses `key-binding' to look
8791 ;; up if the key has an associated command in another currently active
8792 ;; keymap (minor modes, major mode, global), and executes that
8793 ;; command. There might be problems if any of the keys is otherwise
8794 ;; used as a prefix key.
8796 (defcustom orgstruct-heading-prefix-regexp nil
8797 "Regexp that matches the custom prefix of Org headlines in
8798 orgstruct(++)-mode."
8799 :group 'org
8800 :version "24.4"
8801 :package-version '(Org . "8.0")
8802 :type 'string)
8803 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
8805 (defcustom orgstruct-setup-hook nil
8806 "Hook run after orgstruct-mode-map is filled."
8807 :group 'org
8808 :version "24.4"
8809 :package-version '(Org . "8.0")
8810 :type 'hook)
8812 (defvar orgstruct-initialized nil)
8814 (defvar org-local-vars nil
8815 "List of local variables, for use by `orgstruct-mode'.")
8817 ;;;###autoload
8818 (define-minor-mode orgstruct-mode
8819 "Toggle the minor mode `orgstruct-mode'.
8820 This mode is for using Org-mode structure commands in other
8821 modes. The following keys behave as if Org-mode were active, if
8822 the cursor is on a headline, or on a plain list item (both as
8823 defined by Org-mode)."
8824 nil " OrgStruct" (make-sparse-keymap)
8825 (funcall (if orgstruct-mode
8826 'add-to-invisibility-spec
8827 'remove-from-invisibility-spec)
8828 '(outline . t))
8829 (when orgstruct-mode
8830 (org-load-modules-maybe)
8831 (unless orgstruct-initialized
8832 (orgstruct-setup)
8833 (setq orgstruct-initialized t))))
8835 ;;;###autoload
8836 (defun turn-on-orgstruct ()
8837 "Unconditionally turn on `orgstruct-mode'."
8838 (orgstruct-mode 1))
8840 (defvar org-fb-vars nil)
8841 (make-variable-buffer-local 'org-fb-vars)
8842 (defun orgstruct++-mode (&optional arg)
8843 "Toggle `orgstruct-mode', the enhanced version of it.
8844 In addition to setting orgstruct-mode, this also exports all
8845 indentation and autofilling variables from org-mode into the
8846 buffer. It will also recognize item context in multiline items."
8847 (interactive "P")
8848 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8849 (if (< arg 1)
8850 (progn (orgstruct-mode -1)
8851 (mapc (lambda(v)
8852 (org-set-local (car v)
8853 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8854 org-fb-vars))
8855 (orgstruct-mode 1)
8856 (setq org-fb-vars nil)
8857 (let (var val)
8858 (mapc
8859 (lambda (x)
8860 (when (string-match
8862 (symbol-name (car x)))
8863 (setq var (car x) val (nth 1 x))
8864 (push (list var `(quote ,(eval var))) org-fb-vars)
8865 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8866 org-local-vars)
8867 (org-set-local 'orgstruct-is-++ t))))
8869 (defvar orgstruct-is-++ nil
8870 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8871 (make-variable-buffer-local 'orgstruct-is-++)
8873 ;;;###autoload
8874 (defun turn-on-orgstruct++ ()
8875 "Unconditionally turn on `orgstruct++-mode'."
8876 (orgstruct++-mode 1))
8878 (defun orgstruct-error ()
8879 "Error when there is no default binding for a structure key."
8880 (interactive)
8881 (funcall (if (fboundp 'user-error)
8882 'user-error
8883 'error)
8884 "This key has no function outside structure elements"))
8886 (defun orgstruct-setup ()
8887 "Setup orgstruct keymap."
8888 (dolist (cell '((org-demote . t)
8889 (org-metaleft . t)
8890 (org-metaright . t)
8891 (org-promote . t)
8892 (org-shiftmetaleft . t)
8893 (org-shiftmetaright . t)
8894 org-backward-element
8895 org-backward-heading-same-level
8896 org-ctrl-c-ret
8897 org-ctrl-c-minus
8898 org-ctrl-c-star
8899 org-cycle
8900 org-forward-heading-same-level
8901 org-insert-heading
8902 org-insert-heading-respect-content
8903 org-kill-note-or-show-branches
8904 org-mark-subtree
8905 org-meta-return
8906 org-metadown
8907 org-metaup
8908 org-narrow-to-subtree
8909 org-promote-subtree
8910 org-reveal
8911 org-shiftdown
8912 org-shiftleft
8913 org-shiftmetadown
8914 org-shiftmetaup
8915 org-shiftright
8916 org-shifttab
8917 org-shifttab
8918 org-shiftup
8919 org-show-subtree
8920 org-sort
8921 org-up-element
8922 outline-demote
8923 outline-next-visible-heading
8924 outline-previous-visible-heading
8925 outline-promote
8926 outline-up-heading
8927 show-children))
8928 (let ((f (or (car-safe cell) cell))
8929 (disable-when-heading-prefix (cdr-safe cell)))
8930 (when (fboundp f)
8931 (dolist (binding (nconc (where-is-internal f org-mode-map)
8932 (where-is-internal f outline-mode-map)))
8933 ;; TODO use local-function-key-map
8934 (dolist (rep '(("<tab>" . "TAB")
8935 ("<return>" . "RET")
8936 ("<escape>" . "ESC")
8937 ("<delete>" . "DEL")))
8938 (setq binding (read-kbd-macro
8939 (let ((case-fold-search))
8940 (replace-regexp-in-string
8941 (regexp-quote (cdr rep))
8942 (car rep)
8943 (key-description binding))))))
8944 (let ((key (lookup-key orgstruct-mode-map binding)))
8945 (when (or (not key) (numberp key))
8946 (condition-case nil
8947 (org-defkey orgstruct-mode-map
8948 binding
8949 (orgstruct-make-binding f binding disable-when-heading-prefix))
8950 (error nil))))))))
8951 (run-hooks 'orgstruct-setup-hook))
8953 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
8954 "Create a function for binding in the structure minor mode.
8955 FUN is the command to call inside a table. KEY is the key that
8956 should be checked in for a command to execute outside of tables.
8957 Non-nil DISABLE-WHEN-HEADING-PREFIX means to disable the command
8958 if `orgstruct-heading-prefix-regexp' is non-nil."
8959 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
8960 (let ((nname name)
8961 (i 0))
8962 (while (fboundp (intern nname))
8963 (setq nname (format "%s-%d" name (setq i (1+ i)))))
8964 (setq name (intern nname)))
8965 (eval
8966 (let ((bindings '((org-heading-regexp
8967 (concat "^"
8968 orgstruct-heading-prefix-regexp
8970 (org-outline-regexp
8972 (org-outline-regexp-bol
8973 (concat "^" org-outline-regexp))
8974 (outline-regexp org-outline-regexp)
8976 (outline-level 'org-outline-level)
8977 (outline-heading-alist))))
8978 `(defun ,name (arg)
8980 "Outside of structure, run the binding of `"
8981 (key-description key) "'."
8982 (when disable-when-heading-prefix
8983 (concat
8986 "`" (symbol-name fun) "'.")))
8987 (interactive "p")
8988 (let* ((disable
8989 ,(when disable-when-heading-prefix
8990 '(and orgstruct-heading-prefix-regexp
8991 (not (string= orgstruct-heading-prefix-regexp "")))))
8992 (fallback
8993 (or disable
8994 (not
8995 (let* ,bindings
8996 (org-context-p 'headline 'item
8997 ,(when (memq fun '(org-insert-heading))
8998 '(when orgstruct-is-++
8999 'item-body))))))))
9000 (if fallback
9001 (let* ((orgstruct-mode)
9002 (binding
9003 (loop with key = ,key
9004 for rep in
9005 '(nil
9010 do
9011 (when rep
9012 (setq key (read-kbd-macro
9013 (let ((case-fold-search))
9014 (replace-regexp-in-string
9015 (car rep)
9016 (cdr rep)
9017 (key-description key))))))
9018 thereis (key-binding key))))
9019 (if (keymapp binding)
9020 (set-temporary-overlay-map binding)
9021 (let ((func (or binding
9022 (unless disable
9023 'orgstruct-error))))
9024 (when func
9025 (call-interactively func)))))
9026 (org-run-like-in-org-mode
9027 (lambda ()
9028 (interactive)
9029 (let* ,bindings
9030 (call-interactively ',fun)))))))))
9031 name))
9033 (defun org-contextualize-keys (alist contexts)
9034 "Return valid elements in ALIST depending on CONTEXTS.
9036 `org-agenda-custom-commands' or `org-capture-templates' are the
9037 values used for ALIST, and `org-agenda-custom-commands-contexts'
9038 or `org-capture-templates-contexts' are the associated contexts
9039 definitions."
9040 (let ((contexts
9041 ;; normalize contexts
9042 (mapcar
9043 (lambda(c) (cond ((listp (cadr c))
9044 (list (car c) (car c) (cadr c)))
9045 ((string= "" (cadr c))
9046 (list (car c) (car c) (caddr c)))
9047 (t c))) contexts))
9048 (a alist) c r s)
9049 ;; loop over all commands or templates
9050 (while (setq c (pop a))
9051 (let (vrules repl)
9052 (cond
9053 ((not (assoc (car c) contexts))
9054 (push c r))
9055 ((and (assoc (car c) contexts)
9056 (setq vrules (org-contextualize-validate-key
9057 (car c) contexts)))
9058 (mapc (lambda (vr)
9059 (when (not (equal (car vr) (cadr vr)))
9060 (setq repl vr))) vrules)
9061 (if (not repl) (push c r)
9062 (push (cadr repl) s)
9063 (push
9064 (cons (car c)
9065 (cdr (or (assoc (cadr repl) alist)
9066 (error "Undefined key `%s' as contextual replacement for `%s'"
9067 (cadr repl) (car c)))))
9068 r))))))
9069 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9070 (delq
9071 nil
9072 (delete-dups
9073 (mapcar (lambda (x)
9074 (let ((tpl (car x)))
9075 (when (not (delq
9076 nil
9077 (mapcar (lambda(y)
9078 (equal y tpl)) s))) x)))
9079 (reverse r))))))
9081 (defun org-contextualize-validate-key (key contexts)
9082 "Check CONTEXTS for agenda or capture KEY."
9083 (let (r rr res)
9084 (while (setq r (pop contexts))
9085 (mapc
9086 (lambda (rr)
9087 (when
9088 (and (equal key (car r))
9089 (if (functionp rr) (funcall rr)
9090 (or (and (eq (car rr) 'in-file)
9091 (buffer-file-name)
9092 (string-match (cdr rr) (buffer-file-name)))
9093 (and (eq (car rr) 'in-mode)
9094 (string-match (cdr rr) (symbol-name major-mode)))
9095 (and (eq (car rr) 'in-buffer)
9096 (string-match (cdr rr) (buffer-name)))
9097 (when (and (eq (car rr) 'not-in-file)
9098 (buffer-file-name))
9099 (not (string-match (cdr rr) (buffer-file-name))))
9100 (when (eq (car rr) 'not-in-mode)
9101 (not (string-match (cdr rr) (symbol-name major-mode))))
9102 (when (eq (car rr) 'not-in-buffer)
9103 (not (string-match (cdr rr) (buffer-name)))))))
9104 (push r res)))
9105 (car (last r))))
9106 (delete-dups (delq nil res))))
9108 (defun org-context-p (&rest contexts)
9109 "Check if local context is any of CONTEXTS.
9110 Possible values in the list of contexts are `table', `headline', and `item'."
9111 (let ((pos (point)))
9112 (goto-char (point-at-bol))
9113 (prog1 (or (and (memq 'table contexts)
9115 (and (memq 'headline contexts)
9116 (looking-at org-outline-regexp))
9117 (and (memq 'item contexts)
9119 (and (memq 'item-body contexts)
9120 (org-in-item-p)))
9121 (goto-char pos))))
9123 (defun org-get-local-variables ()
9124 "Return a list of all local variables in an Org mode buffer."
9125 (let (varlist)
9126 (with-current-buffer (get-buffer-create "*Org tmp*")
9127 (erase-buffer)
9128 (org-mode)
9129 (setq varlist (buffer-local-variables)))
9130 (kill-buffer "*Org tmp*")
9131 (delq nil
9132 (mapcar
9133 (lambda (x)
9134 (setq x
9135 (if (symbolp x)
9136 (list x)
9137 (list (car x) (cdr x))))
9138 (if (and (not (get (car x) 'org-state))
9139 (string-match
9140 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9141 (symbol-name (car x))))
9142 x nil))
9143 varlist))))
9145 (defun org-clone-local-variables (from-buffer &optional regexp)
9146 "Clone local variables from FROM-BUFFER.
9147 Optional argument REGEXP selects variables to clone."
9148 (mapc
9149 (lambda (pair)
9150 (and (symbolp (car pair))
9151 (or (null regexp)
9152 (string-match regexp (symbol-name (car pair))))
9153 (set (make-local-variable (car pair))
9154 (cdr pair))))
9155 (buffer-local-variables from-buffer)))
9157 ;;;###autoload
9158 (defun org-run-like-in-org-mode (cmd)
9159 "Run a command, pretending that the current buffer is in Org-mode.
9160 This will temporarily bind local variables that are typically bound in
9161 Org-mode to the values they have in Org-mode, and then interactively
9162 call CMD."
9163 (org-load-modules-maybe)
9164 (unless org-local-vars
9165 (setq org-local-vars (org-get-local-variables)))
9166 (let (binds)
9167 (dolist (var org-local-vars)
9168 (when (or (not (boundp (car var)))
9169 (eq (symbol-value (car var))
9170 (default-value (car var))))
9171 (push (list (car var) `(quote ,(cadr var))) binds)))
9172 (eval `(let ,binds
9173 (call-interactively (quote ,cmd))))))
9175 ;;;; Archiving
9177 (defun org-get-category (&optional pos force-refresh)
9178 "Get the category applying to position POS."
9179 (save-match-data
9180 (if force-refresh (org-refresh-category-properties))
9181 (let ((pos (or pos (point))))
9182 (or (get-text-property pos 'org-category)
9183 (progn (org-refresh-category-properties)
9184 (get-text-property pos 'org-category))))))
9186 (defun org-refresh-category-properties ()
9187 "Refresh category text properties in the buffer."
9188 (let ((case-fold-search t)
9189 (inhibit-read-only t)
9190 (def-cat (cond
9191 ((null org-category)
9192 (if buffer-file-name
9193 (file-name-sans-extension
9194 (file-name-nondirectory buffer-file-name))
9195 "???"))
9196 ((symbolp org-category) (symbol-name org-category))
9197 (t org-category)))
9198 beg end cat pos optionp)
9199 (org-with-silent-modifications
9200 (save-excursion
9201 (save-restriction
9202 (widen)
9203 (goto-char (point-min))
9204 (put-text-property (point) (point-max) 'org-category def-cat)
9205 (while (re-search-forward
9207 (setq pos (match-end 0)
9208 optionp (equal (char-after (match-beginning 0)) ?#)
9209 cat (org-trim (match-string 2)))
9210 (if optionp
9211 (setq beg (point-at-bol) end (point-max))
9212 (org-back-to-heading t)
9213 (setq beg (point) end (org-end-of-subtree t t)))
9214 (put-text-property beg end 'org-category cat)
9215 (put-text-property beg end 'org-category-position beg)
9216 (goto-char pos)))))))
9218 (defun org-refresh-properties (dprop tprop)
9219 "Refresh buffer text properties.
9220 DPROP is the drawer property and TPROP is the corresponding text
9221 property to set."
9222 (let ((case-fold-search t)
9223 (inhibit-read-only t) p)
9224 (org-with-silent-modifications
9225 (save-excursion
9226 (save-restriction
9227 (widen)
9228 (goto-char (point-min))
9230 (setq p (org-match-string-no-properties 1))
9231 (save-excursion
9232 (org-back-to-heading t)
9233 (put-text-property
9234 (point-at-bol) (point-at-eol) tprop p))))))))
9237 ;;;; Link Stuff
9239 ;;; Link abbreviations
9241 (defun org-link-expand-abbrev (link)
9242 "Apply replacements as defined in `org-link-abbrev-alist'."
9244 (let* ((key (match-string 1 link))
9245 (as (or (assoc key org-link-abbrev-alist-local)
9246 (assoc key org-link-abbrev-alist)))
9247 (tag (and (match-end 2) (match-string 3 link)))
9248 rpl)
9249 (if (not as)
9250 link
9251 (setq rpl (cdr as))
9252 (cond
9253 ((symbolp rpl) (funcall rpl tag))
9255 (replace-match (funcall (intern-soft (match-string 1 rpl)) tag) t t rpl))
9256 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9257 ((string-match "%h" rpl)
9258 (replace-match (url-hexify-string (or tag "")) t t rpl))
9259 (t (concat rpl tag)))))
9260 link))
9262 ;;; Storing and inserting links
9264 (defvar org-insert-link-history nil
9265 "Minibuffer history for links inserted with `org-insert-link'.")
9267 (defvar org-stored-links nil
9268 "Contains the links stored with `org-store-link'.")
9270 (defvar org-store-link-plist nil
9271 "Plist with info about the most recently link created with `org-store-link'.")
9273 (defvar org-link-protocols nil
9274 "Link protocols added to Org-mode using `org-add-link-type'.")
9276 (defvar org-store-link-functions nil
9277 "List of functions that are called to create and store a link.
9278 Each function will be called in turn until one returns a non-nil
9279 value. Each function should check if it is responsible for creating
9280 this link (for example by looking at the major mode).
9281 If not, it must exit and return nil.
9282 If yes, it should return a non-nil value after a calling
9283 `org-store-link-props' with a list of properties and values.
9284 Special properties are:
9288 This is obligatory as well.
9289 :description Optional default description for the second pair
9290 of brackets in an Org-mode link. The user can still change
9291 this when inserting this link into an Org-mode buffer.
9293 In addition to these, any additional properties can be specified
9294 and then used in capture templates.")
9296 (defun org-add-link-type (type &optional follow export)
9297 "Add TYPE to the list of `org-link-types'.
9298 Re-compute all regular expressions depending on `org-link-types'
9300 FOLLOW and EXPORT are two functions.
9302 FOLLOW should take the link path as the single argument and do whatever
9303 is necessary to follow the link, for example find a file or display
9304 a mail message.
9306 EXPORT should format the link path for export to one of the export formats.
9307 It should be a function accepting three arguments:
9310 desc the description of the link, if any, or a description added by
9311 org-export-normalize-links if there is none
9312 format the export format, a symbol like `html' or `latex' or `ascii'..
9314 The function may use the FORMAT information to return different values
9315 depending on the format. The return value will be put literally into
9316 the exported file. If the return value is nil, this means Org should
9317 do what it normally does with links which do not have EXPORT defined.
9319 Org-mode has a built-in default for exporting links. If you are happy with
9320 this default, there is no need to define an export function for the link
9321 type. For a simple example of an export function, see `org-bbdb.el'."
9322 (add-to-list 'org-link-types type t)
9323 (org-make-link-regexps)
9324 (if (assoc type org-link-protocols)
9325 (setcdr (assoc type org-link-protocols) (list follow export))
9326 (push (list type follow export) org-link-protocols)))
9328 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9329 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9331 ;;;###autoload
9332 (defun org-store-link (arg)
9334 This link is added to `org-stored-links' and can later be inserted
9337 For some link types, a prefix arg is interpreted.
9338 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9339 For file links, arg negates `org-context-in-file-links'.
9341 A double prefix arg force skipping storing functions that are not
9342 part of Org's core.
9344 A triple prefix arg force storing a link for each line in the
9345 active region."
9346 (interactive "P")
9347 (org-load-modules-maybe)
9348 (if (and (equal arg '(64)) (org-region-active-p))
9349 (save-excursion
9350 (let ((end (region-end)))
9351 (goto-char (region-beginning))
9352 (set-mark (point))
9353 (while (< (point-at-eol) end)
9354 (move-end-of-line 1) (activate-mark)
9355 (let (current-prefix-arg)
9356 (call-interactively 'org-store-link))
9357 (move-beginning-of-line 2)
9358 (set-mark (point)))))
9359 (org-with-limited-levels
9360 (setq org-store-link-plist nil)
9361 (let (link cpltxt desc description search
9362 txt custom-id agenda-link sfuns sfunsn)
9363 (cond
9365 ;; Store a link using an external link type
9366 ((and (not (equal arg '(16)))
9367 (setq sfuns
9368 (delq
9369 nil (mapcar (lambda (f)
9370 (let (fs) (if (funcall f) (push f fs))))
9371 org-store-link-functions))
9372 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9373 (or (and (cdr sfuns)
9374 (funcall (intern
9375 (completing-read
9376 "Which function for creating the link? "
9377 sfunsn t (car sfunsn)))))
9378 (funcall (caar sfuns)))
9379 (setq link (plist-get org-store-link-plist :link)
9380 desc (or (plist-get org-store-link-plist
9381 :description) link))))
9383 ;; Store a link from a source code buffer
9384 ((org-src-edit-buffer-p)
9385 (let (label gc)
9386 (while (or (not label)
9387 (save-excursion
9388 (save-restriction
9389 (widen)
9390 (goto-char (point-min))
9391 (re-search-forward
9392 (regexp-quote (format org-coderef-label-format label))
9393 nil t))))
9394 (when label (message "Label exists already") (sit-for 2))
9395 (setq label (read-string "Code line label: " label)))
9396 (end-of-line 1)
9397 (setq link (format org-coderef-label-format label))
9398 (setq gc (- 79 (length link)))
9399 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9400 (insert link)
9401 (setq link (concat "(" label ")") desc nil)))
9403 ;; We are in the agenda, link to referenced location
9404 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9405 (let ((m (or (get-text-property (point) 'org-hd-marker)
9406 (get-text-property (point) 'org-marker))))
9407 (when m
9408 (org-with-point-at m
9409 (setq agenda-link
9410 (if (org-called-interactively-p 'any)
9411 (call-interactively 'org-store-link)
9412 (org-store-link nil)))))))
9414 ((eq major-mode 'calendar-mode)
9415 (let ((cd (calendar-cursor-to-date)))
9416 (setq link
9417 (format-time-string
9418 (car org-time-stamp-formats)
9419 (apply 'encode-time
9420 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9421 nil nil nil))))
9422 (org-store-link-props :type "calendar" :date cd)))
9424 ((eq major-mode 'help-mode)
9425 (setq link (concat "help:" (save-excursion
9426 (goto-char (point-min))
9427 (looking-at "^[^ ]+")
9428 (match-string 0))))
9429 (org-store-link-props :type "help"))
9431 ((eq major-mode 'w3-mode)
9432 (setq cpltxt (if (and (buffer-name)
9433 (not (string-match "Untitled" (buffer-name))))
9434 (buffer-name)
9435 (url-view-url t))
9436 link (url-view-url t))
9437 (org-store-link-props :type "w3" :url (url-view-url t)))
9439 ((eq major-mode 'image-mode)
9440 (setq cpltxt (concat "file:"
9441 (abbreviate-file-name buffer-file-name))
9442 link cpltxt)
9443 (org-store-link-props :type "image" :file buffer-file-name))
9445 ;; In dired, store a link to the file of the current line
9446 ((eq major-mode 'dired-mode)
9447 (let ((file (dired-get-filename nil t)))
9448 (setq file (if file
9449 (abbreviate-file-name
9450 (expand-file-name (dired-get-filename nil t)))
9451 ;; otherwise, no file so use current directory.
9452 default-directory))
9453 (setq cpltxt (concat "file:" file)
9454 link cpltxt)))
9456 ((setq search (run-hook-with-args-until-success
9457 'org-create-file-search-functions))
9458 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9459 "::" search))
9460 (setq cpltxt (or description link)))
9462 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9463 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9464 (cond
9465 ;; Store a link using the radio target at point
9467 (setq cpltxt
9468 (concat "file:"
9469 (abbreviate-file-name
9470 (buffer-file-name (buffer-base-buffer)))
9471 "::" (match-string 1))
9472 link cpltxt))
9473 ((and (featurep 'org-id)
9474 (or (eq org-id-link-to-org-use-id t)
9475 (and (org-called-interactively-p 'any)
9476 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9477 (and (eq org-id-link-to-org-use-id
9478 'create-if-interactive-and-no-custom-id)
9479 (not custom-id))))
9480 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9481 ;; Store a link using the ID at point
9482 (setq link (condition-case nil
9483 (prog1 (org-id-store-link)
9484 (setq desc (plist-get org-store-link-plist
9485 :description)))
9486 (error
9487 ;; Probably before first headline, link only to file
9488 (concat "file:"
9489 (abbreviate-file-name
9490 (buffer-file-name (buffer-base-buffer))))))))
9491 (t
9492 ;; Just link to current headline
9493 (setq cpltxt (concat "file:"
9494 (abbreviate-file-name
9495 (buffer-file-name (buffer-base-buffer)))))
9496 ;; Add a context search string
9497 (when (org-xor org-context-in-file-links arg)
9498 (let* ((ee (org-element-at-point))
9499 (et (org-element-type ee))
9500 (ev (plist-get (cadr ee) :value))
9501 (ek (plist-get (cadr ee) :key))
9502 (eok (and (stringp ek) (string-match "name" ek))))
9503 (setq txt (cond
9504 ((org-at-heading-p) nil)
9505 ((and (eq et 'keyword) eok) ev)
9506 ((org-region-active-p)
9507 (buffer-substring (region-beginning) (region-end)))))
9509 (setq cpltxt
9510 (concat cpltxt "::"
9511 (condition-case nil
9512 (org-make-org-heading-search-string txt)
9513 (error "")))
9514 desc (or (and (eq et 'keyword) eok ev)
9515 (nth 4 (ignore-errors (org-heading-components)))
9516 "NONE")))))
9518 (setq cpltxt (substring cpltxt 0 -2)))
9519 (setq link cpltxt))))
9521 ((buffer-file-name (buffer-base-buffer))
9522 ;; Just link to this file here.
9523 (setq cpltxt (concat "file:"
9524 (abbreviate-file-name
9525 (buffer-file-name (buffer-base-buffer)))))
9526 ;; Add a context string.
9527 (when (org-xor org-context-in-file-links arg)
9528 (setq txt (if (org-region-active-p)
9529 (buffer-substring (region-beginning) (region-end))
9530 (buffer-substring (point-at-bol) (point-at-eol))))
9531 ;; Only use search option if there is some text.
9533 (setq cpltxt
9534 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9535 desc "NONE")))
9536 (setq link cpltxt))
9538 ((org-called-interactively-p 'interactive)
9539 (user-error "No method for storing a link from this buffer"))
9541 (t (setq link nil)))
9543 ;; We're done setting link and desc, clean up
9544 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9545 (setq link (or link cpltxt)
9546 desc (or desc cpltxt))
9547 (cond ((equal desc "NONE") (setq desc nil))
9548 ((string-match org-bracket-link-regexp desc)
9549 (setq desc
9550 (replace-regexp-in-string
9551 org-bracket-link-regexp
9553 (length desc)) "*" "")) desc))))
9555 ;; Return the link
9556 (if (not (and (or (org-called-interactively-p 'any)
9557 executing-kbd-macro) link))
9558 (or agenda-link (and link (org-make-link-string link desc)))
9559 (push (list link desc) org-stored-links)
9560 (message "Stored: %s" (or desc link))
9561 (when custom-id
9562 (setq link (concat "file:" (abbreviate-file-name
9563 (buffer-file-name)) "::#" custom-id))
9564 (push (list link desc) org-stored-links)))))))
9566 (defun org-store-link-props (&rest plist)
9567 "Store link properties, extract names and addresses."
9568 (let (x adr)
9569 (when (setq x (plist-get plist :from))
9570 (setq adr (mail-extract-address-components x))
9571 (setq plist (plist-put plist :fromname (car adr)))
9572 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9573 (when (setq x (plist-get plist :to))
9574 (setq adr (mail-extract-address-components x))
9575 (setq plist (plist-put plist :toname (car adr)))
9576 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9577 (let ((from (plist-get plist :from))
9578 (to (plist-get plist :to)))
9579 (when (and from to org-from-is-user-regexp)
9580 (setq plist
9581 (plist-put plist :fromto
9582 (if (string-match org-from-is-user-regexp from)
9583 (concat "to %t")
9584 (concat "from %f"))))))
9585 (setq org-store-link-plist plist))
9587 (defun org-add-link-props (&rest plist)
9588 "Add these properties to the link property list."
9589 (let (key value)
9590 (while plist
9591 (setq key (pop plist) value (pop plist))
9592 (setq org-store-link-plist
9593 (plist-put org-store-link-plist key value)))))
9595 (defun org-email-link-description (&optional fmt)
9596 "Return the description part of an email link.
9597 This takes information from `org-store-link-plist' and formats it
9598 according to FMT (default from `org-email-link-description-format')."
9599 (setq fmt (or fmt org-email-link-description-format))
9600 (let* ((p org-store-link-plist)
9601 (to (plist-get p :toaddress))
9602 (from (plist-get p :fromaddress))
9603 (table
9604 (list
9605 (cons "%c" (plist-get p :fromto))
9606 (cons "%F" (plist-get p :from))
9607 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9608 (cons "%T" (plist-get p :to))
9609 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9610 (cons "%s" (plist-get p :subject))
9611 (cons "%d" (plist-get p :date))
9612 (cons "%m" (plist-get p :message-id)))))
9613 (when (string-match "%c" fmt)
9614 ;; Check if the user wrote this message
9615 (if (and org-from-is-user-regexp from to
9616 (save-match-data (string-match org-from-is-user-regexp from)))
9617 (setq fmt (replace-match "to %t" t t fmt))
9618 (setq fmt (replace-match "from %f" t t fmt))))
9619 (org-replace-escapes fmt table)))
9621 (defun org-make-org-heading-search-string (&optional string)
9622 "Make search string for the current headline or STRING."
9623 (let ((s (or string
9624 (and (derived-mode-p 'org-mode)
9625 (save-excursion
9626 (org-back-to-heading t)
9627 (org-element-property :raw-value (org-element-at-point))))))
9628 (lines org-context-in-file-links))
9629 (or string (setq s (concat "*" s))) ; Add * for headlines
9631 (when (and string (integerp lines) (> lines 0))
9633 (when (< lines (length slines))
9634 (setq s (mapconcat
9635 'identity
9636 (reverse (nthcdr (- (length slines) lines)
9640 (defun org-make-link-string (link &optional description)
9641 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9643 (error "Empty link"))
9644 (when (and description
9645 (stringp description)
9647 (setq description nil))
9648 (when (stringp description)
9649 ;; Remove brackets from the description, they are fatal.
9651 (setq description (replace-match "{" t t description)))
9653 (setq description (replace-match "}" t t description))))
9654 (when (equal link description)
9655 ;; No description needed, it is identical
9656 (setq description nil))
9657 (when (and (not description)
9658 (not (string-match (org-image-file-name-regexp) link))
9659 (not (equal link (org-link-escape link))))
9660 (setq description (org-extract-attributes link)))
9661 (setq link
9662 (cond ((string-match (org-image-file-name-regexp) link) link)
9663 ((string-match org-link-types-re link)
9664 (concat (match-string 1 link)
9665 (org-link-escape (substring link (match-end 1)))))
9666 (t (org-link-escape link))))
9667 (concat "[[" link "]"
9668 (if description (concat "[" description "]") "")
9669 "]"))
9671 (defconst org-link-escape-chars
9672 '(?\ ?\[ ?\] ?\; ?\= ?\+)
9673 "List of characters that should be escaped in link.
9674 This is the list that is used for internal purposes.")
9676 (defconst org-link-escape-chars-browser
9677 '(?\ )
9678 "List of escapes for characters that are problematic in links.
9679 This is the list that is used before handing over to the browser.")
9681 (defun org-link-escape (text &optional table merge)
9682 "Return percent escaped representation of TEXT.
9683 TEXT is a string with the text to escape.
9684 Optional argument TABLE is a list with characters that should be
9685 escaped. When nil, `org-link-escape-chars' is used.
9686 If optional argument MERGE is set, merge TABLE into
9687 `org-link-escape-chars'."
9688 (cond
9689 ((and table merge)
9690 (mapc (lambda (defchr)
9691 (unless (member defchr table)
9692 (setq table (cons defchr table)))) org-link-escape-chars))
9693 ((null table)
9694 (setq table org-link-escape-chars)))
9695 (mapconcat
9696 (lambda (char)
9697 (if (or (member char table)
9698 (and (or (< char 32) (= char 37) (> char 126))
9699 org-url-hexify-p))
9700 (mapconcat (lambda (sequence-element)
9701 (format "%%%.2X" sequence-element))
9702 (or (encode-coding-char char 'utf-8)
9703 (error "Unable to percent escape character: %s"
9704 (char-to-string char))) "")
9705 (char-to-string char))) text ""))
9707 (defun org-link-unescape (str)
9708 "Unhex hexified Unicode strings as returned from the JavaScript function
9709 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
9710 (unless (and (null str) (string= "" str))
9711 (let ((pos 0) (case-fold-search t) unhexed)
9713 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9714 (setq str (replace-match unhexed t t str))
9715 (setq pos (+ pos (length unhexed))))))
9716 str)
9718 (defun org-link-unescape-compound (hex)
9719 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
9720 Note: this function also decodes single byte encodings like
9721 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
9722 (save-match-data
9723 (let* ((bytes (cdr (split-string hex "%")))
9724 (ret "")
9725 (eat 0)
9726 (sum 0))
9727 (while bytes
9728 (let* ((val (string-to-number (pop bytes) 16))
9729 (shift-xor
9730 (if (= 0 eat)
9731 (cond
9732 ((>= val 252) (cons 6 252))
9733 ((>= val 248) (cons 5 248))
9734 ((>= val 240) (cons 4 240))
9735 ((>= val 224) (cons 3 224))
9736 ((>= val 192) (cons 2 192))
9737 (t (cons 0 0)))
9738 (cons 6 128))))
9739 (if (>= val 192) (setq eat (car shift-xor)))
9740 (setq val (logxor val (cdr shift-xor)))
9741 (setq sum (+ (lsh sum (car shift-xor)) val))
9742 (if (> eat 0) (setq eat (- eat 1)))
9743 (cond
9744 ((= 0 eat) ;multi byte
9745 (setq ret (concat ret (org-char-to-string sum)))
9746 (setq sum 0))
9747 ((not bytes) ; single byte(s)
9748 (setq ret (org-link-unescape-single-byte-sequence hex))))
9749 )) ;; end (while bytes
9750 ret )))
9752 (defun org-link-unescape-single-byte-sequence (hex)
9753 "Unhexify hex-encoded single byte character sequences."
9754 (mapconcat (lambda (byte)
9755 (char-to-string (string-to-number byte 16)))
9756 (cdr (split-string hex "%")) ""))
9758 (defun org-xor (a b)
9759 "Exclusive or."
9760 (if a (not b) b))
9762 (defun org-fixup-message-id-for-http (s)
9763 "Replace special characters in a message id, so it can be used in an http query."
9764 (when (string-match "%" s)
9765 (setq s (mapconcat (lambda (c)
9766 (if (eq c ?%)
9767 "%25"
9768 (char-to-string c)))
9769 s "")))
9770 (while (string-match "<" s)
9771 (setq s (replace-match "%3C" t t s)))
9772 (while (string-match ">" s)
9773 (setq s (replace-match "%3E" t t s)))
9774 (while (string-match "@" s)
9775 (setq s (replace-match "%40" t t s)))
9776 s)
9778 (defun org-link-prettify (link)
9779 "Return a human-readable representation of LINK.
9780 The car of LINK must be a raw link the cdr of LINK must be either
9781 a link description or nil."
9782 (let ((desc (or (cadr link) "<no description>")))
9783 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9784 "<" (car link) ">")))
9786 ;;;###autoload
9787 (defun org-insert-link-global ()
9788 "Insert a link like Org-mode does.
9789 This command can be called in any mode to insert a link in Org-mode syntax."
9790 (interactive)
9791 (org-load-modules-maybe)
9792 (org-run-like-in-org-mode 'org-insert-link))
9794 (defun org-insert-all-links (&optional keep)
9795 "Insert all links in `org-stored-links'."
9796 (interactive "P")
9797 (let ((links (copy-sequence org-stored-links)) l)
9798 (while (setq l (if keep (pop links) (pop org-stored-links)))
9799 (insert "- ")
9800 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
9803 (defun org-link-fontify-links-to-this-file ()
9804 "Fontify links to the current file in `org-stored-links'."
9805 (let ((f (buffer-file-name)) a b)
9806 (setq a (mapcar (lambda(l)
9807 (let ((ll (car l)))
9809 (equal f (expand-file-name (match-string 1 ll))))
9810 ll)))
9811 org-stored-links))
9812 (when (featurep 'org-id)
9813 (setq b (mapcar (lambda(l)
9814 (let ((ll (car l)))
9816 (equal f (expand-file-name
9817 (or (org-id-find-id-file
9818 (match-string 1 ll)) ""))))
9819 ll)))
9820 org-stored-links)))
9821 (mapcar (lambda(l)
9822 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9823 (delq nil (append a b)))))
9825 (defvar org-link-links-in-this-file nil)
9826 (defun org-insert-link (&optional complete-file link-location default-description)
9827 "Insert a link. At the prompt, enter the link.
9829 Completion can be used to insert any of the link protocol prefixes like
9830 http or ftp in use.
9832 The history can be used to select a link previously stored with
9833 `org-store-link'. When the empty string is entered (i.e. if you just
9834 press RET at the prompt), the link defaults to the most recently
9835 stored link. As SPC triggers completion in the minibuffer, you need to
9836 use M-SPC or C-q SPC to force the insertion of a space character.
9838 You will also be prompted for a description, and if one is given, it will
9839 be displayed in the buffer instead of the link.
9841 If there is already a link at point, this command will allow you to edit link
9842 and description parts.
9845 be selected using completion. The path to the file will be relative to the
9846 current directory if the file is in the current directory or a subdirectory.
9847 Otherwise, the link will be the absolute path as completed in the minibuffer
9848 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9849 option `org-link-file-path-type'.
9852 the current directory or below.
9855 `org-keep-stored-link-after-insertion'.
9857 If `org-make-link-description-function' is non-nil, this function will be
9858 called with the link target, and the result will be the default
9859 link description.
9861 If the LINK-LOCATION parameter is non-nil, this value will be
9862 used as the link location instead of reading one interactively.
9864 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
9865 be used as the default description."
9866 (interactive "P")
9867 (let* ((wcf (current-window-configuration))
9868 (origbuf (current-buffer))
9869 (region (if (org-region-active-p)
9870 (buffer-substring (region-beginning) (region-end))))
9871 (remove (and region (list (region-beginning) (region-end))))
9872 (desc region)
9873 tmphist ; byte-compile incorrectly complains about this
9874 (link link-location)
9875 (abbrevs org-link-abbrev-alist-local)
9876 entry file all-prefixes auto-desc)
9877 (cond
9878 (link-location) ; specified by arg, just use it.
9879 ((org-in-regexp org-bracket-link-regexp 1)
9880 ;; We do have a link at point, and we are going to edit it.
9881 (setq remove (list (match-beginning 0) (match-end 0)))
9882 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
9883 (setq link (read-string "Link: "
9884 (org-link-unescape
9885 (org-match-string-no-properties 1)))))
9886 ((or (org-in-regexp org-angle-link-re)
9887 (org-in-regexp org-plain-link-re))
9888 ;; Convert to bracket link
9889 (setq remove (list (match-beginning 0) (match-end 0))
9890 link (read-string "Link: "
9891 (org-remove-angle-brackets (match-string 0)))))
9892 ((member complete-file '((4) (16)))
9893 ;; Completing read for file names.
9894 (setq link (org-file-complete-link complete-file)))
9895 (t
9896 ;; Read link, with completion for stored links.
9897 (org-link-fontify-links-to-this-file)
9898 (org-switch-to-buffer-other-window "*Org Links*")
9899 (with-current-buffer "*Org Links*"
9900 (erase-buffer)
9901 (insert "Insert a link.
9903 (when org-stored-links
9905 (insert (mapconcat 'org-link-prettify
9907 (goto-char (point-min)))
9908 (let ((cw (selected-window)))
9909 (select-window (get-buffer-window "*Org Links*" 'visible))
9910 (with-current-buffer "*Org Links*" (setq truncate-lines t))
9911 (unless (pos-visible-in-window-p (point-max))
9912 (org-fit-window-to-buffer))
9913 (and (window-live-p cw) (select-window cw)))
9914 ;; Fake a link history, containing the stored links.
9915 (setq tmphist (append (mapcar 'car org-stored-links)
9916 org-insert-link-history))
9917 (setq all-prefixes (append (mapcar 'car abbrevs)
9918 (mapcar 'car org-link-abbrev-alist)
9919 org-link-types))
9920 (unwind-protect
9921 (progn
9922 (setq link
9923 (org-completing-read
9924 "Link: "
9925 (append
9926 (mapcar (lambda (x) (concat x ":"))
9927 all-prefixes)
9928 (mapcar 'car org-stored-links))
9929 nil nil nil
9930 'tmphist
9931 (caar org-stored-links)))
9933 (error "No link selected"))
9934 (mapc (lambda(l)
9935 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
9936 org-stored-links)
9937 (if (or (member link all-prefixes)
9938 (and (equal ":" (substring link -1))
9939 (member (substring link 0 -1) all-prefixes)
9940 (setq link (substring link 0 -1))))
9941 (setq link (with-current-buffer origbuf
9942 (org-link-try-special-completion link)))))
9943 (set-window-configuration wcf)
9944 (kill-buffer "*Org Links*"))
9945 (setq entry (assoc link org-stored-links))
9946 (or entry (push link org-insert-link-history))
9947 (setq desc (or desc (nth 1 entry)))))
9949 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
9950 (not org-keep-stored-link-after-insertion))
9951 (setq org-stored-links (delq (assoc link org-stored-links)
9952 org-stored-links)))
9954 (if (string-match org-plain-link-re link)
9955 ;; URL-like link, normalize the use of angular brackets.
9956 (setq link (org-remove-angle-brackets link)))
9958 ;; Check if we are linking to the current file with a search
9959 ;; option If yes, simplify the link by using only the search
9960 ;; option.
9961 (when (and buffer-file-name
9963 (let* ((path (match-string 1 link))
9964 (case-fold-search nil)
9965 (search (match-string 2 link)))
9966 (save-match-data
9967 (if (equal (file-truename buffer-file-name) (file-truename path))
9968 ;; We are linking to this same file, with a search option
9969 (setq link search)))))
9971 ;; Check if we can/should use a relative path. If yes, simplify the link
9973 (let* ((type (match-string 1 link))
9974 (path (match-string 2 link))
9975 (origpath path)
9976 (case-fold-search nil))
9977 (cond
9978 ((or (eq org-link-file-path-type 'absolute)
9979 (equal complete-file '(16)))
9980 (setq path (abbreviate-file-name (expand-file-name path))))
9981 ((eq org-link-file-path-type 'noabbrev)
9982 (setq path (expand-file-name path)))
9983 ((eq org-link-file-path-type 'relative)
9984 (setq path (file-relative-name path)))
9985 (t
9986 (save-match-data
9987 (if (string-match (concat "^" (regexp-quote
9988 (expand-file-name
9989 (file-name-as-directory
9990 default-directory))))
9991 (expand-file-name path))
9992 ;; We are linking a file with relative path name.
9993 (setq path (substring (expand-file-name path)
9994 (match-end 0)))
9995 (setq path (abbreviate-file-name (expand-file-name path)))))))
9996 (setq link (concat type path))
9997 (if (equal desc origpath)
9998 (setq desc path))))
10000 (if org-make-link-description-function
10001 (setq desc
10002 (or (condition-case nil
10003 (funcall org-make-link-description-function link desc)
10004 (error (progn (message "Can't get link description from `%s'"
10005 (symbol-name org-make-link-description-function))
10006 (sit-for 2) nil)))
10007 (read-string "Description: " default-description)))
10008 (if default-description (setq desc default-description)
10009 (setq desc (or (and auto-desc desc)
10010 (read-string "Description: " desc)))))
10013 (if remove (apply 'delete-region remove))
10014 (insert (org-make-link-string link desc))))
10016 (defun org-link-try-special-completion (type)
10017 "If there is completion support for link type TYPE, offer it."
10018 (let ((fun (intern (concat "org-" type "-complete-link"))))
10019 (if (functionp fun)
10020 (funcall fun)
10021 (read-string "Link (no completion support): " (concat type ":")))))
10023 (defun org-file-complete-link (&optional arg)
10024 "Create a file link using completion."
10025 (let (file link)
10026 (setq file (org-iread-file-name "File: "))
10027 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10028 (pwd1 (file-name-as-directory (abbreviate-file-name
10029 (expand-file-name ".")))))
10030 (cond
10031 ((equal arg '(16))
10032 (setq link (concat
10033 "file:"
10034 (abbreviate-file-name (expand-file-name file)))))
10036 (setq link (concat "file:" (match-string 1 file))))
10038 (expand-file-name file))
10039 (setq link (concat
10040 "file:" (match-string 1 (expand-file-name file)))))
10041 (t (setq link (concat "file:" file)))))
10042 link))
10044 (defun org-iread-file-name (&rest args)
10045 "Read-file-name using `ido-mode' speedup if available.
10046 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10047 See `read-file-name' for a description of parameters."
10048 (org-without-partial-completion
10049 (if (and org-completion-use-ido
10050 (fboundp 'ido-read-file-name)
10051 (boundp 'ido-mode) ido-mode
10052 (listp (second args)))
10053 (let ((ido-enter-matching-directory nil))
10054 (apply 'ido-read-file-name args))
10055 (apply 'read-file-name args))))
10057 (defun org-completing-read (&rest args)
10058 "Completing-read with SPACE being a normal character."
10059 (let ((enable-recursive-minibuffers t)
10060 (minibuffer-local-completion-map
10061 (copy-keymap minibuffer-local-completion-map)))
10062 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10063 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10064 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10065 (apply 'org-icompleting-read args)))
10067 (defun org-completing-read-no-i (&rest args)
10068 (let (org-completion-use-ido org-completion-use-iswitchb)
10069 (apply 'org-completing-read args)))
10071 (defun org-iswitchb-completing-read (prompt choices &rest args)
10072 "Use iswitch as a completing-read replacement to choose from choices.
10073 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10074 from."
10075 (let* ((iswitchb-use-virtual-buffers nil)
10076 (iswitchb-make-buflist-hook
10077 (lambda ()
10078 (setq iswitchb-temp-buflist choices))))
10079 (iswitchb-read-buffer prompt)))
10081 (defun org-icompleting-read (&rest args)
10082 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10083 (org-without-partial-completion
10084 (if (and org-completion-use-ido
10085 (fboundp 'ido-completing-read)
10086 (boundp 'ido-mode) ido-mode
10087 (listp (second args)))
10088 (let ((ido-enter-matching-directory nil))
10089 (apply 'ido-completing-read (concat (car args))
10090 (if (consp (car (nth 1 args)))
10091 (mapcar 'car (nth 1 args))
10092 (nth 1 args))
10093 (cddr args)))
10094 (if (and org-completion-use-iswitchb
10095 (boundp 'iswitchb-mode) iswitchb-mode
10096 (listp (second args)))
10097 (apply 'org-iswitchb-completing-read (concat (car args))
10098 (if (consp (car (nth 1 args)))
10099 (mapcar 'car (nth 1 args))
10100 (nth 1 args))
10101 (cddr args))
10102 (apply 'completing-read args)))))
10104 (defun org-extract-attributes (s)
10105 "Extract the attributes cookie from a string and set as text property."
10106 (let (a attr (start 0) key value)
10107 (save-match-data
10109 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10111 (setq key (match-string 1 a) value (match-string 2 a)
10112 start (match-end 0)
10113 attr (plist-put attr (intern key) value))))
10114 (org-add-props s nil 'org-attr attr))
10115 s))
10117 ;;; Opening/following a link
10119 (defvar org-link-search-failed nil)
10121 (defvar org-open-link-functions nil
10122 "Hook for functions finding a plain text link.
10123 These functions must take a single argument, the link content.
10124 They will be called for links that look like [[link text][description]]
10128 These functions will be called *before* Org attempts to resolve the
10129 link by doing text searches in the current buffer - so if you want a
10131 handle this as a special case.
10133 When the function does handle the link, it must return a non-nil value.
10134 If it decides that it is not responsible for this link, it must return
10135 nil to indicate that that Org-mode can continue with other options
10136 like exact and fuzzy text search.")
10138 (defun org-next-link (&optional search-backward)
10139 "Move forward to the next link.
10140 If the link is in hidden text, expose it."
10141 (interactive "P")
10142 (when (and org-link-search-failed (eq this-command last-command))
10143 (goto-char (point-min))
10144 (message "Link search wrapped back to beginning of buffer"))
10145 (setq org-link-search-failed nil)
10146 (let* ((pos (point))
10147 (ct (org-context))
10148 (a (assoc :link ct))
10149 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10150 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10151 ((looking-at org-any-link-re)
10152 ;; Don't stay stuck at link without an org-link face
10153 (forward-char (if search-backward -1 1))))
10154 (if (funcall srch-fun org-any-link-re nil t)
10155 (progn
10156 (goto-char (match-beginning 0))
10157 (if (outline-invisible-p) (org-show-context)))
10158 (goto-char pos)
10159 (setq org-link-search-failed t)
10160 (message "No further link found"))))
10162 (defun org-previous-link ()
10163 "Move backward to the previous link.
10164 If the link is in hidden text, expose it."
10165 (interactive)
10166 (funcall 'org-next-link t))
10168 (defun org-translate-link (s)
10169 "Translate a link string if a translation function has been defined."
10170 (if (and org-link-translation-function
10171 (fboundp org-link-translation-function)
10173 (progn
10174 (setq s (funcall org-link-translation-function
10175 (match-string 1 s) (match-string 2 s)))
10176 (concat (car s) ":" (cdr s)))
10177 s))
10179 (defun org-translate-link-from-planner (type path)
10180 "Translate a link from Emacs Planner syntax so that Org can follow it.
10181 This is still an experimental function, your mileage may vary."
10182 (cond
10183 ((member type '("http" "https" "news" "ftp"))
10184 ;; standard Internet links are the same.
10185 nil)
10186 ((and (equal type "irc") (string-match "^//" path))
10187 ;; Planner has two / at the beginning of an irc link, we have 1.
10188 ;; We should have zero, actually....
10189 (setq path (substring path 1)))
10190 ((and (equal type "lisp") (string-match "^/" path))
10191 ;; Planner has a slash, we do not.
10192 (setq type "elisp" path (substring path 1)))
10194 ;; A typical message link. Planner has the id after the final slash,
10195 ;; we separate it with a hash mark
10196 (setq path (concat (match-string 1 path) "#"
10197 (org-remove-angle-brackets (match-string 2 path)))))
10198 )
10199 (cons type path))
10201 (defun org-find-file-at-mouse (ev)
10202 "Open file link or URL at mouse."
10203 (interactive "e")
10204 (mouse-set-point ev)
10205 (org-open-at-point 'in-emacs))
10207 (defun org-open-at-mouse (ev)
10208 "Open file link or URL at mouse.
10209 See the docstring of `org-open-file' for details."
10210 (interactive "e")
10211 (mouse-set-point ev)
10212 (if (eq major-mode 'org-agenda-mode)
10213 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10214 (org-open-at-point))
10216 (defvar org-window-config-before-follow-link nil
10217 "The window configuration before following a link.
10218 This is saved in case the need arises to restore it.")
10220 (defvar org-open-link-marker (make-marker)
10221 "Marker pointing to the location where `org-open-at-point; was called.")
10223 ;;;###autoload
10224 (defun org-open-at-point-global ()
10225 "Follow a link like Org-mode does.
10226 This command can be called in any mode to follow a link that has
10227 Org-mode syntax."
10228 (interactive)
10229 (org-run-like-in-org-mode 'org-open-at-point))
10231 ;;;###autoload
10232 (defun org-open-link-from-string (s &optional arg reference-buffer)
10233 "Open a link in the string S, as if it was in Org-mode."
10235 (let ((reference-buffer (or reference-buffer (current-buffer))))
10236 (with-temp-buffer
10237 (let ((org-inhibit-startup (not reference-buffer)))
10238 (org-mode)
10239 (insert s)
10240 (goto-char (point-min))
10241 (when reference-buffer
10242 (setq org-link-abbrev-alist-local
10243 (with-current-buffer reference-buffer
10244 org-link-abbrev-alist-local)))
10245 (org-open-at-point arg reference-buffer)))))
10247 (defvar org-open-at-point-functions nil
10248 "Hook that is run when following a link at point.
10250 Functions in this hook must return t if they identify and follow
10251 a link at point. If they don't find anything interesting at point,
10252 they must return nil.")
10254 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10255 (defun org-open-at-point (&optional arg reference-buffer)
10256 "Open link at or after point.
10257 If there is no link at point, this function will search forward up to
10258 the end of the current line.
10259 Normally, files will be opened by an appropriate application. If the
10260 optional prefix argument ARG is non-nil, Emacs will visit the file.
10261 With a double prefix argument, try to open outside of Emacs, in the
10262 application the system uses for this file type."
10263 (interactive "P")
10264 ;; if in a code block, then open the block's results
10265 (unless (call-interactively #'org-babel-open-src-block-result)
10266 (org-load-modules-maybe)
10267 (move-marker org-open-link-marker (point))
10268 (setq org-window-config-before-follow-link (current-window-configuration))
10269 (org-remove-occur-highlights nil nil t)
10270 (cond
10271 ((and (org-at-heading-p)
10272 (not (org-at-timestamp-p t))
10273 (not (org-in-regexp
10278 (not (get-text-property (point) 'org-linked-text)))
10279 (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
10280 (lk0 (car lkall))
10281 (lk (if (stringp lk0) (list lk0) lk0))
10282 (lkend (cdr lkall)))
10283 (mapcar (lambda(l)
10284 (search-forward l nil lkend)
10285 (goto-char (match-beginning 0))
10286 (org-open-at-point))
10287 lk))
10288 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
10289 ((run-hook-with-args-until-success 'org-open-at-point-functions))
10290 ((and (org-at-timestamp-p t)
10291 (not (org-in-regexp org-bracket-link-regexp)))
10292 (org-follow-timestamp-link))
10293 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
10294 (not (org-in-regexp org-any-link-re)))
10295 (org-footnote-action))
10296 (t
10297 (let (type path link line search (pos (point)))
10298 (catch 'match
10299 (save-excursion
10301 (when (org-in-regexp org-bracket-link-regexp 1)
10302 (setq link (org-extract-attributes
10303 (org-link-unescape (org-match-string-no-properties 1))))
10305 (setq link (replace-match " " t t link)))
10306 (setq link (org-link-expand-abbrev link))
10307 (cond
10308 ((or (file-name-absolute-p link)
10310 (setq type "file" path link))
10311 ((string-match org-link-re-with-space3 link)
10312 (setq type (match-string 1 link) path (match-string 2 link)))
10314 (setq type "help" path (match-string 1 link)))
10315 (t (setq type "thisfile" path link)))
10316 (throw 'match t)))
10318 (when (get-text-property (point) 'org-linked-text)
10319 (setq type "thisfile"
10320 pos (if (get-text-property (1+ (point)) 'org-linked-text)
10321 (1+ (point)) (point))
10322 path (buffer-substring
10323 (or (previous-single-property-change pos 'org-linked-text)
10324 (point-min))
10325 (or (next-single-property-change pos 'org-linked-text)
10326 (point-max))))
10327 (throw 'match t))
10329 (save-excursion
10330 (when (or (org-in-regexp org-angle-link-re)
10331 (let ((match (org-in-regexp org-plain-link-re)))
10332 ;; Check a plain link is not within a bracket link
10333 (and match
10334 (save-excursion
10335 (progn
10336 (goto-char (car match))
10337 (not (org-in-regexp org-bracket-link-regexp))))))
10338 (let ((line_ending (save-excursion (end-of-line) (point))))
10339 ;; We are in a line before a plain or bracket link
10340 (or (re-search-forward org-plain-link-re line_ending t)
10341 (re-search-forward org-bracket-link-regexp line_ending t))))
10342 (setq type (match-string 1)
10343 path (org-link-unescape (match-string 2)))
10344 (throw 'match t)))
10345 (save-excursion
10347 (setq type "tags"
10348 path (match-string 1))
10349 (while (string-match ":" path)
10350 (setq path (replace-match "+" t t path)))
10351 (throw 'match t)))
10353 (setq type "tree-match"
10354 path (match-string 1))
10355 (throw 'match t)))
10356 (unless path
10357 (user-error "No link found"))
10359 ;; switch back to reference buffer
10360 ;; needed when if called in a temporary buffer through
10361 ;; org-open-link-from-string
10362 (with-current-buffer (or reference-buffer (current-buffer))
10364 ;; Remove any trailing spaces in path
10366 (setq path (replace-match "" t t path)))
10367 (if (and org-link-translation-function
10368 (fboundp org-link-translation-function))
10369 ;; Check if we need to translate the link
10370 (let ((tmp (funcall org-link-translation-function type path)))
10371 (setq type (car tmp) path (cdr tmp))))
10373 (cond
10375 ((assoc type org-link-protocols)
10376 (funcall (nth 1 (assoc type org-link-protocols)) path))
10378 ((equal type "help")
10379 (let ((f-or-v (intern path)))
10380 (cond ((fboundp f-or-v)
10381 (describe-function f-or-v))
10382 ((boundp f-or-v)
10383 (describe-variable f-or-v))
10384 (t (error "Not a known function or variable")))))
10386 ((equal type "mailto")
10387 (let ((cmd (car org-link-mailto-program))
10388 (args (cdr org-link-mailto-program)) args1
10389 (address path) (subject "") a)
10391 (setq address (match-string 1 path)
10392 subject (org-link-escape (match-string 2 path))))
10393 (while args
10394 (cond
10395 ((not (stringp (car args))) (push (pop args) args1))
10396 (t (setq a (pop args))
10397 (if (string-match "%a" a)
10398 (setq a (replace-match address t t a)))
10399 (if (string-match "%s" a)
10400 (setq a (replace-match subject t t a)))
10401 (push a args1))))
10402 (apply cmd (nreverse args1))))
10404 ((member type '("http" "https" "ftp" "news"))
10405 (browse-url (concat type ":" (if (org-string-match-p "[[:nonascii:] ]" path)
10406 (org-link-escape
10407 path org-link-escape-chars-browser)
10408 path))))
10410 ((string= type "doi")
10411 (browse-url (concat org-doi-server-url (if (org-string-match-p "[[:nonascii:] ]" path)
10412 (org-link-escape
10413 path org-link-escape-chars-browser)
10414 path))))
10416 ((member type '("message"))
10417 (browse-url (concat type ":" path)))
10419 ((string= type "tags")
10420 (org-tags-view arg path))
10422 ((string= type "tree-match")
10425 ((string= type "file")
10427 (setq line (string-to-number (match-string 1 path))
10428 path (substring path 0 (match-beginning 0)))
10430 (setq search (match-string 1 path)
10431 path (substring path 0 (match-beginning 0)))))
10432 (if (string-match "[*?{]" (file-name-nondirectory path))
10433 (dired path)
10434 (org-open-file path arg line search)))
10436 ((string= type "shell")
10437 (let ((buf (generate-new-buffer "*Org Shell Output"))
10438 (cmd path))
10439 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
10440 (string-match org-confirm-shell-link-not-regexp cmd))
10441 (not org-confirm-shell-link-function)
10442 (funcall org-confirm-shell-link-function
10444 (org-add-props cmd nil
10445 'face 'org-warning))))
10446 (progn
10447 (message "Executing %s" cmd)
10448 (shell-command cmd buf)
10449 (if (featurep 'midnight)
10450 (setq clean-buffer-list-kill-buffer-names
10451 (cons buf clean-buffer-list-kill-buffer-names))))
10452 (error "Abort"))))
10454 ((string= type "elisp")
10455 (let ((cmd path))
10456 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
10457 (string-match org-confirm-elisp-link-not-regexp cmd))
10458 (not org-confirm-elisp-link-function)
10459 (funcall org-confirm-elisp-link-function
10461 (org-add-props cmd nil
10462 'face 'org-warning))))
10463 (message "%s => %s" cmd
10464 (if (equal (string-to-char cmd) ?\()
10465 (eval (read cmd))
10466 (call-interactively (read cmd))))
10467 (error "Abort"))))
10469 ((and (string= type "thisfile")
10470 (run-hook-with-args-until-success
10471 'org-open-link-functions path)))
10473 ((string= type "thisfile")
10474 (if arg
10475 (switch-to-buffer-other-window
10476 (org-get-buffer-for-internal-link (current-buffer)))
10477 (org-mark-ring-push))
10478 (let ((cmd `(org-link-search
10479 ,path
10480 ,(cond ((equal arg '(4)) ''occur)
10481 ((equal arg '(16)) ''org-occur))
10482 ,pos)))
10483 (condition-case nil (let ((org-link-search-inhibit-query t))
10484 (eval cmd))
10485 (error (progn (widen) (eval cmd))))))
10487 (t (browse-url-at-point)))))))
10488 (move-marker org-open-link-marker nil)
10489 (run-hook-with-args 'org-follow-link-hook)))
10491 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10492 "Offer links in the current entry and return the selected link.
10493 If there is only one link, return it.
10494 If NTH is an integer, return the NTH link found.
10495 If ZERO is a string, check also this string for a link, and if
10496 there is one, return it."
10497 (with-current-buffer buffer
10498 (save-excursion
10499 (save-restriction
10500 (widen)
10501 (goto-char marker)
10505 (cnt ?0)
10506 (in-emacs (if (integerp nth) nil nth))
10507 have-zero end links link c)
10508 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10509 (push (match-string 0 zero) links)
10510 (setq cnt (1- cnt) have-zero t))
10511 (save-excursion
10512 (org-back-to-heading t)
10513 (setq end (save-excursion (outline-next-heading) (point)))
10514 (while (re-search-forward re end t)
10515 (push (match-string 0) links))
10516 (setq links (org-uniquify (reverse links))))
10517 (cond
10518 ((null links)
10519 (message "No links"))
10520 ((equal (length links) 1)
10521 (setq link (car links)))
10522 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10523 (setq link (nth (if have-zero nth (1- nth)) links)))
10524 (t ; we have to select a link
10525 (save-excursion
10526 (save-window-excursion
10527 (delete-other-windows)
10528 (with-output-to-temp-buffer "*Select Link*"
10529 (mapc (lambda (l)
10530 (if (not (string-match org-bracket-link-regexp l))
10532 (org-remove-angle-brackets l)))
10533 (if (match-end 3)
10535 (match-string 3 l) (match-string 1 l)))
10537 (match-string 1 l))))))
10538 links))
10539 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10540 (message "Select link to open, RET to open all:")
10541 (setq c (read-char-exclusive))
10542 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10543 (when (equal c ?q) (error "Abort"))
10544 (if (equal c ?\C-m)
10545 (setq link links)
10546 (setq nth (- c ?0))
10547 (if have-zero (setq nth (1+ nth)))
10548 (unless (and (integerp nth) (>= (length links) nth))
10549 (error "Invalid link selection"))
10550 (setq link (nth (1- nth) links)))))
10551 (cons link end))))))
10553 ;; Add special file links that specify the way of opening
10555 (org-add-link-type "file+sys" 'org-open-file-with-system)
10556 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10557 (defun org-open-file-with-system (path)
10558 "Open file at PATH using the system way of opening it."
10559 (org-open-file path 'system))
10560 (defun org-open-file-with-emacs (path)
10561 "Open file at PATH in Emacs."
10562 (org-open-file path 'emacs))
10565 ;;; File search
10567 (defvar org-create-file-search-functions nil
10568 "List of functions to construct the right search string for a file link.
10569 These functions are called in turn with point at the location to
10570 which the link should point.
10572 A function in the hook should first test if it would like to
10573 handle this file type, for example by checking the `major-mode'
10574 or the file extension. If it decides not to handle this file, it
10575 should just return nil to give other functions a chance. If it
10576 does handle the file, it must return the search string to be used
10577 when following the link. The search string will be part of the
10578 file link, given after a double colon, and `org-open-at-point'
10579 will automatically search for it. If special measures must be
10580 taken to make the search successful, another function should be
10581 added to the companion hook `org-execute-file-search-functions',
10582 which see.
10584 A function in this hook may also use `setq' to set the variable
10585 `description' to provide a suggestion for the descriptive text to
10586 be used for this link when it gets inserted into an Org-mode
10589 (defvar org-execute-file-search-functions nil
10590 "List of functions to execute a file search triggered by a link.
10592 Functions added to this hook must accept a single argument, the
10593 search string that was part of the file link, the part after the
10594 double colon. The function must first check if it would like to
10595 handle this search, for example by checking the `major-mode' or
10596 the file extension. If it decides not to handle this search, it
10597 should just return nil to give other functions a chance. If it
10598 does handle the search, it must return a non-nil value to keep
10599 other functions from trying.
10601 Each function can access the current prefix argument through the
10602 variable `current-prefix-arg'. Note that a single prefix is used
10603 to force opening a link in Emacs, so it may be good to only use a
10604 numeric or double prefix to guide the search function.
10606 In case this is needed, a function in this hook can also restore
10607 the window configuration before `org-open-at-point' was called using:
10609 (set-window-configuration org-window-config-before-follow-link)")
10611 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10612 (defun org-link-search (s &optional type avoid-pos stealth)
10613 "Search for a link search option.
10614 If S is surrounded by forward slashes, it is interpreted as a
10615 regular expression. In org-mode files, this will create an `org-occur'
10616 sparse tree. In ordinary files, `occur' will be used to list matches.
10617 If the current buffer is in `dired-mode', grep will be used to search
10618 in all files. If AVOID-POS is given, ignore matches near that position.
10620 When optional argument STEALTH is non-nil, do not modify
10621 visibility around point, thus ignoring
10622 `org-show-hierarchy-above', `org-show-following-heading' and
10623 `org-show-siblings' variables."
10624 (let ((case-fold-search t)
10628 org-emphasis-alist)
10630 (pos (point))
10631 (pre nil) (post nil)
10632 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10633 (cond
10634 ;; First check if there are any special search functions
10635 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10636 ;; Now try the builtin stuff
10637 ((and (equal (string-to-char s0) ?#)
10638 (> (length s0) 1)
10639 (save-excursion
10640 (goto-char (point-min))
10641 (and
10642 (re-search-forward
10645 (setq type 'dedicated
10646 pos (match-beginning 0))))
10647 ;; There is an exact target for this
10648 (goto-char pos)
10649 (org-back-to-heading t)))
10650 ((save-excursion
10651 (goto-char (point-min))
10652 (and
10653 (re-search-forward
10654 (concat "<<" (regexp-quote s0) ">>") nil t)
10655 (setq type 'dedicated
10656 pos (match-beginning 0))))
10657 ;; There is an exact target for this
10658 (goto-char pos))
10659 ((save-excursion
10660 (goto-char (point-min))
10661 (and
10662 (re-search-forward
10664 (setq type 'dedicated pos (match-beginning 0))))
10665 ;; Found an element with a matching #+name affiliated keyword.
10666 (goto-char pos))
10668 (save-excursion
10669 (goto-char (point-min))
10670 (and
10671 (re-search-forward
10672 (concat "[^[]" (regexp-quote
10673 (format org-coderef-label-format
10674 (match-string 1 s0))))
10675 nil t)
10676 (setq type 'dedicated
10677 pos (1+ (match-beginning 0))))))
10678 ;; There is a coderef target for this
10679 (goto-char pos))
10681 ;; A regular expression
10682 (cond
10683 ((derived-mode-p 'org-mode)
10684 (org-occur (match-string 1 s)))
10685 (t (org-do-occur (match-string 1 s)))))
10686 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10687 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10688 (goto-char (point-min))
10689 (cond
10690 ((let (case-fold-search)
10691 (re-search-forward (format org-complex-heading-regexp-format
10692 (regexp-quote s))
10693 nil t))
10694 ;; OK, found a match
10695 (setq type 'dedicated)
10696 (goto-char (match-beginning 0)))
10697 ((and (not org-link-search-inhibit-query)
10698 (eq org-link-search-must-match-exact-headline 'query-to-create)
10699 (y-or-n-p "No match - create this as a new heading? "))
10700 (goto-char (point-max))
10701 (or (bolp) (newline))
10703 (beginning-of-line 0))
10704 (t
10705 (goto-char pos)
10706 (error "No match"))))
10707 (t
10708 ;; A normal search string
10709 (when (equal (string-to-char s) ?*)
10710 ;; Anchor on headlines, post may include tags.
10713 s (substring s 1)))
10714 (remove-text-properties
10715 0 (length s)
10716 '(face nil mouse-face nil keymap nil fontified nil) s)
10717 ;; Make a series of regular expressions to find a match
10728 re4 (concat "[^a-zA-Z_]" re4_)
10730 re1 (concat pre re2 post)
10731 re3 (concat pre (if pre re4_ re4) post)
10732 re5 (concat pre ".*" re4)
10733 re2 (concat pre re2)
10734 re2a (concat pre (if pre re2a_ re2a))
10735 re4 (concat pre (if pre re4_ re4))
10739 ))
10740 (cond
10741 ((eq type 'org-occur) (org-occur reall))
10742 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10743 (t (goto-char (point-min))
10744 (setq type 'fuzzy)
10745 (if (or (and (org-search-not-self 1 re0 nil t)
10746 (setq type 'dedicated))
10747 (org-search-not-self 1 re1 nil t)
10748 (org-search-not-self 1 re2 nil t)
10749 (org-search-not-self 1 re2a nil t)
10750 (org-search-not-self 1 re3 nil t)
10751 (org-search-not-self 1 re4 nil t)
10752 (org-search-not-self 1 re5 nil t))
10753 (goto-char (match-beginning 1))
10754 (goto-char pos)
10755 (error "No match"))))))
10756 (and (derived-mode-p 'org-mode)
10757 (not stealth)
10758 (org-show-context 'link-search))
10759 type))
10761 (defun org-search-not-self (group &rest args)
10762 "Execute `re-search-forward', but only accept matches that do not
10763 enclose the position of `org-open-link-marker'."
10764 (let ((m org-open-link-marker))
10765 (catch 'exit
10766 (while (apply 're-search-forward args)
10767 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10768 (goto-char (match-end group))
10769 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10770 (> (match-beginning 0) (marker-position m))
10771 (< (match-end 0) (marker-position m)))
10772 (save-match-data
10773 (or (not (org-in-regexp
10774 org-bracket-link-analytic-regexp 1))
10775 (not (match-end 4)) ; no description
10776 (and (<= (match-beginning 4) (point))
10777 (>= (match-end 4) (point))))))
10778 (throw 'exit (point))))))))
10780 (defun org-get-buffer-for-internal-link (buffer)
10781 "Return a buffer to be used for displaying the link target of internal links."
10782 (cond
10783 ((not org-display-internal-link-with-indirect-buffer)
10784 buffer)
10785 ((string-match "(Clone)$" (buffer-name buffer))
10786 (message "Buffer is already a clone, not making another one")
10787 ;; we also do not modify visibility in this case
10788 buffer)
10789 (t ; make a new indirect buffer for displaying the link
10790 (let* ((bn (buffer-name buffer))
10791 (ibn (concat bn "(Clone)"))
10792 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10793 (with-current-buffer ib (org-overview))
10794 ib))))
10796 (defun org-do-occur (regexp &optional cleanup)
10797 "Call the Emacs command `occur'.
10798 If CLEANUP is non-nil, remove the printout of the regular expression
10799 in the *Occur* buffer. This is useful if the regex is long and not useful
10800 to read."
10801 (occur regexp)
10802 (when cleanup
10803 (let ((cwin (selected-window)) win beg end)
10804 (when (setq win (get-buffer-window "*Occur*"))
10805 (select-window win))
10806 (goto-char (point-min))
10807 (when (re-search-forward "match[a-z]+" nil t)
10808 (setq beg (match-end 0))
10810 (setq end (1- (match-beginning 0)))))
10811 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10812 (goto-char (point-min))
10813 (select-window cwin))))
10815 ;;; The mark ring for links jumps
10817 (defvar org-mark-ring nil
10818 "Mark ring for positions before jumps in Org-mode.")
10819 (defvar org-mark-ring-last-goto nil
10820 "Last position in the mark ring used to go back.")
10821 ;; Fill and close the ring
10822 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10823 (loop for i from 1 to org-mark-ring-length do
10824 (push (make-marker) org-mark-ring))
10825 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10826 org-mark-ring)
10828 (defun org-mark-ring-push (&optional pos buffer)
10829 "Put the current position or POS into the mark ring and rotate it."
10830 (interactive)
10831 (setq pos (or pos (point)))
10832 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10833 (move-marker (car org-mark-ring)
10834 (or pos (point))
10835 (or buffer (current-buffer)))
10836 (message "%s"
10837 (substitute-command-keys
10840 (defun org-mark-ring-goto (&optional n)
10841 "Jump to the previous position in the mark ring.
10842 With prefix arg N, jump back that many stored positions. When
10843 called several times in succession, walk through the entire ring.
10844 Org-mode commands jumping to a different position in the current file,
10845 or to another Org-mode file, automatically push the old position
10846 onto the ring."
10847 (interactive "p")
10848 (let (p m)
10849 (if (eq last-command this-command)
10850 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
10851 (setq p org-mark-ring))
10852 (setq org-mark-ring-last-goto p)
10853 (setq m (car p))
10854 (org-pop-to-buffer-same-window (marker-buffer m))
10855 (goto-char m)
10856 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
10858 (defun org-remove-angle-brackets (s)
10859 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
10860 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
10861 s)
10862 (defun org-add-angle-brackets (s)
10863 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
10864 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
10865 s)
10866 (defun org-remove-double-quotes (s)
10869 s)
10871 ;;; Following specific links
10873 (defun org-follow-timestamp-link ()
10874 "Open an agenda view for the time-stamp date/range at point."
10875 (cond
10876 ((org-at-date-range-p t)
10877 (let ((org-agenda-start-on-weekday)
10878 (t1 (match-string 1))
10879 (t2 (match-string 2)) tt1 tt2)
10880 (setq tt1 (time-to-days (org-time-string-to-time t1))
10881 tt2 (time-to-days (org-time-string-to-time t2)))
10882 (let ((org-agenda-buffer-tmp-name
10883 (format "*Org Agenda(a:%s)"
10884 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
10885 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
10886 ((org-at-timestamp-p t)
10887 (let ((org-agenda-buffer-tmp-name
10888 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
10889 (org-agenda-list nil (time-to-days (org-time-string-to-time
10890 (substring (match-string 1) 0 10)))
10891 1)))
10892 (t (error "This should not happen"))))
10895 ;;; Following file links
10896 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
10897 (declare-function mailcap-extension-to-mime "mailcap" (extn))
10898 (declare-function mailcap-mime-info
10899 "mailcap" (string &optional request no-decode))
10900 (defvar org-wait nil)
10901 (defun org-open-file (path &optional in-emacs line search)
10902 "Open the file at PATH.
10903 First, this expands any special file name abbreviations. Then the
10904 configuration variable `org-file-apps' is checked if it contains an
10905 entry for this file type, and if yes, the corresponding command is launched.
10907 If no application is found, Emacs simply visits the file.
10909 With optional prefix argument IN-EMACS, Emacs will visit the file.
10911 prefix arg, Org tries to avoid opening in Emacs
10912 and to use an external application to visit the file.
10914 Optional LINE specifies a line to go to, optional SEARCH a string
10915 to search for. If LINE or SEARCH is given, the file will be
10916 opened in Emacs, unless an entry from org-file-apps that makes
10917 use of groups in a regexp matches.
10919 If you want to change the way frames are used when following a
10920 link, please customize `org-link-frame-setup'.
10922 If the file does not exist, an error is thrown."
10923 (let* ((file (if (equal path "")
10924 buffer-file-name
10925 (substitute-in-file-name (expand-file-name path))))
10926 (file-apps (append org-file-apps (org-default-apps)))
10927 (apps (org-remove-if
10928 'org-file-apps-entry-match-against-dlink-p file-apps))
10929 (apps-dlink (org-remove-if-not
10930 'org-file-apps-entry-match-against-dlink-p file-apps))
10931 (remp (and (assq 'remote apps) (org-file-remote-p file)))
10932 (dirp (if remp nil (file-directory-p file)))
10933 (file (if (and dirp org-open-directory-means-index-dot-org)
10934 (concat (file-name-as-directory file) "index.org")
10935 file))
10936 (a-m-a-p (assq 'auto-mode apps))
10937 (dfile (downcase file))
10938 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
10939 (link (cond ((and (eq line nil)
10940 (eq search nil))
10941 file)
10942 (line
10943 (concat file "::" (number-to-string line)))
10944 (search
10945 (concat file "::" search))))
10946 (dlink (downcase link))
10947 (old-buffer (current-buffer))
10948 (old-pos (point))
10949 (old-mode major-mode)
10950 ext cmd link-match-data)
10952 (setq ext (match-string 1 dfile))
10954 (setq ext (match-string 1 dfile))))
10955 (cond
10956 ((member in-emacs '((16) system))
10957 (setq cmd (cdr (assoc 'system apps))))
10958 (in-emacs (setq cmd 'emacs))
10959 (t
10960 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
10961 (and dirp (cdr (assoc 'directory apps)))
10962 ; first, try matching against apps-dlink
10963 ; if we get a match here, store the match data for later
10964 (let ((match (assoc-default dlink apps-dlink
10965 'string-match)))
10966 (if match
10967 (progn (setq link-match-data (match-data))
10968 match)
10969 (progn (setq in-emacs (or in-emacs line search))
10970 nil))) ; if we have no match in apps-dlink,
10971 ; always open the file in emacs if line or search
10972 ; is given (for backwards compatibility)
10973 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
10974 'string-match)
10975 (cdr (assoc ext apps))
10976 (cdr (assoc t apps))))))
10977 (when (eq cmd 'system)
10978 (setq cmd (cdr (assoc 'system apps))))
10979 (when (eq cmd 'default)
10980 (setq cmd (cdr (assoc t apps))))
10981 (when (eq cmd 'mailcap)
10982 (require 'mailcap)
10983 (mailcap-parse-mailcaps)
10984 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
10985 (command (mailcap-mime-info mime-type)))
10986 (if (stringp command)
10987 (setq cmd command)
10988 (setq cmd 'emacs))))
10989 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
10990 (not (file-exists-p file))
10991 (not org-open-non-existing-files))
10992 (error "No such file: %s" file))
10993 (cond
10995 ;; Remove quotes around the file name - we'll use shell-quote-argument.
10997 (setq cmd (replace-match "%s" t t cmd)))
10998 (while (string-match "%s" cmd)
10999 (setq cmd (replace-match
11000 (save-match-data
11001 (shell-quote-argument
11002 (convert-standard-filename file)))
11003 t t cmd)))
11005 ;; Replace "%1", "%2" etc. in command with group matches from regex
11006 (save-match-data
11007 (let ((match-index 1)
11008 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11009 (set-match-data link-match-data)
11010 (while (<= match-index number-of-groups)
11011 (let ((regex (concat "%" (number-to-string match-index)))
11012 (replace-with (match-string match-index dlink)))
11013 (while (string-match regex cmd)
11014 (setq cmd (replace-match replace-with t t cmd))))
11015 (setq match-index (+ match-index 1)))))
11017 (save-window-excursion
11018 (message "Running %s...done" cmd)
11019 (start-process-shell-command cmd nil cmd)
11020 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11021 ((or (stringp cmd)
11022 (eq cmd 'emacs))
11023 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11024 (widen)
11025 (if line (org-goto-line line)
11026 (if search (org-link-search search))))
11027 ((consp cmd)
11028 (let ((file (convert-standard-filename file)))
11029 (save-match-data
11030 (set-match-data link-match-data)
11031 (eval cmd))))
11032 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11033 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11034 (or (not (equal old-buffer (current-buffer)))
11035 (not (equal old-pos (point))))
11036 (org-mark-ring-push old-pos old-buffer))))
11038 (defun org-file-apps-entry-match-against-dlink-p (entry)
11039 "This function returns non-nil if `entry' uses a regular
11040 expression which should be matched against the whole link by
11041 org-open-file.
11043 It assumes that is the case when the entry uses a regular
11044 expression which has at least one grouping construct and the
11045 action is either a lisp form or a command string containing
11046 '%1', i.e. using at least one subexpression match as a
11047 parameter."
11048 (let ((selector (car entry))
11049 (action (cdr entry)))
11050 (if (stringp selector)
11051 (and (> (regexp-opt-depth selector) 0)
11052 (or (and (stringp action)
11053 (string-match "%[0-9]" action))
11054 (consp action)))
11055 nil)))
11057 (defun org-default-apps ()
11058 "Return the default applications for this operating system."
11059 (cond
11060 ((eq system-type 'darwin)
11061 org-file-apps-defaults-macosx)
11062 ((eq system-type 'windows-nt)
11063 org-file-apps-defaults-windowsnt)
11064 (t org-file-apps-defaults-gnu)))
11066 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11067 "Convert extensions to regular expressions in the cars of LIST.
11068 Also, weed out any non-string entries, because the return value is used
11069 only for regexp matching.
11070 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11071 point to the symbol `emacs', indicating that the file should
11072 be opened in Emacs."
11073 (append
11074 (delq nil
11075 (mapcar (lambda (x)
11076 (if (not (stringp (car x)))
11077 nil
11079 x
11081 list))
11082 (if add-auto-mode
11083 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11085 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11086 (defun org-file-remote-p (file)
11087 "Test whether FILE specifies a location on a remote system.
11088 Return non-nil if the location is indeed remote.
11092 (cond ((fboundp 'file-remote-p)
11093 (file-remote-p file))
11094 ((fboundp 'tramp-handle-file-remote-p)
11095 (tramp-handle-file-remote-p file))
11096 ((and (boundp 'ange-ftp-name-format)
11097 (string-match (car ange-ftp-name-format) file))
11098 t)))
11101 ;;;; Refiling
11103 (defun org-get-org-file ()
11104 "Read a filename, with default directory `org-directory'."
11105 (let ((default (or org-default-notes-file remember-data-file)))
11106 (read-file-name (format "File name [%s]: " default)
11107 (file-name-as-directory org-directory)
11108 default)))
11110 (defun org-notes-order-reversed-p ()
11111 "Check if the current file should receive notes in reversed order."
11112 (cond
11113 ((not org-reverse-note-order) nil)
11114 ((eq t org-reverse-note-order) t)
11115 ((not (listp org-reverse-note-order)) nil)
11116 (t (catch 'exit
11117 (let ((all org-reverse-note-order)
11118 entry)
11119 (while (setq entry (pop all))
11120 (if (string-match (car entry) buffer-file-name)
11121 (throw 'exit (cdr entry))))
11122 nil)))))
11124 (defvar org-refile-target-table nil
11125 "The list of refile targets, created by `org-refile'.")
11127 (defvar org-agenda-new-buffers nil
11128 "Buffers created to visit agenda files.")
11130 (defvar org-refile-cache nil
11131 "Cache for refile targets.")
11133 (defvar org-refile-markers nil
11134 "All the markers used for caching refile locations.")
11136 (defun org-refile-marker (pos)
11137 "Get a new refile marker, but only if caching is in use."
11138 (if (not org-refile-use-cache)
11139 pos
11140 (let ((m (make-marker)))
11141 (move-marker m pos)
11142 (push m org-refile-markers)
11143 m)))
11145 (defun org-refile-cache-clear ()
11146 "Clear the refile cache and disable all the markers."
11147 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11148 (setq org-refile-markers nil)
11149 (setq org-refile-cache nil)
11150 (message "Refile cache has been cleared"))
11152 (defun org-refile-cache-check-set (set)
11153 "Check if all the markers in the cache still have live buffers."
11154 (let (marker)
11155 (catch 'exit
11156 (while (and set (setq marker (nth 3 (pop set))))
11157 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11158 (when (and marker (null (marker-buffer marker)))
11159 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11160 (sit-for 3)
11161 (throw 'exit nil)))
11162 t)))
11164 (defun org-refile-cache-put (set &rest identifiers)
11165 "Push the refile targets SET into the cache, under IDENTIFIERS."
11166 (let* ((key (sha1 (prin1-to-string identifiers)))
11167 (entry (assoc key org-refile-cache)))
11168 (if entry
11169 (setcdr entry set)
11170 (push (cons key set) org-refile-cache))))
11172 (defun org-refile-cache-get (&rest identifiers)
11173 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11174 (cond
11175 ((not org-refile-cache) nil)
11176 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11177 (t
11178 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11179 org-refile-cache))))
11180 (and set (org-refile-cache-check-set set) set)))))
11182 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11183 "Produce a table with refile targets."
11184 (let ((case-fold-search nil)
11185 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11186 (entries (or org-refile-targets '((nil . (:level . 1)))))
11187 targets tgs txt re files f desc descre fast-path-p level pos0)
11188 (message "Getting targets...")
11189 (with-current-buffer (or default-buffer (current-buffer))
11190 (while (setq entry (pop entries))
11191 (setq files (car entry) desc (cdr entry))
11192 (setq fast-path-p nil)
11193 (cond
11194 ((null files) (setq files (list (current-buffer))))
11195 ((eq files 'org-agenda-files)
11196 (setq files (org-agenda-files 'unrestricted)))
11197 ((and (symbolp files) (fboundp files))
11198 (setq files (funcall files)))
11199 ((and (symbolp files) (boundp files))
11200 (setq files (symbol-value files))))
11201 (if (stringp files) (setq files (list files)))
11202 (cond
11203 ((eq (car desc) :tag)
11205 ((eq (car desc) :todo)
11207 ((eq (car desc) :regexp)
11208 (setq descre (cdr desc)))
11209 ((eq (car desc) :level)
11211 (if org-odd-levels-only
11212 (1- (* 2 (cdr desc)))
11213 (cdr desc)))
11215 ((eq (car desc) :maxlevel)
11216 (setq fast-path-p t)
11218 (if org-odd-levels-only
11219 (1- (* 2 (cdr desc)))
11220 (cdr desc)))
11222 (t (error "Bad refiling target description %s" desc)))
11223 (while (setq f (pop files))
11224 (with-current-buffer
11225 (if (bufferp f) f (org-get-agenda-file-buffer f))
11226 (or
11227 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11228 (progn
11229 (if (bufferp f) (setq f (buffer-file-name
11230 (buffer-base-buffer f))))
11231 (setq f (and f (expand-file-name f)))
11232 (if (eq org-refile-use-outline-path 'file)
11233 (push (list (file-name-nondirectory f) f nil nil) tgs))
11234 (save-excursion
11235 (save-restriction
11236 (widen)
11237 (goto-char (point-min))
11238 (while (re-search-forward descre nil t)
11239 (goto-char (setq pos0 (point-at-bol)))
11240 (catch 'next
11241 (when org-refile-target-verify-function
11242 (save-match-data
11243 (or (funcall org-refile-target-verify-function)
11244 (throw 'next t))))
11245 (when (and (looking-at org-complex-heading-regexp)
11246 (not (member (match-string 4) excluded-entries))
11247 (match-string 4))
11248 (setq level (org-reduced-level
11249 (- (match-end 1) (match-beginning 1)))
11250 txt (org-link-display-format (match-string 4))
11252 re (format org-complex-heading-regexp-format
11253 (regexp-quote (match-string 4))))
11254 (when org-refile-use-outline-path
11255 (setq txt (mapconcat
11256 'org-protect-slash
11257 (append
11258 (if (eq org-refile-use-outline-path
11259 'file)
11260 (list (file-name-nondirectory
11261 (buffer-file-name
11262 (buffer-base-buffer))))
11263 (if (eq org-refile-use-outline-path
11264 'full-file-path)
11265 (list (buffer-file-name
11266 (buffer-base-buffer)))))
11267 (org-get-outline-path fast-path-p
11268 level txt)
11269 (list txt))
11270 "/")))
11271 (push (list txt f re (org-refile-marker (point)))
11272 tgs)))
11273 (when (= (point) pos0)
11274 ;; verification function has not moved point
11275 (goto-char (point-at-eol))))))))
11276 (when org-refile-use-cache
11277 (org-refile-cache-put tgs (buffer-file-name) descre))
11278 (setq targets (append tgs targets))
11279 ))))
11280 (message "Getting targets...done")
11281 (nreverse targets)))
11283 (defun org-protect-slash (s)
11284 (while (string-match "/" s)
11286 s)
11288 (defvar org-olpa (make-vector 20 nil))
11290 (defun org-get-outline-path (&optional fastp level heading)
11291 "Return the outline path to the current entry, as a list.
11293 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11294 routine which makes outline path derivations for an entire file,
11295 avoiding backtracing. Refile target collection makes use of that."
11296 (if fastp
11297 (progn
11298 (if (> level 19)
11299 (error "Outline path failure, more than 19 levels"))
11300 (loop for i from level upto 19 do
11301 (aset org-olpa i nil))
11302 (prog1
11303 (delq nil (append org-olpa nil))
11304 (aset org-olpa level heading)))
11305 (let (rtn case-fold-search)
11306 (save-excursion
11307 (save-restriction
11308 (widen)
11309 (while (org-up-heading-safe)
11310 (when (looking-at org-complex-heading-regexp)
11311 (push (org-match-string-no-properties 4) rtn)))
11312 rtn)))))
11314 (defun org-format-outline-path (path &optional width prefix separator)
11315 "Format the outline path PATH for display.
11316 WIDTH is the maximum number of characters that is available.
11317 PREFIX is a prefix to be included in the returned string,
11318 such as the file name.
11319 SEPARATOR is inserted between the different parts of the path,
11321 (setq width (or width 79))
11322 (if prefix (setq width (- width (length prefix))))
11323 (if (not path)
11324 (or prefix "")
11325 (let* ((nsteps (length path))
11326 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11327 (maxwidth (if (<= total-width width)
11328 10000 ;; everything fits
11329 ;; we need to shorten the level headings
11330 (/ (- width nsteps) nsteps)))
11331 (org-odd-levels-only nil)
11332 (n 0)
11333 (total (1+ (length prefix))))
11334 (setq maxwidth (max maxwidth 10))
11335 (concat prefix
11336 (if prefix (or separator "/"))
11337 (mapconcat
11338 (lambda (h)
11339 (setq n (1+ n))
11340 (if (and (= n nsteps) (< maxwidth 10000))
11341 (setq maxwidth (- total-width total)))
11342 (if (< (length h) maxwidth)
11343 (progn (setq total (+ total (length h) 1)) h)
11344 (setq h (substring h 0 (- maxwidth 2))
11345 total (+ total maxwidth 1))
11347 (setq h (substring h 0 (match-beginning 0))))
11348 (setq h (concat h "..")))
11349 (org-add-props h nil 'face
11350 (nth (% (1- n) org-n-level-faces)
11351 org-level-faces))
11352 h)
11353 path (or separator "/"))))))
11355 (defun org-display-outline-path (&optional file current separator just-return-string)
11356 "Display the current outline path in the echo area.
11358 If FILE is non-nil, prepend the output with the file name.
11359 If CURRENT is non-nil, append the current heading to the output.
11360 SEPARATOR is passed through to `org-format-outline-path'. It separates
11362 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11363 (interactive "P")
11364 (let* (case-fold-search
11365 message-log-max ; Don't populate the *Messages* buffer
11366 (bfn (buffer-file-name (buffer-base-buffer)))
11367 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11368 res)
11369 (if current (setq path (append path
11370 (save-excursion
11371 (org-back-to-heading t)
11372 (if (looking-at org-complex-heading-regexp)
11373 (list (match-string 4)))))))
11374 (setq res
11375 (org-format-outline-path
11376 path
11377 (1- (frame-width))
11378 (and file bfn (concat (file-name-nondirectory bfn) separator))
11379 separator))
11380 (if just-return-string
11381 (org-no-properties res)
11382 (message "%s" res))))
11384 (defvar org-refile-history nil
11385 "History for refiling operations.")
11387 (defvar org-after-refile-insert-hook nil
11388 "Hook run after `org-refile' has inserted its stuff at the new location.
11389 Note that this is still *before* the stuff will be removed from
11390 the *old* location.")
11392 (defvar org-capture-last-stored-marker)
11393 (defvar org-refile-keep nil
11394 "Non-nil means `org-refile' will copy instead of refile.")
11396 (defun org-copy ()
11397 "Like `org-refile', but copy."
11398 (interactive)
11399 (let ((org-refile-keep t))
11400 (funcall 'org-refile nil nil nil "Copy")))
11402 (defun org-refile (&optional goto default-buffer rfloc msg)
11403 "Move the entry or entries at point to another heading.
11404 The list of target headings is compiled using the information in
11405 `org-refile-targets', which see.
11407 At the target location, the entry is filed as a subitem of the target
11408 heading. Depending on `org-reverse-note-order', the new subitem will
11409 either be the first or the last subitem.
11411 If there is an active region, all entries in that region will be moved.
11412 However, the region must fulfill the requirement that the first heading
11413 is the first one sets the top-level of the moved text - at most siblings
11414 below it are allowed.
11416 With prefix arg GOTO, the command will only visit the target location
11417 and not actually move anything.
11420 go to the location where the last refiling operation has put the subtree.
11421 With a prefix argument of `2', refile to the running clock.
11423 RFLOC can be a refile location obtained in a different way.
11428 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11430 If you are using target caching (see `org-refile-use-cache'),
11431 you have to clear the target cache in order to find new targets.
11432 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11433 prefix argument (`C-u C-u C-u C-c C-w')."
11435 (interactive "P")
11436 (if (member goto '(0 (64)))
11437 (org-refile-cache-clear)
11438 (let* ((actionmsg (or msg "Refile"))
11439 (cbuf (current-buffer))
11440 (regionp (org-region-active-p))
11441 (region-start (and regionp (region-beginning)))
11442 (region-end (and regionp (region-end)))
11443 (region-length (and regionp (- region-end region-start)))
11444 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11445 pos it nbuf file re level reversed)
11446 (setq last-command nil)
11447 (when regionp
11448 (goto-char region-start)
11449 (or (bolp) (goto-char (point-at-bol)))
11450 (setq region-start (point))
11451 (unless (or (org-kill-is-subtree-p
11452 (buffer-substring region-start region-end))
11453 (prog1 org-refile-active-region-within-subtree
11454 (org-toggle-heading)))
11455 (error "The region is not a (sequence of) subtree(s)")))
11456 (if (equal goto '(16))
11457 (org-refile-goto-last-stored)
11458 (when (or
11459 (and (equal goto 2)
11460 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11461 (prog1
11462 (setq it (list (or org-clock-heading "running clock")
11463 (buffer-file-name
11464 (marker-buffer org-clock-hd-marker))
11465 ""
11466 (marker-position org-clock-hd-marker)))
11467 (setq goto nil)))
11468 (setq it (or rfloc
11469 (let (heading-text)
11470 (save-excursion
11471 (unless goto
11472 (org-back-to-heading t)
11473 (setq heading-text
11474 (nth 4 (org-heading-components))))
11476 (org-refile-get-location
11477 (cond (goto "Goto")
11478 (regionp (concat actionmsg " region to"))
11481 default-buffer
11482 (and (not (equal '(4) goto))
11483 org-refile-allow-creating-parent-nodes)
11484 goto))))))
11485 (setq file (nth 1 it)
11486 re (nth 2 it)
11487 pos (nth 3 it))
11488 (if (and (not goto)
11489 pos
11490 (equal (buffer-file-name) file)
11491 (if regionp
11492 (and (>= pos region-start)
11493 (<= pos region-end))
11494 (and (>= pos (point))
11495 (< pos (save-excursion
11496 (org-end-of-subtree t t))))))
11497 (error "Cannot refile to position inside the tree or region"))
11499 (setq nbuf (or (find-buffer-visiting file)
11500 (find-file-noselect file)))
11501 (if goto
11502 (progn
11503 (org-pop-to-buffer-same-window nbuf)
11504 (goto-char pos)
11505 (org-show-context 'org-goto))
11506 (if regionp
11507 (progn
11508 (org-kill-new (buffer-substring region-start region-end))
11509 (org-save-markers-in-region region-start region-end))
11510 (org-copy-subtree 1 nil t))
11511 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11512 (find-file-noselect file)))
11513 (setq reversed (org-notes-order-reversed-p))
11514 (save-excursion
11515 (save-restriction
11516 (widen)
11517 (if pos
11518 (progn
11519 (goto-char pos)
11520 (looking-at org-outline-regexp)
11521 (setq level (org-get-valid-level (funcall outline-level) 1))
11522 (goto-char
11523 (if reversed
11524 (or (outline-next-heading) (point-max))
11525 (or (save-excursion (org-get-next-sibling))
11526 (org-end-of-subtree t t)
11527 (point-max)))))
11528 (setq level 1)
11529 (if (not reversed)
11530 (goto-char (point-max))
11531 (goto-char (point-min))
11532 (or (outline-next-heading) (goto-char (point-max)))))
11533 (if (not (bolp)) (newline))
11534 (org-paste-subtree level)
11535 (when org-log-refile
11536 (org-add-log-setup 'refile nil nil 'findpos
11537 org-log-refile)
11538 (unless (eq org-log-refile 'note)
11539 (save-excursion (org-add-log-note))))
11540 (and org-auto-align-tags
11541 (let ((org-loop-over-headlines-in-active-region nil))
11542 (org-set-tags nil t)))
11543 (with-demoted-errors
11544 (bookmark-set "org-refile-last-stored"))
11545 ;; If we are refiling for capture, make sure that the
11546 ;; last-capture pointers point here
11547 (when (org-bound-and-true-p org-refile-for-capture)
11548 (with-demoted-errors
11549 (bookmark-set "org-capture-last-stored-marker"))
11550 (move-marker org-capture-last-stored-marker (point)))
11551 (if (fboundp 'deactivate-mark) (deactivate-mark))
11552 (run-hooks 'org-after-refile-insert-hook))))
11553 (unless org-refile-keep
11554 (if regionp
11555 (delete-region (point) (+ (point) region-length))
11556 (org-cut-subtree)))
11557 (when (featurep 'org-inlinetask)
11558 (org-inlinetask-remove-END-maybe))
11559 (setq org-markers-to-move nil)
11562 (defun org-refile-goto-last-stored ()
11563 "Go to the location where the last refile was stored."
11564 (interactive)
11565 (bookmark-jump "org-refile-last-stored")
11566 (message "This is the location of the last refile"))
11568 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11569 no-exclude)
11570 "Prompt the user for a refile location, using PROMPT.
11571 PROMPT should not be suffixed with a colon and a space, because
11572 this function appends the default value from
11573 `org-refile-history' automatically, if that is not empty.
11574 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11575 this is used for the GOTO interface."
11576 (let ((org-refile-targets org-refile-targets)
11577 (org-refile-use-outline-path org-refile-use-outline-path)
11578 excluded-entries)
11579 (when (and (derived-mode-p 'org-mode)
11580 (not org-refile-use-cache)
11581 (not no-exclude))
11582 (org-map-tree
11583 (lambda()
11584 (setq excluded-entries
11585 (append excluded-entries (list (org-get-heading t t)))))))
11586 (setq org-refile-target-table
11587 (org-refile-get-targets default-buffer excluded-entries)))
11588 (unless org-refile-target-table
11589 (error "No refile targets"))
11590 (let* ((cbuf (current-buffer))
11591 (partial-completion-mode nil)
11592 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11593 (cfunc (if (and org-refile-use-outline-path
11594 org-outline-path-complete-in-steps)
11595 'org-olpath-completing-read
11596 'org-icompleting-read))
11597 (extra (if org-refile-use-outline-path "/" ""))
11598 (cbnex (concat (buffer-name) extra))
11599 (filename (and cfn (expand-file-name cfn)))
11600 (tbl (mapcar
11601 (lambda (x)
11602 (if (and (not (member org-refile-use-outline-path
11603 '(file full-file-path)))
11604 (not (equal filename (nth 1 x))))
11605 (cons (concat (car x) extra " ("
11606 (file-name-nondirectory (nth 1 x)) ")")
11607 (cdr x))
11608 (cons (concat (car x) extra) (cdr x))))
11609 org-refile-target-table))
11610 (completion-ignore-case t)
11611 cdef
11612 (prompt (concat prompt
11613 (or (and (car org-refile-history)
11614 (concat " (default " (car org-refile-history) ")"))
11615 (and (assoc cbnex tbl) (setq cdef cbnex)
11616 (concat " (default " cbnex ")"))) ": "))
11617 pa answ parent-target child parent old-hist)
11618 (setq old-hist org-refile-history)
11619 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11620 nil 'org-refile-history (or cdef (car org-refile-history))))
11621 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
11622 (org-refile-check-position pa)
11623 (if pa
11624 (progn
11625 (when (or (not org-refile-history)
11626 (not (eq old-hist org-refile-history))
11627 (not (equal (car pa) (car org-refile-history))))
11628 (setq org-refile-history
11629 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11630 org-refile-history
11631 (cdr org-refile-history))))
11632 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11633 (pop org-refile-history)))
11634 pa)
11636 (progn
11637 (setq parent (match-string 1 answ)
11638 child (match-string 2 answ))
11639 (setq parent-target (or (assoc parent tbl)
11640 (assoc (concat parent "/") tbl)))
11641 (when (and parent-target
11642 (or (eq new-nodes t)
11643 (and (eq new-nodes 'confirm)
11645 child)))))
11646 (org-refile-new-child parent-target child)))
11647 (error "Invalid target location")))))
11649 (declare-function org-string-nw-p "org-macs" (s))
11650 (defun org-refile-check-position (refile-pointer)
11651 "Check if the refile pointer matches the headline to which it points."
11652 (let* ((file (nth 1 refile-pointer))
11653 (re (nth 2 refile-pointer))
11654 (pos (nth 3 refile-pointer))
11655 buffer)
11656 (if (and (not (markerp pos)) (not file))
11657 (error "Please save the buffer to a file before refiling")
11658 (when (org-string-nw-p re)
11659 (setq buffer (if (markerp pos)
11660 (marker-buffer pos)
11661 (or (find-buffer-visiting file)
11662 (find-file-noselect file))))
11663 (with-current-buffer buffer
11664 (save-excursion
11665 (save-restriction
11666 (widen)
11667 (goto-char pos)
11668 (beginning-of-line 1)
11669 (unless (org-looking-at-p re)
11670 (error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11672 (defun org-refile-new-child (parent-target child)
11673 "Use refile target PARENT-TARGET to add new CHILD below it."
11674 (unless parent-target
11675 (error "Cannot find parent for new node"))
11676 (let ((file (nth 1 parent-target))
11677 (pos (nth 3 parent-target))
11678 level)
11679 (with-current-buffer (or (find-buffer-visiting file)
11680 (find-file-noselect file))
11681 (save-excursion
11682 (save-restriction
11683 (widen)
11684 (if pos
11685 (goto-char pos)
11686 (goto-char (point-max))
11687 (if (not (bolp)) (newline)))
11688 (when (looking-at org-outline-regexp)
11689 (setq level (funcall outline-level))
11690 (org-end-of-subtree t t))
11691 (org-back-over-empty-lines)
11693 (if pos (org-get-valid-level level 1) 1) ?*)
11695 (beginning-of-line 0)
11696 (list (concat (car parent-target) "/" child) file "" (point)))))))
11698 (defun org-olpath-completing-read (prompt collection &rest args)
11699 "Read an outline path like a file name."
11700 (let ((thetable collection)
11701 (org-completion-use-ido nil) ; does not work with ido.
11702 (org-completion-use-iswitchb nil)) ; or iswitchb
11703 (apply
11704 'org-icompleting-read prompt
11705 (lambda (string predicate &optional flag)
11706 (let (rtn r f (l (length string)))
11707 (cond
11708 ((eq flag nil)
11709 ;; try completion
11710 (try-completion string thetable))
11711 ((eq flag t)
11712 ;; all-completions
11713 (setq rtn (all-completions string thetable predicate))
11714 (mapcar
11715 (lambda (x)
11716 (setq r (substring x l))
11717 (if (string-match " ([^)]*)$" x)
11718 (setq f (match-string 0 x))
11719 (setq f ""))
11720 (if (string-match "/" r)
11721 (concat string (substring r 0 (match-end 0)) f)
11722 x))
11723 rtn))
11724 ((eq flag 'lambda)
11725 ;; exact match?
11726 (assoc string thetable)))))
11727 args)))
11729 ;;;; Dynamic blocks
11731 (defun org-find-dblock (name)
11732 "Find the first dynamic block with name NAME in the buffer.
11733 If not found, stay at current position and return nil."
11734 (let ((case-fold-search t) pos)
11735 (save-excursion
11736 (goto-char (point-min))
11737 (setq pos (and (re-search-forward
11739 (match-beginning 0))))
11740 (if pos (goto-char pos))
11741 pos))
11743 (defconst org-dblock-start-re
11745 "Matches the start line of a dynamic block, with parameters.")
11748 "Matches the end of a dynamic block.")
11750 (defun org-create-dblock (plist)
11751 "Create a dynamic block section, with parameters taken from PLIST.
11752 PLIST must contain a :name entry which is used as name of the block."
11754 (end-of-line 1)
11755 (newline))
11756 (let ((col (current-column))
11757 (name (plist-get plist :name)))
11758 (insert "#+BEGIN: " name)
11759 (while plist
11760 (if (eq (car plist) :name)
11761 (setq plist (cddr plist))
11762 (insert " " (prin1-to-string (pop plist)))))
11764 (beginning-of-line -2)))
11766 (defun org-prepare-dblock ()
11767 "Prepare dynamic block for refresh.
11768 This empties the block, puts the cursor at the insert position and returns
11769 the property list including an extra property :name with the block name."
11770 (unless (looking-at org-dblock-start-re)
11771 (error "Not at a dynamic block"))
11772 (let* ((begdel (1+ (match-end 0)))
11773 (name (org-no-properties (match-string 1)))
11774 (params (append (list :name name)
11775 (read (concat "(" (match-string 3) ")")))))
11776 (save-excursion
11777 (beginning-of-line 1)
11779 (setq params (plist-put params :indentation-column (current-column))))
11780 (unless (re-search-forward org-dblock-end-re nil t)
11781 (error "Dynamic block not terminated"))
11782 (setq params
11783 (append params
11784 (list :content (buffer-substring
11785 begdel (match-beginning 0)))))
11786 (delete-region begdel (match-beginning 0))
11787 (goto-char begdel)
11788 (open-line 1)
11789 params))
11791 (defun org-map-dblocks (&optional command)
11792 "Apply COMMAND to all dynamic blocks in the current buffer.
11793 If COMMAND is not given, use `org-update-dblock'."
11794 (let ((cmd (or command 'org-update-dblock)))
11795 (save-excursion
11796 (goto-char (point-min))
11797 (while (re-search-forward org-dblock-start-re nil t)
11798 (goto-char (match-beginning 0))
11799 (save-excursion
11800 (condition-case nil
11801 (funcall cmd)
11802 (error (message "Error during update of dynamic block"))))
11803 (unless (re-search-forward org-dblock-end-re nil t)
11804 (error "Dynamic block not terminated"))))))
11806 (defun org-dblock-update (&optional arg)
11807 "User command for updating dynamic blocks.
11808 Update the dynamic block at point. With prefix ARG, update all dynamic
11809 blocks in the buffer."
11810 (interactive "P")
11811 (if arg
11812 (org-update-all-dblocks)
11813 (or (looking-at org-dblock-start-re)
11814 (org-beginning-of-dblock))
11815 (org-update-dblock)))
11817 (defun org-update-dblock ()
11818 "Update the dynamic block at point.
11819 This means to empty the block, parse for parameters and then call
11820 the correct writing function."
11821 (interactive)
11822 (save-window-excursion
11823 (let* ((pos (point))
11824 (line (org-current-line))
11825 (params (org-prepare-dblock))
11826 (name (plist-get params :name))
11827 (indent (plist-get params :indentation-column))
11828 (cmd (intern (concat "org-dblock-write:" name))))
11829 (message "Updating dynamic block `%s' at line %d..." name line)
11830 (funcall cmd params)
11831 (message "Updating dynamic block `%s' at line %d...done" name line)
11832 (goto-char pos)
11833 (when (and indent (> indent 0))
11834 (setq indent (make-string indent ?\ ))
11835 (save-excursion
11836 (org-beginning-of-dblock)
11837 (forward-line 1)
11838 (while (not (looking-at org-dblock-end-re))
11839 (insert indent)
11840 (beginning-of-line 2))
11841 (when (looking-at org-dblock-end-re)
11843 (replace-match ""))
11844 (insert indent)))))))
11846 (defun org-beginning-of-dblock ()
11847 "Find the beginning of the dynamic block at point.
11848 Error if there is no such block at point."
11849 (let ((pos (point))
11850 beg)
11851 (end-of-line 1)
11852 (if (and (re-search-backward org-dblock-start-re nil t)
11853 (setq beg (match-beginning 0))
11854 (re-search-forward org-dblock-end-re nil t)
11855 (> (match-end 0) pos))
11856 (goto-char beg)
11857 (goto-char pos)
11858 (error "Not in a dynamic block"))))
11860 (defun org-update-all-dblocks ()
11861 "Update all dynamic blocks in the buffer.
11862 This function can be used in a hook."
11863 (interactive)
11864 (when (derived-mode-p 'org-mode)
11865 (org-map-dblocks 'org-update-dblock)))
11868 ;;;; Completion
11870 (defun org-get-export-keywords ()
11871 "Return a list of all currently understood export keywords.
11872 Export keywords include options, block names, attributes and
11873 keywords relative to each registered export back-end."
11874 (delq nil
11875 (let (keywords)
11876 (mapc
11877 (lambda (back-end)
11878 (let ((props (cdr back-end)))
11879 ;; Back-end name (for keywords, like #+LATEX:)
11880 (push (upcase (symbol-name (car back-end))) keywords)
11881 ;; Back-end options.
11882 (mapc (lambda (option) (push (cadr option) keywords))
11883 (plist-get (cdr back-end) :options-alist))))
11884 (org-bound-and-true-p org-export-registered-backends))
11885 keywords)))
11887 (defconst org-options-keywords
11888 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
11889 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
11890 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
11891 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
11892 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
11894 (defcustom org-structure-template-alist
11909 ("L" "#+LaTeX: "
11913 ("H" "#+HTML: "
11916 ("A" "#+ASCII: ")
11917 ("i" "#+INDEX: ?"
11918 "#+INDEX: ?")
11919 ("I" "#+INCLUDE: %file ?"
11921 "Structure completion elements.
11922 This is a list of abbreviation keys and values. The value gets inserted
11923 if you type `<' followed by the key and then press the completion key,
11924 usually `M-TAB'. %file will be replaced by a file name after prompting
11925 for the file using completion. The cursor will be placed at the position
11926 of the `?` in the template.
11927 There are two templates for each key, the first uses the original Org syntax,
11928 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
11929 the default when the /org-mtags.el/ module has been loaded. See also the
11930 variable `org-mtags-prefer-muse-templates'."
11931 :group 'org-completion
11932 :type '(repeat
11933 (string :tag "Key")
11934 (string :tag "Template")
11935 (string :tag "Muse Template")))
11937 (defun org-try-structure-completion ()
11938 "Try to complete a structure template before point.
11940 expands them."
11941 (let ((l (buffer-substring (point-at-bol) (point)))
11942 a)
11945 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
11946 (org-complete-expand-structure-template (+ -1 (point-at-bol)
11947 (match-beginning 1)) a)
11948 t)))
11950 (defun org-complete-expand-structure-template (start cell)
11951 "Expand a structure template."
11952 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
11953 (rpl (nth (if musep 2 1) cell))
11954 (ind ""))
11955 (delete-region start (point))
11957 (cond
11958 ((bolp))
11960 (setq ind (buffer-substring (point-at-bol) (point))))
11961 (t (newline))))
11962 (setq start (point))
11963 (if (string-match "%file" rpl)
11964 (setq rpl (replace-match
11965 (concat
11967 (save-match-data
11968 (abbreviate-file-name (read-file-name "Include file: ")))
11970 t t rpl)))
11973 (insert rpl)
11976 ;;;; TODO, DEADLINE, Comments
11978 (defun org-toggle-comment ()
11979 "Change the COMMENT state of an entry."
11980 (interactive)
11981 (save-excursion
11982 (org-back-to-heading)
11983 (let (case-fold-search)
11984 (cond
11985 ((looking-at (format org-heading-keyword-regexp-format
11986 org-comment-string))
11987 (goto-char (match-end 1))
11988 (looking-at (concat " +" org-comment-string))
11989 (replace-match "" t t)
11990 (when (eolp) (insert " ")))
11991 ((looking-at org-outline-regexp)
11992 (goto-char (match-end 0))
11993 (insert org-comment-string " "))))))
11995 (defvar org-last-todo-state-is-todo nil
11996 "This is non-nil when the last TODO state change led to a TODO state.
11997 If the last change removed the TODO tag or switched to DONE, then
11998 this is nil.")
12000 (defvar org-setting-tags nil) ; dynamically skipped
12002 (defvar org-todo-setup-filter-hook nil
12003 "Hook for functions that pre-filter todo specs.
12004 Each function takes a todo spec and returns either nil or the spec
12005 transformed into canonical form." )
12007 (defvar org-todo-get-default-hook nil
12008 "Hook for functions that get a default item for todo.
12009 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12010 nil or a string to be used for the todo mark." )
12012 (defvar org-agenda-headline-snapshot-before-repeat)
12014 (defun org-current-effective-time ()
12015 "Return current time adjusted for `org-extend-today-until' variable."
12016 (let* ((ct (org-current-time))
12017 (dct (decode-time ct))
12018 (ct1
12019 (cond
12020 (org-use-last-clock-out-time-as-effective-time
12021 (or (org-clock-get-last-clock-out-time) ct))
12022 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12023 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12024 (t ct))))
12025 ct1))
12027 (defun org-todo-yesterday (&optional arg)
12028 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12029 (interactive "P")
12030 (if (eq major-mode 'org-agenda-mode)
12031 (apply 'org-agenda-todo-yesterday arg)
12032 (let* ((hour (third (decode-time
12033 (org-current-time))))
12034 (org-extend-today-until (1+ hour)))
12035 (org-todo arg))))
12037 (defvar org-block-entry-blocking ""
12038 "First entry preventing the TODO state change.")
12040 (defun org-todo (&optional arg)
12041 "Change the TODO state of an item.
12042 The state of an item is given by a keyword at the start of the heading,
12043 like
12044 *** TODO Write paper
12045 *** DONE Call mom
12047 The different keywords are specified in the variable `org-todo-keywords'.
12049 So for this example: when the item starts with TODO, it is changed to DONE.
12050 When it starts with DONE, the DONE is removed. And when neither TODO nor
12051 DONE are present, add TODO at the beginning of the heading.
12054 state.
12055 With numeric prefix arg, switch to that state.
12057 keywords (nextset).
12059 With a numeric prefix arg of 0, inhibit note taking for the change.
12061 For calling through lisp, arg is also interpreted in the following way:
12062 'none -> empty state
12064 'done -> switch to DONE
12065 'nextset -> switch to the next set of keywords
12066 'previousset -> switch to the previous set of keywords
12068 really is a member of `org-todo-keywords'."
12069 (interactive "P")
12070 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12071 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12072 'region-start-level 'region))
12073 org-loop-over-headlines-in-active-region)
12074 (org-map-entries
12075 `(org-todo ,arg)
12076 org-loop-over-headlines-in-active-region
12077 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12078 (if (equal arg '(16)) (setq arg 'nextset))
12079 (let ((org-blocker-hook org-blocker-hook)
12080 commentp
12081 case-fold-search)
12082 (when (equal arg '(64))
12083 (setq arg nil org-blocker-hook nil))
12084 (when (and org-blocker-hook
12085 (or org-inhibit-blocking
12086 (org-entry-get nil "NOBLOCKING")))
12087 (setq org-blocker-hook nil))
12088 (save-excursion
12089 (catch 'exit
12090 (org-back-to-heading t)
12092 (org-toggle-comment)
12093 (setq commentp t))
12094 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12097 (let* ((match-data (match-data))
12098 (startpos (point-at-bol))
12099 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12100 (org-log-done org-log-done)
12101 (org-log-repeat org-log-repeat)
12102 (org-todo-log-states org-todo-log-states)
12103 (org-inhibit-logging
12104 (if (equal arg 0)
12105 (progn (setq arg nil) 'note) org-inhibit-logging))
12106 (this (match-string 1))
12107 (hl-pos (match-beginning 0))
12108 (head (org-get-todo-sequence-head this))
12109 (ass (assoc head org-todo-kwd-alist))
12110 (interpret (nth 1 ass))
12111 (done-word (nth 3 ass))
12112 (final-done-word (nth 4 ass))
12113 (org-last-state (or this ""))
12114 (completion-ignore-case t)
12115 (member (member this org-todo-keywords-1))
12116 (tail (cdr member))
12117 (org-state (cond
12118 ((and org-todo-key-trigger
12119 (or (and (equal arg '(4))
12120 (eq org-use-fast-todo-selection 'prefix))
12121 (and (not arg) org-use-fast-todo-selection
12122 (not (eq org-use-fast-todo-selection
12123 'prefix)))))
12124 ;; Use fast selection
12125 (org-fast-todo-selection))
12126 ((and (equal arg '(4))
12127 (or (not org-use-fast-todo-selection)
12128 (not org-todo-key-trigger)))
12129 ;; Read a state with completion
12130 (org-icompleting-read
12131 "State: " (mapcar 'list org-todo-keywords-1)
12132 nil t))
12133 ((eq arg 'right)
12134 (if this
12135 (if tail (car tail) nil)
12136 (car org-todo-keywords-1)))
12137 ((eq arg 'left)
12138 (if (equal member org-todo-keywords-1)
12139 nil
12140 (if this
12141 (nth (- (length org-todo-keywords-1)
12142 (length tail) 2)
12143 org-todo-keywords-1)
12144 (org-last org-todo-keywords-1))))
12145 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12146 (setq arg nil))) ; hack to fall back to cycling
12147 (arg
12148 ;; user or caller requests a specific state
12149 (cond
12150 ((equal arg "") nil)
12151 ((eq arg 'none) nil)
12152 ((eq arg 'done) (or done-word (car org-done-keywords)))
12153 ((eq arg 'nextset)
12154 (or (car (cdr (member head org-todo-heads)))
12155 (car org-todo-heads)))
12156 ((eq arg 'previousset)
12157 (let ((org-todo-heads (reverse org-todo-heads)))
12158 (or (car (cdr (member head org-todo-heads)))
12159 (car org-todo-heads))))
12160 ((car (member arg org-todo-keywords-1)))
12161 ((stringp arg)
12162 (error "State `%s' not valid in this file" arg))
12163 ((nth (1- (prefix-numeric-value arg))
12164 org-todo-keywords-1))))
12165 ((null member) (or head (car org-todo-keywords-1)))
12166 ((equal this final-done-word) nil) ;; -> make empty
12167 ((null tail) nil) ;; -> first entry
12168 ((memq interpret '(type priority))
12169 (if (eq this-command last-command)
12170 (car tail)
12171 (if (> (length tail) 0)
12172 (or done-word (car org-done-keywords))
12173 nil)))
12174 (t
12175 (car tail))))
12176 (org-state (or
12177 (run-hook-with-args-until-success
12178 'org-todo-get-default-hook org-state org-last-state)
12179 org-state))
12180 (next (if org-state (concat " " org-state " ") " "))
12181 (change-plist (list :type 'todo-state-change :from this :to org-state
12182 :position startpos))
12183 dolog now-done-p)
12184 (when org-blocker-hook
12185 (setq org-last-todo-state-is-todo
12186 (not (member this org-done-keywords)))
12187 (unless (save-excursion
12188 (save-match-data
12189 (org-with-wide-buffer
12190 (run-hook-with-args-until-failure
12191 'org-blocker-hook change-plist))))
12192 (if (org-called-interactively-p 'interactive)
12194 this org-state org-block-entry-blocking)
12195 ;; fail silently
12197 this org-state org-block-entry-blocking)
12198 (throw 'exit nil))))
12199 (store-match-data match-data)
12200 (replace-match next t t)
12201 (unless (pos-visible-in-window-p hl-pos)
12202 (message "TODO state changed to %s" (org-trim next)))
12203 (unless head
12204 (setq head (org-get-todo-sequence-head org-state)
12205 ass (assoc head org-todo-kwd-alist)
12206 interpret (nth 1 ass)
12207 done-word (nth 3 ass)
12208 final-done-word (nth 4 ass)))
12209 (when (memq arg '(nextset previousset))
12210 (message "Keyword-Set %d/%d: %s"
12211 (- (length org-todo-sets) -1
12212 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12213 (length org-todo-sets)
12214 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12215 (setq org-last-todo-state-is-todo
12216 (not (member org-state org-done-keywords)))
12217 (setq now-done-p (and (member org-state org-done-keywords)
12218 (not (member this org-done-keywords))))
12219 (and logging (org-local-logging logging))
12220 (when (and (or org-todo-log-states org-log-done)
12221 (not (eq org-inhibit-logging t))
12222 (not (memq arg '(nextset previousset))))
12223 ;; we need to look at recording a time and note
12224 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12225 (nth 2 (assoc this org-todo-log-states))))
12226 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12227 (setq dolog 'time))
12228 (when (or (not org-state)
12229 (and org-state
12230 (member org-state org-not-done-keywords)
12231 (not (member this org-not-done-keywords))))
12232 ;; This is now a todo state and was not one before
12233 ;; If there was a CLOSED time stamp, get rid of it.
12234 (org-add-planning-info nil nil 'closed))
12235 (when (and now-done-p org-log-done)
12236 ;; It is now done, and it was not done before
12237 (org-add-planning-info 'closed (org-current-effective-time))
12238 (if (and (not dolog) (eq 'note org-log-done))
12239 (org-add-log-setup 'done org-state this 'findpos 'note)))
12240 (when (and org-state dolog)
12241 ;; This is a non-nil state, and we need to log it
12242 (org-add-log-setup 'state org-state this 'findpos dolog)))
12243 ;; Fixup tag positioning
12244 (org-todo-trigger-tag-changes org-state)
12245 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12246 (when org-provide-todo-statistics
12247 (org-update-parent-todo-statistics))
12248 (run-hooks 'org-after-todo-state-change-hook)
12249 (if (and arg (not (member org-state org-done-keywords)))
12250 (setq head (org-get-todo-sequence-head org-state)))
12251 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12252 ;; Do we need to trigger a repeat?
12253 (when now-done-p
12254 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12255 ;; This is for the agenda, take a snapshot of the headline.
12256 (save-match-data
12257 (setq org-agenda-headline-snapshot-before-repeat
12258 (org-get-heading))))
12259 (org-auto-repeat-maybe org-state))
12260 ;; Fixup cursor location if close to the keyword
12261 (if (and (outline-on-heading-p)
12262 (not (bolp))
12263 (save-excursion (beginning-of-line 1)
12264 (looking-at org-todo-line-regexp))
12265 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12266 (progn
12267 (goto-char (or (match-end 2) (match-end 1)))
12268 (and (looking-at " ") (just-one-space))))
12269 (when org-trigger-hook
12270 (save-excursion
12271 (run-hook-with-args 'org-trigger-hook change-plist)))
12272 (when commentp (org-toggle-comment))))))))
12274 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12275 "Block turning an entry into a TODO, using the hierarchy.
12276 This checks whether the current task should be blocked from state
12277 changes. Such blocking occurs when:
12279 1. The task has children which are not all in a completed state.
12281 2. A task has a parent with the property :ORDERED:, and there
12282 are siblings prior to the current task with incomplete
12283 status.
12285 3. The parent of the task is blocked because it has siblings that should
12286 be done first, or is child of a block grandparent TODO entry."
12288 (if (not org-enforce-todo-dependencies)
12289 t ; if locally turned off don't block
12290 (catch 'dont-block
12291 ;; If this is not a todo state change, or if this entry is already DONE,
12292 ;; do not block
12293 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12294 (member (plist-get change-plist :from)
12295 (cons 'done org-done-keywords))
12296 (member (plist-get change-plist :to)
12297 (cons 'todo org-not-done-keywords))
12298 (not (plist-get change-plist :to)))
12299 (throw 'dont-block t))
12300 ;; If this task has children, and any are undone, it's blocked
12301 (save-excursion
12302 (org-back-to-heading t)
12303 (let ((this-level (funcall outline-level)))
12304 (outline-next-heading)
12305 (let ((child-level (funcall outline-level)))
12306 (while (and (not (eobp))
12307 (> child-level this-level))
12308 ;; this todo has children, check whether they are all
12309 ;; completed
12310 (if (and (not (org-entry-is-done-p))
12311 (org-entry-is-todo-p))
12312 (progn (setq org-block-entry-blocking (org-get-heading))
12313 (throw 'dont-block nil)))
12314 (outline-next-heading)
12315 (setq child-level (funcall outline-level))))))
12316 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12317 ;; any previous siblings are undone, it's blocked
12318 (save-excursion
12319 (org-back-to-heading t)
12320 (let* ((pos (point))
12321 (parent-pos (and (org-up-heading-safe) (point))))
12322 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12323 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12324 (forward-line 1)
12325 (re-search-forward org-not-done-heading-regexp pos t))
12326 (setq org-block-entry-blocking (match-string 0))
12327 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12328 ;; Search further up the hierarchy, to see if an ancestor is blocked
12329 (while t
12330 (goto-char parent-pos)
12331 (if (not (looking-at org-not-done-heading-regexp))
12332 (throw 'dont-block t)) ; do not block, parent is not a TODO
12333 (setq pos (point))
12334 (setq parent-pos (and (org-up-heading-safe) (point)))
12335 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12336 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12337 (forward-line 1)
12338 (re-search-forward org-not-done-heading-regexp pos t)
12339 (setq org-block-entry-blocking (org-get-heading)))
12340 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12342 (defcustom org-track-ordered-property-with-tag nil
12343 "Should the ORDERED property also be shown as a tag?
12344 The ORDERED property decides if an entry should require subtasks to be
12345 completed in sequence. Since a property is not very visible, setting
12346 this option means that toggling the ORDERED property with the command
12347 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12348 not relevant for the behavior, but it makes things more visible.
12350 Note that toggling the tag with tags commands will not change the property
12351 and therefore not influence behavior!
12353 This can be t, meaning the tag ORDERED should be used, It can also be a
12354 string to select a different tag for this task."
12355 :group 'org-todo
12356 :type '(choice
12357 (const :tag "No tracking" nil)
12358 (const :tag "Track with ORDERED tag" t)
12359 (string :tag "Use other tag")))
12361 (defun org-toggle-ordered-property ()
12362 "Toggle the ORDERED property of the current entry.
12363 For better visibility, you can track the value of this property with a tag.
12364 See variable `org-track-ordered-property-with-tag'."
12365 (interactive)
12366 (let* ((t1 org-track-ordered-property-with-tag)
12367 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12368 (save-excursion
12369 (org-back-to-heading)
12370 (if (org-entry-get nil "ORDERED")
12371 (progn
12372 (org-delete-property "ORDERED" "PROPERTIES")
12373 (and tag (org-toggle-tag tag 'off))
12374 (message "Subtasks can be completed in arbitrary order"))
12375 (org-entry-put nil "ORDERED" "t")
12376 (and tag (org-toggle-tag tag 'on))
12377 (message "Subtasks must be completed in sequence")))))
12379 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12380 (defun org-block-todo-from-checkboxes (change-plist)
12381 "Block turning an entry into a TODO, using checkboxes.
12382 This checks whether the current task should be blocked from state
12383 changes because there are unchecked boxes in this entry."
12384 (if (not org-enforce-todo-checkbox-dependencies)
12385 t ; if locally turned off don't block
12386 (catch 'dont-block
12387 ;; If this is not a todo state change, or if this entry is already DONE,
12388 ;; do not block
12389 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12390 (member (plist-get change-plist :from)
12391 (cons 'done org-done-keywords))
12392 (member (plist-get change-plist :to)
12393 (cons 'todo org-not-done-keywords))
12394 (not (plist-get change-plist :to)))
12395 (throw 'dont-block t))
12396 ;; If this task has checkboxes that are not checked, it's blocked
12397 (save-excursion
12398 (org-back-to-heading t)
12399 (let ((beg (point)) end)
12400 (outline-next-heading)
12401 (setq end (point))
12402 (goto-char beg)
12403 (if (org-list-search-forward
12404 (concat (org-item-beginning-re)
12407 end t)
12408 (progn
12409 (if (boundp 'org-blocked-by-checkboxes)
12410 (setq org-blocked-by-checkboxes t))
12411 (throw 'dont-block nil)))))
12412 t))) ; do not block
12414 (defun org-entry-blocked-p ()
12415 "Is the current entry blocked?"
12416 (org-with-silent-modifications
12417 (if (org-entry-get nil "NOBLOCKING")
12418 nil ;; Never block this entry
12419 (not (run-hook-with-args-until-failure
12420 'org-blocker-hook
12421 (list :type 'todo-state-change
12422 :position (point)
12423 :from 'todo
12424 :to 'done))))))
12426 (defun org-update-statistics-cookies (all)
12427 "Update the statistics cookie, either from TODO or from checkboxes.
12428 This should be called with the cursor in a line with a statistics cookie."
12429 (interactive "P")
12430 (if all
12431 (progn
12432 (org-update-checkbox-count 'all)
12433 (org-map-entries 'org-update-parent-todo-statistics))
12434 (if (not (org-at-heading-p))
12435 (org-update-checkbox-count)
12436 (let ((pos (point-marker))
12437 end l1 l2)
12438 (ignore-errors (org-back-to-heading t))
12439 (if (not (org-at-heading-p))
12440 (org-update-checkbox-count)
12441 (setq l1 (org-outline-level))
12442 (setq end (save-excursion
12443 (outline-next-heading)
12444 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12445 (point)))
12446 (if (and (save-excursion
12447 (re-search-forward
12449 (not (save-excursion (re-search-forward
12451 (org-update-checkbox-count)
12452 (if (and l2 (> l2 l1))
12453 (progn
12454 (goto-char end)
12455 (org-update-parent-todo-statistics))
12456 (goto-char pos)
12457 (beginning-of-line 1)
12458 (while (re-search-forward
12460 (point-at-eol) t)
12461 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12462 (goto-char pos)
12463 (move-marker pos nil)))))
12465 (defvar org-entry-property-inherited-from) ;; defined below
12466 (defun org-update-parent-todo-statistics ()
12467 "Update any statistics cookie in the parent of the current headline.
12468 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12469 the entire subtree and this will travel up the hierarchy and update
12470 statistics everywhere."
12471 (let* ((prop (save-excursion (org-up-heading-safe)
12472 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12473 (recursive (or (not org-hierarchical-todo-statistics)
12475 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12476 0))
12477 (first t)
12479 level ltoggle l1 new ndel
12480 (cnt-all 0) (cnt-done 0) is-percent kwd
12481 checkbox-beg ov ovs ove cookie-present)
12482 (catch 'exit
12483 (save-excursion
12484 (beginning-of-line 1)
12485 (setq ltoggle (funcall outline-level))
12486 ;; Three situations are to consider:
12488 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12489 ;; to the top-level ancestor on the headline;
12491 ;; 2. If parent has "recursive" property, repeat up to the
12492 ;; headline setting that property, taking inheritance into
12493 ;; account;
12495 ;; 3. Else, move up to direct parent and proceed only once.
12496 (while (and (setq level (org-up-heading-safe))
12497 (or recursive first)
12498 (>= (point) lim))
12499 (setq first nil cookie-present nil)
12500 (unless (and level
12501 (not (string-match
12503 (downcase (or (org-entry-get nil "COOKIE_DATA")
12504 "")))))
12505 (throw 'exit nil))
12506 (while (re-search-forward box-re (point-at-eol) t)
12507 (setq cnt-all 0 cnt-done 0 cookie-present t)
12508 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12509 (save-match-data
12510 (unless (outline-next-heading) (throw 'exit nil))
12511 (while (and (looking-at org-complex-heading-regexp)
12512 (> (setq l1 (length (match-string 1))) level))
12513 (setq kwd (and (or recursive (= l1 ltoggle))
12514 (match-string 2)))
12515 (if (or (eq org-provide-todo-statistics 'all-headlines)
12516 (and (listp org-provide-todo-statistics)
12517 (or (member kwd org-provide-todo-statistics)
12518 (member kwd org-done-keywords))))
12519 (setq cnt-all (1+ cnt-all))
12520 (if (eq org-provide-todo-statistics t)
12521 (and kwd (setq cnt-all (1+ cnt-all)))))
12522 (and (member kwd org-done-keywords)
12523 (setq cnt-done (1+ cnt-done)))
12524 (outline-next-heading)))
12525 (setq new
12526 (if is-percent
12527 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12528 (format "[%d/%d]" cnt-done cnt-all))
12529 ndel (- (match-end 0) checkbox-beg))
12530 ;; handle overlays when updating cookie from column view
12531 (when (setq ov (car (overlays-at checkbox-beg)))
12532 (setq ovs (overlay-start ov) ove (overlay-end ov))
12533 (delete-overlay ov))
12534 (goto-char checkbox-beg)
12535 (insert new)
12536 (delete-region (point) (+ (point) ndel))
12537 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12538 (when ov (move-overlay ov ovs ove)))
12539 (when cookie-present
12540 (run-hook-with-args 'org-after-todo-statistics-hook
12541 cnt-done (- cnt-all cnt-done))))))
12542 (run-hooks 'org-todo-statistics-hook)))
12544 (defvar org-after-todo-statistics-hook nil
12545 "Hook that is called after a TODO statistics cookie has been updated.
12546 Each function is called with two arguments: the number of not-done entries
12547 and the number of done entries.
12549 For example, the following function, when added to this hook, will switch
12550 an entry to DONE when all children are done, and back to TODO when new
12551 entries are set to a TODO status. Note that this hook is only called
12552 when there is a statistics cookie in the headline!
12554 (defun org-summary-todo (n-done n-not-done)
12556 (let (org-log-done org-log-states) ; turn off logging
12558 ")
12560 (defvar org-todo-statistics-hook nil
12561 "Hook that is run whenever Org thinks TODO statistics should be updated.
12562 This hook runs even if there is no statistics cookie present, in which case
12563 `org-after-todo-statistics-hook' would not run.")
12565 (defun org-todo-trigger-tag-changes (state)
12566 "Apply the changes defined in `org-todo-state-tags-triggers'."
12567 (let ((l org-todo-state-tags-triggers)
12568 changes)
12569 (when (or (not state) (equal state ""))
12570 (setq changes (append changes (cdr (assoc "" l)))))
12571 (when (and (stringp state) (> (length state) 0))
12572 (setq changes (append changes (cdr (assoc state l)))))
12573 (when (member state org-not-done-keywords)
12574 (setq changes (append changes (cdr (assoc 'todo l)))))
12575 (when (member state org-done-keywords)
12576 (setq changes (append changes (cdr (assoc 'done l)))))
12577 (dolist (c changes)
12578 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12580 (defun org-local-logging (value)
12581 "Get logging settings from a property VALUE."
12582 (let* (words w a)
12583 ;; directly set the variables, they are already local.
12584 (setq org-log-done nil
12585 org-log-repeat nil
12586 org-todo-log-states nil)
12587 (setq words (org-split-string value))
12588 (while (setq w (pop words))
12589 (cond
12590 ((setq a (assoc w org-startup-options))
12591 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12592 (set (nth 1 a) (nth 2 a))))
12593 ((setq a (org-extract-log-state-settings w))
12594 (and (member (car a) org-todo-keywords-1)
12595 (push a org-todo-log-states)))))))
12597 (defun org-get-todo-sequence-head (kwd)
12598 "Return the head of the TODO sequence to which KWD belongs.
12599 If KWD is not set, check if there is a text property remembering the
12600 right sequence."
12601 (let (p)
12602 (cond
12603 ((not kwd)
12604 (or (get-text-property (point-at-bol) 'org-todo-head)
12605 (progn
12606 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12607 nil (point-at-eol)))
12608 (get-text-property p 'org-todo-head))))
12609 ((not (member kwd org-todo-keywords-1))
12610 (car org-todo-keywords-1))
12611 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12613 (defun org-fast-todo-selection ()
12614 "Fast TODO keyword selection with single keys.
12615 Returns the new TODO keyword, or nil if no state change should occur."
12616 (let* ((fulltable org-todo-key-alist)
12617 (done-keywords org-done-keywords) ;; needed for the faces.
12618 (maxlen (apply 'max (mapcar
12619 (lambda (x)
12620 (if (stringp (car x)) (string-width (car x)) 0))
12621 fulltable)))
12622 (expert nil)
12623 (fwidth (+ maxlen 3 1 3))
12624 (ncol (/ (- (window-width) 4) fwidth))
12625 tg cnt e c tbl
12626 groups ingroup)
12627 (save-excursion
12628 (save-window-excursion
12629 (if expert
12630 (set-buffer (get-buffer-create " *Org todo*"))
12631 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12632 (erase-buffer)
12633 (org-set-local 'org-done-keywords done-keywords)
12634 (setq tbl fulltable cnt 0)
12635 (while (setq e (pop tbl))
12636 (cond
12637 ((equal e '(:startgroup))
12638 (push '() groups) (setq ingroup t)
12639 (when (not (= cnt 0))
12640 (setq cnt 0)
12642 (insert "{ "))
12643 ((equal e '(:endgroup))
12644 (setq ingroup nil cnt 0)
12646 ((equal e '(:newline))
12647 (when (not (= cnt 0))
12648 (setq cnt 0)
12650 (setq e (car tbl))
12651 (while (equal (car tbl) '(:newline))
12653 (setq tbl (cdr tbl)))))
12654 (t
12655 (setq tg (car e) c (cdr e))
12656 (if ingroup (push tg (car groups)))
12657 (setq tg (org-add-props tg nil 'face
12658 (org-get-todo-face tg)))
12659 (if (and (= cnt 0) (not ingroup)) (insert " "))
12660 (insert "[" c "] " tg (make-string
12661 (- fwidth 4 (length tg)) ?\ ))
12662 (when (= (setq cnt (1+ cnt)) ncol)
12664 (if ingroup (insert " "))
12665 (setq cnt 0)))))
12667 (goto-char (point-min))
12668 (if (not expert) (org-fit-window-to-buffer))
12669 (message "[a-z..]:Set [SPC]:clear")
12670 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12671 (cond
12672 ((or (= c ?\C-g)
12673 (and (= c ?q) (not (rassoc c fulltable))))
12674 (setq quit-flag t))
12675 ((= c ?\ ) nil)
12676 ((setq e (rassoc c fulltable) tg (car e))
12677 tg)
12678 (t (setq quit-flag t)))))))
12680 (defun org-entry-is-todo-p ()
12681 (member (org-get-todo-state) org-not-done-keywords))
12683 (defun org-entry-is-done-p ()
12684 (member (org-get-todo-state) org-done-keywords))
12686 (defun org-get-todo-state ()
12687 "Return the TODO keyword of the current subtree."
12688 (save-excursion
12689 (org-back-to-heading t)
12690 (and (looking-at org-todo-line-regexp)
12691 (match-end 2)
12692 (match-string 2))))
12694 (defun org-at-date-range-p (&optional inactive-ok)
12695 "Is the cursor inside a date range?"
12696 (interactive)
12697 (save-excursion
12698 (catch 'exit
12699 (let ((pos (point)))
12701 (skip-chars-backward "<[")
12702 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12703 (>= (match-end 0) pos)
12704 (throw 'exit t))
12706 (skip-chars-backward "<[")
12707 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12708 (>= (match-end 0) pos)
12709 (throw 'exit t)))
12710 nil)))
12712 (defun org-get-repeat (&optional tagline)
12713 "Check if there is a deadline/schedule with repeater in this entry."
12714 (save-match-data
12715 (save-excursion
12716 (org-back-to-heading t)
12717 (and (re-search-forward (if tagline
12719 org-repeat-re)
12720 (org-entry-end-position) t)
12721 (match-string-no-properties 1)))))
12723 (defvar org-last-changed-timestamp)
12724 (defvar org-last-inserted-timestamp)
12725 (defvar org-log-post-message)
12726 (defvar org-log-note-purpose)
12727 (defvar org-log-note-how)
12728 (defvar org-log-note-extra)
12729 (defun org-auto-repeat-maybe (done-word)
12730 "Check if the current headline contains a repeated deadline/schedule.
12731 If yes, set TODO state back to what it was and change the base date
12732 of repeating deadline/scheduled time stamps to new date.
12733 This function is run automatically after each state change to a DONE state."
12734 ;; last-state is dynamically scoped into this function
12735 (let* ((repeat (org-get-repeat))
12736 (aa (assoc org-last-state org-todo-kwd-alist))
12737 (interpret (nth 1 aa))
12738 (head (nth 2 aa))
12739 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12740 (msg "Entry repeats: ")
12741 (org-log-done nil)
12742 (org-todo-log-states nil)
12743 re type n what ts time to-state)
12744 (when repeat
12745 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12746 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12747 org-todo-repeat-to-state))
12748 (unless (and to-state (member to-state org-todo-keywords-1))
12749 (setq to-state (if (eq interpret 'type) org-last-state head)))
12750 (org-todo to-state)
12751 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12752 (org-entry-put nil "LAST_REPEAT" (format-time-string
12753 (org-time-stamp-format t t))))
12754 (when org-log-repeat
12755 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12756 (memq 'org-add-log-note post-command-hook))
12757 ;; OK, we are already setup for some record
12758 (if (eq org-log-repeat 'note)
12759 ;; make sure we take a note, not only a time stamp
12760 (setq org-log-note-how 'note))
12761 ;; Set up for taking a record
12762 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12763 org-last-state
12764 'findpos org-log-repeat)))
12765 (org-back-to-heading t)
12766 (org-add-planning-info nil nil 'closed)
12770 (while (re-search-forward
12771 re (save-excursion (outline-next-heading) (point)) t)
12772 (setq type (if (match-end 1) org-scheduled-string
12773 (if (match-end 3) org-deadline-string "Plain:"))
12774 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12776 (setq n (string-to-number (match-string 2 ts))
12777 what (match-string 3 ts))
12778 (if (equal what "w") (setq n (* n 7) what "d"))
12780 (error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12781 ;; Preparation, see if we need to modify the start date for the change
12782 (when (match-end 1)
12783 (setq time (save-match-data (org-time-string-to-time ts)))
12784 (cond
12785 ((equal (match-string 1 ts) ".")
12786 ;; Shift starting date to today
12787 (org-timestamp-change
12788 (- (org-today) (time-to-days time))
12789 'day))
12790 ((equal (match-string 1 ts) "+")
12791 (let ((nshiftmax 10) (nshift 0))
12792 (while (or (= nshift 0)
12793 (<= (time-to-days time)
12794 (time-to-days (current-time))))
12795 (when (= (incf nshift) nshiftmax)
12796 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12797 (error "Abort")))
12798 (org-timestamp-change n (cdr (assoc what whata)))
12799 (org-at-timestamp-p t)
12800 (setq ts (match-string 1))
12801 (setq time (save-match-data (org-time-string-to-time ts)))))
12802 (org-timestamp-change (- n) (cdr (assoc what whata)))
12803 ;; rematch, so that we have everything in place for the real shift
12804 (org-at-timestamp-p t)
12805 (setq ts (match-string 1))
12807 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
12808 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12809 (setq org-log-post-message msg)
12810 (message "%s" msg))))
12812 (defun org-show-todo-tree (arg)
12813 "Make a compact tree which shows all headlines marked with TODO.
12814 The tree will show the lines where the regexp matches, and all higher
12815 headlines above the match.
12817 With a numeric prefix N, construct a sparse tree for the Nth element
12818 of `org-todo-keywords-1'."
12819 (interactive "P")
12820 (let ((case-fold-search nil)
12821 (kwd-re
12822 (cond ((null arg) org-not-done-regexp)
12823 ((equal arg '(4))
12824 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
12825 (mapcar 'list org-todo-keywords-1))))
12829 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
12830 (regexp-quote (nth (1- (prefix-numeric-value arg))
12831 org-todo-keywords-1)))
12832 (t (error "Invalid prefix argument: %s" arg)))))
12833 (message "%d TODO entries found"
12834 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
12836 (defun org-deadline (arg &optional time)
12838 With one universal prefix argument, remove any deadline from the item.
12839 With two universal prefix arguments, prompt for a warning delay.
12840 With argument TIME, set the deadline at the corresponding date. TIME
12842 (interactive "P")
12843 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12844 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12845 'region-start-level 'region))
12846 org-loop-over-headlines-in-active-region)
12847 (org-map-entries
12848 `(org-deadline ',arg ,time)
12849 org-loop-over-headlines-in-active-region
12850 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12851 (let* ((old-date (org-entry-get nil "DEADLINE"))
12852 (old-date-time (if old-date (org-time-string-to-time old-date)))
12853 (repeater (and old-date
12854 (string-match
12856 old-date)
12857 (match-string 1 old-date))))
12858 (cond
12859 ((equal arg '(4))
12860 (when (and old-date org-log-redeadline)
12861 (org-add-log-setup 'deldeadline nil old-date 'findpos
12862 org-log-redeadline))
12863 (org-remove-timestamp-with-keyword org-deadline-string)
12864 (message "Item no longer has a deadline."))
12865 ((equal arg '(16))
12866 (save-excursion
12867 (if (re-search-forward
12868 org-deadline-time-regexp
12869 (save-excursion (outline-next-heading) (point)) t)
12870 (let* ((rpl0 (match-string 1))
12871 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12872 (replace-match
12873 (concat org-deadline-string
12874 " <" rpl
12875 (format " -%dd"
12876 (abs
12877 (- (time-to-days
12878 (save-match-data
12879 (org-read-date nil t nil "Warn starting from" old-date-time)))
12880 (time-to-days old-date-time))))
12881 ">") t t))
12882 (user-error "No deadline information to update"))))
12883 (t
12884 (org-add-planning-info 'deadline time 'closed)
12885 (when (and old-date org-log-redeadline
12886 (not (equal old-date
12887 (substring org-last-inserted-timestamp 1 -1))))
12888 (org-add-log-setup 'redeadline nil old-date 'findpos
12889 org-log-redeadline))
12890 (when repeater
12891 (save-excursion
12892 (org-back-to-heading t)
12893 (when (re-search-forward (concat org-deadline-string " "
12894 org-last-inserted-timestamp)
12895 (save-excursion
12896 (outline-next-heading) (point)) t)
12897 (goto-char (1- (match-end 0)))
12898 (insert " " repeater)
12899 (setq org-last-inserted-timestamp
12900 (concat (substring org-last-inserted-timestamp 0 -1)
12901 " " repeater
12902 (substring org-last-inserted-timestamp -1))))))
12903 (message "Deadline on %s" org-last-inserted-timestamp))))))
12905 (defun org-schedule (arg &optional time)
12906 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
12907 With one universal prefix argument, remove any scheduling date from the item.
12908 With two universal prefix arguments, prompt for a delay cookie.
12909 With argument TIME, scheduled at the corresponding date. TIME can
12911 (interactive "P")
12912 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12913 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12914 'region-start-level 'region))
12915 org-loop-over-headlines-in-active-region)
12916 (org-map-entries
12917 `(org-schedule ',arg ,time)
12918 org-loop-over-headlines-in-active-region
12919 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12920 (let* ((old-date (org-entry-get nil "SCHEDULED"))
12921 (old-date-time (if old-date (org-time-string-to-time old-date)))
12922 (repeater (and old-date
12923 (string-match
12925 old-date)
12926 (match-string 1 old-date))))
12927 (cond
12928 ((equal arg '(4))
12929 (progn
12930 (when (and old-date org-log-reschedule)
12931 (org-add-log-setup 'delschedule nil old-date 'findpos
12932 org-log-reschedule))
12933 (org-remove-timestamp-with-keyword org-scheduled-string)
12934 (message "Item is no longer scheduled.")))
12935 ((equal arg '(16))
12936 (save-excursion
12937 (if (re-search-forward
12938 org-scheduled-time-regexp
12939 (save-excursion (outline-next-heading) (point)) t)
12940 (let* ((rpl0 (match-string 1))
12941 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
12942 (replace-match
12943 (concat org-scheduled-string
12944 " <" rpl
12945 (format " -%dd"
12946 (abs
12947 (- (time-to-days
12948 (save-match-data
12949 (org-read-date nil t nil "Delay until" old-date-time)))
12950 (time-to-days old-date-time))))
12951 ">") t t))
12952 (user-error "No scheduled information to update"))))
12953 (t
12954 (org-add-planning-info 'scheduled time 'closed)
12955 (when (and old-date org-log-reschedule
12956 (not (equal old-date
12957 (substring org-last-inserted-timestamp 1 -1))))
12958 (org-add-log-setup 'reschedule nil old-date 'findpos
12959 org-log-reschedule))
12960 (when repeater
12961 (save-excursion
12962 (org-back-to-heading t)
12963 (when (re-search-forward (concat org-scheduled-string " "
12964 org-last-inserted-timestamp)
12965 (save-excursion
12966 (outline-next-heading) (point)) t)
12967 (goto-char (1- (match-end 0)))
12968 (insert " " repeater)
12969 (setq org-last-inserted-timestamp
12970 (concat (substring org-last-inserted-timestamp 0 -1)
12971 " " repeater
12972 (substring org-last-inserted-timestamp -1))))))
12973 (message "Scheduled to %s" org-last-inserted-timestamp))))))
12975 (defun org-get-scheduled-time (pom &optional inherit)
12976 "Get the scheduled time as a time tuple, of a format suitable
12977 for calling org-schedule with, or if there is no scheduling,
12978 returns nil."
12979 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
12980 (when time
12981 (apply 'encode-time (org-parse-time-string time)))))
12983 (defun org-get-deadline-time (pom &optional inherit)
12984 "Get the deadline as a time tuple, of a format suitable for
12985 calling org-deadline with, or if there is no scheduling, returns
12986 nil."
12987 (let ((time (org-entry-get pom "DEADLINE" inherit)))
12988 (when time
12989 (apply 'encode-time (org-parse-time-string time)))))
12991 (defun org-remove-timestamp-with-keyword (keyword)
12992 "Remove all time stamps with KEYWORD in the current entry."
12994 beg)
12995 (save-excursion
12996 (org-back-to-heading t)
12997 (setq beg (point))
12998 (outline-next-heading)
12999 (while (re-search-backward re beg t)
13000 (replace-match "")
13002 (equal (char-before) ?\ ))
13003 (backward-delete-char 1)
13005 (point-at-bol) (point-at-eol)))
13006 (delete-region (point-at-bol)
13007 (min (point-max) (1+ (point-at-eol))))))))))
13009 (defun org-add-planning-info (what &optional time &rest remove)
13010 "Insert new timestamp with keyword in the line directly after the headline.
13011 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
13012 If non is given, the user is prompted for a date.
13013 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
13014 be removed."
13015 (interactive)
13016 (let (org-time-was-given org-end-time-was-given ts
13017 end default-time default-input)
13019 (catch 'exit
13020 (when (and (memq what '(scheduled deadline))
13021 (or (not time)
13022 (and (stringp time)
13023 (string-match "^[-+]+[0-9]" time))))
13024 ;; Try to get a default date/time from existing timestamp
13025 (save-excursion
13026 (org-back-to-heading t)
13027 (setq end (save-excursion (outline-next-heading) (point)))
13028 (when (re-search-forward (if (eq what 'scheduled)
13029 org-scheduled-time-regexp
13030 org-deadline-time-regexp)
13031 end t)
13032 (setq ts (match-string 1)
13033 default-time
13034 (apply 'encode-time (org-parse-time-string ts))
13035 default-input (and ts (org-get-compact-tod ts))))))
13036 (when what
13037 (setq time
13038 (if (stringp time)
13039 ;; This is a string (relative or absolute), set proper date
13040 (apply 'encode-time
13041 (org-read-date-analyze
13042 time default-time (decode-time default-time)))
13043 ;; If necessary, get the time from the user
13044 (or time (org-read-date nil 'to-time nil nil
13045 default-time default-input)))))
13047 (when (and org-insert-labeled-timestamps-at-point
13048 (member what '(scheduled deadline)))
13049 (insert
13050 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
13051 (org-insert-time-stamp time org-time-was-given
13052 nil nil nil (list org-end-time-was-given))
13053 (setq what nil))
13054 (save-excursion
13055 (save-restriction
13056 (let (col list elt ts buffer-invisibility-spec)
13057 (org-back-to-heading t)
13059 (goto-char (match-end 1))
13060 (setq col (current-column))
13061 (goto-char (match-end 0))
13063 (when (and (not what)
13064 (not (looking-at
13066 org-keyword-time-not-clock-regexp))))
13067 ;; Nothing to add, nothing to remove...... :-)
13068 (throw 'exit nil))
13069 (if (and (not (looking-at org-outline-regexp))
13072 (not (equal (match-string 1) org-clock-string)))
13073 (narrow-to-region (match-beginning 0) (match-end 0))
13075 (backward-char 1)
13076 (narrow-to-region (point) (point))
13077 (and org-adapt-indentation (org-indent-to-column col)))
13078 ;; Check if we have to remove something.
13079 (setq list (cons what remove))
13080 (while list
13081 (setq elt (pop list))
13082 (when (or (and (eq elt 'scheduled)
13083 (re-search-forward org-scheduled-time-regexp nil t))
13084 (and (eq elt 'deadline)
13085 (re-search-forward org-deadline-time-regexp nil t))
13086 (and (eq elt 'closed)
13087 (re-search-forward org-closed-time-regexp nil t)))
13088 (replace-match "")
13089 (if (looking-at "--+<[^>]+>") (replace-match ""))))
13091 (and org-adapt-indentation (bolp) (org-indent-to-column col))
13092 (when what
13093 (insert
13094 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
13095 (cond ((eq what 'scheduled) org-scheduled-string)
13096 ((eq what 'deadline) org-deadline-string)
13097 ((eq what 'closed) org-closed-string))
13098 " ")
13099 (setq ts (org-insert-time-stamp
13100 time
13101 (or org-time-was-given
13102 (and (eq what 'closed) org-log-done-with-time))
13103 (eq what 'closed)
13104 nil nil (list org-end-time-was-given)))
13105 (insert
13106 (if (not (or (bolp) (eq (char-before) ?\ )
13107 (memq (char-after) '(32 10))
13108 (eobp))) " " ""))
13109 (end-of-line 1))
13110 (goto-char (point-min))
13111 (widen)
13114 (delete-region (1- (point)) (point-at-eol)))
13115 ts))))))
13117 (defvar org-log-note-marker (make-marker))
13118 (defvar org-log-note-purpose nil)
13119 (defvar org-log-note-state nil)
13120 (defvar org-log-note-previous-state nil)
13121 (defvar org-log-note-how nil)
13122 (defvar org-log-note-extra nil)
13123 (defvar org-log-note-window-configuration nil)
13124 (defvar org-log-note-return-to (make-marker))
13125 (defvar org-log-note-effective-time nil
13126 "Remembered current time so that dynamically scoped
13127 `org-extend-today-until' affects tha timestamps in state change
13128 log")
13130 (defvar org-log-post-message nil
13131 "Message to be displayed after a log note has been stored.
13132 The auto-repeater uses this.")
13134 (defun org-add-note ()
13135 "Add a note to the current entry.
13136 This is done in the same way as adding a state change note."
13137 (interactive)
13138 (org-add-log-setup 'note nil nil 'findpos nil))
13140 (defvar org-property-end-re)
13141 (defun org-add-log-setup (&optional purpose state prev-state
13142 findpos how extra)
13143 "Set up the post command hook to take a note.
13144 If this is about to TODO state change, the new state is expected in STATE.
13145 When FINDPOS is non-nil, find the correct position for the note in
13146 the current entry. If not, assume that it can be inserted at point.
13147 HOW is an indicator what kind of note should be created.
13148 EXTRA is additional text that will be inserted into the notes buffer."
13149 (let* ((org-log-into-drawer (org-log-into-drawer))
13150 (drawer (cond ((stringp org-log-into-drawer)
13151 org-log-into-drawer)
13152 (org-log-into-drawer "LOGBOOK"))))
13153 (save-restriction
13154 (save-excursion
13155 (when findpos
13156 (org-back-to-heading t)
13157 (narrow-to-region (point) (save-excursion
13158 (outline-next-heading) (point)))
13162 (goto-char (match-end 0))
13163 (cond
13164 (drawer
13166 nil t)
13167 (progn
13168 (goto-char (match-end 0))
13169 (or org-log-states-order-reversed
13170 (and (re-search-forward org-property-end-re nil t)
13171 (goto-char (1- (match-beginning 0))))))
13173 (beginning-of-line 0)
13174 (org-indent-line)
13175 (beginning-of-line 2)
13176 (org-indent-line)
13177 (end-of-line 0)))
13178 ((and org-log-state-notes-insert-after-drawers
13179 (save-excursion
13180 (forward-line) (looking-at org-drawer-regexp)))
13181 (forward-line)
13182 (while (looking-at org-drawer-regexp)
13183 (goto-char (match-end 0))
13184 (re-search-forward org-property-end-re (point-max) t)
13185 (forward-line))
13186 (forward-line -1)))
13187 (unless org-log-states-order-reversed
13189 (org-skip-over-state-notes)
13191 (move-marker org-log-note-marker (point))
13192 (setq org-log-note-purpose purpose
13193 org-log-note-state state
13194 org-log-note-previous-state prev-state
13195 org-log-note-how how
13196 org-log-note-extra extra
13197 org-log-note-effective-time (org-current-effective-time))
13198 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
13200 (defun org-skip-over-state-notes ()
13201 "Skip past the list of State notes in an entry."
13203 (when (ignore-errors (goto-char (org-in-item-p)))
13204 (let* ((struct (org-list-struct))
13205 (prevs (org-list-prevs-alist struct)))
13207 (goto-char (or (org-list-get-next-item (point) struct prevs)
13208 (org-list-get-item-end (point) struct)))))))
13210 (defun org-add-log-note (&optional purpose)
13211 "Pop up a window for taking a note, and add this note later at point."
13212 (remove-hook 'post-command-hook 'org-add-log-note)
13213 (setq org-log-note-window-configuration (current-window-configuration))
13214 (delete-other-windows)
13215 (move-marker org-log-note-return-to (point))
13216 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13217 (goto-char org-log-note-marker)
13218 (org-switch-to-buffer-other-window "*Org Note*")
13219 (erase-buffer)
13220 (if (memq org-log-note-how '(time state))
13221 (let (current-prefix-arg) (org-store-log-note))
13222 (let ((org-inhibit-startup t)) (org-mode))
13223 (insert (format "# Insert note for %s.
13225 (cond
13226 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13227 ((eq org-log-note-purpose 'done) "closed todo item")
13228 ((eq org-log-note-purpose 'state)
13230 (or org-log-note-previous-state "")
13231 (or org-log-note-state "")))
13232 ((eq org-log-note-purpose 'reschedule)
13233 "rescheduling")
13234 ((eq org-log-note-purpose 'delschedule)
13235 "no longer scheduled")
13236 ((eq org-log-note-purpose 'redeadline)
13237 "changing deadline")
13238 ((eq org-log-note-purpose 'deldeadline)
13239 "removing deadline")
13240 ((eq org-log-note-purpose 'refile)
13241 "refiling")
13242 ((eq org-log-note-purpose 'note)
13243 "this entry")
13244 (t (error "This should not happen")))))
13245 (if org-log-note-extra (insert org-log-note-extra))
13246 (org-set-local 'org-finish-function 'org-store-log-note)
13247 (run-hooks 'org-log-buffer-setup-hook)))
13249 (defvar org-note-abort nil) ; dynamically scoped
13250 (defun org-store-log-note ()
13251 "Finish taking a log note, and insert it to where it belongs."
13252 (let ((txt (buffer-string)))
13253 (kill-buffer (current-buffer))
13254 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
13255 lines ind bul)
13257 (setq txt (replace-match "" t t txt)))
13259 (setq txt (replace-match "" t t txt)))
13262 (setq note
13263 (org-replace-escapes
13264 note
13265 (list (cons "%u" (user-login-name))
13266 (cons "%U" user-full-name)
13267 (cons "%t" (format-time-string
13268 (org-time-stamp-format 'long 'inactive)
13269 org-log-note-effective-time))
13270 (cons "%T" (format-time-string
13271 (org-time-stamp-format 'long nil)
13272 org-log-note-effective-time))
13273 (cons "%d" (format-time-string
13274 (org-time-stamp-format nil 'inactive)
13275 org-log-note-effective-time))
13276 (cons "%D" (format-time-string
13277 (org-time-stamp-format nil nil)
13278 org-log-note-effective-time))
13279 (cons "%s" (if org-log-note-state
13281 ""))
13282 (cons "%S" (if org-log-note-previous-state
13286 (push note lines))
13287 (when (or current-prefix-arg org-note-abort)
13288 (when org-log-into-drawer
13289 (org-remove-empty-drawer-at
13290 (if (stringp org-log-into-drawer) org-log-into-drawer "LOGBOOK")
13291 org-log-note-marker))
13292 (setq lines nil))
13293 (when lines
13294 (with-current-buffer (marker-buffer org-log-note-marker)
13295 (save-excursion
13296 (goto-char org-log-note-marker)
13297 (move-marker org-log-note-marker nil)
13298 (end-of-line 1)
13300 (setq ind (save-excursion
13301 (if (ignore-errors (goto-char (org-in-item-p)))
13302 (let ((struct (org-list-struct)))
13303 (org-list-get-ind
13304 (org-list-get-top-point struct) struct))
13306 (cond
13307 ((and (org-at-heading-p)
13308 org-adapt-indentation)
13309 (1+ (org-current-level)))
13310 ((org-at-heading-p) 0)
13311 (t (org-get-indentation))))))
13312 (setq bul (org-list-bullet-string "-"))
13313 (org-indent-line-to ind)
13314 (insert bul (pop lines))
13315 (let ((ind-body (+ (length bul) ind)))
13316 (while lines
13318 (org-indent-line-to ind-body)
13319 (insert (pop lines))))
13320 (message "Note stored")
13321 (org-back-to-heading t)
13322 (org-cycle-hide-drawers 'children))
13323 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13324 ;; from within `org-add-log-note' because `buffer-undo-list'
13325 ;; is then modified outside of `org-with-remote-undo'.
13326 (when (eq this-command 'org-agenda-todo)
13327 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13328 ;; Don't add undo information when called from `org-agenda-todo'
13329 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13330 (set-window-configuration org-log-note-window-configuration)
13331 (with-current-buffer (marker-buffer org-log-note-return-to)
13332 (goto-char org-log-note-return-to))
13333 (move-marker org-log-note-return-to nil)
13334 (and org-log-post-message (message "%s" org-log-post-message))))
13336 (defun org-remove-empty-drawer-at (drawer pos)
13337 "Remove an empty drawer DRAWER at position POS.
13338 POS may also be a marker."
13339 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13340 (save-excursion
13341 (save-restriction
13342 (widen)
13343 (goto-char pos)
13344 (if (org-in-regexp
13346 (replace-match ""))))))
13348 (defvar org-ts-type nil)
13349 (defun org-sparse-tree (&optional arg type)
13350 "Create a sparse tree, prompt for the details.
13351 This command can create sparse trees. You first need to select the type
13352 of match used to create the tree:
13354 t Show all TODO entries.
13355 T Show entries with a specific TODO keyword.
13356 m Show entries selected by a tags/property match.
13357 p Enter a property name and its value (both with completion on existing
13358 names/values) and show entries with that property.
13359 r Show entries matching a regular expression (`/' can be used as well).
13360 b Show deadlines and scheduled items before a date.
13361 a Show deadlines and scheduled items after a date.
13362 d Show deadlines due within `org-deadline-warning-days'.
13363 D Show deadlines and scheduled items between a date range."
13364 (interactive "P")
13365 (let (ans kwd value ts-type)
13366 (setq type (or type org-sparse-tree-default-date-type))
13367 (setq org-ts-type type)
13368 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date [D]ates range\n [c]ycle through date types: %s"
13369 (cond ((eq type 'all) "all timestamps")
13370 ((eq type 'scheduled) "only scheduled")
13371 ((eq type 'deadline) "only deadline")
13372 ((eq type 'active) "only active timestamps")
13373 ((eq type 'inactive) "only inactive timestamps")
13374 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
13375 ((eq type 'closed) "with a closed time-stamp")
13376 (t "scheduled/deadline")))
13377 (setq ans (read-char-exclusive))
13378 (cond
13379 ((equal ans ?c)
13380 (org-sparse-tree
13381 arg (cadr (member type '(scheduled-or-deadline
13382 all scheduled deadline active inactive closed)))))
13383 ((equal ans ?d)
13384 (call-interactively 'org-check-deadlines))
13385 ((equal ans ?b)
13386 (call-interactively 'org-check-before-date))
13387 ((equal ans ?a)
13388 (call-interactively 'org-check-after-date))
13389 ((equal ans ?D)
13390 (call-interactively 'org-check-dates-range))
13391 ((equal ans ?t)
13392 (call-interactively 'org-show-todo-tree))
13393 ((equal ans ?T)
13394 (org-show-todo-tree '(4)))
13395 ((member ans '(?T ?m))
13396 (call-interactively 'org-match-sparse-tree))
13397 ((member ans '(?p ?P))
13398 (setq kwd (org-icompleting-read "Property: "
13399 (mapcar 'list (org-buffer-property-keys))))
13400 (setq value (org-icompleting-read "Value: "
13401 (mapcar 'list (org-property-values kwd))))
13404 (org-match-sparse-tree arg (concat kwd "=" value)))
13405 ((member ans '(?r ?R ?/))
13406 (call-interactively 'org-occur))
13409 (defvar org-occur-highlights nil
13410 "List of overlays used for occur matches.")
13411 (make-variable-buffer-local 'org-occur-highlights)
13412 (defvar org-occur-parameters nil
13413 "Parameters of the active org-occur calls.
13414 This is a list, each call to org-occur pushes as cons cell,
13415 containing the regular expression and the callback, onto the list.
13416 The list can contain several entries if `org-occur' has been called
13417 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13418 will only contain one set of parameters. When the highlights are
13419 removed (for example with `C-c C-c', or with the next edit (depending
13420 on `org-remove-highlights-with-change'), this variable is emptied
13421 as well.")
13422 (make-variable-buffer-local 'org-occur-parameters)
13424 (defun org-occur (regexp &optional keep-previous callback)
13425 "Make a compact tree which shows all matches of REGEXP.
13426 The tree will show the lines where the regexp matches, and all higher
13427 headlines above the match. It will also show the heading after the match,
13428 to make sure editing the matching entry is easy.
13429 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13430 call to `org-occur' will be kept, to allow stacking of calls to this
13431 command.
13432 If CALLBACK is non-nil, it is a function which is called to confirm
13433 that the match should indeed be shown."
13435 (when (equal regexp "")
13436 (error "Regexp cannot be empty"))
13437 (unless keep-previous
13438 (org-remove-occur-highlights nil nil t))
13439 (push (cons regexp callback) org-occur-parameters)
13440 (let ((cnt 0))
13441 (save-excursion
13442 (goto-char (point-min))
13443 (if (or (not keep-previous) ; do not want to keep
13444 (not org-occur-highlights)) ; no previous matches
13445 ;; hide everything
13446 (org-overview))
13447 (while (re-search-forward regexp nil t)
13448 (when (or (not callback)
13449 (save-match-data (funcall callback)))
13450 (setq cnt (1+ cnt))
13451 (when org-highlight-sparse-tree-matches
13452 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13453 (org-show-context 'occur-tree))))
13454 (when org-remove-highlights-with-change
13455 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13456 nil 'local))
13457 (unless org-sparse-tree-open-archived-trees
13458 (org-hide-archived-subtrees (point-min) (point-max)))
13459 (run-hooks 'org-occur-hook)
13460 (if (org-called-interactively-p 'interactive)
13461 (message "%d match(es) for regexp %s" cnt regexp))
13462 cnt))
13464 (defun org-occur-next-match (&optional n reset)
13465 "Function for `next-error-function' to find sparse tree matches.
13466 N is the number of matches to move, when negative move backwards.
13467 RESET is entirely ignored - this function always goes back to the
13468 starting point when no match is found."
13469 (let* ((limit (if (< n 0) (point-min) (point-max)))
13470 (search-func (if (< n 0)
13471 'previous-single-char-property-change
13472 'next-single-char-property-change))
13473 (n (abs n))
13474 (pos (point))
13475 p1)
13476 (catch 'exit
13477 (while (setq p1 (funcall search-func (point) 'org-type))
13478 (when (equal p1 limit)
13479 (goto-char pos)
13480 (error "No more matches"))
13481 (when (equal (get-char-property p1 'org-type) 'org-occur)
13482 (setq n (1- n))
13483 (when (= n 0)
13484 (goto-char p1)
13485 (throw 'exit (point))))
13486 (goto-char p1))
13487 (goto-char p1)
13488 (error "No more matches"))))
13490 (defun org-show-context (&optional key)
13491 "Make sure point and context are visible.
13492 How much context is shown depends upon the variables
13493 `org-show-hierarchy-above', `org-show-following-heading',
13494 `org-show-entry-below' and `org-show-siblings'."
13495 (let ((heading-p (org-at-heading-p t))
13496 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13497 (following-p (org-get-alist-option org-show-following-heading key))
13498 (entry-p (org-get-alist-option org-show-entry-below key))
13499 (siblings-p (org-get-alist-option org-show-siblings key)))
13500 ;; Show heading or entry text
13501 (if (and heading-p (not entry-p))
13502 (org-flag-heading nil) ; only show the heading
13503 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13504 (org-show-hidden-entry))) ; show entire entry
13505 (when following-p
13506 ;; Show next sibling, or heading below text
13507 (save-excursion
13508 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13509 (org-flag-heading nil))))
13510 (when siblings-p (org-show-siblings))
13511 (when hierarchy-p
13512 ;; show all higher headings, possibly with siblings
13513 (save-excursion
13514 (while (and (condition-case nil
13515 (progn (org-up-heading-all 1) t)
13516 (error nil))
13517 (not (bobp)))
13518 (org-flag-heading nil)
13519 (when siblings-p (org-show-siblings)))))
13520 (unless (eq key 'agenda) (org-fix-ellipsis-at-bol))))
13522 (defvar org-reveal-start-hook nil
13523 "Hook run before revealing a location.")
13525 (defun org-reveal (&optional siblings)
13526 "Show current entry, hierarchy above it, and the following headline.
13527 This can be used to show a consistent set of context around locations
13528 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13529 not t for the search context.
13531 With optional argument SIBLINGS, on each level of the hierarchy all
13532 siblings are shown. This repairs the tree structure to what it would
13533 look like when opened with hierarchical calls to `org-cycle'.
13535 go to the parent and show the
13536 entire tree."
13537 (interactive "P")
13538 (run-hooks 'org-reveal-start-hook)
13539 (let ((org-show-hierarchy-above t)
13540 (org-show-following-heading t)
13541 (org-show-siblings (if siblings t org-show-siblings)))
13542 (org-show-context nil))
13543 (when (equal siblings '(16))
13544 (save-excursion
13545 (when (org-up-heading-safe)
13546 (org-show-subtree)
13547 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13549 (defun org-highlight-new-match (beg end)
13550 "Highlight from BEG to END and mark the highlight is an occur headline."
13551 (let ((ov (make-overlay beg end)))
13552 (overlay-put ov 'face 'secondary-selection)
13553 (overlay-put ov 'org-type 'org-occur)
13554 (push ov org-occur-highlights)))
13556 (defun org-remove-occur-highlights (&optional beg end noremove)
13557 "Remove the occur highlights from the buffer.
13558 BEG and END are ignored. If NOREMOVE is nil, remove this function
13559 from the `before-change-functions' in the current buffer."
13560 (interactive)
13561 (unless org-inhibit-highlight-removal
13562 (mapc 'delete-overlay org-occur-highlights)
13563 (setq org-occur-highlights nil)
13564 (setq org-occur-parameters nil)
13565 (unless noremove
13566 (remove-hook 'before-change-functions
13567 'org-remove-occur-highlights 'local))))
13569 ;;;; Priorities
13572 "Regular expression matching the priority indicator.")
13574 (defvar org-remove-priority-next-time nil)
13576 (defun org-priority-up ()
13577 "Increase the priority of the current item."
13578 (interactive)
13579 (org-priority 'up))
13581 (defun org-priority-down ()
13582 "Decrease the priority of the current item."
13583 (interactive)
13584 (org-priority 'down))
13586 (defun org-priority (&optional action show)
13587 "Change the priority of an item.
13588 ACTION can be `set', `up', `down', or a character."
13589 (interactive "P")
13590 (if (equal action '(4))
13591 (org-show-priority)
13592 (unless org-enable-priority-commands
13593 (error "Priority commands are disabled"))
13594 (setq action (or action 'set))
13595 (let (current new news have remove)
13596 (save-excursion
13597 (org-back-to-heading t)
13598 (if (looking-at org-priority-regexp)
13599 (setq current (string-to-char (match-string 2))
13600 have t))
13601 (cond
13602 ((eq action 'remove)
13603 (setq remove t new ?\ ))
13604 ((or (eq action 'set)
13605 (if (featurep 'xemacs) (characterp action) (integerp action)))
13606 (if (not (eq action 'set))
13607 (setq new action)
13608 (message "Priority %c-%c, SPC to remove: "
13609 org-highest-priority org-lowest-priority)
13610 (save-match-data
13611 (setq new (read-char-exclusive))))
13612 (if (and (= (upcase org-highest-priority) org-highest-priority)
13613 (= (upcase org-lowest-priority) org-lowest-priority))
13614 (setq new (upcase new)))
13615 (cond ((equal new ?\ ) (setq remove t))
13616 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13617 (error "Priority must be between `%c' and `%c'"
13618 org-highest-priority org-lowest-priority))))
13619 ((eq action 'up)
13620 (setq new (if have
13621 (1- current) ; normal cycling
13622 ;; last priority was empty
13623 (if (eq last-command this-command)
13624 org-lowest-priority ; wrap around empty to lowest
13625 ;; default
13626 (if org-priority-start-cycle-with-default
13627 org-default-priority
13628 (1- org-default-priority))))))
13629 ((eq action 'down)
13630 (setq new (if have
13631 (1+ current) ; normal cycling
13632 ;; last priority was empty
13633 (if (eq last-command this-command)
13634 org-highest-priority ; wrap around empty to highest
13635 ;; default
13636 (if org-priority-start-cycle-with-default
13637 org-default-priority
13638 (1+ org-default-priority))))))
13639 (t (error "Invalid action")))
13640 (if (or (< (upcase new) org-highest-priority)
13641 (> (upcase new) org-lowest-priority))
13642 (if (and (memq action '(up down))
13643 (not have) (not (eq last-command this-command)))
13644 ;; `new' is from default priority
13645 (error
13646 "The default can not be set, see `org-default-priority' why")
13647 ;; normal cycling: `new' is beyond highest/lowest priority
13648 ;; and is wrapped around to the empty priority
13649 (setq remove t)))
13650 (setq news (format "%c" new))
13651 (if have
13652 (if remove
13653 (replace-match "" t t nil 1)
13654 (replace-match news t t nil 2))
13655 (if remove
13656 (error "No priority cookie found in line")
13657 (let ((case-fold-search nil))
13658 (looking-at org-todo-line-regexp))
13659 (if (match-end 2)
13660 (progn
13661 (goto-char (match-end 2))
13662 (insert " [#" news "]"))
13663 (goto-char (match-beginning 3))
13664 (insert "[#" news "] "))))
13665 (org-preserve-lc (org-set-tags nil 'align)))
13666 (if remove
13667 (message "Priority removed")
13668 (message "Priority of current item set to %s" news)))))
13670 (defun org-show-priority ()
13671 "Show the priority of the current item.
13672 This priority is composed of the main priority given with the [#A] cookies,
13673 and by additional input from the age of a schedules or deadline entry."
13674 (interactive)
13675 (let ((pri (if (eq major-mode 'org-agenda-mode)
13676 (org-get-at-bol 'priority)
13677 (save-excursion
13678 (save-match-data
13679 (beginning-of-line)
13680 (and (looking-at org-heading-regexp)
13681 (org-get-priority (match-string 0))))))))
13682 (message "Priority is %d" (if pri pri -1000))))
13684 (defun org-get-priority (s)
13685 "Find priority cookie and return priority."
13686 (save-match-data
13687 (if (functionp org-get-priority-function)
13688 (funcall org-get-priority-function)
13689 (if (not (string-match org-priority-regexp s))
13690 (* 1000 (- org-lowest-priority org-default-priority))
13691 (* 1000 (- org-lowest-priority
13692 (string-to-char (match-string 2 s))))))))
13694 ;;;; Tags
13696 (defvar org-agenda-archives-mode)
13697 (defvar org-map-continue-from nil
13698 "Position from where mapping should continue.
13699 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13701 (defvar org-scanner-tags nil
13702 "The current tag list while the tags scanner is running.")
13703 (defvar org-trust-scanner-tags nil
13704 "Should `org-get-tags-at' use the tags for the scanner.
13705 This is for internal dynamical scoping only.
13706 When this is non-nil, the function `org-get-tags-at' will return the value
13707 of `org-scanner-tags' instead of building the list by itself. This
13708 can lead to large speed-ups when the tags scanner is used in a file with
13709 many entries, and when the list of tags is retrieved, for example to
13710 obtain a list of properties. Building the tags list for each entry in such
13711 a file becomes an N^2 operation - but with this variable set, it scales
13712 as N.")
13714 (defun org-scan-tags (action matcher todo-only &optional start-level)
13715 "Sca headline tags with inheritance and produce output ACTION.
13717 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13718 or `agenda' to produce an entry list for an agenda view. It can also be
13719 a Lisp form or a function that should be called at each matched headline, in
13720 this case the return value is a list of all return values from these calls.
13722 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13723 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13724 only lines with a not-done TODO keyword are included in the output.
13725 This should be the same variable that was scoped into
13726 and set by `org-make-tags-matcher' when it constructed MATCHER.
13728 START-LEVEL can be a string with asterisks, reducing the scope to
13729 headlines matching this string."
13730 (require 'org-agenda)
13731 (let* ((re (concat "^"
13732 (if start-level
13733 ;; Get the correct level to match
13735 org-outline-regexp)
13739 (props (list 'face 'default
13740 'done-face 'org-agenda-done
13741 'undone-face 'default
13742 'mouse-face 'highlight
13743 'org-not-done-regexp org-not-done-regexp
13744 'org-todo-regexp org-todo-regexp
13745 'org-complex-heading-regexp org-complex-heading-regexp
13746 'help-echo
13747 (format "mouse-2 or RET jump to org file %s"
13748 (abbreviate-file-name
13749 (or (buffer-file-name (buffer-base-buffer))
13750 (buffer-name (buffer-base-buffer)))))))
13751 (case-fold-search nil)
13752 (org-map-continue-from nil)
13753 lspos tags tags-list
13754 (tags-alist (list (cons 0 org-file-tags)))
13755 (llast 0) rtn rtn1 level category i txt
13756 todo marker entry priority)
13757 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13758 (setq action (list 'lambda nil action)))
13759 (save-excursion
13760 (goto-char (point-min))
13761 (when (eq action 'sparse-tree)
13762 (org-overview)
13763 (org-remove-occur-highlights))
13764 (while (re-search-forward re nil t)
13765 (setq org-map-continue-from nil)
13766 (catch :skip
13767 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13768 tags (if (match-end 4) (org-match-string-no-properties 4)))
13769 (goto-char (setq lspos (match-beginning 0)))
13770 (setq level (org-reduced-level (org-outline-level))
13771 category (org-get-category))
13772 (setq i llast llast level)
13773 ;; remove tag lists from same and sublevels
13774 (while (>= i level)
13775 (when (setq entry (assoc i tags-alist))
13776 (setq tags-alist (delete entry tags-alist)))
13777 (setq i (1- i)))
13778 ;; add the next tags
13779 (when tags
13780 (setq tags (org-split-string tags ":")
13781 tags-alist
13782 (cons (cons level tags) tags-alist)))
13783 ;; compile tags for current headline
13784 (setq tags-list
13785 (if org-use-tag-inheritance
13786 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13787 tags)
13788 org-scanner-tags tags-list)
13789 (when org-use-tag-inheritance
13790 (setcdr (car tags-alist)
13791 (mapcar (lambda (x)
13792 (setq x (copy-sequence x))
13793 (org-add-prop-inherited x))
13794 (cdar tags-alist))))
13795 (when (and tags org-use-tag-inheritance
13796 (or (not (eq t org-use-tag-inheritance))
13797 org-tags-exclude-from-inheritance))
13798 ;; selective inheritance, remove uninherited ones
13799 (setcdr (car tags-alist)
13800 (org-remove-uninherited-tags (cdar tags-alist))))
13801 (when (and
13803 ;; eval matcher only when the todo condition is OK
13804 (and (or (not todo-only) (member todo org-not-done-keywords))
13805 (let ((case-fold-search t) (org-trust-scanner-tags t))
13806 (eval matcher)))
13808 ;; Call the skipper, but return t if it does not skip,
13809 ;; so that the `and' form continues evaluating
13810 (progn
13811 (unless (eq action 'sparse-tree) (org-agenda-skip))
13812 t)
13814 ;; Check if timestamps are deselecting this entry
13815 (or (not todo-only)
13816 (and (member todo org-not-done-keywords)
13817 (or (not org-agenda-tags-todo-honor-ignore-options)
13818 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
13820 ;; select this headline
13821 (cond
13822 ((eq action 'sparse-tree)
13823 (and org-highlight-sparse-tree-matches
13824 (org-get-heading) (match-end 0)
13825 (org-highlight-new-match
13826 (match-beginning 1) (match-end 1)))
13827 (org-show-context 'tags-tree))
13828 ((eq action 'agenda)
13829 (setq txt (org-agenda-format-item
13830 ""
13831 (concat
13832 (if (eq org-tags-match-list-sublevels 'indented)
13833 (make-string (1- level) ?.) "")
13834 (org-get-heading))
13835 level category
13836 tags-list)
13837 priority (org-get-priority txt))
13838 (goto-char lspos)
13839 (setq marker (org-agenda-new-marker))
13840 (org-add-props txt props
13841 'org-marker marker 'org-hd-marker marker 'org-category category
13842 'todo-state todo
13843 'priority priority 'type "tagsmatch")
13844 (push txt rtn))
13845 ((functionp action)
13846 (setq org-map-continue-from nil)
13847 (save-excursion
13848 (setq rtn1 (funcall action))
13849 (push rtn1 rtn)))
13850 (t (error "Invalid action")))
13852 ;; if we are to skip sublevels, jump to end of subtree
13853 (unless org-tags-match-list-sublevels
13854 (org-end-of-subtree t)
13855 (backward-char 1))))
13856 ;; Get the correct position from where to continue
13857 (if org-map-continue-from
13858 (goto-char org-map-continue-from)
13859 (and (= (point) lspos) (end-of-line 1)))))
13860 (when (and (eq action 'sparse-tree)
13861 (not org-sparse-tree-open-archived-trees))
13862 (org-hide-archived-subtrees (point-min) (point-max)))
13863 (nreverse rtn)))
13865 (defun org-remove-uninherited-tags (tags)
13866 "Remove all tags that are not inherited from the list TAGS."
13867 (cond
13868 ((eq org-use-tag-inheritance t)
13869 (if org-tags-exclude-from-inheritance
13870 (org-delete-all org-tags-exclude-from-inheritance tags)
13871 tags))
13872 ((not org-use-tag-inheritance) nil)
13873 ((stringp org-use-tag-inheritance)
13874 (delq nil (mapcar
13875 (lambda (x)
13876 (if (and (string-match org-use-tag-inheritance x)
13877 (not (member x org-tags-exclude-from-inheritance)))
13878 x nil))
13879 tags)))
13880 ((listp org-use-tag-inheritance)
13881 (delq nil (mapcar
13882 (lambda (x)
13883 (if (member x org-use-tag-inheritance) x nil))
13884 tags)))))
13886 (defun org-match-sparse-tree (&optional todo-only match)
13887 "Create a sparse tree according to tags string MATCH.
13888 MATCH can contain positive and negative selection of tags, like
13890 If optional argument TODO-ONLY is non-nil, only select lines that are
13891 also TODO lines."
13892 (interactive "P")
13893 (org-agenda-prepare-buffers (list (current-buffer)))
13894 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
13896 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
13898 (defvar org-cached-props nil)
13899 (defun org-cached-entry-get (pom property)
13900 (if (or (eq t org-use-property-inheritance)
13901 (and (stringp org-use-property-inheritance)
13902 (string-match org-use-property-inheritance property))
13903 (and (listp org-use-property-inheritance)
13904 (member property org-use-property-inheritance)))
13905 ;; Caching is not possible, check it directly
13906 (org-entry-get pom property 'inherit)
13907 ;; Get all properties, so that we can do complicated checks easily
13908 (cdr (assoc property (or org-cached-props
13909 (setq org-cached-props
13910 (org-entry-properties pom)))))))
13912 (defun org-global-tags-completion-table (&optional files)
13913 "Return the list of all tags in all agenda buffer/files.
13914 Optional FILES argument is a list of files which can be used
13915 instead of the agenda files."
13916 (save-excursion
13917 (org-uniquify
13918 (delq nil
13919 (apply 'append
13920 (mapcar
13921 (lambda (file)
13922 (set-buffer (find-file-noselect file))
13923 (append (org-get-buffer-tags)
13924 (mapcar (lambda (x) (if (stringp (car-safe x))
13925 (list (car-safe x)) nil))
13926 org-tag-alist)))
13927 (if (and files (car files))
13928 files
13929 (org-agenda-files))))))))
13931 (defun org-make-tags-matcher (match)
13932 "Create the TAGS/TODO matcher form for the selection string MATCH.
13934 The variable `todo-only' is scoped dynamically into this function.
13935 It will be set to t if the matcher restricts matching to TODO entries,
13936 otherwise will not be touched.
13938 Returns a cons of the selection string MATCH and the constructed
13939 lisp form implementing the matcher. The matcher is to be evaluated
13940 at an Org entry, with point on the headline, and returns t if the
13941 entry matches the selection string MATCH. The returned lisp form
13942 references two variables with information about the entry, which
13943 must be bound around the form's evaluation: todo, the TODO keyword
13944 at the entry (or nil of none); and tags-list, the list of all tags
13945 at the entry including inherited ones. Additionally, the category
13946 of the entry (if any) must be specified as the text property
13947 'org-category on the headline.
13949 See also `org-scan-tags'.
13950 "
13951 (declare (special todo-only))
13952 (unless (boundp 'todo-only)
13953 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
13954 (unless match
13955 ;; Get a new match request, with completion against the global
13956 ;; tags table and the local tags in current buffer
13957 (let ((org-last-tags-completion-table
13958 (org-uniquify
13959 (delq nil (append (org-get-buffer-tags)
13960 (org-global-tags-completion-table))))))
13961 (setq match (org-completing-read-no-i
13962 "Match: " 'org-tags-completion-function nil nil nil
13963 'org-tags-history))))
13965 ;; Parse the string and create a lisp form
13966 (let ((match0 match)
13967 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
13968 minus tag mm
13969 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
13970 orterms term orlist re-p str-p level-p level-op time-p
13971 prop-p pn pv po gv rest)
13972 ;; Expand group tags
13973 (setq match (org-tags-expand match))
13974 (if (string-match "/+" match)
13975 ;; match contains also a todo-matching request
13976 (progn
13977 (setq tagsmatch (substring match 0 (match-beginning 0))
13978 todomatch (substring match (match-end 0)))
13979 (if (string-match "^!" todomatch)
13980 (setq todo-only t todomatch (substring todomatch 1)))
13982 (setq todomatch nil)))
13983 ;; only matching tags
13984 (setq tagsmatch match todomatch nil))
13986 ;; Make the tags matcher
13988 (setq tagsmatcher t)
13989 (setq orterms (org-split-string tagsmatch "|") orlist nil)
13990 (while (setq term (pop orterms))
13992 (setq term (concat term "|" (pop orterms)))) ; repair bad split
13993 (while (string-match re term)
13994 (setq rest (substring term (match-end 0))
13995 minus (and (match-end 1)
13996 (equal (match-string 1 term) "-"))
13997 tag (save-match-data (replace-regexp-in-string
13999 (match-string 2 term)))
14000 re-p (equal (string-to-char tag) ?{)
14001 level-p (match-end 4)
14002 prop-p (match-end 5)
14003 mm (cond
14004 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14005 (level-p
14006 (setq level-op (org-op-to-function (match-string 3 term)))
14007 `(,level-op level ,(string-to-number
14008 (match-string 4 term))))
14009 (prop-p
14010 (setq pn (match-string 5 term)
14011 po (match-string 6 term)
14012 pv (match-string 7 term)
14013 re-p (equal (string-to-char pv) ?{)
14015 time-p (save-match-data
14017 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14018 (if time-p (setq pv (org-matcher-time pv)))
14019 (setq po (org-op-to-function po (if time-p 'time str-p)))
14020 (cond
14021 ((equal pn "CATEGORY")
14022 (setq gv '(get-text-property (point) 'org-category)))
14023 ((equal pn "TODO")
14024 (setq gv 'todo))
14025 (t
14026 (setq gv `(org-cached-entry-get nil ,pn))))
14027 (if re-p
14028 (if (eq po 'org<>)
14029 `(not (string-match ,pv (or ,gv "")))
14030 `(string-match ,pv (or ,gv "")))
14031 (if str-p
14032 `(,po (or ,gv "") ,pv)
14033 `(,po (string-to-number (or ,gv ""))
14034 ,(string-to-number pv) ))))
14035 (t `(member ,tag tags-list)))
14036 mm (if minus (list 'not mm) mm)
14037 term rest)
14038 (push mm tagsmatcher))
14039 (push (if (> (length tagsmatcher) 1)
14040 (cons 'and tagsmatcher)
14041 (car tagsmatcher))
14042 orlist)
14043 (setq tagsmatcher nil))
14044 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14045 (setq tagsmatcher
14046 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14047 ;; Make the todo matcher
14049 (setq todomatcher t)
14050 (setq orterms (org-split-string todomatch "|") orlist nil)
14051 (while (setq term (pop orterms))
14052 (while (string-match re term)
14053 (setq minus (and (match-end 1)
14054 (equal (match-string 1 term) "-"))
14055 kwd (match-string 2 term)
14056 re-p (equal (string-to-char kwd) ?{)
14057 term (substring term (match-end 0))
14058 mm (if re-p
14059 `(string-match ,(substring kwd 1 -1) todo)
14060 (list 'equal 'todo kwd))
14061 mm (if minus (list 'not mm) mm))
14062 (push mm todomatcher))
14063 (push (if (> (length todomatcher) 1)
14064 (cons 'and todomatcher)
14065 (car todomatcher))
14066 orlist)
14067 (setq todomatcher nil))
14068 (setq todomatcher (if (> (length orlist) 1)
14069 (cons 'or orlist) (car orlist))))
14071 ;; Return the string and lisp forms of the matcher
14072 (setq matcher (if todomatcher
14073 (list 'and tagsmatcher todomatcher)
14074 tagsmatcher))
14075 (when todo-only
14076 (setq matcher (list 'and '(member todo org-not-done-keywords)
14077 matcher)))
14078 (cons match0 matcher)))
14080 (defun org-tags-expand (match &optional single-as-list downcased)
14081 "Expand group tags in MATCH.
14083 This replaces every group tag in MATCH with a regexp tag search.
14085 will be replaced like this:
14091 Replacing by a regexp preserves the structure of the match.
14092 E.g., this expansion
14099 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14100 assumed to be a single group tag, and the function will return
14101 the list of tags in this group.
14103 When DOWNCASE is non-nil, expand downcased TAGS."
14104 (if org-group-tags
14105 (let* ((case-fold-search t)
14106 (stable org-mode-syntax-table)
14107 (tal (or org-tag-groups-alist-for-agenda
14108 org-tag-groups-alist))
14109 (tal (if downcased
14110 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14111 (tml (mapcar 'car tal))
14112 (rtnmatch match) rpl)
14113 ;; @ and _ are allowed as word-components in tags
14114 (modify-syntax-entry ?@ "w" stable)
14115 (modify-syntax-entry ?_ "w" stable)
14116 (while (and tml
14117 (string-match
14120 (let* ((dir (match-string 1 rtnmatch))
14121 (tag (match-string 2 rtnmatch))
14122 (tag (if downcased (downcase tag) tag)))
14123 (setq tml (delete tag tml))
14124 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14125 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14127 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14128 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14129 (if single-as-list
14130 (or (reverse rpl) (list rtnmatch))
14131 rtnmatch))
14132 (if single-as-list (list (if downcased (downcase match) match))
14133 match)))
14135 (defun org-op-to-function (op &optional stringp)
14136 "Turn an operator into the appropriate function."
14137 (setq op
14138 (cond
14139 ((equal op "<" ) '(< string< org-time<))
14140 ((equal op ">" ) '(> org-string> org-time>))
14141 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14142 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14143 ((member op '("=" "==")) '(= string= org-time=))
14144 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14145 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14147 (defun org<> (a b) (not (= a b)))
14148 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14149 (defun org-string>= (a b) (not (string< a b)))
14150 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14151 (defun org-string<> (a b) (not (string= a b)))
14152 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14153 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14154 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14155 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14156 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14157 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14158 (defun org-2ft (s)
14159 "Convert S to a floating point time.
14160 If S is already a number, just return it. If it is a string, parse
14161 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14162 (cond
14163 ((numberp s) s)
14164 ((stringp s)
14165 (condition-case nil
14166 (float-time (apply 'encode-time (org-parse-time-string s)))
14167 (error 0.)))
14168 (t 0.)))
14170 (defun org-time-today ()
14171 "Time in seconds today at 0:00.
14172 Returns the float number of seconds since the beginning of the
14173 epoch to the beginning of today (00:00)."
14174 (float-time (apply 'encode-time
14175 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14177 (defun org-matcher-time (s)
14178 "Interpret a time comparison value."
14179 (save-match-data
14180 (cond
14181 ((string= s "<now>") (float-time))
14182 ((string= s "<today>") (org-time-today))
14183 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14184 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14186 (+ (org-time-today)
14187 (* (string-to-number (match-string 1 s))
14188 (cdr (assoc (match-string 2 s)
14189 '(("d" . 86400.0) ("w" . 604800.0)
14190 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14191 (t (org-2ft s)))))
14193 (defun org-match-any-p (re list)
14194 "Does re match any element of list?"
14195 (setq list (mapcar (lambda (x) (string-match re x)) list))
14196 (delq nil list))
14198 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14199 (defvar org-tags-overlay (make-overlay 1 1))
14200 (org-detach-overlay org-tags-overlay)
14202 (defun org-get-local-tags-at (&optional pos)
14203 "Get a list of tags defined in the current headline."
14204 (org-get-tags-at pos 'local))
14206 (defun org-get-local-tags ()
14207 "Get a list of tags defined in the current headline."
14208 (org-get-tags-at nil 'local))
14210 (defun org-get-tags-at (&optional pos local)
14211 "Get a list of all headline tags applicable at POS.
14212 POS defaults to point. If tags are inherited, the list contains
14213 the targets in the same sequence as the headlines appear, i.e.
14214 the tags of the current headline come last.
14215 When LOCAL is non-nil, only return tags from the current headline,
14216 ignore inherited ones."
14217 (interactive)
14218 (if (and org-trust-scanner-tags
14219 (or (not pos) (equal pos (point)))
14220 (not local))
14221 org-scanner-tags
14222 (let (tags ltags lastpos parent)
14223 (save-excursion
14224 (save-restriction
14225 (widen)
14226 (goto-char (or pos (point)))
14227 (save-match-data
14228 (catch 'done
14229 (condition-case nil
14230 (progn
14231 (org-back-to-heading t)
14232 (while (not (equal lastpos (point)))
14233 (setq lastpos (point))
14234 (when (looking-at
14236 (setq ltags (org-split-string
14237 (org-match-string-no-properties 1) ":"))
14238 (when parent
14239 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14240 (setq tags (append
14241 (if parent
14242 (org-remove-uninherited-tags ltags)
14243 ltags)
14244 tags)))
14245 (or org-use-tag-inheritance (throw 'done t))
14246 (if local (throw 'done t))
14247 (or (org-up-heading-safe) (error nil))
14248 (setq parent t)))
14249 (error nil)))))
14250 (if local
14251 tags
14252 (reverse (delete-dups
14253 (reverse (append
14254 (org-remove-uninherited-tags
14255 org-file-tags) tags)))))))))
14257 (defun org-add-prop-inherited (s)
14258 (add-text-properties 0 (length s) '(inherited t) s)
14259 s)
14261 (defun org-toggle-tag (tag &optional onoff)
14262 "Toggle the tag TAG for the current line.
14263 If ONOFF is `on' or `off', don't toggle but set to this state."
14264 (let (res current)
14265 (save-excursion
14266 (org-back-to-heading t)
14268 (point-at-eol) t)
14269 (progn
14270 (setq current (match-string 1))
14271 (replace-match ""))
14272 (setq current ""))
14273 (setq current (nreverse (org-split-string current ":")))
14274 (cond
14275 ((eq onoff 'on)
14276 (setq res t)
14277 (or (member tag current) (push tag current)))
14278 ((eq onoff 'off)
14279 (or (not (member tag current)) (setq current (delete tag current))))
14280 (t (if (member tag current)
14281 (setq current (delete tag current))
14282 (setq res t)
14283 (push tag current))))
14284 (end-of-line 1)
14285 (if current
14286 (progn
14287 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14288 (org-set-tags nil t))
14289 (delete-horizontal-space))
14290 (run-hooks 'org-after-tags-change-hook))
14291 res))
14293 (defun org-align-tags-here (to-col)
14294 ;; Assumes that this is a headline
14295 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14296 (beginning-of-line 1)
14298 (< pos (match-beginning 2)))
14299 (progn
14300 (setq tags-l (- (match-end 2) (match-beginning 2)))
14301 (goto-char (match-beginning 1))
14302 (insert " ")
14303 (delete-region (point) (1+ (match-beginning 2)))
14304 (setq ncol (max (current-column)
14305 (1+ col)
14306 (if (> to-col 0)
14307 to-col
14308 (- (abs to-col) tags-l))))
14309 (setq p (point))
14310 (insert (make-string (- ncol (current-column)) ?\ ))
14311 (setq ncol (current-column))
14312 (when indent-tabs-mode (tabify p (point-at-eol)))
14313 (org-move-to-column (min ncol col) t))
14314 (goto-char pos))))
14316 (defun org-set-tags-command (&optional arg just-align)
14317 "Call the set-tags command for the current entry."
14318 (interactive "P")
14319 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14320 (org-set-tags arg just-align)
14321 (save-excursion
14322 (unless (and (org-region-active-p)
14323 org-loop-over-headlines-in-active-region)
14324 (org-back-to-heading t))
14325 (org-set-tags arg just-align))))
14327 (defun org-set-tags-to (data)
14328 "Set the tags of the current entry to DATA, replacing the current tags.
14329 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14330 If DATA is nil or the empty string, any tags will be removed."
14331 (interactive "sTags: ")
14332 (setq data
14333 (cond
14334 ((eq data nil) "")
14335 ((equal data "") "")
14336 ((stringp data)
14337 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14338 ":"))
14339 ((listp data)
14340 (concat ":" (mapconcat 'identity data ":") ":"))))
14341 (when data
14342 (save-excursion
14343 (org-back-to-heading t)
14344 (when (looking-at org-complex-heading-regexp)
14345 (if (match-end 5)
14346 (progn
14347 (goto-char (match-beginning 5))
14348 (insert data)
14349 (delete-region (point) (point-at-eol))
14350 (org-set-tags nil 'align))
14351 (goto-char (point-at-eol))
14352 (insert " " data)
14353 (org-set-tags nil 'align)))
14354 (beginning-of-line 1)
14356 (delete-region (match-beginning 1) (match-end 1))))))
14358 (defun org-align-all-tags ()
14359 "Align the tags i all headings."
14360 (interactive)
14361 (save-excursion
14362 (or (ignore-errors (org-back-to-heading t))
14363 (outline-next-heading))
14364 (if (org-at-heading-p)
14365 (org-set-tags t)
14366 (message "No headings"))))
14368 (defvar org-indent-indentation-per-level)
14369 (defun org-set-tags (&optional arg just-align)
14370 "Set the tags for the current headline.
14371 With prefix ARG, realign all tags in headings in the current buffer."
14372 (interactive "P")
14373 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14374 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14375 'region-start-level 'region))
14376 org-loop-over-headlines-in-active-region)
14377 (org-map-entries
14378 ;; We don't use ARG and JUST-ALIGN here these args are not
14379 ;; useful when looping over headlines
14380 `(org-set-tags)
14381 org-loop-over-headlines-in-active-region
14382 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14383 (let* ((re org-outline-regexp-bol)
14384 (current (unless arg (org-get-tags-string)))
14385 (col (current-column))
14386 (org-setting-tags t)
14387 table current-tags inherited-tags ; computed below when needed
14388 tags p0 c0 c1 rpl di tc level)
14389 (if arg
14390 (save-excursion
14391 (goto-char (point-min))
14392 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14393 (while (re-search-forward re nil t)
14394 (org-set-tags nil t)
14395 (end-of-line 1)))
14396 (message "All tags realigned to column %d" org-tags-column))
14397 (if just-align
14398 (setq tags current)
14399 ;; Get a new set of tags from the user
14400 (save-excursion
14401 (setq table (append org-tag-persistent-alist
14402 (or org-tag-alist (org-get-buffer-tags))
14403 (and
14404 org-complete-tags-always-offer-all-agenda-tags
14405 (org-global-tags-completion-table
14406 (org-agenda-files))))
14407 org-last-tags-completion-table table
14408 current-tags (org-split-string current ":")
14409 inherited-tags (nreverse
14410 (nthcdr (length current-tags)
14411 (nreverse (org-get-tags-at))))
14412 tags
14413 (if (or (eq t org-use-fast-tag-selection)
14414 (and org-use-fast-tag-selection
14415 (delq nil (mapcar 'cdr table))))
14416 (org-fast-tag-selection
14417 current-tags inherited-tags table
14418 (if org-fast-tag-selection-include-todo
14419 org-todo-key-alist))
14420 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14421 (org-trim
14422 (org-icompleting-read "Tags: "
14423 'org-tags-completion-function
14424 nil nil current 'org-tags-history))))))
14425 (while (string-match "[-+&]+" tags)
14426 ;; No boolean logic, just a list
14427 (setq tags (replace-match ":" t t tags))))
14429 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14431 (if org-tags-sort-function
14432 (setq tags (mapconcat 'identity
14433 (sort (org-split-string
14434 tags (org-re "[^[:alnum:]_@#%]+"))
14435 org-tags-sort-function) ":")))
14438 (setq tags "")
14439 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14440 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14442 ;; Insert new tags at the correct column
14443 (beginning-of-line 1)
14444 (setq level (or (and (looking-at org-outline-regexp)
14445 (- (match-end 0) (point) 1))
14446 1))
14447 (cond
14448 ((and (equal current "") (equal tags "")))
14449 ((re-search-forward
14451 (point-at-eol) t)
14452 (if (equal tags "")
14453 (setq rpl "")
14454 (goto-char (match-beginning 0))
14455 (setq c0 (current-column)
14456 ;; compute offset for the case of org-indent-mode active
14457 di (if org-indent-mode
14458 (* (1- org-indent-indentation-per-level) (1- level))
14459 0)
14460 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14461 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14462 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (length tags))))
14463 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14464 (replace-match rpl t t)
14465 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14466 tags)
14467 (t (error "Tags alignment failed")))
14468 (org-move-to-column col)
14469 (unless just-align
14470 (run-hooks 'org-after-tags-change-hook))))))
14472 (defun org-change-tag-in-region (beg end tag off)
14473 "Add or remove TAG for each entry in the region.
14474 This works in the agenda, and also in an org-mode buffer."
14475 (interactive
14476 (list (region-beginning) (region-end)
14477 (let ((org-last-tags-completion-table
14478 (if (derived-mode-p 'org-mode)
14479 (org-uniquify
14480 (delq nil (append (org-get-buffer-tags)
14481 (org-global-tags-completion-table))))
14482 (org-global-tags-completion-table))))
14483 (org-icompleting-read
14484 "Tag: " 'org-tags-completion-function nil nil nil
14485 'org-tags-history))
14486 (progn
14488 (equal (read-char-exclusive) ?r))))
14489 (if (fboundp 'deactivate-mark) (deactivate-mark))
14490 (let ((agendap (equal major-mode 'org-agenda-mode))
14491 l1 l2 m buf pos newhead (cnt 0))
14492 (goto-char end)
14493 (setq l2 (1- (org-current-line)))
14494 (goto-char beg)
14495 (setq l1 (org-current-line))
14496 (loop for l from l1 to l2 do
14497 (org-goto-line l)
14498 (setq m (get-text-property (point) 'org-hd-marker))
14499 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14500 (and agendap m))
14501 (setq buf (if agendap (marker-buffer m) (current-buffer))
14502 pos (if agendap m (point)))
14503 (with-current-buffer buf
14504 (save-excursion
14505 (save-restriction
14506 (goto-char pos)
14507 (setq cnt (1+ cnt))
14508 (org-toggle-tag tag (if off 'off 'on))
14509 (setq newhead (org-get-heading)))))
14510 (and agendap (org-agenda-change-all-lines newhead m))))
14511 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14513 (defun org-tags-completion-function (string predicate &optional flag)
14514 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14515 (confirm (lambda (x) (stringp (car x)))))
14517 (setq s1 (match-string 1 string)
14518 s2 (match-string 2 string))
14519 (setq s1 "" s2 string))
14520 (cond
14521 ((eq flag nil)
14522 ;; try completion
14523 (setq rtn (try-completion s2 ctable confirm))
14524 (if (stringp rtn)
14525 (setq rtn
14526 (concat s1 s2 (substring rtn (length s2))
14527 (if (and org-add-colon-after-tag-completion
14528 (assoc rtn ctable))
14529 ":" ""))))
14530 rtn)
14531 ((eq flag t)
14532 ;; all-completions
14533 (all-completions s2 ctable confirm))
14534 ((eq flag 'lambda)
14535 ;; exact match?
14536 (assoc s2 ctable)))))
14538 (defun org-fast-tag-insert (kwd tags face &optional end)
14539 "Insert KDW, and the TAGS, the latter with face FACE.
14540 Also insert END."
14541 (insert (format "%-12s" (concat kwd ":"))
14542 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14543 (or end "")))
14545 (defun org-fast-tag-show-exit (flag)
14546 (save-excursion
14547 (org-goto-line 3)
14549 (replace-match ""))
14550 (when flag
14551 (end-of-line 1)
14552 (org-move-to-column (- (window-width) 19) t)
14553 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14555 (defun org-set-current-tags-overlay (current prefix)
14556 "Add an overlay to CURRENT tag with PREFIX."
14557 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14558 (if (featurep 'xemacs)
14559 (org-overlay-display org-tags-overlay (concat prefix s)
14560 'secondary-selection)
14561 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14562 (org-overlay-display org-tags-overlay (concat prefix s)))))
14564 (defvar org-last-tag-selection-key nil)
14565 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14566 "Fast tag selection with single keys.
14567 CURRENT is the current list of tags in the headline, INHERITED is the
14568 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14569 possibly with grouping information. TODO-TABLE is a similar table with
14570 TODO keywords, should these have keys assigned to them.
14571 If the keys are nil, a-z are automatically assigned.
14572 Returns the new tags string, or nil to not change the current settings."
14573 (let* ((fulltable (append table todo-table))
14574 (maxlen (apply 'max (mapcar
14575 (lambda (x)
14576 (if (stringp (car x)) (string-width (car x)) 0))
14577 fulltable)))
14578 (buf (current-buffer))
14579 (expert (eq org-fast-tag-selection-single-key 'expert))
14580 (buffer-tags nil)
14581 (fwidth (+ maxlen 3 1 3))
14582 (ncol (/ (- (window-width) 4) fwidth))
14583 (i-face 'org-done)
14584 (c-face 'org-todo)
14585 tg cnt e c char c1 c2 ntable tbl rtn
14586 ov-start ov-end ov-prefix
14587 (exit-after-next org-fast-tag-selection-single-key)
14588 (done-keywords org-done-keywords)
14589 groups ingroup)
14590 (save-excursion
14591 (beginning-of-line 1)
14592 (if (looking-at
14594 (setq ov-start (match-beginning 1)
14595 ov-end (match-end 1)
14596 ov-prefix "")
14597 (setq ov-start (1- (point-at-eol))
14598 ov-end (1+ ov-start))
14600 (setq ov-prefix
14601 (concat
14602 (buffer-substring (1- (point)) (point))
14603 (if (> (current-column) org-tags-column)
14604 " "
14605 (make-string (- org-tags-column (current-column)) ?\ ))))))
14606 (move-overlay org-tags-overlay ov-start ov-end)
14607 (save-window-excursion
14608 (if expert
14609 (set-buffer (get-buffer-create " *Org tags*"))
14610 (delete-other-windows)
14611 (split-window-vertically)
14612 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
14613 (erase-buffer)
14614 (org-set-local 'org-done-keywords done-keywords)
14617 (org-fast-tag-show-exit exit-after-next)
14618 (org-set-current-tags-overlay current ov-prefix)
14619 (setq tbl fulltable char ?a cnt 0)
14620 (while (setq e (pop tbl))
14621 (cond
14622 ((equal (car e) :startgroup)
14623 (push '() groups) (setq ingroup t)
14624 (when (not (= cnt 0))
14625 (setq cnt 0)
14627 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
14628 ((equal (car e) :endgroup)
14629 (setq ingroup nil cnt 0)
14631 ((equal e '(:newline))
14632 (when (not (= cnt 0))
14633 (setq cnt 0)
14635 (setq e (car tbl))
14636 (while (equal (car tbl) '(:newline))
14638 (setq tbl (cdr tbl)))))
14639 ((equal e '(:grouptags)) nil)
14640 (t
14641 (setq tg (copy-sequence (car e)) c2 nil)
14642 (if (cdr e)
14643 (setq c (cdr e))
14644 ;; automatically assign a character.
14645 (setq c1 (string-to-char
14646 (downcase (substring
14647 tg (if (= (string-to-char tg) ?@) 1 0)))))
14648 (if (or (rassoc c1 ntable) (rassoc c1 table))
14649 (while (or (rassoc char ntable) (rassoc char table))
14650 (setq char (1+ char)))
14651 (setq c2 c1))
14652 (setq c (or c2 char)))
14653 (if ingroup (push tg (car groups)))
14654 (setq tg (org-add-props tg nil 'face
14655 (cond
14656 ((not (assoc tg table))
14657 (org-get-todo-face tg))
14658 ((member tg current) c-face)
14659 ((member tg inherited) i-face))))
14660 (if (equal (caar tbl) :grouptags)
14661 (org-add-props tg nil 'face 'org-tag-group))
14662 (if (and (= cnt 0) (not ingroup)) (insert " "))
14663 (insert "[" c "] " tg (make-string
14664 (- fwidth 4 (length tg)) ?\ ))
14665 (push (cons tg c) ntable)
14666 (when (= (setq cnt (1+ cnt)) ncol)
14668 (if ingroup (insert " "))
14669 (setq cnt 0)))))
14670 (setq ntable (nreverse ntable))
14672 (goto-char (point-min))
14673 (if (not expert) (org-fit-window-to-buffer))
14674 (setq rtn
14675 (catch 'exit
14676 (while t
14677 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14678 (if (not groups) "no " "")
14679 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14680 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14681 (setq org-last-tag-selection-key c)
14682 (cond
14684 ((= c ?!)
14685 (setq groups (not groups))
14686 (goto-char (point-min))
14687 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14688 ((= c ?\C-c)
14689 (if (not expert)
14690 (org-fast-tag-show-exit
14691 (setq exit-after-next (not exit-after-next)))
14692 (setq expert nil)
14693 (delete-other-windows)
14694 (set-window-buffer (split-window-vertically) " *Org tags*")
14695 (org-switch-to-buffer-other-window " *Org tags*")
14696 (org-fit-window-to-buffer)))
14697 ((or (= c ?\C-g)
14698 (and (= c ?q) (not (rassoc c ntable))))
14699 (org-detach-overlay org-tags-overlay)
14700 (setq quit-flag t))
14701 ((= c ?\ )
14702 (setq current nil)
14703 (if exit-after-next (setq exit-after-next 'now)))
14705 (condition-case nil
14706 (setq tg (org-icompleting-read
14707 "Tag: "
14708 (or buffer-tags
14709 (with-current-buffer buf
14710 (org-get-buffer-tags)))))
14711 (quit (setq tg "")))
14713 (add-to-list 'buffer-tags (list tg))
14714 (if (member tg current)
14715 (setq current (delete tg current))
14716 (push tg current)))
14717 (if exit-after-next (setq exit-after-next 'now)))
14718 ((setq e (rassoc c todo-table) tg (car e))
14719 (with-current-buffer buf
14720 (save-excursion (org-todo tg)))
14721 (if exit-after-next (setq exit-after-next 'now)))
14722 ((setq e (rassoc c ntable) tg (car e))
14723 (if (member tg current)
14724 (setq current (delete tg current))
14725 (loop for g in groups do
14726 (if (member tg g)
14727 (mapc (lambda (x)
14728 (setq current (delete x current)))
14729 g)))
14730 (push tg current))
14731 (if exit-after-next (setq exit-after-next 'now))))
14733 ;; Create a sorted list
14734 (setq current
14735 (sort current
14736 (lambda (a b)
14737 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14738 (if (eq exit-after-next 'now) (throw 'exit t))
14739 (goto-char (point-min))
14740 (beginning-of-line 2)
14741 (delete-region (point) (point-at-eol))
14742 (org-fast-tag-insert "Current" current c-face)
14743 (org-set-current-tags-overlay current ov-prefix)
14744 (while (re-search-forward
14746 (setq tg (match-string 1))
14747 (add-text-properties
14748 (match-beginning 1) (match-end 1)
14749 (list 'face
14750 (cond
14751 ((member tg current) c-face)
14752 ((member tg inherited) i-face)
14753 (t (get-text-property (match-beginning 1) 'face))))))
14754 (goto-char (point-min)))))
14755 (org-detach-overlay org-tags-overlay)
14756 (if rtn
14757 (mapconcat 'identity current ":")
14758 nil))))
14760 (defun org-get-tags-string ()
14761 "Get the TAGS string in the current headline."
14762 (unless (org-at-heading-p t)
14763 (error "Not on a heading"))
14764 (save-excursion
14765 (beginning-of-line 1)
14767 (org-match-string-no-properties 1)
14768 "")))
14770 (defun org-get-tags ()
14771 "Get the list of tags specified in the current headline."
14772 (org-split-string (org-get-tags-string) ":"))
14774 (defun org-get-buffer-tags ()
14775 "Get a table of all tags used in the buffer, for completion."
14776 (let (tags)
14777 (save-excursion
14778 (goto-char (point-min))
14779 (while (re-search-forward
14781 (when (equal (char-after (point-at-bol 0)) ?*)
14782 (mapc (lambda (x) (add-to-list 'tags x))
14783 (org-split-string (org-match-string-no-properties 1) ":")))))
14784 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14785 (mapcar 'list tags)))
14787 ;;;; The mapping API
14789 (defun org-map-entries (func &optional match scope &rest skip)
14790 "Call FUNC at each headline selected by MATCH in SCOPE.
14792 FUNC is a function or a lisp form. The function will be called without
14793 arguments, with the cursor positioned at the beginning of the headline.
14794 The return values of all calls to the function will be collected and
14795 returned as a list.
14797 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14798 does not need to preserve point. After evaluation, the cursor will be
14799 moved to the end of the line (presumably of the headline of the
14800 processed entry) and search continues from there. Under some
14801 circumstances, this may not produce the wanted results. For example,
14802 if you have removed (e.g. archived) the current (sub)tree it could
14803 mean that the next entry will be skipped entirely. In such cases, you
14804 can specify the position from where search should continue by making
14805 FUNC set the variable `org-map-continue-from' to the desired buffer
14806 position.
14808 MATCH is a tags/property/todo match as it is used in the agenda tags view.
14809 Only headlines that are matched by this query will be considered during
14810 the iteration. When MATCH is nil or t, all headlines will be
14811 visited by the iteration.
14813 SCOPE determines the scope of this command. It can be any of:
14815 nil The current buffer, respecting the restriction if any
14816 tree The subtree started with the entry at point
14817 region The entries within the active region, if any
14818 region-start-level
14819 The entries within the active region, but only those at
14820 the same level than the first one.
14821 file The current buffer, without restriction
14822 file-with-archives
14823 The current buffer, and any archives associated with it
14824 agenda All agenda files
14825 agenda-with-archives
14826 All agenda files with any archive files associated with them
14827 \(file1 file2 ...)
14828 If this is a list, all files in the list will be scanned
14830 The remaining args are treated as settings for the skipping facilities of
14831 the scanner. The following items can be given here:
14833 archive skip trees with the archive tag
14834 comment skip trees with the COMMENT keyword
14835 function or Emacs Lisp form:
14836 will be used as value for `org-agenda-skip-function', so
14837 whenever the function returns a position, FUNC will not be
14838 called for that entry and search will continue from the
14839 position returned
14841 If your function needs to retrieve the tags including inherited tags
14842 at the *current* entry, you can use the value of the variable
14843 `org-scanner-tags' which will be much faster than getting the value
14844 with `org-get-tags-at'. If your function gets properties with
14845 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
14846 to t around the call to `org-entry-properties' to get the same speedup.
14847 Note that if your function moves around to retrieve tags and properties at
14848 a *different* entry, you cannot use these techniques."
14849 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
14850 (not (org-region-active-p)))
14851 (let* ((org-agenda-archives-mode nil) ; just to make sure
14852 (org-agenda-skip-archived-trees (memq 'archive skip))
14853 (org-agenda-skip-comment-trees (memq 'comment skip))
14854 (org-agenda-skip-function
14855 (car (org-delete-all '(comment archive) skip)))
14856 (org-tags-match-list-sublevels t)
14857 (start-level (eq scope 'region-start-level))
14858 matcher file res
14859 org-todo-keywords-for-agenda
14860 org-done-keywords-for-agenda
14861 org-todo-keyword-alist-for-agenda
14862 org-drawers-for-agenda
14863 org-tag-alist-for-agenda
14864 todo-only)
14866 (cond
14867 ((eq match t) (setq matcher t))
14868 ((eq match nil) (setq matcher t))
14869 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
14871 (save-window-excursion
14872 (save-restriction
14873 (cond ((eq scope 'tree)
14874 (org-back-to-heading t)
14875 (org-narrow-to-subtree)
14876 (setq scope nil))
14877 ((and (or (eq scope 'region) (eq scope 'region-start-level))
14878 (org-region-active-p))
14879 ;; If needed, set start-level to a string like "2"
14880 (when start-level
14881 (save-excursion
14882 (goto-char (region-beginning))
14883 (unless (org-at-heading-p) (outline-next-heading))
14884 (setq start-level (org-current-level))))
14885 (narrow-to-region (region-beginning)
14886 (save-excursion
14887 (goto-char (region-end))
14888 (unless (and (bolp) (org-at-heading-p))
14889 (outline-next-heading))
14890 (point)))
14891 (setq scope nil)))
14893 (if (not scope)
14894 (progn
14895 (org-agenda-prepare-buffers
14896 (list (buffer-file-name (current-buffer))))
14897 (setq res (org-scan-tags func matcher todo-only start-level)))
14898 ;; Get the right scope
14899 (cond
14900 ((and scope (listp scope) (symbolp (car scope)))
14901 (setq scope (eval scope)))
14902 ((eq scope 'agenda)
14903 (setq scope (org-agenda-files t)))
14904 ((eq scope 'agenda-with-archives)
14905 (setq scope (org-agenda-files t))
14906 (setq scope (org-add-archive-files scope)))
14907 ((eq scope 'file)
14908 (setq scope (list (buffer-file-name))))
14909 ((eq scope 'file-with-archives)
14910 (setq scope (org-add-archive-files (list (buffer-file-name))))))
14911 (org-agenda-prepare-buffers scope)
14912 (while (setq file (pop scope))
14913 (with-current-buffer (org-find-base-buffer-visiting file)
14914 (save-excursion
14915 (save-restriction
14916 (widen)
14917 (goto-char (point-min))
14918 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
14919 res)))
14921 ;;;; Properties
14923 ;;; Setting and retrieving properties
14925 (defconst org-special-properties
14926 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
14927 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
14928 "The special properties valid in Org-mode.
14930 These are properties that are not defined in the property drawer,
14931 but in some other way.")
14933 (defconst org-default-properties
14934 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
14935 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
14936 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
14937 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
14938 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
14939 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
14940 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
14941 "Some properties that are used by Org-mode for various purposes.
14942 Being in this list makes sure that they are offered for completion.")
14945 "Regular expression matching the first line of a property drawer.")
14948 "Regular expression matching the last line of a property drawer.")
14951 "Regular expression matching the first line of a property drawer.")
14954 "Regular expression matching the first line of a property drawer.")
14956 (defconst org-property-drawer-re
14959 "Matches an entire property drawer.")
14961 (defconst org-clock-drawer-re
14964 "Matches an entire clock drawer.")
14966 (defsubst org-re-property (property)
14967 "Return a regexp matching a PROPERTY line.
14968 Match group 1 will be set to the value."
14971 (defsubst org-re-property-keyword (property)
14972 "Return a regexp matching a PROPERTY line, possibly with no
14973 value for the property."
14976 (defun org-property-action ()
14977 "Do an action on properties."
14978 (interactive)
14979 (let (c)
14980 (org-at-property-p)
14981 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
14982 (setq c (read-char-exclusive))
14983 (cond
14984 ((equal c ?s)
14985 (call-interactively 'org-set-property))
14986 ((equal c ?d)
14987 (call-interactively 'org-delete-property))
14988 ((equal c ?D)
14989 (call-interactively 'org-delete-property-globally))
14990 ((equal c ?c)
14991 (call-interactively 'org-compute-property-at-point))
14992 (t (error "No such property action %c" c)))))
14994 (defun org-inc-effort ()
14995 "Increment the value of the effort property in the current entry."
14996 (interactive)
14997 (org-set-effort nil t))
14999 (defvar org-clock-effort) ;; Defined in org-clock.el
15000 (defvar org-clock-current-task) ;; Defined in org-clock.el
15001 (defun org-set-effort (&optional value increment)
15002 "Set the effort property of the current entry.
15003 With numerical prefix arg, use the nth allowed value, 0 stands for the
15004 10th allowed value.
15006 When INCREMENT is non-nil, set the property to the next allowed value."
15007 (interactive "P")
15008 (if (equal value 0) (setq value 10))
15009 (let* ((completion-ignore-case t)
15010 (prop org-effort-property)
15011 (cur (org-entry-get nil prop))
15012 (allowed (org-property-get-allowed-values nil prop 'table))
15013 (existing (mapcar 'list (org-property-values prop)))
15014 (heading (nth 4 (org-heading-components)))
15015 rpl
15016 (val (cond
15017 ((stringp value) value)
15018 ((and allowed (integerp value))
15019 (or (car (nth (1- value) allowed))
15020 (car (org-last allowed))))
15021 ((and allowed increment)
15022 (or (caadr (member (list cur) allowed))
15023 (error "Allowed effort values are not set")))
15024 (allowed
15025 (message "Select 1-9,0, [RET%s]: %s"
15026 (if cur (concat "=" cur) "")
15027 (mapconcat 'car allowed " "))
15028 (setq rpl (read-char-exclusive))
15030 cur
15031 (setq rpl (- rpl ?0))
15032 (if (equal rpl 0) (setq rpl 10))
15033 (if (and (> rpl 0) (<= rpl (length allowed)))
15034 (car (nth (1- rpl) allowed))
15035 (org-completing-read "Effort: " allowed nil))))
15036 (t
15037 (let (org-completion-use-ido org-completion-use-iswitchb)
15038 (org-completing-read
15040 (concat "[" cur "]") "")
15041 ": ")
15042 existing nil nil "" nil cur))))))
15043 (unless (equal (org-entry-get nil prop) val)
15044 (org-entry-put nil prop val))
15045 (save-excursion
15046 (org-back-to-heading t)
15047 (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
15048 (when (string= heading org-clock-current-task)
15049 (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
15050 (org-clock-update-mode-line))
15051 (message "%s is now %s" prop val)))
15053 (defun org-at-property-p ()
15054 "Is cursor inside a property drawer?"
15055 (save-excursion
15056 (beginning-of-line 1)
15058 (save-match-data ;; Used by calling procedures
15059 (let ((p (point))
15060 (range (unless (org-before-first-heading-p)
15061 (org-get-property-block))))
15062 (and range (<= (car range) p) (< p (cdr range))))))))
15064 (defun org-get-property-block (&optional beg end force)
15065 "Return the (beg . end) range of the body of the property drawer.
15066 BEG and END are the beginning and end of the current subtree, or of
15067 the part before the first headline. If they are not given, they will
15068 be found. If the drawer does not exist and FORCE is non-nil, create
15069 the drawer."
15070 (catch 'exit
15071 (save-excursion
15072 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
15073 (progn (org-back-to-heading t) (point))))
15074 (end (or end (and (not (outline-next-heading)) (point-max))
15075 (point))))
15076 (goto-char beg)
15077 (if (re-search-forward org-property-start-re end t)
15078 (setq beg (1+ (match-end 0)))
15079 (if force
15080 (save-excursion
15081 (org-insert-property-drawer)
15082 (setq end (progn (outline-next-heading) (point))))
15083 (throw 'exit nil))
15084 (goto-char beg)
15085 (if (re-search-forward org-property-start-re end t)
15086 (setq beg (1+ (match-end 0)))))
15087 (if (re-search-forward org-property-end-re end t)
15088 (setq end (match-beginning 0))
15089 (or force (throw 'exit nil))
15090 (goto-char beg)
15091 (setq end beg)
15092 (org-indent-line)
15094 (cons beg end)))))
15096 (defun org-entry-properties (&optional pom which specific)
15097 "Get all properties of the entry at point-or-marker POM.
15098 This includes the TODO keyword, the tags, time strings for deadline,
15099 scheduled, and clocking, and any additional properties defined in the
15100 entry. The return value is an alist, keys may occur multiple times
15101 if the property key was used several times.
15102 POM may also be nil, in which case the current entry is used.
15103 If WHICH is nil or `all', get all properties. If WHICH is
15104 `special' or `standard', only get that subclass. If WHICH
15105 is a string only get exactly this property. SPECIFIC can be a string, the
15106 specific property we are interested in. Specifying it can speed
15107 things up because then unnecessary parsing is avoided."
15108 (setq which (or which 'all))
15109 (org-with-point-at pom
15110 (let ((clockstr (substring org-clock-string 0 -1))
15111 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
15112 (case-fold-search nil)
15113 beg end range props sum-props key key1 value string clocksum clocksumt)
15114 (save-excursion
15115 (when (condition-case nil
15116 (and (derived-mode-p 'org-mode) (org-back-to-heading t))
15117 (error nil))
15118 (setq beg (point))
15119 (setq sum-props (get-text-property (point) 'org-summaries))
15120 (setq clocksum (get-text-property (point) :org-clock-minutes)
15121 clocksumt (get-text-property (point) :org-clock-minutes-today))
15122 (outline-next-heading)
15123 (setq end (point))
15124 (when (memq which '(all special))
15125 ;; Get the special properties, like TODO and tags
15126 (goto-char beg)
15127 (when (and (or (not specific) (string= specific "TODO"))
15128 (looking-at org-todo-line-regexp) (match-end 2))
15129 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15130 (when (and (or (not specific) (string= specific "PRIORITY"))
15131 (looking-at org-priority-regexp))
15132 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15133 (when (or (not specific) (string= specific "FILE"))
15134 (push (cons "FILE" buffer-file-name) props))
15135 (when (and (or (not specific) (string= specific "TAGS"))
15136 (setq value (org-get-tags-string))
15138 (push (cons "TAGS" value) props))
15139 (when (and (or (not specific) (string= specific "ALLTAGS"))
15140 (setq value (org-get-tags-at)))
15141 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
15142 ":"))
15143 props))
15144 (when (or (not specific) (string= specific "BLOCKED"))
15145 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
15146 (when (or (not specific)
15147 (member specific
15148 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
15149 "TIMESTAMP" "TIMESTAMP_IA")))
15150 (catch 'match
15151 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15152 (setq key (if (match-end 1)
15153 (substring (org-match-string-no-properties 1)
15154 0 -1))
15155 string (if (equal key clockstr)
15156 (org-trim
15157 (buffer-substring-no-properties
15158 (match-beginning 3) (goto-char
15159 (point-at-eol))))
15160 (substring (org-match-string-no-properties 3)
15161 1 -1)))
15162 ;; Get the correct property name from the key. This is
15163 ;; necessary if the user has configured time keywords.
15164 (setq key1 (concat key ":"))
15165 (cond
15166 ((not key)
15167 (setq key
15168 (if (= (char-after (match-beginning 3)) ?\[)
15169 "TIMESTAMP_IA" "TIMESTAMP")))
15170 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
15171 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
15172 ((equal key1 org-closed-string) (setq key "CLOSED"))
15173 ((equal key1 org-clock-string) (setq key "CLOCK")))
15174 (if (and specific (equal key specific) (not (equal key "CLOCK")))
15175 (progn
15176 (push (cons key string) props)
15177 ;; no need to search further if match is found
15178 (throw 'match t))
15179 (when (or (equal key "CLOCK") (not (assoc key props)))
15180 (push (cons key string) props)))))))
15182 (when (memq which '(all standard))
15183 ;; Get the standard properties, like :PROP: ...
15184 (setq range (org-get-property-block beg end))
15185 (when range
15186 (goto-char (car range))
15187 (while (re-search-forward
15189 (cdr range) t)
15190 (setq key (org-match-string-no-properties 1)
15191 value (org-trim (or (org-match-string-no-properties 2) "")))
15192 (unless (member key excluded)
15193 (push (cons key (or value "")) props)))))
15194 (if clocksum
15195 (push (cons "CLOCKSUM"
15196 (org-columns-number-to-string (/ (float clocksum) 60.)
15197 'add_times))
15198 props))
15199 (if clocksumt
15200 (push (cons "CLOCKSUM_T"
15201 (org-columns-number-to-string (/ (float clocksumt) 60.)
15202 'add_times))
15203 props))
15204 (unless (assoc "CATEGORY" props)
15205 (push (cons "CATEGORY" (org-get-category)) props))
15206 (append sum-props (nreverse props)))))))
15208 (defun org-entry-get (pom property &optional inherit literal-nil)
15209 "Get value of PROPERTY for entry or content at point-or-marker POM.
15210 If INHERIT is non-nil and the entry does not have the property,
15211 then also check higher levels of the hierarchy.
15212 If INHERIT is the symbol `selective', use inheritance only if the setting
15213 in `org-use-property-inheritance' selects PROPERTY for inheritance.
15214 If the property is present but empty, the return value is the empty string.
15215 If the property is not present at all, nil is returned.
15218 do not interpret it as the list atom nil. This is used for inheritance
15220 (org-with-point-at pom
15221 (if (and inherit (if (eq inherit 'selective)
15222 (org-property-inherit-p property)
15223 t))
15224 (org-entry-get-with-inheritance property literal-nil)
15225 (if (member property org-special-properties)
15226 ;; We need a special property. Use `org-entry-properties' to
15227 ;; retrieve it, but specify the wanted property
15228 (cdr (assoc property (org-entry-properties nil 'special property)))
15229 (let ((range (org-get-property-block)))
15230 (when (and range (not (eq (car range) (cdr range))))
15231 (let* ((props (list (or (assoc property org-file-properties)
15232 (assoc property org-global-properties)
15233 (assoc property org-global-properties-fixed))))
15234 (ap (lambda (key)
15235 (when (re-search-forward
15236 (org-re-property key) (cdr range) t)
15237 (setq props
15238 (org-update-property-plist
15239 key
15240 (if (match-end 1)
15241 (org-match-string-no-properties 1) "")
15242 props)))))
15243 val)
15244 (goto-char (car range))
15245 (funcall ap property)
15246 (goto-char (car range))
15247 (while (funcall ap (concat property "+")))
15248 (setq val (cdr (assoc property props)))
15249 (when val (if literal-nil val (org-not-nil val))))))))))
15251 (defun org-property-or-variable-value (var &optional inherit)
15252 "Check if there is a property fixing the value of VAR.
15253 If yes, return this value. If not, return the current value of the variable."
15254 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15256 (read prop)
15257 (symbol-value var))))
15259 (defun org-entry-delete (pom property &optional delete-empty-drawer)
15260 "Delete the property PROPERTY from entry at point-or-marker POM.
15261 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15262 an empty drawer to delete."
15263 (org-with-point-at pom
15264 (if (member property org-special-properties)
15265 nil ; cannot delete these properties.
15266 (let ((range (org-get-property-block)))
15267 (if (and range
15268 (goto-char (car range))
15269 (re-search-forward
15270 (org-re-property property)
15271 (cdr range) t))
15272 (progn
15273 (delete-region (match-beginning 0) (1+ (point-at-eol)))
15274 (and delete-empty-drawer
15275 (org-remove-empty-drawer-at
15276 delete-empty-drawer (car range)))
15277 t)
15278 nil)))))
15280 ;; Multi-values properties are properties that contain multiple values
15281 ;; These values are assumed to be single words, separated by whitespace.
15282 (defun org-entry-add-to-multivalued-property (pom property value)
15283 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15284 (let* ((old (org-entry-get pom property))
15286 (setq value (org-entry-protect-space value))
15287 (unless (member value values)
15288 (setq values (append values (list value)))
15289 (org-entry-put pom property
15290 (mapconcat 'identity values " ")))))
15292 (defun org-entry-remove-from-multivalued-property (pom property value)
15293 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15294 (let* ((old (org-entry-get pom property))
15296 (setq value (org-entry-protect-space value))
15297 (when (member value values)
15298 (setq values (delete value values))
15299 (org-entry-put pom property
15300 (mapconcat 'identity values " ")))))
15302 (defun org-entry-member-in-multivalued-property (pom property value)
15303 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15304 (let* ((old (org-entry-get pom property))
15306 (setq value (org-entry-protect-space value))
15307 (member value values)))
15309 (defun org-entry-get-multivalued-property (pom property)
15310 "Return a list of values in a multivalued property."
15311 (let* ((value (org-entry-get pom property))
15313 (mapcar 'org-entry-restore-space values)))
15315 (defun org-entry-put-multivalued-property (pom property &rest values)
15316 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15317 VALUES should be a list of strings. Spaces will be protected."
15318 (org-entry-put pom property
15319 (mapconcat 'org-entry-protect-space values " "))
15320 (let* ((value (org-entry-get pom property))
15322 (mapcar 'org-entry-restore-space values)))
15324 (defun org-entry-protect-space (s)
15325 "Protect spaces and newline in string S."
15326 (while (string-match " " s)
15327 (setq s (replace-match "%20" t t s)))
15329 (setq s (replace-match "%0A" t t s)))
15330 s)
15332 (defun org-entry-restore-space (s)
15333 "Restore spaces and newline in string S."
15334 (while (string-match "%20" s)
15335 (setq s (replace-match " " t t s)))
15336 (while (string-match "%0A" s)
15338 s)
15340 (defvar org-entry-property-inherited-from (make-marker)
15341 "Marker pointing to the entry from where a property was inherited.
15342 Each call to `org-entry-get-with-inheritance' will set this marker to the
15343 location of the entry where the inheritance search matched. If there was
15344 no match, the marker will point nowhere.
15345 Note that also `org-entry-get' calls this function, if the INHERIT flag
15346 is set.")
15348 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15349 "Get PROPERTY of entry or content at point, search higher levels if needed.
15350 The search will stop at the first ancestor which has the property defined.
15352 should be considered as undefined (this is the meaning of nil here).
15354 (move-marker org-entry-property-inherited-from nil)
15355 (let (tmp)
15356 (save-excursion
15357 (save-restriction
15358 (widen)
15359 (catch 'ex
15360 (while t
15361 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
15362 (or (ignore-errors (org-back-to-heading t))
15363 (goto-char (point-min)))
15364 (move-marker org-entry-property-inherited-from (point))
15365 (throw 'ex tmp))
15366 (or (ignore-errors (org-up-heading-safe))
15367 (throw 'ex nil))))))
15368 (setq tmp (or tmp
15369 (cdr (assoc property org-file-properties))
15370 (cdr (assoc property org-global-properties))
15371 (cdr (assoc property org-global-properties-fixed))))
15372 (if literal-nil tmp (org-not-nil tmp))))
15374 (defvar org-property-changed-functions nil
15375 "Hook called when the value of a property has changed.
15376 Each hook function should accept two arguments, the name of the property
15377 and the new value.")
15379 (defun org-entry-put (pom property value)
15380 "Set PROPERTY to VALUE for entry at point-or-marker POM."
15381 (org-with-point-at pom
15382 (org-back-to-heading t)
15383 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15384 range)
15385 (cond
15386 ((equal property "TODO")
15388 (not (member value org-todo-keywords-1)))
15390 (if (or (not value)
15392 (setq value 'none))
15393 (org-todo value)
15394 (org-set-tags nil 'align))
15395 ((equal property "PRIORITY")
15397 (string-to-char value) ?\ ))
15398 (org-set-tags nil 'align))
15399 ((equal property "CLOCKSUM")
15400 (if (not (re-search-forward
15402 (error "Cannot find a clock log")
15403 (goto-char (- (match-end 1) 2))
15404 (cond
15405 ((eq value 'earlier) (org-timestamp-down))
15406 ((eq value 'later) (org-timestamp-up)))
15407 (org-clock-sum-current-item)))
15408 ((equal property "SCHEDULED")
15409 (if (re-search-forward org-scheduled-time-regexp end t)
15410 (cond
15411 ((eq value 'earlier) (org-timestamp-change -1 'day))
15412 ((eq value 'later) (org-timestamp-change 1 'day))
15413 (t (call-interactively 'org-schedule)))
15414 (call-interactively 'org-schedule)))
15415 ((equal property "DEADLINE")
15416 (if (re-search-forward org-deadline-time-regexp end t)
15417 (cond
15418 ((eq value 'earlier) (org-timestamp-change -1 'day))
15419 ((eq value 'later) (org-timestamp-change 1 'day))
15420 (t (call-interactively 'org-deadline)))
15421 (call-interactively 'org-deadline)))
15422 ((member property org-special-properties)
15423 (error "The %s property can not yet be set with `org-entry-put'"
15424 property))
15425 (t ; a non-special property
15426 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15427 (setq range (org-get-property-block beg end 'force))
15428 (goto-char (car range))
15429 (if (re-search-forward
15430 (org-re-property-keyword property) (cdr range) t)
15431 (progn
15432 (delete-region (match-beginning 0) (match-end 0))
15433 (goto-char (match-beginning 0)))
15434 (goto-char (cdr range))
15436 (backward-char 1)
15437 (org-indent-line))
15438 (insert ":" property ":")
15439 (and value (insert " " value))
15440 (org-indent-line)))))
15441 (run-hook-with-args 'org-property-changed-functions property value)))
15443 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
15444 "Get all property keys in the current buffer.
15445 With INCLUDE-SPECIALS, also list the special properties that reflect things
15446 like tags and TODO state.
15447 With INCLUDE-DEFAULTS, also include properties that has special meaning
15448 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
15449 and others.
15450 With INCLUDE-COLUMNS, also include property names given in COLUMN
15451 formats in the current buffer."
15452 (let (rtn range cfmt s p)
15453 (save-excursion
15454 (save-restriction
15455 (widen)
15456 (goto-char (point-min))
15457 (while (re-search-forward org-property-start-re nil t)
15458 (setq range (org-get-property-block))
15459 (goto-char (car range))
15460 (while (re-search-forward
15462 (cdr range) t)
15463 (add-to-list 'rtn (org-match-string-no-properties 1)))
15464 (outline-next-heading))))
15466 (when include-specials
15467 (setq rtn (append org-special-properties rtn)))
15469 (when include-defaults
15470 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
15471 (add-to-list 'rtn org-effort-property))
15473 (when include-columns
15474 (save-excursion
15475 (save-restriction
15476 (widen)
15477 (goto-char (point-min))
15478 (while (re-search-forward
15480 nil t)
15481 (setq cfmt (match-string 2) s 0)
15483 cfmt s)
15484 (setq s (match-end 0)
15485 p (match-string 1 cfmt))
15486 (unless (or (equal p "ITEM")
15487 (member p org-special-properties))
15488 (add-to-list 'rtn (match-string 1 cfmt))))))))
15490 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15492 (defun org-property-values (key)
15493 "Return a list of all values of property KEY in the current buffer."
15494 (save-excursion
15495 (save-restriction
15496 (widen)
15497 (goto-char (point-min))
15498 (let ((re (org-re-property key))
15499 values)
15500 (while (re-search-forward re nil t)
15501 (add-to-list 'values (org-trim (match-string 1))))
15502 (delete "" values)))))
15504 (defun org-insert-property-drawer ()
15505 "Insert a property drawer into the current entry."
15506 (org-back-to-heading t)
15507 (looking-at org-outline-regexp)
15508 (let ((indent (if org-adapt-indentation
15509 (- (match-end 0) (match-beginning 0))
15510 0))
15511 (beg (point))
15513 end hiddenp)
15514 (outline-next-heading)
15515 (setq end (point))
15516 (goto-char beg)
15517 (while (re-search-forward re end t))
15518 (setq hiddenp (outline-invisible-p))
15519 (end-of-line 1)
15522 (if (member (match-string 1) '("CLOCK:" ":END:"))
15523 ;; just skip this line
15524 (beginning-of-line 2)
15525 ;; Drawer start, find the end
15527 (beginning-of-line 1)))
15528 (org-skip-over-state-notes)
15530 (if (eq (char-before) ?*) (forward-char 1))
15532 (beginning-of-line 0)
15533 (org-indent-to-column indent)
15534 (beginning-of-line 2)
15535 (org-indent-to-column indent)
15536 (beginning-of-line 0)
15537 (if hiddenp
15538 (save-excursion
15539 (org-back-to-heading t)
15540 (hide-entry))
15541 (org-flag-drawer t))))
15543 (defun org-insert-drawer (&optional arg drawer)
15544 "Insert a drawer at point.
15546 Optional argument DRAWER, when non-nil, is a string representing
15547 drawer's name. Otherwise, the user is prompted for a name.
15549 If a region is active, insert the drawer around that region
15550 instead.
15552 Point is left between drawer's boundaries."
15553 (interactive "P")
15554 (let* ((logbook (if (stringp org-log-into-drawer) org-log-into-drawer
15555 "LOGBOOK"))
15556 ;; SYSTEM-DRAWERS is a list of drawer names that are used
15557 ;; internally by Org. They are meant to be inserted
15558 ;; automatically.
15559 (system-drawers `("CLOCK" ,logbook "PROPERTIES"))
15560 ;; Remove system drawers from list. Note: For some reason,
15561 ;; `org-completing-read' ignores the predicate while
15562 ;; `completing-read' handles it fine.
15563 (drawer (if arg "PROPERTIES"
15564 (or drawer
15565 (completing-read
15566 "Drawer: " org-drawers
15567 (lambda (d) (not (member d system-drawers))))))))
15568 (cond
15569 ;; With C-u, fall back on `org-insert-property-drawer'
15570 (arg (org-insert-property-drawer))
15571 ;; With an active region, insert a drawer at point.
15572 ((not (org-region-active-p))
15573 (progn
15576 (forward-line -2)))
15577 ;; Otherwise, insert the drawer at point
15578 (t
15579 (let ((rbeg (region-beginning))
15580 (rend (copy-marker (region-end))))
15581 (unwind-protect
15582 (progn
15583 (goto-char rbeg)
15584 (beginning-of-line)
15585 (when (save-excursion
15586 (re-search-forward org-outline-regexp-bol rend t))
15587 (error "Drawers cannot contain headlines"))
15588 ;; Position point at the beginning of the first
15589 ;; non-blank line in region. Insert drawer's opening
15590 ;; there, then indent it.
15591 (org-skip-whitespace)
15592 (beginning-of-line)
15594 (forward-line -1)
15595 (indent-for-tab-command)
15596 ;; Move point to the beginning of the first blank line
15597 ;; after the last non-blank line in region. Insert
15598 ;; drawer's closing, then indent it.
15599 (goto-char rend)
15602 (deactivate-mark t)
15603 (indent-for-tab-command)
15605 ;; Clear marker, whatever the outcome of insertion is.
15606 (set-marker rend nil)))))))
15608 (defvar org-property-set-functions-alist nil
15609 "Property set function alist.
15610 Each entry should have the following format:
15612 (PROPERTY . READ-FUNCTION)
15614 The read function will be called with the same argument as
15615 `org-completing-read'.")
15617 (defun org-set-property-function (property)
15618 "Get the function that should be used to set PROPERTY.
15619 This is computed according to `org-property-set-functions-alist'."
15620 (or (cdr (assoc property org-property-set-functions-alist))
15621 'org-completing-read))
15623 (defun org-read-property-value (property)
15624 "Read PROPERTY value from user."
15625 (let* ((completion-ignore-case t)
15626 (allowed (org-property-get-allowed-values nil property 'table))
15627 (cur (org-entry-get nil property))
15628 (prompt (concat property " value"
15630 (concat " [" cur "]") "") ": "))
15631 (set-function (org-set-property-function property))
15632 (val (if allowed
15633 (funcall set-function prompt allowed nil
15634 (not (get-text-property 0 'org-unrestricted
15635 (caar allowed))))
15636 (let (org-completion-use-ido org-completion-use-iswitchb)
15637 (funcall set-function prompt
15638 (mapcar 'list (org-property-values property))
15639 nil nil "" nil cur)))))
15640 (if (equal val "")
15641 cur
15642 val)))
15644 (defvar org-last-set-property nil)
15645 (defvar org-last-set-property-value nil)
15646 (defun org-read-property-name ()
15647 "Read a property name."
15648 (let* ((completion-ignore-case t)
15649 (keys (org-buffer-property-keys nil t t))
15650 (default-prop (or (save-excursion
15651 (save-match-data
15652 (beginning-of-line)
15654 (null (string= (match-string 1) "END"))
15655 (match-string 1))))
15656 org-last-set-property))
15657 (property (org-icompleting-read
15658 (concat "Property"
15659 (if default-prop (concat " [" default-prop "]") "")
15660 ": ")
15661 (mapcar 'list keys)
15662 nil nil nil nil
15663 default-prop)))
15664 (if (member property keys)
15665 property
15666 (or (cdr (assoc (downcase property)
15667 (mapcar (lambda (x) (cons (downcase x) x))
15668 keys)))
15669 property))))
15671 (defun org-set-property-and-value (use-last)
15672 "Allow to set [PROPERTY]: [value] direction from prompt.
15673 When use-default, don't even ask, just use the last
15675 (interactive "P")
15676 (let* ((completion-ignore-case t)
15677 (pv (or (and use-last org-last-set-property-value)
15678 (org-completing-read
15680 nil nil nil nil nil
15681 org-last-set-property-value)))
15682 prop val)
15684 (setq prop (match-string 1 pv)
15685 val (match-string 2 pv))
15686 (org-set-property prop val))))
15688 (defun org-set-property (property value)
15689 "In the current entry, set PROPERTY to VALUE.
15690 When called interactively, this will prompt for a property name, offering
15691 completion on existing and default properties. And then it will prompt
15692 for a value, offering completion either on allowed values (via an inherited
15693 xxx_ALL property) or on existing values in other instances of this property
15694 in the current file."
15695 (interactive (list nil nil))
15696 (let* ((property (or property (org-read-property-name)))
15697 (value (or value (org-read-property-value property)))
15698 (fn (cdr (assoc property org-properties-postprocess-alist))))
15699 (setq org-last-set-property property)
15700 (setq org-last-set-property-value (concat property ": " value))
15701 ;; Possibly postprocess the inserted value:
15702 (when fn (setq value (funcall fn value)))
15703 (unless (equal (org-entry-get nil property) value)
15704 (org-entry-put nil property value))))
15706 (defun org-delete-property (property &optional delete-empty-drawer)
15707 "In the current entry, delete PROPERTY.
15708 When optional argument DELETE-EMPTY-DRAWER is a string, it defines
15709 an empty drawer to delete."
15710 (interactive
15711 (let* ((completion-ignore-case t)
15712 (prop (org-icompleting-read "Property: "
15713 (org-entry-properties nil 'standard))))
15714 (list prop)))
15715 (message "Property %s %s" property
15716 (if (org-entry-delete nil property delete-empty-drawer)
15717 "deleted"
15718 "was not present in the entry")))
15720 (defun org-delete-property-globally (property)
15721 "Remove PROPERTY globally, from all entries."
15722 (interactive
15723 (let* ((completion-ignore-case t)
15724 (prop (org-icompleting-read
15725 "Globally remove property: "
15726 (mapcar 'list (org-buffer-property-keys)))))
15727 (list prop)))
15728 (save-excursion
15729 (save-restriction
15730 (widen)
15731 (goto-char (point-min))
15732 (let ((cnt 0))
15733 (while (re-search-forward
15734 (org-re-property property)
15735 nil t)
15736 (setq cnt (1+ cnt))
15737 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15740 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15742 (defun org-compute-property-at-point ()
15743 "Compute the property at point.
15744 This looks for an enclosing column format, extracts the operator and
15745 then applies it to the property in the column format's scope."
15746 (interactive)
15747 (unless (org-at-property-p)
15748 (error "Not at a property"))
15749 (let ((prop (org-match-string-no-properties 2)))
15750 (org-columns-get-format-and-top-level)
15751 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15752 (error "No operator defined for property %s" prop))
15753 (org-columns-compute prop)))
15755 (defvar org-property-allowed-value-functions nil
15756 "Hook for functions supplying allowed values for a specific property.
15757 The functions must take a single argument, the name of the property, and
15759 the values, this means that these values are intended as defaults for
15760 completion, but that other values should be allowed too.
15761 The functions must return nil if they are not responsible for this
15762 property.")
15764 (defun org-property-get-allowed-values (pom property &optional table)
15765 "Get allowed values for the property PROPERTY.
15766 When TABLE is non-nil, return an alist that can directly be used for
15767 completion."
15768 (let (vals)
15769 (cond
15770 ((equal property "TODO")
15771 (setq vals (org-with-point-at pom
15772 (append org-todo-keywords-1 '("")))))
15773 ((equal property "PRIORITY")
15774 (let ((n org-lowest-priority))
15775 (while (>= n org-highest-priority)
15776 (push (char-to-string n) vals)
15777 (setq n (1- n)))))
15778 ((member property org-special-properties))
15779 ((setq vals (run-hook-with-args-until-success
15780 'org-property-allowed-value-functions property)))
15781 (t
15782 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15784 (setq vals (car (read-from-string (concat "(" vals ")"))))
15785 (setq vals (mapcar (lambda (x)
15786 (cond ((stringp x) x)
15787 ((numberp x) (number-to-string x))
15788 ((symbolp x) (symbol-name x))
15789 (t "???")))
15790 vals)))))
15791 (when (member ":ETC" vals)
15792 (setq vals (remove ":ETC" vals))
15793 (org-add-props (car vals) '(org-unrestricted t)))
15794 (if table (mapcar 'list vals) vals)))
15796 (defun org-property-previous-allowed-value (&optional previous)
15797 "Switch to the next allowed value for this property."
15798 (interactive)
15799 (org-property-next-allowed-value t))
15801 (defun org-property-next-allowed-value (&optional previous)
15802 "Switch to the next allowed value for this property."
15803 (interactive)
15804 (unless (org-at-property-p)
15805 (error "Not at a property"))
15806 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
15807 (key (match-string 2))
15808 (value (match-string 3))
15809 (allowed (or (org-property-get-allowed-values (point) key)
15810 (and (member value '("[ ]" "[-]" "[X]"))
15811 '("[ ]" "[X]"))))
15812 (heading (save-match-data (nth 4 (org-heading-components))))
15813 nval)
15814 (unless allowed
15815 (error "Allowed values for this property have not been defined"))
15816 (if previous (setq allowed (reverse allowed)))
15817 (if (member value allowed)
15818 (setq nval (car (cdr (member value allowed)))))
15819 (setq nval (or nval (car allowed)))
15820 (if (equal nval value)
15821 (error "Only one allowed value for this property"))
15822 (org-at-property-p)
15823 (replace-match (concat " :" key ": " nval) t t)
15824 (org-indent-line)
15825 (beginning-of-line 1)
15827 (when (equal prop org-effort-property)
15828 (save-excursion
15829 (org-back-to-heading t)
15830 (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
15831 (when (string= org-clock-current-task heading)
15832 (setq org-clock-effort nval)
15833 (org-clock-update-mode-line)))
15834 (run-hook-with-args 'org-property-changed-functions key nval)))
15836 (defun org-find-olp (path &optional this-buffer)
15837 "Return a marker pointing to the entry at outline path OLP.
15838 If anything goes wrong, throw an error.
15839 You can wrap this call to catch the error like this:
15841 (condition-case msg
15842 (org-mobile-locate-entry (match-string 4))
15843 (error (nth 1 msg)))
15845 The return value will then be either a string with the error message,
15846 or a marker if everything is OK.
15848 If THIS-BUFFER is set, the outline path does not contain a file,
15849 only headings."
15850 (let* ((file (if this-buffer buffer-file-name (pop path)))
15851 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
15852 (level 1)
15853 (lmin 1)
15854 (lmax 1)
15855 limit re end found pos heading cnt flevel)
15856 (unless buffer (error "File not found :%s" file))
15857 (with-current-buffer buffer
15858 (save-excursion
15859 (save-restriction
15860 (widen)
15861 (setq limit (point-max))
15862 (goto-char (point-min))
15863 (while (setq heading (pop path))
15864 (setq re (format org-complex-heading-regexp-format
15865 (regexp-quote heading)))
15866 (setq cnt 0 pos (point))
15867 (while (re-search-forward re end t)
15868 (setq level (- (match-end 1) (match-beginning 1)))
15869 (if (and (>= level lmin) (<= level lmax))
15870 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
15871 (when (= cnt 0) (error "Heading not found on level %d: %s"
15872 lmax heading))
15873 (when (> cnt 1) (error "Heading not unique on level %d: %s"
15874 lmax heading))
15875 (goto-char found)
15876 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
15877 (setq end (save-excursion (org-end-of-subtree t t))))
15878 (when (org-at-heading-p)
15879 (point-marker)))))))
15881 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
15882 "Find node HEADING in BUFFER.
15883 Return a marker to the heading if it was found, or nil if not.
15884 If POS-ONLY is set, return just the position instead of a marker.
15886 The heading text must match exact, but it may have a TODO keyword,
15887 a priority cookie and tags in the standard locations."
15888 (with-current-buffer (or buffer (current-buffer))
15889 (save-excursion
15890 (save-restriction
15891 (widen)
15892 (goto-char (point-min))
15893 (let (case-fold-search)
15894 (if (re-search-forward
15895 (format org-complex-heading-regexp-format
15896 (regexp-quote heading)) nil t)
15897 (if pos-only
15898 (match-beginning 0)
15899 (move-marker (make-marker) (match-beginning 0)))))))))
15901 (defun org-find-exact-heading-in-directory (heading &optional dir)
15902 "Find Org node headline HEADING in all .org files in directory DIR.
15903 When the target headline is found, return a marker to this location."
15904 (let ((files (directory-files (or dir default-directory)
15906 file visiting m buffer)
15907 (catch 'found
15908 (while (setq file (pop files))
15909 (message "trying %s" file)
15910 (setq visiting (org-find-base-buffer-visiting file))
15911 (setq buffer (or visiting (find-file-noselect file)))
15912 (setq m (org-find-exact-headline-in-buffer
15913 heading buffer))
15914 (when (and (not m) (not visiting)) (kill-buffer buffer))
15915 (and m (throw 'found m))))))
15917 (defun org-find-entry-with-id (ident)
15918 "Locate the entry that contains the ID property with exact value IDENT.
15919 IDENT can be a string, a symbol or a number, this function will search for
15920 the string representation of it.
15921 Return the position where this entry starts, or nil if there is no such entry."
15922 (interactive "sID: ")
15923 (let ((id (cond
15924 ((stringp ident) ident)
15925 ((symbol-name ident) (symbol-name ident))
15926 ((numberp ident) (number-to-string ident))
15927 (t (error "IDENT %s must be a string, symbol or number" ident))))
15928 (case-fold-search nil))
15929 (save-excursion
15930 (save-restriction
15931 (widen)
15932 (goto-char (point-min))
15933 (when (re-search-forward
15935 nil t)
15936 (org-back-to-heading t)
15937 (point))))))
15939 ;;;; Timestamps
15941 (defvar org-last-changed-timestamp nil)
15942 (defvar org-last-inserted-timestamp nil
15943 "The last time stamp inserted with `org-insert-time-stamp'.")
15944 (defvar org-time-was-given) ; dynamically scoped parameter
15945 (defvar org-end-time-was-given) ; dynamically scoped parameter
15946 (defvar org-ts-what) ; dynamically scoped parameter
15948 (defun org-time-stamp (arg &optional inactive)
15949 "Prompt for a date/time and insert a time stamp.
15950 If the user specifies a time like HH:MM or if this command is
15951 called with at least one prefix argument, the time stamp contains
15952 the date and the time. Otherwise, only the date is be included.
15954 All parts of a date not specified by the user is filled in from
15955 the current date/time. So if you just press return without
15956 typing anything, the time stamp will represent the current
15957 date/time.
15959 If there is already a timestamp at the cursor, it will be
15960 modified.
15962 With two universal prefix arguments, insert an active timestamp
15963 with the current time without prompting the user."
15964 (interactive "P")
15965 (let* ((ts nil)
15966 (default-time
15967 ;; Default time is either today, or, when entering a range,
15968 ;; the range start.
15969 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
15970 (save-excursion
15971 (re-search-backward
15973 (- (point) 20) t)))
15974 (apply 'encode-time (org-parse-time-string (match-string 1)))
15975 (current-time)))
15976 (default-input (and ts (org-get-compact-tod ts)))
15977 (repeater (save-excursion
15978 (save-match-data
15979 (beginning-of-line)
15980 (when (re-search-forward
15982 (save-excursion (progn (end-of-line) (point))) t)
15983 (match-string 0)))))
15984 org-time-was-given org-end-time-was-given time)
15985 (cond
15986 ((and (org-at-timestamp-p t)
15987 (memq last-command '(org-time-stamp org-time-stamp-inactive))
15988 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
15989 (insert "--")
15990 (setq time (let ((this-command this-command))
15991 (org-read-date arg 'totime nil nil
15992 default-time default-input inactive)))
15993 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
15994 ((org-at-timestamp-p t)
15995 (setq time (let ((this-command this-command))
15996 (org-read-date arg 'totime nil nil default-time default-input inactive)))
15997 (when (org-at-timestamp-p t) ; just to get the match data
15998 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
15999 (replace-match "")
16000 (setq org-last-changed-timestamp
16001 (org-insert-time-stamp
16002 time (or org-time-was-given arg)
16003 inactive nil nil (list org-end-time-was-given)))
16004 (when repeater (goto-char (1- (point))) (insert " " repeater)
16005 (setq org-last-changed-timestamp
16006 (concat (substring org-last-inserted-timestamp 0 -1)
16007 " " repeater ">"))))
16008 (message "Timestamp updated"))
16009 ((equal arg '(16))
16010 (org-insert-time-stamp (current-time) t))
16011 (t
16012 (setq time (let ((this-command this-command))
16013 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16014 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16015 nil nil (list org-end-time-was-given))))))
16017 ;; FIXME: can we use this for something else, like computing time differences?
16018 (defun org-get-compact-tod (s)
16019 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16020 (let* ((t1 (match-string 1 s))
16021 (h1 (string-to-number (match-string 2 s)))
16022 (m1 (string-to-number (match-string 3 s)))
16023 (t2 (and (match-end 4) (match-string 5 s)))
16024 (h2 (and t2 (string-to-number (match-string 6 s))))
16025 (m2 (and t2 (string-to-number (match-string 7 s))))
16026 dh dm)
16027 (if (not t2)
16028 t1
16029 (setq dh (- h2 h1) dm (- m2 m1))
16030 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16031 (concat t1 "+" (number-to-string dh)
16032 (if (/= 0 dm) (concat ":" (number-to-string dm))))))))
16034 (defun org-time-stamp-inactive (&optional arg)
16035 "Insert an inactive time stamp.
16036 An inactive time stamp is enclosed in square brackets instead of angle
16037 brackets. It is inactive in the sense that it does not trigger agenda entries,
16038 does not link to the calendar and cannot be changed with the S-cursor keys.
16039 So these are more for recording a certain time/date."
16040 (interactive "P")
16041 (org-time-stamp arg 'inactive))
16043 (defvar org-date-ovl (make-overlay 1 1))
16044 (overlay-put org-date-ovl 'face 'org-date-selected)
16045 (org-detach-overlay org-date-ovl)
16047 (defvar org-ans1) ; dynamically scoped parameter
16048 (defvar org-ans2) ; dynamically scoped parameter
16050 (defvar org-plain-time-of-day-regexp) ; defined below
16052 (defvar org-overriding-default-time nil) ; dynamically scoped
16053 (defvar org-read-date-overlay nil)
16054 (defvar org-dcst nil) ; dynamically scoped
16055 (defvar org-read-date-history nil)
16056 (defvar org-read-date-final-answer nil)
16057 (defvar org-read-date-analyze-futurep nil)
16058 (defvar org-read-date-analyze-forced-year nil)
16059 (defvar org-read-date-inactive)
16061 (defvar org-read-date-minibuffer-local-map
16062 (let ((map (make-sparse-keymap)))
16063 (set-keymap-parent map minibuffer-local-map)
16064 (org-defkey map (kbd ".")
16065 (lambda () (interactive)
16066 (org-eval-in-calendar '(calendar-goto-today))))
16067 (org-defkey map [(meta shift left)]
16068 (lambda () (interactive)
16069 (org-eval-in-calendar '(calendar-backward-month 1))))
16070 (org-defkey map [(meta shift right)]
16071 (lambda () (interactive)
16072 (org-eval-in-calendar '(calendar-forward-month 1))))
16073 (org-defkey map [(meta shift up)]
16074 (lambda () (interactive)
16075 (org-eval-in-calendar '(calendar-backward-year 1))))
16076 (org-defkey map [(meta shift down)]
16077 (lambda () (interactive)
16078 (org-eval-in-calendar '(calendar-forward-year 1))))
16079 (org-defkey map [?\e (shift left)]
16080 (lambda () (interactive)
16081 (org-eval-in-calendar '(calendar-backward-month 1))))
16082 (org-defkey map [?\e (shift right)]
16083 (lambda () (interactive)
16084 (org-eval-in-calendar '(calendar-forward-month 1))))
16085 (org-defkey map [?\e (shift up)]
16086 (lambda () (interactive)
16087 (org-eval-in-calendar '(calendar-backward-year 1))))
16088 (org-defkey map [?\e (shift down)]
16089 (lambda () (interactive)
16090 (org-eval-in-calendar '(calendar-forward-year 1))))
16091 (org-defkey map [(shift up)]
16092 (lambda () (interactive)
16093 (org-eval-in-calendar '(calendar-backward-week 1))))
16094 (org-defkey map [(shift down)]
16095 (lambda () (interactive)
16096 (org-eval-in-calendar '(calendar-forward-week 1))))
16097 (org-defkey map [(shift left)]
16098 (lambda () (interactive)
16099 (org-eval-in-calendar '(calendar-backward-day 1))))
16100 (org-defkey map [(shift right)]
16101 (lambda () (interactive)
16102 (org-eval-in-calendar '(calendar-forward-day 1))))
16103 (org-defkey map "!"
16104 (lambda () (interactive)
16105 (org-eval-in-calendar '(diary-view-entries))
16106 (message "")))
16107 (org-defkey map ">"
16108 (lambda () (interactive)
16109 (org-eval-in-calendar '(scroll-calendar-left 1))))
16110 (org-defkey map "<"
16111 (lambda () (interactive)
16112 (org-eval-in-calendar '(scroll-calendar-right 1))))
16113 (org-defkey map "\C-v"
16114 (lambda () (interactive)
16115 (org-eval-in-calendar
16116 '(calendar-scroll-left-three-months 1))))
16117 (org-defkey map "\M-v"
16118 (lambda () (interactive)
16119 (org-eval-in-calendar
16120 '(calendar-scroll-right-three-months 1))))
16121 map)
16122 "Keymap for minibuffer commands when using `org-read-date'.")
16124 (defun org-read-date (&optional org-with-time to-time from-string prompt
16125 default-time default-input inactive)
16126 "Read a date, possibly a time, and make things smooth for the user.
16127 The prompt will suggest to enter an ISO date, but you can also enter anything
16128 which will at least partially be understood by `parse-time-string'.
16129 Unrecognized parts of the date will default to the current day, month, year,
16130 hour and minute. If this command is called to replace a timestamp at point,
16131 or to enter the second timestamp of a range, the default time is taken
16132 from the existing stamp. Furthermore, the command prefers the future,
16133 so if you are giving a date where the year is not given, and the day-month
16134 combination is already past in the current year, it will assume you
16135 mean next year. For details, see the manual. A few examples:
16137 3-2-5 --> 2003-02-05
16138 feb 15 --> currentyear-02-15
16139 2/15 --> currentyear-02-15
16140 sep 12 9 --> 2009-09-12
16141 12:45 --> today 12:45
16142 22 sept 0:34 --> currentyear-09-22 0:34
16143 12 --> currentyear-currentmonth-12
16144 Fri --> nearest Friday after today
16145 -Tue --> last Tuesday
16146 etc.
16148 Furthermore you can specify a relative date by giving, as the *first* thing
16149 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16150 change in days weeks, months, years.
16151 With a single plus or minus, the date is relative to today. With a double
16152 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16153 +4d --> four days from today
16154 +4 --> same as above
16155 +2w --> two weeks from today
16156 ++5 --> five days from default date
16158 The function understands only English month and weekday abbreviations.
16160 While prompting, a calendar is popped up - you can also select the
16161 date with the mouse (button 1). The calendar shows a period of three
16162 months. To scroll it to other months, use the keys `>' and `<'.
16163 If you don't like the calendar, turn it off with
16164 \(setq org-read-date-popup-calendar nil)
16166 With optional argument TO-TIME, the date will immediately be converted
16167 to an internal time.
16168 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16169 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16170 still enter a time, and this function will inform the calling routine
16171 about this change. The calling routine may then choose to change the
16172 format used to insert the time stamp into the buffer to include the time.
16173 With optional argument FROM-STRING, read from this string instead from
16174 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16175 the time/date that is used for everything that is not specified by the
16176 user."
16177 (require 'parse-time)
16178 (let* ((org-time-stamp-rounding-minutes
16179 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16180 (org-dcst org-display-custom-times)
16181 (ct (org-current-time))
16182 (org-def (or org-overriding-default-time default-time ct))
16183 (org-defdecode (decode-time org-def))
16184 (dummy (progn
16185 (when (< (nth 2 org-defdecode) org-extend-today-until)
16186 (setcar (nthcdr 2 org-defdecode) -1)
16187 (setcar (nthcdr 1 org-defdecode) 59)
16188 (setq org-def (apply 'encode-time org-defdecode)
16189 org-defdecode (decode-time org-def)))))
16190 (mouse-autoselect-window nil) ; Don't let the mouse jump
16191 (calendar-frame-setup nil)
16192 (calendar-setup nil)
16193 (calendar-move-hook nil)
16194 (calendar-view-diary-initially-flag nil)
16195 (calendar-view-holidays-initially-flag nil)
16196 (timestr (format-time-string
16197 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16198 (prompt (concat (if prompt (concat prompt " ") "")
16199 (format "Date+time [%s]: " timestr)))
16200 ans (org-ans0 "") org-ans1 org-ans2 final)
16202 (cond
16203 (from-string (setq ans from-string))
16204 (org-read-date-popup-calendar
16205 (save-excursion
16206 (save-window-excursion
16207 (calendar)
16208 (org-eval-in-calendar '(setq cursor-type nil) t)
16209 (unwind-protect
16210 (progn
16211 (calendar-forward-day (- (time-to-days org-def)
16212 (calendar-absolute-from-gregorian
16213 (calendar-current-date))))
16214 (org-eval-in-calendar nil t)
16215 (let* ((old-map (current-local-map))
16216 (map (copy-keymap calendar-mode-map))
16217 (minibuffer-local-map
16218 (copy-keymap org-read-date-minibuffer-local-map)))
16219 (org-defkey map (kbd "RET") 'org-calendar-select)
16220 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16221 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16222 (unwind-protect
16223 (progn
16224 (use-local-map map)
16225 (setq org-read-date-inactive inactive)
16226 (add-hook 'post-command-hook 'org-read-date-display)
16227 (setq org-ans0 (read-string prompt default-input
16228 'org-read-date-history nil))
16229 ;; org-ans0: from prompt
16230 ;; org-ans1: from mouse click
16231 ;; org-ans2: from calendar motion
16232 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16233 (remove-hook 'post-command-hook 'org-read-date-display)
16234 (use-local-map old-map)
16235 (when org-read-date-overlay
16236 (delete-overlay org-read-date-overlay)
16237 (setq org-read-date-overlay nil)))))
16238 (bury-buffer "*Calendar*")))))
16240 (t ; Naked prompt only
16241 (unwind-protect
16242 (setq ans (read-string prompt default-input
16243 'org-read-date-history timestr))
16244 (when org-read-date-overlay
16245 (delete-overlay org-read-date-overlay)
16246 (setq org-read-date-overlay nil)))))
16248 (setq final (org-read-date-analyze ans org-def org-defdecode))
16250 (when org-read-date-analyze-forced-year
16251 (message "Year was forced into %s"
16252 (if org-read-date-force-compatible-dates
16253 "compatible range (1970-2037)"
16254 "range representable on this machine"))
16255 (ding))
16257 ;; One round trip to get rid of 34th of August and stuff like that....
16258 (setq final (decode-time (apply 'encode-time final)))
16260 (setq org-read-date-final-answer ans)
16262 (if to-time
16263 (apply 'encode-time final)
16264 (if (and (boundp 'org-time-was-given) org-time-was-given)
16265 (format "%04d-%02d-%02d %02d:%02d"
16266 (nth 5 final) (nth 4 final) (nth 3 final)
16267 (nth 2 final) (nth 1 final))
16268 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16270 (defvar org-def)
16271 (defvar org-defdecode)
16272 (defvar org-with-time)
16273 (defun org-read-date-display ()
16274 "Display the current date prompt interpretation in the minibuffer."
16275 (when org-read-date-display-live
16276 (when org-read-date-overlay
16277 (delete-overlay org-read-date-overlay))
16278 (when (minibufferp (current-buffer))
16279 (save-excursion
16280 (end-of-line 1)
16281 (while (not (equal (buffer-substring
16282 (max (point-min) (- (point) 4)) (point))
16283 " "))
16284 (insert " ")))
16285 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16286 " " (or org-ans1 org-ans2)))
16287 (org-end-time-was-given nil)
16288 (f (org-read-date-analyze ans org-def org-defdecode))
16289 (fmts (if org-dcst
16290 org-time-stamp-custom-formats
16291 org-time-stamp-formats))
16292 (fmt (if (or org-with-time
16293 (and (boundp 'org-time-was-given) org-time-was-given))
16294 (cdr fmts)
16295 (car fmts)))
16296 (txt (format-time-string fmt (apply 'encode-time f)))
16297 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16298 (txt (concat "=> " txt)))
16299 (when (and org-end-time-was-given
16300 (string-match org-plain-time-of-day-regexp txt))
16301 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16302 org-end-time-was-given
16303 (substring txt (match-end 0)))))
16304 (when org-read-date-analyze-futurep
16305 (setq txt (concat txt " (=>F)")))
16306 (setq org-read-date-overlay
16307 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16308 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16310 (defun org-read-date-analyze (ans org-def org-defdecode)
16311 "Analyze the combined answer of the date prompt."
16312 ;; FIXME: cleanup and comment
16313 (let ((nowdecode (decode-time (current-time)))
16314 delta deltan deltaw deltadef year month day
16315 hour minute second wday pm h2 m2 tl wday1
16316 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16317 (setq org-read-date-analyze-futurep nil
16318 org-read-date-analyze-forced-year nil)
16320 (setq ans "+0"))
16322 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16323 (setq ans (replace-match "" t t ans)
16324 deltan (car delta)
16325 deltaw (nth 1 delta)
16326 deltadef (nth 2 delta)))
16328 ;; Check if there is an iso week date in there. If yes, store the
16329 ;; info and postpone interpreting it until the rest of the parsing
16330 ;; is done.
16331 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16332 (setq iso-year (if (match-end 1)
16333 (org-small-year-to-year
16334 (string-to-number (match-string 1 ans))))
16335 iso-weekday (if (match-end 3)
16336 (string-to-number (match-string 3 ans)))
16337 iso-week (string-to-number (match-string 2 ans)))
16338 (setq ans (replace-match "" t t ans)))
16340 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16341 (when (string-match
16343 (setq year (if (match-end 2)
16344 (string-to-number (match-string 2 ans))
16345 (progn (setq kill-year t)
16346 (string-to-number (format-time-string "%Y"))))
16347 month (string-to-number (match-string 3 ans))
16348 day (string-to-number (match-string 4 ans)))
16349 (if (< year 100) (setq year (+ 2000 year)))
16351 t nil ans)))
16353 ;; Help matching dotted european dates
16354 (when (string-match
16355 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16356 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16357 (setq kill-year t)
16358 (string-to-number (format-time-string "%Y")))
16359 day (string-to-number (match-string 1 ans))
16360 month (string-to-number (match-string 2 ans))
16361 ans (replace-match (format "%04d-%02d-%02d" year month day)
16362 t nil ans)))
16364 ;; Help matching american dates, like 5/30 or 5/30/7
16365 (when (string-match
16366 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16367 (setq year (if (match-end 4)
16368 (string-to-number (match-string 4 ans))
16369 (progn (setq kill-year t)
16370 (string-to-number (format-time-string "%Y"))))
16371 month (string-to-number (match-string 1 ans))
16372 day (string-to-number (match-string 2 ans)))
16373 (if (< year 100) (setq year (+ 2000 year)))
16375 t nil ans)))
16376 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16377 ;; If there is a time with am/pm, and *no* time without it, we convert
16378 ;; so that matching will be successful.
16379 (loop for i from 1 to 2 do ; twice, for end time as well
16382 (setq hour (string-to-number (match-string 1 ans))
16383 minute (if (match-end 3)
16384 (string-to-number (match-string 3 ans))
16385 0)
16386 pm (equal ?p
16387 (string-to-char (downcase (match-string 4 ans)))))
16388 (if (and (= hour 12) (not pm))
16389 (setq hour 0)
16390 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16391 (setq ans (replace-match (format "%02d:%02d" hour minute)
16392 t t ans))))
16394 ;; Check if a time range is given as a duration
16395 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16396 (setq hour (string-to-number (match-string 1 ans))
16397 h2 (+ hour (string-to-number (match-string 3 ans)))
16398 minute (string-to-number (match-string 2 ans))
16399 m2 (+ minute (if (match-end 5) (string-to-number
16400 (match-string 5 ans))0)))
16401 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16402 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16403 t t ans)))
16405 ;; Check if there is a time range
16406 (when (boundp 'org-end-time-was-given)
16407 (setq org-time-was-given nil)
16408 (when (and (string-match org-plain-time-of-day-regexp ans)
16409 (match-end 8))
16410 (setq org-end-time-was-given (match-string 8 ans))
16411 (setq ans (concat (substring ans 0 (match-beginning 7))
16412 (substring ans (match-end 7))))))
16414 (setq tl (parse-time-string ans)
16415 day (or (nth 3 tl) (nth 3 org-defdecode))
16416 month (or (nth 4 tl)
16417 (if (and org-read-date-prefer-future
16418 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16419 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16420 (nth 4 org-defdecode)))
16421 year (or (and (not kill-year) (nth 5 tl))
16422 (if (and org-read-date-prefer-future
16423 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16424 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16425 (nth 5 org-defdecode)))
16426 hour (or (nth 2 tl) (nth 2 org-defdecode))
16427 minute (or (nth 1 tl) (nth 1 org-defdecode))
16428 second (or (nth 0 tl) 0)
16429 wday (nth 6 tl))
16431 (when (and (eq org-read-date-prefer-future 'time)
16432 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16433 (equal day (nth 3 nowdecode))
16434 (equal month (nth 4 nowdecode))
16435 (equal year (nth 5 nowdecode))
16436 (nth 2 tl)
16437 (or (< (nth 2 tl) (nth 2 nowdecode))
16438 (and (= (nth 2 tl) (nth 2 nowdecode))
16439 (nth 1 tl)
16440 (< (nth 1 tl) (nth 1 nowdecode)))))
16441 (setq day (1+ day)
16442 futurep t))
16444 ;; Special date definitions below
16445 (cond
16446 (iso-week
16447 ;; There was an iso week
16448 (require 'cal-iso)
16449 (setq futurep nil)
16450 (setq year (or iso-year year)
16451 day (or iso-weekday wday 1)
16452 wday nil ; to make sure that the trigger below does not match
16453 iso-date (calendar-gregorian-from-absolute
16454 (calendar-absolute-from-iso
16455 (list iso-week day year))))
16456 ; FIXME: Should we also push ISO weeks into the future?
16457 ; (when (and org-read-date-prefer-future
16458 ; (not iso-year)
16459 ; (< (calendar-absolute-from-gregorian iso-date)
16460 ; (time-to-days (current-time))))
16461 ; (setq year (1+ year)
16462 ; iso-date (calendar-gregorian-from-absolute
16463 ; (calendar-absolute-from-iso
16464 ; (list iso-week day year)))))
16465 (setq month (car iso-date)
16466 year (nth 2 iso-date)
16467 day (nth 1 iso-date)))
16468 (deltan
16469 (setq futurep nil)
16470 (unless deltadef
16471 (let ((now (decode-time (current-time))))
16472 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16473 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16474 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16475 ((equal deltaw "m") (setq month (+ month deltan)))
16476 ((equal deltaw "y") (setq year (+ year deltan)))))
16477 ((and wday (not (nth 3 tl)))
16478 ;; Weekday was given, but no day, so pick that day in the week
16479 ;; on or after the derived date.
16480 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
16481 (unless (equal wday wday1)
16482 (setq day (+ day (% (- wday wday1 -7) 7))))))
16483 (if (and (boundp 'org-time-was-given)
16484 (nth 2 tl))
16485 (setq org-time-was-given t))
16486 (if (< year 100) (setq year (+ 2000 year)))
16487 ;; Check of the date is representable
16488 (if org-read-date-force-compatible-dates
16489 (progn
16490 (if (< year 1970)
16491 (setq year 1970 org-read-date-analyze-forced-year t))
16492 (if (> year 2037)
16493 (setq year 2037 org-read-date-analyze-forced-year t)))
16494 (condition-case nil
16495 (ignore (encode-time second minute hour day month year))
16496 (error
16497 (setq year (nth 5 org-defdecode))
16498 (setq org-read-date-analyze-forced-year t))))
16499 (setq org-read-date-analyze-futurep futurep)
16500 (list second minute hour day month year)))
16502 (defvar parse-time-weekdays)
16503 (defun org-read-date-get-relative (s today default)
16504 "Check string S for special relative date string.
16505 TODAY and DEFAULT are internal times, for today and for a default.
16506 Return shift list (N what def-flag)
16508 N is the number of WHATs to shift.
16509 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16510 the DEFAULT date rather than TODAY."
16511 (require 'parse-time)
16512 (when (and
16513 (string-match
16514 (concat
16519 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
16520 (let* ((dir (if (> (match-end 1) (match-beginning 1))
16521 (string-to-char (substring (match-string 1 s) -1))
16522 ?+))
16523 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
16524 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
16525 (what (if (match-end 3) (match-string 3 s) "d"))
16526 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
16527 (date (if rel default today))
16528 (wday (nth 6 (decode-time date)))
16529 delta)
16530 (if wday1
16531 (progn
16532 (setq delta (mod (+ 7 (- wday1 wday)) 7))
16533 (if (= delta 0) (setq delta 7))
16534 (if (= dir ?-)
16535 (progn
16536 (setq delta (- delta 7))
16537 (if (= delta 0) (setq delta -7))
16538 ))
16539 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
16540 (list delta "d" rel))
16541 (list (* n (if (= dir ?-) -1 1)) what rel)))))
16543 (defun org-order-calendar-date-args (arg1 arg2 arg3)
16544 "Turn a user-specified date into the internal representation.
16545 The internal representation needed by the calendar is (month day year).
16546 This is a wrapper to handle the brain-dead convention in calendar that
16547 user function argument order change dependent on argument order."
16548 (if (boundp 'calendar-date-style)
16549 (cond
16550 ((eq calendar-date-style 'american)
16551 (list arg1 arg2 arg3))
16552 ((eq calendar-date-style 'european)
16553 (list arg2 arg1 arg3))
16554 ((eq calendar-date-style 'iso)
16555 (list arg2 arg3 arg1)))
16556 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
16557 (if (org-bound-and-true-p european-calendar-style)
16558 (list arg2 arg1 arg3)
16559 (list arg1 arg2 arg3)))))
16561 (defun org-eval-in-calendar (form &optional keepdate)
16562 "Eval FORM in the calendar window and return to current window.
16563 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
16564 otherwise stick to the current value of `org-ans2'."
16565 (let ((sf (selected-frame))
16566 (sw (selected-window)))
16567 (select-window (get-buffer-window "*Calendar*" t))
16568 (eval form)
16569 (when (and (not keepdate) (calendar-cursor-to-date))
16570 (let* ((date (calendar-cursor-to-date))
16571 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16572 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
16573 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
16574 (select-window sw)
16575 (org-select-frame-set-input-focus sf)))
16577 (defun org-calendar-select ()
16578 "Return to `org-read-date' with the date currently selected.
16579 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16580 (interactive)
16581 (when (calendar-cursor-to-date)
16582 (let* ((date (calendar-cursor-to-date))
16583 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16584 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16585 (if (active-minibuffer-window) (exit-minibuffer))))
16587 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
16588 "Insert a date stamp for the date given by the internal TIME.
16589 WITH-HM means use the stamp format that includes the time of the day.
16590 INACTIVE means use square brackets instead of angular ones, so that the
16591 stamp will not contribute to the agenda.
16592 PRE and POST are optional strings to be inserted before and after the
16593 stamp.
16594 The command returns the inserted time stamp."
16595 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
16596 stamp)
16597 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
16598 (insert-before-markers (or pre ""))
16599 (when (listp extra)
16600 (setq extra (car extra))
16601 (if (and (stringp extra)
16603 (setq extra (format "-%02d:%02d"
16604 (string-to-number (match-string 1 extra))
16605 (string-to-number (match-string 2 extra))))
16606 (setq extra nil)))
16607 (when extra
16608 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
16609 (insert-before-markers (setq stamp (format-time-string fmt time)))
16610 (insert-before-markers (or post ""))
16611 (setq org-last-inserted-timestamp stamp)))
16613 (defun org-toggle-time-stamp-overlays ()
16614 "Toggle the use of custom time stamp formats."
16615 (interactive)
16616 (setq org-display-custom-times (not org-display-custom-times))
16617 (unless org-display-custom-times
16618 (let ((p (point-min)) (bmp (buffer-modified-p)))
16619 (while (setq p (next-single-property-change p 'display))
16620 (if (and (get-text-property p 'display)
16621 (eq (get-text-property p 'face) 'org-date))
16622 (remove-text-properties
16623 p (setq p (next-single-property-change p 'display))
16624 '(display t))))
16625 (set-buffer-modified-p bmp)))
16626 (if (featurep 'xemacs)
16627 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
16628 (org-restart-font-lock)
16629 (setq org-table-may-need-update t)
16630 (if org-display-custom-times
16631 (message "Time stamps are overlaid with custom format")
16632 (message "Time stamp overlays removed")))
16634 (defun org-display-custom-time (beg end)
16635 "Overlay modified time stamp format over timestamp between BEG and END."
16636 (let* ((ts (buffer-substring beg end))
16637 t1 w1 with-hm tf time str w2 (off 0))
16638 (save-match-data
16639 (setq t1 (org-parse-time-string ts t))
16640 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
16641 (setq off (- (match-end 0) (match-beginning 0)))))
16642 (setq end (- end off))
16643 (setq w1 (- end beg)
16644 with-hm (and (nth 1 t1) (nth 2 t1))
16645 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
16646 time (org-fix-decoded-time t1)
16647 str (org-add-props
16648 (format-time-string
16649 (substring tf 1 -1) (apply 'encode-time time))
16650 nil 'mouse-face 'highlight)
16651 w2 (length str))
16652 (if (not (= w2 w1))
16653 (add-text-properties (1+ beg) (+ 2 beg)
16654 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
16655 (if (featurep 'xemacs)
16656 (progn
16657 (put-text-property beg end 'invisible t)
16658 (put-text-property beg end 'end-glyph (make-glyph str)))
16659 (put-text-property beg end 'display str))))
16661 (defun org-translate-time (string)
16662 "Translate all timestamps in STRING to custom format.
16663 But do this only if the variable `org-display-custom-times' is set."
16664 (when org-display-custom-times
16665 (save-match-data
16666 (let* ((start 0)
16667 (re org-ts-regexp-both)
16668 t1 with-hm inactive tf time str beg end)
16669 (while (setq start (string-match re string start))
16670 (setq beg (match-beginning 0)
16671 end (match-end 0)
16672 t1 (save-match-data
16673 (org-parse-time-string (substring string beg end) t))
16674 with-hm (and (nth 1 t1) (nth 2 t1))
16675 inactive (equal (substring string beg (1+ beg)) "[")
16676 tf (funcall (if with-hm 'cdr 'car)
16677 org-time-stamp-custom-formats)
16678 time (org-fix-decoded-time t1)
16679 str (format-time-string
16680 (concat
16681 (if inactive "[" "<") (substring tf 1 -1)
16682 (if inactive "]" ">"))
16683 (apply 'encode-time time))
16684 string (replace-match str t t string)
16685 start (+ start (length str)))))))
16686 string)
16688 (defun org-fix-decoded-time (time)
16689 "Set 0 instead of nil for the first 6 elements of time.
16690 Don't touch the rest."
16691 (let ((n 0))
16692 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
16694 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
16696 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
16697 "Difference between TIMESTAMP-STRING and now in days.
16698 If SECONDS is non-nil, return the difference in seconds."
16699 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
16700 (- (funcall fdiff (org-time-string-to-time timestamp-string))
16701 (funcall fdiff (current-time)))))
16703 (defun org-deadline-close (timestamp-string &optional ndays)
16704 "Is the time in TIMESTAMP-STRING close to the current date?"
16705 (setq ndays (or ndays (org-get-wdays timestamp-string)))
16706 (and (< (org-time-stamp-to-now timestamp-string) ndays)
16707 (not (org-entry-is-done-p))))
16709 (defun org-get-wdays (ts &optional delay zero-delay)
16710 "Get the deadline lead time appropriate for timestring TS.
16711 When DELAY is non-nil, get the delay time for scheduled items
16712 instead of the deadline lead time. When ZERO-DELAY is non-nil
16713 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
16714 don't try to find the delay cookie in the scheduled timestamp."
16715 (let ((tv (if delay org-scheduled-delay-days
16716 org-deadline-warning-days)))
16717 (cond
16718 ((or (and delay (< tv 0))
16719 (and delay zero-delay (<= tv 0))
16720 (and (not delay) (<= tv 0)))
16721 ;; Enforce this value no matter what
16722 (- tv))
16724 ;; lead time is specified.
16725 (floor (* (string-to-number (match-string 1 ts))
16726 (cdr (assoc (match-string 2 ts)
16727 '(("d" . 1) ("w" . 7)
16728 ("m" . 30.4) ("y" . 365.25)
16729 ("h" . 0.041667)))))))
16730 ;; go for the default.
16731 (t tv))))
16733 (defun org-calendar-select-mouse (ev)
16734 "Return to `org-read-date' with the date currently selected.
16735 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16736 (interactive "e")
16737 (mouse-set-point ev)
16738 (when (calendar-cursor-to-date)
16739 (let* ((date (calendar-cursor-to-date))
16740 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16741 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16742 (if (active-minibuffer-window) (exit-minibuffer))))
16744 (defun org-check-deadlines (ndays)
16745 "Check if there are any deadlines due or past due.
16746 A deadline is considered due if it happens within `org-deadline-warning-days'
16747 days from today's date. If the deadline appears in an entry marked DONE,
16748 it is not shown. The prefix arg NDAYS can be used to test that many
16750 (interactive "P")
16751 (let* ((org-warn-days
16752 (cond
16753 ((equal ndays '(4)) 100000)
16754 (ndays (prefix-numeric-value ndays))
16755 (t (abs org-deadline-warning-days))))
16756 (case-fold-search nil)
16758 (callback
16759 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16761 (message "%d deadlines past-due or due within %d days"
16762 (org-occur regexp nil callback)
16763 org-warn-days)))
16765 (defsubst org-re-timestamp (type)
16766 "Return a regexp for timestamp TYPE.
16767 Allowed values for TYPE are:
16769 all: all timestamps
16770 active: only active timestamps (<...>)
16771 inactive: only inactive timestamps ([...])
16772 scheduled: only scheduled timestamps
16773 deadline: only deadline timestamps
16774 closed: only closed time-stamps
16776 When TYPE is nil, fall back on returning a regexp that matches
16777 both scheduled and deadline timestamps."
16778 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9>
\n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16779 ((eq type 'active) org-ts-regexp)
16783 ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^
\n>]*?\\)\\]"))
16784 ((eq type 'scheduled-or-deadline)
16787 (defun org-check-before-date (date)
16788 "Check if there are deadlines or scheduled entries before DATE."
16789 (interactive (list (org-read-date)))
16790 (let ((case-fold-search nil)
16791 (regexp (org-re-timestamp org-ts-type))
16792 (callback
16793 (lambda () (time-less-p
16794 (org-time-string-to-time (match-string 1))
16795 (org-time-string-to-time date)))))
16796 (message "%d entries before %s"
16797 (org-occur regexp nil callback) date)))
16799 (defun org-check-after-date (date)
16800 "Check if there are deadlines or scheduled entries after DATE."
16801 (interactive (list (org-read-date)))
16802 (let ((case-fold-search nil)
16803 (regexp (org-re-timestamp org-ts-type))
16804 (callback
16805 (lambda () (not
16806 (time-less-p
16807 (org-time-string-to-time (match-string 1))
16808 (org-time-string-to-time date))))))
16809 (message "%d entries after %s"
16810 (org-occur regexp nil callback) date)))
16812 (defun org-check-dates-range (start-date end-date)
16813 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
16814 (interactive (list (org-read-date nil nil nil "Range starts")
16815 (org-read-date nil nil nil "Range end")))
16816 (let ((case-fold-search nil)
16817 (regexp (org-re-timestamp org-ts-type))
16818 (callback
16819 (lambda ()
16820 (let ((match (match-string 1)))
16821 (and
16822 (not (time-less-p
16823 (org-time-string-to-time match)
16824 (org-time-string-to-time start-date)))
16825 (time-less-p
16826 (org-time-string-to-time match)
16827 (org-time-string-to-time end-date)))))))
16828 (message "%d entries between %s and %s"
16829 (org-occur regexp nil callback) start-date end-date)))
16831 (defun org-evaluate-time-range (&optional to-buffer)
16832 "Evaluate a time range by computing the difference between start and end.
16833 Normally the result is just printed in the echo area, but with prefix arg
16834 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
16835 If the time range is actually in a table, the result is inserted into the
16836 next column.
16837 For time difference computation, a year is assumed to be exactly 365
16838 days in order to avoid rounding problems."
16839 (interactive "P")
16840 (or
16841 (org-clock-update-time-maybe)
16842 (save-excursion
16843 (unless (org-at-date-range-p t)
16844 (goto-char (point-at-bol))
16845 (re-search-forward org-tr-regexp-both (point-at-eol) t))
16846 (if (not (org-at-date-range-p t))
16847 (error "Not at a time-stamp range, and none found in current line")))
16848 (let* ((ts1 (match-string 1))
16849 (ts2 (match-string 2))
16850 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
16851 (match-end (match-end 0))
16852 (time1 (org-time-string-to-time ts1))
16853 (time2 (org-time-string-to-time ts2))
16854 (t1 (org-float-time time1))
16855 (t2 (org-float-time time2))
16856 (diff (abs (- t2 t1)))
16857 (negative (< (- t2 t1) 0))
16858 ;; (ys (floor (* 365 24 60 60)))
16859 (ds (* 24 60 60))
16860 (hs (* 60 60))
16861 (fy "%dy %dd %02d:%02d")
16862 (fy1 "%dy %dd")
16863 (fd "%dd %02d:%02d")
16864 (fd1 "%dd")
16865 (fh "%02d:%02d")
16866 y d h m align)
16867 (if havetime
16868 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16869 y 0
16870 d (floor (/ diff ds)) diff (mod diff ds)
16871 h (floor (/ diff hs)) diff (mod diff hs)
16872 m (floor (/ diff 60)))
16873 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
16874 y 0
16875 d (floor (+ (/ diff ds) 0.5))
16876 h 0 m 0))
16877 (if (not to-buffer)
16878 (message "%s" (org-make-tdiff-string y d h m))
16879 (if (org-at-table-p)
16880 (progn
16881 (goto-char match-end)
16882 (setq align t)
16883 (and (looking-at " *|") (goto-char (match-end 0))))
16884 (goto-char match-end))
16885 (if (looking-at
16887 (replace-match ""))
16888 (if negative (insert " -"))
16889 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
16890 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
16891 (insert " " (format fh h m))))
16892 (if align (org-table-align))
16893 (message "Time difference inserted")))))
16895 (defun org-make-tdiff-string (y d h m)
16896 (let ((fmt "")
16897 (l nil))
16898 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
16899 l (push y l)))
16900 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
16901 l (push d l)))
16902 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
16903 l (push h l)))
16904 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
16905 l (push m l)))
16906 (apply 'format fmt (nreverse l))))
16908 (defun org-time-string-to-time (s &optional buffer pos)
16909 "Convert a timestamp string into internal time."
16910 (condition-case errdata
16911 (apply 'encode-time (org-parse-time-string s))
16913 s (if (not (and buffer pos))
16914 ""
16915 (format " at %d in buffer `%s'" pos buffer))
16916 (cdr errdata)))))
16918 (defun org-time-string-to-seconds (s)
16919 "Convert a timestamp string to a number of seconds."
16920 (org-float-time (org-time-string-to-time s)))
16922 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
16923 "Convert a time stamp to an absolute day number.
16924 If there is a specifier for a cyclic time stamp, get the closest
16925 date to DAYNR.
16926 PREFER and SHOW-ALL are passed through to `org-closest-date'.
16927 The variable `date' is bound by the calendar when this is called."
16928 (cond
16930 (if (org-diary-sexp-entry (match-string 1 s) "" date)
16931 daynr
16932 (+ daynr 1000)))
16934 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
16935 (time-to-days (current-time))) (match-string 0 s)
16936 prefer show-all))
16937 (t (time-to-days
16938 (condition-case errdata
16939 (apply 'encode-time (org-parse-time-string s))
16941 s (if (not (and buffer pos))
16942 ""
16943 (format " at %d in buffer `%s'" pos buffer))
16944 (cdr errdata))))))))
16946 (defun org-days-to-iso-week (days)
16947 "Return the iso week number."
16948 (require 'cal-iso)
16949 (car (calendar-iso-from-absolute days)))
16951 (defun org-small-year-to-year (year)
16952 "Convert 2-digit years into 4-digit years.
16953 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2007.
16954 The year 2000 cannot be abbreviated. Any year larger than 99
16955 is returned unchanged."
16956 (if (< year 38)
16957 (setq year (+ 2000 year))
16958 (if (< year 100)
16959 (setq year (+ 1900 year))))
16960 year)
16962 (defun org-time-from-absolute (d)
16963 "Return the time corresponding to date D.
16964 D may be an absolute day number, or a calendar-type list (month day year)."
16965 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
16966 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
16968 (defun org-calendar-holiday ()
16969 "List of holidays, for Diary display in Org-mode."
16970 (require 'holidays)
16971 (let ((hl (funcall
16972 (if (fboundp 'calendar-check-holidays)
16973 'calendar-check-holidays 'check-calendar-holidays) date)))
16974 (if hl (mapconcat 'identity hl "; "))))
16976 (defun org-diary-sexp-entry (sexp entry date)
16977 "Process a SEXP diary ENTRY for DATE."
16978 (require 'diary-lib)
16979 (let ((result (if calendar-debug-sexp
16980 (let ((stack-trace-on-error t))
16981 (eval (car (read-from-string sexp))))
16982 (condition-case nil
16983 (eval (car (read-from-string sexp)))
16984 (error
16985 (beep)
16986 (message "Bad sexp at line %d in %s: %s"
16987 (org-current-line)
16988 (buffer-file-name) sexp)
16989 (sleep-for 2))))))
16990 (cond ((stringp result) (split-string result "; "))
16991 ((and (consp result)
16992 (not (consp (cdr result)))
16993 (stringp (cdr result))) (cdr result))
16994 ((and (consp result)
16995 (stringp (car result))) result)
16996 (result entry))))
16998 (defun org-diary-to-ical-string (frombuf)
16999 "Get iCalendar entries from diary entries in buffer FROMBUF.
17000 This uses the icalendar.el library."
17001 (let* ((tmpdir (if (featurep 'xemacs)
17002 (temp-directory)
17003 temporary-file-directory))
17004 (tmpfile (make-temp-name
17005 (expand-file-name "orgics" tmpdir)))
17006 buf rtn b e)
17007 (with-current-buffer frombuf
17008 (icalendar-export-region (point-min) (point-max) tmpfile)
17009 (setq buf (find-buffer-visiting tmpfile))
17010 (set-buffer buf)
17011 (goto-char (point-min))
17012 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17013 (setq b (match-beginning 0)))
17014 (goto-char (point-max))
17015 (if (re-search-backward "^END:VEVENT" nil t)
17016 (setq e (match-end 0)))
17018 (kill-buffer buf)
17019 (delete-file tmpfile)
17020 rtn))
17022 (defun org-closest-date (start current change prefer show-all)
17023 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17024 When PREFER is `past', return a date that is either CURRENT or past.
17025 When PREFER is `future', return a date that is either CURRENT or future.
17026 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17027 ;; Make the proper lists from the dates
17028 (catch 'exit
17029 (let ((a1 '(("h" . hour)
17030 ("d" . day)
17031 ("w" . week)
17032 ("m" . month)
17033 ("y" . year)))
17034 (shour (nth 2 (org-parse-time-string start)))
17035 dn dw sday cday n1 n2 n0
17036 d m y y1 y2 date1 date2 nmonths nm ny m2)
17038 (setq start (org-date-to-gregorian start)
17039 current (org-date-to-gregorian
17040 (if show-all
17041 current
17042 (time-to-days (current-time))))
17043 sday (calendar-absolute-from-gregorian start)
17044 cday (calendar-absolute-from-gregorian current))
17046 (if (<= cday sday) (throw 'exit sday))
17049 (setq dn (string-to-number (match-string 1 change))
17050 dw (cdr (assoc (match-string 2 change) a1)))
17051 (error "Invalid change specifier: %s" change))
17052 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17053 (cond
17054 ((eq dw 'hour)
17055 (let ((missing-hours
17056 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17057 dn)))
17058 (setq n1 (if (zerop missing-hours) cday
17059 (- cday (1+ (floor (/ missing-hours 24)))))
17060 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17061 ((eq dw 'day)
17062 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17063 n2 (+ n1 dn)))
17064 ((eq dw 'year)
17065 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17066 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17067 (setq date1 (list m d y1)
17068 n1 (calendar-absolute-from-gregorian date1)
17069 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17070 n2 (calendar-absolute-from-gregorian date2)))
17071 ((eq dw 'month)
17072 ;; approx number of month between the two dates
17073 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17074 ;; How often does dn fit in there?
17075 (setq d (nth 1 start) m (car start) y (nth 2 start)
17076 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17077 m (+ m nm)
17078 ny (floor (/ m 12))
17079 y (+ y ny)
17080 m (- m (* ny 12)))
17081 (while (> m 12) (setq m (- m 12) y (1+ y)))
17082 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17083 (setq m2 (+ m dn) y2 y)
17084 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17085 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17086 (while (<= n2 cday)
17087 (setq n1 n2 m m2 y y2)
17088 (setq m2 (+ m dn) y2 y)
17089 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17090 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17091 ;; Make sure n1 is the earlier date
17092 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17093 (if show-all
17094 (cond
17095 ((eq prefer 'past) (if (= cday n2) n2 n1))
17096 ((eq prefer 'future) (if (= cday n1) n1 n2))
17097 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17098 (cond
17099 ((eq prefer 'past) (if (= cday n2) n2 n1))
17100 ((eq prefer 'future) (if (= cday n1) n1 n2))
17101 (t (if (= cday n1) n1 n2)))))))
17103 (defun org-date-to-gregorian (date)
17104 "Turn any specification of DATE into a Gregorian date for the calendar."
17105 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17106 ((and (listp date) (= (length date) 3)) date)
17107 ((stringp date)
17108 (setq date (org-parse-time-string date))
17109 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17110 ((listp date)
17111 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17113 (defun org-parse-time-string (s &optional nodefault)
17114 "Parse the standard Org-mode time string.
17115 This should be a lot faster than the normal `parse-time-string'.
17116 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17117 hour and minute fields will be nil if not given."
17118 (cond ((string-match org-ts-regexp0 s)
17119 (list 0
17120 (if (or (match-beginning 8) (not nodefault))
17121 (string-to-number (or (match-string 8 s) "0")))
17122 (if (or (match-beginning 7) (not nodefault))
17123 (string-to-number (or (match-string 7 s) "0")))
17124 (string-to-number (match-string 4 s))
17125 (string-to-number (match-string 3 s))
17126 (string-to-number (match-string 2 s))
17127 nil nil nil))
17128 ((string-match "^<[^>]+>$" s)
17129 (decode-time (seconds-to-time (org-matcher-time s))))
17130 (t (error "Not a standard Org-mode time string: %s" s))))
17132 (defun org-timestamp-up (&optional arg)
17133 "Increase the date item at the cursor by one.
17134 If the cursor is on the year, change the year. If it is on the month,
17135 the day or the time, change that.
17136 With prefix ARG, change by that many units."
17137 (interactive "p")
17138 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17140 (defun org-timestamp-down (&optional arg)
17141 "Decrease the date item at the cursor by one.
17142 If the cursor is on the year, change the year. If it is on the month,
17143 the day or the time, change that.
17144 With prefix ARG, change by that many units."
17145 (interactive "p")
17146 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17148 (defun org-timestamp-up-day (&optional arg)
17149 "Increase the date in the time stamp by one day.
17150 With prefix ARG, change that many days."
17151 (interactive "p")
17152 (if (and (not (org-at-timestamp-p t))
17153 (org-at-heading-p))
17154 (org-todo 'up)
17155 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17157 (defun org-timestamp-down-day (&optional arg)
17158 "Decrease the date in the time stamp by one day.
17159 With prefix ARG, change that many days."
17160 (interactive "p")
17161 (if (and (not (org-at-timestamp-p t))
17162 (org-at-heading-p))
17163 (org-todo 'down)
17164 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17166 (defun org-at-timestamp-p (&optional inactive-ok)
17167 "Determine if the cursor is in or at a timestamp."
17168 (interactive)
17169 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17170 (pos (point))
17171 (ans (or (looking-at tsr)
17172 (save-excursion
17174 (if (> (point) (point-min)) (backward-char 1))
17175 (and (looking-at tsr)
17176 (> (- (match-end 0) pos) -1))))))
17177 (and ans
17178 (boundp 'org-ts-what)
17179 (setq org-ts-what
17180 (cond
17181 ((= pos (match-beginning 0)) 'bracket)
17182 ;; Point is considered to be "on the bracket" whether
17183 ;; it's really on it or right after it.
17184 ((= pos (1- (match-end 0))) 'bracket)
17185 ((= pos (match-end 0)) 'after)
17186 ((org-pos-in-match-range pos 2) 'year)
17187 ((org-pos-in-match-range pos 3) 'month)
17188 ((org-pos-in-match-range pos 7) 'hour)
17189 ((org-pos-in-match-range pos 8) 'minute)
17190 ((or (org-pos-in-match-range pos 4)
17191 (org-pos-in-match-range pos 5)) 'day)
17192 ((and (> pos (or (match-end 8) (match-end 5)))
17193 (< pos (match-end 0)))
17194 (- pos (or (match-end 8) (match-end 5))))
17195 (t 'day))))
17196 ans))
17198 (defun org-toggle-timestamp-type ()
17199 "Toggle the type (<active> or [inactive]) of a time stamp."
17200 (interactive)
17201 (when (org-at-timestamp-p t)
17202 (let ((beg (match-beginning 0)) (end (match-end 0))
17203 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17204 (save-excursion
17205 (goto-char beg)
17206 (while (re-search-forward "[][<>]" end t)
17207 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17208 t t)))
17209 (message "Timestamp is now %sactive"
17210 (if (equal (char-after beg) ?<) "" "in")))))
17212 (defun org-at-clock-log-p nil
17213 "Is the cursor on the clock log line?"
17214 (save-excursion
17215 (move-beginning-of-line 1)
17218 (defvar org-clock-history) ; defined in org-clock.el
17219 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17220 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17221 "Change the date in the time stamp at point.
17222 The date will be changed by N times WHAT. WHAT can be `day', `month',
17223 `year', `minute', `second'. If WHAT is not given, the cursor position
17224 in the timestamp determines what will be changed.
17226 (let ((origin (point)) origin-cat
17227 with-hm inactive
17228 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17229 org-ts-what
17230 extra rem
17231 ts time time0 fixnext clrgx)
17232 (if (not (org-at-timestamp-p t))
17233 (error "Not at a timestamp"))
17234 (if (and (not what) (eq org-ts-what 'bracket))
17235 (org-toggle-timestamp-type)
17236 ;; Point isn't on brackets. Remember the part of the time-stamp
17237 ;; the point was in. Indeed, size of time-stamps may change,
17238 ;; but point must be kept in the same category nonetheless.
17239 (setq origin-cat org-ts-what)
17240 (if (and (not what) (not (eq org-ts-what 'day))
17241 org-display-custom-times
17242 (get-text-property (point) 'display)
17243 (not (get-text-property (1- (point)) 'display)))
17244 (setq org-ts-what 'day))
17245 (setq org-ts-what (or what org-ts-what)
17246 inactive (= (char-after (match-beginning 0)) ?\[)
17247 ts (match-string 0))
17248 (replace-match "")
17249 (when (string-match
17250 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17251 ts)
17252 (setq extra (match-string 1 ts))
17253 (if suppress-tmp-delay
17254 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17256 (setq with-hm t))
17257 (setq time0 (org-parse-time-string ts))
17258 (when (and updown
17259 (eq org-ts-what 'minute)
17260 (not current-prefix-arg))
17261 ;; This looks like s-up and s-down. Change by one rounding step.
17262 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17263 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17264 (setcar (cdr time0) (+ (nth 1 time0)
17265 (if (> n 0) (- rem) (- dm rem))))))
17266 (setq time
17267 (encode-time (or (car time0) 0)
17268 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17269 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17270 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17271 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17272 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17273 (nthcdr 6 time0)))
17274 (when (and (member org-ts-what '(hour minute))
17275 extra
17277 (setq extra (org-modify-ts-extra
17278 extra
17279 (if (eq org-ts-what 'hour) 2 5)
17280 n dm)))
17281 (when (integerp org-ts-what)
17282 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17283 (if (eq what 'calendar)
17284 (let ((cal-date (org-get-date-from-calendar)))
17285 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17286 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17287 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17288 (setcar time0 (or (car time0) 0))
17289 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17290 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17291 (setq time (apply 'encode-time time0))))
17292 ;; Insert the new time-stamp, and ensure point stays in the same
17293 ;; category as before (i.e. not after the last position in that
17294 ;; category).
17295 (let ((pos (point)))
17296 ;; Stay before inserted string. `save-excursion' is of no use.
17297 (setq org-last-changed-timestamp
17298 (org-insert-time-stamp time with-hm inactive nil nil extra))
17299 (goto-char pos))
17300 (save-match-data
17301 (looking-at org-ts-regexp3)
17302 (goto-char (cond
17303 ;; `day' category ends before `hour' if any, or at
17304 ;; the end of the day name.
17305 ((eq origin-cat 'day)
17306 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17307 ((eq origin-cat 'hour) (min (match-end 7) origin))
17308 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17309 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17310 ;; `year' and `month' have both fixed size: point
17311 ;; couldn't have moved into another part.
17312 (t origin))))
17313 ;; Update clock if on a CLOCK line.
17314 (org-clock-update-time-maybe)
17315 ;; Maybe adjust the closest clock in `org-clock-history'
17316 (when org-clock-adjust-closest
17317 (if (not (and (org-at-clock-log-p)
17318 (< 1 (length (delq nil (mapcar 'marker-position
17319 org-clock-history))))))
17320 (message "No clock to adjust")
17321 (cond ((save-excursion ; fix previous clock?
17322 (re-search-backward org-ts-regexp0 nil t)
17325 ((save-excursion ; fix next clock?
17326 (re-search-backward org-ts-regexp0 nil t)
17329 (save-window-excursion
17330 ;; Find closest clock to point, adjust the previous/next one in history
17331 (let* ((p (save-excursion (org-back-to-heading t)))
17332 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17333 (clfixnth
17334 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
17335 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17336 (if (not clfixpos)
17337 (message "No clock to adjust")
17338 (save-excursion
17339 (org-goto-marker-or-bmk clfixpos)
17340 (org-show-subtree)
17341 (when (re-search-forward clrgx nil t)
17342 (goto-char (match-beginning 1))
17343 (let (org-clock-adjust-closest)
17344 (org-timestamp-change n org-ts-what updown))
17345 (message "Clock adjusted in %s for heading: %s"
17346 (file-name-nondirectory (buffer-file-name))
17347 (org-get-heading t t)))))))))
17348 ;; Try to recenter the calendar window, if any.
17349 (if (and org-calendar-follow-timestamp-change
17350 (get-buffer-window "*Calendar*" t)
17351 (memq org-ts-what '(day month year)))
17352 (org-recenter-calendar (time-to-days time))))))
17354 (defun org-modify-ts-extra (s pos n dm)
17355 "Change the different parts of the lead-time and repeat fields in timestamp."
17356 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17357 ng h m new rem)
17358 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17359 (cond
17360 ((or (org-pos-in-match-range pos 2)
17361 (org-pos-in-match-range pos 3))
17362 (setq m (string-to-number (match-string 3 s))
17363 h (string-to-number (match-string 2 s)))
17364 (if (org-pos-in-match-range pos 2)
17365 (setq h (+ h n))
17366 (setq n (* dm (org-no-warnings (signum n))))
17367 (when (not (= 0 (setq rem (% m dm))))
17368 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17369 (setq m (+ m n)))
17370 (if (< m 0) (setq m (+ m 60) h (1- h)))
17371 (if (> m 59) (setq m (- m 60) h (1+ h)))
17372 (setq h (min 24 (max 0 h)))
17373 (setq ng 1 new (format "-%02d:%02d" h m)))
17374 ((org-pos-in-match-range pos 6)
17375 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17376 ((org-pos-in-match-range pos 5)
17377 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17379 ((org-pos-in-match-range pos 9)
17380 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17381 ((org-pos-in-match-range pos 8)
17382 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17384 (when ng
17385 (setq s (concat
17386 (substring s 0 (match-beginning ng))
17387 new
17388 (substring s (match-end ng))))))
17389 s))
17391 (defun org-recenter-calendar (date)
17392 "If the calendar is visible, recenter it to DATE."
17393 (let ((cwin (get-buffer-window "*Calendar*" t)))
17394 (when cwin
17395 (let ((calendar-move-hook nil))
17396 (with-selected-window cwin
17397 (calendar-goto-date (if (listp date) date
17398 (calendar-gregorian-from-absolute date))))))))
17400 (defun org-goto-calendar (&optional arg)
17401 "Go to the Emacs calendar at the current date.
17402 If there is a time stamp in the current line, go to that date.
17403 A prefix ARG can be used to force the current date."
17404 (interactive "P")
17405 (let ((tsr org-ts-regexp) diff
17406 (calendar-move-hook nil)
17407 (calendar-view-holidays-initially-flag nil)
17408 (calendar-view-diary-initially-flag nil))
17409 (if (or (org-at-timestamp-p)
17410 (save-excursion
17411 (beginning-of-line 1)
17412 (looking-at (concat ".*" tsr))))
17413 (let ((d1 (time-to-days (current-time)))
17414 (d2 (time-to-days
17415 (org-time-string-to-time (match-string 1)))))
17416 (setq diff (- d2 d1))))
17417 (calendar)
17418 (calendar-goto-today)
17419 (if (and diff (not arg)) (calendar-forward-day diff))))
17421 (defun org-get-date-from-calendar ()
17422 "Return a list (month day year) of date at point in calendar."
17423 (with-current-buffer "*Calendar*"
17424 (save-match-data
17425 (calendar-cursor-to-date))))
17427 (defun org-date-from-calendar ()
17428 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17429 If there is already a time stamp at the cursor position, update it."
17430 (interactive)
17431 (if (org-at-timestamp-p t)
17432 (org-timestamp-change 0 'calendar)
17433 (let ((cal-date (org-get-date-from-calendar)))
17434 (org-insert-time-stamp
17435 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17437 (defcustom org-effort-durations
17438 `(("h" . 60)
17439 ("d" . ,(* 60 8))
17440 ("w" . ,(* 60 8 5))
17441 ("m" . ,(* 60 8 5 4))
17442 ("y" . ,(* 60 8 5 40)))
17443 "Conversion factor to minutes for an effort modifier.
17445 Each entry has the form (MODIFIER . MINUTES).
17447 In an effort string, a number followed by MODIFIER is multiplied
17448 by the specified number of MINUTES to obtain an effort in
17449 minutes.
17453 :group 'org-agenda
17454 :version "24.1"
17455 :type '(alist :key-type (string :tag "Modifier")
17456 :value-type (number :tag "Minutes")))
17458 (defun org-minutes-to-clocksum-string (m)
17459 "Format number of minutes as a clocksum string.
17460 The format is determined by `org-time-clocksum-format',
17461 `org-time-clocksum-use-fractional' and
17462 `org-time-clocksum-fractional-format' and
17463 `org-time-clocksum-use-effort-durations'."
17464 (let ((clocksum "")
17465 (m (round m)) ; Don't allow fractions of minutes
17466 h d w mo y fmt n)
17467 (setq h (if org-time-clocksum-use-effort-durations
17468 (cdr (assoc "h" org-effort-durations)) 60)
17469 d (if org-time-clocksum-use-effort-durations
17470 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17471 w (if org-time-clocksum-use-effort-durations
17472 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17473 mo (if org-time-clocksum-use-effort-durations
17474 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17475 y (if org-time-clocksum-use-effort-durations
17476 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17477 ;; fractional format
17478 (if org-time-clocksum-use-fractional
17479 (cond
17480 ;; single format string
17481 ((stringp org-time-clocksum-fractional-format)
17482 (format org-time-clocksum-fractional-format (/ m (float h))))
17483 ;; choice of fractional formats for different time units
17484 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17485 (> (/ (truncate m) (* y d h)) 0))
17486 (format fmt (/ m (* y d (float h)))))
17487 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
17488 (> (/ (truncate m) (* mo d h)) 0))
17489 (format fmt (/ m (* mo d (float h)))))
17490 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17491 (> (/ (truncate m) (* w d h)) 0))
17492 (format fmt (/ m (* w d (float h)))))
17493 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
17494 (> (/ (truncate m) (* d h)) 0))
17495 (format fmt (/ m (* d (float h)))))
17496 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17497 (> (/ (truncate m) h) 0))
17498 (format fmt (/ m (float h))))
17499 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
17500 (format fmt m))
17501 ;; fall back to smallest time unit with a format
17502 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17503 (format fmt (/ m (float h))))
17504 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
17505 (format fmt (/ m (* d (float h)))))
17506 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17507 (format fmt (/ m (* w d (float h)))))
17508 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
17509 (format fmt (/ m (* mo d (float h)))))
17510 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
17511 (format fmt (/ m (* y d (float h))))))
17512 ;; standard (non-fractional) format, with single format string
17513 (if (stringp org-time-clocksum-format)
17514 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
17515 ;; separate formats components
17516 (and (setq fmt (plist-get org-time-clocksum-format :years))
17517 (or (> (setq n (/ (truncate m) (* y d h))) 0)
17518 (plist-get org-time-clocksum-format :require-years))
17519 (setq clocksum (concat clocksum (format fmt n))
17520 m (- m (* n y d h))))
17521 (and (setq fmt (plist-get org-time-clocksum-format :months))
17522 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
17523 (plist-get org-time-clocksum-format :require-months))
17524 (setq clocksum (concat clocksum (format fmt n))
17525 m (- m (* n mo d h))))
17526 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
17527 (or (> (setq n (/ (truncate m) (* w d h))) 0)
17528 (plist-get org-time-clocksum-format :require-weeks))
17529 (setq clocksum (concat clocksum (format fmt n))
17530 m (- m (* n w d h))))
17531 (and (setq fmt (plist-get org-time-clocksum-format :days))
17532 (or (> (setq n (/ (truncate m) (* d h))) 0)
17533 (plist-get org-time-clocksum-format :require-days))
17534 (setq clocksum (concat clocksum (format fmt n))
17535 m (- m (* n d h))))
17536 (and (setq fmt (plist-get org-time-clocksum-format :hours))
17537 (or (> (setq n (/ (truncate m) h)) 0)
17538 (plist-get org-time-clocksum-format :require-hours))
17539 (setq clocksum (concat clocksum (format fmt n))
17540 m (- m (* n h))))
17541 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
17542 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
17543 (setq clocksum (concat clocksum (format fmt m))))
17544 ;; return formatted time duration
17545 clocksum))))
17547 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
17548 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
17549 "Org mode version 8.0")
17551 (defun org-hours-to-clocksum-string (n)
17552 (org-minutes-to-clocksum-string (* n 60)))
17554 (defun org-hh:mm-string-to-minutes (s)
17555 "Convert a string H:MM to a number of minutes.
17556 If the string is just a number, interpret it as minutes.
17557 In fact, the first hh:mm or number in the string will be taken,
17558 there can be extra stuff in the string.
17559 If no number is found, the return value is 0."
17560 (cond
17561 ((integerp s) s)
17563 (+ (* (string-to-number (match-string 1 s)) 60)
17564 (string-to-number (match-string 2 s))))
17566 (string-to-number (match-string 1 s)))
17567 (t 0)))
17569 (defcustom org-image-actual-width t
17570 "Should we use the actual width of images when inlining them?
17572 When set to `t', always use the image width.
17574 When set to a number, use imagemagick (when available) to set
17575 the image's width to this value.
17577 When set to a number in a list, try to get the width from any
17578 #+ATTR.* keyword if it matches a width specification like
17580 #+ATTR_HTML: :width 300px
17582 and fall back on that number if none is found.
17584 When set to nil, try to get the width from an #+ATTR.* keyword
17585 and fall back on the original width if none is found.
17587 This requires Emacs >= 24.1, build with imagemagick support."
17588 :group 'org-appearance
17589 :version "24.4"
17590 :package-version '(Org . "8.0")
17591 :type '(choice
17592 (const :tag "Use the image width" t)
17593 (integer :tag "Use a number of pixels")
17594 (list :tag "Use #+ATTR* or a number of pixels" (integer))
17595 (const :tag "Use #+ATTR* or don't resize" nil)))
17597 (defcustom org-agenda-inhibit-startup nil
17598 "Inhibit startup when preparing agenda buffers.
17599 When this variable is `t' (the default), the initialization of
17600 the Org agenda buffers is inhibited: e.g. the visibility state
17601 is not set, the tables are not re-aligned, etc."
17602 :type 'boolean
17603 :version "24.3"
17604 :group 'org-agenda)
17606 (defun org-duration-string-to-minutes (s &optional output-to-string)
17607 "Convert a duration string S to minutes.
17609 A bare number is interpreted as minutes, modifiers can be set by
17610 customizing `org-effort-durations' (which see).
17612 Entries containing a colon are interpreted as H:MM by
17613 `org-hh:mm-string-to-minutes'."
17614 (let ((result 0)
17616 (regexp-opt (mapcar 'car org-effort-durations))
17618 (while (string-match re s)
17619 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
17620 (string-to-number (match-string 1 s))))
17621 (setq s (replace-match "" nil t s)))
17622 (setq result (floor result))
17623 (incf result (org-hh:mm-string-to-minutes s))
17624 (if output-to-string (number-to-string result) result)))
17626 ;;;; Files
17628 (defun org-save-all-org-buffers ()
17629 "Save all Org-mode buffers without user confirmation."
17630 (interactive)
17631 (message "Saving all Org-mode buffers...")
17632 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
17633 (when (featurep 'org-id) (org-id-locations-save))
17634 (message "Saving all Org-mode buffers... done"))
17636 (defun org-revert-all-org-buffers ()
17637 "Revert all Org-mode buffers.
17638 Prompt for confirmation when there are unsaved changes.
17639 Be sure you know what you are doing before letting this function
17640 overwrite your changes.
17642 This function is useful in a setup where one tracks org files
17643 with a version control system, to revert on one machine after pulling
17644 changes from another. I believe the procedure must be like this:
17646 1. M-x org-save-all-org-buffers
17647 2. Pull changes from the other machine, resolve conflicts
17648 3. M-x org-revert-all-org-buffers"
17649 (interactive)
17650 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
17651 (error "Abort"))
17652 (save-excursion
17653 (save-window-excursion
17654 (mapc
17655 (lambda (b)
17656 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
17657 (with-current-buffer b buffer-file-name))
17658 (org-pop-to-buffer-same-window b)
17659 (revert-buffer t 'no-confirm)))
17660 (buffer-list))
17661 (when (and (featurep 'org-id) org-id-track-globally)
17662 (org-id-locations-load)))))
17664 ;;;; Agenda files
17666 ;;;###autoload
17667 (defun org-switchb (&optional arg)
17668 "Switch between Org buffers.
17669 With one prefix argument, restrict available buffers to files.
17670 With two prefix arguments, restrict available buffers to agenda files.
17672 Defaults to `iswitchb' for buffer name completion.
17673 Set `org-completion-use-ido' to make it use ido instead."
17674 (interactive "P")
17675 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
17676 ((equal arg '(16)) (org-buffer-list 'agenda))
17677 (t (org-buffer-list))))
17678 (org-completion-use-iswitchb org-completion-use-iswitchb)
17679 (org-completion-use-ido org-completion-use-ido))
17680 (unless (or org-completion-use-ido org-completion-use-iswitchb)
17681 (setq org-completion-use-iswitchb t))
17682 (org-pop-to-buffer-same-window
17683 (org-icompleting-read "Org buffer: "
17684 (mapcar 'list (mapcar 'buffer-name blist))
17685 nil t))))
17687 ;;; Define some older names previously used for this functionality
17688 ;;;###autoload
17689 (defalias 'org-ido-switchb 'org-switchb)
17690 ;;;###autoload
17691 (defalias 'org-iswitchb 'org-switchb)
17693 (defun org-buffer-list (&optional predicate exclude-tmp)
17694 "Return a list of Org buffers.
17695 PREDICATE can be `export', `files' or `agenda'.
17697 export restrict the list to Export buffers.
17698 files restrict the list to buffers visiting Org files.
17699 agenda restrict the list to buffers visiting agenda files.
17701 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
17702 (let* ((bfn nil)
17703 (agenda-files (and (eq predicate 'agenda)
17704 (mapcar 'file-truename (org-agenda-files t))))
17705 (filter
17706 (cond
17707 ((eq predicate 'files)
17708 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
17709 ((eq predicate 'export)
17710 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
17711 ((eq predicate 'agenda)
17712 (lambda (b)
17713 (with-current-buffer b
17714 (and (derived-mode-p 'org-mode)
17715 (setq bfn (buffer-file-name b))
17716 (member (file-truename bfn) agenda-files)))))
17717 (t (lambda (b) (with-current-buffer b
17718 (or (derived-mode-p 'org-mode)
17719 (string-match "\*Org .*Export"
17720 (buffer-name b)))))))))
17721 (delq nil
17722 (mapcar
17723 (lambda(b)
17724 (if (and (funcall filter b)
17725 (or (not exclude-tmp)
17726 (not (string-match "tmp" (buffer-name b)))))
17727 b
17728 nil))
17729 (buffer-list)))))
17731 (defun org-agenda-files (&optional unrestricted archives)
17732 "Get the list of agenda files.
17733 Optional UNRESTRICTED means return the full list even if a restriction
17734 is currently in place.
17735 When ARCHIVES is t, include all archive files that are really being
17736 used by the agenda files. If ARCHIVE is `ifmode', do this only if
17737 `org-agenda-archives-mode' is t."
17738 (let ((files
17739 (cond
17740 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
17741 ((stringp org-agenda-files) (org-read-agenda-file-list))
17742 ((listp org-agenda-files) org-agenda-files)
17743 (t (error "Invalid value of `org-agenda-files'")))))
17744 (setq files (apply 'append
17745 (mapcar (lambda (f)
17746 (if (file-directory-p f)
17747 (directory-files
17748 f t org-agenda-file-regexp)
17749 (list f)))
17750 files)))
17751 (when org-agenda-skip-unavailable-files
17752 (setq files (delq nil
17753 (mapcar (function
17754 (lambda (file)
17755 (and (file-readable-p file) file)))
17756 files))))
17757 (when (or (eq archives t)
17758 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
17759 (setq files (org-add-archive-files files)))
17760 files))
17762 (defun org-agenda-file-p (&optional file)
17763 "Return non-nil, if FILE is an agenda file.
17764 If FILE is omitted, use the file associated with the current
17765 buffer."
17766 (member (or file (buffer-file-name))
17767 (org-agenda-files t)))
17769 (defun org-edit-agenda-file-list ()
17770 "Edit the list of agenda files.
17771 Depending on setup, this either uses customize to edit the variable
17772 `org-agenda-files', or it visits the file that is holding the list. In the
17773 latter case, the buffer is set up in a way that saving it automatically kills
17774 the buffer and restores the previous window configuration."
17775 (interactive)
17776 (if (stringp org-agenda-files)
17777 (let ((cw (current-window-configuration)))
17778 (find-file org-agenda-files)
17779 (org-set-local 'org-window-configuration cw)
17780 (org-add-hook 'after-save-hook
17781 (lambda ()
17782 (set-window-configuration
17783 (prog1 org-window-configuration
17784 (kill-buffer (current-buffer))))
17785 (org-install-agenda-files-menu)
17786 (message "New agenda file list installed"))
17787 nil 'local)
17788 (message "%s" (substitute-command-keys
17790 (customize-variable 'org-agenda-files)))
17792 (defun org-store-new-agenda-file-list (list)
17793 "Set new value for the agenda file list and save it correctly."
17794 (if (stringp org-agenda-files)
17795 (let ((fe (org-read-agenda-file-list t)) b u)
17796 (while (setq b (find-buffer-visiting org-agenda-files))
17797 (kill-buffer b))
17798 (with-temp-file org-agenda-files
17799 (insert
17800 (mapconcat
17801 (lambda (f) ;; Keep un-expanded entries.
17802 (if (setq u (assoc f fe))
17803 (cdr u)
17804 f))
17807 (let ((org-mode-hook nil) (org-inhibit-startup t)
17808 (org-insert-mode-line-in-empty-file nil))
17809 (setq org-agenda-files list)
17810 (customize-save-variable 'org-agenda-files org-agenda-files))))
17812 (defun org-read-agenda-file-list (&optional pair-with-expansion)
17813 "Read the list of agenda files from a file.
17814 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
17815 filenames, used by `org-store-new-agenda-file-list' to write back
17816 un-expanded file names."
17817 (when (file-directory-p org-agenda-files)
17818 (error "`org-agenda-files' cannot be a single directory"))
17819 (when (stringp org-agenda-files)
17820 (with-temp-buffer
17821 (insert-file-contents org-agenda-files)
17822 (mapcar
17823 (lambda (f)
17824 (let ((e (expand-file-name (substitute-in-file-name f)
17825 org-directory)))
17826 (if pair-with-expansion
17827 (cons e f)
17828 e)))
17831 ;;;###autoload
17832 (defun org-cycle-agenda-files ()
17833 "Cycle through the files in `org-agenda-files'.
17834 If the current buffer visits an agenda file, find the next one in the list.
17835 If the current buffer does not, find the first agenda file."
17836 (interactive)
17837 (let* ((fs (org-agenda-files t))
17838 (files (append fs (list (car fs))))
17839 (tcf (if buffer-file-name (file-truename buffer-file-name)))
17840 file)
17841 (unless files (error "No agenda files"))
17842 (catch 'exit
17843 (while (setq file (pop files))
17844 (if (equal (file-truename file) tcf)
17845 (when (car files)
17846 (find-file (car files))
17847 (throw 'exit t))))
17848 (find-file (car fs)))
17849 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
17851 (defun org-agenda-file-to-front (&optional to-end)
17852 "Move/add the current file to the top of the agenda file list.
17853 If the file is not present in the list, it is added to the front. If it is
17854 present, it is moved there. With optional argument TO-END, add/move to the
17855 end of the list."
17856 (interactive "P")
17857 (let ((org-agenda-skip-unavailable-files nil)
17858 (file-alist (mapcar (lambda (x)
17859 (cons (file-truename x) x))
17860 (org-agenda-files t)))
17861 (ctf (file-truename
17862 (or buffer-file-name
17863 (error "Please save the current buffer to a file"))))
17864 x had)
17865 (setq x (assoc ctf file-alist) had x)
17867 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
17868 (if to-end
17869 (setq file-alist (append (delq x file-alist) (list x)))
17870 (setq file-alist (cons x (delq x file-alist))))
17871 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
17872 (org-install-agenda-files-menu)
17873 (message "File %s to %s of agenda file list"
17874 (if had "moved" "added") (if to-end "end" "front"))))
17876 (defun org-remove-file (&optional file)
17877 "Remove current file from the list of files in variable `org-agenda-files'.
17878 These are the files which are being checked for agenda entries.
17879 Optional argument FILE means use this file instead of the current."
17880 (interactive)
17881 (let* ((org-agenda-skip-unavailable-files nil)
17882 (file (or file buffer-file-name
17883 (error "Current buffer does not visit a file")))
17884 (true-file (file-truename file))
17885 (afile (abbreviate-file-name file))
17886 (files (delq nil (mapcar
17887 (lambda (x)
17888 (if (equal true-file
17889 (file-truename x))
17890 nil x))
17891 (org-agenda-files t)))))
17892 (if (not (= (length files) (length (org-agenda-files t))))
17893 (progn
17894 (org-store-new-agenda-file-list files)
17895 (org-install-agenda-files-menu)
17896 (message "Removed file: %s" afile))
17897 (message "File was not in list: %s (not removed)" afile))))
17899 (defun org-file-menu-entry (file)
17900 (vector file (list 'find-file file) t))
17902 (defun org-check-agenda-file (file)
17903 "Make sure FILE exists. If not, ask user what to do."
17904 (when (not (file-exists-p file))
17905 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
17906 (abbreviate-file-name file))
17907 (let ((r (downcase (read-char-exclusive))))
17908 (cond
17909 ((equal r ?r)
17910 (org-remove-file file)
17911 (throw 'nextfile t))
17912 (t (error "Abort"))))))
17914 (defun org-get-agenda-file-buffer (file)
17915 "Get a buffer visiting FILE. If the buffer needs to be created, add
17916 it to the list of buffers which might be released later."
17917 (let ((buf (org-find-base-buffer-visiting file)))
17918 (if buf
17919 buf ; just return it
17920 ;; Make a new buffer and remember it
17921 (setq buf (find-file-noselect file))
17922 (if buf (push buf org-agenda-new-buffers))
17923 buf)))
17925 (defun org-release-buffers (blist)
17926 "Release all buffers in list, asking the user for confirmation when needed.
17927 When a buffer is unmodified, it is just killed. When modified, it is saved
17928 \(if the user agrees) and then killed."
17929 (let (buf file)
17930 (while (setq buf (pop blist))
17931 (setq file (buffer-file-name buf))
17932 (when (and (buffer-modified-p buf)
17933 file
17934 (y-or-n-p (format "Save file %s? " file)))
17935 (with-current-buffer buf (save-buffer)))
17936 (kill-buffer buf))))
17938 (defun org-agenda-prepare-buffers (files)
17939 "Create buffers for all agenda files, protect archived trees and comments."
17940 (interactive)
17941 (let ((pa '(:org-archived t))
17942 (pc '(:org-comment t))
17943 (pall '(:org-archived t :org-comment t))
17944 (inhibit-read-only t)
17945 (org-inhibit-startup org-agenda-inhibit-startup)
17946 (rea (concat ":" org-archive-tag ":"))
17947 file re)
17948 (setq org-tag-alist-for-agenda nil
17949 org-tag-groups-alist-for-agenda nil)
17950 (save-excursion
17951 (save-restriction
17952 (while (setq file (pop files))
17953 (catch 'nextfile
17954 (if (bufferp file)
17955 (set-buffer file)
17956 (org-check-agenda-file file)
17957 (set-buffer (org-get-agenda-file-buffer file)))
17958 (widen)
17959 (org-set-regexps-and-options-for-tags)
17960 (org-refresh-category-properties)
17961 (org-refresh-properties org-effort-property 'org-effort)
17962 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime)
17963 (setq org-todo-keywords-for-agenda
17964 (append org-todo-keywords-for-agenda org-todo-keywords-1))
17965 (setq org-done-keywords-for-agenda
17966 (append org-done-keywords-for-agenda org-done-keywords))
17967 (setq org-todo-keyword-alist-for-agenda
17968 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
17969 (setq org-drawers-for-agenda
17970 (append org-drawers-for-agenda org-drawers))
17971 (unless (equal org-tag-alist-for-agenda org-tag-alist)
17972 (setq org-tag-alist-for-agenda
17973 (append org-tag-alist-for-agenda org-tag-alist)))
17974 (if org-group-tags
17975 (setq org-tag-groups-alist-for-agenda
17976 (org-uniquify-alist
17977 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
17978 (org-with-silent-modifications
17979 (save-excursion
17980 (remove-text-properties (point-min) (point-max) pall)
17981 (when org-agenda-skip-archived-trees
17982 (goto-char (point-min))
17983 (while (re-search-forward rea nil t)
17984 (if (org-at-heading-p t)
17985 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
17986 (goto-char (point-min))
17987 (setq re (format org-heading-keyword-regexp-format
17988 org-comment-string))
17989 (while (re-search-forward re nil t)
17990 (add-text-properties
17991 (match-beginning 0) (org-end-of-subtree t) pc))))))))
17992 (setq org-todo-keywords-for-agenda
17993 (org-uniquify org-todo-keywords-for-agenda))
17994 (setq org-todo-keyword-alist-for-agenda
17995 (org-uniquify org-todo-keyword-alist-for-agenda))))
17997 \f
17998 ;;;; CDLaTeX minor mode
18000 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18001 "Keymap for the minor `org-cdlatex-mode'.")
18003 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18004 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18005 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18006 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18007 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
18009 (defvar org-cdlatex-texmathp-advice-is-done nil
18010 "Flag remembering if we have applied the advice to texmathp already.")
18012 (define-minor-mode org-cdlatex-mode
18013 "Toggle the minor `org-cdlatex-mode'.
18014 This mode supports entering LaTeX environment and math in LaTeX fragments
18015 in Org-mode.
18017 nil " OCDL" nil
18018 (when org-cdlatex-mode
18019 (require 'cdlatex)
18020 (run-hooks 'cdlatex-mode-hook)
18021 (cdlatex-compute-tables))
18022 (unless org-cdlatex-texmathp-advice-is-done
18023 (setq org-cdlatex-texmathp-advice-is-done t)
18024 (defadvice texmathp (around org-math-always-on activate)
18025 "Always return t in org-mode buffers.
18026 This is because we want to insert math symbols without dollars even outside
18027 the LaTeX math segments. If Orgmode thinks that point is actually inside
18028 an embedded LaTeX fragment, let texmathp do its job.
18030 (interactive)
18031 (let (p)
18032 (cond
18033 ((not (derived-mode-p 'org-mode)) ad-do-it)
18034 ((eq this-command 'cdlatex-math-symbol)
18035 (setq ad-return-value t
18036 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18037 (t
18038 (let ((p (org-inside-LaTeX-fragment-p)))
18039 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18040 (setq ad-return-value t
18041 texmathp-why '("Org-mode embedded math" . 0))
18042 (if p ad-do-it)))))))))
18044 (defun turn-on-org-cdlatex ()
18045 "Unconditionally turn on `org-cdlatex-mode'."
18046 (org-cdlatex-mode 1))
18048 (defun org-try-cdlatex-tab ()
18049 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18050 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18051 - inside a LaTeX fragment, or
18052 - after the first word in a line, where an abbreviation expansion could
18053 insert a LaTeX environment."
18054 (when org-cdlatex-mode
18055 (cond
18056 ;; Before any word on the line: No expansion possible.
18058 ;; Just after first word on the line: Expand it. Make sure it
18059 ;; cannot happen on headlines, though.
18060 ((save-excursion
18061 (skip-chars-backward "a-zA-Z0-9*")
18063 (and (bolp) (not (org-at-heading-p))))
18064 (cdlatex-tab) t)
18065 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18067 (defun org-cdlatex-underscore-caret (&optional arg)
18068 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18069 Revert to the normal definition outside of these fragments."
18070 (interactive "P")
18071 (if (org-inside-LaTeX-fragment-p)
18072 (call-interactively 'cdlatex-sub-superscript)
18073 (let (org-cdlatex-mode)
18074 (call-interactively (key-binding (vector last-input-event))))))
18076 (defun org-cdlatex-math-modify (&optional arg)
18077 "Execute `cdlatex-math-modify' in LaTeX fragments.
18078 Revert to the normal definition outside of these fragments."
18079 (interactive "P")
18080 (if (org-inside-LaTeX-fragment-p)
18081 (call-interactively 'cdlatex-math-modify)
18082 (let (org-cdlatex-mode)
18083 (call-interactively (key-binding (vector last-input-event))))))
18086 \f
18087 ;;;; LaTeX fragments
18089 (defvar org-latex-regexps
18091 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
18094 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
18098 "Regular expressions for matching embedded LaTeX.")
18100 (defun org-inside-LaTeX-fragment-p ()
18101 "Test if point is inside a LaTeX fragment.
18103 sequence appearing also before point.
18104 Even though the matchers for math are configurable, this function assumes
18106 delimiters are skipped when they have been removed by customization.
18107 The return value is nil, or a cons cell with the delimiter and the
18108 position of this delimiter.
18110 This function does a reasonably good job, but can locally be fooled by
18111 for example currency specifications. For example it will assume being in
18113 fragments that are properly closed, but during editing, we have to live
18114 with the uncertainty caused by missing closing delimiters. This function
18115 looks only before point, not after."
18116 (catch 'exit
18117 (let ((pos (point))
18118 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18119 (lim (progn
18121 (point)))
18122 dd-on str (start 0) m re)
18123 (goto-char pos)
18124 (when dodollar
18126 re (nth 1 (assoc "$" org-latex-regexps)))
18127 (while (string-match re str start)
18128 (cond
18129 ((= (match-end 0) (length str))
18130 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18131 ((= (match-end 0) (- (length str) 5))
18132 (throw 'exit nil))
18133 (t (setq start (match-end 0))))))
18134 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18135 (goto-char pos)
18136 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18137 (and (match-beginning 2) (throw 'exit nil))
18138 ;; count $$
18140 (setq dd-on (not dd-on)))
18141 (goto-char pos)
18142 (if dd-on (cons "$$" m))))))
18144 (defun org-inside-latex-macro-p ()
18145 "Is point inside a LaTeX macro or its arguments?"
18146 (save-match-data
18147 (org-in-regexp
18150 (defvar org-latex-fragment-image-overlays nil
18151 "List of overlays carrying the images of latex fragments.")
18152 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18154 (defun org-remove-latex-fragment-image-overlays ()
18155 "Remove all overlays with LaTeX fragment images in current buffer."
18156 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18157 (setq org-latex-fragment-image-overlays nil))
18159 (defun org-preview-latex-fragment (&optional subtree)
18160 "Preview the LaTeX fragment at point, or all locally or globally.
18161 If the cursor is in a LaTeX fragment, create the image and overlay
18162 it over the source code. If there is no fragment at point, display
18163 all fragments in the current text, from one headline to the next. With
18164 prefix SUBTREE, display all fragments in the current subtree. With a
18166 the cursor is before the first headline,
18167 display all fragments in the buffer.
18169 (interactive "P")
18170 (unless buffer-file-name
18171 (error "Can't preview LaTeX fragment in a non-file buffer"))
18172 (org-remove-latex-fragment-image-overlays)
18173 (save-excursion
18174 (save-restriction
18175 (let (beg end at msg)
18176 (cond
18177 ((or (equal subtree '(16))
18178 (not (save-excursion
18179 (re-search-backward org-outline-regexp-bol nil t))))
18180 (setq beg (point-min) end (point-max)
18181 msg "Creating images for buffer...%s"))
18182 ((equal subtree '(4))
18183 (org-back-to-heading)
18184 (setq beg (point) end (org-end-of-subtree t)
18185 msg "Creating images for subtree...%s"))
18186 (t
18187 (if (setq at (org-inside-LaTeX-fragment-p))
18188 (goto-char (max (point-min) (- (cdr at) 2)))
18189 (org-back-to-heading))
18190 (setq beg (point) end (progn (outline-next-heading) (point))
18191 msg (if at "Creating image...%s"
18192 "Creating images for entry...%s"))))
18193 (message msg "")
18194 (narrow-to-region beg end)
18195 (goto-char beg)
18196 (org-format-latex
18197 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
18198 (file-name-nondirectory
18199 buffer-file-name)))
18200 default-directory 'overlays msg at 'forbuffer
18201 org-latex-create-formula-image-program)
18202 (message msg "done. Use `C-c C-c' to remove images.")))))
18204 (defun org-format-latex (prefix &optional dir overlays msg at
18205 forbuffer processing-type)
18206 "Replace LaTeX fragments with links to an image, and produce images.
18207 Some of the options can be changed using the variable
18208 `org-format-latex-options'."
18209 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18210 (let* ((prefixnodir (file-name-nondirectory prefix))
18211 (absprefix (expand-file-name prefix dir))
18212 (todir (file-name-directory absprefix))
18213 (opt org-format-latex-options)
18214 (optnew org-format-latex-options)
18215 (matchers (plist-get opt :matchers))
18216 (re-list org-latex-regexps)
18217 (cnt 0) txt hash link beg end re e checkdir
18218 string
18219 m n block-type block linkfile movefile ov)
18220 ;; Check the different regular expressions
18221 (while (setq e (pop re-list))
18222 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
18224 (when (member m matchers)
18225 (goto-char (point-min))
18226 (while (re-search-forward re nil t)
18227 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
18228 (or (not overlays)
18229 (not (eq (get-char-property (match-beginning n)
18230 'org-overlay-type)
18231 'org-latex-overlay))))
18232 (cond
18233 ((eq processing-type 'verbatim))
18234 ((eq processing-type 'mathjax)
18235 ;; Prepare for MathJax processing.
18236 (setq string (match-string n))
18237 (when (member m '("$" "$1"))
18238 (save-excursion
18239 (delete-region (match-beginning n) (match-end n))
18240 (goto-char (match-beginning n))
18242 ((or (eq processing-type 'dvipng)
18243 (eq processing-type 'imagemagick))
18244 ;; Process to an image.
18245 (setq txt (match-string n)
18246 beg (match-beginning n) end (match-end n)
18247 cnt (1+ cnt))
18248 (let ((face (face-at-point))
18249 (fg (plist-get opt :foreground))
18250 (bg (plist-get opt :background))
18251 ;; Ensure full list is printed.
18252 print-length print-level)
18253 (when forbuffer
18254 ;; Get the colors from the face at point.
18255 (goto-char beg)
18256 (when (eq fg 'auto)
18257 (setq fg (face-attribute face :foreground nil 'default)))
18258 (when (eq bg 'auto)
18259 (setq bg (face-attribute face :background nil 'default)))
18260 (setq optnew (copy-sequence opt))
18261 (plist-put optnew :foreground fg)
18262 (plist-put optnew :background bg))
18263 (setq hash (sha1 (prin1-to-string
18264 (list org-format-latex-header
18265 org-latex-default-packages-alist
18266 org-latex-packages-alist
18267 org-format-latex-options
18268 forbuffer txt fg bg)))
18269 linkfile (format "%s_%s.png" prefix hash)
18270 movefile (format "%s_%s.png" absprefix hash)))
18271 (setq link (concat block "[[file:" linkfile "]]" block))
18272 (if msg (message msg cnt))
18273 (goto-char beg)
18274 (unless checkdir ; Ensure the directory exists.
18275 (setq checkdir t)
18276 (or (file-directory-p todir) (make-directory todir t)))
18277 (unless (file-exists-p movefile)
18278 (org-create-formula-image
18279 txt movefile optnew forbuffer processing-type))
18280 (if overlays
18281 (progn
18282 (mapc (lambda (o)
18283 (if (eq (overlay-get o 'org-overlay-type)
18284 'org-latex-overlay)
18285 (delete-overlay o)))
18286 (overlays-in beg end))
18287 (setq ov (make-overlay beg end))
18288 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
18289 (if (featurep 'xemacs)
18290 (progn
18291 (overlay-put ov 'invisible t)
18292 (overlay-put
18293 ov 'end-glyph
18294 (make-glyph (vector 'png :file movefile))))
18295 (overlay-put
18296 ov 'display
18297 (list 'image :type 'png :file movefile :ascent 'center)))
18298 (push ov org-latex-fragment-image-overlays)
18299 (goto-char end))
18300 (delete-region beg end)
18301 (insert (org-add-props link
18302 (list 'org-latex-src
18303 (replace-regexp-in-string
18305 'org-latex-src-embed-type
18306 (if block-type 'paragraph 'character))))))
18307 ((eq processing-type 'mathml)
18308 ;; Process to MathML
18309 (unless (save-match-data (org-format-latex-mathml-available-p))
18310 (error "LaTeX to MathML converter not configured"))
18311 (setq txt (match-string n)
18312 beg (match-beginning n) end (match-end n)
18313 cnt (1+ cnt))
18314 (if msg (message msg cnt))
18315 (goto-char beg)
18316 (delete-region beg end)
18317 (insert (org-format-latex-as-mathml
18318 txt block-type prefix dir)))
18319 (t
18320 (error "Unknown conversion type %s for latex fragments"
18321 processing-type)))))))))
18323 (defun org-create-math-formula (latex-frag &optional mathml-file)
18324 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18325 Use `org-latex-to-mathml-convert-command'. If the conversion is
18327 elements otherwise return nil. When MATHML-FILE is specified,
18328 write the results in to that file. When invoked as an
18329 interactive command, prompt for LATEX-FRAG, with initial value
18330 set to the current active region and echo the results for user
18331 inspection."
18332 (interactive (list (let ((frag (when (org-region-active-p)
18333 (buffer-substring-no-properties
18334 (region-beginning) (region-end)))))
18335 (read-string "LaTeX Fragment: " frag nil frag))))
18336 (unless latex-frag (error "Invalid latex-frag"))
18337 (let* ((tmp-in-file (file-relative-name
18338 (make-temp-name (expand-file-name "ltxmathml-in"))))
18339 (ignore (write-region latex-frag nil tmp-in-file))
18340 (tmp-out-file (file-relative-name
18341 (make-temp-name (expand-file-name "ltxmathml-out"))))
18342 (cmd (format-spec
18343 org-latex-to-mathml-convert-command
18344 `((?j . ,(shell-quote-argument
18345 (expand-file-name org-latex-to-mathml-jar-file)))
18346 (?I . ,(shell-quote-argument tmp-in-file))
18347 (?o . ,(shell-quote-argument tmp-out-file)))))
18348 mathml shell-command-output)
18349 (when (org-called-interactively-p 'any)
18350 (unless (org-format-latex-mathml-available-p)
18351 (error "LaTeX to MathML converter not configured")))
18352 (message "Running %s" cmd)
18353 (setq shell-command-output (shell-command-to-string cmd))
18354 (setq mathml
18355 (when (file-readable-p tmp-out-file)
18356 (with-current-buffer (find-file-noselect tmp-out-file t)
18357 (goto-char (point-min))
18358 (when (re-search-forward
18359 (concat
18360 (regexp-quote
18363 (regexp-quote "</math>")) nil t)
18364 (prog1 (match-string 0) (kill-buffer))))))
18365 (cond
18366 (mathml
18367 (setq mathml
18369 (when mathml-file
18370 (write-region mathml nil mathml-file))
18371 (when (org-called-interactively-p 'any)
18372 (message mathml)))
18373 ((message "LaTeX to MathML conversion failed")
18374 (message shell-command-output)))
18375 (delete-file tmp-in-file)
18376 (when (file-exists-p tmp-out-file)
18377 (delete-file tmp-out-file))
18378 mathml))
18380 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18381 prefix &optional dir)
18382 "Use `org-create-math-formula' but check local cache first."
18383 (let* ((absprefix (expand-file-name prefix dir))
18384 (print-length nil) (print-level nil)
18385 (formula-id (concat
18386 "formula-"
18387 (sha1
18388 (prin1-to-string
18389 (list latex-frag
18390 org-latex-to-mathml-convert-command)))))
18391 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18392 (formula-cache-dir (file-name-directory formula-cache)))
18394 (unless (file-directory-p formula-cache-dir)
18395 (make-directory formula-cache-dir t))
18397 (unless (file-exists-p formula-cache)
18398 (org-create-math-formula latex-frag formula-cache))
18400 (if (file-exists-p formula-cache)
18401 ;; Successful conversion. Return the link to MathML file.
18402 (org-add-props
18403 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18405 'org-latex-src-embed-type (if latex-frag-type
18406 'paragraph 'character)))
18407 ;; Failed conversion. Return the LaTeX fragment verbatim
18408 latex-frag)))
18410 (defun org-create-formula-image (string tofile options buffer &optional type)
18411 "Create an image from LaTeX source using dvipng or convert.
18412 This function calls either `org-create-formula-image-with-dvipng'
18413 or `org-create-formula-image-with-imagemagick' depending on the
18414 value of `org-latex-create-formula-image-program' or on the value
18415 of the optional TYPE variable.
18417 Note: ultimately these two function should be combined as they
18418 share a good deal of logic."
18419 (org-check-external-command
18420 "latex" "needed to convert LaTeX fragments to images")
18421 (funcall
18422 (case (or type org-latex-create-formula-image-program)
18423 ('dvipng
18424 (org-check-external-command
18425 "dvipng" "needed to convert LaTeX fragments to images")
18426 #'org-create-formula-image-with-dvipng)
18427 ('imagemagick
18428 (org-check-external-command
18429 "convert" "you need to install imagemagick")
18430 #'org-create-formula-image-with-imagemagick)
18431 (t (error
18432 "invalid value of `org-latex-create-formula-image-program'")))
18433 string tofile options buffer))
18435 (declare-function org-export--get-global-options "ox" (&optional backend))
18436 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
18437 (defun org-create-formula--latex-header ()
18438 "Return LaTeX header appropriate for previewing a LaTeX snippet."
18439 (org-latex-guess-inputenc
18440 (org-splice-latex-header
18441 org-format-latex-header
18442 org-latex-default-packages-alist
18443 org-latex-packages-alist t
18444 (plist-get
18445 (org-combine-plists
18446 (org-export--get-global-options 'latex)
18447 (org-export--get-inbuffer-options 'latex))
18448 :latex-header))))
18450 ;; This function borrows from Ganesh Swami's latex2png.el
18451 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
18452 "This calls dvipng."
18453 (require 'ox-latex)
18454 (let* ((tmpdir (if (featurep 'xemacs)
18455 (temp-directory)
18456 temporary-file-directory))
18457 (texfilebase (make-temp-name
18458 (expand-file-name "orgtex" tmpdir)))
18459 (texfile (concat texfilebase ".tex"))
18460 (dvifile (concat texfilebase ".dvi"))
18461 (pngfile (concat texfilebase ".png"))
18462 (fnh (if (featurep 'xemacs)
18463 (font-height (face-font 'default))
18464 (face-attribute 'default :height nil)))
18465 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18466 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18467 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18468 "Black"))
18469 (bg (or (plist-get options (if buffer :background :html-background))
18470 "Transparent")))
18471 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
18472 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
18473 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
18474 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
18475 (let ((latex-header (org-create-formula--latex-header)))
18476 (with-temp-file texfile
18477 (insert latex-header)
18479 (let ((dir default-directory))
18480 (condition-case nil
18481 (progn
18482 (cd tmpdir)
18483 (call-process "latex" nil nil nil texfile))
18484 (error nil))
18485 (cd dir))
18486 (if (not (file-exists-p dvifile))
18487 (progn (message "Failed to create dvi file from %s" texfile) nil)
18488 (condition-case nil
18489 (if (featurep 'xemacs)
18490 (call-process "dvipng" nil nil nil
18491 "-fg" fg "-bg" bg
18492 "-T" "tight"
18493 "-o" pngfile
18494 dvifile)
18495 (call-process "dvipng" nil nil nil
18496 "-fg" fg "-bg" bg
18497 "-D" dpi
18498 ;;"-x" scale "-y" scale
18499 "-T" "tight"
18500 "-o" pngfile
18501 dvifile))
18502 (error nil))
18503 (if (not (file-exists-p pngfile))
18504 (if org-format-latex-signal-error
18505 (error "Failed to create png file from %s" texfile)
18506 (message "Failed to create png file from %s" texfile)
18507 nil)
18508 ;; Use the requested file name and clean up
18509 (copy-file pngfile tofile 'replace)
18510 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
18511 (if (file-exists-p (concat texfilebase e))
18512 (delete-file (concat texfilebase e))))
18513 pngfile))))
18515 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
18516 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
18517 "This calls convert, which is included into imagemagick."
18518 (require 'ox-latex)
18519 (let* ((tmpdir (if (featurep 'xemacs)
18520 (temp-directory)
18521 temporary-file-directory))
18522 (texfilebase (make-temp-name
18523 (expand-file-name "orgtex" tmpdir)))
18524 (texfile (concat texfilebase ".tex"))
18525 (pdffile (concat texfilebase ".pdf"))
18526 (pngfile (concat texfilebase ".png"))
18527 (fnh (if (featurep 'xemacs)
18528 (font-height (face-font 'default))
18529 (face-attribute 'default :height nil)))
18530 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18531 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18532 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18533 "black"))
18534 (bg (or (plist-get options (if buffer :background :html-background))
18535 "white")))
18536 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
18537 (setq fg (org-latex-color-format fg)))
18538 (if (eq bg 'default) (setq bg (org-latex-color :background))
18539 (setq bg (org-latex-color-format
18540 (if (string= bg "Transparent") "white" bg))))
18541 (let ((latex-header (org-create-formula--latex-header)))
18542 (with-temp-file texfile
18543 (insert latex-header)
18549 string
18552 (org-latex-compile texfile t)
18553 (if (not (file-exists-p pdffile))
18554 (progn (message "Failed to create pdf file from %s" texfile) nil)
18555 (condition-case nil
18556 (if (featurep 'xemacs)
18557 (call-process "convert" nil nil nil
18558 "-density" "96"
18559 "-trim"
18560 "-antialias"
18561 pdffile
18562 "-quality" "100"
18563 ;; "-sharpen" "0x1.0"
18564 pngfile)
18565 (call-process "convert" nil nil nil
18566 "-density" dpi
18567 "-trim"
18568 "-antialias"
18569 pdffile
18570 "-quality" "100"
18571 ;; "-sharpen" "0x1.0"
18572 pngfile))
18573 (error nil))
18574 (if (not (file-exists-p pngfile))
18575 (if org-format-latex-signal-error
18576 (error "Failed to create png file from %s" texfile)
18577 (message "Failed to create png file from %s" texfile)
18578 nil)
18579 ;; Use the requested file name and clean up
18580 (copy-file pngfile tofile 'replace)
18581 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
18582 (if (file-exists-p (concat texfilebase e))
18583 (delete-file (concat texfilebase e))))
18584 pngfile))))
18586 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
18587 "Fill a LaTeX header template TPL.
18588 In the template, the following place holders will be recognized:
18591 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
18593 [NO-PACKAGES] do not include PKG
18594 [EXTRA] the string EXTRA
18595 [NO-EXTRA] do not include EXTRA
18597 For backward compatibility, if both the positive and the negative place
18599 assumed to be present at the end of the template.
18600 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
18601 EXTRA is a string.
18602 SNIPPETS-P indicates if this is run to create snippet images for HTML."
18603 (let (rpl (end ""))
18605 (setq rpl (if (or (match-end 1) (not def-pkg))
18606 "" (org-latex-packages-to-string def-pkg snippets-p t))
18607 tpl (replace-match rpl t t tpl))
18608 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
18611 (setq rpl (if (or (match-end 1) (not pkg))
18612 "" (org-latex-packages-to-string pkg snippets-p t))
18613 tpl (replace-match rpl t t tpl))
18614 (if pkg (setq end
18616 (org-latex-packages-to-string pkg snippets-p)))))
18619 (setq rpl (if (or (match-end 1) (not extra))
18621 tpl (replace-match rpl t t tpl))
18627 tpl)))
18629 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
18631 (setq pkg (mapconcat (lambda(p)
18632 (cond
18633 ((stringp p) p)
18634 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
18635 (format "%% Package %s omitted" (cadr p)))
18636 ((equal "" (car p))
18638 (t
18640 (car p) (cadr p)))))
18641 pkg
18645 (defun org-dvipng-color (attr)
18646 "Return a RGB color specification for dvipng."
18647 (apply 'format "rgb %s %s %s"
18648 (mapcar 'org-normalize-color
18649 (if (featurep 'xemacs)
18650 (color-rgb-components
18651 (face-property 'default
18652 (cond ((eq attr :foreground) 'foreground)
18653 ((eq attr :background) 'background))))
18654 (color-values (face-attribute 'default attr nil))))))
18656 (defun org-dvipng-color-format (color-name)
18657 "Convert COLOR-NAME to a RGB color value for dvipng."
18658 (apply 'format "rgb %s %s %s"
18659 (mapcar 'org-normalize-color
18660 (color-values color-name))))
18662 (defun org-latex-color (attr)
18663 "Return a RGB color for the LaTeX color package."
18664 (apply 'format "%s,%s,%s"
18665 (mapcar 'org-normalize-color
18666 (if (featurep 'xemacs)
18667 (color-rgb-components
18668 (face-property 'default
18669 (cond ((eq attr :foreground) 'foreground)
18670 ((eq attr :background) 'background))))
18671 (color-values (face-attribute 'default attr nil))))))
18673 (defun org-latex-color-format (color-name)
18674 "Convert COLOR-NAME to a RGB color value."
18675 (apply 'format "%s,%s,%s"
18676 (mapcar 'org-normalize-color
18677 (color-values color-name))))
18679 (defun org-normalize-color (value)
18680 "Return string to be used as color value for an RGB component."
18681 (format "%g" (/ value 65535.0)))
18684 \f
18685 ;; Image display
18687 (defvar org-inline-image-overlays nil)
18688 (make-variable-buffer-local 'org-inline-image-overlays)
18690 (defun org-toggle-inline-images (&optional include-linked)
18691 "Toggle the display of inline images.
18692 INCLUDE-LINKED is passed to `org-display-inline-images'."
18693 (interactive "P")
18694 (if org-inline-image-overlays
18695 (progn
18696 (org-remove-inline-images)
18697 (message "Inline image display turned off"))
18698 (org-display-inline-images include-linked)
18699 (if (and (org-called-interactively-p)
18700 org-inline-image-overlays)
18701 (message "%d images displayed inline"
18702 (length org-inline-image-overlays))
18703 (message "No images to display inline"))))
18705 (defun org-redisplay-inline-images ()
18706 "Refresh the display of inline images."
18707 (interactive)
18708 (if (not org-inline-image-overlays)
18709 (org-toggle-inline-images)
18710 (org-toggle-inline-images)
18711 (org-toggle-inline-images)))
18713 (defun org-display-inline-images (&optional include-linked refresh beg end)
18714 "Display inline images.
18715 Normally only links without a description part are inlined, because this
18716 is how it will work for export. When INCLUDE-LINKED is set, also links
18717 with a description part will be inlined. This can be nice for a quick
18718 look at those images, but it does not reflect what exported files will look
18719 like.
18720 When REFRESH is set, refresh existing images between BEG and END.
18721 This will create new image displays only if necessary.
18722 BEG and END default to the buffer boundaries."
18723 (interactive "P")
18724 (unless refresh
18725 (org-remove-inline-images)
18726 (if (fboundp 'clear-image-cache) (clear-image-cache)))
18727 (save-excursion
18728 (save-restriction
18729 (widen)
18730 (setq beg (or beg (point-min)) end (or end (point-max)))
18731 (goto-char beg)
18733 (substring (org-image-file-name-regexp) 0 -2)
18735 (case-fold-search t)
18736 old file ov img type attrwidth width)
18737 (while (re-search-forward re end t)
18738 (setq old (get-char-property-and-overlay (match-beginning 1)
18739 'org-image-overlay)
18740 file (expand-file-name
18741 (concat (or (match-string 3) "") (match-string 4))))
18742 (when (image-type-available-p 'imagemagick)
18743 (setq attrwidth (if (or (listp org-image-actual-width)
18744 (null org-image-actual-width))
18745 (save-excursion
18746 (save-match-data
18747 (when (re-search-backward
18749 (save-excursion
18751 (string-to-number (match-string 1))))))
18752 width (cond ((eq org-image-actual-width t) nil)
18753 ((null org-image-actual-width) attrwidth)
18754 ((numberp org-image-actual-width)
18755 org-image-actual-width)
18756 ((listp org-image-actual-width)
18757 (or attrwidth (car org-image-actual-width))))
18758 type (if width 'imagemagick)))
18759 (when (file-exists-p file)
18760 (if (and (car-safe old) refresh)
18761 (image-refresh (overlay-get (cdr old) 'display))
18762 (setq img (save-match-data (create-image file type nil :width width)))
18763 (when img
18764 (setq ov (make-overlay (match-beginning 0) (match-end 0)))
18765 (overlay-put ov 'display img)
18766 (overlay-put ov 'face 'default)
18767 (overlay-put ov 'org-image-overlay t)
18768 (overlay-put ov 'modification-hooks
18769 (list 'org-display-inline-remove-overlay))
18770 (push ov org-inline-image-overlays)))))))))
18772 (define-obsolete-function-alias
18773 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
18775 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
18776 "Remove inline-display overlay if a corresponding region is modified."
18777 (let ((inhibit-modification-hooks t))
18778 (when (and ov after)
18779 (delete ov org-inline-image-overlays)
18780 (delete-overlay ov))))
18782 (defun org-remove-inline-images ()
18783 "Remove inline display of images."
18784 (interactive)
18785 (mapc 'delete-overlay org-inline-image-overlays)
18786 (setq org-inline-image-overlays nil))
18788 ;;;; Key bindings
18790 ;; Outline functions from `outline-mode-prefix-map'
18791 ;; that can be remapped in Org:
18792 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
18793 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
18794 (define-key org-mode-map [remap outline-forward-same-level]
18795 'org-forward-heading-same-level)
18796 (define-key org-mode-map [remap outline-backward-same-level]
18797 'org-backward-heading-same-level)
18798 (define-key org-mode-map [remap show-branches]
18799 'org-kill-note-or-show-branches)
18800 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
18801 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
18802 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
18804 ;; Outline functions from `outline-mode-prefix-map' that can not
18805 ;; be remapped in Org:
18806 ;;
18807 ;; - the column "key binding" shows whether the Outline function is still
18808 ;; available in Org mode on the same key that it has been bound to in
18809 ;; Outline mode:
18810 ;; - "overridden": key used for a different functionality in Org mode
18811 ;; - else: key still bound to the same Outline function in Org mode
18812 ;;
18813 ;; | Outline function | key binding | Org replacement |
18814 ;; |------------------------------------+-------------+-----------------------|
18815 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
18816 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
18817 ;; | `outline-up-heading' | `C-c C-u' | still same function |
18818 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
18819 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
18820 ;; | `show-entry' | overridden | no replacement |
18821 ;; | `show-children' | `C-c C-i' | visibility cycling |
18822 ;; | `show-branches' | `C-c C-k' | still same function |
18823 ;; | `show-subtree' | overridden | visibility cycling |
18824 ;; | `show-all' | overridden | no replacement |
18825 ;; | `hide-subtree' | overridden | visibility cycling |
18826 ;; | `hide-body' | overridden | no replacement |
18827 ;; | `hide-entry' | overridden | visibility cycling |
18828 ;; | `hide-leaves' | overridden | no replacement |
18829 ;; | `hide-sublevels' | overridden | no replacement |
18830 ;; | `hide-other' | overridden | no replacement |
18832 ;; Make `C-c C-x' a prefix key
18833 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
18835 ;; TAB key with modifiers
18836 (org-defkey org-mode-map "\C-i" 'org-cycle)
18837 (org-defkey org-mode-map [(tab)] 'org-cycle)
18838 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
18840 ;; The following line is necessary under Suse GNU/Linux
18841 (unless (featurep 'xemacs)
18842 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
18843 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
18844 (define-key org-mode-map [backtab] 'org-shifttab)
18846 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
18847 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
18848 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
18850 ;; Cursor keys with modifiers
18851 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
18852 (org-defkey org-mode-map [(meta right)] 'org-metaright)
18853 (org-defkey org-mode-map [(meta up)] 'org-metaup)
18854 (org-defkey org-mode-map [(meta down)] 'org-metadown)
18856 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
18857 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
18858 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
18859 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
18861 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
18862 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
18863 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
18864 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
18866 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
18867 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
18868 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
18869 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
18871 ;; Babel keys
18872 (define-key org-mode-map org-babel-key-prefix org-babel-map)
18873 (mapc (lambda (pair)
18874 (define-key org-babel-map (car pair) (cdr pair)))
18875 org-babel-key-bindings)
18877 ;;; Extra keys for tty access.
18878 ;; We only set them when really needed because otherwise the
18879 ;; menus don't show the simple keys
18881 (when (or org-use-extra-keys
18882 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
18883 (not window-system))
18884 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
18885 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
18886 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
18887 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
18888 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
18889 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
18890 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
18891 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
18892 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
18893 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
18894 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
18895 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
18896 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
18897 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
18898 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
18899 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
18900 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
18901 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
18902 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
18903 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
18904 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
18905 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
18906 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
18907 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
18908 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
18909 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
18910 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
18911 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
18913 ;; All the other keys
18915 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
18916 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
18917 (if (boundp 'narrow-map)
18918 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
18919 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
18920 (if (boundp 'narrow-map)
18921 (org-defkey narrow-map "b" 'org-narrow-to-block)
18922 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
18923 (if (boundp 'narrow-map)
18924 (org-defkey narrow-map "e" 'org-narrow-to-element)
18925 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
18926 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
18927 (org-defkey org-mode-map "\M-}" 'org-forward-element)
18928 (org-defkey org-mode-map "\M-{" 'org-backward-element)
18929 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
18930 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
18931 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
18932 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
18933 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
18934 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
18935 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
18936 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
18937 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
18938 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
18939 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
18940 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
18941 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
18942 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
18943 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
18944 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
18945 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
18946 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
18947 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
18948 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
18949 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
18950 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
18951 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
18953 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
18954 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
18955 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
18956 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
18957 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
18958 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
18959 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
18960 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
18961 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
18962 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
18963 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
18964 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
18965 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
18966 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
18967 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
18968 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
18969 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
18970 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
18971 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
18972 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
18973 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
18975 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
18976 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
18977 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
18978 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
18979 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
18980 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
18981 (org-defkey org-mode-map "\C-c^" 'org-sort)
18982 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
18983 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
18984 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
18985 (org-defkey org-mode-map "\C-o" 'org-ctrl-o)
18986 (org-defkey org-mode-map "\C-m" 'org-return)
18987 (org-defkey org-mode-map "\C-j" 'org-return-indent)
18988 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
18989 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
18990 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
18991 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
18992 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
18993 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
18994 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
18995 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
18996 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
18997 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
18998 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
18999 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19000 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19001 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
19002 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19003 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19004 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19005 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19006 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19007 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19008 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19009 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19011 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19012 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19013 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19015 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19016 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19017 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19018 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19019 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19020 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19021 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19022 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19023 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19024 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19025 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
19026 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19027 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19029 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19030 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19031 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19032 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19033 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19034 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19035 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19036 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19037 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19039 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19040 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19041 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19042 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19043 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19045 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19047 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19049 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19050 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19052 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19055 (when (featurep 'xemacs)
19056 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19059 (defconst org-speed-commands-default
19060 '(
19061 ("Outline Navigation")
19062 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
19063 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
19064 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19065 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19066 ("F" . org-next-block)
19067 ("B" . org-previous-block)
19068 ("u" . (org-speed-move-safe 'outline-up-heading))
19069 ("j" . org-goto)
19070 ("g" . (org-refile t))
19071 ("Outline Visibility")
19072 ("c" . org-cycle)
19073 ("C" . org-shifttab)
19074 (" " . org-display-outline-path)
19075 ("s" . org-narrow-to-subtree)
19076 ("=" . org-columns)
19077 ("Outline Structure Editing")
19078 ("U" . org-shiftmetaup)
19079 ("D" . org-shiftmetadown)
19080 ("r" . org-metaright)
19081 ("l" . org-metaleft)
19082 ("R" . org-shiftmetaright)
19083 ("L" . org-shiftmetaleft)
19084 ("i" . (progn (forward-char 1) (call-interactively
19085 'org-insert-heading-respect-content)))
19086 ("^" . org-sort)
19087 ("w" . org-refile)
19088 ("a" . org-archive-subtree-default-with-confirmation)
19089 ("@" . org-mark-subtree)
19090 ("#" . org-toggle-comment)
19091 ("Clock Commands")
19092 ("I" . org-clock-in)
19093 ("O" . org-clock-out)
19094 ("Meta Data Editing")
19095 ("t" . org-todo)
19096 ("," . (org-priority))
19097 ("0" . (org-priority ?\ ))
19098 ("1" . (org-priority ?A))
19099 ("2" . (org-priority ?B))
19100 ("3" . (org-priority ?C))
19101 (":" . org-set-tags-command)
19102 ("e" . org-set-effort)
19103 ("E" . org-inc-effort)
19104 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19105 (org-entry-put (point) "APPT_WARNTIME" m)))
19106 ("Agenda Views etc")
19107 ("v" . org-agenda)
19108 ("/" . org-sparse-tree)
19109 ("Misc")
19110 ("o" . org-open-at-point)
19111 ("?" . org-speed-command-help)
19112 ("<" . (org-agenda-set-restriction-lock 'subtree))
19113 (">" . (org-agenda-remove-restriction-lock))
19114 )
19115 "The default speed commands.")
19117 (defun org-print-speed-command (e)
19118 (if (> (length (car e)) 1)
19119 (progn
19121 (princ (car e))
19123 (princ (make-string (length (car e)) ?-))
19125 (princ (car e))
19126 (princ " ")
19127 (if (symbolp (cdr e))
19128 (princ (symbol-name (cdr e)))
19129 (prin1 (cdr e)))
19132 (defun org-speed-command-help ()
19133 "Show the available speed commands."
19134 (interactive)
19135 (if (not org-use-speed-commands)
19136 (error "Speed commands are not activated, customize `org-use-speed-commands'")
19137 (with-output-to-temp-buffer "*Help*"
19139 (mapc 'org-print-speed-command org-speed-commands-user)
19142 (mapc 'org-print-speed-command org-speed-commands-default))
19143 (with-current-buffer "*Help*"
19144 (setq truncate-lines t))))
19146 (defun org-speed-move-safe (cmd)
19147 "Execute CMD, but make sure that the cursor always ends up in a headline.
19148 If not, return to the original position and throw an error."
19149 (interactive)
19150 (let ((pos (point)))
19151 (call-interactively cmd)
19152 (unless (and (bolp) (org-at-heading-p))
19153 (goto-char pos)
19154 (error "Boundary reached while executing %s" cmd))))
19156 (defvar org-self-insert-command-undo-counter 0)
19158 (defvar org-table-auto-blank-field) ; defined in org-table.el
19159 (defvar org-speed-command nil)
19161 (define-obsolete-function-alias
19162 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19164 (defun org-speed-command-activate (keys)
19165 "Hook for activating single-letter speed commands.
19166 `org-speed-commands-default' specifies a minimal command set.
19167 Use `org-speed-commands-user' for further customization."
19168 (when (or (and (bolp) (looking-at org-outline-regexp))
19169 (and (functionp org-use-speed-commands)
19170 (funcall org-use-speed-commands)))
19171 (cdr (assoc keys (append org-speed-commands-user
19172 org-speed-commands-default)))))
19174 (define-obsolete-function-alias
19175 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19177 (defun org-babel-speed-command-activate (keys)
19178 "Hook for activating single-letter code block commands."
19179 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19180 (cdr (assoc keys org-babel-key-bindings))))
19182 (defcustom org-speed-command-hook
19183 '(org-speed-command-default-hook org-babel-speed-command-hook)
19184 "Hook for activating speed commands at strategic locations.
19185 Hook functions are called in sequence until a valid handler is
19186 found.
19188 Each hook takes a single argument, a user-pressed command key
19189 which is also a `self-insert-command' from the global map.
19191 Within the hook, examine the cursor position and the command key
19192 and return nil or a valid handler as appropriate. Handler could
19193 be one of an interactive command, a function, or a form.
19195 Set `org-use-speed-commands' to non-nil value to enable this
19196 hook. The default setting is `org-speed-command-activate'."
19197 :group 'org-structure
19198 :version "24.1"
19199 :type 'hook)
19201 (defun org-self-insert-command (N)
19202 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19203 If the cursor is in a table looking at whitespace, the whitespace is
19204 overwritten, and the table is not marked as requiring realignment."
19205 (interactive "p")
19206 (org-check-before-invisible-edit 'insert)
19207 (cond
19208 ((and org-use-speed-commands
19209 (setq org-speed-command
19210 (run-hook-with-args-until-success
19211 'org-speed-command-hook (this-command-keys))))
19212 (cond
19213 ((commandp org-speed-command)
19214 (setq this-command org-speed-command)
19215 (call-interactively org-speed-command))
19216 ((functionp org-speed-command)
19217 (funcall org-speed-command))
19218 ((and org-speed-command (listp org-speed-command))
19219 (eval org-speed-command))
19220 (t (let (org-use-speed-commands)
19221 (call-interactively 'org-self-insert-command)))))
19222 ((and
19223 (org-table-p)
19224 (progn
19225 ;; check if we blank the field, and if that triggers align
19226 (and (featurep 'org-table) org-table-auto-blank-field
19227 (member last-command
19228 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
19230 ;; got extra space, this field does not determine column width
19231 (let (org-table-may-need-update) (org-table-blank-field))
19232 ;; no extra space, this field may determine column width
19233 (org-table-blank-field)))
19234 t)
19235 (eq N 1)
19237 (let (org-table-may-need-update)
19238 (goto-char (1- (match-end 0)))
19239 (backward-delete-char 1)
19240 (goto-char (match-beginning 0))
19241 (self-insert-command N)))
19242 (t
19243 (setq org-table-may-need-update t)
19244 (self-insert-command N)
19245 (org-fix-tags-on-the-fly)
19246 (if org-self-insert-cluster-for-undo
19247 (if (not (eq last-command 'org-self-insert-command))
19248 (setq org-self-insert-command-undo-counter 1)
19249 (if (>= org-self-insert-command-undo-counter 20)
19250 (setq org-self-insert-command-undo-counter 1)
19251 (and (> org-self-insert-command-undo-counter 0)
19252 buffer-undo-list (listp buffer-undo-list)
19253 (not (cadr buffer-undo-list)) ; remove nil entry
19254 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19255 (setq org-self-insert-command-undo-counter
19256 (1+ org-self-insert-command-undo-counter))))))))
19258 (defun org-check-before-invisible-edit (kind)
19259 "Check is editing if kind KIND would be dangerous with invisible text around.
19260 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19261 ;; First, try to get out of here as quickly as possible, to reduce overhead
19262 (if (and org-catch-invisible-edits
19263 (or (not (boundp 'visible-mode)) (not visible-mode))
19264 (or (get-char-property (point) 'invisible)
19265 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19266 ;; OK, we need to take a closer look
19267 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19268 (invisible-before-point (if (bobp) nil (get-char-property
19269 (1- (point)) 'invisible)))
19270 (border-and-ok-direction
19271 (or
19272 ;; Check if we are acting predictably before invisible text
19273 (and invisible-at-point (not invisible-before-point)
19274 (memq kind '(insert delete-backward)))
19275 ;; Check if we are acting predictably after invisible text
19276 ;; This works not well, and I have turned it off. It seems
19277 ;; better to always show and stop after invisible text.
19278 ;; (and (not invisible-at-point) invisible-before-point
19279 ;; (memq kind '(insert delete)))
19280 )))
19281 (when (or (memq invisible-at-point '(outline org-hide-block t))
19282 (memq invisible-before-point '(outline org-hide-block t)))
19283 (if (eq org-catch-invisible-edits 'error)
19284 (error "Editing in invisible areas is prohibited - make visible first"))
19285 (if (and org-custom-properties-overlays
19286 (y-or-n-p "Display invisible properties in this buffer? "))
19287 (org-toggle-custom-properties-visibility)
19288 ;; Make the area visible
19289 (save-excursion
19290 (if invisible-before-point
19291 (goto-char (previous-single-char-property-change
19292 (point) 'invisible)))
19293 (org-cycle))
19294 (cond
19295 ((eq org-catch-invisible-edits 'show)
19296 ;; That's it, we do the edit after showing
19297 (message
19298 "Unfolding invisible region around point before editing")
19299 (sit-for 1))
19300 ((and (eq org-catch-invisible-edits 'smart)
19301 border-and-ok-direction)
19302 (message "Unfolding invisible region around point before editing"))
19303 (t
19304 ;; Don't do the edit, make the user repeat it in full visibility
19305 (error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19307 (defun org-fix-tags-on-the-fly ()
19308 (when (and (equal (char-after (point-at-bol)) ?*)
19309 (org-at-heading-p))
19310 (org-align-tags-here org-tags-column)))
19312 (defun org-delete-backward-char (N)
19313 "Like `delete-backward-char', insert whitespace at field end in tables.
19314 When deleting backwards, in tables this function will insert whitespace in
19316 still be marked for re-alignment if the field did fill the entire column,
19317 because, in this case the deletion might narrow the column."
19318 (interactive "p")
19319 (save-match-data
19320 (org-check-before-invisible-edit 'delete-backward)
19321 (if (and (org-table-p)
19322 (eq N 1)
19323 (string-match "|" (buffer-substring (point-at-bol) (point)))
19324 (looking-at ".*?|"))
19325 (let ((pos (point))
19327 (c org-table-may-need-update))
19328 (backward-delete-char N)
19329 (if (not overwrite-mode)
19330 (progn
19331 (skip-chars-forward "^|")
19332 (insert " ")
19333 (goto-char (1- pos))))
19334 ;; noalign: if there were two spaces at the end, this field
19335 ;; does not determine the width of the column.
19336 (if noalign (setq org-table-may-need-update c)))
19337 (backward-delete-char N)
19338 (org-fix-tags-on-the-fly))))
19340 (defun org-delete-char (N)
19341 "Like `delete-char', but insert whitespace at field end in tables.
19342 When deleting characters, in tables this function will insert whitespace in
19344 still be marked for re-alignment if the field did fill the entire column,
19345 because, in this case the deletion might narrow the column."
19346 (interactive "p")
19347 (save-match-data
19348 (org-check-before-invisible-edit 'delete)
19349 (if (and (org-table-p)
19350 (not (bolp))
19351 (not (= (char-after) ?|))
19352 (eq N 1))
19353 (if (looking-at ".*?|")
19354 (let ((pos (point))
19356 (c org-table-may-need-update))
19357 (replace-match
19358 (concat (substring (match-string 0) 1 -1) " |") nil t)
19359 (goto-char pos)
19360 ;; noalign: if there were two spaces at the end, this field
19361 ;; does not determine the width of the column.
19362 (if noalign (setq org-table-may-need-update c)))
19363 (delete-char N))
19364 (delete-char N)
19365 (org-fix-tags-on-the-fly))))
19367 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19368 (put 'org-self-insert-command 'delete-selection t)
19369 (put 'orgtbl-self-insert-command 'delete-selection t)
19370 (put 'org-delete-char 'delete-selection 'supersede)
19371 (put 'org-delete-backward-char 'delete-selection 'supersede)
19372 (put 'org-yank 'delete-selection 'yank)
19374 ;; Make `flyspell-mode' delay after some commands
19375 (put 'org-self-insert-command 'flyspell-delayed t)
19376 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
19377 (put 'org-delete-char 'flyspell-delayed t)
19378 (put 'org-delete-backward-char 'flyspell-delayed t)
19380 ;; Make pabbrev-mode expand after org-mode commands
19381 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
19382 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
19384 ;; How to do this: Measure non-white length of current string
19385 ;; If equal to column width, we should realign.
19387 (defun org-remap (map &rest commands)
19388 "In MAP, remap the functions given in COMMANDS.
19389 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
19390 (let (new old)
19391 (while commands
19392 (setq old (pop commands) new (pop commands))
19393 (if (fboundp 'command-remapping)
19394 (org-defkey map (vector 'remap old) new)
19395 (substitute-key-definition old new map global-map)))))
19397 (defun org-transpose-words ()
19398 "Transpose words for Org.
19399 This uses the `org-mode-transpose-word-syntax-table' syntax
19400 table, which interprets characters in `org-emphasis-alist' as
19401 word constituants."
19402 (interactive)
19403 (with-syntax-table org-mode-transpose-word-syntax-table
19404 (call-interactively 'transpose-words)))
19405 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
19407 (when (eq org-enable-table-editor 'optimized)
19408 ;; If the user wants maximum table support, we need to hijack
19409 ;; some standard editing functions
19410 (org-remap org-mode-map
19411 'self-insert-command 'org-self-insert-command
19412 'delete-char 'org-delete-char
19413 'delete-backward-char 'org-delete-backward-char)
19414 (org-defkey org-mode-map "|" 'org-force-self-insert))
19416 (defvar org-ctrl-c-ctrl-c-hook nil
19417 "Hook for functions attaching themselves to `C-c C-c'.
19419 This can be used to add additional functionality to the C-c C-c
19420 key which executes context-dependent commands. This hook is run
19421 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
19422 run after the last test.
19424 Each function will be called with no arguments. The function
19425 must check if the context is appropriate for it to act. If yes,
19426 it should do its thing and then return a non-nil value. If the
19427 context is wrong, just do nothing and return nil.")
19429 (defvar org-ctrl-c-ctrl-c-final-hook nil
19430 "Hook for functions attaching themselves to `C-c C-c'.
19432 This can be used to add additional functionality to the C-c C-c
19433 key which executes context-dependent commands. This hook is run
19434 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
19435 before the first test.
19437 Each function will be called with no arguments. The function
19438 must check if the context is appropriate for it to act. If yes,
19439 it should do its thing and then return a non-nil value. If the
19440 context is wrong, just do nothing and return nil.")
19442 (defvar org-tab-first-hook nil
19443 "Hook for functions to attach themselves to TAB.
19444 See `org-ctrl-c-ctrl-c-hook' for more information.
19445 This hook runs as the first action when TAB is pressed, even before
19446 `org-cycle' messes around with the `outline-regexp' to cater for
19447 inline tasks and plain list item folding.
19448 If any function in this hook returns t, any other actions that
19449 would have been caused by TAB (such as table field motion or visibility
19450 cycling) will not occur.")
19452 (defvar org-tab-after-check-for-table-hook nil
19453 "Hook for functions to attach themselves to TAB.
19454 See `org-ctrl-c-ctrl-c-hook' for more information.
19455 This hook runs after it has been established that the cursor is not in a
19456 table, but before checking if the cursor is in a headline or if global cycling
19457 should be done.
19458 If any function in this hook returns t, not other actions like visibility
19459 cycling will be done.")
19461 (defvar org-tab-after-check-for-cycling-hook nil
19462 "Hook for functions to attach themselves to TAB.
19463 See `org-ctrl-c-ctrl-c-hook' for more information.
19464 This hook runs after it has been established that not table field motion and
19465 not visibility should be done because of current context. This is probably
19466 the place where a package like yasnippets can hook in.")
19468 (defvar org-tab-before-tab-emulation-hook nil
19469 "Hook for functions to attach themselves to TAB.
19470 See `org-ctrl-c-ctrl-c-hook' for more information.
19471 This hook runs after every other options for TAB have been exhausted, but
19474 (defvar org-metaleft-hook nil
19475 "Hook for functions attaching themselves to `M-left'.
19476 See `org-ctrl-c-ctrl-c-hook' for more information.")
19477 (defvar org-metaright-hook nil
19478 "Hook for functions attaching themselves to `M-right'.
19479 See `org-ctrl-c-ctrl-c-hook' for more information.")
19480 (defvar org-metaup-hook nil
19481 "Hook for functions attaching themselves to `M-up'.
19482 See `org-ctrl-c-ctrl-c-hook' for more information.")
19483 (defvar org-metadown-hook nil
19484 "Hook for functions attaching themselves to `M-down'.
19485 See `org-ctrl-c-ctrl-c-hook' for more information.")
19486 (defvar org-shiftmetaleft-hook nil
19487 "Hook for functions attaching themselves to `M-S-left'.
19488 See `org-ctrl-c-ctrl-c-hook' for more information.")
19489 (defvar org-shiftmetaright-hook nil
19490 "Hook for functions attaching themselves to `M-S-right'.
19491 See `org-ctrl-c-ctrl-c-hook' for more information.")
19492 (defvar org-shiftmetaup-hook nil
19493 "Hook for functions attaching themselves to `M-S-up'.
19494 See `org-ctrl-c-ctrl-c-hook' for more information.")
19495 (defvar org-shiftmetadown-hook nil
19496 "Hook for functions attaching themselves to `M-S-down'.
19497 See `org-ctrl-c-ctrl-c-hook' for more information.")
19498 (defvar org-metareturn-hook nil
19499 "Hook for functions attaching themselves to `M-RET'.
19500 See `org-ctrl-c-ctrl-c-hook' for more information.")
19501 (defvar org-shiftup-hook nil
19502 "Hook for functions attaching themselves to `S-up'.
19503 See `org-ctrl-c-ctrl-c-hook' for more information.")
19504 (defvar org-shiftup-final-hook nil
19505 "Hook for functions attaching themselves to `S-up'.
19506 This one runs after all other options except shift-select have been excluded.
19507 See `org-ctrl-c-ctrl-c-hook' for more information.")
19508 (defvar org-shiftdown-hook nil
19509 "Hook for functions attaching themselves to `S-down'.
19510 See `org-ctrl-c-ctrl-c-hook' for more information.")
19511 (defvar org-shiftdown-final-hook nil
19512 "Hook for functions attaching themselves to `S-down'.
19513 This one runs after all other options except shift-select have been excluded.
19514 See `org-ctrl-c-ctrl-c-hook' for more information.")
19515 (defvar org-shiftleft-hook nil
19516 "Hook for functions attaching themselves to `S-left'.
19517 See `org-ctrl-c-ctrl-c-hook' for more information.")
19518 (defvar org-shiftleft-final-hook nil
19519 "Hook for functions attaching themselves to `S-left'.
19520 This one runs after all other options except shift-select have been excluded.
19521 See `org-ctrl-c-ctrl-c-hook' for more information.")
19522 (defvar org-shiftright-hook nil
19523 "Hook for functions attaching themselves to `S-right'.
19524 See `org-ctrl-c-ctrl-c-hook' for more information.")
19525 (defvar org-shiftright-final-hook nil
19526 "Hook for functions attaching themselves to `S-right'.
19527 This one runs after all other options except shift-select have been excluded.
19528 See `org-ctrl-c-ctrl-c-hook' for more information.")
19530 (defun org-modifier-cursor-error ()
19531 "Throw an error, a modified cursor command was applied in wrong context."
19532 (error "This command is active in special context like tables, headlines or items"))
19534 (defun org-shiftselect-error ()
19535 "Throw an error because Shift-Cursor command was applied in wrong context."
19536 (if (and (boundp 'shift-select-mode) shift-select-mode)
19537 (error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
19538 (error "This command works only in special context like headlines or timestamps")))
19540 (defun org-call-for-shift-select (cmd)
19541 (let ((this-command-keys-shift-translated t))
19542 (call-interactively cmd)))
19544 (defun org-shifttab (&optional arg)
19545 "Global visibility cycling or move to previous table field.
19546 Calls `org-cycle' with argument t, or `org-table-previous-field', depending
19547 on context.
19548 See the individual commands for more information."
19549 (interactive "P")
19550 (cond
19551 ((org-at-table-p) (call-interactively 'org-table-previous-field))
19552 ((integerp arg)
19553 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
19554 (message "Content view to level: %d" arg)
19555 (org-content (prefix-numeric-value arg2))
19556 (setq org-cycle-global-status 'overview)))
19557 (t (call-interactively 'org-global-cycle))))
19559 (defun org-shiftmetaleft ()
19560 "Promote subtree or delete table column.
19561 Calls `org-promote-subtree', `org-outdent-item-tree', or
19562 `org-table-delete-column', depending on context. See the
19563 individual commands for more information."
19564 (interactive)
19565 (cond
19566 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
19567 ((org-at-table-p) (call-interactively 'org-table-delete-column))
19568 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
19569 ((if (not (org-region-active-p)) (org-at-item-p)
19570 (save-excursion (goto-char (region-beginning))
19571 (org-at-item-p)))
19572 (call-interactively 'org-outdent-item-tree))
19573 (t (org-modifier-cursor-error))))
19575 (defun org-shiftmetaright ()
19576 "Demote subtree or insert table column.
19577 Calls `org-demote-subtree', `org-indent-item-tree', or
19578 `org-table-insert-column', depending on context. See the
19579 individual commands for more information."
19580 (interactive)
19581 (cond
19582 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
19583 ((org-at-table-p) (call-interactively 'org-table-insert-column))
19584 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
19585 ((if (not (org-region-active-p)) (org-at-item-p)
19586 (save-excursion (goto-char (region-beginning))
19587 (org-at-item-p)))
19588 (call-interactively 'org-indent-item-tree))
19589 (t (org-modifier-cursor-error))))
19591 (defun org-shiftmetaup (&optional arg)
19592 "Move subtree up or kill table row.
19593 Calls `org-move-subtree-up' or `org-table-kill-row' or
19594 `org-move-item-up' or `org-timestamp-up', depending on context.
19595 See the individual commands for more information."
19596 (interactive "P")
19597 (cond
19598 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
19599 ((org-at-table-p) (call-interactively 'org-table-kill-row))
19600 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19601 ((org-at-item-p) (call-interactively 'org-move-item-up))
19602 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19603 (call-interactively 'org-timestamp-up)))
19604 (t (call-interactively 'org-drag-line-backward))))
19606 (defun org-shiftmetadown (&optional arg)
19607 "Move subtree down or insert table row.
19608 Calls `org-move-subtree-down' or `org-table-insert-row' or
19609 `org-move-item-down' or `org-timestamp-up', depending on context.
19610 See the individual commands for more information."
19611 (interactive "P")
19612 (cond
19613 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
19614 ((org-at-table-p) (call-interactively 'org-table-insert-row))
19615 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19616 ((org-at-item-p) (call-interactively 'org-move-item-down))
19617 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19618 (call-interactively 'org-timestamp-down)))
19619 (t (call-interactively 'org-drag-line-forward))))
19621 (defsubst org-hidden-tree-error ()
19622 (error
19623 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
19625 (defun org-metaleft (&optional arg)
19626 "Promote heading or move table column to left.
19627 Calls `org-do-promote' or `org-table-move-column', depending on context.
19628 With no specific context, calls the Emacs default `backward-word'.
19629 See the individual commands for more information."
19630 (interactive "P")
19631 (cond
19632 ((run-hook-with-args-until-success 'org-metaleft-hook))
19633 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
19634 ((org-with-limited-levels
19635 (or (org-at-heading-p)
19636 (and (org-region-active-p)
19637 (save-excursion
19638 (goto-char (region-beginning))
19639 (org-at-heading-p)))))
19640 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19641 (call-interactively 'org-do-promote))
19642 ;; At an inline task.
19643 ((org-at-heading-p)
19644 (call-interactively 'org-inlinetask-promote))
19645 ((or (org-at-item-p)
19646 (and (org-region-active-p)
19647 (save-excursion
19648 (goto-char (region-beginning))
19649 (org-at-item-p))))
19650 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19651 (call-interactively 'org-outdent-item))
19652 (t (call-interactively 'backward-word))))
19654 (defun org-metaright (&optional arg)
19655 "Demote a subtree, a list item or move table column to right.
19656 In front of a drawer or a block keyword, indent it correctly.
19657 With no specific context, calls the Emacs default `forward-word'.
19658 See the individual commands for more information."
19659 (interactive "P")
19660 (cond
19661 ((run-hook-with-args-until-success 'org-metaright-hook))
19662 ((org-at-table-p) (call-interactively 'org-table-move-column))
19663 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
19664 ((org-at-block-p) (call-interactively 'org-indent-block))
19665 ((org-with-limited-levels
19666 (or (org-at-heading-p)
19667 (and (org-region-active-p)
19668 (save-excursion
19669 (goto-char (region-beginning))
19670 (org-at-heading-p)))))
19671 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19672 (call-interactively 'org-do-demote))
19673 ;; At an inline task.
19674 ((org-at-heading-p)
19675 (call-interactively 'org-inlinetask-demote))
19676 ((or (org-at-item-p)
19677 (and (org-region-active-p)
19678 (save-excursion
19679 (goto-char (region-beginning))
19680 (org-at-item-p))))
19681 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19682 (call-interactively 'org-indent-item))
19683 (t (call-interactively 'forward-word))))
19685 (defun org-check-for-hidden (what)
19686 "Check if there are hidden headlines/items in the current visual line.
19687 WHAT can be either `headlines' or `items'. If the current line is
19688 an outline or item heading and it has a folded subtree below it,
19689 this function returns t, nil otherwise."
19690 (let ((re (cond
19691 ((eq what 'headlines) org-outline-regexp-bol)
19692 ((eq what 'items) (org-item-beginning-re))
19693 (t (error "This should not happen"))))
19694 beg end)
19695 (save-excursion
19696 (catch 'exit
19697 (unless (org-region-active-p)
19698 (setq beg (point-at-bol))
19699 (beginning-of-line 2)
19700 (while (and (not (eobp)) ;; this is like `next-line'
19701 (get-char-property (1- (point)) 'invisible))
19702 (beginning-of-line 2))
19703 (setq end (point))
19704 (goto-char beg)
19705 (goto-char (point-at-eol))
19706 (setq end (max end (point)))
19707 (while (re-search-forward re end t)
19708 (if (get-char-property (match-beginning 0) 'invisible)
19709 (throw 'exit t))))
19710 nil))))
19712 (defun org-metaup (&optional arg)
19713 "Move subtree up or move table row up.
19714 Calls `org-move-subtree-up' or `org-table-move-row' or
19715 `org-move-item-up', depending on context. See the individual commands
19716 for more information."
19717 (interactive "P")
19718 (cond
19719 ((run-hook-with-args-until-success 'org-metaup-hook))
19720 ((org-region-active-p)
19721 (let* ((a (min (region-beginning) (region-end)))
19722 (b (1- (max (region-beginning) (region-end))))
19723 (c (save-excursion (goto-char a)
19724 (move-beginning-of-line 0)))
19725 (d (save-excursion (goto-char a)
19726 (move-end-of-line 0) (point))))
19727 (transpose-regions a b c d)
19728 (goto-char c)))
19729 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
19730 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19731 ((org-at-item-p) (call-interactively 'org-move-item-up))
19732 (t (org-drag-element-backward))))
19734 (defun org-metadown (&optional arg)
19735 "Move subtree down or move table row down.
19736 Calls `org-move-subtree-down' or `org-table-move-row' or
19737 `org-move-item-down', depending on context. See the individual
19738 commands for more information."
19739 (interactive "P")
19740 (cond
19741 ((run-hook-with-args-until-success 'org-metadown-hook))
19742 ((org-region-active-p)
19743 (let* ((a (min (region-beginning) (region-end)))
19744 (b (max (region-beginning) (region-end)))
19745 (c (save-excursion (goto-char b)
19746 (move-beginning-of-line 1)))
19747 (d (save-excursion (goto-char b)
19748 (move-end-of-line 1) (1+ (point)))))
19749 (transpose-regions a b c d)
19750 (goto-char d)))
19751 ((org-at-table-p) (call-interactively 'org-table-move-row))
19752 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19753 ((org-at-item-p) (call-interactively 'org-move-item-down))
19754 (t (org-drag-element-forward))))
19756 (defun org-shiftup (&optional arg)
19757 "Increase item in timestamp or increase priority of current headline.
19758 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
19759 depending on context. See the individual commands for more information."
19760 (interactive "P")
19761 (cond
19762 ((run-hook-with-args-until-success 'org-shiftup-hook))
19763 ((and org-support-shift-select (org-region-active-p))
19764 (org-call-for-shift-select 'previous-line))
19765 ((org-at-timestamp-p t)
19766 (call-interactively (if org-edit-timestamp-down-means-later
19767 'org-timestamp-down 'org-timestamp-up)))
19768 ((and (not (eq org-support-shift-select 'always))
19769 org-enable-priority-commands
19770 (org-at-heading-p))
19771 (call-interactively 'org-priority-up))
19772 ((and (not org-support-shift-select) (org-at-item-p))
19773 (call-interactively 'org-previous-item))
19774 ((org-clocktable-try-shift 'up arg))
19775 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
19776 (org-support-shift-select
19777 (org-call-for-shift-select 'previous-line))
19778 (t (org-shiftselect-error))))
19780 (defun org-shiftdown (&optional arg)
19781 "Decrease item in timestamp or decrease priority of current headline.
19782 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
19783 depending on context. See the individual commands for more information."
19784 (interactive "P")
19785 (cond
19786 ((run-hook-with-args-until-success 'org-shiftdown-hook))
19787 ((and org-support-shift-select (org-region-active-p))
19788 (org-call-for-shift-select 'next-line))
19789 ((org-at-timestamp-p t)
19790 (call-interactively (if org-edit-timestamp-down-means-later
19791 'org-timestamp-up 'org-timestamp-down)))
19792 ((and (not (eq org-support-shift-select 'always))
19793 org-enable-priority-commands
19794 (org-at-heading-p))
19795 (call-interactively 'org-priority-down))
19796 ((and (not org-support-shift-select) (org-at-item-p))
19797 (call-interactively 'org-next-item))
19798 ((org-clocktable-try-shift 'down arg))
19799 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
19800 (org-support-shift-select
19801 (org-call-for-shift-select 'next-line))
19802 (t (org-shiftselect-error))))
19804 (defun org-shiftright (&optional arg)
19805 "Cycle the thing at point or in the current line, depending on context.
19806 Depending on context, this does one of the following:
19808 - switch a timestamp at point one day into the future
19809 - on a headline, switch to the next TODO keyword.
19810 - on an item, switch entire list to the next bullet type
19811 - on a property line, switch to the next allowed value
19812 - on a clocktable definition line, move time block into the future"
19813 (interactive "P")
19814 (cond
19815 ((run-hook-with-args-until-success 'org-shiftright-hook))
19816 ((and org-support-shift-select (org-region-active-p))
19817 (org-call-for-shift-select 'forward-char))
19818 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
19819 ((and (not (eq org-support-shift-select 'always))
19820 (org-at-heading-p))
19821 (let ((org-inhibit-logging
19822 (not org-treat-S-cursor-todo-selection-as-state-change))
19823 (org-inhibit-blocking
19824 (not org-treat-S-cursor-todo-selection-as-state-change)))
19825 (org-call-with-arg 'org-todo 'right)))
19826 ((or (and org-support-shift-select
19827 (not (eq org-support-shift-select 'always))
19828 (org-at-item-bullet-p))
19829 (and (not org-support-shift-select) (org-at-item-p)))
19830 (org-call-with-arg 'org-cycle-list-bullet nil))
19831 ((and (not (eq org-support-shift-select 'always))
19832 (org-at-property-p))
19833 (call-interactively 'org-property-next-allowed-value))
19834 ((org-clocktable-try-shift 'right arg))
19835 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
19836 (org-support-shift-select
19837 (org-call-for-shift-select 'forward-char))
19838 (t (org-shiftselect-error))))
19840 (defun org-shiftleft (&optional arg)
19841 "Cycle the thing at point or in the current line, depending on context.
19842 Depending on context, this does one of the following:
19844 - switch a timestamp at point one day into the past
19845 - on a headline, switch to the previous TODO keyword.
19846 - on an item, switch entire list to the previous bullet type
19847 - on a property line, switch to the previous allowed value
19848 - on a clocktable definition line, move time block into the past"
19849 (interactive "P")
19850 (cond
19851 ((run-hook-with-args-until-success 'org-shiftleft-hook))
19852 ((and org-support-shift-select (org-region-active-p))
19853 (org-call-for-shift-select 'backward-char))
19854 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
19855 ((and (not (eq org-support-shift-select 'always))
19856 (org-at-heading-p))
19857 (let ((org-inhibit-logging
19858 (not org-treat-S-cursor-todo-selection-as-state-change))
19859 (org-inhibit-blocking
19860 (not org-treat-S-cursor-todo-selection-as-state-change)))
19861 (org-call-with-arg 'org-todo 'left)))
19862 ((or (and org-support-shift-select
19863 (not (eq org-support-shift-select 'always))
19864 (org-at-item-bullet-p))
19865 (and (not org-support-shift-select) (org-at-item-p)))
19866 (org-call-with-arg 'org-cycle-list-bullet 'previous))
19867 ((and (not (eq org-support-shift-select 'always))
19868 (org-at-property-p))
19869 (call-interactively 'org-property-previous-allowed-value))
19870 ((org-clocktable-try-shift 'left arg))
19871 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
19872 (org-support-shift-select
19873 (org-call-for-shift-select 'backward-char))
19874 (t (org-shiftselect-error))))
19876 (defun org-shiftcontrolright ()
19877 "Switch to next TODO set."
19878 (interactive)
19879 (cond
19880 ((and org-support-shift-select (org-region-active-p))
19881 (org-call-for-shift-select 'forward-word))
19882 ((and (not (eq org-support-shift-select 'always))
19883 (org-at-heading-p))
19884 (org-call-with-arg 'org-todo 'nextset))
19885 (org-support-shift-select
19886 (org-call-for-shift-select 'forward-word))
19887 (t (org-shiftselect-error))))
19889 (defun org-shiftcontrolleft ()
19890 "Switch to previous TODO set."
19891 (interactive)
19892 (cond
19893 ((and org-support-shift-select (org-region-active-p))
19894 (org-call-for-shift-select 'backward-word))
19895 ((and (not (eq org-support-shift-select 'always))
19896 (org-at-heading-p))
19897 (org-call-with-arg 'org-todo 'previousset))
19898 (org-support-shift-select
19899 (org-call-for-shift-select 'backward-word))
19900 (t (org-shiftselect-error))))
19902 (defun org-shiftcontrolup (&optional n)
19903 "Change timestamps synchronously up in CLOCK log lines.
19904 Optional argument N tells to change by that many units."
19905 (interactive "P")
19906 (cond ((and (not org-support-shift-select)
19907 (org-at-clock-log-p)
19908 (org-at-timestamp-p t))
19909 (org-clock-timestamps-up n))
19910 (t (org-shiftselect-error))))
19912 (defun org-shiftcontroldown (&optional n)
19913 "Change timestamps synchronously down in CLOCK log lines.
19914 Optional argument N tells to change by that many units."
19915 (interactive "P")
19916 (cond ((and (not org-support-shift-select)
19917 (org-at-clock-log-p)
19918 (org-at-timestamp-p t))
19919 (org-clock-timestamps-down n))
19920 (t (org-shiftselect-error))))
19922 (defun org-ctrl-c-ret ()
19923 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
19924 (interactive)
19925 (cond
19926 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
19927 (t (call-interactively 'org-insert-heading))))
19929 (defun org-find-visible ()
19930 (let ((s (point)))
19931 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
19932 (get-char-property s 'invisible)))
19933 s))
19934 (defun org-find-invisible ()
19935 (let ((s (point)))
19936 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
19937 (not (get-char-property s 'invisible))))
19938 s))
19940 (defun org-copy-visible (beg end)
19941 "Copy the visible parts of the region."
19942 (interactive "r")
19943 (let (snippets s)
19944 (save-excursion
19945 (save-restriction
19946 (narrow-to-region beg end)
19947 (setq s (goto-char (point-min)))
19948 (while (not (= (point) (point-max)))
19949 (goto-char (org-find-invisible))
19950 (push (buffer-substring s (point)) snippets)
19951 (setq s (goto-char (org-find-visible))))))
19952 (kill-new (apply 'concat (nreverse snippets)))))
19954 (defun org-copy-special ()
19955 "Copy region in table or copy current subtree.
19956 Calls `org-table-copy' or `org-copy-subtree', depending on context.
19957 See the individual commands for more information."
19958 (interactive)
19959 (call-interactively
19960 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
19962 (defun org-cut-special ()
19963 "Cut region in table or cut current subtree.
19964 Calls `org-table-copy' or `org-cut-subtree', depending on context.
19965 See the individual commands for more information."
19966 (interactive)
19967 (call-interactively
19968 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
19970 (defun org-paste-special (arg)
19971 "Paste rectangular region into table, or past subtree relative to level.
19972 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
19973 See the individual commands for more information."
19974 (interactive "P")
19975 (if (org-at-table-p)
19976 (org-table-paste-rectangle)
19977 (org-paste-subtree arg)))
19979 (defsubst org-in-fixed-width-region-p ()
19980 "Is point in a fixed-width region?"
19981 (save-match-data
19982 (eq 'fixed-width (org-element-type (org-element-at-point)))))
19984 (defun org-edit-special (&optional arg)
19985 "Call a special editor for the element at point.
19986 When at a table, call the formula editor with `org-table-edit-formulas'.
19987 When in a source code block, call `org-edit-src-code'.
19988 When in a fixed-width region, call `org-edit-fixed-width-region'.
19989 When at an #+INCLUDE keyword, visit the included file.
19990 On a link, call `ffap' to visit the link at point.
19991 Otherwise, return a user error."
19992 (interactive "P")
19993 (let ((element (org-element-at-point)))
19994 (assert (not buffer-read-only) nil
19995 "Buffer is read-only: %s" (buffer-name))
19996 (case (org-element-type element)
19997 (src-block
19998 (if (not arg) (org-edit-src-code)
19999 (let* ((info (org-babel-get-src-block-info))
20000 (lang (nth 0 info))
20001 (params (nth 2 info))
20002 (session (cdr (assq :session params))))
20003 (if (not session) (org-edit-src-code)
20004 ;; At a src-block with a session and function called with
20005 ;; an ARG: switch to the buffer related to the inferior
20006 ;; process.
20007 (switch-to-buffer
20008 (funcall (intern (concat "org-babel-prep-session:" lang))
20009 session params))))))
20010 (keyword
20011 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20012 (find-file
20013 (org-remove-double-quotes
20014 (car (org-split-string (org-element-property :value element)))))
20015 (user-error "No special environment to edit here")))
20016 (table
20017 (if (eq (org-element-property :type element) 'table.el)
20018 (org-edit-src-code)
20019 (call-interactively 'org-table-edit-formulas)))
20020 ;; Only Org tables contain `table-row' type elements.
20021 (table-row (call-interactively 'org-table-edit-formulas))
20022 ((example-block export-block) (org-edit-src-code))
20023 (fixed-width (org-edit-fixed-width-region))
20024 (otherwise
20025 ;; No notable element at point. Though, we may be at a link,
20026 ;; which is an object. Thus, scan deeper.
20027 (if (eq (org-element-type (org-element-context element)) 'link)
20028 (call-interactively 'ffap)
20029 (user-error "No special environment to edit here"))))))
20031 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20032 (defun org-ctrl-c-ctrl-c (&optional arg)
20033 "Set tags in headline, or update according to changed information at point.
20035 This command does many different things, depending on context:
20037 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20038 this is what we do.
20040 - If the cursor is on a statistics cookie, update it.
20042 - If the cursor is in a headline, prompt for tags and insert them
20043 into the current line, aligned to `org-tags-column'. When called
20044 with prefix arg, realign all tags in the current buffer.
20046 - If the cursor is in one of the special #+KEYWORD lines, this
20047 triggers scanning the buffer for these lines and updating the
20048 information.
20050 - If the cursor is inside a table, realign the table. This command
20051 works even if the automatic table editor has been turned off.
20053 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20054 the entire table.
20056 - If the cursor is at a footnote reference or definition, jump to
20057 the corresponding definition or references, respectively.
20059 - If the cursor is a the beginning of a dynamic block, update it.
20061 - If the current buffer is a capture buffer, close note and file it.
20063 - If the cursor is on a <<<target>>>, update radio targets and
20064 corresponding links in this buffer.
20066 - If the cursor is on a numbered item in a plain list, renumber the
20067 ordered list.
20069 - If the cursor is on a checkbox, toggle it.
20071 - If the cursor is on a code block, evaluate it. The variable
20072 `org-confirm-babel-evaluate' can be used to control prompting
20073 before code block evaluation, by default every code block
20074 evaluation requires confirmation. Code block evaluation can be
20075 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20076 (interactive "P")
20077 (cond
20078 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20079 org-occur-highlights
20080 org-latex-fragment-image-overlays)
20081 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20082 (org-remove-occur-highlights)
20083 (org-remove-latex-fragment-image-overlays)
20084 (message "Temporary highlights/overlays removed from current buffer"))
20085 ((and (local-variable-p 'org-finish-function (current-buffer))
20086 (fboundp org-finish-function))
20087 (funcall org-finish-function))
20088 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20089 (t
20090 (let* ((context (org-element-context)) (type (org-element-type context)))
20091 ;; Test if point is within a blank line.
20093 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20094 (user-error "C-c C-c can do nothing useful at this location"))
20095 ;; For convenience: at the first line of a paragraph on the
20096 ;; same line as an item, apply function on that item instead.
20097 (when (eq type 'paragraph)
20098 (let ((parent (org-element-property :parent context)))
20099 (when (and (eq (org-element-type parent) 'item)
20100 (= (point-at-bol) (org-element-property :begin parent)))
20101 (setq context parent type 'item))))
20102 ;; Act according to type of element or object at point.
20103 (case type
20104 (clock (org-clock-update-time-maybe))
20105 (dynamic-block
20106 (save-excursion
20107 (goto-char (org-element-property :post-affiliated context))
20108 (org-update-dblock)))
20109 (footnote-definition
20110 (goto-char (org-element-property :post-affiliated context))
20111 (call-interactively 'org-footnote-action))
20112 (footnote-reference (call-interactively 'org-footnote-action))
20113 ((headline inlinetask)
20114 (save-excursion (goto-char (org-element-property :begin context))
20115 (call-interactively 'org-set-tags)))
20116 (item
20117 ;; At an item: a double C-u set checkbox to "[-]"
20118 ;; unconditionally, whereas a single one will toggle its
20119 ;; presence. Without an universal argument, if the item
20120 ;; has a checkbox, toggle it. Otherwise repair the list.
20121 (let* ((box (org-element-property :checkbox context))
20122 (struct (org-element-property :structure context))
20123 (old-struct (copy-tree struct))
20124 (parents (org-list-parents-alist struct))
20125 (prevs (org-list-prevs-alist struct))
20126 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20127 (org-list-set-checkbox
20128 (org-element-property :begin context) struct
20129 (cond ((equal arg '(16)) "[-]")
20130 ((and (not box) (equal arg '(4))) "[ ]")
20131 ((or (not box) (equal arg '(4))) nil)
20132 ((eq box 'on) "[ ]")
20133 (t "[X]")))
20134 ;; Mimic `org-list-write-struct' but with grabbing
20135 ;; a return value from `org-list-struct-fix-box'.
20136 (org-list-struct-fix-ind struct parents 2)
20137 (org-list-struct-fix-item-end struct)
20138 (org-list-struct-fix-bul struct prevs)
20139 (org-list-struct-fix-ind struct parents)
20140 (let ((block-item
20141 (org-list-struct-fix-box struct parents prevs orderedp)))
20142 (if (and box (equal struct old-struct))
20143 (if (equal arg '(16))
20144 (message "Checkboxes already reset")
20145 (user-error "Cannot toggle this checkbox: %s"
20146 (if (eq box 'on)
20147 "all subitems checked"
20148 "unchecked subitems")))
20149 (org-list-struct-apply-struct struct old-struct)
20150 (org-update-checkbox-count-maybe))
20151 (when block-item
20152 (message "Checkboxes were removed due to empty box at line %d"
20153 (org-current-line block-item))))))
20154 (keyword
20155 (let ((org-inhibit-startup-visibility-stuff t)
20156 (org-startup-align-all-tables nil))
20157 (when (boundp 'org-table-coordinate-overlays)
20158 (mapc 'delete-overlay org-table-coordinate-overlays)
20159 (setq org-table-coordinate-overlays nil))
20160 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20161 (message "Local setup has been refreshed"))
20162 (plain-list
20163 ;; At a plain list, with a double C-u argument, set
20164 ;; checkboxes of each item to "[-]", whereas a single one
20165 ;; will toggle their presence according to the state of the
20166 ;; first item in the list. Without an argument, repair the
20167 ;; list.
20168 (let* ((begin (org-element-property :contents-begin context))
20169 (beginm (move-marker (make-marker) begin))
20170 (struct (org-element-property :structure context))
20171 (old-struct (copy-tree struct))
20172 (first-box (save-excursion
20173 (goto-char begin)
20174 (looking-at org-list-full-item-re)
20175 (match-string-no-properties 3)))
20176 (new-box (cond ((equal arg '(16)) "[-]")
20177 ((equal arg '(4)) (unless first-box "[ ]"))
20178 ((equal first-box "[X]") "[ ]")
20179 (t "[X]"))))
20180 (cond
20181 (arg
20182 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20183 (org-list-get-all-items
20184 begin struct (org-list-prevs-alist struct))))
20185 ((and first-box (eq (point) begin))
20186 ;; For convenience, when point is at bol on the first
20187 ;; item of the list and no argument is provided, simply
20188 ;; toggle checkbox of that item, if any.
20189 (org-list-set-checkbox begin struct new-box)))
20190 (org-list-write-struct
20191 struct (org-list-parents-alist struct) old-struct)
20192 (org-update-checkbox-count-maybe)
20193 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20194 ((property-drawer node-property)
20195 (call-interactively 'org-property-action))
20196 ((radio-target target)
20197 (call-interactively 'org-update-radio-target-regexp))
20198 (statistics-cookie
20199 (call-interactively 'org-update-statistics-cookies))
20200 ((table table-cell table-row)
20201 ;; At a table, recalculate every field and align it. Also
20202 ;; send the table if necessary. If the table has
20203 ;; a `table.el' type, just give up. At a table row or
20204 ;; cell, maybe recalculate line but always align table.
20205 (if (eq (org-element-property :type context) 'table.el)
20206 (message "Use C-c ' to edit table.el tables")
20207 (let ((org-enable-table-editor t))
20208 (if (or (eq type 'table)
20209 ;; Check if point is at a TBLFM line.
20210 (and (eq type 'table-row)
20211 (= (point) (org-element-property :end context))))
20212 (save-excursion
20213 (if (org-at-TBLFM-p) (org-calc-current-TBLFM)
20214 (goto-char (org-element-property :contents-begin context))
20215 (org-call-with-arg 'org-table-recalculate (or arg t))
20216 (orgtbl-send-table 'maybe)))
20217 (org-table-maybe-eval-formula)
20218 (cond (arg (call-interactively 'org-table-recalculate))
20219 ((org-table-maybe-recalculate-line))
20220 (t (org-table-align)))))))
20221 (timestamp (org-timestamp-change 0 'day))
20222 (otherwise
20223 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20224 (user-error
20225 "C-c C-c can do nothing useful at this location")))))))))
20227 (defun org-mode-restart ()
20228 "Restart Org-mode, to scan again for special lines.
20229 Also updates the keyword regular expressions."
20230 (interactive)
20231 (org-mode)
20232 (message "Org-mode restarted"))
20234 (defun org-kill-note-or-show-branches ()
20235 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20236 (interactive)
20237 (if (not org-finish-function)
20238 (progn
20239 (hide-subtree)
20240 (call-interactively 'show-branches))
20241 (let ((org-note-abort t))
20242 (funcall org-finish-function))))
20244 (defun org-ctrl-o (n)
20245 "Insert a new row in tables, call `open-line' elsewhere."
20246 (interactive "*p")
20247 (if (org-at-table-p)
20248 (org-table-insert-row)
20249 (open-line n)))
20251 (defun org-return (&optional indent)
20252 "Goto next table row or insert a newline.
20253 Calls `org-table-next-row' or `newline', depending on context.
20254 See the individual commands for more information."
20255 (interactive)
20256 (let (org-ts-what)
20257 (cond
20258 ((or (bobp) (org-in-src-block-p))
20259 (if indent (newline-and-indent) (newline)))
20260 ((org-at-table-p)
20261 (org-table-justify-field-maybe)
20262 (call-interactively 'org-table-next-row))
20263 ;; when `newline-and-indent' is called within a list, make sure
20264 ;; text moved stays inside the item.
20265 ((and (org-in-item-p) indent)
20266 (if (and (org-at-item-p) (>= (point) (match-end 0)))
20267 (progn
20268 (save-match-data (newline))
20269 (org-indent-line-to (length (match-string 0))))
20270 (let ((ind (org-get-indentation)))
20271 (newline)
20272 (if (org-looking-back org-list-end-re)
20273 (org-indent-line)
20274 (org-indent-line-to ind)))))
20275 ((and org-return-follows-link
20276 (org-at-timestamp-p t)
20277 (not (eq org-ts-what 'after)))
20278 (org-follow-timestamp-link))
20279 ((and org-return-follows-link
20280 (let ((tprop (get-text-property (point) 'face)))
20281 (or (eq tprop 'org-link)
20282 (and (listp tprop) (memq 'org-link tprop)))))
20283 (call-interactively 'org-open-at-point))
20284 ((and (org-at-heading-p)
20285 (looking-at
20287 (org-show-entry)
20288 (end-of-line 1)
20289 (newline))
20290 (t (if indent (newline-and-indent) (newline))))))
20292 (defun org-return-indent ()
20293 "Goto next table row or insert a newline and indent.
20294 Calls `org-table-next-row' or `newline-and-indent', depending on
20295 context. See the individual commands for more information."
20296 (interactive)
20297 (org-return t))
20299 (defun org-ctrl-c-star ()
20300 "Compute table, or change heading status of lines.
20301 Calls `org-table-recalculate' or `org-toggle-heading',
20302 depending on context."
20303 (interactive)
20304 (cond
20305 ((org-at-table-p)
20306 (call-interactively 'org-table-recalculate))
20307 (t
20308 ;; Convert all lines in region to list items
20309 (call-interactively 'org-toggle-heading))))
20311 (defun org-ctrl-c-minus ()
20312 "Insert separator line in table or modify bullet status of line.
20313 Also turns a plain line or a region of lines into list items.
20314 Calls `org-table-insert-hline', `org-toggle-item', or
20315 `org-cycle-list-bullet', depending on context."
20316 (interactive)
20317 (cond
20318 ((org-at-table-p)
20319 (call-interactively 'org-table-insert-hline))
20320 ((org-region-active-p)
20321 (call-interactively 'org-toggle-item))
20322 ((org-in-item-p)
20323 (call-interactively 'org-cycle-list-bullet))
20324 (t
20325 (call-interactively 'org-toggle-item))))
20327 (defun org-toggle-item (arg)
20328 "Convert headings or normal lines to items, items to normal lines.
20329 If there is no active region, only the current line is considered.
20331 If the first non blank line in the region is a headline, convert
20332 all headlines to items, shifting text accordingly.
20334 If it is an item, convert all items to normal lines.
20336 If it is normal text, change region into a list of items.
20337 With a prefix argument ARG, change the region in a single item."
20338 (interactive "P")
20339 (let ((shift-text
20340 (function
20341 ;; Shift text in current section to IND, from point to END.
20342 ;; The function leaves point to END line.
20343 (lambda (ind end)
20344 (let ((min-i 1000) (end (copy-marker end)))
20345 ;; First determine the minimum indentation (MIN-I) of
20346 ;; the text.
20347 (save-excursion
20348 (catch 'exit
20349 (while (< (point) end)
20350 (let ((i (org-get-indentation)))
20351 (cond
20352 ;; Skip blank lines and inline tasks.
20354 ((looking-at org-outline-regexp-bol))
20355 ;; We can't find less than 0 indentation.
20356 ((zerop i) (throw 'exit (setq min-i 0)))
20357 ((< i min-i) (setq min-i i))))
20358 (forward-line))))
20359 ;; Then indent each line so that a line indented to
20360 ;; MIN-I becomes indented to IND. Ignore blank lines
20361 ;; and inline tasks in the process.
20362 (let ((delta (- ind min-i)))
20363 (while (< (point) end)
20365 (looking-at org-outline-regexp-bol))
20366 (org-indent-line-to (+ (org-get-indentation) delta)))
20367 (forward-line)))))))
20368 (skip-blanks
20369 (function
20370 ;; Return beginning of first non-blank line, starting from
20371 ;; line at POS.
20372 (lambda (pos)
20373 (save-excursion
20374 (goto-char pos)
20376 (point-at-bol)))))
20377 beg end)
20378 ;; Determine boundaries of changes.
20379 (if (org-region-active-p)
20380 (setq beg (funcall skip-blanks (region-beginning))
20381 end (copy-marker (region-end)))
20382 (setq beg (funcall skip-blanks (point-at-bol))
20383 end (copy-marker (point-at-eol))))
20384 ;; Depending on the starting line, choose an action on the text
20385 ;; between BEG and END.
20386 (org-with-limited-levels
20387 (save-excursion
20388 (goto-char beg)
20389 (cond
20390 ;; Case 1. Start at an item: de-itemize. Note that it only
20391 ;; happens when a region is active: `org-ctrl-c-minus'
20392 ;; would call `org-cycle-list-bullet' otherwise.
20393 ((org-at-item-p)
20394 (while (< (point) end)
20395 (when (org-at-item-p)
20397 (delete-region (point) (match-end 0)))
20398 (forward-line)))
20399 ;; Case 2. Start at an heading: convert to items.
20400 ((org-at-heading-p)
20401 (let* ((bul (org-list-bullet-string "-"))
20402 (bul-len (length bul))
20403 ;; Indentation of the first heading. It should be
20404 ;; relative to the indentation of its parent, if any.
20405 (start-ind (save-excursion
20406 (cond
20407 ((not org-adapt-indentation) 0)
20408 ((not (outline-previous-heading)) 0)
20409 (t (length (match-string 0))))))
20410 ;; Level of first heading. Further headings will be
20411 ;; compared to it to determine hierarchy in the list.
20412 (ref-level (org-reduced-level (org-outline-level))))
20413 (while (< (point) end)
20414 (let* ((level (org-reduced-level (org-outline-level)))
20415 (delta (max 0 (- level ref-level))))
20416 ;; If current headline is less indented than the first
20417 ;; one, set it as reference, in order to preserve
20418 ;; subtrees.
20419 (when (< level ref-level) (setq ref-level level))
20420 (replace-match bul t t)
20421 (org-indent-line-to (+ start-ind (* delta bul-len)))
20422 ;; Ensure all text down to END (or SECTION-END) belongs
20423 ;; to the newly created item.
20424 (let ((section-end (save-excursion
20425 (or (outline-next-heading) (point)))))
20426 (forward-line)
20427 (funcall shift-text
20428 (+ start-ind (* (1+ delta) bul-len))
20429 (min end section-end)))))))
20430 ;; Case 3. Normal line with ARG: make the first line of region
20431 ;; an item, and shift indentation of others lines to
20432 ;; set them as item's body.
20433 (arg (let* ((bul (org-list-bullet-string "-"))
20434 (bul-len (length bul))
20435 (ref-ind (org-get-indentation)))
20437 (insert bul)
20438 (forward-line)
20439 (while (< (point) end)
20440 ;; Ensure that lines less indented than first one
20441 ;; still get included in item body.
20442 (funcall shift-text
20443 (+ ref-ind bul-len)
20444 (min end (save-excursion (or (outline-next-heading)
20445 (point)))))
20446 (forward-line))))
20447 ;; Case 4. Normal line without ARG: turn each non-item line
20448 ;; into an item.
20449 (t
20450 (while (< (point) end)
20451 (unless (or (org-at-heading-p) (org-at-item-p))
20453 (replace-match
20455 (forward-line))))))))
20457 (defun org-toggle-heading (&optional nstars)
20458 "Convert headings to normal text, or items or text to headings.
20459 If there is no active region, only convert the current line.
20462 point into heading.
20464 In a region:
20466 - If the first non blank line is a headline, remove the stars
20467 from all headlines in the region.
20469 - If it is a normal line, turn each and every normal line (i.e.,
20470 not an heading or an item) in the region into headings. If you
20471 want to convert only the first line of this region, use one
20472 universal prefix argument.
20474 - If it is a plain list item, turn all plain list items into headings.
20476 When converting a line into a heading, the number of stars is chosen
20477 such that the lines become children of the current entry. However,
20478 when a numeric prefix argument is given, its value determines the
20479 number of stars to add."
20480 (interactive "P")
20481 (let ((skip-blanks
20482 (function
20483 ;; Return beginning of first non-blank line, starting from
20484 ;; line at POS.
20485 (lambda (pos)
20486 (save-excursion
20487 (goto-char pos)
20488 (while (org-at-comment-p) (forward-line))
20490 (point-at-bol)))))
20491 beg end toggled)
20492 ;; Determine boundaries of changes. If a universal prefix has
20493 ;; been given, put the list in a region. If region ends at a bol,
20494 ;; do not consider the last line to be in the region.
20496 (when (and current-prefix-arg (org-at-item-p))
20497 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
20498 (org-mark-element))
20500 (if (org-region-active-p)
20501 (setq beg (funcall skip-blanks (region-beginning))
20502 end (copy-marker (save-excursion
20503 (goto-char (region-end))
20504 (if (bolp) (point) (point-at-eol)))))
20505 (setq beg (funcall skip-blanks (point-at-bol))
20506 end (copy-marker (point-at-eol))))
20507 ;; Ensure inline tasks don't count as headings.
20508 (org-with-limited-levels
20509 (save-excursion
20510 (goto-char beg)
20511 (cond
20512 ;; Case 1. Started at an heading: de-star headings.
20513 ((org-at-heading-p)
20514 (while (< (point) end)
20515 (when (org-at-heading-p t)
20516 (looking-at org-outline-regexp) (replace-match "")
20517 (setq toggled t))
20518 (forward-line)))
20519 ;; Case 2. Started at an item: change items into headlines.
20520 ;; One star will be added by `org-list-to-subtree'.
20521 ((org-at-item-p)
20522 (let* ((stars (make-string
20523 ;; subtract the star that will be added again by
20524 ;; `org-list-to-subtree'
20525 (if (numberp nstars) (1- nstars)
20526 (or (org-current-level) 0))
20527 ?*))
20528 (add-stars
20529 (cond (nstars "") ; stars from prefix only
20530 ((equal stars "") "") ; before first heading
20531 (org-odd-levels-only "*") ; inside heading, odd
20532 (t "")))) ; inside heading, oddeven
20533 (while (< (point) end)
20534 (when (org-at-item-p)
20535 ;; Pay attention to cases when region ends before list.
20536 (let* ((struct (org-list-struct))
20537 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
20538 (save-restriction
20539 (narrow-to-region (point) list-end)
20540 (insert
20541 (org-list-to-subtree
20542 (org-list-parse-list t)
20543 '(:istart (concat stars add-stars (funcall get-stars depth))
20544 :icount (concat stars add-stars (funcall get-stars depth)))))))
20545 (setq toggled t))
20546 (forward-line))))
20547 ;; Case 3. Started at normal text: make every line an heading,
20548 ;; skipping headlines and items.
20549 (t (let* ((stars
20550 (make-string
20551 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
20552 (add-stars
20553 (cond (nstars "") ; stars from prefix only
20554 ((equal stars "") "*") ; before first heading
20555 (org-odd-levels-only "**") ; inside heading, odd
20556 (t "*"))) ; inside heading, oddeven
20557 (rpl (concat stars add-stars " "))
20558 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
20559 (while (< (point) (if (equal nstars '(4)) lend end))
20560 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
20562 (replace-match (concat rpl (match-string 2))) (setq toggled t))
20563 (forward-line)))))))
20564 (unless toggled (message "Cannot toggle heading from here"))))
20566 (defun org-meta-return (&optional arg)
20567 "Insert a new heading or wrap a region in a table.
20568 Calls `org-insert-heading' or `org-table-wrap-region', depending on context.
20569 See the individual commands for more information."
20570 (interactive "P")
20571 (cond
20572 ((run-hook-with-args-until-success 'org-metareturn-hook))
20573 ((or (org-at-drawer-p) (org-at-property-p))
20574 (newline-and-indent))
20575 ((org-at-table-p)
20576 (call-interactively 'org-table-wrap-region))
20577 (t (call-interactively 'org-insert-heading))))
20579 ;;; Menu entries
20581 (defsubst org-in-subtree-not-table-p ()
20582 "Are we in a subtree and not in a table?"
20583 (and (not (org-before-first-heading-p))
20584 (not (org-at-table-p))))
20586 ;; Define the Org-mode menus
20587 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
20588 '("Tbl"
20589 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
20590 ["Next Field" org-cycle (org-at-table-p)]
20591 ["Previous Field" org-shifttab (org-at-table-p)]
20592 ["Next Row" org-return (org-at-table-p)]
20593 "--"
20594 ["Blank Field" org-table-blank-field (org-at-table-p)]
20595 ["Edit Field" org-table-edit-field (org-at-table-p)]
20596 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
20597 "--"
20598 ("Column"
20599 ["Move Column Left" org-metaleft (org-at-table-p)]
20600 ["Move Column Right" org-metaright (org-at-table-p)]
20601 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
20602 ["Insert Column" org-shiftmetaright (org-at-table-p)])
20603 ("Row"
20604 ["Move Row Up" org-metaup (org-at-table-p)]
20605 ["Move Row Down" org-metadown (org-at-table-p)]
20606 ["Delete Row" org-shiftmetaup (org-at-table-p)]
20607 ["Insert Row" org-shiftmetadown (org-at-table-p)]
20608 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
20609 "--"
20610 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
20611 ("Rectangle"
20612 ["Copy Rectangle" org-copy-special (org-at-table-p)]
20613 ["Cut Rectangle" org-cut-special (org-at-table-p)]
20614 ["Paste Rectangle" org-paste-special (org-at-table-p)]
20615 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
20616 "--"
20617 ("Calculate"
20618 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
20619 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
20620 ["Edit Formulas" org-edit-special (org-at-table-p)]
20621 "--"
20622 ["Recalculate line" org-table-recalculate (org-at-table-p)]
20623 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
20624 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
20625 "--"
20626 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
20627 "--"
20628 ["Sum Column/Rectangle" org-table-sum
20629 (or (org-at-table-p) (org-region-active-p))]
20630 ["Which Column?" org-table-current-column (org-at-table-p)])
20631 ["Debug Formulas"
20632 org-table-toggle-formula-debugger
20633 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
20634 ["Show Col/Row Numbers"
20635 org-table-toggle-coordinate-overlays
20636 :style toggle
20637 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
20638 "--"
20639 ["Create" org-table-create (and (not (org-at-table-p))
20640 org-enable-table-editor)]
20641 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
20642 ["Import from File" org-table-import (not (org-at-table-p))]
20643 ["Export to File" org-table-export (org-at-table-p)]
20644 "--"
20645 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
20647 (easy-menu-define org-org-menu org-mode-map "Org menu"
20648 '("Org"
20649 ("Show/Hide"
20650 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
20651 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
20652 ["Sparse Tree..." org-sparse-tree t]
20653 ["Reveal Context" org-reveal t]
20654 ["Show All" show-all t]
20655 "--"
20656 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
20657 "--"
20658 ["New Heading" org-insert-heading t]
20659 ("Navigate Headings"
20660 ["Up" outline-up-heading t]
20661 ["Next" outline-next-visible-heading t]
20662 ["Previous" outline-previous-visible-heading t]
20663 ["Next Same Level" outline-forward-same-level t]
20664 ["Previous Same Level" outline-backward-same-level t]
20665 "--"
20666 ["Jump" org-goto t])
20667 ("Edit Structure"
20668 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
20669 "--"
20670 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
20671 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
20672 "--"
20673 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
20674 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
20675 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
20676 "--"
20677 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
20678 "--"
20679 ["Copy visible text" org-copy-visible t]
20680 "--"
20681 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
20682 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
20683 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
20684 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
20685 "--"
20686 ["Sort Region/Children" org-sort t]
20687 "--"
20688 ["Convert to odd levels" org-convert-to-odd-levels t]
20689 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
20690 ("Editing"
20691 ["Emphasis..." org-emphasize t]
20692 ["Edit Source Example" org-edit-special t]
20693 "--"
20694 ["Footnote new/jump" org-footnote-action t]
20695 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
20696 ("Archive"
20697 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
20698 "--"
20699 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
20700 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
20701 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
20702 )
20703 "--"
20704 ("Hyperlinks"
20705 ["Store Link (Global)" org-store-link t]
20706 ["Find existing link to here" org-occur-link-in-agenda-files t]
20707 ["Insert Link" org-insert-link t]
20708 ["Follow Link" org-open-at-point t]
20709 "--"
20710 ["Next link" org-next-link t]
20711 ["Previous link" org-previous-link t]
20712 "--"
20713 ["Descriptive Links"
20714 org-toggle-link-display
20715 :style radio
20716 :selected org-descriptive-links
20717 ]
20718 ["Literal Links"
20719 org-toggle-link-display
20720 :style radio
20721 :selected (not org-descriptive-links)])
20722 "--"
20723 ("TODO Lists"
20724 ["TODO/DONE/-" org-todo t]
20725 ("Select keyword"
20726 ["Next keyword" org-shiftright (org-at-heading-p)]
20727 ["Previous keyword" org-shiftleft (org-at-heading-p)]
20728 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
20729 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
20730 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
20731 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
20732 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
20733 "--"
20734 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
20735 :selected org-enforce-todo-dependencies :style toggle :active t]
20736 "Settings for tree at point"
20737 ["Do Children sequentially" org-toggle-ordered-property :style radio
20738 :selected (org-entry-get nil "ORDERED")
20739 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20740 ["Do Children parallel" org-toggle-ordered-property :style radio
20741 :selected (not (org-entry-get nil "ORDERED"))
20742 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
20743 "--"
20744 ["Set Priority" org-priority t]
20745 ["Priority Up" org-shiftup t]
20746 ["Priority Down" org-shiftdown t]
20747 "--"
20748 ["Get news from all feeds" org-feed-update-all t]
20749 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
20750 ["Customize feeds" (customize-variable 'org-feed-alist) t])
20751 ("TAGS and Properties"
20752 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
20753 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
20754 "--"
20755 ["Set property" org-set-property (not (org-before-first-heading-p))]
20756 ["Column view of properties" org-columns t]
20757 ["Insert Column View DBlock" org-insert-columns-dblock t])
20758 ("Dates and Scheduling"
20759 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
20760 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
20761 ("Change Date"
20762 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
20763 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
20764 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
20765 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
20766 ["Compute Time Range" org-evaluate-time-range t]
20767 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
20768 ["Deadline" org-deadline (not (org-before-first-heading-p))]
20769 "--"
20770 ["Custom time format" org-toggle-time-stamp-overlays
20771 :style radio :selected org-display-custom-times]
20772 "--"
20773 ["Goto Calendar" org-goto-calendar t]
20774 ["Date from Calendar" org-date-from-calendar t]
20775 "--"
20776 ["Start/Restart Timer" org-timer-start t]
20777 ["Pause/Continue Timer" org-timer-pause-or-continue t]
20778 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
20779 ["Insert Timer String" org-timer t]
20780 ["Insert Timer Item" org-timer-item t])
20781 ("Logging work"
20782 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
20783 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
20784 ["Clock out" org-clock-out t]
20785 ["Clock cancel" org-clock-cancel t]
20786 "--"
20787 ["Mark as default task" org-clock-mark-default-task t]
20788 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
20789 ["Goto running clock" org-clock-goto t]
20790 "--"
20791 ["Display times" org-clock-display t]
20792 ["Create clock table" org-clock-report t]
20793 "--"
20794 ["Record DONE time"
20795 (progn (setq org-log-done (not org-log-done))
20796 (message "Switching to %s will %s record a timestamp"
20797 (car org-done-keywords)
20798 (if org-log-done "automatically" "not")))
20799 :style toggle :selected org-log-done])
20800 "--"
20801 ["Agenda Command..." org-agenda t]
20802 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
20803 ("File List for Agenda")
20804 ("Special views current file"
20805 ["TODO Tree" org-show-todo-tree t]
20806 ["Check Deadlines" org-check-deadlines t]
20807 ["Timeline" org-timeline t]
20808 ["Tags/Property tree" org-match-sparse-tree t])
20809 "--"
20810 ["Export/Publish..." org-export-dispatch t]
20811 ("LaTeX"
20812 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
20813 :selected org-cdlatex-mode]
20814 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
20815 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
20816 ["Modify math symbol" org-cdlatex-math-modify
20817 (org-inside-LaTeX-fragment-p)]
20818 ["Insert citation" org-reftex-citation t]
20819 "--"
20820 ["Template for BEAMER" (org-beamer-insert-options-template) t])
20821 "--"
20822 ("MobileOrg"
20823 ["Push Files and Views" org-mobile-push t]
20824 ["Get Captured and Flagged" org-mobile-pull t]
20825 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
20826 "--"
20827 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
20828 "--"
20829 ("Documentation"
20830 ["Show Version" org-version t]
20831 ["Info Documentation" org-info t])
20832 ("Customize"
20833 ["Browse Org Group" org-customize t]
20834 "--"
20835 ["Expand This Menu" org-create-customize-menu
20836 (fboundp 'customize-menu-create)])
20837 ["Send bug report" org-submit-bug-report t]
20838 "--"
20839 ("Refresh/Reload"
20840 ["Refresh setup current buffer" org-mode-restart t]
20841 ["Reload Org (after update)" org-reload t]
20842 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
20843 ))
20845 (defun org-info (&optional node)
20846 "Read documentation for Org-mode in the info system.
20847 With optional NODE, go directly to that node."
20848 (interactive)
20849 (info (format "(org)%s" (or node ""))))
20851 ;;;###autoload
20852 (defun org-submit-bug-report ()
20853 "Submit a bug report on Org-mode via mail.
20855 Don't hesitate to report any problems or inaccurate documentation.
20857 If you don't have setup sending mail from (X)Emacs, please copy the
20858 output buffer into your mail program, as it gives us important
20859 information about your Org-mode version and configuration."
20860 (interactive)
20861 (require 'reporter)
20862 (org-load-modules-maybe)
20863 (org-require-autoloaded-modules)
20864 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
20865 (reporter-submit-bug-report
20866 "emacs-orgmode@gnu.org"
20867 (org-version nil 'full)
20868 (let (list)
20869 (save-window-excursion
20870 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
20871 (delete-other-windows)
20872 (erase-buffer)
20873 (insert "You are about to submit a bug report to the Org-mode mailing list.
20875 We would like to add your full Org-mode and Outline configuration to the
20876 bug report. This greatly simplifies the work of the maintainer and
20877 other experts on the mailing list.
20879 HOWEVER, some variables you have customized may contain private
20880 information. The names of customers, colleagues, or friends, might
20881 appear in the form of file names, tags, todo states, or search strings.
20882 If you answer yes to the prompt, you might want to check and remove
20883 such private information before sending the email.")
20884 (add-text-properties (point-min) (point-max) '(face org-warning))
20885 (when (yes-or-no-p "Include your Org-mode configuration ")
20886 (mapatoms
20887 (lambda (v)
20888 (and (boundp v)
20890 (or (and (symbol-value v)
20892 (and
20893 (get v 'custom-type) (get v 'standard-value)
20894 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
20895 (push v list)))))
20896 (kill-buffer (get-buffer "*Warn about privacy*"))
20897 list))
20898 nil nil
20899 "Remember to cover the basics, that is, what you expected to happen and
20900 what in fact did happen. You don't know how to make a good report? See
20902 http://orgmode.org/manual/Feedback.html#Feedback
20904 Your bug report will be posted to the Org-mode mailing list.
20905 ------------------------------------------------------------------------")
20906 (save-excursion
20911 (defun org-install-agenda-files-menu ()
20912 (let ((bl (buffer-list)))
20913 (save-excursion
20914 (while bl
20915 (set-buffer (pop bl))
20916 (if (derived-mode-p 'org-mode) (setq bl nil)))
20917 (when (derived-mode-p 'org-mode)
20918 (easy-menu-change
20919 '("Org") "File List for Agenda"
20920 (append
20921 (list
20922 ["Edit File List" (org-edit-agenda-file-list) t]
20923 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
20924 ["Remove Current File from List" org-remove-file t]
20925 ["Cycle through agenda files" org-cycle-agenda-files t]
20926 ["Occur in all agenda files" org-occur-in-agenda-files t]
20927 "--")
20928 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
20930 ;;;; Documentation
20932 (defun org-require-autoloaded-modules ()
20933 (interactive)
20934 (mapc 'require
20935 '(org-agenda org-archive org-attach org-clock org-colview org-id
20936 org-remember org-table org-timer)))
20938 ;;;###autoload
20939 (defun org-reload (&optional uncompiled)
20940 "Reload all org lisp files.
20941 With prefix arg UNCOMPILED, load the uncompiled versions."
20942 (interactive "P")
20943 (require 'loadhist)
20944 (let* ((org-dir (org-find-library-dir "org"))
20945 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
20947 (remove-re (mapconcat 'identity
20948 (mapcar (lambda (f) (concat "^" f "$"))
20949 (list (if (featurep 'xemacs)
20950 "org-colview"
20951 "org-colview-xemacs")
20952 "org" "org-loaddefs" "org-version"))
20954 (feats (delete-dups
20955 (mapcar 'file-name-sans-extension
20956 (mapcar 'file-name-nondirectory
20957 (delq nil
20958 (mapcar 'feature-file
20959 features))))))
20960 (lfeat (append
20961 (sort
20962 (setq feats
20963 (delq nil (mapcar
20964 (lambda (f)
20965 (if (and (string-match feature-re f)
20966 (not (string-match remove-re f)))
20967 f nil))
20968 feats)))
20969 'string-lessp)
20970 (list "org-version" "org")))
20971 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
20972 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
20973 load-uncore load-misses)
20974 (setq load-misses
20975 (delq 't
20976 (mapcar (lambda (f)
20977 (or (org-load-noerror-mustsuffix (concat org-dir f))
20978 (and (string= org-dir contrib-dir)
20979 (org-load-noerror-mustsuffix (concat contrib-dir f)))
20980 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
20981 (add-to-list 'load-uncore f 'append)
20982 't)
20983 f))
20984 lfeat)))
20985 (if load-uncore
20987 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
20988 (if load-misses
20990 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
20993 ;;;###autoload
20994 (defun org-customize ()
20995 "Call the customize function with org as argument."
20996 (interactive)
20997 (org-load-modules-maybe)
20998 (org-require-autoloaded-modules)
20999 (customize-browse 'org))
21001 (defun org-create-customize-menu ()
21002 "Create a full customization menu for Org-mode, insert it into the menu."
21003 (interactive)
21004 (org-load-modules-maybe)
21005 (org-require-autoloaded-modules)
21006 (if (fboundp 'customize-menu-create)
21007 (progn
21008 (easy-menu-change
21009 '("Org") "Customize"
21010 `(["Browse Org group" org-customize t]
21011 "--"
21012 ,(customize-menu-create 'org)
21013 ["Set" Custom-set t]
21014 ["Save" Custom-save t]
21015 ["Reset to Current" Custom-reset-current t]
21016 ["Reset to Saved" Custom-reset-saved t]
21017 ["Reset to Standard Settings" Custom-reset-standard t]))
21019 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21021 ;;;; Miscellaneous stuff
21023 ;;; Generally useful functions
21025 (defun org-get-at-bol (property)
21026 "Get text property PROPERTY at beginning of line."
21027 (get-text-property (point-at-bol) property))
21029 (defun org-find-text-property-in-string (prop s)
21030 "Return the first non-nil value of property PROP in string S."
21031 (or (get-text-property 0 prop s)
21032 (get-text-property (or (next-single-property-change 0 prop s) 0)
21033 prop s)))
21035 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21036 "Display the given MESSAGE as a warning."
21037 (if (fboundp 'display-warning)
21038 (display-warning 'org message
21039 (if (featurep 'xemacs) 'warning :warning))
21040 (let ((buf (get-buffer-create "*Org warnings*")))
21041 (with-current-buffer buf
21042 (goto-char (point-max))
21043 (insert "Warning (Org): " message)
21044 (unless (bolp)
21045 (newline)))
21046 (display-buffer buf)
21047 (sit-for 0))))
21049 (defun org-eval (form)
21050 "Eval FORM and return result."
21051 (condition-case error
21052 (eval form)
21053 (error (format "%%![Error: %s]" error))))
21055 (defun org-in-clocktable-p ()
21056 "Check if the cursor is in a clocktable."
21057 (let ((pos (point)) start)
21058 (save-excursion
21059 (end-of-line 1)
21061 (setq start (match-beginning 0))
21063 (>= (match-end 0) pos)
21064 start))))
21066 (defun org-in-commented-line ()
21067 "Is point in a line starting with `#'?"
21068 (equal (char-after (point-at-bol)) ?#))
21070 (defun org-in-indented-comment-line ()
21071 "Is point in a line starting with `#' after some white space?"
21072 (save-excursion
21073 (save-match-data
21074 (goto-char (point-at-bol))
21077 (defun org-in-verbatim-emphasis ()
21078 (save-match-data
21079 (and (org-in-regexp org-emph-re 2)
21080 (>= (point) (match-beginning 3))
21081 (<= (point) (match-end 4))
21082 (member (match-string 3) '("=" "~")))))
21084 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21085 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21086 (if (and marker (marker-buffer marker)
21087 (buffer-live-p (marker-buffer marker)))
21088 (progn
21089 (org-pop-to-buffer-same-window (marker-buffer marker))
21090 (if (or (> marker (point-max)) (< marker (point-min)))
21091 (widen))
21092 (goto-char marker)
21093 (org-show-context 'org-goto))
21094 (if bookmark
21095 (bookmark-jump bookmark)
21096 (error "Cannot find location"))))
21098 (defun org-quote-csv-field (s)
21099 "Quote field for inclusion in CSV material."
21102 s))
21104 (defun org-force-self-insert (N)
21105 "Needed to enforce self-insert under remapping."
21106 (interactive "p")
21107 (self-insert-command N))
21109 (defun org-string-width (s)
21110 "Compute width of string, ignoring invisible characters.
21111 This ignores character with invisibility property `org-link', and also
21112 characters with property `org-cwidth', because these will become invisible
21113 upon the next fontification round."
21114 (let (b l)
21115 (when (or (eq t buffer-invisibility-spec)
21116 (assq 'org-link buffer-invisibility-spec))
21117 (while (setq b (text-property-any 0 (length s)
21118 'invisible 'org-link s))
21119 (setq s (concat (substring s 0 b)
21120 (substring s (or (next-single-property-change
21121 b 'invisible s) (length s)))))))
21122 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21123 (setq s (concat (substring s 0 b)
21124 (substring s (or (next-single-property-change
21125 b 'org-cwidth s) (length s))))))
21126 (setq l (string-width s) b -1)
21127 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21128 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21129 l))
21131 (defun org-shorten-string (s maxlength)
21132 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21133 If the string is shorter or has length MAXLENGTH, just return the
21134 original string. If it is longer, the functions finds a space in the
21135 string, breaks this string off at that locations and adds three dots
21136 as ellipsis. Including the ellipsis, the string will not be longer
21137 than MAXLENGTH. If finding a good breaking point in the string does
21138 not work, the string is just chopped off in the middle of a word
21139 if necessary."
21140 (if (<= (length s) maxlength)
21141 s
21142 (let* ((n (max (- maxlength 4) 1))
21144 (if (string-match re s)
21145 (concat (match-string 1 s) "...")
21146 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21148 (defun org-get-indentation (&optional line)
21149 "Get the indentation of the current line, interpreting tabs.
21150 When LINE is given, assume it represents a line and compute its indentation."
21151 (if line
21152 (if (string-match "^ *" (org-remove-tabs line))
21153 (match-end 0))
21154 (save-excursion
21155 (beginning-of-line 1)
21157 (current-column))))
21159 (defun org-get-string-indentation (s)
21160 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21161 (let ((n -1) (i 0) (w tab-width) c)
21162 (catch 'exit
21163 (while (< (setq n (1+ n)) (length s))
21164 (setq c (aref s n))
21165 (cond ((= c ?\ ) (setq i (1+ i)))
21167 (t (throw 'exit t)))))
21168 i))
21170 (defun org-remove-tabs (s &optional width)
21171 "Replace tabulators in S with spaces.
21172 Assumes that s is a single line, starting in column 0."
21173 (setq width (or width tab-width))
21175 (setq s (replace-match
21176 (make-string
21177 (- (* width (/ (+ (match-beginning 0) width) width))
21178 (match-beginning 0)) ?\ )
21179 t t s)))
21180 s)
21182 (defun org-fix-indentation (line ind)
21183 "Fix indentation in LINE.
21184 IND is a cons cell with target and minimum indentation.
21185 If the current indentation in LINE is smaller than the minimum,
21186 leave it alone. If it is larger than ind, set it to the target."
21187 (let* ((l (org-remove-tabs line))
21188 (i (org-get-indentation l))
21189 (i1 (car ind)) (i2 (cdr ind)))
21190 (if (>= i i2) (setq l (substring line i2)))
21191 (if (> i1 0)
21192 (concat (make-string i1 ?\ ) l)
21193 l)))
21195 (defun org-remove-indentation (code &optional n)
21196 "Remove the maximum common indentation from the lines in CODE.
21197 N may optionally be the number of spaces to remove."
21198 (with-temp-buffer
21199 (insert code)
21200 (org-do-remove-indentation n)
21201 (buffer-string)))
21203 (defun org-do-remove-indentation (&optional n)
21204 "Remove the maximum common indentation from the buffer."
21205 (untabify (point-min) (point-max))
21206 (let ((min 10000) re)
21207 (if n
21208 (setq min n)
21209 (goto-char (point-min))
21211 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21212 (unless (or (= min 0) (= min 10000))
21214 (goto-char (point-min))
21215 (while (re-search-forward re nil t)
21216 (replace-match "")
21217 (end-of-line 1))
21218 min)))
21220 (defun org-fill-template (template alist)
21221 "Find each %key of ALIST in TEMPLATE and replace it."
21222 (let ((case-fold-search nil)
21223 entry key value)
21224 (setq alist (sort (copy-sequence alist)
21225 (lambda (a b) (< (length (car a)) (length (car b))))))
21226 (while (setq entry (pop alist))
21227 (setq template
21228 (replace-regexp-in-string
21229 (concat "%" (regexp-quote (car entry)))
21230 (or (cdr entry) "") template t t)))
21231 template))
21233 (defun org-base-buffer (buffer)
21234 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21235 (if (not buffer)
21236 buffer
21237 (or (buffer-base-buffer buffer)
21238 buffer)))
21240 (defun org-trim (s)
21241 "Remove whitespace at beginning and end of string."
21244 s)
21246 (defun org-wrap (string &optional width lines)
21247 "Wrap string to either a number of lines, or a width in characters.
21248 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21249 that costs. If there is a word longer than WIDTH, the text is actually
21250 wrapped to the length of that word.
21251 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21252 many lines, whatever width that takes.
21253 The return value is a list of lines, without newlines at the end."
21255 (maxword (apply 'max (mapcar 'org-string-width words)))
21256 w ll)
21257 (cond (width
21258 (org-do-wrap words (max maxword width)))
21259 (lines
21260 (setq w maxword)
21261 (setq ll (org-do-wrap words maxword))
21262 (if (<= (length ll) lines)
21263 ll
21264 (setq ll words)
21265 (while (> (length ll) lines)
21266 (setq w (1+ w))
21267 (setq ll (org-do-wrap words w)))
21268 ll))
21269 (t (error "Cannot wrap this")))))
21271 (defun org-do-wrap (words width)
21272 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21273 (let (lines line)
21274 (while words
21275 (setq line (pop words))
21276 (while (and words (< (+ (length line) (length (car words))) width))
21277 (setq line (concat line " " (pop words))))
21278 (setq lines (push line lines)))
21279 (nreverse lines)))
21281 (defun org-split-string (string &optional separators)
21282 "Splits STRING into substrings at SEPARATORS.
21283 No empty strings are returned if there are matches at the beginning
21284 and end of string."
21286 (start 0)
21287 notfirst
21288 (list nil))
21289 (while (and (string-match rexp string
21290 (if (and notfirst
21291 (= start (match-beginning 0))
21292 (< start (length string)))
21293 (1+ start) start))
21294 (< (match-beginning 0) (length string)))
21295 (setq notfirst t)
21296 (or (eq (match-beginning 0) 0)
21297 (and (eq (match-beginning 0) (match-end 0))
21298 (eq (match-beginning 0) start))
21299 (setq list
21300 (cons (substring string start (match-beginning 0))
21301 list)))
21302 (setq start (match-end 0)))
21303 (or (eq start (length string))
21304 (setq list
21305 (cons (substring string start)
21306 list)))
21307 (nreverse list)))
21309 (defun org-quote-vert (s)
21311 (while (string-match "|" s)
21313 s)
21315 (defun org-uuidgen-p (s)
21316 "Is S an ID created by UUIDGEN?"
21317 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
21319 (defun org-in-src-block-p (&optional inside)
21320 "Whether point is in a code source block.
21321 When INSIDE is non-nil, don't consider we are within a src block
21322 when point is at #+BEGIN_SRC or #+END_SRC."
21323 (let ((case-fold-search t) ov)
21324 (or (and (setq ov (overlays-at (point)))
21325 (memq 'org-block-background
21326 (overlay-properties (car ov))))
21327 (and (not inside)
21328 (save-match-data
21329 (save-excursion
21330 (beginning-of-line)
21333 (defun org-context ()
21334 "Return a list of contexts of the current cursor position.
21335 If several contexts apply, all are returned.
21336 Each context entry is a list with a symbol naming the context, and
21337 two positions indicating start and end of the context. Possible
21338 contexts are:
21340 :headline anywhere in a headline
21341 :headline-stars on the leading stars in a headline
21342 :todo-keyword on a TODO keyword (including DONE) in a headline
21343 :tags on the TAGS in a headline
21344 :priority on the priority cookie in a headline
21345 :item on the first line of a plain list item
21346 :item-bullet on the bullet/number of a plain list item
21347 :checkbox on the checkbox in a plain list item
21348 :table in an org-mode table
21349 :table-special on a special filed in a table
21350 :table-table in a table.el table
21351 :clocktable in a clocktable
21352 :src-block in a source block
21353 :link on a hyperlink
21354 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
21355 :target on a <<target>>
21356 :radio-target on a <<<radio-target>>>
21357 :latex-fragment on a LaTeX fragment
21358 :latex-preview on a LaTeX fragment with overlaid preview image
21360 This function expects the position to be visible because it uses font-lock
21361 faces as a help to recognize the following contexts: :table-special, :link,
21362 and :keyword."
21363 (let* ((f (get-text-property (point) 'face))
21364 (faces (if (listp f) f (list f)))
21365 (case-fold-search t)
21366 (p (point)) clist o)
21367 ;; First the large context
21368 (cond
21369 ((org-at-heading-p t)
21370 (push (list :headline (point-at-bol) (point-at-eol)) clist)
21371 (when (progn
21372 (beginning-of-line 1)
21373 (looking-at org-todo-line-tags-regexp))
21374 (push (org-point-in-group p 1 :headline-stars) clist)
21375 (push (org-point-in-group p 2 :todo-keyword) clist)
21376 (push (org-point-in-group p 4 :tags) clist))
21377 (goto-char p)
21380 (push (org-point-in-group p 0 :priority) clist)))
21382 ((org-at-item-p)
21383 (push (org-point-in-group p 2 :item-bullet) clist)
21384 (push (list :item (point-at-bol)
21385 (save-excursion (org-end-of-item) (point)))
21386 clist)
21387 (and (org-at-item-checkbox-p)
21388 (push (org-point-in-group p 0 :checkbox) clist)))
21390 ((org-at-table-p)
21391 (push (list :table (org-table-begin) (org-table-end)) clist)
21392 (if (memq 'org-formula faces)
21393 (push (list :table-special
21394 (previous-single-property-change p 'face)
21395 (next-single-property-change p 'face)) clist)))
21396 ((org-at-table-p 'any)
21397 (push (list :table-table) clist)))
21398 (goto-char p)
21400 (let ((case-fold-search t))
21401 ;; New the "medium" contexts: clocktables, source blocks
21402 (cond ((org-in-clocktable-p)
21403 (push (list :clocktable
21405 (search-backward "#+BEGIN: clocktable" nil t))
21406 (match-beginning 0))
21408 (match-end 0))) clist))
21409 ((org-in-src-block-p)
21410 (push (list :src-block
21412 (search-backward "#+BEGIN_SRC" nil t))
21413 (match-beginning 0))
21414 (and (search-forward "#+END_SRC" nil t)
21415 (match-beginning 0))) clist))))
21416 (goto-char p)
21418 ;; Now the small context
21419 (cond
21420 ((org-at-timestamp-p)
21421 (push (org-point-in-group p 0 :timestamp) clist))
21422 ((memq 'org-link faces)
21423 (push (list :link
21424 (previous-single-property-change p 'face)
21425 (next-single-property-change p 'face)) clist))
21426 ((memq 'org-special-keyword faces)
21427 (push (list :keyword
21428 (previous-single-property-change p 'face)
21429 (next-single-property-change p 'face)) clist))
21430 ((org-at-target-p)
21431 (push (org-point-in-group p 0 :target) clist)
21432 (goto-char (1- (match-beginning 0)))
21433 (if (looking-at org-radio-target-regexp)
21434 (push (org-point-in-group p 0 :radio-target) clist))
21435 (goto-char p))
21436 ((setq o (car (delq nil
21437 (mapcar
21438 (lambda (x)
21439 (if (memq x org-latex-fragment-image-overlays) x))
21440 (overlays-at (point))))))
21441 (push (list :latex-fragment
21442 (overlay-start o) (overlay-end o)) clist)
21443 (push (list :latex-preview
21444 (overlay-start o) (overlay-end o)) clist))
21445 ((org-inside-LaTeX-fragment-p)
21446 ;; FIXME: positions wrong.
21447 (push (list :latex-fragment (point) (point)) clist)))
21449 (setq clist (nreverse (delq nil clist)))
21450 clist))
21452 ;; FIXME: Compare with at-regexp-p Do we need both?
21453 (defun org-in-regexp (re &optional nlines visually)
21454 "Check if point is inside a match of regexp.
21455 Normally only the current line is checked, but you can include NLINES extra
21456 lines both before and after point into the search.
21457 If VISUALLY is set, require that the cursor is not after the match but
21458 really on, so that the block visually is on the match."
21459 (catch 'exit
21460 (let ((pos (point))
21461 (eol (point-at-eol (+ 1 (or nlines 0))))
21462 (inc (if visually 1 0)))
21463 (save-excursion
21464 (beginning-of-line (- 1 (or nlines 0)))
21465 (while (re-search-forward re eol t)
21466 (if (and (<= (match-beginning 0) pos)
21467 (>= (+ inc (match-end 0)) pos))
21468 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
21470 (defun org-at-regexp-p (regexp)
21471 "Is point inside a match of REGEXP in the current line?"
21472 (catch 'exit
21473 (save-excursion
21474 (let ((pos (point)) (end (point-at-eol)))
21475 (beginning-of-line 1)
21476 (while (re-search-forward regexp end t)
21477 (if (and (<= (match-beginning 0) pos)
21478 (>= (match-end 0) pos))
21479 (throw 'exit t)))
21480 nil))))
21482 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
21483 "Non-nil when point is between matches of START-RE and END-RE.
21485 Also return a non-nil value when point is on one of the matches.
21487 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
21488 buffer positions. Default values are the positions of headlines
21489 surrounding the point.
21491 The functions returns a cons cell whose car (resp. cdr) is the
21492 position before START-RE (resp. after END-RE)."
21493 (save-match-data
21494 (let ((pos (point))
21495 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
21496 (limit-down (or lim-down (save-excursion (outline-next-heading))))
21497 beg end)
21498 (save-excursion
21499 ;; Point is on a block when on START-RE or if START-RE can be
21500 ;; found before it...
21501 (and (or (org-at-regexp-p start-re)
21502 (re-search-backward start-re limit-up t))
21503 (setq beg (match-beginning 0))
21504 ;; ... and END-RE after it...
21505 (goto-char (match-end 0))
21506 (re-search-forward end-re limit-down t)
21507 (> (setq end (match-end 0)) pos)
21508 ;; ... without another START-RE in-between.
21509 (goto-char (match-beginning 0))
21510 (not (re-search-backward start-re (1+ beg) t))
21511 ;; Return value.
21512 (cons beg end))))))
21514 (defun org-in-block-p (names)
21515 "Non-nil when point belongs to a block whose name belongs to NAMES.
21517 NAMES is a list of strings containing names of blocks.
21519 Return first block name matched, or nil. Beware that in case of
21520 nested blocks, the returned name may not belong to the closest
21521 block from point."
21522 (save-match-data
21523 (catch 'exit
21524 (let ((case-fold-search t)
21525 (lim-up (save-excursion (outline-previous-heading)))
21526 (lim-down (save-excursion (outline-next-heading))))
21527 (mapc (lambda (name)
21528 (let ((n (regexp-quote name)))
21529 (when (org-between-regexps-p
21532 lim-up lim-down)
21533 (throw 'exit n))))
21534 names))
21535 nil)))
21537 (defun org-occur-in-agenda-files (regexp &optional nlines)
21538 "Call `multi-occur' with buffers for all agenda files."
21540 (let* ((files (org-agenda-files))
21541 (tnames (mapcar 'file-truename files))
21542 (extra org-agenda-text-search-extra-files)
21543 f)
21544 (when (eq (car extra) 'agenda-archives)
21545 (setq extra (cdr extra))
21546 (setq files (org-add-archive-files files)))
21547 (while (setq f (pop extra))
21548 (unless (member (file-truename f) tnames)
21549 (add-to-list 'files f 'append)
21550 (add-to-list 'tnames (file-truename f) 'append)))
21551 (multi-occur
21552 (mapcar (lambda (x)
21553 (with-current-buffer
21554 (or (get-file-buffer x) (find-file-noselect x))
21555 (widen)
21556 (current-buffer)))
21557 files)
21558 regexp)))
21560 (if (boundp 'occur-mode-find-occurrence-hook)
21561 ;; Emacs 23
21562 (add-hook 'occur-mode-find-occurrence-hook
21563 (lambda ()
21564 (when (derived-mode-p 'org-mode)
21565 (org-reveal))))
21566 ;; Emacs 22
21567 (defadvice occur-mode-goto-occurrence
21568 (after org-occur-reveal activate)
21569 (and (derived-mode-p 'org-mode) (org-reveal)))
21570 (defadvice occur-mode-goto-occurrence-other-window
21571 (after org-occur-reveal activate)
21572 (and (derived-mode-p 'org-mode) (org-reveal)))
21573 (defadvice occur-mode-display-occurrence
21574 (after org-occur-reveal activate)
21575 (when (derived-mode-p 'org-mode)
21576 (let ((pos (occur-mode-find-occurrence)))
21577 (with-current-buffer (marker-buffer pos)
21578 (save-excursion
21579 (goto-char pos)
21580 (org-reveal)))))))
21582 (defun org-occur-link-in-agenda-files ()
21583 "Create a link and search for it in the agendas.
21584 The link is not stored in `org-stored-links', it is just created
21585 for the search purpose."
21586 (interactive)
21587 (let ((link (condition-case nil
21588 (org-store-link nil)
21589 (error "Unable to create a link to here"))))
21590 (org-occur-in-agenda-files (regexp-quote link))))
21592 (defun org-reverse-string (string)
21593 "Return the reverse of STRING."
21594 (apply 'string (reverse (string-to-list string))))
21596 (defsubst org-uniquify (list)
21597 "Non-destructively remove duplicate elements from LIST."
21598 (let ((res (copy-seq list))) (delete-dups res)))
21600 (defun org-uniquify-alist (alist)
21601 "Merge elements of ALIST with the same key.
21603 For example, in this alist:
21605 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
21606 => '((a 1 3) (b 2))
21608 merge (a 1) and (a 3) into (a 1 3).
21610 The function returns the new ALIST."
21611 (let (rtn)
21612 (mapc
21613 (lambda (e)
21614 (let (n)
21615 (if (not (assoc (car e) rtn))
21616 (push e rtn)
21617 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
21618 (setq rtn (assq-delete-all (car e) rtn))
21619 (push n rtn))))
21620 alist)
21621 rtn))
21623 (defun org-delete-all (elts list)
21624 "Remove all elements in ELTS from LIST."
21625 (while elts
21626 (setq list (delete (pop elts) list)))
21627 list)
21629 (defun org-count (cl-item cl-seq)
21630 "Count the number of occurrences of ITEM in SEQ.
21631 Taken from `count' in cl-seq.el with all keyword arguments removed."
21632 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
21633 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
21634 (while (< cl-start cl-end)
21635 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
21636 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
21637 (setq cl-start (1+ cl-start)))
21638 cl-count))
21640 (defun org-remove-if (predicate seq)
21641 "Remove everything from SEQ that fulfills PREDICATE."
21642 (let (res e)
21643 (while seq
21644 (setq e (pop seq))
21645 (if (not (funcall predicate e)) (push e res)))
21646 (nreverse res)))
21648 (defun org-remove-if-not (predicate seq)
21649 "Remove everything from SEQ that does not fulfill PREDICATE."
21650 (let (res e)
21651 (while seq
21652 (setq e (pop seq))
21653 (if (funcall predicate e) (push e res)))
21654 (nreverse res)))
21656 (defun org-reduce (cl-func cl-seq &rest cl-keys)
21657 "Reduce two-argument FUNCTION across SEQ.
21658 Taken from `reduce' in cl-seq.el with all keyword arguments but
21660 (let ((cl-accum (cond ((memq :initial-value cl-keys)
21661 (cadr (memq :initial-value cl-keys)))
21662 (cl-seq (pop cl-seq))
21663 (t (funcall cl-func)))))
21664 (while cl-seq
21665 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
21666 cl-accum))
21668 (defun org-back-over-empty-lines ()
21669 "Move backwards over whitespace, to the beginning of the first empty line.
21670 Returns the number of empty lines passed."
21671 (let ((pos (point)))
21672 (if (cdr (assoc 'heading org-blank-before-new-entry))
21674 (unless (eobp)
21675 (forward-line -1)))
21676 (beginning-of-line 2)
21677 (goto-char (min (point) pos))
21678 (count-lines (point) pos)))
21680 (defun org-skip-whitespace ()
21683 (defun org-point-in-group (point group &optional context)
21684 "Check if POINT is in match-group GROUP.
21685 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
21686 match. If the match group does not exist or point is not inside it,
21687 return nil."
21688 (and (match-beginning group)
21689 (>= point (match-beginning group))
21690 (<= point (match-end group))
21691 (if context
21692 (list context (match-beginning group) (match-end group))
21693 t)))
21695 (defun org-switch-to-buffer-other-window (&rest args)
21696 "Switch to buffer in a second window on the current frame.
21697 In particular, do not allow pop-up frames.
21698 Returns the newly created buffer."
21699 (org-no-popups
21700 (apply 'switch-to-buffer-other-window args)))
21702 (defun org-combine-plists (&rest plists)
21703 "Create a single property list from all plists in PLISTS.
21704 The process starts by copying the first list, and then setting properties
21705 from the other lists. Settings in the last list are the most significant
21706 ones and overrule settings in the other lists."
21707 (let ((rtn (copy-sequence (pop plists)))
21708 p v ls)
21709 (while plists
21710 (setq ls (pop plists))
21711 (while ls
21712 (setq p (pop ls) v (pop ls))
21713 (setq rtn (plist-put rtn p v))))
21714 rtn))
21716 (defun org-replace-escapes (string table)
21717 "Replace %-escapes in STRING with values in TABLE.
21719 The sequences in STRING may contain normal field width and padding information,
21721 so values can contain further %-escapes if they are define later in TABLE."
21722 (let ((tbl (copy-alist table))
21723 (case-fold-search nil)
21724 (pchg 0)
21725 e re rpl)
21726 (while (setq e (pop tbl))
21727 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
21728 (when (and (cdr e) (string-match re (cdr e)))
21729 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
21730 (safe "SREF"))
21731 (add-text-properties 0 3 (list 'sref sref) safe)
21732 (setcdr e (replace-match safe t t (cdr e)))))
21733 (while (string-match re string)
21734 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
21735 (cdr e)))
21736 (setq string (replace-match rpl t t string))))
21737 (while (setq pchg (next-property-change pchg string))
21738 (let ((sref (get-text-property pchg 'sref string)))
21739 (when (and sref (string-match "SREF" string pchg))
21740 (setq string (replace-match sref t t string)))))
21741 string))
21743 (defun org-sublist (list start end)
21744 "Return a section of LIST, from START to END.
21745 Counting starts at 1."
21746 (let (rtn (c start))
21747 (setq list (nthcdr (1- start) list))
21748 (while (and list (<= c end))
21749 (push (pop list) rtn)
21750 (setq c (1+ c)))
21751 (nreverse rtn)))
21753 (defun org-find-base-buffer-visiting (file)
21754 "Like `find-buffer-visiting' but always return the base buffer and
21755 not an indirect buffer."
21756 (let ((buf (or (get-file-buffer file)
21757 (find-buffer-visiting file))))
21758 (if buf
21759 (or (buffer-base-buffer buf) buf)
21760 nil)))
21762 (defun org-image-file-name-regexp (&optional extensions)
21763 "Return regexp matching the file names of images.
21764 If EXTENSIONS is given, only match these."
21765 (if (and (not extensions) (fboundp 'image-file-name-regexp))
21766 (image-file-name-regexp)
21767 (let ((image-file-name-extensions
21768 (or extensions
21769 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
21770 "xbm" "xpm" "pbm" "pgm" "ppm"))))
21772 (regexp-opt (nconc (mapcar 'upcase
21773 image-file-name-extensions)
21774 image-file-name-extensions)
21775 t)
21778 (defun org-file-image-p (file &optional extensions)
21779 "Return non-nil if FILE is an image."
21780 (save-match-data
21781 (string-match (org-image-file-name-regexp extensions) file)))
21783 (defun org-get-cursor-date (&optional with-time)
21784 "Return the date at cursor in as a time.
21785 This works in the calendar and in the agenda, anywhere else it just
21786 returns the current time.
21787 If WITH-TIME is non-nil, returns the time of the event at point (in
21788 the agenda) or the current time of the day."
21789 (let (date day defd tp tm hod mod)
21790 (when with-time
21791 (setq tp (get-text-property (point) 'time))
21793 (setq hod (string-to-number (match-string 1 tp))
21794 mod (string-to-number (match-string 2 tp))))
21795 (or tp (setq hod (nth 2 (decode-time (current-time)))
21796 mod (nth 1 (decode-time (current-time))))))
21797 (cond
21798 ((eq major-mode 'calendar-mode)
21799 (setq date (calendar-cursor-to-date)
21800 defd (encode-time 0 (or mod 0) (or hod 0)
21801 (nth 1 date) (nth 0 date) (nth 2 date))))
21802 ((eq major-mode 'org-agenda-mode)
21803 (setq day (get-text-property (point) 'day))
21804 (if day
21805 (setq date (calendar-gregorian-from-absolute day)
21806 defd (encode-time 0 (or mod 0) (or hod 0)
21807 (nth 1 date) (nth 0 date) (nth 2 date))))))
21808 (or defd (current-time))))
21810 (defun org-mark-subtree (&optional up)
21811 "Mark the current subtree.
21812 This puts point at the start of the current subtree, and mark at
21813 the end. If a numeric prefix UP is given, move up into the
21814 hierarchy of headlines by UP levels before marking the subtree."
21815 (interactive "P")
21816 (org-with-limited-levels
21817 (cond ((org-at-heading-p) (beginning-of-line))
21818 ((org-before-first-heading-p) (error "Not in a subtree"))
21819 (t (outline-previous-visible-heading 1))))
21820 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
21821 (if (org-called-interactively-p 'any)
21822 (call-interactively 'org-mark-element)
21823 (org-mark-element)))
21826 ;;; Indentation
21828 (defun org-indent-line ()
21829 "Indent line depending on context."
21830 (interactive)
21831 (let* ((pos (point))
21832 (itemp (org-at-item-p))
21833 (case-fold-search t)
21835 (inline-task-p (and (featurep 'org-inlinetask)
21836 (org-inlinetask-in-task-p)))
21837 (inline-re (and inline-task-p
21838 (org-inlinetask-outline-regexp)))
21839 column)
21840 (if (and orgstruct-is-++ (eq pos (point)))
21841 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
21842 (indent-according-to-mode))
21843 (beginning-of-line 1)
21844 (cond
21845 ;; Headings
21846 ((looking-at org-outline-regexp) (setq column 0))
21847 ;; Footnote definition
21848 ((looking-at org-footnote-definition-re) (setq column 0))
21849 ;; Literal examples
21851 (setq column (org-get-indentation))) ; do nothing
21852 ;; Lists
21853 ((ignore-errors (goto-char (org-in-item-p)))
21854 (setq column (if itemp
21855 (org-get-indentation)
21856 (org-list-item-body-column (point))))
21857 (goto-char pos))
21858 ;; Drawers
21860 (save-excursion (re-search-backward org-drawer-regexp nil t)))
21861 (save-excursion
21862 (goto-char (1- (match-beginning 1)))
21863 (setq column (current-column))))
21864 ;; Special blocks
21866 (save-excursion
21867 (re-search-backward
21869 (setq column (org-get-indentation (match-string 0))))
21872 (save-excursion
21874 (setq column
21875 (cond ((equal (downcase (match-string 1)) "src")
21876 ;; src blocks: let `org-edit-src-exit' handle them
21877 (org-get-indentation))
21878 ((equal (downcase (match-string 1)) "example")
21879 (max (org-get-indentation)
21880 (org-get-indentation (match-string 0))))
21881 (t
21882 (org-get-indentation (match-string 0))))))
21883 ;; This line has nothing special, look at the previous relevant
21884 ;; line to compute indentation
21885 (t
21886 (beginning-of-line 0)
21887 (while (and (not (bobp))
21888 (not (looking-at org-table-line-regexp))
21889 (not (looking-at org-drawer-regexp))
21890 ;; When point started in an inline task, do not move
21891 ;; above task starting line.
21892 (not (and inline-task-p (looking-at inline-re)))
21893 ;; Skip drawers, blocks, empty lines, verbatim,
21894 ;; comments, tables, footnotes definitions, lists,
21895 ;; inline tasks.
21897 (re-search-backward org-drawer-regexp nil t))
21901 (looking-at org-footnote-definition-re)
21902 (and (not inline-task-p)
21903 (featurep 'org-inlinetask)
21904 (org-inlinetask-in-task-p)
21905 (or (org-inlinetask-goto-beginning) t))))
21906 (beginning-of-line 0))
21907 (cond
21908 ;; There was a list item above.
21909 ((save-excursion
21910 (and (ignore-errors (goto-char (org-in-item-p)))
21911 (goto-char
21912 (org-list-get-top-point (org-list-struct)))))
21913 (looking-at org-list-full-item-re)
21914 (setq column (length (match-string 0))))
21915 ;; There was an heading above.
21917 (if (not org-adapt-indentation)
21918 (setq column 0)
21919 (goto-char (match-end 0))
21920 (setq column (current-column))))
21921 ;; A drawer had started and is unfinished
21922 ((looking-at org-drawer-regexp)
21923 (goto-char (1- (match-beginning 1)))
21924 (setq column (current-column)))
21925 ;; Else, nothing noticeable found: get indentation and go on.
21926 (t (setq column (org-get-indentation))))))
21927 ;; Now apply indentation and move cursor accordingly
21928 (goto-char pos)
21929 (if (<= (current-column) (current-indentation))
21930 (org-indent-line-to column)
21931 (save-excursion (org-indent-line-to column)))
21932 ;; Special polishing for properties, see `org-property-format'
21933 (setq column (current-column))
21934 (beginning-of-line 1)
21935 (if (looking-at
21937 (replace-match (concat (match-string 1)
21938 (format org-property-format
21939 (match-string 2) (match-string 3)))
21940 t t))
21941 (org-move-to-column column))))
21943 (defun org-indent-drawer ()
21944 "Indent the drawer at point."
21945 (interactive)
21946 (let ((p (point))
21947 (e (and (save-excursion (re-search-forward ":END:" nil t))
21948 (match-end 0)))
21949 (folded
21950 (save-excursion
21951 (end-of-line)
21952 (when (overlays-at (point))
21953 (member 'invisible (overlay-properties
21954 (car (overlays-at (point)))))))))
21955 (when folded (org-cycle))
21956 (indent-for-tab-command)
21957 (while (and (move-beginning-of-line 2) (< (point) e))
21958 (indent-for-tab-command))
21959 (goto-char p)
21960 (when folded (org-cycle)))
21961 (message "Drawer at point indented"))
21963 (defun org-indent-block ()
21964 "Indent the block at point."
21965 (interactive)
21966 (let ((p (point))
21967 (case-fold-search t)
21969 (match-end 0)))
21970 (folded
21971 (save-excursion
21972 (end-of-line)
21973 (when (overlays-at (point))
21974 (member 'invisible (overlay-properties
21975 (car (overlays-at (point)))))))))
21976 (when folded (org-cycle))
21977 (indent-for-tab-command)
21978 (while (and (move-beginning-of-line 2) (< (point) e))
21979 (indent-for-tab-command))
21980 (goto-char p)
21981 (when folded (org-cycle)))
21982 (message "Block at point indented"))
21984 (defun org-indent-region (start end)
21985 "Indent region."
21986 (interactive "r")
21987 (save-excursion
21988 (let ((line-end (org-current-line end)))
21989 (goto-char start)
21990 (while (< (org-current-line) line-end)
21991 (cond ((org-in-src-block-p) (org-src-native-tab-command-maybe))
21992 (t (call-interactively 'org-indent-line)))
21993 (move-beginning-of-line 2)))))
21996 ;;; Filling
21998 ;; We use our own fill-paragraph and auto-fill functions.
22000 ;; `org-fill-paragraph' relies on adaptive filling and context
22001 ;; checking. Appropriate `fill-prefix' is computed with
22002 ;; `org-adaptive-fill-function'.
22004 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22005 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22006 ;; `org-adaptive-fill-function' value. Internally,
22007 ;; `org-comment-line-break-function' breaks the line.
22009 ;; `org-setup-filling' installs filling and auto-filling related
22010 ;; variables during `org-mode' initialization.
22012 (defun org-setup-filling ()
22013 (interactive)
22014 ;; Prevent auto-fill from inserting unwanted new items.
22015 (when (boundp 'fill-nobreak-predicate)
22016 (org-set-local
22017 'fill-nobreak-predicate
22018 (org-uniquify
22019 (append fill-nobreak-predicate
22020 '(org-fill-paragraph-separate-nobreak-p
22021 org-fill-line-break-nobreak-p
22022 org-fill-paragraph-with-timestamp-nobreak-p)))))
22023 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22024 (org-set-local 'auto-fill-inhibit-regexp nil)
22025 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22026 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22027 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22029 (defvar org-element-paragraph-separate) ; org-element.el
22030 (defun org-fill-paragraph-separate-nobreak-p ()
22031 "Non-nil when a line break at point would insert a new item."
22032 (looking-at (substring org-element-paragraph-separate 1)))
22034 (defun org-fill-line-break-nobreak-p ()
22035 "Non-nil when a line break at point would create an Org line break."
22036 (save-excursion
22041 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22042 "Non-nil when a line break at point would insert a new item."
22043 (and (org-at-timestamp-p t)
22044 (not (looking-at org-ts-regexp-both))))
22046 (declare-function message-in-body-p "message" ())
22047 (defvar orgtbl-line-start-regexp) ; From org-table.el
22048 (defun org-adaptive-fill-function ()
22049 "Compute a fill prefix for the current line.
22050 Return fill prefix, as a string, or nil if current line isn't
22051 meant to be filled."
22052 (let (prefix)
22053 (catch 'exit
22054 (when (derived-mode-p 'message-mode)
22055 (save-excursion
22056 (beginning-of-line)
22057 (cond ((or (not (message-in-body-p))
22058 (looking-at orgtbl-line-start-regexp))
22059 (throw 'exit nil))
22060 ((looking-at message-cite-prefix-regexp)
22061 (throw 'exit (match-string-no-properties 0)))
22062 ((looking-at org-outline-regexp)
22063 (throw 'exit (make-string (length (match-string 0)) ? ))))))
22064 (org-with-wide-buffer
22065 (let* ((p (line-beginning-position))
22066 (element (save-excursion (beginning-of-line)
22067 (org-element-at-point)))
22068 (type (org-element-type element))
22069 (post-affiliated (org-element-property :post-affiliated element)))
22070 (unless (and post-affiliated (< p post-affiliated))
22071 (case type
22073 (footnote-definition "")
22074 ((item plain-list)
22075 (make-string (org-list-item-body-column
22076 (or post-affiliated
22077 (org-element-property :begin element)))
22078 ? ))
22079 (paragraph
22080 ;; Fill prefix is usually the same as the current line,
22081 ;; except if the paragraph is at the beginning of an item.
22082 (let ((parent (org-element-property :parent element)))
22083 (cond ((eq (org-element-type parent) 'item)
22084 (make-string (org-list-item-body-column
22085 (org-element-property :begin parent))
22086 ? ))
22088 (match-string 0))
22089 (t ""))))
22090 (comment-block
22091 ;; Only fill contents if P is within block boundaries.
22092 (let* ((cbeg (save-excursion (goto-char post-affiliated)
22093 (forward-line)
22094 (point)))
22095 (cend (save-excursion
22096 (goto-char (org-element-property :end element))
22098 (line-beginning-position))))
22099 (when (and (>= p cbeg) (< p cend))
22101 (match-string 0)
22102 "")))))))))))
22104 (declare-function message-goto-body "message" ())
22105 (defvar message-cite-prefix-regexp) ; From message.el
22106 (defun org-fill-paragraph (&optional justify)
22107 "Fill element at point, when applicable.
22109 This function only applies to comment blocks, comments, example
22110 blocks and paragraphs. Also, as a special case, re-align table
22111 when point is at one.
22113 If JUSTIFY is non-nil (interactively, with prefix argument),
22114 justify as well. If `sentence-end-double-space' is non-nil, then
22115 period followed by one space does not end a sentence, so don't
22116 break a line there. The variable `fill-column' controls the
22117 width for filling.
22119 For convenience, when point is at a plain list, an item or
22120 a footnote definition, try to fill the first paragraph within."
22121 (interactive)
22122 (if (and (derived-mode-p 'message-mode)
22123 (or (not (message-in-body-p))
22124 (save-excursion (move-beginning-of-line 1)
22125 (looking-at message-cite-prefix-regexp))))
22126 ;; First ensure filling is correct in message-mode.
22127 (let ((fill-paragraph-function
22128 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
22129 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
22130 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
22131 (paragraph-separate
22132 (cadadr (assoc 'paragraph-separate org-fb-vars))))
22133 (fill-paragraph nil))
22134 (with-syntax-table org-mode-transpose-word-syntax-table
22135 ;; Move to end of line in order to get the first paragraph
22136 ;; within a plain list or a footnote definition.
22137 (let ((element (save-excursion (end-of-line) (org-element-at-point))))
22138 ;; First check if point is in a blank line at the beginning of
22139 ;; the buffer. In that case, ignore filling.
22140 (case (org-element-type element)
22141 ;; Use major mode filling function is src blocks.
22142 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
22143 ;; Align Org tables, leave table.el tables as-is.
22144 (table-row (org-table-align) t)
22145 (table
22146 (when (eq (org-element-property :type element) 'org)
22147 (org-table-align))
22148 t)
22149 (paragraph
22150 ;; Paragraphs may contain `line-break' type objects.
22151 (let ((beg (max (point-min)
22152 (org-element-property :contents-begin element)))
22153 (end (min (point-max)
22154 (org-element-property :contents-end element))))
22155 ;; Do nothing if point is at an affiliated keyword.
22156 (if (< (line-end-position) beg) t
22157 (when (derived-mode-p 'message-mode)
22158 ;; In `message-mode', do not fill following citation
22159 ;; in current paragraph nor text before message body.
22160 (let ((body-start (save-excursion (message-goto-body))))
22161 (when body-start (setq beg (max body-start beg))))
22162 (when (save-excursion
22163 (re-search-forward
22164 (concat "^" message-cite-prefix-regexp) end t))
22165 (setq end (match-beginning 0))))
22166 ;; Fill paragraph, taking line breaks into account.
22167 ;; For that, slice the paragraph using line breaks as
22168 ;; separators, and fill the parts in reverse order to
22169 ;; avoid messing with markers.
22170 (save-excursion
22171 (goto-char end)
22172 (mapc
22173 (lambda (pos)
22174 (fill-region-as-paragraph pos (point) justify)
22175 (goto-char pos))
22176 ;; Find the list of ending positions for line breaks
22177 ;; in the current paragraph. Add paragraph
22178 ;; beginning to include first slice.
22179 (nreverse
22180 (cons beg
22181 (org-element-map
22182 (org-element--parse-objects
22183 beg end nil (org-element-restriction 'paragraph))
22184 'line-break
22185 (lambda (lb) (org-element-property :end lb)))))))
22186 t)))
22187 ;; Contents of `comment-block' type elements should be
22188 ;; filled as plain text, but only if point is within block
22189 ;; markers.
22190 (comment-block
22191 (let* ((case-fold-search t)
22192 (beg (save-excursion
22193 (goto-char (org-element-property :begin element))
22195 (forward-line)
22196 (point)))
22197 (end (save-excursion
22198 (goto-char (org-element-property :end element))
22200 (line-beginning-position))))
22201 (when (and (>= (point) beg) (< (point) end))
22202 (fill-region-as-paragraph
22203 (save-excursion
22204 (end-of-line)
22206 (line-beginning-position))
22207 (save-excursion
22208 (beginning-of-line)
22210 (line-beginning-position))
22211 justify)))
22212 t)
22213 ;; Fill comments.
22214 (comment (fill-comment-paragraph justify))
22215 ;; Ignore every other element.
22216 (otherwise t))))))
22218 (defun org-auto-fill-function ()
22219 "Auto-fill function."
22220 ;; Check if auto-filling is meaningful.
22221 (let ((fc (current-fill-column)))
22222 (when (and fc (> (current-column) fc))
22223 (let* ((fill-prefix (org-adaptive-fill-function))
22224 ;; Enforce empty fill prefix, if required. Otherwise, it
22225 ;; will be computed again.
22226 (adaptive-fill-mode (not (equal fill-prefix ""))))
22227 (when fill-prefix (do-auto-fill))))))
22229 (defun org-comment-line-break-function (&optional soft)
22230 "Break line at point and indent, continuing comment if within one.
22231 The inserted newline is marked hard if variable
22232 `use-hard-newlines' is true, unless optional argument SOFT is
22233 non-nil."
22235 (save-excursion (forward-char -1) (delete-horizontal-space))
22236 (delete-horizontal-space)
22237 (indent-to-left-margin)
22238 (insert-before-markers-and-inherit fill-prefix))
22241 ;;; Comments
22243 ;; Org comments syntax is quite complex. It requires the entire line
22244 ;; to be just a comment. Also, even with the right syntax at the
22245 ;; beginning of line, some some elements (i.e. verse-block or
22246 ;; example-block) don't accept comments. Usual Emacs comment commands
22247 ;; cannot cope with those requirements. Therefore, Org replaces them.
22249 ;; Org still relies on `comment-dwim', but cannot trust
22250 ;; `comment-only-p'. So, `comment-region-function' and
22251 ;; `uncomment-region-function' both point
22252 ;; to`org-comment-or-uncomment-region'. Eventually,
22253 ;; `org-insert-comment' takes care of insertion of comments at the
22254 ;; beginning of line.
22256 ;; `org-setup-comments-handling' install comments related variables
22257 ;; during `org-mode' initialization.
22259 (defun org-setup-comments-handling ()
22260 (interactive)
22261 (org-set-local 'comment-use-syntax nil)
22262 (org-set-local 'comment-start "# ")
22264 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
22265 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
22266 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
22268 (defun org-insert-comment ()
22269 "Insert an empty comment above current line.
22270 If the line is empty, insert comment at its beginning."
22271 (beginning-of-line)
22273 (org-indent-line)
22274 (insert "# "))
22276 (defvar comment-empty-lines) ; From newcomment.el.
22277 (defun org-comment-or-uncomment-region (beg end &rest ignore)
22278 "Comment or uncomment each non-blank line in the region.
22279 Uncomment each non-blank line between BEG and END if it only
22280 contains commented lines. Otherwise, comment them."
22281 (save-restriction
22282 ;; Restrict region
22283 (narrow-to-region (save-excursion (goto-char beg)
22285 (line-beginning-position))
22286 (save-excursion (goto-char end)
22288 (line-end-position)))
22289 (let ((uncommentp
22290 ;; UNCOMMENTP is non-nil when every non blank line between
22291 ;; BEG and END is a comment.
22292 (save-excursion
22293 (goto-char (point-min))
22294 (while (and (not (eobp))
22295 (let ((element (org-element-at-point)))
22296 (and (eq (org-element-type element) 'comment)
22297 (goto-char (min (point-max)
22298 (org-element-property
22299 :end element)))))))
22300 (eobp))))
22301 (if uncommentp
22302 ;; Only blank lines and comments in region: uncomment it.
22303 (save-excursion
22304 (goto-char (point-min))
22305 (while (not (eobp))
22307 (replace-match "" nil nil nil 1))
22308 (forward-line)))
22309 ;; Comment each line in region.
22310 (let ((min-indent (point-max)))
22311 ;; First find the minimum indentation across all lines.
22312 (save-excursion
22313 (goto-char (point-min))
22314 (while (and (not (eobp)) (not (zerop min-indent)))
22316 (setq min-indent (min min-indent (current-indentation))))
22317 (forward-line)))
22318 ;; Then loop over all lines.
22319 (save-excursion
22320 (goto-char (point-min))
22321 (while (not (eobp))
22323 ;; Don't get fooled by invisible text (e.g. link path)
22324 ;; when moving to column MIN-INDENT.
22325 (let ((buffer-invisibility-spec nil))
22326 (org-move-to-column min-indent t))
22327 (insert comment-start))
22328 (forward-line))))))))
22331 ;;; Planning
22333 ;; This section contains tools to operate on timestamp objects, as
22334 ;; returned by, e.g. `org-element-context'.
22336 (defun org-timestamp-has-time-p (timestamp)
22337 "Non-nil when TIMESTAMP has a time specified."
22338 (org-element-property :hour-start timestamp))
22340 (defun org-timestamp-format (timestamp format &optional end utc)
22341 "Format a TIMESTAMP element into a string.
22343 FORMAT is a format specifier to be passed to
22344 `format-time-string'.
22346 When optional argument END is non-nil, use end of date-range or
22347 time-range, if possible.
22349 When optional argument UTC is non-nil, time will be expressed as
22350 Universal Time."
22351 (format-time-string
22352 format
22353 (apply 'encode-time
22354 (cons 0
22355 (mapcar
22356 (lambda (prop) (or (org-element-property prop timestamp) 0))
22357 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
22358 '(:minute-start :hour-start :day-start :month-start
22359 :year-start)))))
22360 utc))
22362 (defun org-timestamp-split-range (timestamp &optional end)
22363 "Extract a timestamp object from a date or time range.
22365 TIMESTAMP is a timestamp object. END, when non-nil, means extract
22366 the end of the range. Otherwise, extract its start.
22368 Return a new timestamp object sharing the same parent as
22369 TIMESTAMP."
22370 (let ((type (org-element-property :type timestamp)))
22371 (if (memq type '(active inactive diary)) timestamp
22372 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
22373 ;; Set new type.
22374 (org-element-put-property
22375 split-ts :type (if (eq type 'active-range) 'active 'inactive))
22376 ;; Copy start properties over end properties if END is
22377 ;; non-nil. Otherwise, copy end properties over `start' ones.
22378 (let ((p-alist '((:minute-start . :minute-end)
22379 (:hour-start . :hour-end)
22380 (:day-start . :day-end)
22381 (:month-start . :month-end)
22382 (:year-start . :year-end))))
22383 (dolist (p-cell p-alist)
22384 (org-element-put-property
22385 split-ts
22386 (funcall (if end 'car 'cdr) p-cell)
22387 (org-element-property
22388 (funcall (if end 'cdr 'car) p-cell) split-ts)))
22389 ;; Eventually refresh `:raw-value'.
22390 (org-element-put-property split-ts :raw-value nil)
22391 (org-element-put-property
22392 split-ts :raw-value (org-element-interpret-data split-ts)))))))
22394 (defun org-timestamp-translate (timestamp &optional boundary)
22395 "Apply `org-translate-time' on a TIMESTAMP object.
22396 When optional argument BOUNDARY is non-nil, it is either the
22397 symbol `start' or `end'. In this case, only translate the
22398 starting or ending part of TIMESTAMP if it is a date or time
22399 range. Otherwise, translate both parts."
22400 (if (and (not boundary)
22401 (memq (org-element-property :type timestamp)
22402 '(active-range inactive-range)))
22403 (concat
22404 (org-translate-time
22405 (org-element-property :raw-value
22406 (org-timestamp-split-range timestamp)))
22407 "--"
22408 (org-translate-time
22409 (org-element-property :raw-value
22410 (org-timestamp-split-range timestamp t))))
22411 (org-translate-time
22412 (org-element-property
22413 :raw-value
22414 (if (not boundary) timestamp
22415 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
22419 ;;; Other stuff.
22421 (defun org-toggle-fixed-width-section (arg)
22422 "Toggle the fixed-width export.
22423 If there is no active region, the QUOTE keyword at the current headline is
22424 inserted or removed. When present, it causes the text between this headline
22425 and the next to be exported as fixed-width text, and unmodified.
22426 If there is an active region, this command adds or removes a colon as the
22427 first character of this line. If the first character of a line is a colon,
22428 this line is also exported in fixed-width font."
22429 (interactive "P")
22430 (let* ((cc 0)
22431 (regionp (org-region-active-p))
22432 (beg (if regionp (region-beginning) (point)))
22433 (end (if regionp (region-end)))
22434 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
22435 (case-fold-search nil)
22437 off)
22438 (if regionp
22439 (save-excursion
22440 (goto-char beg)
22441 (setq cc (current-column))
22442 (beginning-of-line 1)
22443 (setq off (looking-at re))
22444 (while (> nlines 0)
22445 (setq nlines (1- nlines))
22446 (beginning-of-line 1)
22447 (cond
22448 (arg
22449 (org-move-to-column cc t)
22451 (forward-line -1))
22452 ((and off (looking-at re))
22453 (replace-match "" t t nil 1))
22454 ((not off) (org-move-to-column cc t) (insert ": ")))
22455 (forward-line 1)))
22456 (save-excursion
22457 (org-back-to-heading)
22458 (cond
22459 ((looking-at (format org-heading-keyword-regexp-format
22460 org-quote-string))
22461 (goto-char (match-end 1))
22462 (looking-at (concat " +" org-quote-string))
22463 (replace-match "" t t)
22464 (when (eolp) (insert " ")))
22465 ((looking-at org-outline-regexp)
22466 (goto-char (match-end 0))
22467 (insert org-quote-string " ")))))))
22469 (defun org-reftex-citation ()
22470 "Use reftex-citation to insert a citation into the buffer.
22471 This looks for a line like
22473 #+BIBLIOGRAPHY: foo plain option:-d
22475 and derives from it that foo.bib is the bibliography file relevant
22476 for this document. It then installs the necessary environment for RefTeX
22477 to work in this buffer and calls `reftex-citation' to insert a citation
22478 into the buffer.
22480 Export of such citations to both LaTeX and HTML is handled by the contributed
22481 package org-exp-bibtex by Taru Karttunen."
22482 (interactive)
22483 (let ((reftex-docstruct-symbol 'rds)
22485 rds bib)
22486 (save-excursion
22487 (save-restriction
22488 (widen)
22489 (let ((case-fold-search t)
22491 (if (not (save-excursion
22492 (or (re-search-forward re nil t)
22493 (re-search-backward re nil t))))
22494 (error "No bibliography defined in file")
22495 (setq bib (concat (match-string 1) ".bib")
22496 rds (list (list 'bib bib)))))))
22497 (call-interactively 'reftex-citation)))
22499 ;;;; Functions extending outline functionality
22501 (defun org-beginning-of-line (&optional arg)
22502 "Go to the beginning of the current line. If that is invisible, continue
22503 to a visible line beginning. This makes the function of C-a more intuitive.
22504 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
22505 first attempt, and only move to after the tags when the cursor is already
22506 beyond the end of the headline."
22507 (interactive "P")
22508 (let ((pos (point))
22509 (special (if (consp org-special-ctrl-a/e)
22510 (car org-special-ctrl-a/e)
22511 org-special-ctrl-a/e))
22512 refpos)
22513 (if (org-bound-and-true-p visual-line-mode)
22514 (beginning-of-visual-line 1)
22515 (beginning-of-line 1))
22516 (if (and arg (fboundp 'move-beginning-of-line))
22517 (call-interactively 'move-beginning-of-line)
22518 (if (bobp)
22519 nil
22520 (backward-char 1)
22521 (if (org-truely-invisible-p)
22522 (while (and (not (bobp)) (org-truely-invisible-p))
22523 (backward-char 1)
22524 (beginning-of-line 1))
22525 (forward-char 1))))
22526 (when special
22527 (cond
22528 ((and (looking-at org-complex-heading-regexp)
22529 (= (char-after (match-end 1)) ?\ ))
22530 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
22531 (point-at-eol)))
22532 (goto-char
22533 (if (eq special t)
22534 (cond ((> pos refpos) refpos)
22535 ((= pos (point)) refpos)
22536 (t (point)))
22537 (cond ((> pos (point)) (point))
22538 ((not (eq last-command this-command)) (point))
22539 (t refpos)))))
22540 ((org-at-item-p)
22541 ;; Being at an item and not looking at an the item means point
22542 ;; was previously moved to beginning of a visual line, which
22543 ;; doesn't contain the item. Therefore, do nothing special,
22544 ;; just stay here.
22545 (when (looking-at org-list-full-item-re)
22546 ;; Set special position at first white space character after
22547 ;; bullet, and check-box, if any.
22548 (let ((after-bullet
22549 (let ((box (match-end 3)))
22550 (if (not box) (match-end 1)
22551 (let ((after (char-after box)))
22552 (if (and after (= after ? )) (1+ box) box))))))
22553 ;; Special case: Move point to special position when
22554 ;; currently after it or at beginning of line.
22555 (if (eq special t)
22556 (when (or (> pos after-bullet) (= (point) pos))
22557 (goto-char after-bullet))
22558 ;; Reversed case: Move point to special position when
22559 ;; point was already at beginning of line and command is
22560 ;; repeated.
22561 (when (and (= (point) pos) (eq last-command this-command))
22562 (goto-char after-bullet))))))))
22563 (org-no-warnings
22564 (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
22566 (defun org-end-of-line (&optional arg)
22567 "Go to the end of the line.
22568 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
22569 tags on the first attempt, and only move to after the tags when
22570 the cursor is already beyond the end of the headline."
22571 (interactive "P")
22572 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
22573 org-special-ctrl-a/e))
22574 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
22575 'end-of-visual-line)
22576 ((fboundp 'move-end-of-line) 'move-end-of-line)
22577 (t 'end-of-line))))
22578 (if (or (not special) arg) (call-interactively move-fun)
22579 (let* ((element (save-excursion (beginning-of-line)
22580 (org-element-at-point)))
22581 (type (org-element-type element)))
22582 (cond
22583 ((memq type '(headline inlinetask))
22584 (let ((pos (point)))
22585 (beginning-of-line 1)
22587 (if (eq special t)
22588 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
22589 (goto-char (match-beginning 1))
22590 (goto-char (match-end 0)))
22591 (if (or (< pos (match-end 0))
22592 (not (eq this-command last-command)))
22593 (goto-char (match-end 0))
22594 (goto-char (match-beginning 1))))
22595 (call-interactively move-fun))))
22596 ((org-element-property :hiddenp element)
22597 ;; If element is hidden, `move-end-of-line' would put point
22598 ;; after it. Use `end-of-line' to stay on current line.
22599 (call-interactively 'end-of-line))
22600 (t (call-interactively move-fun)))))
22601 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t)))))
22603 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
22604 (define-key org-mode-map "\C-e" 'org-end-of-line)
22606 (defun org-backward-sentence (&optional arg)
22607 "Go to beginning of sentence, or beginning of table field.
22608 This will call `backward-sentence' or `org-table-beginning-of-field',
22609 depending on context."
22610 (interactive "P")
22611 (cond
22612 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
22613 (t (call-interactively 'backward-sentence))))
22615 (defun org-forward-sentence (&optional arg)
22616 "Go to end of sentence, or end of table field.
22617 This will call `forward-sentence' or `org-table-end-of-field',
22618 depending on context."
22619 (interactive "P")
22620 (cond
22621 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
22622 (t (call-interactively 'forward-sentence))))
22624 (define-key org-mode-map "\M-a" 'org-backward-sentence)
22625 (define-key org-mode-map "\M-e" 'org-forward-sentence)
22627 (defun org-kill-line (&optional arg)
22628 "Kill line, to tags or end of line."
22629 (interactive "P")
22630 (cond
22631 ((or (not org-special-ctrl-k)
22632 (bolp)
22633 (not (org-at-heading-p)))
22634 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
22635 org-ctrl-k-protect-subtree)
22636 (if (or (eq org-ctrl-k-protect-subtree 'error)
22637 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
22638 (error "C-k aborted - would kill hidden subtree")))
22639 (call-interactively
22640 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
22642 (kill-region (point) (match-beginning 1))
22643 (org-set-tags nil t))
22644 (t (kill-region (point) (point-at-eol)))))
22646 (define-key org-mode-map "\C-k" 'org-kill-line)
22648 (defun org-yank (&optional arg)
22649 "Yank. If the kill is a subtree, treat it specially.
22650 This command will look at the current kill and check if is a single
22651 subtree, or a series of subtrees[1]. If it passes the test, and if the
22652 cursor is at the beginning of a line or after the stars of a currently
22653 empty headline, then the yank is handled specially. How exactly depends
22654 on the value of the following variables, both set by default.
22656 org-yank-folded-subtrees
22657 When set, the subtree(s) will be folded after insertion, but only
22658 if doing so would now swallow text after the yanked text.
22660 org-yank-adjusted-subtrees
22661 When set, the subtree will be promoted or demoted in order to
22662 fit into the local outline tree structure, which means that the level
22663 will be adjusted so that it becomes the smaller one of the two
22664 *visible* surrounding headings.
22666 Any prefix to this command will cause `yank' to be called directly with
22668 will just
22669 plainly yank the text as it is.
22671 \[1] The test checks if the first non-white line is a heading
22672 and if there are no other headings with fewer stars."
22673 (interactive "P")
22674 (org-yank-generic 'yank arg))
22676 (defun org-yank-generic (command arg)
22677 "Perform some yank-like command.
22679 This function implements the behavior described in the `org-yank'
22680 documentation. However, it has been generalized to work for any
22681 interactive command with similar behavior."
22683 ;; pretend to be command COMMAND
22684 (setq this-command command)
22686 (if arg
22687 (call-interactively command)
22689 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
22690 (and (org-kill-is-subtree-p)
22691 (or (bolp)
22693 (string-match
22695 (buffer-substring (point-at-bol) (point)))))))
22696 swallowp)
22697 (cond
22698 ((and subtreep org-yank-folded-subtrees)
22699 (let ((beg (point))
22700 end)
22701 (if (and subtreep org-yank-adjusted-subtrees)
22702 (org-paste-subtree nil nil 'for-yank)
22703 (call-interactively command))
22705 (setq end (point))
22706 (goto-char beg)
22707 (when (and (bolp) subtreep
22708 (not (setq swallowp
22709 (org-yank-folding-would-swallow-text beg end))))
22710 (org-with-limited-levels
22711 (or (looking-at org-outline-regexp)
22712 (re-search-forward org-outline-regexp-bol end t))
22713 (while (and (< (point) end) (looking-at org-outline-regexp))
22714 (hide-subtree)
22715 (org-cycle-show-empty-lines 'folded)
22716 (condition-case nil
22717 (outline-forward-same-level 1)
22718 (error (goto-char end))))))
22719 (when swallowp
22720 (message
22721 "Inserted text not folded because that would swallow text"))
22723 (goto-char end)
22725 (beginning-of-line 1)
22726 (push-mark beg 'nomsg)))
22727 ((and subtreep org-yank-adjusted-subtrees)
22728 (let ((beg (point-at-bol)))
22729 (org-paste-subtree nil nil 'for-yank)
22730 (push-mark beg 'nomsg)))
22731 (t
22732 (call-interactively command))))))
22734 (defun org-yank-folding-would-swallow-text (beg end)
22735 "Would hide-subtree at BEG swallow any text after END?"
22736 (let (level)
22737 (org-with-limited-levels
22738 (save-excursion
22739 (goto-char beg)
22740 (when (or (looking-at org-outline-regexp)
22741 (re-search-forward org-outline-regexp-bol end t))
22742 (setq level (org-outline-level)))
22743 (goto-char end)
22745 (if (or (eobp)
22746 (and (bolp) (looking-at org-outline-regexp)
22747 (<= (org-outline-level) level)))
22748 nil ; Nothing would be swallowed
22749 t))))) ; something would swallow
22751 (define-key org-mode-map "\C-y" 'org-yank)
22753 (defun org-truely-invisible-p ()
22754 "Check if point is at a character currently not visible.
22755 This version does not only check the character property, but also
22756 `visible-mode'."
22757 ;; Early versions of noutline don't have `outline-invisible-p'.
22758 (if (org-bound-and-true-p visible-mode)
22759 nil
22760 (outline-invisible-p)))
22762 (defun org-invisible-p2 ()
22763 "Check if point is at a character currently not visible."
22764 (save-excursion
22765 (if (and (eolp) (not (bobp))) (backward-char 1))
22766 ;; Early versions of noutline don't have `outline-invisible-p'.
22767 (outline-invisible-p)))
22769 (defun org-back-to-heading (&optional invisible-ok)
22770 "Call `outline-back-to-heading', but provide a better error message."
22771 (condition-case nil
22772 (outline-back-to-heading invisible-ok)
22773 (error (error "Before first headline at position %d in buffer %s"
22774 (point) (current-buffer)))))
22776 (defun org-before-first-heading-p ()
22777 "Before first heading?"
22778 (save-excursion
22779 (end-of-line)
22780 (null (re-search-backward org-outline-regexp-bol nil t))))
22782 (defun org-at-heading-p (&optional ignored)
22783 (outline-on-heading-p t))
22784 ;; Compatibility alias with Org versions < 7.8.03
22785 (defalias 'org-on-heading-p 'org-at-heading-p)
22787 (defun org-at-comment-p nil
22788 "Is cursor in a line starting with a # character?"
22789 (save-excursion
22790 (beginning-of-line)
22791 (looking-at "^#")))
22793 (defun org-at-drawer-p nil
22794 "Is cursor at a drawer keyword?"
22795 (save-excursion
22796 (move-beginning-of-line 1)
22797 (looking-at org-drawer-regexp)))
22799 (defun org-at-block-p nil
22800 "Is cursor at a block keyword?"
22801 (save-excursion
22802 (move-beginning-of-line 1)
22803 (looking-at org-block-regexp)))
22805 (defun org-point-at-end-of-empty-headline ()
22806 "If point is at the end of an empty headline, return t, else nil.
22807 If the heading only contains a TODO keyword, it is still still considered
22808 empty."
22810 (when org-todo-line-regexp
22811 (save-excursion
22812 (beginning-of-line 1)
22813 (let ((case-fold-search nil))
22814 (looking-at org-todo-line-regexp)
22815 (string= (match-string 3) ""))))))
22817 (defun org-at-heading-or-item-p ()
22818 (or (org-at-heading-p) (org-at-item-p)))
22820 (defun org-at-target-p ()
22821 (or (org-in-regexp org-radio-target-regexp)
22822 (org-in-regexp org-target-regexp)))
22823 ;; Compatibility alias with Org versions < 7.8.03
22824 (defalias 'org-on-target-p 'org-at-target-p)
22826 (defun org-up-heading-all (arg)
22827 "Move to the heading line of which the present line is a subheading.
22828 This function considers both visible and invisible heading lines.
22829 With argument, move up ARG levels."
22830 (if (fboundp 'outline-up-heading-all)
22831 (outline-up-heading-all arg) ; emacs 21 version of outline.el
22832 (outline-up-heading arg t))) ; emacs 22 version of outline.el
22834 (defun org-up-heading-safe ()
22835 "Move to the heading line of which the present line is a subheading.
22836 This version will not throw an error. It will return the level of the
22837 headline found, or nil if no higher level is found.
22839 Also, this function will be a lot faster than `outline-up-heading',
22840 because it relies on stars being the outline starters. This can really
22841 make a significant difference in outlines with very many siblings."
22842 (let (start-level re)
22843 (org-back-to-heading t)
22844 (setq start-level (funcall outline-level))
22845 (if (equal start-level 1)
22846 nil
22848 (if (re-search-backward re nil t)
22849 (funcall outline-level)))))
22851 (defun org-first-sibling-p ()
22852 "Is this heading the first child of its parents?"
22853 (interactive)
22854 (let ((re org-outline-regexp-bol)
22855 level l)
22856 (unless (org-at-heading-p t)
22857 (error "Not at a heading"))
22858 (setq level (funcall outline-level))
22859 (save-excursion
22860 (if (not (re-search-backward re nil t))
22861 t
22862 (setq l (funcall outline-level))
22863 (< l level)))))
22865 (defun org-goto-sibling (&optional previous)
22866 "Goto the next sibling, even if it is invisible.
22867 When PREVIOUS is set, go to the previous sibling instead. Returns t
22868 when a sibling was found. When none is found, return nil and don't
22869 move point."
22870 (let ((fun (if previous 're-search-backward 're-search-forward))
22871 (pos (point))
22872 (re org-outline-regexp-bol)
22873 level l)
22874 (when (condition-case nil (org-back-to-heading t) (error nil))
22875 (setq level (funcall outline-level))
22876 (catch 'exit
22877 (or previous (forward-char 1))
22878 (while (funcall fun re nil t)
22879 (setq l (funcall outline-level))
22880 (when (< l level) (goto-char pos) (throw 'exit nil))
22881 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
22882 (goto-char pos)
22883 nil))))
22885 (defun org-show-siblings ()
22886 "Show all siblings of the current headline."
22887 (save-excursion
22888 (while (org-goto-sibling) (org-flag-heading nil)))
22889 (save-excursion
22890 (while (org-goto-sibling 'previous)
22891 (org-flag-heading nil))))
22893 (defun org-goto-first-child ()
22894 "Goto the first child, even if it is invisible.
22895 Return t when a child was found. Otherwise don't move point and
22896 return nil."
22897 (let (level (pos (point)) (re org-outline-regexp-bol))
22898 (when (condition-case nil (org-back-to-heading t) (error nil))
22899 (setq level (outline-level))
22900 (forward-char 1)
22901 (if (and (re-search-forward re nil t) (> (outline-level) level))
22902 (progn (goto-char (match-beginning 0)) t)
22903 (goto-char pos) nil))))
22905 (defun org-show-hidden-entry ()
22906 "Show an entry where even the heading is hidden."
22907 (save-excursion
22908 (org-show-entry)))
22910 (defun org-flag-heading (flag &optional entry)
22911 "Flag the current heading. FLAG non-nil means make invisible.
22912 When ENTRY is non-nil, show the entire entry."
22913 (save-excursion
22914 (org-back-to-heading t)
22915 ;; Check if we should show the entire entry
22916 (if entry
22917 (progn
22918 (org-show-entry)
22919 (save-excursion
22920 (and (outline-next-heading)
22921 (org-flag-heading nil))))
22922 (outline-flag-region (max (point-min) (1- (point)))
22923 (save-excursion (outline-end-of-heading) (point))
22924 flag))))
22926 (defun org-get-next-sibling ()
22927 "Move to next heading of the same level, and return point.
22928 If there is no such heading, return nil.
22929 This is like outline-next-sibling, but invisible headings are ok."
22930 (let ((level (funcall outline-level)))
22931 (outline-next-heading)
22932 (while (and (not (eobp)) (> (funcall outline-level) level))
22933 (outline-next-heading))
22934 (if (or (eobp) (< (funcall outline-level) level))
22935 nil
22936 (point))))
22938 (defun org-get-last-sibling ()
22939 "Move to previous heading of the same level, and return point.
22940 If there is no such heading, return nil."
22941 (let ((opoint (point))
22942 (level (funcall outline-level)))
22943 (outline-previous-heading)
22944 (when (and (/= (point) opoint) (outline-on-heading-p t))
22945 (while (and (> (funcall outline-level) level)
22946 (not (bobp)))
22947 (outline-previous-heading))
22948 (if (< (funcall outline-level) level)
22949 nil
22950 (point)))))
22952 (defun org-end-of-subtree (&optional invisible-ok to-heading)
22953 "Goto to the end of a subtree."
22954 ;; This contains an exact copy of the original function, but it uses
22955 ;; `org-back-to-heading', to make it work also in invisible
22956 ;; trees. And is uses an invisible-ok argument.
22957 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
22958 ;; Furthermore, when used inside Org, finding the end of a large subtree
22959 ;; with many children and grandchildren etc, this can be much faster
22960 ;; than the outline version.
22961 (org-back-to-heading invisible-ok)
22962 (let ((first t)
22963 (level (funcall outline-level)))
22964 (if (and (derived-mode-p 'org-mode) (< level 1000))
22965 ;; A true heading (not a plain list item), in Org-mode
22966 ;; This means we can easily find the end by looking
22967 ;; only for the right number of stars. Using a regexp to do
22968 ;; this is so much faster than using a Lisp loop.
22970 (forward-char 1)
22971 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
22972 ;; something else, do it the slow way
22973 (while (and (not (eobp))
22974 (or first (> (funcall outline-level) level)))
22975 (setq first nil)
22976 (outline-next-heading)))
22977 (unless to-heading
22979 (progn
22980 ;; Go to end of line before heading
22981 (forward-char -1)
22983 ;; leave blank line before heading
22984 (forward-char -1))))))
22985 (point))
22987 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
22988 "Use Org version in org-mode, for dramatic speed-up."
22989 (if (derived-mode-p 'org-mode)
22990 (progn
22991 (org-end-of-subtree nil t)
22992 (unless (eobp) (backward-char 1)))
22993 ad-do-it))
22995 (defun org-end-of-meta-data-and-drawers ()
22996 "Jump to the first text after meta data and drawers in the current entry.
22997 This will move over empty lines, lines with planning time stamps,
22998 clocking lines, and drawers."
22999 (org-back-to-heading t)
23000 (let ((end (save-excursion (outline-next-heading) (point)))
23003 (forward-line 1)
23004 (while (re-search-forward re end t)
23005 (if (not (match-end 1))
23006 ;; empty or planning line
23007 (forward-line 1)
23008 ;; a drawer, find the end
23010 (forward-line 1)))
23012 (point)))
23014 (defun org-forward-heading-same-level (arg &optional invisible-ok)
23015 "Move forward to the ARG'th subheading at same level as this one.
23016 Stop at the first and last subheadings of a superior heading.
23017 Normally this only looks at visible headings, but when INVISIBLE-OK is
23018 non-nil it will also look at invisible ones."
23019 (interactive "p")
23020 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
23021 (if (and arg (< arg 0))
23022 (goto-char (point-min))
23023 (outline-next-heading))
23024 (org-at-heading-p)
23025 (let ((level (- (match-end 0) (match-beginning 0) 1))
23026 (f (if (and arg (< arg 0))
23027 're-search-backward
23028 're-search-forward))
23029 (count (if arg (abs arg) 1))
23030 (result (point)))
23031 (while (and (prog1 (> count 0)
23032 (forward-char (if (and arg (< arg 0)) -1 1)))
23033 (funcall f org-outline-regexp-bol nil 'move))
23034 (let ((l (- (match-end 0) (match-beginning 0) 1)))
23035 (cond ((< l level) (setq count 0))
23036 ((and (= l level)
23037 (or invisible-ok
23038 (progn
23039 (goto-char (line-beginning-position))
23040 (not (outline-invisible-p)))))
23041 (setq count (1- count))
23042 (when (eq l level)
23043 (setq result (point)))))))
23044 (goto-char result))
23045 (beginning-of-line 1)))
23047 (defun org-backward-heading-same-level (arg &optional invisible-ok)
23048 "Move backward to the ARG'th subheading at same level as this one.
23049 Stop at the first and last subheadings of a superior heading."
23050 (interactive "p")
23051 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
23053 (defun org-next-block (arg &optional backward block-regexp)
23054 "Jump to the next block.
23055 With a prefix argument ARG, jump forward ARG many source blocks.
23056 When BACKWARD is non-nil, jump to the previous block.
23057 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23058 (interactive "p")
23059 (let ((re (or block-regexp org-block-regexp))
23060 (re-search-fn (or (and backward 're-search-backward)
23061 're-search-forward)))
23062 (if (looking-at re) (forward-char 1))
23063 (condition-case nil
23064 (funcall re-search-fn re nil nil arg)
23065 (error (error "No %s code blocks" (if backward "previous" "further" ))))
23066 (goto-char (match-beginning 0)) (org-show-context)))
23068 (defun org-previous-block (arg &optional block-regexp)
23069 "Jump to the previous block.
23070 With a prefix argument ARG, jump backward ARG many source blocks.
23071 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23072 (interactive "p")
23073 (org-next-block arg t block-regexp))
23075 (defun org-forward-element ()
23076 "Move forward by one element.
23077 Move to the next element at the same level, when possible."
23078 (interactive)
23079 (cond ((eobp) (user-error "Cannot move further down"))
23080 ((org-with-limited-levels (org-at-heading-p))
23081 (let ((origin (point)))
23082 (goto-char (org-end-of-subtree nil t))
23083 (unless (org-with-limited-levels (org-at-heading-p))
23084 (goto-char origin)
23085 (user-error "Cannot move further down"))))
23086 (t
23087 (let* ((elem (org-element-at-point))
23088 (end (org-element-property :end elem))
23089 (parent (org-element-property :parent elem)))
23090 (if (and parent (= (org-element-property :contents-end parent) end))
23091 (goto-char (org-element-property :end parent))
23092 (goto-char end))))))
23094 (defun org-backward-element ()
23095 "Move backward by one element.
23096 Move to the previous element at the same level, when possible."
23097 (interactive)
23098 (cond ((bobp) (user-error "Cannot move further up"))
23099 ((org-with-limited-levels (org-at-heading-p))
23100 ;; At a headline, move to the previous one, if any, or stay
23101 ;; here.
23102 (let ((origin (point)))
23103 (org-with-limited-levels (org-backward-heading-same-level 1))
23104 ;; When current headline has no sibling above, move to its
23105 ;; parent.
23106 (when (= (point) origin)
23107 (or (org-with-limited-levels (org-up-heading-safe))
23108 (progn (goto-char origin)
23109 (user-error "Cannot move further up"))))))
23110 (t
23111 (let* ((trail (org-element-at-point 'keep-trail))
23112 (elem (car trail))
23113 (prev-elem (nth 1 trail))
23114 (beg (org-element-property :begin elem)))
23115 (cond
23116 ;; Move to beginning of current element if point isn't
23117 ;; there already.
23118 ((/= (point) beg) (goto-char beg))
23119 (prev-elem (goto-char (org-element-property :begin prev-elem)))
23120 ((org-before-first-heading-p) (goto-char (point-min)))
23121 (t (org-back-to-heading)))))))
23123 (defun org-up-element ()
23124 "Move to upper element."
23125 (interactive)
23126 (if (org-with-limited-levels (org-at-heading-p))
23127 (unless (org-up-heading-safe) (error "No surrounding element"))
23128 (let* ((elem (org-element-at-point))
23129 (parent (org-element-property :parent elem)))
23130 (if parent (goto-char (org-element-property :begin parent))
23131 (if (org-with-limited-levels (org-before-first-heading-p))
23132 (error "No surrounding element")
23133 (org-with-limited-levels (org-back-to-heading)))))))
23135 (defvar org-element-greater-elements)
23136 (defun org-down-element ()
23137 "Move to inner element."
23138 (interactive)
23139 (let ((element (org-element-at-point)))
23140 (cond
23141 ((memq (org-element-type element) '(plain-list table))
23142 (goto-char (org-element-property :contents-begin element))
23143 (forward-char))
23144 ((memq (org-element-type element) org-element-greater-elements)
23145 ;; If contents are hidden, first disclose them.
23146 (when (org-element-property :hiddenp element) (org-cycle))
23147 (goto-char (or (org-element-property :contents-begin element)
23148 (error "No content for this element"))))
23149 (t (error "No inner element")))))
23151 (defun org-drag-element-backward ()
23152 "Move backward element at point."
23153 (interactive)
23154 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
23155 (let* ((trail (org-element-at-point 'keep-trail))
23156 (elem (car trail))
23157 (prev-elem (nth 1 trail)))
23158 ;; Error out if no previous element or previous element is
23159 ;; a parent of the current one.
23160 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
23161 (error "Cannot drag element backward")
23162 (let ((pos (point)))
23163 (org-element-swap-A-B prev-elem elem)
23164 (goto-char (+ (org-element-property :begin prev-elem)
23165 (- pos (org-element-property :begin elem)))))))))
23167 (defun org-drag-element-forward ()
23168 "Move forward element at point."
23169 (interactive)
23170 (let* ((pos (point))
23171 (elem (org-element-at-point)))
23172 (when (= (point-max) (org-element-property :end elem))
23173 (error "Cannot drag element forward"))
23174 (goto-char (org-element-property :end elem))
23175 (let ((next-elem (org-element-at-point)))
23176 (when (or (org-element-nested-p elem next-elem)
23177 (and (eq (org-element-type next-elem) 'headline)
23178 (not (eq (org-element-type elem) 'headline))))
23179 (goto-char pos)
23180 (error "Cannot drag element forward"))
23181 ;; Compute new position of point: it's shifted by NEXT-ELEM
23182 ;; body's length (without final blanks) and by the length of
23183 ;; blanks between ELEM and NEXT-ELEM.
23184 (let ((size-next (- (save-excursion
23185 (goto-char (org-element-property :end next-elem))
23187 (forward-line)
23188 ;; Small correction if buffer doesn't end
23189 ;; with a newline character.
23190 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
23191 (org-element-property :begin next-elem)))
23192 (size-blank (- (org-element-property :end elem)
23193 (save-excursion
23194 (goto-char (org-element-property :end elem))
23196 (forward-line)
23197 (point)))))
23198 (org-element-swap-A-B elem next-elem)
23199 (goto-char (+ pos size-next size-blank))))))
23201 (defun org-drag-line-forward (arg)
23202 "Drag the line at point ARG lines forward."
23203 (interactive "p")
23204 (dotimes (n (abs arg))
23205 (let ((c (current-column)))
23206 (if (< 0 arg)
23207 (progn
23208 (beginning-of-line 2)
23209 (transpose-lines 1)
23210 (beginning-of-line 0))
23211 (transpose-lines 1)
23212 (beginning-of-line -1))
23213 (org-move-to-column c))))
23215 (defun org-drag-line-backward (arg)
23216 "Drag the line at point ARG lines backward."
23217 (interactive "p")
23218 (org-drag-line-forward (- arg)))
23220 (defun org-mark-element ()
23221 "Put point at beginning of this element, mark at end.
23223 Interactively, if this command is repeated or (in Transient Mark
23224 mode) if the mark is active, it marks the next element after the
23225 ones already marked."
23226 (interactive)
23227 (let (deactivate-mark)
23228 (if (and (org-called-interactively-p 'any)
23229 (or (and (eq last-command this-command) (mark t))
23230 (and transient-mark-mode mark-active)))
23231 (set-mark
23232 (save-excursion
23233 (goto-char (mark))
23234 (goto-char (org-element-property :end (org-element-at-point)))))
23235 (let ((element (org-element-at-point)))
23236 (end-of-line)
23237 (push-mark (org-element-property :end element) t t)
23238 (goto-char (org-element-property :begin element))))))
23240 (defun org-narrow-to-element ()
23241 "Narrow buffer to current element."
23242 (interactive)
23243 (let ((elem (org-element-at-point)))
23244 (cond
23245 ((eq (car elem) 'headline)
23246 (narrow-to-region
23247 (org-element-property :begin elem)
23248 (org-element-property :end elem)))
23249 ((memq (car elem) org-element-greater-elements)
23250 (narrow-to-region
23251 (org-element-property :contents-begin elem)
23252 (org-element-property :contents-end elem)))
23253 (t
23254 (narrow-to-region
23255 (org-element-property :begin elem)
23256 (org-element-property :end elem))))))
23258 (defun org-transpose-element ()
23259 "Transpose current and previous elements, keeping blank lines between.
23260 Point is moved after both elements."
23261 (interactive)
23262 (org-skip-whitespace)
23263 (let ((end (org-element-property :end (org-element-at-point))))
23264 (org-drag-element-backward)
23265 (goto-char end)))
23267 (defun org-unindent-buffer ()
23268 "Un-indent the visible part of the buffer.
23269 Relative indentation (between items, inside blocks, etc.) isn't
23270 modified."
23271 (interactive)
23272 (unless (eq major-mode 'org-mode)
23273 (error "Cannot un-indent a buffer not in Org mode"))
23274 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
23275 unindent-tree ; For byte-compiler.
23276 (unindent-tree
23277 (function
23278 (lambda (contents)
23279 (mapc
23280 (lambda (element)
23281 (if (memq (org-element-type element) '(headline section))
23282 (funcall unindent-tree (org-element-contents element))
23283 (save-excursion
23284 (save-restriction
23285 (narrow-to-region
23286 (org-element-property :begin element)
23287 (org-element-property :end element))
23288 (org-do-remove-indentation)))))
23289 (reverse contents))))))
23290 (funcall unindent-tree (org-element-contents parse-tree))))
23292 (defun org-show-subtree ()
23293 "Show everything after this heading at deeper levels."
23294 (interactive)
23295 (outline-flag-region
23296 (point)
23297 (save-excursion
23298 (org-end-of-subtree t t))
23299 nil))
23301 (defun org-show-entry ()
23302 "Show the body directly following this heading.
23303 Show the heading too, if it is currently invisible."
23304 (interactive)
23305 (save-excursion
23306 (condition-case nil
23307 (progn
23308 (org-back-to-heading t)
23309 (outline-flag-region
23310 (max (point-min) (1- (point)))
23311 (save-excursion
23312 (if (re-search-forward
23314 (match-beginning 1)
23315 (point-max)))
23316 nil)
23317 (org-cycle-hide-drawers 'children))
23318 (error nil))))
23320 (defun org-make-options-regexp (kwds &optional extra)
23321 "Make a regular expression for keyword lines."
23322 (concat
23328 ;; Make isearch reveal the necessary context
23329 (defun org-isearch-end ()
23330 "Reveal context after isearch exits."
23331 (when isearch-success ; only if search was successful
23332 (if (featurep 'xemacs)
23333 ;; Under XEmacs, the hook is run in the correct place,
23334 ;; we directly show the context.
23335 (org-show-context 'isearch)
23336 ;; In Emacs the hook runs *before* restoring the overlays.
23337 ;; So we have to use a one-time post-command-hook to do this.
23338 ;; (Emacs 22 has a special variable, see function `org-mode')
23339 (unless (and (boundp 'isearch-mode-end-hook-quit)
23340 isearch-mode-end-hook-quit)
23341 ;; Only when the isearch was not quitted.
23342 (org-add-hook 'post-command-hook 'org-isearch-post-command
23343 'append 'local)))
23344 (org-fix-ellipsis-at-bol)))
23346 (defun org-isearch-post-command ()
23347 "Remove self from hook, and show context."
23348 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
23349 (org-show-context 'isearch))
23352 ;;;; Integration with and fixes for other packages
23354 ;;; Imenu support
23356 (defvar org-imenu-markers nil
23357 "All markers currently used by Imenu.")
23358 (make-variable-buffer-local 'org-imenu-markers)
23360 (defun org-imenu-new-marker (&optional pos)
23361 "Return a new marker for use by Imenu, and remember the marker."
23362 (let ((m (make-marker)))
23363 (move-marker m (or pos (point)))
23364 (push m org-imenu-markers)
23365 m))
23367 (defun org-imenu-get-tree ()
23368 "Produce the index for Imenu."
23369 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
23370 (setq org-imenu-markers nil)
23371 (let* ((n org-imenu-depth)
23372 (re (concat "^" (org-get-limited-outline-regexp)))
23373 (subs (make-vector (1+ n) nil))
23374 (last-level 0)
23375 m level head0 head)
23376 (save-excursion
23377 (save-restriction
23378 (widen)
23379 (goto-char (point-max))
23380 (while (re-search-backward re nil t)
23381 (setq level (org-reduced-level (funcall outline-level)))
23382 (when (and (<= level n)
23383 (looking-at org-complex-heading-regexp)
23384 (setq head0 (org-match-string-no-properties 4)))
23385 (setq head (org-link-display-format head0)
23386 m (org-imenu-new-marker))
23387 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
23388 (if (>= level last-level)
23389 (push (cons head m) (aref subs level))
23390 (push (cons head (aref subs (1+ level))) (aref subs level))
23391 (loop for i from (1+ level) to n do (aset subs i nil)))
23392 (setq last-level level)))))
23393 (aref subs 1)))
23395 (eval-after-load "imenu"
23396 '(progn
23397 (add-hook 'imenu-after-jump-hook
23398 (lambda ()
23399 (if (derived-mode-p 'org-mode)
23400 (org-show-context 'org-goto))))))
23402 (defun org-link-display-format (link)
23403 "Replace a link with its the description.
23404 If there is no description, use the link target."
23405 (save-match-data
23406 (if (string-match org-bracket-link-analytic-regexp link)
23407 (replace-match (if (match-end 5)
23408 (match-string 5 link)
23409 (concat (match-string 1 link)
23410 (match-string 3 link)))
23411 nil t link)
23412 link)))
23414 (defun org-toggle-link-display ()
23415 "Toggle the literal or descriptive display of links."
23416 (interactive)
23417 (if org-descriptive-links
23418 (progn (org-remove-from-invisibility-spec '(org-link))
23419 (org-restart-font-lock)
23420 (setq org-descriptive-links nil))
23421 (progn (add-to-invisibility-spec '(org-link))
23422 (org-restart-font-lock)
23423 (setq org-descriptive-links t))))
23425 ;; Speedbar support
23427 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
23428 "Overlay marking the agenda restriction line in speedbar.")
23429 (overlay-put org-speedbar-restriction-lock-overlay
23430 'face 'org-agenda-restriction-lock)
23431 (overlay-put org-speedbar-restriction-lock-overlay
23432 'help-echo "Agendas are currently limited to this item.")
23433 (org-detach-overlay org-speedbar-restriction-lock-overlay)
23435 (defun org-speedbar-set-agenda-restriction ()
23436 "Restrict future agenda commands to the location at point in speedbar.
23438 (interactive)
23439 (require 'org-agenda)
23440 (let (p m tp np dir txt)
23441 (cond
23442 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23443 'org-imenu t))
23444 (setq m (get-text-property p 'org-imenu-marker))
23445 (with-current-buffer (marker-buffer m)
23446 (goto-char m)
23447 (org-agenda-set-restriction-lock 'subtree)))
23448 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23449 'speedbar-function 'speedbar-find-file))
23450 (setq tp (previous-single-property-change
23451 (1+ p) 'speedbar-function)
23452 np (next-single-property-change
23453 tp 'speedbar-function)
23454 dir (speedbar-line-directory)
23455 txt (buffer-substring-no-properties (or tp (point-min))
23456 (or np (point-max))))
23457 (with-current-buffer (find-file-noselect
23458 (let ((default-directory dir))
23459 (expand-file-name txt)))
23460 (unless (derived-mode-p 'org-mode)
23461 (error "Cannot restrict to non-Org-mode file"))
23462 (org-agenda-set-restriction-lock 'file)))
23463 (t (error "Don't know how to restrict Org-mode's agenda")))
23464 (move-overlay org-speedbar-restriction-lock-overlay
23465 (point-at-bol) (point-at-eol))
23466 (setq current-prefix-arg nil)
23467 (org-agenda-maybe-redo)))
23469 (eval-after-load "speedbar"
23470 '(progn
23471 (speedbar-add-supported-extension ".org")
23472 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
23473 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
23474 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
23475 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
23476 (add-hook 'speedbar-visiting-tag-hook
23477 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
23479 ;;; Fixes and Hacks for problems with other packages
23481 ;; Make flyspell not check words in links, to not mess up our keymap
23482 (defvar org-element-affiliated-keywords) ; From org-element.el
23483 (defvar org-element-block-name-alist) ; From org-element.el
23484 (defun org-mode-flyspell-verify ()
23485 "Don't let flyspell put overlays at active buttons, or on
23486 {todo,all-time,additional-option-like}-keywords."
23487 (require 'org-element) ; For `org-element-affiliated-keywords'
23488 (let ((pos (max (1- (point)) (point-min)))
23489 (word (thing-at-point 'word)))
23490 (and (not (get-text-property pos 'keymap))
23491 (not (get-text-property pos 'org-no-flyspell))
23492 (not (member word org-todo-keywords-1))
23493 (not (member word org-all-time-keywords))
23494 (not (member word org-options-keywords))
23495 (not (member word (mapcar 'car org-startup-options)))
23496 (not (member-ignore-case word org-element-affiliated-keywords))
23497 (not (member-ignore-case word (org-get-export-keywords)))
23498 (not (member-ignore-case
23499 word (mapcar 'car org-element-block-name-alist)))
23500 (not (member-ignore-case word '("BEGIN" "END" "ATTR"))))))
23502 (defun org-remove-flyspell-overlays-in (beg end)
23503 "Remove flyspell overlays in region."
23504 (and (org-bound-and-true-p flyspell-mode)
23505 (fboundp 'flyspell-delete-region-overlays)
23506 (flyspell-delete-region-overlays beg end))
23507 (add-text-properties beg end '(org-no-flyspell t)))
23509 ;; Make `bookmark-jump' shows the jump location if it was hidden.
23510 (eval-after-load "bookmark"
23511 '(if (boundp 'bookmark-after-jump-hook)
23512 ;; We can use the hook
23513 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
23514 ;; Hook not available, use advice
23515 (defadvice bookmark-jump (after org-make-visible activate)
23516 "Make the position visible."
23517 (org-bookmark-jump-unhide))))
23519 ;; Make sure saveplace shows the location if it was hidden
23520 (eval-after-load "saveplace"
23521 '(defadvice save-place-find-file-hook (after org-make-visible activate)
23522 "Make the position visible."
23523 (org-bookmark-jump-unhide)))
23525 ;; Make sure ecb shows the location if it was hidden
23526 (eval-after-load "ecb"
23527 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
23528 "Make hierarchy visible when jumping into location from ECB tree buffer."
23529 (if (derived-mode-p 'org-mode)
23530 (org-show-context))))
23532 (defun org-bookmark-jump-unhide ()
23533 "Unhide the current position, to show the bookmark location."
23534 (and (derived-mode-p 'org-mode)
23535 (or (outline-invisible-p)
23536 (save-excursion (goto-char (max (point-min) (1- (point))))
23537 (outline-invisible-p)))
23538 (org-show-context 'bookmark-jump)))
23540 ;; Make session.el ignore our circular variable
23541 (eval-after-load "session"
23542 '(add-to-list 'session-globals-exclude 'org-mark-ring))
23544 ;;;; Finish up
23546 (provide 'org)
23548 (run-hooks 'org-load-hook)
23550 ;;; org.el ends here